From 28b72ab6080e6dd61015638277c8d7ad758cc5ad Mon Sep 17 00:00:00 2001 From: Jeffrey Aven Date: Fri, 29 Aug 2025 05:53:16 +1000 Subject: [PATCH] updated google provider --- .../googleapis.com/v00.00.00000/provider.yaml | 170 +- .../v00.00.00000/services/accessapproval.yaml | 60 +- .../services/accesscontextmanager.yaml | 153 +- .../services/addressvalidation.yaml | 1734 +- .../services/advisorynotifications.yaml | 636 +- .../v00.00.00000/services/aiplatform.yaml | 26410 +++-- .../v00.00.00000/services/airquality.yaml | 1300 +- .../v00.00.00000/services/alloydb.yaml | 1304 +- .../v00.00.00000/services/analyticshub.yaml | 874 +- .../v00.00.00000/services/apigateway.yaml | 14 +- .../v00.00.00000/services/apigee.yaml | 28264 ++--- .../v00.00.00000/services/apigeeregistry.yaml | 56 +- .../v00.00.00000/services/apihub.yaml | 8286 ++ .../v00.00.00000/services/apikeys.yaml | 804 +- .../v00.00.00000/services/apim.yaml | 89 +- .../v00.00.00000/services/appengine.yaml | 646 +- .../v00.00.00000/services/apphub.yaml | 335 +- .../v00.00.00000/services/areainsights.yaml | 461 + .../services/artifactregistry.yaml | 36 +- .../services/assuredworkloads.yaml | 2863 +- .../v00.00.00000/services/backupdr.yaml | 2960 +- .../services/baremetalsolution.yaml | 22 +- .../v00.00.00000/services/batch.yaml | 163 +- .../v00.00.00000/services/beyondcorp.yaml | 1314 +- .../v00.00.00000/services/biglake.yaml | 4 +- .../v00.00.00000/services/bigquery.yaml | 849 +- .../services/bigqueryconnection.yaml | 4 +- .../services/bigquerydatapolicy.yaml | 6 +- .../services/bigquerydatatransfer.yaml | 53 +- .../services/bigqueryreservation.yaml | 1352 +- .../v00.00.00000/services/bigtableadmin.yaml | 2712 +- .../v00.00.00000/services/billingbudgets.yaml | 894 +- .../services/binaryauthorization.yaml | 42 +- .../services/blockchainnodeengine.yaml | 20 +- .../services/certificatemanager.yaml | 55 +- .../v00.00.00000/services/cloudasset.yaml | 178 +- .../v00.00.00000/services/cloudbilling.yaml | 4 +- .../v00.00.00000/services/cloudbuild.yaml | 4792 +- .../services/cloudcommerceprocurement.yaml | 948 +- .../services/cloudcontrolspartner.yaml | 32 +- .../v00.00.00000/services/clouddeploy.yaml | 364 +- .../services/clouderrorreporting.yaml | 4 +- .../v00.00.00000/services/cloudfunctions.yaml | 108 +- .../v00.00.00000/services/cloudidentity.yaml | 672 +- .../v00.00.00000/services/cloudkms.yaml | 937 +- .../services/cloudlocationfinder.yaml | 537 + .../v00.00.00000/services/cloudprofiler.yaml | 29 +- .../services/cloudresourcemanager.yaml | 352 +- .../v00.00.00000/services/cloudscheduler.yaml | 71 +- .../v00.00.00000/services/cloudshell.yaml | 18 +- .../v00.00.00000/services/cloudsupport.yaml | 1534 +- .../v00.00.00000/services/cloudtasks.yaml | 28 +- .../v00.00.00000/services/cloudtrace.yaml | 21 +- .../v00.00.00000/services/composer.yaml | 110 +- .../v00.00.00000/services/compute.yaml | 90054 +++++++++------- .../v00.00.00000/services/config.yaml | 540 +- .../v00.00.00000/services/connectors.yaml | 322 +- .../services/contactcenteraiplatform.yaml | 55 +- .../services/contactcenterinsights.yaml | 20320 ++-- .../v00.00.00000/services/container.yaml | 1783 +- .../services/containeranalysis.yaml | 10692 +- .../services/contentwarehouse.yaml | 9252 +- .../v00.00.00000/services/datacatalog.yaml | 236 +- .../v00.00.00000/services/dataflow.yaml | 229 +- .../v00.00.00000/services/dataform.yaml | 2271 +- .../v00.00.00000/services/datafusion.yaml | 432 +- .../v00.00.00000/services/datalabeling.yaml | 126 +- .../v00.00.00000/services/datalineage.yaml | 1460 +- .../v00.00.00000/services/datamigration.yaml | 645 +- .../v00.00.00000/services/datapipelines.yaml | 1388 +- .../v00.00.00000/services/dataplex.yaml | 12826 ++- .../v00.00.00000/services/dataproc.yaml | 292 +- .../v00.00.00000/services/datastore.yaml | 13 +- .../v00.00.00000/services/datastream.yaml | 684 +- .../services/deploymentmanager.yaml | 63 +- .../services/developerconnect.yaml | 1738 +- .../v00.00.00000/services/dialogflow.yaml | 21831 ++-- .../services/discoveryengine.yaml | 37115 ++++--- .../v00.00.00000/services/dlp.yaml | 18855 ++-- .../v00.00.00000/services/dns.yaml | 47 +- .../v00.00.00000/services/documentai.yaml | 9425 +- .../v00.00.00000/services/domains.yaml | 76 +- .../services/essentialcontacts.yaml | 805 +- .../v00.00.00000/services/eventarc.yaml | 321 +- .../v00.00.00000/services/file.yaml | 165 +- .../v00.00.00000/services/firestore.yaml | 685 +- .../services/geminicloudassist.yaml | 2560 + .../v00.00.00000/services/gkebackup.yaml | 1415 +- .../v00.00.00000/services/gkehub.yaml | 370 +- .../v00.00.00000/services/gkeonprem.yaml | 55 +- .../v00.00.00000/services/healthcare.yaml | 2066 +- .../v00.00.00000/services/iam.yaml | 3862 +- .../v00.00.00000/services/iamcredentials.yaml | 123 +- .../v00.00.00000/services/iamv2.yaml | 64 +- .../v00.00.00000/services/iamv2beta.yaml | 102 +- .../v00.00.00000/services/iap.yaml | 67 +- .../services/identitytoolkit.yaml | 2 +- .../v00.00.00000/services/ids.yaml | 507 +- .../v00.00.00000/services/integrations.yaml | 21480 ++-- .../v00.00.00000/services/jobs.yaml | 147 +- .../v00.00.00000/services/kmsinventory.yaml | 1376 +- .../v00.00.00000/services/language.yaml | 8721 +- .../v00.00.00000/services/libraryagent.yaml | 344 +- .../v00.00.00000/services/lifesciences.yaml | 8 +- .../v00.00.00000/services/logging.yaml | 240 +- .../v00.00.00000/services/looker.yaml | 672 +- .../services/managedidentities.yaml | 29 +- .../v00.00.00000/services/managedkafka.yaml | 6073 ++ .../v00.00.00000/services/memcache.yaml | 343 +- .../v00.00.00000/services/metastore.yaml | 4721 - .../services/migrationcenter.yaml | 812 +- .../v00.00.00000/services/ml.yaml | 10 +- .../v00.00.00000/services/monitoring.yaml | 127 +- .../v00.00.00000/services/netapp.yaml | 1090 +- .../services/networkconnectivity.yaml | 1734 +- .../services/networkmanagement.yaml | 2576 +- .../services/networksecurity.yaml | 8094 +- .../services/networkservices.yaml | 1272 +- .../v00.00.00000/services/notebooks.yaml | 290 +- .../v00.00.00000/services/observability.yaml | 1039 + .../services/ondemandscanning.yaml | 237 +- .../v00.00.00000/services/oracledatabase.yaml | 1137 +- .../v00.00.00000/services/orgpolicy.yaml | 1872 +- .../v00.00.00000/services/osconfig.yaml | 3945 +- .../v00.00.00000/services/oslogin.yaml | 8 +- .../v00.00.00000/services/parallelstore.yaml | 1330 + .../services/parametermanager.yaml | 1051 + .../v00.00.00000/services/places.yaml | 4387 +- .../v00.00.00000/services/policyanalyzer.yaml | 166 +- .../services/policysimulator.yaml | 3835 +- .../services/policytroubleshooter.yaml | 1002 +- .../v00.00.00000/services/pollen.yaml | 802 +- .../v00.00.00000/services/privateca.yaml | 186 +- .../services/prod_tt_sasportal.yaml | 4294 +- .../v00.00.00000/services/publicca.yaml | 4 +- .../v00.00.00000/services/pubsub.yaml | 256 +- .../v00.00.00000/services/pubsublite.yaml | 6 +- .../services/rapidmigrationassessment.yaml | 12 +- .../services/recaptchaenterprise.yaml | 3971 +- .../services/recommendationengine.yaml | 4 +- .../v00.00.00000/services/recommender.yaml | 2682 +- .../v00.00.00000/services/redis.yaml | 1540 +- .../services/resourcesettings.yaml | 720 - .../v00.00.00000/services/retail.yaml | 559 +- .../v00.00.00000/services/run.yaml | 4638 +- .../v00.00.00000/services/runtimeconfig.yaml | 6 +- .../services/saasservicemgmt.yaml | 3982 + .../v00.00.00000/services/sasportal.yaml | 4260 +- .../v00.00.00000/services/secretmanager.yaml | 20 +- .../services/securesourcemanager.yaml | 5051 + .../v00.00.00000/services/securitycenter.yaml | 2291 +- .../services/securityposture.yaml | 2585 + .../services/serviceconsumermanagement.yaml | 6560 +- .../v00.00.00000/services/servicecontrol.yaml | 31 +- .../services/servicedirectory.yaml | 8 +- .../services/servicemanagement.yaml | 235 +- .../services/servicenetworking.yaml | 8164 +- .../v00.00.00000/services/serviceusage.yaml | 7185 +- .../v00.00.00000/services/solar.yaml | 1328 +- .../v00.00.00000/services/spanner.yaml | 6984 +- .../v00.00.00000/services/speech.yaml | 4 +- .../v00.00.00000/services/sqladmin.yaml | 2242 +- .../v00.00.00000/services/storage.yaml | 339 +- .../services/storagebatchoperations.yaml | 1385 + .../services/storagetransfer.yaml | 95 +- .../v00.00.00000/services/testing.yaml | 3103 - .../v00.00.00000/services/texttospeech.yaml | 92 +- .../v00.00.00000/services/tpu.yaml | 86 +- .../services/trafficdirector.yaml | 90 +- .../v00.00.00000/services/transcoder.yaml | 65 +- .../v00.00.00000/services/translate.yaml | 20 +- .../services/videointelligence.yaml | 163 +- .../v00.00.00000/services/vision.yaml | 8 +- .../v00.00.00000/services/vmmigration.yaml | 167 +- .../v00.00.00000/services/vmwareengine.yaml | 910 +- .../v00.00.00000/services/vpcaccess.yaml | 8 +- .../v00.00.00000/services/webrisk.yaml | 780 +- .../services/websecurityscanner.yaml | 1741 +- .../services/workflowexecutions.yaml | 21 +- .../v00.00.00000/services/workflows.yaml | 17 +- .../services/workloadmanager.yaml | 965 +- .../v00.00.00000/services/workstations.yaml | 235 +- 182 files changed, 310353 insertions(+), 202338 deletions(-) create mode 100644 providers/src/googleapis.com/v00.00.00000/services/apihub.yaml create mode 100644 providers/src/googleapis.com/v00.00.00000/services/areainsights.yaml create mode 100644 providers/src/googleapis.com/v00.00.00000/services/cloudlocationfinder.yaml create mode 100644 providers/src/googleapis.com/v00.00.00000/services/geminicloudassist.yaml create mode 100644 providers/src/googleapis.com/v00.00.00000/services/managedkafka.yaml delete mode 100644 providers/src/googleapis.com/v00.00.00000/services/metastore.yaml create mode 100644 providers/src/googleapis.com/v00.00.00000/services/observability.yaml create mode 100644 providers/src/googleapis.com/v00.00.00000/services/parallelstore.yaml create mode 100644 providers/src/googleapis.com/v00.00.00000/services/parametermanager.yaml delete mode 100644 providers/src/googleapis.com/v00.00.00000/services/resourcesettings.yaml create mode 100644 providers/src/googleapis.com/v00.00.00000/services/saasservicemgmt.yaml create mode 100644 providers/src/googleapis.com/v00.00.00000/services/securesourcemanager.yaml create mode 100644 providers/src/googleapis.com/v00.00.00000/services/securityposture.yaml create mode 100644 providers/src/googleapis.com/v00.00.00000/services/storagebatchoperations.yaml delete mode 100644 providers/src/googleapis.com/v00.00.00000/services/testing.yaml diff --git a/providers/src/googleapis.com/v00.00.00000/provider.yaml b/providers/src/googleapis.com/v00.00.00000/provider.yaml index f21d51c7..c3459fb1 100644 --- a/providers/src/googleapis.com/v00.00.00000/provider.yaml +++ b/providers/src/googleapis.com/v00.00.00000/provider.yaml @@ -133,6 +133,15 @@ providerServices: title: Apigee Registry API version: v00.00.00000 description: '' + apihub: + id: apihub:v00.00.00000 + name: apihub + preferred: true + service: + $ref: googleapis.com/v00.00.00000/services/apihub.yaml + title: API hub API + version: v00.00.00000 + description: '' apikeys: id: apikeys:v00.00.00000 name: apikeys @@ -171,6 +180,15 @@ providerServices: title: App Hub API version: v00.00.00000 description: '' + areainsights: + id: areainsights:v00.00.00000 + name: areainsights + preferred: true + service: + $ref: googleapis.com/v00.00.00000/services/areainsights.yaml + title: Places Aggregate API + version: v00.00.00000 + description: Places Aggregate API. artifactregistry: id: artifactregistry:v00.00.00000 name: artifactregistry @@ -291,7 +309,7 @@ providerServices: $ref: googleapis.com/v00.00.00000/services/bigqueryreservation.yaml title: BigQuery Reservation API version: v00.00.00000 - description: A service to modify your BigQuery flat-rate reservations. + description: A service to modify your BigQuery reservations. bigtableadmin: id: bigtableadmin:v00.00.00000 name: bigtableadmin @@ -447,6 +465,15 @@ providerServices: description: >- Manages keys and performs cryptographic operations in a central cloud service, for direct use by other cloud resources and applications. + cloudlocationfinder: + id: cloudlocationfinder:v00.00.00000 + name: cloudlocationfinder + preferred: true + service: + $ref: googleapis.com/v00.00.00000/services/cloudlocationfinder.yaml + title: Cloud Location Finder API + version: v00.00.00000 + description: '' cloudprofiler: id: cloudprofiler:v00.00.00000 name: cloudprofiler @@ -599,11 +626,9 @@ providerServices: version: v00.00.00000 description: >- This API is a prerequisite for leveraging Artifact Analysis scanning - capabilities in both Artifact Registry and with Advanced Vulnerability - Insights (runtime scanning) in GKE. In addition, the Container Analysis - API is an implementation of the Grafeas API, which enables storing, - querying, and retrieval of critical metadata about all of your software - artifacts. + capabilities in Artifact Registry. In addition, the Container Analysis API + is an implementation of the Grafeas API, which enables storing, querying, + and retrieval of critical metadata about all of your software artifacts. contentwarehouse: id: contentwarehouse:v00.00.00000 name: contentwarehouse @@ -708,7 +733,7 @@ providerServices: $ref: googleapis.com/v00.00.00000/services/dataplex.yaml title: Cloud Dataplex API version: v00.00.00000 - description: Dataplex API is used to manage the lifecycle of data lakes. + description: A unified, intelligent governance solution for data and AI assets. dataproc: id: dataproc:v00.00.00000 name: dataproc @@ -861,6 +886,15 @@ providerServices: description: >- Accesses the NoSQL document database built for automatic scaling, high performance, and ease of application development. + geminicloudassist: + id: geminicloudassist:v00.00.00000 + name: geminicloudassist + preferred: true + service: + $ref: googleapis.com/v00.00.00000/services/geminicloudassist.yaml + title: Gemini Cloud Assist API + version: v00.00.00000 + description: 'The AI-powered assistant for Google Cloud. ' gkebackup: id: gkebackup:v00.00.00000 name: gkebackup @@ -887,7 +921,7 @@ providerServices: preferred: true service: $ref: googleapis.com/v00.00.00000/services/gkeonprem.yaml - title: GDC Virtual API + title: GKE On-Prem API version: v00.00.00000 description: '' healthcare: @@ -1080,6 +1114,15 @@ providerServices: The Managed Service for Microsoft Active Directory API is used for managing a highly available, hardened service running Microsoft Active Directory (AD). + managedkafka: + id: managedkafka:v00.00.00000 + name: managedkafka + preferred: true + service: + $ref: googleapis.com/v00.00.00000/services/managedkafka.yaml + title: Managed Service for Apache Kafka API + version: v00.00.00000 + description: 'Manage Apache Kafka clusters and resources. ' memcache: id: memcache:v00.00.00000 name: memcache @@ -1091,17 +1134,6 @@ providerServices: description: >- Google Cloud Memorystore for Memcached API is used for creating and managing Memcached instances in GCP. - metastore: - id: metastore:v00.00.00000 - name: metastore - preferred: true - service: - $ref: googleapis.com/v00.00.00000/services/metastore.yaml - title: Dataproc Metastore API - version: v00.00.00000 - description: >- - The Dataproc Metastore API is used to manage the lifecycle and - configuration of metastore services. migrationcenter: id: migrationcenter:v00.00.00000 name: migrationcenter @@ -1190,6 +1222,15 @@ providerServices: title: Notebooks API version: v00.00.00000 description: Notebooks API is used to manage notebook resources in Google Cloud. + observability: + id: observability:v00.00.00000 + name: observability + preferred: true + service: + $ref: googleapis.com/v00.00.00000/services/observability.yaml + title: Observability API + version: v00.00.00000 + description: '' ondemandscanning: id: ondemandscanning:v00.00.00000 name: ondemandscanning @@ -1243,6 +1284,28 @@ providerServices: description: >- You can use OS Login to manage access to your VM instances using IAM roles. + parallelstore: + id: parallelstore:v00.00.00000 + name: parallelstore + preferred: true + service: + $ref: googleapis.com/v00.00.00000/services/parallelstore.yaml + title: Parallelstore API + version: v00.00.00000 + description: '' + parametermanager: + id: parametermanager:v00.00.00000 + name: parametermanager + preferred: true + service: + $ref: googleapis.com/v00.00.00000/services/parametermanager.yaml + title: Parameter Manager API + version: v00.00.00000 + description: >- + Parameter Manager is a single source of truth to store, access and manage + the lifecycle of your workload parameters. Parameter Manager aims to make + management of sensitive application parameters effortless for customers + without diminishing focus on security. places: id: places:v00.00.00000 name: places @@ -1398,28 +1461,16 @@ providerServices: title: Google Cloud Memorystore for Redis API version: v00.00.00000 description: Creates and manages Redis instances on the Google Cloud Platform. - resourcesettings: - id: resourcesettings:v00.00.00000 - name: resourcesettings - preferred: true - service: - $ref: googleapis.com/v00.00.00000/services/resourcesettings.yaml - title: Resource Settings API - version: v00.00.00000 - description: >- - The Resource Settings API allows users to control and modify the behavior - of their GCP resources (e.g., VM, firewall, Project, etc.) across the - Cloud Resource Hierarchy. retail: id: retail:v00.00.00000 name: retail preferred: true service: $ref: googleapis.com/v00.00.00000/services/retail.yaml - title: Vertex AI Search for Retail API + title: Vertex AI Search for commerce API version: v00.00.00000 description: >- - Vertex AI Search for Retail API is made up of Retail Search, Browse and + Vertex AI Search for commerce API is made up of Retail Search, Browse and Recommendations. These discovery AI solutions help you implement personalized search, browse and recommendations, based on machine learning models, across your websites and mobile applications. @@ -1449,6 +1500,15 @@ providerServices: 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. + saasservicemgmt: + id: saasservicemgmt:v00.00.00000 + name: saasservicemgmt + preferred: true + service: + $ref: googleapis.com/v00.00.00000/services/saasservicemgmt.yaml + title: SaaS Runtime API + version: v00.00.00000 + description: 'Model, deploy, and operate your SaaS at scale. ' sasportal: id: sasportal:v00.00.00000 name: sasportal @@ -1469,6 +1529,17 @@ providerServices: description: >- Stores sensitive data such as API keys, passwords, and certificates. Provides convenience while improving security. + securesourcemanager: + id: securesourcemanager:v00.00.00000 + name: securesourcemanager + preferred: true + service: + $ref: googleapis.com/v00.00.00000/services/securesourcemanager.yaml + title: Secure Source Manager API + version: v00.00.00000 + description: >- + Regionally deployed, single-tenant managed source code repository hosted + on Google Cloud. securitycenter: id: securitycenter:v00.00.00000 name: securitycenter @@ -1480,6 +1551,19 @@ providerServices: description: >- Security Command Center API provides access to temporal views of assets and findings within an organization. + securityposture: + id: securityposture:v00.00.00000 + name: securityposture + preferred: true + service: + $ref: googleapis.com/v00.00.00000/services/securityposture.yaml + title: Security Posture API + version: v00.00.00000 + description: >- + Defines, assesses, and monitors the overall status of your security in + Google Cloud. You can use security postures to evaluate your current cloud + security against defined benchmarks and help maintain the level of + security that your organization requires. serviceconsumermanagement: id: serviceconsumermanagement:v00.00.00000 name: serviceconsumermanagement @@ -1593,6 +1677,15 @@ providerServices: title: Cloud Storage JSON API version: v00.00.00000 description: Stores and retrieves potentially large, immutable data objects. + storagebatchoperations: + id: storagebatchoperations:v00.00.00000 + name: storagebatchoperations + preferred: true + service: + $ref: googleapis.com/v00.00.00000/services/storagebatchoperations.yaml + title: Storage Batch Operations API + version: v00.00.00000 + description: '' storagetransfer: id: storagetransfer:v00.00.00000 name: storagetransfer @@ -1604,17 +1697,6 @@ providerServices: description: >- Transfers data from external data sources to a Google Cloud Storage bucket or between Google Cloud Storage buckets. - testing: - id: testing:v00.00.00000 - name: testing - preferred: true - service: - $ref: googleapis.com/v00.00.00000/services/testing.yaml - title: Cloud Testing API - version: v00.00.00000 - description: >- - Allows developers to run automated tests for their mobile applications on - Google infrastructure. texttospeech: id: texttospeech:v00.00.00000 name: texttospeech diff --git a/providers/src/googleapis.com/v00.00.00000/services/accessapproval.yaml b/providers/src/googleapis.com/v00.00.00000/services/accessapproval.yaml index 7dcbcb1b..f645490f 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/accessapproval.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/accessapproval.yaml @@ -7,8 +7,8 @@ info: title: Access Approval API description: An API for controlling access to data by Google personnel. version: v1 - x-discovery-doc-revision: '20241025' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250821' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/assured-workloads/access-approval/docs servers: @@ -222,6 +222,11 @@ components: autoApproved: description: True when the request has been auto-approved. type: boolean + policyApproved: + description: >- + True when the request has been approved by the customer's defined + policy. + type: boolean SignatureInfo: id: SignatureInfo description: Information about the digital signature of the resource. @@ -294,6 +299,21 @@ components: - >- Algorithm representing symmetric encryption by an external key manager. + - ML-KEM-768 (FIPS 203) + - ML-KEM-1024 (FIPS 203) + - >- + X-Wing hybrid KEM combining ML-KEM-768 with X25519 following + datatracker.ietf.org/doc/draft-connolly-cfrg-xwing-kem/. + - >- + The post-quantum Module-Lattice-Based Digital Signature Algorithm, + at security level 3. Randomized version. + - >- + The post-quantum stateless hash-based digital signature algorithm, + at security level 1. Randomized version. + - >- + The post-quantum stateless hash-based digital signature algorithm, + at security level 1. Randomized pre-hash version supporting SHA256 + digests. enum: - CRYPTO_KEY_VERSION_ALGORITHM_UNSPECIFIED - GOOGLE_SYMMETRIC_ENCRYPTION @@ -331,6 +351,12 @@ components: - HMAC_SHA512 - HMAC_SHA224 - EXTERNAL_SYMMETRIC_ENCRYPTION + - ML_KEM_768 + - ML_KEM_1024 + - KEM_XWING + - PQ_SIGN_ML_DSA_65 + - PQ_SIGN_SLH_DSA_SHA2_128S + - PQ_SIGN_HASH_SLH_DSA_SHA2_128S_SHA256 serializedApprovalRequest: description: >- The ApprovalRequest that is serialized without the SignatureInfo @@ -492,6 +518,16 @@ components: - ORGANIZATION - FOLDER - PROJECT + approvalPolicy: + description: Optional. Policy for approval. This contains all policies. + $ref: '#/components/schemas/CustomerApprovalApprovalPolicy' + effectiveApprovalPolicy: + description: >- + Output only. Policy for approval included inherited settings to + understand the exact policy applied to this resource. This is a + read-only field. + readOnly: true + $ref: '#/components/schemas/CustomerApprovalApprovalPolicy' EnrolledService: id: EnrolledService description: Represents the enrollment of a cloud resource into a specific service. @@ -536,6 +572,26 @@ components: enum: - ENROLLMENT_LEVEL_UNSPECIFIED - BLOCK_ALL + CustomerApprovalApprovalPolicy: + id: CustomerApprovalApprovalPolicy + description: Represents all the policies that can be set for Customer Approval. + type: object + properties: + justificationBasedApprovalPolicy: + description: Optional. Policy for approval based on the justification given. + type: string + enumDescriptions: + - Default value for proto. + - Instant approval is enabled for all accesses. + - Instant approval is enabled for external justifications. + - Instant approval is not enabled for any accesses. + - Instant approval is inherited from the parent. + enum: + - JUSTIFICATION_BASED_APPROVAL_POLICY_UNSPECIFIED + - JUSTIFICATION_BASED_APPROVAL_ENABLED_ALL + - JUSTIFICATION_BASED_APPROVAL_ENABLED_EXTERNAL_JUSTIFICATIONS + - JUSTIFICATION_BASED_APPROVAL_NOT_ENABLED + - JUSTIFICATION_BASED_APPROVAL_INHERITED Empty: id: Empty description: >- diff --git a/providers/src/googleapis.com/v00.00.00000/services/accesscontextmanager.yaml b/providers/src/googleapis.com/v00.00.00000/services/accesscontextmanager.yaml index 4c36a142..f943666a 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/accesscontextmanager.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/accesscontextmanager.yaml @@ -17,8 +17,8 @@ info: Modifications using v1alpha should be limited to policies with non-production/non-critical service perimeters. version: v1 - x-discovery-doc-revision: '20241028' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250805' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/access-context-manager/docs/reference/rest/ servers: @@ -676,6 +676,13 @@ components: use_explicit_dry_run_spec must bet set to True if any of the fields in the spec are set to non-default values. type: boolean + etag: + description: >- + Optional. An opaque identifier for the current version of the + `ServicePerimeter`. This identifier does not follow any specific + format. If an etag is not provided, the operation will be performed + as if a valid etag is provided. + type: string ServicePerimeterConfig: id: ServicePerimeterConfig description: >- @@ -784,6 +791,13 @@ components: Defines the conditions on the ApiOperation and request destination that cause this IngressPolicy to apply. $ref: '#/components/schemas/IngressTo' + title: + description: >- + Optional. Human-readable title for the ingress rule. The title must + be unique within the perimeter and can not exceed 100 characters. + Within the access policy, the combined length of all rule titles + must not exceed 240,000 characters. + type: string IngressFrom: id: IngressFrom description: >- @@ -884,6 +898,14 @@ components: type: array items: type: string + roles: + description: >- + IAM roles that represent the set of operations that the sources + specified in the corresponding IngressFrom are allowed to perform in + this ServicePerimeter. + type: array + items: + type: string ApiOperation: id: ApiOperation description: Identification for an API Operation. @@ -950,6 +972,13 @@ components: Defines the conditions on the ApiOperation and destination resources that cause this EgressPolicy to apply. $ref: '#/components/schemas/EgressTo' + title: + description: >- + Optional. Human-readable title for the egress rule. The title must + be unique within the perimeter and can not exceed 100 characters. + Within the access policy, the combined length of all rule titles + must not exceed 240,000 characters. + type: string EgressFrom: id: EgressFrom description: >- @@ -1037,6 +1066,13 @@ components: specified for `access_level`, then all EgressSources will be allowed. type: string + resource: + description: >- + A Google Cloud resource from the service perimeter that you want to + allow to access data outside the perimeter. This field supports only + projects. The project format is `projects/{project_number}`. You + can't use `*` in this field to allow all Google Cloud resources. + type: string EgressTo: id: EgressTo description: >- @@ -1080,6 +1116,14 @@ components: type: array items: type: string + roles: + description: >- + IAM roles that represent the set of operations that the sources + specified in the corresponding EgressFrom. are allowed to perform in + this ServicePerimeter. + type: array + items: + type: string ReplaceServicePerimetersRequest: id: ReplaceServicePerimetersRequest description: >- @@ -1271,9 +1315,9 @@ components: type: string groupKey: description: >- - Required. Immutable. Google Group id whose members are subject to - this binding's restrictions. See "id" in the [G Suite Directory - API's Groups resource] + Optional. Immutable. Google Group id whose users are subject to this + binding's restrictions. See "id" in the [Google Workspace Directory + API's Group Resource] (https://developers.google.com/admin-sdk/directory/v1/reference/groups#resource). If a group's email address/alias is changed, this resource will continue to point at the changed group. This field does not accept @@ -1298,13 +1342,10 @@ components: type: array items: type: string - reauthSettings: - description: Optional. GCSL policy for the group key. - $ref: '#/components/schemas/ReauthSettings' sessionSettings: description: >- - Optional. GCSL policy for the group key. Migrated from - ReauthSettings + Optional. The Google Cloud session length (GCSL) policy for the + group key. $ref: '#/components/schemas/SessionSettings' restrictedClientApplications: description: >- @@ -1322,62 +1363,6 @@ components: type: array items: $ref: '#/components/schemas/ScopedAccessSettings' - ReauthSettings: - id: ReauthSettings - description: >- - Stores settings related to Google Cloud Session Length including session - duration, the type of challenge (i.e. method) they should face when - their session expires, and other related settings. - type: object - properties: - reauthMethod: - description: Optional. Reauth method when users GCP session is up. - type: string - enumDescriptions: - - If method undefined in API, we will use LOGIN by default. - - >- - The user will prompted to perform regular login. Users who are - enrolled for two-step verification and haven't chosen to "Remember - this computer" will be prompted for their second factor. - - >- - The user will be prompted to autheticate using their security key. - If no security key has been configured, then we will fallback to - LOGIN. - - The user will be prompted for their password. - enum: - - REAUTH_METHOD_UNSPECIFIED - - LOGIN - - SECURITY_KEY - - PASSWORD - sessionLength: - description: >- - Optional. The session length. Setting this field to zero is equal to - disabling. Reauth. Also can set infinite session by flipping the - enabled bit to false below. If use_oidc_max_age is true, for OIDC - apps, the session length will be the minimum of this field and OIDC - max_age param. - type: string - format: google-duration - maxInactivity: - description: >- - Optional. How long a user is allowed to take between actions before - a new access token must be issued. Presently only set for Cloud - Apps. - type: string - format: google-duration - useOidcMaxAge: - description: >- - Optional. Only useful for OIDC apps. When false, the OIDC max_age - param, if passed in the authentication request will be ignored. When - true, the re-auth period will be the minimum of the session_length - field and the max_age OIDC param. - type: boolean - sessionLengthEnabled: - description: >- - Optional. Big red button to turn off GCSL. When false, all fields - set above will be disregarded and the session length is basically - infinite. - type: boolean SessionSettings: id: SessionSettings description: >- @@ -1387,18 +1372,18 @@ components: type: object properties: sessionReauthMethod: - description: Optional. Session method when users GCP session is up. + description: Optional. Session method when user's Google Cloud session is up. type: string enumDescriptions: - - If method undefined in API, we will use LOGIN by default. + - If method is undefined in the API, LOGIN will be used by default. - >- - The user will prompted to perform regular login. Users who are - enrolled for two-step verification and haven't chosen to "Remember + The user will be prompted to perform regular login. Users who are + enrolled for two-step verification and haven't chosen "Remember this computer" will be prompted for their second factor. - >- - The user will be prompted to autheticate using their security key. - If no security key has been configured, then we will fallback to - LOGIN. + The user will be prompted to authenticate using their security + key. If no security key has been configured, then authentication + will fallback to LOGIN. - The user will be prompted for their password. enum: - SESSION_REAUTH_METHOD_UNSPECIFIED @@ -1408,7 +1393,7 @@ components: sessionLength: description: >- Optional. The session length. Setting this field to zero is equal to - disabling. Session. Also can set infinite session by flipping the + disabling session. Also can set infinite session by flipping the enabled bit to false below. If use_oidc_max_age is true, for OIDC apps, the session length will be the minimum of this field and OIDC max_age param. @@ -1417,8 +1402,7 @@ components: maxInactivity: description: >- Optional. How long a user is allowed to take between actions before - a new access token must be issued. Presently only set for Cloud - Apps. + a new access token must be issued. Only set for Google Cloud apps. type: string format: google-duration useOidcMaxAge: @@ -1430,9 +1414,9 @@ components: type: boolean sessionLengthEnabled: description: >- - Optional. Big red button to turn off GCSL. When false, all fields - set above will be disregarded and the session length is basically - infinite. + Optional. This field enables or disables Google Cloud session + length. When false, all fields set above will be disregarded and the + session length is basically infinite. type: boolean Application: id: Application @@ -1502,15 +1486,10 @@ components: type: array items: type: string - reauthSettings: - description: >- - Optional. Reauth settings applied to user access on a given - AccessScope. - $ref: '#/components/schemas/ReauthSettings' sessionSettings: description: >- Optional. Session settings applied to user access on a given - AccessScope. Migrated from ReauthSettings + AccessScope. $ref: '#/components/schemas/SessionSettings' SetIamPolicyRequest: id: SetIamPolicyRequest @@ -1960,7 +1939,7 @@ components: $ref: '#/components/schemas/ServicePerimeter' GcpUserAccessBindingOperationMetadata: id: GcpUserAccessBindingOperationMetadata - description: Metadata of GCP Access Binding Long Running Operations. + description: Metadata of Google Cloud Access Binding Long Running Operations. type: object properties: {} AccessContextManagerOperationMetadata: @@ -2580,7 +2559,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: accesscontextmanager.operations.cancel requestBody: content: diff --git a/providers/src/googleapis.com/v00.00.00000/services/addressvalidation.yaml b/providers/src/googleapis.com/v00.00.00000/services/addressvalidation.yaml index 2017dd05..e9d13456 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/addressvalidation.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/addressvalidation.yaml @@ -11,8 +11,8 @@ info: the components of the parsed address, a geocode, and a verdict on the deliverability of the parsed address. version: v1 - x-discovery-doc-revision: '20241030' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250826' + x-generated-date: '2025-08-28' externalDocs: url: https://developers.google.com/maps/documentation/addressvalidation servers: @@ -41,272 +41,261 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleMapsAddressvalidationV1Geocode: - description: Contains information about the place the input was geocoded to. + GoogleMapsAddressvalidationV1ValidateAddressRequest: + id: GoogleMapsAddressvalidationV1ValidateAddressRequest + description: The request for validating an address. + type: object properties: - plusCode: - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1PlusCode' - description: The plus code corresponding to the `location`. - location: + address: description: >- - The geocoded location of the input. Using place IDs is preferred - over using addresses, latitude/longitude coordinates, or plus codes. - Using coordinates when routing or calculating driving directions - will always result in the point being snapped to the road nearest to - those coordinates. This may not be a road that will quickly or - safely lead to the destination and may not be near an access point - to the property. Additionally, when a location is reverse geocoded, - there is no guarantee that the returned address will match the - original. - $ref: '#/components/schemas/GoogleTypeLatLng' - placeId: + Required. The address being validated. Unformatted addresses should + be submitted via `address_lines`. The total length of the fields in + this input must not exceed 280 characters. Supported regions can be + found + [here](https://developers.google.com/maps/documentation/address-validation/coverage). + The language_code value in the input address is reserved for future + uses and is ignored today. The validated address result will be + populated based on the preferred language for the given address, as + identified by the system. The Address Validation API ignores the + values in recipients and organization. Any values in those fields + will be discarded and not returned. Please do not set them. + $ref: '#/components/schemas/GoogleTypePostalAddress' + previousResponseId: + description: >- + This field must be empty for the first address validation request. + If more requests are necessary to fully validate a single address + (for example if the changes the user makes after the initial + validation need to be re-validated), then each followup request must + populate this field with the response_id from the very first + response in the validation sequence. type: string + enableUspsCass: description: >- - The PlaceID of the place this input geocodes to. For more - information about Place IDs see - [here](https://developers.google.com/maps/documentation/places/web-service/place-id). - featureSizeMeters: - format: float + Enables USPS CASS compatible mode. This affects _only_ the + [google.maps.addressvalidation.v1.ValidationResult.usps_data] field + of [google.maps.addressvalidation.v1.ValidationResult]. Note: for + USPS CASS enabled requests for addresses in Puerto Rico, a + [google.type.PostalAddress.region_code] of the `address` must be + provided as "PR", or an + [google.type.PostalAddress.administrative_area] of the `address` + must be provided as "Puerto Rico" (case-insensitive) or "PR". It's + recommended to use a componentized `address`, or alternatively + specify at least two [google.type.PostalAddress.address_lines] where + the first line contains the street number and name and the second + line contains the city, state, and zip code. + type: boolean + languageOptions: description: >- - The size of the geocoded place, in meters. This is another measure - of the coarseness of the geocoded location, but in physical size - rather than in semantic meaning. - type: number - placeTypes: - items: - type: string - type: array + Optional. Preview: This feature is in Preview (pre-GA). Pre-GA + products and features might have limited support, and changes to + pre-GA products and features might not be compatible with other + pre-GA versions. Pre-GA Offerings are covered by the [Google Maps + Platform Service Specific + Terms](https://cloud.google.com/maps-platform/terms/maps-service-terms). + For more information, see the [launch stage + descriptions](https://developers.google.com/maps/launch-stages). + Enables the Address Validation API to include additional information + in the response. + $ref: '#/components/schemas/GoogleMapsAddressvalidationV1LanguageOptions' + sessionToken: description: >- - The type(s) of place that the input geocoded to. For example, - `['locality', 'political']`. The full list of types can be found - [here](https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types). - bounds: - description: The bounds of the geocoded place. - $ref: '#/components/schemas/GoogleGeoTypeViewport' + Optional. A string which identifies an Autocomplete session for + billing purposes. Must be a URL and filename safe base64 string with + at most 36 ASCII characters in length. Otherwise an INVALID_ARGUMENT + error is returned. The session begins when the user makes an + Autocomplete query, and concludes when they select a place and a + call to Place Details or Address Validation is made. Each session + can have multiple Autocomplete queries, followed by one Place + Details or Address Validation request. The credentials used for each + request within a session must belong to the same Google Cloud + Console project. Once a session has concluded, the token is no + longer valid; your app must generate a fresh token for each session. + If the `sessionToken` parameter is omitted, or if you reuse a + session token, the session is charged as if no session token was + provided (each request is billed separately). Note: Address + Validation can only be used in sessions with the Autocomplete (New) + API, not the Autocomplete API. See + https://developers.google.com/maps/documentation/places/web-service/session-pricing + for more details. + type: string + GoogleTypePostalAddress: + id: GoogleTypePostalAddress + description: >- + Represents a postal address, such as for postal delivery or payments + addresses. With a postal address, a postal service can deliver items to + a premise, P.O. box, or similar. A postal address is not intended to + model geographical locations like roads, towns, or mountains. In typical + usage, an address would be created by user input or from importing + existing data, depending on the type of process. Advice on address input + or editing: - Use an internationalization-ready address widget such as + https://github.com/google/libaddressinput. - Users should not be + presented with UI elements for input or editing of fields outside + countries where that field is used. For more guidance on how to use this + schema, see: https://support.google.com/business/answer/6397478. type: object - id: GoogleMapsAddressvalidationV1Geocode - GoogleMapsAddressvalidationV1PlusCode: - id: GoogleMapsAddressvalidationV1PlusCode properties: - compoundCode: + revision: description: >- - Place's compound code, such as "33GV+HQ, Ramberg, Norway", - containing the suffix of the global code and replacing the prefix - with a formatted name of a reference entity. + The schema revision of the `PostalAddress`. This must be set to 0, + which is the latest revision. All new revisions **must** be backward + compatible with old revisions. + type: integer + format: int32 + regionCode: + description: >- + Required. CLDR region code of the country/region of the address. + This is never inferred and it is up to the user to ensure the value + is correct. See https://cldr.unicode.org/ and + https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html + for details. Example: "CH" for Switzerland. type: string - globalCode: + languageCode: description: >- - Place's global (full) code, such as "9FWM33GV+HQ", representing an - 1/8000 by 1/8000 degree area (~14 by 14 meters). + Optional. BCP-47 language code of the contents of this address (if + known). This is often the UI language of the input form or is + expected to match one of the languages used in the address' + country/region, or their transliterated equivalents. This can affect + formatting in certain countries, but is not critical to the + correctness of the data and will never affect any validation or + other non-formatting related operations. If this value is not known, + it should be omitted (rather than specifying a possibly incorrect + default). Examples: "zh-Hant", "ja", "ja-Latn", "en". type: string - type: object - description: >- - Plus code (http://plus.codes) is a location reference with two formats: - global code defining a 14mx14m (1/8000th of a degree) or smaller - rectangle, and compound code, replacing the prefix with a reference - location. - GoogleMapsAddressvalidationV1Address: - description: >- - Details of the post-processed address. Post-processing includes - correcting misspelled parts of the address, replacing incorrect parts, - and inferring missing parts. - properties: - unresolvedTokens: - items: - type: string - type: array + postalCode: description: >- - Any tokens in the input that could not be resolved. This might be an - input that was not recognized as a valid part of an address (for - example in an input like "123235253253 Main St, San Francisco, CA, - 94105", the unresolved tokens may look like `["123235253253"]` since - that does not look like a valid street number. - postalAddress: - $ref: '#/components/schemas/GoogleTypePostalAddress' - description: The post-processed address represented as a postal address. - missingComponentTypes: - type: array - items: - type: string + Optional. Postal code of the address. Not all countries use or + require postal codes to be present, but where they are used, they + may trigger additional validation with other parts of the address + (for example, state or zip code validation in the United States). + type: string + sortingCode: description: >- - The types of components that were expected to be present in a - correctly formatted mailing address but were not found in the input - AND could not be inferred. Components of this type are not present - in `formatted_address`, `postal_address`, or `address_components`. - An example might be `['street_number', 'route']` for an input like - "Boulder, Colorado, 80301, USA". The list of possible types can be - found - [here](https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types). - addressComponents: + Optional. Additional, country-specific, sorting code. This is not + used in most regions. Where it is used, the value is either a string + like "CEDEX", optionally followed by a number (for example, "CEDEX + 7"), or just a number alone, representing the "sector code" + (Jamaica), "delivery area indicator" (Malawi) or "post office + indicator" (Côte d'Ivoire). + type: string + administrativeArea: description: >- - Unordered list. The individual address components of the formatted - and corrected address, along with validation information. This - provides information on the validation status of the individual - components. Address components are not ordered in a particular way. - Do not make any assumptions on the ordering of the address - components in the list. - items: - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1AddressComponent' - type: array - unconfirmedComponentTypes: - items: - type: string + Optional. Highest administrative subdivision which is used for + postal addresses of a country or region. For example, this can be a + state, a province, an oblast, or a prefecture. For Spain, this is + the province and not the autonomous community (for example, + "Barcelona" and not "Catalonia"). Many countries don't use an + administrative area in postal addresses. For example, in + Switzerland, this should be left unpopulated. + type: string + locality: description: >- - The types of the components that are present in the - `address_components` but could not be confirmed to be correct. This - field is provided for the sake of convenience: its contents are - equivalent to iterating through the `address_components` to find the - types of all the components where the confirmation_level is not - CONFIRMED or the inferred flag is not set to `true`. The list of - possible types can be found - [here](https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types). - type: array - formattedAddress: + Optional. Generally refers to the city or town portion of the + address. Examples: US city, IT comune, UK post town. In regions of + the world where localities are not well defined or do not fit into + this structure well, leave `locality` empty and use `address_lines`. + type: string + sublocality: description: >- - The post-processed address, formatted as a single-line address - following the address formatting rules of the region where the - address is located. + Optional. Sublocality of the address. For example, this can be a + neighborhood, borough, or district. type: string - id: GoogleMapsAddressvalidationV1Address - type: object - GoogleTypePostalAddress: - properties: addressLines: - type: array description: >- Unstructured address lines describing the lower levels of an - address. Because values in address_lines do not have type + address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single - field (e.g. "Austin, TX"), it is important that the line order is - clear. The order of address lines should be "envelope order" for the - country/region of the address. In places where this can vary (e.g. - Japan), address_language is used to make it explicit (e.g. "ja" for - large-to-small ordering and "ja-Latn" or "en" for small-to-large). - This way, the most specific line of an address can be selected based - on the language. The minimum permitted structural representation of - an address consists of a region_code with all remaining information - placed in the address_lines. It would be possible to format such an - address very approximately without geocoding, but no semantic - reasoning could be made about any of the address components until it - was at least partially resolved. Creating an address only containing - a region_code and address_lines, and then geocoding is the + field (for example, "Austin, TX"), it is important that the line + order is clear. The order of address lines should be "envelope + order" for the country or region of the address. In places where + this can vary (for example, Japan), `address_language` is used to + make it explicit (for example, "ja" for large-to-small ordering and + "ja-Latn" or "en" for small-to-large). In this way, the most + specific line of an address can be selected based on the language. + The minimum permitted structural representation of an address + consists of a `region_code` with all remaining information placed in + the `address_lines`. It would be possible to format such an address + very approximately without geocoding, but no semantic reasoning + could be made about any of the address components until it was at + least partially resolved. Creating an address only containing a + `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). + type: array items: type: string recipients: - items: - type: string description: >- Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information. type: array - locality: - type: string - description: >- - Optional. Generally refers to the city/town portion of the address. - Examples: US city, IT comune, UK post town. In regions of the world - where localities are not well defined or do not fit into this - structure well, leave locality empty and use address_lines. - sublocality: - type: string - description: >- - Optional. Sublocality of the address. For example, this can be - neighborhoods, boroughs, districts. - sortingCode: - type: string - description: >- - Optional. Additional, country-specific, sorting code. This is not - used in most regions. Where it is used, the value is either a string - like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or - just a number alone, representing the "sector code" (Jamaica), - "delivery area indicator" (Malawi) or "post office indicator" (e.g. - Côte d'Ivoire). - administrativeArea: - type: string - description: >- - Optional. Highest administrative subdivision which is used for - postal addresses of a country or region. For example, this can be a - state, a province, an oblast, or a prefecture. Specifically, for - Spain this is the province and not the autonomous community (e.g. - "Barcelona" and not "Catalonia"). Many countries don't use an - administrative area in postal addresses. E.g. in Switzerland this - should be left unpopulated. - regionCode: - description: >- - Required. CLDR region code of the country/region of the address. - This is never inferred and it is up to the user to ensure the value - is correct. See https://cldr.unicode.org/ and - https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html - for details. Example: "CH" for Switzerland. - type: string - organization: - type: string - description: Optional. The name of the organization at the address. - revision: - type: integer - format: int32 - description: >- - The schema revision of the `PostalAddress`. This must be set to 0, - which is the latest revision. All new revisions **must** be backward - compatible with old revisions. - postalCode: - description: >- - Optional. Postal code of the address. Not all countries use or - require postal codes to be present, but where they are used, they - may trigger additional validation with other parts of the address - (e.g. state/zip validation in the U.S.A.). - type: string - languageCode: - description: >- - Optional. BCP-47 language code of the contents of this address (if - known). This is often the UI language of the input form or is - expected to match one of the languages used in the address' - country/region, or their transliterated equivalents. This can affect - formatting in certain countries, but is not critical to the - correctness of the data and will never affect any validation or - other non-formatting related operations. If this value is not known, - it should be omitted (rather than specifying a possibly incorrect - default). Examples: "zh-Hant", "ja", "ja-Latn", "en". + items: + type: string + organization: + description: Optional. The name of the organization at the address. type: string + GoogleMapsAddressvalidationV1LanguageOptions: + id: GoogleMapsAddressvalidationV1LanguageOptions description: >- - Represents a postal address, e.g. for postal delivery or payments - addresses. Given a postal address, a postal service can deliver items to - a premise, P.O. Box or similar. It is not intended to model geographical - locations (roads, towns, mountains). In typical usage an address would - be created via user input or from importing existing data, depending on - the type of process. Advice on address input / editing: - Use an - internationalization-ready address widget such as - https://github.com/google/libaddressinput) - Users should not be - presented with UI elements for input or editing of fields outside - countries where that field is used. For more guidance on how to use this - schema, please see: https://support.google.com/business/answer/6397478 - id: GoogleTypePostalAddress + Preview: This feature is in Preview (pre-GA). Pre-GA products and + features might have limited support, and changes to pre-GA products and + features might not be compatible with other pre-GA versions. Pre-GA + Offerings are covered by the [Google Maps Platform Service Specific + Terms](https://cloud.google.com/maps-platform/terms/maps-service-terms). + For more information, see the [launch stage + descriptions](https://developers.google.com/maps/launch-stages). Enables + the Address Validation API to include additional information in the + response. + type: object + properties: + returnEnglishLatinAddress: + description: >- + Preview: Return a [google.maps.addressvalidation.v1.Address] in + English. See + [google.maps.addressvalidation.v1.ValidationResult.english_latin_address] + for details. + type: boolean + GoogleMapsAddressvalidationV1ValidateAddressResponse: + id: GoogleMapsAddressvalidationV1ValidateAddressResponse + description: The response to an address validation request. type: object + properties: + result: + description: The result of the address validation. + $ref: '#/components/schemas/GoogleMapsAddressvalidationV1ValidationResult' + responseId: + description: >- + The UUID that identifies this response. If the address needs to be + re-validated, this UUID *must* accompany the new request. + type: string GoogleMapsAddressvalidationV1ValidationResult: + id: GoogleMapsAddressvalidationV1ValidationResult + description: The result of validating an address. type: object properties: + verdict: + description: Overall verdict flags + $ref: '#/components/schemas/GoogleMapsAddressvalidationV1Verdict' + address: + description: Information about the address itself as opposed to the geocode. + $ref: '#/components/schemas/GoogleMapsAddressvalidationV1Address' + geocode: + description: >- + Information about the location and place that the address geocoded + to. + $ref: '#/components/schemas/GoogleMapsAddressvalidationV1Geocode' metadata: description: >- Other information relevant to deliverability. `metadata` is not guaranteed to be fully populated for every address sent to the Address Validation API. $ref: '#/components/schemas/GoogleMapsAddressvalidationV1AddressMetadata' - geocode: - description: >- - Information about the location and place that the address geocoded - to. - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1Geocode' - verdict: - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1Verdict' - description: Overall verdict flags uspsData: - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1UspsData' description: >- Extra deliverability flags provided by USPS. Only provided in region `US` and `PR`. + $ref: '#/components/schemas/GoogleMapsAddressvalidationV1UspsData' englishLatinAddress: description: >- Preview: This feature is in Preview (pre-GA). Pre-GA products and @@ -337,135 +326,294 @@ components: fields in `english_latin_address.address_components` are not populated. $ref: '#/components/schemas/GoogleMapsAddressvalidationV1Address' - address: - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1Address' - description: Information about the address itself as opposed to the geocode. - id: GoogleMapsAddressvalidationV1ValidationResult - description: The result of validating an address. - GoogleMapsAddressvalidationV1ValidateAddressRequest: - id: GoogleMapsAddressvalidationV1ValidateAddressRequest + GoogleMapsAddressvalidationV1Verdict: + id: GoogleMapsAddressvalidationV1Verdict + description: High level overview of the address validation result and geocode. + type: object properties: - address: - $ref: '#/components/schemas/GoogleTypePostalAddress' + inputGranularity: description: >- - Required. The address being validated. Unformatted addresses should - be submitted via `address_lines`. The total length of the fields in - this input must not exceed 280 characters. Supported regions can be - found - [here](https://developers.google.com/maps/documentation/address-validation/coverage). - The language_code value in the input address is reserved for future - uses and is ignored today. The validated address result will be - populated based on the preferred language for the given address, as - identified by the system. The Address Validation API ignores the - values in recipients and organization. Any values in those fields - will be discarded and not returned. Please do not set them. - languageOptions: - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1LanguageOptions' + The granularity of the **input** address. This is the result of + parsing the input address and does not give any validation signals. + For validation signals, refer to `validation_granularity` below. For + example, if the input address includes a specific apartment number, + then the `input_granularity` here will be `SUB_PREMISE`. If the + address validation service cannot match the apartment number in the + databases or the apartment number is invalid, the + `validation_granularity` will likely be `PREMISE` or more coarse. + type: string + enumDescriptions: + - Default value. This value is unused. + - Below-building level result, such as an apartment. + - Building-level result. + - >- + A geocode that approximates the building-level location of the + address. + - >- + The address or geocode indicates a block. Only used in regions + which have block-level addressing, such as Japan. + - >- + The geocode or address is granular to route, such as a street, + road, or highway. + - >- + All other granularities, which are bucketed together since they + are not deliverable. + enum: + - GRANULARITY_UNSPECIFIED + - SUB_PREMISE + - PREMISE + - PREMISE_PROXIMITY + - BLOCK + - ROUTE + - OTHER + validationGranularity: description: >- - Optional. Preview: This feature is in Preview (pre-GA). Pre-GA - products and features might have limited support, and changes to - pre-GA products and features might not be compatible with other - pre-GA versions. Pre-GA Offerings are covered by the [Google Maps - Platform Service Specific + The level of granularity for the post-processed address that the API + can fully validate. For example, a `validation_granularity` of + `PREMISE` indicates all address components at the level of `PREMISE` + or more coarse can be validated. Per address component validation + result can be found in + [google.maps.addressvalidation.v1.Address.address_components]. + type: string + enumDescriptions: + - Default value. This value is unused. + - Below-building level result, such as an apartment. + - Building-level result. + - >- + A geocode that approximates the building-level location of the + address. + - >- + The address or geocode indicates a block. Only used in regions + which have block-level addressing, such as Japan. + - >- + The geocode or address is granular to route, such as a street, + road, or highway. + - >- + All other granularities, which are bucketed together since they + are not deliverable. + enum: + - GRANULARITY_UNSPECIFIED + - SUB_PREMISE + - PREMISE + - PREMISE_PROXIMITY + - BLOCK + - ROUTE + - OTHER + geocodeGranularity: + description: >- + Information about the granularity of the `geocode`. This can be + understood as the semantic meaning of how coarse or fine the + geocoded location is. This can differ from the + `validation_granularity` above occasionally. For example, our + database might record the existence of an apartment number but do + not have a precise location for the apartment within a big apartment + complex. In that case, the `validation_granularity` will be + `SUB_PREMISE` but the `geocode_granularity` will be `PREMISE`. + type: string + enumDescriptions: + - Default value. This value is unused. + - Below-building level result, such as an apartment. + - Building-level result. + - >- + A geocode that approximates the building-level location of the + address. + - >- + The address or geocode indicates a block. Only used in regions + which have block-level addressing, such as Japan. + - >- + The geocode or address is granular to route, such as a street, + road, or highway. + - >- + All other granularities, which are bucketed together since they + are not deliverable. + enum: + - GRANULARITY_UNSPECIFIED + - SUB_PREMISE + - PREMISE + - PREMISE_PROXIMITY + - BLOCK + - ROUTE + - OTHER + addressComplete: + description: >- + The post-processed address is considered complete if there are no + unresolved tokens, no unexpected or missing address components. If + unset, indicates that the value is `false`. See + `missing_component_types`, `unresolved_tokens` or `unexpected` + fields for more details. + type: boolean + hasUnconfirmedComponents: + description: >- + At least one address component cannot be categorized or validated, + see [google.maps.addressvalidation.v1.Address.address_components] + for details. + type: boolean + hasInferredComponents: + description: >- + At least one address component was inferred (added) that wasn't in + the input, see + [google.maps.addressvalidation.v1.Address.address_components] for + details. + type: boolean + hasReplacedComponents: + description: >- + At least one address component was replaced, see + [google.maps.addressvalidation.v1.Address.address_components] for + details. + type: boolean + possibleNextAction: + description: >- + Preview: This feature is in Preview (pre-GA). Pre-GA products and + features might have limited support, and changes to pre-GA products + and features might not be compatible with other pre-GA versions. + Pre-GA Offerings are covered by the [Google Maps Platform Service + Specific Terms](https://cloud.google.com/maps-platform/terms/maps-service-terms). For more information, see the [launch stage descriptions](https://developers.google.com/maps/launch-stages). - Enables the Address Validation API to include additional information - in the response. - sessionToken: - description: >- - Optional. A string which identifies an Autocomplete session for - billing purposes. Must be a URL and filename safe base64 string with - at most 36 ASCII characters in length. Otherwise an INVALID_ARGUMENT - error is returned. The session begins when the user makes an - Autocomplete query, and concludes when they select a place and a - call to Place Details or Address Validation is made. Each session - can have multiple Autocomplete queries, followed by one Place - Details or Address Validation request. The credentials used for each - request within a session must belong to the same Google Cloud - Console project. Once a session has concluded, the token is no - longer valid; your app must generate a fresh token for each session. - If the `sessionToken` parameter is omitted, or if you reuse a - session token, the session is charged as if no session token was - provided (each request is billed separately). Note: Address - Validation can only be used in sessions with the Autocomplete (New) - API, not the Autocomplete API. See - https://developers.google.com/maps/documentation/places/web-service/session-pricing + Offers an interpretive summary of the API response, intended to + assist in determining a potential subsequent action to take. This + field is derived from other fields in the API response and should + not be considered as a guarantee of address accuracy or + deliverability. See [Build your validation + logic](https://developers.google.com/maps/documentation/address-validation/build-validation-logic) for more details. type: string - enableUspsCass: - description: >- - Enables USPS CASS compatible mode. This affects _only_ the - [google.maps.addressvalidation.v1.ValidationResult.usps_data] field - of [google.maps.addressvalidation.v1.ValidationResult]. Note: for - USPS CASS enabled requests for addresses in Puerto Rico, a - [google.type.PostalAddress.region_code] of the `address` must be - provided as "PR", or an - [google.type.PostalAddress.administrative_area] of the `address` - must be provided as "Puerto Rico" (case-insensitive) or "PR". It's - recommended to use a componentized `address`, or alternatively - specify at least two [google.type.PostalAddress.address_lines] where - the first line contains the street number and name and the second - line contains the city, state, and zip code. + enumDescriptions: + - Default value. This value is unused. + - >- + One or more fields of the API response indicate a potential issue + with the post-processed address, for example the + `verdict.validation_granularity` is `OTHER`. Prompting your + customer to edit the address could help improve the quality of the + address. + - >- + The API response indicates the post-processed address might be + missing a subpremises. Prompting your customer to review the + address and consider adding a unit number could help improve the + quality of the address. The post-processed address might also have + other minor issues. Note: this enum value can only be returned for + US addresses. + - >- + One or more fields of the API response indicate potential minor + issues with the post-processed address, for example the + `postal_code` address component was `replaced`. Prompting your + customer to review the address could help improve the quality of + the address. + - >- + The API response does not contain signals that warrant one of the + other PossibleNextAction values. You might consider using the + post-processed address without further prompting your customer, + though this does not guarantee the address is valid, and the + address might still contain corrections. It is your responsibility + to determine if and how to prompt your customer, depending on your + own risk assessment. + enum: + - POSSIBLE_NEXT_ACTION_UNSPECIFIED + - FIX + - CONFIRM_ADD_SUBPREMISES + - CONFIRM + - ACCEPT + hasSpellCorrectedComponents: + description: >- + At least one address component was spell-corrected, see + [google.maps.addressvalidation.v1.Address.address_components] for + details. type: boolean - previousResponseId: - type: string - description: >- - This field must be empty for the first address validation request. - If more requests are necessary to fully validate a single address - (for example if the changes the user makes after the initial - validation need to be re-validated), then each followup request must - populate this field with the response_id from the very first - response in the validation sequence. - description: The request for validating an address. - type: object - GoogleGeoTypeViewport: + GoogleMapsAddressvalidationV1Address: + id: GoogleMapsAddressvalidationV1Address description: >- - A latitude-longitude viewport, represented as two diagonally opposite - `low` and `high` points. A viewport is considered a closed region, i.e. - it includes its boundary. The latitude bounds must range between -90 to - 90 degrees inclusive, and the longitude bounds must range between -180 - to 180 degrees inclusive. Various cases include: - If `low` = `high`, - the viewport consists of that single point. - If `low.longitude` > - `high.longitude`, the longitude range is inverted (the viewport crosses - the 180 degree longitude line). - If `low.longitude` = -180 degrees and - `high.longitude` = 180 degrees, the viewport includes all longitudes. - - If `low.longitude` = 180 degrees and `high.longitude` = -180 degrees, - the longitude range is empty. - If `low.latitude` > `high.latitude`, the - latitude range is empty. Both `low` and `high` must be populated, and - the represented box cannot be empty (as specified by the definitions - above). An empty viewport will result in an error. For example, this - viewport fully encloses New York City: { "low": { "latitude": 40.477398, - "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": - -73.70018 } } - id: GoogleGeoTypeViewport + Details of the post-processed address. Post-processing includes + correcting misspelled parts of the address, replacing incorrect parts, + and inferring missing parts. type: object properties: - low: - $ref: '#/components/schemas/GoogleTypeLatLng' - description: Required. The low point of the viewport. - high: - description: Required. The high point of the viewport. - $ref: '#/components/schemas/GoogleTypeLatLng' + formattedAddress: + description: >- + The post-processed address, formatted as a single-line address + following the address formatting rules of the region where the + address is located. Note: the format of this address may not match + the format of the address in the `postal_address` field. For + example, the `postal_address` always represents the country as a 2 + letter `region_code`, such as "US" or "NZ". By contrast, this field + uses a longer form of the country name, such as "USA" or "New + Zealand". + type: string + postalAddress: + description: The post-processed address represented as a postal address. + $ref: '#/components/schemas/GoogleTypePostalAddress' + addressComponents: + description: >- + Unordered list. The individual address components of the formatted + and corrected address, along with validation information. This + provides information on the validation status of the individual + components. Address components are not ordered in a particular way. + Do not make any assumptions on the ordering of the address + components in the list. + type: array + items: + $ref: '#/components/schemas/GoogleMapsAddressvalidationV1AddressComponent' + missingComponentTypes: + description: >- + The types of components that were expected to be present in a + correctly formatted mailing address but were not found in the input + AND could not be inferred. An example might be `['street_number', + 'route']` for an input like "Boulder, Colorado, 80301, USA". The + list of possible types can be found + [here](https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types). + **Note: you might see a missing component type when you think you've + already supplied the missing component.** For example, this can + happen when the input address contains the building name, but not + the premise number. In the address "渋谷区渋谷３丁目　Shibuya Stream", the + building name "Shibuya Stream" has the component type `premise`, but + the premise number is missing, so `missing_component_types` will + contain `premise`. + type: array + items: + type: string + unconfirmedComponentTypes: + description: >- + The types of the components that are present in the + `address_components` but could not be confirmed to be correct. This + field is provided for the sake of convenience: its contents are + equivalent to iterating through the `address_components` to find the + types of all the components where the confirmation_level is not + CONFIRMED or the inferred flag is not set to `true`. The list of + possible types can be found + [here](https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types). + type: array + items: + type: string + unresolvedTokens: + description: >- + Any tokens in the input that could not be resolved. This might be an + input that was not recognized as a valid part of an address. For + example, for an input such as "Parcel 0000123123 & 0000456456 Str # + Guthrie Center IA 50115 US", the unresolved tokens might look like + `["Parcel", "0000123123", "&", "0000456456"]`. + type: array + items: + type: string GoogleMapsAddressvalidationV1AddressComponent: - type: object + id: GoogleMapsAddressvalidationV1AddressComponent description: Represents an address component, such as a street, city, or state. + type: object properties: - inferred: + componentName: + description: The name for this component. + $ref: '#/components/schemas/GoogleMapsAddressvalidationV1ComponentName' + componentType: description: >- - Indicates that the component was not part of the input, but we - inferred it for the address location and believe it should be - provided for a complete address. - type: boolean + The type of the address component. See [Table 2: Additional types + returned by the Places + service](https://developers.google.com/places/web-service/supported_types#table2) + for a list of possible types. + type: string confirmationLevel: - enum: - - CONFIRMATION_LEVEL_UNSPECIFIED - - CONFIRMED - - UNCONFIRMED_BUT_PLAUSIBLE - - UNCONFIRMED_AND_SUSPICIOUS description: >- Indicates the level of certainty that we have that the component is correct. + type: string enumDescriptions: - Default value. This value is unused. - >- @@ -478,133 +626,97 @@ components: - >- This component was not confirmed and is likely to be wrong. For example, a neighborhood that does not fit the rest of the address. - type: string - componentName: - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1ComponentName' - description: The name for this component. - spellCorrected: + enum: + - CONFIRMATION_LEVEL_UNSPECIFIED + - CONFIRMED + - UNCONFIRMED_BUT_PLAUSIBLE + - UNCONFIRMED_AND_SUSPICIOUS + inferred: + description: >- + Indicates that the component was not part of the input, but we + inferred it for the address location and believe it should be + provided for a complete address. type: boolean + spellCorrected: description: >- Indicates a correction to a misspelling in the component name. The API does not always flag changes from one spelling variant to another, such as when changing "centre" to "center". It also does not always flag common misspellings, such as when changing "Amphitheater Pkwy" to "Amphitheatre Pkwy". - componentType: - description: >- - The type of the address component. See [Table 2: Additional types - returned by the Places - service](https://developers.google.com/places/web-service/supported_types#table2) - for a list of possible types. - type: string - replaced: type: boolean + replaced: description: >- Indicates the name of the component was replaced with a completely different one, for example a wrong postal code being replaced with one that is correct for the address. This is not a cosmetic change, the input component has been changed to a different one. - unexpected: type: boolean + unexpected: description: >- Indicates an address component that is not expected to be present in a postal address for the given region. We have retained it only because it was part of the input. - id: GoogleMapsAddressvalidationV1AddressComponent - GoogleMapsAddressvalidationV1UspsAddress: - id: GoogleMapsAddressvalidationV1UspsAddress - description: USPS representation of a US address. - properties: - city: - description: City name. - type: string - state: - description: 2 letter state code. - type: string - zipCode: - description: Postal code e.g. 10009. - type: string - cityStateZipAddressLine: - type: string - description: City + state + postal code. - firstAddressLine: - type: string - description: First address line. - firm: - description: Firm name. - type: string - urbanization: - type: string - description: Puerto Rican urbanization name. - zipCodeExtension: - description: 4-digit postal code extension e.g. 5023. - type: string - secondAddressLine: - description: Second address line. - type: string - type: object - GoogleMapsAddressvalidationV1ProvideValidationFeedbackRequest: - description: The request for sending validation feedback. - id: GoogleMapsAddressvalidationV1ProvideValidationFeedbackRequest + type: boolean + GoogleMapsAddressvalidationV1ComponentName: + id: GoogleMapsAddressvalidationV1ComponentName + description: A wrapper for the name of the component. type: object properties: - conclusion: - enum: - - VALIDATION_CONCLUSION_UNSPECIFIED - - VALIDATED_VERSION_USED - - USER_VERSION_USED - - UNVALIDATED_VERSION_USED - - UNUSED - type: string - enumDescriptions: - - >- - This value is unused. If the - `ProvideValidationFeedbackRequest.conclusion` field is set to - `VALIDATION_CONCLUSION_UNSPECIFIED`, an `INVALID_ARGUMENT` error - will be returned. - - >- - The version of the address returned by the Address Validation API - was used for the transaction. - - >- - The version of the address provided by the user was used for the - transaction - - >- - A version of the address that was entered after the last - validation attempt but that was not re-validated was used for the - transaction. - - The transaction was abandoned and the address was not used. + text: description: >- - Required. The outcome of the sequence of validation attempts. If - this field is set to `VALIDATION_CONCLUSION_UNSPECIFIED`, an - `INVALID_ARGUMENT` error will be returned. - responseId: + The name text. For example, "5th Avenue" for a street name or "1253" + for a street number. type: string + languageCode: description: >- - Required. The ID of the response that this feedback is for. This - should be the response_id from the first response in a series of - address validation attempts. - GoogleMapsAddressvalidationV1AddressMetadata: + The BCP-47 language code. This will not be present if the component + name is not associated with a language, such as a street number. + type: string + GoogleMapsAddressvalidationV1Geocode: + id: GoogleMapsAddressvalidationV1Geocode + description: Contains information about the place the input was geocoded to. type: object - id: GoogleMapsAddressvalidationV1AddressMetadata - description: >- - The metadata for the address. `metadata` is not guaranteed to be fully - populated for every address sent to the Address Validation API. properties: - residential: - type: boolean + location: description: >- - Indicates that this is the address of a residence. If unset, - indicates that the value is unknown. - poBox: + The geocoded location of the input. Using place IDs is preferred + over using addresses, latitude/longitude coordinates, or plus codes. + Using coordinates when routing or calculating driving directions + will always result in the point being snapped to the road nearest to + those coordinates. This may not be a road that will quickly or + safely lead to the destination and may not be near an access point + to the property. Additionally, when a location is reverse geocoded, + there is no guarantee that the returned address will match the + original. + $ref: '#/components/schemas/GoogleTypeLatLng' + plusCode: + description: The plus code corresponding to the `location`. + $ref: '#/components/schemas/GoogleMapsAddressvalidationV1PlusCode' + bounds: + description: The bounds of the geocoded place. + $ref: '#/components/schemas/GoogleGeoTypeViewport' + featureSizeMeters: description: >- - Indicates that the address of a PO box. If unset, indicates that the - value is unknown. - type: boolean - business: - type: boolean + The size of the geocoded place, in meters. This is another measure + of the coarseness of the geocoded location, but in physical size + rather than in semantic meaning. + type: number + format: float + placeId: description: >- - Indicates that this is the address of a business. If unset, - indicates that the value is unknown. + The PlaceID of the place this input geocodes to. For more + information about Place IDs see + [here](https://developers.google.com/maps/documentation/places/web-service/place-id). + type: string + placeTypes: + description: >- + The type(s) of place that the input geocoded to. For example, + `['locality', 'political']`. The full list of types can be found + [here](https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types). + type: array + items: + type: string GoogleTypeLatLng: id: GoogleTypeLatLng description: >- @@ -612,139 +724,124 @@ components: as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. + type: object properties: latitude: - format: double - type: number description: The latitude in degrees. It must be in the range [-90.0, +90.0]. - longitude: - format: double type: number + format: double + longitude: description: The longitude in degrees. It must be in the range [-180.0, +180.0]. - type: object - GoogleMapsAddressvalidationV1LanguageOptions: - type: object - properties: - returnEnglishLatinAddress: - description: >- - Preview: Return a [google.maps.addressvalidation.v1.Address] in - English. See - [google.maps.addressvalidation.v1.ValidationResult.english_latin_address] - for details. - type: boolean - description: >- - Preview: This feature is in Preview (pre-GA). Pre-GA products and - features might have limited support, and changes to pre-GA products and - features might not be compatible with other pre-GA versions. Pre-GA - Offerings are covered by the [Google Maps Platform Service Specific - Terms](https://cloud.google.com/maps-platform/terms/maps-service-terms). - For more information, see the [launch stage - descriptions](https://developers.google.com/maps/launch-stages). Enables - the Address Validation API to include additional information in the - response. - id: GoogleMapsAddressvalidationV1LanguageOptions - GoogleMapsAddressvalidationV1ProvideValidationFeedbackResponse: + type: number + format: double + GoogleMapsAddressvalidationV1PlusCode: + id: GoogleMapsAddressvalidationV1PlusCode description: >- - The response for validation feedback. The response is empty if the - feedback is sent successfully. - id: GoogleMapsAddressvalidationV1ProvideValidationFeedbackResponse + Plus code (http://plus.codes) is a location reference with two formats: + global code defining a 14mx14m (1/8000th of a degree) or smaller + rectangle, and compound code, replacing the prefix with a reference + location. type: object - properties: {} - GoogleMapsAddressvalidationV1ComponentName: - id: GoogleMapsAddressvalidationV1ComponentName properties: - languageCode: - type: string + globalCode: description: >- - The BCP-47 language code. This will not be present if the component - name is not associated with a language, such as a street number. - text: + Place's global (full) code, such as "9FWM33GV+HQ", representing an + 1/8000 by 1/8000 degree area (~14 by 14 meters). + type: string + compoundCode: description: >- - The name text. For example, "5th Avenue" for a street name or "1253" - for a street number. + Place's compound code, such as "33GV+HQ, Ramberg, Norway", + containing the suffix of the global code and replacing the prefix + with a formatted name of a reference entity. type: string - description: A wrapper for the name of the component. + GoogleGeoTypeViewport: + id: GoogleGeoTypeViewport + description: >- + A latitude-longitude viewport, represented as two diagonally opposite + `low` and `high` points. A viewport is considered a closed region, i.e. + it includes its boundary. The latitude bounds must range between -90 to + 90 degrees inclusive, and the longitude bounds must range between -180 + to 180 degrees inclusive. Various cases include: - If `low` = `high`, + the viewport consists of that single point. - If `low.longitude` > + `high.longitude`, the longitude range is inverted (the viewport crosses + the 180 degree longitude line). - If `low.longitude` = -180 degrees and + `high.longitude` = 180 degrees, the viewport includes all longitudes. - + If `low.longitude` = 180 degrees and `high.longitude` = -180 degrees, + the longitude range is empty. - If `low.latitude` > `high.latitude`, the + latitude range is empty. Both `low` and `high` must be populated, and + the represented box cannot be empty (as specified by the definitions + above). An empty viewport will result in an error. For example, this + viewport fully encloses New York City: { "low": { "latitude": 40.477398, + "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": + -73.70018 } } type: object - GoogleMapsAddressvalidationV1UspsData: properties: - dpvNoStat: - type: string + low: + description: Required. The low point of the viewport. + $ref: '#/components/schemas/GoogleTypeLatLng' + high: + description: Required. The high point of the viewport. + $ref: '#/components/schemas/GoogleTypeLatLng' + GoogleMapsAddressvalidationV1AddressMetadata: + id: GoogleMapsAddressvalidationV1AddressMetadata + description: >- + The metadata for the post-processed address. `metadata` is not + guaranteed to be fully populated for every address sent to the Address + Validation API. + type: object + properties: + business: description: >- - Is this a no stat address or an active address? No stat addresses - are ones which are not continuously occupied or addresses that the - USPS does not service. Returns a single character. * `Y`: The - address is not active * `N`: The address is active - cassProcessed: + Indicates that this is the address of a business. If unset, + indicates that the value is unknown. type: boolean - description: Indicator that the request has been CASS processed. - pmbNumber: - description: PMB (Private Mail Box) number; - type: string - lacsLinkIndicator: - description: LACSLink indicator. - type: string - dpvCmra: - type: string - description: >- - Indicates if the address is a CMRA (Commercial Mail Receiving - Agency)--a private business receiving mail for clients. Returns a - single character. * `Y`: The address is a CMRA * `N`: The address is - not a CMRA - dpvDrop: - type: string + poBox: description: >- - Flag indicates mail is delivered to a single receptable at a site. - Returns a single character. * `Y`: The mail is delivered to a single - receptable at a site. * `N`: The mail is not delivered to a single - receptable at a site. - defaultAddress: + Indicates that the address of a PO box. If unset, indicates that the + value is unknown. type: boolean + residential: description: >- - Indicator that a default address was found, but more specific - addresses exists. - dpvEnhancedDeliveryCode: + Indicates that this is the address of a residence. If unset, + indicates that the value is unknown. + type: boolean + GoogleMapsAddressvalidationV1UspsData: + id: GoogleMapsAddressvalidationV1UspsData + description: >- + The USPS data for the address. `uspsData` is not guaranteed to be fully + populated for every US or PR address sent to the Address Validation API. + It's recommended to integrate the backup address fields in the response + if you utilize uspsData as the primary part of the response. + type: object + properties: + standardizedAddress: + description: USPS standardized address. + $ref: '#/components/schemas/GoogleMapsAddressvalidationV1UspsAddress' + deliveryPointCode: + description: 2 digit delivery point code type: string + deliveryPointCheckDigit: description: >- - Indicates that more than one DPV return code is valid for the - address. Returns a single character. * `Y`: Address was DPV - confirmed for primary and any secondary numbers. * `N`: Primary and - any secondary number information failed to DPV confirm. * `S`: - Address was DPV confirmed for the primary number only, and the - secondary number information was present but not confirmed, or a - single trailing alpha on a primary number was dropped to make a DPV - match and secondary information required. * `D`: Address was DPV - confirmed for the primary number only, and the secondary number - information was missing. * `R`: Address confirmed but assigned to - phantom route R777 and R779 and USPS delivery is not provided. - addressRecordType: + The delivery point check digit. This number is added to the end of + the delivery_point_barcode for mechanically scanned mail. Adding all + the digits of the delivery_point_barcode, + delivery_point_check_digit, postal code, and ZIP+4 together should + yield a number divisible by 10. type: string + dpvConfirmation: description: >- - Type of the address record that matches the input address. * `F`: - FIRM. This is a match to a Firm Record, which is the finest level of - match available for an address. * `G`: GENERAL DELIVERY. This is a - match to a General Delivery record. * `H`: BUILDING / APARTMENT. - This is a match to a Building or Apartment record. * `P`: POST - OFFICE BOX. This is a match to a Post Office Box. * `R`: RURAL ROUTE - or HIGHWAY CONTRACT: This is a match to either a Rural Route or a - Highway Contract record, both of which may have associated Box - Number ranges. * `S`: STREET RECORD: This is a match to a Street - record containing a valid primary number range. - postOfficeState: - type: string - description: Main post office state. - dpvPbsa: + The possible values for DPV confirmation. Returns a single character + or returns no value. * `N`: Primary and any secondary number + information failed to DPV confirm. * `D`: Address was DPV confirmed + for the primary number only, and the secondary number information + was missing. * `S`: Address was DPV confirmed for the primary number + only, and the secondary number information was present but not + confirmed. * `Y`: Address was DPV confirmed for primary and any + secondary numbers. * Empty: If the response does not contain a + `dpv_confirmation` value, the address was not submitted for DPV + confirmation. type: string - description: >- - Indicates the address was matched to PBSA record. Returns a single - character. * `Y`: The address was matched to PBSA record. * `N`: The - address was not matched to PBSA record. - ewsNoMatch: - type: boolean - description: >- - The delivery address is matchable, but the EWS file indicates that - an exact match will be available soon. dpvFootnote: - type: string description: >- The footnotes from delivery point validation. Multiple footnotes may be strung together in the same string. * `AA`: Input address matched @@ -762,42 +859,63 @@ components: without PMB information * `R7`: Carrier Route R777 or R779 record * `IA`: Informed Address identified * `TA`: Primary number matched by dropping a trailing alpha - dpvConfirmation: + type: string + dpvCmra: description: >- - The possible values for DPV confirmation. Returns a single character - or returns no value. * `N`: Primary and any secondary number - information failed to DPV confirm. * `D`: Address was DPV confirmed - for the primary number only, and the secondary number information - was missing. * `S`: Address was DPV confirmed for the primary number - only, and the secondary number information was present but not - confirmed. * `Y`: Address was DPV confirmed for primary and any - secondary numbers. * Empty: If the response does not contain a - `dpv_confirmation` value, the address was not submitted for DPV - confirmation. + Indicates if the address is a CMRA (Commercial Mail Receiving + Agency)--a private business receiving mail for clients. Returns a + single character. * `Y`: The address is a CMRA * `N`: The address is + not a CMRA type: string - errorMessage: + dpvVacant: + description: >- + Is this place vacant? Returns a single character. * `Y`: The address + is vacant * `N`: The address is not vacant type: string + dpvNoStat: description: >- - Error message for USPS data retrieval. This is populated when USPS - processing is suspended because of the detection of artificially - created addresses. The USPS data fields might not be populated when - this error is present. - deliveryPointCheckDigit: + Is this a no stat address or an active address? No stat addresses + are ones which are not continuously occupied or addresses that the + USPS does not service. Returns a single character. * `Y`: The + address is not active * `N`: The address is active + type: string + dpvNoStatReasonCode: + description: >- + Indicates the NoStat type. Returns a reason code as int. * `1`: IDA + (Internal Drop Address) – Addresses that do not receive mail + directly from the USPS but are delivered to a drop address that + services them. * `2`: CDS - Addresses that have not yet become + deliverable. For example, a new subdivision where lots and primary + numbers have been determined, but no structure exists yet for + occupancy. * `3`: Collision - Addresses that do not actually DPV + confirm. * `4`: CMZ (College, Military and Other Types) - ZIP + 4 + records USPS has incorporated into the data. * `5`: Regular - + Indicates addresses not receiving delivery and the addresses are not + counted as possible deliveries. * `6`: Secondary Required - The + address requires secondary information. + type: integer + format: int32 + dpvDrop: description: >- - The delivery point check digit. This number is added to the end of - the delivery_point_barcode for mechanically scanned mail. Adding all - the digits of the delivery_point_barcode, - delivery_point_check_digit, postal code, and ZIP+4 together should - yield a number divisible by 10. + Flag indicates mail is delivered to a single receptable at a site. + Returns a single character. * `Y`: The mail is delivered to a single + receptable at a site. * `N`: The mail is not delivered to a single + receptable at a site. type: string - dpvDoorNotAccessible: + dpvThrowback: + description: >- + Indicates that mail is not delivered to the street address. Returns + a single character. * `Y`: The mail is not delivered to the street + address. * `N`: The mail is delivered to the street address. type: string + dpvNonDeliveryDays: description: >- - Flag indicates addresses where USPS cannot knock on a door to - deliver mail. Returns a single character. * `Y`: The door is not - accessible. * `N`: No indication the door is not accessible. + Flag indicates mail delivery is not performed every day of the week. + Returns a single character. * `Y`: The mail delivery is not + performed every day of the week. * `N`: No indication the mail + delivery is not performed every day of the week. + type: string dpvNonDeliveryDaysValues: - type: integer description: >- Integer identifying non-delivery days. It can be interrogated using bit flags: 0x40 – Sunday is a non-delivery day 0x20 – Monday is a @@ -805,261 +923,234 @@ components: Wednesday is a non-delivery day 0x04 – Thursday is a non-delivery day 0x02 – Friday is a non-delivery day 0x01 – Saturday is a non-delivery day + type: integer format: int32 - dpvVacant: + dpvNoSecureLocation: + description: >- + Flag indicates door is accessible, but package will not be left due + to security concerns. Returns a single character. * `Y`: The package + will not be left due to security concerns. * `N`: No indication the + package will not be left due to security concerns. type: string + dpvPbsa: description: >- - Is this place vacant? Returns a single character. * `Y`: The address - is vacant * `N`: The address is not vacant - postOfficeCity: + Indicates the address was matched to PBSA record. Returns a single + character. * `Y`: The address was matched to PBSA record. * `N`: The + address was not matched to PBSA record. + type: string + dpvDoorNotAccessible: + description: >- + Flag indicates addresses where USPS cannot knock on a door to + deliver mail. Returns a single character. * `Y`: The door is not + accessible. * `N`: No indication the door is not accessible. + type: string + dpvEnhancedDeliveryCode: + description: >- + Indicates that more than one DPV return code is valid for the + address. Returns a single character. * `Y`: Address was DPV + confirmed for primary and any secondary numbers. * `N`: Primary and + any secondary number information failed to DPV confirm. * `S`: + Address was DPV confirmed for the primary number only, and the + secondary number information was present but not confirmed, or a + single trailing alpha on a primary number was dropped to make a DPV + match and secondary information required. * `D`: Address was DPV + confirmed for the primary number only, and the secondary number + information was missing. * `R`: Address confirmed but assigned to + phantom route R777 and R779 and USPS delivery is not provided. + type: string + carrierRoute: + description: >- + The carrier route code. A four character code consisting of a one + letter prefix and a three digit route designator. Prefixes: * `C`: + Carrier route (or city route) * `R`: Rural route * `H`: Highway + Contract Route * `B`: Post Office Box Section * `G`: General + delivery unit + type: string + carrierRouteIndicator: + description: Carrier route rate sort indicator. type: string + ewsNoMatch: + description: >- + The delivery address is matchable, but the EWS file indicates that + an exact match will be available soon. + type: boolean + postOfficeCity: description: Main post office city. - elotFlag: - description: eLOT Ascending/Descending Flag (A/D). + type: string + postOfficeState: + description: Main post office state. + type: string + abbreviatedCity: + description: Abbreviated city. type: string fipsCountyCode: description: FIPS county code. type: string - dpvNonDeliveryDays: + county: + description: County name. type: string - description: >- - Flag indicates mail delivery is not performed every day of the week. - Returns a single character. * `Y`: The mail delivery is not - performed every day of the week. * `N`: No indication the mail - delivery is not performed every day of the week. elotNumber: description: Enhanced Line of Travel (eLOT) number. type: string + elotFlag: + description: eLOT Ascending/Descending Flag (A/D). + type: string lacsLinkReturnCode: description: LACSLink return code. type: string + lacsLinkIndicator: + description: LACSLink indicator. + type: string poBoxOnlyPostalCode: - type: boolean description: PO Box only postal code. - pmbDesignator: - type: string - description: PMB (Private Mail Box) unit designator. + type: boolean suitelinkFootnote: - type: string description: >- Footnotes from matching a street or highrise record to suite information. If business name match is found, the secondary number is returned. * `A`: SuiteLink record match, business address improved. * `00`: No match, business address is not improved. - standardizedAddress: - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1UspsAddress' - description: USPS standardized address. - deliveryPointCode: - description: 2 digit delivery point code type: string - carrierRoute: + pmbDesignator: + description: PMB (Private Mail Box) unit designator. type: string - description: >- - The carrier route code. A four character code consisting of a one - letter prefix and a three digit route designator. Prefixes: * `C`: - Carrier route (or city route) * `R`: Rural route * `H`: Highway - Contract Route * `B`: Post Office Box Section * `G`: General - delivery unit - carrierRouteIndicator: + pmbNumber: + description: PMB (Private Mail Box) number; type: string - description: Carrier route rate sort indicator. - dpvNoStatReasonCode: - type: integer - format: int32 + addressRecordType: description: >- - Indicates the NoStat type. Returns a reason code as int. * `1`: IDA - (Internal Drop Address) – Addresses that do not receive mail - directly from the USPS but are delivered to a drop address that - services them. * `2`: CDS - Addresses that have not yet become - deliverable. For example, a new subdivision where lots and primary - numbers have been determined, but no structure exists yet for - occupancy. * `3`: Collision - Addresses that do not actually DPV - confirm. * `4`: CMZ (College, Military and Other Types) - ZIP + 4 - records USPS has incorporated into the data. * `5`: Regular - - Indicates addresses not receiving delivery and the addresses are not - counted as possible deliveries. * `6`: Secondary Required - The - address requires secondary information. - dpvNoSecureLocation: + Type of the address record that matches the input address. * `F`: + FIRM. This is a match to a Firm Record, which is the finest level of + match available for an address. * `G`: GENERAL DELIVERY. This is a + match to a General Delivery record. * `H`: BUILDING / APARTMENT. + This is a match to a Building or Apartment record. * `P`: POST + OFFICE BOX. This is a match to a Post Office Box. * `R`: RURAL ROUTE + or HIGHWAY CONTRACT: This is a match to either a Rural Route or a + Highway Contract record, both of which may have associated Box + Number ranges. * `S`: STREET RECORD: This is a match to a Street + record containing a valid primary number range. type: string + defaultAddress: description: >- - Flag indicates door is accessible, but package will not be left due - to security concerns. Returns a single character. * `Y`: The package - will not be left due to security concerns. * `N`: No indication the - package will not be left due to security concerns. - dpvThrowback: - type: string + Indicator that a default address was found, but more specific + addresses exists. + type: boolean + errorMessage: description: >- - Indicates that mail is not delivered to the street address. Returns - a single character. * `Y`: The mail is not delivered to the street - address. * `N`: The mail is delivered to the street address. - county: - type: string - description: County name. - abbreviatedCity: - description: Abbreviated city. + Error message for USPS data retrieval. This is populated when USPS + processing is suspended because of the detection of artificially + created addresses. The USPS data fields might not be populated when + this error is present. type: string - id: GoogleMapsAddressvalidationV1UspsData - description: >- - The USPS data for the address. `uspsData` is not guaranteed to be fully - populated for every US or PR address sent to the Address Validation API. - It's recommended to integrate the backup address fields in the response - if you utilize uspsData as the primary part of the response. + cassProcessed: + description: Indicator that the request has been CASS processed. + type: boolean + GoogleMapsAddressvalidationV1UspsAddress: + id: GoogleMapsAddressvalidationV1UspsAddress + description: USPS representation of a US address. type: object - GoogleMapsAddressvalidationV1Verdict: properties: - hasInferredComponents: - type: boolean - description: >- - At least one address component was inferred (added) that wasn't in - the input, see - [google.maps.addressvalidation.v1.Address.address_components] for - details. - addressComplete: - description: >- - The address is considered complete if there are no unresolved - tokens, no unexpected or missing address components. If unset, - indicates that the value is `false`. See `missing_component_types`, - `unresolved_tokens` or `unexpected` fields for more details. - type: boolean - geocodeGranularity: + firstAddressLine: + description: First address line. type: string + firm: + description: Firm name. + type: string + secondAddressLine: + description: Second address line. + type: string + urbanization: + description: Puerto Rican urbanization name. + type: string + cityStateZipAddressLine: + description: City + state + postal code. + type: string + city: + description: City name. + type: string + state: + description: 2 letter state code. + type: string + zipCode: + description: Postal code e.g. 10009. + type: string + zipCodeExtension: + description: 4-digit postal code extension e.g. 5023. + type: string + GoogleMapsAddressvalidationV1ProvideValidationFeedbackRequest: + id: GoogleMapsAddressvalidationV1ProvideValidationFeedbackRequest + description: The request for sending validation feedback. + type: object + properties: + conclusion: description: >- - Information about the granularity of the `geocode`. This can be - understood as the semantic meaning of how coarse or fine the - geocoded location is. This can differ from the - `validation_granularity` above occasionally. For example, our - database might record the existence of an apartment number but do - not have a precise location for the apartment within a big apartment - complex. In that case, the `validation_granularity` will be - `SUB_PREMISE` but the `geocode_granularity` will be `PREMISE`. - enum: - - GRANULARITY_UNSPECIFIED - - SUB_PREMISE - - PREMISE - - PREMISE_PROXIMITY - - BLOCK - - ROUTE - - OTHER - enumDescriptions: - - Default value. This value is unused. - - Below-building level result, such as an apartment. - - Building-level result. - - >- - A geocode that approximates the building-level location of the - address. - - >- - The address or geocode indicates a block. Only used in regions - which have block-level addressing, such as Japan. - - >- - The geocode or address is granular to route, such as a street, - road, or highway. - - >- - All other granularities, which are bucketed together since they - are not deliverable. - hasReplacedComponents: - description: >- - At least one address component was replaced, see - [google.maps.addressvalidation.v1.Address.address_components] for - details. - type: boolean - hasUnconfirmedComponents: - type: boolean - description: >- - At least one address component cannot be categorized or validated, - see [google.maps.addressvalidation.v1.Address.address_components] - for details. - inputGranularity: - description: >- - The granularity of the **input** address. This is the result of - parsing the input address and does not give any validation signals. - For validation signals, refer to `validation_granularity` below. For - example, if the input address includes a specific apartment number, - then the `input_granularity` here will be `SUB_PREMISE`. If we - cannot match the apartment number in the databases or the apartment - number is invalid, the `validation_granularity` will likely be - `PREMISE` or below. - enum: - - GRANULARITY_UNSPECIFIED - - SUB_PREMISE - - PREMISE - - PREMISE_PROXIMITY - - BLOCK - - ROUTE - - OTHER + Required. The outcome of the sequence of validation attempts. If + this field is set to `VALIDATION_CONCLUSION_UNSPECIFIED`, an + `INVALID_ARGUMENT` error will be returned. type: string enumDescriptions: - - Default value. This value is unused. - - Below-building level result, such as an apartment. - - Building-level result. - - >- - A geocode that approximates the building-level location of the - address. - - >- - The address or geocode indicates a block. Only used in regions - which have block-level addressing, such as Japan. - - >- - The geocode or address is granular to route, such as a street, - road, or highway. - - >- - All other granularities, which are bucketed together since they - are not deliverable. - validationGranularity: - enumDescriptions: - - Default value. This value is unused. - - Below-building level result, such as an apartment. - - Building-level result. - >- - A geocode that approximates the building-level location of the - address. + This value is unused. If the + `ProvideValidationFeedbackRequest.conclusion` field is set to + `VALIDATION_CONCLUSION_UNSPECIFIED`, an `INVALID_ARGUMENT` error + will be returned. - >- - The address or geocode indicates a block. Only used in regions - which have block-level addressing, such as Japan. + The version of the address returned by the Address Validation API + was used for the transaction. - >- - The geocode or address is granular to route, such as a street, - road, or highway. + The version of the address provided by the user was used for the + transaction - >- - All other granularities, which are bucketed together since they - are not deliverable. - type: string - description: >- - The granularity level that the API can fully **validate** the - address to. For example, an `validation_granularity` of `PREMISE` - indicates all address components at the level of `PREMISE` or more - coarse can be validated. Per address component validation result can - be found in - [google.maps.addressvalidation.v1.Address.address_components]. + A version of the address that was entered after the last + validation attempt but that was not re-validated was used for the + transaction. + - The transaction was abandoned and the address was not used. enum: - - GRANULARITY_UNSPECIFIED - - SUB_PREMISE - - PREMISE - - PREMISE_PROXIMITY - - BLOCK - - ROUTE - - OTHER - description: High level overview of the address validation result and geocode. - type: object - id: GoogleMapsAddressvalidationV1Verdict - GoogleMapsAddressvalidationV1ValidateAddressResponse: - properties: + - VALIDATION_CONCLUSION_UNSPECIFIED + - VALIDATED_VERSION_USED + - USER_VERSION_USED + - UNVALIDATED_VERSION_USED + - UNUSED responseId: - type: string description: >- - The UUID that identifies this response. If the address needs to be - re-validated, this UUID *must* accompany the new request. - result: - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1ValidationResult' - description: The result of the address validation. - id: GoogleMapsAddressvalidationV1ValidateAddressResponse - description: The response to an address validation request. + Required. The ID of the response that this feedback is for. This + should be the response_id from the first response in a series of + address validation attempts. + type: string + GoogleMapsAddressvalidationV1ProvideValidationFeedbackResponse: + id: GoogleMapsAddressvalidationV1ProvideValidationFeedbackResponse + description: >- + The response for validation feedback. The response is empty if the + feedback is sent successfully. type: object + properties: {} parameters: - 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. + access_token: + description: OAuth access token. in: query - name: quotaUser + name: access_token + schema: + type: string + alt: + description: Data format for response. + in: query + name: alt + schema: + type: string + enum: + - json + - media + - proto + 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: @@ -1071,47 +1162,25 @@ components: name: key schema: type: string - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean oauth_token: description: OAuth 2.0 token for the current user. in: query name: oauth_token schema: type: string - _.xgafv: - description: V1 error format. - in: query - name: $.xgafv - schema: - type: string - enum: - - '1' - - '2' - alt: - description: Data format for response. - in: query - name: alt - schema: - type: string - enum: - - json - - media - - proto - callback: - description: JSONP + prettyPrint: + description: Returns response with indentations and line breaks. in: query - name: callback + name: prettyPrint schema: - type: string - access_token: - description: OAuth access token. + 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: access_token + name: quotaUser schema: type: string upload_protocol: @@ -1126,27 +1195,30 @@ components: name: uploadType schema: type: string - fields: - description: Selector specifying which fields to include in a partial response. + _.xgafv: + description: V1 error format. in: query - name: fields + name: $.xgafv schema: type: string + enum: + - '1' + - '2' x-stackQL-resources: addressvalidation: id: google.addressvalidation.addressvalidation name: addressvalidation title: Addressvalidation methods: - provide_validation_feedback: + validate_address: operation: - $ref: '#/paths/~1v1:provideValidationFeedback/post' + $ref: '#/paths/~1v1:validateAddress/post' response: mediaType: application/json openAPIDocKey: '200' - validate_address: + provide_validation_feedback: operation: - $ref: '#/paths/~1v1:validateAddress/post' + $ref: '#/paths/~1v1:provideValidationFeedback/post' response: mediaType: application/json openAPIDocKey: '200' @@ -1157,33 +1229,28 @@ components: replace: [] delete: [] paths: - /v1:provideValidationFeedback: + /v1:validateAddress: parameters: &ref_1 - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/_.xgafv' post: - description: >- - Feedback about the outcome of the sequence of validation attempts. This - should be the last call made after a sequence of validation calls for - the same address, and should be called once the transaction is - concluded. This should only be sent once for the sequence of - `ValidateAddress` requests needed to validate an address fully. - operationId: addressvalidation.provideValidationFeedback + description: Validates an address. + operationId: addressvalidation.validateAddress requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleMapsAddressvalidationV1ProvideValidationFeedbackRequest + #/components/schemas/GoogleMapsAddressvalidationV1ValidateAddressRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1200,19 +1267,24 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleMapsAddressvalidationV1ProvideValidationFeedbackResponse + #/components/schemas/GoogleMapsAddressvalidationV1ValidateAddressResponse parameters: [] - /v1:validateAddress: + /v1:provideValidationFeedback: parameters: *ref_1 post: - description: Validates an address. - operationId: addressvalidation.validateAddress + description: >- + Feedback about the outcome of the sequence of validation attempts. This + should be the last call made after a sequence of validation calls for + the same address, and should be called once the transaction is + concluded. This should only be sent once for the sequence of + `ValidateAddress` requests needed to validate an address fully. + operationId: addressvalidation.provideValidationFeedback requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleMapsAddressvalidationV1ValidateAddressRequest + #/components/schemas/GoogleMapsAddressvalidationV1ProvideValidationFeedbackRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1229,5 +1301,5 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleMapsAddressvalidationV1ValidateAddressResponse + #/components/schemas/GoogleMapsAddressvalidationV1ProvideValidationFeedbackResponse parameters: [] diff --git a/providers/src/googleapis.com/v00.00.00000/services/advisorynotifications.yaml b/providers/src/googleapis.com/v00.00.00000/services/advisorynotifications.yaml index a1649f9c..e2451b06 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/advisorynotifications.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/advisorynotifications.yaml @@ -7,8 +7,8 @@ info: title: Advisory Notifications API description: An API for accessing Advisory Notifications in Google Cloud version: v1 - x-discovery-doc-revision: '20241103' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250824' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/advisory-notifications servers: @@ -34,249 +34,250 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudAdvisorynotificationsV1Attachment: - properties: - csv: - $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Csv' - description: A CSV file attachment. Max size is 10 MB. - displayName: - type: string - description: The title of the attachment. - description: Attachment with specific information about the issue. - type: object - id: GoogleCloudAdvisorynotificationsV1Attachment GoogleCloudAdvisorynotificationsV1ListNotificationsResponse: + id: GoogleCloudAdvisorynotificationsV1ListNotificationsResponse + description: Response of ListNotifications endpoint. + type: object properties: - nextPageToken: - description: >- - A token, which can be sent as `page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. - type: string notifications: + description: List of notifications under a given parent. type: array items: $ref: >- #/components/schemas/GoogleCloudAdvisorynotificationsV1Notification - description: List of notifications under a given parent. + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string totalSize: + description: Estimation of a total number of notifications. type: integer format: int32 - description: Estimation of a total number of notifications. - description: Response of ListNotifications endpoint. - type: object - id: GoogleCloudAdvisorynotificationsV1ListNotificationsResponse - GoogleCloudAdvisorynotificationsV1NotificationSettings: - id: GoogleCloudAdvisorynotificationsV1NotificationSettings - type: object - properties: - enabled: - description: Whether the associated NotificationType is enabled. - type: boolean - description: Settings for each NotificationType. - GoogleCloudAdvisorynotificationsV1Csv: + GoogleCloudAdvisorynotificationsV1Notification: + id: GoogleCloudAdvisorynotificationsV1Notification description: >- - A representation of a CSV file attachment, as a list of column headers - and a list of data rows. - properties: - dataRows: - items: - $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1CsvCsvRow' - type: array - description: >- - The list of data rows in a CSV file, as string arrays rather than as - a single comma-separated string. - headers: - type: array - description: The list of headers for data columns in a CSV file. - items: - type: string - id: GoogleCloudAdvisorynotificationsV1Csv - type: object - GoogleCloudAdvisorynotificationsV1Settings: - id: GoogleCloudAdvisorynotificationsV1Settings - type: object - description: Settings for Advisory Notifications. - properties: - notificationSettings: - type: object - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudAdvisorynotificationsV1NotificationSettings - description: >- - Required. Map of each notification type and its settings to get/set - all settings at once. The server will validate the value for each - notification type. - etag: - type: string - description: >- - Required. Fingerprint for optimistic concurrency returned in Get - requests. Must be provided for Update requests. If the value - provided does not match the value known to the server, ABORTED will - be thrown, and the client should retry the read-modify-write cycle. - name: - description: >- - Identifier. The resource name of the settings to retrieve. Format: - organizations/{organization}/locations/{location}/settings or - projects/{projects}/locations/{location}/settings. - type: string - GoogleCloudAdvisorynotificationsV1MessageBody: - properties: - text: - $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Text' - description: The text content of the message body. - description: A message body containing text. - id: GoogleCloudAdvisorynotificationsV1MessageBody - type: object - GoogleCloudAdvisorynotificationsV1CsvCsvRow: - id: GoogleCloudAdvisorynotificationsV1CsvCsvRow - properties: - entries: - description: >- - The data entries in a CSV file row, as a string array rather than a - single comma-separated string. - items: - type: string - type: array - type: object - description: A representation of a single data row in a CSV file. - GoogleCloudAdvisorynotificationsV1Text: - description: A text object containing the English text and its localized copies. - id: GoogleCloudAdvisorynotificationsV1Text + A notification object for notifying customers about security and privacy + issues. type: object - properties: - localizationState: - type: string - enum: - - LOCALIZATION_STATE_UNSPECIFIED - - LOCALIZATION_STATE_NOT_APPLICABLE - - LOCALIZATION_STATE_PENDING - - LOCALIZATION_STATE_COMPLETED - description: Status of the localization. - enumDescriptions: - - Not used. - - >- - Localization is not applicable for requested language. This can - happen when: - The requested language was not supported by - Advisory Notifications at the time of localization (including - notifications created before the localization feature was - launched). - The requested language is English, so only the - English text is returned. - - >- - Localization for requested language is in progress, and not ready - yet. - - Localization for requested language is completed. - localizedText: - description: The requested localized copy (if applicable). - type: string - enText: - type: string - description: The English copy. - GoogleCloudAdvisorynotificationsV1Notification: properties: name: - type: string description: >- The resource name of the notification. Format: organizations/{organization}/locations/{location}/notifications/{notification} or projects/{project}/locations/{location}/notifications/{notification}. + type: string subject: - $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Subject' description: The subject line of the notification. - createTime: - readOnly: true - format: google-datetime - description: Output only. Time the notification was created. - type: string + $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Subject' messages: description: A list of messages in the notification. + type: array items: $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Message' - type: array + createTime: + description: Output only. Time the notification was created. + readOnly: true + type: string + format: google-datetime notificationType: - enum: - - NOTIFICATION_TYPE_UNSPECIFIED - - NOTIFICATION_TYPE_SECURITY_PRIVACY_ADVISORY - - NOTIFICATION_TYPE_SENSITIVE_ACTIONS - - NOTIFICATION_TYPE_SECURITY_MSA - - NOTIFICATION_TYPE_THREAT_HORIZONS description: Type of notification + type: string enumDescriptions: - Default type - Security and privacy advisory notifications - Sensitive action notifications - General security MSA - Threat horizons MSA - type: string - description: >- - A notification object for notifying customers about security and privacy - issues. - type: object - id: GoogleCloudAdvisorynotificationsV1Notification + enum: + - NOTIFICATION_TYPE_UNSPECIFIED + - NOTIFICATION_TYPE_SECURITY_PRIVACY_ADVISORY + - NOTIFICATION_TYPE_SENSITIVE_ACTIONS + - NOTIFICATION_TYPE_SECURITY_MSA + - NOTIFICATION_TYPE_THREAT_HORIZONS GoogleCloudAdvisorynotificationsV1Subject: id: GoogleCloudAdvisorynotificationsV1Subject description: A subject line of a notification. + type: object properties: text: - $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Text' description: The text content. + $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Text' + GoogleCloudAdvisorynotificationsV1Text: + id: GoogleCloudAdvisorynotificationsV1Text + description: A text object containing the English text and its localized copies. type: object + properties: + enText: + description: The English copy. + type: string + localizedText: + description: The requested localized copy (if applicable). + type: string + localizationState: + description: Status of the localization. + type: string + enumDescriptions: + - Not used. + - >- + Localization is not applicable for requested language. This can + happen when: - The requested language was not supported by + Advisory Notifications at the time of localization (including + notifications created before the localization feature was + launched). - The requested language is English, so only the + English text is returned. + - >- + Localization for requested language is in progress, and not ready + yet. + - Localization for requested language is completed. + enum: + - LOCALIZATION_STATE_UNSPECIFIED + - LOCALIZATION_STATE_NOT_APPLICABLE + - LOCALIZATION_STATE_PENDING + - LOCALIZATION_STATE_COMPLETED GoogleCloudAdvisorynotificationsV1Message: id: GoogleCloudAdvisorynotificationsV1Message description: A message which contains notification details. + type: object properties: + body: + description: The message content. + $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1MessageBody' attachments: description: The attachments to download. + type: array items: $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Attachment' - type: array createTime: - type: string description: The Message creation timestamp. + type: string format: google-datetime localizationTime: description: Time when Message was localized + type: string format: google-datetime + GoogleCloudAdvisorynotificationsV1MessageBody: + id: GoogleCloudAdvisorynotificationsV1MessageBody + description: A message body containing text. + type: object + properties: + text: + description: The text content of the message body. + $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Text' + GoogleCloudAdvisorynotificationsV1Attachment: + id: GoogleCloudAdvisorynotificationsV1Attachment + description: Attachment with specific information about the issue. + type: object + properties: + csv: + description: A CSV file attachment. Max size is 10 MB. + $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Csv' + displayName: + description: The title of the attachment. type: string - body: - description: The message content. - $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1MessageBody' + GoogleCloudAdvisorynotificationsV1Csv: + id: GoogleCloudAdvisorynotificationsV1Csv + description: >- + A representation of a CSV file attachment, as a list of column headers + and a list of data rows. + type: object + properties: + headers: + description: The list of headers for data columns in a CSV file. + type: array + items: + type: string + dataRows: + description: >- + The list of data rows in a CSV file, as string arrays rather than as + a single comma-separated string. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1CsvCsvRow' + GoogleCloudAdvisorynotificationsV1CsvCsvRow: + id: GoogleCloudAdvisorynotificationsV1CsvCsvRow + description: A representation of a single data row in a CSV file. + type: object + properties: + entries: + description: >- + The data entries in a CSV file row, as a string array rather than a + single comma-separated string. + type: array + items: + type: string + GoogleCloudAdvisorynotificationsV1Settings: + id: GoogleCloudAdvisorynotificationsV1Settings + description: Settings for Advisory Notifications. + type: object + properties: + name: + description: >- + Identifier. The resource name of the settings to retrieve. Format: + organizations/{organization}/locations/{location}/settings or + projects/{projects}/locations/{location}/settings. + type: string + notificationSettings: + description: >- + Required. Map of each notification type and its settings to get/set + all settings at once. The server will validate the value for each + notification type. + type: object + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudAdvisorynotificationsV1NotificationSettings + etag: + description: >- + Required. Fingerprint for optimistic concurrency returned in Get + requests. Must be provided for Update requests. If the value + provided does not match the value known to the server, ABORTED will + be thrown, and the client should retry the read-modify-write cycle. + type: string + GoogleCloudAdvisorynotificationsV1NotificationSettings: + id: GoogleCloudAdvisorynotificationsV1NotificationSettings + description: Settings for each NotificationType. type: object + properties: + enabled: + description: Whether the associated NotificationType is enabled. + type: boolean parameters: - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + access_token: + description: OAuth access token. in: query - name: upload_protocol + name: access_token schema: type: string - _.xgafv: - description: V1 error format. + alt: + description: Data format for response. in: query - name: $.xgafv + name: alt schema: type: string enum: - - '1' - - '2' - 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 + - json + - media + - proto callback: description: JSONP in: query name: callback schema: type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: uploadType + 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: @@ -285,116 +286,115 @@ components: 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 - alt: - description: Data format for response. - in: query - name: alt - schema: - type: string - enum: - - json - - media - - proto - fields: - description: Selector specifying which fields to include in a partial response. + characters. in: query - name: fields + name: quotaUser schema: type: string - prettyPrint: - description: Returns response with indentations and line breaks. + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: prettyPrint + name: upload_protocol schema: - type: boolean - access_token: - description: OAuth access token. + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: access_token + name: uploadType + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv schema: type: string + enum: + - '1' + - '2' x-stackQL-resources: - notifications: - id: google.advisorynotifications.notifications - name: notifications - title: Notifications + settings: + id: google.advisorynotifications.settings + name: settings + title: Settings methods: - get: + get_settings: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1notifications~1{notificationsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1settings/get response: mediaType: application/json openAPIDocKey: '200' - list: + update_settings: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1notifications/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1settings/patch response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.notifications sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/notifications/methods/get' - - $ref: '#/components/x-stackQL-resources/notifications/methods/list' + - $ref: '#/components/x-stackQL-resources/settings/methods/get_settings' insert: [] - update: [] + update: + - $ref: '#/components/x-stackQL-resources/settings/methods/update_settings' replace: [] delete: [] - settings: - id: google.advisorynotifications.settings - name: settings - title: Settings + notifications: + id: google.advisorynotifications.notifications + name: notifications + title: Notifications methods: - update_settings: + list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1settings/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notifications/get response: mediaType: application/json openAPIDocKey: '200' - get_settings: + objectKey: $.notifications + get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1settings/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notifications~1{notificationsId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/settings/methods/get_settings' + - $ref: '#/components/x-stackQL-resources/notifications/methods/get' + - $ref: '#/components/x-stackQL-resources/notifications/methods/list' insert: [] - update: - - $ref: '#/components/x-stackQL-resources/settings/methods/update_settings' + update: [] replace: [] delete: [] paths: - /v1/projects/{projectsId}/locations/{locationsId}/notifications/{notificationsId}: + /v1/organizations/{organizationsId}/locations/{locationsId}/settings: parameters: &ref_1 - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' get: - description: Gets a notification. - operationId: advisorynotifications.projects.locations.notifications.get + description: Get notification settings. + operationId: advisorynotifications.organizations.locations.getSettings security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -407,10 +407,10 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAdvisorynotificationsV1Notification + #/components/schemas/GoogleCloudAdvisorynotificationsV1Settings parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -419,20 +419,43 @@ paths: required: true schema: type: string + patch: + description: Update notification settings. + operationId: advisorynotifications.organizations.locations.updateSettings + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Settings' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAdvisorynotificationsV1Settings + parameters: - in: path - name: notificationsId + name: organizationsId required: true schema: type: string - - in: query - name: languageCode + - in: path + name: locationsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notifications: + /v1/organizations/{organizationsId}/locations/{locationsId}/notifications: parameters: *ref_1 get: description: Lists notifications under a given parent. - operationId: advisorynotifications.projects.locations.notifications.list + operationId: advisorynotifications.organizations.locations.notifications.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -448,7 +471,7 @@ paths: #/components/schemas/GoogleCloudAdvisorynotificationsV1ListNotificationsResponse parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -463,27 +486,22 @@ paths: type: integer format: int32 - in: query - name: view + name: pageToken schema: type: string - in: query - name: pageToken + name: view schema: type: string - in: query name: languageCode schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/settings: + /v1/organizations/{organizationsId}/locations/{locationsId}/notifications/{notificationsId}: parameters: *ref_1 - patch: - description: Update notification settings. - operationId: advisorynotifications.projects.locations.updateSettings - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Settings' + get: + description: Gets a notification. + operationId: advisorynotifications.organizations.locations.notifications.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -496,10 +514,10 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAdvisorynotificationsV1Settings + #/components/schemas/GoogleCloudAdvisorynotificationsV1Notification parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -508,6 +526,17 @@ paths: required: true schema: type: string + - in: path + name: notificationsId + required: true + schema: + type: string + - in: query + name: languageCode + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/settings: + parameters: *ref_1 get: description: Get notification settings. operationId: advisorynotifications.projects.locations.getSettings @@ -535,11 +564,14 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/notifications: - parameters: *ref_1 - get: - description: Lists notifications under a given parent. - operationId: advisorynotifications.organizations.locations.notifications.list + patch: + description: Update notification settings. + operationId: advisorynotifications.projects.locations.updateSettings + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Settings' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -552,10 +584,10 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAdvisorynotificationsV1ListNotificationsResponse + #/components/schemas/GoogleCloudAdvisorynotificationsV1Settings parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -564,28 +596,11 @@ paths: required: true schema: type: string - - in: query - name: view - schema: - type: string - - in: query - name: languageCode - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/organizations/{organizationsId}/locations/{locationsId}/notifications/{notificationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/notifications: parameters: *ref_1 get: - description: Gets a notification. - operationId: advisorynotifications.organizations.locations.notifications.get + description: Lists notifications under a given parent. + operationId: advisorynotifications.projects.locations.notifications.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -598,10 +613,10 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAdvisorynotificationsV1Notification + #/components/schemas/GoogleCloudAdvisorynotificationsV1ListNotificationsResponse parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -610,25 +625,28 @@ paths: required: true schema: type: string - - in: path - name: notificationsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: view schema: type: string - in: query name: languageCode schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/settings: + /v1/projects/{projectsId}/locations/{locationsId}/notifications/{notificationsId}: parameters: *ref_1 - patch: - description: Update notification settings. - operationId: advisorynotifications.organizations.locations.updateSettings - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Settings' + get: + description: Gets a notification. + operationId: advisorynotifications.projects.locations.notifications.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -641,10 +659,10 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAdvisorynotificationsV1Settings + #/components/schemas/GoogleCloudAdvisorynotificationsV1Notification parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -653,30 +671,12 @@ paths: required: true schema: type: string - get: - description: Get notification settings. - operationId: advisorynotifications.organizations.locations.getSettings - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAdvisorynotificationsV1Settings - parameters: - in: path - name: organizationsId + name: notificationsId required: true schema: type: string - - in: path - name: locationsId - required: true + - in: query + name: languageCode schema: type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/aiplatform.yaml b/providers/src/googleapis.com/v00.00.00000/services/aiplatform.yaml index f91a8433..608d0e10 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/aiplatform.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/aiplatform.yaml @@ -9,8 +9,8 @@ info: Train high-quality custom machine learning models with minimal machine learning expertise and effort. version: v1 - x-discovery-doc-revision: '20241026' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250825' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/vertex-ai/ servers: @@ -442,7 +442,9 @@ components: type: object properties: name: - description: Output only. Identifier. The resource name of the Dataset. + description: >- + Output only. Identifier. The resource name of the Dataset. Format: + `projects/{project}/locations/{location}/datasets/{dataset}` readOnly: true type: string displayName: @@ -696,7 +698,7 @@ components: description: >- Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see - https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames. + https://cloud.google.com/storage/docs/wildcards. type: array items: type: string @@ -742,13 +744,13 @@ components: savedQueryId: description: >- The ID of a SavedQuery (annotation set) under the Dataset specified - by dataset_id used for filtering Annotations for training. Only used - for custom training data export use cases. Only applicable to - Datasets that have SavedQueries. Only Annotations that are - associated with this SavedQuery are used in respectively training. - When used in conjunction with annotations_filter, the Annotations - used for training are filtered by both saved_query_id and - annotations_filter. Only one of saved_query_id and + by ExportDataRequest.name used for filtering Annotations for + training. Only used for custom training data export use cases. Only + applicable to Datasets that have SavedQueries. Only Annotations that + are associated with this SavedQuery are used in respectively + training. When used in conjunction with annotations_filter, the + Annotations used for training are filtered by both saved_query_id + and annotations_filter. Only one of saved_query_id and annotation_schema_uri should be specified as both of them represent the same thing: problem type. type: string @@ -760,12 +762,12 @@ components: The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/annotation/, note that the chosen schema must be consistent with metadata of the Dataset - specified by dataset_id. Only used for custom training data export - use cases. Only applicable to Datasets that have DataItems and - Annotations. Only Annotations that both match this schema and belong - to DataItems not ignored by the split method are used in - respectively training, validation or test role, depending on the - role of the DataItem they are on. When used in conjunction with + specified by ExportDataRequest.name. Only used for custom training + data export use cases. Only applicable to Datasets that have + DataItems and Annotations. Only Annotations that both match this + schema and belong to DataItems not ignored by the split method are + used in respectively training, validation or test role, depending on + the role of the DataItem they are on. When used in conjunction with annotations_filter, the Annotations used for training are filtered by both annotations_filter and annotation_schema_uri. type: string @@ -862,7 +864,10 @@ components: type: object properties: name: - description: Output only. Identifier. The resource name of the DatasetVersion. + description: >- + Output only. Identifier. The resource name of the DatasetVersion. + Format: + `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}` readOnly: true type: string createTime: @@ -1254,38 +1259,49 @@ components: GoogleCloudAiplatformV1DedicatedResources: id: GoogleCloudAiplatformV1DedicatedResources description: >- - A description of resources that are dedicated to a DeployedModel, and - that need a higher degree of manual configuration. + A description of resources that are dedicated to a DeployedModel or + DeployedIndex, and that need a higher degree of manual configuration. type: object properties: machineSpec: description: >- - Required. Immutable. The specification of a single machine used by - the prediction. + Required. Immutable. The specification of a single machine being + used. $ref: '#/components/schemas/GoogleCloudAiplatformV1MachineSpec' minReplicaCount: description: >- - Required. Immutable. The minimum number of machine replicas this - DeployedModel will be always deployed on. This value must be greater - than or equal to 1. If traffic against the DeployedModel increases, - it may dynamically be deployed onto more replicas, and as traffic - decreases, some of these extra replicas may be freed. + Required. Immutable. The minimum number of machine replicas that + will be always deployed on. This value must be greater than or equal + to 1. If traffic increases, it may dynamically be deployed onto more + replicas, and as traffic decreases, some of these extra replicas may + be freed. type: integer format: int32 maxReplicaCount: description: >- - Immutable. The maximum number of replicas this DeployedModel may be - deployed on when the traffic against it increases. If the requested - value is too large, the deployment will error, but if deployment - succeeds then the ability to scale the model to that many replicas - is guaranteed (barring service outages). If traffic against the - DeployedModel increases beyond what its replicas at maximum may - handle, a portion of the traffic will be dropped. If this value is - not provided, will use min_replica_count as the default value. The - value of this field impacts the charge against Vertex CPU and GPU - quotas. Specifically, you will be charged for (max_replica_count * - number of cores in the selected machine type) and (max_replica_count - * number of GPUs per replica in the selected machine type). + Immutable. The maximum number of replicas that may be deployed on + when the traffic against it increases. If the requested value is too + large, the deployment will error, but if deployment succeeds then + the ability to scale to that many replicas is guaranteed (barring + service outages). If traffic increases beyond what its replicas at + maximum may handle, a portion of the traffic will be dropped. If + this value is not provided, will use min_replica_count as the + default value. The value of this field impacts the charge against + Vertex CPU and GPU quotas. Specifically, you will be charged for + (max_replica_count * number of cores in the selected machine type) + and (max_replica_count * number of GPUs per replica in the selected + machine type). + type: integer + format: int32 + requiredReplicaCount: + description: >- + Optional. Number of required available replicas for the deployment + to succeed. This field is only needed when partial + deployment/mutation is desired. If set, the deploy/mutate operation + will succeed once available_replica_count reaches + required_replica_count, and the rest of the replicas will be + retried. If not set, the default required_replica_count will be + min_replica_count. type: integer format: int32 autoscalingMetricSpecs: @@ -1347,6 +1363,10 @@ components: - Nvidia A100 80GB GPU. - Nvidia L4 GPU. - Nvidia H100 80Gb GPU. + - Nvidia H100 Mega 80Gb GPU. + - Nvidia H200 141Gb GPU. + - Nvidia B200 GPU. + - Nvidia GB200 GPU. - TPU v2. - TPU v3. - TPU v4. @@ -1366,6 +1386,10 @@ components: - false - false - false + - false + - false + - false + - false enum: - ACCELERATOR_TYPE_UNSPECIFIED - NVIDIA_TESLA_K80 @@ -1377,6 +1401,10 @@ components: - NVIDIA_A100_80GB - NVIDIA_L4 - NVIDIA_H100_80GB + - NVIDIA_H100_MEGA_80GB + - NVIDIA_H200_141GB + - NVIDIA_B200 + - NVIDIA_GB200 - TPU_V2 - TPU_V3 - TPU_V4_POD @@ -1428,7 +1456,8 @@ components: values: description: >- Optional. Corresponds to the label values of a reservation resource. - This must be the full resource name of the reservation. + This must be the full resource name of the reservation or + reservation block. type: array items: type: string @@ -1445,7 +1474,8 @@ components: Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` - * `aiplatform.googleapis.com/prediction/online/cpu/utilization` + * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * + `aiplatform.googleapis.com/prediction/online/request_count` type: string target: description: >- @@ -1532,14 +1562,19 @@ components: type: string model: description: >- - Required. The resource name of the Model that this is the deployment - of. Note that the Model may be in a different location than the + The resource name of the Model that this is the deployment of. Note + that the Model may be in a different location than the DeployedModel's Endpoint. The resource name may contain version id or version alias to specify the version. Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` if no version is specified, the default version will be deployed. type: string + gdcConnectedModel: + description: >- + GDC pretrained / Gemini model name. The model name is a plain model + name, e.g. gemini-1.5-flash-002. + type: string modelVersionId: description: Output only. The version ID of the model that is deployed. readOnly: true @@ -1605,6 +1640,13 @@ components: configured. readOnly: true $ref: '#/components/schemas/GoogleCloudAiplatformV1PrivateEndpoints' + fasterDeploymentConfig: + description: Configuration for faster model deployment. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FasterDeploymentConfig' + status: + description: Output only. Runtime status of the deployed model. + readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModelStatus' systemLabels: description: >- System labels to apply to Model Garden deployments. System labels @@ -1612,6 +1654,12 @@ components: type: object additionalProperties: type: string + checkpointId: + description: The checkpoint id of the model. + type: string + speculativeDecodingSpec: + description: Optional. Spec for configuring speculative decoding. + $ref: '#/components/schemas/GoogleCloudAiplatformV1SpeculativeDecodingSpec' GoogleCloudAiplatformV1AutomaticResources: id: GoogleCloudAiplatformV1AutomaticResources description: >- @@ -1622,25 +1670,24 @@ components: properties: minReplicaCount: description: >- - Immutable. The minimum number of replicas this DeployedModel will be - always deployed on. If traffic against it increases, it may - dynamically be deployed onto more replicas up to max_replica_count, - and as traffic decreases, some of these extra replicas may be freed. - If the requested value is too large, the deployment will error. + Immutable. The minimum number of replicas that will be always + deployed on. If traffic against it increases, it may dynamically be + deployed onto more replicas up to max_replica_count, and as traffic + decreases, some of these extra replicas may be freed. If the + requested value is too large, the deployment will error. type: integer format: int32 maxReplicaCount: description: >- - Immutable. The maximum number of replicas this DeployedModel may be - deployed on when the traffic against it increases. If the requested - value is too large, the deployment will error, but if deployment - succeeds then the ability to scale the model to that many replicas - is guaranteed (barring service outages). If traffic against the - DeployedModel increases beyond what its replicas at maximum may - handle, a portion of the traffic will be dropped. If this value is - not provided, a no upper bound for scaling under heavy traffic will - be assume, though Vertex AI may be unable to scale beyond certain - replica number. + Immutable. The maximum number of replicas that may be deployed on + when the traffic against it increases. If the requested value is too + large, the deployment will error, but if deployment succeeds then + the ability to scale to that many replicas is guaranteed (barring + service outages). If traffic increases beyond what its replicas at + maximum may handle, a portion of the traffic will be dropped. If + this value is not provided, a no upper bound for scaling under heavy + traffic will be assume, though Vertex AI may be unable to scale + beyond certain replica number. type: integer format: int32 GoogleCloudAiplatformV1ExplanationSpec: @@ -2348,6 +2395,75 @@ components: if private service connect is enabled. readOnly: true type: string + GoogleCloudAiplatformV1FasterDeploymentConfig: + id: GoogleCloudAiplatformV1FasterDeploymentConfig + description: Configuration for faster model deployment. + type: object + properties: + fastTryoutEnabled: + description: If true, enable fast tryout feature for this deployed model. + type: boolean + GoogleCloudAiplatformV1DeployedModelStatus: + id: GoogleCloudAiplatformV1DeployedModelStatus + description: Runtime status of the deployed model. + type: object + properties: + message: + description: Output only. The latest deployed model's status message (if any). + readOnly: true + type: string + lastUpdateTime: + description: Output only. The time at which the status was last updated. + readOnly: true + type: string + format: google-datetime + availableReplicaCount: + description: Output only. The number of available replicas of the deployed model. + readOnly: true + type: integer + format: int32 + GoogleCloudAiplatformV1SpeculativeDecodingSpec: + id: GoogleCloudAiplatformV1SpeculativeDecodingSpec + description: Configuration for Speculative Decoding. + type: object + properties: + draftModelSpeculation: + description: draft model speculation. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SpeculativeDecodingSpecDraftModelSpeculation + ngramSpeculation: + description: N-Gram speculation. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SpeculativeDecodingSpecNgramSpeculation + speculativeTokenCount: + description: The number of speculative tokens to generate at each step. + type: integer + format: int32 + GoogleCloudAiplatformV1SpeculativeDecodingSpecDraftModelSpeculation: + id: GoogleCloudAiplatformV1SpeculativeDecodingSpecDraftModelSpeculation + description: >- + Draft model speculation works by using the smaller model to generate + candidate tokens for speculative decoding. + type: object + properties: + draftModel: + description: Required. The resource name of the draft model. + type: string + GoogleCloudAiplatformV1SpeculativeDecodingSpecNgramSpeculation: + id: GoogleCloudAiplatformV1SpeculativeDecodingSpecNgramSpeculation + description: >- + N-Gram speculation works by trying to find matching tokens in the + previous prompt sequence and use those as speculation for generating new + tokens. + type: object + properties: + ngramSize: + description: >- + The number of last N input tokens used as ngram to search/match + against the previous prompt sequence. This is equal to the N in + N-Gram. The default value is 3 if not specified. + type: integer + format: int32 GoogleCloudAiplatformV1DeployedModelRef: id: GoogleCloudAiplatformV1DeployedModelRef description: Points to a DeployedModel. @@ -2359,6 +2475,9 @@ components: deployedModelId: description: Immutable. An ID of a DeployedModel in the above Endpoint. type: string + checkpointId: + description: Immutable. The ID of the Checkpoint deployed in the DeployedModel. + type: string GoogleCloudAiplatformV1Endpoint: id: GoogleCloudAiplatformV1Endpoint description: >- @@ -2480,10 +2599,18 @@ components: dedicatedEndpointDns: description: >- Output only. DNS of the dedicated endpoint. Will only be populated - if dedicated_endpoint_enabled is true. Format: - `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`. + if dedicated_endpoint_enabled is true. Depending on the features + enabled, uid might be a random number or a string. For example, if + fast_tryout is enabled, uid will be fasttryout. Format: + `https://{endpoint_id}.{region}-{uid}.prediction.vertexai.goog`. readOnly: true type: string + gdcConfig: + description: >- + Configures the Google Distributed Cloud (GDC) environment for online + prediction. Only set this field when the Endpoint is to be deployed + in a GDC environment. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GdcConfig' clientConnectionConfig: description: >- Configurations that are applied to the endpoint for online @@ -2497,6 +2624,14 @@ components: description: Output only. Reserved for future use. readOnly: true type: boolean + genAiAdvancedFeaturesConfig: + description: >- + Optional. Configuration for GenAiAdvancedFeatures. If the endpoint + is serving GenAI models, advanced features like native RAG + integration can be configured. Currently, only Model Garden models + are supported. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfig GoogleCloudAiplatformV1PrivateServiceConnectConfig: id: GoogleCloudAiplatformV1PrivateServiceConnectConfig description: Represents configuration for private service connect. @@ -2514,6 +2649,13 @@ components: type: array items: type: string + pscAutomationConfigs: + description: >- + Optional. List of projects and networks where the PSC endpoints will + be created. This field is used by Online Inference(Prediction) only. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PSCAutomationConfig' serviceAttachment: description: >- Output only. The name of the generated service attachment resource. @@ -2521,6 +2663,47 @@ components: PrivateServiceConnect. readOnly: true type: string + GoogleCloudAiplatformV1PSCAutomationConfig: + id: GoogleCloudAiplatformV1PSCAutomationConfig + description: >- + PSC config that is used to automatically create PSC endpoints in the + user projects. + type: object + properties: + projectId: + description: Required. Project id used to create forwarding rule. + type: string + network: + description: >- + Required. The full name of the Google Compute Engine + [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). + [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/get): + `projects/{project}/global/networks/{network}`. + type: string + ipAddress: + description: Output only. IP address rule created by the PSC service automation. + readOnly: true + type: string + forwardingRule: + description: Output only. Forwarding rule created by the PSC service automation. + readOnly: true + type: string + state: + description: Output only. The state of the PSC service automation. + readOnly: true + type: string + enumDescriptions: + - Should not be used. + - The PSC service automation is successful. + - The PSC service automation has failed. + enum: + - PSC_AUTOMATION_STATE_UNSPECIFIED + - PSC_AUTOMATION_STATE_SUCCESSFUL + - PSC_AUTOMATION_STATE_FAILED + errorMessage: + description: Output only. Error message if the PSC service automation failed. + readOnly: true + type: string GoogleCloudAiplatformV1PredictRequestResponseLoggingConfig: id: GoogleCloudAiplatformV1PredictRequestResponseLoggingConfig description: Configuration for logging request-response to a BigQuery table. @@ -2557,6 +2740,16 @@ components: path. For example: `bq://projectId` or `bq://projectId.bqDatasetId` or `bq://projectId.bqDatasetId.bqTableId`. type: string + GoogleCloudAiplatformV1GdcConfig: + id: GoogleCloudAiplatformV1GdcConfig + description: Google Distributed Cloud (GDC) config. + type: object + properties: + zone: + description: >- + GDC zone. A cluster will be designated for the Vertex AI workload in + this zone. + type: string GoogleCloudAiplatformV1ClientConnectionConfig: id: GoogleCloudAiplatformV1ClientConnectionConfig description: >- @@ -2568,6 +2761,26 @@ components: description: Customizable online prediction request timeout. type: string format: google-duration + GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfig: + id: GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfig + description: Configuration for GenAiAdvancedFeatures. + type: object + properties: + ragConfig: + description: Configuration for Retrieval Augmented Generation feature. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfigRagConfig + GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfigRagConfig: + id: GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfigRagConfig + description: Configuration for Retrieval Augmented Generation feature. + type: object + properties: + enableRag: + description: >- + If true, enable Retrieval Augmented Generation in ChatCompletion + request. Once enabled, the endpoint will be identified as GenAI + endpoint and Arthedain router will be used. + type: boolean GoogleCloudAiplatformV1ListEndpointsResponse: id: GoogleCloudAiplatformV1ListEndpointsResponse description: Response message for EndpointService.ListEndpoints. @@ -2583,6 +2796,17 @@ components: A token to retrieve the next page of results. Pass to ListEndpointsRequest.page_token to obtain that page. type: string + GoogleCloudAiplatformV1UpdateEndpointLongRunningRequest: + id: GoogleCloudAiplatformV1UpdateEndpointLongRunningRequest + description: Request message for EndpointService.UpdateEndpointLongRunning. + type: object + properties: + endpoint: + description: >- + Required. The Endpoint which replaces the resource on the server. + Currently we only support updating the `client_connection_config` + field, all the other fields' update will be blocked. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Endpoint' GoogleCloudAiplatformV1DeployModelRequest: id: GoogleCloudAiplatformV1DeployModelRequest description: Request message for EndpointService.DeployModel. @@ -2642,6 +2866,7 @@ components: the following fields can be mutated: * `min_replica_count` in either DedicatedResources or AutomaticResources * `max_replica_count` in either DedicatedResources or AutomaticResources * + `required_replica_count` in DedicatedResources * autoscaling_metric_specs * `disable_container_logging` (v1 only) * `enable_container_logging` (v1beta1 only) $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModel' @@ -2740,6 +2965,52 @@ components: description: Input for tool parameter key value match metric. $ref: >- #/components/schemas/GoogleCloudAiplatformV1ToolParameterKVMatchInput + cometInput: + description: Translation metrics. Input for Comet metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1CometInput' + metricxInput: + description: Input for Metricx metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1MetricxInput' + trajectoryExactMatchInput: + description: Input for trajectory exact match metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TrajectoryExactMatchInput + trajectoryInOrderMatchInput: + description: Input for trajectory in order match metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TrajectoryInOrderMatchInput + trajectoryAnyOrderMatchInput: + description: Input for trajectory match any order metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TrajectoryAnyOrderMatchInput + trajectoryPrecisionInput: + description: Input for trajectory precision metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1TrajectoryPrecisionInput' + trajectoryRecallInput: + description: Input for trajectory recall metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1TrajectoryRecallInput' + trajectorySingleToolUseInput: + description: Input for trajectory single tool use metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TrajectorySingleToolUseInput + rubricBasedInstructionFollowingInput: + description: Rubric Based Instruction Following metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1RubricBasedInstructionFollowingInput + metrics: + description: >- + The metrics used for evaluation. Currently, we only support + evaluating a single metric. If multiple metrics are provided, only + the first one will be evaluated. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Metric' + instance: + description: The instance to be evaluated. + $ref: '#/components/schemas/GoogleCloudAiplatformV1EvaluationInstance' + autoraterConfig: + description: Optional. Autorater config used for evaluation. + $ref: '#/components/schemas/GoogleCloudAiplatformV1AutoraterConfig' GoogleCloudAiplatformV1ExactMatchInput: id: GoogleCloudAiplatformV1ExactMatchInput description: Input for exact match metric. @@ -3423,6 +3694,26 @@ components: metricPromptTemplate: description: Required. Metric prompt template for pointwise metric. type: string + systemInstruction: + description: Optional. System instructions for pointwise metric. + type: string + customOutputFormatConfig: + description: >- + Optional. CustomOutputFormatConfig allows customization of metric + output. By default, metrics return a score and explanation. When + this config is set, the default output is replaced with either: - + The raw output string. - A parsed output based on a user-defined + schema. If a custom format is chosen, the `score` and `explanation` + fields in the corresponding metric result will be empty. + $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomOutputFormatConfig' + GoogleCloudAiplatformV1CustomOutputFormatConfig: + id: GoogleCloudAiplatformV1CustomOutputFormatConfig + description: Spec for custom output format configuration. + type: object + properties: + returnRawOutput: + description: Optional. Whether to return raw output. + type: boolean GoogleCloudAiplatformV1PointwiseMetricInstance: id: GoogleCloudAiplatformV1PointwiseMetricInstance description: >- @@ -3436,6 +3727,263 @@ components: expected in the json_instance to render PointwiseMetricSpec.instance_prompt_template. type: string + contentMapInstance: + description: >- + Key-value contents for the mutlimodality input, including text, + image, video, audio, and pdf, etc. The key is placeholder in metric + prompt template, and the value is the multimodal content. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ContentMap' + GoogleCloudAiplatformV1ContentMap: + id: GoogleCloudAiplatformV1ContentMap + description: Map of placeholder in metric prompt template to contents of model input. + type: object + properties: + values: + description: Optional. Map of placeholder to contents. + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ContentMapContents' + GoogleCloudAiplatformV1ContentMapContents: + id: GoogleCloudAiplatformV1ContentMapContents + description: Repeated Content type. + type: object + properties: + contents: + description: Optional. Repeated contents. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' + GoogleCloudAiplatformV1Content: + id: GoogleCloudAiplatformV1Content + description: >- + The base structured datatype containing multi-part content of a message. + A `Content` includes a `role` field designating the producer of the + `Content` and a `parts` field containing multi-part data that contains + the content of the message turn. + type: object + properties: + role: + description: >- + Optional. The producer of the content. Must be either 'user' or + 'model'. Useful to set for multi-turn conversations, otherwise can + be left blank or unset. + type: string + parts: + description: >- + Required. Ordered `Parts` that constitute a single message. Parts + may have different IANA MIME types. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Part' + GoogleCloudAiplatformV1Part: + id: GoogleCloudAiplatformV1Part + description: >- + A datatype containing media that is part of a multi-part `Content` + message. A `Part` consists of data which has an associated datatype. A + `Part` can only contain one of the accepted types in `Part.data`. A + `Part` must have a fixed IANA MIME type identifying the type and subtype + of the media if `inline_data` or `file_data` field is filled with raw + bytes. + type: object + properties: + text: + description: Optional. Text part (can be code). + type: string + inlineData: + description: Optional. Inlined bytes data. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Blob' + fileData: + description: Optional. URI based data. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FileData' + functionCall: + description: >- + Optional. A predicted [FunctionCall] returned from the model that + contains a string representing the [FunctionDeclaration.name] with + the parameters and their values. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FunctionCall' + functionResponse: + description: >- + Optional. The result output of a [FunctionCall] that contains a + string representing the [FunctionDeclaration.name] and a structured + JSON object containing any output from the function call. It is used + as context to the model. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FunctionResponse' + executableCode: + description: Optional. Code generated by the model that is meant to be executed. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExecutableCode' + codeExecutionResult: + description: Optional. Result of executing the [ExecutableCode]. + $ref: '#/components/schemas/GoogleCloudAiplatformV1CodeExecutionResult' + videoMetadata: + description: >- + Optional. Video metadata. The metadata should only be specified + while the video data is presented in inline_data or file_data. + $ref: '#/components/schemas/GoogleCloudAiplatformV1VideoMetadata' + thought: + description: Optional. Indicates if the part is thought from the model. + type: boolean + thoughtSignature: + description: >- + Optional. An opaque signature for the thought so it can be reused in + subsequent requests. + type: string + format: byte + GoogleCloudAiplatformV1Blob: + id: GoogleCloudAiplatformV1Blob + description: Content blob. + type: object + properties: + mimeType: + description: Required. The IANA standard MIME type of the source data. + type: string + data: + description: Required. Raw bytes. + type: string + format: byte + displayName: + description: >- + Optional. Display name of the blob. Used to provide a label or + filename to distinguish blobs. This field is only returned in + PromptMessage for prompt management. It is currently used in the + Gemini GenerateContent calls only when server side tools + (code_execution, google_search, and url_context) are enabled. + type: string + GoogleCloudAiplatformV1FileData: + id: GoogleCloudAiplatformV1FileData + description: URI based data. + type: object + properties: + mimeType: + description: Required. The IANA standard MIME type of the source data. + type: string + fileUri: + description: Required. URI. + type: string + displayName: + description: >- + Optional. Display name of the file data. Used to provide a label or + filename to distinguish file datas. This field is only returned in + PromptMessage for prompt management. It is currently used in the + Gemini GenerateContent calls only when server side tools + (code_execution, google_search, and url_context) are enabled. + type: string + GoogleCloudAiplatformV1FunctionCall: + id: GoogleCloudAiplatformV1FunctionCall + description: >- + A predicted [FunctionCall] returned from the model that contains a + string representing the [FunctionDeclaration.name] and a structured JSON + object containing the parameters and their values. + type: object + properties: + name: + description: >- + Required. The name of the function to call. Matches + [FunctionDeclaration.name]. + type: string + args: + description: >- + Optional. The function parameters and values in JSON object format. + See [FunctionDeclaration.parameters] for parameter details. + type: object + additionalProperties: + type: any + description: Properties of the object. + GoogleCloudAiplatformV1FunctionResponse: + id: GoogleCloudAiplatformV1FunctionResponse + description: >- + The result output from a [FunctionCall] that contains a string + representing the [FunctionDeclaration.name] and a structured JSON object + containing any output from the function is used as context to the model. + This should contain the result of a [FunctionCall] made based on model + prediction. + type: object + properties: + name: + description: >- + Required. The name of the function to call. Matches + [FunctionDeclaration.name] and [FunctionCall.name]. + type: string + response: + description: >- + Required. The function response in JSON object format. Use "output" + key to specify function output and "error" key to specify error + details (if any). If "output" and "error" keys are not specified, + then whole "response" is treated as function output. + type: object + additionalProperties: + type: any + description: Properties of the object. + GoogleCloudAiplatformV1ExecutableCode: + id: GoogleCloudAiplatformV1ExecutableCode + description: >- + Code generated by the model that is meant to be executed, and the result + returned to the model. Generated when using the [CodeExecution] tool, in + which the code will be automatically executed, and a corresponding + [CodeExecutionResult] will also be generated. + type: object + properties: + language: + description: Required. Programming language of the `code`. + type: string + enumDescriptions: + - Unspecified language. This value should not be used. + - Python >= 3.10, with numpy and simpy available. + enum: + - LANGUAGE_UNSPECIFIED + - PYTHON + code: + description: Required. The code to be executed. + type: string + GoogleCloudAiplatformV1CodeExecutionResult: + id: GoogleCloudAiplatformV1CodeExecutionResult + description: >- + Result of executing the [ExecutableCode]. Only generated when using the + [CodeExecution] tool, and always follows a `part` containing the + [ExecutableCode]. + type: object + properties: + outcome: + description: Required. Outcome of the code execution. + type: string + enumDescriptions: + - Unspecified status. This value should not be used. + - Code execution completed successfully. + - >- + Code execution finished but with a failure. `stderr` should + contain the reason. + - >- + Code execution ran for too long, and was cancelled. There may or + may not be a partial output present. + enum: + - OUTCOME_UNSPECIFIED + - OUTCOME_OK + - OUTCOME_FAILED + - OUTCOME_DEADLINE_EXCEEDED + output: + description: >- + Optional. Contains stdout when code execution is successful, stderr + or other description otherwise. + type: string + GoogleCloudAiplatformV1VideoMetadata: + id: GoogleCloudAiplatformV1VideoMetadata + description: Metadata describes the input video content. + type: object + properties: + startOffset: + description: Optional. The start offset of the video. + type: string + format: google-duration + endOffset: + description: Optional. The end offset of the video. + type: string + format: google-duration + fps: + description: >- + Optional. The frame rate of the video sent to the model. If not + specified, the default value will be 1.0. The fps range is (0.0, + 24.0]. + type: number + format: double GoogleCloudAiplatformV1PairwiseMetricInput: id: GoogleCloudAiplatformV1PairwiseMetricInput description: Input for pairwise metric. @@ -3455,6 +4003,23 @@ components: metricPromptTemplate: description: Required. Metric prompt template for pairwise metric. type: string + candidateResponseFieldName: + description: Optional. The field name of the candidate response. + type: string + baselineResponseFieldName: + description: Optional. The field name of the baseline response. + type: string + systemInstruction: + description: Optional. System instructions for pairwise metric. + type: string + customOutputFormatConfig: + description: >- + Optional. CustomOutputFormatConfig allows customization of metric + output. When this config is set, the default output is replaced with + the raw output string. If a custom format is chosen, the + `pairwise_choice` and `explanation` fields in the corresponding + metric result will be empty. + $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomOutputFormatConfig' GoogleCloudAiplatformV1PairwiseMetricInstance: id: GoogleCloudAiplatformV1PairwiseMetricInstance description: >- @@ -3468,6 +4033,12 @@ components: expected in the json_instance to render PairwiseMetricSpec.instance_prompt_template. type: string + contentMapInstance: + description: >- + Key-value contents for the mutlimodality input, including text, + image, video, audio, and pdf, etc. The key is placeholder in metric + prompt template, and the value is the multimodal content. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ContentMap' GoogleCloudAiplatformV1ToolCallValidInput: id: GoogleCloudAiplatformV1ToolCallValidInput description: Input for tool call valid metric. @@ -3590,6 +4161,622 @@ components: reference: description: Required. Ground truth used to compare against the prediction. type: string + GoogleCloudAiplatformV1CometInput: + id: GoogleCloudAiplatformV1CometInput + description: Input for Comet metric. + type: object + properties: + metricSpec: + description: Required. Spec for comet metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1CometSpec' + instance: + description: Required. Comet instance. + $ref: '#/components/schemas/GoogleCloudAiplatformV1CometInstance' + GoogleCloudAiplatformV1CometSpec: + id: GoogleCloudAiplatformV1CometSpec + description: Spec for Comet metric. + type: object + properties: + version: + description: Required. Which version to use for evaluation. + type: string + enumDescriptions: + - Comet version unspecified. + - >- + Comet 22 for translation + source + reference + (source-reference-combined). + enum: + - COMET_VERSION_UNSPECIFIED + - COMET_22_SRC_REF + sourceLanguage: + description: Optional. Source language in BCP-47 format. + type: string + targetLanguage: + description: >- + Optional. Target language in BCP-47 format. Covers both prediction + and reference. + type: string + GoogleCloudAiplatformV1CometInstance: + id: GoogleCloudAiplatformV1CometInstance + description: >- + Spec for Comet instance - The fields used for evaluation are dependent + on the comet version. + type: object + properties: + prediction: + description: Required. Output of the evaluated model. + type: string + reference: + description: Optional. Ground truth used to compare against the prediction. + type: string + source: + description: Optional. Source text in original language. + type: string + GoogleCloudAiplatformV1MetricxInput: + id: GoogleCloudAiplatformV1MetricxInput + description: Input for MetricX metric. + type: object + properties: + metricSpec: + description: Required. Spec for Metricx metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1MetricxSpec' + instance: + description: Required. Metricx instance. + $ref: '#/components/schemas/GoogleCloudAiplatformV1MetricxInstance' + GoogleCloudAiplatformV1MetricxSpec: + id: GoogleCloudAiplatformV1MetricxSpec + description: Spec for MetricX metric. + type: object + properties: + version: + description: Required. Which version to use for evaluation. + type: string + enumDescriptions: + - MetricX version unspecified. + - MetricX 2024 (2.6) for translation + reference (reference-based). + - MetricX 2024 (2.6) for translation + source (QE). + - >- + MetricX 2024 (2.6) for translation + source + reference + (source-reference-combined). + enum: + - METRICX_VERSION_UNSPECIFIED + - METRICX_24_REF + - METRICX_24_SRC + - METRICX_24_SRC_REF + sourceLanguage: + description: Optional. Source language in BCP-47 format. + type: string + targetLanguage: + description: >- + Optional. Target language in BCP-47 format. Covers both prediction + and reference. + type: string + GoogleCloudAiplatformV1MetricxInstance: + id: GoogleCloudAiplatformV1MetricxInstance + description: >- + Spec for MetricX instance - The fields used for evaluation are dependent + on the MetricX version. + type: object + properties: + prediction: + description: Required. Output of the evaluated model. + type: string + reference: + description: Optional. Ground truth used to compare against the prediction. + type: string + source: + description: Optional. Source text in original language. + type: string + GoogleCloudAiplatformV1TrajectoryExactMatchInput: + id: GoogleCloudAiplatformV1TrajectoryExactMatchInput + description: Instances and metric spec for TrajectoryExactMatch metric. + type: object + properties: + metricSpec: + description: Required. Spec for TrajectoryExactMatch metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1TrajectoryExactMatchSpec' + instances: + description: Required. Repeated TrajectoryExactMatch instance. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TrajectoryExactMatchInstance + GoogleCloudAiplatformV1TrajectoryExactMatchSpec: + id: GoogleCloudAiplatformV1TrajectoryExactMatchSpec + description: >- + Spec for TrajectoryExactMatch metric - returns 1 if tool calls in the + reference trajectory exactly match the predicted trajectory, else 0. + type: object + properties: {} + GoogleCloudAiplatformV1TrajectoryExactMatchInstance: + id: GoogleCloudAiplatformV1TrajectoryExactMatchInstance + description: Spec for TrajectoryExactMatch instance. + type: object + properties: + predictedTrajectory: + description: Required. Spec for predicted tool call trajectory. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trajectory' + referenceTrajectory: + description: Required. Spec for reference tool call trajectory. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trajectory' + GoogleCloudAiplatformV1Trajectory: + id: GoogleCloudAiplatformV1Trajectory + description: Spec for trajectory. + type: object + properties: + toolCalls: + description: Required. Tool calls in the trajectory. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolCall' + GoogleCloudAiplatformV1ToolCall: + id: GoogleCloudAiplatformV1ToolCall + description: Spec for tool call. + type: object + properties: + toolName: + description: Required. Spec for tool name + type: string + toolInput: + description: Optional. Spec for tool input + type: string + GoogleCloudAiplatformV1TrajectoryInOrderMatchInput: + id: GoogleCloudAiplatformV1TrajectoryInOrderMatchInput + description: Instances and metric spec for TrajectoryInOrderMatch metric. + type: object + properties: + metricSpec: + description: Required. Spec for TrajectoryInOrderMatch metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TrajectoryInOrderMatchSpec + instances: + description: Required. Repeated TrajectoryInOrderMatch instance. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TrajectoryInOrderMatchInstance + GoogleCloudAiplatformV1TrajectoryInOrderMatchSpec: + id: GoogleCloudAiplatformV1TrajectoryInOrderMatchSpec + description: >- + Spec for TrajectoryInOrderMatch metric - returns 1 if tool calls in the + reference trajectory appear in the predicted trajectory in the same + order, else 0. + type: object + properties: {} + GoogleCloudAiplatformV1TrajectoryInOrderMatchInstance: + id: GoogleCloudAiplatformV1TrajectoryInOrderMatchInstance + description: Spec for TrajectoryInOrderMatch instance. + type: object + properties: + predictedTrajectory: + description: Required. Spec for predicted tool call trajectory. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trajectory' + referenceTrajectory: + description: Required. Spec for reference tool call trajectory. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trajectory' + GoogleCloudAiplatformV1TrajectoryAnyOrderMatchInput: + id: GoogleCloudAiplatformV1TrajectoryAnyOrderMatchInput + description: Instances and metric spec for TrajectoryAnyOrderMatch metric. + type: object + properties: + metricSpec: + description: Required. Spec for TrajectoryAnyOrderMatch metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TrajectoryAnyOrderMatchSpec + instances: + description: Required. Repeated TrajectoryAnyOrderMatch instance. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TrajectoryAnyOrderMatchInstance + GoogleCloudAiplatformV1TrajectoryAnyOrderMatchSpec: + id: GoogleCloudAiplatformV1TrajectoryAnyOrderMatchSpec + description: >- + Spec for TrajectoryAnyOrderMatch metric - returns 1 if all tool calls in + the reference trajectory appear in the predicted trajectory in any + order, else 0. + type: object + properties: {} + GoogleCloudAiplatformV1TrajectoryAnyOrderMatchInstance: + id: GoogleCloudAiplatformV1TrajectoryAnyOrderMatchInstance + description: Spec for TrajectoryAnyOrderMatch instance. + type: object + properties: + predictedTrajectory: + description: Required. Spec for predicted tool call trajectory. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trajectory' + referenceTrajectory: + description: Required. Spec for reference tool call trajectory. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trajectory' + GoogleCloudAiplatformV1TrajectoryPrecisionInput: + id: GoogleCloudAiplatformV1TrajectoryPrecisionInput + description: Instances and metric spec for TrajectoryPrecision metric. + type: object + properties: + metricSpec: + description: Required. Spec for TrajectoryPrecision metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1TrajectoryPrecisionSpec' + instances: + description: Required. Repeated TrajectoryPrecision instance. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TrajectoryPrecisionInstance + GoogleCloudAiplatformV1TrajectoryPrecisionSpec: + id: GoogleCloudAiplatformV1TrajectoryPrecisionSpec + description: >- + Spec for TrajectoryPrecision metric - returns a float score based on + average precision of individual tool calls. + type: object + properties: {} + GoogleCloudAiplatformV1TrajectoryPrecisionInstance: + id: GoogleCloudAiplatformV1TrajectoryPrecisionInstance + description: Spec for TrajectoryPrecision instance. + type: object + properties: + predictedTrajectory: + description: Required. Spec for predicted tool call trajectory. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trajectory' + referenceTrajectory: + description: Required. Spec for reference tool call trajectory. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trajectory' + GoogleCloudAiplatformV1TrajectoryRecallInput: + id: GoogleCloudAiplatformV1TrajectoryRecallInput + description: Instances and metric spec for TrajectoryRecall metric. + type: object + properties: + metricSpec: + description: Required. Spec for TrajectoryRecall metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1TrajectoryRecallSpec' + instances: + description: Required. Repeated TrajectoryRecall instance. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TrajectoryRecallInstance + GoogleCloudAiplatformV1TrajectoryRecallSpec: + id: GoogleCloudAiplatformV1TrajectoryRecallSpec + description: >- + Spec for TrajectoryRecall metric - returns a float score based on + average recall of individual tool calls. + type: object + properties: {} + GoogleCloudAiplatformV1TrajectoryRecallInstance: + id: GoogleCloudAiplatformV1TrajectoryRecallInstance + description: Spec for TrajectoryRecall instance. + type: object + properties: + predictedTrajectory: + description: Required. Spec for predicted tool call trajectory. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trajectory' + referenceTrajectory: + description: Required. Spec for reference tool call trajectory. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trajectory' + GoogleCloudAiplatformV1TrajectorySingleToolUseInput: + id: GoogleCloudAiplatformV1TrajectorySingleToolUseInput + description: Instances and metric spec for TrajectorySingleToolUse metric. + type: object + properties: + metricSpec: + description: Required. Spec for TrajectorySingleToolUse metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TrajectorySingleToolUseSpec + instances: + description: Required. Repeated TrajectorySingleToolUse instance. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TrajectorySingleToolUseInstance + GoogleCloudAiplatformV1TrajectorySingleToolUseSpec: + id: GoogleCloudAiplatformV1TrajectorySingleToolUseSpec + description: >- + Spec for TrajectorySingleToolUse metric - returns 1 if tool is present + in the predicted trajectory, else 0. + type: object + properties: + toolName: + description: >- + Required. Spec for tool name to be checked for in the predicted + trajectory. + type: string + GoogleCloudAiplatformV1TrajectorySingleToolUseInstance: + id: GoogleCloudAiplatformV1TrajectorySingleToolUseInstance + description: Spec for TrajectorySingleToolUse instance. + type: object + properties: + predictedTrajectory: + description: Required. Spec for predicted tool call trajectory. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trajectory' + GoogleCloudAiplatformV1RubricBasedInstructionFollowingInput: + id: GoogleCloudAiplatformV1RubricBasedInstructionFollowingInput + description: Instance and metric spec for RubricBasedInstructionFollowing metric. + type: object + properties: + metricSpec: + description: Required. Spec for RubricBasedInstructionFollowing metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1RubricBasedInstructionFollowingSpec + instance: + description: Required. Instance for RubricBasedInstructionFollowing metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1RubricBasedInstructionFollowingInstance + GoogleCloudAiplatformV1RubricBasedInstructionFollowingSpec: + id: GoogleCloudAiplatformV1RubricBasedInstructionFollowingSpec + description: >- + Spec for RubricBasedInstructionFollowing metric - returns rubrics and + verdicts corresponding to rubrics along with overall score. + type: object + properties: {} + GoogleCloudAiplatformV1RubricBasedInstructionFollowingInstance: + id: GoogleCloudAiplatformV1RubricBasedInstructionFollowingInstance + description: >- + Instance for RubricBasedInstructionFollowing metric - one instance + corresponds to one row in an evaluation dataset. + type: object + properties: + jsonInstance: + description: >- + Required. Instance specified as a json string. String key-value + pairs are expected in the json_instance to render + RubricBasedInstructionFollowing prompt templates. + type: string + GoogleCloudAiplatformV1Metric: + id: GoogleCloudAiplatformV1Metric + description: The metric used for running evaluations. + type: object + properties: + predefinedMetricSpec: + description: The spec for a pre-defined metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1PredefinedMetricSpec' + pointwiseMetricSpec: + description: Spec for pointwise metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1PointwiseMetricSpec' + pairwiseMetricSpec: + description: Spec for pairwise metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1PairwiseMetricSpec' + exactMatchSpec: + description: Spec for exact match metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExactMatchSpec' + bleuSpec: + description: Spec for bleu metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1BleuSpec' + rougeSpec: + description: Spec for rouge metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1RougeSpec' + aggregationMetrics: + description: Optional. The aggregation metrics to use. + type: array + items: + type: string + enumDescriptions: + - Unspecified aggregation metric. + - Average aggregation metric. Not supported for Pairwise metric. + - Mode aggregation metric. + - >- + Standard deviation aggregation metric. Not supported for + pairwise metric. + - Variance aggregation metric. Not supported for pairwise metric. + - Minimum aggregation metric. Not supported for pairwise metric. + - Maximum aggregation metric. Not supported for pairwise metric. + - Median aggregation metric. Not supported for pairwise metric. + - >- + 90th percentile aggregation metric. Not supported for pairwise + metric. + - >- + 95th percentile aggregation metric. Not supported for pairwise + metric. + - >- + 99th percentile aggregation metric. Not supported for pairwise + metric. + enum: + - AGGREGATION_METRIC_UNSPECIFIED + - AVERAGE + - MODE + - STANDARD_DEVIATION + - VARIANCE + - MINIMUM + - MAXIMUM + - MEDIAN + - PERCENTILE_P90 + - PERCENTILE_P95 + - PERCENTILE_P99 + GoogleCloudAiplatformV1PredefinedMetricSpec: + id: GoogleCloudAiplatformV1PredefinedMetricSpec + description: The spec for a pre-defined metric. + type: object + properties: + metricSpecName: + description: >- + Required. The name of a pre-defined metric, such as + "instruction_following_v1" or "text_quality_v1". + type: string + metricSpecParameters: + description: Optional. The parameters needed to run the pre-defined metric. + type: object + additionalProperties: + type: any + description: Properties of the object. + GoogleCloudAiplatformV1EvaluationInstance: + id: GoogleCloudAiplatformV1EvaluationInstance + description: >- + A single instance to be evaluated. Instances are used to specify the + input data for evaluation, from simple string comparisons to complex, + multi-turn model evaluations + type: object + properties: + prompt: + description: >- + Optional. Data used to populate placeholder `prompt` in a metric + prompt template. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1EvaluationInstanceInstanceData + rubricGroups: + description: >- + Optional. Named groups of rubrics associated with the prompt. This + is used for rubric-based evaluations where rubrics can be referenced + by a key. The key could represent versions, associated metrics, etc. + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudAiplatformV1RubricGroup' + response: + description: >- + Required. Data used to populate placeholder `response` in a metric + prompt template. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1EvaluationInstanceInstanceData + reference: + description: >- + Optional. Data used to populate placeholder `reference` in a metric + prompt template. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1EvaluationInstanceInstanceData + otherData: + description: >- + Optional. Other data used to populate placeholders based on their + key. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1EvaluationInstanceMapInstance + GoogleCloudAiplatformV1EvaluationInstanceInstanceData: + id: GoogleCloudAiplatformV1EvaluationInstanceInstanceData + description: Instance data used to populate placeholders in a metric prompt template. + type: object + properties: + text: + description: Text data. + type: string + contents: + description: List of Gemini content data. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1EvaluationInstanceInstanceDataContents + GoogleCloudAiplatformV1EvaluationInstanceInstanceDataContents: + id: GoogleCloudAiplatformV1EvaluationInstanceInstanceDataContents + description: List of standard Content messages from Gemini API. + type: object + properties: + contents: + description: Optional. Repeated contents. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' + GoogleCloudAiplatformV1RubricGroup: + id: GoogleCloudAiplatformV1RubricGroup + description: >- + A group of rubrics, used for grouping rubrics based on a metric or a + version. + type: object + properties: + groupId: + description: Unique identifier for the group. + type: string + displayName: + description: >- + Human-readable name for the group. This should be unique within a + given context if used for display or selection. Example: + "Instruction Following V1", "Content Quality - Summarization Task". + type: string + rubrics: + description: Rubrics that are part of this group. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Rubric' + GoogleCloudAiplatformV1Rubric: + id: GoogleCloudAiplatformV1Rubric + description: >- + Message representing a single testable criterion for evaluation. One + input prompt could have multiple rubrics. + type: object + properties: + rubricId: + description: >- + Unique identifier for the rubric. This ID is used to refer to this + rubric, e.g., in RubricVerdict. + type: string + content: + description: Required. The actual testable criteria for the rubric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1RubricContent' + type: + description: >- + Optional. A type designator for the rubric, which can inform how + it's evaluated or interpreted by systems or users. It's recommended + to use consistent, well-defined, upper snake_case strings. Examples: + "SUMMARIZATION_QUALITY", "SAFETY_HARMFUL_CONTENT", + "INSTRUCTION_ADHERENCE". + type: string + importance: + description: Optional. The relative importance of this rubric. + type: string + enumDescriptions: + - Importance is not specified. + - High importance. + - Medium importance. + - Low importance. + enum: + - IMPORTANCE_UNSPECIFIED + - HIGH + - MEDIUM + - LOW + GoogleCloudAiplatformV1RubricContent: + id: GoogleCloudAiplatformV1RubricContent + description: Content of the rubric, defining the testable criteria. + type: object + properties: + property: + description: Evaluation criteria based on a specific property. + $ref: '#/components/schemas/GoogleCloudAiplatformV1RubricContentProperty' + GoogleCloudAiplatformV1RubricContentProperty: + id: GoogleCloudAiplatformV1RubricContentProperty + description: Defines criteria based on a specific property. + type: object + properties: + description: + description: >- + Description of the property being evaluated. Example: "The model's + response is grammatically correct." + type: string + GoogleCloudAiplatformV1EvaluationInstanceMapInstance: + id: GoogleCloudAiplatformV1EvaluationInstanceMapInstance + description: Instance data specified as a map. + type: object + properties: + mapInstance: + description: Optional. Map of instance data. + type: object + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1EvaluationInstanceInstanceData + GoogleCloudAiplatformV1AutoraterConfig: + id: GoogleCloudAiplatformV1AutoraterConfig + description: >- + The configs for autorater. This is applicable to both EvaluateInstances + and EvaluateDataset. + type: object + properties: + samplingCount: + description: >- + Optional. Number of samples for each instance in the dataset. If not + specified, the default is 4. Minimum value is 1, maximum value is + 32. + type: integer + format: int32 + flipEnabled: + description: >- + Optional. Default is true. Whether to flip the candidate and + baseline responses. This is only applicable to the pairwise metric. + If enabled, also provide + PairwiseMetricSpec.candidate_response_field_name and + PairwiseMetricSpec.baseline_response_field_name. When rendering + PairwiseMetricSpec.metric_prompt_template, the candidate and + baseline fields will be flipped for half of the samples to reduce + bias. + type: boolean + autoraterModel: + description: >- + Optional. The fully qualified name of the publisher model or tuned + autorater endpoint to use. Publisher model format: + `projects/{project}/locations/{location}/publishers/*/models/*` + Tuned model endpoint format: + `projects/{project}/locations/{location}/endpoints/{endpoint}` + type: string GoogleCloudAiplatformV1EvaluateInstancesResponse: id: GoogleCloudAiplatformV1EvaluateInstancesResponse description: Response message for EvaluationService.EvaluateInstances. @@ -3679,6 +4866,47 @@ components: description: Results for tool parameter key value match metric. $ref: >- #/components/schemas/GoogleCloudAiplatformV1ToolParameterKVMatchResults + cometResult: + description: Translation metrics. Result for Comet metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1CometResult' + metricxResult: + description: Result for Metricx metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1MetricxResult' + trajectoryExactMatchResults: + description: Result for trajectory exact match metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TrajectoryExactMatchResults + trajectoryInOrderMatchResults: + description: Result for trajectory in order match metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TrajectoryInOrderMatchResults + trajectoryAnyOrderMatchResults: + description: Result for trajectory any order match metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TrajectoryAnyOrderMatchResults + trajectoryPrecisionResults: + description: Result for trajectory precision metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TrajectoryPrecisionResults + trajectoryRecallResults: + description: Results for trajectory recall metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1TrajectoryRecallResults' + trajectorySingleToolUseResults: + description: Results for trajectory single tool use metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TrajectorySingleToolUseResults + rubricBasedInstructionFollowingResult: + description: Result for rubric based instruction following metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1RubricBasedInstructionFollowingResult + metricResults: + description: >- + Metric results for each instance. The order of the metric results is + guaranteed to be the same as the order of the instances in the + request. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1MetricResult' GoogleCloudAiplatformV1ExactMatchResults: id: GoogleCloudAiplatformV1ExactMatchResults description: Results for exact match metric. @@ -4040,6 +5268,30 @@ components: description: Output only. Explanation for pointwise metric score. readOnly: true type: string + customOutput: + description: Output only. Spec for custom output. + readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomOutput' + GoogleCloudAiplatformV1CustomOutput: + id: GoogleCloudAiplatformV1CustomOutput + description: Spec for custom output. + type: object + properties: + rawOutputs: + description: Output only. List of raw output strings. + readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1RawOutput' + GoogleCloudAiplatformV1RawOutput: + id: GoogleCloudAiplatformV1RawOutput + description: Raw output. + type: object + properties: + rawOutput: + description: Output only. Raw output string. + readOnly: true + type: array + items: + type: string GoogleCloudAiplatformV1PairwiseMetricResult: id: GoogleCloudAiplatformV1PairwiseMetricResult description: Spec for pairwise metric result. @@ -4063,6 +5315,10 @@ components: description: Output only. Explanation for pairwise metric score. readOnly: true type: string + customOutput: + description: Output only. Spec for custom output. + readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomOutput' GoogleCloudAiplatformV1ToolCallValidResults: id: GoogleCloudAiplatformV1ToolCallValidResults description: Results for tool call valid metric. @@ -4151,6 +5407,364 @@ components: readOnly: true type: number format: float + GoogleCloudAiplatformV1CometResult: + id: GoogleCloudAiplatformV1CometResult + description: >- + Spec for Comet result - calculates the comet score for the given + instance using the version specified in the spec. + type: object + properties: + score: + description: Output only. Comet score. Range depends on version. + readOnly: true + type: number + format: float + GoogleCloudAiplatformV1MetricxResult: + id: GoogleCloudAiplatformV1MetricxResult + description: >- + Spec for MetricX result - calculates the MetricX score for the given + instance using the version specified in the spec. + type: object + properties: + score: + description: Output only. MetricX score. Range depends on version. + readOnly: true + type: number + format: float + GoogleCloudAiplatformV1TrajectoryExactMatchResults: + id: GoogleCloudAiplatformV1TrajectoryExactMatchResults + description: Results for TrajectoryExactMatch metric. + type: object + properties: + trajectoryExactMatchMetricValues: + description: Output only. TrajectoryExactMatch metric values. + readOnly: true + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TrajectoryExactMatchMetricValue + GoogleCloudAiplatformV1TrajectoryExactMatchMetricValue: + id: GoogleCloudAiplatformV1TrajectoryExactMatchMetricValue + description: TrajectoryExactMatch metric value for an instance. + type: object + properties: + score: + description: Output only. TrajectoryExactMatch score. + readOnly: true + type: number + format: float + GoogleCloudAiplatformV1TrajectoryInOrderMatchResults: + id: GoogleCloudAiplatformV1TrajectoryInOrderMatchResults + description: Results for TrajectoryInOrderMatch metric. + type: object + properties: + trajectoryInOrderMatchMetricValues: + description: Output only. TrajectoryInOrderMatch metric values. + readOnly: true + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TrajectoryInOrderMatchMetricValue + GoogleCloudAiplatformV1TrajectoryInOrderMatchMetricValue: + id: GoogleCloudAiplatformV1TrajectoryInOrderMatchMetricValue + description: TrajectoryInOrderMatch metric value for an instance. + type: object + properties: + score: + description: Output only. TrajectoryInOrderMatch score. + readOnly: true + type: number + format: float + GoogleCloudAiplatformV1TrajectoryAnyOrderMatchResults: + id: GoogleCloudAiplatformV1TrajectoryAnyOrderMatchResults + description: Results for TrajectoryAnyOrderMatch metric. + type: object + properties: + trajectoryAnyOrderMatchMetricValues: + description: Output only. TrajectoryAnyOrderMatch metric values. + readOnly: true + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TrajectoryAnyOrderMatchMetricValue + GoogleCloudAiplatformV1TrajectoryAnyOrderMatchMetricValue: + id: GoogleCloudAiplatformV1TrajectoryAnyOrderMatchMetricValue + description: TrajectoryAnyOrderMatch metric value for an instance. + type: object + properties: + score: + description: Output only. TrajectoryAnyOrderMatch score. + readOnly: true + type: number + format: float + GoogleCloudAiplatformV1TrajectoryPrecisionResults: + id: GoogleCloudAiplatformV1TrajectoryPrecisionResults + description: Results for TrajectoryPrecision metric. + type: object + properties: + trajectoryPrecisionMetricValues: + description: Output only. TrajectoryPrecision metric values. + readOnly: true + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TrajectoryPrecisionMetricValue + GoogleCloudAiplatformV1TrajectoryPrecisionMetricValue: + id: GoogleCloudAiplatformV1TrajectoryPrecisionMetricValue + description: TrajectoryPrecision metric value for an instance. + type: object + properties: + score: + description: Output only. TrajectoryPrecision score. + readOnly: true + type: number + format: float + GoogleCloudAiplatformV1TrajectoryRecallResults: + id: GoogleCloudAiplatformV1TrajectoryRecallResults + description: Results for TrajectoryRecall metric. + type: object + properties: + trajectoryRecallMetricValues: + description: Output only. TrajectoryRecall metric values. + readOnly: true + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TrajectoryRecallMetricValue + GoogleCloudAiplatformV1TrajectoryRecallMetricValue: + id: GoogleCloudAiplatformV1TrajectoryRecallMetricValue + description: TrajectoryRecall metric value for an instance. + type: object + properties: + score: + description: Output only. TrajectoryRecall score. + readOnly: true + type: number + format: float + GoogleCloudAiplatformV1TrajectorySingleToolUseResults: + id: GoogleCloudAiplatformV1TrajectorySingleToolUseResults + description: Results for TrajectorySingleToolUse metric. + type: object + properties: + trajectorySingleToolUseMetricValues: + description: Output only. TrajectorySingleToolUse metric values. + readOnly: true + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TrajectorySingleToolUseMetricValue + GoogleCloudAiplatformV1TrajectorySingleToolUseMetricValue: + id: GoogleCloudAiplatformV1TrajectorySingleToolUseMetricValue + description: TrajectorySingleToolUse metric value for an instance. + type: object + properties: + score: + description: Output only. TrajectorySingleToolUse score. + readOnly: true + type: number + format: float + GoogleCloudAiplatformV1RubricBasedInstructionFollowingResult: + id: GoogleCloudAiplatformV1RubricBasedInstructionFollowingResult + description: Result for RubricBasedInstructionFollowing metric. + type: object + properties: + score: + description: Output only. Overall score for the instruction following. + readOnly: true + type: number + format: float + rubricCritiqueResults: + description: Output only. List of per rubric critique results. + readOnly: true + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1RubricCritiqueResult' + GoogleCloudAiplatformV1RubricCritiqueResult: + id: GoogleCloudAiplatformV1RubricCritiqueResult + description: Rubric critique result. + type: object + properties: + rubric: + description: Output only. Rubric to be evaluated. + readOnly: true + type: string + verdict: + description: >- + Output only. Verdict for the rubric - true if the rubric is met, + false otherwise. + readOnly: true + type: boolean + GoogleCloudAiplatformV1MetricResult: + id: GoogleCloudAiplatformV1MetricResult + description: Result for a single metric on a single instance. + type: object + properties: + score: + description: >- + The score for the metric. Please refer to each metric's + documentation for the meaning of the score. + type: number + format: float + rubricVerdicts: + description: For rubric-based metrics, the verdicts for each rubric. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1RubricVerdict' + explanation: + description: The explanation for the metric result. + type: string + GoogleCloudAiplatformV1RubricVerdict: + id: GoogleCloudAiplatformV1RubricVerdict + description: Represents the verdict of an evaluation against a single rubric. + type: object + properties: + evaluatedRubric: + description: >- + Required. The full rubric definition that was evaluated. Storing + this ensures the verdict is self-contained and understandable, + especially if the original rubric definition changes or was + dynamically generated. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Rubric' + verdict: + description: >- + Required. Outcome of the evaluation against the rubric, represented + as a boolean. `true` indicates a "Pass", `false` indicates a "Fail". + type: boolean + reasoning: + description: >- + Optional. Human-readable reasoning or explanation for the verdict. + This can include specific examples or details from the evaluated + content that justify the given verdict. + type: string + GoogleCloudAiplatformV1EvaluateDatasetRequest: + id: GoogleCloudAiplatformV1EvaluateDatasetRequest + description: Request message for EvaluationService.EvaluateDataset. + type: object + properties: + dataset: + description: Required. The dataset used for evaluation. + $ref: '#/components/schemas/GoogleCloudAiplatformV1EvaluationDataset' + metrics: + description: Required. The metrics used for evaluation. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Metric' + outputConfig: + description: Required. Config for evaluation output. + $ref: '#/components/schemas/GoogleCloudAiplatformV1OutputConfig' + autoraterConfig: + description: >- + Optional. Autorater config used for evaluation. Currently only + publisher Gemini models are supported. Format: + `projects/{PROJECT}/locations/{LOCATION}/publishers/google/models/{MODEL}.` + $ref: '#/components/schemas/GoogleCloudAiplatformV1AutoraterConfig' + GoogleCloudAiplatformV1EvaluationDataset: + id: GoogleCloudAiplatformV1EvaluationDataset + description: The dataset used for evaluation. + type: object + properties: + gcsSource: + description: >- + Cloud storage source holds the dataset. Currently only one Cloud + Storage file path is supported. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' + bigquerySource: + description: BigQuery source holds the dataset. + $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQuerySource' + GoogleCloudAiplatformV1BigQuerySource: + id: GoogleCloudAiplatformV1BigQuerySource + description: The BigQuery location for the input content. + type: object + properties: + inputUri: + description: >- + Required. BigQuery URI to a table, up to 2000 characters long. + Accepted forms: * BigQuery path. For example: + `bq://projectId.bqDatasetId.bqTableId`. + type: string + GoogleCloudAiplatformV1OutputConfig: + id: GoogleCloudAiplatformV1OutputConfig + description: Config for evaluation output. + type: object + properties: + gcsDestination: + description: Cloud storage destination for evaluation output. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' + GoogleCloudAiplatformV1GenerateInstanceRubricsRequest: + id: GoogleCloudAiplatformV1GenerateInstanceRubricsRequest + description: Request message for EvaluationService.GenerateInstanceRubrics. + type: object + properties: + contents: + description: >- + Required. The prompt to generate rubrics from. For single-turn + queries, this is a single instance. For multi-turn queries, this is + a repeated field that contains conversation history + latest + request. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' + predefinedRubricGenerationSpec: + description: >- + Optional. Specification for using the rubric generation configs of a + pre-defined metric, e.g. "generic_quality_v1" and + "instruction_following_v1". Some of the configs may be only used in + rubric generation and not supporting evaluation, e.g. + "fully_customized_generic_quality_v1". If this field is set, the + `rubric_generation_spec` field will be ignored. + $ref: '#/components/schemas/GoogleCloudAiplatformV1PredefinedMetricSpec' + rubricGenerationSpec: + description: Optional. Specification for how the rubrics should be generated. + $ref: '#/components/schemas/GoogleCloudAiplatformV1RubricGenerationSpec' + GoogleCloudAiplatformV1RubricGenerationSpec: + id: GoogleCloudAiplatformV1RubricGenerationSpec + description: Specification for how rubrics should be generated. + type: object + properties: + promptTemplate: + description: >- + Template for the prompt used to generate rubrics. The details should + be updated based on the most-recent recipe requirements. + type: string + modelConfig: + description: >- + Configuration for the model used in rubric generation. Configs + including sampling count and base model can be specified here. + Flipping is not supported for rubric generation. + $ref: '#/components/schemas/GoogleCloudAiplatformV1AutoraterConfig' + rubricContentType: + description: The type of rubric content to be generated. + type: string + enumDescriptions: + - The content type to generate is not specified. + - Generate rubrics based on properties. + - Generate rubrics in an NL question answer format. + - Generate rubrics in a unit test format. + enum: + - RUBRIC_CONTENT_TYPE_UNSPECIFIED + - PROPERTY + - NL_QUESTION_ANSWER + - PYTHON_CODE_ASSERTION + rubricTypeOntology: + description: >- + Optional. An optional, pre-defined list of allowed types for + generated rubrics. If this field is provided, it implies + `include_rubric_type` should be true, and the generated rubric types + should be chosen from this ontology. + type: array + items: + type: string + GoogleCloudAiplatformV1GenerateInstanceRubricsResponse: + id: GoogleCloudAiplatformV1GenerateInstanceRubricsResponse + description: Response message for EvaluationService.GenerateInstanceRubrics. + type: object + properties: + generatedRubrics: + description: Output only. A list of generated rubrics. + readOnly: true + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Rubric' GoogleCloudAiplatformV1ReadFeatureValuesRequest: id: GoogleCloudAiplatformV1ReadFeatureValuesRequest description: Request message for FeaturestoreOnlineServingService.ReadFeatureValues. @@ -4382,10 +5996,10 @@ components: description: >- Feature generation timestamp. Typically, it is provided by user at feature ingestion time. If not, feature store will use the system - timestamp when the data is ingested into feature store. For - streaming ingestion, the time, aligned by days, must be no older - than five years (1825 days) and no later than one year (366 days) in - the future. + timestamp when the data is ingested into feature store. Legacy + Feature Store: For streaming ingestion, the time, aligned by days, + must be no older than five years (1825 days) and no later than one + year (366 days) in the future. type: string format: google-datetime GoogleCloudAiplatformV1FeatureValueList: @@ -4402,7 +6016,7 @@ components: id: GoogleCloudAiplatformV1StreamingReadFeatureValuesRequest description: >- Request message for - FeaturestoreOnlineServingService.StreamingFeatureValuesRead. + FeaturestoreOnlineServingService.StreamingReadFeatureValues. type: object properties: entityIds: @@ -5194,17 +6808,6 @@ components: gcsSource: description: Required. Google Cloud Storage location. $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' - GoogleCloudAiplatformV1BigQuerySource: - id: GoogleCloudAiplatformV1BigQuerySource - description: The BigQuery location for the input content. - type: object - properties: - inputUri: - description: >- - Required. BigQuery URI to a table, up to 2000 characters long. - Accepted forms: * BigQuery path. For example: - `bq://projectId.bqDatasetId.bqTableId`. - type: string GoogleCloudAiplatformV1CsvSource: id: GoogleCloudAiplatformV1CsvSource description: The storage details for CSV input content. @@ -5599,6 +7202,37 @@ components: description: description: Optional. Description of the FeatureGroup. type: string + serviceAgentType: + description: >- + Optional. Service agent type used during jobs under a FeatureGroup. + By default, the Vertex AI Service Agent is used. When using an IAM + Policy to isolate this FeatureGroup within a project, a separate + service account should be provisioned by setting this field to + `SERVICE_AGENT_TYPE_FEATURE_GROUP`. This will generate a separate + service account to access the BigQuery source table. + type: string + enumDescriptions: + - By default, the project-level Vertex AI Service Agent is enabled. + - >- + Specifies the project-level Vertex AI Service Agent + (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + - >- + Enable a FeatureGroup service account to be created by Vertex AI + and output in the field `service_account_email`. This service + account will be used to read from the source BigQuery table during + jobs under a FeatureGroup. + enum: + - SERVICE_AGENT_TYPE_UNSPECIFIED + - SERVICE_AGENT_TYPE_PROJECT + - SERVICE_AGENT_TYPE_FEATURE_GROUP + serviceAccountEmail: + description: >- + Output only. A Service Account unique to this FeatureGroup. The role + bigquery.dataViewer should be granted to this service account to + allow Vertex AI Feature Store to access source data while running + jobs under this FeatureGroup. + readOnly: true + type: string GoogleCloudAiplatformV1FeatureGroupBigQuery: id: GoogleCloudAiplatformV1FeatureGroupBigQuery description: Input source type for BigQuery Tables and Views. @@ -5932,6 +7566,37 @@ components: FeatureOnlineStore. $ref: >- #/components/schemas/GoogleCloudAiplatformV1FeatureViewOptimizedConfig + serviceAgentType: + description: >- + Optional. Service agent type used during data sync. By default, the + Vertex AI Service Agent is used. When using an IAM Policy to isolate + this FeatureView within a project, a separate service account should + be provisioned by setting this field to + `SERVICE_AGENT_TYPE_FEATURE_VIEW`. This will generate a separate + service account to access the BigQuery source table. + type: string + enumDescriptions: + - By default, the project-level Vertex AI Service Agent is enabled. + - >- + Indicates the project-level Vertex AI Service Agent + (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) + will be used during sync jobs. + - >- + Enable a FeatureView service account to be created by Vertex AI + and output in the field `service_account_email`. This service + account will be used to read from the source BigQuery table during + sync. + enum: + - SERVICE_AGENT_TYPE_UNSPECIFIED + - SERVICE_AGENT_TYPE_PROJECT + - SERVICE_AGENT_TYPE_FEATURE_VIEW + serviceAccountEmail: + description: >- + Output only. A Service Account unique to this FeatureView. The role + bigquery.dataViewer should be granted to this service account to + allow Vertex AI Feature Store to sync data to the online store. + readOnly: true + type: string satisfiesPzs: description: Output only. Reserved for future use. readOnly: true @@ -6541,6 +8206,86 @@ components: fields are populated. $ref: >- #/components/schemas/GoogleCloudAiplatformV1FetchFeatureValuesResponse + GoogleCloudAiplatformV1FeatureViewDirectWriteRequest: + id: GoogleCloudAiplatformV1FeatureViewDirectWriteRequest + description: Request message for FeatureOnlineStoreService.FeatureViewDirectWrite. + type: object + properties: + dataKeyAndFeatureValues: + description: Required. The data keys and associated feature values. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureViewDirectWriteRequestDataKeyAndFeatureValues + GoogleCloudAiplatformV1FeatureViewDirectWriteRequestDataKeyAndFeatureValues: + id: >- + GoogleCloudAiplatformV1FeatureViewDirectWriteRequestDataKeyAndFeatureValues + description: A data key and associated feature values to write to the feature view. + type: object + properties: + dataKey: + description: The data key. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewDataKey' + features: + description: List of features to write. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureViewDirectWriteRequestDataKeyAndFeatureValuesFeature + GoogleCloudAiplatformV1FeatureViewDirectWriteRequestDataKeyAndFeatureValuesFeature: + id: >- + GoogleCloudAiplatformV1FeatureViewDirectWriteRequestDataKeyAndFeatureValuesFeature + description: Feature name & value pair. + type: object + properties: + value: + description: >- + Feature value. A user provided timestamp may be set in the + `FeatureValue.metadata.generate_time` field. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValue' + name: + description: Feature short name. + type: string + GoogleCloudAiplatformV1FeatureViewDirectWriteResponse: + id: GoogleCloudAiplatformV1FeatureViewDirectWriteResponse + description: Response message for FeatureOnlineStoreService.FeatureViewDirectWrite. + type: object + properties: + status: + description: >- + Response status for the keys listed in + FeatureViewDirectWriteResponse.write_responses. The error only + applies to the listed data keys - the stream will remain open for + further FeatureOnlineStoreService.FeatureViewDirectWriteRequest + requests. Partial failures (e.g. if the first 10 keys of a request + fail, but the rest succeed) from a single request may result in + multiple responses - there will be one response for the successful + request keys and one response for the failing request keys. + $ref: '#/components/schemas/GoogleRpcStatus' + writeResponses: + description: >- + Details about write for each key. If status is not OK, + WriteResponse.data_key will have the key with error, but + WriteResponse.online_store_write_time will not be present. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureViewDirectWriteResponseWriteResponse + GoogleCloudAiplatformV1FeatureViewDirectWriteResponseWriteResponse: + id: GoogleCloudAiplatformV1FeatureViewDirectWriteResponseWriteResponse + description: Details about the write for each key. + type: object + properties: + dataKey: + description: What key is this write response associated with. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewDataKey' + onlineStoreWriteTime: + description: >- + When the feature values were written to the online store. If + FeatureViewDirectWriteResponse.status is not OK, this field is not + populated. + type: string + format: google-datetime GoogleCloudAiplatformV1CacheConfig: id: GoogleCloudAiplatformV1CacheConfig description: Config of GenAI caching features. This is a singleton resource. @@ -6556,1395 +8301,1579 @@ components: If set to true, disables GenAI caching. Otherwise caching is enabled. type: boolean - GoogleCloudAiplatformV1TuningJob: - id: GoogleCloudAiplatformV1TuningJob - description: Represents a TuningJob that runs with Google owned models. + GoogleCloudAiplatformV1CachedContent: + id: GoogleCloudAiplatformV1CachedContent + description: >- + A resource used in LLM queries for users to explicitly specify what to + cache and how to cache. type: object properties: - baseModel: - description: The base model that is being tuned, e.g., "gemini-1.0-pro-002". . - type: string - supervisedTuningSpec: - description: Tuning Spec for Supervised Fine Tuning. - $ref: '#/components/schemas/GoogleCloudAiplatformV1SupervisedTuningSpec' - name: + expireTime: description: >- - Output only. Identifier. Resource name of a TuningJob. Format: - `projects/{project}/locations/{location}/tuningJobs/{tuning_job}` - readOnly: true + Timestamp of when this resource is considered expired. This is + *always* provided on output, regardless of what was sent on input. type: string - tunedModelDisplayName: + format: google-datetime + ttl: description: >- - Optional. The display name of the TunedModel. The name can be up to - 128 characters long and can consist of any UTF-8 characters. - type: string - description: - description: Optional. The description of the TuningJob. + Input only. The TTL for this resource. The expiration time is + computed: now + TTL. type: string - state: - description: Output only. The detailed state of the job. - readOnly: true + format: google-duration + name: + description: >- + Immutable. Identifier. The server-generated resource name of the + cached content Format: + projects/{project}/locations/{location}/cachedContents/{cached_content} type: string - enumDescriptions: - - The job state is unspecified. - - >- - The job has been just created or resumed and processing has not - yet begun. - - The service is preparing to run the job. - - The job is in progress. - - The job completed successfully. - - The job failed. - - >- - The job is being cancelled. From this state the job may only go to - either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or - `JOB_STATE_CANCELLED`. - - The job has been cancelled. - - The job has been stopped, and can be resumed. - - The job has expired. - - >- - The job is being updated. Only jobs in the `RUNNING` state can be - updated. After updating, the job goes back to the `RUNNING` state. - - >- - The job is partially succeeded, some results may be missing due to - errors. - enum: - - JOB_STATE_UNSPECIFIED - - JOB_STATE_QUEUED - - JOB_STATE_PENDING - - JOB_STATE_RUNNING - - JOB_STATE_SUCCEEDED - - JOB_STATE_FAILED - - JOB_STATE_CANCELLING - - JOB_STATE_CANCELLED - - JOB_STATE_PAUSED - - JOB_STATE_EXPIRED - - JOB_STATE_UPDATING - - JOB_STATE_PARTIALLY_SUCCEEDED - createTime: - description: Output only. Time when the TuningJob was created. - readOnly: true + displayName: + description: >- + Optional. Immutable. The user-generated meaningful display name of + the cached content. type: string - format: google-datetime - startTime: + model: description: >- - Output only. Time when the TuningJob for the first time entered the - `JOB_STATE_RUNNING` state. - readOnly: true + Immutable. The name of the `Model` to use for cached content. + Currently, only the published Gemini base models are supported, in + form of + projects/{PROJECT}/locations/{LOCATION}/publishers/google/models/{MODEL} type: string - format: google-datetime - endTime: + systemInstruction: description: >- - Output only. Time when the TuningJob entered any of the following - JobStates: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, - `JOB_STATE_CANCELLED`, `JOB_STATE_EXPIRED`. + Optional. Input only. Immutable. Developer set system instruction. + Currently, text only + $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' + contents: + description: Optional. Input only. Immutable. The content to cache + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' + tools: + description: >- + Optional. Input only. Immutable. A list of `Tools` the model may use + to generate the next response + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tool' + toolConfig: + description: >- + Optional. Input only. Immutable. Tool config. This config is shared + for all tools + $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolConfig' + createTime: + description: Output only. Creation time of the cache entry. readOnly: true type: string format: google-datetime updateTime: - description: Output only. Time when the TuningJob was most recently updated. + description: Output only. When the cache entry was last updated in UTC time. readOnly: true type: string format: google-datetime - error: - description: >- - Output only. Only populated when job's state is `JOB_STATE_FAILED` - or `JOB_STATE_CANCELLED`. - readOnly: true - $ref: '#/components/schemas/GoogleRpcStatus' - labels: - description: >- - Optional. The labels with user-defined metadata to organize - TuningJob and generated resources such as Model and Endpoint. Label - keys and values can be no longer than 64 characters (Unicode - codepoints), can only contain lowercase letters, numeric characters, - underscores and dashes. International characters are allowed. See - https://goo.gl/xmQnxf for more information and examples of labels. - type: object - additionalProperties: - type: string - experiment: - description: Output only. The Experiment associated with this TuningJob. - readOnly: true - type: string - tunedModel: - description: >- - Output only. The tuned model resources assiociated with this - TuningJob. - readOnly: true - $ref: '#/components/schemas/GoogleCloudAiplatformV1TunedModel' - tuningDataStats: - description: >- - Output only. The tuning data statistics associated with this - TuningJob. + usageMetadata: + description: Output only. Metadata on the usage of the cached content. readOnly: true - $ref: '#/components/schemas/GoogleCloudAiplatformV1TuningDataStats' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1CachedContentUsageMetadata encryptionSpec: description: >- - Customer-managed encryption key options for a TuningJob. If this is - set, then all resources created by the TuningJob will be encrypted - with the provided encryption key. + Input only. Immutable. Customer-managed encryption key spec for a + `CachedContent`. If set, this `CachedContent` and all its + sub-resources will be secured by this key. $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' - GoogleCloudAiplatformV1SupervisedTuningSpec: - id: GoogleCloudAiplatformV1SupervisedTuningSpec - description: Tuning Spec for Supervised Tuning for first party models. + GoogleCloudAiplatformV1Tool: + id: GoogleCloudAiplatformV1Tool + description: >- + Tool details that the model may use to generate response. A `Tool` is a + piece of code that enables the system to interact with external systems + to perform an action, or set of actions, outside of knowledge and scope + of the model. A Tool object should contain exactly one type of Tool (e.g + FunctionDeclaration, Retrieval or GoogleSearchRetrieval). type: object properties: - trainingDatasetUri: + functionDeclarations: description: >- - Required. Cloud Storage path to file containing training dataset for - tuning. The dataset must be formatted as a JSONL file. - type: string - validationDatasetUri: + Optional. Function tool type. One or more function declarations to + be passed to the model along with the current user query. Model may + decide to call a subset of these functions by populating + FunctionCall in the response. User should provide a FunctionResponse + for each function call in the next turn. Based on the function + responses, Model will generate the final response back to the user. + Maximum 512 function declarations can be provided. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FunctionDeclaration' + retrieval: description: >- - Optional. Cloud Storage path to file containing validation dataset - for tuning. The dataset must be formatted as a JSONL file. - type: string - hyperParameters: - description: Optional. Hyperparameters for SFT. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SupervisedHyperParameters - GoogleCloudAiplatformV1SupervisedHyperParameters: - id: GoogleCloudAiplatformV1SupervisedHyperParameters - description: Hyperparameters for SFT. - type: object - properties: - epochCount: + Optional. Retrieval tool type. System will always execute the + provided retrieval tool(s) to get external knowledge to answer the + prompt. Retrieval results are presented to the model for generation. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Retrieval' + googleSearch: description: >- - Optional. Number of complete passes the model makes over the entire - training dataset during training. - type: string - format: int64 - learningRateMultiplier: - description: Optional. Multiplier for adjusting the default learning rate. - type: number - format: double - adapterSize: - description: Optional. Adapter size for tuning. - type: string - enumDescriptions: - - Adapter size is unspecified. - - Adapter size 1. - - Adapter size 4. - - Adapter size 8. - - Adapter size 16. - - Adapter size 32. - enum: - - ADAPTER_SIZE_UNSPECIFIED - - ADAPTER_SIZE_ONE - - ADAPTER_SIZE_FOUR - - ADAPTER_SIZE_EIGHT - - ADAPTER_SIZE_SIXTEEN - - ADAPTER_SIZE_THIRTY_TWO - GoogleCloudAiplatformV1TunedModel: - id: GoogleCloudAiplatformV1TunedModel + Optional. GoogleSearch tool type. Tool to support Google Search in + Model. Powered by Google. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolGoogleSearch' + googleSearchRetrieval: + description: >- + Optional. GoogleSearchRetrieval tool type. Specialized retrieval + tool that is powered by Google search. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GoogleSearchRetrieval' + googleMaps: + description: >- + Optional. GoogleMaps tool type. Tool to support Google Maps in + Model. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GoogleMaps' + enterpriseWebSearch: + description: >- + Optional. Tool to support searching public web data, powered by + Vertex AI Search and Sec4 compliance. + $ref: '#/components/schemas/GoogleCloudAiplatformV1EnterpriseWebSearch' + codeExecution: + description: >- + Optional. CodeExecution tool type. Enables the model to execute code + as part of generation. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolCodeExecution' + urlContext: + description: Optional. Tool to support URL context retrieval. + $ref: '#/components/schemas/GoogleCloudAiplatformV1UrlContext' + GoogleCloudAiplatformV1FunctionDeclaration: + id: GoogleCloudAiplatformV1FunctionDeclaration description: >- - The Model Registry Model and Online Prediction Endpoint assiociated with - this TuningJob. + Structured representation of a function declaration as defined by the + [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). + Included in this declaration are the function name, description, + parameters and response type. This FunctionDeclaration is a + representation of a block of code that can be used as a `Tool` by the + model and executed by the client. type: object properties: - model: + name: description: >- - Output only. The resource name of the TunedModel. Format: - `projects/{project}/locations/{location}/models/{model}`. - readOnly: true + Required. The name of the function to call. Must start with a letter + or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, + dots and dashes, with a maximum length of 64. type: string - endpoint: + description: description: >- - Output only. A resource name of an Endpoint. Format: - `projects/{project}/locations/{location}/endpoints/{endpoint}`. - readOnly: true + Optional. Description and purpose of the function. Model uses it to + decide how and whether to call the function. type: string - GoogleCloudAiplatformV1TuningDataStats: - id: GoogleCloudAiplatformV1TuningDataStats - description: The tuning data statistic values for TuningJob. + parameters: + description: >- + Optional. Describes the parameters to this function in JSON Schema + Object format. Reflects the Open API 3.03 Parameter Object. string + Key: the name of the parameter. Parameter names are case sensitive. + Schema Value: the Schema defining the type used for the parameter. + For function with no parameters, this can be left unset. Parameter + names must start with a letter or an underscore and must only + contain chars a-z, A-Z, 0-9, or underscores with a maximum length of + 64. Example with 1 required and 1 optional parameter: type: OBJECT + properties: param1: type: STRING param2: type: INTEGER required: - + param1 + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schema' + parametersJsonSchema: + description: >- + Optional. Describes the parameters to the function in JSON Schema + format. The schema must describe an object where the properties are + the parameters to the function. For example: ``` { "type": "object", + "properties": { "name": { "type": "string" }, "age": { "type": + "integer" } }, "additionalProperties": false, "required": ["name", + "age"], "propertyOrdering": ["name", "age"] } ``` This field is + mutually exclusive with `parameters`. + type: any + response: + description: >- + Optional. Describes the output from this function in JSON Schema + format. Reflects the Open API 3.03 Response Object. The Schema + defines the type used for the response value of the function. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schema' + responseJsonSchema: + description: >- + Optional. Describes the output from this function in JSON Schema + format. The value specified by the schema is the response value of + the function. This field is mutually exclusive with `response`. + type: any + GoogleCloudAiplatformV1Schema: + id: GoogleCloudAiplatformV1Schema + description: >- + Schema is used to define the format of input/output data. Represents a + select subset of an [OpenAPI 3.0 schema + object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields + may be added in the future as needed. type: object properties: - supervisedTuningDataStats: - description: The SFT Tuning data stats. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SupervisedTuningDataStats - GoogleCloudAiplatformV1SupervisedTuningDataStats: - id: GoogleCloudAiplatformV1SupervisedTuningDataStats - description: Tuning data statistics for Supervised Tuning. - type: object - properties: - tuningDatasetExampleCount: - description: Output only. Number of examples in the tuning dataset. - readOnly: true + type: + description: Optional. The type of the data. type: string - format: int64 - totalTuningCharacterCount: - description: Output only. Number of tuning characters in the tuning dataset. - readOnly: true + enumDescriptions: + - Not specified, should not be used. + - OpenAPI string type + - OpenAPI number type + - OpenAPI integer type + - OpenAPI boolean type + - OpenAPI array type + - OpenAPI object type + - Null type + enum: + - TYPE_UNSPECIFIED + - STRING + - NUMBER + - INTEGER + - BOOLEAN + - ARRAY + - OBJECT + - 'NULL' + format: + description: >- + Optional. The format of the data. Supported formats: for NUMBER + type: "float", "double" for INTEGER type: "int32", "int64" for + STRING type: "email", "byte", etc type: string - format: int64 - totalBillableCharacterCount: - description: Output only. Number of billable characters in the tuning dataset. - readOnly: true - deprecated: true + title: + description: Optional. The title of the Schema. type: string - format: int64 - totalBillableTokenCount: - description: Output only. Number of billable tokens in the tuning dataset. - readOnly: true + description: + description: Optional. The description of the data. + type: string + nullable: + description: Optional. Indicates if the value may be null. + type: boolean + default: + description: Optional. Default value of the data. + type: any + items: + description: >- + Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of + Type.ARRAY. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schema' + minItems: + description: Optional. Minimum number of the elements for Type.ARRAY. type: string format: int64 - tuningStepCount: - description: Output only. Number of tuning steps for this Tuning Job. - readOnly: true + maxItems: + description: Optional. Maximum number of the elements for Type.ARRAY. type: string format: int64 - userInputTokenDistribution: - description: Output only. Dataset distributions for the user input tokens. - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution - userOutputTokenDistribution: - description: Output only. Dataset distributions for the user output tokens. - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution - userMessagePerExampleDistribution: - description: Output only. Dataset distributions for the messages per example. - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution - userDatasetExamples: - description: Output only. Sample user messages in the training dataset uri. - readOnly: true + enum: + description: >- + Optional. Possible values of the element of primitive type with enum + format. Examples: 1. We can define direction as : {type:STRING, + format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can + define apartment number as : {type:INTEGER, format:enum, + enum:["101", "201", "301"]} type: array items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' - totalTruncatedExampleCount: - description: >- - The number of examples in the dataset that have been truncated by - any amount. - type: string - format: int64 - truncatedExampleIndices: + type: string + properties: + description: Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schema' + propertyOrdering: description: >- - A partial sample of the indices (starting from 1) of the truncated - examples. + Optional. The order of the properties. Not a standard field in open + api spec. Only used to support the order of the properties. type: array items: type: string - format: int64 - GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution: - id: GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution - description: Dataset distribution for Supervised Tuning. - type: object - properties: - sum: - description: Output only. Sum of a given population of values. - readOnly: true + required: + description: Optional. Required properties of Type.OBJECT. + type: array + items: + type: string + minProperties: + description: Optional. Minimum number of the properties for Type.OBJECT. type: string format: int64 - billableSum: - description: Output only. Sum of a given population of values that are billable. - readOnly: true + maxProperties: + description: Optional. Maximum number of the properties for Type.OBJECT. type: string format: int64 - min: - description: Output only. The minimum of the population values. - readOnly: true - type: number - format: double - max: - description: Output only. The maximum of the population values. - readOnly: true - type: number - format: double - mean: - description: Output only. The arithmetic mean of the values in the population. - readOnly: true - type: number - format: double - median: - description: Output only. The median of the values in the population. - readOnly: true - type: number - format: double - p5: - description: Output only. The 5th percentile of the values in the population. - readOnly: true + minimum: + description: >- + Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of + the Type.INTEGER and Type.NUMBER type: number format: double - p95: - description: Output only. The 95th percentile of the values in the population. - readOnly: true + maximum: + description: Optional. Maximum value of the Type.INTEGER and Type.NUMBER type: number format: double - buckets: - description: Output only. Defines the histogram bucket. - readOnly: true + minLength: + description: >- + Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the + Type.STRING + type: string + format: int64 + maxLength: + description: Optional. Maximum length of the Type.STRING + type: string + format: int64 + pattern: + description: >- + Optional. Pattern of the Type.STRING to restrict a string to a + regular expression. + type: string + example: + description: >- + Optional. Example of the object. Will only populated when the object + is the root. + type: any + anyOf: + description: >- + Optional. The value should be validated against any (one or more) of + the subschemas in the list. type: array items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SupervisedTuningDatasetDistributionDatasetBucket - GoogleCloudAiplatformV1SupervisedTuningDatasetDistributionDatasetBucket: - id: GoogleCloudAiplatformV1SupervisedTuningDatasetDistributionDatasetBucket + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schema' + additionalProperties: + description: >- + Optional. Can either be a boolean or an object; controls the + presence of additional properties. + type: any + ref: + description: >- + Optional. Allows indirect references between schema nodes. The value + should be a valid reference to a child of the root `defs`. For + example, the following schema defines a reference to a schema node + named "Pet": type: object properties: pet: ref: #/defs/Pet defs: + Pet: type: object properties: name: type: string The value of the + "pet" property is a reference to the schema node named "Pet". See + details in + https://json-schema.org/understanding-json-schema/structuring + type: string + defs: + description: >- + Optional. A map of definitions for use by `ref` Only allowed at the + root of the schema. + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schema' + GoogleCloudAiplatformV1Retrieval: + id: GoogleCloudAiplatformV1Retrieval description: >- - Dataset bucket used to create a histogram for the distribution given a - population of values. + Defines a retrieval tool that model can call to access external + knowledge. type: object properties: - count: - description: Output only. Number of values in the bucket. - readOnly: true - type: number - format: double - left: - description: Output only. Left bound of the bucket. - readOnly: true - type: number - format: double - right: - description: Output only. Right bound of the bucket. - readOnly: true - type: number - format: double - GoogleCloudAiplatformV1Content: - id: GoogleCloudAiplatformV1Content + vertexAiSearch: + description: Set to use data source powered by Vertex AI Search. + $ref: '#/components/schemas/GoogleCloudAiplatformV1VertexAISearch' + vertexRagStore: + description: >- + Set to use data source powered by Vertex RAG store. User data is + uploaded via the VertexRagDataService. + $ref: '#/components/schemas/GoogleCloudAiplatformV1VertexRagStore' + externalApi: + description: Use data source powered by external API for grounding. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExternalApi' + disableAttribution: + description: Optional. Deprecated. This option is no longer supported. + deprecated: true + type: boolean + GoogleCloudAiplatformV1VertexAISearch: + id: GoogleCloudAiplatformV1VertexAISearch description: >- - The base structured datatype containing multi-part content of a message. - A `Content` includes a `role` field designating the producer of the - `Content` and a `parts` field containing multi-part data that contains - the content of the message turn. + Retrieve from Vertex AI Search datastore or engine for grounding. + datastore and engine are mutually exclusive. See + https://cloud.google.com/products/agent-builder type: object properties: - role: + datastore: description: >- - Optional. The producer of the content. Must be either 'user' or - 'model'. Useful to set for multi-turn conversations, otherwise can - be left blank or unset. + Optional. Fully-qualified Vertex AI Search data store resource ID. + Format: + `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` type: string - parts: + engine: description: >- - Required. Ordered `Parts` that constitute a single message. Parts - may have different IANA MIME types. + Optional. Fully-qualified Vertex AI Search engine resource ID. + Format: + `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + type: string + maxResults: + description: >- + Optional. Number of search results to return per query. The default + value is 10. The maximumm allowed value is 10. + type: integer + format: int32 + filter: + description: Optional. Filter strings to be passed to the search API. + type: string + dataStoreSpecs: + description: >- + Specifications that define the specific DataStores to be searched, + along with configurations for those data stores. This is only + considered for Engines with multiple data stores. It should only be + set if engine is used. type: array items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Part' - GoogleCloudAiplatformV1Part: - id: GoogleCloudAiplatformV1Part + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1VertexAISearchDataStoreSpec + GoogleCloudAiplatformV1VertexAISearchDataStoreSpec: + id: GoogleCloudAiplatformV1VertexAISearchDataStoreSpec description: >- - A datatype containing media that is part of a multi-part `Content` - message. A `Part` consists of data which has an associated datatype. A - `Part` can only contain one of the accepted types in `Part.data`. A - `Part` must have a fixed IANA MIME type identifying the type and subtype - of the media if `inline_data` or `file_data` field is filled with raw - bytes. + Define data stores within engine to filter on in a search call and + configurations for those data stores. For more information, see + https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec type: object properties: - text: - description: Optional. Text part (can be code). + dataStore: + description: >- + Full resource name of DataStore, such as Format: + `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` type: string - inlineData: - description: Optional. Inlined bytes data. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Blob' - fileData: - description: Optional. URI based data. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FileData' - functionCall: + filter: description: >- - Optional. A predicted [FunctionCall] returned from the model that - contains a string representing the [FunctionDeclaration.name] with - the parameters and their values. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FunctionCall' - functionResponse: + Optional. Filter specification to filter documents in the data store + specified by data_store field. For more information on filtering, + see + [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + type: string + GoogleCloudAiplatformV1VertexRagStore: + id: GoogleCloudAiplatformV1VertexRagStore + description: Retrieve from Vertex RAG Store for grounding. + type: object + properties: + ragResources: description: >- - Optional. The result output of a [FunctionCall] that contains a - string representing the [FunctionDeclaration.name] and a structured - JSON object containing any output from the function call. It is used - as context to the model. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FunctionResponse' - videoMetadata: + Optional. The representation of the rag source. It can be used to + specify corpus only or ragfiles. Currently only support one corpus + or multiple files from one corpus. In the future we may open up + multiple corpora support. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1VertexRagStoreRagResource + similarityTopK: description: >- - Optional. Video metadata. The metadata should only be specified - while the video data is presented in inline_data or file_data. - $ref: '#/components/schemas/GoogleCloudAiplatformV1VideoMetadata' - GoogleCloudAiplatformV1Blob: - id: GoogleCloudAiplatformV1Blob - description: >- - Content blob. It's preferred to send as text directly rather than raw - bytes. + Optional. Number of top k results to return from the selected + corpora. + deprecated: true + type: integer + format: int32 + vectorDistanceThreshold: + description: >- + Optional. Only return results with vector distance smaller than the + threshold. + deprecated: true + type: number + format: double + ragRetrievalConfig: + description: Optional. The retrieval config for the Rag query. + $ref: '#/components/schemas/GoogleCloudAiplatformV1RagRetrievalConfig' + GoogleCloudAiplatformV1VertexRagStoreRagResource: + id: GoogleCloudAiplatformV1VertexRagStoreRagResource + description: The definition of the Rag resource. type: object properties: - mimeType: - description: Required. The IANA standard MIME type of the source data. - type: string - data: - description: Required. Raw bytes. + ragCorpus: + description: >- + Optional. RagCorpora resource name. Format: + `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` type: string - format: byte - GoogleCloudAiplatformV1FileData: - id: GoogleCloudAiplatformV1FileData - description: URI based data. + ragFileIds: + description: >- + Optional. rag_file_id. The files should be in the same rag_corpus + set in rag_corpus field. + type: array + items: + type: string + GoogleCloudAiplatformV1RagRetrievalConfig: + id: GoogleCloudAiplatformV1RagRetrievalConfig + description: Specifies the context retrieval config. type: object properties: - mimeType: - description: Required. The IANA standard MIME type of the source data. - type: string - fileUri: - description: Required. URI. + topK: + description: Optional. The number of contexts to retrieve. + type: integer + format: int32 + filter: + description: Optional. Config for filters. + $ref: '#/components/schemas/GoogleCloudAiplatformV1RagRetrievalConfigFilter' + ranking: + description: Optional. Config for ranking and reranking. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1RagRetrievalConfigRanking + GoogleCloudAiplatformV1RagRetrievalConfigFilter: + id: GoogleCloudAiplatformV1RagRetrievalConfigFilter + description: Config for filters. + type: object + properties: + vectorDistanceThreshold: + description: >- + Optional. Only returns contexts with vector distance smaller than + the threshold. + type: number + format: double + vectorSimilarityThreshold: + description: >- + Optional. Only returns contexts with vector similarity larger than + the threshold. + type: number + format: double + metadataFilter: + description: Optional. String for metadata filtering. type: string - GoogleCloudAiplatformV1FunctionCall: - id: GoogleCloudAiplatformV1FunctionCall - description: >- - A predicted [FunctionCall] returned from the model that contains a - string representing the [FunctionDeclaration.name] and a structured JSON - object containing the parameters and their values. + GoogleCloudAiplatformV1RagRetrievalConfigRanking: + id: GoogleCloudAiplatformV1RagRetrievalConfigRanking + description: Config for ranking and reranking. type: object properties: - name: + rankService: + description: Optional. Config for Rank Service. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1RagRetrievalConfigRankingRankService + llmRanker: + description: Optional. Config for LlmRanker. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1RagRetrievalConfigRankingLlmRanker + GoogleCloudAiplatformV1RagRetrievalConfigRankingRankService: + id: GoogleCloudAiplatformV1RagRetrievalConfigRankingRankService + description: Config for Rank Service. + type: object + properties: + modelName: description: >- - Required. The name of the function to call. Matches - [FunctionDeclaration.name]. + Optional. The model name of the rank service. Format: + `semantic-ranker-512@latest` type: string - args: + GoogleCloudAiplatformV1RagRetrievalConfigRankingLlmRanker: + id: GoogleCloudAiplatformV1RagRetrievalConfigRankingLlmRanker + description: Config for LlmRanker. + type: object + properties: + modelName: description: >- - Optional. Required. The function parameters and values in JSON - object format. See [FunctionDeclaration.parameters] for parameter - details. - type: object - additionalProperties: - type: any - description: Properties of the object. - GoogleCloudAiplatformV1FunctionResponse: - id: GoogleCloudAiplatformV1FunctionResponse + Optional. The model name used for ranking. See [Supported + models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + type: string + GoogleCloudAiplatformV1ExternalApi: + id: GoogleCloudAiplatformV1ExternalApi description: >- - The result output from a [FunctionCall] that contains a string - representing the [FunctionDeclaration.name] and a structured JSON object - containing any output from the function is used as context to the model. - This should contain the result of a [FunctionCall] made based on model - prediction. + Retrieve from data source powered by external API for grounding. The + external API is not owned by Google, but need to follow the pre-defined + API spec. type: object properties: - name: + simpleSearchParams: + description: Parameters for the simple search API. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ExternalApiSimpleSearchParams + elasticSearchParams: + description: Parameters for the elastic search API. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ExternalApiElasticSearchParams + apiSpec: + description: The API spec that the external API implements. + type: string + enumDescriptions: + - Unspecified API spec. This value should not be used. + - Simple search API spec. + - Elastic search API spec. + enum: + - API_SPEC_UNSPECIFIED + - SIMPLE_SEARCH + - ELASTIC_SEARCH + endpoint: description: >- - Required. The name of the function to call. Matches - [FunctionDeclaration.name] and [FunctionCall.name]. + The endpoint of the external API. The system will call the API at + this endpoint to retrieve the data for grounding. Example: + https://acme.com:443/search type: string - response: + apiAuth: description: >- - Required. The function response in JSON object format. Use "output" - key to specify function output and "error" key to specify error - details (if any). If "output" and "error" keys are not specified, - then whole "response" is treated as function output. - type: object - additionalProperties: - type: any - description: Properties of the object. - GoogleCloudAiplatformV1VideoMetadata: - id: GoogleCloudAiplatformV1VideoMetadata - description: Metadata describes the input video content. + The authentication config to access the API. Deprecated. Please use + auth_config instead. + deprecated: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1ApiAuth' + authConfig: + description: The authentication config to access the API. + $ref: '#/components/schemas/GoogleCloudAiplatformV1AuthConfig' + GoogleCloudAiplatformV1ExternalApiSimpleSearchParams: + id: GoogleCloudAiplatformV1ExternalApiSimpleSearchParams + description: The search parameters to use for SIMPLE_SEARCH spec. + type: object + properties: {} + GoogleCloudAiplatformV1ExternalApiElasticSearchParams: + id: GoogleCloudAiplatformV1ExternalApiElasticSearchParams + description: The search parameters to use for the ELASTIC_SEARCH spec. type: object properties: - startOffset: - description: Optional. The start offset of the video. + index: + description: The ElasticSearch index to use. type: string - format: google-duration - endOffset: - description: Optional. The end offset of the video. + searchTemplate: + description: The ElasticSearch search template to use. type: string - format: google-duration - GoogleCloudAiplatformV1ListTuningJobsResponse: - id: GoogleCloudAiplatformV1ListTuningJobsResponse - description: Response message for GenAiTuningService.ListTuningJobs + numHits: + description: >- + Optional. Number of hits (chunks) to request. When specified, it is + passed to Elasticsearch as the `num_hits` param. + type: integer + format: int32 + GoogleCloudAiplatformV1ApiAuth: + id: GoogleCloudAiplatformV1ApiAuth + description: >- + The generic reusable api auth config. Deprecated. Please use AuthConfig + (google/cloud/aiplatform/master/auth.proto) instead. type: object properties: - tuningJobs: - description: List of TuningJobs in the requested page. - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TuningJob' - nextPageToken: + apiKeyConfig: + description: The API secret. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ApiAuthApiKeyConfig' + GoogleCloudAiplatformV1ApiAuthApiKeyConfig: + id: GoogleCloudAiplatformV1ApiAuthApiKeyConfig + description: The API secret. + type: object + properties: + apiKeySecretVersion: description: >- - A token to retrieve the next page of results. Pass to - ListTuningJobsRequest.page_token to obtain that page. + Required. The SecretManager secret version resource name storing API + key. e.g. projects/{project}/secrets/{secret}/versions/{version} type: string - GoogleCloudAiplatformV1CancelTuningJobRequest: - id: GoogleCloudAiplatformV1CancelTuningJobRequest - description: Request message for GenAiTuningService.CancelTuningJob. + apiKeyString: + description: >- + The API key string. Either this or `api_key_secret_version` must be + set. + type: string + GoogleCloudAiplatformV1AuthConfig: + id: GoogleCloudAiplatformV1AuthConfig + description: Auth configuration to run the extension. type: object - properties: {} - GoogleCloudAiplatformV1RebaseTunedModelRequest: - id: GoogleCloudAiplatformV1RebaseTunedModelRequest - description: Request message for GenAiTuningService.RebaseTunedModel. + properties: + apiKeyConfig: + description: Config for API key auth. + $ref: '#/components/schemas/GoogleCloudAiplatformV1AuthConfigApiKeyConfig' + httpBasicAuthConfig: + description: Config for HTTP Basic auth. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1AuthConfigHttpBasicAuthConfig + googleServiceAccountConfig: + description: Config for Google Service Account auth. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1AuthConfigGoogleServiceAccountConfig + oauthConfig: + description: Config for user oauth. + $ref: '#/components/schemas/GoogleCloudAiplatformV1AuthConfigOauthConfig' + oidcConfig: + description: Config for user OIDC auth. + $ref: '#/components/schemas/GoogleCloudAiplatformV1AuthConfigOidcConfig' + authType: + description: Type of auth scheme. + type: string + enumDescriptions: + - '' + - No Auth. + - API Key Auth. + - HTTP Basic Auth. + - Google Service Account Auth. + - OAuth auth. + - OpenID Connect (OIDC) Auth. + enum: + - AUTH_TYPE_UNSPECIFIED + - NO_AUTH + - API_KEY_AUTH + - HTTP_BASIC_AUTH + - GOOGLE_SERVICE_ACCOUNT_AUTH + - OAUTH + - OIDC_AUTH + GoogleCloudAiplatformV1AuthConfigApiKeyConfig: + id: GoogleCloudAiplatformV1AuthConfigApiKeyConfig + description: Config for authentication with API key. type: object properties: - tunedModelRef: + name: description: >- - Required. TunedModel reference to retrieve the legacy model - information. - $ref: '#/components/schemas/GoogleCloudAiplatformV1TunedModelRef' - tuningJob: + Optional. The parameter name of the API key. E.g. If the API request + is "https://example.com/act?api_key=", "api_key" would be the + parameter name. + type: string + apiKeySecret: description: >- - Optional. The TuningJob to be updated. Users can use this TuningJob - field to overwrite tuning configs. - $ref: '#/components/schemas/GoogleCloudAiplatformV1TuningJob' - artifactDestination: - description: Optional. The Google Cloud Storage location to write the artifacts. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' - deployToSameEndpoint: + Optional. The name of the SecretManager secret version resource + storing the API key. Format: + `projects/{project}/secrets/{secrete}/versions/{version}` - If both + `api_key_secret` and `api_key_string` are specified, this field + takes precedence over `api_key_string`. - If specified, the + `secretmanager.versions.access` permission should be granted to + Vertex AI Extension Service Agent + (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) + on the specified resource. + type: string + apiKeyString: + description: Optional. The API key to be used in the request directly. + type: string + httpElementLocation: + description: Optional. The location of the API key. + type: string + enumDescriptions: + - '' + - Element is in the HTTP request query. + - Element is in the HTTP request header. + - Element is in the HTTP request path. + - Element is in the HTTP request body. + - Element is in the HTTP request cookie. + enum: + - HTTP_IN_UNSPECIFIED + - HTTP_IN_QUERY + - HTTP_IN_HEADER + - HTTP_IN_PATH + - HTTP_IN_BODY + - HTTP_IN_COOKIE + GoogleCloudAiplatformV1AuthConfigHttpBasicAuthConfig: + id: GoogleCloudAiplatformV1AuthConfigHttpBasicAuthConfig + description: Config for HTTP Basic Authentication. + type: object + properties: + credentialSecret: description: >- - Optional. By default, bison to gemini migration will always create - new model/endpoint, but for gemini-1.0 to gemini-1.5 migration, we - default deploy to the same endpoint. See details in this Section. - type: boolean - GoogleCloudAiplatformV1TunedModelRef: - id: GoogleCloudAiplatformV1TunedModelRef - description: TunedModel Reference for legacy model migration. + Required. The name of the SecretManager secret version resource + storing the base64 encoded credentials. Format: + `projects/{project}/secrets/{secrete}/versions/{version}` - If + specified, the `secretmanager.versions.access` permission should be + granted to Vertex AI Extension Service Agent + (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) + on the specified resource. + type: string + GoogleCloudAiplatformV1AuthConfigGoogleServiceAccountConfig: + id: GoogleCloudAiplatformV1AuthConfigGoogleServiceAccountConfig + description: Config for Google Service Account Authentication. type: object properties: - tunedModel: - description: Support migration from model registry. + serviceAccount: + description: >- + Optional. The service account that the extension execution service + runs as. - If the service account is specified, the + `iam.serviceAccounts.getAccessToken` permission should be granted to + Vertex AI Extension Service Agent + (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) + on the specified service account. - If not specified, the Vertex AI + Extension Service Agent will be used to execute the Extension. type: string - tuningJob: + GoogleCloudAiplatformV1AuthConfigOauthConfig: + id: GoogleCloudAiplatformV1AuthConfigOauthConfig + description: Config for user oauth. + type: object + properties: + accessToken: description: >- - Support migration from tuning job list page, from gemini-1.0-pro-002 - to 1.5 and above. + Access token for extension endpoint. Only used to propagate token + from [[ExecuteExtensionRequest.runtime_auth_config]] at request + time. type: string - pipelineJob: + serviceAccount: description: >- - Support migration from tuning job list page, from bison model to - gemini model. + The service account used to generate access tokens for executing the + Extension. - If the service account is specified, the + `iam.serviceAccounts.getAccessToken` permission should be granted to + Vertex AI Extension Service Agent + (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) + on the provided service account. type: string - GoogleCloudAiplatformV1Index: - id: GoogleCloudAiplatformV1Index - description: >- - A representation of a collection of database items organized in a way - that allows for approximate nearest neighbor (a.k.a ANN) algorithms - search. + GoogleCloudAiplatformV1AuthConfigOidcConfig: + id: GoogleCloudAiplatformV1AuthConfigOidcConfig + description: Config for user OIDC auth. type: object properties: - name: - description: Output only. The resource name of the Index. - readOnly: true - type: string - displayName: + idToken: description: >- - Required. The display name of the Index. The name can be up to 128 - characters long and can consist of any UTF-8 characters. - type: string - description: - description: The description of the Index. + OpenID Connect formatted ID token for extension endpoint. Only used + to propagate token from + [[ExecuteExtensionRequest.runtime_auth_config]] at request time. type: string - metadataSchemaUri: + serviceAccount: description: >- - Immutable. Points to a YAML file stored on Google Cloud Storage - describing additional information about the Index, that is specific - to it. Unset if the Index does not have any additional information. - The schema is defined as an OpenAPI 3.0.2 [Schema - Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). - Note: The URI given on output will be immutable and probably - different, including the URI scheme, than the one given on input. - The output URI will point to a location where the user only has a - read access. + The service account used to generate an OpenID Connect + (OIDC)-compatible JWT token signed by the Google OIDC Provider + (accounts.google.com) for extension endpoint + (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). + - The audience for the token will be set to the URL in the server + url defined in the OpenApi spec. - If the service account is + provided, the service account should grant + `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI + Extension Service Agent + (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). type: string - metadata: - description: >- - An additional information about the Index; the schema of the - metadata can be found in metadata_schema. - type: any - deployedIndexes: + GoogleCloudAiplatformV1ToolGoogleSearch: + id: GoogleCloudAiplatformV1ToolGoogleSearch + description: >- + GoogleSearch tool type. Tool to support Google Search in Model. Powered + by Google. + type: object + properties: + excludeDomains: description: >- - Output only. The pointers to DeployedIndexes created from this - Index. An Index can be only deleted if all its DeployedIndexes had - been undeployed first. - readOnly: true + Optional. List of domains to be excluded from the search results. + The default limit is 2000 domains. Example: ["amazon.com", + "facebook.com"]. type: array items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndexRef' - etag: - description: >- - Used to perform consistent read-modify-write updates. If not set, a - blind "overwrite" update happens. - type: string - labels: - description: >- - The labels with user-defined metadata to organize your Indexes. - Label keys and values can be no longer than 64 characters (Unicode - codepoints), can only contain lowercase letters, numeric characters, - underscores and dashes. International characters are allowed. See - https://goo.gl/xmQnxf for more information and examples of labels. - type: object - additionalProperties: type: string - createTime: - description: Output only. Timestamp when this Index was created. - readOnly: true - type: string - format: google-datetime - updateTime: - description: >- - Output only. Timestamp when this Index was most recently updated. - This also includes any update to the contents of the Index. Note - that Operations working on this Index may have their - Operations.metadata.generic_metadata.update_time a little after the - value of this timestamp, yet that does not mean their results are - not already reflected in the Index. Result of any successfully - completed Operation on the Index is reflected in it. - readOnly: true - type: string - format: google-datetime - indexStats: - description: Output only. Stats of the index resource. - readOnly: true - $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexStats' - indexUpdateMethod: - description: >- - Immutable. The update method to use with this Index. If not set, - BATCH_UPDATE will be used by default. - type: string - enumDescriptions: - - Should not be used. - - >- - BatchUpdate: user can call UpdateIndex with files on Cloud Storage - of Datapoints to update. - - >- - StreamUpdate: user can call UpsertDatapoints/DeleteDatapoints to - update the Index and the updates will be applied in corresponding - DeployedIndexes in nearly real-time. - enum: - - INDEX_UPDATE_METHOD_UNSPECIFIED - - BATCH_UPDATE - - STREAM_UPDATE - encryptionSpec: - description: >- - Immutable. Customer-managed encryption key spec for an Index. If - set, this Index and all sub-resources of this Index will be secured - by this key. - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' - satisfiesPzs: - description: Output only. Reserved for future use. - readOnly: true - type: boolean - satisfiesPzi: - description: Output only. Reserved for future use. - readOnly: true - type: boolean - GoogleCloudAiplatformV1DeployedIndexRef: - id: GoogleCloudAiplatformV1DeployedIndexRef - description: Points to a DeployedIndex. + GoogleCloudAiplatformV1GoogleSearchRetrieval: + id: GoogleCloudAiplatformV1GoogleSearchRetrieval + description: Tool to retrieve public web data for grounding, powered by Google. type: object properties: - indexEndpoint: - description: Immutable. A resource name of the IndexEndpoint. - type: string - deployedIndexId: - description: Immutable. The ID of the DeployedIndex in the above IndexEndpoint. - type: string - displayName: - description: Output only. The display name of the DeployedIndex. - readOnly: true - type: string - GoogleCloudAiplatformV1IndexStats: - id: GoogleCloudAiplatformV1IndexStats - description: Stats of the Index. + dynamicRetrievalConfig: + description: Specifies the dynamic retrieval configuration for the given source. + $ref: '#/components/schemas/GoogleCloudAiplatformV1DynamicRetrievalConfig' + GoogleCloudAiplatformV1DynamicRetrievalConfig: + id: GoogleCloudAiplatformV1DynamicRetrievalConfig + description: Describes the options to customize dynamic retrieval. type: object properties: - vectorsCount: - description: Output only. The number of dense vectors in the Index. - readOnly: true - type: string - format: int64 - sparseVectorsCount: - description: Output only. The number of sparse vectors in the Index. - readOnly: true + mode: + description: The mode of the predictor to be used in dynamic retrieval. type: string - format: int64 - shardsCount: - description: Output only. The number of shards in the Index. - readOnly: true - type: integer - format: int32 - GoogleCloudAiplatformV1ListIndexesResponse: - id: GoogleCloudAiplatformV1ListIndexesResponse - description: Response message for IndexService.ListIndexes. - type: object - properties: - indexes: - description: List of indexes in the requested page. - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Index' - nextPageToken: + enumDescriptions: + - Always trigger retrieval. + - Run retrieval only when system decides it is necessary. + enum: + - MODE_UNSPECIFIED + - MODE_DYNAMIC + dynamicThreshold: description: >- - A token to retrieve next page of results. Pass to - ListIndexesRequest.page_token to obtain that page. - type: string - GoogleCloudAiplatformV1UpsertDatapointsRequest: - id: GoogleCloudAiplatformV1UpsertDatapointsRequest - description: Request message for IndexService.UpsertDatapoints + Optional. The threshold to be used in dynamic retrieval. If not set, + a system default value is used. + type: number + format: float + GoogleCloudAiplatformV1GoogleMaps: + id: GoogleCloudAiplatformV1GoogleMaps + description: Tool to retrieve public maps data for grounding, powered by Google. type: object - properties: - datapoints: - description: A list of datapoints to be created/updated. - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexDatapoint' - updateMask: - description: >- - Optional. Update mask is used to specify the fields to be - overwritten in the datapoints by the update. The fields specified in - the update_mask are relative to each IndexDatapoint inside - datapoints, not the full request. Updatable fields: * Use - `all_restricts` to update both restricts and numeric_restricts. - type: string - format: google-fieldmask - GoogleCloudAiplatformV1IndexDatapoint: - id: GoogleCloudAiplatformV1IndexDatapoint - description: A datapoint of Index. + properties: {} + GoogleCloudAiplatformV1EnterpriseWebSearch: + id: GoogleCloudAiplatformV1EnterpriseWebSearch + description: >- + Tool to search public web data, powered by Vertex AI Search and Sec4 + compliance. type: object properties: - datapointId: - description: Required. Unique identifier of the datapoint. - type: string - featureVector: - description: >- - Required. Feature embedding vector for dense index. An array of - numbers with the length of [NearestNeighborSearchConfig.dimensions]. - type: array - items: - type: number - format: float - sparseEmbedding: - description: Optional. Feature embedding vector for sparse index. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1IndexDatapointSparseEmbedding - restricts: - description: >- - Optional. List of Restrict of the datapoint, used to perform - "restricted searches" where boolean rule are used to filter the - subset of the database eligible for matching. This uses categorical - tokens. See: - https://cloud.google.com/vertex-ai/docs/matching-engine/filtering - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1IndexDatapointRestriction - numericRestricts: + excludeDomains: description: >- - Optional. List of Restrict of the datapoint, used to perform - "restricted searches" where boolean rule are used to filter the - subset of the database eligible for matching. This uses numeric - comparisons. + Optional. List of domains to be excluded from the search results. + The default limit is 2000 domains. type: array items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1IndexDatapointNumericRestriction - crowdingTag: - description: >- - Optional. CrowdingTag of the datapoint, the number of neighbors to - return in each crowding can be configured during query. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1IndexDatapointCrowdingTag - GoogleCloudAiplatformV1IndexDatapointSparseEmbedding: - id: GoogleCloudAiplatformV1IndexDatapointSparseEmbedding + type: string + GoogleCloudAiplatformV1ToolCodeExecution: + id: GoogleCloudAiplatformV1ToolCodeExecution description: >- - Feature embedding vector for sparse index. An array of numbers whose - values are located in the specified dimensions. + Tool that executes code generated by the model, and automatically + returns the result to the model. See also [ExecutableCode]and + [CodeExecutionResult] which are input and output to this tool. + type: object + properties: {} + GoogleCloudAiplatformV1UrlContext: + id: GoogleCloudAiplatformV1UrlContext + description: Tool to support URL context. + type: object + properties: {} + GoogleCloudAiplatformV1ToolConfig: + id: GoogleCloudAiplatformV1ToolConfig + description: >- + Tool config. This config is shared for all tools provided in the + request. type: object properties: - values: - description: Required. The list of embedding values of the sparse vector. - type: array - items: - type: number - format: float - dimensions: + functionCallingConfig: + description: Optional. Function calling config. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FunctionCallingConfig' + retrievalConfig: + description: Optional. Retrieval config. + $ref: '#/components/schemas/GoogleCloudAiplatformV1RetrievalConfig' + GoogleCloudAiplatformV1FunctionCallingConfig: + id: GoogleCloudAiplatformV1FunctionCallingConfig + description: Function calling config. + type: object + properties: + mode: + description: Optional. Function calling mode. + type: string + enumDescriptions: + - Unspecified function calling mode. This value should not be used. + - >- + Default model behavior, model decides to predict either function + calls or natural language response. + - >- + Model is constrained to always predicting function calls only. If + "allowed_function_names" are set, the predicted function calls + will be limited to any one of "allowed_function_names", else the + predicted function calls will be any one of the provided + "function_declarations". + - >- + Model will not predict any function calls. Model behavior is same + as when not passing any function declarations. + enum: + - MODE_UNSPECIFIED + - AUTO + - ANY + - NONE + allowedFunctionNames: description: >- - Required. The list of indexes for the embedding values of the sparse - vector. + Optional. Function names to call. Only set when the Mode is ANY. + Function names should match [FunctionDeclaration.name]. With mode + set to ANY, model will predict a function call from the set of + function names provided. type: array items: type: string - format: int64 - GoogleCloudAiplatformV1IndexDatapointRestriction: - id: GoogleCloudAiplatformV1IndexDatapointRestriction - description: >- - Restriction of a datapoint which describe its attributes(tokens) from - each of several attribute categories(namespaces). + GoogleCloudAiplatformV1RetrievalConfig: + id: GoogleCloudAiplatformV1RetrievalConfig + description: Retrieval config. type: object properties: - namespace: - description: 'The namespace of this restriction. e.g.: color.' + latLng: + description: The location of the user. + $ref: '#/components/schemas/GoogleTypeLatLng' + languageCode: + description: The language code of the user. type: string - allowList: - description: 'The attributes to allow in this namespace. e.g.: ''red''' - type: array - items: - type: string - denyList: - description: 'The attributes to deny in this namespace. e.g.: ''blue''' - type: array - items: - type: string - GoogleCloudAiplatformV1IndexDatapointNumericRestriction: - id: GoogleCloudAiplatformV1IndexDatapointNumericRestriction + GoogleTypeLatLng: + id: GoogleTypeLatLng description: >- - This field allows restricts to be based on numeric comparisons rather - than categorical tokens. + An object that represents a latitude/longitude pair. This is expressed + as a pair of doubles to represent degrees latitude and degrees + longitude. Unless specified otherwise, this object must conform to the + WGS84 standard. Values must be within normalized ranges. type: object properties: - valueInt: - description: Represents 64 bit integer. - type: string - format: int64 - valueFloat: - description: Represents 32 bit float. + latitude: + description: The latitude in degrees. It must be in the range [-90.0, +90.0]. type: number - format: float - valueDouble: - description: Represents 64 bit float. + format: double + longitude: + description: The longitude in degrees. It must be in the range [-180.0, +180.0]. type: number format: double - namespace: - description: 'The namespace of this restriction. e.g.: cost.' - type: string - op: - description: >- - This MUST be specified for queries and must NOT be specified for - datapoints. - type: string - enumDescriptions: - - Default value of the enum. - - Datapoints are eligible iff their value is < the query's. - - Datapoints are eligible iff their value is <= the query's. - - Datapoints are eligible iff their value is == the query's. - - Datapoints are eligible iff their value is >= the query's. - - Datapoints are eligible iff their value is > the query's. - - Datapoints are eligible iff their value is != the query's. - enum: - - OPERATOR_UNSPECIFIED - - LESS - - LESS_EQUAL - - EQUAL - - GREATER_EQUAL - - GREATER - - NOT_EQUAL - GoogleCloudAiplatformV1IndexDatapointCrowdingTag: - id: GoogleCloudAiplatformV1IndexDatapointCrowdingTag - description: >- - Crowding tag is a constraint on a neighbor list produced by nearest - neighbor search requiring that no more than some value k' of the k - neighbors returned have the same value of crowding_attribute. + GoogleCloudAiplatformV1CachedContentUsageMetadata: + id: GoogleCloudAiplatformV1CachedContentUsageMetadata + description: Metadata on the usage of the cached content. type: object properties: - crowdingAttribute: - description: >- - The attribute value used for crowding. The maximum number of - neighbors to return per crowding attribute value - (per_crowding_attribute_num_neighbors) is configured per-query. This - field is ignored if per_crowding_attribute_num_neighbors is larger - than the total number of neighbors to return for a given query. - type: string - GoogleCloudAiplatformV1UpsertDatapointsResponse: - id: GoogleCloudAiplatformV1UpsertDatapointsResponse - description: Response message for IndexService.UpsertDatapoints - type: object - properties: {} - GoogleCloudAiplatformV1RemoveDatapointsRequest: - id: GoogleCloudAiplatformV1RemoveDatapointsRequest - description: Request message for IndexService.RemoveDatapoints + totalTokenCount: + description: Total number of tokens that the cached content consumes. + type: integer + format: int32 + textCount: + description: Number of text characters. + type: integer + format: int32 + imageCount: + description: Number of images. + type: integer + format: int32 + videoDurationSeconds: + description: Duration of video in seconds. + type: integer + format: int32 + audioDurationSeconds: + description: Duration of audio in seconds. + type: integer + format: int32 + GoogleCloudAiplatformV1ListCachedContentsResponse: + id: GoogleCloudAiplatformV1ListCachedContentsResponse + description: Response with a list of CachedContents. type: object properties: - datapointIds: - description: A list of datapoint ids to be deleted. + cachedContents: + description: List of cached contents. type: array items: - type: string - GoogleCloudAiplatformV1RemoveDatapointsResponse: - id: GoogleCloudAiplatformV1RemoveDatapointsResponse - description: Response message for IndexService.RemoveDatapoints - type: object - properties: {} - GoogleCloudAiplatformV1IndexEndpoint: - id: GoogleCloudAiplatformV1IndexEndpoint - description: >- - Indexes are deployed into it. An IndexEndpoint can have multiple - DeployedIndexes. + $ref: '#/components/schemas/GoogleCloudAiplatformV1CachedContent' + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + GoogleCloudAiplatformV1TuningJob: + id: GoogleCloudAiplatformV1TuningJob + description: Represents a TuningJob that runs with Google owned models. type: object properties: + baseModel: + description: >- + The base model that is being tuned. See [Supported + models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models). + type: string + supervisedTuningSpec: + description: Tuning Spec for Supervised Fine Tuning. + $ref: '#/components/schemas/GoogleCloudAiplatformV1SupervisedTuningSpec' name: - description: Output only. The resource name of the IndexEndpoint. + description: >- + Output only. Identifier. Resource name of a TuningJob. Format: + `projects/{project}/locations/{location}/tuningJobs/{tuning_job}` readOnly: true type: string - displayName: + tunedModelDisplayName: description: >- - Required. The display name of the IndexEndpoint. The name can be up - to 128 characters long and can consist of any UTF-8 characters. + Optional. The display name of the TunedModel. The name can be up to + 128 characters long and can consist of any UTF-8 characters. type: string description: - description: The description of the IndexEndpoint. + description: Optional. The description of the TuningJob. type: string - deployedIndexes: - description: Output only. The indexes deployed in this endpoint. + state: + description: Output only. The detailed state of the job. readOnly: true - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndex' - etag: - description: >- - Used to perform consistent read-modify-write updates. If not set, a - blind "overwrite" update happens. type: string - labels: - description: >- - The labels with user-defined metadata to organize your - IndexEndpoints. Label keys and values can be no longer than 64 - characters (Unicode codepoints), can only contain lowercase letters, - numeric characters, underscores and dashes. International characters - are allowed. See https://goo.gl/xmQnxf for more information and - examples of labels. - type: object - additionalProperties: - type: string + enumDescriptions: + - The job state is unspecified. + - >- + The job has been just created or resumed and processing has not + yet begun. + - The service is preparing to run the job. + - The job is in progress. + - The job completed successfully. + - The job failed. + - >- + The job is being cancelled. From this state the job may only go to + either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or + `JOB_STATE_CANCELLED`. + - The job has been cancelled. + - The job has been stopped, and can be resumed. + - The job has expired. + - >- + The job is being updated. Only jobs in the `RUNNING` state can be + updated. After updating, the job goes back to the `RUNNING` state. + - >- + The job is partially succeeded, some results may be missing due to + errors. + enum: + - JOB_STATE_UNSPECIFIED + - JOB_STATE_QUEUED + - JOB_STATE_PENDING + - JOB_STATE_RUNNING + - JOB_STATE_SUCCEEDED + - JOB_STATE_FAILED + - JOB_STATE_CANCELLING + - JOB_STATE_CANCELLED + - JOB_STATE_PAUSED + - JOB_STATE_EXPIRED + - JOB_STATE_UPDATING + - JOB_STATE_PARTIALLY_SUCCEEDED createTime: - description: Output only. Timestamp when this IndexEndpoint was created. + description: Output only. Time when the TuningJob was created. readOnly: true type: string format: google-datetime - updateTime: + startTime: description: >- - Output only. Timestamp when this IndexEndpoint was last updated. - This timestamp is not updated when the endpoint's DeployedIndexes - are updated, e.g. due to updates of the original Indexes they are - the deployments of. + Output only. Time when the TuningJob for the first time entered the + `JOB_STATE_RUNNING` state. readOnly: true type: string format: google-datetime - network: + endTime: description: >- - Optional. The full name of the Google Compute Engine - [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) - to which the IndexEndpoint should be peered. Private services access - must already be configured for the network. If left unspecified, the - Endpoint is not peered with any network. network and - private_service_connect_config are mutually exclusive. - [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): - `projects/{project}/global/networks/{network}`. Where {project} is a - project number, as in '12345', and {network} is network name. + Output only. Time when the TuningJob entered any of the following + JobStates: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, + `JOB_STATE_CANCELLED`, `JOB_STATE_EXPIRED`. + readOnly: true type: string - enablePrivateServiceConnect: - description: >- - Optional. Deprecated: If true, expose the IndexEndpoint via private - service connect. Only one of the fields, network or - enable_private_service_connect, can be set. - deprecated: true - type: boolean - privateServiceConnectConfig: + format: google-datetime + updateTime: + description: Output only. Time when the TuningJob was most recently updated. + readOnly: true + type: string + format: google-datetime + error: description: >- - Optional. Configuration for private service connect. network and - private_service_connect_config are mutually exclusive. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PrivateServiceConnectConfig - publicEndpointEnabled: - description: >- - Optional. If true, the deployed index will be accessible through - public endpoint. - type: boolean - publicEndpointDomainName: + Output only. Only populated when job's state is `JOB_STATE_FAILED` + or `JOB_STATE_CANCELLED`. + readOnly: true + $ref: '#/components/schemas/GoogleRpcStatus' + labels: description: >- - Output only. If public_endpoint_enabled is true, this field will be - populated with the domain name to use for this index endpoint. + Optional. The labels with user-defined metadata to organize + TuningJob and generated resources such as Model and Endpoint. Label + keys and values can be no longer than 64 characters (Unicode + codepoints), can only contain lowercase letters, numeric characters, + underscores and dashes. International characters are allowed. See + https://goo.gl/xmQnxf for more information and examples of labels. + type: object + additionalProperties: + type: string + experiment: + description: Output only. The Experiment associated with this TuningJob. readOnly: true type: string - encryptionSpec: + tunedModel: description: >- - Immutable. Customer-managed encryption key spec for an - IndexEndpoint. If set, this IndexEndpoint and all sub-resources of - this IndexEndpoint will be secured by this key. - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' - satisfiesPzs: - description: Output only. Reserved for future use. + Output only. The tuned model resources associated with this + TuningJob. readOnly: true - type: boolean - satisfiesPzi: - description: Output only. Reserved for future use. + $ref: '#/components/schemas/GoogleCloudAiplatformV1TunedModel' + tuningDataStats: + description: >- + Output only. The tuning data statistics associated with this + TuningJob. readOnly: true - type: boolean - GoogleCloudAiplatformV1DeployedIndex: - id: GoogleCloudAiplatformV1DeployedIndex - description: >- - A deployment of an Index. IndexEndpoints contain one or more - DeployedIndexes. - type: object - properties: - id: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TuningDataStats' + encryptionSpec: description: >- - Required. The user specified ID of the DeployedIndex. The ID can be - up to 128 characters long and must start with a letter and only - contain letters, numbers, and underscores. The ID must be unique - within the project it is created in. - type: string - index: + Customer-managed encryption key options for a TuningJob. If this is + set, then all resources created by the TuningJob will be encrypted + with the provided encryption key. + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + serviceAccount: description: >- - Required. The name of the Index this is the deployment of. We may - refer to this Index as the DeployedIndex's "original" Index. + The service account that the tuningJob workload runs as. If not + specified, the Vertex AI Secure Fine-Tuned Service Agent in the + project will be used. See + https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent + Users starting the pipeline must have the + `iam.serviceAccounts.actAs` permission on this service account. type: string - displayName: + GoogleCloudAiplatformV1SupervisedTuningSpec: + id: GoogleCloudAiplatformV1SupervisedTuningSpec + description: Tuning Spec for Supervised Tuning for first party models. + type: object + properties: + trainingDatasetUri: description: >- - The display name of the DeployedIndex. If not provided upon - creation, the Index's display_name is used. - type: string - createTime: - description: Output only. Timestamp when the DeployedIndex was created. - readOnly: true + Required. Training dataset used for tuning. The dataset can be + specified as either a Cloud Storage path to a JSONL file or as the + resource name of a Vertex Multimodal Dataset. type: string - format: google-datetime - privateEndpoints: - description: >- - Output only. Provides paths for users to send requests directly to - the deployed index services running on Cloud via private services - access. This field is populated if network is configured. - readOnly: true - $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexPrivateEndpoints' - indexSyncTime: + validationDatasetUri: description: >- - Output only. The DeployedIndex may depend on various data on its - original Index. Additionally when certain changes to the original - Index are being done (e.g. when what the Index contains is being - changed) the DeployedIndex may be asynchronously updated in the - background to reflect these changes. If this timestamp's value is at - least the Index.update_time of the original Index, it means that - this DeployedIndex and the original Index are in sync. If this - timestamp is older, then to see which updates this DeployedIndex - already contains (and which it does not), one must list the - operations that are running on the original Index. Only the - successfully completed Operations with update_time equal or before - this sync time are contained in this DeployedIndex. - readOnly: true + Optional. Validation dataset used for tuning. The dataset can be + specified as either a Cloud Storage path to a JSONL file or as the + resource name of a Vertex Multimodal Dataset. type: string - format: google-datetime - automaticResources: - description: >- - Optional. A description of resources that the DeployedIndex uses, - which to large degree are decided by Vertex AI, and optionally - allows only a modest additional configuration. If min_replica_count - is not set, the default value is 2 (we don't provide SLA when - min_replica_count=1). If max_replica_count is not set, the default - value is min_replica_count. The max allowed replica count is 1000. - $ref: '#/components/schemas/GoogleCloudAiplatformV1AutomaticResources' - dedicatedResources: - description: >- - Optional. A description of resources that are dedicated to the - DeployedIndex, and that need a higher degree of manual - configuration. The field min_replica_count must be set to a value - strictly greater than 0, or else validation will fail. We don't - provide SLA when min_replica_count=1. If max_replica_count is not - set, the default value is min_replica_count. The max allowed replica - count is 1000. Available machine types for SMALL shard: - e2-standard-2 and all machine types available for MEDIUM and LARGE - shard. Available machine types for MEDIUM shard: e2-standard-16 and - all machine types available for LARGE shard. Available machine types - for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and - n1-standard-32 are still available, but we recommend e2-standard-16 - and e2-highmem-16 for cost efficiency. - $ref: '#/components/schemas/GoogleCloudAiplatformV1DedicatedResources' - enableAccessLogging: + hyperParameters: + description: Optional. Hyperparameters for SFT. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SupervisedHyperParameters + exportLastCheckpointOnly: description: >- - Optional. If true, private endpoint's access logs are sent to Cloud - Logging. These logs are like standard server access logs, containing - information like timestamp and latency for each MatchRequest. Note - that logs may incur a cost, especially if the deployed index - receives a high queries per second rate (QPS). Estimate your costs - before enabling this option. + Optional. If set to true, disable intermediate checkpoints for SFT + and only the last checkpoint will be exported. Otherwise, enable + intermediate checkpoints for SFT. Default is false. type: boolean - deployedIndexAuthConfig: - description: >- - Optional. If set, the authentication is enabled for the private - endpoint. - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndexAuthConfig' - reservedIpRanges: - description: >- - Optional. A list of reserved ip ranges under the VPC network that - can be used for this DeployedIndex. If set, we will deploy the index - within the provided ip ranges. Otherwise, the index might be - deployed to any ip ranges under the provided VPC network. The value - should be the name of the address - (https://cloud.google.com/compute/docs/reference/rest/v1/addresses) - Example: ['vertex-ai-ip-range']. For more information about subnets - and network IP ranges, please see - https://cloud.google.com/vpc/docs/subnets#manually_created_subnet_ip_ranges. - type: array - items: - type: string - deploymentGroup: + GoogleCloudAiplatformV1SupervisedHyperParameters: + id: GoogleCloudAiplatformV1SupervisedHyperParameters + description: Hyperparameters for SFT. + type: object + properties: + epochCount: description: >- - Optional. The deployment group can be no longer than 64 characters - (eg: 'test', 'prod'). If not set, we will use the 'default' - deployment group. Creating `deployment_groups` with - `reserved_ip_ranges` is a recommended practice when the peered - network has multiple peering ranges. This creates your deployments - from predictable IP spaces for easier traffic administration. Also, - one deployment_group (except 'default') can only be used with the - same reserved_ip_ranges which means if the deployment_group has been - used with reserved_ip_ranges: [a, b, c], using it with [a, b] or [d, - e] is disallowed. Note: we only support up to 5 deployment - groups(not including 'default'). + Optional. Number of complete passes the model makes over the entire + training dataset during training. type: string - pscAutomationConfigs: + format: int64 + learningRateMultiplier: description: >- - Optional. If set for PSC deployed index, PSC connection will be - automatically created after deployment is done and the endpoint - information is populated in - private_endpoints.psc_automated_endpoints. - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PSCAutomationConfig' - GoogleCloudAiplatformV1IndexPrivateEndpoints: - id: GoogleCloudAiplatformV1IndexPrivateEndpoints + Optional. Multiplier for adjusting the default learning rate. + Mutually exclusive with `learning_rate`. This feature is only + available for 1P models. + type: number + format: double + adapterSize: + description: Optional. Adapter size for tuning. + type: string + enumDescriptions: + - Adapter size is unspecified. + - Adapter size 1. + - Adapter size 2. + - Adapter size 4. + - Adapter size 8. + - Adapter size 16. + - Adapter size 32. + enum: + - ADAPTER_SIZE_UNSPECIFIED + - ADAPTER_SIZE_ONE + - ADAPTER_SIZE_TWO + - ADAPTER_SIZE_FOUR + - ADAPTER_SIZE_EIGHT + - ADAPTER_SIZE_SIXTEEN + - ADAPTER_SIZE_THIRTY_TWO + GoogleCloudAiplatformV1TunedModel: + id: GoogleCloudAiplatformV1TunedModel description: >- - IndexPrivateEndpoints proto is used to provide paths for users to send - requests via private endpoints (e.g. private service access, private - service connect). To send request via private service access, use - match_grpc_address. To send request via private service connect, use - service_attachment. + The Model Registry Model and Online Prediction Endpoint associated with + this TuningJob. type: object properties: - matchGrpcAddress: - description: Output only. The ip address used to send match gRPC requests. + model: + description: >- + Output only. The resource name of the TunedModel. Format: + `projects/{project}/locations/{location}/models/{model}@{version_id}` + When tuning from a base model, the version_id will be 1. For + continuous tuning, the version id will be incremented by 1 from the + last version id in the parent model. E.g., + `projects/{project}/locations/{location}/models/{model}@{last_version_id + + 1}` readOnly: true type: string - serviceAttachment: + endpoint: description: >- - Output only. The name of the service attachment resource. Populated - if private service connect is enabled. + Output only. A resource name of an Endpoint. Format: + `projects/{project}/locations/{location}/endpoints/{endpoint}`. readOnly: true type: string - pscAutomatedEndpoints: + checkpoints: description: >- - Output only. PscAutomatedEndpoints is populated if private service - connect is enabled if PscAutomatedConfig is set. + Output only. The checkpoints associated with this TunedModel. This + field is only populated for tuning jobs that enable intermediate + checkpoints. readOnly: true type: array items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PscAutomatedEndpoints' - GoogleCloudAiplatformV1PscAutomatedEndpoints: - id: GoogleCloudAiplatformV1PscAutomatedEndpoints - description: >- - PscAutomatedEndpoints defines the output of the forwarding rule - automatically created by each PscAutomationConfig. + $ref: '#/components/schemas/GoogleCloudAiplatformV1TunedModelCheckpoint' + GoogleCloudAiplatformV1TunedModelCheckpoint: + id: GoogleCloudAiplatformV1TunedModelCheckpoint + description: TunedModelCheckpoint for the Tuned Model of a Tuning Job. type: object properties: - projectId: - description: Corresponding project_id in pscAutomationConfigs + checkpointId: + description: The ID of the checkpoint. type: string - network: - description: Corresponding network in pscAutomationConfigs. + epoch: + description: The epoch of the checkpoint. type: string - matchAddress: - description: Ip Address created by the automated forwarding rule. + format: int64 + step: + description: The step of the checkpoint. type: string - GoogleCloudAiplatformV1DeployedIndexAuthConfig: - id: GoogleCloudAiplatformV1DeployedIndexAuthConfig - description: Used to set up the auth on the DeployedIndex's private endpoint. + format: int64 + endpoint: + description: >- + The Endpoint resource name that the checkpoint is deployed to. + Format: + `projects/{project}/locations/{location}/endpoints/{endpoint}`. + type: string + GoogleCloudAiplatformV1TuningDataStats: + id: GoogleCloudAiplatformV1TuningDataStats + description: The tuning data statistic values for TuningJob. type: object properties: - authProvider: - description: Defines the authentication provider that the DeployedIndex uses. + supervisedTuningDataStats: + description: The SFT Tuning data stats. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DeployedIndexAuthConfigAuthProvider - GoogleCloudAiplatformV1DeployedIndexAuthConfigAuthProvider: - id: GoogleCloudAiplatformV1DeployedIndexAuthConfigAuthProvider - description: >- - Configuration for an authentication provider, including support for - [JSON Web Token - (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + #/components/schemas/GoogleCloudAiplatformV1SupervisedTuningDataStats + GoogleCloudAiplatformV1SupervisedTuningDataStats: + id: GoogleCloudAiplatformV1SupervisedTuningDataStats + description: Tuning data statistics for Supervised Tuning. type: object properties: - audiences: + tuningDatasetExampleCount: + description: Output only. Number of examples in the tuning dataset. + readOnly: true + type: string + format: int64 + totalTuningCharacterCount: + description: Output only. Number of tuning characters in the tuning dataset. + readOnly: true + type: string + format: int64 + totalBillableCharacterCount: + description: Output only. Number of billable characters in the tuning dataset. + readOnly: true + deprecated: true + type: string + format: int64 + totalBillableTokenCount: + description: Output only. Number of billable tokens in the tuning dataset. + readOnly: true + type: string + format: int64 + tuningStepCount: + description: Output only. Number of tuning steps for this Tuning Job. + readOnly: true + type: string + format: int64 + userInputTokenDistribution: + description: Output only. Dataset distributions for the user input tokens. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution + userOutputTokenDistribution: + description: Output only. Dataset distributions for the user output tokens. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution + userMessagePerExampleDistribution: + description: Output only. Dataset distributions for the messages per example. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution + userDatasetExamples: + description: Output only. Sample user messages in the training dataset uri. + readOnly: true + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' + totalTruncatedExampleCount: description: >- - The list of JWT - [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). - that are allowed to access. A JWT containing any of these audiences - will be accepted. + Output only. The number of examples in the dataset that have been + dropped. An example can be dropped for reasons including: too many + tokens, contains an invalid image, contains too many images, etc. + readOnly: true + type: string + format: int64 + truncatedExampleIndices: + description: >- + Output only. A partial sample of the indices (starting from 1) of + the dropped examples. + readOnly: true type: array items: type: string - allowedIssuers: + format: int64 + droppedExampleReasons: description: >- - A list of allowed JWT issuers. Each entry must be a valid Google - service account, in the following format: - `service-account-name@project-id.iam.gserviceaccount.com` + Output only. For each index in `truncated_example_indices`, the + user-facing reason why the example was dropped. + readOnly: true type: array items: type: string - GoogleCloudAiplatformV1PSCAutomationConfig: - id: GoogleCloudAiplatformV1PSCAutomationConfig - description: >- - PSC config that is used to automatically create forwarding rule via - ServiceConnectionMap. + GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution: + id: GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution + description: Dataset distribution for Supervised Tuning. type: object properties: - projectId: - description: Required. Project id used to create forwarding rule. + sum: + description: Output only. Sum of a given population of values. + readOnly: true type: string - network: - description: >- - Required. The full name of the Google Compute Engine - [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). - [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): - `projects/{project}/global/networks/{network}`. Where {project} is a - project number, as in '12345', and {network} is network name. + format: int64 + billableSum: + description: Output only. Sum of a given population of values that are billable. + readOnly: true type: string - GoogleCloudAiplatformV1ListIndexEndpointsResponse: - id: GoogleCloudAiplatformV1ListIndexEndpointsResponse - description: Response message for IndexEndpointService.ListIndexEndpoints. + format: int64 + min: + description: Output only. The minimum of the population values. + readOnly: true + type: number + format: double + max: + description: Output only. The maximum of the population values. + readOnly: true + type: number + format: double + mean: + description: Output only. The arithmetic mean of the values in the population. + readOnly: true + type: number + format: double + median: + description: Output only. The median of the values in the population. + readOnly: true + type: number + format: double + p5: + description: Output only. The 5th percentile of the values in the population. + readOnly: true + type: number + format: double + p95: + description: Output only. The 95th percentile of the values in the population. + readOnly: true + type: number + format: double + buckets: + description: Output only. Defines the histogram bucket. + readOnly: true + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SupervisedTuningDatasetDistributionDatasetBucket + GoogleCloudAiplatformV1SupervisedTuningDatasetDistributionDatasetBucket: + id: GoogleCloudAiplatformV1SupervisedTuningDatasetDistributionDatasetBucket + description: >- + Dataset bucket used to create a histogram for the distribution given a + population of values. type: object properties: - indexEndpoints: - description: List of IndexEndpoints in the requested page. + count: + description: Output only. Number of values in the bucket. + readOnly: true + type: number + format: double + left: + description: Output only. Left bound of the bucket. + readOnly: true + type: number + format: double + right: + description: Output only. Right bound of the bucket. + readOnly: true + type: number + format: double + GoogleCloudAiplatformV1ListTuningJobsResponse: + id: GoogleCloudAiplatformV1ListTuningJobsResponse + description: Response message for GenAiTuningService.ListTuningJobs + type: object + properties: + tuningJobs: + description: List of TuningJobs in the requested page. type: array items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexEndpoint' + $ref: '#/components/schemas/GoogleCloudAiplatformV1TuningJob' nextPageToken: description: >- - A token to retrieve next page of results. Pass to - ListIndexEndpointsRequest.page_token to obtain that page. + A token to retrieve the next page of results. Pass to + ListTuningJobsRequest.page_token to obtain that page. type: string - GoogleCloudAiplatformV1DeployIndexRequest: - id: GoogleCloudAiplatformV1DeployIndexRequest - description: Request message for IndexEndpointService.DeployIndex. + GoogleCloudAiplatformV1CancelTuningJobRequest: + id: GoogleCloudAiplatformV1CancelTuningJobRequest + description: Request message for GenAiTuningService.CancelTuningJob. + type: object + properties: {} + GoogleCloudAiplatformV1RebaseTunedModelRequest: + id: GoogleCloudAiplatformV1RebaseTunedModelRequest + description: Request message for GenAiTuningService.RebaseTunedModel. type: object properties: - deployedIndex: - description: Required. The DeployedIndex to be created within the IndexEndpoint. - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndex' - GoogleCloudAiplatformV1UndeployIndexRequest: - id: GoogleCloudAiplatformV1UndeployIndexRequest - description: Request message for IndexEndpointService.UndeployIndex. + tunedModelRef: + description: >- + Required. TunedModel reference to retrieve the legacy model + information. + $ref: '#/components/schemas/GoogleCloudAiplatformV1TunedModelRef' + tuningJob: + description: >- + Optional. The TuningJob to be updated. Users can use this TuningJob + field to overwrite tuning configs. + $ref: '#/components/schemas/GoogleCloudAiplatformV1TuningJob' + artifactDestination: + description: Optional. The Google Cloud Storage location to write the artifacts. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' + deployToSameEndpoint: + description: >- + Optional. By default, bison to gemini migration will always create + new model/endpoint, but for gemini-1.0 to gemini-1.5 migration, we + default deploy to the same endpoint. See details in this Section. + type: boolean + GoogleCloudAiplatformV1TunedModelRef: + id: GoogleCloudAiplatformV1TunedModelRef + description: TunedModel Reference for legacy model migration. type: object properties: - deployedIndexId: + tunedModel: + description: Support migration from model registry. + type: string + tuningJob: description: >- - Required. The ID of the DeployedIndex to be undeployed from the - IndexEndpoint. + Support migration from tuning job list page, from gemini-1.0-pro-002 + to 1.5 and above. type: string - GoogleCloudAiplatformV1CustomJob: - id: GoogleCloudAiplatformV1CustomJob + pipelineJob: + description: >- + Support migration from tuning job list page, from bison model to + gemini model. + type: string + GoogleCloudAiplatformV1Index: + id: GoogleCloudAiplatformV1Index description: >- - Represents a job that runs custom workloads such as a Docker container - or a Python package. A CustomJob can have multiple worker pools and each - worker pool can have its own machine and input spec. A CustomJob will be - cleaned up once the job enters terminal state (failed or succeeded). + A representation of a collection of database items organized in a way + that allows for approximate nearest neighbor (a.k.a ANN) algorithms + search. type: object properties: name: - description: Output only. Resource name of a CustomJob. + description: Output only. The resource name of the Index. readOnly: true type: string displayName: description: >- - Required. The display name of the CustomJob. The name can be up to - 128 characters long and can consist of any UTF-8 characters. + Required. The display name of the Index. The name can be up to 128 + characters long and can consist of any UTF-8 characters. type: string - jobSpec: - description: Required. Job spec. - $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJobSpec' - state: - description: Output only. The detailed state of the job. - readOnly: true + description: + description: The description of the Index. type: string - enumDescriptions: - - The job state is unspecified. - - >- - The job has been just created or resumed and processing has not - yet begun. - - The service is preparing to run the job. - - The job is in progress. - - The job completed successfully. - - The job failed. - - >- - The job is being cancelled. From this state the job may only go to - either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or - `JOB_STATE_CANCELLED`. - - The job has been cancelled. - - The job has been stopped, and can be resumed. - - The job has expired. - - >- - The job is being updated. Only jobs in the `RUNNING` state can be - updated. After updating, the job goes back to the `RUNNING` state. - - >- - The job is partially succeeded, some results may be missing due to - errors. - enum: - - JOB_STATE_UNSPECIFIED - - JOB_STATE_QUEUED - - JOB_STATE_PENDING - - JOB_STATE_RUNNING - - JOB_STATE_SUCCEEDED - - JOB_STATE_FAILED - - JOB_STATE_CANCELLING - - JOB_STATE_CANCELLED - - JOB_STATE_PAUSED - - JOB_STATE_EXPIRED - - JOB_STATE_UPDATING - - JOB_STATE_PARTIALLY_SUCCEEDED - createTime: - description: Output only. Time when the CustomJob was created. - readOnly: true + metadataSchemaUri: + description: >- + Immutable. Points to a YAML file stored on Google Cloud Storage + describing additional information about the Index, that is specific + to it. Unset if the Index does not have any additional information. + The schema is defined as an OpenAPI 3.0.2 [Schema + Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). + Note: The URI given on output will be immutable and probably + different, including the URI scheme, than the one given on input. + The output URI will point to a location where the user only has a + read access. type: string - format: google-datetime - startTime: + metadata: description: >- - Output only. Time when the CustomJob for the first time entered the - `JOB_STATE_RUNNING` state. + An additional information about the Index; the schema of the + metadata can be found in metadata_schema. + type: any + deployedIndexes: + description: >- + Output only. The pointers to DeployedIndexes created from this + Index. An Index can be only deleted if all its DeployedIndexes had + been undeployed first. readOnly: true + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndexRef' + etag: + description: >- + Used to perform consistent read-modify-write updates. If not set, a + blind "overwrite" update happens. type: string - format: google-datetime - endTime: + labels: description: >- - Output only. Time when the CustomJob entered any of the following - states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, - `JOB_STATE_CANCELLED`. + The labels with user-defined metadata to organize your Indexes. + Label keys and values can be no longer than 64 characters (Unicode + codepoints), can only contain lowercase letters, numeric characters, + underscores and dashes. International characters are allowed. See + https://goo.gl/xmQnxf for more information and examples of labels. + type: object + additionalProperties: + type: string + createTime: + description: Output only. Timestamp when this Index was created. readOnly: true type: string format: google-datetime updateTime: - description: Output only. Time when the CustomJob was most recently updated. + description: >- + Output only. Timestamp when this Index was most recently updated. + This also includes any update to the contents of the Index. Note + that Operations working on this Index may have their + Operations.metadata.generic_metadata.update_time a little after the + value of this timestamp, yet that does not mean their results are + not already reflected in the Index. Result of any successfully + completed Operation on the Index is reflected in it. readOnly: true type: string format: google-datetime - error: - description: >- - Output only. Only populated when job's state is `JOB_STATE_FAILED` - or `JOB_STATE_CANCELLED`. + indexStats: + description: Output only. Stats of the index resource. readOnly: true - $ref: '#/components/schemas/GoogleRpcStatus' - labels: + $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexStats' + indexUpdateMethod: description: >- - The labels with user-defined metadata to organize CustomJobs. Label - keys and values can be no longer than 64 characters (Unicode - codepoints), can only contain lowercase letters, numeric characters, - underscores and dashes. International characters are allowed. See - https://goo.gl/xmQnxf for more information and examples of labels. - type: object - additionalProperties: - type: string + Immutable. The update method to use with this Index. If not set, + BATCH_UPDATE will be used by default. + type: string + enumDescriptions: + - Should not be used. + - >- + BatchUpdate: user can call UpdateIndex with files on Cloud Storage + of Datapoints to update. + - >- + StreamUpdate: user can call UpsertDatapoints/DeleteDatapoints to + update the Index and the updates will be applied in corresponding + DeployedIndexes in nearly real-time. + enum: + - INDEX_UPDATE_METHOD_UNSPECIFIED + - BATCH_UPDATE + - STREAM_UPDATE encryptionSpec: description: >- - Customer-managed encryption key options for a CustomJob. If this is - set, then all resources created by the CustomJob will be encrypted - with the provided encryption key. + Immutable. Customer-managed encryption key spec for an Index. If + set, this Index and all sub-resources of this Index will be secured + by this key. $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' - webAccessUris: - description: >- - Output only. URIs for accessing [interactive - shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) - (one URI for each training node). Only available if - job_spec.enable_web_access is `true`. The keys are names of each - node in the training job; for example, `workerpool0-0` for the - primary node, `workerpool1-0` for the first node in the second - worker pool, and `workerpool1-1` for the second node in the second - worker pool. The values are the URIs for each node's interactive - shell. - readOnly: true - type: object - additionalProperties: - type: string satisfiesPzs: description: Output only. Reserved for future use. readOnly: true @@ -7953,416 +9882,637 @@ components: description: Output only. Reserved for future use. readOnly: true type: boolean - GoogleCloudAiplatformV1CustomJobSpec: - id: GoogleCloudAiplatformV1CustomJobSpec - description: Represents the spec of a CustomJob. + GoogleCloudAiplatformV1DeployedIndexRef: + id: GoogleCloudAiplatformV1DeployedIndexRef + description: Points to a DeployedIndex. type: object properties: - persistentResourceId: - description: >- - Optional. The ID of the PersistentResource in the same Project and - Location which to run If this is specified, the job will be run on - existing machines held by the PersistentResource instead of - on-demand short-live machines. The network and CMEK configs on the - job should be consistent with those on the PersistentResource, - otherwise, the job will be rejected. - type: string - workerPoolSpecs: - description: >- - Required. The spec of the worker pools including machine type and - Docker image. All worker pools except the first one are optional and - can be skipped by providing an empty value. - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1WorkerPoolSpec' - scheduling: - description: Scheduling options for a CustomJob. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Scheduling' - serviceAccount: - description: >- - Specifies the service account for workload run-as account. Users - submitting jobs must have act-as permission on this run-as account. - If unspecified, the [Vertex AI Custom Code Service - Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) - for the CustomJob's project is used. - type: string - network: - description: >- - Optional. The full name of the Compute Engine - [network](/compute/docs/networks-and-firewalls#networks) to which - the Job should be peered. For example, - `projects/12345/global/networks/myVPC`. - [Format](/compute/docs/reference/rest/v1/networks/insert) is of the - form `projects/{project}/global/networks/{network}`. Where {project} - is a project number, as in `12345`, and {network} is a network name. - To specify this field, you must have already [configured VPC Network - Peering for Vertex - AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If - this field is left unspecified, the job is not peered with any - network. + indexEndpoint: + description: Immutable. A resource name of the IndexEndpoint. type: string - reservedIpRanges: - description: >- - Optional. A list of names for the reserved ip ranges under the VPC - network that can be used for this job. If set, we will deploy the - job within the provided ip ranges. Otherwise, the job will be - deployed to any ip ranges under the provided VPC network. Example: - ['vertex-ai-ip-range']. - type: array - items: - type: string - baseOutputDirectory: - description: >- - The Cloud Storage location to store the output of this CustomJob or - HyperparameterTuningJob. For HyperparameterTuningJob, the - baseOutputDirectory of each child CustomJob backing a Trial is set - to a subdirectory of name id under its parent - HyperparameterTuningJob's baseOutputDirectory. The following Vertex - AI environment variables will be passed to containers or python - modules when this field is set: For CustomJob: * AIP_MODEL_DIR = - `/model/` * AIP_CHECKPOINT_DIR = `/checkpoints/` * - AIP_TENSORBOARD_LOG_DIR = `/logs/` For CustomJob backing a Trial of - HyperparameterTuningJob: * AIP_MODEL_DIR = `//model/` * - AIP_CHECKPOINT_DIR = `//checkpoints/` * AIP_TENSORBOARD_LOG_DIR = - `//logs/` - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' - protectedArtifactLocationId: - description: >- - The ID of the location to store protected artifacts. e.g. - us-central1. Populate only when the location is different than - CustomJob location. List of supported locations: - https://cloud.google.com/vertex-ai/docs/general/locations + deployedIndexId: + description: Immutable. The ID of the DeployedIndex in the above IndexEndpoint. type: string - tensorboard: - description: >- - Optional. The name of a Vertex AI Tensorboard resource to which this - CustomJob will upload Tensorboard logs. Format: - `projects/{project}/locations/{location}/tensorboards/{tensorboard}` + displayName: + description: Output only. The display name of the DeployedIndex. + readOnly: true type: string - enableWebAccess: - description: >- - Optional. Whether you want Vertex AI to enable [interactive shell - access](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) - to training containers. If set to `true`, you can access interactive - shells at the URIs given by CustomJob.web_access_uris or - Trial.web_access_uris (within HyperparameterTuningJob.trials). - type: boolean - enableDashboardAccess: - description: >- - Optional. Whether you want Vertex AI to enable access to the - customized dashboard in training chief container. If set to `true`, - you can access the dashboard at the URIs given by - CustomJob.web_access_uris or Trial.web_access_uris (within - HyperparameterTuningJob.trials). - type: boolean - experiment: - description: >- - Optional. The Experiment associated with this job. Format: - `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}` + GoogleCloudAiplatformV1IndexStats: + id: GoogleCloudAiplatformV1IndexStats + description: Stats of the Index. + type: object + properties: + vectorsCount: + description: Output only. The number of dense vectors in the Index. + readOnly: true type: string - experimentRun: - description: >- - Optional. The Experiment Run associated with this job. Format: - `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}-{experiment-run-name}` + format: int64 + sparseVectorsCount: + description: Output only. The number of sparse vectors in the Index. + readOnly: true type: string - models: - description: >- - Optional. The name of the Model resources for which to generate a - mapping to artifact URIs. Applicable only to some of the - Google-provided custom jobs. Format: - `projects/{project}/locations/{location}/models/{model}` In order to - retrieve a specific version of the model, also provide the version - ID or version alias. Example: - `projects/{project}/locations/{location}/models/{model}@2` or - `projects/{project}/locations/{location}/models/{model}@golden` If - no version ID or alias is specified, the "default" version will be - returned. The "default" version alias is created for the first - version of the model, and can be moved to other versions later on. - There will be exactly one default version. + format: int64 + shardsCount: + description: Output only. The number of shards in the Index. + readOnly: true + type: integer + format: int32 + GoogleCloudAiplatformV1ListIndexesResponse: + id: GoogleCloudAiplatformV1ListIndexesResponse + description: Response message for IndexService.ListIndexes. + type: object + properties: + indexes: + description: List of indexes in the requested page. type: array items: - type: string - GoogleCloudAiplatformV1WorkerPoolSpec: - id: GoogleCloudAiplatformV1WorkerPoolSpec - description: Represents the spec of a worker pool in a job. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Index' + nextPageToken: + description: >- + A token to retrieve next page of results. Pass to + ListIndexesRequest.page_token to obtain that page. + type: string + GoogleCloudAiplatformV1UpsertDatapointsRequest: + id: GoogleCloudAiplatformV1UpsertDatapointsRequest + description: Request message for IndexService.UpsertDatapoints type: object properties: - containerSpec: - description: The custom container task. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ContainerSpec' - pythonPackageSpec: - description: The Python packaged task. - $ref: '#/components/schemas/GoogleCloudAiplatformV1PythonPackageSpec' - machineSpec: - description: Optional. Immutable. The specification of a single machine. - $ref: '#/components/schemas/GoogleCloudAiplatformV1MachineSpec' - replicaCount: - description: Optional. The number of worker replicas to use for this worker pool. - type: string - format: int64 - nfsMounts: - description: Optional. List of NFS mount spec. + datapoints: + description: A list of datapoints to be created/updated. type: array items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NfsMount' - diskSpec: - description: Disk spec. - $ref: '#/components/schemas/GoogleCloudAiplatformV1DiskSpec' - GoogleCloudAiplatformV1ContainerSpec: - id: GoogleCloudAiplatformV1ContainerSpec - description: The spec of a Container. + $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexDatapoint' + updateMask: + description: >- + Optional. Update mask is used to specify the fields to be + overwritten in the datapoints by the update. The fields specified in + the update_mask are relative to each IndexDatapoint inside + datapoints, not the full request. Updatable fields: * Use + `all_restricts` to update both restricts and numeric_restricts. + type: string + format: google-fieldmask + GoogleCloudAiplatformV1IndexDatapoint: + id: GoogleCloudAiplatformV1IndexDatapoint + description: A datapoint of Index. type: object properties: - imageUri: - description: >- - Required. The URI of a container image in the Container Registry - that is to be run on each worker replica. + datapointId: + description: Required. Unique identifier of the datapoint. type: string - command: + featureVector: description: >- - The command to be invoked when the container is started. It - overrides the entrypoint instruction in Dockerfile when provided. + Required. Feature embedding vector for dense index. An array of + numbers with the length of [NearestNeighborSearchConfig.dimensions]. type: array items: - type: string - args: - description: The arguments to be passed when starting the container. + type: number + format: float + sparseEmbedding: + description: Optional. Feature embedding vector for sparse index. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1IndexDatapointSparseEmbedding + restricts: + description: >- + Optional. List of Restrict of the datapoint, used to perform + "restricted searches" where boolean rule are used to filter the + subset of the database eligible for matching. This uses categorical + tokens. See: + https://cloud.google.com/vertex-ai/docs/matching-engine/filtering type: array items: - type: string - env: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1IndexDatapointRestriction + numericRestricts: description: >- - Environment variables to be passed to the container. Maximum limit - is 100. + Optional. List of Restrict of the datapoint, used to perform + "restricted searches" where boolean rule are used to filter the + subset of the database eligible for matching. This uses numeric + comparisons. type: array items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EnvVar' - GoogleCloudAiplatformV1EnvVar: - id: GoogleCloudAiplatformV1EnvVar - description: >- - Represents an environment variable present in a Container or Python - Module. - type: object - properties: - name: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1IndexDatapointNumericRestriction + crowdingTag: description: >- - Required. Name of the environment variable. Must be a valid C - identifier. - type: string - value: + Optional. CrowdingTag of the datapoint, the number of neighbors to + return in each crowding can be configured during query. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1IndexDatapointCrowdingTag + embeddingMetadata: description: >- - Required. Variables that reference a $(VAR_NAME) are expanded using - the previous defined environment variables in the container and any - service environment variables. If a variable cannot be resolved, the - reference in the input string will be unchanged. The $(VAR_NAME) - syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped - references will never be expanded, regardless of whether the - variable exists or not. - type: string - GoogleCloudAiplatformV1PythonPackageSpec: - id: GoogleCloudAiplatformV1PythonPackageSpec - description: The spec of a Python packaged code. + Optional. The key-value map of additional metadata for the + datapoint. + type: object + additionalProperties: + type: any + description: Properties of the object. + GoogleCloudAiplatformV1IndexDatapointSparseEmbedding: + id: GoogleCloudAiplatformV1IndexDatapointSparseEmbedding + description: >- + Feature embedding vector for sparse index. An array of numbers whose + values are located in the specified dimensions. type: object properties: - executorImageUri: - description: >- - Required. The URI of a container image in Artifact Registry that - will run the provided Python package. Vertex AI provides a wide - range of executor images with pre-installed packages to meet users' - various use cases. See the list of [pre-built containers for - training](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). - You must use an image from this list. - type: string - packageUris: + values: + description: Required. The list of embedding values of the sparse vector. + type: array + items: + type: number + format: float + dimensions: description: >- - Required. The Google Cloud Storage location of the Python package - files which are the training program and its dependent packages. The - maximum number of package URIs is 100. + Required. The list of indexes for the embedding values of the sparse + vector. type: array items: type: string - pythonModule: - description: >- - Required. The Python module name to run after installing the - packages. + format: int64 + GoogleCloudAiplatformV1IndexDatapointRestriction: + id: GoogleCloudAiplatformV1IndexDatapointRestriction + description: >- + Restriction of a datapoint which describe its attributes(tokens) from + each of several attribute categories(namespaces). + type: object + properties: + namespace: + description: 'The namespace of this restriction. e.g.: color.' type: string - args: - description: Command line arguments to be passed to the Python task. + allowList: + description: 'The attributes to allow in this namespace. e.g.: ''red''' type: array items: type: string - env: - description: >- - Environment variables to be passed to the python module. Maximum - limit is 100. + denyList: + description: 'The attributes to deny in this namespace. e.g.: ''blue''' type: array items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EnvVar' - GoogleCloudAiplatformV1NfsMount: - id: GoogleCloudAiplatformV1NfsMount - description: Represents a mount configuration for Network File System (NFS) to mount. + type: string + GoogleCloudAiplatformV1IndexDatapointNumericRestriction: + id: GoogleCloudAiplatformV1IndexDatapointNumericRestriction + description: >- + This field allows restricts to be based on numeric comparisons rather + than categorical tokens. type: object properties: - server: - description: Required. IP address of the NFS server. + valueInt: + description: Represents 64 bit integer. type: string - path: + format: int64 + valueFloat: + description: Represents 32 bit float. + type: number + format: float + valueDouble: + description: Represents 64 bit float. + type: number + format: double + namespace: + description: 'The namespace of this restriction. e.g.: cost.' + type: string + op: description: >- - Required. Source path exported from NFS server. Has to start with - '/', and combined with the ip address, it indicates the source mount - path in the form of `server:path` - type: string - mountPoint: - description: >- - Required. Destination mount path. The NFS will be mounted for the - user under /mnt/nfs/ + This MUST be specified for queries and must NOT be specified for + datapoints. type: string - GoogleCloudAiplatformV1DiskSpec: - id: GoogleCloudAiplatformV1DiskSpec - description: Represents the spec of disk options. + enumDescriptions: + - Default value of the enum. + - Datapoints are eligible iff their value is < the query's. + - Datapoints are eligible iff their value is <= the query's. + - Datapoints are eligible iff their value is == the query's. + - Datapoints are eligible iff their value is >= the query's. + - Datapoints are eligible iff their value is > the query's. + - Datapoints are eligible iff their value is != the query's. + enum: + - OPERATOR_UNSPECIFIED + - LESS + - LESS_EQUAL + - EQUAL + - GREATER_EQUAL + - GREATER + - NOT_EQUAL + GoogleCloudAiplatformV1IndexDatapointCrowdingTag: + id: GoogleCloudAiplatformV1IndexDatapointCrowdingTag + description: >- + Crowding tag is a constraint on a neighbor list produced by nearest + neighbor search requiring that no more than some value k' of the k + neighbors returned have the same value of crowding_attribute. type: object properties: - bootDiskType: + crowdingAttribute: description: >- - Type of the boot disk (default is "pd-ssd"). Valid values: "pd-ssd" - (Persistent Disk Solid State Drive) or "pd-standard" (Persistent - Disk Hard Disk Drive). + The attribute value used for crowding. The maximum number of + neighbors to return per crowding attribute value + (per_crowding_attribute_num_neighbors) is configured per-query. This + field is ignored if per_crowding_attribute_num_neighbors is larger + than the total number of neighbors to return for a given query. type: string - bootDiskSizeGb: - description: Size in GB of the boot disk (default is 100GB). - type: integer - format: int32 - GoogleCloudAiplatformV1Scheduling: - id: GoogleCloudAiplatformV1Scheduling - description: All parameters related to queuing and scheduling of custom jobs. + GoogleCloudAiplatformV1UpsertDatapointsResponse: + id: GoogleCloudAiplatformV1UpsertDatapointsResponse + description: Response message for IndexService.UpsertDatapoints + type: object + properties: {} + GoogleCloudAiplatformV1RemoveDatapointsRequest: + id: GoogleCloudAiplatformV1RemoveDatapointsRequest + description: Request message for IndexService.RemoveDatapoints type: object properties: - timeout: - description: The maximum job running time. The default is 7 days. + datapointIds: + description: A list of datapoint ids to be deleted. + type: array + items: + type: string + GoogleCloudAiplatformV1RemoveDatapointsResponse: + id: GoogleCloudAiplatformV1RemoveDatapointsResponse + description: Response message for IndexService.RemoveDatapoints + type: object + properties: {} + GoogleCloudAiplatformV1IndexEndpoint: + id: GoogleCloudAiplatformV1IndexEndpoint + description: >- + Indexes are deployed into it. An IndexEndpoint can have multiple + DeployedIndexes. + type: object + properties: + name: + description: Output only. The resource name of the IndexEndpoint. + readOnly: true type: string - format: google-duration - restartJobOnWorkerRestart: + displayName: description: >- - Restarts the entire CustomJob if a worker gets restarted. This - feature can be used by distributed training jobs that are not - resilient to workers leaving and joining a job. - type: boolean - strategy: - description: Optional. This determines which type of scheduling strategy to use. + Required. The display name of the IndexEndpoint. The name can be up + to 128 characters long and can consist of any UTF-8 characters. type: string - enumDescriptions: - - Strategy will default to STANDARD. - - Deprecated. Regular on-demand provisioning strategy. - - Deprecated. Low cost by making potential use of spot resources. - - Standard provisioning strategy uses regular on-demand resources. - - Spot provisioning strategy uses spot resources. - - Flex Start strategy uses DWS to queue for resources. - enumDeprecated: - - false - - true - - true - - false - - false - - false - enum: - - STRATEGY_UNSPECIFIED - - ON_DEMAND - - LOW_COST - - STANDARD - - SPOT - - FLEX_START - disableRetries: + description: + description: The description of the IndexEndpoint. + type: string + deployedIndexes: + description: Output only. The indexes deployed in this endpoint. + readOnly: true + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndex' + etag: description: >- - Optional. Indicates if the job should retry for internal errors - after the job starts running. If true, overrides - `Scheduling.restart_job_on_worker_restart` to false. + Used to perform consistent read-modify-write updates. If not set, a + blind "overwrite" update happens. + type: string + labels: + description: >- + The labels with user-defined metadata to organize your + IndexEndpoints. Label keys and values can be no longer than 64 + characters (Unicode codepoints), can only contain lowercase letters, + numeric characters, underscores and dashes. International characters + are allowed. See https://goo.gl/xmQnxf for more information and + examples of labels. + type: object + additionalProperties: + type: string + createTime: + description: Output only. Timestamp when this IndexEndpoint was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: >- + Output only. Timestamp when this IndexEndpoint was last updated. + This timestamp is not updated when the endpoint's DeployedIndexes + are updated, e.g. due to updates of the original Indexes they are + the deployments of. + readOnly: true + type: string + format: google-datetime + network: + description: >- + Optional. The full name of the Google Compute Engine + [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) + to which the IndexEndpoint should be peered. Private services access + must already be configured for the network. If left unspecified, the + Endpoint is not peered with any network. network and + private_service_connect_config are mutually exclusive. + [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): + `projects/{project}/global/networks/{network}`. Where {project} is a + project number, as in '12345', and {network} is network name. + type: string + enablePrivateServiceConnect: + description: >- + Optional. Deprecated: If true, expose the IndexEndpoint via private + service connect. Only one of the fields, network or + enable_private_service_connect, can be set. + deprecated: true type: boolean - maxWaitDuration: + privateServiceConnectConfig: description: >- - Optional. This is the maximum duration that a job will wait for the - requested resources to be provisioned if the scheduling strategy is - set to [Strategy.DWS_FLEX_START]. If set to 0, the job will wait - indefinitely. The default is 24 hours. + Optional. Configuration for private service connect. network and + private_service_connect_config are mutually exclusive. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PrivateServiceConnectConfig + publicEndpointEnabled: + description: >- + Optional. If true, the deployed index will be accessible through + public endpoint. + type: boolean + publicEndpointDomainName: + description: >- + Output only. If public_endpoint_enabled is true, this field will be + populated with the domain name to use for this index endpoint. + readOnly: true type: string - format: google-duration - GoogleCloudAiplatformV1ListCustomJobsResponse: - id: GoogleCloudAiplatformV1ListCustomJobsResponse - description: Response message for JobService.ListCustomJobs + encryptionSpec: + description: >- + Immutable. Customer-managed encryption key spec for an + IndexEndpoint. If set, this IndexEndpoint and all sub-resources of + this IndexEndpoint will be secured by this key. + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + satisfiesPzs: + description: Output only. Reserved for future use. + readOnly: true + type: boolean + satisfiesPzi: + description: Output only. Reserved for future use. + readOnly: true + type: boolean + GoogleCloudAiplatformV1DeployedIndex: + id: GoogleCloudAiplatformV1DeployedIndex + description: >- + A deployment of an Index. IndexEndpoints contain one or more + DeployedIndexes. type: object properties: - customJobs: - description: List of CustomJobs in the requested page. + id: + description: >- + Required. The user specified ID of the DeployedIndex. The ID can be + up to 128 characters long and must start with a letter and only + contain letters, numbers, and underscores. The ID must be unique + within the project it is created in. + type: string + index: + description: >- + Required. The name of the Index this is the deployment of. We may + refer to this Index as the DeployedIndex's "original" Index. + type: string + displayName: + description: >- + The display name of the DeployedIndex. If not provided upon + creation, the Index's display_name is used. + type: string + createTime: + description: Output only. Timestamp when the DeployedIndex was created. + readOnly: true + type: string + format: google-datetime + privateEndpoints: + description: >- + Output only. Provides paths for users to send requests directly to + the deployed index services running on Cloud via private services + access. This field is populated if network is configured. + readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexPrivateEndpoints' + indexSyncTime: + description: >- + Output only. The DeployedIndex may depend on various data on its + original Index. Additionally when certain changes to the original + Index are being done (e.g. when what the Index contains is being + changed) the DeployedIndex may be asynchronously updated in the + background to reflect these changes. If this timestamp's value is at + least the Index.update_time of the original Index, it means that + this DeployedIndex and the original Index are in sync. If this + timestamp is older, then to see which updates this DeployedIndex + already contains (and which it does not), one must list the + operations that are running on the original Index. Only the + successfully completed Operations with update_time equal or before + this sync time are contained in this DeployedIndex. + readOnly: true + type: string + format: google-datetime + automaticResources: + description: >- + Optional. A description of resources that the DeployedIndex uses, + which to large degree are decided by Vertex AI, and optionally + allows only a modest additional configuration. If min_replica_count + is not set, the default value is 2 (we don't provide SLA when + min_replica_count=1). If max_replica_count is not set, the default + value is min_replica_count. The max allowed replica count is 1000. + $ref: '#/components/schemas/GoogleCloudAiplatformV1AutomaticResources' + dedicatedResources: + description: >- + Optional. A description of resources that are dedicated to the + DeployedIndex, and that need a higher degree of manual + configuration. The field min_replica_count must be set to a value + strictly greater than 0, or else validation will fail. We don't + provide SLA when min_replica_count=1. If max_replica_count is not + set, the default value is min_replica_count. The max allowed replica + count is 1000. Available machine types for SMALL shard: + e2-standard-2 and all machine types available for MEDIUM and LARGE + shard. Available machine types for MEDIUM shard: e2-standard-16 and + all machine types available for LARGE shard. Available machine types + for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and + n1-standard-32 are still available, but we recommend e2-standard-16 + and e2-highmem-16 for cost efficiency. + $ref: '#/components/schemas/GoogleCloudAiplatformV1DedicatedResources' + enableAccessLogging: + description: >- + Optional. If true, private endpoint's access logs are sent to Cloud + Logging. These logs are like standard server access logs, containing + information like timestamp and latency for each MatchRequest. Note + that logs may incur a cost, especially if the deployed index + receives a high queries per second rate (QPS). Estimate your costs + before enabling this option. + type: boolean + enableDatapointUpsertLogging: + description: >- + Optional. If true, logs to Cloud Logging errors relating to + datapoint upserts. Under normal operation conditions, these log + entries should be very rare. However, if incompatible datapoint + updates are being uploaded to an index, a high volume of log entries + may be generated in a short period of time. Note that logs may incur + a cost, especially if the deployed index receives a high volume of + datapoint upserts. Estimate your costs before enabling this option. + type: boolean + deployedIndexAuthConfig: + description: >- + Optional. If set, the authentication is enabled for the private + endpoint. + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndexAuthConfig' + reservedIpRanges: + description: >- + Optional. A list of reserved ip ranges under the VPC network that + can be used for this DeployedIndex. If set, we will deploy the index + within the provided ip ranges. Otherwise, the index might be + deployed to any ip ranges under the provided VPC network. The value + should be the name of the address + (https://cloud.google.com/compute/docs/reference/rest/v1/addresses) + Example: ['vertex-ai-ip-range']. For more information about subnets + and network IP ranges, please see + https://cloud.google.com/vpc/docs/subnets#manually_created_subnet_ip_ranges. type: array items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJob' - nextPageToken: + type: string + deploymentGroup: description: >- - A token to retrieve the next page of results. Pass to - ListCustomJobsRequest.page_token to obtain that page. + Optional. The deployment group can be no longer than 64 characters + (eg: 'test', 'prod'). If not set, we will use the 'default' + deployment group. Creating `deployment_groups` with + `reserved_ip_ranges` is a recommended practice when the peered + network has multiple peering ranges. This creates your deployments + from predictable IP spaces for easier traffic administration. Also, + one deployment_group (except 'default') can only be used with the + same reserved_ip_ranges which means if the deployment_group has been + used with reserved_ip_ranges: [a, b, c], using it with [a, b] or [d, + e] is disallowed. Note: we only support up to 5 deployment + groups(not including 'default'). type: string - GoogleCloudAiplatformV1CancelCustomJobRequest: - id: GoogleCloudAiplatformV1CancelCustomJobRequest - description: Request message for JobService.CancelCustomJob. - type: object - properties: {} - GoogleCloudAiplatformV1DataLabelingJob: - id: GoogleCloudAiplatformV1DataLabelingJob + deploymentTier: + description: >- + Optional. The deployment tier that the index is deployed to. + DEPLOYMENT_TIER_UNSPECIFIED defaults to PERFORMANCE. + type: string + enumDescriptions: + - Default deployment tier. + - Optimized for costs. + enum: + - DEPLOYMENT_TIER_UNSPECIFIED + - STORAGE + pscAutomationConfigs: + description: >- + Optional. If set for PSC deployed index, PSC connection will be + automatically created after deployment is done and the endpoint + information is populated in + private_endpoints.psc_automated_endpoints. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PSCAutomationConfig' + GoogleCloudAiplatformV1IndexPrivateEndpoints: + id: GoogleCloudAiplatformV1IndexPrivateEndpoints description: >- - DataLabelingJob is used to trigger a human labeling job on unlabeled - data from the following Dataset: + IndexPrivateEndpoints proto is used to provide paths for users to send + requests via private endpoints (e.g. private service access, private + service connect). To send request via private service access, use + match_grpc_address. To send request via private service connect, use + service_attachment. type: object properties: - name: - description: Output only. Resource name of the DataLabelingJob. + matchGrpcAddress: + description: Output only. The ip address used to send match gRPC requests. readOnly: true type: string - displayName: + serviceAttachment: description: >- - Required. The user-defined name of the DataLabelingJob. The name can - be up to 128 characters long and can consist of any UTF-8 - characters. Display name of a DataLabelingJob. + Output only. The name of the service attachment resource. Populated + if private service connect is enabled. + readOnly: true type: string - datasets: + pscAutomatedEndpoints: description: >- - Required. Dataset resource names. Right now we only support labeling - from a single Dataset. Format: - `projects/{project}/locations/{location}/datasets/{dataset}` + Output only. PscAutomatedEndpoints is populated if private service + connect is enabled if PscAutomatedConfig is set. + readOnly: true + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PscAutomatedEndpoints' + GoogleCloudAiplatformV1PscAutomatedEndpoints: + id: GoogleCloudAiplatformV1PscAutomatedEndpoints + description: >- + PscAutomatedEndpoints defines the output of the forwarding rule + automatically created by each PscAutomationConfig. + type: object + properties: + projectId: + description: Corresponding project_id in pscAutomationConfigs + type: string + network: + description: Corresponding network in pscAutomationConfigs. + type: string + matchAddress: + description: Ip Address created by the automated forwarding rule. + type: string + GoogleCloudAiplatformV1DeployedIndexAuthConfig: + id: GoogleCloudAiplatformV1DeployedIndexAuthConfig + description: Used to set up the auth on the DeployedIndex's private endpoint. + type: object + properties: + authProvider: + description: Defines the authentication provider that the DeployedIndex uses. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1DeployedIndexAuthConfigAuthProvider + GoogleCloudAiplatformV1DeployedIndexAuthConfigAuthProvider: + id: GoogleCloudAiplatformV1DeployedIndexAuthConfigAuthProvider + description: >- + Configuration for an authentication provider, including support for + [JSON Web Token + (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + type: object + properties: + audiences: + description: >- + The list of JWT + [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). + that are allowed to access. A JWT containing any of these audiences + will be accepted. type: array items: type: string - annotationLabels: + allowedIssuers: description: >- - Labels to assign to annotations generated by this DataLabelingJob. - Label keys and values can be no longer than 64 characters (Unicode - codepoints), can only contain lowercase letters, numeric characters, - underscores and dashes. International characters are allowed. See - https://goo.gl/xmQnxf for more information and examples of labels. - System reserved label keys are prefixed with - "aiplatform.googleapis.com/" and are immutable. - type: object - additionalProperties: + A list of allowed JWT issuers. Each entry must be a valid Google + service account, in the following format: + `service-account-name@project-id.iam.gserviceaccount.com` + type: array + items: type: string - labelerCount: - description: Required. Number of labelers to work on each DataItem. - type: integer - format: int32 - instructionUri: + GoogleCloudAiplatformV1ListIndexEndpointsResponse: + id: GoogleCloudAiplatformV1ListIndexEndpointsResponse + description: Response message for IndexEndpointService.ListIndexEndpoints. + type: object + properties: + indexEndpoints: + description: List of IndexEndpoints in the requested page. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexEndpoint' + nextPageToken: description: >- - Required. The Google Cloud Storage location of the instruction pdf. - This pdf is shared with labelers, and provides detailed description - on how to label DataItems in Datasets. + A token to retrieve next page of results. Pass to + ListIndexEndpointsRequest.page_token to obtain that page. type: string - inputsSchemaUri: + GoogleCloudAiplatformV1DeployIndexRequest: + id: GoogleCloudAiplatformV1DeployIndexRequest + description: Request message for IndexEndpointService.DeployIndex. + type: object + properties: + deployedIndex: + description: Required. The DeployedIndex to be created within the IndexEndpoint. + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndex' + GoogleCloudAiplatformV1UndeployIndexRequest: + id: GoogleCloudAiplatformV1UndeployIndexRequest + description: Request message for IndexEndpointService.UndeployIndex. + type: object + properties: + deployedIndexId: description: >- - Required. Points to a YAML file stored on Google Cloud Storage - describing the config for a specific type of DataLabelingJob. The - schema files that can be used here are found in the - https://storage.googleapis.com/google-cloud-aiplatform bucket in the - /schema/datalabelingjob/inputs/ folder. + Required. The ID of the DeployedIndex to be undeployed from the + IndexEndpoint. type: string - inputs: - description: Required. Input config parameters for the DataLabelingJob. - type: any + GoogleCloudAiplatformV1CustomJob: + id: GoogleCloudAiplatformV1CustomJob + description: >- + Represents a job that runs custom workloads such as a Docker container + or a Python package. A CustomJob can have multiple worker pools and each + worker pool can have its own machine and input spec. A CustomJob will be + cleaned up once the job enters terminal state (failed or succeeded). + type: object + properties: + name: + description: Output only. Resource name of a CustomJob. + readOnly: true + type: string + displayName: + description: >- + Required. The display name of the CustomJob. The name can be up to + 128 characters long and can consist of any UTF-8 characters. + type: string + jobSpec: + description: Required. Job spec. + $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJobSpec' state: description: Output only. The detailed state of the job. readOnly: true @@ -8402,215 +10552,789 @@ components: - JOB_STATE_EXPIRED - JOB_STATE_UPDATING - JOB_STATE_PARTIALLY_SUCCEEDED - labelingProgress: + createTime: + description: Output only. Time when the CustomJob was created. + readOnly: true + type: string + format: google-datetime + startTime: description: >- - Output only. Current labeling job progress percentage scaled in - interval [0, 100], indicating the percentage of DataItems that has - been finished. + Output only. Time when the CustomJob for the first time entered the + `JOB_STATE_RUNNING` state. readOnly: true - type: integer - format: int32 - currentSpend: + type: string + format: google-datetime + endTime: description: >- - Output only. Estimated cost(in US dollars) that the DataLabelingJob - has incurred to date. - readOnly: true - $ref: '#/components/schemas/GoogleTypeMoney' - createTime: - description: Output only. Timestamp when this DataLabelingJob was created. + Output only. Time when the CustomJob entered any of the following + states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, + `JOB_STATE_CANCELLED`. readOnly: true type: string format: google-datetime updateTime: - description: >- - Output only. Timestamp when this DataLabelingJob was updated most - recently. + description: Output only. Time when the CustomJob was most recently updated. readOnly: true type: string format: google-datetime error: description: >- - Output only. DataLabelingJob errors. It is only populated when job's - state is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`. + Output only. Only populated when job's state is `JOB_STATE_FAILED` + or `JOB_STATE_CANCELLED`. readOnly: true $ref: '#/components/schemas/GoogleRpcStatus' labels: description: >- - The labels with user-defined metadata to organize your - DataLabelingJobs. Label keys and values can be no longer than 64 - characters (Unicode codepoints), can only contain lowercase letters, - numeric characters, underscores and dashes. International characters - are allowed. See https://goo.gl/xmQnxf for more information and - examples of labels. System reserved label keys are prefixed with - "aiplatform.googleapis.com/" and are immutable. Following system - labels exist for each DataLabelingJob: * - "aiplatform.googleapis.com/schema": output only, its value is the - inputs_schema's title. + The labels with user-defined metadata to organize CustomJobs. Label + keys and values can be no longer than 64 characters (Unicode + codepoints), can only contain lowercase letters, numeric characters, + underscores and dashes. International characters are allowed. See + https://goo.gl/xmQnxf for more information and examples of labels. type: object additionalProperties: type: string - specialistPools: - description: The SpecialistPools' resource names associated with this job. - type: array - items: - type: string encryptionSpec: description: >- - Customer-managed encryption key spec for a DataLabelingJob. If set, - this DataLabelingJob will be secured by this key. Note: Annotations - created in the DataLabelingJob are associated with the - EncryptionSpec of the Dataset they are exported to. + Customer-managed encryption key options for a CustomJob. If this is + set, then all resources created by the CustomJob will be encrypted + with the provided encryption key. $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' - activeLearningConfig: + webAccessUris: description: >- - Parameters that configure the active learning pipeline. Active - learning will label the data incrementally via several iterations. - For every iteration, it will select a batch of data based on the - sampling strategy. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ActiveLearningConfig' - GoogleTypeMoney: - id: GoogleTypeMoney - description: Represents an amount of money with its currency type. + Output only. URIs for accessing [interactive + shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) + (one URI for each training node). Only available if + job_spec.enable_web_access is `true`. The keys are names of each + node in the training job; for example, `workerpool0-0` for the + primary node, `workerpool1-0` for the first node in the second + worker pool, and `workerpool1-1` for the second node in the second + worker pool. The values are the URIs for each node's interactive + shell. + readOnly: true + type: object + additionalProperties: + type: string + satisfiesPzs: + description: Output only. Reserved for future use. + readOnly: true + type: boolean + satisfiesPzi: + description: Output only. Reserved for future use. + readOnly: true + type: boolean + GoogleCloudAiplatformV1CustomJobSpec: + id: GoogleCloudAiplatformV1CustomJobSpec + description: Represents the spec of a CustomJob. type: object properties: - currencyCode: - description: The three-letter currency code defined in ISO 4217. + persistentResourceId: + description: >- + Optional. The ID of the PersistentResource in the same Project and + Location which to run If this is specified, the job will be run on + existing machines held by the PersistentResource instead of + on-demand short-live machines. The network and CMEK configs on the + job should be consistent with those on the PersistentResource, + otherwise, the job will be rejected. type: string - units: + workerPoolSpecs: description: >- - The whole units of the amount. For example if `currencyCode` is - `"USD"`, then 1 unit is one US dollar. + Required. The spec of the worker pools including machine type and + Docker image. All worker pools except the first one are optional and + can be skipped by providing an empty value. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1WorkerPoolSpec' + scheduling: + description: Scheduling options for a CustomJob. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Scheduling' + serviceAccount: + description: >- + Specifies the service account for workload run-as account. Users + submitting jobs must have act-as permission on this run-as account. + If unspecified, the [Vertex AI Custom Code Service + Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) + for the CustomJob's project is used. type: string - format: int64 - nanos: + network: description: >- - Number of nano (10^-9) units of the amount. The value must be - between -999,999,999 and +999,999,999 inclusive. If `units` is - positive, `nanos` must be positive or zero. If `units` is zero, - `nanos` can be positive, zero, or negative. If `units` is negative, - `nanos` must be negative or zero. For example $-1.75 is represented - as `units`=-1 and `nanos`=-750,000,000. - type: integer - format: int32 - GoogleCloudAiplatformV1ActiveLearningConfig: - id: GoogleCloudAiplatformV1ActiveLearningConfig - description: >- - Parameters that configure the active learning pipeline. Active learning - will label the data incrementally by several iterations. For every - iteration, it will select a batch of data based on the sampling - strategy. + Optional. The full name of the Compute Engine + [network](/compute/docs/networks-and-firewalls#networks) to which + the Job should be peered. For example, + `projects/12345/global/networks/myVPC`. + [Format](/compute/docs/reference/rest/v1/networks/insert) is of the + form `projects/{project}/global/networks/{network}`. Where {project} + is a project number, as in `12345`, and {network} is a network name. + To specify this field, you must have already [configured VPC Network + Peering for Vertex + AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If + this field is left unspecified, the job is not peered with any + network. + type: string + reservedIpRanges: + description: >- + Optional. A list of names for the reserved ip ranges under the VPC + network that can be used for this job. If set, we will deploy the + job within the provided ip ranges. Otherwise, the job will be + deployed to any ip ranges under the provided VPC network. Example: + ['vertex-ai-ip-range']. + type: array + items: + type: string + pscInterfaceConfig: + description: Optional. Configuration for PSC-I for CustomJob. + $ref: '#/components/schemas/GoogleCloudAiplatformV1PscInterfaceConfig' + baseOutputDirectory: + description: >- + The Cloud Storage location to store the output of this CustomJob or + HyperparameterTuningJob. For HyperparameterTuningJob, the + baseOutputDirectory of each child CustomJob backing a Trial is set + to a subdirectory of name id under its parent + HyperparameterTuningJob's baseOutputDirectory. The following Vertex + AI environment variables will be passed to containers or python + modules when this field is set: For CustomJob: * AIP_MODEL_DIR = + `/model/` * AIP_CHECKPOINT_DIR = `/checkpoints/` * + AIP_TENSORBOARD_LOG_DIR = `/logs/` For CustomJob backing a Trial of + HyperparameterTuningJob: * AIP_MODEL_DIR = `//model/` * + AIP_CHECKPOINT_DIR = `//checkpoints/` * AIP_TENSORBOARD_LOG_DIR = + `//logs/` + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' + protectedArtifactLocationId: + description: >- + The ID of the location to store protected artifacts. e.g. + us-central1. Populate only when the location is different than + CustomJob location. List of supported locations: + https://cloud.google.com/vertex-ai/docs/general/locations + type: string + tensorboard: + description: >- + Optional. The name of a Vertex AI Tensorboard resource to which this + CustomJob will upload Tensorboard logs. Format: + `projects/{project}/locations/{location}/tensorboards/{tensorboard}` + type: string + enableWebAccess: + description: >- + Optional. Whether you want Vertex AI to enable [interactive shell + access](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) + to training containers. If set to `true`, you can access interactive + shells at the URIs given by CustomJob.web_access_uris or + Trial.web_access_uris (within HyperparameterTuningJob.trials). + type: boolean + enableDashboardAccess: + description: >- + Optional. Whether you want Vertex AI to enable access to the + customized dashboard in training chief container. If set to `true`, + you can access the dashboard at the URIs given by + CustomJob.web_access_uris or Trial.web_access_uris (within + HyperparameterTuningJob.trials). + type: boolean + experiment: + description: >- + Optional. The Experiment associated with this job. Format: + `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}` + type: string + experimentRun: + description: >- + Optional. The Experiment Run associated with this job. Format: + `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}-{experiment-run-name}` + type: string + models: + description: >- + Optional. The name of the Model resources for which to generate a + mapping to artifact URIs. Applicable only to some of the + Google-provided custom jobs. Format: + `projects/{project}/locations/{location}/models/{model}` In order to + retrieve a specific version of the model, also provide the version + ID or version alias. Example: + `projects/{project}/locations/{location}/models/{model}@2` or + `projects/{project}/locations/{location}/models/{model}@golden` If + no version ID or alias is specified, the "default" version will be + returned. The "default" version alias is created for the first + version of the model, and can be moved to other versions later on. + There will be exactly one default version. + type: array + items: + type: string + GoogleCloudAiplatformV1WorkerPoolSpec: + id: GoogleCloudAiplatformV1WorkerPoolSpec + description: Represents the spec of a worker pool in a job. type: object properties: - maxDataItemCount: - description: Max number of human labeled DataItems. + containerSpec: + description: The custom container task. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ContainerSpec' + pythonPackageSpec: + description: The Python packaged task. + $ref: '#/components/schemas/GoogleCloudAiplatformV1PythonPackageSpec' + machineSpec: + description: Optional. Immutable. The specification of a single machine. + $ref: '#/components/schemas/GoogleCloudAiplatformV1MachineSpec' + replicaCount: + description: Optional. The number of worker replicas to use for this worker pool. type: string format: int64 - maxDataItemPercentage: - description: Max percent of total DataItems for human labeling. - type: integer - format: int32 - sampleConfig: + nfsMounts: + description: Optional. List of NFS mount spec. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1NfsMount' + diskSpec: + description: Disk spec. + $ref: '#/components/schemas/GoogleCloudAiplatformV1DiskSpec' + GoogleCloudAiplatformV1ContainerSpec: + id: GoogleCloudAiplatformV1ContainerSpec + description: The spec of a Container. + type: object + properties: + imageUri: description: >- - Active learning data sampling config. For every active learning - labeling iteration, it will select a batch of data based on the - sampling strategy. - $ref: '#/components/schemas/GoogleCloudAiplatformV1SampleConfig' - trainingConfig: + Required. The URI of a container image in the Container Registry + that is to be run on each worker replica. + type: string + command: description: >- - CMLE training config. For every active learning labeling iteration, - system will train a machine learning model on CMLE. The trained - model will be used by data sampling algorithm to select DataItems. - $ref: '#/components/schemas/GoogleCloudAiplatformV1TrainingConfig' - GoogleCloudAiplatformV1SampleConfig: - id: GoogleCloudAiplatformV1SampleConfig + The command to be invoked when the container is started. It + overrides the entrypoint instruction in Dockerfile when provided. + type: array + items: + type: string + args: + description: The arguments to be passed when starting the container. + type: array + items: + type: string + env: + description: >- + Environment variables to be passed to the container. Maximum limit + is 100. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EnvVar' + GoogleCloudAiplatformV1EnvVar: + id: GoogleCloudAiplatformV1EnvVar description: >- - Active learning data sampling config. For every active learning labeling - iteration, it will select a batch of data based on the sampling - strategy. + Represents an environment variable present in a Container or Python + Module. type: object properties: - initialBatchSamplePercentage: - description: The percentage of data needed to be labeled in the first batch. - type: integer - format: int32 - followingBatchSamplePercentage: + name: description: >- - The percentage of data needed to be labeled in each following batch - (except the first batch). + Required. Name of the environment variable. Must be a valid C + identifier. + type: string + value: + description: >- + Required. Variables that reference a $(VAR_NAME) are expanded using + the previous defined environment variables in the container and any + service environment variables. If a variable cannot be resolved, the + reference in the input string will be unchanged. The $(VAR_NAME) + syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped + references will never be expanded, regardless of whether the + variable exists or not. + type: string + GoogleCloudAiplatformV1PythonPackageSpec: + id: GoogleCloudAiplatformV1PythonPackageSpec + description: The spec of a Python packaged code. + type: object + properties: + executorImageUri: + description: >- + Required. The URI of a container image in Artifact Registry that + will run the provided Python package. Vertex AI provides a wide + range of executor images with pre-installed packages to meet users' + various use cases. See the list of [pre-built containers for + training](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). + You must use an image from this list. + type: string + packageUris: + description: >- + Required. The Google Cloud Storage location of the Python package + files which are the training program and its dependent packages. The + maximum number of package URIs is 100. + type: array + items: + type: string + pythonModule: + description: >- + Required. The Python module name to run after installing the + packages. + type: string + args: + description: Command line arguments to be passed to the Python task. + type: array + items: + type: string + env: + description: >- + Environment variables to be passed to the python module. Maximum + limit is 100. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EnvVar' + GoogleCloudAiplatformV1NfsMount: + id: GoogleCloudAiplatformV1NfsMount + description: Represents a mount configuration for Network File System (NFS) to mount. + type: object + properties: + server: + description: Required. IP address of the NFS server. + type: string + path: + description: >- + Required. Source path exported from NFS server. Has to start with + '/', and combined with the ip address, it indicates the source mount + path in the form of `server:path` + type: string + mountPoint: + description: >- + Required. Destination mount path. The NFS will be mounted for the + user under /mnt/nfs/ + type: string + GoogleCloudAiplatformV1DiskSpec: + id: GoogleCloudAiplatformV1DiskSpec + description: Represents the spec of disk options. + type: object + properties: + bootDiskType: + description: >- + Type of the boot disk. For non-A3U machines, the default value is + "pd-ssd", for A3U machines, the default value is + "hyperdisk-balanced". Valid values: "pd-ssd" (Persistent Disk Solid + State Drive), "pd-standard" (Persistent Disk Hard Disk Drive) or + "hyperdisk-balanced". + type: string + bootDiskSizeGb: + description: Size in GB of the boot disk (default is 100GB). type: integer format: int32 - sampleStrategy: + GoogleCloudAiplatformV1Scheduling: + id: GoogleCloudAiplatformV1Scheduling + description: All parameters related to queuing and scheduling of custom jobs. + type: object + properties: + timeout: + description: Optional. The maximum job running time. The default is 7 days. + type: string + format: google-duration + restartJobOnWorkerRestart: description: >- - Field to choose sampling strategy. Sampling strategy will decide - which data should be selected for human labeling in every batch. + Optional. Restarts the entire CustomJob if a worker gets restarted. + This feature can be used by distributed training jobs that are not + resilient to workers leaving and joining a job. + type: boolean + strategy: + description: Optional. This determines which type of scheduling strategy to use. type: string enumDescriptions: - - Default will be treated as UNCERTAINTY. - - Sample the most uncertain data to label. + - Strategy will default to STANDARD. + - Deprecated. Regular on-demand provisioning strategy. + - Deprecated. Low cost by making potential use of spot resources. + - Standard provisioning strategy uses regular on-demand resources. + - Spot provisioning strategy uses spot resources. + - Flex Start strategy uses DWS to queue for resources. + enumDeprecated: + - false + - true + - true + - false + - false + - false enum: - - SAMPLE_STRATEGY_UNSPECIFIED - - UNCERTAINTY - GoogleCloudAiplatformV1TrainingConfig: - id: GoogleCloudAiplatformV1TrainingConfig - description: >- - CMLE training config. For every active learning labeling iteration, - system will train a machine learning model on CMLE. The trained model - will be used by data sampling algorithm to select DataItems. + - STRATEGY_UNSPECIFIED + - ON_DEMAND + - LOW_COST + - STANDARD + - SPOT + - FLEX_START + disableRetries: + description: >- + Optional. Indicates if the job should retry for internal errors + after the job starts running. If true, overrides + `Scheduling.restart_job_on_worker_restart` to false. + type: boolean + maxWaitDuration: + description: >- + Optional. This is the maximum duration that a job will wait for the + requested resources to be provisioned if the scheduling strategy is + set to [Strategy.DWS_FLEX_START]. If set to 0, the job will wait + indefinitely. The default is 24 hours. + type: string + format: google-duration + GoogleCloudAiplatformV1PscInterfaceConfig: + id: GoogleCloudAiplatformV1PscInterfaceConfig + description: Configuration for PSC-I. type: object properties: - timeoutTrainingMilliHours: + networkAttachment: description: >- - The timeout hours for the CMLE training job, expressed in milli - hours i.e. 1,000 value in this field means 1 hour. + Optional. The name of the Compute Engine [network + attachment](https://cloud.google.com/vpc/docs/about-network-attachments) + to attach to the resource within the region and user project. To + specify this field, you must have already [created a network + attachment] + (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). + This field is only used for resources using PSC-I. type: string - format: int64 - GoogleCloudAiplatformV1ListDataLabelingJobsResponse: - id: GoogleCloudAiplatformV1ListDataLabelingJobsResponse - description: Response message for JobService.ListDataLabelingJobs. + dnsPeeringConfigs: + description: >- + Optional. DNS peering configurations. When specified, Vertex AI will + attempt to configure DNS peering zones in the tenant project VPC to + resolve the specified domains using the target network's Cloud DNS. + The user must grant the dns.peer role to the Vertex AI Service Agent + on the target project. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DnsPeeringConfig' + GoogleCloudAiplatformV1DnsPeeringConfig: + id: GoogleCloudAiplatformV1DnsPeeringConfig + description: >- + DNS peering configuration. These configurations are used to create DNS + peering zones in the Vertex tenant project VPC, enabling resolution of + records within the specified domain hosted in the target network's Cloud + DNS. type: object properties: - dataLabelingJobs: + domain: description: >- - A list of DataLabelingJobs that matches the specified filter in the - request. + Required. The DNS name suffix of the zone being peered to, e.g., + "my-internal-domain.corp.". Must end with a dot. + type: string + targetProject: + description: >- + Required. The project ID hosting the Cloud DNS managed zone that + contains the 'domain'. The Vertex AI Service Agent requires the + dns.peer role on this project. + type: string + targetNetwork: + description: >- + Required. The VPC network name in the target_project where the DNS + zone specified by 'domain' is visible. + type: string + GoogleCloudAiplatformV1ListCustomJobsResponse: + id: GoogleCloudAiplatformV1ListCustomJobsResponse + description: Response message for JobService.ListCustomJobs + type: object + properties: + customJobs: + description: List of CustomJobs in the requested page. type: array items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DataLabelingJob' + $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJob' nextPageToken: - description: The standard List next-page token. + description: >- + A token to retrieve the next page of results. Pass to + ListCustomJobsRequest.page_token to obtain that page. type: string - GoogleCloudAiplatformV1CancelDataLabelingJobRequest: - id: GoogleCloudAiplatformV1CancelDataLabelingJobRequest - description: Request message for JobService.CancelDataLabelingJob. + GoogleCloudAiplatformV1CancelCustomJobRequest: + id: GoogleCloudAiplatformV1CancelCustomJobRequest + description: Request message for JobService.CancelCustomJob. type: object properties: {} - GoogleCloudAiplatformV1HyperparameterTuningJob: - id: GoogleCloudAiplatformV1HyperparameterTuningJob + GoogleCloudAiplatformV1DataLabelingJob: + id: GoogleCloudAiplatformV1DataLabelingJob description: >- - Represents a HyperparameterTuningJob. A HyperparameterTuningJob has a - Study specification and multiple CustomJobs with identical CustomJob - specification. + DataLabelingJob is used to trigger a human labeling job on unlabeled + data from the following Dataset: type: object properties: name: - description: Output only. Resource name of the HyperparameterTuningJob. + description: Output only. Resource name of the DataLabelingJob. readOnly: true type: string displayName: description: >- - Required. The display name of the HyperparameterTuningJob. The name - can be up to 128 characters long and can consist of any UTF-8 - characters. + Required. The user-defined name of the DataLabelingJob. The name can + be up to 128 characters long and can consist of any UTF-8 + characters. Display name of a DataLabelingJob. type: string - studySpec: - description: Required. Study configuration of the HyperparameterTuningJob. - $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpec' - maxTrialCount: - description: Required. The desired total number of Trials. - type: integer - format: int32 - parallelTrialCount: - description: Required. The desired number of Trials to run in parallel. + datasets: + description: >- + Required. Dataset resource names. Right now we only support labeling + from a single Dataset. Format: + `projects/{project}/locations/{location}/datasets/{dataset}` + type: array + items: + type: string + annotationLabels: + description: >- + Labels to assign to annotations generated by this DataLabelingJob. + Label keys and values can be no longer than 64 characters (Unicode + codepoints), can only contain lowercase letters, numeric characters, + underscores and dashes. International characters are allowed. See + https://goo.gl/xmQnxf for more information and examples of labels. + System reserved label keys are prefixed with + "aiplatform.googleapis.com/" and are immutable. + type: object + additionalProperties: + type: string + labelerCount: + description: Required. Number of labelers to work on each DataItem. + type: integer + format: int32 + instructionUri: + description: >- + Required. The Google Cloud Storage location of the instruction pdf. + This pdf is shared with labelers, and provides detailed description + on how to label DataItems in Datasets. + type: string + inputsSchemaUri: + description: >- + Required. Points to a YAML file stored on Google Cloud Storage + describing the config for a specific type of DataLabelingJob. The + schema files that can be used here are found in the + https://storage.googleapis.com/google-cloud-aiplatform bucket in the + /schema/datalabelingjob/inputs/ folder. + type: string + inputs: + description: Required. Input config parameters for the DataLabelingJob. + type: any + state: + description: Output only. The detailed state of the job. + readOnly: true + type: string + enumDescriptions: + - The job state is unspecified. + - >- + The job has been just created or resumed and processing has not + yet begun. + - The service is preparing to run the job. + - The job is in progress. + - The job completed successfully. + - The job failed. + - >- + The job is being cancelled. From this state the job may only go to + either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or + `JOB_STATE_CANCELLED`. + - The job has been cancelled. + - The job has been stopped, and can be resumed. + - The job has expired. + - >- + The job is being updated. Only jobs in the `RUNNING` state can be + updated. After updating, the job goes back to the `RUNNING` state. + - >- + The job is partially succeeded, some results may be missing due to + errors. + enum: + - JOB_STATE_UNSPECIFIED + - JOB_STATE_QUEUED + - JOB_STATE_PENDING + - JOB_STATE_RUNNING + - JOB_STATE_SUCCEEDED + - JOB_STATE_FAILED + - JOB_STATE_CANCELLING + - JOB_STATE_CANCELLED + - JOB_STATE_PAUSED + - JOB_STATE_EXPIRED + - JOB_STATE_UPDATING + - JOB_STATE_PARTIALLY_SUCCEEDED + labelingProgress: + description: >- + Output only. Current labeling job progress percentage scaled in + interval [0, 100], indicating the percentage of DataItems that has + been finished. + readOnly: true + type: integer + format: int32 + currentSpend: + description: >- + Output only. Estimated cost(in US dollars) that the DataLabelingJob + has incurred to date. + readOnly: true + $ref: '#/components/schemas/GoogleTypeMoney' + createTime: + description: Output only. Timestamp when this DataLabelingJob was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: >- + Output only. Timestamp when this DataLabelingJob was updated most + recently. + readOnly: true + type: string + format: google-datetime + error: + description: >- + Output only. DataLabelingJob errors. It is only populated when job's + state is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`. + readOnly: true + $ref: '#/components/schemas/GoogleRpcStatus' + labels: + description: >- + The labels with user-defined metadata to organize your + DataLabelingJobs. Label keys and values can be no longer than 64 + characters (Unicode codepoints), can only contain lowercase letters, + numeric characters, underscores and dashes. International characters + are allowed. See https://goo.gl/xmQnxf for more information and + examples of labels. System reserved label keys are prefixed with + "aiplatform.googleapis.com/" and are immutable. Following system + labels exist for each DataLabelingJob: * + "aiplatform.googleapis.com/schema": output only, its value is the + inputs_schema's title. + type: object + additionalProperties: + type: string + specialistPools: + description: The SpecialistPools' resource names associated with this job. + type: array + items: + type: string + encryptionSpec: + description: >- + Customer-managed encryption key spec for a DataLabelingJob. If set, + this DataLabelingJob will be secured by this key. Note: Annotations + created in the DataLabelingJob are associated with the + EncryptionSpec of the Dataset they are exported to. + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + activeLearningConfig: + description: >- + Parameters that configure the active learning pipeline. Active + learning will label the data incrementally via several iterations. + For every iteration, it will select a batch of data based on the + sampling strategy. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ActiveLearningConfig' + GoogleTypeMoney: + id: GoogleTypeMoney + description: Represents an amount of money with its currency type. + type: object + properties: + currencyCode: + description: The three-letter currency code defined in ISO 4217. + type: string + units: + description: >- + The whole units of the amount. For example if `currencyCode` is + `"USD"`, then 1 unit is one US dollar. + type: string + format: int64 + nanos: + description: >- + Number of nano (10^-9) units of the amount. The value must be + between -999,999,999 and +999,999,999 inclusive. If `units` is + positive, `nanos` must be positive or zero. If `units` is zero, + `nanos` can be positive, zero, or negative. If `units` is negative, + `nanos` must be negative or zero. For example $-1.75 is represented + as `units`=-1 and `nanos`=-750,000,000. + type: integer + format: int32 + GoogleCloudAiplatformV1ActiveLearningConfig: + id: GoogleCloudAiplatformV1ActiveLearningConfig + description: >- + Parameters that configure the active learning pipeline. Active learning + will label the data incrementally by several iterations. For every + iteration, it will select a batch of data based on the sampling + strategy. + type: object + properties: + maxDataItemCount: + description: Max number of human labeled DataItems. + type: string + format: int64 + maxDataItemPercentage: + description: Max percent of total DataItems for human labeling. + type: integer + format: int32 + sampleConfig: + description: >- + Active learning data sampling config. For every active learning + labeling iteration, it will select a batch of data based on the + sampling strategy. + $ref: '#/components/schemas/GoogleCloudAiplatformV1SampleConfig' + trainingConfig: + description: >- + CMLE training config. For every active learning labeling iteration, + system will train a machine learning model on CMLE. The trained + model will be used by data sampling algorithm to select DataItems. + $ref: '#/components/schemas/GoogleCloudAiplatformV1TrainingConfig' + GoogleCloudAiplatformV1SampleConfig: + id: GoogleCloudAiplatformV1SampleConfig + description: >- + Active learning data sampling config. For every active learning labeling + iteration, it will select a batch of data based on the sampling + strategy. + type: object + properties: + initialBatchSamplePercentage: + description: The percentage of data needed to be labeled in the first batch. + type: integer + format: int32 + followingBatchSamplePercentage: + description: >- + The percentage of data needed to be labeled in each following batch + (except the first batch). + type: integer + format: int32 + sampleStrategy: + description: >- + Field to choose sampling strategy. Sampling strategy will decide + which data should be selected for human labeling in every batch. + type: string + enumDescriptions: + - Default will be treated as UNCERTAINTY. + - Sample the most uncertain data to label. + enum: + - SAMPLE_STRATEGY_UNSPECIFIED + - UNCERTAINTY + GoogleCloudAiplatformV1TrainingConfig: + id: GoogleCloudAiplatformV1TrainingConfig + description: >- + CMLE training config. For every active learning labeling iteration, + system will train a machine learning model on CMLE. The trained model + will be used by data sampling algorithm to select DataItems. + type: object + properties: + timeoutTrainingMilliHours: + description: >- + The timeout hours for the CMLE training job, expressed in milli + hours i.e. 1,000 value in this field means 1 hour. + type: string + format: int64 + GoogleCloudAiplatformV1ListDataLabelingJobsResponse: + id: GoogleCloudAiplatformV1ListDataLabelingJobsResponse + description: Response message for JobService.ListDataLabelingJobs. + type: object + properties: + dataLabelingJobs: + description: >- + A list of DataLabelingJobs that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DataLabelingJob' + nextPageToken: + description: The standard List next-page token. + type: string + GoogleCloudAiplatformV1CancelDataLabelingJobRequest: + id: GoogleCloudAiplatformV1CancelDataLabelingJobRequest + description: Request message for JobService.CancelDataLabelingJob. + type: object + properties: {} + GoogleCloudAiplatformV1HyperparameterTuningJob: + id: GoogleCloudAiplatformV1HyperparameterTuningJob + description: >- + Represents a HyperparameterTuningJob. A HyperparameterTuningJob has a + Study specification and multiple CustomJobs with identical CustomJob + specification. + type: object + properties: + name: + description: Output only. Resource name of the HyperparameterTuningJob. + readOnly: true + type: string + displayName: + description: >- + Required. The display name of the HyperparameterTuningJob. The name + can be up to 128 characters long and can consist of any UTF-8 + characters. + type: string + studySpec: + description: Required. Study configuration of the HyperparameterTuningJob. + $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpec' + maxTrialCount: + description: Required. The desired total number of Trials. + type: integer + format: int32 + parallelTrialCount: + description: Required. The desired number of Trials to run in parallel. type: integer format: int32 maxFailedTrialCount: @@ -10334,6 +13058,17 @@ components: [`AIP_DEPLOYED_MODEL_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) type: string + invokeRoutePrefix: + description: >- + Immutable. Invoke route prefix for the custom container. "/*" is the + only supported value right now. By setting this field, any non-root + route on this model will be accessible with invoke http call eg: + "/invoke/foo/bar", however the [PredictionService.Invoke] RPC is not + supported yet. Only one of `predict_route` or `invoke_route_prefix` + can be set, and we default to using `predict_route` if this field is + not set. If this field is set, the Model can only be deployed to + dedicated endpoint. + type: string grpcPorts: description: >- Immutable. List of ports to expose from the container. Vertex AI @@ -10364,6 +13099,9 @@ components: healthProbe: description: Immutable. Specification for Kubernetes readiness probe. $ref: '#/components/schemas/GoogleCloudAiplatformV1Probe' + livenessProbe: + description: Immutable. Specification for Kubernetes liveness probe. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Probe' GoogleCloudAiplatformV1Port: id: GoogleCloudAiplatformV1Port description: Represents a network port in a container. @@ -10385,6 +13123,21 @@ components: exec: description: ExecAction probes the health of a container by executing a command. $ref: '#/components/schemas/GoogleCloudAiplatformV1ProbeExecAction' + httpGet: + description: >- + HttpGetAction probes the health of a container by sending an HTTP + GET request. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ProbeHttpGetAction' + grpc: + description: >- + GrpcAction probes the health of a container by sending a gRPC + request. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ProbeGrpcAction' + tcpSocket: + description: >- + TcpSocketAction probes the health of a container by opening a TCP + socket connection. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ProbeTcpSocketAction' periodSeconds: description: >- How often (in seconds) to perform the probe. Default to 10 seconds. @@ -10399,6 +13152,27 @@ components: period_seconds. Maps to Kubernetes probe argument 'timeoutSeconds'. type: integer format: int32 + failureThreshold: + description: >- + Number of consecutive failures before the probe is considered + failed. Defaults to 3. Minimum value is 1. Maps to Kubernetes probe + argument 'failureThreshold'. + type: integer + format: int32 + successThreshold: + description: >- + Number of consecutive successes before the probe is considered + successful. Defaults to 1. Minimum value is 1. Maps to Kubernetes + probe argument 'successThreshold'. + type: integer + format: int32 + initialDelaySeconds: + description: >- + Number of seconds to wait before starting the probe. Defaults to 0. + Minimum value is 0. Maps to Kubernetes probe argument + 'initialDelaySeconds'. + type: integer + format: int32 GoogleCloudAiplatformV1ProbeExecAction: id: GoogleCloudAiplatformV1ProbeExecAction description: ExecAction specifies a command to execute. @@ -10415,6 +13189,84 @@ components: type: array items: type: string + GoogleCloudAiplatformV1ProbeHttpGetAction: + id: GoogleCloudAiplatformV1ProbeHttpGetAction + description: HttpGetAction describes an action based on HTTP Get requests. + type: object + properties: + path: + description: Path to access on the HTTP server. + type: string + port: + description: >- + Number of the port to access on the container. Number must be in the + range 1 to 65535. + type: integer + format: int32 + host: + description: >- + Host name to connect to, defaults to the model serving container's + IP. You probably want to set "Host" in httpHeaders instead. + type: string + scheme: + description: >- + Scheme to use for connecting to the host. Defaults to HTTP. + Acceptable values are "HTTP" or "HTTPS". + type: string + httpHeaders: + description: Custom headers to set in the request. HTTP allows repeated headers. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ProbeHttpHeader' + GoogleCloudAiplatformV1ProbeHttpHeader: + id: GoogleCloudAiplatformV1ProbeHttpHeader + description: HttpHeader describes a custom header to be used in HTTP probes + type: object + properties: + name: + description: >- + The header field name. This will be canonicalized upon output, so + case-variant names will be understood as the same header. + type: string + value: + description: The header field value + type: string + GoogleCloudAiplatformV1ProbeGrpcAction: + id: GoogleCloudAiplatformV1ProbeGrpcAction + description: GrpcAction checks the health of a container using a gRPC service. + type: object + properties: + port: + description: >- + Port number of the gRPC service. Number must be in the range 1 to + 65535. + type: integer + format: int32 + service: + description: >- + Service is the name of the service to place in the gRPC + HealthCheckRequest. See + https://github.com/grpc/grpc/blob/master/doc/health-checking.md. If + this is not specified, the default behavior is defined by gRPC. + type: string + GoogleCloudAiplatformV1ProbeTcpSocketAction: + id: GoogleCloudAiplatformV1ProbeTcpSocketAction + description: >- + TcpSocketAction probes the health of a container by opening a TCP socket + connection. + type: object + properties: + port: + description: >- + Number of the port to access on the container. Number must be in the + range 1 to 65535. + type: integer + format: int32 + host: + description: >- + Optional: Host name to connect to, defaults to the model serving + container's IP. + type: string GoogleCloudAiplatformV1BatchPredictionJobInputConfig: id: GoogleCloudAiplatformV1BatchPredictionJobInputConfig description: >- @@ -11180,10 +14032,9 @@ components: enableLogging: description: >- Dump the anomalies to Cloud Logging. The anomalies will be put to - json payload encoded from proto - google.cloud.aiplatform.logging.ModelMonitoringAnomaliesLogEntry. - This can be further sinked to Pub/Sub or any other services - supported by Cloud Logging. + json payload encoded from proto ModelMonitoringStatsAnomalies. This + can be further synced to Pub/Sub or any other services supported by + Cloud Logging. type: boolean notificationChannels: description: >- @@ -12128,6 +14979,14 @@ components: only text should be used in parts and content in each part will be in a separate paragraph. $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' + cachedContent: + description: >- + Optional. The name of the cached content used as context to serve + the prediction. Note: only used in explicit caching, where users can + have control over caching (e.g. what content to cache) and enjoy + guaranteed cost savings. Format: + `projects/{project}/locations/{location}/cachedContents/{cachedContent}` + type: string tools: description: >- Optional. A list of `Tools` the model may use to generate the next @@ -12160,371 +15019,15 @@ components: type: array items: $ref: '#/components/schemas/GoogleCloudAiplatformV1SafetySetting' + modelArmorConfig: + description: >- + Optional. Settings for prompt and response sanitization using the + Model Armor service. If supplied, safety_settings must not be + supplied. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelArmorConfig' generationConfig: description: Optional. Generation config. $ref: '#/components/schemas/GoogleCloudAiplatformV1GenerationConfig' - GoogleCloudAiplatformV1Tool: - id: GoogleCloudAiplatformV1Tool - description: >- - Tool details that the model may use to generate response. A `Tool` is a - piece of code that enables the system to interact with external systems - to perform an action, or set of actions, outside of knowledge and scope - of the model. A Tool object should contain exactly one type of Tool (e.g - FunctionDeclaration, Retrieval or GoogleSearchRetrieval). - type: object - properties: - functionDeclarations: - description: >- - Optional. Function tool type. One or more function declarations to - be passed to the model along with the current user query. Model may - decide to call a subset of these functions by populating - FunctionCall in the response. User should provide a FunctionResponse - for each function call in the next turn. Based on the function - responses, Model will generate the final response back to the user. - Maximum 128 function declarations can be provided. - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FunctionDeclaration' - retrieval: - description: >- - Optional. Retrieval tool type. System will always execute the - provided retrieval tool(s) to get external knowledge to answer the - prompt. Retrieval results are presented to the model for generation. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Retrieval' - googleSearchRetrieval: - description: >- - Optional. GoogleSearchRetrieval tool type. Specialized retrieval - tool that is powered by Google search. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GoogleSearchRetrieval' - GoogleCloudAiplatformV1FunctionDeclaration: - id: GoogleCloudAiplatformV1FunctionDeclaration - description: >- - Structured representation of a function declaration as defined by the - [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). - Included in this declaration are the function name, description, - parameters and response type. This FunctionDeclaration is a - representation of a block of code that can be used as a `Tool` by the - model and executed by the client. - type: object - properties: - name: - description: >- - Required. The name of the function to call. Must start with a letter - or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, - dots and dashes, with a maximum length of 64. - type: string - description: - description: >- - Optional. Description and purpose of the function. Model uses it to - decide how and whether to call the function. - type: string - parameters: - description: >- - Optional. Describes the parameters to this function in JSON Schema - Object format. Reflects the Open API 3.03 Parameter Object. string - Key: the name of the parameter. Parameter names are case sensitive. - Schema Value: the Schema defining the type used for the parameter. - For function with no parameters, this can be left unset. Parameter - names must start with a letter or an underscore and must only - contain chars a-z, A-Z, 0-9, or underscores with a maximum length of - 64. Example with 1 required and 1 optional parameter: type: OBJECT - properties: param1: type: STRING param2: type: INTEGER required: - - param1 - $ref: '#/components/schemas/GoogleCloudAiplatformV1Schema' - response: - description: >- - Optional. Describes the output from this function in JSON Schema - format. Reflects the Open API 3.03 Response Object. The Schema - defines the type used for the response value of the function. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Schema' - GoogleCloudAiplatformV1Schema: - id: GoogleCloudAiplatformV1Schema - description: >- - Schema is used to define the format of input/output data. Represents a - select subset of an [OpenAPI 3.0 schema - object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields - may be added in the future as needed. - type: object - properties: - type: - description: Optional. The type of the data. - type: string - enumDescriptions: - - Not specified, should not be used. - - OpenAPI string type - - OpenAPI number type - - OpenAPI integer type - - OpenAPI boolean type - - OpenAPI array type - - OpenAPI object type - enum: - - TYPE_UNSPECIFIED - - STRING - - NUMBER - - INTEGER - - BOOLEAN - - ARRAY - - OBJECT - format: - description: >- - Optional. The format of the data. Supported formats: for NUMBER - type: "float", "double" for INTEGER type: "int32", "int64" for - STRING type: "email", "byte", etc - type: string - title: - description: Optional. The title of the Schema. - type: string - description: - description: Optional. The description of the data. - type: string - nullable: - description: Optional. Indicates if the value may be null. - type: boolean - default: - description: Optional. Default value of the data. - type: any - items: - description: >- - Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of - Type.ARRAY. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Schema' - minItems: - description: Optional. Minimum number of the elements for Type.ARRAY. - type: string - format: int64 - maxItems: - description: Optional. Maximum number of the elements for Type.ARRAY. - type: string - format: int64 - enum: - description: >- - Optional. Possible values of the element of primitive type with enum - format. Examples: 1. We can define direction as : {type:STRING, - format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can - define apartment number as : {type:INTEGER, format:enum, - enum:["101", "201", "301"]} - type: array - items: - type: string - properties: - description: Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. - type: object - additionalProperties: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Schema' - propertyOrdering: - description: >- - Optional. The order of the properties. Not a standard field in open - api spec. Only used to support the order of the properties. - type: array - items: - type: string - required: - description: Optional. Required properties of Type.OBJECT. - type: array - items: - type: string - minProperties: - description: Optional. Minimum number of the properties for Type.OBJECT. - type: string - format: int64 - maxProperties: - description: Optional. Maximum number of the properties for Type.OBJECT. - type: string - format: int64 - minimum: - description: >- - Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of - the Type.INTEGER and Type.NUMBER - type: number - format: double - maximum: - description: Optional. Maximum value of the Type.INTEGER and Type.NUMBER - type: number - format: double - minLength: - description: >- - Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the - Type.STRING - type: string - format: int64 - maxLength: - description: Optional. Maximum length of the Type.STRING - type: string - format: int64 - pattern: - description: >- - Optional. Pattern of the Type.STRING to restrict a string to a - regular expression. - type: string - example: - description: >- - Optional. Example of the object. Will only populated when the object - is the root. - type: any - anyOf: - description: >- - Optional. The value should be validated against any (one or more) of - the subschemas in the list. - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Schema' - GoogleCloudAiplatformV1Retrieval: - id: GoogleCloudAiplatformV1Retrieval - description: >- - Defines a retrieval tool that model can call to access external - knowledge. - type: object - properties: - vertexAiSearch: - description: Set to use data source powered by Vertex AI Search. - $ref: '#/components/schemas/GoogleCloudAiplatformV1VertexAISearch' - vertexRagStore: - description: >- - Set to use data source powered by Vertex RAG store. User data is - uploaded via the VertexRagDataService. - $ref: '#/components/schemas/GoogleCloudAiplatformV1VertexRagStore' - disableAttribution: - description: Optional. Deprecated. This option is no longer supported. - deprecated: true - type: boolean - GoogleCloudAiplatformV1VertexAISearch: - id: GoogleCloudAiplatformV1VertexAISearch - description: >- - Retrieve from Vertex AI Search datastore for grounding. See - https://cloud.google.com/products/agent-builder - type: object - properties: - datastore: - description: >- - Required. Fully-qualified Vertex AI Search data store resource ID. - Format: - `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` - type: string - GoogleCloudAiplatformV1VertexRagStore: - id: GoogleCloudAiplatformV1VertexRagStore - description: Retrieve from Vertex RAG Store for grounding. - type: object - properties: - ragCorpora: - description: Optional. Deprecated. Please use rag_resources instead. - deprecated: true - type: array - items: - type: string - ragResources: - description: >- - Optional. The representation of the rag source. It can be used to - specify corpus only or ragfiles. Currently only support one corpus - or multiple files from one corpus. In the future we may open up - multiple corpora support. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1VertexRagStoreRagResource - similarityTopK: - description: >- - Optional. Number of top k results to return from the selected - corpora. - deprecated: true - type: integer - format: int32 - vectorDistanceThreshold: - description: >- - Optional. Only return results with vector distance smaller than the - threshold. - type: number - format: double - GoogleCloudAiplatformV1VertexRagStoreRagResource: - id: GoogleCloudAiplatformV1VertexRagStoreRagResource - description: The definition of the Rag resource. - type: object - properties: - ragCorpus: - description: >- - Optional. RagCorpora resource name. Format: - `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` - type: string - ragFileIds: - description: >- - Optional. rag_file_id. The files should be in the same rag_corpus - set in rag_corpus field. - type: array - items: - type: string - GoogleCloudAiplatformV1GoogleSearchRetrieval: - id: GoogleCloudAiplatformV1GoogleSearchRetrieval - description: Tool to retrieve public web data for grounding, powered by Google. - type: object - properties: - dynamicRetrievalConfig: - description: Specifies the dynamic retrieval configuration for the given source. - $ref: '#/components/schemas/GoogleCloudAiplatformV1DynamicRetrievalConfig' - GoogleCloudAiplatformV1DynamicRetrievalConfig: - id: GoogleCloudAiplatformV1DynamicRetrievalConfig - description: Describes the options to customize dynamic retrieval. - type: object - properties: - mode: - description: The mode of the predictor to be used in dynamic retrieval. - type: string - enumDescriptions: - - Always trigger retrieval. - - Run retrieval only when system decides it is necessary. - enum: - - MODE_UNSPECIFIED - - MODE_DYNAMIC - dynamicThreshold: - description: >- - Optional. The threshold to be used in dynamic retrieval. If not set, - a system default value is used. - type: number - format: float - GoogleCloudAiplatformV1ToolConfig: - id: GoogleCloudAiplatformV1ToolConfig - description: >- - Tool config. This config is shared for all tools provided in the - request. - type: object - properties: - functionCallingConfig: - description: Optional. Function calling config. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FunctionCallingConfig' - GoogleCloudAiplatformV1FunctionCallingConfig: - id: GoogleCloudAiplatformV1FunctionCallingConfig - description: Function calling config. - type: object - properties: - mode: - description: Optional. Function calling mode. - type: string - enumDescriptions: - - Unspecified function calling mode. This value should not be used. - - >- - Default model behavior, model decides to predict either function - calls or natural language response. - - >- - Model is constrained to always predicting function calls only. If - "allowed_function_names" are set, the predicted function calls - will be limited to any one of "allowed_function_names", else the - predicted function calls will be any one of the provided - "function_declarations". - - >- - Model will not predict any function calls. Model behavior is same - as when not passing any function declarations. - enum: - - MODE_UNSPECIFIED - - AUTO - - ANY - - NONE - allowedFunctionNames: - description: >- - Optional. Function names to call. Only set when the Mode is ANY. - Function names should match [FunctionDeclaration.name]. With mode - set to ANY, model will predict a function call from the set of - function names provided. - type: array - items: - type: string GoogleCloudAiplatformV1SafetySetting: id: GoogleCloudAiplatformV1SafetySetting description: Safety settings. @@ -12539,7 +15042,24 @@ components: - The harm category is dangerous content. - The harm category is harassment. - The harm category is sexually explicit content. - - The harm category is civic integrity. + - >- + Deprecated: Election filter is not longer supported. The harm + category is civic integrity. + - The harm category is image hate. + - The harm category is image dangerous content. + - The harm category is image harassment. + - The harm category is image sexually explicit content. + enumDeprecated: + - false + - false + - false + - false + - false + - true + - false + - false + - false + - false enum: - HARM_CATEGORY_UNSPECIFIED - HARM_CATEGORY_HATE_SPEECH @@ -12547,6 +15067,10 @@ components: - HARM_CATEGORY_HARASSMENT - HARM_CATEGORY_SEXUALLY_EXPLICIT - HARM_CATEGORY_CIVIC_INTEGRITY + - HARM_CATEGORY_IMAGE_HATE + - HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT + - HARM_CATEGORY_IMAGE_HARASSMENT + - HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT threshold: description: Required. The harm block threshold. type: string @@ -12578,6 +15102,21 @@ components: - HARM_BLOCK_METHOD_UNSPECIFIED - SEVERITY - PROBABILITY + GoogleCloudAiplatformV1ModelArmorConfig: + id: GoogleCloudAiplatformV1ModelArmorConfig + description: Configuration for Model Armor integrations of prompt and responses. + type: object + properties: + promptTemplateName: + description: >- + Optional. The name of the Model Armor template to use for prompt + sanitization. + type: string + responseTemplateName: + description: >- + Optional. The name of the Model Armor template to use for response + sanitization. + type: string GoogleCloudAiplatformV1GenerationConfig: id: GoogleCloudAiplatformV1GenerationConfig description: Generation config. @@ -12646,6 +15185,25 @@ components: compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. $ref: '#/components/schemas/GoogleCloudAiplatformV1Schema' + responseJsonSchema: + description: >- + Optional. Output schema of the generated response. This is an + alternative to `response_schema` that accepts [JSON + Schema](https://json-schema.org/). If set, `response_schema` must be + omitted, but `response_mime_type` is required. While the full JSON + Schema may be sent, not all features are supported. Specifically, + only the following properties are supported: - `$id` - `$defs` - + `$ref` - `$anchor` - `type` - `format` - `title` - `description` - + `enum` (for strings and numbers) - `items` - `prefixItems` - + `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` + (interpreted the same as `anyOf`) - `properties` - + `additionalProperties` - `required` The non-standard + `propertyOrdering` property may also be set. Cyclic references are + unrolled to a limited degree and, as such, may only be used within + non-required properties. (Nullable properties are not sufficient.) + If `$ref` is set on a sub-schema, no other properties, except for + than those starting as a `$`, may be set. + type: any routingConfig: description: Optional. Routing configuration. $ref: >- @@ -12655,6 +15213,48 @@ components: Optional. If enabled, audio timestamp will be included in the request to the model. type: boolean + responseModalities: + description: Optional. The modalities of the response. + type: array + items: + type: string + enumDescriptions: + - Unspecified modality. Will be processed as text. + - Text modality. + - Image modality. + - Audio modality. + enum: + - MODALITY_UNSPECIFIED + - TEXT + - IMAGE + - AUDIO + mediaResolution: + description: Optional. If specified, the media resolution specified will be used. + type: string + enumDescriptions: + - Media resolution has not been set. + - Media resolution set to low (64 tokens). + - Media resolution set to medium (256 tokens). + - Media resolution set to high (zoomed reframing with 256 tokens). + enum: + - MEDIA_RESOLUTION_UNSPECIFIED + - MEDIA_RESOLUTION_LOW + - MEDIA_RESOLUTION_MEDIUM + - MEDIA_RESOLUTION_HIGH + speechConfig: + description: Optional. The speech generation config. + $ref: '#/components/schemas/GoogleCloudAiplatformV1SpeechConfig' + thinkingConfig: + description: >- + Optional. Config for thinking features. An error will be returned if + this field is set for models that don't support thinking. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerationConfigThinkingConfig + enableAffectiveDialog: + description: >- + Optional. If enabled, the model will detect emotions and adapt its + responses accordingly. + type: boolean GoogleCloudAiplatformV1GenerationConfigRoutingConfig: id: GoogleCloudAiplatformV1GenerationConfigRoutingConfig description: The configuration for routing the request to a specific model. @@ -12696,9 +15296,53 @@ components: properties: modelName: description: >- - The model name to use. Only the public LLM models are accepted. e.g. - 'gemini-1.5-pro-001'. + The model name to use. Only the public LLM models are accepted. See + [Supported + models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). type: string + GoogleCloudAiplatformV1SpeechConfig: + id: GoogleCloudAiplatformV1SpeechConfig + description: The speech generation config. + type: object + properties: + voiceConfig: + description: The configuration for the speaker to use. + $ref: '#/components/schemas/GoogleCloudAiplatformV1VoiceConfig' + languageCode: + description: >- + Optional. Language code (ISO 639. e.g. en-US) for the speech + synthesization. + type: string + GoogleCloudAiplatformV1VoiceConfig: + id: GoogleCloudAiplatformV1VoiceConfig + description: The configuration for the voice to use. + type: object + properties: + prebuiltVoiceConfig: + description: The configuration for the prebuilt voice to use. + $ref: '#/components/schemas/GoogleCloudAiplatformV1PrebuiltVoiceConfig' + GoogleCloudAiplatformV1PrebuiltVoiceConfig: + id: GoogleCloudAiplatformV1PrebuiltVoiceConfig + description: The configuration for the prebuilt speaker to use. + type: object + properties: + voiceName: + description: The name of the preset voice to use. + type: string + GoogleCloudAiplatformV1GenerationConfigThinkingConfig: + id: GoogleCloudAiplatformV1GenerationConfigThinkingConfig + description: Config for thinking features. + type: object + properties: + includeThoughts: + description: >- + Optional. Indicates whether to include thoughts in the response. If + true, thoughts are returned only when available. + type: boolean + thinkingBudget: + description: Optional. Indicates the thinking budget in tokens. + type: integer + format: int32 GoogleCloudAiplatformV1GenerateContentResponse: id: GoogleCloudAiplatformV1GenerateContentResponse description: Response message for [PredictionService.GenerateContent]. @@ -12714,6 +15358,17 @@ components: description: Output only. The model version used to generate the response. readOnly: true type: string + createTime: + description: Output only. Timestamp when the request is made to the server. + readOnly: true + type: string + format: google-datetime + responseId: + description: >- + Output only. response_id is used to identify each response. It is + the encoding of the event_id. + readOnly: true + type: string promptFeedback: description: >- Output only. Content filter results for a prompt sent in the @@ -12779,6 +15434,16 @@ components: Token generation stopped because the content potentially contains Sensitive Personally Identifiable Information (SPII). - The function call generated by the model is invalid. + - The model response was blocked by Model Armor. + - >- + Token generation stopped because generated images has safety + violations. + - >- + Image generation stopped because generated images has other + prohibited content. + - Image generation stopped due to recitation. + - Image generation stopped because of other miscellaneous issue. + - The tool call generated by the model is invalid. enum: - FINISH_REASON_UNSPECIFIED - STOP @@ -12790,6 +15455,12 @@ components: - PROHIBITED_CONTENT - SPII - MALFORMED_FUNCTION_CALL + - MODEL_ARMOR + - IMAGE_SAFETY + - IMAGE_PROHIBITED_CONTENT + - IMAGE_RECITATION + - IMAGE_OTHER + - UNEXPECTED_TOOL_CALL safetyRatings: description: >- Output only. List of ratings for the safety of a response candidate. @@ -12814,6 +15485,10 @@ components: content. readOnly: true $ref: '#/components/schemas/GoogleCloudAiplatformV1GroundingMetadata' + urlContextMetadata: + description: Output only. Metadata related to url context retrieval tool. + readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1UrlContextMetadata' GoogleCloudAiplatformV1LogprobsResult: id: GoogleCloudAiplatformV1LogprobsResult description: Logprobs Result @@ -12875,7 +15550,24 @@ components: - The harm category is dangerous content. - The harm category is harassment. - The harm category is sexually explicit content. - - The harm category is civic integrity. + - >- + Deprecated: Election filter is not longer supported. The harm + category is civic integrity. + - The harm category is image hate. + - The harm category is image dangerous content. + - The harm category is image harassment. + - The harm category is image sexually explicit content. + enumDeprecated: + - false + - false + - false + - false + - false + - true + - false + - false + - false + - false enum: - HARM_CATEGORY_UNSPECIFIED - HARM_CATEGORY_HATE_SPEECH @@ -12883,6 +15575,10 @@ components: - HARM_CATEGORY_HARASSMENT - HARM_CATEGORY_SEXUALLY_EXPLICIT - HARM_CATEGORY_CIVIC_INTEGRITY + - HARM_CATEGORY_IMAGE_HATE + - HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT + - HARM_CATEGORY_IMAGE_HARASSMENT + - HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT probability: description: Output only. Harm probability levels in the content. readOnly: true @@ -12931,6 +15627,28 @@ components: of this rating. readOnly: true type: boolean + overwrittenThreshold: + description: >- + Output only. The overwritten threshold for the safety category of + Gemini 2.0 image out. If minors are detected in the output image, + the threshold of each safety category will be overwritten if user + sets a lower threshold. + readOnly: true + type: string + enumDescriptions: + - Unspecified harm block threshold. + - Block low threshold and above (i.e. block more). + - Block medium threshold and above. + - Block only high threshold (i.e. block less). + - Block none. + - Turn off the safety filter. + enum: + - HARM_BLOCK_THRESHOLD_UNSPECIFIED + - BLOCK_LOW_AND_ABOVE + - BLOCK_MEDIUM_AND_ABOVE + - BLOCK_ONLY_HIGH + - BLOCK_NONE + - 'OFF' GoogleCloudAiplatformV1CitationMetadata: id: GoogleCloudAiplatformV1CitationMetadata description: A collection of source attributions for a piece of content. @@ -13035,6 +15753,14 @@ components: description: Optional. Output only. Retrieval metadata. readOnly: true $ref: '#/components/schemas/GoogleCloudAiplatformV1RetrievalMetadata' + googleMapsWidgetContextToken: + description: >- + Optional. Output only. Resource name of the Google Maps widget + context token to be used with the PlacesContextElement widget to + render contextual data. This is populated only for Google Maps + grounding. + readOnly: true + type: string GoogleCloudAiplatformV1SearchEntryPoint: id: GoogleCloudAiplatformV1SearchEntryPoint description: Google search entry point. @@ -13061,6 +15787,9 @@ components: description: Grounding chunk from context retrieved by the retrieval tools. $ref: >- #/components/schemas/GoogleCloudAiplatformV1GroundingChunkRetrievedContext + maps: + description: Grounding chunk from Google Maps. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GroundingChunkMaps' GoogleCloudAiplatformV1GroundingChunkWeb: id: GoogleCloudAiplatformV1GroundingChunkWeb description: Chunk from the web. @@ -13072,11 +15801,19 @@ components: title: description: Title of the chunk. type: string + domain: + description: Domain of the (original) URI. + type: string GoogleCloudAiplatformV1GroundingChunkRetrievedContext: id: GoogleCloudAiplatformV1GroundingChunkRetrievedContext description: Chunk from context retrieved by the retrieval tools. type: object properties: + ragChunk: + description: >- + Additional context for the RAG retrieval result. This is only + populated when using the RAG retrieval tool. + $ref: '#/components/schemas/GoogleCloudAiplatformV1RagChunk' uri: description: URI reference of the attribution. type: string @@ -13086,6 +15823,121 @@ components: text: description: Text of the attribution. type: string + documentName: + description: >- + Output only. The full document name for the referenced Vertex AI + Search document. + readOnly: true + type: string + GoogleCloudAiplatformV1RagChunk: + id: GoogleCloudAiplatformV1RagChunk + description: >- + A RagChunk includes the content of a chunk of a RagFile, and associated + metadata. + type: object + properties: + text: + description: The content of the chunk. + type: string + pageSpan: + description: >- + If populated, represents where the chunk starts and ends in the + document. + $ref: '#/components/schemas/GoogleCloudAiplatformV1RagChunkPageSpan' + GoogleCloudAiplatformV1RagChunkPageSpan: + id: GoogleCloudAiplatformV1RagChunkPageSpan + description: Represents where the chunk starts and ends in the document. + type: object + properties: + firstPage: + description: Page where chunk starts in the document. Inclusive. 1-indexed. + type: integer + format: int32 + lastPage: + description: Page where chunk ends in the document. Inclusive. 1-indexed. + type: integer + format: int32 + GoogleCloudAiplatformV1GroundingChunkMaps: + id: GoogleCloudAiplatformV1GroundingChunkMaps + description: Chunk from Google Maps. + type: object + properties: + uri: + description: URI reference of the chunk. + type: string + title: + description: Title of the chunk. + type: string + text: + description: Text of the chunk. + type: string + placeId: + description: >- + This Place's resource name, in `places/{place_id}` format. Can be + used to look up the Place. + type: string + placeAnswerSources: + description: >- + Sources used to generate the place answer. This includes review + snippets and photos that were used to generate the answer, as well + as uris to flag content. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSources + GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSources: + id: GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSources + description: Sources used to generate the place answer. + type: object + properties: + reviewSnippets: + description: Snippets of reviews that are used to generate the answer. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet + flagContentUri: + description: A link where users can flag a problem with the generated answer. + type: string + GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet: + id: GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet + description: Encapsulates a review snippet. + type: object + properties: + review: + description: >- + A reference representing this place review which may be used to look + up this place review again. + type: string + authorAttribution: + description: This review's author. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution + relativePublishTimeDescription: + description: >- + A string of formatted recent time, expressing the review time + relative to the current time in a form appropriate for the language + and country. + type: string + flagContentUri: + description: A link where users can flag a problem with the review. + type: string + googleMapsUri: + description: A link to show the review on Google Maps. + type: string + GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution: + id: >- + GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution + description: Author attribution for a photo or review. + type: object + properties: + displayName: + description: Name of the author of the Photo or Review. + type: string + uri: + description: URI of the author of the Photo or Review. + type: string + photoUri: + description: Profile photo URI of the author of the Photo or Review. + type: string GoogleCloudAiplatformV1GroundingSupport: id: GoogleCloudAiplatformV1GroundingSupport description: Grounding support. @@ -13107,8 +15959,9 @@ components: confidenceScores: description: >- Confidence score of the support references. Ranges from 0 to 1. 1 is - the most confident. This list must have the same size as the - grounding_chunk_indices. + the most confident. For Gemini 2.0 and before, this list must have + the same size as the grounding_chunk_indices. For Gemini 2.5 and + after, this list will be empty and should be ignored. type: array items: type: number @@ -13160,6 +16013,36 @@ components: to trigger Google Search. type: number format: float + GoogleCloudAiplatformV1UrlContextMetadata: + id: GoogleCloudAiplatformV1UrlContextMetadata + description: Metadata related to url context retrieval tool. + type: object + properties: + urlMetadata: + description: Output only. List of url context. + readOnly: true + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1UrlMetadata' + GoogleCloudAiplatformV1UrlMetadata: + id: GoogleCloudAiplatformV1UrlMetadata + description: Context of the a single url retrieval. + type: object + properties: + retrievedUrl: + description: Retrieved url by the tool. + type: string + urlRetrievalStatus: + description: Status of the url retrieval. + type: string + enumDescriptions: + - Default value. This value is unused. + - Url retrieval is successful. + - Url retrieval is failed due to error. + enum: + - URL_RETRIEVAL_STATUS_UNSPECIFIED + - URL_RETRIEVAL_STATUS_SUCCESS + - URL_RETRIEVAL_STATUS_ERROR GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback: id: GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback description: Content filter results for a prompt sent in the request. @@ -13177,12 +16060,16 @@ components: Candidates blocked due to the terms which are included from the terminology blocklist. - Candidates blocked due to prohibited content. + - The user prompt was blocked by Model Armor. + - Candidates blocked due to unsafe image generation content. enum: - BLOCKED_REASON_UNSPECIFIED - SAFETY - OTHER - BLOCKLIST - PROHIBITED_CONTENT + - MODEL_ARMOR + - IMAGE_SAFETY safetyRatings: description: Output only. Safety ratings. readOnly: true @@ -13209,8 +16096,97 @@ components: description: Number of tokens in the response(s). type: integer format: int32 + toolUsePromptTokenCount: + description: Output only. Number of tokens present in tool-use prompt(s). + readOnly: true + type: integer + format: int32 + thoughtsTokenCount: + description: Output only. Number of tokens present in thoughts output. + readOnly: true + type: integer + format: int32 totalTokenCount: - description: Total token count for prompt and response candidates. + description: >- + Total token count for prompt, response candidates, and tool-use + prompts (if present). + type: integer + format: int32 + cachedContentTokenCount: + description: >- + Output only. Number of tokens in the cached part in the input (the + cached content). + readOnly: true + type: integer + format: int32 + promptTokensDetails: + description: >- + Output only. List of modalities that were processed in the request + input. + readOnly: true + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModalityTokenCount' + cacheTokensDetails: + description: >- + Output only. List of modalities of the cached content in the request + input. + readOnly: true + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModalityTokenCount' + candidatesTokensDetails: + description: Output only. List of modalities that were returned in the response. + readOnly: true + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModalityTokenCount' + toolUsePromptTokensDetails: + description: >- + Output only. List of modalities that were processed for tool-use + request inputs. + readOnly: true + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModalityTokenCount' + trafficType: + description: >- + Output only. Traffic type. This shows whether a request consumes + Pay-As-You-Go or Provisioned Throughput quota. + readOnly: true + type: string + enumDescriptions: + - Unspecified request traffic type. + - Type for Pay-As-You-Go traffic. + - Type for Provisioned Throughput traffic. + enum: + - TRAFFIC_TYPE_UNSPECIFIED + - ON_DEMAND + - PROVISIONED_THROUGHPUT + GoogleCloudAiplatformV1ModalityTokenCount: + id: GoogleCloudAiplatformV1ModalityTokenCount + description: Represents token counting info for a single modality. + type: object + properties: + modality: + description: The modality associated with this token count. + type: string + enumDescriptions: + - Unspecified modality. + - Plain text. + - Image. + - Video. + - Audio. + - Document, e.g. PDF. + enum: + - MODALITY_UNSPECIFIED + - TEXT + - IMAGE + - VIDEO + - AUDIO + - DOCUMENT + tokenCount: + description: Number of tokens. type: integer format: int32 GoogleCloudAiplatformV1CountTokensRequest: @@ -13274,6 +16250,14 @@ components: from the request. type: integer format: int32 + promptTokensDetails: + description: >- + Output only. List of modalities that were processed in the request + input. + readOnly: true + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModalityTokenCount' GoogleCloudAiplatformV1ComputeTokensRequest: id: GoogleCloudAiplatformV1ComputeTokensRequest description: Request message for ComputeTokens RPC call. @@ -14510,6 +17494,9 @@ components: versionDescription: description: The description of this version. type: string + defaultCheckpointId: + description: The default checkpoint id of a model version. + type: string predictSchemata: description: >- The schemata that describe formats of the Model's predictions and @@ -14742,6 +17729,12 @@ components: description: Output only. Reserved for future use. readOnly: true type: boolean + checkpoints: + description: Optional. Output only. The checkpoints of the model. + readOnly: true + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Checkpoint' GoogleCloudAiplatformV1ModelExportFormat: id: GoogleCloudAiplatformV1ModelExportFormat description: >- @@ -14758,7 +17751,8 @@ components: A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript. * `core-ml` Used for iOS mobile devices. * `custom-trained` A Model that was - uploaded or trained by custom code. + uploaded or trained by custom code. * `genie` A tuned Model Garden + model. readOnly: true type: string exportableContents: @@ -14889,6 +17883,12 @@ components: publicModelName: description: Required. The model garden source model resource name. type: string + versionId: + description: Optional. The model garden source model version ID. + type: string + skipHfModelCache: + description: Optional. Whether to avoid pulling the model from the HF cache. + type: boolean GoogleCloudAiplatformV1GenieSource: id: GoogleCloudAiplatformV1GenieSource description: >- @@ -14899,6 +17899,22 @@ components: baseModelUri: description: Required. The public base model URI. type: string + GoogleCloudAiplatformV1Checkpoint: + id: GoogleCloudAiplatformV1Checkpoint + description: Describes the machine learning model version checkpoint. + type: object + properties: + checkpointId: + description: The ID of the checkpoint. + type: string + epoch: + description: The epoch of the checkpoint. + type: string + format: int64 + step: + description: The step of the checkpoint. + type: string + format: int64 GoogleCloudAiplatformV1ListModelsResponse: id: GoogleCloudAiplatformV1ListModelsResponse description: Response message for ModelService.ListModels @@ -14931,6 +17947,38 @@ components: A token to retrieve the next page of results. Pass to ListModelVersionsRequest.page_token to obtain that page. type: string + GoogleCloudAiplatformV1ListModelVersionCheckpointsResponse: + id: GoogleCloudAiplatformV1ListModelVersionCheckpointsResponse + description: Response message for ModelService.ListModelVersionCheckpoints + type: object + properties: + checkpoints: + description: List of Model Version checkpoints. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelVersionCheckpoint' + nextPageToken: + description: >- + A token to retrieve the next page of results. Pass to + ListModelVersionCheckpointsRequest.page_token to obtain that page. + type: string + GoogleCloudAiplatformV1ModelVersionCheckpoint: + id: GoogleCloudAiplatformV1ModelVersionCheckpoint + deprecated: true + description: Describes the machine learning model version checkpoint. + type: object + properties: + checkpointId: + description: The ID of the checkpoint. + type: string + epoch: + description: The epoch of the checkpoint. + type: string + format: int64 + step: + description: The step of the checkpoint. + type: string + format: int64 GoogleCloudAiplatformV1UpdateExplanationDatasetRequest: id: GoogleCloudAiplatformV1UpdateExplanationDatasetRequest description: Request message for ModelService.UpdateExplanationDataset. @@ -15577,8 +18625,12 @@ components: description: The description of the NotebookRuntimeTemplate. type: string isDefault: - description: Output only. The default template to use if not specified. + description: >- + Output only. Deprecated: This field has no behavior. Use + notebook_runtime_type = 'ONE_CLICK' instead. The default template to + use if not specified. readOnly: true + deprecated: true type: boolean machineSpec: description: >- @@ -15595,12 +18647,20 @@ components: $ref: '#/components/schemas/GoogleCloudAiplatformV1NetworkSpec' serviceAccount: description: >- - The service account that the runtime workload runs as. You can use - any service account within the same project, but you must have the - service account user permission to use the instance. If not - specified, the [Compute Engine default service + Deprecated: This field is ignored and the "Vertex AI Notebook + Service Account" + (service-PROJECT_NUMBER@gcp-sa-aiplatform-vm.iam.gserviceaccount.com) + is used for the runtime workload identity. See + https://cloud.google.com/iam/docs/service-agents#vertex-ai-notebook-service-account + for more details. For NotebookExecutionJob, use + NotebookExecutionJob.service_account instead. The service account + that the runtime workload runs as. You can use any service account + within the same project, but you must have the service account user + permission to use the instance. If not specified, the [Compute + Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. + deprecated: true type: string etag: description: >- @@ -15664,9 +18724,18 @@ components: type: array items: type: string + reservationAffinity: + description: Optional. Reservation Affinity of the notebook runtime template. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NotebookReservationAffinity encryptionSpec: description: Customer-managed encryption key spec for the notebook runtime. $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + softwareConfig: + description: >- + Optional. The notebook software configuration of the notebook + runtime. + $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookSoftwareConfig' GoogleCloudAiplatformV1PersistentDiskSpec: id: GoogleCloudAiplatformV1PersistentDiskSpec description: Represents the spec of persistent disk options. @@ -15758,6 +18827,111 @@ components: components, and halting the boot process if signature verification fails. type: boolean + GoogleCloudAiplatformV1NotebookReservationAffinity: + id: GoogleCloudAiplatformV1NotebookReservationAffinity + description: Notebook Reservation Affinity for consuming Zonal reservation. + type: object + properties: + consumeReservationType: + description: >- + Required. Specifies the type of reservation from which this instance + can consume resources: RESERVATION_ANY (default), + RESERVATION_SPECIFIC, or RESERVATION_NONE. See Consuming reserved + instances for examples. + type: string + enumDescriptions: + - Default type. + - Do not consume from any allocated capacity. + - Consume any reservation available. + - >- + Must consume from a specific reservation. Must specify key value + fields for specifying the reservations. + enum: + - RESERVATION_AFFINITY_TYPE_UNSPECIFIED + - RESERVATION_NONE + - RESERVATION_ANY + - RESERVATION_SPECIFIC + key: + description: >- + Optional. Corresponds to the label key of a reservation resource. To + target a RESERVATION_SPECIFIC by name, use + compute.googleapis.com/reservation-name as the key and specify the + name of your reservation as its value. + type: string + values: + description: >- + Optional. Corresponds to the label values of a reservation resource. + This must be the full path name of Reservation. + type: array + items: + type: string + GoogleCloudAiplatformV1NotebookSoftwareConfig: + id: GoogleCloudAiplatformV1NotebookSoftwareConfig + description: >- + Notebook Software Config. This is passed to the backend when user makes + software configurations in UI. + type: object + properties: + colabImage: + description: Optional. Google-managed NotebookRuntime colab image. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ColabImage' + env: + description: >- + Optional. Environment variables to be passed to the container. + Maximum limit is 100. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EnvVar' + postStartupScriptConfig: + description: Optional. Post startup script config. + $ref: '#/components/schemas/GoogleCloudAiplatformV1PostStartupScriptConfig' + GoogleCloudAiplatformV1ColabImage: + id: GoogleCloudAiplatformV1ColabImage + description: Colab image of the runtime. + type: object + properties: + releaseName: + description: >- + Optional. The release name of the NotebookRuntime Colab image, e.g. + "py310". If not specified, detault to the latest release. + type: string + description: + description: >- + Output only. A human-readable description of the specified colab + image release, populated by the system. Example: "Python 3.10", + "Latest - current Python 3.11" + readOnly: true + type: string + GoogleCloudAiplatformV1PostStartupScriptConfig: + id: GoogleCloudAiplatformV1PostStartupScriptConfig + description: Post startup script config. + type: object + properties: + postStartupScript: + description: Optional. Post startup script to run after runtime is started. + type: string + postStartupScriptUrl: + description: >- + Optional. Post startup script url to download. Example: + `gs://bucket/script.sh` + type: string + postStartupScriptBehavior: + description: >- + Optional. Post startup script behavior that defines download and + execution behavior. + type: string + enumDescriptions: + - Unspecified post startup script behavior. + - Run post startup script after runtime is started. + - Run post startup script after runtime is stopped. + - >- + Download and run post startup script every time runtime is + started. + enum: + - POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED + - RUN_ONCE + - RUN_EVERY_START + - DOWNLOAD_AND_RUN_EVERY_START GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse: id: GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse description: Response message for NotebookService.ListNotebookRuntimeTemplates. @@ -15797,8 +18971,9 @@ components: id: GoogleCloudAiplatformV1NotebookRuntime description: >- A runtime is a virtual machine allocated to a particular user for a - particular Notebook file on temporary basis with lifetime limited to 24 - hours. + particular Notebook file on temporary basis with lifetime. Default + runtimes have a lifetime of 18 hours, while custom runtimes last for 6 + months from their creation or last upgrade. type: object properties: name: @@ -15853,8 +19028,13 @@ components: type: string serviceAccount: description: >- - Output only. The service account that the NotebookRuntime workload - runs as. + Output only. Deprecated: This field is no longer used and the + "Vertex AI Notebook Service Account" + (service-PROJECT_NUMBER@gcp-sa-aiplatform-vm.iam.gserviceaccount.com) + is used for the runtime workload identity. See + https://cloud.google.com/iam/docs/service-agents#vertex-ai-notebook-service-account + for more details. The service account that the NotebookRuntime + workload runs as. readOnly: true type: string runtimeState: @@ -15864,7 +19044,9 @@ components: enumDescriptions: - Unspecified runtime state. - NotebookRuntime is in running state. - - NotebookRuntime is in starting state. + - >- + NotebookRuntime is in starting state. This is when the runtime is + being started from a stopped state. - NotebookRuntime is in stopping state. - NotebookRuntime is in stopped state. - >- @@ -15935,6 +19117,22 @@ components: - NOTEBOOK_RUNTIME_TYPE_UNSPECIFIED - USER_DEFINED - ONE_CLICK + machineSpec: + description: >- + Output only. The specification of a single machine used by the + notebook runtime. + readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1MachineSpec' + dataPersistentDiskSpec: + description: >- + Output only. The specification of persistent disk attached to the + notebook runtime as data disk storage. + readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1PersistentDiskSpec' + networkSpec: + description: Output only. Network spec of the notebook runtime. + readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1NetworkSpec' idleShutdownConfig: description: >- Output only. The idle shutdown configuration of the notebook @@ -15942,6 +19140,14 @@ components: readOnly: true $ref: >- #/components/schemas/GoogleCloudAiplatformV1NotebookIdleShutdownConfig + eucConfig: + description: Output only. EUC configuration of the notebook runtime. + readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookEucConfig' + shieldedVmConfig: + description: Output only. Runtime Shielded VM spec. + readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1ShieldedVmConfig' networkTags: description: >- Optional. The Compute Engine tags to add to runtime (see [Tagging @@ -15949,6 +19155,15 @@ components: type: array items: type: string + reservationAffinity: + description: Output only. Reservation Affinity of the notebook runtime. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NotebookReservationAffinity + softwareConfig: + description: Output only. Software config of the notebook runtime. + readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookSoftwareConfig' encryptionSpec: description: >- Output only. Customer-managed encryption key spec for the notebook @@ -16042,6 +19257,12 @@ components: serviceAccount: description: The service account to run the execution as. type: string + workbenchRuntime: + description: >- + The Workbench runtime configuration to use for the notebook + execution. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntime name: description: >- Output only. The resource name of this NotebookExecutionJob. Format: @@ -16061,10 +19282,8 @@ components: format: google-duration scheduleResourceName: description: >- - Output only. The Schedule resource name if this job is triggered by - one. Format: + The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}` - readOnly: true type: string jobState: description: Output only. The state of the NotebookExecutionJob. @@ -16136,11 +19355,16 @@ components: type: object additionalProperties: type: string + kernelName: + description: >- + The name of the kernel to use during notebook execution. If unset, + the default kernel is used. + type: string encryptionSpec: description: >- Customer-managed encryption key spec for the notebook execution job. - This field is auto-populated if the - NotebookService.NotebookRuntimeTemplate has an encryption spec. + This field is auto-populated if the NotebookRuntimeTemplate has an + encryption spec. $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource: id: GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource @@ -16198,6 +19422,11 @@ components: networkSpec: description: The network configuration to use for the execution job. $ref: '#/components/schemas/GoogleCloudAiplatformV1NetworkSpec' + GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntime: + id: GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntime + description: Configuration for a Workbench Instances-based environment. + type: object + properties: {} GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse: id: GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse description: Response message for [NotebookService.CreateNotebookExecutionJob] @@ -16211,7 +19440,7 @@ components: nextPageToken: description: >- A token to retrieve next page of results. Pass to - ListNotebookExecutionJobs.page_token to obtain that page. + ListNotebookExecutionJobsRequest.page_token to obtain that page. type: string GoogleCloudAiplatformV1PersistentResource: id: GoogleCloudAiplatformV1PersistentResource @@ -16319,6 +19548,9 @@ components: this field is left unspecified, the resources aren't peered with any network. type: string + pscInterfaceConfig: + description: Optional. Configuration for PSC-I for PersistentResource. + $ref: '#/components/schemas/GoogleCloudAiplatformV1PscInterfaceConfig' encryptionSpec: description: >- Optional. Customer-managed encryption key spec for a @@ -17142,6 +20374,9 @@ components: type: array items: type: string + pscInterfaceConfig: + description: Optional. Configuration for PSC-I for PipelineJob. + $ref: '#/components/schemas/GoogleCloudAiplatformV1PscInterfaceConfig' templateUri: description: >- A template uri from where the PipelineJob.pipeline_spec, if empty, @@ -17290,6 +20525,17 @@ components: additionalProperties: $ref: >- #/components/schemas/GoogleCloudAiplatformV1PipelineTaskDetailArtifactList + taskUniqueName: + description: >- + Output only. The unique name of a task. This field is used by rerun + pipeline job. Console UI and Vertex AI SDK will support triggering + pipeline job reruns. The name is constructed by concatenating all + the parent tasks name with the task name. For example, if a task + named "child_task" has a parent task named "parent_task_1" and + parent task 1 has a parent task named "parent_task_2", the task + unique name will be "parent_task_2.parent_task_1.child_task". + readOnly: true + type: string GoogleCloudAiplatformV1PipelineTaskExecutorDetail: id: GoogleCloudAiplatformV1PipelineTaskExecutorDetail description: The runtime detail of a pipeline executor. @@ -17579,6 +20825,264 @@ components: type: array items: type: string + GoogleCloudAiplatformV1QueryReasoningEngineRequest: + id: GoogleCloudAiplatformV1QueryReasoningEngineRequest + description: Request message for ReasoningEngineExecutionService.Query. + type: object + properties: + input: + description: >- + Optional. Input content provided by users in JSON object format. + Examples include text query, function calling parameters, media + bytes, etc. + type: object + additionalProperties: + type: any + description: Properties of the object. + classMethod: + description: >- + Optional. Class method to be used for the query. It is optional and + defaults to "query" if unspecified. + type: string + GoogleCloudAiplatformV1QueryReasoningEngineResponse: + id: GoogleCloudAiplatformV1QueryReasoningEngineResponse + description: Response message for ReasoningEngineExecutionService.Query + type: object + properties: + output: + description: Response provided by users in JSON object format. + type: any + GoogleCloudAiplatformV1StreamQueryReasoningEngineRequest: + id: GoogleCloudAiplatformV1StreamQueryReasoningEngineRequest + description: Request message for ReasoningEngineExecutionService.StreamQuery. + type: object + properties: + input: + description: >- + Optional. Input content provided by users in JSON object format. + Examples include text query, function calling parameters, media + bytes, etc. + type: object + additionalProperties: + type: any + description: Properties of the object. + classMethod: + description: >- + Optional. Class method to be used for the stream query. It is + optional and defaults to "stream_query" if unspecified. + type: string + GoogleCloudAiplatformV1ReasoningEngine: + id: GoogleCloudAiplatformV1ReasoningEngine + description: >- + ReasoningEngine provides a customizable runtime for models to determine + which actions to take and in which order. + type: object + properties: + name: + description: >- + Identifier. The resource name of the ReasoningEngine. Format: + `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` + type: string + displayName: + description: Required. The display name of the ReasoningEngine. + type: string + description: + description: Optional. The description of the ReasoningEngine. + type: string + spec: + description: Optional. Configurations of the ReasoningEngine + $ref: '#/components/schemas/GoogleCloudAiplatformV1ReasoningEngineSpec' + createTime: + description: Output only. Timestamp when this ReasoningEngine was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: >- + Output only. Timestamp when this ReasoningEngine was most recently + updated. + readOnly: true + type: string + format: google-datetime + etag: + description: >- + Optional. Used to perform consistent read-modify-write updates. If + not set, a blind "overwrite" update happens. + type: string + encryptionSpec: + description: >- + Customer-managed encryption key spec for a ReasoningEngine. If set, + this ReasoningEngine and all sub-resources of this ReasoningEngine + will be secured by this key. + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + GoogleCloudAiplatformV1ReasoningEngineSpec: + id: GoogleCloudAiplatformV1ReasoningEngineSpec + description: ReasoningEngine configurations + type: object + properties: + serviceAccount: + description: >- + Optional. The service account that the Reasoning Engine artifact + runs as. It should have "roles/storage.objectViewer" for reading the + user project's Cloud Storage and "roles/aiplatform.user" for using + Vertex extensions. If not specified, the Vertex AI Reasoning Engine + Service Agent in the project will be used. + type: string + packageSpec: + description: >- + Optional. User provided package spec of the ReasoningEngine. Ignored + when users directly specify a deployment image through + `deployment_spec.first_party_image_override`, but keeping the + field_behavior to avoid introducing breaking changes. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReasoningEngineSpecPackageSpec + deploymentSpec: + description: Optional. The specification of a Reasoning Engine deployment. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpec + classMethods: + description: >- + Optional. Declarations for object class methods in OpenAPI + specification format. + type: array + items: + type: object + additionalProperties: + type: any + description: Properties of the object. + agentFramework: + description: >- + Optional. The OSS agent framework used to develop the agent. + Currently supported values: "google-adk", "langchain", "langgraph", + "ag2", "llama-index", "custom". + type: string + GoogleCloudAiplatformV1ReasoningEngineSpecPackageSpec: + id: GoogleCloudAiplatformV1ReasoningEngineSpecPackageSpec + description: User provided package spec like pickled object and package requirements. + type: object + properties: + pickleObjectGcsUri: + description: Optional. The Cloud Storage URI of the pickled python object. + type: string + dependencyFilesGcsUri: + description: >- + Optional. The Cloud Storage URI of the dependency files in tar.gz + format. + type: string + requirementsGcsUri: + description: Optional. The Cloud Storage URI of the `requirements.txt` file + type: string + pythonVersion: + description: >- + Optional. The Python version. Currently support 3.8, 3.9, 3.10, + 3.11. If not specified, default value is 3.10. + type: string + GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpec: + id: GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpec + description: The specification of a Reasoning Engine deployment. + type: object + properties: + env: + description: >- + Optional. Environment variables to be set with the Reasoning Engine + deployment. The environment variables can be updated through the + UpdateReasoningEngine API. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EnvVar' + secretEnv: + description: >- + Optional. Environment variables where the value is a secret in Cloud + Secret Manager. To use this feature, add 'Secret Manager Secret + Accessor' role (roles/secretmanager.secretAccessor) to AI Platform + Reasoning Engine Service Agent. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SecretEnvVar' + pscInterfaceConfig: + description: Optional. Configuration for PSC-I. + $ref: '#/components/schemas/GoogleCloudAiplatformV1PscInterfaceConfig' + minInstances: + description: >- + Optional. The minimum number of application instances that will be + kept running at all times. Defaults to 1. Range: [0, 10]. + type: integer + format: int32 + maxInstances: + description: >- + Optional. The maximum number of application instances that can be + launched to handle increased traffic. Defaults to 100. Range: [1, + 1000]. If VPC-SC or PSC-I is enabled, the acceptable range is [1, + 100]. + type: integer + format: int32 + resourceLimits: + description: >- + Optional. Resource limits for each container. Only 'cpu' and + 'memory' keys are supported. Defaults to {"cpu": "4", "memory": + "4Gi"}. * The only supported values for CPU are '1', '2', '4', '6' + and '8'. For more information, go to + https://cloud.google.com/run/docs/configuring/cpu. * The only + supported values for memory are '1Gi', '2Gi', ... '32 Gi'. * For + required cpu on different memory values, go to + https://cloud.google.com/run/docs/configuring/memory-limits + type: object + additionalProperties: + type: string + containerConcurrency: + description: >- + Optional. Concurrency for each container and agent server. + Recommended value: 2 * cpu + 1. Defaults to 9. + type: integer + format: int32 + GoogleCloudAiplatformV1SecretEnvVar: + id: GoogleCloudAiplatformV1SecretEnvVar + description: >- + Represents an environment variable where the value is a secret in Cloud + Secret Manager. + type: object + properties: + name: + description: Required. Name of the secret environment variable. + type: string + secretRef: + description: >- + Required. Reference to a secret stored in the Cloud Secret Manager + that will provide the value for this environment variable. + $ref: '#/components/schemas/GoogleCloudAiplatformV1SecretRef' + GoogleCloudAiplatformV1SecretRef: + id: GoogleCloudAiplatformV1SecretRef + description: >- + Reference to a secret stored in the Cloud Secret Manager that will + provide the value for this environment variable. + type: object + properties: + secret: + description: >- + Required. The name of the secret in Cloud Secret Manager. Format: + {secret_name}. + type: string + version: + description: >- + The Cloud Secret Manager secret version. Can be 'latest' for the + latest version, an integer for a specific version, or a version + alias. + type: string + GoogleCloudAiplatformV1ListReasoningEnginesResponse: + id: GoogleCloudAiplatformV1ListReasoningEnginesResponse + description: Response message for ReasoningEngineService.ListReasoningEngines + type: object + properties: + reasoningEngines: + description: List of ReasoningEngines in the requested page. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ReasoningEngine' + nextPageToken: + description: >- + A token to retrieve the next page of results. Pass to + ListReasoningEnginesRequest.page_token to obtain that page. + type: string GoogleCloudAiplatformV1Schedule: id: GoogleCloudAiplatformV1Schedule description: >- @@ -19027,6 +22531,17 @@ components: resourceDescription: description: Optional. Description of the resource. type: string + supportsWorkbench: + description: >- + Optional. For notebook resource, whether the notebook supports + Workbench. + type: boolean + colabNotebookDisabled: + description: >- + Optional. For notebook resource. When set to true, the Colab + Enterprise link will be disabled in the "open notebook" dialog in + UI. + type: boolean GoogleCloudAiplatformV1PublisherModelResourceReference: id: GoogleCloudAiplatformV1PublisherModelResourceReference description: Reference to a resource. @@ -19175,239 +22690,1415 @@ components: type: array items: type: string - GoogleCloudAiplatformV1AssignNotebookRuntimeOperationMetadata: - id: GoogleCloudAiplatformV1AssignNotebookRuntimeOperationMetadata - description: Metadata information for NotebookService.AssignNotebookRuntime. + GoogleCloudAiplatformV1DeployRequest: + id: GoogleCloudAiplatformV1DeployRequest + description: Request message for ModelGardenService.Deploy. type: object properties: - genericMetadata: - description: The operation generic information. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - progressMessage: + publisherModelName: description: >- - A human-readable message that shows the intermediate progress - details of NotebookRuntime. + The Model Garden model to deploy. Format: + `publishers/{publisher}/models/{publisher_model}@{version_id}`, or + `publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001`. type: string - GoogleCloudAiplatformV1GenericOperationMetadata: - id: GoogleCloudAiplatformV1GenericOperationMetadata - description: Generic Metadata shared by all operations. + huggingFaceModelId: + description: >- + The Hugging Face model to deploy. Format: Hugging Face model ID like + `google/gemma-2-2b-it`. + type: string + modelConfig: + description: >- + Optional. The model config to use for the deployment. If not + specified, the default model config will be used. + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployRequestModelConfig' + endpointConfig: + description: >- + Optional. The endpoint config to use for the deployment. If not + specified, the default endpoint config will be used. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1DeployRequestEndpointConfig + deployConfig: + description: >- + Optional. The deploy config to use for the deployment. If not + specified, the default deploy config will be used. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1DeployRequestDeployConfig + GoogleCloudAiplatformV1DeployRequestModelConfig: + id: GoogleCloudAiplatformV1DeployRequestModelConfig + description: The model config to use for the deployment. type: object properties: - partialFailures: + acceptEula: description: >- - Output only. Partial failures encountered. E.g. single files that - couldn't be read. This field should never exceed 20 entries. Status - details field will contain standard Google Cloud error details. + Optional. Whether the user accepts the End User License Agreement + (EULA) for the model. + type: boolean + huggingFaceAccessToken: + description: >- + Optional. The Hugging Face read access token used to access the + model artifacts of gated models. + type: string + huggingFaceCacheEnabled: + description: >- + Optional. If true, the model will deploy with a cached version + instead of directly downloading the model artifacts from Hugging + Face. This is suitable for VPC-SC users with limited internet + access. + type: boolean + modelDisplayName: + description: >- + Optional. The user-specified display name of the uploaded model. If + not set, a default name will be used. + type: string + containerSpec: + description: >- + Optional. The specification of the container that is to be used when + deploying. If not set, the default container spec will be used. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelContainerSpec' + modelUserId: + description: >- + Optional. The ID to use for the uploaded Model, which will become + the final component of the model resource name. When not provided, + Vertex AI will generate a value for this ID. When Model Registry + model is provided, this field will be ignored. This value may be up + to 63 characters, and valid characters are `[a-z0-9_-]`. The first + character cannot be a number or hyphen. + type: string + GoogleCloudAiplatformV1DeployRequestEndpointConfig: + id: GoogleCloudAiplatformV1DeployRequestEndpointConfig + description: The endpoint config to use for the deployment. + type: object + properties: + endpointDisplayName: + description: >- + Optional. The user-specified display name of the endpoint. If not + set, a default name will be used. + type: string + dedicatedEndpointEnabled: + description: >- + Optional. Deprecated. Use dedicated_endpoint_disabled instead. If + true, the endpoint will be exposed through a dedicated DNS + [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS + will be isolated from other users' traffic and will have better + performance and reliability. Note: Once you enabled dedicated + endpoint, you won't be able to send request to the shared DNS + {region}-aiplatform.googleapis.com. The limitations will be removed + soon. + deprecated: true + type: boolean + dedicatedEndpointDisabled: + description: >- + Optional. By default, if dedicated endpoint is enabled, the endpoint + will be exposed through a dedicated DNS + [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS + will be isolated from other users' traffic and will have better + performance and reliability. Note: Once you enabled dedicated + endpoint, you won't be able to send request to the shared DNS + {region}-aiplatform.googleapis.com. The limitations will be removed + soon. If this field is set to true, the dedicated endpoint will be + disabled and the deployed model will be exposed through the shared + DNS {region}-aiplatform.googleapis.com. + type: boolean + endpointUserId: + description: >- + Optional. Immutable. The ID to use for endpoint, which will become + the final component of the endpoint resource name. If not provided, + Vertex AI will generate a value for this ID. If the first character + is a letter, this value may be up to 63 characters, and valid + characters are `[a-z0-9-]`. The last character must be a letter or + number. If the first character is a number, this value may be up to + 9 characters, and valid characters are `[0-9]` with no leading + zeros. When using HTTP/JSON, this field is populated based on a + query string argument, such as `?endpoint_id=12345`. This is the + fallback for fields that are not included in either the URI or the + body. + type: string + GoogleCloudAiplatformV1DeployRequestDeployConfig: + id: GoogleCloudAiplatformV1DeployRequestDeployConfig + description: The deploy config to use for the deployment. + type: object + properties: + dedicatedResources: + description: >- + Optional. The dedicated resources to use for the endpoint. If not + set, the default resources will be used. + $ref: '#/components/schemas/GoogleCloudAiplatformV1DedicatedResources' + fastTryoutEnabled: + description: >- + Optional. If true, enable the QMT fast tryout feature for this model + if possible. + type: boolean + systemLabels: + description: >- + Optional. System labels for Model Garden deployments. These labels + are managed by Google and for tracking purposes only. + type: object + additionalProperties: + type: string + GoogleCloudAiplatformV1RagCorpus: + id: GoogleCloudAiplatformV1RagCorpus + description: >- + A RagCorpus is a RagFile container and a project can have multiple + RagCorpora. + type: object + properties: + vectorDbConfig: + description: Optional. Immutable. The config for the Vector DBs. + $ref: '#/components/schemas/GoogleCloudAiplatformV1RagVectorDbConfig' + vertexAiSearchConfig: + description: Optional. Immutable. The config for the Vertex AI Search. + $ref: '#/components/schemas/GoogleCloudAiplatformV1VertexAiSearchConfig' + name: + description: Output only. The resource name of the RagCorpus. readOnly: true - type: array - items: - $ref: '#/components/schemas/GoogleRpcStatus' + type: string + displayName: + description: >- + Required. The display name of the RagCorpus. The name can be up to + 128 characters long and can consist of any UTF-8 characters. + type: string + description: + description: Optional. The description of the RagCorpus. + type: string createTime: - description: Output only. Time when the operation was created. + description: Output only. Timestamp when this RagCorpus was created. readOnly: true type: string format: google-datetime updateTime: - description: >- - Output only. Time when the operation was updated for the last time. - If the operation has finished (successfully or not), this is the - finish time. + description: Output only. Timestamp when this RagCorpus was last updated. readOnly: true type: string format: google-datetime - GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadata: - id: GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadata - description: >- - Runtime operation information for - MigrationService.BatchMigrateResources. + corpusStatus: + description: Output only. RagCorpus state. + readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1CorpusStatus' + encryptionSpec: + description: >- + Optional. Immutable. The CMEK key name used to encrypt at-rest data + related to this Corpus. Only applicable to RagManagedDb option for + Vector DB. This field can only be set at corpus creation time, and + cannot be updated or deleted. + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + GoogleCloudAiplatformV1RagVectorDbConfig: + id: GoogleCloudAiplatformV1RagVectorDbConfig + description: Config for the Vector DB to use for RAG. type: object properties: - genericMetadata: - description: The common part of the operation metadata. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - partialResults: + ragManagedDb: + description: The config for the RAG-managed Vector DB. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1RagVectorDbConfigRagManagedDb + pinecone: + description: The config for the Pinecone. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1RagVectorDbConfigPinecone + vertexVectorSearch: + description: The config for the Vertex Vector Search. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1RagVectorDbConfigVertexVectorSearch + apiAuth: + description: Authentication config for the chosen Vector DB. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ApiAuth' + ragEmbeddingModelConfig: + description: Optional. Immutable. The embedding model config of the Vector DB. + $ref: '#/components/schemas/GoogleCloudAiplatformV1RagEmbeddingModelConfig' + GoogleCloudAiplatformV1RagVectorDbConfigRagManagedDb: + id: GoogleCloudAiplatformV1RagVectorDbConfigRagManagedDb + description: The config for the default RAG-managed Vector DB. + type: object + properties: + knn: + description: Performs a KNN search on RagCorpus. Default choice if not specified. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1RagVectorDbConfigRagManagedDbKNN + ann: description: >- - Partial results that reflect the latest migration operation - progress. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadataPartialResult - GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadataPartialResult: - id: >- - GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadataPartialResult + Performs an ANN search on RagCorpus. Use this if you have a lot of + files (> 10K) in your RagCorpus and want to reduce the search + latency. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1RagVectorDbConfigRagManagedDbANN + GoogleCloudAiplatformV1RagVectorDbConfigRagManagedDbKNN: + id: GoogleCloudAiplatformV1RagVectorDbConfigRagManagedDbKNN + description: Config for KNN search. + type: object + properties: {} + GoogleCloudAiplatformV1RagVectorDbConfigRagManagedDbANN: + id: GoogleCloudAiplatformV1RagVectorDbConfigRagManagedDbANN description: >- - Represents a partial result in batch migration operation for one - MigrateResourceRequest. + Config for ANN search. RagManagedDb uses a tree-based structure to + partition data and facilitate faster searches. As a tradeoff, it + requires longer indexing time and manual triggering of index rebuild via + the ImportRagFiles and UpdateRagCorpus API. type: object properties: - error: - description: The error result of the migration request in case of failure. - $ref: '#/components/schemas/GoogleRpcStatus' - model: - description: Migrated model resource name. + treeDepth: + description: >- + The depth of the tree-based structure. Only depth values of 2 and 3 + are supported. Recommended value is 2 if you have if you have O(10K) + files in the RagCorpus and set this to 3 if more than that. Default + value is 2. + type: integer + format: int32 + leafCount: + description: >- + Number of leaf nodes in the tree-based structure. Each leaf node + contains groups of closely related vectors along with their + corresponding centroid. Recommended value is 10 * sqrt(num of + RagFiles in your RagCorpus). Default value is 500. + type: integer + format: int32 + GoogleCloudAiplatformV1RagVectorDbConfigPinecone: + id: GoogleCloudAiplatformV1RagVectorDbConfigPinecone + description: The config for the Pinecone. + type: object + properties: + indexName: + description: Pinecone index name. This value cannot be changed after it's set. type: string - dataset: - description: Migrated dataset resource name. + GoogleCloudAiplatformV1RagVectorDbConfigVertexVectorSearch: + id: GoogleCloudAiplatformV1RagVectorDbConfigVertexVectorSearch + description: The config for the Vertex Vector Search. + type: object + properties: + indexEndpoint: + description: >- + The resource name of the Index Endpoint. Format: + `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}` type: string - request: + index: description: >- - It's the same as the value in - MigrateResourceRequest.migrate_resource_requests. - $ref: '#/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequest' - GoogleCloudAiplatformV1BatchMigrateResourcesResponse: - id: GoogleCloudAiplatformV1BatchMigrateResourcesResponse - description: Response message for MigrationService.BatchMigrateResources. + The resource name of the Index. Format: + `projects/{project}/locations/{location}/indexes/{index}` + type: string + GoogleCloudAiplatformV1RagEmbeddingModelConfig: + id: GoogleCloudAiplatformV1RagEmbeddingModelConfig + description: Config for the embedding model to use for RAG. type: object properties: - migrateResourceResponses: - description: Successfully migrated resources. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MigrateResourceResponse - GoogleCloudAiplatformV1MigrateResourceResponse: - id: GoogleCloudAiplatformV1MigrateResourceResponse - description: Describes a successfully migrated resource. + vertexPredictionEndpoint: + description: >- + The Vertex AI Prediction Endpoint that either refers to a publisher + model or an endpoint that is hosting a 1P fine-tuned text embedding + model. Endpoints hosting non-1P fine-tuned text embedding models are + currently not supported. This is used for dense vector search. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1RagEmbeddingModelConfigVertexPredictionEndpoint + GoogleCloudAiplatformV1RagEmbeddingModelConfigVertexPredictionEndpoint: + id: GoogleCloudAiplatformV1RagEmbeddingModelConfigVertexPredictionEndpoint + description: Config representing a model hosted on Vertex Prediction Endpoint. type: object properties: - dataset: - description: Migrated Dataset's resource name. + endpoint: + description: >- + Required. The endpoint resource name. Format: + `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}` + or `projects/{project}/locations/{location}/endpoints/{endpoint}` type: string model: - description: Migrated Model's resource name. + description: >- + Output only. The resource name of the model that is deployed on the + endpoint. Present only when the endpoint is not a publisher model. + Pattern: `projects/{project}/locations/{location}/models/{model}` + readOnly: true type: string - migratableResource: + modelVersionId: description: >- - Before migration, the identifier in ml.googleapis.com, - automl.googleapis.com or datalabeling.googleapis.com. - $ref: '#/components/schemas/GoogleCloudAiplatformV1MigratableResource' - GoogleCloudAiplatformV1BatchReadFeatureValuesOperationMetadata: - id: GoogleCloudAiplatformV1BatchReadFeatureValuesOperationMetadata - description: Details of operations that batch reads Feature values. + Output only. Version ID of the model that is deployed on the + endpoint. Present only when the endpoint is not a publisher model. + readOnly: true + type: string + GoogleCloudAiplatformV1VertexAiSearchConfig: + id: GoogleCloudAiplatformV1VertexAiSearchConfig + description: Config for the Vertex AI Search. type: object properties: - genericMetadata: - description: Operation metadata for Featurestore batch read Features values. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - GoogleCloudAiplatformV1BatchReadFeatureValuesResponse: - id: GoogleCloudAiplatformV1BatchReadFeatureValuesResponse - description: Response message for FeaturestoreService.BatchReadFeatureValues. - type: object - properties: {} - GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateMetatdata: - id: GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateMetatdata - description: >- - This message will be placed in the metadata field of a - google.longrunning.Operation associated with a - CheckTrialEarlyStoppingState request. + servingConfig: + description: >- + Vertex AI Search Serving Config resource full name. For example, + `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}` + or + `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}`. + type: string + GoogleCloudAiplatformV1CorpusStatus: + id: GoogleCloudAiplatformV1CorpusStatus + description: RagCorpus status. type: object properties: - genericMetadata: - description: Operation metadata for suggesting Trials. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - study: - description: The name of the Study that the Trial belongs to. + state: + description: Output only. RagCorpus life state. + readOnly: true type: string - trial: - description: The Trial name. + enumDescriptions: + - This state is not supposed to happen. + - >- + RagCorpus resource entry is initialized, but hasn't done + validation. + - RagCorpus is provisioned successfully and is ready to serve. + - >- + RagCorpus is in a problematic situation. See `error_message` field + for details. + enum: + - UNKNOWN + - INITIALIZED + - ACTIVE + - ERROR + errorStatus: + description: Output only. Only when the `state` field is ERROR. + readOnly: true type: string - GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateResponse: - id: GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateResponse - description: Response message for VizierService.CheckTrialEarlyStoppingState. + GoogleCloudAiplatformV1ListRagCorporaResponse: + id: GoogleCloudAiplatformV1ListRagCorporaResponse + description: Response message for VertexRagDataService.ListRagCorpora. type: object properties: - shouldStop: - description: True if the Trial should stop. - type: boolean - GoogleCloudAiplatformV1CreateDeploymentResourcePoolOperationMetadata: - id: GoogleCloudAiplatformV1CreateDeploymentResourcePoolOperationMetadata - description: Runtime operation information for CreateDeploymentResourcePool method. + ragCorpora: + description: List of RagCorpora in the requested page. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1RagCorpus' + nextPageToken: + description: >- + A token to retrieve the next page of results. Pass to + ListRagCorporaRequest.page_token to obtain that page. + type: string + GoogleCloudAiplatformV1UploadRagFileRequest: + id: GoogleCloudAiplatformV1UploadRagFileRequest + description: Request message for VertexRagDataService.UploadRagFile. type: object properties: - genericMetadata: - description: The operation generic information. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - GoogleCloudAiplatformV1CreateFeatureOperationMetadata: - id: GoogleCloudAiplatformV1CreateFeatureOperationMetadata - description: Details of operations that perform create Feature. + ragFile: + description: Required. The RagFile to upload. + $ref: '#/components/schemas/GoogleCloudAiplatformV1RagFile' + uploadRagFileConfig: + description: >- + Required. The config for the RagFiles to be uploaded into the + RagCorpus. VertexRagDataService.UploadRagFile. + $ref: '#/components/schemas/GoogleCloudAiplatformV1UploadRagFileConfig' + GoogleCloudAiplatformV1RagFile: + id: GoogleCloudAiplatformV1RagFile + description: A RagFile contains user data for chunking, embedding and indexing. type: object properties: - genericMetadata: - description: Operation metadata for Feature. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - GoogleCloudAiplatformV1CreateFeaturestoreOperationMetadata: - id: GoogleCloudAiplatformV1CreateFeaturestoreOperationMetadata - description: Details of operations that perform create Featurestore. + gcsSource: + description: >- + Output only. Google Cloud Storage location of the RagFile. It does + not support wildcards in the Cloud Storage uri for now. + readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' + googleDriveSource: + description: >- + Output only. Google Drive location. Supports importing individual + files as well as Google Drive folders. + readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1GoogleDriveSource' + directUploadSource: + description: >- + Output only. The RagFile is encapsulated and uploaded in the + UploadRagFile request. + readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1DirectUploadSource' + slackSource: + description: The RagFile is imported from a Slack channel. + $ref: '#/components/schemas/GoogleCloudAiplatformV1SlackSource' + jiraSource: + description: The RagFile is imported from a Jira query. + $ref: '#/components/schemas/GoogleCloudAiplatformV1JiraSource' + sharePointSources: + description: The RagFile is imported from a SharePoint source. + $ref: '#/components/schemas/GoogleCloudAiplatformV1SharePointSources' + name: + description: Output only. The resource name of the RagFile. + readOnly: true + type: string + displayName: + description: >- + Required. The display name of the RagFile. The name can be up to 128 + characters long and can consist of any UTF-8 characters. + type: string + description: + description: Optional. The description of the RagFile. + type: string + createTime: + description: Output only. Timestamp when this RagFile was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. Timestamp when this RagFile was last updated. + readOnly: true + type: string + format: google-datetime + fileStatus: + description: Output only. State of the RagFile. + readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1FileStatus' + userMetadata: + description: >- + Output only. The metadata for metadata search. The user_metadata + Needs to be in JSON format. + readOnly: true + type: string + GoogleCloudAiplatformV1GoogleDriveSource: + id: GoogleCloudAiplatformV1GoogleDriveSource + description: The Google Drive location for the input content. type: object properties: - genericMetadata: - description: Operation metadata for Featurestore. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - GoogleCloudAiplatformV1CreateFeatureGroupOperationMetadata: - id: GoogleCloudAiplatformV1CreateFeatureGroupOperationMetadata - description: Details of operations that perform create FeatureGroup. + resourceIds: + description: Required. Google Drive resource IDs. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GoogleDriveSourceResourceId + GoogleCloudAiplatformV1GoogleDriveSourceResourceId: + id: GoogleCloudAiplatformV1GoogleDriveSourceResourceId + description: The type and ID of the Google Drive resource. type: object properties: - genericMetadata: - description: Operation metadata for FeatureGroup. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - GoogleCloudAiplatformV1CreateRegistryFeatureOperationMetadata: - id: GoogleCloudAiplatformV1CreateRegistryFeatureOperationMetadata - description: Details of operations that perform create FeatureGroup. + resourceType: + description: Required. The type of the Google Drive resource. + type: string + enumDescriptions: + - Unspecified resource type. + - File resource type. + - Folder resource type. + enum: + - RESOURCE_TYPE_UNSPECIFIED + - RESOURCE_TYPE_FILE + - RESOURCE_TYPE_FOLDER + resourceId: + description: Required. The ID of the Google Drive resource. + type: string + GoogleCloudAiplatformV1DirectUploadSource: + id: GoogleCloudAiplatformV1DirectUploadSource + description: The input content is encapsulated and uploaded in the request. + type: object + properties: {} + GoogleCloudAiplatformV1SlackSource: + id: GoogleCloudAiplatformV1SlackSource + description: The Slack source for the ImportRagFilesRequest. type: object properties: - genericMetadata: - description: Operation metadata for Feature. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - GoogleCloudAiplatformV1CreateFeatureOnlineStoreOperationMetadata: - id: GoogleCloudAiplatformV1CreateFeatureOnlineStoreOperationMetadata - description: Details of operations that perform create FeatureOnlineStore. + channels: + description: Required. The Slack channels. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SlackSourceSlackChannels + GoogleCloudAiplatformV1SlackSourceSlackChannels: + id: GoogleCloudAiplatformV1SlackSourceSlackChannels + description: >- + SlackChannels contains the Slack channels and corresponding access + token. type: object properties: - genericMetadata: - description: Operation metadata for FeatureOnlineStore. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - GoogleCloudAiplatformV1CreateFeatureViewOperationMetadata: - id: GoogleCloudAiplatformV1CreateFeatureViewOperationMetadata - description: Details of operations that perform create FeatureView. + channels: + description: Required. The Slack channel IDs. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SlackSourceSlackChannelsSlackChannel + apiKeyConfig: + description: >- + Required. The SecretManager secret version resource name (e.g. + projects/{project}/secrets/{secret}/versions/{version}) storing the + Slack channel access token that has access to the slack channel IDs. + See: https://api.slack.com/tutorials/tracks/getting-a-token. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ApiAuthApiKeyConfig' + GoogleCloudAiplatformV1SlackSourceSlackChannelsSlackChannel: + id: GoogleCloudAiplatformV1SlackSourceSlackChannelsSlackChannel + description: SlackChannel contains the Slack channel ID and the time range to import. type: object properties: - genericMetadata: - description: Operation metadata for FeatureView Create. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - GoogleCloudAiplatformV1UpdateFeatureOnlineStoreOperationMetadata: - id: GoogleCloudAiplatformV1UpdateFeatureOnlineStoreOperationMetadata - description: Details of operations that perform update FeatureOnlineStore. + channelId: + description: Required. The Slack channel ID. + type: string + startTime: + description: Optional. The starting timestamp for messages to import. + type: string + format: google-datetime + endTime: + description: Optional. The ending timestamp for messages to import. + type: string + format: google-datetime + GoogleCloudAiplatformV1JiraSource: + id: GoogleCloudAiplatformV1JiraSource + description: The Jira source for the ImportRagFilesRequest. type: object properties: - genericMetadata: - description: Operation metadata for FeatureOnlineStore. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - GoogleCloudAiplatformV1UpdateFeatureViewOperationMetadata: - id: GoogleCloudAiplatformV1UpdateFeatureViewOperationMetadata - description: Details of operations that perform update FeatureView. + jiraQueries: + description: Required. The Jira queries. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1JiraSourceJiraQueries' + GoogleCloudAiplatformV1JiraSourceJiraQueries: + id: GoogleCloudAiplatformV1JiraSourceJiraQueries + description: JiraQueries contains the Jira queries and corresponding authentication. type: object properties: - genericMetadata: - description: Operation metadata for FeatureView Update. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - GoogleCloudAiplatformV1CreateDatasetOperationMetadata: - id: GoogleCloudAiplatformV1CreateDatasetOperationMetadata - description: Runtime operation information for DatasetService.CreateDataset. + projects: + description: A list of Jira projects to import in their entirety. + type: array + items: + type: string + customQueries: + description: >- + A list of custom Jira queries to import. For information about JQL + (Jira Query Language), see + https://support.atlassian.com/jira-service-management-cloud/docs/use-advanced-search-with-jira-query-language-jql/ + type: array + items: + type: string + email: + description: Required. The Jira email address. + type: string + serverUri: + description: Required. The Jira server URI. + type: string + apiKeyConfig: + description: >- + Required. The SecretManager secret version resource name (e.g. + projects/{project}/secrets/{secret}/versions/{version}) storing the + Jira API key. See [Manage API tokens for your Atlassian + account](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/). + $ref: '#/components/schemas/GoogleCloudAiplatformV1ApiAuthApiKeyConfig' + GoogleCloudAiplatformV1SharePointSources: + id: GoogleCloudAiplatformV1SharePointSources + description: The SharePointSources to pass to ImportRagFiles. type: object properties: - genericMetadata: - description: The operation generic information. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - GoogleCloudAiplatformV1CreateDatasetVersionOperationMetadata: - id: GoogleCloudAiplatformV1CreateDatasetVersionOperationMetadata - description: Runtime operation information for DatasetService.CreateDatasetVersion. + sharePointSources: + description: The SharePoint sources. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SharePointSourcesSharePointSource + GoogleCloudAiplatformV1SharePointSourcesSharePointSource: + id: GoogleCloudAiplatformV1SharePointSourcesSharePointSource + description: An individual SharePointSource. + type: object + properties: + sharepointFolderPath: + description: The path of the SharePoint folder to download from. + type: string + sharepointFolderId: + description: The ID of the SharePoint folder to download from. + type: string + driveName: + description: The name of the drive to download from. + type: string + driveId: + description: The ID of the drive to download from. + type: string + clientId: + description: >- + The Application ID for the app registered in Microsoft Azure Portal. + The application must also be configured with MS Graph permissions + "Files.ReadAll", "Sites.ReadAll" and BrowserSiteLists.Read.All. + type: string + clientSecret: + description: The application secret for the app registered in Azure. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ApiAuthApiKeyConfig' + tenantId: + description: Unique identifier of the Azure Active Directory Instance. + type: string + sharepointSiteName: + description: >- + The name of the SharePoint site to download from. This can be the + site name or the site id. + type: string + fileId: + description: Output only. The SharePoint file id. Output only. + readOnly: true + type: string + GoogleCloudAiplatformV1FileStatus: + id: GoogleCloudAiplatformV1FileStatus + description: RagFile status. + type: object + properties: + state: + description: Output only. RagFile state. + readOnly: true + type: string + enumDescriptions: + - RagFile state is unspecified. + - RagFile resource has been created and indexed successfully. + - >- + RagFile resource is in a problematic state. See `error_message` + field for details. + enum: + - STATE_UNSPECIFIED + - ACTIVE + - ERROR + errorStatus: + description: Output only. Only when the `state` field is ERROR. + readOnly: true + type: string + GoogleCloudAiplatformV1UploadRagFileConfig: + id: GoogleCloudAiplatformV1UploadRagFileConfig + description: Config for uploading RagFile. + type: object + properties: + ragFileTransformationConfig: + description: Specifies the transformation config for RagFiles. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1RagFileTransformationConfig + GoogleCloudAiplatformV1RagFileTransformationConfig: + id: GoogleCloudAiplatformV1RagFileTransformationConfig + description: Specifies the transformation config for RagFiles. + type: object + properties: + ragFileChunkingConfig: + description: Specifies the chunking config for RagFiles. + $ref: '#/components/schemas/GoogleCloudAiplatformV1RagFileChunkingConfig' + GoogleCloudAiplatformV1RagFileChunkingConfig: + id: GoogleCloudAiplatformV1RagFileChunkingConfig + description: Specifies the size and overlap of chunks for RagFiles. + type: object + properties: + fixedLengthChunking: + description: Specifies the fixed length chunking config. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1RagFileChunkingConfigFixedLengthChunking + GoogleCloudAiplatformV1RagFileChunkingConfigFixedLengthChunking: + id: GoogleCloudAiplatformV1RagFileChunkingConfigFixedLengthChunking + description: Specifies the fixed length chunking config. + type: object + properties: + chunkSize: + description: The size of the chunks. + type: integer + format: int32 + chunkOverlap: + description: The overlap between chunks. + type: integer + format: int32 + GoogleCloudAiplatformV1UploadRagFileResponse: + id: GoogleCloudAiplatformV1UploadRagFileResponse + description: Response message for VertexRagDataService.UploadRagFile. + type: object + properties: + ragFile: + description: The RagFile that had been uploaded into the RagCorpus. + $ref: '#/components/schemas/GoogleCloudAiplatformV1RagFile' + error: + description: The error that occurred while processing the RagFile. + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudAiplatformV1ImportRagFilesRequest: + id: GoogleCloudAiplatformV1ImportRagFilesRequest + description: Request message for VertexRagDataService.ImportRagFiles. + type: object + properties: + importRagFilesConfig: + description: >- + Required. The config for the RagFiles to be synced and imported into + the RagCorpus. VertexRagDataService.ImportRagFiles. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ImportRagFilesConfig' + GoogleCloudAiplatformV1ImportRagFilesConfig: + id: GoogleCloudAiplatformV1ImportRagFilesConfig + description: Config for importing RagFiles. + type: object + properties: + gcsSource: + description: >- + Google Cloud Storage location. Supports importing individual files + as well as entire Google Cloud Storage directories. Sample formats: + - `gs://bucket_name/my_directory/object_name/my_file.txt` - + `gs://bucket_name/my_directory` + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' + googleDriveSource: + description: >- + Google Drive location. Supports importing individual files as well + as Google Drive folders. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GoogleDriveSource' + slackSource: + description: Slack channels with their corresponding access tokens. + $ref: '#/components/schemas/GoogleCloudAiplatformV1SlackSource' + jiraSource: + description: Jira queries with their corresponding authentication. + $ref: '#/components/schemas/GoogleCloudAiplatformV1JiraSource' + sharePointSources: + description: SharePoint sources. + $ref: '#/components/schemas/GoogleCloudAiplatformV1SharePointSources' + partialFailureGcsSink: + description: >- + The Cloud Storage path to write partial failures to. Deprecated. + Prefer to use `import_result_gcs_sink`. + deprecated: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' + partialFailureBigquerySink: + description: >- + The BigQuery destination to write partial failures to. It should be + a bigquery table resource name (e.g. + "bq://projectId.bqDatasetId.bqTableId"). The dataset must exist. If + the table does not exist, it will be created with the expected + schema. If the table exists, the schema will be validated and data + will be added to this existing table. Deprecated. Prefer to use + `import_result_bq_sink`. + deprecated: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQueryDestination' + importResultGcsSink: + description: The Cloud Storage path to write import result to. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' + importResultBigquerySink: + description: >- + The BigQuery destination to write import result to. It should be a + bigquery table resource name (e.g. + "bq://projectId.bqDatasetId.bqTableId"). The dataset must exist. If + the table does not exist, it will be created with the expected + schema. If the table exists, the schema will be validated and data + will be added to this existing table. + $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQueryDestination' + ragFileTransformationConfig: + description: Specifies the transformation config for RagFiles. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1RagFileTransformationConfig + ragFileParsingConfig: + description: >- + Optional. Specifies the parsing config for RagFiles. RAG will use + the default parser if this field is not set. + $ref: '#/components/schemas/GoogleCloudAiplatformV1RagFileParsingConfig' + maxEmbeddingRequestsPerMin: + description: >- + Optional. The max number of queries per minute that this job is + allowed to make to the embedding model specified on the corpus. This + value is specific to this job and not shared across other import + jobs. Consult the Quotas page on the project to set an appropriate + value here. If unspecified, a default value of 1,000 QPM would be + used. + type: integer + format: int32 + rebuildAnnIndex: + description: >- + Rebuilds the ANN index to optimize for recall on the imported data. + Only applicable for RagCorpora running on RagManagedDb with + `retrieval_strategy` set to `ANN`. The rebuild will be performed + using the existing ANN config set on the RagCorpus. To change the + ANN config, please use the UpdateRagCorpus API. Default is false, + i.e., index is not rebuilt. + type: boolean + GoogleCloudAiplatformV1RagFileParsingConfig: + id: GoogleCloudAiplatformV1RagFileParsingConfig + description: Specifies the parsing config for RagFiles. + type: object + properties: + layoutParser: + description: The Layout Parser to use for RagFiles. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1RagFileParsingConfigLayoutParser + llmParser: + description: The LLM Parser to use for RagFiles. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1RagFileParsingConfigLlmParser + GoogleCloudAiplatformV1RagFileParsingConfigLayoutParser: + id: GoogleCloudAiplatformV1RagFileParsingConfigLayoutParser + description: Document AI Layout Parser config. + type: object + properties: + processorName: + description: >- + The full resource name of a Document AI processor or processor + version. The processor must have type `LAYOUT_PARSER_PROCESSOR`. If + specified, the `additional_config.parse_as_scanned_pdf` field must + be false. Format: * + `projects/{project_id}/locations/{location}/processors/{processor_id}` + * + `projects/{project_id}/locations/{location}/processors/{processor_id}/processorVersions/{processor_version_id}` + type: string + maxParsingRequestsPerMin: + description: >- + The maximum number of requests the job is allowed to make to the + Document AI processor per minute. Consult + https://cloud.google.com/document-ai/quotas and the Quota page for + your project to set an appropriate value here. If unspecified, a + default value of 120 QPM would be used. + type: integer + format: int32 + GoogleCloudAiplatformV1RagFileParsingConfigLlmParser: + id: GoogleCloudAiplatformV1RagFileParsingConfigLlmParser + description: Specifies the LLM parsing for RagFiles. + type: object + properties: + modelName: + description: >- + The name of a LLM model used for parsing. Format: * + `projects/{project_id}/locations/{location}/publishers/{publisher}/models/{model}` + type: string + maxParsingRequestsPerMin: + description: >- + The maximum number of requests the job is allowed to make to the LLM + model per minute. Consult + https://cloud.google.com/vertex-ai/generative-ai/docs/quotas and + your document size to set an appropriate value here. If unspecified, + a default value of 5000 QPM would be used. + type: integer + format: int32 + customParsingPrompt: + description: >- + The prompt to use for parsing. If not specified, a default prompt + will be used. + type: string + GoogleCloudAiplatformV1ListRagFilesResponse: + id: GoogleCloudAiplatformV1ListRagFilesResponse + description: Response message for VertexRagDataService.ListRagFiles. + type: object + properties: + ragFiles: + description: List of RagFiles in the requested page. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1RagFile' + nextPageToken: + description: >- + A token to retrieve the next page of results. Pass to + ListRagFilesRequest.page_token to obtain that page. + type: string + GoogleCloudAiplatformV1RagEngineConfig: + id: GoogleCloudAiplatformV1RagEngineConfig + description: Config for RagEngine. + type: object + properties: + name: + description: >- + Identifier. The name of the RagEngineConfig. Format: + `projects/{project}/locations/{location}/ragEngineConfig` + type: string + ragManagedDbConfig: + description: The config of the RagManagedDb used by RagEngine. + $ref: '#/components/schemas/GoogleCloudAiplatformV1RagManagedDbConfig' + GoogleCloudAiplatformV1RagManagedDbConfig: + id: GoogleCloudAiplatformV1RagManagedDbConfig + description: Configuration message for RagManagedDb used by RagEngine. + type: object + properties: + scaled: + description: Sets the RagManagedDb to the Scaled tier. + $ref: '#/components/schemas/GoogleCloudAiplatformV1RagManagedDbConfigScaled' + basic: + description: Sets the RagManagedDb to the Basic tier. + $ref: '#/components/schemas/GoogleCloudAiplatformV1RagManagedDbConfigBasic' + unprovisioned: + description: Sets the RagManagedDb to the Unprovisioned tier. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1RagManagedDbConfigUnprovisioned + GoogleCloudAiplatformV1RagManagedDbConfigScaled: + id: GoogleCloudAiplatformV1RagManagedDbConfigScaled + description: >- + Scaled tier offers production grade performance along with autoscaling + functionality. It is suitable for customers with large amounts of data + or performance sensitive workloads. + type: object + properties: {} + GoogleCloudAiplatformV1RagManagedDbConfigBasic: + id: GoogleCloudAiplatformV1RagManagedDbConfigBasic + description: >- + Basic tier is a cost-effective and low compute tier suitable for the + following cases: * Experimenting with RagManagedDb. * Small data size. * + Latency insensitive workload. * Only using RAG Engine with external + vector DBs. NOTE: This is the default tier if not explicitly chosen. + type: object + properties: {} + GoogleCloudAiplatformV1RagManagedDbConfigUnprovisioned: + id: GoogleCloudAiplatformV1RagManagedDbConfigUnprovisioned + description: >- + Disables the RAG Engine service and deletes all your data held within + this service. This will halt the billing of the service. NOTE: Once + deleted the data cannot be recovered. To start using RAG Engine again, + you will need to update the tier by calling the UpdateRagEngineConfig + API. + type: object + properties: {} + GoogleCloudAiplatformV1RetrieveContextsRequest: + id: GoogleCloudAiplatformV1RetrieveContextsRequest + description: Request message for VertexRagService.RetrieveContexts. + type: object + properties: + vertexRagStore: + description: The data source for Vertex RagStore. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1RetrieveContextsRequestVertexRagStore + query: + description: Required. Single RAG retrieve query. + $ref: '#/components/schemas/GoogleCloudAiplatformV1RagQuery' + GoogleCloudAiplatformV1RetrieveContextsRequestVertexRagStore: + id: GoogleCloudAiplatformV1RetrieveContextsRequestVertexRagStore + description: The data source for Vertex RagStore. + type: object + properties: + ragResources: + description: >- + Optional. The representation of the rag source. It can be used to + specify corpus only or ragfiles. Currently only support one corpus + or multiple files from one corpus. In the future we may open up + multiple corpora support. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1RetrieveContextsRequestVertexRagStoreRagResource + vectorDistanceThreshold: + description: >- + Optional. Only return contexts with vector distance smaller than the + threshold. + deprecated: true + type: number + format: double + GoogleCloudAiplatformV1RetrieveContextsRequestVertexRagStoreRagResource: + id: GoogleCloudAiplatformV1RetrieveContextsRequestVertexRagStoreRagResource + description: The definition of the Rag resource. + type: object + properties: + ragCorpus: + description: >- + Optional. RagCorpora resource name. Format: + `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + type: string + ragFileIds: + description: >- + Optional. rag_file_id. The files should be in the same rag_corpus + set in rag_corpus field. + type: array + items: + type: string + GoogleCloudAiplatformV1RagQuery: + id: GoogleCloudAiplatformV1RagQuery + description: A query to retrieve relevant contexts. + type: object + properties: + text: + description: Optional. The query in text format to get relevant contexts. + type: string + ragRetrievalConfig: + description: Optional. The retrieval config for the query. + $ref: '#/components/schemas/GoogleCloudAiplatformV1RagRetrievalConfig' + GoogleCloudAiplatformV1RetrieveContextsResponse: + id: GoogleCloudAiplatformV1RetrieveContextsResponse + description: Response message for VertexRagService.RetrieveContexts. + type: object + properties: + contexts: + description: The contexts of the query. + $ref: '#/components/schemas/GoogleCloudAiplatformV1RagContexts' + GoogleCloudAiplatformV1RagContexts: + id: GoogleCloudAiplatformV1RagContexts + description: Relevant contexts for one query. + type: object + properties: + contexts: + description: All its contexts. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1RagContextsContext' + GoogleCloudAiplatformV1RagContextsContext: + id: GoogleCloudAiplatformV1RagContextsContext + description: A context of the query. + type: object + properties: + sourceUri: + description: >- + If the file is imported from Cloud Storage or Google Drive, + source_uri will be original file URI in Cloud Storage or Google + Drive; if file is uploaded, source_uri will be file display name. + type: string + sourceDisplayName: + description: The file display name. + type: string + text: + description: The text chunk. + type: string + score: + description: >- + According to the underlying Vector DB and the selected metric type, + the score can be either the distance or the similarity between the + query and the context and its range depends on the metric type. For + example, if the metric type is COSINE_DISTANCE, it represents the + distance between the query and the context. The larger the distance, + the less relevant the context is to the query. The range is [0, 2], + while 0 means the most relevant and 2 means the least relevant. + type: number + format: double + chunk: + description: Context of the retrieved chunk. + $ref: '#/components/schemas/GoogleCloudAiplatformV1RagChunk' + GoogleCloudAiplatformV1AugmentPromptRequest: + id: GoogleCloudAiplatformV1AugmentPromptRequest + description: Request message for AugmentPrompt. + type: object + properties: + vertexRagStore: + description: Optional. Retrieves contexts from the Vertex RagStore. + $ref: '#/components/schemas/GoogleCloudAiplatformV1VertexRagStore' + contents: + description: >- + Optional. Input content to augment, only text format is supported + for now. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' + model: + description: Optional. Metadata of the backend deployed model. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1AugmentPromptRequestModel + GoogleCloudAiplatformV1AugmentPromptRequestModel: + id: GoogleCloudAiplatformV1AugmentPromptRequestModel + description: Metadata of the backend deployed model. + type: object + properties: + model: + description: >- + Optional. The model that the user will send the augmented prompt for + content generation. + type: string + modelVersion: + description: Optional. The model version of the backend deployed model. + type: string + GoogleCloudAiplatformV1AugmentPromptResponse: + id: GoogleCloudAiplatformV1AugmentPromptResponse + description: Response message for AugmentPrompt. + type: object + properties: + augmentedPrompt: + description: Augmented prompt, only text format is supported for now. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' + facts: + description: Retrieved facts from RAG data sources. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Fact' + GoogleCloudAiplatformV1Fact: + id: GoogleCloudAiplatformV1Fact + description: The fact used in grounding. + type: object + properties: + query: + description: Query that is used to retrieve this fact. + type: string + title: + description: If present, it refers to the title of this fact. + type: string + uri: + description: If present, this uri links to the source of the fact. + type: string + summary: + description: If present, the summary/snippet of the fact. + type: string + vectorDistance: + description: >- + If present, the distance between the query vector and this fact + vector. + deprecated: true + type: number + format: double + score: + description: >- + If present, according to the underlying Vector DB and the selected + metric type, the score can be either the distance or the similarity + between the query and the fact and its range depends on the metric + type. For example, if the metric type is COSINE_DISTANCE, it + represents the distance between the query and the fact. The larger + the distance, the less relevant the fact is to the query. The range + is [0, 2], while 0 means the most relevant and 2 means the least + relevant. + type: number + format: double + chunk: + description: If present, chunk properties. + $ref: '#/components/schemas/GoogleCloudAiplatformV1RagChunk' + GoogleCloudAiplatformV1CorroborateContentRequest: + id: GoogleCloudAiplatformV1CorroborateContentRequest + description: Request message for CorroborateContent. + type: object + properties: + content: + description: >- + Optional. Input content to corroborate, only text format is + supported for now. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' + facts: + description: >- + Optional. Facts used to generate the text can also be used to + corroborate the text. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Fact' + parameters: + description: >- + Optional. Parameters that can be set to override default settings + per request. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1CorroborateContentRequestParameters + GoogleCloudAiplatformV1CorroborateContentRequestParameters: + id: GoogleCloudAiplatformV1CorroborateContentRequestParameters + description: Parameters that can be overrided per request. + type: object + properties: + citationThreshold: + description: >- + Optional. Only return claims with citation score larger than the + threshold. + type: number + format: double + GoogleCloudAiplatformV1CorroborateContentResponse: + id: GoogleCloudAiplatformV1CorroborateContentResponse + description: Response message for CorroborateContent. + type: object + properties: + corroborationScore: + description: >- + Confidence score of corroborating content. Value is [0,1] with 1 is + the most confidence. + type: number + format: float + claims: + description: >- + Claims that are extracted from the input content and facts that + support the claims. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Claim' + GoogleCloudAiplatformV1Claim: + id: GoogleCloudAiplatformV1Claim + description: Claim that is extracted from the input text and facts that support it. + type: object + properties: + startIndex: + description: Index in the input text where the claim starts (inclusive). + type: integer + format: int32 + endIndex: + description: Index in the input text where the claim ends (exclusive). + type: integer + format: int32 + factIndexes: + description: Indexes of the facts supporting this claim. + type: array + items: + type: integer + format: int32 + score: + description: Confidence score of this corroboration. + type: number + format: float + GoogleCloudAiplatformV1AssignNotebookRuntimeOperationMetadata: + id: GoogleCloudAiplatformV1AssignNotebookRuntimeOperationMetadata + description: Metadata information for NotebookService.AssignNotebookRuntime. + type: object + properties: + genericMetadata: + description: The operation generic information. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + progressMessage: + description: >- + A human-readable message that shows the intermediate progress + details of NotebookRuntime. + type: string + GoogleCloudAiplatformV1GenericOperationMetadata: + id: GoogleCloudAiplatformV1GenericOperationMetadata + description: Generic Metadata shared by all operations. + type: object + properties: + partialFailures: + description: >- + Output only. Partial failures encountered. E.g. single files that + couldn't be read. This field should never exceed 20 entries. Status + details field will contain standard Google Cloud error details. + readOnly: true + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + createTime: + description: Output only. Time when the operation was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: >- + Output only. Time when the operation was updated for the last time. + If the operation has finished (successfully or not), this is the + finish time. + readOnly: true + type: string + format: google-datetime + GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadata: + id: GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadata + description: >- + Runtime operation information for + MigrationService.BatchMigrateResources. type: object properties: genericMetadata: description: The common part of the operation metadata. $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + partialResults: + description: >- + Partial results that reflect the latest migration operation + progress. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadataPartialResult + GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadataPartialResult: + id: >- + GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadataPartialResult + description: >- + Represents a partial result in batch migration operation for one + MigrateResourceRequest. + type: object + properties: + error: + description: The error result of the migration request in case of failure. + $ref: '#/components/schemas/GoogleRpcStatus' + model: + description: Migrated model resource name. + type: string + dataset: + description: Migrated dataset resource name. + type: string + request: + description: >- + It's the same as the value in + BatchMigrateResourcesRequest.migrate_resource_requests. + $ref: '#/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequest' + GoogleCloudAiplatformV1BatchMigrateResourcesResponse: + id: GoogleCloudAiplatformV1BatchMigrateResourcesResponse + description: Response message for MigrationService.BatchMigrateResources. + type: object + properties: + migrateResourceResponses: + description: Successfully migrated resources. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1MigrateResourceResponse + GoogleCloudAiplatformV1MigrateResourceResponse: + id: GoogleCloudAiplatformV1MigrateResourceResponse + description: Describes a successfully migrated resource. + type: object + properties: + dataset: + description: Migrated Dataset's resource name. + type: string + model: + description: Migrated Model's resource name. + type: string + migratableResource: + description: >- + Before migration, the identifier in ml.googleapis.com, + automl.googleapis.com or datalabeling.googleapis.com. + $ref: '#/components/schemas/GoogleCloudAiplatformV1MigratableResource' + GoogleCloudAiplatformV1BatchReadFeatureValuesOperationMetadata: + id: GoogleCloudAiplatformV1BatchReadFeatureValuesOperationMetadata + description: Details of operations that batch reads Feature values. + type: object + properties: + genericMetadata: + description: Operation metadata for Featurestore batch read Features values. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + GoogleCloudAiplatformV1BatchReadFeatureValuesResponse: + id: GoogleCloudAiplatformV1BatchReadFeatureValuesResponse + description: Response message for FeaturestoreService.BatchReadFeatureValues. + type: object + properties: {} + GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateMetatdata: + id: GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateMetatdata + description: >- + This message will be placed in the metadata field of a + google.longrunning.Operation associated with a + CheckTrialEarlyStoppingState request. + type: object + properties: + genericMetadata: + description: Operation metadata for suggesting Trials. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + study: + description: The name of the Study that the Trial belongs to. + type: string + trial: + description: The Trial name. + type: string + GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateResponse: + id: GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateResponse + description: Response message for VizierService.CheckTrialEarlyStoppingState. + type: object + properties: + shouldStop: + description: True if the Trial should stop. + type: boolean + GoogleCloudAiplatformV1CreateDeploymentResourcePoolOperationMetadata: + id: GoogleCloudAiplatformV1CreateDeploymentResourcePoolOperationMetadata + description: Runtime operation information for CreateDeploymentResourcePool method. + type: object + properties: + genericMetadata: + description: The operation generic information. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + GoogleCloudAiplatformV1CreateFeatureOperationMetadata: + id: GoogleCloudAiplatformV1CreateFeatureOperationMetadata + description: Details of operations that perform create Feature. + type: object + properties: + genericMetadata: + description: Operation metadata for Feature. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + GoogleCloudAiplatformV1CreateFeaturestoreOperationMetadata: + id: GoogleCloudAiplatformV1CreateFeaturestoreOperationMetadata + description: Details of operations that perform create Featurestore. + type: object + properties: + genericMetadata: + description: Operation metadata for Featurestore. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + GoogleCloudAiplatformV1CreateFeatureGroupOperationMetadata: + id: GoogleCloudAiplatformV1CreateFeatureGroupOperationMetadata + description: Details of operations that perform create FeatureGroup. + type: object + properties: + genericMetadata: + description: Operation metadata for FeatureGroup. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + GoogleCloudAiplatformV1CreateRegistryFeatureOperationMetadata: + id: GoogleCloudAiplatformV1CreateRegistryFeatureOperationMetadata + description: Details of operations that perform create FeatureGroup. + type: object + properties: + genericMetadata: + description: Operation metadata for Feature. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + GoogleCloudAiplatformV1CreateFeatureOnlineStoreOperationMetadata: + id: GoogleCloudAiplatformV1CreateFeatureOnlineStoreOperationMetadata + description: Details of operations that perform create FeatureOnlineStore. + type: object + properties: + genericMetadata: + description: Operation metadata for FeatureOnlineStore. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + GoogleCloudAiplatformV1CreateFeatureViewOperationMetadata: + id: GoogleCloudAiplatformV1CreateFeatureViewOperationMetadata + description: Details of operations that perform create FeatureView. + type: object + properties: + genericMetadata: + description: Operation metadata for FeatureView Create. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + GoogleCloudAiplatformV1UpdateFeatureOnlineStoreOperationMetadata: + id: GoogleCloudAiplatformV1UpdateFeatureOnlineStoreOperationMetadata + description: Details of operations that perform update FeatureOnlineStore. + type: object + properties: + genericMetadata: + description: Operation metadata for FeatureOnlineStore. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + GoogleCloudAiplatformV1UpdateFeatureViewOperationMetadata: + id: GoogleCloudAiplatformV1UpdateFeatureViewOperationMetadata + description: Details of operations that perform update FeatureView. + type: object + properties: + genericMetadata: + description: Operation metadata for FeatureView Update. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' GoogleCloudAiplatformV1CreateEndpointOperationMetadata: id: GoogleCloudAiplatformV1CreateEndpointOperationMetadata description: Runtime operation information for EndpointService.CreateEndpoint. @@ -19416,6 +24107,34 @@ components: genericMetadata: description: The operation generic information. $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + deploymentStage: + description: >- + Output only. The deployment stage of the model. Only populated if + this CreateEndpoint request deploys a model at the same time. + readOnly: true + type: string + enumDescriptions: + - Default value. This value is unused. + - The deployment is initializing and setting up the environment. + - The deployment is preparing the model assets. + - The deployment is creating the underlying serving cluster. + - The deployment is adding nodes to the serving cluster. + - >- + The deployment is getting the container image for the model + server. + - The deployment is starting the model server. + - The deployment is performing finalization steps. + - The deployment has terminated. + enum: + - DEPLOYMENT_STAGE_UNSPECIFIED + - STARTING_DEPLOYMENT + - PREPARING_MODEL + - CREATING_SERVING_CLUSTER + - ADDING_NODES_TO_CLUSTER + - GETTING_CONTAINER_IMAGE + - STARTING_MODEL_SERVER + - FINISHING_UP + - DEPLOYMENT_TERMINATED GoogleCloudAiplatformV1CreateMetadataStoreOperationMetadata: id: GoogleCloudAiplatformV1CreateMetadataStoreOperationMetadata description: Details of operations that perform MetadataService.CreateMetadataStore. @@ -19556,6 +24275,8 @@ components: - Token restrict value is invalid. - Invalid sparse embedding. - Invalid dense embedding. + - Invalid embedding metadata. + - Embedding metadata exceeds size limit. enum: - ERROR_TYPE_UNSPECIFIED - EMPTY_LINE @@ -19575,6 +24296,8 @@ components: - INVALID_TOKEN_VALUE - INVALID_SPARSE_EMBEDDING - INVALID_EMBEDDING + - INVALID_EMBEDDING_METADATA + - EMBEDDING_METADATA_EXCEEDS_SIZE_LIMIT errorMessage: description: >- A human-readable message that is shown to the user to help them fix @@ -19737,6 +24460,32 @@ components: genericMetadata: description: The operation generic information. $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + deploymentStage: + description: Output only. The deployment stage of the model. + readOnly: true + type: string + enumDescriptions: + - Default value. This value is unused. + - The deployment is initializing and setting up the environment. + - The deployment is preparing the model assets. + - The deployment is creating the underlying serving cluster. + - The deployment is adding nodes to the serving cluster. + - >- + The deployment is getting the container image for the model + server. + - The deployment is starting the model server. + - The deployment is performing finalization steps. + - The deployment has terminated. + enum: + - DEPLOYMENT_STAGE_UNSPECIFIED + - STARTING_DEPLOYMENT + - PREPARING_MODEL + - CREATING_SERVING_CLUSTER + - ADDING_NODES_TO_CLUSTER + - GETTING_CONTAINER_IMAGE + - STARTING_MODEL_SERVER + - FINISHING_UP + - DEPLOYMENT_TERMINATED GoogleCloudAiplatformV1DeployModelResponse: id: GoogleCloudAiplatformV1DeployModelResponse description: Response message for EndpointService.DeployModel. @@ -19851,6 +24600,46 @@ components: description: Response message of ModelService.ExportModel operation. type: object properties: {} + GoogleCloudAiplatformV1GenerateVideoResponse: + id: GoogleCloudAiplatformV1GenerateVideoResponse + description: Generate video response. + type: object + properties: + generatedSamples: + description: The cloud storage uris of the generated videos. + deprecated: true + type: array + items: + type: string + raiMediaFilteredCount: + description: Returns if any videos were filtered due to RAI policies. + type: integer + format: int32 + raiMediaFilteredReasons: + description: Returns rai failure reasons if any. + type: array + items: + type: string + videos: + description: List of video bytes or Cloud Storage URIs of the generated videos. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateVideoResponseVideo + GoogleCloudAiplatformV1GenerateVideoResponseVideo: + id: GoogleCloudAiplatformV1GenerateVideoResponseVideo + description: A generated video. + type: object + properties: + gcsUri: + description: Cloud Storage URI where the generated video is written. + type: string + bytesBase64Encoded: + description: Base64 encoded bytes string representing the video. + type: string + mimeType: + description: The MIME type of the content of the video. - video/mp4 + type: string GoogleCloudAiplatformV1ImportDataOperationMetadata: id: GoogleCloudAiplatformV1ImportDataOperationMetadata description: Runtime operation information for DatasetService.ImportData. @@ -20066,14 +24855,6 @@ components: progressMessage: description: Progress Message for Reboot LRO type: string - GoogleCloudAiplatformV1RestoreDatasetVersionOperationMetadata: - id: GoogleCloudAiplatformV1RestoreDatasetVersionOperationMetadata - description: Runtime operation information for DatasetService.RestoreDatasetVersion. - type: object - properties: - genericMetadata: - description: The common part of the operation metadata. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' GoogleCloudAiplatformV1StartNotebookRuntimeOperationMetadata: id: GoogleCloudAiplatformV1StartNotebookRuntimeOperationMetadata description: Metadata information for NotebookService.StartNotebookRuntime. @@ -24082,6 +28863,371 @@ components: message: description: Error message with additional details. type: string + CloudAiLargeModelsVisionGenerateVideoResponse: + id: CloudAiLargeModelsVisionGenerateVideoResponse + description: Generate video response. + type: object + properties: + generatedSamples: + description: The generates samples. + type: array + items: + $ref: '#/components/schemas/CloudAiLargeModelsVisionMedia' + raiMediaFilteredCount: + description: Returns if any videos were filtered due to RAI policies. + type: integer + format: int32 + raiMediaFilteredReasons: + description: Returns rai failure reasons if any. + type: array + items: + type: string + videos: + description: List of videos, used to align naming with the external response. + type: array + items: + $ref: >- + #/components/schemas/CloudAiLargeModelsVisionGenerateVideoResponseVideo + CloudAiLargeModelsVisionMedia: + id: CloudAiLargeModelsVisionMedia + description: Media. + type: object + properties: + image: + description: Image. + $ref: '#/components/schemas/CloudAiLargeModelsVisionImage' + video: + description: Video + $ref: '#/components/schemas/CloudAiLargeModelsVisionVideo' + CloudAiLargeModelsVisionImage: + id: CloudAiLargeModelsVisionImage + description: Image. + type: object + properties: + image: + description: Raw bytes. + type: string + format: byte + uri: + description: Path to another storage (typically Google Cloud Storage). + type: string + encoding: + description: Image encoding, encoded as "image/png" or "image/jpg". + type: string + imageRaiScores: + description: RAI scores for generated image. + $ref: '#/components/schemas/CloudAiLargeModelsVisionImageRAIScores' + raiInfo: + description: RAI info for image. + $ref: '#/components/schemas/CloudAiLargeModelsVisionRaiInfo' + semanticFilterResponse: + description: Semantic filter info for image. + $ref: '#/components/schemas/CloudAiLargeModelsVisionSemanticFilterResponse' + text: + description: Text/Expanded text input for imagen. + type: string + generationSeed: + description: >- + Generation seed for the sampled image. This parameter is exposed to + the user only if one of the following is true: 1. The user specified + per-example seeds in the request. 2. The user doesn't specify the + generation seed in the request. + type: integer + format: int32 + imageSize: + description: >- + Image size. The size of the image. Can be self reported, or computed + from the image bytes. + $ref: '#/components/schemas/CloudAiLargeModelsVisionImageImageSize' + CloudAiLargeModelsVisionImageRAIScores: + id: CloudAiLargeModelsVisionImageRAIScores + description: RAI scores for generated image returned. + type: object + properties: + agileWatermarkDetectionScore: + description: Agile watermark score for image. + type: number + format: double + CloudAiLargeModelsVisionRaiInfo: + id: CloudAiLargeModelsVisionRaiInfo + description: 'Next ID: 6' + type: object + properties: + raiCategories: + description: List of rai categories' information to return + type: array + items: + type: string + scores: + description: >- + List of rai scores mapping to the rai categories. Rounded to 1 + decimal place. + type: array + items: + type: number + format: float + blockedEntities: + description: List of blocked entities from the blocklist if it is detected. + type: array + items: + type: string + detectedLabels: + description: The list of detected labels for different rai categories. + type: array + items: + $ref: '#/components/schemas/CloudAiLargeModelsVisionRaiInfoDetectedLabels' + modelName: + description: >- + The model name used to indexing into the RaiFilterConfig map. Would + either be one of imagegeneration@002-006, imagen-3.0-... api + endpoint names, or internal names used for mapping to different + filter configs (genselfie, ai_watermark) than its api endpoint. + type: string + CloudAiLargeModelsVisionRaiInfoDetectedLabels: + id: CloudAiLargeModelsVisionRaiInfoDetectedLabels + description: Filters returning list of deteceted labels, scores, and bounding boxes. + type: object + properties: + raiCategory: + description: The RAI category for the deteceted labels. + type: string + entities: + description: The list of detected entities for the rai signal. + type: array + items: + $ref: >- + #/components/schemas/CloudAiLargeModelsVisionRaiInfoDetectedLabelsEntity + CloudAiLargeModelsVisionRaiInfoDetectedLabelsEntity: + id: CloudAiLargeModelsVisionRaiInfoDetectedLabelsEntity + description: The properties for a detected entity from the rai signal. + type: object + properties: + mid: + description: MID of the label + type: string + description: + description: Description of the label + type: string + score: + description: Confidence score of the label + type: number + format: float + boundingBox: + description: Bounding box of the label + $ref: >- + #/components/schemas/CloudAiLargeModelsVisionRaiInfoDetectedLabelsBoundingBox + iouScore: + description: >- + The intersection ratio between the detection bounding box and the + mask. + type: number + format: float + CloudAiLargeModelsVisionRaiInfoDetectedLabelsBoundingBox: + id: CloudAiLargeModelsVisionRaiInfoDetectedLabelsBoundingBox + description: >- + An integer bounding box of original pixels of the image for the detected + labels. + type: object + properties: + x1: + description: The X coordinate of the top-left corner, in pixels. + type: integer + format: int32 + y1: + description: The Y coordinate of the top-left corner, in pixels. + type: integer + format: int32 + x2: + description: The X coordinate of the bottom-right corner, in pixels. + type: integer + format: int32 + y2: + description: The Y coordinate of the bottom-right corner, in pixels. + type: integer + format: int32 + CloudAiLargeModelsVisionSemanticFilterResponse: + id: CloudAiLargeModelsVisionSemanticFilterResponse + type: object + properties: + passedSemanticFilter: + description: >- + This response is added when semantic filter config is turned on in + EditConfig. It reports if this image is passed semantic filter + response. If passed_semantic_filter is false, the bounding box + information will be populated for user to check what caused the + semantic filter to fail. + type: boolean + namedBoundingBoxes: + description: >- + Class labels of the bounding boxes that failed the semantic + filtering. Bounding box coordinates. + type: array + items: + $ref: '#/components/schemas/CloudAiLargeModelsVisionNamedBoundingBox' + CloudAiLargeModelsVisionNamedBoundingBox: + id: CloudAiLargeModelsVisionNamedBoundingBox + type: object + properties: + x1: + type: number + format: float + x2: + type: number + format: float + y1: + type: number + format: float + y2: + type: number + format: float + classes: + type: array + items: + type: string + entities: + type: array + items: + type: string + scores: + type: array + items: + type: number + format: float + CloudAiLargeModelsVisionImageImageSize: + id: CloudAiLargeModelsVisionImageImageSize + description: Image size. + type: object + properties: + width: + type: integer + format: int32 + height: + type: integer + format: int32 + channels: + type: integer + format: int32 + CloudAiLargeModelsVisionVideo: + id: CloudAiLargeModelsVisionVideo + description: Video + type: object + properties: + video: + description: Raw bytes. + type: string + format: byte + uri: + description: Path to another storage (typically Google Cloud Storage). + type: string + encodedVideo: + description: Base 64 encoded video bytes. + type: string + encoding: + description: Video encoding, for example "video/mp4". + type: string + text: + description: Text/Expanded text input for Help Me Write. + type: string + CloudAiLargeModelsVisionGenerateVideoResponseVideo: + id: CloudAiLargeModelsVisionGenerateVideoResponseVideo + type: object + properties: + gcsUri: + description: Cloud Storage URI where the generated video is written. + type: string + bytesBase64Encoded: + description: Base64 encoded bytes string representing the video. + type: string + mimeType: + description: The MIME type of the content of the video. - video/mp4 + type: string + CloudAiPlatformCommonCreatePipelineJobApiErrorDetail: + id: CloudAiPlatformCommonCreatePipelineJobApiErrorDetail + description: Create API error message for Vertex Pipeline. + type: object + properties: + errorCause: + description: The error root cause returned by CreatePipelineJob API. + type: string + enumDescriptions: + - Should never be used. + - IR Pipeline Spec can not been parsed to yaml or json format. + - A pipeline spec is invalid. + - A deployment config is invalid. + - A deployment spec is invalid. + - An instance schema is invalid. + - A custom job is invalid. + - A container spec is invalid. + - Notification email setup is invalid. + - Service account setup is invalid. + - KMS setup is invalid. + - Network setup is invalid. + - Task spec is invalid. + - Task artifact is invalid. + - Importer spec is invalid. + - Resolver spec is invalid. + - Runtime Parameters are invalid. + - Cloud API not enabled. + - Invalid Cloud Storage input uri + - Invalid Cloud Storage output uri + - Component spec of pipeline is invalid. + - DagOutputsSpec is invalid. + - DagSpec is invalid. + - Project does not have enough quota. + - An internal error with unknown cause. + enum: + - ERROR_CAUSE_UNSPECIFIED + - INVALID_PIPELINE_SPEC_FORMAT + - INVALID_PIPELINE_SPEC + - INVALID_DEPLOYMENT_CONFIG + - INVALID_DEPLOYMENT_SPEC + - INVALID_INSTANCE_SCHEMA + - INVALID_CUSTOM_JOB + - INVALID_CONTAINER_SPEC + - INVALID_NOTIFICATION_EMAIL_SETUP + - INVALID_SERVICE_ACCOUNT_SETUP + - INVALID_KMS_SETUP + - INVALID_NETWORK_SETUP + - INVALID_PIPELINE_TASK_SPEC + - INVALID_PIPELINE_TASK_ARTIFACT + - INVALID_IMPORTER_SPEC + - INVALID_RESOLVER_SPEC + - INVALID_RUNTIME_PARAMETERS + - CLOUD_API_NOT_ENABLED + - INVALID_GCS_INPUT_URI + - INVALID_GCS_OUTPUT_URI + - INVALID_COMPONENT_SPEC + - INVALID_DAG_OUTPUTS_SPEC + - INVALID_DAG_SPEC + - INSUFFICIENT_QUOTA + - INTERNAL + publicMessage: + description: Public messages contains actionable items for the error cause. + type: string + GoogleCloudAiplatformV1CreateDatasetOperationMetadata: + id: GoogleCloudAiplatformV1CreateDatasetOperationMetadata + description: Runtime operation information for DatasetService.CreateDataset. + type: object + properties: + genericMetadata: + description: The operation generic information. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + GoogleCloudAiplatformV1CreateDatasetVersionOperationMetadata: + id: GoogleCloudAiplatformV1CreateDatasetVersionOperationMetadata + description: Runtime operation information for DatasetService.CreateDatasetVersion. + type: object + properties: + genericMetadata: + description: The common part of the operation metadata. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + GoogleCloudAiplatformV1RestoreDatasetVersionOperationMetadata: + id: GoogleCloudAiplatformV1RestoreDatasetVersionOperationMetadata + description: Runtime operation information for DatasetService.RestoreDatasetVersion. + type: object + properties: + genericMetadata: + description: The common part of the operation metadata. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' GoogleCloudAiplatformV1SchemaImageBoundingBoxAnnotation: id: GoogleCloudAiplatformV1SchemaImageBoundingBoxAnnotation description: Annotation details specific to image object detection. @@ -24427,8 +29573,9 @@ components: properties: gcsUri: description: >- - Output only. Google Cloud Storage URI points to the original text in - user's bucket. The text file is up to 10MB in size. + Output only. Google Cloud Storage URI points to a copy of the + original text in the Vertex-managed bucket in the user's project. + The text file is up to 10MB in size. readOnly: true type: string GoogleCloudAiplatformV1SchemaTextDatasetMetadata: @@ -25131,325 +30278,58 @@ components: id: GoogleCloudAiplatformV1SchemaVisualInspectionMaskSavedQueryMetadata type: object properties: {} - CloudAiLargeModelsVisionGenerateVideoResponse: - id: CloudAiLargeModelsVisionGenerateVideoResponse - description: Generate video response. - type: object - properties: - generatedSamples: - description: The generates samples. - type: array - items: - $ref: '#/components/schemas/CloudAiLargeModelsVisionMedia' - raiMediaFilteredCount: - description: Returns if any videos were filtered due to RAI policies. - type: integer - format: int32 - raiMediaFilteredReasons: - description: Returns rai failure reasons if any. - type: array - items: - type: string - CloudAiLargeModelsVisionMedia: - id: CloudAiLargeModelsVisionMedia - description: Media. + GoogleCloudAiplatformV1DeployOperationMetadata: + id: GoogleCloudAiplatformV1DeployOperationMetadata + description: Runtime operation information for ModelGardenService.Deploy. type: object properties: - image: - description: Image. - $ref: '#/components/schemas/CloudAiLargeModelsVisionImage' - video: - description: Video - $ref: '#/components/schemas/CloudAiLargeModelsVisionVideo' - CloudAiLargeModelsVisionImage: - id: CloudAiLargeModelsVisionImage - description: Image. - type: object - properties: - image: - description: Raw bytes. - type: string - format: byte - uri: - description: Path to another storage (typically Google Cloud Storage). - type: string - encoding: - description: Image encoding, encoded as "image/png" or "image/jpg". - type: string - imageRaiScores: - description: RAI scores for generated image. - $ref: '#/components/schemas/CloudAiLargeModelsVisionImageRAIScores' - raiInfo: - description: RAI info for image. - $ref: '#/components/schemas/CloudAiLargeModelsVisionRaiInfo' - semanticFilterResponse: - description: Semantic filter info for image. - $ref: '#/components/schemas/CloudAiLargeModelsVisionSemanticFilterResponse' - text: - description: Text/Expanded text input for imagen. + genericMetadata: + description: The operation generic information. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + publisherModel: + description: Output only. The name of the model resource. + readOnly: true type: string - generationSeed: - description: >- - Generation seed for the sampled image. This parameter is exposed to - the user only if one of the following is true: 1. The user specified - per-example seeds in the request. 2. The user doesn't specify the - generation seed in the request. - type: integer - format: int32 - imageSize: - description: >- - Image size. The size of the image. Can be self reported, or computed - from the image bytes. - $ref: '#/components/schemas/CloudAiLargeModelsVisionImageImageSize' - CloudAiLargeModelsVisionImageRAIScores: - id: CloudAiLargeModelsVisionImageRAIScores - description: RAI scores for generated image returned. - type: object - properties: - agileWatermarkDetectionScore: - description: Agile watermark score for image. - type: number - format: double - CloudAiLargeModelsVisionRaiInfo: - id: CloudAiLargeModelsVisionRaiInfo - description: 'Next ID: 6' - type: object - properties: - raiCategories: - description: List of rai categories' information to return - type: array - items: - type: string - scores: - description: >- - List of rai scores mapping to the rai categories. Rounded to 1 - decimal place. - type: array - items: - type: number - format: float - blockedEntities: - description: List of blocked entities from the blocklist if it is detected. - type: array - items: - type: string - detectedLabels: - description: The list of detected labels for different rai categories. - type: array - items: - $ref: '#/components/schemas/CloudAiLargeModelsVisionRaiInfoDetectedLabels' - modelName: + destination: description: >- - The model name used to indexing into the RaiFilterConfig map. Would - either be one of imagegeneration@002-006, imagen-3.0-... api - endpoint names, or internal names used for mapping to different - filter configs (genselfie, ai_watermark) than its api endpoint. - type: string - CloudAiLargeModelsVisionRaiInfoDetectedLabels: - id: CloudAiLargeModelsVisionRaiInfoDetectedLabels - description: Filters returning list of deteceted labels, scores, and bounding boxes. - type: object - properties: - raiCategory: - description: The RAI category for the deteceted labels. + Output only. The resource name of the Location to deploy the model + in. Format: `projects/{project}/locations/{location}` + readOnly: true type: string - entities: - description: The list of detected entities for the rai signal. - type: array - items: - $ref: >- - #/components/schemas/CloudAiLargeModelsVisionRaiInfoDetectedLabelsEntity - CloudAiLargeModelsVisionRaiInfoDetectedLabelsEntity: - id: CloudAiLargeModelsVisionRaiInfoDetectedLabelsEntity - description: The properties for a detected entity from the rai signal. - type: object - properties: - mid: - description: MID of the label + projectNumber: + description: >- + Output only. The project number where the deploy model request is + sent. + readOnly: true type: string - description: - description: Description of the label + format: int64 + modelId: + description: Output only. The model id to be used at query time. + readOnly: true type: string - score: - description: Confidence score of the label - type: number - format: float - boundingBox: - description: Bounding box of the label - $ref: >- - #/components/schemas/CloudAiLargeModelsVisionRaiInfoDetectedLabelsBoundingBox - iouScore: - description: >- - The intersection ratio between the detection bounding box and the - mask. - type: number - format: float - CloudAiLargeModelsVisionRaiInfoDetectedLabelsBoundingBox: - id: CloudAiLargeModelsVisionRaiInfoDetectedLabelsBoundingBox - description: >- - An integer bounding box of original pixels of the image for the detected - labels. + GoogleCloudAiplatformV1DeployResponse: + id: GoogleCloudAiplatformV1DeployResponse + description: Response message for ModelGardenService.Deploy. type: object properties: - x1: - description: The X coordinate of the top-left corner, in pixels. - type: integer - format: int32 - y1: - description: The Y coordinate of the top-left corner, in pixels. - type: integer - format: int32 - x2: - description: The X coordinate of the bottom-right corner, in pixels. - type: integer - format: int32 - y2: - description: The Y coordinate of the bottom-right corner, in pixels. - type: integer - format: int32 - CloudAiLargeModelsVisionSemanticFilterResponse: - id: CloudAiLargeModelsVisionSemanticFilterResponse - type: object - properties: - passedSemanticFilter: - description: >- - This response is added when semantic filter config is turned on in - EditConfig. It reports if this image is passed semantic filter - response. If passed_semantic_filter is false, the bounding box - information will be populated for user to check what caused the - semantic filter to fail. - type: boolean - namedBoundingBoxes: + publisherModel: description: >- - Class labels of the bounding boxes that failed the semantic - filtering. Bounding box coordinates. - type: array - items: - $ref: '#/components/schemas/CloudAiLargeModelsVisionNamedBoundingBox' - CloudAiLargeModelsVisionNamedBoundingBox: - id: CloudAiLargeModelsVisionNamedBoundingBox - type: object - properties: - x1: - type: number - format: float - x2: - type: number - format: float - y1: - type: number - format: float - y2: - type: number - format: float - classes: - type: array - items: - type: string - entities: - type: array - items: - type: string - scores: - type: array - items: - type: number - format: float - CloudAiLargeModelsVisionImageImageSize: - id: CloudAiLargeModelsVisionImageImageSize - description: Image size. - type: object - properties: - width: - type: integer - format: int32 - height: - type: integer - format: int32 - channels: - type: integer - format: int32 - CloudAiLargeModelsVisionVideo: - id: CloudAiLargeModelsVisionVideo - description: Video - type: object - properties: - video: - description: Raw bytes. - type: string - format: byte - uri: - description: Path to another storage (typically Google Cloud Storage). - type: string - encodedVideo: - description: Base 64 encoded video bytes. - type: string - format: byte - encoding: - description: Video encoding, for example "video/mp4". + Output only. The name of the PublisherModel resource. Format: + `publishers/{publisher}/models/{publisher_model}@{version_id}`, or + `publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001` + readOnly: true type: string - CloudAiPlatformCommonCreatePipelineJobApiErrorDetail: - id: CloudAiPlatformCommonCreatePipelineJobApiErrorDetail - description: 'Create API error message for Vertex Pipeline. Next Id: 3.' - type: object - properties: - errorCause: - description: The error root cause returned by CreatePipelineJob API. + endpoint: + description: >- + Output only. The name of the Endpoint created. Format: + `projects/{project}/locations/{location}/endpoints/{endpoint}` + readOnly: true type: string - enumDescriptions: - - Should never be used. - - IR Pipeline Spec can not been parsed to yaml or json format. - - A pipeline spec is invalid. - - A deployment config is invalid. - - A deployment spec is invalid. - - An instance schema is invalid. - - A custom job is invalid. - - A container spec is invalid. - - Notification email setup is invalid. - - Service account setup is invalid. - - KMS setup is invalid. - - Network setup is invalid. - - Task spec is invalid. - - Task artifact is invalid. - - Importer spec is invalid. - - Resolver spec is invalid. - - Runtime Parameters are invalid. - - Cloud API not enabled. - - Invalid GCS input uri - - Invalid GCS output uri - - Component spec of pipeline is invalid. - - DagOutputsSpec is invalid. - - DagSpec is invalid. - - Project does not have enough quota. - - An internal error with unknown cause. - enum: - - ERROR_CAUSE_UNSPECIFIED - - INVALID_PIPELINE_SPEC_FORMAT - - INVALID_PIPELINE_SPEC - - INVALID_DEPLOYMENT_CONFIG - - INVALID_DEPLOYMENT_SPEC - - INVALID_INSTANCE_SCHEMA - - INVALID_CUSTOM_JOB - - INVALID_CONTAINER_SPEC - - INVALID_NOTIFICATION_EMAIL_SETUP - - INVALID_SERVICE_ACCOUNT_SETUP - - INVALID_KMS_SETUP - - INVALID_NETWORK_SETUP - - INVALID_PIPELINE_TASK_SPEC - - INVALID_PIPELINE_TASK_ARTIFACT - - INVALID_IMPORTER_SPEC - - INVALID_RESOLVER_SPEC - - INVALID_RUNTIME_PARAMETERS - - CLOUD_API_NOT_ENABLED - - INVALID_GCS_INPUT_URI - - INVALID_GCS_OUTPUT_URI - - INVALID_COMPONENT_SPEC - - INVALID_DAG_OUTPUTS_SPEC - - INVALID_DAG_SPEC - - INSUFFICIENT_QUOTA - - INTERNAL - publicMessage: - description: Public messages contains actionable items for the error cause. + model: + description: >- + Output only. The name of the Model created. Format: + `projects/{project}/locations/{location}/models/{model}` + readOnly: true type: string parameters: access_token: @@ -25716,6 +30596,41 @@ components: response: mediaType: application/json openAPIDocKey: '200' + evaluate_dataset: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:evaluateDataset/post + response: + mediaType: application/json + openAPIDocKey: '200' + generate_instance_rubrics: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:generateInstanceRubrics/post + response: + mediaType: application/json + openAPIDocKey: '200' + deploy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:deploy/post + response: + mediaType: application/json + openAPIDocKey: '200' + augment_prompt: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:augmentPrompt/post + response: + mediaType: application/json + openAPIDocKey: '200' + corroborate_content: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:corroborateContent/post + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/locations/methods/get' @@ -25724,6 +30639,122 @@ components: update: [] replace: [] delete: [] + rag_engine_config: + id: google.aiplatform.rag_engine_config + name: rag_engine_config + title: Rag_engine_config + methods: + update_rag_engine_config: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ragEngineConfig/patch + response: + mediaType: application/json + openAPIDocKey: '200' + get_rag_engine_config: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ragEngineConfig/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/rag_engine_config/methods/get_rag_engine_config + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/rag_engine_config/methods/update_rag_engine_config + replace: [] + delete: [] + contexts: + id: google.aiplatform.contexts + name: contexts + title: Contexts + methods: + retrieve_contexts: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:retrieveContexts/post + response: + mediaType: application/json + openAPIDocKey: '200' + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.contexts + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + purge: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts:purge/post + response: + mediaType: application/json + openAPIDocKey: '200' + add_context_artifacts_and_executions: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}:addContextArtifactsAndExecutions/post + response: + mediaType: application/json + openAPIDocKey: '200' + add_context_children: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}:addContextChildren/post + response: + mediaType: application/json + openAPIDocKey: '200' + remove_context_children: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}:removeContextChildren/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/contexts/methods/get' + - $ref: '#/components/x-stackQL-resources/contexts/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/contexts/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/contexts/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/contexts/methods/delete' featurestores_iam_policies: id: google.aiplatform.featurestores_iam_policies name: featurestores_iam_policies @@ -25940,6 +30971,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + delete_feature_values: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:deleteFeatureValues/post + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/entity_types/methods/get' @@ -25951,26 +30989,6 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/entity_types/methods/delete' - entity_types_feature_values: - id: google.aiplatform.entity_types_feature_values - name: entity_types_feature_values - title: Entity_types_feature_values - methods: - delete_feature_values: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:deleteFeatureValues/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/entity_types_feature_values/methods/delete_feature_values operations: id: google.aiplatform.operations name: operations @@ -25979,7 +30997,7 @@ components: list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials~1{trialsId}~1operations/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ragCorpora~1{ragCorporaId}~1operations/get response: mediaType: application/json openAPIDocKey: '200' @@ -25987,28 +31005,28 @@ components: get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials~1{trialsId}~1operations~1{operationsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ragCorpora~1{ragCorporaId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials~1{trialsId}~1operations~1{operationsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ragCorpora~1{ragCorporaId}~1operations~1{operationsId}/delete response: mediaType: application/json openAPIDocKey: '200' cancel: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials~1{trialsId}~1operations~1{operationsId}:cancel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ragCorpora~1{ragCorporaId}~1operations~1{operationsId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' wait: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials~1{trialsId}~1operations~1{operationsId}:wait/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ragCorpora~1{ragCorporaId}~1operations~1{operationsId}:wait/post response: mediaType: application/json openAPIDocKey: '200' @@ -26158,6 +31176,13 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.models + update_explanation_dataset: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:updateExplanationDataset/post + response: + mediaType: application/json + openAPIDocKey: '200' merge_version_aliases: operation: $ref: >- @@ -26182,7 +31207,7 @@ components: predict: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:predict/post + #/paths/~1v1~1publishers~1{publishersId}~1models~1{modelsId}:predict/post response: mediaType: application/json openAPIDocKey: '200' @@ -26210,7 +31235,7 @@ components: predict_long_running: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:predictLongRunning/post + #/paths/~1v1~1publishers~1{publishersId}~1models~1{modelsId}:predictLongRunning/post response: mediaType: application/json openAPIDocKey: '200' @@ -26242,6 +31267,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + fetch_predict_operation: + operation: + $ref: >- + #/paths/~1v1~1publishers~1{publishersId}~1models~1{modelsId}:fetchPredictOperation/post + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/models/methods/get' @@ -26273,30 +31305,31 @@ components: update: [] replace: [] delete: [] - models_explanation_dataset: - id: google.aiplatform.models_explanation_dataset - name: models_explanation_dataset - title: Models_explanation_dataset + models_checkpoints: + id: google.aiplatform.models_checkpoints + name: models_checkpoints + title: Models_checkpoints methods: - update_explanation_dataset: + list_checkpoints: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:updateExplanationDataset/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:listCheckpoints/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.checkpoints sqlVerbs: - select: [] - insert: [] - update: + select: - $ref: >- - #/components/x-stackQL-resources/models_explanation_dataset/methods/update_explanation_dataset + #/components/x-stackQL-resources/models_checkpoints/methods/list_checkpoints + insert: [] + update: [] replace: [] delete: [] - models_version: - id: google.aiplatform.models_version - name: models_version - title: Models_version + model_versions: + id: google.aiplatform.model_versions + name: model_versions + title: Model_versions methods: delete_version: operation: @@ -26312,7 +31345,7 @@ components: replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/models_version/methods/delete_version + #/components/x-stackQL-resources/model_versions/methods/delete_version evaluations: id: google.aiplatform.evaluations name: evaluations @@ -26655,6 +31688,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + fetch_feature_values: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}:fetchFeatureValues/post + response: + mediaType: application/json + openAPIDocKey: '200' search_nearest_entities: operation: $ref: >- @@ -26662,6 +31702,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + direct_write: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}:directWrite/post + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/feature_views/methods/get' @@ -26673,26 +31720,6 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/feature_views/methods/delete' - feature_views_feature_values: - id: google.aiplatform.feature_views_feature_values - name: feature_views_feature_values - title: Feature_views_feature_values - methods: - fetch_feature_values: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}:fetchFeatureValues/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/feature_views_feature_values/methods/fetch_feature_values - insert: [] - update: [] - replace: [] - delete: [] operations_wait: id: google.aiplatform.operations_wait name: operations_wait @@ -26701,7 +31728,7 @@ components: list_wait: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}~1features~1{featuresId}~1operations~1{operationsId}:wait/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}~1operations~1{operationsId}:wait/get response: mediaType: application/json openAPIDocKey: '200' @@ -26741,6 +31768,116 @@ components: update: [] replace: [] delete: [] + feature_groups_iam_policies: + id: google.aiplatform.feature_groups_iam_policies + name: feature_groups_iam_policies + title: Feature_groups_iam_policies + methods: + set_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}:setIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + get_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}:getIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.bindings + test_iam_permissions: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}:testIamPermissions/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/feature_groups_iam_policies/methods/get_iam_policy + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/feature_groups_iam_policies/methods/set_iam_policy + delete: [] + feature_groups: + id: google.aiplatform.feature_groups + name: feature_groups + title: Feature_groups + methods: + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.featureGroups + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/feature_groups/methods/get' + - $ref: '#/components/x-stackQL-resources/feature_groups/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/feature_groups/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/feature_groups/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/feature_groups/methods/delete' + feature_group_operations: + id: google.aiplatform.feature_group_operations + name: feature_group_operations + title: Feature_group_operations + methods: + list_wait: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}~1features~1{featuresId}~1operations~1{operationsId}:wait/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.operations + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/feature_group_operations/methods/list_wait + insert: [] + update: [] + replace: [] + delete: [] data_items: id: google.aiplatform.data_items name: data_items @@ -26935,6 +32072,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + update: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:update/post + response: + mediaType: application/json + openAPIDocKey: '200' deploy_model: operation: $ref: >- @@ -26958,8 +32102,7 @@ components: openAPIDocKey: '200' predict: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:predict/post + $ref: '#/paths/~1v1~1endpoints~1{endpointsId}:predict/post' response: mediaType: application/json openAPIDocKey: '200' @@ -27000,8 +32143,7 @@ components: openAPIDocKey: '200' predict_long_running: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:predictLongRunning/post + $ref: '#/paths/~1v1~1endpoints~1{endpointsId}:predictLongRunning/post' response: mediaType: application/json openAPIDocKey: '200' @@ -27036,6 +32178,12 @@ components: response: mediaType: application/json openAPIDocKey: '200' + fetch_predict_operation: + operation: + $ref: '#/paths/~1v1~1endpoints~1{endpointsId}:fetchPredictOperation/post' + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/endpoints/methods/get' @@ -27044,6 +32192,7 @@ components: - $ref: '#/components/x-stackQL-resources/endpoints/methods/create' update: - $ref: '#/components/x-stackQL-resources/endpoints/methods/patch' + - $ref: '#/components/x-stackQL-resources/endpoints/methods/update' replace: [] delete: - $ref: '#/components/x-stackQL-resources/endpoints/methods/delete' @@ -27074,8 +32223,7 @@ components: methods: completions: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}~1chat~1completions/post + $ref: '#/paths/~1v1~1endpoints~1{endpointsId}~1chat~1completions/post' response: mediaType: application/json openAPIDocKey: '200' @@ -27085,58 +32233,58 @@ components: update: [] replace: [] delete: [] - feature_groups: - id: google.aiplatform.feature_groups - name: feature_groups - title: Feature_groups + cached_contents: + id: google.aiplatform.cached_contents + name: cached_contents + title: Cached_contents methods: create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1cachedContents/post response: mediaType: application/json openAPIDocKey: '200' list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1cachedContents/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.featureGroups + objectKey: $.cachedContents get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1cachedContents~1{cachedContentsId}/get response: mediaType: application/json openAPIDocKey: '200' patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1cachedContents~1{cachedContentsId}/patch response: mediaType: application/json openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1cachedContents~1{cachedContentsId}/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/feature_groups/methods/get' - - $ref: '#/components/x-stackQL-resources/feature_groups/methods/list' + - $ref: '#/components/x-stackQL-resources/cached_contents/methods/get' + - $ref: '#/components/x-stackQL-resources/cached_contents/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/feature_groups/methods/create' + - $ref: '#/components/x-stackQL-resources/cached_contents/methods/create' update: - - $ref: '#/components/x-stackQL-resources/feature_groups/methods/patch' + - $ref: '#/components/x-stackQL-resources/cached_contents/methods/patch' replace: [] delete: - - $ref: '#/components/x-stackQL-resources/feature_groups/methods/delete' + - $ref: '#/components/x-stackQL-resources/cached_contents/methods/delete' tuning_jobs: id: google.aiplatform.tuning_jobs name: tuning_jobs @@ -27235,6 +32383,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + remove_datapoints: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes~1{indexesId}:removeDatapoints/post + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/indexes/methods/get' @@ -27246,26 +32401,6 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/indexes/methods/delete' - indexes_datapoints: - id: google.aiplatform.indexes_datapoints - name: indexes_datapoints - title: Indexes_datapoints - methods: - remove_datapoints: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes~1{indexesId}:removeDatapoints/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/indexes_datapoints/methods/remove_datapoints index_endpoints: id: google.aiplatform.index_endpoints name: index_endpoints @@ -27596,23 +32731,20 @@ components: methods: create: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1batchPredictionJobs/post + $ref: '#/paths/~1v1~1batchPredictionJobs/post' response: mediaType: application/json openAPIDocKey: '200' list: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1batchPredictionJobs/get + $ref: '#/paths/~1v1~1batchPredictionJobs/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.batchPredictionJobs get: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1batchPredictionJobs~1{batchPredictionJobsId}/get + $ref: '#/paths/~1v1~1batchPredictionJobs~1{batchPredictionJobsId}/get' response: mediaType: application/json openAPIDocKey: '200' @@ -27853,54 +32985,11 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/artifacts/methods/delete' - contexts: - id: google.aiplatform.contexts - name: contexts - title: Contexts + context_lineage_subgraph: + id: google.aiplatform.context_lineage_subgraph + name: context_lineage_subgraph + title: Context_lineage_subgraph methods: - create: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts/post - response: - mediaType: application/json - openAPIDocKey: '200' - list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.contexts - get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - patch: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - purge: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts:purge/post - response: - mediaType: application/json - openAPIDocKey: '200' query_context_lineage_subgraph: operation: $ref: >- @@ -27910,66 +32999,12 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/contexts/methods/get' - $ref: >- - #/components/x-stackQL-resources/contexts/methods/query_context_lineage_subgraph - - $ref: '#/components/x-stackQL-resources/contexts/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/contexts/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/contexts/methods/patch' - replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/contexts/methods/delete' - contexts_context_artifacts_and_executions: - id: google.aiplatform.contexts_context_artifacts_and_executions - name: contexts_context_artifacts_and_executions - title: Contexts_context_artifacts_and_executions - methods: - add_context_artifacts_and_executions: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}:addContextArtifactsAndExecutions/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: >- - #/components/x-stackQL-resources/contexts_context_artifacts_and_executions/methods/add_context_artifacts_and_executions + #/components/x-stackQL-resources/context_lineage_subgraph/methods/query_context_lineage_subgraph + insert: [] update: [] replace: [] delete: [] - contexts_context_children: - id: google.aiplatform.contexts_context_children - name: contexts_context_children - title: Contexts_context_children - methods: - add_context_children: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}:addContextChildren/post - response: - mediaType: application/json - openAPIDocKey: '200' - remove_context_children: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}:removeContextChildren/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: >- - #/components/x-stackQL-resources/contexts_context_children/methods/add_context_children - update: [] - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/contexts_context_children/methods/remove_context_children executions: id: google.aiplatform.executions name: executions @@ -28018,18 +33053,16 @@ components: response: mediaType: application/json openAPIDocKey: '200' - query_execution_inputs_and_outputs: + add_execution_events: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions~1{executionsId}:queryExecutionInputsAndOutputs/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions~1{executionsId}:addExecutionEvents/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/executions/methods/get' - - $ref: >- - #/components/x-stackQL-resources/executions/methods/query_execution_inputs_and_outputs - $ref: '#/components/x-stackQL-resources/executions/methods/list' insert: - $ref: '#/components/x-stackQL-resources/executions/methods/create' @@ -28038,23 +33071,23 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/executions/methods/delete' - executions_execution_events: - id: google.aiplatform.executions_execution_events - name: executions_execution_events - title: Executions_execution_events + execution_lineage_subgraph: + id: google.aiplatform.execution_lineage_subgraph + name: execution_lineage_subgraph + title: Execution_lineage_subgraph methods: - add_execution_events: + query_execution_inputs_and_outputs: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions~1{executionsId}:addExecutionEvents/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions~1{executionsId}:queryExecutionInputsAndOutputs/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] - insert: + select: - $ref: >- - #/components/x-stackQL-resources/executions_execution_events/methods/add_execution_events + #/components/x-stackQL-resources/execution_lineage_subgraph/methods/query_execution_inputs_and_outputs + insert: [] update: [] replace: [] delete: [] @@ -28411,6 +33444,66 @@ components: - $ref: '#/components/x-stackQL-resources/pipeline_jobs/methods/delete' - $ref: >- #/components/x-stackQL-resources/pipeline_jobs/methods/batch_delete + reasoning_engines: + id: google.aiplatform.reasoning_engines + name: reasoning_engines + title: Reasoning_engines + methods: + query: + operation: + $ref: '#/paths/~1v1~1reasoningEngines~1{reasoningEnginesId}:query/post' + response: + mediaType: application/json + openAPIDocKey: '200' + stream_query: + operation: + $ref: >- + #/paths/~1v1~1reasoningEngines~1{reasoningEnginesId}:streamQuery/post + response: + mediaType: application/json + openAPIDocKey: '200' + create: + operation: + $ref: '#/paths/~1v1~1reasoningEngines/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1v1~1reasoningEngines/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.reasoningEngines + get: + operation: + $ref: '#/paths/~1v1~1reasoningEngines~1{reasoningEnginesId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: '#/paths/~1v1~1reasoningEngines~1{reasoningEnginesId}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1v1~1reasoningEngines~1{reasoningEnginesId}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/reasoning_engines/methods/get' + - $ref: '#/components/x-stackQL-resources/reasoning_engines/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/reasoning_engines/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/reasoning_engines/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/reasoning_engines/methods/delete' schedules: id: google.aiplatform.schedules name: schedules @@ -28901,6 +33994,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + add_trial_measurement: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials~1{trialsId}:addTrialMeasurement/post + response: + mediaType: application/json + openAPIDocKey: '200' complete: operation: $ref: >- @@ -28932,46 +34032,179 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/trials/methods/delete' - trials_trial_measurement: - id: google.aiplatform.trials_trial_measurement - name: trials_trial_measurement - title: Trials_trial_measurement + optimal_trials: + id: google.aiplatform.optimal_trials + name: optimal_trials + title: Optimal_trials methods: - add_trial_measurement: + list_optimal_trials: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials~1{trialsId}:addTrialMeasurement/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials:listOptimalTrials/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] - insert: + select: - $ref: >- - #/components/x-stackQL-resources/trials_trial_measurement/methods/add_trial_measurement + #/components/x-stackQL-resources/optimal_trials/methods/list_optimal_trials + insert: [] update: [] replace: [] delete: [] - trials_optimal_trials: - id: google.aiplatform.trials_optimal_trials - name: trials_optimal_trials - title: Trials_optimal_trials + rag_corpora: + id: google.aiplatform.rag_corpora + name: rag_corpora + title: Rag_corpora methods: - list_optimal_trials: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials:listOptimalTrials/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ragCorpora/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ragCorpora/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.ragCorpora + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ragCorpora~1{ragCorporaId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ragCorpora~1{ragCorporaId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ragCorpora~1{ragCorporaId}/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/trials_optimal_trials/methods/list_optimal_trials + - $ref: '#/components/x-stackQL-resources/rag_corpora/methods/get' + - $ref: '#/components/x-stackQL-resources/rag_corpora/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/rag_corpora/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/rag_corpora/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/rag_corpora/methods/delete' + rag_files: + id: google.aiplatform.rag_files + name: rag_files + title: Rag_files + methods: + import: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ragCorpora~1{ragCorporaId}~1ragFiles:import/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ragCorpora~1{ragCorporaId}~1ragFiles~1{ragFilesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ragCorpora~1{ragCorporaId}~1ragFiles~1{ragFilesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ragCorpora~1{ragCorporaId}~1ragFiles/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.ragFiles + upload: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ragCorpora~1{ragCorporaId}~1ragFiles:upload/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/rag_files/methods/get' + - $ref: '#/components/x-stackQL-resources/rag_files/methods/list' insert: [] update: [] replace: [] - delete: [] + delete: + - $ref: '#/components/x-stackQL-resources/rag_files/methods/delete' + rag_file_operations: + id: google.aiplatform.rag_file_operations + name: rag_file_operations + title: Rag_file_operations + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ragCorpora~1{ragCorporaId}~1ragFiles~1{ragFilesId}~1operations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.operations + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ragCorpora~1{ragCorporaId}~1ragFiles~1{ragFilesId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ragCorpora~1{ragCorporaId}~1ragFiles~1{ragFilesId}~1operations~1{operationsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + cancel: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ragCorpora~1{ragCorporaId}~1ragFiles~1{ragFilesId}~1operations~1{operationsId}:cancel/post + response: + mediaType: application/json + openAPIDocKey: '200' + wait: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ragCorpora~1{ragCorporaId}~1ragFiles~1{ragFilesId}~1operations~1{operationsId}:wait/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/rag_file_operations/methods/get' + - $ref: '#/components/x-stackQL-resources/rag_file_operations/methods/list' + insert: [] + update: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/rag_file_operations/methods/delete paths: /v1/datasets: parameters: &ref_1 @@ -28987,13 +34220,1714 @@ paths: - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/_.xgafv' post: - description: Creates a Dataset. - operationId: aiplatform.datasets.create + description: Creates a Dataset. + operationId: aiplatform.datasets.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: query + name: parent + schema: + type: string + get: + description: Lists Datasets in a Location. + operationId: aiplatform.datasets.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListDatasetsResponse + parameters: + - in: query + name: parent + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: orderBy + schema: + type: string + /v1/datasets/{datasetsId}: + parameters: *ref_1 + get: + description: Gets a Dataset. + operationId: aiplatform.datasets.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' + parameters: + - in: path + name: datasetsId + required: true + schema: + type: string + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + patch: + description: Updates a Dataset. + operationId: aiplatform.datasets.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' + parameters: + - in: path + name: datasetsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a Dataset. + operationId: aiplatform.datasets.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: datasetsId + required: true + schema: + type: string + /v1/datasets/{datasetsId}/datasetVersions: + parameters: *ref_1 + post: + description: Create a version from a Dataset. + operationId: aiplatform.datasets.datasetVersions.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: datasetsId + required: true + schema: + type: string + get: + description: Lists DatasetVersions in a Dataset. + operationId: aiplatform.datasets.datasetVersions.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListDatasetVersionsResponse + parameters: + - in: path + name: datasetsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: orderBy + schema: + type: string + /v1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}: + parameters: *ref_1 + patch: + description: Updates a DatasetVersion. + operationId: aiplatform.datasets.datasetVersions.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' + parameters: + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: datasetVersionsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a Dataset version. + operationId: aiplatform.datasets.datasetVersions.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: datasetVersionsId + required: true + schema: + type: string + get: + description: Gets a Dataset version. + operationId: aiplatform.datasets.datasetVersions.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' + parameters: + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: datasetVersionsId + required: true + schema: + type: string + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + /v1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}:restore: + parameters: *ref_1 + get: + description: Restores a dataset version. + operationId: aiplatform.datasets.datasetVersions.restore + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: datasetVersionsId + required: true + schema: + type: string + /v1/projects/{projectsId}/cacheConfig: + parameters: *ref_1 + patch: + description: Updates a cache config. + operationId: aiplatform.projects.updateCacheConfig + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CacheConfig' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + get: + description: Gets a GenAI cache config. + operationId: aiplatform.projects.getCacheConfig + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CacheConfig' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations: + parameters: *ref_1 + get: + description: Lists information about the supported locations for this service. + operationId: aiplatform.projects.locations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudLocationListLocationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: extraLocationTypes + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}: + parameters: *ref_1 + get: + description: Gets information about a location. + operationId: aiplatform.projects.locations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudLocationLocation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}:evaluateInstances: + parameters: *ref_1 + post: + description: Evaluates instances based on a given metric. + operationId: aiplatform.projects.locations.evaluateInstances + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1EvaluateInstancesRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1EvaluateInstancesResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}:evaluateDataset: + parameters: *ref_1 + post: + description: Evaluates a dataset based on a set of given metrics. + operationId: aiplatform.projects.locations.evaluateDataset + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1EvaluateDatasetRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}:generateInstanceRubrics: + parameters: *ref_1 + post: + description: >- + Generates rubrics for a given prompt. A rubric represents a single + testable criterion for evaluation. One input prompt could have multiple + rubrics This RPC allows users to get suggested rubrics based on provided + prompt, which can then be reviewed and used for subsequent evaluations. + operationId: aiplatform.projects.locations.generateInstanceRubrics + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateInstanceRubricsRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateInstanceRubricsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}:deploy: + parameters: *ref_1 + post: + description: Deploys a model to a new endpoint. + operationId: aiplatform.projects.locations.deploy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig: + parameters: *ref_1 + patch: + description: Updates a RagEngineConfig. + operationId: aiplatform.projects.locations.updateRagEngineConfig + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1RagEngineConfig' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + get: + description: Gets a RagEngineConfig. + operationId: aiplatform.projects.locations.getRagEngineConfig + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1RagEngineConfig' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}:retrieveContexts: + parameters: *ref_1 + post: + description: Retrieves relevant contexts for a query. + operationId: aiplatform.projects.locations.retrieveContexts + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1RetrieveContextsRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1RetrieveContextsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}:augmentPrompt: + parameters: *ref_1 + post: + description: >- + Given an input prompt, it returns augmented prompt from vertex rag store + to guide LLM towards generating grounded responses. + operationId: aiplatform.projects.locations.augmentPrompt + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1AugmentPromptRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1AugmentPromptResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}:corroborateContent: + parameters: *ref_1 + post: + description: >- + Given an input text, it returns a score that evaluates the factuality of + the text. It also extracts and returns claims from the text and provides + supporting facts. + operationId: aiplatform.projects.locations.corroborateContent + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1CorroborateContentRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1CorroborateContentResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:setIamPolicy: + parameters: *ref_1 + post: + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and + `PERMISSION_DENIED` errors. + operationId: aiplatform.projects.locations.featurestores.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featurestoresId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:getIamPolicy: + parameters: *ref_1 + post: + description: >- + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: aiplatform.projects.locations.featurestores.getIamPolicy + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featurestoresId + required: true + schema: + type: string + - in: query + name: options.requestedPolicyVersion + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:testIamPermissions: + parameters: *ref_1 + post: + description: >- + Returns permissions that a caller has on the specified resource. If the + resource does not exist, this will return an empty set of permissions, + not a `NOT_FOUND` error. Note: This operation is designed to be used for + building permission-aware UIs and command-line tools, not for + authorization checking. This operation may "fail open" without warning. + operationId: aiplatform.projects.locations.featurestores.testIamPermissions + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featurestoresId + required: true + schema: + type: string + - in: query + name: permissions + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores: + parameters: *ref_1 + post: + description: Creates a new Featurestore in a given project and location. + operationId: aiplatform.projects.locations.featurestores.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Featurestore' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: featurestoreId + schema: + type: string + get: + description: Lists Featurestores in a given project and location. + operationId: aiplatform.projects.locations.featurestores.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListFeaturestoresResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: orderBy + schema: + type: string + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}: + parameters: *ref_1 + get: + description: Gets details of a single Featurestore. + operationId: aiplatform.projects.locations.featurestores.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Featurestore' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featurestoresId + required: true + schema: + type: string + patch: + description: Updates the parameters of a single Featurestore. + operationId: aiplatform.projects.locations.featurestores.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Featurestore' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featurestoresId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: >- + Deletes a single Featurestore. The Featurestore must not contain any + EntityTypes or `force` must be set to true for the request to succeed. + operationId: aiplatform.projects.locations.featurestores.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featurestoresId + required: true + schema: + type: string + - in: query + name: force + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:batchReadFeatureValues: + parameters: *ref_1 + post: + description: >- + Batch reads Feature values from a Featurestore. This API enables batch + reading Feature values, where each read instance in the batch may read + Feature values of entities from one or more EntityTypes. Point-in-time + correctness is guaranteed for Feature values of each read instance as of + each instance's read timestamp. + operationId: aiplatform.projects.locations.featurestores.batchReadFeatureValues + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchReadFeatureValuesRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featurestoresId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores:searchFeatures: + parameters: *ref_1 + get: + description: Searches Features matching a query in a given project. + operationId: aiplatform.projects.locations.featurestores.searchFeatures + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SearchFeaturesResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: query + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:setIamPolicy: + parameters: *ref_1 + post: + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and + `PERMISSION_DENIED` errors. + operationId: aiplatform.projects.locations.featurestores.entityTypes.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featurestoresId + required: true + schema: + type: string + - in: path + name: entityTypesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:getIamPolicy: + parameters: *ref_1 + post: + description: >- + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: aiplatform.projects.locations.featurestores.entityTypes.getIamPolicy + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featurestoresId + required: true + schema: + type: string + - in: path + name: entityTypesId + required: true + schema: + type: string + - in: query + name: options.requestedPolicyVersion + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:testIamPermissions: + parameters: *ref_1 + post: + description: >- + Returns permissions that a caller has on the specified resource. If the + resource does not exist, this will return an empty set of permissions, + not a `NOT_FOUND` error. Note: This operation is designed to be used for + building permission-aware UIs and command-line tools, not for + authorization checking. This operation may "fail open" without warning. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.testIamPermissions + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featurestoresId + required: true + schema: + type: string + - in: path + name: entityTypesId + required: true + schema: + type: string + - in: query + name: permissions + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:readFeatureValues: + parameters: *ref_1 + post: + description: >- + Reads Feature values of a specific entity of an EntityType. For reading + feature values of multiple entities of an EntityType, please use + StreamingReadFeatureValues. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.readFeatureValues + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featurestoresId + required: true + schema: + type: string + - in: path + name: entityTypesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:streamingReadFeatureValues: + parameters: *ref_1 + post: + description: >- + Reads Feature values for multiple entities. Depending on their size, + data for different entities may be broken up across multiple responses. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.streamingReadFeatureValues + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StreamingReadFeatureValuesRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featurestoresId + required: true + schema: + type: string + - in: path + name: entityTypesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:writeFeatureValues: + parameters: *ref_1 + post: + description: >- + Writes Feature values of one or more entities of an EntityType. The + Feature values are merged into existing entities if any. The Feature + values to be written must have timestamp within the online storage + retention. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.writeFeatureValues + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1WriteFeatureValuesRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1WriteFeatureValuesResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featurestoresId + required: true + schema: + type: string + - in: path + name: entityTypesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes: + parameters: *ref_1 + post: + description: Creates a new EntityType in a given Featurestore. + operationId: aiplatform.projects.locations.featurestores.entityTypes.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityType' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featurestoresId + required: true + schema: + type: string + - in: query + name: entityTypeId + schema: + type: string + get: + description: Lists EntityTypes in a given Featurestore. + operationId: aiplatform.projects.locations.featurestores.entityTypes.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListEntityTypesResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featurestoresId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: orderBy + schema: + type: string + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}: + parameters: *ref_1 + get: + description: Gets details of a single EntityType. + operationId: aiplatform.projects.locations.featurestores.entityTypes.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityType' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featurestoresId + required: true + schema: + type: string + - in: path + name: entityTypesId + required: true + schema: + type: string + patch: + description: Updates the parameters of a single EntityType. + operationId: aiplatform.projects.locations.featurestores.entityTypes.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityType' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityType' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featurestoresId + required: true + schema: + type: string + - in: path + name: entityTypesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: >- + Deletes a single EntityType. The EntityType must not have any Features + or `force` must be set to true for the request to succeed. + operationId: aiplatform.projects.locations.featurestores.entityTypes.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featurestoresId + required: true + schema: + type: string + - in: path + name: entityTypesId + required: true + schema: + type: string + - in: query + name: force + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:importFeatureValues: + parameters: *ref_1 + post: + description: >- + Imports Feature values into the Featurestore from a source storage. The + progress of the import is tracked by the returned operation. The + imported features are guaranteed to be visible to subsequent read + operations after the operation is marked as successfully done. If an + import operation fails, the Feature values returned from reads and + exports may be inconsistent. If consistency is required, the caller must + retry the same import request again and wait till the new operation + returned is marked as successfully done. There are also scenarios where + the caller can cause inconsistency. - Source data for import contains + multiple distinct Feature values for the same entity ID and timestamp. - + Source is modified during an import. This includes adding, updating, or + removing source data and/or metadata. Examples of updating metadata + include but are not limited to changing storage location, storage class, + or retention policy. - Online serving cluster is under-provisioned. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.importFeatureValues requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ImportFeatureValuesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29007,13 +35941,38 @@ paths: schema: $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - - in: query - name: parent + - in: path + name: projectsId + required: true schema: type: string - get: - description: Lists Datasets in a Location. - operationId: aiplatform.datasets.list + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featurestoresId + required: true + schema: + type: string + - in: path + name: entityTypesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:exportFeatureValues: + parameters: *ref_1 + post: + description: Exports Feature values from all the entities of a target EntityType. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.exportFeatureValues + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ExportFeatureValuesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29025,40 +35984,88 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListDatasetsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - - in: query - name: parent + - in: path + name: projectsId + required: true schema: type: string - - in: query - name: filter + - in: path + name: locationsId + required: true schema: type: string - - in: query - name: pageSize + - in: path + name: featurestoresId + required: true schema: - type: integer - format: int32 - - in: query - name: pageToken + type: string + - in: path + name: entityTypesId + required: true schema: type: string - - in: query - name: readMask + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:deleteFeatureValues: + parameters: *ref_1 + post: + description: >- + Delete Feature values from Featurestore. The progress of the deletion is + tracked by the returned operation. The deleted feature values are + guaranteed to be invisible to subsequent read operations after the + operation is marked as successfully done. If a delete feature values + operation fails, the feature values returned from reads and exports may + be inconsistent. If consistency is required, the caller must retry the + same delete request again and wait till the new operation returned is + marked as successfully done. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.deleteFeatureValues + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1DeleteFeatureValuesRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true schema: type: string - format: google-fieldmask - - in: query - name: orderBy + - in: path + name: locationsId + required: true schema: type: string - /v1/datasets/{datasetsId}: + - in: path + name: featurestoresId + required: true + schema: + type: string + - in: path + name: entityTypesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations: parameters: *ref_1 get: - description: Gets a Dataset. - operationId: aiplatform.datasets.get + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.featurestores.entityTypes.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29070,26 +36077,49 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path - name: datasetsId + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featurestoresId + required: true + schema: + type: string + - in: path + name: entityTypesId required: true schema: type: string - in: query - name: readMask + name: filter schema: type: string - format: google-fieldmask - patch: - description: Updates a Dataset. - operationId: aiplatform.datasets.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: aiplatform.projects.locations.featurestores.entityTypes.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29101,21 +36131,41 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path - name: datasetsId + name: projectsId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featurestoresId + required: true + schema: + type: string + - in: path + name: entityTypesId + required: true + schema: + type: string + - in: path + name: operationsId + required: true schema: type: string - format: google-fieldmask delete: - description: Deletes a Dataset. - operationId: aiplatform.datasets.delete + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29127,23 +36177,48 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: datasetsId + name: projectsId required: true schema: type: string - /v1/datasets/{datasetsId}/datasetVersions: + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featurestoresId + required: true + schema: + type: string + - in: path + name: entityTypesId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:cancel: parameters: *ref_1 post: - description: Create a version from a Dataset. - operationId: aiplatform.datasets.datasetVersions.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + `1`, corresponding to `Code.CANCELLED`. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29155,16 +36230,47 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: datasetsId + name: projectsId required: true schema: type: string - get: - description: Lists DatasetVersions in a Dataset. - operationId: aiplatform.datasets.datasetVersions.list + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featurestoresId + required: true + schema: + type: string + - in: path + name: entityTypesId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:wait: + parameters: *ref_1 + post: + description: >- + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It may return the latest state before the specified + timeout (including immediately), meaning even an immediate response is + no guarantee that the operation is done. + operationId: aiplatform.projects.locations.featurestores.entityTypes.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29176,46 +36282,48 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListDatasetVersionsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path - name: datasetsId + name: projectsId required: true schema: type: string - - in: query - name: filter + - in: path + name: locationsId + required: true schema: type: string - - in: query - name: pageSize + - in: path + name: featurestoresId + required: true schema: - type: integer - format: int32 - - in: query - name: pageToken + type: string + - in: path + name: entityTypesId + required: true schema: type: string - - in: query - name: readMask + - in: path + name: operationsId + required: true schema: type: string - format: google-fieldmask - in: query - name: orderBy + name: timeout schema: type: string - /v1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}: + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features: parameters: *ref_1 - patch: - description: Updates a DatasetVersion. - operationId: aiplatform.datasets.datasetVersions.patch + post: + description: Creates a new Feature in a given EntityType. + operationId: aiplatform.projects.locations.featurestores.entityTypes.features.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29227,26 +36335,35 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path - name: datasetsId + name: projectsId required: true schema: type: string - in: path - name: datasetVersionsId + name: locationsId + required: true + schema: + type: string + - in: path + name: featurestoresId + required: true + schema: + type: string + - in: path + name: entityTypesId required: true schema: type: string - in: query - name: updateMask + name: featureId schema: type: string - format: google-fieldmask - delete: - description: Deletes a Dataset version. - operationId: aiplatform.datasets.datasetVersions.delete + get: + description: Lists Features in a given EntityType. + operationId: aiplatform.projects.locations.featurestores.entityTypes.features.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29258,21 +36375,68 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListFeaturesResponse parameters: - in: path - name: datasetsId + name: projectsId required: true schema: type: string - in: path - name: datasetVersionsId + name: locationsId required: true schema: type: string - get: - description: Gets a Dataset version. - operationId: aiplatform.datasets.datasetVersions.get + - in: path + name: featurestoresId + required: true + schema: + type: string + - in: path + name: entityTypesId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: orderBy + schema: + type: string + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: latestStatsCount + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features:batchCreate: + parameters: *ref_1 + post: + description: Creates a batch of Features in a given EntityType. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.features.batchCreate + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchCreateFeaturesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29284,28 +36448,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path - name: datasetsId + name: projectsId required: true schema: type: string - in: path - name: datasetVersionsId + name: locationsId required: true schema: type: string - - in: query - name: readMask + - in: path + name: featurestoresId + required: true schema: type: string - format: google-fieldmask - /v1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}:restore: + - in: path + name: entityTypesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}: parameters: *ref_1 get: - description: Restores a dataset version. - operationId: aiplatform.datasets.datasetVersions.restore + description: Gets details of a single Feature. + operationId: aiplatform.projects.locations.featurestores.entityTypes.features.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29317,28 +36486,41 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' parameters: - in: path - name: datasetsId + name: projectsId required: true schema: type: string - in: path - name: datasetVersionsId + name: locationsId + required: true + schema: + type: string + - in: path + name: featurestoresId + required: true + schema: + type: string + - in: path + name: entityTypesId + required: true + schema: + type: string + - in: path + name: featuresId required: true schema: type: string - /v1/projects/{projectsId}/cacheConfig: - parameters: *ref_1 patch: - description: Updates a cache config. - operationId: aiplatform.projects.updateCacheConfig + description: Updates the parameters of a single Feature. + operationId: aiplatform.projects.locations.featurestores.entityTypes.features.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CacheConfig' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29350,16 +36532,41 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' parameters: - in: path name: projectsId required: true schema: type: string - get: - description: Gets a GenAI cache config. - operationId: aiplatform.projects.getCacheConfig + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featurestoresId + required: true + schema: + type: string + - in: path + name: entityTypesId + required: true + schema: + type: string + - in: path + name: featuresId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a single Feature. + operationId: aiplatform.projects.locations.featurestores.entityTypes.features.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29371,18 +36578,41 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CacheConfig' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId required: true schema: type: string - /v1/projects/{projectsId}/locations: + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featurestoresId + required: true + schema: + type: string + - in: path + name: entityTypesId + required: true + schema: + type: string + - in: path + name: featuresId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations: parameters: *ref_1 get: - description: Lists information about the supported locations for this service. - operationId: aiplatform.projects.locations.list + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.features.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29394,13 +36624,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudLocationListLocationsResponse' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId required: true schema: type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featurestoresId + required: true + schema: + type: string + - in: path + name: entityTypesId + required: true + schema: + type: string + - in: path + name: featuresId + required: true + schema: + type: string - in: query name: filter schema: @@ -29414,11 +36664,15 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}: parameters: *ref_1 get: - description: Gets information about a location. - operationId: aiplatform.projects.locations.get + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.features.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29430,7 +36684,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudLocationLocation' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -29442,54 +36696,34 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}:evaluateInstances: - parameters: *ref_1 - post: - description: Evaluates instances based on a given metric. - operationId: aiplatform.projects.locations.evaluateInstances - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1EvaluateInstancesRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1EvaluateInstancesResponse - parameters: - in: path - name: projectsId + name: featurestoresId required: true schema: type: string - in: path - name: locationsId + name: entityTypesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:setIamPolicy: - parameters: *ref_1 - post: + - in: path + name: featuresId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + delete: description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - `PERMISSION_DENIED` errors. - operationId: aiplatform.projects.locations.featurestores.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.features.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29501,7 +36735,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -29518,13 +36752,36 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:getIamPolicy: + - in: path + name: entityTypesId + required: true + schema: + type: string + - in: path + name: featuresId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: aiplatform.projects.locations.featurestores.getIamPolicy + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + `1`, corresponding to `Code.CANCELLED`. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.features.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29536,7 +36793,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -29553,21 +36810,36 @@ paths: required: true schema: type: string - - in: query - name: options.requestedPolicyVersion + - in: path + name: entityTypesId + required: true schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:testIamPermissions: + type: string + - in: path + name: featuresId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- - Returns permissions that a caller has on the specified resource. If the - resource does not exist, this will return an empty set of permissions, - not a `NOT_FOUND` error. Note: This operation is designed to be used for - building permission-aware UIs and command-line tools, not for - authorization checking. This operation may "fail open" without warning. - operationId: aiplatform.projects.locations.featurestores.testIamPermissions + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It may return the latest state before the specified + timeout (including immediately), meaning even an immediate response is + no guarantee that the operation is done. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.features.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29579,7 +36851,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -29596,50 +36868,33 @@ paths: required: true schema: type: string - - in: query - name: permissions + - in: path + name: entityTypesId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores: - parameters: *ref_1 - post: - description: Creates a new Featurestore in a given project and location. - operationId: aiplatform.projects.locations.featurestores.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Featurestore' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - in: path - name: projectsId + name: featuresId required: true schema: type: string - in: path - name: locationsId + name: operationsId required: true schema: type: string - in: query - name: featurestoreId + name: timeout schema: type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations: + parameters: *ref_1 get: - description: Lists Featurestores in a given project and location. - operationId: aiplatform.projects.locations.featurestores.list + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.featurestores.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29651,8 +36906,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListFeaturestoresResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -29664,6 +36918,11 @@ paths: required: true schema: type: string + - in: path + name: featurestoresId + required: true + schema: + type: string - in: query name: filter schema: @@ -29677,20 +36936,14 @@ paths: name: pageToken schema: type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}: parameters: *ref_1 get: - description: Gets details of a single Featurestore. - operationId: aiplatform.projects.locations.featurestores.get + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: aiplatform.projects.locations.featurestores.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29702,7 +36955,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Featurestore' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -29719,14 +36972,18 @@ paths: required: true schema: type: string - patch: - description: Updates the parameters of a single Featurestore. - operationId: aiplatform.projects.locations.featurestores.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Featurestore' + - in: path + name: operationsId + required: true + schema: + type: string + delete: + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.featurestores.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29738,7 +36995,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -29755,16 +37012,25 @@ paths: required: true schema: type: string - - in: query - name: updateMask + - in: path + name: operationsId + required: true schema: type: string - format: google-fieldmask - delete: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: description: >- - Deletes a single Featurestore. The Featurestore must not contain any - EntityTypes or `force` must be set to true for the request to succeed. - operationId: aiplatform.projects.locations.featurestores.delete + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + `1`, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.featurestores.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29776,7 +37042,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -29793,26 +37059,25 @@ paths: required: true schema: type: string - - in: query - name: force + - in: path + name: operationsId + required: true schema: - type: boolean - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:batchReadFeatureValues: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- - Batch reads Feature values from a Featurestore. This API enables batch - reading Feature values, where each read instance in the batch may read - Feature values of entities from one or more EntityTypes. Point-in-time - correctness is guaranteed for Feature values of each read instance as of - each instance's read timestamp. - operationId: aiplatform.projects.locations.featurestores.batchReadFeatureValues - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchReadFeatureValuesRequest + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It may return the latest state before the specified + timeout (including immediately), meaning even an immediate response is + no guarantee that the operation is done. + operationId: aiplatform.projects.locations.featurestores.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29841,56 +37106,24 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores:searchFeatures: - parameters: *ref_1 - get: - description: Searches Features matching a query in a given project. - operationId: aiplatform.projects.locations.featurestores.searchFeatures - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SearchFeaturesResponse - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - in: path - name: locationsId + name: operationsId required: true schema: type: string - in: query - name: query - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + name: timeout schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:setIamPolicy: + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:setIamPolicy: parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. - operationId: aiplatform.projects.locations.featurestores.entityTypes.setIamPolicy + operationId: aiplatform.projects.locations.models.setIamPolicy requestBody: content: application/json: @@ -29920,22 +37153,17 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId + name: modelsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:getIamPolicy: + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:getIamPolicy: parameters: *ref_1 post: description: >- Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - operationId: aiplatform.projects.locations.featurestores.entityTypes.getIamPolicy + operationId: aiplatform.projects.locations.models.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29960,12 +37188,7 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId + name: modelsId required: true schema: type: string @@ -29974,7 +37197,7 @@ paths: schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:testIamPermissions: + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:testIamPermissions: parameters: *ref_1 post: description: >- @@ -29983,8 +37206,7 @@ paths: not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.testIamPermissions + operationId: aiplatform.projects.locations.models.testIamPermissions security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30009,12 +37231,7 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId + name: modelsId required: true schema: type: string @@ -30022,21 +37239,16 @@ paths: name: permissions schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:readFeatureValues: + /v1/projects/{projectsId}/locations/{locationsId}/models:upload: parameters: *ref_1 post: - description: >- - Reads Feature values of a specific entity of an EntityType. For reading - feature values of multiple entities of an EntityType, please use - StreamingReadFeatureValues. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.readFeatureValues + description: Uploads a Model artifact into Vertex AI. + operationId: aiplatform.projects.locations.models.upload requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1UploadModelRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30048,8 +37260,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -30061,30 +37272,47 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}: + parameters: *ref_1 + get: + description: Gets a Model. + operationId: aiplatform.projects.locations.models.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string - in: path - name: featurestoresId + name: locationsId required: true schema: type: string - in: path - name: entityTypesId + name: modelsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:streamingReadFeatureValues: - parameters: *ref_1 - post: - description: >- - Reads Feature values for multiple entities. Depending on their size, - data for different entities may be broken up across multiple responses. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.streamingReadFeatureValues + patch: + description: Updates a Model. + operationId: aiplatform.projects.locations.models.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StreamingReadFeatureValuesRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30096,8 +37324,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' parameters: - in: path name: projectsId @@ -30110,31 +37337,20 @@ paths: schema: type: string - in: path - name: featurestoresId + name: modelsId required: true schema: type: string - - in: path - name: entityTypesId - required: true + - in: query + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:writeFeatureValues: - parameters: *ref_1 - post: + format: google-fieldmask + delete: description: >- - Writes Feature values of one or more entities of an EntityType. The - Feature values are merged into existing entities if any. The Feature - values to be written must have timestamp within the online storage - retention. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.writeFeatureValues - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1WriteFeatureValuesRequest + Deletes a Model. A model cannot be deleted if any Endpoint resource has + a DeployedModel based on the model in its deployed_models field. + operationId: aiplatform.projects.locations.models.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30146,8 +37362,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1WriteFeatureValuesResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -30160,25 +37375,15 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId + name: modelsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes: + /v1/projects/{projectsId}/locations/{locationsId}/models: parameters: *ref_1 - post: - description: Creates a new EntityType in a given Featurestore. - operationId: aiplatform.projects.locations.featurestores.entityTypes.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityType' + get: + description: Lists Models in a Location. + operationId: aiplatform.projects.locations.models.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30190,7 +37395,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1ListModelsResponse' parameters: - in: path name: projectsId @@ -30202,18 +37407,33 @@ paths: required: true schema: type: string - - in: path - name: featurestoresId - required: true + - in: query + name: filter schema: type: string - in: query - name: entityTypeId + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: readMask schema: type: string + format: google-fieldmask + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:listVersions: + parameters: *ref_1 get: - description: Lists EntityTypes in a given Featurestore. - operationId: aiplatform.projects.locations.featurestores.entityTypes.list + description: Lists versions of the specified model. + operationId: aiplatform.projects.locations.models.listVersions security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30226,7 +37446,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListEntityTypesResponse + #/components/schemas/GoogleCloudAiplatformV1ListModelVersionsResponse parameters: - in: path name: projectsId @@ -30239,14 +37459,10 @@ paths: schema: type: string - in: path - name: featurestoresId + name: modelsId required: true schema: type: string - - in: query - name: filter - schema: - type: string - in: query name: pageSize schema: @@ -30257,7 +37473,7 @@ paths: schema: type: string - in: query - name: orderBy + name: filter schema: type: string - in: query @@ -30265,11 +37481,15 @@ paths: schema: type: string format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}: + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:listCheckpoints: parameters: *ref_1 get: - description: Gets details of a single EntityType. - operationId: aiplatform.projects.locations.featurestores.entityTypes.get + description: Lists checkpoints of the specified model version. + operationId: aiplatform.projects.locations.models.listCheckpoints security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30281,7 +37501,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityType' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListModelVersionCheckpointsResponse parameters: - in: path name: projectsId @@ -30294,23 +37515,30 @@ paths: schema: type: string - in: path - name: featurestoresId + name: modelsId required: true schema: type: string - - in: path - name: entityTypesId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - patch: - description: Updates the parameters of a single EntityType. - operationId: aiplatform.projects.locations.featurestores.entityTypes.patch + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:updateExplanationDataset: + parameters: *ref_1 + post: + description: Incrementally update the dataset used for an examples model. + operationId: aiplatform.projects.locations.models.updateExplanationDataset requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityType' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1UpdateExplanationDatasetRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30322,7 +37550,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityType' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -30335,25 +37563,18 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId + name: modelsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:deleteVersion: + parameters: *ref_1 delete: description: >- - Deletes a single EntityType. The EntityType must not have any Features - or `force` must be set to true for the request to succeed. - operationId: aiplatform.projects.locations.featurestores.entityTypes.delete + Deletes a Model version. Model version can only be deleted if there are + no DeployedModels created from it. Deleting the only version in the + Model is not allowed. Use DeleteModel for deleting the Model instead. + operationId: aiplatform.projects.locations.models.deleteVersion security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30378,45 +37599,21 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId + name: modelsId required: true schema: type: string - - in: query - name: force - schema: - type: boolean - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:importFeatureValues: + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:mergeVersionAliases: parameters: *ref_1 post: - description: >- - Imports Feature values into the Featurestore from a source storage. The - progress of the import is tracked by the returned operation. The - imported features are guaranteed to be visible to subsequent read - operations after the operation is marked as successfully done. If an - import operation fails, the Feature values returned from reads and - exports may be inconsistent. If consistency is required, the caller must - retry the same import request again and wait till the new operation - returned is marked as successfully done. There are also scenarios where - the caller can cause inconsistency. - Source data for import contains - multiple distinct Feature values for the same entity ID and timestamp. - - Source is modified during an import. This includes adding, updating, or - removing source data and/or metadata. Examples of updating metadata - include but are not limited to changing storage location, storage class, - or retention policy. - Online serving cluster is under-provisioned. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.importFeatureValues + description: Merges a set of aliases for a Model version. + operationId: aiplatform.projects.locations.models.mergeVersionAliases requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ImportFeatureValuesRequest + #/components/schemas/GoogleCloudAiplatformV1MergeVersionAliasesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30428,7 +37625,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' parameters: - in: path name: projectsId @@ -30441,27 +37638,23 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId + name: modelsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:exportFeatureValues: + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:export: parameters: *ref_1 post: - description: Exports Feature values from all the entities of a target EntityType. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.exportFeatureValues + description: >- + Exports a trained, exportable Model to a location specified by the user. + A Model is considered to be exportable if it has at least one supported + export format. + operationId: aiplatform.projects.locations.models.export requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExportFeatureValuesRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExportModelRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30486,35 +37679,25 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId + name: modelsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:deleteFeatureValues: + /v1/projects/{projectsId}/locations/{locationsId}/models:copy: parameters: *ref_1 post: description: >- - Delete Feature values from Featurestore. The progress of the deletion is - tracked by the returned operation. The deleted feature values are - guaranteed to be invisible to subsequent read operations after the - operation is marked as successfully done. If a delete feature values - operation fails, the feature values returned from reads and exports may - be inconsistent. If consistency is required, the caller must retry the - same delete request again and wait till the new operation returned is - marked as successfully done. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.deleteFeatureValues + Copies an already existing Vertex AI Model into the specified Location. + The source Model must exist in the same Project. When copying custom + Models, the users themselves are responsible for Model.metadata content + to be region-agnostic, as well as making sure that any resources (e.g. + files) it depends on remain accessible. + operationId: aiplatform.projects.locations.models.copy requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DeleteFeatureValuesRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1CopyModelRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30538,23 +37721,13 @@ paths: required: true schema: type: string - - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.featurestores.entityTypes.operations.list + operationId: aiplatform.projects.locations.models.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30579,12 +37752,7 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId + name: modelsId required: true schema: type: string @@ -30601,14 +37769,14 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}: parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - operationId: aiplatform.projects.locations.featurestores.entityTypes.operations.get + operationId: aiplatform.projects.locations.models.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30633,12 +37801,7 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId + name: modelsId required: true schema: type: string @@ -30653,8 +37816,7 @@ paths: is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.operations.delete + operationId: aiplatform.projects.locations.models.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30679,12 +37841,7 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId + name: modelsId required: true schema: type: string @@ -30693,7 +37850,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- @@ -30705,9 +37862,8 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.operations.cancel + `1`, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.models.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30732,12 +37888,7 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId + name: modelsId required: true schema: type: string @@ -30746,7 +37897,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- @@ -30759,7 +37910,7 @@ paths: best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. - operationId: aiplatform.projects.locations.featurestores.entityTypes.operations.wait + operationId: aiplatform.projects.locations.models.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30784,12 +37935,7 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId + name: modelsId required: true schema: type: string @@ -30803,16 +37949,17 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features: + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations:import: parameters: *ref_1 post: - description: Creates a new Feature in a given EntityType. - operationId: aiplatform.projects.locations.featurestores.entityTypes.features.create + description: Imports an externally generated ModelEvaluation. + operationId: aiplatform.projects.locations.models.evaluations.import requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ImportModelEvaluationRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30824,7 +37971,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluation' parameters: - in: path name: projectsId @@ -30837,22 +37984,53 @@ paths: schema: type: string - in: path - name: featurestoresId + name: modelsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}: + parameters: *ref_1 + get: + description: Gets a ModelEvaluation. + operationId: aiplatform.projects.locations.models.evaluations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluation' + parameters: + - in: path + name: projectsId required: true schema: type: string - in: path - name: entityTypesId + name: locationsId required: true schema: type: string - - in: query - name: featureId + - in: path + name: modelsId + required: true + schema: + type: string + - in: path + name: evaluationsId + required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations: + parameters: *ref_1 get: - description: Lists Features in a given EntityType. - operationId: aiplatform.projects.locations.featurestores.entityTypes.features.list + description: Lists ModelEvaluations in a Model. + operationId: aiplatform.projects.locations.models.evaluations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30865,7 +38043,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListFeaturesResponse + #/components/schemas/GoogleCloudAiplatformV1ListModelEvaluationsResponse parameters: - in: path name: projectsId @@ -30878,12 +38056,7 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId + name: modelsId required: true schema: type: string @@ -30901,31 +38074,168 @@ paths: schema: type: string - in: query - name: orderBy + name: readMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.models.evaluations.operations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: modelsId + required: true + schema: + type: string + - in: path + name: evaluationsId + required: true schema: type: string - in: query - name: readMask + name: filter schema: type: string - format: google-fieldmask - in: query - name: latestStatsCount + name: pageSize schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features:batchCreate: + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}: parameters: *ref_1 - post: - description: Creates a batch of Features in a given EntityType. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.features.batchCreate - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchCreateFeaturesRequest + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: aiplatform.projects.locations.models.evaluations.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: modelsId + required: true + schema: + type: string + - in: path + name: evaluationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + delete: + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.models.evaluations.operations.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: modelsId + required: true + schema: + type: string + - in: path + name: evaluationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + `1`, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.models.evaluations.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30937,7 +38247,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -30950,20 +38260,34 @@ paths: schema: type: string - in: path - name: featurestoresId + name: modelsId required: true schema: type: string - in: path - name: entityTypesId + name: evaluationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:wait: parameters: *ref_1 - get: - description: Gets details of a single Feature. - operationId: aiplatform.projects.locations.featurestores.entityTypes.features.get + post: + description: >- + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It may return the latest state before the specified + timeout (including immediately), meaning even an immediate response is + no guarantee that the operation is done. + operationId: aiplatform.projects.locations.models.evaluations.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30975,7 +38299,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -30988,28 +38312,36 @@ paths: schema: type: string - in: path - name: featurestoresId + name: modelsId required: true schema: type: string - in: path - name: entityTypesId + name: evaluationsId required: true schema: type: string - in: path - name: featuresId + name: operationsId required: true schema: type: string - patch: - description: Updates the parameters of a single Feature. - operationId: aiplatform.projects.locations.featurestores.entityTypes.features.patch + - in: query + name: timeout + schema: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices/{slicesId}:batchImport: + parameters: *ref_1 + post: + description: Imports a list of externally generated EvaluatedAnnotations. + operationId: aiplatform.projects.locations.models.evaluations.slices.batchImport requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31021,7 +38353,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsResponse parameters: - in: path name: projectsId @@ -31034,28 +38367,25 @@ paths: schema: type: string - in: path - name: featurestoresId + name: modelsId required: true schema: type: string - in: path - name: entityTypesId + name: evaluationsId required: true schema: type: string - in: path - name: featuresId + name: slicesId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: - description: Deletes a single Feature. - operationId: aiplatform.projects.locations.featurestores.entityTypes.features.delete + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices/{slicesId}: + parameters: *ref_1 + get: + description: Gets a ModelEvaluationSlice. + operationId: aiplatform.projects.locations.models.evaluations.slices.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31067,7 +38397,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSlice parameters: - in: path name: projectsId @@ -31080,28 +38411,25 @@ paths: schema: type: string - in: path - name: featurestoresId + name: modelsId required: true schema: type: string - in: path - name: entityTypesId + name: evaluationsId required: true schema: type: string - in: path - name: featuresId + name: slicesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices: parameters: *ref_1 get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.features.operations.list + description: Lists ModelEvaluationSlices in a ModelEvaluation. + operationId: aiplatform.projects.locations.models.evaluations.slices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31113,7 +38441,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListModelEvaluationSlicesResponse parameters: - in: path name: projectsId @@ -31126,17 +38455,12 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId + name: modelsId required: true schema: type: string - in: path - name: featuresId + name: evaluationsId required: true schema: type: string @@ -31153,15 +38477,24 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}: + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:setIamPolicy: parameters: *ref_1 - get: + post: description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.features.operations.get + Sets the access control policy on the specified resource. Replaces any + existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and + `PERMISSION_DENIED` errors. + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31173,7 +38506,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -31186,33 +38519,61 @@ paths: schema: type: string - in: path - name: featurestoresId + name: notebookRuntimeTemplatesId required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:getIamPolicy: + parameters: *ref_1 + post: + description: >- + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.getIamPolicy + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1Policy' + parameters: - in: path - name: entityTypesId + name: projectsId required: true schema: type: string - in: path - name: featuresId + name: locationsId required: true schema: type: string - in: path - name: operationsId + name: notebookRuntimeTemplatesId required: true schema: type: string - delete: + - in: query + name: options.requestedPolicyVersion + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:testIamPermissions: + parameters: *ref_1 + post: description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. + Returns permissions that a caller has on the specified resource. If the + resource does not exist, this will return an empty set of permissions, + not a `NOT_FOUND` error. Note: This operation is designed to be used for + building permission-aware UIs and command-line tools, not for + authorization checking. This operation may "fail open" without warning. operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.features.operations.delete + aiplatform.projects.locations.notebookRuntimeTemplates.testIamPermissions security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31224,7 +38585,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' parameters: - in: path name: projectsId @@ -31237,40 +38598,55 @@ paths: schema: type: string - in: path - name: featurestoresId + name: notebookRuntimeTemplatesId required: true schema: type: string - - in: path - name: entityTypesId - required: true + - in: query + name: permissions schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates: + parameters: *ref_1 + post: + description: Creates a NotebookRuntimeTemplate. + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplate + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: - in: path - name: featuresId + name: projectsId required: true schema: type: string - in: path - name: operationsId + name: locationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:cancel: - parameters: *ref_1 - post: - description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.features.operations.cancel + - in: query + name: notebookRuntimeTemplateId + schema: + type: string + get: + description: Lists NotebookRuntimeTemplates in a Location. + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31282,7 +38658,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse parameters: - in: path name: projectsId @@ -31294,41 +38671,65 @@ paths: required: true schema: type: string - - in: path - name: featurestoresId - required: true + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: orderBy schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}: + parameters: *ref_1 + get: + description: Gets a NotebookRuntimeTemplate. + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplate + parameters: - in: path - name: entityTypesId + name: projectsId required: true schema: type: string - in: path - name: featuresId + name: locationsId required: true schema: type: string - in: path - name: operationsId + name: notebookRuntimeTemplatesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:wait: - parameters: *ref_1 - post: - description: >- - Waits until the specified long-running operation is done or reaches at - most a specified timeout, returning the latest state. If the operation - is already done, the latest state is immediately returned. If the - timeout specified is greater than the default HTTP/RPC timeout, the - HTTP/RPC timeout is used. If the server does not support this method, it - returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a - best-effort basis. It may return the latest state before the specified - timeout (including immediately), meaning even an immediate response is - no guarantee that the operation is done. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.features.operations.wait + delete: + description: Deletes a NotebookRuntimeTemplate. + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31353,37 +38754,60 @@ paths: schema: type: string - in: path - name: featurestoresId + name: notebookRuntimeTemplatesId required: true schema: type: string + patch: + description: Updates a NotebookRuntimeTemplate. + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplate + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplate + parameters: - in: path - name: entityTypesId + name: projectsId required: true schema: type: string - in: path - name: featuresId + name: locationsId required: true schema: type: string - in: path - name: operationsId + name: notebookRuntimeTemplatesId required: true schema: type: string - in: query - name: timeout + name: updateMask schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations: + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.featurestores.operations.list + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31408,7 +38832,7 @@ paths: schema: type: string - in: path - name: featurestoresId + name: notebookRuntimeTemplatesId required: true schema: type: string @@ -31425,14 +38849,14 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}: parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - operationId: aiplatform.projects.locations.featurestores.operations.get + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31457,7 +38881,7 @@ paths: schema: type: string - in: path - name: featurestoresId + name: notebookRuntimeTemplatesId required: true schema: type: string @@ -31472,7 +38896,7 @@ paths: is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.featurestores.operations.delete + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31497,7 +38921,7 @@ paths: schema: type: string - in: path - name: featurestoresId + name: notebookRuntimeTemplatesId required: true schema: type: string @@ -31506,7 +38930,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- @@ -31518,8 +38942,8 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.featurestores.operations.cancel + `1`, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31544,7 +38968,7 @@ paths: schema: type: string - in: path - name: featurestoresId + name: notebookRuntimeTemplatesId required: true schema: type: string @@ -31553,7 +38977,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- @@ -31566,7 +38990,7 @@ paths: best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. - operationId: aiplatform.projects.locations.featurestores.operations.wait + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31591,7 +39015,7 @@ paths: schema: type: string - in: path - name: featurestoresId + name: notebookRuntimeTemplatesId required: true schema: type: string @@ -31605,14 +39029,14 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:setIamPolicy: + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:setIamPolicy: parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. - operationId: aiplatform.projects.locations.models.setIamPolicy + operationId: aiplatform.projects.locations.featureOnlineStores.setIamPolicy requestBody: content: application/json: @@ -31642,17 +39066,17 @@ paths: schema: type: string - in: path - name: modelsId + name: featureOnlineStoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:getIamPolicy: + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:getIamPolicy: parameters: *ref_1 post: description: >- Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - operationId: aiplatform.projects.locations.models.getIamPolicy + operationId: aiplatform.projects.locations.featureOnlineStores.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31677,131 +39101,25 @@ paths: schema: type: string - in: path - name: modelsId + name: featureOnlineStoresId required: true schema: type: string - in: query name: options.requestedPolicyVersion - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:testIamPermissions: - parameters: *ref_1 - post: - description: >- - Returns permissions that a caller has on the specified resource. If the - resource does not exist, this will return an empty set of permissions, - not a `NOT_FOUND` error. Note: This operation is designed to be used for - building permission-aware UIs and command-line tools, not for - authorization checking. This operation may "fail open" without warning. - operationId: aiplatform.projects.locations.models.testIamPermissions - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: modelsId - required: true - schema: - type: string - - in: query - name: permissions - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/models:upload: - parameters: *ref_1 - post: - description: Uploads a Model artifact into Vertex AI. - operationId: aiplatform.projects.locations.models.upload - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1UploadModelRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}: - parameters: *ref_1 - get: - description: Gets a Model. - operationId: aiplatform.projects.locations.models.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: modelsId - required: true - schema: - type: string - patch: - description: Updates a Model. - operationId: aiplatform.projects.locations.models.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:testIamPermissions: + parameters: *ref_1 + post: + description: >- + Returns permissions that a caller has on the specified resource. If the + resource does not exist, this will return an empty set of permissions, + not a `NOT_FOUND` error. Note: This operation is designed to be used for + building permission-aware UIs and command-line tools, not for + authorization checking. This operation may "fail open" without warning. + operationId: aiplatform.projects.locations.featureOnlineStores.testIamPermissions security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31813,7 +39131,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' parameters: - in: path name: projectsId @@ -31826,20 +39144,24 @@ paths: schema: type: string - in: path - name: modelsId + name: featureOnlineStoresId required: true schema: type: string - in: query - name: updateMask + name: permissions schema: type: string - format: google-fieldmask - delete: - description: >- - Deletes a Model. A model cannot be deleted if any Endpoint resource has - a DeployedModel based on the model in its deployed_models field. - operationId: aiplatform.projects.locations.models.delete + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores: + parameters: *ref_1 + post: + description: Creates a new FeatureOnlineStore in a given project and location. + operationId: aiplatform.projects.locations.featureOnlineStores.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStore' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31863,16 +39185,13 @@ paths: required: true schema: type: string - - in: path - name: modelsId - required: true + - in: query + name: featureOnlineStoreId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models: - parameters: *ref_1 get: - description: Lists Models in a Location. - operationId: aiplatform.projects.locations.models.list + description: Lists FeatureOnlineStores in a given project and location. + operationId: aiplatform.projects.locations.featureOnlineStores.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31884,7 +39203,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ListModelsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListFeatureOnlineStoresResponse parameters: - in: path name: projectsId @@ -31909,20 +39229,15 @@ paths: name: pageToken schema: type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - in: query name: orderBy schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:listVersions: + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}: parameters: *ref_1 get: - description: Lists versions of the specified model. - operationId: aiplatform.projects.locations.models.listVersions + description: Gets details of a single FeatureOnlineStore. + operationId: aiplatform.projects.locations.featureOnlineStores.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31934,8 +39249,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListModelVersionsResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStore' parameters: - in: path name: projectsId @@ -31948,43 +39262,18 @@ paths: schema: type: string - in: path - name: modelsId + name: featureOnlineStoresId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: orderBy - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:updateExplanationDataset: - parameters: *ref_1 - post: - description: Incrementally update the dataset used for an examples model. - operationId: aiplatform.projects.locations.models.updateExplanationDataset + patch: + description: Updates the parameters of a single FeatureOnlineStore. + operationId: aiplatform.projects.locations.featureOnlineStores.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1UpdateExplanationDatasetRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStore' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32009,18 +39298,20 @@ paths: schema: type: string - in: path - name: modelsId + name: featureOnlineStoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:deleteVersion: - parameters: *ref_1 + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask delete: description: >- - Deletes a Model version. Model version can only be deleted if there are - no DeployedModels created from it. Deleting the only version in the - Model is not allowed. Use DeleteModel for deleting the Model instead. - operationId: aiplatform.projects.locations.models.deleteVersion + Deletes a single FeatureOnlineStore. The FeatureOnlineStore must not + contain any FeatureViews. + operationId: aiplatform.projects.locations.featureOnlineStores.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32045,21 +39336,28 @@ paths: schema: type: string - in: path - name: modelsId + name: featureOnlineStoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:mergeVersionAliases: + - in: query + name: force + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:setIamPolicy: parameters: *ref_1 post: - description: Merges a set of aliases for a Model version. - operationId: aiplatform.projects.locations.models.mergeVersionAliases + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and + `PERMISSION_DENIED` errors. + operationId: >- + aiplatform.projects.locations.featureOnlineStores.featureViews.setIamPolicy requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MergeVersionAliasesRequest + $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32071,7 +39369,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -32084,23 +39382,23 @@ paths: schema: type: string - in: path - name: modelsId + name: featureOnlineStoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:export: + - in: path + name: featureViewsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:getIamPolicy: parameters: *ref_1 post: description: >- - Exports a trained, exportable Model to a location specified by the user. - A Model is considered to be exportable if it has at least one supported - export format. - operationId: aiplatform.projects.locations.models.export - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExportModelRequest' + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: >- + aiplatform.projects.locations.featureOnlineStores.featureViews.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32112,7 +39410,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -32125,25 +39423,78 @@ paths: schema: type: string - in: path - name: modelsId + name: featureOnlineStoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models:copy: + - in: path + name: featureViewsId + required: true + schema: + type: string + - in: query + name: options.requestedPolicyVersion + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:testIamPermissions: parameters: *ref_1 post: description: >- - Copies an already existing Vertex AI Model into the specified Location. - The source Model must exist in the same Project. When copying custom - Models, the users themselves are responsible for Model.metadata content - to be region-agnostic, as well as making sure that any resources (e.g. - files) it depends on remain accessible. - operationId: aiplatform.projects.locations.models.copy + Returns permissions that a caller has on the specified resource. If the + resource does not exist, this will return an empty set of permissions, + not a `NOT_FOUND` error. Note: This operation is designed to be used for + building permission-aware UIs and command-line tools, not for + authorization checking. This operation may "fail open" without warning. + operationId: >- + aiplatform.projects.locations.featureOnlineStores.featureViews.testIamPermissions + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featureOnlineStoresId + required: true + schema: + type: string + - in: path + name: featureViewsId + required: true + schema: + type: string + - in: query + name: permissions + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews: + parameters: *ref_1 + post: + description: Creates a new FeatureView in a given FeatureOnlineStore. + operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CopyModelRequest' + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureView' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32167,13 +39518,22 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations: - parameters: *ref_1 + - in: path + name: featureOnlineStoresId + required: true + schema: + type: string + - in: query + name: featureViewId + schema: + type: string + - in: query + name: runSyncImmediately + schema: + type: boolean get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.models.operations.list + description: Lists FeatureViews in a given FeatureOnlineStore. + operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32185,7 +39545,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListFeatureViewsResponse parameters: - in: path name: projectsId @@ -32198,7 +39559,7 @@ paths: schema: type: string - in: path - name: modelsId + name: featureOnlineStoresId required: true schema: type: string @@ -32215,14 +39576,56 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}: + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}: parameters: *ref_1 get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: aiplatform.projects.locations.models.operations.get + description: Gets details of a single FeatureView. + operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureView' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featureOnlineStoresId + required: true + schema: + type: string + - in: path + name: featureViewsId + required: true + schema: + type: string + patch: + description: Updates the parameters of a single FeatureView. + operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureView' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32247,22 +39650,23 @@ paths: schema: type: string - in: path - name: modelsId + name: featureOnlineStoresId required: true schema: type: string - in: path - name: operationsId + name: featureViewsId required: true schema: type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask delete: - description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.models.operations.delete + description: Deletes a single FeatureView. + operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32274,7 +39678,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -32287,29 +39691,26 @@ paths: schema: type: string - in: path - name: modelsId + name: featureOnlineStoresId required: true schema: type: string - in: path - name: operationsId + name: featureViewsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:sync: parameters: *ref_1 post: - description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.models.operations.cancel + description: Triggers on-demand sync for the FeatureView. + operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.sync + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SyncFeatureViewRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32321,7 +39722,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SyncFeatureViewResponse parameters: - in: path name: projectsId @@ -32334,29 +39736,27 @@ paths: schema: type: string - in: path - name: modelsId + name: featureOnlineStoresId required: true schema: type: string - in: path - name: operationsId + name: featureViewsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:fetchFeatureValues: parameters: *ref_1 post: - description: >- - Waits until the specified long-running operation is done or reaches at - most a specified timeout, returning the latest state. If the operation - is already done, the latest state is immediately returned. If the - timeout specified is greater than the default HTTP/RPC timeout, the - HTTP/RPC timeout is used. If the server does not support this method, it - returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a - best-effort basis. It may return the latest state before the specified - timeout (including immediately), meaning even an immediate response is - no guarantee that the operation is done. - operationId: aiplatform.projects.locations.models.operations.wait + description: Fetch feature values under a FeatureView. + operationId: >- + aiplatform.projects.locations.featureOnlineStores.featureViews.fetchFeatureValues + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FetchFeatureValuesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32368,7 +39768,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FetchFeatureValuesResponse parameters: - in: path name: projectsId @@ -32381,31 +39782,30 @@ paths: schema: type: string - in: path - name: modelsId + name: featureOnlineStoresId required: true schema: type: string - in: path - name: operationsId + name: featureViewsId required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations:import: + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:searchNearestEntities: parameters: *ref_1 post: - description: Imports an externally generated ModelEvaluation. - operationId: aiplatform.projects.locations.models.evaluations.import + description: >- + Search the nearest entities under a FeatureView. Search only works for + indexable feature view; if a feature view isn't indexable, returns + Invalid argument response. + operationId: >- + aiplatform.projects.locations.featureOnlineStores.featureViews.searchNearestEntities requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ImportModelEvaluationRequest + #/components/schemas/GoogleCloudAiplatformV1SearchNearestEntitiesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32417,7 +39817,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SearchNearestEntitiesResponse parameters: - in: path name: projectsId @@ -32430,15 +39831,30 @@ paths: schema: type: string - in: path - name: modelsId + name: featureOnlineStoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}: + - in: path + name: featureViewsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:directWrite: parameters: *ref_1 - get: - description: Gets a ModelEvaluation. - operationId: aiplatform.projects.locations.models.evaluations.get + post: + description: >- + Bidirectional streaming RPC to directly write to feature values in a + feature view. Requests may not have a one-to-one mapping to responses + and responses may be returned out-of-order to reduce latency. + operationId: >- + aiplatform.projects.locations.featureOnlineStores.featureViews.directWrite + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureViewDirectWriteRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32450,7 +39866,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureViewDirectWriteResponse parameters: - in: path name: projectsId @@ -32463,20 +39880,23 @@ paths: schema: type: string - in: path - name: modelsId + name: featureOnlineStoresId required: true schema: type: string - in: path - name: evaluationsId + name: featureViewsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations: + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}:wait: parameters: *ref_1 get: - description: Lists ModelEvaluations in a Model. - operationId: aiplatform.projects.locations.models.evaluations.list + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: >- + aiplatform.projects.locations.featureOnlineStores.featureViews.operations.listWait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32488,8 +39908,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListModelEvaluationsResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -32502,7 +39921,17 @@ paths: schema: type: string - in: path - name: modelsId + name: featureOnlineStoresId + required: true + schema: + type: string + - in: path + name: featureViewsId + required: true + schema: + type: string + - in: path + name: operationsId required: true schema: type: string @@ -32519,18 +39948,19 @@ paths: name: pageToken schema: type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations: - parameters: *ref_1 - get: + post: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.models.evaluations.operations.list + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It may return the latest state before the specified + timeout (including immediately), meaning even an immediate response is + no guarantee that the operation is done. + operationId: >- + aiplatform.projects.locations.featureOnlineStores.featureViews.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32542,7 +39972,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -32555,36 +39985,34 @@ paths: schema: type: string - in: path - name: modelsId + name: featureOnlineStoresId required: true schema: type: string - in: path - name: evaluationsId + name: featureViewsId required: true schema: type: string - - in: query - name: filter + - in: path + name: operationsId + required: true schema: type: string - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + name: timeout schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}: + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}: parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - operationId: aiplatform.projects.locations.models.evaluations.operations.get + operationId: >- + aiplatform.projects.locations.featureOnlineStores.featureViews.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32609,12 +40037,12 @@ paths: schema: type: string - in: path - name: modelsId + name: featureOnlineStoresId required: true schema: type: string - in: path - name: evaluationsId + name: featureViewsId required: true schema: type: string @@ -32629,7 +40057,8 @@ paths: is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.models.evaluations.operations.delete + operationId: >- + aiplatform.projects.locations.featureOnlineStores.featureViews.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32654,12 +40083,12 @@ paths: schema: type: string - in: path - name: modelsId + name: featureOnlineStoresId required: true schema: type: string - in: path - name: evaluationsId + name: featureViewsId required: true schema: type: string @@ -32668,20 +40097,12 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/featureViewSyncs/{featureViewSyncsId}: parameters: *ref_1 - post: - description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.models.evaluations.operations.cancel + get: + description: Gets details of a single FeatureViewSync. + operationId: >- + aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32693,7 +40114,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewSync' parameters: - in: path name: projectsId @@ -32706,34 +40127,26 @@ paths: schema: type: string - in: path - name: modelsId + name: featureOnlineStoresId required: true schema: type: string - in: path - name: evaluationsId + name: featureViewsId required: true schema: type: string - in: path - name: operationsId + name: featureViewSyncsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/featureViewSyncs: parameters: *ref_1 - post: - description: >- - Waits until the specified long-running operation is done or reaches at - most a specified timeout, returning the latest state. If the operation - is already done, the latest state is immediately returned. If the - timeout specified is greater than the default HTTP/RPC timeout, the - HTTP/RPC timeout is used. If the server does not support this method, it - returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a - best-effort basis. It may return the latest state before the specified - timeout (including immediately), meaning even an immediate response is - no guarantee that the operation is done. - operationId: aiplatform.projects.locations.models.evaluations.operations.wait + get: + description: Lists FeatureViewSyncs in a given FeatureView. + operationId: >- + aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32745,7 +40158,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListFeatureViewSyncsResponse parameters: - in: path name: projectsId @@ -32758,36 +40172,39 @@ paths: schema: type: string - in: path - name: modelsId + name: featureOnlineStoresId required: true schema: type: string - in: path - name: evaluationsId + name: featureViewsId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: filter schema: type: string - in: query - name: timeout + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices/{slicesId}:batchImport: + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}:wait: parameters: *ref_1 - post: - description: Imports a list of externally generated EvaluatedAnnotations. - operationId: aiplatform.projects.locations.models.evaluations.slices.batchImport - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsRequest + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.featureOnlineStores.operations.listWait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32799,8 +40216,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -32813,25 +40229,40 @@ paths: schema: type: string - in: path - name: modelsId + name: featureOnlineStoresId required: true schema: type: string - in: path - name: evaluationsId + name: operationsId required: true schema: type: string - - in: path - name: slicesId - required: true + - in: query + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices/{slicesId}: - parameters: *ref_1 - get: - description: Gets a ModelEvaluationSlice. - operationId: aiplatform.projects.locations.models.evaluations.slices.get + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + post: + description: >- + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It may return the latest state before the specified + timeout (including immediately), meaning even an immediate response is + no guarantee that the operation is done. + operationId: aiplatform.projects.locations.featureOnlineStores.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32843,8 +40274,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSlice + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -32857,25 +40287,28 @@ paths: schema: type: string - in: path - name: modelsId + name: featureOnlineStoresId required: true schema: type: string - in: path - name: evaluationsId + name: operationsId required: true schema: type: string - - in: path - name: slicesId - required: true + - in: query + name: timeout schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices: + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}: parameters: *ref_1 get: - description: Lists ModelEvaluationSlices in a ModelEvaluation. - operationId: aiplatform.projects.locations.models.evaluations.slices.list + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: aiplatform.projects.locations.featureOnlineStores.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32887,8 +40320,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListModelEvaluationSlicesResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -32901,41 +40333,63 @@ paths: schema: type: string - in: path - name: modelsId + name: featureOnlineStoresId required: true schema: type: string - in: path - name: evaluationsId + name: operationsId required: true schema: type: string - - in: query - name: filter + delete: + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.featureOnlineStores.operations.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: projectsId + required: true schema: type: string - - in: query - name: pageSize + - in: path + name: locationsId + required: true schema: - type: integer - format: int32 - - in: query - name: pageToken + type: string + - in: path + name: featureOnlineStoresId + required: true schema: type: string - - in: query - name: readMask + - in: path + name: operationsId + required: true schema: type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:setIamPolicy: + /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}:setIamPolicy: parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. - operationId: aiplatform.projects.locations.notebookRuntimeTemplates.setIamPolicy + operationId: aiplatform.projects.locations.featureGroups.setIamPolicy requestBody: content: application/json: @@ -32965,17 +40419,17 @@ paths: schema: type: string - in: path - name: notebookRuntimeTemplatesId + name: featureGroupsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:getIamPolicy: + /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}:getIamPolicy: parameters: *ref_1 post: description: >- Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - operationId: aiplatform.projects.locations.notebookRuntimeTemplates.getIamPolicy + operationId: aiplatform.projects.locations.featureGroups.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33000,7 +40454,7 @@ paths: schema: type: string - in: path - name: notebookRuntimeTemplatesId + name: featureGroupsId required: true schema: type: string @@ -33009,7 +40463,7 @@ paths: schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:testIamPermissions: + /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}:testIamPermissions: parameters: *ref_1 post: description: >- @@ -33018,8 +40472,7 @@ paths: not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. - operationId: >- - aiplatform.projects.locations.notebookRuntimeTemplates.testIamPermissions + operationId: aiplatform.projects.locations.featureGroups.testIamPermissions security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33044,7 +40497,7 @@ paths: schema: type: string - in: path - name: notebookRuntimeTemplatesId + name: featureGroupsId required: true schema: type: string @@ -33052,17 +40505,16 @@ paths: name: permissions schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates: + /v1/projects/{projectsId}/locations/{locationsId}/featureGroups: parameters: *ref_1 post: - description: Creates a NotebookRuntimeTemplate. - operationId: aiplatform.projects.locations.notebookRuntimeTemplates.create + description: Creates a new FeatureGroup in a given project and location. + operationId: aiplatform.projects.locations.featureGroups.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplate + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureGroup' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33087,12 +40539,12 @@ paths: schema: type: string - in: query - name: notebookRuntimeTemplateId + name: featureGroupId schema: type: string get: - description: Lists NotebookRuntimeTemplates in a Location. - operationId: aiplatform.projects.locations.notebookRuntimeTemplates.list + description: Lists FeatureGroups in a given project and location. + operationId: aiplatform.projects.locations.featureGroups.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33105,7 +40557,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse + #/components/schemas/GoogleCloudAiplatformV1ListFeatureGroupsResponse parameters: - in: path name: projectsId @@ -33130,20 +40582,15 @@ paths: name: pageToken schema: type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - in: query name: orderBy schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}: + /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}: parameters: *ref_1 get: - description: Gets a NotebookRuntimeTemplate. - operationId: aiplatform.projects.locations.notebookRuntimeTemplates.get + description: Gets details of a single FeatureGroup. + operationId: aiplatform.projects.locations.featureGroups.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33155,8 +40602,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplate + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureGroup' parameters: - in: path name: projectsId @@ -33169,13 +40615,18 @@ paths: schema: type: string - in: path - name: notebookRuntimeTemplatesId + name: featureGroupsId required: true schema: type: string - delete: - description: Deletes a NotebookRuntimeTemplate. - operationId: aiplatform.projects.locations.notebookRuntimeTemplates.delete + patch: + description: Updates the parameters of a single FeatureGroup. + operationId: aiplatform.projects.locations.featureGroups.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureGroup' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33200,19 +40651,18 @@ paths: schema: type: string - in: path - name: notebookRuntimeTemplatesId + name: featureGroupsId required: true schema: type: string - patch: - description: Updates a NotebookRuntimeTemplate. - operationId: aiplatform.projects.locations.notebookRuntimeTemplates.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplate + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a single FeatureGroup. + operationId: aiplatform.projects.locations.featureGroups.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33224,8 +40674,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplate + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -33238,22 +40687,21 @@ paths: schema: type: string - in: path - name: notebookRuntimeTemplatesId + name: featureGroupsId required: true schema: type: string - in: query - name: updateMask + name: force schema: - type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}:wait: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.notebookRuntimeTemplates.operations.list + operationId: aiplatform.projects.locations.featureGroups.operations.listWait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33278,7 +40726,12 @@ paths: schema: type: string - in: path - name: notebookRuntimeTemplatesId + name: featureGroupsId + required: true + schema: + type: string + - in: path + name: operationsId required: true schema: type: string @@ -33295,14 +40748,64 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}: + post: + description: >- + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It may return the latest state before the specified + timeout (including immediately), meaning even an immediate response is + no guarantee that the operation is done. + operationId: aiplatform.projects.locations.featureGroups.operations.wait + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featureGroupsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + - in: query + name: timeout + schema: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}: parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - operationId: aiplatform.projects.locations.notebookRuntimeTemplates.operations.get + operationId: aiplatform.projects.locations.featureGroups.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33327,7 +40830,7 @@ paths: schema: type: string - in: path - name: notebookRuntimeTemplatesId + name: featureGroupsId required: true schema: type: string @@ -33342,7 +40845,7 @@ paths: is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.notebookRuntimeTemplates.operations.delete + operationId: aiplatform.projects.locations.featureGroups.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33367,7 +40870,7 @@ paths: schema: type: string - in: path - name: notebookRuntimeTemplatesId + name: featureGroupsId required: true schema: type: string @@ -33376,20 +40879,16 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features: parameters: *ref_1 post: - description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.notebookRuntimeTemplates.operations.cancel + description: Creates a new Feature in a given FeatureGroup. + operationId: aiplatform.projects.locations.featureGroups.features.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33401,7 +40900,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -33414,29 +40913,17 @@ paths: schema: type: string - in: path - name: notebookRuntimeTemplatesId + name: featureGroupsId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: featureId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:wait: - parameters: *ref_1 - post: - description: >- - Waits until the specified long-running operation is done or reaches at - most a specified timeout, returning the latest state. If the operation - is already done, the latest state is immediately returned. If the - timeout specified is greater than the default HTTP/RPC timeout, the - HTTP/RPC timeout is used. If the server does not support this method, it - returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a - best-effort basis. It may return the latest state before the specified - timeout (including immediately), meaning even an immediate response is - no guarantee that the operation is done. - operationId: aiplatform.projects.locations.notebookRuntimeTemplates.operations.wait + get: + description: Lists Features in a given FeatureGroup. + operationId: aiplatform.projects.locations.featureGroups.features.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33448,7 +40935,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListFeaturesResponse parameters: - in: path name: projectsId @@ -33461,33 +40949,48 @@ paths: schema: type: string - in: path - name: notebookRuntimeTemplatesId + name: featureGroupsId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: filter schema: type: string - in: query - name: timeout + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:setIamPolicy: + - in: query + name: orderBy + schema: + type: string + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: latestStatsCount + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features:batchCreate: parameters: *ref_1 post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - `PERMISSION_DENIED` errors. - operationId: aiplatform.projects.locations.featureOnlineStores.setIamPolicy + description: Creates a batch of Features in a given FeatureGroup. + operationId: aiplatform.projects.locations.featureGroups.features.batchCreate requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchCreateFeaturesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33499,7 +41002,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -33512,17 +41015,15 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: featureGroupsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:getIamPolicy: + /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}: parameters: *ref_1 - post: - description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: aiplatform.projects.locations.featureOnlineStores.getIamPolicy + get: + description: Gets details of a single Feature. + operationId: aiplatform.projects.locations.featureGroups.features.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33534,7 +41035,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' parameters: - in: path name: projectsId @@ -33547,25 +41048,23 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: featureGroupsId required: true schema: type: string - - in: query - name: options.requestedPolicyVersion + - in: path + name: featuresId + required: true schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:testIamPermissions: - parameters: *ref_1 - post: - description: >- - Returns permissions that a caller has on the specified resource. If the - resource does not exist, this will return an empty set of permissions, - not a `NOT_FOUND` error. Note: This operation is designed to be used for - building permission-aware UIs and command-line tools, not for - authorization checking. This operation may "fail open" without warning. - operationId: aiplatform.projects.locations.featureOnlineStores.testIamPermissions + type: string + patch: + description: Updates the parameters of a single Feature. + operationId: aiplatform.projects.locations.featureGroups.features.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33577,7 +41076,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -33590,24 +41089,23 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: featureGroupsId + required: true + schema: + type: string + - in: path + name: featuresId required: true schema: type: string - in: query - name: permissions + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores: - parameters: *ref_1 - post: - description: Creates a new FeatureOnlineStore in a given project and location. - operationId: aiplatform.projects.locations.featureOnlineStores.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStore' + format: google-fieldmask + delete: + description: Deletes a single Feature. + operationId: aiplatform.projects.locations.featureGroups.features.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33631,13 +41129,23 @@ paths: required: true schema: type: string - - in: query - name: featureOnlineStoreId + - in: path + name: featureGroupsId + required: true + schema: + type: string + - in: path + name: featuresId + required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}:wait: + parameters: *ref_1 get: - description: Lists FeatureOnlineStores in a given project and location. - operationId: aiplatform.projects.locations.featureOnlineStores.list + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.featureGroups.features.operations.listWait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33649,8 +41157,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListFeatureOnlineStoresResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -33662,6 +41169,21 @@ paths: required: true schema: type: string + - in: path + name: featureGroupsId + required: true + schema: + type: string + - in: path + name: featuresId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string - in: query name: filter schema: @@ -33675,15 +41197,18 @@ paths: name: pageToken schema: type: string - - in: query - name: orderBy - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}: - parameters: *ref_1 - get: - description: Gets details of a single FeatureOnlineStore. - operationId: aiplatform.projects.locations.featureOnlineStores.get + post: + description: >- + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It may return the latest state before the specified + timeout (including immediately), meaning even an immediate response is + no guarantee that the operation is done. + operationId: aiplatform.projects.locations.featureGroups.features.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33695,7 +41220,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStore' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -33708,18 +41233,33 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: featureGroupsId required: true schema: type: string - patch: - description: Updates the parameters of a single FeatureOnlineStore. - operationId: aiplatform.projects.locations.featureOnlineStores.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStore' + - in: path + name: featuresId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + - in: query + name: timeout + schema: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: aiplatform.projects.locations.featureGroups.features.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33744,20 +41284,27 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: featureGroupsId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: featuresId + required: true + schema: + type: string + - in: path + name: operationsId + required: true schema: type: string - format: google-fieldmask delete: description: >- - Deletes a single FeatureOnlineStore. The FeatureOnlineStore must not - contain any FeatureViews. - operationId: aiplatform.projects.locations.featureOnlineStores.delete + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.featureGroups.features.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33769,7 +41316,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -33782,28 +41329,27 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: featureGroupsId required: true schema: type: string - - in: query - name: force + - in: path + name: featuresId + required: true schema: - type: boolean - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:setIamPolicy: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations: parameters: *ref_1 - post: + get: description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - `PERMISSION_DENIED` errors. - operationId: >- - aiplatform.projects.locations.featureOnlineStores.featureViews.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33815,7 +41361,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -33827,24 +41373,27 @@ paths: required: true schema: type: string - - in: path - name: featureOnlineStoresId - required: true + - in: query + name: filter schema: type: string - - in: path - name: featureViewsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:getIamPolicy: + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: parameters: *ref_1 - post: + get: description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: >- - aiplatform.projects.locations.featureOnlineStores.featureViews.getIamPolicy + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: aiplatform.projects.locations.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33856,7 +41405,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -33869,31 +41418,17 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId - required: true - schema: - type: string - - in: path - name: featureViewsId + name: operationsId required: true schema: type: string - - in: query - name: options.requestedPolicyVersion - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:testIamPermissions: - parameters: *ref_1 - post: + delete: description: >- - Returns permissions that a caller has on the specified resource. If the - resource does not exist, this will return an empty set of permissions, - not a `NOT_FOUND` error. Note: This operation is designed to be used for - building permission-aware UIs and command-line tools, not for - authorization checking. This operation may "fail open" without warning. - operationId: >- - aiplatform.projects.locations.featureOnlineStores.featureViews.testIamPermissions + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33905,7 +41440,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -33918,29 +41453,24 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId - required: true - schema: - type: string - - in: path - name: featureViewsId + name: operationsId required: true schema: type: string - - in: query - name: permissions - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews: + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: - description: Creates a new FeatureView in a given FeatureOnlineStore. - operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureView' + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + `1`, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33952,7 +41482,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -33965,21 +41495,24 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: operationsId required: true schema: type: string - - in: query - name: featureViewId - schema: - type: string - - in: query - name: runSyncImmediately - schema: - type: boolean - get: - description: Lists FeatureViews in a given FeatureOnlineStore. - operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.list + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:wait: + parameters: *ref_1 + post: + description: >- + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It may return the latest state before the specified + timeout (including immediately), meaning even an immediate response is + no guarantee that the operation is done. + operationId: aiplatform.projects.locations.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33991,8 +41524,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListFeatureViewsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -34005,32 +41537,22 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: operationsId required: true schema: type: string - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: orderBy + name: timeout schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}: + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations: parameters: *ref_1 get: - description: Gets details of a single FeatureView. - operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.get + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.ragEngineConfig.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34042,7 +41564,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureView' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -34054,24 +41576,27 @@ paths: required: true schema: type: string - - in: path - name: featureOnlineStoresId - required: true + - in: query + name: filter schema: type: string - - in: path - name: featureViewsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - patch: - description: Updates the parameters of a single FeatureView. - operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureView' + /v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: aiplatform.projects.locations.ragEngineConfig.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34096,23 +41621,17 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId - required: true - schema: - type: string - - in: path - name: featureViewsId + name: operationsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask delete: - description: Deletes a single FeatureView. - operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.delete + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.ragEngineConfig.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34124,7 +41643,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -34137,26 +41656,24 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId - required: true - schema: - type: string - - in: path - name: featureViewsId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:sync: + /v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}:cancel: parameters: *ref_1 post: - description: Triggers on-demand sync for the FeatureView. - operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.sync - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SyncFeatureViewRequest + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + `1`, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.ragEngineConfig.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34168,8 +41685,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SyncFeatureViewResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -34182,27 +41698,24 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId - required: true - schema: - type: string - - in: path - name: featureViewsId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:fetchFeatureValues: + /v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}:wait: parameters: *ref_1 post: - description: Fetch feature values under a FeatureView. - operationId: >- - aiplatform.projects.locations.featureOnlineStores.featureViews.fetchFeatureValues - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FetchFeatureValuesRequest + description: >- + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It may return the latest state before the specified + timeout (including immediately), meaning even an immediate response is + no guarantee that the operation is done. + operationId: aiplatform.projects.locations.ragEngineConfig.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34214,8 +41727,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FetchFeatureValuesResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -34228,30 +41740,25 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: operationsId required: true schema: type: string - - in: path - name: featureViewsId - required: true + - in: query + name: timeout schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:searchNearestEntities: + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/datasets: parameters: *ref_1 post: - description: >- - Search the nearest entities under a FeatureView. Search only works for - indexable feature view; if a feature view isn't indexable, returns - Invalid argument response. - operationId: >- - aiplatform.projects.locations.featureOnlineStores.featureViews.searchNearestEntities + description: Creates a Dataset. + operationId: aiplatform.projects.locations.datasets.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SearchNearestEntitiesRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34263,8 +41770,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SearchNearestEntitiesResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -34276,24 +41782,9 @@ paths: required: true schema: type: string - - in: path - name: featureOnlineStoresId - required: true - schema: - type: string - - in: path - name: featureViewsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}:wait: - parameters: *ref_1 get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: >- - aiplatform.projects.locations.featureOnlineStores.featureViews.operations.listWait + description: Lists Datasets in a Location. + operationId: aiplatform.projects.locations.datasets.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34305,7 +41796,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListDatasetsResponse parameters: - in: path name: projectsId @@ -34317,21 +41809,6 @@ paths: required: true schema: type: string - - in: path - name: featureOnlineStoresId - required: true - schema: - type: string - - in: path - name: featureViewsId - required: true - schema: - type: string - - in: path - name: operationsId - required: true - schema: - type: string - in: query name: filter schema: @@ -34345,19 +41822,20 @@ paths: name: pageToken schema: type: string - post: - description: >- - Waits until the specified long-running operation is done or reaches at - most a specified timeout, returning the latest state. If the operation - is already done, the latest state is immediately returned. If the - timeout specified is greater than the default HTTP/RPC timeout, the - HTTP/RPC timeout is used. If the server does not support this method, it - returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a - best-effort basis. It may return the latest state before the specified - timeout (including immediately), meaning even an immediate response is - no guarantee that the operation is done. - operationId: >- - aiplatform.projects.locations.featureOnlineStores.featureViews.operations.wait + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}: + parameters: *ref_1 + get: + description: Gets a Dataset. + operationId: aiplatform.projects.locations.datasets.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34369,7 +41847,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' parameters: - in: path name: projectsId @@ -34382,34 +41860,23 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId - required: true - schema: - type: string - - in: path - name: featureViewsId - required: true - schema: - type: string - - in: path - name: operationsId + name: datasetsId required: true schema: type: string - in: query - name: timeout + name: readMask schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}: - parameters: *ref_1 - get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: >- - aiplatform.projects.locations.featureOnlineStores.featureViews.operations.get + format: google-fieldmask + patch: + description: Updates a Dataset. + operationId: aiplatform.projects.locations.datasets.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34421,7 +41888,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' parameters: - in: path name: projectsId @@ -34434,28 +41901,18 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId - required: true - schema: - type: string - - in: path - name: featureViewsId + name: datasetsId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: updateMask schema: type: string + format: google-fieldmask delete: - description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: >- - aiplatform.projects.locations.featureOnlineStores.featureViews.operations.delete + description: Deletes a Dataset. + operationId: aiplatform.projects.locations.datasets.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34467,7 +41924,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -34480,26 +41937,20 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId - required: true - schema: - type: string - - in: path - name: featureViewsId - required: true - schema: - type: string - - in: path - name: operationsId + name: datasetsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/featureViewSyncs/{featureViewSyncsId}: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:import: parameters: *ref_1 - get: - description: Gets details of a single FeatureViewSync. - operationId: >- - aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.get + post: + description: Imports data into a Dataset. + operationId: aiplatform.projects.locations.datasets.import + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ImportDataRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34511,7 +41962,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewSync' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -34524,26 +41975,53 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: datasetsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:export: + parameters: *ref_1 + post: + description: Exports data from a Dataset. + operationId: aiplatform.projects.locations.datasets.export + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExportDataRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId required: true schema: type: string - in: path - name: featureViewsId + name: locationsId required: true schema: type: string - in: path - name: featureViewSyncsId + name: datasetsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/featureViewSyncs: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:searchDataItems: parameters: *ref_1 get: - description: Lists FeatureViewSyncs in a given FeatureView. - operationId: >- - aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.list + description: Searches DataItems in a Dataset. + operationId: aiplatform.projects.locations.datasets.searchDataItems security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34556,7 +42034,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListFeatureViewSyncsResponse + #/components/schemas/GoogleCloudAiplatformV1SearchDataItemsResponse parameters: - in: path name: projectsId @@ -34569,39 +42047,72 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: datasetsId required: true schema: type: string - - in: path - name: featureViewsId - required: true + - in: query + name: orderByDataItem schema: type: string - in: query - name: filter + name: orderByAnnotation.savedQuery + schema: + type: string + - in: query + name: orderByAnnotation.orderBy + schema: + type: string + - in: query + name: savedQuery + schema: + type: string + - in: query + name: dataLabelingJob + schema: + type: string + - in: query + name: dataItemFilter + schema: + type: string + - in: query + name: annotationsFilter + schema: + type: string + - in: query + name: annotationFilters + schema: + type: string + - in: query + name: fieldMask schema: type: string + format: google-fieldmask + - in: query + name: annotationsLimit + schema: + type: integer + format: int32 - in: query name: pageSize schema: type: integer format: int32 - in: query - name: pageToken + name: orderBy schema: type: string - in: query - name: orderBy + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.featureOnlineStores.operations.listWait + operationId: aiplatform.projects.locations.datasets.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34626,12 +42137,7 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId - required: true - schema: - type: string - - in: path - name: operationsId + name: datasetsId required: true schema: type: string @@ -34648,18 +42154,14 @@ paths: name: pageToken schema: type: string - post: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}: + parameters: *ref_1 + get: description: >- - Waits until the specified long-running operation is done or reaches at - most a specified timeout, returning the latest state. If the operation - is already done, the latest state is immediately returned. If the - timeout specified is greater than the default HTTP/RPC timeout, the - HTTP/RPC timeout is used. If the server does not support this method, it - returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a - best-effort basis. It may return the latest state before the specified - timeout (including immediately), meaning even an immediate response is - no guarantee that the operation is done. - operationId: aiplatform.projects.locations.featureOnlineStores.operations.wait + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: aiplatform.projects.locations.datasets.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34684,7 +42186,7 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: datasetsId required: true schema: type: string @@ -34693,19 +42195,13 @@ paths: required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}: - parameters: *ref_1 - get: + delete: description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: aiplatform.projects.locations.featureOnlineStores.operations.get + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.datasets.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34717,7 +42213,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -34730,7 +42226,7 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: datasetsId required: true schema: type: string @@ -34739,13 +42235,20 @@ paths: required: true schema: type: string - delete: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.featureOnlineStores.operations.delete + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + `1`, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.datasets.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34770,7 +42273,7 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: datasetsId required: true schema: type: string @@ -34779,13 +42282,20 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}:wait: parameters: *ref_1 - get: + post: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.operations.list + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It may return the latest state before the specified + timeout (including immediately), meaning even an immediate response is + no guarantee that the operation is done. + operationId: aiplatform.projects.locations.datasets.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34797,7 +42307,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -34809,27 +42319,31 @@ paths: required: true schema: type: string - - in: query - name: filter + - in: path + name: datasetsId + required: true schema: type: string - - in: query - name: pageSize + - in: path + name: operationsId + required: true schema: - type: integer - format: int32 + type: string - in: query - name: pageToken + name: timeout schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions: parameters: *ref_1 - get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: aiplatform.projects.locations.operations.get + post: + description: Create a version from a Dataset. + operationId: aiplatform.projects.locations.datasets.datasetVersions.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34854,17 +42368,13 @@ paths: schema: type: string - in: path - name: operationsId + name: datasetsId required: true schema: type: string - delete: - description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.operations.delete + get: + description: Lists DatasetVersions in a Dataset. + operationId: aiplatform.projects.locations.datasets.datasetVersions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34876,7 +42386,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListDatasetVersionsResponse parameters: - in: path name: projectsId @@ -34889,24 +42400,83 @@ paths: schema: type: string - in: path - name: operationsId + name: datasetsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}: parameters: *ref_1 - post: - description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.operations.cancel + patch: + description: Updates a DatasetVersion. + operationId: aiplatform.projects.locations.datasets.datasetVersions.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: datasetVersionsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a Dataset version. + operationId: aiplatform.projects.locations.datasets.datasetVersions.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34918,7 +42488,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -34931,24 +42501,18 @@ paths: schema: type: string - in: path - name: operationsId + name: datasetsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:wait: - parameters: *ref_1 - post: - description: >- - Waits until the specified long-running operation is done or reaches at - most a specified timeout, returning the latest state. If the operation - is already done, the latest state is immediately returned. If the - timeout specified is greater than the default HTTP/RPC timeout, the - HTTP/RPC timeout is used. If the server does not support this method, it - returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a - best-effort basis. It may return the latest state before the specified - timeout (including immediately), meaning even an immediate response is - no guarantee that the operation is done. - operationId: aiplatform.projects.locations.operations.wait + - in: path + name: datasetVersionsId + required: true + schema: + type: string + get: + description: Gets a Dataset version. + operationId: aiplatform.projects.locations.datasets.datasetVersions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34960,7 +42524,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' parameters: - in: path name: projectsId @@ -34973,25 +42537,25 @@ paths: schema: type: string - in: path - name: operationsId + name: datasetsId + required: true + schema: + type: string + - in: path + name: datasetVersionsId required: true schema: type: string - in: query - name: timeout + name: readMask schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/datasets: + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}:restore: parameters: *ref_1 - post: - description: Creates a Dataset. - operationId: aiplatform.projects.locations.datasets.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' + get: + description: Restores a dataset version. + operationId: aiplatform.projects.locations.datasets.datasetVersions.restore security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35015,9 +42579,21 @@ paths: required: true schema: type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: datasetVersionsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems: + parameters: *ref_1 get: - description: Lists Datasets in a Location. - operationId: aiplatform.projects.locations.datasets.list + description: Lists DataItems in a Dataset. + operationId: aiplatform.projects.locations.datasets.dataItems.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35030,7 +42606,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListDatasetsResponse + #/components/schemas/GoogleCloudAiplatformV1ListDataItemsResponse parameters: - in: path name: projectsId @@ -35042,6 +42618,11 @@ paths: required: true schema: type: string + - in: path + name: datasetsId + required: true + schema: + type: string - in: query name: filter schema: @@ -35064,11 +42645,13 @@ paths: name: orderBy schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations: parameters: *ref_1 get: - description: Gets a Dataset. - operationId: aiplatform.projects.locations.datasets.get + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.datasets.dataItems.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35080,7 +42663,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -35097,19 +42680,32 @@ paths: required: true schema: type: string + - in: path + name: dataItemsId + required: true + schema: + type: string - in: query - name: readMask + name: filter schema: type: string - format: google-fieldmask - patch: - description: Updates a Dataset. - operationId: aiplatform.projects.locations.datasets.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: aiplatform.projects.locations.datasets.dataItems.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35121,7 +42717,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -35138,14 +42734,23 @@ paths: required: true schema: type: string - - in: query - name: updateMask + - in: path + name: dataItemsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true schema: type: string - format: google-fieldmask delete: - description: Deletes a Dataset. - operationId: aiplatform.projects.locations.datasets.delete + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.datasets.dataItems.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35157,7 +42762,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -35174,16 +42779,30 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:import: + - in: path + name: dataItemsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: - description: Imports data into a Dataset. - operationId: aiplatform.projects.locations.datasets.import - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ImportDataRequest' + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + `1`, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.datasets.dataItems.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35195,7 +42814,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -35212,16 +42831,30 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:export: + - in: path + name: dataItemsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:wait: parameters: *ref_1 post: - description: Exports data from a Dataset. - operationId: aiplatform.projects.locations.datasets.export - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExportDataRequest' + description: >- + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It may return the latest state before the specified + timeout (including immediately), meaning even an immediate response is + no guarantee that the operation is done. + operationId: aiplatform.projects.locations.datasets.dataItems.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35250,11 +42883,26 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:searchDataItems: + - in: path + name: dataItemsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + - in: query + name: timeout + schema: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations: parameters: *ref_1 get: - description: Searches DataItems in a Dataset. - operationId: aiplatform.projects.locations.datasets.searchDataItems + description: Lists Annotations belongs to a dataitem. + operationId: aiplatform.projects.locations.datasets.dataItems.annotations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35267,7 +42915,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SearchDataItemsResponse + #/components/schemas/GoogleCloudAiplatformV1ListAnnotationsResponse parameters: - in: path name: projectsId @@ -35284,68 +42932,41 @@ paths: required: true schema: type: string - - in: query - name: orderByDataItem - schema: - type: string - - in: query - name: orderByAnnotation.savedQuery - schema: - type: string - - in: query - name: orderByAnnotation.orderBy - schema: - type: string - - in: query - name: savedQuery - schema: - type: string - - in: query - name: dataLabelingJob + - in: path + name: dataItemsId + required: true schema: type: string - in: query - name: dataItemFilter + name: filter schema: type: string - in: query - name: annotationsFilter + name: pageSize schema: - type: string + type: integer + format: int32 - in: query - name: annotationFilters + name: pageToken schema: type: string - in: query - name: fieldMask + name: readMask schema: type: string format: google-fieldmask - - in: query - name: annotationsLimit - schema: - type: integer - format: int32 - - in: query - name: pageSize - schema: - type: integer - format: int32 - in: query name: orderBy schema: type: string - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.datasets.operations.list + operationId: >- + aiplatform.projects.locations.datasets.dataItems.annotations.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35374,6 +42995,16 @@ paths: required: true schema: type: string + - in: path + name: dataItemsId + required: true + schema: + type: string + - in: path + name: annotationsId + required: true + schema: + type: string - in: query name: filter schema: @@ -35387,14 +43018,15 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}: parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - operationId: aiplatform.projects.locations.datasets.operations.get + operationId: >- + aiplatform.projects.locations.datasets.dataItems.annotations.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35423,6 +43055,16 @@ paths: required: true schema: type: string + - in: path + name: dataItemsId + required: true + schema: + type: string + - in: path + name: annotationsId + required: true + schema: + type: string - in: path name: operationsId required: true @@ -35434,7 +43076,8 @@ paths: is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.datasets.operations.delete + operationId: >- + aiplatform.projects.locations.datasets.dataItems.annotations.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35463,12 +43106,22 @@ paths: required: true schema: type: string + - in: path + name: dataItemsId + required: true + schema: + type: string + - in: path + name: annotationsId + required: true + schema: + type: string - in: path name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- @@ -35480,8 +43133,9 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.datasets.operations.cancel + `1`, corresponding to `Code.CANCELLED`. + operationId: >- + aiplatform.projects.locations.datasets.dataItems.annotations.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35510,12 +43164,22 @@ paths: required: true schema: type: string + - in: path + name: dataItemsId + required: true + schema: + type: string + - in: path + name: annotationsId + required: true + schema: + type: string - in: path name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- @@ -35528,7 +43192,8 @@ paths: best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. - operationId: aiplatform.projects.locations.datasets.operations.wait + operationId: >- + aiplatform.projects.locations.datasets.dataItems.annotations.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35557,6 +43222,16 @@ paths: required: true schema: type: string + - in: path + name: dataItemsId + required: true + schema: + type: string + - in: path + name: annotationsId + required: true + schema: + type: string - in: path name: operationsId required: true @@ -35567,16 +43242,67 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries: parameters: *ref_1 - post: - description: Create a version from a Dataset. - operationId: aiplatform.projects.locations.datasets.datasetVersions.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' + get: + description: Lists SavedQueries in a Dataset. + operationId: aiplatform.projects.locations.datasets.savedQueries.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListSavedQueriesResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}: + parameters: *ref_1 + delete: + description: Deletes a SavedQuery. + operationId: aiplatform.projects.locations.datasets.savedQueries.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35605,9 +43331,18 @@ paths: required: true schema: type: string + - in: path + name: savedQueriesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations: + parameters: *ref_1 get: - description: Lists DatasetVersions in a Dataset. - operationId: aiplatform.projects.locations.datasets.datasetVersions.list + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.datasets.savedQueries.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35619,8 +43354,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListDatasetVersionsResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -35637,6 +43371,11 @@ paths: required: true schema: type: string + - in: path + name: savedQueriesId + required: true + schema: + type: string - in: query name: filter schema: @@ -35650,25 +43389,14 @@ paths: name: pageToken schema: type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: orderBy - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}: parameters: *ref_1 - patch: - description: Updates a DatasetVersion. - operationId: aiplatform.projects.locations.datasets.datasetVersions.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: aiplatform.projects.locations.datasets.savedQueries.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35680,7 +43408,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -35698,18 +43426,22 @@ paths: schema: type: string - in: path - name: datasetVersionsId + name: savedQueriesId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: operationsId + required: true schema: type: string - format: google-fieldmask delete: - description: Deletes a Dataset version. - operationId: aiplatform.projects.locations.datasets.datasetVersions.delete + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.datasets.savedQueries.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35721,7 +43453,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -35739,13 +43471,29 @@ paths: schema: type: string - in: path - name: datasetVersionsId + name: savedQueriesId required: true schema: type: string - get: - description: Gets a Dataset version. - operationId: aiplatform.projects.locations.datasets.datasetVersions.get + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + `1`, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.datasets.savedQueries.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35757,7 +43505,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -35775,20 +43523,29 @@ paths: schema: type: string - in: path - name: datasetVersionsId + name: savedQueriesId required: true schema: type: string - - in: query - name: readMask + - in: path + name: operationsId + required: true schema: type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}:restore: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:wait: parameters: *ref_1 - get: - description: Restores a dataset version. - operationId: aiplatform.projects.locations.datasets.datasetVersions.restore + post: + description: >- + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It may return the latest state before the specified + timeout (including immediately), meaning even an immediate response is + no guarantee that the operation is done. + operationId: aiplatform.projects.locations.datasets.savedQueries.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35818,15 +43575,25 @@ paths: schema: type: string - in: path - name: datasetVersionsId + name: savedQueriesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems: + - in: path + name: operationsId + required: true + schema: + type: string + - in: query + name: timeout + schema: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}: parameters: *ref_1 get: - description: Lists DataItems in a Dataset. - operationId: aiplatform.projects.locations.datasets.dataItems.list + description: Gets an AnnotationSpec. + operationId: aiplatform.projects.locations.datasets.annotationSpecs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35838,8 +43605,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListDataItemsResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1AnnotationSpec' parameters: - in: path name: projectsId @@ -35856,17 +43622,9 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: annotationSpecsId + required: true schema: type: string - in: query @@ -35874,17 +43632,13 @@ paths: schema: type: string format: google-fieldmask - - in: query - name: orderBy - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.datasets.dataItems.operations.list + operationId: aiplatform.projects.locations.datasets.annotationSpecs.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35914,7 +43668,7 @@ paths: schema: type: string - in: path - name: dataItemsId + name: annotationSpecsId required: true schema: type: string @@ -35931,14 +43685,14 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}: parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - operationId: aiplatform.projects.locations.datasets.dataItems.operations.get + operationId: aiplatform.projects.locations.datasets.annotationSpecs.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35968,7 +43722,7 @@ paths: schema: type: string - in: path - name: dataItemsId + name: annotationSpecsId required: true schema: type: string @@ -35983,7 +43737,7 @@ paths: is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.datasets.dataItems.operations.delete + operationId: aiplatform.projects.locations.datasets.annotationSpecs.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36013,7 +43767,7 @@ paths: schema: type: string - in: path - name: dataItemsId + name: annotationSpecsId required: true schema: type: string @@ -36022,7 +43776,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- @@ -36034,8 +43788,8 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.datasets.dataItems.operations.cancel + `1`, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.datasets.annotationSpecs.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36065,7 +43819,7 @@ paths: schema: type: string - in: path - name: dataItemsId + name: annotationSpecsId required: true schema: type: string @@ -36074,7 +43828,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- @@ -36087,7 +43841,7 @@ paths: best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. - operationId: aiplatform.projects.locations.datasets.dataItems.operations.wait + operationId: aiplatform.projects.locations.datasets.annotationSpecs.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36117,7 +43871,7 @@ paths: schema: type: string - in: path - name: dataItemsId + name: annotationSpecsId required: true schema: type: string @@ -36131,14 +43885,17 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations: + /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools: parameters: *ref_1 - get: - description: >- - Lists Annotations belongs to a dataitem This RPC is only available in - InternalDatasetService. It is only used for exporting conversation data - to CCAI Insights. - operationId: aiplatform.projects.locations.datasets.dataItems.annotations.list + post: + description: Create a DeploymentResourcePool. + operationId: aiplatform.projects.locations.deploymentResourcePools.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1CreateDeploymentResourcePoolRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36150,8 +43907,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListAnnotationsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -36163,20 +43919,33 @@ paths: required: true schema: type: string + get: + description: List DeploymentResourcePools in a location. + operationId: aiplatform.projects.locations.deploymentResourcePools.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListDeploymentResourcePoolsResponse + parameters: - in: path - name: datasetsId + name: projectsId required: true schema: type: string - in: path - name: dataItemsId + name: locationsId required: true schema: type: string - - in: query - name: filter - schema: - type: string - in: query name: pageSize schema: @@ -36186,23 +43955,121 @@ paths: name: pageToken schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}: + parameters: *ref_1 + get: + description: Get a DeploymentResourcePool. + operationId: aiplatform.projects.locations.deploymentResourcePools.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1DeploymentResourcePool + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: deploymentResourcePoolsId + required: true + schema: + type: string + patch: + description: Update a DeploymentResourcePool. + operationId: aiplatform.projects.locations.deploymentResourcePools.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1DeploymentResourcePool + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: deploymentResourcePoolsId + required: true + schema: + type: string - in: query - name: readMask + name: updateMask schema: type: string format: google-fieldmask - - in: query - name: orderBy + delete: + description: Delete a DeploymentResourcePool. + operationId: aiplatform.projects.locations.deploymentResourcePools.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations: + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: deploymentResourcePoolsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}:queryDeployedModels: parameters: *ref_1 get: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. + List DeployedModels that have been deployed on this + DeploymentResourcePool. operationId: >- - aiplatform.projects.locations.datasets.dataItems.annotations.operations.list + aiplatform.projects.locations.deploymentResourcePools.queryDeployedModels security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36214,7 +44081,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1QueryDeployedModelsResponse parameters: - in: path name: projectsId @@ -36227,17 +44095,51 @@ paths: schema: type: string - in: path - name: datasetsId + name: deploymentResourcePoolsId required: true schema: type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.deploymentResourcePools.operations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + parameters: - in: path - name: dataItemsId + name: projectsId required: true schema: type: string - in: path - name: annotationsId + name: locationsId + required: true + schema: + type: string + - in: path + name: deploymentResourcePoolsId required: true schema: type: string @@ -36254,15 +44156,14 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}: parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - operationId: >- - aiplatform.projects.locations.datasets.dataItems.annotations.operations.get + operationId: aiplatform.projects.locations.deploymentResourcePools.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36287,17 +44188,7 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: dataItemsId - required: true - schema: - type: string - - in: path - name: annotationsId + name: deploymentResourcePoolsId required: true schema: type: string @@ -36312,8 +44203,7 @@ paths: is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. - operationId: >- - aiplatform.projects.locations.datasets.dataItems.annotations.operations.delete + operationId: aiplatform.projects.locations.deploymentResourcePools.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36338,17 +44228,7 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: dataItemsId - required: true - schema: - type: string - - in: path - name: annotationsId + name: deploymentResourcePoolsId required: true schema: type: string @@ -36357,7 +44237,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- @@ -36369,9 +44249,8 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: >- - aiplatform.projects.locations.datasets.dataItems.annotations.operations.cancel + `1`, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.deploymentResourcePools.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36396,17 +44275,7 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: dataItemsId - required: true - schema: - type: string - - in: path - name: annotationsId + name: deploymentResourcePoolsId required: true schema: type: string @@ -36415,7 +44284,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- @@ -36428,8 +44297,7 @@ paths: best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. - operationId: >- - aiplatform.projects.locations.datasets.dataItems.annotations.operations.wait + operationId: aiplatform.projects.locations.deploymentResourcePools.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36454,35 +44322,60 @@ paths: schema: type: string - in: path - name: datasetsId + name: deploymentResourcePoolsId required: true schema: type: string - in: path - name: dataItemsId + name: operationsId required: true schema: type: string + - in: query + name: timeout + schema: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/endpoints: + parameters: *ref_1 + post: + description: Creates an Endpoint. + operationId: aiplatform.projects.locations.endpoints.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Endpoint' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: - in: path - name: annotationsId + name: projectsId required: true schema: type: string - in: path - name: operationsId + name: locationsId required: true schema: type: string - in: query - name: timeout + name: endpointId schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries: - parameters: *ref_1 get: - description: Lists SavedQueries in a Dataset. - operationId: aiplatform.projects.locations.datasets.savedQueries.list + description: Lists Endpoints in a Location. + operationId: aiplatform.projects.locations.endpoints.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36495,7 +44388,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListSavedQueriesResponse + #/components/schemas/GoogleCloudAiplatformV1ListEndpointsResponse parameters: - in: path name: projectsId @@ -36507,11 +44400,6 @@ paths: required: true schema: type: string - - in: path - name: datasetsId - required: true - schema: - type: string - in: query name: filter schema: @@ -36534,11 +44422,15 @@ paths: name: orderBy schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}: + - in: query + name: gdcZone + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}: parameters: *ref_1 - delete: - description: Deletes a SavedQuery. - operationId: aiplatform.projects.locations.datasets.savedQueries.delete + get: + description: Gets an Endpoint. + operationId: aiplatform.projects.locations.endpoints.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36550,7 +44442,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Endpoint' parameters: - in: path name: projectsId @@ -36563,22 +44455,54 @@ paths: schema: type: string - in: path - name: datasetsId + name: endpointsId required: true schema: type: string + patch: + description: Updates an Endpoint. + operationId: aiplatform.projects.locations.endpoints.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Endpoint' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Endpoint' + parameters: - in: path - name: savedQueriesId + name: projectsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations: - parameters: *ref_1 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.datasets.savedQueries.operations.list + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: endpointsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes an Endpoint. + operationId: aiplatform.projects.locations.endpoints.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36590,7 +44514,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -36603,36 +44527,59 @@ paths: schema: type: string - in: path - name: datasetsId + name: endpointsId required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:update: + parameters: *ref_1 + post: + description: Updates an Endpoint with a long running operation. + operationId: aiplatform.projects.locations.endpoints.update + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1UpdateEndpointLongRunningRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: - in: path - name: savedQueriesId + name: projectsId required: true schema: type: string - - in: query - name: filter + - in: path + name: locationsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: endpointsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:deployModel: parameters: *ref_1 - get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: aiplatform.projects.locations.datasets.savedQueries.operations.get + post: + description: Deploys a Model into this Endpoint, creating a DeployedModel within it. + operationId: aiplatform.projects.locations.endpoints.deployModel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployModelRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36657,27 +44604,22 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: savedQueriesId - required: true - schema: - type: string - - in: path - name: operationsId + name: endpointsId required: true schema: type: string - delete: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:undeployModel: + parameters: *ref_1 + post: description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.datasets.savedQueries.operations.delete + Undeploys a Model from an Endpoint, removing a DeployedModel from it, + and freeing all resources it's using. + operationId: aiplatform.projects.locations.endpoints.undeployModel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1UndeployModelRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36689,7 +44631,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -36702,34 +44644,25 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: savedQueriesId - required: true - schema: - type: string - - in: path - name: operationsId + name: endpointsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:mutateDeployedModel: parameters: *ref_1 post: description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.datasets.savedQueries.operations.cancel + Updates an existing deployed model. Updatable fields include + `min_replica_count`, `max_replica_count`, `required_replica_count`, + `autoscaling_metric_specs`, `disable_container_logging` (v1 only), and + `enable_container_logging` (v1beta1 only). + operationId: aiplatform.projects.locations.endpoints.mutateDeployedModel + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1MutateDeployedModelRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36741,7 +44674,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -36754,46 +44687,36 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: savedQueriesId - required: true - schema: - type: string - - in: path - name: operationsId + name: endpointsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:predict: parameters: *ref_1 post: - description: >- - Waits until the specified long-running operation is done or reaches at - most a specified timeout, returning the latest state. If the operation - is already done, the latest state is immediately returned. If the - timeout specified is greater than the default HTTP/RPC timeout, the - HTTP/RPC timeout is used. If the server does not support this method, it - returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a - best-effort basis. It may return the latest state before the specified - timeout (including immediately), meaning even an immediate response is - no guarantee that the operation is done. - operationId: aiplatform.projects.locations.datasets.savedQueries.operations.wait + description: Perform an online prediction. + operationId: aiplatform.projects.locations.endpoints.predict + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictResponse' parameters: - in: path name: projectsId @@ -36806,42 +44729,41 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: savedQueriesId - required: true - schema: - type: string - - in: path - name: operationsId + name: endpointsId required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:rawPredict: parameters: *ref_1 - get: - description: Gets an AnnotationSpec. - operationId: aiplatform.projects.locations.datasets.annotationSpecs.get + post: + description: >- + Perform an online prediction with an arbitrary HTTP payload. The + response includes the following HTTP headers: * + `X-Vertex-AI-Endpoint-Id`: ID of the Endpoint that served this + prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's + DeployedModel that served this prediction. + operationId: aiplatform.projects.locations.endpoints.rawPredict + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1RawPredictRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1AnnotationSpec' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: projectsId @@ -36854,39 +44776,37 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: annotationSpecsId + name: endpointsId required: true schema: type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:streamRawPredict: parameters: *ref_1 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.datasets.annotationSpecs.operations.list + post: + description: Perform a streaming online prediction with an arbitrary HTTP payload. + operationId: aiplatform.projects.locations.endpoints.streamRawPredict + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StreamRawPredictRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: projectsId @@ -36899,48 +44819,39 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: annotationSpecsId + name: endpointsId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:directPredict: parameters: *ref_1 - get: + post: description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: aiplatform.projects.locations.datasets.annotationSpecs.operations.get + Perform an unary online prediction request to a gRPC model server for + Vertex first-party products and frameworks. + operationId: aiplatform.projects.locations.endpoints.directPredict + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DirectPredictRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1DirectPredictResponse parameters: - in: path name: projectsId @@ -36953,39 +44864,40 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: annotationSpecsId - required: true - schema: - type: string - - in: path - name: operationsId + name: endpointsId required: true schema: type: string - delete: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:directRawPredict: + parameters: *ref_1 + post: description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.datasets.annotationSpecs.operations.delete + Perform an unary online prediction request to a gRPC model server for + custom containers. + operationId: aiplatform.projects.locations.endpoints.directRawPredict + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1DirectRawPredictRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1DirectRawPredictResponse parameters: - in: path name: projectsId @@ -36998,46 +44910,40 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: annotationSpecsId - required: true - schema: - type: string - - in: path - name: operationsId + name: endpointsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:serverStreamingPredict: parameters: *ref_1 post: description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.datasets.annotationSpecs.operations.cancel + Perform a server-side streaming online prediction request for Vertex LLM + streaming. + operationId: aiplatform.projects.locations.endpoints.serverStreamingPredict + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StreamingPredictRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StreamingPredictResponse parameters: - in: path name: projectsId @@ -37050,39 +44956,30 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: annotationSpecsId - required: true - schema: - type: string - - in: path - name: operationsId + name: endpointsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:predictLongRunning: parameters: *ref_1 post: - description: >- - Waits until the specified long-running operation is done or reaches at - most a specified timeout, returning the latest state. If the operation - is already done, the latest state is immediately returned. If the - timeout specified is greater than the default HTTP/RPC timeout, the - HTTP/RPC timeout is used. If the server does not support this method, it - returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a - best-effort basis. It may return the latest state before the specified - timeout (including immediately), meaning even an immediate response is - no guarantee that the operation is done. - operationId: aiplatform.projects.locations.datasets.annotationSpecs.operations.wait + description: '' + operationId: aiplatform.projects.locations.endpoints.predictLongRunning + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PredictLongRunningRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response @@ -37102,41 +44999,30 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: annotationSpecsId - required: true - schema: - type: string - - in: path - name: operationsId + name: endpointsId required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:fetchPredictOperation: parameters: *ref_1 post: - description: Create a DeploymentResourcePool. - operationId: aiplatform.projects.locations.deploymentResourcePools.create + description: Fetch an asynchronous online prediction operation. + operationId: aiplatform.projects.locations.endpoints.fetchPredictOperation requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CreateDeploymentResourcePoolRequest + #/components/schemas/GoogleCloudAiplatformV1FetchPredictOperationRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response @@ -37155,22 +45041,41 @@ paths: required: true schema: type: string - get: - description: List DeploymentResourcePools in a location. - operationId: aiplatform.projects.locations.deploymentResourcePools.list + - in: path + name: endpointsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:explain: + parameters: *ref_1 + post: + description: >- + Perform an online explanation. If deployed_model_id is specified, the + corresponding DeployModel must have explanation_spec populated. If + deployed_model_id is not specified, all DeployedModels must have + explanation_spec populated. + operationId: aiplatform.projects.locations.endpoints.explain + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplainRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListDeploymentResourcePoolsResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplainResponse' parameters: - in: path name: projectsId @@ -37182,25 +45087,31 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: endpointsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:generateContent: parameters: *ref_1 - get: - description: Get a DeploymentResourcePool. - operationId: aiplatform.projects.locations.deploymentResourcePools.get + post: + description: Generate content with multimodal inputs. + operationId: aiplatform.projects.locations.endpoints.generateContent + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response @@ -37208,7 +45119,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DeploymentResourcePool + #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse parameters: - in: path name: projectsId @@ -37221,31 +45132,38 @@ paths: schema: type: string - in: path - name: deploymentResourcePoolsId + name: endpointsId required: true schema: type: string - patch: - description: Update a DeploymentResourcePool. - operationId: aiplatform.projects.locations.deploymentResourcePools.patch + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:streamGenerateContent: + parameters: *ref_1 + post: + description: Generate content with multimodal inputs with streaming support. + operationId: aiplatform.projects.locations.endpoints.streamGenerateContent requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DeploymentResourcePool + #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse parameters: - in: path name: projectsId @@ -37258,18 +45176,20 @@ paths: schema: type: string - in: path - name: deploymentResourcePoolsId + name: endpointsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: - description: Delete a DeploymentResourcePool. - operationId: aiplatform.projects.locations.deploymentResourcePools.delete + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:countTokens: + parameters: *ref_1 + post: + description: Perform a token counting. + operationId: aiplatform.projects.locations.endpoints.countTokens + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CountTokensRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37281,7 +45201,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1CountTokensResponse parameters: - in: path name: projectsId @@ -37294,18 +45215,20 @@ paths: schema: type: string - in: path - name: deploymentResourcePoolsId + name: endpointsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}:queryDeployedModels: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:computeTokens: parameters: *ref_1 - get: - description: >- - List DeployedModels that have been deployed on this - DeploymentResourcePool. - operationId: >- - aiplatform.projects.locations.deploymentResourcePools.queryDeployedModels + post: + description: Return a list of tokens based on the input text. + operationId: aiplatform.projects.locations.endpoints.computeTokens + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ComputeTokensRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37318,7 +45241,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1QueryDeployedModelsResponse + #/components/schemas/GoogleCloudAiplatformV1ComputeTokensResponse parameters: - in: path name: projectsId @@ -37331,26 +45254,17 @@ paths: schema: type: string - in: path - name: deploymentResourcePoolsId + name: endpointsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.deploymentResourcePools.operations.list + operationId: aiplatform.projects.locations.endpoints.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37375,7 +45289,7 @@ paths: schema: type: string - in: path - name: deploymentResourcePoolsId + name: endpointsId required: true schema: type: string @@ -37392,14 +45306,14 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}: parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - operationId: aiplatform.projects.locations.deploymentResourcePools.operations.get + operationId: aiplatform.projects.locations.endpoints.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37424,7 +45338,7 @@ paths: schema: type: string - in: path - name: deploymentResourcePoolsId + name: endpointsId required: true schema: type: string @@ -37439,7 +45353,7 @@ paths: is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.deploymentResourcePools.operations.delete + operationId: aiplatform.projects.locations.endpoints.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37464,7 +45378,7 @@ paths: schema: type: string - in: path - name: deploymentResourcePoolsId + name: endpointsId required: true schema: type: string @@ -37473,7 +45387,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- @@ -37485,8 +45399,8 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.deploymentResourcePools.operations.cancel + `1`, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.endpoints.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37511,7 +45425,7 @@ paths: schema: type: string - in: path - name: deploymentResourcePoolsId + name: endpointsId required: true schema: type: string @@ -37520,7 +45434,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- @@ -37533,7 +45447,7 @@ paths: best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. - operationId: aiplatform.projects.locations.deploymentResourcePools.operations.wait + operationId: aiplatform.projects.locations.endpoints.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37558,7 +45472,7 @@ paths: schema: type: string - in: path - name: deploymentResourcePoolsId + name: endpointsId required: true schema: type: string @@ -37572,28 +45486,32 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/endpoints: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/chat/completions: parameters: *ref_1 post: - description: Creates an Endpoint. - operationId: aiplatform.projects.locations.endpoints.create + description: Exposes an OpenAI-compatible endpoint for chat completions. + operationId: aiplatform.projects.locations.endpoints.chat.completions requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Endpoint' + $ref: '#/components/schemas/GoogleApiHttpBody' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: projectsId @@ -37605,13 +45523,23 @@ paths: required: true schema: type: string - - in: query - name: endpointId + - in: path + name: endpointsId + required: true schema: type: string - get: - description: Lists Endpoints in a Location. - operationId: aiplatform.projects.locations.endpoints.list + /v1/projects/{projectsId}/locations/{locationsId}/cachedContents: + parameters: *ref_1 + post: + description: >- + Creates cached content, this call will initialize the cached content in + the data storage, and users need to pay for the cache data storage. + operationId: aiplatform.projects.locations.cachedContents.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CachedContent' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37623,8 +45551,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListEndpointsResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1CachedContent' parameters: - in: path name: projectsId @@ -37636,8 +45563,31 @@ paths: required: true schema: type: string - - in: query - name: filter + get: + description: Lists cached contents in a project + operationId: aiplatform.projects.locations.cachedContents.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListCachedContentsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true schema: type: string - in: query @@ -37649,20 +45599,11 @@ paths: name: pageToken schema: type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: orderBy - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}: + /v1/projects/{projectsId}/locations/{locationsId}/cachedContents/{cachedContentsId}: parameters: *ref_1 get: - description: Gets an Endpoint. - operationId: aiplatform.projects.locations.endpoints.get + description: Gets cached content configurations + operationId: aiplatform.projects.locations.cachedContents.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37674,7 +45615,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Endpoint' + $ref: '#/components/schemas/GoogleCloudAiplatformV1CachedContent' parameters: - in: path name: projectsId @@ -37687,18 +45628,18 @@ paths: schema: type: string - in: path - name: endpointsId + name: cachedContentsId required: true schema: type: string patch: - description: Updates an Endpoint. - operationId: aiplatform.projects.locations.endpoints.patch + description: Updates cached content configurations + operationId: aiplatform.projects.locations.cachedContents.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Endpoint' + $ref: '#/components/schemas/GoogleCloudAiplatformV1CachedContent' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37710,7 +45651,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Endpoint' + $ref: '#/components/schemas/GoogleCloudAiplatformV1CachedContent' parameters: - in: path name: projectsId @@ -37723,7 +45664,7 @@ paths: schema: type: string - in: path - name: endpointsId + name: cachedContentsId required: true schema: type: string @@ -37733,8 +45674,8 @@ paths: type: string format: google-fieldmask delete: - description: Deletes an Endpoint. - operationId: aiplatform.projects.locations.endpoints.delete + description: Deletes cached content + operationId: aiplatform.projects.locations.cachedContents.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37746,7 +45687,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -37759,20 +45700,22 @@ paths: schema: type: string - in: path - name: endpointsId + name: cachedContentsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:deployModel: + /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs: parameters: *ref_1 post: - description: Deploys a Model into this Endpoint, creating a DeployedModel within it. - operationId: aiplatform.projects.locations.endpoints.deployModel + description: >- + Creates a TuningJob. A created TuningJob right away will be attempted to + be run. + operationId: aiplatform.projects.locations.tuningJobs.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployModelRequest' + $ref: '#/components/schemas/GoogleCloudAiplatformV1TuningJob' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37784,7 +45727,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1TuningJob' parameters: - in: path name: projectsId @@ -37796,23 +45739,9 @@ paths: required: true schema: type: string - - in: path - name: endpointsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:undeployModel: - parameters: *ref_1 - post: - description: >- - Undeploys a Model from an Endpoint, removing a DeployedModel from it, - and freeing all resources it's using. - operationId: aiplatform.projects.locations.endpoints.undeployModel - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1UndeployModelRequest' + get: + description: Lists TuningJobs in a Location. + operationId: aiplatform.projects.locations.tuningJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37824,7 +45753,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListTuningJobsResponse parameters: - in: path name: projectsId @@ -37836,26 +45766,24 @@ paths: required: true schema: type: string - - in: path - name: endpointsId - required: true + - in: query + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:mutateDeployedModel: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}: parameters: *ref_1 - post: - description: >- - Updates an existing deployed model. Updatable fields include - `min_replica_count`, `max_replica_count`, `autoscaling_metric_specs`, - `disable_container_logging` (v1 only), and `enable_container_logging` - (v1beta1 only). - operationId: aiplatform.projects.locations.endpoints.mutateDeployedModel - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MutateDeployedModelRequest + get: + description: Gets a TuningJob. + operationId: aiplatform.projects.locations.tuningJobs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37867,7 +45795,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1TuningJob' parameters: - in: path name: projectsId @@ -37880,36 +45808,41 @@ paths: schema: type: string - in: path - name: endpointsId + name: tuningJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:predict: + /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}:cancel: parameters: *ref_1 post: - description: Perform an online prediction. - operationId: aiplatform.projects.locations.endpoints.predict + description: >- + Cancels a TuningJob. Starts asynchronous cancellation on the TuningJob. + The server makes a best effort to cancel the job, but success is not + guaranteed. Clients can use GenAiTuningService.GetTuningJob or other + methods to check whether the cancellation succeeded or whether the job + completed despite cancellation. On successful cancellation, the + TuningJob is not deleted; instead it becomes a job with a + TuningJob.error value with a google.rpc.Status.code of 1, corresponding + to `Code.CANCELLED`, and TuningJob.state is set to `CANCELLED`. + operationId: aiplatform.projects.locations.tuningJobs.cancel requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictRequest' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1CancelTuningJobRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -37922,41 +45855,33 @@ paths: schema: type: string - in: path - name: endpointsId + name: tuningJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:rawPredict: + /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs:rebaseTunedModel: parameters: *ref_1 post: - description: >- - Perform an online prediction with an arbitrary HTTP payload. The - response includes the following HTTP headers: * - `X-Vertex-AI-Endpoint-Id`: ID of the Endpoint that served this - prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's - DeployedModel that served this prediction. - operationId: aiplatform.projects.locations.endpoints.rawPredict + description: Rebase a TunedModel. + operationId: aiplatform.projects.locations.tuningJobs.rebaseTunedModel requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1RawPredictRequest' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1RebaseTunedModelRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -37968,38 +45893,25 @@ paths: required: true schema: type: string - - in: path - name: endpointsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:streamRawPredict: + /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations: parameters: *ref_1 - post: - description: Perform a streaming online prediction with an arbitrary HTTP payload. - operationId: aiplatform.projects.locations.endpoints.streamRawPredict - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StreamRawPredictRequest + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.tuningJobs.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -38012,39 +45924,43 @@ paths: schema: type: string - in: path - name: endpointsId + name: tuningJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:directPredict: + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}: parameters: *ref_1 - post: + get: description: >- - Perform an unary online prediction request to a gRPC model server for - Vertex first-party products and frameworks. - operationId: aiplatform.projects.locations.endpoints.directPredict - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DirectPredictRequest' + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: aiplatform.projects.locations.tuningJobs.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DirectPredictResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -38057,40 +45973,34 @@ paths: schema: type: string - in: path - name: endpointsId + name: tuningJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:directRawPredict: - parameters: *ref_1 - post: + - in: path + name: operationsId + required: true + schema: + type: string + delete: description: >- - Perform an unary online prediction request to a gRPC model server for - custom containers. - operationId: aiplatform.projects.locations.endpoints.directRawPredict - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DirectRawPredictRequest + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.tuningJobs.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DirectRawPredictResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -38103,40 +46013,41 @@ paths: schema: type: string - in: path - name: endpointsId + name: tuningJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:serverStreamingPredict: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- - Perform a server-side streaming online prediction request for Vertex LLM - streaming. - operationId: aiplatform.projects.locations.endpoints.serverStreamingPredict - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StreamingPredictRequest + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + `1`, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.tuningJobs.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StreamingPredictResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -38149,30 +46060,30 @@ paths: schema: type: string - in: path - name: endpointsId + name: tuningJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:predictLongRunning: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/indexes: parameters: *ref_1 post: - description: '' - operationId: aiplatform.projects.locations.endpoints.predictLongRunning + description: Creates an Index. + operationId: aiplatform.projects.locations.indexes.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PredictLongRunningRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1Index' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response @@ -38182,47 +46093,31 @@ paths: $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId + name: projectsId required: true schema: type: string - in: path - name: endpointsId + name: locationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:fetchPredictOperation: - parameters: *ref_1 - post: - description: Fetch an asynchronous online prediction operation. - operationId: aiplatform.projects.locations.endpoints.fetchPredictOperation - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FetchPredictOperationRequest + get: + description: Lists Indexes in a Location. + operationId: aiplatform.projects.locations.indexes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListIndexesResponse parameters: - in: path name: projectsId @@ -38234,41 +46129,41 @@ paths: required: true schema: type: string - - in: path - name: endpointsId - required: true + - in: query + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:explain: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}: parameters: *ref_1 - post: - description: >- - Perform an online explanation. If deployed_model_id is specified, the - corresponding DeployModel must have explanation_spec populated. If - deployed_model_id is not specified, all DeployedModels must have - explanation_spec populated. - operationId: aiplatform.projects.locations.endpoints.explain - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplainRequest' + get: + description: Gets an Index. + operationId: aiplatform.projects.locations.indexes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplainResponse' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Index' parameters: - in: path name: projectsId @@ -38281,38 +46176,30 @@ paths: schema: type: string - in: path - name: endpointsId + name: indexesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:generateContent: - parameters: *ref_1 - post: - description: Generate content with multimodal inputs. - operationId: aiplatform.projects.locations.endpoints.generateContent + patch: + description: Updates an Index. + operationId: aiplatform.projects.locations.indexes.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1Index' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -38325,38 +46212,32 @@ paths: schema: type: string - in: path - name: endpointsId + name: indexesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:streamGenerateContent: - parameters: *ref_1 - post: - description: Generate content with multimodal inputs with streaming support. - operationId: aiplatform.projects.locations.endpoints.streamGenerateContent - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: >- + Deletes an Index. An Index can only be deleted when all its + DeployedIndexes had been undeployed. + operationId: aiplatform.projects.locations.indexes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -38369,20 +46250,21 @@ paths: schema: type: string - in: path - name: endpointsId + name: indexesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:countTokens: + /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:upsertDatapoints: parameters: *ref_1 post: - description: Perform a token counting. - operationId: aiplatform.projects.locations.endpoints.countTokens + description: Add/update Datapoints into an Index. + operationId: aiplatform.projects.locations.indexes.upsertDatapoints requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CountTokensRequest' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1UpsertDatapointsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38395,7 +46277,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CountTokensResponse + #/components/schemas/GoogleCloudAiplatformV1UpsertDatapointsResponse parameters: - in: path name: projectsId @@ -38408,20 +46290,21 @@ paths: schema: type: string - in: path - name: endpointsId + name: indexesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:computeTokens: + /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:removeDatapoints: parameters: *ref_1 post: - description: Return a list of tokens based on the input text. - operationId: aiplatform.projects.locations.endpoints.computeTokens + description: Remove Datapoints from an Index. + operationId: aiplatform.projects.locations.indexes.removeDatapoints requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ComputeTokensRequest' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1RemoveDatapointsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38434,7 +46317,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ComputeTokensResponse + #/components/schemas/GoogleCloudAiplatformV1RemoveDatapointsResponse parameters: - in: path name: projectsId @@ -38447,17 +46330,17 @@ paths: schema: type: string - in: path - name: endpointsId + name: indexesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.endpoints.operations.list + operationId: aiplatform.projects.locations.indexes.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38482,7 +46365,7 @@ paths: schema: type: string - in: path - name: endpointsId + name: indexesId required: true schema: type: string @@ -38499,14 +46382,14 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}: parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - operationId: aiplatform.projects.locations.endpoints.operations.get + operationId: aiplatform.projects.locations.indexes.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38531,7 +46414,7 @@ paths: schema: type: string - in: path - name: endpointsId + name: indexesId required: true schema: type: string @@ -38546,7 +46429,7 @@ paths: is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.endpoints.operations.delete + operationId: aiplatform.projects.locations.indexes.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38571,7 +46454,7 @@ paths: schema: type: string - in: path - name: endpointsId + name: indexesId required: true schema: type: string @@ -38580,7 +46463,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- @@ -38592,8 +46475,8 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.endpoints.operations.cancel + `1`, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.indexes.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38618,7 +46501,7 @@ paths: schema: type: string - in: path - name: endpointsId + name: indexesId required: true schema: type: string @@ -38627,7 +46510,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- @@ -38640,7 +46523,7 @@ paths: best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. - operationId: aiplatform.projects.locations.endpoints.operations.wait + operationId: aiplatform.projects.locations.indexes.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38665,7 +46548,7 @@ paths: schema: type: string - in: path - name: endpointsId + name: indexesId required: true schema: type: string @@ -38679,58 +46562,16 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/chat/completions: - parameters: *ref_1 - post: - description: Exposes an OpenAI-compatible endpoint for chat completions. - operationId: aiplatform.projects.locations.endpoints.chat.completions - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleApiHttpBody' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleApiHttpBody' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: endpointsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureGroups: + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints: parameters: *ref_1 post: - description: Creates a new FeatureGroup in a given project and location. - operationId: aiplatform.projects.locations.featureGroups.create + description: Creates an IndexEndpoint. + operationId: aiplatform.projects.locations.indexEndpoints.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureGroup' + $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexEndpoint' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38754,13 +46595,9 @@ paths: required: true schema: type: string - - in: query - name: featureGroupId - schema: - type: string get: - description: Lists FeatureGroups in a given project and location. - operationId: aiplatform.projects.locations.featureGroups.list + description: Lists IndexEndpoints in a Location. + operationId: aiplatform.projects.locations.indexEndpoints.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38773,7 +46610,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListFeatureGroupsResponse + #/components/schemas/GoogleCloudAiplatformV1ListIndexEndpointsResponse parameters: - in: path name: projectsId @@ -38799,14 +46636,15 @@ paths: schema: type: string - in: query - name: orderBy + name: readMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}: + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}: parameters: *ref_1 get: - description: Gets details of a single FeatureGroup. - operationId: aiplatform.projects.locations.featureGroups.get + description: Gets an IndexEndpoint. + operationId: aiplatform.projects.locations.indexEndpoints.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38818,7 +46656,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureGroup' + $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexEndpoint' parameters: - in: path name: projectsId @@ -38831,18 +46669,18 @@ paths: schema: type: string - in: path - name: featureGroupsId + name: indexEndpointsId required: true schema: type: string patch: - description: Updates the parameters of a single FeatureGroup. - operationId: aiplatform.projects.locations.featureGroups.patch + description: Updates an IndexEndpoint. + operationId: aiplatform.projects.locations.indexEndpoints.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureGroup' + $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexEndpoint' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38854,7 +46692,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexEndpoint' parameters: - in: path name: projectsId @@ -38867,7 +46705,7 @@ paths: schema: type: string - in: path - name: featureGroupsId + name: indexEndpointsId required: true schema: type: string @@ -38877,8 +46715,8 @@ paths: type: string format: google-fieldmask delete: - description: Deletes a single FeatureGroup. - operationId: aiplatform.projects.locations.featureGroups.delete + description: Deletes an IndexEndpoint. + operationId: aiplatform.projects.locations.indexEndpoints.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38903,125 +46741,22 @@ paths: schema: type: string - in: path - name: featureGroupsId + name: indexEndpointsId required: true schema: type: string - - in: query - name: force - schema: - type: boolean - /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:deployIndex: parameters: *ref_1 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.featureGroups.operations.listWait - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: featureGroupsId - required: true - schema: - type: string - - in: path - name: operationsId - required: true - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string post: description: >- - Waits until the specified long-running operation is done or reaches at - most a specified timeout, returning the latest state. If the operation - is already done, the latest state is immediately returned. If the - timeout specified is greater than the default HTTP/RPC timeout, the - HTTP/RPC timeout is used. If the server does not support this method, it - returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a - best-effort basis. It may return the latest state before the specified - timeout (including immediately), meaning even an immediate response is - no guarantee that the operation is done. - operationId: aiplatform.projects.locations.featureGroups.operations.wait - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: featureGroupsId - required: true - schema: - type: string - - in: path - name: operationsId - required: true - schema: - type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}: - parameters: *ref_1 - get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: aiplatform.projects.locations.featureGroups.operations.get + Deploys an Index into this IndexEndpoint, creating a DeployedIndex + within it. + operationId: aiplatform.projects.locations.indexEndpoints.deployIndex + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployIndexRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39046,65 +46781,22 @@ paths: schema: type: string - in: path - name: featureGroupsId - required: true - schema: - type: string - - in: path - name: operationsId - required: true - schema: - type: string - delete: - description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.featureGroups.operations.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: featureGroupsId - required: true - schema: - type: string - - in: path - name: operationsId + name: indexEndpointsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features: + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:undeployIndex: parameters: *ref_1 post: - description: Creates a new Feature in a given FeatureGroup. - operationId: aiplatform.projects.locations.featureGroups.features.create + description: >- + Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from + it, and freeing all resources it's using. + operationId: aiplatform.projects.locations.indexEndpoints.undeployIndex requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' + $ref: '#/components/schemas/GoogleCloudAiplatformV1UndeployIndexRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39129,84 +46821,20 @@ paths: schema: type: string - in: path - name: featureGroupsId - required: true - schema: - type: string - - in: query - name: featureId - schema: - type: string - get: - description: Lists Features in a given FeatureGroup. - operationId: aiplatform.projects.locations.featureGroups.features.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListFeaturesResponse - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: featureGroupsId + name: indexEndpointsId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: latestStatsCount - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features:batchCreate: + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:mutateDeployedIndex: parameters: *ref_1 post: - description: Creates a batch of Features in a given FeatureGroup. - operationId: aiplatform.projects.locations.featureGroups.features.batchCreate + description: Update an existing DeployedIndex under an IndexEndpoint. + operationId: aiplatform.projects.locations.indexEndpoints.mutateDeployedIndex requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchCreateFeaturesRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndex' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39231,15 +46859,20 @@ paths: schema: type: string - in: path - name: featureGroupsId + name: indexEndpointsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}: + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:findNeighbors: parameters: *ref_1 - get: - description: Gets details of a single Feature. - operationId: aiplatform.projects.locations.featureGroups.features.get + post: + description: Finds the nearest neighbors of each vector within the request. + operationId: aiplatform.projects.locations.indexEndpoints.findNeighbors + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FindNeighborsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39251,7 +46884,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FindNeighborsResponse parameters: - in: path name: projectsId @@ -39264,23 +46898,23 @@ paths: schema: type: string - in: path - name: featureGroupsId - required: true - schema: - type: string - - in: path - name: featuresId + name: indexEndpointsId required: true schema: type: string - patch: - description: Updates the parameters of a single Feature. - operationId: aiplatform.projects.locations.featureGroups.features.patch + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:readIndexDatapoints: + parameters: *ref_1 + post: + description: >- + Reads the datapoints/vectors of the given IDs. A maximum of 1000 + datapoints can be retrieved in a batch. + operationId: aiplatform.projects.locations.indexEndpoints.readIndexDatapoints requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReadIndexDatapointsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39292,7 +46926,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReadIndexDatapointsResponse parameters: - in: path name: projectsId @@ -39305,23 +46940,17 @@ paths: schema: type: string - in: path - name: featureGroupsId - required: true - schema: - type: string - - in: path - name: featuresId + name: indexEndpointsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: - description: Deletes a single Feature. - operationId: aiplatform.projects.locations.featureGroups.features.delete + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.indexEndpoints.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39333,7 +46962,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -39346,22 +46975,31 @@ paths: schema: type: string - in: path - name: featureGroupsId + name: indexEndpointsId required: true schema: type: string - - in: path - name: featuresId - required: true + - in: query + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}:wait: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}: parameters: *ref_1 get: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.featureGroups.features.operations.listWait + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: aiplatform.projects.locations.indexEndpoints.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39373,7 +47011,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -39386,12 +47024,7 @@ paths: schema: type: string - in: path - name: featureGroupsId - required: true - schema: - type: string - - in: path - name: featuresId + name: indexEndpointsId required: true schema: type: string @@ -39400,31 +47033,13 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - post: + delete: description: >- - Waits until the specified long-running operation is done or reaches at - most a specified timeout, returning the latest state. If the operation - is already done, the latest state is immediately returned. If the - timeout specified is greater than the default HTTP/RPC timeout, the - HTTP/RPC timeout is used. If the server does not support this method, it - returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a - best-effort basis. It may return the latest state before the specified - timeout (including immediately), meaning even an immediate response is - no guarantee that the operation is done. - operationId: aiplatform.projects.locations.featureGroups.features.operations.wait + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.indexEndpoints.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39436,7 +47051,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -39449,12 +47064,7 @@ paths: schema: type: string - in: path - name: featureGroupsId - required: true - schema: - type: string - - in: path - name: featuresId + name: indexEndpointsId required: true schema: type: string @@ -39463,19 +47073,20 @@ paths: required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:cancel: parameters: *ref_1 - get: + post: description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: aiplatform.projects.locations.featureGroups.features.operations.get + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + `1`, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.indexEndpoints.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39487,7 +47098,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -39500,12 +47111,7 @@ paths: schema: type: string - in: path - name: featureGroupsId - required: true - schema: - type: string - - in: path - name: featuresId + name: indexEndpointsId required: true schema: type: string @@ -39514,13 +47120,20 @@ paths: required: true schema: type: string - delete: + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:wait: + parameters: *ref_1 + post: description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.featureGroups.features.operations.delete + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It may return the latest state before the specified + timeout (including immediately), meaning even an immediate response is + no guarantee that the operation is done. + operationId: aiplatform.projects.locations.indexEndpoints.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39532,7 +47145,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -39545,32 +47158,32 @@ paths: schema: type: string - in: path - name: featureGroupsId + name: indexEndpointsId required: true schema: type: string - in: path - name: featuresId + name: operationsId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: timeout schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs: + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/customJobs: parameters: *ref_1 post: description: >- - Creates a TuningJob. A created TuningJob right away will be attempted to + Creates a CustomJob. A created CustomJob right away will be attempted to be run. - operationId: aiplatform.projects.locations.tuningJobs.create + operationId: aiplatform.projects.locations.customJobs.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TuningJob' + $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJob' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39582,7 +47195,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TuningJob' + $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJob' parameters: - in: path name: projectsId @@ -39595,8 +47208,8 @@ paths: schema: type: string get: - description: Lists TuningJobs in a Location. - operationId: aiplatform.projects.locations.tuningJobs.list + description: Lists CustomJobs in a Location. + operationId: aiplatform.projects.locations.customJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39609,7 +47222,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListTuningJobsResponse + #/components/schemas/GoogleCloudAiplatformV1ListCustomJobsResponse parameters: - in: path name: projectsId @@ -39634,11 +47247,16 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}: + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}: parameters: *ref_1 get: - description: Gets a TuningJob. - operationId: aiplatform.projects.locations.tuningJobs.get + description: Gets a CustomJob. + operationId: aiplatform.projects.locations.customJobs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39650,7 +47268,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TuningJob' + $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJob' parameters: - in: path name: projectsId @@ -39663,29 +47281,13 @@ paths: schema: type: string - in: path - name: tuningJobsId + name: customJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}:cancel: - parameters: *ref_1 - post: - description: >- - Cancels a TuningJob. Starts asynchronous cancellation on the TuningJob. - The server makes a best effort to cancel the job, but success is not - guaranteed. Clients can use GenAiTuningService.GetTuningJob or other - methods to check whether the cancellation succeeded or whether the job - completed despite cancellation. On successful cancellation, the - TuningJob is not deleted; instead it becomes a job with a - TuningJob.error value with a google.rpc.Status.code of 1, corresponding - to `Code.CANCELLED`, and TuningJob.state is set to `CANCELLED`. - operationId: aiplatform.projects.locations.tuningJobs.cancel - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CancelTuningJobRequest + delete: + description: Deletes a CustomJob. + operationId: aiplatform.projects.locations.customJobs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39697,7 +47299,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -39710,21 +47312,29 @@ paths: schema: type: string - in: path - name: tuningJobsId + name: customJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs:rebaseTunedModel: + /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}:cancel: parameters: *ref_1 post: - description: Rebase a TunedModel. - operationId: aiplatform.projects.locations.tuningJobs.rebaseTunedModel + description: >- + Cancels a CustomJob. Starts asynchronous cancellation on the CustomJob. + The server makes a best effort to cancel the job, but success is not + guaranteed. Clients can use JobService.GetCustomJob or other methods to + check whether the cancellation succeeded or whether the job completed + despite cancellation. On successful cancellation, the CustomJob is not + deleted; instead it becomes a job with a CustomJob.error value with a + google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and + CustomJob.state is set to `CANCELLED`. + operationId: aiplatform.projects.locations.customJobs.cancel requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1RebaseTunedModelRequest + #/components/schemas/GoogleCloudAiplatformV1CancelCustomJobRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39736,7 +47346,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -39748,13 +47358,18 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations: + - in: path + name: customJobsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.tuningJobs.operations.list + operationId: aiplatform.projects.locations.customJobs.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39779,7 +47394,7 @@ paths: schema: type: string - in: path - name: tuningJobsId + name: customJobsId required: true schema: type: string @@ -39796,14 +47411,14 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}: parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - operationId: aiplatform.projects.locations.tuningJobs.operations.get + operationId: aiplatform.projects.locations.customJobs.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39828,7 +47443,7 @@ paths: schema: type: string - in: path - name: tuningJobsId + name: customJobsId required: true schema: type: string @@ -39843,7 +47458,7 @@ paths: is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.tuningJobs.operations.delete + operationId: aiplatform.projects.locations.customJobs.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39868,7 +47483,7 @@ paths: schema: type: string - in: path - name: tuningJobsId + name: customJobsId required: true schema: type: string @@ -39877,7 +47492,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- @@ -39889,8 +47504,8 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.tuningJobs.operations.cancel + `1`, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.customJobs.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39915,7 +47530,7 @@ paths: schema: type: string - in: path - name: tuningJobsId + name: customJobsId required: true schema: type: string @@ -39924,16 +47539,20 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexes: + /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}:wait: parameters: *ref_1 post: - description: Creates an Index. - operationId: aiplatform.projects.locations.indexes.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Index' + description: >- + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It may return the latest state before the specified + timeout (including immediately), meaning even an immediate response is + no guarantee that the operation is done. + operationId: aiplatform.projects.locations.customJobs.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39957,56 +47576,31 @@ paths: required: true schema: type: string - get: - description: Lists Indexes in a Location. - operationId: aiplatform.projects.locations.indexes.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListIndexesResponse - parameters: - in: path - name: projectsId + name: customJobsId required: true schema: type: string - in: path - name: locationsId + name: operationsId required: true schema: type: string - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: readMask + name: timeout schema: type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}: + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs: parameters: *ref_1 - get: - description: Gets an Index. - operationId: aiplatform.projects.locations.indexes.get + post: + description: Creates a DataLabelingJob. + operationId: aiplatform.projects.locations.dataLabelingJobs.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DataLabelingJob' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40018,7 +47612,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Index' + $ref: '#/components/schemas/GoogleCloudAiplatformV1DataLabelingJob' parameters: - in: path name: projectsId @@ -40030,19 +47624,9 @@ paths: required: true schema: type: string - - in: path - name: indexesId - required: true - schema: - type: string - patch: - description: Updates an Index. - operationId: aiplatform.projects.locations.indexes.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Index' + get: + description: Lists DataLabelingJobs in a Location. + operationId: aiplatform.projects.locations.dataLabelingJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40054,7 +47638,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListDataLabelingJobsResponse parameters: - in: path name: projectsId @@ -40066,21 +47651,33 @@ paths: required: true schema: type: string - - in: path - name: indexesId - required: true + - in: query + name: filter schema: type: string - in: query - name: updateMask + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: readMask schema: type: string format: google-fieldmask - delete: - description: >- - Deletes an Index. An Index can only be deleted when all its - DeployedIndexes had been undeployed. - operationId: aiplatform.projects.locations.indexes.delete + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}: + parameters: *ref_1 + get: + description: Gets a DataLabelingJob. + operationId: aiplatform.projects.locations.dataLabelingJobs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40092,7 +47689,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1DataLabelingJob' parameters: - in: path name: projectsId @@ -40105,21 +47702,13 @@ paths: schema: type: string - in: path - name: indexesId + name: dataLabelingJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:upsertDatapoints: - parameters: *ref_1 - post: - description: Add/update Datapoints into an Index. - operationId: aiplatform.projects.locations.indexes.upsertDatapoints - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1UpsertDatapointsRequest + delete: + description: Deletes a DataLabelingJob. + operationId: aiplatform.projects.locations.dataLabelingJobs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40131,8 +47720,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1UpsertDatapointsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -40145,21 +47733,21 @@ paths: schema: type: string - in: path - name: indexesId + name: dataLabelingJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:removeDatapoints: + /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}:cancel: parameters: *ref_1 post: - description: Remove Datapoints from an Index. - operationId: aiplatform.projects.locations.indexes.removeDatapoints + description: Cancels a DataLabelingJob. Success of cancellation is not guaranteed. + operationId: aiplatform.projects.locations.dataLabelingJobs.cancel requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1RemoveDatapointsRequest + #/components/schemas/GoogleCloudAiplatformV1CancelDataLabelingJobRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40171,8 +47759,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1RemoveDatapointsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -40185,17 +47772,17 @@ paths: schema: type: string - in: path - name: indexesId + name: dataLabelingJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.indexes.operations.list + operationId: aiplatform.projects.locations.dataLabelingJobs.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40220,7 +47807,7 @@ paths: schema: type: string - in: path - name: indexesId + name: dataLabelingJobsId required: true schema: type: string @@ -40237,14 +47824,14 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}: parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - operationId: aiplatform.projects.locations.indexes.operations.get + operationId: aiplatform.projects.locations.dataLabelingJobs.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40269,7 +47856,7 @@ paths: schema: type: string - in: path - name: indexesId + name: dataLabelingJobsId required: true schema: type: string @@ -40284,7 +47871,7 @@ paths: is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.indexes.operations.delete + operationId: aiplatform.projects.locations.dataLabelingJobs.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40309,7 +47896,7 @@ paths: schema: type: string - in: path - name: indexesId + name: dataLabelingJobsId required: true schema: type: string @@ -40318,7 +47905,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- @@ -40330,8 +47917,8 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.indexes.operations.cancel + `1`, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.dataLabelingJobs.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40356,7 +47943,7 @@ paths: schema: type: string - in: path - name: indexesId + name: dataLabelingJobsId required: true schema: type: string @@ -40365,7 +47952,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- @@ -40378,7 +47965,7 @@ paths: best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. - operationId: aiplatform.projects.locations.indexes.operations.wait + operationId: aiplatform.projects.locations.dataLabelingJobs.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40403,7 +47990,7 @@ paths: schema: type: string - in: path - name: indexesId + name: dataLabelingJobsId required: true schema: type: string @@ -40417,16 +48004,17 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints: + /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs: parameters: *ref_1 post: - description: Creates an IndexEndpoint. - operationId: aiplatform.projects.locations.indexEndpoints.create + description: Creates a HyperparameterTuningJob + operationId: aiplatform.projects.locations.hyperparameterTuningJobs.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexEndpoint' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1HyperparameterTuningJob security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40438,7 +48026,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1HyperparameterTuningJob parameters: - in: path name: projectsId @@ -40451,8 +48040,8 @@ paths: schema: type: string get: - description: Lists IndexEndpoints in a Location. - operationId: aiplatform.projects.locations.indexEndpoints.list + description: Lists HyperparameterTuningJobs in a Location. + operationId: aiplatform.projects.locations.hyperparameterTuningJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40465,7 +48054,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListIndexEndpointsResponse + #/components/schemas/GoogleCloudAiplatformV1ListHyperparameterTuningJobsResponse parameters: - in: path name: projectsId @@ -40495,47 +48084,11 @@ paths: schema: type: string format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}: + /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}: parameters: *ref_1 get: - description: Gets an IndexEndpoint. - operationId: aiplatform.projects.locations.indexEndpoints.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexEndpoint' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: indexEndpointsId - required: true - schema: - type: string - patch: - description: Updates an IndexEndpoint. - operationId: aiplatform.projects.locations.indexEndpoints.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexEndpoint' + description: Gets a HyperparameterTuningJob + operationId: aiplatform.projects.locations.hyperparameterTuningJobs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40547,7 +48100,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexEndpoint' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1HyperparameterTuningJob parameters: - in: path name: projectsId @@ -40560,136 +48114,13 @@ paths: schema: type: string - in: path - name: indexEndpointsId + name: hyperparameterTuningJobsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask delete: - description: Deletes an IndexEndpoint. - operationId: aiplatform.projects.locations.indexEndpoints.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: indexEndpointsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:deployIndex: - parameters: *ref_1 - post: - description: >- - Deploys an Index into this IndexEndpoint, creating a DeployedIndex - within it. Only non-empty Indexes can be deployed. - operationId: aiplatform.projects.locations.indexEndpoints.deployIndex - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployIndexRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: indexEndpointsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:undeployIndex: - parameters: *ref_1 - post: - description: >- - Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from - it, and freeing all resources it's using. - operationId: aiplatform.projects.locations.indexEndpoints.undeployIndex - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1UndeployIndexRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: indexEndpointsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:mutateDeployedIndex: - parameters: *ref_1 - post: - description: Update an existing DeployedIndex under an IndexEndpoint. - operationId: aiplatform.projects.locations.indexEndpoints.mutateDeployedIndex - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndex' + description: Deletes a HyperparameterTuningJob. + operationId: aiplatform.projects.locations.hyperparameterTuningJobs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40714,62 +48145,31 @@ paths: schema: type: string - in: path - name: indexEndpointsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:findNeighbors: - parameters: *ref_1 - post: - description: Finds the nearest neighbors of each vector within the request. - operationId: aiplatform.projects.locations.indexEndpoints.findNeighbors - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FindNeighborsRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FindNeighborsResponse - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: indexEndpointsId + name: hyperparameterTuningJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:readIndexDatapoints: + /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}:cancel: parameters: *ref_1 post: description: >- - Reads the datapoints/vectors of the given IDs. A maximum of 1000 - datapoints can be retrieved in a batch. - operationId: aiplatform.projects.locations.indexEndpoints.readIndexDatapoints + Cancels a HyperparameterTuningJob. Starts asynchronous cancellation on + the HyperparameterTuningJob. The server makes a best effort to cancel + the job, but success is not guaranteed. Clients can use + JobService.GetHyperparameterTuningJob or other methods to check whether + the cancellation succeeded or whether the job completed despite + cancellation. On successful cancellation, the HyperparameterTuningJob is + not deleted; instead it becomes a job with a + HyperparameterTuningJob.error value with a google.rpc.Status.code of 1, + corresponding to `Code.CANCELLED`, and HyperparameterTuningJob.state is + set to `CANCELLED`. + operationId: aiplatform.projects.locations.hyperparameterTuningJobs.cancel requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadIndexDatapointsRequest + #/components/schemas/GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40781,8 +48181,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadIndexDatapointsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -40795,17 +48194,17 @@ paths: schema: type: string - in: path - name: indexEndpointsId + name: hyperparameterTuningJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.indexEndpoints.operations.list + operationId: aiplatform.projects.locations.hyperparameterTuningJobs.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40830,7 +48229,7 @@ paths: schema: type: string - in: path - name: indexEndpointsId + name: hyperparameterTuningJobsId required: true schema: type: string @@ -40847,14 +48246,14 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}: parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - operationId: aiplatform.projects.locations.indexEndpoints.operations.get + operationId: aiplatform.projects.locations.hyperparameterTuningJobs.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40879,7 +48278,7 @@ paths: schema: type: string - in: path - name: indexEndpointsId + name: hyperparameterTuningJobsId required: true schema: type: string @@ -40894,7 +48293,7 @@ paths: is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.indexEndpoints.operations.delete + operationId: aiplatform.projects.locations.hyperparameterTuningJobs.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40919,7 +48318,7 @@ paths: schema: type: string - in: path - name: indexEndpointsId + name: hyperparameterTuningJobsId required: true schema: type: string @@ -40928,7 +48327,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- @@ -40940,8 +48339,8 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.indexEndpoints.operations.cancel + `1`, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.hyperparameterTuningJobs.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40966,7 +48365,7 @@ paths: schema: type: string - in: path - name: indexEndpointsId + name: hyperparameterTuningJobsId required: true schema: type: string @@ -40975,7 +48374,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- @@ -40988,7 +48387,7 @@ paths: best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. - operationId: aiplatform.projects.locations.indexEndpoints.operations.wait + operationId: aiplatform.projects.locations.hyperparameterTuningJobs.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41013,7 +48412,7 @@ paths: schema: type: string - in: path - name: indexEndpointsId + name: hyperparameterTuningJobsId required: true schema: type: string @@ -41027,18 +48426,16 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/customJobs: + /v1/projects/{projectsId}/locations/{locationsId}/nasJobs: parameters: *ref_1 post: - description: >- - Creates a CustomJob. A created CustomJob right away will be attempted to - be run. - operationId: aiplatform.projects.locations.customJobs.create + description: Creates a NasJob + operationId: aiplatform.projects.locations.nasJobs.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJob' + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJob' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41050,7 +48447,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJob' + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJob' parameters: - in: path name: projectsId @@ -41063,8 +48460,8 @@ paths: schema: type: string get: - description: Lists CustomJobs in a Location. - operationId: aiplatform.projects.locations.customJobs.list + description: Lists NasJobs in a Location. + operationId: aiplatform.projects.locations.nasJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41077,7 +48474,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListCustomJobsResponse + #/components/schemas/GoogleCloudAiplatformV1ListNasJobsResponse parameters: - in: path name: projectsId @@ -41107,23 +48504,27 @@ paths: schema: type: string format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}: + /v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}: parameters: *ref_1 get: - description: Gets a CustomJob. - operationId: aiplatform.projects.locations.customJobs.get + description: Gets a NasJob + operationId: aiplatform.projects.locations.nasJobs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJob' + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJob' parameters: - in: path name: projectsId @@ -41136,13 +48537,13 @@ paths: schema: type: string - in: path - name: customJobsId + name: nasJobsId required: true schema: type: string delete: - description: Deletes a CustomJob. - operationId: aiplatform.projects.locations.customJobs.delete + description: Deletes a NasJob. + operationId: aiplatform.projects.locations.nasJobs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41167,29 +48568,28 @@ paths: schema: type: string - in: path - name: customJobsId + name: nasJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}:cancel: parameters: *ref_1 post: description: >- - Cancels a CustomJob. Starts asynchronous cancellation on the CustomJob. - The server makes a best effort to cancel the job, but success is not - guaranteed. Clients can use JobService.GetCustomJob or other methods to + Cancels a NasJob. Starts asynchronous cancellation on the NasJob. The + server makes a best effort to cancel the job, but success is not + guaranteed. Clients can use JobService.GetNasJob or other methods to check whether the cancellation succeeded or whether the job completed - despite cancellation. On successful cancellation, the CustomJob is not - deleted; instead it becomes a job with a CustomJob.error value with a + despite cancellation. On successful cancellation, the NasJob is not + deleted; instead it becomes a job with a NasJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and - CustomJob.state is set to `CANCELLED`. - operationId: aiplatform.projects.locations.customJobs.cancel + NasJob.state is set to `CANCELLED`. + operationId: aiplatform.projects.locations.nasJobs.cancel requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CancelCustomJobRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1CancelNasJobRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41214,17 +48614,103 @@ paths: schema: type: string - in: path - name: customJobsId + name: nasJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}/nasTrialDetails/{nasTrialDetailsId}: + parameters: *ref_1 + get: + description: Gets a NasTrialDetail. + operationId: aiplatform.projects.locations.nasJobs.nasTrialDetails.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasTrialDetail' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: nasJobsId + required: true + schema: + type: string + - in: path + name: nasTrialDetailsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}/nasTrialDetails: parameters: *ref_1 get: + description: List top NasTrialDetails of a NasJob. + operationId: aiplatform.projects.locations.nasJobs.nasTrialDetails.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListNasTrialDetailsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: nasJobsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs: + parameters: *ref_1 + post: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.customJobs.operations.list + Creates a BatchPredictionJob. A BatchPredictionJob once created will + right away be attempted to start. + operationId: aiplatform.projects.locations.batchPredictionJobs.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1BatchPredictionJob' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41236,7 +48722,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleCloudAiplatformV1BatchPredictionJob' parameters: - in: path name: projectsId @@ -41248,8 +48734,30 @@ paths: required: true schema: type: string + get: + description: Lists BatchPredictionJobs in a Location. + operationId: aiplatform.projects.locations.batchPredictionJobs.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListBatchPredictionJobsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string - in: path - name: customJobsId + name: locationsId required: true schema: type: string @@ -41266,14 +48774,16 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}: + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}: parameters: *ref_1 - get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: aiplatform.projects.locations.customJobs.operations.get + get: + description: Gets a BatchPredictionJob + operationId: aiplatform.projects.locations.batchPredictionJobs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41285,7 +48795,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1BatchPredictionJob' parameters: - in: path name: projectsId @@ -41298,22 +48808,15 @@ paths: schema: type: string - in: path - name: customJobsId - required: true - schema: - type: string - - in: path - name: operationsId + name: batchPredictionJobsId required: true schema: type: string delete: description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.customJobs.operations.delete + Deletes a BatchPredictionJob. Can only be called on jobs that already + finished. + operationId: aiplatform.projects.locations.batchPredictionJobs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41325,7 +48828,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -41338,29 +48841,29 @@ paths: schema: type: string - in: path - name: customJobsId - required: true - schema: - type: string - - in: path - name: operationsId + name: batchPredictionJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}:cancel: parameters: *ref_1 post: description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.customJobs.operations.cancel + Cancels a BatchPredictionJob. Starts asynchronous cancellation on the + BatchPredictionJob. The server makes the best effort to cancel the job, + but success is not guaranteed. Clients can use + JobService.GetBatchPredictionJob or other methods to check whether the + cancellation succeeded or whether the job completed despite + cancellation. On a successful cancellation, the BatchPredictionJob is + not deleted;instead its BatchPredictionJob.state is set to `CANCELLED`. + Any files already outputted by the job are not deleted. + operationId: aiplatform.projects.locations.batchPredictionJobs.cancel + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1CancelBatchPredictionJobRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41385,29 +48888,23 @@ paths: schema: type: string - in: path - name: customJobsId - required: true - schema: - type: string - - in: path - name: operationsId + name: batchPredictionJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs: parameters: *ref_1 post: description: >- - Waits until the specified long-running operation is done or reaches at - most a specified timeout, returning the latest state. If the operation - is already done, the latest state is immediately returned. If the - timeout specified is greater than the default HTTP/RPC timeout, the - HTTP/RPC timeout is used. If the server does not support this method, it - returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a - best-effort basis. It may return the latest state before the specified - timeout (including immediately), meaning even an immediate response is - no guarantee that the operation is done. - operationId: aiplatform.projects.locations.customJobs.operations.wait + Creates a ModelDeploymentMonitoringJob. It will run periodically on a + configured interval. + operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringJob security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41419,7 +48916,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringJob parameters: - in: path name: projectsId @@ -41431,31 +48929,65 @@ paths: required: true schema: type: string + get: + description: Lists ModelDeploymentMonitoringJobs in a Location. + operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListModelDeploymentMonitoringJobsResponse + parameters: - in: path - name: customJobsId + name: projectsId required: true schema: type: string - in: path - name: operationsId + name: locationsId required: true schema: type: string - in: query - name: timeout + name: filter schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:searchModelDeploymentMonitoringStatsAnomalies: parameters: *ref_1 post: - description: Creates a DataLabelingJob. - operationId: aiplatform.projects.locations.dataLabelingJobs.create + description: >- + Searches Model Monitoring Statistics generated within a given time + window. + operationId: >- + aiplatform.projects.locations.modelDeploymentMonitoringJobs.searchModelDeploymentMonitoringStatsAnomalies requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DataLabelingJob' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41467,7 +48999,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DataLabelingJob' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesResponse parameters: - in: path name: projectsId @@ -41479,9 +49012,16 @@ paths: required: true schema: type: string + - in: path + name: modelDeploymentMonitoringJobsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}: + parameters: *ref_1 get: - description: Lists DataLabelingJobs in a Location. - operationId: aiplatform.projects.locations.dataLabelingJobs.list + description: Gets a ModelDeploymentMonitoringJob. + operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41494,7 +49034,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListDataLabelingJobsResponse + #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringJob parameters: - in: path name: projectsId @@ -41506,33 +49046,56 @@ paths: required: true schema: type: string - - in: query - name: filter + - in: path + name: modelDeploymentMonitoringJobsId + required: true schema: type: string - - in: query - name: pageSize + patch: + description: Updates a ModelDeploymentMonitoringJob. + operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringJob + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true schema: - type: integer - format: int32 - - in: query - name: pageToken + type: string + - in: path + name: locationsId + required: true schema: type: string - - in: query - name: readMask + - in: path + name: modelDeploymentMonitoringJobsId + required: true schema: type: string - format: google-fieldmask - in: query - name: orderBy + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}: - parameters: *ref_1 - get: - description: Gets a DataLabelingJob. - operationId: aiplatform.projects.locations.dataLabelingJobs.get + format: google-fieldmask + delete: + description: Deletes a ModelDeploymentMonitoringJob. + operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41544,7 +49107,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DataLabelingJob' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -41557,13 +49120,24 @@ paths: schema: type: string - in: path - name: dataLabelingJobsId + name: modelDeploymentMonitoringJobsId required: true schema: type: string - delete: - description: Deletes a DataLabelingJob. - operationId: aiplatform.projects.locations.dataLabelingJobs.delete + /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:pause: + parameters: *ref_1 + post: + description: >- + Pauses a ModelDeploymentMonitoringJob. If the job is running, the server + makes a best effort to cancel the job. Will mark + ModelDeploymentMonitoringJob.state to 'PAUSED'. + operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.pause + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PauseModelDeploymentMonitoringJobRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41575,7 +49149,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -41588,21 +49162,24 @@ paths: schema: type: string - in: path - name: dataLabelingJobsId + name: modelDeploymentMonitoringJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:resume: parameters: *ref_1 post: - description: Cancels a DataLabelingJob. Success of cancellation is not guaranteed. - operationId: aiplatform.projects.locations.dataLabelingJobs.cancel + description: >- + Resumes a paused ModelDeploymentMonitoringJob. It will start to run from + next scheduled time. A deleted ModelDeploymentMonitoringJob can't be + resumed. + operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.resume requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CancelDataLabelingJobRequest + #/components/schemas/GoogleCloudAiplatformV1ResumeModelDeploymentMonitoringJobRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41627,17 +49204,18 @@ paths: schema: type: string - in: path - name: dataLabelingJobsId + name: modelDeploymentMonitoringJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.dataLabelingJobs.operations.list + operationId: >- + aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41662,7 +49240,7 @@ paths: schema: type: string - in: path - name: dataLabelingJobsId + name: modelDeploymentMonitoringJobsId required: true schema: type: string @@ -41679,14 +49257,15 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}: parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - operationId: aiplatform.projects.locations.dataLabelingJobs.operations.get + operationId: >- + aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41711,7 +49290,7 @@ paths: schema: type: string - in: path - name: dataLabelingJobsId + name: modelDeploymentMonitoringJobsId required: true schema: type: string @@ -41726,7 +49305,8 @@ paths: is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.dataLabelingJobs.operations.delete + operationId: >- + aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41751,7 +49331,7 @@ paths: schema: type: string - in: path - name: dataLabelingJobsId + name: modelDeploymentMonitoringJobsId required: true schema: type: string @@ -41760,7 +49340,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- @@ -41772,8 +49352,9 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.dataLabelingJobs.operations.cancel + `1`, corresponding to `Code.CANCELLED`. + operationId: >- + aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41798,7 +49379,7 @@ paths: schema: type: string - in: path - name: dataLabelingJobsId + name: modelDeploymentMonitoringJobsId required: true schema: type: string @@ -41807,7 +49388,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- @@ -41820,7 +49401,8 @@ paths: best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. - operationId: aiplatform.projects.locations.dataLabelingJobs.operations.wait + operationId: >- + aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41845,7 +49427,7 @@ paths: schema: type: string - in: path - name: dataLabelingJobsId + name: modelDeploymentMonitoringJobsId required: true schema: type: string @@ -41859,30 +49441,32 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs: + /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:predict: parameters: *ref_1 post: - description: Creates a HyperparameterTuningJob - operationId: aiplatform.projects.locations.hyperparameterTuningJobs.create + description: Perform an online prediction. + operationId: aiplatform.projects.locations.publishers.models.predict requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1HyperparameterTuningJob + $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1HyperparameterTuningJob + $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictResponse' parameters: - in: path name: projectsId @@ -41894,69 +49478,47 @@ paths: required: true schema: type: string - get: - description: Lists HyperparameterTuningJobs in a Location. - operationId: aiplatform.projects.locations.hyperparameterTuningJobs.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListHyperparameterTuningJobsResponse - parameters: - in: path - name: projectsId + name: publishersId required: true schema: type: string - in: path - name: locationsId + name: modelsId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}: + /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:rawPredict: parameters: *ref_1 - get: - description: Gets a HyperparameterTuningJob - operationId: aiplatform.projects.locations.hyperparameterTuningJobs.get + post: + description: >- + Perform an online prediction with an arbitrary HTTP payload. The + response includes the following HTTP headers: * + `X-Vertex-AI-Endpoint-Id`: ID of the Endpoint that served this + prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's + DeployedModel that served this prediction. + operationId: aiplatform.projects.locations.publishers.models.rawPredict + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1RawPredictRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1HyperparameterTuningJob + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: projectsId @@ -41969,109 +49531,42 @@ paths: schema: type: string - in: path - name: hyperparameterTuningJobsId - required: true - schema: - type: string - delete: - description: Deletes a HyperparameterTuningJob. - operationId: aiplatform.projects.locations.hyperparameterTuningJobs.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId + name: publishersId required: true schema: type: string - in: path - name: hyperparameterTuningJobsId + name: modelsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:streamRawPredict: parameters: *ref_1 post: - description: >- - Cancels a HyperparameterTuningJob. Starts asynchronous cancellation on - the HyperparameterTuningJob. The server makes a best effort to cancel - the job, but success is not guaranteed. Clients can use - JobService.GetHyperparameterTuningJob or other methods to check whether - the cancellation succeeded or whether the job completed despite - cancellation. On successful cancellation, the HyperparameterTuningJob is - not deleted; instead it becomes a job with a - HyperparameterTuningJob.error value with a google.rpc.Status.code of 1, - corresponding to `Code.CANCELLED`, and HyperparameterTuningJob.state is - set to `CANCELLED`. - operationId: aiplatform.projects.locations.hyperparameterTuningJobs.cancel + description: Perform a streaming online prediction with an arbitrary HTTP payload. + operationId: aiplatform.projects.locations.publishers.models.streamRawPredict requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest + #/components/schemas/GoogleCloudAiplatformV1StreamRawPredictRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: hyperparameterTuningJobsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations: - parameters: *ref_1 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.hyperparameterTuningJobs.operations.list - security: - Oauth2: - - https://www.googleapis.com/auth/cloud-platform + - https://www.googleapis.com/auth/cloud-platform.read-only Oauth2c: - - https://www.googleapis.com/auth/cloud-platform + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: projectsId @@ -42084,43 +49579,45 @@ paths: schema: type: string - in: path - name: hyperparameterTuningJobsId + name: publishersId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: modelsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:serverStreamingPredict: parameters: *ref_1 - get: + post: description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: aiplatform.projects.locations.hyperparameterTuningJobs.operations.get + Perform a server-side streaming online prediction request for Vertex LLM + streaming. + operationId: aiplatform.projects.locations.publishers.models.serverStreamingPredict + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StreamingPredictRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StreamingPredictResponse parameters: - in: path name: projectsId @@ -42133,34 +49630,42 @@ paths: schema: type: string - in: path - name: hyperparameterTuningJobsId + name: publishersId required: true schema: type: string - in: path - name: operationsId + name: modelsId required: true schema: type: string - delete: - description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.hyperparameterTuningJobs.operations.delete + /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:predictLongRunning: + parameters: *ref_1 + post: + description: '' + operationId: aiplatform.projects.locations.publishers.models.predictLongRunning + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PredictLongRunningRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -42173,41 +49678,42 @@ paths: schema: type: string - in: path - name: hyperparameterTuningJobsId + name: publishersId required: true schema: type: string - in: path - name: operationsId + name: modelsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:fetchPredictOperation: parameters: *ref_1 post: - description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.hyperparameterTuningJobs.operations.cancel + description: Fetch an asynchronous online prediction operation. + operationId: aiplatform.projects.locations.publishers.models.fetchPredictOperation + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FetchPredictOperationRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -42220,41 +49726,43 @@ paths: schema: type: string - in: path - name: hyperparameterTuningJobsId + name: publishersId required: true schema: type: string - in: path - name: operationsId + name: modelsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:generateContent: parameters: *ref_1 post: - description: >- - Waits until the specified long-running operation is done or reaches at - most a specified timeout, returning the latest state. If the operation - is already done, the latest state is immediately returned. If the - timeout specified is greater than the default HTTP/RPC timeout, the - HTTP/RPC timeout is used. If the server does not support this method, it - returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a - best-effort basis. It may return the latest state before the specified - timeout (including immediately), meaning even an immediate response is - no guarantee that the operation is done. - operationId: aiplatform.projects.locations.hyperparameterTuningJobs.operations.wait + description: Generate content with multimodal inputs. + operationId: aiplatform.projects.locations.publishers.models.generateContent + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse parameters: - in: path name: projectsId @@ -42267,42 +49775,43 @@ paths: schema: type: string - in: path - name: hyperparameterTuningJobsId + name: publishersId required: true schema: type: string - in: path - name: operationsId + name: modelsId required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/nasJobs: + /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:streamGenerateContent: parameters: *ref_1 post: - description: Creates a NasJob - operationId: aiplatform.projects.locations.nasJobs.create + description: Generate content with multimodal inputs with streaming support. + operationId: aiplatform.projects.locations.publishers.models.streamGenerateContent requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJob' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJob' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse parameters: - in: path name: projectsId @@ -42314,72 +49823,39 @@ paths: required: true schema: type: string - get: - description: Lists NasJobs in a Location. - operationId: aiplatform.projects.locations.nasJobs.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListNasJobsResponse - parameters: - in: path - name: projectsId + name: publishersId required: true schema: type: string - in: path - name: locationsId + name: modelsId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}: + /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:countTokens: parameters: *ref_1 - get: - description: Gets a NasJob - operationId: aiplatform.projects.locations.nasJobs.get + post: + description: Perform a token counting. + operationId: aiplatform.projects.locations.publishers.models.countTokens + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CountTokensRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJob' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1CountTokensResponse parameters: - in: path name: projectsId @@ -42392,13 +49868,25 @@ paths: schema: type: string - in: path - name: nasJobsId + name: publishersId required: true schema: type: string - delete: - description: Deletes a NasJob. - operationId: aiplatform.projects.locations.nasJobs.delete + - in: path + name: modelsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:computeTokens: + parameters: *ref_1 + post: + description: Return a list of tokens based on the input text. + operationId: aiplatform.projects.locations.publishers.models.computeTokens + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ComputeTokensRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42410,7 +49898,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ComputeTokensResponse parameters: - in: path name: projectsId @@ -42423,28 +49912,25 @@ paths: schema: type: string - in: path - name: nasJobsId + name: publishersId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}:cancel: + - in: path + name: modelsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores: parameters: *ref_1 post: - description: >- - Cancels a NasJob. Starts asynchronous cancellation on the NasJob. The - server makes a best effort to cancel the job, but success is not - guaranteed. Clients can use JobService.GetNasJob or other methods to - check whether the cancellation succeeded or whether the job completed - despite cancellation. On successful cancellation, the NasJob is not - deleted; instead it becomes a job with a NasJob.error value with a - google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and - NasJob.state is set to `CANCELLED`. - operationId: aiplatform.projects.locations.nasJobs.cancel + description: Initializes a MetadataStore, including allocation of resources. + operationId: aiplatform.projects.locations.metadataStores.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CancelNasJobRequest' + $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataStore' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42456,7 +49942,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -42468,16 +49954,13 @@ paths: required: true schema: type: string - - in: path - name: nasJobsId - required: true + - in: query + name: metadataStoreId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}/nasTrialDetails/{nasTrialDetailsId}: - parameters: *ref_1 get: - description: Gets a NasTrialDetail. - operationId: aiplatform.projects.locations.nasJobs.nasTrialDetails.get + description: Lists MetadataStores for a Location. + operationId: aiplatform.projects.locations.metadataStores.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42489,7 +49972,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasTrialDetail' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListMetadataStoresResponse parameters: - in: path name: projectsId @@ -42501,21 +49985,20 @@ paths: required: true schema: type: string - - in: path - name: nasJobsId - required: true + - in: query + name: pageSize schema: - type: string - - in: path - name: nasTrialDetailsId - required: true + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}/nasTrialDetails: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}: parameters: *ref_1 get: - description: List top NasTrialDetails of a NasJob. - operationId: aiplatform.projects.locations.nasJobs.nasTrialDetails.list + description: Retrieves a specific MetadataStore. + operationId: aiplatform.projects.locations.metadataStores.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42527,8 +50010,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListNasTrialDetailsResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataStore' parameters: - in: path name: projectsId @@ -42541,31 +50023,15 @@ paths: schema: type: string - in: path - name: nasJobsId + name: metadataStoresId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs: - parameters: *ref_1 - post: + delete: description: >- - Creates a BatchPredictionJob. A BatchPredictionJob once created will - right away be attempted to start. - operationId: aiplatform.projects.locations.batchPredictionJobs.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BatchPredictionJob' + Deletes a single MetadataStore and all its child resources (Artifacts, + Executions, and Contexts). + operationId: aiplatform.projects.locations.metadataStores.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42577,7 +50043,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BatchPredictionJob' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -42589,9 +50055,22 @@ paths: required: true schema: type: string + - in: path + name: metadataStoresId + required: true + schema: + type: string + - in: query + name: force + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations: + parameters: *ref_1 get: - description: Lists BatchPredictionJobs in a Location. - operationId: aiplatform.projects.locations.batchPredictionJobs.list + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.metadataStores.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42603,8 +50082,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListBatchPredictionJobsResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -42616,6 +50094,11 @@ paths: required: true schema: type: string + - in: path + name: metadataStoresId + required: true + schema: + type: string - in: query name: filter schema: @@ -42629,16 +50112,14 @@ paths: name: pageToken schema: type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}: parameters: *ref_1 get: - description: Gets a BatchPredictionJob - operationId: aiplatform.projects.locations.batchPredictionJobs.get + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: aiplatform.projects.locations.metadataStores.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42650,7 +50131,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BatchPredictionJob' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -42663,15 +50144,22 @@ paths: schema: type: string - in: path - name: batchPredictionJobsId + name: metadataStoresId + required: true + schema: + type: string + - in: path + name: operationsId required: true schema: type: string delete: description: >- - Deletes a BatchPredictionJob. Can only be called on jobs that already - finished. - operationId: aiplatform.projects.locations.batchPredictionJobs.delete + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.metadataStores.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42683,7 +50171,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -42696,29 +50184,29 @@ paths: schema: type: string - in: path - name: batchPredictionJobsId + name: metadataStoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}:cancel: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- - Cancels a BatchPredictionJob. Starts asynchronous cancellation on the - BatchPredictionJob. The server makes the best effort to cancel the job, - but success is not guaranteed. Clients can use - JobService.GetBatchPredictionJob or other methods to check whether the - cancellation succeeded or whether the job completed despite - cancellation. On a successful cancellation, the BatchPredictionJob is - not deleted;instead its BatchPredictionJob.state is set to `CANCELLED`. - Any files already outputted by the job are not deleted. - operationId: aiplatform.projects.locations.batchPredictionJobs.cancel - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CancelBatchPredictionJobRequest + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + `1`, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.metadataStores.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42743,23 +50231,29 @@ paths: schema: type: string - in: path - name: batchPredictionJobsId + name: metadataStoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- - Creates a ModelDeploymentMonitoringJob. It will run periodically on a - configured interval. - operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringJob + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It may return the latest state before the specified + timeout (including immediately), meaning even an immediate response is + no guarantee that the operation is done. + operationId: aiplatform.projects.locations.metadataStores.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42771,8 +50265,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringJob + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -42784,9 +50277,31 @@ paths: required: true schema: type: string - get: - description: Lists ModelDeploymentMonitoringJobs in a Location. - operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.list + - in: path + name: metadataStoresId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + - in: query + name: timeout + schema: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts: + parameters: *ref_1 + post: + description: Creates an Artifact associated with a MetadataStore. + operationId: aiplatform.projects.locations.metadataStores.artifacts.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42798,8 +50313,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListModelDeploymentMonitoringJobsResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' parameters: - in: path name: projectsId @@ -42811,38 +50325,18 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: metadataStoresId + required: true schema: type: string - in: query - name: readMask + name: artifactId schema: type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:searchModelDeploymentMonitoringStatsAnomalies: - parameters: *ref_1 - post: - description: >- - Searches Model Monitoring Statistics generated within a given time - window. - operationId: >- - aiplatform.projects.locations.modelDeploymentMonitoringJobs.searchModelDeploymentMonitoringStatsAnomalies - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequest + get: + description: Lists Artifacts in the MetadataStore. + operationId: aiplatform.projects.locations.metadataStores.artifacts.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42855,7 +50349,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesResponse + #/components/schemas/GoogleCloudAiplatformV1ListArtifactsResponse parameters: - in: path name: projectsId @@ -42868,15 +50362,32 @@ paths: schema: type: string - in: path - name: modelDeploymentMonitoringJobsId + name: metadataStoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}: parameters: *ref_1 get: - description: Gets a ModelDeploymentMonitoringJob. - operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.get + description: Retrieves a specific Artifact. + operationId: aiplatform.projects.locations.metadataStores.artifacts.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42888,8 +50399,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringJob + $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' parameters: - in: path name: projectsId @@ -42902,19 +50412,23 @@ paths: schema: type: string - in: path - name: modelDeploymentMonitoringJobsId + name: metadataStoresId + required: true + schema: + type: string + - in: path + name: artifactsId required: true schema: type: string patch: - description: Updates a ModelDeploymentMonitoringJob. - operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.patch + description: Updates a stored Artifact. + operationId: aiplatform.projects.locations.metadataStores.artifacts.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringJob + $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42926,7 +50440,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' parameters: - in: path name: projectsId @@ -42939,7 +50453,12 @@ paths: schema: type: string - in: path - name: modelDeploymentMonitoringJobsId + name: metadataStoresId + required: true + schema: + type: string + - in: path + name: artifactsId required: true schema: type: string @@ -42948,9 +50467,13 @@ paths: schema: type: string format: google-fieldmask + - in: query + name: allowMissing + schema: + type: boolean delete: - description: Deletes a ModelDeploymentMonitoringJob. - operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.delete + description: Deletes an Artifact. + operationId: aiplatform.projects.locations.metadataStores.artifacts.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42970,29 +50493,35 @@ paths: schema: type: string - in: path - name: locationsId + name: locationsId + required: true + schema: + type: string + - in: path + name: metadataStoresId required: true schema: type: string - in: path - name: modelDeploymentMonitoringJobsId + name: artifactsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:pause: + - in: query + name: etag + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts:purge: parameters: *ref_1 post: - description: >- - Pauses a ModelDeploymentMonitoringJob. If the job is running, the server - makes a best effort to cancel the job. Will mark - ModelDeploymentMonitoringJob.state to 'PAUSED'. - operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.pause + description: Purges Artifacts. + operationId: aiplatform.projects.locations.metadataStores.artifacts.purge requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PauseModelDeploymentMonitoringJobRequest + #/components/schemas/GoogleCloudAiplatformV1PurgeArtifactsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43004,7 +50533,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -43017,24 +50546,18 @@ paths: schema: type: string - in: path - name: modelDeploymentMonitoringJobsId + name: metadataStoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:resume: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}:queryArtifactLineageSubgraph: parameters: *ref_1 - post: + get: description: >- - Resumes a paused ModelDeploymentMonitoringJob. It will start to run from - next scheduled time. A deleted ModelDeploymentMonitoringJob can't be - resumed. - operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.resume - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ResumeModelDeploymentMonitoringJobRequest + Retrieves lineage of an Artifact represented through Artifacts and + Executions connected by Event edges and returned as a LineageSubgraph. + operationId: >- + aiplatform.projects.locations.metadataStores.artifacts.queryArtifactLineageSubgraph security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43046,7 +50569,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudAiplatformV1LineageSubgraph' parameters: - in: path name: projectsId @@ -43059,18 +50582,31 @@ paths: schema: type: string - in: path - name: modelDeploymentMonitoringJobsId + name: metadataStoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations: + - in: path + name: artifactsId + required: true + schema: + type: string + - in: query + name: maxHops + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: >- - aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.list + operationId: aiplatform.projects.locations.metadataStores.artifacts.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43095,7 +50631,12 @@ paths: schema: type: string - in: path - name: modelDeploymentMonitoringJobsId + name: metadataStoresId + required: true + schema: + type: string + - in: path + name: artifactsId required: true schema: type: string @@ -43112,15 +50653,14 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}: parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - operationId: >- - aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.get + operationId: aiplatform.projects.locations.metadataStores.artifacts.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43145,7 +50685,12 @@ paths: schema: type: string - in: path - name: modelDeploymentMonitoringJobsId + name: metadataStoresId + required: true + schema: + type: string + - in: path + name: artifactsId required: true schema: type: string @@ -43160,8 +50705,7 @@ paths: is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. - operationId: >- - aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.delete + operationId: aiplatform.projects.locations.metadataStores.artifacts.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43186,7 +50730,12 @@ paths: schema: type: string - in: path - name: modelDeploymentMonitoringJobsId + name: metadataStoresId + required: true + schema: + type: string + - in: path + name: artifactsId required: true schema: type: string @@ -43195,7 +50744,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- @@ -43207,9 +50756,8 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: >- - aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.cancel + `1`, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.metadataStores.artifacts.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43234,7 +50782,12 @@ paths: schema: type: string - in: path - name: modelDeploymentMonitoringJobsId + name: metadataStoresId + required: true + schema: + type: string + - in: path + name: artifactsId required: true schema: type: string @@ -43243,7 +50796,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- @@ -43256,8 +50809,7 @@ paths: best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. - operationId: >- - aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.wait + operationId: aiplatform.projects.locations.metadataStores.artifacts.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43282,7 +50834,12 @@ paths: schema: type: string - in: path - name: modelDeploymentMonitoringJobsId + name: metadataStoresId + required: true + schema: + type: string + - in: path + name: artifactsId required: true schema: type: string @@ -43296,32 +50853,28 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:predict: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts: parameters: *ref_1 post: - description: Perform an online prediction. - operationId: aiplatform.projects.locations.publishers.models.predict + description: Creates a Context associated with a MetadataStore. + operationId: aiplatform.projects.locations.metadataStores.contexts.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictRequest' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictResponse' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' parameters: - in: path name: projectsId @@ -43334,46 +50887,30 @@ paths: schema: type: string - in: path - name: publishersId + name: metadataStoresId required: true schema: type: string - - in: path - name: modelsId - required: true + - in: query + name: contextId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:rawPredict: - parameters: *ref_1 - post: - description: >- - Perform an online prediction with an arbitrary HTTP payload. The - response includes the following HTTP headers: * - `X-Vertex-AI-Endpoint-Id`: ID of the Endpoint that served this - prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's - DeployedModel that served this prediction. - operationId: aiplatform.projects.locations.publishers.models.rawPredict - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1RawPredictRequest' + get: + description: Lists Contexts on the MetadataStore. + operationId: aiplatform.projects.locations.metadataStores.contexts.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListContextsResponse parameters: - in: path name: projectsId @@ -43386,93 +50923,44 @@ paths: schema: type: string - in: path - name: publishersId - required: true - schema: - type: string - - in: path - name: modelsId + name: metadataStoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:streamRawPredict: - parameters: *ref_1 - post: - description: Perform a streaming online prediction with an arbitrary HTTP payload. - operationId: aiplatform.projects.locations.publishers.models.streamRawPredict - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StreamRawPredictRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleApiHttpBody' - parameters: - - in: path - name: projectsId - required: true + - in: query + name: pageSize schema: - type: string - - in: path - name: locationsId - required: true + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - - in: path - name: publishersId - required: true + - in: query + name: filter schema: type: string - - in: path - name: modelsId - required: true + - in: query + name: orderBy schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:serverStreamingPredict: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}: parameters: *ref_1 - post: - description: >- - Perform a server-side streaming online prediction request for Vertex LLM - streaming. - operationId: aiplatform.projects.locations.publishers.models.serverStreamingPredict - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StreamingPredictRequest + get: + description: Retrieves a specific Context. + operationId: aiplatform.projects.locations.metadataStores.contexts.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StreamingPredictResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' parameters: - in: path name: projectsId @@ -43485,42 +50973,35 @@ paths: schema: type: string - in: path - name: publishersId + name: metadataStoresId required: true schema: type: string - in: path - name: modelsId + name: contextsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:predictLongRunning: - parameters: *ref_1 - post: - description: '' - operationId: aiplatform.projects.locations.publishers.models.predictLongRunning + patch: + description: Updates a stored Context. + operationId: aiplatform.projects.locations.metadataStores.contexts.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PredictLongRunningRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' parameters: - in: path name: projectsId @@ -43533,35 +51014,32 @@ paths: schema: type: string - in: path - name: publishersId + name: metadataStoresId required: true schema: type: string - in: path - name: modelsId + name: contextsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:fetchPredictOperation: - parameters: *ref_1 - post: - description: Fetch an asynchronous online prediction operation. - operationId: aiplatform.projects.locations.publishers.models.fetchPredictOperation - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FetchPredictOperationRequest + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: allowMissing + schema: + type: boolean + delete: + description: Deletes a stored Context. + operationId: aiplatform.projects.locations.metadataStores.contexts.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response @@ -43581,92 +51059,45 @@ paths: schema: type: string - in: path - name: publishersId - required: true - schema: - type: string - - in: path - name: modelsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:generateContent: - parameters: *ref_1 - post: - description: Generate content with multimodal inputs. - operationId: aiplatform.projects.locations.publishers.models.generateContent - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse - parameters: - - in: path - name: projectsId + name: metadataStoresId required: true schema: type: string - in: path - name: locationsId + name: contextsId required: true schema: type: string - - in: path - name: publishersId - required: true + - in: query + name: force schema: - type: string - - in: path - name: modelsId - required: true + type: boolean + - in: query + name: etag schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:streamGenerateContent: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts:purge: parameters: *ref_1 post: - description: Generate content with multimodal inputs with streaming support. - operationId: aiplatform.projects.locations.publishers.models.streamGenerateContent + description: Purges Contexts. + operationId: aiplatform.projects.locations.metadataStores.contexts.purge requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1PurgeContextsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -43679,25 +51110,25 @@ paths: schema: type: string - in: path - name: publishersId - required: true - schema: - type: string - - in: path - name: modelsId + name: metadataStoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:countTokens: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:addContextArtifactsAndExecutions: parameters: *ref_1 post: - description: Perform a token counting. - operationId: aiplatform.projects.locations.publishers.models.countTokens + description: >- + Adds a set of Artifacts and Executions to a Context. If any of the + Artifacts or Executions have already been added to a Context, they are + simply skipped. + operationId: >- + aiplatform.projects.locations.metadataStores.contexts.addContextArtifactsAndExecutions requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CountTokensRequest' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43710,7 +51141,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CountTokensResponse + #/components/schemas/GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsResponse parameters: - in: path name: projectsId @@ -43723,25 +51154,31 @@ paths: schema: type: string - in: path - name: publishersId + name: metadataStoresId required: true schema: type: string - in: path - name: modelsId + name: contextsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:computeTokens: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:addContextChildren: parameters: *ref_1 post: - description: Return a list of tokens based on the input text. - operationId: aiplatform.projects.locations.publishers.models.computeTokens + description: >- + Adds a set of Contexts as children to a parent Context. If any of the + child Contexts have already been added to the parent Context, they are + simply skipped. If this call would create a cycle or cause any Context + to have more than 10 parents, the request will fail with an + INVALID_ARGUMENT error. + operationId: aiplatform.projects.locations.metadataStores.contexts.addContextChildren requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ComputeTokensRequest' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1AddContextChildrenRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43754,7 +51191,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ComputeTokensResponse + #/components/schemas/GoogleCloudAiplatformV1AddContextChildrenResponse parameters: - in: path name: projectsId @@ -43767,25 +51204,30 @@ paths: schema: type: string - in: path - name: publishersId + name: metadataStoresId required: true schema: type: string - in: path - name: modelsId + name: contextsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:removeContextChildren: parameters: *ref_1 post: - description: Initializes a MetadataStore, including allocation of resources. - operationId: aiplatform.projects.locations.metadataStores.create + description: >- + Remove a set of children contexts from a parent Context. If any of the + child Contexts were NOT added to the parent Context, they are simply + skipped. + operationId: >- + aiplatform.projects.locations.metadataStores.contexts.removeContextChildren requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataStore' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1RemoveContextChildrenRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43797,7 +51239,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1RemoveContextChildrenResponse parameters: - in: path name: projectsId @@ -43809,51 +51252,24 @@ paths: required: true schema: type: string - - in: query - name: metadataStoreId - schema: - type: string - get: - description: Lists MetadataStores for a Location. - operationId: aiplatform.projects.locations.metadataStores.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListMetadataStoresResponse - parameters: - in: path - name: projectsId + name: metadataStoresId required: true schema: type: string - in: path - name: locationsId + name: contextsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:queryContextLineageSubgraph: parameters: *ref_1 get: - description: Retrieves a specific MetadataStore. - operationId: aiplatform.projects.locations.metadataStores.get + description: >- + Retrieves Artifacts and Executions within the specified Context, + connected by Event edges and returned as a LineageSubgraph. + operationId: >- + aiplatform.projects.locations.metadataStores.contexts.queryContextLineageSubgraph security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43865,7 +51281,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataStore' + $ref: '#/components/schemas/GoogleCloudAiplatformV1LineageSubgraph' parameters: - in: path name: projectsId @@ -43882,50 +51298,18 @@ paths: required: true schema: type: string - delete: - description: >- - Deletes a single MetadataStore and all its child resources (Artifacts, - Executions, and Contexts). - operationId: aiplatform.projects.locations.metadataStores.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - in: path - name: metadataStoresId + name: contextsId required: true schema: type: string - - in: query - name: force - schema: - type: boolean - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.metadataStores.operations.list + operationId: aiplatform.projects.locations.metadataStores.contexts.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43954,6 +51338,11 @@ paths: required: true schema: type: string + - in: path + name: contextsId + required: true + schema: + type: string - in: query name: filter schema: @@ -43967,14 +51356,14 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}: parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - operationId: aiplatform.projects.locations.metadataStores.operations.get + operationId: aiplatform.projects.locations.metadataStores.contexts.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44003,6 +51392,11 @@ paths: required: true schema: type: string + - in: path + name: contextsId + required: true + schema: + type: string - in: path name: operationsId required: true @@ -44014,7 +51408,7 @@ paths: is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.metadataStores.operations.delete + operationId: aiplatform.projects.locations.metadataStores.contexts.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44043,12 +51437,17 @@ paths: required: true schema: type: string + - in: path + name: contextsId + required: true + schema: + type: string - in: path name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- @@ -44060,8 +51459,8 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.metadataStores.operations.cancel + `1`, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.metadataStores.contexts.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44090,12 +51489,17 @@ paths: required: true schema: type: string + - in: path + name: contextsId + required: true + schema: + type: string - in: path name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- @@ -44108,7 +51512,7 @@ paths: best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. - operationId: aiplatform.projects.locations.metadataStores.operations.wait + operationId: aiplatform.projects.locations.metadataStores.contexts.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44137,6 +51541,11 @@ paths: required: true schema: type: string + - in: path + name: contextsId + required: true + schema: + type: string - in: path name: operationsId required: true @@ -44147,16 +51556,16 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions: parameters: *ref_1 post: - description: Creates an Artifact associated with a MetadataStore. - operationId: aiplatform.projects.locations.metadataStores.artifacts.create + description: Creates an Execution associated with a MetadataStore. + operationId: aiplatform.projects.locations.metadataStores.executions.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44168,7 +51577,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' parameters: - in: path name: projectsId @@ -44186,12 +51595,12 @@ paths: schema: type: string - in: query - name: artifactId + name: executionId schema: type: string get: - description: Lists Artifacts in the MetadataStore. - operationId: aiplatform.projects.locations.metadataStores.artifacts.list + description: Lists Executions in the MetadataStore. + operationId: aiplatform.projects.locations.metadataStores.executions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44204,7 +51613,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListArtifactsResponse + #/components/schemas/GoogleCloudAiplatformV1ListExecutionsResponse parameters: - in: path name: projectsId @@ -44238,11 +51647,11 @@ paths: name: orderBy schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}: parameters: *ref_1 get: - description: Retrieves a specific Artifact. - operationId: aiplatform.projects.locations.metadataStores.artifacts.get + description: Retrieves a specific Execution. + operationId: aiplatform.projects.locations.metadataStores.executions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44254,7 +51663,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' parameters: - in: path name: projectsId @@ -44272,18 +51681,18 @@ paths: schema: type: string - in: path - name: artifactsId + name: executionsId required: true schema: type: string patch: - description: Updates a stored Artifact. - operationId: aiplatform.projects.locations.metadataStores.artifacts.patch + description: Updates a stored Execution. + operationId: aiplatform.projects.locations.metadataStores.executions.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44295,7 +51704,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' parameters: - in: path name: projectsId @@ -44313,7 +51722,7 @@ paths: schema: type: string - in: path - name: artifactsId + name: executionsId required: true schema: type: string @@ -44327,8 +51736,8 @@ paths: schema: type: boolean delete: - description: Deletes an Artifact. - operationId: aiplatform.projects.locations.metadataStores.artifacts.delete + description: Deletes an Execution. + operationId: aiplatform.projects.locations.metadataStores.executions.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44358,7 +51767,7 @@ paths: schema: type: string - in: path - name: artifactsId + name: executionsId required: true schema: type: string @@ -44366,17 +51775,17 @@ paths: name: etag schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts:purge: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions:purge: parameters: *ref_1 post: - description: Purges Artifacts. - operationId: aiplatform.projects.locations.metadataStores.artifacts.purge + description: Purges Executions. + operationId: aiplatform.projects.locations.metadataStores.executions.purge requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PurgeArtifactsRequest + #/components/schemas/GoogleCloudAiplatformV1PurgeExecutionsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44405,14 +51814,22 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}:queryArtifactLineageSubgraph: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}:addExecutionEvents: parameters: *ref_1 - get: + post: description: >- - Retrieves lineage of an Artifact represented through Artifacts and - Executions connected by Event edges and returned as a LineageSubgraph. + Adds Events to the specified Execution. An Event indicates whether an + Artifact was used as an input or output for an Execution. If an Event + already exists between the Execution and the Artifact, the Event is + skipped. operationId: >- - aiplatform.projects.locations.metadataStores.artifacts.queryArtifactLineageSubgraph + aiplatform.projects.locations.metadataStores.executions.addExecutionEvents + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1AddExecutionEventsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44424,7 +51841,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1LineageSubgraph' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1AddExecutionEventsResponse parameters: - in: path name: projectsId @@ -44442,26 +51860,59 @@ paths: schema: type: string - in: path - name: artifactsId + name: executionsId required: true schema: type: string - - in: query - name: maxHops + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}:queryExecutionInputsAndOutputs: + parameters: *ref_1 + get: + description: >- + Obtains the set of input and output Artifacts for this Execution, in the + form of LineageSubgraph that also contains the Execution and connecting + Events. + operationId: >- + aiplatform.projects.locations.metadataStores.executions.queryExecutionInputsAndOutputs + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1LineageSubgraph' + parameters: + - in: path + name: projectsId + required: true schema: - type: integer - format: int32 - - in: query - name: filter + type: string + - in: path + name: locationsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations: + - in: path + name: metadataStoresId + required: true + schema: + type: string + - in: path + name: executionsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.metadataStores.artifacts.operations.list + operationId: aiplatform.projects.locations.metadataStores.executions.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44491,7 +51942,7 @@ paths: schema: type: string - in: path - name: artifactsId + name: executionsId required: true schema: type: string @@ -44508,14 +51959,14 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}: parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - operationId: aiplatform.projects.locations.metadataStores.artifacts.operations.get + operationId: aiplatform.projects.locations.metadataStores.executions.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44545,7 +51996,7 @@ paths: schema: type: string - in: path - name: artifactsId + name: executionsId required: true schema: type: string @@ -44560,7 +52011,8 @@ paths: is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.metadataStores.artifacts.operations.delete + operationId: >- + aiplatform.projects.locations.metadataStores.executions.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44590,7 +52042,7 @@ paths: schema: type: string - in: path - name: artifactsId + name: executionsId required: true schema: type: string @@ -44599,7 +52051,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- @@ -44611,8 +52063,9 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.metadataStores.artifacts.operations.cancel + `1`, corresponding to `Code.CANCELLED`. + operationId: >- + aiplatform.projects.locations.metadataStores.executions.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44642,7 +52095,7 @@ paths: schema: type: string - in: path - name: artifactsId + name: executionsId required: true schema: type: string @@ -44651,7 +52104,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- @@ -44664,7 +52117,7 @@ paths: best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. - operationId: aiplatform.projects.locations.metadataStores.artifacts.operations.wait + operationId: aiplatform.projects.locations.metadataStores.executions.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44694,7 +52147,7 @@ paths: schema: type: string - in: path - name: artifactsId + name: executionsId required: true schema: type: string @@ -44708,188 +52161,16 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas: parameters: *ref_1 post: - description: Creates a Context associated with a MetadataStore. - operationId: aiplatform.projects.locations.metadataStores.contexts.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: query - name: contextId - schema: - type: string - get: - description: Lists Contexts on the MetadataStore. - operationId: aiplatform.projects.locations.metadataStores.contexts.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListContextsResponse - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: orderBy - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}: - parameters: *ref_1 - get: - description: Retrieves a specific Context. - operationId: aiplatform.projects.locations.metadataStores.contexts.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: path - name: contextsId - required: true - schema: - type: string - patch: - description: Updates a stored Context. - operationId: aiplatform.projects.locations.metadataStores.contexts.patch + description: Creates a MetadataSchema. + operationId: aiplatform.projects.locations.metadataStores.metadataSchemas.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: path - name: contextsId - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - - in: query - name: allowMissing - schema: - type: boolean - delete: - description: Deletes a stored Context. - operationId: aiplatform.projects.locations.metadataStores.contexts.delete + $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataSchema' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44901,7 +52182,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataSchema' parameters: - in: path name: projectsId @@ -44918,72 +52199,13 @@ paths: required: true schema: type: string - - in: path - name: contextsId - required: true - schema: - type: string - - in: query - name: force - schema: - type: boolean - in: query - name: etag - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts:purge: - parameters: *ref_1 - post: - description: Purges Contexts. - operationId: aiplatform.projects.locations.metadataStores.contexts.purge - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PurgeContextsRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: metadataStoresId - required: true + name: metadataSchemaId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:addContextArtifactsAndExecutions: - parameters: *ref_1 - post: - description: >- - Adds a set of Artifacts and Executions to a Context. If any of the - Artifacts or Executions have already been added to a Context, they are - simply skipped. - operationId: >- - aiplatform.projects.locations.metadataStores.contexts.addContextArtifactsAndExecutions - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsRequest + get: + description: Lists MetadataSchemas. + operationId: aiplatform.projects.locations.metadataStores.metadataSchemas.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44996,7 +52218,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsResponse + #/components/schemas/GoogleCloudAiplatformV1ListMetadataSchemasResponse parameters: - in: path name: projectsId @@ -45013,27 +52235,24 @@ paths: required: true schema: type: string - - in: path - name: contextsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:addContextChildren: + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas/{metadataSchemasId}: parameters: *ref_1 - post: - description: >- - Adds a set of Contexts as children to a parent Context. If any of the - child Contexts have already been added to the parent Context, they are - simply skipped. If this call would create a cycle or cause any Context - to have more than 10 parents, the request will fail with an - INVALID_ARGUMENT error. - operationId: aiplatform.projects.locations.metadataStores.contexts.addContextChildren - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1AddContextChildrenRequest + get: + description: Retrieves a specific MetadataSchema. + operationId: aiplatform.projects.locations.metadataStores.metadataSchemas.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45045,8 +52264,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1AddContextChildrenResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataSchema' parameters: - in: path name: projectsId @@ -45064,25 +52282,24 @@ paths: schema: type: string - in: path - name: contextsId + name: metadataSchemasId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:removeContextChildren: + /v1/projects/{projectsId}/locations/{locationsId}/migratableResources:search: parameters: *ref_1 post: description: >- - Remove a set of children contexts from a parent Context. If any of the - child Contexts were NOT added to the parent Context, they are simply - skipped. - operationId: >- - aiplatform.projects.locations.metadataStores.contexts.removeContextChildren + Searches all of the resources in automl.googleapis.com, + datalabeling.googleapis.com and ml.googleapis.com that can be migrated + to Vertex AI's given location. + operationId: aiplatform.projects.locations.migratableResources.search requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1RemoveContextChildrenRequest + #/components/schemas/GoogleCloudAiplatformV1SearchMigratableResourcesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45095,7 +52312,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1RemoveContextChildrenResponse + #/components/schemas/GoogleCloudAiplatformV1SearchMigratableResourcesResponse parameters: - in: path name: projectsId @@ -45107,24 +52324,19 @@ paths: required: true schema: type: string - - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: path - name: contextsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:queryContextLineageSubgraph: + /v1/projects/{projectsId}/locations/{locationsId}/migratableResources:batchMigrate: parameters: *ref_1 - get: + post: description: >- - Retrieves Artifacts and Executions within the specified Context, - connected by Event edges and returned as a LineageSubgraph. - operationId: >- - aiplatform.projects.locations.metadataStores.contexts.queryContextLineageSubgraph + Batch migrates resources from ml.googleapis.com, automl.googleapis.com, + and datalabeling.googleapis.com to Vertex AI. + operationId: aiplatform.projects.locations.migratableResources.batchMigrate + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchMigrateResourcesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45136,7 +52348,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1LineageSubgraph' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -45148,23 +52360,13 @@ paths: required: true schema: type: string - - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: path - name: contextsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.metadataStores.contexts.operations.list + operationId: aiplatform.projects.locations.migratableResources.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45189,12 +52391,7 @@ paths: schema: type: string - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: path - name: contextsId + name: migratableResourcesId required: true schema: type: string @@ -45211,14 +52408,14 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}: parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - operationId: aiplatform.projects.locations.metadataStores.contexts.operations.get + operationId: aiplatform.projects.locations.migratableResources.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45243,12 +52440,7 @@ paths: schema: type: string - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: path - name: contextsId + name: migratableResourcesId required: true schema: type: string @@ -45263,7 +52455,7 @@ paths: is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.metadataStores.contexts.operations.delete + operationId: aiplatform.projects.locations.migratableResources.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45288,12 +52480,7 @@ paths: schema: type: string - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: path - name: contextsId + name: migratableResourcesId required: true schema: type: string @@ -45302,7 +52489,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- @@ -45314,8 +52501,8 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.metadataStores.contexts.operations.cancel + `1`, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.migratableResources.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45340,12 +52527,7 @@ paths: schema: type: string - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: path - name: contextsId + name: migratableResourcesId required: true schema: type: string @@ -45354,7 +52536,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- @@ -45367,7 +52549,7 @@ paths: best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. - operationId: aiplatform.projects.locations.metadataStores.contexts.operations.wait + operationId: aiplatform.projects.locations.migratableResources.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45392,12 +52574,7 @@ paths: schema: type: string - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: path - name: contextsId + name: migratableResourcesId required: true schema: type: string @@ -45411,16 +52588,20 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions: + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes:assign: parameters: *ref_1 post: - description: Creates an Execution associated with a MetadataStore. - operationId: aiplatform.projects.locations.metadataStores.executions.create + description: >- + Assigns a NotebookRuntime to a user for a particular Notebook file. This + method will either returns an existing assignment or generates a new + one. + operationId: aiplatform.projects.locations.notebookRuntimes.assign requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1AssignNotebookRuntimeRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45432,7 +52613,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -45444,18 +52625,42 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}: + parameters: *ref_1 + get: + description: Gets a NotebookRuntime. + operationId: aiplatform.projects.locations.notebookRuntimes.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookRuntime' + parameters: - in: path - name: metadataStoresId + name: projectsId required: true schema: type: string - - in: query - name: executionId + - in: path + name: locationsId + required: true schema: type: string - get: - description: Lists Executions in the MetadataStore. - operationId: aiplatform.projects.locations.metadataStores.executions.list + - in: path + name: notebookRuntimesId + required: true + schema: + type: string + delete: + description: Deletes a NotebookRuntime. + operationId: aiplatform.projects.locations.notebookRuntimes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45467,8 +52672,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListExecutionsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -45481,10 +52685,43 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: notebookRuntimesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes: + parameters: *ref_1 + get: + description: Lists NotebookRuntimes in a Location. + operationId: aiplatform.projects.locations.notebookRuntimes.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListNotebookRuntimesResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId required: true schema: type: string + - in: query + name: filter + schema: + type: string - in: query name: pageSize schema: @@ -45495,18 +52732,25 @@ paths: schema: type: string - in: query - name: filter + name: readMask schema: type: string + format: google-fieldmask - in: query name: orderBy schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}: + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:upgrade: parameters: *ref_1 - get: - description: Retrieves a specific Execution. - operationId: aiplatform.projects.locations.metadataStores.executions.get + post: + description: Upgrades a NotebookRuntime. + operationId: aiplatform.projects.locations.notebookRuntimes.upgrade + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1UpgradeNotebookRuntimeRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45518,7 +52762,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -45531,23 +52775,60 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: notebookRuntimesId required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:start: + parameters: *ref_1 + post: + description: Starts a NotebookRuntime. + operationId: aiplatform.projects.locations.notebookRuntimes.start + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StartNotebookRuntimeRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: - in: path - name: executionsId + name: projectsId required: true schema: type: string - patch: - description: Updates a stored Execution. - operationId: aiplatform.projects.locations.metadataStores.executions.patch + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: notebookRuntimesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:stop: + parameters: *ref_1 + post: + description: Stops a NotebookRuntime. + operationId: aiplatform.projects.locations.notebookRuntimes.stop requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StopNotebookRuntimeRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45559,7 +52840,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -45572,27 +52853,200 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: notebookRuntimesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.notebookRuntimes.operations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + parameters: + - in: path + name: projectsId required: true schema: type: string - in: path - name: executionsId + name: locationsId + required: true + schema: + type: string + - in: path + name: notebookRuntimesId required: true schema: type: string - in: query - name: updateMask + name: filter schema: type: string - format: google-fieldmask - in: query - name: allowMissing + name: pageSize schema: - type: boolean + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: aiplatform.projects.locations.notebookRuntimes.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: notebookRuntimesId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string delete: - description: Deletes an Execution. - operationId: aiplatform.projects.locations.metadataStores.executions.delete + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.notebookRuntimes.operations.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: notebookRuntimesId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + `1`, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.notebookRuntimes.operations.cancel + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: notebookRuntimesId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:wait: + parameters: *ref_1 + post: + description: >- + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It may return the latest state before the specified + timeout (including immediately), meaning even an immediate response is + no guarantee that the operation is done. + operationId: aiplatform.projects.locations.notebookRuntimes.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45617,30 +53071,30 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: notebookRuntimesId required: true schema: type: string - in: path - name: executionsId + name: operationsId required: true schema: type: string - in: query - name: etag + name: timeout schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions:purge: + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs: parameters: *ref_1 post: - description: Purges Executions. - operationId: aiplatform.projects.locations.metadataStores.executions.purge + description: Creates a NotebookExecutionJob. + operationId: aiplatform.projects.locations.notebookExecutionJobs.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PurgeExecutionsRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookExecutionJob' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45664,27 +53118,13 @@ paths: required: true schema: type: string - - in: path - name: metadataStoresId - required: true + - in: query + name: notebookExecutionJobId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}:addExecutionEvents: - parameters: *ref_1 - post: - description: >- - Adds Events to the specified Execution. An Event indicates whether an - Artifact was used as an input or output for an Execution. If an Event - already exists between the Execution and the Artifact, the Event is - skipped. - operationId: >- - aiplatform.projects.locations.metadataStores.executions.addExecutionEvents - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1AddExecutionEventsRequest + get: + description: Lists NotebookExecutionJobs in a Location. + operationId: aiplatform.projects.locations.notebookExecutionJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45697,7 +53137,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1AddExecutionEventsResponse + #/components/schemas/GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse parameters: - in: path name: projectsId @@ -45709,25 +53149,32 @@ paths: required: true schema: type: string - - in: path - name: metadataStoresId - required: true + - in: query + name: filter schema: type: string - - in: path - name: executionsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}:queryExecutionInputsAndOutputs: + - in: query + name: orderBy + schema: + type: string + - in: query + name: view + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}: parameters: *ref_1 get: - description: >- - Obtains the set of input and output Artifacts for this Execution, in the - form of LineageSubgraph that also contains the Execution and connecting - Events. - operationId: >- - aiplatform.projects.locations.metadataStores.executions.queryExecutionInputsAndOutputs + description: Gets a NotebookExecutionJob. + operationId: aiplatform.projects.locations.notebookExecutionJobs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45739,7 +53186,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1LineageSubgraph' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NotebookExecutionJob parameters: - in: path name: projectsId @@ -45752,22 +53200,52 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: notebookExecutionJobsId required: true schema: type: string + - in: query + name: view + schema: + type: string + delete: + description: Deletes a NotebookExecutionJob. + operationId: aiplatform.projects.locations.notebookExecutionJobs.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: - in: path - name: executionsId + name: projectsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations: + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: notebookExecutionJobsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.metadataStores.executions.operations.list + operationId: aiplatform.projects.locations.notebookExecutionJobs.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45792,12 +53270,7 @@ paths: schema: type: string - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: path - name: executionsId + name: notebookExecutionJobsId required: true schema: type: string @@ -45814,14 +53287,14 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}: parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - operationId: aiplatform.projects.locations.metadataStores.executions.operations.get + operationId: aiplatform.projects.locations.notebookExecutionJobs.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45846,12 +53319,7 @@ paths: schema: type: string - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: path - name: executionsId + name: notebookExecutionJobsId required: true schema: type: string @@ -45866,8 +53334,7 @@ paths: is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. - operationId: >- - aiplatform.projects.locations.metadataStores.executions.operations.delete + operationId: aiplatform.projects.locations.notebookExecutionJobs.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45892,12 +53359,7 @@ paths: schema: type: string - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: path - name: executionsId + name: notebookExecutionJobsId required: true schema: type: string @@ -45906,7 +53368,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- @@ -45918,9 +53380,8 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: >- - aiplatform.projects.locations.metadataStores.executions.operations.cancel + `1`, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.notebookExecutionJobs.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45945,12 +53406,7 @@ paths: schema: type: string - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: path - name: executionsId + name: notebookExecutionJobsId required: true schema: type: string @@ -45959,7 +53415,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- @@ -45972,7 +53428,7 @@ paths: best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. - operationId: aiplatform.projects.locations.metadataStores.executions.operations.wait + operationId: aiplatform.projects.locations.notebookExecutionJobs.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45997,12 +53453,7 @@ paths: schema: type: string - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: path - name: executionsId + name: notebookExecutionJobsId required: true schema: type: string @@ -46016,16 +53467,16 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas: + /v1/projects/{projectsId}/locations/{locationsId}/persistentResources: parameters: *ref_1 post: - description: Creates a MetadataSchema. - operationId: aiplatform.projects.locations.metadataStores.metadataSchemas.create + description: Creates a PersistentResource. + operationId: aiplatform.projects.locations.persistentResources.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataSchema' + $ref: '#/components/schemas/GoogleCloudAiplatformV1PersistentResource' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46037,7 +53488,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataSchema' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -46049,18 +53500,13 @@ paths: required: true schema: type: string - - in: path - name: metadataStoresId - required: true - schema: - type: string - in: query - name: metadataSchemaId + name: persistentResourceId schema: type: string get: - description: Lists MetadataSchemas. - operationId: aiplatform.projects.locations.metadataStores.metadataSchemas.list + description: Lists PersistentResources in a Location. + operationId: aiplatform.projects.locations.persistentResources.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46073,7 +53519,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListMetadataSchemasResponse + #/components/schemas/GoogleCloudAiplatformV1ListPersistentResourcesResponse parameters: - in: path name: projectsId @@ -46085,11 +53531,6 @@ paths: required: true schema: type: string - - in: path - name: metadataStoresId - required: true - schema: - type: string - in: query name: pageSize schema: @@ -46099,15 +53540,11 @@ paths: name: pageToken schema: type: string - - in: query - name: filter - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas/{metadataSchemasId}: + /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}: parameters: *ref_1 get: - description: Retrieves a specific MetadataSchema. - operationId: aiplatform.projects.locations.metadataStores.metadataSchemas.get + description: Gets a PersistentResource. + operationId: aiplatform.projects.locations.persistentResources.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46119,7 +53556,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataSchema' + $ref: '#/components/schemas/GoogleCloudAiplatformV1PersistentResource' parameters: - in: path name: projectsId @@ -46132,29 +53569,49 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: persistentResourcesId + required: true + schema: + type: string + delete: + description: Deletes a PersistentResource. + operationId: aiplatform.projects.locations.persistentResources.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId required: true schema: type: string - in: path - name: metadataSchemasId + name: locationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/migratableResources:search: - parameters: *ref_1 - post: - description: >- - Searches all of the resources in automl.googleapis.com, - datalabeling.googleapis.com and ml.googleapis.com that can be migrated - to Vertex AI's given location. - operationId: aiplatform.projects.locations.migratableResources.search + - in: path + name: persistentResourcesId + required: true + schema: + type: string + patch: + description: Updates a PersistentResource. + operationId: aiplatform.projects.locations.persistentResources.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SearchMigratableResourcesRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1PersistentResource' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46166,8 +53623,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SearchMigratableResourcesResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -46179,19 +53635,27 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/migratableResources:batchMigrate: + - in: path + name: persistentResourcesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}:reboot: parameters: *ref_1 post: - description: >- - Batch migrates resources from ml.googleapis.com, automl.googleapis.com, - and datalabeling.googleapis.com to Vertex AI. - operationId: aiplatform.projects.locations.migratableResources.batchMigrate + description: Reboots a PersistentResource. + operationId: aiplatform.projects.locations.persistentResources.reboot requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchMigrateResourcesRequest + #/components/schemas/GoogleCloudAiplatformV1RebootPersistentResourceRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46215,13 +53679,18 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations: + - in: path + name: persistentResourcesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.migratableResources.operations.list + operationId: aiplatform.projects.locations.persistentResources.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46246,7 +53715,7 @@ paths: schema: type: string - in: path - name: migratableResourcesId + name: persistentResourcesId required: true schema: type: string @@ -46263,14 +53732,14 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}: parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - operationId: aiplatform.projects.locations.migratableResources.operations.get + operationId: aiplatform.projects.locations.persistentResources.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46295,7 +53764,7 @@ paths: schema: type: string - in: path - name: migratableResourcesId + name: persistentResourcesId required: true schema: type: string @@ -46310,7 +53779,7 @@ paths: is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.migratableResources.operations.delete + operationId: aiplatform.projects.locations.persistentResources.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46335,7 +53804,7 @@ paths: schema: type: string - in: path - name: migratableResourcesId + name: persistentResourcesId required: true schema: type: string @@ -46344,7 +53813,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- @@ -46356,8 +53825,8 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.migratableResources.operations.cancel + `1`, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.persistentResources.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46382,7 +53851,7 @@ paths: schema: type: string - in: path - name: migratableResourcesId + name: persistentResourcesId required: true schema: type: string @@ -46391,7 +53860,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- @@ -46404,7 +53873,7 @@ paths: best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. - operationId: aiplatform.projects.locations.migratableResources.operations.wait + operationId: aiplatform.projects.locations.persistentResources.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46429,7 +53898,7 @@ paths: schema: type: string - in: path - name: migratableResourcesId + name: persistentResourcesId required: true schema: type: string @@ -46443,79 +53912,18 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes:assign: + /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines: parameters: *ref_1 post: description: >- - Assigns a NotebookRuntime to a user for a particular Notebook file. This - method will either returns an existing assignment or generates a new - one. - operationId: aiplatform.projects.locations.notebookRuntimes.assign + Creates a TrainingPipeline. A created TrainingPipeline right away will + be attempted to be run. + operationId: aiplatform.projects.locations.trainingPipelines.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1AssignNotebookRuntimeRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}: - parameters: *ref_1 - get: - description: Gets a NotebookRuntime. - operationId: aiplatform.projects.locations.notebookRuntimes.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookRuntime' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: notebookRuntimesId - required: true - schema: - type: string - delete: - description: Deletes a NotebookRuntime. - operationId: aiplatform.projects.locations.notebookRuntimes.delete + $ref: '#/components/schemas/GoogleCloudAiplatformV1TrainingPipeline' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46527,7 +53935,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1TrainingPipeline' parameters: - in: path name: projectsId @@ -46539,16 +53947,9 @@ paths: required: true schema: type: string - - in: path - name: notebookRuntimesId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes: - parameters: *ref_1 get: - description: Lists NotebookRuntimes in a Location. - operationId: aiplatform.projects.locations.notebookRuntimes.list + description: Lists TrainingPipelines in a Location. + operationId: aiplatform.projects.locations.trainingPipelines.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46561,7 +53962,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListNotebookRuntimesResponse + #/components/schemas/GoogleCloudAiplatformV1ListTrainingPipelinesResponse parameters: - in: path name: projectsId @@ -46591,21 +53992,11 @@ paths: schema: type: string format: google-fieldmask - - in: query - name: orderBy - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:upgrade: + /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}: parameters: *ref_1 - post: - description: Upgrades a NotebookRuntime. - operationId: aiplatform.projects.locations.notebookRuntimes.upgrade - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1UpgradeNotebookRuntimeRequest + get: + description: Gets a TrainingPipeline. + operationId: aiplatform.projects.locations.trainingPipelines.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46617,7 +54008,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1TrainingPipeline' parameters: - in: path name: projectsId @@ -46630,21 +54021,13 @@ paths: schema: type: string - in: path - name: notebookRuntimesId + name: trainingPipelinesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:start: - parameters: *ref_1 - post: - description: Starts a NotebookRuntime. - operationId: aiplatform.projects.locations.notebookRuntimes.start - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StartNotebookRuntimeRequest + delete: + description: Deletes a TrainingPipeline. + operationId: aiplatform.projects.locations.trainingPipelines.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46669,21 +54052,30 @@ paths: schema: type: string - in: path - name: notebookRuntimesId + name: trainingPipelinesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:stop: + /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}:cancel: parameters: *ref_1 post: - description: Stops a NotebookRuntime. - operationId: aiplatform.projects.locations.notebookRuntimes.stop + description: >- + Cancels a TrainingPipeline. Starts asynchronous cancellation on the + TrainingPipeline. The server makes a best effort to cancel the pipeline, + but success is not guaranteed. Clients can use + PipelineService.GetTrainingPipeline or other methods to check whether + the cancellation succeeded or whether the pipeline completed despite + cancellation. On successful cancellation, the TrainingPipeline is not + deleted; instead it becomes a pipeline with a TrainingPipeline.error + value with a google.rpc.Status.code of 1, corresponding to + `Code.CANCELLED`, and TrainingPipeline.state is set to `CANCELLED`. + operationId: aiplatform.projects.locations.trainingPipelines.cancel requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StopNotebookRuntimeRequest + #/components/schemas/GoogleCloudAiplatformV1CancelTrainingPipelineRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46695,7 +54087,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -46708,17 +54100,17 @@ paths: schema: type: string - in: path - name: notebookRuntimesId + name: trainingPipelinesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.notebookRuntimes.operations.list + operationId: aiplatform.projects.locations.trainingPipelines.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46743,7 +54135,7 @@ paths: schema: type: string - in: path - name: notebookRuntimesId + name: trainingPipelinesId required: true schema: type: string @@ -46760,14 +54152,14 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}: parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - operationId: aiplatform.projects.locations.notebookRuntimes.operations.get + operationId: aiplatform.projects.locations.trainingPipelines.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46792,7 +54184,7 @@ paths: schema: type: string - in: path - name: notebookRuntimesId + name: trainingPipelinesId required: true schema: type: string @@ -46807,7 +54199,7 @@ paths: is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.notebookRuntimes.operations.delete + operationId: aiplatform.projects.locations.trainingPipelines.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46832,7 +54224,7 @@ paths: schema: type: string - in: path - name: notebookRuntimesId + name: trainingPipelinesId required: true schema: type: string @@ -46841,7 +54233,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- @@ -46853,8 +54245,8 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.notebookRuntimes.operations.cancel + `1`, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.trainingPipelines.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46879,7 +54271,7 @@ paths: schema: type: string - in: path - name: notebookRuntimesId + name: trainingPipelinesId required: true schema: type: string @@ -46888,7 +54280,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- @@ -46901,7 +54293,7 @@ paths: best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. - operationId: aiplatform.projects.locations.notebookRuntimes.operations.wait + operationId: aiplatform.projects.locations.trainingPipelines.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46926,7 +54318,7 @@ paths: schema: type: string - in: path - name: notebookRuntimesId + name: trainingPipelinesId required: true schema: type: string @@ -46940,16 +54332,128 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs: + /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs: parameters: *ref_1 post: - description: Creates a NotebookExecutionJob. - operationId: aiplatform.projects.locations.notebookExecutionJobs.create + description: Creates a PipelineJob. A PipelineJob will run immediately when created. + operationId: aiplatform.projects.locations.pipelineJobs.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookExecutionJob' + $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJob' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJob' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pipelineJobId + schema: + type: string + get: + description: Lists PipelineJobs in a Location. + operationId: aiplatform.projects.locations.pipelineJobs.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListPipelineJobsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: orderBy + schema: + type: string + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}: + parameters: *ref_1 + get: + description: Gets a PipelineJob. + operationId: aiplatform.projects.locations.pipelineJobs.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJob' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: pipelineJobsId + required: true + schema: + type: string + delete: + description: Deletes a PipelineJob. + operationId: aiplatform.projects.locations.pipelineJobs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46973,13 +54477,25 @@ paths: required: true schema: type: string - - in: query - name: notebookExecutionJobId + - in: path + name: pipelineJobsId + required: true schema: type: string - get: - description: Lists NotebookExecutionJobs in a Location. - operationId: aiplatform.projects.locations.notebookExecutionJobs.list + /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs:batchDelete: + parameters: *ref_1 + post: + description: >- + Batch deletes PipelineJobs The Operation is atomic. If it fails, none of + the PipelineJobs are deleted. If it succeeds, all of the PipelineJobs + are deleted. + operationId: aiplatform.projects.locations.pipelineJobs.batchDelete + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46991,8 +54507,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -47004,32 +54519,26 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: view - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}: + /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}:cancel: parameters: *ref_1 - get: - description: Gets a NotebookExecutionJob. - operationId: aiplatform.projects.locations.notebookExecutionJobs.get + post: + description: >- + Cancels a PipelineJob. Starts asynchronous cancellation on the + PipelineJob. The server makes a best effort to cancel the pipeline, but + success is not guaranteed. Clients can use + PipelineService.GetPipelineJob or other methods to check whether the + cancellation succeeded or whether the pipeline completed despite + cancellation. On successful cancellation, the PipelineJob is not + deleted; instead it becomes a pipeline with a PipelineJob.error value + with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, + and PipelineJob.state is set to `CANCELLED`. + operationId: aiplatform.projects.locations.pipelineJobs.cancel + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1CancelPipelineJobRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47041,8 +54550,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NotebookExecutionJob + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -47055,17 +54563,27 @@ paths: schema: type: string - in: path - name: notebookExecutionJobsId + name: pipelineJobsId required: true schema: type: string - - in: query - name: view - schema: - type: string - delete: - description: Deletes a NotebookExecutionJob. - operationId: aiplatform.projects.locations.notebookExecutionJobs.delete + /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs:batchCancel: + parameters: *ref_1 + post: + description: >- + Batch cancel PipelineJobs. Firstly the server will check if all the jobs + are in non-terminal states, and skip the jobs that are already + terminated. If the operation failed, none of the pipeline jobs are + cancelled. The server will poll the states of all the pipeline jobs + periodically to check the cancellation status. This operation will + return an LRO. + operationId: aiplatform.projects.locations.pipelineJobs.batchCancel + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47089,18 +54607,13 @@ paths: required: true schema: type: string - - in: path - name: notebookExecutionJobsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.notebookExecutionJobs.operations.list + operationId: aiplatform.projects.locations.pipelineJobs.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47125,7 +54638,7 @@ paths: schema: type: string - in: path - name: notebookExecutionJobsId + name: pipelineJobsId required: true schema: type: string @@ -47142,14 +54655,14 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}: parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - operationId: aiplatform.projects.locations.notebookExecutionJobs.operations.get + operationId: aiplatform.projects.locations.pipelineJobs.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47174,7 +54687,7 @@ paths: schema: type: string - in: path - name: notebookExecutionJobsId + name: pipelineJobsId required: true schema: type: string @@ -47189,7 +54702,7 @@ paths: is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.notebookExecutionJobs.operations.delete + operationId: aiplatform.projects.locations.pipelineJobs.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47214,7 +54727,7 @@ paths: schema: type: string - in: path - name: notebookExecutionJobsId + name: pipelineJobsId required: true schema: type: string @@ -47223,7 +54736,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- @@ -47235,8 +54748,8 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.notebookExecutionJobs.operations.cancel + `1`, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.pipelineJobs.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47261,7 +54774,7 @@ paths: schema: type: string - in: path - name: notebookExecutionJobsId + name: pipelineJobsId required: true schema: type: string @@ -47270,7 +54783,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- @@ -47283,7 +54796,7 @@ paths: best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. - operationId: aiplatform.projects.locations.notebookExecutionJobs.operations.wait + operationId: aiplatform.projects.locations.pipelineJobs.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47308,7 +54821,7 @@ paths: schema: type: string - in: path - name: notebookExecutionJobsId + name: pipelineJobsId required: true schema: type: string @@ -47322,16 +54835,17 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/persistentResources: + /v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}:query: parameters: *ref_1 post: - description: Creates a PersistentResource. - operationId: aiplatform.projects.locations.persistentResources.create + description: Queries using a reasoning engine. + operationId: aiplatform.projects.locations.reasoningEngines.query requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PersistentResource' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1QueryReasoningEngineRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47343,7 +54857,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1QueryReasoningEngineResponse parameters: - in: path name: projectsId @@ -47355,13 +54870,22 @@ paths: required: true schema: type: string - - in: query - name: persistentResourceId + - in: path + name: reasoningEnginesId + required: true schema: type: string - get: - description: Lists PersistentResources in a Location. - operationId: aiplatform.projects.locations.persistentResources.list + /v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}:streamQuery: + parameters: *ref_1 + post: + description: Streams queries using a reasoning engine. + operationId: aiplatform.projects.locations.reasoningEngines.streamQuery + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StreamQueryReasoningEngineRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47373,8 +54897,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListPersistentResourcesResponse + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: projectsId @@ -47386,20 +54909,21 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: reasoningEnginesId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}: + /v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines: parameters: *ref_1 - get: - description: Gets a PersistentResource. - operationId: aiplatform.projects.locations.persistentResources.get + post: + description: Creates a reasoning engine. + operationId: aiplatform.projects.locations.reasoningEngines.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ReasoningEngine' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47411,7 +54935,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PersistentResource' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -47423,14 +54947,51 @@ paths: required: true schema: type: string + get: + description: Lists reasoning engines in a location. + operationId: aiplatform.projects.locations.reasoningEngines.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListReasoningEnginesResponse + parameters: - in: path - name: persistentResourcesId + name: projectsId required: true schema: type: string - delete: - description: Deletes a PersistentResource. - operationId: aiplatform.projects.locations.persistentResources.delete + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}: + parameters: *ref_1 + get: + description: Gets a reasoning engine. + operationId: aiplatform.projects.locations.reasoningEngines.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47442,7 +55003,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1ReasoningEngine' parameters: - in: path name: projectsId @@ -47455,18 +55016,18 @@ paths: schema: type: string - in: path - name: persistentResourcesId + name: reasoningEnginesId required: true schema: type: string patch: - description: Updates a PersistentResource. - operationId: aiplatform.projects.locations.persistentResources.patch + description: Updates a reasoning engine. + operationId: aiplatform.projects.locations.reasoningEngines.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PersistentResource' + $ref: '#/components/schemas/GoogleCloudAiplatformV1ReasoningEngine' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47491,7 +55052,7 @@ paths: schema: type: string - in: path - name: persistentResourcesId + name: reasoningEnginesId required: true schema: type: string @@ -47500,17 +55061,9 @@ paths: schema: type: string format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}:reboot: - parameters: *ref_1 - post: - description: Reboots a PersistentResource. - operationId: aiplatform.projects.locations.persistentResources.reboot - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1RebootPersistentResourceRequest + delete: + description: Deletes a reasoning engine. + operationId: aiplatform.projects.locations.reasoningEngines.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47535,17 +55088,21 @@ paths: schema: type: string - in: path - name: persistentResourcesId + name: reasoningEnginesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations: + - in: query + name: force + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.persistentResources.operations.list + operationId: aiplatform.projects.locations.reasoningEngines.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47570,7 +55127,7 @@ paths: schema: type: string - in: path - name: persistentResourcesId + name: reasoningEnginesId required: true schema: type: string @@ -47587,14 +55144,14 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}: parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - operationId: aiplatform.projects.locations.persistentResources.operations.get + operationId: aiplatform.projects.locations.reasoningEngines.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47619,7 +55176,7 @@ paths: schema: type: string - in: path - name: persistentResourcesId + name: reasoningEnginesId required: true schema: type: string @@ -47634,7 +55191,7 @@ paths: is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.persistentResources.operations.delete + operationId: aiplatform.projects.locations.reasoningEngines.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47659,7 +55216,7 @@ paths: schema: type: string - in: path - name: persistentResourcesId + name: reasoningEnginesId required: true schema: type: string @@ -47668,7 +55225,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- @@ -47680,8 +55237,8 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.persistentResources.operations.cancel + `1`, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.reasoningEngines.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47706,7 +55263,7 @@ paths: schema: type: string - in: path - name: persistentResourcesId + name: reasoningEnginesId required: true schema: type: string @@ -47715,7 +55272,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- @@ -47728,7 +55285,7 @@ paths: best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. - operationId: aiplatform.projects.locations.persistentResources.operations.wait + operationId: aiplatform.projects.locations.reasoningEngines.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47753,7 +55310,7 @@ paths: schema: type: string - in: path - name: persistentResourcesId + name: reasoningEnginesId required: true schema: type: string @@ -47767,18 +55324,16 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines: + /v1/projects/{projectsId}/locations/{locationsId}/schedules: parameters: *ref_1 post: - description: >- - Creates a TrainingPipeline. A created TrainingPipeline right away will - be attempted to be run. - operationId: aiplatform.projects.locations.trainingPipelines.create + description: Creates a Schedule. + operationId: aiplatform.projects.locations.schedules.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TrainingPipeline' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47790,7 +55345,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TrainingPipeline' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' parameters: - in: path name: projectsId @@ -47803,8 +55358,8 @@ paths: schema: type: string get: - description: Lists TrainingPipelines in a Location. - operationId: aiplatform.projects.locations.trainingPipelines.list + description: Lists Schedules in a Location. + operationId: aiplatform.projects.locations.schedules.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47817,7 +55372,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListTrainingPipelinesResponse + #/components/schemas/GoogleCloudAiplatformV1ListSchedulesResponse parameters: - in: path name: projectsId @@ -47843,15 +55398,45 @@ paths: schema: type: string - in: query - name: readMask + name: orderBy schema: type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}: + /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}: parameters: *ref_1 + delete: + description: Deletes a Schedule. + operationId: aiplatform.projects.locations.schedules.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: schedulesId + required: true + schema: + type: string get: - description: Gets a TrainingPipeline. - operationId: aiplatform.projects.locations.trainingPipelines.get + description: Gets a Schedule. + operationId: aiplatform.projects.locations.schedules.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47863,7 +55448,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TrainingPipeline' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' parameters: - in: path name: projectsId @@ -47876,13 +55461,23 @@ paths: schema: type: string - in: path - name: trainingPipelinesId + name: schedulesId required: true schema: type: string - delete: - description: Deletes a TrainingPipeline. - operationId: aiplatform.projects.locations.trainingPipelines.delete + patch: + description: >- + Updates an active or paused Schedule. When the Schedule is updated, new + runs will be scheduled starting from the updated next execution time + after the update time based on the time_specification in the updated + Schedule. All unstarted runs before the update time will be skipped + while already created runs will NOT be paused or canceled. + operationId: aiplatform.projects.locations.schedules.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47894,7 +55489,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' parameters: - in: path name: projectsId @@ -47907,30 +55502,73 @@ paths: schema: type: string - in: path - name: trainingPipelinesId + name: schedulesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}:cancel: + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:pause: parameters: *ref_1 post: description: >- - Cancels a TrainingPipeline. Starts asynchronous cancellation on the - TrainingPipeline. The server makes a best effort to cancel the pipeline, - but success is not guaranteed. Clients can use - PipelineService.GetTrainingPipeline or other methods to check whether - the cancellation succeeded or whether the pipeline completed despite - cancellation. On successful cancellation, the TrainingPipeline is not - deleted; instead it becomes a pipeline with a TrainingPipeline.error - value with a google.rpc.Status.code of 1, corresponding to - `Code.CANCELLED`, and TrainingPipeline.state is set to `CANCELLED`. - operationId: aiplatform.projects.locations.trainingPipelines.cancel + Pauses a Schedule. Will mark Schedule.state to 'PAUSED'. If the schedule + is paused, no new runs will be created. Already created runs will NOT be + paused or canceled. + operationId: aiplatform.projects.locations.schedules.pause + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PauseScheduleRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: schedulesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:resume: + parameters: *ref_1 + post: + description: >- + Resumes a paused Schedule to start scheduling new runs. Will mark + Schedule.state to 'ACTIVE'. Only paused Schedule can be resumed. When + the Schedule is resumed, new runs will be scheduled starting from the + next execution time after the current time based on the + time_specification in the Schedule. If Schedule.catch_up is set up true, + all missed runs will be scheduled for backfill first. + operationId: aiplatform.projects.locations.schedules.resume requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CancelTrainingPipelineRequest + #/components/schemas/GoogleCloudAiplatformV1ResumeScheduleRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47955,17 +55593,17 @@ paths: schema: type: string - in: path - name: trainingPipelinesId + name: schedulesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.trainingPipelines.operations.list + operationId: aiplatform.projects.locations.schedules.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47990,7 +55628,7 @@ paths: schema: type: string - in: path - name: trainingPipelinesId + name: schedulesId required: true schema: type: string @@ -48007,14 +55645,14 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}: parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - operationId: aiplatform.projects.locations.trainingPipelines.operations.get + operationId: aiplatform.projects.locations.schedules.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48039,7 +55677,7 @@ paths: schema: type: string - in: path - name: trainingPipelinesId + name: schedulesId required: true schema: type: string @@ -48054,7 +55692,7 @@ paths: is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.trainingPipelines.operations.delete + operationId: aiplatform.projects.locations.schedules.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48079,7 +55717,7 @@ paths: schema: type: string - in: path - name: trainingPipelinesId + name: schedulesId required: true schema: type: string @@ -48088,7 +55726,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- @@ -48100,8 +55738,8 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.trainingPipelines.operations.cancel + `1`, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.schedules.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48126,7 +55764,7 @@ paths: schema: type: string - in: path - name: trainingPipelinesId + name: schedulesId required: true schema: type: string @@ -48135,7 +55773,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- @@ -48148,7 +55786,7 @@ paths: best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. - operationId: aiplatform.projects.locations.trainingPipelines.operations.wait + operationId: aiplatform.projects.locations.schedules.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48173,7 +55811,7 @@ paths: schema: type: string - in: path - name: trainingPipelinesId + name: schedulesId required: true schema: type: string @@ -48187,16 +55825,16 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs: + /v1/projects/{projectsId}/locations/{locationsId}/specialistPools: parameters: *ref_1 post: - description: Creates a PipelineJob. A PipelineJob will run immediately when created. - operationId: aiplatform.projects.locations.pipelineJobs.create + description: Creates a SpecialistPool. + operationId: aiplatform.projects.locations.specialistPools.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJob' + $ref: '#/components/schemas/GoogleCloudAiplatformV1SpecialistPool' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48208,7 +55846,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJob' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -48220,13 +55858,9 @@ paths: required: true schema: type: string - - in: query - name: pipelineJobId - schema: - type: string get: - description: Lists PipelineJobs in a Location. - operationId: aiplatform.projects.locations.pipelineJobs.list + description: Lists SpecialistPools in a Location. + operationId: aiplatform.projects.locations.specialistPools.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48239,7 +55873,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListPipelineJobsResponse + #/components/schemas/GoogleCloudAiplatformV1ListSpecialistPoolsResponse parameters: - in: path name: projectsId @@ -48251,10 +55885,6 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - in: query name: pageSize schema: @@ -48264,20 +55894,16 @@ paths: name: pageToken schema: type: string - - in: query - name: orderBy - schema: - type: string - in: query name: readMask schema: type: string format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}: + /v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}: parameters: *ref_1 get: - description: Gets a PipelineJob. - operationId: aiplatform.projects.locations.pipelineJobs.get + description: Gets a SpecialistPool. + operationId: aiplatform.projects.locations.specialistPools.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48289,7 +55915,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJob' + $ref: '#/components/schemas/GoogleCloudAiplatformV1SpecialistPool' parameters: - in: path name: projectsId @@ -48302,13 +55928,13 @@ paths: schema: type: string - in: path - name: pipelineJobsId + name: specialistPoolsId required: true schema: type: string delete: - description: Deletes a PipelineJob. - operationId: aiplatform.projects.locations.pipelineJobs.delete + description: Deletes a SpecialistPool as well as all Specialists in the pool. + operationId: aiplatform.projects.locations.specialistPools.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48333,67 +55959,22 @@ paths: schema: type: string - in: path - name: pipelineJobsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs:batchDelete: - parameters: *ref_1 - post: - description: >- - Batch deletes PipelineJobs The Operation is atomic. If it fails, none of - the PipelineJobs are deleted. If it succeeds, all of the PipelineJobs - are deleted. - operationId: aiplatform.projects.locations.pipelineJobs.batchDelete - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - - in: path - name: projectsId + name: specialistPoolsId required: true schema: type: string - - in: path - name: locationsId - required: true + - in: query + name: force schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}:cancel: - parameters: *ref_1 - post: - description: >- - Cancels a PipelineJob. Starts asynchronous cancellation on the - PipelineJob. The server makes a best effort to cancel the pipeline, but - success is not guaranteed. Clients can use - PipelineService.GetPipelineJob or other methods to check whether the - cancellation succeeded or whether the pipeline completed despite - cancellation. On successful cancellation, the PipelineJob is not - deleted; instead it becomes a pipeline with a PipelineJob.error value - with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, - and PipelineJob.state is set to `CANCELLED`. - operationId: aiplatform.projects.locations.pipelineJobs.cancel + type: boolean + patch: + description: Updates a SpecialistPool. + operationId: aiplatform.projects.locations.specialistPools.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CancelPipelineJobRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1SpecialistPool' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48405,7 +55986,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -48418,57 +55999,22 @@ paths: schema: type: string - in: path - name: pipelineJobsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs:batchCancel: - parameters: *ref_1 - post: - description: >- - Batch cancel PipelineJobs. Firstly the server will check if all the jobs - are in non-terminal states, and skip the jobs that are already - terminated. If the operation failed, none of the pipeline jobs are - cancelled. The server will poll the states of all the pipeline jobs - periodically to check the cancellation status. This operation will - return an LRO. - operationId: aiplatform.projects.locations.pipelineJobs.batchCancel - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - - in: path - name: projectsId + name: specialistPoolsId required: true schema: type: string - - in: path - name: locationsId - required: true + - in: query + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations: + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.pipelineJobs.operations.list + operationId: aiplatform.projects.locations.specialistPools.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48493,7 +56039,7 @@ paths: schema: type: string - in: path - name: pipelineJobsId + name: specialistPoolsId required: true schema: type: string @@ -48510,14 +56056,14 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}: parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - operationId: aiplatform.projects.locations.pipelineJobs.operations.get + operationId: aiplatform.projects.locations.specialistPools.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48542,7 +56088,7 @@ paths: schema: type: string - in: path - name: pipelineJobsId + name: specialistPoolsId required: true schema: type: string @@ -48557,7 +56103,7 @@ paths: is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.pipelineJobs.operations.delete + operationId: aiplatform.projects.locations.specialistPools.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48582,7 +56128,7 @@ paths: schema: type: string - in: path - name: pipelineJobsId + name: specialistPoolsId required: true schema: type: string @@ -48591,7 +56137,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- @@ -48603,8 +56149,8 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.pipelineJobs.operations.cancel + `1`, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.specialistPools.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48629,7 +56175,7 @@ paths: schema: type: string - in: path - name: pipelineJobsId + name: specialistPoolsId required: true schema: type: string @@ -48638,7 +56184,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- @@ -48651,7 +56197,7 @@ paths: best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. - operationId: aiplatform.projects.locations.pipelineJobs.operations.wait + operationId: aiplatform.projects.locations.specialistPools.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48676,7 +56222,7 @@ paths: schema: type: string - in: path - name: pipelineJobsId + name: specialistPoolsId required: true schema: type: string @@ -48690,16 +56236,16 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/schedules: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards: parameters: *ref_1 post: - description: Creates a Schedule. - operationId: aiplatform.projects.locations.schedules.create + description: Creates a Tensorboard. + operationId: aiplatform.projects.locations.tensorboards.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensorboard' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48711,7 +56257,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -48724,13 +56270,17 @@ paths: schema: type: string get: - description: Lists Schedules in a Location. - operationId: aiplatform.projects.locations.schedules.list + description: Lists Tensorboards in a Location. + operationId: aiplatform.projects.locations.tensorboards.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response @@ -48738,7 +56288,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListSchedulesResponse + #/components/schemas/GoogleCloudAiplatformV1ListTensorboardsResponse parameters: - in: path name: projectsId @@ -48767,23 +56317,32 @@ paths: name: orderBy schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}: + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}: parameters: *ref_1 - delete: - description: Deletes a Schedule. - operationId: aiplatform.projects.locations.schedules.delete + get: + description: Gets a Tensorboard. + operationId: aiplatform.projects.locations.tensorboards.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensorboard' parameters: - in: path name: projectsId @@ -48796,13 +56355,18 @@ paths: schema: type: string - in: path - name: schedulesId + name: tensorboardsId required: true schema: type: string - get: - description: Gets a Schedule. - operationId: aiplatform.projects.locations.schedules.get + patch: + description: Updates a Tensorboard. + operationId: aiplatform.projects.locations.tensorboards.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensorboard' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48814,7 +56378,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -48827,23 +56391,18 @@ paths: schema: type: string - in: path - name: schedulesId + name: tensorboardsId required: true schema: type: string - patch: - description: >- - Updates an active or paused Schedule. When the Schedule is updated, new - runs will be scheduled starting from the updated next execution time - after the update time based on the time_specification in the updated - Schedule. All unstarted runs before the update time will be skipped - while already created runs will NOT be paused or canceled. - operationId: aiplatform.projects.locations.schedules.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a Tensorboard. + operationId: aiplatform.projects.locations.tensorboards.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48855,7 +56414,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -48868,28 +56427,49 @@ paths: schema: type: string - in: path - name: schedulesId + name: tensorboardsId required: true schema: type: string - - in: query - name: updateMask + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readUsage: + parameters: *ref_1 + get: + description: Returns a list of monthly active users for a given TensorBoard instance. + operationId: aiplatform.projects.locations.tensorboards.readUsage + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardUsageResponse + parameters: + - in: path + name: projectsId + required: true schema: type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:pause: + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: tensorboardsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readSize: parameters: *ref_1 - post: - description: >- - Pauses a Schedule. Will mark Schedule.state to 'PAUSED'. If the schedule - is paused, no new runs will be created. Already created runs will NOT be - paused or canceled. - operationId: aiplatform.projects.locations.schedules.pause - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PauseScheduleRequest' + get: + description: Returns the storage size for a given TensorBoard instance. + operationId: aiplatform.projects.locations.tensorboards.readSize security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48901,7 +56481,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardSizeResponse parameters: - in: path name: projectsId @@ -48914,27 +56495,20 @@ paths: schema: type: string - in: path - name: schedulesId + name: tensorboardsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:resume: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:batchRead: parameters: *ref_1 - post: + get: description: >- - Resumes a paused Schedule to start scheduling new runs. Will mark - Schedule.state to 'ACTIVE'. Only paused Schedule can be resumed. When - the Schedule is resumed, new runs will be scheduled starting from the - next execution time after the current time based on the - time_specification in the Schedule. If Schedule.catchUp is set up true, - all missed runs will be scheduled for backfill first. - operationId: aiplatform.projects.locations.schedules.resume - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ResumeScheduleRequest + Reads multiple TensorboardTimeSeries' data. The data point number limit + is 1000 for scalars, 100 for tensors and blob references. If the number + of data points stored is less than the limit, all data is returned. + Otherwise, the number limit of data points is randomly selected from + this time series and returned. + operationId: aiplatform.projects.locations.tensorboards.batchRead security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48946,7 +56520,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchReadTensorboardTimeSeriesDataResponse parameters: - in: path name: projectsId @@ -48959,17 +56534,21 @@ paths: schema: type: string - in: path - name: schedulesId + name: tensorboardsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations: + - in: query + name: timeSeries + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.schedules.operations.list + operationId: aiplatform.projects.locations.tensorboards.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48994,7 +56573,7 @@ paths: schema: type: string - in: path - name: schedulesId + name: tensorboardsId required: true schema: type: string @@ -49011,14 +56590,14 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}: parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - operationId: aiplatform.projects.locations.schedules.operations.get + operationId: aiplatform.projects.locations.tensorboards.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49043,7 +56622,7 @@ paths: schema: type: string - in: path - name: schedulesId + name: tensorboardsId required: true schema: type: string @@ -49058,7 +56637,7 @@ paths: is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.schedules.operations.delete + operationId: aiplatform.projects.locations.tensorboards.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49083,7 +56662,7 @@ paths: schema: type: string - in: path - name: schedulesId + name: tensorboardsId required: true schema: type: string @@ -49092,7 +56671,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- @@ -49104,8 +56683,8 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.schedules.operations.cancel + `1`, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.tensorboards.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49130,7 +56709,7 @@ paths: schema: type: string - in: path - name: schedulesId + name: tensorboardsId required: true schema: type: string @@ -49139,7 +56718,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- @@ -49152,7 +56731,7 @@ paths: best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. - operationId: aiplatform.projects.locations.schedules.operations.wait + operationId: aiplatform.projects.locations.tensorboards.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49177,7 +56756,7 @@ paths: schema: type: string - in: path - name: schedulesId + name: tensorboardsId required: true schema: type: string @@ -49191,16 +56770,17 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/specialistPools: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments: parameters: *ref_1 post: - description: Creates a SpecialistPool. - operationId: aiplatform.projects.locations.specialistPools.create + description: Creates a TensorboardExperiment. + operationId: aiplatform.projects.locations.tensorboards.experiments.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SpecialistPool' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49212,7 +56792,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment parameters: - in: path name: projectsId @@ -49224,9 +56805,125 @@ paths: required: true schema: type: string + - in: path + name: tensorboardsId + required: true + schema: + type: string + - in: query + name: tensorboardExperimentId + schema: + type: string get: - description: Lists SpecialistPools in a Location. - operationId: aiplatform.projects.locations.specialistPools.list + description: Lists TensorboardExperiments in a Location. + operationId: aiplatform.projects.locations.tensorboards.experiments.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListTensorboardExperimentsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: tensorboardsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: orderBy + schema: + type: string + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}: + parameters: *ref_1 + get: + description: Gets a TensorboardExperiment. + operationId: aiplatform.projects.locations.tensorboards.experiments.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: tensorboardsId + required: true + schema: + type: string + - in: path + name: experimentsId + required: true + schema: + type: string + patch: + description: Updates a TensorboardExperiment. + operationId: aiplatform.projects.locations.tensorboards.experiments.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49239,7 +56936,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListSpecialistPoolsResponse + #/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment parameters: - in: path name: projectsId @@ -49251,25 +56948,24 @@ paths: required: true schema: type: string - - in: query - name: pageSize + - in: path + name: tensorboardsId + required: true schema: - type: integer - format: int32 - - in: query - name: pageToken + type: string + - in: path + name: experimentsId + required: true schema: type: string - in: query - name: readMask + name: updateMask schema: type: string format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}: - parameters: *ref_1 - get: - description: Gets a SpecialistPool. - operationId: aiplatform.projects.locations.specialistPools.get + delete: + description: Deletes a TensorboardExperiment. + operationId: aiplatform.projects.locations.tensorboards.experiments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49281,7 +56977,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SpecialistPool' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -49294,13 +56990,28 @@ paths: schema: type: string - in: path - name: specialistPoolsId + name: tensorboardsId required: true schema: type: string - delete: - description: Deletes a SpecialistPool as well as all Specialists in the pool. - operationId: aiplatform.projects.locations.specialistPools.delete + - in: path + name: experimentsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:batchCreate: + parameters: *ref_1 + post: + description: >- + Batch create TensorboardTimeSeries that belong to a + TensorboardExperiment. + operationId: aiplatform.projects.locations.tensorboards.experiments.batchCreate + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49312,7 +57023,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesResponse parameters: - in: path name: projectsId @@ -49325,22 +57037,29 @@ paths: schema: type: string - in: path - name: specialistPoolsId + name: tensorboardsId required: true schema: type: string - - in: query - name: force + - in: path + name: experimentsId + required: true schema: - type: boolean - patch: - description: Updates a SpecialistPool. - operationId: aiplatform.projects.locations.specialistPools.patch + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:write: + parameters: *ref_1 + post: + description: >- + Write time series data points of multiple TensorboardTimeSeries in + multiple TensorboardRun's. If any data fail to be ingested, an error is + returned. + operationId: aiplatform.projects.locations.tensorboards.experiments.write requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SpecialistPool' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49352,7 +57071,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1WriteTensorboardExperimentDataResponse parameters: - in: path name: projectsId @@ -49365,22 +57085,22 @@ paths: schema: type: string - in: path - name: specialistPoolsId + name: tensorboardsId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: experimentsId + required: true schema: type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.specialistPools.operations.list + operationId: aiplatform.projects.locations.tensorboards.experiments.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49405,7 +57125,12 @@ paths: schema: type: string - in: path - name: specialistPoolsId + name: tensorboardsId + required: true + schema: + type: string + - in: path + name: experimentsId required: true schema: type: string @@ -49422,14 +57147,14 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}: parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - operationId: aiplatform.projects.locations.specialistPools.operations.get + operationId: aiplatform.projects.locations.tensorboards.experiments.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49454,7 +57179,12 @@ paths: schema: type: string - in: path - name: specialistPoolsId + name: tensorboardsId + required: true + schema: + type: string + - in: path + name: experimentsId required: true schema: type: string @@ -49469,7 +57199,7 @@ paths: is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.specialistPools.operations.delete + operationId: aiplatform.projects.locations.tensorboards.experiments.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49494,7 +57224,12 @@ paths: schema: type: string - in: path - name: specialistPoolsId + name: tensorboardsId + required: true + schema: + type: string + - in: path + name: experimentsId required: true schema: type: string @@ -49503,7 +57238,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- @@ -49515,8 +57250,8 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.specialistPools.operations.cancel + `1`, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.tensorboards.experiments.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49541,7 +57276,12 @@ paths: schema: type: string - in: path - name: specialistPoolsId + name: tensorboardsId + required: true + schema: + type: string + - in: path + name: experimentsId required: true schema: type: string @@ -49550,7 +57290,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- @@ -49563,7 +57303,7 @@ paths: best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. - operationId: aiplatform.projects.locations.specialistPools.operations.wait + operationId: aiplatform.projects.locations.tensorboards.experiments.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49588,7 +57328,12 @@ paths: schema: type: string - in: path - name: specialistPoolsId + name: tensorboardsId + required: true + schema: + type: string + - in: path + name: experimentsId required: true schema: type: string @@ -49602,16 +57347,16 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs: parameters: *ref_1 post: - description: Creates a Tensorboard. - operationId: aiplatform.projects.locations.tensorboards.create + description: Creates a TensorboardRun. + operationId: aiplatform.projects.locations.tensorboards.experiments.runs.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensorboard' + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49623,7 +57368,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' parameters: - in: path name: projectsId @@ -49635,9 +57380,23 @@ paths: required: true schema: type: string + - in: path + name: tensorboardsId + required: true + schema: + type: string + - in: path + name: experimentsId + required: true + schema: + type: string + - in: query + name: tensorboardRunId + schema: + type: string get: - description: Lists Tensorboards in a Location. - operationId: aiplatform.projects.locations.tensorboards.list + description: Lists TensorboardRuns in a Location. + operationId: aiplatform.projects.locations.tensorboards.experiments.runs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49654,7 +57413,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListTensorboardsResponse + #/components/schemas/GoogleCloudAiplatformV1ListTensorboardRunsResponse parameters: - in: path name: projectsId @@ -49666,6 +57425,16 @@ paths: required: true schema: type: string + - in: path + name: tensorboardsId + required: true + schema: + type: string + - in: path + name: experimentsId + required: true + schema: + type: string - in: query name: filter schema: @@ -49688,27 +57457,30 @@ paths: schema: type: string format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs:batchCreate: parameters: *ref_1 - get: - description: Gets a Tensorboard. - operationId: aiplatform.projects.locations.tensorboards.get + post: + description: Batch create TensorboardRuns. + operationId: aiplatform.projects.locations.tensorboards.experiments.runs.batchCreate + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensorboard' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchCreateTensorboardRunsResponse parameters: - in: path name: projectsId @@ -49725,26 +57497,32 @@ paths: required: true schema: type: string - patch: - description: Updates a Tensorboard. - operationId: aiplatform.projects.locations.tensorboards.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensorboard' + - in: path + name: experimentsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}: + parameters: *ref_1 + get: + description: Gets a TensorboardRun. + operationId: aiplatform.projects.locations.tensorboards.experiments.runs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' parameters: - in: path name: projectsId @@ -49761,14 +57539,24 @@ paths: required: true schema: type: string - - in: query - name: updateMask + - in: path + name: experimentsId + required: true schema: type: string - format: google-fieldmask - delete: - description: Deletes a Tensorboard. - operationId: aiplatform.projects.locations.tensorboards.delete + - in: path + name: runsId + required: true + schema: + type: string + patch: + description: Updates a TensorboardRun. + operationId: aiplatform.projects.locations.tensorboards.experiments.runs.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49780,7 +57568,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' parameters: - in: path name: projectsId @@ -49797,45 +57585,24 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readUsage: - parameters: *ref_1 - get: - description: Returns a list of monthly active users for a given TensorBoard instance. - operationId: aiplatform.projects.locations.tensorboards.readUsage - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardUsageResponse - parameters: - in: path - name: projectsId + name: experimentsId required: true schema: type: string - in: path - name: locationsId + name: runsId required: true schema: type: string - - in: path - name: tensorboardsId - required: true + - in: query + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readSize: - parameters: *ref_1 - get: - description: Returns the storage size for a given TensorBoard instance. - operationId: aiplatform.projects.locations.tensorboards.readSize + format: google-fieldmask + delete: + description: Deletes a TensorboardRun. + operationId: aiplatform.projects.locations.tensorboards.experiments.runs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49847,8 +57614,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardSizeResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -49865,16 +57631,29 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:batchRead: + - in: path + name: experimentsId + required: true + schema: + type: string + - in: path + name: runsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}:write: parameters: *ref_1 - get: + post: description: >- - Reads multiple TensorboardTimeSeries' data. The data point number limit - is 1000 for scalars, 100 for tensors and blob references. If the number - of data points stored is less than the limit, all data is returned. - Otherwise, the number limit of data points is randomly selected from - this time series and returned. - operationId: aiplatform.projects.locations.tensorboards.batchRead + Write time series data points into multiple TensorboardTimeSeries under + a TensorboardRun. If any data fail to be ingested, an error is returned. + operationId: aiplatform.projects.locations.tensorboards.experiments.runs.write + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1WriteTensorboardRunDataRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49887,7 +57666,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchReadTensorboardTimeSeriesDataResponse + #/components/schemas/GoogleCloudAiplatformV1WriteTensorboardRunDataResponse parameters: - in: path name: projectsId @@ -49904,17 +57683,24 @@ paths: required: true schema: type: string - - in: query - name: timeSeries + - in: path + name: experimentsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations: + - in: path + name: runsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.tensorboards.operations.list + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49943,6 +57729,16 @@ paths: required: true schema: type: string + - in: path + name: experimentsId + required: true + schema: + type: string + - in: path + name: runsId + required: true + schema: + type: string - in: query name: filter schema: @@ -49956,14 +57752,15 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}: parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - operationId: aiplatform.projects.locations.tensorboards.operations.get + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -49992,6 +57789,16 @@ paths: required: true schema: type: string + - in: path + name: experimentsId + required: true + schema: + type: string + - in: path + name: runsId + required: true + schema: + type: string - in: path name: operationsId required: true @@ -50003,7 +57810,8 @@ paths: is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.tensorboards.operations.delete + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50032,12 +57840,22 @@ paths: required: true schema: type: string + - in: path + name: experimentsId + required: true + schema: + type: string + - in: path + name: runsId + required: true + schema: + type: string - in: path name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- @@ -50049,8 +57867,9 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.tensorboards.operations.cancel + `1`, corresponding to `Code.CANCELLED`. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50079,12 +57898,22 @@ paths: required: true schema: type: string + - in: path + name: experimentsId + required: true + schema: + type: string + - in: path + name: runsId + required: true + schema: + type: string - in: path name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- @@ -50097,7 +57926,8 @@ paths: best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. - operationId: aiplatform.projects.locations.tensorboards.operations.wait + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50126,6 +57956,16 @@ paths: required: true schema: type: string + - in: path + name: experimentsId + required: true + schema: + type: string + - in: path + name: runsId + required: true + schema: + type: string - in: path name: operationsId required: true @@ -50136,17 +57976,18 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries: parameters: *ref_1 post: - description: Creates a TensorboardExperiment. - operationId: aiplatform.projects.locations.tensorboards.experiments.create + description: Creates a TensorboardTimeSeries. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment + #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50159,7 +58000,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment + #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries parameters: - in: path name: projectsId @@ -50176,13 +58017,24 @@ paths: required: true schema: type: string + - in: path + name: experimentsId + required: true + schema: + type: string + - in: path + name: runsId + required: true + schema: + type: string - in: query - name: tensorboardExperimentId + name: tensorboardTimeSeriesId schema: type: string get: - description: Lists TensorboardExperiments in a Location. - operationId: aiplatform.projects.locations.tensorboards.experiments.list + description: Lists TensorboardTimeSeries in a Location. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50199,7 +58051,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListTensorboardExperimentsResponse + #/components/schemas/GoogleCloudAiplatformV1ListTensorboardTimeSeriesResponse parameters: - in: path name: projectsId @@ -50216,6 +58068,16 @@ paths: required: true schema: type: string + - in: path + name: experimentsId + required: true + schema: + type: string + - in: path + name: runsId + required: true + schema: + type: string - in: query name: filter schema: @@ -50238,11 +58100,12 @@ paths: schema: type: string format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}: parameters: *ref_1 get: - description: Gets a TensorboardExperiment. - operationId: aiplatform.projects.locations.tensorboards.experiments.get + description: Gets a TensorboardTimeSeries. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50259,7 +58122,61 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment + #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: tensorboardsId + required: true + schema: + type: string + - in: path + name: experimentsId + required: true + schema: + type: string + - in: path + name: runsId + required: true + schema: + type: string + - in: path + name: timeSeriesId + required: true + schema: + type: string + patch: + description: Updates a TensorboardTimeSeries. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries parameters: - in: path name: projectsId @@ -50281,15 +58198,25 @@ paths: required: true schema: type: string - patch: - description: Updates a TensorboardExperiment. - operationId: aiplatform.projects.locations.tensorboards.experiments.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment + - in: path + name: runsId + required: true + schema: + type: string + - in: path + name: timeSeriesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a TensorboardTimeSeries. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50301,8 +58228,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -50324,26 +58250,44 @@ paths: required: true schema: type: string - - in: query - name: updateMask + - in: path + name: runsId + required: true schema: type: string - format: google-fieldmask - delete: - description: Deletes a TensorboardExperiment. - operationId: aiplatform.projects.locations.tensorboards.experiments.delete + - in: path + name: timeSeriesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:read: + parameters: *ref_1 + get: + description: >- + Reads a TensorboardTimeSeries' data. By default, if the number of data + points stored is less than 1000, all data is returned. Otherwise, 1000 + data points is randomly selected from this time series and returned. + This value can be changed by changing max_data_points, which can't be + greater than 10k. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.read security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse parameters: - in: path name: projectsId @@ -50365,24 +58309,43 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:batchCreate: + - in: path + name: runsId + required: true + schema: + type: string + - in: path + name: timeSeriesId + required: true + schema: + type: string + - in: query + name: maxDataPoints + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:readBlobData: parameters: *ref_1 - post: + get: description: >- - Batch create TensorboardTimeSeries that belong to a - TensorboardExperiment. - operationId: aiplatform.projects.locations.tensorboards.experiments.batchCreate - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest + Gets bytes of TensorboardBlobs. This is to allow reading blob data + stored in consumer project's Cloud Storage bucket without users having + to obtain Cloud Storage access permission. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.readBlobData security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response @@ -50390,7 +58353,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesResponse + #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardBlobDataResponse parameters: - in: path name: projectsId @@ -50412,20 +58375,34 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:write: + - in: path + name: runsId + required: true + schema: + type: string + - in: path + name: timeSeriesId + required: true + schema: + type: string + - in: query + name: blobIds + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:exportTensorboardTimeSeries: parameters: *ref_1 post: description: >- - Write time series data points of multiple TensorboardTimeSeries in - multiple TensorboardRun's. If any data fail to be ingested, an error is - returned. - operationId: aiplatform.projects.locations.tensorboards.experiments.write + Exports a TensorboardTimeSeries' data. Data is returned in paginated + responses. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.exportTensorboardTimeSeries requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest + #/components/schemas/GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50438,7 +58415,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1WriteTensorboardExperimentDataResponse + #/components/schemas/GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataResponse parameters: - in: path name: projectsId @@ -50460,13 +58437,24 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations: + - in: path + name: runsId + required: true + schema: + type: string + - in: path + name: timeSeriesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.tensorboards.experiments.operations.list + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50500,6 +58488,16 @@ paths: required: true schema: type: string + - in: path + name: runsId + required: true + schema: + type: string + - in: path + name: timeSeriesId + required: true + schema: + type: string - in: query name: filter schema: @@ -50513,14 +58511,15 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}: parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - operationId: aiplatform.projects.locations.tensorboards.experiments.operations.get + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50554,6 +58553,16 @@ paths: required: true schema: type: string + - in: path + name: runsId + required: true + schema: + type: string + - in: path + name: timeSeriesId + required: true + schema: + type: string - in: path name: operationsId required: true @@ -50565,7 +58574,8 @@ paths: is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.tensorboards.experiments.operations.delete + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50599,12 +58609,22 @@ paths: required: true schema: type: string + - in: path + name: runsId + required: true + schema: + type: string + - in: path + name: timeSeriesId + required: true + schema: + type: string - in: path name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- @@ -50616,8 +58636,9 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.tensorboards.experiments.operations.cancel + `1`, corresponding to `Code.CANCELLED`. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50651,12 +58672,22 @@ paths: required: true schema: type: string + - in: path + name: runsId + required: true + schema: + type: string + - in: path + name: timeSeriesId + required: true + schema: + type: string - in: path name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- @@ -50669,7 +58700,8 @@ paths: best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. - operationId: aiplatform.projects.locations.tensorboards.experiments.operations.wait + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50703,6 +58735,16 @@ paths: required: true schema: type: string + - in: path + name: runsId + required: true + schema: + type: string + - in: path + name: timeSeriesId + required: true + schema: + type: string - in: path name: operationsId required: true @@ -50713,16 +58755,18 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs: + /v1/projects/{projectsId}/locations/{locationsId}/studies: parameters: *ref_1 post: - description: Creates a TensorboardRun. - operationId: aiplatform.projects.locations.tensorboards.experiments.runs.create + description: >- + Creates a Study. A resource name will be generated after creation of the + Study. + operationId: aiplatform.projects.locations.studies.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Study' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50734,7 +58778,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Study' parameters: - in: path name: projectsId @@ -50746,32 +58790,14 @@ paths: required: true schema: type: string - - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: query - name: tensorboardRunId - schema: - type: string get: - description: Lists TensorboardRuns in a Location. - operationId: aiplatform.projects.locations.tensorboards.experiments.runs.list + description: Lists all the studies in a region for an associated project. + operationId: aiplatform.projects.locations.studies.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response @@ -50779,7 +58805,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListTensorboardRunsResponse + #/components/schemas/GoogleCloudAiplatformV1ListStudiesResponse parameters: - in: path name: projectsId @@ -50791,18 +58817,8 @@ paths: required: true schema: type: string - - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - in: query - name: filter + name: pageToken schema: type: string - in: query @@ -50810,119 +58826,11 @@ paths: schema: type: integer format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs:batchCreate: - parameters: *ref_1 - post: - description: Batch create TensorboardRuns. - operationId: aiplatform.projects.locations.tensorboards.experiments.runs.batchCreate - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchCreateTensorboardRunsResponse - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}: + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}: parameters: *ref_1 get: - description: Gets a TensorboardRun. - operationId: aiplatform.projects.locations.tensorboards.experiments.runs.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: runsId - required: true - schema: - type: string - patch: - description: Updates a TensorboardRun. - operationId: aiplatform.projects.locations.tensorboards.experiments.runs.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' + description: Gets a Study by name. + operationId: aiplatform.projects.locations.studies.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50934,7 +58842,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Study' parameters: - in: path name: projectsId @@ -50947,28 +58855,13 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: runsId + name: studiesId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask delete: - description: Deletes a TensorboardRun. - operationId: aiplatform.projects.locations.tensorboards.experiments.runs.delete + description: Deletes a Study. + operationId: aiplatform.projects.locations.studies.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -50980,7 +58873,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -50993,33 +58886,22 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: runsId + name: studiesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}:write: + /v1/projects/{projectsId}/locations/{locationsId}/studies:lookup: parameters: *ref_1 post: description: >- - Write time series data points into multiple TensorboardTimeSeries under - a TensorboardRun. If any data fail to be ingested, an error is returned. - operationId: aiplatform.projects.locations.tensorboards.experiments.runs.write + Looks a study up using the user-defined display_name field instead of + the fully qualified resource name. + operationId: aiplatform.projects.locations.studies.lookup requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1WriteTensorboardRunDataRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1LookupStudyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51031,8 +58913,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1WriteTensorboardRunDataResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1Study' parameters: - in: path name: projectsId @@ -51044,29 +58925,13 @@ paths: required: true schema: type: string - - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: runsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.operations.list + operationId: aiplatform.projects.locations.studies.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51091,17 +58956,7 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: runsId + name: studiesId required: true schema: type: string @@ -51118,15 +58973,14 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}: parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.operations.get + operationId: aiplatform.projects.locations.studies.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51151,17 +59005,7 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: runsId + name: studiesId required: true schema: type: string @@ -51176,8 +59020,7 @@ paths: is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.operations.delete + operationId: aiplatform.projects.locations.studies.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51202,17 +59045,7 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: runsId + name: studiesId required: true schema: type: string @@ -51221,7 +59054,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- @@ -51233,9 +59066,8 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.operations.cancel + `1`, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.studies.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51246,31 +59078,21 @@ paths: description: Successful response content: application/json: - schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: - in: path - name: tensorboardsId + name: projectsId required: true schema: type: string - in: path - name: experimentsId + name: locationsId required: true schema: type: string - in: path - name: runsId + name: studiesId required: true schema: type: string @@ -51279,7 +59101,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- @@ -51292,8 +59114,7 @@ paths: best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.operations.wait + operationId: aiplatform.projects.locations.studies.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51318,17 +59139,7 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: runsId + name: studiesId required: true schema: type: string @@ -51342,18 +59153,20 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries: + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:suggest: parameters: *ref_1 post: - description: Creates a TensorboardTimeSeries. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.create + description: >- + Adds one or more Trials to a Study, with parameter values suggested by + Vertex AI Vizier. Returns a long-running operation associated with the + generation of Trial suggestions. When this long-running operation + succeeds, it will contain a SuggestTrialsResponse. + operationId: aiplatform.projects.locations.studies.trials.suggest requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries + $ref: '#/components/schemas/GoogleCloudAiplatformV1SuggestTrialsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51365,8 +59178,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -51379,45 +59191,63 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: studiesId required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials: + parameters: *ref_1 + post: + description: Adds a user provided Trial to a Study. + operationId: aiplatform.projects.locations.studies.trials.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' + parameters: - in: path - name: experimentsId + name: projectsId required: true schema: type: string - in: path - name: runsId + name: locationsId required: true schema: type: string - - in: query - name: tensorboardTimeSeriesId + - in: path + name: studiesId + required: true schema: type: string get: - description: Lists TensorboardTimeSeries in a Location. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.list + description: Lists the Trials associated with a Study. + operationId: aiplatform.projects.locations.studies.trials.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListTensorboardTimeSeriesResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1ListTrialsResponse' parameters: - in: path name: projectsId @@ -51430,22 +59260,12 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: runsId + name: studiesId required: true schema: type: string - in: query - name: filter + name: pageToken schema: type: string - in: query @@ -51453,42 +59273,23 @@ paths: schema: type: integer format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}: + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}: parameters: *ref_1 get: - description: Gets a TensorboardTimeSeries. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.get + description: Gets a Trial. + operationId: aiplatform.projects.locations.studies.trials.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' parameters: - in: path name: projectsId @@ -51501,35 +59302,64 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: studiesId required: true schema: type: string - in: path - name: experimentsId + name: trialsId required: true schema: type: string + delete: + description: Deletes a Trial. + operationId: aiplatform.projects.locations.studies.trials.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: - in: path - name: runsId + name: projectsId required: true schema: type: string - in: path - name: timeSeriesId + name: locationsId required: true schema: type: string - patch: - description: Updates a TensorboardTimeSeries. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.patch + - in: path + name: studiesId + required: true + schema: + type: string + - in: path + name: trialsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:addTrialMeasurement: + parameters: *ref_1 + post: + description: >- + Adds a measurement of the objective metrics to a Trial. This measurement + is assumed to have been taken before the Trial is complete. + operationId: aiplatform.projects.locations.studies.trials.addTrialMeasurement requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries + #/components/schemas/GoogleCloudAiplatformV1AddTrialMeasurementRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51541,8 +59371,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' parameters: - in: path name: projectsId @@ -51555,34 +59384,25 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: runsId + name: studiesId required: true schema: type: string - in: path - name: timeSeriesId + name: trialsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: - description: Deletes a TensorboardTimeSeries. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.delete + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:complete: + parameters: *ref_1 + post: + description: Marks a Trial as complete. + operationId: aiplatform.projects.locations.studies.trials.complete + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CompleteTrialRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51594,7 +59414,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' parameters: - in: path name: projectsId @@ -51607,53 +59427,42 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: runsId + name: studiesId required: true schema: type: string - in: path - name: timeSeriesId + name: trialsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:read: + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:checkTrialEarlyStoppingState: parameters: *ref_1 - get: + post: description: >- - Reads a TensorboardTimeSeries' data. By default, if the number of data - points stored is less than 1000, all data is returned. Otherwise, 1000 - data points is randomly selected from this time series and returned. - This value can be changed by changing max_data_points, which can't be - greater than 10k. + Checks whether a Trial should stop or not. Returns a long-running + operation. When the operation is successful, it will contain a + CheckTrialEarlyStoppingStateResponse. operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.read + aiplatform.projects.locations.studies.trials.checkTrialEarlyStoppingState + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -51666,60 +59475,37 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: runsId + name: studiesId required: true schema: type: string - in: path - name: timeSeriesId + name: trialsId required: true schema: type: string - - in: query - name: maxDataPoints - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:readBlobData: + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:stop: parameters: *ref_1 - get: - description: >- - Gets bytes of TensorboardBlobs. This is to allow reading blob data - stored in consumer project's Cloud Storage bucket without users having - to obtain Cloud Storage access permission. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.readBlobData + post: + description: Stops a Trial. + operationId: aiplatform.projects.locations.studies.trials.stop + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1StopTrialRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardBlobDataResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' parameters: - in: path name: projectsId @@ -51732,43 +59518,29 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: runsId + name: studiesId required: true schema: type: string - in: path - name: timeSeriesId + name: trialsId required: true schema: type: string - - in: query - name: blobIds - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:exportTensorboardTimeSeries: + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:listOptimalTrials: parameters: *ref_1 post: description: >- - Exports a TensorboardTimeSeries' data. Data is returned in paginated - responses. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.exportTensorboardTimeSeries + Lists the pareto-optimal Trials for multi-objective Study or the optimal + Trials for single-objective Study. The definition of pareto-optimal can + be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency + operationId: aiplatform.projects.locations.studies.trials.listOptimalTrials requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest + #/components/schemas/GoogleCloudAiplatformV1ListOptimalTrialsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51781,7 +59553,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataResponse + #/components/schemas/GoogleCloudAiplatformV1ListOptimalTrialsResponse parameters: - in: path name: projectsId @@ -51794,33 +59566,17 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: runsId - required: true - schema: - type: string - - in: path - name: timeSeriesId + name: studiesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.list + operationId: aiplatform.projects.locations.studies.trials.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51845,22 +59601,12 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: runsId + name: studiesId required: true schema: type: string - in: path - name: timeSeriesId + name: trialsId required: true schema: type: string @@ -51877,15 +59623,14 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}: parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.get + operationId: aiplatform.projects.locations.studies.trials.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51910,22 +59655,12 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: runsId + name: studiesId required: true schema: type: string - in: path - name: timeSeriesId + name: trialsId required: true schema: type: string @@ -51940,8 +59675,7 @@ paths: is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.delete + operationId: aiplatform.projects.locations.studies.trials.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -51966,22 +59700,12 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: runsId + name: studiesId required: true schema: type: string - in: path - name: timeSeriesId + name: trialsId required: true schema: type: string @@ -51990,7 +59714,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- @@ -52002,9 +59726,8 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.cancel + `1`, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.studies.trials.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -52029,22 +59752,12 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: runsId + name: studiesId required: true schema: type: string - in: path - name: timeSeriesId + name: trialsId required: true schema: type: string @@ -52053,7 +59766,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- @@ -52066,8 +59779,7 @@ paths: best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.wait + operationId: aiplatform.projects.locations.studies.trials.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -52092,22 +59804,12 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: runsId + name: studiesId required: true schema: type: string - in: path - name: timeSeriesId + name: trialsId required: true schema: type: string @@ -52121,18 +59823,16 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/studies: + /v1/projects/{projectsId}/locations/{locationsId}/ragCorpora: parameters: *ref_1 post: - description: >- - Creates a Study. A resource name will be generated after creation of the - Study. - operationId: aiplatform.projects.locations.studies.create + description: Creates a RagCorpus. + operationId: aiplatform.projects.locations.ragCorpora.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Study' + $ref: '#/components/schemas/GoogleCloudAiplatformV1RagCorpus' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -52144,7 +59844,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Study' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -52157,8 +59857,8 @@ paths: schema: type: string get: - description: Lists all the studies in a region for an associated project. - operationId: aiplatform.projects.locations.studies.list + description: Lists RagCorpora in a Location. + operationId: aiplatform.projects.locations.ragCorpora.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -52171,7 +59871,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListStudiesResponse + #/components/schemas/GoogleCloudAiplatformV1ListRagCorporaResponse parameters: - in: path name: projectsId @@ -52183,20 +59883,25 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - in: query name: pageSize schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}: + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}: parameters: *ref_1 - get: - description: Gets a Study by name. - operationId: aiplatform.projects.locations.studies.get + patch: + description: Updates a RagCorpus. + operationId: aiplatform.projects.locations.ragCorpora.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1RagCorpus' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -52208,7 +59913,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Study' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -52221,13 +59926,13 @@ paths: schema: type: string - in: path - name: studiesId + name: ragCorporaId required: true schema: type: string - delete: - description: Deletes a Study. - operationId: aiplatform.projects.locations.studies.delete + get: + description: Gets a RagCorpus. + operationId: aiplatform.projects.locations.ragCorpora.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -52239,7 +59944,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudAiplatformV1RagCorpus' parameters: - in: path name: projectsId @@ -52252,22 +59957,13 @@ paths: schema: type: string - in: path - name: studiesId + name: ragCorporaId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies:lookup: - parameters: *ref_1 - post: - description: >- - Looks a study up using the user-defined display_name field instead of - the fully qualified resource name. - operationId: aiplatform.projects.locations.studies.lookup - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1LookupStudyRequest' + delete: + description: Deletes a RagCorpus. + operationId: aiplatform.projects.locations.ragCorpora.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -52279,7 +59975,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Study' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -52291,13 +59987,22 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations: + - in: path + name: ragCorporaId + required: true + schema: + type: string + - in: query + name: force + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.studies.operations.list + operationId: aiplatform.projects.locations.ragCorpora.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -52322,7 +60027,7 @@ paths: schema: type: string - in: path - name: studiesId + name: ragCorporaId required: true schema: type: string @@ -52339,14 +60044,14 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}: parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - operationId: aiplatform.projects.locations.studies.operations.get + operationId: aiplatform.projects.locations.ragCorpora.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -52371,7 +60076,7 @@ paths: schema: type: string - in: path - name: studiesId + name: ragCorporaId required: true schema: type: string @@ -52386,7 +60091,7 @@ paths: is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.studies.operations.delete + operationId: aiplatform.projects.locations.ragCorpora.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -52411,7 +60116,7 @@ paths: schema: type: string - in: path - name: studiesId + name: ragCorporaId required: true schema: type: string @@ -52420,7 +60125,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- @@ -52432,8 +60137,8 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.studies.operations.cancel + `1`, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.ragCorpora.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -52458,7 +60163,7 @@ paths: schema: type: string - in: path - name: studiesId + name: ragCorporaId required: true schema: type: string @@ -52467,7 +60172,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}:wait: parameters: *ref_1 post: description: >- @@ -52480,7 +60185,7 @@ paths: best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. - operationId: aiplatform.projects.locations.studies.operations.wait + operationId: aiplatform.projects.locations.ragCorpora.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -52505,7 +60210,7 @@ paths: schema: type: string - in: path - name: studiesId + name: ragCorporaId required: true schema: type: string @@ -52519,20 +60224,17 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:suggest: + /v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles:import: parameters: *ref_1 post: - description: >- - Adds one or more Trials to a Study, with parameter values suggested by - Vertex AI Vizier. Returns a long-running operation associated with the - generation of Trial suggestions. When this long-running operation - succeeds, it will contain a SuggestTrialsResponse. - operationId: aiplatform.projects.locations.studies.trials.suggest + description: Import files from Google Cloud Storage or Google Drive into a RagCorpus. + operationId: aiplatform.projects.locations.ragCorpora.ragFiles.import requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SuggestTrialsRequest' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ImportRagFilesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -52557,20 +60259,15 @@ paths: schema: type: string - in: path - name: studiesId + name: ragCorporaId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials: + /v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}: parameters: *ref_1 - post: - description: Adds a user provided Trial to a Study. - operationId: aiplatform.projects.locations.studies.trials.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' + get: + description: Gets a RagFile. + operationId: aiplatform.projects.locations.ragCorpora.ragFiles.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -52582,7 +60279,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' + $ref: '#/components/schemas/GoogleCloudAiplatformV1RagFile' parameters: - in: path name: projectsId @@ -52595,13 +60292,18 @@ paths: schema: type: string - in: path - name: studiesId + name: ragCorporaId required: true schema: type: string - get: - description: Lists the Trials associated with a Study. - operationId: aiplatform.projects.locations.studies.trials.list + - in: path + name: ragFilesId + required: true + schema: + type: string + delete: + description: Deletes a RagFile. + operationId: aiplatform.projects.locations.ragCorpora.ragFiles.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -52613,7 +60315,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ListTrialsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -52626,24 +60328,24 @@ paths: schema: type: string - in: path - name: studiesId + name: ragCorporaId required: true schema: type: string - - in: query - name: pageToken + - in: path + name: ragFilesId + required: true schema: type: string - in: query - name: pageSize + name: forceDelete schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles: parameters: *ref_1 get: - description: Gets a Trial. - operationId: aiplatform.projects.locations.studies.trials.get + description: Lists RagFiles in a RagCorpus. + operationId: aiplatform.projects.locations.ragCorpora.ragFiles.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -52655,7 +60357,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListRagFilesResponse parameters: - in: path name: projectsId @@ -52668,18 +60371,26 @@ paths: schema: type: string - in: path - name: studiesId + name: ragCorporaId required: true schema: type: string - - in: path - name: trialsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - delete: - description: Deletes a Trial. - operationId: aiplatform.projects.locations.studies.trials.delete + /v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.ragCorpora.ragFiles.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -52691,7 +60402,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -52704,28 +60415,36 @@ paths: schema: type: string - in: path - name: studiesId + name: ragCorporaId required: true schema: type: string - in: path - name: trialsId + name: ragFilesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:addTrialMeasurement: + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}: parameters: *ref_1 - post: + get: description: >- - Adds a measurement of the objective metrics to a Trial. This measurement - is assumed to have been taken before the Trial is complete. - operationId: aiplatform.projects.locations.studies.trials.addTrialMeasurement - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1AddTrialMeasurementRequest + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: aiplatform.projects.locations.ragCorpora.ragFiles.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -52737,7 +60456,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -52750,25 +60469,27 @@ paths: schema: type: string - in: path - name: studiesId + name: ragCorporaId required: true schema: type: string - in: path - name: trialsId + name: ragFilesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:complete: - parameters: *ref_1 - post: - description: Marks a Trial as complete. - operationId: aiplatform.projects.locations.studies.trials.complete - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CompleteTrialRequest' + - in: path + name: operationsId + required: true + schema: + type: string + delete: + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.ragCorpora.ragFiles.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -52780,7 +60501,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -52793,30 +60514,34 @@ paths: schema: type: string - in: path - name: studiesId + name: ragCorporaId required: true schema: type: string - in: path - name: trialsId + name: ragFilesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:checkTrialEarlyStoppingState: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- - Checks whether a Trial should stop or not. Returns a long-running - operation. When the operation is successful, it will contain a - CheckTrialEarlyStoppingStateResponse. - operationId: >- - aiplatform.projects.locations.studies.trials.checkTrialEarlyStoppingState - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + `1`, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.ragCorpora.ragFiles.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -52828,7 +60553,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -52841,25 +60566,34 @@ paths: schema: type: string - in: path - name: studiesId + name: ragCorporaId required: true schema: type: string - in: path - name: trialsId + name: ragFilesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:stop: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}:wait: parameters: *ref_1 post: - description: Stops a Trial. - operationId: aiplatform.projects.locations.studies.trials.stop - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1StopTrialRequest' + description: >- + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It may return the latest state before the specified + timeout (including immediately), meaning even an immediate response is + no guarantee that the operation is done. + operationId: aiplatform.projects.locations.ragCorpora.ragFiles.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -52871,7 +60605,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -52884,29 +60618,37 @@ paths: schema: type: string - in: path - name: studiesId + name: ragCorporaId required: true schema: type: string - in: path - name: trialsId + name: ragFilesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:listOptimalTrials: + - in: path + name: operationsId + required: true + schema: + type: string + - in: query + name: timeout + schema: + type: string + format: google-duration + /v1/batchPredictionJobs: parameters: *ref_1 post: description: >- - Lists the pareto-optimal Trials for multi-objective Study or the optimal - Trials for single-objective Study. The definition of pareto-optimal can - be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency - operationId: aiplatform.projects.locations.studies.trials.listOptimalTrials + Creates a BatchPredictionJob. A BatchPredictionJob once created will + right away be attempted to start. + operationId: aiplatform.batchPredictionJobs.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListOptimalTrialsRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1BatchPredictionJob' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -52918,31 +60660,15 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListOptimalTrialsResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1BatchPredictionJob' parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: studiesId - required: true + - in: query + name: parent schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations: - parameters: *ref_1 get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.studies.trials.operations.list + description: Lists BatchPredictionJobs in a Location. + operationId: aiplatform.batchPredictionJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -52954,26 +60680,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListBatchPredictionJobsResponse parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: studiesId - required: true - schema: - type: string - - in: path - name: trialsId - required: true + - in: query + name: parent schema: type: string - in: query @@ -52986,17 +60697,19 @@ paths: type: integer format: int32 - in: query - name: pageToken + name: pageToken + schema: + type: string + - in: query + name: readMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}: + format: google-fieldmask + /v1/batchPredictionJobs/{batchPredictionJobsId}: parameters: *ref_1 get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: aiplatform.projects.locations.studies.trials.operations.get + description: Gets a BatchPredictionJob + operationId: aiplatform.batchPredictionJobs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -53008,149 +60721,98 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1BatchPredictionJob' parameters: - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: studiesId - required: true - schema: - type: string - - in: path - name: trialsId - required: true - schema: - type: string - - in: path - name: operationsId + name: batchPredictionJobsId required: true schema: type: string - delete: - description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.studies.trials.operations.delete + /v1/endpoints/{endpointsId}:predict: + parameters: *ref_1 + post: + description: Perform an online prediction. + operationId: aiplatform.endpoints.predict + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictResponse' parameters: - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: studiesId - required: true - schema: - type: string - - in: path - name: trialsId - required: true - schema: - type: string - - in: path - name: operationsId + name: endpointsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:cancel: + /v1/endpoints/{endpointsId}:predictLongRunning: parameters: *ref_1 post: - description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.studies.trials.operations.cancel + description: '' + operationId: aiplatform.endpoints.predictLongRunning + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PredictLongRunningRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: studiesId - required: true - schema: - type: string - - in: path - name: trialsId - required: true - schema: - type: string - - in: path - name: operationsId + name: endpointsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:wait: + /v1/endpoints/{endpointsId}:fetchPredictOperation: parameters: *ref_1 post: - description: >- - Waits until the specified long-running operation is done or reaches at - most a specified timeout, returning the latest state. If the operation - is already done, the latest state is immediately returned. If the - timeout specified is greater than the default HTTP/RPC timeout, the - HTTP/RPC timeout is used. If the server does not support this method, it - returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a - best-effort basis. It may return the latest state before the specified - timeout (including immediately), meaning even an immediate response is - no guarantee that the operation is done. - operationId: aiplatform.projects.locations.studies.trials.operations.wait + description: Fetch an asynchronous online prediction operation. + operationId: aiplatform.endpoints.fetchPredictOperation + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FetchPredictOperationRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response @@ -53160,35 +60822,10 @@ paths: $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: studiesId - required: true - schema: - type: string - - in: path - name: trialsId - required: true - schema: - type: string - - in: path - name: operationsId + name: endpointsId required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration /v1/endpoints/{endpointsId}:generateContent: parameters: *ref_1 post: @@ -53315,6 +60952,151 @@ paths: required: true schema: type: string + /v1/endpoints/{endpointsId}/chat/completions: + parameters: *ref_1 + post: + description: Exposes an OpenAI-compatible endpoint for chat completions. + operationId: aiplatform.endpoints.chat.completions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleApiHttpBody' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleApiHttpBody' + parameters: + - in: path + name: endpointsId + required: true + schema: + type: string + /v1/publishers/{publishersId}/models/{modelsId}:predict: + parameters: *ref_1 + post: + description: Perform an online prediction. + operationId: aiplatform.publishers.models.predict + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictResponse' + parameters: + - in: path + name: publishersId + required: true + schema: + type: string + - in: path + name: modelsId + required: true + schema: + type: string + /v1/publishers/{publishersId}/models/{modelsId}:predictLongRunning: + parameters: *ref_1 + post: + description: '' + operationId: aiplatform.publishers.models.predictLongRunning + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PredictLongRunningRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: publishersId + required: true + schema: + type: string + - in: path + name: modelsId + required: true + schema: + type: string + /v1/publishers/{publishersId}/models/{modelsId}:fetchPredictOperation: + parameters: *ref_1 + post: + description: Fetch an asynchronous online prediction operation. + operationId: aiplatform.publishers.models.fetchPredictOperation + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FetchPredictOperationRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: publishersId + required: true + schema: + type: string + - in: path + name: modelsId + required: true + schema: + type: string /v1/publishers/{publishersId}/models/{modelsId}:generateContent: parameters: *ref_1 post: @@ -53505,3 +61287,241 @@ paths: name: huggingFaceToken schema: type: string + /v1/reasoningEngines/{reasoningEnginesId}:query: + parameters: *ref_1 + post: + description: Queries using a reasoning engine. + operationId: aiplatform.reasoningEngines.query + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1QueryReasoningEngineRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1QueryReasoningEngineResponse + parameters: + - in: path + name: reasoningEnginesId + required: true + schema: + type: string + /v1/reasoningEngines/{reasoningEnginesId}:streamQuery: + parameters: *ref_1 + post: + description: Streams queries using a reasoning engine. + operationId: aiplatform.reasoningEngines.streamQuery + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StreamQueryReasoningEngineRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleApiHttpBody' + parameters: + - in: path + name: reasoningEnginesId + required: true + schema: + type: string + /v1/reasoningEngines: + parameters: *ref_1 + post: + description: Creates a reasoning engine. + operationId: aiplatform.reasoningEngines.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ReasoningEngine' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: query + name: parent + schema: + type: string + get: + description: Lists reasoning engines in a location. + operationId: aiplatform.reasoningEngines.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListReasoningEnginesResponse + parameters: + - in: query + name: parent + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/reasoningEngines/{reasoningEnginesId}: + parameters: *ref_1 + get: + description: Gets a reasoning engine. + operationId: aiplatform.reasoningEngines.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ReasoningEngine' + parameters: + - in: path + name: reasoningEnginesId + required: true + schema: + type: string + patch: + description: Updates a reasoning engine. + operationId: aiplatform.reasoningEngines.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ReasoningEngine' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: reasoningEnginesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a reasoning engine. + operationId: aiplatform.reasoningEngines.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: reasoningEnginesId + required: true + schema: + type: string + - in: query + name: force + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles:upload: + parameters: *ref_1 + post: + description: Upload a file into a RagCorpus. + operationId: aiplatform.media.upload + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1UploadRagFileRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1UploadRagFileResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: ragCorporaId + required: true + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/airquality.yaml b/providers/src/googleapis.com/v00.00.00000/services/airquality.yaml index 5b953d57..32410cfc 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/airquality.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/airquality.yaml @@ -7,8 +7,8 @@ info: title: Air Quality API description: The Air Quality API. version: v1 - x-discovery-doc-revision: '20241030' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250826' + x-generated-date: '2025-08-28' externalDocs: url: https://developers.google.com/maps/documentation/air-quality servers: @@ -34,142 +34,28 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - Concentration: - properties: - units: - enum: - - UNIT_UNSPECIFIED - - PARTS_PER_BILLION - - MICROGRAMS_PER_CUBIC_METER - description: Units for measuring this pollutant concentration. - type: string - enumDescriptions: - - Unspecified concentration unit. - - The ppb (parts per billion) concentration unit. - - The "µg/m^3" (micrograms per cubic meter) concentration unit. - value: - type: number - format: float - description: Value of the pollutant concentration. - description: The concentration of a given pollutant in the air. - id: Concentration - type: object - LookupCurrentConditionsResponse: - properties: - regionCode: - description: >- - The ISO_3166-1 alpha-2 code of the country/region corresponding to - the location provided in the request. This field might be omitted - from the response if the location provided in the request resides in - a disputed territory. - type: string - indexes: - description: >- - Based on the request parameters, this list will include (up to) two - air quality indexes: - Universal AQI. Will be returned if the - universalAqi boolean is set to true. - Local AQI. Will be returned - if the LOCAL_AQI extra computation is specified. - type: array - items: - $ref: '#/components/schemas/AirQualityIndex' - healthRecommendations: - description: >- - Health advice and recommended actions related to the reported air - quality conditions. Recommendations are tailored differently for - populations at risk, groups with greater sensitivities to - pollutants, and the general population. - $ref: '#/components/schemas/HealthRecommendations' - dateTime: - format: google-datetime - type: string - description: >- - A rounded down timestamp in RFC3339 UTC "Zulu" format, with - nanosecond resolution and up to nine fractional digits. For example: - "2014-10-02T15:00:00Z". - pollutants: - type: array - items: - $ref: '#/components/schemas/Pollutant' - description: >- - A list of pollutants affecting the location specified in the - request. Note: This field will be returned only for requests that - specified one or more of the following extra computations: - POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, - POLLUTANT_CONCENTRATION. - id: LookupCurrentConditionsResponse - type: object - LookupHistoryResponse: - type: object - properties: - regionCode: - type: string - description: >- - Optional. The ISO_3166-1 alpha-2 code of the country/region - corresponding to the location provided in the request. This field - might be omitted from the response if the location provided in the - request resides in a disputed territory. - hoursInfo: - type: array - items: - $ref: '#/components/schemas/HourInfo' - description: >- - Optional. Contains the air quality information for each hour in the - requested range. For example, if the request is for 48 hours of - history there will be 48 elements of hourly info. - nextPageToken: - type: string - description: Optional. The token to retrieve the next page. - id: LookupHistoryResponse - LookupForecastRequest: - description: The request object of the air quality forecast API. - id: LookupForecastRequest + LookupCurrentConditionsRequest: + id: LookupCurrentConditionsRequest + description: The request definition of the air quality current conditions. type: object properties: - period: - $ref: '#/components/schemas/Interval' - description: >- - Indicates the start and end period for which to get the forecast - data. The timestamp is rounded to the previous exact hour. - dateTime: + location: description: >- - A timestamp for which to return the data for a specific point in - time. The timestamp is rounded to the previous exact hour. Note: - this will return hourly data for the requested timestamp only (i.e. - a single hourly info element). For example, a request sent where the - date_time parameter is set to 2023-01-03T11:05:49Z will be rounded - down to 2023-01-03T11:00:00Z. - format: google-datetime - type: string + Required. The longitude and latitude from which the API looks for + air quality current conditions data. + $ref: '#/components/schemas/LatLng' universalAqi: - type: boolean description: >- Optional. If set to true, the Universal AQI will be included in the - 'indexes' field of the response (default = true). - customLocalAqis: - items: - $ref: '#/components/schemas/CustomLocalAqi' - description: >- - Optional. Expresses a 'country/region to AQI' relationship. Pairs a - country/region with a desired AQI so that air quality data that is - required for that country/region will be displayed according to the - chosen AQI. This parameter can be used to specify a non-default AQI - for a given country, for example, to get the US EPA index for Canada - rather than the default index for Canada. - type: array + 'indexes' field of the response. Default value is true. + type: boolean extraComputations: - type: array description: >- Optional. Additional features that can be optionally enabled. Specifying extra computations will result in the relevant elements and fields to be returned in the response. + type: array items: - enum: - - EXTRA_COMPUTATION_UNSPECIFIED - - LOCAL_AQI - - HEALTH_RECOMMENDATIONS - - POLLUTANT_ADDITIONAL_INFO - - DOMINANT_POLLUTANT_CONCENTRATION - - POLLUTANT_CONCENTRATION type: string enumDescriptions: - >- @@ -207,137 +93,112 @@ components: global and/or local indexes. If specified, each pollutant object contained in the 'pollutants' field in the response will include a `concentration` field when the data is available. - pageSize: - description: >- - Optional. The maximum number of hourly info records to return per - page (default = 24). - type: integer - format: int32 - pageToken: - type: string - description: >- - Optional. A page token received from a previous forecast call. It is - used to retrieve the subsequent page. - location: - description: >- - Required. The latitude and longitude for which the API looks for air - quality data. - $ref: '#/components/schemas/LatLng' + enum: + - EXTRA_COMPUTATION_UNSPECIFIED + - LOCAL_AQI + - HEALTH_RECOMMENDATIONS + - POLLUTANT_ADDITIONAL_INFO + - DOMINANT_POLLUTANT_CONCENTRATION + - POLLUTANT_CONCENTRATION languageCode: - type: string description: >- Optional. Allows the client to choose the language for the response. If data cannot be provided for that language the API uses the - closest match. Allowed values rely on the IETF standard (default = - 'en'). + closest match. Allowed values rely on the IETF standard. Default + value is en. + type: string uaqiColorPalette: description: >- Optional. Determines the color palette used for data provided by the 'Universal Air Quality Index' (UAQI). This color palette is relevant just for UAQI, other AQIs have a predetermined color palette that can't be controlled. + type: string enumDescriptions: - The default value. Ignored if passed as a parameter. - Determines whether to use a red/green palette. - Determines whether to use a indigo/persian palette (dark theme). - Determines whether to use a indigo/persian palette (light theme). - type: string enum: - COLOR_PALETTE_UNSPECIFIED - RED_GREEN - INDIGO_PERSIAN_DARK - INDIGO_PERSIAN_LIGHT - CustomLocalAqi: - description: >- - Expresses a 'country/region to AQI' relationship. Pairs a country/region - with a desired AQI so that air quality data that is required for that - country/region will be displayed according to the chosen AQI. - type: object - id: CustomLocalAqi - properties: - aqi: - type: string - description: >- - The AQI to associate the country/region with. Value should be a - [valid index](/maps/documentation/air-quality/laqis) code. - regionCode: + customLocalAqis: description: >- - The country/region requiring the custom AQI. Value should be - provided using [ISO 3166-1 - alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code. - type: string - LookupForecastResponse: - description: The response object of the air quality forecast API. - type: object - id: LookupForecastResponse - properties: - hourlyForecasts: + Optional. Expresses a 'country/region to AQI' relationship. Pairs a + country/region with a desired AQI so that air quality data that is + required for that country/region will be displayed according to the + chosen AQI. This parameter can be used to specify a non-default AQI + for a given country, for example, to get the US EPA index for Canada + rather than the default index for Canada. type: array - description: >- - Optional. Contains the air quality information for each hour in the - requested range. For example, if the request is for 48 hours of - forecast there will be 48 elements of hourly forecasts. items: - $ref: '#/components/schemas/HourlyForecast' - regionCode: - type: string - description: >- - Optional. The ISO_3166-1 alpha-2 code of the country/region - corresponding to the location provided in the request. This field - might be omitted from the response if the location provided in the - request resides in a disputed territory. - nextPageToken: - description: Optional. The token to retrieve the next page. - type: string + $ref: '#/components/schemas/CustomLocalAqi' LatLng: + id: LatLng description: >- An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. + type: object properties: latitude: + description: The latitude in degrees. It must be in the range [-90.0, +90.0]. type: number format: double - description: The latitude in degrees. It must be in the range [-90.0, +90.0]. longitude: + description: The longitude in degrees. It must be in the range [-180.0, +180.0]. type: number format: double - description: The longitude in degrees. It must be in the range [-180.0, +180.0]. - id: LatLng - type: object - HourInfo: + CustomLocalAqi: + id: CustomLocalAqi description: >- - Contains the air quality information for each hour in the requested - range. For example, if the request is for 48 hours of history there will - be 48 elements of hourly info. + Expresses a 'country/region to AQI' relationship. Pairs a country/region + with a desired AQI so that air quality data that is required for that + country/region will be displayed according to the chosen AQI. + type: object properties: - healthRecommendations: - description: >- - Health advice and recommended actions related to the reported air - quality conditions. Recommendations are tailored differently for - populations at risk, groups with greater sensitivities to - pollutants, and the general population. - $ref: '#/components/schemas/HealthRecommendations' - indexes: - type: array - description: >- - Based on the request parameters, this list will include (up to) two - air quality indexes: - Universal AQI. Will be returned if the - universalAqi boolean is set to true. - Local AQI. Will be returned - if the LOCAL_AQI extra computation is specified. - items: - $ref: '#/components/schemas/AirQualityIndex' - dateTime: + regionCode: description: >- - A rounded down timestamp indicating the time the data refers to in - RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine - fractional digits. For example: "2014-10-02T15:00:00Z". - format: google-datetime + The country/region requiring the custom AQI. Value should be + provided using [ISO 3166-1 + alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code. type: string - pollutants: + aqi: + description: >- + The AQI to associate the country/region with. Value should be a + [valid index](/maps/documentation/air-quality/laqis) code. + type: string + LookupCurrentConditionsResponse: + id: LookupCurrentConditionsResponse + type: object + properties: + dateTime: + description: >- + A rounded down timestamp in RFC3339 UTC "Zulu" format, with + nanosecond resolution and up to nine fractional digits. For example: + "2014-10-02T15:00:00Z". + type: string + format: google-datetime + regionCode: + description: >- + The ISO_3166-1 alpha-2 code of the country/region corresponding to + the location provided in the request. This field might be omitted + from the response if the location provided in the request resides in + a disputed territory. + type: string + indexes: + description: >- + Based on the request parameters, this list will include (up to) two + air quality indexes: - Universal AQI. Will be returned if the + universalAqi boolean is set to true. - Local AQI. Will be returned + if the LOCAL_AQI extra computation is specified. + type: array items: - $ref: '#/components/schemas/Pollutant' + $ref: '#/components/schemas/AirQualityIndex' + pollutants: description: >- A list of pollutants affecting the location specified in the request. Note: This field will be returned only for requests that @@ -345,71 +206,288 @@ components: POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, POLLUTANT_CONCENTRATION. type: array - id: HourInfo + items: + $ref: '#/components/schemas/Pollutant' + healthRecommendations: + description: >- + Health advice and recommended actions related to the reported air + quality conditions. Recommendations are tailored differently for + populations at risk, groups with greater sensitivities to + pollutants, and the general population. + $ref: '#/components/schemas/HealthRecommendations' + AirQualityIndex: + id: AirQualityIndex + description: >- + The basic object for representing different air quality metrics. When + brought together, these metrics provide a snapshot about the current air + quality conditions. There are multiple indexes in the world serving + different purposes and groups interested in measuring different aspects + of air quality. type: object - LookupCurrentConditionsRequest: - description: The request definition of the air quality current conditions. + properties: + code: + description: >- + The index's code. This field represents the index for programming + purposes by using snake case instead of spaces. Examples: "uaqi", + "fra_atmo". + type: string + displayName: + description: >- + A human readable representation of the index name. Example: "AQI + (US)" + type: string + aqi: + description: ' The index''s numeric score. Examples: 10, 100. The value is not normalized and should only be interpreted in the context of its related air-quality index. For non-numeric indexes, this field will not be returned. Note: This field should be used for calculations, graph display, etc. For displaying the index score, you should use the AQI display field.' + type: integer + format: int32 + aqiDisplay: + description: >- + Textual representation of the index numeric score, that may include + prefix or suffix symbols, which usually represents the worst index + score. Example: >100 or 10+. Note: This field should be used when + you want to display the index score. For non-numeric indexes, this + field is empty. + type: string + color: + description: The color used to represent the AQI numeric score. + $ref: '#/components/schemas/Color' + category: + description: >- + Textual classification of the index numeric score interpretation. + For example: "Excellent air quality". + type: string + dominantPollutant: + description: 'The chemical symbol of the dominant pollutant. For example: "CO".' + type: string + Color: + id: Color + description: >- + Represents a color in the RGBA color space. This representation is + designed for simplicity of conversion to and from color representations + in various languages over compactness. For example, the fields of this + representation can be trivially provided to the constructor of + `java.awt.Color` in Java; it can also be trivially provided to UIColor's + `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little + work, it can be easily formatted into a CSS `rgba()` string in + JavaScript. This reference page doesn't have information about the + absolute color space that should be used to interpret the RGB value—for + example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications + should assume the sRGB color space. When color equality needs to be + decided, implementations, unless documented otherwise, treat two colors + as equal if all their red, green, blue, and alpha values each differ by + at most `1e-5`. Example (Java): import com.google.type.Color; // ... + public static java.awt.Color fromProto(Color protocolor) { float alpha = + protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return + new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), + protocolor.getBlue(), alpha); } public static Color + toProto(java.awt.Color color) { float red = (float) color.getRed(); + float green = (float) color.getGreen(); float blue = (float) + color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder + = Color .newBuilder() .setRed(red / denominator) .setGreen(green / + denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); + if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() + .setValue(((float) alpha) / denominator) .build()); } return + resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static + UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; + float green = [protocolor green]; float blue = [protocolor blue]; + FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if + (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return + [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static + Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if + (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return + nil; } Color* result = [[Color alloc] init]; [result setRed:red]; + [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { + [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; + return result; } // ... Example (JavaScript): // ... var protoToCssColor + = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var + greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || + 0.0; var red = Math.floor(redFrac * 255); var green = + Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if + (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } + var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, + green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, + ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var + rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString + = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var + resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { + resultBuilder.push('0'); } resultBuilder.push(hexString); return + resultBuilder.join(''); }; // ... type: object properties: - customLocalAqis: - items: - $ref: '#/components/schemas/CustomLocalAqi' + red: + description: The amount of red in the color as a value in the interval [0, 1]. + type: number + format: float + green: + description: The amount of green in the color as a value in the interval [0, 1]. + type: number + format: float + blue: + description: The amount of blue in the color as a value in the interval [0, 1]. + type: number + format: float + alpha: description: >- - Optional. Expresses a 'country/region to AQI' relationship. Pairs a - country/region with a desired AQI so that air quality data that is - required for that country/region will be displayed according to the - chosen AQI. This parameter can be used to specify a non-default AQI - for a given country, for example, to get the US EPA index for Canada - rather than the default index for Canada. - type: array + The fraction of this color that should be applied to the pixel. That + is, the final pixel color is defined by the equation: `pixel color = + alpha * (this color) + (1.0 - alpha) * (background color)` This + means that a value of 1.0 corresponds to a solid color, whereas a + value of 0.0 corresponds to a completely transparent color. This + uses a wrapper message rather than a simple float scalar so that it + is possible to distinguish between a default value and the value + being unset. If omitted, this color object is rendered as a solid + color (as if the alpha value had been explicitly given a value of + 1.0). + type: number + format: float + Pollutant: + id: Pollutant + description: Data regarding an air quality pollutant. + type: object + properties: + code: + description: >- + The pollutant's code name (for example, "so2"). For a list of + supported pollutant codes, see [Reported + pollutants](/maps/documentation/air-quality/pollutants#reported_pollutants). + type: string + displayName: + description: 'The pollutant''s display name. For example: "NOx".' + type: string + fullName: + description: >- + The pollutant's full name. For chemical compounds, this is the IUPAC + name. Example: "Sulfur Dioxide". For more information about the + IUPAC names table, see + https://iupac.org/what-we-do/periodic-table-of-elements/. + type: string + concentration: + description: >- + The pollutant's concentration level measured by one of the standard + air pollutation measure units. + $ref: '#/components/schemas/Concentration' + additionalInfo: + description: Additional information about the pollutant. + $ref: '#/components/schemas/AdditionalInfo' + Concentration: + id: Concentration + description: The concentration of a given pollutant in the air. + type: object + properties: + value: + description: Value of the pollutant concentration. + type: number + format: float + units: + description: Units for measuring this pollutant concentration. + type: string + enumDescriptions: + - Unspecified concentration unit. + - The ppb (parts per billion) concentration unit. + - The "µg/m^3" (micrograms per cubic meter) concentration unit. + enum: + - UNIT_UNSPECIFIED + - PARTS_PER_BILLION + - MICROGRAMS_PER_CUBIC_METER + AdditionalInfo: + id: AdditionalInfo + description: The emission sources and health effects of a given pollutant. + type: object + properties: + sources: + description: Text representing the pollutant's main emission sources. + type: string + effects: + description: Text representing the pollutant's main health effects. + type: string + HealthRecommendations: + id: HealthRecommendations + description: >- + Health recommendations for different population groups in a free text + format. The recommendations are derived from their associated air + quality conditions. + type: object + properties: + generalPopulation: + description: No specific sensitivities. + type: string + elderly: + description: Retirees and people older than the general population. + type: string + lungDiseasePopulation: + description: Respiratory related problems and asthma suffers. + type: string + heartDiseasePopulation: + description: Heart and circulatory system diseases. + type: string + athletes: + description: Sports and other strenuous outdoor activities. + type: string + pregnantWomen: + description: Women at all stages of pregnancy. + type: string + children: + description: Younger populations including children, toddlers, and babies. + type: string + LookupHistoryRequest: + id: LookupHistoryRequest + description: The request object of the air quality history API. + type: object + properties: + pageSize: + description: >- + Optional. The maximum number of hourly info records to return per + page. The default is 72 and the max value is 168 (7 days of data). + type: integer + format: int32 + pageToken: + description: >- + Optional. A page token received from a previous history call. It is + used to retrieve the subsequent page. Note that when providing a + value for this parameter all other parameters provided must match + the call that provided the page token (the previous call). + type: string location: + description: >- + Required. The latitude and longitude for which the API looks for air + quality history data. $ref: '#/components/schemas/LatLng' + dateTime: description: >- - Required. The longitude and latitude from which the API looks for - air quality current conditions data. + A timestamp for which to return historical data. The timestamp is + rounded to the previous exact hour. Note: this will return hourly + data for the requested timestamp only (i.e. a single hourly info + element). For example, a request sent where the dateTime parameter + is set to 2023-01-03T11:05:49Z will be rounded down to + 2023-01-03T11:00:00Z. A timestamp in RFC3339 UTC "Zulu" format, with + nanosecond resolution and up to nine fractional digits. Examples: + "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z". + type: string + format: google-datetime + hours: + description: >- + Number from 1 to 720 that indicates the hours range for the request. + For example: A value of 48 will yield data from the last 48 hours. + type: integer + format: int32 + period: + description: >- + Indicates the start and end period for which to get the historical + data. The timestamp is rounded to the previous exact hour. + $ref: '#/components/schemas/Interval' universalAqi: - type: boolean description: >- Optional. If set to true, the Universal AQI will be included in the 'indexes' field of the response. Default value is true. - languageCode: - type: string - description: >- - Optional. Allows the client to choose the language for the response. - If data cannot be provided for that language the API uses the - closest match. Allowed values rely on the IETF standard. Default - value is en. - uaqiColorPalette: - enumDescriptions: - - The default value. Ignored if passed as a parameter. - - Determines whether to use a red/green palette. - - Determines whether to use a indigo/persian palette (dark theme). - - Determines whether to use a indigo/persian palette (light theme). - enum: - - COLOR_PALETTE_UNSPECIFIED - - RED_GREEN - - INDIGO_PERSIAN_DARK - - INDIGO_PERSIAN_LIGHT - type: string - description: >- - Optional. Determines the color palette used for data provided by the - 'Universal Air Quality Index' (UAQI). This color palette is relevant - just for UAQI, other AQIs have a predetermined color palette that - can't be controlled. + type: boolean extraComputations: - type: array description: >- Optional. Additional features that can be optionally enabled. Specifying extra computations will result in the relevant elements and fields to be returned in the response. + type: array items: - enum: - - EXTRA_COMPUTATION_UNSPECIFIED - - LOCAL_AQI - - HEALTH_RECOMMENDATIONS - - POLLUTANT_ADDITIONAL_INFO - - DOMINANT_POLLUTANT_CONCENTRATION - - POLLUTANT_CONCENTRATION + type: string enumDescriptions: - >- The default value. The server ignores it if it is passed as a @@ -446,59 +524,63 @@ components: global and/or local indexes. If specified, each pollutant object contained in the 'pollutants' field in the response will include a `concentration` field when the data is available. - type: string - id: LookupCurrentConditionsRequest - AirQualityIndex: - properties: - displayName: + enum: + - EXTRA_COMPUTATION_UNSPECIFIED + - LOCAL_AQI + - HEALTH_RECOMMENDATIONS + - POLLUTANT_ADDITIONAL_INFO + - DOMINANT_POLLUTANT_CONCENTRATION + - POLLUTANT_CONCENTRATION + languageCode: description: >- - A human readable representation of the index name. Example: "AQI - (US)" - type: string - category: + Optional. Allows the client to choose the language for the response. + If data cannot be provided for that language the API uses the + closest match. Allowed values rely on the IETF standard. Default + value is en. type: string + uaqiColorPalette: description: >- - Textual classification of the index numeric score interpretation. - For example: "Excellent air quality". - color: - description: The color used to represent the AQI numeric score. - $ref: '#/components/schemas/Color' - code: - description: >- - The index's code. This field represents the index for programming - purposes by using snake case instead of spaces. Examples: "uaqi", - "fra_atmo". - type: string - aqiDisplay: + Optional. Determines the color palette used for data provided by the + 'Universal Air Quality Index' (UAQI). This color palette is relevant + just for UAQI, other AQIs have a predetermined color palette that + can't be controlled. type: string + enumDescriptions: + - The default value. Ignored if passed as a parameter. + - Determines whether to use a red/green palette. + - Determines whether to use a indigo/persian palette (dark theme). + - Determines whether to use a indigo/persian palette (light theme). + enum: + - COLOR_PALETTE_UNSPECIFIED + - RED_GREEN + - INDIGO_PERSIAN_DARK + - INDIGO_PERSIAN_LIGHT + customLocalAqis: description: >- - Textual representation of the index numeric score, that may include - prefix or suffix symbols, which usually represents the worst index - score. Example: >100 or 10+. Note: This field should be used when - you want to display the index score. For non-numeric indexes, this - field is empty. - dominantPollutant: - type: string - description: 'The chemical symbol of the dominant pollutant. For example: "CO".' - aqi: - description: ' The index''s numeric score. Examples: 10, 100. The value is not normalized and should only be interpreted in the context of its related air-quality index. For non-numeric indexes, this field will not be returned. Note: This field should be used for calculations, graph display, etc. For displaying the index score, you should use the AQI display field.' - format: int32 - type: integer - type: object - id: AirQualityIndex - description: >- - The basic object for representing different air quality metrics. When - brought together, these metrics provide a snapshot about the current air - quality conditions. There are multiple indexes in the world serving - different purposes and groups interested in measuring different aspects - of air quality. + Optional. Expresses a 'country/region to AQI' relationship. Pairs a + country/region with a desired AQI so that air quality data that is + required for that country/region will be displayed according to the + chosen AQI. This parameter can be used to specify a non-default AQI + for a given country, for example, to get the US EPA index for Canada + rather than the default index for Canada. + type: array + items: + $ref: '#/components/schemas/CustomLocalAqi' Interval: + id: Interval + description: >- + Represents a time interval, encoded as a Timestamp start (inclusive) and + a Timestamp end (exclusive). The start must be less than or equal to the + end. When the start equals the end, the interval is empty (matches no + time). When both start and end are unspecified, the interval matches any + time. + type: object properties: startTime: - type: string description: >- Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start. + type: string format: google-datetime endTime: description: >- @@ -506,81 +588,105 @@ components: matching this interval will have to be before the end. type: string format: google-datetime + LookupHistoryResponse: + id: LookupHistoryResponse type: object + properties: + hoursInfo: + description: >- + Optional. Contains the air quality information for each hour in the + requested range. For example, if the request is for 48 hours of + history there will be 48 elements of hourly info. + type: array + items: + $ref: '#/components/schemas/HourInfo' + regionCode: + description: >- + Optional. The ISO_3166-1 alpha-2 code of the country/region + corresponding to the location provided in the request. This field + might be omitted from the response if the location provided in the + request resides in a disputed territory. + type: string + nextPageToken: + description: Optional. The token to retrieve the next page. + type: string + HourInfo: + id: HourInfo description: >- - Represents a time interval, encoded as a Timestamp start (inclusive) and - a Timestamp end (exclusive). The start must be less than or equal to the - end. When the start equals the end, the interval is empty (matches no - time). When both start and end are unspecified, the interval matches any - time. - id: Interval - LookupHistoryRequest: + Contains the air quality information for each hour in the requested + range. For example, if the request is for 48 hours of history there will + be 48 elements of hourly info. type: object properties: - period: + dateTime: description: >- - Indicates the start and end period for which to get the historical - data. The timestamp is rounded to the previous exact hour. - $ref: '#/components/schemas/Interval' - hours: - format: int32 - type: integer + A rounded down timestamp indicating the time the data refers to in + RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine + fractional digits. For example: "2014-10-02T15:00:00Z". + type: string + format: google-datetime + indexes: description: >- - Number from 1 to 720 that indicates the hours range for the request. - For example: A value of 48 will yield data from the last 48 hours. - customLocalAqis: + Based on the request parameters, this list will include (up to) two + air quality indexes: - Universal AQI. Will be returned if the + universalAqi boolean is set to true. - Local AQI. Will be returned + if the LOCAL_AQI extra computation is specified. type: array items: - $ref: '#/components/schemas/CustomLocalAqi' + $ref: '#/components/schemas/AirQualityIndex' + pollutants: description: >- - Optional. Expresses a 'country/region to AQI' relationship. Pairs a - country/region with a desired AQI so that air quality data that is - required for that country/region will be displayed according to the - chosen AQI. This parameter can be used to specify a non-default AQI - for a given country, for example, to get the US EPA index for Canada - rather than the default index for Canada. - location: + A list of pollutants affecting the location specified in the + request. Note: This field will be returned only for requests that + specified one or more of the following extra computations: + POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, + POLLUTANT_CONCENTRATION. + type: array + items: + $ref: '#/components/schemas/Pollutant' + healthRecommendations: description: >- - Required. The latitude and longitude for which the API looks for air - quality history data. - $ref: '#/components/schemas/LatLng' - uaqiColorPalette: - enumDescriptions: - - The default value. Ignored if passed as a parameter. - - Determines whether to use a red/green palette. - - Determines whether to use a indigo/persian palette (dark theme). - - Determines whether to use a indigo/persian palette (light theme). - enum: - - COLOR_PALETTE_UNSPECIFIED - - RED_GREEN - - INDIGO_PERSIAN_DARK - - INDIGO_PERSIAN_LIGHT - type: string + Health advice and recommended actions related to the reported air + quality conditions. Recommendations are tailored differently for + populations at risk, groups with greater sensitivities to + pollutants, and the general population. + $ref: '#/components/schemas/HealthRecommendations' + LookupForecastRequest: + id: LookupForecastRequest + description: The request object of the air quality forecast API. + type: object + properties: + location: description: >- - Optional. Determines the color palette used for data provided by the - 'Universal Air Quality Index' (UAQI). This color palette is relevant - just for UAQI, other AQIs have a predetermined color palette that - can't be controlled. + Required. The latitude and longitude for which the API looks for air + quality data. + $ref: '#/components/schemas/LatLng' dateTime: + description: >- + A timestamp for which to return the data for a specific point in + time. The timestamp is rounded to the previous exact hour. Note: + this will return hourly data for the requested timestamp only (i.e. + a single hourly info element). For example, a request sent where the + date_time parameter is set to 2023-01-03T11:05:49Z will be rounded + down to 2023-01-03T11:00:00Z. type: string format: google-datetime + period: description: >- - A timestamp for which to return historical data. The timestamp is - rounded to the previous exact hour. Note: this will return hourly - data for the requested timestamp only (i.e. a single hourly info - element). For example, a request sent where the dateTime parameter - is set to 2023-01-03T11:05:49Z will be rounded down to - 2023-01-03T11:00:00Z. A timestamp in RFC3339 UTC "Zulu" format, with - nanosecond resolution and up to nine fractional digits. Examples: - "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z". - pageToken: - type: string + Indicates the start and end period for which to get the forecast + data. The timestamp is rounded to the previous exact hour. + $ref: '#/components/schemas/Interval' + universalAqi: description: >- - Optional. A page token received from a previous history call. It is - used to retrieve the subsequent page. Note that when providing a - value for this parameter all other parameters provided must match - the call that provided the page token (the previous call). + Optional. If set to true, the Universal AQI will be included in the + 'indexes' field of the response (default = true). + type: boolean extraComputations: + description: >- + Optional. Additional features that can be optionally enabled. + Specifying extra computations will result in the relevant elements + and fields to be returned in the response. + type: array items: type: string enumDescriptions: @@ -626,61 +732,81 @@ components: - POLLUTANT_ADDITIONAL_INFO - DOMINANT_POLLUTANT_CONCENTRATION - POLLUTANT_CONCENTRATION - type: array - description: >- - Optional. Additional features that can be optionally enabled. - Specifying extra computations will result in the relevant elements - and fields to be returned in the response. languageCode: - type: string description: >- Optional. Allows the client to choose the language for the response. If data cannot be provided for that language the API uses the - closest match. Allowed values rely on the IETF standard. Default - value is en. - universalAqi: - type: boolean + closest match. Allowed values rely on the IETF standard (default = + 'en'). + type: string + uaqiColorPalette: description: >- - Optional. If set to true, the Universal AQI will be included in the - 'indexes' field of the response. Default value is true. + Optional. Determines the color palette used for data provided by the + 'Universal Air Quality Index' (UAQI). This color palette is relevant + just for UAQI, other AQIs have a predetermined color palette that + can't be controlled. + type: string + enumDescriptions: + - The default value. Ignored if passed as a parameter. + - Determines whether to use a red/green palette. + - Determines whether to use a indigo/persian palette (dark theme). + - Determines whether to use a indigo/persian palette (light theme). + enum: + - COLOR_PALETTE_UNSPECIFIED + - RED_GREEN + - INDIGO_PERSIAN_DARK + - INDIGO_PERSIAN_LIGHT + customLocalAqis: + description: >- + Optional. Expresses a 'country/region to AQI' relationship. Pairs a + country/region with a desired AQI so that air quality data that is + required for that country/region will be displayed according to the + chosen AQI. This parameter can be used to specify a non-default AQI + for a given country, for example, to get the US EPA index for Canada + rather than the default index for Canada. + type: array + items: + $ref: '#/components/schemas/CustomLocalAqi' pageSize: + description: >- + Optional. The maximum number of hourly info records to return per + page (default = 24). type: integer format: int32 + pageToken: description: >- - Optional. The maximum number of hourly info records to return per - page. The default is 72 and the max value is 168 (7 days of data). - id: LookupHistoryRequest - description: The request object of the air quality history API. - HealthRecommendations: + Optional. A page token received from a previous forecast call. It is + used to retrieve the subsequent page. + type: string + LookupForecastResponse: + id: LookupForecastResponse + description: The response object of the air quality forecast API. type: object - description: >- - Health recommendations for different population groups in a free text - format. The recommendations are derived from their associated air - quality conditions. properties: - athletes: - description: Sports and other strenuous outdoor activities. - type: string - generalPopulation: - description: No specific sensitivities. - type: string - heartDiseasePopulation: - type: string - description: Heart and circulatory system diseases. - pregnantWomen: - description: Women at all stages of pregnancy. - type: string - lungDiseasePopulation: - type: string - description: Respiratory related problems and asthma suffers. - children: + hourlyForecasts: + description: >- + Optional. Contains the air quality information for each hour in the + requested range. For example, if the request is for 48 hours of + forecast there will be 48 elements of hourly forecasts. + type: array + items: + $ref: '#/components/schemas/HourlyForecast' + regionCode: + description: >- + Optional. The ISO_3166-1 alpha-2 code of the country/region + corresponding to the location provided in the request. This field + might be omitted from the response if the location provided in the + request resides in a disputed territory. type: string - description: Younger populations including children, toddlers, and babies. - elderly: + nextPageToken: + description: Optional. The token to retrieve the next page. type: string - description: Retirees and people older than the general population. - id: HealthRecommendations HourlyForecast: + id: HourlyForecast + description: >- + Contains the air quality information for each hour in the requested + range. For example, if the request is for 48 hours of forecast there + will be 48 elements of hourly forecasts. type: object properties: dateTime: @@ -690,119 +816,34 @@ components: "2014-10-02T15:00:00Z". type: string format: google-datetime - pollutants: - type: array - description: >- - A list of pollutants affecting the location specified in the - request. Note: This field will be returned only for requests that - specified one or more of the following extra computations: - POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, - POLLUTANT_CONCENTRATION. - items: - $ref: '#/components/schemas/Pollutant' - healthRecommendations: - $ref: '#/components/schemas/HealthRecommendations' - description: >- - Health advice and recommended actions related to the reported air - quality conditions. Recommendations are tailored differently for - populations at risk, groups with greater sensitivities to - pollutants, and the general population. indexes: - items: - $ref: '#/components/schemas/AirQualityIndex' description: >- Based on the request parameters, this list will include (up to) two air quality indexes: - Universal AQI. Will be returned if the - `universal_aqi` boolean is set to true. - Local AQI. Will be - returned if the LOCAL_AQI extra computation is specified. - type: array - description: >- - Contains the air quality information for each hour in the requested - range. For example, if the request is for 48 hours of forecast there - will be 48 elements of hourly forecasts. - id: HourlyForecast - Color: - properties: - alpha: - format: float - description: >- - The fraction of this color that should be applied to the pixel. That - is, the final pixel color is defined by the equation: `pixel color = - alpha * (this color) + (1.0 - alpha) * (background color)` This - means that a value of 1.0 corresponds to a solid color, whereas a - value of 0.0 corresponds to a completely transparent color. This - uses a wrapper message rather than a simple float scalar so that it - is possible to distinguish between a default value and the value - being unset. If omitted, this color object is rendered as a solid - color (as if the alpha value had been explicitly given a value of - 1.0). - type: number - red: - format: float - description: The amount of red in the color as a value in the interval [0, 1]. - type: number - blue: - description: The amount of blue in the color as a value in the interval [0, 1]. - type: number - format: float - green: - format: float - type: number - description: The amount of green in the color as a value in the interval [0, 1]. - type: object - id: Color - description: >- - Represents a color in the RGBA color space. This representation is - designed for simplicity of conversion to and from color representations - in various languages over compactness. For example, the fields of this - representation can be trivially provided to the constructor of - `java.awt.Color` in Java; it can also be trivially provided to UIColor's - `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little - work, it can be easily formatted into a CSS `rgba()` string in - JavaScript. This reference page doesn't have information about the - absolute color space that should be used to interpret the RGB value—for - example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications - should assume the sRGB color space. When color equality needs to be - decided, implementations, unless documented otherwise, treat two colors - as equal if all their red, green, blue, and alpha values each differ by - at most `1e-5`. Example (Java): import com.google.type.Color; // ... - public static java.awt.Color fromProto(Color protocolor) { float alpha = - protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return - new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), - protocolor.getBlue(), alpha); } public static Color - toProto(java.awt.Color color) { float red = (float) color.getRed(); - float green = (float) color.getGreen(); float blue = (float) - color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder - = Color .newBuilder() .setRed(red / denominator) .setGreen(green / - denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); - if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() - .setValue(((float) alpha) / denominator) .build()); } return - resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static - UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; - float green = [protocolor green]; float blue = [protocolor blue]; - FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if - (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return - [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static - Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if - (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return - nil; } Color* result = [[Color alloc] init]; [result setRed:red]; - [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { - [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; - return result; } // ... Example (JavaScript): // ... var protoToCssColor - = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var - greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || - 0.0; var red = Math.floor(redFrac * 255); var green = - Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if - (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } - var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, - green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, - ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var - rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString - = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var - resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { - resultBuilder.push('0'); } resultBuilder.push(hexString); return - resultBuilder.join(''); }; // ... + `universal_aqi` boolean is set to true. - Local AQI. Will be + returned if the LOCAL_AQI extra computation is specified. + type: array + items: + $ref: '#/components/schemas/AirQualityIndex' + pollutants: + description: >- + A list of pollutants affecting the location specified in the + request. Note: This field will be returned only for requests that + specified one or more of the following extra computations: + POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, + POLLUTANT_CONCENTRATION. + type: array + items: + $ref: '#/components/schemas/Pollutant' + healthRecommendations: + description: >- + Health advice and recommended actions related to the reported air + quality conditions. Recommendations are tailored differently for + populations at risk, groups with greater sensitivities to + pollutants, and the general population. + $ref: '#/components/schemas/HealthRecommendations' HttpBody: + id: HttpBody description: >- Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw @@ -822,69 +863,34 @@ components: returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. + type: object properties: + contentType: + description: >- + The HTTP Content-Type header value specifying the content type of + the body. + type: string data: description: The HTTP request/response body as raw binary. - format: byte type: string + format: byte extensions: - items: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any description: >- Application specific response metadata. Must be set in the first response for streaming APIs. type: array - contentType: - description: >- - The HTTP Content-Type header value specifying the content type of - the body. - type: string - id: HttpBody - type: object - AdditionalInfo: - properties: - effects: - description: Text representing the pollutant's main health effects. - type: string - sources: - type: string - description: Text representing the pollutant's main emission sources. - type: object - description: The emission sources and health effects of a given pollutant. - id: AdditionalInfo - Pollutant: - id: Pollutant - description: Data regarding an air quality pollutant. - type: object - properties: - additionalInfo: - description: Additional information about the pollutant. - $ref: '#/components/schemas/AdditionalInfo' - concentration: - $ref: '#/components/schemas/Concentration' - description: >- - The pollutant's concentration level measured by one of the standard - air pollutation measure units. - fullName: - type: string - description: >- - The pollutant's full name. For chemical compounds, this is the IUPAC - name. Example: "Sulfur Dioxide". For more information about the - IUPAC names table, see - https://iupac.org/what-we-do/periodic-table-of-elements/. - code: - description: >- - The pollutant's code name (for example, "so2"). For a list of - supported pollutant codes, see [Reported - pollutants](/maps/documentation/air-quality/pollutants#reported_pollutants). - type: string - displayName: - type: string - description: 'The pollutant''s display name. For example: "NOx".' + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. parameters: + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string alt: description: Data format for response. in: query @@ -895,51 +901,18 @@ components: - json - media - proto - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + callback: + description: JSONP in: query - name: upload_protocol + name: callback schema: type: string - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean fields: description: Selector specifying which fields to include in a partial response. in: query name: fields schema: type: string - access_token: - description: OAuth access token. - in: query - name: access_token - schema: - type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string - _.xgafv: - description: V1 error format. - in: query - name: $.xgafv - schema: - type: string - enum: - - '1' - - '2' - callback: - description: JSONP - in: query - name: callback - schema: - type: string key: description: >- API key. Your API key identifies your project and provides you with API @@ -955,6 +928,12 @@ components: 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 @@ -964,6 +943,27 @@ components: name: quotaUser schema: type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' x-stackQL-resources: current_conditions: id: google.airquality.current_conditions @@ -982,6 +982,23 @@ components: update: [] replace: [] delete: [] + history: + id: google.airquality.history + name: history + title: History + methods: + lookup: + operation: + $ref: '#/paths/~1v1~1history:lookup/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] forecast: id: google.airquality.forecast name: forecast @@ -1017,37 +1034,20 @@ components: update: [] replace: [] delete: [] - history: - id: google.airquality.history - name: history - title: History - methods: - lookup: - operation: - $ref: '#/paths/~1v1~1history:lookup/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: [] paths: /v1/currentConditions:lookup: parameters: &ref_1 - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' post: description: >- The Current Conditions endpoint provides hourly air quality information @@ -1073,6 +1073,31 @@ paths: schema: $ref: '#/components/schemas/LookupCurrentConditionsResponse' parameters: [] + /v1/history:lookup: + parameters: *ref_1 + post: + description: >- + Returns air quality history for a specific location for a given time + range. + operationId: airquality.history.lookup + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LookupHistoryRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/LookupHistoryResponse' + parameters: [] /v1/forecast:lookup: parameters: *ref_1 post: @@ -1136,28 +1161,3 @@ paths: required: true schema: type: string - /v1/history:lookup: - parameters: *ref_1 - post: - description: >- - Returns air quality history for a specific location for a given time - range. - operationId: airquality.history.lookup - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/LookupHistoryRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/LookupHistoryResponse' - parameters: [] diff --git a/providers/src/googleapis.com/v00.00.00000/services/alloydb.yaml b/providers/src/googleapis.com/v00.00.00000/services/alloydb.yaml index a74572ca..a3ac0949 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/alloydb.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/alloydb.yaml @@ -18,8 +18,8 @@ info: resources; scale existing PostgreSQL workloads with no application changes; and modernize legacy proprietary databases. version: v1 - x-discovery-doc-revision: '20241023' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250807' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/alloydb/ servers: @@ -156,24 +156,37 @@ components: description: The request message for Operations.CancelOperation. type: object properties: {} - ListClustersResponse: - id: ListClustersResponse - description: Message for response to listing Clusters + RestoreFromCloudSQLRequest: + id: RestoreFromCloudSQLRequest + description: Message for registering Restoring from CloudSQL resource. type: object properties: - clusters: - description: The list of Cluster - type: array - items: - $ref: '#/components/schemas/Cluster' - nextPageToken: - description: A token identifying a page of results the server should return. + cloudsqlBackupRunSource: + description: Cluster created from CloudSQL backup run. + $ref: '#/components/schemas/CloudSQLBackupRunSource' + clusterId: + description: Required. ID of the requesting object. type: string - unreachable: - description: Locations that could not be reached. - type: array - items: - type: string + cluster: + description: Required. The resource being created + $ref: '#/components/schemas/Cluster' + CloudSQLBackupRunSource: + id: CloudSQLBackupRunSource + description: The source CloudSQL backup resource. + type: object + properties: + project: + description: >- + The project ID of the source CloudSQL instance. This should be the + same as the AlloyDB cluster's project. + type: string + instanceId: + description: Required. The CloudSQL instance ID. + type: string + backupRunId: + description: Required. The CloudSQL backup run ID. + type: string + format: int64 Cluster: id: Cluster description: >- @@ -190,6 +203,10 @@ components: description: Output only. Cluster created via DMS migration. readOnly: true $ref: '#/components/schemas/MigrationSource' + cloudsqlBackupRunSource: + description: Output only. Cluster created from CloudSQL snapshot. + readOnly: true + $ref: '#/components/schemas/CloudSQLBackupRunSource' name: description: >- Output only. The name of the cluster resource with the format: * @@ -238,11 +255,8 @@ components: - The state of the cluster is unknown. - The cluster is active and running. - >- - The cluster is stopped. All instances in the cluster are stopped. - Customers can start a stopped cluster at any point and all their - instances will come back to life with same names and IP resources. - In this state, customer pays for storage. Associated backups could - also be present in a stopped cluster. + This is unused. Even when all instances in the cluster are + stopped, the cluster remains in READY state. - >- The cluster is empty and has no associated resources. All instances, associated storage and backups have been deleted. @@ -554,8 +568,8 @@ components: description: >- Optional. The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this - field is not specified, the backup will then use default encryption - scheme to protect the user data. + field is not specified, the backup will use the cluster's encryption + config. $ref: '#/components/schemas/EncryptionConfig' location: description: >- @@ -789,8 +803,7 @@ components: description: >- The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not - specified, the backup will then use default encryption scheme to - protect the user data. + specified, the backup will use the cluster's encryption config. $ref: '#/components/schemas/EncryptionConfig' ContinuousBackupInfo: id: ContinuousBackupInfo @@ -813,9 +826,7 @@ components: type: string format: google-datetime schedule: - description: >- - Output only. Days of the week on which a continuous backup is taken. - Output only field. Ignored if passed into the request. + description: Output only. Days of the week on which a continuous backup is taken. readOnly: true type: array items: @@ -841,7 +852,16 @@ components: earliestRestorableTime: description: >- Output only. The earliest restorable time that can be restored to. - Output only field. + If continuous backups and recovery was recently enabled, the + earliest restorable time is the creation time of the earliest + eligible backup within this cluster's continuous backup recovery + window. After a cluster has had continuous backups enabled for the + duration of its recovery window, the earliest restorable time + becomes "now minus the recovery window". For example, assuming a + point in time recovery is attempted at 04/16/2025 3:23:00PM with a + 14d recovery window, the earliest restorable time would be + 04/02/2025 3:23:00PM. This field is only visible if the + CLUSTER_VIEW_CONTINUOUS_BACKUP cluster view is provided. readOnly: true type: string format: google-datetime @@ -883,6 +903,13 @@ components: Optional. Create an instance that allows connections from Private Service Connect endpoints to the instance. type: boolean + serviceOwnedProjectNumber: + description: >- + Output only. The project number that needs to be allowlisted on the + network attachment to enable outbound connectivity. + readOnly: true + type: string + format: int64 MaintenanceUpdatePolicy: id: MaintenanceUpdatePolicy description: MaintenanceUpdatePolicy defines the policy for system updates. @@ -893,6 +920,11 @@ components: type: array items: $ref: '#/components/schemas/MaintenanceWindow' + denyMaintenancePeriods: + description: Periods to deny maintenance. Currently limited to 1. + type: array + items: + $ref: '#/components/schemas/DenyMaintenancePeriod' MaintenanceWindow: id: MaintenanceWindow description: MaintenanceWindow specifies a preferred day and time for maintenance. @@ -926,6 +958,64 @@ components: Preferred time to start the maintenance operation on the specified day. Maintenance will start within 1 hour of this time. $ref: '#/components/schemas/GoogleTypeTimeOfDay' + DenyMaintenancePeriod: + id: DenyMaintenancePeriod + description: >- + DenyMaintenancePeriod definition. Excepting emergencies, maintenance + will not be scheduled to start within this deny period. The start_date + must be less than the end_date. + type: object + properties: + startDate: + description: >- + Deny period start date. This can be: * A full date, with non-zero + year, month and day values OR * A month and day value, with a zero + year for recurring + $ref: '#/components/schemas/GoogleTypeDate' + endDate: + description: >- + Deny period end date. This can be: * A full date, with non-zero + year, month and day values OR * A month and day value, with a zero + year for recurring + $ref: '#/components/schemas/GoogleTypeDate' + time: + description: >- + Time in UTC when the deny period starts on start_date and ends on + end_date. This can be: * Full time OR * All zeros for 00:00:00 UTC + $ref: '#/components/schemas/GoogleTypeTimeOfDay' + GoogleTypeDate: + id: GoogleTypeDate + description: >- + Represents a whole or partial calendar date, such as a birthday. The + time of day and time zone are either specified elsewhere or are + insignificant. The date is relative to the Gregorian Calendar. This can + represent one of the following: * A full date, with non-zero year, + month, and day values. * A month and day, with a zero year (for example, + an anniversary). * A year on its own, with a zero month and a zero day. + * A year and month, with a zero day (for example, a credit card + expiration date). Related types: * google.type.TimeOfDay * + google.type.DateTime * google.protobuf.Timestamp + type: object + properties: + year: + description: >- + Year of the date. Must be from 1 to 9999, or 0 to specify a date + without a year. + type: integer + format: int32 + month: + description: >- + Month of a year. Must be from 1 to 12, or 0 to specify a year + without a month and day. + type: integer + format: int32 + day: + description: >- + Day of a month. Must be from 1 to 31 and valid for the year and + month, or 0 to specify a year by itself or a year and month where + the day isn't significant. + type: integer + format: int32 MaintenanceSchedule: id: MaintenanceSchedule description: >- @@ -962,6 +1052,180 @@ components: description: grace end time of the cluster. type: string format: google-datetime + ListClustersResponse: + id: ListClustersResponse + description: Message for response to listing Clusters + type: object + properties: + clusters: + description: The list of Cluster + type: array + items: + $ref: '#/components/schemas/Cluster' + nextPageToken: + description: A token identifying a page of results the server should return. + type: string + unreachable: + description: Locations that could not be reached. + type: array + items: + type: string + ExportClusterRequest: + id: ExportClusterRequest + description: Export cluster request. + type: object + properties: + gcsDestination: + description: Required. Option to export data to cloud storage. + $ref: '#/components/schemas/GcsDestination' + csvExportOptions: + description: >- + Options for exporting data in CSV format. Required field to be set + for CSV file type. + $ref: '#/components/schemas/CsvExportOptions' + sqlExportOptions: + description: >- + Options for exporting data in SQL format. Required field to be set + for SQL file type. + $ref: '#/components/schemas/SqlExportOptions' + database: + description: >- + Required. Name of the database where the export command will be + executed. Note - Value provided should be the same as expected from + `SELECT current_database();` and NOT as a resource reference. + type: string + GcsDestination: + id: GcsDestination + description: Destination for Export. Export will be done to cloud storage. + type: object + properties: + uri: + description: >- + Required. The path to the file in Google Cloud Storage where the + export will be stored. The URI is in the form + `gs://bucketName/fileName`. + type: string + CsvExportOptions: + id: CsvExportOptions + description: Options for exporting data in CSV format. + type: object + properties: + selectQuery: + description: Required. The SELECT query used to extract the data. + type: string + fieldDelimiter: + description: >- + Optional. Specifies the character that separates columns within each + row (line) of the file. The default is comma. The value of this + argument has to be a character in Hex ASCII Code. + type: string + quoteCharacter: + description: >- + Optional. Specifies the quoting character to be used when a data + value is quoted. The default is double-quote. The value of this + argument has to be a character in Hex ASCII Code. + type: string + escapeCharacter: + description: >- + Optional. Specifies the character that should appear before a data + character that needs to be escaped. The default is the same as quote + character. The value of this argument has to be a character in Hex + ASCII Code. + type: string + SqlExportOptions: + id: SqlExportOptions + description: Options for exporting data in SQL format. + type: object + properties: + tables: + description: Optional. Tables to export from. + type: array + items: + type: string + schemaOnly: + description: Optional. If true, only export the schema. + type: boolean + cleanTargetObjects: + description: >- + Optional. If true, output commands to DROP all the dumped database + objects prior to outputting the commands for creating them. + type: boolean + ifExistTargetObjects: + description: >- + Optional. If true, use DROP ... IF EXISTS commands to check for the + object's existence before dropping it in clean_target_objects mode. + type: boolean + ImportClusterRequest: + id: ImportClusterRequest + description: Import cluster request. + type: object + properties: + sqlImportOptions: + description: Options for importing data in SQL format. + $ref: '#/components/schemas/SqlImportOptions' + csvImportOptions: + description: Options for importing data in CSV format. + $ref: '#/components/schemas/CsvImportOptions' + gcsUri: + description: >- + Required. The path to the file in Google Cloud Storage where the + source file for import will be stored. The URI is in the form + `gs://bucketName/fileName`. + type: string + database: + description: >- + Optional. Name of the database to which the import will be done. For + import from SQL file, this is required only if the file does not + specify a database. Note - Value provided should be the same as + expected from `SELECT current_database();` and NOT as a resource + reference. + type: string + user: + description: >- + Optional. Database user to be used for importing the data. Note - + Value provided should be the same as expected from `SELECT + current_user;` and NOT as a resource reference. + type: string + SqlImportOptions: + id: SqlImportOptions + description: Options for importing data in SQL format. + type: object + properties: {} + CsvImportOptions: + id: CsvImportOptions + description: Options for importing data in CSV format. + type: object + properties: + table: + description: Required. The database table to import CSV file into. + type: string + columns: + description: >- + Optional. The columns to which CSV data is imported. If not + specified, all columns of the database table are loaded with CSV + data. + type: array + items: + type: string + fieldDelimiter: + description: >- + Optional. Specifies the character that separates columns within each + row (line) of the file. The default is comma. The value of this + argument has to be a character in Hex ASCII Code. + type: string + quoteCharacter: + description: >- + Optional. Specifies the quoting character to be used when a data + value is quoted. The default is double-quote. The value of this + argument has to be a character in Hex ASCII Code. + type: string + escapeCharacter: + description: >- + Optional. Specifies the character that should appear before a data + character that needs to be escaped. The default is same as quote + character. The value of this argument has to be a character in Hex + ASCII Code. + type: string UpgradeClusterRequest: id: UpgradeClusterRequest description: Upgrades a cluster. @@ -1077,7 +1341,7 @@ components: id: RestoreClusterRequest description: >- Message for restoring a Cluster from a backup or another cluster at a - given point in time. + given point in time. NEXT_ID: 11 type: object properties: backupSource: @@ -1316,6 +1580,9 @@ components: queryInsightsConfig: description: Configuration for query insights. $ref: '#/components/schemas/QueryInsightsInstanceConfig' + observabilityConfig: + description: Configuration for observability. + $ref: '#/components/schemas/ObservabilityInstanceConfig' readPoolConfig: description: >- Read pool instance configuration. This is required if the value of @@ -1377,6 +1644,24 @@ components: type: array items: type: string + activationPolicy: + description: >- + Optional. Specifies whether an instance needs to spin up. Once the + instance is active, the activation policy can be updated to the + `NEVER` to stop the instance. Likewise, the activation policy can be + updated to `ALWAYS` to start the instance. There are restrictions + around when an instance can/cannot be activated (for example, a read + pool instance should be stopped before stopping primary etc.). + Please refer to the API documentation for more details. + type: string + enumDescriptions: + - The policy is not specified. + - The instance is running. + - The instance is not running. + enum: + - ACTIVATION_POLICY_UNSPECIFIED + - ALWAYS + - NEVER MachineConfig: id: MachineConfig description: MachineConfig describes the configuration of a machine. @@ -1386,29 +1671,41 @@ components: description: The number of CPU's in the VM instance. type: integer format: int32 + machineType: + description: >- + Machine type of the VM instance. E.g. "n2-highmem-4", + "n2-highmem-8", "c4a-highmem-4-lssd". cpu_count must match the + number of vCPUs in the machine type. + type: string Node: id: Node description: >- Details of a single node in the instance. Nodes in an AlloyDB instance - are ephemereal, they can change during update, failover, autohealing and + are ephemeral, they can change during update, failover, autohealing and resize operations. type: object properties: zoneId: - description: The Compute Engine zone of the VM e.g. "us-central1-b". + description: Output only. The Compute Engine zone of the VM e.g. "us-central1-b". + readOnly: true type: string id: - description: The identifier of the VM e.g. "test-read-0601-407e52be-ms3l". + description: >- + Output only. The identifier of the VM e.g. + "test-read-0601-407e52be-ms3l". + readOnly: true type: string ip: - description: The private IP address of the VM e.g. "10.57.0.34". + description: Output only. The private IP address of the VM e.g. "10.57.0.34". + readOnly: true type: string state: description: >- - Determined by state of the compute VM and postgres-service health. - Compute VM state can have values listed in + Output only. Determined by state of the compute VM and + postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY. + readOnly: true type: string QueryInsightsInstanceConfig: id: QueryInsightsInstanceConfig @@ -1438,6 +1735,56 @@ components: and 20 is considered valid. type: integer format: uint32 + ObservabilityInstanceConfig: + id: ObservabilityInstanceConfig + description: Observability Instance specific configuration. + type: object + properties: + enabled: + description: >- + Observability feature status for an instance. This flag is turned + "off" by default. + type: boolean + preserveComments: + description: >- + Preserve comments in query string for an instance. This flag is + turned "off" by default. + type: boolean + trackWaitEvents: + description: >- + Track wait events during query execution for an instance. This flag + is turned "on" by default but tracking is enabled only after + observability enabled flag is also turned on. + type: boolean + trackWaitEventTypes: + description: >- + Output only. Track wait event types during query execution for an + instance. This flag is turned "on" by default but tracking is + enabled only after observability enabled flag is also turned on. + This is read-only flag and only modifiable by internal API. + readOnly: true + type: boolean + maxQueryStringLength: + description: Query string length. The default value is 10k. + type: integer + format: int32 + recordApplicationTags: + description: >- + Record application tags for an instance. This flag is turned "off" + by default. + type: boolean + queryPlansPerMinute: + description: >- + Number of query execution plans captured by Insights per minute for + all queries combined. The default value is 200. Any integer between + 0 to 200 is considered valid. + type: integer + format: int32 + trackActiveQueries: + description: >- + Track actively running queries on the instance. If not set, this + flag is "off" by default. + type: boolean ReadPoolConfig: id: ReadPoolConfig description: Configuration for a read pool instance. @@ -1487,6 +1834,85 @@ components: convention: ...alloydb-psc.goog readOnly: true type: string + pscInterfaceConfigs: + description: >- + Optional. Configurations for setting up PSC interfaces attached to + the instance which are used for outbound connectivity. Only primary + instances can have PSC interface attached. Currently we only support + 0 or 1 PSC interface. + type: array + items: + $ref: '#/components/schemas/PscInterfaceConfig' + pscAutoConnections: + description: Optional. Configurations for setting up PSC service automation. + type: array + items: + $ref: '#/components/schemas/PscAutoConnectionConfig' + PscInterfaceConfig: + id: PscInterfaceConfig + description: >- + Configuration for setting up a PSC interface to enable outbound + connectivity. + type: object + properties: + networkAttachmentResource: + description: >- + The network attachment resource created in the consumer network to + which the PSC interface will be linked. This is of the format: + "projects/${CONSUMER_PROJECT}/regions/${REGION}/networkAttachments/${NETWORK_ATTACHMENT_NAME}". + The network attachment must be in the same region as the instance. + type: string + PscAutoConnectionConfig: + id: PscAutoConnectionConfig + description: >- + Configuration for setting up PSC service automation. Consumer projects + in the configs will be allowlisted automatically for the instance. + type: object + properties: + consumerProject: + description: >- + The consumer project to which the PSC service automation endpoint + will be created. + type: string + consumerNetwork: + description: >- + The consumer network for the PSC service automation, example: + "projects/vpc-host-project/global/networks/default". The consumer + network might be hosted a different project than the consumer + project. + type: string + ipAddress: + description: Output only. The IP address of the PSC service automation endpoint. + readOnly: true + type: string + status: + description: >- + Output only. The status of the PSC service automation connection. + Possible values: "STATE_UNSPECIFIED" - An invalid state as the + default case. "ACTIVE" - The connection has been created + successfully. "FAILED" - The connection is not functional since some + resources on the connection fail to be created. "CREATING" - The + connection is being created. "DELETING" - The connection is being + deleted. "CREATE_REPAIRING" - The connection is being repaired to + complete creation. "DELETE_REPAIRING" - The connection is being + repaired to complete deletion. + readOnly: true + type: string + consumerNetworkStatus: + description: >- + Output only. The status of the service connection policy. Possible + values: "STATE_UNSPECIFIED" - Default state, when Connection Map is + created initially. "VALID" - Set when policy and map configuration + is valid, and their matching can lead to allowing creation of PSC + Connections subject to other constraints like connections limit. + "CONNECTION_POLICY_MISSING" - No Service Connection Policy found for + this network and Service Class "POLICY_LIMIT_REACHED" - Service + Connection Policy limit reached for this network and Service Class + "CONSUMER_INSTANCE_PROJECT_NOT_ALLOWLISTED" - The consumer instance + project is not in AllowedGoogleProducersResourceHierarchyLevels of + the matching ServiceConnectionPolicy. + readOnly: true + type: string InstanceNetworkConfig: id: InstanceNetworkConfig description: Metadata related to instance-level network configuration. @@ -1507,6 +1933,26 @@ components: Optional. Enabling an outbound public IP address to support a database server sending requests out into the internet. type: boolean + network: + description: >- + Output only. The resource link for the VPC network in which instance + resources are created and from which they are accessible via Private + IP. This will be the same value as the parent cluster's network. It + is specified in the form: // + `projects/{project_number}/global/networks/{network_id}`. + readOnly: true + type: string + allocatedIpRangeOverride: + description: >- + Optional. Name of the allocated IP range for the private IP AlloyDB + instance, for example: "google-managed-services-default". If set, + the instance IPs will be created from this allocated range and will + override the IP range used by the parent cluster. The range name + must comply with [RFC + 1035](http://datatracker.ietf.org/doc/html/rfc1035). Specifically, + the name must be 1-63 characters long and match the regular + expression [a-z]([-a-z0-9]*[a-z0-9])?. + type: string AuthorizedNetwork: id: AuthorizedNetwork description: AuthorizedNetwork contains metadata for an authorized network. @@ -1660,7 +2106,10 @@ components: type: string format: google-datetime updateTime: - description: Output only. Update time stamp + description: >- + Output only. Update time stamp Users should not infer any meaning + from this field. Its value is generally unrelated to the timing of + the backup creation operation. readOnly: true type: string format: google-datetime @@ -1669,6 +2118,11 @@ components: readOnly: true type: string format: google-datetime + createCompletionTime: + description: Output only. Timestamp when the resource finished being created. + readOnly: true + type: string + format: google-datetime labels: description: Labels as key value pairs type: object @@ -1867,6 +2321,13 @@ components: integerRestrictions: description: Restriction on INTEGER type value. $ref: '#/components/schemas/IntegerRestrictions' + recommendedStringValue: + description: The recommended value for a STRING flag. + type: string + recommendedIntegerValue: + description: The recommended value for an INTEGER flag. + type: string + format: int64 name: description: >- The name of the flag resource, following Google Cloud conventions, @@ -1927,6 +2388,17 @@ components: the backend will automatically restart the database (making sure to satisfy any availability SLO's). type: boolean + scope: + description: The scope of the flag. + type: string + enumDescriptions: + - The scope of the flag is not specified. Default is DATABASE. + - The flag is a database flag. + - The flag is a connection pool flag. + enum: + - SCOPE_UNSPECIFIED + - DATABASE + - CONNECTION_POOL StringRestrictions: id: StringRestrictions description: Restrictions on STRING type values @@ -2093,6 +2565,10 @@ components: description: Represents the metadata of the long-running operation. type: object properties: + upgradeClusterStatus: + description: Output only. UpgradeClusterStatus related metadata. + readOnly: true + $ref: '#/components/schemas/UpgradeClusterStatus' createTime: description: Output only. The time the operation was created. readOnly: true @@ -2121,14 +2597,217 @@ components: description: >- Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled - have Operation.error value with a google.rpc.Status.code of 1, - corresponding to `Code.CANCELLED`. + have google.longrunning.Operation.error value with a + google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. readOnly: true type: boolean apiVersion: description: Output only. API version used to start the operation. readOnly: true type: string + UpgradeClusterStatus: + id: UpgradeClusterStatus + description: Message for current status of the Major Version Upgrade operation. + type: object + properties: + state: + description: Cluster Major Version Upgrade state. + type: string + enumDescriptions: + - Unspecified status. + - Not started. + - In progress. + - Operation succeeded. + - Operation failed. + - Operation partially succeeded. + - Cancel is in progress. + - Cancellation complete. + enum: + - STATUS_UNSPECIFIED + - NOT_STARTED + - IN_PROGRESS + - SUCCESS + - FAILED + - PARTIAL_SUCCESS + - CANCEL_IN_PROGRESS + - CANCELLED + cancellable: + description: Whether the operation is cancellable. + type: boolean + sourceVersion: + description: Source database major version. + type: string + enumDescriptions: + - This is an unknown database version. + - DEPRECATED - The database version is Postgres 13. + - The database version is Postgres 14. + - The database version is Postgres 15. + - The database version is Postgres 16. + enumDeprecated: + - false + - true + - false + - false + - false + enum: + - DATABASE_VERSION_UNSPECIFIED + - POSTGRES_13 + - POSTGRES_14 + - POSTGRES_15 + - POSTGRES_16 + targetVersion: + description: Target database major version. + type: string + enumDescriptions: + - This is an unknown database version. + - DEPRECATED - The database version is Postgres 13. + - The database version is Postgres 14. + - The database version is Postgres 15. + - The database version is Postgres 16. + enumDeprecated: + - false + - true + - false + - false + - false + enum: + - DATABASE_VERSION_UNSPECIFIED + - POSTGRES_13 + - POSTGRES_14 + - POSTGRES_15 + - POSTGRES_16 + stages: + description: Status of all upgrade stages. + type: array + items: + $ref: '#/components/schemas/StageStatus' + StageStatus: + id: StageStatus + description: Status of an upgrade stage. + type: object + properties: + readPoolInstancesUpgrade: + description: Read pool instances upgrade metadata. + $ref: '#/components/schemas/ReadPoolInstancesUpgradeStageStatus' + stage: + description: Upgrade stage. + type: string + enumDescriptions: + - Unspecified stage. + - Pre-upgrade custom checks, not covered by pg_upgrade. + - Pre-upgrade pg_upgrade checks. + - Clone the original cluster. + - Upgrade the primary instance(downtime). + - This stage is read pool upgrade. + - Rollback in case of critical failures. + - Cleanup. + enum: + - STAGE_UNSPECIFIED + - ALLOYDB_PRECHECK + - PG_UPGRADE_CHECK + - PREPARE_FOR_UPGRADE + - PRIMARY_INSTANCE_UPGRADE + - READ_POOL_INSTANCES_UPGRADE + - ROLLBACK + - CLEANUP + state: + description: State of this stage. + type: string + enumDescriptions: + - Unspecified status. + - Not started. + - In progress. + - Operation succeeded. + - Operation failed. + - Operation partially succeeded. + - Cancel is in progress. + - Cancellation complete. + enum: + - STATUS_UNSPECIFIED + - NOT_STARTED + - IN_PROGRESS + - SUCCESS + - FAILED + - PARTIAL_SUCCESS + - CANCEL_IN_PROGRESS + - CANCELLED + schedule: + description: Output only. Timing information for the stage execution. + readOnly: true + $ref: '#/components/schemas/StageSchedule' + ReadPoolInstancesUpgradeStageStatus: + id: ReadPoolInstancesUpgradeStageStatus + description: Read pool instances upgrade specific status. + type: object + properties: + upgradeStats: + description: Read pool instances upgrade statistics. + $ref: '#/components/schemas/Stats' + Stats: + id: Stats + description: Upgrade stats for read pool instances. + type: object + properties: + notStarted: + description: Number of read pool instances for which upgrade has not started. + type: integer + format: int32 + ongoing: + description: Number of read pool instances undergoing upgrade. + type: integer + format: int32 + success: + description: Number of read pool instances successfully upgraded. + type: integer + format: int32 + failed: + description: Number of read pool instances which failed to upgrade. + type: integer + format: int32 + StageSchedule: + id: StageSchedule + description: Timing information for the stage execution. + type: object + properties: + estimatedStartTime: + description: >- + When the stage is expected to start. Set only if the stage has not + started yet. + type: string + format: google-datetime + actualStartTime: + description: Actual start time of the stage. Set only if the stage has started. + type: string + format: google-datetime + estimatedEndTime: + description: >- + When the stage is expected to end. Set only if the stage has not + completed yet. + type: string + format: google-datetime + actualEndTime: + description: Actual end time of the stage. Set only if the stage has completed. + type: string + format: google-datetime + ExportClusterResponse: + id: ExportClusterResponse + description: Response of export cluster rpc. + type: object + properties: + gcsDestination: + description: Required. Option to export data to cloud storage. + $ref: '#/components/schemas/GcsDestination' + ImportClusterResponse: + id: ImportClusterResponse + description: Response of import rpc. + type: object + properties: + bytesDownloaded: + description: >- + Required. Size of the object downloaded from Google Cloud Storage in + bytes. + type: string + format: int64 UpgradeClusterResponse: id: UpgradeClusterResponse description: >- @@ -2302,7 +2981,7 @@ components: type: string InstanceUpgradeDetails: id: InstanceUpgradeDetails - description: Details regarding the upgrade of instaces associated with a cluster. + description: Details regarding the upgrade of instances associated with a cluster. type: object properties: name: @@ -2353,7 +3032,8 @@ components: id: StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed description: >- DatabaseResourceFeed is the top level proto to be used to ingest - different database resource level events into Condor platform. + different database resource level events into Condor platform. Next ID: + 11 type: object properties: resourceId: @@ -2376,12 +3056,16 @@ components: - Database resource monitoring data - Database resource security health signal data - Database resource recommendation signal data + - Database config based signal data + - Database resource metadata from BackupDR enum: - FEEDTYPE_UNSPECIFIED - RESOURCE_METADATA - OBSERVABILITY_DATA - SECURITY_FINDING_DATA - RECOMMENDATION_SIGNAL_DATA + - CONFIG_BASED_SIGNAL_DATA + - BACKUPDR_METADATA resourceMetadata: $ref: >- #/components/schemas/StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata @@ -2394,6 +3078,24 @@ components: observabilityMetricData: $ref: >- #/components/schemas/StorageDatabasecenterPartnerapiV1mainObservabilityMetricData + configBasedSignalData: + description: >- + Config based signal data is used to ingest signals that are + generated based on the configuration of the database resource. + $ref: >- + #/components/schemas/StorageDatabasecenterPartnerapiV1mainConfigBasedSignalData + backupdrMetadata: + description: BackupDR metadata is used to ingest metadata from BackupDR. + $ref: >- + #/components/schemas/StorageDatabasecenterPartnerapiV1mainBackupDRMetadata + skipIngestion: + description: >- + Optional. If true, the feed won't be ingested by DB Center. This + indicates that the feed is intentionally skipped. For example, + BackupDR feeds are only needed for resources integrated with DB + Center (e.g., CloudSQL, AlloyDB). Feeds for non-integrated resources + (e.g., Compute Engine, Persistent Disk) can be skipped. + type: boolean StorageDatabasecenterPartnerapiV1mainDatabaseResourceId: id: StorageDatabasecenterPartnerapiV1mainDatabaseResourceId description: >- @@ -2438,17 +3140,22 @@ components: resourceType: description: >- Required. The type of resource this ID is identifying. Ex + go/keep-sorted start alloydb.googleapis.com/Cluster, + alloydb.googleapis.com/Instance, + bigtableadmin.googleapis.com/Cluster, + bigtableadmin.googleapis.com/Instance + compute.googleapis.com/Instance firestore.googleapis.com/Database, redis.googleapis.com/Instance, redis.googleapis.com/Cluster, - alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, + oracledatabase.googleapis.com/CloudExadataInfrastructure + oracledatabase.googleapis.com/CloudVmCluster + oracledatabase.googleapis.com/AutonomousDatabase spanner.googleapis.com/Instance, spanner.googleapis.com/Database, - firestore.googleapis.com/Database, sqladmin.googleapis.com/Instance, - bigtableadmin.googleapis.com/Cluster, - bigtableadmin.googleapis.com/Instance REQUIRED Please refer - go/condor-common-datamodel + sqladmin.googleapis.com/Instance, go/keep-sorted end REQUIRED Please + refer go/condor-common-datamodel type: string StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata: id: StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata - description: 'Common model for database resource instance metadata. Next ID: 23' + description: 'Common model for database resource instance metadata. Next ID: 26' type: object properties: id: @@ -2540,7 +3247,7 @@ components: description: The type of the instance. Specified at creation time. type: string enumDescriptions: - - '' + - Unspecified. - For rest of the other categories. - A regular primary database instance. - A cluster or an instance acting as a secondary. @@ -2549,6 +3256,7 @@ components: - A regular primary database instance. - A cluster or an instance acting as a secondary. - An instance acting as a read-replica. + - An instance acting as an external primary. - For rest of the other categories. enumDeprecated: - true @@ -2561,6 +3269,7 @@ components: - false - false - false + - false enum: - INSTANCE_TYPE_UNSPECIFIED - SUB_RESOURCE_TYPE_UNSPECIFIED @@ -2571,6 +3280,7 @@ components: - SUB_RESOURCE_TYPE_PRIMARY - SUB_RESOURCE_TYPE_SECONDARY - SUB_RESOURCE_TYPE_READ_REPLICA + - SUB_RESOURCE_TYPE_EXTERNAL_PRIMARY - SUB_RESOURCE_TYPE_OTHER product: description: The product this resource represents. @@ -2620,6 +3330,34 @@ components: - EDITION_UNSPECIFIED - EDITION_ENTERPRISE - EDITION_ENTERPRISE_PLUS + suspensionReason: + description: Optional. Suspension reason for the resource. + type: string + enumDescriptions: + - Suspension reason is unspecified. + - Wipeout hide event. + - Wipeout purge event. + - Billing disabled for project + - Abuse detected for resource + - Encryption key inaccessible. + - Replicated cluster encryption key inaccessible. + enum: + - SUSPENSION_REASON_UNSPECIFIED + - WIPEOUT_HIDE_EVENT + - WIPEOUT_PURGE_EVENT + - BILLING_DISABLED + - ABUSER_DETECTED + - ENCRYPTION_KEY_INACCESSIBLE + - REPLICATED_CLUSTER_ENCRYPTION_KEY_INACCESSIBLE + gcbdrConfiguration: + description: GCBDR configuration for the resource. + deprecated: true + $ref: >- + #/components/schemas/StorageDatabasecenterPartnerapiV1mainGCBDRConfiguration + backupdrConfiguration: + description: Optional. BackupDR Configuration for the resource. + $ref: >- + #/components/schemas/StorageDatabasecenterPartnerapiV1mainBackupDRConfiguration StorageDatabasecenterProtoCommonProduct: id: StorageDatabasecenterProtoCommonProduct description: Product specification for Condor resources. @@ -2641,10 +3379,12 @@ components: - On premises database product. - Memorystore product area in GCP - Bigtable product area in GCP + - Firestore product area in GCP. + - Compute Engine self managed databases + - Oracle product area in GCP - >- Other refers to rest of other product type. This is to be when product type is known, but it is not present in this enum. - - Firestore product area in GCP. enumDeprecated: - false - false @@ -2658,6 +3398,8 @@ components: - false - false - false + - false + - false enum: - PRODUCT_TYPE_UNSPECIFIED - PRODUCT_TYPE_CLOUD_SQL @@ -2669,8 +3411,10 @@ components: - ON_PREM - PRODUCT_TYPE_MEMORYSTORE - PRODUCT_TYPE_BIGTABLE - - PRODUCT_TYPE_OTHER - PRODUCT_TYPE_FIRESTORE + - PRODUCT_TYPE_COMPUTE_ENGINE + - PRODUCT_TYPE_ORACLE_ON_GCP + - PRODUCT_TYPE_OTHER engine: description: The specific engine that the underlying database is running. type: string @@ -2693,6 +3437,9 @@ components: engine is known, but it is not present in this enum. - Firestore with native mode. - Firestore with datastore mode. + - Firestore with MongoDB compatibility mode. + - Oracle Exadata engine. + - Oracle Autonomous DB Serverless engine. enumDeprecated: - false - false @@ -2710,6 +3457,9 @@ components: - false - false - false + - false + - false + - false enum: - ENGINE_UNSPECIFIED - ENGINE_MYSQL @@ -2727,12 +3477,21 @@ components: - ENGINE_OTHER - ENGINE_FIRESTORE_WITH_NATIVE_MODE - ENGINE_FIRESTORE_WITH_DATASTORE_MODE + - ENGINE_FIRESTORE_WITH_MONGODB_COMPATIBILITY_MODE + - ENGINE_EXADATA_ORACLE + - ENGINE_ADB_SERVERLESS_ORACLE version: description: >- Version of the underlying database engine. Example values: For MySQL, it could be "8.0", "5.7" etc.. For Postgres, it could be "14", "15" etc.. type: string + minorVersion: + description: >- + Minor version of the underlying database engine. Example values: For + MySQL, it could be "8.0.32", "5.7.32" etc.. For Postgres, it could + be "14.3", "15.3" etc.. + type: string StorageDatabasecenterPartnerapiV1mainAvailabilityConfiguration: id: StorageDatabasecenterPartnerapiV1mainAvailabilityConfiguration description: Configuration for availability of database instance @@ -2819,6 +3578,7 @@ components: - DURATION - RETENTION_UNIT_OTHER timeBasedRetention: + deprecated: true type: string format: google-duration quantityBasedRetention: @@ -2940,6 +3700,9 @@ components: backupRun: description: Information about the last backup attempt for this database $ref: '#/components/schemas/StorageDatabasecenterPartnerapiV1mainBackupRun' + isDeletionProtectionEnabled: + description: Whether deletion protection is enabled for this internal resource. + type: boolean StorageDatabasecenterPartnerapiV1mainEntitlement: id: StorageDatabasecenterPartnerapiV1mainEntitlement description: >- @@ -2951,11 +3714,24 @@ components: description: An enum that represents the type of this entitlement. type: string enumDescriptions: - - '' - - The root entitlement representing Gemini package ownership. + - The entitlement type is unspecified. + - >- + The root entitlement representing Gemini package ownership.This + will no longer be supported in the future. + - >- + The entitlement representing Native Tier, This will be the default + Entitlement going forward with GCA Enablement. + - The entitlement representing GCA-Standard Tier. + enumDeprecated: + - false + - true + - false + - false enum: - ENTITLEMENT_TYPE_UNSPECIFIED - GEMINI + - NATIVE + - GCA_STANDARD entitlementState: description: The current state of user's accessibility to a feature/benefit. type: string @@ -2993,20 +3769,27 @@ components: properties: cpuCount: description: >- - The number of CPUs. TODO(b/342344482, b/342346271) add proto - validations again after bug fix. + The number of CPUs. Deprecated. Use vcpu_count instead. + TODO(b/342344482) add proto validations again after bug fix. + deprecated: true type: integer format: int32 memorySizeInBytes: description: >- - Memory size in bytes. TODO(b/342344482, b/342346271) add proto - validations again after bug fix. + Memory size in bytes. TODO(b/342344482) add proto validations again + after bug fix. type: string format: int64 shardCount: description: Optional. Number of shards (if applicable). type: integer format: int32 + vcpuCount: + description: >- + Optional. The number of vCPUs. TODO(b/342344482) add proto + validations again after bug fix. + type: number + format: double StorageDatabasecenterPartnerapiV1mainTags: id: StorageDatabasecenterPartnerapiV1mainTags description: >- @@ -3020,6 +3803,24 @@ components: type: object additionalProperties: type: string + StorageDatabasecenterPartnerapiV1mainGCBDRConfiguration: + id: StorageDatabasecenterPartnerapiV1mainGCBDRConfiguration + description: GCBDR Configuration for the resource. + type: object + properties: + gcbdrManaged: + description: Whether the resource is managed by GCBDR. + type: boolean + StorageDatabasecenterPartnerapiV1mainBackupDRConfiguration: + id: StorageDatabasecenterPartnerapiV1mainBackupDRConfiguration + description: >- + BackupDRConfiguration to capture the backup and disaster recovery + details of database resource. + type: object + properties: + backupdrManaged: + description: Indicates if the resource is managed by BackupDR. + type: boolean StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData: id: StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData description: Common model for database resource health signal data. @@ -3347,12 +4148,70 @@ components: Detects if database instance data exported to a Cloud Storage bucket that is owned by the organization and is publicly accessible. + - >- + Detects if a database instance is using a weak password hash + algorithm. + - Detects if a database instance has no user password policy set. + - Detects if a database instance/cluster has a hot node. + - >- + Detects if a database instance has no point in time recovery + enabled. + - Detects if a database instance/cluster is suspended. + - >- + Detects that expensive commands are being run on a database + instance impacting overall performance. + - >- + Indicates that the instance does not have a maintenance policy + configured. + - Deletion Protection Disabled for the resource + - Indicates that the instance has inefficient queries detected. + - Indicates that the instance has read intensive workload. + - Indicates that the instance is nearing memory limit. + - >- + Indicates that the instance's max server memory is configured + higher than the recommended value. + - >- + Indicates that the database has large rows beyond the recommended + limit. + - Heavy write pressure on the database rows. + - Heavy read pressure on the database rows. + - Encryption org policy not satisfied. + - Location org policy not satisfied. + - Outdated DB minor version. + - Schema not optimized. + - High number of idle connections. + - Replication delay. + - Outdated version. + - Outdated client. enumDeprecated: - false - false - false - true - true + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false - false - false - false @@ -3507,6 +4366,34 @@ components: - SIGNAL_TYPE_USER_GRANTED_ALL_PERMISSIONS - SIGNAL_TYPE_DATA_EXPORT_TO_EXTERNAL_CLOUD_STORAGE_BUCKET - SIGNAL_TYPE_DATA_EXPORT_TO_PUBLIC_CLOUD_STORAGE_BUCKET + - SIGNAL_TYPE_WEAK_PASSWORD_HASH_ALGORITHM + - SIGNAL_TYPE_NO_USER_PASSWORD_POLICY + - SIGNAL_TYPE_HOT_NODE + - SIGNAL_TYPE_NO_POINT_IN_TIME_RECOVERY + - SIGNAL_TYPE_RESOURCE_SUSPENDED + - SIGNAL_TYPE_EXPENSIVE_COMMANDS + - SIGNAL_TYPE_NO_MAINTENANCE_POLICY_CONFIGURED + - SIGNAL_TYPE_NO_DELETION_PROTECTION + - SIGNAL_TYPE_INEFFICIENT_QUERY + - SIGNAL_TYPE_READ_INTENSIVE_WORKLOAD + - SIGNAL_TYPE_MEMORY_LIMIT + - SIGNAL_TYPE_MAX_SERVER_MEMORY + - SIGNAL_TYPE_LARGE_ROWS + - SIGNAL_TYPE_HIGH_WRITE_PRESSURE + - SIGNAL_TYPE_HIGH_READ_PRESSURE + - SIGNAL_TYPE_ENCRYPTION_ORG_POLICY_NOT_SATISFIED + - SIGNAL_TYPE_LOCATION_ORG_POLICY_NOT_SATISFIED + - SIGNAL_TYPE_OUTDATED_MINOR_VERSION + - SIGNAL_TYPE_SCHEMA_NOT_OPTIMIZED + - SIGNAL_TYPE_MANY_IDLE_CONNECTIONS + - SIGNAL_TYPE_REPLICATION_LAG + - SIGNAL_TYPE_OUTDATED_VERSION + - SIGNAL_TYPE_OUTDATED_CLIENT + location: + description: >- + This is used to identify the location of the resource. Example: + "us-central1" + type: string StorageDatabasecenterPartnerapiV1mainCompliance: id: StorageDatabasecenterPartnerapiV1mainCompliance description: >- @@ -3706,12 +4593,70 @@ components: Detects if database instance data exported to a Cloud Storage bucket that is owned by the organization and is publicly accessible. + - >- + Detects if a database instance is using a weak password hash + algorithm. + - Detects if a database instance has no user password policy set. + - Detects if a database instance/cluster has a hot node. + - >- + Detects if a database instance has no point in time recovery + enabled. + - Detects if a database instance/cluster is suspended. + - >- + Detects that expensive commands are being run on a database + instance impacting overall performance. + - >- + Indicates that the instance does not have a maintenance policy + configured. + - Deletion Protection Disabled for the resource + - Indicates that the instance has inefficient queries detected. + - Indicates that the instance has read intensive workload. + - Indicates that the instance is nearing memory limit. + - >- + Indicates that the instance's max server memory is configured + higher than the recommended value. + - >- + Indicates that the database has large rows beyond the recommended + limit. + - Heavy write pressure on the database rows. + - Heavy read pressure on the database rows. + - Encryption org policy not satisfied. + - Location org policy not satisfied. + - Outdated DB minor version. + - Schema not optimized. + - High number of idle connections. + - Replication delay. + - Outdated version. + - Outdated client. enumDeprecated: - false - false - false - true - true + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false - false - false - false @@ -3866,6 +4811,29 @@ components: - SIGNAL_TYPE_USER_GRANTED_ALL_PERMISSIONS - SIGNAL_TYPE_DATA_EXPORT_TO_EXTERNAL_CLOUD_STORAGE_BUCKET - SIGNAL_TYPE_DATA_EXPORT_TO_PUBLIC_CLOUD_STORAGE_BUCKET + - SIGNAL_TYPE_WEAK_PASSWORD_HASH_ALGORITHM + - SIGNAL_TYPE_NO_USER_PASSWORD_POLICY + - SIGNAL_TYPE_HOT_NODE + - SIGNAL_TYPE_NO_POINT_IN_TIME_RECOVERY + - SIGNAL_TYPE_RESOURCE_SUSPENDED + - SIGNAL_TYPE_EXPENSIVE_COMMANDS + - SIGNAL_TYPE_NO_MAINTENANCE_POLICY_CONFIGURED + - SIGNAL_TYPE_NO_DELETION_PROTECTION + - SIGNAL_TYPE_INEFFICIENT_QUERY + - SIGNAL_TYPE_READ_INTENSIVE_WORKLOAD + - SIGNAL_TYPE_MEMORY_LIMIT + - SIGNAL_TYPE_MAX_SERVER_MEMORY + - SIGNAL_TYPE_LARGE_ROWS + - SIGNAL_TYPE_HIGH_WRITE_PRESSURE + - SIGNAL_TYPE_HIGH_READ_PRESSURE + - SIGNAL_TYPE_ENCRYPTION_ORG_POLICY_NOT_SATISFIED + - SIGNAL_TYPE_LOCATION_ORG_POLICY_NOT_SATISFIED + - SIGNAL_TYPE_OUTDATED_MINOR_VERSION + - SIGNAL_TYPE_SCHEMA_NOT_OPTIMIZED + - SIGNAL_TYPE_MANY_IDLE_CONNECTIONS + - SIGNAL_TYPE_REPLICATION_LAG + - SIGNAL_TYPE_OUTDATED_VERSION + - SIGNAL_TYPE_OUTDATED_CLIENT lastRefreshTime: description: Required. last time recommendationw as refreshed type: string @@ -3955,6 +4923,13 @@ components: Storage utilization for a resource. The value is a fraction between 0.0 and 1.0 (may momentarily exceed 1.0 in some cases). - Sotrage used by a resource. + - >- + Node count for a resource. It represents the number of node units + in a bigtable/spanner instance. + - Memory used by a resource (in bytes). + - >- + Processing units used by a resource. It represents the number of + processing units in a spanner instance. enum: - METRIC_TYPE_UNSPECIFIED - CPU_UTILIZATION @@ -3962,6 +4937,9 @@ components: - NETWORK_CONNECTIONS - STORAGE_UTILIZATION - STORAGE_USED_BYTES + - NODE_COUNT + - MEMORY_USED_BYTES + - PROCESSING_UNIT_COUNT aggregationType: description: Required. Type of aggregation performed on the metric. type: string @@ -4005,6 +4983,78 @@ components: boolValue: description: For boolean value type: boolean + StorageDatabasecenterPartnerapiV1mainConfigBasedSignalData: + id: StorageDatabasecenterPartnerapiV1mainConfigBasedSignalData + description: >- + Config based signal data. This is used to send signals to Condor which + are based on the DB level configurations. These will be used to send + signals for self managed databases. + type: object + properties: + resourceId: + description: Database resource id. + $ref: >- + #/components/schemas/StorageDatabasecenterPartnerapiV1mainDatabaseResourceId + fullResourceName: + description: Required. Full Resource name of the source resource. + type: string + lastRefreshTime: + description: Required. Last time signal was refreshed + type: string + format: google-datetime + signalType: + description: Required. Signal type of the signal + type: string + enumDescriptions: + - Unspecified signal type. + - Outdated Minor Version + - Represents database auditing is disabled. + - >- + Represents if a database has a password configured for the root + account or not. + - Represents if a resource is exposed to public access. + - >- + Represents if a resources requires all incoming connections to use + SSL or not. + enum: + - SIGNAL_TYPE_UNSPECIFIED + - SIGNAL_TYPE_OUTDATED_MINOR_VERSION + - SIGNAL_TYPE_DATABASE_AUDITING_DISABLED + - SIGNAL_TYPE_NO_ROOT_PASSWORD + - SIGNAL_TYPE_EXPOSED_TO_PUBLIC_ACCESS + - SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS + signalBoolValue: + description: Signal data for boolean signals. + type: boolean + StorageDatabasecenterPartnerapiV1mainBackupDRMetadata: + id: StorageDatabasecenterPartnerapiV1mainBackupDRMetadata + description: >- + BackupDRMetadata contains information about the backup and disaster + recovery metadata of a database resource. + type: object + properties: + resourceId: + description: Required. Database resource id. + $ref: >- + #/components/schemas/StorageDatabasecenterPartnerapiV1mainDatabaseResourceId + lastRefreshTime: + description: Required. Last time backup configuration was refreshed. + type: string + format: google-datetime + backupConfiguration: + description: Backup configuration for this instance. + $ref: >- + #/components/schemas/StorageDatabasecenterPartnerapiV1mainBackupConfiguration + backupRun: + description: Latest backup run information for this instance. + $ref: '#/components/schemas/StorageDatabasecenterPartnerapiV1mainBackupRun' + backupdrConfiguration: + description: BackupDR configuration for this instance. + $ref: >- + #/components/schemas/StorageDatabasecenterPartnerapiV1mainBackupDRConfiguration + fullResourceName: + description: Required. Full resource name of this instance. + type: string CloudControl2SharedOperationsReconciliationOperationMetadata: id: CloudControl2SharedOperationsReconciliationOperationMetadata description: >- @@ -4193,6 +5243,13 @@ components: name: clusters title: Clusters methods: + restore_from_cloud_sql: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clusters:restoreFromCloudSQL/post + response: + mediaType: application/json + openAPIDocKey: '200' list: operation: $ref: >- @@ -4229,6 +5286,20 @@ components: response: mediaType: application/json openAPIDocKey: '200' + export: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clusters~1{clustersId}:export/post + response: + mediaType: application/json + openAPIDocKey: '200' + import: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clusters~1{clustersId}:import/post + response: + mediaType: application/json + openAPIDocKey: '200' upgrade: operation: $ref: >- @@ -4574,6 +5645,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: @@ -4728,7 +5803,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: alloydb.projects.locations.operations.cancel requestBody: content: @@ -4763,6 +5838,39 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/clusters:restoreFromCloudSQL: + parameters: *ref_1 + post: + description: Restores an AlloyDB cluster from a CloudSQL resource. + operationId: alloydb.projects.locations.clusters.restoreFromCloudSQL + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RestoreFromCloudSQLRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/clusters: parameters: *ref_1 get: @@ -4988,6 +6096,82 @@ paths: name: force schema: type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:export: + parameters: *ref_1 + post: + description: Exports data from the cluster. Imperative only. + operationId: alloydb.projects.locations.clusters.export + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExportClusterRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:import: + parameters: *ref_1 + post: + description: Imports data to the cluster. Imperative only. + operationId: alloydb.projects.locations.clusters.import + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ImportClusterRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:upgrade: parameters: *ref_1 patch: @@ -6152,3 +7336,7 @@ paths: name: pageToken schema: type: string + - in: query + name: scope + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/analyticshub.yaml b/providers/src/googleapis.com/v00.00.00000/services/analyticshub.yaml index 0ad72022..7ec6b385 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/analyticshub.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/analyticshub.yaml @@ -7,8 +7,8 @@ info: title: Analytics Hub API description: Exchange data and analytics assets securely and efficiently. version: v1 - x-discovery-doc-revision: '20241028' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250818' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/bigquery/docs/analytics-hub-introduction servers: @@ -61,7 +61,7 @@ components: name: description: >- Output only. The resource name of the data exchange. e.g. - `projects/myproject/locations/US/dataExchanges/123`. + `projects/myproject/locations/us/dataExchanges/123`. readOnly: true type: string displayName: @@ -127,6 +127,11 @@ components: - DISCOVERY_TYPE_UNSPECIFIED - DISCOVERY_TYPE_PRIVATE - DISCOVERY_TYPE_PUBLIC + logLinkedDatasetQueryUserEmail: + description: >- + Optional. By default, false. If true, the DataExchange has an email + sharing mandate enabled. + type: boolean SharingEnvironmentConfig: id: SharingEnvironmentConfig description: >- @@ -219,15 +224,15 @@ components: type: object properties: bigqueryDataset: - description: Required. Shared dataset i.e. BigQuery dataset source. + description: Shared dataset i.e. BigQuery dataset source. $ref: '#/components/schemas/BigQueryDatasetSource' pubsubTopic: - description: Required. Pub/Sub topic source. + description: Pub/Sub topic source. $ref: '#/components/schemas/PubSubTopicSource' name: description: >- Output only. The resource name of the listing. e.g. - `projects/myproject/locations/US/dataExchanges/123/listings/456` + `projects/myproject/locations/us/dataExchanges/123/listings/456` readOnly: true type: string displayName: @@ -279,7 +284,7 @@ components: $ref: '#/components/schemas/DataProvider' categories: description: >- - Optional. Categories of the listing. Up to two categories are + Optional. Categories of the listing. Up to five categories are allowed. type: array items: @@ -305,6 +310,7 @@ components: - '' - '' - '' + - '' enum: - CATEGORY_UNSPECIFIED - CATEGORY_OTHERS @@ -326,6 +332,7 @@ components: - CATEGORY_SCIENCE_AND_RESEARCH - CATEGORY_TRANSPORTATION_AND_LOGISTICS - CATEGORY_TRAVEL_AND_TOURISM + - CATEGORY_GOOGLE_EARTH_ENGINE publisher: description: >- Optional. Details of the publisher who owns the listing and who can @@ -369,6 +376,23 @@ components: - SHARED_RESOURCE_TYPE_UNSPECIFIED - BIGQUERY_DATASET - PUBSUB_TOPIC + commercialInfo: + description: >- + Output only. Commercial info contains the information about the + commercial data products associated with the listing. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudBigqueryAnalyticshubV1ListingCommercialInfo + logLinkedDatasetQueryUserEmail: + description: >- + Optional. By default, false. If true, the Listing has an email + sharing mandate enabled. + type: boolean + allowOnlyMetadataSharing: + description: >- + Optional. If true, the listing is only available to get the resource + metadata. Listing is non subscribable. + type: boolean BigQueryDatasetSource: id: BigQueryDatasetSource description: >- @@ -382,7 +406,7 @@ components: properties: dataset: description: >- - Resource name of the dataset source for this listing. e.g. + Optional. Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123` type: string selectedResources: @@ -408,6 +432,12 @@ components: `projects/{projectId}/datasets/{datasetId}/tables/{tableId}` Example:"projects/test_project/datasets/test_dataset/tables/test_table" type: string + routine: + description: >- + Optional. Format: For routine: + `projects/{projectId}/datasets/{datasetId}/routines/{routineId}` + Example:"projects/test_project/datasets/test_dataset/routines/test_routine" + type: string RestrictedExportPolicy: id: RestrictedExportPolicy description: >- @@ -441,7 +471,8 @@ components: dataAffinityRegions: description: >- Optional. Region hint on where the data might be published. Data - affinity regions are modifiable. See go/regions for full listing of + affinity regions are modifiable. See + https://cloud.google.com/about/locations for full listing of possible Cloud regions. type: array items: @@ -491,6 +522,46 @@ components: Optional. If true, restrict export of query result derived from restricted linked dataset table. type: boolean + GoogleCloudBigqueryAnalyticshubV1ListingCommercialInfo: + id: GoogleCloudBigqueryAnalyticshubV1ListingCommercialInfo + description: >- + Commercial info contains the information about the commercial data + products associated with the listing. + type: object + properties: + cloudMarketplace: + description: >- + Output only. Details of the Marketplace Data Product associated with + the Listing. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudBigqueryAnalyticshubV1ListingCommercialInfoGoogleCloudMarketplaceInfo + GoogleCloudBigqueryAnalyticshubV1ListingCommercialInfoGoogleCloudMarketplaceInfo: + id: >- + GoogleCloudBigqueryAnalyticshubV1ListingCommercialInfoGoogleCloudMarketplaceInfo + description: >- + Specifies the details of the Marketplace Data Product associated with + the Listing. + type: object + properties: + service: + description: >- + Output only. Resource name of the commercial service associated with + the Marketplace Data Product. e.g. example.com + readOnly: true + type: string + commercialState: + description: Output only. Commercial state of the Marketplace Data Product. + readOnly: true + type: string + enumDescriptions: + - Commercialization is incomplete and cannot be used. + - Commercialization has been initialized. + - Commercialization is complete and available for use. + enum: + - COMMERCIAL_STATE_UNSPECIFIED + - ONBOARDING + - ACTIVE SubscribeListingRequest: id: SubscribeListingRequest description: Message for subscribing to a listing. @@ -503,8 +574,8 @@ components: $ref: '#/components/schemas/DestinationDataset' destinationPubsubSubscription: description: >- - Required. Input only. Destination Pub/Sub subscription to create for - the subscriber. + Input only. Destination Pub/Sub subscription to create for the + subscriber. $ref: '#/components/schemas/DestinationPubSubSubscription' DestinationDataset: id: DestinationDataset @@ -538,7 +609,6 @@ components: type: string DestinationDatasetReference: id: DestinationDatasetReference - description: Contains the reference that identifies a destination bigquery dataset. type: object properties: datasetId: @@ -561,8 +631,9 @@ components: GooglePubsubV1Subscription: id: GooglePubsubV1Subscription description: >- - A subscription resource. If none of `push_config`, `bigquery_config`, or - `cloud_storage_config` is set, then the subscriber will pull and ack + Defines the destination Pub/Sub subscription. If none of `push_config`, + `bigquery_config`, `cloud_storage_config`, `pubsub_export_config`, or + `pubsublite_export_config` is set, then the subscriber will pull and ack messages using API methods. At most one of these fields may be set. type: object properties: @@ -698,47 +769,34 @@ components: multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinct `message_id` values. type: boolean - topicMessageRetentionDuration: - description: >- - Output only. Indicates the minimum duration for which a message is - retained after it is published to the subscription's topic. If this - field is set, messages published to the subscription's topic in the - last `topic_message_retention_duration` are always available to - subscribers. See the `message_retention_duration` field in `Topic`. - This field is set only in responses from the server; it is ignored - if it is set in any requests. - readOnly: true - type: string - format: google-duration - state: - description: >- - Output only. An output-only field indicating whether or not the - subscription can receive messages. - readOnly: true - type: string - enumDescriptions: - - Default value. This value is unused. - - The subscription can actively receive messages - - >- - The subscription cannot receive messages because of an error with - the resource to which it pushes messages. See the more detailed - error state in the corresponding configuration. - enum: - - STATE_UNSPECIFIED - - ACTIVE - - RESOURCE_ERROR - analyticsHubSubscriptionInfo: + messageTransforms: description: >- - Output only. Information about the associated Analytics Hub - subscription. Only set if the subscritpion is created by Analytics - Hub. - readOnly: true - $ref: '#/components/schemas/AnalyticsHubSubscriptionInfo' + Optional. Transforms to be applied to messages before they are + delivered to subscribers. Transforms are applied in the order + specified. + type: array + items: + $ref: '#/components/schemas/MessageTransform' PushConfig: id: PushConfig description: Configuration for a push delivery endpoint. type: object properties: + oidcToken: + description: >- + Optional. If specified, Pub/Sub will generate and attach an OIDC JWT + token as an `Authorization` header in the HTTP request for every + pushed message. + $ref: '#/components/schemas/OidcToken' + pubsubWrapper: + description: >- + Optional. When set, the payload to the push endpoint is in the form + of the JSON representation of a PubsubMessage + (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage). + $ref: '#/components/schemas/PubsubWrapper' + noWrapper: + description: Optional. When set, the payload to the push endpoint is not wrapped. + $ref: '#/components/schemas/NoWrapper' pushEndpoint: description: >- Optional. A URL locating the endpoint to which messages should be @@ -765,21 +823,6 @@ components: type: object additionalProperties: type: string - oidcToken: - description: >- - Optional. If specified, Pub/Sub will generate and attach an OIDC JWT - token as an `Authorization` header in the HTTP request for every - pushed message. - $ref: '#/components/schemas/OidcToken' - pubsubWrapper: - description: >- - Optional. When set, the payload to the push endpoint is in the form - of the JSON representation of a PubsubMessage - (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage). - $ref: '#/components/schemas/PubsubWrapper' - noWrapper: - description: Optional. When set, the payload to the push endpoint is not wrapped. - $ref: '#/components/schemas/NoWrapper' OidcToken: id: OidcToken description: >- @@ -857,35 +900,6 @@ components: schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog. type: boolean - state: - description: >- - Output only. An output-only field that indicates whether or not the - subscription can receive messages. - readOnly: true - type: string - enumDescriptions: - - Default value. This value is unused. - - The subscription can actively send messages to BigQuery - - >- - Cannot write to the BigQuery table because of permission denied - errors. This can happen if - Pub/Sub SA has not been granted the - [appropriate BigQuery IAM - permissions](https://cloud.google.com/pubsub/docs/create-subscription#assign_bigquery_service_account) - - bigquery.googleapis.com API is not enabled for the project - ([instructions](https://cloud.google.com/service-usage/docs/enable-disable)) - - Cannot write to the BigQuery table because it does not exist. - - Cannot write to the BigQuery table due to a schema mismatch. - - >- - Cannot write to the destination because enforce_in_transit is set - to true and the destination locations are not in the allowed - regions. - enum: - - STATE_UNSPECIFIED - - ACTIVE - - PERMISSION_DENIED - - NOT_FOUND - - SCHEMA_MISMATCH - - IN_TRANSIT_LOCATION_RESTRICTION useTableSchema: description: >- Optional. When true, use the BigQuery table's schema as the columns @@ -907,6 +921,16 @@ components: description: Configuration for a Cloud Storage subscription. type: object properties: + textConfig: + description: >- + Optional. If set, message data will be written to Cloud Storage in + text format. + $ref: '#/components/schemas/TextConfig' + avroConfig: + description: >- + Optional. If set, message data will be written to Cloud Storage in + Avro format. + $ref: '#/components/schemas/AvroConfig' bucket: description: >- Required. User-provided name for the Cloud Storage bucket. The @@ -933,21 +957,15 @@ components: datetimes in Cloud Storage filenames. See the [datetime format guidance](https://cloud.google.com/pubsub/docs/create-cloudstorage-subscription#file_names). type: string - textConfig: - description: >- - Optional. If set, message data will be written to Cloud Storage in - text format. - $ref: '#/components/schemas/TextConfig' - avroConfig: - description: >- - Optional. If set, message data will be written to Cloud Storage in - Avro format. - $ref: '#/components/schemas/AvroConfig' maxDuration: description: >- - Optional. The maximum duration that can elapse before a new Cloud - Storage file is created. Min 1 minute, max 10 minutes, default 5 - minutes. May not exceed the subscription's acknowledgement deadline. + Optional. File batching settings. If no max_duration setting is + specified, a max_duration of 5 minutes will be set by default. + max_duration is required regardless of whether other file batching + settings are specified. The maximum duration that can elapse before + a new Cloud Storage file is created. Min 1 minute, max 10 minutes, + default 5 minutes. May not exceed the subscription's acknowledgement + deadline. type: string format: google-duration maxBytes: @@ -964,35 +982,6 @@ components: Cloud Storage file before a new file is created. Min 1000 messages. type: string format: int64 - state: - description: >- - Output only. An output-only field that indicates whether or not the - subscription can receive messages. - readOnly: true - type: string - enumDescriptions: - - Default value. This value is unused. - - The subscription can actively send messages to Cloud Storage. - - >- - Cannot write to the Cloud Storage bucket because of permission - denied errors. - - >- - Cannot write to the Cloud Storage bucket because it does not - exist. - - >- - Cannot write to the destination because enforce_in_transit is set - to true and the destination locations are not in the allowed - regions. - - >- - Cannot write to the Cloud Storage bucket due to an incompatibility - between the topic schema and subscription settings. - enum: - - STATE_UNSPECIFIED - - ACTIVE - - PERMISSION_DENIED - - NOT_FOUND - - IN_TRANSIT_LOCATION_RESTRICTION - - SCHEMA_MISMATCH serviceAccountEmail: description: >- Optional. The service account to use to write to Cloud Storage. The @@ -1108,24 +1097,54 @@ components: to 600 seconds. type: string format: google-duration - AnalyticsHubSubscriptionInfo: - id: AnalyticsHubSubscriptionInfo + MessageTransform: + id: MessageTransform + description: All supported message transforms types. + type: object + properties: + javascriptUdf: + description: >- + Optional. JavaScript User Defined Function. If multiple + JavaScriptUDF's are specified on a resource, each must have a unique + `function_name`. + $ref: '#/components/schemas/JavaScriptUDF' + enabled: + description: >- + Optional. This field is deprecated, use the `disabled` field to + disable transforms. + deprecated: true + type: boolean + disabled: + description: >- + Optional. If true, the transform is disabled and will not be applied + to messages. Defaults to `false`. + type: boolean + JavaScriptUDF: + id: JavaScriptUDF description: >- - Information about an associated Analytics Hub subscription - (https://cloud.google.com/bigquery/docs/analytics-hub-manage-subscriptions). + User-defined JavaScript function that can transform or filter a Pub/Sub + message. type: object properties: - listing: + functionName: description: >- - Optional. The name of the associated Analytics Hub listing resource. - Pattern: - "projects/{project}/locations/{location}/dataExchanges/{data_exchange}/listings/{listing}" + Required. Name of the JavasScript function that should applied to + Pub/Sub messages. type: string - subscription: + code: description: >- - Optional. The name of the associated Analytics Hub subscription - resource. Pattern: - "projects/{project}/locations/{location}/subscriptions/{subscription}" + Required. JavaScript code that contains a function `function_name` + with the below signature: ``` /** * Transforms a Pub/Sub message. * + @return {(Object)>|null)} - To * filter a message, return `null`. To + transform a message return a map * with the following keys: * - + (required) 'data' : {string} * - (optional) 'attributes' : {Object} + * Returning empty `attributes` will remove all attributes from the * + message. * * @param {(Object)>} Pub/Sub * message. Keys: * - + (required) 'data' : {string} * - (required) 'attributes' : {Object} + * * @param {Object} metadata - Pub/Sub message metadata. * Keys: * - + (required) 'message_id' : {string} * - (optional) 'publish_time': + {string} YYYY-MM-DDTHH:MM:SSZ format * - (optional) 'ordering_key': + {string} */ function (message, metadata) { } ``` type: string SubscribeListingResponse: id: SubscribeListingResponse @@ -1146,19 +1165,19 @@ components: listing: description: >- Output only. Resource name of the source Listing. e.g. - projects/123/locations/US/dataExchanges/456/listings/789 + projects/123/locations/us/dataExchanges/456/listings/789 readOnly: true type: string dataExchange: description: >- Output only. Resource name of the source Data Exchange. e.g. - projects/123/locations/US/dataExchanges/456 + projects/123/locations/us/dataExchanges/456 readOnly: true type: string name: description: >- Output only. The resource name of the subscription. e.g. - `projects/myproject/locations/US/subscriptions/123`. + `projects/myproject/locations/us/subscriptions/123`. readOnly: true type: string creationTime: @@ -1204,7 +1223,7 @@ components: description: >- Output only. Map of listing resource names to associated linked resource, e.g. - projects/123/locations/US/dataExchanges/456/listings/789 -> + projects/123/locations/us/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE. @@ -1236,6 +1255,23 @@ components: - SHARED_RESOURCE_TYPE_UNSPECIFIED - BIGQUERY_DATASET - PUBSUB_TOPIC + commercialInfo: + description: >- + Output only. This is set if this is a commercial subscription i.e. + if this subscription was created from subscribing to a commercial + listing. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudBigqueryAnalyticshubV1SubscriptionCommercialInfo + logLinkedDatasetQueryUserEmail: + description: >- + Output only. By default, false. If true, the Subscriber agreed to + the email sharing mandate that is enabled for DataExchange/Listing. + readOnly: true + type: boolean + destinationDataset: + description: Optional. BigQuery destination dataset to create for the subscriber. + $ref: '#/components/schemas/DestinationDataset' LinkedResource: id: LinkedResource description: Reference to a linked resource tracked by this Subscription. @@ -1257,6 +1293,27 @@ components: description: Output only. Listing for which linked resource is created. readOnly: true type: string + GoogleCloudBigqueryAnalyticshubV1SubscriptionCommercialInfo: + id: GoogleCloudBigqueryAnalyticshubV1SubscriptionCommercialInfo + description: Commercial info metadata for this subscription. + type: object + properties: + cloudMarketplace: + description: >- + Output only. This is set when the subscription is commercialised via + Cloud Marketplace. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudBigqueryAnalyticshubV1SubscriptionCommercialInfoGoogleCloudMarketplaceInfo + GoogleCloudBigqueryAnalyticshubV1SubscriptionCommercialInfoGoogleCloudMarketplaceInfo: + id: >- + GoogleCloudBigqueryAnalyticshubV1SubscriptionCommercialInfoGoogleCloudMarketplaceInfo + description: Cloud Marketplace commercial metadata for this subscription. + type: object + properties: + order: + description: Resource name of the Marketplace Order. + type: string SubscribeDataExchangeRequest: id: SubscribeDataExchangeRequest description: Message for subscribing to a Data Exchange. @@ -1265,7 +1322,7 @@ components: destination: description: >- Required. The parent resource path of the Subscription. e.g. - `projects/subscriberproject/locations/US` + `projects/subscriberproject/locations/us` type: string destinationDataset: description: Optional. BigQuery destination dataset to create for the subscriber. @@ -1393,7 +1450,13 @@ components: id: RevokeSubscriptionRequest description: Message for revoking a subscription. type: object - properties: {} + properties: + revokeCommercial: + description: >- + Optional. If the subscription is commercial then this field must be + set to true, otherwise a failure is thrown. This acts as a safety + guard to avoid revoking commercial subscriptions accidentally. + type: boolean RevokeSubscriptionResponse: id: RevokeSubscriptionResponse description: Message for response when you revoke a subscription. Empty for now. @@ -1761,6 +1824,117 @@ components: type: array items: type: string + QueryTemplate: + id: QueryTemplate + description: >- + A query template is a container for sharing table-valued functions + defined by contributors in a data clean room. + type: object + properties: + name: + description: >- + Output only. The resource name of the QueryTemplate. e.g. + `projects/myproject/locations/us/dataExchanges/123/queryTemplates/456` + readOnly: true + type: string + displayName: + description: >- + Required. Human-readable display name of the QueryTemplate. The + display name must contain only Unicode letters, numbers (0-9), + underscores (_), dashes (-), spaces ( ), ampersands (&) and can't + start or end with spaces. Default value is an empty string. Max + length: 63 bytes. + type: string + description: + description: >- + Optional. Short description of the QueryTemplate. The description + must not contain Unicode non-characters and C0 and C1 control codes + except tabs (HT), new lines (LF), carriage returns (CR), and page + breaks (FF). Default value is an empty string. Max length: 2000 + bytes. + type: string + proposer: + description: >- + Optional. Will be deprecated. Email or URL of the primary point of + contact of the QueryTemplate. Max Length: 1000 bytes. + type: string + primaryContact: + description: >- + Optional. Email or URL of the primary point of contact of the + QueryTemplate. Max Length: 1000 bytes. + type: string + documentation: + description: Optional. Documentation describing the QueryTemplate. + type: string + state: + description: Output only. The QueryTemplate lifecycle state. + readOnly: true + type: string + enumDescriptions: + - Default value. This value is unused. + - The QueryTemplate is in draft state. + - The QueryTemplate is in pending state. + - The QueryTemplate is in deleted state. + - The QueryTemplate is in approved state. + enum: + - STATE_UNSPECIFIED + - DRAFTED + - PENDING + - DELETED + - APPROVED + routine: + description: Optional. The routine associated with the QueryTemplate. + $ref: '#/components/schemas/Routine' + createTime: + description: Output only. Timestamp when the QueryTemplate was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. Timestamp when the QueryTemplate was last modified. + readOnly: true + type: string + format: google-datetime + Routine: + id: Routine + description: Represents a bigquery routine. + type: object + properties: + routineType: + description: Required. The type of routine. + type: string + enumDescriptions: + - Default value. + - Non-built-in persistent TVF. + enum: + - ROUTINE_TYPE_UNSPECIFIED + - TABLE_VALUED_FUNCTION + definitionBody: + description: Optional. The definition body of the routine. + type: string + ListQueryTemplatesResponse: + id: ListQueryTemplatesResponse + description: Message for response to the list of QueryTemplates. + type: object + properties: + queryTemplates: + description: The list of QueryTemplates. + type: array + items: + $ref: '#/components/schemas/QueryTemplate' + nextPageToken: + description: A token to request the next page of results. + type: string + SubmitQueryTemplateRequest: + id: SubmitQueryTemplateRequest + description: Message for submitting a QueryTemplate. + type: object + properties: {} + ApproveQueryTemplateRequest: + id: ApproveQueryTemplateRequest + description: Message for approving a QueryTemplate. + type: object + properties: {} SubscribeDataExchangeResponse: id: SubscribeDataExchangeResponse description: Message for response when you subscribe to a Data Exchange. @@ -2153,6 +2327,77 @@ components: - $ref: >- #/components/x-stackQL-resources/listings_iam_policies/methods/projects_locations_data_exchanges_listings_set_iam_policy delete: [] + query_templates: + id: google.analyticshub.query_templates + name: query_templates + title: Query_templates + methods: + projects_locations_data_exchanges_query_templates_create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataExchanges~1{dataExchangesId}~1queryTemplates/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_data_exchanges_query_templates_list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataExchanges~1{dataExchangesId}~1queryTemplates/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.queryTemplates + projects_locations_data_exchanges_query_templates_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataExchanges~1{dataExchangesId}~1queryTemplates~1{queryTemplatesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_data_exchanges_query_templates_patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataExchanges~1{dataExchangesId}~1queryTemplates~1{queryTemplatesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_data_exchanges_query_templates_delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataExchanges~1{dataExchangesId}~1queryTemplates~1{queryTemplatesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_data_exchanges_query_templates_submit: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataExchanges~1{dataExchangesId}~1queryTemplates~1{queryTemplatesId}:submit/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_data_exchanges_query_templates_approve: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataExchanges~1{dataExchangesId}~1queryTemplates~1{queryTemplatesId}:approve/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/query_templates/methods/projects_locations_data_exchanges_query_templates_get + - $ref: >- + #/components/x-stackQL-resources/query_templates/methods/projects_locations_data_exchanges_query_templates_list + insert: + - $ref: >- + #/components/x-stackQL-resources/query_templates/methods/projects_locations_data_exchanges_query_templates_create + update: + - $ref: >- + #/components/x-stackQL-resources/query_templates/methods/projects_locations_data_exchanges_query_templates_patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/query_templates/methods/projects_locations_data_exchanges_query_templates_delete subscriptions: id: google.analyticshub.subscriptions name: subscriptions @@ -2450,7 +2695,8 @@ paths: post: description: >- Creates a Subscription to a Data Clean Room. This is a long-running - operation as it will create one or more linked datasets. + operation as it will create one or more linked datasets. Throws a Bad + Request error if the Data Exchange does not contain any listings. operationId: analyticshub.projects.locations.dataExchanges.subscribe requestBody: content: @@ -2887,6 +3133,10 @@ paths: required: true schema: type: string + - in: query + name: deleteCommercial + schema: + type: boolean /v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}/listings/{listingsId}:subscribe: parameters: *ref_1 post: @@ -3135,6 +3385,322 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}/queryTemplates: + parameters: *ref_1 + post: + description: Creates a new QueryTemplate + operationId: analyticshub.projects.locations.dataExchanges.queryTemplates.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryTemplate' + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/QueryTemplate' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: dataExchangesId + required: true + schema: + type: string + - in: query + name: queryTemplateId + schema: + type: string + get: + description: Lists all QueryTemplates in a given project and location. + operationId: analyticshub.projects.locations.dataExchanges.queryTemplates.list + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListQueryTemplatesResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: dataExchangesId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}/queryTemplates/{queryTemplatesId}: + parameters: *ref_1 + get: + description: Gets a QueryTemplate + operationId: analyticshub.projects.locations.dataExchanges.queryTemplates.get + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/QueryTemplate' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: dataExchangesId + required: true + schema: + type: string + - in: path + name: queryTemplatesId + required: true + schema: + type: string + patch: + description: Updates an existing QueryTemplate + operationId: analyticshub.projects.locations.dataExchanges.queryTemplates.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryTemplate' + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/QueryTemplate' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: dataExchangesId + required: true + schema: + type: string + - in: path + name: queryTemplatesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a query template. + operationId: analyticshub.projects.locations.dataExchanges.queryTemplates.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: dataExchangesId + required: true + schema: + type: string + - in: path + name: queryTemplatesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}/queryTemplates/{queryTemplatesId}:submit: + parameters: *ref_1 + post: + description: Submits a query template for approval. + operationId: analyticshub.projects.locations.dataExchanges.queryTemplates.submit + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SubmitQueryTemplateRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/QueryTemplate' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: dataExchangesId + required: true + schema: + type: string + - in: path + name: queryTemplatesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}/queryTemplates/{queryTemplatesId}:approve: + parameters: *ref_1 + post: + description: Approves a query template. + operationId: analyticshub.projects.locations.dataExchanges.queryTemplates.approve + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ApproveQueryTemplateRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/QueryTemplate' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: dataExchangesId + required: true + schema: + type: string + - in: path + name: queryTemplatesId + required: true + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/subscriptions/{subscriptionsId}:refresh: parameters: *ref_1 post: diff --git a/providers/src/googleapis.com/v00.00.00000/services/apigateway.yaml b/providers/src/googleapis.com/v00.00.00000/services/apigateway.yaml index 51df18a6..b33308c9 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/apigateway.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/apigateway.yaml @@ -7,8 +7,8 @@ info: title: API Gateway API description: '' version: v1 - x-discovery-doc-revision: '20241022' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250813' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/api-gateway/docs servers: @@ -877,8 +877,8 @@ components: description: >- Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled - have Operation.error value with a google.rpc.Status.code of 1, - corresponding to `Code.CANCELLED`. + have google.longrunning.Operation.error value with a + google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. readOnly: true type: boolean apiVersion: @@ -1369,6 +1369,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: @@ -1523,7 +1527,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: apigateway.projects.locations.operations.cancel requestBody: content: diff --git a/providers/src/googleapis.com/v00.00.00000/services/apigee.yaml b/providers/src/googleapis.com/v00.00.00000/services/apigee.yaml index d27d68a6..9bc812ab 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/apigee.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/apigee.yaml @@ -12,8 +12,8 @@ info: more. Note: This product is available as a free trial for a time period of 60 days. version: v1 - x-discovery-doc-revision: '20241024' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250814' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/apigee-api-management/ servers: @@ -39,2603 +39,2414 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudApigeeV1QueryTabularStatsRequest: - id: GoogleCloudApigeeV1QueryTabularStatsRequest + GoogleCloudApigeeV1ListHybridIssuersResponse: + id: GoogleCloudApigeeV1ListHybridIssuersResponse type: object - description: >- - Request payload representing the query to be run for fetching security - statistics as rows. properties: - pageSize: - description: Page size represents the number of rows. - type: integer - format: int32 - metrics: - description: Required. List of metrics and their aggregations. + issuers: + description: Lists of hybrid services and its trusted issuer email ids. type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1MetricAggregation' - timeRange: - $ref: '#/components/schemas/GoogleTypeInterval' - description: Time range for the stats. - filter: - type: string - description: >- - Filter further on specific dimension values. Follows the same - grammar as custom report's filter expressions. Example, apiproxy eq - 'foobar'. - https://cloud.google.com/apigee/docs/api-platform/analytics/analytics-reference#filters - pageToken: + $ref: '#/components/schemas/GoogleCloudApigeeV1ServiceIssuersMapping' + GoogleCloudApigeeV1ServiceIssuersMapping: + id: GoogleCloudApigeeV1ServiceIssuersMapping + type: object + properties: + service: + description: String indicating the Apigee service name. type: string - description: Identifies a sequence of rows. - dimensions: - description: Required. List of dimension names to group the aggregations by. + emailIds: + description: List of trusted issuer email ids. + type: array items: type: string - type: array - GoogleCloudApigeeV1DatastoreConfig: + GoogleApiHttpBody: + id: GoogleApiHttpBody + description: >- + Message that represents an arbitrary HTTP body. It should only be used + for payload formats that can't be represented as JSON, such as raw + binary or an HTML page. This message can be used both in streaming and + non-streaming API methods in the request as well as the response. It can + be used as a top-level request field, which is convenient if one wants + to extract parameters from either the URL or HTTP template into the + request fields and also want access to the raw HTTP body. Example: + message GetResourceRequest { // A unique request id. string request_id = + 1; // The raw HTTP body is bound to this field. google.api.HttpBody + http_body = 2; } service ResourceService { rpc + GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc + UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } + Example with streaming methods: service CaldavService { rpc + GetCalendar(stream google.api.HttpBody) returns (stream + google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) + returns (stream google.api.HttpBody); } Use of this type only changes + how the request and response bodies are handled, all other features will + continue to work unchanged. + type: object properties: - tablePrefix: - type: string - description: Prefix of BigQuery table Required for `bigquery` target_type. - bucketName: - description: Name of the Cloud Storage bucket. Required for `gcs` target_type. + contentType: + description: >- + The HTTP Content-Type header value specifying the content type of + the body. type: string - datasetName: + data: + description: The HTTP request/response body as raw binary. type: string - description: BigQuery dataset name Required for `bigquery` target_type. - path: + format: byte + extensions: + description: >- + Application specific response metadata. Must be set in the first + response for streaming APIs. + type: array + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + GoogleCloudApigeeV1ResourceFile: + id: GoogleCloudApigeeV1ResourceFile + description: Metadata about a resource file. + type: object + properties: + name: + description: ID of the resource file. type: string - description: Path of Cloud Storage bucket Required for `gcs` target_type. - projectId: + type: + description: Resource file type. {{ resource_file_type }} type: string - description: Required. Google Cloud project in which the datastore exists - id: GoogleCloudApigeeV1DatastoreConfig - description: Configuration detail for datastore + GoogleCloudApigeeV1ListEnvironmentResourcesResponse: + id: GoogleCloudApigeeV1ListEnvironmentResourcesResponse + description: Response for ListEnvironmentResources type: object - GoogleCloudApigeeV1DebugSession: - id: GoogleCloudApigeeV1DebugSession + properties: + resourceFile: + description: List of resources files. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' + GoogleCloudApigeeV1ListApiProxiesResponse: + id: GoogleCloudApigeeV1ListApiProxiesResponse type: object properties: - filter: - type: string - description: >- - Optional. A conditional statement which is evaluated against the - request message to determine if it should be traced. Syntax matches - that of on API Proxy bundle flow Condition. - timeout: - type: string - description: >- - Optional. The time in seconds after which this DebugSession should - end. This value will override the value in query param, if both are - provided. - format: int64 + proxies: + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' + GoogleCloudApigeeV1ApiProxy: + id: GoogleCloudApigeeV1ApiProxy + description: Metadata describing the API proxy + type: object + properties: + metaData: + description: Output only. Metadata describing the API proxy. + readOnly: true + $ref: '#/components/schemas/GoogleCloudApigeeV1EntityMetadata' name: - description: A unique ID for this DebugSession. + description: Output only. Name of the API proxy. + readOnly: true type: string - createTime: + revision: + description: Output only. List of revisions defined for the API proxy. + readOnly: true + type: array + items: + type: string + latestRevisionId: description: >- - Output only. The first transaction creation timestamp, recorded by - UAP. - format: google-datetime + Output only. The id of the most recently created revision for this + api proxy. readOnly: true type: string - validity: - format: int32 - type: integer - description: >- - Optional. The length of time, in seconds, that this debug session is - valid, starting from when it's received in the control plane. Min = - 1, Max = 15, Default = 10. - tracesize: + labels: + description: User labels applied to this API Proxy. + type: object + additionalProperties: + type: string + readOnly: description: >- - Optional. The maximum number of bytes captured from the response - payload. Min = 0, Max = 5120, Default = 5120. - format: int32 - type: integer - count: + Output only. Whether this proxy is read-only. A read-only proxy + cannot have new revisions created through calls to + CreateApiProxyRevision. A proxy is read-only if it was generated by + an archive. + readOnly: true + type: boolean + apiProxyType: + description: Output only. The type of the API proxy. + readOnly: true + type: string + enumDescriptions: + - API proxy type not specified. + - >- + Programmable API Proxies enable you to develop APIs with highly + flexible behavior using bundled policy configuration and one or + more programming languages to describe complex sequential and/or + conditional flows of logic. + - >- + Configurable API Proxies enable you to develop efficient APIs + using simple configuration while complex execution control flow + logic is handled by Apigee. This type only works with the ARCHIVE + deployment type and cannot be combined with the PROXY deployment + type. + enum: + - API_PROXY_TYPE_UNSPECIFIED + - PROGRAMMABLE + - CONFIGURABLE + space: description: >- - Optional. The number of request to be traced. Min = 1, Max = 15, - Default = 10. - type: integer - format: int32 - GoogleCloudApigeeV1Export: + Optional. The id of the space this proxy is associated with. Any IAM + policies applied to the space will control access to this proxy. To + learn how Spaces can be used to manage resources, read the [Apigee + Spaces + Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview). + type: string + GoogleCloudApigeeV1EntityMetadata: + id: GoogleCloudApigeeV1EntityMetadata + description: Metadata common to many entities in this API. type: object properties: - description: - type: string - description: Description of the export job. - self: + createdAt: description: >- - Output only. Self link of the export job. A URI that can be used to - retrieve the status of an export job. Example: - `/organizations/myorg/environments/myenv/analytics/exports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` - type: string - readOnly: true - updated: - type: string - readOnly: true - description: Output only. Time the export job was last updated. - state: - readOnly: true + Time at which the API proxy was created, in milliseconds since + epoch. type: string + format: int64 + lastModifiedAt: description: >- - Output only. Status of the export job. Valid values include - `enqueued`, `running`, `completed`, and `failed`. - created: - readOnly: true - description: Output only. Time the export job was created. + Time at which the API proxy was most recently modified, in + milliseconds since epoch. type: string - datastoreName: + format: int64 + subType: + description: The type of entity described type: string + GoogleCloudApigeeV1MoveApiProxyRequest: + id: GoogleCloudApigeeV1MoveApiProxyRequest + description: Moves an API Proxy to a different Space. + type: object + properties: + space: description: >- - Name of the datastore that is the destination of the export job - [datastore] - executionTime: + Optional. Resource ID of the space to move the proxy to. If + unspecified, the proxy will be moved to the organization level. type: string - description: >- - Output only. Execution time for this export job. If the job is still - in progress, it will be set to the amount of time that has elapsed - since`created`, in seconds. Else, it will set to (`updated` - - `created`), in seconds. - readOnly: true - error: - type: string - readOnly: true - description: Output only. Error is set when export fails - name: - type: string - description: Display name of the export job. - description: Details of an export job. - id: GoogleCloudApigeeV1Export - GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequest: + GoogleCloudApigeeV1ApiProxyRevision: + id: GoogleCloudApigeeV1ApiProxyRevision + description: API proxy revision. + type: object properties: - profile: - description: Required. Name of the profile that is used for computation. - type: string - include: - description: Include only these resources. - $ref: >- - #/components/schemas/GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArray - pageToken: - type: string - description: >- - Optional. A page token, received from a previous - `BatchComputeSecurityAssessmentResults` call. Provide this to - retrieve the subsequent page. - includeAllResources: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestIncludeAll - description: Include all resources under the scope. - scope: + basepaths: + description: Base URL of the API proxy. + type: array + items: + type: string + configurationVersion: description: >- - Required. Scope of the resources for the computation. For Apigee, - the environment is the scope of the resources. + Version of the API proxy configuration schema to which the API proxy + conforms. Currently, the only supported value is 4.0 + (`majorVersion.minorVersion`). This setting may be used in the + future to track the evolution of the API proxy format. + $ref: '#/components/schemas/GoogleCloudApigeeV1ConfigVersion' + contextInfo: + description: Revision number, app name, and organization for the API proxy. type: string - pageSize: - type: integer + createdAt: description: >- - Optional. The maximum number of results to return. The service may - return fewer than this value. If unspecified, at most 50 results - will be returned. - format: int32 - id: GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequest - type: object - description: Request for BatchComputeSecurityAssessmentResults. - GoogleCloudApigeeV1NatAddress: - type: object - id: GoogleCloudApigeeV1NatAddress - properties: - ipAddress: + Time that the API proxy revision was created in milliseconds since + epoch. type: string - readOnly: true - description: Output only. The static IPV4 address. - state: - enum: - - STATE_UNSPECIFIED - - CREATING - - RESERVED - - ACTIVE - - DELETING - enumDescriptions: - - The resource is in an unspecified state. - - The NAT address is being created. - - The NAT address is reserved but not yet used for Internet egress. - - The NAT address is active and used for Internet egress. - - The NAT address is being deleted. + format: int64 + displayName: + description: Human-readable name of the API proxy. type: string - description: Output only. State of the nat address. - readOnly: true + description: + description: Description of the API proxy revision. + type: string + entityMetaDataAsProperties: + description: Metadata describing the API proxy revision as a key-value map. + type: object + additionalProperties: + type: string + lastModifiedAt: + description: >- + Time that the API proxy revision was last modified in milliseconds + since epoch. + type: string + format: int64 name: - description: Required. Resource ID of the NAT address. + description: Name of the API proxy. type: string - description: >- - Apigee NAT(network address translation) address. A NAT address is a - static external IP address used for Internet egress traffic. - GoogleCloudApigeeV1AsyncQueryResultView: - properties: - rows: + revision: + description: API proxy revision. + type: string + policies: + description: List of policy names included in the API proxy revision.. + type: array items: - type: any + type: string + proxies: + description: List of proxy names included in the API proxy revision. + type: array + items: + type: string + proxyEndpoints: description: >- - Rows of query result. Each row is a JSON object. Example: - {sum(message_count): 1, developer_app: "(not set)",…} + List of ProxyEndpoints in the `/proxies` directory of the API proxy. + Typically, this element is included only when the API proxy was + created using the Edge UI. This is a 'manifest' setting designed to + provide visibility into the contents of the API proxy. type: array - metadata: + items: + type: string + resourceFiles: + description: List of resource files included in the API proxy revision. + $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFiles' + resources: description: >- - Metadata contains information like metrics, dimenstions etc of the - AsyncQuery. - $ref: '#/components/schemas/GoogleCloudApigeeV1QueryMetadata' - code: - description: Error code when there is a failure. - format: int32 - type: integer - state: - description: State of retrieving ResultView. - type: string - error: + List of the resources included in the API proxy revision formatted + as "{type}://{name}". + type: array + items: + type: string + sharedFlows: + description: List of the shared flows included in the API proxy revision. + type: array + items: + type: string + spec: + description: >- + OpenAPI Specification that is associated with the API proxy. The + value is set to a URL or to a path in the specification store. type: string - description: Error message when there is a failure. - id: GoogleCloudApigeeV1AsyncQueryResultView - type: object - GoogleRpcStatus: - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - id: GoogleRpcStatus - properties: - code: - format: int32 - type: integer - description: The status code, which should be an enum value of google.rpc.Code. - details: + targetEndpoints: description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. + List of TargetEndpoints in the `/targets` directory of the API + proxy. Typically, this element is included only when the API proxy + was created using the Edge UI. This is a 'manifest' setting designed + to provide visibility into the contents of the API proxy. type: array items: - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - message: - type: string + type: string + targetServers: description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - type: object - GoogleCloudApigeeV1EnvironmentGroup: - type: object - properties: - name: - description: ID of the environment group. - type: string - hostnames: - description: Required. Host names for this environment group. + List of TargetServers referenced in any TargetEndpoint in the API + proxy. Typically, you will see this element only when the API proxy + was created using the Edge UI. This is a 'manifest' setting designed + to provide visibility into the contents of the API proxy. type: array items: type: string - createdAt: - type: string - format: int64 - readOnly: true + targets: + description: List of the targets included in the API proxy revision. + type: array + items: + type: string + integrationEndpoints: description: >- - Output only. The time at which the environment group was created as - milliseconds since epoch. - state: - readOnly: true + List of IntegrationEndpoints in the '/integration-endpoints' + directory of the API proxy. This is a 'manifest' setting designed to + provide visibility into the contents of the API proxy. + type: array + items: + type: string + type: description: >- - Output only. State of the environment group. Values other than - ACTIVE means the resource is not ready to use. - enumDescriptions: - - Resource is in an unspecified state. - - Resource is being created. - - Resource is provisioned and ready to use. - - The resource is being deleted. - - The resource is being updated. - enum: - - STATE_UNSPECIFIED - - CREATING - - ACTIVE - - DELETING - - UPDATING + Type. Set to `Application`. Maintained for compatibility with the + Apigee Edge API. type: string - lastModifiedAt: - readOnly: true + teams: + description: List of the teams included in the API proxy revision. + type: array + items: + type: string + archive: description: >- - Output only. The time at which the environment group was last - updated as milliseconds since epoch. - type: string - format: int64 + Output only. The archive that generated this proxy revision. This + field is only present on proxy revisions that were generated by an + archive. Proxies generated by archives cannot be updated, deleted, + or deployed to other environments. Format: + `organizations/*/environments/*/archiveDeployments/*` + readOnly: true + type: string + hasExtensiblePolicy: + description: >- + Output only. This field will be marked as true if revision contains + any policies marked as extensible. + readOnly: true + type: boolean + GoogleCloudApigeeV1ConfigVersion: + id: GoogleCloudApigeeV1ConfigVersion description: >- - EnvironmentGroup configuration. An environment group is used to group - one or more Apigee environments under a single host name. - id: GoogleCloudApigeeV1EnvironmentGroup - GoogleCloudApigeeV1GrpcOperationGroup: + Version of the API proxy configuration schema. Currently, only 4.0 is + supported. type: object - description: >- - List of gRPC operation configuration details associated with Apigee API - proxies. properties: - operationConfigs: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1GrpcOperationConfig' + majorVersion: + description: Major version of the API proxy configuration schema. + type: integer + format: int32 + minorVersion: + description: Minor version of the API proxy configuration schema. + type: integer + format: int32 + GoogleCloudApigeeV1ResourceFiles: + id: GoogleCloudApigeeV1ResourceFiles + description: List of resource files. + type: object + properties: + resourceFile: + description: List of resource files. type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' + GoogleLongrunningListOperationsResponse: + id: GoogleLongrunningListOperationsResponse + description: The response message for Operations.ListOperations. + type: object + properties: + operations: description: >- - Required. List of operation configurations for either Apigee API - proxies that are associated with this API product. - id: GoogleCloudApigeeV1GrpcOperationGroup - GoogleCloudApigeeV1SecurityProfileV2: + A list of operations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/GoogleLongrunningOperation' + nextPageToken: + description: The standard List next-page token. + type: string + GoogleLongrunningOperation: + id: GoogleLongrunningOperation + description: >- + This resource represents a long-running operation that is the result of + a network API call. type: object properties: name: description: >- - Identifier. Name of the security profile v2 resource. Format: - organizations/{org}/securityProfilesV2/{profile} + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. type: string - googleDefined: + metadata: + description: >- + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + done: + description: >- + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. type: boolean - description: Output only. Whether the security profile is google defined. - readOnly: true - createTime: - readOnly: true - description: Output only. The time of the security profile creation. - format: google-datetime - type: string - description: - type: string - description: Optional. The description of the security profile. - profileAssessmentConfigs: + error: description: >- - Required. The configuration for each assessment in this profile. Key - is the name/id of the assessment. + The error result of the operation in case of failure or + cancellation. + $ref: '#/components/schemas/GoogleRpcStatus' + response: + description: >- + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. type: object additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityProfileV2ProfileAssessmentConfig - updateTime: - description: Output only. The time of the security profile update. - format: google-datetime - type: string - readOnly: true - id: GoogleCloudApigeeV1SecurityProfileV2 - description: Security profile for risk assessment version 2. - GoogleCloudApigeeV1ApiProxy: + type: any + description: Properties of the object. Contains field @type with type URL. + GoogleRpcStatus: + id: GoogleRpcStatus + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). type: object - description: Metadata describing the API proxy - id: GoogleCloudApigeeV1ApiProxy properties: - name: - description: Output only. Name of the API proxy. - type: string - readOnly: true - latestRevisionId: - readOnly: true + code: + description: The status code, which should be an enum value of google.rpc.Code. + type: integer + format: int32 + message: + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. type: string + details: description: >- - Output only. The id of the most recently created revision for this - api proxy. - revision: + A list of messages that carry the error details. There is a common + set of message types for APIs to use. type: array - readOnly: true - description: Output only. List of revisions defined for the API proxy. items: - type: string + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + GoogleCloudApigeeV1ArchiveDeployment: + id: GoogleCloudApigeeV1ArchiveDeployment + description: Archive Deployment information. + type: object + properties: + name: + description: >- + Name of the Archive Deployment in the following format: + `organizations/{org}/environments/{env}/archiveDeployments/{id}`. + type: string labels: - description: User labels applied to this API Proxy. + description: >- + User-supplied key-value pairs used to organize ArchiveDeployments. + Label keys must be between 1 and 63 characters long, have a UTF-8 + encoding of maximum 128 bytes, and must conform to the following + PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values must be + between 1 and 63 characters long, have a UTF-8 encoding of maximum + 128 bytes, and must conform to the following PCRE regular + expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can + be associated with a given store. type: object additionalProperties: type: string - apiProxyType: - readOnly: true - enum: - - API_PROXY_TYPE_UNSPECIFIED - - PROGRAMMABLE - - CONFIGURABLE - description: Output only. The type of the API proxy. - enumDescriptions: - - API proxy type not specified. - - >- - Programmable API Proxies enable you to develop APIs with highly - flexible behavior using bundled policy configuration and one or - more programming languages to describe complex sequential and/or - conditional flows of logic. - - >- - Configurable API Proxies enable you to develop efficient APIs - using simple configuration while complex execution control flow - logic is handled by Apigee. This type only works with the ARCHIVE - deployment type and cannot be combined with the PROXY deployment - type. - type: string - readOnly: - readOnly: true - type: boolean + createdAt: description: >- - Output only. Whether this proxy is read-only. A read-only proxy - cannot have new revisions created through calls to - CreateApiProxyRevision. A proxy is read-only if it was generated by - an archive. - metaData: - $ref: '#/components/schemas/GoogleCloudApigeeV1EntityMetadata' - description: Output only. Metadata describing the API proxy. + Output only. The time at which the Archive Deployment was created in + milliseconds since the epoch. readOnly: true - GoogleCloudApigeeV1EnvironmentConfig: - type: object - properties: - featureFlags: - additionalProperties: - type: string - description: Feature flags inherited from the organization and environment. - type: object - gatewayConfigLocation: type: string + format: int64 + updatedAt: description: >- - The location for the gateway config blob as a URI, e.g. a Cloud - Storage URI. This is only used by Envoy-based gateways. - arcConfigLocation: - description: >- - The location for the config blob of API Runtime Control, aka Envoy - Adapter, for op-based authentication as a URI, e.g. a Cloud Storage - URI. This is only used by Envoy-based gateways. + Output only. The time at which the Archive Deployment was updated in + milliseconds since the epoch. + readOnly: true type: string - targets: - type: array + format: int64 + gcsUri: description: >- - List of target servers in the environment. Disabled target servers - are not displayed. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServerConfig' - name: + Input only. The Google Cloud Storage signed URL returned from + GenerateUploadUrl and used to upload the Archive zip file. type: string + operation: description: >- - Name of the environment configuration in the following format: - `organizations/{org}/environments/{env}/configs/{config}` - deploymentGroups: - description: List of deployment groups in the environment. + Output only. A reference to the LRO that created this Archive + Deployment in the following format: + `organizations/{org}/operations/{id}` + readOnly: true + type: string + GoogleCloudApigeeV1ListArchiveDeploymentsResponse: + id: GoogleCloudApigeeV1ListArchiveDeploymentsResponse + description: Response for ListArchiveDeployments method. + type: object + properties: + archiveDeployments: + description: Archive Deployments in the specified environment. type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeploymentGroupConfig' - traceConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeTraceConfig' + $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' + nextPageToken: description: >- - Trace configurations. Contains config for the environment and config - overrides for specific API proxies. - addonsConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeAddonsConfig' - description: The latest runtime configurations for add-ons. - createTime: + Page token that you can include in a ListArchiveDeployments request + to retrieve the next page. If omitted, no subsequent pages exist. type: string - format: google-datetime - description: Time that the environment configuration was created. - revisionId: + GoogleCloudApigeeV1GenerateUploadUrlRequest: + id: GoogleCloudApigeeV1GenerateUploadUrlRequest + description: Request for GenerateUploadUrl method. + type: object + properties: {} + GoogleCloudApigeeV1GenerateUploadUrlResponse: + id: GoogleCloudApigeeV1GenerateUploadUrlResponse + description: Response for GenerateUploadUrl method. + type: object + properties: + uploadUri: description: >- - Revision ID of the environment configuration. The higher the value, - the more recently the configuration was deployed. + The Google Cloud Storage signed URL that can be used to upload a new + Archive zip file. + type: string + GoogleCloudApigeeV1GenerateDownloadUrlRequest: + id: GoogleCloudApigeeV1GenerateDownloadUrlRequest + description: Request for GenerateDownloadUrl method. + type: object + properties: {} + GoogleCloudApigeeV1GenerateDownloadUrlResponse: + id: GoogleCloudApigeeV1GenerateDownloadUrlResponse + description: Response for GenerateDownloadUrl method. + type: object + properties: + downloadUri: + description: >- + The Google Cloud Storage signed URL that can be used to download the + Archive zip file. + type: string + GoogleProtobufEmpty: + id: GoogleProtobufEmpty + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + type: object + properties: {} + GoogleCloudApigeeV1DataCollector: + id: GoogleCloudApigeeV1DataCollector + description: Data collector configuration. + type: object + properties: + name: + description: ID of the data collector. Must begin with `dc_`. + type: string + description: + description: A description of the data collector. + type: string + type: + description: Immutable. The type of data this data collector will collect. + type: string + enumDescriptions: + - For future compatibility. + - For integer values. + - For float values. + - For string values. + - For boolean values. + - For datetime values. + enum: + - TYPE_UNSPECIFIED + - INTEGER + - FLOAT + - STRING + - BOOLEAN + - DATETIME + createdAt: + description: >- + Output only. The time at which the data collector was created in + milliseconds since the epoch. + readOnly: true + type: string format: int64 + lastModifiedAt: + description: >- + Output only. The time at which the Data Collector was last updated + in milliseconds since the epoch. + readOnly: true type: string - resourceReferences: - description: List of resource references in the environment. + format: int64 + GoogleCloudApigeeV1ListDataCollectorsResponse: + id: GoogleCloudApigeeV1ListDataCollectorsResponse + description: Response for ListDataCollectors. + type: object + properties: + dataCollectors: + description: Data collectors in the specified organization. type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ReferenceConfig' - keystores: - description: List of keystores in the environment. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeystoreConfig' - type: array - provider: + $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' + nextPageToken: description: >- - Used by the Control plane to add context information to help detect - the source of the document during diagnostics and debugging. + Page token that you can include in a ListDataCollectors request to + retrieve the next page. If omitted, no subsequent pages exist. type: string - pubsubTopic: + GoogleCloudApigeeV1DebugMask: + id: GoogleCloudApigeeV1DebugMask + type: object + properties: + name: + description: Name of the debug mask. type: string - description: Name of the PubSub topic for the environment. - resources: + namespaces: + description: Map of namespaces to URIs. + type: object + additionalProperties: + type: string + requestXPaths: + description: >- + List of XPaths that specify the XML elements to be filtered from XML + request message payloads. type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceConfig' - description: List of resource versions in the environment. - dataCollectors: - description: List of data collectors used by the deployments in the environment. + type: string + responseXPaths: + description: >- + List of XPaths that specify the XML elements to be filtered from XML + response message payloads. + type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollectorConfig' + type: string + faultXPaths: + description: >- + List of XPaths that specify the XML elements to be filtered from XML + payloads in error flows. type: array - debugMask: - description: Debug mask that applies to all deployments in the environment. - $ref: '#/components/schemas/GoogleCloudApigeeV1DebugMask' - deployments: - description: List of deployments in the environment. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeploymentConfig' + type: string + requestJSONPaths: + description: >- + List of JSON paths that specify the JSON elements to be filtered + from JSON request message payloads. type: array - flowhooks: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1FlowHookConfig' + type: string + responseJSONPaths: + description: >- + List of JSON paths that specify the JSON elements to be filtered + from JSON response message payloads. type: array - description: List of flow hooks in the environment. - sequenceNumber: - type: string - format: int64 - description: 'DEPRECATED: Use revision_id.' - uid: + items: + type: string + faultJSONPaths: description: >- - Unique ID for the environment configuration. The ID will only change - if the environment is deleted and recreated. - type: string - forwardProxyUri: + List of JSON paths that specify the JSON elements to be filtered + from JSON payloads in error flows. + type: array + items: + type: string + variables: + description: List of variables that should be masked from the debug output. + type: array + items: + type: string + GoogleCloudApigeeV1Deployment: + id: GoogleCloudApigeeV1Deployment + description: Deployment represents a deployment of an API proxy or shared flow. + type: object + properties: + environment: + description: Environment. type: string - description: >- - The forward proxy's url to be used by the runtime. When set, runtime - will send requests to the target via the given forward proxy. This - is only used by programmable gateways. - envScopedRevisionId: - description: >- - Revision ID for environment-scoped resources (e.g. target servers, - keystores) in this config. This ID will increment any time a - resource not scoped to a deployment group changes. - format: int64 + apiProxy: + description: API proxy. type: string - id: GoogleCloudApigeeV1EnvironmentConfig - GoogleCloudApigeeV1DeveloperSubscription: - properties: - apiproduct: + revision: + description: API proxy revision. type: string + deployStartTime: description: >- - Name of the API product for which the developer is purchasing a - subscription. - endTime: + Time the API proxy was marked `deployed` in the control plane in + millisconds since epoch. type: string format: int64 + pods: description: >- - Time when the API product subscription ends in milliseconds since - epoch. - createdAt: - readOnly: true - format: int64 + Status reported by runtime pods. **Note**: **This field is + deprecated**. Runtime versions 1.3 and above report instance level + status rather than pod status. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1PodStatus' + state: description: >- - Output only. Time when the API product subscription was created in - milliseconds since epoch. - type: string - startTime: + Current state of the deployment. **Note**: This field is displayed + only when viewing deployment status. type: string + enumDescriptions: + - This value should never be returned. + - Runtime has loaded the deployment. + - Deployment is not fully ready in the runtime. + - >- + Encountered an error with the deployment that requires + intervention. + enum: + - RUNTIME_STATE_UNSPECIFIED + - READY + - PROGRESSING + - ERROR + errors: description: >- - Time when the API product subscription starts in milliseconds since - epoch. - format: int64 - lastModifiedAt: - type: string + Errors reported for this deployment. Populated only when state == + ERROR. **Note**: This field is displayed only when viewing + deployment status. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + routeConflicts: description: >- - Output only. Time when the API product subscription was last - modified in milliseconds since epoch. - readOnly: true - format: int64 - name: - description: Output only. Name of the API product subscription. - readOnly: true - type: string - id: GoogleCloudApigeeV1DeveloperSubscription - type: object - description: Structure of a DeveloperSubscription. - GoogleCloudApigeeV1Point: - properties: - results: - description: List of results extracted from a given debug point. + Conflicts in the desired state routing configuration. The presence + of conflicts does not cause the state to be `ERROR`, but it will + mean that some of the deployment's base paths are not routed to its + environment. If the conflicts change, the state will transition to + `PROGRESSING` until the latest configuration is rolled out to all + instances. **Note**: This field is displayed only when viewing + deployment status. type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Result' - id: - description: Name of a step in the transaction. - type: string - description: >- - Point is a group of information collected by runtime plane at critical - points of the message flow of the processed API request. This is a list - of supported point IDs, categorized to three major buckets. For each - category, debug points that we are currently supporting are listed - below: - Flow status debug points: StateChange FlowInfo Condition - Execution DebugMask Error - Flow control debug points: FlowCallout - Paused Resumed FlowReturn BreakFlow Error - Runtime debug points: - ScriptExecutor FlowCalloutStepDefinition CustomTarget StepDefinition - Oauth2ServicePoint RaiseFault NodeJS The detail information of the given - debug point is stored in a list of results. - type: object - id: GoogleCloudApigeeV1Point - GoogleCloudApigeeV1ListExportsResponse: - type: object - description: The response for ListExports - properties: - exports: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict + instances: + description: >- + Status reported by each runtime instance. **Note**: This field is + displayed only when viewing deployment status. type: array - description: Details of the export jobs. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Export' - id: GoogleCloudApigeeV1ListExportsResponse - GoogleCloudApigeeV1ApiCategoryResponse: - description: The API category resource wrapped with response status, error_code, etc. - properties: - message: - type: string - description: Description of the operation. - errorCode: - type: string - description: Unique error code for the request, if any. - requestId: - description: Unique ID of the request. - type: string - status: + $ref: '#/components/schemas/GoogleCloudApigeeV1InstanceDeploymentStatus' + serviceAccount: + description: >- + The full resource name of Cloud IAM Service Account that this + deployment is using, eg, `projects/-/serviceAccounts/{email}`. type: string - description: Status of the operation. - data: - description: The API category resource. - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategory' - type: object - id: GoogleCloudApigeeV1ApiCategoryResponse - GoogleCloudApigeeV1Organization: - id: GoogleCloudApigeeV1Organization - type: object - properties: - description: + proxyDeploymentType: + description: >- + Output only. The type of the deployment (standard or extensible) + Deployed proxy revision will be marked as extensible in following 2 + cases. 1. The deployed proxy revision uses extensible policies. 2. + If a environment supports flowhooks and flow hook is configured. + readOnly: true type: string - description: Description of the Apigee organization. - subscriptionType: enumDescriptions: - - Subscription type not specified. - - Full subscription to Apigee has been purchased. - >- - Subscription to Apigee is free, limited, and used for evaluation - purposes only. - readOnly: true + Default value till public preview. After public preview this value + should not be returned. + - >- + Deployment will be of type Standard if only Standard proxies are + used + - >- + Proxy will be of type Extensible if deployments uses one or more + Extensible proxies enum: - - SUBSCRIPTION_TYPE_UNSPECIFIED - - PAID - - TRIAL + - PROXY_DEPLOYMENT_TYPE_UNSPECIFIED + - STANDARD + - EXTENSIBLE + GoogleCloudApigeeV1PodStatus: + id: GoogleCloudApigeeV1PodStatus + type: object + properties: + podName: + description: Name of the pod which is reporting the status. type: string - description: >- - Output only. DEPRECATED: This will eventually be replaced by - BillingType. Subscription type of the Apigee organization. Valid - values include trial (free, limited, and for evaluation purposes - only) or paid (full subscription has been purchased). See [Apigee - pricing](https://cloud.google.com/apigee/pricing/). - deprecated: true - state: - enum: - - STATE_UNSPECIFIED - - CREATING - - ACTIVE - - DELETING - - UPDATING - readOnly: true - enumDescriptions: - - Resource is in an unspecified state. - - Resource is being created. - - Resource is provisioned and ready to use. - - The resource is being deleted. - - The resource is being updated. - description: >- - Output only. State of the organization. Values other than ACTIVE - means the resource is not ready to use. + appVersion: + description: Version of the application running in the pod. type: string - lastModifiedAt: + podStatus: description: >- - Output only. Time that the Apigee organization was last modified in - milliseconds since epoch. + Overall status of the pod (not this specific deployment). Valid + values include: - `active`: Up to date. - `stale` : Recently out of + date. Pods that have not reported status in a long time are excluded + from the output. + type: string + podStatusTime: + description: Time the pod status was reported in milliseconds since epoch. type: string format: int64 - readOnly: true - projectId: - readOnly: true + deploymentStatusTime: + description: Time the deployment status was reported in milliseconds since epoch. type: string - description: Output only. Project ID associated with the Apigee organization. - displayName: + format: int64 + deploymentTime: + description: Time the proxy was deployed in milliseconds since epoch. + type: string + format: int64 + deploymentStatus: description: >- - Display name for the Apigee organization. Unused, but reserved for - future use. + Status of the deployment. Valid values include: - `deployed`: + Successful. - `error` : Failed. - `pending` : Pod has not yet + reported on the deployment. type: string - customerName: + statusCode: + description: Code associated with the deployment status. type: string - description: Not used by Apigee. - subscriptionPlan: - readOnly: true - description: >- - Output only. Subscription plan that the customer has purchased. - Output only. + statusCodeDetails: + description: Human-readable message associated with the status code. type: string - enumDescriptions: - - Subscription plan not specified. - - Traditional subscription plan. - - >- - New subscription plan that provides standard proxy and scaled - proxy implementation. - enum: - - SUBSCRIPTION_PLAN_UNSPECIFIED - - SUBSCRIPTION_2021 - - SUBSCRIPTION_2024 - name: + GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict: + id: GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict + description: >- + Describes a routing conflict that may cause a deployment not to receive + traffic at some base path. + type: object + properties: + environmentGroup: + description: Name of the environment group in which this conflict exists. type: string - description: Output only. Name of the Apigee organization. - readOnly: true - caCertificate: + conflictingDeployment: + description: Existing base path/deployment causing the conflict. + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment + description: + description: Human-readable description of this conflict. type: string - format: byte - readOnly: true - description: >- - Output only. Base64-encoded public certificate for the root CA of - the Apigee organization. Valid only when [RuntimeType](#RuntimeType) - is `CLOUD`. - portalDisabled: - description: Configuration for the Portals settings. - type: boolean - apigeeProjectId: - description: >- - Output only. Apigee Project ID associated with the organization. Use - this project to allowlist Apigee in the Service Attachment when - using private service connect with Apigee. + GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment: + id: GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment + description: Tuple representing a base path and the deployment containing it. + type: object + properties: + basepath: + description: Base path receiving traffic. type: string - readOnly: true - properties: - $ref: '#/components/schemas/GoogleCloudApigeeV1Properties' - description: Properties defined in the Apigee organization profile. - attributes: - items: - type: string - description: Not used by Apigee. - type: array - type: - enumDescriptions: - - Subscription type not specified. - - >- - Subscription to Apigee is free, limited, and used for evaluation - purposes only. - - >- - Full subscription to Apigee has been purchased. See [Apigee - pricing](https://cloud.google.com/apigee/pricing/). - - For internal users only. + environment: + description: Name of the environment in which the proxy is deployed. type: string - enum: - - TYPE_UNSPECIFIED - - TYPE_TRIAL - - TYPE_PAID - - TYPE_INTERNAL - description: Not used by Apigee. - authorizedNetwork: - description: >- - Compute Engine network used for Service Networking to be peered with - Apigee runtime instances. See [Getting started with the Service - Networking - API](https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started). - Valid only when [RuntimeType](#RuntimeType) is set to `CLOUD`. The - value must be set before the creation of a runtime instance and can - be updated only when there are no runtime instances. For example: - `default`. Apigee also supports shared VPC (that is, the host - network project is not the same as the one that is peering with - Apigee). See [Shared VPC - overview](https://cloud.google.com/vpc/docs/shared-vpc). To use a - shared VPC network, use the following format: - `projects/{host-project-id}/{region}/networks/{network-name}`. For - example: `projects/my-sharedvpc-host/global/networks/mynetwork` - **Note:** Not supported for Apigee hybrid. + apiProxy: + description: Name of the deployed API proxy revision containing the base path. type: string - addonsConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1AddonsConfig' - description: Addon configurations of the Apigee organization. - controlPlaneEncryptionKeyName: + revision: + description: Name of the deployed API proxy revision containing the base path. type: string - description: >- - Cloud KMS key name used for encrypting control plane data that is - stored in a multi region. Only used for the data residency region - "US" or "EU". If not specified or [BillingType](#BillingType) is - `EVALUATION`, a Google-Managed encryption key will be used. Format: - `projects/*/locations/*/keyRings/*/cryptoKeys/*` - runtimeDatabaseEncryptionKeyName: - description: >- - Cloud KMS key name used for encrypting the data that is stored and - replicated across runtime instances. Update is not allowed after the - organization is created. If not specified or - [RuntimeType](#RuntimeType) is `TRIAL`, a Google-Managed encryption - key will be used. For example: - "projects/foo/locations/us/keyRings/bar/cryptoKeys/baz". **Note:** - Not supported for Apigee hybrid. + GoogleCloudApigeeV1InstanceDeploymentStatus: + id: GoogleCloudApigeeV1InstanceDeploymentStatus + description: The status of a deployment as reported by a single instance. + type: object + properties: + instance: + description: ID of the instance reporting the status. type: string - environments: - readOnly: true - items: - type: string - description: Output only. List of environments in the Apigee organization. + deployedRevisions: + description: Revisions currently deployed in MPs. type: array - disableVpcPeering: - type: boolean - description: >- - Optional. Flag that specifies whether the VPC Peering through - Private Google Access should be disabled between the consumer - network and Apigee. Valid only when RuntimeType is set to CLOUD. - Required if an authorizedNetwork on the consumer project is not - provided, in which case the flag should be set to true. The value - must be set before the creation of any Apigee runtime instance and - can be updated only when there are no runtime instances. **Note:** - Apigee will be deprecating the vpc peering model that requires you - to provide 'authorizedNetwork', by making the non-peering model as - the default way of provisioning Apigee organization in future. So, - this will be a temporary flag to enable the transition. Not - supported for Apigee hybrid. - expiresAt: - format: int64 - description: >- - Output only. Time that the Apigee organization is scheduled for - deletion. - readOnly: true - type: string - runtimeType: - description: >- - Required. Runtime type of the Apigee organization based on the - Apigee subscription purchased. - type: string - enum: - - RUNTIME_TYPE_UNSPECIFIED - - CLOUD - - HYBRID - enumDescriptions: - - Runtime type not specified. - - Google-managed Apigee runtime. - - User-managed Apigee hybrid runtime. - analyticsRegion: + items: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRevision + deployedRoutes: description: >- - Required. DEPRECATED: This field will eventually be deprecated and - replaced with a differently-named field. Primary Google Cloud region - for analytics data storage. For valid values, see [Create an Apigee - organization](https://cloud.google.com/apigee/docs/api-platform/get-started/create-org). + Current routes deployed in the ingress routing table. A route which + is missing will appear in `missing_routes`. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRoute + GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRevision: + id: GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRevision + description: Revisions deployed in the MPs. + type: object + properties: + revision: + description: API proxy revision reported as deployed. type: string - deprecated: true - apiConsumerDataEncryptionKeyName: + percentage: + description: Percentage of MP replicas reporting this revision. + type: integer + format: int32 + GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRoute: + id: GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRoute + description: Route deployed in the ingress routing table. + type: object + properties: + basepath: + description: Base path in the routing table. type: string - description: >- - Cloud KMS key name used for encrypting API consumer data. If not - specified or [BillingType](#BillingType) is `EVALUATION`, a - Google-Managed encryption key will be used. Format: - `projects/*/locations/*/keyRings/*/cryptoKeys/*` - createdAt: + envgroup: + description: Environment group where this route is installed. type: string - readOnly: true - description: >- - Output only. Time that the Apigee organization was created in - milliseconds since epoch. - format: int64 - apiConsumerDataLocation: + environment: description: >- - This field is needed only for customers using non-default data - residency regions. Apigee stores some control plane data only in - single region. This field determines which single region Apigee - should use. For example: "us-west1" when control plane is in US or - "europe-west2" when control plane is in EU. - type: string - billingType: + Destination environment. This will be empty if the route is not yet + reported. type: string - description: >- - Billing type of the Apigee organization. See [Apigee - pricing](https://cloud.google.com/apigee/pricing). - enum: - - BILLING_TYPE_UNSPECIFIED - - SUBSCRIPTION - - EVALUATION - - PAYG - enumDescriptions: - - Billing type not specified. - - A pre-paid subscription to Apigee. - - Free and limited access to Apigee for evaluation purposes only. - - Access to Apigee using a Pay-As-You-Go plan. - GoogleCloudApigeeV1OptimizedStatsNode: - type: object + percentage: + description: Percentage of ingress replicas reporting this route. + type: integer + format: int32 + GoogleCloudApigeeV1DeploymentChangeReport: + id: GoogleCloudApigeeV1DeploymentChangeReport description: >- - Encapsulates a data node as represented below: ``` { "identifier": { - "names": [ "apiproxy" ], "values": [ "sirjee" ] }, "metric": [ { "env": - "prod", "name": "sum(message_count)", "values": [ 36.0 ] } ] }``` or ``` - { "env": "prod", "name": "sum(message_count)", "values": [ 36.0 ] }``` - Depending on whether a dimension is present in the query or not the data - node type can be a simple metric value or dimension identifier with list - of metrics. - id: GoogleCloudApigeeV1OptimizedStatsNode + Response for GenerateDeployChangeReport and + GenerateUndeployChangeReport. This report contains any validation + failures that would cause the deployment to be rejected, as well changes + and conflicts in routing that may occur due to the new deployment. The + existence of a routing warning does not necessarily imply that the + deployment request is bad, if the desired state of the deployment + request is to effect a routing change. The primary purposes of the + routing messages are: 1) To inform users of routing changes that may + have an effect on traffic currently being routed to other existing + deployments. 2) To warn users if some base path in the proxy will not + receive traffic due to an existing deployment having already claimed + that base path. The presence of routing conflicts/changes will not cause + non-dry-run DeployApiProxy/UndeployApiProxy requests to be rejected. + type: object properties: - data: + validationErrors: + description: >- + Validation errors that would cause the deployment change request to + be rejected. + $ref: '#/components/schemas/GoogleRpcPreconditionFailure' + routingChanges: + description: All routing changes that may result from a deployment request. + type: array items: - type: any + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingChange + routingConflicts: + description: All base path conflicts detected for a deployment request. type: array - GoogleCloudApigeeV1Certificate: - id: GoogleCloudApigeeV1Certificate + items: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict + GoogleRpcPreconditionFailure: + id: GoogleRpcPreconditionFailure + description: >- + Describes what preconditions have failed. For example, if an RPC failed + because it required the Terms of Service to be acknowledged, it could + list the terms of service violation in the PreconditionFailure message. + type: object properties: - certInfo: + violations: + description: Describes all precondition violations. type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1CertInfo' - description: Chain of certificates under this name. + $ref: '#/components/schemas/GoogleRpcPreconditionFailureViolation' + GoogleRpcPreconditionFailureViolation: + id: GoogleRpcPreconditionFailureViolation + description: A message type used to describe a single precondition failure. type: object - GoogleCloudApigeeV1KeyAliasReference: properties: - aliasId: - type: string - description: Alias ID. Must exist in the keystore referred to by the reference. - reference: + type: + description: >- + The type of PreconditionFailure. We recommend using a + service-specific enum type to define the supported precondition + violation subjects. For example, "TOS" for "Terms of Service + violation". type: string + subject: description: >- - Reference name in the following format: - `organizations/{org}/environments/{env}/references/{reference}` - id: GoogleCloudApigeeV1KeyAliasReference - type: object - GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment: - properties: - revision: + The subject, relative to the type, that failed. For example, + "google.com/cloud" relative to the "TOS" type would indicate which + terms of service is being referenced. type: string - description: Name of the deployed API proxy revision containing the base path. - environment: - description: Name of the environment in which the proxy is deployed. - type: string - basepath: - description: Base path receiving traffic. - type: string - apiProxy: + description: + description: >- + A description of how the precondition failed. Developers can use + this description to understand how to fix the failure. For example: + "Terms of service not accepted". type: string - description: Name of the deployed API proxy revision containing the base path. - id: GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment - type: object - description: Tuple representing a base path and the deployment containing it. - GoogleCloudApigeeV1ProfileConfigCORS: - id: GoogleCloudApigeeV1ProfileConfigCORS - type: object - properties: {} - description: Checks to see if you have CORS policy in place. - GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArrayResource: + GoogleCloudApigeeV1DeploymentChangeReportRoutingChange: + id: GoogleCloudApigeeV1DeploymentChangeReportRoutingChange + description: >- + Describes a potential routing change that may occur as a result of some + deployment operation. type: object - description: Resource for which we are computing security assessment. - id: >- - GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArrayResource properties: - name: - type: string - description: Required. Name of this resource. - type: + environmentGroup: + description: Name of the environment group affected by this routing change. type: string - enum: - - RESOURCE_TYPE_UNSPECIFIED - - API_PROXY - enumDescriptions: - - ResourceType not specified. - - Resource is an Apigee Proxy. - description: Required. Type of this resource. - GoogleCloudApigeeV1ControlPlaneAccess: - description: >- - ControlPlaneAccess is the request body and response body of - UpdateControlPlaneAccess. and the response body of - GetControlPlaneAccess. The input identities contains an array of service - accounts to grant access to the respective control plane resource, with - each service account specified using the following format: - `serviceAccount:`***service-account-name***. The - ***service-account-name*** is formatted like an email address. For - example: - `my-control-plane-service_account@my_project_id.iam.gserviceaccount.com` - You might specify multiple service accounts, for example, if you have - multiple environments and wish to assign a unique service account to - each one. - id: GoogleCloudApigeeV1ControlPlaneAccess - properties: - analyticsPublisherIdentities: - items: - type: string - type: array - description: >- - Optional. Array of service accounts authorized to publish analytics - data to the control plane (for the Message Processor component). - name: + fromDeployment: + description: Base path/deployment that may stop receiving some traffic. + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment + toDeployment: description: >- - Identifier. The resource name of the ControlPlaneAccess. Format: - "organizations/{org}/controlPlaneAccess" - type: string - synchronizerIdentities: - type: array - items: - type: string + Base path/deployment that may start receiving that traffic. May be + null if no deployment is able to receive the traffic. + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment + shouldSequenceRollout: description: >- - Optional. Array of service accounts to grant access to control plane - resources (for the Synchronizer component). The service accounts - must have **Apigee Synchronizer Manager** role. See also [Create - service - accounts](https://cloud.google.com/apigee/docs/hybrid/latest/sa-about#create-the-service-accounts). - type: object - GoogleIamV1AuditConfig: - type: object - properties: - service: + Set to `true` if using sequenced rollout would make this routing + change safer. **Note**: This does not necessarily imply that + automated sequenced rollout mode is supported for the operation. + type: boolean + description: + description: Human-readable description of this routing change. type: string - 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. - auditLogConfigs: - items: - $ref: '#/components/schemas/GoogleIamV1AuditLogConfig' - type: array - description: The configuration for logging of each type of permission. - 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. - id: GoogleIamV1AuditConfig - GoogleCloudApigeeV1DeveloperAppKey: + GoogleCloudApigeeV1ListDeploymentsResponse: + id: GoogleCloudApigeeV1ListDeploymentsResponse type: object - id: GoogleCloudApigeeV1DeveloperAppKey properties: - consumerSecret: - description: Secret key. - type: string - scopes: - type: array - description: >- - Scopes to apply to the app. The specified scope names must already - be defined for the API product that you associate with the app. - items: - type: string - status: - type: string - description: >- - Status of the credential. Valid values include `approved` or - `revoked`. - apiProducts: - description: >- - List of API products for which the credential can be used. **Note**: - Do not specify the list of API products when creating a consumer key - and secret for a developer app. Instead, use the - UpdateDeveloperAppKey API to make the association after the consumer - key and secret are created. - items: - type: any - type: array - attributes: + deployments: + description: List of deployments. type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - description: List of attributes associated with the credential. - issuedAt: - format: int64 - type: string - description: Time the developer app was created in milliseconds since epoch. - consumerKey: - type: string - description: Consumer key. - expiresAt: - format: int64 - description: Time the developer app expires in milliseconds since epoch. - type: string - expiresInSeconds: - type: string - description: >- - Input only. Expiration time, in seconds, for the consumer key. If - not set or left to the default value of `-1`, the API key never - expires. The expiration time can't be updated after it is set. - format: int64 - GoogleCloudApigeeV1SecurityReport: - description: >- - SecurityReport saves all the information about the created security - report. + $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' + GoogleCloudApigeeV1FlowHook: + id: GoogleCloudApigeeV1FlowHook + type: object properties: - self: - type: string + flowHookPoint: description: >- - Self link of the query. Example: - `/organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` - or following format if query is running at host level: - `/organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` - reportDefinitionId: - type: string - description: Report Definition ID. - updated: - description: Output only. Last updated timestamp for the query. + Output only. Where in the API call flow the flow hook is invoked. + Must be one of `PreProxyFlowHook`, `PostProxyFlowHook`, + `PreTargetFlowHook`, or `PostTargetFlowHook`. readOnly: true type: string - displayName: - type: string - description: Display Name specified by the user. - executionTime: - type: string - description: ExecutionTime is available only after the query is completed. - error: - type: string - description: Error is set when query fails. - resultFileSize: - description: ResultFileSize is available only after the query is completed. + description: + description: Description of the flow hook. type: string - result: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportResultMetadata' - description: Result is available only after the query is completed. - state: + sharedFlow: description: >- - Query state could be "enqueued", "running", "completed", "expired" - and "failed". - type: string - resultRows: - format: int64 + Shared flow attached to this flow hook, or empty if there is none + attached. type: string - description: ResultRows is available only after the query is completed. - queryParams: + continueOnError: description: >- - Contains information like metrics, dimenstions etc of the Security - Report. - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportMetadata' - created: - description: Creation time of the query. - type: string - envgroupHostname: - type: string - description: Hostname is available only when query is executed at host level. - id: GoogleCloudApigeeV1SecurityReport + Optional. Flag that specifies whether execution should continue if + the flow hook throws an exception. Set to `true` to continue + execution. Set to `false` to stop execution if the flow hook throws + an exception. Defaults to `true`. + type: boolean + GoogleIamV1SetIamPolicyRequest: + id: GoogleIamV1SetIamPolicyRequest + description: Request message for `SetIamPolicy` method. type: object - GoogleCloudApigeeV1UpdateAppGroupAppKeyRequest: properties: - appGroupAppKey: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' - description: >- - The new AppGroupKey to be amended. Note that the status can be - updated only via action. - action: + policy: description: >- - Approve or revoke the consumer key by setting this value to - `approve` or `revoke` respectively. The `Content-Type` header, if - set, must be set to `application/octet-stream`, with empty body. + REQUIRED: The complete policy to be applied to the `resource`. The + size of the policy is limited to a few 10s of KB. An empty policy is + a valid policy but certain Google Cloud services (such as Projects) + might reject them. + $ref: '#/components/schemas/GoogleIamV1Policy' + updateMask: + description: >- + OPTIONAL: A FieldMask specifying which fields of the policy to + modify. Only the fields in the mask will be modified. If no mask is + provided, the following default mask is used: `paths: "bindings, + etag"` type: string - apiProducts: + format: google-fieldmask + GoogleIamV1Policy: + id: GoogleIamV1Policy + description: >- + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. A `Policy` is a collection of + `bindings`. A `binding` binds one or more `members`, or principals, to a + single `role`. Principals can be user accounts, service accounts, Google + groups, and domains (such as G Suite). A `role` is a named list of + permissions; each `role` can be an IAM predefined role or a user-created + custom role. For some types of Google Cloud resources, a `binding` can + also specify a `condition`, which is a logical expression that allows + access to a resource only if the expression evaluates to `true`. A + condition can add constraints based on attributes of the request, the + resource, or both. To learn which resources support conditions in their + IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + **JSON example:** ``` { "bindings": [ { "role": + "roles/resourcemanager.organizationAdmin", "members": [ + "user:mike@example.com", "group:admins@example.com", + "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { + "role": "roles/resourcemanager.organizationViewer", "members": [ + "user:eve@example.com" ], "condition": { "title": "expirable access", + "description": "Does not grant access after Sep 2020", "expression": + "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": + "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - + members: - user:mike@example.com - group:admins@example.com - + domain:google.com - + serviceAccount:my-project-id@appspot.gserviceaccount.com role: + roles/resourcemanager.organizationAdmin - members: - + user:eve@example.com role: roles/resourcemanager.organizationViewer + condition: title: expirable access description: Does not grant access + after Sep 2020 expression: request.time < + timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` + For a description of IAM and its features, see the [IAM + documentation](https://cloud.google.com/iam/docs/). + type: object + properties: + 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). + type: integer + format: int32 + bindings: + description: >- + Associates a list of `members`, or principals, with a `role`. + Optionally, may specify a `condition` that determines how and when + the `bindings` are applied. Each of the `bindings` must contain at + least one principal. The `bindings` in a `Policy` can refer to up to + 1,500 principals; up to 250 of these principals can be Google + groups. Each occurrence of a principal counts towards these limits. + For example, if the `bindings` grant 50 different roles to + `user:alice@example.com`, and not to any other principal, then you + can add another 1,450 principals to the `bindings` in the `Policy`. type: array items: - type: string + $ref: '#/components/schemas/GoogleIamV1Binding' + auditConfigs: + description: Specifies cloud audit logging configuration for this policy. + type: array + items: + $ref: '#/components/schemas/GoogleIamV1AuditConfig' + etag: description: >- - The list of API products that will be associated with the - credential. This list will be appended to the existing list of - associated API Products for this App Key. Duplicates will be - ignored. - id: GoogleCloudApigeeV1UpdateAppGroupAppKeyRequest - type: object - description: Request for UpdateAppGroupAppKey - EdgeConfigstoreBundleBadBundle: - description: Describes why a bundle is invalid. Intended for use in error details. + `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. + type: string + format: byte + GoogleIamV1Binding: + id: GoogleIamV1Binding + description: Associates `members`, or principals, with a `role`. type: object - id: EdgeConfigstoreBundleBadBundle properties: - violations: + role: + description: >- + Role that is assigned to the list of `members`, or principals. For + example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an + overview of the IAM roles and permissions, see the [IAM + documentation](https://cloud.google.com/iam/docs/roles-overview). + For a list of the available pre-defined roles, see + [here](https://cloud.google.com/iam/docs/understanding-roles). + type: string + members: + description: >- + Specifies the principals requesting access for a Google Cloud + 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. Does not include identities + that come from external identity providers (IdPs) through identity + federation. * `user:{emailid}`: An email address that represents a + specific Google account. For example, `alice@example.com` . * + `serviceAccount:{emailid}`: An email address that represents a + Google service account. For example, + `my-other-app@appspot.gserviceaccount.com`. * + `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: + An identifier for a [Kubernetes service + account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). + For example, + `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * + `group:{emailid}`: An email address that represents a Google group. + For example, `admins@example.com`. * `domain:{domain}`: The G Suite + domain (primary) that represents all the users of that domain. For + example, `google.com` or `example.com`. * + `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workforce identity pool. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: + All workforce identities in a group. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All workforce identities with a specific attribute value. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: + All identities in a workforce identity pool. * + `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workload identity pool. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: + A workload identity pool group. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All identities in a workload identity pool with a certain attribute. + * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: + All identities in a workload identity pool. * + `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. * + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + Deleted single identity in a workforce identity pool. For example, + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. type: array - description: Describes all precondition violations. items: - $ref: '#/components/schemas/EdgeConfigstoreBundleBadBundleViolation' - GoogleCloudApigeeV1AsyncQueryResult: - id: GoogleCloudApigeeV1AsyncQueryResult - properties: - expires: - description: Query result will be unaccessable after this time. - type: string - self: - type: string + type: string + condition: description: >- - Self link of the query results. Example: - `/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result` - or following format if query is running at host level: - `/organizations/myorg/hostQueries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result` - type: object - GoogleCloudApigeeV1AsyncQuery: - id: GoogleCloudApigeeV1AsyncQuery + The condition that is associated with this binding. If the condition + evaluates to `true`, then this binding applies to the current + request. If the condition evaluates to `false`, then this binding + does not apply to the current request. However, a different role + binding might grant the same role to one or more of the principals + in this binding. To learn which resources support conditions in + their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + $ref: '#/components/schemas/GoogleTypeExpr' + GoogleTypeExpr: + id: GoogleTypeExpr + 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. type: object properties: - reportDefinitionId: + expression: + description: >- + Textual representation of an expression in Common Expression + Language syntax. type: string - description: Asynchronous Report ID. - state: + 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 - description: Query state could be "enqueued", "running", "completed", "failed". - resultFileSize: - description: ResultFileSize is available only after the query is completed. + 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 - error: - type: string - description: Error is set when query fails. - result: - $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQueryResult' - description: Result is available only after the query is completed. - updated: - description: Last updated timestamp for the query. - type: string - executionTime: - description: ExecutionTime is available only after the query is completed. - type: string - envgroupHostname: - type: string - description: Hostname is available only when query is executed at host level. - resultRows: - description: ResultRows is available only after the query is completed. - format: int64 - type: string - self: + location: description: >- - Self link of the query. Example: - `/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` - or following format if query is running at host level: - `/organizations/myorg/hostQueries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` - type: string - created: - description: Creation time of the query. - type: string - name: - description: Asynchronous Query Name. + Optional. String indicating the location of the expression for error + reporting, e.g. a file name and a position in the file. type: string - queryParams: - $ref: '#/components/schemas/GoogleCloudApigeeV1QueryMetadata' - description: >- - Contains information like metrics, dimenstions etc of the - AsyncQuery. - GoogleCloudApigeeV1OrganizationProjectMapping: + GoogleIamV1AuditConfig: + id: GoogleIamV1AuditConfig + 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. type: object - id: GoogleCloudApigeeV1OrganizationProjectMapping properties: - location: - type: string + service: description: >- - Output only. The Google Cloud region where control plane data is - located. For more information, see - https://cloud.google.com/about/locations/. - readOnly: true - organization: - type: string - description: Name of the Apigee organization. - projectId: + 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 - description: Google Cloud project associated with the Apigee organization - projectIds: - deprecated: true - description: >- - DEPRECATED: Use `project_id`. An Apigee Organization is mapped to a - single project. - items: - type: string + auditLogConfigs: + description: The configuration for logging of each type of permission. type: array - GoogleCloudApigeeV1TraceConfig: + items: + $ref: '#/components/schemas/GoogleIamV1AuditLogConfig' + GoogleIamV1AuditLogConfig: + id: GoogleIamV1AuditLogConfig description: >- - TraceConfig defines the configurations in an environment of distributed - trace. - id: GoogleCloudApigeeV1TraceConfig + 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. type: object properties: - endpoint: - description: Required. Endpoint of the exporter. + logType: + description: The log type that this config enables. type: string - exporter: enumDescriptions: - - Exporter unspecified - - Jaeger exporter - - Cloudtrace exporter + - Default case. Should never be this. + - 'Admin reads. Example: CloudIAM getIamPolicy' + - 'Data writes. Example: CloudSQL Users create' + - 'Data reads. Example: CloudSQL Users list' enum: - - EXPORTER_UNSPECIFIED - - JAEGER - - CLOUD_TRACE - type: string - description: >- - Required. Exporter that is used to view the distributed trace - captured using OpenCensus. An exporter sends traces to any backend - that is capable of consuming them. Recorded spans can be exported by - registered exporters. - samplingConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceSamplingConfig' + - LOG_TYPE_UNSPECIFIED + - ADMIN_READ + - DATA_WRITE + - DATA_READ + exemptedMembers: description: >- - Distributed trace configuration for all API proxies in an - environment. You can also override the configuration for a specific - API proxy using the distributed trace configuration overrides API. - GoogleCloudApigeeV1CanaryEvaluationMetricLabels: - description: Labels that can be used to filter Apigee metrics. - id: GoogleCloudApigeeV1CanaryEvaluationMetricLabels + Specifies the identities that do not cause logging for this type of + permission. Follows the same format of Binding.members. + type: array + items: + type: string + GoogleIamV1TestIamPermissionsRequest: + id: GoogleIamV1TestIamPermissionsRequest + description: Request message for `TestIamPermissions` method. type: object properties: - env: - description: The environment ID associated with the metrics. - type: string - instance_id: + permissions: description: >- - Required. The instance ID associated with the metrics. In Apigee - Hybrid, the value is configured during installation. - type: string - location: - description: Required. The location associated with the metrics. - type: string - GoogleCloudApigeeV1ListOfDevelopersResponse: + The set of permissions to check for the `resource`. Permissions with + wildcards (such as `*` or `storage.*`) are not allowed. For more + information see [IAM + Overview](https://cloud.google.com/iam/docs/overview#permissions). + type: array + items: + type: string + GoogleIamV1TestIamPermissionsResponse: + id: GoogleIamV1TestIamPermissionsResponse + description: Response message for `TestIamPermissions` method. type: object - id: GoogleCloudApigeeV1ListOfDevelopersResponse properties: - developer: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' + permissions: + description: >- + A subset of `TestPermissionsRequest.permissions` that the caller is + allowed. type: array - description: List of developers. - GoogleCloudApigeeV1DataCollector: + items: + type: string + GoogleCloudApigeeV1EnvironmentGroup: + id: GoogleCloudApigeeV1EnvironmentGroup + description: >- + EnvironmentGroup configuration. An environment group is used to group + one or more Apigee environments under a single host name. + type: object properties: - lastModifiedAt: - readOnly: true - type: string - description: >- - Output only. The time at which the Data Collector was last updated - in milliseconds since the epoch. - format: int64 - description: - description: A description of the data collector. - type: string name: + description: ID of the environment group. type: string - description: ID of the data collector. Must begin with `dc_`. + hostnames: + description: Required. Host names for this environment group. + type: array + items: + type: string createdAt: + description: >- + Output only. The time at which the environment group was created as + milliseconds since epoch. readOnly: true + type: string + format: int64 + lastModifiedAt: description: >- - Output only. The time at which the data collector was created in - milliseconds since the epoch. + Output only. The time at which the environment group was last + updated as milliseconds since epoch. + readOnly: true + type: string format: int64 + state: + description: >- + Output only. State of the environment group. Values other than + ACTIVE means the resource is not ready to use. + readOnly: true type: string - type: - enum: - - TYPE_UNSPECIFIED - - INTEGER - - FLOAT - - STRING - - BOOLEAN - - DATETIME enumDescriptions: - - For future compatibility. - - For integer values. - - For float values. - - For string values. - - For boolean values. - - For datetime values. - type: string - description: Immutable. The type of data this data collector will collect. - type: object - id: GoogleCloudApigeeV1DataCollector - description: Data collector configuration. - GoogleCloudApigeeV1GenerateUploadUrlRequest: - description: Request for GenerateUploadUrl method. - id: GoogleCloudApigeeV1GenerateUploadUrlRequest + - Resource is in an unspecified state. + - Resource is being created. + - Resource is provisioned and ready to use. + - The resource is being deleted. + - The resource is being updated. + enum: + - STATE_UNSPECIFIED + - CREATING + - ACTIVE + - DELETING + - UPDATING + GoogleCloudApigeeV1ListEnvironmentGroupsResponse: + id: GoogleCloudApigeeV1ListEnvironmentGroupsResponse + description: Response for ListEnvironmentGroups. type: object - properties: {} - GoogleCloudApigeeV1ListEnvironmentResourcesResponse: properties: - resourceFile: - description: List of resources files. + environmentGroups: + description: EnvironmentGroups in the specified organization. type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' - description: Response for ListEnvironmentResources - type: object - id: GoogleCloudApigeeV1ListEnvironmentResourcesResponse - GoogleCloudApigeeV1ListAppsResponse: - properties: + $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroup' nextPageToken: - type: string description: >- - Token that can be sent as `next_page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. - totalSize: - format: int32 - description: Total count of Apps. - type: integer - app: - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1App' - id: GoogleCloudApigeeV1ListAppsResponse - type: object - GoogleCloudApigeeV1SecurityProfileScoringConfig: - type: object - id: GoogleCloudApigeeV1SecurityProfileScoringConfig - description: Security configurations to manage scoring. - properties: - scorePath: - type: string - description: Path of the component config used for scoring. - description: - type: string - description: Description of the config. - title: - description: Title of the config. + Page token that you can include in a ListEnvironmentGroups request + to retrieve the next page. If omitted, no subsequent pages exist. type: string - GoogleCloudApigeeV1ApiDocDocumentationResponse: + GoogleCloudApigeeV1EnvironmentGroupAttachment: + id: GoogleCloudApigeeV1EnvironmentGroupAttachment + description: >- + EnvironmentGroupAttachment is a resource which defines an attachment of + an environment to an environment group. + type: object properties: - message: - description: Output only. Description of the operation. + name: + description: ID of the environment group attachment. type: string - readOnly: true - requestId: + environment: + description: Required. ID of the attached environment. type: string - description: Output only. Unique ID of the request. - readOnly: true - errorCode: + createdAt: + description: >- + Output only. The time at which the environment group attachment was + created as milliseconds since epoch. readOnly: true type: string - description: Output only. Unique error code for the request, if any. - status: - type: string - description: Output only. Status of the operation. - readOnly: true - data: + format: int64 + environmentGroupId: + description: Output only. ID of the environment group. readOnly: true - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDocDocumentation' - description: Output only. The documentation resource. - description: >- - The catalog item documentation wrapped with response status, error_code, - etc. - type: object - id: GoogleCloudApigeeV1ApiDocDocumentationResponse - GoogleCloudApigeeV1TraceSamplingConfig: - type: object - properties: - sampler: type: string - description: Sampler of distributed tracing. OFF is the default value. - enum: - - SAMPLER_UNSPECIFIED - - 'OFF' - - PROBABILITY - enumDescriptions: - - Sampler unspecified. - - >- - OFF means distributed trace is disabled, or the sampling - probability is 0. - - >- - PROBABILITY means traces are captured on a probability that - defined by sampling_rate. The sampling rate is limited to 0 to 0.5 - when this is set. - samplingRate: - description: >- - Field sampling rate. This value is only applicable when using the - PROBABILITY sampler. The supported values are > 0 and <= 0.5. - type: number - format: float - id: GoogleCloudApigeeV1TraceSamplingConfig - description: >- - TraceSamplingConfig represents the detail settings of distributed - tracing. Only the fields that are defined in the distributed trace - configuration can be overridden using the distribute trace configuration - override APIs. - GoogleCloudApigeeV1ListEnvironmentGroupsResponse: - description: Response for ListEnvironmentGroups. + GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse: + id: GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse + description: Response for ListEnvironmentGroupAttachments. type: object - id: GoogleCloudApigeeV1ListEnvironmentGroupsResponse properties: - environmentGroups: + environmentGroupAttachments: + description: EnvironmentGroupAttachments for the specified environment group. type: array - description: EnvironmentGroups in the specified organization. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroup' + $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroupAttachment' nextPageToken: description: >- - Page token that you can include in a ListEnvironmentGroups request - to retrieve the next page. If omitted, no subsequent pages exist. + Page token that you can include in a ListEnvironmentGroupAttachments + request to retrieve the next page. If omitted, no subsequent pages + exist. type: string - GoogleCloudApigeeV1ApiDoc: + GoogleCloudApigeeV1Keystore: + id: GoogleCloudApigeeV1Keystore + description: Datastore for Certificates and Aliases. + type: object properties: - requireCallbackUrl: - type: boolean + name: description: >- - Optional. Whether a callback URL is required when this catalog - item's API product is enabled in a developer app. When true, a - portal user will be required to input a URL when managing the app - (this is typically used for the app's OAuth flow). - imageUrl: + Required. Resource ID for this keystore. Values must match the + regular expression `[\w[:space:].-]{1,255}`. type: string - description: >- - Optional. Location of the image used for the catalog item in the - catalog. This can be either an image with an external URL or a file - path for [image files stored in the - portal](/apigee/docs/api-platform/publish/portal/portal-files"), for - example, `/files/book-tree.jpg`. When specifying the URL of an - external image, the image won't be uploaded to your assets; - additionally, loading the image in the integrated portal will be - subject to its availability, which may be blocked or restricted by - [content security - policies](/apigee/docs/api-platform/publish/portal/csp). Max length - of file path is 2,083 characters. - siteId: + aliases: + description: Output only. Aliases in this keystore. readOnly: true - description: Output only. The ID of the parent portal. - type: string - visibility: - type: boolean - description: 'Optional. DEPRECATED: use the `published` field instead' - graphqlEndpointUrl: - description: >- - Optional. DEPRECATED: manage documentation through the - `getDocumentation` and `updateDocumentation` methods - type: string - deprecated: true - graphqlSchemaDisplayName: - type: string - deprecated: true - description: >- - Optional. DEPRECATED: manage documentation through the - `getDocumentation` and `updateDocumentation` methods - categoryIds: + type: array items: type: string - type: array - description: >- - Optional. The IDs of the API categories to which this catalog item - belongs. - anonAllowed: - type: boolean + GoogleCloudApigeeV1Alias: + id: GoogleCloudApigeeV1Alias + description: Reference to a certificate or key/certificate pair. + type: object + properties: + alias: description: >- - Optional. Boolean flag that manages user access to the catalog item. - When true, the catalog item has public visibility and can be viewed - anonymously; otherwise, only registered users may view it. Note: - when the parent portal is enrolled in the [audience management - feature](https://cloud.google.com/apigee/docs/api-platform/publish/portal/portal-audience#enrolling_in_the_beta_release_of_the_audience_management_feature), - and this flag is set to false, visibility is set to an indeterminate - state and must be explicitly specified in the management UI (see - [Manage the visibility of an API in your - portal](https://cloud.google.com/apigee/docs/api-platform/publish/portal/publish-apis#visibility)). - Additionally, when enrolled in the audience management feature, - updates to this flag will be ignored as visibility permissions must - be updated in the management UI. - modified: + Resource ID for this alias. Values must match the regular expression + `[^/]{1,255}`. type: string - readOnly: true - description: >- - Output only. Time the catalog item was last modified in milliseconds - since epoch. - format: int64 - description: + certsInfo: + description: Chain of certificates under this alias. + $ref: '#/components/schemas/GoogleCloudApigeeV1Certificate' + type: + description: Type of alias. type: string - description: >- - Optional. Description of the catalog item. Max length is 10,000 - characters. - edgeAPIProductName: - description: >- - Optional. Immutable. DEPRECATED: use the `apiProductName` field - instead + enumDescriptions: + - Alias type is not specified. + - Certificate. + - Key/certificate pair. + enum: + - ALIAS_TYPE_UNSPECIFIED + - CERT + - KEY_CERT + GoogleCloudApigeeV1Certificate: + id: GoogleCloudApigeeV1Certificate + type: object + properties: + certInfo: + description: Chain of certificates under this name. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1CertInfo' + GoogleCloudApigeeV1CertInfo: + id: GoogleCloudApigeeV1CertInfo + description: X.509 certificate as defined in RFC 5280. + type: object + properties: + version: + description: X.509 version. + type: integer + format: int32 + subject: + description: X.509 subject. type: string - id: - description: Output only. The ID of the catalog item. - readOnly: true + issuer: + description: X.509 issuer. type: string - format: int64 - specId: + expiryDate: + description: X.509 `notAfter` validity period in milliseconds since epoch. type: string - description: 'Optional. DEPRECATED: DO NOT USE' - deprecated: true - graphqlSchema: + format: int64 + validFrom: + description: X.509 `notBefore` validity period in milliseconds since epoch. type: string - deprecated: true - description: >- - Optional. DEPRECATED: manage documentation through the - `getDocumentation` and `updateDocumentation` methods - published: - type: boolean - description: >- - Optional. Denotes whether the catalog item is published to the - portal or is in a draft state. When the parent portal is enrolled in - the [audience management - feature](https://cloud.google.com/apigee/docs/api-platform/publish/portal/portal-audience#enrolling_in_the_beta_release_of_the_audience_management_feature), - the visibility can be set to public on creation by setting the - anonAllowed flag to true or further managed in the management UI - (see [Manage the visibility of an API in your - portal](https://cloud.google.com/apigee/docs/api-platform/publish/portal/publish-apis#visibility)) - before it can be visible to any users. If not enrolled in the - audience management feature, the visibility is managed by the - `anonAllowed` flag. - title: + format: int64 + isValid: description: >- - Required. The user-facing name of the catalog item. `title` must be - a non-empty string with a max length of 255 characters. + Flag that specifies whether the certificate is valid. Flag is set to + `Yes` if the certificate is valid, `No` if expired, or `Not yet` if + not yet valid. type: string - apiProductName: - description: >- - Required. Immutable. The `name` field of the associated [API - product](/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). - A portal may have only one catalog item associated with a given API - product. + subjectAlternativeNames: + description: X.509 subject alternative names (SANs) extension. + type: array + items: + type: string + sigAlgName: + description: X.509 signatureAlgorithm. type: string - description: >- - `ApiDoc` represents an API catalog item. Catalog items are used in two - ways in a portal: - Users can browse and interact with a visual - representation of the API documentation - The `api_product_name` field - provides a link to a backing [API product] - (/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). - Through this link, portal users can create and manage developer apps - linked to one or more API products. - id: GoogleCloudApigeeV1ApiDoc - type: object - GoogleCloudApigeeV1GraphqlDocumentation: - id: GoogleCloudApigeeV1GraphqlDocumentation - properties: - endpointUri: - description: >- - Required. The GraphQL endpoint URI to be queried by API consumers. - Max length is 2,083 characters. + publicKey: + description: Public key component of the X.509 subject public key info. type: string - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DocumentationFile' - description: Required. The documentation file contents for the GraphQL schema. - type: object - description: GraphQL documentation for a catalog item. - GoogleCloudApigeeV1ListNatAddressesResponse: - id: GoogleCloudApigeeV1ListNatAddressesResponse - type: object - properties: - nextPageToken: - description: >- - Page token that you can include in a ListNatAddresses request to - retrieve the next page of content. If omitted, no subsequent pages - exist. + basicConstraints: + description: X.509 basic constraints extension. type: string - natAddresses: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1NatAddress' - description: List of NAT Addresses for the instance. - type: array - description: Response for ListNatAddresses. - GoogleCloudApigeeV1DeveloperBalance: - properties: - wallets: - description: >- - Output only. List of all wallets. Each individual wallet stores the - account balance for a particular currency. - type: array - readOnly: true - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperBalanceWallet' - description: Account balance for the developer. + serialNumber: + description: X.509 serial number. + type: string + GoogleCloudApigeeV1TargetServer: + id: GoogleCloudApigeeV1TargetServer + description: >- + TargetServer configuration. TargetServers are used to decouple a proxy + TargetEndpoint HTTPTargetConnections from concrete URLs for backend + services. type: object - id: GoogleCloudApigeeV1DeveloperBalance - GoogleCloudApigeeV1Instance: - description: Apigee runtime instance. properties: - displayName: - type: string - description: Optional. Display name for the instance. - state: - readOnly: true - enum: - - STATE_UNSPECIFIED - - CREATING - - ACTIVE - - DELETING - - UPDATING - enumDescriptions: - - Resource is in an unspecified state. - - Resource is being created. - - Resource is provisioned and ready to use. - - The resource is being deleted. - - The resource is being updated. - type: string + name: description: >- - Output only. State of the instance. Values other than `ACTIVE` means - the resource is not ready to use. - location: + Required. The resource id of this target server. Values must match + the regular expression type: string - description: Required. Compute Engine location where the instance resides. - ipRange: - description: >- - Optional. Comma-separated list of CIDR blocks of length 22 and/or 28 - used to create the Apigee instance. Providing CIDR ranges is - optional. You can provide just /22 or /28 or both (or neither). - Ranges you provide should be freely available as part of a larger - named range you have allocated to the Service Networking peering. If - this parameter is not provided, Apigee automatically requests an - available /22 and /28 CIDR block from Service Networking. Use the - /22 CIDR block for configuring your firewall needs to allow traffic - from Apigee. Input formats: `a.b.c.d/22` or `e.f.g.h/28` or - `a.b.c.d/22,e.f.g.h/28` + description: + description: Optional. A human-readable description of this TargetServer. type: string - name: + host: + description: >- + Required. The host name this target connects to. Value must be a + valid hostname as described by RFC-1123. type: string + port: description: >- - Required. Resource ID of the instance. Values must match the regular - expression `^a-z{0,30}[a-z\d]$`. - accessLoggingConfig: + Required. The port number this target connects to on the given host. + Value must be between 1 and 65535, inclusive. + type: integer + format: int32 + isEnabled: description: >- - Optional. Access logging configuration enables the access logging - feature at the instance. Apigee customers can enable access logging - to ship the access logs to their own project's cloud logging. - $ref: '#/components/schemas/GoogleCloudApigeeV1AccessLoggingConfig' - createdAt: - type: string - format: int64 + Optional. Enabling/disabling a TargetServer is useful when + TargetServers are used in load balancing configurations, and one or + more TargetServers need to taken out of rotation periodically. + Defaults to true. + type: boolean + sSLInfo: description: >- - Output only. Time the instance was created in milliseconds since - epoch. - readOnly: true - lastModifiedAt: - format: int64 - readOnly: true + Optional. Specifies TLS configuration info for this TargetServer. + The JSON name is `sSLInfo` for legacy/backwards compatibility + reasons -- Edge originally supported SSL, and the name is still used + for TLS configuration. + $ref: '#/components/schemas/GoogleCloudApigeeV1TlsInfo' + protocol: + description: Immutable. The protocol used by this TargetServer. type: string + enumDescriptions: + - UNSPECIFIED defaults to HTTP for backwards compatibility. + - The TargetServer uses HTTP. + - The TargetSever uses HTTP2. + - The TargetServer uses GRPC. + - >- + GRPC TargetServer to be used in ExternalCallout Policy. Prefer to + use EXTERNAL_CALLOUT instead. TODO(b/266125112) deprecate once + EXTERNAL _CALLOUT generally available. + - The TargetServer is to be used in the ExternalCallout Policy + enum: + - PROTOCOL_UNSPECIFIED + - HTTP + - HTTP2 + - GRPC_TARGET + - GRPC + - EXTERNAL_CALLOUT + GoogleCloudApigeeV1TlsInfo: + id: GoogleCloudApigeeV1TlsInfo + description: TLS configuration information for virtual hosts and TargetServers. + type: object + properties: + enabled: description: >- - Output only. Time the instance was last modified in milliseconds - since epoch. - port: - description: Output only. Port number of the exposed Apigee endpoint. - type: string - readOnly: true - runtimeVersion: + Required. Enables TLS. If false, neither one-way nor two-way TLS + will be enabled. + type: boolean + clientAuthEnabled: + description: Optional. Enables two-way TLS. + type: boolean + keyStore: description: >- - Output only. Version of the runtime system running in the instance. - The runtime system is the set of components that serve the API Proxy - traffic in your Environments. - readOnly: true - type: string - host: - readOnly: true + Required if `client_auth_enabled` is true. The resource ID of the + keystore. type: string + keyAlias: description: >- - Output only. Internal hostname or IP address of the Apigee endpoint - used by clients to connect to the service. - description: - description: Optional. Description of the instance. + Required if `client_auth_enabled` is true. The resource ID for the + alias containing the private key and cert. type: string - peeringCidrRange: + trustStore: + description: The resource ID of the truststore. type: string - enumDescriptions: - - Range not specified. - - '`/16` CIDR range.' - - '`/17` CIDR range.' - - '`/18` CIDR range.' - - '`/19` CIDR range.' - - '`/20` CIDR range.' - - '`/22` CIDR range. Supported for evaluation only.' - - '`/23` CIDR range. Supported for evaluation only.' - deprecated: true + ignoreValidationErrors: description: >- - Optional. Size of the CIDR block range that will be reserved by the - instance. PAID organizations support `SLASH_16` to `SLASH_20` and - defaults to `SLASH_16`. Evaluation organizations support only - `SLASH_23`. - enum: - - CIDR_RANGE_UNSPECIFIED - - SLASH_16 - - SLASH_17 - - SLASH_18 - - SLASH_19 - - SLASH_20 - - SLASH_22 - - SLASH_23 - serviceAttachment: - readOnly: true - description: >- - Output only. Resource name of the service attachment created for the - instance in the format: `projects/*/regions/*/serviceAttachments/*` - Apigee customers can privately forward traffic to this service - attachment using the PSC endpoints. - type: string - diskEncryptionKeyName: - description: >- - Customer Managed Encryption Key (CMEK) used for disk and volume - encryption. If not specified, a Google-Managed encryption key will - be used. Use the following format: - `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)` - type: string - consumerAcceptList: + If true, Edge ignores TLS certificate errors. Valid when configuring + TLS for target servers and target endpoints, and when configuring + virtual hosts that use 2-way TLS. When used with a target + endpoint/target server, if the backend system uses SNI and returns a + cert with a subject Distinguished Name (DN) that does not match the + hostname, there is no way to ignore the error and the connection + fails. + type: boolean + protocols: + description: The TLS versioins to be used. + type: array items: type: string + ciphers: description: >- - Optional. Customer accept list represents the list of projects - (id/number) on customer side that can privately connect to the - service attachment. It is an optional field which the customers can - provide during the instance creation. By default, the customer - project associated with the Apigee organization will be included to - the list. + The SSL/TLS cipher suites to be used. For programmable proxies, it + must be one of the cipher suite names listed in: + http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites. + For configurable proxies, it must follow the configuration specified + in: + https://commondatastorage.googleapis.com/chromium-boringssl-docs/ssl.h.html#Cipher-suite-configuration. + This setting has no effect for configurable proxies when negotiating + TLS 1.3. type: array - id: GoogleCloudApigeeV1Instance + items: + type: string + commonName: + description: The TLS Common Name of the certificate. + $ref: '#/components/schemas/GoogleCloudApigeeV1TlsInfoCommonName' + enforce: + description: TLS is strictly enforced. + type: boolean + GoogleCloudApigeeV1TlsInfoCommonName: + id: GoogleCloudApigeeV1TlsInfoCommonName type: object - GoogleCloudApigeeV1IngressConfig: - id: GoogleCloudApigeeV1IngressConfig properties: - name: - type: string - description: >- - Name of the resource in the following format: - `organizations/{org}/deployedIngressConfig`. - revisionCreateTime: - format: google-datetime - type: string - description: Time at which the IngressConfig revision was created. - revisionId: - description: >- - Revision id that defines the ordering on IngressConfig resources. - The higher the revision, the more recently the configuration was - deployed. - format: int64 + value: + description: The TLS Common Name string of the certificate. type: string - uid: + wildcardMatch: description: >- - A unique id for the ingress config that will only change if the - organization is deleted and recreated. - type: string - environmentGroups: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroupConfig' - type: array - description: List of environment groups in the organization. + Indicates whether the cert should be matched against as a wildcard + cert. + type: boolean + GoogleCloudApigeeV1TraceConfig: + id: GoogleCloudApigeeV1TraceConfig + description: >- + TraceConfig defines the configurations in an environment of distributed + trace. type: object - GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse: - id: GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse - description: Response for ListEnvironmentGroupAttachments. properties: - environmentGroupAttachments: - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroupAttachment' - description: EnvironmentGroupAttachments for the specified environment group. - nextPageToken: + exporter: description: >- - Page token that you can include in a ListEnvironmentGroupAttachments - request to retrieve the next page. If omitted, no subsequent pages - exist. + Required. Exporter that is used to view the distributed trace + captured using OpenCensus. An exporter sends traces to any backend + that is capable of consuming them. Recorded spans can be exported by + registered exporters. type: string - type: object - GoogleCloudApigeeV1KeystoreConfig: - id: GoogleCloudApigeeV1KeystoreConfig - type: object - properties: - name: + enumDescriptions: + - Exporter unspecified + - Jaeger exporter + - Cloudtrace exporter + enum: + - EXPORTER_UNSPECIFIED + - JAEGER + - CLOUD_TRACE + endpoint: + description: Required. Endpoint of the exporter. type: string + samplingConfig: description: >- - Resource name in the following format: - `organizations/{org}/environments/{env}/keystores/{keystore}` - aliases: - type: array - description: Aliases in the keystore. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1AliasRevisionConfig' - GoogleCloudApigeeV1Properties: - properties: - property: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Property' - description: List of all properties in the object - type: array - id: GoogleCloudApigeeV1Properties - type: object + Distributed trace configuration for all API proxies in an + environment. You can also override the configuration for a specific + API proxy using the distributed trace configuration overrides API. + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceSamplingConfig' + GoogleCloudApigeeV1TraceSamplingConfig: + id: GoogleCloudApigeeV1TraceSamplingConfig description: >- - Message for compatibility with legacy Edge specification for Java - Properties object in JSON. - GoogleCloudApigeeV1UpdateSecurityIncidentRequest: + TraceSamplingConfig represents the detail settings of distributed + tracing. Only the fields that are defined in the distributed trace + configuration can be overridden using the distribute trace configuration + override APIs. + type: object properties: - securityIncident: - description: >- - Required. The security incident to update. Must contain all existing - populated fields of the current incident. - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' - updateMask: + sampler: + description: Sampler of distributed tracing. OFF is the default value. type: string - format: google-fieldmask + enumDescriptions: + - Sampler unspecified. + - >- + OFF means distributed trace is disabled, or the sampling + probability is 0. + - >- + PROBABILITY means traces are captured on a probability that + defined by sampling_rate. The sampling rate is limited to 0 to 0.5 + when this is set. + enum: + - SAMPLER_UNSPECIFIED + - 'OFF' + - PROBABILITY + samplingRate: description: >- - Required. The list of fields to update. Allowed fields are: - LINT.IfChange(allowed_update_fields_comment) - observability - LINT.ThenChange() - type: object - description: Request for UpdateSecurityIncident. - id: GoogleCloudApigeeV1UpdateSecurityIncidentRequest - GoogleCloudApigeeV1SharedFlow: - id: GoogleCloudApigeeV1SharedFlow + Field sampling rate. This value is only applicable when using the + PROBABILITY sampler. The supported values are > 0 and <= 0.5. + type: number + format: float + GoogleCloudApigeeV1Environment: + id: GoogleCloudApigeeV1Environment type: object - description: The metadata describing a shared flow properties: - metaData: - $ref: '#/components/schemas/GoogleCloudApigeeV1EntityMetadata' - description: Metadata describing the shared flow. - latestRevisionId: - type: string - description: The id of the most recently created revision for this shared flow. name: + description: >- + Required. Name of the environment. Values must match the regular + expression `^[.\\p{Alnum}-_]{1,255}$` type: string - description: The ID of the shared flow. - revision: - description: A list of revisions of this shared flow. - type: array - items: - type: string - GoogleCloudApigeeV1DeveloperBalanceWallet: - description: Wallet used to manage an account balance for a particular currency. - id: GoogleCloudApigeeV1DeveloperBalanceWallet - properties: - balance: - $ref: '#/components/schemas/GoogleTypeMoney' + description: + description: Optional. Description of the environment. + type: string + createdAt: description: >- - Current remaining balance of the developer for a particular - currency. - lastCreditTime: + Output only. Creation time of this environment as milliseconds since + epoch. + readOnly: true type: string + format: int64 + lastModifiedAt: description: >- - Output only. Time at which the developer last added credit to the - account in milliseconds since epoch. + Output only. Last modification time of this environment as + milliseconds since epoch. + readOnly: true + type: string format: int64 + properties: + description: >- + Optional. Key-value pairs that may be used for customizing the + environment. + $ref: '#/components/schemas/GoogleCloudApigeeV1Properties' + displayName: + description: Optional. Display name for this environment. + type: string + state: + description: >- + Output only. State of the environment. Values other than ACTIVE + means the resource is not ready to use. readOnly: true - type: object - GoogleRpcPreconditionFailure: - id: GoogleRpcPreconditionFailure - properties: - violations: - description: Describes all precondition violations. - type: array - items: - $ref: '#/components/schemas/GoogleRpcPreconditionFailureViolation' - type: object - description: >- - Describes what preconditions have failed. For example, if an RPC failed - because it required the Terms of Service to be acknowledged, it could - list the terms of service violation in the PreconditionFailure message. - GoogleCloudApigeeV1EndpointChainingRule: - type: object - id: GoogleCloudApigeeV1EndpointChainingRule - properties: - proxyIds: - type: array - items: - type: string - description: List of proxy ids which may be found in the given deployment group. - deploymentGroup: - description: >- - The deployment group to target for cross-shard chaining calls to - these proxies. - type: string - description: >- - EndpointChainingRule specifies the proxies contained in a particular - deployment group, so that other deployment groups can find them in - chaining calls. - GoogleCloudApigeeV1QueryTimeSeriesStatsResponseSequence: - type: object - description: A sequence of time series. - id: GoogleCloudApigeeV1QueryTimeSeriesStatsResponseSequence - properties: - dimensions: - additionalProperties: - type: string - description: >- - Map of dimensions and their values that uniquely identifies a time - series sequence. - type: object - points: - description: List of points. First value of each inner list is a timestamp. - items: - type: array - items: - type: any - type: array - GoogleCloudApigeeV1RevisionStatus: - id: GoogleCloudApigeeV1RevisionStatus - description: The status of a specific resource revision. - properties: - jsonSpec: - type: string - description: >- - The json content of the resource revision. Large specs should be - sent individually via the spec field to avoid hitting request size - limits. - errors: - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1UpdateError' - description: Errors reported when attempting to load this revision. - revisionId: - type: string - description: The revision of the resource. - replicas: - type: integer - description: The number of replicas that have successfully loaded this revision. - format: int32 - type: object - GoogleCloudApigeeV1EndpointAttachment: - id: GoogleCloudApigeeV1EndpointAttachment - properties: - serviceAttachment: - description: 'Format: projects/*/regions/*/serviceAttachments/*' type: string - state: - enum: - - STATE_UNSPECIFIED - - CREATING - - ACTIVE - - DELETING - - UPDATING enumDescriptions: - Resource is in an unspecified state. - Resource is being created. - Resource is provisioned and ready to use. - The resource is being deleted. - The resource is being updated. - readOnly: true + enum: + - STATE_UNSPECIFIED + - CREATING + - ACTIVE + - DELETING + - UPDATING + deploymentType: description: >- - Output only. State of the endpoint attachment. Values other than - `ACTIVE` mean the resource is not ready to use. - type: string - host: + Optional. Deployment type supported by the environment. The + deployment type can be set when creating the environment and cannot + be changed. When you enable archive deployment, you will be + **prevented from performing** a [subset of + actions](/apigee/docs/api-platform/local-development/overview#prevented-actions) + within the environment, including: * Managing the deployment of API + proxy or shared flow revisions * Creating, updating, or deleting + resource files * Creating, updating, or deleting target servers type: string - readOnly: true - description: >- - Output only. Host that can be used in either the HTTP target - endpoint directly or as the host in target server. - connectionState: - enum: - - CONNECTION_STATE_UNSPECIFIED - - UNAVAILABLE - - PENDING - - ACCEPTED - - REJECTED - - CLOSED - - FROZEN - - NEEDS_ATTENTION enumDescriptions: - - The connection state has not been set. + - Deployment type not specified. - >- - The connection state is unavailable at this time, possibly because - the endpoint attachment is currently being provisioned. - - The connection is pending acceptance by the PSC producer. - - The connection has been accepted by the PSC producer. - - The connection has been rejected by the PSC producer. + Proxy deployment enables you to develop and deploy API proxies + using Apigee on Google Cloud. This cannot currently be combined + with the CONFIGURABLE API proxy type. - >- - The connection has been closed by the PSC producer and will not - serve traffic going forward. + Archive deployment enables you to develop API proxies locally then + deploy an archive of your API proxy configuration to an + environment in Apigee on Google Cloud. You will be prevented from + performing a [subset of + actions](/apigee/docs/api-platform/local-development/overview#prevented-actions) + within the environment. + enum: + - DEPLOYMENT_TYPE_UNSPECIFIED + - PROXY + - ARCHIVE + apiProxyType: + description: >- + Optional. API Proxy type supported by the environment. The type can + be set when creating the Environment and cannot be changed. + type: string + enumDescriptions: + - API proxy type not specified. - >- - The connection has been frozen by the PSC producer and will not - serve traffic. + Programmable API Proxies enable you to develop APIs with highly + flexible behavior using bundled policy configuration and one or + more programming languages to describe complex sequential and/or + conditional flows of logic. - >- - The connection has been accepted by the PSC producer, but it is - not ready to serve the traffic due to producer side issues. - readOnly: true - type: string + Configurable API Proxies enable you to develop efficient APIs + using simple configuration while complex execution control flow + logic is handled by Apigee. This type only works with the ARCHIVE + deployment type and cannot be combined with the PROXY deployment + type. + enum: + - API_PROXY_TYPE_UNSPECIFIED + - PROGRAMMABLE + - CONFIGURABLE + nodeConfig: + description: Optional. NodeConfig of the environment. + $ref: '#/components/schemas/GoogleCloudApigeeV1NodeConfig' + forwardProxyUri: description: >- - Output only. State of the endpoint attachment connection to the - service attachment. - name: + Optional. URI of the forward proxy to be applied to the runtime + instances in this environment. Must be in the format of + {scheme}://{hostname}:{port}. Note that the only supported scheme is + "http". The port must be supplied. To remove a forward proxy + setting, update the field to an empty value. Note: At this time, PUT + operations to add forwardProxyUri to an existing environment fail if + the environment has nodeConfig set up. To successfully add the + forwardProxyUri setting in this case, include the NodeConfig details + with the request. type: string - description: >- - Name of the endpoint attachment. Use the following structure in your - request: - `organizations/{org}/endpointAttachments/{endpoint_attachment}` - location: + type: + description: Optional. EnvironmentType selected for the environment. type: string - description: Required. Location of the endpoint attachment. - type: object + enumDescriptions: + - Environment type not specified. + - >- + This is the default type. Base environment has limited capacity + and capabilities and are usually used when you are getting started + with Apigee or while experimenting. Refer to Apigee's public + documentation for more details. + - >- + Intermediate environment supports API management features and + higher capacity than Base environment. Refer to Apigee's public + documentation for more details. + - >- + Comprehensive environment supports advanced capabilites and even + higher capacity than Intermediate environment. Refer to Apigee's + public documentation for more details. + enum: + - ENVIRONMENT_TYPE_UNSPECIFIED + - BASE + - INTERMEDIATE + - COMPREHENSIVE + hasAttachedFlowHooks: + type: boolean + clientIpResolutionConfig: + description: >- + Optional. The algorithm to resolve IP. This will affect Analytics, + API Security, and other features that use the client ip. To remove a + client ip resolution config, update the field to an empty value. + Example: '{ "clientIpResolutionConfig" = {} }' For more information, + see: + https://cloud.google.com/apigee/docs/api-platform/system-administration/client-ip-resolution. + $ref: >- + #/components/schemas/GoogleCloudApigeeV1EnvironmentClientIPResolutionConfig + GoogleCloudApigeeV1Properties: + id: GoogleCloudApigeeV1Properties description: >- - Apigee endpoint attachment. For more information, see [Southbound - networking patterns] - (https://cloud.google.com/apigee/docs/api-platform/architecture/southbound-networking-patterns-endpoints). - GoogleCloudApigeeV1RevenueShareRange: - id: GoogleCloudApigeeV1RevenueShareRange - properties: - sharePercentage: - format: double - description: >- - Percentage of the revenue to be shared with the developer. For - example, to share 21 percent of the total revenue with the - developer, set this value to 21. Specify a decimal number with a - maximum of two digits following the decimal point. - type: number - start: - format: int64 - type: string - description: >- - Starting value of the range. Set to 0 or `null` for the initial - range of values. - end: - description: >- - Ending value of the range. Set to 0 or `null` for the last range of - values. - format: int64 - type: string + Message for compatibility with legacy Edge specification for Java + Properties object in JSON. type: object - description: >- - API call volume range and the percentage of revenue to share with the - developer when the total number of API calls is within the range. - GoogleCloudApigeeV1ListDeploymentsResponse: - id: GoogleCloudApigeeV1ListDeploymentsResponse properties: - deployments: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' + property: + description: List of all properties in the object type: array - description: List of deployments. - type: object - GoogleCloudApigeeV1AccessGet: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Property' + GoogleCloudApigeeV1Property: + id: GoogleCloudApigeeV1Property + description: A single property entry in the Properties message. type: object properties: - value: - type: string name: + description: The property key + type: string + value: + description: The property value type: string + GoogleCloudApigeeV1NodeConfig: + id: GoogleCloudApigeeV1NodeConfig description: >- - Get action. For example, "Get" : { "name" : "target.name", "value" : - "default" } - id: GoogleCloudApigeeV1AccessGet - GoogleCloudApigeeV1ListAppGroupsResponse: - id: GoogleCloudApigeeV1ListAppGroupsResponse - description: >- - ListAppGroupsResponse contains the 0 or more AppGroups, along with the - optional page token and the total count of apps. + NodeConfig for setting the min/max number of nodes associated with the + environment. type: object properties: - totalSize: - description: Total count of AppGroups. - type: integer - format: int32 - nextPageToken: + minNodeCount: description: >- - Token that can be sent as `next_page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. - type: string - appGroups: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' - description: List of AppGroups. - type: array - GoogleCloudApigeeV1Quota: - properties: - timeUnit: + Optional. The minimum total number of gateway nodes that the is + reserved for all instances that has the specified environment. If + not specified, the default is determined by the recommended minimum + number of nodes for that gateway. type: string + format: int64 + maxNodeCount: description: >- - Time unit defined for the `interval`. Valid values include `minute`, - `hour`, `day`, or `month`. If `limit` and `interval` are valid, the - default value is `hour`; otherwise, the default is null. - interval: - description: >- - Required. Time interval over which the number of request messages is - calculated. + Optional. The maximum total number of gateway nodes that the is + reserved for all instances that has the specified environment. If + not specified, the default is determined by the recommended maximum + number of nodes for that gateway. type: string - limit: + format: int64 + currentAggregateNodeCount: description: >- - Required. Upper limit allowed for the time interval and time unit - specified. Requests exceeding this limit will be rejected. + Output only. The current total number of gateway nodes that each + environment currently has across all instances. + readOnly: true type: string - type: object - description: >- - Quota contains the essential parameters needed that can be applied on - the resources, methods, API source combination associated with this API - product. While Quota is optional, setting it prevents requests from - exceeding the provisioned parameters. - id: GoogleCloudApigeeV1Quota - GoogleCloudApigeeV1Stats: - properties: - hosts: - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1StatsHostStats' - description: List of query results grouped by host. - metaData: - description: Metadata information. - $ref: '#/components/schemas/GoogleCloudApigeeV1Metadata' - environments: - description: List of query results on the environment level. - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1StatsEnvironmentStats' - type: object - description: Encapsulates a `stats` response. - id: GoogleCloudApigeeV1Stats - GoogleCloudApigeeV1SetAddonsRequest: - id: GoogleCloudApigeeV1SetAddonsRequest + format: int64 + GoogleCloudApigeeV1EnvironmentClientIPResolutionConfig: + id: GoogleCloudApigeeV1EnvironmentClientIPResolutionConfig + description: Configuration for resolving the client ip. type: object properties: - addonsConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1AddonsConfig' - description: Required. Add-on configurations. - description: Request for SetAddons. - GoogleCloudApigeeV1StatsEnvironmentStats: - id: GoogleCloudApigeeV1StatsEnvironmentStats + headerIndexAlgorithm: + description: Resolves the client ip based on a custom header. + $ref: >- + #/components/schemas/GoogleCloudApigeeV1EnvironmentClientIPResolutionConfigHeaderIndexAlgorithm + GoogleCloudApigeeV1EnvironmentClientIPResolutionConfigHeaderIndexAlgorithm: + id: >- + GoogleCloudApigeeV1EnvironmentClientIPResolutionConfigHeaderIndexAlgorithm + description: Resolves the client ip based on a custom header. type: object - description: >- - Encapsulates the environment wrapper: ``` "environments": [ { "metrics": - [ { "name": "sum(message_count)", "values": [ "2.52056245E8" ] } ], - "name": "prod" } ]``` properties: - name: - description: Name of the environment. + ipHeaderName: + description: >- + Required. The name of the header to extract the client ip from. We + are currently only supporting the X-Forwarded-For header. type: string - dimensions: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1DimensionMetric' - type: array - description: List of metrics grouped under dimensions. - metrics: + ipHeaderIndex: description: >- - In the final response, only one of the following fields will be - present based on the dimensions provided. If no dimensions are - provided, then only top-level metrics is provided. If dimensions are - included, then there will be a top-level dimensions field under - environments which will contain metrics values and the dimension - name. Example: ``` "environments": [ { "dimensions": [ { "metrics": - [ { "name": "sum(message_count)", "values": [ "2.14049521E8" ] } ], - "name": "nit_proxy" } ], "name": "prod" } ]``` or ```"environments": - [ { "metrics": [ { "name": "sum(message_count)", "values": [ - "2.19026331E8" ] } ], "name": "prod" } ]``` List of metric values. - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Metric' - GoogleCloudApigeeV1ListEndpointAttachmentsResponse: - description: Response for ListEndpointAttachments method. - id: GoogleCloudApigeeV1ListEndpointAttachmentsResponse + Required. The index of the ip in the header. Positive indices 0, 1, + 2, 3 chooses indices from the left (first ips) Negative indices -1, + -2, -3 chooses indices from the right (last ips) + type: integer + format: int32 + GoogleCloudApigeeV1EnvironmentConfig: + id: GoogleCloudApigeeV1EnvironmentConfig type: object properties: - nextPageToken: + name: description: >- - Page token that you can include in an `ListEndpointAttachments` - request to retrieve the next page. If omitted, no subsequent pages - exist. + Name of the environment configuration in the following format: + `organizations/{org}/environments/{env}/configs/{config}` type: string - endpointAttachments: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1EndpointAttachment' - type: array - description: Endpoint attachments in the specified organization. - GoogleCloudApigeeV1ProfileConfig: - properties: - categories: - type: array - description: List of categories of profile config. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigCategory' - description: >- - ProfileConfig defines a set of categories and policies which will be - used to compute security score. - id: GoogleCloudApigeeV1ProfileConfig - type: object - GoogleCloudApigeeV1Alias: - id: GoogleCloudApigeeV1Alias - type: object - description: Reference to a certificate or key/certificate pair. - properties: - alias: + uid: + description: >- + Unique ID for the environment configuration. The ID will only change + if the environment is deleted and recreated. type: string + revisionId: description: >- - Resource ID for this alias. Values must match the regular expression - `[^/]{1,255}`. - certsInfo: - $ref: '#/components/schemas/GoogleCloudApigeeV1Certificate' - description: Chain of certificates under this alias. - type: - description: Type of alias. - enumDescriptions: - - Alias type is not specified. - - Certificate. - - Key/certificate pair. + Revision ID of the environment configuration. The higher the value, + the more recently the configuration was deployed. type: string - enum: - - ALIAS_TYPE_UNSPECIFIED - - CERT - - KEY_CERT - GoogleProtobufEmpty: - id: GoogleProtobufEmpty - type: object - properties: {} - description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } - GoogleCloudApigeeV1SecurityAssessmentResult: - description: The security assessment result for one resource. - type: object - id: GoogleCloudApigeeV1SecurityAssessmentResult - properties: - createTime: + format: int64 + envScopedRevisionId: description: >- - The time of the assessment of this resource. This could lag behind - `assessment_time` due to caching within the backend. + Revision ID for environment-scoped resources (e.g. target servers, + keystores) in this config. This ID will increment any time a + resource not scoped to a deployment group changes. + type: string + format: int64 + sequenceNumber: + description: 'DEPRECATED: Use revision_id.' + type: string + format: int64 + createTime: + description: Time that the environment configuration was created. + type: string format: google-datetime + provider: + description: >- + Used by the Control plane to add context information to help detect + the source of the document during diagnostics and debugging. type: string - scoringResult: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResultScoringResult - description: The result of the assessment. - resource: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResultResource - description: The assessed resource. - error: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The error status if scoring fails. - GoogleCloudApigeeV1BatchUpdateSecurityIncidentsResponse: - description: Response for BatchUpdateSecurityIncident. - properties: - securityIncidents: - description: Output only. Updated security incidents - readOnly: true + resources: + description: List of resource versions in the environment. + type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' + $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceConfig' + targets: + description: >- + List of target servers in the environment. Disabled target servers + are not displayed. type: array - type: object - id: GoogleCloudApigeeV1BatchUpdateSecurityIncidentsResponse - GoogleIamV1TestIamPermissionsRequest: - id: GoogleIamV1TestIamPermissionsRequest - properties: - permissions: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServerConfig' + deployments: + description: List of deployments in the environment. type: array - description: >- - The set of permissions to check for the `resource`. Permissions with - wildcards (such as `*` or `storage.*`) are not allowed. For more - information see [IAM - Overview](https://cloud.google.com/iam/docs/overview#permissions). items: - type: string - type: object - description: Request message for `TestIamPermissions` method. - GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendation: - description: The format of the assessment recommendation. - properties: - link: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendationLink - description: The link for the recommendation. - description: - description: The description of the recommendation. + $ref: '#/components/schemas/GoogleCloudApigeeV1DeploymentConfig' + deploymentGroups: + description: List of deployment groups in the environment. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1DeploymentGroupConfig' + flowhooks: + description: List of flow hooks in the environment. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1FlowHookConfig' + debugMask: + description: Debug mask that applies to all deployments in the environment. + $ref: '#/components/schemas/GoogleCloudApigeeV1DebugMask' + keystores: + description: List of keystores in the environment. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1KeystoreConfig' + featureFlags: + description: Feature flags inherited from the organization and environment. + type: object + additionalProperties: + type: string + pubsubTopic: + description: Name of the PubSub topic for the environment. type: string - id: >- - GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendation - type: object - GoogleCloudApigeeV1Score: - id: GoogleCloudApigeeV1Score - type: object - properties: - timeRange: - description: Start and end time for the score. - $ref: '#/components/schemas/GoogleTypeInterval' - component: - description: Component containing score, recommendations and actions. - $ref: '#/components/schemas/GoogleCloudApigeeV1ScoreComponent' - subcomponents: + resourceReferences: + description: List of resource references in the environment. + type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ScoreComponent' + $ref: '#/components/schemas/GoogleCloudApigeeV1ReferenceConfig' + dataCollectors: + description: List of data collectors used by the deployments in the environment. type: array - description: List of all the drilldown score components. - description: Represents Security Score. - GoogleCloudApigeeV1RateRange: - properties: - fee: - description: >- - Fee to charge when total number of API calls falls within this - range. - $ref: '#/components/schemas/GoogleTypeMoney' - end: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollectorConfig' + traceConfig: description: >- - Ending value of the range. Set to 0 or `null` for the last range of - values. - format: int64 - type: string - start: + Trace configurations. Contains config for the environment and config + overrides for specific API proxies. + $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeTraceConfig' + gatewayConfigLocation: description: >- - Starting value of the range. Set to 0 or `null` for the initial - range of values. - type: string - format: int64 - description: >- - API call volume range and the fees charged when the total number of API - calls is within the range. - id: GoogleCloudApigeeV1RateRange - type: object - GoogleCloudApigeeV1RuntimeTraceConfig: - description: >- - NEXT ID: 8 RuntimeTraceConfig defines the configurations for distributed - trace in an environment. - id: GoogleCloudApigeeV1RuntimeTraceConfig - properties: - revisionId: + The location for the gateway config blob as a URI, e.g. a Cloud + Storage URI. This is only used by Envoy-based gateways. type: string + arcConfigLocation: description: >- - Revision number which can be used by the runtime to detect if the - trace config has changed between two versions. - endpoint: - description: Endpoint of the exporter. + The location for the config blob of API Runtime Control, aka Envoy + Adapter, for op-based authentication as a URI, e.g. a Cloud Storage + URI. This is only used by Envoy-based gateways. type: string - samplingConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeTraceSamplingConfig' - description: Trace configuration for all API proxies in an environment. - exporter: + forwardProxyUri: description: >- - Exporter that is used to view the distributed trace captured using - OpenCensus. An exporter sends traces to any backend that is capable - of consuming them. Recorded spans can be exported by registered - exporters. + The forward proxy's url to be used by the runtime. When set, runtime + will send requests to the target via the given forward proxy. This + is only used by programmable gateways. type: string - enumDescriptions: - - Exporter unspecified - - Jaeger exporter - - Cloudtrace exporter - enum: - - EXPORTER_UNSPECIFIED - - JAEGER - - CLOUD_TRACE + addonsConfig: + description: The latest runtime configurations for add-ons. + $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeAddonsConfig' + clientIpResolutionConfig: + description: The algorithm to resolve IP. + $ref: >- + #/components/schemas/GoogleCloudApigeeV1EnvironmentConfigClientIPResolutionConfig + GoogleCloudApigeeV1ResourceConfig: + id: GoogleCloudApigeeV1ResourceConfig + type: object + properties: name: description: >- - Name of the trace config in the following format: - `organizations/{org}/environment/{env}/traceConfig` + Resource name in the following format: + `organizations/{org}/environments/{env}/resourcefiles/{type}/{file}/revisions/{rev}` + Only environment-scoped resource files are supported. type: string - revisionCreateTime: - format: google-datetime - description: The timestamp that the revision was created or updated. + location: + description: Location of the resource as a URI. type: string - overrides: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeTraceConfigOverride' - type: array - description: List of trace configuration overrides for spicific API proxies. - type: object - GoogleCloudApigeeV1CanaryEvaluation: + GoogleCloudApigeeV1TargetServerConfig: + id: GoogleCloudApigeeV1TargetServerConfig type: object - id: GoogleCloudApigeeV1CanaryEvaluation - description: >- - CanaryEvaluation represents the canary analysis between two versions of - the runtime that is serving requests. properties: name: + description: >- + Target server revision name in the following format: + `organizations/{org}/environments/{env}/targetservers/{targetserver}/revisions/{rev}` type: string - description: Output only. Name of the canary evalution. - readOnly: true - state: + host: + description: Host name of the target server. type: string - enumDescriptions: - - No state has been specified. - - The canary evaluation is still in progress. - - The canary evaluation has finished. - enum: - - STATE_UNSPECIFIED - - RUNNING - - SUCCEEDED - description: Output only. The current state of the canary evaluation. - readOnly: true - verdict: + port: + description: Port number for the target server. + type: integer + format: int32 + tlsInfo: + description: TLS settings for the target server. + $ref: '#/components/schemas/GoogleCloudApigeeV1TlsInfoConfig' + protocol: + description: The protocol used by this target server. type: string enumDescriptions: - - Verdict is not available yet. - - No verdict reached. - - Evaluation is not good. - - Evaluation is good. + - UNSPECIFIED defaults to HTTP for backwards compatibility. + - The TargetServer uses HTTP. + - The TargetSever uses HTTP2. + - The TargetServer uses GRPC. + - >- + GRPC TargetServer to be used in ExternalCallout Policy. Prefer to + use EXTERNAL_CALLOUT instead. TODO(b/266125112) deprecate once + EXTERNAL _CALLOUT generally available. + - The TargetServer is to be used in the ExternalCallout Policy enum: - - VERDICT_UNSPECIFIED - - NONE - - FAIL - - PASS - readOnly: true - description: >- - Output only. The resulting verdict of the canary evaluations: NONE, - PASS, or FAIL. - endTime: - description: Required. End time for the evaluation's analysis. - format: google-datetime - type: string - control: - type: string - description: Required. The stable version that is serving requests. - metricLabels: - $ref: '#/components/schemas/GoogleCloudApigeeV1CanaryEvaluationMetricLabels' + - PROTOCOL_UNSPECIFIED + - HTTP + - HTTP2 + - GRPC_TARGET + - GRPC + - EXTERNAL_CALLOUT + enabled: description: >- - Required. Labels used to filter the metrics used for a canary - evaluation. - createTime: - format: google-datetime - description: Output only. Create time of the canary evaluation. - readOnly: true - type: string - startTime: - format: google-datetime - description: Required. Start time for the canary evaluation's analysis. - type: string - treatment: - type: string - description: Required. The newer version that is serving requests. - GoogleCloudApigeeV1ReportInstanceStatusRequest: + Whether the target server is enabled. An empty/omitted value for + this field should be interpreted as true. + type: boolean + GoogleCloudApigeeV1TlsInfoConfig: + id: GoogleCloudApigeeV1TlsInfoConfig type: object properties: - resources: - type: array - description: Status for config resources - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceStatus' - reportTime: - format: google-datetime + enabled: description: >- - The time the report was generated in the runtime. Used to prevent an - old status from overwriting a newer one. An instance should space - out it's status reports so that clock skew does not play a factor. - type: string - instanceUid: - type: string + Flag that specifies whether one-way TLS is enabled. Set to `true` to + enable one-way TLS. + type: boolean + clientAuthEnabled: description: >- - A unique ID for the instance which is guaranteed to be unique in - case the user installs multiple hybrid runtimes with the same - instance ID. - id: GoogleCloudApigeeV1ReportInstanceStatusRequest - description: Request for ReportInstanceStatus. - GoogleCloudApigeeV1RuntimeAddonsConfig: - description: >- - RuntimeAddonsConfig defines the runtime configurations for add-ons in an - environment. + Flag that specifies whether client-side authentication is enabled + for the target server. Enables two-way TLS. + type: boolean + keyAlias: + description: >- + Name of the alias used for client-side authentication in the + following format: + `organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}` + type: string + keyAliasReference: + description: Reference name and alias pair to use for client-side authentication. + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyAliasReference' + trustStore: + description: >- + Name of the keystore or keystore reference containing trusted + certificates for the server in the following format: + `organizations/{org}/environments/{env}/keystores/{keystore}` or + `organizations/{org}/environments/{env}/references/{reference}` + type: string + ciphers: + description: List of ciphers that are granted access. + type: array + items: + type: string + protocols: + description: List of TLS protocols that are granted access. + type: array + items: + type: string + commonName: + description: Common name to validate the target server against. + $ref: '#/components/schemas/GoogleCloudApigeeV1CommonNameConfig' + ignoreValidationErrors: + description: >- + Flag that specifies whether to ignore TLS certificate validation + errors. Set to `true` to ignore errors. + type: boolean + enforce: + description: Flag that enforces TLS settings + type: boolean + GoogleCloudApigeeV1KeyAliasReference: + id: GoogleCloudApigeeV1KeyAliasReference + type: object + properties: + reference: + description: >- + Reference name in the following format: + `organizations/{org}/environments/{env}/references/{reference}` + type: string + aliasId: + description: Alias ID. Must exist in the keystore referred to by the reference. + type: string + GoogleCloudApigeeV1CommonNameConfig: + id: GoogleCloudApigeeV1CommonNameConfig + type: object + properties: + name: + type: string + matchWildCards: + type: boolean + GoogleCloudApigeeV1DeploymentConfig: + id: GoogleCloudApigeeV1DeploymentConfig + description: 'NEXT ID: 11' + type: object properties: - analyticsConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeAnalyticsConfig' - description: Runtime configuration for Analytics add-on. name: description: >- - Name of the addons config in the format: - `organizations/{org}/environments/{env}/addonsConfig` + Name of the API or shared flow revision to be deployed in the + following format: `organizations/{org}/apis/{api}/revisions/{rev}` + or `organizations/{org}/sharedflows/{sharedflow}/revisions/{rev}` type: string - apiSecurityConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeApiSecurityConfig' - description: Runtime configuration for API Security add-on. uid: + description: >- + Unique ID. The ID will only change if the deployment is deleted and + recreated. + type: string + proxyUid: + description: Unique ID of the API proxy revision. + type: string + location: + description: Location of the API proxy bundle as a URI. + type: string + basePath: + description: Base path where the application will be hosted. Defaults to "/". + type: string + attributes: + description: Additional key-value metadata for the deployment. + type: object + additionalProperties: + type: string + serviceAccount: + description: >- + The service account identity associated with this deployment. If + non-empty, will be in the following format: + `projects/-/serviceAccounts/{account_email}` type: string + deploymentGroups: description: >- - UID is to detect if config is recreated after deletion. The add-on - config will only be deleted when the environment itself gets - deleted, thus it will always be the same as the UID of - EnvironmentConfig. + The list of deployment groups in which this proxy should be + deployed. Not currently populated for shared flows. + type: array + items: + type: string + endpoints: + description: >- + A mapping from basepaths to proxy endpoint names in this proxy. Not + populated for shared flows. + type: object + additionalProperties: + type: string + GoogleCloudApigeeV1DeploymentGroupConfig: + id: GoogleCloudApigeeV1DeploymentGroupConfig + description: >- + DeploymentGroupConfig represents a deployment group that should be + present in a particular environment. + type: object + properties: + name: + description: >- + Name of the deployment group in the following format: + `organizations/{org}/environments/{env}/deploymentGroups/{group}`. + type: string + uid: + description: >- + Unique ID. The ID will only change if the deployment group is + deleted and recreated. + type: string revisionId: + description: >- + Revision number which can be used by the runtime to detect if the + deployment group has changed between two versions. type: string - description: Revision number used by the runtime to detect config changes. + format: int64 + deploymentGroupType: + description: >- + Type of the deployment group, which will be either Standard or + Extensible. + type: string + enumDescriptions: + - Unspecified type + - Standard type + - Extensible Type + enum: + - DEPLOYMENT_GROUP_TYPE_UNSPECIFIED + - STANDARD + - EXTENSIBLE + GoogleCloudApigeeV1FlowHookConfig: + id: GoogleCloudApigeeV1FlowHookConfig type: object - id: GoogleCloudApigeeV1RuntimeAddonsConfig - GoogleCloudApigeeV1ListAsyncQueriesResponse: - description: The response for ListAsyncQueries. + properties: + name: + description: >- + Name of the flow hook in the following format: + `organizations/{org}/environments/{env}/flowhooks/{point}`. Valid + `point` values include: `PreProxyFlowHook`, `PostProxyFlowHook`, + `PreTargetFlowHook`, and `PostTargetFlowHook` + type: string + sharedFlowName: + description: >- + Name of the shared flow to invoke in the following format: + `organizations/{org}/sharedflows/{sharedflow}` + type: string + continueOnError: + description: >- + Flag that specifies whether the flow should abort after an error in + the flow hook. Defaults to `true` (continue on error). + type: boolean + GoogleCloudApigeeV1KeystoreConfig: + id: GoogleCloudApigeeV1KeystoreConfig type: object - id: GoogleCloudApigeeV1ListAsyncQueriesResponse properties: - queries: - description: The asynchronous queries belong to requested resource name. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQuery' + name: + description: >- + Resource name in the following format: + `organizations/{org}/environments/{env}/keystores/{keystore}` + type: string + aliases: + description: Aliases in the keystore. type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1AliasRevisionConfig' GoogleCloudApigeeV1AliasRevisionConfig: + id: GoogleCloudApigeeV1AliasRevisionConfig + type: object properties: + name: + description: >- + Name of the alias revision included in the keystore in the following + format: + `organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}/revisions/{rev}` + type: string type: - enum: - - ALIAS_TYPE_UNSPECIFIED - - CERT - - KEY_CERT type: string enumDescriptions: - Alias type is not specified. - Certificate. - Key/certificate pair. + enum: + - ALIAS_TYPE_UNSPECIFIED + - CERT + - KEY_CERT location: description: Location of the alias file. For example, a Google Cloud Storage URI. type: string + GoogleCloudApigeeV1ReferenceConfig: + id: GoogleCloudApigeeV1ReferenceConfig + type: object + properties: name: + description: >- + Name of the reference in the following format: + `organizations/{org}/environments/{env}/references/{reference}` type: string + resourceName: description: >- - Name of the alias revision included in the keystore in the following - format: - `organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}/revisions/{rev}` - type: object - id: GoogleCloudApigeeV1AliasRevisionConfig - GoogleCloudApigeeV1ExpireDeveloperSubscriptionRequest: - type: object - id: GoogleCloudApigeeV1ExpireDeveloperSubscriptionRequest - properties: {} - description: Request for ExpireDeveloperSubscription. - GoogleCloudApigeeV1ResourceFiles: - type: object - id: GoogleCloudApigeeV1ResourceFiles - description: List of resource files. - properties: - resourceFile: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' - type: array - description: List of resource files. + Name of the referenced resource in the following format: + `organizations/{org}/environments/{env}/keystores/{keystore}` Only + references to keystore resources are supported. + type: string GoogleCloudApigeeV1DataCollectorConfig: - description: Data collector and its configuration. id: GoogleCloudApigeeV1DataCollectorConfig + description: Data collector and its configuration. + type: object properties: name: description: >- @@ -2643,13 +2454,7 @@ components: `organizations/{org}/datacollectors/{datacollector}` type: string type: - enum: - - TYPE_UNSPECIFIED - - INTEGER - - FLOAT - - STRING - - BOOLEAN - - DATETIME + description: Data type accepted by the data collector. type: string enumDescriptions: - For future compatibility. @@ -2658,4078 +2463,4085 @@ components: - For string values. - For boolean values. - For datetime values. - description: Data type accepted by the data collector. - type: object - GoogleCloudApigeeV1ScoreComponentRecommendationActionActionContext: - id: GoogleCloudApigeeV1ScoreComponentRecommendationActionActionContext - properties: - documentationLink: - description: Documentation link for the action. - type: string - type: object - description: Action context are all the relevant details for the action. - GoogleCloudApigeeV1ComputeEnvironmentScoresResponse: + enum: + - TYPE_UNSPECIFIED + - INTEGER + - FLOAT + - STRING + - BOOLEAN + - DATETIME + GoogleCloudApigeeV1RuntimeTraceConfig: + id: GoogleCloudApigeeV1RuntimeTraceConfig + description: >- + NEXT ID: 8 RuntimeTraceConfig defines the configurations for distributed + trace in an environment. type: object properties: - nextPageToken: + name: + description: >- + Name of the trace config in the following format: + `organizations/{org}/environment/{env}/traceConfig` type: string + revisionId: description: >- - A page token, received from a previous `ComputeScore` call. Provide - this to retrieve the subsequent page. - scores: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Score' - type: array - description: List of scores. One score per day. - description: Response for ComputeEnvironmentScores. - id: GoogleCloudApigeeV1ComputeEnvironmentScoresResponse - GoogleCloudApigeeV1ListKeyValueEntriesResponse: - properties: - keyValueEntries: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' - type: array - description: One or more key value map keys and values. - nextPageToken: + Revision number which can be used by the runtime to detect if the + trace config has changed between two versions. + type: string + revisionCreateTime: + description: The timestamp that the revision was created or updated. + type: string + format: google-datetime + exporter: description: >- - Token that can be sent as `next_page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. + Exporter that is used to view the distributed trace captured using + OpenCensus. An exporter sends traces to any backend that is capable + of consuming them. Recorded spans can be exported by registered + exporters. type: string - id: GoogleCloudApigeeV1ListKeyValueEntriesResponse + enumDescriptions: + - Exporter unspecified + - Jaeger exporter + - Cloudtrace exporter + enum: + - EXPORTER_UNSPECIFIED + - JAEGER + - CLOUD_TRACE + endpoint: + description: Endpoint of the exporter. + type: string + samplingConfig: + description: Trace configuration for all API proxies in an environment. + $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeTraceSamplingConfig' + overrides: + description: List of trace configuration overrides for spicific API proxies. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeTraceConfigOverride' + GoogleCloudApigeeV1RuntimeTraceSamplingConfig: + id: GoogleCloudApigeeV1RuntimeTraceSamplingConfig description: >- - The request structure for listing key value map keys and its - corresponding values. + NEXT ID: 3 RuntimeTraceSamplingConfig represents the detail settings of + distributed tracing. Only the fields that are defined in the distributed + trace configuration can be overridden using the distribute trace + configuration override APIs. type: object - GoogleCloudApigeeV1AddonsConfig: properties: - advancedApiOpsConfig: - description: Configuration for the Advanced API Ops add-on. - $ref: '#/components/schemas/GoogleCloudApigeeV1AdvancedApiOpsConfig' - connectorsPlatformConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1ConnectorsPlatformConfig' - description: Configuration for the Connectors Platform add-on. - monetizationConfig: - description: Configuration for the Monetization add-on. - $ref: '#/components/schemas/GoogleCloudApigeeV1MonetizationConfig' - analyticsConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1AnalyticsConfig' + sampler: + description: Sampler of distributed tracing. OFF is the default value. + type: string + enumDescriptions: + - Sampler unspecified. + - >- + OFF means distributed trace is disabled, or the sampling + probability is 0. + - >- + PROBABILITY means traces are captured on a probability that + defined by sampling_rate. The sampling rate is limited to 0 to 0.5 + when this is set. + enum: + - SAMPLER_UNSPECIFIED + - 'OFF' + - PROBABILITY + samplingRate: description: >- - Configuration for the Analytics add-on. Only used in - organizations.environments.addonsConfig. - integrationConfig: - description: Configuration for the Integration add-on. - $ref: '#/components/schemas/GoogleCloudApigeeV1IntegrationConfig' - apiSecurityConfig: - description: Configuration for the API Security add-on. - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiSecurityConfig' - description: Add-on configurations for the Apigee organization. - type: object - id: GoogleCloudApigeeV1AddonsConfig - GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation: + Field sampling rate. This value is only applicable when using the + PROBABILITY sampler. The supported values are > 0 and <= 0.5. + type: number + format: float + GoogleCloudApigeeV1RuntimeTraceConfigOverride: + id: GoogleCloudApigeeV1RuntimeTraceConfigOverride + description: >- + NEXT ID: 7 Trace configuration override for a specific API proxy in an + environment. type: object properties: - securityProfileRevisionId: + name: + description: >- + Name of the trace config override in the following format: + `organizations/{org}/environment/{env}/traceConfig/overrides/{override}` type: string - format: int64 - description: 'DEPRECATED: DO NOT USE Revision ID of the security profile.' - deprecated: true - attachTime: + uid: + description: >- + Unique ID for the configuration override. The ID will only change if + the override is deleted and recreated. Corresponds to name's + "override" field. type: string - readOnly: true + revisionId: description: >- - Output only. The time when environment was attached to the security - profile. - format: google-datetime - name: - description: Immutable. Name of the environment that the profile is attached to. + Revision number which can be used by the runtime to detect if the + trace config override has changed between two versions. type: string - description: Represents a SecurityProfileEnvironmentAssociation resource. - id: GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation - GoogleCloudApigeeV1SecurityReportResultMetadata: - type: object - properties: - expires: + revisionCreateTime: + description: The timestamp that the revision was created or updated. type: string + format: google-datetime + apiProxy: description: >- - Output only. Expire_time is set to 7 days after report creation. - Query result will be unaccessable after this time. Example: - "2021-05-04T13:38:52-07:00" - readOnly: true - self: + Name of the API proxy that will have its trace configuration + overridden following format: `organizations/{org}/apis/{api}` type: string + samplingConfig: description: >- - Self link of the query results. Example: - `/organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result` - or following format if query is running at host level: - `/organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result` - id: GoogleCloudApigeeV1SecurityReportResultMetadata - description: Contains informations about the security report results. - GoogleCloudApigeeV1ConnectorsPlatformConfig: + Trace configuration override for a specific API proxy in an + environment. + $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeTraceSamplingConfig' + GoogleCloudApigeeV1RuntimeAddonsConfig: + id: GoogleCloudApigeeV1RuntimeAddonsConfig + description: >- + RuntimeAddonsConfig defines the runtime configurations for add-ons in an + environment. + type: object properties: - expiresAt: - readOnly: true + name: + description: >- + Name of the addons config in the format: + `organizations/{org}/environments/{env}/addonsConfig` type: string - format: int64 + revisionId: + description: Revision number used by the runtime to detect config changes. + type: string + uid: description: >- - Output only. Time at which the Connectors Platform add-on expires in - milliseconds since epoch. If unspecified, the add-on will never - expire. + UID is to detect if config is recreated after deletion. The add-on + config will only be deleted when the environment itself gets + deleted, thus it will always be the same as the UID of + EnvironmentConfig. + type: string + analyticsConfig: + description: Runtime configuration for Analytics add-on. + $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeAnalyticsConfig' + apiSecurityConfig: + description: Runtime configuration for API Security add-on. + $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeApiSecurityConfig' + GoogleCloudApigeeV1RuntimeAnalyticsConfig: + id: GoogleCloudApigeeV1RuntimeAnalyticsConfig + description: Runtime configuration for the Analytics add-on. + type: object + properties: enabled: - description: >- - Flag that specifies whether the Connectors Platform add-on is - enabled. + description: If the Analytics is enabled or not. type: boolean - id: GoogleCloudApigeeV1ConnectorsPlatformConfig - description: Configuration for the Connectors Platform add-on. + billingPipelineEnabled: + description: If Runtime should send billing data to AX or not. + type: boolean + GoogleCloudApigeeV1RuntimeApiSecurityConfig: + id: GoogleCloudApigeeV1RuntimeApiSecurityConfig + description: Runtime configuration for the API Security add-on. type: object - GoogleCloudApigeeV1ApiProxyRevision: + properties: + enabled: + description: If the API Security is enabled or not. + type: boolean + GoogleCloudApigeeV1EnvironmentConfigClientIPResolutionConfig: + id: GoogleCloudApigeeV1EnvironmentConfigClientIPResolutionConfig + description: Configuration for resolving the client ip. type: object properties: - integrationEndpoints: - description: >- - List of IntegrationEndpoints in the '/integration-endpoints' - directory of the API proxy. This is a 'manifest' setting designed to - provide visibility into the contents of the API proxy. - type: array - items: - type: string - type: - description: >- - Type. Set to `Application`. Maintained for compatibility with the - Apigee Edge API. + headerIndexAlgorithm: + description: Resolves the client ip based on a custom header. + $ref: >- + #/components/schemas/GoogleCloudApigeeV1EnvironmentConfigClientIPResolutionConfigHeaderIndexAlgorithm + GoogleCloudApigeeV1EnvironmentConfigClientIPResolutionConfigHeaderIndexAlgorithm: + id: >- + GoogleCloudApigeeV1EnvironmentConfigClientIPResolutionConfigHeaderIndexAlgorithm + description: Resolves the client ip based on a custom header. + type: object + properties: + ipHeaderName: + description: The name of the header to extract the client ip from. type: string - policies: - description: List of policy names included in the API proxy revision.. - items: - type: string - type: array - resources: - items: - type: string - description: >- - List of the resources included in the API proxy revision formatted - as "{type}://{name}". - type: array - lastModifiedAt: - format: int64 - type: string - description: >- - Time that the API proxy revision was last modified in milliseconds - since epoch. - revision: - type: string - description: API proxy revision. - proxyEndpoints: - description: >- - List of ProxyEndpoints in the `/proxies` directory of the API proxy. - Typically, this element is included only when the API proxy was - created using the Edge UI. This is a 'manifest' setting designed to - provide visibility into the contents of the API proxy. - type: array - items: - type: string - createdAt: + ipHeaderIndex: description: >- - Time that the API proxy revision was created in milliseconds since - epoch. - format: int64 - type: string - resourceFiles: - description: List of resource files included in the API proxy revision. - $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFiles' + The index of the ip in the header. (By default, value is 0 if + missing) + type: integer + format: int32 + GoogleCloudApigeeV1ApiSecurityRuntimeConfig: + id: GoogleCloudApigeeV1ApiSecurityRuntimeConfig + description: >- + Response for + GetApiSecurityRuntimeConfig[EnvironmentService.GetApiSecurityRuntimeConfig]. + type: object + properties: name: - type: string - description: Name of the API proxy. - teams: - type: array - items: - type: string - description: List of the teams included in the API proxy revision. - hasExtensiblePolicy: - description: >- - Output only. This field will be marked as true if revision contains - any policies marked as extensible. - type: boolean - readOnly: true - configurationVersion: - $ref: '#/components/schemas/GoogleCloudApigeeV1ConfigVersion' description: >- - Version of the API proxy configuration schema to which the API proxy - conforms. Currently, the only supported value is 4.0 - (`majorVersion.minorVersion`). This setting may be used in the - future to track the evolution of the API proxy format. - spec: + Name of the environment API Security Runtime configuration resource. + Format: + `organizations/{org}/environments/{env}/apiSecurityRuntimeConfig` type: string + uid: description: >- - OpenAPI Specification that is associated with the API proxy. The - value is set to a URL or to a path in the specification store. - description: - description: Description of the API proxy revision. + Unique ID for the API Security Runtime configuration. The ID will + only change if the environment is deleted and recreated. type: string - entityMetaDataAsProperties: - type: object - additionalProperties: - type: string - description: Metadata describing the API proxy revision as a key-value map. - targetEndpoints: - items: - type: string + revisionId: description: >- - List of TargetEndpoints in the `/targets` directory of the API - proxy. Typically, this element is included only when the API proxy - was created using the Edge UI. This is a 'manifest' setting designed - to provide visibility into the contents of the API proxy. - type: array - proxies: - items: - type: string - description: List of proxy names included in the API proxy revision. - type: array - targets: - type: array - description: List of the targets included in the API proxy revision. - items: - type: string - contextInfo: - description: Revision number, app name, and organization for the API proxy. + Revision ID of the API Security Runtime configuration. The higher + the value, the more recently the configuration was deployed. type: string - targetServers: - description: >- - List of TargetServers referenced in any TargetEndpoint in the API - proxy. Typically, you will see this element only when the API proxy - was created using the Edge UI. This is a 'manifest' setting designed - to provide visibility into the contents of the API proxy. - items: - type: string - type: array - displayName: + format: int64 + updateTime: + description: Time that the API Security Runtime configuration was updated. type: string - description: Human-readable name of the API proxy. - sharedFlows: + format: google-datetime + location: + description: A list of up to 5 Cloud Storage Blobs that contain SecurityActions. type: array - description: List of the shared flows included in the API proxy revision. items: type: string - archive: - readOnly: true + GoogleCloudApigeeV1Subscription: + id: GoogleCloudApigeeV1Subscription + description: Pub/Sub subscription of an environment. + type: object + properties: + name: description: >- - Output only. The archive that generated this proxy revision. This - field is only present on proxy revisions that were generated by an - archive. Proxies generated by archives cannot be updated, deleted, - or deployed to other environments. Format: - `organizations/*/environments/*/archiveDeployments/*` + Full name of the Pub/Sub subcription. Use the following structure in + your request: `subscription "projects/foo/subscription/bar"` type: string - basepaths: - items: - type: string - type: array - description: Base URL of the API proxy. - description: API proxy revision. - id: GoogleCloudApigeeV1ApiProxyRevision - GoogleCloudApigeeV1GenerateDownloadUrlRequest: - id: GoogleCloudApigeeV1GenerateDownloadUrlRequest - description: Request for GenerateDownloadUrl method. + GoogleCloudApigeeV1AddonsConfig: + id: GoogleCloudApigeeV1AddonsConfig + description: Add-on configurations for the Apigee organization. type: object - properties: {} - GoogleCloudApigeeV1IntegrationConfig: + properties: + advancedApiOpsConfig: + description: Configuration for the Advanced API Ops add-on. + $ref: '#/components/schemas/GoogleCloudApigeeV1AdvancedApiOpsConfig' + integrationConfig: + description: Configuration for the Integration add-on. + $ref: '#/components/schemas/GoogleCloudApigeeV1IntegrationConfig' + monetizationConfig: + description: Configuration for the Monetization add-on. + $ref: '#/components/schemas/GoogleCloudApigeeV1MonetizationConfig' + apiSecurityConfig: + description: Configuration for the API Security add-on. + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiSecurityConfig' + connectorsPlatformConfig: + description: Configuration for the Connectors Platform add-on. + $ref: '#/components/schemas/GoogleCloudApigeeV1ConnectorsPlatformConfig' + analyticsConfig: + description: >- + Configuration for the Analytics add-on. Only used in + organizations.environments.addonsConfig. + $ref: '#/components/schemas/GoogleCloudApigeeV1AnalyticsConfig' + GoogleCloudApigeeV1AdvancedApiOpsConfig: + id: GoogleCloudApigeeV1AdvancedApiOpsConfig + description: Configuration for the Advanced API Ops add-on. type: object + properties: + enabled: + description: Flag that specifies whether the Advanced API Ops add-on is enabled. + type: boolean + GoogleCloudApigeeV1IntegrationConfig: id: GoogleCloudApigeeV1IntegrationConfig description: Configuration for the Integration add-on. + type: object properties: enabled: - type: boolean description: Flag that specifies whether the Integration add-on is enabled. - GoogleCloudApigeeV1ProvisionOrganizationRequest: + type: boolean + GoogleCloudApigeeV1MonetizationConfig: + id: GoogleCloudApigeeV1MonetizationConfig + description: Configuration for the Monetization add-on. + type: object properties: - analyticsRegion: - type: string + enabled: + description: Flag that specifies whether the Monetization add-on is enabled. + type: boolean + GoogleCloudApigeeV1ApiSecurityConfig: + id: GoogleCloudApigeeV1ApiSecurityConfig + description: Configurations of the API Security add-on. + type: object + properties: + enabled: + description: Flag that specifies whether the API security add-on is enabled. + type: boolean + expiresAt: description: >- - Primary Cloud Platform region for analytics data storage. For valid - values, see [Create an - organization](https://cloud.google.com/apigee/docs/hybrid/latest/precog-provision). - Defaults to `us-west1`. - authorizedNetwork: + Output only. Time at which the API Security add-on expires in + milliseconds since epoch. If unspecified, the add-on will never + expire. + readOnly: true type: string + format: int64 + GoogleCloudApigeeV1ConnectorsPlatformConfig: + id: GoogleCloudApigeeV1ConnectorsPlatformConfig + description: Configuration for the Connectors Platform add-on. + type: object + properties: + enabled: description: >- - Compute Engine network used for Service Networking to be peered with - Apigee runtime instances. See [Getting started with the Service - Networking - API](https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started). - Apigee also supports shared VPC (that is, the host network project - is not the same as the one that is peering with Apigee). See [Shared - VPC overview](https://cloud.google.com/vpc/docs/shared-vpc). To use - a shared VPC network, use the following format: - `projects/{host-project-id}/{region}/networks/{network-name}`. For - example: `projects/my-sharedvpc-host/global/networks/mynetwork` - runtimeLocation: + Flag that specifies whether the Connectors Platform add-on is + enabled. + type: boolean + expiresAt: description: >- - Cloud Platform location for the runtime instance. Defaults to zone - `us-west1-a`. If a region is provided, `EVAL` organizations will use - the region for automatically selecting a zone for the runtime - instance. + Output only. Time at which the Connectors Platform add-on expires in + milliseconds since epoch. If unspecified, the add-on will never + expire. + readOnly: true type: string - disableVpcPeering: + format: int64 + GoogleCloudApigeeV1AnalyticsConfig: + id: GoogleCloudApigeeV1AnalyticsConfig + description: Configuration for the Analytics add-on. + type: object + properties: + enabled: + description: Whether the Analytics add-on is enabled. type: boolean + expireTimeMillis: description: >- - Optional. Flag that specifies whether the VPC Peering through - Private Google Access should be disabled between the consumer - network and Apigee. Required if an authorizedNetwork on the consumer - project is not provided, in which case the flag should be set to - true. The value must be set before the creation of any Apigee - runtime instance and can be updated only when there are no runtime - instances. **Note:** Apigee will be deprecating the vpc peering - model that requires you to provide 'authorizedNetwork', by making - the non-peering model as the default way of provisioning Apigee - organization in future. So, this will be a temporary flag to enable - the transition. Not supported for Apigee hybrid. - type: object - id: GoogleCloudApigeeV1ProvisionOrganizationRequest - description: Request for ProvisionOrganization. - GoogleCloudApigeeV1Attributes: - id: GoogleCloudApigeeV1Attributes + Output only. Time at which the Analytics add-on expires in + milliseconds since epoch. If unspecified, the add-on will never + expire. + readOnly: true + type: string + format: int64 + state: + description: Output only. The state of the Analytics add-on. + readOnly: true + type: string + enumDescriptions: + - Default value. + - Add-on is in progress of enabling. + - Add-on is fully enabled and ready to use. + - Add-on is in progress of disabling. + - Add-on is fully disabled. + enum: + - ADDON_STATE_UNSPECIFIED + - ENABLING + - ENABLED + - DISABLING + - DISABLED + updateTime: + description: Output only. The latest update time. + readOnly: true + type: string + format: google-datetime + GoogleCloudApigeeV1SetAddonEnablementRequest: + id: GoogleCloudApigeeV1SetAddonEnablementRequest + description: Request for SetAddonEnablement. type: object properties: - attribute: - description: List of attributes. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - type: array - GoogleCloudApigeeV1Datastore: + analyticsEnabled: + description: If the Analytics should be enabled in the environment. + type: boolean + apiSecurityEnabled: + description: If the API Security should be enabled in the environment. + type: boolean + GoogleCloudApigeeV1Instance: + id: GoogleCloudApigeeV1Instance + description: Apigee runtime instance. + type: object properties: - createTime: + name: + description: >- + Required. Resource ID of the instance. Values must match the regular + expression `^a-z{0,30}[a-z\d]$`. type: string - format: int64 - readOnly: true + location: + description: Required. Compute Engine location where the instance resides. + type: string + peeringCidrRange: description: >- - Output only. Datastore create time, in milliseconds since the epoch - of 1970-01-01T00:00:00Z - targetType: + Optional. Size of the CIDR block range that will be reserved by the + instance. PAID organizations support `SLASH_16` to `SLASH_20` and + defaults to `SLASH_16`. Evaluation organizations support only + `SLASH_23`. + deprecated: true type: string - description: Destination storage type. Supported types `gcs` or `bigquery`. - org: + enumDescriptions: + - Range not specified. + - '`/16` CIDR range.' + - '`/17` CIDR range.' + - '`/18` CIDR range.' + - '`/19` CIDR range.' + - '`/20` CIDR range.' + - '`/22` CIDR range. Supported for evaluation only.' + - '`/23` CIDR range. Supported for evaluation only.' + enum: + - CIDR_RANGE_UNSPECIFIED + - SLASH_16 + - SLASH_17 + - SLASH_18 + - SLASH_19 + - SLASH_20 + - SLASH_22 + - SLASH_23 + host: + description: >- + Output only. Internal hostname or IP address of the Apigee endpoint + used by clients to connect to the service. readOnly: true - description: Output only. Organization that the datastore belongs to type: string - datastoreConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1DatastoreConfig' - description: Datastore Configurations. + port: + description: Output only. Port number of the exposed Apigee endpoint. + readOnly: true + type: string + description: + description: Optional. Description of the instance. + type: string displayName: - description: Required. Display name in UI + description: Optional. Display name for the instance. + type: string + createdAt: + description: >- + Output only. Time the instance was created in milliseconds since + epoch. + readOnly: true + type: string + format: int64 + lastModifiedAt: + description: >- + Output only. Time the instance was last modified in milliseconds + since epoch. + readOnly: true type: string - lastUpdateTime: format: int64 + diskEncryptionKeyName: + description: >- + Optional. Customer Managed Encryption Key (CMEK) used for disk and + volume encryption. If not specified, a Google-Managed encryption key + will be used. Use the following format: + `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)` + type: string + state: + description: >- + Output only. State of the instance. Values other than `ACTIVE` means + the resource is not ready to use. readOnly: true + type: string + enumDescriptions: + - Resource is in an unspecified state. + - Resource is being created. + - Resource is provisioned and ready to use. + - The resource is being deleted. + - The resource is being updated. + enum: + - STATE_UNSPECIFIED + - CREATING + - ACTIVE + - DELETING + - UPDATING + runtimeVersion: description: >- - Output only. Datastore last update time, in milliseconds since the - epoch of 1970-01-01T00:00:00Z + Output only. Version of the runtime system running in the instance. + The runtime system is the set of components that serve the API Proxy + traffic in your Environments. + readOnly: true type: string - self: + ipRange: + description: >- + Optional. Comma-separated list of CIDR blocks of length 22 and/or 28 + used to create the Apigee instance. Providing CIDR ranges is + optional. You can provide just /22 or /28 or both (or neither). + Ranges you provide should be freely available as part of a larger + named range you have allocated to the Service Networking peering. If + this parameter is not provided, Apigee automatically requests an + available /22 and /28 CIDR block from Service Networking. Use the + /22 CIDR block for configuring your firewall needs to allow traffic + from Apigee. Input formats: `a.b.c.d/22` or `e.f.g.h/28` or + `a.b.c.d/22,e.f.g.h/28` type: string + consumerAcceptList: + description: >- + Optional. Customer accept list represents the list of projects + (id/number) on customer side that can privately connect to the + service attachment. It is an optional field which the customers can + provide during the instance creation. By default, the customer + project associated with the Apigee organization will be included to + the list. + type: array + items: + type: string + serviceAttachment: + description: >- + Output only. Resource name of the service attachment created for the + instance in the format: `projects/*/regions/*/serviceAttachments/*` + Apigee customers can privately forward traffic to this service + attachment using the PSC endpoints. readOnly: true + type: string + accessLoggingConfig: description: >- - Output only. Resource link of Datastore. Example: - `/organizations/{org}/analytics/datastores/{uuid}` - type: object - id: GoogleCloudApigeeV1Datastore + Optional. Access logging configuration enables the access logging + feature at the instance. Apigee customers can enable access logging + to ship the access logs to their own project's cloud logging. + $ref: '#/components/schemas/GoogleCloudApigeeV1AccessLoggingConfig' + GoogleCloudApigeeV1AccessLoggingConfig: + id: GoogleCloudApigeeV1AccessLoggingConfig description: >- - The data store defines the connection to export data repository (Cloud - Storage, BigQuery), including the credentials used to access the data - repository. - GoogleCloudApigeeV1ApiSecurityConfig: + Access logging configuration enables customers to ship the access logs + from the tenant projects to their own project's cloud logging. The + feature is at the instance level ad disabled by default. It can be + enabled during CreateInstance or UpdateInstance. type: object - description: Configurations of the API Security add-on. properties: - expiresAt: - type: string - format: int64 - readOnly: true - description: >- - Output only. Time at which the API Security add-on expires in in - milliseconds since epoch. If unspecified, the add-on will never - expire. enabled: - description: Flag that specifies whether the API security add-on is enabled. + description: >- + Optional. Boolean flag that specifies whether the customer access + log feature is enabled. type: boolean - id: GoogleCloudApigeeV1ApiSecurityConfig - GoogleCloudApigeeV1ActivateNatAddressRequest: - properties: {} - type: object - id: GoogleCloudApigeeV1ActivateNatAddressRequest - description: Request for ActivateNatAddressRequest. Activate the nat address request. - GoogleCloudApigeeV1ReferenceConfig: - id: GoogleCloudApigeeV1ReferenceConfig - type: object - properties: - resourceName: - type: string + filter: description: >- - Name of the referenced resource in the following format: - `organizations/{org}/environments/{env}/keystores/{keystore}` Only - references to keystore resources are supported. - name: + Optional. Ship the access log entries that match the status_code + defined in the filter. The status_code is the only + expected/supported filter field. (Ex: status_code) The filter will + parse it to the Common Expression Language semantics for expression + evaluation to build the filter condition. (Ex: "filter": status_code + >= 200 && status_code < 300 ) type: string - description: >- - Name of the reference in the following format: - `organizations/{org}/environments/{env}/references/{reference}` - GoogleCloudApigeeV1ListHybridIssuersResponse: - id: GoogleCloudApigeeV1ListHybridIssuersResponse + GoogleCloudApigeeV1ListInstancesResponse: + id: GoogleCloudApigeeV1ListInstancesResponse + description: Response for ListInstances. type: object properties: - issuers: + instances: + description: Instances in the specified organization. type: array - description: Lists of hybrid services and its trusted issuer email ids. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ServiceIssuersMapping' - GoogleCloudApigeeV1ListRatePlansResponse: - type: object - properties: - nextStartKey: - type: string + $ref: '#/components/schemas/GoogleCloudApigeeV1Instance' + nextPageToken: description: >- - Value that can be sent as `startKey` to retrieve the next page of - content. If this field is omitted, there are no subsequent pages. - ratePlans: - description: List of rate plans in an organization. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' - type: array - id: GoogleCloudApigeeV1ListRatePlansResponse - description: Response for ListRatePlans. - GoogleCloudApigeeV1DocumentationFile: - properties: - contents: - description: Required. The file contents. The max size is 4 MB. - format: byte - type: string - displayName: + Page token that you can include in a ListInstance request to + retrieve the next page of content. If omitted, no subsequent pages + exist. type: string - description: >- - Required. A display name for the file, shown in the management UI. - Max length is 255 characters. - id: GoogleCloudApigeeV1DocumentationFile + GoogleCloudApigeeV1ListOrganizationsResponse: + id: GoogleCloudApigeeV1ListOrganizationsResponse type: object - description: Documentation file contents for a catalog item. - GoogleCloudApigeeV1BatchUpdateSecurityIncidentsRequest: properties: - requests: - description: >- - Optional. Required. The request message specifying the resources to - update. A maximum of 1000 can be modified in a batch. - items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1UpdateSecurityIncidentRequest + organizations: + description: List of Apigee organizations and associated Google Cloud projects. type: array - id: GoogleCloudApigeeV1BatchUpdateSecurityIncidentsRequest - type: object - description: Request for BatchUpdateSecurityIncident. - GoogleCloudApigeeV1GenerateUploadUrlResponse: - id: GoogleCloudApigeeV1GenerateUploadUrlResponse - properties: - uploadUri: - description: >- - The Google Cloud Storage signed URL that can be used to upload a new - Archive zip file. - type: string - description: Response for GenerateUploadUrl method. - type: object - GoogleCloudApigeeV1TargetServerConfig: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1OrganizationProjectMapping' + GoogleCloudApigeeV1OrganizationProjectMapping: + id: GoogleCloudApigeeV1OrganizationProjectMapping type: object properties: - protocol: - description: The protocol used by this target server. - enum: - - PROTOCOL_UNSPECIFIED - - HTTP - - HTTP2 - - GRPC_TARGET - - GRPC - - EXTERNAL_CALLOUT - enumDescriptions: - - UNSPECIFIED defaults to HTTP for backwards compatibility. - - The TargetServer uses HTTP. - - The TargetSever uses HTTP2. - - The TargetServer uses GRPC. - - >- - GRPC TargetServer to be used in ExternalCallout Policy. Prefer to - use EXTERNAL_CALLOUT instead. TODO(b/266125112) deprecate once - EXTERNAL _CALLOUT generally available. - - The TargetServer is to be used in the ExternalCallout Policy + organization: + description: Name of the Apigee organization. type: string - enabled: - type: boolean + projectIds: description: >- - Whether the target server is enabled. An empty/omitted value for - this field should be interpreted as true. - tlsInfo: - $ref: '#/components/schemas/GoogleCloudApigeeV1TlsInfoConfig' - description: TLS settings for the target server. - host: - type: string - description: Host name of the target server. - port: - format: int32 - type: integer - description: Port number for the target server. - name: + DEPRECATED: Use `project_id`. An Apigee Organization is mapped to a + single project. + deprecated: true + type: array + items: + type: string + projectId: + description: Google Cloud project associated with the Apigee organization type: string + location: description: >- - Target server revision name in the following format: - `organizations/{org}/environments/{env}/targetservers/{targetserver}/revisions/{rev}` - id: GoogleCloudApigeeV1TargetServerConfig - GoogleCloudApigeeV1ApiCategory: - description: >- - `ApiCategory` represents an API category. [Catalog - items](/apigee/docs/reference/apis/apigee/rest/v1/organizations.sites.apidocs) - can be tagged with API categories; users viewing the API catalog in the - portal will have the option to browse the catalog by category. - type: object - id: GoogleCloudApigeeV1ApiCategory - properties: - updateTime: - format: int64 - type: string - description: Time the category was last modified in milliseconds since epoch. - id: - description: ID of the category (a UUID). - type: string - name: - description: Name of the category. - type: string - siteId: - description: Name of the portal. + Output only. The Google Cloud region where control plane data is + located. For more information, see + https://cloud.google.com/about/locations/. + readOnly: true type: string - GoogleCloudApigeeV1ListInstanceAttachmentsResponse: - description: Response for ListInstanceAttachments. - id: GoogleCloudApigeeV1ListInstanceAttachmentsResponse + GoogleCloudApigeeV1Organization: + id: GoogleCloudApigeeV1Organization type: object properties: - nextPageToken: + name: + description: Output only. Name of the Apigee organization. + readOnly: true type: string + displayName: description: >- - Page token that you can include in a ListInstanceAttachments request - to retrieve the next page of content. If omitted, no subsequent - pages exist. - attachments: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1InstanceAttachment' - type: array - description: Attachments for the instance. - GoogleCloudApigeeV1GraphQLOperation: - type: object - properties: - operation: - description: >- - GraphQL operation name. The name and operation type will be used to - apply quotas. If no name is specified, the quota will be applied to - all GraphQL operations irrespective of their operation names in the - payload. + Optional. Display name for the Apigee organization. Unused, but + reserved for future use. type: string - operationTypes: - items: - type: string - description: >- - Required. GraphQL operation types. Valid values include `query` or - `mutation`. **Note**: Apigee does not currently support - `subscription` types. - type: array - description: >- - Represents the pairing of GraphQL operation types and the GraphQL - operation name. - id: GoogleCloudApigeeV1GraphQLOperation - GoogleCloudApigeeV1APIProductAssociation: - id: GoogleCloudApigeeV1APIProductAssociation - properties: - status: - description: >- - The API product credential associated status. Valid values are - `approved` or `revoked`. + description: + description: Optional. Description of the Apigee organization. type: string - apiproduct: + customerName: + description: Not used by Apigee. type: string - description: API product to be associated with the credential. - type: object - description: >- - APIProductAssociation has the API product and its administrative state - association. - GoogleCloudApigeeV1Access: - id: GoogleCloudApigeeV1Access - properties: - Get: - $ref: '#/components/schemas/GoogleCloudApigeeV1AccessGet' - Remove: - $ref: '#/components/schemas/GoogleCloudApigeeV1AccessRemove' - Set: - $ref: '#/components/schemas/GoogleCloudApigeeV1AccessSet' - type: object - GoogleCloudApigeeV1QueryTabularStatsResponse: - id: GoogleCloudApigeeV1QueryTabularStatsResponse - properties: - values: - type: array - description: Resultant rows from the executed query. - items: - type: array - items: - type: any - columns: + attributes: + description: Not used by Apigee. type: array items: type: string + createdAt: description: >- - Column names corresponding to the same order as the inner values in - the stats field. - nextPageToken: - description: Next page token. - type: string - description: >- - Encapsulates two kinds of stats that are results of the dimensions and - aggregations requested. - Tabular rows. - Time series data. Example of - tabular rows, Represents security stats results as a row of flat values. - type: object - GoogleTypeExpr: - properties: - location: + Output only. Time that the Apigee organization was created in + milliseconds since epoch. + readOnly: true type: string + format: int64 + lastModifiedAt: description: >- - Optional. String indicating the location of the expression for error - reporting, e.g. a file name and a position in the file. - expression: - description: >- - Textual representation of an expression in Common Expression - Language syntax. + Output only. Time that the Apigee organization was last modified in + milliseconds since epoch. + readOnly: true type: string - title: + format: int64 + expiresAt: 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 - description: + Output only. Time that the Apigee organization is scheduled for + deletion. + readOnly: true + type: string + format: int64 + environments: + description: Output only. List of environments in the Apigee organization. + readOnly: true + type: array + items: + type: string + properties: + description: Optional. Properties defined in the Apigee organization profile. + $ref: '#/components/schemas/GoogleCloudApigeeV1Properties' + type: + description: Not used by Apigee. type: string - description: >- - Optional. Description of the expression. This is a longer text which - describes the expression, e.g. when hovered over it in a UI. - 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. - type: object - id: GoogleTypeExpr - GoogleCloudApigeeV1Environment: - type: object - properties: - deploymentType: - enum: - - DEPLOYMENT_TYPE_UNSPECIFIED - - PROXY - - ARCHIVE - description: >- - Optional. Deployment type supported by the environment. The - deployment type can be set when creating the environment and cannot - be changed. When you enable archive deployment, you will be - **prevented from performing** a [subset of - actions](/apigee/docs/api-platform/local-development/overview#prevented-actions) - within the environment, including: * Managing the deployment of API - proxy or shared flow revisions * Creating, updating, or deleting - resource files * Creating, updating, or deleting target servers enumDescriptions: - - Deployment type not specified. + - Subscription type not specified. - >- - Proxy deployment enables you to develop and deploy API proxies - using Apigee on Google Cloud. This cannot currently be combined - with the CONFIGURABLE API proxy type. + Subscription to Apigee is free, limited, and used for evaluation + purposes only. - >- - Archive deployment enables you to develop API proxies locally then - deploy an archive of your API proxy configuration to an - environment in Apigee on Google Cloud. You will be prevented from - performing a [subset of - actions](/apigee/docs/api-platform/local-development/overview#prevented-actions) - within the environment. + Full subscription to Apigee has been purchased. See [Apigee + pricing](https://cloud.google.com/apigee/pricing/). + - For internal users only. + enum: + - TYPE_UNSPECIFIED + - TYPE_TRIAL + - TYPE_PAID + - TYPE_INTERNAL + analyticsRegion: + description: >- + Required. DEPRECATED: This field will eventually be deprecated and + replaced with a differently-named field. Primary Google Cloud region + for analytics data storage. For valid values, see [Create an Apigee + organization](https://cloud.google.com/apigee/docs/api-platform/get-started/create-org). + deprecated: true type: string - hasAttachedFlowHooks: + authorizedNetwork: + description: >- + Optional. Compute Engine network used for Service Networking to be + peered with Apigee runtime instances. See [Getting started with the + Service Networking + API](https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started). + Valid only when [RuntimeType](#RuntimeType) is set to `CLOUD`. The + value must be set before the creation of a runtime instance and can + be updated only when there are no runtime instances. For example: + `default`. When changing authorizedNetwork, you must reconfigure VPC + peering. After VPC peering with previous network is deleted, [run + the following + command](https://cloud.google.com/sdk/gcloud/reference/services/vpc-peerings/delete): + `gcloud services vpc-peerings delete --network=NETWORK`, where + `NETWORK` is the name of the previous network. This will delete the + previous Service Networking. Otherwise, you will get the following + error: `The resource 'projects/...-tp' is already linked to another + shared VPC host 'projects/...-tp`. Apigee also supports shared VPC + (that is, the host network project is not the same as the one that + is peering with Apigee). See [Shared VPC + overview](https://cloud.google.com/vpc/docs/shared-vpc). To use a + shared VPC network, use the following format: + `projects/{host-project-id}/{region}/networks/{network-name}`. For + example: `projects/my-sharedvpc-host/global/networks/mynetwork` + **Note:** Not supported for Apigee hybrid. + type: string + disableVpcPeering: + description: >- + Optional. Flag that specifies whether the VPC Peering through + Private Google Access should be disabled between the consumer + network and Apigee. Valid only when RuntimeType is set to CLOUD. + Required if an authorizedNetwork on the consumer project is not + provided, in which case the flag should be set to true. The value + must be set before the creation of any Apigee runtime instance and + can be updated only when there are no runtime instances. **Note:** + Apigee will be deprecating the vpc peering model that requires you + to provide 'authorizedNetwork', by making the non-peering model as + the default way of provisioning Apigee organization in future. So, + this will be a temporary flag to enable the transition. Not + supported for Apigee hybrid. type: boolean - displayName: - description: Optional. Display name for this environment. + runtimeType: + description: >- + Required. Runtime type of the Apigee organization based on the + Apigee subscription purchased. type: string - nodeConfig: - description: Optional. NodeConfig of the environment. - $ref: '#/components/schemas/GoogleCloudApigeeV1NodeConfig' - state: + enumDescriptions: + - Runtime type not specified. + - Google-managed Apigee runtime. + - User-managed Apigee hybrid runtime. + enum: + - RUNTIME_TYPE_UNSPECIFIED + - CLOUD + - HYBRID + subscriptionType: + description: >- + Output only. DEPRECATED: This will eventually be replaced by + BillingType. Subscription type of the Apigee organization. Valid + values include trial (free, limited, and for evaluation purposes + only) or paid (full subscription has been purchased). See [Apigee + pricing](https://cloud.google.com/apigee/pricing/). + readOnly: true + deprecated: true type: string + enumDescriptions: + - Subscription type not specified. + - Full subscription to Apigee has been purchased. + - >- + Subscription to Apigee is free, limited, and used for evaluation + purposes only. enum: - - STATE_UNSPECIFIED - - CREATING - - ACTIVE - - DELETING - - UPDATING + - SUBSCRIPTION_TYPE_UNSPECIFIED + - PAID + - TRIAL + billingType: + description: >- + Optional. Billing type of the Apigee organization. See [Apigee + pricing](https://cloud.google.com/apigee/pricing). + type: string + enumDescriptions: + - Billing type not specified. + - A pre-paid subscription to Apigee. + - Free and limited access to Apigee for evaluation purposes only. + - Access to Apigee using a Pay-As-You-Go plan. + enum: + - BILLING_TYPE_UNSPECIFIED + - SUBSCRIPTION + - EVALUATION + - PAYG + addonsConfig: + description: Optional. Addon configurations of the Apigee organization. + $ref: '#/components/schemas/GoogleCloudApigeeV1AddonsConfig' + caCertificate: + description: >- + Output only. Base64-encoded public certificate for the root CA of + the Apigee organization. Valid only when [RuntimeType](#RuntimeType) + is `CLOUD`. + readOnly: true + type: string + format: byte + runtimeDatabaseEncryptionKeyName: + description: >- + Optional. Cloud KMS key name used for encrypting the data that is + stored and replicated across runtime instances. Update is not + allowed after the organization is created. If not specified or + [RuntimeType](#RuntimeType) is `TRIAL`, a Google-Managed encryption + key will be used. For example: + "projects/foo/locations/us/keyRings/bar/cryptoKeys/baz". **Note:** + Not supported for Apigee hybrid. + type: string + projectId: + description: Output only. Project ID associated with the Apigee organization. + readOnly: true + type: string + state: + description: >- + Output only. State of the organization. Values other than ACTIVE + means the resource is not ready to use. + readOnly: true + type: string enumDescriptions: - Resource is in an unspecified state. - Resource is being created. - Resource is provisioned and ready to use. - The resource is being deleted. - The resource is being updated. - readOnly: true - description: >- - Output only. State of the environment. Values other than ACTIVE - means the resource is not ready to use. - createdAt: - readOnly: true + enum: + - STATE_UNSPECIFIED + - CREATING + - ACTIVE + - DELETING + - UPDATING + portalDisabled: + description: Optional. Configuration for the Portals settings. + type: boolean + apiConsumerDataEncryptionKeyName: description: >- - Output only. Creation time of this environment as milliseconds since - epoch. - type: string - format: int64 - name: + Optional. Cloud KMS key name used for encrypting API consumer data. + If not specified or [BillingType](#BillingType) is `EVALUATION`, a + Google-Managed encryption key will be used. Format: + `projects/*/locations/*/keyRings/*/cryptoKeys/*` type: string + controlPlaneEncryptionKeyName: description: >- - Required. Name of the environment. Values must match the regular - expression `^[.\\p{Alnum}-_]{1,255}$` - properties: + Optional. Cloud KMS key name used for encrypting control plane data + that is stored in a multi region. Only used for the data residency + region "US" or "EU". If not specified or [BillingType](#BillingType) + is `EVALUATION`, a Google-Managed encryption key will be used. + Format: `projects/*/locations/*/keyRings/*/cryptoKeys/*` + type: string + apiConsumerDataLocation: description: >- - Optional. Key-value pairs that may be used for customizing the - environment. - $ref: '#/components/schemas/GoogleCloudApigeeV1Properties' - type: - enum: - - ENVIRONMENT_TYPE_UNSPECIFIED - - BASE - - INTERMEDIATE - - COMPREHENSIVE - description: Optional. EnvironmentType selected for the environment. - enumDescriptions: - - Environment type not specified. - - >- - This is the default type. Base environment has limited capacity - and capabilities and are usually used when you are getting started - with Apigee or while experimenting. Refer to Apigee's public - documentation for more details. - - >- - Intermediate environment supports API management features and - higher capacity than Base environment. Refer to Apigee's public - documentation for more details. - - >- - Comprehensive environment supports advanced capabilites and even - higher capacity than Intermediate environment. Refer to Apigee's - public documentation for more details. + Optional. This field is needed only for customers using non-default + data residency regions. Apigee stores some control plane data only + in single region. This field determines which single region Apigee + should use. For example: "us-west1" when control plane is in US or + "europe-west2" when control plane is in EU. type: string - lastModifiedAt: + apigeeProjectId: + description: >- + Output only. Apigee Project ID associated with the organization. Use + this project to allowlist Apigee in the Service Attachment when + using private service connect with Apigee. + readOnly: true type: string + subscriptionPlan: description: >- - Output only. Last modification time of this environment as - milliseconds since epoch. - format: int64 + Output only. Subscription plan that the customer has purchased. + Output only. readOnly: true - apiProxyType: - enum: - - API_PROXY_TYPE_UNSPECIFIED - - PROGRAMMABLE - - CONFIGURABLE type: string enumDescriptions: - - API proxy type not specified. - - >- - Programmable API Proxies enable you to develop APIs with highly - flexible behavior using bundled policy configuration and one or - more programming languages to describe complex sequential and/or - conditional flows of logic. + - Subscription plan not specified. + - Traditional subscription plan. - >- - Configurable API Proxies enable you to develop efficient APIs - using simple configuration while complex execution control flow - logic is handled by Apigee. This type only works with the ARCHIVE - deployment type and cannot be combined with the PROXY deployment - type. - description: >- - Optional. API Proxy type supported by the environment. The type can - be set when creating the Environment and cannot be changed. - forwardProxyUri: + New subscription plan that provides standard proxy and scaled + proxy implementation. + enum: + - SUBSCRIPTION_PLAN_UNSPECIFIED + - SUBSCRIPTION_2021 + - SUBSCRIPTION_2024 + networkEgressRestricted: description: >- - Optional. URI of the forward proxy to be applied to the runtime - instances in this environment. Must be in the format of - {scheme}://{hostname}:{port}. Note that the scheme must be one of - "http" or "https", and the port must be supplied. To remove a - forward proxy setting, update the field to an empty value. Note: At - this time, PUT operations to add forwardProxyUri to an existing - environment fail if the environment has nodeConfig set up. To - successfully add the forwardProxyUri setting in this case, include - the NodeConfig details with the request. - type: string - description: - description: Optional. Description of the environment. - type: string - id: GoogleCloudApigeeV1Environment - GoogleCloudApigeeV1ProfileConfigAuthorization: - properties: {} - description: >- - By default, following policies will be included: - JWS - JWT - OAuth - - BasicAuth - APIKey - id: GoogleCloudApigeeV1ProfileConfigAuthorization + Optional. Flag that specifies if internet egress is restricted for + VPC Service Controls. Valid only when runtime_type is `CLOUD` and + disable_vpc_peering is `true`. + type: boolean + GoogleCloudApigeeV1GetSyncAuthorizationRequest: + id: GoogleCloudApigeeV1GetSyncAuthorizationRequest + description: Request for GetSyncAuthorization. type: object - GoogleCloudApigeeV1GrpcOperationConfig: - description: >- - Binds the resources in a proxy or remote service with the gRPC operation - and its associated quota enforcement. - id: GoogleCloudApigeeV1GrpcOperationConfig + properties: {} + GoogleCloudApigeeV1SyncAuthorization: + id: GoogleCloudApigeeV1SyncAuthorization type: object properties: - quota: - description: >- - Quota parameters to be enforced for the methods and API source - combination. If none are specified, quota enforcement will not be - done. - $ref: '#/components/schemas/GoogleCloudApigeeV1Quota' - apiSource: + identities: description: >- - Required. Name of the API proxy with which the gRPC operation and - quota are associated. - type: string - attributes: + Required. Array of service accounts to grant access to control plane + resources, each specified using the following format: + `serviceAccount:` service-account-name. The service-account-name is + formatted like an email address. For example: + `my-synchronizer-manager-service_account@my_project_id.iam.gserviceaccount.com` + You might specify multiple service accounts, for example, if you + have multiple environments and wish to assign a unique service + account to each one. The service accounts must have **Apigee + Synchronizer Manager** role. See also [Create service + accounts](https://cloud.google.com/apigee/docs/hybrid/latest/sa-about#create-the-service-accounts). type: array - description: Custom attributes associated with the operation. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - service: - type: string - description: >- - Required. gRPC Service name associated to be associated with the API - proxy, on which quota rules can be applied upon. - methods: - description: >- - List of unqualified gRPC method names for the proxy to which quota - will be applied. If this field is empty, the Quota will apply to all - operations on the gRPC service defined on the proxy. Example: Given - a proxy that is configured to serve com.petstore.PetService, the - methods com.petstore.PetService.ListPets and - com.petstore.PetService.GetPet would be specified here as simply - ["ListPets", "GetPet"]. items: type: string - type: array - GoogleIamV1Policy: - id: GoogleIamV1Policy - type: object - properties: etag: + description: >- + Entity tag (ETag) used for optimistic concurrency control as a way + to help prevent simultaneous updates from overwriting each other. + For example, when you call + [getSyncAuthorization](organizations/getSyncAuthorization) an ETag + is returned in the response. Pass that ETag when calling the + [setSyncAuthorization](organizations/setSyncAuthorization) to ensure + that you are updating the correct version. If you don't pass the + ETag in the call to `setSyncAuthorization`, then the existing + authorization is overwritten indiscriminately. **Note**: We strongly + recommend that you use the ETag in the read-modify-write cycle to + avoid race conditions. type: string format: byte - 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. - 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). - type: integer - format: int32 - bindings: - description: >- - Associates a list of `members`, or principals, with a `role`. - Optionally, may specify a `condition` that determines how and when - the `bindings` are applied. Each of the `bindings` must contain at - least one principal. The `bindings` in a `Policy` can refer to up to - 1,500 principals; up to 250 of these principals can be Google - groups. Each occurrence of a principal counts towards these limits. - For example, if the `bindings` grant 50 different roles to - `user:alice@example.com`, and not to any other principal, then you - can add another 1,450 principals to the `bindings` in the `Policy`. - items: - $ref: '#/components/schemas/GoogleIamV1Binding' - type: array - auditConfigs: - type: array - items: - $ref: '#/components/schemas/GoogleIamV1AuditConfig' - description: Specifies cloud audit logging configuration for this policy. + GoogleCloudApigeeV1ControlPlaneAccess: + id: GoogleCloudApigeeV1ControlPlaneAccess description: >- - An Identity and Access Management (IAM) policy, which specifies access - controls for Google Cloud resources. A `Policy` is a collection of - `bindings`. A `binding` binds one or more `members`, or principals, to a - single `role`. Principals can be user accounts, service accounts, Google - groups, and domains (such as G Suite). A `role` is a named list of - permissions; each `role` can be an IAM predefined role or a user-created - custom role. For some types of Google Cloud resources, a `binding` can - also specify a `condition`, which is a logical expression that allows - access to a resource only if the expression evaluates to `true`. A - condition can add constraints based on attributes of the request, the - resource, or both. To learn which resources support conditions in their - IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - **JSON example:** ``` { "bindings": [ { "role": - "roles/resourcemanager.organizationAdmin", "members": [ - "user:mike@example.com", "group:admins@example.com", - "domain:google.com", - "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { - "role": "roles/resourcemanager.organizationViewer", "members": [ - "user:eve@example.com" ], "condition": { "title": "expirable access", - "description": "Does not grant access after Sep 2020", "expression": - "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": - "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - - members: - user:mike@example.com - group:admins@example.com - - domain:google.com - - serviceAccount:my-project-id@appspot.gserviceaccount.com role: - roles/resourcemanager.organizationAdmin - members: - - user:eve@example.com role: roles/resourcemanager.organizationViewer - condition: title: expirable access description: Does not grant access - after Sep 2020 expression: request.time < - timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` - For a description of IAM and its features, see the [IAM - documentation](https://cloud.google.com/iam/docs/). - GoogleCloudApigeeV1EnvironmentGroupConfig: - id: GoogleCloudApigeeV1EnvironmentGroupConfig + ControlPlaneAccess is the request body and response body of + UpdateControlPlaneAccess. and the response body of + GetControlPlaneAccess. The input identities contains an array of service + accounts to grant access to the respective control plane resource, with + each service account specified using the following format: + `serviceAccount:`***service-account-name***. The + ***service-account-name*** is formatted like an email address. For + example: + `my-control-plane-service_account@my_project_id.iam.gserviceaccount.com` + You might specify multiple service accounts, for example, if you have + multiple environments and wish to assign a unique service account to + each one. type: object - description: >- - EnvironmentGroupConfig is a revisioned snapshot of an EnvironmentGroup - and its associated routing rules. properties: - endpointChainingRules: - type: array - description: A list of proxies in each deployment group for proxy chaining calls. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1EndpointChainingRule' - uid: - type: string - description: >- - A unique id for the environment group config that will only change - if the environment group is deleted and recreated. - revisionId: - format: int64 - type: string - description: >- - Revision id that defines the ordering of the EnvironmentGroupConfig - resource. The higher the revision, the more recently the - configuration was deployed. name: description: >- - Name of the environment group in the following format: - `organizations/{org}/envgroups/{envgroup}`. - type: string - location: + Identifier. The resource name of the ControlPlaneAccess. Format: + "organizations/{org}/controlPlaneAccess" type: string + synchronizerIdentities: description: >- - When this message appears in the top-level IngressConfig, this field - will be populated in lieu of the inlined routing_rules and hostnames - fields. Some URL for downloading the full EnvironmentGroupConfig for - this group. - routingRules: + Optional. Array of service accounts to grant access to control plane + resources (for the Synchronizer component). The service accounts + must have **Apigee Synchronizer Manager** role. See also [Create + service + accounts](https://cloud.google.com/apigee/docs/hybrid/latest/sa-about#create-the-service-accounts). type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1RoutingRule' + type: string + analyticsPublisherIdentities: description: >- - Ordered list of routing rules defining how traffic to this - environment group's hostnames should be routed to different - environments. - hostnames: + Optional. Array of service accounts authorized to publish analytics + data to the control plane (for the Message Processor component). type: array - description: Host names for the environment group. items: type: string - GoogleApiHttpBody: - properties: - contentType: - description: >- - The HTTP Content-Type header value specifying the content type of - the body. - type: string - extensions: - description: >- - Application specific response metadata. Must be set in the first - response for streaming APIs. - items: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: array - data: - format: byte - type: string - description: The HTTP request/response body as raw binary. - description: >- - Message that represents an arbitrary HTTP body. It should only be used - for payload formats that can't be represented as JSON, such as raw - binary or an HTML page. This message can be used both in streaming and - non-streaming API methods in the request as well as the response. It can - be used as a top-level request field, which is convenient if one wants - to extract parameters from either the URL or HTTP template into the - request fields and also want access to the raw HTTP body. Example: - message GetResourceRequest { // A unique request id. string request_id = - 1; // The raw HTTP body is bound to this field. google.api.HttpBody - http_body = 2; } service ResourceService { rpc - GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc - UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } - Example with streaming methods: service CaldavService { rpc - GetCalendar(stream google.api.HttpBody) returns (stream - google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) - returns (stream google.api.HttpBody); } Use of this type only changes - how the request and response bodies are handled, all other features will - continue to work unchanged. - type: object - id: GoogleApiHttpBody - GoogleCloudApigeeV1ListDeveloperAppsResponse: + GoogleCloudApigeeV1SetAddonsRequest: + id: GoogleCloudApigeeV1SetAddonsRequest + description: Request for SetAddons. type: object properties: - app: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' - type: array - description: List of developer apps and their credentials. - id: GoogleCloudApigeeV1ListDeveloperAppsResponse - GoogleCloudApigeeV1SharedFlowRevision: + addonsConfig: + description: Required. Add-on configurations. + $ref: '#/components/schemas/GoogleCloudApigeeV1AddonsConfig' + GoogleCloudApigeeV1Reference: + id: GoogleCloudApigeeV1Reference + description: >- + A Reference configuration. References must refer to a keystore that also + exists in the parent environment. + type: object properties: - policies: - items: - type: string - description: A list of policy names included in this shared flow revision. - type: array - contextInfo: - description: A textual description of the shared flow revision. - type: string - sharedFlows: + name: description: >- - A list of the shared flow names included in this shared flow - revision. - type: array - items: - type: string - revision: + Required. The resource id of this reference. Values must match the + regular expression [\w\s\-.]+. type: string - description: The resource ID of this revision. - resources: - type: array - items: - type: string - description: >- - A list of the resources included in this shared flow revision - formatted as "{type}://{name}". description: + description: Optional. A human-readable description of this reference. type: string - description: Description of the shared flow revision. - lastModifiedAt: + resourceType: + description: >- + The type of resource referred to by this reference. Valid values are + 'KeyStore' or 'TrustStore'. type: string + refers: description: >- - Time at which this shared flow revision was most recently modified, - in milliseconds since epoch. - format: int64 - displayName: - description: The human readable name of this shared flow. + Required. The id of the resource to which this reference refers. + Must be the id of a resource that exists in the parent environment + and is of the given resource_type. type: string - entityMetaDataAsProperties: - description: A Key-Value map of metadata about this shared flow revision. - additionalProperties: - type: string - type: object + GoogleCloudApigeeV1IngressConfig: + id: GoogleCloudApigeeV1IngressConfig + type: object + properties: name: - description: The resource ID of the parent shared flow. + description: >- + Name of the resource in the following format: + `organizations/{org}/deployedIngressConfig`. type: string - type: - description: The string "Application" + uid: + description: >- + A unique id for the ingress config that will only change if the + organization is deleted and recreated. type: string - resourceFiles: - $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFiles' - description: The resource files included in this shared flow revision. - createdAt: + revisionId: description: >- - Time at which this shared flow revision was created, in milliseconds - since epoch. + Revision id that defines the ordering on IngressConfig resources. + The higher the revision, the more recently the configuration was + deployed. + type: string format: int64 + revisionCreateTime: + description: Time at which the IngressConfig revision was created. type: string - configurationVersion: - $ref: '#/components/schemas/GoogleCloudApigeeV1ConfigVersion' - description: >- - The version of the configuration schema to which this shared flow - conforms. The only supported value currently is majorVersion 4 and - minorVersion 0. This setting may be used in the future to enable - evolution of the shared flow format. - id: GoogleCloudApigeeV1SharedFlowRevision - description: The metadata describing a shared flow revision. - type: object - GoogleCloudApigeeV1Keystore: - id: GoogleCloudApigeeV1Keystore - properties: - aliases: + format: google-datetime + environmentGroups: + description: List of environment groups in the organization. type: array - description: Output only. Aliases in this keystore. - readOnly: true items: - type: string + $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroupConfig' + GoogleCloudApigeeV1EnvironmentGroupConfig: + id: GoogleCloudApigeeV1EnvironmentGroupConfig + description: >- + EnvironmentGroupConfig is a revisioned snapshot of an EnvironmentGroup + and its associated routing rules. + type: object + properties: name: description: >- - Required. Resource ID for this keystore. Values must match the - regular expression `[\w[:space:].-]{1,255}`. + Name of the environment group in the following format: + `organizations/{org}/envgroups/{envgroup}`. type: string - type: object - description: Datastore for Certificates and Aliases. - GoogleCloudApigeeV1InstanceDeploymentStatus: - type: object - description: The status of a deployment as reported by a single instance. - id: GoogleCloudApigeeV1InstanceDeploymentStatus - properties: - deployedRoutes: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRoute + uid: description: >- - Current routes deployed in the ingress routing table. A route which - is missing will appear in `missing_routes`. - instance: - description: ID of the instance reporting the status. + A unique id for the environment group config that will only change + if the environment group is deleted and recreated. type: string - deployedRevisions: - description: Revisions currently deployed in MPs. + revisionId: + description: >- + Revision id that defines the ordering of the EnvironmentGroupConfig + resource. The higher the revision, the more recently the + configuration was deployed. + type: string + format: int64 + hostnames: + description: Host names for the environment group. type: array items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRevision - GoogleCloudApigeeV1Schema: - type: object - description: Response for Schema call - properties: - metrics: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SchemaSchemaElement' - type: array + type: string + routingRules: description: >- - List of schema fields grouped as dimensions that can be used with an - aggregate function such as `sum`, `avg`, `min`, and `max`. - dimensions: - description: List of schema fields grouped as dimensions. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SchemaSchemaElement' - type: array - meta: + Ordered list of routing rules defining how traffic to this + environment group's hostnames should be routed to different + environments. type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1RoutingRule' + location: description: >- - Additional metadata associated with schema. This is a legacy field - and usually consists of an empty array of strings. + When this message appears in the top-level IngressConfig, this field + will be populated in lieu of the inlined routing_rules and hostnames + fields. Some URL for downloading the full EnvironmentGroupConfig for + this group. + type: string + endpointChainingRules: + description: A list of proxies in each deployment group for proxy chaining calls. + type: array items: - type: string - id: GoogleCloudApigeeV1Schema - GoogleCloudApigeeV1ApiProduct: - id: GoogleCloudApigeeV1ApiProduct + $ref: '#/components/schemas/GoogleCloudApigeeV1EndpointChainingRule' + GoogleCloudApigeeV1RoutingRule: + id: GoogleCloudApigeeV1RoutingRule type: object properties: - displayName: + basepath: + description: >- + URI path prefix used to route to the specified environment. May + contain one or more wildcards. For example, path segments consisting + of a single `*` character will match any string. type: string + environment: description: >- - Name displayed in the UI or developer portal to developers - registering for API access. - graphqlOperationGroup: - $ref: '#/components/schemas/GoogleCloudApigeeV1GraphQLOperationGroup' + Name of an environment bound to the environment group in the + following format: `organizations/{org}/environments/{env}`. Only one + of environment or deployment_group will be set. + type: string + deploymentGroup: description: >- - Configuration used to group Apigee proxies or remote services with - graphQL operation name, graphQL operation type and quotas. This - grouping allows us to precisely set quota for a particular - combination of graphQL name and operation type for a particular - proxy request. If graphQL name is not set, this would imply quota - will be applied on all graphQL requests matching the operation type. - proxies: - type: array + Name of a deployment group in an environment bound to the + environment group in the following format: + `organizations/{org}/environment/{env}/deploymentGroups/{group}` + Only one of environment or deployment_group will be set. + type: string + otherTargets: description: >- - Comma-separated list of API proxy names to which this API product is - bound. By specifying API proxies, you can associate resources in the - API product with specific API proxies, preventing developers from - accessing those resources through other API proxies. Apigee rejects - requests to API proxies that are not listed. **Note:** The API proxy - names must already exist in the specified environment as they will - be validated upon creation. + Conflicting targets, which will be resource names specifying either + deployment groups or environments. + type: array items: type: string - approvalType: + envGroupRevision: description: >- - Flag that specifies how API keys are approved to access the APIs - defined by the API product. If set to `manual`, the consumer key is - generated and returned in "pending" state. In this case, the API - keys won't work until they have been explicitly approved. If set to - `auto`, the consumer key is generated and returned in "approved" - state and can be used immediately. **Note:** Typically, `auto` is - used to provide access to free or trial API products that provide - limited quota or capabilities. + The env group config revision_id when this rule was added or last + updated. This value is set when the rule is created and will only + update if the the environment_id changes. It is used to determine if + the runtime is up to date with respect to this rule. This field is + omitted from the IngressConfig unless the GetDeployedIngressConfig + API is called with view=FULL. type: string - quotaTimeUnit: + format: int64 + updateTime: description: >- - Time unit defined for the `quotaInterval`. Valid values include - `minute`, `hour`, `day`, or `month`. + The unix timestamp when this rule was updated. This is updated + whenever env_group_revision is updated. This field is omitted from + the IngressConfig unless the GetDeployedIngressConfig API is called + with view=FULL. type: string - environments: - items: - type: string - type: array + format: google-datetime + receiver: description: >- - Comma-separated list of environment names to which the API product - is bound. Requests to environments that are not listed are rejected. - By specifying one or more environments, you can bind the resources - listed in the API product to a specific environment, preventing - developers from accessing those resources through API proxies - deployed in another environment. This setting is used, for example, - to prevent resources associated with API proxies in `prod` from - being accessed by API proxies deployed in `test`. - lastModifiedAt: + The resource name of the proxy revision that is receiving this + basepath in the following format: + `organizations/{org}/apis/{api}/revisions/{rev}`. This field is + omitted from the IngressConfig unless the GetDeployedIngressConfig + API is called with view=FULL. type: string + GoogleCloudApigeeV1EndpointChainingRule: + id: GoogleCloudApigeeV1EndpointChainingRule + description: >- + EndpointChainingRule specifies the proxies contained in a particular + deployment group, so that other deployment groups can find them in + chaining calls. + type: object + properties: + proxyIds: + description: List of proxy ids which may be found in the given deployment group. + type: array + items: + type: string + deploymentGroup: description: >- - Response only. Modified time of this environment as milliseconds - since epoch. - format: int64 - createdAt: + The deployment group to target for cross-shard chaining calls to + these proxies. type: string + GoogleCloudApigeeV1ReportInstanceStatusRequest: + id: GoogleCloudApigeeV1ReportInstanceStatusRequest + description: Request for ReportInstanceStatus. + type: object + properties: + instanceUid: description: >- - Response only. Creation time of this environment as milliseconds - since epoch. - format: int64 - quota: + A unique ID for the instance which is guaranteed to be unique in + case the user installs multiple hybrid runtimes with the same + instance ID. type: string + reportTime: description: >- - Number of request messages permitted per app by this API product for - the specified `quotaInterval` and `quotaTimeUnit`. For example, a - `quota` of 50, for a `quotaInterval` of 12 and a `quotaTimeUnit` of - hours means 50 requests are allowed every 12 hours. - quotaCounterScope: - enum: - - QUOTA_COUNTER_SCOPE_UNSPECIFIED - - PROXY - - OPERATION + The time the report was generated in the runtime. Used to prevent an + old status from overwriting a newer one. An instance should space + out it's status reports so that clock skew does not play a factor. type: string - enumDescriptions: - - >- - When quota is not explicitly defined for each - operation(REST/GraphQL), the limits set at product level will be - used as a local counter for quota evaluation by all the - operations, independent of proxy association. - - >- - When quota is not explicitly defined for each - operation(REST/GraphQL), set at product level will be used as a - global counter for quota evaluation by all the operations - associated with a particular proxy. - - >- - When quota is not explicitly defined for each - operation(REST/GraphQL), the limits set at product level will be - used as a local counter for quota evaluation by all the - operations, independent of proxy association. This behavior mimics - the same as QUOTA_COUNTER_SCOPE_UNSPECIFIED. - description: >- - Scope of the quota decides how the quota counter gets applied and - evaluate for quota violation. If the Scope is set as PROXY, then all - the operations defined for the APIproduct that are associated with - the same proxy will share the same quota counter set at the - APIproduct level, making it a global counter at a proxy level. If - the Scope is set as OPERATION, then each operations get the counter - set at the API product dedicated, making it a local counter. Note - that, the QuotaCounterScope applies only when an operation does not - have dedicated quota set for itself. - operationGroup: - $ref: '#/components/schemas/GoogleCloudApigeeV1OperationGroup' - description: >- - Configuration used to group Apigee proxies or remote services with - resources, method types, and quotas. The resource refers to the - resource URI (excluding the base path). With this grouping, the API - product creator is able to fine-tune and give precise control over - which REST methods have access to specific resources and how many - calls can be made (using the `quota` setting). **Note:** The - `api_resources` setting cannot be specified for both the API product - and operation group; otherwise the call will fail. - grpcOperationGroup: - $ref: '#/components/schemas/GoogleCloudApigeeV1GrpcOperationGroup' + format: google-datetime + resources: + description: Status for config resources + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceStatus' + GoogleCloudApigeeV1ResourceStatus: + id: GoogleCloudApigeeV1ResourceStatus + description: The status of a resource loaded in the runtime. + type: object + properties: + resource: description: >- - Optional. Configuration used to group Apigee proxies with gRPC - services and method names. This grouping allows us to set quota for - a particular proxy with the gRPC service name and method. If a - method name is not set, this implies quota and authorization are - applied to all gRPC methods implemented by that proxy for that - particular gRPC service. - name: + The resource name. Currently only two resources are supported: + EnvironmentGroup - organizations/{org}/envgroups/{envgroup} + EnvironmentConfig - + organizations/{org}/environments/{environment}/deployedConfig type: string + uid: description: >- - Internal name of the API product. Characters you can use in the name - are restricted to: `A-Z0-9._\-$ %`. **Note:** The internal name - cannot be edited when updating the API product. - quotaInterval: - description: >- - Time interval over which the number of request messages is - calculated. + The uid of the resource. In the unexpected case that the instance + has multiple uids for the same name, they should be reported under + separate ResourceStatuses. type: string - attributes: - description: >- - Array of attributes that may be used to extend the default API - product profile with customer-specific metadata. You can specify a - maximum of 18 attributes. Use this property to specify the access - level of the API product as either `public`, `private`, or - `internal`. Only products marked `public` are available to - developers in the Apigee developer portal. For example, you can set - a product to `internal` while it is in development and then change - access to `public` when it is ready to release on the portal. API - products marked as `private` do not appear on the portal, but can be - accessed by external developers. + totalReplicas: + description: The total number of replicas that should have this resource. + type: integer + format: int32 + revisions: + description: Revisions of the resource currently deployed in the instance. type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - apiResources: + $ref: '#/components/schemas/GoogleCloudApigeeV1RevisionStatus' + GoogleCloudApigeeV1RevisionStatus: + id: GoogleCloudApigeeV1RevisionStatus + description: The status of a specific resource revision. + type: object + properties: + revisionId: + description: The revision of the resource. + type: string + replicas: + description: The number of replicas that have successfully loaded this revision. + type: integer + format: int32 + errors: + description: Errors reported when attempting to load this revision. type: array items: - type: string - description: >- - Comma-separated list of API resources to be bundled in the API - product. By default, the resource paths are mapped from the - `proxy.pathsuffix` variable. The proxy path suffix is defined as the - URI fragment following the ProxyEndpoint base path. For example, if - the `apiResources` element is defined to be `/forecastrss` and the - base path defined for the API proxy is `/weather`, then only - requests to `/weather/forecastrss` are permitted by the API product. - You can select a specific path, or you can select all subpaths with - the following wildcard: - `/**`: Indicates that all sub-URIs are - included. - `/*` : Indicates that only URIs one level down are - included. By default, / supports the same resources as /** as well - as the base path defined by the API proxy. For example, if the base - path of the API proxy is `/v1/weatherapikey`, then the API product - supports requests to `/v1/weatherapikey` and to any sub-URIs, such - as `/v1/weatherapikey/forecastrss`, `/v1/weatherapikey/region/CA`, - and so on. For more information, see Managing API products. - scopes: - type: array + $ref: '#/components/schemas/GoogleCloudApigeeV1UpdateError' + jsonSpec: description: >- - Comma-separated list of OAuth scopes that are validated at runtime. - Apigee validates that the scopes in any access token presented match - the scopes defined in the OAuth policy associated with the API - product. - items: - type: string - description: + The json content of the resource revision. Large specs should be + sent individually via the spec field to avoid hitting request size + limits. type: string - description: >- - Description of the API product. Include key information about the - API product that is not captured by other fields. - GoogleCloudApigeeV1QueryTimeSeriesStatsRequest: - id: GoogleCloudApigeeV1QueryTimeSeriesStatsRequest - description: >- - QueryTimeSeriesStatsRequest represents a query that returns a collection - of time series sequences grouped by their values. + GoogleCloudApigeeV1UpdateError: + id: GoogleCloudApigeeV1UpdateError + description: Details on why a resource update failed in the runtime. type: object properties: - filter: - type: string - description: >- - Filter further on specific dimension values. Follows the same - grammar as custom report's filter expressions. Example, apiproxy eq - 'foobar'. - https://cloud.google.com/apigee/docs/api-platform/analytics/analytics-reference#filters - windowSize: - enum: - - WINDOW_SIZE_UNSPECIFIED - - MINUTE - - HOUR - - DAY - - MONTH - enumDescriptions: - - Unspecified window size. Default is 1 hour. - - 1 Minute window - - 1 Hour window - - 1 Day window - - 1 Month window - type: string - description: Time buckets to group the stats by. - pageToken: - description: >- - Page token stands for a specific collection of time series - sequences. - type: string - pageSize: - description: >- - Page size represents the number of time series sequences, one per - unique set of dimensions and their values. - type: integer - format: int32 - metrics: - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1MetricAggregation' - description: Required. List of metrics and their aggregations. - dimensions: - type: array - items: - type: string + resource: description: >- - List of dimension names to group the aggregations by. If no - dimensions are passed, a single trend line representing the - requested metric aggregations grouped by environment is returned. - timestampOrder: + The sub resource specific to this error (e.g. a proxy deployed + within the EnvironmentConfig). If empty the error refers to the top + level resource. type: string - enumDescriptions: - - Unspecified order. Default is Descending. - - Ascending sort order. - - Descending sort order. - enum: - - ORDER_UNSPECIFIED - - ASCENDING - - DESCENDING + type: description: >- - Order the sequences in increasing or decreasing order of timestamps. - Default is descending order of timestamps (latest first). - timeRange: - description: Required. Time range for the stats. - $ref: '#/components/schemas/GoogleTypeInterval' - GoogleLongrunningListOperationsResponse: - id: GoogleLongrunningListOperationsResponse - type: object - properties: - nextPageToken: + A string that uniquely identifies the type of error. This provides a + more reliable means to deduplicate errors across revisions and + instances. type: string - description: The standard List next-page token. - operations: - type: array - items: - $ref: '#/components/schemas/GoogleLongrunningOperation' - description: >- - A list of operations that matches the specified filter in the - request. - description: The response message for Operations.ListOperations. - GoogleCloudApigeeV1OperationMetadataProgress: - properties: - details: - additionalProperties: - type: any - description: Properties of the object. - type: object - description: The additional details of the progress. - description: + code: + description: Status code. type: string - description: Description of the operation's progress. - percentDone: - description: The percentage of the operation progress. - type: integer - format: int32 - state: enumDescriptions: - - '' - - '' - - '' - - '' - description: State of the operation. + - 'Not an error; returned on success. HTTP Mapping: 200 OK' + - >- + The operation was cancelled, typically by the caller. HTTP + Mapping: 499 Client Closed Request + - >- + Unknown error. For example, this error may be returned when a + `Status` value received from another address space belongs to an + error space that is not known in this address space. Also errors + raised by APIs that do not return enough error information may be + converted to this error. HTTP Mapping: 500 Internal Server Error + - >- + The client specified an invalid argument. Note that this differs + from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments + that are problematic regardless of the state of the system (e.g., + a malformed file name). HTTP Mapping: 400 Bad Request + - >- + The deadline expired before the operation could complete. For + operations that change the state of the system, this error may be + returned even if the operation has completed successfully. For + example, a successful response from a server could have been + delayed long enough for the deadline to expire. HTTP Mapping: 504 + Gateway Timeout + - >- + Some requested entity (e.g., file or directory) was not found. + Note to server developers: if a request is denied for an entire + class of users, such as gradual feature rollout or undocumented + allowlist, `NOT_FOUND` may be used. If a request is denied for + some users within a class of users, such as user-based access + control, `PERMISSION_DENIED` must be used. HTTP Mapping: 404 Not + Found + - >- + The entity that a client attempted to create (e.g., file or + directory) already exists. HTTP Mapping: 409 Conflict + - >- + The caller does not have permission to execute the specified + operation. `PERMISSION_DENIED` must not be used for rejections + caused by exhausting some resource (use `RESOURCE_EXHAUSTED` + instead for those errors). `PERMISSION_DENIED` must not be used if + the caller can not be identified (use `UNAUTHENTICATED` instead + for those errors). This error code does not imply the request is + valid or the requested entity exists or satisfies other + pre-conditions. HTTP Mapping: 403 Forbidden + - >- + The request does not have valid authentication credentials for the + operation. HTTP Mapping: 401 Unauthorized + - >- + Some resource has been exhausted, perhaps a per-user quota, or + perhaps the entire file system is out of space. HTTP Mapping: 429 + Too Many Requests + - >- + The operation was rejected because the system is not in a state + required for the operation's execution. For example, the directory + to be deleted is non-empty, an rmdir operation is applied to a + non-directory, etc. Service implementors can use the following + guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and + `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just + the failing call. (b) Use `ABORTED` if the client should retry at + a higher level. For example, when a client-specified test-and-set + fails, indicating the client should restart a read-modify-write + sequence. (c) Use `FAILED_PRECONDITION` if the client should not + retry until the system state has been explicitly fixed. For + example, if an "rmdir" fails because the directory is non-empty, + `FAILED_PRECONDITION` should be returned since the client should + not retry unless the files are deleted from the directory. HTTP + Mapping: 400 Bad Request + - >- + The operation was aborted, typically due to a concurrency issue + such as a sequencer check failure or transaction abort. See the + guidelines above for deciding between `FAILED_PRECONDITION`, + `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 409 Conflict + - >- + The operation was attempted past the valid range. E.g., seeking or + reading past end-of-file. Unlike `INVALID_ARGUMENT`, this error + indicates a problem that may be fixed if the system state changes. + For example, a 32-bit file system will generate `INVALID_ARGUMENT` + if asked to read at an offset that is not in the range [0,2^32-1], + but it will generate `OUT_OF_RANGE` if asked to read from an + offset past the current file size. There is a fair bit of overlap + between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We recommend + using `OUT_OF_RANGE` (the more specific error) when it applies so + that callers who are iterating through a space can easily look for + an `OUT_OF_RANGE` error to detect when they are done. HTTP + Mapping: 400 Bad Request + - >- + The operation is not implemented or is not supported/enabled in + this service. HTTP Mapping: 501 Not Implemented + - >- + Internal errors. This means that some invariants expected by the + underlying system have been broken. This error code is reserved + for serious errors. HTTP Mapping: 500 Internal Server Error + - >- + The service is currently unavailable. This is most likely a + transient condition, which can be corrected by retrying with a + backoff. Note that it is not always safe to retry non-idempotent + operations. See the guidelines above for deciding between + `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: + 503 Service Unavailable + - >- + Unrecoverable data loss or corruption. HTTP Mapping: 500 Internal + Server Error enum: - - STATE_UNSPECIFIED - - NOT_STARTED - - IN_PROGRESS - - FINISHED + - OK + - CANCELLED + - UNKNOWN + - INVALID_ARGUMENT + - DEADLINE_EXCEEDED + - NOT_FOUND + - ALREADY_EXISTS + - PERMISSION_DENIED + - UNAUTHENTICATED + - RESOURCE_EXHAUSTED + - FAILED_PRECONDITION + - ABORTED + - OUT_OF_RANGE + - UNIMPLEMENTED + - INTERNAL + - UNAVAILABLE + - DATA_LOSS + message: + description: User-friendly error message. type: string - id: GoogleCloudApigeeV1OperationMetadataProgress - description: Information about operation progress. + GoogleCloudApigeeV1ReportInstanceStatusResponse: + id: GoogleCloudApigeeV1ReportInstanceStatusResponse + description: Placeholder for future enhancements to status reporting protocol type: object - GoogleCloudApigeeV1SecurityProfileEnvironment: + properties: {} + GoogleCloudApigeeV1CanaryEvaluation: + id: GoogleCloudApigeeV1CanaryEvaluation description: >- - Environment information of attached environments. Scoring an environment - is enabled only if it is attached to a security profile. + CanaryEvaluation represents the canary analysis between two versions of + the runtime that is serving requests. type: object properties: - attachTime: + name: + description: Output only. Name of the canary evalution. + readOnly: true type: string - format: google-datetime + createTime: + description: Output only. Create time of the canary evaluation. readOnly: true - description: >- - Output only. Time at which environment was attached to the security - profile. - environment: + type: string + format: google-datetime + startTime: + description: Required. Start time for the canary evaluation's analysis. + type: string + format: google-datetime + endTime: + description: Required. End time for the evaluation's analysis. + type: string + format: google-datetime + metricLabels: + description: >- + Required. Labels used to filter the metrics used for a canary + evaluation. + $ref: '#/components/schemas/GoogleCloudApigeeV1CanaryEvaluationMetricLabels' + control: + description: Required. The stable version that is serving requests. + type: string + treatment: + description: Required. The newer version that is serving requests. + type: string + verdict: + description: >- + Output only. The resulting verdict of the canary evaluations: NONE, + PASS, or FAIL. readOnly: true type: string - description: Output only. Name of the environment. - id: GoogleCloudApigeeV1SecurityProfileEnvironment - GoogleCloudApigeeV1Metadata: + enumDescriptions: + - Verdict is not available yet. + - No verdict reached. + - Evaluation is not good. + - Evaluation is good. + enum: + - VERDICT_UNSPECIFIED + - NONE + - FAIL + - PASS + state: + description: Output only. The current state of the canary evaluation. + readOnly: true + type: string + enumDescriptions: + - No state has been specified. + - The canary evaluation is still in progress. + - The canary evaluation has finished. + enum: + - STATE_UNSPECIFIED + - RUNNING + - SUCCEEDED + GoogleCloudApigeeV1CanaryEvaluationMetricLabels: + id: GoogleCloudApigeeV1CanaryEvaluationMetricLabels + description: Labels that can be used to filter Apigee metrics. + type: object properties: - notices: - items: - type: string - type: array + env: + description: The environment ID associated with the metrics. + type: string + location: + description: Required. The location associated with the metrics. + type: string + instance_id: description: >- - List of additional information such as data source, if result was - truncated. For example: ``` "notices": [ "Source:Postgres", "PG - Host:uappg0rw.e2e.apigeeks.net", "query served - by:4b64601e-40de-4eb1-bfb9-eeee7ac929ed", "Table used: - edge.api.uapgroup2.agg_api" ]``` - errors: - items: - type: string - type: array - description: List of error messages as strings. - id: GoogleCloudApigeeV1Metadata - description: Encapsulates additional information about query execution. - type: object - GoogleCloudApigeeV1SecurityActionsConfig: - id: GoogleCloudApigeeV1SecurityActionsConfig + Required. The instance ID associated with the metrics. In Apigee + Hybrid, the value is configured during installation. + type: string + GoogleCloudApigeeV1RuntimeConfig: + id: GoogleCloudApigeeV1RuntimeConfig description: >- - SecurityActionsConfig reflects the current state of the SecurityActions - feature. This is a singleton resource: https://google.aip.dev/156 + Runtime configuration for the organization. Response for + GetRuntimeConfig. + type: object properties: name: + description: >- + Name of the resource in the following format: + `organizations/{org}/runtimeConfig`. + type: string + analyticsBucket: + description: Cloud Storage bucket used for uploading Analytics records. + type: string + traceBucket: + description: Cloud Storage bucket used for uploading Trace records. type: string + tenantProjectId: description: >- - This is a singleton resource, the name will always be set by - SecurityActions and any user input will be ignored. The name is - always: - `organizations/{org}/environments/{env}/security_actions_config` - updateTime: + Output only. Tenant project ID associated with the Apigee + organization. The tenant project is used to host Google-managed + resources that are dedicated to this Apigee organization. Clients + have limited access to resources within the tenant project used to + support Apigee runtime instances. Access to the tenant project is + managed using SetSyncAuthorization. It can be empty if the tenant + project hasn't been created yet. readOnly: true type: string - format: google-datetime - description: Output only. The update time for configuration. - enabled: - type: boolean + GoogleCloudApigeeV1ListSharedFlowsResponse: + id: GoogleCloudApigeeV1ListSharedFlowsResponse + type: object + properties: + sharedFlows: + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlow' + GoogleCloudApigeeV1SharedFlow: + id: GoogleCloudApigeeV1SharedFlow + description: The metadata describing a shared flow + type: object + properties: + metaData: + description: Metadata describing the shared flow. + $ref: '#/components/schemas/GoogleCloudApigeeV1EntityMetadata' + name: + description: The ID of the shared flow. + type: string + revision: + description: A list of revisions of this shared flow. + type: array + items: + type: string + latestRevisionId: + description: The id of the most recently created revision for this shared flow. + type: string + space: description: >- - The flag that controls whether this feature is enabled. This is - `unset` by default. When this flag is `false`, even if individual - rules are enabled, no SecurityActions will be enforced. + Optional. The ID of the space associated with this shared flow. Any + IAM policies applied to the space will control access to this shared + flow. To learn how Spaces can be used to manage resources, read the + [Apigee Spaces + Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview). + type: string + GoogleCloudApigeeV1SharedFlowRevision: + id: GoogleCloudApigeeV1SharedFlowRevision + description: The metadata describing a shared flow revision. type: object - GoogleCloudApigeeV1AppGroupAppKey: - id: GoogleCloudApigeeV1AppGroupAppKey properties: - consumerKey: - description: Immutable. Consumer key. + configurationVersion: + description: >- + The version of the configuration schema to which this shared flow + conforms. The only supported value currently is majorVersion 4 and + minorVersion 0. This setting may be used in the future to enable + evolution of the shared flow format. + $ref: '#/components/schemas/GoogleCloudApigeeV1ConfigVersion' + contextInfo: + description: A textual description of the shared flow revision. type: string - issuedAt: + createdAt: description: >- - Output only. Time the AppGroup app was created in milliseconds since - epoch. + Time at which this shared flow revision was created, in milliseconds + since epoch. + type: string format: int64 - readOnly: true + displayName: + description: The human readable name of this shared flow. type: string - attributes: + description: + description: Description of the shared flow revision. + type: string + entityMetaDataAsProperties: + description: A Key-Value map of metadata about this shared flow revision. + type: object + additionalProperties: + type: string + lastModifiedAt: + description: >- + Time at which this shared flow revision was most recently modified, + in milliseconds since epoch. + type: string + format: int64 + revision: + description: The resource ID of this revision. + type: string + name: + description: The resource ID of the parent shared flow. + type: string + policies: + description: A list of policy names included in this shared flow revision. type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - description: List of attributes associated with the credential. - apiProducts: - type: array - readOnly: true + type: string + resourceFiles: + description: The resource files included in this shared flow revision. + $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFiles' + resources: description: >- - Output only. List of API products and its status for which the - credential can be used. **Note**: Use - UpdateAppGroupAppKeyApiProductRequest API to make the association - after the consumer key and secret are created. + A list of the resources included in this shared flow revision + formatted as "{type}://{name}". + type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1APIProductAssociation' - expiresInSeconds: + type: string + sharedFlows: description: >- - Immutable. Expiration time, in seconds, for the consumer key. If not - set or left to the default value of `-1`, the API key never expires. - The expiration time can't be updated after it is set. - format: int64 - type: string - scopes: + A list of the shared flow names included in this shared flow + revision. + type: array items: type: string + type: + description: The string "Application" + type: string + GoogleCloudApigeeV1MoveSharedFlowRequest: + id: GoogleCloudApigeeV1MoveSharedFlowRequest + description: Moves a Shared Flow to a different space. + type: object + properties: + space: description: >- - Scopes to apply to the app. The specified scope names must already - be defined for the API product that you associate with the app. - type: array - status: + Optional. Resource ID of the space to move the shared flow to. If + unspecified, the shared flow will be moved to the organization + level. + type: string + GoogleCloudApigeeV1Space: + id: GoogleCloudApigeeV1Space + description: Organization space resource. + type: object + properties: + name: description: >- - Status of the credential. Valid values include `approved` or - `revoked`. + Output only. Identifier. Id of the space. This field is used as the + resource name, and must follow [AIP-122](https://google.aip.dev/122) + guidelines. + readOnly: true type: string - consumerSecret: + displayName: + description: Optional. Display name of the space. type: string - description: Secret key. - expiresAt: + createTime: + description: Output only. Create timestamp of the space. readOnly: true type: string - format: int64 - description: >- - Output only. Time the AppGroup app expires in milliseconds since - epoch. - type: object - description: >- - AppGroupAppKey contains all the information associated with the - credentials. - GoogleCloudApigeeV1DeploymentChangeReportRoutingChange: - properties: - fromDeployment: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment - description: Base path/deployment that may stop receiving some traffic. - description: - description: Human-readable description of this routing change. + format: google-datetime + updateTime: + description: Output only. Last modified timestamp of the space. + readOnly: true type: string - toDeployment: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment - description: >- - Base path/deployment that may start receiving that traffic. May be - null if no deployment is able to receive the traffic. - shouldSequenceRollout: - type: boolean + format: google-datetime + GoogleCloudApigeeV1ListSpacesResponse: + id: GoogleCloudApigeeV1ListSpacesResponse + description: >- + A response to a ListSpaces request containing the list of organization + spaces and a page token for the next page. + type: object + properties: + spaces: + description: List of Apigee organization spaces. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Space' + nextPageToken: description: >- - Set to `true` if using sequenced rollout would make this routing - change safer. **Note**: This does not necessarily imply that - automated sequenced rollout mode is supported for the operation. - environmentGroup: - description: Name of the environment group affected by this routing change. + A token that can be sent as `page_token` to retrieve the next page. + If this field is omitted, there are no subsequent pages. type: string + GoogleCloudApigeeV1TraceConfigOverride: + id: GoogleCloudApigeeV1TraceConfigOverride + description: A representation of a configuration override. type: object - description: >- - Describes a potential routing change that may occur as a result of some - deployment operation. - id: GoogleCloudApigeeV1DeploymentChangeReportRoutingChange - GoogleCloudApigeeV1ProfileConfigMediation: - id: GoogleCloudApigeeV1ProfileConfigMediation - type: object - description: >- - By default, following policies will be included: - OASValidation - - SOAPMessageValidation - properties: {} - GoogleCloudApigeeV1ResourceFile: - description: Metadata about a resource file. - id: GoogleCloudApigeeV1ResourceFile properties: name: + description: >- + ID of the trace configuration override specified as a + system-generated UUID. type: string - description: ID of the resource file. - type: + apiProxy: + description: >- + ID of the API proxy that will have its trace configuration + overridden. type: string - description: Resource file type. {{ resource_file_type }} - type: object - GoogleCloudApigeeV1GraphQLOperationGroup: - description: >- - List of graphQL operation configuration details associated with Apigee - API proxies or remote services. Remote services are non-Apigee proxies, - such as Istio-Envoy. - id: GoogleCloudApigeeV1GraphQLOperationGroup + samplingConfig: + description: Trace configuration to override. + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceSamplingConfig' + GoogleCloudApigeeV1ListTraceConfigOverridesResponse: + id: GoogleCloudApigeeV1ListTraceConfigOverridesResponse + description: Response for ListTraceConfigOverrides. type: object properties: - operationConfigType: + traceConfigOverrides: + description: List all trace configuration overrides in an environment. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' + nextPageToken: description: >- - Flag that specifies whether the configuration is for Apigee API - proxy or a remote service. Valid values include `proxy` or - `remoteservice`. Defaults to `proxy`. Set to `proxy` when Apigee API - proxies are associated with the API product. Set to `remoteservice` - when non-Apigee proxies like Istio-Envoy are associated with the API - product. + Token value that can be passed as `page_token` to retrieve the next + page of content. type: string - operationConfigs: + GoogleCloudApigeeV1Stats: + id: GoogleCloudApigeeV1Stats + description: Encapsulates a `stats` response. + type: object + properties: + environments: + description: List of query results on the environment level. type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1GraphQLOperationConfig' - description: >- - Required. List of operation configurations for either Apigee API - proxies or other remote services that are associated with this API - product. - GoogleCloudApigeeV1SecurityIncident: - id: GoogleCloudApigeeV1SecurityIncident + $ref: '#/components/schemas/GoogleCloudApigeeV1StatsEnvironmentStats' + hosts: + description: List of query results grouped by host. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1StatsHostStats' + metaData: + description: Metadata information. + $ref: '#/components/schemas/GoogleCloudApigeeV1Metadata' + GoogleCloudApigeeV1StatsEnvironmentStats: + id: GoogleCloudApigeeV1StatsEnvironmentStats + description: >- + Encapsulates the environment wrapper: ``` "environments": [ { "metrics": + [ { "name": "sum(message_count)", "values": [ "2.52056245E8" ] } ], + "name": "prod" } ]``` + type: object properties: name: + description: Name of the environment. type: string + metrics: description: >- - Immutable. Name of the security incident resource. Format: - organizations/{org}/environments/{environment}/securityIncidents/{incident} - Example: - organizations/apigee-org/environments/dev/securityIncidents/1234-5678-9101-1111 - displayName: - type: string - description: Optional. Display name of the security incident. - riskLevel: - enum: - - RISK_LEVEL_UNSPECIFIED - - LOW - - MODERATE - - SEVERE - type: string - enumDescriptions: - - Risk Level Unspecified. - - Risk level of the incident is low. - - Risk level of the incident is moderate. - - Risk level of the incident is severe. - description: Output only. Risk level of the incident. - readOnly: true - trafficCount: - format: int64 - description: Total traffic detected as part of the incident. - type: string - observability: - enum: - - OBSERVABILITY_UNSPECIFIED - - ACTIVE - - ARCHIVED - enumDescriptions: - - The incident observability is unspecified. - - >- - The incident is currently active. Can change to this status from - archived. - - >- - The incident is currently archived and was archived by the - customer. - type: string - description: Optional. Indicates if the user archived this incident. - firstDetectedTime: + In the final response, only one of the following fields will be + present based on the dimensions provided. If no dimensions are + provided, then only top-level metrics is provided. If dimensions are + included, then there will be a top-level dimensions field under + environments which will contain metrics values and the dimension + name. Example: ``` "environments": [ { "dimensions": [ { "metrics": + [ { "name": "sum(message_count)", "values": [ "2.14049521E8" ] } ], + "name": "nit_proxy" } ], "name": "prod" } ]``` or ```"environments": + [ { "metrics": [ { "name": "sum(message_count)", "values": [ + "2.19026331E8" ] } ], "name": "prod" } ]``` List of metric values. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Metric' + dimensions: + description: List of metrics grouped under dimensions. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1DimensionMetric' + GoogleCloudApigeeV1Metric: + id: GoogleCloudApigeeV1Metric + description: >- + Encapsulates the metric data point. For example: ```{ "name": + "sum(message_count)", "values" : [ { "timestamp": 1549004400000, + "value": "39.0" }, { "timestamp" : 1548997200000, "value" : "0.0" } ] + }``` or ```{ "name": "sum(message_count)", "values" : ["39.0"] }``` + type: object + properties: + name: + description: Metric name. type: string - format: google-datetime - readOnly: true + values: description: >- - Output only. The time when events associated with the incident were - first detected. - lastObservabilityChangeTime: + List of metric values. Possible value formats include: + `"values":["39.0"]` or `"values":[ { "value": "39.0", "timestamp": + 1232434354} ]` + type: array + items: + type: any + GoogleCloudApigeeV1DimensionMetric: + id: GoogleCloudApigeeV1DimensionMetric + description: Encapsulates a metric grouped by dimension. + type: object + properties: + name: description: >- - Output only. The time when the incident observability was last - changed. + Comma joined dimension names. E.g. "dim1_name,dim2_name". + Deprecated. If name already has comma before join, we may get wrong + splits. Please use individual_names. + deprecated: true type: string - readOnly: true - format: google-datetime - detectionTypes: - description: >- - Output only. Detection types which are part of the incident. - Examples: Flooder, OAuth Abuser, Static Content Scraper, Anomaly - Detection. + individualNames: + description: Individual dimension names. E.g. ["dim1_name", "dim2_name"]. + type: array items: type: string + metrics: + description: List of metrics. type: array - readOnly: true - lastDetectedTime: - format: google-datetime - readOnly: true - type: string - description: >- - Output only. The time when events associated with the incident were - last detected. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Metric' + GoogleCloudApigeeV1StatsHostStats: + id: GoogleCloudApigeeV1StatsHostStats + description: >- + Encapsulates the hostname wrapper: ``` "hosts": [ { "metrics": [ { + "name": "sum(message_count)", "values": [ "2.52056245E8" ] } ], "name": + "example.com" } ]``` type: object - description: Represents an SecurityIncident resource. - GoogleCloudApigeeV1Reference: properties: - description: - description: Optional. A human-readable description of this reference. - type: string name: + description: Hostname used in query. type: string + metrics: description: >- - Required. The resource id of this reference. Values must match the - regular expression [\w\s\-.]+. - refers: - type: string - description: >- - Required. The id of the resource to which this reference refers. - Must be the id of a resource that exists in the parent environment - and is of the given resource_type. - resourceType: - type: string - description: >- - The type of resource referred to by this reference. Valid values are - 'KeyStore' or 'TrustStore'. - description: >- - A Reference configuration. References must refer to a keystore that also - exists in the parent environment. - id: GoogleCloudApigeeV1Reference - type: object - GoogleCloudApigeeV1ListSecurityActionsResponse: - description: >- - Contains a list of SecurityActions in response to a - ListSecurityActionRequest. - type: object - properties: - securityActions: + In the final response, only one of the following fields will be + present based on the dimensions provided. If no dimensions are + provided, then only the top-level metrics are provided. If + dimensions are included, then there will be a top-level dimensions + field under hostnames which will contain metrics values and the + dimension name. Example: ``` "hosts": [ { "dimensions": [ { + "metrics": [ { "name": "sum(message_count)", "values": [ + "2.14049521E8" ] } ], "name": "nit_proxy" } ], "name": "example.com" + } ]``` OR ```"hosts": [ { "metrics": [ { "name": + "sum(message_count)", "values": [ "2.19026331E8" ] } ], "name": + "example.com" } ]``` List of metric values. + type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' + $ref: '#/components/schemas/GoogleCloudApigeeV1Metric' + dimensions: + description: List of metrics grouped under dimensions. type: array - description: The SecurityActions for the specified environment. - nextPageToken: - description: >- - A token, which can be sent as `page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. - type: string - id: GoogleCloudApigeeV1ListSecurityActionsResponse - GoogleCloudApigeeV1TlsInfoConfig: - id: GoogleCloudApigeeV1TlsInfoConfig + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1DimensionMetric' + GoogleCloudApigeeV1Metadata: + id: GoogleCloudApigeeV1Metadata + description: Encapsulates additional information about query execution. type: object properties: - commonName: - description: Common name to validate the target server against. - $ref: '#/components/schemas/GoogleCloudApigeeV1CommonNameConfig' - ciphers: + errors: + description: List of error messages as strings. + type: array items: type: string - description: List of ciphers that are granted access. - type: array - clientAuthEnabled: - type: boolean + notices: description: >- - Flag that specifies whether client-side authentication is enabled - for the target server. Enables two-way TLS. - keyAlias: - type: string + List of additional information such as data source, if result was + truncated. For example: ``` "notices": [ "Source:Postgres", "PG + Host:uappg0rw.e2e.apigeeks.net", "query served + by:4b64601e-40de-4eb1-bfb9-eeee7ac929ed", "Table used: + edge.api.uapgroup2.agg_api" ]``` + type: array + items: + type: string + GoogleCloudApigeeV1OptimizedStats: + id: GoogleCloudApigeeV1OptimizedStats + description: Encapsulates a response format for JavaScript Optimized Scenario. + type: object + properties: + Response: description: >- - Name of the alias used for client-side authentication in the - following format: - `organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}` - enabled: - type: boolean + Wraps the `stats` response for JavaScript Optimized Scenario with a + response key. For example: ```{ "Response": { "TimeUnit": [], + "metaData": { "errors": [], "notices": [ "Source:Postgres", "Table + used: edge.api.aaxgroup001.agg_api", "PG + Host:ruappg08-ro.production.apigeeks.net", "query served + by:80c4ebca-6a10-4a2e-8faf-c60c1ee306ca" ] }, "resultTruncated": + false, "stats": { "data": [ { "identifier": { "names": [ "apiproxy" + ], "values": [ "sirjee" ] }, "metric": [ { "env": "prod", "name": + "sum(message_count)", "values": [ 36.0 ] }, { "env": "prod", "name": + "sum(is_error)", "values": [ 36.0 ] } ] } ] } } }``` + $ref: '#/components/schemas/GoogleCloudApigeeV1OptimizedStatsResponse' + GoogleCloudApigeeV1OptimizedStatsResponse: + id: GoogleCloudApigeeV1OptimizedStatsResponse + description: Encapsulates a response format for JavaScript Optimized Scenario. + type: object + properties: + TimeUnit: description: >- - Flag that specifies whether one-way TLS is enabled. Set to `true` to - enable one-way TLS. - protocols: + List of time unit values. Time unit refers to an epoch timestamp + value. type: array - description: List of TLS protocols that are granted access. items: type: string - keyAliasReference: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyAliasReference' - description: Reference name and alias pair to use for client-side authentication. - ignoreValidationErrors: - type: boolean + format: int64 + metaData: + description: Metadata information about the query executed. + $ref: '#/components/schemas/GoogleCloudApigeeV1Metadata' + resultTruncated: description: >- - Flag that specifies whether to ignore TLS certificate validation - errors. Set to `true` to ignore errors. - enforce: + Boolean flag that indicates whether the results were truncated based + on the limit parameter. type: boolean - description: Flag that enforces TLS settings - trustStore: - type: string - description: >- - Name of the keystore or keystore reference containing trusted - certificates for the server in the following format: - `organizations/{org}/environments/{env}/keystores/{keystore}` or - `organizations/{org}/environments/{env}/references/{reference}` - GoogleCloudApigeeV1RuntimeAnalyticsConfig: + stats: + description: '`stats` results.' + $ref: '#/components/schemas/GoogleCloudApigeeV1OptimizedStatsNode' + GoogleCloudApigeeV1OptimizedStatsNode: + id: GoogleCloudApigeeV1OptimizedStatsNode + description: >- + Encapsulates a data node as represented below: ``` { "identifier": { + "names": [ "apiproxy" ], "values": [ "sirjee" ] }, "metric": [ { "env": + "prod", "name": "sum(message_count)", "values": [ 36.0 ] } ] }``` or ``` + { "env": "prod", "name": "sum(message_count)", "values": [ 36.0 ] }``` + Depending on whether a dimension is present in the query or not the data + node type can be a simple metric value or dimension identifier with list + of metrics. type: object - description: Runtime configuration for the Analytics add-on. properties: - billingPipelineEnabled: - type: boolean - description: If Runtime should send billing data to AX or not. - enabled: - description: If the Analytics is enabled or not. - type: boolean - id: GoogleCloudApigeeV1RuntimeAnalyticsConfig - GoogleCloudApigeeV1Result: - id: GoogleCloudApigeeV1Result + data: + description: List of data values. + type: array + items: + type: any + GoogleCloudApigeeV1Schema: + id: GoogleCloudApigeeV1Schema + description: Response for Schema call + type: object properties: - headers: + dimensions: + description: List of schema fields grouped as dimensions. type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1SchemaSchemaElement' + metrics: description: >- - A list of HTTP headers. for example, '"headers" : [ { "name" : - "Content-Length", "value" : "83" }, { "name" : "Content-Type", - "value" : "application/json" } ]' + List of schema fields grouped as dimensions that can be used with an + aggregate function such as `sum`, `avg`, `min`, and `max`. + type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Property' - ActionResult: + $ref: '#/components/schemas/GoogleCloudApigeeV1SchemaSchemaElement' + meta: description: >- - Type of the action result. Can be one of the five: DebugInfo, - RequestMessage, ResponseMessage, ErrorMessage, VariableAccess + Additional metadata associated with schema. This is a legacy field + and usually consists of an empty array of strings. + type: array + items: + type: string + GoogleCloudApigeeV1SchemaSchemaElement: + id: GoogleCloudApigeeV1SchemaSchemaElement + description: Message type for the schema element + type: object + properties: + name: + description: Name of the field. type: string - content: + properties: description: >- - Error message content. for example, "content" : - "{\"fault\":{\"faultstring\":\"API timed - out\",\"detail\":{\"errorcode\":\"flow.APITimedOut\"}}}" + Properties for the schema field. For example: { "createTime": + "2016-02-26T10:23:09.592Z", "custom": "false", "type": "string" } + $ref: '#/components/schemas/GoogleCloudApigeeV1SchemaSchemaProperty' + GoogleCloudApigeeV1SchemaSchemaProperty: + id: GoogleCloudApigeeV1SchemaSchemaProperty + description: Properties for the schema field. + type: object + properties: + createTime: + description: >- + Time the field was created in RFC3339 string form. For example: + `2016-02-26T10:23:09.592Z`. type: string - reasonPhrase: + custom: + description: >- + Flag that specifies whether the field is standard in the dataset or + a custom field created by the customer. `true` indicates that it is + a custom field. type: string - description: HTTP response phrase - statusCode: + type: + description: Data type of the field. type: string - description: HTTP response code - accessList: - type: array + GoogleCloudApigeeV1ApiProduct: + id: GoogleCloudApigeeV1ApiProduct + type: object + properties: + name: description: >- - A list of variable access actions agaist the api proxy. Supported - values: Get, Set, Remove. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Access' - timestamp: + Internal name of the API product. Characters you can use in the name + are restricted to: `A-Z0-9._\-$ %`. **Note:** The internal name + cannot be edited when updating the API product. type: string + displayName: description: >- - Timestamp of when the result is recorded. Its format is dd-mm-yy - hh:mm:ss:xxx. For example, `"timestamp" : "12-08-19 00:31:59:960"` - verb: + Name displayed in the UI or developer portal to developers + registering for API access. type: string - description: HTTP method verb - uRI: + approvalType: + description: >- + Flag that specifies how API keys are approved to access the APIs + defined by the API product. If set to `manual`, the consumer key is + generated and returned in "pending" state. In this case, the API + keys won't work until they have been explicitly approved. If set to + `auto`, the consumer key is generated and returned in "approved" + state and can be used immediately. **Note:** Typically, `auto` is + used to provide access to free or trial API products that provide + limited quota or capabilities. type: string + attributes: description: >- - The relative path of the api proxy. for example, `"uRI" : - "/iloveapis"` - properties: - $ref: '#/components/schemas/GoogleCloudApigeeV1Properties' - description: Name value pairs used for DebugInfo ActionResult. - type: object - description: >- - Result is short for "action result", could be different types identified - by "action_result" field. Supported types: 1. DebugInfo : generic debug - info collected by runtime recorded as a list of properties. For example, - the contents could be virtual host info, state change result, or - execution metadata. Required fields : properties, timestamp 2. - RequestMessage: information of a http request. Contains headers, request - URI and http methods type.Required fields : headers, uri, verb 3. - ResponseMessage: information of a http response. Contains headers, - reason phrase and http status code. Required fields : headers, - reasonPhrase, statusCode 4. ErrorMessage: information of a http error - message. Contains detail error message, reason phrase and status code. - Required fields : content, headers, reasonPhrase, statusCode 5. - VariableAccess: a list of variable access actions, can be Get, Set and - Remove. Required fields : accessList - GoogleCloudApigeeV1SecurityProfileV2ProfileAssessmentConfig: - description: The configuration definition for a specific assessment. - type: object - id: GoogleCloudApigeeV1SecurityProfileV2ProfileAssessmentConfig - properties: - weight: - type: string - description: The weight of the assessment. - enum: - - WEIGHT_UNSPECIFIED - - MINOR - - MODERATE - - MAJOR - enumDescriptions: - - The weight is unspecified. - - The weight is minor. - - The weight is moderate. - - The weight is major. - GoogleCloudApigeeV1AccessLoggingConfig: - type: object - id: GoogleCloudApigeeV1AccessLoggingConfig - properties: - enabled: - type: boolean + Array of attributes that may be used to extend the default API + product profile with customer-specific metadata. You can specify a + maximum of 18 attributes. Use this property to specify the access + level of the API product as either `public`, `private`, or + `internal`. Only products marked `public` are available to + developers in the Apigee developer portal. For example, you can set + a product to `internal` while it is in development and then change + access to `public` when it is ready to release on the portal. API + products marked as `private` do not appear on the portal, but can be + accessed by external developers. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + description: description: >- - Optional. Boolean flag that specifies whether the customer access - log feature is enabled. - filter: + Description of the API product. Include key information about the + API product that is not captured by other fields. type: string + apiResources: description: >- - Optional. Ship the access log entries that match the status_code - defined in the filter. The status_code is the only - expected/supported filter field. (Ex: status_code) The filter will - parse it to the Common Expression Language semantics for expression - evaluation to build the filter condition. (Ex: "filter": status_code - >= 200 && status_code < 300 ) - description: >- - Access logging configuration enables customers to ship the access logs - from the tenant projects to their own project's cloud logging. The - feature is at the instance level ad disabled by default. It can be - enabled during CreateInstance or UpdateInstance. - GoogleCloudApigeeV1DebugSessionTransaction: - type: object - id: GoogleCloudApigeeV1DebugSessionTransaction - properties: - point: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Point' + Comma-separated list of API resources to be bundled in the API + product. By default, the resource paths are mapped from the + `proxy.pathsuffix` variable. The proxy path suffix is defined as the + URI fragment following the ProxyEndpoint base path. For example, if + the `apiResources` element is defined to be `/forecastrss` and the + base path defined for the API proxy is `/weather`, then only + requests to `/weather/forecastrss` are permitted by the API product. + You can select a specific path, or you can select all subpaths with + the following wildcard: - `/**`: Indicates that all sub-URIs are + included. - `/*` : Indicates that only URIs one level down are + included. By default, / supports the same resources as /** as well + as the base path defined by the API proxy. For example, if the base + path of the API proxy is `/v1/weatherapikey`, then the API product + supports requests to `/v1/weatherapikey` and to any sub-URIs, such + as `/v1/weatherapikey/forecastrss`, `/v1/weatherapikey/region/CA`, + and so on. For more information, see Managing API products. type: array + items: + type: string + environments: description: >- - List of debug data collected by runtime plane at various defined - points in the flow. - completed: - type: boolean - description: Flag indicating whether a transaction is completed or not - description: >- - A transaction contains all of the debug information of the entire - message flow of an API call processed by the runtime plane. The - information is collected and recorded at critical points of the message - flow in the runtime apiproxy. - GoogleCloudApigeeV1ListSharedFlowsResponse: - type: object - properties: - sharedFlows: + Comma-separated list of environment names to which the API product + is bound. Requests to environments that are not listed are rejected. + By specifying one or more environments, you can bind the resources + listed in the API product to a specific environment, preventing + developers from accessing those resources through API proxies + deployed in another environment. This setting is used, for example, + to prevent resources associated with API proxies in `prod` from + being accessed by API proxies deployed in `test`. type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlow' - id: GoogleCloudApigeeV1ListSharedFlowsResponse - GoogleCloudApigeeV1ScoreComponentRecommendationAction: - id: GoogleCloudApigeeV1ScoreComponentRecommendationAction - description: Action to improve security score. - properties: - actionContext: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ScoreComponentRecommendationActionActionContext - description: Action context for the action. - description: - description: Description of the action. - type: string - type: object - GoogleCloudApigeeV1CertInfo: - type: object - id: GoogleCloudApigeeV1CertInfo - properties: - serialNumber: - description: X.509 serial number. - type: string - sigAlgName: - description: X.509 signatureAlgorithm. - type: string - expiryDate: - format: int64 - type: string - description: X.509 `notAfter` validity period in milliseconds since epoch. - version: - format: int32 - description: X.509 version. - type: integer - isValid: + type: string + proxies: description: >- - Flag that specifies whether the certificate is valid. Flag is set to - `Yes` if the certificate is valid, `No` if expired, or `Not yet` if - not yet valid. - type: string - subjectAlternativeNames: + Comma-separated list of API proxy names to which this API product is + bound. By specifying API proxies, you can associate resources in the + API product with specific API proxies, preventing developers from + accessing those resources through other API proxies. Apigee rejects + requests to API proxies that are not listed. **Note:** The API proxy + names must already exist in the specified environment as they will + be validated upon creation. + type: array items: type: string - type: array - description: X.509 subject alternative names (SANs) extension. - validFrom: - description: X.509 `notBefore` validity period in milliseconds since epoch. - format: int64 - type: string - subject: - description: X.509 subject. - type: string - issuer: - type: string - description: X.509 issuer. - basicConstraints: - description: X.509 basic constraints extension. + quota: + description: >- + Number of request messages permitted per app by this API product for + the specified `quotaInterval` and `quotaTimeUnit`. For example, a + `quota` of 50, for a `quotaInterval` of 12 and a `quotaTimeUnit` of + hours means 50 requests are allowed every 12 hours. type: string - publicKey: + quotaInterval: + description: >- + Time interval over which the number of request messages is + calculated. type: string - description: Public key component of the X.509 subject public key info. - description: X.509 certificate as defined in RFC 5280. - GoogleCloudApigeeV1SecurityActionAllow: - description: >- - Message that should be set in case of an Allow Action. This does not - have any fields. - properties: {} - id: GoogleCloudApigeeV1SecurityActionAllow - type: object - GoogleCloudApigeeV1SecurityReportMetadata: - id: GoogleCloudApigeeV1SecurityReportMetadata - properties: - startTimestamp: - format: google-datetime + quotaTimeUnit: + description: >- + Time unit defined for the `quotaInterval`. Valid values include + `minute`, `hour`, `day`, or `month`. type: string - description: Start timestamp of the query range. - dimensions: - items: - type: string - description: Dimensions of the SecurityReport. - type: array - metrics: - type: array + scopes: description: >- - Metrics of the SecurityReport. Example: - ["name:bot_count,func:sum,alias:sum_bot_count"] + Comma-separated list of OAuth scopes that are validated at runtime. + Apigee validates that the scopes in any access token presented match + the scopes defined in the OAuth policy associated with the API + product. + type: array items: type: string - timeUnit: - description: 'Query GroupBy time unit. Example: "seconds", "minute", "hour"' - type: string - mimeType: - description: MIME type / Output format. - type: string - endTimestamp: - format: google-datetime - description: End timestamp of the query range. + createdAt: + description: >- + Response only. Creation time of this environment as milliseconds + since epoch. type: string - description: Metadata for the security report. - type: object - GoogleCloudApigeeV1Credential: - type: object - id: GoogleCloudApigeeV1Credential - properties: - expiresAt: format: int64 - description: Time the credential will expire in milliseconds since epoch. + lastModifiedAt: + description: >- + Response only. Modified time of this environment as milliseconds + since epoch. type: string - apiProducts: - type: array - description: List of API products this credential can be used for. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProductRef' - issuedAt: format: int64 - description: Time the credential was issued in milliseconds since epoch. - type: string - attributes: - description: List of attributes associated with this credential. - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - consumerSecret: - type: string - description: Secret key. - status: + operationGroup: description: >- - Status of the credential. Valid values include `approved` or - `revoked`. + Configuration used to group Apigee proxies or remote services with + resources, method types, and quotas. The resource refers to the + resource URI (excluding the base path). With this grouping, the API + product creator is able to fine-tune and give precise control over + which REST methods have access to specific resources and how many + calls can be made (using the `quota` setting). **Note:** The + `api_resources` setting cannot be specified for both the API product + and operation group; otherwise the call will fail. + $ref: '#/components/schemas/GoogleCloudApigeeV1OperationGroup' + graphqlOperationGroup: + description: >- + Configuration used to group Apigee proxies or remote services with + graphQL operation name, graphQL operation type and quotas. This + grouping allows us to precisely set quota for a particular + combination of graphQL name and operation type for a particular + proxy request. If graphQL name is not set, this would imply quota + will be applied on all graphQL requests matching the operation type. + $ref: '#/components/schemas/GoogleCloudApigeeV1GraphQLOperationGroup' + grpcOperationGroup: + description: >- + Optional. Configuration used to group Apigee proxies with gRPC + services and method names. This grouping allows us to set quota for + a particular proxy with the gRPC service name and method. If a + method name is not set, this implies quota and authorization are + applied to all gRPC methods implemented by that proxy for that + particular gRPC service. + $ref: '#/components/schemas/GoogleCloudApigeeV1GrpcOperationGroup' + quotaCounterScope: + description: >- + Scope of the quota decides how the quota counter gets applied and + evaluate for quota violation. If the Scope is set as PROXY, then all + the operations defined for the APIproduct that are associated with + the same proxy will share the same quota counter set at the + APIproduct level, making it a global counter at a proxy level. If + the Scope is set as OPERATION, then each operations get the counter + set at the API product dedicated, making it a local counter. Note + that, the QuotaCounterScope applies only when an operation does not + have dedicated quota set for itself. type: string - scopes: - items: - type: string - type: array + enumDescriptions: + - >- + When quota is not explicitly defined for each + operation(REST/GraphQL), the limits set at product level will be + used as a local counter for quota evaluation by all the + operations, independent of proxy association. + - >- + When quota is not explicitly defined for each + operation(REST/GraphQL), set at product level will be used as a + global counter for quota evaluation by all the operations + associated with a particular proxy. + - >- + When quota is not explicitly defined for each + operation(REST/GraphQL), the limits set at product level will be + used as a local counter for quota evaluation by all the + operations, independent of proxy association. This behavior mimics + the same as QUOTA_COUNTER_SCOPE_UNSPECIFIED. + enum: + - QUOTA_COUNTER_SCOPE_UNSPECIFIED + - PROXY + - OPERATION + space: description: >- - List of scopes to apply to the app. Specified scopes must already - exist on the API product that you associate with the app. - consumerKey: - description: Consumer key. + Optional. The resource ID of the parent Space. If not set, the + parent resource will be the Organization. To learn how Spaces can be + used to manage resources, read the [Apigee Spaces + Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview). type: string - GoogleCloudApigeeV1SecuritySettings: - description: >- - SecuritySettings reflects the current state of the SecuritySettings - feature. + GoogleCloudApigeeV1Attribute: + id: GoogleCloudApigeeV1Attribute + description: Key-value pair to store extra metadata. type: object - id: GoogleCloudApigeeV1SecuritySettings properties: name: + description: API key of the attribute. type: string - description: >- - Identifier. Full resource name is always - `organizations/{org}/securitySettings`. - mlRetrainingFeedbackEnabled: - description: >- - Optional. If true the user consents to the use of ML models for - Abuse detection. - type: boolean - GoogleCloudApigeeV1ScoreComponentRecommendation: - description: Recommendation based on security concerns and score. + value: + description: Value of the attribute. + type: string + GoogleCloudApigeeV1OperationGroup: + id: GoogleCloudApigeeV1OperationGroup + description: >- + List of operation configuration details associated with Apigee API + proxies or remote services. Remote services are non-Apigee proxies, such + as Istio-Envoy. type: object - id: GoogleCloudApigeeV1ScoreComponentRecommendation properties: - title: - type: string - description: Title represents recommendation title. - description: - description: Description of the recommendation. - type: string - impact: - format: int32 - type: integer + operationConfigs: description: >- - Potential impact of this recommendation on the overall score. This - denotes how important this recommendation is to improve the score. - actions: - items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ScoreComponentRecommendationAction - description: Actions for the recommendation to improve the security score. + Required. List of operation configurations for either Apigee API + proxies or other remote services that are associated with this API + product. type: array - GoogleCloudApigeeV1DeploymentGroupConfig: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1OperationConfig' + operationConfigType: + description: >- + Flag that specifes whether the configuration is for Apigee API proxy + or a remote service. Valid values include `proxy` or + `remoteservice`. Defaults to `proxy`. Set to `proxy` when Apigee API + proxies are associated with the API product. Set to `remoteservice` + when non-Apigee proxies like Istio-Envoy are associated with the API + product. + type: string + GoogleCloudApigeeV1OperationConfig: + id: GoogleCloudApigeeV1OperationConfig description: >- - DeploymentGroupConfig represents a deployment group that should be - present in a particular environment. - id: GoogleCloudApigeeV1DeploymentGroupConfig + Binds the resources in an API proxy or remote service with the allowed + REST methods and associated quota enforcement. + type: object properties: - uid: - type: string - description: >- - Unique ID. The ID will only change if the deployment group is - deleted and recreated. - revisionId: + apiSource: description: >- - Revision number which can be used by the runtime to detect if the - deployment group has changed between two versions. - format: int64 - type: string - deploymentGroupType: + Required. Name of the API proxy or remote service with which the + resources, methods, and quota are associated. type: string - enumDescriptions: - - Unspecified type - - Standard type - - Extensible Type - enum: - - DEPLOYMENT_GROUP_TYPE_UNSPECIFIED - - STANDARD - - EXTENSIBLE + operations: description: >- - Type of the deployment group, which will be either Standard or - Extensible. - name: - type: string + List of resource/method pairs for the API proxy or remote service to + which quota will applied. **Note**: Currently, you can specify only + a single resource/method pair. The call will fail if more than one + resource/method pair is provided. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Operation' + quota: description: >- - Name of the deployment group in the following format: - `organizations/{org}/environments/{env}/deploymentGroups/{group}`. - type: object - GoogleIamV1SetIamPolicyRequest: - id: GoogleIamV1SetIamPolicyRequest + Quota parameters to be enforced for the resources, methods, and API + source combination. If none are specified, quota enforcement will + not be done. + $ref: '#/components/schemas/GoogleCloudApigeeV1Quota' + attributes: + description: Custom attributes associated with the operation. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + GoogleCloudApigeeV1Operation: + id: GoogleCloudApigeeV1Operation + description: >- + Represents the pairing of REST resource path and the actions (verbs) + allowed on the resource path. type: object - description: Request message for `SetIamPolicy` method. properties: - updateMask: - type: string - format: google-fieldmask + resource: description: >- - OPTIONAL: A FieldMask specifying which fields of the policy to - modify. Only the fields in the mask will be modified. If no mask is - provided, the following default mask is used: `paths: "bindings, - etag"` - policy: + Required. REST resource path associated with the API proxy or remote + service. + type: string + methods: description: >- - REQUIRED: The complete policy to be applied to the `resource`. The - size of the policy is limited to a few 10s of KB. An empty policy is - a valid policy but certain Google Cloud services (such as Projects) - might reject them. - $ref: '#/components/schemas/GoogleIamV1Policy' - GoogleCloudApigeeV1AppGroupApp: + methods refers to the REST verbs as in + https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html. When none + specified, all verb types are allowed. + type: array + items: + type: string + GoogleCloudApigeeV1Quota: + id: GoogleCloudApigeeV1Quota description: >- - Response for [GetAppGroupApp].[AppGroupApps.GetAppGroupApp], - [CreateAppGroupAppRequest].[AppGroupApp.CreateAppGroupAppRequest] and - [DeleteAppGroupApp].[AppGroupApp.DeleteAppGroupApp] - id: GoogleCloudApigeeV1AppGroupApp + Quota contains the essential parameters needed that can be applied on + the resources, methods, API source combination associated with this API + product. While Quota is optional, setting it prevents requests from + exceeding the provisioned parameters. type: object properties: - appGroup: - type: string + limit: description: >- - Immutable. Name of the parent AppGroup whose resource name format is - of syntax (organizations/*/appgroups/*). - createdAt: + Required. Upper limit allowed for the time interval and time unit + specified. Requests exceeding this limit will be rejected. type: string + interval: description: >- - Output only. Time the AppGroup app was created in milliseconds since - epoch. - format: int64 - readOnly: true - lastModifiedAt: - format: int64 - description: >- - Output only. Time the AppGroup app was modified in milliseconds - since epoch. - readOnly: true - type: string - appId: - description: Immutable. ID of the AppGroup app. + Required. Time interval over which the number of request messages is + calculated. type: string - callbackUrl: + timeUnit: + description: >- + Time unit defined for the `interval`. Valid values include `minute`, + `hour`, `day`, or `month`. If `limit` and `interval` are valid, the + default value is `hour`; otherwise, the default is null. type: string + GoogleCloudApigeeV1GraphQLOperationGroup: + id: GoogleCloudApigeeV1GraphQLOperationGroup + description: >- + List of graphQL operation configuration details associated with Apigee + API proxies or remote services. Remote services are non-Apigee proxies, + such as Istio-Envoy. + type: object + properties: + operationConfigs: description: >- - Callback URL used by OAuth 2.0 authorization servers to communicate - authorization codes back to AppGroup apps. - name: + Required. List of operation configurations for either Apigee API + proxies or other remote services that are associated with this API + product. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1GraphQLOperationConfig' + operationConfigType: + description: >- + Flag that specifies whether the configuration is for Apigee API + proxy or a remote service. Valid values include `proxy` or + `remoteservice`. Defaults to `proxy`. Set to `proxy` when Apigee API + proxies are associated with the API product. Set to `remoteservice` + when non-Apigee proxies like Istio-Envoy are associated with the API + product. type: string + GoogleCloudApigeeV1GraphQLOperationConfig: + id: GoogleCloudApigeeV1GraphQLOperationConfig + description: >- + Binds the resources in a proxy or remote service with the GraphQL + operation and its associated quota enforcement. + type: object + properties: + apiSource: description: >- - Immutable. Name of the AppGroup app whose resource name format is of - syntax (organizations/*/appgroups/*/apps/*). - status: + Required. Name of the API proxy endpoint or remote service with + which the GraphQL operation and quota are associated. type: string - description: Status of the App. Valid values include `approved` or `revoked`. - scopes: - type: array + operations: description: >- - Scopes to apply to the AppGroup app. The specified scopes must - already exist for the API product that you associate with the - AppGroup app. - items: - type: string - apiProducts: - description: List of API products associated with the AppGroup app. - items: - type: string + Required. List of GraphQL name/operation type pairs for the proxy or + remote service to which quota will be applied. If only operation + types are specified, the quota will be applied to all GraphQL + requests irrespective of the GraphQL name. **Note**: Currently, you + can specify only a single GraphQLOperation. Specifying more than one + will cause the operation to fail. type: array - keyExpiresIn: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1GraphQLOperation' + quota: description: >- - Immutable. Expiration time, in seconds, for the consumer key that is - generated for the AppGroup app. If not set or left to the default - value of `-1`, the API key never expires. The expiration time can't - be updated after it is set. - format: int64 - type: string + Quota parameters to be enforced for the resources, methods, and API + source combination. If none are specified, quota enforcement will + not be done. + $ref: '#/components/schemas/GoogleCloudApigeeV1Quota' attributes: + description: Custom attributes associated with the operation. type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - description: List of attributes for the AppGroup app. - credentials: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Credential' - readOnly: true + GoogleCloudApigeeV1GraphQLOperation: + id: GoogleCloudApigeeV1GraphQLOperation + description: >- + Represents the pairing of GraphQL operation types and the GraphQL + operation name. + type: object + properties: + operationTypes: description: >- - Output only. Set of credentials for the AppGroup app consisting of - the consumer key/secret pairs associated with the API products. + Required. GraphQL operation types. Valid values include `query` or + `mutation`. **Note**: Apigee does not currently support + `subscription` types. type: array - GoogleCloudApigeeV1RuntimeTraceConfigOverride: - type: object + items: + type: string + operation: + description: >- + GraphQL operation name. The name and operation type will be used to + apply quotas. If no name is specified, the quota will be applied to + all GraphQL operations irrespective of their operation names in the + payload. + type: string + GoogleCloudApigeeV1GrpcOperationGroup: + id: GoogleCloudApigeeV1GrpcOperationGroup description: >- - NEXT ID: 7 Trace configuration override for a specific API proxy in an - environment. + List of gRPC operation configuration details associated with Apigee API + proxies. + type: object properties: - revisionId: - type: string + operationConfigs: description: >- - Revision number which can be used by the runtime to detect if the - trace config override has changed between two versions. - name: + Required. List of operation configurations for either Apigee API + proxies that are associated with this API product. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1GrpcOperationConfig' + GoogleCloudApigeeV1GrpcOperationConfig: + id: GoogleCloudApigeeV1GrpcOperationConfig + description: >- + Binds the resources in a proxy or remote service with the gRPC operation + and its associated quota enforcement. + type: object + properties: + apiSource: description: >- - Name of the trace config override in the following format: - `organizations/{org}/environment/{env}/traceConfig/overrides/{override}` - type: string - apiProxy: + Required. Name of the API proxy with which the gRPC operation and + quota are associated. type: string + methods: description: >- - Name of the API proxy that will have its trace configuration - overridden following format: `organizations/{org}/apis/{api}` - uid: - type: string + List of unqualified gRPC method names for the proxy to which quota + will be applied. If this field is empty, the Quota will apply to all + operations on the gRPC service defined on the proxy. Example: Given + a proxy that is configured to serve com.petstore.PetService, the + methods com.petstore.PetService.ListPets and + com.petstore.PetService.GetPet would be specified here as simply + ["ListPets", "GetPet"]. + type: array + items: + type: string + quota: description: >- - Unique ID for the configuration override. The ID will only change if - the override is deleted and recreated. Corresponds to name's - "override" field. - samplingConfig: + Quota parameters to be enforced for the methods and API source + combination. If none are specified, quota enforcement will not be + done. + $ref: '#/components/schemas/GoogleCloudApigeeV1Quota' + attributes: + description: Custom attributes associated with the operation. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + service: description: >- - Trace configuration override for a specific API proxy in an - environment. - $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeTraceSamplingConfig' - revisionCreateTime: - description: The timestamp that the revision was created or updated. + Required. gRPC Service name associated to be associated with the API + proxy, on which quota rules can be applied upon. type: string - format: google-datetime - id: GoogleCloudApigeeV1RuntimeTraceConfigOverride - GoogleCloudApigeeV1KeyValueMap: - description: Collection of key/value string pairs. + GoogleCloudApigeeV1MoveApiProductRequest: + id: GoogleCloudApigeeV1MoveApiProductRequest + description: Moves API product to a different space. type: object properties: - encrypted: + space: description: >- - Required. Flag that specifies whether entry values will be - encrypted. This field is retained for backward compatibility and the - value of encrypted will always be `true`. Apigee X and hybrid do not - support unencrypted key value maps. - type: boolean - name: + Optional. Resource ID of the space to move the API product to. If + unspecified, the API product will be moved to the organization + level. type: string - description: Required. ID of the key value map. - id: GoogleCloudApigeeV1KeyValueMap - GoogleCloudApigeeV1ListSecurityReportsResponse: - description: The response for SecurityReports. + GoogleCloudApigeeV1ListApiProductsResponse: + id: GoogleCloudApigeeV1ListApiProductsResponse type: object - id: GoogleCloudApigeeV1ListSecurityReportsResponse properties: - securityReports: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' + apiProduct: + description: Lists all API product names defined for an organization. type: array - description: The security reports belong to requested resource name. - nextPageToken: - type: string - description: >- - If the number of security reports exceeded the page size requested, - the token can be used to fetch the next page in a subsequent call. - If the response is the last page and there are no more reports to - return this field is left empty. - GoogleCloudApigeeV1AdjustDeveloperBalanceRequest: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' + GoogleCloudApigeeV1Attributes: + id: GoogleCloudApigeeV1Attributes + type: object properties: - adjustment: - description: >- - * A positive value of `adjustment` means that that the API provider - wants to adjust the balance for an under-charged developer i.e. the - balance of the developer will decrease. * A negative value of - `adjustment` means that that the API provider wants to adjust the - balance for an over-charged developer i.e. the balance of the - developer will increase. - $ref: '#/components/schemas/GoogleTypeMoney' + attribute: + description: List of attributes. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + GoogleCloudApigeeV1App: + id: GoogleCloudApigeeV1App type: object - description: Request for AdjustDeveloperBalance. - id: GoogleCloudApigeeV1AdjustDeveloperBalanceRequest - GoogleCloudApigeeV1Developer: properties: + appId: + description: ID of the app. + type: string attributes: + description: List of attributes. type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + callbackUrl: description: >- - Optional. Developer attributes (name/value pairs). The custom - attribute limit is 18. - developerId: + Callback URL used by OAuth 2.0 authorization servers to communicate + authorization codes back to apps. type: string - description: >- - ID of the developer. **Note**: IDs are generated internally by - Apigee and are not guaranteed to stay the same over time. - companies: - description: List of companies associated with the developer. - items: - type: string - type: array - status: + createdAt: + description: Output only. Unix time when the app was created. readOnly: true type: string + format: int64 + credentials: description: >- - Output only. Status of the developer. Valid values are `active` and - `inactive`. - organizationName: + Output only. Set of credentials for the app. Credentials are API + key/secret pairs associated with API products. readOnly: true - description: >- - Output only. Name of the Apigee organization in which the developer - resides. - type: string - apps: - description: List of apps associated with the developer. type: array items: - type: string - lastModifiedAt: + $ref: '#/components/schemas/GoogleCloudApigeeV1Credential' + companyName: + description: Name of the company that owns the app. type: string - format: int64 - readOnly: true - description: >- - Output only. Time at which the developer was last modified in - milliseconds since epoch. - firstName: + developerId: + description: ID of the developer. type: string - description: Required. First name of the developer. - appFamily: - description: Developer app family. + lastModifiedAt: + description: Output only. Last modified time as milliseconds since epoch. + readOnly: true type: string - userName: + format: int64 + name: + description: Name of the app. type: string - description: Required. User name of the developer. Not used by Apigee hybrid. - email: + scopes: description: >- - Required. Email address of the developer. This value is used to - uniquely identify the developer in Apigee hybrid. Note that the - email address has to be in lowercase only. - type: string - accessType: + Scopes to apply to the app. The specified scope names must already + exist on the API product that you associate with the app. + type: array + items: + type: string + status: + description: Status of the credential. type: string - description: Access type. - createdAt: + apiProducts: + description: List of API products associated with the app. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProductRef' + keyExpiresIn: description: >- - Output only. Time at which the developer was created in milliseconds - since epoch. + Duration, in milliseconds, of the consumer key that will be + generated for the app. The default value, -1, indicates an infinite + validity period. Once set, the expiration can't be updated. json + key: keyExpiresIn + type: string format: int64 - readOnly: true + developerEmail: + description: Email of the developer. type: string - lastName: - description: Required. Last name of the developer. + appGroup: + description: Name of the AppGroup type: string - id: GoogleCloudApigeeV1Developer - type: object - GoogleCloudApigeeV1GetAsyncQueryResultUrlResponseURLInfo: - description: A Signed URL and the relevant metadata associated with it. + GoogleCloudApigeeV1Credential: + id: GoogleCloudApigeeV1Credential type: object properties: - uri: - description: >- - The signed URL of the JSON data. Will be of the form - `https://storage.googleapis.com/example-bucket/cat.jpeg?X-Goog-Algorithm= - GOOG4-RSA-SHA256&X-Goog-Credential=example%40example-project.iam.gserviceaccount - .com%2F20181026%2Fus-central1%2Fstorage%2Fgoog4_request&X-Goog-Date=20181026T18 - 1309Z&X-Goog-Expires=900&X-Goog-SignedHeaders=host&X-Goog-Signature=247a2aa45f16 - 9edf4d187d54e7cc46e4731b1e6273242c4f4c39a1d2507a0e58706e25e3a85a7dbb891d62afa849 - 6def8e260c1db863d9ace85ff0a184b894b117fe46d1225c82f2aa19efd52cf21d3e2022b3b868dc - c1aca2741951ed5bf3bb25a34f5e9316a2841e8ff4c530b22ceaa1c5ce09c7cbb5732631510c2058 - 0e61723f5594de3aea497f195456a2ff2bdd0d13bad47289d8611b6f9cfeef0c46c91a455b94e90a - 66924f722292d21e24d31dcfb38ce0c0f353ffa5a9756fc2a9f2b40bc2113206a81e324fc4fd6823 - a29163fa845c8ae7eca1fcf6e5bb48b3200983c56c5ca81fffb151cca7402beddfc4a76b13344703 - 2ea7abedc098d2eb14a7` + apiProducts: + description: List of API products this credential can be used for. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProductRef' + attributes: + description: List of attributes associated with this credential. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + consumerKey: + description: Consumer key. type: string - sizeBytes: + consumerSecret: + description: Secret key. + type: string + expiresAt: + description: Time the credential will expire in milliseconds since epoch. type: string format: int64 - description: The size of the returned file in bytes - md5: + issuedAt: + description: Time the credential was issued in milliseconds since epoch. type: string - description: The MD5 Hash of the JSON data - id: GoogleCloudApigeeV1GetAsyncQueryResultUrlResponseURLInfo - GoogleCloudApigeeV1RatePlan: + format: int64 + scopes: + description: >- + List of scopes to apply to the app. Specified scopes must already + exist on the API product that you associate with the app. + type: array + items: + type: string + status: + description: >- + Status of the credential. Valid values include `approved` or + `revoked`. + type: string + GoogleCloudApigeeV1ApiProductRef: + id: GoogleCloudApigeeV1ApiProductRef type: object - id: GoogleCloudApigeeV1RatePlan properties: - createdAt: + apiproduct: + description: Name of the API product. type: string - readOnly: true + status: + description: Status of the API product. Valid values are `approved` or `revoked`. + type: string + GoogleCloudApigeeV1ListAppsResponse: + id: GoogleCloudApigeeV1ListAppsResponse + type: object + properties: + app: + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1App' + nextPageToken: description: >- - Output only. Time that the rate plan was created in milliseconds - since epoch. - format: int64 - displayName: - description: Display name of the rate plan. + Token that can be sent as `next_page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. type: string - revenueShareRates: + totalSize: + description: Total count of Apps. + type: integer + format: int32 + GoogleCloudApigeeV1Query: + id: GoogleCloudApigeeV1Query + type: object + properties: + metrics: + description: A list of Metrics. + type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1RevenueShareRange' - description: Details of the revenue sharing model. + $ref: '#/components/schemas/GoogleCloudApigeeV1QueryMetric' + dimensions: + description: >- + A list of dimensions. + https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions type: array - endTime: + items: + type: string + timeRange: description: >- - Time when the rate plan will expire in milliseconds since epoch. Set - to 0 or `null` to indicate that the rate plan should never expire. - type: string - format: int64 - paymentFundingModel: - deprecated: true + Required. Time range for the query. Can use the following predefined + strings to specify the time range: `last60minutes` `last24hours` + `last7days` Or, specify the timeRange as a structure describing + start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. + Example: "timeRange": { "start": "2018-07-29T00:13:00Z", "end": + "2018-08-01T00:18:00Z" } + type: any + filter: description: >- - DEPRECATED: This field is no longer supported and will eventually be - removed when Apigee Hybrid 1.5/1.6 is no longer supported. Instead, - use the `billingType` field inside `DeveloperMonetizationConfig` - resource. Flag that specifies the billing account type, prepaid or - postpaid. - enumDescriptions: - - Billing account type not specified. - - >- - Prepaid billing account type. Developer pays in advance for the - use of your API products. Funds are deducted from their prepaid - account balance. **Note**: Not supported by Apigee at this time. - - >- - Postpaid billing account type. Developer is billed through an - invoice after using your API products. - enum: - - PAYMENT_FUNDING_MODEL_UNSPECIFIED - - PREPAID - - POSTPAID + Boolean expression that can be used to filter data. Filter + expressions can be combined using AND/OR terms and should be fully + parenthesized to avoid ambiguity. See Analytics metrics, dimensions, + and filters reference + https://docs.apigee.com/api-platform/analytics/analytics-reference + for more information on the fields available to filter on. For more + information on the tokens that you use to build filter expressions, + see Filter expression syntax. + https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax type: string - billingPeriod: + groupByTimeUnit: + description: >- + Time unit used to group the result set. Valid values include: + second, minute, hour, day, week, or month. If a query includes + groupByTimeUnit, then the result is an aggregation based on the + specified time unit and the resultant timestamp does not include + milliseconds precision. If a query omits groupByTimeUnit, then the + resultant timestamp includes milliseconds precision. type: string - enumDescriptions: - - Billing period not specified. - - >- - Weekly billing period. **Note**: Not supported by Apigee at this - time. - - Monthly billing period. - description: Frequency at which the customer will be billed. - enum: - - BILLING_PERIOD_UNSPECIFIED - - WEEKLY - - MONTHLY - fixedFeeFrequency: + limit: + description: Maximum number of rows that can be returned in the result. type: integer format: int32 - description: Frequency at which the fixed fee is charged. + outputFormat: + description: >- + Valid values include: `csv` or `json`. Defaults to `json`. Note: + Configure the delimiter for CSV output using the csvDelimiter + property. + type: string + csvDelimiter: + description: >- + Delimiter used in the CSV file, if `outputFormat` is set to `csv`. + Defaults to the `,` (comma) character. Supported delimiter + characters include comma (`,`), pipe (`|`), and tab (`\t`). + type: string + envgroupHostname: + description: >- + Hostname needs to be specified if query intends to run at host + level. This field is only allowed when query is submitted by + CreateHostAsyncQuery where analytics data will be grouped by + organization and hostname. + type: string + reportDefinitionId: + description: Asynchronous Report ID. + type: string name: + description: Asynchronous Query Name. type: string - description: Output only. Name of the rate plan. - readOnly: true - startTime: + GoogleCloudApigeeV1QueryMetric: + id: GoogleCloudApigeeV1QueryMetric + description: >- + More info about Metric: + https://docs.apigee.com/api-platform/analytics/analytics-reference#metrics + type: object + properties: + name: + description: Required. Metric name. type: string - format: int64 - description: Time when the rate plan becomes active in milliseconds since epoch. - lastModifiedAt: + function: + description: 'Aggregation function: avg, min, max, or sum.' type: string - readOnly: true - format: int64 - description: >- - Output only. Time the rate plan was last modified in milliseconds - since epoch. - consumptionPricingRates: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1RateRange' + alias: description: >- - API call volume ranges and the fees charged when the total number of - API calls is within a given range. The method used to calculate the - final fee depends on the selected pricing model. For example, if the - pricing model is `STAIRSTEP` and the ranges are defined as follows: - ``` { "start": 1, "end": 100, "fee": 75 }, { "start": 101, "end": - 200, "fee": 100 }, } ``` Then the following fees would be charged - based on the total number of API calls (assuming the currency - selected is `USD`): * 1 call costs $75 * 50 calls cost $75 * 150 - calls cost $100 The number of API calls cannot exceed 200. - type: array - setupFee: - $ref: '#/components/schemas/GoogleTypeMoney' - description: Initial, one-time fee paid when purchasing the API product. - apiproduct: - description: Name of the API product that the rate plan is associated with. + Alias for the metric. Alias will be used to replace metric name in + query results. type: string - description: - description: Description of the rate plan. + operator: + description: One of `+`, `-`, `/`, `%`, `*`. + type: string + value: + description: Operand value should be provided when operator is set. + type: string + GoogleCloudApigeeV1AsyncQuery: + id: GoogleCloudApigeeV1AsyncQuery + type: object + properties: + self: + description: >- + Self link of the query. Example: + `/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` + or following format if query is running at host level: + `/organizations/myorg/hostQueries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` type: string state: - enumDescriptions: - - State of the rate plan is not specified. - - Rate plan is in draft mode and only visible to API providers. - - >- - Rate plan is published and will become visible to developers for - the configured duration (between `startTime` and `endTime`). - description: Current state of the rate plan (draft or published). + description: Query state could be "enqueued", "running", "completed", "failed". type: string - enum: - - STATE_UNSPECIFIED - - DRAFT - - PUBLISHED - consumptionPricingType: + created: + description: Creation time of the query. type: string - description: Pricing model used for consumption-based charges. - enum: - - CONSUMPTION_PRICING_TYPE_UNSPECIFIED - - FIXED_PER_UNIT - - BANDED - - TIERED - - STAIRSTEP - enumDescriptions: - - Pricing model not specified. This is the default. - - Fixed rate charged for each API call. - - >- - Variable rate charged for each API call based on price tiers. - Example: * 1-100 calls cost $2 per call * 101-200 calls cost $1.50 - per call * 201-300 calls cost $1 per call * Total price for 50 - calls: 50 x $2 = $100 * Total price for 150 calls: 100 x $2 + 50 x - $1.5 = $275 * Total price for 250 calls: 100 x $2 + 100 x $1.5 + - 50 x $1 = $400. **Note**: Not supported by Apigee at this time. - - '**Note**: Not supported by Apigee at this time.' - - '**Note**: Not supported by Apigee at this time.' - revenueShareType: + updated: + description: Last updated timestamp for the query. type: string - description: Method used to calculate the revenue that is shared with developers. - enumDescriptions: - - Revenue share type is not specified. - - >- - Fixed percentage of the total revenue will be shared. The - percentage to be shared can be configured by the API provider. - - >- - Amount of revenue shared depends on the number of API calls. The - API call volume ranges and the revenue share percentage for each - volume can be configured by the API provider. **Note**: Not - supported by Apigee at this time. - enum: - - REVENUE_SHARE_TYPE_UNSPECIFIED - - FIXED - - VOLUME_BANDED - fixedRecurringFee: - $ref: '#/components/schemas/GoogleTypeMoney' + result: + description: Result is available only after the query is completed. + $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQueryResult' + resultRows: + description: ResultRows is available only after the query is completed. + type: string + format: int64 + resultFileSize: + description: ResultFileSize is available only after the query is completed. + type: string + executionTime: + description: ExecutionTime is available only after the query is completed. + type: string + error: + description: Error is set when query fails. + type: string + queryParams: description: >- - Fixed amount that is charged at a defined interval and billed in - advance of use of the API product. The fee will be prorated for the - first billing period. - currencyCode: + Contains information like metrics, dimenstions etc of the + AsyncQuery. + $ref: '#/components/schemas/GoogleCloudApigeeV1QueryMetadata' + reportDefinitionId: + description: Asynchronous Report ID. + type: string + name: + description: Asynchronous Query Name. + type: string + envgroupHostname: + description: Hostname is available only when query is executed at host level. + type: string + GoogleCloudApigeeV1AsyncQueryResult: + id: GoogleCloudApigeeV1AsyncQueryResult + type: object + properties: + self: description: >- - Currency to be used for billing. Consists of a three-letter code as - defined by the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) - standard. + Self link of the query results. Example: + `/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result` + or following format if query is running at host level: + `/organizations/myorg/hostQueries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result` type: string - description: Rate plan details. - GoogleCloudApigeeV1ScoreComponent: - description: Component is an individual security element that is scored. - id: GoogleCloudApigeeV1ScoreComponent + expires: + description: Query result will be unaccessable after this time. + type: string + GoogleCloudApigeeV1QueryMetadata: + id: GoogleCloudApigeeV1QueryMetadata + type: object properties: - drilldownPaths: - description: List of paths for next components. + metrics: + description: >- + Metrics of the AsyncQuery. Example: + ["name:message_count,func:sum,alias:sum_message_count"] + type: array items: type: string + dimensions: + description: Dimensions of the AsyncQuery. type: array - score: - description: Score for the component. - type: integer - format: int32 - calculateTime: - format: google-datetime - description: Time when score was calculated. + items: + type: string + startTimestamp: + description: Start timestamp of the query range. type: string - scorePath: + endTimestamp: + description: End timestamp of the query range. type: string - description: >- - Path of the component. Example: - /org@myorg/envgroup@myenvgroup/proxies/proxy@myproxy - dataCaptureTime: + outputFormat: + description: Output format. type: string - format: google-datetime - description: >- - Time in the requested time period when data was last captured to - compute the score. - recommendations: + timeUnit: + description: Query GroupBy time unit. + type: string + GoogleCloudApigeeV1GetAsyncQueryResultUrlResponse: + id: GoogleCloudApigeeV1GetAsyncQueryResultUrlResponse + description: The response for GetAsyncQueryResultUrl + type: object + properties: + urls: + description: The list of Signed URLs generated by the CreateAsyncQuery request type: array - description: List of recommendations to improve API security. items: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ScoreComponentRecommendation + #/components/schemas/GoogleCloudApigeeV1GetAsyncQueryResultUrlResponseURLInfo + GoogleCloudApigeeV1GetAsyncQueryResultUrlResponseURLInfo: + id: GoogleCloudApigeeV1GetAsyncQueryResultUrlResponseURLInfo + description: A Signed URL and the relevant metadata associated with it. type: object - GoogleCloudApigeeV1SecurityActionConditionConfig: - description: >- - The following are a list of conditions. A valid SecurityAction must - contain at least one condition. Within a condition, each element is - ORed. Across conditions elements are ANDed. For example if a - SecurityAction has the following: ip_address_ranges: ["ip1", "ip2"] and - bot_reasons: ["Flooder", "Robot Abuser"] then this is interpreted as: - enforce the action if the incoming request has ((ip_address_ranges = - "ip1" OR ip_address_ranges = "ip2") AND (bot_reasons="Flooder" OR - bot_reasons="Robot Abuser")). Conditions other than ip_address_ranges - and bot_reasons cannot be ANDed. properties: - asns: - items: - type: string - format: int64 - type: array + uri: description: >- - Optional. A list of ASN numbers to act on, e.g. 23. - https://en.wikipedia.org/wiki/Autonomous_system_(Internet) This uses - int64 instead of uint32 because of - https://linter.aip.dev/141/forbidden-types. - accessTokens: - type: array - items: - type: string - description: Optional. A list of access_tokens. Limit 1000 per action. - developers: - items: - type: string + The signed URL of the JSON data. Will be of the form + `https://storage.googleapis.com/example-bucket/cat.jpeg?X-Goog-Algorithm= + GOOG4-RSA-SHA256&X-Goog-Credential=example%40example-project.iam.gserviceaccount + .com%2F20181026%2Fus-central1%2Fstorage%2Fgoog4_request&X-Goog-Date=20181026T18 + 1309Z&X-Goog-Expires=900&X-Goog-SignedHeaders=host&X-Goog-Signature=247a2aa45f16 + 9edf4d187d54e7cc46e4731b1e6273242c4f4c39a1d2507a0e58706e25e3a85a7dbb891d62afa849 + 6def8e260c1db863d9ace85ff0a184b894b117fe46d1225c82f2aa19efd52cf21d3e2022b3b868dc + c1aca2741951ed5bf3bb25a34f5e9316a2841e8ff4c530b22ceaa1c5ce09c7cbb5732631510c2058 + 0e61723f5594de3aea497f195456a2ff2bdd0d13bad47289d8611b6f9cfeef0c46c91a455b94e90a + 66924f722292d21e24d31dcfb38ce0c0f353ffa5a9756fc2a9f2b40bc2113206a81e324fc4fd6823 + a29163fa845c8ae7eca1fcf6e5bb48b3200983c56c5ca81fffb151cca7402beddfc4a76b13344703 + 2ea7abedc098d2eb14a7` + type: string + md5: + description: The MD5 Hash of the JSON data + type: string + sizeBytes: + description: The size of the returned file in bytes + type: string + format: int64 + GoogleCloudApigeeV1ListAsyncQueriesResponse: + id: GoogleCloudApigeeV1ListAsyncQueriesResponse + description: The response for ListAsyncQueries. + type: object + properties: + queries: + description: The asynchronous queries belong to requested resource name. type: array - description: Optional. A list of developers. Limit 1000 per action. - userAgents: items: - type: string + $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQuery' + GoogleCloudApigeeV1AsyncQueryResultView: + id: GoogleCloudApigeeV1AsyncQueryResultView + type: object + properties: + metadata: description: >- - Optional. A list of user agents to deny. We look for exact matches. - Limit 50 per action. - type: array - apiProducts: + Metadata contains information like metrics, dimenstions etc of the + AsyncQuery. + $ref: '#/components/schemas/GoogleCloudApigeeV1QueryMetadata' + rows: + description: >- + Rows of query result. Each row is a JSON object. Example: + {sum(message_count): 1, developer_app: "(not set)",…} type: array items: - type: string - description: Optional. A list of API Products. Limit 1000 per action. - ipAddressRanges: + type: any + state: + description: State of retrieving ResultView. + type: string + code: + description: Error code when there is a failure. + type: integer + format: int32 + error: + description: Error message when there is a failure. + type: string + GoogleCloudApigeeV1CustomReport: + id: GoogleCloudApigeeV1CustomReport + type: object + properties: + name: description: >- - Optional. A list of IP addresses. This could be either IPv4 or IPv6. - Limited to 100 per action. - items: - type: string - type: array - regionCodes: + Required. Unique identifier for the report T his is a legacy field + used to encode custom report unique id + type: string + displayName: + description: This is the display name for the report + type: string + metrics: + description: Required. This contains the list of metrics type: array - description: >- - Optional. A list of countries/region codes to act on, e.g. US. This - follows https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2. items: - type: string - developerApps: + $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReportMetric' + dimensions: + description: This contains the list of dimensions for the report type: array - description: Optional. A list of developer apps. Limit 1000 per action. items: type: string - apiKeys: + filter: + description: This field contains the filter expression + type: string + createdAt: + description: 'Output only. Unix time when the app was created json key: createdAt' + readOnly: true + type: string + format: int64 + lastModifiedAt: + description: >- + Output only. Modified time of this entity as milliseconds since + epoch. json key: lastModifiedAt + readOnly: true + type: string + format: int64 + properties: + description: This field contains report properties such as ui metadata etc. type: array items: - type: string - description: Optional. A list of API keys. Limit 1000 per action. - botReasons: + $ref: '#/components/schemas/GoogleCloudApigeeV1ReportProperty' + chartType: + description: This field contains the chart type for the report + type: string + timeUnit: + description: This field contains the time unit of aggregation for the report + type: string + sortByCols: + description: 'Legacy field: not used much. Contains the list of sort by columns' type: array items: type: string + sortOrder: description: >- - Optional. A list of Bot Reasons. Current options: Flooder, Brute - Guessor, Static Content Scraper, OAuth Abuser, Robot Abuser, - TorListRule, Advanced Anomaly Detection, Advanced API Scraper, - Search Engine Crawlers, Public Clouds, Public Cloud AWS, Public - Cloud Azure, and Public Cloud Google. - httpMethods: - type: array - description: >- - Optional. Act only on particular HTTP methods. E.g. A read-only API - can block POST/PUT/DELETE methods. Accepted values are: GET, HEAD, - POST, PUT, DELETE, CONNECT, OPTIONS, TRACE and PATCH. - items: - type: string - type: object - id: GoogleCloudApigeeV1SecurityActionConditionConfig - GoogleCloudApigeeV1ListAppGroupAppsResponse: - id: GoogleCloudApigeeV1ListAppGroupAppsResponse - description: Response for ListAppGroupApps - properties: - nextPageToken: + Legacy field: not used much. Contains the sort order for the sort + columns type: string - description: >- - Token that can be sent as `next_page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. - appGroupApps: - description: List of AppGroup apps and their credentials. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' - type: array - type: object - GoogleCloudApigeeV1NodeConfig: - type: object - id: GoogleCloudApigeeV1NodeConfig - description: >- - NodeConfig for setting the min/max number of nodes associated with the - environment. - properties: - currentAggregateNodeCount: - readOnly: true - description: >- - Output only. The current total number of gateway nodes that each - environment currently has across all instances. - format: int64 + fromTime: + description: 'Legacy field: not used. Contains the from time for the report' type: string - maxNodeCount: - format: int64 + toTime: + description: 'Legacy field: not used. Contains the end time for the report' + type: string + offset: + description: 'Legacy field: not used. This field contains the offset for the data' + type: string + limit: description: >- - Optional. The maximum total number of gateway nodes that the is - reserved for all instances that has the specified environment. If - not specified, the default is determined by the recommended maximum - number of nodes for that gateway. + Legacy field: not used This field contains the limit for the result + retrieved type: string - minNodeCount: - format: int64 + topk: description: >- - Optional. The minimum total number of gateway nodes that the is - reserved for all instances that has the specified environment. If - not specified, the default is determined by the recommended minimum - number of nodes for that gateway. + Legacy field: not used. This field contains the top k parameter + value for restricting the result type: string - GoogleCloudApigeeV1SchemaSchemaProperty: - properties: - type: + organization: + description: Output only. Organization name + readOnly: true type: string - description: Data type of the field. - custom: + environment: + description: Output only. Environment name + readOnly: true type: string + lastViewedAt: description: >- - Flag that specifies whether the field is standard in the dataset or - a custom field created by the customer. `true` indicates that it is - a custom field. - createTime: + Output only. Last viewed time of this entity as milliseconds since + epoch + readOnly: true type: string + format: int64 + tags: description: >- - Time the field was created in RFC3339 string form. For example: - `2016-02-26T10:23:09.592Z`. - description: Properties for the schema field. - id: GoogleCloudApigeeV1SchemaSchemaProperty + Legacy field: not used. This field contains a list of tags + associated with custom report + type: array + items: + type: string + comments: + description: >- + Legacy field: not used. This field contains a list of comments + associated with custom report + type: array + items: + type: string + GoogleCloudApigeeV1CustomReportMetric: + id: GoogleCloudApigeeV1CustomReportMetric + description: >- + This encapsulates a metric property of the form sum(message_count) where + name is message_count and function is sum type: object - GoogleCloudApigeeV1KeyValueEntry: properties: name: + description: name of the metric type: string - description: >- - Resource URI that can be used to identify the scope of the key value - map entries. - value: - description: >- - Required. Data or payload that is being retrieved and associated - with the unique key. + function: + description: aggregate function type: string + GoogleCloudApigeeV1ReportProperty: + id: GoogleCloudApigeeV1ReportProperty type: object - description: >- - Key value map pair where the value represents the data associated with - the corresponding key. **Note**: Supported for Apigee hybrid 1.8.x and - higher. - id: GoogleCloudApigeeV1KeyValueEntry - GoogleCloudApigeeV1DeleteResponse: - id: GoogleCloudApigeeV1DeleteResponse - description: Response for certain delete operations. properties: - requestId: + property: + description: name of the property type: string - description: Unique ID of the request. - status: - description: Status of the operation. + value: + description: property values + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + GoogleCloudApigeeV1ListCustomReportsResponse: + id: GoogleCloudApigeeV1ListCustomReportsResponse + description: This message encapsulates a list of custom report definitions + type: object + properties: + qualifier: + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' + GoogleCloudApigeeV1DeleteCustomReportResponse: + id: GoogleCloudApigeeV1DeleteCustomReportResponse + type: object + properties: + message: + description: The response contains only a message field. type: string - errorCode: + GoogleCloudApigeeV1ExportRequest: + id: GoogleCloudApigeeV1ExportRequest + description: Request body for [CreateExportRequest] + type: object + properties: + name: + description: Required. Display name of the export job. type: string - description: Unique error code for the request, if any. - message: - description: Description of the operation. + description: + description: Optional. Description of the export job. type: string - gcpResource: + dateRange: + description: Required. Date range of the data to export. + $ref: '#/components/schemas/GoogleCloudApigeeV1DateRange' + outputFormat: + description: >- + Optional. Output format of the export. Valid values include: `csv` + or `json`. Defaults to `json`. Note: Configure the delimiter for CSV + output using the `csvDelimiter` property. type: string - description: Google Cloud name of deleted resource. + csvDelimiter: + description: >- + Optional. Delimiter used in the CSV file, if `outputFormat` is set + to `csv`. Defaults to the `,` (comma) character. Supported delimiter + characters include comma (`,`), pipe (`|`), and tab (`\t`). + type: string + datastoreName: + description: Required. Name of the preconfigured datastore. + type: string + GoogleCloudApigeeV1DateRange: + id: GoogleCloudApigeeV1DateRange + description: Date range of the data to export. type: object - GoogleCloudApigeeV1AnalyticsConfig: + properties: + start: + description: >- + Required. Start date of the data to export in the format + `yyyy-mm-dd`. The date range begins at 00:00:00 UTC on the start + date. + type: string + end: + description: >- + Required. End date (exclusive) of the data to export in the format + `yyyy-mm-dd`. The date range ends at 00:00:00 UTC on the end date- + which will not be in the output. + type: string + GoogleCloudApigeeV1Export: + id: GoogleCloudApigeeV1Export + description: Details of an export job. type: object - id: GoogleCloudApigeeV1AnalyticsConfig properties: - updateTime: - description: Output only. The latest update time. - format: google-datetime + self: + description: >- + Output only. Self link of the export job. A URI that can be used to + retrieve the status of an export job. Example: + `/organizations/myorg/environments/myenv/analytics/exports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` + readOnly: true + type: string + name: + description: Display name of the export job. + type: string + description: + description: Description of the export job. + type: string + datastoreName: + description: >- + Name of the datastore that is the destination of the export job + [datastore] type: string + created: + description: Output only. Time the export job was created. readOnly: true - state: - enum: - - ADDON_STATE_UNSPECIFIED - - ENABLING - - ENABLED - - DISABLING - - DISABLED type: string - enumDescriptions: - - Default value. - - Add-on is in progress of enabling. - - Add-on is fully enabled and ready to use. - - Add-on is in progress of disabling. - - Add-on is fully disabled. + updated: + description: Output only. Time the export job was last updated. readOnly: true - description: Output only. The state of the Analytics add-on. - expireTimeMillis: + type: string + executionTime: + description: >- + Output only. Execution time for this export job. If the job is still + in progress, it will be set to the amount of time that has elapsed + since`created`, in seconds. Else, it will set to (`updated` - + `created`), in seconds. readOnly: true type: string - format: int64 + state: description: >- - Output only. Time at which the Analytics add-on expires in - milliseconds since epoch. If unspecified, the add-on will never - expire. - enabled: - description: Whether the Analytics add-on is enabled. - type: boolean - description: Configuration for the Analytics add-on. - GoogleCloudApigeeV1ListTraceConfigOverridesResponse: + Output only. Status of the export job. Valid values include + `enqueued`, `running`, `completed`, and `failed`. + readOnly: true + type: string + error: + description: Output only. Error is set when export fails + readOnly: true + type: string + GoogleCloudApigeeV1ListExportsResponse: + id: GoogleCloudApigeeV1ListExportsResponse + description: The response for ListExports type: object - description: Response for ListTraceConfigOverrides. - id: GoogleCloudApigeeV1ListTraceConfigOverridesResponse properties: - traceConfigOverrides: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' - description: List all trace configuration overrides in an environment. + exports: + description: Details of the export jobs. type: array - nextPageToken: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Export' + GoogleCloudApigeeV1Datastore: + id: GoogleCloudApigeeV1Datastore + description: >- + The data store defines the connection to export data repository (Cloud + Storage, BigQuery), including the credentials used to access the data + repository. + type: object + properties: + self: description: >- - Token value that can be passed as `page_token` to retrieve the next - page of content. + Output only. Resource link of Datastore. Example: + `/organizations/{org}/analytics/datastores/{uuid}` + readOnly: true type: string - GoogleCloudApigeeV1SecurityActionDeny: + displayName: + description: Required. Display name in UI + type: string + org: + description: Output only. Organization that the datastore belongs to + readOnly: true + type: string + targetType: + description: Destination storage type. Supported types `gcs` or `bigquery`. + type: string + createTime: + description: >- + Output only. Datastore create time, in milliseconds since the epoch + of 1970-01-01T00:00:00Z + readOnly: true + type: string + format: int64 + lastUpdateTime: + description: >- + Output only. Datastore last update time, in milliseconds since the + epoch of 1970-01-01T00:00:00Z + readOnly: true + type: string + format: int64 + datastoreConfig: + description: Datastore Configurations. + $ref: '#/components/schemas/GoogleCloudApigeeV1DatastoreConfig' + GoogleCloudApigeeV1DatastoreConfig: + id: GoogleCloudApigeeV1DatastoreConfig + description: Configuration detail for datastore + type: object properties: - responseCode: - format: int32 - type: integer - description: Optional. The HTTP response code if the Action = DENY. - description: Message that should be set in case of a Deny Action. + projectId: + description: Required. Google Cloud project in which the datastore exists + type: string + bucketName: + description: Name of the Cloud Storage bucket. Required for `gcs` target_type. + type: string + path: + description: Path of Cloud Storage bucket Required for `gcs` target_type. + type: string + datasetName: + description: BigQuery dataset name Required for `bigquery` target_type. + type: string + tablePrefix: + description: Prefix of BigQuery table Required for `bigquery` target_type. + type: string + GoogleCloudApigeeV1TestDatastoreResponse: + id: GoogleCloudApigeeV1TestDatastoreResponse + description: The response for TestDatastore type: object - id: GoogleCloudApigeeV1SecurityActionDeny - GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict: properties: - description: - description: Human-readable description of this conflict. + state: + description: Output only. It could be `completed` or `failed` + readOnly: true type: string - environmentGroup: + error: + description: Output only. Error message of test connection failure + readOnly: true type: string - description: Name of the environment group in which this conflict exists. - conflictingDeployment: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment - description: Existing base path/deployment causing the conflict. - id: GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict + GoogleCloudApigeeV1ListDatastoresResponse: + id: GoogleCloudApigeeV1ListDatastoresResponse + description: The response for ListDatastores type: object - description: >- - Describes a routing conflict that may cause a deployment not to receive - traffic at some base path. - GoogleCloudApigeeV1MonetizationConfig: properties: - enabled: - type: boolean - description: Flag that specifies whether the Monetization add-on is enabled. - description: Configuration for the Monetization add-on. - type: object - id: GoogleCloudApigeeV1MonetizationConfig - GoogleCloudApigeeV1DeveloperMonetizationConfig: - type: object - description: Monetization configuration for the developer. - properties: - billingType: - type: string - description: Billing type. - enumDescriptions: - - The default/unset value. - - >- - Developer pays in advance for the use of APIs and the charged - amount is deducted from their account balance. - - >- - Developer does not maintain an account balance. The API provider - bills the developer for API usage. - enum: - - BILLING_TYPE_UNSPECIFIED - - PREPAID - - POSTPAID - id: GoogleCloudApigeeV1DeveloperMonetizationConfig - GoogleCloudApigeeV1OperationConfig: - description: >- - Binds the resources in an API proxy or remote service with the allowed - REST methods and associated quota enforcement. + datastores: + description: A list of datastores + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' + GoogleCloudApigeeV1DeveloperAppKey: + id: GoogleCloudApigeeV1DeveloperAppKey type: object properties: - quota: - $ref: '#/components/schemas/GoogleCloudApigeeV1Quota' + apiProducts: description: >- - Quota parameters to be enforced for the resources, methods, and API - source combination. If none are specified, quota enforcement will - not be done. - operations: + List of API products for which the credential can be used. **Note**: + Do not specify the list of API products when creating a consumer key + and secret for a developer app. Instead, use the + UpdateDeveloperAppKey API to make the association after the consumer + key and secret are created. type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Operation' - description: >- - List of resource/method pairs for the API proxy or remote service to - which quota will applied. **Note**: Currently, you can specify only - a single resource/method pair. The call will fail if more than one - resource/method pair is provided. + type: any attributes: - description: Custom attributes associated with the operation. + description: List of attributes associated with the credential. + type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - type: array - apiSource: - description: >- - Required. Name of the API proxy or remote service with which the - resources, methods, and quota are associated. + consumerKey: + description: Consumer key. type: string - id: GoogleCloudApigeeV1OperationConfig - GoogleCloudApigeeV1TargetServer: - type: object - properties: - protocol: - description: Immutable. The protocol used by this TargetServer. + consumerSecret: + description: Secret key. type: string - enumDescriptions: - - UNSPECIFIED defaults to HTTP for backwards compatibility. - - The TargetServer uses HTTP. - - The TargetSever uses HTTP2. - - The TargetServer uses GRPC. - - >- - GRPC TargetServer to be used in ExternalCallout Policy. Prefer to - use EXTERNAL_CALLOUT instead. TODO(b/266125112) deprecate once - EXTERNAL _CALLOUT generally available. - - The TargetServer is to be used in the ExternalCallout Policy - enum: - - PROTOCOL_UNSPECIFIED - - HTTP - - HTTP2 - - GRPC_TARGET - - GRPC - - EXTERNAL_CALLOUT - name: - description: >- - Required. The resource id of this target server. Values must match - the regular expression + expiresAt: + description: Time the developer app expires in milliseconds since epoch. type: string - sSLInfo: - description: >- - Optional. Specifies TLS configuration info for this TargetServer. - The JSON name is `sSLInfo` for legacy/backwards compatibility - reasons -- Edge originally supported SSL, and the name is still used - for TLS configuration. - $ref: '#/components/schemas/GoogleCloudApigeeV1TlsInfo' - host: + format: int64 + issuedAt: + description: Time the developer app was created in milliseconds since epoch. type: string + format: int64 + scopes: description: >- - Required. The host name this target connects to. Value must be a - valid hostname as described by RFC-1123. - isEnabled: + Scopes to apply to the app. The specified scope names must already + be defined for the API product that you associate with the app. + type: array + items: + type: string + status: description: >- - Optional. Enabling/disabling a TargetServer is useful when - TargetServers are used in load balancing configurations, and one or - more TargetServers need to taken out of rotation periodically. - Defaults to true. - type: boolean - description: + Status of the credential. Valid values include `approved` or + `revoked`. type: string - description: Optional. A human-readable description of this TargetServer. - port: - format: int32 + expiresInSeconds: description: >- - Required. The port number this target connects to on the given host. - Value must be between 1 and 65535, inclusive. - type: integer - id: GoogleCloudApigeeV1TargetServer - description: >- - TargetServer configuration. TargetServers are used to decouple a proxy - TargetEndpoint HTTPTargetConnections from concrete URLs for backend - services. - GoogleCloudApigeeV1CustomReport: - id: GoogleCloudApigeeV1CustomReport - properties: - organization: - description: Output only. Organization name - readOnly: true - type: string - limit: + Input only. Expiration time, in seconds, for the consumer key. If + not set or left to the default value of `-1`, the API key never + expires. The expiration time can't be updated after it is set. type: string + format: int64 + GoogleCloudApigeeV1DeveloperApp: + id: GoogleCloudApigeeV1DeveloperApp + type: object + properties: + appId: description: >- - Legacy field: not used This field contains the limit for the result - retrieved - fromTime: + ID of the developer app. This ID is not user specified but is + automatically generated on app creation. appId is a UUID. type: string - description: 'Legacy field: not used. Contains the from time for the report' - properties: - description: This field contains report properties such as ui metadata etc. - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ReportProperty' - comments: + attributes: + description: List of attributes for the developer app. type: array items: - type: string + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + callbackUrl: description: >- - Legacy field: not used. This field contains a list of comments - associated with custom report - filter: - description: This field contains the filter expression + Callback URL used by OAuth 2.0 authorization servers to communicate + authorization codes back to developer apps. type: string - dimensions: - items: - type: string - description: This contains the list of dimensions for the report - type: array createdAt: - type: string - format: int64 - description: 'Output only. Unix time when the app was created json key: createdAt' - readOnly: true - topk: - description: >- - Legacy field: not used. This field contains the top k parameter - value for restricting the result - type: string - displayName: - type: string - description: This is the display name for the report - sortOrder: description: >- - Legacy field: not used much. Contains the sort order for the sort - columns + Output only. Time the developer app was created in milliseconds + since epoch. + readOnly: true type: string - lastModifiedAt: format: int64 + credentials: description: >- - Output only. Modified time of this entity as milliseconds since - epoch. json key: lastModifiedAt + Output only. Set of credentials for the developer app consisting of + the consumer key/secret pairs associated with the API products. readOnly: true + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Credential' + developerId: + description: ID of the developer. type: string - environment: - type: string - description: Output only. Environment name + lastModifiedAt: + description: >- + Output only. Time the developer app was modified in milliseconds + since epoch. readOnly: true - toTime: - type: string - description: 'Legacy field: not used. Contains the end time for the report' - timeUnit: type: string - description: This field contains the time unit of aggregation for the report + format: int64 name: + description: Name of the developer app. type: string + scopes: description: >- - Required. Unique identifier for the report T his is a legacy field - used to encode custom report unique id - chartType: - type: string - description: This field contains the chart type for the report - metrics: + Scopes to apply to the developer app. The specified scopes must + already exist for the API product that you associate with the + developer app. type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReportMetric' - description: Required. This contains the list of metrics - sortByCols: - description: 'Legacy field: not used much. Contains the list of sort by columns' items: type: string - type: array - lastViewedAt: + status: + description: >- + Status of the credential. Valid values include `approved` or + `revoked`. type: string + keyExpiresIn: description: >- - Output only. Last viewed time of this entity as milliseconds since - epoch - readOnly: true + Expiration time, in milliseconds, for the consumer key that is + generated for the developer app. If not set or left to the default + value of `-1`, the API key never expires. The expiration time can't + be updated after it is set. + type: string format: int64 - offset: - description: 'Legacy field: not used. This field contains the offset for the data' + appFamily: + description: Developer app family. type: string - tags: + apiProducts: + description: List of API products associated with the developer app. type: array items: type: string - description: >- - Legacy field: not used. This field contains a list of tags - associated with custom report + GoogleCloudApigeeV1ListDeveloperAppsResponse: + id: GoogleCloudApigeeV1ListDeveloperAppsResponse type: object - GoogleCloudApigeeV1Query: properties: - metrics: - description: A list of Metrics. + app: + description: List of developer apps and their credentials. type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1QueryMetric' - filter: - type: string - description: >- - Boolean expression that can be used to filter data. Filter - expressions can be combined using AND/OR terms and should be fully - parenthesized to avoid ambiguity. See Analytics metrics, dimensions, - and filters reference - https://docs.apigee.com/api-platform/analytics/analytics-reference - for more information on the fields available to filter on. For more - information on the tokens that you use to build filter expressions, - see Filter expression syntax. - https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax - timeRange: + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' + GoogleCloudApigeeV1Developer: + id: GoogleCloudApigeeV1Developer + type: object + properties: + email: description: >- - Required. Time range for the query. Can use the following predefined - strings to specify the time range: `last60minutes` `last24hours` - `last7days` Or, specify the timeRange as a structure describing - start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. - Example: "timeRange": { "start": "2018-07-29T00:13:00Z", "end": - "2018-08-01T00:18:00Z" } - type: any - reportDefinitionId: + Required. Email address of the developer. This value is used to + uniquely identify the developer in Apigee hybrid. Note that the + email address has to be in lowercase only. type: string - description: Asynchronous Report ID. - name: - description: Asynchronous Query Name. + firstName: + description: Required. First name of the developer. type: string - dimensions: + lastName: + description: Required. Last name of the developer. + type: string + userName: + description: Required. User name of the developer. Not used by Apigee hybrid. + type: string + attributes: + description: >- + Optional. Developer attributes (name/value pairs). The custom + attribute limit is 18. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + apps: + description: List of apps associated with the developer. + type: array items: type: string - description: >- - A list of dimensions. - https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions + companies: + description: List of companies associated with the developer. type: array - limit: - description: Maximum number of rows that can be returned in the result. - type: integer - format: int32 - groupByTimeUnit: + items: + type: string + developerId: + description: >- + ID of the developer. **Note**: IDs are generated internally by + Apigee and are not guaranteed to stay the same over time. type: string + organizationName: description: >- - Time unit used to group the result set. Valid values include: - second, minute, hour, day, week, or month. If a query includes - groupByTimeUnit, then the result is an aggregation based on the - specified time unit and the resultant timestamp does not include - milliseconds precision. If a query omits groupByTimeUnit, then the - resultant timestamp includes milliseconds precision. - outputFormat: + Output only. Name of the Apigee organization in which the developer + resides. + readOnly: true type: string + status: description: >- - Valid values include: `csv` or `json`. Defaults to `json`. Note: - Configure the delimiter for CSV output using the csvDelimiter - property. - envgroupHostname: + Output only. Status of the developer. Valid values are `active` and + `inactive`. + readOnly: true + type: string + createdAt: description: >- - Hostname needs to be specified if query intends to run at host - level. This field is only allowed when query is submitted by - CreateHostAsyncQuery where analytics data will be grouped by - organization and hostname. + Output only. Time at which the developer was created in milliseconds + since epoch. + readOnly: true type: string - csvDelimiter: + format: int64 + lastModifiedAt: description: >- - Delimiter used in the CSV file, if `outputFormat` is set to `csv`. - Defaults to the `,` (comma) character. Supported delimiter - characters include comma (`,`), pipe (`|`), and tab (`\t`). + Output only. Time at which the developer was last modified in + milliseconds since epoch. + readOnly: true type: string - id: GoogleCloudApigeeV1Query - type: object - GoogleCloudApigeeV1ProfileConfigAbuse: - properties: {} - description: >- - Checks for abuse, which includes any requests sent to the API for - purposes other than what it is intended for, such as high volumes of - requests, data scraping, and abuse related to authorization. - id: GoogleCloudApigeeV1ProfileConfigAbuse - type: object - GoogleCloudApigeeV1ProfileConfigMTLS: - type: object - description: Checks to see if you have configured mTLS for the target server. - properties: {} - id: GoogleCloudApigeeV1ProfileConfigMTLS - GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestIncludeAll: - properties: {} - id: >- - GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestIncludeAll + format: int64 + accessType: + description: Access type. + type: string + appFamily: + description: Developer app family. + type: string + GoogleCloudApigeeV1ListOfDevelopersResponse: + id: GoogleCloudApigeeV1ListOfDevelopersResponse type: object - description: Message for include_all option. - GoogleCloudApigeeV1AdvancedApiOpsConfig: + properties: + developer: + description: List of developers. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' + GoogleCloudApigeeV1DeveloperMonetizationConfig: + id: GoogleCloudApigeeV1DeveloperMonetizationConfig + description: Monetization configuration for the developer. type: object properties: - enabled: - type: boolean - description: Flag that specifies whether the Advanced API Ops add-on is enabled. - id: GoogleCloudApigeeV1AdvancedApiOpsConfig - description: Configuration for the Advanced API Ops add-on. - GoogleCloudApigeeV1SecurityReportResultView: + billingType: + description: Billing type. + type: string + enumDescriptions: + - The default/unset value. + - >- + Developer pays in advance for the use of APIs and the charged + amount is deducted from their account balance. + - >- + Developer does not maintain an account balance. The API provider + bills the developer for API usage. + enum: + - BILLING_TYPE_UNSPECIFIED + - PREPAID + - POSTPAID + GoogleCloudApigeeV1DeveloperBalance: + id: GoogleCloudApigeeV1DeveloperBalance + description: Account balance for the developer. type: object properties: - code: - type: integer - format: int32 - description: Error code when there is a failure. - rows: + wallets: description: >- - Rows of security report result. Each row is a JSON object. Example: - {sum(message_count): 1, developer_app: "(not set)",…} - items: - type: any + Output only. List of all wallets. Each individual wallet stores the + account balance for a particular currency. + readOnly: true type: array - metadata: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportMetadata' + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperBalanceWallet' + GoogleCloudApigeeV1DeveloperBalanceWallet: + id: GoogleCloudApigeeV1DeveloperBalanceWallet + description: Wallet used to manage an account balance for a particular currency. + type: object + properties: + balance: description: >- - Metadata contains information like metrics, dimenstions etc of the - security report. - state: - description: State of retrieving ResultView. - type: string - error: - description: Error message when there is a failure. + Current remaining balance of the developer for a particular + currency. + $ref: '#/components/schemas/GoogleTypeMoney' + lastCreditTime: + description: >- + Output only. Time at which the developer last added credit to the + account in milliseconds since epoch. + readOnly: true type: string - description: The response for security report result view APIs. - id: GoogleCloudApigeeV1SecurityReportResultView - GoogleCloudApigeeV1DeploymentChangeReport: + format: int64 + GoogleTypeMoney: + id: GoogleTypeMoney + description: Represents an amount of money with its currency type. type: object properties: - routingConflicts: - description: All base path conflicts detected for a deployment request. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict - validationErrors: - $ref: '#/components/schemas/GoogleRpcPreconditionFailure' + currencyCode: + description: The three-letter currency code defined in ISO 4217. + type: string + units: description: >- - Validation errors that would cause the deployment change request to - be rejected. - routingChanges: - items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingChange - description: All routing changes that may result from a deployment request. - type: array - id: GoogleCloudApigeeV1DeploymentChangeReport - description: >- - Response for GenerateDeployChangeReport and - GenerateUndeployChangeReport. This report contains any validation - failures that would cause the deployment to be rejected, as well changes - and conflicts in routing that may occur due to the new deployment. The - existence of a routing warning does not necessarily imply that the - deployment request is bad, if the desired state of the deployment - request is to effect a routing change. The primary purposes of the - routing messages are: 1) To inform users of routing changes that may - have an effect on traffic currently being routed to other existing - deployments. 2) To warn users if some base path in the proxy will not - receive traffic due to an existing deployment having already claimed - that base path. The presence of routing conflicts/changes will not cause - non-dry-run DeployApiProxy/UndeployApiProxy requests to be rejected. - GoogleCloudApigeeV1ListApiCategoriesResponse: - description: 'The response for `ListApiCategoriesRequest`. Next ID: 6' - properties: - data: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategory' - type: array - description: The API category resources. - requestId: - type: string - description: Unique ID of the request. - status: - type: string - description: Status of the operation. - message: + The whole units of the amount. For example if `currencyCode` is + `"USD"`, then 1 unit is one US dollar. type: string - description: Description of the operation. - errorCode: - description: Unique error code for the request, if any. + format: int64 + nanos: + description: >- + Number of nano (10^-9) units of the amount. The value must be + between -999,999,999 and +999,999,999 inclusive. If `units` is + positive, `nanos` must be positive or zero. If `units` is zero, + `nanos` can be positive, zero, or negative. If `units` is negative, + `nanos` must be negative or zero. For example $-1.75 is represented + as `units`=-1 and `nanos`=-750,000,000. + type: integer + format: int32 + GoogleCloudApigeeV1CreditDeveloperBalanceRequest: + id: GoogleCloudApigeeV1CreditDeveloperBalanceRequest + description: Request for CreditDeveloperBalance. + type: object + properties: + transactionAmount: + description: >- + The amount of money to be credited. The wallet corresponding to the + currency specified within `transaction_amount` will be updated. For + example, if you specified `currency_code` within + `transaction_amount` as "USD", then the amount would be added to the + wallet which has the "USD" currency or if no such wallet exists, a + new wallet will be created with the "USD" currency. + $ref: '#/components/schemas/GoogleTypeMoney' + transactionId: + description: >- + Each transaction_id uniquely identifies a credit balance request. If + multiple requests are received with the same transaction_id, only + one of them will be considered. type: string - id: GoogleCloudApigeeV1ListApiCategoriesResponse + GoogleCloudApigeeV1AdjustDeveloperBalanceRequest: + id: GoogleCloudApigeeV1AdjustDeveloperBalanceRequest + description: Request for AdjustDeveloperBalance. type: object - GoogleCloudApigeeV1Metric: - id: GoogleCloudApigeeV1Metric + properties: + adjustment: + description: >- + * A positive value of `adjustment` means that that the API provider + wants to adjust the balance for an under-charged developer i.e. the + balance of the developer will decrease. * A negative value of + `adjustment` means that that the API provider wants to adjust the + balance for an over-charged developer i.e. the balance of the + developer will increase. + $ref: '#/components/schemas/GoogleTypeMoney' + GoogleCloudApigeeV1AppGroup: + id: GoogleCloudApigeeV1AppGroup + description: >- + AppGroup contains the request/response fields representing the logical + grouping of apps. Note that appgroup_id, create_time and update_time + cannot be changed by the user, and gets updated by the system. The name + and the organization once provided cannot be edited subsequently. type: object properties: + appGroupId: + description: Output only. Internal identifier that cannot be edited + readOnly: true + type: string name: + description: >- + Immutable. Name of the AppGroup. Characters you can use in the name + are restricted to: A-Z0-9._\-$ %. type: string - description: Metric name. - values: + channelUri: + description: A reference to the associated storefront/marketplace. + type: string + channelId: + description: channel identifier identifies the owner maintaing this grouping. + type: string + displayName: + description: app group name displayed in the UI + type: string + organization: + description: Immutable. the org the app group is created + type: string + status: description: >- - List of metric values. Possible value formats include: - `"values":["39.0"]` or `"values":[ { "value": "39.0", "timestamp": - 1232434354} ]` - items: - type: any + Valid values are `active` or `inactive`. Note that the status of the + AppGroup should be updated via UpdateAppGroupRequest by setting the + action as `active` or `inactive`. + type: string + attributes: + description: A list of attributes type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + createdAt: + description: Output only. Created time as milliseconds since epoch. + readOnly: true + type: string + format: int64 + lastModifiedAt: + description: Output only. Modified time as milliseconds since epoch. + readOnly: true + type: string + format: int64 + GoogleCloudApigeeV1ListAppGroupsResponse: + id: GoogleCloudApigeeV1ListAppGroupsResponse description: >- - Encapsulates the metric data point. For example: ```{ "name": - "sum(message_count)", "values" : [ { "timestamp": 1549004400000, - "value": "39.0" }, { "timestamp" : 1548997200000, "value" : "0.0" } ] - }``` or ```{ "name": "sum(message_count)", "values" : ["39.0"] }``` - GoogleCloudApigeeV1Deployment: - id: GoogleCloudApigeeV1Deployment + ListAppGroupsResponse contains the 0 or more AppGroups, along with the + optional page token and the total count of apps. + type: object properties: - pods: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1PodStatus' + appGroups: + description: List of AppGroups. type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' + nextPageToken: description: >- - Status reported by runtime pods. **Note**: **This field is - deprecated**. Runtime versions 1.3 and above report instance level - status rather than pod status. - environment: + Token that can be sent as `next_page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. type: string - description: Environment. - revision: - description: API proxy revision. + totalSize: + description: Total count of AppGroups. + type: integer + format: int32 + GoogleCloudApigeeV1AppGroupApp: + id: GoogleCloudApigeeV1AppGroupApp + description: >- + Response for [GetAppGroupApp].[AppGroupApps.GetAppGroupApp], + [CreateAppGroupAppRequest].[AppGroupApp.CreateAppGroupAppRequest] and + [DeleteAppGroupApp].[AppGroupApp.DeleteAppGroupApp] + type: object + properties: + appId: + description: Immutable. ID of the AppGroup app. type: string - state: + attributes: + description: List of attributes for the AppGroup app. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + callbackUrl: description: >- - Current state of the deployment. **Note**: This field is displayed - only when viewing deployment status. - enum: - - RUNTIME_STATE_UNSPECIFIED - - READY - - PROGRESSING - - ERROR - enumDescriptions: - - This value should never be returned. - - Runtime has loaded the deployment. - - Deployment is not fully ready in the runtime. - - >- - Encountered an error with the deployment that requires - intervention. + Callback URL used by OAuth 2.0 authorization servers to communicate + authorization codes back to AppGroup apps. type: string - instances: + createdAt: description: >- - Status reported by each runtime instance. **Note**: This field is - displayed only when viewing deployment status. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1InstanceDeploymentStatus' + Output only. Time the AppGroup app was created in milliseconds since + epoch. + readOnly: true + type: string + format: int64 + credentials: + description: >- + Output only. Set of credentials for the AppGroup app consisting of + the consumer key/secret pairs associated with the API products. + readOnly: true type: array - routeConflicts: items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict + $ref: '#/components/schemas/GoogleCloudApigeeV1Credential' + lastModifiedAt: description: >- - Conflicts in the desired state routing configuration. The presence - of conflicts does not cause the state to be `ERROR`, but it will - mean that some of the deployment's base paths are not routed to its - environment. If the conflicts change, the state will transition to - `PROGRESSING` until the latest configuration is rolled out to all - instances. **Note**: This field is displayed only when viewing - deployment status. - type: array - apiProxy: - description: API proxy. + Output only. Time the AppGroup app was modified in milliseconds + since epoch. + readOnly: true type: string - serviceAccount: + format: int64 + name: description: >- - The full resource name of Cloud IAM Service Account that this - deployment is using, eg, `projects/-/serviceAccounts/{email}`. + Immutable. Name of the AppGroup app whose resource name format is of + syntax (organizations/*/appgroups/*/apps/*). type: string - errors: + scopes: description: >- - Errors reported for this deployment. Populated only when state == - ERROR. **Note**: This field is displayed only when viewing - deployment status. + Scopes to apply to the AppGroup app. The specified scopes must + already exist for the API product that you associate with the + AppGroup app. type: array items: - $ref: '#/components/schemas/GoogleRpcStatus' - deployStartTime: + type: string + status: + description: Status of the App. Valid values include `approved` or `revoked`. type: string - format: int64 + keyExpiresIn: description: >- - Time the API proxy was marked `deployed` in the control plane in - millisconds since epoch. - proxyDeploymentType: - enum: - - PROXY_DEPLOYMENT_TYPE_UNSPECIFIED - - STANDARD - - EXTENSIBLE - enumDescriptions: - - >- - Default value till public preview. After public preview this value - should not be returned. - - >- - Deployment will be of type Standard if only Standard proxies are - used - - >- - Proxy will be of type Extensible if deployments uses one or more - Extensible proxies - readOnly: true - description: >- - Output only. The type of the deployment (standard or extensible) - Deployed proxy revision will be marked as extensible in following 2 - cases. 1. The deployed proxy revision uses extensible policies. 2. - If a environment supports flowhooks and flow hook is configured. - type: string - type: object - EdgeConfigstoreBundleBadBundleViolation: - properties: - description: - type: string - description: A description of why the bundle is invalid and how to fix it. - filename: + Immutable. Expiration time, in seconds, for the consumer key that is + generated for the AppGroup app. If not set or left to the default + value of `-1`, the API key never expires. The expiration time can't + be updated after it is set. type: string + format: int64 + apiProducts: + description: List of API products associated with the AppGroup app. + type: array + items: + type: string + appGroup: description: >- - The filename (including relative path from the bundle root) in which - the error occurred. - id: EdgeConfigstoreBundleBadBundleViolation - description: A message type used to describe a single bundle validation error. - type: object - GoogleCloudApigeeV1OASDocumentation: + Immutable. Name of the parent AppGroup whose resource name format is + of syntax (organizations/*/appgroups/*). + type: string + GoogleCloudApigeeV1ListAppGroupAppsResponse: + id: GoogleCloudApigeeV1ListAppGroupAppsResponse + description: Response for ListAppGroupApps type: object - id: GoogleCloudApigeeV1OASDocumentation properties: - spec: + appGroupApps: + description: List of AppGroup apps and their credentials. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' + nextPageToken: description: >- - Required. The documentation file contents for the OpenAPI - Specification. JSON and YAML file formats are supported. - $ref: '#/components/schemas/GoogleCloudApigeeV1DocumentationFile' - format: - enumDescriptions: - - The format is not available. - - YAML format. - - JSON format. + Token that can be sent as `next_page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. type: string - readOnly: true - enum: - - FORMAT_UNSPECIFIED - - YAML - - JSON - description: Output only. The format of the input specification file contents. - description: OpenAPI Specification documentation for a catalog item. - GoogleCloudApigeeV1GraphQLOperationConfig: + GoogleCloudApigeeV1AppGroupAppKey: + id: GoogleCloudApigeeV1AppGroupAppKey description: >- - Binds the resources in a proxy or remote service with the GraphQL - operation and its associated quota enforcement. + AppGroupAppKey contains all the information associated with the + credentials. + type: object properties: - apiSource: - description: >- - Required. Name of the API proxy endpoint or remote service with - which the GraphQL operation and quota are associated. - type: string - quota: - $ref: '#/components/schemas/GoogleCloudApigeeV1Quota' + apiProducts: description: >- - Quota parameters to be enforced for the resources, methods, and API - source combination. If none are specified, quota enforcement will - not be done. + Output only. List of API products and its status for which the + credential can be used. **Note**: Use + UpdateAppGroupAppKeyApiProductRequest API to make the association + after the consumer key and secret are created. + readOnly: true + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1APIProductAssociation' attributes: + description: List of attributes associated with the credential. + type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - type: array - description: Custom attributes associated with the operation. - operations: + consumerKey: + description: Immutable. Consumer key. + type: string + consumerSecret: + description: Secret key. + type: string + expiresAt: description: >- - Required. List of GraphQL name/operation type pairs for the proxy or - remote service to which quota will be applied. If only operation - types are specified, the quota will be applied to all GraphQL - requests irrespective of the GraphQL name. **Note**: Currently, you - can specify only a single GraphQLOperation. Specifying more than one - will cause the operation to fail. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1GraphQLOperation' - type: array - type: object - id: GoogleCloudApigeeV1GraphQLOperationConfig - GoogleCloudApigeeV1EntityMetadata: - properties: - lastModifiedAt: + Output only. Time the AppGroup app expires in milliseconds since + epoch. + readOnly: true type: string format: int64 + issuedAt: description: >- - Time at which the API proxy was most recently modified, in - milliseconds since epoch. - subType: - description: The type of entity described - type: string - createdAt: + Output only. Time the AppGroup app was created in milliseconds since + epoch. + readOnly: true type: string format: int64 + scopes: description: >- - Time at which the API proxy was created, in milliseconds since - epoch. + Scopes to apply to the app. The specified scope names must already + be defined for the API product that you associate with the app. + type: array + items: + type: string + status: + description: >- + Status of the credential. Valid values include `approved` or + `revoked`. + type: string + expiresInSeconds: + description: >- + Immutable. Expiration time, in seconds, for the consumer key. If not + set or left to the default value of `-1`, the API key never expires. + The expiration time can't be updated after it is set. + type: string + format: int64 + GoogleCloudApigeeV1APIProductAssociation: + id: GoogleCloudApigeeV1APIProductAssociation + description: >- + APIProductAssociation has the API product and its administrative state + association. type: object - description: Metadata common to many entities in this API. - id: GoogleCloudApigeeV1EntityMetadata - GoogleCloudApigeeV1SecurityAssessmentResultScoringResult: properties: - dataUpdateTime: - format: google-datetime + apiproduct: + description: API product to be associated with the credential. + type: string + status: description: >- - The time when resource data was last fetched for this resource. This - time may be different than when the resource was actually updated - due to lag in data collection. + The API product credential associated status. Valid values are + `approved` or `revoked`. type: string - severity: + GoogleCloudApigeeV1UpdateAppGroupAppKeyRequest: + id: GoogleCloudApigeeV1UpdateAppGroupAppKeyRequest + description: Request for UpdateAppGroupAppKey + type: object + properties: + action: + description: >- + Approve or revoke the consumer key by setting this value to + `approve` or `revoke` respectively. The `Content-Type` header, if + set, must be set to `application/octet-stream`, with empty body. type: string - description: The severity of the assessment. - enum: - - SEVERITY_UNSPECIFIED - - LOW - - MEDIUM - - HIGH - - MINIMAL - enumDescriptions: - - Severity is not defined. - - Severity is low. - - Severity is medium. - - Severity is high. - - Severity is minimal - failedAssessmentPerWeight: - type: object - additionalProperties: - type: integer - format: int32 + appGroupAppKey: description: >- - The number of failed assessments grouped by its weight. Keys are one - of the following: "MAJOR", "MODERATE", "MINOR". - score: - description: The security score of the assessment. - format: int32 - type: integer - assessmentRecommendations: - type: object - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendation + Note that only Scopes and Attributes of the AppGroupAppKey can be + amended. Scopes and Attributes mentioned in the request will be + inserted and the existing scopes and attributes will be removed. + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' + apiProducts: description: >- - The recommendations of the assessment. The key is the "name" of the - assessment (not display_name), and the value are the - recommendations. - id: GoogleCloudApigeeV1SecurityAssessmentResultScoringResult - description: The result of the assessment. + The list of API products that will be associated with the + credential. This list will be appended to the existing list of + associated API Products for this App Key. Duplicates will be + ignored. + type: array + items: + type: string + GoogleCloudApigeeV1DeveloperSubscription: + id: GoogleCloudApigeeV1DeveloperSubscription + description: Structure of a DeveloperSubscription. type: object - GoogleCloudApigeeV1RuntimeConfig: properties: name: - description: >- - Name of the resource in the following format: - `organizations/{org}/runtimeConfig`. + description: Output only. Name of the API product subscription. + readOnly: true type: string - tenantProjectId: + apiproduct: + description: >- + Name of the API product for which the developer is purchasing a + subscription. type: string - readOnly: true + startTime: description: >- - Output only. Tenant project ID associated with the Apigee - organization. The tenant project is used to host Google-managed - resources that are dedicated to this Apigee organization. Clients - have limited access to resources within the tenant project used to - support Apigee runtime instances. Access to the tenant project is - managed using SetSyncAuthorization. It can be empty if the tenant - project hasn't been created yet. - analyticsBucket: - type: string - description: Cloud Storage bucket used for uploading Analytics records. - traceBucket: - description: Cloud Storage bucket used for uploading Trace records. - type: string - description: >- - Runtime configuration for the organization. Response for - GetRuntimeConfig. - type: object - id: GoogleCloudApigeeV1RuntimeConfig - GoogleCloudApigeeV1ListSecurityProfileRevisionsResponse: - type: object - description: Response for ListSecurityProfileRevisions. - properties: - securityProfiles: - type: array - description: >- - List of security profile revisions. The revisions may be attached or - unattached to any environment. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' - nextPageToken: - description: >- - A token that can be sent as `page_token` to retrieve the next page. - If this field is omitted, there are no subsequent pages. - type: string - id: GoogleCloudApigeeV1ListSecurityProfileRevisionsResponse - GoogleRpcPreconditionFailureViolation: - description: A message type used to describe a single precondition failure. - type: object - id: GoogleRpcPreconditionFailureViolation - properties: - subject: + Time when the API product subscription starts in milliseconds since + epoch. type: string + format: int64 + endTime: description: >- - The subject, relative to the type, that failed. For example, - "google.com/cloud" relative to the "TOS" type would indicate which - terms of service is being referenced. - type: + Time when the API product subscription ends in milliseconds since + epoch. type: string + format: int64 + createdAt: description: >- - The type of PreconditionFailure. We recommend using a - service-specific enum type to define the supported precondition - violation subjects. For example, "TOS" for "Terms of Service - violation". - description: + Output only. Time when the API product subscription was created in + milliseconds since epoch. + readOnly: true type: string + format: int64 + lastModifiedAt: description: >- - A description of how the precondition failed. Developers can use - this description to understand how to fix the failure. For example: - "Terms of service not accepted". - GoogleCloudApigeeV1ConfigVersion: - description: >- - Version of the API proxy configuration schema. Currently, only 4.0 is - supported. - properties: - majorVersion: - type: integer - description: Major version of the API proxy configuration schema. - format: int32 - minorVersion: - format: int32 - description: Minor version of the API proxy configuration schema. - type: integer - id: GoogleCloudApigeeV1ConfigVersion - type: object - GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRevision: - properties: - percentage: - format: int32 - type: integer - description: Percentage of MP replicas reporting this revision. - revision: + Output only. Time when the API product subscription was last + modified in milliseconds since epoch. + readOnly: true type: string - description: API proxy revision reported as deployed. - id: GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRevision - description: Revisions deployed in the MPs. - type: object - GoogleCloudApigeeV1ListSecurityIncidentsResponse: + format: int64 + GoogleCloudApigeeV1ListDeveloperSubscriptionsResponse: + id: GoogleCloudApigeeV1ListDeveloperSubscriptionsResponse + description: Response for ListDeveloperSubscriptions. type: object properties: - securityIncidents: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' + developerSubscriptions: + description: List of all subscriptions. type: array - description: List of security incidents in the organization - nextPageToken: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription' + nextStartKey: description: >- - A token that can be sent as `page_token` to retrieve the next page. - If this field is omitted, there are no subsequent pages. + Value that can be sent as `startKey` to retrieve the next page of + content. If this field is omitted, there are no subsequent pages. type: string - id: GoogleCloudApigeeV1ListSecurityIncidentsResponse - description: Response for ListSecurityIncidents. - GoogleCloudApigeeV1QueryTimeSeriesStatsResponse: - description: >- - Represents security stats result as a collection of time series - sequences. - id: GoogleCloudApigeeV1QueryTimeSeriesStatsResponse + GoogleCloudApigeeV1ExpireDeveloperSubscriptionRequest: + id: GoogleCloudApigeeV1ExpireDeveloperSubscriptionRequest + description: Request for ExpireDeveloperSubscription. + type: object + properties: {} + GoogleCloudApigeeV1SecurityReportQuery: + id: GoogleCloudApigeeV1SecurityReportQuery + description: Body structure when user makes a request to create a security report. + type: object properties: - values: + metrics: + description: A list of Metrics. type: array - description: Results of the query returned as a JSON array. items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1QueryTimeSeriesStatsResponseSequence - nextPageToken: - type: string - description: Next page token. - columns: - type: array + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportQueryMetric' + dimensions: description: >- - Column names corresponding to the same order as the inner values in - the stats field. + A list of dimensions. + https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions + type: array items: type: string - type: object - GoogleCloudApigeeV1SecurityAction: - id: GoogleCloudApigeeV1SecurityAction - description: >- - A SecurityAction is rule that can be enforced at an environment level. - The result is one of: - A denied API call - An explicitly allowed API - call - A flagged API call (HTTP headers added before the target receives - it) At least one condition is required to create a SecurityAction. - type: object - properties: - description: + timeRange: + description: >- + Required. Time range for the query. Can use the following predefined + strings to specify the time range: `last60minutes` `last24hours` + `last7days` Or, specify the timeRange as a structure describing + start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. + Example: "timeRange": { "start": "2018-07-29T00:13:00Z", "end": + "2018-08-01T00:18:00Z" } + type: any + filter: + description: >- + Boolean expression that can be used to filter data. Filter + expressions can be combined using AND/OR terms and should be fully + parenthesized to avoid ambiguity. See Analytics metrics, dimensions, + and filters reference + https://docs.apigee.com/api-platform/analytics/analytics-reference + for more information on the fields available to filter on. For more + information on the tokens that you use to build filter expressions, + see Filter expression syntax. + https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax type: string + groupByTimeUnit: description: >- - Optional. An optional user provided description of the - SecurityAction. - name: + Time unit used to group the result set. Valid values include: + second, minute, hour, day, week, or month. If a query includes + groupByTimeUnit, then the result is an aggregation based on the + specified time unit and the resultant timestamp does not include + milliseconds precision. If a query omits groupByTimeUnit, then the + resultant timestamp includes milliseconds precision. type: string + limit: + description: Maximum number of rows that can be returned in the result. + type: integer + format: int32 + mimeType: description: >- - Immutable. This field is ignored during creation as per AIP-133. - Please set the `security_action_id` field in the - CreateSecurityActionRequest when creating a new SecurityAction. - Format: - organizations/{org}/environments/{env}/securityActions/{security_action} - conditionConfig: + Valid values include: `csv` or `json`. Defaults to `json`. Note: + Configure the delimiter for CSV output using the csvDelimiter + property. + type: string + csvDelimiter: description: >- - Required. A valid SecurityAction must contain at least one - condition. - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityActionConditionConfig - updateTime: + Delimiter used in the CSV file, if `outputFormat` is set to `csv`. + Defaults to the `,` (comma) character. Supported delimiter + characters include comma (`,`), pipe (`|`), and tab (`\t`). type: string + envgroupHostname: description: >- - Output only. The update time for this SecurityAction. This reflects - when this SecurityAction changed states. - readOnly: true - format: google-datetime - expireTime: - format: google-datetime - description: The expiration for this SecurityAction. + Hostname needs to be specified if query intends to run at host + level. This field is only allowed when query is submitted by + CreateHostSecurityReport where analytics data will be grouped by + organization and hostname. type: string - ttl: - description: Input only. The TTL for this SecurityAction. - format: google-duration + reportDefinitionId: + description: Report Definition ID. type: string - createTime: + displayName: + description: Security Report display name which users can specify. type: string - format: google-datetime - description: Output only. The create time for this SecurityAction. - readOnly: true - state: + GoogleCloudApigeeV1SecurityReportQueryMetric: + id: GoogleCloudApigeeV1SecurityReportQueryMetric + description: Metric of the Query + type: object + properties: + name: + description: Required. Metric name. type: string - enum: - - STATE_UNSPECIFIED - - ENABLED - - DISABLED - enumDescriptions: - - >- - The default value. This only exists for forward compatibility. A - create request with this value will be rejected. - - >- - An ENABLED SecurityAction is actively enforced if the - `expiration_time` is in the future. - - A disabled SecurityAction is never enforced. + aggregationFunction: + description: 'Aggregation function: avg, min, max, or sum.' + type: string + alias: description: >- - Required. Only an ENABLED SecurityAction is enforced. An ENABLED - SecurityAction past its expiration time will not be enforced. - flag: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionFlag' - description: Flag a request through if it matches this SecurityAction. - deny: - description: Deny a request through if it matches this SecurityAction. - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionDeny' - allow: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionAllow' - description: Allow a request through if it matches this SecurityAction. - apiProxies: - type: array - items: - type: string - description: >- - Optional. If unset, this would apply to all proxies in the - environment. If set, this action is enforced only if at least one - proxy in the repeated list is deployed at the time of enforcement. - If set, several restrictions are enforced on SecurityActions. There - can be at most 100 enabled actions with proxies set in an env. - Several other restrictions apply on conditions and are detailed - later. - GoogleCloudApigeeV1ApiDocResponse: - id: GoogleCloudApigeeV1ApiDocResponse - properties: - data: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDoc' - description: The catalog item resource. - status: - type: string - description: Status of the operation. - requestId: - type: string - description: Unique ID of the request. - message: - description: Description of the operation. + Alias for the metric. Alias will be used to replace metric name in + query results. type: string - errorCode: + operator: + description: One of `+`, `-`, `/`, `%`, `*`. type: string - description: Unique error code for the request, if any. - description: The catalog item resource wrapped with response status, error_code, etc. - type: object - GoogleCloudApigeeV1TlsInfoCommonName: - properties: - wildcardMatch: - type: boolean - description: >- - Indicates whether the cert should be matched against as a wildcard - cert. value: - description: The TLS Common Name string of the certificate. + description: Operand value should be provided when operator is set. type: string - type: object - id: GoogleCloudApigeeV1TlsInfoCommonName - GoogleCloudApigeeV1OperationMetadata: - description: Metadata describing an Operation. - id: GoogleCloudApigeeV1OperationMetadata + GoogleCloudApigeeV1SecurityReport: + id: GoogleCloudApigeeV1SecurityReport + description: >- + SecurityReport saves all the information about the created security + report. type: object properties: - progress: - $ref: '#/components/schemas/GoogleCloudApigeeV1OperationMetadataProgress' - description: Progress of the operation. - warnings: - description: Warnings encountered while executing the operation. - items: - type: string - type: array - operationType: - enum: - - OPERATION_TYPE_UNSPECIFIED - - INSERT - - DELETE - - UPDATE - enumDescriptions: - - '' - - '' - - '' - - '' + self: + description: >- + Self link of the query. Example: + `/organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` + or following format if query is running at host level: + `/organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` type: string state: + description: >- + Query state could be "enqueued", "running", "completed", "expired" + and "failed". type: string - enumDescriptions: - - '' - - '' - - '' - - '' - enum: - - STATE_UNSPECIFIED - - NOT_STARTED - - IN_PROGRESS - - FINISHED - targetResourceName: + created: + description: Creation time of the query. + type: string + updated: + description: Output only. Last updated timestamp for the query. + readOnly: true + type: string + result: + description: Result is available only after the query is completed. + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportResultMetadata' + resultRows: + description: ResultRows is available only after the query is completed. type: string - description: Name of the resource for which the operation is operating on. - GoogleCloudApigeeV1Session: - description: Session carries the debug session id and its creation time. - properties: - timestampMs: format: int64 + resultFileSize: + description: ResultFileSize is available only after the query is completed. + type: string + executionTime: + description: ExecutionTime is available only after the query is completed. + type: string + error: + description: Error is set when query fails. + type: string + queryParams: description: >- - The first transaction creation timestamp in millisecond, recorded by - UAP. + Contains information like metrics, dimenstions etc of the Security + Report. + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportMetadata' + reportDefinitionId: + description: Report Definition ID. type: string - id: - description: The debug session ID. + displayName: + description: Display Name specified by the user. type: string - type: object - id: GoogleCloudApigeeV1Session - GoogleCloudApigeeV1ListCustomReportsResponse: - properties: - qualifier: - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' - type: object - id: GoogleCloudApigeeV1ListCustomReportsResponse - description: This message encapsulates a list of custom report definitions - GoogleCloudApigeeV1Attribute: - description: Key-value pair to store extra metadata. - id: GoogleCloudApigeeV1Attribute + envgroupHostname: + description: Hostname is available only when query is executed at host level. + type: string + GoogleCloudApigeeV1SecurityReportResultMetadata: + id: GoogleCloudApigeeV1SecurityReportResultMetadata + description: Contains informations about the security report results. type: object properties: - name: - description: API key of the attribute. + self: + description: >- + Self link of the query results. Example: + `/organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result` + or following format if query is running at host level: + `/organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result` type: string - value: + expires: + description: >- + Output only. Expire_time is set to 7 days after report creation. + Query result will be unaccessable after this time. Example: + "2021-05-04T13:38:52-07:00" + readOnly: true type: string - description: Value of the attribute. - GoogleCloudApigeeV1SecurityProfile: + GoogleCloudApigeeV1SecurityReportMetadata: + id: GoogleCloudApigeeV1SecurityReportMetadata + description: Metadata for the security report. type: object properties: - revisionCreateTime: - type: string - description: Output only. The time when revision was created. - format: google-datetime - readOnly: true - profileConfig: + metrics: description: >- - Required. Customized profile configuration that computes the - security score. - $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfig' - scoringConfigs: + Metrics of the SecurityReport. Example: + ["name:bot_count,func:sum,alias:sum_bot_count"] type: array items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityProfileScoringConfig - description: List of profile scoring configs in this revision. - environments: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfileEnvironment' + type: string + dimensions: + description: Dimensions of the SecurityReport. type: array - description: List of environments attached to security profile. - maxScore: - description: >- - Output only. Maximum security score that can be generated by this - profile. - readOnly: true - format: int32 - type: integer - revisionId: - format: int64 - description: Output only. Revision ID of the security profile. - readOnly: true + items: + type: string + startTimestamp: + description: Start timestamp of the query range. type: string - minScore: - format: int32 - type: integer - description: >- - Output only. Minimum security score that can be generated by this - profile. - readOnly: true - revisionPublishTime: format: google-datetime - readOnly: true - deprecated: true - description: >- - Output only. DEPRECATED: DO NOT USE The time when revision was - published. Once published, the security profile revision cannot be - updated further and can be attached to environments. - type: string - revisionUpdateTime: + endTimestamp: + description: End timestamp of the query range. type: string format: google-datetime - description: Output only. The time when revision was updated. - readOnly: true - displayName: - description: 'DEPRECATED: DO NOT USE Display name of the security profile.' - type: string - deprecated: true - description: + mimeType: + description: MIME type / Output format. type: string - description: Description of the security profile. - name: + timeUnit: + description: 'Query GroupBy time unit. Example: "seconds", "minute", "hour"' type: string - description: >- - Immutable. Name of the security profile resource. Format: - organizations/{org}/securityProfiles/{profile} - description: Represents a SecurityProfile resource. - id: GoogleCloudApigeeV1SecurityProfile - GoogleCloudApigeeV1OptimizedStats: + GoogleCloudApigeeV1SecurityReportResultView: + id: GoogleCloudApigeeV1SecurityReportResultView + description: The response for security report result view APIs. + type: object properties: - Response: - $ref: '#/components/schemas/GoogleCloudApigeeV1OptimizedStatsResponse' + metadata: description: >- - Wraps the `stats` response for JavaScript Optimized Scenario with a - response key. For example: ```{ "Response": { "TimeUnit": [], - "metaData": { "errors": [], "notices": [ "Source:Postgres", "Table - used: edge.api.aaxgroup001.agg_api", "PG - Host:ruappg08-ro.production.apigeeks.net", "query served - by:80c4ebca-6a10-4a2e-8faf-c60c1ee306ca" ] }, "resultTruncated": - false, "stats": { "data": [ { "identifier": { "names": [ "apiproxy" - ], "values": [ "sirjee" ] }, "metric": [ { "env": "prod", "name": - "sum(message_count)", "values": [ 36.0 ] }, { "env": "prod", "name": - "sum(is_error)", "values": [ 36.0 ] } ] } ] } } }``` - type: object - id: GoogleCloudApigeeV1OptimizedStats - GoogleCloudApigeeV1SecurityReportQueryMetric: - description: Metric of the Query - properties: - name: - description: Required. Metric name. + Metadata contains information like metrics, dimenstions etc of the + security report. + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportMetadata' + rows: + description: >- + Rows of security report result. Each row is a JSON object. Example: + {sum(message_count): 1, developer_app: "(not set)",…} + type: array + items: + type: any + state: + description: State of retrieving ResultView. type: string - alias: + code: + description: Error code when there is a failure. + type: integer + format: int32 + error: + description: Error message when there is a failure. type: string + GoogleCloudApigeeV1ListSecurityReportsResponse: + id: GoogleCloudApigeeV1ListSecurityReportsResponse + description: The response for SecurityReports. + type: object + properties: + securityReports: + description: The security reports belong to requested resource name. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' + nextPageToken: description: >- - Alias for the metric. Alias will be used to replace metric name in - query results. - value: + If the number of security reports exceeded the page size requested, + the token can be used to fetch the next page in a subsequent call. + If the response is the last page and there are no more reports to + return this field is left empty. type: string - description: Operand value should be provided when operator is set. - aggregationFunction: + GoogleCloudApigeeV1QueryTabularStatsRequest: + id: GoogleCloudApigeeV1QueryTabularStatsRequest + description: >- + Request payload representing the query to be run for fetching security + statistics as rows. + type: object + properties: + dimensions: + description: Required. List of dimension names to group the aggregations by. + type: array + items: + type: string + metrics: + description: Required. List of metrics and their aggregations. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1MetricAggregation' + filter: + description: >- + Filter further on specific dimension values. Follows the same + grammar as custom report's filter expressions. Example, apiproxy eq + 'foobar'. + https://cloud.google.com/apigee/docs/api-platform/analytics/analytics-reference#filters type: string - description: 'Aggregation function: avg, min, max, or sum.' - operator: + timeRange: + description: Time range for the stats. + $ref: '#/components/schemas/GoogleTypeInterval' + pageSize: + description: Page size represents the number of rows. + type: integer + format: int32 + pageToken: + description: Identifies a sequence of rows. type: string - description: One of `+`, `-`, `/`, `%`, `*`. - id: GoogleCloudApigeeV1SecurityReportQueryMetric + GoogleCloudApigeeV1MetricAggregation: + id: GoogleCloudApigeeV1MetricAggregation + description: The optionally aggregated metric to query with its ordering. type: object + properties: + name: + description: Name of the metric + type: string + aggregation: + description: Aggregation function associated with the metric. + type: string + enumDescriptions: + - Unspecified Aggregation function. + - Average. + - Summation. + - Min. + - Max. + - Count distinct + enum: + - AGGREGATION_FUNCTION_UNSPECIFIED + - AVG + - SUM + - MIN + - MAX + - COUNT_DISTINCT + order: + description: >- + Ordering for this aggregation in the result. For time series this is + ignored since the ordering of points depends only on the timestamp, + not the values. + type: string + enumDescriptions: + - Unspecified order. Default is Descending. + - Ascending sort order. + - Descending sort order. + enum: + - ORDER_UNSPECIFIED + - ASCENDING + - DESCENDING GoogleTypeInterval: + id: GoogleTypeInterval description: >- Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the @@ -6738,2102 +6550,2670 @@ components: time. type: object properties: - endTime: - description: >- - Optional. Exclusive end of the interval. If specified, a Timestamp - matching this interval will have to be before the end. - type: string - format: google-datetime startTime: - type: string description: >- Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start. - format: google-datetime - id: GoogleTypeInterval - GoogleCloudApigeeV1ArchiveDeployment: - id: GoogleCloudApigeeV1ArchiveDeployment - properties: - operation: - description: >- - Output only. A reference to the LRO that created this Archive - Deployment in the following format: - `organizations/{org}/operations/{id}` - readOnly: true - type: string - createdAt: - description: >- - Output only. The time at which the Archive Deployment was created in - milliseconds since the epoch. - readOnly: true - format: int64 type: string - gcsUri: - type: string - description: >- - Input only. The Google Cloud Storage signed URL returned from - GenerateUploadUrl and used to upload the Archive zip file. - labels: - description: >- - User-supplied key-value pairs used to organize ArchiveDeployments. - Label keys must be between 1 and 63 characters long, have a UTF-8 - encoding of maximum 128 bytes, and must conform to the following - PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values must be - between 1 and 63 characters long, have a UTF-8 encoding of maximum - 128 bytes, and must conform to the following PCRE regular - expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can - be associated with a given store. - type: object - additionalProperties: - type: string - updatedAt: + format: google-datetime + endTime: description: >- - Output only. The time at which the Archive Deployment was updated in - milliseconds since the epoch. - readOnly: true - format: int64 - type: string - name: + Optional. Exclusive end of the interval. If specified, a Timestamp + matching this interval will have to be before the end. type: string - description: >- - Name of the Archive Deployment in the following format: - `organizations/{org}/environments/{env}/archiveDeployments/{id}`. - type: object - description: Archive Deployment information. - GoogleCloudApigeeV1ListOrganizationsResponse: + format: google-datetime + GoogleCloudApigeeV1QueryTabularStatsResponse: + id: GoogleCloudApigeeV1QueryTabularStatsResponse + description: >- + Encapsulates two kinds of stats that are results of the dimensions and + aggregations requested. - Tabular rows. - Time series data. Example of + tabular rows, Represents security stats results as a row of flat values. type: object properties: - organizations: - description: List of Apigee organizations and associated Google Cloud projects. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1OrganizationProjectMapping' + values: + description: Resultant rows from the executed query. type: array - id: GoogleCloudApigeeV1ListOrganizationsResponse - GoogleCloudApigeeV1StatsHostStats: - description: >- - Encapsulates the hostname wrapper: ``` "hosts": [ { "metrics": [ { - "name": "sum(message_count)", "values": [ "2.52056245E8" ] } ], "name": - "example.com" } ]``` - properties: - dimensions: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1DimensionMetric' - type: array - description: List of metrics grouped under dimensions. - metrics: + type: array + items: + type: any + columns: description: >- - In the final response, only one of the following fields will be - present based on the dimensions provided. If no dimensions are - provided, then only the top-level metrics are provided. If - dimensions are included, then there will be a top-level dimensions - field under hostnames which will contain metrics values and the - dimension name. Example: ``` "hosts": [ { "dimensions": [ { - "metrics": [ { "name": "sum(message_count)", "values": [ - "2.14049521E8" ] } ], "name": "nit_proxy" } ], "name": "example.com" - } ]``` OR ```"hosts": [ { "metrics": [ { "name": - "sum(message_count)", "values": [ "2.19026331E8" ] } ], "name": - "example.com" } ]``` List of metric values. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Metric' + Column names corresponding to the same order as the inner values in + the stats field. type: array - name: - description: Hostname used in query. + items: + type: string + nextPageToken: + description: Next page token. type: string + GoogleCloudApigeeV1QueryTimeSeriesStatsRequest: + id: GoogleCloudApigeeV1QueryTimeSeriesStatsRequest + description: >- + QueryTimeSeriesStatsRequest represents a query that returns a collection + of time series sequences grouped by their values. type: object - id: GoogleCloudApigeeV1StatsHostStats - GoogleTypeMoney: properties: - currencyCode: - type: string - description: The three-letter currency code defined in ISO 4217. - nanos: + dimensions: description: >- - Number of nano (10^-9) units of the amount. The value must be - between -999,999,999 and +999,999,999 inclusive. If `units` is - positive, `nanos` must be positive or zero. If `units` is zero, - `nanos` can be positive, zero, or negative. If `units` is negative, - `nanos` must be negative or zero. For example $-1.75 is represented - as `units`=-1 and `nanos`=-750,000,000. - type: integer - format: int32 - units: + List of dimension names to group the aggregations by. If no + dimensions are passed, a single trend line representing the + requested metric aggregations grouped by environment is returned. + type: array + items: + type: string + metrics: + description: Required. List of metrics and their aggregations. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1MetricAggregation' + filter: description: >- - The whole units of the amount. For example if `currencyCode` is - `"USD"`, then 1 unit is one US dollar. - format: int64 + Filter further on specific dimension values. Follows the same + grammar as custom report's filter expressions. Example, apiproxy eq + 'foobar'. + https://cloud.google.com/apigee/docs/api-platform/analytics/analytics-reference#filters type: string - description: Represents an amount of money with its currency type. - type: object - id: GoogleTypeMoney - GoogleCloudApigeeV1RuntimeTraceSamplingConfig: - type: object - description: >- - NEXT ID: 3 RuntimeTraceSamplingConfig represents the detail settings of - distributed tracing. Only the fields that are defined in the distributed - trace configuration can be overridden using the distribute trace - configuration override APIs. - id: GoogleCloudApigeeV1RuntimeTraceSamplingConfig - properties: - samplingRate: - format: float + windowSize: + description: Time buckets to group the stats by. + type: string + enumDescriptions: + - Unspecified window size. Default is 1 hour. + - 1 Minute window + - 1 Hour window + - 1 Day window + - 1 Month window + enum: + - WINDOW_SIZE_UNSPECIFIED + - MINUTE + - HOUR + - DAY + - MONTH + timeRange: + description: Required. Time range for the stats. + $ref: '#/components/schemas/GoogleTypeInterval' + timestampOrder: description: >- - Field sampling rate. This value is only applicable when using the - PROBABILITY sampler. The supported values are > 0 and <= 0.5. - type: number - sampler: - description: Sampler of distributed tracing. OFF is the default value. + Order the sequences in increasing or decreasing order of timestamps. + Default is descending order of timestamps (latest first). + type: string enumDescriptions: - - Sampler unspecified. - - >- - OFF means distributed trace is disabled, or the sampling - probability is 0. - - >- - PROBABILITY means traces are captured on a probability that - defined by sampling_rate. The sampling rate is limited to 0 to 0.5 - when this is set. + - Unspecified order. Default is Descending. + - Ascending sort order. + - Descending sort order. enum: - - SAMPLER_UNSPECIFIED - - 'OFF' - - PROBABILITY + - ORDER_UNSPECIFIED + - ASCENDING + - DESCENDING + pageSize: + description: >- + Page size represents the number of time series sequences, one per + unique set of dimensions and their values. + type: integer + format: int32 + pageToken: + description: >- + Page token stands for a specific collection of time series + sequences. type: string - GoogleCloudApigeeV1DimensionMetric: + GoogleCloudApigeeV1QueryTimeSeriesStatsResponse: + id: GoogleCloudApigeeV1QueryTimeSeriesStatsResponse + description: >- + Represents security stats result as a collection of time series + sequences. + type: object properties: - metrics: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Metric' + values: + description: Results of the query returned as a JSON array. type: array - description: List of metrics. - name: - type: string + items: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1QueryTimeSeriesStatsResponseSequence + columns: description: >- - Comma joined dimension names. E.g. "dim1_name,dim2_name". - Deprecated. If name already has comma before join, we may get wrong - splits. Please use individual_names. - deprecated: true - individualNames: - description: Individual dimension names. E.g. ["dim1_name", "dim2_name"]. + Column names corresponding to the same order as the inner values in + the stats field. + type: array items: type: string - type: array - description: Encapsulates a metric grouped by dimension. + nextPageToken: + description: Next page token. + type: string + GoogleCloudApigeeV1QueryTimeSeriesStatsResponseSequence: + id: GoogleCloudApigeeV1QueryTimeSeriesStatsResponseSequence + description: A sequence of time series. type: object - id: GoogleCloudApigeeV1DimensionMetric - GoogleCloudApigeeV1ServiceIssuersMapping: - id: GoogleCloudApigeeV1ServiceIssuersMapping properties: - service: - description: String indicating the Apigee service name. - type: string - emailIds: - items: + dimensions: + description: >- + Map of dimensions and their values that uniquely identifies a time + series sequence. + type: object + additionalProperties: type: string + points: + description: List of points. First value of each inner list is a timestamp. type: array - description: List of trusted issuer email ids. + items: + type: array + items: + type: any + GoogleCloudApigeeV1SecurityProfile: + id: GoogleCloudApigeeV1SecurityProfile + description: Represents a SecurityProfile resource. type: object - GoogleCloudApigeeV1AppGroup: properties: name: - type: string description: >- - Immutable. Name of the AppGroup. Characters you can use in the name - are restricted to: A-Z0-9._\-$ %. - channelId: - description: channel identifier identifies the owner maintaing this grouping. - type: string - organization: + Immutable. Name of the security profile resource. Format: + organizations/{org}/securityProfiles/{profile} type: string - description: Immutable. the org the app group is created - appGroupId: - description: Output only. Internal identifier that cannot be edited + displayName: + description: 'DEPRECATED: DO NOT USE Display name of the security profile.' + deprecated: true type: string + revisionId: + description: Output only. Revision ID of the security profile. readOnly: true - attributes: - description: A list of attributes - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - lastModifiedAt: - readOnly: true + type: string format: int64 - description: Output only. Modified time as milliseconds since epoch. + revisionCreateTime: + description: Output only. The time when revision was created. + readOnly: true type: string - channelUri: - description: A reference to the associated storefront/marketplace. + format: google-datetime + revisionUpdateTime: + description: Output only. The time when revision was updated. + readOnly: true type: string - status: + format: google-datetime + revisionPublishTime: description: >- - Valid values are `active` or `inactive`. Note that the status of the - AppGroup should be updated via UpdateAppGroupRequest by setting the - action as `active` or `inactive`. - type: string - createdAt: + Output only. DEPRECATED: DO NOT USE The time when revision was + published. Once published, the security profile revision cannot be + updated further and can be attached to environments. + readOnly: true + deprecated: true type: string - format: int64 + format: google-datetime + scoringConfigs: + description: List of profile scoring configs in this revision. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityProfileScoringConfig + environments: + description: List of environments attached to security profile. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfileEnvironment' + maxScore: + description: >- + Output only. Maximum security score that can be generated by this + profile. readOnly: true - description: Output only. Created time as milliseconds since epoch. - displayName: + type: integer + format: int32 + minScore: + description: >- + Output only. Minimum security score that can be generated by this + profile. + readOnly: true + type: integer + format: int32 + profileConfig: + description: >- + Required. Customized profile configuration that computes the + security score. + $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfig' + description: + description: Description of the security profile. type: string - description: app group name displayed in the UI - description: >- - AppGroup contains the request/response fields representing the logical - grouping of apps. Note that appgroup_id, create_time and update_time - cannot be changed by the user, and gets updated by the system. The name - and the organization once provided cannot be edited subsequently. - type: object - id: GoogleCloudApigeeV1AppGroup - GoogleIamV1Binding: - description: Associates `members`, or principals, with a `role`. + GoogleCloudApigeeV1SecurityProfileScoringConfig: + id: GoogleCloudApigeeV1SecurityProfileScoringConfig + description: Security configurations to manage scoring. type: object properties: - role: + title: + description: Title of the config. type: string - description: >- - Role that is assigned to the list of `members`, or principals. For - example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an - overview of the IAM roles and permissions, see the [IAM - documentation](https://cloud.google.com/iam/docs/roles-overview). - For a list of the available pre-defined roles, see - [here](https://cloud.google.com/iam/docs/understanding-roles). - condition: - description: >- - The condition that is associated with this binding. If the condition - evaluates to `true`, then this binding applies to the current - request. If the condition evaluates to `false`, then this binding - does not apply to the current request. However, a different role - binding might grant the same role to one or more of the principals - in this binding. To learn which resources support conditions in - their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - $ref: '#/components/schemas/GoogleTypeExpr' - members: - description: >- - Specifies the principals requesting access for a Google Cloud - 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. Does not include identities - that come from external identity providers (IdPs) through identity - federation. * `user:{emailid}`: An email address that represents a - specific Google account. For example, `alice@example.com` . * - `serviceAccount:{emailid}`: An email address that represents a - Google service account. For example, - `my-other-app@appspot.gserviceaccount.com`. * - `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: - An identifier for a [Kubernetes service - account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). - For example, - `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * - `group:{emailid}`: An email address that represents a Google group. - For example, `admins@example.com`. * `domain:{domain}`: The G Suite - domain (primary) that represents all the users of that domain. For - example, `google.com` or `example.com`. * - `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workforce identity pool. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: - All workforce identities in a group. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All workforce identities with a specific attribute value. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: - All identities in a workforce identity pool. * - `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workload identity pool. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: - A workload identity pool group. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All identities in a workload identity pool with a certain attribute. - * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: - All identities in a workload identity pool. * - `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. * - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - Deleted single identity in a workforce identity pool. For example, - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. - type: array - items: - type: string - id: GoogleIamV1Binding - GoogleCloudApigeeV1EnableSecurityActionRequest: + scorePath: + description: Path of the component config used for scoring. + type: string + description: + description: Description of the config. + type: string + GoogleCloudApigeeV1SecurityProfileEnvironment: + id: GoogleCloudApigeeV1SecurityProfileEnvironment + description: >- + Environment information of attached environments. Scoring an environment + is enabled only if it is attached to a security profile. type: object - description: Message to enable a disabled SecurityAction. - id: GoogleCloudApigeeV1EnableSecurityActionRequest - properties: {} - GoogleCloudApigeeV1AccessSet: properties: - success: - type: boolean - name: + environment: + description: Output only. Name of the environment. + readOnly: true type: string - value: + attachTime: + description: >- + Output only. Time at which environment was attached to the security + profile. + readOnly: true type: string - type: object + format: google-datetime + GoogleCloudApigeeV1ProfileConfig: + id: GoogleCloudApigeeV1ProfileConfig description: >- - Set action. For example, "Set" : { "name" : "target.name", "success" : - true, "value" : "default" } - id: GoogleCloudApigeeV1AccessSet - GoogleCloudApigeeV1ListApiProxiesResponse: + ProfileConfig defines a set of categories and policies which will be + used to compute security score. + type: object properties: - proxies: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' + categories: + description: List of categories of profile config. type: array - id: GoogleCloudApigeeV1ListApiProxiesResponse + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigCategory' + GoogleCloudApigeeV1ProfileConfigCategory: + id: GoogleCloudApigeeV1ProfileConfigCategory + description: >- + Advanced API Security provides security profile that scores the + following categories. type: object - GoogleCloudApigeeV1RuntimeApiSecurityConfig: properties: - enabled: - description: If the API Security is enabled or not. - type: boolean - id: GoogleCloudApigeeV1RuntimeApiSecurityConfig - description: Runtime configuration for the API Security add-on. + abuse: + description: >- + Checks for abuse, which includes any requests sent to the API for + purposes other than what it is intended for, such as high volumes of + requests, data scraping, and abuse related to authorization. + $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigAbuse' + mediation: + description: Checks to see if you have a mediation policy in place. + $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigMediation' + authorization: + description: Checks to see if you have an authorization policy in place. + $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigAuthorization' + threat: + description: Checks to see if you have a threat protection policy in place. + $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigThreat' + mtls: + description: Checks to see if you have configured mTLS for the target server. + $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigMTLS' + cors: + description: Checks to see if you have CORS policy in place. + $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigCORS' + GoogleCloudApigeeV1ProfileConfigAbuse: + id: GoogleCloudApigeeV1ProfileConfigAbuse + description: >- + Checks for abuse, which includes any requests sent to the API for + purposes other than what it is intended for, such as high volumes of + requests, data scraping, and abuse related to authorization. + type: object + properties: {} + GoogleCloudApigeeV1ProfileConfigMediation: + id: GoogleCloudApigeeV1ProfileConfigMediation + description: >- + By default, following policies will be included: - OASValidation - + SOAPMessageValidation + type: object + properties: {} + GoogleCloudApigeeV1ProfileConfigAuthorization: + id: GoogleCloudApigeeV1ProfileConfigAuthorization + description: >- + By default, following policies will be included: - JWS - JWT - OAuth - + BasicAuth - APIKey + type: object + properties: {} + GoogleCloudApigeeV1ProfileConfigThreat: + id: GoogleCloudApigeeV1ProfileConfigThreat + description: >- + By default, following policies will be included: - XMLThreatProtection - + JSONThreatProtection + type: object + properties: {} + GoogleCloudApigeeV1ProfileConfigMTLS: + id: GoogleCloudApigeeV1ProfileConfigMTLS + description: Checks to see if you have configured mTLS for the target server. + type: object + properties: {} + GoogleCloudApigeeV1ProfileConfigCORS: + id: GoogleCloudApigeeV1ProfileConfigCORS + description: Checks to see if you have CORS policy in place. + type: object + properties: {} + GoogleCloudApigeeV1ListSecurityProfilesResponse: + id: GoogleCloudApigeeV1ListSecurityProfilesResponse + description: Response for ListSecurityProfiles. type: object - GoogleCloudApigeeV1PodStatus: - id: GoogleCloudApigeeV1PodStatus properties: - statusCode: - type: string - description: Code associated with the deployment status. - deploymentStatusTime: - format: int64 - type: string - description: Time the deployment status was reported in milliseconds since epoch. - statusCodeDetails: - type: string - description: Human-readable message associated with the status code. - deploymentStatus: - type: string + securityProfiles: description: >- - Status of the deployment. Valid values include: - `deployed`: - Successful. - `error` : Failed. - `pending` : Pod has not yet - reported on the deployment. - deploymentTime: - description: Time the proxy was deployed in milliseconds since epoch. - type: string - format: int64 - podStatusTime: - format: int64 - description: Time the pod status was reported in milliseconds since epoch. - type: string - podStatus: - type: string + List of security profiles in the organization. The profiles may be + attached or unattached to any environment. This will return latest + revision of each profile. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' + nextPageToken: description: >- - Overall status of the pod (not this specific deployment). Valid - values include: - `active`: Up to date. - `stale` : Recently out of - date. Pods that have not reported status in a long time are excluded - from the output. - appVersion: - type: string - description: Version of the application running in the pod. - podName: + A token that can be sent as `page_token` to retrieve the next page. + If this field is omitted, there are no subsequent pages. type: string - description: Name of the pod which is reporting the status. - type: object - GoogleCloudApigeeV1UpdateError: + GoogleCloudApigeeV1ListSecurityProfileRevisionsResponse: + id: GoogleCloudApigeeV1ListSecurityProfileRevisionsResponse + description: Response for ListSecurityProfileRevisions. type: object properties: - message: - type: string - description: User-friendly error message. - type: - type: string - description: >- - A string that uniquely identifies the type of error. This provides a - more reliable means to deduplicate errors across revisions and - instances. - resource: - type: string + securityProfiles: description: >- - The sub resource specific to this error (e.g. a proxy deployed - within the EnvironmentConfig). If empty the error refers to the top - level resource. - code: - enum: - - OK - - CANCELLED - - UNKNOWN - - INVALID_ARGUMENT - - DEADLINE_EXCEEDED - - NOT_FOUND - - ALREADY_EXISTS - - PERMISSION_DENIED - - UNAUTHENTICATED - - RESOURCE_EXHAUSTED - - FAILED_PRECONDITION - - ABORTED - - OUT_OF_RANGE - - UNIMPLEMENTED - - INTERNAL - - UNAVAILABLE - - DATA_LOSS - type: string - description: Status code. - enumDescriptions: - - 'Not an error; returned on success. HTTP Mapping: 200 OK' - - >- - The operation was cancelled, typically by the caller. HTTP - Mapping: 499 Client Closed Request - - >- - Unknown error. For example, this error may be returned when a - `Status` value received from another address space belongs to an - error space that is not known in this address space. Also errors - raised by APIs that do not return enough error information may be - converted to this error. HTTP Mapping: 500 Internal Server Error - - >- - The client specified an invalid argument. Note that this differs - from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments - that are problematic regardless of the state of the system (e.g., - a malformed file name). HTTP Mapping: 400 Bad Request - - >- - The deadline expired before the operation could complete. For - operations that change the state of the system, this error may be - returned even if the operation has completed successfully. For - example, a successful response from a server could have been - delayed long enough for the deadline to expire. HTTP Mapping: 504 - Gateway Timeout - - >- - Some requested entity (e.g., file or directory) was not found. - Note to server developers: if a request is denied for an entire - class of users, such as gradual feature rollout or undocumented - allowlist, `NOT_FOUND` may be used. If a request is denied for - some users within a class of users, such as user-based access - control, `PERMISSION_DENIED` must be used. HTTP Mapping: 404 Not - Found - - >- - The entity that a client attempted to create (e.g., file or - directory) already exists. HTTP Mapping: 409 Conflict - - >- - The caller does not have permission to execute the specified - operation. `PERMISSION_DENIED` must not be used for rejections - caused by exhausting some resource (use `RESOURCE_EXHAUSTED` - instead for those errors). `PERMISSION_DENIED` must not be used if - the caller can not be identified (use `UNAUTHENTICATED` instead - for those errors). This error code does not imply the request is - valid or the requested entity exists or satisfies other - pre-conditions. HTTP Mapping: 403 Forbidden - - >- - The request does not have valid authentication credentials for the - operation. HTTP Mapping: 401 Unauthorized - - >- - Some resource has been exhausted, perhaps a per-user quota, or - perhaps the entire file system is out of space. HTTP Mapping: 429 - Too Many Requests - - >- - The operation was rejected because the system is not in a state - required for the operation's execution. For example, the directory - to be deleted is non-empty, an rmdir operation is applied to a - non-directory, etc. Service implementors can use the following - guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and - `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just - the failing call. (b) Use `ABORTED` if the client should retry at - a higher level. For example, when a client-specified test-and-set - fails, indicating the client should restart a read-modify-write - sequence. (c) Use `FAILED_PRECONDITION` if the client should not - retry until the system state has been explicitly fixed. For - example, if an "rmdir" fails because the directory is non-empty, - `FAILED_PRECONDITION` should be returned since the client should - not retry unless the files are deleted from the directory. HTTP - Mapping: 400 Bad Request - - >- - The operation was aborted, typically due to a concurrency issue - such as a sequencer check failure or transaction abort. See the - guidelines above for deciding between `FAILED_PRECONDITION`, - `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 409 Conflict - - >- - The operation was attempted past the valid range. E.g., seeking or - reading past end-of-file. Unlike `INVALID_ARGUMENT`, this error - indicates a problem that may be fixed if the system state changes. - For example, a 32-bit file system will generate `INVALID_ARGUMENT` - if asked to read at an offset that is not in the range [0,2^32-1], - but it will generate `OUT_OF_RANGE` if asked to read from an - offset past the current file size. There is a fair bit of overlap - between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We recommend - using `OUT_OF_RANGE` (the more specific error) when it applies so - that callers who are iterating through a space can easily look for - an `OUT_OF_RANGE` error to detect when they are done. HTTP - Mapping: 400 Bad Request - - >- - The operation is not implemented or is not supported/enabled in - this service. HTTP Mapping: 501 Not Implemented - - >- - Internal errors. This means that some invariants expected by the - underlying system have been broken. This error code is reserved - for serious errors. HTTP Mapping: 500 Internal Server Error - - >- - The service is currently unavailable. This is most likely a - transient condition, which can be corrected by retrying with a - backoff. Note that it is not always safe to retry non-idempotent - operations. See the guidelines above for deciding between - `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: - 503 Service Unavailable - - >- - Unrecoverable data loss or corruption. HTTP Mapping: 500 Internal - Server Error - id: GoogleCloudApigeeV1UpdateError - description: Details on why a resource update failed in the runtime. - GoogleCloudApigeeV1GetAsyncQueryResultUrlResponse: - properties: - urls: - description: The list of Signed URLs generated by the CreateAsyncQuery request + List of security profile revisions. The revisions may be attached or + unattached to any environment. type: array items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1GetAsyncQueryResultUrlResponseURLInfo - type: object - id: GoogleCloudApigeeV1GetAsyncQueryResultUrlResponse - description: The response for GetAsyncQueryResultUrl - GoogleCloudApigeeV1ApiSecurityRuntimeConfig: - description: >- - Response for - GetApiSecurityRuntimeConfig[EnvironmentService.GetApiSecurityRuntimeConfig]. + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' + nextPageToken: + description: >- + A token that can be sent as `page_token` to retrieve the next page. + If this field is omitted, there are no subsequent pages. + type: string + GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation: + id: GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation + description: Represents a SecurityProfileEnvironmentAssociation resource. type: object properties: - uid: - type: string - description: >- - Unique ID for the API Security Runtime configuration. The ID will - only change if the environment is deleted and recreated. name: + description: Immutable. Name of the environment that the profile is attached to. type: string - description: >- - Name of the environment API Security Runtime configuration resource. - Format: - `organizations/{org}/environments/{env}/apiSecurityRuntimeConfig` - location: - description: A list of up to 5 Cloud Storage Blobs that contain SecurityActions. - items: - type: string - type: array - updateTime: - format: google-datetime + securityProfileRevisionId: + description: 'DEPRECATED: DO NOT USE Revision ID of the security profile.' + deprecated: true type: string - description: Time that the API Security Runtime configuration was updated. - revisionId: format: int64 - type: string + attachTime: description: >- - Revision ID of the API Security Runtime configuration. The higher - the value, the more recently the configuration was deployed. - id: GoogleCloudApigeeV1ApiSecurityRuntimeConfig - GoogleCloudApigeeV1ListDebugSessionsResponse: + Output only. The time when environment was attached to the security + profile. + readOnly: true + type: string + format: google-datetime + GoogleCloudApigeeV1ComputeEnvironmentScoresRequest: + id: GoogleCloudApigeeV1ComputeEnvironmentScoresRequest + description: Request for ComputeEnvironmentScores. type: object - id: GoogleCloudApigeeV1ListDebugSessionsResponse properties: - nextPageToken: + timeRange: description: >- - Page token that you can include in a ListDebugSessionsRequest to - retrieve the next page. If omitted, no subsequent pages exist. - type: string - sessions: - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Session' + Required. Time range for score calculation. At most 14 days of + scores will be returned, and both the start and end dates must be + within the last 90 days. + $ref: '#/components/schemas/GoogleTypeInterval' + filters: description: >- - Session info that includes debug session ID and the first - transaction creation timestamp. - GoogleCloudApigeeV1ReportProperty: - properties: - value: + Optional. Filters are used to filter scored components. Return all + the components if no filter is mentioned. Example: [{ "scorePath": + "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/source" + }, { "scorePath": + "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/target", + }] This will return components with path: + "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/source" + OR + "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/target" type: array - description: property values items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - property: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ComputeEnvironmentScoresRequestFilter + pageSize: + description: >- + Optional. The maximum number of subcomponents to be returned in a + single page. The service may return fewer than this value. If + unspecified, at most 100 subcomponents will be returned in a single + page. + type: integer + format: int32 + pageToken: + description: >- + Optional. A token that can be sent as `page_token` to retrieve the + next page. If this field is omitted, there are no subsequent pages. type: string - description: name of the property - id: GoogleCloudApigeeV1ReportProperty - type: object - GoogleCloudApigeeV1TestDatastoreResponse: + GoogleCloudApigeeV1ComputeEnvironmentScoresRequestFilter: + id: GoogleCloudApigeeV1ComputeEnvironmentScoresRequestFilter + description: >- + Filter scores by component path. Used custom filter instead of AIP-160 + as the use cases are highly constrained and predictable. type: object - description: The response for TestDatastore properties: - error: - description: Output only. Error message of test connection failure + scorePath: + description: >- + Optional. Return scores for this component. Example: + "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/source" type: string - readOnly: true - state: - description: Output only. It could be `completed` or `failed` - readOnly: true - type: string - id: GoogleCloudApigeeV1TestDatastoreResponse - GoogleCloudApigeeV1DeleteCustomReportResponse: - id: GoogleCloudApigeeV1DeleteCustomReportResponse + GoogleCloudApigeeV1ComputeEnvironmentScoresResponse: + id: GoogleCloudApigeeV1ComputeEnvironmentScoresResponse + description: Response for ComputeEnvironmentScores. type: object properties: - message: - description: The response contains only a message field. - type: string - GoogleCloudApigeeV1SecurityAssessmentResultResource: - properties: - name: - type: string - description: Required. Name of this resource. - resourceRevisionId: - type: string + scores: + description: List of scores. One score per day. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Score' + nextPageToken: description: >- - The revision id for the resource. In case of Apigee, this is proxy - revision id. - type: - enumDescriptions: - - ResourceType not specified. - - Resource is an Apigee Proxy. + A page token, received from a previous `ComputeScore` call. Provide + this to retrieve the subsequent page. type: string - enum: - - RESOURCE_TYPE_UNSPECIFIED - - API_PROXY - description: Required. Type of this resource. + GoogleCloudApigeeV1Score: + id: GoogleCloudApigeeV1Score + description: Represents Security Score. type: object - id: GoogleCloudApigeeV1SecurityAssessmentResultResource - description: Resource for which we are computing security assessment. - GoogleCloudApigeeV1SyncAuthorization: properties: - identities: - items: - type: string - description: >- - Required. Array of service accounts to grant access to control plane - resources, each specified using the following format: - `serviceAccount:` service-account-name. The service-account-name is - formatted like an email address. For example: - `my-synchronizer-manager-service_account@my_project_id.iam.gserviceaccount.com` - You might specify multiple service accounts, for example, if you - have multiple environments and wish to assign a unique service - account to each one. The service accounts must have **Apigee - Synchronizer Manager** role. See also [Create service - accounts](https://cloud.google.com/apigee/docs/hybrid/latest/sa-about#create-the-service-accounts). + timeRange: + description: Start and end time for the score. + $ref: '#/components/schemas/GoogleTypeInterval' + component: + description: Component containing score, recommendations and actions. + $ref: '#/components/schemas/GoogleCloudApigeeV1ScoreComponent' + subcomponents: + description: List of all the drilldown score components. type: array - etag: - description: >- - Entity tag (ETag) used for optimistic concurrency control as a way - to help prevent simultaneous updates from overwriting each other. - For example, when you call - [getSyncAuthorization](organizations/getSyncAuthorization) an ETag - is returned in the response. Pass that ETag when calling the - [setSyncAuthorization](organizations/setSyncAuthorization) to ensure - that you are updating the correct version. If you don't pass the - ETag in the call to `setSyncAuthorization`, then the existing - authorization is overwritten indiscriminately. **Note**: We strongly - recommend that you use the ETag in the read-modify-write cycle to - avoid race conditions. - type: string - format: byte + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1ScoreComponent' + GoogleCloudApigeeV1ScoreComponent: + id: GoogleCloudApigeeV1ScoreComponent + description: Component is an individual security element that is scored. type: object - id: GoogleCloudApigeeV1SyncAuthorization - GoogleCloudApigeeV1OperationGroup: - id: GoogleCloudApigeeV1OperationGroup properties: - operationConfigType: + score: + description: Score for the component. + type: integer + format: int32 + scorePath: description: >- - Flag that specifes whether the configuration is for Apigee API proxy - or a remote service. Valid values include `proxy` or - `remoteservice`. Defaults to `proxy`. Set to `proxy` when Apigee API - proxies are associated with the API product. Set to `remoteservice` - when non-Apigee proxies like Istio-Envoy are associated with the API - product. + Path of the component. Example: + /org@myorg/envgroup@myenvgroup/proxies/proxy@myproxy type: string - operationConfigs: + recommendations: + description: List of recommendations to improve API security. + type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1OperationConfig' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ScoreComponentRecommendation + dataCaptureTime: description: >- - Required. List of operation configurations for either Apigee API - proxies or other remote services that are associated with this API - product. + Time in the requested time period when data was last captured to + compute the score. + type: string + format: google-datetime + calculateTime: + description: Time when score was calculated. + type: string + format: google-datetime + drilldownPaths: + description: List of paths for next components. type: array + items: + type: string + GoogleCloudApigeeV1ScoreComponentRecommendation: + id: GoogleCloudApigeeV1ScoreComponentRecommendation + description: Recommendation based on security concerns and score. type: object - description: >- - List of operation configuration details associated with Apigee API - proxies or remote services. Remote services are non-Apigee proxies, such - as Istio-Envoy. - GoogleCloudApigeeV1RoutingRule: - id: GoogleCloudApigeeV1RoutingRule properties: - basepath: + title: + description: Title represents recommendation title. type: string - description: >- - URI path prefix used to route to the specified environment. May - contain one or more wildcards. For example, path segments consisting - of a single `*` character will match any string. - deploymentGroup: - description: >- - Name of a deployment group in an environment bound to the - environment group in the following format: - `organizations/{org}/environment/{env}/deploymentGroups/{group}` - Only one of environment or deployment_group will be set. + description: + description: Description of the recommendation. type: string - otherTargets: + impact: + description: >- + Potential impact of this recommendation on the overall score. This + denotes how important this recommendation is to improve the score. + type: integer + format: int32 + actions: + description: Actions for the recommendation to improve the security score. type: array items: - type: string - description: >- - Conflicting targets, which will be resource names specifying either - deployment groups or environments. - updateTime: - description: >- - The unix timestamp when this rule was updated. This is updated - whenever env_group_revision is updated. This field is omitted from - the IngressConfig unless the GetDeployedIngressConfig API is called - with view=FULL. + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ScoreComponentRecommendationAction + GoogleCloudApigeeV1ScoreComponentRecommendationAction: + id: GoogleCloudApigeeV1ScoreComponentRecommendationAction + description: Action to improve security score. + type: object + properties: + description: + description: Description of the action. type: string - format: google-datetime - envGroupRevision: + actionContext: + description: Action context for the action. + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ScoreComponentRecommendationActionActionContext + GoogleCloudApigeeV1ScoreComponentRecommendationActionActionContext: + id: GoogleCloudApigeeV1ScoreComponentRecommendationActionActionContext + description: Action context are all the relevant details for the action. + type: object + properties: + documentationLink: + description: Documentation link for the action. type: string + GoogleCloudApigeeV1SecurityIncident: + id: GoogleCloudApigeeV1SecurityIncident + description: Represents an SecurityIncident resource. + type: object + properties: + name: description: >- - The env group config revision_id when this rule was added or last - updated. This value is set when the rule is created and will only - update if the the environment_id changes. It is used to determine if - the runtime is up to date with respect to this rule. This field is - omitted from the IngressConfig unless the GetDeployedIngressConfig - API is called with view=FULL. - format: int64 - environment: + Immutable. Name of the security incident resource. Format: + organizations/{org}/environments/{environment}/securityIncidents/{incident} + Example: + organizations/apigee-org/environments/dev/securityIncidents/1234-5678-9101-1111 + type: string + displayName: + description: Optional. Display name of the security incident. type: string + firstDetectedTime: description: >- - Name of an environment bound to the environment group in the - following format: `organizations/{org}/environments/{env}`. Only one - of environment or deployment_group will be set. - receiver: + Output only. The time when events associated with the incident were + first detected. + readOnly: true type: string + format: google-datetime + lastDetectedTime: description: >- - The resource name of the proxy revision that is receiving this - basepath in the following format: - `organizations/{org}/apis/{api}/revisions/{rev}`. This field is - omitted from the IngressConfig unless the GetDeployedIngressConfig - API is called with view=FULL. - type: object - GoogleCloudApigeeV1QueryMetadata: - type: object - id: GoogleCloudApigeeV1QueryMetadata - properties: - startTimestamp: + Output only. The time when events associated with the incident were + last detected. + readOnly: true type: string - description: Start timestamp of the query range. - dimensions: - description: Dimensions of the AsyncQuery. - items: - type: string - type: array - metrics: + format: google-datetime + detectionTypes: description: >- - Metrics of the AsyncQuery. Example: - ["name:message_count,func:sum,alias:sum_message_count"] + Output only. Detection types which are part of the incident. + Examples: Flooder, OAuth Abuser, Static Content Scraper, Anomaly + Detection. + readOnly: true type: array items: type: string - outputFormat: - description: Output format. + trafficCount: + description: Total traffic detected as part of the incident. type: string - timeUnit: - description: Query GroupBy time unit. - type: string - endTimestamp: - description: End timestamp of the query range. + format: int64 + riskLevel: + description: Output only. Risk level of the incident. + readOnly: true type: string - GoogleCloudApigeeV1GenerateDownloadUrlResponse: - type: object - properties: - downloadUri: + enumDescriptions: + - Risk Level Unspecified. + - Risk level of the incident is low. + - Risk level of the incident is moderate. + - Risk level of the incident is severe. + enum: + - RISK_LEVEL_UNSPECIFIED + - LOW + - MODERATE + - SEVERE + observability: + description: Optional. Indicates if the user archived this incident. type: string + enumDescriptions: + - The incident observability is unspecified. + - >- + The incident is currently active. Can change to this status from + archived. + - >- + The incident is currently archived and was archived by the + customer. + enum: + - OBSERVABILITY_UNSPECIFIED + - ACTIVE + - ARCHIVED + lastObservabilityChangeTime: description: >- - The Google Cloud Storage signed URL that can be used to download the - Archive zip file. - description: Response for GenerateDownloadUrl method. - id: GoogleCloudApigeeV1GenerateDownloadUrlResponse - GoogleCloudApigeeV1DeploymentConfig: - description: 'NEXT ID: 11' - id: GoogleCloudApigeeV1DeploymentConfig + Output only. The time when the incident observability was last + changed. + readOnly: true + type: string + format: google-datetime + GoogleCloudApigeeV1ListSecurityIncidentsResponse: + id: GoogleCloudApigeeV1ListSecurityIncidentsResponse + description: Response for ListSecurityIncidents. + type: object properties: - endpoints: - type: object - additionalProperties: - type: string + securityIncidents: + description: List of security incidents in the organization + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' + nextPageToken: description: >- - A mapping from basepaths to proxy endpoint names in this proxy. Not - populated for shared flows. - location: + A token that can be sent as `page_token` to retrieve the next page. + If this field is omitted, there are no subsequent pages. type: string - description: Location of the API proxy bundle as a URI. - name: + GoogleCloudApigeeV1BatchUpdateSecurityIncidentsRequest: + id: GoogleCloudApigeeV1BatchUpdateSecurityIncidentsRequest + description: Request for BatchUpdateSecurityIncident. + type: object + properties: + requests: description: >- - Name of the API or shared flow revision to be deployed in the - following format: `organizations/{org}/apis/{api}/revisions/{rev}` - or `organizations/{org}/sharedflows/{sharedflow}/revisions/{rev}` - type: string - basePath: - type: string - description: Base path where the application will be hosted. Defaults to "/". - proxyUid: - description: Unique ID of the API proxy revision. - type: string - deploymentGroups: + Optional. Required. The request message specifying the resources to + update. A maximum of 1000 can be modified in a batch. + type: array items: - type: string + $ref: >- + #/components/schemas/GoogleCloudApigeeV1UpdateSecurityIncidentRequest + GoogleCloudApigeeV1UpdateSecurityIncidentRequest: + id: GoogleCloudApigeeV1UpdateSecurityIncidentRequest + description: Request for UpdateSecurityIncident. + type: object + properties: + securityIncident: description: >- - The list of deployment groups in which this proxy should be - deployed. Not currently populated for shared flows. - type: array - serviceAccount: - type: string + Required. The security incident to update. Must contain all existing + populated fields of the current incident. + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' + updateMask: description: >- - The service account identity associated with this deployment. If - non-empty, will be in the following format: - `projects/-/serviceAccounts/{account_email}` - uid: + Required. The list of fields to update. Allowed fields are: + LINT.IfChange(allowed_update_fields_comment) - observability + LINT.ThenChange() type: string - description: >- - Unique ID. The ID will only change if the deployment is deleted and - recreated. - attributes: - additionalProperties: - type: string - type: object - description: Additional key-value metadata for the deployment. + format: google-fieldmask + GoogleCloudApigeeV1BatchUpdateSecurityIncidentsResponse: + id: GoogleCloudApigeeV1BatchUpdateSecurityIncidentsResponse + description: Response for BatchUpdateSecurityIncident. type: object - GoogleIamV1AuditLogConfig: properties: - exemptedMembers: + securityIncidents: + description: Output only. Updated security incidents + readOnly: true type: array - description: >- - Specifies the identities that do not cause logging for this type of - permission. Follows the same format of Binding.members. items: - type: string - logType: - type: string - enumDescriptions: - - Default case. Should never be this. - - 'Admin reads. Example: CloudIAM getIamPolicy' - - 'Data writes. Example: CloudSQL Users create' - - 'Data reads. Example: CloudSQL Users list' - enum: - - LOG_TYPE_UNSPECIFIED - - ADMIN_READ - - DATA_WRITE - - DATA_READ - description: The log type that this config enables. - id: GoogleIamV1AuditLogConfig - type: object - 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. - GoogleCloudApigeeV1EnvironmentGroupAttachment: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' + GoogleCloudApigeeV1SecurityActionsConfig: + id: GoogleCloudApigeeV1SecurityActionsConfig description: >- - EnvironmentGroupAttachment is a resource which defines an attachment of - an environment to an environment group. + SecurityActionsConfig reflects the current state of the SecurityActions + feature. This is a singleton resource: https://google.aip.dev/156 type: object properties: - environment: - type: string - description: Required. ID of the attached environment. - environmentGroupId: - description: Output only. ID of the environment group. - readOnly: true - type: string - createdAt: + name: + description: >- + This is a singleton resource, the name will always be set by + SecurityActions and any user input will be ignored. The name is + always: + `organizations/{org}/environments/{env}/security_actions_config` type: string - format: int64 + enabled: description: >- - Output only. The time at which the environment group attachment was - created as milliseconds since epoch. + The flag that controls whether this feature is enabled. This is + `unset` by default. When this flag is `false`, even if individual + rules are enabled, no SecurityActions will be enforced. + type: boolean + updateTime: + description: Output only. The update time for configuration. readOnly: true - name: type: string - description: ID of the environment group attachment. - id: GoogleCloudApigeeV1EnvironmentGroupAttachment - GoogleCloudApigeeV1TlsInfo: + format: google-datetime + GoogleCloudApigeeV1SecurityAction: + id: GoogleCloudApigeeV1SecurityAction + description: >- + A SecurityAction is rule that can be enforced at an environment level. + The result is one of: - A denied API call - An explicitly allowed API + call - A flagged API call (HTTP headers added before the target receives + it) At least one condition is required to create a SecurityAction. + type: object properties: - enforce: - description: TLS is strictly enforced. - type: boolean - clientAuthEnabled: - type: boolean - description: Optional. Enables two-way TLS. - protocols: - type: array - description: The TLS versioins to be used. - items: - type: string - keyAlias: - type: string - description: >- - Required if `client_auth_enabled` is true. The resource ID for the - alias containing the private key and cert. - commonName: - $ref: '#/components/schemas/GoogleCloudApigeeV1TlsInfoCommonName' - description: The TLS Common Name of the certificate. - enabled: + name: description: >- - Required. Enables TLS. If false, neither one-way nor two-way TLS - will be enabled. - type: boolean - ignoreValidationErrors: + Immutable. This field is ignored during creation as per AIP-133. + Please set the `security_action_id` field in the + CreateSecurityActionRequest when creating a new SecurityAction. + Format: + organizations/{org}/environments/{env}/securityActions/{security_action} + type: string + description: description: >- - If true, Edge ignores TLS certificate errors. Valid when configuring - TLS for target servers and target endpoints, and when configuring - virtual hosts that use 2-way TLS. When used with a target - endpoint/target server, if the backend system uses SNI and returns a - cert with a subject Distinguished Name (DN) that does not match the - hostname, there is no way to ignore the error and the connection - fails. - type: boolean - trustStore: - description: The resource ID of the truststore. + Optional. An optional user provided description of the + SecurityAction. type: string - ciphers: - items: - type: string - type: array + state: description: >- - The SSL/TLS cipher suites to be used. For programmable proxies, it - must be one of the cipher suite names listed in: - http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites. - For configurable proxies, it must follow the configuration specified - in: - https://commondatastorage.googleapis.com/chromium-boringssl-docs/ssl.h.html#Cipher-suite-configuration. - This setting has no effect for configurable proxies when negotiating - TLS 1.3. - keyStore: - description: >- - Required if `client_auth_enabled` is true. The resource ID of the - keystore. + Required. Only an ENABLED SecurityAction is enforced. An ENABLED + SecurityAction past its expiration time will not be enforced. type: string - id: GoogleCloudApigeeV1TlsInfo - type: object - description: TLS configuration information for virtual hosts and TargetServers. - GoogleCloudApigeeV1DisableSecurityActionRequest: - description: Message to disable an enabled SecurityAction. - type: object - properties: {} - id: GoogleCloudApigeeV1DisableSecurityActionRequest - GoogleCloudApigeeV1FlowHookConfig: - type: object - properties: - sharedFlowName: + enumDescriptions: + - >- + The default value. This only exists for forward compatibility. A + create request with this value will be rejected. + - >- + An ENABLED SecurityAction is actively enforced if the + `expiration_time` is in the future. + - A disabled SecurityAction is never enforced. + enum: + - STATE_UNSPECIFIED + - ENABLED + - DISABLED + allow: + description: Allow a request through if it matches this SecurityAction. + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionAllow' + deny: + description: Deny a request through if it matches this SecurityAction. + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionDeny' + flag: + description: Flag a request through if it matches this SecurityAction. + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionFlag' + expireTime: + description: The expiration for this SecurityAction. type: string + format: google-datetime + ttl: + description: Input only. The TTL for this SecurityAction. + type: string + format: google-duration + createTime: + description: Output only. The create time for this SecurityAction. + readOnly: true + type: string + format: google-datetime + updateTime: description: >- - Name of the shared flow to invoke in the following format: - `organizations/{org}/sharedflows/{sharedflow}` - name: - description: >- - Name of the flow hook in the following format: - `organizations/{org}/environments/{env}/flowhooks/{point}`. Valid - `point` values include: `PreProxyFlowHook`, `PostProxyFlowHook`, - `PreTargetFlowHook`, and `PostTargetFlowHook` + Output only. The update time for this SecurityAction. This reflects + when this SecurityAction changed states. + readOnly: true type: string - continueOnError: + format: google-datetime + apiProxies: description: >- - Flag that specifies whether the flow should abort after an error in - the flow hook. Defaults to `true` (continue on error). - type: boolean - id: GoogleCloudApigeeV1FlowHookConfig - GoogleCloudApigeeV1ListSecurityProfilesV2Response: - id: GoogleCloudApigeeV1ListSecurityProfilesV2Response - description: Response for ListSecurityProfilesV2. - type: object - properties: - securityProfilesV2: + Optional. If unset, this would apply to all proxies in the + environment. If set, this action is enforced only if at least one + proxy in the repeated list is deployed at the time of enforcement. + If set, several restrictions are enforced on SecurityActions. There + can be at most 100 enabled actions with proxies set in an env. + Several other restrictions apply on conditions and are detailed + later. type: array - description: List of security profiles in the organization. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfileV2' - nextPageToken: + type: string + conditionConfig: description: >- - A token that can be sent as `page_token` to retrieve the next page. - If this field is omitted, there are no subsequent pages. - type: string - GoogleCloudApigeeV1ListSecurityProfilesResponse: + Required. A valid SecurityAction must contain at least one + condition. + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityActionConditionConfig + GoogleCloudApigeeV1SecurityActionAllow: + id: GoogleCloudApigeeV1SecurityActionAllow + description: >- + Message that should be set in case of an Allow Action. This does not + have any fields. + type: object + properties: {} + GoogleCloudApigeeV1SecurityActionDeny: + id: GoogleCloudApigeeV1SecurityActionDeny + description: Message that should be set in case of a Deny Action. + type: object properties: - nextPageToken: + responseCode: + description: Optional. The HTTP response code if the Action = DENY. + type: integer + format: int32 + GoogleCloudApigeeV1SecurityActionFlag: + id: GoogleCloudApigeeV1SecurityActionFlag + description: The message that should be set in the case of a Flag action. + type: object + properties: + headers: description: >- - A token that can be sent as `page_token` to retrieve the next page. - If this field is omitted, there are no subsequent pages. - type: string - securityProfiles: + Optional. A list of HTTP headers to be sent to the target in case of + a FLAG SecurityAction. Limit 5 headers per SecurityAction. At least + one is mandatory. type: array - description: >- - List of security profiles in the organization. The profiles may be - attached or unattached to any environment. This will return latest - revision of each profile. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' - description: Response for ListSecurityProfiles. + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionHttpHeader' + GoogleCloudApigeeV1SecurityActionHttpHeader: + id: GoogleCloudApigeeV1SecurityActionHttpHeader + description: An HTTP header. type: object - id: GoogleCloudApigeeV1ListSecurityProfilesResponse - GoogleCloudApigeeV1CommonNameConfig: properties: - matchWildCards: - type: boolean name: + description: The header name to be sent to the target. type: string - id: GoogleCloudApigeeV1CommonNameConfig - type: object - GoogleCloudApigeeV1Property: - type: object - description: A single property entry in the Properties message. - properties: value: - description: The property value - type: string - name: - description: The property key + description: The header value to be sent to the target. type: string - id: GoogleCloudApigeeV1Property - GoogleCloudApigeeV1Operation: - id: GoogleCloudApigeeV1Operation + GoogleCloudApigeeV1SecurityActionConditionConfig: + id: GoogleCloudApigeeV1SecurityActionConditionConfig description: >- - Represents the pairing of REST resource path and the actions (verbs) - allowed on the resource path. + The following are a list of conditions. A valid SecurityAction must + contain at least one condition. Within a condition, each element is + ORed. Across conditions elements are ANDed. For example if a + SecurityAction has the following: ip_address_ranges: ["ip1", "ip2"] and + bot_reasons: ["Flooder", "Robot Abuser"] then this is interpreted as: + enforce the action if the incoming request has ((ip_address_ranges = + "ip1" OR ip_address_ranges = "ip2") AND (bot_reasons="Flooder" OR + bot_reasons="Robot Abuser")). Conditions other than ip_address_ranges + and bot_reasons cannot be ANDed. + type: object properties: - methods: + ipAddressRanges: description: >- - methods refers to the REST verbs as in - https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html. When none - specified, all verb types are allowed. + Optional. A list of IP addresses. This could be either IPv4 or IPv6. + Limited to 100 per action. + type: array items: type: string - type: array - resource: - type: string - description: >- - Required. REST resource path associated with the API proxy or remote - service. - type: object - GoogleCloudApigeeV1CreditDeveloperBalanceRequest: - properties: - transactionId: - type: string + botReasons: description: >- - Each transaction_id uniquely identifies a credit balance request. If - multiple requests are received with the same transaction_id, only - one of them will be considered. - transactionAmount: + Optional. A list of Bot Reasons. Current options: Flooder, Brute + Guessor, Static Content Scraper, OAuth Abuser, Robot Abuser, + TorListRule, Advanced Anomaly Detection, Advanced API Scraper, + Search Engine Crawlers, Public Clouds, Public Cloud AWS, Public + Cloud Azure, and Public Cloud Google. + type: array + items: + type: string + httpMethods: description: >- - The amount of money to be credited. The wallet corresponding to the - currency specified within `transaction_amount` will be updated. For - example, if you specified `currency_code` within - `transaction_amount` as "USD", then the amount would be added to the - wallet which has the "USD" currency or if no such wallet exists, a - new wallet will be created with the "USD" currency. - $ref: '#/components/schemas/GoogleTypeMoney' - type: object - description: Request for CreditDeveloperBalance. - id: GoogleCloudApigeeV1CreditDeveloperBalanceRequest - GoogleCloudApigeeV1DeveloperApp: - id: GoogleCloudApigeeV1DeveloperApp - properties: + Optional. Act only on particular HTTP methods. E.g. A read-only API + can block POST/PUT/DELETE methods. Accepted values are: GET, HEAD, + POST, PUT, DELETE, CONNECT, OPTIONS, TRACE and PATCH. + type: array + items: + type: string + apiKeys: + description: Optional. A list of API keys. Limit 1000 per action. + type: array + items: + type: string + accessTokens: + description: Optional. A list of access_tokens. Limit 1000 per action. + type: array + items: + type: string apiProducts: + description: Optional. A list of API Products. Limit 1000 per action. + type: array items: type: string + developerApps: + description: Optional. A list of developer apps. Limit 1000 per action. type: array - description: List of API products associated with the developer app. - name: - type: string - description: Name of the developer app. - scopes: items: type: string - description: >- - Scopes to apply to the developer app. The specified scopes must - already exist for the API product that you associate with the - developer app. + developers: + description: Optional. A list of developers. Limit 1000 per action. type: array - createdAt: - readOnly: true + items: + type: string + userAgents: description: >- - Output only. Time the developer app was created in milliseconds - since epoch. - format: int64 - type: string - appFamily: - type: string - description: Developer app family. - keyExpiresIn: - description: >- - Expiration time, in milliseconds, for the consumer key that is - generated for the developer app. If not set or left to the default - value of `-1`, the API key never expires. The expiration time can't - be updated after it is set. - format: int64 - type: string - callbackUrl: - type: string - description: >- - Callback URL used by OAuth 2.0 authorization servers to communicate - authorization codes back to developer apps. - credentials: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Credential' - readOnly: true + Optional. A list of user agents to deny. We look for exact matches. + Limit 50 per action. type: array + items: + type: string + regionCodes: description: >- - Output only. Set of credentials for the developer app consisting of - the consumer key/secret pairs associated with the API products. - attributes: - description: List of attributes for the developer app. + Optional. A list of countries/region codes to act on, e.g. US. This + follows https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2. type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - appId: - type: string - description: ID of the developer app. - developerId: - description: ID of the developer. - type: string - lastModifiedAt: - type: string - readOnly: true - format: int64 - description: >- - Output only. Time the developer app was modified in milliseconds - since epoch. - status: - type: string + type: string + asns: description: >- - Status of the credential. Valid values include `approved` or - `revoked`. + Optional. A list of ASN numbers to act on, e.g. 23. + https://en.wikipedia.org/wiki/Autonomous_system_(Internet) This uses + int64 instead of uint32 because of + https://linter.aip.dev/141/forbidden-types. + type: array + items: + type: string + format: int64 + GoogleCloudApigeeV1ListSecurityActionsResponse: + id: GoogleCloudApigeeV1ListSecurityActionsResponse + description: >- + Contains a list of SecurityActions in response to a + ListSecurityActionRequest. type: object - GoogleCloudApigeeV1ResourceStatus: properties: - resource: - description: >- - The resource name. Currently only two resources are supported: - EnvironmentGroup - organizations/{org}/envgroups/{envgroup} - EnvironmentConfig - - organizations/{org}/environments/{environment}/deployedConfig - type: string - totalReplicas: - description: The total number of replicas that should have this resource. - format: int32 - type: integer - uid: - type: string - description: >- - The uid of the resource. In the unexpected case that the instance - has multiple uids for the same name, they should be reported under - separate ResourceStatuses. - revisions: + securityActions: + description: The SecurityActions for the specified environment. type: array - description: Revisions of the resource currently deployed in the instance. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1RevisionStatus' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + GoogleCloudApigeeV1EnableSecurityActionRequest: + id: GoogleCloudApigeeV1EnableSecurityActionRequest + description: Message to enable a disabled SecurityAction. type: object - id: GoogleCloudApigeeV1ResourceStatus - description: The status of a resource loaded in the runtime. - GoogleCloudApigeeV1OptimizedStatsResponse: - id: GoogleCloudApigeeV1OptimizedStatsResponse + properties: {} + GoogleCloudApigeeV1DisableSecurityActionRequest: + id: GoogleCloudApigeeV1DisableSecurityActionRequest + description: Message to disable an enabled SecurityAction. + type: object + properties: {} + GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequest: + id: GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequest + description: Request for BatchComputeSecurityAssessmentResults. type: object - description: Encapsulates a response format for JavaScript Optimized Scenario. properties: - metaData: - $ref: '#/components/schemas/GoogleCloudApigeeV1Metadata' - description: Metadata information about the query executed. - resultTruncated: + profile: + description: Required. Name of the profile that is used for computation. + type: string + scope: description: >- - Boolean flag that indicates whether the results were truncated based - on the limit parameter. - type: boolean - stats: - $ref: '#/components/schemas/GoogleCloudApigeeV1OptimizedStatsNode' - description: '`stats` results.' - TimeUnit: - type: array + Required. Scope of the resources for the computation. For Apigee, + the environment is the scope of the resources. + type: string + includeAllResources: + description: Include all resources under the scope. + $ref: >- + #/components/schemas/GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestIncludeAll + include: + description: Include only these resources. + $ref: >- + #/components/schemas/GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArray + pageSize: description: >- - List of time unit values. Time unit refers to an epoch timestamp - value. - items: - format: int64 - type: string - GoogleCloudApigeeV1ReportInstanceStatusResponse: + Optional. The maximum number of results to return. The service may + return fewer than this value. If unspecified, at most 50 results + will be returned. + type: integer + format: int32 + pageToken: + description: >- + Optional. A page token, received from a previous + `BatchComputeSecurityAssessmentResults` call. Provide this to + retrieve the subsequent page. + type: string + GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestIncludeAll: + id: >- + GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestIncludeAll + description: Message for include_all_resources option. type: object properties: {} - description: Placeholder for future enhancements to status reporting protocol - id: GoogleCloudApigeeV1ReportInstanceStatusResponse GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArray: - type: object - description: An array of resource messages. id: >- GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArray + description: >- + Message for the array of resources. For Apigee, the proxies are + resources. + type: object properties: resources: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArrayResource description: >- Required. The array of resources. For Apigee, the proxies are resources. - GoogleCloudApigeeV1ListDatastoresResponse: - type: object - id: GoogleCloudApigeeV1ListDatastoresResponse - description: The response for ListDatastores - properties: - datastores: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' type: array - description: A list of datastores - GoogleCloudApigeeV1CustomReportMetric: - description: >- - This encapsulates a metric property of the form sum(message_count) where - name is message_count and function is sum + items: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArrayResource + GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArrayResource: + id: >- + GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArrayResource + description: Resource for which we are computing security assessment. type: object - id: GoogleCloudApigeeV1CustomReportMetric properties: - function: + type: + description: Required. Type of this resource. type: string - description: aggregate function + enumDescriptions: + - ResourceType not specified. + - Resource is an Apigee Proxy. + enum: + - RESOURCE_TYPE_UNSPECIFIED + - API_PROXY name: - description: name of the metric + description: Required. Name of this resource. type: string - GoogleCloudApigeeV1SecurityActionFlag: + GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsResponse: + id: GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsResponse + description: Response for BatchComputeSecurityAssessmentResults. type: object properties: - headers: + securityAssessmentResults: + description: Default sort order is by resource name in alphabetic order. type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionHttpHeader' - description: >- - Optional. A list of HTTP headers to be sent to the target in case of - a FLAG SecurityAction. Limit 5 headers per SecurityAction. At least - one is mandatory. - description: The message that should be set in the case of a Flag action. - id: GoogleCloudApigeeV1SecurityActionFlag - GoogleCloudApigeeV1ListDeveloperSubscriptionsResponse: - description: Response for ListDeveloperSubscriptions. - id: GoogleCloudApigeeV1ListDeveloperSubscriptionsResponse - properties: - nextStartKey: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResult' + assessmentTime: + description: The time of the assessment api call. type: string - description: >- - Value that can be sent as `startKey` to retrieve the next page of - content. If this field is omitted, there are no subsequent pages. - developerSubscriptions: - description: List of all subscriptions. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription' - type: array - type: object - GoogleCloudApigeeV1ListDataCollectorsResponse: - properties: + format: google-datetime nextPageToken: - type: string description: >- - Page token that you can include in a ListDataCollectors request to - retrieve the next page. If omitted, no subsequent pages exist. - dataCollectors: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' - type: array - description: Data collectors in the specified organization. + A token that can be sent as `page_token` to retrieve the next page. + If this field is blank, there are no subsequent pages. + type: string + GoogleCloudApigeeV1SecurityAssessmentResult: + id: GoogleCloudApigeeV1SecurityAssessmentResult + description: The security assessment result for one resource. type: object - id: GoogleCloudApigeeV1ListDataCollectorsResponse - description: Response for ListDataCollectors. - GoogleCloudApigeeV1InstanceAttachment: - description: >- - InstanceAttachment represents the installation of an environment onto an - instance. properties: - createdAt: - readOnly: true + resource: + description: The assessed resource. + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResultResource + createTime: description: >- - Output only. Time the attachment was created in milliseconds since - epoch. - format: int64 - type: string - name: - type: string - description: Output only. ID of the attachment. - readOnly: true - environment: + The time of the assessment of this resource. This could lag behind + `assessment_time` due to caching within the backend. type: string - description: ID of the attached environment. - id: GoogleCloudApigeeV1InstanceAttachment - type: object - GoogleIamV1TestIamPermissionsResponse: - id: GoogleIamV1TestIamPermissionsResponse + format: google-datetime + scoringResult: + description: The result of the assessment. + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResultScoringResult + error: + description: The error status if scoring fails. + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudApigeeV1SecurityAssessmentResultResource: + id: GoogleCloudApigeeV1SecurityAssessmentResultResource + description: Resource for which we are computing security assessment. type: object - description: Response message for `TestIamPermissions` method. - properties: - permissions: - description: >- - A subset of `TestPermissionsRequest.permissions` that the caller is - allowed. - items: - type: string - type: array - GoogleCloudApigeeV1ResourceConfig: properties: - location: - description: Location of the resource as a URI. + type: + description: Required. Type of this resource. type: string + enumDescriptions: + - ResourceType not specified. + - Resource is an Apigee Proxy. + enum: + - RESOURCE_TYPE_UNSPECIFIED + - API_PROXY name: + description: Required. Name of this resource. + type: string + resourceRevisionId: description: >- - Resource name in the following format: - `organizations/{org}/environments/{env}/resourcefiles/{type}/{file}/revisions/{rev}` - Only environment-scoped resource files are supported. + The revision id for the resource. In case of Apigee, this is proxy + revision id. type: string + GoogleCloudApigeeV1SecurityAssessmentResultScoringResult: + id: GoogleCloudApigeeV1SecurityAssessmentResultScoringResult + description: The result of the assessment. type: object - id: GoogleCloudApigeeV1ResourceConfig - GoogleCloudApigeeV1FlowHook: properties: - description: + score: + description: The security score of the assessment. + type: integer + format: int32 + severity: type: string - description: Description of the flow hook. - continueOnError: - type: boolean + enumDescriptions: + - Severity is not defined. + - Severity is low. + - Severity is medium. + - Severity is high. + - Severity is minimal + enum: + - SEVERITY_UNSPECIFIED + - LOW + - MEDIUM + - HIGH + - MINIMAL + failedAssessmentPerWeight: description: >- - Optional. Flag that specifies whether execution should continue if - the flow hook throws an exception. Set to `true` to continue - execution. Set to `false` to stop execution if the flow hook throws - an exception. Defaults to `true`. - flowHookPoint: + The number of failed assessments grouped by its weight. Keys are one + of the following: "MAJOR", "MODERATE", "MINOR". + type: object + additionalProperties: + type: integer + format: int32 + assessmentRecommendations: description: >- - Output only. Where in the API call flow the flow hook is invoked. - Must be one of `PreProxyFlowHook`, `PostProxyFlowHook`, - `PreTargetFlowHook`, or `PostTargetFlowHook`. - type: string - readOnly: true - sharedFlow: + The recommendations of the assessment. The key is the "name" of the + assessment (not display_name), and the value are the + recommendations. + type: object + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendation + dataUpdateTime: description: >- - Shared flow attached to this flow hook, or empty if there is none - attached. + The time when resource data was last fetched for this resource. This + time may be different than when the resource was actually updated + due to lag in data collection. type: string + format: google-datetime + GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendation: + id: >- + GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendation + description: The message format of a recommendation from the assessment. type: object - id: GoogleCloudApigeeV1FlowHook - GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRoute: - id: GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRoute properties: - percentage: - description: Percentage of ingress replicas reporting this route. - type: integer - format: int32 - basepath: - description: Base path in the routing table. - type: string - envgroup: + displayName: + description: The display name of the assessment. type: string - description: Environment group where this route is installed. - environment: + weight: + description: The weight of the assessment which was set in the profile. type: string + enumDescriptions: + - The weight is unspecified. + - The weight is minor. + - The weight is moderate. + - The weight is major. + enum: + - WEIGHT_UNSPECIFIED + - MINOR + - MODERATE + - MAJOR + scoreImpact: description: >- - Destination environment. This will be empty if the route is not yet - reported. - type: object - description: Route deployed in the ingress routing table. - GoogleCloudApigeeV1ComputeEnvironmentScoresRequest: - id: GoogleCloudApigeeV1ComputeEnvironmentScoresRequest - description: Request for ComputeEnvironmentScores. - type: object - properties: - pageSize: - description: >- - Optional. The maximum number of subcomponents to be returned in a - single page. The service may return fewer than this value. If - unspecified, at most 100 subcomponents will be returned in a single - page. - format: int32 + Score impact indicates the impact on the overall score if the + assessment were to pass. type: integer - timeRange: - $ref: '#/components/schemas/GoogleTypeInterval' - description: >- - Required. Time range for score calculation. At most 14 days of - scores will be returned, and both the start and end dates must be - within the last 90 days. - pageToken: - description: >- - Optional. A token that can be sent as `page_token` to retrieve the - next page. If this field is omitted, there are no subsequent pages. + format: int32 + verdict: + description: Verdict indicates the assessment result. type: string - filters: + enumDescriptions: + - The verdict is unspecified. + - The assessment has passed. + - The assessment has failed. + enum: + - VERDICT_UNSPECIFIED + - PASS + - FAIL + recommendations: + description: The recommended steps of the assessment. + type: array items: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ComputeEnvironmentScoresRequestFilter - description: >- - Optional. Filters are used to filter scored components. Return all - the components if no filter is mentioned. Example: [{ "scorePath": - "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/source" - }, { "scorePath": - "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/target", - }] This will return components with path: - "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/source" - OR - "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/target" - type: array - GoogleCloudApigeeV1ProfileConfigCategory: + #/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendation + GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendation: + id: >- + GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendation + description: The format of the assessment recommendation. type: object - description: >- - Advanced API Security provides security profile that scores the - following categories. - properties: - mtls: - description: Checks to see if you have configured mTLS for the target server. - $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigMTLS' - cors: - description: Checks to see if you have CORS policy in place. - $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigCORS' - threat: - $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigThreat' - description: Checks to see if you have a threat protection policy in place. - abuse: - $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigAbuse' - description: >- - Checks for abuse, which includes any requests sent to the API for - purposes other than what it is intended for, such as high volumes of - requests, data scraping, and abuse related to authorization. - mediation: - $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigMediation' - description: Checks to see if you have a mediation policy in place. - authorization: - $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigAuthorization' - description: Checks to see if you have an authorization policy in place. - id: GoogleCloudApigeeV1ProfileConfigCategory - GoogleCloudApigeeV1DateRange: properties: - start: - description: >- - Required. Start date of the data to export in the format - `yyyy-mm-dd`. The date range begins at 00:00:00 UTC on the start - date. - type: string - end: - description: >- - Required. End date (exclusive) of the data to export in the format - `yyyy-mm-dd`. The date range ends at 00:00:00 UTC on the end date- - which will not be in the output. + description: + description: The description of the recommendation. type: string - id: GoogleCloudApigeeV1DateRange - type: object - description: Date range of the data to export. - GoogleCloudApigeeV1App: + link: + description: The link for the recommendation. + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendationLink + GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendationLink: + id: >- + GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendationLink + description: The format for a link in the recommendation. type: object - id: GoogleCloudApigeeV1App properties: - developerEmail: - type: string - description: Email of the developer. - companyName: - description: Name of the company that owns the app. - type: string - appGroup: + text: + description: 'The text of the url. (ie: "Learn more")' type: string - description: Name of the AppGroup - lastModifiedAt: - description: Output only. Last modified time as milliseconds since epoch. + uri: + description: The link itself. type: string - format: int64 - readOnly: true + GoogleCloudApigeeV1SecurityProfileV2: + id: GoogleCloudApigeeV1SecurityProfileV2 + description: Security profile for risk assessment version 2. + type: object + properties: name: - description: Name of the app. - type: string - developerId: - description: ID of the developer. + description: >- + Identifier. Name of the security profile v2 resource. Format: + organizations/{org}/securityProfilesV2/{profile} type: string - callbackUrl: + description: + description: Optional. The description of the security profile. type: string - description: >- - Callback URL used by OAuth 2.0 authorization servers to communicate - authorization codes back to apps. - appId: + createTime: + description: Output only. The time of the security profile creation. + readOnly: true type: string - description: ID of the app. - status: + format: google-datetime + updateTime: + description: Output only. The time of the security profile update. + readOnly: true type: string - description: Status of the credential. - keyExpiresIn: + format: google-datetime + profileAssessmentConfigs: description: >- - Duration, in milliseconds, of the consumer key that will be - generated for the app. The default value, -1, indicates an infinite - validity period. Once set, the expiration can't be updated. json - key: keyExpiresIn - type: string - format: int64 - apiProducts: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProductRef' - description: List of API products associated with the app. - type: array - attributes: - description: List of attributes. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - type: array - createdAt: + Required. The configuration for each assessment in this profile. Key + is the name/id of the assessment. + type: object + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityProfileV2ProfileAssessmentConfig + googleDefined: + description: Output only. Whether the security profile is google defined. readOnly: true + type: boolean + GoogleCloudApigeeV1SecurityProfileV2ProfileAssessmentConfig: + id: GoogleCloudApigeeV1SecurityProfileV2ProfileAssessmentConfig + description: The configuration definition for a specific assessment. + type: object + properties: + weight: + description: The weight of the assessment. type: string - format: int64 - description: Output only. Unix time when the app was created. - scopes: + enumDescriptions: + - The weight is unspecified. + - The weight is minor. + - The weight is moderate. + - The weight is major. + enum: + - WEIGHT_UNSPECIFIED + - MINOR + - MODERATE + - MAJOR + GoogleCloudApigeeV1ListSecurityProfilesV2Response: + id: GoogleCloudApigeeV1ListSecurityProfilesV2Response + description: Response for ListSecurityProfilesV2. + type: object + properties: + securityProfilesV2: + description: List of security profiles in the organization. type: array items: - type: string - description: >- - Scopes to apply to the app. The specified scope names must already - exist on the API product that you associate with the app. - credentials: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Credential' - type: array - readOnly: true + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfileV2' + nextPageToken: description: >- - Output only. Set of credentials for the app. Credentials are API - key/secret pairs associated with API products. - GoogleCloudApigeeV1QueryMetric: - id: GoogleCloudApigeeV1QueryMetric + A token that can be sent as `page_token` to retrieve the next page. + If this field is omitted, there are no subsequent pages. + type: string + GoogleCloudApigeeV1SecurityMonitoringCondition: + id: GoogleCloudApigeeV1SecurityMonitoringCondition + description: Security monitoring condition for risk assessment version 2. type: object properties: - function: - type: string - description: 'Aggregation function: avg, min, max, or sum.' name: - description: Required. Metric name. + description: >- + Identifier. Name of the security monitoring condition resource. + Format: + organizations/{org}/securityMonitoringConditions/{security_monitoring_condition} type: string - value: - description: Operand value should be provided when operator is set. + createTime: + description: Output only. The time of the security monitoring condition creation. + readOnly: true type: string - alias: + format: google-datetime + updateTime: + description: Output only. The time of the security monitoring condition update. + readOnly: true type: string + format: google-datetime + profile: description: >- - Alias for the metric. Alias will be used to replace metric name in - query results. - operator: + Required. ID of security profile of the security monitoring + condition. type: string - description: One of `+`, `-`, `/`, `%`, `*`. - description: >- - More info about Metric: - https://docs.apigee.com/api-platform/analytics/analytics-reference#metrics - GoogleCloudApigeeV1ProfileConfigThreat: - id: GoogleCloudApigeeV1ProfileConfigThreat - description: >- - By default, following policies will be included: - XMLThreatProtection - - JSONThreatProtection - properties: {} + scope: + description: >- + Required. Scope of the security monitoring condition. For Apigee, + the environment is the scope of the resources. + type: string + includeAllResources: + description: Include all resources under the scope. + $ref: >- + #/components/schemas/GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestIncludeAll + include: + description: Include only these resources. + $ref: >- + #/components/schemas/GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArray + totalMonitoredResources: + description: >- + Output only. Total number of monitored resources within this + condition. + readOnly: true + type: integer + format: int32 + totalDeployedResources: + description: Output only. Total number of deployed resources within scope. + readOnly: true + type: integer + format: int32 + GoogleCloudApigeeV1ListSecurityMonitoringConditionsResponse: + id: GoogleCloudApigeeV1ListSecurityMonitoringConditionsResponse + description: Response for ListSecurityMonitoringConditions. type: object - GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsResponse: - id: GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsResponse properties: - securityAssessmentResults: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResult' - description: Default sort order is by resource name in alphabetic order. + securityMonitoringConditions: + description: List of security monitoring conditions in the organization. type: array - assessmentTime: - format: google-datetime - description: The time of the assessment api call. - type: string + items: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityMonitoringCondition nextPageToken: - type: string description: >- A token that can be sent as `page_token` to retrieve the next page. - If this field is blank, there are no subsequent pages. - type: object - description: Response for BatchComputeSecurityAssessmentResults. - GoogleCloudApigeeV1GetSyncAuthorizationRequest: - properties: {} - description: Request for GetSyncAuthorization. - id: GoogleCloudApigeeV1GetSyncAuthorizationRequest - type: object - GoogleCloudApigeeV1MetricAggregation: - properties: - aggregation: - enumDescriptions: - - Unspecified Aggregation function. - - Average. - - Summation. - - Min. - - Max. - - Count distinct - description: Aggregation function associated with the metric. - enum: - - AGGREGATION_FUNCTION_UNSPECIFIED - - AVG - - SUM - - MIN - - MAX - - COUNT_DISTINCT - type: string - order: - enumDescriptions: - - Unspecified order. Default is Descending. - - Ascending sort order. - - Descending sort order. - type: string - enum: - - ORDER_UNSPECIFIED - - ASCENDING - - DESCENDING - description: >- - Ordering for this aggregation in the result. For time series this is - ignored since the ordering of points depends only on the timestamp, - not the values. - name: - description: Name of the metric + If this field is omitted, there are no subsequent pages. type: string - description: The optionally aggregated metric to query with its ordering. + GoogleCloudApigeeV1SecuritySettings: + id: GoogleCloudApigeeV1SecuritySettings + description: >- + SecuritySettings reflects the current state of the SecuritySettings + feature. type: object - id: GoogleCloudApigeeV1MetricAggregation - GoogleCloudApigeeV1Subscription: - description: Pub/Sub subscription of an environment. - id: GoogleCloudApigeeV1Subscription properties: name: description: >- - Full name of the Pub/Sub subcription. Use the following structure in - your request: `subscription "projects/foo/subscription/bar"` + Identifier. Full resource name is always + `organizations/{org}/securitySettings`. type: string - type: object - GoogleLongrunningOperation: - properties: - done: - type: boolean + mlRetrainingFeedbackEnabled: description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - metadata: - description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - error: - description: >- - The error result of the operation in case of failure or - cancellation. - $ref: '#/components/schemas/GoogleRpcStatus' + Optional. If true the user consents to the use of ML models for + Abuse detection. + type: boolean + GoogleCloudApigeeV1KeyValueMap: + id: GoogleCloudApigeeV1KeyValueMap + description: Collection of key/value string pairs. + type: object + properties: name: + description: Required. ID of the key value map. type: string + encrypted: description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. - response: - description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any + Required. Flag that specifies whether entry values will be + encrypted. This field is retained for backward compatibility and the + value of encrypted will always be `true`. Apigee X and hybrid do not + support unencrypted key value maps. + type: boolean + GoogleCloudApigeeV1KeyValueEntry: + id: GoogleCloudApigeeV1KeyValueEntry description: >- - This resource represents a long-running operation that is the result of - a network API call. - id: GoogleLongrunningOperation - type: object - GoogleCloudApigeeV1ListInstancesResponse: - id: GoogleCloudApigeeV1ListInstancesResponse + Key value map pair where the value represents the data associated with + the corresponding key. **Note**: Supported for Apigee hybrid 1.8.x and + higher. type: object properties: - nextPageToken: + name: description: >- - Page token that you can include in a ListInstance request to - retrieve the next page of content. If omitted, no subsequent pages - exist. + Resource URI that can be used to identify the scope of the key value + map entries. type: string - instances: - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Instance' - description: Instances in the specified organization. - description: Response for ListInstances. - GoogleCloudApigeeV1AccessRemove: - type: object - id: GoogleCloudApigeeV1AccessRemove - properties: - name: + value: + description: >- + Required. Data or payload that is being retrieved and associated + with the unique key. type: string - success: - type: boolean + GoogleCloudApigeeV1ListKeyValueEntriesResponse: + id: GoogleCloudApigeeV1ListKeyValueEntriesResponse description: >- - Remove action. For example, "Remove" : { "name" : "target.name", - "success" : true } - GoogleCloudApigeeV1SchemaSchemaElement: - description: Message type for the schema element + The request structure for listing key value map keys and its + corresponding values. type: object properties: - properties: + keyValueEntries: + description: One or more key value map keys and values. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + nextPageToken: description: >- - Properties for the schema field. For example: { "createTime": - "2016-02-26T10:23:09.592Z", "custom": "false", "type": "string" } - $ref: '#/components/schemas/GoogleCloudApigeeV1SchemaSchemaProperty' - name: + Token that can be sent as `next_page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. type: string - description: Name of the field. - id: GoogleCloudApigeeV1SchemaSchemaElement - GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendation: + GoogleCloudApigeeV1RatePlan: + id: GoogleCloudApigeeV1RatePlan + description: Rate plan details. type: object properties: + name: + description: Output only. Name of the rate plan. + readOnly: true + type: string + apiproduct: + description: Name of the API product that the rate plan is associated with. + type: string displayName: - description: The display name of the assessment. + description: Display name of the rate plan. type: string - recommendations: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendation - description: The recommended steps of the assessment. - scoreImpact: - format: int32 - description: >- - Score impact indicates the impact on the overall score if the - assessment were to pass. - type: integer - weight: - description: The weight of the assessment which was set in the profile. - enum: - - WEIGHT_UNSPECIFIED - - MINOR - - MODERATE - - MAJOR + description: + description: Description of the rate plan. + type: string + billingPeriod: + description: Frequency at which the customer will be billed. type: string enumDescriptions: - - The weight is unspecified. - - The weight is minor. - - The weight is moderate. - - The weight is major. - verdict: - description: Verdict indicates the assessment result. + - Billing period not specified. + - >- + Weekly billing period. **Note**: Not supported by Apigee at this + time. + - Monthly billing period. enum: - - VERDICT_UNSPECIFIED - - PASS - - FAIL + - BILLING_PERIOD_UNSPECIFIED + - WEEKLY + - MONTHLY + paymentFundingModel: + description: >- + DEPRECATED: This field is no longer supported and will eventually be + removed when Apigee Hybrid 1.5/1.6 is no longer supported. Instead, + use the `billingType` field inside `DeveloperMonetizationConfig` + resource. Flag that specifies the billing account type, prepaid or + postpaid. + deprecated: true + type: string enumDescriptions: - - The verdict is unspecified. - - The assessment has passed. - - The assessment has failed. + - Billing account type not specified. + - >- + Prepaid billing account type. Developer pays in advance for the + use of your API products. Funds are deducted from their prepaid + account balance. **Note**: Not supported by Apigee at this time. + - >- + Postpaid billing account type. Developer is billed through an + invoice after using your API products. + enum: + - PAYMENT_FUNDING_MODEL_UNSPECIFIED + - PREPAID + - POSTPAID + currencyCode: + description: >- + Currency to be used for billing. Consists of a three-letter code as + defined by the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) + standard. type: string - id: >- - GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendation - description: The message format of a recommendation from the assessment. - GoogleCloudApigeeV1ListArchiveDeploymentsResponse: - id: GoogleCloudApigeeV1ListArchiveDeploymentsResponse - description: Response for ListArchiveDeployments method. - properties: - archiveDeployments: - description: Archive Deployments in the specified environment. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' - type: array - nextPageToken: + setupFee: + description: Initial, one-time fee paid when purchasing the API product. + $ref: '#/components/schemas/GoogleTypeMoney' + fixedRecurringFee: + description: >- + Fixed amount that is charged at a defined interval and billed in + advance of use of the API product. The fee will be prorated for the + first billing period. + $ref: '#/components/schemas/GoogleTypeMoney' + fixedFeeFrequency: + description: Frequency at which the fixed fee is charged. + type: integer + format: int32 + consumptionPricingType: + description: Pricing model used for consumption-based charges. type: string + enumDescriptions: + - Pricing model not specified. This is the default. + - Fixed rate charged for each API call. + - >- + Variable rate charged for each API call based on price tiers. + Example: * 1-100 calls cost $2 per call * 101-200 calls cost $1.50 + per call * 201-300 calls cost $1 per call * Total price for 50 + calls: 50 x $2 = $100 * Total price for 150 calls: 100 x $2 + 50 x + $1.5 = $275 * Total price for 250 calls: 100 x $2 + 100 x $1.5 + + 50 x $1 = $400. + - '**Note**: Not supported by Apigee at this time.' + - '**Note**: Not supported by Apigee at this time.' + enum: + - CONSUMPTION_PRICING_TYPE_UNSPECIFIED + - FIXED_PER_UNIT + - BANDED + - TIERED + - STAIRSTEP + consumptionPricingRates: description: >- - Page token that you can include in a ListArchiveDeployments request - to retrieve the next page. If omitted, no subsequent pages exist. - type: object - GoogleCloudApigeeV1DebugMask: - id: GoogleCloudApigeeV1DebugMask - properties: - requestJSONPaths: + API call volume ranges and the fees charged when the total number of + API calls is within a given range. The method used to calculate the + final fee depends on the selected pricing model. For example, if the + pricing model is `BANDED` and the ranges are defined as follows: ``` + { "start": 1, "end": 100, "fee": 2 }, { "start": 101, "end": 200, + "fee": 1.50 }, { "start": 201, "end": 0, "fee": 1 }, } ``` Then the + following fees would be charged based on the total number of API + calls (assuming the currency selected is `USD`): * 50 calls cost 50 + x $2 = $100 * 150 calls cost 100 x $2 + 50 x $1.5 = $275 * 250 calls + cost 100 x $2 + 100 x $1.5 + 50 x $1 = $400 * 500 calls cost 100 x + $2 + 100 x $1.5 + 300 x $1 = $650 type: array items: - type: string - description: >- - List of JSON paths that specify the JSON elements to be filtered - from JSON request message payloads. - requestXPaths: - type: array - description: >- - List of XPaths that specify the XML elements to be filtered from XML - request message payloads. - items: - type: string - responseJSONPaths: - items: - type: string - description: >- - List of JSON paths that specify the JSON elements to be filtered - from JSON response message payloads. - type: array - variables: - items: - type: string - type: array - description: List of variables that should be masked from the debug output. - namespaces: - type: object - additionalProperties: - type: string - description: Map of namespaces to URIs. - faultXPaths: + $ref: '#/components/schemas/GoogleCloudApigeeV1RateRange' + revenueShareType: + description: Method used to calculate the revenue that is shared with developers. + type: string + enumDescriptions: + - Revenue share type is not specified. + - >- + Fixed percentage of the total revenue will be shared. The + percentage to be shared can be configured by the API provider. + - >- + Amount of revenue shared depends on the number of API calls. The + API call volume ranges and the revenue share percentage for each + volume can be configured by the API provider. **Note**: Not + supported by Apigee at this time. + enum: + - REVENUE_SHARE_TYPE_UNSPECIFIED + - FIXED + - VOLUME_BANDED + revenueShareRates: + description: Details of the revenue sharing model. type: array items: - type: string + $ref: '#/components/schemas/GoogleCloudApigeeV1RevenueShareRange' + state: + description: Current state of the rate plan (draft or published). + type: string + enumDescriptions: + - State of the rate plan is not specified. + - Rate plan is in draft mode and only visible to API providers. + - >- + Rate plan is published and will become visible to developers for + the configured duration (between `startTime` and `endTime`). + enum: + - STATE_UNSPECIFIED + - DRAFT + - PUBLISHED + startTime: + description: Time when the rate plan becomes active in milliseconds since epoch. + type: string + format: int64 + endTime: description: >- - List of XPaths that specify the XML elements to be filtered from XML - payloads in error flows. - responseXPaths: - items: - type: string + Time when the rate plan will expire in milliseconds since epoch. Set + to 0 or `null` to indicate that the rate plan should never expire. + type: string + format: int64 + createdAt: description: >- - List of XPaths that specify the XML elements to be filtered from XML - response message payloads. - type: array - name: + Output only. Time that the rate plan was created in milliseconds + since epoch. + readOnly: true type: string - description: Name of the debug mask. - faultJSONPaths: - items: - type: string + format: int64 + lastModifiedAt: description: >- - List of JSON paths that specify the JSON elements to be filtered - from JSON payloads in error flows. - type: array + Output only. Time the rate plan was last modified in milliseconds + since epoch. + readOnly: true + type: string + format: int64 + GoogleCloudApigeeV1RateRange: + id: GoogleCloudApigeeV1RateRange + description: >- + API call volume range and the fees charged when the total number of API + calls is within the range. type: object - GoogleCloudApigeeV1ApiDocDocumentation: properties: - oasDocumentation: - $ref: '#/components/schemas/GoogleCloudApigeeV1OASDocumentation' - description: Optional. OpenAPI Specification documentation. - graphqlDocumentation: - description: Optional. GraphQL documentation. - $ref: '#/components/schemas/GoogleCloudApigeeV1GraphqlDocumentation' - type: object - description: The documentation for a catalog item. - id: GoogleCloudApigeeV1ApiDocDocumentation - GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendationLink: + start: + description: >- + Starting value of the range. Set to 0 or `null` for the initial + range of values. + type: string + format: int64 + end: + description: >- + Ending value of the range. Set to 0 or `null` for the last range of + values. + type: string + format: int64 + fee: + description: >- + Fee to charge when total number of API calls falls within this + range. + $ref: '#/components/schemas/GoogleTypeMoney' + GoogleCloudApigeeV1RevenueShareRange: + id: GoogleCloudApigeeV1RevenueShareRange + description: >- + API call volume range and the percentage of revenue to share with the + developer when the total number of API calls is within the range. type: object - id: >- - GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendationLink - description: The format for a link in the recommendation. properties: - text: + start: + description: >- + Starting value of the range. Set to 0 or `null` for the initial + range of values. type: string - description: 'The text of the url. (ie: "Learn more")' - uri: + format: int64 + end: + description: >- + Ending value of the range. Set to 0 or `null` for the last range of + values. type: string - description: The link itself. - GoogleCloudApigeeV1SecurityReportQuery: + format: int64 + sharePercentage: + description: >- + Percentage of the revenue to be shared with the developer. For + example, to share 21 percent of the total revenue with the + developer, set this value to 21. Specify a decimal number with a + maximum of two digits following the decimal point. + type: number + format: double + GoogleCloudApigeeV1ListRatePlansResponse: + id: GoogleCloudApigeeV1ListRatePlansResponse + description: Response for ListRatePlans. + type: object properties: - metrics: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportQueryMetric' + ratePlans: + description: List of rate plans in an organization. type: array - description: A list of Metrics. - dimensions: items: - type: string - type: array + $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' + nextStartKey: description: >- - A list of dimensions. - https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions - reportDefinitionId: - description: Report Definition ID. + Value that can be sent as `startKey` to retrieve the next page of + content. If this field is omitted, there are no subsequent pages. type: string - csvDelimiter: + GoogleCloudApigeeV1DebugSession: + id: GoogleCloudApigeeV1DebugSession + type: object + properties: + name: + description: A unique ID for this DebugSession. type: string + validity: description: >- - Delimiter used in the CSV file, if `outputFormat` is set to `csv`. - Defaults to the `,` (comma) character. Supported delimiter - characters include comma (`,`), pipe (`|`), and tab (`\t`). - timeRange: + Optional. The length of time, in seconds, that this debug session is + valid, starting from when it's received in the control plane. Min = + 1, Max = 15, Default = 10. + type: integer + format: int32 + count: description: >- - Required. Time range for the query. Can use the following predefined - strings to specify the time range: `last60minutes` `last24hours` - `last7days` Or, specify the timeRange as a structure describing - start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. - Example: "timeRange": { "start": "2018-07-29T00:13:00Z", "end": - "2018-08-01T00:18:00Z" } - type: any + Optional. The number of request to be traced. Min = 1, Max = 15, + Default = 10. + type: integer + format: int32 + tracesize: + description: >- + Optional. The maximum number of bytes captured from the response + payload. Min = 0, Max = 5120, Default = 5120. + type: integer + format: int32 filter: description: >- - Boolean expression that can be used to filter data. Filter - expressions can be combined using AND/OR terms and should be fully - parenthesized to avoid ambiguity. See Analytics metrics, dimensions, - and filters reference - https://docs.apigee.com/api-platform/analytics/analytics-reference - for more information on the fields available to filter on. For more - information on the tokens that you use to build filter expressions, - see Filter expression syntax. - https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax + Optional. A conditional statement which is evaluated against the + request message to determine if it should be traced. Syntax matches + that of on API Proxy bundle flow Condition. type: string - groupByTimeUnit: + timeout: description: >- - Time unit used to group the result set. Valid values include: - second, minute, hour, day, week, or month. If a query includes - groupByTimeUnit, then the result is an aggregation based on the - specified time unit and the resultant timestamp does not include - milliseconds precision. If a query omits groupByTimeUnit, then the - resultant timestamp includes milliseconds precision. - type: string - envgroupHostname: + Optional. The time in seconds after which this DebugSession should + end. This value will override the value in query param, if both are + provided. type: string + format: int64 + createTime: description: >- - Hostname needs to be specified if query intends to run at host - level. This field is only allowed when query is submitted by - CreateHostSecurityReport where analytics data will be grouped by - organization and hostname. - mimeType: - description: >- - Valid values include: `csv` or `json`. Defaults to `json`. Note: - Configure the delimiter for CSV output using the csvDelimiter - property. + Output only. The first transaction creation timestamp, recorded by + UAP. + readOnly: true type: string - limit: - description: Maximum number of rows that can be returned in the result. - format: int32 - type: integer - displayName: - description: Security Report display name which users can specify. - type: string - description: Body structure when user makes a request to create a security report. - type: object - id: GoogleCloudApigeeV1SecurityReportQuery - GoogleCloudApigeeV1ListApiDocsResponse: + format: google-datetime + GoogleCloudApigeeV1ListDebugSessionsResponse: + id: GoogleCloudApigeeV1ListDebugSessionsResponse type: object properties: - data: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDoc' - description: The catalog item resources. + sessions: + description: >- + Session info that includes debug session ID and the first + transaction creation timestamp. type: array - errorCode: - type: string - description: Unique error code for the request, if any. - requestId: - description: Unique ID of the request. - type: string - message: - type: string - description: Description of the operation. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Session' nextPageToken: description: >- - A token, which can be sent as `page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. - type: string - status: + Page token that you can include in a ListDebugSessionsRequest to + retrieve the next page. If omitted, no subsequent pages exist. type: string - description: Status of the operation. - id: GoogleCloudApigeeV1ListApiDocsResponse - GoogleCloudApigeeV1SecurityActionHttpHeader: + GoogleCloudApigeeV1Session: + id: GoogleCloudApigeeV1Session + description: Session carries the debug session id and its creation time. type: object properties: - value: + id: + description: The debug session ID. type: string - description: The header value to be sent to the target. - name: - description: The header name to be sent to the target. + timestampMs: + description: >- + The first transaction creation timestamp in millisecond, recorded by + UAP. type: string - description: An HTTP header. - id: GoogleCloudApigeeV1SecurityActionHttpHeader - GoogleCloudApigeeV1ListApiProductsResponse: + format: int64 + GoogleCloudApigeeV1ListApiDebugSessionsResponse: + id: GoogleCloudApigeeV1ListApiDebugSessionsResponse + description: Response for ListApiDebugSessions. type: object - id: GoogleCloudApigeeV1ListApiProductsResponse properties: - apiProduct: - description: Lists all API product names defined for an organization. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' + sessions: + description: >- + Session info that includes debug session ID, environment ID, api + proxy revision ID and the first transaction creation timestamp. type: array - GoogleCloudApigeeV1ComputeEnvironmentScoresRequestFilter: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDebugSession' + nextPageToken: + description: >- + Page token that you can include in a ListApiDebugSessionsRequest to + retrieve the next page. If omitted, no subsequent pages exist. + type: string + GoogleCloudApigeeV1ApiDebugSession: + id: GoogleCloudApigeeV1ApiDebugSession + description: Session carries the debug session id and its creation time. type: object - id: GoogleCloudApigeeV1ComputeEnvironmentScoresRequestFilter - description: >- - Filter scores by component path. Used custom filter instead of AIP-160 - as the use cases are highly constrained and predictable. properties: - scorePath: + id: + description: The debug session ID. type: string - description: >- - Optional. Return scores for this component. Example: - "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/source" - GoogleCloudApigeeV1ApiProductRef: - properties: - status: - description: Status of the API product. Valid values are `approved` or `revoked`. + apiProxyRevisionId: + description: The revision ID of the deployed API proxy. type: string - apiproduct: - description: Name of the API product. + environmentId: + description: The environment ID of the deployed API proxy. type: string - id: GoogleCloudApigeeV1ApiProductRef + createTime: + description: >- + The first transaction creation timestamp in millisecond, recorded by + UAP. + type: string + format: google-datetime + GoogleCloudApigeeV1DebugSessionTransaction: + id: GoogleCloudApigeeV1DebugSessionTransaction + description: >- + A transaction contains all of the debug information of the entire + message flow of an API call processed by the runtime plane. The + information is collected and recorded at critical points of the message + flow in the runtime apiproxy. type: object - GoogleCloudApigeeV1SetAddonEnablementRequest: - description: Request for SetAddonEnablement. properties: - apiSecurityEnabled: - type: boolean - description: If the API Security should be enabled in the environment. - analyticsEnabled: - description: If the Analytics should be enabled in the environment. + completed: + description: Flag indicating whether a transaction is completed or not type: boolean - id: GoogleCloudApigeeV1SetAddonEnablementRequest + point: + description: >- + List of debug data collected by runtime plane at various defined + points in the flow. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Point' + GoogleCloudApigeeV1Point: + id: GoogleCloudApigeeV1Point + description: >- + Point is a group of information collected by runtime plane at critical + points of the message flow of the processed API request. This is a list + of supported point IDs, categorized to three major buckets. For each + category, debug points that we are currently supporting are listed + below: - Flow status debug points: StateChange FlowInfo Condition + Execution DebugMask Error - Flow control debug points: FlowCallout + Paused Resumed FlowReturn BreakFlow Error - Runtime debug points: + ScriptExecutor FlowCalloutStepDefinition CustomTarget StepDefinition + Oauth2ServicePoint RaiseFault NodeJS The detail information of the given + debug point is stored in a list of results. type: object - GoogleCloudApigeeV1ExportRequest: properties: - datastoreName: - description: Required. Name of the preconfigured datastore. + id: + description: Name of a step in the transaction. type: string - name: + results: + description: List of results extracted from a given debug point. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Result' + GoogleCloudApigeeV1Result: + id: GoogleCloudApigeeV1Result + description: >- + Result is short for "action result", could be different types identified + by "action_result" field. Supported types: 1. DebugInfo : generic debug + info collected by runtime recorded as a list of properties. For example, + the contents could be virtual host info, state change result, or + execution metadata. Required fields : properties, timestamp 2. + RequestMessage: information of a http request. Contains headers, request + URI and http methods type.Required fields : headers, uri, verb 3. + ResponseMessage: information of a http response. Contains headers, + reason phrase and http status code. Required fields : headers, + reasonPhrase, statusCode 4. ErrorMessage: information of a http error + message. Contains detail error message, reason phrase and status code. + Required fields : content, headers, reasonPhrase, statusCode 5. + VariableAccess: a list of variable access actions, can be Get, Set and + Remove. Required fields : accessList + type: object + properties: + ActionResult: + description: >- + Type of the action result. Can be one of the five: DebugInfo, + RequestMessage, ResponseMessage, ErrorMessage, VariableAccess type: string - description: Required. Display name of the export job. - csvDelimiter: + properties: + description: Name value pairs used for DebugInfo ActionResult. + $ref: '#/components/schemas/GoogleCloudApigeeV1Properties' + timestamp: + description: >- + Timestamp of when the result is recorded. Its format is dd-mm-yy + hh:mm:ss:xxx. For example, `"timestamp" : "12-08-19 00:31:59:960"` type: string + headers: description: >- - Optional. Delimiter used in the CSV file, if `outputFormat` is set - to `csv`. Defaults to the `,` (comma) character. Supported delimiter - characters include comma (`,`), pipe (`|`), and tab (`\t`). - outputFormat: + A list of HTTP headers. for example, '"headers" : [ { "name" : + "Content-Length", "value" : "83" }, { "name" : "Content-Type", + "value" : "application/json" } ]' + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Property' + uRI: + description: >- + The relative path of the api proxy. for example, `"uRI" : + "/iloveapis"` + type: string + verb: + description: HTTP method verb type: string + accessList: description: >- - Optional. Output format of the export. Valid values include: `csv` - or `json`. Defaults to `json`. Note: Configure the delimiter for CSV - output using the `csvDelimiter` property. - dateRange: - $ref: '#/components/schemas/GoogleCloudApigeeV1DateRange' - description: Required. Date range of the data to export. - description: + A list of variable access actions agaist the api proxy. Supported + values: Get, Set, Remove. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Access' + reasonPhrase: + description: HTTP response phrase type: string - description: Optional. Description of the export job. - id: GoogleCloudApigeeV1ExportRequest - description: Request body for [CreateExportRequest] + statusCode: + description: HTTP response code + type: string + content: + description: >- + Error message content. for example, "content" : + "{\"fault\":{\"faultstring\":\"API timed + out\",\"detail\":{\"errorcode\":\"flow.APITimedOut\"}}}" + type: string + GoogleCloudApigeeV1Access: + id: GoogleCloudApigeeV1Access type: object - GoogleCloudApigeeV1TraceConfigOverride: + properties: + Get: + $ref: '#/components/schemas/GoogleCloudApigeeV1AccessGet' + Set: + $ref: '#/components/schemas/GoogleCloudApigeeV1AccessSet' + Remove: + $ref: '#/components/schemas/GoogleCloudApigeeV1AccessRemove' + GoogleCloudApigeeV1AccessGet: + id: GoogleCloudApigeeV1AccessGet + description: >- + Get action. For example, "Get" : { "name" : "target.name", "value" : + "default" } type: object properties: - apiProxy: + name: type: string - description: >- - ID of the API proxy that will have its trace configuration - overridden. + value: + type: string + GoogleCloudApigeeV1AccessSet: + id: GoogleCloudApigeeV1AccessSet + description: >- + Set action. For example, "Set" : { "name" : "target.name", "success" : + true, "value" : "default" } + type: object + properties: name: type: string - description: >- - ID of the trace configuration override specified as a - system-generated UUID. - samplingConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceSamplingConfig' - description: Trace configuration to override. - id: GoogleCloudApigeeV1TraceConfigOverride - description: A representation of a configuration override. - parameters: - alt: + success: + type: boolean + value: + type: string + GoogleCloudApigeeV1AccessRemove: + id: GoogleCloudApigeeV1AccessRemove + description: >- + Remove action. For example, "Remove" : { "name" : "target.name", + "success" : true } + type: object + properties: + name: + type: string + success: + type: boolean + GoogleCloudApigeeV1ApiCategory: + id: GoogleCloudApigeeV1ApiCategory + description: >- + `ApiCategory` represents an API category. [Catalog + items](/apigee/docs/reference/apis/apigee/rest/v1/organizations.sites.apidocs) + can be tagged with API categories; users viewing the API catalog in the + portal will have the option to browse the catalog by category. + type: object + properties: + siteId: + description: Name of the portal. + type: string + name: + description: Name of the category. + type: string + id: + description: ID of the category (a UUID). + type: string + updateTime: + description: Time the category was last modified in milliseconds since epoch. + type: string + format: int64 + GoogleCloudApigeeV1ApiCategoryResponse: + id: GoogleCloudApigeeV1ApiCategoryResponse + description: The API category resource wrapped with response status, error_code, etc. + type: object + properties: + status: + description: Status of the operation. + type: string + message: + description: Description of the operation. + type: string + requestId: + description: Unique ID of the request. + type: string + errorCode: + description: Unique error code for the request, if any. + type: string + data: + description: The API category resource. + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategory' + GoogleCloudApigeeV1DeleteResponse: + id: GoogleCloudApigeeV1DeleteResponse + description: Response for certain delete operations. + type: object + properties: + status: + description: Status of the operation. + type: string + message: + description: Description of the operation. + type: string + requestId: + description: Unique ID of the request. + type: string + errorCode: + description: Unique error code for the request, if any. + type: string + gcpResource: + description: Google Cloud name of deleted resource. + type: string + GoogleCloudApigeeV1ListApiCategoriesResponse: + id: GoogleCloudApigeeV1ListApiCategoriesResponse + description: 'The response for `ListApiCategoriesRequest`. Next ID: 6' + type: object + properties: + status: + description: Status of the operation. + type: string + message: + description: Description of the operation. + type: string + requestId: + description: Unique ID of the request. + type: string + errorCode: + description: Unique error code for the request, if any. + type: string + data: + description: The API category resources. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategory' + GoogleCloudApigeeV1ApiDocResponse: + id: GoogleCloudApigeeV1ApiDocResponse + description: The catalog item resource wrapped with response status, error_code, etc. + type: object + properties: + status: + description: Status of the operation. + type: string + message: + description: Description of the operation. + type: string + requestId: + description: Unique ID of the request. + type: string + errorCode: + description: Unique error code for the request, if any. + type: string + data: + description: The catalog item resource. + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDoc' + GoogleCloudApigeeV1ApiDoc: + id: GoogleCloudApigeeV1ApiDoc + description: >- + `ApiDoc` represents an API catalog item. Catalog items are used in two + ways in a portal: - Users can browse and interact with a visual + representation of the API documentation - The `api_product_name` field + provides a link to a backing [API product] + (/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). + Through this link, portal users can create and manage developer apps + linked to one or more API products. + type: object + properties: + siteId: + description: Output only. The ID of the parent portal. + readOnly: true + type: string + id: + description: Output only. The ID of the catalog item. + readOnly: true + type: string + format: int64 + title: + description: >- + Required. The user-facing name of the catalog item. `title` must be + a non-empty string with a max length of 255 characters. + type: string + description: + description: >- + Optional. Description of the catalog item. Max length is 10,000 + characters. + type: string + published: + description: >- + Optional. Denotes whether the catalog item is published to the + portal or is in a draft state. When the parent portal is enrolled in + the [audience management + feature](https://cloud.google.com/apigee/docs/api-platform/publish/portal/portal-audience#enrolling_in_the_beta_release_of_the_audience_management_feature), + the visibility can be set to public on creation by setting the + anonAllowed flag to true or further managed in the management UI + (see [Manage the visibility of an API in your + portal](https://cloud.google.com/apigee/docs/api-platform/publish/portal/publish-apis#visibility)) + before it can be visible to any users. If not enrolled in the + audience management feature, the visibility is managed by the + `anonAllowed` flag. + type: boolean + anonAllowed: + description: >- + Optional. Boolean flag that manages user access to the catalog item. + When true, the catalog item has public visibility and can be viewed + anonymously; otherwise, only registered users may view it. Note: + when the parent portal is enrolled in the [audience management + feature](https://cloud.google.com/apigee/docs/api-platform/publish/portal/portal-audience#enrolling_in_the_beta_release_of_the_audience_management_feature), + and this flag is set to false, visibility is set to an indeterminate + state and must be explicitly specified in the management UI (see + [Manage the visibility of an API in your + portal](https://cloud.google.com/apigee/docs/api-platform/publish/portal/publish-apis#visibility)). + Additionally, when enrolled in the audience management feature, + updates to this flag will be ignored as visibility permissions must + be updated in the management UI. + type: boolean + apiProductName: + description: >- + Required. Immutable. The `name` field of the associated [API + product](/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). + A portal may have only one catalog item associated with a given API + product. + type: string + requireCallbackUrl: + description: >- + Optional. Whether a callback URL is required when this catalog + item's API product is enabled in a developer app. When true, a + portal user will be required to input a URL when managing the app + (this is typically used for the app's OAuth flow). + type: boolean + imageUrl: + description: >- + Optional. Location of the image used for the catalog item in the + catalog. This can be either an image with an external URL or a file + path for [image files stored in the + portal](/apigee/docs/api-platform/publish/portal/portal-files"), for + example, `/files/book-tree.jpg`. When specifying the URL of an + external image, the image won't be uploaded to your assets; + additionally, loading the image in the integrated portal will be + subject to its availability, which may be blocked or restricted by + [content security + policies](/apigee/docs/api-platform/publish/portal/csp). Max length + of file path is 2,083 characters. + type: string + categoryIds: + description: >- + Optional. The IDs of the API categories to which this catalog item + belongs. + type: array + items: + type: string + modified: + description: >- + Output only. Time the catalog item was last modified in milliseconds + since epoch. + readOnly: true + type: string + format: int64 + visibility: + description: 'Optional. DEPRECATED: use the `published` field instead' + type: boolean + edgeAPIProductName: + description: >- + Optional. Immutable. DEPRECATED: use the `apiProductName` field + instead + type: string + specId: + description: 'Optional. DEPRECATED: DO NOT USE' + deprecated: true + type: string + graphqlSchema: + description: >- + Optional. DEPRECATED: manage documentation through the + `getDocumentation` and `updateDocumentation` methods + deprecated: true + type: string + graphqlEndpointUrl: + description: >- + Optional. DEPRECATED: manage documentation through the + `getDocumentation` and `updateDocumentation` methods + deprecated: true + type: string + graphqlSchemaDisplayName: + description: >- + Optional. DEPRECATED: manage documentation through the + `getDocumentation` and `updateDocumentation` methods + deprecated: true + type: string + GoogleCloudApigeeV1ListApiDocsResponse: + id: GoogleCloudApigeeV1ListApiDocsResponse + type: object + properties: + status: + description: Status of the operation. + type: string + message: + description: Description of the operation. + type: string + requestId: + description: Unique ID of the request. + type: string + errorCode: + description: Unique error code for the request, if any. + type: string + data: + description: The catalog item resources. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDoc' + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + GoogleCloudApigeeV1ApiDocDocumentation: + id: GoogleCloudApigeeV1ApiDocDocumentation + description: The documentation for a catalog item. + type: object + properties: + oasDocumentation: + description: Optional. OpenAPI Specification documentation. + $ref: '#/components/schemas/GoogleCloudApigeeV1OASDocumentation' + graphqlDocumentation: + description: Optional. GraphQL documentation. + $ref: '#/components/schemas/GoogleCloudApigeeV1GraphqlDocumentation' + GoogleCloudApigeeV1OASDocumentation: + id: GoogleCloudApigeeV1OASDocumentation + description: OpenAPI Specification documentation for a catalog item. + type: object + properties: + spec: + description: >- + Required. The documentation file contents for the OpenAPI + Specification. JSON and YAML file formats are supported. + $ref: '#/components/schemas/GoogleCloudApigeeV1DocumentationFile' + format: + description: Output only. The format of the input specification file contents. + readOnly: true + type: string + enumDescriptions: + - The format is not available. + - YAML format. + - JSON format. + enum: + - FORMAT_UNSPECIFIED + - YAML + - JSON + GoogleCloudApigeeV1DocumentationFile: + id: GoogleCloudApigeeV1DocumentationFile + description: Documentation file contents for a catalog item. + type: object + properties: + displayName: + description: >- + Required. A display name for the file, shown in the management UI. + Max length is 255 characters. + type: string + contents: + description: Required. The file contents. The max size is 4 MB. + type: string + format: byte + GoogleCloudApigeeV1GraphqlDocumentation: + id: GoogleCloudApigeeV1GraphqlDocumentation + description: GraphQL documentation for a catalog item. + type: object + properties: + schema: + description: Required. The documentation file contents for the GraphQL schema. + $ref: '#/components/schemas/GoogleCloudApigeeV1DocumentationFile' + endpointUri: + description: >- + Required. The GraphQL endpoint URI to be queried by API consumers. + Max length is 2,083 characters. + type: string + GoogleCloudApigeeV1ApiDocDocumentationResponse: + id: GoogleCloudApigeeV1ApiDocDocumentationResponse + description: >- + The catalog item documentation wrapped with response status, error_code, + etc. + type: object + properties: + status: + description: Output only. Status of the operation. + readOnly: true + type: string + message: + description: Output only. Description of the operation. + readOnly: true + type: string + requestId: + description: Output only. Unique ID of the request. + readOnly: true + type: string + errorCode: + description: Output only. Unique error code for the request, if any. + readOnly: true + type: string + data: + description: Output only. The documentation resource. + readOnly: true + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDocDocumentation' + GoogleCloudApigeeV1InstanceAttachment: + id: GoogleCloudApigeeV1InstanceAttachment + description: >- + InstanceAttachment represents the installation of an environment onto an + instance. + type: object + properties: + name: + description: Output only. ID of the attachment. + readOnly: true + type: string + environment: + description: ID of the attached environment. + type: string + createdAt: + description: >- + Output only. Time the attachment was created in milliseconds since + epoch. + readOnly: true + type: string + format: int64 + GoogleCloudApigeeV1ListInstanceAttachmentsResponse: + id: GoogleCloudApigeeV1ListInstanceAttachmentsResponse + description: Response for ListInstanceAttachments. + type: object + properties: + attachments: + description: Attachments for the instance. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1InstanceAttachment' + nextPageToken: + description: >- + Page token that you can include in a ListInstanceAttachments request + to retrieve the next page of content. If omitted, no subsequent + pages exist. + type: string + GoogleCloudApigeeV1EndpointAttachment: + id: GoogleCloudApigeeV1EndpointAttachment + description: >- + Apigee endpoint attachment. For more information, see [Southbound + networking patterns] + (https://cloud.google.com/apigee/docs/api-platform/architecture/southbound-networking-patterns-endpoints). + type: object + properties: + name: + description: >- + Name of the endpoint attachment. Use the following structure in your + request: + `organizations/{org}/endpointAttachments/{endpoint_attachment}` + type: string + serviceAttachment: + description: 'Format: projects/*/regions/*/serviceAttachments/*' + type: string + location: + description: Required. Location of the endpoint attachment. + type: string + host: + description: >- + Output only. Host that can be used in either the HTTP target + endpoint directly or as the host in target server. + readOnly: true + type: string + state: + description: >- + Output only. State of the endpoint attachment. Values other than + `ACTIVE` mean the resource is not ready to use. + readOnly: true + type: string + enumDescriptions: + - Resource is in an unspecified state. + - Resource is being created. + - Resource is provisioned and ready to use. + - The resource is being deleted. + - The resource is being updated. + enum: + - STATE_UNSPECIFIED + - CREATING + - ACTIVE + - DELETING + - UPDATING + connectionState: + description: >- + Output only. State of the endpoint attachment connection to the + service attachment. + readOnly: true + type: string + enumDescriptions: + - The connection state has not been set. + - >- + The connection state is unavailable at this time, possibly because + the endpoint attachment is currently being provisioned. + - The connection is pending acceptance by the PSC producer. + - The connection has been accepted by the PSC producer. + - The connection has been rejected by the PSC producer. + - >- + The connection has been closed by the PSC producer and will not + serve traffic going forward. + - >- + The connection has been frozen by the PSC producer and will not + serve traffic. + - >- + The connection has been accepted by the PSC producer, but it is + not ready to serve the traffic due to producer side issues. + enum: + - CONNECTION_STATE_UNSPECIFIED + - UNAVAILABLE + - PENDING + - ACCEPTED + - REJECTED + - CLOSED + - FROZEN + - NEEDS_ATTENTION + GoogleCloudApigeeV1ListEndpointAttachmentsResponse: + id: GoogleCloudApigeeV1ListEndpointAttachmentsResponse + description: Response for ListEndpointAttachments method. + type: object + properties: + endpointAttachments: + description: Endpoint attachments in the specified organization. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1EndpointAttachment' + nextPageToken: + description: >- + Page token that you can include in an `ListEndpointAttachments` + request to retrieve the next page. If omitted, no subsequent pages + exist. + type: string + GoogleCloudApigeeV1ListNatAddressesResponse: + id: GoogleCloudApigeeV1ListNatAddressesResponse + description: Response for ListNatAddresses. + type: object + properties: + natAddresses: + description: List of NAT Addresses for the instance. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1NatAddress' + nextPageToken: + description: >- + Page token that you can include in a ListNatAddresses request to + retrieve the next page of content. If omitted, no subsequent pages + exist. + type: string + GoogleCloudApigeeV1NatAddress: + id: GoogleCloudApigeeV1NatAddress + description: >- + Apigee NAT(network address translation) address. A NAT address is a + static external IP address used for Internet egress traffic. + type: object + properties: + name: + description: Required. Resource ID of the NAT address. + type: string + ipAddress: + description: Output only. The static IPV4 address. + readOnly: true + type: string + state: + description: Output only. State of the nat address. + readOnly: true + type: string + enumDescriptions: + - The resource is in an unspecified state. + - The NAT address is being created. + - The NAT address is reserved but not yet used for Internet egress. + - The NAT address is active and used for Internet egress. + - The NAT address is being deleted. + enum: + - STATE_UNSPECIFIED + - CREATING + - RESERVED + - ACTIVE + - DELETING + GoogleCloudApigeeV1ActivateNatAddressRequest: + id: GoogleCloudApigeeV1ActivateNatAddressRequest + description: Request for ActivateNatAddressRequest. Activate the nat address request. + type: object + properties: {} + GoogleCloudApigeeV1ProvisionOrganizationRequest: + id: GoogleCloudApigeeV1ProvisionOrganizationRequest + description: Request for ProvisionOrganization. + type: object + properties: + authorizedNetwork: + description: >- + Compute Engine network used for Service Networking to be peered with + Apigee runtime instances. See [Getting started with the Service + Networking + API](https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started). + Apigee also supports shared VPC (that is, the host network project + is not the same as the one that is peering with Apigee). See [Shared + VPC overview](https://cloud.google.com/vpc/docs/shared-vpc). To use + a shared VPC network, use the following format: + `projects/{host-project-id}/{region}/networks/{network-name}`. For + example: `projects/my-sharedvpc-host/global/networks/mynetwork` + type: string + disableVpcPeering: + description: >- + Optional. Flag that specifies whether the VPC Peering through + Private Google Access should be disabled between the consumer + network and Apigee. Required if an authorizedNetwork on the consumer + project is not provided, in which case the flag should be set to + true. The value must be set before the creation of any Apigee + runtime instance and can be updated only when there are no runtime + instances. **Note:** Apigee will be deprecating the vpc peering + model that requires you to provide 'authorizedNetwork', by making + the non-peering model as the default way of provisioning Apigee + organization in future. So, this will be a temporary flag to enable + the transition. Not supported for Apigee hybrid. + type: boolean + analyticsRegion: + description: >- + Primary Cloud Platform region for analytics data storage. For valid + values, see [Create an + organization](https://cloud.google.com/apigee/docs/hybrid/latest/precog-provision). + Defaults to `us-west1`. + type: string + runtimeLocation: + description: >- + Cloud Platform location for the runtime instance. Defaults to zone + `us-west1-a`. If a region is provided, `EVAL` organizations will use + the region for automatically selecting a zone for the runtime + instance. + type: string + GoogleCloudApigeeV1DnsZone: + id: GoogleCloudApigeeV1DnsZone + description: >- + A DNS zone is a resource under an Apigee organization that is used to + create a DNS peering with Apigee's network. DNS peering will let Apigee + instances resolve the hostnames created in a peered network. + type: object + properties: + name: + description: >- + Identifier. Unique name for the resource. Defined by the server + Format: "organizations/{organization}/dnsZones/{dns_zone}". + type: string + createTime: + description: Output only. The time that this resource was created on the server. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. The time that this resource was updated on the server. + readOnly: true + type: string + format: google-datetime + description: + description: >- + Required. Description of the resource. String of at most 1024 + characters associated with this resource for the user's convenience. + type: string + domain: + description: >- + Required. The domain name for hosts in this private zone, for + instance "example.com.". + type: string + peeringConfig: + description: DNS PEERING zone configuration. + $ref: '#/components/schemas/GoogleCloudApigeeV1DnsZonePeeringConfig' + state: + description: >- + Output only. State of the DNS Peering. Values other than `ACTIVE` + mean the resource is not ready to use. + readOnly: true + type: string + enumDescriptions: + - Resource is in an unspecified state. + - Resource is being created. + - Resource is provisioned and ready to use. + - The resource is being deleted. + - The resource is being updated. + enum: + - STATE_UNSPECIFIED + - CREATING + - ACTIVE + - DELETING + - UPDATING + GoogleCloudApigeeV1DnsZonePeeringConfig: + id: GoogleCloudApigeeV1DnsZonePeeringConfig + description: Fields for DNS PEERING zone. + type: object + properties: + targetProjectId: + description: >- + Required. The ID of the project that contains the producer VPC + network. + type: string + targetNetworkId: + description: >- + Required. The VPC network where the records for that private DNS + zone's namespace are available. Apigee will be performing DNS + peering with this VPC network. + type: string + GoogleCloudApigeeV1ListDnsZonesResponse: + id: GoogleCloudApigeeV1ListDnsZonesResponse + description: Response for list DNS zones. + type: object + properties: + dnsZones: + description: DNS zones in a given organization. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1DnsZone' + nextPageToken: + description: >- + Page token that you can include in an `ListDnsZones` request to + retrieve the next page. If omitted, no subsequent pages exist. + type: string + EdgeConfigstoreBundleBadBundle: + id: EdgeConfigstoreBundleBadBundle + description: Describes why a bundle is invalid. Intended for use in error details. + type: object + properties: + violations: + description: Describes all precondition violations. + type: array + items: + $ref: '#/components/schemas/EdgeConfigstoreBundleBadBundleViolation' + EdgeConfigstoreBundleBadBundleViolation: + id: EdgeConfigstoreBundleBadBundleViolation + description: A message type used to describe a single bundle validation error. + type: object + properties: + filename: + description: >- + The filename (including relative path from the bundle root) in which + the error occurred. + type: string + description: + description: A description of why the bundle is invalid and how to fix it. + type: string + GoogleCloudApigeeV1OperationMetadata: + id: GoogleCloudApigeeV1OperationMetadata + description: Metadata describing an Operation. + type: object + properties: + operationType: + type: string + enumDescriptions: + - '' + - '' + - '' + - '' + enum: + - OPERATION_TYPE_UNSPECIFIED + - INSERT + - DELETE + - UPDATE + targetResourceName: + description: Name of the resource for which the operation is operating on. + type: string + state: + type: string + enumDescriptions: + - '' + - '' + - '' + - '' + enum: + - STATE_UNSPECIFIED + - NOT_STARTED + - IN_PROGRESS + - FINISHED + progress: + description: Progress of the operation. + $ref: '#/components/schemas/GoogleCloudApigeeV1OperationMetadataProgress' + warnings: + description: Warnings encountered while executing the operation. + type: array + items: + type: string + GoogleCloudApigeeV1OperationMetadataProgress: + id: GoogleCloudApigeeV1OperationMetadataProgress + description: Information about operation progress. + type: object + properties: + description: + description: Description of the operation's progress. + type: string + state: + description: State of the operation. + type: string + enumDescriptions: + - '' + - '' + - '' + - '' + enum: + - STATE_UNSPECIFIED + - NOT_STARTED + - IN_PROGRESS + - FINISHED + percentDone: + description: The percentage of the operation progress. + type: integer + format: int32 + details: + description: The additional details of the progress. + type: object + additionalProperties: + type: any + description: Properties of the object. + parameters: + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string + alt: description: Data format for response. in: query name: alt @@ -8843,24 +9223,6 @@ components: - json - media - proto - oauth_token: - description: OAuth 2.0 token for the current user. - in: query - name: oauth_token - schema: - type: string - access_token: - description: OAuth access token. - in: query - name: access_token - schema: - type: string - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean callback: description: JSONP in: query @@ -8882,6 +9244,18 @@ components: 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 @@ -8891,6 +9265,12 @@ components: name: quotaUser schema: type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string uploadType: description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query @@ -8906,46 +9286,22 @@ components: enum: - '1' - '2' - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string x-stackQL-resources: - projects: - id: google.apigee.projects - name: projects - title: Projects - methods: - projects_provision_organization: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}:provisionOrganization/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: [] - deployed_ingress_config: - id: google.apigee.deployed_ingress_config - name: deployed_ingress_config - title: Deployed_ingress_config + issuers: + id: google.apigee.issuers + name: issuers + title: Issuers methods: - organizations_get_deployed_ingress_config: + hybrid_issuers_list: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1deployedIngressConfig/get + $ref: '#/paths/~1v1~1hybrid~1issuers/get' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/deployed_ingress_config/methods/organizations_get_deployed_ingress_config + #/components/x-stackQL-resources/issuers/methods/hybrid_issuers_list insert: [] update: [] replace: [] @@ -8955,9 +9311,15 @@ components: name: organizations title: Organizations methods: - organizations_delete: + organizations_list: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}/delete' + $ref: '#/paths/~1v1~1organizations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_create: + operation: + $ref: '#/paths/~1v1~1organizations/post' response: mediaType: application/json openAPIDocKey: '200' @@ -8973,15 +9335,16 @@ components: response: mediaType: application/json openAPIDocKey: '200' - organizations_create: + organizations_delete: operation: - $ref: '#/paths/~1v1~1organizations/post' + $ref: '#/paths/~1v1~1organizations~1{organizationsId}/delete' response: mediaType: application/json openAPIDocKey: '200' - organizations_list: + organizations_set_sync_authorization: operation: - $ref: '#/paths/~1v1~1organizations/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}:setSyncAuthorization/post response: mediaType: application/json openAPIDocKey: '200' @@ -8991,10 +9354,16 @@ components: response: mediaType: application/json openAPIDocKey: '200' - organizations_set_sync_authorization: + organizations_security_assessment_results_batch_compute: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}:setSyncAuthorization/post + #/paths/~1v1~1organizations~1{organizationsId}~1securityAssessmentResults:batchCompute/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_provision_organization: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}:provisionOrganization/post' response: mediaType: application/json openAPIDocKey: '200' @@ -9014,177 +9383,212 @@ components: delete: - $ref: >- #/components/x-stackQL-resources/organizations/methods/organizations_delete - runtime_config: - id: google.apigee.runtime_config - name: runtime_config - title: Runtime_config + sync_authorization: + id: google.apigee.sync_authorization + name: sync_authorization + title: Sync_authorization methods: - organizations_get_runtime_config: + organizations_get_sync_authorization: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1runtimeConfig/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}:getSyncAuthorization/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/runtime_config/methods/organizations_get_runtime_config + #/components/x-stackQL-resources/sync_authorization/methods/organizations_get_sync_authorization insert: [] update: [] replace: [] delete: [] - security_settings: - id: google.apigee.security_settings - name: security_settings - title: Security_settings + control_plane_access: + id: google.apigee.control_plane_access + name: control_plane_access + title: Control_plane_access methods: - organizations_update_security_settings: + organizations_get_control_plane_access: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securitySettings/patch + #/paths/~1v1~1organizations~1{organizationsId}~1controlPlaneAccess/get response: mediaType: application/json openAPIDocKey: '200' - organizations_get_security_settings: + organizations_update_control_plane_access: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securitySettings/get + #/paths/~1v1~1organizations~1{organizationsId}~1controlPlaneAccess/patch response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/security_settings/methods/organizations_get_security_settings + #/components/x-stackQL-resources/control_plane_access/methods/organizations_get_control_plane_access insert: [] update: - $ref: >- - #/components/x-stackQL-resources/security_settings/methods/organizations_update_security_settings + #/components/x-stackQL-resources/control_plane_access/methods/organizations_update_control_plane_access replace: [] delete: [] - control_plane_access: - id: google.apigee.control_plane_access - name: control_plane_access - title: Control_plane_access + project_mapping: + id: google.apigee.project_mapping + name: project_mapping + title: Project_mapping methods: - organizations_update_control_plane_access: + organizations_get_project_mapping: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1controlPlaneAccess/patch + #/paths/~1v1~1organizations~1{organizationsId}:getProjectMapping/get response: mediaType: application/json openAPIDocKey: '200' - organizations_get_control_plane_access: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/project_mapping/methods/organizations_get_project_mapping + insert: [] + update: [] + replace: [] + delete: [] + ingress_config: + id: google.apigee.ingress_config + name: ingress_config + title: Ingress_config + methods: + organizations_get_deployed_ingress_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1controlPlaneAccess/get + #/paths/~1v1~1organizations~1{organizationsId}~1deployedIngressConfig/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/control_plane_access/methods/organizations_get_control_plane_access + #/components/x-stackQL-resources/ingress_config/methods/organizations_get_deployed_ingress_config insert: [] - update: - - $ref: >- - #/components/x-stackQL-resources/control_plane_access/methods/organizations_update_control_plane_access + update: [] replace: [] delete: [] - project_mapping: - id: google.apigee.project_mapping - name: project_mapping - title: Project_mapping + runtime_config: + id: google.apigee.runtime_config + name: runtime_config + title: Runtime_config methods: - organizations_get_project_mapping: + organizations_get_runtime_config: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}:getProjectMapping/get + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1runtimeConfig/get' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/project_mapping/methods/organizations_get_project_mapping + #/components/x-stackQL-resources/runtime_config/methods/organizations_get_runtime_config insert: [] update: [] replace: [] delete: [] - sync_authorization: - id: google.apigee.sync_authorization - name: sync_authorization - title: Sync_authorization + security_settings: + id: google.apigee.security_settings + name: security_settings + title: Security_settings methods: - organizations_get_sync_authorization: + organizations_get_security_settings: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}:getSyncAuthorization/post + #/paths/~1v1~1organizations~1{organizationsId}~1securitySettings/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_update_security_settings: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1securitySettings/patch response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/sync_authorization/methods/organizations_get_sync_authorization + #/components/x-stackQL-resources/security_settings/methods/organizations_get_security_settings insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/security_settings/methods/organizations_update_security_settings replace: [] delete: [] - sharedflows: - id: google.apigee.sharedflows - name: sharedflows - title: Sharedflows + apis: + id: google.apigee.apis + name: apis + title: Apis methods: - organizations_sharedflows_get: + organizations_apis_list: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}/get + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apis/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_sharedflows_delete: + organizations_apis_create: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apis/post' + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_apis_patch: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_sharedflows_create: + organizations_apis_get: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1sharedflows/post' + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_sharedflows_list: + organizations_apis_delete: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1sharedflows/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_apis_move: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}:move/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/sharedflows/methods/organizations_sharedflows_get + #/components/x-stackQL-resources/apis/methods/organizations_apis_get - $ref: >- - #/components/x-stackQL-resources/sharedflows/methods/organizations_sharedflows_list + #/components/x-stackQL-resources/apis/methods/organizations_apis_list insert: - $ref: >- - #/components/x-stackQL-resources/sharedflows/methods/organizations_sharedflows_create - update: [] + #/components/x-stackQL-resources/apis/methods/organizations_apis_create + update: + - $ref: >- + #/components/x-stackQL-resources/apis/methods/organizations_apis_patch replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/sharedflows/methods/organizations_sharedflows_delete - revisions_shared_flow_revision: - id: google.apigee.revisions_shared_flow_revision - name: revisions_shared_flow_revision - title: Revisions_shared_flow_revision + #/components/x-stackQL-resources/apis/methods/organizations_apis_delete + revisions_api_proxy_revision: + id: google.apigee.revisions_api_proxy_revision + name: revisions_api_proxy_revision + title: Revisions_api_proxy_revision methods: - organizations_sharedflows_revisions_update_shared_flow_revision: + organizations_apis_revisions_update_api_proxy_revision: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}/post + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1revisions~1{revisionsId}/post response: mediaType: application/json openAPIDocKey: '200' @@ -9193,7 +9597,7 @@ components: insert: [] update: - $ref: >- - #/components/x-stackQL-resources/revisions_shared_flow_revision/methods/organizations_sharedflows_revisions_update_shared_flow_revision + #/components/x-stackQL-resources/revisions_api_proxy_revision/methods/organizations_apis_revisions_update_api_proxy_revision replace: [] delete: [] revisions: @@ -9201,1555 +9605,1646 @@ components: name: revisions title: Revisions methods: - organizations_sharedflows_revisions_get: + organizations_apis_revisions_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1revisions~1{revisionsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_sharedflows_revisions_delete: + organizations_apis_revisions_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1revisions~1{revisionsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_sharedflows_revisions_undeploy: + organizations_environments_apis_revisions_deploy: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}~1deployments/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_sharedflows_revisions_deploy: + organizations_environments_apis_revisions_undeploy: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}~1deployments/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_apis_revisions_undeploy: + organizations_environments_sharedflows_revisions_deploy: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}~1deployments/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_apis_revisions_deploy: + organizations_environments_sharedflows_revisions_undeploy: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}~1deployments/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_revisions_delete: + organizations_sharedflows_revisions_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1revisions~1{revisionsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_revisions_get: + organizations_sharedflows_revisions_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1revisions~1{revisionsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/revisions/methods/organizations_sharedflows_revisions_get - $ref: >- #/components/x-stackQL-resources/revisions/methods/organizations_apis_revisions_get + - $ref: >- + #/components/x-stackQL-resources/revisions/methods/organizations_sharedflows_revisions_get insert: [] update: [] replace: [] delete: - - $ref: >- - #/components/x-stackQL-resources/revisions/methods/organizations_sharedflows_revisions_delete - $ref: >- #/components/x-stackQL-resources/revisions/methods/organizations_apis_revisions_delete + - $ref: >- + #/components/x-stackQL-resources/revisions/methods/organizations_sharedflows_revisions_delete deployments: id: google.apigee.deployments name: deployments title: Deployments methods: - organizations_sharedflows_revisions_deployments_list: + organizations_apis_revisions_deployments_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}~1deployments/get + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments/get response: mediaType: application/json openAPIDocKey: '200' - organizations_sharedflows_deployments_list: + organizations_apis_deployments_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}~1deployments/get + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1deployments/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_deployments_get: + organizations_environments_apis_revisions_deployments_generate_deploy_change_report: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1deployments~1{deploymentsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments:generateDeployChangeReport/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_deployments_list: + organizations_environments_apis_revisions_deployments_generate_undeploy_change_report: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1deployments/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments:generateUndeployChangeReport/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_sharedflows_deployments_list: + organizations_environments_apis_deployments_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1sharedflows~1{sharedflowsId}~1deployments/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1deployments/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_apis_deployments_list: + organizations_environments_sharedflows_deployments_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1deployments/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1sharedflows~1{sharedflowsId}~1deployments/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_apis_revisions_deployments_generate_undeploy_change_report: + organizations_environments_deployments_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments:generateUndeployChangeReport/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1deployments/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_apis_revisions_deployments_generate_deploy_change_report: + organizations_environments_deployments_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments:generateDeployChangeReport/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1deployments~1{deploymentsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_revisions_deployments_list: + organizations_deployments_list: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments/get + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1deployments/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_deployments_list: + organizations_sharedflows_deployments_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1deployments/get + #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}~1deployments/get response: mediaType: application/json openAPIDocKey: '200' - organizations_deployments_list: + organizations_sharedflows_revisions_deployments_list: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1deployments/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}~1deployments/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/deployments/methods/organizations_sharedflows_revisions_deployments_list + #/components/x-stackQL-resources/deployments/methods/organizations_apis_revisions_deployments_list - $ref: >- - #/components/x-stackQL-resources/deployments/methods/organizations_environments_deployments_get + #/components/x-stackQL-resources/deployments/methods/organizations_environments_apis_deployments_list - $ref: >- #/components/x-stackQL-resources/deployments/methods/organizations_environments_sharedflows_deployments_list - $ref: >- - #/components/x-stackQL-resources/deployments/methods/organizations_environments_apis_deployments_list + #/components/x-stackQL-resources/deployments/methods/organizations_environments_deployments_get - $ref: >- - #/components/x-stackQL-resources/deployments/methods/organizations_apis_revisions_deployments_list + #/components/x-stackQL-resources/deployments/methods/organizations_sharedflows_revisions_deployments_list - $ref: >- - #/components/x-stackQL-resources/deployments/methods/organizations_sharedflows_deployments_list + #/components/x-stackQL-resources/deployments/methods/organizations_apis_deployments_list - $ref: >- #/components/x-stackQL-resources/deployments/methods/organizations_environments_deployments_list - $ref: >- - #/components/x-stackQL-resources/deployments/methods/organizations_apis_deployments_list + #/components/x-stackQL-resources/deployments/methods/organizations_sharedflows_deployments_list - $ref: >- #/components/x-stackQL-resources/deployments/methods/organizations_deployments_list insert: [] update: [] replace: [] delete: [] - datacollectors: - id: google.apigee.datacollectors - name: datacollectors - title: Datacollectors + keyvaluemaps: + id: google.apigee.keyvaluemaps + name: keyvaluemaps + title: Keyvaluemaps methods: - organizations_datacollectors_list: + organizations_apis_keyvaluemaps_create: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1datacollectors/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.dataCollectors - organizations_datacollectors_create: + organizations_apis_keyvaluemaps_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1datacollectors/post + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_datacollectors_get: + organizations_environments_keyvaluemaps_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1datacollectors~1{datacollectorsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps/post response: mediaType: application/json openAPIDocKey: '200' - organizations_datacollectors_delete: + organizations_environments_keyvaluemaps_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1datacollectors~1{datacollectorsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_datacollectors_patch: + organizations_keyvaluemaps_create: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps/post' + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_keyvaluemaps_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1datacollectors~1{datacollectorsId}/patch + #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/datacollectors/methods/organizations_datacollectors_get - - $ref: >- - #/components/x-stackQL-resources/datacollectors/methods/organizations_datacollectors_list + select: [] insert: - $ref: >- - #/components/x-stackQL-resources/datacollectors/methods/organizations_datacollectors_create - update: + #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_apis_keyvaluemaps_create - $ref: >- - #/components/x-stackQL-resources/datacollectors/methods/organizations_datacollectors_patch + #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_environments_keyvaluemaps_create + - $ref: >- + #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_keyvaluemaps_create + update: [] replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/datacollectors/methods/organizations_datacollectors_delete - balance: - id: google.apigee.balance - name: balance - title: Balance + #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_apis_keyvaluemaps_delete + - $ref: >- + #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_environments_keyvaluemaps_delete + - $ref: >- + #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_keyvaluemaps_delete + entries: + id: google.apigee.entries + name: entries + title: Entries methods: - organizations_developers_balance_credit: + organizations_apis_keyvaluemaps_entries_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1balance:credit/post + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_balance_adjust: + organizations_apis_keyvaluemaps_entries_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1balance:adjust/post + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/delete response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: [] - attributes: - id: google.apigee.attributes - name: attributes - title: Attributes - methods: - organizations_developers_attributes_delete: + organizations_apis_keyvaluemaps_entries_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1attributes~1{attributesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_attributes_get: + organizations_apis_keyvaluemaps_entries_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1attributes~1{attributesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/post response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_attributes_list: + organizations_apis_keyvaluemaps_entries_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1attributes/get + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/get response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_attributes_delete: + objectKey: $.keyValueEntries + organizations_environments_keyvaluemaps_entries_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1attributes~1{attributesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_attributes_get: + organizations_environments_keyvaluemaps_entries_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1attributes~1{attributesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_keyvaluemaps_entries_update: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/put + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_keyvaluemaps_entries_create: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/post + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_keyvaluemaps_entries_list: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.keyValueEntries + organizations_keyvaluemaps_entries_get: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_attributes_list: + organizations_keyvaluemaps_entries_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1attributes/get + #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_attributes_list: + organizations_keyvaluemaps_entries_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1attributes/get + #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_attributes_get: + organizations_keyvaluemaps_entries_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1attributes~1{attributesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/post response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_attributes_delete: + organizations_keyvaluemaps_entries_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1attributes~1{attributesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.keyValueEntries sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/attributes/methods/organizations_developers_apps_attributes_get + #/components/x-stackQL-resources/entries/methods/organizations_apis_keyvaluemaps_entries_get - $ref: >- - #/components/x-stackQL-resources/attributes/methods/organizations_developers_attributes_get + #/components/x-stackQL-resources/entries/methods/organizations_environments_keyvaluemaps_entries_get - $ref: >- - #/components/x-stackQL-resources/attributes/methods/organizations_developers_apps_attributes_list + #/components/x-stackQL-resources/entries/methods/organizations_apis_keyvaluemaps_entries_list - $ref: >- - #/components/x-stackQL-resources/attributes/methods/organizations_apiproducts_attributes_get + #/components/x-stackQL-resources/entries/methods/organizations_environments_keyvaluemaps_entries_list - $ref: >- - #/components/x-stackQL-resources/attributes/methods/organizations_developers_attributes_list + #/components/x-stackQL-resources/entries/methods/organizations_keyvaluemaps_entries_get - $ref: >- - #/components/x-stackQL-resources/attributes/methods/organizations_apiproducts_attributes_list - insert: [] + #/components/x-stackQL-resources/entries/methods/organizations_keyvaluemaps_entries_list + insert: + - $ref: >- + #/components/x-stackQL-resources/entries/methods/organizations_apis_keyvaluemaps_entries_create + - $ref: >- + #/components/x-stackQL-resources/entries/methods/organizations_environments_keyvaluemaps_entries_create + - $ref: >- + #/components/x-stackQL-resources/entries/methods/organizations_keyvaluemaps_entries_create update: [] - replace: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/entries/methods/organizations_apis_keyvaluemaps_entries_update + - $ref: >- + #/components/x-stackQL-resources/entries/methods/organizations_environments_keyvaluemaps_entries_update + - $ref: >- + #/components/x-stackQL-resources/entries/methods/organizations_keyvaluemaps_entries_update delete: - $ref: >- - #/components/x-stackQL-resources/attributes/methods/organizations_developers_apps_attributes_delete + #/components/x-stackQL-resources/entries/methods/organizations_apis_keyvaluemaps_entries_delete - $ref: >- - #/components/x-stackQL-resources/attributes/methods/organizations_developers_attributes_delete + #/components/x-stackQL-resources/entries/methods/organizations_environments_keyvaluemaps_entries_delete - $ref: >- - #/components/x-stackQL-resources/attributes/methods/organizations_apiproducts_attributes_delete - attributes_developer_attribute: - id: google.apigee.attributes_developer_attribute - name: attributes_developer_attribute - title: Attributes_developer_attribute + #/components/x-stackQL-resources/entries/methods/organizations_keyvaluemaps_entries_delete + debugsessions: + id: google.apigee.debugsessions + name: debugsessions + title: Debugsessions methods: - organizations_developers_attributes_update_developer_attribute: + organizations_apis_debugsessions_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1attributes~1{attributesId}/post + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1debugsessions/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.sessions + organizations_environments_apis_revisions_debugsessions_create: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1debugsessions/post + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_apis_revisions_debugsessions_list: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1debugsessions/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.sessions + organizations_environments_apis_revisions_debugsessions_get: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1debugsessions~1{debugsessionsId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] - insert: [] - update: + select: + - $ref: >- + #/components/x-stackQL-resources/debugsessions/methods/organizations_environments_apis_revisions_debugsessions_get + - $ref: >- + #/components/x-stackQL-resources/debugsessions/methods/organizations_environments_apis_revisions_debugsessions_list - $ref: >- - #/components/x-stackQL-resources/attributes_developer_attribute/methods/organizations_developers_attributes_update_developer_attribute + #/components/x-stackQL-resources/debugsessions/methods/organizations_apis_debugsessions_list + insert: + - $ref: >- + #/components/x-stackQL-resources/debugsessions/methods/organizations_environments_apis_revisions_debugsessions_create + update: [] replace: [] delete: [] - developers: - id: google.apigee.developers - name: developers - title: Developers + operations: + id: google.apigee.operations + name: operations + title: Operations methods: - organizations_developers_attributes: + organizations_operations_list: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1attributes/post + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1operations/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_list: + objectKey: $.operations + organizations_operations_get: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1developers/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_create: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/operations/methods/organizations_operations_get + - $ref: >- + #/components/x-stackQL-resources/operations/methods/organizations_operations_list + insert: [] + update: [] + replace: [] + delete: [] + datacollectors: + id: google.apigee.datacollectors + name: datacollectors + title: Datacollectors + methods: + organizations_datacollectors_create: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1developers/post' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1datacollectors/post response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_get: + organizations_datacollectors_list: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}/get + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1datacollectors/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_set_developer_status: + objectKey: $.dataCollectors + organizations_datacollectors_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}/post + #/paths/~1v1~1organizations~1{organizationsId}~1datacollectors~1{datacollectorsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_delete: + organizations_datacollectors_patch: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1datacollectors~1{datacollectorsId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_update: + organizations_datacollectors_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1datacollectors~1{datacollectorsId}/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/developers/methods/organizations_developers_get + #/components/x-stackQL-resources/datacollectors/methods/organizations_datacollectors_get - $ref: >- - #/components/x-stackQL-resources/developers/methods/organizations_developers_list + #/components/x-stackQL-resources/datacollectors/methods/organizations_datacollectors_list insert: - $ref: >- - #/components/x-stackQL-resources/developers/methods/organizations_developers_create - update: [] - replace: + #/components/x-stackQL-resources/datacollectors/methods/organizations_datacollectors_create + update: - $ref: >- - #/components/x-stackQL-resources/developers/methods/organizations_developers_update + #/components/x-stackQL-resources/datacollectors/methods/organizations_datacollectors_patch + replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/developers/methods/organizations_developers_delete - subscriptions: - id: google.apigee.subscriptions - name: subscriptions - title: Subscriptions + #/components/x-stackQL-resources/datacollectors/methods/organizations_datacollectors_delete + environments_debugmask: + id: google.apigee.environments_debugmask + name: environments_debugmask + title: Environments_debugmask methods: - organizations_developers_subscriptions_expire: + organizations_environments_get_debugmask: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1subscriptions~1{subscriptionsId}:expire/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1debugmask/get response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_subscriptions_get: + organizations_environments_update_debugmask: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1subscriptions~1{subscriptionsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1debugmask/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_subscriptions_create: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/environments_debugmask/methods/organizations_environments_get_debugmask + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/environments_debugmask/methods/organizations_environments_update_debugmask + replace: [] + delete: [] + environments_trace_config: + id: google.apigee.environments_trace_config + name: environments_trace_config + title: Environments_trace_config + methods: + organizations_environments_get_trace_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1subscriptions/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig/get response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_subscriptions_list: + organizations_environments_update_trace_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1subscriptions/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig/patch response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/subscriptions/methods/organizations_developers_subscriptions_get - - $ref: >- - #/components/x-stackQL-resources/subscriptions/methods/organizations_developers_subscriptions_list - insert: + #/components/x-stackQL-resources/environments_trace_config/methods/organizations_environments_get_trace_config + insert: [] + update: - $ref: >- - #/components/x-stackQL-resources/subscriptions/methods/organizations_developers_subscriptions_create - update: [] + #/components/x-stackQL-resources/environments_trace_config/methods/organizations_environments_update_trace_config replace: [] delete: [] - create: - id: google.apigee.create - name: create - title: Create + environments: + id: google.apigee.environments + name: environments + title: Environments methods: - organizations_developers_apps_keys_create_create: + organizations_environments_create: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1environments/post' + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1create/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}/delete response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: >- - #/components/x-stackQL-resources/create/methods/organizations_developers_apps_keys_create_create - update: [] - replace: [] - delete: [] - apiproducts_developer_app_key_api_product: - id: google.apigee.apiproducts_developer_app_key_api_product - name: apiproducts_developer_app_key_api_product - title: Apiproducts_developer_app_key_api_product - methods: - organizations_developers_apps_keys_apiproducts_update_developer_app_key_api_product: + organizations_environments_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1{keysId}~1apiproducts~1{apiproductsId}/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: - - $ref: >- - #/components/x-stackQL-resources/apiproducts_developer_app_key_api_product/methods/organizations_developers_apps_keys_apiproducts_update_developer_app_key_api_product - replace: [] - delete: [] - apiproducts: - id: google.apigee.apiproducts - name: apiproducts - title: Apiproducts - methods: - organizations_developers_apps_keys_apiproducts_delete: + organizations_environments_update_environment: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1{keysId}~1apiproducts~1{apiproductsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}/post response: mediaType: application/json openAPIDocKey: '200' - organizations_appgroups_apps_keys_apiproducts_delete: + organizations_environments_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys~1{keysId}~1apiproducts~1{apiproductsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_attributes: + organizations_environments_modify_environment: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1attributes/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_list: + organizations_environments_subscribe: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apiproducts/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}:subscribe/post response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_create: + organizations_environments_unsubscribe: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apiproducts/post' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}:unsubscribe/post response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_update: + organizations_security_profiles_environments_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}~1environments/post response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_get: + organizations_security_profiles_environments_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}~1environments~1{environmentsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_delete: + organizations_security_profiles_environments_compute_environment_scores: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}~1environments~1{environmentsId}:computeEnvironmentScores/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/apiproducts/methods/organizations_apiproducts_get - - $ref: >- - #/components/x-stackQL-resources/apiproducts/methods/organizations_apiproducts_list + #/components/x-stackQL-resources/environments/methods/organizations_environments_get insert: - $ref: >- - #/components/x-stackQL-resources/apiproducts/methods/organizations_apiproducts_create - update: [] + #/components/x-stackQL-resources/environments/methods/organizations_security_profiles_environments_create + - $ref: >- + #/components/x-stackQL-resources/environments/methods/organizations_environments_create + update: + - $ref: >- + #/components/x-stackQL-resources/environments/methods/organizations_environments_update_environment replace: - $ref: >- - #/components/x-stackQL-resources/apiproducts/methods/organizations_apiproducts_update + #/components/x-stackQL-resources/environments/methods/organizations_environments_update delete: - $ref: >- - #/components/x-stackQL-resources/apiproducts/methods/organizations_developers_apps_keys_apiproducts_delete - - $ref: >- - #/components/x-stackQL-resources/apiproducts/methods/organizations_appgroups_apps_keys_apiproducts_delete + #/components/x-stackQL-resources/environments/methods/organizations_security_profiles_environments_delete - $ref: >- - #/components/x-stackQL-resources/apiproducts/methods/organizations_apiproducts_delete - keys: - id: google.apigee.keys - name: keys - title: Keys + #/components/x-stackQL-resources/environments/methods/organizations_environments_delete + environment_config: + id: google.apigee.environment_config + name: environment_config + title: Environment_config methods: - organizations_developers_apps_keys_create: + organizations_environments_get_deployed_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1deployedConfig/get response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_keys_replace_developer_app_key: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/environment_config/methods/organizations_environments_get_deployed_config + insert: [] + update: [] + replace: [] + delete: [] + api_security_runtime_config: + id: google.apigee.api_security_runtime_config + name: api_security_runtime_config + title: Api_security_runtime_config + methods: + organizations_environments_get_api_security_runtime_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1{keysId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apiSecurityRuntimeConfig/get response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_keys_get: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/api_security_runtime_config/methods/organizations_environments_get_api_security_runtime_config + insert: [] + update: [] + replace: [] + delete: [] + environments_iam_policies: + id: google.apigee.environments_iam_policies + name: environments_iam_policies + title: Environments_iam_policies + methods: + organizations_environments_set_iam_policy: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1{keysId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_keys_delete: + organizations_environments_get_iam_policy: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1{keysId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}:getIamPolicy/get response: mediaType: application/json openAPIDocKey: '200' - organizations_appgroups_apps_keys_get: + objectKey: $.bindings + organizations_environments_test_iam_permissions: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys~1{keysId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}:testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' - organizations_appgroups_apps_keys_delete: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/environments_iam_policies/methods/organizations_environments_get_iam_policy + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/environments_iam_policies/methods/organizations_environments_set_iam_policy + delete: [] + addons_config: + id: google.apigee.addons_config + name: addons_config + title: Addons_config + methods: + organizations_environments_get_addons_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys~1{keysId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1addonsConfig/get response: mediaType: application/json openAPIDocKey: '200' - organizations_appgroups_apps_keys_create: + organizations_environments_addons_config_set_addon_enablement: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1addonsConfig:setAddonEnablement/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/keys/methods/organizations_developers_apps_keys_get - - $ref: >- - #/components/x-stackQL-resources/keys/methods/organizations_appgroups_apps_keys_get - insert: - - $ref: >- - #/components/x-stackQL-resources/keys/methods/organizations_developers_apps_keys_create - - $ref: >- - #/components/x-stackQL-resources/keys/methods/organizations_appgroups_apps_keys_create + #/components/x-stackQL-resources/addons_config/methods/organizations_environments_get_addons_config + insert: [] update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/keys/methods/organizations_developers_apps_keys_replace_developer_app_key - delete: - - $ref: >- - #/components/x-stackQL-resources/keys/methods/organizations_developers_apps_keys_delete - - $ref: >- - #/components/x-stackQL-resources/keys/methods/organizations_appgroups_apps_keys_delete - keys_developer_app_key: - id: google.apigee.keys_developer_app_key - name: keys_developer_app_key - title: Keys_developer_app_key + replace: [] + delete: [] + security_actions_config: + id: google.apigee.security_actions_config + name: security_actions_config + title: Security_actions_config methods: - organizations_developers_apps_keys_update_developer_app_key: + organizations_environments_get_security_actions_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1{keysId}/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActionsConfig/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: - - $ref: >- - #/components/x-stackQL-resources/keys_developer_app_key/methods/organizations_developers_apps_keys_update_developer_app_key - replace: [] - delete: [] - attributes_developer_app_attribute: - id: google.apigee.attributes_developer_app_attribute - name: attributes_developer_app_attribute - title: Attributes_developer_app_attribute - methods: - organizations_developers_apps_attributes_update_developer_app_attribute: + organizations_environments_update_security_actions_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1attributes~1{attributesId}/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActionsConfig/patch response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/security_actions_config/methods/organizations_environments_get_security_actions_config insert: [] update: - $ref: >- - #/components/x-stackQL-resources/attributes_developer_app_attribute/methods/organizations_developers_apps_attributes_update_developer_app_attribute + #/components/x-stackQL-resources/security_actions_config/methods/organizations_environments_update_security_actions_config replace: [] delete: [] - apps: - id: google.apigee.apps - name: apps - title: Apps + resourcefiles: + id: google.apigee.resourcefiles + name: resourcefiles + title: Resourcefiles methods: - organizations_developers_apps_attributes: + organizations_environments_resourcefiles_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1attributes/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles/post response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_delete: + organizations_environments_resourcefiles_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles/get response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_update: + organizations_environments_resourcefiles_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles~1{type}~1{name}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_get: + organizations_environments_resourcefiles_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles~1{type}~1{name}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_generate_key_pair_or_update_developer_app_status: + organizations_environments_resourcefiles_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles~1{type}~1{name}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_create: + organizations_environments_resourcefiles_list_environment_resources: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles~1{type}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_list: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/resourcefiles/methods/organizations_environments_resourcefiles_get + - $ref: >- + #/components/x-stackQL-resources/resourcefiles/methods/organizations_environments_resourcefiles_list_environment_resources + - $ref: >- + #/components/x-stackQL-resources/resourcefiles/methods/organizations_environments_resourcefiles_list + insert: + - $ref: >- + #/components/x-stackQL-resources/resourcefiles/methods/organizations_environments_resourcefiles_create + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/resourcefiles/methods/organizations_environments_resourcefiles_update + delete: + - $ref: >- + #/components/x-stackQL-resources/resourcefiles/methods/organizations_environments_resourcefiles_delete + archive_deployments: + id: google.apigee.archive_deployments + name: archive_deployments + title: Archive_deployments + methods: + organizations_environments_archive_deployments_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments~1{archiveDeploymentsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_appgroups_apps_update: + organizations_environments_archive_deployments_patch: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments~1{archiveDeploymentsId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_appgroups_apps_get: + organizations_environments_archive_deployments_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments~1{archiveDeploymentsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_appgroups_apps_delete: + organizations_environments_archive_deployments_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments/get response: mediaType: application/json openAPIDocKey: '200' - organizations_appgroups_apps_list: + objectKey: $.archiveDeployments + organizations_environments_archive_deployments_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.appGroupApps - organizations_appgroups_apps_create: + organizations_environments_archive_deployments_generate_upload_url: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps/post - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_apps_list: - operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apps/get' + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments:generateUploadUrl/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.app - organizations_apps_get: + organizations_environments_archive_deployments_generate_download_url: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apps~1{appsId}/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments~1{archiveDeploymentsId}:generateDownloadUrl/post response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_developers_apps_get - - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_appgroups_apps_get - - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_developers_apps_list - - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_appgroups_apps_list + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_apps_get + #/components/x-stackQL-resources/archive_deployments/methods/organizations_environments_archive_deployments_get - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_apps_list + #/components/x-stackQL-resources/archive_deployments/methods/organizations_environments_archive_deployments_list insert: - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_developers_apps_create - - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_appgroups_apps_create - update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_developers_apps_update + #/components/x-stackQL-resources/archive_deployments/methods/organizations_environments_archive_deployments_create + update: - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_appgroups_apps_update + #/components/x-stackQL-resources/archive_deployments/methods/organizations_environments_archive_deployments_patch + replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_developers_apps_delete - - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_appgroups_apps_delete - developers_balance: - id: google.apigee.developers_balance - name: developers_balance - title: Developers_balance + #/components/x-stackQL-resources/archive_deployments/methods/organizations_environments_archive_deployments_delete + revisions_deployments: + id: google.apigee.revisions_deployments + name: revisions_deployments + title: Revisions_deployments methods: - organizations_developers_get_balance: + organizations_environments_apis_revisions_get_deployments: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1balance/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_sharedflows_revisions_get_deployments: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}~1deployments/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/developers_balance/methods/organizations_developers_get_balance + #/components/x-stackQL-resources/revisions_deployments/methods/organizations_environments_apis_revisions_get_deployments + - $ref: >- + #/components/x-stackQL-resources/revisions_deployments/methods/organizations_environments_sharedflows_revisions_get_deployments insert: [] update: [] replace: [] delete: [] - developers_monetization_config: - id: google.apigee.developers_monetization_config - name: developers_monetization_config - title: Developers_monetization_config + debugsession_data: + id: google.apigee.debugsession_data + name: debugsession_data + title: Debugsession_data methods: - organizations_developers_update_monetization_config: + organizations_environments_apis_revisions_debugsessions_delete_data: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1monetizationConfig/put + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1debugsessions~1{debugsessionsId}~1data/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_get_monetization_config: + organizations_environments_apis_revisions_debugsessions_data_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1monetizationConfig/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1debugsessions~1{debugsessionsId}~1data~1{dataId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/developers_monetization_config/methods/organizations_developers_get_monetization_config + #/components/x-stackQL-resources/debugsession_data/methods/organizations_environments_apis_revisions_debugsessions_data_get insert: [] update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/developers_monetization_config/methods/organizations_developers_update_monetization_config + replace: [] delete: [] - host_security_reports_result: - id: google.apigee.host_security_reports_result - name: host_security_reports_result - title: Host_security_reports_result + deployments_iam_policies: + id: google.apigee.deployments_iam_policies + name: deployments_iam_policies + title: Deployments_iam_policies methods: - organizations_host_security_reports_get_result: + organizations_environments_deployments_set_iam_policy: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1hostSecurityReports~1{hostSecurityReportsId}~1result/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1deployments~1{deploymentsId}:setIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_deployments_get_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1deployments~1{deploymentsId}:getIamPolicy/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.bindings + organizations_environments_deployments_test_iam_permissions: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1deployments~1{deploymentsId}:testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/host_security_reports_result/methods/organizations_host_security_reports_get_result + #/components/x-stackQL-resources/deployments_iam_policies/methods/organizations_environments_deployments_get_iam_policy insert: [] update: [] - replace: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/deployments_iam_policies/methods/organizations_environments_deployments_set_iam_policy delete: [] - host_security_reports: - id: google.apigee.host_security_reports - name: host_security_reports - title: Host_security_reports + flowhooks: + id: google.apigee.flowhooks + name: flowhooks + title: Flowhooks methods: - organizations_host_security_reports_get: + organizations_environments_flowhooks_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1hostSecurityReports~1{hostSecurityReportsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1flowhooks~1{flowhooksId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_host_security_reports_create: + organizations_environments_flowhooks_attach_shared_flow_to_flow_hook: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1hostSecurityReports/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1flowhooks~1{flowhooksId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_host_security_reports_list: + organizations_environments_flowhooks_detach_shared_flow_from_flow_hook: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1hostSecurityReports/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1flowhooks~1{flowhooksId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.securityReports sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/host_security_reports/methods/organizations_host_security_reports_get - - $ref: >- - #/components/x-stackQL-resources/host_security_reports/methods/organizations_host_security_reports_list - insert: - - $ref: >- - #/components/x-stackQL-resources/host_security_reports/methods/organizations_host_security_reports_create + #/components/x-stackQL-resources/flowhooks/methods/organizations_environments_flowhooks_get + insert: [] update: [] replace: [] delete: [] - host_security_reports_result_view: - id: google.apigee.host_security_reports_result_view - name: host_security_reports_result_view - title: Host_security_reports_result_view + keystores: + id: google.apigee.keystores + name: keystores + title: Keystores methods: - organizations_host_security_reports_get_result_view: + organizations_environments_keystores_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1hostSecurityReports~1{hostSecurityReportsId}~1resultView/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/host_security_reports_result_view/methods/organizations_host_security_reports_get_result_view - insert: [] - update: [] - replace: [] - delete: [] - optimized_host_stats: - id: google.apigee.optimized_host_stats - name: optimized_host_stats - title: Optimized_host_stats - methods: - organizations_optimized_host_stats_get: + organizations_environments_keystores_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1optimizedHostStats~1{optimizedHostStatsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}/delete response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/optimized_host_stats/methods/organizations_optimized_host_stats_get - insert: [] - update: [] - replace: [] - delete: [] - host_stats: - id: google.apigee.host_stats - name: host_stats - title: Host_stats - methods: - organizations_host_stats_get: + organizations_environments_keystores_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1hostStats~1{hostStatsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/host_stats/methods/organizations_host_stats_get - insert: [] + #/components/x-stackQL-resources/keystores/methods/organizations_environments_keystores_get + insert: + - $ref: >- + #/components/x-stackQL-resources/keystores/methods/organizations_environments_keystores_create update: [] replace: [] - delete: [] - reports: - id: google.apigee.reports - name: reports - title: Reports + delete: + - $ref: >- + #/components/x-stackQL-resources/keystores/methods/organizations_environments_keystores_delete + aliases: + id: google.apigee.aliases + name: aliases + title: Aliases methods: - organizations_reports_get: + organizations_environments_keystores_aliases_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1reports~1{reportsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases/post response: mediaType: application/json openAPIDocKey: '200' - organizations_reports_update: + organizations_environments_keystores_aliases_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1reports~1{reportsId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases~1{aliasesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_reports_delete: + organizations_environments_keystores_aliases_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1reports~1{reportsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases~1{aliasesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_reports_list: + organizations_environments_keystores_aliases_update: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1reports/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases~1{aliasesId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_reports_create: + organizations_environments_keystores_aliases_csr: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1reports/post' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases~1{aliasesId}~1csr/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/reports/methods/organizations_reports_get - - $ref: >- - #/components/x-stackQL-resources/reports/methods/organizations_reports_list + #/components/x-stackQL-resources/aliases/methods/organizations_environments_keystores_aliases_get insert: - $ref: >- - #/components/x-stackQL-resources/reports/methods/organizations_reports_create + #/components/x-stackQL-resources/aliases/methods/organizations_environments_keystores_aliases_create update: [] replace: - $ref: >- - #/components/x-stackQL-resources/reports/methods/organizations_reports_update + #/components/x-stackQL-resources/aliases/methods/organizations_environments_keystores_aliases_update delete: - $ref: >- - #/components/x-stackQL-resources/reports/methods/organizations_reports_delete - apiproducts_app_group_app_key_api_product: - id: google.apigee.apiproducts_app_group_app_key_api_product - name: apiproducts_app_group_app_key_api_product - title: Apiproducts_app_group_app_key_api_product - methods: - organizations_appgroups_apps_keys_apiproducts_update_app_group_app_key_api_product: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys~1{keysId}~1apiproducts~1{apiproductsId}/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: - - $ref: >- - #/components/x-stackQL-resources/apiproducts_app_group_app_key_api_product/methods/organizations_appgroups_apps_keys_apiproducts_update_app_group_app_key_api_product - replace: [] - delete: [] - keys_app_group_app_key: - id: google.apigee.keys_app_group_app_key - name: keys_app_group_app_key - title: Keys_app_group_app_key - methods: - organizations_appgroups_apps_keys_update_app_group_app_key: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys~1{keysId}/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: - - $ref: >- - #/components/x-stackQL-resources/keys_app_group_app_key/methods/organizations_appgroups_apps_keys_update_app_group_app_key - replace: [] - delete: [] - appgroups: - id: google.apigee.appgroups - name: appgroups - title: Appgroups + #/components/x-stackQL-resources/aliases/methods/organizations_environments_keystores_aliases_delete + aliases_certificate: + id: google.apigee.aliases_certificate + name: aliases_certificate + title: Aliases_certificate methods: - organizations_appgroups_delete: + organizations_environments_keystores_aliases_get_certificate: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases~1{aliasesId}~1certificate/get response: mediaType: application/json openAPIDocKey: '200' - organizations_appgroups_get: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/aliases_certificate/methods/organizations_environments_keystores_aliases_get_certificate + insert: [] + update: [] + replace: [] + delete: [] + targetservers: + id: google.apigee.targetservers + name: targetservers + title: Targetservers + methods: + organizations_environments_targetservers_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1targetservers/post response: mediaType: application/json openAPIDocKey: '200' - organizations_appgroups_update: + organizations_environments_targetservers_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1targetservers~1{targetserversId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_appgroups_create: + organizations_environments_targetservers_get: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1appgroups/post' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1targetservers~1{targetserversId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_appgroups_list: + organizations_environments_targetservers_update: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1appgroups/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1targetservers~1{targetserversId}/put response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.appGroups sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/appgroups/methods/organizations_appgroups_get - - $ref: >- - #/components/x-stackQL-resources/appgroups/methods/organizations_appgroups_list + #/components/x-stackQL-resources/targetservers/methods/organizations_environments_targetservers_get insert: - $ref: >- - #/components/x-stackQL-resources/appgroups/methods/organizations_appgroups_create + #/components/x-stackQL-resources/targetservers/methods/organizations_environments_targetservers_create update: [] replace: - $ref: >- - #/components/x-stackQL-resources/appgroups/methods/organizations_appgroups_update + #/components/x-stackQL-resources/targetservers/methods/organizations_environments_targetservers_update delete: - $ref: >- - #/components/x-stackQL-resources/appgroups/methods/organizations_appgroups_delete - apicategories: - id: google.apigee.apicategories - name: apicategories - title: Apicategories + #/components/x-stackQL-resources/targetservers/methods/organizations_environments_targetservers_delete + references: + id: google.apigee.references + name: references + title: References methods: - organizations_sites_apicategories_list: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apicategories/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_sites_apicategories_create: + organizations_environments_references_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apicategories/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1references/post response: mediaType: application/json openAPIDocKey: '200' - organizations_sites_apicategories_get: + organizations_environments_references_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apicategories~1{apicategoriesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1references~1{referencesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_sites_apicategories_patch: + organizations_environments_references_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apicategories~1{apicategoriesId}/patch + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1references~1{referencesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_sites_apicategories_delete: + organizations_environments_references_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apicategories~1{apicategoriesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1references~1{referencesId}/put response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/apicategories/methods/organizations_sites_apicategories_get - - $ref: >- - #/components/x-stackQL-resources/apicategories/methods/organizations_sites_apicategories_list + #/components/x-stackQL-resources/references/methods/organizations_environments_references_get insert: - $ref: >- - #/components/x-stackQL-resources/apicategories/methods/organizations_sites_apicategories_create - update: + #/components/x-stackQL-resources/references/methods/organizations_environments_references_create + update: [] + replace: - $ref: >- - #/components/x-stackQL-resources/apicategories/methods/organizations_sites_apicategories_patch - replace: [] + #/components/x-stackQL-resources/references/methods/organizations_environments_references_update delete: - $ref: >- - #/components/x-stackQL-resources/apicategories/methods/organizations_sites_apicategories_delete - apidocs: - id: google.apigee.apidocs - name: apidocs - title: Apidocs + #/components/x-stackQL-resources/references/methods/organizations_environments_references_delete + overrides: + id: google.apigee.overrides + name: overrides + title: Overrides methods: - organizations_sites_apidocs_update: + organizations_environments_trace_config_overrides_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs~1{apidocsId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig~1overrides/post response: mediaType: application/json openAPIDocKey: '200' - organizations_sites_apidocs_get: + organizations_environments_trace_config_overrides_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs~1{apidocsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig~1overrides/get response: mediaType: application/json openAPIDocKey: '200' - organizations_sites_apidocs_delete: + objectKey: $.traceConfigOverrides + organizations_environments_trace_config_overrides_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs~1{apidocsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig~1overrides~1{overridesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_sites_apidocs_list: + organizations_environments_trace_config_overrides_patch: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig~1overrides~1{overridesId}/patch response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.data - organizations_sites_apidocs_create: + organizations_environments_trace_config_overrides_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig~1overrides~1{overridesId}/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/apidocs/methods/organizations_sites_apidocs_get + #/components/x-stackQL-resources/overrides/methods/organizations_environments_trace_config_overrides_get - $ref: >- - #/components/x-stackQL-resources/apidocs/methods/organizations_sites_apidocs_list + #/components/x-stackQL-resources/overrides/methods/organizations_environments_trace_config_overrides_list insert: - $ref: >- - #/components/x-stackQL-resources/apidocs/methods/organizations_sites_apidocs_create - update: [] - replace: + #/components/x-stackQL-resources/overrides/methods/organizations_environments_trace_config_overrides_create + update: - $ref: >- - #/components/x-stackQL-resources/apidocs/methods/organizations_sites_apidocs_update + #/components/x-stackQL-resources/overrides/methods/organizations_environments_trace_config_overrides_patch + replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/apidocs/methods/organizations_sites_apidocs_delete - apidocs_documentation: - id: google.apigee.apidocs_documentation - name: apidocs_documentation - title: Apidocs_documentation + #/components/x-stackQL-resources/overrides/methods/organizations_environments_trace_config_overrides_delete + stats: + id: google.apigee.stats + name: stats + title: Stats methods: - organizations_sites_apidocs_update_documentation: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs~1{apidocsId}~1documentation/patch - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_sites_apidocs_get_documentation: + organizations_environments_stats_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs~1{apidocsId}~1documentation/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1stats~1{statsId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/apidocs_documentation/methods/organizations_sites_apidocs_get_documentation - insert: [] - update: - - $ref: >- - #/components/x-stackQL-resources/apidocs_documentation/methods/organizations_sites_apidocs_update_documentation - replace: [] - delete: [] - attributes_api_product_attribute: - id: google.apigee.attributes_api_product_attribute - name: attributes_api_product_attribute - title: Attributes_api_product_attribute - methods: - organizations_apiproducts_attributes_update_api_product_attribute: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1attributes~1{attributesId}/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] + #/components/x-stackQL-resources/stats/methods/organizations_environments_stats_get insert: [] - update: - - $ref: >- - #/components/x-stackQL-resources/attributes_api_product_attribute/methods/organizations_apiproducts_attributes_update_api_product_attribute + update: [] replace: [] delete: [] - rateplans: - id: google.apigee.rateplans - name: rateplans - title: Rateplans + optimized_stats: + id: google.apigee.optimized_stats + name: optimized_stats + title: Optimized_stats methods: - organizations_apiproducts_rateplans_list: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1rateplans/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_apiproducts_rateplans_create: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1rateplans/post - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_apiproducts_rateplans_delete: + organizations_environments_optimized_stats_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1rateplans~1{rateplansId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1optimizedStats~1{optimizedStatsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_rateplans_update: + organizations_optimized_host_stats_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1rateplans~1{rateplansId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1optimizedHostStats~1{optimizedHostStatsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_rateplans_get: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/optimized_stats/methods/organizations_environments_optimized_stats_get + - $ref: >- + #/components/x-stackQL-resources/optimized_stats/methods/organizations_optimized_host_stats_get + insert: [] + update: [] + replace: [] + delete: [] + admin_schemav2: + id: google.apigee.admin_schemav2 + name: admin_schemav2 + title: Admin_schemav2 + methods: + organizations_environments_analytics_admin_get_schemav2: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1rateplans~1{rateplansId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1analytics~1admin~1schemav2/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/rateplans/methods/organizations_apiproducts_rateplans_get - - $ref: >- - #/components/x-stackQL-resources/rateplans/methods/organizations_apiproducts_rateplans_list - insert: - - $ref: >- - #/components/x-stackQL-resources/rateplans/methods/organizations_apiproducts_rateplans_create + #/components/x-stackQL-resources/admin_schemav2/methods/organizations_environments_analytics_admin_get_schemav2 + insert: [] update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/rateplans/methods/organizations_apiproducts_rateplans_update - delete: - - $ref: >- - #/components/x-stackQL-resources/rateplans/methods/organizations_apiproducts_rateplans_delete - operations: - id: google.apigee.operations - name: operations - title: Operations + replace: [] + delete: [] + exports: + id: google.apigee.exports + name: exports + title: Exports methods: - organizations_operations_list: + organizations_environments_analytics_exports_create: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1operations/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1analytics~1exports/post + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_analytics_exports_list: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1analytics~1exports/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.operations - organizations_operations_get: + organizations_environments_analytics_exports_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1operations~1{operationsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1analytics~1exports~1{exportsId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/operations/methods/organizations_operations_get + #/components/x-stackQL-resources/exports/methods/organizations_environments_analytics_exports_get - $ref: >- - #/components/x-stackQL-resources/operations/methods/organizations_operations_list - insert: [] + #/components/x-stackQL-resources/exports/methods/organizations_environments_analytics_exports_list + insert: + - $ref: >- + #/components/x-stackQL-resources/exports/methods/organizations_environments_analytics_exports_create update: [] replace: [] delete: [] - security_actions: - id: google.apigee.security_actions - name: security_actions - title: Security_actions + queries: + id: google.apigee.queries + name: queries + title: Queries methods: - organizations_environments_security_actions_get: + organizations_environments_queries_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions~1{securityActionsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1queries/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_security_actions_disable: + organizations_environments_queries_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions~1{securityActionsId}:disable/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1queries/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_security_actions_list: + organizations_environments_queries_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1queries~1{queriesId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.securityActions - organizations_environments_security_actions_create: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/queries/methods/organizations_environments_queries_get + - $ref: >- + #/components/x-stackQL-resources/queries/methods/organizations_environments_queries_list + insert: + - $ref: >- + #/components/x-stackQL-resources/queries/methods/organizations_environments_queries_create + update: [] + replace: [] + delete: [] + queries_result: + id: google.apigee.queries_result + name: queries_result + title: Queries_result + methods: + organizations_environments_queries_get_result: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1queries~1{queriesId}~1result/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_security_actions_enable: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/queries_result/methods/organizations_environments_queries_get_result + insert: [] + update: [] + replace: [] + delete: [] + queries_resulturl: + id: google.apigee.queries_resulturl + name: queries_resulturl + title: Queries_resulturl + methods: + organizations_environments_queries_get_resulturl: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions~1{securityActionsId}:enable/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1queries~1{queriesId}~1resulturl/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/security_actions/methods/organizations_environments_security_actions_get - - $ref: >- - #/components/x-stackQL-resources/security_actions/methods/organizations_environments_security_actions_list - insert: - - $ref: >- - #/components/x-stackQL-resources/security_actions/methods/organizations_environments_security_actions_create + #/components/x-stackQL-resources/queries_resulturl/methods/organizations_environments_queries_get_resulturl + insert: [] update: [] replace: [] delete: [] - resourcefiles: - id: google.apigee.resourcefiles - name: resourcefiles - title: Resourcefiles + caches: + id: google.apigee.caches + name: caches + title: Caches methods: - organizations_environments_resourcefiles_list: + organizations_environments_caches_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1caches~1{cachesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_resourcefiles_create: + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/caches/methods/organizations_environments_caches_delete + security_reports: + id: google.apigee.security_reports + name: security_reports + title: Security_reports + methods: + organizations_environments_security_reports_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityReports/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_resourcefiles_get: + organizations_environments_security_reports_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles~1{type}~1{name}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityReports/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_resourcefiles_delete: + objectKey: $.securityReports + organizations_environments_security_reports_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles~1{type}~1{name}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityReports~1{securityReportsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_resourcefiles_update: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/security_reports/methods/organizations_environments_security_reports_get + - $ref: >- + #/components/x-stackQL-resources/security_reports/methods/organizations_environments_security_reports_list + insert: + - $ref: >- + #/components/x-stackQL-resources/security_reports/methods/organizations_environments_security_reports_create + update: [] + replace: [] + delete: [] + security_reports_result: + id: google.apigee.security_reports_result + name: security_reports_result + title: Security_reports_result + methods: + organizations_environments_security_reports_get_result: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles~1{type}~1{name}/put + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityReports~1{securityReportsId}~1result/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/resourcefiles/methods/organizations_environments_resourcefiles_get - - $ref: >- - #/components/x-stackQL-resources/resourcefiles/methods/organizations_environments_resourcefiles_list - insert: - - $ref: >- - #/components/x-stackQL-resources/resourcefiles/methods/organizations_environments_resourcefiles_create + #/components/x-stackQL-resources/security_reports_result/methods/organizations_environments_security_reports_get_result + insert: [] update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/resourcefiles/methods/organizations_environments_resourcefiles_update - delete: - - $ref: >- - #/components/x-stackQL-resources/resourcefiles/methods/organizations_environments_resourcefiles_delete - resourcefiles_environment_resources: - id: google.apigee.resourcefiles_environment_resources - name: resourcefiles_environment_resources - title: Resourcefiles_environment_resources + replace: [] + delete: [] + security_reports_result_view: + id: google.apigee.security_reports_result_view + name: security_reports_result_view + title: Security_reports_result_view methods: - organizations_environments_resourcefiles_list_environment_resources: + organizations_environments_security_reports_get_result_view: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles~1{type}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityReports~1{securityReportsId}~1resultView/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/resourcefiles_environment_resources/methods/organizations_environments_resourcefiles_list_environment_resources + #/components/x-stackQL-resources/security_reports_result_view/methods/organizations_environments_security_reports_get_result_view insert: [] update: [] replace: [] delete: [] - caches: - id: google.apigee.caches - name: caches - title: Caches + security_stats: + id: google.apigee.security_stats + name: security_stats + title: Security_stats methods: - organizations_environments_caches_delete: + organizations_environments_security_stats_query_tabular_stats: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1caches~1{cachesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityStats:queryTabularStats/post + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_security_stats_query_time_series_stats: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityStats:queryTimeSeriesStats/post response: mediaType: application/json openAPIDocKey: '200' @@ -10758,1769 +11253,1665 @@ components: insert: [] update: [] replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/caches/methods/organizations_environments_caches_delete - deployments_iam_policies: - id: google.apigee.deployments_iam_policies - name: deployments_iam_policies - title: Deployments_iam_policies + delete: [] + security_incidents: + id: google.apigee.security_incidents + name: security_incidents + title: Security_incidents methods: - organizations_environments_deployments_test_iam_permissions: + organizations_environments_security_incidents_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1deployments~1{deploymentsId}:testIamPermissions/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityIncidents~1{securityIncidentsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_deployments_get_iam_policy: + organizations_environments_security_incidents_patch: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1deployments~1{deploymentsId}:getIamPolicy/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityIncidents~1{securityIncidentsId}/patch response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.bindings - organizations_environments_deployments_set_iam_policy: + organizations_environments_security_incidents_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1deployments~1{deploymentsId}:setIamPolicy/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityIncidents/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.securityIncidents + organizations_environments_security_incidents_batch_update: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityIncidents:batchUpdate/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/deployments_iam_policies/methods/organizations_environments_deployments_get_iam_policy + #/components/x-stackQL-resources/security_incidents/methods/organizations_environments_security_incidents_get + - $ref: >- + #/components/x-stackQL-resources/security_incidents/methods/organizations_environments_security_incidents_list insert: [] - update: [] - replace: + update: - $ref: >- - #/components/x-stackQL-resources/deployments_iam_policies/methods/organizations_environments_deployments_set_iam_policy + #/components/x-stackQL-resources/security_incidents/methods/organizations_environments_security_incidents_patch + - $ref: >- + #/components/x-stackQL-resources/security_incidents/methods/organizations_environments_security_incidents_batch_update + replace: [] delete: [] - references: - id: google.apigee.references - name: references - title: References + security_actions: + id: google.apigee.security_actions + name: security_actions + title: Security_actions methods: - organizations_environments_references_get: + organizations_environments_security_actions_create: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions/post + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_security_actions_list: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.securityActions + organizations_environments_security_actions_get: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions~1{securityActionsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_security_actions_patch: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1references~1{referencesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions~1{securityActionsId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_references_update: + organizations_environments_security_actions_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1references~1{referencesId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions~1{securityActionsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_references_delete: + organizations_environments_security_actions_enable: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1references~1{referencesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions~1{securityActionsId}:enable/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_references_create: + organizations_environments_security_actions_disable: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1references/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions~1{securityActionsId}:disable/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/references/methods/organizations_environments_references_get + #/components/x-stackQL-resources/security_actions/methods/organizations_environments_security_actions_get + - $ref: >- + #/components/x-stackQL-resources/security_actions/methods/organizations_environments_security_actions_list insert: - $ref: >- - #/components/x-stackQL-resources/references/methods/organizations_environments_references_create - update: [] - replace: + #/components/x-stackQL-resources/security_actions/methods/organizations_environments_security_actions_create + update: - $ref: >- - #/components/x-stackQL-resources/references/methods/organizations_environments_references_update + #/components/x-stackQL-resources/security_actions/methods/organizations_environments_security_actions_patch + replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/references/methods/organizations_environments_references_delete - security_incidents: - id: google.apigee.security_incidents - name: security_incidents - title: Security_incidents + #/components/x-stackQL-resources/security_actions/methods/organizations_environments_security_actions_delete + envgroups: + id: google.apigee.envgroups + name: envgroups + title: Envgroups methods: - organizations_environments_security_incidents_batch_update: + organizations_envgroups_create: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityIncidents:batchUpdate/post + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1envgroups/post' response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_security_incidents_patch: + organizations_envgroups_list: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1envgroups/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.environmentGroups + organizations_envgroups_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityIncidents~1{securityIncidentsId}/patch + #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_security_incidents_get: + organizations_envgroups_patch: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityIncidents~1{securityIncidentsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_security_incidents_list: + organizations_envgroups_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityIncidents/get + #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.securityIncidents sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/security_incidents/methods/organizations_environments_security_incidents_get + #/components/x-stackQL-resources/envgroups/methods/organizations_envgroups_get - $ref: >- - #/components/x-stackQL-resources/security_incidents/methods/organizations_environments_security_incidents_list - insert: [] - update: + #/components/x-stackQL-resources/envgroups/methods/organizations_envgroups_list + insert: - $ref: >- - #/components/x-stackQL-resources/security_incidents/methods/organizations_environments_security_incidents_patch + #/components/x-stackQL-resources/envgroups/methods/organizations_envgroups_create + update: - $ref: >- - #/components/x-stackQL-resources/security_incidents/methods/organizations_environments_security_incidents_batch_update + #/components/x-stackQL-resources/envgroups/methods/organizations_envgroups_patch replace: [] - delete: [] - revisions_deployments: - id: google.apigee.revisions_deployments - name: revisions_deployments - title: Revisions_deployments + delete: + - $ref: >- + #/components/x-stackQL-resources/envgroups/methods/organizations_envgroups_delete + envgroup_config: + id: google.apigee.envgroup_config + name: envgroup_config + title: Envgroup_config methods: - organizations_environments_sharedflows_revisions_get_deployments: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}~1deployments/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_environments_apis_revisions_get_deployments: + organizations_envgroups_get_deployed_ingress_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments/get + #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}~1deployedIngressConfig/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/revisions_deployments/methods/organizations_environments_sharedflows_revisions_get_deployments - - $ref: >- - #/components/x-stackQL-resources/revisions_deployments/methods/organizations_environments_apis_revisions_get_deployments + #/components/x-stackQL-resources/envgroup_config/methods/organizations_envgroups_get_deployed_ingress_config insert: [] update: [] replace: [] delete: [] - queries_resulturl: - id: google.apigee.queries_resulturl - name: queries_resulturl - title: Queries_resulturl + attachments: + id: google.apigee.attachments + name: attachments + title: Attachments methods: - organizations_environments_queries_get_resulturl: + organizations_envgroups_attachments_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1queries~1{queriesId}~1resulturl/get + #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}~1attachments/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/queries_resulturl/methods/organizations_environments_queries_get_resulturl - insert: [] - update: [] - replace: [] - delete: [] - queries: - id: google.apigee.queries - name: queries - title: Queries - methods: - organizations_environments_queries_get: + organizations_envgroups_attachments_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1queries~1{queriesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}~1attachments/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_queries_create: + objectKey: $.environmentGroupAttachments + organizations_envgroups_attachments_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1queries/post + #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}~1attachments~1{attachmentsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_queries_list: + organizations_envgroups_attachments_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1queries/get + #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}~1attachments~1{attachmentsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_instances_attachments_create: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1attachments/post + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_instances_attachments_list: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1attachments/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.attachments + organizations_instances_attachments_get: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1attachments~1{attachmentsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_instances_attachments_delete: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1attachments~1{attachmentsId}/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/queries/methods/organizations_environments_queries_get + #/components/x-stackQL-resources/attachments/methods/organizations_envgroups_attachments_get - $ref: >- - #/components/x-stackQL-resources/queries/methods/organizations_environments_queries_list + #/components/x-stackQL-resources/attachments/methods/organizations_instances_attachments_get + - $ref: >- + #/components/x-stackQL-resources/attachments/methods/organizations_envgroups_attachments_list + - $ref: >- + #/components/x-stackQL-resources/attachments/methods/organizations_instances_attachments_list insert: - $ref: >- - #/components/x-stackQL-resources/queries/methods/organizations_environments_queries_create + #/components/x-stackQL-resources/attachments/methods/organizations_envgroups_attachments_create + - $ref: >- + #/components/x-stackQL-resources/attachments/methods/organizations_instances_attachments_create update: [] replace: [] - delete: [] - queries_result: - id: google.apigee.queries_result - name: queries_result - title: Queries_result + delete: + - $ref: >- + #/components/x-stackQL-resources/attachments/methods/organizations_envgroups_attachments_delete + - $ref: >- + #/components/x-stackQL-resources/attachments/methods/organizations_instances_attachments_delete + instances: + id: google.apigee.instances + name: instances + title: Instances methods: - organizations_environments_queries_get_result: + organizations_instances_create: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1queries~1{queriesId}~1result/get + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1instances/post' response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/queries_result/methods/organizations_environments_queries_get_result - insert: [] - update: [] - replace: [] - delete: [] - targetservers: - id: google.apigee.targetservers - name: targetservers - title: Targetservers - methods: - organizations_environments_targetservers_update: + organizations_instances_list: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1instances/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.instances + organizations_instances_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1targetservers~1{targetserversId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_targetservers_get: + organizations_instances_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1targetservers~1{targetserversId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_targetservers_delete: + organizations_instances_patch: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1targetservers~1{targetserversId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_targetservers_create: + organizations_instances_report_status: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1targetservers/post + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}:reportStatus/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/targetservers/methods/organizations_environments_targetservers_get + #/components/x-stackQL-resources/instances/methods/organizations_instances_get + - $ref: >- + #/components/x-stackQL-resources/instances/methods/organizations_instances_list insert: - $ref: >- - #/components/x-stackQL-resources/targetservers/methods/organizations_environments_targetservers_create - update: [] - replace: + #/components/x-stackQL-resources/instances/methods/organizations_instances_create + update: - $ref: >- - #/components/x-stackQL-resources/targetservers/methods/organizations_environments_targetservers_update + #/components/x-stackQL-resources/instances/methods/organizations_instances_patch + replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/targetservers/methods/organizations_environments_targetservers_delete - optimized_stats: - id: google.apigee.optimized_stats - name: optimized_stats - title: Optimized_stats + #/components/x-stackQL-resources/instances/methods/organizations_instances_delete + canaryevaluations: + id: google.apigee.canaryevaluations + name: canaryevaluations + title: Canaryevaluations methods: - organizations_environments_optimized_stats_get: + organizations_instances_canaryevaluations_create: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1canaryevaluations/post + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_instances_canaryevaluations_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1optimizedStats~1{optimizedStatsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1canaryevaluations~1{canaryevaluationsId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/optimized_stats/methods/organizations_environments_optimized_stats_get - insert: [] + #/components/x-stackQL-resources/canaryevaluations/methods/organizations_instances_canaryevaluations_get + insert: + - $ref: >- + #/components/x-stackQL-resources/canaryevaluations/methods/organizations_instances_canaryevaluations_create update: [] replace: [] delete: [] - addons_config: - id: google.apigee.addons_config - name: addons_config - title: Addons_config + nat_addresses: + id: google.apigee.nat_addresses + name: nat_addresses + title: Nat_addresses methods: - organizations_environments_addons_config_set_addon_enablement: + organizations_instances_nat_addresses_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1addonsConfig:setAddonEnablement/post + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1natAddresses/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: [] - entries: - id: google.apigee.entries - name: entries - title: Entries - methods: - organizations_environments_keyvaluemaps_entries_create: + objectKey: $.natAddresses + organizations_instances_nat_addresses_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/post + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1natAddresses/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keyvaluemaps_entries_list: + organizations_instances_nat_addresses_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/get + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1natAddresses~1{natAddressesId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.keyValueEntries - organizations_environments_keyvaluemaps_entries_delete: + organizations_instances_nat_addresses_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1natAddresses~1{natAddressesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keyvaluemaps_entries_update: + organizations_instances_nat_addresses_activate: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1natAddresses~1{natAddressesId}:activate/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keyvaluemaps_entries_get: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/nat_addresses/methods/organizations_instances_nat_addresses_get + - $ref: >- + #/components/x-stackQL-resources/nat_addresses/methods/organizations_instances_nat_addresses_list + insert: + - $ref: >- + #/components/x-stackQL-resources/nat_addresses/methods/organizations_instances_nat_addresses_create + update: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/nat_addresses/methods/organizations_instances_nat_addresses_delete + sharedflows: + id: google.apigee.sharedflows + name: sharedflows + title: Sharedflows + methods: + organizations_sharedflows_list: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/get + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1sharedflows/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_keyvaluemaps_entries_get: + organizations_sharedflows_create: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/get + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1sharedflows/post' response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_keyvaluemaps_entries_delete: + organizations_sharedflows_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_keyvaluemaps_entries_update: + organizations_sharedflows_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_keyvaluemaps_entries_list: + organizations_sharedflows_move: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/get + #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}:move/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.keyValueEntries - organizations_apis_keyvaluemaps_entries_create: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/sharedflows/methods/organizations_sharedflows_get + - $ref: >- + #/components/x-stackQL-resources/sharedflows/methods/organizations_sharedflows_list + insert: + - $ref: >- + #/components/x-stackQL-resources/sharedflows/methods/organizations_sharedflows_create + update: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/sharedflows/methods/organizations_sharedflows_delete + revisions_shared_flow_revision: + id: google.apigee.revisions_shared_flow_revision + name: revisions_shared_flow_revision + title: Revisions_shared_flow_revision + methods: + organizations_sharedflows_revisions_update_shared_flow_revision: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/post + #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}/post response: mediaType: application/json openAPIDocKey: '200' - organizations_keyvaluemaps_entries_create: + sqlVerbs: + select: [] + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/revisions_shared_flow_revision/methods/organizations_sharedflows_revisions_update_shared_flow_revision + replace: [] + delete: [] + spaces: + id: google.apigee.spaces + name: spaces + title: Spaces + methods: + organizations_spaces_create: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/post + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1spaces/post' response: mediaType: application/json openAPIDocKey: '200' - organizations_keyvaluemaps_entries_list: + organizations_spaces_list: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/get + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1spaces/get' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.keyValueEntries - organizations_keyvaluemaps_entries_update: + objectKey: $.spaces + organizations_spaces_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1spaces~1{spacesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_keyvaluemaps_entries_delete: + organizations_spaces_patch: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1spaces~1{spacesId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_keyvaluemaps_entries_get: + organizations_spaces_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1spaces~1{spacesId}/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_environments_keyvaluemaps_entries_get - - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_apis_keyvaluemaps_entries_get - - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_environments_keyvaluemaps_entries_list - - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_apis_keyvaluemaps_entries_list - - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_keyvaluemaps_entries_get + #/components/x-stackQL-resources/spaces/methods/organizations_spaces_get - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_keyvaluemaps_entries_list + #/components/x-stackQL-resources/spaces/methods/organizations_spaces_list insert: - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_environments_keyvaluemaps_entries_create - - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_apis_keyvaluemaps_entries_create - - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_keyvaluemaps_entries_create - update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_environments_keyvaluemaps_entries_update - - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_apis_keyvaluemaps_entries_update + #/components/x-stackQL-resources/spaces/methods/organizations_spaces_create + update: - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_keyvaluemaps_entries_update + #/components/x-stackQL-resources/spaces/methods/organizations_spaces_patch + replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_environments_keyvaluemaps_entries_delete - - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_apis_keyvaluemaps_entries_delete - - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_keyvaluemaps_entries_delete - keyvaluemaps: - id: google.apigee.keyvaluemaps - name: keyvaluemaps - title: Keyvaluemaps + #/components/x-stackQL-resources/spaces/methods/organizations_spaces_delete + spaces_iam_policies: + id: google.apigee.spaces_iam_policies + name: spaces_iam_policies + title: Spaces_iam_policies methods: - organizations_environments_keyvaluemaps_create: + organizations_spaces_set_iam_policy: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps/post + #/paths/~1v1~1organizations~1{organizationsId}~1spaces~1{spacesId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keyvaluemaps_delete: + organizations_spaces_get_iam_policy: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1spaces~1{spacesId}:getIamPolicy/get response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_keyvaluemaps_delete: + objectKey: $.bindings + organizations_spaces_test_iam_permissions: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1spaces~1{spacesId}:testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_keyvaluemaps_create: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/spaces_iam_policies/methods/organizations_spaces_get_iam_policy + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/spaces_iam_policies/methods/organizations_spaces_set_iam_policy + delete: [] + host_stats: + id: google.apigee.host_stats + name: host_stats + title: Host_stats + methods: + organizations_host_stats_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps/post + #/paths/~1v1~1organizations~1{organizationsId}~1hostStats~1{hostStatsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_keyvaluemaps_delete: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/host_stats/methods/organizations_host_stats_get + insert: [] + update: [] + replace: [] + delete: [] + apiproducts: + id: google.apigee.apiproducts + name: apiproducts + title: Apiproducts + methods: + organizations_apiproducts_create: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apiproducts/post' + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_apiproducts_list: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apiproducts/get' + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_apiproducts_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_keyvaluemaps_create: + organizations_apiproducts_get: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps/post' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: >- - #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_environments_keyvaluemaps_create - - $ref: >- - #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_apis_keyvaluemaps_create - - $ref: >- - #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_keyvaluemaps_create - update: [] - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_environments_keyvaluemaps_delete - - $ref: >- - #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_apis_keyvaluemaps_delete - - $ref: >- - #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_keyvaluemaps_delete - security_reports_result: - id: google.apigee.security_reports_result - name: security_reports_result - title: Security_reports_result - methods: - organizations_environments_security_reports_get_result: + organizations_apiproducts_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityReports~1{securityReportsId}~1result/get + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}/put response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/security_reports_result/methods/organizations_environments_security_reports_get_result - insert: [] - update: [] - replace: [] - delete: [] - security_reports_result_view: - id: google.apigee.security_reports_result_view - name: security_reports_result_view - title: Security_reports_result_view - methods: - organizations_environments_security_reports_get_result_view: + organizations_apiproducts_move: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityReports~1{securityReportsId}~1resultView/get + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}:move/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/security_reports_result_view/methods/organizations_environments_security_reports_get_result_view - insert: [] - update: [] - replace: [] - delete: [] - security_reports: - id: google.apigee.security_reports - name: security_reports - title: Security_reports - methods: - organizations_environments_security_reports_create: + organizations_apiproducts_attributes: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityReports/post + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1attributes/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_security_reports_list: + organizations_appgroups_apps_keys_apiproducts_update_app_group_app_key_api_product: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityReports/get + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys~1{keysId}~1apiproducts~1{apiproductsId}/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.securityReports - organizations_environments_security_reports_get: + organizations_appgroups_apps_keys_apiproducts_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityReports~1{securityReportsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys~1{keysId}~1apiproducts~1{apiproductsId}/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/security_reports/methods/organizations_environments_security_reports_get + #/components/x-stackQL-resources/apiproducts/methods/organizations_apiproducts_get - $ref: >- - #/components/x-stackQL-resources/security_reports/methods/organizations_environments_security_reports_list + #/components/x-stackQL-resources/apiproducts/methods/organizations_apiproducts_list insert: - $ref: >- - #/components/x-stackQL-resources/security_reports/methods/organizations_environments_security_reports_create + #/components/x-stackQL-resources/apiproducts/methods/organizations_apiproducts_create update: [] - replace: [] - delete: [] - flowhooks: - id: google.apigee.flowhooks - name: flowhooks - title: Flowhooks + replace: + - $ref: >- + #/components/x-stackQL-resources/apiproducts/methods/organizations_apiproducts_update + delete: + - $ref: >- + #/components/x-stackQL-resources/apiproducts/methods/organizations_appgroups_apps_keys_apiproducts_delete + - $ref: >- + #/components/x-stackQL-resources/apiproducts/methods/organizations_apiproducts_delete + attributes: + id: google.apigee.attributes + name: attributes + title: Attributes methods: - organizations_environments_flowhooks_detach_shared_flow_from_flow_hook: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1flowhooks~1{flowhooksId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_environments_flowhooks_get: + organizations_apiproducts_attributes_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1flowhooks~1{flowhooksId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1attributes/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_flowhooks_attach_shared_flow_to_flow_hook: + organizations_apiproducts_attributes_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1flowhooks~1{flowhooksId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1attributes~1{attributesId}/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/flowhooks/methods/organizations_environments_flowhooks_get - insert: [] - update: [] - replace: [] - delete: [] - overrides: - id: google.apigee.overrides - name: overrides - title: Overrides - methods: - organizations_environments_trace_config_overrides_delete: + organizations_apiproducts_attributes_update_api_product_attribute: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig~1overrides~1{overridesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1attributes~1{attributesId}/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_trace_config_overrides_patch: + organizations_apiproducts_attributes_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig~1overrides~1{overridesId}/patch + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1attributes~1{attributesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_trace_config_overrides_get: + organizations_developers_attributes_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig~1overrides~1{overridesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1attributes/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_trace_config_overrides_create: + organizations_developers_apps_attributes_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig~1overrides/post + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1attributes/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_trace_config_overrides_list: + organizations_developers_apps_attributes_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig~1overrides/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1attributes~1{attributesId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.traceConfigOverrides - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/overrides/methods/organizations_environments_trace_config_overrides_get - - $ref: >- - #/components/x-stackQL-resources/overrides/methods/organizations_environments_trace_config_overrides_list - insert: - - $ref: >- - #/components/x-stackQL-resources/overrides/methods/organizations_environments_trace_config_overrides_create - update: - - $ref: >- - #/components/x-stackQL-resources/overrides/methods/organizations_environments_trace_config_overrides_patch - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/overrides/methods/organizations_environments_trace_config_overrides_delete - security_stats: - id: google.apigee.security_stats - name: security_stats - title: Security_stats - methods: - organizations_environments_security_stats_query_tabular_stats: + organizations_developers_apps_attributes_update_developer_app_attribute: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityStats:queryTabularStats/post + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1attributes~1{attributesId}/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_security_stats_query_time_series_stats: + organizations_developers_apps_attributes_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityStats:queryTimeSeriesStats/post + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1attributes~1{attributesId}/delete response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: [] - keystores: - id: google.apigee.keystores - name: keystores - title: Keystores - methods: - organizations_environments_keystores_delete: + organizations_developers_attributes_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1attributes~1{attributesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keystores_get: + organizations_developers_attributes_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1attributes~1{attributesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keystores_create: + organizations_developers_attributes_update_developer_attribute: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores/post + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1attributes~1{attributesId}/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/keystores/methods/organizations_environments_keystores_get - insert: + #/components/x-stackQL-resources/attributes/methods/organizations_developers_apps_attributes_get - $ref: >- - #/components/x-stackQL-resources/keystores/methods/organizations_environments_keystores_create + #/components/x-stackQL-resources/attributes/methods/organizations_apiproducts_attributes_get + - $ref: >- + #/components/x-stackQL-resources/attributes/methods/organizations_developers_apps_attributes_list + - $ref: >- + #/components/x-stackQL-resources/attributes/methods/organizations_developers_attributes_get + - $ref: >- + #/components/x-stackQL-resources/attributes/methods/organizations_apiproducts_attributes_list + - $ref: >- + #/components/x-stackQL-resources/attributes/methods/organizations_developers_attributes_list + insert: [] update: [] replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/keystores/methods/organizations_environments_keystores_delete - aliases: - id: google.apigee.aliases - name: aliases - title: Aliases + #/components/x-stackQL-resources/attributes/methods/organizations_developers_apps_attributes_delete + - $ref: >- + #/components/x-stackQL-resources/attributes/methods/organizations_apiproducts_attributes_delete + - $ref: >- + #/components/x-stackQL-resources/attributes/methods/organizations_developers_attributes_delete + rateplans: + id: google.apigee.rateplans + name: rateplans + title: Rateplans methods: - organizations_environments_keystores_aliases_delete: + organizations_apiproducts_rateplans_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases~1{aliasesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1rateplans/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keystores_aliases_get: + organizations_apiproducts_rateplans_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases~1{aliasesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1rateplans/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keystores_aliases_update: + organizations_apiproducts_rateplans_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases~1{aliasesId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1rateplans~1{rateplansId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keystores_aliases_create: + organizations_apiproducts_rateplans_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases/post + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1rateplans~1{rateplansId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keystores_aliases_csr: + organizations_apiproducts_rateplans_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases~1{aliasesId}~1csr/get + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1rateplans~1{rateplansId}/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/aliases/methods/organizations_environments_keystores_aliases_get + #/components/x-stackQL-resources/rateplans/methods/organizations_apiproducts_rateplans_get + - $ref: >- + #/components/x-stackQL-resources/rateplans/methods/organizations_apiproducts_rateplans_list insert: - $ref: >- - #/components/x-stackQL-resources/aliases/methods/organizations_environments_keystores_aliases_create + #/components/x-stackQL-resources/rateplans/methods/organizations_apiproducts_rateplans_create update: [] replace: - $ref: >- - #/components/x-stackQL-resources/aliases/methods/organizations_environments_keystores_aliases_update + #/components/x-stackQL-resources/rateplans/methods/organizations_apiproducts_rateplans_update delete: - $ref: >- - #/components/x-stackQL-resources/aliases/methods/organizations_environments_keystores_aliases_delete - aliases_certificate: - id: google.apigee.aliases_certificate - name: aliases_certificate - title: Aliases_certificate + #/components/x-stackQL-resources/rateplans/methods/organizations_apiproducts_rateplans_delete + apps: + id: google.apigee.apps + name: apps + title: Apps methods: - organizations_environments_keystores_aliases_get_certificate: + organizations_apps_get: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases~1{aliasesId}~1certificate/get + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apps~1{appsId}/get' response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/aliases_certificate/methods/organizations_environments_keystores_aliases_get_certificate - insert: [] - update: [] - replace: [] - delete: [] - archive_deployments: - id: google.apigee.archive_deployments - name: archive_deployments - title: Archive_deployments - methods: - organizations_environments_archive_deployments_get: + organizations_apps_list: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apps/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.app + organizations_developers_apps_generate_key_pair_or_update_developer_app_status: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments~1{archiveDeploymentsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_archive_deployments_patch: + organizations_developers_apps_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments~1{archiveDeploymentsId}/patch + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_archive_deployments_delete: + organizations_developers_apps_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments~1{archiveDeploymentsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_archive_deployments_create: + organizations_developers_apps_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments/post + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_archive_deployments_list: + organizations_developers_apps_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.archiveDeployments - organizations_environments_archive_deployments_generate_download_url: + organizations_developers_apps_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments~1{archiveDeploymentsId}:generateDownloadUrl/post + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_archive_deployments_generate_upload_url: + organizations_developers_apps_attributes: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments:generateUploadUrl/post + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1attributes/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/archive_deployments/methods/organizations_environments_archive_deployments_get - - $ref: >- - #/components/x-stackQL-resources/archive_deployments/methods/organizations_environments_archive_deployments_list - insert: - - $ref: >- - #/components/x-stackQL-resources/archive_deployments/methods/organizations_environments_archive_deployments_create - update: - - $ref: >- - #/components/x-stackQL-resources/archive_deployments/methods/organizations_environments_archive_deployments_patch - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/archive_deployments/methods/organizations_environments_archive_deployments_delete - stats: - id: google.apigee.stats - name: stats - title: Stats - methods: - organizations_environments_stats_get: + organizations_appgroups_apps_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1stats~1{statsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/stats/methods/organizations_environments_stats_get - insert: [] - update: [] - replace: [] - delete: [] - admin_schemav2: - id: google.apigee.admin_schemav2 - name: admin_schemav2 - title: Admin_schemav2 - methods: - organizations_environments_analytics_admin_get_schemav2: + organizations_appgroups_apps_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1analytics~1admin~1schemav2/get + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/admin_schemav2/methods/organizations_environments_analytics_admin_get_schemav2 - insert: [] - update: [] - replace: [] - delete: [] - exports: - id: google.apigee.exports - name: exports - title: Exports - methods: - organizations_environments_analytics_exports_create: + objectKey: $.appGroupApps + organizations_appgroups_apps_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1analytics~1exports/post + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_analytics_exports_list: + organizations_appgroups_apps_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1analytics~1exports/get + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_analytics_exports_get: + organizations_appgroups_apps_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1analytics~1exports~1{exportsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}/put response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/exports/methods/organizations_environments_analytics_exports_get + #/components/x-stackQL-resources/apps/methods/organizations_developers_apps_get - $ref: >- - #/components/x-stackQL-resources/exports/methods/organizations_environments_analytics_exports_list + #/components/x-stackQL-resources/apps/methods/organizations_appgroups_apps_get + - $ref: >- + #/components/x-stackQL-resources/apps/methods/organizations_apps_get + - $ref: >- + #/components/x-stackQL-resources/apps/methods/organizations_developers_apps_list + - $ref: >- + #/components/x-stackQL-resources/apps/methods/organizations_appgroups_apps_list + - $ref: >- + #/components/x-stackQL-resources/apps/methods/organizations_apps_list insert: - $ref: >- - #/components/x-stackQL-resources/exports/methods/organizations_environments_analytics_exports_create + #/components/x-stackQL-resources/apps/methods/organizations_developers_apps_create + - $ref: >- + #/components/x-stackQL-resources/apps/methods/organizations_appgroups_apps_create update: [] - replace: [] - delete: [] - debugsessions: - id: google.apigee.debugsessions - name: debugsessions - title: Debugsessions + replace: + - $ref: >- + #/components/x-stackQL-resources/apps/methods/organizations_developers_apps_update + - $ref: >- + #/components/x-stackQL-resources/apps/methods/organizations_appgroups_apps_update + delete: + - $ref: >- + #/components/x-stackQL-resources/apps/methods/organizations_developers_apps_delete + - $ref: >- + #/components/x-stackQL-resources/apps/methods/organizations_appgroups_apps_delete + host_queries: + id: google.apigee.host_queries + name: host_queries + title: Host_queries methods: - organizations_environments_apis_revisions_debugsessions_get: + organizations_host_queries_create: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1debugsessions~1{debugsessionsId}/get + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1hostQueries/post' response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_apis_revisions_debugsessions_create: + organizations_host_queries_list: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1debugsessions/post + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1hostQueries/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_apis_revisions_debugsessions_list: + organizations_host_queries_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1debugsessions/get + #/paths/~1v1~1organizations~1{organizationsId}~1hostQueries~1{hostQueriesId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.sessions sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/debugsessions/methods/organizations_environments_apis_revisions_debugsessions_get + #/components/x-stackQL-resources/host_queries/methods/organizations_host_queries_get - $ref: >- - #/components/x-stackQL-resources/debugsessions/methods/organizations_environments_apis_revisions_debugsessions_list + #/components/x-stackQL-resources/host_queries/methods/organizations_host_queries_list insert: - $ref: >- - #/components/x-stackQL-resources/debugsessions/methods/organizations_environments_apis_revisions_debugsessions_create + #/components/x-stackQL-resources/host_queries/methods/organizations_host_queries_create update: [] replace: [] delete: [] - debugsessions_data: - id: google.apigee.debugsessions_data - name: debugsessions_data - title: Debugsessions_data + host_queries_result: + id: google.apigee.host_queries_result + name: host_queries_result + title: Host_queries_result methods: - organizations_environments_apis_revisions_debugsessions_delete_data: + organizations_host_queries_get_result: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1debugsessions~1{debugsessionsId}~1data/delete + #/paths/~1v1~1organizations~1{organizationsId}~1hostQueries~1{hostQueriesId}~1result/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/host_queries_result/methods/organizations_host_queries_get_result insert: [] update: [] replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/debugsessions_data/methods/organizations_environments_apis_revisions_debugsessions_delete_data - data: - id: google.apigee.data - name: data - title: Data + delete: [] + host_queries_result_view: + id: google.apigee.host_queries_result_view + name: host_queries_result_view + title: Host_queries_result_view methods: - organizations_environments_apis_revisions_debugsessions_data_get: + organizations_host_queries_get_result_view: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1debugsessions~1{debugsessionsId}~1data~1{dataId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1hostQueries~1{hostQueriesId}~1resultView/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/data/methods/organizations_environments_apis_revisions_debugsessions_data_get + #/components/x-stackQL-resources/host_queries_result_view/methods/organizations_host_queries_get_result_view insert: [] update: [] replace: [] delete: [] - environments: - id: google.apigee.environments - name: environments - title: Environments + reports: + id: google.apigee.reports + name: reports + title: Reports methods: - organizations_environments_get: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_environments_delete: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_environments_update: + organizations_reports_create: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}/put + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1reports/post' response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_modify_environment: + organizations_reports_list: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}/patch + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1reports/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_subscribe: + organizations_reports_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}:subscribe/post - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_environments_create: - operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1environments/post' + #/paths/~1v1~1organizations~1{organizationsId}~1reports~1{reportsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_unsubscribe: + organizations_reports_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}:unsubscribe/post + #/paths/~1v1~1organizations~1{organizationsId}~1reports~1{reportsId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_security_profiles_environments_create: + organizations_reports_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}~1environments/post + #/paths/~1v1~1organizations~1{organizationsId}~1reports~1{reportsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_security_profiles_environments_compute_environment_scores: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/reports/methods/organizations_reports_get + - $ref: >- + #/components/x-stackQL-resources/reports/methods/organizations_reports_list + insert: + - $ref: >- + #/components/x-stackQL-resources/reports/methods/organizations_reports_create + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/reports/methods/organizations_reports_update + delete: + - $ref: >- + #/components/x-stackQL-resources/reports/methods/organizations_reports_delete + datastores: + id: google.apigee.datastores + name: datastores + title: Datastores + methods: + organizations_analytics_datastores_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}~1environments~1{environmentsId}:computeEnvironmentScores/post + #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores/post response: mediaType: application/json openAPIDocKey: '200' - organizations_security_profiles_environments_delete: + organizations_analytics_datastores_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}~1environments~1{environmentsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/environments/methods/organizations_environments_get - insert: - - $ref: >- - #/components/x-stackQL-resources/environments/methods/organizations_security_profiles_environments_create - - $ref: >- - #/components/x-stackQL-resources/environments/methods/organizations_environments_create - update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/environments/methods/organizations_environments_update - delete: - - $ref: >- - #/components/x-stackQL-resources/environments/methods/organizations_security_profiles_environments_delete - - $ref: >- - #/components/x-stackQL-resources/environments/methods/organizations_environments_delete - environments_environment: - id: google.apigee.environments_environment - name: environments_environment - title: Environments_environment - methods: - organizations_environments_update_environment: + organizations_analytics_datastores_test: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}/post + #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores:test/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: - - $ref: >- - #/components/x-stackQL-resources/environments_environment/methods/organizations_environments_update_environment - replace: [] - delete: [] - environments_iam_policies: - id: google.apigee.environments_iam_policies - name: environments_iam_policies - title: Environments_iam_policies - methods: - organizations_environments_set_iam_policy: + organizations_analytics_datastores_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}:setIamPolicy/post + #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores~1{datastoresId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_test_iam_permissions: + organizations_analytics_datastores_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}:testIamPermissions/post + #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores~1{datastoresId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_get_iam_policy: + organizations_analytics_datastores_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}:getIamPolicy/get + #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores~1{datastoresId}/put response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.bindings sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/environments_iam_policies/methods/organizations_environments_get_iam_policy - insert: [] + #/components/x-stackQL-resources/datastores/methods/organizations_analytics_datastores_get + - $ref: >- + #/components/x-stackQL-resources/datastores/methods/organizations_analytics_datastores_list + insert: + - $ref: >- + #/components/x-stackQL-resources/datastores/methods/organizations_analytics_datastores_create update: [] replace: - $ref: >- - #/components/x-stackQL-resources/environments_iam_policies/methods/organizations_environments_set_iam_policy - delete: [] - environments_debugmask: - id: google.apigee.environments_debugmask - name: environments_debugmask - title: Environments_debugmask + #/components/x-stackQL-resources/datastores/methods/organizations_analytics_datastores_update + delete: + - $ref: >- + #/components/x-stackQL-resources/datastores/methods/organizations_analytics_datastores_delete + developers: + id: google.apigee.developers + name: developers + title: Developers methods: - organizations_environments_update_debugmask: + organizations_developers_create: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1debugmask/patch + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1developers/post' response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_get_debugmask: + organizations_developers_list: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1developers/get' + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_developers_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1debugmask/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}/put response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/environments_debugmask/methods/organizations_environments_get_debugmask - insert: [] - update: - - $ref: >- - #/components/x-stackQL-resources/environments_debugmask/methods/organizations_environments_update_debugmask - replace: [] - delete: [] - environments_trace_config: - id: google.apigee.environments_trace_config - name: environments_trace_config - title: Environments_trace_config - methods: - organizations_environments_update_trace_config: + organizations_developers_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig/patch + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_get_trace_config: + organizations_developers_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}/delete response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/environments_trace_config/methods/organizations_environments_get_trace_config - insert: [] - update: - - $ref: >- - #/components/x-stackQL-resources/environments_trace_config/methods/organizations_environments_update_trace_config - replace: [] - delete: [] - environments_security_actions_config: - id: google.apigee.environments_security_actions_config - name: environments_security_actions_config - title: Environments_security_actions_config - methods: - organizations_environments_get_security_actions_config: + organizations_developers_set_developer_status: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActionsConfig/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_update_security_actions_config: + organizations_developers_attributes: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActionsConfig/patch + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1attributes/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/environments_security_actions_config/methods/organizations_environments_get_security_actions_config - insert: [] - update: + #/components/x-stackQL-resources/developers/methods/organizations_developers_get - $ref: >- - #/components/x-stackQL-resources/environments_security_actions_config/methods/organizations_environments_update_security_actions_config - replace: [] - delete: [] - environments_deployed_config: - id: google.apigee.environments_deployed_config - name: environments_deployed_config - title: Environments_deployed_config + #/components/x-stackQL-resources/developers/methods/organizations_developers_list + insert: + - $ref: >- + #/components/x-stackQL-resources/developers/methods/organizations_developers_create + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/developers/methods/organizations_developers_update + delete: + - $ref: >- + #/components/x-stackQL-resources/developers/methods/organizations_developers_delete + developers_monetization_config: + id: google.apigee.developers_monetization_config + name: developers_monetization_config + title: Developers_monetization_config methods: - organizations_environments_get_deployed_config: + organizations_developers_get_monetization_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1deployedConfig/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1monetizationConfig/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/environments_deployed_config/methods/organizations_environments_get_deployed_config - insert: [] - update: [] - replace: [] - delete: [] - environments_addons_config: - id: google.apigee.environments_addons_config - name: environments_addons_config - title: Environments_addons_config - methods: - organizations_environments_get_addons_config: + organizations_developers_update_monetization_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1addonsConfig/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1monetizationConfig/put response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/environments_addons_config/methods/organizations_environments_get_addons_config + #/components/x-stackQL-resources/developers_monetization_config/methods/organizations_developers_get_monetization_config insert: [] update: [] - replace: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/developers_monetization_config/methods/organizations_developers_update_monetization_config delete: [] - environments_api_security_runtime_config: - id: google.apigee.environments_api_security_runtime_config - name: environments_api_security_runtime_config - title: Environments_api_security_runtime_config + developers_balance: + id: google.apigee.developers_balance + name: developers_balance + title: Developers_balance methods: - organizations_environments_get_api_security_runtime_config: + organizations_developers_get_balance: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apiSecurityRuntimeConfig/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1balance/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/environments_api_security_runtime_config/methods/organizations_environments_get_api_security_runtime_config + #/components/x-stackQL-resources/developers_balance/methods/organizations_developers_get_balance insert: [] update: [] replace: [] delete: [] - attachments: - id: google.apigee.attachments - name: attachments - title: Attachments + keys: + id: google.apigee.keys + name: keys + title: Keys methods: - organizations_instances_attachments_delete: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1attachments~1{attachmentsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_instances_attachments_get: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1attachments~1{attachmentsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_instances_attachments_create: + organizations_developers_apps_keys_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1attachments/post + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys/post response: mediaType: application/json openAPIDocKey: '200' - organizations_instances_attachments_list: + organizations_developers_apps_keys_update_developer_app_key: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1attachments/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1{keysId}/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.attachments - organizations_envgroups_attachments_delete: + organizations_developers_apps_keys_replace_developer_app_key: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}~1attachments~1{attachmentsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1{keysId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_envgroups_attachments_get: + organizations_developers_apps_keys_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}~1attachments~1{attachmentsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1{keysId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_envgroups_attachments_create: + organizations_developers_apps_keys_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}~1attachments/post + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1{keysId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_envgroups_attachments_list: + organizations_developers_apps_keys_create_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}~1attachments/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1create/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.environmentGroupAttachments - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/attachments/methods/organizations_instances_attachments_get - - $ref: >- - #/components/x-stackQL-resources/attachments/methods/organizations_envgroups_attachments_get - - $ref: >- - #/components/x-stackQL-resources/attachments/methods/organizations_instances_attachments_list - - $ref: >- - #/components/x-stackQL-resources/attachments/methods/organizations_envgroups_attachments_list - insert: - - $ref: >- - #/components/x-stackQL-resources/attachments/methods/organizations_instances_attachments_create - - $ref: >- - #/components/x-stackQL-resources/attachments/methods/organizations_envgroups_attachments_create - update: [] - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/attachments/methods/organizations_instances_attachments_delete - - $ref: >- - #/components/x-stackQL-resources/attachments/methods/organizations_envgroups_attachments_delete - nat_addresses: - id: google.apigee.nat_addresses - name: nat_addresses - title: Nat_addresses - methods: - organizations_instances_nat_addresses_list: + organizations_developers_apps_keys_apiproducts_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1natAddresses/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1{keysId}~1apiproducts~1{apiproductsId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.natAddresses - organizations_instances_nat_addresses_create: + organizations_developers_apps_keys_apiproducts_update_developer_app_key_api_product: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1natAddresses/post + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1{keysId}~1apiproducts~1{apiproductsId}/post response: mediaType: application/json openAPIDocKey: '200' - organizations_instances_nat_addresses_delete: + organizations_appgroups_apps_keys_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1natAddresses~1{natAddressesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys/post response: mediaType: application/json openAPIDocKey: '200' - organizations_instances_nat_addresses_get: + organizations_appgroups_apps_keys_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1natAddresses~1{natAddressesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys~1{keysId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_instances_nat_addresses_activate: + organizations_appgroups_apps_keys_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1natAddresses~1{natAddressesId}:activate/post + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys~1{keysId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_appgroups_apps_keys_update_app_group_app_key: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys~1{keysId}/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/nat_addresses/methods/organizations_instances_nat_addresses_get + #/components/x-stackQL-resources/keys/methods/organizations_developers_apps_keys_get - $ref: >- - #/components/x-stackQL-resources/nat_addresses/methods/organizations_instances_nat_addresses_list + #/components/x-stackQL-resources/keys/methods/organizations_appgroups_apps_keys_get insert: - $ref: >- - #/components/x-stackQL-resources/nat_addresses/methods/organizations_instances_nat_addresses_create + #/components/x-stackQL-resources/keys/methods/organizations_developers_apps_keys_create + - $ref: >- + #/components/x-stackQL-resources/keys/methods/organizations_appgroups_apps_keys_create update: [] - replace: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/keys/methods/organizations_developers_apps_keys_replace_developer_app_key delete: - $ref: >- - #/components/x-stackQL-resources/nat_addresses/methods/organizations_instances_nat_addresses_delete - canaryevaluations: - id: google.apigee.canaryevaluations - name: canaryevaluations - title: Canaryevaluations + #/components/x-stackQL-resources/keys/methods/organizations_developers_apps_keys_apiproducts_delete + - $ref: >- + #/components/x-stackQL-resources/keys/methods/organizations_developers_apps_keys_delete + - $ref: >- + #/components/x-stackQL-resources/keys/methods/organizations_appgroups_apps_keys_delete + balance: + id: google.apigee.balance + name: balance + title: Balance methods: - organizations_instances_canaryevaluations_get: + organizations_developers_balance_credit: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1canaryevaluations~1{canaryevaluationsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1balance:credit/post response: mediaType: application/json openAPIDocKey: '200' - organizations_instances_canaryevaluations_create: + organizations_developers_balance_adjust: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1canaryevaluations/post + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1balance:adjust/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/canaryevaluations/methods/organizations_instances_canaryevaluations_get - insert: - - $ref: >- - #/components/x-stackQL-resources/canaryevaluations/methods/organizations_instances_canaryevaluations_create + select: [] + insert: [] update: [] replace: [] delete: [] - instances: - id: google.apigee.instances - name: instances - title: Instances + subscriptions: + id: google.apigee.subscriptions + name: subscriptions + title: Subscriptions methods: - organizations_instances_list: - operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1instances/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.instances - organizations_instances_create: - operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1instances/post' - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_instances_report_status: + organizations_developers_subscriptions_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}:reportStatus/post + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1subscriptions/post response: mediaType: application/json openAPIDocKey: '200' - organizations_instances_patch: + organizations_developers_subscriptions_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}/patch + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1subscriptions/get response: mediaType: application/json openAPIDocKey: '200' - organizations_instances_get: + organizations_developers_subscriptions_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1subscriptions~1{subscriptionsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_instances_delete: + organizations_developers_subscriptions_expire: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1subscriptions~1{subscriptionsId}:expire/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/instances/methods/organizations_instances_get + #/components/x-stackQL-resources/subscriptions/methods/organizations_developers_subscriptions_get - $ref: >- - #/components/x-stackQL-resources/instances/methods/organizations_instances_list + #/components/x-stackQL-resources/subscriptions/methods/organizations_developers_subscriptions_list insert: - $ref: >- - #/components/x-stackQL-resources/instances/methods/organizations_instances_create - update: - - $ref: >- - #/components/x-stackQL-resources/instances/methods/organizations_instances_patch + #/components/x-stackQL-resources/subscriptions/methods/organizations_developers_subscriptions_create + update: [] replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/instances/methods/organizations_instances_delete - envgroups: - id: google.apigee.envgroups - name: envgroups - title: Envgroups + delete: [] + appgroups: + id: google.apigee.appgroups + name: appgroups + title: Appgroups methods: - organizations_envgroups_get: + organizations_appgroups_create: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}/get + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1appgroups/post' response: mediaType: application/json openAPIDocKey: '200' - organizations_envgroups_delete: + organizations_appgroups_list: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}/delete + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1appgroups/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_envgroups_patch: + objectKey: $.appGroups + organizations_appgroups_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}/patch + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_envgroups_create: + organizations_appgroups_delete: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1envgroups/post' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_envgroups_list: + organizations_appgroups_update: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1envgroups/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}/put response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.environmentGroups sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/envgroups/methods/organizations_envgroups_get + #/components/x-stackQL-resources/appgroups/methods/organizations_appgroups_get - $ref: >- - #/components/x-stackQL-resources/envgroups/methods/organizations_envgroups_list + #/components/x-stackQL-resources/appgroups/methods/organizations_appgroups_list insert: - $ref: >- - #/components/x-stackQL-resources/envgroups/methods/organizations_envgroups_create - update: + #/components/x-stackQL-resources/appgroups/methods/organizations_appgroups_create + update: [] + replace: - $ref: >- - #/components/x-stackQL-resources/envgroups/methods/organizations_envgroups_patch - replace: [] + #/components/x-stackQL-resources/appgroups/methods/organizations_appgroups_update delete: - $ref: >- - #/components/x-stackQL-resources/envgroups/methods/organizations_envgroups_delete - envgroups_deployed_ingress_config: - id: google.apigee.envgroups_deployed_ingress_config - name: envgroups_deployed_ingress_config - title: Envgroups_deployed_ingress_config + #/components/x-stackQL-resources/appgroups/methods/organizations_appgroups_delete + host_security_reports: + id: google.apigee.host_security_reports + name: host_security_reports + title: Host_security_reports methods: - organizations_envgroups_get_deployed_ingress_config: + organizations_host_security_reports_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}~1deployedIngressConfig/get + #/paths/~1v1~1organizations~1{organizationsId}~1hostSecurityReports/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/envgroups_deployed_ingress_config/methods/organizations_envgroups_get_deployed_ingress_config - insert: [] - update: [] - replace: [] - delete: [] - endpoint_attachments: - id: google.apigee.endpoint_attachments - name: endpoint_attachments - title: Endpoint_attachments - methods: - organizations_endpoint_attachments_get: + organizations_host_security_reports_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1endpointAttachments~1{endpointAttachmentsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1hostSecurityReports/get response: mediaType: application/json openAPIDocKey: '200' - organizations_endpoint_attachments_delete: + objectKey: $.securityReports + organizations_host_security_reports_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1endpointAttachments~1{endpointAttachmentsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1hostSecurityReports~1{hostSecurityReportsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_endpoint_attachments_list: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/host_security_reports/methods/organizations_host_security_reports_get + - $ref: >- + #/components/x-stackQL-resources/host_security_reports/methods/organizations_host_security_reports_list + insert: + - $ref: >- + #/components/x-stackQL-resources/host_security_reports/methods/organizations_host_security_reports_create + update: [] + replace: [] + delete: [] + host_security_reports_result: + id: google.apigee.host_security_reports_result + name: host_security_reports_result + title: Host_security_reports_result + methods: + organizations_host_security_reports_get_result: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1endpointAttachments/get + #/paths/~1v1~1organizations~1{organizationsId}~1hostSecurityReports~1{hostSecurityReportsId}~1result/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.endpointAttachments - organizations_endpoint_attachments_create: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/host_security_reports_result/methods/organizations_host_security_reports_get_result + insert: [] + update: [] + replace: [] + delete: [] + host_security_reports_result_view: + id: google.apigee.host_security_reports_result_view + name: host_security_reports_result_view + title: Host_security_reports_result_view + methods: + organizations_host_security_reports_get_result_view: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1endpointAttachments/post + #/paths/~1v1~1organizations~1{organizationsId}~1hostSecurityReports~1{hostSecurityReportsId}~1resultView/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/endpoint_attachments/methods/organizations_endpoint_attachments_get - - $ref: >- - #/components/x-stackQL-resources/endpoint_attachments/methods/organizations_endpoint_attachments_list - insert: - - $ref: >- - #/components/x-stackQL-resources/endpoint_attachments/methods/organizations_endpoint_attachments_create + #/components/x-stackQL-resources/host_security_reports_result_view/methods/organizations_host_security_reports_get_result_view + insert: [] update: [] replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/endpoint_attachments/methods/organizations_endpoint_attachments_delete + delete: [] security_profiles: id: google.apigee.security_profiles name: security_profiles title: Security_profiles methods: - organizations_security_profiles_patch: + organizations_security_profiles_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}/patch + #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles/post response: mediaType: application/json openAPIDocKey: '200' - organizations_security_profiles_get: + organizations_security_profiles_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles/get response: mediaType: application/json openAPIDocKey: '200' - organizations_security_profiles_delete: + objectKey: $.securityProfiles + organizations_security_profiles_patch: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_security_profiles_list: + organizations_security_profiles_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles/get + #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.securityProfiles - organizations_security_profiles_create: + organizations_security_profiles_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles/post + #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}/get response: mediaType: application/json openAPIDocKey: '200' @@ -12618,280 +13009,833 @@ components: delete: - $ref: >- #/components/x-stackQL-resources/security_profiles_v2/methods/organizations_security_profiles_v2_delete - datastores: - id: google.apigee.datastores - name: datastores - title: Datastores + security_monitoring_conditions: + id: google.apigee.security_monitoring_conditions + name: security_monitoring_conditions + title: Security_monitoring_conditions methods: - organizations_analytics_datastores_get: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores~1{datastoresId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_analytics_datastores_delete: + organizations_security_monitoring_conditions_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores~1{datastoresId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1securityMonitoringConditions/post response: mediaType: application/json openAPIDocKey: '200' - organizations_analytics_datastores_update: + organizations_security_monitoring_conditions_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores~1{datastoresId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1securityMonitoringConditions/get response: mediaType: application/json openAPIDocKey: '200' - organizations_analytics_datastores_test: + objectKey: $.securityMonitoringConditions + organizations_security_monitoring_conditions_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores:test/post + #/paths/~1v1~1organizations~1{organizationsId}~1securityMonitoringConditions~1{securityMonitoringConditionsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_analytics_datastores_list: + organizations_security_monitoring_conditions_patch: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores/get + #/paths/~1v1~1organizations~1{organizationsId}~1securityMonitoringConditions~1{securityMonitoringConditionsId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_analytics_datastores_create: + organizations_security_monitoring_conditions_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores/post + #/paths/~1v1~1organizations~1{organizationsId}~1securityMonitoringConditions~1{securityMonitoringConditionsId}/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/datastores/methods/organizations_analytics_datastores_get + #/components/x-stackQL-resources/security_monitoring_conditions/methods/organizations_security_monitoring_conditions_get - $ref: >- - #/components/x-stackQL-resources/datastores/methods/organizations_analytics_datastores_list + #/components/x-stackQL-resources/security_monitoring_conditions/methods/organizations_security_monitoring_conditions_list insert: - $ref: >- - #/components/x-stackQL-resources/datastores/methods/organizations_analytics_datastores_create - update: [] - replace: + #/components/x-stackQL-resources/security_monitoring_conditions/methods/organizations_security_monitoring_conditions_create + update: - $ref: >- - #/components/x-stackQL-resources/datastores/methods/organizations_analytics_datastores_update + #/components/x-stackQL-resources/security_monitoring_conditions/methods/organizations_security_monitoring_conditions_patch + replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/datastores/methods/organizations_analytics_datastores_delete - apis: - id: google.apigee.apis - name: apis - title: Apis + #/components/x-stackQL-resources/security_monitoring_conditions/methods/organizations_security_monitoring_conditions_delete + apicategories: + id: google.apigee.apicategories + name: apicategories + title: Apicategories methods: - organizations_apis_delete: + organizations_sites_apicategories_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apicategories/post response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_get: + organizations_sites_apicategories_list: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apicategories/get response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_patch: + organizations_sites_apicategories_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}/patch + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apicategories~1{apicategoriesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_list: + organizations_sites_apicategories_patch: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apis/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apicategories~1{apicategoriesId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_create: + organizations_sites_apicategories_get: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apis/post' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apicategories~1{apicategoriesId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/apis/methods/organizations_apis_get + #/components/x-stackQL-resources/apicategories/methods/organizations_sites_apicategories_get - $ref: >- - #/components/x-stackQL-resources/apis/methods/organizations_apis_list + #/components/x-stackQL-resources/apicategories/methods/organizations_sites_apicategories_list insert: - $ref: >- - #/components/x-stackQL-resources/apis/methods/organizations_apis_create + #/components/x-stackQL-resources/apicategories/methods/organizations_sites_apicategories_create update: - $ref: >- - #/components/x-stackQL-resources/apis/methods/organizations_apis_patch + #/components/x-stackQL-resources/apicategories/methods/organizations_sites_apicategories_patch replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/apis/methods/organizations_apis_delete - revisions_api_proxy_revision: - id: google.apigee.revisions_api_proxy_revision - name: revisions_api_proxy_revision - title: Revisions_api_proxy_revision + #/components/x-stackQL-resources/apicategories/methods/organizations_sites_apicategories_delete + apidocs: + id: google.apigee.apidocs + name: apidocs + title: Apidocs methods: - organizations_apis_revisions_update_api_proxy_revision: + organizations_sites_apidocs_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1revisions~1{revisionsId}/post + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs~1{apidocsId}/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: - - $ref: >- - #/components/x-stackQL-resources/revisions_api_proxy_revision/methods/organizations_apis_revisions_update_api_proxy_revision - replace: [] - delete: [] - security_assessment_results: - id: google.apigee.security_assessment_results - name: security_assessment_results - title: Security_assessment_results - methods: - organizations_security_assessment_results_batch_compute: + organizations_sites_apidocs_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securityAssessmentResults:batchCompute/post + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs~1{apidocsId}/put response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: [] - host_queries: - id: google.apigee.host_queries - name: host_queries - title: Host_queries - methods: - organizations_host_queries_create: + organizations_sites_apidocs_delete: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1hostQueries/post' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs~1{apidocsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_host_queries_list: + organizations_sites_apidocs_create: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1hostQueries/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs/post response: mediaType: application/json openAPIDocKey: '200' - organizations_host_queries_get: + organizations_sites_apidocs_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1hostQueries~1{hostQueriesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.data sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/host_queries/methods/organizations_host_queries_get + #/components/x-stackQL-resources/apidocs/methods/organizations_sites_apidocs_get - $ref: >- - #/components/x-stackQL-resources/host_queries/methods/organizations_host_queries_list + #/components/x-stackQL-resources/apidocs/methods/organizations_sites_apidocs_list insert: - $ref: >- - #/components/x-stackQL-resources/host_queries/methods/organizations_host_queries_create + #/components/x-stackQL-resources/apidocs/methods/organizations_sites_apidocs_create update: [] - replace: [] - delete: [] - host_queries_result_view: - id: google.apigee.host_queries_result_view - name: host_queries_result_view - title: Host_queries_result_view + replace: + - $ref: >- + #/components/x-stackQL-resources/apidocs/methods/organizations_sites_apidocs_update + delete: + - $ref: >- + #/components/x-stackQL-resources/apidocs/methods/organizations_sites_apidocs_delete + apidocs_documentation: + id: google.apigee.apidocs_documentation + name: apidocs_documentation + title: Apidocs_documentation methods: - organizations_host_queries_get_result_view: + organizations_sites_apidocs_update_documentation: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1hostQueries~1{hostQueriesId}~1resultView/get + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs~1{apidocsId}~1documentation/patch + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_sites_apidocs_get_documentation: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs~1{apidocsId}~1documentation/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/host_queries_result_view/methods/organizations_host_queries_get_result_view + #/components/x-stackQL-resources/apidocs_documentation/methods/organizations_sites_apidocs_get_documentation insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/apidocs_documentation/methods/organizations_sites_apidocs_update_documentation replace: [] delete: [] - host_queries_result: - id: google.apigee.host_queries_result - name: host_queries_result - title: Host_queries_result + endpoint_attachments: + id: google.apigee.endpoint_attachments + name: endpoint_attachments + title: Endpoint_attachments methods: - organizations_host_queries_get_result: + organizations_endpoint_attachments_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1hostQueries~1{hostQueriesId}~1result/get + #/paths/~1v1~1organizations~1{organizationsId}~1endpointAttachments/post + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_endpoint_attachments_list: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1endpointAttachments/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.endpointAttachments + organizations_endpoint_attachments_get: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1endpointAttachments~1{endpointAttachmentsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_endpoint_attachments_delete: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1endpointAttachments~1{endpointAttachmentsId}/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/host_queries_result/methods/organizations_host_queries_get_result - insert: [] + #/components/x-stackQL-resources/endpoint_attachments/methods/organizations_endpoint_attachments_get + - $ref: >- + #/components/x-stackQL-resources/endpoint_attachments/methods/organizations_endpoint_attachments_list + insert: + - $ref: >- + #/components/x-stackQL-resources/endpoint_attachments/methods/organizations_endpoint_attachments_create update: [] replace: [] - delete: [] - issuers: - id: google.apigee.issuers - name: issuers - title: Issuers + delete: + - $ref: >- + #/components/x-stackQL-resources/endpoint_attachments/methods/organizations_endpoint_attachments_delete + dns_zones: + id: google.apigee.dns_zones + name: dns_zones + title: Dns_zones methods: - hybrid_issuers_list: + organizations_dns_zones_create: operation: - $ref: '#/paths/~1v1~1hybrid~1issuers/get' + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1dnsZones/post' + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_dns_zones_list: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1dnsZones/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.dnsZones + organizations_dns_zones_get: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1dnsZones~1{dnsZonesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_dns_zones_delete: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1dnsZones~1{dnsZonesId}/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/issuers/methods/hybrid_issuers_list - insert: [] + #/components/x-stackQL-resources/dns_zones/methods/organizations_dns_zones_get + - $ref: >- + #/components/x-stackQL-resources/dns_zones/methods/organizations_dns_zones_list + insert: + - $ref: >- + #/components/x-stackQL-resources/dns_zones/methods/organizations_dns_zones_create update: [] replace: [] - delete: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/dns_zones/methods/organizations_dns_zones_delete paths: - /v1/projects/{projectsId}:provisionOrganization: + /v1/hybrid/issuers: parameters: &ref_1 - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/upload_protocol' + get: + description: >- + Lists hybrid services and its trusted issuers service account ids. This + api is authenticated and unauthorized(allow all the users) and used by + runtime authn-authz service to query control plane's issuer service + account ids. + operationId: apigee.hybrid.issuers.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListHybridIssuersResponse + parameters: [] + /v1/organizations: + parameters: *ref_1 + get: + description: >- + Lists the Apigee organizations and associated Google Cloud projects that + you have permission to access. See [Understanding + organizations](https://cloud.google.com/apigee/docs/api-platform/fundamentals/organization-structure). + operationId: apigee.organizations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListOrganizationsResponse + parameters: [] + post: + description: >- + Creates an Apigee organization. See [Create an Apigee + organization](https://cloud.google.com/apigee/docs/api-platform/get-started/create-org). + operationId: apigee.organizations.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Organization' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: query + name: parent + schema: + type: string + /v1/organizations/{organizationsId}: + parameters: *ref_1 + get: + description: >- + Gets the profile for an Apigee organization. See [Understanding + organizations](https://cloud.google.com/apigee/docs/api-platform/fundamentals/organization-structure). + operationId: apigee.organizations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Organization' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + put: + description: >- + Updates the properties for an Apigee organization. No other fields in + the organization profile will be updated. + operationId: apigee.organizations.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Organization' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Organization' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + delete: + description: >- + Delete an Apigee organization. For organizations with BillingType + EVALUATION, an immediate deletion is performed. For paid organizations + (Subscription or Pay-as-you-go), a soft-deletion is performed. The + organization can be restored within the soft-deletion period, which is + specified using the `retention` field in the request or by filing a + support ticket with Apigee. During the data retention period specified + in the request, the Apigee organization cannot be recreated in the same + Google Cloud project. **IMPORTANT: The default data retention setting + for this operation is 7 days. To permanently delete the organization in + 24 hours, set the retention parameter to `MINIMUM`.** + operationId: apigee.organizations.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: query + name: retention + schema: + type: string + /v1/organizations/{organizationsId}:getSyncAuthorization: + parameters: *ref_1 + post: + description: >- + Lists the service accounts with the permissions required to allow the + Synchronizer to download environment data from the control plane. An + ETag is returned in the response to `getSyncAuthorization`. Pass that + ETag when calling [setSyncAuthorization](setSyncAuthorization) to ensure + that you are updating the correct version. If you don't pass the ETag in + the call to `setSyncAuthorization`, then the existing authorization is + overwritten indiscriminately. For more information, see [Configure the + Synchronizer](https://cloud.google.com/apigee/docs/hybrid/latest/synchronizer-access). + **Note**: Available to Apigee hybrid only. + operationId: apigee.organizations.getSyncAuthorization + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1GetSyncAuthorizationRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1SyncAuthorization' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}:setSyncAuthorization: + parameters: *ref_1 + post: + description: >- + Sets the permissions required to allow the Synchronizer to download + environment data from the control plane. You must call this API to + enable proper functioning of hybrid. Pass the ETag when calling + `setSyncAuthorization` to ensure that you are updating the correct + version. To get an ETag, call + [getSyncAuthorization](getSyncAuthorization). If you don't pass the ETag + in the call to `setSyncAuthorization`, then the existing authorization + is overwritten indiscriminately. For more information, see [Configure + the + Synchronizer](https://cloud.google.com/apigee/docs/hybrid/latest/synchronizer-access). + **Note**: Available to Apigee hybrid only. + operationId: apigee.organizations.setSyncAuthorization + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1SyncAuthorization' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1SyncAuthorization' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/controlPlaneAccess: + parameters: *ref_1 + get: + description: >- + Lists the service accounts allowed to access Apigee control plane + directly for limited functionality. **Note**: Available to Apigee hybrid + only. + operationId: apigee.organizations.getControlPlaneAccess + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1ControlPlaneAccess' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + patch: + description: >- + Updates the permissions required to allow Apigee runtime-plane + components access to the control plane. Currently, the permissions + required are to: 1. Allow runtime components to publish analytics data + to the control plane. **Note**: Available to Apigee hybrid only. + operationId: apigee.organizations.updateControlPlaneAccess + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1ControlPlaneAccess' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/organizations/{organizationsId}:setAddons: + parameters: *ref_1 post: description: >- - Provisions a new Apigee organization with a functioning runtime. This is - the standard way to create trial organizations for a free Apigee trial. - operationId: apigee.projects.provisionOrganization + Configures the add-ons for the Apigee organization. The existing add-on + configuration will be fully replaced. + operationId: apigee.organizations.setAddons + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1SetAddonsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}:getProjectMapping: + parameters: *ref_1 + get: + description: Gets the project ID and region for an Apigee organization. + operationId: apigee.organizations.getProjectMapping + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1OrganizationProjectMapping + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/deployedIngressConfig: + parameters: *ref_1 + get: + description: Gets the deployed ingress configuration for an organization. + operationId: apigee.organizations.getDeployedIngressConfig + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1IngressConfig' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: query + name: view + schema: + type: string + /v1/organizations/{organizationsId}/runtimeConfig: + parameters: *ref_1 + get: + description: Get runtime config for an organization. + operationId: apigee.organizations.getRuntimeConfig + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeConfig' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/securitySettings: + parameters: *ref_1 + get: + description: GetSecuritySettings gets the security settings for API Security. + operationId: apigee.organizations.getSecuritySettings + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecuritySettings' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + patch: + description: >- + UpdateSecuritySettings updates the current security settings for API + Security. + operationId: apigee.organizations.updateSecuritySettings + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecuritySettings' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecuritySettings' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/organizations/{organizationsId}/apis: + parameters: *ref_1 + get: + description: >- + Lists the names of all API proxies in an organization. The names + returned correspond to the names defined in the configuration files for + each API proxy. If the resource has the `space` attribute set, the + response may not return all resources. To learn more, read the [Apigee + Spaces + Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview). + operationId: apigee.organizations.apis.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1ListApiProxiesResponse' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: query + name: includeRevisions + schema: + type: boolean + - in: query + name: includeMetaData + schema: + type: boolean + - in: query + name: space + schema: + type: string + post: + description: >- + Creates an API proxy. The API proxy created will not be accessible at + runtime until it is deployed to an environment. Create a new API proxy + by setting the `name` query parameter to the name of the API proxy. + Import an API proxy configuration bundle stored in zip format on your + local machine to your organization by doing the following: * Set the + `name` query parameter to the name of the API proxy. * Set the `action` + query parameter to `import`. * Set the `Content-Type` header to + `multipart/form-data`. * Pass as a file the name of API proxy + configuration bundle stored in zip format on your local machine using + the `file` form field. **Note**: To validate the API proxy configuration + bundle only without importing it, set the `action` query parameter to + `validate`. When importing an API proxy configuration bundle, if the API + proxy does not exist, it will be created. If the API proxy exists, then + a new revision is created. Invalid API proxy configurations are + rejected, and a list of validation errors is returned to the client. + operationId: apigee.organizations.apis.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ProvisionOrganizationRequest + $ref: '#/components/schemas/GoogleApiHttpBody' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12903,18 +13847,39 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxyRevision' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}/deployedIngressConfig: + - in: query + name: name + schema: + type: string + - in: query + name: action + schema: + type: string + - in: query + name: validate + schema: + type: boolean + - in: query + name: space + schema: + type: string + /v1/organizations/{organizationsId}/apis/{apisId}: parameters: *ref_1 - get: - description: Gets the deployed ingress configuration for an organization. - operationId: apigee.organizations.getDeployedIngressConfig + patch: + description: Updates an existing API proxy. + operationId: apigee.organizations.apis.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12926,32 +13891,55 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1IngressConfig' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' parameters: - in: path name: organizationsId required: true schema: type: string + - in: path + name: apisId + required: true + schema: + type: string - in: query - name: view + name: updateMask + schema: + type: string + format: google-fieldmask + get: + description: Gets an API proxy including a list of existing revisions. + operationId: apigee.organizations.apis.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: apisId + required: true schema: type: string - /v1/organizations/{organizationsId}: - parameters: *ref_1 delete: description: >- - Delete an Apigee organization. For organizations with BillingType - EVALUATION, an immediate deletion is performed. For paid organizations - (Subscription or Pay-as-you-go), a soft-deletion is performed. The - organization can be restored within the soft-deletion period, which is - specified using the `retention` field in the request or by filing a - support ticket with Apigee. During the data retention period specified - in the request, the Apigee organization cannot be recreated in the same - Google Cloud project. **IMPORTANT: The default data retention setting - for this operation is 7 days. To permanently delete the organization in - 24 hours, set the retention parameter to `MINIMUM`.** - operationId: apigee.organizations.delete + Deletes an API proxy and all associated endpoints, policies, resources, + and revisions. The API proxy must be undeployed before you can delete + it. + operationId: apigee.organizations.apis.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12963,22 +13951,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: retention + - in: path + name: apisId + required: true schema: type: string - get: - description: >- - Gets the profile for an Apigee organization. See [Understanding - organizations](https://cloud.google.com/apigee/docs/api-platform/fundamentals/organization-structure). - operationId: apigee.organizations.get + /v1/organizations/{organizationsId}/apis/{apisId}:move: + parameters: *ref_1 + post: + description: Moves an API proxy to a different space. + operationId: apigee.organizations.apis.move + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1MoveApiProxyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12990,23 +13984,34 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Organization' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' parameters: - in: path name: organizationsId required: true schema: type: string - put: + - in: path + name: apisId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/apis/{apisId}/revisions/{revisionsId}: + parameters: *ref_1 + post: description: >- - Updates the properties for an Apigee organization. No other fields in - the organization profile will be updated. - operationId: apigee.organizations.update + Updates an existing API proxy revision by uploading the API proxy + configuration bundle as a zip file from your local machine. You can + update only API proxy revisions that have never been deployed. After + deployment, an API proxy revision becomes immutable, even if it is + undeployed. Set the `Content-Type` header to either + `multipart/form-data` or `application/octet-stream`. + operationId: apigee.organizations.apis.revisions.updateApiProxyRevision requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Organization' + $ref: '#/components/schemas/GoogleApiHttpBody' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13018,18 +14023,142 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Organization' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxyRevision' parameters: - in: path name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}/runtimeConfig: + - in: path + name: apisId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string + - in: query + name: validate + schema: + type: boolean + get: + description: >- + Gets an API proxy revision. To download the API proxy configuration + bundle for the specified revision as a zip file, set the `format` query + parameter to `bundle`. If you are using curl, specify `-o filename.zip` + to save the output to a file; otherwise, it displays to `stdout`. Then, + develop the API proxy configuration locally and upload the updated API + proxy configuration revision, as described in + [updateApiProxyRevision](updateApiProxyRevision). + operationId: apigee.organizations.apis.revisions.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleApiHttpBody' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: apisId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string + - in: query + name: format + schema: + type: string + delete: + description: >- + Deletes an API proxy revision and all policies, resources, endpoints, + and revisions associated with it. The API proxy revision must be + undeployed before you can delete it. + operationId: apigee.organizations.apis.revisions.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxyRevision' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: apisId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/apis/{apisId}/revisions/{revisionsId}/deployments: + parameters: *ref_1 + get: + description: Lists all deployments of an API proxy revision. + operationId: apigee.organizations.apis.revisions.deployments.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: apisId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/apis/{apisId}/deployments: parameters: *ref_1 get: - description: Get runtime config for an organization. - operationId: apigee.organizations.getRuntimeConfig + description: Lists all deployments of an API proxy. + operationId: apigee.organizations.apis.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13041,25 +14170,29 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeConfig' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse parameters: - in: path name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}/securitySettings: + - in: path + name: apisId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps: parameters: *ref_1 - patch: - description: >- - UpdateSecuritySettings updates the current security settings for API - Security. - operationId: apigee.organizations.updateSecuritySettings + post: + description: Creates a key value map in an API proxy. + operationId: apigee.organizations.apis.keyvaluemaps.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecuritySettings' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13071,21 +14204,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecuritySettings' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: apisId + required: true schema: type: string - format: google-fieldmask - get: - description: GetSecuritySettings gets the security settings for API Security. - operationId: apigee.organizations.getSecuritySettings + /v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps/{keyvaluemapsId}: + parameters: *ref_1 + delete: + description: Deletes a key value map from an API proxy. + operationId: apigee.organizations.apis.keyvaluemaps.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13097,27 +14232,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecuritySettings' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' parameters: - in: path name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}/controlPlaneAccess: + - in: path + name: apisId + required: true + schema: + type: string + - in: path + name: keyvaluemapsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps/{keyvaluemapsId}/entries/{entriesId}: parameters: *ref_1 - patch: + get: description: >- - Updates the permissions required to allow Apigee runtime-plane - components access to the control plane. Currently, the permissions - required are to: 1. Allow runtime components to publish analytics data - to the control plane. **Note**: Available to Apigee hybrid only. - operationId: apigee.organizations.updateControlPlaneAccess - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ControlPlaneAccess' + Get the key value entry value for a key value map scoped to an + organization, environment, or API proxy. **Note**: Supported for Apigee + hybrid 1.8.x and higher. + operationId: apigee.organizations.apis.keyvaluemaps.entries.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13129,24 +14268,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: apisId + required: true schema: type: string - format: google-fieldmask - get: + - in: path + name: keyvaluemapsId + required: true + schema: + type: string + - in: path + name: entriesId + required: true + schema: + type: string + delete: description: >- - Lists the service accounts allowed to access Apigee control plane - directly for limited functionality. **Note**: Available to Apigee hybrid - only. - operationId: apigee.organizations.getControlPlaneAccess + Deletes a key value entry from a key value map scoped to an + organization, environment, or API proxy. **Notes:** * After you delete + the key value entry, the policy consuming the entry will continue to + function with its cached values for a few minutes. This is expected + behavior. * Supported for Apigee hybrid 1.8.x and higher. + operationId: apigee.organizations.apis.keyvaluemaps.entries.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13158,25 +14309,38 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ControlPlaneAccess' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId required: true schema: type: string - /v1/organizations: - parameters: *ref_1 - post: + - in: path + name: apisId + required: true + schema: + type: string + - in: path + name: keyvaluemapsId + required: true + schema: + type: string + - in: path + name: entriesId + required: true + schema: + type: string + put: description: >- - Creates an Apigee organization. See [Create an Apigee - organization](https://cloud.google.com/apigee/docs/api-platform/get-started/create-org). - operationId: apigee.organizations.create + Update key value entry scoped to an organization, environment, or API + proxy for an existing key. + operationId: apigee.organizations.apis.keyvaluemaps.entries.update requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Organization' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13188,44 +14352,41 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - - in: query - name: parent + - in: path + name: organizationsId + required: true schema: type: string - get: - description: >- - Lists the Apigee organizations and associated Google Cloud projects that - you have permission to access. See [Understanding - organizations](https://cloud.google.com/apigee/docs/api-platform/fundamentals/organization-structure). - operationId: apigee.organizations.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListOrganizationsResponse - parameters: [] - /v1/organizations/{organizationsId}:setAddons: + - in: path + name: apisId + required: true + schema: + type: string + - in: path + name: keyvaluemapsId + required: true + schema: + type: string + - in: path + name: entriesId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps/{keyvaluemapsId}/entries: parameters: *ref_1 post: description: >- - Configures the add-ons for the Apigee organization. The existing add-on - configuration will be fully replaced. - operationId: apigee.organizations.setAddons + Creates key value entries in a key value map scoped to an organization, + environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x + and higher. + operationId: apigee.organizations.apis.keyvaluemaps.entries.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SetAddonsRequest' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13237,18 +14398,29 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}:getProjectMapping: - parameters: *ref_1 + - in: path + name: apisId + required: true + schema: + type: string + - in: path + name: keyvaluemapsId + required: true + schema: + type: string get: - description: Gets the project ID and region for an Apigee organization. - operationId: apigee.organizations.getProjectMapping + description: >- + Lists key value entries for key values maps scoped to an organization, + environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x + and higher. + operationId: apigee.organizations.apis.keyvaluemaps.entries.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13261,72 +14433,37 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1OrganizationProjectMapping + #/components/schemas/GoogleCloudApigeeV1ListKeyValueEntriesResponse parameters: - in: path name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}:getSyncAuthorization: - parameters: *ref_1 - post: - description: >- - Lists the service accounts with the permissions required to allow the - Synchronizer to download environment data from the control plane. An - ETag is returned in the response to `getSyncAuthorization`. Pass that - ETag when calling [setSyncAuthorization](setSyncAuthorization) to ensure - that you are updating the correct version. If you don't pass the ETag in - the call to `setSyncAuthorization`, then the existing authorization is - overwritten indiscriminately. For more information, see [Configure the - Synchronizer](https://cloud.google.com/apigee/docs/hybrid/latest/synchronizer-access). - **Note**: Available to Apigee hybrid only. - operationId: apigee.organizations.getSyncAuthorization - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1GetSyncAuthorizationRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SyncAuthorization' - parameters: - in: path - name: organizationsId + name: apisId required: true schema: type: string - /v1/organizations/{organizationsId}:setSyncAuthorization: + - in: path + name: keyvaluemapsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/organizations/{organizationsId}/apis/{apisId}/debugsessions: parameters: *ref_1 - post: - description: >- - Sets the permissions required to allow the Synchronizer to download - environment data from the control plane. You must call this API to - enable proper functioning of hybrid. Pass the ETag when calling - `setSyncAuthorization` to ensure that you are updating the correct - version. To get an ETag, call - [getSyncAuthorization](getSyncAuthorization). If you don't pass the ETag - in the call to `setSyncAuthorization`, then the existing authorization - is overwritten indiscriminately. For more information, see [Configure - the - Synchronizer](https://cloud.google.com/apigee/docs/hybrid/latest/synchronizer-access). - **Note**: Available to Apigee hybrid only. - operationId: apigee.organizations.setSyncAuthorization - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SyncAuthorization' + get: + description: Lists debug sessions that are currently active in the given API Proxy. + operationId: apigee.organizations.apis.debugsessions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13338,18 +14475,35 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SyncAuthorization' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListApiDebugSessionsResponse parameters: - in: path name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}: + - in: path + name: apisId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/organizations/{organizationsId}/operations: parameters: *ref_1 get: - description: Gets a shared flow by name, including a list of its revisions. - operationId: apigee.organizations.sharedflows.get + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: apigee.organizations.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13361,23 +14515,34 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlow' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: sharedflowsId - required: true + - in: query + name: filter schema: type: string - delete: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/organizations/{organizationsId}/operations/{operationsId}: + parameters: *ref_1 + get: description: >- - Deletes a shared flow and all it's revisions. The shared flow must be - undeployed before you can delete it. - operationId: apigee.organizations.sharedflows.delete + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: apigee.organizations.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13389,7 +14554,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlow' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -13397,25 +14562,20 @@ paths: schema: type: string - in: path - name: sharedflowsId + name: operationsId required: true schema: type: string - /v1/organizations/{organizationsId}/sharedflows: + /v1/organizations/{organizationsId}/datacollectors: parameters: *ref_1 post: - description: >- - Uploads a ZIP-formatted shared flow configuration bundle to an - organization. If the shared flow already exists, this creates a new - revision of it. If the shared flow does not exist, this creates it. Once - imported, the shared flow revision must be deployed before it can be - accessed at runtime. The size limit of a shared flow bundle is 15 MB. - operationId: apigee.organizations.sharedflows.create + description: Creates a new data collector. + operationId: apigee.organizations.datacollectors.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13427,7 +14587,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlowRevision' + $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' parameters: - in: path name: organizationsId @@ -13435,16 +14595,12 @@ paths: schema: type: string - in: query - name: name - schema: - type: string - - in: query - name: action + name: dataCollectorId schema: type: string get: - description: Lists all shared flows in the organization. - operationId: apigee.organizations.sharedflows.list + description: Lists all data collectors. + operationId: apigee.organizations.datacollectors.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13457,7 +14613,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListSharedFlowsResponse + #/components/schemas/GoogleCloudApigeeV1ListDataCollectorsResponse parameters: - in: path name: organizationsId @@ -13465,28 +14621,19 @@ paths: schema: type: string - in: query - name: includeMetaData + name: pageSize schema: - type: boolean + type: integer + format: int32 - in: query - name: includeRevisions + name: pageToken schema: - type: boolean - /v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}/revisions/{revisionsId}: + type: string + /v1/organizations/{organizationsId}/datacollectors/{datacollectorsId}: parameters: *ref_1 - post: - description: >- - Updates a shared flow revision. This operation is only allowed on - revisions which have never been deployed. After deployment a revision - becomes immutable, even if it becomes undeployed. The payload is a - ZIP-formatted shared flow. Content type must be either - multipart/form-data or application/octet-stream. - operationId: apigee.organizations.sharedflows.revisions.updateSharedFlowRevision - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + get: + description: Gets a data collector. + operationId: apigee.organizations.datacollectors.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13498,7 +14645,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlowRevision' + $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' parameters: - in: path name: organizationsId @@ -13506,29 +14653,18 @@ paths: schema: type: string - in: path - name: sharedflowsId - required: true - schema: - type: string - - in: path - name: revisionsId + name: datacollectorsId required: true schema: type: string - - in: query - name: validate - schema: - type: boolean - get: - description: >- - Gets a revision of a shared flow. To download the shared flow - configuration bundle for the specified revision as a zip file, set the - `format` query parameter to `bundle`. If you are using curl, specify `-o - filename.zip` to save the output to a file; otherwise, it displays to - `stdout`. Then, develop the shared flow configuration locally and upload - the updated sharedFlow configuration revision, as described in - [updateSharedFlowRevision](updateSharedFlowRevision). - operationId: apigee.organizations.sharedflows.revisions.get + patch: + description: Updates a data collector. + operationId: apigee.organizations.datacollectors.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13540,7 +14676,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' parameters: - in: path name: organizationsId @@ -13548,24 +14684,18 @@ paths: schema: type: string - in: path - name: sharedflowsId - required: true - schema: - type: string - - in: path - name: revisionsId + name: datacollectorsId required: true schema: type: string - in: query - name: format + name: updateMask schema: type: string + format: google-fieldmask delete: - description: >- - Deletes a shared flow and all associated policies, resources, and - revisions. You must undeploy the shared flow before deleting it. - operationId: apigee.organizations.sharedflows.revisions.delete + description: Deletes a data collector. + operationId: apigee.organizations.datacollectors.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13577,7 +14707,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlowRevision' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -13585,20 +14715,15 @@ paths: schema: type: string - in: path - name: sharedflowsId - required: true - schema: - type: string - - in: path - name: revisionsId + name: datacollectorsId required: true schema: type: string - /v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}/revisions/{revisionsId}/deployments: + /v1/organizations/{organizationsId}/environments/{environmentsId}/debugmask: parameters: *ref_1 get: - description: Lists all deployments of a shared flow revision. - operationId: apigee.organizations.sharedflows.revisions.deployments.list + description: Gets the debug mask singleton resource for an environment. + operationId: apigee.organizations.environments.getDebugmask security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13610,8 +14735,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1DebugMask' parameters: - in: path name: organizationsId @@ -13619,20 +14743,55 @@ paths: schema: type: string - in: path - name: sharedflowsId + name: environmentsId required: true schema: type: string + patch: + description: Updates the debug mask singleton resource for an environment. + operationId: apigee.organizations.environments.updateDebugmask + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1DebugMask' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1DebugMask' + parameters: - in: path - name: revisionsId + name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}/deployments: + - in: path + name: environmentsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: replaceRepeatedFields + schema: + type: boolean + /v1/organizations/{organizationsId}/environments/{environmentsId}/traceConfig: parameters: *ref_1 get: - description: Lists all deployments of a shared flow. - operationId: apigee.organizations.sharedflows.deployments.list + description: Get distributed trace configuration in an environment. + operationId: apigee.organizations.environments.getTraceConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13644,8 +14803,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfig' parameters: - in: path name: organizationsId @@ -13653,15 +14811,22 @@ paths: schema: type: string - in: path - name: sharedflowsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/datacollectors: - parameters: *ref_1 - get: - description: Lists all data collectors. - operationId: apigee.organizations.datacollectors.list + patch: + description: >- + Updates the trace configurations in an environment. Note that the + repeated fields have replace semantics when included in the field mask + and that they will be overwritten by the value of the fields in the + request body. + operationId: apigee.organizations.environments.updateTraceConfig + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13673,31 +14838,33 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDataCollectorsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfig' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: pageSize + - in: path + name: environmentsId + required: true schema: - type: integer - format: int32 + type: string - in: query - name: pageToken + name: updateMask schema: type: string + format: google-fieldmask + /v1/organizations/{organizationsId}/environments: + parameters: *ref_1 post: - description: Creates a new data collector. - operationId: apigee.organizations.datacollectors.create + description: Creates an environment in an organization. + operationId: apigee.organizations.environments.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' + $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13709,7 +14876,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -13717,14 +14884,18 @@ paths: schema: type: string - in: query - name: dataCollectorId + name: name schema: type: string - /v1/organizations/{organizationsId}/datacollectors/{datacollectorsId}: + /v1/organizations/{organizationsId}/environments/{environmentsId}: parameters: *ref_1 - get: - description: Gets a data collector. - operationId: apigee.organizations.datacollectors.get + delete: + description: >- + Deletes an environment from an organization. **Warning: You must delete + all key value maps and key value entries before you delete an + environment.** Otherwise, if you re-create the environment the key value + map entry operations will encounter encryption/decryption discrepancies. + operationId: apigee.organizations.environments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13736,7 +14907,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -13744,13 +14915,13 @@ paths: schema: type: string - in: path - name: datacollectorsId + name: environmentsId required: true schema: type: string - delete: - description: Deletes a data collector. - operationId: apigee.organizations.datacollectors.delete + get: + description: Gets environment details. + operationId: apigee.organizations.environments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13762,7 +14933,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' parameters: - in: path name: organizationsId @@ -13770,18 +14941,24 @@ paths: schema: type: string - in: path - name: datacollectorsId + name: environmentsId required: true schema: type: string - patch: - description: Updates a data collector. - operationId: apigee.organizations.datacollectors.patch + post: + description: >- + Updates an existing environment. When updating properties, you must pass + all existing properties to the API, even if they are not being changed. + If you omit properties from the payload, the properties are removed. To + get the current list of properties for the environment, use the [Get + Environment API](get). **Note**: Both `PUT` and `POST` methods are + supported for updating an existing environment. + operationId: apigee.organizations.environments.updateEnvironment requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' + $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13793,7 +14970,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' + $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' parameters: - in: path name: organizationsId @@ -13801,26 +14978,24 @@ paths: schema: type: string - in: path - name: datacollectorsId + name: environmentsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1/organizations/{organizationsId}/developers/{developersId}/balance:credit: - parameters: *ref_1 - post: - description: Credits the account balance for the developer. - operationId: apigee.organizations.developers.balance.credit + put: + description: >- + Updates an existing environment. When updating properties, you must pass + all existing properties to the API, even if they are not being changed. + If you omit properties from the payload, the properties are removed. To + get the current list of properties for the environment, use the [Get + Environment API](get). **Note**: Both `PUT` and `POST` methods are + supported for updating an existing environment. + operationId: apigee.organizations.environments.update requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1CreditDeveloperBalanceRequest + $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13832,7 +15007,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperBalance' + $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' parameters: - in: path name: organizationsId @@ -13840,23 +15015,20 @@ paths: schema: type: string - in: path - name: developersId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/balance:adjust: - parameters: *ref_1 - post: + patch: description: >- - Adjust the prepaid balance for the developer. This API will be used in - scenarios where the developer has been under-charged or over-charged. - operationId: apigee.organizations.developers.balance.adjust + Updates properties for an Apigee environment with patch semantics using + a field mask. **Note:** Not supported for Apigee hybrid. + operationId: apigee.organizations.environments.modifyEnvironment requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1AdjustDeveloperBalanceRequest + $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13868,7 +15040,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperBalance' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -13876,15 +15048,20 @@ paths: schema: type: string - in: path - name: developersId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/attributes/{attributesId}: + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/organizations/{organizationsId}/environments/{environmentsId}/deployedConfig: parameters: *ref_1 - delete: - description: Deletes a developer attribute. - operationId: apigee.organizations.developers.attributes.delete + get: + description: Gets the deployed configuration for an environment. + operationId: apigee.organizations.environments.getDeployedConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13896,7 +15073,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentConfig' parameters: - in: path name: organizationsId @@ -13904,29 +15081,58 @@ paths: schema: type: string - in: path - name: developersId + name: environmentsId required: true schema: type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/apiSecurityRuntimeConfig: + parameters: *ref_1 + get: + description: >- + Gets the API Security runtime configuration for an environment. This + named ApiSecurityRuntimeConfig to prevent conflicts with + ApiSecurityConfig from addon config. + operationId: apigee.organizations.environments.getApiSecurityRuntimeConfig + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ApiSecurityRuntimeConfig + parameters: - in: path - name: attributesId + name: organizationsId required: true schema: type: string + - in: path + name: environmentsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}:setIamPolicy: + parameters: *ref_1 post: description: >- - Updates a developer attribute. **Note**: OAuth access tokens and Key - Management Service (KMS) entities (apps, developers, and API products) - are cached for 180 seconds (default). Any custom attributes associated - with these entities are cached for at least 180 seconds after the entity - is accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 - policy won't be able to expire an access token in less than 180 seconds. - operationId: apigee.organizations.developers.attributes.updateDeveloperAttribute + Sets the IAM policy on an environment, if the policy already exists it + will be replaced. For more information, see [Manage users, roles, and + permissions using the + API](https://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). + You must have the `apigee.environments.setIamPolicy` permission to call + this API. + operationId: apigee.organizations.environments.setIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13938,7 +15144,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: organizationsId @@ -13946,18 +15152,20 @@ paths: schema: type: string - in: path - name: developersId - required: true - schema: - type: string - - in: path - name: attributesId + name: environmentsId required: true schema: type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}:getIamPolicy: + parameters: *ref_1 get: - description: Returns the value of the specified developer attribute. - operationId: apigee.organizations.developers.attributes.get + description: >- + Gets the IAM policy on an environment. For more information, see [Manage + users, roles, and permissions using the + API](https://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). + You must have the `apigee.environments.getIamPolicy` permission to call + this API. + operationId: apigee.organizations.environments.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13969,7 +15177,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: organizationsId @@ -13977,20 +15185,29 @@ paths: schema: type: string - in: path - name: developersId + name: environmentsId required: true schema: type: string - - in: path - name: attributesId - required: true + - in: query + name: options.requestedPolicyVersion schema: - type: string - /v1/organizations/{organizationsId}/developers/{developersId}/attributes: + type: integer + format: int32 + /v1/organizations/{organizationsId}/environments/{environmentsId}:testIamPermissions: parameters: *ref_1 - get: - description: Returns a list of all developer attributes. - operationId: apigee.organizations.developers.attributes.list + post: + description: >- + Tests the permissions of a user on an environment, and returns a subset + of permissions that the user has on the environment. If the environment + does not exist, an empty permission set is returned (a NOT_FOUND error + is not returned). + operationId: apigee.organizations.environments.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14002,7 +15219,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' parameters: - in: path name: organizationsId @@ -14010,28 +15227,18 @@ paths: schema: type: string - in: path - name: developersId + name: environmentsId required: true - schema: - type: string - post: - description: >- - Updates developer attributes. This API replaces the existing attributes - with those specified in the request. Add new attributes, and include or - exclude any existing attributes that you want to retain or remove, - respectively. The custom attribute limit is 18. **Note**: OAuth access - tokens and Key Management Service (KMS) entities (apps, developers, and - API products) are cached for 180 seconds (default). Any custom - attributes associated with these entities are cached for at least 180 - seconds after the entity is accessed at runtime. Therefore, an - `ExpiresIn` element on the OAuthV2 policy won't be able to expire an - access token in less than 180 seconds. - operationId: apigee.organizations.developers.attributes - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}:subscribe: + parameters: *ref_1 + post: + description: >- + Creates a subscription for the environment's Pub/Sub topic. The server + will assign a random name for this subscription. The "name" and + "push_config" must *not* be specified. + operationId: apigee.organizations.environments.subscribe security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14043,7 +15250,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' + $ref: '#/components/schemas/GoogleCloudApigeeV1Subscription' parameters: - in: path name: organizationsId @@ -14051,21 +15258,20 @@ paths: schema: type: string - in: path - name: developersId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/subscriptions/{subscriptionsId}:expire: + /v1/organizations/{organizationsId}/environments/{environmentsId}:unsubscribe: parameters: *ref_1 post: - description: Expires an API product subscription immediately. - operationId: apigee.organizations.developers.subscriptions.expire + description: Deletes a subscription for the environment's Pub/Sub topic. + operationId: apigee.organizations.environments.unsubscribe requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ExpireDeveloperSubscriptionRequest + $ref: '#/components/schemas/GoogleCloudApigeeV1Subscription' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14077,7 +15283,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -14085,20 +15291,15 @@ paths: schema: type: string - in: path - name: developersId - required: true - schema: - type: string - - in: path - name: subscriptionsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/subscriptions/{subscriptionsId}: + /v1/organizations/{organizationsId}/environments/{environmentsId}/addonsConfig: parameters: *ref_1 get: - description: Gets details for an API product subscription. - operationId: apigee.organizations.developers.subscriptions.get + description: Gets the add-ons config of an environment. + operationId: apigee.organizations.environments.getAddonsConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14110,7 +15311,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription' + $ref: '#/components/schemas/GoogleCloudApigeeV1AddonsConfig' parameters: - in: path name: organizationsId @@ -14118,25 +15319,17 @@ paths: schema: type: string - in: path - name: developersId - required: true - schema: - type: string - - in: path - name: subscriptionsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/subscriptions: + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityActionsConfig: parameters: *ref_1 - post: - description: 'Creates a subscription to an API product. ' - operationId: apigee.organizations.developers.subscriptions.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription' + get: + description: >- + GetSecurityActionConfig returns the current SecurityActions + configuration. + operationId: apigee.organizations.environments.getSecurityActionsConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14148,7 +15341,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionsConfig' parameters: - in: path name: organizationsId @@ -14156,13 +15349,21 @@ paths: schema: type: string - in: path - name: developersId + name: environmentsId required: true schema: type: string - get: - description: Lists all API product subscriptions for a developer. - operationId: apigee.organizations.developers.subscriptions.list + patch: + description: >- + UpdateSecurityActionConfig updates the current SecurityActions + configuration. This method is used to enable/disable the feature at the + environment level. + operationId: apigee.organizations.environments.updateSecurityActionsConfig + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionsConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14174,8 +15375,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDeveloperSubscriptionsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionsConfig' parameters: - in: path name: organizationsId @@ -14183,43 +15383,29 @@ paths: schema: type: string - in: path - name: developersId + name: environmentsId required: true schema: type: string - in: query - name: startKey + name: updateMask schema: type: string - - in: query - name: count - schema: - type: integer - format: int32 - /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/create: + format: google-fieldmask + /v1/organizations/{organizationsId}/environments/{environmentsId}/resourcefiles: parameters: *ref_1 post: description: >- - Creates a custom consumer key and secret for a developer app. This is - particularly useful if you want to migrate existing consumer keys and - secrets to Apigee from another system. Consumer keys and secrets can - contain letters, numbers, underscores, and hyphens. No other special - characters are allowed. To avoid service disruptions, a consumer key and - secret should not exceed 2 KBs each. **Note**: When creating the - consumer key and secret, an association to API products will not be - made. Therefore, you should not specify the associated API products in - your request. Instead, use the UpdateDeveloperAppKey API to make the - association after the consumer key and secret are created. If a consumer - key and secret already exist, you can keep them or delete them using the - DeleteDeveloperAppKey API. **Note**: All keys start out with - status=approved, even if status=revoked is passed when the key is - created. To revoke a key, use the UpdateDeveloperAppKey API. - operationId: apigee.organizations.developers.apps.keys.create.create + Creates a resource file. Specify the `Content-Type` as + `application/octet-stream` or `multipart/form-data`. For more + information about resource files, see [Resource + files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). + operationId: apigee.organizations.environments.resourcefiles.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + $ref: '#/components/schemas/GoogleApiHttpBody' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14231,7 +15417,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' parameters: - in: path name: organizationsId @@ -14239,27 +15425,24 @@ paths: schema: type: string - in: path - name: developersId + name: environmentsId required: true schema: type: string - - in: path - name: appsId - required: true + - in: query + name: type schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/{keysId}/apiproducts/{apiproductsId}: - parameters: *ref_1 - post: + - in: query + name: name + schema: + type: string + get: description: >- - Approves or revokes the consumer key for an API product. After a - consumer key is approved, the app can use it to access APIs. A consumer - key that is revoked or pending cannot be used to access an API. Any - access tokens associated with a revoked consumer key will remain active. - However, Apigee checks the status of the consumer key and if set to - `revoked` will not allow access to the API. - operationId: >- - apigee.organizations.developers.apps.keys.apiproducts.updateDeveloperAppKeyApiProduct + Lists all resource files, optionally filtering by type. For more + information about resource files, see [Resource + files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). + operationId: apigee.organizations.environments.resourcefiles.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14271,7 +15454,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListEnvironmentResourcesResponse parameters: - in: path name: organizationsId @@ -14279,36 +15463,28 @@ paths: schema: type: string - in: path - name: developersId - required: true - schema: - type: string - - in: path - name: appsId - required: true - schema: - type: string - - in: path - name: keysId - required: true - schema: - type: string - - in: path - name: apiproductsId + name: environmentsId required: true schema: type: string - in: query - name: action + name: type schema: type: string - delete: + /v1/organizations/{organizationsId}/environments/{environmentsId}/resourcefiles/{type}/{name}: + parameters: *ref_1 + put: description: >- - Removes an API product from an app's consumer key. After the API product - is removed, the app cannot access the API resources defined in that API - product. **Note**: The consumer key is not removed, only its association - with the API product. - operationId: apigee.organizations.developers.apps.keys.apiproducts.delete + Updates a resource file. Specify the `Content-Type` as + `application/octet-stream` or `multipart/form-data`. For more + information about resource files, see [Resource + files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). + operationId: apigee.organizations.environments.resourcefiles.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleApiHttpBody' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14320,7 +15496,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' parameters: - in: path name: organizationsId @@ -14328,49 +15504,26 @@ paths: schema: type: string - in: path - name: developersId - required: true - schema: - type: string - - in: path - name: appsId + name: environmentsId required: true schema: type: string - in: path - name: keysId + name: type required: true schema: type: string - in: path - name: apiproductsId + name: name required: true schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys: - parameters: *ref_1 - post: + get: description: >- - Creates a custom consumer key and secret for a developer app. This is - particularly useful if you want to migrate existing consumer keys and - secrets to Apigee from another system. Consumer keys and secrets can - contain letters, numbers, underscores, and hyphens. No other special - characters are allowed. To avoid service disruptions, a consumer key and - secret should not exceed 2 KBs each. **Note**: When creating the - consumer key and secret, an association to API products will not be - made. Therefore, you should not specify the associated API products in - your request. Instead, use the UpdateDeveloperAppKey API to make the - association after the consumer key and secret are created. If a consumer - key and secret already exist, you can keep them or delete them using the - DeleteDeveloperAppKey API. **Note**: All keys start out with - status=approved, even if status=revoked is passed when the key is - created. To revoke a key, use the UpdateDeveloperAppKey API. - operationId: apigee.organizations.developers.apps.keys.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + Gets the contents of a resource file. For more information about + resource files, see [Resource + files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). + operationId: apigee.organizations.environments.resourcefiles.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14382,7 +15535,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: organizationsId @@ -14390,31 +15543,26 @@ paths: schema: type: string - in: path - name: developersId + name: environmentsId required: true schema: type: string - in: path - name: appsId + name: type required: true schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/{keysId}: - parameters: *ref_1 - put: + - in: path + name: name + required: true + schema: + type: string + delete: description: >- - Updates the scope of an app. This API replaces the existing scopes with - those specified in the request. Include or exclude any existing scopes - that you want to retain or delete, respectively. The specified scopes - must already be defined for the API products associated with the app. - This API sets the `scopes` element under the `apiProducts` element in - the attributes of the app. - operationId: apigee.organizations.developers.apps.keys.replaceDeveloperAppKey - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + Deletes a resource file. For more information about resource files, see + [Resource + files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). + operationId: apigee.organizations.environments.resourcefiles.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14426,7 +15574,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' parameters: - in: path name: organizationsId @@ -14434,25 +15582,28 @@ paths: schema: type: string - in: path - name: developersId + name: environmentsId required: true schema: type: string - in: path - name: appsId + name: type required: true schema: type: string - in: path - name: keysId + name: name required: true schema: type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/resourcefiles/{type}: + parameters: *ref_1 get: description: >- - Gets details for a consumer key for a developer app, including the key - and secret value, associated API products, and other information. - operationId: apigee.organizations.developers.apps.keys.get + Lists all resource files, optionally filtering by type. For more + information about resource files, see [Resource + files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). + operationId: apigee.organizations.environments.resourcefiles.listEnvironmentResources security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14464,7 +15615,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListEnvironmentResourcesResponse parameters: - in: path name: organizationsId @@ -14472,30 +15624,20 @@ paths: schema: type: string - in: path - name: developersId - required: true - schema: - type: string - - in: path - name: appsId + name: environmentsId required: true schema: type: string - in: path - name: keysId + name: type required: true schema: type: string - delete: - description: >- - Deletes an app's consumer key and removes all API products associated - with the app. After the consumer key is deleted, it cannot be used to - access any APIs. **Note**: After you delete a consumer key, you may want - to: 1. Create a new consumer key and secret for the developer app using - the CreateDeveloperAppKey API, and subsequently add an API product to - the key using the UpdateDeveloperAppKey API. 2. Delete the developer - app, if it is no longer required. - operationId: apigee.organizations.developers.apps.keys.delete + /v1/organizations/{organizationsId}/environments/{environmentsId}/archiveDeployments/{archiveDeploymentsId}: + parameters: *ref_1 + get: + description: Gets the specified ArchiveDeployment. + operationId: apigee.organizations.environments.archiveDeployments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14507,7 +15649,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' parameters: - in: path name: organizationsId @@ -14515,35 +15657,25 @@ paths: schema: type: string - in: path - name: developersId - required: true - schema: - type: string - - in: path - name: appsId + name: environmentsId required: true schema: type: string - in: path - name: keysId + name: archiveDeploymentsId required: true schema: type: string - post: + patch: description: >- - Adds an API product to a developer app key, enabling the app that holds - the key to access the API resources bundled in the API product. In - addition, you can add attributes to a developer app key. This API - replaces the existing attributes with those specified in the request. - Include or exclude any existing attributes that you want to retain or - delete, respectively. You can use the same key to access all API - products associated with the app. - operationId: apigee.organizations.developers.apps.keys.updateDeveloperAppKey + Updates an existing ArchiveDeployment. Labels can modified but most of + the other fields are not modifiable. + operationId: apigee.organizations.environments.archiveDeployments.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14555,7 +15687,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' parameters: - in: path name: organizationsId @@ -14563,29 +15695,23 @@ paths: schema: type: string - in: path - name: developersId - required: true - schema: - type: string - - in: path - name: appsId + name: environmentsId required: true schema: type: string - in: path - name: keysId + name: archiveDeploymentsId required: true schema: type: string - in: query - name: action + name: updateMask schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/attributes/{attributesId}: - parameters: *ref_1 + format: google-fieldmask delete: - description: Deletes a developer app attribute. - operationId: apigee.organizations.developers.apps.attributes.delete + description: Deletes an archive deployment. + operationId: apigee.organizations.environments.archiveDeployments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14597,7 +15723,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -14605,23 +15731,20 @@ paths: schema: type: string - in: path - name: developersId - required: true - schema: - type: string - - in: path - name: appsId + name: environmentsId required: true schema: type: string - in: path - name: attributesId + name: archiveDeploymentsId required: true schema: type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/archiveDeployments: + parameters: *ref_1 get: - description: Returns a developer app attribute. - operationId: apigee.organizations.developers.apps.attributes.get + description: Lists the ArchiveDeployments in the specified Environment. + operationId: apigee.organizations.environments.archiveDeployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14633,7 +15756,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListArchiveDeploymentsResponse parameters: - in: path name: organizationsId @@ -14641,36 +15765,31 @@ paths: schema: type: string - in: path - name: developersId + name: environmentsId required: true schema: type: string - - in: path - name: appsId - required: true + - in: query + name: filter schema: type: string - - in: path - name: attributesId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string post: - description: >- - Updates a developer app attribute. **Note**: OAuth access tokens and Key - Management Service (KMS) entities (apps, developers, and API products) - are cached for 180 seconds (current default). Any custom attributes - associated with these entities are cached for at least 180 seconds after - the entity is accessed at runtime. Therefore, an `ExpiresIn` element on - the OAuthV2 policy won't be able to expire an access token in less than - 180 seconds. - operationId: >- - apigee.organizations.developers.apps.attributes.updateDeveloperAppAttribute + description: Creates a new ArchiveDeployment. + operationId: apigee.organizations.environments.archiveDeployments.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14682,7 +15801,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -14690,25 +15809,71 @@ paths: schema: type: string - in: path - name: developersId + name: environmentsId required: true schema: type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/archiveDeployments:generateUploadUrl: + parameters: *ref_1 + post: + description: >- + Generates a signed URL for uploading an Archive zip file to Google Cloud + Storage. Once the upload is complete, the signed URL should be passed to + CreateArchiveDeployment. When uploading to the generated signed URL, + please follow these restrictions: * Source file type should be a zip + file. * Source file size should not exceed 1GB limit. * No credentials + should be attached - the signed URLs provide access to the target bucket + using internal service identity; if credentials were attached, the + identity from the credentials would be used, but that identity does not + have permissions to upload files to the URL. When making a HTTP PUT + request, these two headers need to be specified: * `content-type: + application/zip` * `x-goog-content-length-range: 0,1073741824` And this + header SHOULD NOT be specified: * `Authorization: Bearer YOUR_TOKEN` + operationId: apigee.organizations.environments.archiveDeployments.generateUploadUrl + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1GenerateUploadUrlRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1GenerateUploadUrlResponse + parameters: - in: path - name: appsId + name: organizationsId required: true schema: type: string - in: path - name: attributesId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/attributes: + /v1/organizations/{organizationsId}/environments/{environmentsId}/archiveDeployments/{archiveDeploymentsId}:generateDownloadUrl: parameters: *ref_1 - get: - description: Returns a list of all developer app attributes. - operationId: apigee.organizations.developers.apps.attributes.list + post: + description: >- + Generates a signed URL for downloading the original zip file used to + create an Archive Deployment. The URL is only valid for a limited period + and should be used within minutes after generation. Each call returns a + new upload URL. + operationId: apigee.organizations.environments.archiveDeployments.generateDownloadUrl + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1GenerateDownloadUrlRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14720,7 +15885,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1GenerateDownloadUrlResponse parameters: - in: path name: organizationsId @@ -14728,25 +15894,38 @@ paths: schema: type: string - in: path - name: developersId + name: environmentsId required: true schema: type: string - in: path - name: appsId + name: archiveDeploymentsId required: true schema: type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/deployments: + parameters: *ref_1 post: description: >- - Updates attributes for a developer app. This API replaces the current - attributes with those specified in the request. - operationId: apigee.organizations.developers.apps.attributes - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' + Deploys a revision of an API proxy. If another revision of the same API + proxy revision is currently deployed, set the `override` parameter to + `true` to have this revision replace the currently deployed revision. + You cannot invoke an API proxy until it has been deployed to an + environment. After you deploy an API proxy revision, you cannot edit it. + To edit the API proxy, you must create and deploy a new revision. For a + request path + `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments`, + two permissions are required: * `apigee.deployments.create` on the + resource `organizations/{org}/environments/{env}` * + `apigee.proxyrevisions.deploy` on the resource + `organizations/{org}/apis/{api}/revisions/{rev}` All successful API + proxy deployments to Apigee are [zero-downtime + deployments](https://cloud.google.com/apigee/docs/api-platform/deploy/ui-deploy-overview#zero-downtime-deployment). + Apigee hybrid validates the dependencies between shared flows and API + proxies at deployment time. For example, if the Flow Callout policy in + an API proxy references a shared flow that either doesn't exist or isn't + deployed, the API proxy deployment fails. + operationId: apigee.organizations.environments.apis.revisions.deploy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14758,7 +15937,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' + $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' parameters: - in: path name: organizationsId @@ -14766,24 +15945,41 @@ paths: schema: type: string - in: path - name: developersId + name: environmentsId required: true schema: type: string - in: path - name: appsId + name: apisId required: true schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}: - parameters: *ref_1 + - in: path + name: revisionsId + required: true + schema: + type: string + - in: query + name: override + schema: + type: boolean + - in: query + name: sequencedRollout + schema: + type: boolean + - in: query + name: serviceAccount + schema: + type: string delete: description: >- - Deletes a developer app. **Note**: The delete operation is asynchronous. - The developer app is deleted immediately, but its associated resources, - such as app keys or access tokens, may take anywhere from a few seconds - to a few minutes to be deleted. - operationId: apigee.organizations.developers.apps.delete + Undeploys an API proxy revision from an environment. For a request path + `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments`, + two permissions are required: * `apigee.deployments.delete` on the + resource `organizations/{org}/environments/{env}` * + `apigee.proxyrevisions.undeploy` on the resource + `organizations/{org}/apis/{api}/revisions/{rev}` + operationId: apigee.organizations.environments.apis.revisions.undeploy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14795,7 +15991,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -14803,33 +15999,29 @@ paths: schema: type: string - in: path - name: developersId + name: environmentsId required: true schema: type: string - in: path - name: appsId + name: apisId required: true schema: type: string - put: + - in: path + name: revisionsId + required: true + schema: + type: string + - in: query + name: sequencedRollout + schema: + type: boolean + get: description: >- - Updates the details for a developer app. In addition, you can add an API - product to a developer app and automatically generate an API key for the - app to use when calling APIs in the API product. If you want to use an - existing API key for the API product, add the API product to the API key - using the UpdateDeveloperAppKey API. Using this API, you cannot update - the following: * App name as it is the primary key used to identify the - app and cannot be changed. * Scopes associated with the app. Instead, - use the ReplaceDeveloperAppKey API. This API replaces the existing - attributes with those specified in the request. Include or exclude any - existing attributes that you want to retain or delete, respectively. - operationId: apigee.organizations.developers.apps.update - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' + Gets the deployment of an API proxy revision and actual state reported + by runtime pods. + operationId: apigee.organizations.environments.apis.revisions.getDeployments security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14841,7 +16033,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' + $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' parameters: - in: path name: organizationsId @@ -14849,18 +16041,39 @@ paths: schema: type: string - in: path - name: developersId + name: environmentsId required: true schema: type: string - in: path - name: appsId + name: apisId required: true schema: type: string - get: - description: Returns the details for a developer app. - operationId: apigee.organizations.developers.apps.get + - in: path + name: revisionsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/deployments:generateDeployChangeReport: + parameters: *ref_1 + post: + description: >- + Generates a report for a dry run analysis of a DeployApiProxy request + without committing the deployment. In addition to the standard + validations performed when adding deployments, additional analysis will + be done to detect possible traffic routing changes that would result + from this deployment being created. Any potential routing conflicts or + unsafe changes will be reported in the response. This routing analysis + is not performed for a non-dry-run DeployApiProxy request. For a request + path + `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments:generateDeployChangeReport`, + two permissions are required: * `apigee.deployments.create` on the + resource `organizations/{org}/environments/{env}` * + `apigee.proxyrevisions.deploy` on the resource + `organizations/{org}/apis/{api}/revisions/{rev}` + operationId: >- + apigee.organizations.environments.apis.revisions.deployments.generateDeployChangeReport security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14872,7 +16085,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeploymentChangeReport' parameters: - in: path name: organizationsId @@ -14880,57 +16093,42 @@ paths: schema: type: string - in: path - name: developersId + name: environmentsId required: true schema: type: string - in: path - name: appsId + name: apisId required: true schema: type: string - - in: query - name: entity + - in: path + name: revisionsId + required: true schema: type: string - in: query - name: query + name: override schema: - type: string + type: boolean + /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/deployments:generateUndeployChangeReport: + parameters: *ref_1 post: description: >- - Manages access to a developer app by enabling you to: * Approve or - revoke a developer app * Generate a new consumer key and secret for a - developer app To approve or revoke a developer app, set the `action` - query parameter to `approve` or `revoke`, respectively, and the - `Content-Type` header to `application/octet-stream`. If a developer app - is revoked, none of its API keys are valid for API calls even though the - keys are still approved. If successful, the API call returns the - following HTTP status code: `204 No Content` To generate a new consumer - key and secret for a developer app, pass the new key/secret details. - Rather than replace an existing key, this API generates a new key. In - this case, multiple key pairs may be associated with a single developer - app. Each key pair has an independent status (`approve` or `revoke`) and - expiration time. Any approved, non-expired key can be used in an API - call. For example, if you're using API key rotation, you can generate - new keys with expiration times that overlap keys that are going to - expire. You might also generate a new consumer key/secret if the - security of the original key/secret is compromised. The `keyExpiresIn` - property defines the expiration time for the API key in milliseconds. If - you don't set this property or set it to `-1`, the API key never - expires. **Notes**: * When generating a new key/secret, this API - replaces the existing attributes, notes, and callback URLs with those - specified in the request. Include or exclude any existing information - that you want to retain or delete, respectively. * To migrate existing - consumer keys and secrets to hybrid from another system, see the - CreateDeveloperAppKey API. + Generates a report for a dry run analysis of an UndeployApiProxy request + without committing the undeploy. In addition to the standard validations + performed when removing deployments, additional analysis will be done to + detect possible traffic routing changes that would result from this + deployment being removed. Any potential routing conflicts or unsafe + changes will be reported in the response. This routing analysis is not + performed for a non-dry-run UndeployApiProxy request. For a request path + `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments:generateUndeployChangeReport`, + two permissions are required: * `apigee.deployments.delete` on the + resource `organizations/{org}/environments/{env}` * + `apigee.proxyrevisions.undeploy` on the resource + `organizations/{org}/apis/{api}/revisions/{rev}` operationId: >- - apigee.organizations.developers.apps.generateKeyPairOrUpdateDeveloperAppStatus - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' + apigee.organizations.environments.apis.revisions.deployments.generateUndeployChangeReport security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14942,7 +16140,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeploymentChangeReport' parameters: - in: path name: organizationsId @@ -14950,35 +16148,30 @@ paths: schema: type: string - in: path - name: developersId + name: environmentsId required: true schema: type: string - in: path - name: appsId + name: apisId required: true schema: type: string - - in: query - name: action + - in: path + name: revisionsId + required: true schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/apps: + /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions: parameters: *ref_1 post: - description: >- - Creates an app associated with a developer. This API associates the - developer app with the specified API product and auto-generates an API - key for the app to use in calls to API proxies inside that API product. - The `name` is the unique ID of the app that you can use in API calls. - The `DisplayName` (set as an attribute) appears in the UI. If you don't - set the `DisplayName` attribute, the `name` appears in the UI. - operationId: apigee.organizations.developers.apps.create + description: Creates a debug session for a deployed API Proxy revision. + operationId: apigee.organizations.environments.apis.revisions.debugsessions.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' + $ref: '#/components/schemas/GoogleCloudApigeeV1DebugSession' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14990,7 +16183,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' + $ref: '#/components/schemas/GoogleCloudApigeeV1DebugSession' parameters: - in: path name: organizationsId @@ -14998,18 +16191,30 @@ paths: schema: type: string - in: path - name: developersId + name: environmentsId + required: true + schema: + type: string + - in: path + name: apisId required: true schema: type: string + - in: path + name: revisionsId + required: true + schema: + type: string + - in: query + name: timeout + schema: + type: string + format: int64 get: description: >- - Lists all apps created by a developer in an Apigee organization. - Optionally, you can request an expanded view of the developer apps. A - maximum of 100 developer apps are returned per API call. You can - paginate the list of deveoper apps returned using the `startKey` and - `count` query parameters. - operationId: apigee.organizations.developers.apps.list + Lists debug sessions that are currently active in the given API Proxy + revision. + operationId: apigee.organizations.environments.apis.revisions.debugsessions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15022,7 +16227,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDeveloperAppsResponse + #/components/schemas/GoogleCloudApigeeV1ListDebugSessionsResponse parameters: - in: path name: organizationsId @@ -15030,32 +16235,34 @@ paths: schema: type: string - in: path - name: developersId + name: environmentsId required: true schema: type: string - - in: query - name: startKey + - in: path + name: apisId + required: true schema: type: string - - in: query - name: count + - in: path + name: revisionsId + required: true schema: type: string - format: int64 - in: query - name: expand + name: pageSize schema: - type: boolean + type: integer + format: int32 - in: query - name: shallowExpand + name: pageToken schema: - type: boolean - /v1/organizations/{organizationsId}/developers/{developersId}/balance: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions/{debugsessionsId}: parameters: *ref_1 get: - description: Gets the account balance for the developer. - operationId: apigee.organizations.developers.getBalance + description: Retrieves a debug session. + operationId: apigee.organizations.environments.apis.revisions.debugsessions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15067,7 +16274,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperBalance' + $ref: '#/components/schemas/GoogleCloudApigeeV1DebugSession' parameters: - in: path name: organizationsId @@ -15075,21 +16282,34 @@ paths: schema: type: string - in: path - name: developersId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/developers: + - in: path + name: apisId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string + - in: path + name: debugsessionsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions/{debugsessionsId}/data: parameters: *ref_1 - get: + delete: description: >- - Lists all developers in an organization by email address. By default, - the response does not include company developers. Set the - `includeCompany` query parameter to `true` to include company - developers. **Note**: A maximum of 1000 developers are returned in the - response. You paginate the list of developers returned using the - `startKey` and `count` query parameters. - operationId: apigee.organizations.developers.list + Deletes the data from a debug session. This does not cancel the debug + session or prevent further data from being collected if the session is + still active in runtime pods. + operationId: >- + apigee.organizations.environments.apis.revisions.debugsessions.deleteData security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15101,50 +16321,38 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListOfDevelopersResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: expand - schema: - type: boolean - - in: query - name: ids + - in: path + name: environmentsId + required: true schema: type: string - - in: query - name: count + - in: path + name: apisId + required: true schema: type: string - format: int64 - - in: query - name: app + - in: path + name: revisionsId + required: true schema: type: string - - in: query - name: includeCompany - schema: - type: boolean - - in: query - name: startKey + - in: path + name: debugsessionsId + required: true schema: type: string - post: - description: >- - Creates a developer. Once created, the developer can register an app and - obtain an API key. At creation time, a developer is set as `active`. To - change the developer status, use the SetDeveloperStatus API. - operationId: apigee.organizations.developers.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' + /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions/{debugsessionsId}/data/{dataId}: + parameters: *ref_1 + get: + description: Gets the debug data from a transaction. + operationId: apigee.organizations.environments.apis.revisions.debugsessions.data.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15156,21 +16364,44 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DebugSessionTransaction parameters: - in: path name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}: + - in: path + name: environmentsId + required: true + schema: + type: string + - in: path + name: apisId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string + - in: path + name: debugsessionsId + required: true + schema: + type: string + - in: path + name: dataId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/deployments: parameters: *ref_1 get: - description: >- - Returns the developer details, including the developer's name, email - address, apps, and other information. **Note**: The response includes - only the first 100 developer apps. - operationId: apigee.organizations.developers.get + description: Lists all deployments of an API proxy in an environment. + operationId: apigee.organizations.environments.apis.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15182,7 +16413,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse parameters: - in: path name: organizationsId @@ -15190,26 +16422,30 @@ paths: schema: type: string - in: path - name: developersId + name: environmentsId required: true schema: type: string - - in: query - name: action + - in: path + name: apisId + required: true schema: type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/sharedflows/{sharedflowsId}/revisions/{revisionsId}/deployments: + parameters: *ref_1 post: description: >- - Sets the status of a developer. A developer is `active` by default. If - you set a developer's status to `inactive`, the API keys assigned to the - developer apps are no longer valid even though the API keys are set to - `approved`. Inactive developers can still sign in to the developer - portal and create apps; however, any new API keys generated during app - creation won't work. To set the status of a developer, set the `action` - query parameter to `active` or `inactive`, and the `Content-Type` header - to `application/octet-stream`. If successful, the API call returns the - following HTTP status code: `204 No Content` - operationId: apigee.organizations.developers.setDeveloperStatus + Deploys a revision of a shared flow. If another revision of the same + shared flow is currently deployed, set the `override` parameter to + `true` to have this revision replace the currently deployed revision. + You cannot use a shared flow until it has been deployed to an + environment. For a request path + `organizations/{org}/environments/{env}/sharedflows/{sf}/revisions/{rev}/deployments`, + two permissions are required: * `apigee.deployments.create` on the + resource `organizations/{org}/environments/{env}` * + `apigee.sharedflowrevisions.deploy` on the resource + `organizations/{org}/sharedflows/{sf}/revisions/{rev}` + operationId: apigee.organizations.environments.sharedflows.revisions.deploy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15221,7 +16457,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' parameters: - in: path name: organizationsId @@ -15229,25 +16465,37 @@ paths: schema: type: string - in: path - name: developersId + name: environmentsId + required: true + schema: + type: string + - in: path + name: sharedflowsId + required: true + schema: + type: string + - in: path + name: revisionsId required: true schema: type: string - in: query - name: action + name: override + schema: + type: boolean + - in: query + name: serviceAccount schema: type: string delete: description: >- - Deletes a developer. All apps and API keys associated with the developer - are also removed. **Warning**: This API will permanently delete the - developer and related artifacts. To avoid permanently deleting - developers and their artifacts, set the developer status to `inactive` - using the SetDeveloperStatus API. **Note**: The delete operation is - asynchronous. The developer app is deleted immediately, but its - associated resources, such as apps and API keys, may take anywhere from - a few seconds to a few minutes to be deleted. - operationId: apigee.organizations.developers.delete + Undeploys a shared flow revision from an environment. For a request path + `organizations/{org}/environments/{env}/sharedflows/{sf}/revisions/{rev}/deployments`, + two permissions are required: * `apigee.deployments.delete` on the + resource `organizations/{org}/environments/{env}` * + `apigee.sharedflowrevisions.undeploy` on the resource + `organizations/{org}/sharedflows/{sf}/revisions/{rev}` + operationId: apigee.organizations.environments.sharedflows.revisions.undeploy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15259,7 +16507,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -15267,27 +16515,25 @@ paths: schema: type: string - in: path - name: developersId + name: environmentsId required: true schema: type: string - put: + - in: path + name: sharedflowsId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string + get: description: >- - Updates a developer. This API replaces the existing developer details - with those specified in the request. Include or exclude any existing - details that you want to retain or delete, respectively. The custom - attribute limit is 18. **Note**: OAuth access tokens and Key Management - Service (KMS) entities (apps, developers, and API products) are cached - for 180 seconds (current default). Any custom attributes associated with - these entities are cached for at least 180 seconds after the entity is - accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 - policy won't be able to expire an access token in less than 180 seconds. - operationId: apigee.organizations.developers.update - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' + Gets the deployment of a shared flow revision and actual state reported + by runtime pods. + operationId: apigee.organizations.environments.sharedflows.revisions.getDeployments security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15299,7 +16545,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' + $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' parameters: - in: path name: organizationsId @@ -15307,48 +16553,25 @@ paths: schema: type: string - in: path - name: developersId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/monetizationConfig: - parameters: *ref_1 - put: - description: Updates the monetization configuration for the developer. - operationId: apigee.organizations.developers.updateMonetizationConfig - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DeveloperMonetizationConfig - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DeveloperMonetizationConfig - parameters: - in: path - name: organizationsId + name: sharedflowsId required: true schema: type: string - in: path - name: developersId + name: revisionsId required: true schema: type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/sharedflows/{sharedflowsId}/deployments: + parameters: *ref_1 get: - description: Gets the monetization configuration for the developer. - operationId: apigee.organizations.developers.getMonetizationConfig + description: Lists all deployments of a shared flow in an environment. + operationId: apigee.organizations.environments.sharedflows.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15361,7 +16584,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1DeveloperMonetizationConfig + #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse parameters: - in: path name: organizationsId @@ -15369,20 +16592,20 @@ paths: schema: type: string - in: path - name: developersId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/hostSecurityReports/{hostSecurityReportsId}/result: + - in: path + name: sharedflowsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/deployments: parameters: *ref_1 get: - description: >- - After the query is completed, use this API to retrieve the results. If - the request succeeds, and there is a non-zero result set, the result is - downloaded to the client as a zipped JSON file. The name of the - downloaded file will be: OfflineQueryResult-.zip Example: - `OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip` - operationId: apigee.organizations.hostSecurityReports.getResult + description: Lists all deployments of API proxies or shared flows in an environment. + operationId: apigee.organizations.environments.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15394,7 +16617,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse parameters: - in: path name: organizationsId @@ -15402,18 +16626,21 @@ paths: schema: type: string - in: path - name: hostSecurityReportsId + name: environmentsId required: true schema: - type: string - /v1/organizations/{organizationsId}/hostSecurityReports/{hostSecurityReportsId}: + type: string + - in: query + name: sharedFlows + schema: + type: boolean + /v1/organizations/{organizationsId}/environments/{environmentsId}/deployments/{deploymentsId}: parameters: *ref_1 get: description: >- - Get status of a query submitted at host level. If the query is still in - progress, the `state` is set to "running" After the query has completed - successfully, `state` is set to "completed" - operationId: apigee.organizations.hostSecurityReports.get + Gets a particular deployment of Api proxy or a shared flow in an + environment + operationId: apigee.organizations.environments.deployments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15425,7 +16652,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' + $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' parameters: - in: path name: organizationsId @@ -15433,24 +16660,31 @@ paths: schema: type: string - in: path - name: hostSecurityReportsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/hostSecurityReports: + - in: path + name: deploymentsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/deployments/{deploymentsId}:setIamPolicy: parameters: *ref_1 post: description: >- - Submit a query at host level to be processed in the background. If the - submission of the query succeeds, the API returns a 201 status and an ID - that refer to the query. In addition to the HTTP status 201, the `state` - of "enqueued" means that the request succeeded. - operationId: apigee.organizations.hostSecurityReports.create + Sets the IAM policy on a deployment, if the policy already exists it + will be replaced. For more information, see [Manage users, roles, and + permissions using the + API](https://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). + You must have the `apigee.deployments.setIamPolicy` permission to call + this API. + operationId: apigee.organizations.environments.deployments.setIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportQuery' + $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15462,75 +16696,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: organizationsId required: true schema: type: string - get: - description: Return a list of Security Reports at host level. - operationId: apigee.organizations.hostSecurityReports.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListSecurityReportsResponse - parameters: - in: path - name: organizationsId + name: environmentsId required: true schema: type: string - - in: query - name: status - schema: - type: string - - in: query - name: envgroupHostname - schema: - type: string - - in: query - name: submittedBy - schema: - type: string - - in: query - name: dataset - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: from - schema: - type: string - - in: query - name: to + - in: path + name: deploymentsId + required: true schema: type: string - /v1/organizations/{organizationsId}/hostSecurityReports/{hostSecurityReportsId}/resultView: + /v1/organizations/{organizationsId}/environments/{environmentsId}/deployments/{deploymentsId}:getIamPolicy: parameters: *ref_1 get: description: >- - After the query is completed, use this API to view the query result when - result size is small. - operationId: apigee.organizations.hostSecurityReports.getResultView + Gets the IAM policy on a deployment. For more information, see [Manage + users, roles, and permissions using the + API](https://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). + You must have the `apigee.deployments.getIamPolicy` permission to call + this API. + operationId: apigee.organizations.environments.deployments.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15542,8 +16734,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityReportResultView + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: organizationsId @@ -15551,15 +16742,34 @@ paths: schema: type: string - in: path - name: hostSecurityReportsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/optimizedHostStats/{optimizedHostStatsId}: + - in: path + name: deploymentsId + required: true + schema: + type: string + - in: query + name: options.requestedPolicyVersion + schema: + type: integer + format: int32 + /v1/organizations/{organizationsId}/environments/{environmentsId}/deployments/{deploymentsId}:testIamPermissions: parameters: *ref_1 - get: - description: Similar to GetHostStats except that the response is less verbose. - operationId: apigee.organizations.optimizedHostStats.get + post: + description: >- + Tests the permissions of a user on a deployment, and returns a subset of + permissions that the user has on the deployment. If the deployment does + not exist, an empty permission set is returned (a NOT_FOUND error is not + returned). + operationId: apigee.organizations.environments.deployments.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15571,7 +16781,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1OptimizedStats' + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' parameters: - in: path name: organizationsId @@ -15579,77 +16789,23 @@ paths: schema: type: string - in: path - name: optimizedHostStatsId + name: environmentsId required: true schema: type: string - - in: query - name: topk - schema: - type: string - - in: query - name: envgroupHostname - schema: - type: string - - in: query - name: tsAscending - schema: - type: boolean - - in: query - name: offset - schema: - type: string - - in: query - name: accuracy - schema: - type: string - - in: query - name: limit - schema: - type: string - - in: query - name: sortby - schema: - type: string - - in: query - name: tzo - schema: - type: string - - in: query - name: realtime - schema: - type: boolean - - in: query - name: filter - schema: - type: string - - in: query - name: select - schema: - type: string - - in: query - name: timeUnit - schema: - type: string - - in: query - name: sort - schema: - type: string - - in: query - name: timeRange + - in: path + name: deploymentsId + required: true schema: type: string - /v1/organizations/{organizationsId}/hostStats/{hostStatsId}: + /v1/organizations/{organizationsId}/environments/{environmentsId}/flowhooks/{flowhooksId}: parameters: *ref_1 get: description: >- - Retrieve metrics grouped by dimensions in host level. The types of - metrics you can retrieve include traffic, message counts, API call - latency, response size, and cache hits and counts. Dimensions let you - view metrics in meaningful groups. You can optionally pass dimensions as - path parameters to the `stats` API. If dimensions are not specified, the - metrics are computed on the entire set of data for the given time range. - operationId: apigee.organizations.hostStats.get + Returns the name of the shared flow attached to the specified flow hook. + If there's no shared flow attached to the flow hook, the API does not + return an error; it simply does not return a name in the response. + operationId: apigee.organizations.environments.flowhooks.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15661,7 +16817,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Stats' + $ref: '#/components/schemas/GoogleCloudApigeeV1FlowHook' parameters: - in: path name: organizationsId @@ -15669,71 +16825,54 @@ paths: schema: type: string - in: path - name: hostStatsId + name: environmentsId required: true schema: type: string - - in: query - name: timeUnit - schema: - type: string - - in: query - name: offset - schema: - type: string - - in: query - name: tzo - schema: - type: string - - in: query - name: tsAscending - schema: - type: boolean - - in: query - name: envgroupHostname - schema: - type: string - - in: query - name: select - schema: - type: string - - in: query - name: timeRange - schema: - type: string - - in: query - name: limit - schema: - type: string - - in: query - name: realtime - schema: - type: boolean - - in: query - name: accuracy - schema: - type: string - - in: query - name: topk + - in: path + name: flowhooksId + required: true schema: type: string - - in: query - name: sort + put: + description: Attaches a shared flow to a flow hook. + operationId: apigee.organizations.environments.flowhooks.attachSharedFlowToFlowHook + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1FlowHook' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1FlowHook' + parameters: + - in: path + name: organizationsId + required: true schema: type: string - - in: query - name: filter + - in: path + name: environmentsId + required: true schema: type: string - - in: query - name: sortby + - in: path + name: flowhooksId + required: true schema: type: string - /v1/organizations/{organizationsId}/reports/{reportsId}: - parameters: *ref_1 - get: - description: Retrieve a custom report definition. - operationId: apigee.organizations.reports.get + delete: + description: Detaches a shared flow from a flow hook. + operationId: apigee.organizations.environments.flowhooks.detachSharedFlowFromFlowHook security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15745,7 +16884,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' + $ref: '#/components/schemas/GoogleCloudApigeeV1FlowHook' parameters: - in: path name: organizationsId @@ -15753,18 +16892,30 @@ paths: schema: type: string - in: path - name: reportsId + name: environmentsId required: true schema: type: string - put: - description: Update an existing custom report definition - operationId: apigee.organizations.reports.update + - in: path + name: flowhooksId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores: + parameters: *ref_1 + post: + description: >- + Creates a keystore or truststore. - Keystore: Contains certificates and + their associated keys. - Truststore: Contains trusted certificates used + to validate a server's certificate. These certificates are typically + self-signed certificates or certificates that are not signed by a + trusted CA. + operationId: apigee.organizations.environments.keystores.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' + $ref: '#/components/schemas/GoogleCloudApigeeV1Keystore' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15776,7 +16927,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' + $ref: '#/components/schemas/GoogleCloudApigeeV1Keystore' parameters: - in: path name: organizationsId @@ -15784,13 +16935,19 @@ paths: schema: type: string - in: path - name: reportsId + name: environmentsId required: true schema: type: string + - in: query + name: name + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}: + parameters: *ref_1 delete: - description: Deletes an existing custom report definition - operationId: apigee.organizations.reports.delete + description: Deletes a keystore or truststore. + operationId: apigee.organizations.environments.keystores.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15802,8 +16959,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DeleteCustomReportResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1Keystore' parameters: - in: path name: organizationsId @@ -15811,15 +16967,18 @@ paths: schema: type: string - in: path - name: reportsId + name: environmentsId + required: true + schema: + type: string + - in: path + name: keystoresId required: true schema: type: string - /v1/organizations/{organizationsId}/reports: - parameters: *ref_1 get: - description: Return a list of Custom Reports - operationId: apigee.organizations.reports.list + description: Gets a keystore or truststore. + operationId: apigee.organizations.environments.keystores.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15831,33 +16990,45 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListCustomReportsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1Keystore' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: expand + - in: path + name: environmentsId + required: true schema: - type: boolean + type: string + - in: path + name: keystoresId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases: + parameters: *ref_1 post: description: >- - Creates a Custom Report for an Organization. A Custom Report provides - Apigee Customers to create custom dashboards in addition to the standard - dashboards which are provided. The Custom Report in its simplest form - contains specifications about metrics, dimensions and filters. It is - important to note that the custom report by itself does not provide an - executable entity. The Edge UI converts the custom report definition - into an analytics query and displays the result in a chart. - operationId: apigee.organizations.reports.create + Creates an alias from a key/certificate pair. The structure of the + request is controlled by the `format` query parameter: - `keycertfile` - + Separate PEM-encoded key and certificate files are uploaded. Set + `Content-Type: multipart/form-data` and include the `keyFile`, + `certFile`, and `password` (if keys are encrypted) fields in the request + body. If uploading to a truststore, omit `keyFile`. - `pkcs12` - A + PKCS12 file is uploaded. Set `Content-Type: multipart/form-data`, + provide the file in the `file` field, and include the `password` field + if the file is encrypted in the request body. - `selfsignedcert` - A new + private key and certificate are generated. Set `Content-Type: + application/json` and include CertificateGenerationSpec in the request + body. + operationId: apigee.organizations.environments.keystores.aliases.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' + $ref: '#/components/schemas/GoogleApiHttpBody' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15869,22 +17040,48 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' + $ref: '#/components/schemas/GoogleCloudApigeeV1Alias' parameters: - in: path name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps/{appsId}/keys/{keysId}/apiproducts/{apiproductsId}: + - in: path + name: environmentsId + required: true + schema: + type: string + - in: path + name: keystoresId + required: true + schema: + type: string + - in: query + name: alias + schema: + type: string + - in: query + name: format + schema: + type: string + - in: query + name: ignoreExpiryValidation + schema: + type: boolean + - in: query + name: _password + schema: + type: string + - in: query + name: ignoreNewlineValidation + schema: + type: boolean + /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases/{aliasesId}: parameters: *ref_1 - delete: - description: >- - Removes an API product from an app's consumer key. After the API product - is removed, the app cannot access the API resources defined in that API - product. **Note**: The consumer key is not removed, only its association - with the API product. - operationId: apigee.organizations.appgroups.apps.keys.apiproducts.delete + get: + description: Gets an alias. + operationId: apigee.organizations.environments.keystores.aliases.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15896,7 +17093,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' + $ref: '#/components/schemas/GoogleCloudApigeeV1Alias' parameters: - in: path name: organizationsId @@ -15904,35 +17101,23 @@ paths: schema: type: string - in: path - name: appgroupsId - required: true - schema: - type: string - - in: path - name: appsId + name: environmentsId required: true schema: type: string - in: path - name: keysId + name: keystoresId required: true schema: type: string - in: path - name: apiproductsId + name: aliasesId required: true schema: type: string - post: - description: >- - Approves or revokes the consumer key for an API product. After a - consumer key is approved, the app can use it to access APIs. A consumer - key that is revoked or pending cannot be used to access an API. Any - access tokens associated with a revoked consumer key will remain active. - However, Apigee checks the status of the consumer key and if set to - `revoked` will not allow access to the API. - operationId: >- - apigee.organizations.appgroups.apps.keys.apiproducts.updateAppGroupAppKeyApiProduct + delete: + description: Deletes an alias. + operationId: apigee.organizations.environments.keystores.aliases.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15944,7 +17129,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudApigeeV1Alias' parameters: - in: path name: organizationsId @@ -15952,36 +17137,30 @@ paths: schema: type: string - in: path - name: appgroupsId - required: true - schema: - type: string - - in: path - name: appsId + name: environmentsId required: true schema: type: string - in: path - name: keysId + name: keystoresId required: true schema: type: string - in: path - name: apiproductsId + name: aliasesId required: true schema: type: string - - in: query - name: action - schema: - type: string - /v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps/{appsId}/keys/{keysId}: - parameters: *ref_1 - get: + put: description: >- - Gets details for a consumer key for a AppGroup app, including the key - and secret value, associated API products, and other information. - operationId: apigee.organizations.appgroups.apps.keys.get + Updates the certificate in an alias. The updated certificate must be in + PEM- or DER-encoded X.509 format. + operationId: apigee.organizations.environments.keystores.aliases.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleApiHttpBody' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15993,7 +17172,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' + $ref: '#/components/schemas/GoogleCloudApigeeV1Alias' parameters: - in: path name: organizationsId @@ -16001,26 +17180,35 @@ paths: schema: type: string - in: path - name: appgroupsId + name: environmentsId required: true schema: type: string - in: path - name: appsId + name: keystoresId required: true schema: type: string - in: path - name: keysId + name: aliasesId required: true schema: - type: string - delete: + type: string + - in: query + name: ignoreExpiryValidation + schema: + type: boolean + - in: query + name: ignoreNewlineValidation + schema: + type: boolean + /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases/{aliasesId}/csr: + parameters: *ref_1 + get: description: >- - Deletes an app's consumer key and removes all API products associated - with the app. After the consumer key is deleted, it cannot be used to - access any APIs. - operationId: apigee.organizations.appgroups.apps.keys.delete + Generates a PKCS #10 Certificate Signing Request for the private key in + an alias. + operationId: apigee.organizations.environments.keystores.aliases.csr security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16032,7 +17220,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: organizationsId @@ -16040,36 +17228,25 @@ paths: schema: type: string - in: path - name: appgroupsId + name: environmentsId required: true schema: type: string - in: path - name: appsId + name: keystoresId required: true schema: type: string - in: path - name: keysId + name: aliasesId required: true schema: type: string - post: - description: >- - Adds an API product to an AppGroupAppKey, enabling the app that holds - the key to access the API resources bundled in the API product. In - addition, you can add attributes to the AppGroupAppKey. This API - replaces the existing attributes with those specified in the request. - Include or exclude any existing attributes that you want to retain or - delete, respectively. You can use the same key to access all API - products associated with the app. - operationId: apigee.organizations.appgroups.apps.keys.updateAppGroupAppKey - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1UpdateAppGroupAppKeyRequest + /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases/{aliasesId}/certificate: + parameters: *ref_1 + get: + description: Gets the certificate from an alias in PEM-encoded form. + operationId: apigee.organizations.environments.keystores.aliases.getCertificate security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16081,7 +17258,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: organizationsId @@ -16089,42 +17266,30 @@ paths: schema: type: string - in: path - name: appgroupsId + name: environmentsId required: true schema: type: string - in: path - name: appsId + name: keystoresId required: true schema: type: string - in: path - name: keysId + name: aliasesId required: true schema: type: string - /v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps/{appsId}/keys: + /v1/organizations/{organizationsId}/environments/{environmentsId}/targetservers: parameters: *ref_1 post: - description: >- - Creates a custom consumer key and secret for a AppGroup app. This is - particularly useful if you want to migrate existing consumer keys and - secrets to Apigee from another system. Consumer keys and secrets can - contain letters, numbers, underscores, and hyphens. No other special - characters are allowed. To avoid service disruptions, a consumer key and - secret should not exceed 2 KBs each. **Note**: When creating the - consumer key and secret, an association to API products will not be - made. Therefore, you should not specify the associated API products in - your request. Instead, use the ProductizeAppGroupAppKey API to make the - association after the consumer key and secret are created. If a consumer - key and secret already exist, you can keep them or delete them using the - DeleteAppGroupAppKey API. - operationId: apigee.organizations.appgroups.apps.keys.create + description: Creates a TargetServer in the specified environment. + operationId: apigee.organizations.environments.targetservers.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' + $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16136,7 +17301,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' + $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' parameters: - in: path name: organizationsId @@ -16144,34 +17309,21 @@ paths: schema: type: string - in: path - name: appgroupsId + name: environmentsId required: true schema: type: string - - in: path - name: appsId - required: true + - in: query + name: name schema: type: string - /v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps/{appsId}: + /v1/organizations/{organizationsId}/environments/{environmentsId}/targetservers/{targetserversId}: parameters: *ref_1 - put: + delete: description: >- - Updates the details for an AppGroup app. In addition, you can add an API - product to an AppGroup app and automatically generate an API key for the - app to use when calling APIs in the API product. If you want to use an - existing API key for the API product, add the API product to the API key - using the UpdateAppGroupAppKey API. Using this API, you cannot update - the app name, as it is the primary key used to identify the app and - cannot be changed. This API replaces the existing attributes with those - specified in the request. Include or exclude any existing attributes - that you want to retain or delete, respectively. - operationId: apigee.organizations.appgroups.apps.update - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' + Deletes a TargetServer from an environment. Returns the deleted + TargetServer resource. + operationId: apigee.organizations.environments.targetservers.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16183,7 +17335,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' + $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' parameters: - in: path name: organizationsId @@ -16191,22 +17343,18 @@ paths: schema: type: string - in: path - name: appgroupsId + name: environmentsId required: true schema: type: string - in: path - name: appsId + name: targetserversId required: true schema: type: string - - in: query - name: action - schema: - type: string get: - description: Returns the details for an AppGroup app. - operationId: apigee.organizations.appgroups.apps.get + description: Gets a TargetServer resource. + operationId: apigee.organizations.environments.targetservers.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16218,7 +17366,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' + $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' parameters: - in: path name: organizationsId @@ -16226,22 +17374,26 @@ paths: schema: type: string - in: path - name: appgroupsId + name: environmentsId required: true schema: type: string - in: path - name: appsId + name: targetserversId required: true schema: type: string - delete: + put: description: >- - Deletes an AppGroup app. **Note**: The delete operation is asynchronous. - The AppGroup app is deleted immediately, but its associated resources, - such as app keys or access tokens, may take anywhere from a few seconds - to a few minutes to be deleted. - operationId: apigee.organizations.appgroups.apps.delete + Updates an existing TargetServer. Note that this operation has PUT + semantics; it will replace the entirety of the existing TargetServer + with the resource in the request body. + operationId: apigee.organizations.environments.targetservers.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16253,7 +17405,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' + $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' parameters: - in: path name: organizationsId @@ -16261,25 +17413,26 @@ paths: schema: type: string - in: path - name: appgroupsId + name: environmentsId required: true schema: type: string - in: path - name: appsId + name: targetserversId required: true schema: type: string - /v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps: + /v1/organizations/{organizationsId}/environments/{environmentsId}/addonsConfig:setAddonEnablement: parameters: *ref_1 - get: - description: >- - Lists all apps created by an AppGroup in an Apigee organization. - Optionally, you can request an expanded view of the AppGroup apps. Lists - all AppGroupApps in an AppGroup. A maximum of 1000 AppGroup apps are - returned in the response if PageSize is not specified, or if the - PageSize is greater than 1000. - operationId: apigee.organizations.appgroups.apps.list + post: + description: Updates an add-on enablement status of an environment. + operationId: apigee.organizations.environments.addonsConfig.setAddonEnablement + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SetAddonEnablementRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16291,8 +17444,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListAppGroupAppsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -16300,32 +17452,20 @@ paths: schema: type: string - in: path - name: appgroupsId + name: environmentsId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 + /v1/organizations/{organizationsId}/environments/{environmentsId}/references: + parameters: *ref_1 post: - description: >- - Creates an app and associates it with an AppGroup. This API associates - the AppGroup app with the specified API product and auto-generates an - API key for the app to use in calls to API proxies inside that API - product. The `name` is the unique ID of the app that you can use in API - calls. - operationId: apigee.organizations.appgroups.apps.create + description: Creates a Reference in the specified environment. + operationId: apigee.organizations.environments.references.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' + $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16337,7 +17477,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' + $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' parameters: - in: path name: organizationsId @@ -16345,21 +17485,17 @@ paths: schema: type: string - in: path - name: appgroupsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/appgroups/{appgroupsId}: + /v1/organizations/{organizationsId}/environments/{environmentsId}/references/{referencesId}: parameters: *ref_1 delete: description: >- - Deletes an AppGroup. All app and API keys associations with the AppGroup - are also removed. **Warning**: This API will permanently delete the - AppGroup and related artifacts. **Note**: The delete operation is - asynchronous. The AppGroup app is deleted immediately, but its - associated resources, such as apps and API keys, may take anywhere from - a few seconds to a few minutes to be deleted. - operationId: apigee.organizations.appgroups.delete + Deletes a Reference from an environment. Returns the deleted Reference + resource. + operationId: apigee.organizations.environments.references.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16371,7 +17507,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' + $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' parameters: - in: path name: organizationsId @@ -16379,15 +17515,18 @@ paths: schema: type: string - in: path - name: appgroupsId + name: environmentsId + required: true + schema: + type: string + - in: path + name: referencesId required: true schema: type: string get: - description: >- - Returns the AppGroup details for the provided AppGroup name in the - request URI. - operationId: apigee.organizations.appgroups.get + description: Gets a Reference resource. + operationId: apigee.organizations.environments.references.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16399,7 +17538,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' + $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' parameters: - in: path name: organizationsId @@ -16407,23 +17546,26 @@ paths: schema: type: string - in: path - name: appgroupsId + name: environmentsId + required: true + schema: + type: string + - in: path + name: referencesId required: true schema: type: string put: description: >- - Updates an AppGroup. This API replaces the existing AppGroup details - with those specified in the request. Include or exclude any existing - details that you want to retain or delete, respectively. Note that the - state of the AppGroup should be updated using `action`, and not via - AppGroup. - operationId: apigee.organizations.appgroups.update + Updates an existing Reference. Note that this operation has PUT + semantics; it will replace the entirety of the existing Reference with + the resource in the request body. + operationId: apigee.organizations.environments.references.update requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' + $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16435,7 +17577,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' + $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' parameters: - in: path name: organizationsId @@ -16443,27 +17585,29 @@ paths: schema: type: string - in: path - name: appgroupsId + name: environmentsId required: true schema: type: string - - in: query - name: action + - in: path + name: referencesId + required: true schema: type: string - /v1/organizations/{organizationsId}/appgroups: + /v1/organizations/{organizationsId}/environments/{environmentsId}/traceConfig/overrides: parameters: *ref_1 post: description: >- - Creates an AppGroup. Once created, user can register apps under the - AppGroup to obtain secret key and password. At creation time, the - AppGroup's state is set as `active`. - operationId: apigee.organizations.appgroups.create + Creates a trace configuration override. The response contains a + system-generated UUID, that can be used to view, update, or delete the + configuration override. Use the List API to view the existing trace + configuration overrides. + operationId: apigee.organizations.environments.traceConfig.overrides.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16475,19 +17619,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' parameters: - in: path name: organizationsId required: true schema: type: string + - in: path + name: environmentsId + required: true + schema: + type: string get: description: >- - Lists all AppGroups in an organization. A maximum of 1000 AppGroups are - returned in the response if PageSize is not specified, or if the - PageSize is greater than 1000. - operationId: apigee.organizations.appgroups.list + Lists all of the distributed trace configuration overrides in an + environment. + operationId: apigee.organizations.environments.traceConfig.overrides.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16499,13 +17647,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ListAppGroupsResponse' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListTraceConfigOverridesResponse parameters: - in: path name: organizationsId required: true schema: type: string + - in: path + name: environmentsId + required: true + schema: + type: string - in: query name: pageSize schema: @@ -16515,15 +17669,11 @@ paths: name: pageToken schema: type: string - - in: query - name: filter - schema: - type: string - /v1/organizations/{organizationsId}/sites/{sitesId}/apicategories: + /v1/organizations/{organizationsId}/environments/{environmentsId}/traceConfig/overrides/{overridesId}: parameters: *ref_1 get: - description: Returns the API categories associated with a portal. - operationId: apigee.organizations.sites.apicategories.list + description: Gets a trace configuration override. + operationId: apigee.organizations.environments.traceConfig.overrides.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16535,8 +17685,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListApiCategoriesResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' parameters: - in: path name: organizationsId @@ -16544,18 +17693,27 @@ paths: schema: type: string - in: path - name: sitesId + name: environmentsId required: true schema: type: string - post: - description: Creates a new API category. - operationId: apigee.organizations.sites.apicategories.create + - in: path + name: overridesId + required: true + schema: + type: string + patch: + description: >- + Updates a distributed trace configuration override. Note that the + repeated fields have replace semantics when included in the field mask + and that they will be overwritten by the value of the fields in the + request body. + operationId: apigee.organizations.environments.traceConfig.overrides.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategory' + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16567,7 +17725,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategoryResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' parameters: - in: path name: organizationsId @@ -16575,15 +17733,62 @@ paths: schema: type: string - in: path - name: sitesId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/sites/{sitesId}/apicategories/{apicategoriesId}: + - in: path + name: overridesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a distributed trace configuration override. + operationId: apigee.organizations.environments.traceConfig.overrides.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: environmentsId + required: true + schema: + type: string + - in: path + name: overridesId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/stats/{statsId}: parameters: *ref_1 get: - description: Gets an API category. - operationId: apigee.organizations.sites.apicategories.get + description: >- + Retrieve metrics grouped by dimensions. The types of metrics you can + retrieve include traffic, message counts, API call latency, response + size, and cache hits and counts. Dimensions let you view metrics in + meaningful groups. You can optionally pass dimensions as path parameters + to the `stats` API. If dimensions are not specified, the metrics are + computed on the entire set of data for the given time range. + operationId: apigee.organizations.environments.stats.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16595,7 +17800,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategoryResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1Stats' parameters: - in: path name: organizationsId @@ -16603,23 +17808,80 @@ paths: schema: type: string - in: path - name: sitesId + name: environmentsId required: true schema: type: string - in: path - name: apicategoriesId + name: statsId required: true schema: type: string - patch: - description: Updates an API category. - operationId: apigee.organizations.sites.apicategories.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategory' + - in: query + name: select + schema: + type: string + - in: query + name: timeUnit + schema: + type: string + - in: query + name: timeRange + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: sort + schema: + type: string + - in: query + name: sortby + schema: + type: string + - in: query + name: aggTable + schema: + type: string + - in: query + name: limit + schema: + type: string + - in: query + name: offset + schema: + type: string + - in: query + name: topk + schema: + type: string + - in: query + name: tsAscending + schema: + type: boolean + - in: query + name: realtime + schema: + type: boolean + - in: query + name: sonar + schema: + type: boolean + - in: query + name: tzo + schema: + type: string + - in: query + name: accuracy + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/optimizedStats/{optimizedStatsId}: + parameters: *ref_1 + get: + description: Similar to GetStats except that the response is less verbose. + operationId: apigee.organizations.environments.optimizedStats.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16631,7 +17893,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategoryResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1OptimizedStats' parameters: - in: path name: organizationsId @@ -16639,18 +17901,84 @@ paths: schema: type: string - in: path - name: sitesId + name: environmentsId required: true schema: type: string - in: path - name: apicategoriesId + name: optimizedStatsId required: true schema: type: string - delete: - description: Deletes an API category. - operationId: apigee.organizations.sites.apicategories.delete + - in: query + name: select + schema: + type: string + - in: query + name: timeUnit + schema: + type: string + - in: query + name: timeRange + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: sort + schema: + type: string + - in: query + name: sortby + schema: + type: string + - in: query + name: aggTable + schema: + type: string + - in: query + name: limit + schema: + type: string + - in: query + name: offset + schema: + type: string + - in: query + name: topk + schema: + type: string + - in: query + name: tsAscending + schema: + type: boolean + - in: query + name: realtime + schema: + type: boolean + - in: query + name: sonar + schema: + type: boolean + - in: query + name: tzo + schema: + type: string + - in: query + name: accuracy + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/analytics/admin/schemav2: + parameters: *ref_1 + get: + description: >- + Gets a list of metrics and dimensions that can be used to create + analytics queries and reports. Each schema element contains the name of + the field, its associated type, and a flag indicating whether it is a + standard or custom field. + operationId: apigee.organizations.environments.analytics.admin.getSchemav2 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16662,7 +17990,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeleteResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1Schema' parameters: - in: path name: organizationsId @@ -16670,25 +17998,32 @@ paths: schema: type: string - in: path - name: sitesId + name: environmentsId required: true schema: type: string - - in: path - name: apicategoriesId - required: true + - in: query + name: type schema: type: string - /v1/organizations/{organizationsId}/sites/{sitesId}/apidocs/{apidocsId}: + - in: query + name: disableCache + schema: + type: boolean + /v1/organizations/{organizationsId}/environments/{environmentsId}/analytics/exports: parameters: *ref_1 - put: - description: Updates a catalog item. - operationId: apigee.organizations.sites.apidocs.update + post: + description: >- + Submit a data export job to be processed in the background. If the + request is successful, the API returns a 201 status, a URI that can be + used to retrieve the status of the export job, and the `state` value of + "enqueued". + operationId: apigee.organizations.environments.analytics.exports.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDoc' + $ref: '#/components/schemas/GoogleCloudApigeeV1ExportRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16700,7 +18035,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDocResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1Export' parameters: - in: path name: organizationsId @@ -16708,18 +18043,15 @@ paths: schema: type: string - in: path - name: sitesId - required: true - schema: - type: string - - in: path - name: apidocsId + name: environmentsId required: true schema: type: string get: - description: Gets a catalog item. - operationId: apigee.organizations.sites.apidocs.get + description: >- + Lists the details and status of all analytics export jobs belonging to + the parent organization and environment. + operationId: apigee.organizations.environments.analytics.exports.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16731,7 +18063,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDocResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1ListExportsResponse' parameters: - in: path name: organizationsId @@ -16739,18 +18071,19 @@ paths: schema: type: string - in: path - name: sitesId - required: true - schema: - type: string - - in: path - name: apidocsId + name: environmentsId required: true schema: type: string - delete: - description: Deletes a catalog item. - operationId: apigee.organizations.sites.apidocs.delete + /v1/organizations/{organizationsId}/environments/{environmentsId}/analytics/exports/{exportsId}: + parameters: *ref_1 + get: + description: >- + Gets the details and status of an analytics export job. If the export + job is still in progress, its `state` is set to "running". After the + export job has completed successfully, its `state` is set to + "completed". If the export job fails, its `state` is set to `failed`. + operationId: apigee.organizations.environments.analytics.exports.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16762,7 +18095,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeleteResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1Export' parameters: - in: path name: organizationsId @@ -16770,60 +18103,29 @@ paths: schema: type: string - in: path - name: sitesId + name: environmentsId required: true schema: type: string - in: path - name: apidocsId + name: exportsId required: true schema: type: string - /v1/organizations/{organizationsId}/sites/{sitesId}/apidocs: + /v1/organizations/{organizationsId}/environments/{environmentsId}/queries: parameters: *ref_1 - get: - description: Returns the catalog items associated with a portal. - operationId: apigee.organizations.sites.apidocs.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ListApiDocsResponse' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: sitesId - required: true - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string post: - description: Creates a new catalog item. - operationId: apigee.organizations.sites.apidocs.create + description: >- + Submit a query to be processed in the background. If the submission of + the query succeeds, the API returns a 201 status and an ID that refer to + the query. In addition to the HTTP status 201, the `state` of "enqueued" + means that the request succeeded. + operationId: apigee.organizations.environments.queries.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDoc' + $ref: '#/components/schemas/GoogleCloudApigeeV1Query' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16835,7 +18137,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDocResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQuery' parameters: - in: path name: organizationsId @@ -16843,22 +18145,13 @@ paths: schema: type: string - in: path - name: sitesId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/sites/{sitesId}/apidocs/{apidocsId}/documentation: - parameters: *ref_1 - patch: - description: >- - Updates the documentation for the specified catalog item. Note that the - documentation file contents will not be populated in the return message. - operationId: apigee.organizations.sites.apidocs.updateDocumentation - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDocDocumentation' + get: + description: Return a list of Asynchronous Queries + operationId: apigee.organizations.environments.queries.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16871,7 +18164,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ApiDocDocumentationResponse + #/components/schemas/GoogleCloudApigeeV1ListAsyncQueriesResponse parameters: - in: path name: organizationsId @@ -16879,18 +18172,42 @@ paths: schema: type: string - in: path - name: sitesId + name: environmentsId required: true schema: type: string - - in: path - name: apidocsId - required: true + - in: query + name: submittedBy + schema: + type: string + - in: query + name: status + schema: + type: string + - in: query + name: from + schema: + type: string + - in: query + name: to + schema: + type: string + - in: query + name: dataset + schema: + type: string + - in: query + name: inclQueriesWithoutReport schema: type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/queries/{queriesId}: + parameters: *ref_1 get: - description: Gets the documentation for the specified catalog item. - operationId: apigee.organizations.sites.apidocs.getDocumentation + description: >- + Get query status If the query is still in progress, the `state` is set + to "running" After the query has completed successfully, `state` is set + to "completed" + operationId: apigee.organizations.environments.queries.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16902,8 +18219,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ApiDocDocumentationResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQuery' parameters: - in: path name: organizationsId @@ -16911,20 +18227,25 @@ paths: schema: type: string - in: path - name: sitesId + name: environmentsId required: true schema: type: string - in: path - name: apidocsId + name: queriesId required: true schema: type: string - /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/attributes: + /v1/organizations/{organizationsId}/environments/{environmentsId}/queries/{queriesId}/result: parameters: *ref_1 get: - description: Lists all API product attributes. - operationId: apigee.organizations.apiproducts.attributes.list + description: >- + After the query is completed, use this API to retrieve the results. If + the request succeeds, and there is a non-zero result set, the result is + downloaded to the client as a zipped JSON file. The name of the + downloaded file will be: OfflineQueryResult-.zip Example: + `OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip` + operationId: apigee.organizations.environments.queries.getResult security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16936,7 +18257,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: organizationsId @@ -16944,57 +18265,23 @@ paths: schema: type: string - in: path - name: apiproductsId - required: true - schema: - type: string - post: - description: >- - Updates or creates API product attributes. This API **replaces** the - current list of attributes with the attributes specified in the request - body. In this way, you can update existing attributes, add new - attributes, or delete existing attributes by omitting them from the - request body. **Note**: OAuth access tokens and Key Management Service - (KMS) entities (apps, developers, and API products) are cached for 180 - seconds (current default). Any custom attributes associated with - entities also get cached for at least 180 seconds after entity is - accessed during runtime. In this case, the `ExpiresIn` element on the - OAuthV2 policy won't be able to expire an access token in less than 180 - seconds. - operationId: apigee.organizations.apiproducts.attributes - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' - parameters: - - in: path - name: organizationsId + name: environmentsId required: true schema: type: string - in: path - name: apiproductsId + name: queriesId required: true schema: type: string - /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/attributes/{attributesId}: + /v1/organizations/{organizationsId}/environments/{environmentsId}/queries/{queriesId}/resulturl: parameters: *ref_1 get: - description: Gets the value of an API product attribute. - operationId: apigee.organizations.apiproducts.attributes.get + description: >- + After the query is completed, use this API to retrieve the results. If + the request succeeds, and there is a non-zero result set, the result is + sent to the client as a list of urls to JSON files. + operationId: apigee.organizations.environments.queries.getResulturl security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17006,7 +18293,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1GetAsyncQueryResultUrlResponse parameters: - in: path name: organizationsId @@ -17014,30 +18302,20 @@ paths: schema: type: string - in: path - name: apiproductsId + name: environmentsId required: true schema: type: string - in: path - name: attributesId + name: queriesId required: true schema: type: string - post: - description: >- - Updates the value of an API product attribute. **Note**: OAuth access - tokens and Key Management Service (KMS) entities (apps, developers, and - API products) are cached for 180 seconds (current default). Any custom - attributes associated with entities also get cached for at least 180 - seconds after entity is accessed during runtime. In this case, the - `ExpiresIn` element on the OAuthV2 policy won't be able to expire an - access token in less than 180 seconds. - operationId: apigee.organizations.apiproducts.attributes.updateApiProductAttribute - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + /v1/organizations/{organizationsId}/environments/{environmentsId}/caches/{cachesId}: + parameters: *ref_1 + delete: + description: Deletes a cache. + operationId: apigee.organizations.environments.caches.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17049,7 +18327,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -17057,18 +18335,29 @@ paths: schema: type: string - in: path - name: apiproductsId + name: environmentsId required: true schema: type: string - in: path - name: attributesId + name: cachesId required: true schema: type: string - delete: - description: Deletes an API product attribute. - operationId: apigee.organizations.apiproducts.attributes.delete + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityReports: + parameters: *ref_1 + post: + description: >- + Submit a report request to be processed in the background. If the + submission succeeds, the API returns a 200 status and an ID that refer + to the report request. In addition to the HTTP status 200, the `state` + of "enqueued" means that the request succeeded. + operationId: apigee.organizations.environments.securityReports.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportQuery' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17080,7 +18369,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' parameters: - in: path name: organizationsId @@ -17088,20 +18377,13 @@ paths: schema: type: string - in: path - name: apiproductsId - required: true - schema: - type: string - - in: path - name: attributesId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/rateplans: - parameters: *ref_1 get: - description: Lists all the rate plans for an API product. - operationId: apigee.organizations.apiproducts.rateplans.list + description: Return a list of Security Reports + operationId: apigee.organizations.environments.securityReports.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17113,7 +18395,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ListRatePlansResponse' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListSecurityReportsResponse parameters: - in: path name: organizationsId @@ -17121,49 +18404,47 @@ paths: schema: type: string - in: path - name: apiproductsId + name: environmentsId required: true schema: type: string - in: query - name: orderBy + name: submittedBy schema: type: string - in: query - name: expand + name: status schema: - type: boolean + type: string - in: query - name: startKey + name: from schema: type: string - in: query - name: state + name: to schema: type: string - in: query - name: count + name: dataset + schema: + type: string + - in: query + name: pageSize schema: type: integer format: int32 - post: + - in: query + name: pageToken + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityReports/{securityReportsId}: + parameters: *ref_1 + get: description: >- - Create a rate plan that is associated with an API product in an - organization. Using rate plans, API product owners can monetize their - API products by configuring one or more of the following: - Billing - frequency - Initial setup fees for using an API product - Payment - funding model (postpaid only) - Fixed recurring or consumption-based - charges for using an API product - Revenue sharing with developer - partners An API product can have multiple rate plans associated with it - but *only one* rate plan can be active at any point of time. **Note: - From the developer's perspective, they purchase API products not rate - plans. - operationId: apigee.organizations.apiproducts.rateplans.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' + Get security report status If the query is still in progress, the + `state` is set to "running" After the query has completed successfully, + `state` is set to "completed" + operationId: apigee.organizations.environments.securityReports.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17175,7 +18456,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' parameters: - in: path name: organizationsId @@ -17183,15 +18464,25 @@ paths: schema: type: string - in: path - name: apiproductsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/rateplans/{rateplansId}: + - in: path + name: securityReportsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityReports/{securityReportsId}/result: parameters: *ref_1 - delete: - description: Deletes a rate plan. - operationId: apigee.organizations.apiproducts.rateplans.delete + get: + description: >- + After the query is completed, use this API to retrieve the results as + file. If the request succeeds, and there is a non-zero result set, the + result is downloaded to the client as a zipped JSON file. The name of + the downloaded file will be: OfflineQueryResult-.zip Example: + `OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip` + operationId: apigee.organizations.environments.securityReports.getResult security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17203,7 +18494,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: organizationsId @@ -17211,23 +18502,22 @@ paths: schema: type: string - in: path - name: apiproductsId + name: environmentsId required: true schema: type: string - in: path - name: rateplansId + name: securityReportsId required: true schema: type: string - put: - description: Updates an existing rate plan. - operationId: apigee.organizations.apiproducts.rateplans.update - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityReports/{securityReportsId}/resultView: + parameters: *ref_1 + get: + description: >- + After the query is completed, use this API to view the query result when + result size is small. + operationId: apigee.organizations.environments.securityReports.getResultView security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17239,7 +18529,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityReportResultView parameters: - in: path name: organizationsId @@ -17247,18 +18538,25 @@ paths: schema: type: string - in: path - name: apiproductsId + name: environmentsId required: true schema: type: string - in: path - name: rateplansId + name: securityReportsId required: true schema: type: string - get: - description: Gets the details of a rate plan. - operationId: apigee.organizations.apiproducts.rateplans.get + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityStats:queryTabularStats: + parameters: *ref_1 + post: + description: Retrieve security statistics as tabular rows. + operationId: apigee.organizations.environments.securityStats.queryTabularStats + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1QueryTabularStatsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17270,7 +18568,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1QueryTabularStatsResponse parameters: - in: path name: organizationsId @@ -17278,24 +18577,21 @@ paths: schema: type: string - in: path - name: apiproductsId - required: true - schema: - type: string - - in: path - name: rateplansId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/apiproducts: + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityStats:queryTimeSeriesStats: parameters: *ref_1 - get: - description: >- - Lists all API product names for an organization. Filter the list by - passing an `attributename` and `attibutevalue`. The maximum number of - API products returned is 1000. You can paginate the list of API products - returned using the `startKey` and `count` query parameters. - operationId: apigee.organizations.apiproducts.list + post: + description: Retrieve security statistics as a collection of time series. + operationId: apigee.organizations.environments.securityStats.queryTimeSeriesStats + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1QueryTimeSeriesStatsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17308,60 +18604,26 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListApiProductsResponse + #/components/schemas/GoogleCloudApigeeV1QueryTimeSeriesStatsResponse parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: query - name: attributename - schema: - type: string - - in: query - name: startKey - schema: - type: string - - in: query - name: expand - schema: - type: boolean - - in: query - name: attributevalue - schema: - type: string - - in: query - name: count - schema: - type: string - format: int64 - post: - description: >- - Creates an API product in an organization. You create API products after - you have proxied backend services using API proxies. An API product is a - collection of API resources combined with quota settings and metadata - that you can use to deliver customized and productized API bundles to - your developer community. This metadata can include: - Scope - - Environments - API proxies - Extensible profile API products enable you - repackage APIs on the fly, without having to do any additional coding or - configuration. Apigee recommends that you start with a simple API - product including only required elements. You then provision credentials - to apps to enable them to start testing your APIs. After you have - authentication and authorization working against a simple API product, - you can iterate to create finer-grained API products, defining different - sets of API resources for each API product. **WARNING:** - If you don't - specify an API proxy in the request body, *any* app associated with the - product can make calls to *any* API in your entire organization. - If - you don't specify an environment in the request body, the product allows - access to all environments. For more information, see What is an API - product? - operationId: apigee.organizations.apiproducts.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: environmentsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityIncidents/{securityIncidentsId}: + parameters: *ref_1 + get: + description: >- + GetSecurityIncident gets the specified security incident. Returns + NOT_FOUND if security incident is not present for the specified + organization and environment. + operationId: apigee.organizations.environments.securityIncidents.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17373,30 +18635,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' parameters: - in: path name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}: - parameters: *ref_1 - put: - description: >- - Updates an existing API product. You must include all required values, - whether or not you are updating them, as well as any optional values - that you are updating. The API product name required in the request URL - is the internal name of the product, not the display name. While they - may be the same, it depends on whether the API product was created via - UI or API. View the list of API products to identify their internal - names. - operationId: apigee.organizations.apiproducts.update + - in: path + name: environmentsId + required: true + schema: + type: string + - in: path + name: securityIncidentsId + required: true + schema: + type: string + patch: + description: UpdateSecurityIncidents updates an existing security incident. + operationId: apigee.organizations.environments.securityIncidents.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17408,7 +18671,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' parameters: - in: path name: organizationsId @@ -17416,18 +18679,27 @@ paths: schema: type: string - in: path - name: apiproductsId + name: environmentsId + required: true + schema: + type: string + - in: path + name: securityIncidentsId required: true schema: type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityIncidents: + parameters: *ref_1 get: description: >- - Gets configuration details for an API product. The API product name - required in the request URL is the internal name of the product, not the - display name. While they may be the same, it depends on whether the API - product was created via the UI or the API. View the list of API products - to verify the internal name. - operationId: apigee.organizations.apiproducts.get + ListSecurityIncidents lists all the security incident associated with + the environment. + operationId: apigee.organizations.environments.securityIncidents.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17439,7 +18711,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListSecurityIncidentsResponse parameters: - in: path name: organizationsId @@ -17447,21 +18720,36 @@ paths: schema: type: string - in: path - name: apiproductsId + name: environmentsId required: true schema: type: string - delete: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityIncidents:batchUpdate: + parameters: *ref_1 + post: description: >- - Deletes an API product from an organization. Deleting an API product - causes app requests to the resource URIs defined in the API product to - fail. Ensure that you create a new API product to serve existing apps, - unless your intention is to disable access to the resources defined in - the API product. The API product name required in the request URL is the - internal name of the product, not the display name. While they may be - the same, it depends on whether the API product was created via the UI - or the API. View the list of API products to verify the internal name. - operationId: apigee.organizations.apiproducts.delete + BatchUpdateSecurityIncident updates multiple existing security + incidents. + operationId: apigee.organizations.environments.securityIncidents.batchUpdate + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1BatchUpdateSecurityIncidentsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17473,7 +18761,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1BatchUpdateSecurityIncidentsResponse parameters: - in: path name: organizationsId @@ -17481,17 +18770,20 @@ paths: schema: type: string - in: path - name: apiproductsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/operations: + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityActions: parameters: *ref_1 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: apigee.organizations.operations.list + post: + description: CreateSecurityAction creates a SecurityAction. + operationId: apigee.organizations.environments.securityActions.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17503,34 +18795,27 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: environmentsId + required: true schema: type: string - in: query - name: filter + name: securityActionId schema: type: string - /v1/organizations/{organizationsId}/operations/{operationsId}: - parameters: *ref_1 get: description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: apigee.organizations.operations.get + Returns a list of SecurityActions. This returns both enabled and + disabled actions. + operationId: apigee.organizations.environments.securityActions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17542,7 +18827,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListSecurityActionsResponse parameters: - in: path name: organizationsId @@ -17550,10 +18836,23 @@ paths: schema: type: string - in: path - name: operationsId + name: environmentsId required: true schema: type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string /v1/organizations/{organizationsId}/environments/{environmentsId}/securityActions/{securityActionsId}: parameters: *ref_1 get: @@ -17587,21 +18886,14 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityActions/{securityActionsId}:disable: - parameters: *ref_1 - post: - description: >- - Disable a SecurityAction. The `state` of the SecurityAction after - disabling is `DISABLED`. `DisableSecurityAction` can be called on - SecurityActions in the state `ENABLED`; SecurityActions in a different - state (including `DISABLED`) return an error. - operationId: apigee.organizations.environments.securityActions.disable + patch: + description: Update a SecurityAction. + operationId: apigee.organizations.environments.securityActions.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DisableSecurityActionRequest + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17630,13 +18922,14 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityActions: - parameters: *ref_1 - get: - description: >- - Returns a list of SecurityActions. This returns both enabled and - disabled actions. - operationId: apigee.organizations.environments.securityActions.list + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Delete a SecurityAction. + operationId: apigee.organizations.environments.securityActions.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17648,8 +18941,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListSecurityActionsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -17661,27 +18953,26 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + - in: path + name: securityActionsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityActions/{securityActionsId}:enable: + parameters: *ref_1 post: - description: CreateSecurityAction creates a SecurityAction. - operationId: apigee.organizations.environments.securityActions.create + description: >- + Enable a SecurityAction. The `state` of the SecurityAction after + enabling is `ENABLED`. `EnableSecurityAction` can be called on + SecurityActions in the state `DISABLED`; SecurityActions in a different + state (including `ENABLED) return an error. + operationId: apigee.organizations.environments.securityActions.enable requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1EnableSecurityActionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17705,25 +18996,26 @@ paths: required: true schema: type: string - - in: query - name: securityActionId + - in: path + name: securityActionsId + required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityActions/{securityActionsId}:enable: + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityActions/{securityActionsId}:disable: parameters: *ref_1 post: description: >- - Enable a SecurityAction. The `state` of the SecurityAction after - enabling is `ENABLED`. `EnableSecurityAction` can be called on - SecurityActions in the state `DISABLED`; SecurityActions in a different - state (including `ENABLED) return an error. - operationId: apigee.organizations.environments.securityActions.enable + Disable a SecurityAction. The `state` of the SecurityAction after + disabling is `DISABLED`. `DisableSecurityAction` can be called on + SecurityActions in the state `ENABLED`; SecurityActions in a different + state (including `DISABLED`) return an error. + operationId: apigee.organizations.environments.securityActions.disable requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1EnableSecurityActionRequest + #/components/schemas/GoogleCloudApigeeV1DisableSecurityActionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17752,14 +19044,16 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/resourcefiles: + /v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps: parameters: *ref_1 - get: - description: >- - Lists all resource files, optionally filtering by type. For more - information about resource files, see [Resource - files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). - operationId: apigee.organizations.environments.resourcefiles.list + post: + description: Creates a key value map in an environment. + operationId: apigee.organizations.environments.keyvaluemaps.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17771,8 +19065,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListEnvironmentResourcesResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' parameters: - in: path name: organizationsId @@ -17784,22 +19077,11 @@ paths: required: true schema: type: string - - in: query - name: type - schema: - type: string - post: - description: >- - Creates a resource file. Specify the `Content-Type` as - `application/octet-stream` or `multipart/form-data`. For more - information about resource files, see [Resource - files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). - operationId: apigee.organizations.environments.resourcefiles.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + /v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps/{keyvaluemapsId}: + parameters: *ref_1 + delete: + description: Deletes a key value map from an environment. + operationId: apigee.organizations.environments.keyvaluemaps.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17811,7 +19093,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' parameters: - in: path name: organizationsId @@ -17823,22 +19105,19 @@ paths: required: true schema: type: string - - in: query - name: name - schema: - type: string - - in: query - name: type + - in: path + name: keyvaluemapsId + required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/resourcefiles/{type}/{name}: + /v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps/{keyvaluemapsId}/entries/{entriesId}: parameters: *ref_1 get: description: >- - Gets the contents of a resource file. For more information about - resource files, see [Resource - files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). - operationId: apigee.organizations.environments.resourcefiles.get + Get the key value entry value for a key value map scoped to an + organization, environment, or API proxy. **Note**: Supported for Apigee + hybrid 1.8.x and higher. + operationId: apigee.organizations.environments.keyvaluemaps.entries.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17850,7 +19129,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId @@ -17863,21 +19142,23 @@ paths: schema: type: string - in: path - name: type + name: keyvaluemapsId required: true schema: type: string - in: path - name: name + name: entriesId required: true schema: type: string delete: description: >- - Deletes a resource file. For more information about resource files, see - [Resource - files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). - operationId: apigee.organizations.environments.resourcefiles.delete + Deletes a key value entry from a key value map scoped to an + organization, environment, or API proxy. **Notes:** * After you delete + the key value entry, the policy consuming the entry will continue to + function with its cached values for a few minutes. This is expected + behavior. * Supported for Apigee hybrid 1.8.x and higher. + operationId: apigee.organizations.environments.keyvaluemaps.entries.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17889,7 +19170,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId @@ -17902,27 +19183,25 @@ paths: schema: type: string - in: path - name: type + name: keyvaluemapsId required: true schema: type: string - in: path - name: name + name: entriesId required: true schema: type: string put: description: >- - Updates a resource file. Specify the `Content-Type` as - `application/octet-stream` or `multipart/form-data`. For more - information about resource files, see [Resource - files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). - operationId: apigee.organizations.environments.resourcefiles.update + Update key value entry scoped to an organization, environment, or API + proxy for an existing key. + operationId: apigee.organizations.environments.keyvaluemaps.entries.update requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17934,7 +19213,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId @@ -17947,23 +19226,28 @@ paths: schema: type: string - in: path - name: type + name: keyvaluemapsId required: true schema: type: string - in: path - name: name + name: entriesId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/resourcefiles/{type}: + /v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps/{keyvaluemapsId}/entries: parameters: *ref_1 - get: + post: description: >- - Lists all resource files, optionally filtering by type. For more - information about resource files, see [Resource - files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). - operationId: apigee.organizations.environments.resourcefiles.listEnvironmentResources + Creates key value entries in a key value map scoped to an organization, + environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x + and higher. + operationId: apigee.organizations.environments.keyvaluemaps.entries.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17975,8 +19259,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListEnvironmentResourcesResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId @@ -17989,15 +19272,16 @@ paths: schema: type: string - in: path - name: type + name: keyvaluemapsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/caches/{cachesId}: - parameters: *ref_1 - delete: - description: Deletes a cache. - operationId: apigee.organizations.environments.caches.delete + get: + description: >- + Lists key value entries for key values maps scoped to an organization, + environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x + and higher. + operationId: apigee.organizations.environments.keyvaluemaps.entries.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18009,7 +19293,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListKeyValueEntriesResponse parameters: - in: path name: organizationsId @@ -18022,17 +19307,24 @@ paths: schema: type: string - in: path - name: cachesId + name: keyvaluemapsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/deployments/{deploymentsId}: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/organizations/{organizationsId}/deployments: parameters: *ref_1 get: - description: >- - Gets a particular deployment of Api proxy or a shared flow in an - environment - operationId: apigee.organizations.environments.deployments.get + description: Lists all deployments of API proxies or shared flows. + operationId: apigee.organizations.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18044,37 +19336,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: deploymentsId - required: true + - in: query + name: sharedFlows schema: - type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/deployments/{deploymentsId}:testIamPermissions: + type: boolean + /v1/organizations/{organizationsId}/envgroups: parameters: *ref_1 post: - description: >- - Tests the permissions of a user on a deployment, and returns a subset of - permissions that the user has on the deployment. If the deployment does - not exist, an empty permission set is returned (a NOT_FOUND error is not - returned). - operationId: apigee.organizations.environments.deployments.testIamPermissions + description: Creates a new environment group. + operationId: apigee.organizations.envgroups.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsRequest' + $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroup' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18086,33 +19369,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: deploymentsId - required: true + - in: query + name: name schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/deployments/{deploymentsId}:getIamPolicy: - parameters: *ref_1 get: - description: >- - Gets the IAM policy on a deployment. For more information, see [Manage - users, roles, and permissions using the - API](https://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). - You must have the `apigee.deployments.getIamPolicy` permission to call - this API. - operationId: apigee.organizations.environments.deployments.getIamPolicy + description: Lists all environment groups. + operationId: apigee.organizations.envgroups.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18124,77 +19394,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListEnvironmentGroupsResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: deploymentsId - required: true - schema: - type: string - in: query - name: options.requestedPolicyVersion - schema: - type: integer - format: int32 - /v1/organizations/{organizationsId}/environments/{environmentsId}/deployments/{deploymentsId}:setIamPolicy: - parameters: *ref_1 - post: - description: >- - Sets the IAM policy on a deployment, if the policy already exists it - will be replaced. For more information, see [Manage users, roles, and - permissions using the - API](https://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). - You must have the `apigee.deployments.setIamPolicy` permission to call - this API. - operationId: apigee.organizations.environments.deployments.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1Policy' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: deploymentsId - required: true + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/deployments: + /v1/organizations/{organizationsId}/envgroups/{envgroupsId}: parameters: *ref_1 get: - description: Lists all deployments of API proxies or shared flows in an environment. - operationId: apigee.organizations.environments.deployments.list + description: Gets an environment group. + operationId: apigee.organizations.envgroups.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18206,8 +19427,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroup' parameters: - in: path name: organizationsId @@ -18215,19 +19435,18 @@ paths: schema: type: string - in: path - name: environmentsId + name: envgroupsId required: true schema: type: string - - in: query - name: sharedFlows - schema: - type: boolean - /v1/organizations/{organizationsId}/environments/{environmentsId}/references/{referencesId}: - parameters: *ref_1 - get: - description: Gets a Reference resource. - operationId: apigee.organizations.environments.references.get + patch: + description: Updates an environment group. + operationId: apigee.organizations.envgroups.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroup' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18239,7 +19458,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -18247,26 +19466,18 @@ paths: schema: type: string - in: path - name: environmentsId + name: envgroupsId required: true schema: type: string - - in: path - name: referencesId - required: true + - in: query + name: updateMask schema: type: string - put: - description: >- - Updates an existing Reference. Note that this operation has PUT - semantics; it will replace the entirety of the existing Reference with - the resource in the request body. - operationId: apigee.organizations.environments.references.update - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' + format: google-fieldmask + delete: + description: Deletes an environment group. + operationId: apigee.organizations.envgroups.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18278,7 +19489,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -18286,20 +19497,15 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: referencesId + name: envgroupsId required: true schema: type: string - delete: - description: >- - Deletes a Reference from an environment. Returns the deleted Reference - resource. - operationId: apigee.organizations.environments.references.delete + /v1/organizations/{organizationsId}/envgroups/{envgroupsId}/deployedIngressConfig: + parameters: *ref_1 + get: + description: Gets the deployed ingress configuration for an environment group. + operationId: apigee.organizations.envgroups.getDeployedIngressConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18311,7 +19517,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' + $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroupConfig' parameters: - in: path name: organizationsId @@ -18319,25 +19525,25 @@ paths: schema: type: string - in: path - name: environmentsId + name: envgroupsId required: true schema: type: string - - in: path - name: referencesId - required: true + - in: query + name: view schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/references: + /v1/organizations/{organizationsId}/envgroups/{envgroupsId}/attachments: parameters: *ref_1 post: - description: Creates a Reference in the specified environment. - operationId: apigee.organizations.environments.references.create + description: Creates a new attachment of an environment to an environment group. + operationId: apigee.organizations.envgroups.attachments.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1EnvironmentGroupAttachment security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18349,7 +19555,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -18357,23 +19563,13 @@ paths: schema: type: string - in: path - name: environmentsId + name: envgroupsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityIncidents:batchUpdate: - parameters: *ref_1 - post: - description: >- - BatchUpdateSecurityIncident updates multiple existing security - incidents. - operationId: apigee.organizations.environments.securityIncidents.batchUpdate - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1BatchUpdateSecurityIncidentsRequest + get: + description: Lists all attachments of an environment group. + operationId: apigee.organizations.envgroups.attachments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18386,7 +19582,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1BatchUpdateSecurityIncidentsResponse + #/components/schemas/GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse parameters: - in: path name: organizationsId @@ -18394,20 +19590,24 @@ paths: schema: type: string - in: path - name: environmentsId + name: envgroupsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityIncidents/{securityIncidentsId}: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/organizations/{organizationsId}/envgroups/{envgroupsId}/attachments/{attachmentsId}: parameters: *ref_1 - patch: - description: UpdateSecurityIncidents updates an existing security incident. - operationId: apigee.organizations.environments.securityIncidents.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' + get: + description: Gets an environment group attachment. + operationId: apigee.organizations.envgroups.attachments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18419,7 +19619,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1EnvironmentGroupAttachment parameters: - in: path name: organizationsId @@ -18427,26 +19628,18 @@ paths: schema: type: string - in: path - name: environmentsId + name: envgroupsId required: true schema: type: string - in: path - name: securityIncidentsId + name: attachmentsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - get: - description: >- - GetSecurityIncident gets the specified security incident. Returns - NOT_FOUND if security incident is not present for the specified - organization and environment. - operationId: apigee.organizations.environments.securityIncidents.get + delete: + description: Deletes an environment group attachment. + operationId: apigee.organizations.envgroups.attachments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18458,7 +19651,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -18466,22 +19659,28 @@ paths: schema: type: string - in: path - name: environmentsId + name: envgroupsId required: true schema: type: string - in: path - name: securityIncidentsId + name: attachmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityIncidents: + /v1/organizations/{organizationsId}/instances: parameters: *ref_1 - get: + post: description: >- - ListSecurityIncidents lists all the security incident associated with - the environment. - operationId: apigee.organizations.environments.securityIncidents.list + Creates an Apigee runtime instance. The instance is accessible from the + authorized network configured on the organization. **Note:** Not + supported for Apigee hybrid. + operationId: apigee.organizations.instances.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Instance' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18493,23 +19692,36 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListSecurityIncidentsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId required: true schema: type: string + get: + description: >- + Lists all Apigee runtime instances for the organization. **Note:** Not + supported for Apigee hybrid. + operationId: apigee.organizations.instances.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1ListInstancesResponse' + parameters: - in: path - name: environmentsId + name: organizationsId required: true schema: type: string - - in: query - name: filter - schema: - type: string - in: query name: pageSize schema: @@ -18519,13 +19731,14 @@ paths: name: pageToken schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/sharedflows/{sharedflowsId}/revisions/{revisionsId}/deployments: + /v1/organizations/{organizationsId}/instances/{instancesId}: parameters: *ref_1 - get: + delete: description: >- - Gets the deployment of a shared flow revision and actual state reported - by runtime pods. - operationId: apigee.organizations.environments.sharedflows.revisions.getDeployments + Deletes an Apigee runtime instance. The instance stops serving requests + and the runtime data is deleted. **Note:** Not supported for Apigee + hybrid. + operationId: apigee.organizations.instances.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18537,7 +19750,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -18545,29 +19758,49 @@ paths: schema: type: string - in: path - name: environmentsId + name: instancesId required: true schema: type: string + get: + description: >- + Gets the details for an Apigee runtime instance. **Note:** Not supported + for Apigee hybrid. + operationId: apigee.organizations.instances.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Instance' + parameters: - in: path - name: sharedflowsId + name: organizationsId required: true schema: type: string - in: path - name: revisionsId + name: instancesId required: true schema: type: string - delete: - description: >- - Undeploys a shared flow revision from an environment. For a request path - `organizations/{org}/environments/{env}/sharedflows/{sf}/revisions/{rev}/deployments`, - two permissions are required: * `apigee.deployments.delete` on the - resource `organizations/{org}/environments/{env}` * - `apigee.sharedflowrevisions.undeploy` on the resource - `organizations/{org}/sharedflows/{sf}/revisions/{rev}` - operationId: apigee.organizations.environments.sharedflows.revisions.undeploy + patch: + description: >- + Updates an Apigee runtime instance. You can update the fields described + in NodeConfig. No other fields will be updated. **Note:** Not supported + for Apigee hybrid. + operationId: apigee.organizations.instances.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Instance' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18579,7 +19812,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -18587,33 +19820,26 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: sharedflowsId + name: instancesId required: true schema: type: string - - in: path - name: revisionsId - required: true + - in: query + name: updateMask schema: type: string + format: google-fieldmask + /v1/organizations/{organizationsId}/instances/{instancesId}:reportStatus: + parameters: *ref_1 post: - description: >- - Deploys a revision of a shared flow. If another revision of the same - shared flow is currently deployed, set the `override` parameter to - `true` to have this revision replace the currently deployed revision. - You cannot use a shared flow until it has been deployed to an - environment. For a request path - `organizations/{org}/environments/{env}/sharedflows/{sf}/revisions/{rev}/deployments`, - two permissions are required: * `apigee.deployments.create` on the - resource `organizations/{org}/environments/{env}` * - `apigee.sharedflowrevisions.deploy` on the resource - `organizations/{org}/sharedflows/{sf}/revisions/{rev}` - operationId: apigee.organizations.environments.sharedflows.revisions.deploy + description: Reports the latest status for a runtime instance. + operationId: apigee.organizations.instances.reportStatus + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ReportInstanceStatusRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18625,7 +19851,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ReportInstanceStatusResponse parameters: - in: path name: organizationsId @@ -18633,33 +19860,48 @@ paths: schema: type: string - in: path - name: environmentsId + name: instancesId required: true schema: type: string + /v1/organizations/{organizationsId}/instances/{instancesId}/canaryevaluations: + parameters: *ref_1 + post: + description: Creates a new canary evaluation for an organization. + operationId: apigee.organizations.instances.canaryevaluations.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1CanaryEvaluation' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: - in: path - name: sharedflowsId + name: organizationsId required: true schema: type: string - in: path - name: revisionsId + name: instancesId required: true schema: type: string - - in: query - name: serviceAccount - schema: - type: string - - in: query - name: override - schema: - type: boolean - /v1/organizations/{organizationsId}/environments/{environmentsId}/sharedflows/{sharedflowsId}/deployments: + /v1/organizations/{organizationsId}/instances/{instancesId}/canaryevaluations/{canaryevaluationsId}: parameters: *ref_1 get: - description: Lists all deployments of a shared flow in an environment. - operationId: apigee.organizations.environments.sharedflows.deployments.list + description: Gets a CanaryEvaluation for an organization. + operationId: apigee.organizations.instances.canaryevaluations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18671,8 +19913,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1CanaryEvaluation' parameters: - in: path name: organizationsId @@ -18680,23 +19921,27 @@ paths: schema: type: string - in: path - name: environmentsId + name: instancesId required: true schema: type: string - in: path - name: sharedflowsId + name: canaryevaluationsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/queries/{queriesId}/resulturl: + /v1/organizations/{organizationsId}/instances/{instancesId}/attachments: parameters: *ref_1 - get: + post: description: >- - After the query is completed, use this API to retrieve the results. If - the request succeeds, and there is a non-zero result set, the result is - sent to the client as a list of urls to JSON files. - operationId: apigee.organizations.environments.queries.getResulturl + Creates a new attachment of an environment to an instance. **Note:** Not + supported for Apigee hybrid. + operationId: apigee.organizations.instances.attachments.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1InstanceAttachment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18708,8 +19953,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1GetAsyncQueryResultUrlResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -18717,23 +19961,15 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: queriesId + name: instancesId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/queries/{queriesId}: - parameters: *ref_1 get: description: >- - Get query status If the query is still in progress, the `state` is set - to "running" After the query has completed successfully, `state` is set - to "completed" - operationId: apigee.organizations.environments.queries.get + Lists all attachments to an instance. **Note:** Not supported for Apigee + hybrid. + operationId: apigee.organizations.instances.attachments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18745,7 +19981,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQuery' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListInstanceAttachmentsResponse parameters: - in: path name: organizationsId @@ -18753,25 +19990,24 @@ paths: schema: type: string - in: path - name: environmentsId + name: instancesId required: true schema: type: string - - in: path - name: queriesId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/queries/{queriesId}/result: + /v1/organizations/{organizationsId}/instances/{instancesId}/attachments/{attachmentsId}: parameters: *ref_1 get: - description: >- - After the query is completed, use this API to retrieve the results. If - the request succeeds, and there is a non-zero result set, the result is - downloaded to the client as a zipped JSON file. The name of the - downloaded file will be: OfflineQueryResult-.zip Example: - `OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip` - operationId: apigee.organizations.environments.queries.getResult + description: Gets an attachment. **Note:** Not supported for Apigee hybrid. + operationId: apigee.organizations.instances.attachments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18783,7 +20019,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleCloudApigeeV1InstanceAttachment' parameters: - in: path name: organizationsId @@ -18791,29 +20027,18 @@ paths: schema: type: string - in: path - name: environmentsId + name: instancesId required: true schema: type: string - in: path - name: queriesId + name: attachmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/queries: - parameters: *ref_1 - post: - description: >- - Submit a query to be processed in the background. If the submission of - the query succeeds, the API returns a 201 status and an ID that refer to - the query. In addition to the HTTP status 201, the `state` of "enqueued" - means that the request succeeded. - operationId: apigee.organizations.environments.queries.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Query' + delete: + description: Deletes an attachment. **Note:** Not supported for Apigee hybrid. + operationId: apigee.organizations.instances.attachments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18825,7 +20050,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQuery' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -18833,13 +20058,22 @@ paths: schema: type: string - in: path - name: environmentsId + name: instancesId + required: true + schema: + type: string + - in: path + name: attachmentsId required: true schema: type: string + /v1/organizations/{organizationsId}/instances/{instancesId}/natAddresses: + parameters: *ref_1 get: - description: Return a list of Asynchronous Queries - operationId: apigee.organizations.environments.queries.list + description: >- + Lists the NAT addresses for an Apigee instance. **Note:** Not supported + for Apigee hybrid. + operationId: apigee.organizations.instances.natAddresses.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18852,7 +20086,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListAsyncQueriesResponse + #/components/schemas/GoogleCloudApigeeV1ListNatAddressesResponse parameters: - in: path name: organizationsId @@ -18860,47 +20094,33 @@ paths: schema: type: string - in: path - name: environmentsId + name: instancesId required: true schema: type: string - in: query - name: to - schema: - type: string - - in: query - name: dataset - schema: - type: string - - in: query - name: submittedBy - schema: - type: string - - in: query - name: from - schema: - type: string - - in: query - name: inclQueriesWithoutReport + name: pageSize schema: - type: string + type: integer + format: int32 - in: query - name: status + name: pageToken schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/targetservers/{targetserversId}: - parameters: *ref_1 - put: + post: description: >- - Updates an existing TargetServer. Note that this operation has PUT - semantics; it will replace the entirety of the existing TargetServer - with the resource in the request body. - operationId: apigee.organizations.environments.targetservers.update + Creates a NAT address. The address is created in the RESERVED state and + a static external IP address will be provisioned. At this time, the + instance will not use this IP address for Internet egress traffic. The + address can be activated for use once any required firewall IP + whitelisting has been completed. **Note:** Not supported for Apigee + hybrid. + operationId: apigee.organizations.instances.natAddresses.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' + $ref: '#/components/schemas/GoogleCloudApigeeV1NatAddress' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18912,7 +20132,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -18920,18 +20140,17 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: targetserversId + name: instancesId required: true schema: type: string + /v1/organizations/{organizationsId}/instances/{instancesId}/natAddresses/{natAddressesId}: + parameters: *ref_1 get: - description: Gets a TargetServer resource. - operationId: apigee.organizations.environments.targetservers.get + description: >- + Gets the details of a NAT address. **Note:** Not supported for Apigee + hybrid. + operationId: apigee.organizations.instances.natAddresses.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18943,7 +20162,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' + $ref: '#/components/schemas/GoogleCloudApigeeV1NatAddress' parameters: - in: path name: organizationsId @@ -18951,20 +20170,21 @@ paths: schema: type: string - in: path - name: environmentsId + name: instancesId required: true schema: type: string - in: path - name: targetserversId + name: natAddressesId required: true schema: type: string delete: description: >- - Deletes a TargetServer from an environment. Returns the deleted - TargetServer resource. - operationId: apigee.organizations.environments.targetservers.delete + Deletes the NAT address. Connections that are actively using the address + are drained before it is removed. **Note:** Not supported for Apigee + hybrid. + operationId: apigee.organizations.instances.natAddresses.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18976,7 +20196,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -18984,25 +20204,28 @@ paths: schema: type: string - in: path - name: environmentsId + name: instancesId required: true schema: type: string - in: path - name: targetserversId + name: natAddressesId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/targetservers: + /v1/organizations/{organizationsId}/instances/{instancesId}/natAddresses/{natAddressesId}:activate: parameters: *ref_1 post: - description: Creates a TargetServer in the specified environment. - operationId: apigee.organizations.environments.targetservers.create + description: >- + Activates the NAT address. The Apigee instance can now use this for + Internet egress traffic. **Note:** Not supported for Apigee hybrid. + operationId: apigee.organizations.instances.natAddresses.activate requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ActivateNatAddressRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19014,7 +20237,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -19022,19 +20245,24 @@ paths: schema: type: string - in: path - name: environmentsId + name: instancesId required: true schema: type: string - - in: query - name: name + - in: path + name: natAddressesId + required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/optimizedStats/{optimizedStatsId}: + /v1/organizations/{organizationsId}/sharedflows: parameters: *ref_1 get: - description: Similar to GetStats except that the response is less verbose. - operationId: apigee.organizations.environments.optimizedStats.get + description: >- + Lists all shared flows in the organization. If the resource has the + `space` attribute set, the response may not return all resources. To + learn more, read the [Apigee Spaces + Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview). + operationId: apigee.organizations.sharedflows.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19046,130 +20274,39 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1OptimizedStats' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListSharedFlowsResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: optimizedStatsId - required: true - schema: - type: string - in: query - name: tsAscending + name: includeRevisions schema: type: boolean - in: query - name: filter - schema: - type: string - - in: query - name: aggTable - schema: - type: string - - in: query - name: select - schema: - type: string - - in: query - name: sortby - schema: - type: string - - in: query - name: timeUnit - schema: - type: string - - in: query - name: timeRange - schema: - type: string - - in: query - name: accuracy - schema: - type: string - - in: query - name: limit - schema: - type: string - - in: query - name: tzo - schema: - type: string - - in: query - name: sort - schema: - type: string - - in: query - name: topk - schema: - type: string - - in: query - name: offset - schema: - type: string - - in: query - name: sonar + name: includeMetaData schema: type: boolean - in: query - name: realtime - schema: - type: boolean - /v1/organizations/{organizationsId}/environments/{environmentsId}/addonsConfig:setAddonEnablement: - parameters: *ref_1 - post: - description: Updates an add-on enablement status of an environment. - operationId: apigee.organizations.environments.addonsConfig.setAddonEnablement - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SetAddonEnablementRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: environmentsId - required: true + name: space schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps/{keyvaluemapsId}/entries: - parameters: *ref_1 post: description: >- - Creates key value entries in a key value map scoped to an organization, - environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x - and higher. - operationId: apigee.organizations.environments.keyvaluemaps.entries.create + Uploads a ZIP-formatted shared flow configuration bundle to an + organization. If the shared flow already exists, this creates a new + revision of it. If the shared flow does not exist, this creates it. Once + imported, the shared flow revision must be deployed before it can be + accessed at runtime. The size limit of a shared flow bundle is 15 MB. + operationId: apigee.organizations.sharedflows.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: '#/components/schemas/GoogleApiHttpBody' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19181,29 +20318,30 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlowRevision' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true + - in: query + name: action schema: type: string - - in: path - name: keyvaluemapsId - required: true + - in: query + name: name + schema: + type: string + - in: query + name: space schema: type: string + /v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}: + parameters: *ref_1 get: - description: >- - Lists key value entries for key values maps scoped to an organization, - environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x - and higher. - operationId: apigee.organizations.environments.keyvaluemaps.entries.list + description: Gets a shared flow by name, including a list of its revisions. + operationId: apigee.organizations.sharedflows.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19215,8 +20353,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListKeyValueEntriesResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlow' parameters: - in: path name: organizationsId @@ -19224,34 +20361,15 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: keyvaluemapsId + name: sharedflowsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps/{keyvaluemapsId}/entries/{entriesId}: - parameters: *ref_1 delete: description: >- - Deletes a key value entry from a key value map scoped to an - organization, environment, or API proxy. **Notes:** * After you delete - the key value entry, the policy consuming the entry will continue to - function with its cached values for a few minutes. This is expected - behavior. * Supported for Apigee hybrid 1.8.x and higher. - operationId: apigee.organizations.environments.keyvaluemaps.entries.delete + Deletes a shared flow and all it's revisions. The shared flow must be + undeployed before you can delete it. + operationId: apigee.organizations.sharedflows.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19263,7 +20381,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlow' parameters: - in: path name: organizationsId @@ -19271,30 +20389,20 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: keyvaluemapsId - required: true - schema: - type: string - - in: path - name: entriesId + name: sharedflowsId required: true schema: type: string - put: - description: >- - Update key value entry scoped to an organization, environment, or API - proxy for an existing key. - operationId: apigee.organizations.environments.keyvaluemaps.entries.update + /v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}:move: + parameters: *ref_1 + post: + description: Moves an shared flow to a different space. + operationId: apigee.organizations.sharedflows.move requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: '#/components/schemas/GoogleCloudApigeeV1MoveSharedFlowRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19304,36 +20412,25 @@ paths: '200': description: Successful response content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: environmentsId - required: true - schema: - type: string + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlow' + parameters: - in: path - name: keyvaluemapsId + name: organizationsId required: true schema: type: string - in: path - name: entriesId + name: sharedflowsId required: true schema: type: string + /v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}/deployments: + parameters: *ref_1 get: - description: >- - Get the key value entry value for a key value map scoped to an - organization, environment, or API proxy. **Note**: Supported for Apigee - hybrid 1.8.x and higher. - operationId: apigee.organizations.environments.keyvaluemaps.entries.get + description: Lists all deployments of a shared flow. + operationId: apigee.organizations.sharedflows.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19345,7 +20442,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse parameters: - in: path name: organizationsId @@ -19353,30 +20451,25 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: keyvaluemapsId - required: true - schema: - type: string - - in: path - name: entriesId + name: sharedflowsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps: + /v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}/revisions/{revisionsId}: parameters: *ref_1 post: - description: Creates a key value map in an environment. - operationId: apigee.organizations.environments.keyvaluemaps.create + description: >- + Updates a shared flow revision. This operation is only allowed on + revisions which have never been deployed. After deployment a revision + becomes immutable, even if it becomes undeployed. The payload is a + ZIP-formatted shared flow. Content type must be either + multipart/form-data or application/octet-stream. + operationId: apigee.organizations.sharedflows.revisions.updateSharedFlowRevision requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' + $ref: '#/components/schemas/GoogleApiHttpBody' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19388,7 +20481,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' + $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlowRevision' parameters: - in: path name: organizationsId @@ -19396,15 +20489,29 @@ paths: schema: type: string - in: path - name: environmentsId + name: sharedflowsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps/{keyvaluemapsId}: - parameters: *ref_1 - delete: - description: Deletes a key value map from an environment. - operationId: apigee.organizations.environments.keyvaluemaps.delete + - in: path + name: revisionsId + required: true + schema: + type: string + - in: query + name: validate + schema: + type: boolean + get: + description: >- + Gets a revision of a shared flow. To download the shared flow + configuration bundle for the specified revision as a zip file, set the + `format` query parameter to `bundle`. If you are using curl, specify `-o + filename.zip` to save the output to a file; otherwise, it displays to + `stdout`. Then, develop the shared flow configuration locally and upload + the updated sharedFlow configuration revision, as described in + [updateSharedFlowRevision](updateSharedFlowRevision). + operationId: apigee.organizations.sharedflows.revisions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19416,7 +20523,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: organizationsId @@ -19424,25 +20531,24 @@ paths: schema: type: string - in: path - name: environmentsId + name: sharedflowsId required: true schema: type: string - in: path - name: keyvaluemapsId + name: revisionsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityReports/{securityReportsId}/result: - parameters: *ref_1 - get: + - in: query + name: format + schema: + type: string + delete: description: >- - After the query is completed, use this API to retrieve the results as - file. If the request succeeds, and there is a non-zero result set, the - result is downloaded to the client as a zipped JSON file. The name of - the downloaded file will be: OfflineQueryResult-.zip Example: - `OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip` - operationId: apigee.organizations.environments.securityReports.getResult + Deletes a shared flow and all associated policies, resources, and + revisions. You must undeploy the shared flow before deleting it. + operationId: apigee.organizations.sharedflows.revisions.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19454,7 +20560,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlowRevision' parameters: - in: path name: organizationsId @@ -19462,22 +20568,20 @@ paths: schema: type: string - in: path - name: environmentsId + name: sharedflowsId required: true schema: type: string - in: path - name: securityReportsId + name: revisionsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityReports/{securityReportsId}/resultView: + /v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}/revisions/{revisionsId}/deployments: parameters: *ref_1 get: - description: >- - After the query is completed, use this API to view the query result when - result size is small. - operationId: apigee.organizations.environments.securityReports.getResultView + description: Lists all deployments of a shared flow revision. + operationId: apigee.organizations.sharedflows.revisions.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19490,7 +20594,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityReportResultView + #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse parameters: - in: path name: organizationsId @@ -19498,29 +20602,25 @@ paths: schema: type: string - in: path - name: environmentsId + name: sharedflowsId required: true schema: type: string - in: path - name: securityReportsId + name: revisionsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityReports: + /v1/organizations/{organizationsId}/spaces: parameters: *ref_1 post: - description: >- - Submit a report request to be processed in the background. If the - submission succeeds, the API returns a 200 status and an ID that refer - to the report request. In addition to the HTTP status 200, the `state` - of "enqueued" means that the request succeeded. - operationId: apigee.organizations.environments.securityReports.create + description: Create a space under an organization. + operationId: apigee.organizations.spaces.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportQuery' + $ref: '#/components/schemas/GoogleCloudApigeeV1Space' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19532,21 +20632,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' + $ref: '#/components/schemas/GoogleCloudApigeeV1Space' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true + - in: query + name: spaceId schema: type: string get: - description: Return a list of Security Reports - operationId: apigee.organizations.environments.securityReports.list + description: Lists spaces under an organization. + operationId: apigee.organizations.spaces.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19558,31 +20657,13 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListSecurityReportsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1ListSpacesResponse' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true - schema: - type: string - - in: query - name: to - schema: - type: string - - in: query - name: submittedBy - schema: - type: string - - in: query - name: status - schema: - type: string - in: query name: pageSize schema: @@ -19592,22 +20673,11 @@ paths: name: pageToken schema: type: string - - in: query - name: dataset - schema: - type: string - - in: query - name: from - schema: - type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityReports/{securityReportsId}: + /v1/organizations/{organizationsId}/spaces/{spacesId}: parameters: *ref_1 get: - description: >- - Get security report status If the query is still in progress, the - `state` is set to "running" After the query has completed successfully, - `state` is set to "completed" - operationId: apigee.organizations.environments.securityReports.get + description: Get a space under an Organization. + operationId: apigee.organizations.spaces.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19619,7 +20689,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' + $ref: '#/components/schemas/GoogleCloudApigeeV1Space' parameters: - in: path name: organizationsId @@ -19627,20 +20697,18 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: securityReportsId + name: spacesId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/flowhooks/{flowhooksId}: - parameters: *ref_1 - delete: - description: Detaches a shared flow from a flow hook. - operationId: apigee.organizations.environments.flowhooks.detachSharedFlowFromFlowHook + patch: + description: Updates a space. + operationId: apigee.organizations.spaces.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Space' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19652,7 +20720,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1FlowHook' + $ref: '#/components/schemas/GoogleCloudApigeeV1Space' parameters: - in: path name: organizationsId @@ -19660,21 +20728,18 @@ paths: schema: type: string - in: path - name: environmentsId + name: spacesId required: true schema: type: string - - in: path - name: flowhooksId - required: true + - in: query + name: updateMask schema: type: string - get: - description: >- - Returns the name of the shared flow attached to the specified flow hook. - If there's no shared flow attached to the flow hook, the API does not - return an error; it simply does not return a name in the response. - operationId: apigee.organizations.environments.flowhooks.get + format: google-fieldmask + delete: + description: Deletes an organization space. + operationId: apigee.organizations.spaces.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19686,7 +20751,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1FlowHook' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -19694,23 +20759,20 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: flowhooksId + name: spacesId required: true schema: type: string - put: - description: Attaches a shared flow to a flow hook. - operationId: apigee.organizations.environments.flowhooks.attachSharedFlowToFlowHook + /v1/organizations/{organizationsId}/spaces/{spacesId}:setIamPolicy: + parameters: *ref_1 + post: + description: IAM META APIs Callers must have apigee.spaces.setIamPolicy. + operationId: apigee.organizations.spaces.setIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1FlowHook' + $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19722,7 +20784,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1FlowHook' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: organizationsId @@ -19730,20 +20792,15 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: flowhooksId + name: spacesId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/traceConfig/overrides/{overridesId}: + /v1/organizations/{organizationsId}/spaces/{spacesId}:getIamPolicy: parameters: *ref_1 - delete: - description: Deletes a distributed trace configuration override. - operationId: apigee.organizations.environments.traceConfig.overrides.delete + get: + description: Callers must have apigee.spaces.getIamPolicy. + operationId: apigee.organizations.spaces.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19755,7 +20812,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: organizationsId @@ -19763,27 +20820,59 @@ paths: schema: type: string - in: path - name: environmentsId + name: spacesId + required: true + schema: + type: string + - in: query + name: options.requestedPolicyVersion + schema: + type: integer + format: int32 + /v1/organizations/{organizationsId}/spaces/{spacesId}:testIamPermissions: + parameters: *ref_1 + post: + description: Callers don't need any permissions. + operationId: apigee.organizations.spaces.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + parameters: + - in: path + name: organizationsId required: true schema: type: string - in: path - name: overridesId + name: spacesId required: true schema: type: string - patch: + /v1/organizations/{organizationsId}/hostStats/{hostStatsId}: + parameters: *ref_1 + get: description: >- - Updates a distributed trace configuration override. Note that the - repeated fields have replace semantics when included in the field mask - and that they will be overwritten by the value of the fields in the - request body. - operationId: apigee.organizations.environments.traceConfig.overrides.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' + Retrieve metrics grouped by dimensions in host level. The types of + metrics you can retrieve include traffic, message counts, API call + latency, response size, and cache hits and counts. Dimensions let you + view metrics in meaningful groups. You can optionally pass dimensions as + path parameters to the `stats` API. If dimensions are not specified, the + metrics are computed on the entire set of data for the given time range. + operationId: apigee.organizations.hostStats.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19795,7 +20884,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' + $ref: '#/components/schemas/GoogleCloudApigeeV1Stats' parameters: - in: path name: organizationsId @@ -19803,23 +20892,71 @@ paths: schema: type: string - in: path - name: environmentsId + name: hostStatsId required: true schema: type: string - - in: path - name: overridesId - required: true + - in: query + name: select schema: type: string - in: query - name: updateMask + name: timeUnit schema: type: string - format: google-fieldmask + - in: query + name: timeRange + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: sort + schema: + type: string + - in: query + name: sortby + schema: + type: string + - in: query + name: limit + schema: + type: string + - in: query + name: offset + schema: + type: string + - in: query + name: topk + schema: + type: string + - in: query + name: tsAscending + schema: + type: boolean + - in: query + name: realtime + schema: + type: boolean + - in: query + name: tzo + schema: + type: string + - in: query + name: accuracy + schema: + type: string + - in: query + name: envgroupHostname + schema: + type: string + /v1/organizations/{organizationsId}/optimizedHostStats/{optimizedHostStatsId}: + parameters: *ref_1 get: - description: Gets a trace configuration override. - operationId: apigee.organizations.environments.traceConfig.overrides.get + description: Similar to GetHostStats except that the response is less verbose. + operationId: apigee.organizations.optimizedHostStats.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19831,7 +20968,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' + $ref: '#/components/schemas/GoogleCloudApigeeV1OptimizedStats' parameters: - in: path name: organizationsId @@ -19839,29 +20976,94 @@ paths: schema: type: string - in: path - name: environmentsId + name: optimizedHostStatsId required: true schema: type: string - - in: path - name: overridesId - required: true + - in: query + name: select schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/traceConfig/overrides: + - in: query + name: timeUnit + schema: + type: string + - in: query + name: timeRange + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: sort + schema: + type: string + - in: query + name: sortby + schema: + type: string + - in: query + name: limit + schema: + type: string + - in: query + name: offset + schema: + type: string + - in: query + name: topk + schema: + type: string + - in: query + name: tsAscending + schema: + type: boolean + - in: query + name: realtime + schema: + type: boolean + - in: query + name: tzo + schema: + type: string + - in: query + name: accuracy + schema: + type: string + - in: query + name: envgroupHostname + schema: + type: string + /v1/organizations/{organizationsId}/apiproducts: parameters: *ref_1 post: description: >- - Creates a trace configuration override. The response contains a - system-generated UUID, that can be used to view, update, or delete the - configuration override. Use the List API to view the existing trace - configuration overrides. - operationId: apigee.organizations.environments.traceConfig.overrides.create + Creates an API product in an organization. You create API products after + you have proxied backend services using API proxies. An API product is a + collection of API resources combined with quota settings and metadata + that you can use to deliver customized and productized API bundles to + your developer community. This metadata can include: - Scope - + Environments - API proxies - Extensible profile API products enable you + repackage APIs on the fly, without having to do any additional coding or + configuration. Apigee recommends that you start with a simple API + product including only required elements. You then provision credentials + to apps to enable them to start testing your APIs. After you have + authentication and authorization working against a simple API product, + you can iterate to create finer-grained API products, defining different + sets of API resources for each API product. **WARNING:** - If you don't + specify an API proxy in the request body, *any* app associated with the + product can make calls to *any* API in your entire organization. - If + you don't specify an environment in the request body, the product allows + access to all environments. For more information, see What is an API + product? + operationId: apigee.organizations.apiproducts.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19873,23 +21075,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true - schema: - type: string get: description: >- - Lists all of the distributed trace configuration overrides in an - environment. - operationId: apigee.organizations.environments.traceConfig.overrides.list + Lists all API product names for an organization. Filter the list by + passing an `attributename` and `attibutevalue`. The maximum number of + API products returned is 1000. You can paginate the list of API products + returned using the `startKey` and `count` query parameters. If the + resource has the `space` attribute set, the response may not return all + resources. To learn more, read the [Apigee Spaces + Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview). + operationId: apigee.organizations.apiproducts.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19902,37 +21104,51 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListTraceConfigOverridesResponse + #/components/schemas/GoogleCloudApigeeV1ListApiProductsResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true + - in: query + name: attributename schema: type: string - in: query - name: pageSize + name: attributevalue schema: - type: integer - format: int32 + type: string - in: query - name: pageToken + name: expand + schema: + type: boolean + - in: query + name: startKey schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityStats:queryTabularStats: + - in: query + name: count + schema: + type: string + format: int64 + - in: query + name: space + schema: + type: string + /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}: parameters: *ref_1 - post: - description: Retrieve security statistics as tabular rows. - operationId: apigee.organizations.environments.securityStats.queryTabularStats - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1QueryTabularStatsRequest' + delete: + description: >- + Deletes an API product from an organization. Deleting an API product + causes app requests to the resource URIs defined in the API product to + fail. Ensure that you create a new API product to serve existing apps, + unless your intention is to disable access to the resources defined in + the API product. The API product name required in the request URL is the + internal name of the product, not the display name. While they may be + the same, it depends on whether the API product was created via the UI + or the API. View the list of API products to verify the internal name. + operationId: apigee.organizations.apiproducts.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19944,8 +21160,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1QueryTabularStatsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' parameters: - in: path name: organizationsId @@ -19953,21 +21168,18 @@ paths: schema: type: string - in: path - name: environmentsId + name: apiproductsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityStats:queryTimeSeriesStats: - parameters: *ref_1 - post: - description: Retrieve security statistics as a collection of time series. - operationId: apigee.organizations.environments.securityStats.queryTimeSeriesStats - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1QueryTimeSeriesStatsRequest + get: + description: >- + Gets configuration details for an API product. The API product name + required in the request URL is the internal name of the product, not the + display name. While they may be the same, it depends on whether the API + product was created via the UI or the API. View the list of API products + to verify the internal name. + operationId: apigee.organizations.apiproducts.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19979,8 +21191,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1QueryTimeSeriesStatsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' parameters: - in: path name: organizationsId @@ -19988,15 +21199,25 @@ paths: schema: type: string - in: path - name: environmentsId + name: apiproductsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}: - parameters: *ref_1 - delete: - description: Deletes a keystore or truststore. - operationId: apigee.organizations.environments.keystores.delete + put: + description: >- + Updates an existing API product. You must include all required values, + whether or not you are updating them, as well as any optional values + that you are updating. The API product name required in the request URL + is the internal name of the product, not the display name. While they + may be the same, it depends on whether the API product was created via + UI or API. View the list of API products to identify their internal + names. + operationId: apigee.organizations.apiproducts.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20008,7 +21229,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Keystore' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' parameters: - in: path name: organizationsId @@ -20016,18 +21237,20 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: keystoresId + name: apiproductsId required: true schema: type: string - get: - description: Gets a keystore or truststore. - operationId: apigee.organizations.environments.keystores.get + /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}:move: + parameters: *ref_1 + post: + description: Moves an API product to a different space. + operationId: apigee.organizations.apiproducts.move + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1MoveApiProductRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20039,7 +21262,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Keystore' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' parameters: - in: path name: organizationsId @@ -20047,30 +21270,31 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: keystoresId + name: apiproductsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores: + /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/attributes: parameters: *ref_1 post: description: >- - Creates a keystore or truststore. - Keystore: Contains certificates and - their associated keys. - Truststore: Contains trusted certificates used - to validate a server's certificate. These certificates are typically - self-signed certificates or certificates that are not signed by a - trusted CA. - operationId: apigee.organizations.environments.keystores.create + Updates or creates API product attributes. This API **replaces** the + current list of attributes with the attributes specified in the request + body. In this way, you can update existing attributes, add new + attributes, or delete existing attributes by omitting them from the + request body. **Note**: OAuth access tokens and Key Management Service + (KMS) entities (apps, developers, and API products) are cached for 180 + seconds (current default). Any custom attributes associated with + entities also get cached for at least 180 seconds after entity is + accessed during runtime. In this case, the `ExpiresIn` element on the + OAuthV2 policy won't be able to expire an access token in less than 180 + seconds. + operationId: apigee.organizations.apiproducts.attributes requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Keystore' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20082,7 +21306,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Keystore' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' parameters: - in: path name: organizationsId @@ -20090,19 +21314,13 @@ paths: schema: type: string - in: path - name: environmentsId + name: apiproductsId required: true schema: type: string - - in: query - name: name - schema: - type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases/{aliasesId}: - parameters: *ref_1 - delete: - description: Deletes an alias. - operationId: apigee.organizations.environments.keystores.aliases.delete + get: + description: Lists all API product attributes. + operationId: apigee.organizations.apiproducts.attributes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20114,7 +21332,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Alias' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' parameters: - in: path name: organizationsId @@ -20122,23 +21340,15 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: keystoresId - required: true - schema: - type: string - - in: path - name: aliasesId + name: apiproductsId required: true schema: type: string + /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/attributes/{attributesId}: + parameters: *ref_1 get: - description: Gets an alias. - operationId: apigee.organizations.environments.keystores.aliases.get + description: Gets the value of an API product attribute. + operationId: apigee.organizations.apiproducts.attributes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20150,7 +21360,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Alias' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' parameters: - in: path name: organizationsId @@ -20158,28 +21368,30 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: keystoresId + name: apiproductsId required: true schema: type: string - in: path - name: aliasesId + name: attributesId required: true schema: type: string - put: - description: Updates the certificate in an alias. - operationId: apigee.organizations.environments.keystores.aliases.update + post: + description: >- + Updates the value of an API product attribute. **Note**: OAuth access + tokens and Key Management Service (KMS) entities (apps, developers, and + API products) are cached for 180 seconds (current default). Any custom + attributes associated with entities also get cached for at least 180 + seconds after entity is accessed during runtime. In this case, the + `ExpiresIn` element on the OAuthV2 policy won't be able to expire an + access token in less than 180 seconds. + operationId: apigee.organizations.apiproducts.attributes.updateApiProductAttribute requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20191,7 +21403,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Alias' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' parameters: - in: path name: organizationsId @@ -20199,33 +21411,18 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: keystoresId + name: apiproductsId required: true schema: type: string - in: path - name: aliasesId + name: attributesId required: true schema: type: string - - in: query - name: ignoreExpiryValidation - schema: - type: boolean - - in: query - name: ignoreNewlineValidation - schema: - type: boolean - /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases/{aliasesId}/certificate: - parameters: *ref_1 - get: - description: Gets the certificate from an alias in PEM-encoded form. - operationId: apigee.organizations.environments.keystores.aliases.getCertificate + delete: + description: Deletes an API product attribute. + operationId: apigee.organizations.apiproducts.attributes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20237,7 +21434,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' parameters: - in: path name: organizationsId @@ -20245,42 +21442,35 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: keystoresId + name: apiproductsId required: true schema: type: string - in: path - name: aliasesId + name: attributesId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases: + /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/rateplans: parameters: *ref_1 post: description: >- - Creates an alias from a key/certificate pair. The structure of the - request is controlled by the `format` query parameter: - `keycertfile` - - Separate PEM-encoded key and certificate files are uploaded. Set - `Content-Type: multipart/form-data` and include the `keyFile`, - `certFile`, and `password` (if keys are encrypted) fields in the request - body. If uploading to a truststore, omit `keyFile`. - `pkcs12` - A - PKCS12 file is uploaded. Set `Content-Type: multipart/form-data`, - provide the file in the `file` field, and include the `password` field - if the file is encrypted in the request body. - `selfsignedcert` - A new - private key and certificate are generated. Set `Content-Type: - application/json` and include CertificateGenerationSpec in the request - body. - operationId: apigee.organizations.environments.keystores.aliases.create + Create a rate plan that is associated with an API product in an + organization. Using rate plans, API product owners can monetize their + API products by configuring one or more of the following: - Billing + frequency - Initial setup fees for using an API product - Payment + funding model (postpaid only) - Fixed recurring or consumption-based + charges for using an API product - Revenue sharing with developer + partners An API product can have multiple rate plans associated with it + but *only one* rate plan can be active at any point of time. **Note: + From the developer's perspective, they purchase API products not rate + plans. + operationId: apigee.organizations.apiproducts.rateplans.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20292,7 +21482,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Alias' + $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' parameters: - in: path name: organizationsId @@ -20300,42 +21490,13 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: keystoresId + name: apiproductsId required: true schema: type: string - - in: query - name: format - schema: - type: string - - in: query - name: _password - schema: - type: string - - in: query - name: ignoreExpiryValidation - schema: - type: boolean - - in: query - name: alias - schema: - type: string - - in: query - name: ignoreNewlineValidation - schema: - type: boolean - /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases/{aliasesId}/csr: - parameters: *ref_1 get: - description: >- - Generates a PKCS #10 Certificate Signing Request for the private key in - an alias. - operationId: apigee.organizations.environments.keystores.aliases.csr + description: Lists all the rate plans for an API product. + operationId: apigee.organizations.apiproducts.rateplans.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20347,7 +21508,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleCloudApigeeV1ListRatePlansResponse' parameters: - in: path name: organizationsId @@ -20355,25 +21516,36 @@ paths: schema: type: string - in: path - name: environmentsId + name: apiproductsId required: true schema: type: string - - in: path - name: keystoresId - required: true + - in: query + name: orderBy + schema: + type: string + - in: query + name: startKey + schema: + type: string + - in: query + name: count schema: - type: string - - in: path - name: aliasesId - required: true + type: integer + format: int32 + - in: query + name: expand + schema: + type: boolean + - in: query + name: state schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/archiveDeployments/{archiveDeploymentsId}: + /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/rateplans/{rateplansId}: parameters: *ref_1 get: - description: Gets the specified ArchiveDeployment. - operationId: apigee.organizations.environments.archiveDeployments.get + description: Gets the details of a rate plan. + operationId: apigee.organizations.apiproducts.rateplans.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20385,7 +21557,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' + $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' parameters: - in: path name: organizationsId @@ -20393,25 +21565,23 @@ paths: schema: type: string - in: path - name: environmentsId + name: apiproductsId required: true schema: type: string - in: path - name: archiveDeploymentsId + name: rateplansId required: true schema: type: string - patch: - description: >- - Updates an existing ArchiveDeployment. Labels can modified but most of - the other fields are not modifiable. - operationId: apigee.organizations.environments.archiveDeployments.patch + put: + description: Updates an existing rate plan. + operationId: apigee.organizations.apiproducts.rateplans.update requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' + $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20423,7 +21593,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' + $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' parameters: - in: path name: organizationsId @@ -20431,23 +21601,18 @@ paths: schema: type: string - in: path - name: environmentsId + name: apiproductsId required: true schema: type: string - in: path - name: archiveDeploymentsId + name: rateplansId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask delete: - description: Deletes an archive deployment. - operationId: apigee.organizations.environments.archiveDeployments.delete + description: Deletes a rate plan. + operationId: apigee.organizations.apiproducts.rateplans.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20459,7 +21624,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' parameters: - in: path name: organizationsId @@ -20467,25 +21632,20 @@ paths: schema: type: string - in: path - name: environmentsId + name: apiproductsId required: true schema: type: string - in: path - name: archiveDeploymentsId + name: rateplansId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/archiveDeployments: + /v1/organizations/{organizationsId}/apps/{appsId}: parameters: *ref_1 - post: - description: Creates a new ArchiveDeployment. - operationId: apigee.organizations.environments.archiveDeployments.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' + get: + description: Gets the app profile for the specified app ID. + operationId: apigee.organizations.apps.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20497,7 +21657,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1App' parameters: - in: path name: organizationsId @@ -20505,13 +21665,18 @@ paths: schema: type: string - in: path - name: environmentsId + name: appsId required: true schema: type: string + /v1/organizations/{organizationsId}/apps: + parameters: *ref_1 get: - description: Lists the ArchiveDeployments in the specified Environment. - operationId: apigee.organizations.environments.archiveDeployments.list + description: >- + Lists IDs of apps within an organization that have the specified app + status (approved or revoked) or are of the specified app type (developer + or company). + operationId: apigee.organizations.apps.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20523,25 +21688,48 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListArchiveDeploymentsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1ListAppsResponse' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true + - in: query + name: status schema: type: string - in: query - name: filter + name: apptype schema: type: string - in: query - name: pageToken + name: includeCred + schema: + type: boolean + - in: query + name: startKey + schema: + type: string + - in: query + name: rows + schema: + type: string + format: int64 + - in: query + name: expand + schema: + type: boolean + - in: query + name: ids + schema: + type: string + - in: query + name: keyStatus + schema: + type: string + - in: query + name: apiProduct schema: type: string - in: query @@ -20549,72 +21737,28 @@ paths: schema: type: integer format: int32 - /v1/organizations/{organizationsId}/environments/{environmentsId}/archiveDeployments/{archiveDeploymentsId}:generateDownloadUrl: - parameters: *ref_1 - post: - description: >- - Generates a signed URL for downloading the original zip file used to - create an Archive Deployment. The URL is only valid for a limited period - and should be used within minutes after generation. Each call returns a - new upload URL. - operationId: apigee.organizations.environments.archiveDeployments.generateDownloadUrl - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1GenerateDownloadUrlRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1GenerateDownloadUrlResponse - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: environmentsId - required: true + - in: query + name: pageToken schema: type: string - - in: path - name: archiveDeploymentsId - required: true + - in: query + name: filter schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/archiveDeployments:generateUploadUrl: + /v1/organizations/{organizationsId}/hostQueries: parameters: *ref_1 post: description: >- - Generates a signed URL for uploading an Archive zip file to Google Cloud - Storage. Once the upload is complete, the signed URL should be passed to - CreateArchiveDeployment. When uploading to the generated signed URL, - please follow these restrictions: * Source file type should be a zip - file. * Source file size should not exceed 1GB limit. * No credentials - should be attached - the signed URLs provide access to the target bucket - using internal service identity; if credentials were attached, the - identity from the credentials would be used, but that identity does not - have permissions to upload files to the URL. When making a HTTP PUT - request, these two headers need to be specified: * `content-type: - application/zip` * `x-goog-content-length-range: 0,1073741824` And this - header SHOULD NOT be specified: * `Authorization: Bearer YOUR_TOKEN` - operationId: apigee.organizations.environments.archiveDeployments.generateUploadUrl + Submit a query at host level to be processed in the background. If the + submission of the query succeeds, the API returns a 201 status and an ID + that refer to the query. In addition to the HTTP status 201, the `state` + of "enqueued" means that the request succeeded. + operationId: apigee.organizations.hostQueries.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1GenerateUploadUrlRequest' + $ref: '#/components/schemas/GoogleCloudApigeeV1Query' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20626,30 +21770,16 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1GenerateUploadUrlResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQuery' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true - schema: - type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/stats/{statsId}: - parameters: *ref_1 get: - description: >- - Retrieve metrics grouped by dimensions. The types of metrics you can - retrieve include traffic, message counts, API call latency, response - size, and cache hits and counts. Dimensions let you view metrics in - meaningful groups. You can optionally pass dimensions as path parameters - to the `stats` API. If dimensions are not specified, the metrics are - computed on the entire set of data for the given time range. - operationId: apigee.organizations.environments.stats.get + description: Return a list of Asynchronous Queries at host level. + operationId: apigee.organizations.hostQueries.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20661,92 +21791,50 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Stats' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListAsyncQueriesResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: statsId - required: true - schema: - type: string - - in: query - name: tsAscending - schema: - type: boolean - - in: query - name: timeRange - schema: - type: string - - in: query - name: tzo - schema: - type: string - - in: query - name: offset - schema: - type: string - - in: query - name: accuracy - schema: - type: string - - in: query - name: aggTable - schema: - type: string - - in: query - name: limit - schema: - type: string - - in: query - name: sort - schema: - type: string - in: query - name: sortby + name: submittedBy schema: type: string - in: query - name: realtime + name: status schema: - type: boolean + type: string - in: query - name: topk + name: from schema: type: string - in: query - name: sonar + name: to schema: - type: boolean + type: string - in: query - name: select + name: dataset schema: type: string - in: query - name: filter + name: inclQueriesWithoutReport schema: type: string - in: query - name: timeUnit + name: envgroupHostname schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/analytics/admin/schemav2: + /v1/organizations/{organizationsId}/hostQueries/{hostQueriesId}: parameters: *ref_1 get: description: >- - Gets a list of metrics and dimensions that can be used to create - analytics queries and reports. Each schema element contains the name of - the field, its associated type, and a flag indicating whether it is a - standard or custom field. - operationId: apigee.organizations.environments.analytics.admin.getSchemav2 + Get status of a query submitted at host level. If the query is still in + progress, the `state` is set to "running" After the query has completed + successfully, `state` is set to "completed" + operationId: apigee.organizations.hostQueries.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20758,7 +21846,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Schema' + $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQuery' parameters: - in: path name: organizationsId @@ -20766,32 +21854,20 @@ paths: schema: type: string - in: path - name: environmentsId + name: hostQueriesId required: true schema: type: string - - in: query - name: type - schema: - type: string - - in: query - name: disableCache - schema: - type: boolean - /v1/organizations/{organizationsId}/environments/{environmentsId}/analytics/exports: + /v1/organizations/{organizationsId}/hostQueries/{hostQueriesId}/result: parameters: *ref_1 - post: + get: description: >- - Submit a data export job to be processed in the background. If the - request is successful, the API returns a 201 status, a URI that can be - used to retrieve the status of the export job, and the `state` value of - "enqueued". - operationId: apigee.organizations.environments.analytics.exports.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ExportRequest' + After the query is completed, use this API to retrieve the results. If + the request succeeds, and there is a non-zero result set, the result is + downloaded to the client as a zipped JSON file. The name of the + downloaded file will be: OfflineQueryResult-.zip Example: + `OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip` + operationId: apigee.organizations.hostQueries.getResult security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20803,7 +21879,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Export' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: organizationsId @@ -20811,15 +21887,15 @@ paths: schema: type: string - in: path - name: environmentsId + name: hostQueriesId required: true schema: type: string + /v1/organizations/{organizationsId}/hostQueries/{hostQueriesId}/resultView: + parameters: *ref_1 get: - description: >- - Lists the details and status of all analytics export jobs belonging to - the parent organization and environment. - operationId: apigee.organizations.environments.analytics.exports.list + description: '' + operationId: apigee.organizations.hostQueries.getResultView security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20831,7 +21907,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ListExportsResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQueryResultView' parameters: - in: path name: organizationsId @@ -20839,19 +21915,27 @@ paths: schema: type: string - in: path - name: environmentsId + name: hostQueriesId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/analytics/exports/{exportsId}: + /v1/organizations/{organizationsId}/reports: parameters: *ref_1 - get: + post: description: >- - Gets the details and status of an analytics export job. If the export - job is still in progress, its `state` is set to "running". After the - export job has completed successfully, its `state` is set to - "completed". If the export job fails, its `state` is set to `failed`. - operationId: apigee.organizations.environments.analytics.exports.get + Creates a Custom Report for an Organization. A Custom Report provides + Apigee Customers to create custom dashboards in addition to the standard + dashboards which are provided. The Custom Report in its simplest form + contains specifications about metrics, dimensions and filters. It is + important to note that the custom report by itself does not provide an + executable entity. The Edge UI converts the custom report definition + into an analytics query and displays the result in a chart. + operationId: apigee.organizations.reports.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20863,28 +21947,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Export' + $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: exportsId - required: true - schema: - type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/deployments: - parameters: *ref_1 get: - description: Lists all deployments of an API proxy in an environment. - operationId: apigee.organizations.environments.apis.deployments.list + description: Return a list of Custom Reports + operationId: apigee.organizations.reports.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20897,28 +21969,22 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse + #/components/schemas/GoogleCloudApigeeV1ListCustomReportsResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: apisId - required: true + - in: query + name: expand schema: - type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions/{debugsessionsId}: + type: boolean + /v1/organizations/{organizationsId}/reports/{reportsId}: parameters: *ref_1 get: - description: Retrieves a debug session. - operationId: apigee.organizations.environments.apis.revisions.debugsessions.get + description: Retrieve a custom report definition. + operationId: apigee.organizations.reports.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20930,7 +21996,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DebugSession' + $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' parameters: - in: path name: organizationsId @@ -20938,35 +22004,18 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: apisId - required: true - schema: - type: string - - in: path - name: revisionsId - required: true - schema: - type: string - - in: path - name: debugsessionsId + name: reportsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions: - parameters: *ref_1 - post: - description: Creates a debug session for a deployed API Proxy revision. - operationId: apigee.organizations.environments.apis.revisions.debugsessions.create + put: + description: Update an existing custom report definition + operationId: apigee.organizations.reports.update requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DebugSession' + $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20978,7 +22027,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DebugSession' + $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' parameters: - in: path name: organizationsId @@ -20986,30 +22035,13 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: apisId - required: true - schema: - type: string - - in: path - name: revisionsId + name: reportsId required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: int64 - get: - description: >- - Lists debug sessions that are currently active in the given API Proxy - revision. - operationId: apigee.organizations.environments.apis.revisions.debugsessions.list + delete: + description: Deletes an existing custom report definition + operationId: apigee.organizations.reports.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21022,7 +22054,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDebugSessionsResponse + #/components/schemas/GoogleCloudApigeeV1DeleteCustomReportResponse parameters: - in: path name: organizationsId @@ -21030,38 +22062,76 @@ paths: schema: type: string - in: path - name: environmentsId + name: reportsId required: true schema: type: string + /v1/organizations/{organizationsId}/analytics/datastores: + parameters: *ref_1 + post: + description: Create a Datastore for an org + operationId: apigee.organizations.analytics.datastores.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' + parameters: - in: path - name: apisId + name: organizationsId required: true schema: type: string + get: + description: List Datastores + operationId: apigee.organizations.analytics.datastores.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1ListDatastoresResponse' + parameters: - in: path - name: revisionsId + name: organizationsId required: true schema: type: string - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + name: targetType schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions/{debugsessionsId}/data: + /v1/organizations/{organizationsId}/analytics/datastores:test: parameters: *ref_1 - delete: + post: description: >- - Deletes the data from a debug session. This does not cancel the debug - session or prevent further data from being collected if the session is - still active in runtime pods. - operationId: >- - apigee.organizations.environments.apis.revisions.debugsessions.deleteData + Test if Datastore configuration is correct. This includes checking if + credentials provided by customer have required permissions in target + destination storage + operationId: apigee.organizations.analytics.datastores.test + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21073,38 +22143,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudApigeeV1TestDatastoreResponse' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: apisId - required: true - schema: - type: string - - in: path - name: revisionsId - required: true - schema: - type: string - - in: path - name: debugsessionsId - required: true - schema: - type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions/{debugsessionsId}/data/{dataId}: + /v1/organizations/{organizationsId}/analytics/datastores/{datastoresId}: parameters: *ref_1 - get: - description: Gets the debug data from a transaction. - operationId: apigee.organizations.environments.apis.revisions.debugsessions.data.get + delete: + description: Delete a Datastore from an org. + operationId: apigee.organizations.analytics.datastores.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21116,8 +22166,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DebugSessionTransaction + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -21125,48 +22174,13 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: apisId - required: true - schema: - type: string - - in: path - name: revisionsId - required: true - schema: - type: string - - in: path - name: debugsessionsId - required: true - schema: - type: string - - in: path - name: dataId + name: datastoresId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/deployments:generateUndeployChangeReport: - parameters: *ref_1 - post: - description: >- - Generates a report for a dry run analysis of an UndeployApiProxy request - without committing the undeploy. In addition to the standard validations - performed when removing deployments, additional analysis will be done to - detect possible traffic routing changes that would result from this - deployment being removed. Any potential routing conflicts or unsafe - changes will be reported in the response. This routing analysis is not - performed for a non-dry-run UndeployApiProxy request. For a request path - `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments:generateUndeployChangeReport`, - two permissions are required: * `apigee.deployments.delete` on the - resource `organizations/{org}/environments/{env}` * - `apigee.proxyrevisions.undeploy` on the resource - `organizations/{org}/apis/{api}/revisions/{rev}` - operationId: >- - apigee.organizations.environments.apis.revisions.deployments.generateUndeployChangeReport + get: + description: Get a Datastore + operationId: apigee.organizations.analytics.datastores.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21178,7 +22192,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeploymentChangeReport' + $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' parameters: - in: path name: organizationsId @@ -21186,39 +22200,18 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: apisId - required: true - schema: - type: string - - in: path - name: revisionsId + name: datastoresId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/deployments:generateDeployChangeReport: - parameters: *ref_1 - post: - description: >- - Generates a report for a dry run analysis of a DeployApiProxy request - without committing the deployment. In addition to the standard - validations performed when adding deployments, additional analysis will - be done to detect possible traffic routing changes that would result - from this deployment being created. Any potential routing conflicts or - unsafe changes will be reported in the response. This routing analysis - is not performed for a non-dry-run DeployApiProxy request. For a request - path - `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments:generateDeployChangeReport`, - two permissions are required: * `apigee.deployments.create` on the - resource `organizations/{org}/environments/{env}` * - `apigee.proxyrevisions.deploy` on the resource - `organizations/{org}/apis/{api}/revisions/{rev}` - operationId: >- - apigee.organizations.environments.apis.revisions.deployments.generateDeployChangeReport + put: + description: Update a Datastore + operationId: apigee.organizations.analytics.datastores.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21230,7 +22223,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeploymentChangeReport' + $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' parameters: - in: path name: organizationsId @@ -21238,35 +22231,23 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: apisId - required: true - schema: - type: string - - in: path - name: revisionsId + name: datastoresId required: true schema: type: string - - in: query - name: override - schema: - type: boolean - /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/deployments: + /v1/organizations/{organizationsId}/developers: parameters: *ref_1 - delete: + post: description: >- - Undeploys an API proxy revision from an environment. For a request path - `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments`, - two permissions are required: * `apigee.deployments.delete` on the - resource `organizations/{org}/environments/{env}` * - `apigee.proxyrevisions.undeploy` on the resource - `organizations/{org}/apis/{api}/revisions/{rev}` - operationId: apigee.organizations.environments.apis.revisions.undeploy + Creates a developer. Once created, the developer can register an app and + obtain an API key. At creation time, a developer is set as `active`. To + change the developer status, use the SetDeveloperStatus API. + operationId: apigee.organizations.developers.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21278,47 +22259,22 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: apisId - required: true - schema: - type: string - - in: path - name: revisionsId - required: true - schema: - type: string - - in: query - name: sequencedRollout - schema: - type: boolean - post: + get: description: >- - Deploys a revision of an API proxy. If another revision of the same API - proxy revision is currently deployed, set the `override` parameter to - `true` to have this revision replace the currently deployed revision. - You cannot invoke an API proxy until it has been deployed to an - environment. After you deploy an API proxy revision, you cannot edit it. - To edit the API proxy, you must create and deploy a new revision. For a - request path - `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments`, - two permissions are required: * `apigee.deployments.create` on the - resource `organizations/{org}/environments/{env}` * - `apigee.proxyrevisions.deploy` on the resource - `organizations/{org}/apis/{api}/revisions/{rev}` - operationId: apigee.organizations.environments.apis.revisions.deploy + Lists all developers in an organization by email address. By default, + the response does not include company developers. Set the + `includeCompany` query parameter to `true` to include company + developers. **Note**: A maximum of 1000 developers are returned in the + response. You paginate the list of developers returned using the + `startKey` and `count` query parameters. + operationId: apigee.organizations.developers.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21330,45 +22286,58 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListOfDevelopersResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true + - in: query + name: expand schema: - type: string - - in: path - name: apisId - required: true + type: boolean + - in: query + name: startKey schema: type: string - - in: path - name: revisionsId - required: true + - in: query + name: count schema: type: string + format: int64 - in: query - name: sequencedRollout + name: ids schema: - type: boolean + type: string - in: query - name: override + name: includeCompany schema: type: boolean - in: query - name: serviceAccount + name: app schema: type: string - get: + /v1/organizations/{organizationsId}/developers/{developersId}: + parameters: *ref_1 + put: description: >- - Gets the deployment of an API proxy revision and actual state reported - by runtime pods. - operationId: apigee.organizations.environments.apis.revisions.getDeployments + Updates a developer. This API replaces the existing developer details + with those specified in the request. Include or exclude any existing + details that you want to retain or delete, respectively. The custom + attribute limit is 18. **Note**: OAuth access tokens and Key Management + Service (KMS) entities (apps, developers, and API products) are cached + for 180 seconds (current default). Any custom attributes associated with + these entities are cached for at least 180 seconds after the entity is + accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 + policy won't be able to expire an access token in less than 180 seconds. + operationId: apigee.organizations.developers.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21380,7 +22349,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' + $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' parameters: - in: path name: organizationsId @@ -21388,25 +22357,16 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: apisId - required: true - schema: - type: string - - in: path - name: revisionsId + name: developersId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}: - parameters: *ref_1 get: - description: Gets environment details. - operationId: apigee.organizations.environments.get + description: >- + Returns the developer details, including the developer's name, email + address, apps, and other information. **Note**: The response includes + only the first 100 developer apps. + operationId: apigee.organizations.developers.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21418,7 +22378,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' + $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' parameters: - in: path name: organizationsId @@ -21426,17 +22386,25 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string + - in: query + name: action + schema: + type: string delete: description: >- - Deletes an environment from an organization. **Warning: You must delete - all key value maps and key value entries before you delete an - environment.** Otherwise, if you re-create the environment the key value - map entry operations will encounter encryption/decryption discrepancies. - operationId: apigee.organizations.environments.delete + Deletes a developer. All apps and API keys associated with the developer + are also removed. **Warning**: This API will permanently delete the + developer and related artifacts. To avoid permanently deleting + developers and their artifacts, set the developer status to `inactive` + using the SetDeveloperStatus API. **Note**: The delete operation is + asynchronous. The developer is deleted immediately, but its associated + resources, such as apps and API keys, may take anywhere from a few + seconds to a few minutes to be deleted. + operationId: apigee.organizations.developers.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21448,7 +22416,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' parameters: - in: path name: organizationsId @@ -21456,24 +22424,22 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - put: + post: description: >- - Updates an existing environment. When updating properties, you must pass - all existing properties to the API, even if they are not being changed. - If you omit properties from the payload, the properties are removed. To - get the current list of properties for the environment, use the [Get - Environment API](get). **Note**: Both `PUT` and `POST` methods are - supported for updating an existing environment. - operationId: apigee.organizations.environments.update - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' + Sets the status of a developer. A developer is `active` by default. If + you set a developer's status to `inactive`, the API keys assigned to the + developer apps are no longer valid even though the API keys are set to + `approved`. Inactive developers can still sign in to the developer + portal and create apps; however, any new API keys generated during app + creation won't work. To set the status of a developer, set the `action` + query parameter to `active` or `inactive`, and the `Content-Type` header + to `application/octet-stream`. If successful, the API call returns the + following HTTP status code: `204 No Content` + operationId: apigee.organizations.developers.setDeveloperStatus security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21485,7 +22451,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -21493,24 +22459,34 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string + - in: query + name: action + schema: + type: string + /v1/organizations/{organizationsId}/developers/{developersId}/attributes: + parameters: *ref_1 post: description: >- - Updates an existing environment. When updating properties, you must pass - all existing properties to the API, even if they are not being changed. - If you omit properties from the payload, the properties are removed. To - get the current list of properties for the environment, use the [Get - Environment API](get). **Note**: Both `PUT` and `POST` methods are - supported for updating an existing environment. - operationId: apigee.organizations.environments.updateEnvironment + Updates developer attributes. This API replaces the existing attributes + with those specified in the request. Add new attributes, and include or + exclude any existing attributes that you want to retain or remove, + respectively. The custom attribute limit is 18. **Note**: OAuth access + tokens and Key Management Service (KMS) entities (apps, developers, and + API products) are cached for 180 seconds (default). Any custom + attributes associated with these entities are cached for at least 180 + seconds after the entity is accessed at runtime. Therefore, an + `ExpiresIn` element on the OAuthV2 policy won't be able to expire an + access token in less than 180 seconds. + operationId: apigee.organizations.developers.attributes requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21522,7 +22498,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' parameters: - in: path name: organizationsId @@ -21530,20 +22506,13 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - patch: - description: >- - Updates properties for an Apigee environment with patch semantics using - a field mask. **Note:** Not supported for Apigee hybrid. - operationId: apigee.organizations.environments.modifyEnvironment - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' + get: + description: Returns a list of all developer attributes. + operationId: apigee.organizations.developers.attributes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21555,7 +22524,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' parameters: - in: path name: organizationsId @@ -21563,31 +22532,15 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1/organizations/{organizationsId}/environments/{environmentsId}:setIamPolicy: + /v1/organizations/{organizationsId}/developers/{developersId}/monetizationConfig: parameters: *ref_1 - post: - description: >- - Sets the IAM policy on an environment, if the policy already exists it - will be replaced. For more information, see [Manage users, roles, and - permissions using the - API](https://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). - You must have the `apigee.environments.setIamPolicy` permission to call - this API. - operationId: apigee.organizations.environments.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' + get: + description: Gets the monetization configuration for the developer. + operationId: apigee.organizations.developers.getMonetizationConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21599,7 +22552,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DeveloperMonetizationConfig parameters: - in: path name: organizationsId @@ -21607,24 +22561,19 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}:testIamPermissions: - parameters: *ref_1 - post: - description: >- - Tests the permissions of a user on an environment, and returns a subset - of permissions that the user has on the environment. If the environment - does not exist, an empty permission set is returned (a NOT_FOUND error - is not returned). - operationId: apigee.organizations.environments.testIamPermissions + put: + description: Updates the monetization configuration for the developer. + operationId: apigee.organizations.developers.updateMonetizationConfig requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsRequest' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DeveloperMonetizationConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21636,7 +22585,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DeveloperMonetizationConfig parameters: - in: path name: organizationsId @@ -21644,18 +22594,15 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}:subscribe: + /v1/organizations/{organizationsId}/developers/{developersId}/balance: parameters: *ref_1 - post: - description: >- - Creates a subscription for the environment's Pub/Sub topic. The server - will assign a random name for this subscription. The "name" and - "push_config" must *not* be specified. - operationId: apigee.organizations.environments.subscribe + get: + description: Gets the account balance for the developer. + operationId: apigee.organizations.developers.getBalance security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21667,7 +22614,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Subscription' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperBalance' parameters: - in: path name: organizationsId @@ -21675,55 +22622,46 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/debugmask: + /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}: parameters: *ref_1 - patch: - description: Updates the debug mask singleton resource for an environment. - operationId: apigee.organizations.environments.updateDebugmask + post: + description: >- + Manages access to a developer app by enabling you to: * Approve or + revoke a developer app * Generate a new consumer key and secret for a + developer app To approve or revoke a developer app, set the `action` + query parameter to `approve` or `revoke`, respectively, and the + `Content-Type` header to `application/octet-stream`. If a developer app + is revoked, none of its API keys are valid for API calls even though the + keys are still approved. If successful, the API call returns the + following HTTP status code: `204 No Content` To generate a new consumer + key and secret for a developer app, pass the new key/secret details. + Rather than replace an existing key, this API generates a new key. In + this case, multiple key pairs may be associated with a single developer + app. Each key pair has an independent status (`approve` or `revoke`) and + expiration time. Any approved, non-expired key can be used in an API + call. For example, if you're using API key rotation, you can generate + new keys with expiration times that overlap keys that are going to + expire. You might also generate a new consumer key/secret if the + security of the original key/secret is compromised. The `keyExpiresIn` + property defines the expiration time for the API key in milliseconds. If + you don't set this property or set it to `-1`, the API key never + expires. **Notes**: * When generating a new key/secret, this API + replaces the existing attributes, notes, and callback URLs with those + specified in the request. Include or exclude any existing information + that you want to retain or delete, respectively. * To migrate existing + consumer keys and secrets to hybrid from another system, see the + CreateDeveloperAppKey API. + operationId: >- + apigee.organizations.developers.apps.generateKeyPairOrUpdateDeveloperAppStatus requestBody: content: application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DebugMask' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DebugMask' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: environmentsId - required: true - schema: - type: string - - in: query - name: replaceRepeatedFields - schema: - type: boolean - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - get: - description: Gets the debug mask singleton resource for an environment. - operationId: apigee.organizations.environments.getDebugmask + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21735,7 +22673,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DebugMask' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' parameters: - in: path name: organizationsId @@ -21743,24 +22681,26 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/traceConfig: - parameters: *ref_1 - patch: + - in: path + name: appsId + required: true + schema: + type: string + - in: query + name: action + schema: + type: string + delete: description: >- - Updates the trace configurations in an environment. Note that the - repeated fields have replace semantics when included in the field mask - and that they will be overwritten by the value of the fields in the - request body. - operationId: apigee.organizations.environments.updateTraceConfig - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfig' + Deletes a developer app. **Note**: The delete operation is asynchronous. + The developer app is deleted immediately, but its associated resources, + such as app keys or access tokens, may take anywhere from a few seconds + to a few minutes to be deleted. + operationId: apigee.organizations.developers.apps.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21772,7 +22712,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfig' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' parameters: - in: path name: organizationsId @@ -21780,18 +22720,18 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: appsId + required: true schema: type: string - format: google-fieldmask get: - description: Get distributed trace configuration in an environment. - operationId: apigee.organizations.environments.getTraceConfig + description: Returns the details for a developer app. + operationId: apigee.organizations.developers.apps.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21803,7 +22743,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfig' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' parameters: - in: path name: organizationsId @@ -21811,17 +22751,41 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityActionsConfig: - parameters: *ref_1 - get: + - in: path + name: appsId + required: true + schema: + type: string + - in: query + name: query + schema: + type: string + - in: query + name: entity + schema: + type: string + put: description: >- - GetSecurityActionConfig returns the current SecurityActions - configuration. - operationId: apigee.organizations.environments.getSecurityActionsConfig + Updates the details for a developer app. In addition, you can add an API + product to a developer app and automatically generate an API key for the + app to use when calling APIs in the API product. If you want to use an + existing API key for the API product, add the API product to the API key + using the UpdateDeveloperAppKey API. Using this API, you cannot update + the following: * App name as it is the primary key used to identify the + app and cannot be changed. * Scopes associated with the app. Instead, + use the ReplaceDeveloperAppKey API. This API replaces the existing + attributes with those specified in the request. Include or exclude any + existing attributes that you want to retain or delete, respectively. + operationId: apigee.organizations.developers.apps.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21833,7 +22797,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionsConfig' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' parameters: - in: path name: organizationsId @@ -21841,21 +22805,31 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - patch: + - in: path + name: appsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/developers/{developersId}/apps: + parameters: *ref_1 + post: description: >- - UpdateSecurityActionConfig updates the current SecurityActions - configuration. This method is used to enable/disable the feature at the - environment level. - operationId: apigee.organizations.environments.updateSecurityActionsConfig + Creates an app associated with a developer. This API associates the + developer app with the specified API product and auto-generates an API + key for the app to use in calls to API proxies inside that API product. + The `name` is the unique ID of the app that you can use in API calls. + The `DisplayName` (set as an attribute) appears in the UI. If you don't + set the `DisplayName` attribute, the `name` appears in the UI. + operationId: apigee.organizations.developers.apps.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionsConfig' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21867,7 +22841,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionsConfig' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' parameters: - in: path name: organizationsId @@ -21875,25 +22849,18 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1/organizations/{organizationsId}/environments/{environmentsId}:getIamPolicy: - parameters: *ref_1 get: description: >- - Gets the IAM policy on an environment. For more information, see [Manage - users, roles, and permissions using the - API](https://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). - You must have the `apigee.environments.getIamPolicy` permission to call - this API. - operationId: apigee.organizations.environments.getIamPolicy + Lists all apps created by a developer in an Apigee organization. + Optionally, you can request an expanded view of the developer apps. A + maximum of 100 developer apps are returned per API call. You can + paginate the list of deveoper apps returned using the `startKey` and + `count` query parameters. + operationId: apigee.organizations.developers.apps.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21905,7 +22872,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListDeveloperAppsResponse parameters: - in: path name: organizationsId @@ -21913,20 +22881,39 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - in: query - name: options.requestedPolicyVersion + name: expand schema: - type: integer - format: int32 - /v1/organizations/{organizationsId}/environments/{environmentsId}/deployedConfig: + type: boolean + - in: query + name: count + schema: + type: string + format: int64 + - in: query + name: startKey + schema: + type: string + - in: query + name: shallowExpand + schema: + type: boolean + /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/attributes: parameters: *ref_1 - get: - description: Gets the deployed configuration for an environment. - operationId: apigee.organizations.environments.getDeployedConfig + post: + description: >- + Updates attributes for a developer app. This API replaces the current + attributes with those specified in the request. + operationId: apigee.organizations.developers.apps.attributes + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21938,7 +22925,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentConfig' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' parameters: - in: path name: organizationsId @@ -21946,20 +22933,18 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - /v1/organizations/{organizationsId}/environments: - parameters: *ref_1 - post: - description: Creates an environment in an organization. - operationId: apigee.organizations.environments.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' + - in: path + name: appsId + required: true + schema: + type: string + get: + description: Returns a list of all developer app attributes. + operationId: apigee.organizations.developers.apps.attributes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21971,27 +22956,47 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: name + - in: path + name: developersId + required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}:unsubscribe: + - in: path + name: appsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys: parameters: *ref_1 post: - description: Deletes a subscription for the environment's Pub/Sub topic. - operationId: apigee.organizations.environments.unsubscribe + description: >- + Creates a custom consumer key and secret for a developer app. This is + particularly useful if you want to migrate existing consumer keys and + secrets to Apigee from another system. Consumer keys and secrets can + contain letters, numbers, underscores, and hyphens. No other special + characters are allowed. To avoid service disruptions, a consumer key and + secret should not exceed 2 KBs each. **Note**: When creating the + consumer key and secret, an association to API products will not be + made. Therefore, you should not specify the associated API products in + your request. Instead, use the UpdateDeveloperAppKey API to make the + association after the consumer key and secret are created. If a consumer + key and secret already exist, you can keep them or delete them using the + DeleteDeveloperAppKey API. **Note**: All keys start out with + status=approved, even if status=revoked is passed when the key is + created. To revoke a key, use the UpdateDeveloperAppKey API. + operationId: apigee.organizations.developers.apps.keys.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Subscription' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22003,7 +23008,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' parameters: - in: path name: organizationsId @@ -22011,15 +23016,35 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/addonsConfig: + - in: path + name: appsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/{keysId}: parameters: *ref_1 - get: - description: Gets the add-ons config of an environment. - operationId: apigee.organizations.environments.getAddonsConfig + post: + description: >- + Adds an API product to a developer app key, enabling the app that holds + the key to access the API resources bundled in the API product. In + addition, you can add attributes and scopes associated with the API + product to the developer app key. The status of the key can be updated + via "action" Query Parameter. None of the other fields can be updated + via this API. This API replaces the existing attributes with those + specified in the request. Include or exclude any existing attributes + that you want to retain or delete, respectively. None of the other + fields can be updated. You can use the same key to access all API + products associated with the app. + operationId: apigee.organizations.developers.apps.keys.updateDeveloperAppKey + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22031,7 +23056,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AddonsConfig' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' parameters: - in: path name: organizationsId @@ -22039,18 +23064,38 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/apiSecurityRuntimeConfig: - parameters: *ref_1 - get: + - in: path + name: appsId + required: true + schema: + type: string + - in: path + name: keysId + required: true + schema: + type: string + - in: query + name: action + schema: + type: string + put: description: >- - Gets the API Security runtime configuration for an environment. This - named ApiSecurityRuntimeConfig to prevent conflicts with - ApiSecurityConfig from addon config. - operationId: apigee.organizations.environments.getApiSecurityRuntimeConfig + Updates the scope of an app. This API replaces the existing scopes with + those specified in the request. Include or exclude any existing scopes + that you want to retain or delete, respectively. The specified scopes + must already be defined for the API products associated with the app. + This API sets the `scopes` element under the `apiProducts` element in + the attributes of the app. + operationId: apigee.organizations.developers.apps.keys.replaceDeveloperAppKey + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22062,8 +23107,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ApiSecurityRuntimeConfig + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' parameters: - in: path name: organizationsId @@ -22071,15 +23115,30 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId + required: true + schema: + type: string + - in: path + name: appsId + required: true + schema: + type: string + - in: path + name: keysId required: true schema: type: string - /v1/organizations/{organizationsId}/instances/{instancesId}/attachments/{attachmentsId}: - parameters: *ref_1 delete: - description: Deletes an attachment. **Note:** Not supported for Apigee hybrid. - operationId: apigee.organizations.instances.attachments.delete + description: >- + Deletes an app's consumer key and removes all API products associated + with the app. After the consumer key is deleted, it cannot be used to + access any APIs. **Note**: After you delete a consumer key, you may want + to: 1. Create a new consumer key and secret for the developer app using + the CreateDeveloperAppKey API, and subsequently add an API product to + the key using the UpdateDeveloperAppKey API. 2. Delete the developer + app, if it is no longer required. + operationId: apigee.organizations.developers.apps.keys.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22091,7 +23150,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' parameters: - in: path name: organizationsId @@ -22099,18 +23158,25 @@ paths: schema: type: string - in: path - name: instancesId + name: developersId required: true schema: type: string - in: path - name: attachmentsId + name: appsId + required: true + schema: + type: string + - in: path + name: keysId required: true schema: type: string get: - description: Gets an attachment. **Note:** Not supported for Apigee hybrid. - operationId: apigee.organizations.instances.attachments.get + description: >- + Gets details for a consumer key for a developer app, including the key + and secret value, associated API products, and other information. + operationId: apigee.organizations.developers.apps.keys.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22122,7 +23188,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1InstanceAttachment' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' parameters: - in: path name: organizationsId @@ -22130,27 +23196,44 @@ paths: schema: type: string - in: path - name: instancesId + name: developersId required: true schema: type: string - in: path - name: attachmentsId + name: appsId required: true schema: type: string - /v1/organizations/{organizationsId}/instances/{instancesId}/attachments: + - in: path + name: keysId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/create: parameters: *ref_1 post: description: >- - Creates a new attachment of an environment to an instance. **Note:** Not - supported for Apigee hybrid. - operationId: apigee.organizations.instances.attachments.create + Creates a custom consumer key and secret for a developer app. This is + particularly useful if you want to migrate existing consumer keys and + secrets to Apigee from another system. Consumer keys and secrets can + contain letters, numbers, underscores, and hyphens. No other special + characters are allowed. To avoid service disruptions, a consumer key and + secret should not exceed 2 KBs each. **Note**: When creating the + consumer key and secret, an association to API products will not be + made. Therefore, you should not specify the associated API products in + your request. Instead, use the UpdateDeveloperAppKey API to make the + association after the consumer key and secret are created. If a consumer + key and secret already exist, you can keep them or delete them using the + DeleteDeveloperAppKey API. **Note**: All keys start out with + status=approved, even if status=revoked is passed when the key is + created. To revoke a key, use the UpdateDeveloperAppKey API. + operationId: apigee.organizations.developers.apps.keys.create.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1InstanceAttachment' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22162,7 +23245,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' parameters: - in: path name: organizationsId @@ -22170,15 +23253,24 @@ paths: schema: type: string - in: path - name: instancesId + name: developersId required: true schema: type: string - get: + - in: path + name: appsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/{keysId}/apiproducts/{apiproductsId}: + parameters: *ref_1 + delete: description: >- - Lists all attachments to an instance. **Note:** Not supported for Apigee - hybrid. - operationId: apigee.organizations.instances.attachments.list + Removes an API product from an app's consumer key. After the API product + is removed, the app cannot access the API resources defined in that API + product. **Note**: The consumer key is not removed, only its association + with the API product. + operationId: apigee.organizations.developers.apps.keys.apiproducts.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22190,8 +23282,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListInstanceAttachmentsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' parameters: - in: path name: organizationsId @@ -22199,73 +23290,35 @@ paths: schema: type: string - in: path - name: instancesId + name: developersId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/organizations/{organizationsId}/instances/{instancesId}/natAddresses: - parameters: *ref_1 - get: - description: >- - Lists the NAT addresses for an Apigee instance. **Note:** Not supported - for Apigee hybrid. - operationId: apigee.organizations.instances.natAddresses.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListNatAddressesResponse - parameters: - in: path - name: organizationsId + name: appsId required: true schema: type: string - in: path - name: instancesId + name: keysId required: true schema: type: string - - in: query - name: pageToken + - in: path + name: apiproductsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 post: description: >- - Creates a NAT address. The address is created in the RESERVED state and - a static external IP address will be provisioned. At this time, the - instance will not use this IP address for Internet egress traffic. The - address can be activated for use once any required firewall IP - whitelisting has been completed. **Note:** Not supported for Apigee - hybrid. - operationId: apigee.organizations.instances.natAddresses.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1NatAddress' + Approves or revokes the consumer key for an API product. After a + consumer key is approved, the app can use it to access APIs. A consumer + key that is revoked or pending cannot be used to access an API. Any + access tokens associated with a revoked consumer key will remain active. + However, Apigee checks the status of the consumer key and if set to + `revoked` will not allow access to the API. + operationId: >- + apigee.organizations.developers.apps.keys.apiproducts.updateDeveloperAppKeyApiProduct security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22277,7 +23330,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -22285,51 +23338,34 @@ paths: schema: type: string - in: path - name: instancesId + name: developersId required: true schema: type: string - /v1/organizations/{organizationsId}/instances/{instancesId}/natAddresses/{natAddressesId}: - parameters: *ref_1 - delete: - description: >- - Deletes the NAT address. Connections that are actively using the address - are drained before it is removed. **Note:** Not supported for Apigee - hybrid. - operationId: apigee.organizations.instances.natAddresses.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - in: path - name: organizationsId + name: appsId required: true schema: type: string - in: path - name: instancesId + name: keysId required: true schema: type: string - in: path - name: natAddressesId + name: apiproductsId required: true schema: type: string + - in: query + name: action + schema: + type: string + /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/attributes/{attributesId}: + parameters: *ref_1 get: - description: >- - Gets the details of a NAT address. **Note:** Not supported for Apigee - hybrid. - operationId: apigee.organizations.instances.natAddresses.get + description: Returns a developer app attribute. + operationId: apigee.organizations.developers.apps.attributes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22341,7 +23377,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1NatAddress' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' parameters: - in: path name: organizationsId @@ -22349,28 +23385,36 @@ paths: schema: type: string - in: path - name: instancesId + name: developersId + required: true + schema: + type: string + - in: path + name: appsId required: true schema: type: string - in: path - name: natAddressesId + name: attributesId required: true schema: type: string - /v1/organizations/{organizationsId}/instances/{instancesId}/natAddresses/{natAddressesId}:activate: - parameters: *ref_1 post: description: >- - Activates the NAT address. The Apigee instance can now use this for - Internet egress traffic. **Note:** Not supported for Apigee hybrid. - operationId: apigee.organizations.instances.natAddresses.activate + Updates a developer app attribute. **Note**: OAuth access tokens and Key + Management Service (KMS) entities (apps, developers, and API products) + are cached for 180 seconds (current default). Any custom attributes + associated with these entities are cached for at least 180 seconds after + the entity is accessed at runtime. Therefore, an `ExpiresIn` element on + the OAuthV2 policy won't be able to expire an access token in less than + 180 seconds. + operationId: >- + apigee.organizations.developers.apps.attributes.updateDeveloperAppAttribute requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ActivateNatAddressRequest + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22382,7 +23426,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' parameters: - in: path name: organizationsId @@ -22390,20 +23434,23 @@ paths: schema: type: string - in: path - name: instancesId + name: developersId required: true schema: type: string - in: path - name: natAddressesId + name: appsId required: true schema: type: string - /v1/organizations/{organizationsId}/instances/{instancesId}/canaryevaluations/{canaryevaluationsId}: - parameters: *ref_1 - get: - description: Gets a CanaryEvaluation for an organization. - operationId: apigee.organizations.instances.canaryevaluations.get + - in: path + name: attributesId + required: true + schema: + type: string + delete: + description: Deletes a developer app attribute. + operationId: apigee.organizations.developers.apps.attributes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22415,7 +23462,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1CanaryEvaluation' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' parameters: - in: path name: organizationsId @@ -22423,25 +23470,25 @@ paths: schema: type: string - in: path - name: instancesId + name: developersId required: true schema: type: string - in: path - name: canaryevaluationsId + name: appsId required: true schema: type: string - /v1/organizations/{organizationsId}/instances/{instancesId}/canaryevaluations: + - in: path + name: attributesId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/developers/{developersId}/attributes/{attributesId}: parameters: *ref_1 - post: - description: Creates a new canary evaluation for an organization. - operationId: apigee.organizations.instances.canaryevaluations.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1CanaryEvaluation' + get: + description: Returns the value of the specified developer attribute. + operationId: apigee.organizations.developers.attributes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22453,7 +23500,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' parameters: - in: path name: organizationsId @@ -22461,17 +23508,18 @@ paths: schema: type: string - in: path - name: instancesId + name: developersId required: true schema: type: string - /v1/organizations/{organizationsId}/instances: - parameters: *ref_1 - get: - description: >- - Lists all Apigee runtime instances for the organization. **Note:** Not - supported for Apigee hybrid. - operationId: apigee.organizations.instances.list + - in: path + name: attributesId + required: true + schema: + type: string + delete: + description: Deletes a developer attribute. + operationId: apigee.organizations.developers.attributes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22483,33 +23531,37 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ListInstancesResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: pageSize + - in: path + name: developersId + required: true schema: - type: integer - format: int32 - - in: query - name: pageToken + type: string + - in: path + name: attributesId + required: true schema: type: string post: description: >- - Creates an Apigee runtime instance. The instance is accessible from the - authorized network configured on the organization. **Note:** Not - supported for Apigee hybrid. - operationId: apigee.organizations.instances.create + Updates a developer attribute. **Note**: OAuth access tokens and Key + Management Service (KMS) entities (apps, developers, and API products) + are cached for 180 seconds (default). Any custom attributes associated + with these entities are cached for at least 180 seconds after the entity + is accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 + policy won't be able to expire an access token in less than 180 seconds. + operationId: apigee.organizations.developers.attributes.updateDeveloperAttribute requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Instance' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22521,24 +23573,34 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' parameters: - in: path name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}/instances/{instancesId}:reportStatus: + - in: path + name: developersId + required: true + schema: + type: string + - in: path + name: attributesId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/developers/{developersId}/balance:credit: parameters: *ref_1 post: - description: Reports the latest status for a runtime instance. - operationId: apigee.organizations.instances.reportStatus + description: Credits the account balance for the developer. + operationId: apigee.organizations.developers.balance.credit requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ReportInstanceStatusRequest + #/components/schemas/GoogleCloudApigeeV1CreditDeveloperBalanceRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22550,8 +23612,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ReportInstanceStatusResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperBalance' parameters: - in: path name: organizationsId @@ -22559,23 +23620,23 @@ paths: schema: type: string - in: path - name: instancesId + name: developersId required: true schema: type: string - /v1/organizations/{organizationsId}/instances/{instancesId}: + /v1/organizations/{organizationsId}/developers/{developersId}/balance:adjust: parameters: *ref_1 - patch: + post: description: >- - Updates an Apigee runtime instance. You can update the fields described - in NodeConfig. No other fields will be updated. **Note:** Not supported - for Apigee hybrid. - operationId: apigee.organizations.instances.patch + Adjust the prepaid balance for the developer. This API will be used in + scenarios where the developer has been under-charged or over-charged. + operationId: apigee.organizations.developers.balance.adjust requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Instance' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1AdjustDeveloperBalanceRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22587,7 +23648,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperBalance' parameters: - in: path name: organizationsId @@ -22595,20 +23656,20 @@ paths: schema: type: string - in: path - name: instancesId + name: developersId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - get: - description: >- - Gets the details for an Apigee runtime instance. **Note:** Not supported - for Apigee hybrid. - operationId: apigee.organizations.instances.get + /v1/organizations/{organizationsId}/developers/{developersId}/subscriptions: + parameters: *ref_1 + post: + description: 'Creates a subscription to an API product. ' + operationId: apigee.organizations.developers.subscriptions.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22620,7 +23681,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Instance' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription' parameters: - in: path name: organizationsId @@ -22628,16 +23689,13 @@ paths: schema: type: string - in: path - name: instancesId + name: developersId required: true schema: type: string - delete: - description: >- - Deletes an Apigee runtime instance. The instance stops serving requests - and the runtime data is deleted. **Note:** Not supported for Apigee - hybrid. - operationId: apigee.organizations.instances.delete + get: + description: Lists all API product subscriptions for a developer. + operationId: apigee.organizations.developers.subscriptions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22649,7 +23707,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListDeveloperSubscriptionsResponse parameters: - in: path name: organizationsId @@ -22657,15 +23716,24 @@ paths: schema: type: string - in: path - name: instancesId + name: developersId required: true schema: type: string - /v1/organizations/{organizationsId}/envgroups/{envgroupsId}/attachments/{attachmentsId}: + - in: query + name: startKey + schema: + type: string + - in: query + name: count + schema: + type: integer + format: int32 + /v1/organizations/{organizationsId}/developers/{developersId}/subscriptions/{subscriptionsId}: parameters: *ref_1 - delete: - description: Deletes an environment group attachment. - operationId: apigee.organizations.envgroups.attachments.delete + get: + description: Gets details for an API product subscription. + operationId: apigee.organizations.developers.subscriptions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22677,7 +23745,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription' parameters: - in: path name: organizationsId @@ -22685,18 +23753,26 @@ paths: schema: type: string - in: path - name: envgroupsId + name: developersId required: true schema: type: string - in: path - name: attachmentsId + name: subscriptionsId required: true schema: type: string - get: - description: Gets an environment group attachment. - operationId: apigee.organizations.envgroups.attachments.get + /v1/organizations/{organizationsId}/developers/{developersId}/subscriptions/{subscriptionsId}:expire: + parameters: *ref_1 + post: + description: Expires an API product subscription immediately. + operationId: apigee.organizations.developers.subscriptions.expire + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ExpireDeveloperSubscriptionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22708,8 +23784,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1EnvironmentGroupAttachment + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription' parameters: - in: path name: organizationsId @@ -22717,26 +23792,28 @@ paths: schema: type: string - in: path - name: envgroupsId + name: developersId required: true schema: type: string - in: path - name: attachmentsId + name: subscriptionsId required: true schema: type: string - /v1/organizations/{organizationsId}/envgroups/{envgroupsId}/attachments: + /v1/organizations/{organizationsId}/appgroups: parameters: *ref_1 post: - description: Creates a new attachment of an environment to an environment group. - operationId: apigee.organizations.envgroups.attachments.create + description: >- + Creates an AppGroup. Once created, user can register apps under the + AppGroup to obtain secret key and password. At creation time, the + AppGroup's state is set as `active`. + operationId: apigee.organizations.appgroups.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1EnvironmentGroupAttachment + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22748,21 +23825,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: envgroupsId - required: true - schema: - type: string get: - description: Lists all attachments of an environment group. - operationId: apigee.organizations.envgroups.attachments.list + description: >- + Lists all AppGroups in an organization. A maximum of 1000 AppGroups are + returned in the response if PageSize is not specified, or if the + PageSize is greater than 1000. + operationId: apigee.organizations.appgroups.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22774,21 +23849,15 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1ListAppGroupsResponse' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: envgroupsId - required: true - schema: - type: string - in: query - name: pageToken + name: filter schema: type: string - in: query @@ -22796,11 +23865,17 @@ paths: schema: type: integer format: int32 - /v1/organizations/{organizationsId}/envgroups/{envgroupsId}: + - in: query + name: pageToken + schema: + type: string + /v1/organizations/{organizationsId}/appgroups/{appgroupsId}: parameters: *ref_1 get: - description: Gets an environment group. - operationId: apigee.organizations.envgroups.get + description: >- + Returns the AppGroup details for the provided AppGroup name in the + request URI. + operationId: apigee.organizations.appgroups.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22812,7 +23887,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroup' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' parameters: - in: path name: organizationsId @@ -22820,13 +23895,19 @@ paths: schema: type: string - in: path - name: envgroupsId + name: appgroupsId required: true schema: type: string delete: - description: Deletes an environment group. - operationId: apigee.organizations.envgroups.delete + description: >- + Deletes an AppGroup. All app and API keys associations with the AppGroup + are also removed. **Warning**: This API will permanently delete the + AppGroup and related artifacts. **Note**: The delete operation is + asynchronous. The AppGroup is deleted immediately, but its associated + resources, such as apps and API keys, may take anywhere from a few + seconds to a few minutes to be deleted. + operationId: apigee.organizations.appgroups.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22838,7 +23919,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' parameters: - in: path name: organizationsId @@ -22846,18 +23927,23 @@ paths: schema: type: string - in: path - name: envgroupsId + name: appgroupsId required: true schema: type: string - patch: - description: Updates an environment group. - operationId: apigee.organizations.envgroups.patch + put: + description: >- + Updates an AppGroup. This API replaces the existing AppGroup details + with those specified in the request. Include or exclude any existing + details that you want to retain or delete, respectively. Note that the + state of the AppGroup should be updated using `action`, and not via + AppGroup. + operationId: apigee.organizations.appgroups.update requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroup' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22869,7 +23955,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' parameters: - in: path name: organizationsId @@ -22877,25 +23963,29 @@ paths: schema: type: string - in: path - name: envgroupsId + name: appgroupsId required: true schema: type: string - in: query - name: updateMask + name: action schema: type: string - format: google-fieldmask - /v1/organizations/{organizationsId}/envgroups: + /v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps: parameters: *ref_1 post: - description: Creates a new environment group. - operationId: apigee.organizations.envgroups.create + description: >- + Creates an app and associates it with an AppGroup. This API associates + the AppGroup app with the specified API product and auto-generates an + API key for the app to use in calls to API proxies inside that API + product. The `name` is the unique ID of the app that you can use in API + calls. + operationId: apigee.organizations.appgroups.apps.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroup' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22907,20 +23997,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: name + - in: path + name: appgroupsId + required: true schema: type: string get: - description: Lists all environment groups. - operationId: apigee.organizations.envgroups.list + description: >- + Lists all apps created by an AppGroup in an Apigee organization. + Optionally, you can request an expanded view of the AppGroup apps. Lists + all AppGroupApps in an AppGroup. A maximum of 1000 AppGroup apps are + returned in the response if PageSize is not specified, or if the + PageSize is greater than 1000. + operationId: apigee.organizations.appgroups.apps.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22933,13 +24029,18 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListEnvironmentGroupsResponse + #/components/schemas/GoogleCloudApigeeV1ListAppGroupAppsResponse parameters: - in: path name: organizationsId required: true schema: type: string + - in: path + name: appgroupsId + required: true + schema: + type: string - in: query name: pageSize schema: @@ -22949,11 +24050,15 @@ paths: name: pageToken schema: type: string - /v1/organizations/{organizationsId}/envgroups/{envgroupsId}/deployedIngressConfig: + /v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps/{appsId}: parameters: *ref_1 - get: - description: Gets the deployed ingress configuration for an environment group. - operationId: apigee.organizations.envgroups.getDeployedIngressConfig + delete: + description: >- + Deletes an AppGroup app. **Note**: The delete operation is asynchronous. + The AppGroup app is deleted immediately, but its associated resources, + such as app keys or access tokens, may take anywhere from a few seconds + to a few minutes to be deleted. + operationId: apigee.organizations.appgroups.apps.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22965,7 +24070,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroupConfig' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' parameters: - in: path name: organizationsId @@ -22973,22 +24078,18 @@ paths: schema: type: string - in: path - name: envgroupsId + name: appgroupsId required: true schema: type: string - - in: query - name: view + - in: path + name: appsId + required: true schema: type: string - /v1/organizations/{organizationsId}/apps: - parameters: *ref_1 get: - description: >- - Lists IDs of apps within an organization that have the specified app - status (approved or revoked) or are of the specified app type (developer - or company). - operationId: apigee.organizations.apps.list + description: Returns the details for an AppGroup app. + operationId: apigee.organizations.appgroups.apps.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23000,68 +24101,40 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ListAppsResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: expand - schema: - type: boolean - - in: query - name: rows - schema: - type: string - format: int64 - - in: query - name: ids - schema: - type: string - - in: query - name: includeCred - schema: - type: boolean - - in: query - name: filter - schema: - type: string - - in: query - name: apiProduct - schema: - type: string - - in: query - name: apptype - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: status - schema: - type: string - - in: query - name: startKey - schema: - type: string - - in: query - name: keyStatus + - in: path + name: appgroupsId + required: true schema: type: string - - in: query - name: pageToken + - in: path + name: appsId + required: true schema: type: string - /v1/organizations/{organizationsId}/apps/{appsId}: - parameters: *ref_1 - get: - description: Gets the app profile for the specified app ID. - operationId: apigee.organizations.apps.get + put: + description: >- + Updates the details for an AppGroup app. In addition, you can add an API + product to an AppGroup app and automatically generate an API key for the + app to use when calling APIs in the API product. If you want to use an + existing API key for the API product, add the API product to the API key + using the UpdateAppGroupAppKey API. Using this API, you cannot update + the app name, as it is the primary key used to identify the app and + cannot be changed. This API replaces the existing attributes with those + specified in the request. Include or exclude any existing attributes + that you want to retain or delete, respectively. + operationId: apigee.organizations.appgroups.apps.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23073,23 +24146,49 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1App' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' parameters: - in: path name: organizationsId required: true schema: type: string + - in: path + name: appgroupsId + required: true + schema: + type: string - in: path name: appsId required: true schema: type: string - /v1/organizations/{organizationsId}/endpointAttachments/{endpointAttachmentsId}: + - in: query + name: action + schema: + type: string + /v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps/{appsId}/keys: parameters: *ref_1 - get: - description: Gets the endpoint attachment. - operationId: apigee.organizations.endpointAttachments.get + post: + description: >- + Creates a custom consumer key and secret for a AppGroup app. This is + particularly useful if you want to migrate existing consumer keys and + secrets to Apigee from another system. Consumer keys and secrets can + contain letters, numbers, underscores, and hyphens. No other special + characters are allowed. To avoid service disruptions, a consumer key and + secret should not exceed 2 KBs each. **Note**: When creating the + consumer key and secret, an association to API products will not be + made. Therefore, you should not specify the associated API products in + your request. Instead, use the UpdateAppGroupAppKey API to make the + association after the consumer key and secret are created. If a consumer + key and secret already exist, you can keep them or delete them using the + DeleteAppGroupAppKey API. + operationId: apigee.organizations.appgroups.apps.keys.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23101,7 +24200,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1EndpointAttachment' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' parameters: - in: path name: organizationsId @@ -23109,13 +24208,23 @@ paths: schema: type: string - in: path - name: endpointAttachmentsId + name: appgroupsId + required: true + schema: + type: string + - in: path + name: appsId required: true schema: type: string + /v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps/{appsId}/keys/{keysId}: + parameters: *ref_1 delete: - description: Deletes an endpoint attachment. - operationId: apigee.organizations.endpointAttachments.delete + description: >- + Deletes an app's consumer key and removes all API products associated + with the app. After the consumer key is deleted, it cannot be used to + access any APIs. + operationId: apigee.organizations.appgroups.apps.keys.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23127,7 +24236,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' parameters: - in: path name: organizationsId @@ -23135,15 +24244,25 @@ paths: schema: type: string - in: path - name: endpointAttachmentsId + name: appgroupsId + required: true + schema: + type: string + - in: path + name: appsId + required: true + schema: + type: string + - in: path + name: keysId required: true schema: type: string - /v1/organizations/{organizationsId}/endpointAttachments: - parameters: *ref_1 get: - description: Lists the endpoint attachments in an organization. - operationId: apigee.organizations.endpointAttachments.list + description: >- + Gets details for a consumer key for a AppGroup app, including the key + and secret value, associated API products, and other information. + operationId: apigee.organizations.appgroups.apps.keys.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23155,33 +24274,44 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListEndpointAttachmentsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: pageSize + - in: path + name: appgroupsId + required: true schema: - type: integer - format: int32 - - in: query - name: pageToken + type: string + - in: path + name: appsId + required: true + schema: + type: string + - in: path + name: keysId + required: true schema: type: string post: description: >- - Creates an endpoint attachment. **Note:** Not supported for Apigee - hybrid. - operationId: apigee.organizations.endpointAttachments.create + Adds an API product to an AppGroupAppKey, enabling the app that holds + the key to access the API resources bundled in the API product. In + addition, you can add attributes and scopes to the AppGroupAppKey. This + API replaces the existing attributes with those specified in the + request. Include or exclude any existing attributes that you want to + retain or delete, respectively. You can use the same key to access all + API products associated with the app. + operationId: apigee.organizations.appgroups.apps.keys.updateAppGroupAppKey requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1EndpointAttachment' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1UpdateAppGroupAppKeyRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23193,30 +24323,40 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: endpointAttachmentId + - in: path + name: appgroupsId + required: true schema: type: string - /v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}/environments: + - in: path + name: appsId + required: true + schema: + type: string + - in: path + name: keysId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps/{appsId}/keys/{keysId}/apiproducts/{apiproductsId}: parameters: *ref_1 post: description: >- - CreateSecurityProfileEnvironmentAssociation creates profile environment - association i.e. attaches environment to security profile. - operationId: apigee.organizations.securityProfiles.environments.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation + Approves or revokes the consumer key for an API product. After a + consumer key is approved, the app can use it to access APIs. A consumer + key that is revoked or pending cannot be used to access an API. Any + access tokens associated with a revoked consumer key will remain active. + However, Apigee checks the status of the consumer key and if set to + `revoked` will not allow access to the API. + operationId: >- + apigee.organizations.appgroups.apps.keys.apiproducts.updateAppGroupAppKeyApiProduct security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23228,8 +24368,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -23237,24 +24376,36 @@ paths: schema: type: string - in: path - name: securityProfilesId + name: appgroupsId required: true schema: type: string - /v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}/environments/{environmentsId}:computeEnvironmentScores: - parameters: *ref_1 - post: + - in: path + name: appsId + required: true + schema: + type: string + - in: path + name: keysId + required: true + schema: + type: string + - in: path + name: apiproductsId + required: true + schema: + type: string + - in: query + name: action + schema: + type: string + delete: description: >- - ComputeEnvironmentScores calculates scores for requested time range for - the specified security profile and environment. - operationId: >- - apigee.organizations.securityProfiles.environments.computeEnvironmentScores - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ComputeEnvironmentScoresRequest + Removes an API product from an app's consumer key. After the API product + is removed, the app cannot access the API resources defined in that API + product. **Note**: The consumer key is not removed, only its association + with the API product. + operationId: apigee.organizations.appgroups.apps.keys.apiproducts.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23266,8 +24417,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ComputeEnvironmentScoresResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' parameters: - in: path name: organizationsId @@ -23275,22 +24425,39 @@ paths: schema: type: string - in: path - name: securityProfilesId + name: appgroupsId required: true schema: type: string - in: path - name: environmentsId + name: appsId required: true schema: type: string - /v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}/environments/{environmentsId}: + - in: path + name: keysId + required: true + schema: + type: string + - in: path + name: apiproductsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/hostSecurityReports: parameters: *ref_1 - delete: + post: description: >- - DeleteSecurityProfileEnvironmentAssociation removes profile environment - association i.e. detaches environment from security profile. - operationId: apigee.organizations.securityProfiles.environments.delete + Submit a query at host level to be processed in the background. If the + submission of the query succeeds, the API returns a 201 status and an ID + that refer to the query. In addition to the HTTP status 201, the `state` + of "enqueued" means that the request succeeded. + operationId: apigee.organizations.hostSecurityReports.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportQuery' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23302,33 +24469,76 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' parameters: - in: path name: organizationsId required: true schema: type: string + get: + description: Return a list of Security Reports at host level. + operationId: apigee.organizations.hostSecurityReports.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListSecurityReportsResponse + parameters: - in: path - name: securityProfilesId + name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true + - in: query + name: submittedBy schema: type: string - /v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}: + - in: query + name: status + schema: + type: string + - in: query + name: from + schema: + type: string + - in: query + name: to + schema: + type: string + - in: query + name: dataset + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: envgroupHostname + schema: + type: string + /v1/organizations/{organizationsId}/hostSecurityReports/{hostSecurityReportsId}: parameters: *ref_1 - patch: - description: UpdateSecurityProfile update the metadata of security profile. - operationId: apigee.organizations.securityProfiles.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' + get: + description: >- + Get status of a query submitted at host level. If the query is still in + progress, the `state` is set to "running" After the query has completed + successfully, `state` is set to "completed" + operationId: apigee.organizations.hostSecurityReports.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23340,7 +24550,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' parameters: - in: path name: organizationsId @@ -23348,21 +24558,20 @@ paths: schema: type: string - in: path - name: securityProfilesId + name: hostSecurityReportsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - get: - description: >- - GetSecurityProfile gets the specified security profile. Returns - NOT_FOUND if security profile is not present for the specified - organization. - operationId: apigee.organizations.securityProfiles.get + /v1/organizations/{organizationsId}/hostSecurityReports/{hostSecurityReportsId}/result: + parameters: *ref_1 + get: + description: >- + After the query is completed, use this API to retrieve the results. If + the request succeeds, and there is a non-zero result set, the result is + downloaded to the client as a zipped JSON file. The name of the + downloaded file will be: OfflineQueryResult-.zip Example: + `OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip` + operationId: apigee.organizations.hostSecurityReports.getResult security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23374,7 +24583,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: organizationsId @@ -23382,13 +24591,17 @@ paths: schema: type: string - in: path - name: securityProfilesId + name: hostSecurityReportsId required: true schema: type: string - delete: - description: DeleteSecurityProfile delete a profile with all its revisions. - operationId: apigee.organizations.securityProfiles.delete + /v1/organizations/{organizationsId}/hostSecurityReports/{hostSecurityReportsId}/resultView: + parameters: *ref_1 + get: + description: >- + After the query is completed, use this API to view the query result when + result size is small. + operationId: apigee.organizations.hostSecurityReports.getResultView security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23400,7 +24613,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityReportResultView parameters: - in: path name: organizationsId @@ -23408,17 +24622,20 @@ paths: schema: type: string - in: path - name: securityProfilesId + name: hostSecurityReportsId required: true schema: type: string - /v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}:listRevisions: + /v1/organizations/{organizationsId}/securityProfiles: parameters: *ref_1 - get: - description: >- - ListSecurityProfileRevisions lists all the revisions of the security - profile. - operationId: apigee.organizations.securityProfiles.listRevisions + post: + description: CreateSecurityProfile create a new custom security profile. + operationId: apigee.organizations.securityProfiles.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23430,30 +24647,17 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListSecurityProfileRevisionsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: securityProfilesId - required: true - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - in: query - name: pageToken + name: securityProfileId schema: type: string - /v1/organizations/{organizationsId}/securityProfiles: - parameters: *ref_1 get: description: >- ListSecurityProfiles lists all the security profiles associated with the @@ -23478,18 +24682,20 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - in: query name: pageSize schema: type: integer format: int32 - post: - description: CreateSecurityProfile create a new custom security profile. - operationId: apigee.organizations.securityProfiles.create + - in: query + name: pageToken + schema: + type: string + /v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}: + parameters: *ref_1 + patch: + description: UpdateSecurityProfile update the metadata of security profile. + operationId: apigee.organizations.securityProfiles.patch requestBody: content: application/json: @@ -23513,20 +24719,19 @@ paths: required: true schema: type: string + - in: path + name: securityProfilesId + required: true + schema: + type: string - in: query - name: securityProfileId + name: updateMask schema: type: string - /v1/organizations/{organizationsId}/securityProfilesV2: - parameters: *ref_1 - post: - description: Create a security profile v2. - operationId: apigee.organizations.securityProfilesV2.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfileV2' + format: google-fieldmask + delete: + description: DeleteSecurityProfile delete a profile with all its revisions. + operationId: apigee.organizations.securityProfiles.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23538,20 +24743,24 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfileV2' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: securityProfileV2Id + - in: path + name: securityProfilesId + required: true schema: type: string get: - description: List security profiles v2. - operationId: apigee.organizations.securityProfilesV2.list + description: >- + GetSecurityProfile gets the specified security profile. Returns + NOT_FOUND if security profile is not present for the specified + organization. + operationId: apigee.organizations.securityProfiles.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23563,28 +24772,25 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListSecurityProfilesV2Response + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: securityProfilesId + required: true schema: type: string - /v1/organizations/{organizationsId}/securityProfilesV2/{securityProfilesV2Id}: + /v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}:listRevisions: parameters: *ref_1 get: - description: Get a security profile v2. - operationId: apigee.organizations.securityProfilesV2.get + description: >- + ListSecurityProfileRevisions lists all the revisions of the security + profile. + operationId: apigee.organizations.securityProfiles.listRevisions security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23596,7 +24802,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfileV2' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListSecurityProfileRevisionsResponse parameters: - in: path name: organizationsId @@ -23604,18 +24811,32 @@ paths: schema: type: string - in: path - name: securityProfilesV2Id + name: securityProfilesId required: true schema: type: string - patch: - description: Update a security profile V2. - operationId: apigee.organizations.securityProfilesV2.patch + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}/environments: + parameters: *ref_1 + post: + description: >- + CreateSecurityProfileEnvironmentAssociation creates profile environment + association i.e. attaches environment to security profile. + operationId: apigee.organizations.securityProfiles.environments.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfileV2' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23627,7 +24848,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfileV2' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation parameters: - in: path name: organizationsId @@ -23635,18 +24857,17 @@ paths: schema: type: string - in: path - name: securityProfilesV2Id + name: securityProfilesId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask + /v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}/environments/{environmentsId}: + parameters: *ref_1 delete: - description: Delete a security profile v2. - operationId: apigee.organizations.securityProfilesV2.delete + description: >- + DeleteSecurityProfileEnvironmentAssociation removes profile environment + association i.e. detaches environment from security profile. + operationId: apigee.organizations.securityProfiles.environments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23666,15 +24887,29 @@ paths: schema: type: string - in: path - name: securityProfilesV2Id + name: securityProfilesId required: true schema: type: string - /v1/organizations/{organizationsId}/analytics/datastores/{datastoresId}: + - in: path + name: environmentsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}/environments/{environmentsId}:computeEnvironmentScores: parameters: *ref_1 - get: - description: Get a Datastore - operationId: apigee.organizations.analytics.datastores.get + post: + description: >- + ComputeEnvironmentScores calculates scores for requested time range for + the specified security profile and environment. + operationId: >- + apigee.organizations.securityProfiles.environments.computeEnvironmentScores + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ComputeEnvironmentScoresRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23686,7 +24921,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ComputeEnvironmentScoresResponse parameters: - in: path name: organizationsId @@ -23694,44 +24930,26 @@ paths: schema: type: string - in: path - name: datastoresId - required: true - schema: - type: string - delete: - description: Delete a Datastore from an org. - operationId: apigee.organizations.analytics.datastores.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' - parameters: - - in: path - name: organizationsId + name: securityProfilesId required: true schema: type: string - in: path - name: datastoresId + name: environmentsId required: true schema: type: string - put: - description: Update a Datastore - operationId: apigee.organizations.analytics.datastores.update + /v1/organizations/{organizationsId}/securityAssessmentResults:batchCompute: + parameters: *ref_1 + post: + description: Compute RAV2 security scores for a set of resources. + operationId: apigee.organizations.securityAssessmentResults.batchCompute requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23743,31 +24961,24 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: datastoresId - required: true - schema: - type: string - /v1/organizations/{organizationsId}/analytics/datastores:test: + /v1/organizations/{organizationsId}/securityProfilesV2: parameters: *ref_1 post: - description: >- - Test if Datastore configuration is correct. This includes checking if - credentials provided by customer have required permissions in target - destination storage - operationId: apigee.organizations.analytics.datastores.test + description: Create a security profile v2. + operationId: apigee.organizations.securityProfilesV2.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfileV2' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23779,18 +24990,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TestDatastoreResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfileV2' parameters: - in: path name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}/analytics/datastores: - parameters: *ref_1 + - in: query + name: securityProfileV2Id + schema: + type: string get: - description: List Datastores - operationId: apigee.organizations.analytics.datastores.list + description: List security profiles v2. + operationId: apigee.organizations.securityProfilesV2.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23802,7 +25015,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ListDatastoresResponse' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListSecurityProfilesV2Response parameters: - in: path name: organizationsId @@ -23810,17 +25024,19 @@ paths: schema: type: string - in: query - name: targetType + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - post: - description: Create a Datastore for an org - operationId: apigee.organizations.analytics.datastores.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' + /v1/organizations/{organizationsId}/securityProfilesV2/{securityProfilesV2Id}: + parameters: *ref_1 + get: + description: Get a security profile v2. + operationId: apigee.organizations.securityProfilesV2.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23832,21 +25048,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfileV2' parameters: - in: path name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}/apis/{apisId}: - parameters: *ref_1 - delete: - description: >- - Deletes an API proxy and all associated endpoints, policies, resources, - and revisions. The API proxy must be undeployed before you can delete - it. - operationId: apigee.organizations.apis.delete + - in: path + name: securityProfilesV2Id + required: true + schema: + type: string + patch: + description: Update a security profile V2. + operationId: apigee.organizations.securityProfilesV2.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfileV2' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23858,7 +25079,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfileV2' parameters: - in: path name: organizationsId @@ -23866,13 +25087,18 @@ paths: schema: type: string - in: path - name: apisId + name: securityProfilesV2Id required: true schema: type: string - get: - description: Gets an API proxy including a list of existing revisions. - operationId: apigee.organizations.apis.get + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Delete a security profile v2. + operationId: apigee.organizations.securityProfilesV2.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23884,7 +25110,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -23892,18 +25118,21 @@ paths: schema: type: string - in: path - name: apisId + name: securityProfilesV2Id required: true schema: type: string - patch: - description: Updates an existing API proxy. - operationId: apigee.organizations.apis.patch + /v1/organizations/{organizationsId}/securityMonitoringConditions: + parameters: *ref_1 + post: + description: Create a security monitoring condition. + operationId: apigee.organizations.securityMonitoringConditions.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityMonitoringCondition security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23915,31 +25144,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityMonitoringCondition parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: apisId - required: true - schema: - type: string - in: query - name: updateMask + name: securityMonitoringConditionId schema: type: string - format: google-fieldmask - /v1/organizations/{organizationsId}/apis: - parameters: *ref_1 get: - description: >- - Lists the names of all API proxies in an organization. The names - returned correspond to the names defined in the configuration files for - each API proxy. - operationId: apigee.organizations.apis.list + description: List security monitoring conditions. + operationId: apigee.organizations.securityMonitoringConditions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23951,7 +25170,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ListApiProxiesResponse' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListSecurityMonitoringConditionsResponse parameters: - in: path name: organizationsId @@ -23959,36 +25179,23 @@ paths: schema: type: string - in: query - name: includeRevisions + name: pageSize schema: - type: boolean + type: integer + format: int32 - in: query - name: includeMetaData + name: pageToken schema: - type: boolean - post: - description: >- - Creates an API proxy. The API proxy created will not be accessible at - runtime until it is deployed to an environment. Create a new API proxy - by setting the `name` query parameter to the name of the API proxy. - Import an API proxy configuration bundle stored in zip format on your - local machine to your organization by doing the following: * Set the - `name` query parameter to the name of the API proxy. * Set the `action` - query parameter to `import`. * Set the `Content-Type` header to - `multipart/form-data`. * Pass as a file the name of API proxy - configuration bundle stored in zip format on your local machine using - the `file` form field. **Note**: To validate the API proxy configuration - bundle only without importing it, set the `action` query parameter to - `validate`. When importing an API proxy configuration bundle, if the API - proxy does not exist, it will be created. If the API proxy exists, then - a new revision is created. Invalid API proxy configurations are - rejected, and a list of validation errors is returned to the client. - operationId: apigee.organizations.apis.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + type: string + - in: query + name: filter + schema: + type: string + /v1/organizations/{organizationsId}/securityMonitoringConditions/{securityMonitoringConditionsId}: + parameters: *ref_1 + get: + description: Get a security monitoring condition. + operationId: apigee.organizations.securityMonitoringConditions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24000,30 +25207,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxyRevision' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityMonitoringCondition parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: name - schema: - type: string - - in: query - name: validate - schema: - type: boolean - - in: query - name: action + - in: path + name: securityMonitoringConditionsId + required: true schema: type: string - /v1/organizations/{organizationsId}/apis/{apisId}/revisions/{revisionsId}/deployments: - parameters: *ref_1 - get: - description: Lists all deployments of an API proxy revision. - operationId: apigee.organizations.apis.revisions.deployments.list + patch: + description: Update a security monitoring condition. + operationId: apigee.organizations.securityMonitoringConditions.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityMonitoringCondition security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24036,7 +25241,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse + #/components/schemas/GoogleCloudApigeeV1SecurityMonitoringCondition parameters: - in: path name: organizationsId @@ -24044,23 +25249,18 @@ paths: schema: type: string - in: path - name: apisId + name: securityMonitoringConditionsId required: true schema: type: string - - in: path - name: revisionsId - required: true + - in: query + name: updateMask schema: type: string - /v1/organizations/{organizationsId}/apis/{apisId}/revisions/{revisionsId}: - parameters: *ref_1 + format: google-fieldmask delete: - description: >- - Deletes an API proxy revision and all policies, resources, endpoints, - and revisions associated with it. The API proxy revision must be - undeployed before you can delete it. - operationId: apigee.organizations.apis.revisions.delete + description: Delete a security monitoring condition. + operationId: apigee.organizations.securityMonitoringConditions.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24072,7 +25272,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxyRevision' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -24080,29 +25280,20 @@ paths: schema: type: string - in: path - name: apisId - required: true - schema: - type: string - - in: path - name: revisionsId + name: securityMonitoringConditionsId required: true schema: type: string + /v1/organizations/{organizationsId}/keyvaluemaps: + parameters: *ref_1 post: - description: >- - Updates an existing API proxy revision by uploading the API proxy - configuration bundle as a zip file from your local machine. You can - update only API proxy revisions that have never been deployed. After - deployment, an API proxy revision becomes immutable, even if it is - undeployed. Set the `Content-Type` header to either - `multipart/form-data` or `application/octet-stream`. - operationId: apigee.organizations.apis.revisions.updateApiProxyRevision + description: Creates a key value map in an organization. + operationId: apigee.organizations.keyvaluemaps.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24114,37 +25305,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxyRevision' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: apisId - required: true - schema: - type: string - - in: path - name: revisionsId - required: true - schema: - type: string - - in: query - name: validate - schema: - type: boolean - get: - description: >- - Gets an API proxy revision. To download the API proxy configuration - bundle for the specified revision as a zip file, set the `format` query - parameter to `bundle`. If you are using curl, specify `-o filename.zip` - to save the output to a file; otherwise, it displays to `stdout`. Then, - develop the API proxy configuration locally and upload the updated API - proxy configuration revision, as described in - [updateApiProxyRevision](updateApiProxyRevision). - operationId: apigee.organizations.apis.revisions.get + /v1/organizations/{organizationsId}/keyvaluemaps/{keyvaluemapsId}: + parameters: *ref_1 + delete: + description: Deletes a key value map from an organization. + operationId: apigee.organizations.keyvaluemaps.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24156,7 +25328,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' parameters: - in: path name: organizationsId @@ -24164,27 +25336,18 @@ paths: schema: type: string - in: path - name: apisId - required: true - schema: - type: string - - in: path - name: revisionsId + name: keyvaluemapsId required: true schema: type: string - - in: query - name: format - schema: - type: string - /v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps/{keyvaluemapsId}/entries/{entriesId}: + /v1/organizations/{organizationsId}/keyvaluemaps/{keyvaluemapsId}/entries/{entriesId}: parameters: *ref_1 get: description: >- Get the key value entry value for a key value map scoped to an organization, environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x and higher. - operationId: apigee.organizations.apis.keyvaluemaps.entries.get + operationId: apigee.organizations.keyvaluemaps.entries.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24203,11 +25366,6 @@ paths: required: true schema: type: string - - in: path - name: apisId - required: true - schema: - type: string - in: path name: keyvaluemapsId required: true @@ -24225,7 +25383,7 @@ paths: the key value entry, the policy consuming the entry will continue to function with its cached values for a few minutes. This is expected behavior. * Supported for Apigee hybrid 1.8.x and higher. - operationId: apigee.organizations.apis.keyvaluemaps.entries.delete + operationId: apigee.organizations.keyvaluemaps.entries.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24244,11 +25402,6 @@ paths: required: true schema: type: string - - in: path - name: apisId - required: true - schema: - type: string - in: path name: keyvaluemapsId required: true @@ -24263,7 +25416,7 @@ paths: description: >- Update key value entry scoped to an organization, environment, or API proxy for an existing key. - operationId: apigee.organizations.apis.keyvaluemaps.entries.update + operationId: apigee.organizations.keyvaluemaps.entries.update requestBody: content: application/json: @@ -24288,28 +25441,57 @@ paths: schema: type: string - in: path - name: apisId + name: keyvaluemapsId required: true schema: type: string - in: path - name: keyvaluemapsId + name: entriesId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/keyvaluemaps/{keyvaluemapsId}/entries: + parameters: *ref_1 + post: + description: >- + Creates key value entries in a key value map scoped to an organization, + environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x + and higher. + operationId: apigee.organizations.keyvaluemaps.entries.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + parameters: + - in: path + name: organizationsId required: true schema: type: string - in: path - name: entriesId + name: keyvaluemapsId required: true schema: type: string - /v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps/{keyvaluemapsId}/entries: - parameters: *ref_1 get: description: >- Lists key value entries for key values maps scoped to an organization, environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x and higher. - operationId: apigee.organizations.apis.keyvaluemaps.entries.list + operationId: apigee.organizations.keyvaluemaps.entries.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24329,11 +25511,6 @@ paths: required: true schema: type: string - - in: path - name: apisId - required: true - schema: - type: string - in: path name: keyvaluemapsId required: true @@ -24348,17 +25525,16 @@ paths: name: pageToken schema: type: string + /v1/organizations/{organizationsId}/sites/{sitesId}/apicategories: + parameters: *ref_1 post: - description: >- - Creates key value entries in a key value map scoped to an organization, - environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x - and higher. - operationId: apigee.organizations.apis.keyvaluemaps.entries.create + description: Creates a new API category. + operationId: apigee.organizations.sites.apicategories.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategory' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24370,7 +25546,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategoryResponse' parameters: - in: path name: organizationsId @@ -24378,20 +25554,42 @@ paths: schema: type: string - in: path - name: apisId + name: sitesId + required: true + schema: + type: string + get: + description: Returns the API categories associated with a portal. + operationId: apigee.organizations.sites.apicategories.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListApiCategoriesResponse + parameters: + - in: path + name: organizationsId required: true schema: type: string - in: path - name: keyvaluemapsId + name: sitesId required: true schema: type: string - /v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps/{keyvaluemapsId}: + /v1/organizations/{organizationsId}/sites/{sitesId}/apicategories/{apicategoriesId}: parameters: *ref_1 delete: - description: Deletes a key value map from an API proxy. - operationId: apigee.organizations.apis.keyvaluemaps.delete + description: Deletes an API category. + operationId: apigee.organizations.sites.apicategories.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24403,7 +25601,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeleteResponse' parameters: - in: path name: organizationsId @@ -24411,25 +25609,23 @@ paths: schema: type: string - in: path - name: apisId + name: sitesId required: true schema: type: string - in: path - name: keyvaluemapsId + name: apicategoriesId required: true schema: type: string - /v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps: - parameters: *ref_1 - post: - description: Creates a key value map in an API proxy. - operationId: apigee.organizations.apis.keyvaluemaps.create + patch: + description: Updates an API category. + operationId: apigee.organizations.sites.apicategories.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategory' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24441,7 +25637,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategoryResponse' parameters: - in: path name: organizationsId @@ -24449,15 +25645,18 @@ paths: schema: type: string - in: path - name: apisId + name: sitesId + required: true + schema: + type: string + - in: path + name: apicategoriesId required: true schema: type: string - /v1/organizations/{organizationsId}/apis/{apisId}/deployments: - parameters: *ref_1 get: - description: Lists all deployments of an API proxy. - operationId: apigee.organizations.apis.deployments.list + description: Gets an API category. + operationId: apigee.organizations.sites.apicategories.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24469,8 +25668,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategoryResponse' parameters: - in: path name: organizationsId @@ -24478,21 +25676,20 @@ paths: schema: type: string - in: path - name: apisId + name: sitesId required: true schema: type: string - /v1/organizations/{organizationsId}/securityAssessmentResults:batchCompute: + - in: path + name: apicategoriesId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/sites/{sitesId}/apidocs/{apidocsId}: parameters: *ref_1 - post: - description: Compute RAV2 security scores for a set of resources. - operationId: apigee.organizations.securityAssessmentResults.batchCompute - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequest + get: + description: Gets a catalog item. + operationId: apigee.organizations.sites.apidocs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24504,28 +25701,31 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDocResponse' parameters: - in: path name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}/hostQueries: - parameters: *ref_1 - post: - description: >- - Submit a query at host level to be processed in the background. If the - submission of the query succeeds, the API returns a 201 status and an ID - that refer to the query. In addition to the HTTP status 201, the `state` - of "enqueued" means that the request succeeded. - operationId: apigee.organizations.hostQueries.create + - in: path + name: sitesId + required: true + schema: + type: string + - in: path + name: apidocsId + required: true + schema: + type: string + put: + description: Updates a catalog item. + operationId: apigee.organizations.sites.apidocs.update requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Query' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDoc' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24537,16 +25737,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQuery' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDocResponse' parameters: - in: path name: organizationsId required: true schema: type: string - get: - description: Return a list of Asynchronous Queries at host level. - operationId: apigee.organizations.hostQueries.list + - in: path + name: sitesId + required: true + schema: + type: string + - in: path + name: apidocsId + required: true + schema: + type: string + delete: + description: Deletes a catalog item. + operationId: apigee.organizations.sites.apidocs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24558,47 +25768,59 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListAsyncQueriesResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1DeleteResponse' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: submittedBy - schema: - type: string - - in: query - name: status - schema: - type: string - - in: query - name: envgroupHostname - schema: - type: string - - in: query - name: from + - in: path + name: sitesId + required: true schema: type: string - - in: query - name: dataset + - in: path + name: apidocsId + required: true schema: type: string - - in: query - name: inclQueriesWithoutReport + /v1/organizations/{organizationsId}/sites/{sitesId}/apidocs: + parameters: *ref_1 + post: + description: Creates a new catalog item. + operationId: apigee.organizations.sites.apidocs.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDoc' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDocResponse' + parameters: + - in: path + name: organizationsId + required: true schema: type: string - - in: query - name: to + - in: path + name: sitesId + required: true schema: type: string - /v1/organizations/{organizationsId}/hostQueries/{hostQueriesId}/resultView: - parameters: *ref_1 get: - description: '' - operationId: apigee.organizations.hostQueries.getResultView + description: Returns the catalog items associated with a portal. + operationId: apigee.organizations.sites.apidocs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24610,7 +25832,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQueryResultView' + $ref: '#/components/schemas/GoogleCloudApigeeV1ListApiDocsResponse' parameters: - in: path name: organizationsId @@ -24618,18 +25840,31 @@ paths: schema: type: string - in: path - name: hostQueriesId + name: sitesId required: true schema: type: string - /v1/organizations/{organizationsId}/hostQueries/{hostQueriesId}: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/organizations/{organizationsId}/sites/{sitesId}/apidocs/{apidocsId}/documentation: parameters: *ref_1 - get: + patch: description: >- - Get status of a query submitted at host level. If the query is still in - progress, the `state` is set to "running" After the query has completed - successfully, `state` is set to "completed" - operationId: apigee.organizations.hostQueries.get + Updates the documentation for the specified catalog item. Note that the + documentation file contents will not be populated in the return message. + operationId: apigee.organizations.sites.apidocs.updateDocumentation + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDocDocumentation' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24641,7 +25876,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQuery' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ApiDocDocumentationResponse parameters: - in: path name: organizationsId @@ -24649,20 +25885,18 @@ paths: schema: type: string - in: path - name: hostQueriesId + name: sitesId + required: true + schema: + type: string + - in: path + name: apidocsId required: true schema: type: string - /v1/organizations/{organizationsId}/hostQueries/{hostQueriesId}/result: - parameters: *ref_1 get: - description: >- - After the query is completed, use this API to retrieve the results. If - the request succeeds, and there is a non-zero result set, the result is - downloaded to the client as a zipped JSON file. The name of the - downloaded file will be: OfflineQueryResult-.zip Example: - `OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip` - operationId: apigee.organizations.hostQueries.getResult + description: Gets the documentation for the specified catalog item. + operationId: apigee.organizations.sites.apidocs.getDocumentation security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24674,7 +25908,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ApiDocDocumentationResponse parameters: - in: path name: organizationsId @@ -24682,15 +25917,27 @@ paths: schema: type: string - in: path - name: hostQueriesId + name: sitesId required: true schema: type: string - /v1/organizations/{organizationsId}/keyvaluemaps/{keyvaluemapsId}: + - in: path + name: apidocsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/endpointAttachments: parameters: *ref_1 - delete: - description: Deletes a key value map from an organization. - operationId: apigee.organizations.keyvaluemaps.delete + post: + description: >- + Creates an endpoint attachment. **Note:** Not supported for Apigee + hybrid. + operationId: apigee.organizations.endpointAttachments.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1EndpointAttachment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24702,28 +25949,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: keyvaluemapsId - required: true + - in: query + name: endpointAttachmentId schema: type: string - /v1/organizations/{organizationsId}/keyvaluemaps: - parameters: *ref_1 - post: - description: Creates a key value map in an organization. - operationId: apigee.organizations.keyvaluemaps.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' + get: + description: Lists the endpoint attachments in an organization. + operationId: apigee.organizations.endpointAttachments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24735,26 +25974,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListEndpointAttachmentsResponse parameters: - in: path name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}/keyvaluemaps/{keyvaluemapsId}/entries: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/organizations/{organizationsId}/endpointAttachments/{endpointAttachmentsId}: parameters: *ref_1 - post: - description: >- - Creates key value entries in a key value map scoped to an organization, - environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x - and higher. - operationId: apigee.organizations.keyvaluemaps.entries.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + get: + description: Gets the endpoint attachment. + operationId: apigee.organizations.endpointAttachments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24766,7 +26007,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: '#/components/schemas/GoogleCloudApigeeV1EndpointAttachment' parameters: - in: path name: organizationsId @@ -24774,16 +26015,13 @@ paths: schema: type: string - in: path - name: keyvaluemapsId + name: endpointAttachmentsId required: true schema: type: string - get: - description: >- - Lists key value entries for key values maps scoped to an organization, - environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x - and higher. - operationId: apigee.organizations.keyvaluemaps.entries.list + delete: + description: Deletes an endpoint attachment. + operationId: apigee.organizations.endpointAttachments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24795,8 +26033,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListKeyValueEntriesResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -24804,31 +26041,20 @@ paths: schema: type: string - in: path - name: keyvaluemapsId + name: endpointAttachmentsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/organizations/{organizationsId}/keyvaluemaps/{keyvaluemapsId}/entries/{entriesId}: + /v1/organizations/{organizationsId}/dnsZones: parameters: *ref_1 - put: - description: >- - Update key value entry scoped to an organization, environment, or API - proxy for an existing key. - operationId: apigee.organizations.keyvaluemaps.entries.update + post: + description: Creates a new DNS zone. + operationId: apigee.organizations.dnsZones.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: '#/components/schemas/GoogleCloudApigeeV1DnsZone' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24840,31 +26066,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: keyvaluemapsId - required: true - schema: - type: string - - in: path - name: entriesId - required: true + - in: query + name: dnsZoneId schema: type: string - delete: - description: >- - Deletes a key value entry from a key value map scoped to an - organization, environment, or API proxy. **Notes:** * After you delete - the key value entry, the policy consuming the entry will continue to - function with its cached values for a few minutes. This is expected - behavior. * Supported for Apigee hybrid 1.8.x and higher. - operationId: apigee.organizations.keyvaluemaps.entries.delete + get: + description: Enumerates DNS zones that have been created but not yet deleted. + operationId: apigee.organizations.dnsZones.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24876,29 +26091,27 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: '#/components/schemas/GoogleCloudApigeeV1ListDnsZonesResponse' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: keyvaluemapsId - required: true + - in: query + name: pageSize schema: - type: string - - in: path - name: entriesId - required: true + type: integer + format: int32 + - in: query + name: pageToken schema: type: string + /v1/organizations/{organizationsId}/dnsZones/{dnsZonesId}: + parameters: *ref_1 get: - description: >- - Get the key value entry value for a key value map scoped to an - organization, environment, or API proxy. **Note**: Supported for Apigee - hybrid 1.8.x and higher. - operationId: apigee.organizations.keyvaluemaps.entries.get + description: Fetches the representation of an existing DNS zone. + operationId: apigee.organizations.dnsZones.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24910,7 +26123,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: '#/components/schemas/GoogleCloudApigeeV1DnsZone' parameters: - in: path name: organizationsId @@ -24918,20 +26131,13 @@ paths: schema: type: string - in: path - name: keyvaluemapsId - required: true - schema: - type: string - - in: path - name: entriesId + name: dnsZonesId required: true schema: type: string - /v1/organizations/{organizationsId}/deployments: - parameters: *ref_1 - get: - description: Lists all deployments of API proxies or shared flows. - operationId: apigee.organizations.deployments.list + delete: + description: Deletes a previously created DNS zone. + operationId: apigee.organizations.dnsZones.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24943,27 +26149,31 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: sharedFlows + - in: path + name: dnsZonesId + required: true schema: - type: boolean - /v1/hybrid/issuers: + type: string + /v1/projects/{projectsId}:provisionOrganization: parameters: *ref_1 - get: + post: description: >- - Lists hybrid services and its trusted issuers service account ids. This - api is authenticated and unauthorized(allow all the users) and used by - runtime authn-authz service to query control plane's issuer service - account ids. - operationId: apigee.hybrid.issuers.list + Provisions a new Apigee organization with a functioning runtime. This is + the standard way to create trial organizations for a free Apigee trial. + operationId: apigee.projects.provisionOrganization + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ProvisionOrganizationRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24975,6 +26185,10 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListHybridIssuersResponse - parameters: [] + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/apigeeregistry.yaml b/providers/src/googleapis.com/v00.00.00000/services/apigeeregistry.yaml index 907fc5d7..3f5c82d6 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/apigeeregistry.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/apigeeregistry.yaml @@ -8,7 +8,7 @@ info: description: '' version: v1 x-discovery-doc-revision: '20231204' - x-generated-date: '2024-11-06' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/apigee/docs/api-hub/what-is-api-hub servers: @@ -1660,10 +1660,10 @@ components: update: [] replace: [] delete: [] - specs_revisions: - id: google.apigeeregistry.specs_revisions - name: specs_revisions - title: Specs_revisions + spec_revisions: + id: google.apigeeregistry.spec_revisions + name: spec_revisions + title: Spec_revisions methods: projects_locations_apis_versions_specs_list_revisions: operation: @@ -1673,19 +1673,6 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.apiSpecs - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/specs_revisions/methods/projects_locations_apis_versions_specs_list_revisions - insert: [] - update: [] - replace: [] - delete: [] - specs_revision: - id: google.apigeeregistry.specs_revision - name: specs_revision - title: Specs_revision - methods: projects_locations_apis_versions_specs_delete_revision: operation: $ref: >- @@ -1694,13 +1681,15 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/spec_revisions/methods/projects_locations_apis_versions_specs_list_revisions insert: [] update: [] replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/specs_revision/methods/projects_locations_apis_versions_specs_delete_revision + #/components/x-stackQL-resources/spec_revisions/methods/projects_locations_apis_versions_specs_delete_revision specs_iam_policies: id: google.apigeeregistry.specs_iam_policies name: specs_iam_policies @@ -2221,10 +2210,10 @@ components: delete: - $ref: >- #/components/x-stackQL-resources/deployments/methods/projects_locations_apis_deployments_delete - deployments_revisions: - id: google.apigeeregistry.deployments_revisions - name: deployments_revisions - title: Deployments_revisions + deployment_revisions: + id: google.apigeeregistry.deployment_revisions + name: deployment_revisions + title: Deployment_revisions methods: projects_locations_apis_deployments_list_revisions: operation: @@ -2234,19 +2223,6 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.apiDeployments - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/deployments_revisions/methods/projects_locations_apis_deployments_list_revisions - insert: [] - update: [] - replace: [] - delete: [] - deployments_revision: - id: google.apigeeregistry.deployments_revision - name: deployments_revision - title: Deployments_revision - methods: projects_locations_apis_deployments_delete_revision: operation: $ref: >- @@ -2255,13 +2231,15 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/deployment_revisions/methods/projects_locations_apis_deployments_list_revisions insert: [] update: [] replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/deployments_revision/methods/projects_locations_apis_deployments_delete_revision + #/components/x-stackQL-resources/deployment_revisions/methods/projects_locations_apis_deployments_delete_revision deployments_iam_policies: id: google.apigeeregistry.deployments_iam_policies name: deployments_iam_policies diff --git a/providers/src/googleapis.com/v00.00.00000/services/apihub.yaml b/providers/src/googleapis.com/v00.00.00000/services/apihub.yaml new file mode 100644 index 00000000..687ceee6 --- /dev/null +++ b/providers/src/googleapis.com/v00.00.00000/services/apihub.yaml @@ -0,0 +1,8286 @@ +openapi: 3.1.0 +info: + contact: + name: StackQL Studios + url: https://github.com/stackql/google-discovery-to-openapi + email: info@stackql.io + title: API hub API + description: '' + version: v1 + x-discovery-doc-revision: '20250731' + x-generated-date: '2025-08-28' +externalDocs: + url: https://cloud.google.com/apigee/docs/api-hub/what-is-api-hub +servers: + - url: https://apihub.googleapis.com +components: + securitySchemes: + Oauth2: + type: oauth2 + description: Oauth 2.0 implicit authentication + flows: + implicit: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + scopes: &ref_0 + 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. + Oauth2c: + type: oauth2 + description: Oauth 2.0 authorization code authentication + flows: + authorizationCode: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + tokenUrl: https://accounts.google.com/o/oauth2/token + scopes: *ref_0 + schemas: + GoogleLongrunningListOperationsResponse: + id: GoogleLongrunningListOperationsResponse + description: The response message for Operations.ListOperations. + type: object + properties: + operations: + description: >- + A list of operations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/GoogleLongrunningOperation' + nextPageToken: + description: The standard List next-page token. + type: string + GoogleLongrunningOperation: + id: GoogleLongrunningOperation + description: >- + This resource represents a long-running operation that is the result of + a network API call. + type: object + properties: + name: + description: >- + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. + type: string + metadata: + description: >- + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + done: + description: >- + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + type: boolean + error: + description: >- + The error result of the operation in case of failure or + cancellation. + $ref: '#/components/schemas/GoogleRpcStatus' + response: + description: >- + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + GoogleRpcStatus: + id: GoogleRpcStatus + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + type: object + properties: + code: + description: The status code, which should be an enum value of google.rpc.Code. + type: integer + format: int32 + message: + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + type: string + details: + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + type: array + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + Empty: + id: Empty + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + type: object + properties: {} + GoogleLongrunningCancelOperationRequest: + id: GoogleLongrunningCancelOperationRequest + description: The request message for Operations.CancelOperation. + type: object + properties: {} + GoogleCloudApihubV1Plugin: + id: GoogleCloudApihubV1Plugin + description: A plugin resource in the API Hub. + type: object + properties: + name: + description: >- + Identifier. The name of the plugin. Format: + `projects/{project}/locations/{location}/plugins/{plugin}` + type: string + displayName: + description: >- + Required. The display name of the plugin. Max length is 50 + characters (Unicode code points). + type: string + type: + description: >- + Optional. The type of the API. This maps to the following system + defined attribute: + `projects/{project}/locations/{location}/attributes/system-plugin-type` + attribute. The number of allowed values for this attribute will be + based on the cardinality of the attribute. The same can be retrieved + via GetAttribute API. All values should be from the list of allowed + values defined for the attribute. Note this field is not required + for plugins developed via plugin framework. + $ref: '#/components/schemas/GoogleCloudApihubV1AttributeValues' + description: + description: >- + Optional. The plugin description. Max length is 2000 characters + (Unicode code points). + type: string + state: + description: >- + Output only. Represents the state of the plugin. Note this field + will not be set for plugins developed via plugin framework as the + state will be managed at plugin instance level. + readOnly: true + type: string + enumDescriptions: + - The default value. This value is used if the state is omitted. + - The plugin is enabled. + - The plugin is disabled. + enum: + - STATE_UNSPECIFIED + - ENABLED + - DISABLED + ownershipType: + description: >- + Output only. The type of the plugin, indicating whether it is + 'SYSTEM_OWNED' or 'USER_OWNED'. + readOnly: true + type: string + enumDescriptions: + - Default unspecified type. + - >- + System owned plugins are defined by API hub and are available out + of the box in API hub. + - >- + User owned plugins are defined by the user and need to be + explicitly added to API hub via CreatePlugin method. + enum: + - OWNERSHIP_TYPE_UNSPECIFIED + - SYSTEM_OWNED + - USER_OWNED + hostingService: + description: >- + Optional. This field is optional. It is used to notify the plugin + hosting service for any lifecycle changes of the plugin instance and + trigger execution of plugin instance actions in case of API hub + managed actions. This field should be provided if the plugin + instance lifecycle of the developed plugin needs to be managed from + API hub. Also, in this case the plugin hosting service interface + needs to be implemented. This field should not be provided if the + plugin wants to manage plugin instance lifecycle events outside of + hub interface and use plugin framework for only registering of + plugin and plugin instances to capture the source of data into hub. + Note, in this case the plugin hosting service interface is not + required to be implemented. Also, the plugin instance lifecycle + actions will be disabled from API hub's UI. + $ref: '#/components/schemas/GoogleCloudApihubV1HostingService' + actionsConfig: + description: Required. The configuration of actions supported by the plugin. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApihubV1PluginActionConfig' + documentation: + description: >- + Optional. The documentation of the plugin, that explains how to set + up and use the plugin. + $ref: '#/components/schemas/GoogleCloudApihubV1Documentation' + pluginCategory: + description: >- + Optional. The category of the plugin, identifying its primary + category or purpose. This field is required for all plugins. + type: string + enumDescriptions: + - Default unspecified plugin type. + - >- + API_GATEWAY plugins represent plugins built for API Gateways like + Apigee. + - >- + API_PRODUCER plugins represent plugins built for API Producers + like Cloud Run, Application Integration etc. + enum: + - PLUGIN_CATEGORY_UNSPECIFIED + - API_GATEWAY + - API_PRODUCER + configTemplate: + description: Optional. The configuration template for the plugin. + $ref: '#/components/schemas/GoogleCloudApihubV1ConfigTemplate' + createTime: + description: Output only. Timestamp indicating when the plugin was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. Timestamp indicating when the plugin was last updated. + readOnly: true + type: string + format: google-datetime + gatewayType: + description: Optional. The type of the gateway. + type: string + enumDescriptions: + - The gateway type is not specified. + - The gateway type is Apigee X and Hybrid. + - The gateway type is Apigee Edge Public Cloud. + - The gateway type is Apigee Edge Private Cloud. + - The gateway type is Cloud API Gateway. + - The gateway type is Cloud Endpoints. + - The gateway type is API Discovery. + - The gateway type for any other types of gateways. + enum: + - GATEWAY_TYPE_UNSPECIFIED + - APIGEE_X_AND_HYBRID + - APIGEE_EDGE_PUBLIC_CLOUD + - APIGEE_EDGE_PRIVATE_CLOUD + - CLOUD_API_GATEWAY + - CLOUD_ENDPOINTS + - API_DISCOVERY + - OTHERS + GoogleCloudApihubV1AttributeValues: + id: GoogleCloudApihubV1AttributeValues + description: The attribute values associated with resource. + type: object + properties: + enumValues: + description: >- + The attribute values associated with a resource in case attribute + data type is enum. + $ref: '#/components/schemas/GoogleCloudApihubV1EnumAttributeValues' + stringValues: + description: >- + The attribute values associated with a resource in case attribute + data type is string. + $ref: '#/components/schemas/GoogleCloudApihubV1StringAttributeValues' + jsonValues: + description: >- + The attribute values associated with a resource in case attribute + data type is JSON. + $ref: '#/components/schemas/GoogleCloudApihubV1StringAttributeValues' + uriValues: + description: >- + The attribute values associated with a resource in case attribute + data type is URL, URI or IP, like gs://bucket-name/object-name. + $ref: '#/components/schemas/GoogleCloudApihubV1StringAttributeValues' + attribute: + description: >- + Output only. The name of the attribute. Format: + projects/{project}/locations/{location}/attributes/{attribute} + readOnly: true + type: string + GoogleCloudApihubV1EnumAttributeValues: + id: GoogleCloudApihubV1EnumAttributeValues + description: The attribute values of data type enum. + type: object + properties: + values: + description: Required. The attribute values in case attribute data type is enum. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApihubV1AllowedValue' + GoogleCloudApihubV1AllowedValue: + id: GoogleCloudApihubV1AllowedValue + description: >- + The value that can be assigned to the attribute when the data type is + enum. + type: object + properties: + id: + description: >- + Required. The ID of the allowed value. * If provided, the same will + be used. The service will throw an error if the specified id is + already used by another allowed value in the same attribute + resource. * If not provided, a system generated id derived from the + display name will be used. In this case, the service will handle + conflict resolution by adding a system generated suffix in case of + duplicates. This value should be 4-63 characters, and valid + characters are /a-z-/. + type: string + displayName: + description: Required. The display name of the allowed value. + type: string + description: + description: Optional. The detailed description of the allowed value. + type: string + immutable: + description: >- + Optional. When set to true, the allowed value cannot be updated or + deleted by the user. It can only be true for System defined + attributes. + type: boolean + GoogleCloudApihubV1StringAttributeValues: + id: GoogleCloudApihubV1StringAttributeValues + description: The attribute values of data type string or JSON. + type: object + properties: + values: + description: >- + Required. The attribute values in case attribute data type is string + or JSON. + type: array + items: + type: string + GoogleCloudApihubV1HostingService: + id: GoogleCloudApihubV1HostingService + description: >- + The information related to the service implemented by the plugin + developer, used to invoke the plugin's functionality. + type: object + properties: + serviceUri: + description: >- + Optional. The URI of the service implemented by the plugin + developer, used to invoke the plugin's functionality. This + information is only required for user defined plugins. + type: string + GoogleCloudApihubV1PluginActionConfig: + id: GoogleCloudApihubV1PluginActionConfig + description: >- + PluginActionConfig represents the configuration of an action supported + by a plugin. + type: object + properties: + id: + description: Required. The id of the action. + type: string + displayName: + description: Required. The display name of the action. + type: string + description: + description: Required. The description of the operation performed by the action. + type: string + triggerMode: + description: Required. The trigger mode supported by the action. + type: string + enumDescriptions: + - Default unspecified mode. + - >- + This action can be executed by invoking + ExecutePluginInstanceAction API with the given action id. To + support this, the plugin hosting service should handle this action + id as part of execute call. + - >- + This action will be executed on schedule by invoking + ExecutePluginInstanceAction API with the given action id. To set + the schedule, the user can provide the cron expression in the + PluginAction field for a given plugin instance. To support this, + the plugin hosting service should handle this action id as part of + execute call. Note, on demand execution will be supported by + default in this trigger mode. + - >- + The execution of this plugin is not handled by API hub. In this + case, the plugin hosting service need not handle this action id as + part of the execute call. + enum: + - TRIGGER_MODE_UNSPECIFIED + - API_HUB_ON_DEMAND_TRIGGER + - API_HUB_SCHEDULE_TRIGGER + - NON_API_HUB_MANAGED + GoogleCloudApihubV1Documentation: + id: GoogleCloudApihubV1Documentation + description: Documentation details. + type: object + properties: + externalUri: + description: Optional. The uri of the externally hosted documentation. + type: string + GoogleCloudApihubV1ConfigTemplate: + id: GoogleCloudApihubV1ConfigTemplate + description: ConfigTemplate represents the configuration template for a plugin. + type: object + properties: + authConfigTemplate: + description: Optional. The authentication template for the plugin. + $ref: '#/components/schemas/GoogleCloudApihubV1AuthConfigTemplate' + additionalConfigTemplate: + description: >- + Optional. The list of additional configuration variables for the + plugin's configuration. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApihubV1ConfigVariableTemplate' + GoogleCloudApihubV1AuthConfigTemplate: + id: GoogleCloudApihubV1AuthConfigTemplate + description: AuthConfigTemplate represents the authentication template for a plugin. + type: object + properties: + supportedAuthTypes: + description: Required. The list of authentication types supported by the plugin. + type: array + items: + type: string + enumDescriptions: + - Authentication type not specified. + - No authentication. + - Google service account authentication. + - Username and password authentication. + - API Key authentication. + - Oauth 2.0 client credentials grant authentication. + enum: + - AUTH_TYPE_UNSPECIFIED + - NO_AUTH + - GOOGLE_SERVICE_ACCOUNT + - USER_PASSWORD + - API_KEY + - OAUTH2_CLIENT_CREDENTIALS + serviceAccount: + description: >- + Optional. The service account of the plugin hosting service. This + service account should be granted the required permissions on the + Auth Config parameters provided while creating the plugin instances + corresponding to this plugin. For example, if the plugin instance + auth config requires a secret manager secret, the service account + should be granted the secretmanager.versions.access permission on + the corresponding secret, if the plugin instance auth config + contains a service account, the service account should be granted + the iam.serviceAccounts.getAccessToken permission on the + corresponding service account. + $ref: '#/components/schemas/GoogleCloudApihubV1GoogleServiceAccountConfig' + GoogleCloudApihubV1GoogleServiceAccountConfig: + id: GoogleCloudApihubV1GoogleServiceAccountConfig + description: Config for Google service account authentication. + type: object + properties: + serviceAccount: + description: >- + Required. The service account to be used for authenticating request. + The `iam.serviceAccounts.getAccessToken` permission should be + granted on this service account to the impersonator service account. + type: string + GoogleCloudApihubV1ConfigVariableTemplate: + id: GoogleCloudApihubV1ConfigVariableTemplate + description: >- + ConfigVariableTemplate represents a configuration variable template + present in a Plugin Config. + type: object + properties: + id: + description: >- + Required. ID of the config variable. Must be unique within the + configuration. + type: string + valueType: + description: 'Required. Type of the parameter: string, int, bool etc.' + type: string + enumDescriptions: + - Value type is not specified. + - Value type is string. + - Value type is integer. + - Value type is boolean. + - Value type is secret. + - Value type is enum. + - Value type is multi select. + - Value type is multi string. + - Value type is multi int. + enum: + - VALUE_TYPE_UNSPECIFIED + - STRING + - INT + - BOOL + - SECRET + - ENUM + - MULTI_SELECT + - MULTI_STRING + - MULTI_INT + description: + description: Optional. Description. + type: string + validationRegex: + description: >- + Optional. Regular expression in RE2 syntax used for validating the + `value` of a `ConfigVariable`. + type: string + required: + description: >- + Optional. Flag represents that this `ConfigVariable` must be + provided for a PluginInstance. + type: boolean + enumOptions: + description: Optional. Enum options. To be populated if `ValueType` is `ENUM`. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApihubV1ConfigValueOption' + multiSelectOptions: + description: >- + Optional. Multi select options. To be populated if `ValueType` is + `MULTI_SELECT`. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApihubV1ConfigValueOption' + GoogleCloudApihubV1ConfigValueOption: + id: GoogleCloudApihubV1ConfigValueOption + description: >- + ConfigValueOption represents an option for a config variable of type + enum or multi select. + type: object + properties: + id: + description: Required. Id of the option. + type: string + displayName: + description: Required. Display name of the option. + type: string + description: + description: Optional. Description of the option. + type: string + GoogleCloudApihubV1EnablePluginRequest: + id: GoogleCloudApihubV1EnablePluginRequest + description: The EnablePlugin method's request. + type: object + properties: {} + GoogleCloudApihubV1DisablePluginRequest: + id: GoogleCloudApihubV1DisablePluginRequest + description: The DisablePlugin method's request. + type: object + properties: {} + GoogleCloudApihubV1ListPluginsResponse: + id: GoogleCloudApihubV1ListPluginsResponse + description: The ListPlugins method's response. + type: object + properties: + plugins: + description: The plugins from the specified parent resource. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApihubV1Plugin' + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + GoogleCloudApihubV1PluginInstance: + id: GoogleCloudApihubV1PluginInstance + description: >- + Represents a plugin instance resource in the API Hub. A PluginInstance + is a specific instance of a hub plugin with its own configuration, + state, and execution details. + type: object + properties: + name: + description: >- + Identifier. The unique name of the plugin instance resource. Format: + `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}` + type: string + displayName: + description: >- + Required. The display name for this plugin instance. Max length is + 255 characters. + type: string + authConfig: + description: Optional. The authentication information for this plugin instance. + $ref: '#/components/schemas/GoogleCloudApihubV1AuthConfig' + additionalConfig: + description: >- + Optional. The additional information for this plugin instance + corresponding to the additional config template of the plugin. This + information will be sent to plugin hosting service on each call to + plugin hosted service. The key will be the + config_variable_template.display_name to uniquely identify the + config variable. + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudApihubV1ConfigVariable' + state: + description: >- + Output only. The current state of the plugin instance (e.g., + enabled, disabled, provisioning). + readOnly: true + type: string + enumDescriptions: + - Default unspecified state. + - The plugin instance is being created. + - >- + The plugin instance is active and ready for executions. This is + the only state where executions can run on the plugin instance. + - >- + The updated config that contains additional_config and auth_config + is being applied. + - >- + The ERROR state can come while applying config. Users can + retrigger ApplyPluginInstanceConfig to restore the plugin instance + back to active state. Note, In case the ERROR state happens while + applying config (auth_config, additional_config), the plugin + instance will reflect the config which was trying to be applied + while error happened. In order to overwrite, trigger ApplyConfig + with a new config. + - >- + The plugin instance is in a failed state. This indicates that an + unrecoverable error occurred during a previous operation (Create, + Delete). + - >- + The plugin instance is being deleted. Delete is only possible if + there is no other operation running on the plugin instance and + plugin instance action. + enum: + - STATE_UNSPECIFIED + - CREATING + - ACTIVE + - APPLYING_CONFIG + - ERROR + - FAILED + - DELETING + errorMessage: + description: >- + Output only. Error message describing the failure, if any, during + Create, Delete or ApplyConfig operation corresponding to the plugin + instance.This field will only be populated if the plugin instance is + in the ERROR or FAILED state. + readOnly: true + type: string + actions: + description: Required. The action status for the plugin instance. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApihubV1PluginInstanceAction' + createTime: + description: >- + Output only. Timestamp indicating when the plugin instance was + created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: >- + Output only. Timestamp indicating when the plugin instance was last + updated. + readOnly: true + type: string + format: google-datetime + sourceProjectId: + description: >- + Optional. The source project id of the plugin instance. This will be + the id of runtime project in case of gcp based plugins and org id in + case of non gcp based plugins. This field will be a required field + for Google provided on-ramp plugins. + type: string + GoogleCloudApihubV1AuthConfig: + id: GoogleCloudApihubV1AuthConfig + description: AuthConfig represents the authentication information. + type: object + properties: + googleServiceAccountConfig: + description: Google Service Account. + $ref: '#/components/schemas/GoogleCloudApihubV1GoogleServiceAccountConfig' + userPasswordConfig: + description: User Password. + $ref: '#/components/schemas/GoogleCloudApihubV1UserPasswordConfig' + apiKeyConfig: + description: Api Key Config. + $ref: '#/components/schemas/GoogleCloudApihubV1ApiKeyConfig' + oauth2ClientCredentialsConfig: + description: Oauth2.0 Client Credentials. + $ref: >- + #/components/schemas/GoogleCloudApihubV1Oauth2ClientCredentialsConfig + authType: + description: Required. The authentication type. + type: string + enumDescriptions: + - Authentication type not specified. + - No authentication. + - Google service account authentication. + - Username and password authentication. + - API Key authentication. + - Oauth 2.0 client credentials grant authentication. + enum: + - AUTH_TYPE_UNSPECIFIED + - NO_AUTH + - GOOGLE_SERVICE_ACCOUNT + - USER_PASSWORD + - API_KEY + - OAUTH2_CLIENT_CREDENTIALS + GoogleCloudApihubV1UserPasswordConfig: + id: GoogleCloudApihubV1UserPasswordConfig + description: Parameters to support Username and Password Authentication. + type: object + properties: + username: + description: Required. Username. + type: string + password: + description: >- + Required. Secret version reference containing the password. The + `secretmanager.versions.access` permission should be granted to the + service account accessing the secret. + $ref: '#/components/schemas/GoogleCloudApihubV1Secret' + GoogleCloudApihubV1Secret: + id: GoogleCloudApihubV1Secret + description: Secret provides a reference to entries in Secret Manager. + type: object + properties: + secretVersion: + description: >- + Required. The resource name of the secret version in the format, + format as: `projects/*/secrets/*/versions/*`. + type: string + GoogleCloudApihubV1ApiKeyConfig: + id: GoogleCloudApihubV1ApiKeyConfig + description: Config for authentication with API key. + type: object + properties: + name: + description: >- + Required. The parameter name of the API key. E.g. If the API request + is "https://example.com/act?api_key=", "api_key" would be the + parameter name. + type: string + apiKey: + description: >- + Required. The name of the SecretManager secret version resource + storing the API key. Format: + `projects/{project}/secrets/{secrete}/versions/{version}`. The + `secretmanager.versions.access` permission should be granted to the + service account accessing the secret. + $ref: '#/components/schemas/GoogleCloudApihubV1Secret' + httpElementLocation: + description: Required. The location of the API key. The default value is QUERY. + type: string + enumDescriptions: + - HTTP element location not specified. + - Element is in the HTTP request query. + - Element is in the HTTP request header. + - Element is in the HTTP request path. + - Element is in the HTTP request body. + - Element is in the HTTP request cookie. + enum: + - HTTP_ELEMENT_LOCATION_UNSPECIFIED + - QUERY + - HEADER + - PATH + - BODY + - COOKIE + GoogleCloudApihubV1Oauth2ClientCredentialsConfig: + id: GoogleCloudApihubV1Oauth2ClientCredentialsConfig + description: >- + Parameters to support Oauth 2.0 client credentials grant authentication. + See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. + type: object + properties: + clientId: + description: Required. The client identifier. + type: string + clientSecret: + description: >- + Required. Secret version reference containing the client secret. The + `secretmanager.versions.access` permission should be granted to the + service account accessing the secret. + $ref: '#/components/schemas/GoogleCloudApihubV1Secret' + GoogleCloudApihubV1ConfigVariable: + id: GoogleCloudApihubV1ConfigVariable + description: >- + ConfigVariable represents a additional configuration variable present in + a PluginInstance Config or AuthConfig, based on a + ConfigVariableTemplate. + type: object + properties: + stringValue: + description: >- + Optional. The config variable value in case of config variable of + type string. + type: string + intValue: + description: >- + Optional. The config variable value in case of config variable of + type integer. + type: string + format: int64 + boolValue: + description: >- + Optional. The config variable value in case of config variable of + type boolean. + type: boolean + secretValue: + description: >- + Optional. The config variable value in case of config variable of + type secret. + $ref: '#/components/schemas/GoogleCloudApihubV1Secret' + enumValue: + description: >- + Optional. The config variable value in case of config variable of + type enum. + $ref: '#/components/schemas/GoogleCloudApihubV1ConfigValueOption' + multiSelectValues: + description: >- + Optional. The config variable value in case of config variable of + type multi select. + $ref: '#/components/schemas/GoogleCloudApihubV1MultiSelectValues' + multiStringValues: + description: >- + Optional. The config variable value in case of config variable of + type multi string. + $ref: '#/components/schemas/GoogleCloudApihubV1MultiStringValues' + multiIntValues: + description: >- + Optional. The config variable value in case of config variable of + type multi integer. + $ref: '#/components/schemas/GoogleCloudApihubV1MultiIntValues' + key: + description: >- + Output only. Key will be the id to uniquely identify the config + variable. + readOnly: true + type: string + GoogleCloudApihubV1MultiSelectValues: + id: GoogleCloudApihubV1MultiSelectValues + description: The config variable value of data type multi select. + type: object + properties: + values: + description: Optional. The config variable value of data type multi select. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApihubV1ConfigValueOption' + GoogleCloudApihubV1MultiStringValues: + id: GoogleCloudApihubV1MultiStringValues + description: The config variable value of data type multi string. + type: object + properties: + values: + description: Optional. The config variable value of data type multi string. + type: array + items: + type: string + GoogleCloudApihubV1MultiIntValues: + id: GoogleCloudApihubV1MultiIntValues + description: The config variable value of data type multi int. + type: object + properties: + values: + description: Optional. The config variable value of data type multi int. + type: array + items: + type: integer + format: int32 + GoogleCloudApihubV1PluginInstanceAction: + id: GoogleCloudApihubV1PluginInstanceAction + description: >- + PluginInstanceAction represents an action which can be executed in the + plugin instance. + type: object + properties: + hubInstanceAction: + description: >- + Optional. The execution information for the plugin instance action + done corresponding to an API hub instance. + $ref: '#/components/schemas/GoogleCloudApihubV1ExecutionStatus' + actionId: + description: >- + Required. This should map to one of the action id specified in + actions_config in the plugin. + type: string + state: + description: >- + Output only. The current state of the plugin action in the plugin + instance. + readOnly: true + type: string + enumDescriptions: + - Default unspecified state. + - >- + The action is enabled in the plugin instance i.e., executions can + be triggered for this action. + - >- + The action is disabled in the plugin instance i.e., no executions + can be triggered for this action. This state indicates that the + user explicitly disabled the instance, and no further action is + needed unless the user wants to re-enable it. + - The action in the plugin instance is being enabled. + - The action in the plugin instance is being disabled. + - >- + The ERROR state can come while enabling/disabling plugin instance + action. Users can retrigger enable, disable via + EnablePluginInstanceAction and DisablePluginInstanceAction to + restore the action back to enabled/disabled state. Note + enable/disable on actions can only be triggered if plugin instance + is in Active state. + enum: + - STATE_UNSPECIFIED + - ENABLED + - DISABLED + - ENABLING + - DISABLING + - ERROR + scheduleCronExpression: + description: >- + Optional. The schedule for this plugin instance action. This can + only be set if the plugin supports API_HUB_SCHEDULE_TRIGGER mode for + this action. + type: string + curationConfig: + description: >- + Optional. This configuration should be provided if the plugin action + is publishing data to API hub curate layer. + $ref: '#/components/schemas/GoogleCloudApihubV1CurationConfig' + scheduleTimeZone: + description: >- + Optional. The time zone for the schedule cron expression. If not + provided, UTC will be used. + type: string + serviceAccount: + description: >- + Optional. The service account used to publish data. Note, the + service account will only be accepted for non GCP plugins like OPDK. + type: string + resourceConfig: + description: >- + Output only. The configuration of resources created for a given + plugin instance action. Note these will be returned only in case of + Non-GCP plugins like OPDK. + readOnly: true + $ref: '#/components/schemas/GoogleCloudApihubV1ResourceConfig' + GoogleCloudApihubV1ExecutionStatus: + id: GoogleCloudApihubV1ExecutionStatus + description: The execution status for the plugin instance. + type: object + properties: + currentExecutionState: + description: Output only. The current state of the execution. + readOnly: true + type: string + enumDescriptions: + - Default unspecified execution state. + - The plugin instance is executing. + - The plugin instance is not running an execution. + enum: + - CURRENT_EXECUTION_STATE_UNSPECIFIED + - RUNNING + - NOT_RUNNING + lastExecution: + description: Output only. The last execution of the plugin instance. + readOnly: true + $ref: '#/components/schemas/GoogleCloudApihubV1LastExecution' + GoogleCloudApihubV1LastExecution: + id: GoogleCloudApihubV1LastExecution + description: The result of the last execution of the plugin instance. + type: object + properties: + result: + description: >- + Output only. The result of the last execution of the plugin + instance. + readOnly: true + type: string + enumDescriptions: + - Default unspecified execution result. + - The plugin instance executed successfully. + - The plugin instance execution failed. + enum: + - RESULT_UNSPECIFIED + - SUCCEEDED + - FAILED + errorMessage: + description: >- + Output only. Error message describing the failure, if any, during + the last execution. + readOnly: true + type: string + startTime: + description: Output only. The last execution start time of the plugin instance. + readOnly: true + type: string + format: google-datetime + endTime: + description: Output only. The last execution end time of the plugin instance. + readOnly: true + type: string + format: google-datetime + GoogleCloudApihubV1CurationConfig: + id: GoogleCloudApihubV1CurationConfig + description: The curation information for this plugin instance. + type: object + properties: + customCuration: + description: Optional. Custom curation information for this plugin instance. + $ref: '#/components/schemas/GoogleCloudApihubV1CustomCuration' + curationType: + description: Required. The curation type for this plugin instance. + type: string + enumDescriptions: + - Default unspecified curation type. + - Default curation for API metadata will be used. + - Custom curation for API metadata will be used. + enum: + - CURATION_TYPE_UNSPECIFIED + - DEFAULT_CURATION_FOR_API_METADATA + - CUSTOM_CURATION_FOR_API_METADATA + GoogleCloudApihubV1CustomCuration: + id: GoogleCloudApihubV1CustomCuration + description: Custom curation information for this plugin instance. + type: object + properties: + curation: + description: >- + Required. The unique name of the curation resource. This will be the + name of the curation resource in the format: + `projects/{project}/locations/{location}/curations/{curation}` + type: string + GoogleCloudApihubV1ResourceConfig: + id: GoogleCloudApihubV1ResourceConfig + description: >- + The configuration of resources created for a given plugin instance + action. + type: object + properties: + actionType: + description: Output only. The type of the action. + readOnly: true + type: string + enumDescriptions: + - Default unspecified action type. + - Action type for sync metadata. + - Action type for sync runtime data. + enum: + - ACTION_TYPE_UNSPECIFIED + - SYNC_METADATA + - SYNC_RUNTIME_DATA + pubsubTopic: + description: >- + Output only. The pubsub topic to publish the data to. Format is + projects/{project}/topics/{topic} + readOnly: true + type: string + GoogleCloudApihubV1ExecutePluginInstanceActionRequest: + id: GoogleCloudApihubV1ExecutePluginInstanceActionRequest + description: The ExecutePluginInstanceAction method's request. + type: object + properties: + actionExecutionDetail: + description: Required. The execution details for the action to execute. + $ref: '#/components/schemas/GoogleCloudApihubV1ActionExecutionDetail' + GoogleCloudApihubV1ActionExecutionDetail: + id: GoogleCloudApihubV1ActionExecutionDetail + description: The details for the action to execute. + type: object + properties: + actionId: + description: Required. The action id of the plugin to execute. + type: string + GoogleCloudApihubV1ListPluginInstancesResponse: + id: GoogleCloudApihubV1ListPluginInstancesResponse + description: The ListPluginInstances method's response. + type: object + properties: + pluginInstances: + description: The plugin instances from the specified parent resource. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApihubV1PluginInstance' + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + GoogleCloudApihubV1EnablePluginInstanceActionRequest: + id: GoogleCloudApihubV1EnablePluginInstanceActionRequest + description: The EnablePluginInstanceAction method's request. + type: object + properties: + actionId: + description: Required. The action id to enable. + type: string + GoogleCloudApihubV1DisablePluginInstanceActionRequest: + id: GoogleCloudApihubV1DisablePluginInstanceActionRequest + description: The DisablePluginInstanceAction method's request. + type: object + properties: + actionId: + description: Required. The action id to disable. + type: string + GoogleCloudApihubV1Api: + id: GoogleCloudApihubV1Api + description: An API resource in the API Hub. + type: object + properties: + name: + description: >- + Identifier. The name of the API resource in the API Hub. Format: + `projects/{project}/locations/{location}/apis/{api}` + type: string + displayName: + description: Required. The display name of the API resource. + type: string + description: + description: Optional. The description of the API resource. + type: string + documentation: + description: Optional. The documentation for the API resource. + $ref: '#/components/schemas/GoogleCloudApihubV1Documentation' + owner: + description: Optional. Owner details for the API resource. + $ref: '#/components/schemas/GoogleCloudApihubV1Owner' + versions: + description: >- + Output only. The list of versions present in an API resource. Note: + An API resource can be associated with more than 1 version. Format + is + `projects/{project}/locations/{location}/apis/{api}/versions/{version}` + readOnly: true + type: array + items: + type: string + createTime: + description: Output only. The time at which the API resource was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. The time at which the API resource was last updated. + readOnly: true + type: string + format: google-datetime + targetUser: + description: >- + Optional. The target users for the API. This maps to the following + system defined attribute: + `projects/{project}/locations/{location}/attributes/system-target-user` + attribute. The number of values for this attribute will be based on + the cardinality of the attribute. The same can be retrieved via + GetAttribute API. All values should be from the list of allowed + values defined for the attribute. + $ref: '#/components/schemas/GoogleCloudApihubV1AttributeValues' + team: + description: >- + Optional. The team owning the API. This maps to the following system + defined attribute: + `projects/{project}/locations/{location}/attributes/system-team` + attribute. The number of values for this attribute will be based on + the cardinality of the attribute. The same can be retrieved via + GetAttribute API. All values should be from the list of allowed + values defined for the attribute. + $ref: '#/components/schemas/GoogleCloudApihubV1AttributeValues' + businessUnit: + description: >- + Optional. The business unit owning the API. This maps to the + following system defined attribute: + `projects/{project}/locations/{location}/attributes/system-business-unit` + attribute. The number of values for this attribute will be based on + the cardinality of the attribute. The same can be retrieved via + GetAttribute API. All values should be from the list of allowed + values defined for the attribute. + $ref: '#/components/schemas/GoogleCloudApihubV1AttributeValues' + maturityLevel: + description: >- + Optional. The maturity level of the API. This maps to the following + system defined attribute: + `projects/{project}/locations/{location}/attributes/system-maturity-level` + attribute. The number of values for this attribute will be based on + the cardinality of the attribute. The same can be retrieved via + GetAttribute API. All values should be from the list of allowed + values defined for the attribute. + $ref: '#/components/schemas/GoogleCloudApihubV1AttributeValues' + attributes: + description: >- + Optional. The list of user defined attributes associated with the + API resource. The key is the attribute name. It will be of the + format: + `projects/{project}/locations/{location}/attributes/{attribute}`. + The value is the attribute values associated with the resource. + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudApihubV1AttributeValues' + apiStyle: + description: >- + Optional. The style of the API. This maps to the following system + defined attribute: + `projects/{project}/locations/{location}/attributes/system-api-style` + attribute. The number of values for this attribute will be based on + the cardinality of the attribute. The same can be retrieved via + GetAttribute API. All values should be from the list of allowed + values defined for the attribute. + $ref: '#/components/schemas/GoogleCloudApihubV1AttributeValues' + selectedVersion: + description: >- + Optional. The selected version for an API resource. This can be used + when special handling is needed on client side for particular + version of the API. Format is + `projects/{project}/locations/{location}/apis/{api}/versions/{version}` + type: string + apiRequirements: + description: >- + Optional. The api requirement doc associated with the API resource. + Carinality is 1 for this attribute. This maps to the following + system defined attribute: + `projects/{project}/locations/{location}/attributes/system-api-requirements` + attribute. The value of the attribute should be a proper URI, and in + case of Cloud Storage URI, it should point to a Cloud Storage + object, not a directory. + $ref: '#/components/schemas/GoogleCloudApihubV1AttributeValues' + fingerprint: + description: Optional. Fingerprint of the API resource. + type: string + sourceMetadata: + description: >- + Output only. The list of sources and metadata from the sources of + the API resource. + readOnly: true + type: array + items: + $ref: '#/components/schemas/GoogleCloudApihubV1SourceMetadata' + apiFunctionalRequirements: + description: >- + Optional. The api functional requirements associated with the API + resource. Carinality is 1 for this attribute. This maps to the + following system defined attribute: + `projects/{project}/locations/{location}/attributes/system-api-functional-requirements` + attribute. The value of the attribute should be a proper URI, and in + case of Cloud Storage URI, it should point to a Cloud Storage + object, not a directory. + $ref: '#/components/schemas/GoogleCloudApihubV1AttributeValues' + apiTechnicalRequirements: + description: >- + Optional. The api technical requirements associated with the API + resource. Carinality is 1 for this attribute. This maps to the + following system defined attribute: + `projects/{project}/locations/{location}/attributes/system-api-technical-requirements` + attribute. The value of the attribute should be a proper URI, and in + case of Cloud Storage URI, it should point to a Cloud Storage + object, not a directory. + $ref: '#/components/schemas/GoogleCloudApihubV1AttributeValues' + GoogleCloudApihubV1Owner: + id: GoogleCloudApihubV1Owner + description: Owner details. + type: object + properties: + displayName: + description: Optional. The name of the owner. + type: string + email: + description: Required. The email of the owner. + type: string + GoogleCloudApihubV1SourceMetadata: + id: GoogleCloudApihubV1SourceMetadata + description: SourceMetadata represents the metadata for a resource at the source. + type: object + properties: + pluginInstanceActionSource: + description: Output only. The source of the resource is a plugin instance action. + readOnly: true + $ref: '#/components/schemas/GoogleCloudApihubV1PluginInstanceActionSource' + sourceType: + description: Output only. The type of the source. + readOnly: true + type: string + enumDescriptions: + - Source type not specified. + - Source type plugin. + enum: + - SOURCE_TYPE_UNSPECIFIED + - PLUGIN + originalResourceId: + description: Output only. The unique identifier of the resource at the source. + readOnly: true + type: string + originalResourceCreateTime: + description: >- + Output only. The time at which the resource was created at the + source. + readOnly: true + type: string + format: google-datetime + originalResourceUpdateTime: + description: >- + Output only. The time at which the resource was last updated at the + source. + readOnly: true + type: string + format: google-datetime + GoogleCloudApihubV1PluginInstanceActionSource: + id: GoogleCloudApihubV1PluginInstanceActionSource + description: PluginInstanceActionSource represents the plugin instance action source. + type: object + properties: + pluginInstance: + description: >- + Output only. The resource name of the source plugin instance. Format + is + `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}` + readOnly: true + type: string + actionId: + description: Output only. The id of the plugin instance action. + readOnly: true + type: string + GoogleCloudApihubV1ListApisResponse: + id: GoogleCloudApihubV1ListApisResponse + description: The ListApis method's response. + type: object + properties: + apis: + description: The API resources present in the API hub. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApihubV1Api' + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + GoogleCloudApihubV1Version: + id: GoogleCloudApihubV1Version + description: >- + Represents a version of the API resource in API hub. This is also + referred to as the API version. + type: object + properties: + name: + description: >- + Identifier. The name of the version. Format: + `projects/{project}/locations/{location}/apis/{api}/versions/{version}` + type: string + displayName: + description: Required. The display name of the version. + type: string + description: + description: Optional. The description of the version. + type: string + documentation: + description: Optional. The documentation of the version. + $ref: '#/components/schemas/GoogleCloudApihubV1Documentation' + specs: + description: >- + Output only. The specs associated with this version. Note that an + API version can be associated with multiple specs. Format is + `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}` + readOnly: true + type: array + items: + type: string + apiOperations: + description: >- + Output only. The operations contained in the API version. These + operations will be added to the version when a new spec is added or + when an existing spec is updated. Format is + `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}` + readOnly: true + type: array + items: + type: string + definitions: + description: >- + Output only. The definitions contained in the API version. These + definitions will be added to the version when a new spec is added or + when an existing spec is updated. Format is + `projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}` + readOnly: true + type: array + items: + type: string + deployments: + description: >- + Optional. The deployments linked to this API version. Note: A + particular API version could be deployed to multiple deployments + (for dev deployment, UAT deployment, etc) Format is + `projects/{project}/locations/{location}/deployments/{deployment}` + type: array + items: + type: string + createTime: + description: Output only. The time at which the version was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. The time at which the version was last updated. + readOnly: true + type: string + format: google-datetime + lifecycle: + description: >- + Optional. The lifecycle of the API version. This maps to the + following system defined attribute: + `projects/{project}/locations/{location}/attributes/system-lifecycle` + attribute. The number of values for this attribute will be based on + the cardinality of the attribute. The same can be retrieved via + GetAttribute API. All values should be from the list of allowed + values defined for the attribute. + $ref: '#/components/schemas/GoogleCloudApihubV1AttributeValues' + compliance: + description: >- + Optional. The compliance associated with the API version. This maps + to the following system defined attribute: + `projects/{project}/locations/{location}/attributes/system-compliance` + attribute. The number of values for this attribute will be based on + the cardinality of the attribute. The same can be retrieved via + GetAttribute API. All values should be from the list of allowed + values defined for the attribute. + $ref: '#/components/schemas/GoogleCloudApihubV1AttributeValues' + accreditation: + description: >- + Optional. The accreditations associated with the API version. This + maps to the following system defined attribute: + `projects/{project}/locations/{location}/attributes/system-accreditation` + attribute. The number of values for this attribute will be based on + the cardinality of the attribute. The same can be retrieved via + GetAttribute API. All values should be from the list of allowed + values defined for the attribute. + $ref: '#/components/schemas/GoogleCloudApihubV1AttributeValues' + attributes: + description: >- + Optional. The list of user defined attributes associated with the + Version resource. The key is the attribute name. It will be of the + format: + `projects/{project}/locations/{location}/attributes/{attribute}`. + The value is the attribute values associated with the resource. + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudApihubV1AttributeValues' + selectedDeployment: + description: >- + Optional. The selected deployment for a Version resource. This can + be used when special handling is needed on client side for a + particular deployment linked to the version. Format is + `projects/{project}/locations/{location}/deployments/{deployment}` + type: string + sourceMetadata: + description: >- + Output only. The list of sources and metadata from the sources of + the version. + readOnly: true + type: array + items: + $ref: '#/components/schemas/GoogleCloudApihubV1SourceMetadata' + GoogleCloudApihubV1ListVersionsResponse: + id: GoogleCloudApihubV1ListVersionsResponse + description: The ListVersions method's response. + type: object + properties: + versions: + description: The versions corresponding to an API. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApihubV1Version' + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + GoogleCloudApihubV1Spec: + id: GoogleCloudApihubV1Spec + description: >- + Represents a spec associated with an API version in the API Hub. Note + that specs of various types can be uploaded, however parsing of details + is supported for OpenAPI spec currently. + type: object + properties: + name: + description: >- + Identifier. The name of the spec. Format: + `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}` + type: string + displayName: + description: >- + Required. The display name of the spec. This can contain the file + name of the spec. + type: string + specType: + description: >- + Required. The type of spec. The value should be one of the allowed + values defined for + `projects/{project}/locations/{location}/attributes/system-spec-type` + attribute. The number of values for this attribute will be based on + the cardinality of the attribute. The same can be retrieved via + GetAttribute API. Note, this field is mandatory if content is + provided. + $ref: '#/components/schemas/GoogleCloudApihubV1AttributeValues' + contents: + description: Optional. Input only. The contents of the uploaded spec. + $ref: '#/components/schemas/GoogleCloudApihubV1SpecContents' + details: + description: Output only. Details parsed from the spec. + readOnly: true + $ref: '#/components/schemas/GoogleCloudApihubV1SpecDetails' + sourceUri: + description: >- + Optional. The URI of the spec source in case file is uploaded from + an external version control system. + type: string + createTime: + description: Output only. The time at which the spec was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. The time at which the spec was last updated. + readOnly: true + type: string + format: google-datetime + lintResponse: + description: Optional. The lint response for the spec. + $ref: '#/components/schemas/GoogleCloudApihubV1LintResponse' + attributes: + description: >- + Optional. The list of user defined attributes associated with the + spec. The key is the attribute name. It will be of the format: + `projects/{project}/locations/{location}/attributes/{attribute}`. + The value is the attribute values associated with the resource. + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudApihubV1AttributeValues' + documentation: + description: >- + Optional. The documentation of the spec. For OpenAPI spec, this will + be populated from `externalDocs` in OpenAPI spec. + $ref: '#/components/schemas/GoogleCloudApihubV1Documentation' + parsingMode: + description: >- + Optional. Input only. Enum specifying the parsing mode for OpenAPI + Specification (OAS) parsing. + type: string + enumDescriptions: + - Defaults to `RELAXED`. + - >- + Parsing of the Spec on create and update is relaxed, meaning that + parsing errors the spec contents will not fail the API call. + - >- + Parsing of the Spec on create and update is strict, meaning that + parsing errors in the spec contents will fail the API call. + enum: + - PARSING_MODE_UNSPECIFIED + - RELAXED + - STRICT + sourceMetadata: + description: >- + Output only. The list of sources and metadata from the sources of + the spec. + readOnly: true + type: array + items: + $ref: '#/components/schemas/GoogleCloudApihubV1SourceMetadata' + GoogleCloudApihubV1SpecContents: + id: GoogleCloudApihubV1SpecContents + description: The spec contents. + type: object + properties: + contents: + description: Required. The contents of the spec. + type: string + format: byte + mimeType: + description: >- + Required. The mime type of the content for example application/json, + application/yaml, application/wsdl etc. + type: string + GoogleCloudApihubV1SpecDetails: + id: GoogleCloudApihubV1SpecDetails + description: SpecDetails contains the details parsed from supported spec types. + type: object + properties: + openApiSpecDetails: + description: >- + Output only. Additional details apart from `OperationDetails` parsed + from an OpenAPI spec. The OperationDetails parsed from the spec can + be obtained by using ListAPIOperations method. + readOnly: true + $ref: '#/components/schemas/GoogleCloudApihubV1OpenApiSpecDetails' + description: + description: Output only. The description of the spec. + readOnly: true + type: string + GoogleCloudApihubV1OpenApiSpecDetails: + id: GoogleCloudApihubV1OpenApiSpecDetails + description: >- + OpenApiSpecDetails contains the details parsed from an OpenAPI spec in + addition to the fields mentioned in SpecDetails. + type: object + properties: + format: + description: Output only. The format of the spec. + readOnly: true + type: string + enumDescriptions: + - SpecFile type unspecified. + - OpenAPI Spec v2.0. + - OpenAPI Spec v3.0. + - OpenAPI Spec v3.1. + enum: + - FORMAT_UNSPECIFIED + - OPEN_API_SPEC_2_0 + - OPEN_API_SPEC_3_0 + - OPEN_API_SPEC_3_1 + version: + description: >- + Output only. The version in the spec. This maps to `info.version` in + OpenAPI spec. + readOnly: true + type: string + owner: + description: >- + Output only. Owner details for the spec. This maps to `info.contact` + in OpenAPI spec. + readOnly: true + $ref: '#/components/schemas/GoogleCloudApihubV1Owner' + GoogleCloudApihubV1LintResponse: + id: GoogleCloudApihubV1LintResponse + description: LintResponse contains the response from the linter. + type: object + properties: + issues: + description: Optional. Array of issues found in the analyzed document. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApihubV1Issue' + summary: + description: >- + Optional. Summary of all issue types and counts for each severity + level. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApihubV1SummaryEntry' + state: + description: Required. Lint state represents success or failure for linting. + type: string + enumDescriptions: + - Lint state unspecified. + - Linting was completed successfully. + - Linting encountered errors. + enum: + - LINT_STATE_UNSPECIFIED + - LINT_STATE_SUCCESS + - LINT_STATE_ERROR + source: + description: Required. Name of the linting application. + type: string + linter: + description: Required. Name of the linter used. + type: string + enumDescriptions: + - Linter type unspecified. + - Linter type spectral. + - Linter type other. + enum: + - LINTER_UNSPECIFIED + - SPECTRAL + - OTHER + createTime: + description: Required. Timestamp when the linting response was generated. + type: string + format: google-datetime + GoogleCloudApihubV1Issue: + id: GoogleCloudApihubV1Issue + description: Issue contains the details of a single issue found by the linter. + type: object + properties: + code: + description: Required. Rule code unique to each rule defined in linter. + type: string + path: + description: >- + Required. An array of strings indicating the location in the + analyzed document where the rule was triggered. + type: array + items: + type: string + message: + description: >- + Required. Human-readable message describing the issue found by the + linter. + type: string + severity: + description: Required. Severity level of the rule violation. + type: string + enumDescriptions: + - Severity unspecified. + - Severity error. + - Severity warning. + - Severity info. + - Severity hint. + enum: + - SEVERITY_UNSPECIFIED + - SEVERITY_ERROR + - SEVERITY_WARNING + - SEVERITY_INFO + - SEVERITY_HINT + range: + description: Required. Object describing where in the file the issue was found. + $ref: '#/components/schemas/GoogleCloudApihubV1Range' + GoogleCloudApihubV1Range: + id: GoogleCloudApihubV1Range + description: Object describing where in the file the issue was found. + type: object + properties: + start: + description: Required. Start of the issue. + $ref: '#/components/schemas/GoogleCloudApihubV1Point' + end: + description: Required. End of the issue. + $ref: '#/components/schemas/GoogleCloudApihubV1Point' + GoogleCloudApihubV1Point: + id: GoogleCloudApihubV1Point + description: Point within the file (line and character). + type: object + properties: + line: + description: Required. Line number (zero-indexed). + type: integer + format: int32 + character: + description: Required. Character position within the line (zero-indexed). + type: integer + format: int32 + GoogleCloudApihubV1SummaryEntry: + id: GoogleCloudApihubV1SummaryEntry + description: Count of issues with a given severity. + type: object + properties: + severity: + description: Required. Severity of the issue. + type: string + enumDescriptions: + - Severity unspecified. + - Severity error. + - Severity warning. + - Severity info. + - Severity hint. + enum: + - SEVERITY_UNSPECIFIED + - SEVERITY_ERROR + - SEVERITY_WARNING + - SEVERITY_INFO + - SEVERITY_HINT + count: + description: Required. Count of issues with the given severity. + type: integer + format: int32 + GoogleCloudApihubV1ListSpecsResponse: + id: GoogleCloudApihubV1ListSpecsResponse + description: The ListSpecs method's response. + type: object + properties: + specs: + description: The specs corresponding to an API Version. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApihubV1Spec' + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + GoogleCloudApihubV1ApiOperation: + id: GoogleCloudApihubV1ApiOperation + description: >- + Represents an operation contained in an API version in the API Hub. An + operation is added/updated/deleted in an API version when a new spec is + added or an existing spec is updated/deleted in a version. Currently, an + operation will be created only corresponding to OpenAPI spec as parsing + is supported for OpenAPI spec. Alternatively operations can be managed + via create,update and delete APIs, creation of apiOperation can be + possible only for version with no parsed operations and update/delete + can be possible only for operations created via create API. + type: object + properties: + name: + description: >- + Identifier. The name of the operation. Format: + `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}` + type: string + spec: + description: >- + Output only. The name of the spec will be of the format: + `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}` + Note:The name of the spec will be empty if the operation is created + via CreateApiOperation API. + readOnly: true + type: string + details: + description: >- + Optional. Operation details. Note: Even though this field is + optional, it is required for CreateApiOperation API and we will fail + the request if not provided. + $ref: '#/components/schemas/GoogleCloudApihubV1OperationDetails' + createTime: + description: Output only. The time at which the operation was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. The time at which the operation was last updated. + readOnly: true + type: string + format: google-datetime + attributes: + description: >- + Optional. The list of user defined attributes associated with the + API operation resource. The key is the attribute name. It will be of + the format: + `projects/{project}/locations/{location}/attributes/{attribute}`. + The value is the attribute values associated with the resource. + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudApihubV1AttributeValues' + sourceMetadata: + description: >- + Output only. The list of sources and metadata from the sources of + the API operation. + readOnly: true + type: array + items: + $ref: '#/components/schemas/GoogleCloudApihubV1SourceMetadata' + GoogleCloudApihubV1OperationDetails: + id: GoogleCloudApihubV1OperationDetails + description: The operation details parsed from the spec. + type: object + properties: + httpOperation: + description: The HTTP Operation. + $ref: '#/components/schemas/GoogleCloudApihubV1HttpOperation' + description: + description: >- + Optional. Description of the operation behavior. For OpenAPI spec, + this will map to `operation.description` in the spec, in case + description is empty, `operation.summary` will be used. + type: string + documentation: + description: >- + Optional. Additional external documentation for this operation. For + OpenAPI spec, this will map to `operation.documentation` in the + spec. + $ref: '#/components/schemas/GoogleCloudApihubV1Documentation' + deprecated: + description: >- + Optional. For OpenAPI spec, this will be set if + `operation.deprecated`is marked as `true` in the spec. + type: boolean + GoogleCloudApihubV1HttpOperation: + id: GoogleCloudApihubV1HttpOperation + description: The HTTP Operation. + type: object + properties: + path: + description: >- + Optional. The path details for the Operation. Note: Even though this + field is optional, it is required for CreateApiOperation API and we + will fail the request if not provided. + $ref: '#/components/schemas/GoogleCloudApihubV1Path' + method: + description: >- + Optional. Operation method Note: Even though this field is optional, + it is required for CreateApiOperation API and we will fail the + request if not provided. + type: string + enumDescriptions: + - Method unspecified. + - Get Operation type. + - Put Operation type. + - Post Operation type. + - Delete Operation type. + - Options Operation type. + - Head Operation type. + - Patch Operation type. + - Trace Operation type. + enum: + - METHOD_UNSPECIFIED + - GET + - PUT + - POST + - DELETE + - OPTIONS + - HEAD + - PATCH + - TRACE + GoogleCloudApihubV1Path: + id: GoogleCloudApihubV1Path + description: The path details derived from the spec. + type: object + properties: + path: + description: >- + Optional. Complete path relative to server endpoint. Note: Even + though this field is optional, it is required for CreateApiOperation + API and we will fail the request if not provided. + type: string + description: + description: >- + Optional. A short description for the path applicable to all + operations. + type: string + GoogleCloudApihubV1ListApiOperationsResponse: + id: GoogleCloudApihubV1ListApiOperationsResponse + description: The ListApiOperations method's response. + type: object + properties: + apiOperations: + description: The operations corresponding to an API version. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApihubV1ApiOperation' + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + GoogleCloudApihubV1Definition: + id: GoogleCloudApihubV1Definition + description: >- + Represents a definition for example schema, request, response + definitions contained in an API version. A definition is + added/updated/deleted in an API version when a new spec is added or an + existing spec is updated/deleted in a version. Currently, definition + will be created only corresponding to OpenAPI spec as parsing is + supported for OpenAPI spec. Also, within OpenAPI spec, only `schema` + object is supported. + type: object + properties: + schema: + description: Output only. The value of a schema definition. + readOnly: true + $ref: '#/components/schemas/GoogleCloudApihubV1Schema' + name: + description: >- + Identifier. The name of the definition. Format: + `projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}` + type: string + spec: + description: >- + Output only. The name of the spec from where the definition was + parsed. Format is + `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}` + readOnly: true + type: string + type: + description: Output only. The type of the definition. + readOnly: true + type: string + enumDescriptions: + - Definition type unspecified. + - Definition type schema. + enum: + - TYPE_UNSPECIFIED + - SCHEMA + createTime: + description: Output only. The time at which the definition was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. The time at which the definition was last updated. + readOnly: true + type: string + format: google-datetime + attributes: + description: >- + Optional. The list of user defined attributes associated with the + definition resource. The key is the attribute name. It will be of + the format: + `projects/{project}/locations/{location}/attributes/{attribute}`. + The value is the attribute values associated with the resource. + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudApihubV1AttributeValues' + GoogleCloudApihubV1Schema: + id: GoogleCloudApihubV1Schema + description: >- + The schema details derived from the spec. Currently, this entity is + supported for OpenAPI spec only. For OpenAPI spec, this maps to the + schema defined in the `definitions` section for OpenAPI 2.0 version and + in `components.schemas` section for OpenAPI 3.0 and 3.1 version. + type: object + properties: + displayName: + description: >- + Output only. The display name of the schema. This will map to the + name of the schema in the spec. + readOnly: true + type: string + rawValue: + description: >- + Output only. The raw value of the schema definition corresponding to + the schema name in the spec. + readOnly: true + type: string + format: byte + GoogleCloudApihubV1Deployment: + id: GoogleCloudApihubV1Deployment + description: >- + Details of the deployment where APIs are hosted. A deployment could + represent an Apigee proxy, API gateway, other Google Cloud services or + non-Google Cloud services as well. A deployment entity is a root level + entity in the API hub and exists independent of any API. + type: object + properties: + name: + description: >- + Identifier. The name of the deployment. Format: + `projects/{project}/locations/{location}/deployments/{deployment}` + type: string + displayName: + description: Required. The display name of the deployment. + type: string + description: + description: Optional. The description of the deployment. + type: string + documentation: + description: Optional. The documentation of the deployment. + $ref: '#/components/schemas/GoogleCloudApihubV1Documentation' + deploymentType: + description: >- + Required. The type of deployment. This maps to the following system + defined attribute: + `projects/{project}/locations/{location}/attributes/system-deployment-type` + attribute. The number of values for this attribute will be based on + the cardinality of the attribute. The same can be retrieved via + GetAttribute API. All values should be from the list of allowed + values defined for the attribute. + $ref: '#/components/schemas/GoogleCloudApihubV1AttributeValues' + resourceUri: + description: >- + Required. The resource URI identifies the deployment within its + gateway. For Apigee gateways, its recommended to use the format: + organizations/{org}/environments/{env}/apis/{api}. For ex: if a + proxy with name `orders` is deployed in `staging` environment of + `cymbal` organization, the resource URI would be: + `organizations/cymbal/environments/staging/apis/orders`. + type: string + endpoints: + description: >- + Required. The endpoints at which this deployment resource is + listening for API requests. This could be a list of complete URIs, + hostnames or an IP addresses. + type: array + items: + type: string + apiVersions: + description: >- + Output only. The API versions linked to this deployment. Note: A + particular deployment could be linked to multiple different API + versions (of same or different APIs). + readOnly: true + type: array + items: + type: string + createTime: + description: Output only. The time at which the deployment was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. The time at which the deployment was last updated. + readOnly: true + type: string + format: google-datetime + slo: + description: >- + Optional. The SLO for this deployment. This maps to the following + system defined attribute: + `projects/{project}/locations/{location}/attributes/system-slo` + attribute. The number of values for this attribute will be based on + the cardinality of the attribute. The same can be retrieved via + GetAttribute API. All values should be from the list of allowed + values defined for the attribute. + $ref: '#/components/schemas/GoogleCloudApihubV1AttributeValues' + environment: + description: >- + Optional. The environment mapping to this deployment. This maps to + the following system defined attribute: + `projects/{project}/locations/{location}/attributes/system-environment` + attribute. The number of values for this attribute will be based on + the cardinality of the attribute. The same can be retrieved via + GetAttribute API. All values should be from the list of allowed + values defined for the attribute. + $ref: '#/components/schemas/GoogleCloudApihubV1AttributeValues' + attributes: + description: >- + Optional. The list of user defined attributes associated with the + deployment resource. The key is the attribute name. It will be of + the format: + `projects/{project}/locations/{location}/attributes/{attribute}`. + The value is the attribute values associated with the resource. + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudApihubV1AttributeValues' + sourceMetadata: + description: >- + Output only. The list of sources and metadata from the sources of + the deployment. + readOnly: true + type: array + items: + $ref: '#/components/schemas/GoogleCloudApihubV1SourceMetadata' + managementUrl: + description: >- + Optional. The uri where users can navigate to for the management of + the deployment. This maps to the following system defined attribute: + `projects/{project}/locations/{location}/attributes/system-management-url` + The number of values for this attribute will be based on the + cardinality of the attribute. The same can be retrieved via + GetAttribute API. The value of the attribute should be a valid URL. + $ref: '#/components/schemas/GoogleCloudApihubV1AttributeValues' + sourceUri: + description: >- + Optional. The uri where additional source specific information for + this deployment can be found. This maps to the following system + defined attribute: + `projects/{project}/locations/{location}/attributes/system-source-uri` + The number of values for this attribute will be based on the + cardinality of the attribute. The same can be retrieved via + GetAttribute API. The value of the attribute should be a valid URI, + and in case of Cloud Storage URI, it should point to a Cloud Storage + object, not a directory. + $ref: '#/components/schemas/GoogleCloudApihubV1AttributeValues' + sourceProject: + description: >- + Optional. The project to which the deployment belongs. For GCP + gateways, this will refer to the project identifier. For others like + Edge/OPDK, this will refer to the org identifier. + type: string + sourceEnvironment: + description: >- + Optional. The environment at source for the deployment. For example: + prod, dev, staging, etc. + type: string + GoogleCloudApihubV1ListDeploymentsResponse: + id: GoogleCloudApihubV1ListDeploymentsResponse + description: The ListDeployments method's response. + type: object + properties: + deployments: + description: The deployment resources present in the API hub. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApihubV1Deployment' + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + GoogleCloudApihubV1Attribute: + id: GoogleCloudApihubV1Attribute + description: >- + An attribute in the API Hub. An attribute is a name value pair which can + be attached to different resources in the API hub based on the scope of + the attribute. Attributes can either be pre-defined by the API Hub or + created by users. + type: object + properties: + name: + description: >- + Identifier. The name of the attribute in the API Hub. Format: + `projects/{project}/locations/{location}/attributes/{attribute}` + type: string + displayName: + description: Required. The display name of the attribute. + type: string + description: + description: Optional. The description of the attribute. + type: string + definitionType: + description: Output only. The definition type of the attribute. + readOnly: true + type: string + enumDescriptions: + - Attribute definition type unspecified. + - >- + The attribute is predefined by the API Hub. Note that only the + list of allowed values can be updated in this case via + UpdateAttribute method. + - The attribute is defined by the user. + enum: + - DEFINITION_TYPE_UNSPECIFIED + - SYSTEM_DEFINED + - USER_DEFINED + scope: + description: >- + Required. The scope of the attribute. It represents the resource in + the API Hub to which the attribute can be linked. + type: string + enumDescriptions: + - Scope Unspecified. + - Attribute can be linked to an API. + - Attribute can be linked to an API version. + - Attribute can be linked to a Spec. + - Attribute can be linked to an API Operation. + - Attribute can be linked to a Deployment. + - Attribute can be linked to a Dependency. + - Attribute can be linked to a definition. + - Attribute can be linked to a ExternalAPI. + - Attribute can be linked to a Plugin. + enum: + - SCOPE_UNSPECIFIED + - API + - VERSION + - SPEC + - API_OPERATION + - DEPLOYMENT + - DEPENDENCY + - DEFINITION + - EXTERNAL_API + - PLUGIN + dataType: + description: Required. The type of the data of the attribute. + type: string + enumDescriptions: + - Attribute data type unspecified. + - Attribute's value is of type enum. + - Attribute's value is of type json. + - Attribute's value is of type string. + - Attribute's value is of type uri. + enum: + - DATA_TYPE_UNSPECIFIED + - ENUM + - JSON + - STRING + - URI + allowedValues: + description: >- + Optional. The list of allowed values when the attribute value is of + type enum. This is required when the data_type of the attribute is + ENUM. The maximum number of allowed values of an attribute will be + 1000. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApihubV1AllowedValue' + cardinality: + description: >- + Optional. The maximum number of values that the attribute can have + when associated with an API Hub resource. Cardinality 1 would + represent a single-valued attribute. It must not be less than 1 or + greater than 20. If not specified, the cardinality would be set to 1 + by default and represent a single-valued attribute. + type: integer + format: int32 + mandatory: + description: >- + Output only. When mandatory is true, the attribute is mandatory for + the resource specified in the scope. Only System defined attributes + can be mandatory. + readOnly: true + type: boolean + createTime: + description: Output only. The time at which the attribute was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. The time at which the attribute was last updated. + readOnly: true + type: string + format: google-datetime + GoogleCloudApihubV1ListAttributesResponse: + id: GoogleCloudApihubV1ListAttributesResponse + description: The ListAttributes method's response. + type: object + properties: + attributes: + description: The list of all attributes. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApihubV1Attribute' + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + GoogleCloudApihubV1SearchResourcesRequest: + id: GoogleCloudApihubV1SearchResourcesRequest + description: The SearchResources method's request. + type: object + properties: + query: + description: >- + Required. The free text search query. This query can contain + keywords which could be related to any detail of the API-Hub + resources such display names, descriptions, attributes etc. + type: string + filter: + description: >- + Optional. An expression that filters the list of search results. A + filter expression consists of a field name, a comparison operator, + and a value for filtering. The value must be a string, a number, or + a boolean. The comparison operator must be `=`. Filters are not case + sensitive. The following field names are eligible for filtering: * + `resource_type` - The type of resource in the search results. Must + be one of the following: `Api`, `ApiOperation`, `Deployment`, + `Definition`, `Spec` or `Version`. This field can only be specified + once in the filter. Here are is an example: * `resource_type = Api` + - The resource_type is _Api_. + type: string + pageSize: + description: >- + Optional. The maximum number of search results to return. The + service may return fewer than this value. If unspecified at most 10 + search results will be returned. If value is negative then + `INVALID_ARGUMENT` error is returned. The maximum value is 25; + values above 25 will be coerced to 25. While paginating, you can + specify a new page size parameter for each page of search results to + be listed. + type: integer + format: int32 + pageToken: + description: >- + Optional. A page token, received from a previous SearchResources + call. Specify this parameter to retrieve the next page of + transactions. When paginating, you must specify the `page_token` + parameter and all the other parameters except page_size should be + specified with the same value which was used in the previous call. + If the other fields are set with a different value than the previous + call then `INVALID_ARGUMENT` error is returned. + type: string + GoogleCloudApihubV1SearchResourcesResponse: + id: GoogleCloudApihubV1SearchResourcesResponse + description: Response for the SearchResources method. + type: object + properties: + searchResults: + description: >- + List of search results according to the filter and search query + specified. The order of search results represents the ranking. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApihubV1SearchResult' + nextPageToken: + description: >- + Pass this token in the SearchResourcesRequest to continue to list + results. If all results have been returned, this field is an empty + string or not present in the response. + type: string + GoogleCloudApihubV1SearchResult: + id: GoogleCloudApihubV1SearchResult + description: Represents the search results. + type: object + properties: + resource: + description: >- + This represents the ApiHubResource. Note: Only selected fields of + the resources are populated in response. + $ref: '#/components/schemas/GoogleCloudApihubV1ApiHubResource' + GoogleCloudApihubV1ApiHubResource: + id: GoogleCloudApihubV1ApiHubResource + description: >- + ApiHubResource is one of the resources such as Api, Operation, + Deployment, Definition, Spec and Version resources stored in API-Hub. + type: object + properties: + api: + description: >- + This represents Api resource in search results. Only name, + display_name, description and owner fields are populated in search + results. + $ref: '#/components/schemas/GoogleCloudApihubV1Api' + operation: + description: >- + This represents ApiOperation resource in search results. Only name, + description, spec and details fields are populated in search + results. + $ref: '#/components/schemas/GoogleCloudApihubV1ApiOperation' + deployment: + description: >- + This represents Deployment resource in search results. Only name, + display_name, description, deployment_type and api_versions fields + are populated in search results. + $ref: '#/components/schemas/GoogleCloudApihubV1Deployment' + spec: + description: >- + This represents Spec resource in search results. Only name, + display_name, description, spec_type and documentation fields are + populated in search results. + $ref: '#/components/schemas/GoogleCloudApihubV1Spec' + definition: + description: >- + This represents Definition resource in search results. Only name + field is populated in search results. + $ref: '#/components/schemas/GoogleCloudApihubV1Definition' + version: + description: >- + This represents Version resource in search results. Only name, + display_name, description, lifecycle, compliance and accreditation + fields are populated in search results. + $ref: '#/components/schemas/GoogleCloudApihubV1Version' + GoogleCloudApihubV1ExternalApi: + id: GoogleCloudApihubV1ExternalApi + description: >- + An external API represents an API being provided by external sources. + This can be used to model third-party APIs and can be used to define + dependencies. + type: object + properties: + name: + description: >- + Identifier. Format: + `projects/{project}/locations/{location}/externalApi/{externalApi}`. + type: string + displayName: + description: >- + Required. Display name of the external API. Max length is 63 + characters (Unicode Code Points). + type: string + description: + description: >- + Optional. Description of the external API. Max length is 2000 + characters (Unicode Code Points). + type: string + endpoints: + description: Optional. List of endpoints on which this API is accessible. + type: array + items: + type: string + paths: + description: Optional. List of paths served by this API. + type: array + items: + type: string + documentation: + description: Optional. Documentation of the external API. + $ref: '#/components/schemas/GoogleCloudApihubV1Documentation' + attributes: + description: >- + Optional. The list of user defined attributes associated with the + Version resource. The key is the attribute name. It will be of the + format: + `projects/{project}/locations/{location}/attributes/{attribute}`. + The value is the attribute values associated with the resource. + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudApihubV1AttributeValues' + createTime: + description: Output only. Creation timestamp. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. Last update timestamp. + readOnly: true + type: string + format: google-datetime + GoogleCloudApihubV1ListExternalApisResponse: + id: GoogleCloudApihubV1ListExternalApisResponse + description: The ListExternalApis method's response. + type: object + properties: + externalApis: + description: The External API resources present in the API hub. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApihubV1ExternalApi' + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + GoogleCloudApihubV1Dependency: + id: GoogleCloudApihubV1Dependency + description: >- + A dependency resource defined in the API hub describes a dependency + directed from a consumer to a supplier entity. A dependency can be + defined between two Operations or between an Operation and External API. + type: object + properties: + name: + description: >- + Identifier. The name of the dependency in the API Hub. Format: + `projects/{project}/locations/{location}/dependencies/{dependency}` + type: string + consumer: + description: >- + Required. Immutable. The entity acting as the consumer in the + dependency. + $ref: '#/components/schemas/GoogleCloudApihubV1DependencyEntityReference' + supplier: + description: >- + Required. Immutable. The entity acting as the supplier in the + dependency. + $ref: '#/components/schemas/GoogleCloudApihubV1DependencyEntityReference' + state: + description: Output only. State of the dependency. + readOnly: true + type: string + enumDescriptions: + - Default value. This value is unused. + - >- + Dependency will be in a proposed state when it is newly identified + by the API hub on its own. + - >- + Dependency will be in a validated state when it is validated by + the admin or manually created in the API hub. + enum: + - STATE_UNSPECIFIED + - PROPOSED + - VALIDATED + description: + description: >- + Optional. Human readable description corresponding of the + dependency. + type: string + discoveryMode: + description: Output only. Discovery mode of the dependency. + readOnly: true + type: string + enumDescriptions: + - Default value. This value is unused. + - >- + Manual mode of discovery when the dependency is defined by the + user. + enum: + - DISCOVERY_MODE_UNSPECIFIED + - MANUAL + errorDetail: + description: >- + Output only. Error details of a dependency if the system has + detected it internally. + readOnly: true + $ref: '#/components/schemas/GoogleCloudApihubV1DependencyErrorDetail' + createTime: + description: Output only. The time at which the dependency was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. The time at which the dependency was last updated. + readOnly: true + type: string + format: google-datetime + attributes: + description: >- + Optional. The list of user defined attributes associated with the + dependency resource. The key is the attribute name. It will be of + the format: + `projects/{project}/locations/{location}/attributes/{attribute}`. + The value is the attribute values associated with the resource. + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudApihubV1AttributeValues' + GoogleCloudApihubV1DependencyEntityReference: + id: GoogleCloudApihubV1DependencyEntityReference + description: Reference to an entity participating in a dependency. + type: object + properties: + operationResourceName: + description: >- + The resource name of an operation in the API Hub. Format: + `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}` + type: string + externalApiResourceName: + description: >- + The resource name of an external API in the API Hub. Format: + `projects/{project}/locations/{location}/externalApis/{external_api}` + type: string + displayName: + description: Output only. Display name of the entity. + readOnly: true + type: string + GoogleCloudApihubV1DependencyErrorDetail: + id: GoogleCloudApihubV1DependencyErrorDetail + description: Details describing error condition of a dependency. + type: object + properties: + error: + description: Optional. Error in the dependency. + type: string + enumDescriptions: + - Default value used for no error in the dependency. + - Supplier entity has been deleted. + - Supplier entity has been recreated. + enum: + - ERROR_UNSPECIFIED + - SUPPLIER_NOT_FOUND + - SUPPLIER_RECREATED + errorTime: + description: Optional. Timestamp at which the error was found. + type: string + format: google-datetime + GoogleCloudApihubV1ListDependenciesResponse: + id: GoogleCloudApihubV1ListDependenciesResponse + description: The ListDependencies method's response. + type: object + properties: + dependencies: + description: The dependency resources present in the API hub. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApihubV1Dependency' + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + GoogleCloudApihubV1CollectApiDataRequest: + id: GoogleCloudApihubV1CollectApiDataRequest + description: The CollectApiData method's request. + type: object + properties: + collectionType: + description: >- + Required. The type of collection. Applies to all entries in + api_data. + type: string + enumDescriptions: + - >- + The default value. This value is used if the collection type is + omitted. + - >- + The collection type is upsert. This should be used when an API is + created or updated at the source. + - >- + The collection type is delete. This should be used when an API is + deleted at the source. + enum: + - COLLECTION_TYPE_UNSPECIFIED + - COLLECTION_TYPE_UPSERT + - COLLECTION_TYPE_DELETE + pluginInstance: + description: >- + Required. The plugin instance collecting the API data. Format: + `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`. + type: string + actionId: + description: >- + Required. The action ID to be used for collecting the API data. This + should map to one of the action IDs specified in action configs in + the plugin. + type: string + apiData: + description: Required. The API data to be collected. + $ref: '#/components/schemas/GoogleCloudApihubV1ApiData' + GoogleCloudApihubV1ApiData: + id: GoogleCloudApihubV1ApiData + description: The API data to be collected. + type: object + properties: + apiMetadataList: + description: Optional. The list of API metadata. + $ref: '#/components/schemas/GoogleCloudApihubV1ApiMetadataList' + GoogleCloudApihubV1ApiMetadataList: + id: GoogleCloudApihubV1ApiMetadataList + description: The message to hold repeated API metadata. + type: object + properties: + apiMetadata: + description: Required. The list of API metadata. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApihubV1APIMetadata' + GoogleCloudApihubV1APIMetadata: + id: GoogleCloudApihubV1APIMetadata + description: The API metadata. + type: object + properties: + api: + description: >- + Required. The API resource to be pushed to Hub's collect layer. The + ID of the API resource will be generated by Hub to ensure uniqueness + across all APIs across systems. + $ref: '#/components/schemas/GoogleCloudApihubV1Api' + versions: + description: Optional. The list of versions present in an API resource. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApihubV1VersionMetadata' + originalId: + description: >- + Optional. The unique identifier of the API in the system where it + was originally created. + type: string + originalCreateTime: + description: >- + Optional. Timestamp indicating when the API was created at the + source. + type: string + format: google-datetime + originalUpdateTime: + description: >- + Required. Timestamp indicating when the API was last updated at the + source. + type: string + format: google-datetime + GoogleCloudApihubV1VersionMetadata: + id: GoogleCloudApihubV1VersionMetadata + description: The metadata associated with a version of the API resource. + type: object + properties: + version: + description: >- + Required. Represents a version of the API resource in API hub. The + ID of the version will be generated by Hub. + $ref: '#/components/schemas/GoogleCloudApihubV1Version' + specs: + description: >- + Optional. The specs associated with this version. Note that an API + version can be associated with multiple specs. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApihubV1SpecMetadata' + deployments: + description: >- + Optional. The deployments linked to this API version. Note: A + particular API version could be deployed to multiple deployments + (for dev deployment, UAT deployment, etc.) + type: array + items: + $ref: '#/components/schemas/GoogleCloudApihubV1DeploymentMetadata' + originalId: + description: >- + Optional. The unique identifier of the version in the system where + it was originally created. + type: string + originalCreateTime: + description: >- + Optional. Timestamp indicating when the version was created at the + source. + type: string + format: google-datetime + originalUpdateTime: + description: >- + Required. Timestamp indicating when the version was last updated at + the source. + type: string + format: google-datetime + GoogleCloudApihubV1SpecMetadata: + id: GoogleCloudApihubV1SpecMetadata + description: The metadata associated with a spec of the API version. + type: object + properties: + spec: + description: >- + Required. The spec resource to be pushed to Hub's collect layer. The + ID of the spec will be generated by Hub. + $ref: '#/components/schemas/GoogleCloudApihubV1Spec' + originalId: + description: >- + Optional. The unique identifier of the spec in the system where it + was originally created. + type: string + originalCreateTime: + description: >- + Optional. Timestamp indicating when the spec was created at the + source. + type: string + format: google-datetime + originalUpdateTime: + description: >- + Required. Timestamp indicating when the spec was last updated at the + source. + type: string + format: google-datetime + GoogleCloudApihubV1DeploymentMetadata: + id: GoogleCloudApihubV1DeploymentMetadata + description: The metadata associated with a deployment. + type: object + properties: + deployment: + description: >- + Required. The deployment resource to be pushed to Hub's collect + layer. The ID of the deployment will be generated by Hub. + $ref: '#/components/schemas/GoogleCloudApihubV1Deployment' + originalId: + description: >- + Optional. The unique identifier of the deployment in the system + where it was originally created. + type: string + originalCreateTime: + description: >- + Optional. Timestamp indicating when the deployment was created at + the source. + type: string + format: google-datetime + originalUpdateTime: + description: >- + Required. Timestamp indicating when the deployment was last updated + at the source. + type: string + format: google-datetime + GoogleCloudApihubV1Curation: + id: GoogleCloudApihubV1Curation + description: A curation resource in the API Hub. + type: object + properties: + name: + description: >- + Identifier. The name of the curation. Format: + `projects/{project}/locations/{location}/curations/{curation}` + type: string + displayName: + description: Required. The display name of the curation. + type: string + description: + description: Optional. The description of the curation. + type: string + endpoint: + description: Required. The endpoint to be triggered for curation. + $ref: '#/components/schemas/GoogleCloudApihubV1Endpoint' + pluginInstanceActions: + description: >- + Output only. The plugin instances and associated actions that are + using the curation. Note: A particular curation could be used by + multiple plugin instances or multiple actions in a plugin instance. + readOnly: true + type: array + items: + $ref: '#/components/schemas/GoogleCloudApihubV1PluginInstanceActionID' + lastExecutionState: + description: Output only. The last execution state of the curation. + readOnly: true + type: string + enumDescriptions: + - Default unspecified state. + - The last curation execution was successful. + - The last curation execution failed. + enum: + - LAST_EXECUTION_STATE_UNSPECIFIED + - SUCCEEDED + - FAILED + lastExecutionErrorCode: + description: >- + Output only. The error code of the last execution of the curation. + The error code is populated only when the last execution state is + failed. + readOnly: true + type: string + enumDescriptions: + - Default unspecified error code. + - The execution failed due to an internal error. + - The curation is not authorized to trigger the endpoint uri. + enum: + - ERROR_CODE_UNSPECIFIED + - INTERNAL_ERROR + - UNAUTHORIZED + lastExecutionErrorMessage: + description: >- + Output only. Error message describing the failure, if any, during + the last execution of the curation. + readOnly: true + type: string + createTime: + description: Output only. The time at which the curation was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. The time at which the curation was last updated. + readOnly: true + type: string + format: google-datetime + GoogleCloudApihubV1Endpoint: + id: GoogleCloudApihubV1Endpoint + description: >- + The endpoint to be triggered for curation. The endpoint will be invoked + with a request payload containing ApiMetadata. Response should contain + curated data in the form of ApiMetadata. + type: object + properties: + applicationIntegrationEndpointDetails: + description: >- + Required. The details of the Application Integration endpoint to be + triggered for curation. + $ref: >- + #/components/schemas/GoogleCloudApihubV1ApplicationIntegrationEndpointDetails + GoogleCloudApihubV1ApplicationIntegrationEndpointDetails: + id: GoogleCloudApihubV1ApplicationIntegrationEndpointDetails + description: >- + The details of the Application Integration endpoint to be triggered for + curation. + type: object + properties: + uri: + description: >- + Required. The endpoint URI should be a valid REST URI for triggering + an Application Integration. Format: + `https://integrations.googleapis.com/v1/{name=projects/*/locations/*/integrations/*}:execute` + or + `https://{location}-integrations.googleapis.com/v1/{name=projects/*/locations/*/integrations/*}:execute` + type: string + triggerId: + description: >- + Required. The API trigger ID of the Application Integration + workflow. + type: string + GoogleCloudApihubV1PluginInstanceActionID: + id: GoogleCloudApihubV1PluginInstanceActionID + description: The plugin instance and associated action that is using the curation. + type: object + properties: + pluginInstance: + description: >- + Output only. Plugin instance that is using the curation. Format is + `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}` + readOnly: true + type: string + actionId: + description: >- + Output only. The action ID that is using the curation. This should + map to one of the action IDs specified in action configs in the + plugin. + readOnly: true + type: string + GoogleCloudApihubV1ListCurationsResponse: + id: GoogleCloudApihubV1ListCurationsResponse + description: The ListCurations method's response. + type: object + properties: + curations: + description: The curation resources present in the API hub. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApihubV1Curation' + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + GoogleCloudApihubV1ListDiscoveredApiObservationsResponse: + id: GoogleCloudApihubV1ListDiscoveredApiObservationsResponse + description: Message for response to listing DiscoveredApiObservations + type: object + properties: + discoveredApiObservations: + description: >- + The DiscoveredApiObservation from the specified project and + location. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApihubV1DiscoveredApiObservation' + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + GoogleCloudApihubV1DiscoveredApiObservation: + id: GoogleCloudApihubV1DiscoveredApiObservation + description: Respresents an API Observation observed in one of the sources. + type: object + properties: + name: + description: >- + Identifier. The name of the discovered API Observation. Format: + `projects/{project}/locations/{location}/discoveredApiObservations/{discovered_api_observation}` + type: string + style: + description: Optional. Style of ApiObservation + type: string + enumDescriptions: + - Unknown style + - Style is Rest API + - Style is Grpc API + - Style is GraphQL API + enum: + - STYLE_UNSPECIFIED + - REST + - GRPC + - GRAPHQL + serverIps: + description: >- + Optional. The IP address (IPv4 or IPv6) of the origin server that + the request was sent to. This field can include port information. + Examples: `"192.168.1.1"`, `"10.0.0.1:80"`, + `"FE80::0202:B3FF:FE1E:8329"`. + type: array + items: + type: string + hostname: + description: Optional. The hostname of requests processed for this Observation. + type: string + lastEventDetectedTime: + description: Optional. Last event detected time stamp + type: string + format: google-datetime + sourceLocations: + description: Optional. The location of the observation source. + type: array + items: + type: string + apiOperationCount: + description: Optional. The number of observed API Operations. + type: string + format: int64 + origin: + description: >- + Optional. For an observation pushed from a gcp resource, this would + be the gcp project id. + type: string + sourceTypes: + description: >- + Optional. The type of the source from which the observation was + collected. + type: array + items: + type: string + enumDescriptions: + - Source type not specified. + - GCP external load balancer. + - GCP internal load balancer. + enum: + - SOURCE_TYPE_UNSPECIFIED + - GCP_XLB + - GCP_ILB + knownOperationsCount: + description: Output only. The number of known API Operations. + readOnly: true + type: string + format: int64 + unknownOperationsCount: + description: Output only. The number of unknown API Operations. + readOnly: true + type: string + format: int64 + createTime: + description: Output only. Create time stamp of the observation in API Hub. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. Update time stamp of the observation in API Hub. + readOnly: true + type: string + format: google-datetime + sourceMetadata: + description: >- + Output only. The metadata of the source from which the observation + was collected. + readOnly: true + $ref: '#/components/schemas/GoogleCloudApihubV1SourceMetadata' + GoogleCloudApihubV1ListDiscoveredApiOperationsResponse: + id: GoogleCloudApihubV1ListDiscoveredApiOperationsResponse + description: Message for response to listing DiscoveredApiOperations + type: object + properties: + discoveredApiOperations: + description: >- + The DiscoveredApiOperations from the specified project, location and + DiscoveredApiObservation. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApihubV1DiscoveredApiOperation' + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + GoogleCloudApihubV1DiscoveredApiOperation: + id: GoogleCloudApihubV1DiscoveredApiOperation + description: >- + DiscoveredApiOperation represents an API Operation observed in one of + the sources. + type: object + properties: + httpOperation: + description: Optional. An HTTP Operation. + $ref: '#/components/schemas/GoogleCloudApihubV1HttpOperationDetails' + name: + description: >- + Identifier. The name of the discovered API Operation. Format: + `projects/{project}/locations/{location}/discoveredApiObservations/{discovered_api_observation}/discoveredApiOperations/{discovered_api_operation}` + type: string + firstSeenTime: + description: Optional. First seen time stamp + type: string + format: google-datetime + lastSeenTime: + description: Optional. Last seen time stamp + type: string + format: google-datetime + count: + description: Optional. The number of occurrences of this API Operation. + type: string + format: int64 + classification: + description: Output only. The classification of the discovered API operation. + readOnly: true + type: string + enumDescriptions: + - Operation is not classified as known or unknown. + - Operation has a matched catalog operation. + - Operation does not have a matched catalog operation. + enum: + - CLASSIFICATION_UNSPECIFIED + - KNOWN + - UNKNOWN + matchResults: + description: >- + Output only. The list of matched results for the discovered API + operation. This will be populated only if the classification is + known. The current usecase is for a single match. Keeping it + repeated to support multiple matches in future. + readOnly: true + type: array + items: + $ref: '#/components/schemas/GoogleCloudApihubV1MatchResult' + sourceMetadata: + description: >- + Output only. The metadata of the source from which the api operation + was collected. + readOnly: true + $ref: '#/components/schemas/GoogleCloudApihubV1SourceMetadata' + createTime: + description: >- + Output only. Create time stamp of the discovered API operation in + API Hub. + readOnly: true + type: string + format: google-datetime + updateTime: + description: >- + Output only. Update time stamp of the discovered API operation in + API Hub. + readOnly: true + type: string + format: google-datetime + GoogleCloudApihubV1HttpOperationDetails: + id: GoogleCloudApihubV1HttpOperationDetails + description: An HTTP-based API Operation, sometimes called a "REST" Operation. + type: object + properties: + httpOperation: + description: Required. An HTTP Operation. + $ref: '#/components/schemas/GoogleCloudApihubV1HttpOperation' + pathParams: + description: Optional. Path params of HttpOperation + type: array + items: + $ref: '#/components/schemas/GoogleCloudApihubV1PathParam' + queryParams: + description: Optional. Query params of HttpOperation + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudApihubV1QueryParam' + request: + description: Optional. Request metadata. + $ref: '#/components/schemas/GoogleCloudApihubV1HttpRequest' + response: + description: Optional. Response metadata. + $ref: '#/components/schemas/GoogleCloudApihubV1HttpResponse' + GoogleCloudApihubV1PathParam: + id: GoogleCloudApihubV1PathParam + description: HTTP Path parameter. + type: object + properties: + position: + description: Optional. Segment location in the path, 1-indexed + type: integer + format: int32 + dataType: + description: Optional. Data type of path param + type: string + enumDescriptions: + - Unspecified data type + - Boolean data type + - Integer data type + - Float data type + - String data type + - UUID data type + enum: + - DATA_TYPE_UNSPECIFIED + - BOOL + - INTEGER + - FLOAT + - STRING + - UUID + GoogleCloudApihubV1QueryParam: + id: GoogleCloudApihubV1QueryParam + description: An aggregation of HTTP query parameter occurrences. + type: object + properties: + name: + description: Required. Name of query param + type: string + count: + description: >- + Optional. The number of occurrences of this query parameter across + transactions. + type: string + format: int64 + dataType: + description: Optional. Data type of path param + type: string + enumDescriptions: + - Unspecified data type + - Boolean data type + - Integer data type + - Float data type + - String data type + - UUID data type + enum: + - DATA_TYPE_UNSPECIFIED + - BOOL + - INTEGER + - FLOAT + - STRING + - UUID + GoogleCloudApihubV1HttpRequest: + id: GoogleCloudApihubV1HttpRequest + description: An aggregation of HTTP requests. + type: object + properties: + headers: + description: Optional. Unordered map from header name to header metadata + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudApihubV1Header' + GoogleCloudApihubV1Header: + id: GoogleCloudApihubV1Header + description: An aggregation of HTTP header occurrences. + type: object + properties: + name: + description: Header name. + type: string + count: + description: The number of occurrences of this Header across transactions. + type: string + format: int64 + dataType: + description: Data type of header + type: string + enumDescriptions: + - Unspecified data type + - Boolean data type + - Integer data type + - Float data type + - String data type + - UUID data type + enum: + - DATA_TYPE_UNSPECIFIED + - BOOL + - INTEGER + - FLOAT + - STRING + - UUID + GoogleCloudApihubV1HttpResponse: + id: GoogleCloudApihubV1HttpResponse + description: An aggregation of HTTP responses. + type: object + properties: + headers: + description: Optional. Unordered map from header name to header metadata + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudApihubV1Header' + responseCodes: + description: Optional. Map of status code to observed count + type: object + additionalProperties: + type: string + format: int64 + GoogleCloudApihubV1MatchResult: + id: GoogleCloudApihubV1MatchResult + description: >- + MatchResult represents the result of matching a discovered API operation + with a catalog API operation. + type: object + properties: + name: + description: >- + Output only. The name of the matched API Operation. Format: + `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}` + readOnly: true + type: string + GoogleCloudApihubV1HostProjectRegistration: + id: GoogleCloudApihubV1HostProjectRegistration + description: >- + Host project registration refers to the registration of a Google cloud + project with Api Hub as a host project. This is the project where Api + Hub is provisioned. It acts as the consumer project for the Api Hub + instance provisioned. Multiple runtime projects can be attached to the + host project and these attachments define the scope of Api Hub. + type: object + properties: + name: + description: >- + Identifier. The name of the host project registration. Format: + "projects/{project}/locations/{location}/hostProjectRegistrations/{host_project_registration}". + type: string + gcpProject: + description: >- + Required. Immutable. Google cloud project name in the format: + "projects/abc" or "projects/123". As input, project name with either + project id or number are accepted. As output, this field will + contain project number. + type: string + createTime: + description: >- + Output only. The time at which the host project registration was + created. + readOnly: true + type: string + format: google-datetime + GoogleCloudApihubV1ListHostProjectRegistrationsResponse: + id: GoogleCloudApihubV1ListHostProjectRegistrationsResponse + description: The ListHostProjectRegistrations method's response. + type: object + properties: + hostProjectRegistrations: + description: The list of host project registrations. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApihubV1HostProjectRegistration' + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + GoogleCloudApihubV1StyleGuide: + id: GoogleCloudApihubV1StyleGuide + description: >- + Represents a singleton style guide resource to be used for linting Open + API specs. + type: object + properties: + name: + description: >- + Identifier. The name of the style guide. Format: + `projects/{project}/locations/{location}/plugins/{plugin}/styleGuide` + type: string + linter: + description: Required. Target linter for the style guide. + type: string + enumDescriptions: + - Linter type unspecified. + - Linter type spectral. + - Linter type other. + enum: + - LINTER_UNSPECIFIED + - SPECTRAL + - OTHER + contents: + description: Required. Input only. The contents of the uploaded style guide. + $ref: '#/components/schemas/GoogleCloudApihubV1StyleGuideContents' + GoogleCloudApihubV1StyleGuideContents: + id: GoogleCloudApihubV1StyleGuideContents + description: The style guide contents. + type: object + properties: + contents: + description: Required. The contents of the style guide. + type: string + format: byte + mimeType: + description: Required. The mime type of the content. + type: string + GoogleCloudApihubV1LintSpecRequest: + id: GoogleCloudApihubV1LintSpecRequest + description: The LintSpec method's request. + type: object + properties: {} + GoogleCloudApihubV1ApiHubInstance: + id: GoogleCloudApihubV1ApiHubInstance + description: >- + An ApiHubInstance represents the instance resources of the API Hub. + Currently, only one ApiHub instance is allowed for each project. + type: object + properties: + name: + description: >- + Identifier. Format: + `projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance}`. + type: string + createTime: + description: Output only. Creation timestamp. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. Last update timestamp. + readOnly: true + type: string + format: google-datetime + state: + description: Output only. The current state of the ApiHub instance. + readOnly: true + type: string + enumDescriptions: + - The default value. This value is used if the state is omitted. + - The ApiHub instance has not been initialized or has been deleted. + - The ApiHub instance is being created. + - The ApiHub instance has been created and is ready for use. + - The ApiHub instance is being updated. + - The ApiHub instance is being deleted. + - The ApiHub instance encountered an error during a state change. + enum: + - STATE_UNSPECIFIED + - INACTIVE + - CREATING + - ACTIVE + - UPDATING + - DELETING + - FAILED + stateMessage: + description: >- + Output only. Extra information about ApiHub instance state. + Currently the message would be populated when state is `FAILED`. + readOnly: true + type: string + config: + description: Required. Config of the ApiHub instance. + $ref: '#/components/schemas/GoogleCloudApihubV1Config' + labels: + description: >- + Optional. Instance labels to represent user-provided metadata. Refer + to cloud documentation on labels for more details. + https://cloud.google.com/compute/docs/labeling-resources + type: object + additionalProperties: + type: string + description: + description: Optional. Description of the ApiHub instance. + type: string + GoogleCloudApihubV1Config: + id: GoogleCloudApihubV1Config + description: Available configurations to provision an ApiHub Instance. + type: object + properties: + cmekKeyName: + description: >- + Optional. The Customer Managed Encryption Key (CMEK) used for data + encryption. The CMEK name should follow the format of + `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)`, + where the location must match the instance location. If the CMEK is + not provided, a GMEK will be created for the instance. + type: string + disableSearch: + description: >- + Optional. If true, the search will be disabled for the instance. The + default value is false. + type: boolean + vertexLocation: + description: >- + Optional. The name of the Vertex AI location where the data store is + stored. + type: string + encryptionType: + description: >- + Optional. Encryption type for the region. If the encryption type is + CMEK, the cmek_key_name must be provided. If no encryption type is + provided, GMEK will be used. + type: string + enumDescriptions: + - Encryption type unspecified. + - Default encryption using Google managed encryption key. + - Encryption using customer managed encryption key. + enum: + - ENCRYPTION_TYPE_UNSPECIFIED + - GMEK + - CMEK + GoogleCloudApihubV1LookupApiHubInstanceResponse: + id: GoogleCloudApihubV1LookupApiHubInstanceResponse + description: The LookupApiHubInstance method's response.` + type: object + properties: + apiHubInstance: + description: API Hub instance for a project if it exists, empty otherwise. + $ref: '#/components/schemas/GoogleCloudApihubV1ApiHubInstance' + GoogleCloudApihubV1RuntimeProjectAttachment: + id: GoogleCloudApihubV1RuntimeProjectAttachment + description: >- + Runtime project attachment represents an attachment from the runtime + project to the host project. Api Hub looks for deployments in the + attached runtime projects and creates corresponding resources in Api Hub + for the discovered deployments. + type: object + properties: + name: + description: >- + Identifier. The resource name of a runtime project attachment. + Format: + "projects/{project}/locations/{location}/runtimeProjectAttachments/{runtime_project_attachment}". + type: string + runtimeProject: + description: >- + Required. Immutable. Google cloud project name in the format: + "projects/abc" or "projects/123". As input, project name with either + project id or number are accepted. As output, this field will + contain project number. + type: string + createTime: + description: Output only. Create time. + readOnly: true + type: string + format: google-datetime + GoogleCloudApihubV1ListRuntimeProjectAttachmentsResponse: + id: GoogleCloudApihubV1ListRuntimeProjectAttachmentsResponse + description: The ListRuntimeProjectAttachments method's response. + type: object + properties: + runtimeProjectAttachments: + description: List of runtime project attachments. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApihubV1RuntimeProjectAttachment' + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + GoogleCloudApihubV1LookupRuntimeProjectAttachmentResponse: + id: GoogleCloudApihubV1LookupRuntimeProjectAttachmentResponse + description: The ListRuntimeProjectAttachments method's response. + type: object + properties: + runtimeProjectAttachment: + description: Runtime project attachment for a project if exists, empty otherwise. + $ref: '#/components/schemas/GoogleCloudApihubV1RuntimeProjectAttachment' + GoogleCloudLocationListLocationsResponse: + id: GoogleCloudLocationListLocationsResponse + description: The response message for Locations.ListLocations. + type: object + properties: + locations: + description: >- + A list of locations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/GoogleCloudLocationLocation' + nextPageToken: + description: The standard List next-page token. + type: string + GoogleCloudLocationLocation: + id: GoogleCloudLocationLocation + description: A resource that represents a Google Cloud location. + type: object + properties: + name: + description: >- + Resource name for the location, which may vary between + implementations. For example: + `"projects/example-project/locations/us-east1"` + type: string + locationId: + description: 'The canonical id for this location. For example: `"us-east1"`.' + type: string + displayName: + description: >- + The friendly name for this location, typically a nearby city name. + For example, "Tokyo". + type: string + labels: + description: >- + Cross-service attributes for the location. For example + {"cloud.googleapis.com/region": "us-east1"} + type: object + additionalProperties: + type: string + metadata: + description: >- + Service-specific metadata. For example the available capacity at the + given location. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + GoogleCloudCommonOperationMetadata: + id: GoogleCloudCommonOperationMetadata + description: Represents the metadata of the long-running operation. + type: object + properties: + createTime: + description: Output only. The time the operation was created. + readOnly: true + type: string + format: google-datetime + endTime: + description: Output only. The time the operation finished running. + readOnly: true + type: string + format: google-datetime + target: + description: >- + Output only. Server-defined resource path for the target of the + operation. + readOnly: true + type: string + verb: + description: Output only. Name of the verb executed by the operation. + readOnly: true + type: string + statusDetail: + description: Output only. Human-readable status of the operation, if any. + readOnly: true + type: string + cancelRequested: + description: >- + Output only. Identifies whether the user has requested cancellation + of the operation. Operations that have been cancelled successfully + have google.longrunning.Operation.error value with a + google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + readOnly: true + type: boolean + apiVersion: + description: Output only. API version used to start the operation. + readOnly: true + type: string + GoogleCloudApihubV1OperationMetadata: + id: GoogleCloudApihubV1OperationMetadata + description: Represents the metadata of the long-running operation. + type: object + properties: + createTime: + description: Output only. The time the operation was created. + readOnly: true + type: string + format: google-datetime + endTime: + description: Output only. The time the operation finished running. + readOnly: true + type: string + format: google-datetime + target: + description: >- + Output only. Server-defined resource path for the target of the + operation. + readOnly: true + type: string + verb: + description: Output only. Name of the verb executed by the operation. + readOnly: true + type: string + statusMessage: + description: Output only. Human-readable status of the operation, if any. + readOnly: true + type: string + requestedCancellation: + description: >- + Output only. Identifies whether the user has requested cancellation + of the operation. Operations that have been cancelled successfully + have Operation.error value with a google.rpc.Status.code of 1, + corresponding to `Code.CANCELLED`. + readOnly: true + type: boolean + apiVersion: + description: Output only. API version used to start the operation. + readOnly: true + type: string + parameters: + 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: + type: string + enum: + - json + - media + - proto + 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 + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + x-stackQL-resources: + locations: + id: google.apihub.locations + name: locations + title: Locations + methods: + search_resources: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:searchResources/post + response: + mediaType: application/json + openAPIDocKey: '200' + collect_api_data: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:collectApiData/post + response: + mediaType: application/json + openAPIDocKey: '200' + lookup_runtime_project_attachment: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:lookupRuntimeProjectAttachment/get + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.locations + get: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + operations: + id: google.apihub.operations + name: operations + title: Operations + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1apis~1{apisId}~1versions~1{versionsId}~1operations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.apiOperations + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1apis~1{apisId}~1versions~1{versionsId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1apis~1{apisId}~1versions~1{versionsId}~1operations~1{operationsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + cancel: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post + response: + mediaType: application/json + openAPIDocKey: '200' + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1apis~1{apisId}~1versions~1{versionsId}~1operations/post + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1apis~1{apisId}~1versions~1{versionsId}~1operations~1{operationsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/operations/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/operations/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/operations/methods/delete' + plugins: + id: google.apihub.plugins + name: plugins + title: Plugins + methods: + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1plugins~1{pluginsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1plugins~1{pluginsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + enable: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1plugins~1{pluginsId}:enable/post + response: + mediaType: application/json + openAPIDocKey: '200' + disable: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1plugins~1{pluginsId}:disable/post + response: + mediaType: application/json + openAPIDocKey: '200' + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1plugins/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1plugins/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.plugins + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/plugins/methods/get' + - $ref: '#/components/x-stackQL-resources/plugins/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/plugins/methods/create' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/plugins/methods/delete' + plugins_style_guide: + id: google.apihub.plugins_style_guide + name: plugins_style_guide + title: Plugins_style_guide + methods: + get_style_guide: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1plugins~1{pluginsId}~1styleGuide/get + response: + mediaType: application/json + openAPIDocKey: '200' + update_style_guide: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1plugins~1{pluginsId}~1styleGuide/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/plugins_style_guide/methods/get_style_guide + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/plugins_style_guide/methods/update_style_guide + replace: [] + delete: [] + instances: + id: google.apihub.instances + name: instances + title: Instances + methods: + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1plugins~1{pluginsId}~1instances/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1plugins~1{pluginsId}~1instances/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.pluginInstances + execute_action: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1plugins~1{pluginsId}~1instances~1{instancesId}:executeAction/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1plugins~1{pluginsId}~1instances~1{instancesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1plugins~1{pluginsId}~1instances~1{instancesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1plugins~1{pluginsId}~1instances~1{instancesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + enable_action: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1plugins~1{pluginsId}~1instances~1{instancesId}:enableAction/post + response: + mediaType: application/json + openAPIDocKey: '200' + disable_action: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1plugins~1{pluginsId}~1instances~1{instancesId}:disableAction/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/instances/methods/get' + - $ref: '#/components/x-stackQL-resources/instances/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/instances/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/instances/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/instances/methods/delete' + style_guide_contents: + id: google.apihub.style_guide_contents + name: style_guide_contents + title: Style_guide_contents + methods: + get_contents: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1plugins~1{pluginsId}~1styleGuide:contents/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/style_guide_contents/methods/get_contents + insert: [] + update: [] + replace: [] + delete: [] + apis: + id: google.apihub.apis + name: apis + title: Apis + methods: + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1apis/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1apis/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.apis + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1apis~1{apisId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1apis~1{apisId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1apis~1{apisId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/apis/methods/get' + - $ref: '#/components/x-stackQL-resources/apis/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/apis/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/apis/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/apis/methods/delete' + versions: + id: google.apihub.versions + name: versions + title: Versions + methods: + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1apis~1{apisId}~1versions/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1apis~1{apisId}~1versions/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.versions + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1apis~1{apisId}~1versions~1{versionsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1apis~1{apisId}~1versions~1{versionsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1apis~1{apisId}~1versions~1{versionsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/versions/methods/get' + - $ref: '#/components/x-stackQL-resources/versions/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/versions/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/versions/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/versions/methods/delete' + specs: + id: google.apihub.specs + name: specs + title: Specs + methods: + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1apis~1{apisId}~1versions~1{versionsId}~1specs/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1apis~1{apisId}~1versions~1{versionsId}~1specs/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.specs + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1apis~1{apisId}~1versions~1{versionsId}~1specs~1{specsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1apis~1{apisId}~1versions~1{versionsId}~1specs~1{specsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1apis~1{apisId}~1versions~1{versionsId}~1specs~1{specsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + lint: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1apis~1{apisId}~1versions~1{versionsId}~1specs~1{specsId}:lint/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/specs/methods/get' + - $ref: '#/components/x-stackQL-resources/specs/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/specs/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/specs/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/specs/methods/delete' + specs_contents: + id: google.apihub.specs_contents + name: specs_contents + title: Specs_contents + methods: + get_contents: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1apis~1{apisId}~1versions~1{versionsId}~1specs~1{specsId}:contents/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/specs_contents/methods/get_contents + insert: [] + update: [] + replace: [] + delete: [] + definitions: + id: google.apihub.definitions + name: definitions + title: Definitions + methods: + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1apis~1{apisId}~1versions~1{versionsId}~1definitions~1{definitionsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/definitions/methods/get' + insert: [] + update: [] + replace: [] + delete: [] + deployments: + id: google.apihub.deployments + name: deployments + title: Deployments + methods: + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deployments/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deployments/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.deployments + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deployments~1{deploymentsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deployments~1{deploymentsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deployments~1{deploymentsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/deployments/methods/get' + - $ref: '#/components/x-stackQL-resources/deployments/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/deployments/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/deployments/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/deployments/methods/delete' + attributes: + id: google.apihub.attributes + name: attributes + title: Attributes + methods: + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1attributes/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1attributes/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.attributes + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1attributes~1{attributesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1attributes~1{attributesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1attributes~1{attributesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/attributes/methods/get' + - $ref: '#/components/x-stackQL-resources/attributes/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/attributes/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/attributes/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/attributes/methods/delete' + external_apis: + id: google.apihub.external_apis + name: external_apis + title: External_apis + methods: + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1externalApis/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1externalApis/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.externalApis + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1externalApis~1{externalApisId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1externalApis~1{externalApisId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1externalApis~1{externalApisId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/external_apis/methods/get' + - $ref: '#/components/x-stackQL-resources/external_apis/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/external_apis/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/external_apis/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/external_apis/methods/delete' + dependencies: + id: google.apihub.dependencies + name: dependencies + title: Dependencies + methods: + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dependencies/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dependencies/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.dependencies + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dependencies~1{dependenciesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dependencies~1{dependenciesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dependencies~1{dependenciesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dependencies/methods/get' + - $ref: '#/components/x-stackQL-resources/dependencies/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/dependencies/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/dependencies/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/dependencies/methods/delete' + curations: + id: google.apihub.curations + name: curations + title: Curations + methods: + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1curations/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1curations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.curations + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1curations~1{curationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1curations~1{curationsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1curations~1{curationsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/curations/methods/get' + - $ref: '#/components/x-stackQL-resources/curations/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/curations/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/curations/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/curations/methods/delete' + discovered_api_observations: + id: google.apihub.discovered_api_observations + name: discovered_api_observations + title: Discovered_api_observations + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1discoveredApiObservations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.discoveredApiObservations + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1discoveredApiObservations~1{discoveredApiObservationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/discovered_api_observations/methods/get + - $ref: >- + #/components/x-stackQL-resources/discovered_api_observations/methods/list + insert: [] + update: [] + replace: [] + delete: [] + discovered_api_operations: + id: google.apihub.discovered_api_operations + name: discovered_api_operations + title: Discovered_api_operations + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1discoveredApiObservations~1{discoveredApiObservationsId}~1discoveredApiOperations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.discoveredApiOperations + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1discoveredApiObservations~1{discoveredApiObservationsId}~1discoveredApiOperations~1{discoveredApiOperationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/discovered_api_operations/methods/get + - $ref: >- + #/components/x-stackQL-resources/discovered_api_operations/methods/list + insert: [] + update: [] + replace: [] + delete: [] + host_project_registrations: + id: google.apihub.host_project_registrations + name: host_project_registrations + title: Host_project_registrations + methods: + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hostProjectRegistrations/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hostProjectRegistrations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.hostProjectRegistrations + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hostProjectRegistrations~1{hostProjectRegistrationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/host_project_registrations/methods/get + - $ref: >- + #/components/x-stackQL-resources/host_project_registrations/methods/list + insert: + - $ref: >- + #/components/x-stackQL-resources/host_project_registrations/methods/create + update: [] + replace: [] + delete: [] + api_hub_instances: + id: google.apihub.api_hub_instances + name: api_hub_instances + title: Api_hub_instances + methods: + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1apiHubInstances/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1apiHubInstances~1{apiHubInstancesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1apiHubInstances~1{apiHubInstancesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + lookup: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1apiHubInstances:lookup/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/api_hub_instances/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/api_hub_instances/methods/create' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/api_hub_instances/methods/delete' + runtime_project_attachments: + id: google.apihub.runtime_project_attachments + name: runtime_project_attachments + title: Runtime_project_attachments + methods: + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1runtimeProjectAttachments/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1runtimeProjectAttachments/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.runtimeProjectAttachments + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1runtimeProjectAttachments~1{runtimeProjectAttachmentsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1runtimeProjectAttachments~1{runtimeProjectAttachmentsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/runtime_project_attachments/methods/get + - $ref: >- + #/components/x-stackQL-resources/runtime_project_attachments/methods/list + insert: + - $ref: >- + #/components/x-stackQL-resources/runtime_project_attachments/methods/create + update: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/runtime_project_attachments/methods/delete +paths: + /v1/projects/{projectsId}/locations/{locationsId}:searchResources: + parameters: &ref_1 + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' + post: + description: Search across API-Hub resources. + operationId: apihub.projects.locations.searchResources + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1SearchResourcesRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApihubV1SearchResourcesResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}:collectApiData: + parameters: *ref_1 + post: + description: Collect API data from a source and push it to Hub's collect layer. + operationId: apihub.projects.locations.collectApiData + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1CollectApiDataRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}:lookupRuntimeProjectAttachment: + parameters: *ref_1 + get: + description: >- + Look up a runtime project attachment. This API can be called in the + context of any project. + operationId: apihub.projects.locations.lookupRuntimeProjectAttachment + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApihubV1LookupRuntimeProjectAttachmentResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations: + parameters: *ref_1 + get: + description: Lists information about the supported locations for this service. + operationId: apihub.projects.locations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudLocationListLocationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: extraLocationTypes + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}: + parameters: *ref_1 + get: + description: Gets information about a location. + operationId: apihub.projects.locations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudLocationLocation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: apihub.projects.locations.operations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: apihub.projects.locations.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + delete: + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: apihub.projects.locations.operations.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + `1`, corresponding to `Code.CANCELLED`. + operationId: apihub.projects.locations.operations.cancel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningCancelOperationRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/plugins/{pluginsId}: + parameters: *ref_1 + get: + description: Get an API Hub plugin. + operationId: apihub.projects.locations.plugins.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1Plugin' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: pluginsId + required: true + schema: + type: string + delete: + description: >- + Delete a Plugin in API hub. Note, only user owned plugins can be deleted + via this method. + operationId: apihub.projects.locations.plugins.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: pluginsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/plugins/{pluginsId}:enable: + parameters: *ref_1 + post: + description: Enables a plugin. The `state` of the plugin after enabling is `ENABLED` + operationId: apihub.projects.locations.plugins.enable + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1EnablePluginRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1Plugin' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: pluginsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/plugins/{pluginsId}:disable: + parameters: *ref_1 + post: + description: >- + Disables a plugin. The `state` of the plugin after disabling is + `DISABLED` + operationId: apihub.projects.locations.plugins.disable + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1DisablePluginRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1Plugin' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: pluginsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/plugins: + parameters: *ref_1 + post: + description: >- + Create an API Hub plugin resource in the API hub. Once a plugin is + created, it can be used to create plugin instances. + operationId: apihub.projects.locations.plugins.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1Plugin' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1Plugin' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pluginId + schema: + type: string + get: + description: List all the plugins in a given project and location. + operationId: apihub.projects.locations.plugins.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1ListPluginsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/plugins/{pluginsId}/styleGuide: + parameters: *ref_1 + get: + description: Get the style guide being used for linting. + operationId: apihub.projects.locations.plugins.getStyleGuide + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1StyleGuide' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: pluginsId + required: true + schema: + type: string + patch: + description: Update the styleGuide to be used for liniting in by API hub. + operationId: apihub.projects.locations.plugins.updateStyleGuide + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1StyleGuide' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1StyleGuide' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: pluginsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/plugins/{pluginsId}/instances: + parameters: *ref_1 + post: + description: Creates a Plugin instance in the API hub. + operationId: apihub.projects.locations.plugins.instances.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1PluginInstance' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: pluginsId + required: true + schema: + type: string + - in: query + name: pluginInstanceId + schema: + type: string + get: + description: >- + List all the plugins in a given project and location. `-` can be used as + wildcard value for {plugin_id} + operationId: apihub.projects.locations.plugins.instances.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApihubV1ListPluginInstancesResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: pluginsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/plugins/{pluginsId}/instances/{instancesId}:executeAction: + parameters: *ref_1 + post: + description: Executes a plugin instance in the API hub. + operationId: apihub.projects.locations.plugins.instances.executeAction + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApihubV1ExecutePluginInstanceActionRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: pluginsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/plugins/{pluginsId}/instances/{instancesId}: + parameters: *ref_1 + get: + description: Get an API Hub plugin instance. + operationId: apihub.projects.locations.plugins.instances.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1PluginInstance' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: pluginsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + patch: + description: >- + Updates a plugin instance in the API hub. The following fields in the + plugin_instance can be updated currently: * display_name * + schedule_cron_expression The update_mask should be used to specify the + fields being updated. To update the auth_config and additional_config of + the plugin instance, use the ApplyPluginInstanceConfig method. + operationId: apihub.projects.locations.plugins.instances.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1PluginInstance' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1PluginInstance' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: pluginsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a plugin instance in the API hub. + operationId: apihub.projects.locations.plugins.instances.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: pluginsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/plugins/{pluginsId}/instances/{instancesId}:enableAction: + parameters: *ref_1 + post: + description: Enables a plugin instance in the API hub. + operationId: apihub.projects.locations.plugins.instances.enableAction + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApihubV1EnablePluginInstanceActionRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: pluginsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/plugins/{pluginsId}/instances/{instancesId}:disableAction: + parameters: *ref_1 + post: + description: Disables a plugin instance in the API hub. + operationId: apihub.projects.locations.plugins.instances.disableAction + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApihubV1DisablePluginInstanceActionRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: pluginsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/plugins/{pluginsId}/styleGuide:contents: + parameters: *ref_1 + get: + description: Get the contents of the style guide. + operationId: apihub.projects.locations.plugins.styleGuide.getContents + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1StyleGuideContents' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: pluginsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/apis: + parameters: *ref_1 + post: + description: >- + Create an API resource in the API hub. Once an API resource is created, + versions can be added to it. + operationId: apihub.projects.locations.apis.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1Api' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1Api' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: apiId + schema: + type: string + get: + description: List API resources in the API hub. + operationId: apihub.projects.locations.apis.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1ListApisResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}: + parameters: *ref_1 + get: + description: Get API resource details including the API versions contained in it. + operationId: apihub.projects.locations.apis.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1Api' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: apisId + required: true + schema: + type: string + patch: + description: >- + Update an API resource in the API hub. The following fields in the API + can be updated: * display_name * description * owner * documentation * + target_user * team * business_unit * maturity_level * api_style * + attributes The update_mask should be used to specify the fields being + updated. Updating the owner field requires complete owner message and + updates both owner and email fields. + operationId: apihub.projects.locations.apis.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1Api' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1Api' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: apisId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: >- + Delete an API resource in the API hub. API can only be deleted if all + underlying versions are deleted. + operationId: apihub.projects.locations.apis.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: apisId + required: true + schema: + type: string + - in: query + name: force + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions: + parameters: *ref_1 + post: + description: Create an API version for an API resource in the API hub. + operationId: apihub.projects.locations.apis.versions.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1Version' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1Version' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: apisId + required: true + schema: + type: string + - in: query + name: versionId + schema: + type: string + get: + description: List API versions of an API resource in the API hub. + operationId: apihub.projects.locations.apis.versions.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1ListVersionsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: apisId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}: + parameters: *ref_1 + get: + description: >- + Get details about the API version of an API resource. This will include + information about the specs and operations present in the API version as + well as the deployments linked to it. + operationId: apihub.projects.locations.apis.versions.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1Version' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: apisId + required: true + schema: + type: string + - in: path + name: versionsId + required: true + schema: + type: string + patch: + description: >- + Update API version. The following fields in the version can be updated + currently: * display_name * description * documentation * deployments * + lifecycle * compliance * accreditation * attributes The update_mask + should be used to specify the fields being updated. + operationId: apihub.projects.locations.apis.versions.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1Version' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1Version' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: apisId + required: true + schema: + type: string + - in: path + name: versionsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: >- + Delete an API version. Version can only be deleted if all underlying + specs, operations, definitions and linked deployments are deleted. + operationId: apihub.projects.locations.apis.versions.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: apisId + required: true + schema: + type: string + - in: path + name: versionsId + required: true + schema: + type: string + - in: query + name: force + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs: + parameters: *ref_1 + post: + description: >- + Add a spec to an API version in the API hub. Multiple specs can be added + to an API version. Note, while adding a spec, at least one of `contents` + or `source_uri` must be provided. If `contents` is provided, then + `spec_type` must also be provided. On adding a spec with contents to the + version, the operations present in it will be added to the version.Note + that the file contents in the spec should be of the same type as defined + in the + `projects/{project}/locations/{location}/attributes/system-spec-type` + attribute associated with spec resource. Note that specs of various + types can be uploaded, however parsing of details is supported for + OpenAPI spec currently. In order to access the information parsed from + the spec, use the GetSpec method. In order to access the raw contents + for a particular spec, use the GetSpecContents method. In order to + access the operations parsed from the spec, use the ListAPIOperations + method. + operationId: apihub.projects.locations.apis.versions.specs.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1Spec' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1Spec' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: apisId + required: true + schema: + type: string + - in: path + name: versionsId + required: true + schema: + type: string + - in: query + name: specId + schema: + type: string + get: + description: List specs corresponding to a particular API resource. + operationId: apihub.projects.locations.apis.versions.specs.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1ListSpecsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: apisId + required: true + schema: + type: string + - in: path + name: versionsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}: + parameters: *ref_1 + get: + description: >- + Get details about the information parsed from a spec. Note that this + method does not return the raw spec contents. Use GetSpecContents method + to retrieve the same. + operationId: apihub.projects.locations.apis.versions.specs.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1Spec' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: apisId + required: true + schema: + type: string + - in: path + name: versionsId + required: true + schema: + type: string + - in: path + name: specsId + required: true + schema: + type: string + patch: + description: >- + Update spec. The following fields in the spec can be updated: * + display_name * source_uri * lint_response * attributes * contents * + spec_type In case of an OAS spec, updating spec contents can lead to: 1. + Creation, deletion and update of operations. 2. Creation, deletion and + update of definitions. 3. Update of other info parsed out from the new + spec. In case of contents or source_uri being present in update mask, + spec_type must also be present. Also, spec_type can not be present in + update mask if contents or source_uri is not present. The update_mask + should be used to specify the fields being updated. + operationId: apihub.projects.locations.apis.versions.specs.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1Spec' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1Spec' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: apisId + required: true + schema: + type: string + - in: path + name: versionsId + required: true + schema: + type: string + - in: path + name: specsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: >- + Delete a spec. Deleting a spec will also delete the associated + operations from the version. + operationId: apihub.projects.locations.apis.versions.specs.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: apisId + required: true + schema: + type: string + - in: path + name: versionsId + required: true + schema: + type: string + - in: path + name: specsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}:contents: + parameters: *ref_1 + get: + description: Get spec contents. + operationId: apihub.projects.locations.apis.versions.specs.getContents + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1SpecContents' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: apisId + required: true + schema: + type: string + - in: path + name: versionsId + required: true + schema: + type: string + - in: path + name: specsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}:lint: + parameters: *ref_1 + post: + description: >- + Lints the requested spec and updates the corresponding API Spec with the + lint response. This lint response will be available in all subsequent + Get and List Spec calls to Core service. + operationId: apihub.projects.locations.apis.versions.specs.lint + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1LintSpecRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: apisId + required: true + schema: + type: string + - in: path + name: versionsId + required: true + schema: + type: string + - in: path + name: specsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/operations: + parameters: *ref_1 + post: + description: >- + Create an apiOperation in an API version. An apiOperation can be created + only if the version has no apiOperations which were created by parsing a + spec. + operationId: apihub.projects.locations.apis.versions.operations.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1ApiOperation' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1ApiOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: apisId + required: true + schema: + type: string + - in: path + name: versionsId + required: true + schema: + type: string + - in: query + name: apiOperationId + schema: + type: string + get: + description: List operations in an API version. + operationId: apihub.projects.locations.apis.versions.operations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApihubV1ListApiOperationsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: apisId + required: true + schema: + type: string + - in: path + name: versionsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: Get details about a particular operation in API version. + operationId: apihub.projects.locations.apis.versions.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1ApiOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: apisId + required: true + schema: + type: string + - in: path + name: versionsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + patch: + description: >- + Update an operation in an API version. The following fields in the + ApiOperation resource can be updated: * details.description * + details.documentation * details.http_operation.path * + details.http_operation.method * details.deprecated * attributes The + update_mask should be used to specify the fields being updated. An + operation can be updated only if the operation was created via + CreateApiOperation API. If the operation was created by parsing the + spec, then it can be edited by updating the spec. + operationId: apihub.projects.locations.apis.versions.operations.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1ApiOperation' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1ApiOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: apisId + required: true + schema: + type: string + - in: path + name: versionsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: >- + Delete an operation in an API version and we can delete only the + operations created via create API. If the operation was created by + parsing the spec, then it can be deleted by editing or deleting the + spec. + operationId: apihub.projects.locations.apis.versions.operations.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: apisId + required: true + schema: + type: string + - in: path + name: versionsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/definitions/{definitionsId}: + parameters: *ref_1 + get: + description: Get details about a definition in an API version. + operationId: apihub.projects.locations.apis.versions.definitions.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1Definition' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: apisId + required: true + schema: + type: string + - in: path + name: versionsId + required: true + schema: + type: string + - in: path + name: definitionsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/deployments: + parameters: *ref_1 + post: + description: >- + Create a deployment resource in the API hub. Once a deployment resource + is created, it can be associated with API versions. + operationId: apihub.projects.locations.deployments.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1Deployment' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1Deployment' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: deploymentId + schema: + type: string + get: + description: List deployment resources in the API hub. + operationId: apihub.projects.locations.deployments.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApihubV1ListDeploymentsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}: + parameters: *ref_1 + get: + description: Get details about a deployment and the API versions linked to it. + operationId: apihub.projects.locations.deployments.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1Deployment' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: deploymentsId + required: true + schema: + type: string + patch: + description: >- + Update a deployment resource in the API hub. The following fields in the + deployment resource can be updated: * display_name * description * + documentation * deployment_type * resource_uri * endpoints * slo * + environment * attributes * source_project * source_environment * + management_url * source_uri The update_mask should be used to specify + the fields being updated. + operationId: apihub.projects.locations.deployments.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1Deployment' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1Deployment' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: deploymentsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Delete a deployment resource in the API hub. + operationId: apihub.projects.locations.deployments.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: deploymentsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/attributes: + parameters: *ref_1 + post: + description: >- + Create a user defined attribute. Certain pre defined attributes are + already created by the API hub. These attributes will have type as + `SYSTEM_DEFINED` and can be listed via ListAttributes method. Allowed + values for the same can be updated via UpdateAttribute method. + operationId: apihub.projects.locations.attributes.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1Attribute' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1Attribute' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: attributeId + schema: + type: string + get: + description: List all attributes. + operationId: apihub.projects.locations.attributes.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1ListAttributesResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/attributes/{attributesId}: + parameters: *ref_1 + get: + description: Get details about the attribute. + operationId: apihub.projects.locations.attributes.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1Attribute' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: attributesId + required: true + schema: + type: string + patch: + description: >- + Update the attribute. The following fields in the Attribute resource can + be updated: * display_name The display name can be updated for user + defined attributes only. * description The description can be updated + for user defined attributes only. * allowed_values To update the list of + allowed values, clients need to use the fetched list of allowed values + and add or remove values to or from the same list. The mutable allowed + values can be updated for both user defined and System defined + attributes. The immutable allowed values cannot be updated or deleted. + The updated list of allowed values cannot be empty. If an allowed value + that is already used by some resource's attribute is deleted, then the + association between the resource and the attribute value will also be + deleted. * cardinality The cardinality can be updated for user defined + attributes only. Cardinality can only be increased during an update. The + update_mask should be used to specify the fields being updated. + operationId: apihub.projects.locations.attributes.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1Attribute' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1Attribute' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: attributesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: >- + Delete an attribute. Note: System defined attributes cannot be deleted. + All associations of the attribute being deleted with any API hub + resource will also get deleted. + operationId: apihub.projects.locations.attributes.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: attributesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/externalApis: + parameters: *ref_1 + post: + description: Create an External API resource in the API hub. + operationId: apihub.projects.locations.externalApis.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1ExternalApi' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1ExternalApi' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: externalApiId + schema: + type: string + get: + description: List External API resources in the API hub. + operationId: apihub.projects.locations.externalApis.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApihubV1ListExternalApisResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/externalApis/{externalApisId}: + parameters: *ref_1 + get: + description: Get details about an External API resource in the API hub. + operationId: apihub.projects.locations.externalApis.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1ExternalApi' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: externalApisId + required: true + schema: + type: string + patch: + description: >- + Update an External API resource in the API hub. The following fields can + be updated: * display_name * description * documentation * endpoints * + paths The update_mask should be used to specify the fields being + updated. + operationId: apihub.projects.locations.externalApis.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1ExternalApi' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1ExternalApi' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: externalApisId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Delete an External API resource in the API hub. + operationId: apihub.projects.locations.externalApis.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: externalApisId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/dependencies: + parameters: *ref_1 + post: + description: Create a dependency between two entities in the API hub. + operationId: apihub.projects.locations.dependencies.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1Dependency' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1Dependency' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: dependencyId + schema: + type: string + get: + description: >- + List dependencies based on the provided filter and pagination + parameters. + operationId: apihub.projects.locations.dependencies.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApihubV1ListDependenciesResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/dependencies/{dependenciesId}: + parameters: *ref_1 + get: + description: Get details about a dependency resource in the API hub. + operationId: apihub.projects.locations.dependencies.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1Dependency' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: dependenciesId + required: true + schema: + type: string + patch: + description: >- + Update a dependency based on the update_mask provided in the request. + The following fields in the dependency can be updated: * description + operationId: apihub.projects.locations.dependencies.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1Dependency' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1Dependency' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: dependenciesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Delete the dependency resource. + operationId: apihub.projects.locations.dependencies.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: dependenciesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/curations: + parameters: *ref_1 + post: + description: >- + Create a curation resource in the API hub. Once a curation resource is + created, plugin instances can start using it. + operationId: apihub.projects.locations.curations.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1Curation' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1Curation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: curationId + schema: + type: string + get: + description: List curation resources in the API hub. + operationId: apihub.projects.locations.curations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1ListCurationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/curations/{curationsId}: + parameters: *ref_1 + get: + description: Get curation resource details. + operationId: apihub.projects.locations.curations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1Curation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: curationsId + required: true + schema: + type: string + patch: + description: >- + Update a curation resource in the API hub. The following fields in the + curation can be updated: * display_name * description The update_mask + should be used to specify the fields being updated. + operationId: apihub.projects.locations.curations.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1Curation' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1Curation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: curationsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: >- + Delete a curation resource in the API hub. A curation can only be + deleted if it's not being used by any plugin instance. + operationId: apihub.projects.locations.curations.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: curationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/discoveredApiObservations: + parameters: *ref_1 + get: + description: Lists all the DiscoveredAPIObservations in a given project and location. + operationId: apihub.projects.locations.discoveredApiObservations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApihubV1ListDiscoveredApiObservationsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/discoveredApiObservations/{discoveredApiObservationsId}: + parameters: *ref_1 + get: + description: >- + Gets a DiscoveredAPIObservation in a given project, location and + ApiObservation. + operationId: apihub.projects.locations.discoveredApiObservations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApihubV1DiscoveredApiObservation + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: discoveredApiObservationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/discoveredApiObservations/{discoveredApiObservationsId}/discoveredApiOperations: + parameters: *ref_1 + get: + description: >- + Lists all the DiscoveredAPIOperations in a given project, location and + ApiObservation. + operationId: >- + apihub.projects.locations.discoveredApiObservations.discoveredApiOperations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApihubV1ListDiscoveredApiOperationsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: discoveredApiObservationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/discoveredApiObservations/{discoveredApiObservationsId}/discoveredApiOperations/{discoveredApiOperationsId}: + parameters: *ref_1 + get: + description: >- + Gets a DiscoveredAPIOperation in a given project, location, + ApiObservation and ApiOperation. + operationId: >- + apihub.projects.locations.discoveredApiObservations.discoveredApiOperations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1DiscoveredApiOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: discoveredApiObservationsId + required: true + schema: + type: string + - in: path + name: discoveredApiOperationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/hostProjectRegistrations: + parameters: *ref_1 + post: + description: >- + Create a host project registration. A Google cloud project can be + registered as a host project if it is not attached as a runtime project + to another host project. A project can be registered as a host project + only once. Subsequent register calls for the same project will fail. + operationId: apihub.projects.locations.hostProjectRegistrations.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1HostProjectRegistration' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApihubV1HostProjectRegistration + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: hostProjectRegistrationId + schema: + type: string + get: + description: Lists host project registrations. + operationId: apihub.projects.locations.hostProjectRegistrations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApihubV1ListHostProjectRegistrationsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/hostProjectRegistrations/{hostProjectRegistrationsId}: + parameters: *ref_1 + get: + description: Get a host project registration. + operationId: apihub.projects.locations.hostProjectRegistrations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApihubV1HostProjectRegistration + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: hostProjectRegistrationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/apiHubInstances: + parameters: *ref_1 + post: + description: Provisions instance resources for the API Hub. + operationId: apihub.projects.locations.apiHubInstances.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1ApiHubInstance' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: apiHubInstanceId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/apiHubInstances/{apiHubInstancesId}: + parameters: *ref_1 + delete: + description: Deletes the API hub instance. + operationId: apihub.projects.locations.apiHubInstances.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: apiHubInstancesId + required: true + schema: + type: string + get: + description: Gets details of a single API Hub instance. + operationId: apihub.projects.locations.apiHubInstances.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1ApiHubInstance' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: apiHubInstancesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/apiHubInstances:lookup: + parameters: *ref_1 + get: + description: >- + Looks up an Api Hub instance in a given GCP project. There will always + be only one Api Hub instance for a GCP project across all locations. + operationId: apihub.projects.locations.apiHubInstances.lookup + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApihubV1LookupApiHubInstanceResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/runtimeProjectAttachments: + parameters: *ref_1 + post: + description: Attaches a runtime project to the host project. + operationId: apihub.projects.locations.runtimeProjectAttachments.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApihubV1RuntimeProjectAttachment' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApihubV1RuntimeProjectAttachment + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: runtimeProjectAttachmentId + schema: + type: string + get: + description: List runtime projects attached to the host project. + operationId: apihub.projects.locations.runtimeProjectAttachments.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApihubV1ListRuntimeProjectAttachmentsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/runtimeProjectAttachments/{runtimeProjectAttachmentsId}: + parameters: *ref_1 + get: + description: Gets a runtime project attachment. + operationId: apihub.projects.locations.runtimeProjectAttachments.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApihubV1RuntimeProjectAttachment + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: runtimeProjectAttachmentsId + required: true + schema: + type: string + delete: + description: >- + Delete a runtime project attachment in the API Hub. This call will + detach the runtime project from the host project. + operationId: apihub.projects.locations.runtimeProjectAttachments.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: runtimeProjectAttachmentsId + required: true + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/apikeys.yaml b/providers/src/googleapis.com/v00.00.00000/services/apikeys.yaml index 1445d052..b94514e8 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/apikeys.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/apikeys.yaml @@ -7,8 +7,8 @@ info: title: API Keys API description: Manages the API keys associated with developer projects. version: v2 - x-discovery-doc-revision: '20241025' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250619' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/api-keys/docs servers: @@ -22,12 +22,12 @@ components: implicit: authorizationUrl: https://accounts.google.com/o/oauth2/auth scopes: &ref_0 - https://www.googleapis.com/auth/cloud-platform.read-only: >- - View your data across Google Cloud services and see the email - address of your Google Account https://www.googleapis.com/auth/cloud-platform: >- See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. + https://www.googleapis.com/auth/cloud-platform.read-only: >- + View your data across Google Cloud services and see the email + address of your Google Account Oauth2c: type: oauth2 description: Oauth 2.0 authorization code authentication @@ -41,101 +41,219 @@ components: id: V2BrowserKeyRestrictions properties: allowedReferrers: + type: array items: type: string description: >- A list of regular expressions for the referrer URLs that are allowed to make API calls with this key. + description: The HTTP referrers (websites) that are allowed to use the key. + type: object + V2IosKeyRestrictions: + id: V2IosKeyRestrictions + type: object + description: The iOS apps that are allowed to use the key. + properties: + allowedBundleIds: + items: + type: string type: array + description: >- + A list of bundle IDs that are allowed when making API calls with + this key. + V2Key: + description: The representation of a key managed by the API Keys API. + properties: + deleteTime: + description: >- + Output only. A timestamp when this key was deleted. If the resource + is not deleted, this must be empty. + format: google-datetime + readOnly: true + type: string + updateTime: + readOnly: true + description: >- + Output only. A timestamp identifying the time this key was last + updated. + type: string + format: google-datetime + serviceAccountEmail: + description: >- + Optional. The email address of [the service + account](https://cloud.google.com/iam/docs/service-accounts) the key + is bound to. + type: string + name: + readOnly: true + description: >- + Output only. The resource name of the key. The `name` has the form: + `projects//locations/global/keys/`. For example: + `projects/123456867718/locations/global/keys/b7ff1f9f-8275-410a-94dd-3855ee9b5dd2` + NOTE: Key is a global resource; hence the only supported value for + location is `global`. + type: string + annotations: + additionalProperties: + type: string + description: >- + Annotations is an unstructured key-value map stored with a policy + that may be set by external tools to store and retrieve arbitrary + metadata. They are not queryable and should be preserved when + modifying objects. + type: object + keyString: + type: string + readOnly: true + description: >- + Output only. An encrypted and signed value held by this key. This + field can be accessed only through the `GetKeyString` method. + restrictions: + description: Key restrictions. + $ref: '#/components/schemas/V2Restrictions' + createTime: + type: string + description: >- + Output only. A timestamp identifying the time this key was + originally created. + format: google-datetime + readOnly: true + uid: + description: Output only. Unique id in UUID4 format. + readOnly: true + type: string + etag: + description: >- + Output only. A checksum computed by the server based on the current + value of the Key resource. This may be sent on update and delete + requests to ensure the client has an up-to-date value before + proceeding. See https://google.aip.dev/154. + type: string + readOnly: true + displayName: + type: string + description: >- + Human-readable display name of this key that you can modify. The + maximum length is 63 characters. type: object - description: The HTTP referrers (websites) that are allowed to use the key. + id: V2Key V2GetKeyStringResponse: - id: V2GetKeyStringResponse description: Response message for `GetKeyString` method. type: object + id: V2GetKeyStringResponse properties: keyString: description: An encrypted and signed value of the key. type: string - V2ListKeysResponse: - description: Response message for `ListKeys` method. - type: object + V2LookupKeyResponse: + description: Response message for `LookupKey` method. + id: V2LookupKeyResponse properties: - nextPageToken: - description: The pagination token for the next page of results. + name: + description: >- + The resource name of the API key. If the API key has been purged, + resource name is empty. type: string - keys: + parent: + type: string + description: >- + The project that owns the key with the value specified in the + request. + type: object + V2AndroidKeyRestrictions: + id: V2AndroidKeyRestrictions + type: object + properties: + allowedApplications: type: array items: - $ref: '#/components/schemas/V2Key' - description: A list of API keys. - id: V2ListKeysResponse + $ref: '#/components/schemas/V2AndroidApplication' + description: >- + A list of Android applications that are allowed to make API calls + with this key. + description: The Android apps that are allowed to use the key. + Status: + type: object + properties: + message: + type: string + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + details: + items: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + type: array + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + code: + format: int32 + description: The status code, which should be an enum value of google.rpc.Code. + type: integer + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + id: Status + V2UndeleteKeyRequest: + type: object + description: Request message for `UndeleteKey` method. + id: V2UndeleteKeyRequest + properties: {} V2Restrictions: + id: V2Restrictions + description: Describes the restrictions on the key. + type: object properties: serverKeyRestrictions: - description: The IP addresses of callers that are allowed to use the key. $ref: '#/components/schemas/V2ServerKeyRestrictions' - browserKeyRestrictions: - $ref: '#/components/schemas/V2BrowserKeyRestrictions' - description: The HTTP referrers (websites) that are allowed to use the key. + description: The IP addresses of callers that are allowed to use the key. + iosKeyRestrictions: + $ref: '#/components/schemas/V2IosKeyRestrictions' + description: The iOS apps that are allowed to use the key. androidKeyRestrictions: $ref: '#/components/schemas/V2AndroidKeyRestrictions' description: The Android apps that are allowed to use the key. + browserKeyRestrictions: + description: The HTTP referrers (websites) that are allowed to use the key. + $ref: '#/components/schemas/V2BrowserKeyRestrictions' apiTargets: - type: array description: >- A restriction for a specific service and optionally one or more specific methods. Requests are allowed if they match any of these restrictions. If no restrictions are specified, all targets are allowed. - items: - $ref: '#/components/schemas/V2ApiTarget' - iosKeyRestrictions: - $ref: '#/components/schemas/V2IosKeyRestrictions' - description: The iOS apps that are allowed to use the key. - type: object - id: V2Restrictions - description: Describes the restrictions on the key. - V2IosKeyRestrictions: - properties: - allowedBundleIds: - description: >- - A list of bundle IDs that are allowed when making API calls with - this key. type: array items: - type: string - id: V2IosKeyRestrictions - type: object - description: The iOS apps that are allowed to use the key. + $ref: '#/components/schemas/V2ApiTarget' Operation: id: Operation properties: + error: + $ref: '#/components/schemas/Status' + description: >- + The error result of the operation in case of failure or + cancellation. name: - type: string description: >- The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. - metadata: - type: object - description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. + type: string + response: additionalProperties: - type: any description: Properties of the object. Contains field @type with type URL. - error: - description: >- - The error result of the operation in case of failure or - cancellation. - $ref: '#/components/schemas/Status' - response: - type: object + type: any description: >- The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is @@ -145,9 +263,18 @@ components: where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + type: object + metadata: + type: object additionalProperties: type: any description: Properties of the object. Contains field @type with type URL. + description: >- + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. done: description: >- If the value is `false`, it means the operation is still in @@ -158,231 +285,89 @@ components: description: >- This resource represents a long-running operation that is the result of a network API call. - V2UndeleteKeyRequest: + V2AndroidApplication: + description: Identifier of an Android application for key use. type: object - id: V2UndeleteKeyRequest - description: Request message for `UndeleteKey` method. - properties: {} - V2ApiTarget: + id: V2AndroidApplication properties: - service: - description: >- - The service for this restriction. It should be the canonical service - name, for example: `translate.googleapis.com`. You can use [`gcloud - services - list`](https://cloud.google.com/sdk/gcloud/reference/services/list) - to get a list of services that are enabled in the project. + packageName: + description: The package name of the application. type: string - methods: - items: - type: string + sha1Fingerprint: description: >- - Optional. List of one or more methods that can be called. If empty, - all methods for the service are allowed. A wildcard (*) can be used - as the last symbol. Valid examples: - `google.cloud.translate.v2.TranslateService.GetSupportedLanguage` - `TranslateText` `Get*` `translate.googleapis.com.Get*` - type: array - type: object + The SHA1 fingerprint of the application. For example, both sha1 + formats are acceptable : + DA:39:A3:EE:5E:6B:4B:0D:32:55:BF:EF:95:60:18:90:AF:D8:07:09 or + DA39A3EE5E6B4B0D3255BFEF95601890AFD80709. Output format is the + latter. + type: string + V2ApiTarget: description: >- A restriction for a specific service and optionally one or multiple specific methods. Both fields are case insensitive. - id: V2ApiTarget - Status: - id: Status - type: object properties: - details: - type: array + service: description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - items: - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - code: - description: The status code, which should be an enum value of google.rpc.Code. - format: int32 - type: integer - message: + The service for this restriction. It should be the canonical service + name, for example: `translate.googleapis.com`. You can use [`gcloud + services + list`](https://cloud.google.com/sdk/gcloud/reference/services/list) + to get a list of services that are enabled in the project. type: string - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - V2AndroidKeyRestrictions: - description: The Android apps that are allowed to use the key. - id: V2AndroidKeyRestrictions - properties: - allowedApplications: - description: >- - A list of Android applications that are allowed to make API calls - with this key. - type: array + methods: items: - $ref: '#/components/schemas/V2AndroidApplication' - type: object - V2Key: - description: The representation of a key managed by the API Keys API. - type: object - properties: - etag: - readOnly: true - type: string - description: >- - Output only. A checksum computed by the server based on the current - value of the Key resource. This may be sent on update and delete - requests to ensure the client has an up-to-date value before - proceeding. See https://google.aip.dev/154. - keyString: - type: string - readOnly: true - description: >- - Output only. An encrypted and signed value held by this key. This - field can be accessed only through the `GetKeyString` method. - displayName: - description: >- - Human-readable display name of this key that you can modify. The - maximum length is 63 characters. - type: string - annotations: - type: object - additionalProperties: type: string + type: array description: >- - Annotations is an unstructured key-value map stored with a policy - that may be set by external tools to store and retrieve arbitrary - metadata. They are not queryable and should be preserved when - modifying objects. - createTime: - format: google-datetime - type: string - readOnly: true - description: >- - Output only. A timestamp identifying the time this key was - originally created. - restrictions: - $ref: '#/components/schemas/V2Restrictions' - description: Key restrictions. - serviceAccountEmail: - description: >- - Optional. The email address of [the service - account](https://cloud.google.com/iam/docs/service-accounts) the key - is bound to. - type: string - uid: - description: Output only. Unique id in UUID4 format. - readOnly: true - type: string - name: - readOnly: true - description: >- - Output only. The resource name of the key. The `name` has the form: - `projects//locations/global/keys/`. For example: - `projects/123456867718/locations/global/keys/b7ff1f9f-8275-410a-94dd-3855ee9b5dd2` - NOTE: Key is a global resource; hence the only supported value for - location is `global`. - type: string - deleteTime: - type: string - description: >- - Output only. A timestamp when this key was deleted. If the resource - is not deleted, this must be empty. - readOnly: true - format: google-datetime - updateTime: - readOnly: true - description: >- - Output only. A timestamp identifying the time this key was last - updated. - type: string - format: google-datetime - id: V2Key + Optional. List of one or more methods that can be called. If empty, + all methods for the service are allowed. A wildcard (*) can be used + as the last symbol. Valid examples: + `google.cloud.translate.v2.TranslateService.GetSupportedLanguage` + `TranslateText` `Get*` `translate.googleapis.com.Get*` + type: object + id: V2ApiTarget V2ServerKeyRestrictions: + description: The IP addresses of callers that are allowed to use the key. id: V2ServerKeyRestrictions properties: allowedIps: + items: + type: string + type: array description: >- A list of the caller IP addresses that are allowed to make API calls with this key. - type: array - items: - type: string type: object - description: The IP addresses of callers that are allowed to use the key. - V2LookupKeyResponse: - id: V2LookupKeyResponse + V2ListKeysResponse: + id: V2ListKeysResponse type: object - description: Response message for `LookupKey` method. properties: - name: - type: string - description: >- - The resource name of the API key. If the API key has been purged, - resource name is empty. - parent: - type: string - description: >- - The project that owns the key with the value specified in the - request. - V2AndroidApplication: - id: V2AndroidApplication - properties: - packageName: - description: The package name of the application. - type: string - sha1Fingerprint: - description: >- - The SHA1 fingerprint of the application. For example, both sha1 - formats are acceptable : - DA:39:A3:EE:5E:6B:4B:0D:32:55:BF:EF:95:60:18:90:AF:D8:07:09 or - DA39A3EE5E6B4B0D3255BFEF95601890AFD80709. Output format is the - latter. + keys: + type: array + items: + $ref: '#/components/schemas/V2Key' + description: A list of API keys. + nextPageToken: + description: The pagination token for the next page of results. type: string - type: object - description: Identifier of an Android application for key use. + description: Response message for `ListKeys` method. parameters: - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - type: string - _.xgafv: - description: V1 error format. + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: $.xgafv + name: upload_protocol schema: type: string - enum: - - '1' - - '2' uploadType: description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query name: uploadType schema: type: string - oauth_token: - description: OAuth 2.0 token for the current user. - in: query - name: oauth_token - schema: - type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: upload_protocol + name: fields schema: type: string access_token: @@ -397,22 +382,30 @@ components: name: callback schema: type: string - alt: - description: Data format for response. - in: query - name: alt - schema: - type: string - enum: - - json - - media - - proto prettyPrint: description: Returns response with indentations and line breaks. in: query name: prettyPrint schema: type: boolean + 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 + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' quotaUser: description: >- Available to use for quota purposes for server-side applications. Can be @@ -422,59 +415,46 @@ components: name: quotaUser 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. + alt: + description: Data format for response. in: query - name: key + name: alt schema: type: string - x-stackQL-resources: - keys_key_string: - id: google.apikeys.keys_key_string - name: keys_key_string - title: Keys_key_string - methods: - get_key_string: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1keys~1{keysId}~1keyString/get - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/keys_key_string/methods/get_key_string - insert: [] - update: [] - replace: [] - delete: [] + enum: + - json + - media + - proto + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token + schema: + type: string + x-stackQL-resources: keys: id: google.apikeys.keys name: keys title: Keys methods: - get: + lookup_key: operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1keys~1{keysId}/get + $ref: '#/paths/~1v2~1keys:lookupKey/get' response: mediaType: application/json openAPIDocKey: '200' - patch: + list: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1keys~1{keysId}/patch + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1keys/get response: mediaType: application/json openAPIDocKey: '200' - delete: + objectKey: $.keys + create: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1keys~1{keysId}/delete + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1keys/post response: mediaType: application/json openAPIDocKey: '200' @@ -485,24 +465,24 @@ components: response: mediaType: application/json openAPIDocKey: '200' - create: + get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1keys/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1keys~1{keysId}/get response: mediaType: application/json openAPIDocKey: '200' - list: + delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1keys/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1keys~1{keysId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.keys - lookup_key: + patch: operation: - $ref: '#/paths/~1v2~1keys:lookupKey/get' + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1keys~1{keysId}/patch response: mediaType: application/json openAPIDocKey: '200' @@ -517,6 +497,26 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/keys/methods/delete' + key_strings: + id: google.apikeys.key_strings + name: key_strings + title: Key_strings + methods: + get_key_string: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1keys~1{keysId}~1keyString/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/key_strings/methods/get_key_string + insert: [] + update: [] + replace: [] + delete: [] operations: id: google.apikeys.operations name: operations @@ -536,24 +536,26 @@ components: replace: [] delete: [] paths: - /v2/projects/{projectsId}/locations/{locationsId}/keys/{keysId}/keyString: + /v2/keys:lookupKey: parameters: &ref_1 - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/oauth_token' get: description: >- - Get the key string for an API key. NOTE: Key is a global resource; hence - the only supported value for location is `global`. - operationId: apikeys.projects.locations.keys.getKeyString + Find the parent project and resource name of the API key that matches + the key string in the request. If the API key has been purged, resource + name will not be set. The service account must have the + `apikeys.keys.lookup` permission on the parent project. + operationId: apikeys.keys.lookupKey security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -569,31 +571,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/V2GetKeyStringResponse' + $ref: '#/components/schemas/V2LookupKeyResponse' parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: keysId - required: true + - in: query + name: keyString schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/keys/{keysId}: + /v2/projects/{projectsId}/locations/{locationsId}/keys: parameters: *ref_1 get: description: >- - Gets the metadata for an API key. The key string of the API key isn't - included in the response. NOTE: Key is a global resource; hence the only - supported value for location is `global`. - operationId: apikeys.projects.locations.keys.get + Lists the API keys owned by a project. The key string of the API key + isn't included in the response. NOTE: Key is a global resource; hence + the only supported value for location is `global`. + operationId: apikeys.projects.locations.keys.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -609,7 +600,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/V2Key' + $ref: '#/components/schemas/V2ListKeysResponse' parameters: - in: path name: projectsId @@ -621,17 +612,24 @@ paths: required: true schema: type: string - - in: path - name: keysId - required: true + - in: query + name: pageToken schema: type: string - patch: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: showDeleted + schema: + type: boolean + post: description: >- - Patches the modifiable fields of an API key. The key string of the API - key isn't included in the response. NOTE: Key is a global resource; - hence the only supported value for location is `global`. - operationId: apikeys.projects.locations.keys.patch + Creates a new API key. NOTE: Key is a global resource; hence the only + supported value for location is `global`. + operationId: apikeys.projects.locations.keys.create requestBody: content: application/json: @@ -660,23 +658,23 @@ paths: required: true schema: type: string - - in: path - name: keysId - required: true - schema: - type: string - in: query - name: updateMask + name: keyId schema: type: string - format: google-fieldmask - delete: + /v2/projects/{projectsId}/locations/{locationsId}/keys/{keysId}:undelete: + parameters: *ref_1 + post: description: >- - Deletes an API key. Deleted key can be retrieved within 30 days of - deletion. Afterward, key will be purged from the project. NOTE: Key is a + Undeletes an API key which was deleted within 30 days. NOTE: Key is a global resource; hence the only supported value for location is `global`. - operationId: apikeys.projects.locations.keys.delete + operationId: apikeys.projects.locations.keys.undelete + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/V2UndeleteKeyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -705,35 +703,30 @@ paths: required: true schema: type: string - - in: query - name: etag - schema: - type: string - /v2/projects/{projectsId}/locations/{locationsId}/keys/{keysId}:undelete: + /v2/projects/{projectsId}/locations/{locationsId}/keys/{keysId}: parameters: *ref_1 - post: + get: description: >- - Undeletes an API key which was deleted within 30 days. NOTE: Key is a - global resource; hence the only supported value for location is - `global`. - operationId: apikeys.projects.locations.keys.undelete - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/V2UndeleteKeyRequest' + Gets the metadata for an API key. The key string of the API key isn't + included in the response. NOTE: Key is a global resource; hence the only + supported value for location is `global`. + operationId: apikeys.projects.locations.keys.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/V2Key' parameters: - in: path name: projectsId @@ -750,18 +743,13 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/keys: - parameters: *ref_1 - post: + delete: description: >- - Creates a new API key. NOTE: Key is a global resource; hence the only - supported value for location is `global`. - operationId: apikeys.projects.locations.keys.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/V2Key' + Deletes an API key. Deleted key can be retrieved within 30 days of + deletion. Afterward, key will be purged from the project. NOTE: Key is a + global resource; hence the only supported value for location is + `global`. + operationId: apikeys.projects.locations.keys.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -785,32 +773,38 @@ paths: required: true schema: type: string + - in: path + name: keysId + required: true + schema: + type: string - in: query - name: keyId + name: etag schema: type: string - get: + patch: description: >- - Lists the API keys owned by a project. The key string of the API key - isn't included in the response. NOTE: Key is a global resource; hence - the only supported value for location is `global`. - operationId: apikeys.projects.locations.keys.list + Patches the modifiable fields of an API key. The key string of the API + key isn't included in the response. NOTE: Key is a global resource; + hence the only supported value for location is `global`. + operationId: apikeys.projects.locations.keys.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/V2Key' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/V2ListKeysResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -822,28 +816,23 @@ paths: required: true schema: type: string - - in: query - name: showDeleted - schema: - type: boolean - - in: query - name: pageSize + - in: path + name: keysId + required: true schema: - type: integer - format: int32 + type: string - in: query - name: pageToken + name: updateMask schema: type: string - /v2/keys:lookupKey: + format: google-fieldmask + /v2/projects/{projectsId}/locations/{locationsId}/keys/{keysId}/keyString: parameters: *ref_1 get: description: >- - Find the parent project and resource name of the API key that matches - the key string in the request. If the API key has been purged, resource - name will not be set. The service account must have the - `apikeys.keys.lookup` permission on the parent project. - operationId: apikeys.keys.lookupKey + Get the key string for an API key. NOTE: Key is a global resource; hence + the only supported value for location is `global`. + operationId: apikeys.projects.locations.keys.getKeyString security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -859,10 +848,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/V2LookupKeyResponse' + $ref: '#/components/schemas/V2GetKeyStringResponse' parameters: - - in: query - name: keyString + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: keysId + required: true schema: type: string /v2/operations/{operationsId}: diff --git a/providers/src/googleapis.com/v00.00.00000/services/apim.yaml b/providers/src/googleapis.com/v00.00.00000/services/apim.yaml index 239eb48a..0b63ce65 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/apim.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/apim.yaml @@ -9,8 +9,8 @@ info: Enables users to discover shadow APIs in existing Google Cloud infrastructure. version: v1alpha - x-discovery-doc-revision: '20240731' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250820' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/apigee/ servers: @@ -662,6 +662,37 @@ components: A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. type: string + Entitlement: + id: Entitlement + description: >- + Entitlement stores data related to API Observation entitlement for a + given project + type: object + properties: + name: + description: >- + Identifier. The entitlement resource name + `projects/{project}/locations/{location}/entitlement` + type: string + billingProjectNumber: + description: >- + Project number of associated billing project that has Apigee and + Advanced API Security entitled. + type: string + format: int64 + apiObservationEntitled: + description: Whether API Observation is entitled. + type: boolean + createTime: + description: Output only. The time of the entitlement creation. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. The time of the entitlement update. + readOnly: true + type: string + format: google-datetime ListLocationsResponse: id: ListLocationsResponse description: The response message for Locations.ListLocations. @@ -854,6 +885,26 @@ components: update: [] replace: [] delete: [] + entitlements: + id: google.apim.entitlements + name: entitlements + title: Entitlements + methods: + get_entitlement: + operation: + $ref: >- + #/paths/~1v1alpha~1projects~1{projectsId}~1locations~1{locationsId}~1entitlement/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/entitlements/methods/get_entitlement + insert: [] + update: [] + replace: [] + delete: [] locations: id: google.apim.locations name: locations @@ -1142,6 +1193,34 @@ paths: name: pageToken schema: type: string + /v1alpha/projects/{projectsId}/locations/{locationsId}/entitlement: + parameters: *ref_1 + get: + description: GetEntitlement returns the entitlement for the provided project. + operationId: apim.projects.locations.getEntitlement + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Entitlement' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string /v1alpha/projects/{projectsId}/locations: parameters: *ref_1 get: @@ -1178,6 +1257,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v1alpha/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: @@ -1332,7 +1415,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: apim.projects.locations.operations.cancel requestBody: content: diff --git a/providers/src/googleapis.com/v00.00.00000/services/appengine.yaml b/providers/src/googleapis.com/v00.00.00000/services/appengine.yaml index 639e4927..c923005d 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/appengine.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/appengine.yaml @@ -7,8 +7,8 @@ info: title: App Engine Admin API description: Provisions and manages developers' App Engine applications. version: v1 - x-discovery-doc-revision: '20241028' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250824' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/appengine/docs/admin-api/ servers: @@ -142,9 +142,6 @@ components: type: object properties: name: - description: >- - Output only. Full path to the Application resource in the API. - Example: apps/myapp.@OutputOnly readOnly: true type: string id: @@ -253,6 +250,24 @@ components: additionalProperties: type: any description: Properties of the object. Contains field @type with type URL. + sslPolicy: + description: >- + The SSL policy that will be applied to the application. If set to + Modern it will restrict traffic with TLS < 1.2 and allow only Modern + Ciphers suite + type: string + enumDescriptions: + - Required by linter. Will work same as DEFAULT + - >- + DEFAULT is to allow all TLS versions and cipher suites supported + by App Engine + - >- + MODERN is to allow only TLS 1.2 and TLS 1.3 along with Modern + cipher suites only + enum: + - SSL_POLICY_UNSPECIFIED + - DEFAULT + - MODERN UrlDispatchRule: id: UrlDispatchRule description: Rules to match an HTTP request and dispatch that request to a service. @@ -1047,8 +1062,8 @@ components: format: int32 maxInstances: description: >- - Maximum number of instances to run for this version. Set to zero to - disable max_instances configuration. + Maximum number of instances to run for this version. Set to + 2147483647 to disable max_instances configuration. type: integer format: int32 BasicScaling: @@ -1985,16 +2000,15 @@ components: id: FirewallRule description: >- A single firewall rule that is evaluated against incoming traffic and - provides an action to take on matched requests. + provides an action to take on matched requests. A positive integer + between 1, Int32.MaxValue-1 that defines the order of rule evaluation. + Rules with the lowest priority are evaluated first.A default rule at + priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no + previous rule matches. Only the action of this rule can be modified by + the user. type: object properties: priority: - description: >- - A positive integer between 1, Int32.MaxValue-1 that defines the - order of rule evaluation. Rules with the lowest priority are - evaluated first.A default rule at priority Int32.MaxValue matches - all IPv4 and IPv6 traffic when no previous rule matches. Only the - action of this rule can be modified by the user. type: integer format: int32 action: @@ -2315,7 +2329,7 @@ components: - >- SSL support for this domain is configured manually by the user. Either the domain has no SSL support or a user-obtained SSL - certificate has been explictly mapped to this domain. + certificate has been explicitly mapped to this domain. enum: - SSL_MANAGEMENT_TYPE_UNSPECIFIED - AUTOMATIC @@ -2952,6 +2966,26 @@ components: - SERVICE_ACTIVATION_DISABLED - SERVICE_ACTIVATION_DISABLED_FULL - SERVICE_ACTIVATION_UNKNOWN_REASON + ResourceEvent: + id: ResourceEvent + description: >- + The request that is passed to CLH during per-resource events. The + request will be sent with update semantics in all cases except for data + governance purge events. These events will be sent with delete semantics + and the CLH is expected to delete the resource receiving this event. + type: object + properties: + name: + description: The name of the resource for which this event is. required + type: string + eventId: + description: >- + The unique ID for this per-resource event. CLHs can use this value + to dedup repeated calls. required + type: string + state: + description: The state of the project that led to this event. + $ref: '#/components/schemas/ContainerState' parameters: access_token: description: OAuth access token. @@ -3046,7 +3080,8 @@ components: openAPIDocKey: '200' patch: operation: - $ref: '#/paths/~1v1~1apps~1{appsId}/patch' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1applications~1{applicationsId}/patch response: mediaType: application/json openAPIDocKey: '200' @@ -3071,10 +3106,10 @@ components: - $ref: '#/components/x-stackQL-resources/apps/methods/patch' replace: [] delete: [] - apps_runtimes: - id: google.appengine.apps_runtimes - name: apps_runtimes - title: Apps_runtimes + runtimes: + id: google.appengine.runtimes + name: runtimes + title: Runtimes methods: list_runtimes: operation: @@ -3085,8 +3120,7 @@ components: objectKey: $.runtimes sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/apps_runtimes/methods/list_runtimes + - $ref: '#/components/x-stackQL-resources/runtimes/methods/list_runtimes' insert: [] update: [] replace: [] @@ -3137,13 +3171,15 @@ components: openAPIDocKey: '200' patch: operation: - $ref: '#/paths/~1v1~1apps~1{appsId}~1services~1{servicesId}/patch' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1applications~1{applicationsId}~1services~1{servicesId}/patch response: mediaType: application/json openAPIDocKey: '200' delete: operation: - $ref: '#/paths/~1v1~1apps~1{appsId}~1services~1{servicesId}/delete' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1applications~1{applicationsId}~1services~1{servicesId}/delete response: mediaType: application/json openAPIDocKey: '200' @@ -3186,7 +3222,7 @@ components: patch: operation: $ref: >- - #/paths/~1v1~1apps~1{appsId}~1services~1{servicesId}~1versions~1{versionsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1applications~1{applicationsId}~1services~1{servicesId}~1versions~1{versionsId}/patch response: mediaType: application/json openAPIDocKey: '200' @@ -3337,35 +3373,37 @@ components: methods: list: operation: - $ref: '#/paths/~1v1~1apps~1{appsId}~1authorizedCertificates/get' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1applications~1{applicationsId}~1authorizedCertificates/get response: mediaType: application/json openAPIDocKey: '200' objectKey: $.certificates create: operation: - $ref: '#/paths/~1v1~1apps~1{appsId}~1authorizedCertificates/post' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1applications~1{applicationsId}~1authorizedCertificates/post response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1v1~1apps~1{appsId}~1authorizedCertificates~1{authorizedCertificatesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1applications~1{applicationsId}~1authorizedCertificates~1{authorizedCertificatesId}/get response: mediaType: application/json openAPIDocKey: '200' patch: operation: $ref: >- - #/paths/~1v1~1apps~1{appsId}~1authorizedCertificates~1{authorizedCertificatesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1applications~1{applicationsId}~1authorizedCertificates~1{authorizedCertificatesId}/patch response: mediaType: application/json openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1v1~1apps~1{appsId}~1authorizedCertificates~1{authorizedCertificatesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1applications~1{applicationsId}~1authorizedCertificates~1{authorizedCertificatesId}/delete response: mediaType: application/json openAPIDocKey: '200' @@ -3399,14 +3437,15 @@ components: objectKey: $.domainMappings create: operation: - $ref: '#/paths/~1v1~1apps~1{appsId}~1domainMappings/post' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1applications~1{applicationsId}~1domainMappings/post response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1v1~1apps~1{appsId}~1domainMappings~1{domainMappingsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1applications~1{applicationsId}~1domainMappings~1{domainMappingsId}/get response: mediaType: application/json openAPIDocKey: '200' @@ -4943,6 +4982,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v1/apps/{appsId}/locations/{locationsId}: parameters: *ref_1 get: @@ -4979,8 +5022,229 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}: + parameters: *ref_1 + patch: + description: >- + Updates the specified Application resource. You can update the following + fields: auth_domain - Google authentication domain for controlling user + access to the application. default_cookie_expiration - Cookie expiration + policy for the application. iap - Identity-Aware Proxy properties for + the application. + operationId: appengine.projects.locations.applications.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Application' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: applicationsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services/{servicesId}: + parameters: *ref_1 + patch: + description: Updates the configuration of the specified service. + operationId: appengine.projects.locations.applications.services.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Service' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: applicationsId + required: true + schema: + type: string + - in: path + name: servicesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: migrateTraffic + schema: + type: boolean + delete: + description: Deletes the specified service and all enclosed versions. + operationId: appengine.projects.locations.applications.services.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: applicationsId + required: true + schema: + type: string + - in: path + name: servicesId + required: true + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services/{servicesId}/versions/{versionsId}: parameters: *ref_1 + patch: + description: >- + Updates the specified Version resource. You can specify the following + fields depending on the App Engine environment and type of scaling that + the version resource uses:Standard environment instance_class + (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.instance_class)automatic + scaling in the standard environment: + automatic_scaling.min_idle_instances + (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) + automatic_scaling.max_idle_instances + (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) + automaticScaling.standard_scheduler_settings.max_instances + (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) + automaticScaling.standard_scheduler_settings.min_instances + (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) + automaticScaling.standard_scheduler_settings.target_cpu_utilization + (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) + automaticScaling.standard_scheduler_settings.target_throughput_utilization + (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings)basic + scaling or manual scaling in the standard environment: serving_status + (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status) + manual_scaling.instances + (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#manualscaling)Flexible + environment serving_status + (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status)automatic + scaling in the flexible environment: + automatic_scaling.min_total_instances + (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) + automatic_scaling.max_total_instances + (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) + automatic_scaling.cool_down_period_sec + (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) + automatic_scaling.cpu_utilization.target_utilization + (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling)manual + scaling in the flexible environment: manual_scaling.instances + (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#manualscaling) + operationId: appengine.projects.locations.applications.services.versions.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Version' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: applicationsId + required: true + schema: + type: string + - in: path + name: servicesId + required: true + schema: + type: string + - in: path + name: versionsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask delete: description: Deletes an existing Version resource. operationId: appengine.projects.locations.applications.services.versions.delete @@ -5072,3 +5336,321 @@ paths: name: pageToken schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedCertificates: + parameters: *ref_1 + get: + description: Lists all SSL certificates the user is authorized to administer. + operationId: appengine.projects.locations.applications.authorizedCertificates.list + security: + - Oauth2: + - https://www.googleapis.com/auth/appengine.admin + Oauth2c: + - https://www.googleapis.com/auth/appengine.admin + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListAuthorizedCertificatesResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: applicationsId + required: true + schema: + type: string + - in: query + name: view + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + post: + description: Uploads the specified SSL certificate. + operationId: appengine.projects.locations.applications.authorizedCertificates.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AuthorizedCertificate' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/AuthorizedCertificate' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: applicationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedCertificates/{authorizedCertificatesId}: + parameters: *ref_1 + get: + description: Gets the specified SSL certificate. + operationId: appengine.projects.locations.applications.authorizedCertificates.get + security: + - Oauth2: + - https://www.googleapis.com/auth/appengine.admin + Oauth2c: + - https://www.googleapis.com/auth/appengine.admin + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/AuthorizedCertificate' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: applicationsId + required: true + schema: + type: string + - in: path + name: authorizedCertificatesId + required: true + schema: + type: string + - in: query + name: view + schema: + type: string + patch: + description: >- + Updates the specified SSL certificate. To renew a certificate and + maintain its existing domain mappings, update certificate_data with a + new certificate. The new certificate must be applicable to the same + domains as the original certificate. The certificate display_name may + also be updated. + operationId: appengine.projects.locations.applications.authorizedCertificates.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AuthorizedCertificate' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/AuthorizedCertificate' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: applicationsId + required: true + schema: + type: string + - in: path + name: authorizedCertificatesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes the specified SSL certificate. + operationId: appengine.projects.locations.applications.authorizedCertificates.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: applicationsId + required: true + schema: + type: string + - in: path + name: authorizedCertificatesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/domainMappings/{domainMappingsId}: + parameters: *ref_1 + get: + description: Gets the specified domain mapping. + operationId: appengine.projects.locations.applications.domainMappings.get + security: + - Oauth2: + - https://www.googleapis.com/auth/appengine.admin + Oauth2c: + - https://www.googleapis.com/auth/appengine.admin + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/DomainMapping' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: applicationsId + required: true + schema: + type: string + - in: path + name: domainMappingsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/domainMappings: + parameters: *ref_1 + post: + description: >- + Maps a domain to an application. A user must be authorized to administer + a domain in order to map it to an application. For a list of available + authorized domains, see AuthorizedDomains.ListAuthorizedDomains. + operationId: appengine.projects.locations.applications.domainMappings.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DomainMapping' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: applicationsId + required: true + schema: + type: string + - in: query + name: overrideStrategy + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/apphub.yaml b/providers/src/googleapis.com/v00.00.00000/services/apphub.yaml index 65487d92..c717c7ed 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/apphub.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/apphub.yaml @@ -7,8 +7,8 @@ info: title: App Hub API description: '' version: v1 - x-discovery-doc-revision: '20241008' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250820' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/app-hub/docs/ servers: @@ -1215,335 +1215,14 @@ components: description: >- Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully - have Operation.error value with a google.rpc.Status.code of 1, - corresponding to `Code.CANCELLED`. + have google.longrunning.Operation.error value with a + google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. readOnly: true type: boolean apiVersion: description: Output only. API version used to start the operation. readOnly: true type: string - AssetLocation: - id: AssetLocation - description: >- - Provides the mapping of a cloud asset to a direct physical location or - to a proxy that defines the location on its behalf. - type: object - properties: - expected: - description: >- - Defines the customer expectation around ZI/ZS for this asset and - ZI/ZS state of the region at the time of asset creation. - $ref: '#/components/schemas/IsolationExpectations' - locationData: - description: Contains all kinds of physical location definitions for this asset. - type: array - items: - $ref: '#/components/schemas/LocationData' - parentAsset: - description: >- - Defines parents assets if any in order to allow later generation of - child_asset_location data via child assets. - type: array - items: - $ref: '#/components/schemas/CloudAsset' - extraParameters: - description: Defines extra parameters required for specific asset types. - type: array - items: - $ref: '#/components/schemas/ExtraParameter' - ccfeRmsPath: - description: >- - Spanner path of the CCFE RMS database. It is only applicable for - CCFE tenants that use CCFE RMS for storing resource metadata. - type: string - IsolationExpectations: - id: IsolationExpectations - type: object - properties: - zoneIsolation: - description: >- - Deprecated: use zi_org_policy, zi_region_policy and zi_region_state - instead for setting ZI expectations as per - go/zicy-publish-physical-location. - deprecated: true - type: string - enumDescriptions: - - '' - - To be used if tracking is not available - - '' - - '' - - '' - enum: - - ZI_UNSPECIFIED - - ZI_UNKNOWN - - ZI_NOT_REQUIRED - - ZI_PREFERRED - - ZI_REQUIRED - zoneSeparation: - description: >- - Deprecated: use zs_org_policy, and zs_region_stateinstead for - setting Zs expectations as per go/zicy-publish-physical-location. - deprecated: true - type: string - enumDescriptions: - - '' - - To be used if tracking is not available - - '' - - '' - enum: - - ZS_UNSPECIFIED - - ZS_UNKNOWN - - ZS_NOT_REQUIRED - - ZS_REQUIRED - zsOrgPolicy: - type: string - enumDescriptions: - - '' - - To be used if tracking is not available - - '' - - '' - enum: - - ZS_UNSPECIFIED - - ZS_UNKNOWN - - ZS_NOT_REQUIRED - - ZS_REQUIRED - zsRegionState: - type: string - enumDescriptions: - - '' - - To be used if tracking of the asset ZS-bit is not available - - '' - - '' - enum: - - ZS_REGION_UNSPECIFIED - - ZS_REGION_UNKNOWN - - ZS_REGION_NOT_ENABLED - - ZS_REGION_ENABLED - ziOrgPolicy: - type: string - enumDescriptions: - - '' - - To be used if tracking is not available - - '' - - '' - - '' - enum: - - ZI_UNSPECIFIED - - ZI_UNKNOWN - - ZI_NOT_REQUIRED - - ZI_PREFERRED - - ZI_REQUIRED - ziRegionPolicy: - type: string - enumDescriptions: - - '' - - To be used if tracking is not available - - '' - - '' - - '' - enum: - - ZI_REGION_POLICY_UNSPECIFIED - - ZI_REGION_POLICY_UNKNOWN - - ZI_REGION_POLICY_NOT_SET - - ZI_REGION_POLICY_FAIL_OPEN - - ZI_REGION_POLICY_FAIL_CLOSED - ziRegionState: - type: string - enumDescriptions: - - '' - - To be used if tracking is not available - - '' - - '' - enum: - - ZI_REGION_UNSPECIFIED - - ZI_REGION_UNKNOWN - - ZI_REGION_NOT_ENABLED - - ZI_REGION_ENABLED - requirementOverride: - description: >- - Explicit overrides for ZI and ZS requirements to be used for - resources that should be excluded from ZI/ZS verification logic. - $ref: '#/components/schemas/RequirementOverride' - RequirementOverride: - id: RequirementOverride - type: object - properties: - ziOverride: - type: string - enumDescriptions: - - '' - - To be used if tracking is not available - - '' - - '' - - '' - enum: - - ZI_UNSPECIFIED - - ZI_UNKNOWN - - ZI_NOT_REQUIRED - - ZI_PREFERRED - - ZI_REQUIRED - zsOverride: - type: string - enumDescriptions: - - '' - - To be used if tracking is not available - - '' - - '' - enum: - - ZS_UNSPECIFIED - - ZS_UNKNOWN - - ZS_NOT_REQUIRED - - ZS_REQUIRED - LocationData: - id: LocationData - type: object - properties: - directLocation: - $ref: '#/components/schemas/DirectLocationAssignment' - spannerLocation: - $ref: '#/components/schemas/SpannerLocation' - childAssetLocation: - $ref: '#/components/schemas/CloudAssetComposition' - gcpProjectProxy: - $ref: '#/components/schemas/TenantProjectProxy' - blobstoreLocation: - $ref: '#/components/schemas/BlobstoreLocation' - placerLocation: - $ref: '#/components/schemas/PlacerLocation' - DirectLocationAssignment: - id: DirectLocationAssignment - type: object - properties: - location: - type: array - items: - $ref: '#/components/schemas/LocationAssignment' - LocationAssignment: - id: LocationAssignment - type: object - properties: - location: - type: string - locationType: - type: string - enumDescriptions: - - '' - - '1-10: Physical failure domains.' - - '' - - '11-20: Logical failure domains.' - - '' - - '' - - '' - - '' - - '' - enum: - - UNSPECIFIED - - CLUSTER - - POP - - CLOUD_ZONE - - CLOUD_REGION - - MULTI_REGION_GEO - - MULTI_REGION_JURISDICTION - - GLOBAL - - OTHER - SpannerLocation: - id: SpannerLocation - type: object - properties: - dbName: - description: Set of databases used by the resource in format /span// - type: array - items: - type: string - backupName: - description: >- - Set of backups used by the resource with name in the same format as - what is available at http://table/spanner_automon.backup_metadata - type: array - items: - type: string - CloudAssetComposition: - id: CloudAssetComposition - type: object - properties: - childAsset: - type: array - items: - $ref: '#/components/schemas/CloudAsset' - CloudAsset: - id: CloudAsset - type: object - properties: - assetType: - type: string - assetName: - type: string - TenantProjectProxy: - id: TenantProjectProxy - type: object - properties: - projectNumbers: - type: array - items: - type: string - BlobstoreLocation: - id: BlobstoreLocation - description: >- - Policy ID that identified data placement in Blobstore as per - go/blobstore-user-guide#data-metadata-placement-and-failure-domains - type: object - properties: - policyId: - type: array - items: - type: string - PlacerLocation: - id: PlacerLocation - description: >- - Message describing that the location of the customer resource is tied to - placer allocations - type: object - properties: - placerConfig: - description: >- - Directory with a config related to it in placer (e.g. - "/placer/prod/home/my-root/my-dir") - type: string - ExtraParameter: - id: ExtraParameter - description: Defines parameters that should only be used for specific asset types. - type: object - properties: - regionalMigDistributionPolicy: - description: >- - Details about zones used by regional - compute.googleapis.com/InstanceGroupManager to create instances. - $ref: '#/components/schemas/RegionalMigDistributionPolicy' - RegionalMigDistributionPolicy: - id: RegionalMigDistributionPolicy - description: >- - To be used for specifying the intended distribution of regional - compute.googleapis.com/InstanceGroupManager instances - type: object - properties: - zones: - description: Cloud zones used by regional MIG to create instances. - type: array - items: - $ref: '#/components/schemas/ZoneConfiguration' - targetShape: - description: >- - The shape in which the group converges around distribution of - resources. Instance of proto2 enum - type: integer - format: int32 - ZoneConfiguration: - id: ZoneConfiguration - type: object - properties: - zone: - type: string parameters: access_token: description: OAuth access token. @@ -2134,6 +1813,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: @@ -2288,7 +1971,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: apphub.projects.locations.operations.cancel requestBody: content: diff --git a/providers/src/googleapis.com/v00.00.00000/services/areainsights.yaml b/providers/src/googleapis.com/v00.00.00000/services/areainsights.yaml new file mode 100644 index 00000000..89b3e1a1 --- /dev/null +++ b/providers/src/googleapis.com/v00.00.00000/services/areainsights.yaml @@ -0,0 +1,461 @@ +openapi: 3.1.0 +info: + contact: + name: StackQL Studios + url: https://github.com/stackql/google-discovery-to-openapi + email: info@stackql.io + title: Places Aggregate API + description: Places Aggregate API. + version: v1 + x-discovery-doc-revision: '20250826' + x-generated-date: '2025-08-28' +externalDocs: + url: https://developers.google.com/maps/documentation/places-aggregate/overview +servers: + - url: https://areainsights.googleapis.com +components: + securitySchemes: + Oauth2: + type: oauth2 + description: Oauth 2.0 implicit authentication + flows: + implicit: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + scopes: &ref_0 + 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. + Oauth2c: + type: oauth2 + description: Oauth 2.0 authorization code authentication + flows: + authorizationCode: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + tokenUrl: https://accounts.google.com/o/oauth2/token + scopes: *ref_0 + schemas: + ComputeInsightsRequest: + id: ComputeInsightsRequest + description: Request for the ComputeInsights RPC. + type: object + properties: + insights: + description: >- + Required. Insights to compute. Currently only INSIGHT_COUNT and + INSIGHT_PLACES are supported. + type: array + items: + type: string + enumDescriptions: + - Not Specified. + - >- + Count insight. When this insight is specified ComputeInsights + returns the number of places that match the specified filter + criteria. Example request: ``` { "insights": ["INSIGHT_COUNT"], + "filter": { "locationFilter": { "region": { "place": + "places/ChIJPV4oX_65j4ARVW8IJ6IJUYs" } }, "typeFilter": { + "includedTypes": ["restaurant"] }, "operatingStatus": + ["OPERATING_STATUS_OPERATIONAL"], "priceLevels": [ + "PRICE_LEVEL_FREE", "PRICE_LEVEL_INEXPENSIVE" ], "ratingFilter": + { "minRating": 4.0 } } } ``` Example response: ``` { "count": + 1234 } ``` + - >- + Return Places When this insight is specified ComputeInsights + returns places IDs that match the specified filter criteria. + Example request: ``` { "insights": ["INSIGHT_PLACES"], "filter": + { "locationFilter": { "region": { "place": + "places/ChIJPV4oX_65j4ARVW8IJ6IJUYs" } }, "typeFilter": { + "includedTypes": ["restaurant"] }, "operatingStatus": + ["OPERATING_STATUS_OPERATIONAL"], "priceLevels": [ + "PRICE_LEVEL_FREE", "PRICE_LEVEL_INEXPENSIVE" ], "ratingFilter": + { "minRating": 4.0 } } } ``` Example response: ``` { + "placeInsights": [ {"place": "places/ABC"}, {"place": + "places/PQR"}, {"place": "places/XYZ"} ] } ``` + enum: + - INSIGHT_UNSPECIFIED + - INSIGHT_COUNT + - INSIGHT_PLACES + filter: + description: Required. Insight filter. + $ref: '#/components/schemas/Filter' + Filter: + id: Filter + description: Filters for the ComputeInsights RPC. + type: object + properties: + locationFilter: + description: >- + Required. Restricts results to places which are located in the area + specified by location filters. + $ref: '#/components/schemas/LocationFilter' + typeFilter: + description: Required. Place type filters. + $ref: '#/components/schemas/TypeFilter' + operatingStatus: + description: >- + Optional. Restricts results to places whose operating status is + included on this list. If operating_status is not set, + OPERATING_STATUS_OPERATIONAL is used as default. + type: array + items: + type: string + enumDescriptions: + - Not specified. This value should not be used. + - The place is operational and its open during its defined hours. + - The Place is no longer in business. + - >- + The place is temporarily closed and expected to reopen in the + future. + enum: + - OPERATING_STATUS_UNSPECIFIED + - OPERATING_STATUS_OPERATIONAL + - OPERATING_STATUS_PERMANENTLY_CLOSED + - OPERATING_STATUS_TEMPORARILY_CLOSED + priceLevels: + description: >- + Optional. Restricts results to places whose price level is included + on this list. If `price_levels` is not set, all price levels are + included in the results. + type: array + items: + type: string + enumDescriptions: + - Not specified. This value should not be used. + - Place provides free services. + - Place provides inexpensive services. + - Place provides moderately priced services. + - Place provides expensive services. + - Place provides very expensive services. + enum: + - PRICE_LEVEL_UNSPECIFIED + - PRICE_LEVEL_FREE + - PRICE_LEVEL_INEXPENSIVE + - PRICE_LEVEL_MODERATE + - PRICE_LEVEL_EXPENSIVE + - PRICE_LEVEL_VERY_EXPENSIVE + ratingFilter: + description: >- + Optional. Restricts results to places whose average user ratings are + in the range specified by rating_filter. If rating_filter is not + set, all ratings are included in the result. + $ref: '#/components/schemas/RatingFilter' + LocationFilter: + id: LocationFilter + description: Location filters. Specifies the area of interest for the insight. + type: object + properties: + circle: + description: Area as a circle. + $ref: '#/components/schemas/Circle' + region: + description: Area as region. + $ref: '#/components/schemas/Region' + customArea: + description: Custom area specified by a polygon. + $ref: '#/components/schemas/CustomArea' + Circle: + id: Circle + description: A circle is defined by a center point and radius in meters. + type: object + properties: + latLng: + description: The latitude and longitude of the center of the circle. + $ref: '#/components/schemas/LatLng' + place: + description: >- + **Format:** Must be in the format `places/PLACE_ID`, where + `PLACE_ID` is the unique identifier of a place. For example: + `places/ChIJgUbEo8cfqokR5lP9_Wh_DaM`. + type: string + radius: + description: Optional. The radius of the circle in meters + type: integer + format: int32 + LatLng: + id: LatLng + description: >- + An object that represents a latitude/longitude pair. This is expressed + as a pair of doubles to represent degrees latitude and degrees + longitude. Unless specified otherwise, this object must conform to the + WGS84 standard. Values must be within normalized ranges. + type: object + properties: + latitude: + description: The latitude in degrees. It must be in the range [-90.0, +90.0]. + type: number + format: double + longitude: + description: The longitude in degrees. It must be in the range [-180.0, +180.0]. + type: number + format: double + Region: + id: Region + description: >- + A region is a geographic boundary such as: cities, postal codes, + counties, states, etc. + type: object + properties: + place: + description: >- + The [place + ID](https://developers.google.com/maps/documentation/places/web-service/place-id) + of the geographic region. Not all region types are supported; see + documentation for details. **Format:** Must be in the format + `places/PLACE_ID`, where `PLACE_ID` is the unique identifier of a + place. For example: `places/ChIJPV4oX_65j4ARVW8IJ6IJUYs`. + type: string + CustomArea: + id: CustomArea + description: Custom Area. + type: object + properties: + polygon: + description: Required. The custom area represented as a polygon + $ref: '#/components/schemas/Polygon' + Polygon: + id: Polygon + description: >- + A polygon is represented by a series of connected coordinates in an + counterclockwise ordered sequence. The coordinates form a closed loop + and define a filled region. The first and last coordinates are + equivalent, and they must contain identical values. The format is a + simplified version of GeoJSON polygons (we only support one + counterclockwise exterior ring). + type: object + properties: + coordinates: + description: Optional. The coordinates that define the polygon. + type: array + items: + $ref: '#/components/schemas/LatLng' + TypeFilter: + id: TypeFilter + description: >- + Place type filters. Only Place types from [Table + a](https://developers.google.com/maps/documentation/places/web-service/place-types#table-a) + are supported. A place can only have a single primary type associated + with it. For example, the primary type might be "mexican_restaurant" or + "steak_house". Use included_primary_types and excluded_primary_types to + filter the results on a place's primary type. A place can also have + multiple type values associated with it. For example a restaurant might + have the following types: "seafood_restaurant", "restaurant", "food", + "point_of_interest", "establishment". Use included_types and + excluded_types to filter the results on the list of types associated + with a place. If a search is specified with multiple type restrictions, + only places that satisfy all of the restrictions are returned. For + example, if you specify {"included_types": ["restaurant"], + "excluded_primary_types": ["steak_house"]}, the returned places provide + "restaurant" related services but do not operate primarily as a + "steak_house". If there are any conflicting types, i.e. a type appears + in both included_types and excluded_types types or + included_primary_types and excluded_primary_types, an INVALID_ARGUMENT + error is returned. One of included_types or included_primary_types must + be set. + type: object + properties: + includedTypes: + description: Optional. Included Place types. + type: array + items: + type: string + excludedTypes: + description: Optional. Excluded Place types. + type: array + items: + type: string + includedPrimaryTypes: + description: Optional. Included primary Place types. + type: array + items: + type: string + excludedPrimaryTypes: + description: Optional. Excluded primary Place types. + type: array + items: + type: string + RatingFilter: + id: RatingFilter + description: Average user rating filters. + type: object + properties: + minRating: + description: >- + Optional. Restricts results to places whose average user rating is + greater than or equal to min_rating. Values must be between 1.0 and + 5.0. + type: number + format: float + maxRating: + description: >- + Optional. Restricts results to places whose average user rating is + strictly less than or equal to max_rating. Values must be between + 1.0 and 5.0. + type: number + format: float + ComputeInsightsResponse: + id: ComputeInsightsResponse + description: Response for the ComputeInsights RPC. + type: object + properties: + count: + description: Result for Insights.INSIGHT_COUNT. + type: string + format: int64 + placeInsights: + description: Result for Insights.INSIGHT_PLACES. + type: array + items: + $ref: '#/components/schemas/PlaceInsight' + PlaceInsight: + id: PlaceInsight + description: Holds information about a place + type: object + properties: + place: + description: >- + The unique identifier of the place. This resource name can be used + to retrieve details about the place using the [Places + API](https://developers.google.com/maps/documentation/places/web-service/reference/rest/v1/places/get). + type: string + parameters: + 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: + type: string + enum: + - json + - media + - proto + 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 + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + x-stackQL-resources: + areainsights: + id: google.areainsights.areainsights + name: areainsights + title: Areainsights + methods: + compute_insights: + operation: + $ref: '#/paths/~1v1:computeInsights/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] +paths: + /v1:computeInsights: + parameters: + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' + post: + description: >- + This method lets you retrieve insights about areas using a variety of + filter such as: area, place type, operating status, price level and + ratings. Currently "count" and "places" insights are supported. With + "count" insights you can answer questions such as "How many restaurant + are located in California that are operational, are inexpensive and have + an average rating of at least 4 stars" (see `insight` enum for more + details). With "places" insights, you can determine which places match + the requested filter. Clients can then use those place resource names to + fetch more details about each individual place using the Places API. + operationId: areainsights.computeInsights + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ComputeInsightsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ComputeInsightsResponse' + parameters: [] diff --git a/providers/src/googleapis.com/v00.00.00000/services/artifactregistry.yaml b/providers/src/googleapis.com/v00.00.00000/services/artifactregistry.yaml index b5f49727..da6c47ea 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/artifactregistry.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/artifactregistry.yaml @@ -9,8 +9,8 @@ info: Store and manage build artifacts in a scalable and integrated service built on Google infrastructure. version: v1 - x-discovery-doc-revision: '20241029' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250730' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/artifacts/docs/ servers: @@ -149,7 +149,8 @@ components: description: >- Required. registry_location, project_id, repository_name and image id forms a unique image - name:`projects//locations//repository//dockerImages/`. For example, + name:`projects//locations//repositories//dockerImages/`. For + example, "projects/test-project/locations/us-west4/repositories/test-repo/dockerImages/ nginx@sha256:e9954c1fc875017be1c3e36eca16be2d9e9bccc4bf072163515467d6a823c7cf", where "us-west4" is the registry_location, "test-project" is the @@ -470,9 +471,9 @@ components: The ID of the version of the generic artifact. If the version does not exist, a new version will be created. The version_id must start and end with a letter or number, can only contain lowercase letters, - numbers, hyphens and periods, i.e. [a-z0-9-.] and cannot exceed a - total of 128 characters. Creating a version called `latest` is not - allowed. + numbers, the following characters [-.+~:], i.e.[a-z0-9-.+~:] and + cannot exceed a total of 128 characters. Creating a version called + `latest` is not allowed. type: string filename: description: >- @@ -669,9 +670,7 @@ components: type: string format: int64 satisfiesPzs: - description: >- - Output only. If set, the repository satisfies physical zone - separation. + description: Output only. Whether or not this repository satisfies PZS. readOnly: true type: boolean cleanupPolicyDryRun: @@ -690,11 +689,15 @@ components: as error rather than defaulting to standard. type: boolean satisfiesPzi: - description: >- - Output only. If set, the repository satisfies physical zone - isolation. + description: Output only. Whether or not this repository satisfies PZI. readOnly: true type: boolean + registryUri: + description: >- + Output only. The repository endpoint, for example: + `us-docker.pkg.dev/my-proj/my-repo`. + readOnly: true + type: string MavenRepositoryConfig: id: MavenRepositoryConfig description: >- @@ -1343,8 +1346,9 @@ components: properties: names: description: >- - Required. The names of the versions to delete. A maximum of 10000 - versions can be deleted in a batch. + Required. The names of the versions to delete. The maximum number of + versions deleted per batch is determined by the service and is + dependent on the available resources in the region. type: array items: type: string @@ -3319,6 +3323,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: diff --git a/providers/src/googleapis.com/v00.00.00000/services/assuredworkloads.yaml b/providers/src/googleapis.com/v00.00.00000/services/assuredworkloads.yaml index 1c3dff25..16e65d61 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/assuredworkloads.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/assuredworkloads.yaml @@ -7,8 +7,8 @@ info: title: Assured Workloads API description: '' version: v1 - x-discovery-doc-revision: '20241024' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250821' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/learnmoreurl servers: @@ -34,875 +34,1352 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions: - properties: - dataLogsViewer: - description: >- - Allow the partner to view inspectability logs and monitoring - violations. - type: boolean - serviceAccessApprover: - type: boolean - description: Optional. Allow partner to view access approval logs. - accessTransparencyLogsSupportCaseViewer: - type: boolean - description: Optional. Allow partner to view support case details for an AXT log - assuredWorkloadsMonitoring: - type: boolean - description: Optional. Allow partner to view violation alerts. - description: >- - Permissions granted to the AW Partner SA account for the customer - workload - type: object - id: GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions - GoogleCloudAssuredworkloadsV1EnableResourceMonitoringResponse: - properties: {} - id: GoogleCloudAssuredworkloadsV1EnableResourceMonitoringResponse - description: Response for EnableResourceMonitoring endpoint. - type: object - GoogleCloudAssuredworkloadsV1ListWorkloadsResponse: - id: GoogleCloudAssuredworkloadsV1ListWorkloadsResponse + GoogleLongrunningListOperationsResponse: + id: GoogleLongrunningListOperationsResponse + description: The response message for Operations.ListOperations. type: object - description: Response of ListWorkloads endpoint. properties: + operations: + description: >- + A list of operations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/GoogleLongrunningOperation' nextPageToken: + description: The standard List next-page token. type: string - description: The next page token. Return empty if reached the last page. - workloads: - description: List of Workloads under a given parent. - items: - $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Workload' - type: array - GoogleCloudAssuredworkloadsV1ViolationExceptionContext: + GoogleLongrunningOperation: + id: GoogleLongrunningOperation + description: >- + This resource represents a long-running operation that is the result of + a network API call. type: object properties: - userName: - type: string + name: description: >- - Name of the user (or service account) who acknowledged the - violation. - acknowledgementTime: - description: Timestamp when the violation was acknowledged. - format: google-datetime - type: string - comment: + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. type: string + metadata: description: >- - Business justification provided towards the acknowledgement of the - violation. - id: GoogleCloudAssuredworkloadsV1ViolationExceptionContext - description: Violation exception detail. - GoogleProtobufEmpty: - type: object - description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } - properties: {} - id: GoogleProtobufEmpty - GoogleCloudAssuredworkloadsV1MoveImpact: - properties: - detail: - type: string - description: Explanation of the impact. - type: object - id: GoogleCloudAssuredworkloadsV1MoveImpact - description: Represents the impact of moving the asset to the target. - GoogleCloudAssuredworkloadsV1WorkloadSaaEnrollmentResponse: - description: Signed Access Approvals (SAA) enrollment response. - properties: - setupErrors: - items: - enumDescriptions: - - Unspecified. - - >- - Invalid states for all customers, to be redirected to AA UI for - additional details. - - Returned when there is not an EKM key configured. - - >- - Returned when there are no enrolled services or the customer is - enrolled in CAA only for a subset of services. - - >- - Returned when exception was encountered during evaluation of - other criteria. - enum: - - SETUP_ERROR_UNSPECIFIED - - ERROR_INVALID_BASE_SETUP - - ERROR_MISSING_EXTERNAL_SIGNING_KEY - - ERROR_NOT_ALL_SERVICES_ENROLLED - - ERROR_SETUP_CHECK_FAILED - type: string - type: array - description: Indicates SAA enrollment setup error if any. - setupStatus: - enumDescriptions: - - Unspecified. - - SAA enrollment pending. - - SAA enrollment comopleted. - enum: - - SETUP_STATE_UNSPECIFIED - - STATUS_PENDING - - STATUS_COMPLETE - description: Indicates SAA enrollment status of a given workload. - type: string - type: object - id: GoogleCloudAssuredworkloadsV1WorkloadSaaEnrollmentResponse - GoogleCloudAssuredworkloadsV1MutatePartnerPermissionsRequest: - type: object - description: Request for updating permission settings for a partner workload. - properties: - etag: - type: string + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + done: description: >- - Optional. The etag of the workload. If this is provided, it must - match the server's etag. - updateMask: - format: google-fieldmask + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + type: boolean + error: description: >- - Required. The list of fields to be updated. E.g. update_mask { - paths: "partner_permissions.data_logs_viewer"} - type: string - partnerPermissions: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions - description: Required. The partner permissions to be updated. - id: GoogleCloudAssuredworkloadsV1MutatePartnerPermissionsRequest - GoogleCloudAssuredworkloadsV1AnalyzeWorkloadMoveResponse: - id: GoogleCloudAssuredworkloadsV1AnalyzeWorkloadMoveResponse - description: >- - Response containing the analysis results for the hypothetical resource - move. - type: object - properties: - nextPageToken: - type: string - description: The next page token. Is empty if the last page is reached. - assetMoveAnalyses: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1AssetMoveAnalysis - description: List of analysis results for each asset in scope. + The error result of the operation in case of failure or + cancellation. + $ref: '#/components/schemas/GoogleRpcStatus' + response: + description: >- + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. GoogleRpcStatus: id: GoogleRpcStatus + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + type: object properties: - details: - items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - type: array code: description: The status code, which should be an enum value of google.rpc.Code. type: integer format: int32 message: - type: string description: >- A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + type: string + details: + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + type: array + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + GoogleCloudAssuredworkloadsV1Workload: + id: GoogleCloudAssuredworkloadsV1Workload description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). + A Workload object for managing highly regulated workloads of cloud + customers. type: object - GoogleCloudAssuredworkloadsV1ViolationRemediation: properties: - instructions: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1ViolationRemediationInstructions - description: Required. Remediation instructions to resolve violations - remediationType: + name: + description: >- + Optional. The resource name of the workload. Format: + organizations/{organization}/locations/{location}/workloads/{workload} + Read-only. type: string + displayName: description: >- - Output only. Reemediation type based on the type of org policy - values violated - enum: - - REMEDIATION_TYPE_UNSPECIFIED - - REMEDIATION_BOOLEAN_ORG_POLICY_VIOLATION - - REMEDIATION_LIST_ALLOWED_VALUES_ORG_POLICY_VIOLATION - - REMEDIATION_LIST_DENIED_VALUES_ORG_POLICY_VIOLATION - - REMEDIATION_RESTRICT_CMEK_CRYPTO_KEY_PROJECTS_ORG_POLICY_VIOLATION - - REMEDIATION_RESOURCE_VIOLATION - - REMEDIATION_RESOURCE_VIOLATION_NON_CMEK_SERVICES - readOnly: true + Required. The user-assigned display name of the Workload. When + present it must be between 4 to 30 characters. Allowed characters + are: lowercase and uppercase letters, numbers, hyphen, and spaces. + Example: My Workload + type: string + resources: + description: >- + Output only. The resources associated with this workload. These + resources will be created when creating the workload. If any of the + projects already exist, the workload creation will fail. Always read + only. + readOnly: true + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadResourceInfo + complianceRegime: + description: >- + Required. Immutable. Compliance Regime associated with this + workload. + type: string + enumDescriptions: + - Unknown compliance regime. + - Information protection as per DoD IL4 requirements. + - Criminal Justice Information Services (CJIS) Security policies. + - FedRAMP High data protection controls + - FedRAMP Moderate data protection controls + - Assured Workloads For US Regions data protection controls + - >- + [DEPRECATED] Health Insurance Portability and Accountability Act + controls + - '[DEPRECATED] Health Information Trust Alliance controls' + - Assured Workloads For EU Regions and Support controls + - Assured Workloads For Canada Regions and Support controls + - International Traffic in Arms Regulations + - Assured Workloads for Australia Regions and Support controls + - Assured Workloads for Partners; + - Assured Workloads for Israel Regions + - Assured Workloads for Israel Regions + - Assured Workloads for Canada Protected B regime + - Information protection as per DoD IL5 requirements. + - Information protection as per DoD IL2 requirements. + - Assured Workloads for Japan Regions + - Assured Workloads Sovereign Controls KSA + - Assured Workloads for Regional Controls + - Healthcare and Life Science Controls + - Healthcare and Life Science Controls with US Support + - Internal Revenue Service 1075 controls + - Canada Controlled Goods + - Australia Data Boundary and Support + - Canada Data Boundary and Support + - Data Boundary for Canada Controlled Goods + - Data Boundary for Canada Protected B + - Data Boundary for CJIS + - Data Boundary for FedRAMP High + - Data Boundary for FedRAMP Moderate + - Data Boundary for IL2 + - Data Boundary for IL4 + - Data Boundary for IL5 + - Data Boundary for IRS Publication 1075 + - Data Boundary for ITAR + - Data Boundary for EU Regions and Support + - Data Boundary for Israel Regions + - Data Boundary for US Regions and Support + - Data Boundary for US Healthcare and Life Sciences + - Data Boundary for US Healthcare and Life Sciences with Support + - KSA Data Boundary with Access Justifications + - Regional Data Boundary + - JAPAN Data Boundary + enumDeprecated: + - false + - false + - false + - false + - false + - false + - true + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + enum: + - COMPLIANCE_REGIME_UNSPECIFIED + - IL4 + - CJIS + - FEDRAMP_HIGH + - FEDRAMP_MODERATE + - US_REGIONAL_ACCESS + - HIPAA + - HITRUST + - EU_REGIONS_AND_SUPPORT + - CA_REGIONS_AND_SUPPORT + - ITAR + - AU_REGIONS_AND_US_SUPPORT + - ASSURED_WORKLOADS_FOR_PARTNERS + - ISR_REGIONS + - ISR_REGIONS_AND_SUPPORT + - CA_PROTECTED_B + - IL5 + - IL2 + - JP_REGIONS_AND_SUPPORT + - KSA_REGIONS_AND_SUPPORT_WITH_SOVEREIGNTY_CONTROLS + - REGIONAL_CONTROLS + - HEALTHCARE_AND_LIFE_SCIENCES_CONTROLS + - HEALTHCARE_AND_LIFE_SCIENCES_CONTROLS_US_SUPPORT + - IRS_1075 + - CANADA_CONTROLLED_GOODS + - AUSTRALIA_DATA_BOUNDARY_AND_SUPPORT + - CANADA_DATA_BOUNDARY_AND_SUPPORT + - DATA_BOUNDARY_FOR_CANADA_CONTROLLED_GOODS + - DATA_BOUNDARY_FOR_CANADA_PROTECTED_B + - DATA_BOUNDARY_FOR_CJIS + - DATA_BOUNDARY_FOR_FEDRAMP_HIGH + - DATA_BOUNDARY_FOR_FEDRAMP_MODERATE + - DATA_BOUNDARY_FOR_IL2 + - DATA_BOUNDARY_FOR_IL4 + - DATA_BOUNDARY_FOR_IL5 + - DATA_BOUNDARY_FOR_IRS_PUBLICATION_1075 + - DATA_BOUNDARY_FOR_ITAR + - EU_DATA_BOUNDARY_AND_SUPPORT + - ISRAEL_DATA_BOUNDARY_AND_SUPPORT + - US_DATA_BOUNDARY_AND_SUPPORT + - US_DATA_BOUNDARY_FOR_HEALTHCARE_AND_LIFE_SCIENCES + - US_DATA_BOUNDARY_FOR_HEALTHCARE_AND_LIFE_SCIENCES_WITH_SUPPORT + - KSA_DATA_BOUNDARY_WITH_ACCESS_JUSTIFICATIONS + - REGIONAL_DATA_BOUNDARY + - JAPAN_DATA_BOUNDARY + createTime: + description: Output only. Immutable. The Workload creation timestamp. + readOnly: true + type: string + format: google-datetime + billingAccount: + description: >- + Optional. The billing account used for the resources which are + direct children of workload. This billing account is initially + associated with the resources created as part of Workload creation. + After the initial creation of these resources, the customer can + change the assigned billing account. The resource name has the form + `billingAccounts/{billing_account_id}`. For example, + `billingAccounts/012345-567890-ABCDEF`. + type: string + etag: + description: >- + Optional. ETag of the workload, it is calculated on the basis of the + Workload contents. It will be used in Update & Delete operations. + type: string + labels: + description: Optional. Labels applied to the workload. + type: object + additionalProperties: + type: string + provisionedResourcesParent: + description: >- + Input only. The parent resource for the resources managed by this + Assured Workload. May be either empty or a folder resource which is + a child of the Workload parent. If not specified all resources are + created under the parent organization. Format: folders/{folder_id} + type: string + kmsSettings: + description: >- + Input only. Settings used to create a CMEK crypto key. When set, a + project with a KMS CMEK key is provisioned. This field is deprecated + as of Feb 28, 2022. In order to create a Keyring, callers should + specify, ENCRYPTION_KEYS_PROJECT or KEYRING in + ResourceSettings.resource_type field. + deprecated: true + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadKMSSettings + resourceSettings: + description: >- + Input only. Resource properties that are used to customize workload + resources. These properties (such as custom project id) will be used + to create workload resources if possible. This field is optional. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadResourceSettings + kajEnrollmentState: + description: >- + Output only. Represents the KAJ enrollment state of the given + workload. + readOnly: true + type: string + enumDescriptions: + - Default State for KAJ Enrollment. + - Pending State for KAJ Enrollment. + - Complete State for KAJ Enrollment. + enum: + - KAJ_ENROLLMENT_STATE_UNSPECIFIED + - KAJ_ENROLLMENT_STATE_PENDING + - KAJ_ENROLLMENT_STATE_COMPLETE + enableSovereignControls: + description: >- + Optional. Indicates the sovereignty status of the given workload. + Currently meant to be used by Europe/Canada customers. + type: boolean + saaEnrollmentResponse: + description: >- + Output only. Represents the SAA enrollment response of the given + workload. SAA enrollment response is queried during GetWorkload + call. In failure cases, user friendly error message is shown in SAA + details page. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadSaaEnrollmentResponse + complianceStatus: + description: Output only. Count of active Violations in the Workload. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadComplianceStatus + compliantButDisallowedServices: + description: >- + Output only. Urls for services which are compliant for this Assured + Workload, but which are currently disallowed by the + ResourceUsageRestriction org policy. Invoke RestrictAllowedResources + endpoint to allow your project developers to use these services in + their environment. + readOnly: true + type: array + items: + type: string + partner: + description: Optional. Partner regime associated with this workload. + type: string + enumDescriptions: + - '' + - Enum representing S3NS (Thales) partner. + - Enum representing T_SYSTEM (TSI) partner. + - Enum representing SIA_MINSAIT (Indra) partner. + - Enum representing PSN (TIM) partner. + - Enum representing CNTXT (Kingdom of Saudi Arabia) partner. + - >- + Enum representing CNTXT (Kingdom of Saudi Arabia) partner offering + without EKM. + enum: + - PARTNER_UNSPECIFIED + - LOCAL_CONTROLS_BY_S3NS + - SOVEREIGN_CONTROLS_BY_T_SYSTEMS + - SOVEREIGN_CONTROLS_BY_SIA_MINSAIT + - SOVEREIGN_CONTROLS_BY_PSN + - SOVEREIGN_CONTROLS_BY_CNTXT + - SOVEREIGN_CONTROLS_BY_CNTXT_NO_EKM + partnerPermissions: + description: >- + Optional. Permissions granted to the AW Partner SA account for the + customer workload + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions + partnerServicesBillingAccount: + description: >- + Optional. Billing account necessary for purchasing services from + Sovereign Partners. This field is required for creating + SIA/PSN/CNTXT partner workloads. The caller should have + 'billing.resourceAssociations.create' IAM permission on this + billing-account. The format of this string is + billingAccounts/AAAAAA-BBBBBB-CCCCCC + type: string + violationNotificationsEnabled: + description: >- + Optional. Indicates whether the e-mail notification for a violation + is enabled for a workload. This value will be by default True, and + if not present will be considered as true. This should only be + updated via updateWorkload call. Any Changes to this field during + the createWorkload call will not be honored. This will always be + true while creating the workload. + type: boolean + ekmProvisioningResponse: + description: >- + Output only. Represents the Ekm Provisioning State of the given + workload. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadEkmProvisioningResponse + resourceMonitoringEnabled: + description: >- + Output only. Indicates whether resource monitoring is enabled for + workload or not. It is true when Resource feed is subscribed to AWM + topic and AWM Service Agent Role is binded to AW Service Account for + resource Assured workload. + readOnly: true + type: boolean + workloadOptions: + description: Optional. Options to be set for the given created workload. + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadWorkloadOptions + GoogleCloudAssuredworkloadsV1WorkloadResourceInfo: + id: GoogleCloudAssuredworkloadsV1WorkloadResourceInfo + description: Represent the resources that are children of this Workload. + type: object + properties: + resourceId: + description: >- + Output only. Resource identifier. For a project this represents + project_number. + readOnly: true + type: string + format: int64 + resourceType: + description: Indicates the type of resource. + type: string + enumDescriptions: + - Unknown resource type. + - >- + Deprecated. Existing workloads will continue to support this, but + new CreateWorkloadRequests should not specify this as an input + value. + - Consumer Folder. + - Consumer project containing encryption keys. + - Keyring resource that hosts encryption keys. + enumDeprecated: + - false + - true + - false + - false + - false + enum: + - RESOURCE_TYPE_UNSPECIFIED + - CONSUMER_PROJECT + - CONSUMER_FOLDER + - ENCRYPTION_KEYS_PROJECT + - KEYRING + GoogleCloudAssuredworkloadsV1WorkloadKMSSettings: + id: GoogleCloudAssuredworkloadsV1WorkloadKMSSettings + deprecated: true + description: Settings specific to the Key Management Service. + type: object + properties: + nextRotationTime: + description: >- + Required. Input only. Immutable. The time at which the Key + Management Service will automatically create a new version of the + crypto key and mark it as the primary. + type: string + format: google-datetime + rotationPeriod: + description: >- + Required. Input only. Immutable. [next_rotation_time] will be + advanced by this period when the Key Management Service + automatically rotates a key. Must be at least 24 hours and at most + 876,000 hours. + type: string + format: google-duration + GoogleCloudAssuredworkloadsV1WorkloadResourceSettings: + id: GoogleCloudAssuredworkloadsV1WorkloadResourceSettings + description: Represent the custom settings for the resources to be created. + type: object + properties: + resourceId: + description: >- + Resource identifier. For a project this represents project_id. If + the project is already taken, the workload creation will fail. For + KeyRing, this represents the keyring_id. For a folder, don't set + this value as folder_id is assigned by Google. + type: string + resourceType: + description: >- + Indicates the type of resource. This field should be specified to + correspond the id to the right project type (CONSUMER_PROJECT or + ENCRYPTION_KEYS_PROJECT) + type: string enumDescriptions: - - Unspecified remediation type - - Remediation type for boolean org policy - - >- - Remediation type for list org policy which have allowed values in - the monitoring rule - - >- - Remediation type for list org policy which have denied values in - the monitoring rule - - Remediation type for gcp.restrictCmekCryptoKeyProjects - - Remediation type for resource violation. + - Unknown resource type. - >- - Remediation type for resource violation due to - gcp.restrictNonCmekServices - compliantValues: + Deprecated. Existing workloads will continue to support this, but + new CreateWorkloadRequests should not specify this as an input + value. + - Consumer Folder. + - Consumer project containing encryption keys. + - Keyring resource that hosts encryption keys. + enumDeprecated: + - false + - true + - false + - false + - false + enum: + - RESOURCE_TYPE_UNSPECIFIED + - CONSUMER_PROJECT + - CONSUMER_FOLDER + - ENCRYPTION_KEYS_PROJECT + - KEYRING + displayName: + description: >- + User-assigned resource display name. If not empty it will be used to + create a resource with the specified name. + type: string + GoogleCloudAssuredworkloadsV1WorkloadSaaEnrollmentResponse: + id: GoogleCloudAssuredworkloadsV1WorkloadSaaEnrollmentResponse + description: Signed Access Approvals (SAA) enrollment response. + type: object + properties: + setupStatus: + description: Output only. Indicates SAA enrollment status of a given workload. + readOnly: true + type: string + enumDescriptions: + - Unspecified. + - SAA enrollment pending. + - SAA enrollment comopleted. + enum: + - SETUP_STATE_UNSPECIFIED + - STATUS_PENDING + - STATUS_COMPLETE + setupErrors: + description: Indicates SAA enrollment setup error if any. + type: array items: type: string - type: array + enumDescriptions: + - Unspecified. + - >- + Invalid states for all customers, to be redirected to AA UI for + additional details. + - Returned when there is not an EKM key configured. + - >- + Returned when there are no enrolled services or the customer is + enrolled in CAA only for a subset of services. + - >- + Returned when exception was encountered during evaluation of + other criteria. + enum: + - SETUP_ERROR_UNSPECIFIED + - ERROR_INVALID_BASE_SETUP + - ERROR_MISSING_EXTERNAL_SIGNING_KEY + - ERROR_NOT_ALL_SERVICES_ENROLLED + - ERROR_SETUP_CHECK_FAILED + GoogleCloudAssuredworkloadsV1WorkloadComplianceStatus: + id: GoogleCloudAssuredworkloadsV1WorkloadComplianceStatus + description: Represents the Compliance Status of this workload + type: object + properties: + activeViolationCount: + description: Number of current orgPolicy violations which are not acknowledged. + type: integer + format: int32 + acknowledgedViolationCount: + description: Number of current orgPolicy violations which are acknowledged. + type: integer + format: int32 + activeResourceViolationCount: + description: Number of current resource violations which are acknowledged. + type: integer + format: int32 + acknowledgedResourceViolationCount: + description: Number of current resource violations which are not acknowledged. + type: integer + format: int32 + GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions: + id: GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions + description: >- + Permissions granted to the AW Partner SA account for the customer + workload + type: object + properties: + dataLogsViewer: description: >- - Values that can resolve the violation For example: for list org - policy violations, this will either be the list of allowed or denied - values + Optional. Allow the partner to view inspectability logs and + monitoring violations. + type: boolean + serviceAccessApprover: + description: Optional. Allow partner to view access approval logs. + type: boolean + assuredWorkloadsMonitoring: + description: Optional. Allow partner to view violation alerts. + type: boolean + accessTransparencyLogsSupportCaseViewer: + description: Optional. Allow partner to view support case details for an AXT log + type: boolean + GoogleCloudAssuredworkloadsV1WorkloadEkmProvisioningResponse: + id: GoogleCloudAssuredworkloadsV1WorkloadEkmProvisioningResponse + description: External key management systems(EKM) Provisioning response + type: object + properties: + ekmProvisioningState: + description: >- + Output only. Indicates Ekm enrollment Provisioning of a given + workload. + readOnly: true + type: string + enumDescriptions: + - Default State for Ekm Provisioning + - Pending State for Ekm Provisioning + - Failed State for Ekm Provisioning + - Completed State for Ekm Provisioning + enum: + - EKM_PROVISIONING_STATE_UNSPECIFIED + - EKM_PROVISIONING_STATE_PENDING + - EKM_PROVISIONING_STATE_FAILED + - EKM_PROVISIONING_STATE_COMPLETED + ekmProvisioningErrorDomain: + description: Indicates Ekm provisioning error if any. + type: string + enumDescriptions: + - No error domain + - Error but domain is unspecified. + - Internal logic breaks within provisioning code. + - >- + Error occurred with the customer not granting permission/creating + resource. + - Error occurred within the partner's provisioning cluster. + - Resource wasn't provisioned in the required 7 day time period + enum: + - EKM_PROVISIONING_ERROR_DOMAIN_UNSPECIFIED + - UNSPECIFIED_ERROR + - GOOGLE_SERVER_ERROR + - EXTERNAL_USER_ERROR + - EXTERNAL_PARTNER_ERROR + - TIMEOUT_ERROR + ekmProvisioningErrorMapping: + description: Detailed error message if Ekm provisioning fails + type: string + enumDescriptions: + - Error is unspecified. + - Service account is used is invalid. + - Iam permission monitoring.MetricsScopeAdmin wasn't applied. + - Iam permission cloudkms.ekmConnectionsAdmin wasn't applied. + enum: + - EKM_PROVISIONING_ERROR_MAPPING_UNSPECIFIED + - INVALID_SERVICE_ACCOUNT + - MISSING_METRICS_SCOPE_ADMIN_PERMISSION + - MISSING_EKM_CONNECTION_ADMIN_PERMISSION + GoogleCloudAssuredworkloadsV1WorkloadWorkloadOptions: + id: GoogleCloudAssuredworkloadsV1WorkloadWorkloadOptions + description: Options to be set for the given created workload. + type: object + properties: + kajEnrollmentType: + description: Optional. Specifies type of KAJ Enrollment if provided. + type: string + enumDescriptions: + - KAJ Enrollment type is unspecified + - >- + KAT sets External, Hardware, and Software key feature logging only + to TRUE. + enum: + - KAJ_ENROLLMENT_TYPE_UNSPECIFIED + - KEY_ACCESS_TRANSPARENCY_OFF + GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesRequest: + id: GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesRequest + description: >- + Request for restricting list of available resources in Workload + environment. + type: object + properties: + restrictionType: + description: >- + Required. The type of restriction for using gcp products in the + Workload environment. + type: string + enumDescriptions: + - Unknown restriction type. + - >- + Allow the use all of all gcp products, irrespective of the + compliance posture. This effectively removes + gcp.restrictServiceUsage OrgPolicy on the AssuredWorkloads Folder. + - >- + Based on Workload's compliance regime, allowed list changes. See - + https://cloud.google.com/assured-workloads/docs/supported-products + for the list of supported resources. + - >- + Similar to ALLOW_COMPLIANT_RESOURCES but adds the list of + compliant resources to the existing list of compliant resources. + Effective org-policy of the Folder is considered to ensure there + is no disruption to the existing customer workflows. + enum: + - RESTRICTION_TYPE_UNSPECIFIED + - ALLOW_ALL_GCP_RESOURCES + - ALLOW_COMPLIANT_RESOURCES + - APPEND_COMPLIANT_RESOURCES + GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesResponse: + id: GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesResponse + description: Response for restricting the list of allowed resources. type: object - id: GoogleCloudAssuredworkloadsV1ViolationRemediation + properties: {} + GoogleProtobufEmpty: + id: GoogleProtobufEmpty description: >- - Represents remediation guidance to resolve compliance violation for - AssuredWorkload - GoogleCloudAssuredworkloadsV1WorkloadEkmProvisioningResponse: + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + type: object + properties: {} + GoogleCloudAssuredworkloadsV1AnalyzeWorkloadMoveResponse: + id: GoogleCloudAssuredworkloadsV1AnalyzeWorkloadMoveResponse + description: >- + Response containing the analysis results for the hypothetical resource + move. type: object properties: - ekmProvisioningErrorMapping: - enum: - - EKM_PROVISIONING_ERROR_MAPPING_UNSPECIFIED - - INVALID_SERVICE_ACCOUNT - - MISSING_METRICS_SCOPE_ADMIN_PERMISSION - - MISSING_EKM_CONNECTION_ADMIN_PERMISSION - enumDescriptions: - - Error is unspecified. - - Service account is used is invalid. - - Iam permission monitoring.MetricsScopeAdmin wasn't applied. - - Iam permission cloudkms.ekmConnectionsAdmin wasn't applied. + assetMoveAnalyses: + description: List of analysis results for each asset in scope. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1AssetMoveAnalysis + nextPageToken: + description: The next page token. Is empty if the last page is reached. type: string - description: Detailed error message if Ekm provisioning fails - ekmProvisioningErrorDomain: - enum: - - EKM_PROVISIONING_ERROR_DOMAIN_UNSPECIFIED - - UNSPECIFIED_ERROR - - GOOGLE_SERVER_ERROR - - EXTERNAL_USER_ERROR - - EXTERNAL_PARTNER_ERROR - - TIMEOUT_ERROR - description: Indicates Ekm provisioning error if any. - enumDescriptions: - - No error domain - - Error but domain is unspecified. - - Internal logic breaks within provisioning code. - - >- - Error occurred with the customer not granting permission/creating - resource. - - Error occurred within the partner's provisioning cluster. - - Resource wasn't provisioned in the required 7 day time period + GoogleCloudAssuredworkloadsV1AssetMoveAnalysis: + id: GoogleCloudAssuredworkloadsV1AssetMoveAnalysis + description: Represents move analysis results for an asset. + type: object + properties: + asset: + description: >- + The full resource name of the asset being analyzed. Example: + //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1 type: string - ekmProvisioningState: + assetType: + description: >- + Type of the asset being analyzed. Possible values will be among the + ones listed + [here](https://cloud.google.com/asset-inventory/docs/supported-asset-types). type: string - enum: - - EKM_PROVISIONING_STATE_UNSPECIFIED - - EKM_PROVISIONING_STATE_PENDING - - EKM_PROVISIONING_STATE_FAILED - - EKM_PROVISIONING_STATE_COMPLETED - description: Indicates Ekm enrollment Provisioning of a given workload. - enumDescriptions: - - Default State for Ekm Provisioning - - Pending State for Ekm Provisioning - - Failed State for Ekm Provisioning - - Completed State for Ekm Provisioning - description: External key management systems(EKM) Provisioning response - id: GoogleCloudAssuredworkloadsV1WorkloadEkmProvisioningResponse - GoogleCloudAssuredworkloadsV1WorkloadResourceSettings: - description: Represent the custom settings for the resources to be created. + analysisGroups: + description: List of eligible analyses performed for the asset. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1MoveAnalysisGroup + GoogleCloudAssuredworkloadsV1MoveAnalysisGroup: + id: GoogleCloudAssuredworkloadsV1MoveAnalysisGroup + description: >- + Represents a logical group of checks performed for an asset. If + successful, the group contains the analysis result, otherwise it + contains an error with the failure reason. type: object - id: GoogleCloudAssuredworkloadsV1WorkloadResourceSettings properties: + analysisResult: + description: Result of a successful analysis. + $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1MoveAnalysisResult' + error: + description: Error details for a failed analysis. + $ref: '#/components/schemas/GoogleRpcStatus' displayName: + description: Name of the analysis group. + type: string + GoogleCloudAssuredworkloadsV1MoveAnalysisResult: + id: GoogleCloudAssuredworkloadsV1MoveAnalysisResult + description: Represents the successful move analysis results for a group. + type: object + properties: + warnings: description: >- - User-assigned resource display name. If not empty it will be used to - create a resource with the specified name. + List of warnings. These are risks that may or may not result in + compliance violations. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1MoveImpact' + blockers: + description: >- + List of blockers. If not resolved, these will result in compliance + violations in the target. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1MoveImpact' + GoogleCloudAssuredworkloadsV1MoveImpact: + id: GoogleCloudAssuredworkloadsV1MoveImpact + description: Represents the impact of moving the asset to the target. + type: object + properties: + detail: + description: Explanation of the impact. type: string - resourceType: + GoogleCloudAssuredworkloadsV1ListWorkloadsResponse: + id: GoogleCloudAssuredworkloadsV1ListWorkloadsResponse + description: Response of ListWorkloads endpoint. + type: object + properties: + workloads: + description: List of Workloads under a given parent. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Workload' + nextPageToken: + description: The next page token. Return empty if reached the last page. type: string - enumDeprecated: - - false - - true - - false - - false - - false - enum: - - RESOURCE_TYPE_UNSPECIFIED - - CONSUMER_PROJECT - - CONSUMER_FOLDER - - ENCRYPTION_KEYS_PROJECT - - KEYRING + GoogleCloudAssuredworkloadsV1ListViolationsResponse: + id: GoogleCloudAssuredworkloadsV1ListViolationsResponse + description: Response of ListViolations endpoint. + type: object + properties: + violations: + description: List of Violations under a Workload. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Violation' + nextPageToken: + description: The next page token. Returns empty if reached the last page. + type: string + GoogleCloudAssuredworkloadsV1Violation: + id: GoogleCloudAssuredworkloadsV1Violation + description: Workload monitoring Violation. + type: object + properties: + name: description: >- - Indicates the type of resource. This field should be specified to - correspond the id to the right project type (CONSUMER_PROJECT or - ENCRYPTION_KEYS_PROJECT) + Output only. Immutable. Name of the Violation. Format: + organizations/{organization}/locations/{location}/workloads/{workload_id}/violations/{violations_id} + readOnly: true + type: string + description: + description: >- + Output only. Description for the Violation. e.g. OrgPolicy + gcp.resourceLocations has non compliant value. + readOnly: true + type: string + beginTime: + description: Output only. Time of the event which triggered the Violation. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. The last time when the Violation record was updated. + readOnly: true + type: string + format: google-datetime + resolveTime: + description: >- + Output only. Time of the event which fixed the Violation. If the + violation is ACTIVE this will be empty. + readOnly: true + type: string + format: google-datetime + category: + description: >- + Output only. Category under which this violation is mapped. e.g. + Location, Service Usage, Access, Encryption, etc. + readOnly: true + type: string + state: + description: Output only. State of the violation + readOnly: true + type: string enumDescriptions: - - Unknown resource type. - - >- - Deprecated. Existing workloads will continue to support this, but - new CreateWorkloadRequests should not specify this as an input - value. - - Consumer Folder. - - Consumer project containing encryption keys. - - Keyring resource that hosts encryption keys. - resourceId: + - Unspecified state. + - Violation is resolved. + - Violation is Unresolved + - Violation is Exception + enum: + - STATE_UNSPECIFIED + - RESOLVED + - UNRESOLVED + - EXCEPTION + orgPolicyConstraint: + description: >- + Output only. Immutable. The org-policy-constraint that was + incorrectly changed, which resulted in this violation. + readOnly: true + deprecated: true type: string + auditLogLink: description: >- - Resource identifier. For a project this represents project_id. If - the project is already taken, the workload creation will fail. For - KeyRing, this represents the keyring_id. For a folder, don't set - this value as folder_id is assigned by Google. - GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest: - properties: + Output only. Immutable. Audit Log Link for violated resource Format: + https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{timeRange}{folder} + readOnly: true + type: string nonCompliantOrgPolicy: description: >- - Optional. This field is deprecated and will be removed in future - version of the API. Name of the OrgPolicy which was modified with - non-compliant change and resulted in this violation. Format: + Output only. Immutable. Name of the OrgPolicy which was modified + with non-compliant change and resulted this violation. Format: projects/{project_number}/policies/{constraint_name} folders/{folder_id}/policies/{constraint_name} organizations/{organization_id}/policies/{constraint_name} + readOnly: true type: string - deprecated: true - acknowledgeType: + remediation: + description: Output only. Compliance violation remediation + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1ViolationRemediation + acknowledged: + description: A boolean that indicates if the violation is acknowledged + type: boolean + acknowledgementTime: + description: >- + Optional. Timestamp when this violation was acknowledged first. + Check exception_contexts to find the last time the violation was + acknowledged when there are more than one violations. This field + will be absent when acknowledged field is marked as false. type: string - enum: - - ACKNOWLEDGE_TYPE_UNSPECIFIED - - SINGLE_VIOLATION - - EXISTING_CHILD_RESOURCE_VIOLATIONS - description: Optional. Acknowledge type of specified violation. - enumDescriptions: - - Acknowledge type unspecified. - - Acknowledge only the specific violation. - - >- - Acknowledge specified orgPolicy violation and also associated - resource violations. - comment: + format: google-datetime + exceptionAuditLogLink: description: >- - Required. Business justification explaining the need for violation - acknowledgement + Output only. Immutable. Audit Log link to find business + justification provided for violation exception. Format: + https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{protoPayload.methodName}{timeRange}{organization} + readOnly: true type: string - type: object - description: Request for acknowledging the violation - id: GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest - GoogleLongrunningOperation: - type: object - description: >- - This resource represents a long-running operation that is the result of - a network API call. - id: GoogleLongrunningOperation - properties: - name: + exceptionContexts: description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. + Output only. List of all the exception detail added for the + violation. + readOnly: true + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1ViolationExceptionContext + violationType: + description: Output only. Type of the violation + readOnly: true type: string - metadata: - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: object + enumDescriptions: + - Unspecified type. + - Org Policy Violation. + - Resource Violation. + enum: + - VIOLATION_TYPE_UNSPECIFIED + - ORG_POLICY + - RESOURCE + associatedOrgPolicyViolationId: description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - done: + Optional. Output only. Violation Id of the org-policy violation due + to which the resource violation is caused. Empty for org-policy + violations. + readOnly: true + type: string + parentProjectNumber: description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - type: boolean - error: - $ref: '#/components/schemas/GoogleRpcStatus' + Optional. Output only. Parent project number where resource is + present. Empty for org-policy violations. + readOnly: true + type: string + resourceType: description: >- - The error result of the operation in case of failure or - cancellation. - response: + Optional. Output only. Type of the resource like + compute.googleapis.com/Disk, etc. Empty for org-policy violations. + readOnly: true + type: string + resourceName: description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - GoogleCloudAssuredworkloadsV1AcknowledgeViolationResponse: - description: Response for violation acknowledgement - id: GoogleCloudAssuredworkloadsV1AcknowledgeViolationResponse - properties: {} - type: object - GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsConsole: - description: Remediation instructions to resolve violation via cloud console - id: GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsConsole - properties: - steps: - description: Steps to resolve violation via cloud console - items: - type: string - type: array - additionalLinks: - description: Additional urls for more information about steps - items: - type: string - type: array - consoleUris: - items: - type: string - type: array - description: Link to console page where violations can be resolved - type: object - GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsGcloud: + Optional. Output only. Name of the resource like + //storage.googleapis.com/myprojectxyz-testbucket. Empty for + org-policy violations. + readOnly: true + type: string + GoogleCloudAssuredworkloadsV1ViolationRemediation: + id: GoogleCloudAssuredworkloadsV1ViolationRemediation + description: >- + Represents remediation guidance to resolve compliance violation for + AssuredWorkload type: object - id: GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsGcloud - description: Remediation instructions to resolve violation via gcloud cli properties: - additionalLinks: - items: - type: string - description: Additional urls for more information about steps - type: array - steps: - type: array - items: - type: string - description: Steps to resolve violation via gcloud cli - gcloudCommands: - description: Gcloud command to resolve violation + instructions: + description: Required. Remediation instructions to resolve violations + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1ViolationRemediationInstructions + compliantValues: + description: >- + Values that can resolve the violation For example: for list org + policy violations, this will either be the list of allowed or denied + values type: array items: type: string - GoogleCloudAssuredworkloadsV1MoveAnalysisGroup: - properties: - error: - $ref: '#/components/schemas/GoogleRpcStatus' - description: Error details for a failed analysis. - displayName: - description: Name of the analysis group. - type: string - analysisResult: - description: Result of a successful analysis. - $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1MoveAnalysisResult' - type: object - description: >- - Represents a logical group of checks performed for an asset. If - successful, the group contains the analysis result, otherwise it - contains an error with the failure reason. - id: GoogleCloudAssuredworkloadsV1MoveAnalysisGroup - GoogleCloudAssuredworkloadsV1WorkloadResourceInfo: - type: object - properties: - resourceId: - format: int64 - description: Resource identifier. For a project this represents project_number. - type: string - resourceType: - description: Indicates the type of resource. - enumDeprecated: - - false - - true - - false - - false - - false - enumDescriptions: - - Unknown resource type. - - >- - Deprecated. Existing workloads will continue to support this, but - new CreateWorkloadRequests should not specify this as an input - value. - - Consumer Folder. - - Consumer project containing encryption keys. - - Keyring resource that hosts encryption keys. + remediationType: + description: >- + Output only. Reemediation type based on the type of org policy + values violated + readOnly: true type: string - enum: - - RESOURCE_TYPE_UNSPECIFIED - - CONSUMER_PROJECT - - CONSUMER_FOLDER - - ENCRYPTION_KEYS_PROJECT - - KEYRING - id: GoogleCloudAssuredworkloadsV1WorkloadResourceInfo - description: Represent the resources that are children of this Workload. - GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesRequest: - properties: - restrictionType: enumDescriptions: - - Unknown restriction type. + - Unspecified remediation type + - Remediation type for boolean org policy - >- - Allow the use all of all gcp products, irrespective of the - compliance posture. This effectively removes - gcp.restrictServiceUsage OrgPolicy on the AssuredWorkloads Folder. + Remediation type for list org policy which have allowed values in + the monitoring rule - >- - Based on Workload's compliance regime, allowed list changes. See - - https://cloud.google.com/assured-workloads/docs/supported-products - for the list of supported resources. + Remediation type for list org policy which have denied values in + the monitoring rule + - Remediation type for gcp.restrictCmekCryptoKeyProjects + - Remediation type for resource violation. - >- - Similar to ALLOW_COMPLIANT_RESOURCES but adds the list of - compliant resources to the existing list of compliant resources. - Effective org-policy of the Folder is considered to ensure there - is no disruption to the existing customer workflows. + Remediation type for resource violation due to + gcp.restrictNonCmekServices enum: - - RESTRICTION_TYPE_UNSPECIFIED - - ALLOW_ALL_GCP_RESOURCES - - ALLOW_COMPLIANT_RESOURCES - - APPEND_COMPLIANT_RESOURCES - type: string - description: >- - Required. The type of restriction for using gcp products in the - Workload environment. - description: >- - Request for restricting list of available resources in Workload - environment. - id: GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesRequest + - REMEDIATION_TYPE_UNSPECIFIED + - REMEDIATION_BOOLEAN_ORG_POLICY_VIOLATION + - REMEDIATION_LIST_ALLOWED_VALUES_ORG_POLICY_VIOLATION + - REMEDIATION_LIST_DENIED_VALUES_ORG_POLICY_VIOLATION + - REMEDIATION_RESTRICT_CMEK_CRYPTO_KEY_PROJECTS_ORG_POLICY_VIOLATION + - REMEDIATION_RESOURCE_VIOLATION + - REMEDIATION_RESOURCE_VIOLATION_NON_CMEK_SERVICES + GoogleCloudAssuredworkloadsV1ViolationRemediationInstructions: + id: GoogleCloudAssuredworkloadsV1ViolationRemediationInstructions + description: Instructions to remediate violation type: object - GoogleCloudAssuredworkloadsV1WorkloadComplianceStatus: properties: - acknowledgedResourceViolationCount: - type: integer - description: Number of current resource violations which are not acknowledged. - format: int32 - activeViolationCount: - format: int32 - description: Number of current orgPolicy violations which are not acknowledged. - type: integer - acknowledgedViolationCount: - type: integer - description: Number of current orgPolicy violations which are acknowledged. - format: int32 - activeResourceViolationCount: - format: int32 - type: integer - description: Number of current resource violations which are acknowledged. - id: GoogleCloudAssuredworkloadsV1WorkloadComplianceStatus - description: Represents the Compliance Status of this workload - type: object - GoogleCloudAssuredworkloadsV1MoveAnalysisResult: - id: GoogleCloudAssuredworkloadsV1MoveAnalysisResult + gcloudInstructions: + description: Remediation instructions to resolve violation via gcloud cli + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsGcloud + consoleInstructions: + description: Remediation instructions to resolve violation via cloud console + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsConsole + GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsGcloud: + id: GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsGcloud + description: Remediation instructions to resolve violation via gcloud cli type: object properties: - blockers: + gcloudCommands: + description: Gcloud command to resolve violation type: array - description: >- - List of blockers. If not resolved, these will result in compliance - violations in the target. items: - $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1MoveImpact' - warnings: - description: >- - List of warnings. These are risks that may or may not result in - compliance violations. + type: string + steps: + description: Steps to resolve violation via gcloud cli type: array items: - $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1MoveImpact' - description: Represents the successful move analysis results for a group. - GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesResponse: - id: GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesResponse - description: Response for restricting the list of allowed resources. - properties: {} + type: string + additionalLinks: + description: Additional urls for more information about steps + type: array + items: + type: string + GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsConsole: + id: GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsConsole + description: Remediation instructions to resolve violation via cloud console type: object - GoogleLongrunningListOperationsResponse: properties: - nextPageToken: - type: string - description: The standard List next-page token. - operations: - description: >- - A list of operations that matches the specified filter in the - request. + consoleUris: + description: Link to console page where violations can be resolved + type: array items: - $ref: '#/components/schemas/GoogleLongrunningOperation' + type: string + steps: + description: Steps to resolve violation via cloud console type: array - type: object - id: GoogleLongrunningListOperationsResponse - description: The response message for Operations.ListOperations. - GoogleCloudAssuredworkloadsV1WorkloadKMSSettings: - deprecated: true + items: + type: string + additionalLinks: + description: Additional urls for more information about steps + type: array + items: + type: string + GoogleCloudAssuredworkloadsV1ViolationExceptionContext: + id: GoogleCloudAssuredworkloadsV1ViolationExceptionContext + description: Violation exception detail. type: object properties: - rotationPeriod: - format: google-duration + comment: description: >- - Required. Input only. Immutable. [next_rotation_time] will be - advanced by this period when the Key Management Service - automatically rotates a key. Must be at least 24 hours and at most - 876,000 hours. + Business justification provided towards the acknowledgement of the + violation. type: string - nextRotationTime: - format: google-datetime + acknowledgementTime: + description: Timestamp when the violation was acknowledged. type: string + format: google-datetime + userName: description: >- - Required. Input only. Immutable. The time at which the Key - Management Service will automatically create a new version of the - crypto key and mark it as the primary. - description: Settings specific to the Key Management Service. - id: GoogleCloudAssuredworkloadsV1WorkloadKMSSettings - GoogleCloudAssuredworkloadsV1Workload: + Name of the user (or service account) who acknowledged the + violation. + type: string + GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest: + id: GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest + description: Request for acknowledging the violation type: object properties: - resourceSettings: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadResourceSettings - description: >- - Input only. Resource properties that are used to customize workload - resources. These properties (such as custom project id) will be used - to create workload resources if possible. This field is optional. - provisionedResourcesParent: + comment: description: >- - Input only. The parent resource for the resources managed by this - Assured Workload. May be either empty or a folder resource which is - a child of the Workload parent. If not specified all resources are - created under the parent organization. Format: folders/{folder_id} + Required. Business justification explaining the need for violation + acknowledgement type: string - kmsSettings: + nonCompliantOrgPolicy: description: >- - Input only. Settings used to create a CMEK crypto key. When set, a - project with a KMS CMEK key is provisioned. This field is deprecated - as of Feb 28, 2022. In order to create a Keyring, callers should - specify, ENCRYPTION_KEYS_PROJECT or KEYRING in - ResourceSettings.resource_type field. - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadKMSSettings + Optional. This field is deprecated and will be removed in future + version of the API. Name of the OrgPolicy which was modified with + non-compliant change and resulted in this violation. Format: + projects/{project_number}/policies/{constraint_name} + folders/{folder_id}/policies/{constraint_name} + organizations/{organization_id}/policies/{constraint_name} deprecated: true - partner: + type: string + acknowledgeType: + description: Optional. Acknowledge type of specified violation. type: string enumDescriptions: - - '' - - Enum representing S3NS (Thales) partner. - - Enum representing T_SYSTEM (TSI) partner. - - Enum representing SIA_MINSAIT (Indra) partner. - - Enum representing PSN (TIM) partner. - - Enum representing CNTXT (Kingdom of Saudi Arabia) partner. + - Acknowledge type unspecified. + - Acknowledge only the specific violation. - >- - Enum representing CNTXT (Kingdom of Saudi Arabia) partner offering - without EKM. + Acknowledge specified orgPolicy violation and also associated + resource violations. enum: - - PARTNER_UNSPECIFIED - - LOCAL_CONTROLS_BY_S3NS - - SOVEREIGN_CONTROLS_BY_T_SYSTEMS - - SOVEREIGN_CONTROLS_BY_SIA_MINSAIT - - SOVEREIGN_CONTROLS_BY_PSN - - SOVEREIGN_CONTROLS_BY_CNTXT - - SOVEREIGN_CONTROLS_BY_CNTXT_NO_EKM - description: Optional. Partner regime associated with this workload. - resources: + - ACKNOWLEDGE_TYPE_UNSPECIFIED + - SINGLE_VIOLATION + - EXISTING_CHILD_RESOURCE_VIOLATIONS + GoogleCloudAssuredworkloadsV1AcknowledgeViolationResponse: + id: GoogleCloudAssuredworkloadsV1AcknowledgeViolationResponse + description: Response for violation acknowledgement + type: object + properties: {} + GoogleCloudAssuredworkloadsV1MutatePartnerPermissionsRequest: + id: GoogleCloudAssuredworkloadsV1MutatePartnerPermissionsRequest + description: Request for updating permission settings for a partner workload. + type: object + properties: + partnerPermissions: + description: Required. The partner permissions to be updated. + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions + updateMask: description: >- - Output only. The resources associated with this workload. These - resources will be created when creating the workload. If any of the - projects already exist, the workload creation will fail. Always read - only. - items: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadResourceInfo - readOnly: true + Required. The list of fields to be updated. E.g. update_mask { + paths: "partner_permissions.data_logs_viewer"} + type: string + format: google-fieldmask + etag: + description: >- + Optional. The etag of the workload. If this is provided, it must + match the server's etag. + type: string + GoogleCloudAssuredworkloadsV1EnableResourceMonitoringResponse: + id: GoogleCloudAssuredworkloadsV1EnableResourceMonitoringResponse + description: Response for EnableResourceMonitoring endpoint. + type: object + properties: {} + GoogleCloudAssuredworkloadsV1EnableComplianceUpdatesResponse: + id: GoogleCloudAssuredworkloadsV1EnableComplianceUpdatesResponse + description: Response for EnableComplianceUpdates endpoint. + type: object + properties: {} + GoogleCloudAssuredworkloadsV1ListWorkloadUpdatesResponse: + id: GoogleCloudAssuredworkloadsV1ListWorkloadUpdatesResponse + description: Response of listing the compliance updates per workload with pagination. + type: object + properties: + workloadUpdates: + description: The list of workload updates for a given workload. type: array - enableSovereignControls: - type: boolean + items: + $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadUpdate' + nextPageToken: + description: The next page token. Return empty if reached the last page. + type: string + GoogleCloudAssuredworkloadsV1WorkloadUpdate: + id: GoogleCloudAssuredworkloadsV1WorkloadUpdate + description: >- + A workload update is a change to the workload's compliance + configuration. + type: object + properties: + name: description: >- - Optional. Indicates the sovereignty status of the given workload. - Currently meant to be used by Europe/Canada customers. - createTime: + Output only. Immutable. Identifier. Resource name of the + WorkloadUpdate. Format: + organizations/{organization}/locations/{location}/workloads/{workload}/updates/{update} readOnly: true type: string - description: Output only. Immutable. The Workload creation timestamp. - format: google-datetime - labels: - description: Optional. Labels applied to the workload. - type: object - additionalProperties: - type: string - partnerServicesBillingAccount: - type: string - description: >- - Optional. Billing account necessary for purchasing services from - Sovereign Partners. This field is required for creating - SIA/PSN/CNTXT partner workloads. The caller should have - 'billing.resourceAssociations.create' IAM permission on this - billing-account. The format of this string is - billingAccounts/AAAAAA-BBBBBB-CCCCCC - etag: + state: + description: Output only. The state of the update. + readOnly: true type: string - description: >- - Optional. ETag of the workload, it is calculated on the basis of the - Workload contents. It will be used in Update & Delete operations. - kajEnrollmentState: + enumDescriptions: + - Unspecified. + - The update is available to be applied. + - The update has been applied. + - The update has been withdrawn by the service. enum: - - KAJ_ENROLLMENT_STATE_UNSPECIFIED - - KAJ_ENROLLMENT_STATE_PENDING - - KAJ_ENROLLMENT_STATE_COMPLETE + - STATE_UNSPECIFIED + - AVAILABLE + - APPLIED + - WITHDRAWN + createTime: + description: The time the update was created. type: string - enumDescriptions: - - Default State for KAJ Enrollment. - - Pending State for KAJ Enrollment. - - Complete State for KAJ Enrollment. - description: >- - Output only. Represents the KAJ enrollment state of the given - workload. - readOnly: true - billingAccount: - description: >- - Optional. The billing account used for the resources which are - direct children of workload. This billing account is initially - associated with the resources created as part of Workload creation. - After the initial creation of these resources, the customer can - change the assigned billing account. The resource name has the form - `billingAccounts/{billing_account_id}`. For example, - `billingAccounts/012345-567890-ABCDEF`. + format: google-datetime + updateTime: + description: The time the update was last updated. type: string - violationNotificationsEnabled: + format: google-datetime + details: + description: The details of the update. + $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1UpdateDetails' + GoogleCloudAssuredworkloadsV1UpdateDetails: + id: GoogleCloudAssuredworkloadsV1UpdateDetails + description: The details of the update. + type: object + properties: + orgPolicyUpdate: + description: Update to one org policy, e.g. gcp.resourceLocation. + $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1OrgPolicyUpdate' + GoogleCloudAssuredworkloadsV1OrgPolicyUpdate: + id: GoogleCloudAssuredworkloadsV1OrgPolicyUpdate + description: >- + Represents an update for an org policy control applied on an Assured + Workload resource. The inherited org policy is not considered. + type: object + properties: + appliedPolicy: + description: The org policy currently applied on the assured workload resource. + $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1OrgPolicy' + suggestedPolicy: + description: The suggested org policy that replaces the applied policy. + $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1OrgPolicy' + GoogleCloudAssuredworkloadsV1OrgPolicy: + id: GoogleCloudAssuredworkloadsV1OrgPolicy + description: >- + This assured workload service object is used to represent the org policy + attached to a resource. It servces the same purpose as the + orgpolicy.v2.Policy object but with functionality that is limited to + what is supported by Assured Workloads(e.g. only one rule under one + OrgPolicy object, no conditions, etc). + type: object + properties: + resource: description: >- - Optional. Indicates whether the e-mail notification for a violation - is enabled for a workload. This value will be by default True, and - if not present will be considered as true. This should only be - updated via updateWorkload call. Any Changes to this field during - the createWorkload call will not be honored. This will always be - true while creating the workload. - type: boolean - resourceMonitoringEnabled: - readOnly: true - type: boolean + Resource that the OrgPolicy attaches to. Format: folders/123" + projects/123". + type: string + constraint: description: >- - Output only. Indicates whether resource monitoring is enabled for - workload or not. It is true when Resource feed is subscribed to AWM - topic and AWM Service Agent Role is binded to AW Service Account for - resource Assured workload. - partnerPermissions: + The constraint name of the OrgPolicy. e.g. + "constraints/gcp.resourceLocations". + type: string + rule: + description: The rule of the OrgPolicy. $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions + #/components/schemas/GoogleCloudAssuredworkloadsV1OrgPolicyPolicyRule + inherit: description: >- - Optional. Permissions granted to the AW Partner SA account for the - customer workload - saaEnrollmentResponse: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadSaaEnrollmentResponse - readOnly: true + If `inherit` is true, policy rules of the lowest ancestor in the + resource hierarchy chain are inherited. If it is false, policy rules + are not inherited. + type: boolean + reset: description: >- - Output only. Represents the SAA enrollment response of the given - workload. SAA enrollment response is queried during GetWorkload - call. In failure cases, user friendly error message is shown in SAA - details page. - workloadOptions: + Ignores policies set above this resource and restores to the + `constraint_default` value. `reset` can only be true when `rules` is + empty and `inherit` is false. + type: boolean + GoogleCloudAssuredworkloadsV1OrgPolicyPolicyRule: + id: GoogleCloudAssuredworkloadsV1OrgPolicyPolicyRule + description: A rule used to express this policy. + type: object + properties: + values: + description: ListPolicy only when custom values are specified. $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadWorkloadOptions - description: Optional. Options to be set for the given created workload. - compliantButDisallowedServices: - readOnly: true + #/components/schemas/GoogleCloudAssuredworkloadsV1OrgPolicyPolicyRuleStringValues + allowAll: + description: ListPolicy only when all values are allowed. + type: boolean + denyAll: + description: ListPolicy only when all values are denied. + type: boolean + enforce: + description: BooleanPolicy only. + type: boolean + GoogleCloudAssuredworkloadsV1OrgPolicyPolicyRuleStringValues: + id: GoogleCloudAssuredworkloadsV1OrgPolicyPolicyRuleStringValues + description: The values allowed for a ListPolicy. + type: object + properties: + allowedValues: + description: List of values allowed at this resource. + type: array items: type: string + deniedValues: + description: List of values denied at this resource. type: array - description: >- - Output only. Urls for services which are compliant for this Assured - Workload, but which are currently disallowed by the - ResourceUsageRestriction org policy. Invoke RestrictAllowedResources - endpoint to allow your project developers to use these services in - their environment. - complianceRegime: - description: >- - Required. Immutable. Compliance Regime associated with this - workload. + items: + type: string + GoogleCloudAssuredworkloadsV1ApplyWorkloadUpdateRequest: + id: GoogleCloudAssuredworkloadsV1ApplyWorkloadUpdateRequest + description: Request to apply update to a workload. + type: object + properties: + action: + description: The action to be performed on the update. type: string enumDescriptions: - - Unknown compliance regime. - - Information protection as per DoD IL4 requirements. - - Criminal Justice Information Services (CJIS) Security policies. - - FedRAMP High data protection controls - - FedRAMP Moderate data protection controls - - Assured Workloads For US Regions data protection controls - - Health Insurance Portability and Accountability Act controls - - Health Information Trust Alliance controls - - Assured Workloads For EU Regions and Support controls - - Assured Workloads For Canada Regions and Support controls - - International Traffic in Arms Regulations - - Assured Workloads for Australia Regions and Support controls - - Assured Workloads for Partners; - - Assured Workloads for Israel Regions - - Assured Workloads for Israel Regions - - Assured Workloads for Canada Protected B regime - - Information protection as per DoD IL5 requirements. - - Information protection as per DoD IL2 requirements. - - Assured Workloads for Japan Regions - - Assured Workloads Sovereign Controls KSA - - Assured Workloads for Regional Controls - - Healthcare and Life Science Controls - - Healthcare and Life Science Controls with US Support - - Internal Revenue Service 1075 controls + - Unspecified value. + - The update is applied. enum: - - COMPLIANCE_REGIME_UNSPECIFIED - - IL4 - - CJIS - - FEDRAMP_HIGH - - FEDRAMP_MODERATE - - US_REGIONAL_ACCESS - - HIPAA - - HITRUST - - EU_REGIONS_AND_SUPPORT - - CA_REGIONS_AND_SUPPORT - - ITAR - - AU_REGIONS_AND_US_SUPPORT - - ASSURED_WORKLOADS_FOR_PARTNERS - - ISR_REGIONS - - ISR_REGIONS_AND_SUPPORT - - CA_PROTECTED_B - - IL5 - - IL2 - - JP_REGIONS_AND_SUPPORT - - KSA_REGIONS_AND_SUPPORT_WITH_SOVEREIGNTY_CONTROLS - - REGIONAL_CONTROLS - - HEALTHCARE_AND_LIFE_SCIENCES_CONTROLS - - HEALTHCARE_AND_LIFE_SCIENCES_CONTROLS_US_SUPPORT - - IRS_1075 - displayName: - description: >- - Required. The user-assigned display name of the Workload. When - present it must be between 4 to 30 characters. Allowed characters - are: lowercase and uppercase letters, numbers, hyphen, and spaces. - Example: My Workload - type: string - complianceStatus: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadComplianceStatus - description: Output only. Count of active Violations in the Workload. - readOnly: true - name: - type: string - description: >- - Optional. The resource name of the workload. Format: - organizations/{organization}/locations/{location}/workloads/{workload} - Read-only. - ekmProvisioningResponse: - description: >- - Output only. Represents the Ekm Provisioning State of the given - workload. - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadEkmProvisioningResponse - id: GoogleCloudAssuredworkloadsV1Workload - description: >- - A Workload object for managing highly regulated workloads of cloud - customers. + - WORKLOAD_UPDATE_ACTION_UNSPECIFIED + - APPLY GoogleCloudAssuredworkloadsV1CreateWorkloadOperationMetadata: + id: GoogleCloudAssuredworkloadsV1CreateWorkloadOperationMetadata + description: Operation metadata to give request details of CreateWorkload. + type: object properties: - displayName: - type: string - description: Optional. The display name of the workload. createTime: description: Optional. Time when the operation was created. + type: string format: google-datetime + displayName: + description: Optional. The display name of the workload. + type: string + parent: + description: Optional. The parent of the workload. type: string complianceRegime: + description: >- + Optional. Compliance controls that should be applied to the + resources managed by the workload. type: string enumDescriptions: - Unknown compliance regime. @@ -911,8 +1388,10 @@ components: - FedRAMP High data protection controls - FedRAMP Moderate data protection controls - Assured Workloads For US Regions data protection controls - - Health Insurance Portability and Accountability Act controls - - Health Information Trust Alliance controls + - >- + [DEPRECATED] Health Insurance Portability and Accountability Act + controls + - '[DEPRECATED] Health Information Trust Alliance controls' - Assured Workloads For EU Regions and Support controls - Assured Workloads For Canada Regions and Support controls - International Traffic in Arms Regulations @@ -929,9 +1408,73 @@ components: - Healthcare and Life Science Controls - Healthcare and Life Science Controls with US Support - Internal Revenue Service 1075 controls - description: >- - Optional. Compliance controls that should be applied to the - resources managed by the workload. + - Canada Controlled Goods + - Australia Data Boundary and Support + - Canada Data Boundary and Support + - Data Boundary for Canada Controlled Goods + - Data Boundary for Canada Protected B + - Data Boundary for CJIS + - Data Boundary for FedRAMP High + - Data Boundary for FedRAMP Moderate + - Data Boundary for IL2 + - Data Boundary for IL4 + - Data Boundary for IL5 + - Data Boundary for IRS Publication 1075 + - Data Boundary for ITAR + - Data Boundary for EU Regions and Support + - Data Boundary for Israel Regions + - Data Boundary for US Regions and Support + - Data Boundary for US Healthcare and Life Sciences + - Data Boundary for US Healthcare and Life Sciences with Support + - KSA Data Boundary with Access Justifications + - Regional Data Boundary + - JAPAN Data Boundary + enumDeprecated: + - false + - false + - false + - false + - false + - false + - true + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false enum: - COMPLIANCE_REGIME_UNSPECIFIED - IL4 @@ -957,257 +1500,62 @@ components: - HEALTHCARE_AND_LIFE_SCIENCES_CONTROLS - HEALTHCARE_AND_LIFE_SCIENCES_CONTROLS_US_SUPPORT - IRS_1075 - parent: - type: string - description: Optional. The parent of the workload. - id: GoogleCloudAssuredworkloadsV1CreateWorkloadOperationMetadata - description: Operation metadata to give request details of CreateWorkload. + - CANADA_CONTROLLED_GOODS + - AUSTRALIA_DATA_BOUNDARY_AND_SUPPORT + - CANADA_DATA_BOUNDARY_AND_SUPPORT + - DATA_BOUNDARY_FOR_CANADA_CONTROLLED_GOODS + - DATA_BOUNDARY_FOR_CANADA_PROTECTED_B + - DATA_BOUNDARY_FOR_CJIS + - DATA_BOUNDARY_FOR_FEDRAMP_HIGH + - DATA_BOUNDARY_FOR_FEDRAMP_MODERATE + - DATA_BOUNDARY_FOR_IL2 + - DATA_BOUNDARY_FOR_IL4 + - DATA_BOUNDARY_FOR_IL5 + - DATA_BOUNDARY_FOR_IRS_PUBLICATION_1075 + - DATA_BOUNDARY_FOR_ITAR + - EU_DATA_BOUNDARY_AND_SUPPORT + - ISRAEL_DATA_BOUNDARY_AND_SUPPORT + - US_DATA_BOUNDARY_AND_SUPPORT + - US_DATA_BOUNDARY_FOR_HEALTHCARE_AND_LIFE_SCIENCES + - US_DATA_BOUNDARY_FOR_HEALTHCARE_AND_LIFE_SCIENCES_WITH_SUPPORT + - KSA_DATA_BOUNDARY_WITH_ACCESS_JUSTIFICATIONS + - REGIONAL_DATA_BOUNDARY + - JAPAN_DATA_BOUNDARY + GoogleCloudAssuredworkloadsV1ApplyWorkloadUpdateResponse: + id: GoogleCloudAssuredworkloadsV1ApplyWorkloadUpdateResponse + description: Response for ApplyWorkloadUpdate endpoint. type: object - GoogleCloudAssuredworkloadsV1Violation: properties: - updateTime: - format: google-datetime - readOnly: true - description: Output only. The last time when the Violation record was updated. - type: string - state: - enum: - - STATE_UNSPECIFIED - - RESOLVED - - UNRESOLVED - - EXCEPTION - type: string - readOnly: true - enumDescriptions: - - Unspecified state. - - Violation is resolved. - - Violation is Unresolved - - Violation is Exception - description: Output only. State of the violation - remediation: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1ViolationRemediation - description: Output only. Compliance violation remediation - readOnly: true - associatedOrgPolicyViolationId: - type: string - description: >- - Optional. Output only. Violation Id of the org-policy violation due - to which the resource violation is caused. Empty for org-policy - violations. - readOnly: true - description: - type: string - description: >- - Output only. Description for the Violation. e.g. OrgPolicy - gcp.resourceLocations has non compliant value. - readOnly: true - resolveTime: - format: google-datetime - readOnly: true - description: >- - Output only. Time of the event which fixed the Violation. If the - violation is ACTIVE this will be empty. - type: string - auditLogLink: - description: >- - Output only. Immutable. Audit Log Link for violated resource Format: - https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{timeRange}{folder} - type: string - readOnly: true - exceptionAuditLogLink: - description: >- - Output only. Immutable. Audit Log link to find business - justification provided for violation exception. Format: - https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{protoPayload.methodName}{timeRange}{organization} - readOnly: true - type: string - name: + appliedUpdate: + description: The update that was applied. + $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadUpdate' + GoogleCloudAssuredworkloadsV1ApplyWorkloadUpdateOperationMetadata: + id: GoogleCloudAssuredworkloadsV1ApplyWorkloadUpdateOperationMetadata + description: Operation metadata to give request details of ApplyWorkloadUpdate. + type: object + properties: + updateName: + description: Required. The resource name of the update type: string - description: >- - Output only. Immutable. Name of the Violation. Format: - organizations/{organization}/locations/{location}/workloads/{workload_id}/violations/{violations_id} + createTime: + description: Optional. Output only. The time the operation was created. readOnly: true - acknowledgementTime: type: string - description: >- - Optional. Timestamp when this violation was acknowledged first. - Check exception_contexts to find the last time the violation was - acknowledged when there are more than one violations. This field - will be absent when acknowledged field is marked as false. format: google-datetime - violationType: - readOnly: true - description: Output only. Type of the violation + action: + description: Optional. The time the operation was created. type: string enumDescriptions: - - Unspecified type. - - Org Policy Violation. - - Resource Violation. - enum: - - VIOLATION_TYPE_UNSPECIFIED - - ORG_POLICY - - RESOURCE - resourceName: - type: string - description: >- - Optional. Output only. Name of the resource like - //storage.googleapis.com/myprojectxyz-testbucket. Empty for - org-policy violations. - readOnly: true - parentProjectNumber: - description: >- - Optional. Output only. Parent project number where resource is - present. Empty for org-policy violations. - readOnly: true - type: string - resourceType: - description: >- - Optional. Output only. Type of the resource like - compute.googleapis.com/Disk, etc. Empty for org-policy violations. - type: string - readOnly: true - category: - description: >- - Output only. Category under which this violation is mapped. e.g. - Location, Service Usage, Access, Encryption, etc. - readOnly: true - type: string - exceptionContexts: - readOnly: true - items: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1ViolationExceptionContext - type: array - description: >- - Output only. List of all the exception detail added for the - violation. - orgPolicyConstraint: - description: >- - Output only. Immutable. The org-policy-constraint that was - incorrectly changed, which resulted in this violation. - type: string - deprecated: true - readOnly: true - beginTime: - readOnly: true - format: google-datetime - description: Output only. Time of the event which triggered the Violation. - type: string - nonCompliantOrgPolicy: - description: >- - Output only. Immutable. Name of the OrgPolicy which was modified - with non-compliant change and resulted this violation. Format: - projects/{project_number}/policies/{constraint_name} - folders/{folder_id}/policies/{constraint_name} - organizations/{organization_id}/policies/{constraint_name} - readOnly: true - type: string - acknowledged: - type: boolean - description: A boolean that indicates if the violation is acknowledged - description: Workload monitoring Violation. - id: GoogleCloudAssuredworkloadsV1Violation - type: object - GoogleCloudAssuredworkloadsV1ListViolationsResponse: - id: GoogleCloudAssuredworkloadsV1ListViolationsResponse - description: Response of ListViolations endpoint. - properties: - nextPageToken: - type: string - description: The next page token. Returns empty if reached the last page. - violations: - items: - $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Violation' - type: array - description: List of Violations under a Workload. - type: object - GoogleCloudAssuredworkloadsV1WorkloadWorkloadOptions: - id: GoogleCloudAssuredworkloadsV1WorkloadWorkloadOptions - description: Options to be set for the given created workload. - type: object - properties: - kajEnrollmentType: + - Unspecified value. + - The update is applied. enum: - - KAJ_ENROLLMENT_TYPE_UNSPECIFIED - - KEY_ACCESS_TRANSPARENCY_OFF - type: string - description: Optional. Specifies type of KAJ Enrollment if provided. - enumDescriptions: - - KAJ Enrollment type is unspecified - - >- - KAT sets External, Hardware, and Software key feature logging only - to TRUE. (no enforcement) - GoogleCloudAssuredworkloadsV1ViolationRemediationInstructions: - id: GoogleCloudAssuredworkloadsV1ViolationRemediationInstructions - type: object - properties: - consoleInstructions: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsConsole - description: Remediation instructions to resolve violation via cloud console - gcloudInstructions: - description: Remediation instructions to resolve violation via gcloud cli - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsGcloud - description: Instructions to remediate violation - GoogleCloudAssuredworkloadsV1AssetMoveAnalysis: - properties: - asset: - type: string - description: >- - The full resource name of the asset being analyzed. Example: - //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1 - assetType: - type: string - description: >- - Type of the asset being analyzed. Possible values will be among the - ones listed - [here](https://cloud.google.com/asset-inventory/docs/supported-asset-types). - analysisGroups: - description: List of eligible analyses performed for the asset. - items: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1MoveAnalysisGroup - type: array - id: GoogleCloudAssuredworkloadsV1AssetMoveAnalysis - description: Represents move analysis results for an asset. - type: object + - WORKLOAD_UPDATE_ACTION_UNSPECIFIED + - APPLY parameters: - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string - oauth_token: - description: OAuth 2.0 token for the current user. - in: query - name: oauth_token - schema: - type: string - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - type: string - callback: - description: JSONP + access_token: + description: OAuth access token. in: query - name: callback + name: access_token schema: type: string alt: @@ -1220,15 +1568,18 @@ components: - json - media - proto - _.xgafv: - description: V1 error format. + callback: + description: JSONP in: query - name: $.xgafv + name: callback + schema: + type: string + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields schema: type: string - enum: - - '1' - - '2' key: description: >- API key. Your API key identifies your project and provides you with API @@ -1238,6 +1589,18 @@ components: 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 @@ -1247,25 +1610,76 @@ components: name: quotaUser schema: type: string - access_token: - description: OAuth access token. + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: access_token + name: upload_protocol + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv schema: type: string + enum: + - '1' + - '2' x-stackQL-resources: + operations: + id: google.assuredworkloads.operations + name: operations + title: Operations + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1operations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.operations + get: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' + insert: [] + update: [] + replace: [] + delete: [] workloads: id: google.assuredworkloads.workloads name: workloads title: Workloads methods: - delete: + create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.workloads patch: operation: $ref: >- @@ -1273,25 +1687,24 @@ components: response: mediaType: application/json openAPIDocKey: '200' - get: + delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}/delete response: mediaType: application/json openAPIDocKey: '200' - list: + get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.workloads - create: + restrict_allowed_resources: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads/post + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}:restrictAllowedResources/post response: mediaType: application/json openAPIDocKey: '200' @@ -1302,24 +1715,24 @@ components: response: mediaType: application/json openAPIDocKey: '200' - enable_resource_monitoring: + mutate_partner_permissions: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}:enableResourceMonitoring/post + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}:mutatePartnerPermissions/patch response: mediaType: application/json openAPIDocKey: '200' - mutate_partner_permissions: + enable_resource_monitoring: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}:mutatePartnerPermissions/patch + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}:enableResourceMonitoring/post response: mediaType: application/json openAPIDocKey: '200' - restrict_allowed_resources: + enable_compliance_updates: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}:restrictAllowedResources/post + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}:enableComplianceUpdates/put response: mediaType: application/json openAPIDocKey: '200' @@ -1347,17 +1760,17 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.violations - acknowledge: + get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}~1violations~1{violationsId}:acknowledge/post + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}~1violations~1{violationsId}/get response: mediaType: application/json openAPIDocKey: '200' - get: + acknowledge: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}~1violations~1{violationsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}~1violations~1{violationsId}:acknowledge/post response: mediaType: application/json openAPIDocKey: '200' @@ -1369,57 +1782,164 @@ components: update: [] replace: [] delete: [] - operations: - id: google.assuredworkloads.operations - name: operations - title: Operations + updates: + id: google.assuredworkloads.updates + name: updates + title: Updates methods: - get: + list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1operations~1{operationsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}~1updates/get response: mediaType: application/json openAPIDocKey: '200' - list: + objectKey: $.workloadUpdates + apply: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1operations/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}~1updates~1{updatesId}:apply/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.operations sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' + - $ref: '#/components/x-stackQL-resources/updates/methods/list' insert: [] update: [] replace: [] delete: [] paths: - /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}: + /v1/organizations/{organizationsId}/locations/{locationsId}/operations: parameters: &ref_1 + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/access_token' - delete: + get: description: >- - Deletes the workload. Make sure that workload's direct children are - already in a deleted state, otherwise the request will fail with a - FAILED_PRECONDITION error. In addition to - assuredworkloads.workload.delete permission, the user should also have - orgpolicy.policy.set permission on the deleted folder to remove Assured - Workloads OrgPolicies. - operationId: assuredworkloads.organizations.locations.workloads.delete + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: assuredworkloads.organizations.locations.operations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: assuredworkloads.organizations.locations.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/workloads: + parameters: *ref_1 + post: + description: Creates Assured Workload. + operationId: assuredworkloads.organizations.locations.workloads.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Workload' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: externalId + schema: + type: string + get: + description: Lists Assured Workloads under a CRM Node. + operationId: assuredworkloads.organizations.locations.workloads.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1431,7 +1951,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1ListWorkloadsResponse parameters: - in: path name: organizationsId @@ -1443,15 +1964,21 @@ paths: required: true schema: type: string - - in: path - name: workloadsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - in: query - name: etag + name: filter schema: type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}: + parameters: *ref_1 patch: description: >- Updates an existing workload. Currently allows updating of workload @@ -1496,9 +2023,15 @@ paths: schema: type: string format: google-fieldmask - get: - description: Gets Assured Workload associated with a CRM Node - operationId: assuredworkloads.organizations.locations.workloads.get + delete: + description: >- + Deletes the workload. Make sure that workload's direct children are + already in a deleted state, otherwise the request will fail with a + FAILED_PRECONDITION error. In addition to + assuredworkloads.workload.delete permission, the user should also have + orgpolicy.policy.set permission on the deleted folder to remove Assured + Workloads OrgPolicies. + operationId: assuredworkloads.organizations.locations.workloads.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1510,7 +2043,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Workload' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -1527,11 +2060,13 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/workloads: - parameters: *ref_1 + - in: query + name: etag + schema: + type: string get: - description: Lists Assured Workloads under a CRM Node. - operationId: assuredworkloads.organizations.locations.workloads.list + description: Gets Assured Workload associated with a CRM Node + operationId: assuredworkloads.organizations.locations.workloads.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1543,8 +2078,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1ListWorkloadsResponse + $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Workload' parameters: - in: path name: organizationsId @@ -1556,27 +2090,29 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + - in: path + name: workloadsId + required: true schema: type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:restrictAllowedResources: + parameters: *ref_1 post: - description: Creates Assured Workload. - operationId: assuredworkloads.organizations.locations.workloads.create + description: >- + Restrict the list of resources allowed in the Workload environment. The + current list of allowed products can be found at + https://cloud.google.com/assured-workloads/docs/supported-products In + addition to assuredworkloads.workload.update permission, the user should + also have orgpolicy.policy.set permission on the folder resource to use + this functionality. + operationId: >- + assuredworkloads.organizations.locations.workloads.restrictAllowedResources requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Workload' + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1588,7 +2124,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesResponse parameters: - in: path name: organizationsId @@ -1600,8 +2137,9 @@ paths: required: true schema: type: string - - in: query - name: externalId + - in: path + name: workloadsId + required: true schema: type: string /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:analyzeWorkloadMove: @@ -1641,6 +2179,10 @@ paths: required: true schema: type: string + - in: query + name: project + schema: + type: string - in: query name: pageSize schema: @@ -1650,20 +2192,25 @@ paths: name: pageToken schema: type: string - - in: query - name: project - schema: - type: string - in: query name: assetTypes schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:enableResourceMonitoring: + /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:mutatePartnerPermissions: parameters: *ref_1 - post: - description: Enable resource violation monitoring for a workload. + patch: + description: >- + Update the permissions settings for an existing partner workload. For + force updates don't set etag field in the Workload. Only one update + operation per workload can be in progress. operationId: >- - assuredworkloads.organizations.locations.workloads.enableResourceMonitoring + assuredworkloads.organizations.locations.workloads.mutatePartnerPermissions + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1MutatePartnerPermissionsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1675,8 +2222,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1EnableResourceMonitoringResponse + $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Workload' parameters: - in: path name: organizationsId @@ -1693,21 +2239,12 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:mutatePartnerPermissions: + /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:enableResourceMonitoring: parameters: *ref_1 - patch: - description: >- - Update the permissions settings for an existing partner workload. For - force updates don't set etag field in the Workload. Only one update - operation per workload can be in progress. + post: + description: Enable resource violation monitoring for a workload. operationId: >- - assuredworkloads.organizations.locations.workloads.mutatePartnerPermissions - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1MutatePartnerPermissionsRequest + assuredworkloads.organizations.locations.workloads.enableResourceMonitoring security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1719,7 +2256,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Workload' + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1EnableResourceMonitoringResponse parameters: - in: path name: organizationsId @@ -1736,24 +2274,19 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:restrictAllowedResources: + /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:enableComplianceUpdates: parameters: *ref_1 - post: + put: description: >- - Restrict the list of resources allowed in the Workload environment. The - current list of allowed products can be found at - https://cloud.google.com/assured-workloads/docs/supported-products In - addition to assuredworkloads.workload.update permission, the user should - also have orgpolicy.policy.set permission on the folder resource to use - this functionality. + This endpoint enables Assured Workloads service to offer compliance + updates for the folder based assured workload. It sets up an Assured + Workloads Service Agent, having permissions to read compliance controls + (for example: Org Policies) applied on the workload. The caller must + have `resourcemanager.folders.getIamPolicy` and + `resourcemanager.folders.setIamPolicy` permissions on the assured + workload folder. operationId: >- - assuredworkloads.organizations.locations.workloads.restrictAllowedResources - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesRequest + assuredworkloads.organizations.locations.workloads.enableComplianceUpdates security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1766,7 +2299,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesResponse + #/components/schemas/GoogleCloudAssuredworkloadsV1EnableComplianceUpdatesResponse parameters: - in: path name: organizationsId @@ -1823,14 +2356,15 @@ paths: schema: type: string - in: query - name: interval.endTime + name: interval.startTime schema: type: string format: google-datetime - in: query - name: filter + name: interval.endTime schema: type: string + format: google-datetime - in: query name: pageSize schema: @@ -1841,26 +2375,14 @@ paths: schema: type: string - in: query - name: interval.startTime + name: filter schema: type: string - format: google-datetime - /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations/{violationsId}:acknowledge: + /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations/{violationsId}: parameters: *ref_1 - post: - description: >- - Acknowledges an existing violation. By acknowledging a violation, users - acknowledge the existence of a compliance violation in their workload - and decide to ignore it due to a valid business justification. - Acknowledgement is a permanent operation and it cannot be reverted. - operationId: >- - assuredworkloads.organizations.locations.workloads.violations.acknowledge - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest + get: + description: Retrieves Assured Workload Violation based on ID. + operationId: assuredworkloads.organizations.locations.workloads.violations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1872,8 +2394,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1AcknowledgeViolationResponse + $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Violation' parameters: - in: path name: organizationsId @@ -1895,11 +2416,22 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations/{violationsId}: + /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations/{violationsId}:acknowledge: parameters: *ref_1 - get: - description: Retrieves Assured Workload Violation based on ID. - operationId: assuredworkloads.organizations.locations.workloads.violations.get + post: + description: >- + Acknowledges an existing violation. By acknowledging a violation, users + acknowledge the existence of a compliance violation in their workload + and decide to ignore it due to a valid business justification. + Acknowledgement is a permanent operation and it cannot be reverted. + operationId: >- + assuredworkloads.organizations.locations.workloads.violations.acknowledge + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1911,7 +2443,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Violation' + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1AcknowledgeViolationResponse parameters: - in: path name: organizationsId @@ -1933,14 +2466,11 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}: + /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/updates: parameters: *ref_1 get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: assuredworkloads.organizations.locations.operations.get + description: This endpoint lists all updates for the given workload. + operationId: assuredworkloads.organizations.locations.workloads.updates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1952,7 +2482,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1ListWorkloadUpdatesResponse parameters: - in: path name: organizationsId @@ -1965,17 +2496,30 @@ paths: schema: type: string - in: path - name: operationsId + name: workloadsId required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/operations: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/updates/{updatesId}:apply: parameters: *ref_1 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: assuredworkloads.organizations.locations.operations.list + post: + description: This endpoint creates a new operation to apply the given update. + operationId: assuredworkloads.organizations.locations.workloads.updates.apply + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1ApplyWorkloadUpdateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1987,7 +2531,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -1999,16 +2543,13 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: workloadsId + required: true schema: type: string - - in: query - name: filter + - in: path + name: updatesId + required: true schema: type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/backupdr.yaml b/providers/src/googleapis.com/v00.00.00000/services/backupdr.yaml index 6a31d08f..f381cd84 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/backupdr.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/backupdr.yaml @@ -7,8 +7,8 @@ info: title: Backup and DR Service API description: '' version: v1 - x-discovery-doc-revision: '20241023' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250825' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/backup-disaster-recovery servers: @@ -477,6 +477,49 @@ components: description: The request message for Operations.CancelOperation. type: object properties: {} + SubscribeTrialRequest: + id: SubscribeTrialRequest + description: Request message for subscribing to a trial. + type: object + properties: {} + Trial: + id: Trial + description: Represents a Trial for a project. + type: object + properties: + name: + description: >- + Identifier. The resource name of the trial. Format: + projects/{project}/locations/{location}/trial + type: string + state: + description: Output only. The state of the trial. + readOnly: true + type: string + enumDescriptions: + - State not set. + - Trial is subscribed. + - Trial is unsubscribed before expiration. + - Trial is expired post 30 days of subscription. + - Trial is eligible for enablement. + - Trial is not eligible for enablement. + enum: + - STATE_UNSPECIFIED + - SUBSCRIBED + - UNSUBSCRIBED + - EXPIRED + - ELIGIBLE + - NOT_ELIGIBLE + startTime: + description: Output only. The time when the trial was subscribed. + readOnly: true + type: string + format: google-datetime + endTime: + description: Output only. The time when the trial will expire. + readOnly: true + type: string + format: google-datetime ListManagementServersResponse: id: ListManagementServersResponse description: Response message for listing management servers. @@ -696,6 +739,24 @@ components: Providers. readOnly: true type: string + FetchMsComplianceMetadataRequest: + id: FetchMsComplianceMetadataRequest + description: Request message for GetMsComplianceMetadata + type: object + properties: + projectId: + description: Required. The project id of the target project + type: string + FetchMsComplianceMetadataResponse: + id: FetchMsComplianceMetadataResponse + description: Response message for GetMsComplianceMetadata + type: object + properties: + isAssuredWorkload: + description: >- + The ms compliance metadata of the target project, if the project is + an assured workloads project, values will be true, otherwise false. + type: boolean BackupVault: id: BackupVault description: Message describing a BackupVault object. @@ -761,12 +822,14 @@ components: - The backup vault has been created and is fully usable. - The backup vault is being deleted. - The backup vault is experiencing an issue and might be unusable. + - The backup vault is being updated. enum: - STATE_UNSPECIFIED - CREATING - ACTIVE - DELETING - ERROR + - UPDATING effectiveTime: description: Optional. Time after which the BackupVault resource is locked. type: string @@ -791,8 +854,8 @@ components: format: int64 uid: description: >- - Output only. Output only Immutable after resource creation until - resource deletion. + Output only. Immutable after resource creation until resource + deletion. readOnly: true type: string annotations: @@ -806,9 +869,9 @@ components: accessRestriction: description: >- Optional. Note: This field is added for future use case and will not - be supported in the current release. Optional. Access restriction - for the backup vault. Default value is WITHIN_ORGANIZATION if not - provided during creation. + be supported in the current release. Access restriction for the + backup vault. Default value is WITHIN_ORGANIZATION if not provided + during creation. type: string enumDescriptions: - >- @@ -994,6 +1057,12 @@ components: dataSourceBackupApplianceApplication: description: The backed up resource is a backup appliance application. $ref: '#/components/schemas/DataSourceBackupApplianceApplication' + backupBlockedByVaultAccessRestriction: + description: >- + Output only. This field is set to true if the backup is blocked by + vault access restriction. + readOnly: true + type: boolean BackupConfigInfo: id: BackupConfigInfo description: >- @@ -1060,6 +1129,12 @@ components: type: array items: type: string + backupPlanRevisionName: + description: The name of the backup plan revision. + type: string + backupPlanRevisionId: + description: The user friendly id of the backup plan revision. E.g. v0, v1 etc. + type: string BackupApplianceBackupConfig: id: BackupApplianceBackupConfig description: >- @@ -1117,6 +1192,18 @@ components: ComputeInstanceDataSourceProperties has a subset of Compute Instance properties that are useful at the Datasource level. $ref: '#/components/schemas/ComputeInstanceDataSourceProperties' + cloudSqlInstanceDatasourceProperties: + description: >- + Output only. CloudSqlInstanceDataSourceProperties has a subset of + Cloud SQL Instance properties that are useful at the Datasource + level. + readOnly: true + $ref: '#/components/schemas/CloudSqlInstanceDataSourceProperties' + diskDatasourceProperties: + description: >- + DiskDataSourceProperties has a subset of Disk properties that are + useful at the Datasource level. + $ref: '#/components/schemas/DiskDataSourceProperties' ComputeInstanceDataSourceProperties: id: ComputeInstanceDataSourceProperties description: >- @@ -1141,6 +1228,56 @@ components: description: The sum of all the disk sizes. type: string format: int64 + CloudSqlInstanceDataSourceProperties: + id: CloudSqlInstanceDataSourceProperties + description: >- + CloudSqlInstanceDataSourceProperties represents the properties of a + Cloud SQL resource that are stored in the DataSource. + type: object + properties: + name: + description: >- + Output only. Name of the Cloud SQL instance backed up by the + datasource. Format: projects/{project}/instances/{instance} + readOnly: true + type: string + databaseInstalledVersion: + description: >- + Output only. The installed database version of the Cloud SQL + instance. + readOnly: true + type: string + instanceCreateTime: + description: Output only. The instance creation timestamp. + readOnly: true + type: string + format: google-datetime + instanceTier: + description: >- + Output only. The tier (or machine type) for this instance. Example: + `db-custom-1-3840` + readOnly: true + type: string + DiskDataSourceProperties: + id: DiskDataSourceProperties + description: >- + DiskDataSourceProperties represents the properties of a Disk resource + that are stored in the DataSource. . + type: object + properties: + name: + description: Name of the disk backed up by the datasource. + type: string + description: + description: The description of the disk. + type: string + type: + description: The type of the disk. + type: string + sizeGb: + description: The size of the disk in GB. + type: string + format: int64 DataSourceBackupApplianceApplication: id: DataSourceBackupApplianceApplication description: >- @@ -1472,12 +1609,14 @@ components: - The backup has been created and is fully usable. - The backup is being deleted. - The backup is experiencing an issue and might be unusable. + - The backup is being uploaded. enum: - STATE_UNSPECIFIED - CREATING - ACTIVE - DELETING - ERROR + - UPLOADING serviceLocks: description: >- Output only. The list of BackupLocks taken by the service to prevent @@ -1497,10 +1636,18 @@ components: description: Output only. Compute Engine specific backup properties. readOnly: true $ref: '#/components/schemas/ComputeInstanceBackupProperties' + cloudSqlInstanceBackupProperties: + description: Output only. Cloud SQL specific backup properties. + readOnly: true + $ref: '#/components/schemas/CloudSqlInstanceBackupProperties' backupApplianceBackupProperties: description: Output only. Backup Appliance specific backup properties. readOnly: true $ref: '#/components/schemas/BackupApplianceBackupProperties' + diskBackupProperties: + description: Output only. Disk specific backup properties. + readOnly: true + $ref: '#/components/schemas/DiskBackupProperties' backupType: description: Output only. Type of the backup, unspecified, scheduled or ondemand. readOnly: true @@ -1509,10 +1656,12 @@ components: - Backup type is unspecified. - Scheduled backup. - On demand backup. + - Operational backup. enum: - BACKUP_TYPE_UNSPECIFIED - SCHEDULED - ON_DEMAND + - ON_DEMAND_OPERATIONAL gcpBackupPlanInfo: description: Output only. Configuration for a Google Cloud resource. readOnly: true @@ -1524,6 +1673,14 @@ components: readOnly: true type: string format: int64 + satisfiesPzs: + description: Optional. Output only. Reserved for future use. + readOnly: true + type: boolean + satisfiesPzi: + description: Optional. Output only. Reserved for future use. + readOnly: true + type: boolean BackupLock: id: BackupLock description: >- @@ -2304,6 +2461,35 @@ components: instance. type: integer format: int32 + CloudSqlInstanceBackupProperties: + id: CloudSqlInstanceBackupProperties + description: >- + CloudSqlInstanceBackupProperties represents Cloud SQL Instance Backup + properties. + type: object + properties: + databaseInstalledVersion: + description: >- + Output only. The installed database version of the Cloud SQL + instance when the backup was taken. + readOnly: true + type: string + finalBackup: + description: Output only. Whether the backup is a final backup. + readOnly: true + type: boolean + sourceInstance: + description: >- + Output only. The source instance of the backup. Format: + projects/{project}/instances/{instance} + readOnly: true + type: string + instanceTier: + description: >- + Output only. The tier (or machine type) for this instance. Example: + `db-custom-1-3840` + readOnly: true + type: string BackupApplianceBackupProperties: id: BackupApplianceBackupProperties description: >- @@ -2333,6 +2519,91 @@ components: description: Optional. The latest timestamp of data available in this Backup. type: string format: google-datetime + DiskBackupProperties: + id: DiskBackupProperties + description: DiskBackupProperties represents the properties of a Disk backup. + type: object + properties: + description: + description: A description of the source disk. + type: string + licenses: + description: >- + A list of publicly available licenses that are applicable to this + backup. This is applicable if the original image had licenses + attached, e.g. Windows image. + type: array + items: + type: string + guestOsFeature: + description: A list of guest OS features that are applicable to this backup. + type: array + items: + $ref: '#/components/schemas/GuestOsFeature' + architecture: + description: >- + The architecture of the source disk. Valid values are ARM64 or + X86_64. + type: string + enumDescriptions: + - Default value. This value is unused. + - Disks with architecture X86_64 + - Disks with architecture ARM64 + enum: + - ARCHITECTURE_UNSPECIFIED + - X86_64 + - ARM64 + type: + description: The URL of the type of the disk. + type: string + sizeGb: + description: Size(in GB) of the source disk. + type: string + format: int64 + region: + description: >- + Region and zone are mutually exclusive fields. The URL of the region + of the source disk. + type: string + zone: + description: The URL of the Zone where the source disk. + type: string + replicaZones: + description: The URL of the Zones where the source disk should be replicated. + type: array + items: + type: string + sourceDisk: + description: The source disk used to create this backup. + type: string + accessMode: + description: The access mode of the source disk. + type: string + provisionedIops: + description: The number of IOPS provisioned for the source disk. + type: string + format: int64 + provisionedThroughput: + description: The number of throughput provisioned for the source disk. + type: string + format: int64 + physicalBlockSizeBytes: + description: The physical block size of the source disk. + type: string + format: int64 + enableConfidentialCompute: + description: >- + Indicates whether the source disk is using confidential compute + mode. + type: boolean + storagePool: + description: The storage pool of the source disk. + type: string + labels: + description: The labels of the source disk. + type: object + additionalProperties: + type: string GCPBackupPlanInfo: id: GCPBackupPlanInfo description: >- @@ -2351,6 +2622,19 @@ components: The rule id of the backup plan which triggered this backup in case of scheduled backup or used for type: string + backupPlanRevisionName: + description: >- + Resource name of the backup plan revision which triggered this + backup in case of scheduled backup or used for on demand backup. + Format: + projects/{project}/locations/{location}/backupPlans/{backupPlanId}/revisions/{revisionId} + type: string + backupPlanRevisionId: + description: >- + The user friendly id of the backup plan revision which triggered + this backup in case of scheduled backup or used for on demand + backup. + type: string RestoreBackupRequest: id: RestoreBackupRequest description: Request message for restoring from a Backup. @@ -2374,9 +2658,18 @@ components: computeInstanceTargetEnvironment: description: Compute Engine target environment to be used during restore. $ref: '#/components/schemas/ComputeInstanceTargetEnvironment' + diskTargetEnvironment: + description: Disk target environment to be used during restore. + $ref: '#/components/schemas/DiskTargetEnvironment' + regionDiskTargetEnvironment: + description: Region disk target environment to be used during restore. + $ref: '#/components/schemas/RegionDiskTargetEnvironment' computeInstanceRestoreProperties: description: Compute Engine instance properties to be overridden during restore. $ref: '#/components/schemas/ComputeInstanceRestoreProperties' + diskRestoreProperties: + description: Disk properties to be overridden during restore. + $ref: '#/components/schemas/DiskRestoreProperties' ComputeInstanceTargetEnvironment: id: ComputeInstanceTargetEnvironment description: >- @@ -2390,6 +2683,35 @@ components: zone: description: Required. The zone of the Compute Engine instance. type: string + DiskTargetEnvironment: + id: DiskTargetEnvironment + description: DiskTargetEnvironment represents the target environment for the disk. + type: object + properties: + project: + description: Required. Target project for the disk. + type: string + zone: + description: Required. Target zone for the disk. + type: string + RegionDiskTargetEnvironment: + id: RegionDiskTargetEnvironment + description: >- + RegionDiskTargetEnvironment represents the target environment for the + disk. + type: object + properties: + project: + description: Required. Target project for the disk. + type: string + region: + description: Required. Target region for the disk. + type: string + replicaZones: + description: Required. Target URLs of the replica zones for the disk. + type: array + items: + type: string ComputeInstanceRestoreProperties: id: ComputeInstanceRestoreProperties description: >- @@ -2422,7 +2744,9 @@ components: disks: description: >- Optional. Array of disks associated with this instance. Persistent - disks must be created before you can assign them. + disks must be created before you can assign them. Source regional + persistent disks will be restored with default replica zones if not + specified. type: array items: $ref: '#/components/schemas/AttachedDisk' @@ -2481,7 +2805,8 @@ components: Optional. 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. + interfaces are supported per instance. Required to restore in + different project or region. type: array items: $ref: '#/components/schemas/NetworkInterface' @@ -2526,7 +2851,9 @@ components: from. $ref: '#/components/schemas/AllocationAffinity' resourcePolicies: - description: Optional. Resource policies applied to this instance. + description: >- + Optional. Resource policies applied to this instance. By default, no + resource policies will be applied. type: array items: type: string @@ -2651,6 +2978,127 @@ components: type: array items: type: string + DiskRestoreProperties: + id: DiskRestoreProperties + description: DiskRestoreProperties represents the properties of a Disk restore. + type: object + properties: + name: + description: Required. Name of the disk. + type: string + description: + description: >- + Optional. An optional description of this resource. Provide this + property when you create the resource. + type: string + sizeGb: + description: Required. The size of the disk in GB. + type: string + format: int64 + licenses: + description: >- + Optional. A list of publicly available licenses that are applicable + to this backup. This is applicable if the original image had + licenses attached, e.g. Windows image + type: array + items: + type: string + guestOsFeature: + description: >- + Optional. A list of features to enable in the guest operating + system. This is applicable only for bootable images. + type: array + items: + $ref: '#/components/schemas/GuestOsFeature' + diskEncryptionKey: + description: >- + Optional. Encrypts the disk using a customer-supplied encryption key + or a customer-managed encryption key. + $ref: '#/components/schemas/CustomerEncryptionKey' + physicalBlockSizeBytes: + description: >- + Optional. Physical block size of the persistent disk, in bytes. If + not present in a request, a default value is used. Currently, the + supported size is 4096. + type: string + format: int64 + provisionedIops: + description: >- + Optional. Indicates how many IOPS to provision for the disk. This + sets the number of I/O operations per second that the disk can + handle. + type: string + format: int64 + provisionedThroughput: + description: >- + Optional. Indicates how much throughput to provision for the disk. + This sets the number of throughput MB per second that the disk can + handle. + type: string + format: int64 + enableConfidentialCompute: + description: >- + Optional. Indicates whether this disk is using confidential compute + mode. Encryption with a Cloud KMS key is required to enable this + option. + type: boolean + storagePool: + description: >- + Optional. The storage pool in which the new disk is created. You can + provide this as a partial or full URL to the resource. + type: string + accessMode: + description: Optional. The access mode of the disk. + type: string + enumDescriptions: + - >- + The default AccessMode, means the disk can be attached to single + instance in RW mode. + - >- + The AccessMode means the disk can be attached to multiple + instances in RW mode. + - >- + The AccessMode means the disk can be attached to multiple + instances in RO mode. + enum: + - READ_WRITE_SINGLE + - READ_WRITE_MANY + - READ_ONLY_MANY + architecture: + description: >- + Optional. The architecture of the source disk. Valid values are + ARM64 or X86_64. + type: string + enumDescriptions: + - Default value. This value is unused. + - Disks with architecture X86_64 + - Disks with architecture ARM64 + enum: + - ARCHITECTURE_UNSPECIFIED + - X86_64 + - ARM64 + resourcePolicy: + description: Optional. Resource policies applied to this disk. + type: array + items: + type: string + type: + description: >- + Required. URL of the disk type resource describing which disk type + to use to create the disk. + type: string + labels: + description: >- + Optional. Labels to apply to this disk. These can be modified later + using setLabels method. Label values can be empty. + type: object + additionalProperties: + type: string + resourceManagerTags: + description: Optional. Resource manager tags to be bound to the disk. + type: object + additionalProperties: + type: string BackupPlan: id: BackupPlan description: >- @@ -2694,9 +3142,7 @@ components: type: string format: google-datetime backupRules: - description: >- - Required. The backup rules for this `BackupPlan`. There must be at - least one `BackupRule` message. + description: Optional. The backup rules for this `BackupPlan`. type: array items: $ref: '#/components/schemas/BackupRule' @@ -2710,18 +3156,20 @@ components: - The resource has been created and is fully usable. - The resource is being deleted. - The resource has been created but is not usable. + - The resource is being updated. enum: - STATE_UNSPECIFIED - CREATING - ACTIVE - DELETING - INACTIVE + - UPDATING resourceType: description: >- Required. The resource type to which the `BackupPlan` will be applied. Examples include, "compute.googleapis.com/Instance", - "sqladmin.googleapis.com/Instance" and - "storage.googleapis.com/Bucket". + "sqladmin.googleapis.com/Instance", + "alloydb.googleapis.com/Cluster", "compute.googleapis.com/Disk". type: string etag: description: >- @@ -2742,6 +3190,32 @@ components: Backup Vault Service Account. readOnly: true type: string + logRetentionDays: + description: >- + Optional. Applicable only for CloudSQL resource_type. Configures how + long logs will be stored. It is defined in “days”. This value should + be greater than or equal to minimum enforced log retention duration + of the backup vault. + type: string + format: int64 + supportedResourceTypes: + description: Output only. All resource types to which backupPlan can be applied. + readOnly: true + type: array + items: + type: string + revisionId: + description: >- + Output only. The user friendly revision ID of the + `BackupPlanRevision`. Example: v0, v1, v2, etc. + readOnly: true + type: string + revisionName: + description: >- + Output only. The resource id of the `BackupPlanRevision`. Format: + `projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision_id}` + readOnly: true + type: string BackupRule: id: BackupRule description: '`BackupRule` binds the backup schedule to a retention policy.' @@ -2758,12 +3232,15 @@ components: description: >- Required. Configures the duration for which backup data will be kept. It is defined in “days”. The value should be greater than or - equal to minimum enforced retention of the backup vault. + equal to minimum enforced retention of the backup vault. Minimum + value is 1 and maximum value is 36159 for custom retention on-demand + backup. Minimum and maximum values are workload specific for all + other rules. type: integer format: int32 standardSchedule: description: >- - Required. Defines a schedule that runs within the confines of a + Optional. Defines a schedule that runs within the confines of a defined window of time. $ref: '#/components/schemas/StandardSchedule' StandardSchedule: @@ -2798,7 +3275,7 @@ components: defined. This is required for `recurrence_type`, `HOURLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `HOURLY`. Value of hourly - frequency should be between 6 and 23. Reason for limit : We found + frequency should be between 4 and 23. Reason for limit : We found that there is bandwidth limitation of 3GB/S for GMI while taking a backup and 5GB/S while doing a restore. Given the amount of parallel backups and restore we are targeting, this will potentially take the @@ -3001,33 +3478,110 @@ components: type: array items: type: string - BackupPlanAssociation: - id: BackupPlanAssociation + BackupPlanRevision: + id: BackupPlanRevision description: >- - A BackupPlanAssociation represents a single BackupPlanAssociation which - contains details like workload, backup plan etc + `BackupPlanRevision` represents a snapshot of a `BackupPlan` at a point + in time. type: object properties: name: description: >- - Output only. Identifier. The resource name of BackupPlanAssociation - in below format Format : - projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId} + Output only. Identifier. The resource name of the + `BackupPlanRevision`. Format: + `projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision}` readOnly: true type: string - resourceType: - description: Optional. Resource type of workload on which backupplan is applied - type: string - resource: - description: >- - Required. Immutable. Resource name of workload on which backupplan - is applied - type: string - backupPlan: + revisionId: description: >- - Required. Resource name of backup plan which needs to be applied on - workload. Format: - projects/{project}/locations/{location}/backupPlans/{backupPlanId} + Output only. The user friendly revision ID of the + `BackupPlanRevision`. Example: v0, v1, v2, etc. + readOnly: true + type: string + state: + description: Output only. Resource State + readOnly: true + type: string + enumDescriptions: + - State not set. + - The resource is being created. + - The resource has been created and is fully usable. + - The resource is being deleted. + - The resource has been created but is not usable. + enum: + - STATE_UNSPECIFIED + - CREATING + - ACTIVE + - DELETING + - INACTIVE + backupPlanSnapshot: + description: The Backup Plan being encompassed by this revision. + $ref: '#/components/schemas/BackupPlan' + createTime: + description: Output only. The timestamp that the revision was created. + readOnly: true + type: string + format: google-datetime + ListBackupPlanRevisionsResponse: + id: ListBackupPlanRevisionsResponse + description: The response message for getting a list of `BackupPlanRevision`. + type: object + properties: + backupPlanRevisions: + description: >- + The list of `BackupPlanRevisions` in the project for the specified + location. If the `{location}` value in the request is "-", the + response contains a list of resources from all locations. In case + any location is unreachable, the response will only return backup + plans in reachable locations and the 'unreachable' field will be + populated with a list of unreachable locations. + type: array + items: + $ref: '#/components/schemas/BackupPlanRevision' + nextPageToken: + description: >- + A token which may be sent as page_token in a subsequent + `ListBackupPlanRevisions` call to retrieve the next page of results. + If this field is omitted or empty, then there are no more results to + return. + type: string + unreachable: + description: Locations that could not be reached. + type: array + items: + type: string + BackupPlanAssociation: + id: BackupPlanAssociation + description: >- + A BackupPlanAssociation represents a single BackupPlanAssociation which + contains details like workload, backup plan etc + type: object + properties: + name: + description: >- + Output only. Identifier. The resource name of BackupPlanAssociation + in below format Format : + projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId} + readOnly: true + type: string + resourceType: + description: >- + Required. Immutable. Resource type of workload on which backupplan + is applied + type: string + resource: + description: >- + Required. Immutable. Resource name of workload on which the backup + plan is applied. The format can either be the resource name (e.g., + "projects/my-project/zones/us-central1-a/instances/my-instance") or + the full resource URI (e.g., + "https://www.googleapis.com/compute/v1/projects/my-project/zones/us-central1-a/instances/my-instance"). + type: string + backupPlan: + description: >- + Required. Resource name of backup plan which needs to be applied on + workload. Format: + projects/{project}/locations/{location}/backupPlans/{backupPlanId} type: string createTime: description: Output only. The time when the instance was created. @@ -3065,18 +3619,36 @@ components: $ref: '#/components/schemas/RuleConfigInfo' dataSource: description: >- - Output only. Output Only. Resource name of data source which will be - used as storage location for backups taken. Format : + Output only. Resource name of data source which will be used as + storage location for backups taken. Format : projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource} readOnly: true type: string + cloudSqlInstanceBackupPlanAssociationProperties: + description: >- + Output only. Cloud SQL instance's backup plan association + properties. + readOnly: true + $ref: '#/components/schemas/CloudSqlInstanceBackupPlanAssociationProperties' + backupPlanRevisionId: + description: >- + Output only. The user friendly revision ID of the + `BackupPlanRevision`. Example: v0, v1, v2, etc. + readOnly: true + type: string + backupPlanRevisionName: + description: >- + Output only. The resource id of the `BackupPlanRevision`. Format: + `projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision_id}` + readOnly: true + type: string RuleConfigInfo: id: RuleConfigInfo description: Message for rules config info. type: object properties: ruleId: - description: Output only. Output Only. Backup Rule id fetched from backup plan. + description: Output only. Backup Rule id fetched from backup plan. readOnly: true type: string lastBackupState: @@ -3099,8 +3671,8 @@ components: - FAILED lastBackupError: description: >- - Output only. Output Only. google.rpc.Status object to store the last - backup error. + Output only. google.rpc.Status object to store the last backup + error. readOnly: true $ref: '#/components/schemas/Status' lastSuccessfulBackupConsistencyTime: @@ -3110,6 +3682,16 @@ components: readOnly: true type: string format: google-datetime + CloudSqlInstanceBackupPlanAssociationProperties: + id: CloudSqlInstanceBackupPlanAssociationProperties + description: Cloud SQL instance's BPA properties. + type: object + properties: + instanceCreateTime: + description: Output only. The time when the instance was created. + readOnly: true + type: string + format: google-datetime ListBackupPlanAssociationsResponse: id: ListBackupPlanAssociationsResponse description: Response message for List BackupPlanAssociation @@ -3135,13 +3717,34 @@ components: type: array items: type: string + FetchBackupPlanAssociationsForResourceTypeResponse: + id: FetchBackupPlanAssociationsForResourceTypeResponse + description: Response for the FetchBackupPlanAssociationsForResourceType method. + type: object + properties: + backupPlanAssociations: + description: Output only. The BackupPlanAssociations from the specified parent. + readOnly: true + type: array + items: + $ref: '#/components/schemas/BackupPlanAssociation' + nextPageToken: + description: >- + Output only. A token, which can be sent as `page_token` to retrieve + the next page. If this field is omitted, there are no subsequent + pages. + readOnly: true + type: string TriggerBackupRequest: id: TriggerBackupRequest description: Request message for triggering a backup. type: object properties: ruleId: - description: Required. backup rule_id for which a backup needs to be triggered. + description: >- + Optional. backup rule_id for which a backup needs to be triggered. + If not specified, on-demand backup with custom retention will be + triggered. type: string requestId: description: >- @@ -3158,144 +3761,623 @@ components: with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). type: string - ListLocationsResponse: - id: ListLocationsResponse - description: The response message for Locations.ListLocations. + DataSourceReference: + id: DataSourceReference + description: DataSourceReference is a reference to a DataSource resource. type: object properties: - locations: + name: description: >- - A list of locations that matches the specified filter in the - request. - type: array - items: - $ref: '#/components/schemas/Location' - nextPageToken: - description: The standard List next-page token. + Identifier. The resource name of the DataSourceReference. Format: + projects/{project}/locations/{location}/dataSourceReferences/{data_source_reference} type: string - Location: - id: Location - description: A resource that represents a Google Cloud location. - type: object - properties: - name: + dataSource: description: >- - Resource name for the location, which may vary between - implementations. For example: - `"projects/example-project/locations/us-east1"` + Output only. The resource name of the DataSource. Format: + projects/{project}/locations/{location}/backupVaults/{backupVault}/dataSources/{dataSource} + readOnly: true type: string - locationId: - description: 'The canonical id for this location. For example: `"us-east1"`.' + createTime: + description: Output only. The time when the DataSourceReference was created. + readOnly: true type: string - displayName: - description: >- - The friendly name for this location, typically a nearby city name. - For example, "Tokyo". + format: google-datetime + dataSourceBackupConfigState: + description: Output only. The backup configuration state of the DataSource. + readOnly: true type: string - labels: - description: >- - Cross-service attributes for the location. For example - {"cloud.googleapis.com/region": "us-east1"} - type: object - additionalProperties: - type: string - metadata: + enumDescriptions: + - The possible states of backup configuration. Status not set. + - >- + The data source is actively protected (i.e. there is a + BackupPlanAssociation or Appliance SLA pointing to it) + - >- + The data source is no longer protected (but may have backups under + it) + enum: + - BACKUP_CONFIG_STATE_UNSPECIFIED + - ACTIVE + - PASSIVE + dataSourceBackupCount: + description: Output only. Number of backups in the DataSource. + readOnly: true + type: string + format: int64 + dataSourceBackupConfigInfo: + description: Output only. Information of backup configuration on the DataSource. + readOnly: true + $ref: '#/components/schemas/DataSourceBackupConfigInfo' + dataSourceGcpResourceInfo: description: >- - Service-specific metadata. For example the available capacity at the - given location. - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - OperationMetadata: - id: OperationMetadata - description: Represents the metadata of the long-running operation. + Output only. The GCP resource that the DataSource is associated + with. + readOnly: true + $ref: '#/components/schemas/DataSourceGcpResourceInfo' + DataSourceBackupConfigInfo: + id: DataSourceBackupConfigInfo + description: Information of backup configuration on the DataSource. type: object properties: - createTime: - description: Output only. The time the operation was created. + lastBackupState: + description: Output only. The status of the last backup in this DataSource readOnly: true type: string - format: google-datetime - endTime: - description: Output only. The time the operation finished running. + enumDescriptions: + - Status not set. + - The first backup has not yet completed + - The most recent backup was successful + - The most recent backup failed + - >- + The most recent backup could not be run/failed because of the lack + of permissions + enum: + - LAST_BACKUP_STATE_UNSPECIFIED + - FIRST_BACKUP_PENDING + - SUCCEEDED + - FAILED + - PERMISSION_DENIED + lastSuccessfulBackupConsistencyTime: + description: >- + Output only. Timestamp of the last successful backup to this + DataSource. readOnly: true type: string format: google-datetime - target: + DataSourceGcpResourceInfo: + id: DataSourceGcpResourceInfo + description: The GCP resource that the DataSource is associated with. + type: object + properties: + gcpResourcename: description: >- - Output only. Server-defined resource path for the target of the - operation. + Output only. The resource name of the GCP resource. Ex: + projects/{project}/zones/{zone}/instances/{instance} readOnly: true type: string - verb: - description: Output only. Name of the verb executed by the operation. + type: + description: >- + Output only. The type of the GCP resource. Ex: + compute.googleapis.com/Instance readOnly: true type: string - statusMessage: - description: Output only. Human-readable status of the operation, if any. + location: + description: >- + Output only. The location of the GCP resource. Ex: + //"global"/"unspecified" readOnly: true type: string - requestedCancellation: + cloudSqlInstanceProperties: + description: Output only. The properties of the Cloud SQL instance. + readOnly: true + $ref: '#/components/schemas/CloudSqlInstanceDataSourceReferenceProperties' + CloudSqlInstanceDataSourceReferenceProperties: + id: CloudSqlInstanceDataSourceReferenceProperties + description: >- + CloudSqlInstanceDataSourceReferenceProperties represents the properties + of a Cloud SQL resource that are stored in the DataSourceReference. + type: object + properties: + name: description: >- - Output only. Identifies whether the user has requested cancellation - of the operation. Operations that have successfully been cancelled - have Operation.error value with a google.rpc.Status.code of 1, - corresponding to 'Code.CANCELLED'. + Output only. Name of the Cloud SQL instance backed up by the + datasource. Format: projects/{project}/instances/{instance} readOnly: true - type: boolean - apiVersion: - description: Output only. API version used to start the operation. + type: string + databaseInstalledVersion: + description: >- + Output only. The installed database version of the Cloud SQL + instance. readOnly: true type: string - additionalInfo: + instanceCreateTime: + description: Output only. The instance creation timestamp. + readOnly: true + type: string + format: google-datetime + instanceTier: description: >- - Output only. AdditionalInfo contains additional Info related to - backup plan association resource. + Output only. The tier (or machine type) for this instance. Example: + `db-custom-1-3840` readOnly: true - type: object - additionalProperties: - type: string - SetInternalStatusResponse: - id: SetInternalStatusResponse - description: Response message from SetStatusInternal method. - type: object - properties: {} - RestoreBackupResponse: - id: RestoreBackupResponse - description: Response message for restoring from a Backup. - type: object - properties: - targetResource: - description: Details of the target resource created/modified as part of restore. - $ref: '#/components/schemas/TargetResource' - TargetResource: - id: TargetResource - description: Details of the target resource created/modified as part of restore. + type: string + FetchDataSourceReferencesForResourceTypeResponse: + id: FetchDataSourceReferencesForResourceTypeResponse + description: Response for the FetchDataSourceReferencesForResourceType method. type: object properties: - gcpResource: + dataSourceReferences: + description: The DataSourceReferences from the specified parent. + type: array + items: + $ref: '#/components/schemas/DataSourceReference' + nextPageToken: description: >- - Details of the native Google Cloud resource created as part of - restore. - $ref: '#/components/schemas/GcpResource' - GcpResource: - id: GcpResource - description: Minimum details to identify a Google Cloud resource + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + InitializeServiceRequest: + id: InitializeServiceRequest + description: Request message for initializing the service. type: object properties: - gcpResourcename: - description: Name of the Google Cloud resource. - type: string - location: - description: 'Location of the resource: //"global"/"unspecified".' - type: string - type: + resourceType: description: >- - Type of the resource. Use the Unified Resource Type, eg. - compute.googleapis.com/Instance. + Required. The resource type to which the default service config will + be applied. Examples include, "compute.googleapis.com/Instance" and + "storage.googleapis.com/Bucket". type: string - parameters: + requestId: + description: >- + Optional. An optional request ID to identify requests. Specify a + unique request ID so that if you must retry your request, the server + will know to ignore the request if it has already been completed. + The server will guarantee that for at least 60 minutes since the + first request. For example, consider a situation where you make an + initial request and t he request times out. If you make the request + again with the same request ID, the server can check if original + operation with the same request ID was received, and if so, will + ignore the second request. This prevents clients from accidentally + creating duplicate commitments. The request ID must be a valid UUID + with the exception that zero UUID is not supported + (00000000-0000-0000-0000-000000000000). + type: string + cloudSqlInstanceInitializationConfig: + description: Optional. The configuration for initializing a Cloud SQL instance. + $ref: '#/components/schemas/CloudSqlInstanceInitializationConfig' + CloudSqlInstanceInitializationConfig: + id: CloudSqlInstanceInitializationConfig + description: >- + CloudSqlInstanceInitializationConfig contains the configuration for + initializing a Cloud SQL instance. + type: object + properties: + edition: + description: Required. The edition of the Cloud SQL instance. + type: string + enumDescriptions: + - Unspecified edition. + - Enterprise edition. + - Enterprise Plus edition. + enum: + - EDITION_UNSPECIFIED + - ENTERPRISE + - ENTERPRISE_PLUS + ListResourceBackupConfigsResponse: + id: ListResourceBackupConfigsResponse + description: Response for ListResourceBackupConfigs. + type: object + properties: + resourceBackupConfigs: + description: The list of ResourceBackupConfigs for the specified scope. + type: array + items: + $ref: '#/components/schemas/ResourceBackupConfig' + nextPageToken: + description: A token identifying a page of results the server should return. + type: string + ResourceBackupConfig: + id: ResourceBackupConfig + description: >- + ResourceBackupConfig represents a resource along with its backup + configurations. + type: object + properties: + name: + description: >- + Identifier. The resource name of the ResourceBackupConfig. Format: + projects/{project}/locations/{location}/resourceBackupConfigs/{uid} + type: string + uid: + description: Output only. The unique identifier of the resource backup config. + readOnly: true + type: string + targetResource: + description: >- + Output only. The [full resource + name](https://cloud.google.com/asset-inventory/docs/resource-name-format) + of the cloud resource that this configuration applies to. Supported + resource types are ResourceBackupConfig.ResourceType. + readOnly: true + type: string + targetResourceDisplayName: + description: Output only. The human friendly name of the target resource. + readOnly: true + type: string + targetResourceType: + description: Output only. The type of the target resource. + readOnly: true + type: string + enumDescriptions: + - Resource type not set. + - Cloud SQL instance. + - Compute Engine VM. + enum: + - RESOURCE_TYPE_UNSPECIFIED + - CLOUD_SQL_INSTANCE + - COMPUTE_ENGINE_VM + targetResourceLabels: + description: Labels associated with the target resource. + type: object + additionalProperties: + type: string + backupConfigsDetails: + description: >- + Backup configurations applying to the target resource, including + those targeting its related/child resources. For example, backup + configuration applicable to Compute Engine disks will be populated + in this field for a Compute Engine VM which has the disk associated. + type: array + items: + $ref: '#/components/schemas/BackupConfigDetails' + backupConfigured: + description: >- + Output only. Whether the target resource is configured for backup. + This is true if the backup_configs_details is not empty. + readOnly: true + type: boolean + vaulted: + description: >- + Output only. Whether the target resource is protected by a backup + vault. This is true if the backup_configs_details is not empty and + any of the ResourceBackupConfig.backup_configs_details has a backup + configuration with BackupConfigDetails.backup_vault set. set. + readOnly: true + type: boolean + BackupConfigDetails: + id: BackupConfigDetails + description: >- + BackupConfigDetails has information about how the resource is configured + for backups and about the most recent backup taken for this + configuration. + type: object + properties: + backupConfigSource: + description: >- + Output only. The full resource name of the backup config source + resource. For example, + "//backupdr.googleapis.com/v1/projects/{project}/locations/{region}/backupPlans/{backupplanId}" + or + "//compute.googleapis.com/projects/{project}/locations/{region}/resourcePolicies/{resourcePolicyId}". + readOnly: true + type: string + backupConfigSourceDisplayName: + description: Output only. The display name of the backup config source resource. + readOnly: true + type: string + type: + description: Output only. The type of the backup config resource. + readOnly: true + type: string + enumDescriptions: + - Backup config type is unspecified. + - Backup config is Cloud SQL instance's automated backup config. + - Backup config is Compute Engine Resource Policy. + - Backup config is Backup and DR's Backup Plan. + - Backup config is Backup and DR's Template. + enum: + - TYPE_UNSPECIFIED + - CLOUD_SQL_INSTANCE_BACKUP_CONFIG + - COMPUTE_ENGINE_RESOURCE_POLICY + - BACKUPDR_BACKUP_PLAN + - BACKUPDR_TEMPLATE + state: + description: Output only. The state of the backup config resource. + readOnly: true + type: string + enumDescriptions: + - Backup config state not set. + - The config is in an active state protecting the resource + - >- + The config is currently not protecting the resource. Either + because it is disabled or the owning project has been deleted + without cleanup of the actual resource. + - >- + The config still exists but because of some error state it is not + protecting the resource. Like the source project is deleted. For + eg. PlanAssociation, BackupPlan is deleted. + enum: + - STATE_UNSPECIFIED + - ACTIVE + - INACTIVE + - ERROR + pitrSettings: + description: >- + Output only. Point in time recovery settings of the backup + configuration resource. + readOnly: true + $ref: '#/components/schemas/PitrSettings' + latestSuccessfulBackupTime: + description: >- + Output only. Timestamp of the latest successful backup created via + this backup configuration. + readOnly: true + type: string + format: google-datetime + applicableResource: + description: >- + Output only. The [full resource + name](https://cloud.google.com/asset-inventory/docs/resource-name-format) + of the resource that is applicable for the backup configuration. + Example: + "//compute.googleapis.com/projects/{project}/zones/{zone}/instances/{instance}" + readOnly: true + type: string + backupVault: + description: >- + Output only. The [full resource + name](https://cloud.google.com/asset-inventory/docs/resource-name-format) + of the backup vault that will store the backups generated through + this backup configuration. Example: + "//backupdr.googleapis.com/v1/projects/{project}/locations/{region}/backupVaults/{backupvaultId}" + readOnly: true + type: string + backupLocations: + description: The locations where the backups are to be stored. + type: array + items: + $ref: '#/components/schemas/BackupLocation' + backupDrPlanConfig: + description: Backup and DR's Backup Plan specific data. + $ref: '#/components/schemas/BackupDrPlanConfig' + backupDrTemplateConfig: + description: Backup and DR's Template specific data. + $ref: '#/components/schemas/BackupDrTemplateConfig' + PitrSettings: + id: PitrSettings + description: Point in time recovery settings of the backup configuration resource. + type: object + properties: + retentionDays: + description: Output only. Number of days to retain the backup. + readOnly: true + type: integer + format: int32 + BackupLocation: + id: BackupLocation + description: BackupLocation represents a cloud location where a backup can be stored. + type: object + properties: + type: + description: Output only. The type of the location. + readOnly: true + type: string + enumDescriptions: + - Location type is unspecified. + - Location type is zonal. + - Location type is regional. + - Location type is multi regional. + enum: + - TYPE_UNSPECIFIED + - ZONAL + - REGIONAL + - MULTI_REGIONAL + locationId: + description: 'Output only. The id of the cloud location. Example: "us-central1"' + readOnly: true + type: string + BackupDrPlanConfig: + id: BackupDrPlanConfig + description: >- + BackupDrPlanConfig has additional information about Backup and DR's Plan + backup configuration. + type: object + properties: + backupDrPlanRules: + description: Backup rules of the backup plan resource. + type: array + items: + $ref: '#/components/schemas/BackupDrPlanRule' + BackupDrPlanRule: + id: BackupDrPlanRule + description: >- + BackupDrPlanRule has rule specific information of the backup plan + resource. + type: object + properties: + ruleId: + description: Output only. Unique Id of the backup rule. + readOnly: true + type: string + lastSuccessfulBackupTime: + description: >- + Output only. Timestamp of the latest successful backup created via + this backup rule. + readOnly: true + type: string + format: google-datetime + BackupDrTemplateConfig: + id: BackupDrTemplateConfig + description: >- + BackupDrTemplateConfig has additional information about Backup and DR's + Template backup configuration. + type: object + properties: + firstPartyManagementUri: + description: >- + Output only. The URI of the BackupDr template resource for the first + party identity users. + readOnly: true + type: string + thirdPartyManagementUri: + description: >- + Output only. The URI of the BackupDr template resource for the third + party identity users. + readOnly: true + type: string + ListLocationsResponse: + id: ListLocationsResponse + description: The response message for Locations.ListLocations. + type: object + properties: + locations: + description: >- + A list of locations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/Location' + nextPageToken: + description: The standard List next-page token. + type: string + Location: + id: Location + description: A resource that represents a Google Cloud location. + type: object + properties: + name: + description: >- + Resource name for the location, which may vary between + implementations. For example: + `"projects/example-project/locations/us-east1"` + type: string + locationId: + description: 'The canonical id for this location. For example: `"us-east1"`.' + type: string + displayName: + description: >- + The friendly name for this location, typically a nearby city name. + For example, "Tokyo". + type: string + labels: + description: >- + Cross-service attributes for the location. For example + {"cloud.googleapis.com/region": "us-east1"} + type: object + additionalProperties: + type: string + metadata: + description: >- + Service-specific metadata. For example the available capacity at the + given location. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + OperationMetadata: + id: OperationMetadata + description: Represents the metadata of the long-running operation. + type: object + properties: + createTime: + description: Output only. The time the operation was created. + readOnly: true + type: string + format: google-datetime + endTime: + description: Output only. The time the operation finished running. + readOnly: true + type: string + format: google-datetime + target: + description: >- + Output only. Server-defined resource path for the target of the + operation. + readOnly: true + type: string + verb: + description: Output only. Name of the verb executed by the operation. + readOnly: true + type: string + statusMessage: + description: Output only. Human-readable status of the operation, if any. + readOnly: true + type: string + requestedCancellation: + description: >- + Output only. Identifies whether the user has requested cancellation + of the operation. Operations that have successfully been cancelled + have google.longrunning.Operation.error value with a + google.rpc.Status.code of 1, corresponding to 'Code.CANCELLED'. + readOnly: true + type: boolean + apiVersion: + description: Output only. API version used to start the operation. + readOnly: true + type: string + additionalInfo: + description: >- + Output only. AdditionalInfo contains additional Info related to + backup plan association resource. + readOnly: true + type: object + additionalProperties: + type: string + SetInternalStatusResponse: + id: SetInternalStatusResponse + description: Response message from SetStatusInternal method. + type: object + properties: {} + RestoreBackupResponse: + id: RestoreBackupResponse + description: Response message for restoring from a Backup. + type: object + properties: + targetResource: + description: Details of the target resource created/modified as part of restore. + $ref: '#/components/schemas/TargetResource' + TargetResource: + id: TargetResource + description: Details of the target resource created/modified as part of restore. + type: object + properties: + gcpResource: + description: >- + Details of the native Google Cloud resource created as part of + restore. + $ref: '#/components/schemas/GcpResource' + GcpResource: + id: GcpResource + description: Minimum details to identify a Google Cloud resource + type: object + properties: + gcpResourcename: + description: Name of the Google Cloud resource. + type: string + location: + description: 'Location of the resource: //"global"/"unspecified".' + type: string + type: + description: >- + Type of the resource. Use the Unified Resource Type, eg. + compute.googleapis.com/Instance. + type: string + LocationMetadata: + id: LocationMetadata + type: object + properties: + unsupportedFeatures: + type: array + items: + type: string + enumDescriptions: + - '' + - '' + - '' + enum: + - FEATURE_UNSPECIFIED + - MANAGEMENT_SERVER + - COMPUTE_INSTANCE + parameters: access_token: description: OAuth access token. in: query @@ -3376,6 +4458,32 @@ components: - '1' - '2' x-stackQL-resources: + trial: + id: google.backupdr.trial + name: trial + title: Trial + methods: + get_trial: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1trial/get + response: + mediaType: application/json + openAPIDocKey: '200' + subscribe: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1trial:subscribe/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/trial/methods/get_trial' + insert: [] + update: [] + replace: [] + delete: [] locations: id: google.backupdr.locations name: locations @@ -3473,6 +4581,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + ms_compliance_metadata: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1managementServers:msComplianceMetadata/post + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/management_servers/methods/get' @@ -3517,6 +4632,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + initialize: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1serviceConfig:initialize/post + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/operations/methods/get' @@ -3678,21 +4800,6 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/data_sources/methods/get' - - $ref: '#/components/x-stackQL-resources/data_sources/methods/list' - insert: [] - update: - - $ref: '#/components/x-stackQL-resources/data_sources/methods/patch' - replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/data_sources/methods/remove' - data_sources_access_token: - id: google.backupdr.data_sources_access_token - name: data_sources_access_token - title: Data_sources_access_token - methods: fetch_access_token: operation: $ref: >- @@ -3702,12 +4809,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/data_sources_access_token/methods/fetch_access_token + - $ref: '#/components/x-stackQL-resources/data_sources/methods/get' + - $ref: '#/components/x-stackQL-resources/data_sources/methods/list' insert: [] - update: [] + update: + - $ref: '#/components/x-stackQL-resources/data_sources/methods/patch' replace: [] - delete: [] + delete: + - $ref: '#/components/x-stackQL-resources/data_sources/methods/remove' backups: id: google.backupdr.backups name: backups @@ -3779,6 +4888,13 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.backupPlans + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupPlans~1{backupPlansId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' get: operation: $ref: >- @@ -3799,10 +4915,39 @@ components: - $ref: '#/components/x-stackQL-resources/backup_plans/methods/list' insert: - $ref: '#/components/x-stackQL-resources/backup_plans/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/backup_plans/methods/patch' replace: [] delete: - $ref: '#/components/x-stackQL-resources/backup_plans/methods/delete' + revisions: + id: google.backupdr.revisions + name: revisions + title: Revisions + methods: + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupPlans~1{backupPlansId}~1revisions~1{revisionsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupPlans~1{backupPlansId}~1revisions/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.backupPlanRevisions + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/revisions/methods/get' + - $ref: '#/components/x-stackQL-resources/revisions/methods/list' + insert: [] + update: [] + replace: [] + delete: [] backup_plan_associations: id: google.backupdr.backup_plan_associations name: backup_plan_associations @@ -3823,6 +4968,13 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.backupPlanAssociations + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupPlanAssociations~1{backupPlanAssociationsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' get: operation: $ref: >- @@ -3837,6 +4989,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + fetch_for_resource_type: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupPlanAssociations:fetchForResourceType/get + response: + mediaType: application/json + openAPIDocKey: '200' trigger_backup: operation: $ref: >- @@ -3853,13 +5012,65 @@ components: insert: - $ref: >- #/components/x-stackQL-resources/backup_plan_associations/methods/create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/backup_plan_associations/methods/patch replace: [] delete: - $ref: >- #/components/x-stackQL-resources/backup_plan_associations/methods/delete + data_source_references: + id: google.backupdr.data_source_references + name: data_source_references + title: Data_source_references + methods: + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataSourceReferences~1{dataSourceReferencesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + fetch_for_resource_type: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataSourceReferences:fetchForResourceType/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/data_source_references/methods/get + - $ref: >- + #/components/x-stackQL-resources/data_source_references/methods/fetch_for_resource_type + insert: [] + update: [] + replace: [] + delete: [] + resource_backup_configs: + id: google.backupdr.resource_backup_configs + name: resource_backup_configs + title: Resource_backup_configs + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1resourceBackupConfigs/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.resourceBackupConfigs + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/resource_backup_configs/methods/list + insert: [] + update: [] + replace: [] + delete: [] paths: - /v1/projects/{projectsId}/locations: + /v1/projects/{projectsId}/locations/{locationsId}/trial: parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' @@ -3873,8 +5084,147 @@ paths: - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/_.xgafv' get: - description: Lists information about the supported locations for this service. - operationId: backupdr.projects.locations.list + description: Gets the Trial state for a given project + operationId: backupdr.projects.locations.getTrial + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Trial' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations: + parameters: *ref_1 + get: + description: Lists information about the supported locations for this service. + operationId: backupdr.projects.locations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListLocationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: extraLocationTypes + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}: + parameters: *ref_1 + get: + description: Gets information about a location. + operationId: backupdr.projects.locations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Location' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/managementServers/{managementServersId}:setIamPolicy: + parameters: *ref_1 + post: + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and + `PERMISSION_DENIED` errors. + operationId: backupdr.projects.locations.managementServers.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetIamPolicyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: managementServersId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/managementServers/{managementServersId}:getIamPolicy: + parameters: *ref_1 + get: + description: >- + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: backupdr.projects.locations.managementServers.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3886,31 +5236,76 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListLocationsResponse' + $ref: '#/components/schemas/Policy' parameters: - in: path name: projectsId required: true schema: type: string - - in: query - name: filter + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: managementServersId + required: true schema: type: string - in: query - name: pageSize + name: options.requestedPolicyVersion schema: type: integer format: int32 - - in: query - name: pageToken + /v1/projects/{projectsId}/locations/{locationsId}/managementServers/{managementServersId}:testIamPermissions: + parameters: *ref_1 + post: + description: >- + Returns permissions that a caller has on the specified resource. If the + resource does not exist, this will return an empty set of permissions, + not a `NOT_FOUND` error. Note: This operation is designed to be used for + building permission-aware UIs and command-line tools, not for + authorization checking. This operation may "fail open" without warning. + operationId: backupdr.projects.locations.managementServers.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsResponse' + parameters: + - in: path + name: projectsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}: + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: managementServersId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/managementServers: parameters: *ref_1 get: - description: Gets information about a location. - operationId: backupdr.projects.locations.get + description: Lists ManagementServers in a given project and location. + operationId: backupdr.projects.locations.managementServers.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3922,7 +5317,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Location' + $ref: '#/components/schemas/ListManagementServersResponse' parameters: - in: path name: projectsId @@ -3934,19 +5329,31 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/managementServers/{managementServersId}:setIamPolicy: - parameters: *ref_1 + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - `PERMISSION_DENIED` errors. - operationId: backupdr.projects.locations.managementServers.setIamPolicy + description: Creates a new ManagementServer in a given project and location. + operationId: backupdr.projects.locations.managementServers.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SetIamPolicyRequest' + $ref: '#/components/schemas/ManagementServer' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3958,7 +5365,43 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: managementServerId + schema: + type: string + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/managementServers/{managementServersId}: + parameters: *ref_1 + get: + description: Gets details of a single ManagementServer. + operationId: backupdr.projects.locations.managementServers.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ManagementServer' parameters: - in: path name: projectsId @@ -3975,13 +5418,81 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/managementServers/{managementServersId}:getIamPolicy: + delete: + description: Deletes a single ManagementServer. + operationId: backupdr.projects.locations.managementServers.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: managementServersId + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/managementServers:msComplianceMetadata: + parameters: *ref_1 + post: + description: Returns the Assured Workloads compliance metadata for a given project. + operationId: backupdr.projects.locations.managementServers.msComplianceMetadata + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FetchMsComplianceMetadataRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/FetchMsComplianceMetadataResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations: parameters: *ref_1 get: description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: backupdr.projects.locations.managementServers.getIamPolicy + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: backupdr.projects.locations.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3993,7 +5504,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/ListOperationsResponse' parameters: - in: path name: projectsId @@ -4005,31 +5516,27 @@ paths: required: true schema: type: string - - in: path - name: managementServersId - required: true + - in: query + name: filter schema: type: string - in: query - name: options.requestedPolicyVersion + name: pageSize schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/managementServers/{managementServersId}:testIamPermissions: + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: parameters: *ref_1 - post: + get: description: >- - Returns permissions that a caller has on the specified resource. If the - resource does not exist, this will return an empty set of permissions, - not a `NOT_FOUND` error. Note: This operation is designed to be used for - building permission-aware UIs and command-line tools, not for - authorization checking. This operation may "fail open" without warning. - operationId: backupdr.projects.locations.managementServers.testIamPermissions - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TestIamPermissionsRequest' + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: backupdr.projects.locations.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4041,7 +5548,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TestIamPermissionsResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -4054,15 +5561,17 @@ paths: schema: type: string - in: path - name: managementServersId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/managementServers: - parameters: *ref_1 - get: - description: Lists ManagementServers in a given project and location. - operationId: backupdr.projects.locations.managementServers.list + delete: + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: backupdr.projects.locations.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4074,7 +5583,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListManagementServersResponse' + $ref: '#/components/schemas/Empty' parameters: - in: path name: projectsId @@ -4086,31 +5595,30 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: orderBy + - in: path + name: operationsId + required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: + parameters: *ref_1 post: - description: Creates a new ManagementServer in a given project and location. - operationId: backupdr.projects.locations.managementServers.create + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + `1`, corresponding to `Code.CANCELLED`. + operationId: backupdr.projects.locations.operations.cancel requestBody: content: application/json: schema: - $ref: '#/components/schemas/ManagementServer' + $ref: '#/components/schemas/CancelOperationRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4122,7 +5630,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Empty' parameters: - in: path name: projectsId @@ -4134,19 +5642,21 @@ paths: required: true schema: type: string - - in: query - name: managementServerId - schema: - type: string - - in: query - name: requestId + - in: path + name: operationsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/managementServers/{managementServersId}: + /v1/projects/{projectsId}/locations/{locationsId}/trial:subscribe: parameters: *ref_1 - get: - description: Gets details of a single ManagementServer. - operationId: backupdr.projects.locations.managementServers.get + post: + description: Subscribes to a trial for a project + operationId: backupdr.projects.locations.trial.subscribe + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SubscribeTrialRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4158,7 +5668,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ManagementServer' + $ref: '#/components/schemas/Trial' parameters: - in: path name: projectsId @@ -4170,14 +5680,16 @@ paths: required: true schema: type: string - - in: path - name: managementServersId - required: true - schema: - type: string - delete: - description: Deletes a single ManagementServer. - operationId: backupdr.projects.locations.managementServers.delete + /v1/projects/{projectsId}/locations/{locationsId}/backupVaults: + parameters: *ref_1 + post: + description: Creates a new BackupVault in a given project and location. + operationId: backupdr.projects.locations.backupVaults.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BackupVault' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4201,22 +5713,21 @@ paths: required: true schema: type: string - - in: path - name: managementServersId - required: true + - in: query + name: backupVaultId schema: type: string - in: query name: requestId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_1 + - in: query + name: validateOnly + schema: + type: boolean get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: backupdr.projects.locations.operations.list + description: Lists BackupVaults in a given project and location. + operationId: backupdr.projects.locations.backupVaults.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4228,7 +5739,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListOperationsResponse' + $ref: '#/components/schemas/ListBackupVaultsResponse' parameters: - in: path name: projectsId @@ -4240,10 +5751,6 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - in: query name: pageSize schema: @@ -4253,14 +5760,26 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + - in: query + name: view + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/backupVaults:fetchUsable: parameters: *ref_1 get: description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: backupdr.projects.locations.operations.get + FetchUsableBackupVaults lists usable BackupVaults in a given project and + location. Usable BackupVault are the ones that user has + backupdr.backupVaults.get permission. + operationId: backupdr.projects.locations.backupVaults.fetchUsable security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4272,7 +5791,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/FetchUsableBackupVaultsResponse' parameters: - in: path name: projectsId @@ -4284,18 +5803,28 @@ paths: required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - delete: - description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: backupdr.projects.locations.operations.delete + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}: + parameters: *ref_1 + get: + description: Gets details of a BackupVault. + operationId: backupdr.projects.locations.backupVaults.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4307,7 +5836,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/BackupVault' parameters: - in: path name: projectsId @@ -4320,29 +5849,22 @@ paths: schema: type: string - in: path - name: operationsId + name: backupVaultsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_1 - post: - description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: backupdr.projects.locations.operations.cancel + - in: query + name: view + schema: + type: string + patch: + description: Updates the settings of a BackupVault. + operationId: backupdr.projects.locations.backupVaults.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/CancelOperationRequest' + $ref: '#/components/schemas/BackupVault' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4354,7 +5876,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -4367,20 +5889,34 @@ paths: schema: type: string - in: path - name: operationsId + name: backupVaultsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/backupVaults: - parameters: *ref_1 - post: - description: Creates a new BackupVault in a given project and location. - operationId: backupdr.projects.locations.backupVaults.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/BackupVault' + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: requestId + schema: + type: string + - in: query + name: validateOnly + schema: + type: boolean + - in: query + name: force + schema: + type: boolean + - in: query + name: forceUpdateAccessRestriction + schema: + type: boolean + delete: + description: Deletes a BackupVault. + operationId: backupdr.projects.locations.backupVaults.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4404,21 +5940,47 @@ paths: required: true schema: type: string - - in: query - name: backupVaultId + - in: path + name: backupVaultsId + required: true schema: type: string - in: query name: requestId schema: type: string + - in: query + name: force + schema: + type: boolean + - in: query + name: etag + schema: + type: string - in: query name: validateOnly schema: type: boolean - get: - description: Lists BackupVaults in a given project and location. - operationId: backupdr.projects.locations.backupVaults.list + - in: query + name: allowMissing + schema: + type: boolean + - in: query + name: ignoreBackupPlanReferences + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}:testIamPermissions: + parameters: *ref_1 + post: + description: >- + Returns the caller's permissions on a BackupVault resource. A caller is + not required to have Google IAM permission to make this request. + operationId: backupdr.projects.locations.backupVaults.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4430,7 +5992,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListBackupVaultsResponse' + $ref: '#/components/schemas/TestIamPermissionsResponse' parameters: - in: path name: projectsId @@ -4442,35 +6004,16 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: view + - in: path + name: backupVaultsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/backupVaults:fetchUsable: + /v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources: parameters: *ref_1 get: - description: >- - FetchUsableBackupVaults lists usable BackupVaults in a given project and - location. Usable BackupVault are the ones that user has - backupdr.backupVaults.get permission. - operationId: backupdr.projects.locations.backupVaults.fetchUsable + description: Lists DataSources in a given project and location. + operationId: backupdr.projects.locations.backupVaults.dataSources.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4482,7 +6025,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FetchUsableBackupVaultsResponse' + $ref: '#/components/schemas/ListDataSourcesResponse' parameters: - in: path name: projectsId @@ -4494,6 +6037,11 @@ paths: required: true schema: type: string + - in: path + name: backupVaultsId + required: true + schema: + type: string - in: query name: pageSize schema: @@ -4511,11 +6059,11 @@ paths: name: orderBy schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}: + /v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}: parameters: *ref_1 get: - description: Gets details of a BackupVault. - operationId: backupdr.projects.locations.backupVaults.get + description: Gets details of a DataSource. + operationId: backupdr.projects.locations.backupVaults.dataSources.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4527,7 +6075,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BackupVault' + $ref: '#/components/schemas/DataSource' parameters: - in: path name: projectsId @@ -4544,18 +6092,19 @@ paths: required: true schema: type: string - - in: query - name: view + - in: path + name: dataSourcesId + required: true schema: type: string patch: - description: Updates the settings of a BackupVault. - operationId: backupdr.projects.locations.backupVaults.patch + description: Updates the settings of a DataSource. + operationId: backupdr.projects.locations.backupVaults.dataSources.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/BackupVault' + $ref: '#/components/schemas/DataSource' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4584,6 +6133,11 @@ paths: required: true schema: type: string + - in: path + name: dataSourcesId + required: true + schema: + type: string - in: query name: updateMask schema: @@ -4594,16 +6148,22 @@ paths: schema: type: string - in: query - name: validateOnly - schema: - type: boolean - - in: query - name: force + name: allowMissing schema: type: boolean - delete: - description: Deletes a BackupVault. - operationId: backupdr.projects.locations.backupVaults.delete + /v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:remove: + parameters: *ref_1 + post: + description: >- + Deletes a DataSource. This is a custom method instead of a standard + delete method because external clients will not delete DataSources + except for BackupDR backup appliances. + operationId: backupdr.projects.locations.backupVaults.dataSources.remove + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RemoveDataSourceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4632,42 +6192,21 @@ paths: required: true schema: type: string - - in: query - name: requestId - schema: - type: string - - in: query - name: force - schema: - type: boolean - - in: query - name: etag + - in: path + name: dataSourcesId + required: true schema: type: string - - in: query - name: validateOnly - schema: - type: boolean - - in: query - name: allowMissing - schema: - type: boolean - - in: query - name: ignoreBackupPlanReferences - schema: - type: boolean - /v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}:testIamPermissions: + /v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:setInternalStatus: parameters: *ref_1 post: - description: >- - Returns the caller's permissions on a BackupVault resource. A caller is - not required to have Google IAM permission to make this request. - operationId: backupdr.projects.locations.backupVaults.testIamPermissions + description: Sets the internal status of a DataSource. + operationId: backupdr.projects.locations.backupVaults.dataSources.setInternalStatus requestBody: content: application/json: schema: - $ref: '#/components/schemas/TestIamPermissionsRequest' + $ref: '#/components/schemas/SetInternalStatusRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4679,7 +6218,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TestIamPermissionsResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -4696,11 +6235,21 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources: + - in: path + name: dataSourcesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:initiateBackup: parameters: *ref_1 - get: - description: Lists DataSources in a given project and location. - operationId: backupdr.projects.locations.backupVaults.dataSources.list + post: + description: Internal only. Initiates a backup. + operationId: backupdr.projects.locations.backupVaults.dataSources.initiateBackup + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InitiateBackupRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4712,7 +6261,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListDataSourcesResponse' + $ref: '#/components/schemas/InitiateBackupResponse' parameters: - in: path name: projectsId @@ -4729,28 +6278,66 @@ paths: required: true schema: type: string - - in: query - name: pageSize + - in: path + name: dataSourcesId + required: true schema: - type: integer - format: int32 - - in: query - name: pageToken + type: string + /v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:abandonBackup: + parameters: *ref_1 + post: + description: Internal only. Abandons a backup. + operationId: backupdr.projects.locations.backupVaults.dataSources.abandonBackup + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AbandonBackupRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true schema: type: string - - in: query - name: filter + - in: path + name: locationsId + required: true schema: type: string - - in: query - name: orderBy + - in: path + name: backupVaultsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}: + - in: path + name: dataSourcesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:finalizeBackup: parameters: *ref_1 - get: - description: Gets details of a DataSource. - operationId: backupdr.projects.locations.backupVaults.dataSources.get + post: + description: >- + Internal only. Finalize a backup that was started by a call to + InitiateBackup. + operationId: backupdr.projects.locations.backupVaults.dataSources.finalizeBackup + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FinalizeBackupRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4762,7 +6349,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DataSource' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -4784,14 +6371,16 @@ paths: required: true schema: type: string - patch: - description: Updates the settings of a DataSource. - operationId: backupdr.projects.locations.backupVaults.dataSources.patch + /v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:fetchAccessToken: + parameters: *ref_1 + post: + description: Internal only. Fetch access token for a given data source. + operationId: backupdr.projects.locations.backupVaults.dataSources.fetchAccessToken requestBody: content: application/json: schema: - $ref: '#/components/schemas/DataSource' + $ref: '#/components/schemas/FetchAccessTokenRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4803,7 +6392,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/FetchAccessTokenResponse' parameters: - in: path name: projectsId @@ -4825,32 +6414,11 @@ paths: required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - - in: query - name: requestId - schema: - type: string - - in: query - name: allowMissing - schema: - type: boolean - /v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:remove: + /v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}/backups: parameters: *ref_1 - post: - description: >- - Deletes a DataSource. This is a custom method instead of a standard - delete method because external clients will not delete DataSources - except for BackupDR backup appliances. - operationId: backupdr.projects.locations.backupVaults.dataSources.remove - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RemoveDataSourceRequest' + get: + description: Lists Backups in a given project and location. + operationId: backupdr.projects.locations.backupVaults.dataSources.backups.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4862,7 +6430,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/ListBackupsResponse' parameters: - in: path name: projectsId @@ -4884,16 +6452,32 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:setInternalStatus: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + - in: query + name: view + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}/backups/{backupsId}: parameters: *ref_1 - post: - description: Sets the internal status of a DataSource. - operationId: backupdr.projects.locations.backupVaults.dataSources.setInternalStatus - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SetInternalStatusRequest' + get: + description: Gets details of a Backup. + operationId: backupdr.projects.locations.backupVaults.dataSources.backups.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4905,7 +6489,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Backup' parameters: - in: path name: projectsId @@ -4927,16 +6511,23 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:initiateBackup: - parameters: *ref_1 - post: - description: Internal only. Initiates a backup. - operationId: backupdr.projects.locations.backupVaults.dataSources.initiateBackup + - in: path + name: backupsId + required: true + schema: + type: string + - in: query + name: view + schema: + type: string + patch: + description: Updates the settings of a Backup. + operationId: backupdr.projects.locations.backupVaults.dataSources.backups.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/InitiateBackupRequest' + $ref: '#/components/schemas/Backup' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4948,7 +6539,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InitiateBackupResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -4970,16 +6561,23 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:abandonBackup: - parameters: *ref_1 - post: - description: Internal only. Abandons a backup. - operationId: backupdr.projects.locations.backupVaults.dataSources.abandonBackup - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AbandonBackupRequest' + - in: path + name: backupsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: requestId + schema: + type: string + delete: + description: Deletes a Backup. + operationId: backupdr.projects.locations.backupVaults.dataSources.backups.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5013,18 +6611,25 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:finalizeBackup: + - in: path + name: backupsId + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}/backups/{backupsId}:restore: parameters: *ref_1 post: - description: >- - Internal only. Finalize a backup that was started by a call to - InitiateBackup. - operationId: backupdr.projects.locations.backupVaults.dataSources.finalizeBackup + description: Restore from a Backup + operationId: backupdr.projects.locations.backupVaults.dataSources.backups.restore requestBody: content: application/json: schema: - $ref: '#/components/schemas/FinalizeBackupRequest' + $ref: '#/components/schemas/RestoreBackupRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5058,16 +6663,21 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:fetchAccessToken: + - in: path + name: backupsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/backupPlans: parameters: *ref_1 post: - description: Internal only. Fetch access token for a given data source. - operationId: backupdr.projects.locations.backupVaults.dataSources.fetchAccessToken + description: Create a BackupPlan + operationId: backupdr.projects.locations.backupPlans.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/FetchAccessTokenRequest' + $ref: '#/components/schemas/BackupPlan' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5079,7 +6689,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FetchAccessTokenResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -5091,21 +6701,17 @@ paths: required: true schema: type: string - - in: path - name: backupVaultsId - required: true + - in: query + name: backupPlanId schema: type: string - - in: path - name: dataSourcesId - required: true + - in: query + name: requestId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}/backups: - parameters: *ref_1 get: - description: Lists Backups in a given project and location. - operationId: backupdr.projects.locations.backupVaults.dataSources.backups.list + description: Lists BackupPlans in a given project and location. + operationId: backupdr.projects.locations.backupPlans.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5117,7 +6723,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListBackupsResponse' + $ref: '#/components/schemas/ListBackupPlansResponse' parameters: - in: path name: projectsId @@ -5129,16 +6735,6 @@ paths: required: true schema: type: string - - in: path - name: backupVaultsId - required: true - schema: - type: string - - in: path - name: dataSourcesId - required: true - schema: - type: string - in: query name: pageSize schema: @@ -5156,15 +6752,16 @@ paths: name: orderBy schema: type: string - - in: query - name: view - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}/backups/{backupsId}: + /v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}: parameters: *ref_1 - get: - description: Gets details of a Backup. - operationId: backupdr.projects.locations.backupVaults.dataSources.backups.get + patch: + description: Update a BackupPlan. + operationId: backupdr.projects.locations.backupPlans.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BackupPlan' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5176,7 +6773,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Backup' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -5189,32 +6786,53 @@ paths: schema: type: string - in: path - name: backupVaultsId + name: backupPlansId required: true schema: type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: requestId + schema: + type: string + get: + description: Gets details of a single BackupPlan. + operationId: backupdr.projects.locations.backupPlans.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/BackupPlan' + parameters: - in: path - name: dataSourcesId + name: projectsId required: true schema: type: string - in: path - name: backupsId + name: locationsId required: true schema: type: string - - in: query - name: view + - in: path + name: backupPlansId + required: true schema: type: string - patch: - description: Updates the settings of a Backup. - operationId: backupdr.projects.locations.backupVaults.dataSources.backups.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Backup' + delete: + description: Deletes a single BackupPlan. + operationId: backupdr.projects.locations.backupPlans.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5239,32 +6857,19 @@ paths: schema: type: string - in: path - name: backupVaultsId - required: true - schema: - type: string - - in: path - name: dataSourcesId - required: true - schema: - type: string - - in: path - name: backupsId + name: backupPlansId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - in: query name: requestId schema: type: string - delete: - description: Deletes a Backup. - operationId: backupdr.projects.locations.backupVaults.dataSources.backups.delete + /v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}/revisions/{revisionsId}: + parameters: *ref_1 + get: + description: Gets details of a single BackupPlanRevision. + operationId: backupdr.projects.locations.backupPlans.revisions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5276,7 +6881,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/BackupPlanRevision' parameters: - in: path name: projectsId @@ -5289,34 +6894,20 @@ paths: schema: type: string - in: path - name: backupVaultsId - required: true - schema: - type: string - - in: path - name: dataSourcesId + name: backupPlansId required: true schema: type: string - in: path - name: backupsId + name: revisionsId required: true schema: type: string - - in: query - name: requestId - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}/backups/{backupsId}:restore: + /v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}/revisions: parameters: *ref_1 - post: - description: Restore from a Backup - operationId: backupdr.projects.locations.backupVaults.dataSources.backups.restore - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RestoreBackupRequest' + get: + description: Lists BackupPlanRevisions in a given project and location. + operationId: backupdr.projects.locations.backupPlans.revisions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5328,7 +6919,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/ListBackupPlanRevisionsResponse' parameters: - in: path name: projectsId @@ -5341,30 +6932,29 @@ paths: schema: type: string - in: path - name: backupVaultsId + name: backupPlansId required: true schema: type: string - - in: path - name: dataSourcesId - required: true + - in: query + name: pageSize schema: - type: string - - in: path - name: backupsId - required: true + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/backupPlans: + /v1/projects/{projectsId}/locations/{locationsId}/backupPlanAssociations: parameters: *ref_1 post: - description: Create a BackupPlan - operationId: backupdr.projects.locations.backupPlans.create + description: Create a BackupPlanAssociation + operationId: backupdr.projects.locations.backupPlanAssociations.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/BackupPlan' + $ref: '#/components/schemas/BackupPlanAssociation' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5389,7 +6979,7 @@ paths: schema: type: string - in: query - name: backupPlanId + name: backupPlanAssociationId schema: type: string - in: query @@ -5397,8 +6987,8 @@ paths: schema: type: string get: - description: Lists BackupPlans in a given project and location. - operationId: backupdr.projects.locations.backupPlans.list + description: Lists BackupPlanAssociations in a given project and location. + operationId: backupdr.projects.locations.backupPlanAssociations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5410,7 +7000,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListBackupPlansResponse' + $ref: '#/components/schemas/ListBackupPlanAssociationsResponse' parameters: - in: path name: projectsId @@ -5435,15 +7025,16 @@ paths: name: filter schema: type: string - - in: query - name: orderBy - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}: + /v1/projects/{projectsId}/locations/{locationsId}/backupPlanAssociations/{backupPlanAssociationsId}: parameters: *ref_1 - get: - description: Gets details of a single BackupPlan. - operationId: backupdr.projects.locations.backupPlans.get + patch: + description: Update a BackupPlanAssociation. + operationId: backupdr.projects.locations.backupPlanAssociations.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BackupPlanAssociation' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5455,7 +7046,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BackupPlan' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -5468,13 +7059,22 @@ paths: schema: type: string - in: path - name: backupPlansId + name: backupPlanAssociationsId required: true schema: type: string - delete: - description: Deletes a single BackupPlan. - operationId: backupdr.projects.locations.backupPlans.delete + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: requestId + schema: + type: string + get: + description: Gets details of a single BackupPlanAssociation. + operationId: backupdr.projects.locations.backupPlanAssociations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5486,7 +7086,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/BackupPlanAssociation' parameters: - in: path name: projectsId @@ -5499,24 +7099,13 @@ paths: schema: type: string - in: path - name: backupPlansId + name: backupPlanAssociationsId required: true schema: type: string - - in: query - name: requestId - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/backupPlanAssociations: - parameters: *ref_1 - post: - description: Create a BackupPlanAssociation - operationId: backupdr.projects.locations.backupPlanAssociations.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/BackupPlanAssociation' + delete: + description: Deletes a single BackupPlanAssociation. + operationId: backupdr.projects.locations.backupPlanAssociations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5540,17 +7129,20 @@ paths: required: true schema: type: string - - in: query - name: backupPlanAssociationId + - in: path + name: backupPlanAssociationsId + required: true schema: type: string - in: query name: requestId schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/backupPlanAssociations:fetchForResourceType: + parameters: *ref_1 get: - description: Lists BackupPlanAssociations in a given project and location. - operationId: backupdr.projects.locations.backupPlanAssociations.list + description: List BackupPlanAssociations for a given resource type. + operationId: backupdr.projects.locations.backupPlanAssociations.fetchForResourceType security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5562,7 +7154,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListBackupPlanAssociationsResponse' + $ref: >- + #/components/schemas/FetchBackupPlanAssociationsForResourceTypeResponse parameters: - in: path name: projectsId @@ -5574,6 +7167,10 @@ paths: required: true schema: type: string + - in: query + name: resourceType + schema: + type: string - in: query name: pageSize schema: @@ -5587,11 +7184,20 @@ paths: name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/backupPlanAssociations/{backupPlanAssociationsId}: + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/backupPlanAssociations/{backupPlanAssociationsId}:triggerBackup: parameters: *ref_1 - get: - description: Gets details of a single BackupPlanAssociation. - operationId: backupdr.projects.locations.backupPlanAssociations.get + post: + description: Triggers a new Backup. + operationId: backupdr.projects.locations.backupPlanAssociations.triggerBackup + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TriggerBackupRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5603,7 +7209,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BackupPlanAssociation' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -5620,9 +7226,11 @@ paths: required: true schema: type: string - delete: - description: Deletes a single BackupPlanAssociation. - operationId: backupdr.projects.locations.backupPlanAssociations.delete + /v1/projects/{projectsId}/locations/{locationsId}/dataSourceReferences/{dataSourceReferencesId}: + parameters: *ref_1 + get: + description: Gets details of a single DataSourceReference. + operationId: backupdr.projects.locations.dataSourceReferences.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5634,7 +7242,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/DataSourceReference' parameters: - in: path name: projectsId @@ -5647,24 +7255,72 @@ paths: schema: type: string - in: path - name: backupPlanAssociationsId + name: dataSourceReferencesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/dataSourceReferences:fetchForResourceType: + parameters: *ref_1 + get: + description: >- + Fetch DataSourceReferences for a given project, location and resource + type. + operationId: backupdr.projects.locations.dataSourceReferences.fetchForResourceType + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/FetchDataSourceReferencesForResourceTypeResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId required: true schema: type: string - in: query - name: requestId + name: resourceType schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/backupPlanAssociations/{backupPlanAssociationsId}:triggerBackup: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/serviceConfig:initialize: parameters: *ref_1 post: - description: Triggers a new Backup. - operationId: backupdr.projects.locations.backupPlanAssociations.triggerBackup + description: Initializes the service related config for a project. + operationId: backupdr.projects.locations.serviceConfig.initialize requestBody: content: application/json: schema: - $ref: '#/components/schemas/TriggerBackupRequest' + $ref: '#/components/schemas/InitializeServiceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5688,8 +7344,48 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/resourceBackupConfigs: + parameters: *ref_1 + get: + description: Lists ResourceBackupConfigs. + operationId: backupdr.projects.locations.resourceBackupConfigs.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListResourceBackupConfigsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string - in: path - name: backupPlanAssociationsId + name: locationsId required: true schema: type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/baremetalsolution.yaml b/providers/src/googleapis.com/v00.00.00000/services/baremetalsolution.yaml index 911a2043..bd15029f 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/baremetalsolution.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/baremetalsolution.yaml @@ -9,8 +9,8 @@ info: Provides ways to manage Bare Metal Solution hardware installed in a regional extension located near a Google Cloud data center. version: v2 - x-discovery-doc-revision: '20241028' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250528' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/bare-metal servers: @@ -1535,7 +1535,7 @@ components: type: string id: description: >- - A transient unique identifier to idenfity an instance within an + A transient unique identifier to identify an instance within an ProvisioningConfig request. deprecated: true type: string @@ -2490,10 +2490,10 @@ components: - $ref: '#/components/x-stackQL-resources/networks/methods/patch' replace: [] delete: [] - networks_network_usage: - id: google.baremetalsolution.networks_network_usage - name: networks_network_usage - title: Networks_network_usage + network_usage: + id: google.baremetalsolution.network_usage + name: network_usage + title: Network_usage methods: list_network_usage: operation: @@ -2505,7 +2505,7 @@ components: sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/networks_network_usage/methods/list_network_usage + #/components/x-stackQL-resources/network_usage/methods/list_network_usage insert: [] update: [] replace: [] @@ -2728,6 +2728,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v2/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: @@ -4404,7 +4408,7 @@ paths: /v2/projects/{projectsId}/locations/{locationsId}/provisioningConfigs:submit: parameters: *ref_1 post: - description: Submit a provisiong configuration for a given project. + description: Submit a provisioning configuration for a given project. operationId: baremetalsolution.projects.locations.provisioningConfigs.submit requestBody: content: diff --git a/providers/src/googleapis.com/v00.00.00000/services/batch.yaml b/providers/src/googleapis.com/v00.00.00000/services/batch.yaml index 569fe010..f76f67f3 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/batch.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/batch.yaml @@ -7,8 +7,8 @@ info: title: Batch API description: An API to manage the running of Batch resources on Google Cloud Platform. version: v1 - x-discovery-doc-revision: '20241021' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250813' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/batch/ servers: @@ -858,8 +858,9 @@ components: description: >- Name of an instance template used to create VMs. Named the field as 'instance_template' instead of 'template' to avoid C++ keyword - conflict. Batch only supports global instance templates. You can - specify the global instance template as a full or partial URL. + conflict. Batch only supports global instance templates from the + same project as the job. You can specify the global instance + template as a full or partial URL. type: string installGpuDrivers: description: >- @@ -921,11 +922,21 @@ components: by this field) is the older model, and has been migrated to use the SPOT model as the underlying technology. This old model will still be supported. + - >- + Bound to the lifecycle of the reservation in which it is + provisioned. + enumDeprecated: + - false + - false + - false + - true + - false enum: - PROVISIONING_MODEL_UNSPECIFIED - STANDARD - SPOT - PREEMPTIBLE + - RESERVATION_BOUND accelerators: description: The accelerators attached to each VM instance. type: array @@ -1166,6 +1177,12 @@ components: The Job will be deleted, but has not been deleted yet. Typically this is because resources used by the Job are still being cleaned up. + - >- + The Job cancellation is in progress, this is because the resources + used by the Job are still being cleaned up. + - >- + The Job has been cancelled, the task executions were stopped and + the resources were cleaned up. enum: - STATE_UNSPECIFIED - QUEUED @@ -1174,6 +1191,8 @@ components: - SUCCEEDED - FAILED - DELETION_IN_PROGRESS + - CANCELLATION_IN_PROGRESS + - CANCELLED statusEvents: description: Job status events type: array @@ -1288,11 +1307,21 @@ components: by this field) is the older model, and has been migrated to use the SPOT model as the underlying technology. This old model will still be supported. + - >- + Bound to the lifecycle of the reservation in which it is + provisioned. + enumDeprecated: + - false + - false + - false + - true + - false enum: - PROVISIONING_MODEL_UNSPECIFIED - STANDARD - SPOT - PREEMPTIBLE + - RESERVATION_BOUND taskPack: description: The max number of tasks can be assigned to this instance type. type: string @@ -1303,32 +1332,41 @@ components: LogsPolicy: id: LogsPolicy description: >- - LogsPolicy describes how outputs from a Job's Tasks (stdout/stderr) will - be preserved. + LogsPolicy describes if and how a job's logs are preserved. Logs include + information that is automatically written by the Batch service agent and + any information that you configured the job's runnables to write to the + `stdout` or `stderr` streams. type: object properties: destination: - description: Where logs should be saved. + description: If and where logs should be saved. type: string enumDescriptions: - - Logs are not preserved. - - Logs are streamed to Cloud Logging. - - Logs are saved to a file path. + - (Default) Logs are not preserved. + - >- + Logs are streamed to Cloud Logging. Optionally, you can configure + additional settings in the `cloudLoggingOption` field. + - Logs are saved to the file path specified in the `logsPath` field. enum: - DESTINATION_UNSPECIFIED - CLOUD_LOGGING - PATH logsPath: description: >- - The path to which logs are saved when the destination = PATH. This - can be a local file path on the VM, or under the mount point of a - Persistent Disk or Filestore, or a Cloud Storage path. + When `destination` is set to `PATH`, you must set this field to the + path where you want logs to be saved. This path can point to a local + directory on the VM or (if congifured) a directory under the mount + path of any Cloud Storage bucket, network file system (NFS), or + writable persistent disk that is mounted to the job. For example, if + the job has a bucket with `mountPath` set to `/mnt/disks/my-bucket`, + you can write logs to the root directory of the `remotePath` of that + bucket by setting this field to `/mnt/disks/my-bucket/`. type: string cloudLoggingOption: description: >- - Optional. Additional settings for Cloud Logging. It will only take - effect when the destination of `LogsPolicy` is set to - `CLOUD_LOGGING`. + Optional. When `destination` is set to `CLOUD_LOGGING`, you can + optionally set this field to configure additional settings for Cloud + Logging. $ref: '#/components/schemas/CloudLoggingOption' CloudLoggingOption: id: CloudLoggingOption @@ -1339,7 +1377,7 @@ components: properties: useGenericTaskMonitoredResource: description: >- - Optional. Set this flag to true to change the [monitored resource + Optional. Set this field to `true` to change the [monitored resource type](https://cloud.google.com/monitoring/api/resources) for Cloud Logging logs generated by this Batch job from the [`batch.googleapis.com/Job`](https://cloud.google.com/monitoring/api/resources#tag_batch.googleapis.com/Job) @@ -1412,6 +1450,12 @@ components: The Job will be deleted, but has not been deleted yet. Typically this is because resources used by the Job are still being cleaned up. + - >- + The Job cancellation is in progress, this is because the resources + used by the Job are still being cleaned up. + - >- + The Job has been cancelled, the task executions were stopped and + the resources were cleaned up. enum: - STATE_UNSPECIFIED - QUEUED @@ -1420,6 +1464,8 @@ components: - SUCCEEDED - FAILED - DELETION_IN_PROGRESS + - CANCELLATION_IN_PROGRESS + - CANCELLED newTaskState: description: The new task state. type: string @@ -1439,6 +1485,26 @@ components: - FAILED - SUCCEEDED - UNEXECUTED + CancelJobRequest: + id: CancelJobRequest + description: CancelJob Request. + type: object + properties: + requestId: + description: >- + Optional. An optional request ID to identify requests. Specify a + unique request ID so that if you must retry your request, the server + will know to ignore the request if it has already been completed. + The server will guarantee that for at least 60 minutes after the + first request. For example, consider a situation where you make an + initial request and the request times out. If you make the request + again with the same request ID, the server can check if original + operation with the same request ID was received, and if so, will + ignore the second request. This prevents clients from accidentally + creating duplicate commitments. The request ID must be a valid UUID + with the exception that zero UUID is not supported + (00000000-0000-0000-0000-000000000000). + type: string ListJobsResponse: id: ListJobsResponse description: ListJob Response. @@ -2024,8 +2090,8 @@ components: description: >- Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled - have Operation.error value with a google.rpc.Status.code of 1, - corresponding to `Code.CANCELLED`. + have google.longrunning.Operation.error value with a + google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. readOnly: true type: boolean apiVersion: @@ -2216,6 +2282,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + cancel: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1jobs~1{jobsId}:cancel/post + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/jobs/methods/get' @@ -2254,10 +2327,10 @@ components: update: [] replace: [] delete: [] - state: - id: google.batch.state - name: state - title: State + agent_state_report: + id: google.batch.agent_state_report + name: agent_state_report + title: Agent_state_report methods: report: operation: @@ -2320,6 +2393,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: @@ -2474,7 +2551,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: batch.projects.locations.operations.cancel requestBody: content: @@ -2665,6 +2742,44 @@ paths: name: requestId schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}:cancel: + parameters: *ref_1 + post: + description: Cancel a Job. + operationId: batch.projects.locations.jobs.cancel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CancelJobRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: jobsId + required: true + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}/taskGroups/{taskGroupsId}/tasks/{tasksId}: parameters: *ref_1 get: diff --git a/providers/src/googleapis.com/v00.00.00000/services/beyondcorp.yaml b/providers/src/googleapis.com/v00.00.00000/services/beyondcorp.yaml index e89429ae..0498190e 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/beyondcorp.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/beyondcorp.yaml @@ -11,8 +11,8 @@ info: Enterprise APIs, enterprises can set up multi-cloud and on-prem connectivity solutions. version: v1 - x-discovery-doc-revision: '20241024' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250805' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/ servers: @@ -747,14 +747,6 @@ components: description: Required. The ingress port of an allocated connection type: integer format: int32 - ShouldThrottleResponse: - id: ShouldThrottleResponse - description: Response message for calling ShouldThrottle - type: object - properties: - shouldThrottle: - description: Whether the port should be throttled - type: boolean GoogleCloudBeyondcorpSecuritygatewaysV1ListSecurityGatewaysResponse: id: GoogleCloudBeyondcorpSecuritygatewaysV1ListSecurityGatewaysResponse description: Message for response to listing SecurityGateways. @@ -778,7 +770,7 @@ components: type: string GoogleCloudBeyondcorpSecuritygatewaysV1SecurityGateway: id: GoogleCloudBeyondcorpSecuritygatewaysV1SecurityGateway - description: Information about a BeyoncCorp SecurityGateway resource. + description: The information about a security gateway resource. type: object properties: name: @@ -817,9 +809,7 @@ components: - SecurityGateway is being updated. - SecurityGateway is being deleted. - SecurityGateway is running. - - >- - SecurityGateway is down and may be restored in the future. This - happens when CCFE sends ProjectState = OFF. + - SecurityGateway is down and may be restored in the future. - >- SecurityGateway encountered an error and is in an indeterministic state. @@ -838,6 +828,12 @@ components: type: object additionalProperties: $ref: '#/components/schemas/GoogleCloudBeyondcorpSecuritygatewaysV1Hub' + delegatingServiceAccount: + description: >- + Output only. Service account used for operations that involve + resources in consumer projects. + readOnly: true + type: string GoogleCloudBeyondcorpSecuritygatewaysV1Hub: id: GoogleCloudBeyondcorpSecuritygatewaysV1Hub description: >- @@ -860,56 +856,6 @@ components: type: array items: type: string - GoogleCloudBeyondcorpSecuritygatewaysV1SetPeeringRequest: - id: GoogleCloudBeyondcorpSecuritygatewaysV1SetPeeringRequest - description: >- - Set Peering request for creating a VPC peering between Google network - and customer networks. - type: object - properties: - peerings: - description: Required. List of Peering connection information. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudBeyondcorpSecuritygatewaysV1Peering - requestId: - description: >- - Optional. An optional request ID to identify requests. Specify a - unique request ID so that if you must retry your request, the server - will know to ignore the request if it has already been completed. - The server will guarantee that for at least 60 minutes since the - first request. For example, consider a situation where you make an - initial request and the request times out. If you make the request - again with the same request ID, the server can check if original - operation with the same request ID was received, and if so, will - ignore the second request. This prevents clients from accidentally - creating duplicate commitments. The request ID must be a valid UUID - with the exception that zero UUID is not supported - (00000000-0000-0000-0000-000000000000). - type: string - validateOnly: - description: >- - Optional. If set, validates request by executing a dry-run which - would not alter the resource in any way. - type: boolean - GoogleCloudBeyondcorpSecuritygatewaysV1Peering: - id: GoogleCloudBeyondcorpSecuritygatewaysV1Peering - description: VPC Peering details. - type: object - properties: - targetNetwork: - description: >- - Required. The name of the Target VPC network name in the format: - `projects/{project}/global/networks/{network} - type: string - dnsZones: - description: >- - Optional. List of DNS zones for DNS peering with the customer VPC - network. - type: array - items: - type: string GoogleCloudBeyondcorpSecuritygatewaysV1ListApplicationsResponse: id: GoogleCloudBeyondcorpSecuritygatewaysV1ListApplicationsResponse description: Message for response to listing Applications. @@ -933,7 +879,7 @@ components: type: string GoogleCloudBeyondcorpSecuritygatewaysV1Application: id: GoogleCloudBeyondcorpSecuritygatewaysV1Application - description: A Beyondcorp Application resource information. + description: The information about an application resource. type: object properties: name: @@ -942,13 +888,14 @@ components: endpointMatchers: description: >- Required. Endpoint matchers associated with an application. A - combination of hostname and ports as endpoint matcher is used to + combination of hostname and ports as endpoint matchers is used to match the application. Match conditions for OR logic. An array of match conditions to allow for multiple matching criteria. The rule - is considered a match if one the conditions are met. The conditions - can be one of the following combination (Hostname), (Hostname & - Ports) EXAMPLES: Hostname - ("*.abc.com"), ("xyz.abc.com") Hostname - and Ports - ("abc.com" and "22"), ("abc.com" and "22,33") etc + is considered a match if one of the conditions is met. The + conditions can be one of the following combinations (Hostname), + (Hostname & Ports) EXAMPLES: Hostname - ("*.example.com"), + ("xyz.example.com") Hostname and Ports - ("example.com" and "22"), + ("example.com" and "22,33") etc type: array items: $ref: >- @@ -965,9 +912,15 @@ components: format: google-datetime displayName: description: >- - Optional. An arbitrary user-provided name for the Application + Optional. An arbitrary user-provided name for the application resource. Cannot exceed 64 characters. type: string + upstreams: + description: Optional. Which upstream resources to forward traffic to. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudBeyondcorpSecuritygatewaysV1ApplicationUpstream GoogleCloudBeyondcorpSecuritygatewaysV1EndpointMatcher: id: GoogleCloudBeyondcorpSecuritygatewaysV1EndpointMatcher description: >- @@ -984,6 +937,39 @@ components: items: type: integer format: int32 + GoogleCloudBeyondcorpSecuritygatewaysV1ApplicationUpstream: + id: GoogleCloudBeyondcorpSecuritygatewaysV1ApplicationUpstream + description: Which upstream resource to forward traffic to. + type: object + properties: + network: + description: Network to forward traffic to. + $ref: >- + #/components/schemas/GoogleCloudBeyondcorpSecuritygatewaysV1ApplicationUpstreamNetwork + egressPolicy: + description: Optional. Routing policy information. + $ref: >- + #/components/schemas/GoogleCloudBeyondcorpSecuritygatewaysV1EgressPolicy + GoogleCloudBeyondcorpSecuritygatewaysV1ApplicationUpstreamNetwork: + id: GoogleCloudBeyondcorpSecuritygatewaysV1ApplicationUpstreamNetwork + description: Network to forward traffic to. + type: object + properties: + name: + description: >- + Required. Network name is of the format: + `projects/{project}/global/networks/{network} + type: string + GoogleCloudBeyondcorpSecuritygatewaysV1EgressPolicy: + id: GoogleCloudBeyondcorpSecuritygatewaysV1EgressPolicy + description: Routing policy information. + type: object + properties: + regions: + description: Required. List of the regions where the application sends traffic. + type: array + items: + type: string GoogleCloudLocationListLocationsResponse: id: GoogleCloudLocationListLocationsResponse description: The response message for Locations.ListLocations. @@ -1453,8 +1439,8 @@ components: description: >- Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled - have Operation.error value with a google.rpc.Status.code of 1, - corresponding to `Code.CANCELLED`. + have google.longrunning.Operation.error value with a + google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. readOnly: true type: boolean apiVersion: @@ -1494,8 +1480,8 @@ components: description: >- Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled - have Operation.error value with a google.rpc.Status.code of 1, - corresponding to `Code.CANCELLED`. + have google.longrunning.Operation.error value with a + google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. readOnly: true type: boolean apiVersion: @@ -1535,8 +1521,8 @@ components: description: >- Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled - have Operation.error value with a google.rpc.Status.code of 1, - corresponding to `Code.CANCELLED`. + have google.longrunning.Operation.error value with a + google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. readOnly: true type: boolean apiVersion: @@ -1576,8 +1562,8 @@ components: description: >- Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled - have Operation.error value with a google.rpc.Status.code of 1, - corresponding to `Code.CANCELLED`. + have google.longrunning.Operation.error value with a + google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. readOnly: true type: boolean apiVersion: @@ -1758,8 +1744,8 @@ components: description: >- Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled - have Operation.error value with a google.rpc.Status.code of 1, - corresponding to `Code.CANCELLED`. + have google.longrunning.Operation.error value with a + google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. readOnly: true type: boolean apiVersion: @@ -1799,8 +1785,8 @@ components: description: >- Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled - have Operation.error value with a google.rpc.Status.code of 1, - corresponding to `Code.CANCELLED`. + have google.longrunning.Operation.error value with a + google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. readOnly: true type: boolean apiVersion: @@ -2499,13 +2485,6 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_locations_app_gateways_should_throttle: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1appGateways~1{appGatewaysId}:shouldThrottle/get - response: - mediaType: application/json - openAPIDocKey: '200' projects_locations_app_gateways_get: operation: $ref: >- @@ -2612,13 +2591,6 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_locations_security_gateways_set_peering: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1securityGateways~1{securityGatewaysId}:setPeering/post - response: - mediaType: application/json - openAPIDocKey: '200' sqlVerbs: select: - $ref: >- @@ -2685,31 +2657,31 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.applications - projects_locations_security_gateways_applications_get: + projects_locations_security_gateways_applications_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1securityGateways~1{securityGatewaysId}~1applications~1{applicationsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1securityGateways~1{securityGatewaysId}~1applications/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_security_gateways_applications_delete: + projects_locations_security_gateways_applications_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1securityGateways~1{securityGatewaysId}~1applications~1{applicationsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1securityGateways~1{securityGatewaysId}~1applications~1{applicationsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_global_security_gateways_applications_create: + projects_locations_security_gateways_applications_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1global~1securityGateways~1{securityGatewaysId}~1applications/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1securityGateways~1{securityGatewaysId}~1applications~1{applicationsId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_global_security_gateways_applications_patch: + projects_locations_security_gateways_applications_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1global~1securityGateways~1{securityGatewaysId}~1applications~1{applicationsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1securityGateways~1{securityGatewaysId}~1applications~1{applicationsId}/delete response: mediaType: application/json openAPIDocKey: '200' @@ -2721,10 +2693,10 @@ components: #/components/x-stackQL-resources/applications/methods/projects_locations_security_gateways_applications_list insert: - $ref: >- - #/components/x-stackQL-resources/applications/methods/projects_locations_global_security_gateways_applications_create + #/components/x-stackQL-resources/applications/methods/projects_locations_security_gateways_applications_create update: - $ref: >- - #/components/x-stackQL-resources/applications/methods/projects_locations_global_security_gateways_applications_patch + #/components/x-stackQL-resources/applications/methods/projects_locations_security_gateways_applications_patch replace: [] delete: - $ref: >- @@ -2749,10 +2721,10 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_global_security_gateways_applications_test_iam_permissions: + projects_locations_security_gateways_applications_test_iam_permissions: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1global~1securityGateways~1{securityGatewaysId}~1applications~1{applicationsId}:testIamPermissions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1securityGateways~1{securityGatewaysId}~1applications~1{applicationsId}:testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' @@ -2766,191 +2738,6 @@ components: - $ref: >- #/components/x-stackQL-resources/applications_iam_policies/methods/projects_locations_security_gateways_applications_set_iam_policy delete: [] - client_connector_services_iam_policies: - id: google.beyondcorp.client_connector_services_iam_policies - name: client_connector_services_iam_policies - title: Client_connector_services_iam_policies - methods: - projects_locations_client_connector_services_set_iam_policy: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clientConnectorServices~1{clientConnectorServicesId}:setIamPolicy/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_client_connector_services_get_iam_policy: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clientConnectorServices~1{clientConnectorServicesId}:getIamPolicy/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.bindings - projects_locations_client_connector_services_test_iam_permissions: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clientConnectorServices~1{clientConnectorServicesId}:testIamPermissions/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/client_connector_services_iam_policies/methods/projects_locations_client_connector_services_get_iam_policy - insert: [] - update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/client_connector_services_iam_policies/methods/projects_locations_client_connector_services_set_iam_policy - delete: [] - client_gateways_iam_policies: - id: google.beyondcorp.client_gateways_iam_policies - name: client_gateways_iam_policies - title: Client_gateways_iam_policies - methods: - projects_locations_client_gateways_set_iam_policy: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clientGateways~1{clientGatewaysId}:setIamPolicy/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_client_gateways_get_iam_policy: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clientGateways~1{clientGatewaysId}:getIamPolicy/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.bindings - projects_locations_client_gateways_test_iam_permissions: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clientGateways~1{clientGatewaysId}:testIamPermissions/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/client_gateways_iam_policies/methods/projects_locations_client_gateways_get_iam_policy - insert: [] - update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/client_gateways_iam_policies/methods/projects_locations_client_gateways_set_iam_policy - delete: [] - partner_tenants_iam_policies: - id: google.beyondcorp.partner_tenants_iam_policies - name: partner_tenants_iam_policies - title: Partner_tenants_iam_policies - methods: - organizations_locations_global_partner_tenants_set_iam_policy: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1global~1partnerTenants~1{partnerTenantsId}:setIamPolicy/post - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_locations_global_partner_tenants_get_iam_policy: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1global~1partnerTenants~1{partnerTenantsId}:getIamPolicy/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.bindings - organizations_locations_global_partner_tenants_test_iam_permissions: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1global~1partnerTenants~1{partnerTenantsId}:testIamPermissions/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/partner_tenants_iam_policies/methods/organizations_locations_global_partner_tenants_get_iam_policy - insert: [] - update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/partner_tenants_iam_policies/methods/organizations_locations_global_partner_tenants_set_iam_policy - delete: [] - proxy_configs_iam_policies: - id: google.beyondcorp.proxy_configs_iam_policies - name: proxy_configs_iam_policies - title: Proxy_configs_iam_policies - methods: - organizations_locations_global_partner_tenants_proxy_configs_set_iam_policy: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1global~1partnerTenants~1{partnerTenantsId}~1proxyConfigs~1{proxyConfigsId}:setIamPolicy/post - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_locations_global_partner_tenants_proxy_configs_get_iam_policy: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1global~1partnerTenants~1{partnerTenantsId}~1proxyConfigs~1{proxyConfigsId}:getIamPolicy/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.bindings - organizations_locations_global_partner_tenants_proxy_configs_test_iam_permissions: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1global~1partnerTenants~1{partnerTenantsId}~1proxyConfigs~1{proxyConfigsId}:testIamPermissions/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/proxy_configs_iam_policies/methods/organizations_locations_global_partner_tenants_proxy_configs_get_iam_policy - insert: [] - update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/proxy_configs_iam_policies/methods/organizations_locations_global_partner_tenants_proxy_configs_set_iam_policy - delete: [] - browser_dlp_rules_iam_policies: - id: google.beyondcorp.browser_dlp_rules_iam_policies - name: browser_dlp_rules_iam_policies - title: Browser_dlp_rules_iam_policies - methods: - organizations_locations_global_partner_tenants_browser_dlp_rules_set_iam_policy: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1global~1partnerTenants~1{partnerTenantsId}~1browserDlpRules~1{browserDlpRulesId}:setIamPolicy/post - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_locations_global_partner_tenants_browser_dlp_rules_get_iam_policy: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1global~1partnerTenants~1{partnerTenantsId}~1browserDlpRules~1{browserDlpRulesId}:getIamPolicy/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.bindings - organizations_locations_global_partner_tenants_browser_dlp_rules_test_iam_permissions: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1global~1partnerTenants~1{partnerTenantsId}~1browserDlpRules~1{browserDlpRulesId}:testIamPermissions/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/browser_dlp_rules_iam_policies/methods/organizations_locations_global_partner_tenants_browser_dlp_rules_get_iam_policy - insert: [] - update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/browser_dlp_rules_iam_policies/methods/organizations_locations_global_partner_tenants_browser_dlp_rules_set_iam_policy - delete: [] paths: /v1/projects/{projectsId}/locations: parameters: &ref_1 @@ -2999,6 +2786,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: @@ -3153,7 +2944,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: beyondcorp.projects.locations.operations.cancel requestBody: content: @@ -4073,13 +3864,11 @@ paths: name: validateOnly schema: type: boolean - /v1/projects/{projectsId}/locations/{locationsId}/appGateways/{appGatewaysId}:shouldThrottle: + /v1/projects/{projectsId}/locations/{locationsId}/appGateways/{appGatewaysId}: parameters: *ref_1 get: - description: >- - Calls the Bouncer method ShouldThrottle to check if a request should be - throttled. - operationId: beyondcorp.projects.locations.appGateways.shouldThrottle + description: Gets details of a single AppGateway. + operationId: beyondcorp.projects.locations.appGateways.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4091,7 +3880,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ShouldThrottleResponse' + $ref: '#/components/schemas/AppGateway' parameters: - in: path name: projectsId @@ -4108,21 +3897,9 @@ paths: required: true schema: type: string - - in: query - name: port - schema: - type: integer - format: int32 - - in: query - name: requestedAmount - schema: - type: string - format: int64 - /v1/projects/{projectsId}/locations/{locationsId}/appGateways/{appGatewaysId}: - parameters: *ref_1 - get: - description: Gets details of a single AppGateway. - operationId: beyondcorp.projects.locations.appGateways.get + delete: + description: Deletes a single AppGateway. + operationId: beyondcorp.projects.locations.appGateways.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4134,38 +3911,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AppGateway' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: appGatewaysId - required: true - schema: - type: string - delete: - description: Deletes a single AppGateway. - operationId: beyondcorp.projects.locations.appGateways.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -4361,7 +4107,7 @@ paths: schema: type: string post: - description: Creates a new SecurityGateway in a given project and location. + description: Creates a new Security Gateway in a given project and location. operationId: beyondcorp.projects.locations.securityGateways.create requestBody: content: @@ -4519,48 +4265,6 @@ paths: name: validateOnly schema: type: boolean - /v1/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}:setPeering: - parameters: *ref_1 - post: - description: >- - This is a custom method to allow customers to create a peering - connections between Google network and customer networks. This is - enabled only for the allowlisted customers. - operationId: beyondcorp.projects.locations.securityGateways.setPeering - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudBeyondcorpSecuritygatewaysV1SetPeeringRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: securityGatewaysId - required: true - schema: - type: string /v1/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}:setIamPolicy: parameters: *ref_1 post: @@ -4736,11 +4440,15 @@ paths: name: orderBy schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}/applications/{applicationsId}: - parameters: *ref_1 - get: - description: Gets details of a single Application. - operationId: beyondcorp.projects.locations.securityGateways.applications.get + post: + description: Creates a new Application in a given project and location. + operationId: beyondcorp.projects.locations.securityGateways.applications.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudBeyondcorpSecuritygatewaysV1Application security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4752,8 +4460,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudBeyondcorpSecuritygatewaysV1Application + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -4770,14 +4477,19 @@ paths: required: true schema: type: string - - in: path - name: applicationsId - required: true + - in: query + name: applicationId schema: type: string - delete: - description: Deletes a single Application. - operationId: beyondcorp.projects.locations.securityGateways.applications.delete + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}/applications/{applicationsId}: + parameters: *ref_1 + get: + description: Gets details of a single Application. + operationId: beyondcorp.projects.locations.securityGateways.applications.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4789,7 +4501,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudBeyondcorpSecuritygatewaysV1Application parameters: - in: path name: projectsId @@ -4811,27 +4524,15 @@ paths: required: true schema: type: string - - in: query - name: requestId - schema: - type: string - - in: query - name: validateOnly - schema: - type: boolean - /v1/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}/applications/{applicationsId}:setIamPolicy: - parameters: *ref_1 - post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - `PERMISSION_DENIED` errors. - operationId: beyondcorp.projects.locations.securityGateways.applications.setIamPolicy + patch: + description: Updates the parameters of a single Application. + operationId: beyondcorp.projects.locations.securityGateways.applications.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' + $ref: >- + #/components/schemas/GoogleCloudBeyondcorpSecuritygatewaysV1Application security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4843,7 +4544,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -4865,13 +4566,18 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}/applications/{applicationsId}:getIamPolicy: - parameters: *ref_1 - get: - description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: beyondcorp.projects.locations.securityGateways.applications.getIamPolicy + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: requestId + schema: + type: string + delete: + description: Deletes a single application. + operationId: beyondcorp.projects.locations.securityGateways.applications.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4883,7 +4589,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -4906,22 +4612,26 @@ paths: schema: type: string - in: query - name: options.requestedPolicyVersion + name: requestId schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/global/securityGateways/{securityGatewaysId}/applications: + type: string + - in: query + name: validateOnly + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}/applications/{applicationsId}:setIamPolicy: parameters: *ref_1 post: - description: Creates a new Application in a given project and location. - operationId: >- - beyondcorp.projects.locations.global.securityGateways.applications.create + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and + `PERMISSION_DENIED` errors. + operationId: beyondcorp.projects.locations.securityGateways.applications.setIamPolicy requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudBeyondcorpSecuritygatewaysV1Application + $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4933,7 +4643,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -4941,29 +4651,27 @@ paths: schema: type: string - in: path - name: securityGatewaysId + name: locationsId required: true schema: type: string - - in: query - name: applicationId + - in: path + name: securityGatewaysId + required: true schema: type: string - - in: query - name: requestId + - in: path + name: applicationsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/global/securityGateways/{securityGatewaysId}/applications/{applicationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}/applications/{applicationsId}:getIamPolicy: parameters: *ref_1 - patch: - description: Updates the parameters of a single Application. - operationId: beyondcorp.projects.locations.global.securityGateways.applications.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudBeyondcorpSecuritygatewaysV1Application + get: + description: >- + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: beyondcorp.projects.locations.securityGateways.applications.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4975,7 +4683,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -4983,25 +4691,26 @@ paths: schema: type: string - in: path - name: securityGatewaysId + name: locationsId required: true schema: type: string - in: path - name: applicationsId + name: securityGatewaysId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: applicationsId + required: true schema: type: string - format: google-fieldmask - in: query - name: requestId + name: options.requestedPolicyVersion schema: - type: string - /v1/projects/{projectsId}/locations/global/securityGateways/{securityGatewaysId}/applications/{applicationsId}:testIamPermissions: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}/applications/{applicationsId}:testIamPermissions: parameters: *ref_1 post: description: >- @@ -5011,7 +4720,7 @@ paths: building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. operationId: >- - beyondcorp.projects.locations.global.securityGateways.applications.testIamPermissions + beyondcorp.projects.locations.securityGateways.applications.testIamPermissions requestBody: content: application/json: @@ -5035,6 +4744,11 @@ paths: required: true schema: type: string + - in: path + name: locationsId + required: true + schema: + type: string - in: path name: securityGatewaysId required: true @@ -5045,19 +4759,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/clientConnectorServices/{clientConnectorServicesId}:setIamPolicy: + /v1/organizations/{organizationsId}/locations/{locationsId}/operations: parameters: *ref_1 - post: + get: description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - `PERMISSION_DENIED` errors. - operationId: beyondcorp.projects.locations.clientConnectorServices.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: beyondcorp.organizations.locations.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5069,10 +4777,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -5081,18 +4789,27 @@ paths: required: true schema: type: string - - in: path - name: clientConnectorServicesId - required: true + - in: query + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/clientConnectorServices/{clientConnectorServicesId}:getIamPolicy: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}: parameters: *ref_1 get: description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: beyondcorp.projects.locations.clientConnectorServices.getIamPolicy + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: beyondcorp.organizations.locations.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5104,10 +4821,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -5117,262 +4834,11 @@ paths: schema: type: string - in: path - name: clientConnectorServicesId + name: operationsId required: true schema: type: string - - in: query - name: options.requestedPolicyVersion - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/clientConnectorServices/{clientConnectorServicesId}:testIamPermissions: - parameters: *ref_1 - post: - description: >- - Returns permissions that a caller has on the specified resource. If the - resource does not exist, this will return an empty set of permissions, - not a `NOT_FOUND` error. Note: This operation is designed to be used for - building permission-aware UIs and command-line tools, not for - authorization checking. This operation may "fail open" without warning. - operationId: beyondcorp.projects.locations.clientConnectorServices.testIamPermissions - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: clientConnectorServicesId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/clientGateways/{clientGatewaysId}:setIamPolicy: - parameters: *ref_1 - post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - `PERMISSION_DENIED` errors. - operationId: beyondcorp.projects.locations.clientGateways.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1Policy' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: clientGatewaysId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/clientGateways/{clientGatewaysId}:getIamPolicy: - parameters: *ref_1 - get: - description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: beyondcorp.projects.locations.clientGateways.getIamPolicy - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1Policy' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: clientGatewaysId - required: true - schema: - type: string - - in: query - name: options.requestedPolicyVersion - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/clientGateways/{clientGatewaysId}:testIamPermissions: - parameters: *ref_1 - post: - description: >- - Returns permissions that a caller has on the specified resource. If the - resource does not exist, this will return an empty set of permissions, - not a `NOT_FOUND` error. Note: This operation is designed to be used for - building permission-aware UIs and command-line tools, not for - authorization checking. This operation may "fail open" without warning. - operationId: beyondcorp.projects.locations.clientGateways.testIamPermissions - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: clientGatewaysId - required: true - schema: - type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/operations: - parameters: *ref_1 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: beyondcorp.organizations.locations.operations.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_1 - get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: beyondcorp.organizations.locations.operations.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: operationsId - required: true - schema: - type: string - delete: + delete: description: >- Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the @@ -5419,7 +4885,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: beyondcorp.organizations.locations.operations.cancel requestBody: content: @@ -5454,367 +4920,3 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}:setIamPolicy: - parameters: *ref_1 - post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - `PERMISSION_DENIED` errors. - operationId: beyondcorp.organizations.locations.global.partnerTenants.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1Policy' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: partnerTenantsId - required: true - schema: - type: string - /v1/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}:getIamPolicy: - parameters: *ref_1 - get: - description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: beyondcorp.organizations.locations.global.partnerTenants.getIamPolicy - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1Policy' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: partnerTenantsId - required: true - schema: - type: string - - in: query - name: options.requestedPolicyVersion - schema: - type: integer - format: int32 - /v1/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}:testIamPermissions: - parameters: *ref_1 - post: - description: >- - Returns permissions that a caller has on the specified resource. If the - resource does not exist, this will return an empty set of permissions, - not a `NOT_FOUND` error. Note: This operation is designed to be used for - building permission-aware UIs and command-line tools, not for - authorization checking. This operation may "fail open" without warning. - operationId: >- - beyondcorp.organizations.locations.global.partnerTenants.testIamPermissions - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: partnerTenantsId - required: true - schema: - type: string - /v1/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/proxyConfigs/{proxyConfigsId}:setIamPolicy: - parameters: *ref_1 - post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - `PERMISSION_DENIED` errors. - operationId: >- - beyondcorp.organizations.locations.global.partnerTenants.proxyConfigs.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1Policy' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: partnerTenantsId - required: true - schema: - type: string - - in: path - name: proxyConfigsId - required: true - schema: - type: string - /v1/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/proxyConfigs/{proxyConfigsId}:getIamPolicy: - parameters: *ref_1 - get: - description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: >- - beyondcorp.organizations.locations.global.partnerTenants.proxyConfigs.getIamPolicy - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1Policy' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: partnerTenantsId - required: true - schema: - type: string - - in: path - name: proxyConfigsId - required: true - schema: - type: string - - in: query - name: options.requestedPolicyVersion - schema: - type: integer - format: int32 - /v1/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/proxyConfigs/{proxyConfigsId}:testIamPermissions: - parameters: *ref_1 - post: - description: >- - Returns permissions that a caller has on the specified resource. If the - resource does not exist, this will return an empty set of permissions, - not a `NOT_FOUND` error. Note: This operation is designed to be used for - building permission-aware UIs and command-line tools, not for - authorization checking. This operation may "fail open" without warning. - operationId: >- - beyondcorp.organizations.locations.global.partnerTenants.proxyConfigs.testIamPermissions - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: partnerTenantsId - required: true - schema: - type: string - - in: path - name: proxyConfigsId - required: true - schema: - type: string - /v1/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/browserDlpRules/{browserDlpRulesId}:setIamPolicy: - parameters: *ref_1 - post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - `PERMISSION_DENIED` errors. - operationId: >- - beyondcorp.organizations.locations.global.partnerTenants.browserDlpRules.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1Policy' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: partnerTenantsId - required: true - schema: - type: string - - in: path - name: browserDlpRulesId - required: true - schema: - type: string - /v1/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/browserDlpRules/{browserDlpRulesId}:getIamPolicy: - parameters: *ref_1 - get: - description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: >- - beyondcorp.organizations.locations.global.partnerTenants.browserDlpRules.getIamPolicy - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1Policy' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: partnerTenantsId - required: true - schema: - type: string - - in: path - name: browserDlpRulesId - required: true - schema: - type: string - - in: query - name: options.requestedPolicyVersion - schema: - type: integer - format: int32 - /v1/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/browserDlpRules/{browserDlpRulesId}:testIamPermissions: - parameters: *ref_1 - post: - description: >- - Returns permissions that a caller has on the specified resource. If the - resource does not exist, this will return an empty set of permissions, - not a `NOT_FOUND` error. Note: This operation is designed to be used for - building permission-aware UIs and command-line tools, not for - authorization checking. This operation may "fail open" without warning. - operationId: >- - beyondcorp.organizations.locations.global.partnerTenants.browserDlpRules.testIamPermissions - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: partnerTenantsId - required: true - schema: - type: string - - in: path - name: browserDlpRulesId - required: true - schema: - type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/biglake.yaml b/providers/src/googleapis.com/v00.00.00000/services/biglake.yaml index 24449112..a3d7bbc5 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/biglake.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/biglake.yaml @@ -10,8 +10,8 @@ info: managed, and highly available metastore for open-source data that can be used for querying Apache Iceberg tables in BigQuery. version: v1 - x-discovery-doc-revision: '20241014' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250820' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/bigquery/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/bigquery.yaml b/providers/src/googleapis.com/v00.00.00000/services/bigquery.yaml index c8806936..751de3ce 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/bigquery.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/bigquery.yaml @@ -7,8 +7,8 @@ info: title: BigQuery API description: A data platform for customers to create, manage, share and query data. version: v2 - x-discovery-doc-revision: '20241013' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250713' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/bigquery/ servers: @@ -97,7 +97,7 @@ components: description: >- Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For - multi-class classfication models this is the confidence threshold. + multi-class classification models this is the confidence threshold. format: double type: number type: object @@ -140,11 +140,11 @@ components: a struct or an array, but not a table. - >- The argument is any type, including struct or array, but not a - table. To be added: FIXED_TABLE, ANY_TABLE + table. type: string dataType: $ref: '#/components/schemas/StandardSqlDataType' - description: Required unless argument_kind = ANY_TYPE. + description: Set if argument_kind == FIXED_TYPE. isAggregate: description: >- Optional. Whether the argument is an aggregate function parameter. @@ -546,6 +546,22 @@ components: INTEGER). type: boolean type: object + BatchDeleteRowAccessPoliciesRequest: + description: Request message for the BatchDeleteRowAccessPoliciesRequest method. + id: BatchDeleteRowAccessPoliciesRequest + properties: + force: + description: >- + If set to true, it deletes the row access policy even if it's the + last row access policy on the table and the deletion will widen the + access rather narrowing it. + type: boolean + policyIds: + description: Required. Policy IDs of the row access policies. + items: + type: string + type: array + type: object BiEngineReason: description: Reason why BI Engine didn't accelerate the query (or sub-query). id: BiEngineReason @@ -641,19 +657,21 @@ components: type: array type: object BigLakeConfiguration: - description: Configuration for BigLake managed tables. + description: >- + Configuration for BigQuery tables for Apache Iceberg (formerly BigLake + managed tables.) id: BigLakeConfiguration properties: connectionId: description: >- - Required. The connection specifying the credentials to be used to + Optional. The connection specifying the credentials to be used to read and write to external storage, such as Cloud Storage. The connection_id can have the form `{project}.{location}.{connection_id}` or `projects/{project}/locations/{location}/connections/{connection_id}". type: string fileFormat: - description: Required. The file format the table data is stored in. + description: Optional. The file format the table data is stored in. enum: - FILE_FORMAT_UNSPECIFIED - PARQUET @@ -663,14 +681,14 @@ components: type: string storageUri: description: >- - Required. The fully qualified location prefix of the external folder + Optional. The fully qualified location prefix of the external folder where table data is stored. The '*' wildcard character is not allowed. The URI should be in the format `gs://bucket/path_to_table/` type: string tableFormat: description: >- - Required. The table format the metadata only snapshots are stored + Optional. The table format the metadata only snapshots are stored in. enum: - TABLE_FORMAT_UNSPECIFIED @@ -1135,9 +1153,9 @@ components: One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. The ordering of the clustering fields should be prioritized from most to - least important for filtering purposes. Additional information on - limitations can be found here: - https://cloud.google.com/bigquery/docs/creating-clustered-tables#limitations + least important for filtering purposes. For additional information, + see [Introduction to clustered + tables](https://cloud.google.com/bigquery/docs/clustered-tables#limitations). items: type: string type: array @@ -1261,6 +1279,18 @@ components: except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value. type: string + nullMarkers: + description: >- + Optional. A list of strings represented as SQL NULL value in a CSV + file. null_marker and null_markers can't be set at the same time. If + null_marker is set, null_markers has to be not set. If null_markers + is set, null_marker has to be not set. If both null_marker and + null_markers are set at the same time, a user error would be thrown. + Any strings listed in null_markers, including empty string would be + interpreted as SQL NULL. This applies to all column types. + items: + type: string + type: array preserveAsciiControlCharacters: description: >- Optional. Indicates if the embedded ASCII control characters (the @@ -1299,11 +1329,41 @@ components: detected schema. format: int64 type: string + sourceColumnMatch: + description: >- + Optional. Controls the strategy used to match loaded columns to the + schema. If not set, a sensible default is chosen based on how the + schema is provided. If autodetect is used, then columns are matched + by name. Otherwise, columns are matched by position. This is done to + keep the behavior backward-compatible. Acceptable values are: + POSITION - matches by position. This assumes that the columns are + ordered the same way as the schema. NAME - matches by name. This + reads the header row as column names and reorders columns to match + the field names in the schema. + type: string type: object DataFormatOptions: description: Options for data format adjustments. id: DataFormatOptions properties: + timestampOutputFormat: + description: >- + Optional. The API output format for a timestamp. This offers more + explicit control over the timestamp output format as compared to the + existing `use_int64_timestamp` option. + enum: + - TIMESTAMP_OUTPUT_FORMAT_UNSPECIFIED + - FLOAT64 + - INT64 + - ISO8601_STRING + enumDescriptions: + - Corresponds to default API output behavior, which is FLOAT64. + - Timestamp is output as float64 seconds since Unix epoch. + - Timestamp is output as int64 microseconds since Unix epoch. + - >- + Timestamp is output as ISO 8601 String + ("YYYY-MM-DDTHH:MM:SS.FFFFFFFFFFFFZ"). + type: string useInt64Timestamp: description: Optional. Output timestamp as usec int64. Default is false. type: boolean @@ -1744,6 +1804,13 @@ components: description: >- The dataset reference. Use this property to access specific parts of the dataset's ID, such as project ID or dataset ID. + externalDatasetReference: + $ref: '#/components/schemas/ExternalDatasetReference' + description: >- + Output only. Reference to a read-only external dataset defined + in data catalogs outside of BigQuery. Filled out when the + dataset type is EXTERNAL. + readOnly: true friendlyName: description: >- An alternate name for the dataset. The friendly name is purely @@ -2319,7 +2386,7 @@ components: ExternalCatalogDatasetOptions: description: >- Options defining open source compatible datasets living in the BigQuery - catalog. Contains metadata of open source database, schema or namespace + catalog. Contains metadata of open source database, schema, or namespace represented by the current dataset. id: ExternalCatalogDatasetOptions properties: @@ -2334,30 +2401,30 @@ components: type: string description: >- Optional. A map of key value pairs defining the parameters and - properties of the open source schema. Maximum size of 2Mib. + properties of the open source schema. Maximum size of 2MiB. type: object type: object ExternalCatalogTableOptions: description: >- Metadata about open source compatible table. The fields contained in - these options correspond to hive metastore's table level properties. + these options correspond to Hive metastore's table-level properties. id: ExternalCatalogTableOptions properties: connectionId: description: >- - Optional. The connection specifying the credentials to be used to - read external storage, such as Azure Blob, Cloud Storage, or S3. The - connection is needed to read the open source table from BigQuery - Engine. The connection_id can have the form `..` or + Optional. A connection ID that specifies the credentials to be used + to read external storage, such as Azure Blob, Cloud Storage, or + Amazon S3. This connection is needed to read the open source table + from BigQuery. The connection_id format must be either `..` or `projects//locations//connections/`. type: string parameters: additionalProperties: type: string description: >- - Optional. A map of key value pairs defining the parameters and - properties of the open source table. Corresponds with hive meta - store table parameters. Maximum size of 4Mib. + Optional. A map of the key-value pairs defining the parameters and + properties of the open source table. Corresponds with Hive metastore + table parameters. Maximum size of 4MiB. type: object storageDescriptor: $ref: '#/components/schemas/StorageDescriptor' @@ -2401,6 +2468,16 @@ components: description: >- Optional. Additional properties to set if sourceFormat is set to CSV. + dateFormat: + description: >- + Optional. Format used to parse DATE values. Supports C-style and + SQL-style values. + type: string + datetimeFormat: + description: >- + Optional. Format used to parse DATETIME values. Supports C-style and + SQL-style values. + type: string decimalTargetTypes: description: >- Defines the list of possible SQL data types to which the source @@ -2417,7 +2494,7 @@ components: NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if - value exeeds supported range). This field cannot contain duplicate + value exceeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to @@ -2492,7 +2569,7 @@ components: enumDescriptions: - >- The default if provided value is not one included in the enum, or - the value is not specified. The source formate is parsed without + the value is not specified. The source format is parsed without any modification. - >- Use GeoJSON variant of JSON. See @@ -2589,6 +2666,23 @@ components: items: type: string type: array + timeFormat: + description: >- + Optional. Format used to parse TIME values. Supports C-style and + SQL-style values. + type: string + timeZone: + description: >- + Optional. Time zone used when parsing timestamp values that do not + have specific time zone information (e.g. 2024-04-20 12:34:56). The + expected format is a IANA timezone string (e.g. + America/Los_Angeles). + type: string + timestampFormat: + description: >- + Optional. Format used to parse TIMESTAMP values. Supports C-style + and SQL-style values. + type: string type: object ExternalDatasetReference: description: Configures the access a dataset defined in an external metadata storage. @@ -2604,6 +2698,44 @@ components: description: Required. External source that backs this dataset. type: string type: object + ExternalRuntimeOptions: + description: Options for the runtime of the external system. + id: ExternalRuntimeOptions + properties: + containerCpu: + description: >- + Optional. Amount of CPU provisioned for a Python UDF container + instance. For more information, see [Configure container limits for + Python + UDFs](https://cloud.google.com/bigquery/docs/user-defined-functions-python#configure-container-limits) + format: double + type: number + containerMemory: + description: >- + Optional. Amount of memory provisioned for a Python UDF container + instance. Format: {number}{unit} where unit is one of "M", "G", "Mi" + and "Gi" (e.g. 1G, 512Mi). If not specified, the default value is + 512Mi. For more information, see [Configure container limits for + Python + UDFs](https://cloud.google.com/bigquery/docs/user-defined-functions-python#configure-container-limits) + type: string + maxBatchingRows: + description: >- + Optional. Maximum number of rows in each batch sent to the external + runtime. If absent or if 0, BigQuery dynamically decides the number + of rows in a batch. + format: int64 + type: string + runtimeConnection: + description: >- + Optional. Fully qualified name of the connection whose service + account will be used to execute the code in the container. Format: + ```"projects/{project_id}/locations/{location_id}/connections/{connection_id}"``` + type: string + runtimeVersion: + description: 'Optional. Language runtime version. Example: `python-3.11`.' + type: string + type: object ExternalServiceCost: description: >- The external service cost is a portion of the total cost, these costs @@ -2619,6 +2751,12 @@ components: Output only. id: ExternalServiceCost properties: + billingMethod: + description: >- + The billing method used for the external job. This field is only + used when billed on the services sku, set to "SERVICES_SKU". + Otherwise, it is unspecified for backward compatibility. + type: string bytesBilled: description: External service cost in terms of bigquery bytes billed. format: int64 @@ -3123,6 +3261,7 @@ components: - BASE_TABLE_TOO_SMALL - BASE_TABLE_TOO_LARGE - ESTIMATED_PERFORMANCE_GAIN_TOO_LOW + - COLUMN_METADATA_INDEX_NOT_USED - NOT_SUPPORTED_IN_STANDARD_EDITION - INDEX_SUPPRESSED_BY_FUNCTION_OPTION - QUERY_CACHE_HIT @@ -3174,6 +3313,12 @@ components: - >- Indicates that the estimated performance gain from using the search index is too low for the given search query. + - >- + Indicates that the column metadata index (which the search index + depends on) is not used. User can refer to the [column metadata + index + usage](https://cloud.google.com/bigquery/docs/metadata-indexing-managed-tables#view_column_metadata_index_usage) + for more details on why it was not used. - >- Indicates that search indexes can not be used for search query with STANDARD edition. @@ -3323,9 +3468,7 @@ components: type: string jobCreationReason: $ref: '#/components/schemas/JobCreationReason' - description: >- - Output only. The reason why a Job was created. - [Preview](https://cloud.google.com/products/#product-launch-stages) + description: Output only. The reason why a Job was created. readOnly: true jobReference: $ref: '#/components/schemas/JobReference' @@ -3424,6 +3567,14 @@ components: query: $ref: '#/components/schemas/JobConfigurationQuery' description: '[Pick one] Configures a query job.' + reservation: + description: >- + Optional. The reservation that job would use. User can specify a + reservation to execute the job. If reservation is not set, + reservation is determined based on the rules defined by the + reservation assignments. The expected format is + `projects/{project}/locations/{location}/reservations/{reservation}`. + type: string type: object JobConfigurationExtract: description: >- @@ -3583,6 +3734,12 @@ components: `Job.JobReference.location` if it is present, otherwise it's set to the default location based on existing routing logic. type: boolean + dateFormat: + description: Optional. Date format used for parsing DATE values. + type: string + datetimeFormat: + description: Optional. Date format used for parsing DATETIME values. + type: string decimalTargetTypes: description: >- Defines the list of possible SQL data types to which the source @@ -3599,7 +3756,7 @@ components: NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if - value exeeds supported range). This field cannot contain duplicate + value exceeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to @@ -3707,7 +3864,7 @@ components: enumDescriptions: - >- The default if provided value is not one included in the enum, or - the value is not specified. The source formate is parsed without + the value is not specified. The source format is parsed without any modification. - >- Use GeoJSON variant of JSON. See @@ -3732,6 +3889,18 @@ components: STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value. type: string + nullMarkers: + description: >- + Optional. A list of strings represented as SQL NULL value in a CSV + file. null_marker and null_markers can't be set at the same time. If + null_marker is set, null_markers has to be not set. If null_markers + is set, null_marker has to be not set. If both null_marker and + null_markers are set at the same time, a user error would be thrown. + Any strings listed in null_markers, including empty string would be + interpreted as SQL NULL. This applies to all column types. + items: + type: string + type: array parquetOptions: $ref: '#/components/schemas/ParquetOptions' description: >- @@ -3828,6 +3997,30 @@ components: detected schema. format: int32 type: integer + sourceColumnMatch: + description: >- + Optional. Controls the strategy used to match loaded columns to the + schema. If not set, a sensible default is chosen based on how the + schema is provided. If autodetect is used, then columns are matched + by name. Otherwise, columns are matched by position. This is done to + keep the behavior backward-compatible. + enum: + - SOURCE_COLUMN_MATCH_UNSPECIFIED + - POSITION + - NAME + enumDescriptions: + - >- + Uses sensible defaults based on how the schema is provided. If + autodetect is used, then columns are matched by name. Otherwise, + columns are matched by position. This is done to keep the behavior + backward-compatible. + - >- + Matches by position. This assumes that the columns are ordered the + same way as the schema. + - >- + Matches by name. This reads the header row as column names and + reorders columns to match the field names in the schema. + type: string sourceFormat: description: >- Optional. The format of the data files. For CSV files, specify @@ -3849,12 +4042,23 @@ components: items: type: string type: array + timeFormat: + description: Optional. Date format used for parsing TIME values. + type: string timePartitioning: $ref: '#/components/schemas/TimePartitioning' description: >- Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. + timeZone: + description: >- + Optional. Default time zone that will apply when parsing timestamp + values that have no specific time zone. + type: string + timestampFormat: + description: Optional. Date format used for parsing TIMESTAMP values. + type: string useAvroLogicalTypes: description: >- Optional. If sourceFormat is set to "AVRO", indicates whether to @@ -3868,13 +4072,15 @@ components: already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the data, removes the constraints and uses the schema from the load job. - * WRITE_APPEND: If the table already exists, BigQuery appends the - data to the table. * WRITE_EMPTY: If the table already exists and - contains data, a 'duplicate' error is returned in the job result. - The default value is WRITE_APPEND. Each action is atomic and only - occurs if BigQuery is able to complete the job successfully. - Creation, truncation and append actions occur as one atomic update - upon job completion. + * WRITE_TRUNCATE_DATA: If the table already exists, BigQuery + overwrites the data, but keeps the constraints and schema of the + existing table. * WRITE_APPEND: If the table already exists, + BigQuery appends the data to the table. * WRITE_EMPTY: If the table + already exists and contains data, a 'duplicate' error is returned in + the job result. The default value is WRITE_APPEND. Each action is + atomic and only occurs if BigQuery is able to complete the job + successfully. Creation, truncation and append actions occur as one + atomic update upon job completion. type: string type: object JobConfigurationQuery: @@ -4074,14 +4280,24 @@ components: already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the data, removes the constraints, and uses the schema from the query - result. * WRITE_APPEND: If the table already exists, BigQuery - appends the data to the table. * WRITE_EMPTY: If the table already - exists and contains data, a 'duplicate' error is returned in the job - result. The default value is WRITE_EMPTY. Each action is atomic and - only occurs if BigQuery is able to complete the job successfully. - Creation, truncation and append actions occur as one atomic update - upon job completion. - type: string + result. * WRITE_TRUNCATE_DATA: If the table already exists, BigQuery + overwrites the data, but keeps the constraints and schema of the + existing table. * WRITE_APPEND: If the table already exists, + BigQuery appends the data to the table. * WRITE_EMPTY: If the table + already exists and contains data, a 'duplicate' error is returned in + the job result. The default value is WRITE_EMPTY. Each action is + atomic and only occurs if BigQuery is able to complete the job + successfully. Creation, truncation and append actions occur as one + atomic update upon job completion. + type: string + writeIncrementalResults: + description: >- + Optional. This is only supported for a SELECT query using a + temporary table. If set, the query is allowed to write results + incrementally to the temporary result table. This may incur a + performance penalty. This option cannot be used with Legacy SQL. + This feature is not yet available. + type: boolean type: object JobConfigurationTableCopy: description: >- @@ -4163,7 +4379,6 @@ components: method when used with `JOB_CREATION_OPTIONAL` Job creation mode. For [`jobs.insert`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/insert) method calls it will always be `REQUESTED`. - [Preview](https://cloud.google.com/products/#product-launch-stages) id: JobCreationReason properties: code: @@ -4328,7 +4543,7 @@ components: - Default value, which will be treated as ENTERPRISE. - Standard edition. - Enterprise edition. - - Enterprise plus edition. + - Enterprise Plus edition. readOnly: true type: string endTime: @@ -4609,9 +4824,7 @@ components: readOnly: true type: array referencedTables: - description: >- - Output only. Referenced tables for the job. Queries that reference - more than 50 tables will not have a complete list. + description: Output only. Referenced tables for the job. items: $ref: '#/components/schemas/TableReference' readOnly: true @@ -4662,7 +4875,7 @@ components: statement. * `INSERT`: [`INSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#insert_statement) statement. * `UPDATE`: - [`UPDATE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#update_statement) + [`UPDATE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#update_statement) statement. * `DELETE`: [`DELETE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `MERGE`: @@ -4671,7 +4884,7 @@ components: TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement, without `AS SELECT`. * `CREATE_TABLE_AS_SELECT`: [`CREATE TABLE AS - SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#query_statement) + SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement. * `CREATE_VIEW`: [`CREATE VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_view_statement) statement. * `CREATE_MODEL`: [`CREATE @@ -4723,7 +4936,7 @@ components: statement. * `ALTER_MATERIALIZED_VIEW`: [`ALTER MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_materialized_view_set_options_statement) statement. * `ALTER_SCHEMA`: [`ALTER - SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#aalter_schema_set_options_statement) + SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_schema_set_options_statement) statement. * `SCRIPT`: [`SCRIPT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language). * `TRUNCATE_TABLE`: [`TRUNCATE @@ -4778,6 +4991,15 @@ components: format: int64 readOnly: true type: string + totalServicesSkuSlotMs: + description: >- + Output only. Total slot-milliseconds for the job that run on + external services and billed on the service SKU. This field is only + populated for jobs that have external service costs, and is the + total of the usage for costs whose billing method is "SERVICES_SKU". + format: int64 + readOnly: true + type: string totalSlotMs: description: Output only. Slot-milliseconds for the job. format: int64 @@ -5166,7 +5388,7 @@ components: - >- View is invalidated because of a data change in one or more base tables. It could be any recent change if the - [`max_staleness`](https://cloud.google.com/bigquery/docs/materialized-views-create#max_staleness) + [`maxStaleness`](https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#Table.FIELDS.max_staleness) option is not set for the view, or otherwise any change outside of the staleness window. - >- @@ -5199,6 +5421,9 @@ components: description: >- Optional. This option declares the intention to construct a materialized view that isn't refreshed incrementally. + Non-incremental materialized views support an expanded range of SQL + queries. The `allow_non_incremental_definition` option can't be + changed after the materialized view is created. type: boolean enableRefresh: description: >- @@ -5265,7 +5490,7 @@ components: type: string type: object MetadataCacheStatistics: - description: Statistics for metadata caching in BigLake tables. + description: Statistics for metadata caching in queried tables. id: MetadataCacheStatistics properties: tableMetadataCacheUsage: @@ -5948,6 +6173,25 @@ components: assigned ID of the project. type: string type: object + PythonOptions: + description: Options for a user-defined Python function. + id: PythonOptions + properties: + entryPoint: + description: >- + Required. The name of the function defined in Python code as the + entry point when the Python UDF is invoked. + type: string + packages: + description: >- + Optional. A list of Python package names along with versions to be + installed. Example: ["pandas>=2.1", "google-cloud-translate==3.11"]. + For more information, see [Use third-party + packages](https://cloud.google.com/bigquery/docs/user-defined-functions-python#third-party-packages). + items: + type: string + type: array + type: object QueryInfo: description: Query optimization information for a QUERY job. id: QueryInfo @@ -6004,6 +6248,15 @@ components: description: Required. The type of this field. type: object type: array + timestampPrecision: + default: '6' + description: >- + Optional. Precision (maximum number of total digits in base 10) for + seconds of TIMESTAMP type. Possible values include: * 6 (Default, + for TIMESTAMP type with microsecond precision) * 12 (For TIMESTAMP + type with picosecond precision) + format: int64 + type: string type: description: Required. The top level type of this field. type: string @@ -6059,6 +6312,9 @@ components: for any unqualified table names in the query. If not set, all table names in the query string must be qualified in the format 'datasetId.tableId'. + destinationEncryptionConfiguration: + $ref: '#/components/schemas/EncryptionConfiguration' + description: Optional. Custom encryption configuration (e.g., Cloud KMS keys) dryRun: description: >- Optional. If set to true, BigQuery doesn't run the job. Instead, if @@ -6073,7 +6329,6 @@ components: description: >- Optional. If not set, jobs are always required. If set, the query request will follow the behavior described JobCreationMode. - [Preview](https://cloud.google.com/products/#product-launch-stages) enum: - JOB_CREATION_MODE_UNSPECIFIED - JOB_CREATION_REQUIRED @@ -6089,6 +6344,17 @@ components: required, JOB_CREATION_REQUIRED mode should be used, which is the default. type: string + jobTimeoutMs: + description: >- + Optional. Job timeout in milliseconds. If this time limit is + exceeded, BigQuery will attempt to stop a longer job, but may not + always succeed in canceling it before the job completes. For + example, a job that takes more than 60 seconds to complete has a + better chance of being stopped than a job that takes 10 seconds to + complete. This timeout applies to the query even if a job does not + need to be created. + format: int64 + type: string kind: default: bigquery#queryRequest description: The resource type of the request. @@ -6106,8 +6372,9 @@ components: type: object location: description: >- - The geographic location where the job should run. See details at - https://cloud.google.com/bigquery/docs/locations#specifying_your_location. + The geographic location where the job should run. For more + information, see how to [specify + locations](https://cloud.google.com/bigquery/docs/locations#specify_locations). type: string maxResults: description: >- @@ -6172,6 +6439,13 @@ components: the same request_id, but more than 15 minutes apart, idempotency is not guaranteed. type: string + reservation: + description: >- + Optional. The reservation that jobs.query request would use. User + can specify a reservation to execute the job.query. The expected + format is + `projects/{project}/locations/{location}/reservations/{reservation}`. + type: string timeoutMs: description: >- Optional. Optional: Specifies the maximum amount of time, in @@ -6205,6 +6479,13 @@ components: query cache is a best-effort cache that will be flushed whenever tables in the query are modified. The default value is true. type: boolean + writeIncrementalResults: + description: >- + Optional. This is only supported for SELECT query. If set, the query + is allowed to write results incrementally to the temporary result + table. This may incur a performance penalty. This option cannot be + used with Legacy SQL. This feature is not yet available. + type: boolean type: object QueryResponse: id: QueryResponse @@ -6212,12 +6493,27 @@ components: cacheHit: description: Whether the query result was fetched from the query cache. type: boolean + creationTime: + description: >- + Output only. Creation time of this query, in milliseconds since the + epoch. This field will be present on all queries. + format: int64 + readOnly: true + type: string dmlStats: $ref: '#/components/schemas/DmlStatistics' description: >- Output only. Detailed statistics for DML statements INSERT, UPDATE, DELETE, MERGE or TRUNCATE. readOnly: true + endTime: + description: >- + Output only. End time of this query, in milliseconds since the + epoch. This field will be present whenever a query job is in the + DONE state. + format: int64 + readOnly: true + type: string errors: description: >- Output only. The first errors or warnings encountered during the @@ -6242,7 +6538,6 @@ components: Optional. The reason why a Job was created. Only relevant when a job_reference is present in the response. If job_reference is not present it will always be unset. - [Preview](https://cloud.google.com/products/#product-launch-stages) jobReference: $ref: '#/components/schemas/JobReference' description: >- @@ -6258,6 +6553,13 @@ components: default: bigquery#queryResponse description: The resource type. type: string + location: + description: >- + Output only. The geographic location of the query. For more + information about BigQuery locations, see: + https://cloud.google.com/bigquery/docs/locations + readOnly: true + type: string numDmlAffectedRows: description: >- Output only. The number of rows affected by a DML statement. Present @@ -6275,9 +6577,7 @@ components: data](https://cloud.google.com/bigquery/docs/paging-results). type: string queryId: - description: >- - Auto-generated ID for the query. - [Preview](https://cloud.google.com/products/#product-launch-stages) + description: Auto-generated ID for the query. type: string rows: description: >- @@ -6296,6 +6596,23 @@ components: $ref: '#/components/schemas/SessionInfo' description: Output only. Information of the session if this job is part of one. readOnly: true + startTime: + description: >- + Output only. Start time of this query, in milliseconds since the + epoch. This field will be present when the query job transitions + from the PENDING state to either RUNNING or DONE. + format: int64 + readOnly: true + type: string + totalBytesBilled: + description: >- + Output only. If the project is configured to use on-demand pricing, + then this field contains the total bytes billed for the job. If the + project is configured to use flat-rate pricing, then you are not + billed for bytes and this field is informational only. + format: int64 + readOnly: true + type: string totalBytesProcessed: description: >- The total number of bytes processed for this query. If this query @@ -6309,6 +6626,11 @@ components: be more than the number of rows in this single page of results. format: uint64 type: string + totalSlotMs: + description: Output only. Number of slot ms the user is actually billed for. + format: int64 + readOnly: true + type: string type: object QueryTimelineSample: description: Summary of the state of query execution at a given time. @@ -6342,6 +6664,12 @@ components: revised (increased or decreased) while the query is running. format: int64 type: string + shuffleRamUsageRatio: + description: >- + Total shuffle usage ratio in shuffle RAM per reservation of this + query. This will be provided for reservation customers only. + format: double + type: number totalSlotMs: description: Cumulative slot-ms consumed by the query. format: int64 @@ -6630,6 +6958,12 @@ components: description: Output only. A hash of this resource. readOnly: true type: string + externalRuntimeOptions: + $ref: '#/components/schemas/ExternalRuntimeOptions' + description: >- + Optional. Options for the runtime of the external system executing + the routine. This field is only applicable for Python UDFs. + [Preview](https://cloud.google.com/products/#product-launch-stages) importedLibraries: description: >- Optional. If language = "JAVASCRIPT", this field stores the path of @@ -6663,6 +6997,11 @@ components: format: int64 readOnly: true type: string + pythonOptions: + $ref: '#/components/schemas/PythonOptions' + description: >- + Optional. Options for the Python UDF. + [Preview](https://cloud.google.com/products/#product-launch-stages) remoteFunctionOptions: $ref: '#/components/schemas/RemoteFunctionOptions' description: Optional. Remote function specific options. @@ -6802,6 +7141,31 @@ components: Examples: region="EU" date_field = CAST('2019-9-27' as DATE) nullable_field is not NULL numeric_field BETWEEN 1.0 AND 5.0 type: string + grantees: + description: >- + Optional. Input only. The optional list of iam_member users or + groups that specifies the initial members that the row-level access + policy should be created with. grantees types: - + "user:alice@example.com": An email address that represents a + specific Google account. - + "serviceAccount:my-other-app@appspot.gserviceaccount.com": An email + address that represents a service account. - + "group:admins@example.com": An email address that represents a + Google group. - "domain:example.com":The Google Workspace domain + (primary) that represents all the users of that domain. - + "allAuthenticatedUsers": A special identifier that represents all + service accounts and all users on the internet who have + authenticated with a Google Account. This identifier includes + accounts that aren't connected to a Google Workspace or Cloud + Identity domain, such as personal Gmail accounts. Users who aren't + authenticated, such as anonymous visitors, aren't included. - + "allUsers":A special identifier that represents anyone who is on the + internet, including authenticated and unauthenticated users. Because + BigQuery requires authentication before a user can access the + service, allUsers includes only authenticated users. + items: + type: string + type: array lastModifiedTime: description: >- Output only. The time when this row access policy was last modified, @@ -7388,6 +7752,62 @@ components: $ref: '#/components/schemas/SerDeInfo' description: Optional. Serializer and deserializer information. type: object + StoredColumnsUnusedReason: + description: If the stored column was not used, explain why. + id: StoredColumnsUnusedReason + properties: + code: + description: >- + Specifies the high-level reason for the unused scenario, each reason + must have a code associated. + enum: + - CODE_UNSPECIFIED + - STORED_COLUMNS_COVER_INSUFFICIENT + - BASE_TABLE_HAS_RLS + - BASE_TABLE_HAS_CLS + - UNSUPPORTED_PREFILTER + - INTERNAL_ERROR + - OTHER_REASON + enumDescriptions: + - Default value. + - If stored columns do not fully cover the columns. + - If the base table has RLS (Row Level Security). + - If the base table has CLS (Column Level Security). + - If the provided prefilter is not supported. + - If an internal error is preventing stored columns from being used. + - >- + Indicates that the reason stored columns cannot be used in the + query is not covered by any of the other StoredColumnsUnusedReason + options. + type: string + message: + description: Specifies the detailed description for the scenario. + type: string + uncoveredColumns: + description: >- + Specifies which columns were not covered by the stored columns for + the specified code up to 20 columns. This is populated when the code + is STORED_COLUMNS_COVER_INSUFFICIENT and BASE_TABLE_HAS_CLS. + items: + type: string + type: array + type: object + StoredColumnsUsage: + description: Indicates the stored columns usage in the query. + id: StoredColumnsUsage + properties: + baseTable: + $ref: '#/components/schemas/TableReference' + description: Specifies the base table. + isQueryAccelerated: + description: Specifies whether the query was accelerated with stored columns. + type: boolean + storedColumnsUnusedReasons: + description: If stored columns were not used, explain why. + items: + $ref: '#/components/schemas/StoredColumnsUnusedReason' + type: array + type: object Streamingbuffer: id: Streamingbuffer properties: @@ -7447,7 +7867,9 @@ components: properties: biglakeConfiguration: $ref: '#/components/schemas/BigLakeConfiguration' - description: Optional. Specifies the configuration of a BigLake managed table. + description: >- + Optional. Specifies the configuration of a BigQuery table for Apache + Iceberg. cloneDefinition: $ref: '#/components/schemas/CloneDefinition' description: >- @@ -7567,6 +7989,21 @@ components: value is inherited from the dataset. readOnly: true type: string + managedTableType: + description: >- + Optional. If set, overrides the default managed table type + configured in the dataset. + enum: + - MANAGED_TABLE_TYPE_UNSPECIFIED + - NATIVE + - BIGLAKE + enumDescriptions: + - No managed table type specified. + - The managed table is a native BigQuery table. + - >- + The managed table is a BigLake table for Apache Iceberg in + BigQuery. + type: string materializedView: $ref: '#/components/schemas/MaterializedViewDefinition' description: Optional. The materialized view definition. @@ -8169,7 +8606,7 @@ components: properties: privacyPolicy: $ref: '#/components/schemas/PrivacyPolicy' - description: Specifices the privacy policy for the view. + description: Specifies the privacy policy for the view. useLegacySql: description: >- True if view is defined in legacy SQL dialect, false if in @@ -8491,8 +8928,8 @@ components: description: >- The contribution metric. Applies to contribution analysis models. Allowed formats supported are for summable and summable ratio - contribution metrics. These include expressions such as "SUM(x)" or - "SUM(x)/SUM(y)", where x and y are column names from the base table. + contribution metrics. These include expressions such as `SUM(x)` or + `SUM(x)/SUM(y)`, where x and y are column names from the base table. type: string dartNormalizeType: description: >- @@ -8540,7 +8977,7 @@ components: largest) in the corresponding column are used as training data, and the rest are eval data. It respects the order in Orderable data types: - https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types#data-type-properties + https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types#data_type_properties type: string dataSplitEvalFraction: description: >- @@ -8618,6 +9055,19 @@ components: fitIntercept: description: Whether the model should include intercept during model training. type: boolean + forecastLimitLowerBound: + description: >- + The forecast limit lower bound that was used during ARIMA model + training with limits. To see more details of the algorithm: + https://otexts.com/fpp2/limits.html + format: double + type: number + forecastLimitUpperBound: + description: >- + The forecast limit upper bound that was used during ARIMA model + training with limits. + format: double + type: number hiddenUnits: description: Hidden units for dnn models. items: @@ -8769,7 +9219,7 @@ components: - Ukraine - United States - Venezuela - - Viet Nam + - Vietnam - South Africa type: string holidayRegions: @@ -8917,7 +9367,7 @@ components: - Ukraine - United States - Venezuela - - Viet Nam + - Vietnam - South Africa type: string type: array @@ -8982,7 +9432,7 @@ components: The F1 score is an average of recall and precision. For multiclass this is a macro-averaged metric. - >- - Logorithmic Loss. For multiclass this is a macro-averaged + Logarithmic Loss. For multiclass this is a macro-averaged metric. - >- Area Under an ROC Curve. For multiclass this is a macro-averaged @@ -9490,6 +9940,13 @@ components: other parts of the query did not use vector indexes. - The entire vector search query used vector indexes. type: string + storedColumnsUsages: + description: >- + Specifies the usage of stored columns in the query when stored + columns are used in the query. + items: + $ref: '#/components/schemas/StoredColumnsUsage' + type: array type: object ViewDefinition: description: Describes the definition of a logical view. @@ -9502,7 +9959,7 @@ components: type: array privacyPolicy: $ref: '#/components/schemas/PrivacyPolicy' - description: Optional. Specifices the privacy policy for the view. + description: Optional. Specifies the privacy policy for the view. query: description: >- Required. A query that BigQuery executes when the view is @@ -9721,10 +10178,10 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/jobs/methods/delete' - jobs_query_results: - id: google.bigquery.jobs_query_results - name: jobs_query_results - title: Jobs_query_results + query_results: + id: google.bigquery.query_results + name: query_results + title: Query_results methods: get_query_results: operation: @@ -9735,7 +10192,7 @@ components: sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/jobs_query_results/methods/get_query_results + #/components/x-stackQL-resources/query_results/methods/get_query_results insert: [] update: [] replace: [] @@ -9896,6 +10353,13 @@ components: name: row_access_policies title: Row_access_policies methods: + insert: + operation: + $ref: >- + #/paths/~1projects~1{projectId}~1datasets~1{+datasetId}~1tables~1{+tableId}~1rowAccessPolicies/post + response: + mediaType: application/json + openAPIDocKey: '200' list: operation: $ref: >- @@ -9904,13 +10368,41 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.rowAccessPolicies + delete: + operation: + $ref: >- + #/paths/~1projects~1{projectId}~1datasets~1{+datasetId}~1tables~1{+tableId}~1rowAccessPolicies~1{+policyId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1projects~1{projectId}~1datasets~1{+datasetId}~1tables~1{+tableId}~1rowAccessPolicies~1{+policyId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: >- + #/paths/~1projects~1{projectId}~1datasets~1{+datasetId}~1tables~1{+tableId}~1rowAccessPolicies~1{+policyId}/put + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/row_access_policies/methods/get' - $ref: '#/components/x-stackQL-resources/row_access_policies/methods/list' - insert: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/row_access_policies/methods/insert update: [] - replace: [] - delete: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/row_access_policies/methods/update + delete: + - $ref: >- + #/components/x-stackQL-resources/row_access_policies/methods/delete tabledata: id: google.bigquery.tabledata name: tabledata @@ -10133,6 +10625,10 @@ paths: schema: type: integer format: int32 + - in: query + name: updateMode + schema: + type: string post: description: >- Undeletes a dataset which is within time travel window based on @@ -10214,6 +10710,10 @@ paths: schema: type: integer format: int32 + - in: query + name: updateMode + schema: + type: string /projects/{projectId}/datasets: parameters: *ref_1 post: @@ -10451,6 +10951,10 @@ paths: required: true schema: type: string + - in: query + name: formatOptions.timestampOutputFormat + schema: + type: string - in: query name: formatOptions.useInt64Timestamp schema: @@ -11121,6 +11625,50 @@ paths: format: google-fieldmask /projects/{projectId}/datasets/{+datasetId}/tables/{+tableId}/rowAccessPolicies: parameters: *ref_1 + post: + description: Creates a row access policy. + operationId: bigquery.rowAccessPolicies.insert + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RowAccessPolicy' + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/RowAccessPolicy' + parameters: + - in: path + name: projectId + required: true + schema: + type: string + - in: path + name: +datasetId + required: true + schema: + type: string + - in: path + name: +tableId + required: true + schema: + type: string get: description: Lists all row access policies on the specified table. operationId: bigquery.rowAccessPolicies.list @@ -11169,6 +11717,145 @@ paths: name: pageToken schema: type: string + /projects/{projectId}/datasets/{+datasetId}/tables/{+tableId}/rowAccessPolicies/{+policyId}: + parameters: *ref_1 + delete: + description: Deletes a row access policy. + operationId: bigquery.rowAccessPolicies.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + responses: + '204': + description: No Content + parameters: + - in: path + name: projectId + required: true + schema: + type: string + - in: path + name: +datasetId + required: true + schema: + type: string + - in: path + name: +tableId + required: true + schema: + type: string + - in: path + name: +policyId + required: true + schema: + type: string + - in: query + name: force + schema: + type: boolean + get: + description: Gets the specified row access policy by policy ID. + operationId: bigquery.rowAccessPolicies.get + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/RowAccessPolicy' + parameters: + - in: path + name: projectId + required: true + schema: + type: string + - in: path + name: +datasetId + required: true + schema: + type: string + - in: path + name: +tableId + required: true + schema: + type: string + - in: path + name: +policyId + required: true + schema: + type: string + put: + description: Updates a row access policy. + operationId: bigquery.rowAccessPolicies.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RowAccessPolicy' + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/RowAccessPolicy' + parameters: + - in: path + name: projectId + required: true + schema: + type: string + - in: path + name: +datasetId + required: true + schema: + type: string + - in: path + name: +tableId + required: true + schema: + type: string + - in: path + name: +policyId + required: true + schema: + type: string /projects/{projectId}/datasets/{+datasetId}/tables/{+tableId}/insertAll: parameters: *ref_1 post: @@ -11258,6 +11945,10 @@ paths: required: true schema: type: string + - in: query + name: formatOptions.timestampOutputFormat + schema: + type: string - in: query name: formatOptions.useInt64Timestamp schema: diff --git a/providers/src/googleapis.com/v00.00.00000/services/bigqueryconnection.yaml b/providers/src/googleapis.com/v00.00.00000/services/bigqueryconnection.yaml index 27d6e155..ec5ee37c 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/bigqueryconnection.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/bigqueryconnection.yaml @@ -7,8 +7,8 @@ info: title: BigQuery Connection API description: Allows users to manage BigQuery connections to external data sources. version: v1 - x-discovery-doc-revision: '20241013' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250713' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/bigquery/docs/connections-api-intro servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/bigquerydatapolicy.yaml b/providers/src/googleapis.com/v00.00.00000/services/bigquerydatapolicy.yaml index 15a5d219..ceb863e4 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/bigquerydatapolicy.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/bigquerydatapolicy.yaml @@ -7,8 +7,8 @@ info: title: BigQuery Data Policy API description: Allows users to manage BigQuery data policies. version: v1 - x-discovery-doc-revision: '20241021' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250808' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/bigquery/docs/column-data-masking servers: @@ -57,7 +57,7 @@ components: readOnly: true type: string dataPolicyType: - description: Type of data policy. + description: Required. Data policy type. Type of data policy. type: string enumDescriptions: - Default value for the data policy type. This should not be used. diff --git a/providers/src/googleapis.com/v00.00.00000/services/bigquerydatatransfer.yaml b/providers/src/googleapis.com/v00.00.00000/services/bigquerydatatransfer.yaml index aa804f6d..522a5a76 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/bigquerydatatransfer.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/bigquerydatatransfer.yaml @@ -9,8 +9,8 @@ info: Schedule queries or transfer external data from SaaS applications to Google BigQuery on a regular basis. version: v1 - x-discovery-doc-revision: '20241022' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250821' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/bigquery-transfer/ servers: @@ -249,6 +249,10 @@ components: If true, it should not be used in new transfers, and it should not be visible to users. type: boolean + maxListSize: + description: For list parameters, the max size of the list. + type: string + format: int64 ListDataSourcesResponse: id: ListDataSourcesResponse description: Returns list of supported data sources and their metadata. @@ -1043,10 +1047,10 @@ components: - '1' - '2' x-stackQL-resources: - projects: - id: google.bigquerydatatransfer.projects - name: projects - title: Projects + data_sources: + id: google.bigquerydatatransfer.data_sources + name: data_sources + title: Data_sources methods: projects_enroll_data_sources: operation: @@ -1054,17 +1058,6 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: [] - data_sources: - id: google.bigquerydatatransfer.data_sources - name: data_sources - title: Data_sources - methods: projects_data_sources_get: operation: $ref: >- @@ -1809,10 +1802,13 @@ paths: parameters: *ref_1 post: description: >- - Start manual transfer runs to be executed now with schedule_time equal - to current time. The transfer runs can be created for a time range where - the run_time is between start_time (inclusive) and end_time (exclusive), - or for a specific run_time. + Manually initiates transfer runs. You can schedule these runs in two + ways: 1. For a specific point in time using the 'requested_run_time' + parameter. 2. For a period between 'start_time' (inclusive) and + 'end_time' (exclusive). If scheduling a single run, it is set to execute + immediately (schedule_time equals the current time). When scheduling + multiple runs within a time range, the first run starts now, and + subsequent runs are delayed by 15 seconds each. operationId: bigquerydatatransfer.projects.transferConfigs.startManualRuns requestBody: content: @@ -2160,6 +2156,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: @@ -2607,10 +2607,13 @@ paths: parameters: *ref_1 post: description: >- - Start manual transfer runs to be executed now with schedule_time equal - to current time. The transfer runs can be created for a time range where - the run_time is between start_time (inclusive) and end_time (exclusive), - or for a specific run_time. + Manually initiates transfer runs. You can schedule these runs in two + ways: 1. For a specific point in time using the 'requested_run_time' + parameter. 2. For a period between 'start_time' (inclusive) and + 'end_time' (exclusive). If scheduling a single run, it is set to execute + immediately (schedule_time equals the current time). When scheduling + multiple runs within a time range, the first run starts now, and + subsequent runs are delayed by 15 seconds each. operationId: bigquerydatatransfer.projects.locations.transferConfigs.startManualRuns requestBody: content: diff --git a/providers/src/googleapis.com/v00.00.00000/services/bigqueryreservation.yaml b/providers/src/googleapis.com/v00.00.00000/services/bigqueryreservation.yaml index dc39145c..8f88240b 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/bigqueryreservation.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/bigqueryreservation.yaml @@ -5,10 +5,10 @@ info: url: https://github.com/stackql/google-discovery-to-openapi email: info@stackql.io title: BigQuery Reservation API - description: A service to modify your BigQuery flat-rate reservations. + description: A service to modify your BigQuery reservations. version: v1 - x-discovery-doc-revision: '20241023' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250812' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/bigquery/ servers: @@ -44,7 +44,7 @@ components: properties: name: description: >- - The resource name of the reservation, e.g., + Identifier. The resource name of the reservation, e.g., `projects/*/locations/*/reservations/team1-prod`. The reservation_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum @@ -52,44 +52,41 @@ components: type: string slotCapacity: description: >- - Baseline slots available to this reservation. A slot is a unit of - computational power in BigQuery, and serves as the unit of + Optional. Baseline slots available to this reservation. A slot is a + unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false, or autoscaling - is enabled. If edition is EDITION_UNSPECIFIED and total - slot_capacity of the reservation and its siblings exceeds the total - slot_count of all capacity commitments, the request will fail with - `google.rpc.Code.RESOURCE_EXHAUSTED`. If edition is any value but - EDITION_UNSPECIFIED, then the above requirement is not needed. The - total slot_capacity of the reservation and its siblings may exceed - the total slot_count of capacity commitments. In that case, the - exceeding slots will be charged with the autoscale SKU. You can - increase the number of baseline slots in a reservation every few - minutes. If you want to decrease your baseline slots, you are - limited to once an hour if you have recently changed your baseline - slot capacity and your baseline slots exceed your committed slots. - Otherwise, you can decrease your baseline slots every few minutes. + is enabled. The total slot_capacity of the reservation and its + siblings may exceed the total slot_count of capacity commitments. In + that case, the exceeding slots will be charged with the autoscale + SKU. You can increase the number of baseline slots in a reservation + every few minutes. If you want to decrease your baseline slots, you + are limited to once an hour if you have recently changed your + baseline slot capacity and your baseline slots exceed your committed + slots. Otherwise, you can decrease your baseline slots every few + minutes. type: string format: int64 ignoreIdleSlots: description: >- - If false, any query or pipeline job using this reservation will use - idle slots from other reservations within the same admin project. If - true, a query or pipeline job using this reservation will execute - with the slot capacity specified in the slot_capacity field at most. + Optional. If false, any query or pipeline job using this reservation + will use idle slots from other reservations within the same admin + project. If true, a query or pipeline job using this reservation + will execute with the slot capacity specified in the slot_capacity + field at most. type: boolean autoscale: - description: The configuration parameters for the auto scaling feature. + description: Optional. The configuration parameters for the auto scaling feature. $ref: '#/components/schemas/Autoscale' concurrency: description: >- - Job concurrency target which sets a soft upper bound on the number - of jobs that can run concurrently in this reservation. This is a - soft target due to asynchronous nature of the system and various - optimizations for small queries. Default value is 0 which means that - concurrency target will be automatically computed by the system. - NOTE: this field is exposed as target job concurrency in the - Information Schema, DDL and BQ CLI. + Optional. Job concurrency target which sets a soft upper bound on + the number of jobs that can run concurrently in this reservation. + This is a soft target due to asynchronous nature of the system and + various optimizations for small queries. Default value is 0 which + means that concurrency target will be automatically computed by the + system. NOTE: this field is exposed as target job concurrency in the + Information Schema, DDL and BigQuery CLI. type: string format: int64 creationTime: @@ -110,15 +107,16 @@ components: disaster recovery purposes. If false, this reservation is placed in the organization's default region. NOTE: this is a preview feature. Project must be allow-listed in order to set this field. + deprecated: true type: boolean edition: - description: Edition of the reservation. + description: Optional. Edition of the reservation. type: string enumDescriptions: - Default value, which will be treated as ENTERPRISE. - Standard edition. - Enterprise edition. - - Enterprise plus edition. + - Enterprise Plus edition. enum: - EDITION_UNSPECIFIED - STANDARD @@ -126,37 +124,155 @@ components: - ENTERPRISE_PLUS primaryLocation: description: >- - Optional. The primary location of the reservation. The field is only - meaningful for reservation used for cross region disaster recovery. - The field is output only for customers and should not be specified, - however, the google.api.field_behavior is not set to OUTPUT_ONLY - since these fields are set in rerouted requests sent across regions. + Output only. The current location of the reservation's primary + replica. This field is only set for reservations using the managed + disaster recovery feature. + readOnly: true type: string secondaryLocation: description: >- - Optional. The secondary location of the reservation which is used - for cross region disaster recovery purposes. Customer can set this - in create/update reservation calls to create a failover reservation - or convert a non-failover reservation to a failover reservation. + Optional. The current location of the reservation's secondary + replica. This field is only set for reservations using the managed + disaster recovery feature. Users can set this in create reservation + calls to create a failover reservation or in update reservation + calls to convert a non-failover reservation to a failover + reservation(or vice versa). type: string originalPrimaryLocation: description: >- - Optional. The original primary location of the reservation which is - set only during its creation and remains unchanged afterwards. It - can be used by the customer to answer questions about disaster - recovery billing. The field is output only for customers and should - not be specified, however, the google.api.field_behavior is not set - to OUTPUT_ONLY since these fields are set in rerouted requests sent - across regions. + Output only. The location where the reservation was originally + created. This is set only during the failover reservation's + creation. All billing charges for the failover reservation will be + applied to this location. + readOnly: true + type: string + maxSlots: + description: >- + Optional. The overall max slots for the reservation, covering + slot_capacity (baseline), idle slots (if ignore_idle_slots is false) + and scaled slots. If present, the reservation won't use more than + the specified number of slots, even if there is demand and supply + (from idle slots). NOTE: capping a reservation's idle slot usage is + best effort and its usage may exceed the max_slots value. However, + in terms of autoscale.current_slots (which accounts for the + additional added slots), it will never exceed the max_slots - + baseline. This field must be set together with the scaling_mode enum + value, otherwise the request will be rejected with error code + `google.rpc.Code.INVALID_ARGUMENT`. If the max_slots and + scaling_mode are set, the autoscale or autoscale.max_slots field + must be unset. Otherwise the request will be rejected with error + code `google.rpc.Code.INVALID_ARGUMENT`. However, the autoscale + field may still be in the output. The autopscale.max_slots will + always show as 0 and the autoscaler.current_slots will represent the + current slots from autoscaler excluding idle slots. For example, if + the max_slots is 1000 and scaling_mode is AUTOSCALE_ONLY, then in + the output, the autoscaler.max_slots will be 0 and the + autoscaler.current_slots may be any value between 0 and 1000. If the + max_slots is 1000, scaling_mode is ALL_SLOTS, the baseline is 100 + and idle slots usage is 200, then in the output, the + autoscaler.max_slots will be 0 and the autoscaler.current_slots will + not be higher than 700. If the max_slots is 1000, scaling_mode is + IDLE_SLOTS_ONLY, then in the output, the autoscaler field will be + null. If the max_slots and scaling_mode are set, then the + ignore_idle_slots field must be aligned with the scaling_mode enum + value.(See details in ScalingMode comments). Otherwise the request + will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`. + Please note, the max_slots is for user to manage the part of slots + greater than the baseline. Therefore, we don't allow users to set + max_slots smaller or equal to the baseline as it will not be + meaningful. If the field is present and slot_capacity>=max_slots, + requests will be rejected with error code + `google.rpc.Code.INVALID_ARGUMENT`. Please note that if max_slots is + set to 0, we will treat it as unset. Customers can set max_slots to + 0 and set scaling_mode to SCALING_MODE_UNSPECIFIED to disable the + max_slots feature. + type: string + format: int64 + scalingMode: + description: >- + Optional. The scaling mode for the reservation. If the field is + present but max_slots is not present, requests will be rejected with + error code `google.rpc.Code.INVALID_ARGUMENT`. type: string + enumDescriptions: + - Default value of ScalingMode. + - >- + The reservation will scale up only using slots from autoscaling. + It will not use any idle slots even if there may be some + available. The upper limit that autoscaling can scale up to will + be max_slots - baseline. For example, if max_slots is 1000, + baseline is 200 and customer sets ScalingMode to AUTOSCALE_ONLY, + then autoscalerg will scale up to 800 slots and no idle slots will + be used. Please note, in this mode, the ignore_idle_slots field + must be set to true. Otherwise the request will be rejected with + error code `google.rpc.Code.INVALID_ARGUMENT`. + - >- + The reservation will scale up using only idle slots contributed by + other reservations or from unassigned commitments. If no idle + slots are available it will not scale up further. If the idle + slots which it is using are reclaimed by the contributing + reservation(s) it may be forced to scale down. The max idle slots + the reservation can be max_slots - baseline capacity. For example, + if max_slots is 1000, baseline is 200 and customer sets + ScalingMode to IDLE_SLOTS_ONLY, 1. if there are 1000 idle slots + available in other reservations, the reservation will scale up to + 1000 slots with 200 baseline and 800 idle slots. 2. if there are + 500 idle slots available in other reservations, the reservation + will scale up to 700 slots with 200 baseline and 300 idle slots. + Please note, in this mode, the reservation might not be able to + scale up to max_slots. Please note, in this mode, the + ignore_idle_slots field must be set to false. Otherwise the + request will be rejected with error code + `google.rpc.Code.INVALID_ARGUMENT`. + - >- + The reservation will scale up using all slots available to it. It + will use idle slots contributed by other reservations or from + unassigned commitments first. If no idle slots are available it + will scale up using autoscaling. For example, if max_slots is + 1000, baseline is 200 and customer sets ScalingMode to ALL_SLOTS, + 1. if there are 800 idle slots available in other reservations, + the reservation will scale up to 1000 slots with 200 baseline and + 800 idle slots. 2. if there are 500 idle slots available in other + reservations, the reservation will scale up to 1000 slots with 200 + baseline, 500 idle slots and 300 autoscaling slots. 3. if there + are no idle slots available in other reservations, it will scale + up to 1000 slots with 200 baseline and 800 autoscaling slots. + Please note, in this mode, the ignore_idle_slots field must be set + to false. Otherwise the request will be rejected with error code + `google.rpc.Code.INVALID_ARGUMENT`. + enum: + - SCALING_MODE_UNSPECIFIED + - AUTOSCALE_ONLY + - IDLE_SLOTS_ONLY + - ALL_SLOTS labels: description: >- Optional. The labels associated with this reservation. You can use these to organize and group your reservations. You can set this - property when inserting or updating a reservation. + property when you create or update a reservation. type: object additionalProperties: type: string + reservationGroup: + description: >- + Optional. The reservation group that this reservation belongs to. + You can set this property when you create or update a reservation. + Reservations do not need to belong to a reservation group. Format: + projects/{project}/locations/{location}/reservationGroups/{reservation_group} + or just {reservation_group} + type: string + replicationStatus: + description: >- + Output only. The Disaster Recovery(DR) replication status of the + reservation. This is only available for the primary replicas of + DR/failover reservations and provides information about the both the + staleness of the secondary and the last error encountered while + trying to replicate changes from the primary to the secondary. If + this field is blank, it means that the reservation is either not a + DR reservation or the reservation is a DR secondary or that any + replication operations on the reservation have succeeded. + readOnly: true + $ref: '#/components/schemas/ReplicationStatus' Autoscale: id: Autoscale description: Auto scaling settings. @@ -173,9 +289,78 @@ components: type: string format: int64 maxSlots: - description: Number of slots to be scaled when needed. + description: Optional. Number of slots to be scaled when needed. type: string format: int64 + ReplicationStatus: + id: ReplicationStatus + description: Disaster Recovery(DR) replication status of the reservation. + type: object + properties: + error: + description: >- + Output only. The last error encountered while trying to replicate + changes from the primary to the secondary. This field is only + available if the replication has not succeeded since. + readOnly: true + $ref: '#/components/schemas/Status' + lastErrorTime: + description: >- + Output only. The time at which the last error was encountered while + trying to replicate changes from the primary to the secondary. This + field is only available if the replication has not succeeded since. + readOnly: true + type: string + format: google-datetime + lastReplicationTime: + description: >- + Output only. A timestamp corresponding to the last change on the + primary that was successfully replicated to the secondary. + readOnly: true + type: string + format: google-datetime + softFailoverStartTime: + description: >- + Output only. The time at which a soft failover for the reservation + and its associated datasets was initiated. After this field is set, + all subsequent changes to the reservation will be rejected unless a + hard failover overrides this operation. This field will be cleared + once the failover is complete. + readOnly: true + type: string + format: google-datetime + Status: + id: Status + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + type: object + properties: + code: + description: The status code, which should be an enum value of google.rpc.Code. + type: integer + format: int32 + message: + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + type: string + details: + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + type: array + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. ListReservationsResponse: id: ListReservationsResponse description: The response for ReservationService.ListReservations. @@ -204,7 +389,23 @@ components: id: FailoverReservationRequest description: The request for ReservationService.FailoverReservation. type: object - properties: {} + properties: + failoverMode: + description: Optional. failover mode for the failover operation. + type: string + enumDescriptions: + - Invalid value. + - >- + When customers initiate a soft failover, BigQuery will wait until + all committed writes are replicated to the secondary. + - >- + When customers initiate a hard failover, BigQuery will not wait + until all committed writes are replicated to the secondary. There + can be data loss for hard failover. + enum: + - FAILOVER_MODE_UNSPECIFIED + - SOFT + - HARD CapacityCommitment: id: CapacityCommitment description: >- @@ -226,11 +427,11 @@ components: readOnly: true type: string slotCount: - description: Number of slots in this commitment. + description: Optional. Number of slots in this commitment. type: string format: int64 plan: - description: Capacity commitment commitment plan. + description: Optional. Capacity commitment commitment plan. type: string enumDescriptions: - >- @@ -342,7 +543,7 @@ components: $ref: '#/components/schemas/Status' renewalPlan: description: >- - The plan this capacity commitment is converted to after + Optional. The plan this capacity commitment is converted to after commitment_end_time passes. Once the plan is changed, committed period is extended according to commitment plan. Only applicable for ANNUAL and TRIAL commitments. @@ -420,15 +621,16 @@ components: disaster recovery purposes. If false, this commitment is placed in the organization's default region. NOTE: this is a preview feature. Project must be allow-listed in order to set this field. + deprecated: true type: boolean edition: - description: Edition of the capacity commitment. + description: Optional. Edition of the capacity commitment. type: string enumDescriptions: - Default value, which will be treated as ENTERPRISE. - Standard edition. - Enterprise edition. - - Enterprise plus edition. + - Enterprise Plus edition. enum: - EDITION_UNSPECIFIED - STANDARD @@ -440,38 +642,6 @@ components: otherwise, it's an edition commitment. readOnly: true type: boolean - Status: - id: Status - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - type: object - properties: - code: - description: The status code, which should be an enum value of google.rpc.Code. - type: integer - format: int32 - message: - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - type: string - details: - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - type: array - items: - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. ListCapacityCommitmentsResponse: id: ListCapacityCommitmentsResponse description: The response for ReservationService.ListCapacityCommitments. @@ -521,6 +691,14 @@ components: type: array items: type: string + capacityCommitmentId: + description: >- + Optional. The optional resulting capacity commitment ID. Capacity + commitment name will be generated automatically if this field is + empty. This field must only contain lower case alphanumeric + characters or dashes. The first and last character cannot be a dash. + Max length is 64 characters. + type: string Assignment: id: Assignment description: >- @@ -538,11 +716,11 @@ components: type: string assignee: description: >- - The resource which will use the reservation. E.g. + Optional. The resource which will use the reservation. E.g. `projects/myproject`, `folders/123`, or `organizations/456`. type: string jobType: - description: Which type of jobs will use the reservation. + description: Optional. Which type of jobs will use the reservation. type: string enumDescriptions: - >- @@ -668,8 +846,8 @@ components: properties: name: description: >- - The resource name of the singleton BI reservation. Reservation names - have the form + Identifier. The resource name of the singleton BI reservation. + Reservation names have the form `projects/{project_id}/locations/{location_id}/biReservation`. type: string updateTime: @@ -678,11 +856,11 @@ components: type: string format: google-datetime size: - description: Size of a reservation, in bytes. + description: Optional. Size of a reservation, in bytes. type: string format: int64 preferredTables: - description: Preferred tables to use BI capacity for. + description: Optional. Preferred tables to use BI capacity for. type: array items: $ref: '#/components/schemas/TableReference' @@ -694,13 +872,373 @@ components: type: object properties: projectId: - description: The assigned project ID of the project. + description: Optional. The assigned project ID of the project. type: string datasetId: - description: The ID of the dataset in the above project. + description: Optional. The ID of the dataset in the above project. type: string tableId: - description: The ID of the table in the above dataset. + description: Optional. The ID of the table in the above dataset. + type: string + Policy: + id: Policy + description: >- + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. A `Policy` is a collection of + `bindings`. A `binding` binds one or more `members`, or principals, to a + single `role`. Principals can be user accounts, service accounts, Google + groups, and domains (such as G Suite). A `role` is a named list of + permissions; each `role` can be an IAM predefined role or a user-created + custom role. For some types of Google Cloud resources, a `binding` can + also specify a `condition`, which is a logical expression that allows + access to a resource only if the expression evaluates to `true`. A + condition can add constraints based on attributes of the request, the + resource, or both. To learn which resources support conditions in their + IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + **JSON example:** ``` { "bindings": [ { "role": + "roles/resourcemanager.organizationAdmin", "members": [ + "user:mike@example.com", "group:admins@example.com", + "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { + "role": "roles/resourcemanager.organizationViewer", "members": [ + "user:eve@example.com" ], "condition": { "title": "expirable access", + "description": "Does not grant access after Sep 2020", "expression": + "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": + "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - + members: - user:mike@example.com - group:admins@example.com - + domain:google.com - + serviceAccount:my-project-id@appspot.gserviceaccount.com role: + roles/resourcemanager.organizationAdmin - members: - + user:eve@example.com role: roles/resourcemanager.organizationViewer + condition: title: expirable access description: Does not grant access + after Sep 2020 expression: request.time < + timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` + For a description of IAM and its features, see the [IAM + documentation](https://cloud.google.com/iam/docs/). + type: object + properties: + 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). + type: integer + format: int32 + bindings: + description: >- + Associates a list of `members`, or principals, with a `role`. + Optionally, may specify a `condition` that determines how and when + the `bindings` are applied. Each of the `bindings` must contain at + least one principal. The `bindings` in a `Policy` can refer to up to + 1,500 principals; up to 250 of these principals can be Google + groups. Each occurrence of a principal counts towards these limits. + For example, if the `bindings` grant 50 different roles to + `user:alice@example.com`, and not to any other principal, then you + can add another 1,450 principals to the `bindings` in the `Policy`. + type: array + items: + $ref: '#/components/schemas/Binding' + auditConfigs: + description: Specifies cloud audit logging configuration for this policy. + type: array + items: + $ref: '#/components/schemas/AuditConfig' + 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. + type: string + format: byte + Binding: + id: Binding + description: Associates `members`, or principals, with a `role`. + type: object + properties: + role: + description: >- + Role that is assigned to the list of `members`, or principals. For + example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an + overview of the IAM roles and permissions, see the [IAM + documentation](https://cloud.google.com/iam/docs/roles-overview). + For a list of the available pre-defined roles, see + [here](https://cloud.google.com/iam/docs/understanding-roles). + type: string + members: + description: >- + Specifies the principals requesting access for a Google Cloud + 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. Does not include identities + that come from external identity providers (IdPs) through identity + federation. * `user:{emailid}`: An email address that represents a + specific Google account. For example, `alice@example.com` . * + `serviceAccount:{emailid}`: An email address that represents a + Google service account. For example, + `my-other-app@appspot.gserviceaccount.com`. * + `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: + An identifier for a [Kubernetes service + account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). + For example, + `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * + `group:{emailid}`: An email address that represents a Google group. + For example, `admins@example.com`. * `domain:{domain}`: The G Suite + domain (primary) that represents all the users of that domain. For + example, `google.com` or `example.com`. * + `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workforce identity pool. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: + All workforce identities in a group. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All workforce identities with a specific attribute value. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: + All identities in a workforce identity pool. * + `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workload identity pool. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: + A workload identity pool group. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All identities in a workload identity pool with a certain attribute. + * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: + All identities in a workload identity pool. * + `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. * + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + Deleted single identity in a workforce identity pool. For example, + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + type: array + items: + type: string + condition: + description: >- + The condition that is associated with this binding. If the condition + evaluates to `true`, then this binding applies to the current + request. If the condition evaluates to `false`, then this binding + does not apply to the current request. However, a different role + binding might grant the same role to one or more of the principals + in this binding. To learn which resources support conditions in + their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + $ref: '#/components/schemas/Expr' + Expr: + id: 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. + type: object + properties: + expression: + description: >- + Textual representation of an expression in Common Expression + Language syntax. + 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 + 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 + 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 + AuditConfig: + id: 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. + type: object + properties: + 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 + auditLogConfigs: + description: The configuration for logging of each type of permission. + type: array + items: + $ref: '#/components/schemas/AuditLogConfig' + AuditLogConfig: + id: 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. + type: object + properties: + logType: + description: The log type that this config enables. + type: string + enumDescriptions: + - Default case. Should never be this. + - 'Admin reads. Example: CloudIAM getIamPolicy' + - 'Data writes. Example: CloudSQL Users create' + - 'Data reads. Example: CloudSQL Users list' + enum: + - LOG_TYPE_UNSPECIFIED + - ADMIN_READ + - DATA_WRITE + - DATA_READ + exemptedMembers: + description: >- + Specifies the identities that do not cause logging for this type of + permission. Follows the same format of Binding.members. + type: array + items: + type: string + SetIamPolicyRequest: + id: SetIamPolicyRequest + description: Request message for `SetIamPolicy` method. + type: object + properties: + policy: + description: >- + REQUIRED: The complete policy to be applied to the `resource`. The + size of the policy is limited to a few 10s of KB. An empty policy is + a valid policy but certain Google Cloud services (such as Projects) + might reject them. + $ref: '#/components/schemas/Policy' + updateMask: + description: >- + OPTIONAL: A FieldMask specifying which fields of the policy to + modify. Only the fields in the mask will be modified. If no mask is + provided, the following default mask is used: `paths: "bindings, + etag"` + type: string + format: google-fieldmask + TestIamPermissionsRequest: + id: TestIamPermissionsRequest + description: Request message for `TestIamPermissions` method. + type: object + properties: + permissions: + description: >- + The set of permissions to check for the `resource`. Permissions with + wildcards (such as `*` or `storage.*`) are not allowed. For more + information see [IAM + Overview](https://cloud.google.com/iam/docs/overview#permissions). + type: array + items: + type: string + TestIamPermissionsResponse: + id: TestIamPermissionsResponse + description: Response message for `TestIamPermissions` method. + type: object + properties: + permissions: + description: >- + A subset of `TestPermissionsRequest.permissions` that the caller is + allowed. + type: array + items: + type: string + ReservationGroup: + id: ReservationGroup + description: A reservation group is a container for reservations. + type: object + properties: + name: + description: >- + Identifier. The resource name of the reservation group, e.g., + `projects/*/locations/*/reservationGroups/team1-prod`. The + reservation_group_id must only contain lower case alphanumeric + characters or dashes. It must start with a letter and must not end + with a dash. Its maximum length is 64 characters. + type: string + ListReservationGroupsResponse: + id: ListReservationGroupsResponse + description: The response for ReservationService.ListReservationGroups. + type: object + properties: + reservationGroups: + description: List of reservations visible to the user. + type: array + items: + $ref: '#/components/schemas/ReservationGroup' + nextPageToken: + description: >- + Token to retrieve the next page of results, or empty if there are no + more results in the list. type: string parameters: access_token: @@ -896,6 +1434,43 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/reservations/methods/delete' + reservations_iam_policies: + id: google.bigqueryreservation.reservations_iam_policies + name: reservations_iam_policies + title: Reservations_iam_policies + methods: + get_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1reservations~1{reservationsId}:getIamPolicy/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.bindings + set_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1reservations~1{reservationsId}:setIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + test_iam_permissions: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1reservations~1{reservationsId}:testIamPermissions/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/reservations_iam_policies/methods/get_iam_policy + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/reservations_iam_policies/methods/set_iam_policy + delete: [] assignments: id: google.bigqueryreservation.assignments name: assignments @@ -947,6 +1522,43 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/assignments/methods/delete' + assignments_iam_policies: + id: google.bigqueryreservation.assignments_iam_policies + name: assignments_iam_policies + title: Assignments_iam_policies + methods: + get_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1reservations~1{reservationsId}~1assignments~1{assignmentsId}:getIamPolicy/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.bindings + set_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1reservations~1{reservationsId}~1assignments~1{assignmentsId}:setIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + test_iam_permissions: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1reservations~1{reservationsId}~1assignments~1{assignmentsId}:testIamPermissions/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/assignments_iam_policies/methods/get_iam_policy + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/assignments_iam_policies/methods/set_iam_policy + delete: [] capacity_commitments: id: google.bigqueryreservation.capacity_commitments name: capacity_commitments @@ -1016,26 +1628,70 @@ components: delete: - $ref: >- #/components/x-stackQL-resources/capacity_commitments/methods/delete -paths: - /v1/projects/{projectsId}/locations/{locationsId}:searchAssignments: - parameters: &ref_1 - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/_.xgafv' - get: - description: >- - Deprecated: Looks up assignments for a specified resource for a - particular region. If the request is about a project: 1. Assignments - created on the project will be returned if they exist. 2. Otherwise - assignments created on the closest ancestor will be returned. 3. + reservation_groups: + id: google.bigqueryreservation.reservation_groups + name: reservation_groups + title: Reservation_groups + methods: + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1reservationGroups/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1reservationGroups/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.reservationGroups + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1reservationGroups~1{reservationGroupsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1reservationGroups~1{reservationGroupsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/reservation_groups/methods/get' + - $ref: '#/components/x-stackQL-resources/reservation_groups/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/reservation_groups/methods/create' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/reservation_groups/methods/delete' +paths: + /v1/projects/{projectsId}/locations/{locationsId}:searchAssignments: + parameters: &ref_1 + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' + get: + description: >- + Deprecated: Looks up assignments for a specified resource for a + particular region. If the request is about a project: 1. Assignments + created on the project will be returned if they exist. 2. Otherwise + assignments created on the closest ancestor will be returned. 3. Assignments for different JobTypes will all be returned. The same logic applies if the request is about a folder. If the request is about an organization, then assignments created on the organization will be @@ -1424,7 +2080,7 @@ paths: parameters: *ref_1 post: description: >- - Failover a reservation to the secondary location. The operation should + Fail over a reservation to the secondary location. The operation should be done in the current secondary location, which will be promoted to the new primary location for the reservation. Attempting to failover a reservation in the current primary location will fail with the error @@ -1467,6 +2123,148 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/reservations/{reservationsId}:getIamPolicy: + parameters: *ref_1 + get: + description: >- + Gets the access control policy for a resource. May return: * + A`NOT_FOUND` error if the resource doesn't exist or you don't have the + permission to view it. * An empty policy if the resource exists but + doesn't have a set policy. Supported resources are: - Reservations - + ReservationAssignments To call this method, you must have the following + Google IAM permissions: - + `bigqueryreservation.reservations.getIamPolicy` to get policies on + reservations. + operationId: bigqueryreservation.projects.locations.reservations.getIamPolicy + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: reservationsId + required: true + schema: + type: string + - in: query + name: options.requestedPolicyVersion + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/reservations/{reservationsId}:setIamPolicy: + parameters: *ref_1 + post: + description: >- + Sets an access control policy for a resource. Replaces any existing + policy. Supported resources are: - Reservations To call this method, you + must have the following Google IAM permissions: - + `bigqueryreservation.reservations.setIamPolicy` to set policies on + reservations. + operationId: bigqueryreservation.projects.locations.reservations.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetIamPolicyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: reservationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/reservations/{reservationsId}:testIamPermissions: + parameters: *ref_1 + post: + description: >- + Gets your permissions on a resource. Returns an empty set of permissions + if the resource doesn't exist. Supported resources are: - Reservations + No Google IAM permissions are required to call this method. + operationId: bigqueryreservation.projects.locations.reservations.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: reservationsId + required: true + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/reservations/{reservationsId}/assignments: parameters: *ref_1 post: @@ -1743,6 +2541,166 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/reservations/{reservationsId}/assignments/{assignmentsId}:getIamPolicy: + parameters: *ref_1 + get: + description: >- + Gets the access control policy for a resource. May return: * + A`NOT_FOUND` error if the resource doesn't exist or you don't have the + permission to view it. * An empty policy if the resource exists but + doesn't have a set policy. Supported resources are: - Reservations - + ReservationAssignments To call this method, you must have the following + Google IAM permissions: - + `bigqueryreservation.reservations.getIamPolicy` to get policies on + reservations. + operationId: >- + bigqueryreservation.projects.locations.reservations.assignments.getIamPolicy + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: reservationsId + required: true + schema: + type: string + - in: path + name: assignmentsId + required: true + schema: + type: string + - in: query + name: options.requestedPolicyVersion + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/reservations/{reservationsId}/assignments/{assignmentsId}:setIamPolicy: + parameters: *ref_1 + post: + description: >- + Sets an access control policy for a resource. Replaces any existing + policy. Supported resources are: - Reservations To call this method, you + must have the following Google IAM permissions: - + `bigqueryreservation.reservations.setIamPolicy` to set policies on + reservations. + operationId: >- + bigqueryreservation.projects.locations.reservations.assignments.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetIamPolicyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: reservationsId + required: true + schema: + type: string + - in: path + name: assignmentsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/reservations/{reservationsId}/assignments/{assignmentsId}:testIamPermissions: + parameters: *ref_1 + post: + description: >- + Gets your permissions on a resource. Returns an empty set of permissions + if the resource doesn't exist. Supported resources are: - Reservations + No Google IAM permissions are required to call this method. + operationId: >- + bigqueryreservation.projects.locations.reservations.assignments.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: reservationsId + required: true + schema: + type: string + - in: path + name: assignmentsId + required: true + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/capacityCommitments: parameters: *ref_1 post: @@ -2046,3 +3004,159 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/reservationGroups: + parameters: *ref_1 + post: + description: Creates a new reservation group. + operationId: bigqueryreservation.projects.locations.reservationGroups.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ReservationGroup' + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ReservationGroup' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: reservationGroupId + schema: + type: string + get: + description: >- + Lists all the reservation groups for the project in the specified + location. + operationId: bigqueryreservation.projects.locations.reservationGroups.list + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListReservationGroupsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/reservationGroups/{reservationGroupsId}: + parameters: *ref_1 + get: + description: Returns information about the reservation group. + operationId: bigqueryreservation.projects.locations.reservationGroups.get + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ReservationGroup' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: reservationGroupsId + required: true + schema: + type: string + delete: + description: >- + Deletes a reservation. Returns `google.rpc.Code.FAILED_PRECONDITION` + when reservation has assignments. + operationId: bigqueryreservation.projects.locations.reservationGroups.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: reservationGroupsId + required: true + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/bigtableadmin.yaml b/providers/src/googleapis.com/v00.00.00000/services/bigtableadmin.yaml index d297dd98..ad9593a3 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/bigtableadmin.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/bigtableadmin.yaml @@ -7,8 +7,8 @@ info: title: Cloud Bigtable Admin API description: Administer your Cloud Bigtable tables and instances. version: v2 - x-discovery-doc-revision: '20241025' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250811' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/bigtable/ servers: @@ -254,6 +254,17 @@ components: description: Output only. Reserved for future use. readOnly: true type: boolean + tags: + description: >- + Optional. Input only. Immutable. Tag keys/values directly bound to + this resource. For example: - "123/environment": "production", - + "123/costCenter": "marketing" Tags and Labels (above) are both used + to bind metadata to resources, with different use-cases. See + https://cloud.google.com/resource-manager/docs/tags/tags-overview + for an in-depth overview on the difference between tags and labels. + type: object + additionalProperties: + type: string Cluster: id: Cluster description: >- @@ -480,7 +491,8 @@ components: properties: name: description: >- - The unique name of the app profile. Values are of the form + The unique name of the app profile, up to 50 characters long. Values + are of the form `projects/{project}/instances/{instance}/appProfiles/_a-zA-Z0-9*`. type: string etag: @@ -1084,6 +1096,84 @@ components: readOnly: true type: number format: float + LogicalView: + id: LogicalView + description: A SQL logical view object that can be referenced in SQL queries. + type: object + properties: + name: + description: >- + Identifier. The unique name of the logical view. Format: + `projects/{project}/instances/{instance}/logicalViews/{logical_view}` + type: string + query: + description: Required. The logical view's select query. + type: string + etag: + description: >- + Optional. The etag for this logical view. This may be sent on update + requests to ensure that the client has an up-to-date value before + proceeding. The server returns an ABORTED error on a mismatched + etag. + type: string + deletionProtection: + description: >- + Optional. Set to true to make the LogicalView protected against + deletion. + type: boolean + ListLogicalViewsResponse: + id: ListLogicalViewsResponse + description: Response message for BigtableInstanceAdmin.ListLogicalViews. + type: object + properties: + logicalViews: + description: The list of requested logical views. + type: array + items: + $ref: '#/components/schemas/LogicalView' + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + MaterializedView: + id: MaterializedView + description: A materialized view object that can be referenced in SQL queries. + type: object + properties: + name: + description: >- + Identifier. The unique name of the materialized view. Format: + `projects/{project}/instances/{instance}/materializedViews/{materialized_view}` + type: string + query: + description: Required. Immutable. The materialized view's select query. + type: string + etag: + description: >- + Optional. The etag for this materialized view. This may be sent on + update requests to ensure that the client has an up-to-date value + before proceeding. The server returns an ABORTED error on a + mismatched etag. + type: string + deletionProtection: + description: Set to true to make the MaterializedView protected against deletion. + type: boolean + ListMaterializedViewsResponse: + id: ListMaterializedViewsResponse + description: Response message for BigtableInstanceAdmin.ListMaterializedViews. + type: object + properties: + materializedViews: + description: The list of requested materialized views. + type: array + items: + $ref: '#/components/schemas/MaterializedView' + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string CreateTableRequest: id: CreateTableRequest description: >- @@ -1196,6 +1286,55 @@ components: If specified, automated backups are enabled for this table. Otherwise, automated backups are disabled. $ref: '#/components/schemas/AutomatedBackupPolicy' + tieredStorageConfig: + description: >- + Rules to specify what data is stored in each storage tier. Different + tiers store data differently, providing different trade-offs between + cost and performance. Different parts of a table can be stored + separately on different tiers. If a config is specified, tiered + storage is enabled for this table. Otherwise, tiered storage is + disabled. Only SSD instances can configure tiered storage. + $ref: '#/components/schemas/TieredStorageConfig' + rowKeySchema: + description: >- + The row key schema for this table. The schema is used to decode the + raw row key bytes into a structured format. The order of field + declarations in this schema is important, as it reflects how the raw + row key bytes are structured. Currently, this only affects how the + key is read via a GoogleSQL query from the ExecuteQuery API. For a + SQL query, the _key column is still read as raw bytes. But queries + can reference the key fields by name, which will be decoded from + _key using provided type and encoding. Queries that reference key + fields will fail if they encounter an invalid row key. For example, + if _key = "some_id#2024-04-30#\x00\x13\x00\xf3" with the following + schema: { fields { field_name: "id" type { string { encoding: + utf8_bytes {} } } } fields { field_name: "date" type { string { + encoding: utf8_bytes {} } } } fields { field_name: "product_code" + type { int64 { encoding: big_endian_bytes {} } } } encoding { + delimited_bytes { delimiter: "#" } } } The decoded key parts would + be: id = "some_id", date = "2024-04-30", product_code = 1245427 The + query "SELECT _key, product_code FROM table" will return two + columns: /------------------------------------------------------\ | + _key | product_code | | + --------------------------------------|--------------| | + "some_id#2024-04-30#\x00\x13\x00\xf3" | 1245427 | + \------------------------------------------------------/ The schema + has the following invariants: (1) The decoded field values are + order-preserved. For read, the field values will be decoded in + sorted mode from the raw bytes. (2) Every field in the schema must + specify a non-empty name. (3) Every field must specify a type with + an associated encoding. The type is limited to scalar types only: + Array, Map, Aggregate, and Struct are not allowed. (4) The field + names must not collide with existing column family names and + reserved keywords "_key" and "_timestamp". The following update + operations are allowed for row_key_schema: - Update from an empty + schema to a new schema. - Remove the existing schema. This operation + requires setting the `ignore_warnings` flag to `true`, since it + might be a backward incompatible change. Without the flag, the + update request will fail with an INVALID_ARGUMENT error. Any other + row key schema update operation (e.g. update existing schema columns + names or types) is currently unsupported. + $ref: '#/components/schemas/GoogleBigtableAdminV2TypeStruct' ClusterState: id: ClusterState description: The state of a table's data in a particular cluster. @@ -1462,6 +1601,12 @@ components: mapType: description: Map $ref: '#/components/schemas/GoogleBigtableAdminV2TypeMap' + protoType: + description: Proto + $ref: '#/components/schemas/GoogleBigtableAdminV2TypeProto' + enumType: + description: Enum + $ref: '#/components/schemas/GoogleBigtableAdminV2TypeEnum' GoogleBigtableAdminV2TypeBytes: id: GoogleBigtableAdminV2TypeBytes description: Bytes Values of type `Bytes` are stored in `Value.bytes_value`. @@ -1484,7 +1629,13 @@ components: Leaves the value as-is. Sorted mode: all values are supported. Distinct mode: all values are supported. type: object - properties: {} + properties: + escapeNulls: + description: >- + If set, allows NULL values to be encoded as the empty string "". The + actual empty string, or any value which only contains the null byte + 0x00, has one more null byte appended. + type: boolean GoogleBigtableAdminV2TypeString: id: GoogleBigtableAdminV2TypeString description: String Values of type `String` are stored in `Value.string_value`. @@ -1520,7 +1671,16 @@ components: with: - BigQuery `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)` type: object - properties: {} + properties: + nullEscapeChar: + description: >- + Single-character escape sequence used to support NULL values. If + set, allows NULL values to be encoded as the empty string "". The + actual empty string, or any value where every character equals + `null_escape_char`, has one more `null_escape_char` appended. If + `null_escape_char` is set and does not equal the ASCII null + character 0x00, then the encoding will not support sorted mode. . + type: string GoogleBigtableAdminV2TypeInt64: id: GoogleBigtableAdminV2TypeInt64 description: Int64 Values of type `Int64` are stored in `Value.int_value`. @@ -1538,6 +1698,10 @@ components: description: Use `BigEndianBytes` encoding. $ref: >- #/components/schemas/GoogleBigtableAdminV2TypeInt64EncodingBigEndianBytes + orderedCodeBytes: + description: Use `OrderedCodeBytes` encoding. + $ref: >- + #/components/schemas/GoogleBigtableAdminV2TypeInt64EncodingOrderedCodeBytes GoogleBigtableAdminV2TypeInt64EncodingBigEndianBytes: id: GoogleBigtableAdminV2TypeInt64EncodingBigEndianBytes description: >- @@ -1552,6 +1716,14 @@ components: description: 'Deprecated: ignored if set.' deprecated: true $ref: '#/components/schemas/GoogleBigtableAdminV2TypeBytes' + GoogleBigtableAdminV2TypeInt64EncodingOrderedCodeBytes: + id: GoogleBigtableAdminV2TypeInt64EncodingOrderedCodeBytes + description: >- + Encodes the value in a variable length binary format of up to 10 bytes. + Values that are closer to zero use fewer bytes. Sorted mode: all values + are supported. Distinct mode: all values are supported. + type: object + properties: {} GoogleBigtableAdminV2TypeFloat32: id: GoogleBigtableAdminV2TypeFloat32 description: Float32 Values of type `Float32` are stored in `Value.float_value`. @@ -1573,7 +1745,22 @@ components: Timestamp Values of type `Timestamp` are stored in `Value.timestamp_value`. type: object - properties: {} + properties: + encoding: + description: The encoding to use when converting to or from lower level types. + $ref: '#/components/schemas/GoogleBigtableAdminV2TypeTimestampEncoding' + GoogleBigtableAdminV2TypeTimestampEncoding: + id: GoogleBigtableAdminV2TypeTimestampEncoding + description: Rules used to convert to or from lower level types. + type: object + properties: + unixMicrosInt64: + description: >- + Encodes the number of microseconds since the Unix epoch using the + given `Int64` encoding. Values must be microsecond-aligned. + Compatible with: - Java `Instant.truncatedTo()` with + `ChronoUnit.MICROS` + $ref: '#/components/schemas/GoogleBigtableAdminV2TypeInt64Encoding' GoogleBigtableAdminV2TypeDate: id: GoogleBigtableAdminV2TypeDate description: Date Values of type `Date` are stored in `Value.date_value`. @@ -1658,6 +1845,9 @@ components: type: array items: $ref: '#/components/schemas/GoogleBigtableAdminV2TypeStructField' + encoding: + description: The encoding to use when converting to or from lower level types. + $ref: '#/components/schemas/GoogleBigtableAdminV2TypeStructEncoding' GoogleBigtableAdminV2TypeStructField: id: GoogleBigtableAdminV2TypeStructField description: A struct field and its type. @@ -1671,6 +1861,74 @@ components: type: description: The type of values in this field. $ref: '#/components/schemas/Type' + GoogleBigtableAdminV2TypeStructEncoding: + id: GoogleBigtableAdminV2TypeStructEncoding + description: Rules used to convert to or from lower level types. + type: object + properties: + singleton: + description: Use `Singleton` encoding. + $ref: >- + #/components/schemas/GoogleBigtableAdminV2TypeStructEncodingSingleton + delimitedBytes: + description: Use `DelimitedBytes` encoding. + $ref: >- + #/components/schemas/GoogleBigtableAdminV2TypeStructEncodingDelimitedBytes + orderedCodeBytes: + description: User `OrderedCodeBytes` encoding. + $ref: >- + #/components/schemas/GoogleBigtableAdminV2TypeStructEncodingOrderedCodeBytes + GoogleBigtableAdminV2TypeStructEncodingSingleton: + id: GoogleBigtableAdminV2TypeStructEncodingSingleton + description: >- + Uses the encoding of `fields[0].type` as-is. Only valid if `fields.size + == 1`. + type: object + properties: {} + GoogleBigtableAdminV2TypeStructEncodingDelimitedBytes: + id: GoogleBigtableAdminV2TypeStructEncodingDelimitedBytes + description: >- + Fields are encoded independently and concatenated with a configurable + `delimiter` in between. A struct with no fields defined is encoded as a + single `delimiter`. Sorted mode: - Fields are encoded in sorted mode. - + Encoded field values must not contain any bytes <= `delimiter[0]` - + Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] + == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: + - Fields are encoded in distinct mode. - Encoded field values must not + contain `delimiter[0]`. + type: object + properties: + delimiter: + description: >- + Byte sequence used to delimit concatenated fields. The delimiter + must contain at least 1 character and at most 50 characters. + type: string + format: byte + GoogleBigtableAdminV2TypeStructEncodingOrderedCodeBytes: + id: GoogleBigtableAdminV2TypeStructEncodingOrderedCodeBytes + description: >- + Fields are encoded independently and concatenated with the fixed byte + pair {0x00, 0x01} in between. Any null (0x00) byte in an encoded field + is replaced by the fixed byte pair {0x00, 0xFF}. Fields that encode to + the empty string "" have special handling: - If *every* field encodes to + "", or if the STRUCT has no fields defined, then the STRUCT is encoded + as the fixed byte pair {0x00, 0x00}. - Otherwise, the STRUCT only + encodes until the last non-empty field, omitting any trailing empty + fields. Any empty fields that aren't omitted are replaced with the fixed + byte pair {0x00, 0x00}. Examples: - STRUCT() -> "\00\00" - STRUCT("") -> + "\00\00" - STRUCT("", "") -> "\00\00" - STRUCT("", "B") -> "\00\00" + + "\00\01" + "B" - STRUCT("A", "") -> "A" - STRUCT("", "B", "") -> + "\00\00" + "\00\01" + "B" - STRUCT("A", "", "C") -> "A" + "\00\01" + + "\00\00" + "\00\01" + "C" Since null bytes are always escaped, this + encoding can cause size blowup for encodings like `Int64.BigEndianBytes` + that are likely to produce many such bytes. Sorted mode: - Fields are + encoded in sorted mode. - All values supported by the field encodings + are allowed - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, + or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. + Distinct mode: - Fields are encoded in distinct mode. - All values + supported by the field encodings are allowed. + type: object + properties: {} GoogleBigtableAdminV2TypeArray: id: GoogleBigtableAdminV2TypeArray description: >- @@ -1700,6 +1958,36 @@ components: valueType: description: The type of the values in a map. $ref: '#/components/schemas/Type' + GoogleBigtableAdminV2TypeProto: + id: GoogleBigtableAdminV2TypeProto + description: >- + A protobuf message type. Values of type `Proto` are stored in + `Value.bytes_value`. + type: object + properties: + schemaBundleId: + description: The ID of the schema bundle that this proto is defined in. + type: string + messageName: + description: >- + The fully qualified name of the protobuf message, including package. + In the format of "foo.bar.Message". + type: string + GoogleBigtableAdminV2TypeEnum: + id: GoogleBigtableAdminV2TypeEnum + description: >- + A protobuf enum type. Values of type `Enum` are stored in + `Value.int_value`. + type: object + properties: + schemaBundleId: + description: The ID of the schema bundle that this enum is defined in. + type: string + enumName: + description: >- + The fully qualified name of the protobuf enum message, including + package. In the format of "foo.bar.EnumMessage". + type: string RestoreInfo: id: RestoreInfo description: Information about a table restore. @@ -1816,8 +2104,8 @@ components: properties: retentionPeriod: description: >- - Required. How long the automated backups should be retained. The - only supported value at this time is 3 days. + Required. How long the automated backups should be retained. Values + must be at least 3 days and at most 90 days. type: string format: google-duration frequency: @@ -1827,6 +2115,32 @@ components: 24 hours. type: string format: google-duration + TieredStorageConfig: + id: TieredStorageConfig + description: >- + Config for tiered storage. A valid config must have a valid + TieredStorageRule. Otherwise the whole TieredStorageConfig must be + unset. By default all data is stored in the SSD tier (only SSD instances + can configure tiered storage). + type: object + properties: + infrequentAccess: + description: >- + Rule to specify what data is stored in the infrequent access(IA) + tier. The IA tier allows storing more data per node with reduced + performance. + $ref: '#/components/schemas/TieredStorageRule' + TieredStorageRule: + id: TieredStorageRule + description: Rule to specify what data is stored in a storage tier. + type: object + properties: + includeIfOlderThan: + description: >- + Include cells older than the given age. For the infrequent access + tier, this value must be at least 30 days. + type: string + format: google-duration Split: id: Split description: An initial split point for a newly created table. @@ -2256,6 +2570,61 @@ components: resources used by the backup. type: string format: google-datetime + SchemaBundle: + id: SchemaBundle + description: A named collection of related schemas. + type: object + properties: + name: + description: >- + Identifier. The unique name identifying this schema bundle. Values + are of the form + `projects/{project}/instances/{instance}/tables/{table}/schemaBundles/{schema_bundle}` + type: string + protoSchema: + description: Schema for Protobufs. + $ref: '#/components/schemas/ProtoSchema' + etag: + description: >- + Optional. The etag for this schema bundle. This may be sent on + update and delete requests to ensure the client has an up-to-date + value before proceeding. The server returns an ABORTED error on a + mismatched etag. + type: string + ProtoSchema: + id: ProtoSchema + description: Represents a protobuf schema. + type: object + properties: + protoDescriptors: + description: >- + Required. Contains a protobuf-serialized + [google.protobuf.FileDescriptorSet](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto), + which could include multiple proto files. To generate it, + [install](https://grpc.io/docs/protoc-installation/) and run + `protoc` with `--include_imports` and `--descriptor_set_out`. For + example, to generate for moon/shot/app.proto, run ``` $protoc + --proto_path=/app_path --proto_path=/lib_path \ --include_imports \ + --descriptor_set_out=descriptors.pb \ moon/shot/app.proto ``` For + more details, see protobuffer [self + description](https://developers.google.com/protocol-buffers/docs/techniques#self-description). + type: string + format: byte + ListSchemaBundlesResponse: + id: ListSchemaBundlesResponse + description: The response for ListSchemaBundles. + type: object + properties: + schemaBundles: + description: The schema bundles from the specified table. + type: array + items: + $ref: '#/components/schemas/SchemaBundle' + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string ListLocationsResponse: id: ListLocationsResponse description: The response message for Locations.ListLocations. @@ -2629,12 +2998,12 @@ components: If exists, the name of the long-running operation that will be used to track the post-restore optimization process to optimize the performance of the restored table. The metadata type of the - long-running operation is OptimizeRestoreTableMetadata. The response - type is Empty. This long-running operation may be automatically - created by the system if applicable after the RestoreTable - long-running operation completes successfully. This operation may - not be created if the table is already optimized or the restore was - not successful. + long-running operation is OptimizeRestoredTableMetadata. The + response type is Empty. This long-running operation may be + automatically created by the system if applicable after the + RestoreTable long-running operation completes successfully. This + operation may not be created if the table is already optimized or + the restore was not successful. type: string progress: description: The progress of the RestoreTable operation. @@ -2738,6 +3107,149 @@ components: Optional. If true, ignore the safety checks when updating the AuthorizedView. type: boolean + CreateSchemaBundleMetadata: + id: CreateSchemaBundleMetadata + description: The metadata for the Operation returned by CreateSchemaBundle. + type: object + properties: + name: + description: >- + The unique name identifying this schema bundle. Values are of the + form + `projects/{project}/instances/{instance}/tables/{table}/schemaBundles/{schema_bundle}` + type: string + startTime: + description: The time at which this operation started. + type: string + format: google-datetime + endTime: + description: If set, the time at which this operation finished or was canceled. + type: string + format: google-datetime + UpdateSchemaBundleMetadata: + id: UpdateSchemaBundleMetadata + description: The metadata for the Operation returned by UpdateSchemaBundle. + type: object + properties: + name: + description: >- + The unique name identifying this schema bundle. Values are of the + form + `projects/{project}/instances/{instance}/tables/{table}/schemaBundles/{schema_bundle}` + type: string + startTime: + description: The time at which this operation started. + type: string + format: google-datetime + endTime: + description: If set, the time at which this operation finished or was canceled. + type: string + format: google-datetime + CreateLogicalViewMetadata: + id: CreateLogicalViewMetadata + description: The metadata for the Operation returned by CreateLogicalView. + type: object + properties: + originalRequest: + description: >- + The request that prompted the initiation of this CreateLogicalView + operation. + $ref: '#/components/schemas/CreateLogicalViewRequest' + startTime: + description: The time at which this operation started. + type: string + format: google-datetime + endTime: + description: If set, the time at which this operation finished or was canceled. + type: string + format: google-datetime + CreateLogicalViewRequest: + id: CreateLogicalViewRequest + description: Request message for BigtableInstanceAdmin.CreateLogicalView. + type: object + properties: + parent: + description: >- + Required. The parent instance where this logical view will be + created. Format: `projects/{project}/instances/{instance}`. + type: string + logicalViewId: + description: >- + Required. The ID to use for the logical view, which will become the + final component of the logical view's resource name. + type: string + logicalView: + description: Required. The logical view to create. + $ref: '#/components/schemas/LogicalView' + UpdateLogicalViewMetadata: + id: UpdateLogicalViewMetadata + description: The metadata for the Operation returned by UpdateLogicalView. + type: object + properties: + originalRequest: + description: >- + The request that prompted the initiation of this UpdateLogicalView + operation. + $ref: '#/components/schemas/UpdateLogicalViewRequest' + startTime: + description: The time at which this operation was started. + type: string + format: google-datetime + endTime: + description: If set, the time at which this operation finished or was canceled. + type: string + format: google-datetime + UpdateLogicalViewRequest: + id: UpdateLogicalViewRequest + description: Request message for BigtableInstanceAdmin.UpdateLogicalView. + type: object + properties: + logicalView: + description: >- + Required. The logical view to update. The logical view's `name` + field is used to identify the view to update. Format: + `projects/{project}/instances/{instance}/logicalViews/{logical_view}`. + $ref: '#/components/schemas/LogicalView' + updateMask: + description: Optional. The list of fields to update. + type: string + format: google-fieldmask + CreateMaterializedViewMetadata: + id: CreateMaterializedViewMetadata + description: The metadata for the Operation returned by CreateMaterializedView. + type: object + properties: + originalRequest: + description: >- + The request that prompted the initiation of this + CreateMaterializedView operation. + $ref: '#/components/schemas/CreateMaterializedViewRequest' + startTime: + description: The time at which this operation started. + type: string + format: google-datetime + endTime: + description: If set, the time at which this operation finished or was canceled. + type: string + format: google-datetime + CreateMaterializedViewRequest: + id: CreateMaterializedViewRequest + description: Request message for BigtableInstanceAdmin.CreateMaterializedView. + type: object + properties: + parent: + description: >- + Required. The parent instance where this materialized view will be + created. Format: `projects/{project}/instances/{instance}`. + type: string + materializedViewId: + description: >- + Required. The ID to use for the materialized view, which will become + the final component of the materialized view's resource name. + type: string + materializedView: + description: Required. The materialized view to create. + $ref: '#/components/schemas/MaterializedView' parameters: access_token: description: OAuth access token. @@ -3164,76 +3676,254 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/app_profiles/methods/delete' - tables: - id: google.bigtableadmin.tables - name: tables - title: Tables + materialized_views_iam_policies: + id: google.bigtableadmin.materialized_views_iam_policies + name: materialized_views_iam_policies + title: Materialized_views_iam_policies methods: - create: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1tables/post - response: - mediaType: application/json - openAPIDocKey: '200' - list: + get_iam_policy: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1tables/get + #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1materializedViews~1{materializedViewsId}:getIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.tables - get: + objectKey: $.bindings + set_iam_policy: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1tables~1{tablesId}/get + #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1materializedViews~1{materializedViewsId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - patch: + test_iam_permissions: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1tables~1{tablesId}/patch + #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1materializedViews~1{materializedViewsId}:testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' - delete: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/materialized_views_iam_policies/methods/get_iam_policy + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/materialized_views_iam_policies/methods/set_iam_policy + delete: [] + materialized_views: + id: google.bigtableadmin.materialized_views + name: materialized_views + title: Materialized_views + methods: + create: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1tables~1{tablesId}/delete + #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1materializedViews/post response: mediaType: application/json openAPIDocKey: '200' - undelete: + list: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1tables~1{tablesId}:undelete/post + #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1materializedViews/get response: mediaType: application/json openAPIDocKey: '200' - modify_column_families: + objectKey: $.materializedViews + get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1tables~1{tablesId}:modifyColumnFamilies/post + #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1materializedViews~1{materializedViewsId}/get response: mediaType: application/json openAPIDocKey: '200' - drop_row_range: + patch: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1tables~1{tablesId}:dropRowRange/post + #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1materializedViews~1{materializedViewsId}/patch response: mediaType: application/json openAPIDocKey: '200' - generate_consistency_token: + delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1tables~1{tablesId}:generateConsistencyToken/post + #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1materializedViews~1{materializedViewsId}/delete response: mediaType: application/json openAPIDocKey: '200' - check_consistency: + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/materialized_views/methods/get' + - $ref: '#/components/x-stackQL-resources/materialized_views/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/materialized_views/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/materialized_views/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/materialized_views/methods/delete' + logical_views_iam_policies: + id: google.bigtableadmin.logical_views_iam_policies + name: logical_views_iam_policies + title: Logical_views_iam_policies + methods: + get_iam_policy: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1logicalViews~1{logicalViewsId}:getIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.bindings + set_iam_policy: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1logicalViews~1{logicalViewsId}:setIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + test_iam_permissions: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1logicalViews~1{logicalViewsId}:testIamPermissions/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/logical_views_iam_policies/methods/get_iam_policy + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/logical_views_iam_policies/methods/set_iam_policy + delete: [] + logical_views: + id: google.bigtableadmin.logical_views + name: logical_views + title: Logical_views + methods: + create: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1logicalViews/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1logicalViews/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.logicalViews + get: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1logicalViews~1{logicalViewsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1logicalViews~1{logicalViewsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1logicalViews~1{logicalViewsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/logical_views/methods/get' + - $ref: '#/components/x-stackQL-resources/logical_views/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/logical_views/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/logical_views/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/logical_views/methods/delete' + tables: + id: google.bigtableadmin.tables + name: tables + title: Tables + methods: + create: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1tables/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1tables/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.tables + get: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1tables~1{tablesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1tables~1{tablesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1tables~1{tablesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + undelete: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1tables~1{tablesId}:undelete/post + response: + mediaType: application/json + openAPIDocKey: '200' + modify_column_families: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1tables~1{tablesId}:modifyColumnFamilies/post + response: + mediaType: application/json + openAPIDocKey: '200' + drop_row_range: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1tables~1{tablesId}:dropRowRange/post + response: + mediaType: application/json + openAPIDocKey: '200' + generate_consistency_token: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1tables~1{tablesId}:generateConsistencyToken/post + response: + mediaType: application/json + openAPIDocKey: '200' + check_consistency: operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1tables~1{tablesId}:checkConsistency/post @@ -3384,6 +4074,95 @@ components: - $ref: >- #/components/x-stackQL-resources/authorized_views_iam_policies/methods/set_iam_policy delete: [] + schema_bundles_iam_policies: + id: google.bigtableadmin.schema_bundles_iam_policies + name: schema_bundles_iam_policies + title: Schema_bundles_iam_policies + methods: + get_iam_policy: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1tables~1{tablesId}~1schemaBundles~1{schemaBundlesId}:getIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.bindings + set_iam_policy: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1tables~1{tablesId}~1schemaBundles~1{schemaBundlesId}:setIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + test_iam_permissions: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1tables~1{tablesId}~1schemaBundles~1{schemaBundlesId}:testIamPermissions/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/schema_bundles_iam_policies/methods/get_iam_policy + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/schema_bundles_iam_policies/methods/set_iam_policy + delete: [] + schema_bundles: + id: google.bigtableadmin.schema_bundles + name: schema_bundles + title: Schema_bundles + methods: + create: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1tables~1{tablesId}~1schemaBundles/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1tables~1{tablesId}~1schemaBundles/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.schemaBundles + patch: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1tables~1{tablesId}~1schemaBundles~1{schemaBundlesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1tables~1{tablesId}~1schemaBundles~1{schemaBundlesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1tables~1{tablesId}~1schemaBundles~1{schemaBundlesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/schema_bundles/methods/get' + - $ref: '#/components/x-stackQL-resources/schema_bundles/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/schema_bundles/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/schema_bundles/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/schema_bundles/methods/delete' locations: id: google.bigtableadmin.locations name: locations @@ -5263,35 +6042,39 @@ paths: name: ignoreWarnings schema: type: boolean - /v2/projects/{projectsId}/instances/{instancesId}/tables: + /v2/projects/{projectsId}/instances/{instancesId}/materializedViews/{materializedViewsId}:getIamPolicy: parameters: *ref_1 post: description: >- - Creates a new table in the specified instance. The table can be created - with a full set of initial column families, specified in the request. - operationId: bigtableadmin.projects.instances.tables.create + Gets the access control policy for an instance resource. Returns an + empty policy if an instance exists but does not have a policy set. + operationId: bigtableadmin.projects.instances.materializedViews.getIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateTableRequest' + $ref: '#/components/schemas/GetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/bigtable.admin Oauth2c: - https://www.googleapis.com/auth/bigtable.admin - Oauth2: - - https://www.googleapis.com/auth/bigtable.admin.table + - https://www.googleapis.com/auth/bigtable.admin.cluster Oauth2c: - - https://www.googleapis.com/auth/bigtable.admin.table + - https://www.googleapis.com/auth/bigtable.admin.cluster + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin.instance + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin.instance - Oauth2: - https://www.googleapis.com/auth/cloud-bigtable.admin Oauth2c: - https://www.googleapis.com/auth/cloud-bigtable.admin - Oauth2: - - https://www.googleapis.com/auth/cloud-bigtable.admin.table + - https://www.googleapis.com/auth/cloud-bigtable.admin.cluster Oauth2c: - - https://www.googleapis.com/auth/cloud-bigtable.admin.table + - https://www.googleapis.com/auth/cloud-bigtable.admin.cluster - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -5302,7 +6085,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Table' + $ref: '#/components/schemas/Policy' parameters: - in: path name: projectsId @@ -5314,41 +6097,1304 @@ paths: required: true schema: type: string - get: - description: Lists all tables served from a specified instance. - operationId: bigtableadmin.projects.instances.tables.list + - in: path + name: materializedViewsId + required: true + schema: + type: string + /v2/projects/{projectsId}/instances/{instancesId}/materializedViews/{materializedViewsId}:setIamPolicy: + parameters: *ref_1 + post: + description: >- + Sets the access control policy on an instance resource. Replaces any + existing policy. + operationId: bigtableadmin.projects.instances.materializedViews.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/bigtable.admin Oauth2c: - https://www.googleapis.com/auth/bigtable.admin - Oauth2: - - https://www.googleapis.com/auth/bigtable.admin.table + - https://www.googleapis.com/auth/bigtable.admin.cluster Oauth2c: - - https://www.googleapis.com/auth/bigtable.admin.table + - https://www.googleapis.com/auth/bigtable.admin.cluster + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin.instance + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin.instance - Oauth2: - https://www.googleapis.com/auth/cloud-bigtable.admin Oauth2c: - https://www.googleapis.com/auth/cloud-bigtable.admin - Oauth2: - - https://www.googleapis.com/auth/cloud-bigtable.admin.table + - https://www.googleapis.com/auth/cloud-bigtable.admin.cluster Oauth2c: - - https://www.googleapis.com/auth/cloud-bigtable.admin.table + - https://www.googleapis.com/auth/cloud-bigtable.admin.cluster + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + - in: path + name: materializedViewsId + required: true + schema: + type: string + /v2/projects/{projectsId}/instances/{instancesId}/materializedViews/{materializedViewsId}:testIamPermissions: + parameters: *ref_1 + post: + description: >- + Returns permissions that the caller has on the specified instance + resource. + operationId: bigtableadmin.projects.instances.materializedViews.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin.cluster + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin.cluster + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin.instance + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin.instance + - Oauth2: + - https://www.googleapis.com/auth/cloud-bigtable.admin + Oauth2c: + - https://www.googleapis.com/auth/cloud-bigtable.admin + - Oauth2: + - https://www.googleapis.com/auth/cloud-bigtable.admin.cluster + Oauth2c: + - https://www.googleapis.com/auth/cloud-bigtable.admin.cluster + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + - in: path + name: materializedViewsId + required: true + schema: + type: string + /v2/projects/{projectsId}/instances/{instancesId}/materializedViews: + parameters: *ref_1 + post: + description: Creates a materialized view within an instance. + operationId: bigtableadmin.projects.instances.materializedViews.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MaterializedView' + security: + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin.cluster + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin.cluster + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin.instance + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin.instance + - Oauth2: + - https://www.googleapis.com/auth/cloud-bigtable.admin + Oauth2c: + - https://www.googleapis.com/auth/cloud-bigtable.admin + - Oauth2: + - https://www.googleapis.com/auth/cloud-bigtable.admin.cluster + Oauth2c: + - https://www.googleapis.com/auth/cloud-bigtable.admin.cluster + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + - in: query + name: materializedViewId + schema: + type: string + get: + description: Lists information about materialized views in an instance. + operationId: bigtableadmin.projects.instances.materializedViews.list + security: + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin.cluster + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin.cluster + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin.instance + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin.instance + - Oauth2: + - https://www.googleapis.com/auth/cloud-bigtable.admin + Oauth2c: + - https://www.googleapis.com/auth/cloud-bigtable.admin + - Oauth2: + - https://www.googleapis.com/auth/cloud-bigtable.admin.cluster + Oauth2c: + - https://www.googleapis.com/auth/cloud-bigtable.admin.cluster + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListMaterializedViewsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v2/projects/{projectsId}/instances/{instancesId}/materializedViews/{materializedViewsId}: + parameters: *ref_1 + get: + description: Gets information about a materialized view. + operationId: bigtableadmin.projects.instances.materializedViews.get + security: + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin.cluster + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin.cluster + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin.instance + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin.instance + - Oauth2: + - https://www.googleapis.com/auth/cloud-bigtable.admin + Oauth2c: + - https://www.googleapis.com/auth/cloud-bigtable.admin + - Oauth2: + - https://www.googleapis.com/auth/cloud-bigtable.admin.cluster + Oauth2c: + - https://www.googleapis.com/auth/cloud-bigtable.admin.cluster + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/MaterializedView' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + - in: path + name: materializedViewsId + required: true + schema: + type: string + patch: + description: Updates a materialized view within an instance. + operationId: bigtableadmin.projects.instances.materializedViews.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MaterializedView' + security: + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin.cluster + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin.cluster + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin.instance + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin.instance + - Oauth2: + - https://www.googleapis.com/auth/cloud-bigtable.admin + Oauth2c: + - https://www.googleapis.com/auth/cloud-bigtable.admin + - Oauth2: + - https://www.googleapis.com/auth/cloud-bigtable.admin.cluster + Oauth2c: + - https://www.googleapis.com/auth/cloud-bigtable.admin.cluster + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + - in: path + name: materializedViewsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a materialized view from an instance. + operationId: bigtableadmin.projects.instances.materializedViews.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin.cluster + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin.cluster + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin.instance + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin.instance + - Oauth2: + - https://www.googleapis.com/auth/cloud-bigtable.admin + Oauth2c: + - https://www.googleapis.com/auth/cloud-bigtable.admin + - Oauth2: + - https://www.googleapis.com/auth/cloud-bigtable.admin.cluster + Oauth2c: + - https://www.googleapis.com/auth/cloud-bigtable.admin.cluster + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + - in: path + name: materializedViewsId + required: true + schema: + type: string + - in: query + name: etag + schema: + type: string + /v2/projects/{projectsId}/instances/{instancesId}/logicalViews/{logicalViewsId}:getIamPolicy: + parameters: *ref_1 + post: + description: >- + Gets the access control policy for an instance resource. Returns an + empty policy if an instance exists but does not have a policy set. + operationId: bigtableadmin.projects.instances.logicalViews.getIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetIamPolicyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin.cluster + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin.cluster + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin.instance + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin.instance + - Oauth2: + - https://www.googleapis.com/auth/cloud-bigtable.admin + Oauth2c: + - https://www.googleapis.com/auth/cloud-bigtable.admin + - Oauth2: + - https://www.googleapis.com/auth/cloud-bigtable.admin.cluster + Oauth2c: + - https://www.googleapis.com/auth/cloud-bigtable.admin.cluster + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + - in: path + name: logicalViewsId + required: true + schema: + type: string + /v2/projects/{projectsId}/instances/{instancesId}/logicalViews/{logicalViewsId}:setIamPolicy: + parameters: *ref_1 + post: + description: >- + Sets the access control policy on an instance resource. Replaces any + existing policy. + operationId: bigtableadmin.projects.instances.logicalViews.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetIamPolicyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin.cluster + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin.cluster + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin.instance + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin.instance + - Oauth2: + - https://www.googleapis.com/auth/cloud-bigtable.admin + Oauth2c: + - https://www.googleapis.com/auth/cloud-bigtable.admin + - Oauth2: + - https://www.googleapis.com/auth/cloud-bigtable.admin.cluster + Oauth2c: + - https://www.googleapis.com/auth/cloud-bigtable.admin.cluster + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + - in: path + name: logicalViewsId + required: true + schema: + type: string + /v2/projects/{projectsId}/instances/{instancesId}/logicalViews/{logicalViewsId}:testIamPermissions: + parameters: *ref_1 + post: + description: >- + Returns permissions that the caller has on the specified instance + resource. + operationId: bigtableadmin.projects.instances.logicalViews.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin.cluster + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin.cluster + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin.instance + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin.instance + - Oauth2: + - https://www.googleapis.com/auth/cloud-bigtable.admin + Oauth2c: + - https://www.googleapis.com/auth/cloud-bigtable.admin + - Oauth2: + - https://www.googleapis.com/auth/cloud-bigtable.admin.cluster + Oauth2c: + - https://www.googleapis.com/auth/cloud-bigtable.admin.cluster + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + - in: path + name: logicalViewsId + required: true + schema: + type: string + /v2/projects/{projectsId}/instances/{instancesId}/logicalViews: + parameters: *ref_1 + post: + description: Creates a logical view within an instance. + operationId: bigtableadmin.projects.instances.logicalViews.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LogicalView' + security: + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin.cluster + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin.cluster + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin.instance + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin.instance + - Oauth2: + - https://www.googleapis.com/auth/cloud-bigtable.admin + Oauth2c: + - https://www.googleapis.com/auth/cloud-bigtable.admin + - Oauth2: + - https://www.googleapis.com/auth/cloud-bigtable.admin.cluster + Oauth2c: + - https://www.googleapis.com/auth/cloud-bigtable.admin.cluster + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + - in: query + name: logicalViewId + schema: + type: string + get: + description: Lists information about logical views in an instance. + operationId: bigtableadmin.projects.instances.logicalViews.list + security: + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin.cluster + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin.cluster + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin.instance + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin.instance + - Oauth2: + - https://www.googleapis.com/auth/cloud-bigtable.admin + Oauth2c: + - https://www.googleapis.com/auth/cloud-bigtable.admin + - Oauth2: + - https://www.googleapis.com/auth/cloud-bigtable.admin.cluster + Oauth2c: + - https://www.googleapis.com/auth/cloud-bigtable.admin.cluster + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListLogicalViewsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v2/projects/{projectsId}/instances/{instancesId}/logicalViews/{logicalViewsId}: + parameters: *ref_1 + get: + description: Gets information about a logical view. + operationId: bigtableadmin.projects.instances.logicalViews.get + security: + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin.cluster + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin.cluster + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin.instance + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin.instance + - Oauth2: + - https://www.googleapis.com/auth/cloud-bigtable.admin + Oauth2c: + - https://www.googleapis.com/auth/cloud-bigtable.admin + - Oauth2: + - https://www.googleapis.com/auth/cloud-bigtable.admin.cluster + Oauth2c: + - https://www.googleapis.com/auth/cloud-bigtable.admin.cluster + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/LogicalView' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + - in: path + name: logicalViewsId + required: true + schema: + type: string + patch: + description: Updates a logical view within an instance. + operationId: bigtableadmin.projects.instances.logicalViews.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LogicalView' + security: + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin.cluster + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin.cluster + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin.instance + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin.instance + - Oauth2: + - https://www.googleapis.com/auth/cloud-bigtable.admin + Oauth2c: + - https://www.googleapis.com/auth/cloud-bigtable.admin + - Oauth2: + - https://www.googleapis.com/auth/cloud-bigtable.admin.cluster + Oauth2c: + - https://www.googleapis.com/auth/cloud-bigtable.admin.cluster + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + - in: path + name: logicalViewsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a logical view from an instance. + operationId: bigtableadmin.projects.instances.logicalViews.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin.cluster + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin.cluster + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin.instance + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin.instance + - Oauth2: + - https://www.googleapis.com/auth/cloud-bigtable.admin + Oauth2c: + - https://www.googleapis.com/auth/cloud-bigtable.admin + - Oauth2: + - https://www.googleapis.com/auth/cloud-bigtable.admin.cluster + Oauth2c: + - https://www.googleapis.com/auth/cloud-bigtable.admin.cluster + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + - in: path + name: logicalViewsId + required: true + schema: + type: string + - in: query + name: etag + schema: + type: string + /v2/projects/{projectsId}/instances/{instancesId}/tables: + parameters: *ref_1 + post: + description: >- + Creates a new table in the specified instance. The table can be created + with a full set of initial column families, specified in the request. + operationId: bigtableadmin.projects.instances.tables.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateTableRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin.table + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin.table + - Oauth2: + - https://www.googleapis.com/auth/cloud-bigtable.admin + Oauth2c: + - https://www.googleapis.com/auth/cloud-bigtable.admin + - Oauth2: + - https://www.googleapis.com/auth/cloud-bigtable.admin.table + Oauth2c: + - https://www.googleapis.com/auth/cloud-bigtable.admin.table + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Table' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + get: + description: Lists all tables served from a specified instance. + operationId: bigtableadmin.projects.instances.tables.list + security: + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin.table + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin.table + - Oauth2: + - https://www.googleapis.com/auth/cloud-bigtable.admin + Oauth2c: + - https://www.googleapis.com/auth/cloud-bigtable.admin + - Oauth2: + - https://www.googleapis.com/auth/cloud-bigtable.admin.table + Oauth2c: + - https://www.googleapis.com/auth/cloud-bigtable.admin.table + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListTablesResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + - in: query + name: view + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}: + parameters: *ref_1 + get: + description: Gets metadata information about the specified table. + operationId: bigtableadmin.projects.instances.tables.get + security: + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin.table + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin.table + - Oauth2: + - https://www.googleapis.com/auth/cloud-bigtable.admin + Oauth2c: + - https://www.googleapis.com/auth/cloud-bigtable.admin + - Oauth2: + - https://www.googleapis.com/auth/cloud-bigtable.admin.table + Oauth2c: + - https://www.googleapis.com/auth/cloud-bigtable.admin.table + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Table' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + - in: path + name: tablesId + required: true + schema: + type: string + - in: query + name: view + schema: + type: string + patch: + description: Updates a specified table. + operationId: bigtableadmin.projects.instances.tables.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Table' + security: + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin.table + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin.table + - Oauth2: + - https://www.googleapis.com/auth/cloud-bigtable.admin + Oauth2c: + - https://www.googleapis.com/auth/cloud-bigtable.admin + - Oauth2: + - https://www.googleapis.com/auth/cloud-bigtable.admin.table + Oauth2c: + - https://www.googleapis.com/auth/cloud-bigtable.admin.table + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + - in: path + name: tablesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: ignoreWarnings + schema: + type: boolean + delete: + description: Permanently deletes a specified table and all of its data. + operationId: bigtableadmin.projects.instances.tables.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin.table + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin.table + - Oauth2: + - https://www.googleapis.com/auth/cloud-bigtable.admin + Oauth2c: + - https://www.googleapis.com/auth/cloud-bigtable.admin + - Oauth2: + - https://www.googleapis.com/auth/cloud-bigtable.admin.table + Oauth2c: + - https://www.googleapis.com/auth/cloud-bigtable.admin.table + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + - in: path + name: tablesId + required: true + schema: + type: string + /v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}:undelete: + parameters: *ref_1 + post: + description: Restores a specified table which was accidentally deleted. + operationId: bigtableadmin.projects.instances.tables.undelete + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UndeleteTableRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin.table + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin.table + - Oauth2: + - https://www.googleapis.com/auth/cloud-bigtable.admin + Oauth2c: + - https://www.googleapis.com/auth/cloud-bigtable.admin + - Oauth2: + - https://www.googleapis.com/auth/cloud-bigtable.admin.table + Oauth2c: + - https://www.googleapis.com/auth/cloud-bigtable.admin.table + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + - in: path + name: tablesId + required: true + schema: + type: string + /v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}:modifyColumnFamilies: + parameters: *ref_1 + post: + description: >- + Performs a series of column family modifications on the specified table. + Either all or none of the modifications will occur before this method + returns, but data requests received prior to that point may see a table + where only some modifications have taken effect. + operationId: bigtableadmin.projects.instances.tables.modifyColumnFamilies + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ModifyColumnFamiliesRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin.table + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin.table + - Oauth2: + - https://www.googleapis.com/auth/cloud-bigtable.admin + Oauth2c: + - https://www.googleapis.com/auth/cloud-bigtable.admin + - Oauth2: + - https://www.googleapis.com/auth/cloud-bigtable.admin.table + Oauth2c: + - https://www.googleapis.com/auth/cloud-bigtable.admin.table + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Table' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + - in: path + name: tablesId + required: true + schema: + type: string + /v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}:dropRowRange: + parameters: *ref_1 + post: + description: >- + Permanently drop/delete a row range from a specified table. The request + can specify whether to delete all rows in a table, or only those that + match a particular prefix. Note that row key prefixes used here are + treated as service data. For more information about how service data is + handled, see the [Google Cloud Privacy + Notice](https://cloud.google.com/terms/cloud-privacy-notice). + operationId: bigtableadmin.projects.instances.tables.dropRowRange + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DropRowRangeRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin.table + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin.table + - Oauth2: + - https://www.googleapis.com/auth/cloud-bigtable.admin + Oauth2c: + - https://www.googleapis.com/auth/cloud-bigtable.admin + - Oauth2: + - https://www.googleapis.com/auth/cloud-bigtable.admin.table + Oauth2c: + - https://www.googleapis.com/auth/cloud-bigtable.admin.table - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/ListTablesResponse' + $ref: '#/components/schemas/Empty' parameters: - in: path name: projectsId @@ -5360,24 +7406,25 @@ paths: required: true schema: type: string - - in: query - name: view - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: tablesId + required: true schema: type: string - /v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}: + /v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}:generateConsistencyToken: parameters: *ref_1 - get: - description: Gets metadata information about the specified table. - operationId: bigtableadmin.projects.instances.tables.get + post: + description: >- + Generates a consistency token for a Table, which can be used in + CheckConsistency to check whether mutations to the table that finished + before this call started have been replicated. The tokens will be + available for 90 days. + operationId: bigtableadmin.projects.instances.tables.generateConsistencyToken + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GenerateConsistencyTokenRequest' security: - Oauth2: - https://www.googleapis.com/auth/bigtable.admin @@ -5399,17 +7446,13 @@ paths: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Table' + $ref: '#/components/schemas/GenerateConsistencyTokenResponse' parameters: - in: path name: projectsId @@ -5426,18 +7469,19 @@ paths: required: true schema: type: string - - in: query - name: view - schema: - type: string - patch: - description: Updates a specified table. - operationId: bigtableadmin.projects.instances.tables.patch + /v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}:checkConsistency: + parameters: *ref_1 + post: + description: >- + Checks replication consistency based on a consistency token, that is, if + replication has caught up based on the conditions specified in the token + and the check request. + operationId: bigtableadmin.projects.instances.tables.checkConsistency requestBody: content: application/json: schema: - $ref: '#/components/schemas/Table' + $ref: '#/components/schemas/CheckConsistencyRequest' security: - Oauth2: - https://www.googleapis.com/auth/bigtable.admin @@ -5465,7 +7509,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/CheckConsistencyResponse' parameters: - in: path name: projectsId @@ -5482,14 +7526,71 @@ paths: required: true schema: type: string - - in: query - name: updateMask + /v2/projects/{projectsId}/instances/{instancesId}/tables:restore: + parameters: *ref_1 + post: + description: >- + Create a new table by restoring from a completed backup. The returned + table long-running operation can be used to track the progress of the + operation, and to cancel it. The metadata field type is + RestoreTableMetadata. The response type is Table, if successful. + operationId: bigtableadmin.projects.instances.tables.restore + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RestoreTableRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin.table + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin.table + - Oauth2: + - https://www.googleapis.com/auth/cloud-bigtable.admin + Oauth2c: + - https://www.googleapis.com/auth/cloud-bigtable.admin + - Oauth2: + - https://www.googleapis.com/auth/cloud-bigtable.admin.table + Oauth2c: + - https://www.googleapis.com/auth/cloud-bigtable.admin.table + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true schema: type: string - format: google-fieldmask - delete: - description: Permanently deletes a specified table and all of its data. - operationId: bigtableadmin.projects.instances.tables.delete + - in: path + name: instancesId + required: true + schema: + type: string + /v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}:getIamPolicy: + parameters: *ref_1 + post: + description: >- + Gets the access control policy for a Bigtable resource. Returns an empty + policy if the resource exists but does not have a policy set. + operationId: bigtableadmin.projects.instances.tables.getIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/bigtable.admin @@ -5517,7 +7618,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/Policy' parameters: - in: path name: projectsId @@ -5534,16 +7635,18 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}:undelete: + /v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}:setIamPolicy: parameters: *ref_1 post: - description: Restores a specified table which was accidentally deleted. - operationId: bigtableadmin.projects.instances.tables.undelete + description: >- + Sets the access control policy on a Bigtable resource. Replaces any + existing policy. + operationId: bigtableadmin.projects.instances.tables.setIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/UndeleteTableRequest' + $ref: '#/components/schemas/SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/bigtable.admin @@ -5571,7 +7674,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Policy' parameters: - in: path name: projectsId @@ -5588,20 +7691,18 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}:modifyColumnFamilies: + /v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}:testIamPermissions: parameters: *ref_1 post: description: >- - Performs a series of column family modifications on the specified table. - Either all or none of the modifications will occur before this method - returns, but data requests received prior to that point may see a table - where only some modifications have taken effect. - operationId: bigtableadmin.projects.instances.tables.modifyColumnFamilies + Returns permissions that the caller has on the specified Bigtable + resource. + operationId: bigtableadmin.projects.instances.tables.testIamPermissions requestBody: content: application/json: schema: - $ref: '#/components/schemas/ModifyColumnFamiliesRequest' + $ref: '#/components/schemas/TestIamPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/bigtable.admin @@ -5629,7 +7730,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Table' + $ref: '#/components/schemas/TestIamPermissionsResponse' parameters: - in: path name: projectsId @@ -5646,22 +7747,16 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}:dropRowRange: + /v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}/authorizedViews: parameters: *ref_1 post: - description: >- - Permanently drop/delete a row range from a specified table. The request - can specify whether to delete all rows in a table, or only those that - match a particular prefix. Note that row key prefixes used here are - treated as service data. For more information about how service data is - handled, see the [Google Cloud Privacy - Notice](https://cloud.google.com/terms/cloud-privacy-notice). - operationId: bigtableadmin.projects.instances.tables.dropRowRange + description: Creates a new AuthorizedView in a table. + operationId: bigtableadmin.projects.instances.tables.authorizedViews.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/DropRowRangeRequest' + $ref: '#/components/schemas/AuthorizedView' security: - Oauth2: - https://www.googleapis.com/auth/bigtable.admin @@ -5689,7 +7784,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -5706,20 +7801,75 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}:generateConsistencyToken: + - in: query + name: authorizedViewId + schema: + type: string + get: + description: Lists all AuthorizedViews from a specific table. + operationId: bigtableadmin.projects.instances.tables.authorizedViews.list + security: + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin + - Oauth2: + - https://www.googleapis.com/auth/bigtable.admin.table + Oauth2c: + - https://www.googleapis.com/auth/bigtable.admin.table + - Oauth2: + - https://www.googleapis.com/auth/cloud-bigtable.admin + Oauth2c: + - https://www.googleapis.com/auth/cloud-bigtable.admin + - Oauth2: + - https://www.googleapis.com/auth/cloud-bigtable.admin.table + Oauth2c: + - https://www.googleapis.com/auth/cloud-bigtable.admin.table + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListAuthorizedViewsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + - in: path + name: tablesId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: view + schema: + type: string + /v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}/authorizedViews/{authorizedViewsId}: parameters: *ref_1 - post: - description: >- - Generates a consistency token for a Table, which can be used in - CheckConsistency to check whether mutations to the table that finished - before this call started have been replicated. The tokens will be - available for 90 days. - operationId: bigtableadmin.projects.instances.tables.generateConsistencyToken - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GenerateConsistencyTokenRequest' + get: + description: Gets information from a specified AuthorizedView. + operationId: bigtableadmin.projects.instances.tables.authorizedViews.get security: - Oauth2: - https://www.googleapis.com/auth/bigtable.admin @@ -5747,7 +7897,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GenerateConsistencyTokenResponse' + $ref: '#/components/schemas/AuthorizedView' parameters: - in: path name: projectsId @@ -5764,19 +7914,23 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}:checkConsistency: - parameters: *ref_1 - post: - description: >- - Checks replication consistency based on a consistency token, that is, if - replication has caught up based on the conditions specified in the token - and the check request. - operationId: bigtableadmin.projects.instances.tables.checkConsistency + - in: path + name: authorizedViewsId + required: true + schema: + type: string + - in: query + name: view + schema: + type: string + patch: + description: Updates an AuthorizedView in a table. + operationId: bigtableadmin.projects.instances.tables.authorizedViews.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/CheckConsistencyRequest' + $ref: '#/components/schemas/AuthorizedView' security: - Oauth2: - https://www.googleapis.com/auth/bigtable.admin @@ -5804,7 +7958,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CheckConsistencyResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -5821,20 +7975,23 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/instances/{instancesId}/tables:restore: - parameters: *ref_1 - post: - description: >- - Create a new table by restoring from a completed backup. The returned - table long-running operation can be used to track the progress of the - operation, and to cancel it. The metadata field type is - RestoreTableMetadata. The response type is Table, if successful. - operationId: bigtableadmin.projects.instances.tables.restore - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RestoreTableRequest' + - in: path + name: authorizedViewsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: ignoreWarnings + schema: + type: boolean + delete: + description: Permanently deletes a specified AuthorizedView. + operationId: bigtableadmin.projects.instances.tables.authorizedViews.delete security: - Oauth2: - https://www.googleapis.com/auth/bigtable.admin @@ -5862,7 +8019,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Empty' parameters: - in: path name: projectsId @@ -5874,13 +8031,27 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}:getIamPolicy: + - in: path + name: tablesId + required: true + schema: + type: string + - in: path + name: authorizedViewsId + required: true + schema: + type: string + - in: query + name: etag + schema: + type: string + /v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}/authorizedViews/{authorizedViewsId}:getIamPolicy: parameters: *ref_1 post: description: >- Gets the access control policy for a Bigtable resource. Returns an empty policy if the resource exists but does not have a policy set. - operationId: bigtableadmin.projects.instances.tables.getIamPolicy + operationId: bigtableadmin.projects.instances.tables.authorizedViews.getIamPolicy requestBody: content: application/json: @@ -5930,13 +8101,18 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}:setIamPolicy: + - in: path + name: authorizedViewsId + required: true + schema: + type: string + /v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}/authorizedViews/{authorizedViewsId}:setIamPolicy: parameters: *ref_1 post: description: >- Sets the access control policy on a Bigtable resource. Replaces any existing policy. - operationId: bigtableadmin.projects.instances.tables.setIamPolicy + operationId: bigtableadmin.projects.instances.tables.authorizedViews.setIamPolicy requestBody: content: application/json: @@ -5986,13 +8162,19 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}:testIamPermissions: + - in: path + name: authorizedViewsId + required: true + schema: + type: string + /v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}/authorizedViews/{authorizedViewsId}:testIamPermissions: parameters: *ref_1 post: description: >- Returns permissions that the caller has on the specified Bigtable resource. - operationId: bigtableadmin.projects.instances.tables.testIamPermissions + operationId: >- + bigtableadmin.projects.instances.tables.authorizedViews.testIamPermissions requestBody: content: application/json: @@ -6042,16 +8224,23 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}/authorizedViews: + - in: path + name: authorizedViewsId + required: true + schema: + type: string + /v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}/schemaBundles/{schemaBundlesId}:getIamPolicy: parameters: *ref_1 post: - description: Creates a new AuthorizedView in a table. - operationId: bigtableadmin.projects.instances.tables.authorizedViews.create + description: >- + Gets the access control policy for a Bigtable resource. Returns an empty + policy if the resource exists but does not have a policy set. + operationId: bigtableadmin.projects.instances.tables.schemaBundles.getIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/AuthorizedView' + $ref: '#/components/schemas/GetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/bigtable.admin @@ -6079,7 +8268,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Policy' parameters: - in: path name: projectsId @@ -6096,13 +8285,23 @@ paths: required: true schema: type: string - - in: query - name: authorizedViewId + - in: path + name: schemaBundlesId + required: true schema: type: string - get: - description: Lists all AuthorizedViews from a specific table. - operationId: bigtableadmin.projects.instances.tables.authorizedViews.list + /v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}/schemaBundles/{schemaBundlesId}:setIamPolicy: + parameters: *ref_1 + post: + description: >- + Sets the access control policy on a Bigtable resource. Replaces any + existing policy. + operationId: bigtableadmin.projects.instances.tables.schemaBundles.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/bigtable.admin @@ -6130,7 +8329,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListAuthorizedViewsResponse' + $ref: '#/components/schemas/Policy' parameters: - in: path name: projectsId @@ -6147,24 +8346,23 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: view + - in: path + name: schemaBundlesId + required: true schema: type: string - /v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}/authorizedViews/{authorizedViewsId}: + /v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}/schemaBundles/{schemaBundlesId}:testIamPermissions: parameters: *ref_1 - get: - description: Gets information from a specified AuthorizedView. - operationId: bigtableadmin.projects.instances.tables.authorizedViews.get + post: + description: >- + Returns permissions that the caller has on the specified Bigtable + resource. + operationId: bigtableadmin.projects.instances.tables.schemaBundles.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/bigtable.admin @@ -6192,7 +8390,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AuthorizedView' + $ref: '#/components/schemas/TestIamPermissionsResponse' parameters: - in: path name: projectsId @@ -6210,22 +8408,20 @@ paths: schema: type: string - in: path - name: authorizedViewsId + name: schemaBundlesId required: true schema: type: string - - in: query - name: view - schema: - type: string - patch: - description: Updates an AuthorizedView in a table. - operationId: bigtableadmin.projects.instances.tables.authorizedViews.patch + /v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}/schemaBundles: + parameters: *ref_1 + post: + description: Creates a new schema bundle in the specified table. + operationId: bigtableadmin.projects.instances.tables.schemaBundles.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/AuthorizedView' + $ref: '#/components/schemas/SchemaBundle' security: - Oauth2: - https://www.googleapis.com/auth/bigtable.admin @@ -6270,23 +8466,13 @@ paths: required: true schema: type: string - - in: path - name: authorizedViewsId - required: true - schema: - type: string - in: query - name: updateMask + name: schemaBundleId schema: type: string - format: google-fieldmask - - in: query - name: ignoreWarnings - schema: - type: boolean - delete: - description: Permanently deletes a specified AuthorizedView. - operationId: bigtableadmin.projects.instances.tables.authorizedViews.delete + get: + description: Lists all schema bundles associated with the specified table. + operationId: bigtableadmin.projects.instances.tables.schemaBundles.list security: - Oauth2: - https://www.googleapis.com/auth/bigtable.admin @@ -6314,7 +8500,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/ListSchemaBundlesResponse' parameters: - in: path name: projectsId @@ -6331,27 +8517,29 @@ paths: required: true schema: type: string - - in: path - name: authorizedViewsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - in: query - name: etag + name: view schema: type: string - /v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}/authorizedViews/{authorizedViewsId}:getIamPolicy: + /v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}/schemaBundles/{schemaBundlesId}: parameters: *ref_1 - post: - description: >- - Gets the access control policy for a Bigtable resource. Returns an empty - policy if the resource exists but does not have a policy set. - operationId: bigtableadmin.projects.instances.tables.authorizedViews.getIamPolicy + patch: + description: Updates a schema bundle in the specified table. + operationId: bigtableadmin.projects.instances.tables.schemaBundles.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GetIamPolicyRequest' + $ref: '#/components/schemas/SchemaBundle' security: - Oauth2: - https://www.googleapis.com/auth/bigtable.admin @@ -6379,7 +8567,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -6397,22 +8585,22 @@ paths: schema: type: string - in: path - name: authorizedViewsId + name: schemaBundlesId required: true schema: type: string - /v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}/authorizedViews/{authorizedViewsId}:setIamPolicy: - parameters: *ref_1 - post: - description: >- - Sets the access control policy on a Bigtable resource. Replaces any - existing policy. - operationId: bigtableadmin.projects.instances.tables.authorizedViews.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SetIamPolicyRequest' + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: ignoreWarnings + schema: + type: boolean + get: + description: Gets metadata information about the specified schema bundle. + operationId: bigtableadmin.projects.instances.tables.schemaBundles.get security: - Oauth2: - https://www.googleapis.com/auth/bigtable.admin @@ -6440,7 +8628,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/SchemaBundle' parameters: - in: path name: projectsId @@ -6458,23 +8646,13 @@ paths: schema: type: string - in: path - name: authorizedViewsId + name: schemaBundlesId required: true schema: type: string - /v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}/authorizedViews/{authorizedViewsId}:testIamPermissions: - parameters: *ref_1 - post: - description: >- - Returns permissions that the caller has on the specified Bigtable - resource. - operationId: >- - bigtableadmin.projects.instances.tables.authorizedViews.testIamPermissions - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TestIamPermissionsRequest' + delete: + description: Deletes a schema bundle in the specified table. + operationId: bigtableadmin.projects.instances.tables.schemaBundles.delete security: - Oauth2: - https://www.googleapis.com/auth/bigtable.admin @@ -6502,7 +8680,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TestIamPermissionsResponse' + $ref: '#/components/schemas/Empty' parameters: - in: path name: projectsId @@ -6520,10 +8698,14 @@ paths: schema: type: string - in: path - name: authorizedViewsId + name: schemaBundlesId required: true schema: type: string + - in: query + name: etag + schema: + type: string /v2/projects/{projectsId}/locations: parameters: *ref_1 get: @@ -6584,3 +8766,7 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/billingbudgets.yaml b/providers/src/googleapis.com/v00.00.00000/services/billingbudgets.yaml index 218bdbc9..dea0573a 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/billingbudgets.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/billingbudgets.yaml @@ -9,8 +9,8 @@ info: 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. version: v1 - x-discovery-doc-revision: '20241102' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250824' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/billing/docs/how-to/budget-api-overview servers: @@ -24,10 +24,10 @@ components: implicit: authorizationUrl: https://accounts.google.com/o/oauth2/auth scopes: &ref_0 + https://www.googleapis.com/auth/cloud-billing: View and manage your Google Cloud Platform billing accounts https://www.googleapis.com/auth/cloud-platform: >- See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. - https://www.googleapis.com/auth/cloud-billing: View and manage your Google Cloud Platform billing accounts Oauth2c: type: oauth2 description: Oauth 2.0 authorization code authentication @@ -47,21 +47,49 @@ components: (default), quarter, year, or custom time period. type: object properties: - etag: + name: + description: >- + Output only. Resource name of the budget. The resource name implies + the scope of a budget. Values are of the form + `billingAccounts/{billingAccountId}/budgets/{budgetId}`. + readOnly: true + type: string + displayName: + description: >- + User data for display name in UI. The name must be less than or + equal to 60 characters. type: string + budgetFilter: + description: >- + Optional. Filters that define which resources are used to compute + the actual spend against the budget amount, such as projects, + services, and the budget's time period, as well as other filters. + $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1Filter' + amount: + description: Required. Budgeted amount. + $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1BudgetAmount' + thresholdRules: + description: >- + Optional. Rules that trigger alerts (notifications of thresholds + being crossed) when spend exceeds the specified percentages of the + budget. Optional for `pubsubTopic` notifications. Required if using + email notifications. + type: array + items: + $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1ThresholdRule' + notificationsRule: + description: >- + Optional. Rules to apply to notifications sent based on budget spend + and thresholds. + $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1NotificationsRule' + etag: description: >- Optional. Etag to validate that the object is unchanged for a read-modify-write operation. An empty etag causes an update to overwrite other changes. - amount: - $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1BudgetAmount' - description: Required. Budgeted amount. + type: string ownershipScope: type: string - enum: - - OWNERSHIP_SCOPE_UNSPECIFIED - - ALL_USERS - - BILLING_ACCOUNT enumDescriptions: - Unspecified ownership scope, same as ALL_USERS. - >- @@ -72,232 +100,237 @@ components: Only billing account-level users have full access to the budget. Project-level users have read-only access, even if they have the required IAM permissions. - notificationsRule: - $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1NotificationsRule' + enum: + - OWNERSHIP_SCOPE_UNSPECIFIED + - ALL_USERS + - BILLING_ACCOUNT + GoogleCloudBillingBudgetsV1Filter: + id: GoogleCloudBillingBudgetsV1Filter + description: A filter for a budget, limiting the scope of the cost to calculate. + type: object + properties: + projects: description: >- - Optional. Rules to apply to notifications sent based on budget spend - and thresholds. - displayName: - type: string + Optional. A set of projects of the form `projects/{project}`, + specifying that usage from only this set of projects should be + included in the budget. If omitted, the report includes all usage + for the billing account, regardless of which project the usage + occurred on. + type: array + items: + type: string + resourceAncestors: description: >- - User data for display name in UI. The name must be less than or - equal to 60 characters. - name: + Optional. A set of folder and organization names of the form + `folders/{folderId}` or `organizations/{organizationId}`, specifying + that usage from only this set of folders and organizations should be + included in the budget. If omitted, the budget includes all usage + that the billing account pays for. If the folder or organization + contains projects that are paid for by a different Cloud Billing + account, the budget *doesn't* apply to those projects. + type: array + items: + type: string + creditTypes: description: >- - Output only. Resource name of the budget. The resource name implies - the scope of a budget. Values are of the form - `billingAccounts/{billingAccountId}/budgets/{budgetId}`. - readOnly: true + Optional. If Filter.credit_types_treatment is + INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be + subtracted from gross cost to determine the spend for threshold + calculations. See [a list of acceptable credit type + values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type). + If Filter.credit_types_treatment is **not** + INCLUDE_SPECIFIED_CREDITS, this field must be empty. + type: array + items: + type: string + creditTypesTreatment: + description: Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`. type: string - thresholdRules: + enumDescriptions: + - '' + - >- + All types of credit are subtracted from the gross cost to + determine the spend for threshold calculations. + - >- + All types of credit are added to the net cost to determine the + spend for threshold calculations. + - >- + [Credit + types](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type) + specified in the credit_types field are subtracted from the gross + cost to determine the spend for threshold calculations. + enum: + - CREDIT_TYPES_TREATMENT_UNSPECIFIED + - INCLUDE_ALL_CREDITS + - EXCLUDE_ALL_CREDITS + - INCLUDE_SPECIFIED_CREDITS + services: + description: >- + Optional. A set of services of the form `services/{service_id}`, + specifying that usage from only this set of services should be + included in the budget. If omitted, the report includes usage for + all the services. The service names are available through the + Catalog API: + https://cloud.google.com/billing/v1/how-tos/catalog-api. type: array items: - $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1ThresholdRule' + type: string + subaccounts: description: >- - Optional. Rules that trigger alerts (notifications of thresholds - being crossed) when spend exceeds the specified percentages of the - budget. Optional for `pubsubTopic` notifications. Required if using - email notifications. - budgetFilter: - $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1Filter' + Optional. A set of subaccounts of the form + `billingAccounts/{account_id}`, specifying that usage from only this + set of subaccounts should be included in the budget. If a subaccount + is set to the name of the parent account, usage from the parent + account is included. If the field is omitted, the report includes + usage from the parent account and all subaccounts, if they exist. + type: array + items: + type: string + labels: description: >- - Optional. Filters that define which resources are used to compute - the actual spend against the budget amount, such as projects, - services, and the budget's time period, as well as other filters. - GoogleCloudBillingBudgetsV1BudgetAmount: - properties: - lastPeriodAmount: - $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1LastPeriodAmount' + Optional. A single label and value pair specifying that usage from + only this set of labeled resources should be included in the budget. + If omitted, the report includes all labeled and unlabeled usage. An + object containing a single `"key": value` pair. Example: `{ "name": + "wrench" }`. _Currently, multiple entries or multiple values per + entry are not allowed._ + type: object + additionalProperties: + type: array + items: + type: any + calendarPeriod: description: >- - Use the last period's actual spend as the budget for the present - period. LastPeriodAmount can only be set when the budget's time - period is a Filter.calendar_period. It cannot be set in combination - with Filter.custom_period. - specifiedAmount: - $ref: '#/components/schemas/GoogleTypeMoney' + Optional. Specifies to track usage for recurring calendar period. + For example, assume that CalendarPeriod.QUARTER is set. The budget + tracks usage from April 1 to June 30, when the current calendar + month is April, May, June. After that, it tracks usage from July 1 + to September 30 when the current calendar month is July, August, + September, so on. + type: string + enumDescriptions: + - >- + Calendar period is unset. This is the default if the budget is for + a custom time period (CustomPeriod). + - >- + A month. Month starts on the first day of each month, such as + January 1, February 1, March 1, and so on. + - >- + A quarter. Quarters start on dates January 1, April 1, July 1, and + October 1 of each year. + - A year. Year starts on January 1. + enum: + - CALENDAR_PERIOD_UNSPECIFIED + - MONTH + - QUARTER + - YEAR + customPeriod: description: >- - A specified amount to use as the budget. `currency_code` is - optional. If specified when creating a budget, it must match the - currency of the billing account. If specified when updating a - budget, it must match the currency_code of the existing budget. The - `currency_code` is provided on output. - description: The budgeted amount for each usage period. - id: GoogleCloudBillingBudgetsV1BudgetAmount + Optional. Specifies to track usage from any start date (required) to + any end date (optional). This time period is static, it does not + recur. + $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1CustomPeriod' + GoogleCloudBillingBudgetsV1CustomPeriod: + id: GoogleCloudBillingBudgetsV1CustomPeriod + description: All date times begin at 12 AM US and Canadian Pacific Time (UTC-8). type: object - GoogleProtobufEmpty: - properties: {} + properties: + startDate: + description: Required. The start date must be after January 1, 2017. + $ref: '#/components/schemas/GoogleTypeDate' + endDate: + description: >- + Optional. The end date of the time period. Budgets with elapsed end + date won't be processed. If unset, specifies to track all usage + incurred since the start_date. + $ref: '#/components/schemas/GoogleTypeDate' + GoogleTypeDate: + id: GoogleTypeDate description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + Represents a whole or partial calendar date, such as a birthday. The + time of day and time zone are either specified elsewhere or are + insignificant. The date is relative to the Gregorian Calendar. This can + represent one of the following: * A full date, with non-zero year, + month, and day values. * A month and day, with a zero year (for example, + an anniversary). * A year on its own, with a zero month and a zero day. + * A year and month, with a zero day (for example, a credit card + expiration date). Related types: * google.type.TimeOfDay * + google.type.DateTime * google.protobuf.Timestamp type: object - id: GoogleProtobufEmpty - GoogleTypeMoney: properties: - units: + year: description: >- - The whole units of the amount. For example if `currencyCode` is - `"USD"`, then 1 unit is one US dollar. - type: string - format: int64 - currencyCode: - type: string - description: The three-letter currency code defined in ISO 4217. - nanos: + Year of the date. Must be from 1 to 9999, or 0 to specify a date + without a year. type: integer format: int32 - description: >- - Number of nano (10^-9) units of the amount. The value must be - between -999,999,999 and +999,999,999 inclusive. If `units` is - positive, `nanos` must be positive or zero. If `units` is zero, - `nanos` can be positive, zero, or negative. If `units` is negative, - `nanos` must be negative or zero. For example $-1.75 is represented - as `units`=-1 and `nanos`=-750,000,000. - type: object - description: Represents an amount of money with its currency type. - id: GoogleTypeMoney - GoogleCloudBillingBudgetsV1NotificationsRule: - description: >- - NotificationsRule defines notifications that are sent based on budget - spend and thresholds. - type: object - properties: - schemaVersion: - type: string - description: >- - Optional. Required when NotificationsRule.pubsub_topic is set. The - schema version of the notification sent to - NotificationsRule.pubsub_topic. Only "1.0" is accepted. It - represents the JSON schema as defined in - https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format. - disableDefaultIamRecipients: - description: >- - Optional. When set to true, disables default notifications sent when - a threshold is exceeded. Default notifications are sent to those - with Billing Account Administrator and Billing Account User IAM - roles for the target account. - type: boolean - monitoringNotificationChannels: - description: >- - Optional. Email targets to send notifications to when a threshold is - exceeded. This is in addition to the `DefaultIamRecipients` who - receive alert emails based on their billing account IAM role. The - value is the full REST resource name of a Cloud Monitoring email - notification channel with the form - `projects/{project_id}/notificationChannels/{channel_id}`. A maximum - of 5 email notifications are allowed. To customize budget alert - email recipients with monitoring notification channels, you _must - create the monitoring notification channels before you link them to - a budget_. For guidance on setting up notification channels to use - with budgets, see [Customize budget alert email - recipients](https://cloud.google.com/billing/docs/how-to/budgets-notification-recipients). - For Cloud Billing budget alerts, you _must use email notification - channels_. The other types of notification channels are _not_ - supported, such as Slack, SMS, or PagerDuty. If you want to [send - budget notifications to - Slack](https://cloud.google.com/billing/docs/how-to/notify#send_notifications_to_slack), - use a pubsubTopic and configure [programmatic - notifications](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications). - type: array - items: - type: string - enableProjectLevelRecipients: - description: >- - Optional. When set to true, and when the budget has a single project - configured, notifications will be sent to project level recipients - of that project. This field will be ignored if the budget has - multiple or no project configured. Currently, project level - recipients are the users with `Owner` role on a cloud project. - type: boolean - pubsubTopic: - description: >- - Optional. The name of the Pub/Sub topic where budget-related - messages are published, in the form - `projects/{project_id}/topics/{topic_id}`. Updates are sent to the - topic at regular intervals; the timing of the updates is not - dependent on the [threshold rules](#thresholdrule) you've set. Note - that if you want your [Pub/Sub JSON - object](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format) - to contain data for `alertThresholdExceeded`, you need at least one - [alert threshold rule](#thresholdrule). When you set threshold - rules, you must also enable at least one of the email notification - options, either using the default IAM recipients or Cloud Monitoring - email notification channels. To use Pub/Sub topics with budgets, you - must do the following: 1. Create the Pub/Sub topic before connecting - it to your budget. For guidance, see [Manage programmatic budget - alert - notifications](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications). - 2. Grant the API caller the `pubsub.topics.setIamPolicy` permission - on the Pub/Sub topic. If not set, the API call fails with - PERMISSION_DENIED. For additional details on Pub/Sub roles and - permissions, see [Permissions required for this - task](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#permissions_required_for_this_task). - type: string - id: GoogleCloudBillingBudgetsV1NotificationsRule - GoogleCloudBillingBudgetsV1ListBudgetsResponse: - description: Response for ListBudgets - id: GoogleCloudBillingBudgetsV1ListBudgetsResponse - properties: - nextPageToken: - description: >- - If not empty, indicates that there may be more budgets that match - the request; this value should be passed in a new - `ListBudgetsRequest`. - type: string - budgets: - description: List of the budgets owned by the requested billing account. - items: - $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1Budget' - type: array - type: object - GoogleTypeDate: - type: object - id: GoogleTypeDate - properties: - month: + month: description: >- Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. - format: int32 type: integer + format: int32 day: description: >- Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. - format: int32 type: integer - year: format: int32 - type: integer + GoogleCloudBillingBudgetsV1BudgetAmount: + id: GoogleCloudBillingBudgetsV1BudgetAmount + description: The budgeted amount for each usage period. + type: object + properties: + specifiedAmount: description: >- - Year of the date. Must be from 1 to 9999, or 0 to specify a date - without a year. - description: >- - Represents a whole or partial calendar date, such as a birthday. The - time of day and time zone are either specified elsewhere or are - insignificant. The date is relative to the Gregorian Calendar. This can - represent one of the following: * A full date, with non-zero year, - month, and day values. * A month and day, with a zero year (for example, - an anniversary). * A year on its own, with a zero month and a zero day. - * A year and month, with a zero day (for example, a credit card - expiration date). Related types: * google.type.TimeOfDay * - google.type.DateTime * google.protobuf.Timestamp - GoogleCloudBillingBudgetsV1CustomPeriod: + A specified amount to use as the budget. `currency_code` is + optional. If specified when creating a budget, it must match the + currency of the billing account. If specified when updating a + budget, it must match the currency_code of the existing budget. The + `currency_code` is provided on output. + $ref: '#/components/schemas/GoogleTypeMoney' + lastPeriodAmount: + description: >- + Use the last period's actual spend as the budget for the present + period. LastPeriodAmount can only be set when the budget's time + period is a Filter.calendar_period. It cannot be set in combination + with Filter.custom_period. + $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1LastPeriodAmount' + GoogleTypeMoney: + id: GoogleTypeMoney + description: Represents an amount of money with its currency type. type: object - description: All date times begin at 12 AM US and Canadian Pacific Time (UTC-8). - id: GoogleCloudBillingBudgetsV1CustomPeriod properties: - endDate: - $ref: '#/components/schemas/GoogleTypeDate' + currencyCode: + description: The three-letter currency code defined in ISO 4217. + type: string + units: description: >- - Optional. The end date of the time period. Budgets with elapsed end - date won't be processed. If unset, specifies to track all usage - incurred since the start_date. - startDate: - $ref: '#/components/schemas/GoogleTypeDate' - description: Required. The start date must be after January 1, 2017. + The whole units of the amount. For example if `currencyCode` is + `"USD"`, then 1 unit is one US dollar. + type: string + format: int64 + nanos: + description: >- + Number of nano (10^-9) units of the amount. The value must be + between -999,999,999 and +999,999,999 inclusive. If `units` is + positive, `nanos` must be positive or zero. If `units` is zero, + `nanos` can be positive, zero, or negative. If `units` is negative, + `nanos` must be negative or zero. For example $-1.75 is represented + as `units`=-1 and `nanos`=-750,000,000. + type: integer + format: int32 + GoogleCloudBillingBudgetsV1LastPeriodAmount: + id: GoogleCloudBillingBudgetsV1LastPeriodAmount + description: >- + Describes a budget amount targeted to the last Filter.calendar_period + spend. At this time, the amount is automatically 100% of the last + calendar period's spend; that is, there are no other options yet. + LastPeriodAmount cannot be set for a budget configured with a + Filter.custom_period. + type: object + properties: {} GoogleCloudBillingBudgetsV1ThresholdRule: id: GoogleCloudBillingBudgetsV1ThresholdRule description: >- @@ -314,8 +347,19 @@ components: your JSON data object to include data about the thresholds you set. For more information, see [set budget threshold rules and actions](https://cloud.google.com/billing/docs/how-to/budgets#budget-actions). + type: object properties: + thresholdPercent: + description: >- + Required. Send an alert when this threshold is exceeded. This is a + 1.0-based percentage, so 0.5 = 50%. Validation: non-negative number. + type: number + format: double spendBasis: + description: >- + Optional. The type of basis used to determine if spend has passed + the threshold. Behavior defaults to CURRENT_SPEND if not set. + type: string enumDescriptions: - Unspecified threshold basis. - >- @@ -326,186 +370,140 @@ components: against the threshold. FORECASTED_SPEND can only be set when the budget's time period is a Filter.calendar_period. It cannot be set in combination with Filter.custom_period. - type: string enum: - BASIS_UNSPECIFIED - CURRENT_SPEND - FORECASTED_SPEND - description: >- - Optional. The type of basis used to determine if spend has passed - the threshold. Behavior defaults to CURRENT_SPEND if not set. - thresholdPercent: - description: >- - Required. Send an alert when this threshold is exceeded. This is a - 1.0-based percentage, so 0.5 = 50%. Validation: non-negative number. - type: number - format: double - type: object - GoogleCloudBillingBudgetsV1LastPeriodAmount: - properties: {} + GoogleCloudBillingBudgetsV1NotificationsRule: + id: GoogleCloudBillingBudgetsV1NotificationsRule description: >- - Describes a budget amount targeted to the last Filter.calendar_period - spend. At this time, the amount is automatically 100% of the last - calendar period's spend; that is, there are no other options yet. - LastPeriodAmount cannot be set for a budget configured with a - Filter.custom_period. - id: GoogleCloudBillingBudgetsV1LastPeriodAmount - type: object - GoogleCloudBillingBudgetsV1Filter: - id: GoogleCloudBillingBudgetsV1Filter - description: A filter for a budget, limiting the scope of the cost to calculate. + NotificationsRule defines notifications that are sent based on budget + spend and thresholds. type: object properties: - creditTypesTreatment: - enum: - - CREDIT_TYPES_TREATMENT_UNSPECIFIED - - INCLUDE_ALL_CREDITS - - EXCLUDE_ALL_CREDITS - - INCLUDE_SPECIFIED_CREDITS - type: string - enumDescriptions: - - '' - - >- - All types of credit are subtracted from the gross cost to - determine the spend for threshold calculations. - - >- - All types of credit are added to the net cost to determine the - spend for threshold calculations. - - >- - [Credit - types](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type) - specified in the credit_types field are subtracted from the gross - cost to determine the spend for threshold calculations. - description: Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`. - subaccounts: - type: array - items: - type: string - description: >- - Optional. A set of subaccounts of the form - `billingAccounts/{account_id}`, specifying that usage from only this - set of subaccounts should be included in the budget. If a subaccount - is set to the name of the parent account, usage from the parent - account is included. If the field is omitted, the report includes - usage from the parent account and all subaccounts, if they exist. - resourceAncestors: - items: - type: string - type: array - description: >- - Optional. A set of folder and organization names of the form - `folders/{folderId}` or `organizations/{organizationId}`, specifying - that usage from only this set of folders and organizations should be - included in the budget. If omitted, the budget includes all usage - that the billing account pays for. If the folder or organization - contains projects that are paid for by a different Cloud Billing - account, the budget *doesn't* apply to those projects. - projects: - type: array - items: - type: string - description: >- - Optional. A set of projects of the form `projects/{project}`, - specifying that usage from only this set of projects should be - included in the budget. If omitted, the report includes all usage - for the billing account, regardless of which project the usage - occurred on. - services: - items: - type: string - description: >- - Optional. A set of services of the form `services/{service_id}`, - specifying that usage from only this set of services should be - included in the budget. If omitted, the report includes usage for - all the services. The service names are available through the - Catalog API: - https://cloud.google.com/billing/v1/how-tos/catalog-api. - type: array - customPeriod: - $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1CustomPeriod' + pubsubTopic: description: >- - Optional. Specifies to track usage from any start date (required) to - any end date (optional). This time period is static, it does not - recur. - calendarPeriod: - enum: - - CALENDAR_PERIOD_UNSPECIFIED - - MONTH - - QUARTER - - YEAR + Optional. The name of the Pub/Sub topic where budget-related + messages are published, in the form + `projects/{project_id}/topics/{topic_id}`. Updates are sent to the + topic at regular intervals; the timing of the updates is not + dependent on the [threshold rules](#thresholdrule) you've set. Note + that if you want your [Pub/Sub JSON + object](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format) + to contain data for `alertThresholdExceeded`, you need at least one + [alert threshold rule](#thresholdrule). When you set threshold + rules, you must also enable at least one of the email notification + options, either using the default IAM recipients or Cloud Monitoring + email notification channels. To use Pub/Sub topics with budgets, you + must do the following: 1. Create the Pub/Sub topic before connecting + it to your budget. For guidance, see [Manage programmatic budget + alert + notifications](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications). + 2. Grant the API caller the `pubsub.topics.setIamPolicy` permission + on the Pub/Sub topic. If not set, the API call fails with + PERMISSION_DENIED. For additional details on Pub/Sub roles and + permissions, see [Permissions required for this + task](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#permissions_required_for_this_task). type: string - enumDescriptions: - - >- - Calendar period is unset. This is the default if the budget is for - a custom time period (CustomPeriod). - - >- - A month. Month starts on the first day of each month, such as - January 1, February 1, March 1, and so on. - - >- - A quarter. Quarters start on dates January 1, April 1, July 1, and - October 1 of each year. - - A year. Year starts on January 1. + schemaVersion: description: >- - Optional. Specifies to track usage for recurring calendar period. - For example, assume that CalendarPeriod.QUARTER is set. The budget - tracks usage from April 1 to June 30, when the current calendar - month is April, May, June. After that, it tracks usage from July 1 - to September 30 when the current calendar month is July, August, - September, so on. - labels: - additionalProperties: - items: - type: any - type: array - type: object + Optional. Required when NotificationsRule.pubsub_topic is set. The + schema version of the notification sent to + NotificationsRule.pubsub_topic. Only "1.0" is accepted. It + represents the JSON schema as defined in + https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format. + type: string + monitoringNotificationChannels: description: >- - Optional. A single label and value pair specifying that usage from - only this set of labeled resources should be included in the budget. - If omitted, the report includes all labeled and unlabeled usage. An - object containing a single `"key": value` pair. Example: `{ "name": - "wrench" }`. _Currently, multiple entries or multiple values per - entry are not allowed._ - creditTypes: + Optional. Email targets to send notifications to when a threshold is + exceeded. This is in addition to the `DefaultIamRecipients` who + receive alert emails based on their billing account IAM role. The + value is the full REST resource name of a Cloud Monitoring email + notification channel with the form + `projects/{project_id}/notificationChannels/{channel_id}`. A maximum + of 5 email notifications are allowed. To customize budget alert + email recipients with monitoring notification channels, you _must + create the monitoring notification channels before you link them to + a budget_. For guidance on setting up notification channels to use + with budgets, see [Customize budget alert email + recipients](https://cloud.google.com/billing/docs/how-to/budgets-notification-recipients). + For Cloud Billing budget alerts, you _must use email notification + channels_. The other types of notification channels are _not_ + supported, such as Slack, SMS, or PagerDuty. If you want to [send + budget notifications to + Slack](https://cloud.google.com/billing/docs/how-to/notify#send_notifications_to_slack), + use a pubsubTopic and configure [programmatic + notifications](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications). + type: array items: type: string + disableDefaultIamRecipients: + description: >- + Optional. When set to true, disables default notifications sent when + a threshold is exceeded. Default notifications are sent to those + with Billing Account Administrator and Billing Account User IAM + roles for the target account. + type: boolean + enableProjectLevelRecipients: + description: >- + Optional. When set to true, and when the budget has a single project + configured, notifications will be sent to project level recipients + of that project. This field will be ignored if the budget has + multiple or no project configured. Currently, project level + recipients are the users with `Owner` role on a cloud project. + type: boolean + GoogleCloudBillingBudgetsV1ListBudgetsResponse: + id: GoogleCloudBillingBudgetsV1ListBudgetsResponse + description: Response for ListBudgets + type: object + properties: + budgets: + description: List of the budgets owned by the requested billing account. type: array + items: + $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1Budget' + nextPageToken: description: >- - Optional. If Filter.credit_types_treatment is - INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be - subtracted from gross cost to determine the spend for threshold - calculations. See [a list of acceptable credit type - values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type). - If Filter.credit_types_treatment is **not** - INCLUDE_SPECIFIED_CREDITS, this field must be empty. + If not empty, indicates that there may be more budgets that match + the request; this value should be passed in a new + `ListBudgetsRequest`. + type: string + GoogleProtobufEmpty: + id: GoogleProtobufEmpty + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + type: object + properties: {} parameters: - _.xgafv: - description: V1 error format. + access_token: + description: OAuth access token. in: query - name: $.xgafv + name: access_token schema: type: string - enum: - - '1' - - '2' - 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. + alt: + description: Data format for response. in: query - name: quotaUser + name: alt schema: type: string - oauth_token: - description: OAuth 2.0 token for the current user. + enum: + - json + - media + - proto + callback: + description: JSONP in: query - name: oauth_token + name: callback schema: type: string - access_token: - description: OAuth access token. + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: access_token + name: fields schema: type: string key: @@ -517,26 +515,25 @@ components: 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 - alt: - description: Data format for response. - in: query - name: alt - schema: - type: string - enum: - - json - - media - - proto - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + 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: uploadType + name: quotaUser schema: type: string upload_protocol: @@ -545,38 +542,40 @@ components: name: upload_protocol schema: type: string - callback: - description: JSONP + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: callback + name: uploadType schema: type: string - fields: - description: Selector specifying which fields to include in a partial response. + _.xgafv: + description: V1 error format. in: query - name: fields + name: $.xgafv schema: type: string + enum: + - '1' + - '2' x-stackQL-resources: budgets: id: google.billingbudgets.budgets name: budgets title: Budgets methods: - delete: + create: operation: - $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1budgets~1{budgetsId}/delete + $ref: '#/paths/~1v1~1billingAccounts~1{billingAccountsId}~1budgets/post' response: mediaType: application/json openAPIDocKey: '200' - get: + list: operation: - $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1budgets~1{budgetsId}/get + $ref: '#/paths/~1v1~1billingAccounts~1{billingAccountsId}~1budgets/get' response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.budgets patch: operation: $ref: >- @@ -584,19 +583,20 @@ components: response: mediaType: application/json openAPIDocKey: '200' - create: + get: operation: - $ref: '#/paths/~1v1~1billingAccounts~1{billingAccountsId}~1budgets/post' + $ref: >- + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1budgets~1{budgetsId}/get response: mediaType: application/json openAPIDocKey: '200' - list: + delete: operation: - $ref: '#/paths/~1v1~1billingAccounts~1{billingAccountsId}~1budgets/get' + $ref: >- + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1budgets~1{budgetsId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.budgets sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/budgets/methods/get' @@ -609,22 +609,30 @@ components: delete: - $ref: '#/components/x-stackQL-resources/budgets/methods/delete' paths: - /v1/billingAccounts/{billingAccountsId}/budgets/{budgetsId}: + /v1/billingAccounts/{billingAccountsId}/budgets: parameters: &ref_1 - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - delete: - description: Deletes a budget. Returns successfully if already deleted. - operationId: billingbudgets.billingAccounts.budgets.delete + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' + post: + description: >- + Creates a new budget. See [Quotas and + limits](https://cloud.google.com/billing/quotas) for more information on + the limits of the number of budgets you can create. + operationId: billingbudgets.billingAccounts.budgets.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1Budget' security: - Oauth2: - https://www.googleapis.com/auth/cloud-billing @@ -640,25 +648,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1Budget' parameters: - in: path name: billingAccountsId required: true schema: type: string - - in: path - name: budgetsId - required: true - schema: - type: string get: description: >- - Returns a budget. WARNING: There are some fields exposed on the Google - Cloud Console that aren't available on this API. When reading from the - API, you will not see these fields in the return value, though they may - have been set in the Cloud Console. - operationId: billingbudgets.billingAccounts.budgets.get + Returns a list of budgets for a billing account. WARNING: There are some + fields exposed on the Google Cloud Console that aren't available on this + API. When reading from the API, you will not see these fields in the + return value, though they may have been set in the Cloud Console. + operationId: billingbudgets.billingAccounts.budgets.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-billing @@ -674,18 +677,29 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1Budget' + $ref: >- + #/components/schemas/GoogleCloudBillingBudgetsV1ListBudgetsResponse parameters: - in: path name: billingAccountsId required: true schema: type: string - - in: path - name: budgetsId - required: true + - in: query + name: scope + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string + /v1/billingAccounts/{billingAccountsId}/budgets/{budgetsId}: + parameters: *ref_1 patch: description: >- Updates a budget and returns the updated budget. WARNING: There are some @@ -730,19 +744,13 @@ paths: schema: type: string format: google-fieldmask - /v1/billingAccounts/{billingAccountsId}/budgets: - parameters: *ref_1 - post: + get: description: >- - Creates a new budget. See [Quotas and - limits](https://cloud.google.com/billing/quotas) for more information on - the limits of the number of budgets you can create. - operationId: billingbudgets.billingAccounts.budgets.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1Budget' + Returns a budget. WARNING: There are some fields exposed on the Google + Cloud Console that aren't available on this API. When reading from the + API, you will not see these fields in the return value, though they may + have been set in the Cloud Console. + operationId: billingbudgets.billingAccounts.budgets.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-billing @@ -765,13 +773,14 @@ paths: required: true schema: type: string - get: - description: >- - Returns a list of budgets for a billing account. WARNING: There are some - fields exposed on the Google Cloud Console that aren't available on this - API. When reading from the API, you will not see these fields in the - return value, though they may have been set in the Cloud Console. - operationId: billingbudgets.billingAccounts.budgets.list + - in: path + name: budgetsId + required: true + schema: + type: string + delete: + description: Deletes a budget. Returns successfully if already deleted. + operationId: billingbudgets.billingAccounts.budgets.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-billing @@ -787,24 +796,15 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudBillingBudgetsV1ListBudgetsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: billingAccountsId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: scope + - in: path + name: budgetsId + required: true schema: type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/binaryauthorization.yaml b/providers/src/googleapis.com/v00.00.00000/services/binaryauthorization.yaml index 81c13055..a8e6fe7e 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/binaryauthorization.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/binaryauthorization.yaml @@ -11,8 +11,8 @@ info: Kubernetes Engine (GKE), Anthos Service Mesh, Anthos Clusters, and Cloud Run. version: v1 - x-discovery-doc-revision: '20241025' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250731' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/binary-authorization/ servers: @@ -796,6 +796,14 @@ components: type: array items: type: string + customConstraints: + description: >- + Optional. A CEL expression for specifying custom constraints on the + provenance payload. This can be used when users want to specify + expectations on provenance fields that are not covered by the + general check. For example, users can use this field to require that + certain parameters should never be used during the build process. + type: string AttestationSource: id: AttestationSource description: Specifies the locations for fetching the provenance attestations. @@ -937,7 +945,12 @@ components: $ref: '#/components/schemas/AdmissionWhitelistPattern' clusterAdmissionRules: description: >- - Optional. Per-cluster admission rules. Cluster spec format: + Optional. A valid policy has only one of the following rule maps + non-empty, i.e. only one of `cluster_admission_rules`, + `kubernetes_namespace_admission_rules`, + `kubernetes_service_account_admission_rules`, or + `istio_service_identity_admission_rules` can be non-empty. + Per-cluster admission rules. Cluster spec format: `location.clusterId`. There can be at most one admission rule per cluster spec. A `location` is either a compute zone (e.g. us-central1-a) or a region (e.g. us-central1). For `clusterId` @@ -1660,10 +1673,10 @@ components: - '1' - '2' x-stackQL-resources: - policy: - id: google.binaryauthorization.policy - name: policy - title: Policy + policies: + id: google.binaryauthorization.policies + name: policies + title: Policies methods: get_policy: operation: @@ -1677,19 +1690,6 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/policy/methods/get_policy' - insert: [] - update: [] - replace: - - $ref: '#/components/x-stackQL-resources/policy/methods/update_policy' - delete: [] - policies: - id: google.binaryauthorization.policies - name: policies - title: Policies - methods: evaluate: operation: $ref: >- @@ -1737,12 +1737,14 @@ components: select: - $ref: '#/components/x-stackQL-resources/policies/methods/get' - $ref: '#/components/x-stackQL-resources/policies/methods/list' + - $ref: '#/components/x-stackQL-resources/policies/methods/get_policy' insert: - $ref: '#/components/x-stackQL-resources/policies/methods/create' update: [] replace: - $ref: >- #/components/x-stackQL-resources/policies/methods/replace_platform_policy + - $ref: '#/components/x-stackQL-resources/policies/methods/update_policy' delete: - $ref: '#/components/x-stackQL-resources/policies/methods/delete' attestors: diff --git a/providers/src/googleapis.com/v00.00.00000/services/blockchainnodeengine.yaml b/providers/src/googleapis.com/v00.00.00000/services/blockchainnodeengine.yaml index 0d38a4f1..8e1b58a7 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/blockchainnodeengine.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/blockchainnodeengine.yaml @@ -7,8 +7,8 @@ info: title: Blockchain Node Engine API description: '' version: v1 - x-discovery-doc-revision: '20241023' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250514' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/blockchain-node-engine servers: @@ -243,12 +243,9 @@ components: description: >- Optional. When true, the node is only accessible via Private Service Connect; no public endpoints are exposed. Otherwise, the node is - only accessible via public endpoints. Warning: Private Service - Connect enabled nodes may require a manual migration effort to - remain compatible with future versions of the product. If this - feature is enabled, you will be notified of these changes along with - any required action to avoid disruption. See - https://cloud.google.com/vpc/docs/private-service-connect. + only accessible via public endpoints. Warning: These nodes are + deprecated, please use public endpoints instead. + deprecated: true type: boolean EthereumDetails: id: EthereumDetails @@ -429,6 +426,7 @@ components: description: >- Immutable. When true, deploys a GCP-managed validator client alongside the beacon client. + deprecated: true type: boolean beaconFeeRecipient: description: >- @@ -815,6 +813,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: @@ -969,7 +971,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: blockchainnodeengine.projects.locations.operations.cancel requestBody: content: diff --git a/providers/src/googleapis.com/v00.00.00000/services/certificatemanager.yaml b/providers/src/googleapis.com/v00.00.00000/services/certificatemanager.yaml index 5e2fcc69..d6198440 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/certificatemanager.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/certificatemanager.yaml @@ -7,8 +7,8 @@ info: title: Certificate Manager API description: '' version: v1 - x-discovery-doc-revision: '20241010' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250813' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/certificate-manager servers: @@ -228,20 +228,33 @@ components: type: string enumDescriptions: - >- - Certificates with default scope are served from core Google data - centers. If unsure, choose this option. + Use the DEFAULT scope if you plan to use the certificate with + global external Application Load Balancer, global external proxy + Network Load Balancer, or any of the regional Google Cloud + services. - >- - Certificates with scope EDGE_CACHE are special-purposed - certificates, served from Edge Points of Presence. See - https://cloud.google.com/vpc/docs/edge-locations. + Use the EDGE_CACHE scope if you plan to use the certificate with + Media CDN. The certificates are served from Edge Points of + Presence. See https://cloud.google.com/vpc/docs/edge-locations. - >- - Certificates with ALL_REGIONS scope are served from all Google - Cloud regions. See + Use the ALL_REGIONS scope if you plan to use the certificate with + cross-region internal Application Load Balancer. The certificates + are served from all Google Cloud regions. See https://cloud.google.com/compute/docs/regions-zones. + - >- + Associated with certificates used as client certificates in + Backend mTLS. enum: - DEFAULT - EDGE_CACHE - ALL_REGIONS + - CLIENT_AUTH + usedBy: + description: Output only. The list of resources that use this Certificate. + readOnly: true + type: array + items: + $ref: '#/components/schemas/UsedBy' SelfManagedCertificate: id: SelfManagedCertificate description: >- @@ -419,6 +432,20 @@ components: be stable. For programmatic access use FailureReason enum. readOnly: true type: string + UsedBy: + id: UsedBy + description: Defines a resource that uses the certificate. + type: object + properties: + name: + description: >- + Output only. Full name of the resource + https://google.aip.dev/122#full-resource-names, e.g. + `//certificatemanager.googleapis.com/projects/*/locations/*/certificateMaps/*/certificateMapEntries/*` + or + `//compute.googleapis.com/projects/*/locations/*/targetHttpsProxies/*`. + readOnly: true + type: string ListCertificateMapsResponse: id: ListCertificateMapsResponse description: Response for the `ListCertificateMaps` method. @@ -1036,8 +1063,8 @@ components: description: >- Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have - Operation.error value with a google.rpc.Status.code of 1, - corresponding to `Code.CANCELLED`. + google.longrunning.Operation.error value with a + google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. type: boolean apiVersion: description: API version used to start the operation. @@ -1562,6 +1589,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: @@ -1716,7 +1747,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: certificatemanager.projects.locations.operations.cancel requestBody: content: diff --git a/providers/src/googleapis.com/v00.00.00000/services/cloudasset.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudasset.yaml index 7e028801..417a88ad 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudasset.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudasset.yaml @@ -9,8 +9,8 @@ info: The Cloud Asset API manages the history and inventory of Google Cloud resources. version: v1 - x-discovery-doc-revision: '20241025' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250822' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/asset-inventory/docs/quickstart servers: @@ -265,7 +265,7 @@ components: If the destination table already exists and this flag is `TRUE`, the table will be overwritten by the contents of assets snapshot. If the flag is `FALSE` or unset and the destination table already exists, - the export call returns an INVALID_ARGUMEMT error. + the export call returns an INVALID_ARGUMENT error. type: boolean partitionSpec: description: >- @@ -328,14 +328,14 @@ components: table. - >- The time when the snapshot is taken. If specified as partition - key, the result table(s) is partitoned by the additional timestamp - column, readTime. If [read_time] in ExportAssetsRequest is - specified, the readTime column's value will be the same as it. + key, the result table(s) is partitioned by the additional + timestamp column, readTime. If [read_time] in ExportAssetsRequest + is specified, the readTime column's value will be the same as it. Otherwise, its value will be the current time that is used to take the snapshot. - >- The time when the request is received and started to be processed. - If specified as partition key, the result table(s) is partitoned + If specified as partition key, the result table(s) is partitioned by the requestTime column, an additional timestamp column representing when the request was received. enum: @@ -467,6 +467,11 @@ components: type: array items: type: string + assetExceptions: + description: The exceptions of a resource. + type: array + items: + $ref: '#/components/schemas/AssetException' Resource: id: Resource description: A representation of a Google Cloud resource. @@ -1452,6 +1457,13 @@ components: use_explicit_dry_run_spec must bet set to True if any of the fields in the spec are set to non-default values. type: boolean + etag: + description: >- + Optional. An opaque identifier for the current version of the + `ServicePerimeter`. This identifier does not follow any specific + format. If an etag is not provided, the operation will be performed + as if a valid etag is provided. + type: string GoogleIdentityAccesscontextmanagerV1ServicePerimeterConfig: id: GoogleIdentityAccesscontextmanagerV1ServicePerimeterConfig description: >- @@ -1563,6 +1575,13 @@ components: Defines the conditions on the ApiOperation and request destination that cause this IngressPolicy to apply. $ref: '#/components/schemas/GoogleIdentityAccesscontextmanagerV1IngressTo' + title: + description: >- + Optional. Human-readable title for the ingress rule. The title must + be unique within the perimeter and can not exceed 100 characters. + Within the access policy, the combined length of all rule titles + must not exceed 240,000 characters. + type: string GoogleIdentityAccesscontextmanagerV1IngressFrom: id: GoogleIdentityAccesscontextmanagerV1IngressFrom description: >- @@ -1665,6 +1684,14 @@ components: type: array items: type: string + roles: + description: >- + IAM roles that represent the set of operations that the sources + specified in the corresponding IngressFrom are allowed to perform in + this ServicePerimeter. + type: array + items: + type: string GoogleIdentityAccesscontextmanagerV1ApiOperation: id: GoogleIdentityAccesscontextmanagerV1ApiOperation description: Identification for an API Operation. @@ -1732,6 +1759,13 @@ components: Defines the conditions on the ApiOperation and destination resources that cause this EgressPolicy to apply. $ref: '#/components/schemas/GoogleIdentityAccesscontextmanagerV1EgressTo' + title: + description: >- + Optional. Human-readable title for the egress rule. The title must + be unique within the perimeter and can not exceed 100 characters. + Within the access policy, the combined length of all rule titles + must not exceed 240,000 characters. + type: string GoogleIdentityAccesscontextmanagerV1EgressFrom: id: GoogleIdentityAccesscontextmanagerV1EgressFrom description: >- @@ -1820,6 +1854,13 @@ components: specified for `access_level`, then all EgressSources will be allowed. type: string + resource: + description: >- + A Google Cloud resource from the service perimeter that you want to + allow to access data outside the perimeter. This field supports only + projects. The project format is `projects/{project_number}`. You + can't use `*` in this field to allow all Google Cloud resources. + type: string GoogleIdentityAccesscontextmanagerV1EgressTo: id: GoogleIdentityAccesscontextmanagerV1EgressTo description: >- @@ -1864,6 +1905,14 @@ components: type: array items: type: string + roles: + description: >- + IAM roles that represent the set of operations that the sources + specified in the corresponding EgressFrom. are allowed to perform in + this ServicePerimeter. + type: array + items: + type: string Inventory: id: Inventory description: >- @@ -2285,6 +2334,23 @@ components: The unique identifier of the relationship type. Example: `INSTANCE_TO_INSTANCEGROUP` type: string + AssetException: + id: AssetException + description: An exception of an asset. + type: object + properties: + exceptionType: + description: The type of exception. + type: string + enumDescriptions: + - exception_type is not applicable for the current asset. + - The asset content is truncated. + enum: + - EXCEPTION_TYPE_UNSPECIFIED + - TRUNCATION + details: + description: The details of the exception. + type: string BatchGetAssetsHistoryResponse: id: BatchGetAssetsHistoryResponse description: Batch get assets history response. @@ -2979,7 +3045,7 @@ components: description: >- The [full resource name](https://cloud.google.com/asset-inventory/docs/resource-name-format) - of the ancestor from which an effective_tag is inherited, according + of the ancestor from which effective_tags are inherited, according to [tag inheritance](https://cloud.google.com/resource-manager/docs/tags/tags-overview#inheritance). type: string @@ -3062,7 +3128,7 @@ components: the form of projects/{PROJECT_NUMBER}. If an IAM policy is set on a resource (like VM instance, Cloud Storage bucket), the project field will indicate the project that contains the resource. If an IAM - policy is set on a folder or orgnization, this field will be empty. + policy is set on a folder or organization, this field will be empty. To search against the `project`: * specify the `scope` field as this project in your search request. type: string @@ -3146,8 +3212,8 @@ components: serviceAccountImpersonationAnalysis: description: >- The service account impersonation analysis if - AnalyzeIamPolicyRequest.analyze_service_account_impersonation is - enabled. + IamPolicyAnalysisQuery.Options.analyze_service_account_impersonation + is enabled. type: array items: $ref: '#/components/schemas/IamPolicyAnalysis' @@ -3773,7 +3839,7 @@ components: option. - >- The time when the request is received. If specified as partition - key, the result table(s) is partitoned by the RequestTime column, + key, the result table(s) is partitioned by the RequestTime column, an additional timestamp column representing when the request was received. enum: @@ -4210,16 +4276,16 @@ components: description: >- The consolidated organization policy for the analyzed resource. The consolidated organization policy is computed by merging and - evaluating AnalyzeOrgPoliciesResponse.policy_bundle. The evaluation - will respect the organization policy [hierarchy + evaluating policy_bundle. The evaluation will respect the + organization policy [hierarchy rules](https://cloud.google.com/resource-manager/docs/organization-policy/understanding-hierarchy). $ref: '#/components/schemas/AnalyzerOrgPolicy' policyBundle: description: >- The ordered list of all organization policies from the - AnalyzeOrgPoliciesResponse.OrgPolicyResult.consolidated_policy.attached_resource. - to the scope specified in the request. If the constraint is defined - with default policy, it will also appear in the list. + consolidated_policy.attached_resource. to the scope specified in the + request. If the constraint is defined with default policy, it will + also appear in the list. type: array items: $ref: '#/components/schemas/AnalyzerOrgPolicy' @@ -4548,9 +4614,9 @@ components: policyBundle: description: >- The ordered list of all organization policies from the - AnalyzeOrgPoliciesResponse.OrgPolicyResult.consolidated_policy.attached_resource. - to the scope specified in the request. If the constraint is defined - with default policy, it will also appear in the list. + consolidated_policy.attached_resource. to the scope specified in the + request. If the constraint is defined with default policy, it will + also appear in the list. type: array items: $ref: '#/components/schemas/AnalyzerOrgPolicy' @@ -4629,9 +4695,9 @@ components: policyBundle: description: >- The ordered list of all organization policies from the - AnalyzeOrgPoliciesResponse.OrgPolicyResult.consolidated_policy.attached_resource - to the scope specified in the request. If the constraint is defined - with default policy, it will also appear in the list. + consolidated_policy.attached_resource to the scope specified in the + request. If the constraint is defined with default policy, it will + also appear in the list. type: array items: $ref: '#/components/schemas/AnalyzerOrgPolicy' @@ -5103,10 +5169,10 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/saved_queries/methods/delete' - cloudasset: - id: google.cloudasset.cloudasset - name: cloudasset - title: Cloudasset + assets: + id: google.cloudasset.assets + name: assets + title: Assets methods: query_assets: operation: @@ -5126,16 +5192,24 @@ components: response: mediaType: application/json openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1v1~1{parentType}~1{parent}~1assets/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.assets sqlVerbs: - select: [] + select: + - $ref: '#/components/x-stackQL-resources/assets/methods/list' insert: [] update: [] replace: [] delete: [] - cloudasset_assets_history: - id: google.cloudasset.cloudasset_assets_history - name: cloudasset_assets_history - title: Cloudasset_assets_history + asset_history: + id: google.cloudasset.asset_history + name: asset_history + title: Asset_history methods: batch_get_assets_history: operation: @@ -5146,7 +5220,7 @@ components: sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/cloudasset_assets_history/methods/batch_get_assets_history + #/components/x-stackQL-resources/asset_history/methods/batch_get_assets_history insert: [] update: [] replace: [] @@ -5162,27 +5236,16 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: [] - assets: - id: google.cloudasset.assets - name: assets - title: Assets - methods: - list: + batch_get: operation: - $ref: '#/paths/~1v1~1{parentType}~1{parent}~1assets/get' + $ref: '#/paths/~1v1~1{scope}~1effectiveIamPolicies/get' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.assets sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/assets/methods/list' + - $ref: >- + #/components/x-stackQL-resources/cloudasset_iam_policies/methods/batch_get insert: [] update: [] replace: [] @@ -5212,25 +5275,6 @@ components: update: [] replace: [] delete: [] - effective_iam_policies: - id: google.cloudasset.effective_iam_policies - name: effective_iam_policies - title: Effective_iam_policies - methods: - batch_get: - operation: - $ref: '#/paths/~1v1~1{scope}~1effectiveIamPolicies/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/effective_iam_policies/methods/batch_get - insert: [] - update: [] - replace: [] - delete: [] paths: /v1/{name}: parameters: &ref_1 diff --git a/providers/src/googleapis.com/v00.00.00000/services/cloudbilling.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudbilling.yaml index 1f6cbe91..27c78bd9 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudbilling.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudbilling.yaml @@ -9,8 +9,8 @@ info: Allows developers to manage billing for their Google Cloud Platform projects programmatically. version: v1 - x-discovery-doc-revision: '20241018' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250815' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/billing/docs/apis servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/cloudbuild.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudbuild.yaml index 529728eb..94bfaec0 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudbuild.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudbuild.yaml @@ -7,8 +7,8 @@ info: title: Cloud Build API description: Creates and manages builds on Google Cloud Platform. version: v2 - x-discovery-doc-revision: '20241025' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250823' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/cloud-build/docs/ servers: @@ -34,640 +34,69 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - TestIamPermissionsResponse: - type: object - id: TestIamPermissionsResponse - properties: - permissions: - items: - type: string - description: >- - A subset of `TestPermissionsRequest.permissions` that the caller is - allowed. - type: array - description: Response message for `TestIamPermissions` method. - PipelineResult: - description: A value produced by a Pipeline. - type: object - id: PipelineResult - properties: - name: - readOnly: true - description: Output only. Name of the result. - type: string - value: - readOnly: true - description: Output only. Value of the result. - $ref: '#/components/schemas/ResultValue' - type: - type: string - enum: - - TYPE_UNSPECIFIED - - STRING - - ARRAY - - OBJECT - enumDescriptions: - - Default enum type; should not be used. - - Default - - Array type - - Object type - description: Output only. The type of data that the result holds. - readOnly: true - description: - readOnly: true - type: string - description: Output only. Description of the result. - CancelOperationRequest: - description: The request message for Operations.CancelOperation. - id: CancelOperationRequest - type: object - properties: {} - PipelineSpec: - type: object - description: PipelineSpec defines the desired state of Pipeline. - properties: - tasks: - items: - $ref: '#/components/schemas/PipelineTask' - description: List of Tasks that execute when this Pipeline is run. - type: array - workspaces: - description: >- - Workspaces declares a set of named workspaces that are expected to - be provided by a PipelineRun. - items: - $ref: '#/components/schemas/PipelineWorkspaceDeclaration' - type: array - results: - items: - $ref: '#/components/schemas/PipelineResult' - readOnly: true - type: array - description: >- - Optional. Output only. List of results written out by the pipeline's - containers - generatedYaml: - readOnly: true - type: string - description: >- - Output only. auto-generated yaml that is output only for display - purpose for workflows using pipeline_spec, used by UI/gcloud cli for - Workflows. - params: - type: array - description: List of parameters. - items: - $ref: '#/components/schemas/ParamSpec' - finallyTasks: - items: - $ref: '#/components/schemas/PipelineTask' - description: >- - List of Tasks that execute just before leaving the Pipeline i.e. - either after all Tasks are finished executing successfully or after - a failure which would result in ending the Pipeline. - type: array - id: PipelineSpec - ParamValue: - type: object - properties: - objectVal: - description: Optional. Value of the parameter if type is object. - additionalProperties: - type: string - type: object - arrayVal: - items: - type: string - description: Value of the parameter if type is array. - type: array - stringVal: - type: string - description: Value of the parameter if type is string. - type: - description: Type of parameter. - type: string - enum: - - TYPE_UNSPECIFIED - - STRING - - ARRAY - - OBJECT - enumDescriptions: - - Default enum type; should not be used. - - Default - - Array type - - Object type - description: Parameter value. - id: ParamValue - GoogleDevtoolsCloudbuildV2GitHubEnterpriseConfig: - properties: - apiKey: - type: string - description: Required. API Key used for authentication of webhook events. - appInstallationId: - type: string - format: int64 - description: Optional. ID of the installation of the GitHub App. - serviceDirectoryConfig: - description: >- - Optional. Configuration for using Service Directory to privately - connect to a GitHub Enterprise server. This should only be set if - the GitHub Enterprise server is hosted on-premises and not reachable - by public internet. If this field is left empty, calls to the GitHub - Enterprise server will be made over the public internet. - $ref: >- - #/components/schemas/GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig - appId: - type: string - format: int64 - description: Optional. Id of the GitHub App created from the manifest. - webhookSecretSecretVersion: - description: >- - Optional. SecretManager resource containing the webhook secret of - the GitHub App, formatted as `projects/*/secrets/*/versions/*`. - type: string - serverVersion: - readOnly: true - description: Output only. GitHub Enterprise version installed at the host_uri. - type: string - privateKeySecretVersion: - type: string - description: >- - Optional. SecretManager resource containing the private key of the - GitHub App, formatted as `projects/*/secrets/*/versions/*`. - appSlug: - type: string - description: Optional. The URL-friendly name of the GitHub App. - sslCa: - type: string - description: Optional. SSL certificate to use for requests to GitHub Enterprise. - hostUri: - description: >- - Required. The URI of the GitHub Enterprise host this connection is - for. - type: string - description: Configuration for connections to an instance of GitHub Enterprise. - id: GoogleDevtoolsCloudbuildV2GitHubEnterpriseConfig - type: object - WorkspaceBinding: - id: WorkspaceBinding - description: >- - WorkspaceBinding maps a workspace to a Volume. PipelineRef can be used - to refer to a specific instance of a Pipeline. - properties: - secret: - $ref: '#/components/schemas/SecretVolumeSource' - description: Secret Volume Source. - subPath: - type: string - description: >- - Optional. SubPath is optionally a directory on the volume which - should be used for this binding (i.e. the volume will be mounted at - this sub directory). +optional - name: - type: string - description: Name of the workspace. - type: object - BitbucketCloudConfig: - description: Configuration for connections to Bitbucket Cloud. - type: object - id: BitbucketCloudConfig - properties: - authorizerCredential: - description: >- - Required. An access token with the `webhook`, `repository`, - `repository:admin` and `pullrequest` scope access. It can be either - a workspace, project or repository access token. It's recommended to - use a system account to generate these credentials. - $ref: '#/components/schemas/UserCredential' - workspace: - type: string - description: >- - Required. The Bitbucket Cloud Workspace ID to be connected to Google - Cloud Platform. - readAuthorizerCredential: - $ref: '#/components/schemas/UserCredential' - description: >- - Required. An access token with the `repository` access. It can be - either a workspace, project or repository access token. It's - recommended to use a system account to generate the credentials. - webhookSecretSecretVersion: - description: >- - Required. SecretManager resource containing the webhook secret used - to verify webhook events, formatted as - `projects/*/secrets/*/versions/*`. - type: string - TaskRef: - description: >- - TaskRef can be used to refer to a specific instance of a task. - PipelineRef can be used to refer to a specific instance of a Pipeline. - properties: - params: - type: array - items: - $ref: '#/components/schemas/Param' - description: >- - Params contains the parameters used to identify the referenced - Tekton resource. Example entries might include "repo" or "path" but - the set of params ultimately depends on the chosen resolver. - resolver: - enum: - - RESOLVER_NAME_UNSPECIFIED - - BUNDLES - - GCB_REPO - - GIT - - DEVELOPER_CONNECT - - DEFAULT - enumDescriptions: - - Default enum type; should not be used. - - >- - Bundles resolver. - https://tekton.dev/docs/pipelines/bundle-resolver/ - - GCB repo resolver. - - >- - Simple Git resolver. - https://tekton.dev/docs/pipelines/git-resolver/ - - Developer Connect resolver. - - Default resolver. - description: >- - Resolver is the name of the resolver that should perform resolution - of the referenced Tekton resource. - type: string - name: - type: string - description: Optional. Name of the task. - id: TaskRef - type: object - FetchReadWriteTokenRequest: - id: FetchReadWriteTokenRequest - description: Message for fetching SCM read/write token. - properties: {} - type: object - BatchCreateRepositoriesResponse: - description: Message for response of creating repositories in batch. - type: object - properties: - repositories: - items: - $ref: '#/components/schemas/Repository' - description: Repository resources created. - type: array - id: BatchCreateRepositoriesResponse - TestIamPermissionsRequest: - properties: - permissions: - description: >- - The set of permissions to check for the `resource`. Permissions with - wildcards (such as `*` or `storage.*`) are not allowed. For more - information see [IAM - Overview](https://cloud.google.com/iam/docs/overview#permissions). - type: array - items: - type: string - description: Request message for `TestIamPermissions` method. - type: object - id: TestIamPermissionsRequest - Connection: - id: Connection - properties: - reconciling: - description: >- - Output only. Set to true when the connection is being set up or - updated in the background. - readOnly: true - type: boolean - annotations: - type: object - additionalProperties: - type: string - description: Optional. Allows clients to store small amounts of arbitrary data. - bitbucketDataCenterConfig: - description: Configuration for connections to Bitbucket Data Center. - $ref: '#/components/schemas/BitbucketDataCenterConfig' - gitlabConfig: - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV2GitLabConfig' - description: >- - Configuration for connections to gitlab.com or an instance of GitLab - Enterprise. - bitbucketCloudConfig: - description: Configuration for connections to Bitbucket Cloud. - $ref: '#/components/schemas/BitbucketCloudConfig' - updateTime: - readOnly: true - type: string - format: google-datetime - description: >- - Output only. Server assigned timestamp for when the connection was - updated. - githubConfig: - $ref: '#/components/schemas/GitHubConfig' - description: Configuration for connections to github.com. - githubEnterpriseConfig: - $ref: >- - #/components/schemas/GoogleDevtoolsCloudbuildV2GitHubEnterpriseConfig - description: Configuration for connections to an instance of GitHub Enterprise. - createTime: - description: >- - Output only. Server assigned timestamp for when the connection was - created. - readOnly: true - type: string - format: google-datetime - name: - description: >- - Immutable. The resource name of the connection, in the format - `projects/{project}/locations/{location}/connections/{connection_id}`. - type: string - disabled: - type: boolean - description: >- - Optional. If disabled is set to true, functionality is disabled for - this connection. Repository based API methods and webhooks - processing for repositories in this connection will be disabled. - etag: - description: >- - This checksum is computed by the server based on the value of other - fields, and may be sent on update and delete requests to ensure the - client has an up-to-date value before proceeding. - type: string - installationState: - description: Output only. Installation state of the Connection. - readOnly: true - $ref: '#/components/schemas/InstallationState' - description: >- - A connection to a SCM like GitHub, GitHub Enterprise, Bitbucket Data - Center, Bitbucket Cloud or GitLab. - type: object - WorkspacePipelineTaskBinding: - description: >- - WorkspacePipelineTaskBinding maps workspaces from the PipelineSpec to - the workspaces declared in the Task. - id: WorkspacePipelineTaskBinding - properties: - name: - description: Name of the workspace as declared by the task. - type: string - subPath: - type: string - description: >- - Optional. SubPath is optionally a directory on the volume which - should be used for this binding (i.e. the volume will be mounted at - this sub directory). +optional - workspace: - description: Name of the workspace declared by the pipeline. - type: string - type: object - TaskResult: - type: object - properties: - type: - enumDescriptions: - - Default enum type; should not be used. - - Default - - Array type - - Object type - enum: - - TYPE_UNSPECIFIED - - STRING - - ARRAY - - OBJECT - description: The type of data that the result holds. - type: string - value: - description: >- - Optional. Optionally used to initialize a Task's result with a - Step's result. - $ref: '#/components/schemas/ParamValue' - properties: - type: object - additionalProperties: - $ref: '#/components/schemas/PropertySpec' - description: >- - When type is OBJECT, this map holds the names of fields inside that - object along with the type of data each field holds. - name: - description: Name of the result. - type: string - description: - type: string - description: Description of the result. - description: TaskResult is used to describe the results of a task. - id: TaskResult - Binding: + ListLocationsResponse: + id: ListLocationsResponse + description: The response message for Locations.ListLocations. + type: object properties: - members: + locations: + description: >- + A list of locations that matches the specified filter in the + request. type: array items: - type: string + $ref: '#/components/schemas/Location' + nextPageToken: + description: The standard List next-page token. + type: string + Location: + id: Location + description: A resource that represents a Google Cloud location. + type: object + properties: + name: description: >- - Specifies the principals requesting access for a Google Cloud - 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. Does not include identities - that come from external identity providers (IdPs) through identity - federation. * `user:{emailid}`: An email address that represents a - specific Google account. For example, `alice@example.com` . * - `serviceAccount:{emailid}`: An email address that represents a - Google service account. For example, - `my-other-app@appspot.gserviceaccount.com`. * - `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: - An identifier for a [Kubernetes service - account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). - For example, - `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * - `group:{emailid}`: An email address that represents a Google group. - For example, `admins@example.com`. * `domain:{domain}`: The G Suite - domain (primary) that represents all the users of that domain. For - example, `google.com` or `example.com`. * - `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workforce identity pool. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: - All workforce identities in a group. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All workforce identities with a specific attribute value. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: - All identities in a workforce identity pool. * - `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workload identity pool. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: - A workload identity pool group. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All identities in a workload identity pool with a certain attribute. - * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: - All identities in a workload identity pool. * - `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. * - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - Deleted single identity in a workforce identity pool. For example, - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. - role: + Resource name for the location, which may vary between + implementations. For example: + `"projects/example-project/locations/us-east1"` + type: string + locationId: + description: 'The canonical id for this location. For example: `"us-east1"`.' + type: string + displayName: description: >- - Role that is assigned to the list of `members`, or principals. For - example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an - overview of the IAM roles and permissions, see the [IAM - documentation](https://cloud.google.com/iam/docs/roles-overview). - For a list of the available pre-defined roles, see - [here](https://cloud.google.com/iam/docs/understanding-roles). + The friendly name for this location, typically a nearby city name. + For example, "Tokyo". type: string - condition: + labels: description: >- - The condition that is associated with this binding. If the condition - evaluates to `true`, then this binding applies to the current - request. If the condition evaluates to `false`, then this binding - does not apply to the current request. However, a different role - binding might grant the same role to one or more of the principals - in this binding. To learn which resources support conditions in - their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - $ref: '#/components/schemas/Expr' - type: object - description: Associates `members`, or principals, with a `role`. - id: Binding - EmbeddedTask: - id: EmbeddedTask - description: EmbeddedTask defines a Task that is embedded in a Pipeline. - type: object - properties: - taskSpec: - $ref: '#/components/schemas/TaskSpec' - description: Spec to instantiate this TaskRun. - annotations: + Cross-service attributes for the location. For example + {"cloud.googleapis.com/region": "us-east1"} type: object - description: User annotations. See https://google.aip.dev/128#annotations additionalProperties: type: string - StepTemplate: - id: StepTemplate - properties: - volumeMounts: - items: - $ref: '#/components/schemas/VolumeMount' - type: array - description: Optional. Pod volumes to mount into the container's filesystem. - env: - type: array + metadata: description: >- - Optional. List of environment variables to set in the Step. Cannot - be updated. - items: - $ref: '#/components/schemas/EnvVar' - type: object - description: >- - StepTemplate can be used as the basis for all step containers within the - Task, so that the steps inherit settings on the base container. - Policy: + Service-specific metadata. For example the available capacity at the + given location. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + Operation: + id: Operation description: >- - An Identity and Access Management (IAM) policy, which specifies access - controls for Google Cloud resources. A `Policy` is a collection of - `bindings`. A `binding` binds one or more `members`, or principals, to a - single `role`. Principals can be user accounts, service accounts, Google - groups, and domains (such as G Suite). A `role` is a named list of - permissions; each `role` can be an IAM predefined role or a user-created - custom role. For some types of Google Cloud resources, a `binding` can - also specify a `condition`, which is a logical expression that allows - access to a resource only if the expression evaluates to `true`. A - condition can add constraints based on attributes of the request, the - resource, or both. To learn which resources support conditions in their - IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - **JSON example:** ``` { "bindings": [ { "role": - "roles/resourcemanager.organizationAdmin", "members": [ - "user:mike@example.com", "group:admins@example.com", - "domain:google.com", - "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { - "role": "roles/resourcemanager.organizationViewer", "members": [ - "user:eve@example.com" ], "condition": { "title": "expirable access", - "description": "Does not grant access after Sep 2020", "expression": - "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": - "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - - members: - user:mike@example.com - group:admins@example.com - - domain:google.com - - serviceAccount:my-project-id@appspot.gserviceaccount.com role: - roles/resourcemanager.organizationAdmin - members: - - user:eve@example.com role: roles/resourcemanager.organizationViewer - condition: title: expirable access description: Does not grant access - after Sep 2020 expression: request.time < - timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` - For a description of IAM and its features, see the [IAM - documentation](https://cloud.google.com/iam/docs/). + This resource represents a long-running operation that is the result of + a network API call. + type: object properties: - version: - format: int32 - type: integer + name: 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). - etag: + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. type: string - format: byte - 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. - auditConfigs: - items: - $ref: '#/components/schemas/AuditConfig' - type: array - description: Specifies cloud audit logging configuration for this policy. - bindings: - description: >- - Associates a list of `members`, or principals, with a `role`. - Optionally, may specify a `condition` that determines how and when - the `bindings` are applied. Each of the `bindings` must contain at - least one principal. The `bindings` in a `Policy` can refer to up to - 1,500 principals; up to 250 of these principals can be Google - groups. Each occurrence of a principal counts towards these limits. - For example, if the `bindings` grant 50 different roles to - `user:alice@example.com`, and not to any other principal, then you - can add another 1,450 principals to the `bindings` in the `Policy`. - type: array - items: - $ref: '#/components/schemas/Binding' - id: Policy - type: object - Operation: - type: object - properties: metadata: description: >- Service-specific metadata associated with the operation. It @@ -675,10 +104,10 @@ components: create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. + type: object additionalProperties: - description: Properties of the object. Contains field @type with type URL. type: any - type: object + description: Properties of the object. Contains field @type with type URL. done: description: >- If the value is `false`, it means the operation is still in @@ -686,19 +115,11 @@ components: or `response` is available. type: boolean error: - $ref: '#/components/schemas/Status' description: >- The error result of the operation in case of failure or cancellation. - name: - type: string - description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. + $ref: '#/components/schemas/Status' response: - type: object description: >- The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is @@ -708,325 +129,483 @@ components: where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + type: object additionalProperties: type: any description: Properties of the object. Contains field @type with type URL. + Status: + id: Status description: >- - This resource represents a long-running operation that is the result of - a network API call. - id: Operation - PipelineRun: + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). type: object - id: PipelineRun - description: Message describing PipelineRun object properties: - results: - items: - $ref: '#/components/schemas/PipelineRunResult' - readOnly: true + code: + description: The status code, which should be an enum value of google.rpc.Code. + type: integer + format: int32 + message: + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + type: string + details: + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. type: array + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + CancelOperationRequest: + id: CancelOperationRequest + description: The request message for Operations.CancelOperation. + type: object + properties: {} + Empty: + id: Empty + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + type: object + properties: {} + Connection: + id: Connection + description: >- + A connection to a SCM like GitHub, GitHub Enterprise, Bitbucket Data + Center, Bitbucket Cloud or GitLab. + type: object + properties: + name: description: >- - Optional. Output only. List of results written out by the pipeline's - containers - workflow: + Immutable. The resource name of the connection, in the format + `projects/{project}/locations/{location}/connections/{connection_id}`. type: string - description: Output only. The Workflow used to create this PipelineRun. + createTime: + description: >- + Output only. Server assigned timestamp for when the connection was + created. readOnly: true - etag: type: string - description: Needed for declarative-friendly resources. - record: + format: google-datetime + updateTime: + description: >- + Output only. Server assigned timestamp for when the connection was + updated. + readOnly: true type: string + format: google-datetime + githubConfig: + description: Configuration for connections to github.com. + $ref: '#/components/schemas/GitHubConfig' + githubEnterpriseConfig: + description: Configuration for connections to an instance of GitHub Enterprise. + $ref: >- + #/components/schemas/GoogleDevtoolsCloudbuildV2GitHubEnterpriseConfig + gitlabConfig: description: >- - Output only. The `Record` of this `PipelineRun`. Format: - `projects/{project}/locations/{location}/results/{result_id}/records/{record_id}` + Configuration for connections to gitlab.com or an instance of GitLab + Enterprise. + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV2GitLabConfig' + bitbucketDataCenterConfig: + description: Configuration for connections to Bitbucket Data Center. + $ref: '#/components/schemas/BitbucketDataCenterConfig' + bitbucketCloudConfig: + description: Configuration for connections to Bitbucket Cloud. + $ref: '#/components/schemas/BitbucketCloudConfig' + installationState: + description: Output only. Installation state of the Connection. readOnly: true - name: + $ref: '#/components/schemas/InstallationState' + disabled: + description: >- + Optional. If disabled is set to true, functionality is disabled for + this connection. Repository based API methods and webhooks + processing for repositories in this connection will be disabled. + type: boolean + reconciling: + description: >- + Output only. Set to true when the connection is being set up or + updated in the background. readOnly: true + type: boolean + annotations: + description: Optional. Allows clients to store small amounts of arbitrary data. + type: object + additionalProperties: + type: string + etag: + description: >- + This checksum is computed by the server based on the value of other + fields, and may be sent on update and delete requests to ensure the + client has an up-to-date value before proceeding. type: string + GitHubConfig: + id: GitHubConfig + description: Configuration for connections to github.com. + type: object + properties: + authorizerCredential: description: >- - Output only. The `PipelineRun` name with format - `projects/{project}/locations/{location}/pipelineRuns/{pipeline_run}` - pipelineRunStatus: + Optional. OAuth credential of the account that authorized the Cloud + Build GitHub App. It is recommended to use a robot account instead + of a human user account. The OAuth token must be tied to the Cloud + Build GitHub App. + $ref: '#/components/schemas/OAuthCredential' + appInstallationId: + description: Optional. GitHub App installation id. type: string - enumDescriptions: - - Default enum type; should not be used. - - Cancelled status. - enum: - - PIPELINE_RUN_STATUS_UNSPECIFIED - - PIPELINE_RUN_CANCELLED - description: Pipelinerun status the user can provide. Used for cancellation. - pipelineSpec: - description: PipelineSpec defines the desired state of Pipeline. - $ref: '#/components/schemas/PipelineSpec' - workerPool: - description: Output only. The WorkerPool used to run this PipelineRun. + format: int64 + OAuthCredential: + id: OAuthCredential + description: >- + Represents an OAuth token of the account that authorized the Connection, + and associated metadata. + type: object + properties: + oauthTokenSecretVersion: + description: >- + Optional. A SecretManager resource containing the OAuth token that + authorizes the Cloud Build connection. Format: + `projects/*/secrets/*/versions/*`. + type: string + username: + description: Output only. The username associated to this token. readOnly: true type: string - pipelineSpecYaml: + GoogleDevtoolsCloudbuildV2GitHubEnterpriseConfig: + id: GoogleDevtoolsCloudbuildV2GitHubEnterpriseConfig + description: Configuration for connections to an instance of GitHub Enterprise. + type: object + properties: + hostUri: + description: >- + Required. The URI of the GitHub Enterprise host this connection is + for. type: string - readOnly: true + apiKey: + description: Required. API Key used for authentication of webhook events. + type: string + appId: + description: Optional. Id of the GitHub App created from the manifest. + type: string + format: int64 + appSlug: + description: Optional. The URL-friendly name of the GitHub App. + type: string + privateKeySecretVersion: description: >- - Output only. Inline pipelineSpec yaml string, used by workflow run - requests. - pipelineRef: - description: PipelineRef refer to a specific instance of a Pipeline. - $ref: '#/components/schemas/PipelineRef' - createTime: + Optional. SecretManager resource containing the private key of the + GitHub App, formatted as `projects/*/secrets/*/versions/*`. + type: string + webhookSecretSecretVersion: + description: >- + Optional. SecretManager resource containing the webhook secret of + the GitHub App, formatted as `projects/*/secrets/*/versions/*`. + type: string + appInstallationId: + description: Optional. ID of the installation of the GitHub App. + type: string + format: int64 + serviceDirectoryConfig: + description: >- + Optional. Configuration for using Service Directory to privately + connect to a GitHub Enterprise server. This should only be set if + the GitHub Enterprise server is hosted on-premises and not reachable + by public internet. If this field is left empty, calls to the GitHub + Enterprise server will be made over the public internet. + $ref: >- + #/components/schemas/GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig + sslCa: + description: Optional. SSL certificate to use for requests to GitHub Enterprise. type: string + serverVersion: + description: Output only. GitHub Enterprise version installed at the host_uri. readOnly: true - format: google-datetime + type: string + GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig: + id: GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig + description: >- + ServiceDirectoryConfig represents Service Directory configuration for a + connection. + type: object + properties: + service: + description: >- + Required. The Service Directory service name. Format: + projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. + type: string + GoogleDevtoolsCloudbuildV2GitLabConfig: + id: GoogleDevtoolsCloudbuildV2GitLabConfig + description: >- + Configuration for connections to gitlab.com or an instance of GitLab + Enterprise. + type: object + properties: + hostUri: description: >- - Output only. Time at which the request to create the `PipelineRun` - was received. - gcbParams: - description: Output only. GCB default params. - additionalProperties: - type: string - readOnly: true - type: object - uid: - readOnly: true - description: Output only. A unique identifier for the `PipelineRun`. + Optional. The URI of the GitLab Enterprise host this connection is + for. If not specified, the default value is https://gitlab.com. type: string - worker: - $ref: '#/components/schemas/Worker' - description: Optional. Worker configuration. - annotations: - description: User annotations. See https://google.aip.dev/128#annotations - type: object - additionalProperties: - type: string - finallyStartTime: + webhookSecretSecretVersion: description: >- - Output only. FinallyStartTime is when all non-finally tasks have - been completed and only finally tasks are being executed. +optional + Required. Immutable. SecretManager resource containing the webhook + secret of a GitLab Enterprise project, formatted as + `projects/*/secrets/*/versions/*`. type: string - readOnly: true - format: google-datetime - workspaces: - items: - $ref: '#/components/schemas/WorkspaceBinding' - type: array + readAuthorizerCredential: description: >- - Workspaces is a list of WorkspaceBindings from volumes to - workspaces. - timeouts: - $ref: '#/components/schemas/TimeoutFields' + Required. A GitLab personal access token with the minimum `read_api` + scope access. + $ref: '#/components/schemas/UserCredential' + authorizerCredential: description: >- - Time after which the Pipeline times out. Currently three keys are - accepted in the map pipeline, tasks and finally with - Timeouts.pipeline >= Timeouts.tasks + Timeouts.finally - skippedTasks: - items: - $ref: '#/components/schemas/SkippedTask' - type: array + Required. A GitLab personal access token with the `api` scope + access. + $ref: '#/components/schemas/UserCredential' + serviceDirectoryConfig: description: >- - Output only. List of tasks that were skipped due to when expressions - evaluating to false. - readOnly: true - params: - type: array - description: Params is a list of parameter names and values. - items: - $ref: '#/components/schemas/Param' - serviceAccount: + Optional. Configuration for using Service Directory to privately + connect to a GitLab Enterprise server. This should only be set if + the GitLab Enterprise server is hosted on-premises and not reachable + by public internet. If this field is left empty, calls to the GitLab + Enterprise server will be made over the public internet. + $ref: >- + #/components/schemas/GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig + sslCa: + description: Optional. SSL certificate to use for requests to GitLab Enterprise. type: string + serverVersion: description: >- - Service account used in the Pipeline. Deprecated; please use - security.service_account instead. - deprecated: true - conditions: - description: >- - Output only. Kubernetes Conditions convention for PipelineRun status - and error. - readOnly: true - type: array - items: - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV2Condition' - resolvedPipelineSpec: - readOnly: true - description: Output only. The exact PipelineSpec used to instantiate the run. - $ref: '#/components/schemas/PipelineSpec' - completionTime: - description: Output only. Time the pipeline completed. + Output only. Version of the GitLab Enterprise server running on the + `host_uri`. readOnly: true type: string - format: google-datetime - updateTime: - readOnly: true + UserCredential: + id: UserCredential + description: >- + Represents a personal access token that authorized the Connection, and + associated metadata. + type: object + properties: + userTokenSecretVersion: description: >- - Output only. Time at which the request to update the `PipelineRun` - was received. - format: google-datetime - type: string - security: - $ref: '#/components/schemas/Security' - description: Optional. Security configuration. - provenance: - description: Optional. Provenance configuration. - $ref: '#/components/schemas/Provenance' - startTime: - description: Output only. Time the pipeline is actually started. - format: google-datetime + Required. A SecretManager resource containing the user token that + authorizes the Cloud Build connection. Format: + `projects/*/secrets/*/versions/*`. type: string + username: + description: Output only. The username associated to this token. readOnly: true - childReferences: - description: >- - Output only. List of TaskRun and Run names and PipelineTask names - for children of this PipelineRun. - readOnly: true - items: - $ref: '#/components/schemas/ChildStatusReference' - type: array - FetchReadTokenRequest: - properties: {} - id: FetchReadTokenRequest + type: string + BitbucketDataCenterConfig: + id: BitbucketDataCenterConfig + description: Configuration for connections to Bitbucket Data Center. type: object - description: Message for fetching SCM read token. - GitHubConfig: - description: Configuration for connections to github.com. properties: + hostUri: + description: >- + Required. The URI of the Bitbucket Data Center instance or cluster + this connection is for. + type: string + webhookSecretSecretVersion: + description: >- + Required. Immutable. SecretManager resource containing the webhook + secret used to verify webhook events, formatted as + `projects/*/secrets/*/versions/*`. + type: string + readAuthorizerCredential: + description: Required. A http access token with the `REPO_READ` access. + $ref: '#/components/schemas/UserCredential' authorizerCredential: + description: Required. A http access token with the `REPO_ADMIN` scope access. + $ref: '#/components/schemas/UserCredential' + serviceDirectoryConfig: description: >- - Optional. OAuth credential of the account that authorized the Cloud - Build GitHub App. It is recommended to use a robot account instead - of a human user account. The OAuth token must be tied to the Cloud - Build GitHub App. - $ref: '#/components/schemas/OAuthCredential' - appInstallationId: - format: int64 + Optional. Configuration for using Service Directory to privately + connect to a Bitbucket Data Center. This should only be set if the + Bitbucket Data Center is hosted on-premises and not reachable by + public internet. If this field is left empty, calls to the Bitbucket + Data Center will be made over the public internet. + $ref: >- + #/components/schemas/GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig + sslCa: + description: >- + Optional. SSL certificate to use for requests to the Bitbucket Data + Center. type: string - description: Optional. GitHub App installation id. + serverVersion: + description: >- + Output only. Version of the Bitbucket Data Center running on the + `host_uri`. + readOnly: true + type: string + BitbucketCloudConfig: + id: BitbucketCloudConfig + description: Configuration for connections to Bitbucket Cloud. type: object - id: GitHubConfig - SkippedTask: - id: SkippedTask properties: - whenExpressions: - type: array + workspace: description: >- - WhenExpressions is the list of checks guarding the execution of the - PipelineTask - items: - $ref: '#/components/schemas/WhenExpression' - reason: - readOnly: true - description: Output only. Reason is the cause of the PipelineTask being skipped. + Required. The Bitbucket Cloud Workspace ID to be connected to Google + Cloud Platform. type: string - name: - description: Name is the Pipeline Task name + webhookSecretSecretVersion: + description: >- + Required. SecretManager resource containing the webhook secret used + to verify webhook events, formatted as + `projects/*/secrets/*/versions/*`. type: string + readAuthorizerCredential: + description: >- + Required. An access token with the `repository` access. It can be + either a workspace, project or repository access token. It's + recommended to use a system account to generate the credentials. + $ref: '#/components/schemas/UserCredential' + authorizerCredential: + description: >- + Required. An access token with the `webhook`, `repository`, + `repository:admin` and `pullrequest` scope access. It can be either + a workspace, project or repository access token. It's recommended to + use a system account to generate these credentials. + $ref: '#/components/schemas/UserCredential' + InstallationState: + id: InstallationState description: >- - SkippedTask is used to describe the Tasks that were skipped due to their - When Expressions evaluating to False. - type: object - RunWorkflowCustomOperationMetadata: + Describes stage and necessary actions to be taken by the user to + complete the installation. Used for GitHub and GitHub Enterprise based + connections. type: object - description: >- - Represents the custom metadata of the RunWorkflow long-running - operation. - id: RunWorkflowCustomOperationMetadata properties: - createTime: - format: google-datetime + stage: + description: Output only. Current step of the installation process. + readOnly: true type: string - description: Output only. The time the operation was created. + enumDescriptions: + - No stage specified. + - >- + Only for GitHub Enterprise. An App creation has been requested. + The user needs to confirm the creation in their GitHub enterprise + host. + - User needs to authorize the GitHub (or Enterprise) App via OAuth. + - >- + User needs to follow the link to install the GitHub (or + Enterprise) App. + - Installation process has been completed. + enum: + - STAGE_UNSPECIFIED + - PENDING_CREATE_APP + - PENDING_USER_OAUTH + - PENDING_INSTALL_APP + - COMPLETE + message: + description: >- + Output only. Message of what the user should do next to continue the + installation. Empty string if the installation is already complete. readOnly: true - apiVersion: - description: Output only. API version used to start the operation. type: string + actionUri: + description: >- + Output only. Link to follow for next action. Empty string if the + installation is already complete. readOnly: true - pipelineRunId: - readOnly: true - description: Output only. ID of the pipeline run created by RunWorkflow. type: string - verb: - readOnly: true - description: Output only. Name of the verb executed by the operation. + ListConnectionsResponse: + id: ListConnectionsResponse + description: Message for response to listing Connections. + type: object + properties: + connections: + description: The list of Connections. + type: array + items: + $ref: '#/components/schemas/Connection' + nextPageToken: + description: A token identifying a page of results the server should return. type: string - target: + unreachable: + description: Locations that could not be reached. + type: array + items: + type: string + Repository: + id: Repository + description: A repository associated to a parent connection. + type: object + properties: + name: + description: >- + Immutable. Resource name of the repository, in the format + `projects/*/locations/*/connections/*/repositories/*`. type: string - readOnly: true + remoteUri: + description: Required. Git Clone HTTPS URI. + type: string + createTime: description: >- - Output only. Server-defined resource path for the target of the - operation. - endTime: + Output only. Server assigned timestamp for when the connection was + created. readOnly: true - description: Output only. The time the operation finished running. type: string format: google-datetime - requestedCancellation: + updateTime: description: >- - Output only. Identifies whether the user has requested cancellation - of the operation. Operations that have successfully been cancelled - have Operation.error value with a google.rpc.Status.code of 1, - corresponding to `Code.CANCELLED`. - type: boolean - readOnly: true - ResultValue: - description: ResultValue holds different types of data for a single result. - id: ResultValue - properties: - arrayVal: - items: - type: string - description: Value of the result if type is array. - type: array - type: - enumDescriptions: - - Default enum type; should not be used. - - Default - - Array type - - Object type - type: string + Output only. Server assigned timestamp for when the connection was + updated. readOnly: true - enum: - - TYPE_UNSPECIFIED - - STRING - - ARRAY - - OBJECT - description: Output only. The type of data that the result holds. - stringVal: type: string - description: Value of the result if type is string. - objectVal: + format: google-datetime + annotations: + description: Optional. Allows clients to store small amounts of arbitrary data. type: object additionalProperties: type: string - description: Value of the result if type is object. - type: object - PipelineRunResult: - id: PipelineRunResult - type: object - description: PipelineRunResult used to describe the results of a pipeline - properties: - name: - readOnly: true + etag: + description: >- + This checksum is computed by the server based on the value of other + fields, and may be sent on update and delete requests to ensure the + client has an up-to-date value before proceeding. type: string - description: Output only. Name of the TaskRun - value: - $ref: '#/components/schemas/ResultValue' - description: Output only. Value of the result. + webhookId: + description: Output only. External ID of the webhook created for the repository. readOnly: true - FetchGitRefsResponse: - properties: - nextPageToken: type: string - description: A token identifying a page of results the server should return. - refNames: - items: - type: string - description: Name of the refs fetched. - type: array - id: FetchGitRefsResponse - description: Response for fetching git refs + BatchCreateRepositoriesRequest: + id: BatchCreateRepositoriesRequest + description: Message for creating repositoritories in batch. type: object + properties: + requests: + description: >- + Required. The request messages specifying the repositories to + create. + type: array + items: + $ref: '#/components/schemas/CreateRepositoryRequest' CreateRepositoryRequest: id: CreateRepositoryRequest description: Message for creating a Repository. type: object properties: + parent: + description: >- + Required. The connection to contain the repository. If the request + is part of a BatchCreateRepositoriesRequest, this field should be + empty or match the parent specified there. + type: string + repository: + description: Required. The repository to create. + $ref: '#/components/schemas/Repository' repositoryId: description: >- Required. The ID to use for the repository, which will become the @@ -1034,1182 +613,1638 @@ components: unique in the connection. Allows alphanumeric characters and any of -._~%!$&'()*+,;=@. type: string - repository: - $ref: '#/components/schemas/Repository' - description: Required. The repository to create. - parent: - description: >- - Required. The connection to contain the repository. If the request - is part of a BatchCreateRepositoriesRequest, this field should be - empty or match the parent specified there. - type: string - EnvVar: + ListRepositoriesResponse: + id: ListRepositoriesResponse + description: Message for response to listing Repositories. type: object - id: EnvVar - description: Environment variable. properties: - name: - description: Name of the environment variable. - type: string - value: - description: Value of the environment variable. + repositories: + description: The list of Repositories. + type: array + items: + $ref: '#/components/schemas/Repository' + nextPageToken: + description: A token identifying a page of results the server should return. type: string - GoogleDevtoolsCloudbuildV2OperationMetadata: + unreachable: + description: Locations that could not be reached. + type: array + items: + type: string + FetchReadWriteTokenRequest: + id: FetchReadWriteTokenRequest + description: Message for fetching SCM read/write token. + type: object + properties: {} + FetchReadWriteTokenResponse: + id: FetchReadWriteTokenResponse + description: Message for responding to get read/write token. + type: object properties: - requestedCancellation: - description: >- - Output only. Identifies whether the user has requested cancellation - of the operation. Operations that have successfully been cancelled - have Operation.error value with a google.rpc.Status.code of 1, - corresponding to `Code.CANCELLED`. - readOnly: true - type: boolean - verb: - description: Output only. Name of the verb executed by the operation. - readOnly: true - type: string - apiVersion: - description: Output only. API version used to start the operation. - readOnly: true - type: string - target: - readOnly: true - description: >- - Output only. Server-defined resource path for the target of the - operation. + token: + description: The token content. type: string - endTime: - readOnly: true + expirationTime: + description: Expiration timestamp. Can be empty if unknown or non-expiring. type: string format: google-datetime - description: Output only. The time the operation finished running. - createTime: - format: google-datetime - description: Output only. The time the operation was created. - readOnly: true + FetchReadTokenRequest: + id: FetchReadTokenRequest + description: Message for fetching SCM read token. + type: object + properties: {} + FetchReadTokenResponse: + id: FetchReadTokenResponse + description: Message for responding to get read token. + type: object + properties: + token: + description: The token content. type: string - statusMessage: + expirationTime: + description: Expiration timestamp. Can be empty if unknown or non-expiring. type: string - readOnly: true - description: Output only. Human-readable status of the operation, if any. + format: google-datetime + HttpBody: + id: HttpBody + description: >- + Message that represents an arbitrary HTTP body. It should only be used + for payload formats that can't be represented as JSON, such as raw + binary or an HTML page. This message can be used both in streaming and + non-streaming API methods in the request as well as the response. It can + be used as a top-level request field, which is convenient if one wants + to extract parameters from either the URL or HTTP template into the + request fields and also want access to the raw HTTP body. Example: + message GetResourceRequest { // A unique request id. string request_id = + 1; // The raw HTTP body is bound to this field. google.api.HttpBody + http_body = 2; } service ResourceService { rpc + GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc + UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } + Example with streaming methods: service CaldavService { rpc + GetCalendar(stream google.api.HttpBody) returns (stream + google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) + returns (stream google.api.HttpBody); } Use of this type only changes + how the request and response bodies are handled, all other features will + continue to work unchanged. type: object - description: Represents the metadata of the long-running operation. - id: GoogleDevtoolsCloudbuildV2OperationMetadata - Location: - id: Location - description: A resource that represents a Google Cloud location. properties: - metadata: - description: >- - Service-specific metadata. For example the available capacity at the - given location. - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - name: + contentType: description: >- - Resource name for the location, which may vary between - implementations. For example: - `"projects/example-project/locations/us-east1"` + The HTTP Content-Type header value specifying the content type of + the body. type: string - locationId: + data: + description: The HTTP request/response body as raw binary. type: string - description: 'The canonical id for this location. For example: `"us-east1"`.' - labels: - additionalProperties: - type: string - type: object + format: byte + extensions: description: >- - Cross-service attributes for the location. For example - {"cloud.googleapis.com/region": "us-east1"} - displayName: + Application specific response metadata. Must be set in the first + response for streaming APIs. + type: array + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + FetchLinkableRepositoriesResponse: + id: FetchLinkableRepositoriesResponse + description: Response message for FetchLinkableRepositories. + type: object + properties: + repositories: + description: repositories ready to be created. + type: array + items: + $ref: '#/components/schemas/Repository' + nextPageToken: + description: A token identifying a page of results the server should return. type: string - description: >- - The friendly name for this location, typically a nearby city name. - For example, "Tokyo". + FetchGitRefsResponse: + id: FetchGitRefsResponse + description: Response for fetching git refs type: object + properties: + refNames: + description: Name of the refs fetched. + type: array + items: + type: string + nextPageToken: + description: A token identifying a page of results the server should return. + type: string SetIamPolicyRequest: + id: SetIamPolicyRequest + description: Request message for `SetIamPolicy` method. + type: object properties: policy: - $ref: '#/components/schemas/Policy' description: >- REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them. + $ref: '#/components/schemas/Policy' updateMask: - type: string - format: google-fieldmask description: >- OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"` + type: string + format: google-fieldmask + Policy: + id: Policy + description: >- + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. A `Policy` is a collection of + `bindings`. A `binding` binds one or more `members`, or principals, to a + single `role`. Principals can be user accounts, service accounts, Google + groups, and domains (such as G Suite). A `role` is a named list of + permissions; each `role` can be an IAM predefined role or a user-created + custom role. For some types of Google Cloud resources, a `binding` can + also specify a `condition`, which is a logical expression that allows + access to a resource only if the expression evaluates to `true`. A + condition can add constraints based on attributes of the request, the + resource, or both. To learn which resources support conditions in their + IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + **JSON example:** ``` { "bindings": [ { "role": + "roles/resourcemanager.organizationAdmin", "members": [ + "user:mike@example.com", "group:admins@example.com", + "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { + "role": "roles/resourcemanager.organizationViewer", "members": [ + "user:eve@example.com" ], "condition": { "title": "expirable access", + "description": "Does not grant access after Sep 2020", "expression": + "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": + "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - + members: - user:mike@example.com - group:admins@example.com - + domain:google.com - + serviceAccount:my-project-id@appspot.gserviceaccount.com role: + roles/resourcemanager.organizationAdmin - members: - + user:eve@example.com role: roles/resourcemanager.organizationViewer + condition: title: expirable access description: Does not grant access + after Sep 2020 expression: request.time < + timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` + For a description of IAM and its features, see the [IAM + documentation](https://cloud.google.com/iam/docs/). type: object - description: Request message for `SetIamPolicy` method. - id: SetIamPolicyRequest - PipelineRef: - id: PipelineRef properties: - resolver: + version: description: >- - Resolver is the name of the resolver that should perform resolution - of the referenced Tekton resource. + 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). + type: integer + format: int32 + bindings: + description: >- + Associates a list of `members`, or principals, with a `role`. + Optionally, may specify a `condition` that determines how and when + the `bindings` are applied. Each of the `bindings` must contain at + least one principal. The `bindings` in a `Policy` can refer to up to + 1,500 principals; up to 250 of these principals can be Google + groups. Each occurrence of a principal counts towards these limits. + For example, if the `bindings` grant 50 different roles to + `user:alice@example.com`, and not to any other principal, then you + can add another 1,450 principals to the `bindings` in the `Policy`. + type: array + items: + $ref: '#/components/schemas/Binding' + auditConfigs: + description: Specifies cloud audit logging configuration for this policy. + type: array + items: + $ref: '#/components/schemas/AuditConfig' + 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. type: string - enum: - - RESOLVER_NAME_UNSPECIFIED - - BUNDLES - - GCB_REPO - - GIT - - DEVELOPER_CONNECT - - DEFAULT - enumDescriptions: - - Default enum type; should not be used. - - >- - Bundles resolver. - https://tekton.dev/docs/pipelines/bundle-resolver/ - - GCB repo resolver. - - >- - Simple Git resolver. - https://tekton.dev/docs/pipelines/git-resolver/ - - Developer Connect resolver. - - Default resolver. - name: - description: Optional. Name of the Pipeline. + format: byte + Binding: + id: Binding + description: Associates `members`, or principals, with a `role`. + type: object + properties: + role: + description: >- + Role that is assigned to the list of `members`, or principals. For + example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an + overview of the IAM roles and permissions, see the [IAM + documentation](https://cloud.google.com/iam/docs/roles-overview). + For a list of the available pre-defined roles, see + [here](https://cloud.google.com/iam/docs/understanding-roles). type: string - params: + members: + description: >- + Specifies the principals requesting access for a Google Cloud + 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. Does not include identities + that come from external identity providers (IdPs) through identity + federation. * `user:{emailid}`: An email address that represents a + specific Google account. For example, `alice@example.com` . * + `serviceAccount:{emailid}`: An email address that represents a + Google service account. For example, + `my-other-app@appspot.gserviceaccount.com`. * + `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: + An identifier for a [Kubernetes service + account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). + For example, + `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * + `group:{emailid}`: An email address that represents a Google group. + For example, `admins@example.com`. * `domain:{domain}`: The G Suite + domain (primary) that represents all the users of that domain. For + example, `google.com` or `example.com`. * + `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workforce identity pool. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: + All workforce identities in a group. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All workforce identities with a specific attribute value. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: + All identities in a workforce identity pool. * + `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workload identity pool. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: + A workload identity pool group. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All identities in a workload identity pool with a certain attribute. + * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: + All identities in a workload identity pool. * + `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. * + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + Deleted single identity in a workforce identity pool. For example, + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. type: array items: - $ref: '#/components/schemas/Param' + type: string + condition: description: >- - Params contains the parameters used to identify the referenced - Tekton resource. Example entries might include "repo" or "path" but - the set of params ultimately depends on the chosen resolver. - type: object - description: PipelineRef can be used to refer to a specific instance of a Pipeline. - FetchLinkableRepositoriesResponse: - description: Response message for FetchLinkableRepositories. + The condition that is associated with this binding. If the condition + evaluates to `true`, then this binding applies to the current + request. If the condition evaluates to `false`, then this binding + does not apply to the current request. However, a different role + binding might grant the same role to one or more of the principals + in this binding. To learn which resources support conditions in + their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + $ref: '#/components/schemas/Expr' + Expr: + id: 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. type: object - id: FetchLinkableRepositoriesResponse properties: - repositories: - items: - $ref: '#/components/schemas/Repository' - type: array - description: repositories ready to be created. - nextPageToken: - description: A token identifying a page of results the server should return. + expression: + description: >- + Textual representation of an expression in Common Expression + Language syntax. type: string - ChildStatusReference: - properties: - whenExpressions: + title: description: >- - WhenExpressions is the list of checks guarding the execution of the - PipelineTask - type: array - items: - $ref: '#/components/schemas/WhenExpression' - type: + 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 - enumDescriptions: - - Default enum type; should not be used. - - TaskRun. - description: Output only. Type of the child reference. - readOnly: true - enum: - - TYPE_UNSPECIFIED - - TASK_RUN - pipelineTaskName: + 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 + location: description: >- - PipelineTaskName is the name of the PipelineTask this is - referencing. - name: + Optional. String indicating the location of the expression for error + reporting, e.g. a file name and a position in the file. type: string - description: Name is the name of the TaskRun or Run this is referencing. - type: object - id: ChildStatusReference + AuditConfig: + id: AuditConfig description: >- - ChildStatusReference is used to point to the statuses of individual - TaskRuns and Runs within this PipelineRun. - VolumeSource: - id: VolumeSource + 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. + type: object properties: - emptyDir: - $ref: '#/components/schemas/EmptyDirVolumeSource' - description: A temporary directory that shares a pod's lifetime. - name: + service: description: >- - Name of the Volume. Must be a DNS_LABEL and unique within the pod. - More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + 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 + auditLogConfigs: + description: The configuration for logging of each type of permission. + type: array + items: + $ref: '#/components/schemas/AuditLogConfig' + AuditLogConfig: + id: 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. type: object - description: Volumes available to mount. - ListConnectionsResponse: - type: object - description: Message for response to listing Connections. properties: - connections: + logType: + description: The log type that this config enables. + type: string + enumDescriptions: + - Default case. Should never be this. + - 'Admin reads. Example: CloudIAM getIamPolicy' + - 'Data writes. Example: CloudSQL Users create' + - 'Data reads. Example: CloudSQL Users list' + enum: + - LOG_TYPE_UNSPECIFIED + - ADMIN_READ + - DATA_WRITE + - DATA_READ + exemptedMembers: + description: >- + Specifies the identities that do not cause logging for this type of + permission. Follows the same format of Binding.members. type: array items: - $ref: '#/components/schemas/Connection' - description: The list of Connections. - nextPageToken: - type: string - description: A token identifying a page of results the server should return. - id: ListConnectionsResponse - Worker: - id: Worker + type: string + TestIamPermissionsRequest: + id: TestIamPermissionsRequest + description: Request message for `TestIamPermissions` method. type: object - description: Configuration for the worker. properties: - machineType: - description: Optional. Machine type of a worker, default is "e2-standard-2". - type: string - GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig: - id: GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig - description: >- - ServiceDirectoryConfig represents Service Directory configuration for a - connection. + permissions: + description: >- + The set of permissions to check for the `resource`. Permissions with + wildcards (such as `*` or `storage.*`) are not allowed. For more + information see [IAM + Overview](https://cloud.google.com/iam/docs/overview#permissions). + type: array + items: + type: string + TestIamPermissionsResponse: + id: TestIamPermissionsResponse + description: Response message for `TestIamPermissions` method. type: object properties: - service: - type: string + permissions: description: >- - Required. The Service Directory service name. Format: - projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. - VolumeMount: + A subset of `TestPermissionsRequest.permissions` that the caller is + allowed. + type: array + items: + type: string + GoogleDevtoolsCloudbuildV2OperationMetadata: + id: GoogleDevtoolsCloudbuildV2OperationMetadata + description: Represents the metadata of the long-running operation. type: object - id: VolumeMount - description: Pod volumes to mount into the container's filesystem. properties: - subPath: + createTime: + description: Output only. The time the operation was created. + readOnly: true type: string - description: >- - Path within the volume from which the container's volume should be - mounted. Defaults to "" (volume's root). - name: - description: Name of the volume. + format: google-datetime + endTime: + description: Output only. The time the operation finished running. + readOnly: true type: string - readOnly: - type: boolean - description: >- - Mounted read-only if true, read-write otherwise (false or - unspecified). - mountPath: + format: google-datetime + target: description: >- - Path within the container at which the volume should be mounted. - Must not contain ':'. + Output only. Server-defined resource path for the target of the + operation. + readOnly: true type: string - subPathExpr: + verb: + description: Output only. Name of the verb executed by the operation. + readOnly: true type: string - description: >- - Expanded path within the volume from which the container's volume - should be mounted. Behaves similarly to SubPath but environment - variable references $(VAR_NAME) are expanded using the container's - environment. Defaults to "" (volume's root). - FetchReadTokenResponse: - properties: - expirationTime: - format: google-datetime - description: Expiration timestamp. Can be empty if unknown or non-expiring. + statusMessage: + description: Output only. Human-readable status of the operation, if any. + readOnly: true type: string - token: + requestedCancellation: + description: >- + Output only. Identifies whether the user has requested cancellation + of the operation. Operations that have successfully been cancelled + have Operation.error value with a google.rpc.Status.code of 1, + corresponding to `Code.CANCELLED`. + readOnly: true + type: boolean + apiVersion: + description: Output only. API version used to start the operation. + readOnly: true type: string - description: The token content. - id: FetchReadTokenResponse - type: object - description: Message for responding to get read token. - GoogleDevtoolsCloudbuildV2GitLabConfig: - id: GoogleDevtoolsCloudbuildV2GitLabConfig - type: object + RunWorkflowCustomOperationMetadata: + id: RunWorkflowCustomOperationMetadata description: >- - Configuration for connections to gitlab.com or an instance of GitLab - Enterprise. + Represents the custom metadata of the RunWorkflow long-running + operation. + type: object properties: - serverVersion: - description: >- - Output only. Version of the GitLab Enterprise server running on the - `host_uri`. + createTime: + description: Output only. The time the operation was created. + readOnly: true type: string + format: google-datetime + endTime: + description: Output only. The time the operation finished running. readOnly: true - sslCa: type: string - description: Optional. SSL certificate to use for requests to GitLab Enterprise. - authorizerCredential: - $ref: '#/components/schemas/UserCredential' - description: >- - Required. A GitLab personal access token with the `api` scope - access. - serviceDirectoryConfig: - description: >- - Optional. Configuration for using Service Directory to privately - connect to a GitLab Enterprise server. This should only be set if - the GitLab Enterprise server is hosted on-premises and not reachable - by public internet. If this field is left empty, calls to the GitLab - Enterprise server will be made over the public internet. - $ref: >- - #/components/schemas/GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig - webhookSecretSecretVersion: - description: >- - Required. Immutable. SecretManager resource containing the webhook - secret of a GitLab Enterprise project, formatted as - `projects/*/secrets/*/versions/*`. + format: google-datetime + verb: + description: Output only. Name of the verb executed by the operation. + readOnly: true type: string - readAuthorizerCredential: - $ref: '#/components/schemas/UserCredential' + requestedCancellation: description: >- - Required. A GitLab personal access token with the minimum `read_api` - scope access. - hostUri: + Output only. Identifies whether the user has requested cancellation + of the operation. Operations that have successfully been cancelled + have Operation.error value with a google.rpc.Status.code of 1, + corresponding to `Code.CANCELLED`. + readOnly: true + type: boolean + apiVersion: + description: Output only. API version used to start the operation. + readOnly: true + type: string + target: description: >- - Optional. The URI of the GitLab Enterprise host this connection is - for. If not specified, the default value is https://gitlab.com. + Output only. Server-defined resource path for the target of the + operation. + readOnly: true type: string - ParamSpec: - id: ParamSpec - description: >- - ParamSpec defines parameters needed beyond typed inputs (such as - resources). Parameter values are provided by users as inputs on a - TaskRun or PipelineRun. + pipelineRunId: + description: Output only. ID of the pipeline run created by RunWorkflow. + readOnly: true + type: string + OperationMetadata: + id: OperationMetadata + description: Represents the metadata of the long-running operation. + type: object properties: - type: - enum: - - TYPE_UNSPECIFIED - - STRING - - ARRAY - - OBJECT - enumDescriptions: - - Default enum type; should not be used. - - Default - - Array type. - - Object type. - description: Type of ParamSpec + createTime: + description: Output only. The time the operation was created. + readOnly: true type: string - description: + format: google-datetime + endTime: + description: Output only. The time the operation finished running. + readOnly: true type: string - description: Description of the ParamSpec - name: + format: google-datetime + target: + description: >- + Output only. Server-defined resource path for the target of the + operation. + readOnly: true type: string - description: Name of the ParamSpec - default: - description: The default value a parameter takes if no input value is supplied - $ref: '#/components/schemas/ParamValue' - type: object - UserCredential: - properties: - username: - description: Output only. The username associated to this token. + verb: + description: Output only. Name of the verb executed by the operation. readOnly: true type: string - userTokenSecretVersion: + statusDetail: + description: Output only. Human-readable status of the operation, if any. + readOnly: true type: string + cancelRequested: description: >- - Required. A SecretManager resource containing the user token that - authorizes the Cloud Build connection. Format: - `projects/*/secrets/*/versions/*`. - description: >- - Represents a personal access token that authorized the Connection, and - associated metadata. - type: object - id: UserCredential - Capabilities: + Output only. Identifies whether the user has requested cancellation + of the operation. Operations that have been cancelled successfully + have google.longrunning.Operation.error value with a + google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + readOnly: true + type: boolean + apiVersion: + description: Output only. API version used to start the operation. + readOnly: true + type: string + BatchCreateRepositoriesResponse: + id: BatchCreateRepositoriesResponse + description: Message for response of creating repositories in batch. type: object - id: Capabilities - description: >- - Capabilities adds and removes POSIX capabilities from running - containers. properties: - drop: - description: Optional. Removed capabilities +optional - items: - type: string + repositories: + description: Repository resources created. type: array - add: items: - type: string - description: Optional. Added capabilities +optional - type: array - Provenance: + $ref: '#/components/schemas/Repository' + PipelineRun: + id: PipelineRun + description: Message describing PipelineRun object type: object properties: - storage: + name: + description: >- + Output only. The `PipelineRun` name with format + `projects/{project}/locations/{location}/pipelineRuns/{pipeline_run}` + readOnly: true type: string - enumDescriptions: - - Default PREFER_ARTIFACT_PROJECT. - - >- - GCB will attempt to push provenance to the artifact project. If it - is not available, fallback to build project. - - Only push to artifact project. - - Only push to build project. - enum: - - STORAGE_UNSPECIFIED - - PREFER_ARTIFACT_PROJECT - - ARTIFACT_PROJECT_ONLY - - BUILD_PROJECT_ONLY - description: Optional. Where provenance is stored. - enabled: - description: Optional. Provenance push mode. - enumDescriptions: - - Default to disabled (before AA regionalization), optimistic after - - Provenance failures would fail the run - - >- - GCB will attempt to push to artifact analaysis and build state - would not be impacted by the push failures. - - Disable the provenance push entirely. + uid: + description: Output only. A unique identifier for the `PipelineRun`. + readOnly: true type: string - enum: - - ENABLED_UNSPECIFIED - - REQUIRED - - OPTIMISTIC - - DISABLED - region: + createTime: + description: >- + Output only. Time at which the request to create the `PipelineRun` + was received. + readOnly: true type: string - enum: - - REGION_UNSPECIFIED - - GLOBAL - description: Optional. Provenance region. - enumDescriptions: - - >- - The PipelineRun/TaskRun/Workflow will be rejected. Update this - comment to push to the same region as the run in Artifact Analysis - when it's regionalized. - - Push provenance to Artifact Analysis in global region. - id: Provenance - description: Provenance configuration. - StepRef: - type: object - id: StepRef - description: A reference to a remote Step, i.e. a StepAction. - properties: - resolver: - enum: - - RESOLVER_NAME_UNSPECIFIED - - BUNDLES - - GCB_REPO - - GIT - - DEVELOPER_CONNECT - - DEFAULT + format: google-datetime + updateTime: + description: >- + Output only. Time at which the request to update the `PipelineRun` + was received. + readOnly: true + type: string + format: google-datetime + annotations: + description: User annotations. See https://google.aip.dev/128#annotations + type: object + additionalProperties: + type: string + workflow: + description: Output only. The Workflow used to create this PipelineRun. + readOnly: true + type: string + workerPool: + description: Output only. The WorkerPool used to run this PipelineRun. + readOnly: true type: string - description: Optional. Type of the resolver. - enumDescriptions: - - Default enum type; should not be used. - - >- - Bundles resolver. - https://tekton.dev/docs/pipelines/bundle-resolver/ - - GCB repo resolver. - - >- - Simple Git resolver. - https://tekton.dev/docs/pipelines/git-resolver/ - - Developer Connect resolver. - - Default resolver. - name: + pipelineSpec: + description: PipelineSpec defines the desired state of Pipeline. + $ref: '#/components/schemas/PipelineSpec' + pipelineRef: + description: PipelineRef refer to a specific instance of a Pipeline. + $ref: '#/components/schemas/PipelineRef' + pipelineSpecYaml: + description: >- + Output only. Inline pipelineSpec yaml string, used by workflow run + requests. + readOnly: true type: string - description: Optional. Name of the step. - params: - description: Optional. Parameters used to control the resolution. - items: - $ref: '#/components/schemas/Param' - type: array - Step: - type: object - description: >- - Step embeds the Container type, which allows it to include fields not - provided by Container. - properties: params: + description: Params is a list of parameter names and values. type: array items: $ref: '#/components/schemas/Param' - description: Optional. Optional parameters passed to the StepAction. - volumeMounts: - description: Pod volumes to mount into the container's filesystem. + workspaces: + description: >- + Workspaces is a list of WorkspaceBindings from volumes to + workspaces. type: array items: - $ref: '#/components/schemas/VolumeMount' - onError: + $ref: '#/components/schemas/WorkspaceBinding' + serviceAccount: + description: >- + Service account used in the Pipeline. Deprecated; please use + security.service_account instead. + deprecated: true + type: string + pipelineRunStatus: + description: Pipelinerun status the user can provide. Used for cancellation. + type: string enumDescriptions: - Default enum type; should not be used. - - >- - StopAndFail indicates exit if the step/task exits with non-zero - exit code - - >- - Continue indicates continue executing the rest of the steps/tasks - irrespective of the exit code + - Cancelled status. enum: - - ON_ERROR_TYPE_UNSPECIFIED - - STOP_AND_FAIL - - CONTINUE + - PIPELINE_RUN_STATUS_UNSPECIFIED + - PIPELINE_RUN_CANCELLED + conditions: description: >- - Optional. OnError defines the exiting behavior on error can be set - to [ continue | stopAndFail ] - type: string - env: - type: array - items: - $ref: '#/components/schemas/EnvVar' - description: List of environment variables to set in the container. - command: + Output only. Kubernetes Conditions convention for PipelineRun status + and error. + readOnly: true type: array items: - type: string - description: Entrypoint array. - workingDir: - description: Container's working directory. + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV2Condition' + startTime: + description: Output only. Time the pipeline is actually started. + readOnly: true type: string - name: - description: Name of the container specified as a DNS_LABEL. + format: google-datetime + completionTime: + description: Output only. Time the pipeline completed. + readOnly: true type: string - args: - description: Arguments to the entrypoint. - items: - type: string + format: google-datetime + childReferences: + description: >- + Output only. List of TaskRun and Run names and PipelineTask names + for children of this PipelineRun. + readOnly: true type: array - ref: - $ref: '#/components/schemas/StepRef' - description: Optional. Optional reference to a remote StepAction. - timeout: - description: Time after which the Step times out. Defaults to never. + items: + $ref: '#/components/schemas/ChildStatusReference' + etag: + description: Needed for declarative-friendly resources. type: string - format: google-duration - image: + timeouts: + description: >- + Time after which the Pipeline times out. Currently three keys are + accepted in the map pipeline, tasks and finally with + Timeouts.pipeline >= Timeouts.tasks + Timeouts.finally + $ref: '#/components/schemas/TimeoutFields' + skippedTasks: + description: >- + Output only. List of tasks that were skipped due to when expressions + evaluating to false. + readOnly: true + type: array + items: + $ref: '#/components/schemas/SkippedTask' + resolvedPipelineSpec: + description: Output only. The exact PipelineSpec used to instantiate the run. + readOnly: true + $ref: '#/components/schemas/PipelineSpec' + finallyStartTime: + description: >- + Output only. FinallyStartTime is when all non-finally tasks have + been completed and only finally tasks are being executed. +optional + readOnly: true type: string - description: Docker image name. - script: + format: google-datetime + gcbParams: + description: Output only. GCB default params. + readOnly: true + type: object + additionalProperties: + type: string + worker: + description: Optional. Worker configuration. + $ref: '#/components/schemas/Worker' + security: + description: Optional. Security configuration. + $ref: '#/components/schemas/Security' + provenance: + description: Optional. Provenance configuration. + $ref: '#/components/schemas/Provenance' + record: + description: >- + Output only. The `Record` of this `PipelineRun`. Format: + `projects/{project}/locations/{location}/results/{result_id}/records/{record_id}` + readOnly: true type: string - description: The contents of an executable file to execute. - securityContext: - $ref: '#/components/schemas/SecurityContext' + results: description: >- - Optional. SecurityContext defines the security options the Step - should be run with. If set, the fields of SecurityContext override - the equivalent fields of PodSecurityContext. More info: - https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ - +optional - id: Step - BatchCreateRepositoriesRequest: - description: Message for creating repositoritories in batch. - properties: - requests: + Optional. Output only. List of results written out by the pipeline's + containers + readOnly: true type: array - description: >- - Required. The request messages specifying the repositories to - create. items: - $ref: '#/components/schemas/CreateRepositoryRequest' - id: BatchCreateRepositoriesRequest + $ref: '#/components/schemas/PipelineRunResult' + PipelineSpec: + id: PipelineSpec + description: PipelineSpec defines the desired state of Pipeline. type: object - Sidecar: - description: Sidecars run alongside the Task's step containers. - id: Sidecar properties: - command: - description: Entrypoint array. + tasks: + description: List of Tasks that execute when this Pipeline is run. type: array items: - type: string - image: - description: Docker image name. - type: string - env: + $ref: '#/components/schemas/PipelineTask' + params: + description: List of parameters. + type: array items: - $ref: '#/components/schemas/EnvVar' + $ref: '#/components/schemas/ParamSpec' + workspaces: + description: >- + Workspaces declares a set of named workspaces that are expected to + be provided by a PipelineRun. type: array - description: List of environment variables to set in the container. - name: - description: Name of the Sidecar. - type: string - readinessProbe: - $ref: '#/components/schemas/Probe' + items: + $ref: '#/components/schemas/PipelineWorkspaceDeclaration' + finallyTasks: description: >- - Optional. Periodic probe of Sidecar service readiness. Container - will be removed from service endpoints if the probe fails. Cannot be - updated. More info: - https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes - +optional - args: + List of Tasks that execute just before leaving the Pipeline i.e. + either after all Tasks are finished executing successfully or after + a failure which would result in ending the Pipeline. type: array - description: Arguments to the entrypoint. items: - type: string - securityContext: - $ref: '#/components/schemas/SecurityContext' - description: Optional. Security options the container should be run with. - script: - description: The contents of an executable file to execute. - type: string - workingDir: - description: Container's working directory. + $ref: '#/components/schemas/PipelineTask' + generatedYaml: + description: >- + Output only. auto-generated yaml that is output only for display + purpose for workflows using pipeline_spec, used by UI/gcloud cli for + Workflows. + readOnly: true type: string - volumeMounts: - items: - $ref: '#/components/schemas/VolumeMount' - description: Pod volumes to mount into the container's filesystem. + results: + description: >- + Optional. Output only. List of results written out by the pipeline's + containers + readOnly: true type: array - type: object + items: + $ref: '#/components/schemas/PipelineResult' PipelineTask: + id: PipelineTask description: PipelineTask defines a task in a Pipeline. + type: object properties: - timeout: - description: >- - Time after which the TaskRun times out. Defaults to 1 hour. - Specified TaskRun timeout should be less than 24h. - type: string - format: google-duration name: - type: string description: Name of the task. - workspaces: + type: string + taskSpec: + description: Spec to instantiate this TaskRun. + $ref: '#/components/schemas/EmbeddedTask' + taskRef: + description: Reference to a specific instance of a task. + $ref: '#/components/schemas/TaskRef' + whenExpressions: + description: Conditions that need to be true for the task to run. type: array items: - $ref: '#/components/schemas/WorkspacePipelineTaskBinding' - description: >- - Workspaces maps workspaces from the pipeline spec to the workspaces - declared in the Task. + $ref: '#/components/schemas/WhenExpression' params: + description: Params is a list of parameter names and values. + type: array items: $ref: '#/components/schemas/Param' - description: Params is a list of parameter names and values. + workspaces: + description: >- + Workspaces maps workspaces from the pipeline spec to the workspaces + declared in the Task. type: array - taskRef: - $ref: '#/components/schemas/TaskRef' - description: Reference to a specific instance of a task. + items: + $ref: '#/components/schemas/WorkspacePipelineTaskBinding' runAfter: description: >- RunAfter is the list of PipelineTask names that should be executed before this Task executes. (Used to force a specific ordering in graph execution.) + type: array items: type: string - type: array - taskSpec: - $ref: '#/components/schemas/EmbeddedTask' - description: Spec to instantiate this TaskRun. retries: - type: integer - format: int32 description: >- Retries represents how many times this task should be retried in case of task failure. - whenExpressions: - description: Conditions that need to be true for the task to run. - type: array - items: - $ref: '#/components/schemas/WhenExpression' + type: integer + format: int32 + timeout: + description: >- + Time after which the TaskRun times out. Defaults to 1 hour. + Specified TaskRun timeout should be less than 24h. + type: string + format: google-duration + EmbeddedTask: + id: EmbeddedTask + description: EmbeddedTask defines a Task that is embedded in a Pipeline. type: object - id: PipelineTask - SecretVolumeSource: properties: - secretName: + annotations: + description: User annotations. See https://google.aip.dev/128#annotations + type: object + additionalProperties: + type: string + taskSpec: + description: Spec to instantiate this TaskRun. + $ref: '#/components/schemas/TaskSpec' + TaskSpec: + id: TaskSpec + description: TaskSpec contains the Spec to instantiate a TaskRun. + type: object + properties: + params: + description: List of parameters. + type: array + items: + $ref: '#/components/schemas/ParamSpec' + steps: + description: Steps of the task. + type: array + items: + $ref: '#/components/schemas/Step' + results: + description: Values that this Task can output. + type: array + items: + $ref: '#/components/schemas/TaskResult' + workspaces: + description: The volumes that this Task requires. + type: array + items: + $ref: '#/components/schemas/WorkspaceDeclaration' + description: + description: Description of the task. type: string - description: Name of the secret referenced by the WorkspaceBinding. - secretVersion: + sidecars: + description: Sidecars that run alongside the Task's step containers. + type: array + items: + $ref: '#/components/schemas/Sidecar' + volumes: + description: A collection of volumes that are available to mount into steps. + type: array + items: + $ref: '#/components/schemas/VolumeSource' + managedSidecars: description: >- - Optional. Resource name of the SecretVersion. In format: - projects/*/secrets/*/versions/* - type: string + Sidecars that run alongside the Task’s step containers that should + be added to this Task. + type: array + items: + type: string + enumDescriptions: + - Default enum type; should not be used. + - Sidecar for a privileged docker daemon. + enum: + - MANAGED_SIDECAR_UNSPECIFIED + - PRIVILEGED_DOCKER_DAEMON + stepTemplate: + description: >- + Optional. StepTemplate can be used as the basis for all step + containers within the Task, so that the steps inherit settings on + the base container. + $ref: '#/components/schemas/StepTemplate' + ParamSpec: + id: ParamSpec + description: >- + ParamSpec defines parameters needed beyond typed inputs (such as + resources). Parameter values are provided by users as inputs on a + TaskRun or PipelineRun. type: object - description: Secret Volume Source. - id: SecretVolumeSource - Param: - id: Param properties: - value: - $ref: '#/components/schemas/ParamValue' - description: Value of the parameter. name: - description: Name of the parameter. + description: Name of the ParamSpec + type: string + description: + description: Description of the ParamSpec + type: string + type: + description: Type of ParamSpec type: string + enumDescriptions: + - Default enum type; should not be used. + - Default + - Array type. + - Object type. + enum: + - TYPE_UNSPECIFIED + - STRING + - ARRAY + - OBJECT + default: + description: The default value a parameter takes if no input value is supplied + $ref: '#/components/schemas/ParamValue' + ParamValue: + id: ParamValue + description: Parameter value. type: object + properties: + type: + description: Type of parameter. + type: string + enumDescriptions: + - Default enum type; should not be used. + - Default + - Array type + - Object type + enum: + - TYPE_UNSPECIFIED + - STRING + - ARRAY + - OBJECT + stringVal: + description: Value of the parameter if type is string. + type: string + arrayVal: + description: Value of the parameter if type is array. + type: array + items: + type: string + objectVal: + description: Optional. Value of the parameter if type is object. + type: object + additionalProperties: + type: string + Step: + id: Step description: >- - Param defined with name and value. PipelineRef can be used to refer to a - specific instance of a Pipeline. - AuditLogConfig: + Step embeds the Container type, which allows it to include fields not + provided by Container. type: object - 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: + name: + description: Name of the container specified as a DNS_LABEL. + type: string + image: + description: Docker image name. + type: string + args: + description: Arguments to the entrypoint. type: array - description: >- - Specifies the identities that do not cause logging for this type of - permission. Follows the same format of Binding.members. items: type: string - logType: - enumDescriptions: - - Default case. Should never be this. - - 'Admin reads. Example: CloudIAM getIamPolicy' - - 'Data writes. Example: CloudSQL Users create' - - 'Data reads. Example: CloudSQL Users list' - description: The log type that this config enables. - enum: - - LOG_TYPE_UNSPECIFIED - - ADMIN_READ - - DATA_WRITE - - DATA_READ + command: + description: Entrypoint array. + type: array + items: + type: string + workingDir: + description: Container's working directory. type: string - id: AuditLogConfig - ListRepositoriesResponse: - properties: - nextPageToken: + env: + description: List of environment variables to set in the container. + type: array + items: + $ref: '#/components/schemas/EnvVar' + script: + description: The contents of an executable file to execute. + type: string + volumeMounts: + description: Pod volumes to mount into the container's filesystem. + type: array + items: + $ref: '#/components/schemas/VolumeMount' + timeout: + description: Time after which the Step times out. Defaults to never. type: string - description: A token identifying a page of results the server should return. - repositories: + format: google-duration + securityContext: + description: >- + Optional. SecurityContext defines the security options the Step + should be run with. If set, the fields of SecurityContext override + the equivalent fields of PodSecurityContext. More info: + https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ + +optional + $ref: '#/components/schemas/SecurityContext' + ref: + description: Optional. Optional reference to a remote StepAction. + $ref: '#/components/schemas/StepRef' + params: + description: Optional. Optional parameters passed to the StepAction. type: array - description: The list of Repositories. items: - $ref: '#/components/schemas/Repository' - type: object - id: ListRepositoriesResponse - description: Message for response to listing Repositories. - Security: + $ref: '#/components/schemas/Param' + onError: + description: >- + Optional. OnError defines the exiting behavior on error can be set + to [ continue | stopAndFail ] + type: string + enumDescriptions: + - Default enum type; should not be used. + - >- + StopAndFail indicates exit if the step/task exits with non-zero + exit code + - >- + Continue indicates continue executing the rest of the steps/tasks + irrespective of the exit code + enum: + - ON_ERROR_TYPE_UNSPECIFIED + - STOP_AND_FAIL + - CONTINUE + EnvVar: + id: EnvVar + description: Environment variable. type: object - id: Security properties: - privilegeMode: + name: + description: Name of the environment variable. type: string - deprecated: true - description: Optional. Privilege mode. - enum: - - PRIVILEGE_MODE_UNSPECIFIED - - PRIVILEGED - - UNPRIVILEGED - enumDescriptions: - - Default to PRIVILEGED. - - Privileged mode. - - Unprivileged mode. - serviceAccount: + value: + description: Value of the environment variable. type: string - description: IAM service account whose credentials will be used at runtime. - description: Security configuration. - Empty: - id: Empty - properties: {} - description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + VolumeMount: + id: VolumeMount + description: Pod volumes to mount into the container's filesystem. type: object - BitbucketDataCenterConfig: properties: - readAuthorizerCredential: - description: Required. A http access token with the `REPO_READ` access. - $ref: '#/components/schemas/UserCredential' - authorizerCredential: - description: Required. A http access token with the `REPO_ADMIN` scope access. - $ref: '#/components/schemas/UserCredential' - serviceDirectoryConfig: - $ref: >- - #/components/schemas/GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig + name: + description: Name of the volume. + type: string + readOnly: description: >- - Optional. Configuration for using Service Directory to privately - connect to a Bitbucket Data Center. This should only be set if the - Bitbucket Data Center is hosted on-premises and not reachable by - public internet. If this field is left empty, calls to the Bitbucket - Data Center will be made over the public internet. - sslCa: + Mounted read-only if true, read-write otherwise (false or + unspecified). + type: boolean + mountPath: + description: >- + Path within the container at which the volume should be mounted. + Must not contain ':'. type: string + subPath: description: >- - Optional. SSL certificate to use for requests to the Bitbucket Data - Center. - webhookSecretSecretVersion: + Path within the volume from which the container's volume should be + mounted. Defaults to "" (volume's root). + type: string + subPathExpr: description: >- - Required. Immutable. SecretManager resource containing the webhook - secret used to verify webhook events, formatted as - `projects/*/secrets/*/versions/*`. + Expanded path within the volume from which the container's volume + should be mounted. Behaves similarly to SubPath but environment + variable references $(VAR_NAME) are expanded using the container's + environment. Defaults to "" (volume's root). type: string - serverVersion: + SecurityContext: + id: SecurityContext + description: Security options the container should be run with. + type: object + properties: + privileged: + description: Run container in privileged mode. + type: boolean + runAsUser: description: >- - Output only. Version of the Bitbucket Data Center running on the - `host_uri`. - readOnly: true + Optional. The UID to run the entrypoint of the container process. + Defaults to user specified in image metadata if unspecified. May + also be set in PodSecurityContext. If set in both SecurityContext + and PodSecurityContext, the value specified in SecurityContext takes + precedence. Note that this field cannot be set when spec.os.name is + windows. +optional type: string - hostUri: + format: int64 + runAsGroup: + description: >- + Optional. The GID to run the entrypoint of the container process. + Uses runtime default if unset. May also be set in + PodSecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes + precedence. Note that this field cannot be set when spec.os.name is + windows. +optional type: string + format: int64 + runAsNonRoot: description: >- - Required. The URI of the Bitbucket Data Center instance or cluster - this connection is for. - id: BitbucketDataCenterConfig + Optional. Indicates that the container must run as a non-root user. + If true, the Kubelet will validate the image at runtime to ensure + that it does not run as UID 0 (root) and fail to start the container + if it does. If unset or false, no such validation will be performed. + May also be set in PodSecurityContext. If set in both + SecurityContext and PodSecurityContext, the value specified in + SecurityContext takes precedence. +optional + type: boolean + allowPrivilegeEscalation: + description: >- + Optional. AllowPrivilegeEscalation controls whether a process can + gain more privileges than its parent process. This bool directly + controls if the no_new_privs flag will be set on the container + process. AllowPrivilegeEscalation is true always when the container + is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field + cannot be set when spec.os.name is windows. +optional + type: boolean + StepRef: + id: StepRef + description: A reference to a remote Step, i.e. a StepAction. type: object - description: Configuration for connections to Bitbucket Data Center. - ListLocationsResponse: - id: ListLocationsResponse properties: - locations: - items: - $ref: '#/components/schemas/Location' - description: >- - A list of locations that matches the specified filter in the - request. + name: + description: Optional. Name of the step. + type: string + resolver: + description: Optional. Type of the resolver. + type: string + enumDescriptions: + - Default enum type; should not be used. + - >- + Bundles resolver. + https://tekton.dev/docs/pipelines/bundle-resolver/ + - GCB repo resolver. + - >- + Simple Git resolver. + https://tekton.dev/docs/pipelines/git-resolver/ + - Developer Connect resolver. + - Default resolver. + enum: + - RESOLVER_NAME_UNSPECIFIED + - BUNDLES + - GCB_REPO + - GIT + - DEVELOPER_CONNECT + - DEFAULT + params: + description: Optional. Parameters used to control the resolution. type: array - nextPageToken: + items: + $ref: '#/components/schemas/Param' + Param: + id: Param + description: >- + Param defined with name and value. PipelineRef can be used to refer to a + specific instance of a Pipeline. + type: object + properties: + name: + description: Name of the parameter. type: string - description: The standard List next-page token. + value: + description: Value of the parameter. + $ref: '#/components/schemas/ParamValue' + TaskResult: + id: TaskResult + description: TaskResult is used to describe the results of a task. type: object - description: The response message for Locations.ListLocations. - OAuthCredential: - description: >- - Represents an OAuth token of the account that authorized the Connection, - and associated metadata. - id: OAuthCredential properties: - username: - readOnly: true - description: Output only. The username associated to this token. + name: + description: Name of the result. type: string - oauthTokenSecretVersion: + description: + description: Description of the result. + type: string + type: + description: The type of data that the result holds. type: string + enumDescriptions: + - Default enum type; should not be used. + - Default + - Array type + - Object type + enum: + - TYPE_UNSPECIFIED + - STRING + - ARRAY + - OBJECT + properties: + description: >- + When type is OBJECT, this map holds the names of fields inside that + object along with the type of data each field holds. + type: object + additionalProperties: + $ref: '#/components/schemas/PropertySpec' + value: description: >- - Optional. A SecretManager resource containing the OAuth token that - authorizes the Cloud Build connection. Format: - `projects/*/secrets/*/versions/*`. + Optional. Optionally used to initialize a Task's result with a + Step's result. + $ref: '#/components/schemas/ParamValue' + PropertySpec: + id: PropertySpec + description: PropertySpec holds information about a property in an object. type: object + properties: + type: + description: A type for the object. + type: string + enumDescriptions: + - Default enum type; should not be used. + - Default + enum: + - TYPE_UNSPECIFIED + - STRING WorkspaceDeclaration: + id: WorkspaceDeclaration + description: WorkspaceDeclaration is a declaration of a volume that a Task requires. + type: object properties: - description: + name: + description: Name is the name by which you can bind the volume at runtime. type: string + description: description: Description is a human readable description of this volume. - name: type: string - description: Name is the name by which you can bind the volume at runtime. + mountPath: + description: >- + MountPath overrides the directory that the volume will be made + available at. + type: string readOnly: - type: boolean description: ReadOnly dictates whether a mounted volume is writable. + type: boolean optional: description: >- Optional. Optional marks a Workspace as not being required in TaskRuns. By default this field is false and so declared workspaces are required. type: boolean - mountPath: - type: string - description: >- - MountPath overrides the directory that the volume will be made - available at. + Sidecar: + id: Sidecar + description: Sidecars run alongside the Task's step containers. type: object - id: WorkspaceDeclaration - description: WorkspaceDeclaration is a declaration of a volume that a Task requires. - Repository: properties: - webhookId: + name: + description: Name of the Sidecar. type: string - readOnly: true - description: Output only. External ID of the webhook created for the repository. - remoteUri: + image: + description: Docker image name. type: string - description: Required. Git Clone HTTPS URI. - updateTime: - description: >- - Output only. Server assigned timestamp for when the connection was - updated. - format: google-datetime + args: + description: Arguments to the entrypoint. + type: array + items: + type: string + command: + description: Entrypoint array. + type: array + items: + type: string + workingDir: + description: Container's working directory. type: string - readOnly: true - annotations: - type: object - description: Optional. Allows clients to store small amounts of arbitrary data. - additionalProperties: + env: + description: List of environment variables to set in the container. + type: array + items: + $ref: '#/components/schemas/EnvVar' + script: + description: The contents of an executable file to execute. + type: string + volumeMounts: + description: Pod volumes to mount into the container's filesystem. + type: array + items: + $ref: '#/components/schemas/VolumeMount' + securityContext: + description: Optional. Security options the container should be run with. + $ref: '#/components/schemas/SecurityContext' + readinessProbe: + description: >- + Optional. Periodic probe of Sidecar service readiness. Container + will be removed from service endpoints if the probe fails. Cannot be + updated. More info: + https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +optional + $ref: '#/components/schemas/Probe' + Probe: + id: Probe + description: >- + Probe describes a health check to be performed against a container to + determine whether it is alive or ready to receive traffic. + type: object + properties: + exec: + description: Optional. Exec specifies the action to take. +optional + $ref: '#/components/schemas/ExecAction' + periodSeconds: + description: >- + Optional. How often (in seconds) to perform the probe. Default to 10 + seconds. Minimum value is 1. +optional + type: integer + format: int32 + ExecAction: + id: ExecAction + description: ExecAction describes a "run in container" action. + type: object + properties: + command: + description: >- + Optional. Command is the command line to execute inside the + container, the working directory for the command is root ('/') in + the container's filesystem. The command is simply exec'd, it is not + run inside a shell, so traditional shell instructions ('|', etc) + won't work. To use a shell, you need to explicitly call out to that + shell. Exit status of 0 is treated as live/healthy and non-zero is + unhealthy. +optional + type: array + items: type: string + VolumeSource: + id: VolumeSource + description: Volumes available to mount. + type: object + properties: name: + description: >- + Name of the Volume. Must be a DNS_LABEL and unique within the pod. + More info: + https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names type: string + emptyDir: + description: A temporary directory that shares a pod's lifetime. + $ref: '#/components/schemas/EmptyDirVolumeSource' + EmptyDirVolumeSource: + id: EmptyDirVolumeSource + description: Represents an empty Volume source. + type: object + properties: {} + StepTemplate: + id: StepTemplate + description: >- + StepTemplate can be used as the basis for all step containers within the + Task, so that the steps inherit settings on the base container. + type: object + properties: + env: description: >- - Immutable. Resource name of the repository, in the format - `projects/*/locations/*/connections/*/repositories/*`. - createTime: - format: google-datetime - readOnly: true + Optional. List of environment variables to set in the Step. Cannot + be updated. + type: array + items: + $ref: '#/components/schemas/EnvVar' + volumeMounts: + description: Optional. Pod volumes to mount into the container's filesystem. + type: array + items: + $ref: '#/components/schemas/VolumeMount' + TaskRef: + id: TaskRef + description: >- + TaskRef can be used to refer to a specific instance of a task. + PipelineRef can be used to refer to a specific instance of a Pipeline. + type: object + properties: + name: + description: Optional. Name of the task. type: string + resolver: description: >- - Output only. Server assigned timestamp for when the connection was - created. - etag: + Resolver is the name of the resolver that should perform resolution + of the referenced Tekton resource. type: string + enumDescriptions: + - Default enum type; should not be used. + - >- + Bundles resolver. + https://tekton.dev/docs/pipelines/bundle-resolver/ + - GCB repo resolver. + - >- + Simple Git resolver. + https://tekton.dev/docs/pipelines/git-resolver/ + - Developer Connect resolver. + - Default resolver. + enum: + - RESOLVER_NAME_UNSPECIFIED + - BUNDLES + - GCB_REPO + - GIT + - DEVELOPER_CONNECT + - DEFAULT + params: description: >- - This checksum is computed by the server based on the value of other - fields, and may be sent on update and delete requests to ensure the - client has an up-to-date value before proceeding. - type: object - id: Repository - description: A repository associated to a parent connection. - PropertySpec: - id: PropertySpec + Params contains the parameters used to identify the referenced + Tekton resource. Example entries might include "repo" or "path" but + the set of params ultimately depends on the chosen resolver. + type: array + items: + $ref: '#/components/schemas/Param' + WhenExpression: + id: WhenExpression + description: Conditions that need to be true for the task to run. type: object - description: PropertySpec holds information about a property in an object. properties: - type: + input: + description: >- + Input is the string for guard checking which can be a static input + or an output from a parent Task. + type: string + expressionOperator: + description: Operator that represents an Input's relationship to the values type: string - enum: - - TYPE_UNSPECIFIED - - STRING enumDescriptions: - Default enum type; should not be used. - - Default - description: A type for the object. - FetchReadWriteTokenResponse: + - Input is in values. + - Input is not in values. + enum: + - EXPRESSION_OPERATOR_UNSPECIFIED + - IN + - NOT_IN + values: + description: >- + Values is an array of strings, which is compared against the input, + for guard checking. + type: array + items: + type: string + WorkspacePipelineTaskBinding: + id: WorkspacePipelineTaskBinding + description: >- + WorkspacePipelineTaskBinding maps workspaces from the PipelineSpec to + the workspaces declared in the Task. type: object properties: - expirationTime: - description: Expiration timestamp. Can be empty if unknown or non-expiring. - format: google-datetime + name: + description: Name of the workspace as declared by the task. type: string - token: + workspace: + description: Name of the workspace declared by the pipeline. type: string - description: The token content. - description: Message for responding to get read/write token. - id: FetchReadWriteTokenResponse - OperationMetadata: - id: OperationMetadata - description: Represents the metadata of the long-running operation. + subPath: + description: >- + Optional. SubPath is optionally a directory on the volume which + should be used for this binding (i.e. the volume will be mounted at + this sub directory). +optional + type: string + PipelineWorkspaceDeclaration: + id: PipelineWorkspaceDeclaration + description: >- + Workspaces declares a set of named workspaces that are expected to be + provided by a PipelineRun. type: object properties: - endTime: - readOnly: true - format: google-datetime - description: Output only. The time the operation finished running. + name: + description: Name is the name of a workspace to be provided by a PipelineRun. type: string - createTime: - format: google-datetime - description: Output only. The time the operation was created. + description: + description: >- + Description is a human readable string describing how the workspace + will be used in the Pipeline. type: string + optional: + description: >- + Optional marks a Workspace as not being required in PipelineRuns. By + default this field is false and so declared workspaces are required. + type: boolean + PipelineResult: + id: PipelineResult + description: A value produced by a Pipeline. + type: object + properties: + name: + description: Output only. Name of the result. readOnly: true - statusDetail: type: string - description: Output only. Human-readable status of the operation, if any. - readOnly: true - target: + description: + description: Output only. Description of the result. readOnly: true type: string - description: >- - Output only. Server-defined resource path for the target of the - operation. - apiVersion: - type: string + type: + description: Output only. The type of data that the result holds. readOnly: true - description: Output only. API version used to start the operation. - verb: type: string + enumDescriptions: + - Default enum type; should not be used. + - Default + - Array type + - Object type + enum: + - TYPE_UNSPECIFIED + - STRING + - ARRAY + - OBJECT + value: + description: Output only. Value of the result. readOnly: true - description: Output only. Name of the verb executed by the operation. - cancelRequested: - readOnly: true - description: >- - Output only. Identifies whether the user has requested cancellation - of the operation. Operations that have been cancelled successfully - have Operation.error value with a google.rpc.Status.code of 1, - corresponding to `Code.CANCELLED`. - type: boolean - Status: - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - properties: - message: - type: string - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - code: - type: integer - description: The status code, which should be an enum value of google.rpc.Code. - format: int32 - details: - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - type: array + $ref: '#/components/schemas/ResultValue' + ResultValue: + id: ResultValue + description: ResultValue holds different types of data for a single result. type: object - id: Status - HttpBody: - id: HttpBody - description: >- - Message that represents an arbitrary HTTP body. It should only be used - for payload formats that can't be represented as JSON, such as raw - binary or an HTML page. This message can be used both in streaming and - non-streaming API methods in the request as well as the response. It can - be used as a top-level request field, which is convenient if one wants - to extract parameters from either the URL or HTTP template into the - request fields and also want access to the raw HTTP body. Example: - message GetResourceRequest { // A unique request id. string request_id = - 1; // The raw HTTP body is bound to this field. google.api.HttpBody - http_body = 2; } service ResourceService { rpc - GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc - UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } - Example with streaming methods: service CaldavService { rpc - GetCalendar(stream google.api.HttpBody) returns (stream - google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) - returns (stream google.api.HttpBody); } Use of this type only changes - how the request and response bodies are handled, all other features will - continue to work unchanged. properties: - contentType: - type: string - description: >- - The HTTP Content-Type header value specifying the content type of - the body. - data: - description: The HTTP request/response body as raw binary. + stringVal: + description: Value of the result if type is string. type: string - format: byte - extensions: - items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object + arrayVal: + description: Value of the result if type is array. type: array - description: >- - Application specific response metadata. Must be set in the first - response for streaming APIs. - type: object - InstallationState: + items: + type: string + objectVal: + description: Value of the result if type is object. + type: object + additionalProperties: + type: string + type: + description: Output only. The type of data that the result holds. + readOnly: true + type: string + enumDescriptions: + - Default enum type; should not be used. + - Default + - Array type + - Object type + enum: + - TYPE_UNSPECIFIED + - STRING + - ARRAY + - OBJECT + PipelineRef: + id: PipelineRef + description: PipelineRef can be used to refer to a specific instance of a Pipeline. type: object properties: - actionUri: + name: + description: Optional. Name of the Pipeline. type: string - readOnly: true + resolver: description: >- - Output only. Link to follow for next action. Empty string if the - installation is already complete. - stage: - enum: - - STAGE_UNSPECIFIED - - PENDING_CREATE_APP - - PENDING_USER_OAUTH - - PENDING_INSTALL_APP - - COMPLETE - readOnly: true + Resolver is the name of the resolver that should perform resolution + of the referenced Tekton resource. + type: string enumDescriptions: - - No stage specified. + - Default enum type; should not be used. - >- - Only for GitHub Enterprise. An App creation has been requested. - The user needs to confirm the creation in their GitHub enterprise - host. - - User needs to authorize the GitHub (or Enterprise) App via OAuth. + Bundles resolver. + https://tekton.dev/docs/pipelines/bundle-resolver/ + - GCB repo resolver. - >- - User needs to follow the link to install the GitHub (or - Enterprise) App. - - Installation process has been completed. - description: Output only. Current step of the installation process. - type: string - message: - readOnly: true + Simple Git resolver. + https://tekton.dev/docs/pipelines/git-resolver/ + - Developer Connect resolver. + - Default resolver. + enum: + - RESOLVER_NAME_UNSPECIFIED + - BUNDLES + - GCB_REPO + - GIT + - DEVELOPER_CONNECT + - DEFAULT + params: description: >- - Output only. Message of what the user should do next to continue the - installation. Empty string if the installation is already complete. - type: string + Params contains the parameters used to identify the referenced + Tekton resource. Example entries might include "repo" or "path" but + the set of params ultimately depends on the chosen resolver. + type: array + items: + $ref: '#/components/schemas/Param' + WorkspaceBinding: + id: WorkspaceBinding description: >- - Describes stage and necessary actions to be taken by the user to - complete the installation. Used for GitHub and GitHub Enterprise based - connections. - id: InstallationState - TimeoutFields: + WorkspaceBinding maps a workspace to a Volume. PipelineRef can be used + to refer to a specific instance of a Pipeline. + type: object properties: - tasks: - format: google-duration - type: string - description: Tasks sets the maximum allowed duration of this pipeline's tasks - finally: - description: Finally sets the maximum allowed duration of this pipeline's finally + name: + description: Name of the workspace. type: string - format: google-duration - pipeline: - format: google-duration + secret: + description: Secret Volume Source. + $ref: '#/components/schemas/SecretVolumeSource' + subPath: description: >- - Pipeline sets the maximum allowed duration for execution of the - entire pipeline. The sum of individual timeouts for tasks and - finally must not exceed this value. + Optional. SubPath is optionally a directory on the volume which + should be used for this binding (i.e. the volume will be mounted at + this sub directory). +optional type: string - description: >- - TimeoutFields allows granular specification of pipeline, task, and - finally timeouts - id: TimeoutFields - type: object - TaskSpec: - description: TaskSpec contains the Spec to instantiate a TaskRun. - id: TaskSpec + SecretVolumeSource: + id: SecretVolumeSource + description: Secret Volume Source. type: object properties: - params: - items: - $ref: '#/components/schemas/ParamSpec' - type: array - description: List of parameters. - volumes: - type: array - description: A collection of volumes that are available to mount into steps. - items: - $ref: '#/components/schemas/VolumeSource' - steps: - description: Steps of the task. - items: - $ref: '#/components/schemas/Step' - type: array - workspaces: - description: The volumes that this Task requires. - type: array - items: - $ref: '#/components/schemas/WorkspaceDeclaration' - sidecars: - items: - $ref: '#/components/schemas/Sidecar' - description: Sidecars that run alongside the Task's step containers. - type: array - results: - type: array - items: - $ref: '#/components/schemas/TaskResult' - description: Values that this Task can output. - managedSidecars: - items: - type: string - enum: - - MANAGED_SIDECAR_UNSPECIFIED - - PRIVILEGED_DOCKER_DAEMON - enumDescriptions: - - Default enum type; should not be used. - - Sidecar for a privileged docker daemon. - type: array - description: >- - Sidecars that run alongside the Task’s step containers that should - be added to this Task. - description: + secretName: + description: Name of the secret referenced by the WorkspaceBinding. type: string - description: Description of the task. - stepTemplate: - $ref: '#/components/schemas/StepTemplate' + secretVersion: description: >- - Optional. StepTemplate can be used as the basis for all step - containers within the Task, so that the steps inherit settings on - the base container. + Optional. Resource name of the SecretVersion. In format: + projects/*/secrets/*/versions/* + type: string GoogleDevtoolsCloudbuildV2Condition: id: GoogleDevtoolsCloudbuildV2Condition description: Conditions defines a readiness condition for a Knative resource. type: object properties: type: - type: string description: Type of condition. - reason: - description: The reason for the condition's last transition. type: string status: description: Status of the condition. @@ -2222,253 +2257,213 @@ components: - UNKNOWN - 'TRUE' - 'FALSE' - lastTransitionTime: - format: google-datetime - description: >- - LastTransitionTime is the last time the condition transitioned from - one status to another. - type: string severity: + description: Severity with which to treat failures of this type of condition. type: string enumDescriptions: - Default enum type; should not be used. - Severity is warning. - Severity is informational only. - description: Severity with which to treat failures of this type of condition. enum: - SEVERITY_UNSPECIFIED - WARNING - INFO - message: - description: A human readable message indicating details about the transition. - type: string - Expr: - id: 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. - type: object - properties: - title: - type: string - 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. - description: - type: string - description: >- - Optional. Description of the expression. This is a longer text which - describes the expression, e.g. when hovered over it in a UI. - expression: - type: string - description: >- - Textual representation of an expression in Common Expression - Language syntax. - 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 - EmptyDirVolumeSource: - id: EmptyDirVolumeSource - type: object - properties: {} - description: Represents an empty Volume source. - 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: - type: array - description: The configuration for logging of each type of permission. - items: - $ref: '#/components/schemas/AuditLogConfig' - service: - type: string - 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. - id: AuditConfig - type: object - SecurityContext: - type: object - description: Security options the container should be run with. - properties: - runAsGroup: + lastTransitionTime: description: >- - Optional. The GID to run the entrypoint of the container process. - Uses runtime default if unset. May also be set in - PodSecurityContext. If set in both SecurityContext and - PodSecurityContext, the value specified in SecurityContext takes - precedence. Note that this field cannot be set when spec.os.name is - windows. +optional + LastTransitionTime is the last time the condition transitioned from + one status to another. type: string - format: int64 - allowPrivilegeEscalation: - description: >- - Optional. AllowPrivilegeEscalation controls whether a process can - gain more privileges than its parent process. This bool directly - controls if the no_new_privs flag will be set on the container - process. AllowPrivilegeEscalation is true always when the container - is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field - cannot be set when spec.os.name is windows. +optional - type: boolean - privileged: - description: Run container in privileged mode. - type: boolean - runAsNonRoot: - type: boolean - description: >- - Optional. Indicates that the container must run as a non-root user. - If true, the Kubelet will validate the image at runtime to ensure - that it does not run as UID 0 (root) and fail to start the container - if it does. If unset or false, no such validation will be performed. - May also be set in PodSecurityContext. If set in both - SecurityContext and PodSecurityContext, the value specified in - SecurityContext takes precedence. +optional - runAsUser: + format: google-datetime + reason: + description: The reason for the condition's last transition. type: string - description: >- - Optional. The UID to run the entrypoint of the container process. - Defaults to user specified in image metadata if unspecified. May - also be set in PodSecurityContext. If set in both SecurityContext - and PodSecurityContext, the value specified in SecurityContext takes - precedence. Note that this field cannot be set when spec.os.name is - windows. +optional - format: int64 - capabilities: - $ref: '#/components/schemas/Capabilities' - description: >- - Optional. Adds and removes POSIX capabilities from running - containers. - id: SecurityContext - Probe: - id: Probe - description: >- - Probe describes a health check to be performed against a container to - determine whether it is alive or ready to receive traffic. - type: object - properties: - exec: - $ref: '#/components/schemas/ExecAction' - description: Optional. Exec specifies the action to take. +optional - periodSeconds: - description: >- - Optional. How often (in seconds) to perform the probe. Default to 10 - seconds. Minimum value is 1. +optional - format: int32 - type: integer - WhenExpression: - description: Conditions that need to be true for the task to run. - id: WhenExpression + message: + description: A human readable message indicating details about the transition. + type: string + ChildStatusReference: + id: ChildStatusReference + description: >- + ChildStatusReference is used to point to the statuses of individual + TaskRuns and Runs within this PipelineRun. + type: object properties: - values: - items: - type: string + name: + description: Name is the name of the TaskRun or Run this is referencing. + type: string + pipelineTaskName: description: >- - Values is an array of strings, which is compared against the input, - for guard checking. + PipelineTaskName is the name of the PipelineTask this is + referencing. + type: string + whenExpressions: + description: >- + WhenExpressions is the list of checks guarding the execution of the + PipelineTask type: array - expressionOperator: - description: Operator that represents an Input's relationship to the values - enum: - - EXPRESSION_OPERATOR_UNSPECIFIED - - IN - - NOT_IN + items: + $ref: '#/components/schemas/WhenExpression' + type: + description: Output only. Type of the child reference. + readOnly: true + type: string enumDescriptions: - Default enum type; should not be used. - - Input is in values. - - Input is not in values. - type: string - input: + - TaskRun. + enum: + - TYPE_UNSPECIFIED + - TASK_RUN + TimeoutFields: + id: TimeoutFields + description: >- + TimeoutFields allows granular specification of pipeline, task, and + finally timeouts + type: object + properties: + pipeline: description: >- - Input is the string for guard checking which can be a static input - or an output from a parent Task. + Pipeline sets the maximum allowed duration for execution of the + entire pipeline. The sum of individual timeouts for tasks and + finally must not exceed this value. type: string - type: object - PipelineWorkspaceDeclaration: + format: google-duration + tasks: + description: Tasks sets the maximum allowed duration of this pipeline's tasks + type: string + format: google-duration + finally: + description: Finally sets the maximum allowed duration of this pipeline's finally + type: string + format: google-duration + SkippedTask: + id: SkippedTask description: >- - Workspaces declares a set of named workspaces that are expected to be - provided by a PipelineRun. + SkippedTask is used to describe the Tasks that were skipped due to their + When Expressions evaluating to False. + type: object properties: name: - description: Name is the name of a workspace to be provided by a PipelineRun. + description: Name is the Pipeline Task name type: string - optional: - type: boolean + whenExpressions: description: >- - Optional marks a Workspace as not being required in PipelineRuns. By - default this field is false and so declared workspaces are required. - description: + WhenExpressions is the list of checks guarding the execution of the + PipelineTask + type: array + items: + $ref: '#/components/schemas/WhenExpression' + reason: + description: Output only. Reason is the cause of the PipelineTask being skipped. + readOnly: true type: string - description: >- - Description is a human readable string describing how the workspace - will be used in the Pipeline. + Worker: + id: Worker + description: Configuration for the worker. type: object - id: PipelineWorkspaceDeclaration - ExecAction: properties: - command: - items: - type: string - type: array - description: >- - Optional. Command is the command line to execute inside the - container, the working directory for the command is root ('/') in - the container's filesystem. The command is simply exec'd, it is not - run inside a shell, so traditional shell instructions ('|', etc) - won't work. To use a shell, you need to explicitly call out to that - shell. Exit status of 0 is treated as live/healthy and non-zero is - unhealthy. +optional - description: ExecAction describes a "run in container" action. + machineType: + description: Optional. Machine type of a worker, default is "e2-standard-2". + type: string + Security: + id: Security + description: Security configuration. type: object - id: ExecAction + properties: + serviceAccount: + description: IAM service account whose credentials will be used at runtime. + type: string + privilegeMode: + description: Optional. Privilege mode. + deprecated: true + type: string + enumDescriptions: + - Default to PRIVILEGED. + - Privileged mode. + - Unprivileged mode. + enum: + - PRIVILEGE_MODE_UNSPECIFIED + - PRIVILEGED + - UNPRIVILEGED + Provenance: + id: Provenance + description: Provenance configuration. + type: object + properties: + enabled: + description: Optional. Provenance push mode. + type: string + enumDescriptions: + - Default to disabled (before AA regionalization), optimistic after + - Provenance failures would fail the run + - >- + GCB will attempt to push to artifact analaysis and build state + would not be impacted by the push failures. + - Disable the provenance push entirely. + enum: + - ENABLED_UNSPECIFIED + - REQUIRED + - OPTIMISTIC + - DISABLED + storage: + description: Optional. Where provenance is stored. + type: string + enumDescriptions: + - Default PREFER_ARTIFACT_PROJECT. + - >- + GCB will attempt to push provenance to the artifact project. If it + is not available, fallback to build project. + - Only push to artifact project. + - Only push to build project. + enum: + - STORAGE_UNSPECIFIED + - PREFER_ARTIFACT_PROJECT + - ARTIFACT_PROJECT_ONLY + - BUILD_PROJECT_ONLY + region: + description: Optional. Provenance region. + type: string + enumDescriptions: + - >- + The PipelineRun/TaskRun/Workflow will be rejected. Update this + comment to push to the same region as the run in Artifact Analysis + when it's regionalized. + - Push provenance to Artifact Analysis in global region. + enum: + - REGION_UNSPECIFIED + - GLOBAL + PipelineRunResult: + id: PipelineRunResult + description: PipelineRunResult used to describe the results of a pipeline + type: object + properties: + name: + description: Output only. Name of the TaskRun + readOnly: true + type: string + value: + description: Output only. Value of the result. + readOnly: true + $ref: '#/components/schemas/ResultValue' parameters: - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + access_token: + description: OAuth access token. in: query - name: uploadType + name: access_token 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. + alt: + description: Data format for response. in: query - name: key + name: alt + schema: + type: string + enum: + - json + - media + - proto + callback: + description: JSONP + in: query + name: callback schema: type: string fields: @@ -2477,32 +2472,34 @@ components: name: fields schema: type: string - oauth_token: - description: OAuth 2.0 token for the current user. + 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: oauth_token + name: key schema: type: string - alt: - description: Data format for response. + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: alt + name: oauth_token schema: type: string - enum: - - json - - media - - proto prettyPrint: description: Returns response with indentations and line breaks. in: query name: prettyPrint schema: type: boolean - access_token: - description: OAuth access token. + 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: access_token + name: quotaUser schema: type: string upload_protocol: @@ -2511,13 +2508,10 @@ components: name: upload_protocol schema: type: string - 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. + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: quotaUser + name: uploadType schema: type: string _.xgafv: @@ -2529,29 +2523,51 @@ components: enum: - '1' - '2' - callback: - description: JSONP - in: query - name: callback - schema: - type: string x-stackQL-resources: + locations: + id: google.cloudbuild.locations + name: locations + title: Locations + methods: + projects_locations_list: + operation: + $ref: '#/paths/~1v2~1projects~1{projectsId}~1locations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.locations + projects_locations_get: + operation: + $ref: '#/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/locations/methods/projects_locations_get + - $ref: >- + #/components/x-stackQL-resources/locations/methods/projects_locations_list + insert: [] + update: [] + replace: [] + delete: [] operations: id: google.cloudbuild.operations name: operations title: Operations methods: - projects_locations_operations_cancel: + projects_locations_operations_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_operations_get: + projects_locations_operations_cancel: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' @@ -2563,93 +2579,86 @@ components: update: [] replace: [] delete: [] - repositories: - id: google.cloudbuild.repositories - name: repositories - title: Repositories + connections: + id: google.cloudbuild.connections + name: connections + title: Connections methods: - projects_locations_connections_repositories_get: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories~1{repositoriesId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_connections_repositories_delete: + projects_locations_connections_create: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories~1{repositoriesId}/delete + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_connections_repositories_batch_create: + projects_locations_connections_list: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories:batchCreate/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_connections_repositories_create: + objectKey: $.connections + projects_locations_connections_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_connections_repositories_list: + projects_locations_connections_patch: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}/patch response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.repositories - projects_locations_connections_repositories_access_read_token: + projects_locations_connections_delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories~1{repositoriesId}:accessReadToken/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_connections_repositories_access_read_write_token: + projects_locations_connections_process_webhook: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories~1{repositoriesId}:accessReadWriteToken/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections:processWebhook/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/repositories/methods/projects_locations_connections_repositories_get + #/components/x-stackQL-resources/connections/methods/projects_locations_connections_get - $ref: >- - #/components/x-stackQL-resources/repositories/methods/projects_locations_connections_repositories_list + #/components/x-stackQL-resources/connections/methods/projects_locations_connections_list insert: - $ref: >- - #/components/x-stackQL-resources/repositories/methods/projects_locations_connections_repositories_batch_create + #/components/x-stackQL-resources/connections/methods/projects_locations_connections_create + update: - $ref: >- - #/components/x-stackQL-resources/repositories/methods/projects_locations_connections_repositories_create - update: [] + #/components/x-stackQL-resources/connections/methods/projects_locations_connections_patch replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/repositories/methods/projects_locations_connections_repositories_delete - repositories_git_refs: - id: google.cloudbuild.repositories_git_refs - name: repositories_git_refs - title: Repositories_git_refs + #/components/x-stackQL-resources/connections/methods/projects_locations_connections_delete + connections_linkable_repositories: + id: google.cloudbuild.connections_linkable_repositories + name: connections_linkable_repositories + title: Connections_linkable_repositories methods: - projects_locations_connections_repositories_fetch_git_refs: + projects_locations_connections_fetch_linkable_repositories: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories~1{repositoriesId}:fetchGitRefs/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}:fetchLinkableRepositories/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/repositories_git_refs/methods/projects_locations_connections_repositories_fetch_git_refs + #/components/x-stackQL-resources/connections_linkable_repositories/methods/projects_locations_connections_fetch_linkable_repositories insert: [] update: [] replace: [] @@ -2659,10 +2668,10 @@ components: name: connections_iam_policies title: Connections_iam_policies methods: - projects_locations_connections_test_iam_permissions: + projects_locations_connections_set_iam_policy: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}:testIamPermissions/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' @@ -2674,10 +2683,10 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_connections_set_iam_policy: + projects_locations_connections_test_iam_permissions: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}:setIamPolicy/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}:testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' @@ -2691,149 +2700,154 @@ components: - $ref: >- #/components/x-stackQL-resources/connections_iam_policies/methods/projects_locations_connections_set_iam_policy delete: [] - connections: - id: google.cloudbuild.connections - name: connections - title: Connections + repositories: + id: google.cloudbuild.repositories + name: repositories + title: Repositories methods: - projects_locations_connections_delete: + projects_locations_connections_repositories_create: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}/delete + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_connections_patch: + projects_locations_connections_repositories_list: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}/patch + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_connections_get: + objectKey: $.repositories + projects_locations_connections_repositories_batch_create: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories:batchCreate/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_connections_list: + projects_locations_connections_repositories_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories~1{repositoriesId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.connections - projects_locations_connections_create: + projects_locations_connections_repositories_delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories~1{repositoriesId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_connections_process_webhook: + projects_locations_connections_repositories_access_read_write_token: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections:processWebhook/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories~1{repositoriesId}:accessReadWriteToken/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_connections_repositories_access_read_token: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories~1{repositoriesId}:accessReadToken/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/connections/methods/projects_locations_connections_get + #/components/x-stackQL-resources/repositories/methods/projects_locations_connections_repositories_get - $ref: >- - #/components/x-stackQL-resources/connections/methods/projects_locations_connections_list + #/components/x-stackQL-resources/repositories/methods/projects_locations_connections_repositories_list insert: - $ref: >- - #/components/x-stackQL-resources/connections/methods/projects_locations_connections_create - update: + #/components/x-stackQL-resources/repositories/methods/projects_locations_connections_repositories_create - $ref: >- - #/components/x-stackQL-resources/connections/methods/projects_locations_connections_patch + #/components/x-stackQL-resources/repositories/methods/projects_locations_connections_repositories_batch_create + update: [] replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/connections/methods/projects_locations_connections_delete - connections_linkable_repositories: - id: google.cloudbuild.connections_linkable_repositories - name: connections_linkable_repositories - title: Connections_linkable_repositories + #/components/x-stackQL-resources/repositories/methods/projects_locations_connections_repositories_delete + repositories_git_refs: + id: google.cloudbuild.repositories_git_refs + name: repositories_git_refs + title: Repositories_git_refs methods: - projects_locations_connections_fetch_linkable_repositories: + projects_locations_connections_repositories_fetch_git_refs: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}:fetchLinkableRepositories/get - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/connections_linkable_repositories/methods/projects_locations_connections_fetch_linkable_repositories - insert: [] - update: [] - replace: [] - delete: [] - locations: - id: google.cloudbuild.locations - name: locations - title: Locations - methods: - projects_locations_get: - operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_list: - operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1locations/get' + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories~1{repositoriesId}:fetchGitRefs/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.locations sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/locations/methods/projects_locations_get - - $ref: >- - #/components/x-stackQL-resources/locations/methods/projects_locations_list + #/components/x-stackQL-resources/repositories_git_refs/methods/projects_locations_connections_repositories_fetch_git_refs insert: [] update: [] replace: [] delete: [] paths: - /v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: + /v2/projects/{projectsId}/locations: parameters: &ref_1 - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/callback' - post: - description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: cloudbuild.projects.locations.operations.cancel - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CancelOperationRequest' + get: + description: Lists information about the supported locations for this service. + operationId: cloudbuild.projects.locations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListLocationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: extraLocationTypes + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}: + parameters: *ref_1 + get: + description: Gets information about a location. + operationId: cloudbuild.projects.locations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2845,7 +2859,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/Location' parameters: - in: path name: projectsId @@ -2857,11 +2871,6 @@ paths: required: true schema: type: string - - in: path - name: operationsId - required: true - schema: - type: string /v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: parameters: *ref_1 get: @@ -2898,11 +2907,25 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories/{repositoriesId}: + /v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: parameters: *ref_1 - get: - description: Gets details of a single repository. - operationId: cloudbuild.projects.locations.connections.repositories.get + post: + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + `1`, corresponding to `Code.CANCELLED`. + operationId: cloudbuild.projects.locations.operations.cancel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CancelOperationRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2914,7 +2937,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Repository' + $ref: '#/components/schemas/Empty' parameters: - in: path name: projectsId @@ -2927,18 +2950,20 @@ paths: schema: type: string - in: path - name: connectionsId - required: true - schema: - type: string - - in: path - name: repositoriesId + name: operationsId required: true schema: type: string - delete: - description: Deletes a single repository. - operationId: cloudbuild.projects.locations.connections.repositories.delete + /v2/projects/{projectsId}/locations/{locationsId}/connections: + parameters: *ref_1 + post: + description: Creates a Connection. + operationId: cloudbuild.projects.locations.connections.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Connection' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2962,34 +2987,54 @@ paths: required: true schema: type: string + - in: query + name: connectionId + schema: + type: string + get: + description: Lists Connections in a given project and location. + operationId: cloudbuild.projects.locations.connections.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListConnectionsResponse' + parameters: - in: path - name: connectionsId + name: projectsId required: true schema: type: string - in: path - name: repositoriesId + name: locationsId required: true schema: type: string - in: query - name: validateOnly + name: pageSize schema: - type: boolean + type: integer + format: int32 - in: query - name: etag + name: pageToken schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories:batchCreate: + - in: query + name: returnPartialSuccess + schema: + type: boolean + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}: parameters: *ref_1 - post: - description: Creates multiple repositories inside a connection. - operationId: cloudbuild.projects.locations.connections.repositories.batchCreate - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/BatchCreateRepositoriesRequest' + get: + description: Gets details of a single connection. + operationId: cloudbuild.projects.locations.connections.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3001,7 +3046,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Connection' parameters: - in: path name: projectsId @@ -3018,11 +3063,14 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories/{repositoriesId}:fetchGitRefs: - parameters: *ref_1 - get: - description: Fetch the list of branches or tags for a given repository. - operationId: cloudbuild.projects.locations.connections.repositories.fetchGitRefs + patch: + description: Updates a single connection. + operationId: cloudbuild.projects.locations.connections.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Connection' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3034,7 +3082,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FetchGitRefsResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -3051,34 +3099,22 @@ paths: required: true schema: type: string - - in: path - name: repositoriesId - required: true - schema: - type: string - in: query - name: refType + name: updateMask schema: type: string + format: google-fieldmask - in: query - name: pageToken + name: allowMissing schema: - type: string + type: boolean - in: query - name: pageSize + name: etag schema: - type: integer - format: int32 - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories: - parameters: *ref_1 - post: - description: Creates a Repository. - operationId: cloudbuild.projects.locations.connections.repositories.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Repository' + type: string + delete: + description: Deletes a single connection. + operationId: cloudbuild.projects.locations.connections.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3108,12 +3144,53 @@ paths: schema: type: string - in: query - name: repositoryId + name: etag + schema: + type: string + - in: query + name: validateOnly + schema: + type: boolean + /v2/projects/{projectsId}/locations/{locationsId}/connections:processWebhook: + parameters: *ref_1 + post: + description: ProcessWebhook is called by the external SCM for notifying of events. + operationId: cloudbuild.projects.locations.connections.processWebhook + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/HttpBody' + security: [] + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true schema: type: string + - in: query + name: webhookKey + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:fetchLinkableRepositories: + parameters: *ref_1 get: - description: Lists Repositories in a given connection. - operationId: cloudbuild.projects.locations.connections.repositories.list + description: >- + FetchLinkableRepositories get repositories from SCM that are accessible + and could be added to the connection. + operationId: cloudbuild.projects.locations.connections.fetchLinkableRepositories security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3125,7 +3202,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListRepositoriesResponse' + $ref: '#/components/schemas/FetchLinkableRepositoriesResponse' parameters: - in: path name: projectsId @@ -3151,20 +3228,19 @@ paths: name: pageToken schema: type: string - - in: query - name: filter - schema: - type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories/{repositoriesId}:accessReadToken: + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:setIamPolicy: parameters: *ref_1 post: - description: Fetches read token of a given repository. - operationId: cloudbuild.projects.locations.connections.repositories.accessReadToken + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and + `PERMISSION_DENIED` errors. + operationId: cloudbuild.projects.locations.connections.setIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/FetchReadTokenRequest' + $ref: '#/components/schemas/SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3176,7 +3252,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FetchReadTokenResponse' + $ref: '#/components/schemas/Policy' parameters: - in: path name: projectsId @@ -3193,22 +3269,13 @@ paths: required: true schema: type: string - - in: path - name: repositoriesId - required: true - schema: - type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories/{repositoriesId}:accessReadWriteToken: - parameters: *ref_1 - post: - description: Fetches read/write token of a given repository. - operationId: >- - cloudbuild.projects.locations.connections.repositories.accessReadWriteToken - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/FetchReadWriteTokenRequest' + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:getIamPolicy: + parameters: *ref_1 + get: + description: >- + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: cloudbuild.projects.locations.connections.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3220,7 +3287,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FetchReadWriteTokenResponse' + $ref: '#/components/schemas/Policy' parameters: - in: path name: projectsId @@ -3237,11 +3304,11 @@ paths: required: true schema: type: string - - in: path - name: repositoriesId - required: true + - in: query + name: options.requestedPolicyVersion schema: - type: string + type: integer + format: int32 /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:testIamPermissions: parameters: *ref_1 post: @@ -3285,11 +3352,16 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}: + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories: parameters: *ref_1 - delete: - description: Deletes a single connection. - operationId: cloudbuild.projects.locations.connections.delete + post: + description: Creates a Repository. + operationId: cloudbuild.projects.locations.connections.repositories.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Repository' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3319,21 +3391,12 @@ paths: schema: type: string - in: query - name: etag + name: repositoryId schema: type: string - - in: query - name: validateOnly - schema: - type: boolean - patch: - description: Updates a single connection. - operationId: cloudbuild.projects.locations.connections.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Connection' + get: + description: Lists Repositories in a given connection. + operationId: cloudbuild.projects.locations.connections.repositories.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3345,7 +3408,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/ListRepositoriesResponse' parameters: - in: path name: projectsId @@ -3363,21 +3426,32 @@ paths: schema: type: string - in: query - name: updateMask + name: pageSize schema: - type: string - format: google-fieldmask + type: integer + format: int32 - in: query - name: allowMissing + name: pageToken schema: - type: boolean + type: string - in: query - name: etag + name: filter schema: type: string - get: - description: Gets details of a single connection. - operationId: cloudbuild.projects.locations.connections.get + - in: query + name: returnPartialSuccess + schema: + type: boolean + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories:batchCreate: + parameters: *ref_1 + post: + description: Creates multiple repositories inside a connection. + operationId: cloudbuild.projects.locations.connections.repositories.batchCreate + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BatchCreateRepositoriesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3389,7 +3463,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Connection' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -3406,13 +3480,11 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:getIamPolicy: + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories/{repositoriesId}: parameters: *ref_1 get: - description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: cloudbuild.projects.locations.connections.getIamPolicy + description: Gets details of a single repository. + operationId: cloudbuild.projects.locations.connections.repositories.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3424,7 +3496,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Repository' parameters: - in: path name: projectsId @@ -3441,16 +3513,14 @@ paths: required: true schema: type: string - - in: query - name: options.requestedPolicyVersion + - in: path + name: repositoriesId + required: true schema: - type: integer - format: int32 - /v2/projects/{projectsId}/locations/{locationsId}/connections: - parameters: *ref_1 - get: - description: Lists Connections in a given project and location. - operationId: cloudbuild.projects.locations.connections.list + type: string + delete: + description: Deletes a single repository. + operationId: cloudbuild.projects.locations.connections.repositories.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3462,7 +3532,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListConnectionsResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -3474,63 +3544,35 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - post: - description: Creates a Connection. - operationId: cloudbuild.projects.locations.connections.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Connection' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - in: path - name: projectsId + name: connectionsId required: true schema: type: string - in: path - name: locationsId + name: repositoriesId required: true schema: type: string - in: query - name: connectionId + name: etag schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:setIamPolicy: + - in: query + name: validateOnly + schema: + type: boolean + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories/{repositoriesId}:accessReadWriteToken: parameters: *ref_1 post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - `PERMISSION_DENIED` errors. - operationId: cloudbuild.projects.locations.connections.setIamPolicy + description: Fetches read/write token of a given repository. + operationId: >- + cloudbuild.projects.locations.connections.repositories.accessReadWriteToken requestBody: content: application/json: schema: - $ref: '#/components/schemas/SetIamPolicyRequest' + $ref: '#/components/schemas/FetchReadWriteTokenRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3542,7 +3584,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/FetchReadWriteTokenResponse' parameters: - in: path name: projectsId @@ -3559,46 +3601,21 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections:processWebhook: + - in: path + name: repositoriesId + required: true + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories/{repositoriesId}:accessReadToken: parameters: *ref_1 post: - description: ProcessWebhook is called by the external SCM for notifying of events. - operationId: cloudbuild.projects.locations.connections.processWebhook + description: Fetches read token of a given repository. + operationId: cloudbuild.projects.locations.connections.repositories.accessReadToken requestBody: content: application/json: schema: - $ref: '#/components/schemas/HttpBody' - security: [] - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Empty' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: query - name: webhookKey - schema: - type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:fetchLinkableRepositories: - parameters: *ref_1 - get: - description: >- - FetchLinkableRepositories get repositories from SCM that are accessible - and could be added to the connection. - operationId: cloudbuild.projects.locations.connections.fetchLinkableRepositories + $ref: '#/components/schemas/FetchReadTokenRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3610,7 +3627,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FetchLinkableRepositoriesResponse' + $ref: '#/components/schemas/FetchReadTokenResponse' parameters: - in: path name: projectsId @@ -3627,20 +3644,16 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: repositoriesId + required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}: + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories/{repositoriesId}:fetchGitRefs: parameters: *ref_1 get: - description: Gets information about a location. - operationId: cloudbuild.projects.locations.get + description: Fetch the list of branches or tags for a given repository. + operationId: cloudbuild.projects.locations.connections.repositories.fetchGitRefs security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3652,7 +3665,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Location' + $ref: '#/components/schemas/FetchGitRefsResponse' parameters: - in: path name: projectsId @@ -3664,38 +3677,25 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations: - parameters: *ref_1 - get: - description: Lists information about the supported locations for this service. - operationId: cloudbuild.projects.locations.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/ListLocationsResponse' - parameters: - in: path - name: projectsId + name: connectionsId + required: true + schema: + type: string + - in: path + name: repositoriesId required: true schema: type: string + - in: query + name: refType + schema: + type: string - in: query name: pageSize schema: type: integer format: int32 - - in: query - name: filter - schema: - type: string - in: query name: pageToken schema: diff --git a/providers/src/googleapis.com/v00.00.00000/services/cloudcommerceprocurement.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudcommerceprocurement.yaml index f7bfb3b3..8bca36a2 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudcommerceprocurement.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudcommerceprocurement.yaml @@ -7,8 +7,8 @@ info: title: Cloud Commerce Partner Procurement API description: Partner API for the Cloud Commerce Procurement Service. version: v1 - x-discovery-doc-revision: '20241029' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250824' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/marketplace/docs/partners/ servers: @@ -34,131 +34,33 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - ApproveEntitlementRequest: - id: ApproveEntitlementRequest - properties: - entitlementMigrated: - type: string - description: >- - Optional. The resource name of the entitlement that was migrated, - with the format - `providers/{provider_id}/entitlements/{entitlement_id}`. Should only - be sent when resources have been migrated from entitlement_migrated - to the new entitlement. Optional. - properties: - additionalProperties: - type: string - description: >- - Set of properties that should be associated with the entitlement. - Optional. - deprecated: true - type: object + Account: + id: Account + description: >- + Represents an account that was established by the customer on the + service provider's system. type: object - description: Request message for [PartnerProcurementService.ApproveEntitlement[]. - RejectEntitlementPlanChangeRequest: properties: - reason: - type: string + name: description: >- - Free form text string explaining the rejection reason. Max allowed - length: 256 bytes. Longer strings will be truncated. - pendingPlanName: - description: Required. Name of the pending plan that is being rejected. + Output only. The resource name of the account. Account names have + the form `accounts/{account_id}`. type: string - id: RejectEntitlementPlanChangeRequest - type: object - description: >- - Request message for - PartnerProcurementService.RejectEntitlementPlanChange. - Approval: - description: An approval for some action on an account. - properties: updateTime: - description: Optional. The last update timestamp of the approval. - format: google-datetime - type: string - state: - enum: - - STATE_UNSPECIFIED - - PENDING - - APPROVED - - REJECTED - enumDescriptions: - - Sentinel value; do not use. - - >- - The approval is pending response from the provider. The approval - state can transition to Account.Approval.State.APPROVED or - Account.Approval.State.REJECTED. - - The approval has been granted by the provider. - - >- - The approval has been rejected by the provider. A provider may - choose to approve a previously rejected approval, so is it - possible to transition to Account.Approval.State.APPROVED. - description: Output only. The state of the approval. - type: string - name: - type: string - description: Output only. The name of the approval. - reason: - type: string - description: Output only. An explanation for the state of the approval. - type: object - id: Approval - SuspendEntitlementRequest: - description: >- - Request message for ParterProcurementService.SuspendEntitlement. This is - not yet supported. - type: object - id: SuspendEntitlementRequest - properties: - reason: + description: Output only. The last update timestamp. type: string - description: >- - A free-form reason string, explaining the reason for suspension - request. - RejectEntitlementRequest: - properties: - reason: + format: google-datetime + createTime: + description: Output only. The creation timestamp. type: string + format: google-datetime + provider: description: >- - Free form text string explaining the rejection reason. Max allowed - length: 256 bytes. Longer strings will be truncated. - type: object - id: RejectEntitlementRequest - description: Request message for PartnerProcurementService.RejectEntitlement. - ListEntitlementsResponse: - properties: - entitlements: - items: - $ref: '#/components/schemas/Entitlement' - type: array - description: The list of entitlements in this response. - nextPageToken: - type: string - description: The token for fetching the next page. - id: ListEntitlementsResponse - description: Response message for PartnerProcurementService.ListEntitlements. - type: object - ListAccountsResponse: - id: ListAccountsResponse - type: object - description: Response message for [PartnerProcurementService.ListAccounts[]. - properties: - accounts: - description: The list of accounts in this response. - items: - $ref: '#/components/schemas/Account' - type: array - nextPageToken: + Output only. The identifier of the service provider that this + account was created against. Each service provider is assigned a + unique provider value when they onboard with Cloud Commerce + platform. type: string - description: The token for fetching the next page. - Account: - type: object - id: Account - description: >- - Represents an account that was established by the customer on the - service provider's system. - properties: state: description: >- Output only. The state of the account. This is used to decide @@ -166,10 +68,6 @@ components: able to make purchases. An account might not be able to make a purchase if the billing account is suspended, for example. type: string - enum: - - ACCOUNT_STATE_UNSPECIFIED - - ACCOUNT_ACTIVATION_REQUESTED - - ACCOUNT_ACTIVE enumDescriptions: - >- Default state of the account. It's only set to this value when the @@ -183,207 +81,199 @@ components: The account is active and ready for use. The next possible states are: - Account getting deleted: After the user invokes delete from another API. - name: - description: >- - Output only. The resource name of the account. Account names have - the form `accounts/{account_id}`. - type: string - provider: + enum: + - ACCOUNT_STATE_UNSPECIFIED + - ACCOUNT_ACTIVATION_REQUESTED + - ACCOUNT_ACTIVE + inputProperties: description: >- - Output only. The identifier of the service provider that this - account was created against. Each service provider is assigned a - unique provider value when they onboard with Cloud Commerce - platform. - type: string + Output only. The custom properties that were collected from the user + to create this account. + deprecated: true + type: object + additionalProperties: + type: any + description: Properties of the object. approvals: - type: array - items: - $ref: '#/components/schemas/Approval' description: >- Output only. The approvals for this account. These approvals are used to track actions that are permitted or have been completed by a customer within the context of the provider. This might include a sign up flow or a provisioning step, for example, that the provider can admit to having happened. - updateTime: - format: google-datetime + type: array + items: + $ref: '#/components/schemas/Approval' + Approval: + id: Approval + description: An approval for some action on an account. + type: object + properties: + name: + description: Output only. The name of the approval. type: string - description: Output only. The last update timestamp. - createTime: + state: + description: Output only. The state of the approval. type: string - format: google-datetime - description: Output only. The creation timestamp. - inputProperties: - description: >- - Output only. The custom properties that were collected from the user - to create this account. - deprecated: true - additionalProperties: - type: any - description: Properties of the object. - type: object - Consumer: - properties: - project: + enumDescriptions: + - Sentinel value; do not use. + - >- + The approval is pending response from the provider. The approval + state can transition to Account.Approval.State.APPROVED or + Account.Approval.State.REJECTED. + - The approval has been granted by the provider. + - >- + The approval has been rejected by the provider. A provider may + choose to approve a previously rejected approval, so is it + possible to transition to Account.Approval.State.APPROVED. + enum: + - STATE_UNSPECIFIED + - PENDING + - APPROVED + - REJECTED + reason: + description: Output only. An explanation for the state of the approval. type: string - description: A project name with format `projects/`. - type: object - id: Consumer - description: A resource using (consuming) this entitlement. - ResetAccountRequest: - id: ResetAccountRequest - properties: {} - description: Request message for PartnerProcurementService.ResetAccount. + updateTime: + description: Optional. The last update timestamp of the approval. + type: string + format: google-datetime + ListAccountsResponse: + id: ListAccountsResponse + description: Response message for [PartnerProcurementService.ListAccounts[]. type: object - ApproveEntitlementPlanChangeRequest: - description: >- - Request message for - [PartnerProcurementService.ApproveEntitlementPlanChange[]. - id: ApproveEntitlementPlanChangeRequest properties: - pendingPlanName: + accounts: + description: The list of accounts in this response. + type: array + items: + $ref: '#/components/schemas/Account' + nextPageToken: + description: The token for fetching the next page. type: string - description: Required. Name of the pending plan that's being approved. - type: object ApproveAccountRequest: id: ApproveAccountRequest description: Request message for PartnerProcurementService.ApproveAccount. type: object properties: properties: - type: object - additionalProperties: - type: string description: >- Set of properties that should be associated with the account. Optional. - reason: - description: >- - Free form text string explaining the approval reason. Optional. Max - allowed length: 256 bytes. Longer strings will be truncated. - type: string + type: object + additionalProperties: + type: string approvalName: - type: string description: >- The name of the approval being approved. If absent and there is only one approval possible, that approval will be granted. If absent and there are many approvals possible, the request will fail with a 400 Bad Request. Optional. + type: string + reason: + description: >- + Free form text string explaining the approval reason. Optional. Max + allowed length: 256 bytes. Longer strings will be truncated. + type: string Empty: - type: object - properties: {} + id: Empty description: >- A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } - id: Empty - Entitlement: type: object + properties: {} + RejectAccountRequest: + id: RejectAccountRequest + description: Request message for PartnerProcurementService.RejectAccount. + type: object + properties: + approvalName: + description: >- + The name of the approval being rejected. If absent and there is only + one approval possible, that approval will be rejected. If absent and + there are many approvals possible, the request will fail with a 400 + Bad Request. Optional. + type: string + reason: + description: >- + Free form text string explaining the rejection reason. Max allowed + length: 256 bytes. Longer strings will be truncated. + type: string + ResetAccountRequest: + id: ResetAccountRequest + description: Request message for PartnerProcurementService.ResetAccount. + type: object + properties: {} + Entitlement: id: Entitlement + description: Represents a procured product of a customer. + type: object properties: - newOfferEndTime: + name: description: >- - Output only. The end time of the new offer. If the offer was created - with a term instead of a specified end date, this field is empty. - This field is populated even if the entitlement isn't active yet. If - there's no upcoming offer, the field is be empty. + Output only. The resource name of the entitlement. Entitlement names + have the form + `providers/{provider_id}/entitlements/{entitlement_id}`. type: string - readOnly: true - format: google-datetime - provider: + account: + description: >- + Output only. The resource name of the account that this entitlement + is based on, if any. type: string + provider: description: >- Output only. The identifier of the service provider that this entitlement was created against. Each service provider is assigned a unique provider value when they onboard with Cloud Commerce platform. - inputProperties: - description: >- - Output only. The custom properties that were collected from the user - to create this entitlement. - additionalProperties: - description: Properties of the object. - type: any - deprecated: true - type: object - usageReportingId: type: string - description: >- - Output only. The consumerId to use when reporting usage through the - Service Control API. See the consumerId field at [Reporting - Metrics](https://cloud.google.com/service-control/reporting-metrics) - for more details. This field is present only if the product has - usage-based billing configured. product: - type: string description: >- Output only. The identifier of the entity that was purchased. This may actually represent a product, quote, or offer. We strongly recommend that you use the following more explicit fields: productExternalName, quoteExternalName, or offer. deprecated: true - newOfferStartTime: - type: string - readOnly: true - description: >- - Output only. The timestamp when the new offer becomes effective. - This field is populated even if the entitlement isn't active yet. If - there's no upcoming offer, the field is empty. - format: google-datetime - account: type: string + quoteExternalName: description: >- - Output only. The resource name of the account that this entitlement - is based on, if any. - messageToUser: - type: string - description: >- - Provider-supplied message that is displayed to the end user. - Currently this is used to communicate progress and ETA for - provisioning. This field can be updated only when a user is waiting - for an action from the provider, i.e. entitlement state is - EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED or - EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL. This - field is cleared automatically when the entitlement state changes. - cancellationReason: - description: >- - Output only. The reason the entitlement was cancelled. If this - entitlement wasn't cancelled, this field is empty. Possible values - include "unknown", "expired", "user-cancelled", "account-closed", - "billing-disabled" (if the customer has manually disabled billing to - their resources), "user-aborted", and "migrated" (if the entitlement - has migrated across products). Values of this field are subject to - change, and we recommend that you don't build your technical - integration to rely on these fields. + Output only. The identifier of the quote that was used to procure. + Empty if the order is not purchased using a quote. readOnly: true type: string - createTime: - description: Output only. The creation timestamp. - type: string - format: google-datetime productExternalName: description: Output only. The identifier of the product that was procured. readOnly: true type: string - updateTime: - type: string - description: Output only. The last update timestamp. - format: google-datetime - name: - type: string + plan: description: >- - Output only. The resource name of the entitlement. Entitlement names - have the form - `providers/{provider_id}/entitlements/{entitlement_id}`. - orderId: + Output only. The identifier of the plan that was procured. Required + if the product has plans. type: string + offer: + description: >- + Output only. The name of the offer that was procured. Field is empty + if order was not made using an offer. Format: + 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR + 'projects/{project}/services/{service}/standardOffers/{offer-id}', + depending on whether the offer is private or public. The {service} + in the name is the listing service of the offer. It could be either + the product service that the offer is referencing, or a generic + private offer parent service. We recommend that you don't build your + integration to rely on the meaning of this {service} part. readOnly: true + type: string + newOfferStartTime: description: >- - Output only. The order ID of this entitlement, without any `orders/` - resource name prefix. - newPendingOffer: + Output only. The timestamp when the new offer becomes effective. + This field is populated even if the entitlement isn't active yet. If + there's no upcoming offer, the field is empty. readOnly: true + type: string + format: google-datetime + newPendingOffer: description: >- Output only. The name of the offer the entitlement is switching to upon a pending plan change. Only exists if the pending plan change @@ -396,13 +286,16 @@ components: the product service that the offer is referencing, or a generic private offer parent service. We recommend that you don't build your integration to rely on the meaning of this {service} part. + readOnly: true type: string - plan: + newPendingPlan: description: >- - Output only. The identifier of the plan that was procured. Required - if the product has plans. + Output only. The identifier of the pending new plan. Required if the + product has plans and the entitlement has a pending plan change. type: string state: + description: Output only. The state of the entitlement. + type: string enumDescriptions: - >- Default state of the entitlement. It's only set to this value when @@ -471,42 +364,26 @@ components: - ENTITLEMENT_ACTIVE - ENTITLEMENT_PENDING_CANCELLATION - ENTITLEMENT_CANCELLED - - ENTITLEMENT_PENDING_PLAN_CHANGE - - ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL - - ENTITLEMENT_SUSPENDED - type: string - description: Output only. The state of the entitlement. - entitlementBenefitIds: - items: - type: string - readOnly: true - description: >- - Output only. The entitlement benefit IDs associated with the - purchase. - type: array - offer: - description: >- - Output only. The name of the offer that was procured. Field is empty - if order was not made using an offer. Format: - 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR - 'projects/{project}/services/{service}/standardOffers/{offer-id}', - depending on whether the offer is private or public. The {service} - in the name is the listing service of the offer. It could be either - the product service that the offer is referencing, or a generic - private offer parent service. We recommend that you don't build your - integration to rely on the meaning of this {service} part. - readOnly: true + - ENTITLEMENT_PENDING_PLAN_CHANGE + - ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL + - ENTITLEMENT_SUSPENDED + inputProperties: + description: >- + Output only. The custom properties that were collected from the user + to create this entitlement. + deprecated: true + type: object + additionalProperties: + type: any + description: Properties of the object. + updateTime: + description: Output only. The last update timestamp. type: string - consumers: - type: array - description: Output only. The resources using this entitlement, if applicable. - items: - $ref: '#/components/schemas/Consumer' - newPendingPlan: + format: google-datetime + createTime: + description: Output only. The creation timestamp. type: string - description: >- - Output only. The identifier of the pending new plan. Required if the - product has plans and the entitlement has a pending plan change. + format: google-datetime offerDuration: description: >- Output only. The offer duration of the current offer in ISO 8601 @@ -515,76 +392,206 @@ components: a duration, this field is empty. readOnly: true type: string + newPendingOfferDuration: + description: >- + Output only. The duration of the new offer, in ISO 8601 duration + format. This field isn't populated for entitlements which aren't + active yet, only for pending offer changes. If the offer was created + with a specified end date instead of a duration, this field is + empty. + readOnly: true + type: string + usageReportingId: + description: >- + Output only. The consumerId to use when reporting usage through the + Service Control API. See the consumerId field at [Reporting + Metrics](https://cloud.google.com/service-control/reporting-metrics) + for more details. This field is present only if the product has + usage-based billing configured. + type: string + messageToUser: + description: >- + Provider-supplied message that is displayed to the end user. + Currently this is used to communicate progress and ETA for + provisioning. This field can be updated only when a user is waiting + for an action from the provider, i.e. entitlement state is + EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED or + EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL. This + field is cleared automatically when the entitlement state changes. + type: string + consumers: + description: Output only. The resources using this entitlement, if applicable. + type: array + items: + $ref: '#/components/schemas/Consumer' subscriptionEndTime: description: >- Output only. End time for the subscription corresponding to this entitlement. - format: google-datetime - type: string readOnly: true + type: string + format: google-datetime offerEndTime: description: >- Output only. End time for the Offer association corresponding to this entitlement. The field is only populated if the entitlement is currently associated with an Offer. + readOnly: true type: string format: google-datetime + newOfferEndTime: + description: >- + Output only. The end time of the new offer. If the offer was created + with a term instead of a specified end date, this field is empty. + This field is populated even if the entitlement isn't active yet. If + there's no upcoming offer, the field is be empty. readOnly: true - newPendingOfferDuration: type: string + format: google-datetime + orderId: description: >- - Output only. The duration of the new offer, in ISO 8601 duration - format. This field isn't populated for entitlements which aren't - active yet, only for pending offer changes. If the offer was created - with a specified end date instead of a duration, this field is - empty. + Output only. The order ID of this entitlement, without any `orders/` + resource name prefix. readOnly: true - quoteExternalName: type: string + entitlementBenefitIds: description: >- - Output only. The identifier of the quote that was used to procure. - Empty if the order is not purchased using a quote. + Output only. The entitlement benefit IDs associated with the + purchase. readOnly: true - description: Represents a procured product of a customer. - RejectAccountRequest: - description: Request message for PartnerProcurementService.RejectAccount. - id: RejectAccountRequest + type: array + items: + type: string + cancellationReason: + description: >- + Output only. The reason the entitlement was cancelled. If this + entitlement wasn't cancelled, this field is empty. Possible values + include "unknown", "expired", "user-cancelled", "account-closed", + "billing-disabled" (if the customer has manually disabled billing to + their resources), "user-aborted", and "migrated" (if the entitlement + has migrated across products). Values of this field are subject to + change, and we recommend that you don't build your technical + integration to rely on these fields. + readOnly: true + type: string + Consumer: + id: Consumer + description: A resource using (consuming) this entitlement. type: object properties: - approvalName: + project: + description: A project name with format `projects/`. + type: string + ListEntitlementsResponse: + id: ListEntitlementsResponse + description: Response message for PartnerProcurementService.ListEntitlements. + type: object + properties: + entitlements: + description: The list of entitlements in this response. + type: array + items: + $ref: '#/components/schemas/Entitlement' + nextPageToken: + description: The token for fetching the next page. + type: string + ApproveEntitlementRequest: + id: ApproveEntitlementRequest + description: Request message for [PartnerProcurementService.ApproveEntitlement[]. + type: object + properties: + properties: + description: >- + Set of properties that should be associated with the entitlement. + Optional. + deprecated: true + type: object + additionalProperties: + type: string + entitlementMigrated: + description: >- + Optional. The resource name of the entitlement that was migrated, + with the format + `providers/{provider_id}/entitlements/{entitlement_id}`. Should only + be sent when resources have been migrated from entitlement_migrated + to the new entitlement. Optional. type: string + RejectEntitlementRequest: + id: RejectEntitlementRequest + description: Request message for PartnerProcurementService.RejectEntitlement. + type: object + properties: + reason: description: >- - The name of the approval being rejected. If absent and there is only - one approval possible, that approval will be rejected. If absent and - there are many approvals possible, the request will fail with a 400 - Bad Request. Optional. + Free form text string explaining the rejection reason. Max allowed + length: 256 bytes. Longer strings will be truncated. + type: string + ApproveEntitlementPlanChangeRequest: + id: ApproveEntitlementPlanChangeRequest + description: >- + Request message for + [PartnerProcurementService.ApproveEntitlementPlanChange[]. + type: object + properties: + pendingPlanName: + description: Required. Name of the pending plan that's being approved. + type: string + RejectEntitlementPlanChangeRequest: + id: RejectEntitlementPlanChangeRequest + description: >- + Request message for + PartnerProcurementService.RejectEntitlementPlanChange. + type: object + properties: reason: description: >- Free form text string explaining the rejection reason. Max allowed length: 256 bytes. Longer strings will be truncated. type: string + pendingPlanName: + description: Required. Name of the pending plan that is being rejected. + type: string + SuspendEntitlementRequest: + id: SuspendEntitlementRequest + description: >- + Request message for ParterProcurementService.SuspendEntitlement. This is + not yet supported. + type: object + properties: + reason: + description: >- + A free-form reason string, explaining the reason for suspension + request. + type: string parameters: - prettyPrint: - description: Returns response with indentations and line breaks. + access_token: + description: OAuth access token. in: query - name: prettyPrint + name: access_token schema: - type: boolean + type: string + alt: + description: Data format for response. + in: query + name: alt + schema: + type: string + enum: + - json + - media + - proto callback: description: JSONP in: query name: callback schema: type: string - _.xgafv: - description: V1 error format. + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: $.xgafv + name: fields schema: type: string - enum: - - '1' - - '2' key: description: >- API key. Your API key identifies your project and provides you with API @@ -600,26 +607,19 @@ components: name: oauth_token schema: type: string - access_token: - description: OAuth access token. - in: query - name: access_token - schema: - type: string - alt: - description: Data format for response. + prettyPrint: + description: Returns response with indentations and line breaks. in: query - name: alt + name: prettyPrint schema: - type: string - enum: - - json - - media - - proto - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + 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: uploadType + name: quotaUser schema: type: string upload_protocol: @@ -628,27 +628,33 @@ components: name: upload_protocol schema: type: string - fields: - description: Selector specifying which fields to include in a partial response. + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: fields + name: uploadType schema: type: string - 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. + _.xgafv: + description: V1 error format. in: query - name: quotaUser + name: $.xgafv schema: type: string + enum: + - '1' + - '2' x-stackQL-resources: accounts: id: google.cloudcommerceprocurement.accounts name: accounts title: Accounts methods: + get: + operation: + $ref: '#/paths/~1v1~1providers~1{providersId}~1accounts~1{accountsId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' list: operation: $ref: '#/paths/~1v1~1providers~1{providersId}~1accounts/get' @@ -677,12 +683,6 @@ components: response: mediaType: application/json openAPIDocKey: '200' - get: - operation: - $ref: '#/paths/~1v1~1providers~1{providersId}~1accounts~1{accountsId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/accounts/methods/get' @@ -696,59 +696,59 @@ components: name: entitlements title: Entitlements methods: - list: + get: operation: - $ref: '#/paths/~1v1~1providers~1{providersId}~1entitlements/get' + $ref: >- + #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.entitlements - reject_plan_change: + patch: operation: $ref: >- - #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}:rejectPlanChange/post + #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}/patch response: mediaType: application/json openAPIDocKey: '200' - patch: + list: operation: - $ref: >- - #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}/patch + $ref: '#/paths/~1v1~1providers~1{providersId}~1entitlements/get' response: mediaType: application/json openAPIDocKey: '200' - get: + objectKey: $.entitlements + approve: operation: $ref: >- - #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}/get + #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}:approve/post response: mediaType: application/json openAPIDocKey: '200' - approve_plan_change: + reject: operation: $ref: >- - #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}:approvePlanChange/post + #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}:reject/post response: mediaType: application/json openAPIDocKey: '200' - approve: + approve_plan_change: operation: $ref: >- - #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}:approve/post + #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}:approvePlanChange/post response: mediaType: application/json openAPIDocKey: '200' - suspend: + reject_plan_change: operation: $ref: >- - #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}:suspend/post + #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}:rejectPlanChange/post response: mediaType: application/json openAPIDocKey: '200' - reject: + suspend: operation: $ref: >- - #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}:reject/post + #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}:suspend/post response: mediaType: application/json openAPIDocKey: '200' @@ -762,19 +762,47 @@ components: replace: [] delete: [] paths: - /v1/providers/{providersId}/accounts: + /v1/providers/{providersId}/accounts/{accountsId}: parameters: &ref_1 - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' + get: + description: Gets a requested Account resource. + operationId: cloudcommerceprocurement.providers.accounts.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Account' + parameters: + - in: path + name: providersId + required: true + schema: + type: string + - in: path + name: accountsId + required: true + schema: + type: string + /v1/providers/{providersId}/accounts: + parameters: *ref_1 get: description: Lists Accounts that the provider has access to. operationId: cloudcommerceprocurement.providers.accounts.list @@ -906,11 +934,11 @@ paths: required: true schema: type: string - /v1/providers/{providersId}/accounts/{accountsId}: + /v1/providers/{providersId}/entitlements/{entitlementsId}: parameters: *ref_1 get: - description: Gets a requested Account resource. - operationId: cloudcommerceprocurement.providers.accounts.get + description: Gets a requested Entitlement resource. + operationId: cloudcommerceprocurement.providers.entitlements.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -922,7 +950,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Account' + $ref: '#/components/schemas/Entitlement' parameters: - in: path name: providersId @@ -930,10 +958,46 @@ paths: schema: type: string - in: path - name: accountsId + name: entitlementsId + required: true + schema: + type: string + patch: + description: Updates an existing Entitlement. + operationId: cloudcommerceprocurement.providers.entitlements.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Entitlement' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Entitlement' + parameters: + - in: path + name: providersId + required: true + schema: + type: string + - in: path + name: entitlementsId required: true schema: type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask /v1/providers/{providersId}/entitlements: parameters: *ref_1 get: @@ -970,20 +1034,20 @@ paths: name: pageToken schema: type: string - /v1/providers/{providersId}/entitlements/{entitlementsId}:rejectPlanChange: + /v1/providers/{providersId}/entitlements/{entitlementsId}:approve: parameters: *ref_1 post: description: >- - Rejects an entitlement plan change that is in the - EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state. This - method is invoked by the provider to reject the plan change on the - entitlement resource. - operationId: cloudcommerceprocurement.providers.entitlements.rejectPlanChange + Approves an entitlement that is in the + EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED state. This method is + invoked by the provider to approve the creation of the entitlement + resource. + operationId: cloudcommerceprocurement.providers.entitlements.approve requestBody: content: application/json: schema: - $ref: '#/components/schemas/RejectEntitlementPlanChangeRequest' + $ref: '#/components/schemas/ApproveEntitlementRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1007,47 +1071,20 @@ paths: required: true schema: type: string - /v1/providers/{providersId}/entitlements/{entitlementsId}: + /v1/providers/{providersId}/entitlements/{entitlementsId}:reject: parameters: *ref_1 - patch: - description: Updates an existing Entitlement. - operationId: cloudcommerceprocurement.providers.entitlements.patch + post: + description: >- + Rejects an entitlement that is in the + EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED state. This method is + invoked by the provider to reject the creation of the entitlement + resource. + operationId: cloudcommerceprocurement.providers.entitlements.reject requestBody: content: application/json: schema: - $ref: '#/components/schemas/Entitlement' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Entitlement' - parameters: - - in: path - name: providersId - required: true - schema: - type: string - - in: path - name: entitlementsId - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - get: - description: Gets a requested Entitlement resource. - operationId: cloudcommerceprocurement.providers.entitlements.get + $ref: '#/components/schemas/RejectEntitlementRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1059,7 +1096,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Entitlement' + $ref: '#/components/schemas/Empty' parameters: - in: path name: providersId @@ -1108,20 +1145,20 @@ paths: required: true schema: type: string - /v1/providers/{providersId}/entitlements/{entitlementsId}:approve: + /v1/providers/{providersId}/entitlements/{entitlementsId}:rejectPlanChange: parameters: *ref_1 post: description: >- - Approves an entitlement that is in the - EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED state. This method is - invoked by the provider to approve the creation of the entitlement - resource. - operationId: cloudcommerceprocurement.providers.entitlements.approve + Rejects an entitlement plan change that is in the + EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state. This + method is invoked by the provider to reject the plan change on the + entitlement resource. + operationId: cloudcommerceprocurement.providers.entitlements.rejectPlanChange requestBody: content: application/json: schema: - $ref: '#/components/schemas/ApproveEntitlementRequest' + $ref: '#/components/schemas/RejectEntitlementPlanChangeRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1178,40 +1215,3 @@ paths: required: true schema: type: string - /v1/providers/{providersId}/entitlements/{entitlementsId}:reject: - parameters: *ref_1 - post: - description: >- - Rejects an entitlement that is in the - EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED state. This method is - invoked by the provider to reject the creation of the entitlement - resource. - operationId: cloudcommerceprocurement.providers.entitlements.reject - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RejectEntitlementRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Empty' - parameters: - - in: path - name: providersId - required: true - schema: - type: string - - in: path - name: entitlementsId - required: true - schema: - type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/cloudcontrolspartner.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudcontrolspartner.yaml index 646c9106..d39d692b 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudcontrolspartner.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudcontrolspartner.yaml @@ -9,8 +9,8 @@ info: Provides insights about your customers and their Assured Workloads based on your Sovereign Controls by Partners offering. version: v1 - x-discovery-doc-revision: '20241024' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250820' + x-generated-date: '2025-08-28' externalDocs: url: >- https://cloud.google.com/sovereign-controls-by-partners/docs/sovereign-partners/reference/rest @@ -522,7 +522,13 @@ components: - EKM Partner Fortanix - EKM Partner FutureX - EKM Partner Thales - - EKM Partner Virtu + - This enum value is never used. + enumDeprecated: + - false + - false + - false + - false + - true enum: - EKM_SOLUTION_UNSPECIFIED - FORTANIX @@ -949,10 +955,10 @@ components: update: [] replace: [] delete: [] - workloads_ekm_connections: - id: google.cloudcontrolspartner.workloads_ekm_connections - name: workloads_ekm_connections - title: Workloads_ekm_connections + ekm_connections: + id: google.cloudcontrolspartner.ekm_connections + name: ekm_connections + title: Ekm_connections methods: get_ekm_connections: operation: @@ -964,15 +970,15 @@ components: sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/workloads_ekm_connections/methods/get_ekm_connections + #/components/x-stackQL-resources/ekm_connections/methods/get_ekm_connections insert: [] update: [] replace: [] delete: [] - workloads_partner_permissions: - id: google.cloudcontrolspartner.workloads_partner_permissions - name: workloads_partner_permissions - title: Workloads_partner_permissions + partner_permissions: + id: google.cloudcontrolspartner.partner_permissions + name: partner_permissions + title: Partner_permissions methods: get_partner_permissions: operation: @@ -984,7 +990,7 @@ components: sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/workloads_partner_permissions/methods/get_partner_permissions + #/components/x-stackQL-resources/partner_permissions/methods/get_partner_permissions insert: [] update: [] replace: [] diff --git a/providers/src/googleapis.com/v00.00.00000/services/clouddeploy.yaml b/providers/src/googleapis.com/v00.00.00000/services/clouddeploy.yaml index cd1060ad..5703c5eb 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/clouddeploy.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/clouddeploy.yaml @@ -7,8 +7,8 @@ info: title: Cloud Deploy API description: '' version: v1 - x-discovery-doc-revision: '20241029' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250813' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/deploy/ servers: @@ -175,7 +175,7 @@ components: properties: name: description: >- - Optional. Name of the `DeliveryPipeline`. Format is + Identifier. Name of the `DeliveryPipeline`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}`. The `deliveryPipeline` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?` @@ -185,12 +185,14 @@ components: readOnly: true type: string description: - description: Description of the `DeliveryPipeline`. Max length is 255 characters. + description: >- + Optional. Description of the `DeliveryPipeline`. Max length is 255 + characters. type: string annotations: description: >- - User annotations. These attributes can only be set and used by the - user, and not by Cloud Deploy. + Optional. User annotations. These attributes can only be set and + used by the user, and not by Cloud Deploy. type: object additionalProperties: type: string @@ -219,7 +221,7 @@ components: format: google-datetime serialPipeline: description: >- - SerialPipeline defines a sequential set of stages for a + Optional. SerialPipeline defines a sequential set of stages for a `DeliveryPipeline`. $ref: '#/components/schemas/SerialPipeline' condition: @@ -234,8 +236,8 @@ components: type: string suspended: description: >- - When suspended, no new releases or rollouts can be created, but - in-progress ones will complete. + Optional. When suspended, no new releases or rollouts can be + created, but in-progress ones will complete. type: boolean SerialPipeline: id: SerialPipeline @@ -246,8 +248,8 @@ components: properties: stages: description: >- - Each stage specifies configuration for a `Target`. The ordering of - this list defines the promotion flow. + Optional. Each stage specifies configuration for a `Target`. The + ordering of this list defines the promotion flow. type: array items: $ref: '#/components/schemas/Stage' @@ -258,17 +260,17 @@ components: properties: targetId: description: >- - The target_id to which this stage points. This field refers - exclusively to the last segment of a target name. For example, this - field would just be `my-target` (rather than + Optional. The target_id to which this stage points. This field + refers exclusively to the last segment of a target name. For + example, this field would just be `my-target` (rather than `projects/project/locations/location/targets/my-target`). The location of the `Target` is inferred to be the same as the location of the `DeliveryPipeline` that contains this `Stage`. type: string profiles: description: >- - Skaffold profiles to use when rendering the manifest for this - stage's `Target`. + Optional. Skaffold profiles to use when rendering the manifest for + this stage's `Target`. type: array items: type: string @@ -287,13 +289,13 @@ components: properties: standard: description: >- - Standard deployment strategy executes a single deploy and allows - verifying the deployment. + Optional. Standard deployment strategy executes a single deploy and + allows verifying the deployment. $ref: '#/components/schemas/Standard' canary: description: >- - Canary deployment strategy provides progressive percentage based - deployments to a Target. + Optional. Canary deployment strategy provides progressive percentage + based deployments to a Target. $ref: '#/components/schemas/Canary' Standard: id: Standard @@ -301,17 +303,17 @@ components: type: object properties: verify: - description: Whether to verify a deployment. + description: Optional. Whether to verify a deployment via `skaffold verify`. type: boolean predeploy: description: >- Optional. Configuration for the predeploy job. If this is not - configured, predeploy job will not be present. + configured, the predeploy job will not be present. $ref: '#/components/schemas/Predeploy' postdeploy: description: >- Optional. Configuration for the postdeploy job. If this is not - configured, postdeploy job will not be present. + configured, the postdeploy job will not be present. $ref: '#/components/schemas/Postdeploy' Predeploy: id: Predeploy @@ -349,13 +351,13 @@ components: Deploy will split traffic to enable a progressive deployment. $ref: '#/components/schemas/RuntimeConfig' canaryDeployment: - description: Configures the progressive based deployment for a Target. + description: Optional. Configures the progressive based deployment for a Target. $ref: '#/components/schemas/CanaryDeployment' customCanaryDeployment: description: >- - Configures the progressive based deployment for a Target, but allows - customizing at the phase level where a phase represents each of the - percentage deployments. + Optional. Configures the progressive based deployment for a Target, + but allows customizing at the phase level where a phase represents + each of the percentage deployments. $ref: '#/components/schemas/CustomCanaryDeployment' RuntimeConfig: id: RuntimeConfig @@ -365,10 +367,10 @@ components: type: object properties: kubernetes: - description: Kubernetes runtime configuration. + description: Optional. Kubernetes runtime configuration. $ref: '#/components/schemas/KubernetesConfig' cloudRun: - description: Cloud Run runtime configuration. + description: Optional. Cloud Run runtime configuration. $ref: '#/components/schemas/CloudRunConfig' KubernetesConfig: id: KubernetesConfig @@ -376,10 +378,10 @@ components: type: object properties: gatewayServiceMesh: - description: Kubernetes Gateway API service mesh configuration. + description: Optional. Kubernetes Gateway API service mesh configuration. $ref: '#/components/schemas/GatewayServiceMesh' serviceNetworking: - description: Kubernetes Service networking configuration. + description: Optional. Kubernetes Service networking configuration. $ref: '#/components/schemas/ServiceNetworking' GatewayServiceMesh: id: GatewayServiceMesh @@ -446,7 +448,7 @@ components: Optional. Whether to propagate the Kubernetes Service to the route destination clusters. The Service will always be deployed to the Target cluster even if the HTTPRoute is not. This option may be used - to facilitiate successful DNS lookup in the route destination + to facilitate successful DNS lookup in the route destination clusters. Can only be set to true if destinations are specified. type: boolean ServiceNetworking: @@ -481,10 +483,10 @@ components: properties: automaticTrafficControl: description: >- - Whether Cloud Deploy should update the traffic stanza in a Cloud Run - Service on the user's behalf to facilitate traffic splitting. This - is required to be true for CanaryDeployments, but optional for - CustomCanaryDeployments. + Optional. Whether Cloud Deploy should update the traffic stanza in a + Cloud Run Service on the user's behalf to facilitate traffic + splitting. This is required to be true for CanaryDeployments, but + optional for CustomCanaryDeployments. type: boolean canaryRevisionTags: description: >- @@ -523,7 +525,9 @@ components: type: integer format: int32 verify: - description: Whether to run verify tests after each percentage deployment. + description: >- + Optional. Whether to run verify tests after each percentage + deployment via `skaffold verify`. type: boolean predeploy: description: >- @@ -572,14 +576,16 @@ components: format: int32 profiles: description: >- - Skaffold profiles to use when rendering the manifest for this phase. - These are in addition to the profiles list specified in the - `DeliveryPipeline` stage. + Optional. Skaffold profiles to use when rendering the manifest for + this phase. These are in addition to the profiles list specified in + the `DeliveryPipeline` stage. type: array items: type: string verify: - description: Whether to run verify tests after the deployment. + description: >- + Optional. Whether to run verify tests after the deployment via + `skaffold verify`. type: boolean predeploy: description: >- @@ -712,7 +718,7 @@ components: properties: name: description: >- - Optional. Name of the `Target`. Format is + Identifier. Name of the `Target`. Format is `projects/{project}/locations/{location}/targets/{target}`. The `target` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?` type: string @@ -799,13 +805,13 @@ components: type: string executionConfigs: description: >- - Configurations for all execution that relates to this `Target`. Each - `ExecutionEnvironmentUsage` value may only be used in a single - configuration; using the same value multiple times is an error. When - one or more configurations are specified, they must include the - `RENDER` and `DEPLOY` `ExecutionEnvironmentUsage` values. When no - configurations are specified, execution will use the default - specified in `DefaultPool`. + Optional. Configurations for all execution that relates to this + `Target`. Each `ExecutionEnvironmentUsage` value may only be used in + a single configuration; using the same value multiple times is an + error. When one or more configurations are specified, they must + include the `RENDER` and `DEPLOY` `ExecutionEnvironmentUsage` + values. When no configurations are specified, execution will use the + default specified in `DefaultPool`. type: array items: $ref: '#/components/schemas/ExecutionConfig' @@ -833,6 +839,8 @@ components: control-plane endpoints and the public IP address otherwise. Only specify this option when `cluster` is a [private GKE cluster](https://cloud.google.com/kubernetes-engine/docs/concepts/private-cluster-concept). + Note that `internal_ip` and `dns_endpoint` cannot both be set to + true. type: boolean proxyUrl: description: >- @@ -840,6 +848,12 @@ components: [proxy](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#proxy) to the Kubernetes server. type: string + dnsEndpoint: + description: >- + Optional. If set, the cluster will be accessed using the DNS + endpoint. Note that both `dns_endpoint` and `internal_ip` cannot be + set to true. + type: boolean AnthosCluster: id: AnthosCluster description: Information specifying an Anthos Cluster. @@ -1063,7 +1077,7 @@ components: properties: name: description: >- - Optional. Name of the `Rollout`. Format is + Identifier. Name of the `Rollout`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`. The `rollout` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?` type: string @@ -1073,13 +1087,13 @@ components: type: string description: description: >- - Description of the `Rollout` for user purposes. Max length is 255 - characters. + Optional. Description of the `Rollout` for user purposes. Max length + is 255 characters. type: string annotations: description: >- - User annotations. These attributes can only be set and used by the - user, and not by Cloud Deploy. See + Optional. User annotations. These attributes can only be set and + used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations. type: object @@ -1206,7 +1220,7 @@ components: - >- The deploy operation did not complete successfully; check Cloud Build logs. - - Deployment did not complete within the alloted time. + - Deployment did not complete within the allotted time. - Release is in a failed state. - Release is abandoned. - No Skaffold verify configuration was found. @@ -1310,6 +1324,10 @@ components: description: Deployment job composition. type: object properties: + predeployJob: + description: Output only. The predeploy Job, which is the first job on the phase. + readOnly: true + $ref: '#/components/schemas/Job' deployJob: description: Output only. The deploy Job. This is the deploy job in the phase. readOnly: true @@ -1320,10 +1338,6 @@ components: succeeds. readOnly: true $ref: '#/components/schemas/Job' - predeployJob: - description: Output only. The predeploy Job, which is the first job on the phase. - readOnly: true - $ref: '#/components/schemas/Job' postdeployJob: description: Output only. The postdeploy Job, which is the last job on the phase. readOnly: true @@ -1589,7 +1603,7 @@ components: properties: name: description: >- - Optional. Name of the `CustomTargetType`. Format is + Identifier. Name of the `CustomTargetType`. Format is `projects/{project}/locations/{location}/customTargetTypes/{customTargetType}`. The `customTargetType` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?` @@ -1649,8 +1663,8 @@ components: type: string customActions: description: >- - Configures render and deploy for the `CustomTargetType` using - Skaffold custom actions. + Optional. Configures render and deploy for the `CustomTargetType` + using Skaffold custom actions. $ref: '#/components/schemas/CustomTargetSkaffoldActions' CustomTargetSkaffoldActions: id: CustomTargetSkaffoldActions @@ -1690,13 +1704,19 @@ components: items: type: string git: - description: Remote git repository containing the Skaffold Config modules. + description: >- + Optional. Remote git repository containing the Skaffold Config + modules. $ref: '#/components/schemas/SkaffoldGitSource' googleCloudStorage: - description: Cloud Storage bucket containing the Skaffold Config modules. + description: >- + Optional. Cloud Storage bucket containing the Skaffold Config + modules. $ref: '#/components/schemas/SkaffoldGCSSource' googleCloudBuildRepo: - description: Cloud Build V2 repository containing the Skaffold Config modules. + description: >- + Optional. Cloud Build V2 repository containing the Skaffold Config + modules. $ref: '#/components/schemas/SkaffoldGCBRepoSource' SkaffoldGitSource: id: SkaffoldGitSource @@ -1776,7 +1796,7 @@ components: properties: name: description: >- - Optional. Name of the `Release`. Format is + Identifier. Name of the `Release`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}`. The `release` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?` type: string @@ -1785,12 +1805,14 @@ components: readOnly: true type: string description: - description: Description of the `Release`. Max length is 255 characters. + description: >- + Optional. Description of the `Release`. Max length is 255 + characters. type: string annotations: description: >- - User annotations. These attributes can only be set and used by the - user, and not by Cloud Deploy. See + Optional. User annotations. These attributes can only be set and + used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations. type: object @@ -1830,14 +1852,14 @@ components: format: google-datetime skaffoldConfigUri: description: >- - Cloud Storage URI of tar.gz archive containing Skaffold + Optional. Cloud Storage URI of tar.gz archive containing Skaffold configuration. type: string skaffoldConfigPath: - description: Filepath of the Skaffold config inside of the config URI. + description: Optional. Filepath of the Skaffold config inside of the config URI. type: string buildArtifacts: - description: List of artifacts to pass through to Skaffold command. + description: Optional. List of artifacts to pass through to Skaffold command. type: array items: $ref: '#/components/schemas/BuildArtifact' @@ -1885,10 +1907,10 @@ components: type: string skaffoldVersion: description: >- - The Skaffold version to use when operating on this release, such as - "1.20.0". Not all versions are valid; Cloud Deploy supports a - specific set of versions. If unset, the most recent supported - Skaffold version will be used. + Optional. The Skaffold version to use when operating on this + release, such as "1.20.0". Not all versions are valid; Cloud Deploy + supports a specific set of versions. If unset, the most recent + supported Skaffold version will be used. type: string targetArtifacts: description: >- @@ -1923,12 +1945,12 @@ components: type: object properties: image: - description: Image name in Skaffold configuration. + description: Optional. Image name in Skaffold configuration. type: string tag: description: >- - Image tag to use. This will generally be the full path to an image, - such as "gcr.io/my-project/busybox:1.2.3" or + Optional. Image tag to use. This will generally be the full path to + an image, such as "gcr.io/my-project/busybox:1.2.3" or "gcr.io/my-project/busybox@sha256:abc123". type: string TargetArtifact: @@ -1945,12 +1967,14 @@ components: type: string skaffoldConfigPath: description: >- - Output only. File path of the resolved Skaffold configuration - relative to the URI. + Output only. File path of the resolved Skaffold configuration for + the stable phase, relative to the URI. readOnly: true type: string manifestPath: - description: Output only. File path of the rendered manifest relative to the URI. + description: >- + Output only. File path of the rendered manifest relative to the URI + for the stable phase. readOnly: true type: string phaseArtifacts: @@ -2038,8 +2062,8 @@ components: Skaffold configuration. - >- The render operation did not complete successfully because the - custom action required for predeploy or postdeploy was not found - in the Skaffold configuration. See failure_message for additional + custom action(s) required for Rollout jobs were not found in the + Skaffold configuration. See failure_message for additional details. - >- Release failed during rendering because the release configuration @@ -2183,16 +2207,18 @@ components: readOnly: true type: string description: - description: Description of the `DeployPolicy`. Max length is 255 characters. + description: >- + Optional. Description of the `DeployPolicy`. Max length is 255 + characters. type: string annotations: description: >- - User annotations. These attributes can only be set and used by the - user, and not by Cloud Deploy. Annotations must meet the following - constraints: * Annotations are key/value pairs. * Valid annotation - keys have two segments: an optional prefix and name, separated by a - slash (`/`). * The name segment is required and must be 63 - characters or less, beginning and ending with an alphanumeric + Optional. User annotations. These attributes can only be set and + used by the user, and not by Cloud Deploy. Annotations must meet the + following constraints: * Annotations are key/value pairs. * Valid + annotation keys have two segments: an optional prefix and name, + separated by a slash (`/`). * The name segment is required and must + be 63 characters or less, beginning and ending with an alphanumeric character (`[a-z0-9A-Z]`) with dashes (`-`), underscores (`_`), dots (`.`), and alphanumerics between. * The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS @@ -2230,8 +2256,8 @@ components: format: google-datetime suspended: description: >- - When suspended, the policy will not prevent actions from occurring, - even if the action violates the policy. + Optional. When suspended, the policy will not prevent actions from + occurring, even if the action violates the policy. type: boolean selectors: description: >- @@ -2250,7 +2276,7 @@ components: $ref: '#/components/schemas/PolicyRule' etag: description: >- - The weak etag of the `Automation` resource. This checksum is + The weak etag of the `DeployPolicy` resource. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. @@ -2279,9 +2305,9 @@ components: properties: id: description: >- - ID of the `DeliveryPipeline`. The value of this field could be one - of the following: * The last segment of a pipeline name * "*", all - delivery pipelines in a location + Optional. ID of the `DeliveryPipeline`. The value of this field + could be one of the following: * The last segment of a pipeline name + * "*", all delivery pipelines in a location type: string labels: description: DeliveryPipeline labels. @@ -2297,9 +2323,9 @@ components: properties: id: description: >- - ID of the `Target`. The value of this field could be one of the - following: * The last segment of a target name * "*", all targets in - a location + Optional. ID of the `Target`. The value of this field could be one + of the following: * The last segment of a target name * "*", all + targets in a location type: string labels: description: Target labels. @@ -2312,7 +2338,7 @@ components: type: object properties: rolloutRestriction: - description: Rollout restrictions. + description: Optional. Rollout restrictions. $ref: '#/components/schemas/RolloutRestriction' RolloutRestriction: id: RolloutRestriction @@ -2614,7 +2640,7 @@ components: properties: {} ListRolloutsResponse: id: ListRolloutsResponse - description: ListRolloutsResponse is the response object reutrned by `ListRollouts`. + description: ListRolloutsResponse is the response object returned by `ListRollouts`. type: object properties: rollouts: @@ -2707,8 +2733,9 @@ components: properties: name: description: >- - Optional. Name of the `JobRun`. Format is + Output only. Name of the `JobRun`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{releases}/rollouts/{rollouts}/jobRuns/{uuid}`. + readOnly: true type: string uid: description: Output only. Unique identifier of the `JobRun`. @@ -2813,7 +2840,7 @@ components: - >- The deploy operation did not complete successfully; check Cloud Build logs. - - The deploy job run did not complete within the alloted time. + - The deploy job run did not complete within the allotted time. - >- There were missing resources in the runtime environment required for a canary deployment. Check the Cloud Build logs for more @@ -2944,7 +2971,7 @@ components: - >- The verify operation did not complete successfully; check Cloud Build logs. - - The verify job run did not complete within the alloted time. + - The verify job run did not complete within the allotted time. - No Skaffold verify configuration was found. - >- Cloud Build failed to fulfill Cloud Deploy's request. See @@ -2990,7 +3017,7 @@ components: - >- The predeploy operation did not complete successfully; check Cloud Build logs. - - The predeploy job run did not complete within the alloted time. + - The predeploy job run did not complete within the allotted time. - >- Cloud Build failed to fulfill Cloud Deploy's request. See failure_message for additional details. @@ -3034,7 +3061,7 @@ components: - >- The postdeploy operation did not complete successfully; check Cloud Build logs. - - The postdeploy job run did not complete within the alloted time. + - The postdeploy job run did not complete within the allotted time. - >- Cloud Build failed to fulfill Cloud Deploy's request. See failure_message for additional details. @@ -3247,7 +3274,7 @@ components: type: object properties: targets: - description: Contains attributes about a target. + description: Optional. Contains attributes about a target. type: array items: $ref: '#/components/schemas/TargetAttribute' @@ -4402,8 +4429,8 @@ components: description: >- Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled - have Operation.error value with a google.rpc.Status.code of 1, - corresponding to `Code.CANCELLED`. + have google.longrunning.Operation.error value with a + google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. readOnly: true type: boolean apiVersion: @@ -5905,6 +5932,36 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/deploy_policies/methods/delete' + deploy_policies_iam_policies: + id: google.clouddeploy.deploy_policies_iam_policies + name: deploy_policies_iam_policies + title: Deploy_policies_iam_policies + methods: + set_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deployPolicies~1{deployPoliciesId}:setIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + get_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deployPolicies~1{deployPoliciesId}:getIamPolicy/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.bindings + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/deploy_policies_iam_policies/methods/get_iam_policy + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/deploy_policies_iam_policies/methods/set_iam_policy + delete: [] paths: /v1/projects/{projectsId}/locations/{locationsId}/config: parameters: &ref_1 @@ -5981,6 +6038,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: @@ -6135,7 +6196,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: clouddeploy.projects.locations.operations.cancel requestBody: content: @@ -8558,3 +8619,84 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/deployPolicies/{deployPoliciesId}:setIamPolicy: + parameters: *ref_1 + post: + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and + `PERMISSION_DENIED` errors. + operationId: clouddeploy.projects.locations.deployPolicies.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetIamPolicyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: deployPoliciesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/deployPolicies/{deployPoliciesId}:getIamPolicy: + parameters: *ref_1 + get: + description: >- + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: clouddeploy.projects.locations.deployPolicies.getIamPolicy + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: deployPoliciesId + required: true + schema: + type: string + - in: query + name: options.requestedPolicyVersion + schema: + type: integer + format: int32 diff --git a/providers/src/googleapis.com/v00.00.00000/services/clouderrorreporting.yaml b/providers/src/googleapis.com/v00.00.00000/services/clouderrorreporting.yaml index 636fe07f..dd4049b7 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/clouderrorreporting.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/clouderrorreporting.yaml @@ -10,8 +10,8 @@ info: reports new errors, and provides access to error groups and their associated errors. version: v1beta1 - x-discovery-doc-revision: '20241025' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250822' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/error-reporting/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/cloudfunctions.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudfunctions.yaml index 1d64f443..b43cf37b 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudfunctions.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudfunctions.yaml @@ -7,8 +7,8 @@ info: title: Cloud Functions API description: Manages lightweight user-provided functions executed in response to events. version: v2 - x-discovery-doc-revision: '20241024' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250814' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/functions servers: @@ -508,6 +508,8 @@ components: Function deployment failed and the function serving state is undefined. The function should be updated or deleted to move it out of this state. + - Function is being detached. + - Function detach failed and the function is still serving. enum: - STATE_UNSPECIFIED - ACTIVE @@ -515,6 +517,8 @@ components: - DEPLOYING - DELETING - UNKNOWN + - DETACHING + - DETACH_FAILED updateTime: description: Output only. The last update timestamp of a Cloud Function. readOnly: true @@ -567,6 +571,10 @@ components: readOnly: true type: string format: google-datetime + satisfiesPzi: + description: Output only. Reserved for future use. + readOnly: true + type: boolean BuildConfig: id: BuildConfig description: >- @@ -629,10 +637,15 @@ components: description: >- Docker Registry to use for this deployment. This configuration is only applicable to 1st Gen functions, 2nd Gen functions can only use - Artifact Registry. If unspecified, it defaults to - `ARTIFACT_REGISTRY`. If `docker_repository` field is specified, this - field should either be left unspecified or set to - `ARTIFACT_REGISTRY`. + Artifact Registry. Deprecated: as of March 2025, + `CONTAINER_REGISTRY` option is no longer available in response to + Container Registry's deprecation: + https://cloud.google.com/artifact-registry/docs/transition/transition-from-gcr + Please use Artifact Registry instead, which is the default choice. + If unspecified, it defaults to `ARTIFACT_REGISTRY`. If + `docker_repository` field is specified, this field should either be + left unspecified or set to `ARTIFACT_REGISTRY`. + deprecated: true type: string enumDescriptions: - Unspecified. @@ -658,8 +671,7 @@ components: named 'gcf-artifacts' for every deployed region. It must match the pattern `projects/{project}/locations/{location}/repositories/{repository}`. - Cross-project repositories are not supported. Cross-location - repositories are not supported. Repository format must be 'DOCKER'. + Repository format must be 'DOCKER'. type: string serviceAccount: description: >- @@ -1172,8 +1184,8 @@ components: id: UpgradeInfo description: >- Information related to: * A function's eligibility for 1st Gen to 2nd - Gen migration and 2nd Gen to CRf detach. * Current state of migration - for function undergoing migration/detach. + Gen migration. * Current state of migration for function undergoing + migration. type: object properties: upgradeState: @@ -1196,7 +1208,6 @@ components: - RedirectFunctionUpgradeTraffic API was un-successful. - RollbackFunctionUpgradeTraffic API was un-successful. - CommitFunctionUpgrade API was un-successful. - - Function is requested to be detached from 2nd Gen to CRf. enum: - UPGRADE_STATE_UNSPECIFIED - ELIGIBLE_FOR_2ND_GEN_UPGRADE @@ -1208,7 +1219,6 @@ components: - REDIRECT_FUNCTION_UPGRADE_TRAFFIC_ERROR - ROLLBACK_FUNCTION_UPGRADE_TRAFFIC_ERROR - COMMIT_FUNCTION_UPGRADE_ERROR - - DETACH_IN_PROGRESS serviceConfig: description: >- Describes the Cloud Run service which has been setup to prepare for @@ -1250,7 +1260,15 @@ components: id: SetupFunctionUpgradeConfigRequest description: Request for the `SetupFunctionUpgradeConfig` method. type: object - properties: {} + properties: + triggerServiceAccount: + description: >- + Optional. The trigger's service account. The service account must + have permission to invoke Cloud Run services, the permission is + `run.routes.invoke`. If empty, defaults to the Compute Engine + default service account: + `{project_number}-compute@developer.gserviceaccount.com`. + type: string AbortFunctionUpgradeRequest: id: AbortFunctionUpgradeRequest description: Request for the `AbortFunctionUpgrade` method. @@ -1439,6 +1457,11 @@ components: the day isn't significant. type: integer format: int32 + DetachFunctionRequest: + id: DetachFunctionRequest + description: Request for the `DetachFunction` method. + type: object + properties: {} ListLocationsResponse: id: ListLocationsResponse description: The response message for Locations.ListLocations. @@ -1607,6 +1630,7 @@ components: - SetupFunctionUpgradeConfig - AbortFunctionUpgrade - CommitFunctionUpgrade + - DetachFunction enum: - OPERATIONTYPE_UNSPECIFIED - CREATE_FUNCTION @@ -1617,6 +1641,13 @@ components: - SETUP_FUNCTION_UPGRADE_CONFIG - ABORT_FUNCTION_UPGRADE - COMMIT_FUNCTION_UPGRADE + - DETACH_FUNCTION + customIamRoleDetected: + description: >- + Output only. Whether a custom IAM role binding was detected during + the upgrade. + readOnly: true + type: boolean GoogleCloudFunctionsV2Stage: id: GoogleCloudFunctionsV2Stage description: Each Stage of the deployment process @@ -1627,7 +1658,7 @@ components: type: string enumDescriptions: - Not specified. Invalid name. - - Artifact Regsitry Stage + - Artifact Registry Stage - Build Stage - Service Stage - Trigger Stage @@ -1941,6 +1972,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + detach_function: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1functions~1{functionsId}:detachFunction/post + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/functions/methods/get' @@ -2019,6 +2057,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v2/projects/{projectsId}/locations/{locationsId}/operations: parameters: *ref_1 get: @@ -2718,6 +2760,44 @@ paths: required: true schema: type: string + /v2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:detachFunction: + parameters: *ref_1 + post: + description: Detaches 2nd Gen function to Cloud Run function. + operationId: cloudfunctions.projects.locations.functions.detachFunction + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DetachFunctionRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: functionsId + required: true + schema: + type: string /v2/projects/{projectsId}/locations/{locationsId}/runtimes: parameters: *ref_1 get: diff --git a/providers/src/googleapis.com/v00.00.00000/services/cloudidentity.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudidentity.yaml index 1ea20f23..de2410f2 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudidentity.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudidentity.yaml @@ -7,8 +7,8 @@ info: title: Cloud Identity API description: API for provisioning and managing identity resources. version: v1 - x-discovery-doc-revision: '20241029' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250819' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/identity/ servers: @@ -35,6 +35,15 @@ components: https://www.googleapis.com/auth/cloud-identity.groups.readonly: >- See any Cloud Identity Groups that you can access, including group members and their emails + https://www.googleapis.com/auth/cloud-identity.inboundsso: >- + See and edit all of the Inbound SSO profiles and their assignments + to any Org Units or Google Groups in your Cloud Identity + Organization. + https://www.googleapis.com/auth/cloud-identity.inboundsso.readonly: >- + See all of the Inbound SSO profiles and their assignments to any + Org Units or Google Groups in your Cloud Identity Organization. + https://www.googleapis.com/auth/cloud-identity.policies: See and edit policies in your Cloud Identity Organization. + https://www.googleapis.com/auth/cloud-identity.policies.readonly: See policies in your Cloud Identity Organization. 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. @@ -57,7 +66,10 @@ components: Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device}`, where device is the unique id - assigned to the Device. + assigned to the Device. Important: Device API scopes require that + you use domain-wide delegation to access the API. For more + information, see [Set up the Devices + API](https://cloud.google.com/identity/docs/how-to/setup-devices). readOnly: true type: string createTime: @@ -1089,9 +1101,9 @@ components: format: google-datetime labels: description: >- - Required. One or more label entries that apply to the Group. - Currently supported labels contain a key with an empty value. Google - Groups are the default type of group and have a label with a key of + Required. One or more label entries that apply to the Group. Labels + contain a key with an empty value. Google Groups are the default + type of group and have a label with a key of `cloudidentity.googleapis.com/groups.discussion_forum` and an empty value. Existing Google Groups can have an additional label with a key of `cloudidentity.googleapis.com/groups.security` and an empty @@ -1099,7 +1111,11 @@ components: label cannot be removed once added.** Dynamic groups have a label with a key of `cloudidentity.googleapis.com/groups.dynamic`. Identity-mapped groups for Cloud Search have a label with a key of - `system/groups/external` and an empty value. + `system/groups/external` and an empty value. Google Groups can be + [locked](https://support.google.com/a?p=locked-groups). To lock a + group, add a label with a key of + `cloudidentity.googleapis.com/groups.locked` and an empty value. + Doing so locks the group. To unlock the group, remove this label. type: object additionalProperties: type: string @@ -1886,6 +1902,90 @@ components: PEM encoded x509 certificate containing the public key for verifying IdP signatures. type: string + InboundOidcSsoProfile: + id: InboundOidcSsoProfile + description: >- + An [OIDC](https://openid.net/developers/how-connect-works/) federation + between a Google enterprise customer and an OIDC identity provider. + type: object + properties: + name: + description: >- + Output only. [Resource + name](https://cloud.google.com/apis/design/resource_names) of the + OIDC SSO profile. + readOnly: true + type: string + customer: + description: 'Immutable. The customer. For example: `customers/C0123abc`.' + type: string + displayName: + description: Human-readable name of the OIDC SSO profile. + type: string + idpConfig: + description: OIDC identity provider configuration. + $ref: '#/components/schemas/OidcIdpConfig' + rpConfig: + description: >- + OIDC relying party (RP) configuration for this OIDC SSO profile. + These are the RP details provided by Google that should be + configured on the corresponding identity provider. + $ref: '#/components/schemas/OidcRpConfig' + OidcIdpConfig: + id: OidcIdpConfig + description: OIDC IDP (identity provider) configuration. + type: object + properties: + issuerUri: + description: >- + Required. The Issuer identifier for the IdP. Must be a URL. The + discovery URL will be derived from this as described in Section 4 of + [the OIDC + specification](https://openid.net/specs/openid-connect-discovery-1_0.html). + type: string + changePasswordUri: + description: >- + The **Change Password URL** of the identity provider. Users will be + sent to this URL when changing their passwords at + `myaccount.google.com`. This takes precedence over the change + password URL configured at customer-level. Must use `HTTPS`. + type: string + OidcRpConfig: + id: OidcRpConfig + description: OIDC RP (relying party) configuration. + type: object + properties: + clientId: + description: OAuth2 client ID for OIDC. + type: string + clientSecret: + description: Input only. OAuth2 client secret for OIDC. + type: string + redirectUris: + description: >- + Output only. The URL(s) that this client may use in authentication + requests. + readOnly: true + type: array + items: + type: string + ListInboundOidcSsoProfilesResponse: + id: ListInboundOidcSsoProfilesResponse + description: >- + Response of the InboundOidcSsoProfilesService.ListInboundOidcSsoProfiles + method. + type: object + properties: + inboundOidcSsoProfiles: + description: List of InboundOidcSsoProfiles. + type: array + items: + $ref: '#/components/schemas/InboundOidcSsoProfile' + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string InboundSsoAssignment: id: InboundSsoAssignment description: Targets with "set" SSO assignments and their respective assignments. @@ -1924,6 +2024,9 @@ components: - >- Use an external SAML Identity Provider for SSO for the targeted users. + - >- + Use an external OIDC Identity Provider for SSO for the targeted + users. - >- Use the domain-wide SAML Identity Provider for the targeted users if one is configured; otherwise, this is equivalent to `SSO_OFF`. @@ -1935,12 +2038,18 @@ components: - SSO_MODE_UNSPECIFIED - SSO_OFF - SAML_SSO + - OIDC_SSO - DOMAIN_WIDE_SAML_IF_ENABLED samlSsoInfo: description: >- SAML SSO details. Must be set if and only if `sso_mode` is set to `SAML_SSO`. $ref: '#/components/schemas/SamlSsoInfo' + oidcSsoInfo: + description: >- + OpenID Connect SSO details. Must be set if and only if `sso_mode` is + set to `OIDC_SSO`. + $ref: '#/components/schemas/OidcSsoInfo' signInBehavior: description: >- Assertions about users assigned to an IdP will always be accepted @@ -1957,6 +2066,16 @@ components: Required. Name of the `InboundSamlSsoProfile` to use. Must be of the form `inboundSamlSsoProfiles/{inbound_saml_sso_profile}`. type: string + OidcSsoInfo: + id: OidcSsoInfo + description: Details that are applicable when `sso_mode` is set to `OIDC_SSO`. + type: object + properties: + inboundOidcSsoProfile: + description: >- + Required. Name of the `InboundOidcSsoProfile` to use. Must be of the + form `inboundOidcSsoProfiles/{inbound_oidc_sso_profile}`. + type: string SignInBehavior: id: SignInBehavior description: Controls sign-in behavior. @@ -1994,6 +2113,118 @@ components: A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. type: string + Policy: + id: Policy + description: >- + A Policy resource binds an instance of a single Setting with the scope + of a PolicyQuery. The Setting instance will be applied to all entities + that satisfy the query. + type: object + properties: + name: + description: >- + Output only. Identifier. The [resource + name](https://cloud.google.com/apis/design/resource_names) of the + Policy. Format: policies/{policy}. + readOnly: true + type: string + customer: + description: >- + Immutable. Customer that the Policy belongs to. The value is in the + format 'customers/{customerId}'. The `customerId` must begin with + "C" To find your customer ID in Admin Console see + https://support.google.com/a/answer/10070793. + type: string + policyQuery: + description: Required. The PolicyQuery the Setting applies to. + $ref: '#/components/schemas/PolicyQuery' + setting: + description: Required. The Setting configured by this Policy. + $ref: '#/components/schemas/Setting' + type: + description: Output only. The type of the policy. + readOnly: true + type: string + enumDescriptions: + - Unspecified policy type. + - Policy type denoting the system-configured policies. + - Policy type denoting the admin-configurable policies. + enum: + - POLICY_TYPE_UNSPECIFIED + - SYSTEM + - ADMIN + PolicyQuery: + id: PolicyQuery + description: PolicyQuery + type: object + properties: + query: + description: >- + Immutable. The CEL query that defines which entities the Policy + applies to (ex. a User entity). For details about CEL see + https://opensource.google.com/projects/cel. The OrgUnits the Policy + applies to are represented by a clause like so: + entity.org_units.exists(org_unit, org_unit.org_unit_id == + orgUnitId('{orgUnitId}')) The Group the Policy applies to are + represented by a clause like so: entity.groups.exists(group, + group.group_id == groupId('{groupId}')) The Licenses the Policy + applies to are represented by a clause like so: + entity.licenses.exists(license, license in + ['/product/{productId}/sku/{skuId}']) The above clauses can be + present in any combination, and used in conjunction with the &&, || + and ! operators. The org_unit and group fields below are helper + fields that contain the corresponding value(s) as the query to make + the query easier to use. + type: string + orgUnit: + description: >- + Required. Immutable. Non-empty default. The OrgUnit the query + applies to. This field is only set if there is a single value for + org_unit that satisfies all clauses of the query. + type: string + group: + description: >- + Immutable. The group that the query applies to. This field is only + set if there is a single value for group that satisfies all clauses + of the query. If no group applies, this will be the empty string. + type: string + sortOrder: + description: >- + Output only. The decimal sort order of this PolicyQuery. The value + is relative to all other policies with the same setting type for the + customer. (There are no duplicates within this set). + readOnly: true + type: number + format: double + Setting: + id: Setting + description: Setting + type: object + properties: + type: + description: Required. Immutable. The type of the Setting. . + type: string + value: + description: Required. The value of the Setting. + type: object + additionalProperties: + type: any + description: Properties of the object. + ListPoliciesResponse: + id: ListPoliciesResponse + description: The response message for PoliciesService.ListPolicies. + type: object + properties: + policies: + description: The results + type: array + items: + $ref: '#/components/schemas/Policy' + nextPageToken: + description: >- + The pagination token to retrieve the next page of results. If this + field is empty, there are no subsequent pages. + type: string UserInvitation: id: UserInvitation description: >- @@ -2106,8 +2337,8 @@ components: description: >- Each edge contains information about the member that belongs to this group. Note: Fields returned here will help identify the specific - Membership resource (e.g name, preferred_member_key and role), but - may not be a comprehensive list of all fields. + Membership resource (e.g `name`, `preferred_member_key` and `role`), + but may not be a comprehensive list of all fields. type: array items: $ref: '#/components/schemas/Membership' @@ -2321,6 +2552,41 @@ components: [Multi-party approval for sensitive actions](https://support.google.com/a/answer/13790448). type: string + CreateInboundOidcSsoProfileOperationMetadata: + id: CreateInboundOidcSsoProfileOperationMetadata + description: >- + LRO response metadata for + InboundOidcSsoProfilesService.CreateInboundOidcSsoProfile. + type: object + properties: + state: + description: >- + State of this Operation Will be "awaiting-multi-party-approval" when + the operation is deferred due to the target customer having enabled + [Multi-party approval for sensitive + actions](https://support.google.com/a/answer/13790448). + type: string + UpdateInboundOidcSsoProfileOperationMetadata: + id: UpdateInboundOidcSsoProfileOperationMetadata + description: >- + LRO response metadata for + InboundOidcSsoProfilesService.UpdateInboundOidcSsoProfile. + type: object + properties: + state: + description: >- + State of this Operation Will be "awaiting-multi-party-approval" when + the operation is deferred due to the target customer having enabled + [Multi-party approval for sensitive + actions](https://support.google.com/a/answer/13790448). + type: string + DeleteInboundOidcSsoProfileOperationMetadata: + id: DeleteInboundOidcSsoProfileOperationMetadata + description: >- + LRO response metadata for + InboundOidcSsoProfilesService.DeleteInboundOidcSsoProfile. + type: object + properties: {} CreateInboundSsoAssignmentOperationMetadata: id: CreateInboundSsoAssignmentOperationMetadata description: >- @@ -2867,6 +3133,61 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/idp_credentials/methods/delete' + inbound_oidc_sso_profiles: + id: google.cloudidentity.inbound_oidc_sso_profiles + name: inbound_oidc_sso_profiles + title: Inbound_oidc_sso_profiles + methods: + create: + operation: + $ref: '#/paths/~1v1~1inboundOidcSsoProfiles/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1v1~1inboundOidcSsoProfiles/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.inboundOidcSsoProfiles + patch: + operation: + $ref: >- + #/paths/~1v1~1inboundOidcSsoProfiles~1{inboundOidcSsoProfilesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1inboundOidcSsoProfiles~1{inboundOidcSsoProfilesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1inboundOidcSsoProfiles~1{inboundOidcSsoProfilesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/inbound_oidc_sso_profiles/methods/get + - $ref: >- + #/components/x-stackQL-resources/inbound_oidc_sso_profiles/methods/list + insert: + - $ref: >- + #/components/x-stackQL-resources/inbound_oidc_sso_profiles/methods/create + update: + - $ref: >- + #/components/x-stackQL-resources/inbound_oidc_sso_profiles/methods/patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/inbound_oidc_sso_profiles/methods/delete inbound_sso_assignments: id: google.cloudidentity.inbound_sso_assignments name: inbound_sso_assignments @@ -2921,6 +3242,32 @@ components: delete: - $ref: >- #/components/x-stackQL-resources/inbound_sso_assignments/methods/delete + policies: + id: google.cloudidentity.policies + name: policies + title: Policies + methods: + get: + operation: + $ref: '#/paths/~1v1~1policies~1{policiesId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1v1~1policies/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.policies + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/policies/methods/get' + - $ref: '#/components/x-stackQL-resources/policies/methods/list' + insert: [] + update: [] + replace: [] + delete: [] userinvitations: id: google.cloudidentity.userinvitations name: userinvitations @@ -4422,6 +4769,10 @@ paths: schema: $ref: '#/components/schemas/InboundSamlSsoProfile' security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-identity.inboundsso + Oauth2c: + - https://www.googleapis.com/auth/cloud-identity.inboundsso - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -4438,6 +4789,14 @@ paths: description: Lists InboundSamlSsoProfiles for a customer. operationId: cloudidentity.inboundSamlSsoProfiles.list security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-identity.inboundsso + Oauth2c: + - https://www.googleapis.com/auth/cloud-identity.inboundsso + - Oauth2: + - https://www.googleapis.com/auth/cloud-identity.inboundsso.readonly + Oauth2c: + - https://www.googleapis.com/auth/cloud-identity.inboundsso.readonly - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -4479,6 +4838,10 @@ paths: schema: $ref: '#/components/schemas/InboundSamlSsoProfile' security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-identity.inboundsso + Oauth2c: + - https://www.googleapis.com/auth/cloud-identity.inboundsso - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -4505,6 +4868,10 @@ paths: description: Deletes an InboundSamlSsoProfile. operationId: cloudidentity.inboundSamlSsoProfiles.delete security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-identity.inboundsso + Oauth2c: + - https://www.googleapis.com/auth/cloud-identity.inboundsso - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -4526,6 +4893,14 @@ paths: description: Gets an InboundSamlSsoProfile. operationId: cloudidentity.inboundSamlSsoProfiles.get security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-identity.inboundsso + Oauth2c: + - https://www.googleapis.com/auth/cloud-identity.inboundsso + - Oauth2: + - https://www.googleapis.com/auth/cloud-identity.inboundsso.readonly + Oauth2c: + - https://www.googleapis.com/auth/cloud-identity.inboundsso.readonly - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -4549,6 +4924,10 @@ paths: description: Deletes an IdpCredential. operationId: cloudidentity.inboundSamlSsoProfiles.idpCredentials.delete security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-identity.inboundsso + Oauth2c: + - https://www.googleapis.com/auth/cloud-identity.inboundsso - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -4575,6 +4954,14 @@ paths: description: Gets an IdpCredential. operationId: cloudidentity.inboundSamlSsoProfiles.idpCredentials.get security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-identity.inboundsso + Oauth2c: + - https://www.googleapis.com/auth/cloud-identity.inboundsso + - Oauth2: + - https://www.googleapis.com/auth/cloud-identity.inboundsso.readonly + Oauth2c: + - https://www.googleapis.com/auth/cloud-identity.inboundsso.readonly - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -4603,6 +4990,14 @@ paths: description: Returns a list of IdpCredentials in an InboundSamlSsoProfile. operationId: cloudidentity.inboundSamlSsoProfiles.idpCredentials.list security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-identity.inboundsso + Oauth2c: + - https://www.googleapis.com/auth/cloud-identity.inboundsso + - Oauth2: + - https://www.googleapis.com/auth/cloud-identity.inboundsso.readonly + Oauth2c: + - https://www.googleapis.com/auth/cloud-identity.inboundsso.readonly - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -4645,6 +5040,10 @@ paths: schema: $ref: '#/components/schemas/AddIdpCredentialRequest' security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-identity.inboundsso + Oauth2c: + - https://www.googleapis.com/auth/cloud-identity.inboundsso - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -4662,12 +5061,185 @@ paths: required: true schema: type: string + /v1/inboundOidcSsoProfiles: + parameters: *ref_1 + post: + description: >- + Creates an InboundOidcSsoProfile for a customer. When the target + customer has enabled [Multi-party approval for sensitive + actions](https://support.google.com/a/answer/13790448), the `Operation` + in the response will have `"done": false`, it will not have a response, + and the metadata will have `"state": "awaiting-multi-party-approval"`. + operationId: cloudidentity.inboundOidcSsoProfiles.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InboundOidcSsoProfile' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-identity.inboundsso + Oauth2c: + - https://www.googleapis.com/auth/cloud-identity.inboundsso + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: [] + get: + description: Lists InboundOidcSsoProfile objects for a Google enterprise customer. + operationId: cloudidentity.inboundOidcSsoProfiles.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-identity.inboundsso + Oauth2c: + - https://www.googleapis.com/auth/cloud-identity.inboundsso + - Oauth2: + - https://www.googleapis.com/auth/cloud-identity.inboundsso.readonly + Oauth2c: + - https://www.googleapis.com/auth/cloud-identity.inboundsso.readonly + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListInboundOidcSsoProfilesResponse' + parameters: + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/inboundOidcSsoProfiles/{inboundOidcSsoProfilesId}: + parameters: *ref_1 + patch: + description: >- + Updates an InboundOidcSsoProfile. When the target customer has enabled + [Multi-party approval for sensitive + actions](https://support.google.com/a/answer/13790448), the `Operation` + in the response will have `"done": false`, it will not have a response, + and the metadata will have `"state": "awaiting-multi-party-approval"`. + operationId: cloudidentity.inboundOidcSsoProfiles.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InboundOidcSsoProfile' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-identity.inboundsso + Oauth2c: + - https://www.googleapis.com/auth/cloud-identity.inboundsso + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: inboundOidcSsoProfilesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes an InboundOidcSsoProfile. + operationId: cloudidentity.inboundOidcSsoProfiles.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-identity.inboundsso + Oauth2c: + - https://www.googleapis.com/auth/cloud-identity.inboundsso + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: inboundOidcSsoProfilesId + required: true + schema: + type: string + get: + description: Gets an InboundOidcSsoProfile. + operationId: cloudidentity.inboundOidcSsoProfiles.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-identity.inboundsso + Oauth2c: + - https://www.googleapis.com/auth/cloud-identity.inboundsso + - Oauth2: + - https://www.googleapis.com/auth/cloud-identity.inboundsso.readonly + Oauth2c: + - https://www.googleapis.com/auth/cloud-identity.inboundsso.readonly + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/InboundOidcSsoProfile' + parameters: + - in: path + name: inboundOidcSsoProfilesId + required: true + schema: + type: string /v1/inboundSsoAssignments/{inboundSsoAssignmentsId}: parameters: *ref_1 get: description: Gets an InboundSsoAssignment. operationId: cloudidentity.inboundSsoAssignments.get security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-identity.inboundsso + Oauth2c: + - https://www.googleapis.com/auth/cloud-identity.inboundsso + - Oauth2: + - https://www.googleapis.com/auth/cloud-identity.inboundsso.readonly + Oauth2c: + - https://www.googleapis.com/auth/cloud-identity.inboundsso.readonly - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -4701,6 +5273,10 @@ paths: schema: $ref: '#/components/schemas/InboundSsoAssignment' security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-identity.inboundsso + Oauth2c: + - https://www.googleapis.com/auth/cloud-identity.inboundsso - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -4729,6 +5305,10 @@ paths: assignment that has `sso_mode` == `SSO_OFF`. operationId: cloudidentity.inboundSsoAssignments.delete security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-identity.inboundsso + Oauth2c: + - https://www.googleapis.com/auth/cloud-identity.inboundsso - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -4759,6 +5339,10 @@ paths: schema: $ref: '#/components/schemas/InboundSsoAssignment' security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-identity.inboundsso + Oauth2c: + - https://www.googleapis.com/auth/cloud-identity.inboundsso - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -4775,6 +5359,14 @@ paths: description: Lists the InboundSsoAssignments for a `Customer`. operationId: cloudidentity.inboundSsoAssignments.list security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-identity.inboundsso + Oauth2c: + - https://www.googleapis.com/auth/cloud-identity.inboundsso + - Oauth2: + - https://www.googleapis.com/auth/cloud-identity.inboundsso.readonly + Oauth2c: + - https://www.googleapis.com/auth/cloud-identity.inboundsso.readonly - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -4800,6 +5392,68 @@ paths: name: pageToken schema: type: string + /v1/policies/{policiesId}: + parameters: *ref_1 + get: + description: Get a Policy + operationId: cloudidentity.policies.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-identity.policies + Oauth2c: + - https://www.googleapis.com/auth/cloud-identity.policies + - Oauth2: + - https://www.googleapis.com/auth/cloud-identity.policies.readonly + Oauth2c: + - https://www.googleapis.com/auth/cloud-identity.policies.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: policiesId + required: true + schema: + type: string + /v1/policies: + parameters: *ref_1 + get: + description: List Policies + operationId: cloudidentity.policies.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-identity.policies + Oauth2c: + - https://www.googleapis.com/auth/cloud-identity.policies + - Oauth2: + - https://www.googleapis.com/auth/cloud-identity.policies.readonly + Oauth2c: + - https://www.googleapis.com/auth/cloud-identity.policies.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListPoliciesResponse' + parameters: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string /v1/customers/{customersId}/userinvitations/{userinvitationsId}: parameters: *ref_1 get: diff --git a/providers/src/googleapis.com/v00.00.00000/services/cloudkms.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudkms.yaml index e5eedd6b..d5c08260 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudkms.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudkms.yaml @@ -9,8 +9,8 @@ info: Manages keys and performs cryptographic operations in a central cloud service, for direct use by other cloud resources and applications. version: v1 - x-discovery-doc-revision: '20241024' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250818' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/kms/ servers: @@ -41,13 +41,14 @@ components: schemas: AutokeyConfig: id: AutokeyConfig - description: Cloud KMS Autokey configuration for a folder. + description: Cloud KMS Autokey configuration for a folder or project. type: object properties: name: description: >- Identifier. Name of the AutokeyConfig resource, e.g. - `folders/{FOLDER_NUMBER}/autokeyConfig`. + `folders/{FOLDER_NUMBER}/autokeyConfig` + `projects/{PROJECT_NUMBER}/autokeyConfig`. type: string keyProject: description: >- @@ -80,6 +81,13 @@ components: - ACTIVE - KEY_PROJECT_DELETED - UNINITIALIZED + etag: + description: >- + Optional. A checksum computed by the server based on the value of + other fields. This may be sent on update requests to ensure that the + client has an up-to-date value before proceeding. The request will + be rejected with an ABORTED error on a mismatched etag. + type: string ShowEffectiveAutokeyConfigResponse: id: ShowEffectiveAutokeyConfigResponse description: Response message for ShowEffectiveAutokeyConfig. @@ -234,7 +242,10 @@ components: results. type: string totalSize: - description: The total number of EkmConnections that matched the query. + description: >- + The total number of EkmConnections that matched the query. This + field is not populated if ListEkmConnectionsRequest.filter is + applied. type: integer format: int32 EkmConnection: @@ -424,6 +435,146 @@ components: description: Response message for EkmService.VerifyConnectivity. type: object properties: {} + KeyAccessJustificationsPolicyConfig: + id: KeyAccessJustificationsPolicyConfig + description: A singleton configuration for Key Access Justifications policies. + type: object + properties: + name: + description: >- + Identifier. The resource name for this + KeyAccessJustificationsPolicyConfig in the format of + "{organizations|folders|projects}/*/kajPolicyConfig". + type: string + defaultKeyAccessJustificationPolicy: + description: >- + Optional. The default key access justification policy used when a + CryptoKey is created in this folder. This is only used when a Key + Access Justifications policy is not provided in the + CreateCryptoKeyRequest. This overrides any default policies in its + ancestry. + $ref: '#/components/schemas/KeyAccessJustificationsPolicy' + KeyAccessJustificationsPolicy: + id: KeyAccessJustificationsPolicy + description: >- + A KeyAccessJustificationsPolicy specifies zero or more allowed + AccessReason values for encrypt, decrypt, and sign operations on a + CryptoKey. + type: object + properties: + allowedAccessReasons: + description: >- + The list of allowed reasons for access to a CryptoKey. Zero allowed + access reasons means all encrypt, decrypt, and sign operations for + the CryptoKey associated with this policy will fail. + type: array + items: + type: string + enumDescriptions: + - Unspecified access reason. + - Customer-initiated support. + - >- + Google-initiated access for system management and + troubleshooting. + - >- + Google-initiated access in response to a legal request or legal + process. + - >- + Google-initiated access for security, fraud, abuse, or + compliance purposes. + - >- + Customer uses their account to perform any access to their own + data which their IAM policy authorizes. + - >- + Google systems access customer data to help optimize the + structure of the data or quality for future uses by the + customer. + - No reason is expected for this key request. + - >- + Customer uses their account to perform any access to their own + data which their IAM policy authorizes, and one of the following + is true: * A Google administrator has reset the root-access + account associated with the user's organization within the past + 7 days. * A Google-initiated emergency access operation has + interacted with a resource in the same project or folder as the + currently accessed resource within the past 7 days. + - >- + Google systems access customer data to help optimize the + structure of the data or quality for future uses by the + customer, and one of the following is true: * A Google + administrator has reset the root-access account associated with + the user's organization within the past 7 days. * A + Google-initiated emergency access operation has interacted with + a resource in the same project or folder as the currently + accessed resource within the past 7 days. + - Google-initiated access to maintain system reliability. + - >- + One of the following operations is being executed while + simultaneously encountering an internal technical issue which + prevented a more precise justification code from being + generated: * Your account has been used to perform any access to + your own data which your IAM policy authorizes. * An automated + Google system operates on encrypted customer data which your IAM + policy authorizes. * Customer-initiated Google support access. * + Google-initiated support access to protect system reliability. + enum: + - REASON_UNSPECIFIED + - CUSTOMER_INITIATED_SUPPORT + - GOOGLE_INITIATED_SERVICE + - THIRD_PARTY_DATA_REQUEST + - GOOGLE_INITIATED_REVIEW + - CUSTOMER_INITIATED_ACCESS + - GOOGLE_INITIATED_SYSTEM_OPERATION + - REASON_NOT_EXPECTED + - MODIFIED_CUSTOMER_INITIATED_ACCESS + - MODIFIED_GOOGLE_INITIATED_SYSTEM_OPERATION + - GOOGLE_RESPONSE_TO_PRODUCTION_ALERT + - CUSTOMER_AUTHORIZED_WORKFLOW_SERVICING + ShowEffectiveKeyAccessJustificationsPolicyConfigResponse: + id: ShowEffectiveKeyAccessJustificationsPolicyConfigResponse + description: >- + Response message for + KeyAccessJustificationsConfig.ShowEffectiveKeyAccessJustificationsPolicyConfig. + type: object + properties: + effectiveKajPolicy: + description: The effective KeyAccessJustificationsPolicyConfig. + $ref: '#/components/schemas/KeyAccessJustificationsPolicyConfig' + ShowEffectiveKeyAccessJustificationsEnrollmentConfigResponse: + id: ShowEffectiveKeyAccessJustificationsEnrollmentConfigResponse + description: >- + Response message for + KeyAccessJustificationsConfig.ShowEffectiveKeyAccessJustificationsEnrollmentConfig + type: object + properties: + hardwareConfig: + description: >- + The effective KeyAccessJustificationsEnrollmentConfig for hardware + keys. + $ref: '#/components/schemas/KeyAccessJustificationsEnrollmentConfig' + softwareConfig: + description: >- + The effective KeyAccessJustificationsEnrollmentConfig for software + keys. + $ref: '#/components/schemas/KeyAccessJustificationsEnrollmentConfig' + externalConfig: + description: >- + The effective KeyAccessJustificationsEnrollmentConfig for external + keys. + $ref: '#/components/schemas/KeyAccessJustificationsEnrollmentConfig' + KeyAccessJustificationsEnrollmentConfig: + id: KeyAccessJustificationsEnrollmentConfig + description: >- + The configuration of a protection level for a project's Key Access + Justifications enrollment. + type: object + properties: + auditLogging: + description: Whether the project has KAJ logging enabled. + type: boolean + policyEnforcement: + description: Whether the project is enrolled in KAJ policy enforcement. + type: boolean ListKeyRingsResponse: id: ListKeyRingsResponse description: Response message for KeyManagementService.ListKeyRings. @@ -440,7 +591,9 @@ components: ListKeyRingsRequest.page_token to retrieve the next page of results. type: string totalSize: - description: The total number of KeyRings that matched the query. + description: >- + The total number of KeyRings that matched the query. This field is + not populated if ListKeyRingsRequest.filter is applied. type: integer format: int32 KeyRing: @@ -476,7 +629,9 @@ components: results. type: string totalSize: - description: The total number of CryptoKeys that matched the query. + description: >- + The total number of CryptoKeys that matched the query. This field is + not populated if ListCryptoKeysRequest.filter is applied. type: integer format: int32 CryptoKey: @@ -520,6 +675,9 @@ components: symmetric encryption and does not support automatic CryptoKey rotation. - CryptoKeys with this purpose may be used with MacSign. + - >- + CryptoKeys with this purpose may be used with GetPublicKey and + Decapsulate. enum: - CRYPTO_KEY_PURPOSE_UNSPECIFIED - ENCRYPT_DECRYPT @@ -527,6 +685,7 @@ components: - ASYMMETRIC_DECRYPT - RAW_ENCRYPT_DECRYPT - MAC + - KEY_ENCAPSULATION createTime: description: Output only. The time at which this CryptoKey was created. readOnly: true @@ -631,7 +790,7 @@ components: available, and the version can be placed back into the ENABLED state. - >- - This version is destroyed, and the key material is no longer + The key material of this version is destroyed and no longer stored. This version may only become ENABLED again if this version is reimport_eligible and the original key material is reimported with a call to KeyManagementService.ImportCryptoKeyVersion. @@ -747,6 +906,21 @@ components: - >- Algorithm representing symmetric encryption by an external key manager. + - ML-KEM-768 (FIPS 203) + - ML-KEM-1024 (FIPS 203) + - >- + X-Wing hybrid KEM combining ML-KEM-768 with X25519 following + datatracker.ietf.org/doc/draft-connolly-cfrg-xwing-kem/. + - >- + The post-quantum Module-Lattice-Based Digital Signature Algorithm, + at security level 3. Randomized version. + - >- + The post-quantum stateless hash-based digital signature algorithm, + at security level 1. Randomized version. + - >- + The post-quantum stateless hash-based digital signature algorithm, + at security level 1. Randomized pre-hash version supporting SHA256 + digests. enum: - CRYPTO_KEY_VERSION_ALGORITHM_UNSPECIFIED - GOOGLE_SYMMETRIC_ENCRYPTION @@ -784,6 +958,12 @@ components: - HMAC_SHA512 - HMAC_SHA224 - EXTERNAL_SYMMETRIC_ENCRYPTION + - ML_KEM_768 + - ML_KEM_1024 + - KEM_XWING + - PQ_SIGN_ML_DSA_65 + - PQ_SIGN_SLH_DSA_SHA2_128S + - PQ_SIGN_HASH_SLH_DSA_SHA2_128S_SHA256 attestation: description: >- Output only. Statement that was generated and signed by the HSM at @@ -1025,6 +1205,21 @@ components: - >- Algorithm representing symmetric encryption by an external key manager. + - ML-KEM-768 (FIPS 203) + - ML-KEM-1024 (FIPS 203) + - >- + X-Wing hybrid KEM combining ML-KEM-768 with X25519 following + datatracker.ietf.org/doc/draft-connolly-cfrg-xwing-kem/. + - >- + The post-quantum Module-Lattice-Based Digital Signature Algorithm, + at security level 3. Randomized version. + - >- + The post-quantum stateless hash-based digital signature algorithm, + at security level 1. Randomized version. + - >- + The post-quantum stateless hash-based digital signature algorithm, + at security level 1. Randomized pre-hash version supporting SHA256 + digests. enum: - CRYPTO_KEY_VERSION_ALGORITHM_UNSPECIFIED - GOOGLE_SYMMETRIC_ENCRYPTION @@ -1062,82 +1257,12 @@ components: - HMAC_SHA512 - HMAC_SHA224 - EXTERNAL_SYMMETRIC_ENCRYPTION - KeyAccessJustificationsPolicy: - id: KeyAccessJustificationsPolicy - description: >- - A KeyAccessJustificationsPolicy specifies zero or more allowed - AccessReason values for encrypt, decrypt, and sign operations on a - CryptoKey. - type: object - properties: - allowedAccessReasons: - description: >- - The list of allowed reasons for access to a CryptoKey. Zero allowed - access reasons means all encrypt, decrypt, and sign operations for - the CryptoKey associated with this policy will fail. - type: array - items: - type: string - enumDescriptions: - - Unspecified access reason. - - Customer-initiated support. - - >- - Google-initiated access for system management and - troubleshooting. - - >- - Google-initiated access in response to a legal request or legal - process. - - >- - Google-initiated access for security, fraud, abuse, or - compliance purposes. - - >- - Customer uses their account to perform any access to their own - data which their IAM policy authorizes. - - >- - Google systems access customer data to help optimize the - structure of the data or quality for future uses by the - customer. - - No reason is expected for this key request. - - >- - Customer uses their account to perform any access to their own - data which their IAM policy authorizes, and one of the following - is true: * A Google administrator has reset the root-access - account associated with the user's organization within the past - 7 days. * A Google-initiated emergency access operation has - interacted with a resource in the same project or folder as the - currently accessed resource within the past 7 days. - - >- - Google systems access customer data to help optimize the - structure of the data or quality for future uses by the - customer, and one of the following is true: * A Google - administrator has reset the root-access account associated with - the user's organization within the past 7 days. * A - Google-initiated emergency access operation has interacted with - a resource in the same project or folder as the currently - accessed resource within the past 7 days. - - Google-initiated access to maintain system reliability. - - >- - One of the following operations is being executed while - simultaneously encountering an internal technical issue which - prevented a more precise justification code from being - generated: * Your account has been used to perform any access to - your own data which your IAM policy authorizes. * An automated - Google system operates on encrypted customer data which your IAM - policy authorizes. * Customer-initiated Google support access. * - Google-initiated support access to protect system reliability. - enum: - - REASON_UNSPECIFIED - - CUSTOMER_INITIATED_SUPPORT - - GOOGLE_INITIATED_SERVICE - - THIRD_PARTY_DATA_REQUEST - - GOOGLE_INITIATED_REVIEW - - CUSTOMER_INITIATED_ACCESS - - GOOGLE_INITIATED_SYSTEM_OPERATION - - REASON_NOT_EXPECTED - - MODIFIED_CUSTOMER_INITIATED_ACCESS - - MODIFIED_GOOGLE_INITIATED_SYSTEM_OPERATION - - GOOGLE_RESPONSE_TO_PRODUCTION_ALERT - - CUSTOMER_AUTHORIZED_WORKFLOW_SERVICING + - ML_KEM_768 + - ML_KEM_1024 + - KEM_XWING + - PQ_SIGN_ML_DSA_65 + - PQ_SIGN_SLH_DSA_SHA2_128S + - PQ_SIGN_HASH_SLH_DSA_SHA2_128S_SHA256 ListCryptoKeyVersionsResponse: id: ListCryptoKeyVersionsResponse description: Response message for KeyManagementService.ListCryptoKeyVersions. @@ -1155,7 +1280,10 @@ components: results. type: string totalSize: - description: The total number of CryptoKeyVersions that matched the query. + description: >- + The total number of CryptoKeyVersions that matched the query. This + field is not populated if ListCryptoKeyVersionsRequest.filter is + applied. type: integer format: int32 ListImportJobsResponse: @@ -1175,7 +1303,9 @@ components: results. type: string totalSize: - description: The total number of ImportJobs that matched the query. + description: >- + The total number of ImportJobs that matched the query. This field is + not populated if ListImportJobsRequest.filter is applied. type: integer format: int32 ImportJob: @@ -1423,6 +1553,21 @@ components: - >- Algorithm representing symmetric encryption by an external key manager. + - ML-KEM-768 (FIPS 203) + - ML-KEM-1024 (FIPS 203) + - >- + X-Wing hybrid KEM combining ML-KEM-768 with X25519 following + datatracker.ietf.org/doc/draft-connolly-cfrg-xwing-kem/. + - >- + The post-quantum Module-Lattice-Based Digital Signature Algorithm, + at security level 3. Randomized version. + - >- + The post-quantum stateless hash-based digital signature algorithm, + at security level 1. Randomized version. + - >- + The post-quantum stateless hash-based digital signature algorithm, + at security level 1. Randomized pre-hash version supporting SHA256 + digests. enum: - CRYPTO_KEY_VERSION_ALGORITHM_UNSPECIFIED - GOOGLE_SYMMETRIC_ENCRYPTION @@ -1460,6 +1605,12 @@ components: - HMAC_SHA512 - HMAC_SHA224 - EXTERNAL_SYMMETRIC_ENCRYPTION + - ML_KEM_768 + - ML_KEM_1024 + - KEM_XWING + - PQ_SIGN_ML_DSA_65 + - PQ_SIGN_SLH_DSA_SHA2_128S + - PQ_SIGN_HASH_SLH_DSA_SHA2_128S_SHA256 pemCrc32c: description: >- Integrity verification field. A CRC32C checksum of the returned @@ -1470,7 +1621,7 @@ components: persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a - non-negative integer, which will never exceed 2^32-1, and can be + non-negative integer, which will never exceed `2^32-1`, and can be safely downconverted to uint32 in languages that support this type. NOTE: This field is in Beta. type: string @@ -1495,6 +1646,72 @@ components: - HSM - EXTERNAL - EXTERNAL_VPC + publicKeyFormat: + description: >- + The PublicKey format specified by the customer through the + public_key_format field. + type: string + enumDescriptions: + - >- + If the public_key_format field is not specified: - For PQC + algorithms, an error will be returned. - For non-PQC algorithms, + the default format is PEM, and the field pem will be populated. + Otherwise, the public key will be exported through the public_key + field in the requested format. + - >- + The returned public key will be encoded in PEM format. See the + [RFC7468](https://tools.ietf.org/html/rfc7468) sections for + [General + Considerations](https://tools.ietf.org/html/rfc7468#section-2) and + [Textual Encoding of Subject Public Key Info] + (https://tools.ietf.org/html/rfc7468#section-13) for more + information. + - >- + The returned public key will be encoded in DER format (the + PrivateKeyInfo structure from RFC 5208). + - >- + This is supported only for PQC algorithms. The key material is + returned in the format defined by NIST PQC standards (FIPS 203, + FIPS 204, and FIPS 205). + - >- + The returned public key is in raw bytes format defined in its + standard + https://datatracker.ietf.org/doc/draft-connolly-cfrg-xwing-kem. + enum: + - PUBLIC_KEY_FORMAT_UNSPECIFIED + - PEM + - DER + - NIST_PQC + - XWING_RAW_BYTES + publicKey: + description: >- + This field contains the public key (with integrity verification), + formatted according to the public_key_format field. + $ref: '#/components/schemas/ChecksummedData' + ChecksummedData: + id: ChecksummedData + description: Data with integrity verification field. + type: object + properties: + data: + description: Raw Data. + type: string + format: byte + crc32cChecksum: + description: >- + Integrity verification field. A CRC32C checksum of the returned + ChecksummedData.data. An integrity check of ChecksummedData.data can + be performed by computing the CRC32C checksum of + ChecksummedData.data and comparing your results to this field. + Discard the response in case of non-matching checksum values, and + perform a limited number of retries. A persistent mismatch may + indicate an issue in your computation of the CRC32C checksum. Note: + This field is defined as int64 for reasons of compatibility across + different languages. However, it is a non-negative integer, which + will never exceed `2^32-1`, and can be safely downconverted to + uint32 in languages that support this type. + type: string + format: int64 ImportCryptoKeyVersionRequest: id: ImportCryptoKeyVersionRequest description: Request message for KeyManagementService.ImportCryptoKeyVersion. @@ -1569,6 +1786,21 @@ components: - >- Algorithm representing symmetric encryption by an external key manager. + - ML-KEM-768 (FIPS 203) + - ML-KEM-1024 (FIPS 203) + - >- + X-Wing hybrid KEM combining ML-KEM-768 with X25519 following + datatracker.ietf.org/doc/draft-connolly-cfrg-xwing-kem/. + - >- + The post-quantum Module-Lattice-Based Digital Signature Algorithm, + at security level 3. Randomized version. + - >- + The post-quantum stateless hash-based digital signature algorithm, + at security level 1. Randomized version. + - >- + The post-quantum stateless hash-based digital signature algorithm, + at security level 1. Randomized pre-hash version supporting SHA256 + digests. enum: - CRYPTO_KEY_VERSION_ALGORITHM_UNSPECIFIED - GOOGLE_SYMMETRIC_ENCRYPTION @@ -1606,6 +1838,12 @@ components: - HMAC_SHA512 - HMAC_SHA224 - EXTERNAL_SYMMETRIC_ENCRYPTION + - ML_KEM_768 + - ML_KEM_1024 + - KEM_XWING + - PQ_SIGN_ML_DSA_65 + - PQ_SIGN_SLH_DSA_SHA2_128S + - PQ_SIGN_HASH_SLH_DSA_SHA2_128S_SHA256 importJob: description: >- Required. The name of the ImportJob that was used to wrap this key @@ -2584,7 +2822,7 @@ components: received MacVerifyRequest.mac using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client - should verify that CRC32C(MacVerifyRequest.tag) is equal to + should verify that CRC32C(MacVerifyRequest.mac) is equal to MacVerifyRequest.mac_crc32c, and if so, perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as @@ -2652,6 +2890,94 @@ components: - HSM - EXTERNAL - EXTERNAL_VPC + DecapsulateRequest: + id: DecapsulateRequest + description: Request message for KeyManagementService.Decapsulate. + type: object + properties: + ciphertext: + description: >- + Required. The ciphertext produced from encapsulation with the named + CryptoKeyVersion public key(s). + type: string + format: byte + ciphertextCrc32c: + description: >- + Optional. A CRC32C checksum of the DecapsulateRequest.ciphertext. If + specified, KeyManagementService will verify the integrity of the + received DecapsulateRequest.ciphertext using this checksum. + KeyManagementService will report an error if the checksum + verification fails. If you receive a checksum error, your client + should verify that CRC32C(DecapsulateRequest.ciphertext) is equal to + DecapsulateRequest.ciphertext_crc32c, and if so, perform a limited + number of retries. A persistent mismatch may indicate an issue in + your computation of the CRC32C checksum. Note: This field is defined + as int64 for reasons of compatibility across different languages. + However, it is a non-negative integer, which will never exceed + 2^32-1, and can be safely downconverted to uint32 in languages that + support this type. + type: string + format: int64 + DecapsulateResponse: + id: DecapsulateResponse + description: Response message for KeyManagementService.Decapsulate. + type: object + properties: + name: + description: >- + The resource name of the CryptoKeyVersion used for decapsulation. + Check this field to verify that the intended resource was used for + decapsulation. + type: string + sharedSecret: + description: >- + The decapsulated shared_secret originally encapsulated with the + matching public key. + type: string + format: byte + sharedSecretCrc32c: + description: >- + Integrity verification field. A CRC32C checksum of the returned + DecapsulateResponse.shared_secret. An integrity check of + DecapsulateResponse.shared_secret can be performed by computing the + CRC32C checksum of DecapsulateResponse.shared_secret and comparing + your results to this field. Discard the response in case of + non-matching checksum values, and perform a limited number of + retries. A persistent mismatch may indicate an issue in your + computation of the CRC32C checksum. Note: receiving this response + message indicates that KeyManagementService is able to successfully + decrypt the ciphertext. Note: This field is defined as int64 for + reasons of compatibility across different languages. However, it is + a non-negative integer, which will never exceed 2^32-1, and can be + safely downconverted to uint32 in languages that support this type. + type: string + format: int64 + verifiedCiphertextCrc32c: + description: >- + Integrity verification field. A flag indicating whether + DecapsulateRequest.ciphertext_crc32c was received by + KeyManagementService and used for the integrity verification of the + ciphertext. A false value of this field indicates either that + DecapsulateRequest.ciphertext_crc32c was left unset or that it was + not delivered to KeyManagementService. If you've set + DecapsulateRequest.ciphertext_crc32c but this field is still false, + discard the response and perform a limited number of retries. + type: boolean + protectionLevel: + description: The ProtectionLevel of the CryptoKeyVersion used in decapsulation. + type: string + enumDescriptions: + - Not specified. + - Crypto operations are performed in software. + - Crypto operations are performed in a Hardware Security Module. + - Crypto operations are performed by an external key manager. + - Crypto operations are performed in an EKM-over-VPC backend. + enum: + - PROTECTION_LEVEL_UNSPECIFIED + - SOFTWARE + - HSM + - EXTERNAL + - EXTERNAL_VPC GenerateRandomBytesRequest: id: GenerateRandomBytesRequest description: Request message for KeyManagementService.GenerateRandomBytes. @@ -3209,6 +3535,35 @@ components: #/components/x-stackQL-resources/autokey_config/methods/update_autokey_config replace: [] delete: [] + kaj_policy_config: + id: google.cloudkms.kaj_policy_config + name: kaj_policy_config + title: Kaj_policy_config + methods: + get_kaj_policy_config: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1kajPolicyConfig/get + response: + mediaType: application/json + openAPIDocKey: '200' + update_kaj_policy_config: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1kajPolicyConfig/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/kaj_policy_config/methods/get_kaj_policy_config + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/kaj_policy_config/methods/update_kaj_policy_config + replace: [] + delete: [] projects: id: google.cloudkms.projects name: projects @@ -3221,6 +3576,20 @@ components: response: mediaType: application/json openAPIDocKey: '200' + show_effective_key_access_justifications_policy_config: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}:showEffectiveKeyAccessJustificationsPolicyConfig/get + response: + mediaType: application/json + openAPIDocKey: '200' + show_effective_key_access_justifications_enrollment_config: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}:showEffectiveKeyAccessJustificationsEnrollmentConfig/get + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: [] insert: [] @@ -3538,6 +3907,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + update_primary_version: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1keyRings~1{keyRingsId}~1cryptoKeys~1{cryptoKeysId}:updatePrimaryVersion/post + response: + mediaType: application/json + openAPIDocKey: '200' encrypt: operation: $ref: >- @@ -3562,26 +3938,6 @@ components: - $ref: '#/components/x-stackQL-resources/crypto_keys/methods/patch' replace: [] delete: [] - crypto_keys_primary_version: - id: google.cloudkms.crypto_keys_primary_version - name: crypto_keys_primary_version - title: Crypto_keys_primary_version - methods: - update_primary_version: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1keyRings~1{keyRingsId}~1cryptoKeys~1{cryptoKeysId}:updatePrimaryVersion/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: - - $ref: >- - #/components/x-stackQL-resources/crypto_keys_primary_version/methods/update_primary_version - replace: [] - delete: [] crypto_keys_iam_policies: id: google.cloudkms.crypto_keys_iam_policies name: crypto_keys_iam_policies @@ -3716,6 +4072,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + decapsulate: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1keyRings~1{keyRingsId}~1cryptoKeys~1{cryptoKeysId}~1cryptoKeyVersions~1{cryptoKeyVersionsId}:decapsulate/post + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/crypto_key_versions/methods/get' @@ -3875,18 +4238,109 @@ paths: - $ref: '#/components/parameters/_.xgafv' patch: description: >- - Updates the AutokeyConfig for a folder. The caller must have both - `cloudkms.autokeyConfigs.update` permission on the parent folder and - `cloudkms.cryptoKeys.setIamPolicy` permission on the provided key - project. A KeyHandle creation in the folder's descendant projects will - use this configuration to determine where to create the resulting - CryptoKey. - operationId: cloudkms.folders.updateAutokeyConfig + Updates the AutokeyConfig for a folder. The caller must have both + `cloudkms.autokeyConfigs.update` permission on the parent folder and + `cloudkms.cryptoKeys.setIamPolicy` permission on the provided key + project. A KeyHandle creation in the folder's descendant projects will + use this configuration to determine where to create the resulting + CryptoKey. + operationId: cloudkms.folders.updateAutokeyConfig + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AutokeyConfig' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloudkms + Oauth2c: + - https://www.googleapis.com/auth/cloudkms + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/AutokeyConfig' + parameters: + - in: path + name: foldersId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + get: + description: Returns the AutokeyConfig for a folder. + operationId: cloudkms.folders.getAutokeyConfig + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloudkms + Oauth2c: + - https://www.googleapis.com/auth/cloudkms + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/AutokeyConfig' + parameters: + - in: path + name: foldersId + required: true + schema: + type: string + /v1/folders/{foldersId}/kajPolicyConfig: + parameters: *ref_1 + get: + description: >- + Gets the KeyAccessJustificationsPolicyConfig for a given + organization/folder/projects. + operationId: cloudkms.folders.getKajPolicyConfig + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloudkms + Oauth2c: + - https://www.googleapis.com/auth/cloudkms + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/KeyAccessJustificationsPolicyConfig' + parameters: + - in: path + name: foldersId + required: true + schema: + type: string + patch: + description: >- + Updates the KeyAccessJustificationsPolicyConfig for a given + organization/folder/projects. + operationId: cloudkms.folders.updateKajPolicyConfig requestBody: content: application/json: schema: - $ref: '#/components/schemas/AutokeyConfig' + $ref: '#/components/schemas/KeyAccessJustificationsPolicyConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3902,7 +4356,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AutokeyConfig' + $ref: '#/components/schemas/KeyAccessJustificationsPolicyConfig' parameters: - in: path name: foldersId @@ -3914,9 +4368,13 @@ paths: schema: type: string format: google-fieldmask + /v1/projects/{projectsId}:showEffectiveAutokeyConfig: + parameters: *ref_1 get: - description: Returns the AutokeyConfig for a folder. - operationId: cloudkms.folders.getAutokeyConfig + description: >- + Returns the effective Cloud KMS Autokey configuration for a given + project. + operationId: cloudkms.projects.showEffectiveAutokeyConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3932,20 +4390,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AutokeyConfig' + $ref: '#/components/schemas/ShowEffectiveAutokeyConfigResponse' parameters: - in: path - name: foldersId + name: projectsId required: true schema: type: string - /v1/projects/{projectsId}:showEffectiveAutokeyConfig: + /v1/projects/{projectsId}/kajPolicyConfig: parameters: *ref_1 get: description: >- - Returns the effective Cloud KMS Autokey configuration for a given - project. - operationId: cloudkms.projects.showEffectiveAutokeyConfig + Gets the KeyAccessJustificationsPolicyConfig for a given + organization/folder/projects. + operationId: cloudkms.projects.getKajPolicyConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3961,7 +4419,104 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ShowEffectiveAutokeyConfigResponse' + $ref: '#/components/schemas/KeyAccessJustificationsPolicyConfig' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + patch: + description: >- + Updates the KeyAccessJustificationsPolicyConfig for a given + organization/folder/projects. + operationId: cloudkms.projects.updateKajPolicyConfig + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/KeyAccessJustificationsPolicyConfig' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloudkms + Oauth2c: + - https://www.googleapis.com/auth/cloudkms + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/KeyAccessJustificationsPolicyConfig' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}:showEffectiveKeyAccessJustificationsPolicyConfig: + parameters: *ref_1 + get: + description: >- + Returns the KeyAccessJustificationsPolicyConfig of the resource closest + to the given project in hierarchy. + operationId: cloudkms.projects.showEffectiveKeyAccessJustificationsPolicyConfig + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloudkms + Oauth2c: + - https://www.googleapis.com/auth/cloudkms + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/ShowEffectiveKeyAccessJustificationsPolicyConfigResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + /v1/projects/{projectsId}:showEffectiveKeyAccessJustificationsEnrollmentConfig: + parameters: *ref_1 + get: + description: >- + Returns the KeyAccessJustificationsEnrollmentConfig of the resource + closest to the given project in hierarchy. + operationId: cloudkms.projects.showEffectiveKeyAccessJustificationsEnrollmentConfig + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloudkms + Oauth2c: + - https://www.googleapis.com/auth/cloudkms + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/ShowEffectiveKeyAccessJustificationsEnrollmentConfigResponse parameters: - in: path name: projectsId @@ -4123,6 +4678,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: @@ -5695,6 +6254,10 @@ paths: required: true schema: type: string + - in: query + name: publicKeyFormat + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions:import: parameters: *ref_1 post: @@ -6198,6 +6761,62 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}:decapsulate: + parameters: *ref_1 + post: + description: >- + Decapsulates data that was encapsulated with a public key retrieved from + GetPublicKey corresponding to a CryptoKeyVersion with CryptoKey.purpose + KEY_ENCAPSULATION. + operationId: >- + cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.decapsulate + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DecapsulateRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloudkms + Oauth2c: + - https://www.googleapis.com/auth/cloudkms + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/DecapsulateResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: keyRingsId + required: true + schema: + type: string + - in: path + name: cryptoKeysId + required: true + schema: + type: string + - in: path + name: cryptoKeyVersionsId + required: true + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/importJobs: parameters: *ref_1 get: @@ -6612,3 +7231,69 @@ paths: required: true schema: type: string + /v1/organizations/{organizationsId}/kajPolicyConfig: + parameters: *ref_1 + get: + description: >- + Gets the KeyAccessJustificationsPolicyConfig for a given + organization/folder/projects. + operationId: cloudkms.organizations.getKajPolicyConfig + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloudkms + Oauth2c: + - https://www.googleapis.com/auth/cloudkms + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/KeyAccessJustificationsPolicyConfig' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + patch: + description: >- + Updates the KeyAccessJustificationsPolicyConfig for a given + organization/folder/projects. + operationId: cloudkms.organizations.updateKajPolicyConfig + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/KeyAccessJustificationsPolicyConfig' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloudkms + Oauth2c: + - https://www.googleapis.com/auth/cloudkms + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/KeyAccessJustificationsPolicyConfig' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask diff --git a/providers/src/googleapis.com/v00.00.00000/services/cloudlocationfinder.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudlocationfinder.yaml new file mode 100644 index 00000000..a281117a --- /dev/null +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudlocationfinder.yaml @@ -0,0 +1,537 @@ +openapi: 3.1.0 +info: + contact: + name: StackQL Studios + url: https://github.com/stackql/google-discovery-to-openapi + email: info@stackql.io + title: Cloud Location Finder API + description: '' + version: v1alpha + x-discovery-doc-revision: '20250825' + x-generated-date: '2025-08-28' +externalDocs: + url: https://cloud.google.com/location-finder/docs +servers: + - url: https://cloudlocationfinder.googleapis.com +components: + securitySchemes: + Oauth2: + type: oauth2 + description: Oauth 2.0 implicit authentication + flows: + implicit: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + scopes: &ref_0 + 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. + Oauth2c: + type: oauth2 + description: Oauth 2.0 authorization code authentication + flows: + authorizationCode: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + tokenUrl: https://accounts.google.com/o/oauth2/token + scopes: *ref_0 + schemas: + ListCloudLocationsResponse: + id: ListCloudLocationsResponse + description: Message for response to listing cloud locations. + type: object + properties: + cloudLocations: + description: Output only. List of cloud locations. + readOnly: true + type: array + items: + $ref: '#/components/schemas/CloudLocation' + nextPageToken: + description: >- + Output only. The continuation token, used to page through large + result sets. Provide this value in a subsequent request as + page_token in subsequent requests to retrieve the next page. If this + field is not present, there are no subsequent results. + readOnly: true + type: string + CloudLocation: + id: CloudLocation + description: Represents resource cloud locations. + type: object + properties: + name: + description: >- + Identifier. Name of the cloud location. Unique name of the cloud + location including project and location using the form: + `projects/{project_id}/locations/{location}/cloudLocations/{cloud_location}` + type: string + containingCloudLocation: + description: >- + Output only. The containing cloud location in the strict nesting + hierarchy. For example, the containing cloud location of a zone is a + region. + readOnly: true + type: string + displayName: + description: >- + Optional. The human-readable name of the cloud location. Example: + us-east-2, us-east1. + type: string + cloudProvider: + description: >- + Optional. The provider of the cloud location. Values can be Google + Cloud or third-party providers, including AWS, Azure, or Oracle + Cloud Infrastructure. + type: string + enumDescriptions: + - Unspecified type. + - Cloud provider type for Google Cloud. + - Cloud provider type for AWS. + - Cloud provider type for Azure. + - Cloud provider type for OCI. + enum: + - CLOUD_PROVIDER_UNSPECIFIED + - CLOUD_PROVIDER_GCP + - CLOUD_PROVIDER_AWS + - CLOUD_PROVIDER_AZURE + - CLOUD_PROVIDER_OCI + territoryCode: + description: >- + Optional. The two-letter ISO 3166-1 alpha-2 code of the cloud + location. Examples: US, JP, KR. + type: string + cloudLocationType: + description: Optional. The type of the cloud location. + type: string + enumDescriptions: + - Unspecified type. + - CloudLocation type for region. + - CloudLocation type for zone. + - CloudLocation type for region extension. + - CloudLocation type for Google Distributed Cloud Connected Zone. + enum: + - CLOUD_LOCATION_TYPE_UNSPECIFIED + - CLOUD_LOCATION_TYPE_REGION + - CLOUD_LOCATION_TYPE_ZONE + - CLOUD_LOCATION_TYPE_REGION_EXTENSION + - CLOUD_LOCATION_TYPE_GDCC_ZONE + carbonFreeEnergyPercentage: + description: >- + Optional. The carbon free energy percentage of the cloud location. + This represents the average percentage of time customers' + application will be running on carbon-free energy. See + https://cloud.google.com/sustainability/region-carbon for more + details. There is a difference between default value 0 and unset + value. 0 means the carbon free energy percentage is 0%, while unset + value means the carbon footprint data is not available. + type: number + format: float + SearchCloudLocationsResponse: + id: SearchCloudLocationsResponse + description: Message for response to searching cloud locations. + type: object + properties: + cloudLocations: + description: Output only. List of cloud locations. + readOnly: true + type: array + items: + $ref: '#/components/schemas/CloudLocation' + nextPageToken: + description: >- + Output only. The continuation token, used to page through large + result sets. Provide this value in a subsequent request as + page_token in subsequent requests to retrieve the next page. If this + field is not present, there are no subsequent results. + readOnly: true + type: string + ListLocationsResponse: + id: ListLocationsResponse + description: The response message for Locations.ListLocations. + type: object + properties: + locations: + description: >- + A list of locations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/Location' + nextPageToken: + description: The standard List next-page token. + type: string + Location: + id: Location + description: A resource that represents a Google Cloud location. + type: object + properties: + name: + description: >- + Resource name for the location, which may vary between + implementations. For example: + `"projects/example-project/locations/us-east1"` + type: string + locationId: + description: 'The canonical id for this location. For example: `"us-east1"`.' + type: string + displayName: + description: >- + The friendly name for this location, typically a nearby city name. + For example, "Tokyo". + type: string + labels: + description: >- + Cross-service attributes for the location. For example + {"cloud.googleapis.com/region": "us-east1"} + type: object + additionalProperties: + type: string + metadata: + description: >- + Service-specific metadata. For example the available capacity at the + given location. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + parameters: + 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: + type: string + enum: + - json + - media + - proto + 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 + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + x-stackQL-resources: + locations: + id: google.cloudlocationfinder.locations + name: locations + title: Locations + methods: + list: + operation: + $ref: '#/paths/~1v1alpha~1projects~1{projectsId}~1locations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.locations + get: + operation: + $ref: >- + #/paths/~1v1alpha~1projects~1{projectsId}~1locations~1{locationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + cloud_locations: + id: google.cloudlocationfinder.cloud_locations + name: cloud_locations + title: Cloud_locations + methods: + list: + operation: + $ref: >- + #/paths/~1v1alpha~1projects~1{projectsId}~1locations~1{locationsId}~1cloudLocations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.cloudLocations + get: + operation: + $ref: >- + #/paths/~1v1alpha~1projects~1{projectsId}~1locations~1{locationsId}~1cloudLocations~1{cloudLocationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + search: + operation: + $ref: >- + #/paths/~1v1alpha~1projects~1{projectsId}~1locations~1{locationsId}~1cloudLocations:search/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/cloud_locations/methods/get' + - $ref: '#/components/x-stackQL-resources/cloud_locations/methods/list' + insert: [] + update: [] + replace: [] + delete: [] +paths: + /v1alpha/projects/{projectsId}/locations: + parameters: &ref_1 + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' + get: + description: Lists information about the supported locations for this service. + operationId: cloudlocationfinder.projects.locations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListLocationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: extraLocationTypes + schema: + type: string + /v1alpha/projects/{projectsId}/locations/{locationsId}: + parameters: *ref_1 + get: + description: Gets information about a location. + operationId: cloudlocationfinder.projects.locations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Location' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1alpha/projects/{projectsId}/locations/{locationsId}/cloudLocations: + parameters: *ref_1 + get: + description: Lists cloud locations under a given project and location. + operationId: cloudlocationfinder.projects.locations.cloudLocations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListCloudLocationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1alpha/projects/{projectsId}/locations/{locationsId}/cloudLocations/{cloudLocationsId}: + parameters: *ref_1 + get: + description: Retrieves a resource containing information about a cloud location. + operationId: cloudlocationfinder.projects.locations.cloudLocations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/CloudLocation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: cloudLocationsId + required: true + schema: + type: string + /v1alpha/projects/{projectsId}/locations/{locationsId}/cloudLocations:search: + parameters: *ref_1 + get: + description: Searches for cloud locations from a given source location. + operationId: cloudlocationfinder.projects.locations.cloudLocations.search + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SearchCloudLocationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: sourceCloudLocation + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: query + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/cloudprofiler.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudprofiler.yaml index e7d5c493..ba8930e9 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudprofiler.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudprofiler.yaml @@ -7,8 +7,8 @@ info: title: Cloud Profiler API description: Manages continuous profiling information. version: v2 - x-discovery-doc-revision: '20241028' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250818' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/profiler/ servers: @@ -321,6 +321,12 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.profiles + create_offline: + operation: + $ref: '#/paths/~1v2~1projects~1{projectsId}~1profiles:createOffline/post' + response: + mediaType: application/json + openAPIDocKey: '200' patch: operation: $ref: '#/paths/~1v2~1projects~1{projectsId}~1profiles~1{profilesId}/patch' @@ -336,25 +342,6 @@ components: - $ref: '#/components/x-stackQL-resources/profiles/methods/patch' replace: [] delete: [] - profiles_offline: - id: google.cloudprofiler.profiles_offline - name: profiles_offline - title: Profiles_offline - methods: - create_offline: - operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1profiles:createOffline/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: >- - #/components/x-stackQL-resources/profiles_offline/methods/create_offline - update: [] - replace: [] - delete: [] paths: /v2/projects/{projectsId}/profiles: parameters: &ref_1 diff --git a/providers/src/googleapis.com/v00.00.00000/services/cloudresourcemanager.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudresourcemanager.yaml index 81a686aa..b8d26e0c 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudresourcemanager.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudresourcemanager.yaml @@ -9,8 +9,8 @@ info: Creates, reads, and updates metadata for Google Cloud Platform resource containers. version: v3 - x-discovery-doc-revision: '20241023' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250606' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/resource-manager servers: @@ -198,9 +198,8 @@ components: properties: name: description: >- - Output only. The resource name of the folder. Its format is + Identifier. The resource name of the folder. Its format is `folders/{folder_id}`, for example: "folders/1234". - readOnly: true type: string parent: description: >- @@ -263,6 +262,22 @@ components: type: object additionalProperties: type: string + configuredCapabilities: + description: >- + Output only. Optional capabilities configured for this folder (via + UpdateCapability API). Example: + `folders/123/capabilities/app-management`. + readOnly: true + type: array + items: + type: string + managementProject: + description: >- + Output only. Management Project associated with this folder (if + app-management capability is enabled). Example: + `projects/google-mp-123` OUTPUT ONLY. + readOnly: true + type: string ListFoldersResponse: id: ListFoldersResponse description: The ListFolders response message. @@ -863,6 +878,16 @@ components: type: object additionalProperties: type: string + configuredCapabilities: + description: >- + Output only. If this project is a Management Project, list of + capabilities configured on the parent folder. Note, presence of any + capability implies that this is a Management Project. Example: + `folders/123/capabilities/app-management`. OUTPUT ONLY. + readOnly: true + type: array + items: + type: string ListProjectsResponse: id: ListProjectsResponse description: >- @@ -927,6 +952,82 @@ components: description: The request sent to the UndeleteProject method. type: object properties: {} + Capability: + id: Capability + description: Representation of a Capability. + type: object + properties: + name: + description: >- + Immutable. Identifier. The resource name of the capability. Must be + in the following form: * + `folders/{folder_id}/capabilities/{capability_name}` For example, + `folders/123/capabilities/app-management` Following are the allowed + {capability_name} values: * `app-management` + type: string + value: + description: >- + Required. The configured value of the capability at the given parent + resource. + type: boolean + TagBindingCollection: + id: TagBindingCollection + description: Represents a collection of tags directly bound to a GCP resource. + type: object + properties: + name: + description: >- + Identifier. The name of the TagBindingCollection, following the + convention: + `locations/{location}/tagBindingCollections/{encoded-full-resource-name}` + where the encoded-full-resource-name is the UTF-8 encoded name of + the GCP resource the TagBindings are bound to. + "locations/global/tagBindingCollections/%2f%2fcloudresourcemanager.googleapis.com%2fprojects%2f123" + type: string + fullResourceName: + description: >- + The full resource name of the resource the TagBindings are bound to. + E.g. `//cloudresourcemanager.googleapis.com/projects/123` + type: string + tags: + description: >- + Tag keys/values directly bound to this resource, specified in + namespaced format. For example: "123/environment": "production" + type: object + additionalProperties: + type: string + etag: + description: >- + Optional. A checksum based on the current bindings which can be + passed to prevent race conditions. This field is always set in + server responses. + type: string + EffectiveTagBindingCollection: + id: EffectiveTagBindingCollection + description: Represents a collection of effective tag bindings for a GCP resource. + type: object + properties: + name: + description: >- + Identifier. The name of the EffectiveTagBindingCollection, following + the convention: + `locations/{location}/effectiveTagBindingCollections/{encoded-full-resource-name}` + where the encoded-full-resource-name is the UTF-8 encoded name of + the GCP resource the TagBindings are bound to. E.g. + "locations/global/effectiveTagBindingCollections/%2f%2fcloudresourcemanager.googleapis.com%2fprojects%2f123" + type: string + fullResourceName: + description: >- + The full resource name of the resource the TagBindings are bound to. + E.g. `//cloudresourcemanager.googleapis.com/projects/123` + type: string + effectiveTags: + description: >- + Tag keys/values effectively bound to this resource, specified in + namespaced format. For example: "123/environment": "production" + type: object + additionalProperties: + type: string ListTagBindingsResponse: id: ListTagBindingsResponse description: The ListTagBindings response. @@ -1144,7 +1245,7 @@ components: description: >- Required. Immutable. The user friendly name for a TagKey. The short name should be unique for TagKeys within the same tag namespace. The - short name must be 1-63 characters, beginning and ending with an + short name must be 1-256 characters, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. type: string @@ -1247,7 +1348,7 @@ components: description: >- Required. Immutable. User-assigned short name for TagValue. The short name should be unique for TagValues within the same parent - TagKey. The short name must be 63 characters or less, beginning and + TagKey. The short name must be 256 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. type: string @@ -1821,6 +1922,33 @@ components: - $ref: >- #/components/x-stackQL-resources/folders_iam_policies/methods/set_iam_policy delete: [] + capabilities: + id: google.cloudresourcemanager.capabilities + name: capabilities + title: Capabilities + methods: + get: + operation: + $ref: >- + #/paths/~1v3~1folders~1{foldersId}~1capabilities~1{capabilitiesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v3~1folders~1{foldersId}~1capabilities~1{capabilitiesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/capabilities/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/capabilities/methods/patch' + replace: [] + delete: [] organizations: id: google.cloudresourcemanager.organizations name: organizations @@ -1979,6 +2107,55 @@ components: - $ref: >- #/components/x-stackQL-resources/projects_iam_policies/methods/set_iam_policy delete: [] + tag_binding_collections: + id: google.cloudresourcemanager.tag_binding_collections + name: tag_binding_collections + title: Tag_binding_collections + methods: + get: + operation: + $ref: >- + #/paths/~1v3~1locations~1{locationsId}~1tagBindingCollections~1{tagBindingCollectionsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: >- + #/paths/~1v3~1locations~1{locationsId}~1tagBindingCollections~1{tagBindingCollectionsId}/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/tag_binding_collections/methods/get + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/tag_binding_collections/methods/update + delete: [] + effective_tag_binding_collections: + id: google.cloudresourcemanager.effective_tag_binding_collections + name: effective_tag_binding_collections + title: Effective_tag_binding_collections + methods: + get: + operation: + $ref: >- + #/paths/~1v3~1locations~1{locationsId}~1effectiveTagBindingCollections~1{effectiveTagBindingCollectionsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/effective_tag_binding_collections/methods/get + insert: [] + update: [] + replace: [] + delete: [] tag_bindings: id: google.cloudresourcemanager.tag_bindings name: tag_bindings @@ -2839,6 +3016,70 @@ paths: required: true schema: type: string + /v3/folders/{foldersId}/capabilities/{capabilitiesId}: + parameters: *ref_1 + get: + description: Retrieves the Capability identified by the supplied resource name. + operationId: cloudresourcemanager.folders.capabilities.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Capability' + parameters: + - in: path + name: foldersId + required: true + schema: + type: string + - in: path + name: capabilitiesId + required: true + schema: + type: string + patch: + description: Updates the Capability. + operationId: cloudresourcemanager.folders.capabilities.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Capability' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: foldersId + required: true + schema: + type: string + - in: path + name: capabilitiesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask /v3/organizations/{organizationsId}: parameters: *ref_1 get: @@ -3093,9 +3334,7 @@ paths: state checked by retrieving the project with GetProject, and the project remains visible to ListProjects. However, you cannot update the project. After the deletion completes, the project is not retrievable by the - GetProject, ListProjects, and SearchProjects methods. This method - behaves idempotently, such that deleting a `DELETE_REQUESTED` project - will not cause an error, but also won't do anything. The caller must + GetProject, ListProjects, and SearchProjects methods. The caller must have `resourcemanager.projects.delete` permissions for this project. operationId: cloudresourcemanager.projects.delete security: @@ -3425,6 +3664,101 @@ paths: required: true schema: type: string + /v3/locations/{locationsId}/tagBindingCollections/{tagBindingCollectionsId}: + parameters: *ref_1 + get: + description: Returns tag bindings directly attached to a GCP resource. + operationId: cloudresourcemanager.locations.tagBindingCollections.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/TagBindingCollection' + parameters: + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: tagBindingCollectionsId + required: true + schema: + type: string + put: + description: Updates tag bindings directly attached to a GCP resource. + operationId: cloudresourcemanager.locations.tagBindingCollections.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TagBindingCollection' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: tagBindingCollectionsId + required: true + schema: + type: string + /v3/locations/{locationsId}/effectiveTagBindingCollections/{effectiveTagBindingCollectionsId}: + parameters: *ref_1 + get: + description: Returns effective tag bindings on a GCP resource. + operationId: cloudresourcemanager.locations.effectiveTagBindingCollections.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/EffectiveTagBindingCollection' + parameters: + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: effectiveTagBindingCollectionsId + required: true + schema: + type: string /v3/tagBindings: parameters: *ref_1 get: diff --git a/providers/src/googleapis.com/v00.00.00000/services/cloudscheduler.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudscheduler.yaml index 4206a667..c2c949cd 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudscheduler.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudscheduler.yaml @@ -7,8 +7,8 @@ info: title: Cloud Scheduler API description: Creates and manages jobs run on a regular recurring schedule. version: v1 - x-discovery-doc-revision: '20241028' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250728' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/scheduler/ servers: @@ -238,6 +238,12 @@ components: For Pub/Sub targets, this field is ignored. type: string format: google-duration + satisfiesPzs: + description: >- + Output only. Whether or not this Job satisfies the requirements of + physical zone separation + readOnly: true + type: boolean PubsubTarget: id: PubsubTarget description: >- @@ -587,34 +593,40 @@ components: RetryConfig: id: RetryConfig description: >- - Settings that determine the retry behavior. By default, if a job does - not complete successfully (meaning that an acknowledgement is not - received from the handler, then it will be retried with exponential - backoff according to the settings in RetryConfig. + Settings that determine the retry behavior. For more information, see + [Retry + jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs). + By default, if a job does not complete successfully (meaning that an + acknowledgement is not received from the handler, then it will be + retried with exponential backoff according to the settings in + RetryConfig. type: object properties: retryCount: description: >- The number of attempts that the system will make to run a job using the exponential backoff procedure described by max_doublings. The - default value of retry_count is zero. If retry_count is 0, a job - attempt will not be retried if it fails. Instead the Cloud Scheduler - system will wait for the next scheduled execution time. Setting - retry_count to 0 does not prevent failed jobs from running according - to schedule after the failure. If retry_count is set to a non-zero - number then Cloud Scheduler will retry failed attempts, using - exponential backoff, retry_count times, or until the next scheduled - execution time, whichever comes first. Values greater than 5 and + default value of retry_count is zero. If retry_count is 0 (and if + max_retry_duration is also 0), a job attempt won't be retried if it + fails. Instead, Cloud Scheduler system will wait for the next + scheduled execution time. Setting retry_count to 0 doesn't prevent + failed jobs from running according to schedule after the failure. If + retry_count is set to a non-zero number, Cloud Scheduler will retry + the failed job, using exponential backoff, for retry_count times + until the job succeeds or the number of retries is exhausted. Note + that the next scheduled execution time might be skipped if the + retries continue through that time. Values greater than 5 and negative values are not allowed. type: integer format: int32 maxRetryDuration: description: >- - The time limit for retrying a failed job, measured from time when an - execution was first attempted. If specified with retry_count, the - job will be retried until both limits are reached. The default value - for max_retry_duration is zero, which means retry duration is - unlimited. + The time limit for retrying a failed job, measured from the time + when an execution was first attempted. If specified with + retry_count, the job will be retried until both limits are reached. + The default value for max_retry_duration is zero, which means retry + duration is unlimited. However, if retry_count is also 0, a job + attempt won't be retried if it fails. type: string format: google-duration minBackoffDuration: @@ -635,14 +647,9 @@ components: retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For - example, if min_backoff_duration is 10s, max_backoff_duration is - 300s, and `max_doublings` is 3, then the job will first be retried - in 10s. The retry interval will double three times, and then - increase linearly by 2^3 * 10s. Finally, the job will retry at - intervals of max_backoff_duration until the job has been attempted - retry_count times. Thus, the requests will retry at 10s, 20s, 40s, - 80s, 160s, 240s, 300s, 300s, .... The default value of this field is - 5. + examples, see [Retry + jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs#max-doublings). + The default value of this field is 5. type: integer format: int32 Empty: @@ -825,8 +832,8 @@ components: description: >- Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully - have Operation.error value with a google.rpc.Status.code of 1, - corresponding to `Code.CANCELLED`. + have google.longrunning.Operation.error value with a + google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. readOnly: true type: boolean apiVersion: @@ -1100,6 +1107,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: @@ -1515,7 +1526,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: cloudscheduler.operations.cancel requestBody: content: diff --git a/providers/src/googleapis.com/v00.00.00000/services/cloudshell.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudshell.yaml index 05cbc2cc..c856dbca 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudshell.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudshell.yaml @@ -9,8 +9,8 @@ info: Allows users to start, configure, and connect to interactive shell sessions running in the cloud. version: v1 - x-discovery-doc-revision: '20241028' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250815' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/shell/docs/ servers: @@ -544,10 +544,10 @@ components: update: [] replace: [] delete: [] - environments_public_key: - id: google.cloudshell.environments_public_key - name: environments_public_key - title: Environments_public_key + public_keys: + id: google.cloudshell.public_keys + name: public_keys + title: Public_keys methods: add_public_key: operation: @@ -567,12 +567,12 @@ components: select: [] insert: - $ref: >- - #/components/x-stackQL-resources/environments_public_key/methods/add_public_key + #/components/x-stackQL-resources/public_keys/methods/add_public_key update: [] replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/environments_public_key/methods/remove_public_key + #/components/x-stackQL-resources/public_keys/methods/remove_public_key paths: /v1/operations: parameters: &ref_1 @@ -681,7 +681,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: cloudshell.operations.cancel requestBody: content: diff --git a/providers/src/googleapis.com/v00.00.00000/services/cloudsupport.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudsupport.yaml index 78b59050..e503f01f 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudsupport.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudsupport.yaml @@ -9,8 +9,8 @@ info: Manages Google Cloud technical support cases for Customer Care support offerings. version: v2 - x-discovery-doc-revision: '20241104' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250826' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/support/docs/apis servers: @@ -36,415 +36,259 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - DiffChecksumsResponse: - properties: - objectSizeBytes: - type: string - format: int64 - description: '# gdata.* are outside protos with mising documentation' - objectLocation: - description: '# gdata.* are outside protos with mising documentation' - $ref: '#/components/schemas/CompositeMedia' - chunkSizeBytes: - description: '# gdata.* are outside protos with mising documentation' - type: string - format: int64 - checksumsLocation: - $ref: '#/components/schemas/CompositeMedia' - description: '# gdata.* are outside protos with mising documentation' - objectVersion: - type: string - description: '# gdata.* are outside protos with mising documentation' - description: '# gdata.* are outside protos with mising documentation' - id: DiffChecksumsResponse - type: object - DiffVersionResponse: - id: DiffVersionResponse - description: '# gdata.* are outside protos with mising documentation' - properties: - objectSizeBytes: - format: int64 - description: '# gdata.* are outside protos with mising documentation' - type: string - objectVersion: - description: '# gdata.* are outside protos with mising documentation' - type: string - type: object - CreateAttachmentRequest: - id: CreateAttachmentRequest - type: object - properties: - attachment: - $ref: '#/components/schemas/Attachment' - description: Required. The attachment to be created. - description: The request message for the CreateAttachment endpoint. - SearchCaseClassificationsResponse: - id: SearchCaseClassificationsResponse - description: The response message for SearchCaseClassifications endpoint. + ListAttachmentsResponse: + id: ListAttachmentsResponse + description: The response message for the ListAttachments endpoint. type: object properties: - caseClassifications: + attachments: + description: The list of attachments associated with a case. type: array - description: The classifications retrieved. items: - $ref: '#/components/schemas/CaseClassification' + $ref: '#/components/schemas/Attachment' nextPageToken: description: >- A token to retrieve the next page of results. Set this in the - `page_token` field of subsequent `caseClassifications.list` - requests. If unspecified, there are no more results to retrieve. - type: string - ObjectId: - properties: - generation: - description: '# gdata.* are outside protos with mising documentation' - type: string - format: int64 - objectName: - type: string - description: '# gdata.* are outside protos with mising documentation' - bucketName: + `page_token` field of subsequent `cases.attachments.list` requests. + If unspecified, there are no more results to retrieve. type: string - description: '# gdata.* are outside protos with mising documentation' + Attachment: + id: Attachment + description: >- + An Attachment contains metadata about a file that was uploaded to a case + - it is NOT a file itself. That being said, the name of an Attachment + object can be used to download its accompanying file through the + `media.download` endpoint. While attachments can be uploaded in the + console at the same time as a comment, they're associated on a "case" + level, not a "comment" level. type: object - id: ObjectId - description: '# gdata.* are outside protos with mising documentation' - Actor: properties: - username: + name: + description: Output only. Identifier. The resource name of the attachment. + readOnly: true type: string + createTime: + description: Output only. The time at which the attachment was created. readOnly: true + type: string + format: google-datetime + creator: description: >- - Output only. The username of the actor. It may look like an email or - other format provided by the identity provider. If not provided, it - is inferred from the credentials supplied. When a name is provided, - a username must also be provided. If the user is a Google Support - agent, this will not be set. - googleSupport: - type: boolean + Output only. The user who uploaded the attachment. Note, the name + and email will be obfuscated if the attachment was uploaded by + Google support. readOnly: true - description: Output only. Whether the actor is a Google support actor. - email: - deprecated: true - description: >- - The email address of the actor. If not provided, it is inferred from - the credentials supplied during case creation. When a name is - provided, an email must also be provided. If the user is a Google - Support agent, this is obfuscated. This field is deprecated. Use - **username** field instead. + $ref: '#/components/schemas/Actor' + filename: + description: The filename of the attachment (e.g. `"graph.jpg"`). type: string - displayName: + mimeType: + description: Output only. The MIME type of the attachment (e.g. text/plain). + readOnly: true type: string - description: >- - The name to display for the actor. If not provided, it is inferred - from credentials supplied during case creation. When an email is - provided, a display name must also be provided. This will be - obfuscated if the user is a Google Support agent. - type: object + sizeBytes: + description: Output only. The size of the attachment in bytes. + readOnly: true + type: string + format: int64 + Actor: id: Actor description: >- An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. - DiffUploadRequest: - description: '# gdata.* are outside protos with mising documentation' type: object - id: DiffUploadRequest properties: - objectVersion: - description: '# gdata.* are outside protos with mising documentation' - type: string - objectInfo: - description: '# gdata.* are outside protos with mising documentation' - $ref: '#/components/schemas/CompositeMedia' - checksumsInfo: - description: '# gdata.* are outside protos with mising documentation' - $ref: '#/components/schemas/CompositeMedia' - Blobstore2Info: - id: Blobstore2Info - type: object - description: '# gdata.* are outside protos with mising documentation' - properties: - readToken: - description: '# gdata.* are outside protos with mising documentation' - type: string - downloadReadHandle: - description: '# gdata.* are outside protos with mising documentation' - format: byte - type: string - uploadMetadataContainer: - format: byte - type: string - description: '# gdata.* are outside protos with mising documentation' - blobId: - type: string - description: '# gdata.* are outside protos with mising documentation' - blobGeneration: - description: '# gdata.* are outside protos with mising documentation' - type: string - format: int64 - Comment: - id: Comment - properties: - createTime: - readOnly: true - type: string - format: google-datetime - description: Output only. The time when the comment was created. - plainTextBody: - readOnly: true - type: string - deprecated: true + displayName: description: >- - Output only. DEPRECATED. DO NOT USE. A duplicate of the `body` - field. This field is only present for legacy reasons. - body: - description: The full comment body. Maximum of 12800 characters. + The name to display for the actor. If not provided, it is inferred + from credentials supplied during case creation. When an email is + provided, a display name must also be provided. This will be + obfuscated if the user is a Google Support agent. type: string - creator: - readOnly: true + email: description: >- - Output only. The user or Google Support agent who created the - comment. - $ref: '#/components/schemas/Actor' - name: + The email address of the actor. If not provided, it is inferred from + the credentials supplied during case creation. When a name is + provided, an email must also be provided. If the user is a Google + Support agent, this is obfuscated. This field is deprecated. Use + `username` instead. + deprecated: true type: string - description: Output only. Identifier. The resource name of the comment. + googleSupport: + description: Output only. Whether the actor is a Google support actor. readOnly: true - description: >- - A comment associated with a support case. Case comments are the primary - way for Google Support to communicate with a user who has opened a case. - When a user responds to Google Support, the user's responses also appear - as comments. - type: object - SearchCasesResponse: - type: object - description: The response message for the SearchCases endpoint. - properties: - cases: - items: - $ref: '#/components/schemas/Case' - type: array - description: >- - The list of cases associated with the parent after any filters have - been applied. - nextPageToken: + type: boolean + username: description: >- - A token to retrieve the next page of results. Set this in the - `page_token` field of subsequent `cases.search` requests. If - unspecified, there are no more results to retrieve. + Output only. The username of the actor. It may look like an email or + other format provided by the identity provider. If not provided, it + is inferred from the credentials supplied. When a name is provided, + a username must also be provided. If the user is a Google Support + agent, this will not be set. + readOnly: true type: string - id: SearchCasesResponse - DiffDownloadResponse: - id: DiffDownloadResponse - type: object - properties: - objectLocation: - description: '# gdata.* are outside protos with mising documentation' - $ref: '#/components/schemas/CompositeMedia' - description: '# gdata.* are outside protos with mising documentation' - WorkflowOperationMetadata: - id: WorkflowOperationMetadata + CreateAttachmentRequest: + id: CreateAttachmentRequest + description: The request message for the CreateAttachment endpoint. type: object properties: - namespace: - description: >- - The namespace that the job was scheduled in. Must be included in the - workflow metadata so the workflow status can be retrieved. - type: string - workflowOperationType: - description: Which version of the workflow service this operation came from. - enumDescriptions: - - Unknown version. - - Version 1. - - Version 2. - type: string - enum: - - UNKNOWN_OPERATION_TYPE - - WORKFLOWS_V1 - - WORKFLOWS_V2 - operationAction: - enumDescriptions: - - Operation action is not specified. - - Operation pertains to the creation of a new support account. - - Operation pertains to the updating of an existing support account. - - >- - Operation pertains to the purchasing of a support plan that may - either create or update a support account. - enum: - - OPERATION_ACTION_UNSPECIFIED - - CREATE_SUPPORT_ACCOUNT - - UPDATE_SUPPORT_ACCOUNT - - PURCHASE_SUPPORT_ACCOUNT - description: The type of action the operation is classified as. - type: string - description: Metadata about the operation. Used to lookup the current status. + attachment: + description: Required. The attachment to be created. + $ref: '#/components/schemas/Attachment' Media: id: Media - type: object description: '# gdata.* are outside protos with mising documentation' + type: object properties: - downloadParameters: - description: '# gdata.* are outside protos with mising documentation' - $ref: '#/components/schemas/DownloadParameters' contentType: description: '# gdata.* are outside protos with mising documentation' type: string - hash: - type: string - deprecated: true - description: '# gdata.* are outside protos with mising documentation' - compositeMedia: - items: - $ref: '#/components/schemas/CompositeMedia' - type: array + timestamp: description: '# gdata.* are outside protos with mising documentation' - filename: type: string + format: uint64 + token: description: '# gdata.* are outside protos with mising documentation' - algorithm: - description: '# gdata.* are outside protos with mising documentation' - deprecated: true type: string - diffUploadRequest: - description: '# gdata.* are outside protos with mising documentation' - $ref: '#/components/schemas/DiffUploadRequest' length: + description: '# gdata.* are outside protos with mising documentation' type: string format: int64 + filename: description: '# gdata.* are outside protos with mising documentation' - diffChecksumsResponse: - description: '# gdata.* are outside protos with mising documentation' - $ref: '#/components/schemas/DiffChecksumsResponse' - token: type: string + referenceType: description: '# gdata.* are outside protos with mising documentation' - hashVerified: - description: '# gdata.* are outside protos with mising documentation' - type: boolean + type: string + enumDescriptions: + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' + enum: + - PATH + - BLOB_REF + - INLINE + - GET_MEDIA + - COMPOSITE_MEDIA + - BIGSTORE_REF + - DIFF_VERSION_RESPONSE + - DIFF_CHECKSUMS_RESPONSE + - DIFF_DOWNLOAD_RESPONSE + - DIFF_UPLOAD_REQUEST + - DIFF_UPLOAD_RESPONSE + - COSMO_BINARY_REFERENCE + - ARBITRARY_BYTES path: description: '# gdata.* are outside protos with mising documentation' type: string - bigstoreObjectRef: + blobRef: description: '# gdata.* are outside protos with mising documentation' - type: string deprecated: true + type: string format: byte - sha256Hash: + inline: description: '# gdata.* are outside protos with mising documentation' - format: byte type: string - objectId: - description: '# gdata.* are outside protos with mising documentation' - $ref: '#/components/schemas/ObjectId' - diffVersionResponse: - $ref: '#/components/schemas/DiffVersionResponse' - description: '# gdata.* are outside protos with mising documentation' - diffDownloadResponse: - description: '# gdata.* are outside protos with mising documentation' - $ref: '#/components/schemas/DiffDownloadResponse' - inline: format: byte - type: string + mediaId: description: '# gdata.* are outside protos with mising documentation' - blobRef: type: string format: byte - deprecated: true + hash: description: '# gdata.* are outside protos with mising documentation' - cosmoBinaryReference: - format: byte + deprecated: true type: string + algorithm: description: '# gdata.* are outside protos with mising documentation' - mediaId: + deprecated: true type: string + compositeMedia: description: '# gdata.* are outside protos with mising documentation' - format: byte - sha1Hash: - description: '# gdata.* are outside protos with mising documentation' - format: byte - type: string - crc32cHash: - format: uint32 + type: array + items: + $ref: '#/components/schemas/CompositeMedia' + bigstoreObjectRef: description: '# gdata.* are outside protos with mising documentation' - type: integer - timestamp: + deprecated: true type: string + format: byte + objectId: description: '# gdata.* are outside protos with mising documentation' - format: uint64 + $ref: '#/components/schemas/ObjectId' blobstore2Info: description: '# gdata.* are outside protos with mising documentation' $ref: '#/components/schemas/Blobstore2Info' - md5Hash: + diffVersionResponse: description: '# gdata.* are outside protos with mising documentation' - format: byte - type: string - contentTypeInfo: - $ref: '#/components/schemas/ContentTypeInfo' + $ref: '#/components/schemas/DiffVersionResponse' + diffChecksumsResponse: description: '# gdata.* are outside protos with mising documentation' - isPotentialRetry: + $ref: '#/components/schemas/DiffChecksumsResponse' + diffDownloadResponse: description: '# gdata.* are outside protos with mising documentation' - type: boolean - referenceType: - enum: - - PATH - - BLOB_REF - - INLINE - - GET_MEDIA - - COMPOSITE_MEDIA - - BIGSTORE_REF - - DIFF_VERSION_RESPONSE - - DIFF_CHECKSUMS_RESPONSE - - DIFF_DOWNLOAD_RESPONSE - - DIFF_UPLOAD_REQUEST - - DIFF_UPLOAD_RESPONSE - - COSMO_BINARY_REFERENCE - - ARBITRARY_BYTES - enumDescriptions: - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' + $ref: '#/components/schemas/DiffDownloadResponse' + diffUploadRequest: description: '# gdata.* are outside protos with mising documentation' - type: string + $ref: '#/components/schemas/DiffUploadRequest' diffUploadResponse: + description: '# gdata.* are outside protos with mising documentation' $ref: '#/components/schemas/DiffUploadResponse' + contentTypeInfo: description: '# gdata.* are outside protos with mising documentation' - CompositeMedia: - description: '# gdata.* are outside protos with mising documentation' - id: CompositeMedia - properties: + $ref: '#/components/schemas/ContentTypeInfo' + downloadParameters: + description: '# gdata.* are outside protos with mising documentation' + $ref: '#/components/schemas/DownloadParameters' crc32cHash: - type: integer description: '# gdata.* are outside protos with mising documentation' + type: integer format: uint32 - blobRef: - deprecated: true + md5Hash: + description: '# gdata.* are outside protos with mising documentation' + type: string + format: byte + sha1Hash: description: '# gdata.* are outside protos with mising documentation' type: string format: byte - path: + sha256Hash: description: '# gdata.* are outside protos with mising documentation' type: string - inline: + format: byte + isPotentialRetry: + description: '# gdata.* are outside protos with mising documentation' + type: boolean + cosmoBinaryReference: description: '# gdata.* are outside protos with mising documentation' type: string format: byte - blobstore2Info: - $ref: '#/components/schemas/Blobstore2Info' + hashVerified: + description: '# gdata.* are outside protos with mising documentation' + type: boolean + CompositeMedia: + id: CompositeMedia + description: '# gdata.* are outside protos with mising documentation' + type: object + properties: + length: description: '# gdata.* are outside protos with mising documentation' + type: string + format: int64 referenceType: description: '# gdata.* are outside protos with mising documentation' + type: string enumDescriptions: - '# gdata.* are outside protos with mising documentation' - '# gdata.* are outside protos with mising documentation' @@ -457,178 +301,178 @@ components: - INLINE - BIGSTORE_REF - COSMO_BINARY_REFERENCE + path: + description: '# gdata.* are outside protos with mising documentation' type: string - md5Hash: - type: string + blobRef: description: '# gdata.* are outside protos with mising documentation' + deprecated: true + type: string format: byte - length: + inline: + description: '# gdata.* are outside protos with mising documentation' type: string + format: byte + objectId: description: '# gdata.* are outside protos with mising documentation' - format: int64 - sha1Hash: + $ref: '#/components/schemas/ObjectId' + blobstore2Info: description: '# gdata.* are outside protos with mising documentation' - format: byte - type: string + $ref: '#/components/schemas/Blobstore2Info' cosmoBinaryReference: + description: '# gdata.* are outside protos with mising documentation' type: string + format: byte + crc32cHash: + description: '# gdata.* are outside protos with mising documentation' + type: integer + format: uint32 + md5Hash: description: '# gdata.* are outside protos with mising documentation' + type: string format: byte - objectId: + sha1Hash: description: '# gdata.* are outside protos with mising documentation' - $ref: '#/components/schemas/ObjectId' + type: string + format: byte + ObjectId: + id: ObjectId + description: '# gdata.* are outside protos with mising documentation' type: object - CaseClassification: - id: CaseClassification properties: - id: + bucketName: + description: '# gdata.* are outside protos with mising documentation' type: string - description: >- - The unique ID for a classification. Must be specified for case - creation. To retrieve valid classification IDs for case creation, - use `caseClassifications.search`. Classification IDs returned by - `caseClassifications.search` are guaranteed to be valid for at least - 6 months. If a given classification is deactiveated, it will - immediately stop being returned. After 6 months, `case.create` - requests using the classification ID will fail. - displayName: + objectName: + description: '# gdata.* are outside protos with mising documentation' type: string - description: >- - A display name for the classification. The display name is not - static and can change. To uniquely and consistently identify - classifications, use the `CaseClassification.id` field. - description: >- - A Case Classification represents the topic that a case is about. It's - very important to use accurate classifications, because they're used to - route your cases to specialists who can help you. A classification - always has an ID that is its unique identifier. A valid ID is required - when creating a case. - type: object - Escalation: + generation: + description: '# gdata.* are outside protos with mising documentation' + type: string + format: int64 + Blobstore2Info: + id: Blobstore2Info + description: '# gdata.* are outside protos with mising documentation' type: object - id: Escalation - description: An escalation of a support case. properties: - justification: + blobId: + description: '# gdata.* are outside protos with mising documentation' type: string - description: >- - Required. A free text description to accompany the `reason` field - above. Provides additional context on why the case is being - escalated. - reason: - enumDescriptions: - - >- - The escalation reason is in an unknown state or has not been - specified. - - The case is taking too long to resolve. - - >- - The support agent does not have the expertise required to - successfully resolve the issue. - - The issue is having a significant business impact. + blobGeneration: + description: '# gdata.* are outside protos with mising documentation' type: string - enum: - - REASON_UNSPECIFIED - - RESOLUTION_TIME - - TECHNICAL_EXPERTISE - - BUSINESS_IMPACT - description: Required. The reason why the Case is being escalated. - EscalateCaseRequest: - type: object - description: The request message for the EscalateCase endpoint. - properties: - escalation: - $ref: '#/components/schemas/Escalation' - description: The escalation information to be sent with the escalation request. - id: EscalateCaseRequest - ListAttachmentsResponse: - description: The response message for the ListAttachments endpoint. - type: object - properties: - attachments: - type: array - items: - $ref: '#/components/schemas/Attachment' - description: The list of attachments associated with a case. - nextPageToken: + format: int64 + readToken: + description: '# gdata.* are outside protos with mising documentation' type: string - description: >- - A token to retrieve the next page of results. Set this in the - `page_token` field of subsequent `cases.attachments.list` requests. - If unspecified, there are no more results to retrieve. - id: ListAttachmentsResponse - ListCasesResponse: - properties: - cases: - description: >- - The list of cases associated with the parent after any filters have - been applied. - type: array - items: - $ref: '#/components/schemas/Case' - nextPageToken: - description: >- - A token to retrieve the next page of results. Set this in the - `page_token` field of subsequent `cases.list` requests. If - unspecified, there are no more results to retrieve. + uploadMetadataContainer: + description: '# gdata.* are outside protos with mising documentation' type: string + format: byte + downloadReadHandle: + description: '# gdata.* are outside protos with mising documentation' + type: string + format: byte + DiffVersionResponse: + id: DiffVersionResponse + description: '# gdata.* are outside protos with mising documentation' type: object - description: The response message for the ListCases endpoint. - id: ListCasesResponse - ContentTypeInfo: - type: object - id: ContentTypeInfo properties: - fromUrlPath: + objectVersion: description: '# gdata.* are outside protos with mising documentation' type: string - fromBytes: + objectSizeBytes: description: '# gdata.* are outside protos with mising documentation' type: string - fromHeader: + format: int64 + DiffChecksumsResponse: + id: DiffChecksumsResponse + description: '# gdata.* are outside protos with mising documentation' + type: object + properties: + objectVersion: + description: '# gdata.* are outside protos with mising documentation' type: string + objectSizeBytes: description: '# gdata.* are outside protos with mising documentation' - fromFileName: type: string + format: int64 + chunkSizeBytes: description: '# gdata.* are outside protos with mising documentation' - bestGuess: type: string + format: int64 + checksumsLocation: description: '# gdata.* are outside protos with mising documentation' + $ref: '#/components/schemas/CompositeMedia' + objectLocation: + description: '# gdata.* are outside protos with mising documentation' + $ref: '#/components/schemas/CompositeMedia' + DiffDownloadResponse: + id: DiffDownloadResponse description: '# gdata.* are outside protos with mising documentation' - DiffUploadResponse: + type: object + properties: + objectLocation: + description: '# gdata.* are outside protos with mising documentation' + $ref: '#/components/schemas/CompositeMedia' + DiffUploadRequest: + id: DiffUploadRequest description: '# gdata.* are outside protos with mising documentation' type: object - id: DiffUploadResponse properties: - originalObject: + objectVersion: + description: '# gdata.* are outside protos with mising documentation' + type: string + objectInfo: + description: '# gdata.* are outside protos with mising documentation' $ref: '#/components/schemas/CompositeMedia' + checksumsInfo: description: '# gdata.* are outside protos with mising documentation' + $ref: '#/components/schemas/CompositeMedia' + DiffUploadResponse: + id: DiffUploadResponse + description: '# gdata.* are outside protos with mising documentation' + type: object + properties: objectVersion: description: '# gdata.* are outside protos with mising documentation' type: string - ListCommentsResponse: - id: ListCommentsResponse - description: The response message for the ListComments endpoint. + originalObject: + description: '# gdata.* are outside protos with mising documentation' + $ref: '#/components/schemas/CompositeMedia' + ContentTypeInfo: + id: ContentTypeInfo + description: '# gdata.* are outside protos with mising documentation' type: object properties: - nextPageToken: + bestGuess: + description: '# gdata.* are outside protos with mising documentation' type: string - description: >- - A token to retrieve the next page of results. Set this in the - `page_token` field of subsequent `cases.comments.list` requests. If - unspecified, there are no more results to retrieve. - comments: - items: - $ref: '#/components/schemas/Comment' - description: List of the comments associated with the case. - type: array - CloseCaseRequest: - properties: {} - description: The request message for the CloseCase endpoint. - id: CloseCaseRequest + fromHeader: + description: '# gdata.* are outside protos with mising documentation' + type: string + fromFileName: + description: '# gdata.* are outside protos with mising documentation' + type: string + fromUrlPath: + description: '# gdata.* are outside protos with mising documentation' + type: string + fromBytes: + description: '# gdata.* are outside protos with mising documentation' + type: string + DownloadParameters: + id: DownloadParameters + description: '# gdata.* are outside protos with mising documentation' type: object + properties: + allowGzipCompression: + description: '# gdata.* are outside protos with mising documentation' + type: boolean + ignoreRange: + description: '# gdata.* are outside protos with mising documentation' + type: boolean Case: id: Case - type: object description: >- A Case is an object that contains the details of a support case. It contains fields for the time it was created, its priority, its @@ -641,70 +485,93 @@ components: ``` projects/123/cases/456 ``` You can use either of them when calling the API. To learn more about project identifiers, see [AIP-2510](https://google.aip.dev/cloud/2510). + type: object properties: - updateTime: - readOnly: true + name: + description: Identifier. The resource name for the case. type: string - format: google-datetime - description: Output only. The time this case was last updated. - escalated: - type: boolean - description: Whether the case is currently escalated. - timeZone: + displayName: + description: The short summary of the issue reported in this case. type: string + description: + description: A broad description of the issue. + type: string + classification: + description: The issue classification applicable to this case. + $ref: '#/components/schemas/CaseClassification' + timeZone: description: >- The timezone of the user who created the support case. It should be in a format IANA recognizes: https://www.iana.org/time-zones. There is no additional validation done by the API. - name: - description: The resource name for the case. type: string - languageCode: - description: >- - The language the user has requested to receive support in. This - should be a BCP 47 language code (e.g., `"en"`, `"zh-CN"`, - `"zh-TW"`, `"ja"`, `"ko"`). If no language or an unsupported - language is specified, this field defaults to English (en). Language - selection during case creation may affect your available support - options. For a list of supported languages and their support working - hours, see: - https://cloud.google.com/support/docs/language-working-hours + subscriberEmailAddresses: + description: The email addresses to receive updates on this case. + type: array + items: + type: string + state: + description: Output only. The current status of the support case. + readOnly: true + type: string + enumDescriptions: + - Case is in an unknown state. + - >- + The case has been created but no one is assigned to work on it + yet. + - The case is currently being handled by Google support. + - Google is waiting for a response. + - A solution has been offered for the case, but it isn't yet closed. + - The case has been resolved. + enum: + - STATE_UNSPECIFIED + - NEW + - IN_PROGRESS_GOOGLE_SUPPORT + - ACTION_REQUIRED + - SOLUTION_PROVIDED + - CLOSED + createTime: + description: Output only. The time this case was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. The time this case was last updated. + readOnly: true type: string + format: google-datetime + creator: + description: >- + The user who created the case. Note: The name and email will be + obfuscated if the case was created by Google Support. + $ref: '#/components/schemas/Actor' contactEmail: description: >- A user-supplied email address to send case update notifications for. This should only be used in BYOID flows, where we cannot infer the user's email address directly from their EUCs. type: string + escalated: + description: Whether the case is currently escalated. + type: boolean testCase: description: >- Whether this case was created for internal API testing and should not be acted on by the support team. type: boolean - subscriberEmailAddresses: - type: array - items: - type: string - description: The email addresses to receive updates on this case. - displayName: - type: string - description: The short summary of the issue reported in this case. - creator: - $ref: '#/components/schemas/Actor' + languageCode: description: >- - The user who created the case. Note: The name and email will be - obfuscated if the case was created by Google Support. - description: - description: A broad description of the issue. + The language the user has requested to receive support in. This + should be a BCP 47 language code (e.g., `"en"`, `"zh-CN"`, + `"zh-TW"`, `"ja"`, `"ko"`). If no language or an unsupported + language is specified, this field defaults to English (en). Language + selection during case creation may affect your available support + options. For a list of supported languages and their support working + hours, see: + https://cloud.google.com/support/docs/language-working-hours type: string priority: - enum: - - PRIORITY_UNSPECIFIED - - P0 - - P1 - - P2 - - P3 - - P4 + description: The priority of this case. type: string enumDescriptions: - Priority is undefined or has not been set yet. @@ -721,102 +588,203 @@ components: - >- General questions or minor issues. Production service is fully available. - description: The priority of this case. - state: - description: Output only. The current status of the support case. - readOnly: true enum: - - STATE_UNSPECIFIED - - NEW - - IN_PROGRESS_GOOGLE_SUPPORT - - ACTION_REQUIRED - - SOLUTION_PROVIDED - - CLOSED + - PRIORITY_UNSPECIFIED + - P0 + - P1 + - P2 + - P3 + - P4 + CaseClassification: + id: CaseClassification + description: >- + A Case Classification represents the topic that a case is about. It's + very important to use accurate classifications, because they're used to + route your cases to specialists who can help you. A classification + always has an ID that is its unique identifier. A valid ID is required + when creating a case. + type: object + properties: + id: + description: >- + The unique ID for a classification. Must be specified for case + creation. To retrieve valid classification IDs for case creation, + use `caseClassifications.search`. Classification IDs returned by + `caseClassifications.search` are guaranteed to be valid for at least + 6 months. If a given classification is deactiveated, it will + immediately stop being returned. After 6 months, `case.create` + requests using the classification ID will fail. + type: string + displayName: + description: >- + A display name for the classification. The display name is not + static and can change. To uniquely and consistently identify + classifications, use the `CaseClassification.id` field. + type: string + ListCasesResponse: + id: ListCasesResponse + description: The response message for the ListCases endpoint. + type: object + properties: + cases: + description: >- + The list of cases associated with the parent after any filters have + been applied. + type: array + items: + $ref: '#/components/schemas/Case' + nextPageToken: + description: >- + A token to retrieve the next page of results. Set this in the + `page_token` field of subsequent `cases.list` requests. If + unspecified, there are no more results to retrieve. + type: string + SearchCasesResponse: + id: SearchCasesResponse + description: The response message for the SearchCases endpoint. + type: object + properties: + cases: + description: >- + The list of cases associated with the parent after any filters have + been applied. + type: array + items: + $ref: '#/components/schemas/Case' + nextPageToken: + description: >- + A token to retrieve the next page of results. Set this in the + `page_token` field of subsequent `cases.search` requests. If + unspecified, there are no more results to retrieve. + type: string + EscalateCaseRequest: + id: EscalateCaseRequest + description: The request message for the EscalateCase endpoint. + type: object + properties: + escalation: + description: The escalation information to be sent with the escalation request. + $ref: '#/components/schemas/Escalation' + Escalation: + id: Escalation + description: An escalation of a support case. + type: object + properties: + reason: + description: Required. The reason why the Case is being escalated. type: string enumDescriptions: - - Case is in an unknown state. - >- - The case has been created but no one is assigned to work on it - yet. - - The case is currently being handled by Google support. - - Google is waiting for a response. - - A solution has been offered for the case, but it isn't yet closed. - - The case has been resolved. - createTime: + The escalation reason is in an unknown state or has not been + specified. + - The case is taking too long to resolve. + - >- + The support agent does not have the expertise required to + successfully resolve the issue. + - The issue is having a significant business impact. + enum: + - REASON_UNSPECIFIED + - RESOLUTION_TIME + - TECHNICAL_EXPERTISE + - BUSINESS_IMPACT + justification: + description: >- + Required. A free text description to accompany the `reason` field + above. Provides additional context on why the case is being + escalated. + type: string + CloseCaseRequest: + id: CloseCaseRequest + description: The request message for the CloseCase endpoint. + type: object + properties: {} + SearchCaseClassificationsResponse: + id: SearchCaseClassificationsResponse + description: The response message for SearchCaseClassifications endpoint. + type: object + properties: + caseClassifications: + description: The classifications retrieved. + type: array + items: + $ref: '#/components/schemas/CaseClassification' + nextPageToken: + description: >- + A token to retrieve the next page of results. Set this in the + `page_token` field of subsequent `caseClassifications.list` + requests. If unspecified, there are no more results to retrieve. type: string - readOnly: true - format: google-datetime - description: Output only. The time this case was created. - classification: - $ref: '#/components/schemas/CaseClassification' - description: The issue classification applicable to this case. - Attachment: + ListCommentsResponse: + id: ListCommentsResponse + description: The response message for the ListComments endpoint. + type: object properties: - sizeBytes: - description: Output only. The size of the attachment in bytes. + comments: + description: List of the comments associated with the case. + type: array + items: + $ref: '#/components/schemas/Comment' + nextPageToken: + description: >- + A token to retrieve the next page of results. Set this in the + `page_token` field of subsequent `cases.comments.list` requests. If + unspecified, there are no more results to retrieve. type: string + Comment: + id: Comment + description: >- + A comment associated with a support case. Case comments are the primary + way for Google Support to communicate with a user who has opened a case. + When a user responds to Google Support, the user's responses also appear + as comments. + type: object + properties: + name: + description: Output only. Identifier. The resource name of the comment. readOnly: true - format: int64 + type: string createTime: + description: Output only. The time when the comment was created. readOnly: true type: string - description: Output only. The time at which the attachment was created. format: google-datetime - mimeType: - type: string - description: Output only. The MIME type of the attachment (e.g. text/plain). + creator: + description: >- + Output only. The user or Google Support agent who created the + comment. readOnly: true - name: - description: Output only. The resource name of the attachment. + $ref: '#/components/schemas/Actor' + body: + description: The full comment body. Maximum of 12800 characters. type: string + plainTextBody: + description: >- + Output only. DEPRECATED. DO NOT USE. A duplicate of the `body` + field. This field is only present for legacy reasons. readOnly: true - filename: + deprecated: true type: string - description: The filename of the attachment (e.g. `"graph.jpg"`). - creator: - $ref: '#/components/schemas/Actor' - readOnly: true - description: >- - Output only. The user who uploaded the attachment. Note, the name - and email will be obfuscated if the attachment was uploaded by - Google support. - type: object - description: >- - An Attachment contains metadata about a file that was uploaded to a case - - it is NOT a file itself. That being said, the name of an Attachment - object can be used to download its accompanying file through the - `media.download` endpoint. While attachments can be uploaded in the - console at the same time as a comment, they're associated on a "case" - level, not a "comment" level. - id: Attachment - DownloadParameters: - properties: - ignoreRange: - type: boolean - description: '# gdata.* are outside protos with mising documentation' - allowGzipCompression: - type: boolean - description: '# gdata.* are outside protos with mising documentation' - type: object - description: '# gdata.* are outside protos with mising documentation' - id: DownloadParameters parameters: - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean access_token: description: OAuth access token. in: query name: access_token schema: type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + alt: + description: Data format for response. in: query - name: uploadType + name: alt + schema: + type: string + enum: + - json + - media + - proto + callback: + description: JSONP + in: query + name: callback schema: type: string fields: @@ -825,21 +793,27 @@ components: name: fields schema: type: string - _.xgafv: - description: V1 error format. + 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: $.xgafv + name: key schema: type: string - enum: - - '1' - - '2' - callback: - description: JSONP + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: callback + 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 @@ -855,44 +829,76 @@ components: name: upload_protocol schema: type: string - oauth_token: - description: OAuth 2.0 token for the current user. + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: oauth_token + name: uploadType schema: type: string - alt: - description: Data format for response. + _.xgafv: + description: V1 error format. in: query - name: alt + name: $.xgafv schema: type: string enum: - - json - - media - - proto - 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 + - '1' + - '2' x-stackQL-resources: + media: + id: google.cloudsupport.media + name: media + title: Media + methods: + upload: + operation: + $ref: '#/paths/~1v2~1{parentType}~1{parent}~1attachments/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + attachments: + id: google.cloudsupport.attachments + name: attachments + title: Attachments + methods: + list: + operation: + $ref: '#/paths/~1v2~1{parentType}~1{parent}~1attachments/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.attachments + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/attachments/methods/list' + insert: [] + update: [] + replace: [] + delete: [] cases: id: google.cloudsupport.cases name: cases title: Cases methods: + get: + operation: + $ref: '#/paths/~1v2~1{name}/get' + response: + mediaType: application/json + openAPIDocKey: '200' patch: operation: $ref: '#/paths/~1v2~1{name}/patch' response: mediaType: application/json openAPIDocKey: '200' - escalate: + close: operation: $ref: '#/paths/~1v2~1{name}/post' response: @@ -900,7 +906,7 @@ components: openAPIDocKey: '200' search: operation: - $ref: '#/paths/~1v2~1{parentType}~1{parent}~1cases/get' + $ref: '#/paths/~1v2~1caseClassifications:search/get' response: mediaType: application/json openAPIDocKey: '200' @@ -911,36 +917,14 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: '#/components/x-stackQL-resources/cases/methods/get' insert: - $ref: '#/components/x-stackQL-resources/cases/methods/create' update: - $ref: '#/components/x-stackQL-resources/cases/methods/patch' replace: [] delete: [] - media: - id: google.cloudsupport.media - name: media - title: Media - methods: - download: - operation: - $ref: '#/paths/~1v2~1{name}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - upload: - operation: - $ref: '#/paths/~1v2~1{parentType}~1{parent}~1attachments/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: [] comments: id: google.cloudsupport.comments name: comments @@ -967,76 +951,46 @@ components: update: [] replace: [] delete: [] - attachments: - id: google.cloudsupport.attachments - name: attachments - title: Attachments - methods: - list: - operation: - $ref: '#/paths/~1v2~1{parentType}~1{parent}~1attachments/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.attachments - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/attachments/methods/list' - insert: [] - update: [] - replace: [] - delete: [] - case_classifications: - id: google.cloudsupport.case_classifications - name: case_classifications - title: Case_classifications - methods: - search: - operation: - $ref: '#/paths/~1v2~1caseClassifications:search/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: [] paths: - /v2/{name}: + /v2/{parentType}/{parent}/attachments: parameters: &ref_1 - - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/key' - patch: + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' + post: description: >- - Update a case. Only some fields can be updated. EXAMPLES: cURL: ```shell - case="projects/some-project/cases/43595344" curl \ --request PATCH \ + Create a file attachment on a case or Cloud resource. The attachment + must have the following fields set: `filename`. EXAMPLES: cURL: ```shell + echo "This text is in a file I'm uploading using CSAPI." \ > + "./example_file.txt" case="projects/some-project/cases/43594844" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ - --header "Content-Type: application/json" \ --data '{ "priority": "P1" - }' \ "https://cloudsupport.googleapis.com/v2/$case?updateMask=priority" + --data-binary @"./example_file.txt" \ + "https://cloudsupport.googleapis.com/upload/v2beta/$case/attachments?attachment.filename=uploaded_via_curl.txt" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", - ) request = supportApiService.cases().patch( - name="projects/some-project/cases/43112854", body={ "displayName": "This - is Now a New Title", "priority": "P2", }, ) print(request.execute()) ``` - operationId: cloudsupport.cases.patch + ) file_path = "./example_file.txt" with open(file_path, "w") as file: + file.write( "This text is inside a file I'm going to upload using the + Cloud Support API.", ) request = supportApiService.media().upload( + parent="projects/some-project/cases/43595344", media_body=file_path ) + request.uri = request.uri.split("?")[0] + + "?attachment.filename=uploaded_via_python.txt" print(request.execute()) + ``` + operationId: cloudsupport.media.upload requestBody: content: application/json: schema: - $ref: '#/components/schemas/Case' + $ref: '#/components/schemas/CreateAttachmentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1048,44 +1002,118 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Case' + $ref: '#/components/schemas/Attachment' parameters: - in: path - name: name + name: parentType required: true schema: type: string - - in: query - name: updateMask + - in: path + name: parent + required: true schema: type: string - format: google-fieldmask - post: + get: description: >- - Escalate a case, starting the Google Cloud Support escalation management - process. This operation is only available for some support services. Go - to https://cloud.google.com/support and look for 'Technical support - escalations' in the feature list to find out which ones let you do that. - EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" - curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth - print-access-token)" \ --header "Content-Type: application/json" \ - --data '{ "escalation": { "reason": "BUSINESS_IMPACT", "justification": - "This is a test escalation." } }' \ - "https://cloudsupport.googleapis.com/v2/$case:escalate" ``` Python: + List all the attachments associated with a support case. EXAMPLES: cURL: + ```shell case="projects/some-project/cases/23598314" curl \ --header + "Authorization: Bearer $(gcloud auth print-access-token)" \ + "https://cloudsupport.googleapis.com/v2/$case/attachments" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", - ) request = supportApiService.cases().escalate( - name="projects/some-project/cases/43595344", body={ "escalation": { - "reason": "BUSINESS_IMPACT", "justification": "This is a test - escalation.", }, }, ) print(request.execute()) ``` - operationId: cloudsupport.cases.escalate + ) request = ( supportApiService.cases() .attachments() + .list(parent="projects/some-project/cases/43595344") ) + print(request.execute()) ``` + operationId: cloudsupport.cases.attachments.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListAttachmentsResponse' + parameters: + - in: path + name: parentType + required: true + schema: + type: string + - in: path + name: parent + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v2/{name}: + parameters: *ref_1 + get: + description: >- + Retrieve a case. EXAMPLES: cURL: ```shell + case="projects/some-project/cases/16033687" curl \ --header + "Authorization: Bearer $(gcloud auth print-access-token)" \ + "https://cloudsupport.googleapis.com/v2/$case" ``` Python: ```python + import googleapiclient.discovery api_version = "v2" supportApiService = + googleapiclient.discovery.build( serviceName="cloudsupport", + version=api_version, + discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", + ) request = supportApiService.cases().get( + name="projects/some-project/cases/43595344", ) print(request.execute()) + ``` + operationId: cloudsupport.cases.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Case' + parameters: + - in: path + name: name + required: true + schema: + type: string + patch: + description: >- + Update a case. Only some fields can be updated. EXAMPLES: cURL: ```shell + case="projects/some-project/cases/43595344" curl \ --request PATCH \ + --header "Authorization: Bearer $(gcloud auth print-access-token)" \ + --header "Content-Type: application/json" \ --data '{ "priority": "P1" + }' \ "https://cloudsupport.googleapis.com/v2/$case?updateMask=priority" + ``` Python: ```python import googleapiclient.discovery api_version = + "v2" supportApiService = googleapiclient.discovery.build( + serviceName="cloudsupport", version=api_version, + discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", + ) request = supportApiService.cases().patch( + name="projects/some-project/cases/43112854", body={ "displayName": "This + is Now a New Title", "priority": "P2", }, ) print(request.execute()) ``` + operationId: cloudsupport.cases.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/EscalateCaseRequest' + $ref: '#/components/schemas/Case' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1104,23 +1132,30 @@ paths: required: true schema: type: string - get: + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + post: description: >- - Download a file attached to a case. Note: HTTP requests must append - "?alt=media" to the URL. EXAMPLES: cURL: ```shell - name="projects/some-project/cases/43594844/attachments/0674M00000WijAnZAJ" - curl \ --header "Authorization: Bearer $(gcloud auth - print-access-token)" \ - "https://cloudsupport.googleapis.com/v2/$name:download?alt=media" ``` - Python: ```python import googleapiclient.discovery api_version = "v2" + Close a case. EXAMPLES: cURL: ```shell + case="projects/some-project/cases/43595344" curl \ --request POST \ + --header "Authorization: Bearer $(gcloud auth print-access-token)" \ + "https://cloudsupport.googleapis.com/v2/$case:close" ``` Python: + ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", - ) request = supportApiService.media().download( - name="projects/some-project/cases/43595344/attachments/0684M00000Pw6pHQAR" - ) request.uri = request.uri.split("?")[0] + "?alt=media" - print(request.execute()) ``` - operationId: cloudsupport.media.download + ) request = supportApiService.cases().close( + name="projects/some-project/cases/43595344" ) print(request.execute()) + ``` + operationId: cloudsupport.cases.close + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CloseCaseRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1132,7 +1167,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Media' + $ref: '#/components/schemas/Case' parameters: - in: path name: name @@ -1178,10 +1213,6 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - in: query name: query schema: @@ -1191,6 +1222,10 @@ paths: schema: type: integer format: int32 + - in: query + name: pageToken + schema: + type: string post: description: >- Create a new case and associate it with a parent. It must have the @@ -1338,103 +1373,6 @@ paths: required: true schema: type: string - /v2/{parentType}/{parent}/attachments: - parameters: *ref_1 - get: - description: >- - List all the attachments associated with a support case. EXAMPLES: cURL: - ```shell case="projects/some-project/cases/23598314" curl \ --header - "Authorization: Bearer $(gcloud auth print-access-token)" \ - "https://cloudsupport.googleapis.com/v2/$case/attachments" ``` Python: - ```python import googleapiclient.discovery api_version = "v2" - supportApiService = googleapiclient.discovery.build( - serviceName="cloudsupport", version=api_version, - discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", - ) request = ( supportApiService.cases() .attachments() - .list(parent="projects/some-project/cases/43595344") ) - print(request.execute()) ``` - operationId: cloudsupport.cases.attachments.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/ListAttachmentsResponse' - parameters: - - in: path - name: parentType - required: true - schema: - type: string - - in: path - name: parent - required: true - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - post: - description: >- - Create a file attachment on a case or Cloud resource. The attachment - must have the following fields set: `filename`. EXAMPLES: cURL: ```shell - echo "This text is in a file I'm uploading using CSAPI." \ > - "./example_file.txt" case="projects/some-project/cases/43594844" curl \ - --header "Authorization: Bearer $(gcloud auth print-access-token)" \ - --data-binary @"./example_file.txt" \ - "https://cloudsupport.googleapis.com/upload/v2beta/$case/attachments?attachment.filename=uploaded_via_curl.txt" - ``` Python: ```python import googleapiclient.discovery api_version = - "v2" supportApiService = googleapiclient.discovery.build( - serviceName="cloudsupport", version=api_version, - discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", - ) file_path = "./example_file.txt" with open(file_path, "w") as file: - file.write( "This text is inside a file I'm going to upload using the - Cloud Support API.", ) request = supportApiService.media().upload( - parent="projects/some-project/cases/43595344", media_body=file_path ) - request.uri = request.uri.split("?")[0] + - "?attachment.filename=uploaded_via_python.txt" print(request.execute()) - ``` - operationId: cloudsupport.media.upload - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CreateAttachmentRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Attachment' - parameters: - - in: path - name: parentType - required: true - schema: - type: string - - in: path - name: parent - required: true - schema: - type: string /v2/caseClassifications:search: parameters: *ref_1 get: diff --git a/providers/src/googleapis.com/v00.00.00000/services/cloudtasks.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudtasks.yaml index b40c0d3a..94dc4269 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudtasks.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudtasks.yaml @@ -7,8 +7,8 @@ info: title: Cloud Tasks API description: Manages the execution of large numbers of distributed requests. version: v2 - x-discovery-doc-revision: '20240927' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250611' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/tasks/ servers: @@ -588,6 +588,12 @@ components: default. -1 indicates unlimited attempts. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + Note: Cloud Tasks stops retrying only when `max_attempts` and + `max_retry_duration` are both satisfied. When the task has been + attempted `max_attempts` times and when the `max_retry_duration` + time has passed, no further attempts are made, and the task is + deleted. If you want your task to retry infinitely, you must set + `max_attempts` to -1 and `max_retry_duration` to 0. type: integer format: int32 maxRetryDuration: @@ -1920,6 +1926,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v2/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: @@ -2666,14 +2676,12 @@ paths: reached its RateLimits or is PAUSED. This command is meant to be used for manual debugging. For example, RunTask can be used to retry a failed task after a fix has been made or to manually force a task to be - dispatched now. The dispatched task is returned. That is, the task that - is returned contains the status after the task is dispatched but before - the task is received by its target. If Cloud Tasks receives a successful - response from the task's target, then the task will be deleted; - otherwise the task's schedule_time will be reset to the time that - RunTask was called plus the retry delay specified in the queue's - RetryConfig. RunTask returns NOT_FOUND when it is called on a task that - has already succeeded or permanently failed. + dispatched now. If Cloud Tasks receives a successful response from the + task's target, then the task will be deleted; otherwise the task's + schedule_time will be reset to the time that RunTask was called plus the + retry delay specified in the queue's RetryConfig. RunTask returns + NOT_FOUND when it is called on a task that has already succeeded or + permanently failed. operationId: cloudtasks.projects.locations.queues.tasks.run requestBody: content: diff --git a/providers/src/googleapis.com/v00.00.00000/services/cloudtrace.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudtrace.yaml index ad634533..7f286685 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudtrace.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudtrace.yaml @@ -12,8 +12,8 @@ info: interact with the Cloud Trace API directly. If you are looking to instrument your application for Cloud Trace, we recommend using OpenTelemetry. version: v2 - x-discovery-doc-revision: '20241025' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250822' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/trace servers: @@ -603,10 +603,10 @@ components: update: [] replace: [] delete: [] - spans_span: - id: google.cloudtrace.spans_span - name: spans_span - title: Spans_span + spans: + id: google.cloudtrace.spans + name: spans + title: Spans methods: create_span: operation: @@ -618,7 +618,7 @@ components: sqlVerbs: select: [] insert: - - $ref: '#/components/x-stackQL-resources/spans_span/methods/create_span' + - $ref: '#/components/x-stackQL-resources/spans/methods/create_span' update: [] replace: [] delete: [] @@ -639,7 +639,8 @@ paths: post: description: >- Batch writes new spans to new or existing traces. You cannot update - existing spans. + existing spans. If a span ID already exists, an additional copy of the + span will be stored. operationId: cloudtrace.projects.traces.batchWrite requestBody: content: @@ -671,7 +672,9 @@ paths: /v2/projects/{projectsId}/traces/{tracesId}/spans/{spansId}: parameters: *ref_1 post: - description: Creates a new span. + description: >- + Creates a new span. If a span ID already exists, an additional copy of + the span will be stored. operationId: cloudtrace.projects.traces.spans.createSpan requestBody: content: diff --git a/providers/src/googleapis.com/v00.00.00000/services/composer.yaml b/providers/src/googleapis.com/v00.00.00000/services/composer.yaml index 67263a70..33ee7fe4 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/composer.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/composer.yaml @@ -7,8 +7,8 @@ info: title: Cloud Composer API description: Manages Apache Airflow environments on Google Cloud Platform. version: v1 - x-discovery-doc-revision: '20241027' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250819' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/composer/ servers: @@ -455,7 +455,7 @@ components: Optional. Whether or not the web server uses custom plugins. If unspecified, the field defaults to `PLUGINS_ENABLED`. This field is supported for Cloud Composer environments in versions - composer-3.*.*-airflow-*.*.* and newer. + composer-3-airflow-*.*.*-build.* and newer. type: string enumDescriptions: - Default mode. @@ -601,7 +601,7 @@ components: Network attachment must be provided in format projects/{project}/regions/{region}/networkAttachments/{networkAttachment}. This field is supported for Cloud Composer environments in versions - composer-3.*.*-airflow-*.*.* and newer. + composer-3-airflow-*.*.*-build.* and newer. type: string composerInternalIpv4CidrBlock: description: >- @@ -611,8 +611,8 @@ components: IPs from this range will not be accessible in the user's VPC network. Cannot be updated. If not specified, the default value of '100.64.128.0/20' is used. This field is supported for Cloud - Composer environments in versions composer-3.*.*-airflow-*.*.* and - newer. + Composer environments in versions composer-3-airflow-*.*.*-build.* + and newer. type: string IPAllocationPolicy: id: IPAllocationPolicy @@ -692,7 +692,7 @@ components: `NodeConfig.composer_network_attachment` field are specified). If `false`, the builds also have access to the internet. This field is supported for Cloud Composer environments in versions - composer-3.*.*-airflow-*.*.* and newer. + composer-3-airflow-*.*.*-build.* and newer. type: boolean privateClusterConfig: description: >- @@ -790,7 +790,7 @@ components: properties: connectionType: description: >- - Optional. Indicates the user requested specifc connection type + Optional. Indicates the user requested specific connection type between Tenant and Customer projects. You cannot set networking connection type in public IP environment. type: string @@ -947,7 +947,7 @@ components: description: >- Optional. Resources used by Airflow DAG processors. This field is supported for Cloud Composer environments in versions - composer-3.*.*-airflow-*.*.* and newer. + composer-3-airflow-*.*.*-build.* and newer. $ref: '#/components/schemas/DagProcessorResource' SchedulerResource: id: SchedulerResource @@ -1048,7 +1048,7 @@ components: description: >- Configuration for resources used by Airflow DAG processors. This field is supported for Cloud Composer environments in versions - composer-3.*.*-airflow-*.*.* and newer. + composer-3-airflow-*.*.*-build.* and newer. type: object properties: cpu: @@ -1085,7 +1085,9 @@ components: type: object properties: enabled: - description: Whether or not master authorized networks feature is enabled. + description: >- + Optional. Whether or not master authorized networks feature is + enabled. type: boolean cidrBlocks: description: >- @@ -1211,6 +1213,11 @@ components: nextPageToken: description: The page token used to query for the next page if one exists. type: string + RestartWebServerRequest: + id: RestartWebServerRequest + description: Restart Airflow web server. + type: object + properties: {} ExecuteAirflowCommandRequest: id: ExecuteAirflowCommandRequest description: Execute Airflow Command request. @@ -1708,6 +1715,7 @@ components: - >- Triggers failover of environment's Cloud SQL instance (only for highly resilient environments). + - Migrates resource to a new major version. enum: - TYPE_UNSPECIFIED - CREATE @@ -1717,6 +1725,7 @@ components: - SAVE_SNAPSHOT - LOAD_SNAPSHOT - DATABASE_FAILOVER + - MIGRATE resource: description: >- Output only. The resource being operated on, as a [relative resource @@ -1956,6 +1965,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + restart_web_server: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1environments~1{environmentsId}:restartWebServer/post + response: + mediaType: application/json + openAPIDocKey: '200' execute_airflow_command: operation: $ref: >- @@ -2016,10 +2032,10 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/environments/methods/delete' - environments_database_properties: - id: google.composer.environments_database_properties - name: environments_database_properties - title: Environments_database_properties + database_properties: + id: google.composer.database_properties + name: database_properties + title: Database_properties methods: fetch_database_properties: operation: @@ -2031,7 +2047,7 @@ components: sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/environments_database_properties/methods/fetch_database_properties + #/components/x-stackQL-resources/database_properties/methods/fetch_database_properties insert: [] update: [] replace: [] @@ -2489,6 +2505,44 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:restartWebServer: + parameters: *ref_1 + post: + description: Restart Airflow web server. + operationId: composer.projects.locations.environments.restartWebServer + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RestartWebServerRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: environmentsId + required: true + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:executeAirflowCommand: parameters: *ref_1 post: @@ -2802,7 +2856,7 @@ paths: description: >- Lists workloads in a Cloud Composer environment. Workload is a unit that runs a single Composer component. This method is supported for Cloud - Composer environments in versions composer-3.*.*-airflow-*.*.* and + Composer environments in versions composer-2.*.*-airflow-*.*.* and newer. operationId: composer.projects.locations.environments.workloads.list security: @@ -2851,7 +2905,7 @@ paths: post: description: >- Creates a user workloads Secret. This method is supported for Cloud - Composer environments in versions composer-3.*.*-airflow-*.*.* and + Composer environments in versions composer-3-airflow-*.*.*-build.* and newer. operationId: composer.projects.locations.environments.userWorkloadsSecrets.create requestBody: @@ -2890,7 +2944,7 @@ paths: get: description: >- Lists user workloads Secrets. This method is supported for Cloud - Composer environments in versions composer-3.*.*-airflow-*.*.* and + Composer environments in versions composer-3-airflow-*.*.*-build.* and newer. operationId: composer.projects.locations.environments.userWorkloadsSecrets.list security: @@ -2936,7 +2990,7 @@ paths: description: >- Gets an existing user workloads Secret. Values of the "data" field in the response are cleared. This method is supported for Cloud Composer - environments in versions composer-3.*.*-airflow-*.*.* and newer. + environments in versions composer-3-airflow-*.*.*-build.* and newer. operationId: composer.projects.locations.environments.userWorkloadsSecrets.get security: - Oauth2: @@ -2974,7 +3028,7 @@ paths: put: description: >- Updates a user workloads Secret. This method is supported for Cloud - Composer environments in versions composer-3.*.*-airflow-*.*.* and + Composer environments in versions composer-3-airflow-*.*.*-build.* and newer. operationId: composer.projects.locations.environments.userWorkloadsSecrets.update requestBody: @@ -3018,7 +3072,7 @@ paths: delete: description: >- Deletes a user workloads Secret. This method is supported for Cloud - Composer environments in versions composer-3.*.*-airflow-*.*.* and + Composer environments in versions composer-3-airflow-*.*.*-build.* and newer. operationId: composer.projects.locations.environments.userWorkloadsSecrets.delete security: @@ -3059,7 +3113,7 @@ paths: post: description: >- Creates a user workloads ConfigMap. This method is supported for Cloud - Composer environments in versions composer-3.*.*-airflow-*.*.* and + Composer environments in versions composer-3-airflow-*.*.*-build.* and newer. operationId: composer.projects.locations.environments.userWorkloadsConfigMaps.create requestBody: @@ -3098,7 +3152,7 @@ paths: get: description: >- Lists user workloads ConfigMaps. This method is supported for Cloud - Composer environments in versions composer-3.*.*-airflow-*.*.* and + Composer environments in versions composer-3-airflow-*.*.*-build.* and newer. operationId: composer.projects.locations.environments.userWorkloadsConfigMaps.list security: @@ -3143,8 +3197,8 @@ paths: get: description: >- Gets an existing user workloads ConfigMap. This method is supported for - Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and - newer. + Cloud Composer environments in versions composer-3-airflow-*.*.*-build.* + and newer. operationId: composer.projects.locations.environments.userWorkloadsConfigMaps.get security: - Oauth2: @@ -3182,7 +3236,7 @@ paths: put: description: >- Updates a user workloads ConfigMap. This method is supported for Cloud - Composer environments in versions composer-3.*.*-airflow-*.*.* and + Composer environments in versions composer-3-airflow-*.*.*-build.* and newer. operationId: composer.projects.locations.environments.userWorkloadsConfigMaps.update requestBody: @@ -3226,7 +3280,7 @@ paths: delete: description: >- Deletes a user workloads ConfigMap. This method is supported for Cloud - Composer environments in versions composer-3.*.*-airflow-*.*.* and + Composer environments in versions composer-3-airflow-*.*.*-build.* and newer. operationId: composer.projects.locations.environments.userWorkloadsConfigMaps.delete security: diff --git a/providers/src/googleapis.com/v00.00.00000/services/compute.yaml b/providers/src/googleapis.com/v00.00.00000/services/compute.yaml index 55df65e7..3ab5339a 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/compute.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/compute.yaml @@ -7,8 +7,8 @@ info: title: Compute Engine API description: 'Creates and runs virtual machines on Google Cloud Platform. ' version: v1 - x-discovery-doc-revision: '20241015' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250810' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/compute/ servers: @@ -43,34 +43,35 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - AcceleratorTypeList: - id: AcceleratorTypeList - description: Contains a list of accelerator types. + OperationList: + id: OperationList + description: Contains a list of Operation resources. type: object properties: kind: description: >- - [Output Only] Type of resource. Always compute#acceleratorTypeList - for lists of accelerator types. - default: compute#acceleratorTypeList + [Output Only] Type of resource. Always `compute#operations` for + Operations resource. + default: compute#operationList type: string id: description: >- - [Output Only] Unique identifier for the resource; defined by the - server. + [Output Only] The unique identifier for the resource. This + identifier is defined by the server. type: string items: - description: A list of AcceleratorType resources. + description: '[Output Only] A list of Operation resources.' type: array items: - $ref: '#/components/schemas/AcceleratorType' + $ref: '#/components/schemas/Operation' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. + `maxResults`, use the `nextPageToken` as a value for the query + parameter `pageToken` in the next list request. Subsequent list + requests will have their own `nextPageToken` to continue paging + through the results. type: string selfLink: description: '[Output Only] Server-defined URL for this resource.' @@ -139,6 +140,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -182,6 +186,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -204,6 +209,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -240,847 +246,172 @@ components: [Output Only] A warning data value corresponding to the key. type: string - AcceleratorType: - id: AcceleratorType + Operation: + id: Operation 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. + 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 `zoneOperations` resource. For + more information, read Global, Regional, and Zonal Resources. Note that + completed Operation resources have a limited retention period. type: object properties: + setCommonInstanceMetadataOperationMetadata: + description: >- + [Output Only] If the operation is for + projects.setCommonInstanceMetadata, this field will contain + information on all underlying zonal actions and their state. + $ref: '#/components/schemas/SetCommonInstanceMetadataOperationMetadata' + instancesBulkInsertOperationMetadata: + $ref: '#/components/schemas/InstancesBulkInsertOperationMetadata' kind: description: >- - [Output Only] The type of the resource. Always - compute#acceleratorType for accelerator types. - default: compute#acceleratorType + [Output Only] Type of the resource. Always `compute#operation` for + Operation resources. + default: compute#operation type: string id: description: >- - [Output Only] The unique identifier for the resource. This + [Output Only] The unique identifier for the operation. This identifier is defined by the server. type: string format: uint64 creationTimestamp: - description: '[Output Only] Creation timestamp in RFC3339 text format.' + description: '[Deprecated] This field is deprecated.' type: string name: - description: '[Output Only] Name of the resource.' - pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + description: '[Output Only] Name of the operation.' type: string - description: - description: '[Output Only] An optional textual description of the resource.' + zone: + description: >- + [Output Only] The URL of the zone where the operation resides. Only + applicable when performing per-zone operations. type: string - deprecated: + clientOperationId: description: >- - [Output Only] The deprecation status associated with this - accelerator type. - $ref: '#/components/schemas/DeprecationStatus' - zone: + [Output Only] The value of `requestId` if you provided it in the + request. Not present otherwise. + type: string + operationType: 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. + [Output Only] The type of operation, such as `insert`, `update`, or + `delete`, and so on. type: string - selfLink: - description: '[Output Only] Server-defined, fully qualified URL for this resource.' + targetLink: + description: >- + [Output Only] The URL of the resource that the operation modifies. + For operations related to creating a snapshot, this points to the + disk that the snapshot was created from. type: string - maximumCardsPerInstance: + targetId: description: >- - [Output Only] Maximum number of accelerator cards allowed per - instance. - type: integer - format: int32 - DeprecationStatus: - id: DeprecationStatus - description: Deprecation status for a public resource. - type: object - properties: - state: + [Output Only] The unique target ID, which identifies a specific + incarnation of the target resource. + type: string + format: uint64 + status: 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. + [Output Only] The status of the operation, which can be one of the + following: `PENDING`, `RUNNING`, or `DONE`. type: string enumDescriptions: - '' - '' - '' - - '' enum: - - ACTIVE - - DELETED - - DEPRECATED - - OBSOLETE - replacement: + - DONE + - PENDING + - RUNNING + statusMessage: 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. + [Output Only] An optional textual description of the current status + of the operation. type: string - deprecated: + user: 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. + [Output Only] User who requested the operation, for example: + `user@example.com` or `alice_smith_identifier + (global/workforcePools/example-com-us-employees)`. type: string - obsolete: + progress: 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 - deleted: + [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. + type: integer + format: int32 + insertTime: 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. + [Output Only] The time that this operation was requested. This value + is in RFC3339 text format. type: string - AcceleratorTypeAggregatedList: - id: AcceleratorTypeAggregatedList - type: object - properties: - kind: + startTime: description: >- - [Output Only] Type of resource. Always - compute#acceleratorTypeAggregatedList for aggregated lists of - accelerator types. - default: compute#acceleratorTypeAggregatedList + [Output Only] The time that this operation was started by the + server. This value is in RFC3339 text format. type: string - id: + endTime: description: >- - [Output Only] Unique identifier for the resource; defined by the - server. + [Output Only] The time that this operation was completed. This value + is in RFC3339 text format. type: string - items: - description: A list of AcceleratorTypesScopedList resources. - type: object - additionalProperties: - description: >- - [Output Only] Name of the scope containing this set of accelerator - types. - $ref: '#/components/schemas/AcceleratorTypesScopedList' - nextPageToken: + error: description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. - type: string - selfLink: - description: '[Output Only] Server-defined URL for this resource.' - type: string - warning: - description: '[Output Only] Informational warning message.' + [Output Only] If errors are generated during processing of the + operation, this field will be populated. type: object properties: - code: - description: >- - [Output Only] A warning code, if applicable. For example, - Compute Engine returns NO_RESULTS_ON_PAGE if there are no - results in the response. - type: string - enumDescriptions: - - >- - Warning about failed cleanup of transient changes made by a - failed operation. - - A link to a deprecated resource was created. - - >- - When deploying and at least one of the resources has a type - marked as deprecated - - The user created a boot disk that is larger than image size. - - >- - When deploying and at least one of the resources has a type - marked as experimental - - Warning that is present in an external api call - - >- - Warning that value of a field has been overridden. Deprecated - unused field. - - >- - The operation involved use of an injected kernel, which is - deprecated. - - >- - A WEIGHTED_MAGLEV backend service is associated with a health - check that is not of type HTTP/HTTPS/HTTP2. - - >- - When deploying a deployment with a exceedingly large number of - resources - - >- - Resource can't be retrieved due to list overhead quota exceed - which captures the amount of resources filtered out by - user-defined list filter. - - A resource depends on a missing type - - >- - The route's nextHopIp address is not assigned to an instance - on the network. - - The route's next hop instance cannot ip forward. - - >- - The route's nextHopInstance URL refers to an instance that - does not have an ipv6 interface on the same network as the - route. - - >- - The route's nextHopInstance URL refers to an instance that - does not exist. - - >- - The route's nextHopInstance URL refers to an instance that is - not on the same network as the route. - - >- - The route's next hop instance does not have a status of - RUNNING. - - >- - Error which is not critical. We decided to continue the - process despite the mentioned error. - - No results are present on a particular list page. - - >- - Success is reported, but some results may be missing due to - errors - - >- - The user attempted to use a resource that requires a TOS they - have not accepted. - - Warning that a resource is in use. - - >- - One or more of the resources set to auto-delete could not be - deleted because they were in use. - - When a resource schema validation is ignored. - - >- - Instance template used in instance group manager is valid as - such, but its application does not make a lot of sense, - because it allows only single instance in instance group. - - When undeclared properties in the schema are present - - A given scope cannot be reached. - enumDeprecated: - - false - - false - - false - - false - - false - - false - - true - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - enum: - - CLEANUP_FAILED - - DEPRECATED_RESOURCE_USED - - DEPRECATED_TYPE_USED - - DISK_SIZE_LARGER_THAN_IMAGE_SIZE - - EXPERIMENTAL_TYPE_USED - - EXTERNAL_API_WARNING - - FIELD_VALUE_OVERRIDEN - - INJECTED_KERNELS_DEPRECATED - - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB - - LARGE_DEPLOYMENT_WARNING - - LIST_OVERHEAD_QUOTA_EXCEED - - MISSING_TYPE_DEPENDENCY - - NEXT_HOP_ADDRESS_NOT_ASSIGNED - - NEXT_HOP_CANNOT_IP_FORWARD - - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE - - NEXT_HOP_INSTANCE_NOT_FOUND - - NEXT_HOP_INSTANCE_NOT_ON_NETWORK - - NEXT_HOP_NOT_RUNNING - - NOT_CRITICAL_ERROR - - NO_RESULTS_ON_PAGE - - PARTIAL_SUCCESS - - REQUIRED_TOS_AGREEMENT - - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - - RESOURCE_NOT_DELETED - - SCHEMA_VALIDATION_IGNORED - - SINGLE_INSTANCE_PROPERTY_TEMPLATE - - UNDECLARED_PROPERTIES - - UNREACHABLE - message: - description: '[Output Only] A human-readable description of the warning code.' - type: string - data: + errors: description: >- - [Output Only] Metadata about this warning in key: value format. - For example: "data": [ { "key": "scope", "value": - "zones/us-east1-d" } + [Output Only] The array of errors encountered while processing + this operation. type: array items: type: object properties: - key: - description: >- - [Output Only] A key that provides more detail on the - warning being returned. For example, for warnings where - there are no results in a list request for a particular - zone, this key might be scope and the key value might be - the zone name. Other examples might be a key indicating a - deprecated resource and a suggested replacement, or a - warning about invalid network settings (for example, if an - instance attempts to perform IP forwarding but is not - enabled for IP forwarding). + code: + description: '[Output Only] The error type identifier for this error.' type: string - value: + location: description: >- - [Output Only] A warning data value corresponding to the - key. + [Output Only] Indicates the field in the request that + caused the error. This property is optional. type: string - unreachables: - description: '[Output Only] Unreachable resources.' - type: array - items: - type: string - AcceleratorTypesScopedList: - id: AcceleratorTypesScopedList - type: object - properties: - acceleratorTypes: - description: '[Output Only] A list of accelerator types contained in this scope.' - type: array - items: - $ref: '#/components/schemas/AcceleratorType' - warning: - description: >- - [Output Only] An informational warning that appears when the - accelerator types list is empty. - type: object - properties: - code: - description: >- - [Output Only] A warning code, if applicable. For example, - Compute Engine returns NO_RESULTS_ON_PAGE if there are no - results in the response. - type: string - enumDescriptions: - - >- - Warning about failed cleanup of transient changes made by a - failed operation. - - A link to a deprecated resource was created. - - >- - When deploying and at least one of the resources has a type - marked as deprecated - - The user created a boot disk that is larger than image size. - - >- - When deploying and at least one of the resources has a type - marked as experimental - - Warning that is present in an external api call - - >- - Warning that value of a field has been overridden. Deprecated - unused field. - - >- - The operation involved use of an injected kernel, which is - deprecated. - - >- - A WEIGHTED_MAGLEV backend service is associated with a health - check that is not of type HTTP/HTTPS/HTTP2. - - >- - When deploying a deployment with a exceedingly large number of - resources - - >- - Resource can't be retrieved due to list overhead quota exceed - which captures the amount of resources filtered out by - user-defined list filter. - - A resource depends on a missing type - - >- - The route's nextHopIp address is not assigned to an instance - on the network. - - The route's next hop instance cannot ip forward. - - >- - The route's nextHopInstance URL refers to an instance that - does not have an ipv6 interface on the same network as the - route. - - >- - The route's nextHopInstance URL refers to an instance that - does not exist. - - >- - The route's nextHopInstance URL refers to an instance that is - not on the same network as the route. - - >- - The route's next hop instance does not have a status of - RUNNING. - - >- - Error which is not critical. We decided to continue the - process despite the mentioned error. - - No results are present on a particular list page. - - >- - Success is reported, but some results may be missing due to - errors - - >- - The user attempted to use a resource that requires a TOS they - have not accepted. - - Warning that a resource is in use. - - >- - One or more of the resources set to auto-delete could not be - deleted because they were in use. - - When a resource schema validation is ignored. - - >- - Instance template used in instance group manager is valid as - such, but its application does not make a lot of sense, - because it allows only single instance in instance group. - - When undeclared properties in the schema are present - - A given scope cannot be reached. - enumDeprecated: - - false - - false - - false - - false - - false - - false - - true - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - enum: - - CLEANUP_FAILED - - DEPRECATED_RESOURCE_USED - - DEPRECATED_TYPE_USED - - DISK_SIZE_LARGER_THAN_IMAGE_SIZE - - EXPERIMENTAL_TYPE_USED - - EXTERNAL_API_WARNING - - FIELD_VALUE_OVERRIDEN - - INJECTED_KERNELS_DEPRECATED - - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB - - LARGE_DEPLOYMENT_WARNING - - LIST_OVERHEAD_QUOTA_EXCEED - - MISSING_TYPE_DEPENDENCY - - NEXT_HOP_ADDRESS_NOT_ASSIGNED - - NEXT_HOP_CANNOT_IP_FORWARD - - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE - - NEXT_HOP_INSTANCE_NOT_FOUND - - NEXT_HOP_INSTANCE_NOT_ON_NETWORK - - NEXT_HOP_NOT_RUNNING - - NOT_CRITICAL_ERROR - - NO_RESULTS_ON_PAGE - - PARTIAL_SUCCESS - - REQUIRED_TOS_AGREEMENT - - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - - RESOURCE_NOT_DELETED - - SCHEMA_VALIDATION_IGNORED - - SINGLE_INSTANCE_PROPERTY_TEMPLATE - - UNDECLARED_PROPERTIES - - UNREACHABLE - message: - description: '[Output Only] A human-readable description of the warning code.' - type: string - data: - description: >- - [Output Only] Metadata about this warning in key: value format. - For example: "data": [ { "key": "scope", "value": - "zones/us-east1-d" } - type: array - items: - type: object - properties: - key: - description: >- - [Output Only] A key that provides more detail on the - warning being returned. For example, for warnings where - there are no results in a list request for a particular - zone, this key might be scope and the key value might be - the zone name. Other examples might be a key indicating a - deprecated resource and a suggested replacement, or a - warning about invalid network settings (for example, if an - instance attempts to perform IP forwarding but is not - enabled for IP forwarding). - type: string - value: - description: >- - [Output Only] A warning data value corresponding to the - key. - type: string - OperationList: - id: OperationList - description: Contains a list of Operation resources. - type: object - properties: - kind: - description: >- - [Output Only] Type of resource. Always `compute#operations` for - Operations resource. - default: compute#operationList - 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 Operation resources.' - type: array - items: - $ref: '#/components/schemas/Operation' - nextPageToken: - description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - `maxResults`, use the `nextPageToken` as a value for the query - parameter `pageToken` in the next list request. Subsequent list - requests will have their own `nextPageToken` to continue paging - through the results. - type: string - selfLink: - description: '[Output Only] Server-defined URL for this resource.' - type: string - warning: - description: '[Output Only] Informational warning message.' - type: object - properties: - code: - description: >- - [Output Only] A warning code, if applicable. For example, - Compute Engine returns NO_RESULTS_ON_PAGE if there are no - results in the response. - type: string - enumDescriptions: - - >- - Warning about failed cleanup of transient changes made by a - failed operation. - - A link to a deprecated resource was created. - - >- - When deploying and at least one of the resources has a type - marked as deprecated - - The user created a boot disk that is larger than image size. - - >- - When deploying and at least one of the resources has a type - marked as experimental - - Warning that is present in an external api call - - >- - Warning that value of a field has been overridden. Deprecated - unused field. - - >- - The operation involved use of an injected kernel, which is - deprecated. - - >- - A WEIGHTED_MAGLEV backend service is associated with a health - check that is not of type HTTP/HTTPS/HTTP2. - - >- - When deploying a deployment with a exceedingly large number of - resources - - >- - Resource can't be retrieved due to list overhead quota exceed - which captures the amount of resources filtered out by - user-defined list filter. - - A resource depends on a missing type - - >- - The route's nextHopIp address is not assigned to an instance - on the network. - - The route's next hop instance cannot ip forward. - - >- - The route's nextHopInstance URL refers to an instance that - does not have an ipv6 interface on the same network as the - route. - - >- - The route's nextHopInstance URL refers to an instance that - does not exist. - - >- - The route's nextHopInstance URL refers to an instance that is - not on the same network as the route. - - >- - The route's next hop instance does not have a status of - RUNNING. - - >- - Error which is not critical. We decided to continue the - process despite the mentioned error. - - No results are present on a particular list page. - - >- - Success is reported, but some results may be missing due to - errors - - >- - The user attempted to use a resource that requires a TOS they - have not accepted. - - Warning that a resource is in use. - - >- - One or more of the resources set to auto-delete could not be - deleted because they were in use. - - When a resource schema validation is ignored. - - >- - Instance template used in instance group manager is valid as - such, but its application does not make a lot of sense, - because it allows only single instance in instance group. - - When undeclared properties in the schema are present - - A given scope cannot be reached. - enumDeprecated: - - false - - false - - false - - false - - false - - false - - true - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - enum: - - CLEANUP_FAILED - - DEPRECATED_RESOURCE_USED - - DEPRECATED_TYPE_USED - - DISK_SIZE_LARGER_THAN_IMAGE_SIZE - - EXPERIMENTAL_TYPE_USED - - EXTERNAL_API_WARNING - - FIELD_VALUE_OVERRIDEN - - INJECTED_KERNELS_DEPRECATED - - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB - - LARGE_DEPLOYMENT_WARNING - - LIST_OVERHEAD_QUOTA_EXCEED - - MISSING_TYPE_DEPENDENCY - - NEXT_HOP_ADDRESS_NOT_ASSIGNED - - NEXT_HOP_CANNOT_IP_FORWARD - - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE - - NEXT_HOP_INSTANCE_NOT_FOUND - - NEXT_HOP_INSTANCE_NOT_ON_NETWORK - - NEXT_HOP_NOT_RUNNING - - NOT_CRITICAL_ERROR - - NO_RESULTS_ON_PAGE - - PARTIAL_SUCCESS - - REQUIRED_TOS_AGREEMENT - - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - - RESOURCE_NOT_DELETED - - SCHEMA_VALIDATION_IGNORED - - SINGLE_INSTANCE_PROPERTY_TEMPLATE - - UNDECLARED_PROPERTIES - - UNREACHABLE - message: - description: '[Output Only] A human-readable description of the warning code.' - type: string - data: - description: >- - [Output Only] Metadata about this warning in key: value format. - For example: "data": [ { "key": "scope", "value": - "zones/us-east1-d" } - type: array - items: - type: object - properties: - key: - description: >- - [Output Only] A key that provides more detail on the - warning being returned. For example, for warnings where - there are no results in a list request for a particular - zone, this key might be scope and the key value might be - the zone name. Other examples might be a key indicating a - deprecated resource and a suggested replacement, or a - warning about invalid network settings (for example, if an - instance attempts to perform IP forwarding but is not - enabled for IP forwarding). - type: string - value: - description: >- - [Output Only] A warning data value corresponding to the - key. - type: string - Operation: - id: 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 `zoneOperations` resource. For - more information, read Global, Regional, and Zonal Resources. Note that - completed Operation resources have a limited retention period. - type: object - properties: - kind: - description: >- - [Output Only] Type of the resource. Always `compute#operation` for - Operation resources. - default: compute#operation - type: string - id: - description: >- - [Output Only] The unique identifier for the operation. This - identifier is defined by the server. - type: string - format: uint64 - creationTimestamp: - description: '[Deprecated] This field is deprecated.' - type: string - name: - description: '[Output Only] Name of the operation.' - type: string - zone: - description: >- - [Output Only] The URL of the zone where the operation resides. Only - applicable when performing per-zone operations. - type: string - clientOperationId: - description: >- - [Output Only] The value of `requestId` if you provided it in the - request. Not present otherwise. - type: string - operationType: - description: >- - [Output Only] The type of operation, such as `insert`, `update`, or - `delete`, and so on. - 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 - disk that the snapshot was created from. - type: string - targetId: - description: >- - [Output Only] The unique target ID, which identifies a specific - incarnation of the target resource. - type: string - format: uint64 - status: - description: >- - [Output Only] The status of the operation, which can be one of the - following: `PENDING`, `RUNNING`, or `DONE`. - type: string - enumDescriptions: - - '' - - '' - - '' - enum: - - DONE - - PENDING - - RUNNING - statusMessage: - description: >- - [Output Only] An optional textual description of the current status - of the operation. - type: string - user: - description: >- - [Output Only] User who requested the operation, for example: - `user@example.com` or `alice_smith_identifier - (global/workforcePools/example-com-us-employees)`. - 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. - type: integer - format: int32 - insertTime: - description: >- - [Output Only] The time that this operation was requested. This value - is in RFC3339 text format. - 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 - 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. - type: object - properties: - errors: - description: >- - [Output Only] The array of errors encountered while processing - this operation. - type: array - items: - type: object - 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 - errorDetails: - description: >- - [Output Only] An optional list of messages that contain - the error details. There is a set of defined message types - to use for providing details.The syntax depends on the - error code. For example, QuotaExceededInfo will have - details when the error code is QUOTA_EXCEEDED. - type: array - items: - type: object - properties: - errorInfo: - $ref: '#/components/schemas/ErrorInfo' - quotaInfo: - $ref: '#/components/schemas/QuotaExceededInfo' - help: - $ref: '#/components/schemas/Help' - localizedMessage: - $ref: '#/components/schemas/LocalizedMessage' - warnings: - description: >- - [Output Only] If warning messages are generated during processing of - the operation, this field will be populated. + message: + description: '[Output Only] An optional, human-readable error message.' + type: string + errorDetails: + description: >- + [Output Only] An optional list of messages that contain + the error details. There is a set of defined message types + to use for providing details.The syntax depends on the + error code. For example, QuotaExceededInfo will have + details when the error code is QUOTA_EXCEEDED. + type: array + items: + type: object + properties: + errorInfo: + $ref: '#/components/schemas/ErrorInfo' + quotaInfo: + $ref: '#/components/schemas/QuotaExceededInfo' + help: + $ref: '#/components/schemas/Help' + localizedMessage: + $ref: '#/components/schemas/LocalizedMessage' + warnings: + description: >- + [Output Only] If warning messages are generated during processing of + the operation, this field will be populated. type: array items: type: object @@ -1145,6 +476,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -1188,6 +522,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -1210,6 +545,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -1278,168 +614,30 @@ components: [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 - setCommonInstanceMetadataOperationMetadata: - description: >- - [Output Only] If the operation is for - projects.setCommonInstanceMetadata, this field will contain - information on all underlying zonal actions and their state. - $ref: '#/components/schemas/SetCommonInstanceMetadataOperationMetadata' - instancesBulkInsertOperationMetadata: - $ref: '#/components/schemas/InstancesBulkInsertOperationMetadata' - ErrorInfo: - id: ErrorInfo - description: >- - Describes the cause of the error with structured details. Example of an - error when contacting the "pubsub.googleapis.com" API when it is not - enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" - "metadata": { "resource": "projects/123", "service": - "pubsub.googleapis.com" } } This response indicates that the - pubsub.googleapis.com API is not enabled. Example of an error that is - returned when attempting to create a Spanner instance in a region that - is out of stock: { "reason": "STOCKOUT" "domain": - "spanner.googleapis.com", "metadata": { "availableRegions": - "us-central1,us-east2" } } + SetCommonInstanceMetadataOperationMetadata: + id: SetCommonInstanceMetadataOperationMetadata type: object properties: - reason: - description: >- - The reason of the error. This is a constant value that identifies - the proximate cause of the error. Error reasons are unique within a - particular domain of errors. This should be at most 63 characters - and match a regular expression of `A-Z+[A-Z0-9]`, which represents - UPPER_SNAKE_CASE. - type: string - domain: - description: >- - The logical grouping to which the "reason" belongs. The error domain - is typically the registered service name of the tool or product that - generates the error. Example: "pubsub.googleapis.com". If the error - is generated by some common infrastructure, the error domain must be - a globally unique value that identifies the infrastructure. For - Google API infrastructure, the error domain is "googleapis.com". + clientOperationId: + description: '[Output Only] The client operation id.' type: string - metadatas: + perLocationOperations: description: >- - Additional structured details about this error. Keys must match - /a-z+/ but should ideally be lowerCamelCase. Also they must be - limited to 64 characters in length. When identifying the current - value of an exceeded limit, the units should be contained in the - key, not the value. For example, rather than {"instanceLimit": - "100/request"}, should be returned as, {"instanceLimitPerRequest": - "100"}, if the client exceeds the number of instances that can be - created in a single (batch) request. + [Output Only] Status information per location (location name is + key). Example key: zones/us-central1-a type: object additionalProperties: - type: string - QuotaExceededInfo: - id: QuotaExceededInfo - description: Additional details for quota exceeded error for resource quota. + $ref: >- + #/components/schemas/SetCommonInstanceMetadataOperationMetadataPerLocationOperationInfo + SetCommonInstanceMetadataOperationMetadataPerLocationOperationInfo: + id: SetCommonInstanceMetadataOperationMetadataPerLocationOperationInfo type: object properties: - metricName: - description: The Compute Engine quota metric name. - type: string - limitName: - description: The name of the quota limit. - type: string - dimensions: - description: The map holding related quota dimensions. - type: object - additionalProperties: - type: string - limit: - description: >- - Current effective quota limit. The limit's unit depends on the quota - type or metric. - type: number - format: double - futureLimit: + state: description: >- - Future quota limit being rolled out. The limit's unit depends on the - quota type or metric. - type: number - format: double - rolloutStatus: - description: Rollout status of the future quota limit. - type: string - enumDescriptions: - - >- - IN_PROGRESS - A rollout is in process which will change the limit - value to future limit. - - >- - ROLLOUT_STATUS_UNSPECIFIED - Rollout status is not specified. The - default value. - enum: - - IN_PROGRESS - - ROLLOUT_STATUS_UNSPECIFIED - Help: - id: Help - description: >- - Provides links to documentation or for performing an out of band action. - For example, if a quota check failed with an error indicating the - calling project hasn't enabled the accessed service, this can contain a - URL pointing directly to the right place in the developer console to - flip the bit. - type: object - properties: - links: - description: >- - URL(s) pointing to additional information on handling the current - error. - type: array - items: - $ref: '#/components/schemas/HelpLink' - HelpLink: - id: HelpLink - description: Describes a URL link. - type: object - properties: - description: - description: Describes what the link offers. - type: string - url: - description: The URL of the link. - type: string - LocalizedMessage: - id: LocalizedMessage - description: >- - Provides a localized error message that is safe to return to the user - which can be attached to an RPC error. - type: object - properties: - locale: - description: >- - The locale used following the specification defined at - https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", - "fr-CH", "es-MX" - type: string - message: - description: The localized error message in the above locale. - type: string - SetCommonInstanceMetadataOperationMetadata: - id: SetCommonInstanceMetadataOperationMetadata - type: object - properties: - clientOperationId: - description: '[Output Only] The client operation id.' - type: string - perLocationOperations: - description: >- - [Output Only] Status information per location (location name is - key). Example key: zones/us-central1-a - type: object - additionalProperties: - $ref: >- - #/components/schemas/SetCommonInstanceMetadataOperationMetadataPerLocationOperationInfo - SetCommonInstanceMetadataOperationMetadataPerLocationOperationInfo: - id: SetCommonInstanceMetadataOperationMetadataPerLocationOperationInfo - type: object - properties: - state: - description: >- - [Output Only] Status of the action, which can be one of the - following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or - `DONE`. + [Output Only] Status of the action, which can be one of the + following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or + `DONE`. type: string enumDescriptions: - >- @@ -1492,6 +690,7 @@ components: set of message types for APIs to use. type: array items: + format: google.protobuf.Any type: object additionalProperties: type: any @@ -1544,6 +743,136 @@ components: description: '[Output Only] Count of VMs that got deleted during rollback.' type: integer format: int32 + ErrorInfo: + id: ErrorInfo + description: >- + Describes the cause of the error with structured details. Example of an + error when contacting the "pubsub.googleapis.com" API when it is not + enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" + "metadata": { "resource": "projects/123", "service": + "pubsub.googleapis.com" } } This response indicates that the + pubsub.googleapis.com API is not enabled. Example of an error that is + returned when attempting to create a Spanner instance in a region that + is out of stock: { "reason": "STOCKOUT" "domain": + "spanner.googleapis.com", "metadata": { "availableRegions": + "us-central1,us-east2" } } + type: object + properties: + reason: + description: >- + The reason of the error. This is a constant value that identifies + the proximate cause of the error. Error reasons are unique within a + particular domain of errors. This should be at most 63 characters + and match a regular expression of `A-Z+[A-Z0-9]`, which represents + UPPER_SNAKE_CASE. + type: string + domain: + description: >- + The logical grouping to which the "reason" belongs. The error domain + is typically the registered service name of the tool or product that + generates the error. Example: "pubsub.googleapis.com". If the error + is generated by some common infrastructure, the error domain must be + a globally unique value that identifies the infrastructure. For + Google API infrastructure, the error domain is "googleapis.com". + type: string + metadatas: + description: >- + Additional structured details about this error. Keys must match a + regular expression of `a-z+` but should ideally be lowerCamelCase. + Also, they must be limited to 64 characters in length. When + identifying the current value of an exceeded limit, the units should + be contained in the key, not the value. For example, rather than + `{"instanceLimit": "100/request"}`, should be returned as, + `{"instanceLimitPerRequest": "100"}`, if the client exceeds the + number of instances that can be created in a single (batch) request. + type: object + additionalProperties: + type: string + QuotaExceededInfo: + id: QuotaExceededInfo + description: Additional details for quota exceeded error for resource quota. + type: object + properties: + metricName: + description: The Compute Engine quota metric name. + type: string + limitName: + description: The name of the quota limit. + type: string + dimensions: + description: The map holding related quota dimensions. + type: object + additionalProperties: + type: string + limit: + description: >- + Current effective quota limit. The limit's unit depends on the quota + type or metric. + type: number + format: double + futureLimit: + description: >- + Future quota limit being rolled out. The limit's unit depends on the + quota type or metric. + type: number + format: double + rolloutStatus: + description: Rollout status of the future quota limit. + type: string + enumDescriptions: + - >- + IN_PROGRESS - A rollout is in process which will change the limit + value to future limit. + - >- + ROLLOUT_STATUS_UNSPECIFIED - Rollout status is not specified. The + default value. + enum: + - IN_PROGRESS + - ROLLOUT_STATUS_UNSPECIFIED + Help: + id: Help + description: >- + Provides links to documentation or for performing an out of band action. + For example, if a quota check failed with an error indicating the + calling project hasn't enabled the accessed service, this can contain a + URL pointing directly to the right place in the developer console to + flip the bit. + type: object + properties: + links: + description: >- + URL(s) pointing to additional information on handling the current + error. + type: array + items: + $ref: '#/components/schemas/HelpLink' + HelpLink: + id: HelpLink + description: Describes a URL link. + type: object + properties: + description: + description: Describes what the link offers. + type: string + url: + description: The URL of the link. + type: string + LocalizedMessage: + id: LocalizedMessage + description: >- + Provides a localized error message that is safe to return to the user + which can be attached to an RPC error. + type: object + properties: + locale: + description: >- + The locale used following the specification defined at + https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", + "fr-CH", "es-MX" + type: string + message: + description: The localized error message in the above locale. + type: string OperationAggregatedList: id: OperationAggregatedList type: object @@ -1642,6 +971,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -1685,6 +1017,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -1707,6 +1040,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -1823,6 +1157,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -1866,6 +1203,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -1888,6 +1226,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -1924,16 +1263,16 @@ components: [Output Only] A warning data value corresponding to the key. type: string - AddressList: - id: AddressList - description: Contains a list of addresses. + AcceleratorTypeList: + id: AcceleratorTypeList + description: Contains a list of accelerator types. type: object properties: kind: description: >- - [Output Only] Type of resource. Always compute#addressList for lists - of addresses. - default: compute#addressList + [Output Only] Type of resource. Always compute#acceleratorTypeList + for lists of accelerator types. + default: compute#acceleratorTypeList type: string id: description: >- @@ -1941,10 +1280,10 @@ components: server. type: string items: - description: A list of Address resources. + description: A list of AcceleratorType resources. type: array items: - $ref: '#/components/schemas/Address' + $ref: '#/components/schemas/AcceleratorType' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -1953,6 +1292,9 @@ components: pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. type: string + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string warning: description: '[Output Only] Informational warning message.' type: object @@ -2017,6 +1359,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -2060,6 +1405,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -2082,6 +1428,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -2118,25 +1465,20 @@ components: [Output Only] A warning data value corresponding to the key. type: string - selfLink: - description: '[Output Only] Server-defined URL for this resource.' - type: string - Address: - id: Address + AcceleratorType: + id: AcceleratorType 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. + 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. type: object properties: kind: description: >- - [Output Only] Type of the resource. Always compute#address for - addresses. - default: compute#address + [Output Only] The type of the resource. Always + compute#acceleratorType for accelerator types. + default: compute#acceleratorType type: string id: description: >- @@ -2148,273 +1490,109 @@ components: description: '[Output Only] Creation timestamp in RFC3339 text format.' 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. + description: '[Output Only] Name of the resource.' pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' - annotations: - required: - - compute.addresses.insert type: string description: - description: >- - An optional description of this resource. Provide this field when - you create the resource. - type: string - address: - description: The static IP address represented by this resource. + description: '[Output Only] An optional textual description of the resource.' type: string - prefixLength: - description: The prefix length if the resource represents an IP range. - type: integer - format: int32 - status: + deprecated: 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. - type: string - enumDescriptions: - - Address is being used by another resource and is not available. - - Address is reserved and available to use. - - Address is being reserved. - enum: - - IN_USE - - RESERVED - - RESERVING - region: + [Output Only] The deprecation status associated with this + accelerator type. + $ref: '#/components/schemas/DeprecationStatus' + zone: 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.* + [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 selfLink: - description: '[Output Only] Server-defined URL for the resource.' - type: string - users: - description: '[Output Only] The URLs of the resources that are using this address.' - type: array - items: - 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. + description: '[Output Only] Server-defined, fully qualified URL for this resource.' type: string - enumDescriptions: - - Public internet quality with fixed bandwidth. - - >- - High quality, Google-grade network tier, support for all - networking products. - - >- - Public internet quality, only limited support for other networking - products. - - >- - (Output only) Temporary tier for FIXED_STANDARD when fixed - standard tier is expired or not configured. - enum: - - FIXED_STANDARD - - PREMIUM - - STANDARD - - STANDARD_OVERRIDES_FIXED_STANDARD - labels: - 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 - additionalProperties: - type: string - labelFingerprint: + maximumCardsPerInstance: description: >- - A fingerprint for the labels being applied to this Address, 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 Address. - type: string - format: byte - ipVersion: + [Output Only] Maximum number of accelerator cards allowed per + instance. + type: integer + format: int32 + DeprecationStatus: + id: DeprecationStatus + description: Deprecation status for a public resource. + type: object + properties: + state: description: >- - The IP version that will be used by this address. Valid options are - IPV4 or IPV6. + 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. type: string enumDescriptions: - '' - '' - '' - enum: - - IPV4 - - IPV6 - - UNSPECIFIED_VERSION - addressType: - description: >- - The type of address to reserve, either INTERNAL or EXTERNAL. If - unspecified, defaults to EXTERNAL. - type: string - enumDescriptions: - - A publicly visible external IP address. - - >- - A private network IP address, for use with an Instance or Internal - Load Balancer forwarding rule. - '' enum: - - EXTERNAL - - INTERNAL - - UNSPECIFIED_TYPE - purpose: + - ACTIVE + - DELETED + - DEPRECATED + - OBSOLETE + replacement: 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 automatic NAT IP address allocation. - - IPSEC_INTERCONNECT for addresses created from a private IP range - that are reserved for a VLAN attachment in an *HA VPN over Cloud - Interconnect* configuration. These addresses are regional resources. - - `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. + 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 - enumDescriptions: - - DNS resolver address in the subnetwork. - - VM internal/alias IP, Internal LB service IP, etc. - - >- - A regional internal IP address range reserved for the VLAN - attachment that is used in HA VPN over Cloud Interconnect. This - regional internal IP address range must not overlap with any IP - address range of subnet/route in the VPC network and its peering - networks. After the VLAN attachment is created with the reserved - IP address range, when creating a new VPN gateway, its interface - IP address is allocated from the associated VLAN attachment’s IP - address range. - - External IP automatically reserved for Cloud NAT. - - >- - A private network IP address that can be used to configure Private - Service Connect. This purpose can be specified only for GLOBAL - addresses of Type INTERNAL - - A regional internal IP address range reserved for Serverless. - - >- - A private network IP address that can be shared by multiple - Internal Load Balancer forwarding rules. - - IP range for peer networks. - enum: - - DNS_RESOLVER - - GCE_ENDPOINT - - IPSEC_INTERCONNECT - - NAT_AUTO - - PRIVATE_SERVICE_CONNECT - - SERVERLESS - - SHARED_LOADBALANCER_VIP - - VPC_PEERING - subnetwork: + deprecated: 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. + 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 - network: + obsolete: 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. + 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 - ipv6EndpointType: + deleted: description: >- - The endpoint type of this address, which should be VM or NETLB. This - is used for deciding which type of endpoint this address can be used - after the external IPv6 address reservation. + 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 - enumDescriptions: - - Reserved IPv6 address can be used on network load balancer. - - Reserved IPv6 address can be used on VM. - enum: - - NETLB - - VM - GlobalAddressesMoveRequest: - id: GlobalAddressesMoveRequest + AcceleratorTypeAggregatedList: + id: AcceleratorTypeAggregatedList type: object properties: - destinationAddress: + kind: description: >- - The URL of the destination address to move to. This can be a full or - partial URL. For example, the following are all valid URLs to a - address: - https://www.googleapis.com/compute/v1/projects/project - /global/addresses/address - - projects/project/global/addresses/address Note that destination - project must be different from the source project. So - /global/addresses/address is not valid partial url. + [Output Only] Type of resource. Always + compute#acceleratorTypeAggregatedList for aggregated lists of + accelerator types. + default: compute#acceleratorTypeAggregatedList type: string - description: + id: description: >- - An optional destination address description if intended to be - different from the source. + [Output Only] Unique identifier for the resource; defined by the + server. type: string - GlobalSetLabelsRequest: - id: GlobalSetLabelsRequest - type: object - properties: - labels: - description: >- - A list of labels to apply for this resource. Each label must comply - with the requirements for labels. For example, "webserver-frontend": - "images". A label value can also be empty (e.g. "my-label": ""). + items: + description: A list of AcceleratorTypesScopedList resources. type: object additionalProperties: - type: string - 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. - type: string - format: byte - AddressAggregatedList: - id: AddressAggregatedList - type: object - properties: - kind: - description: >- - [Output Only] Type of resource. Always compute#addressAggregatedList - for aggregated lists of addresses. - default: compute#addressAggregatedList - type: string - id: - description: >- - [Output Only] Unique identifier for the resource; defined by the - server. - type: string - items: - description: A list of AddressesScopedList resources. - type: object - additionalProperties: - description: '[Output Only] Name of the scope containing this set of addresses.' - $ref: '#/components/schemas/AddressesScopedList' + description: >- + [Output Only] Name of the scope containing this set of accelerator + types. + $ref: '#/components/schemas/AcceleratorTypesScopedList' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -2490,6 +1668,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -2533,6 +1714,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -2555,6 +1737,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -2596,19 +1779,19 @@ components: type: array items: type: string - AddressesScopedList: - id: AddressesScopedList + AcceleratorTypesScopedList: + id: AcceleratorTypesScopedList type: object properties: - addresses: - description: '[Output Only] A list of addresses contained in this scope.' + acceleratorTypes: + description: '[Output Only] A list of accelerator types contained in this scope.' type: array items: - $ref: '#/components/schemas/Address' + $ref: '#/components/schemas/AcceleratorType' warning: description: >- - [Output Only] Informational warning which replaces the list of - addresses when the list is empty. + [Output Only] An informational warning that appears when the + accelerator types list is empty. type: object properties: code: @@ -2671,6 +1854,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -2714,6 +1900,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -2736,6 +1923,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -2772,53 +1960,16 @@ components: [Output Only] A warning data value corresponding to the key. type: string - RegionAddressesMoveRequest: - id: RegionAddressesMoveRequest - type: object - properties: - destinationAddress: - description: >- - The URL of the destination address to move to. This can be a full or - partial URL. For example, the following are all valid URLs to a - address: - - https://www.googleapis.com/compute/v1/projects/project/regions/region - /addresses/address - - projects/project/regions/region/addresses/address Note that - destination project must be different from the source project. So - /regions/region/addresses/address is not valid partial url. - type: string - description: - description: >- - An optional destination address description if intended to be - different from the source. - type: string - RegionSetLabelsRequest: - id: RegionSetLabelsRequest - type: object - properties: - labels: - description: The labels to set for this resource. - type: object - additionalProperties: - type: string - 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. - type: string - format: byte - ImageList: - id: ImageList - description: Contains a list of images. + AddressList: + id: AddressList + description: Contains a list of addresses. type: object properties: kind: - description: Type of resource. - default: compute#imageList + description: >- + [Output Only] Type of resource. Always compute#addressList for lists + of addresses. + default: compute#addressList type: string id: description: >- @@ -2826,10 +1977,10 @@ components: server. type: string items: - description: A list of Image resources. + description: A list of Address resources. type: array items: - $ref: '#/components/schemas/Image' + $ref: '#/components/schemas/Address' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -2838,9 +1989,6 @@ components: pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. type: string - selfLink: - description: '[Output Only] Server-defined URL for this resource.' - type: string warning: description: '[Output Only] Informational warning message.' type: object @@ -2905,6 +2053,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -2948,6 +2099,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -2970,6 +2122,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -3006,16 +2159,25 @@ components: [Output Only] A warning data value corresponding to the key. type: string - Image: - id: Image + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string + Address: + id: Address description: >- - Represents an Image resource. You can use images to create boot disks - for your VM instances. For more information, read Images. + 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. type: object properties: kind: - description: '[Output Only] Type of the resource. Always compute#image for images.' - default: compute#image + description: >- + [Output Only] Type of the resource. Always compute#address for + addresses. + default: compute#address type: string id: description: >- @@ -3028,747 +2190,260 @@ components: type: string name: description: >- - Name of the resource; provided by the client when the resource is + 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. + 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])?' annotations: required: - - compute.images.insert + - compute.addresses.insert type: string description: description: >- - An optional description of this resource. Provide this property when + An optional description of this resource. Provide this field when you create the resource. type: string - sourceType: - description: >- - The type of the image used to create this disk. The default and only - valid value is RAW. - default: RAW + address: + description: The static IP address represented by this resource. type: string - enumDescriptions: - - '' - enum: - - RAW - rawDisk: - description: The parameters of the raw disk image. - type: object - properties: - 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 - 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}' - deprecated: true - type: string - 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. - type: string - enumDescriptions: - - '' - enum: - - TAR - deprecated: - description: The deprecation status associated with this image. - $ref: '#/components/schemas/DeprecationStatus' + prefixLength: + description: The prefix length if the resource represents an IP range. + type: integer + format: int32 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. + [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. type: string enumDescriptions: - - Image is deleting. - - Image creation failed due to an error. - - Image hasn't been created as yet. - - Image has been successfully created. + - Address is being used by another resource and is not available. + - Address is reserved and available to use. + - Address is being reserved. enum: - - DELETING - - FAILED - - PENDING - - READY - archiveSizeBytes: - description: >- - Size of the image tar.gz archive stored in Google Cloud Storage (in - bytes). - type: string - format: int64 - diskSizeGb: - description: Size of the image when restored onto a persistent disk (in GB). - type: string - format: int64 - sourceDisk: + - IN_USE + - RESERVED + - RESERVING + region: 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 + [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 - 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. + selfLink: + description: '[Output Only] Server-defined URL for the resource.' type: string - licenses: - description: Any applicable license URI. + users: + description: '[Output Only] The URLs of the resources that are using this address.' type: array items: type: string - family: - description: >- - The name of the image family to which this image belongs. The image - family name can be from a publicly managed image family provided by - Compute Engine, or from a custom image family you create. For - example, centos-stream-9 is a publicly available image family. For - more information, see Image family best practices. When creating - disks, you can specify an image family instead of a specific image - name. The image family always returns its latest image that is not - deprecated. The name of the image family must comply with RFC1035. - type: string - imageEncryptionKey: - 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. - $ref: '#/components/schemas/CustomerEncryptionKey' - sourceDiskEncryptionKey: + networkTier: description: >- - The customer-supplied encryption key of the source disk. Required if - the source disk is protected by a customer-supplied encryption key. - $ref: '#/components/schemas/CustomerEncryptionKey' - selfLink: - description: '[Output Only] Server-defined URL for the resource.' + 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. type: string + enumDescriptions: + - Public internet quality with fixed bandwidth. + - >- + High quality, Google-grade network tier, support for all + networking products. + - >- + Public internet quality, only limited support for other networking + products. + - >- + (Output only) Temporary tier for FIXED_STANDARD when fixed + standard tier is expired or not configured. + enum: + - FIXED_STANDARD + - PREMIUM + - STANDARD + - STANDARD_OVERRIDES_FIXED_STANDARD labels: description: >- - Labels to apply to this image. These can be later modified by the - setLabels method. + 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 additionalProperties: 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 + A fingerprint for the labels being applied to this Address, 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 image. + to retrieve an Address. type: string format: byte - guestOsFeatures: - description: >- - A list of features to enable on the guest operating system. - Applicable only for bootable images. To see a list of available - options, see the guestOSfeatures[].type parameter. - type: array - items: - $ref: '#/components/schemas/GuestOsFeature' - licenseCodes: - description: >- - Integer license codes indicating which licenses are attached to this - image. - type: array - items: - type: string - format: int64 - sourceImage: + ipVersion: 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 + The IP version that will be used by this address. Valid options are + IPV4 or IPV6. type: string - sourceImageId: + enumDescriptions: + - '' + - '' + - '' + enum: + - IPV4 + - IPV6 + - UNSPECIFIED_VERSION + addressType: 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. + The type of address to reserve, either INTERNAL or EXTERNAL. If + unspecified, defaults to EXTERNAL. type: string - sourceImageEncryptionKey: - description: >- - The customer-supplied encryption key of the source image. Required - if the source image is protected by a customer-supplied encryption - key. - $ref: '#/components/schemas/CustomerEncryptionKey' - sourceSnapshot: + enumDescriptions: + - A publicly visible external IP address. + - >- + A private network IP address, for use with an Instance or Internal + Load Balancer forwarding rule. + - '' + enum: + - EXTERNAL + - INTERNAL + - UNSPECIFIED_TYPE + purpose: 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 + 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 automatic NAT IP address allocation. + - IPSEC_INTERCONNECT for addresses created from a private IP range + that are reserved for a VLAN attachment in an *HA VPN over Cloud + Interconnect* configuration. These addresses are regional resources. + - `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. type: string - sourceSnapshotId: + enumDescriptions: + - DNS resolver address in the subnetwork. + - VM internal/alias IP, Internal LB service IP, etc. + - >- + A regional internal IP address range reserved for the VLAN + attachment that is used in HA VPN over Cloud Interconnect. This + regional internal IP address range must not overlap with any IP + address range of subnet/route in the VPC network and its peering + networks. After the VLAN attachment is created with the reserved + IP address range, when creating a new VPN gateway, its interface + IP address is allocated from the associated VLAN attachment’s IP + address range. + - External IP automatically reserved for Cloud NAT. + - >- + A private network IP address that can be used to configure Private + Service Connect. This purpose can be specified only for GLOBAL + addresses of Type INTERNAL + - A regional internal IP address range reserved for Serverless. + - >- + A private network IP address that can be shared by multiple + Internal Load Balancer forwarding rules. + - IP range for peer networks. + enum: + - DNS_RESOLVER + - GCE_ENDPOINT + - IPSEC_INTERCONNECT + - NAT_AUTO + - PRIVATE_SERVICE_CONNECT + - SERVERLESS + - SHARED_LOADBALANCER_VIP + - VPC_PEERING + subnetwork: 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. + 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 - sourceSnapshotEncryptionKey: + network: description: >- - The customer-supplied encryption key of the source snapshot. - Required if the source snapshot is protected by a customer-supplied - encryption key. - $ref: '#/components/schemas/CustomerEncryptionKey' - storageLocations: + 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 + ipv6EndpointType: description: >- - Cloud Storage bucket storage location of the image (regional or - multi-regional). - type: array - items: - type: string - shieldedInstanceInitialState: - description: Set the secure boot keys of shielded instance. - $ref: '#/components/schemas/InitialStateConfig' - satisfiesPzs: - description: '[Output Only] Reserved for future use.' - type: boolean - architecture: - description: The architecture of the image. Valid values are ARM64 or X86_64. + The endpoint type of this address, which should be VM or NETLB. This + is used for deciding which type of endpoint this address can be used + after the external IPv6 address reservation. type: string enumDescriptions: - - Default value indicating Architecture is not set. - - Machines with architecture ARM64 - - Machines with architecture X86_64 + - Reserved IPv6 address can be used on network load balancer. + - Reserved IPv6 address can be used on VM. enum: - - ARCHITECTURE_UNSPECIFIED - - ARM64 - - X86_64 - enableConfidentialCompute: - description: >- - Whether this image is created from a confidential compute mode disk. - [Output Only]: This field is not set by user, but from source disk. - type: boolean - satisfiesPzi: - description: Output only. Reserved for future use. - readOnly: true - type: boolean - CustomerEncryptionKey: - id: CustomerEncryptionKey + - NETLB + - VM + GlobalAddressesMoveRequest: + id: GlobalAddressesMoveRequest type: object properties: - rawKey: + destinationAddress: 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=" + The URL of the destination address to move to. This can be a full or + partial URL. For example, the following are all valid URLs to a + address: - https://www.googleapis.com/compute/v1/projects/project + /global/addresses/address - + projects/project/global/addresses/address Note that destination + project must be different from the source project. So + /global/addresses/address is not valid partial url. type: string - rsaEncryptedKey: + description: 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 - 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 The fully-qualifed key name may be - returned for resource GET requests. For example: "kmsKeyName": - "projects/kms_project_id/locations/region/keyRings/ - key_region/cryptoKeys/key /cryptoKeyVersions/1 - 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 - 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 - GuestOsFeature: - id: GuestOsFeature - description: Guest OS features. - type: object - properties: - type: - description: >- - The ID of a supported feature. To add multiple values, use commas to - separate values. Set to one or more of the following values: - - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - - SEV_LIVE_MIGRATABLE_V2 - SEV_SNP_CAPABLE - TDX_CAPABLE - IDPF For - more information, see Enabling guest operating system features. - type: string - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - enum: - - FEATURE_TYPE_UNSPECIFIED - - GVNIC - - IDPF - - MULTI_IP_SUBNET - - SECURE_BOOT - - SEV_CAPABLE - - SEV_LIVE_MIGRATABLE - - SEV_LIVE_MIGRATABLE_V2 - - SEV_SNP_CAPABLE - - TDX_CAPABLE - - UEFI_COMPATIBLE - - VIRTIO_SCSI_MULTIQUEUE - - WINDOWS - InitialStateConfig: - id: InitialStateConfig - description: >- - Initial State for shielded instance, these are public keys which are - safe to store in public - type: object - properties: - pk: - description: The Platform Key (PK). - $ref: '#/components/schemas/FileContentBuffer' - keks: - description: The Key Exchange Key (KEK). - type: array - items: - $ref: '#/components/schemas/FileContentBuffer' - dbs: - description: The Key Database (db). - type: array - items: - $ref: '#/components/schemas/FileContentBuffer' - dbxs: - description: The forbidden key database (dbx). - type: array - items: - $ref: '#/components/schemas/FileContentBuffer' - FileContentBuffer: - id: FileContentBuffer - type: object - properties: - content: - description: The raw content in the secure keys file. - type: string - format: byte - fileType: - description: The file type of source file. - type: string - enumDescriptions: - - '' - - '' - - '' - enum: - - BIN - - UNDEFINED - - X509 - Policy: - id: Policy - description: >- - An Identity and Access Management (IAM) policy, which specifies access - controls for Google Cloud resources. A `Policy` is a collection of - `bindings`. A `binding` binds one or more `members`, or principals, to a - single `role`. Principals can be user accounts, service accounts, Google - groups, and domains (such as G Suite). A `role` is a named list of - permissions; each `role` can be an IAM predefined role or a user-created - custom role. For some types of Google Cloud resources, a `binding` can - also specify a `condition`, which is a logical expression that allows - access to a resource only if the expression evaluates to `true`. A - condition can add constraints based on attributes of the request, the - resource, or both. To learn which resources support conditions in their - IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - **JSON example:** ``` { "bindings": [ { "role": - "roles/resourcemanager.organizationAdmin", "members": [ - "user:mike@example.com", "group:admins@example.com", - "domain:google.com", - "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { - "role": "roles/resourcemanager.organizationViewer", "members": [ - "user:eve@example.com" ], "condition": { "title": "expirable access", - "description": "Does not grant access after Sep 2020", "expression": - "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": - "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - - members: - user:mike@example.com - group:admins@example.com - - domain:google.com - - serviceAccount:my-project-id@appspot.gserviceaccount.com role: - roles/resourcemanager.organizationAdmin - members: - - user:eve@example.com role: roles/resourcemanager.organizationViewer - condition: title: expirable access description: Does not grant access - after Sep 2020 expression: request.time < - timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` - For a description of IAM and its features, see the [IAM - documentation](https://cloud.google.com/iam/docs/). - type: object - properties: - 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). - type: integer - format: int32 - bindings: - description: >- - Associates a list of `members`, or principals, with a `role`. - Optionally, may specify a `condition` that determines how and when - the `bindings` are applied. Each of the `bindings` must contain at - least one principal. The `bindings` in a `Policy` can refer to up to - 1,500 principals; up to 250 of these principals can be Google - groups. Each occurrence of a principal counts towards these limits. - For example, if the `bindings` grant 50 different roles to - `user:alice@example.com`, and not to any other principal, then you - can add another 1,450 principals to the `bindings` in the `Policy`. - type: array - items: - $ref: '#/components/schemas/Binding' - auditConfigs: - description: Specifies cloud audit logging configuration for this policy. - type: array - items: - $ref: '#/components/schemas/AuditConfig' - 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. - type: string - format: byte - Binding: - id: Binding - description: Associates `members`, or principals, with a `role`. - type: object - properties: - role: - description: >- - Role that is assigned to the list of `members`, or principals. For - example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an - overview of the IAM roles and permissions, see the [IAM - documentation](https://cloud.google.com/iam/docs/roles-overview). - For a list of the available pre-defined roles, see - [here](https://cloud.google.com/iam/docs/understanding-roles). - type: string - members: - description: >- - Specifies the principals requesting access for a Google Cloud - 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. Does not include identities - that come from external identity providers (IdPs) through identity - federation. * `user:{emailid}`: An email address that represents a - specific Google account. For example, `alice@example.com` . * - `serviceAccount:{emailid}`: An email address that represents a - Google service account. For example, - `my-other-app@appspot.gserviceaccount.com`. * - `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: - An identifier for a [Kubernetes service - account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). - For example, - `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * - `group:{emailid}`: An email address that represents a Google group. - For example, `admins@example.com`. * `domain:{domain}`: The G Suite - domain (primary) that represents all the users of that domain. For - example, `google.com` or `example.com`. * - `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workforce identity pool. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: - All workforce identities in a group. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All workforce identities with a specific attribute value. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: - All identities in a workforce identity pool. * - `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workload identity pool. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: - A workload identity pool group. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All identities in a workload identity pool with a certain attribute. - * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: - All identities in a workload identity pool. * - `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. * - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - Deleted single identity in a workforce identity pool. For example, - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. - type: array - items: - type: string - condition: - description: >- - The condition that is associated with this binding. If the condition - evaluates to `true`, then this binding applies to the current - request. If the condition evaluates to `false`, then this binding - does not apply to the current request. However, a different role - binding might grant the same role to one or more of the principals - in this binding. To learn which resources support conditions in - their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - $ref: '#/components/schemas/Expr' - Expr: - id: 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. - type: object - properties: - expression: - description: >- - Textual representation of an expression in Common Expression - Language syntax. - 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 - 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 - 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 - AuditConfig: - id: 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. - type: object - properties: - 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. + An optional destination address description if intended to be + different from the source. type: string - auditLogConfigs: - description: The configuration for logging of each type of permission. - type: array - items: - $ref: '#/components/schemas/AuditLogConfig' - AuditLogConfig: - id: 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. + GlobalSetLabelsRequest: + id: GlobalSetLabelsRequest type: object properties: - logType: - description: The log type that this config enables. - type: string - enumDescriptions: - - 'Admin reads. Example: CloudIAM getIamPolicy' - - 'Data reads. Example: CloudSQL Users list' - - 'Data writes. Example: CloudSQL Users create' - - Default case. Should never be this. - enum: - - ADMIN_READ - - DATA_READ - - DATA_WRITE - - LOG_TYPE_UNSPECIFIED - exemptedMembers: + labels: description: >- - Specifies the identities that do not cause logging for this type of - permission. Follows the same format of Binding.members. - type: array - items: + A list of labels to apply for this resource. Each label must comply + with the requirements for labels. For example, "webserver-frontend": + "images". A label value can also be empty (e.g. "my-label": ""). + type: object + additionalProperties: type: string - GlobalSetPolicyRequest: - id: GlobalSetPolicyRequest - type: object - properties: - 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. - $ref: '#/components/schemas/Policy' - bindings: - description: >- - Flatten Policy to create a backward compatible wire-format. - Deprecated. Use 'policy' to specify bindings. - type: array - items: - $ref: '#/components/schemas/Binding' - etag: + labelFingerprint: description: >- - Flatten Policy to create a backward compatible wire-format. - Deprecated. Use 'policy' to specify the etag. + 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. type: string format: byte - TestPermissionsRequest: - id: TestPermissionsRequest - type: object - properties: - permissions: - description: >- - The set of permissions to check for the 'resource'. Permissions with - wildcards (such as '*' or 'storage.*') are not allowed. - type: array - items: - type: string - TestPermissionsResponse: - id: TestPermissionsResponse - type: object - properties: - permissions: - description: >- - A subset of `TestPermissionsRequest.permissions` that the caller is - allowed. - type: array - items: - type: string - ImageFamilyView: - id: ImageFamilyView - type: object - properties: - image: - description: >- - The latest image that is part of the specified image family in the - requested location, and that is not deprecated. - $ref: '#/components/schemas/Image' - SnapshotList: - id: SnapshotList - description: Contains a list of Snapshot resources. + AddressAggregatedList: + id: AddressAggregatedList type: object properties: kind: - description: Type of resource. - default: compute#snapshotList + description: >- + [Output Only] Type of resource. Always compute#addressAggregatedList + for aggregated lists of addresses. + default: compute#addressAggregatedList type: string id: description: >- @@ -3776,10 +2451,11 @@ components: server. type: string items: - description: A list of Snapshot resources. - type: array - items: - $ref: '#/components/schemas/Snapshot' + description: A list of AddressesScopedList resources. + type: object + additionalProperties: + description: '[Output Only] Name of the scope containing this set of addresses.' + $ref: '#/components/schemas/AddressesScopedList' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -3855,6 +2531,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -3898,6 +2577,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -3920,6 +2600,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -3956,284 +2637,239 @@ components: [Output Only] A warning data value corresponding to the key. type: string - Snapshot: - id: 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. + unreachables: + description: '[Output Only] Unreachable resources.' + type: array + items: + type: string + AddressesScopedList: + id: AddressesScopedList type: object properties: - kind: + addresses: + description: '[Output Only] A list of addresses contained in this scope.' + type: array + items: + $ref: '#/components/schemas/Address' + warning: description: >- - [Output Only] Type of the resource. Always compute#snapshot for - Snapshot resources. - default: compute#snapshot - type: string - id: - description: >- - [Output Only] The unique identifier for the resource. This - identifier is defined by the server. - type: string - format: uint64 - creationTimestamp: - description: '[Output Only] Creation timestamp in RFC3339 text format.' - type: string - name: + [Output Only] Informational warning which replaces the list of + addresses when the list is empty. + type: object + properties: + code: + description: >- + [Output Only] A warning code, if applicable. For example, + Compute Engine returns NO_RESULTS_ON_PAGE if there are no + results in the response. + type: string + enumDescriptions: + - >- + Warning about failed cleanup of transient changes made by a + failed operation. + - A link to a deprecated resource was created. + - >- + When deploying and at least one of the resources has a type + marked as deprecated + - The user created a boot disk that is larger than image size. + - >- + When deploying and at least one of the resources has a type + marked as experimental + - Warning that is present in an external api call + - >- + Warning that value of a field has been overridden. Deprecated + unused field. + - >- + The operation involved use of an injected kernel, which is + deprecated. + - >- + A WEIGHTED_MAGLEV backend service is associated with a health + check that is not of type HTTP/HTTPS/HTTP2. + - >- + When deploying a deployment with a exceedingly large number of + resources + - >- + Resource can't be retrieved due to list overhead quota exceed + which captures the amount of resources filtered out by + user-defined list filter. + - A resource depends on a missing type + - >- + The route's nextHopIp address is not assigned to an instance + on the network. + - The route's next hop instance cannot ip forward. + - >- + The route's nextHopInstance URL refers to an instance that + does not have an ipv6 interface on the same network as the + route. + - >- + The route's nextHopInstance URL refers to an instance that + does not exist. + - >- + The route's nextHopInstance URL refers to an instance that is + not on the same network as the route. + - >- + The route's next hop instance does not have a status of + RUNNING. + - >- + Error which is not critical. We decided to continue the + process despite the mentioned error. + - No results are present on a particular list page. + - >- + Success is reported, but some results may be missing due to + errors + - >- + Quota information is not available to client requests (e.g: + regions.list). + - >- + The user attempted to use a resource that requires a TOS they + have not accepted. + - Warning that a resource is in use. + - >- + One or more of the resources set to auto-delete could not be + deleted because they were in use. + - When a resource schema validation is ignored. + - >- + Instance template used in instance group manager is valid as + such, but its application does not make a lot of sense, + because it allows only single instance in instance group. + - When undeclared properties in the schema are present + - A given scope cannot be reached. + enumDeprecated: + - false + - false + - false + - false + - false + - false + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + enum: + - CLEANUP_FAILED + - DEPRECATED_RESOURCE_USED + - DEPRECATED_TYPE_USED + - DISK_SIZE_LARGER_THAN_IMAGE_SIZE + - EXPERIMENTAL_TYPE_USED + - EXTERNAL_API_WARNING + - FIELD_VALUE_OVERRIDEN + - INJECTED_KERNELS_DEPRECATED + - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB + - LARGE_DEPLOYMENT_WARNING + - LIST_OVERHEAD_QUOTA_EXCEED + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE + - NEXT_HOP_INSTANCE_NOT_FOUND + - NEXT_HOP_INSTANCE_NOT_ON_NETWORK + - NEXT_HOP_NOT_RUNNING + - NOT_CRITICAL_ERROR + - NO_RESULTS_ON_PAGE + - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE + - REQUIRED_TOS_AGREEMENT + - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING + - RESOURCE_NOT_DELETED + - SCHEMA_VALIDATION_IGNORED + - SINGLE_INSTANCE_PROPERTY_TEMPLATE + - UNDECLARED_PROPERTIES + - UNREACHABLE + message: + description: '[Output Only] A human-readable description of the warning code.' + type: string + data: + description: >- + [Output Only] Metadata about this warning in key: value format. + For example: "data": [ { "key": "scope", "value": + "zones/us-east1-d" } + type: array + items: + type: object + properties: + key: + description: >- + [Output Only] A key that provides more detail on the + warning being returned. For example, for warnings where + there are no results in a list request for a particular + zone, this key might be scope and the key value might be + the zone name. Other examples might be a key indicating a + deprecated resource and a suggested replacement, or a + warning about invalid network settings (for example, if an + instance attempts to perform IP forwarding but is not + enabled for IP forwarding). + type: string + value: + description: >- + [Output Only] A warning data value corresponding to the + key. + type: string + RegionAddressesMoveRequest: + id: RegionAddressesMoveRequest + type: object + properties: + destinationAddress: 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])?' - annotations: - required: - - compute.disks.createSnapshot - - compute.snapshots.insert + The URL of the destination address to move to. This can be a full or + partial URL. For example, the following are all valid URLs to a + address: - + https://www.googleapis.com/compute/v1/projects/project/regions/region + /addresses/address - + projects/project/regions/region/addresses/address Note that + destination project must be different from the source project. So + /regions/region/addresses/address is not valid partial url. type: string description: description: >- - An optional description of this resource. Provide this property when - you create the resource. - type: string - status: - description: >- - [Output Only] The status of the snapshot. This can be CREATING, - DELETING, FAILED, READY, or UPLOADING. - type: string - enumDescriptions: - - Snapshot creation is in progress. - - Snapshot is currently being deleted. - - Snapshot creation failed. - - Snapshot has been created successfully. - - Snapshot is being uploaded. - enum: - - CREATING - - DELETING - - FAILED - - READY - - UPLOADING - sourceDisk: - description: The source disk used to create this snapshot. - type: string - 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 - diskSizeGb: - description: '[Output Only] Size of the source disk, specified in GB.' - type: string - format: int64 - 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. - type: string - format: int64 - 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. - type: string - enumDescriptions: - - '' - - '' - enum: - - UPDATING - - UP_TO_DATE - 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). - type: array - items: - type: string - snapshotEncryptionKey: - 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. - $ref: '#/components/schemas/CustomerEncryptionKey' - sourceDiskEncryptionKey: - description: >- - The customer-supplied encryption key of the source disk. Required if - the source disk is protected by a customer-supplied encryption key. - $ref: '#/components/schemas/CustomerEncryptionKey' - selfLink: - description: '[Output Only] Server-defined URL for the resource.' + An optional destination address description if intended to be + different from the source. type: string + RegionSetLabelsRequest: + id: RegionSetLabelsRequest + type: object + properties: labels: - description: >- - Labels to apply to this snapshot. These can be later modified by the - setLabels method. Label values may be empty. + description: The labels to set for this resource. type: object additionalProperties: 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. + 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. type: string format: byte - licenseCodes: - description: >- - [Output Only] Integer license codes indicating which licenses are - attached to this snapshot. - type: array - items: - type: string - format: int64 - storageLocations: - description: >- - Cloud Storage bucket storage location of the snapshot (regional or - multi-regional). - type: array - items: - type: string - autoCreated: - description: >- - [Output Only] Set to true if snapshots are automatically created by - applying resource policy on the target disk. - type: boolean - guestOsFeatures: - description: >- - [Output Only] A list of features to enable on the guest operating - system. Applicable only for bootable images. Read Enabling guest - operating system features to see a list of available options. - type: array - items: - $ref: '#/components/schemas/GuestOsFeature' - downloadBytes: - description: >- - [Output Only] Number of bytes downloaded to restore a snapshot to a - disk. - type: string - format: int64 - 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 - satisfiesPzs: - description: '[Output Only] Reserved for future use.' - type: boolean - 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 - sourceSnapshotSchedulePolicy: - description: >- - [Output Only] URL of the resource policy which created this - scheduled snapshot. - type: string - sourceSnapshotSchedulePolicyId: - description: >- - [Output Only] ID of the resource policy which created this scheduled - snapshot. - type: string - sourceInstantSnapshot: - description: >- - The source instant snapshot used to create this snapshot. 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 - /instantSnapshots/instantSnapshot - - projects/project/zones/zone/instantSnapshots/instantSnapshot - - zones/zone/instantSnapshots/instantSnapshot - type: string - sourceInstantSnapshotId: - description: >- - [Output Only] The unique ID of the instant snapshot used to create - this snapshot. This value identifies the exact instant snapshot that - was used to create this persistent disk. For example, if you created - the persistent disk from an instant snapshot that was later deleted - and recreated under the same name, the source instant snapshot ID - would identify the exact instant snapshot that was used. - type: string - architecture: - description: >- - [Output Only] The architecture of the snapshot. Valid values are - ARM64 or X86_64. - type: string - enumDescriptions: - - Default value indicating Architecture is not set. - - Machines with architecture ARM64 - - Machines with architecture X86_64 - enum: - - ARCHITECTURE_UNSPECIFIED - - ARM64 - - X86_64 - snapshotType: - description: Indicates the type of the snapshot. - type: string - enumDescriptions: - - '' - - '' - enum: - - ARCHIVE - - STANDARD - creationSizeBytes: - description: '[Output Only] Size in bytes of the snapshot at creation time.' - type: string - format: int64 - enableConfidentialCompute: - description: >- - Whether this snapshot is created from a confidential compute mode - disk. [Output Only]: This field is not set by user, but from source - disk. - type: boolean - sourceDiskForRecoveryCheckpoint: - description: >- - The source disk whose recovery checkpoint will be used to create - this snapshot. - type: string - sourceInstantSnapshotEncryptionKey: - description: >- - Customer provided encryption key when creating Snapshot from Instant - Snapshot. - $ref: '#/components/schemas/CustomerEncryptionKey' - satisfiesPzi: - description: Output only. Reserved for future use. - readOnly: true - type: boolean - DiskList: - id: DiskList - description: A list of Disk resources. + ImageList: + id: ImageList + description: Contains a list of images. type: object properties: kind: - description: >- - [Output Only] Type of resource. Always compute#diskList for lists of - disks. - default: compute#diskList + description: Type of resource. + default: compute#imageList type: string id: description: >- @@ -4241,10 +2877,10 @@ components: server. type: string items: - description: A list of Disk resources. + description: A list of Image resources. type: array items: - $ref: '#/components/schemas/Disk' + $ref: '#/components/schemas/Image' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -4320,6 +2956,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -4363,6 +3002,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -4385,6 +3025,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -4421,23 +3062,16 @@ components: [Output Only] A warning data value corresponding to the key. type: string - Disk: - id: Disk + Image: + id: Image 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. + Represents an Image resource. You can use images to create boot disks + for your VM instances. For more information, read Images. type: object properties: kind: - description: '[Output Only] Type of the resource. Always compute#disk for disks.' - default: compute#disk + description: '[Output Only] Type of the resource. Always compute#image for images.' + default: compute#image type: string id: description: >- @@ -4450,7 +3084,7 @@ components: type: string name: description: >- - Name of the resource. Provided by the client when the resource is + 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 @@ -4460,363 +3094,235 @@ components: pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' annotations: required: - - compute.disks.insert + - compute.images.insert type: string description: description: >- An optional description of this resource. Provide this property when you create the 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 greater than 0. - type: string - format: int64 - 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 - status: + sourceType: 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. + The type of the image used to create this disk. The default and only + valid value is RAW. + default: RAW type: string enumDescriptions: - - Disk is provisioning - - Disk is deleting. - - Disk creation failed. - - Disk is ready for use. - - Source data is being copied into the disk. - - >- - Disk is currently unavailable and cannot be accessed, attached or - detached. + - '' enum: - - CREATING - - DELETING - - FAILED - - READY - - RESTORING - - UNAVAILABLE - 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 - sourceSnapshotId: + - RAW + rawDisk: + description: The parameters of the raw disk image. + type: object + properties: + 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 + 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}' + deprecated: true + type: string + 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. + type: string + enumDescriptions: + - '' + enum: + - TAR + deprecated: + description: The deprecation status associated with this image. + $ref: '#/components/schemas/DeprecationStatus' + status: 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. + [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. type: string - sourceStorageObject: + enumDescriptions: + - Image is deleting. + - Image creation failed due to an error. + - Image hasn't been created as yet. + - Image has been successfully created. + enum: + - DELETING + - FAILED + - PENDING + - READY + archiveSizeBytes: 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 - options: - description: Internal use only. - type: string - selfLink: - description: '[Output Only] Server-defined fully-qualified URL for this resource.' + Size of the image tar.gz archive stored in Google Cloud Storage (in + bytes). 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 + format: int64 + diskSizeGb: + description: Size of the image when restored onto a persistent disk (in GB). type: string - sourceImageId: + format: int64 + sourceDisk: 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. + 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 - type: + sourceDiskId: 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. + [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 licenses: - description: A list of publicly visible licenses. Reserved for Google's use. + description: Any applicable license URI. type: array items: type: string - guestOsFeatures: + family: 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. - type: array - items: - $ref: '#/components/schemas/GuestOsFeature' - lastAttachTimestamp: - description: '[Output Only] Last attach timestamp in RFC3339 text format.' - type: string - lastDetachTimestamp: - description: '[Output Only] Last detach timestamp in RFC3339 text format.' + The name of the image family to which this image belongs. The image + family name can be from a publicly managed image family provided by + Compute Engine, or from a custom image family you create. For + example, centos-stream-9 is a publicly available image family. For + more information, see Image family best practices. When creating + disks, you can specify an image family instead of a specific image + name. The image family always returns its latest image that is not + deprecated. The name of the image family must comply with RFC1035. type: string - users: - description: >- - [Output Only] Links to the users of the disk (attached instances) in - form: projects/project/zones/zone/instances/instance - type: array - items: - type: string - diskEncryptionKey: - 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. - $ref: '#/components/schemas/CustomerEncryptionKey' - sourceImageEncryptionKey: + imageEncryptionKey: description: >- - The customer-supplied encryption key of the source image. Required - if the source image is protected by a customer-supplied encryption - key. + 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. $ref: '#/components/schemas/CustomerEncryptionKey' - sourceSnapshotEncryptionKey: + sourceDiskEncryptionKey: description: >- - The customer-supplied encryption key of the source snapshot. - Required if the source snapshot is protected by a customer-supplied - encryption key. + The customer-supplied encryption key of the source disk. Required if + the source disk is protected by a customer-supplied encryption key. $ref: '#/components/schemas/CustomerEncryptionKey' + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string labels: description: >- - Labels to apply to this disk. These can be later modified by the + Labels to apply to this image. These can be later modified by the setLabels method. type: object additionalProperties: 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 + 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 a disk. + to retrieve an image. type: string format: byte - 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: + guestOsFeatures: description: >- - URLs of the zones where the disk should be replicated to. Only - applicable for regional resources. + A list of features to enable on the guest operating system. + Applicable only for bootable images. To see a list of available + options, see the guestOSfeatures[].type parameter. type: array items: - type: string + $ref: '#/components/schemas/GuestOsFeature' licenseCodes: description: >- Integer license codes indicating which licenses are attached to this - disk. + image. type: array items: type: string format: int64 - physicalBlockSizeBytes: + sourceImage: 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. + 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 - format: int64 - resourcePolicies: - description: >- - Resource policies applied to this disk for automatic snapshot - creations. - type: array - items: - type: string - sourceDisk: + sourceImageId: 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 + [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 - sourceDiskId: + sourceImageEncryptionKey: 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 - provisionedIops: + The customer-supplied encryption key of the source image. Required + if the source image is protected by a customer-supplied encryption + key. + $ref: '#/components/schemas/CustomerEncryptionKey' + sourceSnapshot: 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. + 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 - format: int64 - provisionedThroughput: + sourceSnapshotId: description: >- - Indicates how much throughput to provision for the disk. This sets - the number of throughput mb per second that the disk can handle. - Values must be greater than or equal to 1. + [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 - format: int64 - enableConfidentialCompute: - description: Whether this disk is using confidential compute mode. - type: boolean - sourceInstantSnapshot: + sourceSnapshotEncryptionKey: description: >- - The source instant 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/zones/zone - /instantSnapshots/instantSnapshot - - projects/project/zones/zone/instantSnapshots/instantSnapshot - - zones/zone/instantSnapshots/instantSnapshot - type: string - sourceInstantSnapshotId: + The customer-supplied encryption key of the source snapshot. + Required if the source snapshot is protected by a customer-supplied + encryption key. + $ref: '#/components/schemas/CustomerEncryptionKey' + storageLocations: description: >- - [Output Only] The unique ID of the instant snapshot used to create - this disk. This value identifies the exact instant snapshot that was - used to create this persistent disk. For example, if you created the - persistent disk from an instant snapshot that was later deleted and - recreated under the same name, the source instant snapshot ID would - identify the exact version of the instant snapshot that was used. - type: string + Cloud Storage bucket storage location of the image (regional or + multi-regional). + type: array + items: + type: string + shieldedInstanceInitialState: + description: Set the secure boot keys of shielded instance. + $ref: '#/components/schemas/InitialStateConfig' satisfiesPzs: description: '[Output Only] Reserved for future use.' type: boolean - satisfiesPzi: - description: Output only. Reserved for future use. - readOnly: true - type: boolean - 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 - storagePool: - description: >- - The storage pool in which the new disk is created. 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 - /storagePools/storagePool - - projects/project/zones/zone/storagePools/storagePool - - zones/zone/storagePools/storagePool - type: string - accessMode: - description: >- - The access mode of the disk. - READ_WRITE_SINGLE: The default - AccessMode, means the disk can be attached to single instance in RW - mode. - READ_WRITE_MANY: The AccessMode means the disk can be - attached to multiple instances in RW mode. - READ_ONLY_MANY: The - AccessMode means the disk can be attached to multiple instances in - RO mode. The AccessMode is only valid for Hyperdisk disk types. - type: string - enumDescriptions: - - >- - The AccessMode means the disk can be attached to multiple - instances in RO mode. - - >- - The AccessMode means the disk can be attached to multiple - instances in RW mode. - - >- - The default AccessMode, means the disk can be attached to single - instance in RW mode. - enum: - - READ_ONLY_MANY - - READ_WRITE_MANY - - READ_WRITE_SINGLE - asyncPrimaryDisk: - description: Disk asynchronously replicated into this disk. - $ref: '#/components/schemas/DiskAsyncReplication' - asyncSecondaryDisks: - description: >- - [Output Only] A list of disks this disk is asynchronously replicated - to. - type: object - additionalProperties: - $ref: '#/components/schemas/DiskAsyncReplicationList' - resourceStatus: - description: '[Output Only] Status information for the disk resource.' - $ref: '#/components/schemas/DiskResourceStatus' - sourceConsistencyGroupPolicy: - description: >- - [Output Only] URL of the DiskConsistencyGroupPolicy for a secondary - disk that was created using a consistency group. - type: string - sourceConsistencyGroupPolicyId: - description: >- - [Output Only] ID of the DiskConsistencyGroupPolicy for a secondary - disk that was created using a consistency group. - type: string architecture: - description: The architecture of the disk. Valid values are ARM64 or X86_64. + description: The architecture of the image. Valid values are ARM64 or X86_64. type: string enumDescriptions: - Default value indicating Architecture is not set. @@ -4826,103 +3332,504 @@ components: - ARCHITECTURE_UNSPECIFIED - ARM64 - X86_64 - params: + enableConfidentialCompute: description: >- - Input only. [Input Only] Additional params passed with the request, - but not persisted as part of resource payload. - $ref: '#/components/schemas/DiskParams' - DiskAsyncReplication: - id: DiskAsyncReplication + Whether this image is created from a confidential compute mode disk. + [Output Only]: This field is not set by user, but from source disk. + type: boolean + satisfiesPzi: + description: Output only. Reserved for future use. + readOnly: true + type: boolean + CustomerEncryptionKey: + id: CustomerEncryptionKey type: object properties: - disk: + rawKey: description: >- - The other disk asynchronously replicated to or from the current - 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 - projects/project/zones/zone/disks/disk - - zones/zone/disks/disk + 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 - diskId: + rsaEncryptedKey: description: >- - [Output Only] The unique ID of the other disk asynchronously - replicated to or from the current disk. This value identifies the - exact disk that was used to create this replication. For example, if - you started replicating the persistent disk from a disk that was - later deleted and recreated under the same name, the disk ID would - identify the exact version of the disk that was used. + 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 - consistencyGroupPolicy: + kmsKeyName: description: >- - [Output Only] URL of the DiskConsistencyGroupPolicy if replication - was started on the disk as a member of a group. + 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 The fully-qualifed key name may be + returned for resource GET requests. For example: "kmsKeyName": + "projects/kms_project_id/locations/region/keyRings/ + key_region/cryptoKeys/key /cryptoKeyVersions/1 type: string - consistencyGroupPolicyId: + sha256: description: >- - [Output Only] ID of the DiskConsistencyGroupPolicy if replication - was started on the disk as a member of a group. + [Output only] The RFC 4648 base64 encoded SHA-256 hash of the + customer-supplied encryption key that protects this resource. type: string - DiskAsyncReplicationList: - id: DiskAsyncReplicationList - type: object - properties: - asyncReplicationDisk: - $ref: '#/components/schemas/DiskAsyncReplication' - DiskResourceStatus: - id: DiskResourceStatus - type: object - properties: - asyncPrimaryDisk: - $ref: '#/components/schemas/DiskResourceStatusAsyncReplicationStatus' - asyncSecondaryDisks: - description: 'Key: disk, value: AsyncReplicationStatus message' - type: object - additionalProperties: - $ref: '#/components/schemas/DiskResourceStatusAsyncReplicationStatus' - DiskResourceStatusAsyncReplicationStatus: - id: DiskResourceStatusAsyncReplicationStatus + 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 + GuestOsFeature: + id: GuestOsFeature + description: Guest OS features. type: object properties: - state: - type: string - enumDescriptions: - - Replication is active. - - Secondary disk is created and is waiting for replication to start. - - Replication is starting. + type: + description: >- + The ID of a supported feature. To add multiple values, use commas to + separate values. Set to one or more of the following values: - + VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE + - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - + SEV_LIVE_MIGRATABLE_V2 - SEV_SNP_CAPABLE - TDX_CAPABLE - IDPF - + SNP_SVSM_CAPABLE For more information, see Enabling guest operating + system features. + type: string + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' - '' - - Replication is stopped. - - Replication is stopping. enum: - - ACTIVE - - CREATED - - STARTING - - STATE_UNSPECIFIED - - STOPPED - - STOPPING - DiskParams: - id: DiskParams - description: Additional disk params. + - BARE_METAL_LINUX_COMPATIBLE + - FEATURE_TYPE_UNSPECIFIED + - GVNIC + - IDPF + - MULTI_IP_SUBNET + - SECURE_BOOT + - SEV_CAPABLE + - SEV_LIVE_MIGRATABLE + - SEV_LIVE_MIGRATABLE_V2 + - SEV_SNP_CAPABLE + - SNP_SVSM_CAPABLE + - TDX_CAPABLE + - UEFI_COMPATIBLE + - VIRTIO_SCSI_MULTIQUEUE + - WINDOWS + InitialStateConfig: + id: InitialStateConfig + description: >- + Initial State for shielded instance, these are public keys which are + safe to store in public type: object properties: - resourceManagerTags: + pk: + description: The Platform Key (PK). + $ref: '#/components/schemas/FileContentBuffer' + keks: + description: The Key Exchange Key (KEK). + type: array + items: + $ref: '#/components/schemas/FileContentBuffer' + dbs: + description: The Key Database (db). + type: array + items: + $ref: '#/components/schemas/FileContentBuffer' + dbxs: + description: The forbidden key database (dbx). + type: array + items: + $ref: '#/components/schemas/FileContentBuffer' + FileContentBuffer: + id: FileContentBuffer + type: object + properties: + content: + description: The raw content in the secure keys file. + type: string + format: byte + fileType: + description: The file type of source file. + type: string + enumDescriptions: + - '' + - '' + - '' + enum: + - BIN + - UNDEFINED + - X509 + Policy: + id: Policy + description: >- + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. A `Policy` is a collection of + `bindings`. A `binding` binds one or more `members`, or principals, to a + single `role`. Principals can be user accounts, service accounts, Google + groups, and domains (such as G Suite). A `role` is a named list of + permissions; each `role` can be an IAM predefined role or a user-created + custom role. For some types of Google Cloud resources, a `binding` can + also specify a `condition`, which is a logical expression that allows + access to a resource only if the expression evaluates to `true`. A + condition can add constraints based on attributes of the request, the + resource, or both. To learn which resources support conditions in their + IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + **JSON example:** ``` { "bindings": [ { "role": + "roles/resourcemanager.organizationAdmin", "members": [ + "user:mike@example.com", "group:admins@example.com", + "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { + "role": "roles/resourcemanager.organizationViewer", "members": [ + "user:eve@example.com" ], "condition": { "title": "expirable access", + "description": "Does not grant access after Sep 2020", "expression": + "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": + "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - + members: - user:mike@example.com - group:admins@example.com - + domain:google.com - + serviceAccount:my-project-id@appspot.gserviceaccount.com role: + roles/resourcemanager.organizationAdmin - members: - + user:eve@example.com role: roles/resourcemanager.organizationViewer + condition: title: expirable access description: Does not grant access + after Sep 2020 expression: request.time < + timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` + For a description of IAM and its features, see the [IAM + documentation](https://cloud.google.com/iam/docs/). + type: object + properties: + version: description: >- - Resource manager tags to be bound to the disk. Tag keys and values - have the same definition as resource manager tags. Keys must be in - the format `tagKeys/{tag_key_id}`, and values are in the format - `tagValues/456`. The field is ignored (both PUT & PATCH) when empty. - type: object - additionalProperties: + 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). + type: integer + format: int32 + bindings: + description: >- + Associates a list of `members`, or principals, with a `role`. + Optionally, may specify a `condition` that determines how and when + the `bindings` are applied. Each of the `bindings` must contain at + least one principal. The `bindings` in a `Policy` can refer to up to + 1,500 principals; up to 250 of these principals can be Google + groups. Each occurrence of a principal counts towards these limits. + For example, if the `bindings` grant 50 different roles to + `user:alice@example.com`, and not to any other principal, then you + can add another 1,450 principals to the `bindings` in the `Policy`. + type: array + items: + $ref: '#/components/schemas/Binding' + auditConfigs: + description: Specifies cloud audit logging configuration for this policy. + type: array + items: + $ref: '#/components/schemas/AuditConfig' + 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. + type: string + format: byte + Binding: + id: Binding + description: Associates `members`, or principals, with a `role`. + type: object + properties: + role: + description: >- + Role that is assigned to the list of `members`, or principals. For + example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an + overview of the IAM roles and permissions, see the [IAM + documentation](https://cloud.google.com/iam/docs/roles-overview). + For a list of the available pre-defined roles, see + [here](https://cloud.google.com/iam/docs/understanding-roles). + type: string + members: + description: >- + Specifies the principals requesting access for a Google Cloud + 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. Does not include identities + that come from external identity providers (IdPs) through identity + federation. * `user:{emailid}`: An email address that represents a + specific Google account. For example, `alice@example.com` . * + `serviceAccount:{emailid}`: An email address that represents a + Google service account. For example, + `my-other-app@appspot.gserviceaccount.com`. * + `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: + An identifier for a [Kubernetes service + account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). + For example, + `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * + `group:{emailid}`: An email address that represents a Google group. + For example, `admins@example.com`. * `domain:{domain}`: The G Suite + domain (primary) that represents all the users of that domain. For + example, `google.com` or `example.com`. * + `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workforce identity pool. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: + All workforce identities in a group. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All workforce identities with a specific attribute value. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: + All identities in a workforce identity pool. * + `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workload identity pool. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: + A workload identity pool group. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All identities in a workload identity pool with a certain attribute. + * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: + All identities in a workload identity pool. * + `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. * + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + Deleted single identity in a workforce identity pool. For example, + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + type: array + items: type: string - DiskAggregatedList: - id: DiskAggregatedList + condition: + description: >- + The condition that is associated with this binding. If the condition + evaluates to `true`, then this binding applies to the current + request. If the condition evaluates to `false`, then this binding + does not apply to the current request. However, a different role + binding might grant the same role to one or more of the principals + in this binding. To learn which resources support conditions in + their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + $ref: '#/components/schemas/Expr' + Expr: + id: 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. type: object properties: - kind: + expression: description: >- - [Output Only] Type of resource. Always compute#diskAggregatedList - for aggregated lists of persistent disks. - default: compute#diskAggregatedList + Textual representation of an expression in Common Expression + Language syntax. + 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 + 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 + 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 + AuditConfig: + id: 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. + type: object + properties: + 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 + auditLogConfigs: + description: The configuration for logging of each type of permission. + type: array + items: + $ref: '#/components/schemas/AuditLogConfig' + AuditLogConfig: + id: 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. + type: object + properties: + logType: + description: The log type that this config enables. + type: string + enumDescriptions: + - 'Admin reads. Example: CloudIAM getIamPolicy' + - 'Data reads. Example: CloudSQL Users list' + - 'Data writes. Example: CloudSQL Users create' + - Default case. Should never be this. + enum: + - ADMIN_READ + - DATA_READ + - DATA_WRITE + - LOG_TYPE_UNSPECIFIED + exemptedMembers: + description: >- + Specifies the identities that do not cause logging for this type of + permission. Follows the same format of Binding.members. + type: array + items: + type: string + GlobalSetPolicyRequest: + id: GlobalSetPolicyRequest + type: object + properties: + 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. + $ref: '#/components/schemas/Policy' + bindings: + description: >- + Flatten Policy to create a backward compatible wire-format. + Deprecated. Use 'policy' to specify bindings. + type: array + items: + $ref: '#/components/schemas/Binding' + etag: + description: >- + Flatten Policy to create a backward compatible wire-format. + Deprecated. Use 'policy' to specify the etag. + type: string + format: byte + TestPermissionsRequest: + id: TestPermissionsRequest + type: object + properties: + permissions: + description: >- + The set of permissions to check for the 'resource'. Permissions with + wildcards (such as '*' or 'storage.*') are not allowed. + type: array + items: + type: string + TestPermissionsResponse: + id: TestPermissionsResponse + type: object + properties: + permissions: + description: >- + A subset of `TestPermissionsRequest.permissions` that the caller is + allowed. + type: array + items: + type: string + ImageFamilyView: + id: ImageFamilyView + type: object + properties: + image: + description: >- + The latest image that is part of the specified image family in the + requested location, and that is not deprecated. + $ref: '#/components/schemas/Image' + SnapshotList: + id: SnapshotList + description: Contains a list of Snapshot resources. + type: object + properties: + kind: + description: Type of resource. + default: compute#snapshotList type: string id: description: >- @@ -4930,11 +3837,10 @@ components: server. type: string items: - description: A list of DisksScopedList resources. - type: object - additionalProperties: - description: '[Output Only] Name of the scope containing this set of disks.' - $ref: '#/components/schemas/DisksScopedList' + description: A list of Snapshot resources. + type: array + items: + $ref: '#/components/schemas/Snapshot' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -5010,6 +3916,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -5053,6 +3962,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -5075,6 +3985,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -5111,59 +4022,348 @@ components: [Output Only] A warning data value corresponding to the key. type: string - unreachables: - description: '[Output Only] Unreachable resources.' - type: array - items: - type: string - DisksScopedList: - id: DisksScopedList + Snapshot: + id: 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. LINT.IfChange type: object properties: - disks: - description: '[Output Only] A list of disks contained in this scope.' - type: array - items: - $ref: '#/components/schemas/Disk' - warning: + kind: description: >- - [Output Only] Informational warning which replaces the list of disks - when the list is empty. - type: object - properties: - code: - description: >- - [Output Only] A warning code, if applicable. For example, - Compute Engine returns NO_RESULTS_ON_PAGE if there are no - results in the response. - type: string - enumDescriptions: - - >- - Warning about failed cleanup of transient changes made by a - failed operation. - - A link to a deprecated resource was created. - - >- - When deploying and at least one of the resources has a type - marked as deprecated - - The user created a boot disk that is larger than image size. - - >- - When deploying and at least one of the resources has a type - marked as experimental - - Warning that is present in an external api call - - >- - Warning that value of a field has been overridden. Deprecated - unused field. - - >- - The operation involved use of an injected kernel, which is - deprecated. - - >- - A WEIGHTED_MAGLEV backend service is associated with a health - check that is not of type HTTP/HTTPS/HTTP2. - - >- - When deploying a deployment with a exceedingly large number of - resources - - >- - Resource can't be retrieved due to list overhead quota exceed + [Output Only] Type of the resource. Always compute#snapshot for + Snapshot resources. + default: compute#snapshot + type: string + id: + description: >- + [Output Only] The unique identifier for the resource. This + identifier is defined by the server. + type: string + format: uint64 + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + 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])?' + annotations: + required: + - compute.disks.createSnapshot + - compute.snapshots.insert + type: string + description: + description: >- + An optional description of this resource. Provide this property when + you create the resource. + type: string + status: + description: >- + [Output Only] The status of the snapshot. This can be CREATING, + DELETING, FAILED, READY, or UPLOADING. + type: string + enumDescriptions: + - Snapshot creation is in progress. + - Snapshot is currently being deleted. + - Snapshot creation failed. + - Snapshot has been created successfully. + - Snapshot is being uploaded. + enum: + - CREATING + - DELETING + - FAILED + - READY + - UPLOADING + sourceDisk: + description: The source disk used to create this snapshot. + type: string + 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 + diskSizeGb: + description: '[Output Only] Size of the source disk, specified in GB.' + type: string + format: int64 + 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. + type: string + format: int64 + 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. + type: string + enumDescriptions: + - '' + - '' + enum: + - UPDATING + - UP_TO_DATE + 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). + type: array + items: + type: string + snapshotEncryptionKey: + 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. + $ref: '#/components/schemas/CustomerEncryptionKey' + sourceDiskEncryptionKey: + description: >- + The customer-supplied encryption key of the source disk. Required if + the source disk is protected by a customer-supplied encryption key. + $ref: '#/components/schemas/CustomerEncryptionKey' + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + labels: + description: >- + Labels to apply to this snapshot. These can be later modified by the + setLabels method. Label values may be empty. + type: object + additionalProperties: + 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. + type: string + format: byte + licenseCodes: + description: >- + [Output Only] Integer license codes indicating which licenses are + attached to this snapshot. + type: array + items: + type: string + format: int64 + storageLocations: + description: >- + Cloud Storage bucket storage location of the snapshot (regional or + multi-regional). + type: array + items: + type: string + autoCreated: + description: >- + [Output Only] Set to true if snapshots are automatically created by + applying resource policy on the target disk. + type: boolean + guestOsFeatures: + description: >- + [Output Only] A list of features to enable on the guest operating + system. Applicable only for bootable images. Read Enabling guest + operating system features to see a list of available options. + type: array + items: + $ref: '#/components/schemas/GuestOsFeature' + downloadBytes: + description: >- + [Output Only] Number of bytes downloaded to restore a snapshot to a + disk. + type: string + format: int64 + 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 + satisfiesPzs: + description: '[Output Only] Reserved for future use.' + type: boolean + guestFlush: + description: >- + [Input Only] Whether to attempt an application consistent snapshot + by informing the OS to prepare for the snapshot process. + type: boolean + 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 + sourceSnapshotSchedulePolicy: + description: >- + [Output Only] URL of the resource policy which created this + scheduled snapshot. + type: string + sourceSnapshotSchedulePolicyId: + description: >- + [Output Only] ID of the resource policy which created this scheduled + snapshot. + type: string + sourceInstantSnapshot: + description: >- + The source instant snapshot used to create this snapshot. 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 + /instantSnapshots/instantSnapshot - + projects/project/zones/zone/instantSnapshots/instantSnapshot - + zones/zone/instantSnapshots/instantSnapshot + type: string + sourceInstantSnapshotId: + description: >- + [Output Only] The unique ID of the instant snapshot used to create + this snapshot. This value identifies the exact instant snapshot that + was used to create this snapshot. For example, if you created the + snapshot from an instant snapshot that was later deleted and + recreated under the same name, the source instant snapshot ID would + identify the exact instant snapshot that was used. + type: string + architecture: + description: >- + [Output Only] The architecture of the snapshot. Valid values are + ARM64 or X86_64. + type: string + enumDescriptions: + - Default value indicating Architecture is not set. + - Machines with architecture ARM64 + - Machines with architecture X86_64 + enum: + - ARCHITECTURE_UNSPECIFIED + - ARM64 + - X86_64 + snapshotType: + description: Indicates the type of the snapshot. + type: string + enumDescriptions: + - '' + - '' + enum: + - ARCHIVE + - STANDARD + creationSizeBytes: + description: '[Output Only] Size in bytes of the snapshot at creation time.' + type: string + format: int64 + enableConfidentialCompute: + description: >- + Whether this snapshot is created from a confidential compute mode + disk. [Output Only]: This field is not set by user, but from source + disk. + type: boolean + sourceDiskForRecoveryCheckpoint: + description: >- + The source disk whose recovery checkpoint will be used to create + this snapshot. + type: string + sourceInstantSnapshotEncryptionKey: + description: >- + Customer provided encryption key when creating Snapshot from Instant + Snapshot. + $ref: '#/components/schemas/CustomerEncryptionKey' + satisfiesPzi: + description: Output only. Reserved for future use. + readOnly: true + type: boolean + DiskList: + id: DiskList + description: A list of Disk resources. + type: object + properties: + kind: + description: >- + [Output Only] Type of resource. Always compute#diskList for lists of + disks. + default: compute#diskList + type: string + id: + description: >- + [Output Only] Unique identifier for the resource; defined by the + server. + type: string + items: + description: A list of Disk resources. + type: array + items: + $ref: '#/components/schemas/Disk' + nextPageToken: + description: >- + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. + type: string + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string + warning: + description: '[Output Only] Informational warning message.' + type: object + properties: + code: + description: >- + [Output Only] A warning code, if applicable. For example, + Compute Engine returns NO_RESULTS_ON_PAGE if there are no + results in the response. + type: string + enumDescriptions: + - >- + Warning about failed cleanup of transient changes made by a + failed operation. + - A link to a deprecated resource was created. + - >- + When deploying and at least one of the resources has a type + marked as deprecated + - The user created a boot disk that is larger than image size. + - >- + When deploying and at least one of the resources has a type + marked as experimental + - Warning that is present in an external api call + - >- + Warning that value of a field has been overridden. Deprecated + unused field. + - >- + The operation involved use of an injected kernel, which is + deprecated. + - >- + A WEIGHTED_MAGLEV backend service is associated with a health + check that is not of type HTTP/HTTPS/HTTP2. + - >- + When deploying a deployment with a exceedingly large number of + resources + - >- + Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter. - A resource depends on a missing type @@ -5191,6 +4391,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -5234,6 +4437,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -5256,6 +4460,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -5292,188 +4497,278 @@ components: [Output Only] A warning data value corresponding to the key. type: string - ZoneSetLabelsRequest: - id: ZoneSetLabelsRequest - type: object - properties: - labels: - description: The labels to set for this resource. - type: object - additionalProperties: - type: string - 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. - type: string - format: byte - DisksResizeRequest: - id: DisksResizeRequest + Disk: + id: 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. type: object properties: - sizeGb: - description: The new size of the persistent disk, which is specified in GB. + kind: + description: '[Output Only] Type of the resource. Always compute#disk for disks.' + default: compute#disk type: string - format: int64 - DisksAddResourcePoliciesRequest: - id: DisksAddResourcePoliciesRequest - type: object - properties: - resourcePolicies: - description: >- - Full or relative path to the resource policy to be added to this - disk. You can only specify one resource policy. - type: array - items: - type: string - DisksRemoveResourcePoliciesRequest: - id: DisksRemoveResourcePoliciesRequest - type: object - properties: - resourcePolicies: - description: Resource policies to be removed from this disk. - type: array - items: - type: string - ZoneSetPolicyRequest: - id: ZoneSetPolicyRequest - type: object - properties: - 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. - $ref: '#/components/schemas/Policy' - bindings: - description: >- - Flatten Policy to create a backwacd compatible wire-format. - Deprecated. Use 'policy' to specify bindings. - type: array - items: - $ref: '#/components/schemas/Binding' - etag: + id: description: >- - Flatten Policy to create a backward compatible wire-format. - Deprecated. Use 'policy' to specify the etag. + [Output Only] The unique identifier for the resource. This + identifier is defined by the server. type: string - format: byte - DisksStartAsyncReplicationRequest: - id: DisksStartAsyncReplicationRequest - type: object - properties: - asyncSecondaryDisk: - description: >- - The secondary disk to start asynchronous replication to. 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 + format: uint64 + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' type: string - DisksStopGroupAsyncReplicationResource: - id: DisksStopGroupAsyncReplicationResource - description: >- - A transient resource used in compute.disks.stopGroupAsyncReplication and - compute.regionDisks.stopGroupAsyncReplication. It is only used to - process requests and is not persisted. - type: object - properties: - resourcePolicy: + name: description: >- - The URL of the DiskConsistencyGroupPolicy for the group of disks to - stop. This may be a full or partial URL, such as: - - https://www.googleapis.com/compute/v1/projects/project/regions/region - /resourcePolicies/resourcePolicy - - projects/project/regions/region/resourcePolicies/resourcePolicy - - regions/region/resourcePolicies/resourcePolicy + 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])?' + annotations: + required: + - compute.disks.insert type: string - BulkInsertDiskResource: - id: BulkInsertDiskResource - description: >- - A transient resource used in compute.disks.bulkInsert and - compute.regionDisks.bulkInsert. It is only used to process requests and - is not persisted. - type: object - properties: - sourceConsistencyGroupPolicy: + description: description: >- - The URL of the DiskConsistencyGroupPolicy for the group of disks to - clone. This may be a full or partial URL, such as: - - https://www.googleapis.com/compute/v1/projects/project/regions/region - /resourcePolicies/resourcePolicy - - projects/project/regions/region/resourcePolicies/resourcePolicy - - regions/region/resourcePolicies/resourcePolicy + An optional description of this resource. Provide this property when + you create the resource. type: string - RegionDisksResizeRequest: - id: RegionDisksResizeRequest - type: object - properties: sizeGb: description: >- - The new size of the regional persistent disk, which is specified in - GB. + 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 greater than 0. type: string format: int64 - RegionDisksAddResourcePoliciesRequest: - id: RegionDisksAddResourcePoliciesRequest - type: object - properties: - resourcePolicies: - description: Resource policies to be added to this disk. - type: array - items: - type: string - RegionDisksRemoveResourcePoliciesRequest: - id: RegionDisksRemoveResourcePoliciesRequest - type: object - properties: - resourcePolicies: - description: Resource policies to be removed from this disk. - type: array - items: - type: string - RegionSetPolicyRequest: - id: RegionSetPolicyRequest - type: object - properties: - policy: + zone: 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. - $ref: '#/components/schemas/Policy' - bindings: + [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 + status: description: >- - Flatten Policy to create a backwacd compatible wire-format. - Deprecated. Use 'policy' to specify bindings. + [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. + type: string + enumDescriptions: + - Disk is provisioning + - Disk is deleting. + - Disk creation failed. + - Disk is ready for use. + - Source data is being copied into the disk. + - >- + Disk is currently unavailable and cannot be accessed, attached or + detached. + enum: + - CREATING + - DELETING + - FAILED + - READY + - RESTORING + - UNAVAILABLE + 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 + 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 + options: + description: Internal use only. + type: string + selfLink: + description: '[Output Only] Server-defined fully-qualified URL for this resource.' + 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 + 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 + 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 + licenses: + description: A list of publicly visible licenses. Reserved for Google's use. type: array items: - $ref: '#/components/schemas/Binding' - etag: + type: string + guestOsFeatures: description: >- - Flatten Policy to create a backward compatible wire-format. - Deprecated. Use 'policy' to specify the etag. + 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. + type: array + items: + $ref: '#/components/schemas/GuestOsFeature' + 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 + users: + description: >- + [Output Only] Links to the users of the disk (attached instances) in + form: projects/project/zones/zone/instances/instance + type: array + items: + type: string + diskEncryptionKey: + 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. + $ref: '#/components/schemas/CustomerEncryptionKey' + sourceImageEncryptionKey: + description: >- + The customer-supplied encryption key of the source image. Required + if the source image is protected by a customer-supplied encryption + key. + $ref: '#/components/schemas/CustomerEncryptionKey' + sourceSnapshotEncryptionKey: + description: >- + The customer-supplied encryption key of the source snapshot. + Required if the source snapshot is protected by a customer-supplied + encryption key. + $ref: '#/components/schemas/CustomerEncryptionKey' + labels: + description: >- + Labels to apply to this disk. These can be later modified by the + setLabels method. + type: object + additionalProperties: + 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. type: string format: byte - RegionDisksStartAsyncReplicationRequest: - id: RegionDisksStartAsyncReplicationRequest - type: object - properties: - asyncSecondaryDisk: + region: description: >- - The secondary disk to start asynchronous replication to. You can - provide this as a partial or full URL to the resource. For example, - the following are valid values: - + [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. + type: array + items: + type: string + licenseCodes: + description: >- + Integer license codes indicating which licenses are attached to this + disk. + type: array + items: + type: string + format: int64 + 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. + type: string + format: int64 + resourcePolicies: + description: >- + Resource policies applied to this disk for automatic snapshot + creations. + type: array + items: + 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 @@ -5481,16 +4776,229 @@ components: projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk type: string - FirewallList: - id: FirewallList - description: Contains a list of firewalls. + 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 + 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. + type: string + format: int64 + provisionedThroughput: + description: >- + Indicates how much throughput to provision for the disk. This sets + the number of throughput mb per second that the disk can handle. + Values must be greater than or equal to 1. + type: string + format: int64 + enableConfidentialCompute: + description: Whether this disk is using confidential compute mode. + type: boolean + sourceInstantSnapshot: + description: >- + The source instant 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/zones/zone + /instantSnapshots/instantSnapshot - + projects/project/zones/zone/instantSnapshots/instantSnapshot - + zones/zone/instantSnapshots/instantSnapshot + type: string + sourceInstantSnapshotId: + description: >- + [Output Only] The unique ID of the instant snapshot used to create + this disk. This value identifies the exact instant snapshot that was + used to create this persistent disk. For example, if you created the + persistent disk from an instant snapshot that was later deleted and + recreated under the same name, the source instant snapshot ID would + identify the exact version of the instant snapshot that was used. + type: string + satisfiesPzs: + description: '[Output Only] Reserved for future use.' + type: boolean + satisfiesPzi: + description: Output only. Reserved for future use. + readOnly: true + type: boolean + 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 + storagePool: + description: >- + The storage pool in which the new disk is created. 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 + /storagePools/storagePool - + projects/project/zones/zone/storagePools/storagePool - + zones/zone/storagePools/storagePool + type: string + accessMode: + description: >- + The access mode of the disk. - READ_WRITE_SINGLE: The default + AccessMode, means the disk can be attached to single instance in RW + mode. - READ_WRITE_MANY: The AccessMode means the disk can be + attached to multiple instances in RW mode. - READ_ONLY_MANY: The + AccessMode means the disk can be attached to multiple instances in + RO mode. The AccessMode is only valid for Hyperdisk disk types. + type: string + enumDescriptions: + - >- + The AccessMode means the disk can be attached to multiple + instances in RO mode. + - >- + The AccessMode means the disk can be attached to multiple + instances in RW mode. + - >- + The default AccessMode, means the disk can be attached to single + instance in RW mode. + enum: + - READ_ONLY_MANY + - READ_WRITE_MANY + - READ_WRITE_SINGLE + asyncPrimaryDisk: + description: Disk asynchronously replicated into this disk. + $ref: '#/components/schemas/DiskAsyncReplication' + asyncSecondaryDisks: + description: >- + [Output Only] A list of disks this disk is asynchronously replicated + to. + type: object + additionalProperties: + $ref: '#/components/schemas/DiskAsyncReplicationList' + resourceStatus: + description: '[Output Only] Status information for the disk resource.' + $ref: '#/components/schemas/DiskResourceStatus' + sourceConsistencyGroupPolicy: + description: >- + [Output Only] URL of the DiskConsistencyGroupPolicy for a secondary + disk that was created using a consistency group. + type: string + sourceConsistencyGroupPolicyId: + description: >- + [Output Only] ID of the DiskConsistencyGroupPolicy for a secondary + disk that was created using a consistency group. + type: string + architecture: + description: The architecture of the disk. Valid values are ARM64 or X86_64. + type: string + enumDescriptions: + - Default value indicating Architecture is not set. + - Machines with architecture ARM64 + - Machines with architecture X86_64 + enum: + - ARCHITECTURE_UNSPECIFIED + - ARM64 + - X86_64 + params: + description: >- + Input only. [Input Only] Additional params passed with the request, + but not persisted as part of resource payload. + $ref: '#/components/schemas/DiskParams' + DiskAsyncReplication: + id: DiskAsyncReplication + type: object + properties: + disk: + description: >- + The other disk asynchronously replicated to or from the current + 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 - projects/project/zones/zone/disks/disk - + zones/zone/disks/disk + type: string + diskId: + description: >- + [Output Only] The unique ID of the other disk asynchronously + replicated to or from the current disk. This value identifies the + exact disk that was used to create this replication. For example, if + you started replicating the persistent disk from a disk that was + later deleted and recreated under the same name, the disk ID would + identify the exact version of the disk that was used. + type: string + consistencyGroupPolicy: + description: >- + [Output Only] URL of the DiskConsistencyGroupPolicy if replication + was started on the disk as a member of a group. + type: string + consistencyGroupPolicyId: + description: >- + [Output Only] ID of the DiskConsistencyGroupPolicy if replication + was started on the disk as a member of a group. + type: string + DiskAsyncReplicationList: + id: DiskAsyncReplicationList + type: object + properties: + asyncReplicationDisk: + $ref: '#/components/schemas/DiskAsyncReplication' + DiskResourceStatus: + id: DiskResourceStatus + type: object + properties: + asyncPrimaryDisk: + $ref: '#/components/schemas/DiskResourceStatusAsyncReplicationStatus' + asyncSecondaryDisks: + description: 'Key: disk, value: AsyncReplicationStatus message' + type: object + additionalProperties: + $ref: '#/components/schemas/DiskResourceStatusAsyncReplicationStatus' + DiskResourceStatusAsyncReplicationStatus: + id: DiskResourceStatusAsyncReplicationStatus + type: object + properties: + state: + type: string + enumDescriptions: + - Replication is active. + - Secondary disk is created and is waiting for replication to start. + - Replication is starting. + - '' + - Replication is stopped. + - Replication is stopping. + enum: + - ACTIVE + - CREATED + - STARTING + - STATE_UNSPECIFIED + - STOPPED + - STOPPING + DiskParams: + id: DiskParams + description: Additional disk params. + type: object + properties: + resourceManagerTags: + description: >- + Resource manager tags to be bound to the disk. Tag keys and values + have the same definition as resource manager tags. Keys must be in + the format `tagKeys/{tag_key_id}`, and values are in the format + `tagValues/456`. The field is ignored (both PUT & PATCH) when empty. + type: object + additionalProperties: + type: string + DiskAggregatedList: + id: DiskAggregatedList type: object properties: kind: description: >- - [Output Only] Type of resource. Always compute#firewallList for - lists of firewalls. - default: compute#firewallList + [Output Only] Type of resource. Always compute#diskAggregatedList + for aggregated lists of persistent disks. + default: compute#diskAggregatedList type: string id: description: >- @@ -5498,10 +5006,11 @@ components: server. type: string items: - description: A list of Firewall resources. - type: array - items: - $ref: '#/components/schemas/Firewall' + description: A list of DisksScopedList resources. + type: object + additionalProperties: + description: '[Output Only] Name of the scope containing this set of disks.' + $ref: '#/components/schemas/DisksScopedList' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -5577,6 +5086,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -5620,6 +5132,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -5642,6 +5155,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -5678,283 +5192,24 @@ components: [Output Only] A warning data value corresponding to the key. type: string - Firewall: - id: 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. + unreachables: + description: '[Output Only] Unreachable resources.' + type: array + items: + type: string + DisksScopedList: + id: DisksScopedList type: object properties: - kind: - description: >- - [Output Only] Type of the resource. Always compute#firewall for - firewall rules. - default: compute#firewall - type: string - id: - description: >- - [Output Only] The unique identifier for the resource. This - identifier is defined by the server. - type: string - format: uint64 - creationTimestamp: - description: '[Output Only] Creation timestamp in RFC3339 text format.' - type: string - name: + disks: + description: '[Output Only] A list of disks contained in this scope.' + type: array + items: + $ref: '#/components/schemas/Disk' + warning: 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])?' - annotations: - required: - - compute.firewalls.insert - - compute.firewalls.patch - type: string - description: - description: >- - An optional description of this resource. Provide this field when - you create the resource. - 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`. - type: integer - format: int32 - 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. - type: array - items: - 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. - type: array - items: - type: string - 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. - type: array - items: - type: string - 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. - type: array - items: - type: string - 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. - type: array - items: - type: string - 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. - type: array - items: - type: string - 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. - type: array - items: - type: object - 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"]. - type: array - items: - 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. - type: array - items: - type: object - 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"]. - type: array - items: - type: string - direction: - description: >- - Direction of traffic to which this firewall applies, either - `INGRESS` or `EGRESS`. The default is `INGRESS`. For `EGRESS` - traffic, you cannot specify the sourceTags fields. - type: string - enumDescriptions: - - Indicates that firewall should apply to outgoing traffic. - - Indicates that firewall should apply to incoming traffic. - enum: - - EGRESS - - INGRESS - logConfig: - description: >- - This field denotes the logging options for a particular firewall - rule. If logging is enabled, logs will be exported to Cloud Logging. - $ref: '#/components/schemas/FirewallLogConfig' - 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 - selfLink: - description: '[Output Only] Server-defined URL for the resource.' - type: string - FirewallLogConfig: - id: FirewallLogConfig - description: The available logging options for a firewall rule. - type: object - 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. - type: string - enumDescriptions: - - '' - - '' - enum: - - EXCLUDE_ALL_METADATA - - INCLUDE_ALL_METADATA - FirewallPolicyList: - id: FirewallPolicyList - type: object - properties: - kind: - description: >- - [Output Only] Type of resource. Always compute#firewallPolicyList - for listsof FirewallPolicies - default: compute#firewallPolicyList - type: string - id: - description: >- - [Output Only] Unique identifier for the resource; defined by the - server. - type: string - items: - description: A list of FirewallPolicy resources. - type: array - items: - $ref: '#/components/schemas/FirewallPolicy' - nextPageToken: - description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the 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.' + [Output Only] Informational warning which replaces the list of disks + when the list is empty. type: object properties: code: @@ -6017,6 +5272,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -6060,6 +5318,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -6082,6 +5341,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -6118,427 +5378,196 @@ components: [Output Only] A warning data value corresponding to the key. type: string - FirewallPolicy: - id: FirewallPolicy - description: Represents a Firewall Policy resource. + ZoneSetLabelsRequest: + id: ZoneSetLabelsRequest type: object properties: - kind: - description: >- - [Output only] Type of the resource. Always compute#firewallPolicyfor - firewall policies - default: compute#firewallPolicy - type: string - id: - description: >- - [Output Only] The unique identifier for the resource. This - identifier is defined by the server. - type: string - format: uint64 - creationTimestamp: - description: '[Output Only] Creation timestamp in RFC3339 text format.' - type: string - name: - description: >- - Name of the resource. For Organization Firewall Policies it's a - [Output Only] numeric ID allocated by Google Cloud which uniquely - identifies the Organization Firewall Policy. - type: string - description: + labels: + description: The labels to set for this resource. + type: object + additionalProperties: + type: string + labelFingerprint: description: >- - An optional description of this resource. Provide this property when - you create the resource. + 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. 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 firewall policy, a default rule - with action "allow" will be added. + format: byte + BulkZoneSetLabelsRequest: + id: BulkZoneSetLabelsRequest + type: object + properties: + requests: type: array items: - $ref: '#/components/schemas/FirewallPolicyRule' - fingerprint: + $ref: '#/components/schemas/BulkSetLabelsRequest' + BulkSetLabelsRequest: + id: BulkSetLabelsRequest + type: object + properties: + labels: + description: The labels to set for this resource. + type: object + additionalProperties: + type: string + labelFingerprint: 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. + 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 may optionally 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. type: string format: byte - selfLink: - description: '[Output Only] Server-defined URL for the resource.' + DisksResizeRequest: + id: DisksResizeRequest + type: object + properties: + sizeGb: + description: The new size of the persistent disk, which is specified in GB. type: string - selfLinkWithId: + format: int64 + DisksAddResourcePoliciesRequest: + id: DisksAddResourcePoliciesRequest + type: object + properties: + resourcePolicies: description: >- - [Output Only] Server-defined URL for this resource with the resource - id. - type: string - associations: - description: A list of associations that belong to this firewall policy. + Full or relative path to the resource policy to be added to this + disk. You can only specify one resource policy. type: array items: - $ref: '#/components/schemas/FirewallPolicyAssociation' - ruleTupleCount: + type: string + DisksRemoveResourcePoliciesRequest: + id: DisksRemoveResourcePoliciesRequest + type: object + properties: + resourcePolicies: + description: Resource policies to be removed from this disk. + type: array + items: + type: string + ZoneSetPolicyRequest: + id: ZoneSetPolicyRequest + type: object + properties: + policy: description: >- - [Output Only] Total count of all firewall policy rule tuples. A - firewall policy can not exceed a set number of tuples. - type: integer - format: int32 - shortName: + 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. + $ref: '#/components/schemas/Policy' + bindings: description: >- - User-provided name of the Organization firewall policy. The name - should be unique in the organization in which the firewall policy is - created. This field is not applicable to network firewall policies. - This name must be set on creation and cannot be changed. The name - must be 1-63 characters long, and comply with RFC1035. Specifically, - the name must be 1-63 characters long and match the regular - expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first - character must be a lowercase letter, and all following characters - must be a dash, lowercase letter, or digit, except the last - character, which cannot be a dash. - pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' - type: string - displayName: + Flatten Policy to create a backwacd compatible wire-format. + Deprecated. Use 'policy' to specify bindings. + type: array + items: + $ref: '#/components/schemas/Binding' + etag: description: >- - Deprecated, please use short name instead. User-provided name of the - Organization firewall policy. The name should be unique in the - organization in which the firewall policy is created. This field is - not applicable to network firewall policies. This name must be set - on creation and cannot be changed. The name must be 1-63 characters - long, and comply with RFC1035. Specifically, the name must be 1-63 - characters long and match the regular expression - `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be - a lowercase letter, and all following characters must be a dash, - lowercase letter, or digit, except the last character, which cannot - be a dash. - pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' - deprecated: true + Flatten Policy to create a backward compatible wire-format. + Deprecated. Use 'policy' to specify the etag. type: string - parent: + format: byte + DisksStartAsyncReplicationRequest: + id: DisksStartAsyncReplicationRequest + type: object + properties: + asyncSecondaryDisk: description: >- - [Output Only] The parent of the firewall policy. This field is not - applicable to network firewall policies. + The secondary disk to start asynchronous replication to. 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 - region: + DisksStopGroupAsyncReplicationResource: + id: DisksStopGroupAsyncReplicationResource + description: >- + A transient resource used in compute.disks.stopGroupAsyncReplication and + compute.regionDisks.stopGroupAsyncReplication. It is only used to + process requests and is not persisted. + type: object + properties: + resourcePolicy: description: >- - [Output Only] URL of the region where the regional firewall policy - resides. This field is not applicable to global firewall policies. - You must specify this field as part of the HTTP request URL. It is - not settable as a field in the request body. + The URL of the DiskConsistencyGroupPolicy for the group of disks to + stop. This may be a full or partial URL, such as: - + https://www.googleapis.com/compute/v1/projects/project/regions/region + /resourcePolicies/resourcePolicy - + projects/project/regions/region/resourcePolicies/resourcePolicy - + regions/region/resourcePolicies/resourcePolicy type: string - FirewallPolicyRule: - id: FirewallPolicyRule + BulkInsertDiskResource: + id: BulkInsertDiskResource 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). + A transient resource used in compute.disks.bulkInsert and + compute.regionDisks.bulkInsert. It is only used to process requests and + is not persisted. type: object properties: - kind: + sourceConsistencyGroupPolicy: description: >- - [Output only] Type of the resource. Returns - compute#firewallPolicyRule for firewall rules and - compute#packetMirroringRule for packet mirroring rules. - default: compute#firewallPolicyRule + The URL of the DiskConsistencyGroupPolicy for the group of disks to + clone. This may be a full or partial URL, such as: - + https://www.googleapis.com/compute/v1/projects/project/regions/region + /resourcePolicies/resourcePolicy - + projects/project/regions/region/resourcePolicies/resourcePolicy - + regions/region/resourcePolicies/resourcePolicy type: string - ruleName: + RegionDisksResizeRequest: + id: RegionDisksResizeRequest + type: object + properties: + sizeGb: description: >- - An optional name for the rule. This field is not a unique identifier - and can be updated. - type: string - description: - description: An optional description for this resource. + The new size of the regional persistent disk, which is specified in + GB. type: string - priority: + format: int64 + RegionDisksAddResourcePoliciesRequest: + id: RegionDisksAddResourcePoliciesRequest + type: object + properties: + resourcePolicies: + description: Resource policies to be added to this disk. + type: array + items: + type: string + RegionDisksRemoveResourcePoliciesRequest: + id: RegionDisksRemoveResourcePoliciesRequest + type: object + properties: + resourcePolicies: + description: Resource policies to be removed from this disk. + type: array + items: + type: string + RegionSetPolicyRequest: + id: RegionSetPolicyRequest + type: object + properties: + policy: 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. - type: integer - format: int32 - match: + 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. + $ref: '#/components/schemas/Policy' + bindings: description: >- - A match condition that incoming traffic is evaluated against. If it - evaluates to true, the corresponding 'action' is enforced. - $ref: '#/components/schemas/FirewallPolicyRuleMatcher' - action: - description: >- - The Action to perform when the client connection triggers the rule. - Valid actions for firewall rules are: "allow", "deny", - "apply_security_profile_group" and "goto_next". Valid actions for - packet mirroring rules are: "mirror", "do_not_mirror" and - "goto_next". - type: string - securityProfileGroup: - description: >- - A fully-qualified URL of a SecurityProfile resource instance. - Example: - https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group - Must be specified if action is one of 'apply_security_profile_group' - or 'mirror'. Cannot be specified for other actions. - type: string - tlsInspect: - description: >- - Boolean flag indicating if the traffic should be TLS decrypted. Can - be set only if action = 'apply_security_profile_group' and cannot be - set for other actions. - type: boolean - direction: - description: The direction in which this rule applies. - type: string - enumDescriptions: - - '' - - '' - enum: - - EGRESS - - INGRESS - 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. - type: array - items: - type: string - 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 - ruleTupleCount: - description: >- - [Output Only] Calculation of the complexity of a single firewall - policy rule. - type: integer - format: int32 - targetServiceAccounts: - description: >- - A list of service accounts indicating the sets of instances that are - applied with this rule. - type: array - items: - type: string - targetSecureTags: - description: >- - A list of secure tags that controls which instances the firewall - rule applies to. If targetSecureTag are specified, then the firewall - rule applies only to instances in the VPC network that have one of - those EFFECTIVE secure tags, if all the target_secure_tag are in - INEFFECTIVE state, then this rule will be ignored. targetSecureTag - may not be set at the same time as targetServiceAccounts. If neither - targetServiceAccounts nor targetSecureTag are specified, the - firewall rule applies to all instances on the specified network. - Maximum number of target label tags allowed is 256. - type: array - items: - $ref: '#/components/schemas/FirewallPolicyRuleSecureTag' - 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 - FirewallPolicyRuleMatcher: - id: FirewallPolicyRuleMatcher - description: >- - Represents a match condition that incoming traffic is evaluated against. - Exactly one field must be specified. - type: object - properties: - srcIpRanges: - description: >- - CIDR IP address range. Maximum number of source CIDR IP ranges - allowed is 5000. - type: array - items: - type: string - destIpRanges: - description: >- - CIDR IP address range. Maximum number of destination CIDR IP ranges - allowed is 5000. - type: array - items: - type: string - layer4Configs: - description: Pairs of IP protocols and ports that the rule should match. - type: array - items: - $ref: '#/components/schemas/FirewallPolicyRuleMatcherLayer4Config' - srcSecureTags: - description: >- - List of secure tag values, which should be matched at the source of - the traffic. For INGRESS rule, if all the srcSecureTag are - INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. - Maximum number of source tag values allowed is 256. - type: array - items: - $ref: '#/components/schemas/FirewallPolicyRuleSecureTag' - destAddressGroups: - description: >- - Address groups which should be matched against the traffic - destination. Maximum number of destination address groups is 10. - type: array - items: - type: string - srcAddressGroups: - description: >- - Address groups which should be matched against the traffic source. - Maximum number of source address groups is 10. - type: array - items: - type: string - srcFqdns: - description: >- - Fully Qualified Domain Name (FQDN) which should be matched against - traffic source. Maximum number of source fqdn allowed is 100. - type: array - items: - type: string - destFqdns: - description: >- - Fully Qualified Domain Name (FQDN) which should be matched against - traffic destination. Maximum number of destination fqdn allowed is - 100. - type: array - items: - type: string - srcRegionCodes: - description: >- - Region codes whose IP addresses will be used to match for source of - traffic. Should be specified as 2 letter country code defined as per - ISO 3166 alpha-2 country codes. ex."US" Maximum number of source - region codes allowed is 5000. - type: array - items: - type: string - destRegionCodes: - description: >- - Region codes whose IP addresses will be used to match for - destination of traffic. Should be specified as 2 letter country code - defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum - number of dest region codes allowed is 5000. - type: array - items: - type: string - destThreatIntelligences: - description: >- - Names of Network Threat Intelligence lists. The IPs in these lists - will be matched against traffic destination. - type: array - items: - type: string - srcThreatIntelligences: - description: >- - Names of Network Threat Intelligence lists. The IPs in these lists - will be matched against traffic source. - type: array - items: - type: string - FirewallPolicyRuleMatcherLayer4Config: - id: FirewallPolicyRuleMatcherLayer4Config - type: object - 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"]. - type: array - items: - type: string - FirewallPolicyRuleSecureTag: - id: FirewallPolicyRuleSecureTag - type: object - properties: - name: - description: Name of the secure tag, created with TagManager's TagValue API. - pattern: tagValues/[0-9]+ - type: string - state: - description: >- - [Output Only] State of the secure tag, either `EFFECTIVE` or - `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or - its network is deleted. - type: string - enumDescriptions: - - '' - - '' - enum: - - EFFECTIVE - - INEFFECTIVE - FirewallPolicyAssociation: - id: FirewallPolicyAssociation - type: object - properties: - name: - description: The name for an association. - type: string - attachmentTarget: - description: The target that the firewall policy is attached to. - type: string - firewallPolicyId: - description: '[Output Only] The firewall policy ID of the association.' - type: string - shortName: - description: >- - [Output Only] The short name of the firewall policy of the - association. - type: string - displayName: - description: >- - [Output Only] Deprecated, please use short name instead. The display - name of the firewall policy of the association. - deprecated: true - type: string - FirewallPoliciesListAssociationsResponse: - id: FirewallPoliciesListAssociationsResponse - type: object - properties: - kind: - description: >- - [Output Only] Type of firewallPolicy associations. Always - compute#FirewallPoliciesListAssociations for lists of firewallPolicy - associations. - default: compute#firewallPoliciesListAssociationsResponse - type: string - associations: - description: A list of associations. - type: array - items: - $ref: '#/components/schemas/FirewallPolicyAssociation' - GlobalOrganizationSetPolicyRequest: - id: GlobalOrganizationSetPolicyRequest - type: object - properties: - 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. - $ref: '#/components/schemas/Policy' - bindings: - description: >- - Flatten Policy to create a backward compatible wire-format. + Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. type: array items: @@ -6549,66 +5578,32 @@ components: Deprecated. Use 'policy' to specify the etag. type: string format: byte - RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse: - id: RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse - type: object - properties: - firewalls: - description: Effective firewalls on the network. - type: array - items: - $ref: '#/components/schemas/Firewall' - firewallPolicys: - description: >- - [Output only] Effective firewalls from firewall policy. It applies - to Regional Network Firewall Policies in the specified region, - Global Network Firewall Policies and Hierachial Firewall Policies - which are associated with the network. - type: array - items: - $ref: >- - #/components/schemas/RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy - RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy: - id: >- - RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy + RegionDisksStartAsyncReplicationRequest: + id: RegionDisksStartAsyncReplicationRequest type: object properties: - name: - description: '[Output Only] The name of the firewall policy.' - type: string - type: + asyncSecondaryDisk: description: >- - [Output Only] The type of the firewall policy. Can be one of - HIERARCHY, NETWORK, NETWORK_REGIONAL, SYSTEM_GLOBAL, - SYSTEM_REGIONAL. - type: string - enumDescriptions: - - '' - - '' - - '' - - '' - enum: - - HIERARCHY - - NETWORK - - NETWORK_REGIONAL - - UNSPECIFIED - displayName: - description: '[Output Only] The display name of the firewall policy.' + The secondary disk to start asynchronous replication to. 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 - rules: - description: '[Output only] The rules that apply to the network.' - type: array - items: - $ref: '#/components/schemas/FirewallPolicyRule' - SecurityPolicyList: - id: SecurityPolicyList + FirewallList: + id: FirewallList + description: Contains a list of firewalls. type: object properties: kind: description: >- - [Output Only] Type of resource. Always compute#securityPolicyList - for listsof securityPolicies - default: compute#securityPolicyList + [Output Only] Type of resource. Always compute#firewallList for + lists of firewalls. + default: compute#firewallList type: string id: description: >- @@ -6616,10 +5611,10 @@ components: server. type: string items: - description: A list of SecurityPolicy resources. + description: A list of Firewall resources. type: array items: - $ref: '#/components/schemas/SecurityPolicy' + $ref: '#/components/schemas/Firewall' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -6628,6 +5623,9 @@ components: pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. type: string + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string warning: description: '[Output Only] Informational warning message.' type: object @@ -6692,6 +5690,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -6735,6 +5736,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -6757,6 +5759,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -6793,32 +5796,19 @@ components: [Output Only] A warning data value corresponding to the key. type: string - SecurityPolicy: - id: SecurityPolicy + Firewall: + id: Firewall 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. + 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. type: object properties: - userDefinedFields: - description: >- - Definitions of user-defined fields for CLOUD_ARMOR_NETWORK policies. - A user-defined field consists of up to 4 bytes extracted from a - fixed offset in the packet, relative to the IPv4, IPv6, TCP, or UDP - header, with an optional mask to select certain bits. Rules may then - specify matching values for these fields. Example: - userDefinedFields: - name: "ipv4_fragment_offset" base: IPV4 offset: - 6 size: 2 mask: "0x1fff" - type: array - items: - $ref: '#/components/schemas/SecurityPolicyUserDefinedField' kind: description: >- - [Output only] Type of the resource. Always compute#securityPolicyfor - security policies - default: compute#securityPolicy + [Output Only] Type of the resource. Always compute#firewall for + firewall rules. + default: compute#firewall type: string id: description: >- @@ -6831,1013 +5821,272 @@ components: type: string name: description: >- - Name of the resource. Provided by the client when the resource is + 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. + 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])?' + annotations: + required: + - compute.firewalls.insert + - compute.firewalls.patch type: string description: description: >- - An optional description of this resource. Provide this property when + An optional description of this resource. Provide this field when you create the resource. type: string - rules: - description: >- - A list of rules that belong to this policy. There must always be a - default rule which is a rule with priority 2147483647 and match all - condition (for the match condition this means match "*" for - srcIpRanges and for the networkMatch condition every field must be - either match "*" or not set). If no rules are provided when creating - a security policy, a default rule with action "allow" will be added. - type: array - items: - $ref: '#/components/schemas/SecurityPolicyRule' - adaptiveProtectionConfig: - $ref: '#/components/schemas/SecurityPolicyAdaptiveProtectionConfig' - ddosProtectionConfig: - $ref: '#/components/schemas/SecurityPolicyDdosProtectionConfig' - advancedOptionsConfig: - $ref: '#/components/schemas/SecurityPolicyAdvancedOptionsConfig' - recaptchaOptionsConfig: - $ref: '#/components/schemas/SecurityPolicyRecaptchaOptionsConfig' - fingerprint: + network: 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. - type: string - format: byte - selfLink: - description: '[Output Only] Server-defined URL for the resource.' + 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 - type: + priority: description: >- - The type indicates the intended use of the security policy. - - CLOUD_ARMOR: Cloud Armor backend security policies can be configured - to filter incoming HTTP requests targeting backend services. They - filter requests before they hit the origin servers. - - CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be - configured to filter incoming HTTP requests targeting backend - services (including Cloud CDN-enabled) as well as backend buckets - (Cloud Storage). They filter requests before the request is served - from Google's cache. - CLOUD_ARMOR_INTERNAL_SERVICE: Cloud Armor - internal service policies can be configured to filter HTTP requests - targeting services managed by Traffic Director in a service mesh. - They filter requests before the request is served from the - application. - CLOUD_ARMOR_NETWORK: Cloud Armor network policies can - be configured to filter packets targeting network load balancing - resources such as backend services, target pools, target instances, - and instances with external IPs. They filter requests before the - request is served from the application. This field can be set only - at resource creation time. - type: string - enumDescriptions: - - '' - - '' - - '' - enum: - - CLOUD_ARMOR - - CLOUD_ARMOR_EDGE - - CLOUD_ARMOR_NETWORK - labels: + 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`. + type: integer + format: int32 + sourceRanges: 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 - additionalProperties: + 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. + type: array + items: type: string - labelFingerprint: + destinationRanges: description: >- - A fingerprint for the labels being applied to this security policy, - 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. To see the latest fingerprint, make get() request to - the security policy. - type: string - format: byte - region: + 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. + type: array + items: + type: string + sourceTags: description: >- - [Output Only] URL of the region where the regional security policy - resides. This field is not applicable to global security policies. - type: string - SecurityPolicyUserDefinedField: - id: SecurityPolicyUserDefinedField - type: object - properties: - name: - description: The name of this field. Must be unique within the policy. - type: string - base: - description: >- - The base relative to which 'offset' is measured. Possible values - are: - IPV4: Points to the beginning of the IPv4 header. - IPV6: - Points to the beginning of the IPv6 header. - TCP: Points to the - beginning of the TCP header, skipping over any IPv4 options or IPv6 - extension headers. Not present for non-first fragments. - UDP: - Points to the beginning of the UDP header, skipping over any IPv4 - options or IPv6 extension headers. Not present for non-first - fragments. required - type: string - enumDescriptions: - - '' - - '' - - '' - - '' - enum: - - IPV4 - - IPV6 - - TCP - - UDP - offset: - description: >- - Offset of the first byte of the field (in network byte order) - relative to 'base'. - type: integer - format: int32 - size: - description: 'Size of the field in bytes. Valid values: 1-4.' - type: integer - format: int32 - mask: - description: >- - If specified, apply this mask (bitwise AND) to the field to ignore - bits before matching. Encoded as a hexadecimal number (starting with - "0x"). The last byte of the field (in network byte order) - corresponds to the least significant byte of the mask. - type: string - SecurityPolicyRule: - id: 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). - type: object - properties: - kind: - description: >- - [Output only] Type of the resource. Always - compute#securityPolicyRule for security policy rules - default: compute#securityPolicyRule - type: string - description: - description: >- - An optional description of this resource. Provide this property when - you create the resource. - type: string - 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. - type: integer - format: int32 - match: - description: >- - A match condition that incoming traffic is evaluated against. If it - evaluates to true, the corresponding 'action' is enforced. - $ref: '#/components/schemas/SecurityPolicyRuleMatcher' - networkMatch: - description: >- - A match condition that incoming packets are evaluated against for - CLOUD_ARMOR_NETWORK security policies. If it matches, the - corresponding 'action' is enforced. The match criteria for a rule - consists of built-in match fields (like 'srcIpRanges') and - potentially multiple user-defined match fields - ('userDefinedFields'). Field values may be extracted directly from - the packet or derived from it (e.g. 'srcRegionCodes'). Some fields - may not be present in every packet (e.g. 'srcPorts'). A user-defined - field is only present if the base header is found in the packet and - the entire field is in bounds. Each match field may specify which - values can match it, listing one or more ranges, prefixes, or exact - values that are considered a match for the field. A field value must - be present in order to match a specified match field. If no match - values are specified for a match field, then any field value is - considered to match it, and it's not required to be present. For - strings specifying '*' is also equivalent to match all. For a packet - to match a rule, all specified match fields must match the - corresponding field values derived from the packet. Example: - networkMatch: srcIpRanges: - "192.0.2.0/24" - "198.51.100.0/24" - userDefinedFields: - name: "ipv4_fragment_offset" values: - - "1-0x1fff" The above match condition matches packets with a source - IP in 192.0.2.0/24 or 198.51.100.0/24 and a user-defined field named - "ipv4_fragment_offset" with a value between 1 and 0x1fff inclusive. - $ref: '#/components/schemas/SecurityPolicyRuleNetworkMatcher' - action: - description: >- - The Action to perform when the rule is matched. The following are - the valid actions: - allow: allow access to target. - deny(STATUS): - deny access to target, returns the HTTP response code specified. - Valid values for `STATUS` are 403, 404, and 502. - rate_based_ban: - limit client traffic to the configured threshold and ban the client - if the traffic exceeds the threshold. Configure parameters for this - action in RateLimitOptions. Requires rate_limit_options to be set. - - redirect: redirect to a different target. This can either be an - internal reCAPTCHA redirect, or an external URL-based redirect via a - 302 response. Parameters for this action can be configured via - redirectOptions. This action is only supported in Global Security - Policies of type CLOUD_ARMOR. - throttle: limit client traffic to - the configured threshold. Configure parameters for this action in - rateLimitOptions. Requires rate_limit_options to be set for this. - type: string - preview: - description: If set to true, the specified action is not enforced. - type: boolean - rateLimitOptions: - description: >- - Must be specified if the action is "rate_based_ban" or "throttle". - Cannot be specified for any other actions. - $ref: '#/components/schemas/SecurityPolicyRuleRateLimitOptions' - headerAction: - description: >- - Optional, additional actions that are performed on headers. This - field is only supported in Global Security Policies of type - CLOUD_ARMOR. - $ref: '#/components/schemas/SecurityPolicyRuleHttpHeaderAction' - redirectOptions: - description: >- - Parameters defining the redirect action. Cannot be specified for any - other actions. This field is only supported in Global Security - Policies of type CLOUD_ARMOR. - $ref: '#/components/schemas/SecurityPolicyRuleRedirectOptions' - preconfiguredWafConfig: - description: >- - Preconfigured WAF configuration to be applied for the rule. If the - rule does not evaluate preconfigured WAF rules, i.e., if - evaluatePreconfiguredWaf() is not used, this field will have no - effect. - $ref: '#/components/schemas/SecurityPolicyRulePreconfiguredWafConfig' - SecurityPolicyRuleMatcher: - id: SecurityPolicyRuleMatcher - description: >- - Represents a match condition that incoming traffic is evaluated against. - Exactly one field must be specified. - type: object - properties: - 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. Expressions containing - `evaluateThreatIntelligence` require Cloud Armor Managed Protection - Plus tier and are not supported in Edge Policies nor in Regional - Policies. Expressions containing - `evaluatePreconfiguredExpr('sourceiplist-*')` require Cloud Armor - Managed Protection Plus tier and are only supported in Global - Security Policies. - $ref: '#/components/schemas/Expr' - exprOptions: - description: >- - The configuration options available when specifying a user defined - CEVAL expression (i.e., 'expr'). - $ref: '#/components/schemas/SecurityPolicyRuleMatcherExprOptions' - 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. - type: string - enumDescriptions: - - >- - Matches the source IP address of a request to the IP ranges - supplied in config. - enum: - - SRC_IPS_V1 - config: - 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. - $ref: '#/components/schemas/SecurityPolicyRuleMatcherConfig' - SecurityPolicyRuleMatcherExprOptions: - id: SecurityPolicyRuleMatcherExprOptions - type: object - properties: - recaptchaOptions: - description: >- - reCAPTCHA configuration options to be applied for the rule. If the - rule does not evaluate reCAPTCHA tokens, this field has no effect. - $ref: >- - #/components/schemas/SecurityPolicyRuleMatcherExprOptionsRecaptchaOptions - SecurityPolicyRuleMatcherExprOptionsRecaptchaOptions: - id: SecurityPolicyRuleMatcherExprOptionsRecaptchaOptions - type: object - properties: - actionTokenSiteKeys: - description: >- - A list of site keys to be used during the validation of reCAPTCHA - action-tokens. The provided site keys need to be created from - reCAPTCHA API under the same project where the security policy is - created. + 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. type: array items: type: string - sessionTokenSiteKeys: + targetTags: description: >- - A list of site keys to be used during the validation of reCAPTCHA - session-tokens. The provided site keys need to be created from - reCAPTCHA API under the same project where the security policy is - created. + 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. type: array items: type: string - SecurityPolicyRuleMatcherConfig: - id: SecurityPolicyRuleMatcherConfig - type: object - properties: - srcIpRanges: + sourceServiceAccounts: description: >- - CIDR IP address range. Maximum number of src_ip_ranges allowed is - 10. + 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. type: array items: type: string - SecurityPolicyRuleNetworkMatcher: - id: SecurityPolicyRuleNetworkMatcher - description: >- - Represents a match condition that incoming network traffic is evaluated - against. - type: object - properties: - userDefinedFields: - description: >- - User-defined fields. Each element names a defined field and lists - the matching values for that field. - type: array - items: - $ref: >- - #/components/schemas/SecurityPolicyRuleNetworkMatcherUserDefinedFieldMatch - srcIpRanges: + targetServiceAccounts: description: >- - Source IPv4/IPv6 addresses or CIDR prefixes, in standard text - format. + 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. type: array items: type: string - destIpRanges: + allowed: description: >- - Destination IPv4/IPv6 addresses or CIDR prefixes, in standard text - format. + The list of ALLOW rules specified by this firewall. Each rule + specifies a protocol and port-range tuple that describes a permitted + connection. type: array items: - type: string - ipProtocols: + type: object + 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"]. + type: array + items: + type: string + denied: description: >- - IPv4 protocol / IPv6 next header (after extension headers). Each - element can be an 8-bit unsigned decimal number (e.g. "6"), range - (e.g. "253-254"), or one of the following protocol names: "tcp", - "udp", "icmp", "esp", "ah", "ipip", or "sctp". + The list of DENY rules specified by this firewall. Each rule + specifies a protocol and port-range tuple that describes a denied + connection. type: array items: - type: string - srcPorts: + type: object + 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"]. + type: array + items: + type: string + direction: description: >- - Source port numbers for TCP/UDP/SCTP. Each element can be a 16-bit - unsigned decimal number (e.g. "80") or range (e.g. "0-1023"). - type: array - items: - type: string - destPorts: + Direction of traffic to which this firewall applies, either + `INGRESS` or `EGRESS`. The default is `INGRESS`. For `EGRESS` + traffic, you cannot specify the sourceTags fields. + type: string + enumDescriptions: + - Indicates that firewall should apply to outgoing traffic. + - Indicates that firewall should apply to incoming traffic. + enum: + - EGRESS + - INGRESS + logConfig: description: >- - Destination port numbers for TCP/UDP/SCTP. Each element can be a - 16-bit unsigned decimal number (e.g. "80") or range (e.g. "0-1023"). - type: array - items: - type: string - srcRegionCodes: + This field denotes the logging options for a particular firewall + rule. If logging is enabled, logs will be exported to Cloud Logging. + $ref: '#/components/schemas/FirewallLogConfig' + disabled: description: >- - Two-letter ISO 3166-1 alpha-2 country code associated with the - source IP address. - type: array - items: - type: string - srcAsns: - description: BGP Autonomous System Number associated with the source IP address. - type: array - items: - type: integer - format: uint32 - SecurityPolicyRuleNetworkMatcherUserDefinedFieldMatch: - id: SecurityPolicyRuleNetworkMatcherUserDefinedFieldMatch - type: object - properties: - name: - description: Name of the user-defined field, as given in the definition. + 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 + selfLink: + description: '[Output Only] Server-defined URL for the resource.' type: string - values: + params: description: >- - Matching values of the field. Each element can be a 32-bit unsigned - decimal or hexadecimal (starting with "0x") number (e.g. "64") or - range (e.g. "0x400-0x7ff"). - type: array - items: - type: string - SecurityPolicyRuleRateLimitOptions: - id: SecurityPolicyRuleRateLimitOptions + Input only. [Input Only] Additional params passed with the request, + but not persisted as part of resource payload. + $ref: '#/components/schemas/FirewallParams' + FirewallLogConfig: + id: FirewallLogConfig + description: The available logging options for a firewall rule. type: object properties: - rateLimitThreshold: - description: Threshold at which to begin ratelimiting. - $ref: '#/components/schemas/SecurityPolicyRuleRateLimitOptionsThreshold' - conformAction: - description: >- - Action to take for requests that are under the configured rate limit - threshold. Valid option is "allow" only. - type: string - exceedAction: - description: >- - Action to take for requests that are above the configured rate limit - threshold, to either deny with a specified HTTP response code, or - redirect to a different endpoint. Valid options are `deny(STATUS)`, - where valid values for `STATUS` are 403, 404, 429, and 502, and - `redirect`, where the redirect parameters come from - `exceedRedirectOptions` below. The `redirect` action is only - supported in Global Security Policies of type CLOUD_ARMOR. - type: string - exceedRedirectOptions: + enable: description: >- - Parameters defining the redirect action that is used as the exceed - action. Cannot be specified if the exceed action is not redirect. - This field is only supported in Global Security Policies of type - CLOUD_ARMOR. - $ref: '#/components/schemas/SecurityPolicyRuleRedirectOptions' - enforceOnKey: + This field denotes whether to enable logging for a particular + firewall rule. + type: boolean + metadata: description: >- - Determines the key to enforce the rate_limit_threshold on. Possible - values are: - ALL: A single rate limit threshold is applied to all - the requests matching this rule. This is the default value if - "enforceOnKey" is not configured. - IP: The source IP address of the - request is the key. Each IP has this limit enforced separately. - - HTTP_HEADER: The value of the HTTP header whose name is configured - under "enforceOnKeyName". The key value is truncated to the first - 128 bytes of the header value. If no such header is present in the - request, the key type defaults to ALL. - XFF_IP: The first IP - address (i.e. the originating client IP address) specified in the - list of IPs under X-Forwarded-For HTTP header. If no such header is - present or the value is not a valid IP, the key defaults to the - source IP address of the request i.e. key type IP. - HTTP_COOKIE: - The value of the HTTP cookie whose name is configured under - "enforceOnKeyName". The key value is truncated to the first 128 - bytes of the cookie value. If no such cookie is present in the - request, the key type defaults to ALL. - HTTP_PATH: The URL path of - the HTTP request. The key value is truncated to the first 128 bytes. - - SNI: Server name indication in the TLS session of the HTTPS - request. The key value is truncated to the first 128 bytes. The key - type defaults to ALL on a HTTP session. - REGION_CODE: The - country/region from which the request originates. - - TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the client connects - using HTTPS, HTTP/2 or HTTP/3. If not available, the key type - defaults to ALL. - USER_IP: The IP address of the originating - client, which is resolved based on "userIpRequestHeaders" configured - with the security policy. If there is no "userIpRequestHeaders" - configuration or an IP address cannot be resolved from it, the key - type defaults to IP. + 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. type: string enumDescriptions: - '' - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' enum: - - ALL - - HTTP_COOKIE - - HTTP_HEADER - - HTTP_PATH - - IP - - REGION_CODE - - SNI - - TLS_JA3_FINGERPRINT - - USER_IP - - XFF_IP - enforceOnKeyName: + - EXCLUDE_ALL_METADATA + - INCLUDE_ALL_METADATA + FirewallParams: + id: FirewallParams + description: Additional firewall parameters. + type: object + properties: + resourceManagerTags: description: >- - Rate limit key name applicable only for the following key types: - HTTP_HEADER -- Name of the HTTP header whose value is taken as the - key value. HTTP_COOKIE -- Name of the HTTP cookie whose value is - taken as the key value. + Tag keys/values directly bound to this resource. Tag keys and values + have the same definition as resource manager tags. The field is + allowed for INSERT only. The keys/values to set on the resource + should be specified in either ID { : } or Namespaced format { : }. + For example the following are valid inputs: * {"tagKeys/333" : + "tagValues/444", "tagKeys/123" : "tagValues/456"} * + {"123/environment" : "production", "345/abc" : "xyz"} Note: * + Invalid combinations of ID & namespaced format is not supported. For + instance: {"123/environment" : "tagValues/444"} is invalid. + type: object + additionalProperties: + type: string + FirewallPolicyList: + id: FirewallPolicyList + type: object + properties: + kind: + description: >- + [Output Only] Type of resource. Always compute#firewallPolicyList + for listsof FirewallPolicies + default: compute#firewallPolicyList type: string - enforceOnKeyConfigs: - description: >- - If specified, any combination of values of - enforce_on_key_type/enforce_on_key_name is treated as the key on - which ratelimit threshold/action is enforced. You can specify up to - 3 enforce_on_key_configs. If enforce_on_key_configs is specified, - enforce_on_key must not be specified. - type: array - items: - $ref: >- - #/components/schemas/SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig - banThreshold: - description: >- - Can only be specified if the action for the rule is - "rate_based_ban". If specified, the key will be banned for the - configured 'ban_duration_sec' when the number of requests that - exceed the 'rate_limit_threshold' also exceed this 'ban_threshold'. - $ref: '#/components/schemas/SecurityPolicyRuleRateLimitOptionsThreshold' - banDurationSec: - description: >- - Can only be specified if the action for the rule is - "rate_based_ban". If specified, determines the time (in seconds) the - traffic will continue to be banned by the rate limit after the rate - falls below the threshold. - type: integer - format: int32 - SecurityPolicyRuleRateLimitOptionsThreshold: - id: SecurityPolicyRuleRateLimitOptionsThreshold - type: object - properties: - count: - description: Number of HTTP(S) requests for calculating the threshold. - type: integer - format: int32 - intervalSec: - description: Interval over which the threshold is computed. - type: integer - format: int32 - SecurityPolicyRuleRedirectOptions: - id: SecurityPolicyRuleRedirectOptions - type: object - properties: - type: - description: Type of the redirect action. - type: string - enumDescriptions: - - '' - - '' - enum: - - EXTERNAL_302 - - GOOGLE_RECAPTCHA - target: - description: >- - Target for the redirect action. This is required if the type is - EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA. - type: string - SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig: - id: SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig - type: object - properties: - enforceOnKeyType: - description: >- - Determines the key to enforce the rate_limit_threshold on. Possible - values are: - ALL: A single rate limit threshold is applied to all - the requests matching this rule. This is the default value if - "enforceOnKeyConfigs" is not configured. - IP: The source IP address - of the request is the key. Each IP has this limit enforced - separately. - HTTP_HEADER: The value of the HTTP header whose name - is configured under "enforceOnKeyName". The key value is truncated - to the first 128 bytes of the header value. If no such header is - present in the request, the key type defaults to ALL. - XFF_IP: The - first IP address (i.e. the originating client IP address) specified - in the list of IPs under X-Forwarded-For HTTP header. If no such - header is present or the value is not a valid IP, the key defaults - to the source IP address of the request i.e. key type IP. - - HTTP_COOKIE: The value of the HTTP cookie whose name is configured - under "enforceOnKeyName". The key value is truncated to the first - 128 bytes of the cookie value. If no such cookie is present in the - request, the key type defaults to ALL. - HTTP_PATH: The URL path of - the HTTP request. The key value is truncated to the first 128 bytes. - - SNI: Server name indication in the TLS session of the HTTPS - request. The key value is truncated to the first 128 bytes. The key - type defaults to ALL on a HTTP session. - REGION_CODE: The - country/region from which the request originates. - - TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the client connects - using HTTPS, HTTP/2 or HTTP/3. If not available, the key type - defaults to ALL. - USER_IP: The IP address of the originating - client, which is resolved based on "userIpRequestHeaders" configured - with the security policy. If there is no "userIpRequestHeaders" - configuration or an IP address cannot be resolved from it, the key - type defaults to IP. - type: string - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - enum: - - ALL - - HTTP_COOKIE - - HTTP_HEADER - - HTTP_PATH - - IP - - REGION_CODE - - SNI - - TLS_JA3_FINGERPRINT - - USER_IP - - XFF_IP - enforceOnKeyName: - description: >- - Rate limit key name applicable only for the following key types: - HTTP_HEADER -- Name of the HTTP header whose value is taken as the - key value. HTTP_COOKIE -- Name of the HTTP cookie whose value is - taken as the key value. - type: string - SecurityPolicyRuleHttpHeaderAction: - id: SecurityPolicyRuleHttpHeaderAction - type: object - properties: - requestHeadersToAdds: - description: >- - The list of request headers to add or overwrite if they're already - present. - type: array - items: - $ref: >- - #/components/schemas/SecurityPolicyRuleHttpHeaderActionHttpHeaderOption - SecurityPolicyRuleHttpHeaderActionHttpHeaderOption: - id: SecurityPolicyRuleHttpHeaderActionHttpHeaderOption - type: object - properties: - headerName: - description: The name of the header to set. - type: string - headerValue: - description: The value to set the named header to. - type: string - SecurityPolicyRulePreconfiguredWafConfig: - id: SecurityPolicyRulePreconfiguredWafConfig - type: object - properties: - exclusions: - description: A list of exclusions to apply during preconfigured WAF evaluation. - type: array - items: - $ref: >- - #/components/schemas/SecurityPolicyRulePreconfiguredWafConfigExclusion - SecurityPolicyRulePreconfiguredWafConfigExclusion: - id: SecurityPolicyRulePreconfiguredWafConfigExclusion - type: object - properties: - targetRuleSet: - description: Target WAF rule set to apply the preconfigured WAF exclusion. - type: string - targetRuleIds: - description: >- - A list of target rule IDs under the WAF rule set to apply the - preconfigured WAF exclusion. If omitted, it refers to all the rule - IDs under the WAF rule set. - type: array - items: - type: string - requestHeadersToExclude: - description: >- - A list of request header names whose value will be excluded from - inspection during preconfigured WAF evaluation. - type: array - items: - $ref: >- - #/components/schemas/SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParams - requestCookiesToExclude: - description: >- - A list of request cookie names whose value will be excluded from - inspection during preconfigured WAF evaluation. - type: array - items: - $ref: >- - #/components/schemas/SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParams - requestQueryParamsToExclude: - description: >- - A list of request query parameter names whose value will be excluded - from inspection during preconfigured WAF evaluation. Note that the - parameter can be in the query string or in the POST body. - type: array - items: - $ref: >- - #/components/schemas/SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParams - requestUrisToExclude: - description: >- - A list of request URIs from the request line to be excluded from - inspection during preconfigured WAF evaluation. When specifying this - field, the query or fragment part should be excluded. - type: array - items: - $ref: >- - #/components/schemas/SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParams - SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParams: - id: SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParams - type: object - properties: - val: - description: The value of the field. - type: string - op: - description: The match operator for the field. - type: string - enumDescriptions: - - >- - The operator matches if the field value contains the specified - value. - - >- - The operator matches if the field value ends with the specified - value. - - >- - The operator matches if the field value equals the specified - value. - - The operator matches if the field value is any value. - - >- - The operator matches if the field value starts with the specified - value. - enum: - - CONTAINS - - ENDS_WITH - - EQUALS - - EQUALS_ANY - - STARTS_WITH - SecurityPolicyAdaptiveProtectionConfig: - id: SecurityPolicyAdaptiveProtectionConfig - description: Configuration options for Cloud Armor Adaptive Protection (CAAP). - type: object - properties: - layer7DdosDefenseConfig: - description: If set to true, enables Cloud Armor Machine Learning. - $ref: >- - #/components/schemas/SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfig - SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfig: - id: SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfig - description: >- - Configuration options for L7 DDoS detection. This field is only - supported in Global Security Policies of type CLOUD_ARMOR. - type: object - properties: - enable: - description: >- - If set to true, enables CAAP for L7 DDoS detection. This field is - only supported in Global Security Policies of type CLOUD_ARMOR. - type: boolean - ruleVisibility: - description: >- - Rule visibility can be one of the following: STANDARD - opaque - rules. (default) PREMIUM - transparent rules. This field is only - supported in Global Security Policies of type CLOUD_ARMOR. - type: string - enumDescriptions: - - '' - - '' - enum: - - PREMIUM - - STANDARD - thresholdConfigs: - description: >- - Configuration options for layer7 adaptive protection for various - customizable thresholds. - type: array - items: - $ref: >- - #/components/schemas/SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfig - SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfig: - id: >- - SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfig - type: object - properties: - name: - description: >- - The name must be 1-63 characters long, and comply with RFC1035. The - name must be unique within the security policy. - pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' - type: string - autoDeployLoadThreshold: - type: number - format: float - autoDeployConfidenceThreshold: - type: number - format: float - autoDeployImpactedBaselineThreshold: - type: number - format: float - autoDeployExpirationSec: - type: integer - format: int32 - detectionLoadThreshold: - type: number - format: float - detectionAbsoluteQps: - type: number - format: float - detectionRelativeToBaselineQps: - type: number - format: float - trafficGranularityConfigs: - description: >- - Configuration options for enabling Adaptive Protection to operate on - specified granular traffic units. - type: array - items: - $ref: >- - #/components/schemas/SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfigTrafficGranularityConfig - SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfigTrafficGranularityConfig: - id: >- - SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfigTrafficGranularityConfig - description: >- - Configurations to specifc granular traffic units processed by Adaptive - Protection. - type: object - properties: - type: - description: Type of this configuration. - type: string - enumDescriptions: - - '' - - '' - - '' - enum: - - HTTP_HEADER_HOST - - HTTP_PATH - - UNSPECIFIED_TYPE - value: - description: Requests that match this value constitute a granular traffic unit. - type: string - enableEachUniqueValue: - description: >- - If enabled, traffic matching each unique value for the specified - type constitutes a separate traffic unit. It can only be set to true - if `value` is empty. - type: boolean - SecurityPolicyDdosProtectionConfig: - id: SecurityPolicyDdosProtectionConfig - type: object - properties: - ddosProtection: - type: string - enumDescriptions: - - '' - - '' - enum: - - ADVANCED - - STANDARD - SecurityPolicyAdvancedOptionsConfig: - id: SecurityPolicyAdvancedOptionsConfig - type: object - properties: - jsonParsing: - type: string - enumDescriptions: - - '' - - '' - - '' - enum: - - DISABLED - - STANDARD - - STANDARD_WITH_GRAPHQL - jsonCustomConfig: - description: >- - Custom configuration to apply the JSON parsing. Only applicable when - json_parsing is set to STANDARD. - $ref: >- - #/components/schemas/SecurityPolicyAdvancedOptionsConfigJsonCustomConfig - logLevel: - type: string - enumDescriptions: - - '' - - '' - enum: - - NORMAL - - VERBOSE - userIpRequestHeaders: - description: >- - An optional list of case-insensitive request header names to use for - resolving the callers client IP address. - type: array - items: - type: string - SecurityPolicyAdvancedOptionsConfigJsonCustomConfig: - id: SecurityPolicyAdvancedOptionsConfigJsonCustomConfig - type: object - properties: - contentTypes: - description: >- - A list of custom Content-Type header values to apply the JSON - parsing. As per RFC 1341, a Content-Type header value has the - following format: Content-Type := type "/" subtype *[";" parameter] - When configuring a custom Content-Type header value, only the - type/subtype needs to be specified, and the parameters should be - excluded. - type: array - items: - type: string - SecurityPolicyRecaptchaOptionsConfig: - id: SecurityPolicyRecaptchaOptionsConfig - type: object - properties: - redirectSiteKey: - description: >- - An optional field to supply a reCAPTCHA site key to be used for all - the rules using the redirect action with the type of - GOOGLE_RECAPTCHA under the security policy. The specified site key - needs to be created from the reCAPTCHA API. The user is responsible - for the validity of the specified site key. If not specified, a - Google-managed site key is used. This field is only supported in - Global Security Policies of type CLOUD_ARMOR. - type: string - SecurityPoliciesListPreconfiguredExpressionSetsResponse: - id: SecurityPoliciesListPreconfiguredExpressionSetsResponse - type: object - properties: - preconfiguredExpressionSets: - $ref: '#/components/schemas/SecurityPoliciesWafConfig' - SecurityPoliciesWafConfig: - id: SecurityPoliciesWafConfig - type: object - properties: - wafRules: - $ref: '#/components/schemas/PreconfiguredWafSet' - PreconfiguredWafSet: - id: PreconfiguredWafSet - type: object - properties: - expressionSets: - description: List of entities that are currently supported for WAF rules. - type: array - items: - $ref: '#/components/schemas/WafExpressionSet' - WafExpressionSet: - id: WafExpressionSet - type: object - properties: - id: - description: >- - Google specified expression set ID. The format should be: - E.g. - XSS-20170329 required - type: string - 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. - type: array - items: - type: string - expressions: - description: List of available expressions. - type: array - items: - $ref: '#/components/schemas/WafExpressionSetExpression' - WafExpressionSetExpression: - id: WafExpressionSetExpression - type: object - 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 - sensitivity: - description: >- - The sensitivity value associated with the WAF rule ID. This - corresponds to the ModSecurity paranoia level, ranging from 1 to 4. - 0 is reserved for opt-in only rules. - type: integer - format: int32 - SecurityPoliciesAggregatedList: - id: SecurityPoliciesAggregatedList - type: object - properties: - kind: - description: >- - [Output Only] Type of resource. Always - compute#securityPolicyAggregatedList for lists of Security Policies. - default: compute#securityPoliciesAggregatedList - type: string - id: + id: description: >- [Output Only] Unique identifier for the resource; defined by the server. type: string items: - description: A list of SecurityPoliciesScopedList resources. - type: object - additionalProperties: - description: Name of the scope containing this set of security policies. - $ref: '#/components/schemas/SecurityPoliciesScopedList' + description: A list of FirewallPolicy resources. + type: array + items: + $ref: '#/components/schemas/FirewallPolicy' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -7846,9 +6095,6 @@ components: pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. type: string - selfLink: - description: '[Output Only] Server-defined URL for this resource.' - type: string warning: description: '[Output Only] Informational warning message.' type: object @@ -7913,6 +6159,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -7956,6 +6205,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -7978,6 +6228,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -8014,26 +6265,518 @@ components: [Output Only] A warning data value corresponding to the key. type: string - etag: - type: string - unreachables: - description: '[Output Only] Unreachable resources.' - type: array - items: - type: string - SecurityPoliciesScopedList: - id: SecurityPoliciesScopedList + FirewallPolicy: + id: FirewallPolicy + description: Represents a Firewall Policy resource. type: object properties: - securityPolicies: - description: A list of SecurityPolicies contained in this scope. - type: array + kind: + description: >- + [Output only] Type of the resource. Always compute#firewallPolicyfor + firewall policies + default: compute#firewallPolicy + type: string + id: + description: >- + [Output Only] The unique identifier for the resource. This + identifier is defined by the server. + type: string + format: uint64 + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + name: + description: >- + Name of the resource. For Organization Firewall Policies it's a + [Output Only] numeric ID allocated by Google Cloud which uniquely + identifies the Organization Firewall Policy. + type: string + description: + description: >- + An optional description of this resource. Provide this property when + you create the resource. + 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 firewall policy, a default rule + with action "allow" will be added. + type: array items: - $ref: '#/components/schemas/SecurityPolicy' - warning: + $ref: '#/components/schemas/FirewallPolicyRule' + packetMirroringRules: + description: A list of packet mirroring rules that belong to this policy. + type: array + items: + $ref: '#/components/schemas/FirewallPolicyRule' + fingerprint: description: >- - Informational warning which replaces the list of security policies - when the list is empty. + 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. + type: string + format: byte + 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 + associations: + description: A list of associations that belong to this firewall policy. + type: array + items: + $ref: '#/components/schemas/FirewallPolicyAssociation' + ruleTupleCount: + description: >- + [Output Only] Total count of all firewall policy rule tuples. A + firewall policy can not exceed a set number of tuples. + type: integer + format: int32 + shortName: + description: >- + User-provided name of the Organization firewall policy. The name + should be unique in the organization in which the firewall policy is + created. This field is not applicable to network firewall policies. + This name must be set on creation and cannot be changed. The name + must be 1-63 characters long, and comply with RFC1035. Specifically, + the name must be 1-63 characters long and match the regular + expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first + character must be a lowercase letter, and all following characters + must be a dash, lowercase letter, or digit, except the last + character, which cannot be a dash. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + 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 field is + not applicable to network firewall policies. This name must be set + on creation and cannot be changed. The name must be 1-63 characters + long, and comply with RFC1035. Specifically, the name must be 1-63 + characters long and match the regular expression + `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be + a lowercase letter, and all following characters must be a dash, + lowercase letter, or digit, except the last character, which cannot + be a dash. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + deprecated: true + type: string + parent: + description: >- + [Output Only] The parent of the firewall policy. This field is not + applicable to network firewall policies. + type: string + region: + description: >- + [Output Only] URL of the region where the regional firewall policy + resides. This field is not applicable to global firewall policies. + 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 + FirewallPolicyRule: + id: 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). + type: object + properties: + kind: + description: >- + [Output only] Type of the resource. Returns + compute#firewallPolicyRule for firewall rules and + compute#packetMirroringRule for packet mirroring rules. + default: compute#firewallPolicyRule + type: string + ruleName: + description: >- + An optional name for the rule. This field is not a unique identifier + and can be updated. + type: string + description: + description: An optional description for this resource. + type: string + 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. + type: integer + format: int32 + match: + description: >- + A match condition that incoming traffic is evaluated against. If it + evaluates to true, the corresponding 'action' is enforced. + $ref: '#/components/schemas/FirewallPolicyRuleMatcher' + action: + description: >- + The Action to perform when the client connection triggers the rule. + Valid actions for firewall rules are: "allow", "deny", + "apply_security_profile_group" and "goto_next". Valid actions for + packet mirroring rules are: "mirror", "do_not_mirror" and + "goto_next". + type: string + securityProfileGroup: + description: >- + A fully-qualified URL of a SecurityProfile resource instance. + Example: + https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group + Must be specified if action is one of 'apply_security_profile_group' + or 'mirror'. Cannot be specified for other actions. + type: string + tlsInspect: + description: >- + Boolean flag indicating if the traffic should be TLS decrypted. Can + be set only if action = 'apply_security_profile_group' and cannot be + set for other actions. + type: boolean + direction: + description: The direction in which this rule applies. + type: string + enumDescriptions: + - '' + - '' + enum: + - EGRESS + - INGRESS + 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. + type: array + items: + type: string + 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 + ruleTupleCount: + description: >- + [Output Only] Calculation of the complexity of a single firewall + policy rule. + type: integer + format: int32 + targetServiceAccounts: + description: >- + A list of service accounts indicating the sets of instances that are + applied with this rule. + type: array + items: + type: string + targetSecureTags: + description: >- + A list of secure tags that controls which instances the firewall + rule applies to. If targetSecureTag are specified, then the firewall + rule applies only to instances in the VPC network that have one of + those EFFECTIVE secure tags, if all the target_secure_tag are in + INEFFECTIVE state, then this rule will be ignored. targetSecureTag + may not be set at the same time as targetServiceAccounts. If neither + targetServiceAccounts nor targetSecureTag are specified, the + firewall rule applies to all instances on the specified network. + Maximum number of target label tags allowed is 256. + type: array + items: + $ref: '#/components/schemas/FirewallPolicyRuleSecureTag' + 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 + FirewallPolicyRuleMatcher: + id: FirewallPolicyRuleMatcher + description: >- + Represents a match condition that incoming traffic is evaluated against. + Exactly one field must be specified. + type: object + properties: + srcIpRanges: + description: >- + CIDR IP address range. Maximum number of source CIDR IP ranges + allowed is 5000. + type: array + items: + type: string + destIpRanges: + description: >- + CIDR IP address range. Maximum number of destination CIDR IP ranges + allowed is 5000. + type: array + items: + type: string + layer4Configs: + description: Pairs of IP protocols and ports that the rule should match. + type: array + items: + $ref: '#/components/schemas/FirewallPolicyRuleMatcherLayer4Config' + srcSecureTags: + description: >- + List of secure tag values, which should be matched at the source of + the traffic. For INGRESS rule, if all the srcSecureTag are + INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. + Maximum number of source tag values allowed is 256. + type: array + items: + $ref: '#/components/schemas/FirewallPolicyRuleSecureTag' + destAddressGroups: + description: >- + Address groups which should be matched against the traffic + destination. Maximum number of destination address groups is 10. + type: array + items: + type: string + srcAddressGroups: + description: >- + Address groups which should be matched against the traffic source. + Maximum number of source address groups is 10. + type: array + items: + type: string + srcFqdns: + description: >- + Fully Qualified Domain Name (FQDN) which should be matched against + traffic source. Maximum number of source fqdn allowed is 100. + type: array + items: + type: string + destFqdns: + description: >- + Fully Qualified Domain Name (FQDN) which should be matched against + traffic destination. Maximum number of destination fqdn allowed is + 100. + type: array + items: + type: string + srcRegionCodes: + description: >- + Region codes whose IP addresses will be used to match for source of + traffic. Should be specified as 2 letter country code defined as per + ISO 3166 alpha-2 country codes. ex."US" Maximum number of source + region codes allowed is 5000. + type: array + items: + type: string + destRegionCodes: + description: >- + Region codes whose IP addresses will be used to match for + destination of traffic. Should be specified as 2 letter country code + defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum + number of dest region codes allowed is 5000. + type: array + items: + type: string + destThreatIntelligences: + description: >- + Names of Network Threat Intelligence lists. The IPs in these lists + will be matched against traffic destination. + type: array + items: + type: string + srcThreatIntelligences: + description: >- + Names of Network Threat Intelligence lists. The IPs in these lists + will be matched against traffic source. + type: array + items: + type: string + srcNetworkType: + description: >- + Network type of the traffic source. Allowed values are: - + UNSPECIFIED - INTERNET - INTRA_VPC - NON_INTERNET - VPC_NETWORKS + type: string + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + enum: + - INTERNET + - INTRA_VPC + - NON_INTERNET + - UNSPECIFIED + - VPC_NETWORKS + srcNetworks: + description: >- + Networks of the traffic source. It can be either a full or partial + url. + type: array + items: + type: string + destNetworkType: + description: >- + Network type of the traffic destination. Allowed values are: - + UNSPECIFIED - INTERNET - NON_INTERNET + type: string + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + enum: + - INTERNET + - INTRA_VPC + - NON_INTERNET + - UNSPECIFIED + - VPC_NETWORKS + FirewallPolicyRuleMatcherLayer4Config: + id: FirewallPolicyRuleMatcherLayer4Config + type: object + 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"]. + type: array + items: + type: string + FirewallPolicyRuleSecureTag: + id: FirewallPolicyRuleSecureTag + type: object + properties: + name: + description: Name of the secure tag, created with TagManager's TagValue API. + pattern: tagValues/[0-9]+ + type: string + state: + description: >- + [Output Only] State of the secure tag, either `EFFECTIVE` or + `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or + its network is deleted. + type: string + enumDescriptions: + - '' + - '' + enum: + - EFFECTIVE + - INEFFECTIVE + FirewallPolicyAssociation: + id: FirewallPolicyAssociation + type: object + properties: + name: + description: The name for an association. + type: string + attachmentTarget: + description: The target that the firewall policy is attached to. + type: string + firewallPolicyId: + description: '[Output Only] The firewall policy ID of the association.' + type: string + shortName: + description: >- + [Output Only] The short name of the firewall policy of the + association. + type: string + displayName: + description: >- + [Output Only] Deprecated, please use short name instead. The display + name of the firewall policy of the association. + deprecated: true + type: string + FirewallPoliciesListAssociationsResponse: + id: FirewallPoliciesListAssociationsResponse + type: object + properties: + kind: + description: >- + [Output Only] Type of firewallPolicy associations. Always + compute#FirewallPoliciesListAssociations for lists of firewallPolicy + associations. + default: compute#firewallPoliciesListAssociationsResponse + type: string + associations: + description: A list of associations. + type: array + items: + $ref: '#/components/schemas/FirewallPolicyAssociation' + GlobalOrganizationSetPolicyRequest: + id: GlobalOrganizationSetPolicyRequest + type: object + properties: + 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. + $ref: '#/components/schemas/Policy' + bindings: + description: >- + Flatten Policy to create a backward compatible wire-format. + Deprecated. Use 'policy' to specify bindings. + type: array + items: + $ref: '#/components/schemas/Binding' + etag: + description: >- + Flatten Policy to create a backward compatible wire-format. + Deprecated. Use 'policy' to specify the etag. + type: string + format: byte + NetworkFirewallPolicyAggregatedList: + id: NetworkFirewallPolicyAggregatedList + type: object + properties: + kind: + description: >- + [Output Only] Type of resource. Always + compute#networkFirewallPoliciesAggregatedList for lists of network + firewall policies. + default: compute#networkFirewallPolicyAggregatedList + type: string + id: + description: >- + [Output Only] Unique identifier for the resource; defined by the + server. + type: string + items: + description: A list of FirewallPoliciesScopedList resources. + type: object + additionalProperties: + description: Name of the scope containing this set of addresses. + $ref: '#/components/schemas/FirewallPoliciesScopedList' + nextPageToken: + description: >- + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. + type: string + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string + warning: + description: '[Output Only] Informational warning message.' type: object properties: code: @@ -8096,6 +6839,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -8139,6 +6885,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -8161,6 +6908,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -8197,38 +6945,286 @@ components: [Output Only] A warning data value corresponding to the key. type: string - InstanceList: - id: InstanceList - description: Contains a list of instances. + unreachables: + description: '[Output Only] Unreachable resources.' + type: array + items: + type: string + FirewallPoliciesScopedList: + id: FirewallPoliciesScopedList type: object properties: - kind: - description: >- - [Output Only] Type of resource. Always compute#instanceList for - lists of Instance resources. - default: compute#instanceList - type: string - id: - description: >- - [Output Only] Unique identifier for the resource; defined by the - server. - type: string - items: - description: A list of Instance resources. + firewallPolicies: + description: A list of firewall policies contained in this scope. type: array items: - $ref: '#/components/schemas/Instance' - nextPageToken: + $ref: '#/components/schemas/FirewallPolicy' + warning: description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than + Informational warning which replaces the list of firewall policies + when the list is empty. + type: object + properties: + code: + description: >- + [Output Only] A warning code, if applicable. For example, + Compute Engine returns NO_RESULTS_ON_PAGE if there are no + results in the response. + type: string + enumDescriptions: + - >- + Warning about failed cleanup of transient changes made by a + failed operation. + - A link to a deprecated resource was created. + - >- + When deploying and at least one of the resources has a type + marked as deprecated + - The user created a boot disk that is larger than image size. + - >- + When deploying and at least one of the resources has a type + marked as experimental + - Warning that is present in an external api call + - >- + Warning that value of a field has been overridden. Deprecated + unused field. + - >- + The operation involved use of an injected kernel, which is + deprecated. + - >- + A WEIGHTED_MAGLEV backend service is associated with a health + check that is not of type HTTP/HTTPS/HTTP2. + - >- + When deploying a deployment with a exceedingly large number of + resources + - >- + Resource can't be retrieved due to list overhead quota exceed + which captures the amount of resources filtered out by + user-defined list filter. + - A resource depends on a missing type + - >- + The route's nextHopIp address is not assigned to an instance + on the network. + - The route's next hop instance cannot ip forward. + - >- + The route's nextHopInstance URL refers to an instance that + does not have an ipv6 interface on the same network as the + route. + - >- + The route's nextHopInstance URL refers to an instance that + does not exist. + - >- + The route's nextHopInstance URL refers to an instance that is + not on the same network as the route. + - >- + The route's next hop instance does not have a status of + RUNNING. + - >- + Error which is not critical. We decided to continue the + process despite the mentioned error. + - No results are present on a particular list page. + - >- + Success is reported, but some results may be missing due to + errors + - >- + Quota information is not available to client requests (e.g: + regions.list). + - >- + The user attempted to use a resource that requires a TOS they + have not accepted. + - Warning that a resource is in use. + - >- + One or more of the resources set to auto-delete could not be + deleted because they were in use. + - When a resource schema validation is ignored. + - >- + Instance template used in instance group manager is valid as + such, but its application does not make a lot of sense, + because it allows only single instance in instance group. + - When undeclared properties in the schema are present + - A given scope cannot be reached. + enumDeprecated: + - false + - false + - false + - false + - false + - false + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + enum: + - CLEANUP_FAILED + - DEPRECATED_RESOURCE_USED + - DEPRECATED_TYPE_USED + - DISK_SIZE_LARGER_THAN_IMAGE_SIZE + - EXPERIMENTAL_TYPE_USED + - EXTERNAL_API_WARNING + - FIELD_VALUE_OVERRIDEN + - INJECTED_KERNELS_DEPRECATED + - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB + - LARGE_DEPLOYMENT_WARNING + - LIST_OVERHEAD_QUOTA_EXCEED + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE + - NEXT_HOP_INSTANCE_NOT_FOUND + - NEXT_HOP_INSTANCE_NOT_ON_NETWORK + - NEXT_HOP_NOT_RUNNING + - NOT_CRITICAL_ERROR + - NO_RESULTS_ON_PAGE + - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE + - REQUIRED_TOS_AGREEMENT + - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING + - RESOURCE_NOT_DELETED + - SCHEMA_VALIDATION_IGNORED + - SINGLE_INSTANCE_PROPERTY_TEMPLATE + - UNDECLARED_PROPERTIES + - UNREACHABLE + message: + description: '[Output Only] A human-readable description of the warning code.' + type: string + data: + description: >- + [Output Only] Metadata about this warning in key: value format. + For example: "data": [ { "key": "scope", "value": + "zones/us-east1-d" } + type: array + items: + type: object + properties: + key: + description: >- + [Output Only] A key that provides more detail on the + warning being returned. For example, for warnings where + there are no results in a list request for a particular + zone, this key might be scope and the key value might be + the zone name. Other examples might be a key indicating a + deprecated resource and a suggested replacement, or a + warning about invalid network settings (for example, if an + instance attempts to perform IP forwarding but is not + enabled for IP forwarding). + type: string + value: + description: >- + [Output Only] A warning data value corresponding to the + key. + type: string + RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse: + id: RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse + type: object + properties: + firewalls: + description: Effective firewalls on the network. + type: array + items: + $ref: '#/components/schemas/Firewall' + firewallPolicys: + description: >- + [Output only] Effective firewalls from firewall policy. It applies + to Regional Network Firewall Policies in the specified region, + Global Network Firewall Policies and Hierachial Firewall Policies + which are associated with the network. + type: array + items: + $ref: >- + #/components/schemas/RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy + RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy: + id: >- + RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy + type: object + properties: + name: + description: '[Output Only] The name of the firewall policy.' + type: string + type: + description: >- + [Output Only] The type of the firewall policy. Can be one of + HIERARCHY, NETWORK, NETWORK_REGIONAL, SYSTEM_GLOBAL, + SYSTEM_REGIONAL. + type: string + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + enum: + - HIERARCHY + - NETWORK + - NETWORK_REGIONAL + - SYSTEM_GLOBAL + - SYSTEM_REGIONAL + - UNSPECIFIED + displayName: + description: '[Output Only] The display name of the firewall policy.' + type: string + rules: + description: '[Output only] The rules that apply to the network.' + type: array + items: + $ref: '#/components/schemas/FirewallPolicyRule' + packetMirroringRules: + description: '[Output only] The packet mirroring rules that apply to the network.' + type: array + items: + $ref: '#/components/schemas/FirewallPolicyRule' + priority: + description: >- + [Output only] Priority of firewall policy association. Not + applicable for type=HIERARCHY. + type: integer + format: int32 + SecurityPolicyList: + id: SecurityPolicyList + type: object + properties: + kind: + description: >- + [Output Only] Type of resource. Always compute#securityPolicyList + for listsof securityPolicies + default: compute#securityPolicyList + type: string + id: + description: >- + [Output Only] Unique identifier for the resource; defined by the + server. + type: string + items: + description: A list of SecurityPolicy resources. + type: array + items: + $ref: '#/components/schemas/SecurityPolicy' + nextPageToken: + description: >- + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. type: string - selfLink: - description: '[Output Only] Server-defined URL for this resource.' - type: string warning: description: '[Output Only] Informational warning message.' type: object @@ -8293,6 +7289,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -8336,6 +7335,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -8358,6 +7358,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -8394,19 +7395,32 @@ components: [Output Only] A warning data value corresponding to the key. type: string - Instance: - id: Instance + SecurityPolicy: + id: SecurityPolicy 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. + 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. type: object properties: + userDefinedFields: + description: >- + Definitions of user-defined fields for CLOUD_ARMOR_NETWORK policies. + A user-defined field consists of up to 4 bytes extracted from a + fixed offset in the packet, relative to the IPv4, IPv6, TCP, or UDP + header, with an optional mask to select certain bits. Rules may then + specify matching values for these fields. Example: + userDefinedFields: - name: "ipv4_fragment_offset" base: IPV4 offset: + 6 size: 2 mask: "0x1fff" + type: array + items: + $ref: '#/components/schemas/SecurityPolicyUserDefinedField' kind: description: >- - [Output Only] Type of the resource. Always compute#instance for - instances. - default: compute#instance + [Output only] Type of the resource. Always compute#securityPolicyfor + security policies + default: compute#securityPolicy type: string id: description: >- @@ -8419,1498 +7433,1034 @@ components: 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. + 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])?' - annotations: - required: - - compute.instances.insert type: string description: description: >- An optional description of this resource. Provide this property when you create the resource. type: string - 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. - $ref: '#/components/schemas/Tags' - 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 - 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. - type: string - enumDescriptions: - - >- - The instance is halted and we are performing tear down tasks like - network deprogramming, releasing quota, IP, tearing down disks - etc. - - Resources are being allocated for the instance. - - The instance is in repair. - - The instance is running. - - >- - All required resources have been allocated and the instance is - being started. - - The instance has stopped successfully. - - >- - The instance is currently stopping (either being deleted or - killed). - - The instance has suspended. - - The instance is suspending. - - >- - The instance has stopped (either by explicit action or underlying - failure). - enum: - - DEPROVISIONING - - PROVISIONING - - REPAIRING - - RUNNING - - STAGING - - STOPPED - - STOPPING - - SUSPENDED - - SUSPENDING - - TERMINATED - statusMessage: - description: '[Output Only] An optional, human-readable explanation of the status.' - type: string - 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 - 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 - 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. - type: array - items: - $ref: '#/components/schemas/NetworkInterface' - disks: + rules: description: >- - Array of disks associated with this instance. Persistent disks must - be created before you can assign them. + A list of rules that belong to this policy. There must always be a + default rule which is a rule with priority 2147483647 and match all + condition (for the match condition this means match "*" for + srcIpRanges and for the networkMatch condition every field must be + either match "*" or not set). If no rules are provided when creating + a security policy, a default rule with action "allow" will be added. type: array items: - $ref: '#/components/schemas/AttachedDisk' - metadata: - description: >- - The metadata key/value pairs assigned to this instance. This - includes custom metadata and predefined keys. - $ref: '#/components/schemas/Metadata' - serviceAccounts: + $ref: '#/components/schemas/SecurityPolicyRule' + adaptiveProtectionConfig: + $ref: '#/components/schemas/SecurityPolicyAdaptiveProtectionConfig' + ddosProtectionConfig: + $ref: '#/components/schemas/SecurityPolicyDdosProtectionConfig' + advancedOptionsConfig: + $ref: '#/components/schemas/SecurityPolicyAdvancedOptionsConfig' + recaptchaOptionsConfig: + $ref: '#/components/schemas/SecurityPolicyRecaptchaOptionsConfig' + fingerprint: 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. - type: array - items: - $ref: '#/components/schemas/ServiceAccount' + 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. + type: string + format: byte selfLink: - description: '[Output Only] Server-defined URL for this resource.' + description: '[Output Only] Server-defined URL for the resource.' type: string - scheduling: - description: Sets the scheduling options for this instance. - $ref: '#/components/schemas/Scheduling' - cpuPlatform: - description: '[Output Only] The CPU platform used by this instance.' + type: + description: >- + The type indicates the intended use of the security policy. - + CLOUD_ARMOR: Cloud Armor backend security policies can be configured + to filter incoming HTTP requests targeting backend services. They + filter requests before they hit the origin servers. - + CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be + configured to filter incoming HTTP requests targeting backend + services (including Cloud CDN-enabled) as well as backend buckets + (Cloud Storage). They filter requests before the request is served + from Google's cache. - CLOUD_ARMOR_INTERNAL_SERVICE (preview only): + Cloud Armor internal service policies can be configured to filter + HTTP requests targeting services managed by Traffic Director in a + service mesh. They filter requests before the request is served from + the application. - CLOUD_ARMOR_NETWORK: Cloud Armor network policies + can be configured to filter packets targeting network load balancing + resources such as backend services, target pools, target instances, + and instances with external IPs. They filter requests before the + request is served from the application. This field can be set only + at resource creation time. type: string + enumDescriptions: + - '' + - '' + - '' + enum: + - CLOUD_ARMOR + - CLOUD_ARMOR_EDGE + - CLOUD_ARMOR_NETWORK labels: description: >- - Labels to apply to this instance. These can be later modified by the - setLabels method. + 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 additionalProperties: type: string - params: - description: >- - Input only. [Input Only] Additional params passed with the request, - but not persisted as part of resource payload. - $ref: '#/components/schemas/InstanceParams' 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. + A fingerprint for the labels being applied to this security policy, + 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. To see the latest fingerprint, make get() request to + the security policy. type: string format: byte - instanceEncryptionKey: - description: >- - Encrypts suspended data for an instance with a customer-managed - encryption key. If you are creating a new instance, this field will - encrypt the local SSD and in-memory contents of the instance during - the suspend operation. If you do not provide an encryption key when - creating the instance, then the local SSD and in-memory contents - will be encrypted using an automatically generated key during the - suspend operation. - $ref: '#/components/schemas/CustomerEncryptionKey' - minCpuPlatform: + region: 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". + [Output Only] URL of the region where the regional security policy + resides. This field is not applicable to global security policies. type: string - guestAccelerators: - description: >- - A list of the type and count of accelerator cards attached to the - instance. - type: array - items: - $ref: '#/components/schemas/AcceleratorConfig' - startRestricted: - description: >- - [Output Only] Whether a VM has been restricted for start because - Compute Engine has detected suspicious activity. - type: boolean - deletionProtection: - description: Whether the resource should be protected against deletion. - type: boolean - resourcePolicies: - description: Resource policies applied to this instance. - type: array - items: - type: string - sourceMachineImage: - description: Source machine image + SecurityPolicyUserDefinedField: + id: SecurityPolicyUserDefinedField + type: object + properties: + name: + description: The name of this field. Must be unique within the policy. type: string - reservationAffinity: - description: Specifies the reservations that this instance can consume from. - $ref: '#/components/schemas/ReservationAffinity' - hostname: + base: 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. + The base relative to which 'offset' is measured. Possible values + are: - IPV4: Points to the beginning of the IPv4 header. - IPV6: + Points to the beginning of the IPv6 header. - TCP: Points to the + beginning of the TCP header, skipping over any IPv4 options or IPv6 + extension headers. Not present for non-first fragments. - UDP: + Points to the beginning of the UDP header, skipping over any IPv4 + options or IPv6 extension headers. Not present for non-first + fragments. required type: string - displayDevice: - description: Enables display device for the instance. - $ref: '#/components/schemas/DisplayDevice' - shieldedInstanceConfig: - $ref: '#/components/schemas/ShieldedInstanceConfig' - shieldedInstanceIntegrityPolicy: - $ref: '#/components/schemas/ShieldedInstanceIntegrityPolicy' - sourceMachineImageEncryptionKey: + enumDescriptions: + - '' + - '' + - '' + - '' + enum: + - IPV4 + - IPV6 + - TCP + - UDP + offset: description: >- - Source machine image encryption key when creating an instance from a - machine image. - $ref: '#/components/schemas/CustomerEncryptionKey' - confidentialInstanceConfig: - $ref: '#/components/schemas/ConfidentialInstanceConfig' - fingerprint: + Offset of the first byte of the field (in network byte order) + relative to 'base'. + type: integer + format: int32 + size: + description: 'Size of the field in bytes. Valid values: 1-4.' + type: integer + format: int32 + mask: 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. + If specified, apply this mask (bitwise AND) to the field to ignore + bits before matching. Encoded as a hexadecimal number (starting with + "0x"). The last byte of the field (in network byte order) + corresponds to the least significant byte of the mask. type: string - format: byte - privateIpv6GoogleAccess: + SecurityPolicyRule: + id: 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). + type: object + properties: + kind: description: >- - The private IPv6 google access type for the VM. If not specified, - use INHERIT_FROM_SUBNETWORK as default. - type: string - enumDescriptions: - - >- - Bidirectional private IPv6 access to/from Google services. If - specified, the subnetwork who is attached to the instance's - default network interface will be assigned an internal IPv6 prefix - if it doesn't have before. - - >- - Outbound private IPv6 access from VMs in this subnet to Google - services. If specified, the subnetwork who is attached to the - instance's default network interface will be assigned an internal - IPv6 prefix if it doesn't have before. - - >- - Each network interface inherits PrivateIpv6GoogleAccess from its - subnetwork. - enum: - - ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE - - ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE - - INHERIT_FROM_SUBNETWORK - advancedMachineFeatures: - description: Controls for advanced machine-related behavior features. - $ref: '#/components/schemas/AdvancedMachineFeatures' - lastStartTimestamp: - description: '[Output Only] Last start timestamp in RFC3339 text format.' + [Output only] Type of the resource. Always + compute#securityPolicyRule for security policy rules + default: compute#securityPolicyRule type: string - lastStopTimestamp: - description: '[Output Only] Last stop timestamp in RFC3339 text format.' + description: + description: >- + An optional description of this resource. Provide this property when + you create the resource. type: string - lastSuspendedTimestamp: - description: '[Output Only] Last suspended timestamp in RFC3339 text format.' + 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. + type: integer + format: int32 + match: + description: >- + A match condition that incoming traffic is evaluated against. If it + evaluates to true, the corresponding 'action' is enforced. + $ref: '#/components/schemas/SecurityPolicyRuleMatcher' + networkMatch: + description: >- + A match condition that incoming packets are evaluated against for + CLOUD_ARMOR_NETWORK security policies. If it matches, the + corresponding 'action' is enforced. The match criteria for a rule + consists of built-in match fields (like 'srcIpRanges') and + potentially multiple user-defined match fields + ('userDefinedFields'). Field values may be extracted directly from + the packet or derived from it (e.g. 'srcRegionCodes'). Some fields + may not be present in every packet (e.g. 'srcPorts'). A user-defined + field is only present if the base header is found in the packet and + the entire field is in bounds. Each match field may specify which + values can match it, listing one or more ranges, prefixes, or exact + values that are considered a match for the field. A field value must + be present in order to match a specified match field. If no match + values are specified for a match field, then any field value is + considered to match it, and it's not required to be present. For + strings specifying '*' is also equivalent to match all. For a packet + to match a rule, all specified match fields must match the + corresponding field values derived from the packet. Example: + networkMatch: srcIpRanges: - "192.0.2.0/24" - "198.51.100.0/24" + userDefinedFields: - name: "ipv4_fragment_offset" values: - + "1-0x1fff" The above match condition matches packets with a source + IP in 192.0.2.0/24 or 198.51.100.0/24 and a user-defined field named + "ipv4_fragment_offset" with a value between 1 and 0x1fff inclusive. + $ref: '#/components/schemas/SecurityPolicyRuleNetworkMatcher' + action: + description: >- + The Action to perform when the rule is matched. The following are + the valid actions: - allow: allow access to target. - deny(STATUS): + deny access to target, returns the HTTP response code specified. + Valid values for `STATUS` are 403, 404, and 502. - rate_based_ban: + limit client traffic to the configured threshold and ban the client + if the traffic exceeds the threshold. Configure parameters for this + action in RateLimitOptions. Requires rate_limit_options to be set. - + redirect: redirect to a different target. This can either be an + internal reCAPTCHA redirect, or an external URL-based redirect via a + 302 response. Parameters for this action can be configured via + redirectOptions. This action is only supported in Global Security + Policies of type CLOUD_ARMOR. - throttle: limit client traffic to + the configured threshold. Configure parameters for this action in + rateLimitOptions. Requires rate_limit_options to be set for this. - + fairshare (preview only): when traffic reaches the threshold limit, + requests from the clients matching this rule begin to be + rate-limited using the Fair Share algorithm. This action is only + allowed in security policies of type + `CLOUD_ARMOR_INTERNAL_SERVICE`. type: string - satisfiesPzs: - description: '[Output Only] Reserved for future use.' - type: boolean - satisfiesPzi: - description: '[Output Only] Reserved for future use.' + preview: + description: If set to true, the specified action is not enforced. type: boolean - resourceStatus: + rateLimitOptions: description: >- - [Output Only] Specifies values set for instance attributes as - compared to the values requested by user in the corresponding input - only field. - $ref: '#/components/schemas/ResourceStatus' - networkPerformanceConfig: - $ref: '#/components/schemas/NetworkPerformanceConfig' - keyRevocationActionType: + Must be specified if the action is "rate_based_ban" or "throttle" or + "fairshare". Cannot be specified for any other actions. + $ref: '#/components/schemas/SecurityPolicyRuleRateLimitOptions' + headerAction: description: >- - KeyRevocationActionType of the instance. Supported options are - "STOP" and "NONE". The default value is "NONE" if it is not - specified. + Optional, additional actions that are performed on headers. This + field is only supported in Global Security Policies of type + CLOUD_ARMOR. + $ref: '#/components/schemas/SecurityPolicyRuleHttpHeaderAction' + redirectOptions: + description: >- + Parameters defining the redirect action. Cannot be specified for any + other actions. This field is only supported in Global Security + Policies of type CLOUD_ARMOR. + $ref: '#/components/schemas/SecurityPolicyRuleRedirectOptions' + preconfiguredWafConfig: + description: >- + Preconfigured WAF configuration to be applied for the rule. If the + rule does not evaluate preconfigured WAF rules, i.e., if + evaluatePreconfiguredWaf() is not used, this field will have no + effect. + $ref: '#/components/schemas/SecurityPolicyRulePreconfiguredWafConfig' + SecurityPolicyRuleMatcher: + id: SecurityPolicyRuleMatcher + description: >- + Represents a match condition that incoming traffic is evaluated against. + Exactly one field must be specified. + type: object + properties: + 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. Expressions containing + `evaluateThreatIntelligence` require Cloud Armor Managed Protection + Plus tier and are not supported in Edge Policies nor in Regional + Policies. Expressions containing + `evaluatePreconfiguredExpr('sourceiplist-*')` require Cloud Armor + Managed Protection Plus tier and are only supported in Global + Security Policies. + $ref: '#/components/schemas/Expr' + exprOptions: + description: >- + The configuration options available when specifying a user defined + CEVAL expression (i.e., 'expr'). + $ref: '#/components/schemas/SecurityPolicyRuleMatcherExprOptions' + 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. type: string enumDescriptions: - - Default value. This value is unused. - - Indicates user chose no operation. - - Indicates user chose to opt for VM shutdown on key revocation. + - >- + Matches the source IP address of a request to the IP ranges + supplied in config. enum: - - KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED - - NONE - - STOP - Tags: - id: Tags - description: A set of instance tags. + - SRC_IPS_V1 + config: + 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. + $ref: '#/components/schemas/SecurityPolicyRuleMatcherConfig' + SecurityPolicyRuleMatcherExprOptions: + id: SecurityPolicyRuleMatcherExprOptions type: object properties: - items: + recaptchaOptions: description: >- - An array of tags. Each tag must be 1-63 characters long, and comply - with RFC1035. - pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + reCAPTCHA configuration options to be applied for the rule. If the + rule does not evaluate reCAPTCHA tokens, this field has no effect. + $ref: >- + #/components/schemas/SecurityPolicyRuleMatcherExprOptionsRecaptchaOptions + SecurityPolicyRuleMatcherExprOptionsRecaptchaOptions: + id: SecurityPolicyRuleMatcherExprOptionsRecaptchaOptions + type: object + properties: + actionTokenSiteKeys: + description: >- + A list of site keys to be used during the validation of reCAPTCHA + action-tokens. The provided site keys need to be created from + reCAPTCHA API under the same project where the security policy is + created. type: array items: type: string - fingerprint: + sessionTokenSiteKeys: 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. - type: string - format: byte - NetworkInterface: - id: NetworkInterface - description: A network interface resource attached to an instance. + A list of site keys to be used during the validation of reCAPTCHA + session-tokens. The provided site keys need to be created from + reCAPTCHA API under the same project where the security policy is + created. + type: array + items: + type: string + SecurityPolicyRuleMatcherConfig: + id: SecurityPolicyRuleMatcherConfig type: object properties: - kind: + srcIpRanges: description: >- - [Output Only] Type of the resource. Always compute#networkInterface - for network interfaces. - default: compute#networkInterface - type: string - network: + CIDR IP address range. Maximum number of src_ip_ranges allowed is + 10. + type: array + items: + type: string + SecurityPolicyRuleNetworkMatcher: + id: SecurityPolicyRuleNetworkMatcher + description: >- + Represents a match condition that incoming network traffic is evaluated + against. + type: object + properties: + userDefinedFields: description: >- - URL of the VPC 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 selected - project doesn't have the default network, you must specify a network - or subnet. 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 - subnetwork: + User-defined fields. Each element names a defined field and lists + the matching values for that field. + type: array + items: + $ref: >- + #/components/schemas/SecurityPolicyRuleNetworkMatcherUserDefinedFieldMatch + srcIpRanges: 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 - networkIP: + Source IPv4/IPv6 addresses or CIDR prefixes, in standard text + format. + type: array + items: + type: string + destIpRanges: 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 - ipv6Address: + Destination IPv4/IPv6 addresses or CIDR prefixes, in standard text + format. + type: array + items: + type: string + ipProtocols: description: >- - An IPv6 internal network address for this network interface. To use - a static internal IP address, it must be unused and in the same - region as the instance's zone. If not specified, Google Cloud will - automatically assign an internal IPv6 address from the instance's - subnetwork. - type: string - internalIpv6PrefixLength: - description: The prefix length of the primary internal IPv6 range. - type: integer - format: int32 - name: + IPv4 protocol / IPv6 next header (after extension headers). Each + element can be an 8-bit unsigned decimal number (e.g. "6"), range + (e.g. "253-254"), or one of the following protocol names: "tcp", + "udp", "icmp", "esp", "ah", "ipip", or "sctp". + type: array + items: + type: string + srcPorts: description: >- - [Output Only] The name of the network interface, which is generated - by the server. For a VM, the network interface uses the nicN naming - format. Where N is a value between 0 and 7. The default interface - value is nic0. - type: string - accessConfigs: + Source port numbers for TCP/UDP/SCTP. Each element can be a 16-bit + unsigned decimal number (e.g. "80") or range (e.g. "0-1023"). + type: array + items: + type: string + destPorts: 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. + Destination port numbers for TCP/UDP/SCTP. Each element can be a + 16-bit unsigned decimal number (e.g. "80") or range (e.g. "0-1023"). type: array items: - $ref: '#/components/schemas/AccessConfig' - ipv6AccessConfigs: + type: string + srcRegionCodes: 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. + Two-letter ISO 3166-1 alpha-2 country code associated with the + source IP address. type: array items: - $ref: '#/components/schemas/AccessConfig' - aliasIpRanges: + type: string + srcAsns: + description: BGP Autonomous System Number associated with the source IP address. + type: array + items: + type: integer + format: uint32 + SecurityPolicyRuleNetworkMatcherUserDefinedFieldMatch: + id: SecurityPolicyRuleNetworkMatcherUserDefinedFieldMatch + type: object + properties: + name: + description: Name of the user-defined field, as given in the definition. + type: string + values: description: >- - An array of alias IP ranges for this network interface. You can only - specify this field for network interfaces in VPC networks. + Matching values of the field. Each element can be a 32-bit unsigned + decimal or hexadecimal (starting with "0x") number (e.g. "64") or + range (e.g. "0x400-0x7ff"). type: array items: - $ref: '#/components/schemas/AliasIpRange' - fingerprint: + type: string + SecurityPolicyRuleRateLimitOptions: + id: SecurityPolicyRuleRateLimitOptions + type: object + properties: + rateLimitThreshold: + description: Threshold at which to begin ratelimiting. + $ref: '#/components/schemas/SecurityPolicyRuleRateLimitOptionsThreshold' + conformAction: 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. + Action to take for requests that are under the configured rate limit + threshold. Valid option is "allow" only. type: string - format: byte - stackType: + exceedAction: description: >- - The stack type for this network interface. To assign only IPv4 - addresses, use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, - use IPV4_IPV6. If not specified, IPV4_ONLY is used. This field can - be both set at instance creation and update network interface - operations. + Action to take for requests that are above the configured rate limit + threshold, to either deny with a specified HTTP response code, or + redirect to a different endpoint. Valid options are `deny(STATUS)`, + where valid values for `STATUS` are 403, 404, 429, and 502, and + `redirect`, where the redirect parameters come from + `exceedRedirectOptions` below. The `redirect` action is only + supported in Global Security Policies of type CLOUD_ARMOR. type: string - enumDescriptions: - - The network interface can have both IPv4 and IPv6 addresses. - - The network interface will only be assigned IPv4 addresses. - - The network interface will only be assigned IPv6 addresses. - enum: - - IPV4_IPV6 - - IPV4_ONLY - - IPV6_ONLY - ipv6AccessType: + exceedRedirectOptions: 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. - type: string - enumDescriptions: - - This network interface can have external IPv6. - - This network interface can have internal IPv6. - enum: - - EXTERNAL - - INTERNAL - queueCount: + Parameters defining the redirect action that is used as the exceed + action. Cannot be specified if the exceed action is not redirect. + This field is only supported in Global Security Policies of type + CLOUD_ARMOR. + $ref: '#/components/schemas/SecurityPolicyRuleRedirectOptions' + enforceOnKey: 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. + Determines the key to enforce the rate_limit_threshold on. Possible + values are: - ALL: A single rate limit threshold is applied to all + the requests matching this rule. This is the default value if + "enforceOnKey" is not configured. - IP: The source IP address of the + request is the key. Each IP has this limit enforced separately. - + HTTP_HEADER: The value of the HTTP header whose name is configured + under "enforceOnKeyName". The key value is truncated to the first + 128 bytes of the header value. If no such header is present in the + request, the key type defaults to ALL. - XFF_IP: The first IP + address (i.e. the originating client IP address) specified in the + list of IPs under X-Forwarded-For HTTP header. If no such header is + present or the value is not a valid IP, the key defaults to the + source IP address of the request i.e. key type IP. - HTTP_COOKIE: + The value of the HTTP cookie whose name is configured under + "enforceOnKeyName". The key value is truncated to the first 128 + bytes of the cookie value. If no such cookie is present in the + request, the key type defaults to ALL. - HTTP_PATH: The URL path of + the HTTP request. The key value is truncated to the first 128 bytes. + - SNI: Server name indication in the TLS session of the HTTPS + request. The key value is truncated to the first 128 bytes. The key + type defaults to ALL on a HTTP session. - REGION_CODE: The + country/region from which the request originates. - + TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the client connects + using HTTPS, HTTP/2 or HTTP/3. If not available, the key type + defaults to ALL. - USER_IP: The IP address of the originating + client, which is resolved based on "userIpRequestHeaders" configured + with the security policy. If there is no "userIpRequestHeaders" + configuration or an IP address cannot be resolved from it, the key + type defaults to IP. - TLS_JA4_FINGERPRINT: JA4 TLS/SSL fingerprint + if the client connects using HTTPS, HTTP/2 or HTTP/3. If not + available, the key type defaults to ALL. For "fairshare" action, + this value is limited to ALL i.e. a single rate limit threshold is + enforced for all the requests matching the rule. + type: string + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + enum: + - ALL + - HTTP_COOKIE + - HTTP_HEADER + - HTTP_PATH + - IP + - REGION_CODE + - SNI + - TLS_JA3_FINGERPRINT + - TLS_JA4_FINGERPRINT + - USER_IP + - XFF_IP + enforceOnKeyName: + description: >- + Rate limit key name applicable only for the following key types: + HTTP_HEADER -- Name of the HTTP header whose value is taken as the + key value. HTTP_COOKIE -- Name of the HTTP cookie whose value is + taken as the key value. + type: string + enforceOnKeyConfigs: + description: >- + If specified, any combination of values of + enforce_on_key_type/enforce_on_key_name is treated as the key on + which ratelimit threshold/action is enforced. You can specify up to + 3 enforce_on_key_configs. If enforce_on_key_configs is specified, + enforce_on_key must not be specified. + type: array + items: + $ref: >- + #/components/schemas/SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig + banThreshold: + description: >- + Can only be specified if the action for the rule is + "rate_based_ban". If specified, the key will be banned for the + configured 'ban_duration_sec' when the number of requests that + exceed the 'rate_limit_threshold' also exceed this 'ban_threshold'. + $ref: '#/components/schemas/SecurityPolicyRuleRateLimitOptionsThreshold' + banDurationSec: + description: >- + Can only be specified if the action for the rule is + "rate_based_ban". If specified, determines the time (in seconds) the + traffic will continue to be banned by the rate limit after the rate + falls below the threshold. type: integer format: int32 - nicType: + SecurityPolicyRuleRateLimitOptionsThreshold: + id: SecurityPolicyRuleRateLimitOptionsThreshold + type: object + properties: + count: + description: Number of HTTP(S) requests for calculating the threshold. + type: integer + format: int32 + intervalSec: + description: Interval over which the threshold is computed. + type: integer + format: int32 + SecurityPolicyRuleRedirectOptions: + id: SecurityPolicyRuleRedirectOptions + type: object + properties: + type: description: >- - The type of vNIC to be used on this interface. This may be gVNIC or - VirtioNet. + Type of the redirect action. Possible values are: - + GOOGLE_RECAPTCHA: redirect to reCAPTCHA for manual challenge + assessment. - EXTERNAL_302: redirect to a different URL via a 302 + response. type: string enumDescriptions: - - GVNIC - - IDPF - - No type specified. - - VIRTIO + - '' + - '' enum: - - GVNIC - - IDPF - - UNSPECIFIED_NIC_TYPE - - VIRTIO_NET - networkAttachment: + - EXTERNAL_302 + - GOOGLE_RECAPTCHA + target: description: >- - The URL of the network attachment that this interface should connect - to in the following format: - projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}. + Target for the redirect action. This is required if the type is + EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA. type: string - AccessConfig: - id: AccessConfig - description: >- - An access configuration attached to an instance's network interface. - Only one access config per instance is supported. + SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig: + id: SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig type: object properties: - kind: - description: >- - [Output Only] Type of the resource. Always compute#accessConfig for - access configs. - default: compute#accessConfig - type: string - type: + enforceOnKeyType: description: >- - The type of configuration. In accessConfigs (IPv4), the default and - only option is ONE_TO_ONE_NAT. In ipv6AccessConfigs, the default and - only option is DIRECT_IPV6. + Determines the key to enforce the rate_limit_threshold on. Possible + values are: - ALL: A single rate limit threshold is applied to all + the requests matching this rule. This is the default value if + "enforceOnKeyConfigs" is not configured. - IP: The source IP address + of the request is the key. Each IP has this limit enforced + separately. - HTTP_HEADER: The value of the HTTP header whose name + is configured under "enforceOnKeyName". The key value is truncated + to the first 128 bytes of the header value. If no such header is + present in the request, the key type defaults to ALL. - XFF_IP: The + first IP address (i.e. the originating client IP address) specified + in the list of IPs under X-Forwarded-For HTTP header. If no such + header is present or the value is not a valid IP, the key defaults + to the source IP address of the request i.e. key type IP. - + HTTP_COOKIE: The value of the HTTP cookie whose name is configured + under "enforceOnKeyName". The key value is truncated to the first + 128 bytes of the cookie value. If no such cookie is present in the + request, the key type defaults to ALL. - HTTP_PATH: The URL path of + the HTTP request. The key value is truncated to the first 128 bytes. + - SNI: Server name indication in the TLS session of the HTTPS + request. The key value is truncated to the first 128 bytes. The key + type defaults to ALL on a HTTP session. - REGION_CODE: The + country/region from which the request originates. - + TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the client connects + using HTTPS, HTTP/2 or HTTP/3. If not available, the key type + defaults to ALL. - USER_IP: The IP address of the originating + client, which is resolved based on "userIpRequestHeaders" configured + with the security policy. If there is no "userIpRequestHeaders" + configuration or an IP address cannot be resolved from it, the key + type defaults to IP. - TLS_JA4_FINGERPRINT: JA4 TLS/SSL fingerprint + if the client connects using HTTPS, HTTP/2 or HTTP/3. If not + available, the key type defaults to ALL. type: string enumDescriptions: - '' - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' enum: - - DIRECT_IPV6 - - ONE_TO_ONE_NAT - name: + - ALL + - HTTP_COOKIE + - HTTP_HEADER + - HTTP_PATH + - IP + - REGION_CODE + - SNI + - TLS_JA3_FINGERPRINT + - TLS_JA4_FINGERPRINT + - USER_IP + - XFF_IP + enforceOnKeyName: description: >- - The name of this access configuration. In accessConfigs (IPv4), the - default and recommended name is External NAT, but you can use any - arbitrary string, such as My external IP or Network Access. In - ipv6AccessConfigs, the recommend name is External IPv6. + Rate limit key name applicable only for the following key types: + HTTP_HEADER -- Name of the HTTP header whose value is taken as the + key value. HTTP_COOKIE -- Name of the HTTP cookie whose value is + taken as the key value. type: string - natIP: + SecurityPolicyRuleHttpHeaderAction: + id: SecurityPolicyRuleHttpHeaderAction + type: object + properties: + requestHeadersToAdds: description: >- - Applies to accessConfigs (IPv4) only. 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. + The list of request headers to add or overwrite if they're already + present. + type: array + items: + $ref: >- + #/components/schemas/SecurityPolicyRuleHttpHeaderActionHttpHeaderOption + SecurityPolicyRuleHttpHeaderActionHttpHeaderOption: + id: SecurityPolicyRuleHttpHeaderActionHttpHeaderOption + type: object + properties: + headerName: + description: The name of the header to set. type: string - externalIpv6: - description: >- - Applies to ipv6AccessConfigs only. The first IPv6 address of the - external IPv6 range associated with this instance, prefix length is - stored in externalIpv6PrefixLength in ipv6AccessConfig. To use a - static external IP address, it must be unused and in the same region - as the instance's zone. If not specified, Google Cloud will - automatically assign an external IPv6 address from the instance's - subnetwork. + headerValue: + description: The value to set the named header to. type: string - externalIpv6PrefixLength: + SecurityPolicyRulePreconfiguredWafConfig: + id: SecurityPolicyRulePreconfiguredWafConfig + type: object + properties: + exclusions: + description: A list of exclusions to apply during preconfigured WAF evaluation. + type: array + items: + $ref: >- + #/components/schemas/SecurityPolicyRulePreconfiguredWafConfigExclusion + SecurityPolicyRulePreconfiguredWafConfigExclusion: + id: SecurityPolicyRulePreconfiguredWafConfigExclusion + type: object + properties: + targetRuleSet: + description: Target WAF rule set to apply the preconfigured WAF exclusion. + type: string + targetRuleIds: description: >- - Applies to ipv6AccessConfigs only. The prefix length of the external - IPv6 range. - type: integer - format: int32 - setPublicPtr: + A list of target rule IDs under the WAF rule set to apply the + preconfigured WAF exclusion. If omitted, it refers to all the rule + IDs under the WAF rule set. + type: array + items: + type: string + requestHeadersToExclude: 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 - publicPtrDomainName: + A list of request header names whose value will be excluded from + inspection during preconfigured WAF evaluation. + type: array + items: + $ref: >- + #/components/schemas/SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParams + requestCookiesToExclude: 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 created for first IP in associated external IPv6 - range. - type: string - networkTier: + A list of request cookie names whose value will be excluded from + inspection during preconfigured WAF evaluation. + type: array + items: + $ref: >- + #/components/schemas/SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParams + requestQueryParamsToExclude: 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. + A list of request query parameter names whose value will be excluded + from inspection during preconfigured WAF evaluation. Note that the + parameter can be in the query string or in the POST body. + type: array + items: + $ref: >- + #/components/schemas/SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParams + requestUrisToExclude: + description: >- + A list of request URIs from the request line to be excluded from + inspection during preconfigured WAF evaluation. When specifying this + field, the query or fragment part should be excluded. + type: array + items: + $ref: >- + #/components/schemas/SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParams + SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParams: + id: SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParams + type: object + properties: + val: + description: The value of the field. + type: string + op: + description: The match operator for the field. type: string enumDescriptions: - - Public internet quality with fixed bandwidth. - >- - High quality, Google-grade network tier, support for all - networking products. + The operator matches if the field value contains the specified + value. - >- - Public internet quality, only limited support for other networking - products. + The operator matches if the field value ends with the specified + value. - >- - (Output only) Temporary tier for FIXED_STANDARD when fixed - standard tier is expired or not configured. + The operator matches if the field value equals the specified + value. + - The operator matches if the field value is any value. + - >- + The operator matches if the field value starts with the specified + value. + enum: + - CONTAINS + - ENDS_WITH + - EQUALS + - EQUALS_ANY + - STARTS_WITH + SecurityPolicyAdaptiveProtectionConfig: + id: SecurityPolicyAdaptiveProtectionConfig + description: Configuration options for Cloud Armor Adaptive Protection (CAAP). + type: object + properties: + layer7DdosDefenseConfig: + description: If set to true, enables Cloud Armor Machine Learning. + $ref: >- + #/components/schemas/SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfig + SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfig: + id: SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfig + description: >- + Configuration options for L7 DDoS detection. This field is only + supported in Global Security Policies of type CLOUD_ARMOR. + type: object + properties: + enable: + description: >- + If set to true, enables CAAP for L7 DDoS detection. This field is + only supported in Global Security Policies of type CLOUD_ARMOR. + type: boolean + ruleVisibility: + description: >- + Rule visibility can be one of the following: STANDARD - opaque + rules. (default) PREMIUM - transparent rules. This field is only + supported in Global Security Policies of type CLOUD_ARMOR. + type: string + enumDescriptions: + - '' + - '' enum: - - FIXED_STANDARD - PREMIUM - STANDARD - - STANDARD_OVERRIDES_FIXED_STANDARD - securityPolicy: + thresholdConfigs: description: >- - [Output Only] The resource URL for the security policy associated - with this access config. - type: string - AliasIpRange: - id: AliasIpRange - description: An alias IP range attached to an instance's network interface. + Configuration options for layer7 adaptive protection for various + customizable thresholds. + type: array + items: + $ref: >- + #/components/schemas/SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfig + SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfig: + id: >- + SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfig type: object properties: - ipCidrRange: + name: 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). + The name must be 1-63 characters long, and comply with RFC1035. The + name must be unique within the security policy. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' type: string - subnetworkRangeName: + autoDeployLoadThreshold: + type: number + format: float + autoDeployConfidenceThreshold: + type: number + format: float + autoDeployImpactedBaselineThreshold: + type: number + format: float + autoDeployExpirationSec: + type: integer + format: int32 + detectionLoadThreshold: + type: number + format: float + detectionAbsoluteQps: + type: number + format: float + detectionRelativeToBaselineQps: + type: number + format: float + trafficGranularityConfigs: 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 - AttachedDisk: - id: AttachedDisk - description: An instance-attached disk resource. + Configuration options for enabling Adaptive Protection to operate on + specified granular traffic units. + type: array + items: + $ref: >- + #/components/schemas/SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfigTrafficGranularityConfig + SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfigTrafficGranularityConfig: + id: >- + SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfigTrafficGranularityConfig + description: >- + Configurations to specifc granular traffic units processed by Adaptive + Protection. type: object properties: - kind: - description: >- - [Output Only] Type of the resource. Always compute#attachedDisk for - attached disks. - default: compute#attachedDisk - type: string type: - description: >- - Specifies the type of the disk, either SCRATCH or PERSISTENT. If not - specified, the default is PERSISTENT. + description: Type of this configuration. type: string enumDescriptions: - '' - '' + - '' enum: - - PERSISTENT - - SCRATCH - 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. + - HTTP_HEADER_HOST + - HTTP_PATH + - UNSPECIFIED_TYPE + value: + description: Requests that match this value constitute a granular traffic unit. type: string - enumDescriptions: - - >- - Attaches this disk in read-only mode. Multiple virtual machines - can use a disk in read-only mode at a time. - - >- - *[Default]* Attaches this disk in read-write mode. Only one - virtual machine at a time can be attached to a disk in read-write - mode. - enum: - - READ_ONLY - - READ_WRITE - savedState: + enableEachUniqueValue: description: >- - For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, - this field is set to PRESERVED if the LocalSSD data has been saved - to a persistent location by customer request. (see the - discard_local_ssd option on Stop/Suspend). Read-only in the api. + If enabled, traffic matching each unique value for the specified + type constitutes a separate traffic unit. It can only be set to true + if `value` is empty. + type: boolean + SecurityPolicyDdosProtectionConfig: + id: SecurityPolicyDdosProtectionConfig + type: object + properties: + ddosProtection: type: string enumDescriptions: - - '*[Default]* Disk state has not been preserved.' - - Disk state has been preserved. + - '' + - '' + - '' enum: - - DISK_SAVED_STATE_UNSPECIFIED - - PRESERVED - source: - description: >- - Specifies a valid partial or full URL to an existing Persistent Disk - resource. When creating a new instance boot disk, one of - initializeParams.sourceImage or initializeParams.sourceSnapshot or - disks.source is required. 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 for zonal disk, and the URL for regional disk. - type: string - 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 - 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. - type: integer - format: int32 - 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 - initializeParams: - 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. - $ref: '#/components/schemas/AttachedDiskInitializeParams' - 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 - licenses: - description: '[Output Only] Any valid publicly visible licenses.' - type: array - items: - type: string - interface: - description: >- - Specifies the disk interface to use for attaching this disk, which - is either SCSI or NVME. For most machine types, the default is SCSI. - Local SSDs can use either NVME or SCSI. In certain configurations, - persistent disks can use NVMe. For more information, see About - persistent disks. + - ADVANCED + - ADVANCED_PREVIEW + - STANDARD + SecurityPolicyAdvancedOptionsConfig: + id: SecurityPolicyAdvancedOptionsConfig + type: object + properties: + jsonParsing: type: string enumDescriptions: - '' - '' + - '' enum: - - NVME - - SCSI - 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. - type: array - items: - $ref: '#/components/schemas/GuestOsFeature' - diskEncryptionKey: - 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. Note: Instance - templates do not store customer-supplied encryption keys, so you - cannot use your own keys to encrypt disks in a managed instance - group. You cannot create VMs that have disks with customer-supplied - keys using the bulk insert method. - $ref: '#/components/schemas/CustomerEncryptionKey' - diskSizeGb: - description: The size of the disk in GB. - type: string - format: int64 - shieldedInstanceInitialState: - description: '[Output Only] shielded vm initial state stored on disk' - $ref: '#/components/schemas/InitialStateConfig' - forceAttach: - description: >- - [Input Only] 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. - type: boolean - architecture: + - DISABLED + - STANDARD + - STANDARD_WITH_GRAPHQL + jsonCustomConfig: description: >- - [Output Only] The architecture of the attached disk. Valid values - are ARM64 or X86_64. + Custom configuration to apply the JSON parsing. Only applicable when + json_parsing is set to STANDARD. + $ref: >- + #/components/schemas/SecurityPolicyAdvancedOptionsConfigJsonCustomConfig + logLevel: type: string enumDescriptions: - - Default value indicating Architecture is not set. - - Machines with architecture ARM64 - - Machines with architecture X86_64 + - '' + - '' enum: - - ARCHITECTURE_UNSPECIFIED - - ARM64 - - X86_64 - AttachedDiskInitializeParams: - id: 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 field - is persisted and returned for instanceTemplate and not returned in the - context of instance. This property is mutually exclusive with the source - property; you can only define one or the other, but not both. - type: object - properties: - 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 - sourceImage: - description: >- - The source image to create this disk. When creating a new instance - boot disk, one of initializeParams.sourceImage or - initializeParams.sourceSnapshot or disks.source is required. 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 - 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. - type: string - format: int64 - 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 specify this field when creating a VM, - you can provide either the full or partial URL. For example, the - following values are valid: - - https://www.googleapis.com/compute/v1/projects/project/zones/zone - /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - - zones/zone/diskTypes/diskType If you specify this field when - creating or updating an instance template or all-instances - configuration, specify the type of the disk, not the URL. For - example: pd-standard. - type: string - sourceImageEncryptionKey: - description: >- - The customer-supplied encryption key of the source image. Required - if the source image is protected by a customer-supplied encryption - key. InstanceTemplate and InstancePropertiesPatch 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. - $ref: '#/components/schemas/CustomerEncryptionKey' - labels: - 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 - additionalProperties: - type: string - sourceSnapshot: - description: >- - The source snapshot to create this disk. When creating a new - instance boot disk, one of initializeParams.sourceSnapshot or - initializeParams.sourceImage or disks.source is required. 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: - description: The customer-supplied encryption key of the source snapshot. - $ref: '#/components/schemas/CustomerEncryptionKey' - description: - description: >- - An optional description. Provide this property when creating the - disk. - type: string - replicaZones: + - NORMAL + - VERBOSE + userIpRequestHeaders: description: >- - Required for each regional disk associated with the instance. - Specify the URLs of the zones where the disk should be replicated - to. You must provide exactly two replica zones, and one zone must be - the same as the instance zone. + An optional list of case-insensitive request header names to use for + resolving the callers client IP address. type: array items: type: string - resourcePolicies: + SecurityPolicyAdvancedOptionsConfigJsonCustomConfig: + id: SecurityPolicyAdvancedOptionsConfigJsonCustomConfig + type: object + properties: + contentTypes: 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. + A list of custom Content-Type header values to apply the JSON + parsing. As per RFC 1341, a Content-Type header value has the + following format: Content-Type := type "/" subtype *[";" parameter] + When configuring a custom Content-Type header value, only the + type/subtype needs to be specified, and the parameters should be + excluded. type: array items: type: string - onUpdateAction: - description: >- - Specifies which action to take on instance update with this disk. - Default is to use the existing disk. - type: string - enumDescriptions: - - Always recreate the disk. - - >- - Recreate the disk if source (image, snapshot) of this disk is - different from source of existing disk. - - Use the existing disk, this is the default behaviour. - enum: - - RECREATE_DISK - - RECREATE_DISK_IF_SOURCE_CHANGED - - USE_EXISTING_DISK - provisionedIops: + SecurityPolicyRecaptchaOptionsConfig: + id: SecurityPolicyRecaptchaOptionsConfig + type: object + properties: + redirectSiteKey: 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. + An optional field to supply a reCAPTCHA site key to be used for all + the rules using the redirect action with the type of + GOOGLE_RECAPTCHA under the security policy. The specified site key + needs to be created from the reCAPTCHA API. The user is responsible + for the validity of the specified site key. If not specified, a + Google-managed site key is used. This field is only supported in + Global Security Policies of type CLOUD_ARMOR. type: string - format: int64 - licenses: - description: A list of publicly visible licenses. Reserved for Google's use. + SecurityPoliciesListPreconfiguredExpressionSetsResponse: + id: SecurityPoliciesListPreconfiguredExpressionSetsResponse + type: object + properties: + preconfiguredExpressionSets: + $ref: '#/components/schemas/SecurityPoliciesWafConfig' + SecurityPoliciesWafConfig: + id: SecurityPoliciesWafConfig + type: object + properties: + wafRules: + $ref: '#/components/schemas/PreconfiguredWafSet' + PreconfiguredWafSet: + id: PreconfiguredWafSet + type: object + properties: + expressionSets: + description: List of entities that are currently supported for WAF rules. type: array items: - type: string - architecture: - description: >- - The architecture of the attached disk. Valid values are arm64 or - x86_64. - type: string - enumDescriptions: - - Default value indicating Architecture is not set. - - Machines with architecture ARM64 - - Machines with architecture X86_64 - enum: - - ARCHITECTURE_UNSPECIFIED - - ARM64 - - X86_64 - resourceManagerTags: - description: >- - Resource manager tags to be bound to the disk. Tag keys and values - have the same definition as resource manager tags. Keys must be in - the format `tagKeys/{tag_key_id}`, and values are in the format - `tagValues/456`. The field is ignored (both PUT & PATCH) when empty. - type: object - additionalProperties: - type: string - provisionedThroughput: - description: >- - Indicates how much throughput to provision for the disk. This sets - the number of throughput mb per second that the disk can handle. - Values must greater than or equal to 1. - type: string - format: int64 - enableConfidentialCompute: - description: Whether this disk is using confidential compute mode. - type: boolean - storagePool: - description: >- - The storage pool in which the new disk is created. 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 - /storagePools/storagePool - - projects/project/zones/zone/storagePools/storagePool - - zones/zone/storagePools/storagePool - type: string - Metadata: - id: Metadata - description: A metadata key/value entry. + $ref: '#/components/schemas/WafExpressionSet' + WafExpressionSet: + id: WafExpressionSet type: object properties: - kind: - description: >- - [Output Only] Type of the resource. Always compute#metadata for - metadata. - default: compute#metadata - type: string - fingerprint: + id: 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. + Google specified expression set ID. The format should be: - E.g. + XSS-20170329 required type: string - format: byte - items: + aliases: description: >- - Array of key/value pairs. The total size of all keys and values must - be less than 512 KB. + 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. type: array items: - description: Metadata - type: object - 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}' - annotations: - required: - - compute.instances.insert - - compute.projects.setCommonInstanceMetadata - 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). - annotations: - required: - - compute.instances.insert - - compute.projects.setCommonInstanceMetadata - type: string - ServiceAccount: - id: ServiceAccount - description: A service account. - type: object - 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. + type: string + expressions: + description: List of available expressions. type: array items: - type: string - Scheduling: - id: Scheduling - description: Sets the scheduling options for an Instance. + $ref: '#/components/schemas/WafExpressionSetExpression' + WafExpressionSetExpression: + id: WafExpressionSetExpression type: object properties: - onHostMaintenance: + id: 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 Set VM host maintenance policy. + 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 - enumDescriptions: - - >- - *[Default]* Allows Compute Engine to automatically migrate - instances out of the way of maintenance events. - - >- - Tells Compute Engine to terminate and (optionally) restart the - instance away from the maintenance activity. If you would like - your instance to be restarted, set the automaticRestart flag to - true. Your instance may be restarted more than once, and it may be - restarted outside the window of maintenance events. - enum: - - MIGRATE - - TERMINATE - 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 - 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 - nodeAffinities: - description: >- - A set of node affinity and anti-affinity configurations. Refer to - Configuring node affinity for more information. Overrides - reservationAffinity. - type: array - items: - $ref: '#/components/schemas/SchedulingNodeAffinity' - minNodeCpus: + sensitivity: description: >- - The minimum number of virtual CPUs this instance will consume when - running on a sole-tenant node. + The sensitivity value associated with the WAF rule ID. This + corresponds to the ModSecurity paranoia level, ranging from 1 to 4. + 0 is reserved for opt-in only rules. type: integer format: int32 - locationHint: + SecurityPoliciesAggregatedList: + id: SecurityPoliciesAggregatedList + type: object + properties: + kind: 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. + [Output Only] Type of resource. Always + compute#securityPolicyAggregatedList for lists of Security Policies. + default: compute#securityPoliciesAggregatedList type: string - availabilityDomain: + id: description: >- - Specifies the availability domain to place the instance in. The - value must be a number between 1 and the number of availability - domains specified in the spread placement policy attached to the - instance. - type: integer - format: int32 - provisioningModel: - description: Specifies the provisioning model of the instance. - type: string - enumDescriptions: - - Heavily discounted, no guaranteed runtime. - - Standard provisioning with user controlled runtime, no discounts. - enum: - - SPOT - - STANDARD - instanceTerminationAction: - description: Specifies the termination action for the instance. - type: string - enumDescriptions: - - Delete the VM. - - Default value. This value is unused. - - Stop the VM without storing in-memory content. default action. - enum: - - DELETE - - INSTANCE_TERMINATION_ACTION_UNSPECIFIED - - STOP - maxRunDuration: - description: >- - Specifies the max run duration for the given instance. If specified, - the instance termination action will be performed at the end of the - run duration. - $ref: '#/components/schemas/Duration' - terminationTime: - description: >- - Specifies the timestamp, when the instance will be terminated, in - RFC3339 text format. If specified, the instance termination action - will be performed at the termination time. - type: string - onInstanceStopAction: - $ref: '#/components/schemas/SchedulingOnInstanceStopAction' - localSsdRecoveryTimeout: - description: >- - Specifies the maximum amount of time a Local Ssd Vm should wait - while recovery of the Local Ssd state is attempted. Its value should - be in between 0 and 168 hours with hour granularity and the default - value being 1 hour. - $ref: '#/components/schemas/Duration' - SchedulingNodeAffinity: - id: SchedulingNodeAffinity - description: >- - Node Affinity: the configuration of desired nodes onto which this - Instance could be scheduled. - type: object - 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. - type: string - enumDescriptions: - - Requires Compute Engine to seek for matched nodes. - - Requires Compute Engine to avoid certain nodes. - - '' - enum: - - IN - - NOT_IN - - OPERATOR_UNSPECIFIED - values: - description: Corresponds to the label values of Node resource. - type: array - items: - type: string - Duration: - id: 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. - type: object - properties: - 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 - type: string - format: int64 - 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. - type: integer - format: int32 - SchedulingOnInstanceStopAction: - id: SchedulingOnInstanceStopAction - description: >- - Defines the behaviour for instances with the instance_termination_action - STOP. - type: object - properties: - discardLocalSsd: - description: >- - If true, the contents of any attached Local SSD disks will be - discarded else, the Local SSD data will be preserved when the - instance is stopped at the end of the run duration/termination time. - type: boolean - InstanceParams: - id: InstanceParams - description: Additional instance params. - type: object - properties: - resourceManagerTags: - description: >- - Resource manager tags to be bound to the instance. Tag keys and - values have the same definition as resource manager tags. Keys must - be in the format `tagKeys/{tag_key_id}`, and values are in the - format `tagValues/456`. The field is ignored (both PUT & PATCH) when - empty. - type: object - additionalProperties: - type: string - AcceleratorConfig: - id: AcceleratorConfig - description: >- - A specification of the type and number of accelerator cards attached to - the instance. - type: object - properties: - 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 - acceleratorCount: - description: The number of the guest accelerator cards exposed to this instance. - type: integer - format: int32 - ReservationAffinity: - id: ReservationAffinity - description: Specifies the reservations that this instance can consume from. - type: object - 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. - type: string - enumDescriptions: - - Consume any allocation available. - - Do not consume from any allocated capacity. - - >- - Must consume from a specific reservation. Must specify key value - fields for specifying the reservations. - - '' - enum: - - ANY_RESERVATION - - NO_RESERVATION - - SPECIFIC_RESERVATION - - UNSPECIFIED - 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. - type: array - items: - type: string - DisplayDevice: - id: DisplayDevice - description: A set of Display Device options - type: object - properties: - enableDisplay: - description: Defines whether the instance has Display enabled. - type: boolean - ShieldedInstanceConfig: - id: ShieldedInstanceConfig - description: A set of Shielded Instance options. - type: object - properties: - 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 - enableIntegrityMonitoring: - description: >- - Defines whether the instance has integrity monitoring enabled. - Enabled by default. - type: boolean - ShieldedInstanceIntegrityPolicy: - id: ShieldedInstanceIntegrityPolicy - description: >- - The policy describes the baseline against which Instance boot integrity - is measured. - type: object - properties: - updateAutoLearnPolicy: - description: >- - Updates the integrity policy baseline using the measurements from - the VM instance's most recent boot. - type: boolean - ConfidentialInstanceConfig: - id: ConfidentialInstanceConfig - description: A set of Confidential Instance options. - type: object - properties: - enableConfidentialCompute: - description: >- - Defines whether the instance should have confidential compute - enabled. - type: boolean - confidentialInstanceType: - description: Defines the type of technology used by the confidential instance. - type: string - enumDescriptions: - - No type specified. Do not use this value. - - AMD Secure Encrypted Virtualization. - - AMD Secure Encrypted Virtualization - Secure Nested Paging. - - Intel Trust Domain eXtension. - enum: - - CONFIDENTIAL_INSTANCE_TYPE_UNSPECIFIED - - SEV - - SEV_SNP - - TDX - AdvancedMachineFeatures: - id: 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). - type: object - 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. - type: integer - format: int32 - visibleCoreCount: - description: >- - The number of physical cores to expose to an instance. Multiply by - the number of threads per core to compute the total number of - virtual CPUs to expose to the instance. If unset, the number of - cores is inferred from the instance's nominal CPU count and the - underlying platform's SMT width. - type: integer - format: int32 - enableUefiNetworking: - description: Whether to enable UEFI networking for instance creation. - type: boolean - performanceMonitoringUnit: - description: Type of Performance Monitoring Unit requested on instance. - type: string - enumDescriptions: - - Architecturally defined non-LLC events. - - Most documented core/L2 and LLC events. - - '' - - Most documented core/L2 events. - enum: - - ARCHITECTURAL - - ENHANCED - - PERFORMANCE_MONITORING_UNIT_UNSPECIFIED - - STANDARD - turboMode: - description: >- - Turbo frequency mode to use for the instance. Supported modes - include: * ALL_CORE_MAX Using empty string or not setting this field - will use the platform-specific default turbo mode. - type: string - ResourceStatus: - id: ResourceStatus - description: >- - Contains output only fields. Use this sub-message for actual values set - on Instance attributes as compared to the value requested by the user - (intent) in their instance CRUD calls. - type: object - properties: - scheduling: - $ref: '#/components/schemas/ResourceStatusScheduling' - upcomingMaintenance: - $ref: '#/components/schemas/UpcomingMaintenance' - physicalHost: - description: '[Output Only] An opaque ID of the host on which the VM is running.' - type: string - ResourceStatusScheduling: - id: ResourceStatusScheduling - type: object - properties: - availabilityDomain: - description: >- - Specifies the availability domain to place the instance in. The - value must be a number between 1 and the number of availability - domains specified in the spread placement policy attached to the - instance. - type: integer - format: int32 - UpcomingMaintenance: - id: UpcomingMaintenance - description: Upcoming Maintenance notification information. - type: object - properties: - type: - description: Defines the type of maintenance. - type: string - enumDescriptions: - - >- - Scheduled maintenance (e.g. maintenance after uptime guarantee is - complete). - - No type specified. Do not use this value. - - >- - Unscheduled maintenance (e.g. emergency maintenance during uptime - guarantee). - enum: - - SCHEDULED - - UNKNOWN_TYPE - - UNSCHEDULED - canReschedule: - description: Indicates if the maintenance can be customer triggered. - type: boolean - windowStartTime: - description: >- - The current start time of the maintenance window. This timestamp - value is in RFC3339 text format. - type: string - windowEndTime: - description: >- - The time by which the maintenance disruption will be completed. This - timestamp value is in RFC3339 text format. - type: string - latestWindowStartTime: - description: >- - The latest time for the planned maintenance window to start. This - timestamp value is in RFC3339 text format. - type: string - maintenanceStatus: - type: string - enumDescriptions: - - There is ongoing maintenance on this VM. - - There is pending maintenance. - - Unknown maintenance status. Do not use this value. - enum: - - ONGOING - - PENDING - - UNKNOWN - NetworkPerformanceConfig: - id: NetworkPerformanceConfig - type: object - properties: - totalEgressBandwidthTier: - type: string - enumDescriptions: - - '' - - '' - enum: - - DEFAULT - - TIER_1 - InstanceAggregatedList: - id: InstanceAggregatedList - type: object - properties: - kind: - description: >- - [Output Only] Type of resource. Always - compute#instanceAggregatedList for aggregated lists of Instance - resources. - default: compute#instanceAggregatedList - type: string - id: - description: >- - [Output Only] Unique identifier for the resource; defined by the - server. + [Output Only] Unique identifier for the resource; defined by the + server. type: string items: - description: An object that contains a list of instances scoped by zone. + description: A list of SecurityPoliciesScopedList resources. type: object additionalProperties: - description: '[Output Only] Name of the scope containing this set of instances.' - $ref: '#/components/schemas/InstancesScopedList' + description: Name of the scope containing this set of security policies. + $ref: '#/components/schemas/SecurityPoliciesScopedList' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -9986,6 +8536,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -10029,6 +8582,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -10051,6 +8605,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -10087,24 +8642,26 @@ components: [Output Only] A warning data value corresponding to the key. type: string + etag: + type: string unreachables: description: '[Output Only] Unreachable resources.' type: array items: type: string - InstancesScopedList: - id: InstancesScopedList + SecurityPoliciesScopedList: + id: SecurityPoliciesScopedList type: object properties: - instances: - description: '[Output Only] A list of instances contained in this scope.' + securityPolicies: + description: A list of SecurityPolicies contained in this scope. type: array items: - $ref: '#/components/schemas/Instance' + $ref: '#/components/schemas/SecurityPolicy' warning: description: >- - [Output Only] Informational warning which replaces the list of - instances when the list is empty. + Informational warning which replaces the list of security policies + when the list is empty. type: object properties: code: @@ -10167,6 +8724,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -10210,6 +8770,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -10232,6 +8793,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -10268,16 +8830,16 @@ components: [Output Only] A warning data value corresponding to the key. type: string - InstanceListReferrers: - id: InstanceListReferrers - description: Contains a list of instance referrers. + InstanceList: + id: InstanceList + description: Contains a list of instances. type: object properties: kind: description: >- - [Output Only] Type of resource. Always compute#instanceListReferrers - for lists of Instance referrers. - default: compute#instanceListReferrers + [Output Only] Type of resource. Always compute#instanceList for + lists of Instance resources. + default: compute#instanceList type: string id: description: >- @@ -10285,10 +8847,10 @@ components: server. type: string items: - description: A list of Reference resources. + description: A list of Instance resources. type: array items: - $ref: '#/components/schemas/Reference' + $ref: '#/components/schemas/Instance' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -10364,6 +8926,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -10407,6 +8972,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -10429,6 +8995,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -10465,1227 +9032,1660 @@ components: [Output Only] A warning data value corresponding to the key. type: string - Reference: - id: Reference - description: Represents a reference to a resource. + Instance: + id: 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. type: object properties: kind: description: >- - [Output Only] Type of the resource. Always compute#reference for - references. - default: compute#reference - type: string - target: - description: URL of the resource to which this reference points. + [Output Only] Type of the resource. Always compute#instance for + instances. + default: compute#instance type: string - referenceType: + id: description: >- - A description of the reference type with no implied semantics. - Possible values include: 1. MEMBER_OF + [Output Only] The unique identifier for the resource. This + identifier is defined by the server. type: string - referrer: - description: URL of the resource which refers to the target. + format: uint64 + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' type: string - SerialPortOutput: - id: SerialPortOutput - description: An instance serial console output. - type: object - properties: - kind: + name: description: >- - [Output Only] Type of the resource. Always compute#serialPortOutput - for serial port output. - default: compute#serialPortOutput - type: string - contents: - description: '[Output Only] The contents of the console output.' + 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])?' + annotations: + required: + - compute.instances.insert type: string - start: + description: 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. + An optional description of this resource. Provide this property when + you create the resource. type: string - format: int64 - next: + tags: 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. - type: string - format: int64 - selfLink: - description: '[Output Only] Server-defined URL for this resource.' - type: string - Screenshot: - id: Screenshot - description: An instance's screenshot. - type: object - properties: - kind: + 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. + $ref: '#/components/schemas/Tags' + machineType: description: >- - [Output Only] Type of the resource. Always compute#screenshot for - the screenshots. - default: compute#screenshot - type: string - contents: - description: '[Output Only] The Base64-encoded screenshot data.' + 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 - GuestAttributes: - id: GuestAttributes - description: A guest attributes entry. - type: object - properties: - kind: + status: description: >- - [Output Only] Type of the resource. Always compute#guestAttributes - for guest attributes entry. - default: compute#guestAttributes - type: string - variableKey: - description: The key to search for. + [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. type: string - variableValue: - description: '[Output Only] The value found for the requested key.' + enumDescriptions: + - >- + The instance is halted and we are performing tear down tasks like + network deprogramming, releasing quota, IP, tearing down disks + etc. + - Resources are being allocated for the instance. + - The instance is in repair. + - The instance is running. + - >- + All required resources have been allocated and the instance is + being started. + - The instance has stopped successfully. + - >- + The instance is currently stopping (either being deleted or + killed). + - The instance has suspended. + - The instance is suspending. + - >- + The instance has stopped (either by explicit action or underlying + failure). + enum: + - DEPROVISIONING + - PROVISIONING + - REPAIRING + - RUNNING + - STAGING + - STOPPED + - STOPPING + - SUSPENDED + - SUSPENDING + - TERMINATED + statusMessage: + description: '[Output Only] An optional, human-readable explanation of the status.' type: string - queryPath: + zone: description: >- - The path to be queried. This can be the default namespace ('') or a - nested namespace ('\/') or a specified key ('\/\'). - type: string - queryValue: - description: '[Output Only] The value of the requested queried path.' - $ref: '#/components/schemas/GuestAttributesValue' - selfLink: - description: '[Output Only] Server-defined URL for this resource.' + [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 - GuestAttributesValue: - id: GuestAttributesValue - description: Array of guest attribute namespace/key/value tuples. - type: object - properties: - items: + 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 + 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. type: array items: - $ref: '#/components/schemas/GuestAttributesEntry' - GuestAttributesEntry: - id: GuestAttributesEntry - description: A guest attributes namespace/key/value entry. - type: object - properties: - namespace: - description: Namespace for the guest attribute entry. - type: string - key: - description: Key for the guest attribute entry. - type: string - value: - description: Value for the guest attribute entry. - type: string - InstancesSetMachineResourcesRequest: - id: InstancesSetMachineResourcesRequest - type: object - properties: - guestAccelerators: + $ref: '#/components/schemas/NetworkInterface' + disks: description: >- - A list of the type and count of accelerator cards attached to the - instance. + Array of disks associated with this instance. Persistent disks must + be created before you can assign them. type: array items: - $ref: '#/components/schemas/AcceleratorConfig' - InstancesSetMachineTypeRequest: - id: InstancesSetMachineTypeRequest - type: object - properties: - machineType: + $ref: '#/components/schemas/AttachedDisk' + metadata: 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 + The metadata key/value pairs assigned to this instance. This + includes metadata keys that were explicitly defined for the + instance. + $ref: '#/components/schemas/Metadata' + 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. + type: array + items: + $ref: '#/components/schemas/ServiceAccount' + selfLink: + description: '[Output Only] Server-defined URL for this resource.' type: string - InstancesSetMinCpuPlatformRequest: - id: InstancesSetMinCpuPlatformRequest - type: object - properties: - minCpuPlatform: - description: Minimum cpu/platform this instance should be started at. + scheduling: + description: Sets the scheduling options for this instance. + $ref: '#/components/schemas/Scheduling' + cpuPlatform: + description: '[Output Only] The CPU platform used by this instance.' type: string - InstancesSetLabelsRequest: - id: InstancesSetLabelsRequest - type: object - properties: labels: + description: >- + Labels to apply to this instance. These can be later modified by the + setLabels method. type: object additionalProperties: type: string + params: + description: >- + Input only. [Input Only] Additional params passed with the request, + but not persisted as part of resource payload. + $ref: '#/components/schemas/InstanceParams' 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. + 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. type: string format: byte - InstancesSetNameRequest: - id: InstancesSetNameRequest - type: object - properties: - name: + instanceEncryptionKey: description: >- - The name to be applied to the instance. Needs to be RFC 1035 - compliant. - type: string - currentName: + Encrypts suspended data for an instance with a customer-managed + encryption key. If you are creating a new instance, this field will + encrypt the local SSD and in-memory contents of the instance during + the suspend operation. If you do not provide an encryption key when + creating the instance, then the local SSD and in-memory contents + will be encrypted using an automatically generated key during the + suspend operation. + $ref: '#/components/schemas/CustomerEncryptionKey' + minCpuPlatform: description: >- - The current name of this resource, used to prevent conflicts. - Provide the latest name when making a request to change name. + 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 - InstancesStartWithEncryptionKeyRequest: - id: InstancesStartWithEncryptionKeyRequest - type: object - properties: - disks: + guestAccelerators: 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. + A list of the type and count of accelerator cards attached to the + instance. type: array items: - $ref: '#/components/schemas/CustomerEncryptionKeyProtectedDisk' - CustomerEncryptionKeyProtectedDisk: - id: CustomerEncryptionKeyProtectedDisk - type: object - properties: - 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 - diskEncryptionKey: + $ref: '#/components/schemas/AcceleratorConfig' + startRestricted: description: >- - Decrypts data associated with the disk with a customer-supplied - encryption key. - $ref: '#/components/schemas/CustomerEncryptionKey' - InstancesSetServiceAccountRequest: - id: InstancesSetServiceAccountRequest - type: object - 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. - type: array - items: - type: string - InstancesAddResourcePoliciesRequest: - id: InstancesAddResourcePoliciesRequest - type: object - properties: + [Output Only] Whether a VM has been restricted for start because + Compute Engine has detected suspicious activity. + type: boolean + deletionProtection: + description: Whether the resource should be protected against deletion. + type: boolean resourcePolicies: - description: Resource policies to be added to this instance. + description: Resource policies applied to this instance. type: array items: type: string - InstancesRemoveResourcePoliciesRequest: - id: InstancesRemoveResourcePoliciesRequest + sourceMachineImage: + description: Source machine image + type: string + reservationAffinity: + description: Specifies the reservations that this instance can consume from. + $ref: '#/components/schemas/ReservationAffinity' + 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 + displayDevice: + description: Enables display device for the instance. + $ref: '#/components/schemas/DisplayDevice' + shieldedInstanceConfig: + $ref: '#/components/schemas/ShieldedInstanceConfig' + shieldedInstanceIntegrityPolicy: + $ref: '#/components/schemas/ShieldedInstanceIntegrityPolicy' + sourceMachineImageEncryptionKey: + description: >- + Source machine image encryption key when creating an instance from a + machine image. + $ref: '#/components/schemas/CustomerEncryptionKey' + confidentialInstanceConfig: + $ref: '#/components/schemas/ConfidentialInstanceConfig' + 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. + type: string + format: byte + privateIpv6GoogleAccess: + description: >- + The private IPv6 google access type for the VM. If not specified, + use INHERIT_FROM_SUBNETWORK as default. + type: string + enumDescriptions: + - >- + Bidirectional private IPv6 access to/from Google services. If + specified, the subnetwork who is attached to the instance's + default network interface will be assigned an internal IPv6 prefix + if it doesn't have before. + - >- + Outbound private IPv6 access from VMs in this subnet to Google + services. If specified, the subnetwork who is attached to the + instance's default network interface will be assigned an internal + IPv6 prefix if it doesn't have before. + - >- + Each network interface inherits PrivateIpv6GoogleAccess from its + subnetwork. + enum: + - ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE + - ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE + - INHERIT_FROM_SUBNETWORK + advancedMachineFeatures: + description: Controls for advanced machine-related behavior features. + $ref: '#/components/schemas/AdvancedMachineFeatures' + 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 + satisfiesPzs: + description: '[Output Only] Reserved for future use.' + type: boolean + satisfiesPzi: + description: '[Output Only] Reserved for future use.' + type: boolean + resourceStatus: + description: >- + [Output Only] Specifies values set for instance attributes as + compared to the values requested by user in the corresponding input + only field. + $ref: '#/components/schemas/ResourceStatus' + networkPerformanceConfig: + $ref: '#/components/schemas/NetworkPerformanceConfig' + keyRevocationActionType: + description: >- + KeyRevocationActionType of the instance. Supported options are + "STOP" and "NONE". The default value is "NONE" if it is not + specified. + type: string + enumDescriptions: + - Default value. This value is unused. + - Indicates user chose no operation. + - Indicates user chose to opt for VM shutdown on key revocation. + enum: + - KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED + - NONE + - STOP + Tags: + id: Tags + description: A set of instance tags. type: object properties: - resourcePolicies: - description: Resource policies to be removed from this instance. + items: + description: >- + An array of tags. Each tag must be 1-63 characters long, and comply + with RFC1035. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' type: array items: type: string - InstancesSetSecurityPolicyRequest: - id: InstancesSetSecurityPolicyRequest - type: object - properties: - securityPolicy: + fingerprint: description: >- - A full or partial URL to a security policy to add to this instance. - If this field is set to an empty string it will remove the - associated security policy. + 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. type: string - networkInterfaces: - description: >- - The network interfaces that the security policy will be applied to. - Network interfaces use the nicN naming format. You can only set a - security policy for network interfaces with an access config. - type: array - items: - type: string - ShieldedInstanceIdentity: - id: ShieldedInstanceIdentity - description: A Shielded Instance Identity. + format: byte + NetworkInterface: + id: NetworkInterface + description: A network interface resource attached to an instance. type: object properties: kind: description: >- - [Output Only] Type of the resource. Always - compute#shieldedInstanceIdentity for shielded Instance identity - entry. - default: compute#shieldedInstanceIdentity + [Output Only] Type of the resource. Always compute#networkInterface + for network interfaces. + default: compute#networkInterface type: string - signingKey: + network: description: >- - An Attestation Key (AK) made by the RSA 2048 algorithm issued to the - Shielded Instance's vTPM. - $ref: '#/components/schemas/ShieldedInstanceIdentityEntry' - encryptionKey: + URL of the VPC 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 selected + project doesn't have the default network, you must specify a network + or subnet. 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 + subnetwork: description: >- - An Endorsement Key (EK) made by the RSA 2048 algorithm issued to the - Shielded Instance's vTPM. - $ref: '#/components/schemas/ShieldedInstanceIdentityEntry' - ShieldedInstanceIdentityEntry: - id: ShieldedInstanceIdentityEntry - description: A Shielded Instance Identity Entry. - type: object - properties: - ekCert: - description: A PEM-encoded X.509 certificate. This field can be empty. + 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 - ekPub: - description: A PEM-encoded public key. + 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 - BulkInsertInstanceResource: - id: 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. - type: object - properties: - count: - description: The maximum number of instances to create. + ipv6Address: + description: >- + An IPv6 internal network address for this network interface. To use + a static internal IP address, it must be unused and in the same + region as the instance's zone. If not specified, Google Cloud will + automatically assign an internal IPv6 address from the instance's + subnetwork. type: string - format: int64 - minCount: + internalIpv6PrefixLength: + description: The prefix length of the primary internal IPv6 range. + type: integer + format: int32 + name: 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. + [Output Only] The name of the network interface, which is generated + by the server. For a VM, the network interface uses the nicN naming + format. Where N is a value between 0 and 7. The default interface + value is nic0. type: string - format: int64 - namePattern: + accessConfigs: 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. + 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. + type: array + items: + $ref: '#/components/schemas/AccessConfig' + 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. + type: array + items: + $ref: '#/components/schemas/AccessConfig' + aliasIpRanges: + description: >- + An array of alias IP ranges for this network interface. You can only + specify this field for network interfaces in VPC networks. + type: array + items: + $ref: '#/components/schemas/AliasIpRange' + 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. type: string - perInstanceProperties: + format: byte + stackType: 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 - additionalProperties: - $ref: >- - #/components/schemas/BulkInsertInstanceResourcePerInstanceProperties - sourceInstanceTemplate: + The stack type for this network interface. To assign only IPv4 + addresses, use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, + use IPV4_IPV6. If not specified, IPV4_ONLY is used. This field can + be both set at instance creation and update network interface + operations. + type: string + enumDescriptions: + - The network interface can have both IPv4 and IPv6 addresses. + - The network interface will only be assigned IPv4 addresses. + - The network interface will only be assigned IPv6 addresses. + enum: + - IPV4_IPV6 + - IPV4_ONLY + - IPV6_ONLY + ipv6AccessType: 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. + [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. type: string - instanceProperties: + enumDescriptions: + - This network interface can have external IPv6. + - This network interface can have internal IPv6. + enum: + - EXTERNAL + - INTERNAL + queueCount: description: >- - The instance properties defining the VM instances to be created. - Required if sourceInstanceTemplate is not provided. - $ref: '#/components/schemas/InstanceProperties' - locationPolicy: + 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. + type: integer + format: int32 + nicType: description: >- - Policy for choosing target zone. For more information, see Create - VMs in bulk. - $ref: '#/components/schemas/LocationPolicy' - BulkInsertInstanceResourcePerInstanceProperties: - id: BulkInsertInstanceResourcePerInstanceProperties - description: >- - Per-instance properties to be set on individual instances. To be - extended in the future. - type: object - properties: - name: - description: This field is only temporary. It will be removed. Do not use it. + The type of vNIC to be used on this interface. This may be gVNIC or + VirtioNet. type: string - hostname: + enumDescriptions: + - GVNIC + - IDPF + - IRDMA + - MRDMA + - No type specified. + - VIRTIO + enum: + - GVNIC + - IDPF + - IRDMA + - MRDMA + - UNSPECIFIED_NIC_TYPE + - VIRTIO_NET + networkAttachment: description: >- - Specifies the hostname of the instance. More details in: - https://cloud.google.com/compute/docs/instances/custom-hostname-vm#naming_convention + The URL of the network attachment that this interface should connect + to in the following format: + projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}. type: string - InstanceProperties: - id: InstanceProperties + AccessConfig: + id: AccessConfig + description: >- + An access configuration attached to an instance's network interface. + Only one access config per instance is supported. type: object properties: - description: + kind: description: >- - An optional text description for the instances that are created from - these properties. + [Output Only] Type of the resource. Always compute#accessConfig for + access configs. + default: compute#accessConfig type: string - 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. - $ref: '#/components/schemas/Tags' - resourceManagerTags: - description: >- - Resource manager tags to be bound to the instance. Tag keys and - values have the same definition as resource manager tags. Keys must - be in the format `tagKeys/{tag_key_id}`, and values are in the - format `tagValues/456`. The field is ignored (both PUT & PATCH) when - empty. - type: object - additionalProperties: - type: string - machineType: + type: description: >- - The machine type to use for instances that are created from these - properties. This field only accepts a machine type name, for example - `n2-standard-4`. If you use the machine type full or partial URL, - for example - `projects/my-l7ilb-project/zones/us-central1-a/machineTypes/n2-standard-4`, - the request will result in an `INTERNAL_ERROR`. - annotations: - required: - - compute.instanceTemplates.insert + The type of configuration. In accessConfigs (IPv4), the default and + only option is ONE_TO_ONE_NAT. In ipv6AccessConfigs, the default and + only option is DIRECT_IPV6. type: string - 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 - networkInterfaces: - description: An array of network access configurations for this interface. - type: array - items: - $ref: '#/components/schemas/NetworkInterface' - disks: - description: >- - An array of disks that are associated with the instances that are - created from these properties. - type: array - items: - $ref: '#/components/schemas/AttachedDisk' - 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. - $ref: '#/components/schemas/Metadata' - 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. - type: array - items: - $ref: '#/components/schemas/ServiceAccount' - scheduling: + enumDescriptions: + - '' + - '' + enum: + - DIRECT_IPV6 + - ONE_TO_ONE_NAT + name: description: >- - Specifies the scheduling options for the instances that are created - from these properties. - $ref: '#/components/schemas/Scheduling' - labels: - description: Labels to apply to instances that are created from these properties. - type: object - additionalProperties: - type: string - guestAccelerators: + The name of this access configuration. In accessConfigs (IPv4), the + default and recommended name is External NAT, but you can use any + arbitrary string, such as My external IP or Network Access. In + ipv6AccessConfigs, the recommend name is External IPv6. + type: string + natIP: description: >- - A list of guest accelerator cards' type and count to use for - instances created from these properties. - type: array - items: - $ref: '#/components/schemas/AcceleratorConfig' - minCpuPlatform: + Applies to accessConfigs (IPv4) only. 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 + externalIpv6: 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. + Applies to ipv6AccessConfigs only. The first IPv6 address of the + external IPv6 range associated with this instance, prefix length is + stored in externalIpv6PrefixLength in ipv6AccessConfig. To use a + static external IP address, it must be unused and in the same region + as the instance's zone. If not specified, Google Cloud will + automatically assign an external IPv6 address from the instance's + subnetwork. type: string - reservationAffinity: + externalIpv6PrefixLength: description: >- - Specifies the reservations that instances can consume from. Note - that for MachineImage, this is not supported yet. - $ref: '#/components/schemas/ReservationAffinity' - shieldedInstanceConfig: - description: Note that for MachineImage, this is not supported yet. - $ref: '#/components/schemas/ShieldedInstanceConfig' - resourcePolicies: + Applies to ipv6AccessConfigs only. The prefix length of the external + IPv6 range. + type: integer + format: int32 + setPublicPtr: description: >- - Resource policies (names, not URLs) applied to instances created - from these properties. Note that for MachineImage, this is not - supported yet. - type: array - items: - type: string - confidentialInstanceConfig: + 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 + publicPtrDomainName: description: >- - Specifies the Confidential Instance options. Note that for - MachineImage, this is not supported yet. - $ref: '#/components/schemas/ConfidentialInstanceConfig' - privateIpv6GoogleAccess: + 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 created for first IP in associated external IPv6 + range. + type: string + networkTier: 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. + 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. type: string enumDescriptions: + - Public internet quality with fixed bandwidth. - >- - Bidirectional private IPv6 access to/from Google services. If - specified, the subnetwork who is attached to the instance's - default network interface will be assigned an internal IPv6 prefix - if it doesn't have before. + High quality, Google-grade network tier, support for all + networking products. - >- - Outbound private IPv6 access from VMs in this subnet to Google - services. If specified, the subnetwork who is attached to the - instance's default network interface will be assigned an internal - IPv6 prefix if it doesn't have before. + Public internet quality, only limited support for other networking + products. - >- - Each network interface inherits PrivateIpv6GoogleAccess from its - subnetwork. + (Output only) Temporary tier for FIXED_STANDARD when fixed + standard tier is expired or not configured. enum: - - ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE - - ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE - - INHERIT_FROM_SUBNETWORK - advancedMachineFeatures: - description: >- - Controls for advanced machine-related behavior features. Note that - for MachineImage, this is not supported yet. - $ref: '#/components/schemas/AdvancedMachineFeatures' - networkPerformanceConfig: - description: Note that for MachineImage, this is not supported yet. - $ref: '#/components/schemas/NetworkPerformanceConfig' - keyRevocationActionType: + - FIXED_STANDARD + - PREMIUM + - STANDARD + - STANDARD_OVERRIDES_FIXED_STANDARD + securityPolicy: description: >- - KeyRevocationActionType of the instance. Supported options are - "STOP" and "NONE". The default value is "NONE" if it is not - specified. + The resource URL for the security policy associated with this access + config. type: string - enumDescriptions: - - Default value. This value is unused. - - Indicates user chose no operation. - - Indicates user chose to opt for VM shutdown on key revocation. - enum: - - KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED - - NONE - - STOP - LocationPolicy: - id: LocationPolicy - description: >- - Configuration for location policy among multiple possible locations - (e.g. preferences for zone selection among zones in a single region). + AliasIpRange: + id: AliasIpRange + description: An alias IP range attached to an instance's network interface. type: object properties: - locations: + ipCidrRange: 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 - additionalProperties: - $ref: '#/components/schemas/LocationPolicyLocation' - targetShape: - description: Strategy for distributing VMs across zones in a region. - type: string - enumDescriptions: - - >- - GCE picks zones for creating VM instances to fulfill the requested - number of VMs within present resource constraints and to maximize - utilization of unused zonal reservations. Recommended for batch - workloads that do not require high availability. - - >- - GCE always selects a single zone for all the VMs, optimizing for - resource quotas, available reservations and general capacity. - Recommended for batch workloads that cannot tollerate distribution - over multiple zones. This the default shape in Bulk Insert and - Capacity Advisor APIs. - - >- - GCE prioritizes acquisition of resources, scheduling VMs in zones - where resources are available while distributing VMs as evenly as - possible across allowed zones to minimize the impact of zonal - failure. Recommended for highly available serving workloads. - enum: - - ANY - - ANY_SINGLE_ZONE - - BALANCED - LocationPolicyLocation: - id: LocationPolicyLocation - type: object - properties: - preference: - description: Preference for a given location. Set to either ALLOW or DENY. + 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 - enumDescriptions: - - Location is allowed for use. - - Location is prohibited. - - Default value, unused. - enum: - - ALLOW - - DENY - - PREFERENCE_UNSPECIFIED - constraints: + subnetworkRangeName: description: >- - Constraints that the caller requires on the result distribution in - this zone. - $ref: '#/components/schemas/LocationPolicyLocationConstraints' - LocationPolicyLocationConstraints: - id: LocationPolicyLocationConstraints - description: Per-zone constraints on location policy for this zone. + 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 + AttachedDisk: + id: AttachedDisk + description: An instance-attached disk resource. type: object properties: - maxCount: + kind: description: >- - Maximum number of items that are allowed to be placed in this zone. - The value must be non-negative. - type: integer - format: int32 - InstancesGetEffectiveFirewallsResponse: - id: InstancesGetEffectiveFirewallsResponse - type: object - properties: - firewalls: - description: Effective firewalls on the instance. - type: array - items: - $ref: '#/components/schemas/Firewall' - firewallPolicys: - description: '[Output Only] Effective firewalls from firewall policies.' - type: array - items: - $ref: >- - #/components/schemas/InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy - InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy: - id: InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy - type: object - properties: - name: - description: '[Output Only] The name of the firewall policy.' + [Output Only] Type of the resource. Always compute#attachedDisk for + attached disks. + default: compute#attachedDisk type: string type: description: >- - [Output Only] The type of the firewall policy. Can be one of - HIERARCHY, NETWORK, NETWORK_REGIONAL, SYSTEM_GLOBAL, - SYSTEM_REGIONAL. + Specifies the type of the disk, either SCRATCH or PERSISTENT. If not + specified, the default is PERSISTENT. type: string enumDescriptions: - '' - '' - - '' - - '' - - '' - - '' enum: - - HIERARCHY - - NETWORK - - NETWORK_REGIONAL - - SYSTEM_GLOBAL - - SYSTEM_REGIONAL - - UNSPECIFIED - shortName: - description: '[Output Only] The short name of the firewall policy.' + - PERSISTENT + - SCRATCH + 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. type: string - displayName: + enumDescriptions: + - >- + Attaches this disk in read-only mode. Multiple virtual machines + can use a disk in read-only mode at a time. + - >- + *[Default]* Attaches this disk in read-write mode. Only one + virtual machine at a time can be attached to a disk in read-write + mode. + enum: + - READ_ONLY + - READ_WRITE + savedState: description: >- - [Output Only] Deprecated, please use short name instead. The display - name of the firewall policy. - deprecated: true + For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, + this field is set to PRESERVED if the LocalSSD data has been saved + to a persistent location by customer request. (see the + discard_local_ssd option on Stop/Suspend). Read-only in the api. type: string - rules: + enumDescriptions: + - '*[Default]* Disk state has not been preserved.' + - Disk state has been preserved. + enum: + - DISK_SAVED_STATE_UNSPECIFIED + - PRESERVED + source: description: >- - [Output Only] The rules that apply to the instance. Only rules that - target the specific VM instance are returned if target service - accounts or target secure tags are specified in the rules. - type: array - items: - $ref: '#/components/schemas/FirewallPolicyRule' - priority: + Specifies a valid partial or full URL to an existing Persistent Disk + resource. When creating a new instance boot disk, one of + initializeParams.sourceImage or initializeParams.sourceSnapshot or + disks.source is required. 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 for zonal disk, and the URL for regional disk. + type: string + deviceName: description: >- - [Output only] Priority of firewall policy association. Not - applicable for type=HIERARCHY. + 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 + 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. type: integer format: int32 - ReservationList: - id: ReservationList - type: object - properties: - kind: + boot: description: >- - [Output Only] Type of resource.Always compute#reservationsList for - listsof reservations - default: compute#reservationList - type: string - id: + Indicates that this is a boot disk. The virtual machine will use the + first partition of the disk for its root filesystem. + type: boolean + initializeParams: description: >- - [Output Only] The unique identifier for the resource. This - identifier is defined by the server. + [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. + $ref: '#/components/schemas/AttachedDiskInitializeParams' + 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 + licenses: + description: '[Output Only] Any valid publicly visible licenses.' + type: array + items: + type: string + interface: + description: >- + Specifies the disk interface to use for attaching this disk, which + is either SCSI or NVME. For most machine types, the default is SCSI. + Local SSDs can use either NVME or SCSI. In certain configurations, + persistent disks can use NVMe. For more information, see About + persistent disks. type: string - items: - description: '[Output Only] A list of Allocation resources.' + enumDescriptions: + - '' + - '' + enum: + - NVME + - SCSI + 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. type: array items: - $ref: '#/components/schemas/Reservation' - nextPageToken: + $ref: '#/components/schemas/GuestOsFeature' + diskEncryptionKey: description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. + 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. Note: Instance + templates do not store customer-supplied encryption keys, so you + cannot use your own keys to encrypt disks in a managed instance + group. You cannot create VMs that have disks with customer-supplied + keys using the bulk insert method. + $ref: '#/components/schemas/CustomerEncryptionKey' + diskSizeGb: + description: The size of the disk in GB. type: string - warning: - description: '[Output Only] Informational warning message.' - type: object - properties: - code: - description: >- - [Output Only] A warning code, if applicable. For example, - Compute Engine returns NO_RESULTS_ON_PAGE if there are no - results in the response. - type: string - enumDescriptions: - - >- - Warning about failed cleanup of transient changes made by a - failed operation. - - A link to a deprecated resource was created. - - >- - When deploying and at least one of the resources has a type - marked as deprecated - - The user created a boot disk that is larger than image size. - - >- - When deploying and at least one of the resources has a type - marked as experimental - - Warning that is present in an external api call - - >- - Warning that value of a field has been overridden. Deprecated - unused field. - - >- - The operation involved use of an injected kernel, which is - deprecated. - - >- - A WEIGHTED_MAGLEV backend service is associated with a health - check that is not of type HTTP/HTTPS/HTTP2. - - >- - When deploying a deployment with a exceedingly large number of - resources - - >- - Resource can't be retrieved due to list overhead quota exceed - which captures the amount of resources filtered out by - user-defined list filter. - - A resource depends on a missing type - - >- - The route's nextHopIp address is not assigned to an instance - on the network. - - The route's next hop instance cannot ip forward. - - >- - The route's nextHopInstance URL refers to an instance that - does not have an ipv6 interface on the same network as the - route. - - >- - The route's nextHopInstance URL refers to an instance that - does not exist. - - >- - The route's nextHopInstance URL refers to an instance that is - not on the same network as the route. - - >- - The route's next hop instance does not have a status of - RUNNING. - - >- - Error which is not critical. We decided to continue the - process despite the mentioned error. - - No results are present on a particular list page. - - >- - Success is reported, but some results may be missing due to - errors - - >- - The user attempted to use a resource that requires a TOS they - have not accepted. - - Warning that a resource is in use. - - >- - One or more of the resources set to auto-delete could not be - deleted because they were in use. - - When a resource schema validation is ignored. - - >- - Instance template used in instance group manager is valid as - such, but its application does not make a lot of sense, - because it allows only single instance in instance group. - - When undeclared properties in the schema are present - - A given scope cannot be reached. - enumDeprecated: - - false - - false - - false - - false - - false - - false - - true - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - enum: - - CLEANUP_FAILED - - DEPRECATED_RESOURCE_USED - - DEPRECATED_TYPE_USED - - DISK_SIZE_LARGER_THAN_IMAGE_SIZE - - EXPERIMENTAL_TYPE_USED - - EXTERNAL_API_WARNING - - FIELD_VALUE_OVERRIDEN - - INJECTED_KERNELS_DEPRECATED - - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB - - LARGE_DEPLOYMENT_WARNING - - LIST_OVERHEAD_QUOTA_EXCEED - - MISSING_TYPE_DEPENDENCY - - NEXT_HOP_ADDRESS_NOT_ASSIGNED - - NEXT_HOP_CANNOT_IP_FORWARD - - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE - - NEXT_HOP_INSTANCE_NOT_FOUND - - NEXT_HOP_INSTANCE_NOT_ON_NETWORK - - NEXT_HOP_NOT_RUNNING - - NOT_CRITICAL_ERROR - - NO_RESULTS_ON_PAGE - - PARTIAL_SUCCESS - - REQUIRED_TOS_AGREEMENT - - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - - RESOURCE_NOT_DELETED - - SCHEMA_VALIDATION_IGNORED - - SINGLE_INSTANCE_PROPERTY_TEMPLATE - - UNDECLARED_PROPERTIES - - UNREACHABLE - message: - description: '[Output Only] A human-readable description of the warning code.' - type: string - data: - description: >- - [Output Only] Metadata about this warning in key: value format. - For example: "data": [ { "key": "scope", "value": - "zones/us-east1-d" } - type: array - items: - type: object - properties: - key: - description: >- - [Output Only] A key that provides more detail on the - warning being returned. For example, for warnings where - there are no results in a list request for a particular - zone, this key might be scope and the key value might be - the zone name. Other examples might be a key indicating a - deprecated resource and a suggested replacement, or a - warning about invalid network settings (for example, if an - instance attempts to perform IP forwarding but is not - enabled for IP forwarding). - type: string - value: - description: >- - [Output Only] A warning data value corresponding to the - key. - type: string - selfLink: - description: '[Output Only] Server-defined URL for this resource.' + format: int64 + shieldedInstanceInitialState: + description: '[Output Only] shielded vm initial state stored on disk' + $ref: '#/components/schemas/InitialStateConfig' + forceAttach: + description: >- + [Input Only] 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. + type: boolean + architecture: + description: >- + [Output Only] The architecture of the attached disk. Valid values + are ARM64 or X86_64. type: string - Reservation: - id: Reservation + enumDescriptions: + - Default value indicating Architecture is not set. + - Machines with architecture ARM64 + - Machines with architecture X86_64 + enum: + - ARCHITECTURE_UNSPECIFIED + - ARM64 + - X86_64 + AttachedDiskInitializeParams: + id: AttachedDiskInitializeParams 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. + [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 field + is persisted and returned for instanceTemplate and not returned in the + context of instance. This property is mutually exclusive with the source + property; you can only define one or the other, but not both. type: object properties: - kind: + diskName: description: >- - [Output Only] Type of the resource. Always compute#reservations for - reservations. - default: compute#reservation + 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 - id: + sourceImage: description: >- - [Output Only] The unique identifier for the resource. This - identifier is defined by the server. - type: string - format: uint64 - creationTimestamp: - description: '[Output Only] Creation timestamp in RFC3339 text format.' - type: string - selfLink: - description: '[Output Only] Server-defined fully-qualified URL for this resource.' + The source image to create this disk. When creating a new instance + boot disk, one of initializeParams.sourceImage or + initializeParams.sourceSnapshot or disks.source is required. 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 - zone: + diskSizeGb: description: >- - Zone in which the reservation resides. A zone must be provided if - the reservation is created within a commitment. + 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. type: string - description: + format: int64 + diskType: description: >- - An optional description of this resource. Provide this property when - you create the resource. + Specifies the disk type to use to create the instance. If not + specified, the default is pd-standard, specified using the full URL. + For example: + https://www.googleapis.com/compute/v1/projects/project/zones/zone + /diskTypes/pd-standard For a full list of acceptable values, see + Persistent disk types. If you specify this field when creating a VM, + you can provide either the full or partial URL. For example, the + following values are valid: - + https://www.googleapis.com/compute/v1/projects/project/zones/zone + /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType + - zones/zone/diskTypes/diskType If you specify this field when + creating or updating an instance template or all-instances + configuration, specify the type of the disk, not the URL. For + example: pd-standard. type: string - name: + sourceImageEncryptionKey: 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])?' - annotations: - required: - - compute.instances.insert + The customer-supplied encryption key of the source image. Required + if the source image is protected by a customer-supplied encryption + key. InstanceTemplate and InstancePropertiesPatch 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. + $ref: '#/components/schemas/CustomerEncryptionKey' + labels: + 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 + additionalProperties: + type: string + sourceSnapshot: + description: >- + The source snapshot to create this disk. When creating a new + instance boot disk, one of initializeParams.sourceSnapshot or + initializeParams.sourceImage or disks.source is required. 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. Note: You + cannot create VMs in bulk using a snapshot as the source. Use an + image instead when you create VMs using the bulk insert method. type: string - specificReservation: - description: Reservation for instances with specific machine shapes. - $ref: '#/components/schemas/AllocationSpecificSKUReservation' - aggregateReservation: - description: Reservation for aggregated resources, providing shape flexibility. - $ref: '#/components/schemas/AllocationAggregateReservation' - commitment: + sourceSnapshotEncryptionKey: + description: The customer-supplied encryption key of the source snapshot. + $ref: '#/components/schemas/CustomerEncryptionKey' + description: description: >- - [Output Only] Full or partial URL to a parent commitment. This field - displays for reservations that are tied to a commitment. + An optional description. Provide this property when creating the + disk. type: string - specificReservationRequired: + replicaZones: 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: + Required for each regional disk associated with the instance. + Specify the URLs of the zones where the disk should be replicated + to. You must provide exactly two replica zones, and one zone must be + the same as the instance zone. + type: array + items: + type: string + resourcePolicies: description: >- - [Output Only] The status of the reservation. - CREATING: Reservation - resources are being allocated. - READY: Reservation resources have - been allocated, and the reservation is ready for use. - DELETING: - Reservation deletion is in progress. - UPDATING: Reservation update - is in progress. + 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. + type: array + items: + type: string + onUpdateAction: + description: >- + Specifies which action to take on instance update with this disk. + Default is to use the existing disk. type: string enumDescriptions: - - Reservation resources are being allocated. - - Reservation deletion is in progress. - - '' + - Always recreate the disk. - >- - Reservation resources have been allocated, and the reservation is - ready for use. - - Reservation update is in progress. + Recreate the disk if source (image, snapshot) of this disk is + different from source of existing disk. + - Use the existing disk, this is the default behaviour. enum: - - CREATING - - DELETING - - INVALID - - READY - - UPDATING - shareSettings: - description: >- - Specify share-settings to create a shared reservation. This property - is optional. For more information about the syntax and options for - this field and its subfields, see the guide for creating a shared - reservation. - $ref: '#/components/schemas/ShareSettings' - satisfiesPzs: - description: '[Output Only] Reserved for future use.' - type: boolean - resourcePolicies: + - RECREATE_DISK + - RECREATE_DISK_IF_SOURCE_CHANGED + - USE_EXISTING_DISK + provisionedIops: description: >- - Resource policies to be added to this reservation. The key is - defined by user, and the value is resource policy url. This is to - define placement policy with reservation. - type: object - additionalProperties: + 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. + type: string + format: int64 + licenses: + description: A list of publicly visible licenses. Reserved for Google's use. + type: array + items: type: string - resourceStatus: - description: '[Output Only] Status information for Reservation resource.' - $ref: '#/components/schemas/AllocationResourceStatus' - AllocationSpecificSKUReservation: - id: AllocationSpecificSKUReservation - description: >- - This reservation type allows to pre allocate specific instance - configuration. - type: object - properties: - instanceProperties: - description: The instance properties for the reservation. - $ref: >- - #/components/schemas/AllocationSpecificSKUAllocationReservedInstanceProperties - count: - description: Specifies the number of resources that are allocated. - type: string - format: int64 - inUseCount: - description: '[Output Only] Indicates how many instances are in use.' + architecture: + description: >- + The architecture of the attached disk. Valid values are arm64 or + x86_64. type: string - format: int64 - assuredCount: + enumDescriptions: + - Default value indicating Architecture is not set. + - Machines with architecture ARM64 + - Machines with architecture X86_64 + enum: + - ARCHITECTURE_UNSPECIFIED + - ARM64 + - X86_64 + resourceManagerTags: description: >- - [Output Only] Indicates how many instances are actually usable - currently. + Resource manager tags to be bound to the disk. Tag keys and values + have the same definition as resource manager tags. Keys must be in + the format `tagKeys/{tag_key_id}`, and values are in the format + `tagValues/456`. The field is ignored (both PUT & PATCH) when empty. + type: object + additionalProperties: + type: string + provisionedThroughput: + description: >- + Indicates how much throughput to provision for the disk. This sets + the number of throughput mb per second that the disk can handle. + Values must greater than or equal to 1. type: string format: int64 - sourceInstanceTemplate: + enableConfidentialCompute: + description: Whether this disk is using confidential compute mode. + type: boolean + storagePool: description: >- - Specifies the instance template to create the reservation. If you - use this field, you must exclude the instanceProperties field. This - field is optional, and 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 + The storage pool in which the new disk is created. 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 + /storagePools/storagePool - + projects/project/zones/zone/storagePools/storagePool - + zones/zone/storagePools/storagePool type: string - AllocationSpecificSKUAllocationReservedInstanceProperties: - id: AllocationSpecificSKUAllocationReservedInstanceProperties - description: 'Properties of the SKU instances being reserved. Next ID: 9' + Metadata: + id: Metadata + description: A metadata key/value entry. type: object properties: - machineType: + kind: 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. + [Output Only] Type of the resource. Always compute#metadata for + metadata. + default: compute#metadata type: string - guestAccelerators: - description: Specifies accelerator type and count. + 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. + type: string + format: byte + items: + description: >- + Array of key/value pairs. The total size of all keys and values must + be less than 512 KB. type: array items: - $ref: '#/components/schemas/AcceleratorConfig' - minCpuPlatform: - description: Minimum cpu platform the reservation. + description: Metadata + type: object + 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}' + annotations: + required: + - compute.instances.insert + - compute.projects.setCommonInstanceMetadata + 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). + annotations: + required: + - compute.instances.insert + - compute.projects.setCommonInstanceMetadata + type: string + ServiceAccount: + id: ServiceAccount + description: A service account. + type: object + properties: + email: + description: Email address of the service account. type: string - localSsds: + scopes: + description: The list of scopes to be made available for this service account. + type: array + items: + type: string + Scheduling: + id: Scheduling + description: Sets the scheduling options for an Instance. + type: object + properties: + maxRunDuration: description: >- - Specifies amount of local ssd to reserve with each instance. The - type of disk is local-ssd. + Specifies the max run duration for the given instance. If specified, + the instance termination action will be performed at the end of the + run duration. + $ref: '#/components/schemas/Duration' + terminationTime: + description: >- + Specifies the timestamp, when the instance will be terminated, in + RFC3339 text format. If specified, the instance termination action + will be performed at the termination time. + type: string + onInstanceStopAction: + $ref: '#/components/schemas/SchedulingOnInstanceStopAction' + 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 Set VM host maintenance policy. + type: string + enumDescriptions: + - >- + *[Default]* Allows Compute Engine to automatically migrate + instances out of the way of maintenance events. + - >- + Tells Compute Engine to terminate and (optionally) restart the + instance away from the maintenance activity. If you would like + your instance to be restarted, set the automaticRestart flag to + true. Your instance may be restarted more than once, and it may be + restarted outside the window of maintenance events. + enum: + - MIGRATE + - TERMINATE + 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 + 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 + nodeAffinities: + description: >- + A set of node affinity and anti-affinity configurations. Refer to + Configuring node affinity for more information. Overrides + reservationAffinity. type: array items: - $ref: >- - #/components/schemas/AllocationSpecificSKUAllocationAllocatedInstancePropertiesReservedDisk + $ref: '#/components/schemas/SchedulingNodeAffinity' + minNodeCpus: + description: >- + The minimum number of virtual CPUs this instance will consume when + running on a sole-tenant node. + type: integer + format: int32 locationHint: description: >- - An opaque location hint used to place the allocation close to other + 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 - AllocationSpecificSKUAllocationAllocatedInstancePropertiesReservedDisk: - id: AllocationSpecificSKUAllocationAllocatedInstancePropertiesReservedDisk + availabilityDomain: + description: >- + Specifies the availability domain to place the instance in. The + value must be a number between 1 and the number of availability + domains specified in the spread placement policy attached to the + instance. + type: integer + format: int32 + provisioningModel: + description: Specifies the provisioning model of the instance. + type: string + enumDescriptions: + - >- + Bound to the lifecycle of the reservation in which it is + provisioned. + - Heavily discounted, no guaranteed runtime. + - Standard provisioning with user controlled runtime, no discounts. + enum: + - RESERVATION_BOUND + - SPOT + - STANDARD + instanceTerminationAction: + description: Specifies the termination action for the instance. + type: string + enumDescriptions: + - Delete the VM. + - Default value. This value is unused. + - Stop the VM without storing in-memory content. default action. + enum: + - DELETE + - INSTANCE_TERMINATION_ACTION_UNSPECIFIED + - STOP + hostErrorTimeoutSeconds: + description: >- + Specify the time in seconds for host error detection, the value must + be within the range of [90, 330] with the increment of 30, if unset, + the default behavior of host error recovery will be used. + type: integer + format: int32 + localSsdRecoveryTimeout: + description: >- + Specifies the maximum amount of time a Local Ssd Vm should wait + while recovery of the Local Ssd state is attempted. Its value should + be in between 0 and 168 hours with hour granularity and the default + value being 1 hour. + $ref: '#/components/schemas/Duration' + Duration: + id: 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. type: object properties: - diskSizeGb: - description: Specifies the size of the disk in base-2 GB. + 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 type: string format: int64 - interface: + nanos: 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. - type: string - enumDescriptions: - - '' - - '' - enum: - - NVME - - SCSI - AllocationAggregateReservation: - id: AllocationAggregateReservation + 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. + type: integer + format: int32 + SchedulingOnInstanceStopAction: + id: SchedulingOnInstanceStopAction description: >- - This reservation type is specified by total resource amounts (e.g. total - count of CPUs) and can account for multiple instance SKUs. In other - words, one can create instances of varying shapes against this - reservation. + Defines the behaviour for instances with the instance_termination_action + STOP. type: object properties: - vmFamily: + discardLocalSsd: description: >- - The VM family that all instances scheduled against this reservation - must belong to. + If true, the contents of any attached Local SSD disks will be + discarded else, the Local SSD data will be preserved when the + instance is stopped at the end of the run duration/termination time. + type: boolean + SchedulingNodeAffinity: + id: SchedulingNodeAffinity + description: >- + Node Affinity: the configuration of desired nodes onto which this + Instance could be scheduled. + type: object + properties: + key: + description: Corresponds to the label key of Node resource. type: string - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - enum: - - VM_FAMILY_CLOUD_TPU_DEVICE_CT3 - - VM_FAMILY_CLOUD_TPU_LITE_DEVICE_CT5L - - VM_FAMILY_CLOUD_TPU_LITE_POD_SLICE_CT5LP - - VM_FAMILY_CLOUD_TPU_POD_SLICE_CT3P - - VM_FAMILY_CLOUD_TPU_POD_SLICE_CT4P - reservedResources: - description: List of reserved resources (CPUs, memory, accelerators). - type: array - items: - $ref: >- - #/components/schemas/AllocationAggregateReservationReservedResourceInfo - inUseResources: - description: '[Output only] List of resources currently in use.' - type: array - items: - $ref: >- - #/components/schemas/AllocationAggregateReservationReservedResourceInfo - workloadType: + operator: description: >- - The workload type of the instances that will target this - reservation. + Defines the operation of node selection. Valid operators are IN for + affinity and NOT_IN for anti-affinity. type: string enumDescriptions: - - >- - Reserved resources will be optimized for BATCH workloads, such as - ML training. - - >- - Reserved resources will be optimized for SERVING workloads, such - as ML inference. + - Requires Compute Engine to seek for matched nodes. + - Requires Compute Engine to avoid certain nodes. - '' enum: - - BATCH - - SERVING - - UNSPECIFIED - AllocationAggregateReservationReservedResourceInfo: - id: AllocationAggregateReservationReservedResourceInfo + - IN + - NOT_IN + - OPERATOR_UNSPECIFIED + values: + description: Corresponds to the label values of Node resource. + type: array + items: + type: string + InstanceParams: + id: InstanceParams + description: Additional instance params. type: object properties: - accelerator: - description: Properties of accelerator resources in this reservation. - $ref: >- - #/components/schemas/AllocationAggregateReservationReservedResourceInfoAccelerator - AllocationAggregateReservationReservedResourceInfoAccelerator: - id: AllocationAggregateReservationReservedResourceInfoAccelerator + resourceManagerTags: + description: >- + Resource manager tags to be bound to the instance. Tag keys and + values have the same definition as resource manager tags. Keys must + be in the format `tagKeys/{tag_key_id}`, and values are in the + format `tagValues/456`. The field is ignored (both PUT & PATCH) when + empty. + type: object + additionalProperties: + type: string + AcceleratorConfig: + id: AcceleratorConfig + description: >- + A specification of the type and number of accelerator cards attached to + the instance. type: object properties: - acceleratorCount: - description: Number of accelerators of specified type. - type: integer - format: int32 acceleratorType: description: >- - Full or partial URL to accelerator type. e.g. - "projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l" + 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 - ShareSettings: - id: ShareSettings - description: The share setting for reservations and sole tenancy node groups. + acceleratorCount: + description: The number of the guest accelerator cards exposed to this instance. + type: integer + format: int32 + ReservationAffinity: + id: ReservationAffinity + description: Specifies the reservations that this instance can consume from. type: object properties: - shareType: - description: Type of sharing for this shared-reservation + 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. type: string enumDescriptions: - - Default value. - - Shared-reservation is open to entire Organization - - Default value. This value is unused. - - Shared-reservation is open to specific projects + - Consume any allocation available. + - Do not consume from any allocated capacity. + - >- + Must consume from a specific reservation. Must specify key value + fields for specifying the reservations. + - '' enum: - - LOCAL - - ORGANIZATION - - SHARE_TYPE_UNSPECIFIED - - SPECIFIC_PROJECTS - projectMap: - description: >- - A map of project id and project config. This is only valid when - share_type's value is SPECIFIC_PROJECTS. - type: object - additionalProperties: - $ref: '#/components/schemas/ShareSettingsProjectConfig' - ShareSettingsProjectConfig: - id: ShareSettingsProjectConfig - description: Config for each project in the share settings. - type: object - properties: - projectId: + - ANY_RESERVATION + - NO_RESERVATION + - SPECIFIC_RESERVATION + - UNSPECIFIED + key: description: >- - The project ID, should be same as the key of this project config in - the parent map. + 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 - AllocationResourceStatus: - id: AllocationResourceStatus - description: '[Output Only] Contains output only fields.' + 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. + type: array + items: + type: string + DisplayDevice: + id: DisplayDevice + description: A set of Display Device options type: object properties: - specificSkuAllocation: - description: Allocation Properties of this reservation. - $ref: '#/components/schemas/AllocationResourceStatusSpecificSKUAllocation' - AllocationResourceStatusSpecificSKUAllocation: - id: AllocationResourceStatusSpecificSKUAllocation - description: Contains Properties set for the reservation. + enableDisplay: + description: Defines whether the instance has Display enabled. + type: boolean + ShieldedInstanceConfig: + id: ShieldedInstanceConfig + description: A set of Shielded Instance options. type: object properties: - sourceInstanceTemplateId: - description: ID of the instance template used to populate reservation properties. - type: string - ReservationAggregatedList: - id: ReservationAggregatedList - description: Contains a list of reservations. + 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 + enableIntegrityMonitoring: + description: >- + Defines whether the instance has integrity monitoring enabled. + Enabled by default. + type: boolean + ShieldedInstanceIntegrityPolicy: + id: ShieldedInstanceIntegrityPolicy + description: >- + The policy describes the baseline against which Instance boot integrity + is measured. type: object properties: - kind: - description: Type of resource. - default: compute#reservationAggregatedList - type: string - id: + updateAutoLearnPolicy: description: >- - [Output Only] Unique identifier for the resource; defined by the + Updates the integrity policy baseline using the measurements from + the VM instance's most recent boot. + type: boolean + ConfidentialInstanceConfig: + id: ConfidentialInstanceConfig + description: A set of Confidential Instance options. + type: object + properties: + enableConfidentialCompute: + description: >- + Defines whether the instance should have confidential compute + enabled. + type: boolean + confidentialInstanceType: + description: Defines the type of technology used by the confidential instance. + type: string + enumDescriptions: + - No type specified. Do not use this value. + - AMD Secure Encrypted Virtualization. + - AMD Secure Encrypted Virtualization - Secure Nested Paging. + - Intel Trust Domain eXtension. + enum: + - CONFIDENTIAL_INSTANCE_TYPE_UNSPECIFIED + - SEV + - SEV_SNP + - TDX + AdvancedMachineFeatures: + id: 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). + type: object + 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. + type: integer + format: int32 + visibleCoreCount: + description: >- + The number of physical cores to expose to an instance. Multiply by + the number of threads per core to compute the total number of + virtual CPUs to expose to the instance. If unset, the number of + cores is inferred from the instance's nominal CPU count and the + underlying platform's SMT width. + type: integer + format: int32 + enableUefiNetworking: + description: Whether to enable UEFI networking for instance creation. + type: boolean + performanceMonitoringUnit: + description: Type of Performance Monitoring Unit requested on instance. + type: string + enumDescriptions: + - Architecturally defined non-LLC events. + - Most documented core/L2 and LLC events. + - '' + - Most documented core/L2 events. + enum: + - ARCHITECTURAL + - ENHANCED + - PERFORMANCE_MONITORING_UNIT_UNSPECIFIED + - STANDARD + turboMode: + description: >- + Turbo frequency mode to use for the instance. Supported modes + include: * ALL_CORE_MAX Using empty string or not setting this field + will use the platform-specific default turbo mode. + type: string + ResourceStatus: + id: ResourceStatus + description: >- + Contains output only fields. Use this sub-message for actual values set + on Instance attributes as compared to the value requested by the user + (intent) in their instance CRUD calls. + type: object + properties: + effectiveInstanceMetadata: + description: >- + [Output Only] Effective metadata is a field that consolidates + project, zonal instance settings, and instance-level predefined + metadata keys to provide the overridden value for those metadata + keys at the instance level. + $ref: '#/components/schemas/ResourceStatusEffectiveInstanceMetadata' + scheduling: + $ref: '#/components/schemas/ResourceStatusScheduling' + upcomingMaintenance: + $ref: '#/components/schemas/UpcomingMaintenance' + physicalHost: + description: >- + [Output Only] The precise location of your instance within the + zone's data center, including the block, sub-block, and host. The + field is formatted as follows: blockId/subBlockId/hostId. + type: string + physicalHostTopology: + description: >- + [Output Only] A series of fields containing the global name of the + Compute Engine cluster, as well as the ID of the block, sub-block, + and host on which the running instance is located. + $ref: '#/components/schemas/ResourceStatusPhysicalHostTopology' + ResourceStatusEffectiveInstanceMetadata: + id: ResourceStatusEffectiveInstanceMetadata + description: Effective values of predefined metadata keys for an instance. + type: object + properties: + vmDnsSettingMetadataValue: + description: Effective VM DNS setting at Instance level. + type: string + enableOsloginMetadataValue: + description: Effective enable-oslogin value at Instance level. + type: boolean + enableOsconfigMetadataValue: + description: Effective enable-osconfig value at Instance level. + type: boolean + enableOsInventoryMetadataValue: + description: Effective enable-os-inventory value at Instance level. + type: boolean + enableGuestAttributesMetadataValue: + description: Effective enable-guest-attributes value at Instance level. + type: boolean + blockProjectSshKeysMetadataValue: + description: Effective block-project-ssh-keys value at Instance level. + type: boolean + serialPortEnableMetadataValue: + description: Effective serial-port-enable value at Instance level. + type: boolean + serialPortLoggingEnableMetadataValue: + description: Effective serial-port-logging-enable value at Instance level. + type: boolean + ResourceStatusScheduling: + id: ResourceStatusScheduling + type: object + properties: + availabilityDomain: + description: >- + Specifies the availability domain to place the instance in. The + value must be a number between 1 and the number of availability + domains specified in the spread placement policy attached to the + instance. + type: integer + format: int32 + UpcomingMaintenance: + id: UpcomingMaintenance + description: Upcoming Maintenance notification information. + type: object + properties: + type: + description: Defines the type of maintenance. + type: string + enumDescriptions: + - >- + Multiple maintenance types in one window. This is only intended to + be used for groups. + - >- + Scheduled maintenance (e.g. maintenance after uptime guarantee is + complete). + - No type specified. Do not use this value. + - >- + Unscheduled maintenance (e.g. emergency maintenance during uptime + guarantee). + enum: + - MULTIPLE + - SCHEDULED + - UNKNOWN_TYPE + - UNSCHEDULED + canReschedule: + description: Indicates if the maintenance can be customer triggered. + type: boolean + windowStartTime: + description: >- + The current start time of the maintenance window. This timestamp + value is in RFC3339 text format. + type: string + windowEndTime: + description: >- + The time by which the maintenance disruption will be completed. This + timestamp value is in RFC3339 text format. + type: string + latestWindowStartTime: + description: >- + The latest time for the planned maintenance window to start. This + timestamp value is in RFC3339 text format. + type: string + maintenanceStatus: + type: string + enumDescriptions: + - There is ongoing maintenance on this VM. + - There is pending maintenance. + - Unknown maintenance status. Do not use this value. + enum: + - ONGOING + - PENDING + - UNKNOWN + maintenanceOnShutdown: + description: >- + Indicates whether the UpcomingMaintenance will be triggered on VM + shutdown. + type: boolean + maintenanceReasons: + description: The reasons for the maintenance. Only valid for vms. + type: array + items: + type: string + enumDescriptions: + - Maintenance due to disk errors. + - Maintenance due to GPU errors. + - Maintenance due to high GPU temperature. + - Maintenance due to GPU xid failure. + - Maintenance due to infrastructure errors. + - Maintenance due to interface errors. + - Maintenance due to memory errors. + - Maintenance due to network errors. + - Maintenance due to NVLink failure. + - Maintenance due to redundant hardware fault. + - Maintenance due to infrastructure relocation. + - Unknown maintenance reason. Do not use this value. + - Maintenance due to planned network update. + - Maintenance due to planned update to the instance. + enum: + - FAILURE_DISK + - FAILURE_GPU + - FAILURE_GPU_TEMPERATURE + - FAILURE_GPU_XID + - FAILURE_INFRA + - FAILURE_INTERFACE + - FAILURE_MEMORY + - FAILURE_NETWORK + - FAILURE_NVLINK + - FAILURE_REDUNDANT_HARDWARE_FAULT + - INFRASTRUCTURE_RELOCATION + - MAINTENANCE_REASON_UNKNOWN + - PLANNED_NETWORK_UPDATE + - PLANNED_UPDATE + ResourceStatusPhysicalHostTopology: + id: ResourceStatusPhysicalHostTopology + description: >- + Represents the physical host topology of the host on which the VM is + running. + type: object + properties: + cluster: + description: >- + [Output Only] The global name of the Compute Engine cluster where + the running instance is located. + type: string + block: + description: >- + [Output Only] The ID of the block in which the running instance is + located. Instances within the same block experience low network + latency. + type: string + subblock: + description: >- + [Output Only] The ID of the sub-block in which the running instance + is located. Instances in the same sub-block experience lower network + latency than instances in the same block. + type: string + host: + description: >- + [Output Only] The ID of the host on which the running instance is + located. Instances on the same host experience the lowest possible + network latency. + type: string + NetworkPerformanceConfig: + id: NetworkPerformanceConfig + type: object + properties: + totalEgressBandwidthTier: + type: string + enumDescriptions: + - '' + - '' + enum: + - DEFAULT + - TIER_1 + InstanceAggregatedList: + id: InstanceAggregatedList + type: object + properties: + kind: + description: >- + [Output Only] Type of resource. Always + compute#instanceAggregatedList for aggregated lists of Instance + resources. + default: compute#instanceAggregatedList + type: string + id: + description: >- + [Output Only] Unique identifier for the resource; defined by the server. type: string items: - description: A list of Allocation resources. + description: An object that contains a list of instances scoped by zone. type: object additionalProperties: - description: Name of the scope containing this set of reservations. - $ref: '#/components/schemas/ReservationsScopedList' + description: '[Output Only] Name of the scope containing this set of instances.' + $ref: '#/components/schemas/InstancesScopedList' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -11761,6 +10761,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -11804,6 +10807,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -11826,6 +10830,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -11867,19 +10872,19 @@ components: type: array items: type: string - ReservationsScopedList: - id: ReservationsScopedList + InstancesScopedList: + id: InstancesScopedList type: object properties: - reservations: - description: A list of reservations contained in this scope. + instances: + description: '[Output Only] A list of instances contained in this scope.' type: array items: - $ref: '#/components/schemas/Reservation' + $ref: '#/components/schemas/Instance' warning: description: >- - Informational warning which replaces the list of reservations when - the list is empty. + [Output Only] Informational warning which replaces the list of + instances when the list is empty. type: object properties: code: @@ -11942,6 +10947,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -11985,6 +10993,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -12007,6 +11016,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -12043,26 +11053,16 @@ components: [Output Only] A warning data value corresponding to the key. type: string - ReservationsResizeRequest: - id: ReservationsResizeRequest - type: object - properties: - specificSkuCount: - description: >- - Number of allocated resources can be resized with minimum = 1 and - maximum = 1000. - type: string - format: int64 - InstanceGroupList: - id: InstanceGroupList - description: A list of InstanceGroup resources. + InstanceListReferrers: + id: InstanceListReferrers + description: Contains a list of instance referrers. type: object properties: kind: description: >- - [Output Only] The resource type, which is always - compute#instanceGroupList for instance group lists. - default: compute#instanceGroupList + [Output Only] Type of resource. Always compute#instanceListReferrers + for lists of Instance referrers. + default: compute#instanceListReferrers type: string id: description: >- @@ -12070,10 +11070,10 @@ components: server. type: string items: - description: A list of InstanceGroup resources. + description: A list of Reference resources. type: array items: - $ref: '#/components/schemas/InstanceGroup' + $ref: '#/components/schemas/Reference' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -12149,6 +11149,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -12192,6 +11195,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -12214,6 +11218,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -12250,330 +11255,759 @@ components: [Output Only] A warning data value corresponding to the key. type: string - InstanceGroup: - id: 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. + Reference: + id: Reference + description: Represents a reference to a resource. type: object properties: kind: description: >- - [Output Only] The resource type, which is always - compute#instanceGroup for instance groups. - default: compute#instanceGroup - type: string - id: - description: >- - [Output Only] A unique identifier for this instance group, generated - by the server. + [Output Only] Type of the resource. Always compute#reference for + references. + default: compute#reference type: string - format: uint64 - creationTimestamp: - description: >- - [Output Only] The creation timestamp for this instance group in - RFC3339 text format. + target: + description: URL of the resource to which this reference points. type: string - name: + referenceType: 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])?' - annotations: - required: - - compute.instanceGroups.insert + A description of the reference type with no implied semantics. + Possible values include: 1. MEMBER_OF type: string - description: - description: >- - An optional description of this resource. Provide this property when - you create the resource. + referrer: + description: URL of the resource which refers to the target. 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: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group. ' + InstancesReportHostAsFaultyRequest: + id: InstancesReportHostAsFaultyRequest + type: object + properties: + faultReasons: type: array items: - $ref: '#/components/schemas/NamedPort' - network: + $ref: '#/components/schemas/InstancesReportHostAsFaultyRequestFaultReason' + disruptionSchedule: 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). + The disruption schedule for the VM. Required field, only allows + IMMEDIATE. 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. + enumDescriptions: + - Not used. Required as per aip/126. + - Delay disruption for caller control. Will be default soon. + - Default value. Disrupt the VM immediately. + enum: + - DISRUPTION_SCHEDULE_UNSPECIFIED + - FUTURE + - IMMEDIATE + InstancesReportHostAsFaultyRequestFaultReason: + id: InstancesReportHostAsFaultyRequestFaultReason + type: object + properties: + behavior: type: string - format: byte - zone: - description: >- - [Output Only] The URL of the zone where the instance group is - located (for zonal resources). + enumDescriptions: + - Public reportable behaviors + - '' + - '' + - '' + enum: + - BEHAVIOR_UNSPECIFIED + - PERFORMANCE + - SILENT_DATA_CORRUPTION + - UNRECOVERABLE_GPU_ERROR + description: type: string - selfLink: + SerialPortOutput: + id: SerialPortOutput + description: An instance serial console output. + type: object + properties: + kind: description: >- - [Output Only] The URL for this instance group. The server generates - this URL. + [Output Only] Type of the resource. Always compute#serialPortOutput + for serial port output. + default: compute#serialPortOutput type: string - size: - description: '[Output Only] The total number of instances in the instance group.' - type: integer - format: int32 - region: + contents: + description: '[Output Only] The contents of the console output.' + type: string + start: description: >- - [Output Only] The URL of the region where the instance group is - located (for regional resources). + 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. type: string - subnetwork: + format: int64 + next: 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). + [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. type: string - NamedPort: - id: NamedPort - description: 'The named port. For example: <"http", 80>.' + format: int64 + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string + Screenshot: + id: Screenshot + description: An instance's screenshot. type: object properties: - name: + kind: description: >- - The name for this named port. The name must be 1-63 characters long, - and comply with RFC1035. + [Output Only] Type of the resource. Always compute#screenshot for + the screenshots. + default: compute#screenshot type: string - port: - description: The port number, which can be a value between 1 and 65535. - type: integer - format: int32 - InstanceGroupAggregatedList: - id: InstanceGroupAggregatedList + contents: + description: '[Output Only] The Base64-encoded screenshot data.' + type: string + GuestAttributes: + id: GuestAttributes + description: A guest attributes entry. type: object properties: kind: description: >- - [Output Only] The resource type, which is always - compute#instanceGroupAggregatedList for aggregated lists of instance - groups. - default: compute#instanceGroupAggregatedList + [Output Only] Type of the resource. Always compute#guestAttributes + for guest attributes entry. + default: compute#guestAttributes type: string - id: + variableKey: + description: The key to search for. + type: string + variableValue: + description: '[Output Only] The value found for the requested key.' + type: string + queryPath: description: >- - [Output Only] Unique identifier for the resource; defined by the - server. + The path to be queried. This can be the default namespace ('') or a + nested namespace ('\/') or a specified key ('\/\'). + type: string + queryValue: + description: '[Output Only] The value of the requested queried path.' + $ref: '#/components/schemas/GuestAttributesValue' + selfLink: + description: '[Output Only] Server-defined URL for this resource.' type: string + GuestAttributesValue: + id: GuestAttributesValue + description: Array of guest attribute namespace/key/value tuples. + type: object + properties: items: - description: A list of InstanceGroupsScopedList resources. + type: array + items: + $ref: '#/components/schemas/GuestAttributesEntry' + GuestAttributesEntry: + id: GuestAttributesEntry + description: A guest attributes namespace/key/value entry. + type: object + properties: + namespace: + description: Namespace for the guest attribute entry. + type: string + key: + description: Key for the guest attribute entry. + type: string + value: + description: Value for the guest attribute entry. + type: string + InstancesSetMachineResourcesRequest: + id: InstancesSetMachineResourcesRequest + type: object + properties: + guestAccelerators: + description: >- + A list of the type and count of accelerator cards attached to the + instance. + type: array + items: + $ref: '#/components/schemas/AcceleratorConfig' + InstancesSetMachineTypeRequest: + id: InstancesSetMachineTypeRequest + type: object + 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 + InstancesSetMinCpuPlatformRequest: + id: InstancesSetMinCpuPlatformRequest + type: object + properties: + minCpuPlatform: + description: Minimum cpu/platform this instance should be started at. + type: string + InstancesSetLabelsRequest: + id: InstancesSetLabelsRequest + type: object + properties: + labels: type: object additionalProperties: - description: The name of the scope that contains this set of instance groups. - $ref: '#/components/schemas/InstanceGroupsScopedList' - nextPageToken: + type: string + labelFingerprint: description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. + 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. type: string - selfLink: - description: '[Output Only] Server-defined URL for this resource.' + format: byte + InstancesSetNameRequest: + id: InstancesSetNameRequest + type: object + properties: + name: + description: >- + The name to be applied to the instance. Needs to be RFC 1035 + compliant. type: string - warning: - description: '[Output Only] Informational warning message.' - type: object - properties: - code: - description: >- - [Output Only] A warning code, if applicable. For example, - Compute Engine returns NO_RESULTS_ON_PAGE if there are no - results in the response. - type: string - enumDescriptions: - - >- - Warning about failed cleanup of transient changes made by a - failed operation. - - A link to a deprecated resource was created. - - >- - When deploying and at least one of the resources has a type - marked as deprecated - - The user created a boot disk that is larger than image size. - - >- - When deploying and at least one of the resources has a type - marked as experimental - - Warning that is present in an external api call - - >- - Warning that value of a field has been overridden. Deprecated - unused field. - - >- - The operation involved use of an injected kernel, which is - deprecated. - - >- - A WEIGHTED_MAGLEV backend service is associated with a health - check that is not of type HTTP/HTTPS/HTTP2. - - >- - When deploying a deployment with a exceedingly large number of - resources - - >- - Resource can't be retrieved due to list overhead quota exceed - which captures the amount of resources filtered out by - user-defined list filter. - - A resource depends on a missing type - - >- - The route's nextHopIp address is not assigned to an instance - on the network. - - The route's next hop instance cannot ip forward. - - >- - The route's nextHopInstance URL refers to an instance that - does not have an ipv6 interface on the same network as the - route. - - >- - The route's nextHopInstance URL refers to an instance that - does not exist. - - >- - The route's nextHopInstance URL refers to an instance that is - not on the same network as the route. - - >- - The route's next hop instance does not have a status of - RUNNING. - - >- - Error which is not critical. We decided to continue the - process despite the mentioned error. - - No results are present on a particular list page. - - >- - Success is reported, but some results may be missing due to - errors - - >- - The user attempted to use a resource that requires a TOS they - have not accepted. - - Warning that a resource is in use. - - >- - One or more of the resources set to auto-delete could not be - deleted because they were in use. - - When a resource schema validation is ignored. - - >- - Instance template used in instance group manager is valid as - such, but its application does not make a lot of sense, - because it allows only single instance in instance group. - - When undeclared properties in the schema are present - - A given scope cannot be reached. - enumDeprecated: - - false - - false - - false - - false - - false - - false - - true - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - enum: - - CLEANUP_FAILED - - DEPRECATED_RESOURCE_USED - - DEPRECATED_TYPE_USED - - DISK_SIZE_LARGER_THAN_IMAGE_SIZE - - EXPERIMENTAL_TYPE_USED - - EXTERNAL_API_WARNING - - FIELD_VALUE_OVERRIDEN - - INJECTED_KERNELS_DEPRECATED - - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB - - LARGE_DEPLOYMENT_WARNING - - LIST_OVERHEAD_QUOTA_EXCEED - - MISSING_TYPE_DEPENDENCY - - NEXT_HOP_ADDRESS_NOT_ASSIGNED - - NEXT_HOP_CANNOT_IP_FORWARD - - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE - - NEXT_HOP_INSTANCE_NOT_FOUND - - NEXT_HOP_INSTANCE_NOT_ON_NETWORK - - NEXT_HOP_NOT_RUNNING - - NOT_CRITICAL_ERROR - - NO_RESULTS_ON_PAGE - - PARTIAL_SUCCESS - - REQUIRED_TOS_AGREEMENT - - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - - RESOURCE_NOT_DELETED - - SCHEMA_VALIDATION_IGNORED - - SINGLE_INSTANCE_PROPERTY_TEMPLATE - - UNDECLARED_PROPERTIES - - UNREACHABLE - message: - description: '[Output Only] A human-readable description of the warning code.' - type: string - data: - description: >- - [Output Only] Metadata about this warning in key: value format. - For example: "data": [ { "key": "scope", "value": - "zones/us-east1-d" } - type: array - items: - type: object - properties: - key: - description: >- - [Output Only] A key that provides more detail on the - warning being returned. For example, for warnings where - there are no results in a list request for a particular - zone, this key might be scope and the key value might be - the zone name. Other examples might be a key indicating a - deprecated resource and a suggested replacement, or a - warning about invalid network settings (for example, if an - instance attempts to perform IP forwarding but is not - enabled for IP forwarding). - type: string - value: - description: >- - [Output Only] A warning data value corresponding to the - key. - type: string - unreachables: - description: '[Output Only] Unreachable resources.' + currentName: + description: >- + The current name of this resource, used to prevent conflicts. + Provide the latest name when making a request to change name. + type: string + InstancesStartWithEncryptionKeyRequest: + id: InstancesStartWithEncryptionKeyRequest + type: object + 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. + type: array + items: + $ref: '#/components/schemas/CustomerEncryptionKeyProtectedDisk' + CustomerEncryptionKeyProtectedDisk: + id: CustomerEncryptionKeyProtectedDisk + type: object + properties: + 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 + diskEncryptionKey: + description: >- + Decrypts data associated with the disk with a customer-supplied + encryption key. + $ref: '#/components/schemas/CustomerEncryptionKey' + InstancesSetServiceAccountRequest: + id: InstancesSetServiceAccountRequest + type: object + 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. type: array items: type: string - InstanceGroupsScopedList: - id: InstanceGroupsScopedList + InstancesAddResourcePoliciesRequest: + id: InstancesAddResourcePoliciesRequest type: object properties: - instanceGroups: + resourcePolicies: + description: Resource policies to be added to this instance. + type: array + items: + type: string + InstancesRemoveResourcePoliciesRequest: + id: InstancesRemoveResourcePoliciesRequest + type: object + properties: + resourcePolicies: + description: Resource policies to be removed from this instance. + type: array + items: + type: string + InstancesSetSecurityPolicyRequest: + id: InstancesSetSecurityPolicyRequest + type: object + properties: + securityPolicy: description: >- - [Output Only] The list of instance groups that are contained in this - scope. + A full or partial URL to a security policy to add to this instance. + If this field is set to an empty string it will remove the + associated security policy. + type: string + networkInterfaces: + description: >- + The network interfaces that the security policy will be applied to. + Network interfaces use the nicN naming format. You can only set a + security policy for network interfaces with an access config. type: array items: - $ref: '#/components/schemas/InstanceGroup' - warning: + type: string + ShieldedInstanceIdentity: + id: ShieldedInstanceIdentity + description: A Shielded Instance Identity. + type: object + properties: + kind: description: >- - [Output Only] An informational warning that replaces the list of - instance groups when the list is empty. - type: object - properties: - code: + [Output Only] Type of the resource. Always + compute#shieldedInstanceIdentity for shielded Instance identity + entry. + default: compute#shieldedInstanceIdentity + type: string + signingKey: + description: >- + An Attestation Key (AK) made by the RSA 2048 algorithm issued to the + Shielded Instance's vTPM. + $ref: '#/components/schemas/ShieldedInstanceIdentityEntry' + encryptionKey: + description: >- + An Endorsement Key (EK) made by the RSA 2048 algorithm issued to the + Shielded Instance's vTPM. + $ref: '#/components/schemas/ShieldedInstanceIdentityEntry' + ShieldedInstanceIdentityEntry: + id: ShieldedInstanceIdentityEntry + description: A Shielded Instance Identity Entry. + type: object + 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 + BulkInsertInstanceResource: + id: 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. + type: object + properties: + count: + description: The maximum number of instances to create. + type: string + format: int64 + 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. + type: string + format: int64 + 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: + 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 + additionalProperties: + $ref: >- + #/components/schemas/BulkInsertInstanceResourcePerInstanceProperties + 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 + instanceProperties: + description: >- + The instance properties defining the VM instances to be created. + Required if sourceInstanceTemplate is not provided. + $ref: '#/components/schemas/InstanceProperties' + locationPolicy: + description: >- + Policy for choosing target zone. For more information, see Create + VMs in bulk. + $ref: '#/components/schemas/LocationPolicy' + BulkInsertInstanceResourcePerInstanceProperties: + id: BulkInsertInstanceResourcePerInstanceProperties + description: >- + Per-instance properties to be set on individual instances. To be + extended in the future. + type: object + properties: + name: + description: This field is only temporary. It will be removed. Do not use it. + type: string + hostname: + description: >- + Specifies the hostname of the instance. More details in: + https://cloud.google.com/compute/docs/instances/custom-hostname-vm#naming_convention + type: string + InstanceProperties: + id: InstanceProperties + type: object + properties: + description: + description: >- + An optional text description for the instances that are created from + these properties. + type: string + 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. + $ref: '#/components/schemas/Tags' + resourceManagerTags: + description: >- + Resource manager tags to be bound to the instance. Tag keys and + values have the same definition as resource manager tags. Keys must + be in the format `tagKeys/{tag_key_id}`, and values are in the + format `tagValues/456`. The field is ignored (both PUT & PATCH) when + empty. + type: object + additionalProperties: + type: string + machineType: + description: >- + The machine type to use for instances that are created from these + properties. This field only accepts a machine type name, for example + `n2-standard-4`. If you use the machine type full or partial URL, + for example + `projects/my-l7ilb-project/zones/us-central1-a/machineTypes/n2-standard-4`, + the request will result in an `INTERNAL_ERROR`. + annotations: + required: + - compute.instanceTemplates.insert + type: string + 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 + networkInterfaces: + description: An array of network access configurations for this interface. + type: array + items: + $ref: '#/components/schemas/NetworkInterface' + disks: + description: >- + An array of disks that are associated with the instances that are + created from these properties. + type: array + items: + $ref: '#/components/schemas/AttachedDisk' + 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. + $ref: '#/components/schemas/Metadata' + 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. + type: array + items: + $ref: '#/components/schemas/ServiceAccount' + scheduling: + description: >- + Specifies the scheduling options for the instances that are created + from these properties. + $ref: '#/components/schemas/Scheduling' + labels: + description: Labels to apply to instances that are created from these properties. + type: object + additionalProperties: + type: string + guestAccelerators: + description: >- + A list of guest accelerator cards' type and count to use for + instances created from these properties. + type: array + items: + $ref: '#/components/schemas/AcceleratorConfig' + 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 + reservationAffinity: + description: >- + Specifies the reservations that instances can consume from. Note + that for MachineImage, this is not supported yet. + $ref: '#/components/schemas/ReservationAffinity' + shieldedInstanceConfig: + description: Note that for MachineImage, this is not supported yet. + $ref: '#/components/schemas/ShieldedInstanceConfig' + resourcePolicies: + description: >- + Resource policies (names, not URLs) applied to instances created + from these properties. Note that for MachineImage, this is not + supported yet. + type: array + items: + type: string + confidentialInstanceConfig: + description: >- + Specifies the Confidential Instance options. Note that for + MachineImage, this is not supported yet. + $ref: '#/components/schemas/ConfidentialInstanceConfig' + 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. + type: string + enumDescriptions: + - >- + Bidirectional private IPv6 access to/from Google services. If + specified, the subnetwork who is attached to the instance's + default network interface will be assigned an internal IPv6 prefix + if it doesn't have before. + - >- + Outbound private IPv6 access from VMs in this subnet to Google + services. If specified, the subnetwork who is attached to the + instance's default network interface will be assigned an internal + IPv6 prefix if it doesn't have before. + - >- + Each network interface inherits PrivateIpv6GoogleAccess from its + subnetwork. + enum: + - ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE + - ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE + - INHERIT_FROM_SUBNETWORK + advancedMachineFeatures: + description: >- + Controls for advanced machine-related behavior features. Note that + for MachineImage, this is not supported yet. + $ref: '#/components/schemas/AdvancedMachineFeatures' + networkPerformanceConfig: + description: Note that for MachineImage, this is not supported yet. + $ref: '#/components/schemas/NetworkPerformanceConfig' + keyRevocationActionType: + description: >- + KeyRevocationActionType of the instance. Supported options are + "STOP" and "NONE". The default value is "NONE" if it is not + specified. + type: string + enumDescriptions: + - Default value. This value is unused. + - Indicates user chose no operation. + - Indicates user chose to opt for VM shutdown on key revocation. + enum: + - KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED + - NONE + - STOP + LocationPolicy: + id: LocationPolicy + description: >- + Configuration for location policy among multiple possible locations + (e.g. preferences for zone selection among zones in a single region). + type: object + properties: + locations: + 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 + additionalProperties: + $ref: '#/components/schemas/LocationPolicyLocation' + targetShape: + description: Strategy for distributing VMs across zones in a region. + type: string + enumDescriptions: + - >- + GCE picks zones for creating VM instances to fulfill the requested + number of VMs within present resource constraints and to maximize + utilization of unused zonal reservations. Recommended for batch + workloads that do not require high availability. + - >- + GCE always selects a single zone for all the VMs, optimizing for + resource quotas, available reservations and general capacity. + Recommended for batch workloads that cannot tollerate distribution + over multiple zones. This the default shape in Bulk Insert and + Capacity Advisor APIs. + - >- + GCE prioritizes acquisition of resources, scheduling VMs in zones + where resources are available while distributing VMs as evenly as + possible across allowed zones to minimize the impact of zonal + failure. Recommended for highly available serving workloads. + enum: + - ANY + - ANY_SINGLE_ZONE + - BALANCED + LocationPolicyLocation: + id: LocationPolicyLocation + type: object + properties: + preference: + description: Preference for a given location. Set to either ALLOW or DENY. + type: string + enumDescriptions: + - Location is allowed for use. + - Location is prohibited. + - Default value, unused. + enum: + - ALLOW + - DENY + - PREFERENCE_UNSPECIFIED + constraints: + description: >- + Constraints that the caller requires on the result distribution in + this zone. + $ref: '#/components/schemas/LocationPolicyLocationConstraints' + LocationPolicyLocationConstraints: + id: LocationPolicyLocationConstraints + description: Per-zone constraints on location policy for this zone. + type: object + properties: + maxCount: + description: >- + Maximum number of items that are allowed to be placed in this zone. + The value must be non-negative. + type: integer + format: int32 + InstancesGetEffectiveFirewallsResponse: + id: InstancesGetEffectiveFirewallsResponse + type: object + properties: + firewalls: + description: Effective firewalls on the instance. + type: array + items: + $ref: '#/components/schemas/Firewall' + firewallPolicys: + description: '[Output Only] Effective firewalls from firewall policies.' + type: array + items: + $ref: >- + #/components/schemas/InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy + InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy: + id: InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy + type: object + properties: + name: + description: '[Output Only] The name of the firewall policy.' + type: string + type: + description: >- + [Output Only] The type of the firewall policy. Can be one of + HIERARCHY, NETWORK, NETWORK_REGIONAL, SYSTEM_GLOBAL, + SYSTEM_REGIONAL. + type: string + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + enum: + - HIERARCHY + - NETWORK + - NETWORK_REGIONAL + - SYSTEM_GLOBAL + - SYSTEM_REGIONAL + - UNSPECIFIED + shortName: + description: '[Output Only] The short name of the firewall policy.' + type: string + displayName: + description: >- + [Output Only] Deprecated, please use short name instead. The display + name of the firewall policy. + deprecated: true + type: string + rules: + description: >- + [Output Only] The rules that apply to the instance. Only rules that + target the specific VM instance are returned if target service + accounts or target secure tags are specified in the rules. + type: array + items: + $ref: '#/components/schemas/FirewallPolicyRule' + packetMirroringRules: + description: '[Output Only] The packet mirroring rules that apply to the instance.' + type: array + items: + $ref: '#/components/schemas/FirewallPolicyRule' + priority: + description: >- + [Output only] Priority of firewall policy association. Not + applicable for type=HIERARCHY. + type: integer + format: int32 + ReservationList: + id: ReservationList + type: object + properties: + kind: + description: >- + [Output Only] Type of resource.Always compute#reservationsList for + listsof reservations + default: compute#reservationList + 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 Allocation resources.' + type: array + items: + $ref: '#/components/schemas/Reservation' + nextPageToken: + description: >- + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the 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.' + type: object + properties: + code: description: >- [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no @@ -12633,6 +12067,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -12676,6 +12113,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -12698,6 +12136,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -12734,63 +12173,550 @@ components: [Output Only] A warning data value corresponding to the key. type: string - InstanceGroupsAddInstancesRequest: - id: InstanceGroupsAddInstancesRequest - type: object - properties: - instances: - description: The list of instances to add to the instance group. - type: array - items: - $ref: '#/components/schemas/InstanceReference' - InstanceReference: - id: InstanceReference - type: object - properties: - instance: - description: >- - The URL for a specific instance. @required - compute.instancegroups.addInstances/removeInstances + selfLink: + description: '[Output Only] Server-defined URL for this resource.' type: string - InstanceGroupsRemoveInstancesRequest: - id: InstanceGroupsRemoveInstancesRequest - type: object - properties: - instances: - description: The list of instances to remove from the instance group. - type: array - items: - $ref: '#/components/schemas/InstanceReference' - InstanceGroupsListInstancesRequest: - id: InstanceGroupsListInstancesRequest + Reservation: + id: 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. type: object properties: - instanceState: + specificReservation: + description: Reservation for instances with specific machine shapes. + $ref: '#/components/schemas/AllocationSpecificSKUReservation' + aggregateReservation: + description: Reservation for aggregated resources, providing shape flexibility. + $ref: '#/components/schemas/AllocationAggregateReservation' + deleteAtTime: 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. + Absolute time in future when the reservation will be auto-deleted by + Compute Engine. Timestamp is represented in RFC3339 text format. type: string - enumDescriptions: - - >- - Includes all instances in the generated list regardless of their - state. - - >- - Includes instances in the generated list only if they have a - RUNNING state. - enum: - - ALL - - RUNNING - InstanceGroupsListInstances: - id: InstanceGroupsListInstances - type: object - properties: + deleteAfterDuration: + description: >- + Duration time relative to reservation creation when Compute Engine + will automatically delete this resource. + $ref: '#/components/schemas/Duration' kind: description: >- - [Output Only] The resource type, which is always - compute#instanceGroupsListInstances for the list of instances in the - specified instance group. - default: compute#instanceGroupsListInstances + [Output Only] Type of the resource. Always compute#reservations for + reservations. + default: compute#reservation + type: string + id: + description: >- + [Output Only] The unique identifier for the resource. This + identifier is defined by the server. + type: string + format: uint64 + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + selfLink: + description: '[Output Only] Server-defined fully-qualified URL for this resource.' + 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 + description: + description: >- + An optional description of this resource. Provide this property when + you create the resource. + 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])?' + annotations: + required: + - compute.instances.insert + type: string + 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 + linkedCommitments: + description: >- + [Output Only] Full or partial URL to parent commitments. This field + displays for reservations that are tied to multiple commitments. + type: array + items: + type: string + 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. - CREATING: Reservation + resources are being allocated. - READY: Reservation resources have + been allocated, and the reservation is ready for use. - DELETING: + Reservation deletion is in progress. - UPDATING: Reservation update + is in progress. + type: string + enumDescriptions: + - Reservation resources are being allocated. + - Reservation deletion is in progress. + - '' + - >- + Reservation resources have been allocated, and the reservation is + ready for use. + - Reservation update is in progress. + enum: + - CREATING + - DELETING + - INVALID + - READY + - UPDATING + shareSettings: + description: >- + Specify share-settings to create a shared reservation. This property + is optional. For more information about the syntax and options for + this field and its subfields, see the guide for creating a shared + reservation. + $ref: '#/components/schemas/ShareSettings' + satisfiesPzs: + description: '[Output Only] Reserved for future use.' + type: boolean + resourcePolicies: + description: >- + Resource policies to be added to this reservation. The key is + defined by user, and the value is resource policy url. This is to + define placement policy with reservation. + type: object + additionalProperties: + type: string + resourceStatus: + description: '[Output Only] Status information for Reservation resource.' + $ref: '#/components/schemas/AllocationResourceStatus' + reservationSharingPolicy: + description: >- + Specify the reservation sharing policy. If unspecified, the + reservation will not be shared with Google Cloud managed services. + $ref: '#/components/schemas/AllocationReservationSharingPolicy' + deploymentType: + description: Specifies the deployment strategy for this reservation. + type: string + enumDescriptions: + - >- + The reserved capacity is made up of densely deployed reservation + blocks. + - '' + enum: + - DENSE + - DEPLOYMENT_TYPE_UNSPECIFIED + advancedDeploymentControl: + description: >- + Advanced control for cluster management, applicable only to DENSE + deployment type reservations. + $ref: '#/components/schemas/ReservationAdvancedDeploymentControl' + enableEmergentMaintenance: + description: >- + Indicates whether Compute Engine allows unplanned maintenance for + your VMs; for example, to fix hardware errors. + type: boolean + schedulingType: + description: The type of maintenance for the reservation. + type: string + enumDescriptions: + - >- + Maintenance on all reserved instances in the reservation is + synchronized. + - Unknown maintenance type. + - >- + Maintenance is not synchronized for this reservation. Instead, + each instance has its own maintenance window. + enum: + - GROUPED + - GROUP_MAINTENANCE_TYPE_UNSPECIFIED + - INDEPENDENT + AllocationSpecificSKUReservation: + id: AllocationSpecificSKUReservation + description: >- + This reservation type allows to pre allocate specific instance + configuration. + type: object + properties: + instanceProperties: + description: The instance properties for the reservation. + $ref: >- + #/components/schemas/AllocationSpecificSKUAllocationReservedInstanceProperties + count: + description: Specifies the number of resources that are allocated. + type: string + format: int64 + inUseCount: + description: '[Output Only] Indicates how many instances are in use.' + type: string + format: int64 + assuredCount: + description: >- + [Output Only] Indicates how many instances are actually usable + currently. + type: string + format: int64 + sourceInstanceTemplate: + description: >- + Specifies the instance template to create the reservation. If you + use this field, you must exclude the instanceProperties field. This + field is optional, and 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 + type: string + AllocationSpecificSKUAllocationReservedInstanceProperties: + id: AllocationSpecificSKUAllocationReservedInstanceProperties + description: 'Properties of the SKU instances being reserved. Next ID: 9' + type: object + properties: + 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 + guestAccelerators: + description: Specifies accelerator type and count. + type: array + items: + $ref: '#/components/schemas/AcceleratorConfig' + minCpuPlatform: + description: Minimum cpu platform the reservation. + type: string + localSsds: + description: >- + Specifies amount of local ssd to reserve with each instance. The + type of disk is local-ssd. + type: array + items: + $ref: >- + #/components/schemas/AllocationSpecificSKUAllocationAllocatedInstancePropertiesReservedDisk + 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 + AllocationSpecificSKUAllocationAllocatedInstancePropertiesReservedDisk: + id: AllocationSpecificSKUAllocationAllocatedInstancePropertiesReservedDisk + type: object + properties: + diskSizeGb: + description: Specifies the size of the disk in base-2 GB. + type: string + format: int64 + 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. + type: string + enumDescriptions: + - '' + - '' + enum: + - NVME + - SCSI + AllocationAggregateReservation: + id: AllocationAggregateReservation + description: >- + This reservation type is specified by total resource amounts (e.g. total + count of CPUs) and can account for multiple instance SKUs. In other + words, one can create instances of varying shapes against this + reservation. + type: object + properties: + vmFamily: + description: >- + The VM family that all instances scheduled against this reservation + must belong to. + type: string + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + enum: + - VM_FAMILY_CLOUD_TPU_DEVICE_CT3 + - VM_FAMILY_CLOUD_TPU_LITE_DEVICE_CT5L + - VM_FAMILY_CLOUD_TPU_LITE_POD_SLICE_CT5LP + - VM_FAMILY_CLOUD_TPU_LITE_POD_SLICE_CT6E + - VM_FAMILY_CLOUD_TPU_POD_SLICE_CT3P + - VM_FAMILY_CLOUD_TPU_POD_SLICE_CT4P + - VM_FAMILY_CLOUD_TPU_POD_SLICE_CT5P + reservedResources: + description: List of reserved resources (CPUs, memory, accelerators). + type: array + items: + $ref: >- + #/components/schemas/AllocationAggregateReservationReservedResourceInfo + inUseResources: + description: '[Output only] List of resources currently in use.' + type: array + items: + $ref: >- + #/components/schemas/AllocationAggregateReservationReservedResourceInfo + workloadType: + description: >- + The workload type of the instances that will target this + reservation. + type: string + enumDescriptions: + - >- + Reserved resources will be optimized for BATCH workloads, such as + ML training. + - >- + Reserved resources will be optimized for SERVING workloads, such + as ML inference. + - '' + enum: + - BATCH + - SERVING + - UNSPECIFIED + AllocationAggregateReservationReservedResourceInfo: + id: AllocationAggregateReservationReservedResourceInfo + type: object + properties: + accelerator: + description: Properties of accelerator resources in this reservation. + $ref: >- + #/components/schemas/AllocationAggregateReservationReservedResourceInfoAccelerator + AllocationAggregateReservationReservedResourceInfoAccelerator: + id: AllocationAggregateReservationReservedResourceInfoAccelerator + type: object + properties: + acceleratorCount: + description: Number of accelerators of specified type. + type: integer + format: int32 + acceleratorType: + description: >- + Full or partial URL to accelerator type. e.g. + "projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l" + type: string + ShareSettings: + id: ShareSettings + description: The share setting for reservations and sole tenancy node groups. + type: object + properties: + shareType: + description: Type of sharing for this shared-reservation + type: string + enumDescriptions: + - Default value. + - Shared-reservation is open to entire Organization + - Default value. This value is unused. + - Shared-reservation is open to specific projects + enum: + - LOCAL + - ORGANIZATION + - SHARE_TYPE_UNSPECIFIED + - SPECIFIC_PROJECTS + projectMap: + description: >- + A map of project id and project config. This is only valid when + share_type's value is SPECIFIC_PROJECTS. + type: object + additionalProperties: + $ref: '#/components/schemas/ShareSettingsProjectConfig' + ShareSettingsProjectConfig: + id: ShareSettingsProjectConfig + description: Config for each project in the share settings. + type: object + properties: + projectId: + description: >- + The project ID, should be same as the key of this project config in + the parent map. + type: string + AllocationResourceStatus: + id: AllocationResourceStatus + description: '[Output Only] Contains output only fields.' + type: object + properties: + specificSkuAllocation: + description: Allocation Properties of this reservation. + $ref: '#/components/schemas/AllocationResourceStatusSpecificSKUAllocation' + reservationMaintenance: + description: Maintenance information for this reservation + $ref: '#/components/schemas/GroupMaintenanceInfo' + reservationBlockCount: + description: The number of reservation blocks associated with this reservation. + type: integer + format: int32 + healthInfo: + description: '[Output only] Health information for the reservation.' + $ref: '#/components/schemas/AllocationResourceStatusHealthInfo' + AllocationResourceStatusSpecificSKUAllocation: + id: AllocationResourceStatusSpecificSKUAllocation + description: Contains Properties set for the reservation. + type: object + properties: + sourceInstanceTemplateId: + description: ID of the instance template used to populate reservation properties. + type: string + utilizations: + description: >- + Per service utilization breakdown. The Key is the Google Cloud + managed service name. + type: object + additionalProperties: + type: string + format: int64 + GroupMaintenanceInfo: + id: GroupMaintenanceInfo + description: Maintenance Info for ReservationBlocks. + type: object + properties: + upcomingGroupMaintenance: + description: Maintenance information on this group of VMs. + $ref: '#/components/schemas/UpcomingMaintenance' + maintenanceOngoingCount: + description: >- + Progress for ongoing maintenance for this group of VMs/hosts. + Describes number of hosts in the block that have ongoing + maintenance. + type: integer + format: int32 + maintenancePendingCount: + description: >- + Progress for ongoing maintenance for this group of VMs/hosts. + Describes number of hosts in the block that have pending + maintenance. + type: integer + format: int32 + schedulingType: + description: The type of maintenance for the reservation. + type: string + enumDescriptions: + - >- + Maintenance on all reserved instances in the reservation is + synchronized. + - Unknown maintenance type. + - >- + Maintenance is not synchronized for this reservation. Instead, + each instance has its own maintenance window. + enum: + - GROUPED + - GROUP_MAINTENANCE_TYPE_UNSPECIFIED + - INDEPENDENT + subblockInfraMaintenanceOngoingCount: + description: >- + Describes number of subblock Infrastructure that has ongoing + maintenance. Here, Subblock Infrastructure Maintenance pertains to + upstream hardware contained in the Subblock that is necessary for a + VM Family(e.g. NVLink Domains). Not all VM Families will support + this field. + type: integer + format: int32 + subblockInfraMaintenancePendingCount: + description: >- + Describes number of subblock Infrastructure that has pending + maintenance. Here, Subblock Infrastructure Maintenance pertains to + upstream hardware contained in the Subblock that is necessary for a + VM Family (e.g. NVLink Domains). Not all VM Families will support + this field. + type: integer + format: int32 + instanceMaintenanceOngoingCount: + description: Describes number of instances that have ongoing maintenance. + type: integer + format: int32 + instanceMaintenancePendingCount: + description: Describes number of instances that have pending maintenance. + type: integer + format: int32 + AllocationResourceStatusHealthInfo: + id: AllocationResourceStatusHealthInfo + description: Health information for the reservation. + type: object + properties: + healthStatus: + description: The health status of the reservation. + type: string + enumDescriptions: + - The reservation is degraded. + - The reservation is healthy. + - The health status of the reservation is unspecified. + enum: + - DEGRADED + - HEALTHY + - HEALTH_STATUS_UNSPECIFIED + healthyBlockCount: + description: The number of reservation blocks that are healthy. + type: integer + format: int32 + degradedBlockCount: + description: The number of reservation blocks that are degraded. + type: integer + format: int32 + AllocationReservationSharingPolicy: + id: AllocationReservationSharingPolicy + type: object + properties: + serviceShareType: + description: Sharing config for all Google Cloud services. + type: string + enumDescriptions: + - Allow all Google Cloud managed services to share reservations. + - '[Default] Disallow sharing with all Google Cloud services.' + - '' + enum: + - ALLOW_ALL + - DISALLOW_ALL + - SERVICE_SHARE_TYPE_UNSPECIFIED + ReservationAdvancedDeploymentControl: + id: ReservationAdvancedDeploymentControl + description: >- + Advance control for cluster management, applicable only to DENSE + deployment type reservations. + type: object + properties: + reservationOperationalMode: + description: Indicates chosen reservation operational mode for the reservation. + type: string + enumDescriptions: + - >- + Google Cloud does not manage the failure of machines, but provides + additional capacity, which is not guaranteed to be available. + - >- + Google Cloud manages the failure of machines to provide high + availability. + - '' + enum: + - ALL_CAPACITY + - HIGHLY_AVAILABLE_CAPACITY + - RESERVATION_OPERATIONAL_MODE_UNSPECIFIED + ReservationAggregatedList: + id: ReservationAggregatedList + description: Contains a list of reservations. + type: object + properties: + kind: + description: Type of resource. + default: compute#reservationAggregatedList type: string id: description: >- @@ -12798,10 +12724,11 @@ components: server. type: string items: - description: A list of InstanceWithNamedPorts resources. - type: array - items: - $ref: '#/components/schemas/InstanceWithNamedPorts' + description: A list of Allocation resources. + type: object + additionalProperties: + description: Name of the scope containing this set of reservations. + $ref: '#/components/schemas/ReservationsScopedList' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -12877,6 +12804,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -12920,6 +12850,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -12942,6 +12873,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -12978,106 +12910,25 @@ components: [Output Only] A warning data value corresponding to the key. type: string - InstanceWithNamedPorts: - id: InstanceWithNamedPorts - type: object - properties: - instance: - description: '[Output Only] The URL of the instance.' - type: string - status: - description: '[Output Only] The status of the instance.' - type: string - enumDescriptions: - - >- - The instance is halted and we are performing tear down tasks like - network deprogramming, releasing quota, IP, tearing down disks - etc. - - Resources are being allocated for the instance. - - The instance is in repair. - - The instance is running. - - >- - All required resources have been allocated and the instance is - being started. - - The instance has stopped successfully. - - >- - The instance is currently stopping (either being deleted or - killed). - - The instance has suspended. - - The instance is suspending. - - >- - The instance has stopped (either by explicit action or underlying - failure). - enum: - - DEPROVISIONING - - PROVISIONING - - REPAIRING - - RUNNING - - STAGING - - STOPPED - - STOPPING - - SUSPENDED - - SUSPENDING - - TERMINATED - namedPorts: - description: '[Output Only] The named ports that belong to this instance group.' - type: array - items: - $ref: '#/components/schemas/NamedPort' - InstanceGroupsSetNamedPortsRequest: - id: InstanceGroupsSetNamedPortsRequest - type: object - properties: - namedPorts: - description: The list of named ports to set for this instance group. + unreachables: + description: '[Output Only] Unreachable resources.' type: array items: - $ref: '#/components/schemas/NamedPort' - 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. - type: string - format: byte - RegionInstanceGroupList: - id: RegionInstanceGroupList - description: Contains a list of InstanceGroup resources. + type: string + ReservationsScopedList: + id: ReservationsScopedList type: object properties: - kind: - description: The resource type. - default: compute#regionInstanceGroupList - type: string - id: - description: >- - [Output Only] Unique identifier for the resource; defined by the - server. - type: string - items: - description: A list of InstanceGroup resources. + reservations: + description: A list of reservations contained in this scope. type: array items: - $ref: '#/components/schemas/InstanceGroup' - nextPageToken: - description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. - type: string - selfLink: - description: '[Output Only] Server-defined URL for this resource.' - type: string + $ref: '#/components/schemas/Reservation' warning: - description: '[Output Only] Informational warning message.' - type: object + description: >- + Informational warning which replaces the list of reservations when + the list is empty. + type: object properties: code: description: >- @@ -13139,6 +12990,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -13182,6 +13036,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -13204,6 +13059,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -13240,38 +13096,52 @@ components: [Output Only] A warning data value corresponding to the key. type: string - RegionInstanceGroupsListInstancesRequest: - id: RegionInstanceGroupsListInstancesRequest + ReservationsResizeRequest: + id: ReservationsResizeRequest type: object properties: - instanceState: + specificSkuCount: description: >- - Instances in which state should be returned. Valid options are: - 'ALL', 'RUNNING'. By default, it lists all instances. + Number of allocated resources can be resized with minimum = 1 and + maximum = 1000. + type: string + format: int64 + ReservationsPerformMaintenanceRequest: + id: ReservationsPerformMaintenanceRequest + type: object + properties: + maintenanceScope: + description: >- + Specifies if all, running or unused hosts are in scope for this + request. type: string enumDescriptions: - >- - Matches any status of the instances, running, non-running and - others. - - Instance is in RUNNING state if it is running. + Trigger maintenance for all hosts belonging to this reservation + irrespective of whether VMs are running on them or not. + - Internal only + - >- + Trigger maintenance only on the hosts belonging to this + reservation which have VMs running on them. + - >- + Trigger maintenance only on the hosts belonging to this + reservation which do not have any VMs running on them. This is not + allowed for Standard ExR enum: - ALL - - RUNNING - 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 - RegionInstanceGroupsListInstances: - id: RegionInstanceGroupsListInstances + - MAINTENANCE_SCOPE_UNSPECIFIED + - RUNNING_VMS + - UNUSED_CAPACITY + InstanceGroupList: + id: InstanceGroupList + description: A list of InstanceGroup resources. type: object properties: kind: - description: The resource type. - default: compute#regionInstanceGroupsListInstances + description: >- + [Output Only] The resource type, which is always + compute#instanceGroupList for instance group lists. + default: compute#instanceGroupList type: string id: description: >- @@ -13279,10 +13149,10 @@ components: server. type: string items: - description: A list of InstanceWithNamedPorts resources. + description: A list of InstanceGroup resources. type: array items: - $ref: '#/components/schemas/InstanceWithNamedPorts' + $ref: '#/components/schemas/InstanceGroup' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -13358,6 +13228,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -13401,6 +13274,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -13423,6 +13297,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -13459,40 +13334,131 @@ components: [Output Only] A warning data value corresponding to the key. type: string - RegionInstanceGroupsSetNamedPortsRequest: - id: RegionInstanceGroupsSetNamedPortsRequest + InstanceGroup: + id: 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. type: object properties: + kind: + description: >- + [Output Only] The resource type, which is always + compute#instanceGroup for instance groups. + default: compute#instanceGroup + type: string + id: + description: >- + [Output Only] A unique identifier for this instance group, generated + by the server. + type: string + format: uint64 + creationTimestamp: + description: >- + [Output Only] The creation timestamp for this instance group in + RFC3339 text format. + 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])?' + annotations: + required: + - compute.instanceGroups.insert + type: string + description: + description: >- + An optional description of this resource. Provide this property when + you create the resource. + type: string namedPorts: - description: The list of named ports to set for this instance group. + description: ' Optional. 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: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group. ' type: array items: $ref: '#/components/schemas/NamedPort' + 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 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. + [Output Only] The fingerprint of the named ports. The system uses + this fingerprint to detect conflicts when multiple users change the + named ports concurrently. type: string format: byte - InstanceGroupManagerList: - id: InstanceGroupManagerList - description: '[Output Only] A list of managed instance groups.' + zone: + description: >- + [Output Only] The URL of the zone where the instance group is + located (for zonal 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.' + type: integer + format: int32 + region: + description: >- + [Output Only] The URL of the region where the instance group is + located (for regional resources). + type: string + 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 + NamedPort: + id: NamedPort + description: 'The named port. For example: <"http", 80>.' + type: object + 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. + type: integer + format: int32 + InstanceGroupAggregatedList: + id: InstanceGroupAggregatedList type: object properties: + kind: + description: >- + [Output Only] The resource type, which is always + compute#instanceGroupAggregatedList for aggregated lists of instance + groups. + default: compute#instanceGroupAggregatedList + type: string id: description: >- [Output Only] Unique identifier for the resource; defined by the server. type: string items: - description: A list of InstanceGroupManager resources. - type: array - items: - $ref: '#/components/schemas/InstanceGroupManager' + description: A list of InstanceGroupsScopedList resources. + type: object + additionalProperties: + description: The name of the scope that contains this set of instance groups. + $ref: '#/components/schemas/InstanceGroupsScopedList' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -13568,6 +13534,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -13611,6 +13580,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -13633,6 +13603,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -13669,859 +13640,542 @@ components: [Output Only] A warning data value corresponding to the key. type: string - kind: - description: >- - [Output Only] The resource type, which is always - compute#instanceGroupManagerList for a list of managed instance - groups. - default: compute#instanceGroupManagerList - type: string - InstanceGroupManager: - id: 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. + unreachables: + description: '[Output Only] Unreachable resources.' + type: array + items: + type: string + InstanceGroupsScopedList: + id: InstanceGroupsScopedList type: object properties: - kind: - description: >- - [Output Only] The resource type, which is always - compute#instanceGroupManager for managed instance groups. - default: compute#instanceGroupManager - type: string - id: + instanceGroups: description: >- - [Output Only] A unique identifier for this resource type. The server - generates this identifier. - type: string - format: uint64 - creationTimestamp: + [Output Only] The list of instance groups that are contained in this + scope. + type: array + items: + $ref: '#/components/schemas/InstanceGroup' + warning: description: >- - [Output Only] The creation timestamp for this managed instance group - in RFC3339 text format. - type: string - name: + [Output Only] An informational warning that replaces the list of + instance groups when the list is empty. + type: object + properties: + code: + description: >- + [Output Only] A warning code, if applicable. For example, + Compute Engine returns NO_RESULTS_ON_PAGE if there are no + results in the response. + type: string + enumDescriptions: + - >- + Warning about failed cleanup of transient changes made by a + failed operation. + - A link to a deprecated resource was created. + - >- + When deploying and at least one of the resources has a type + marked as deprecated + - The user created a boot disk that is larger than image size. + - >- + When deploying and at least one of the resources has a type + marked as experimental + - Warning that is present in an external api call + - >- + Warning that value of a field has been overridden. Deprecated + unused field. + - >- + The operation involved use of an injected kernel, which is + deprecated. + - >- + A WEIGHTED_MAGLEV backend service is associated with a health + check that is not of type HTTP/HTTPS/HTTP2. + - >- + When deploying a deployment with a exceedingly large number of + resources + - >- + Resource can't be retrieved due to list overhead quota exceed + which captures the amount of resources filtered out by + user-defined list filter. + - A resource depends on a missing type + - >- + The route's nextHopIp address is not assigned to an instance + on the network. + - The route's next hop instance cannot ip forward. + - >- + The route's nextHopInstance URL refers to an instance that + does not have an ipv6 interface on the same network as the + route. + - >- + The route's nextHopInstance URL refers to an instance that + does not exist. + - >- + The route's nextHopInstance URL refers to an instance that is + not on the same network as the route. + - >- + The route's next hop instance does not have a status of + RUNNING. + - >- + Error which is not critical. We decided to continue the + process despite the mentioned error. + - No results are present on a particular list page. + - >- + Success is reported, but some results may be missing due to + errors + - >- + Quota information is not available to client requests (e.g: + regions.list). + - >- + The user attempted to use a resource that requires a TOS they + have not accepted. + - Warning that a resource is in use. + - >- + One or more of the resources set to auto-delete could not be + deleted because they were in use. + - When a resource schema validation is ignored. + - >- + Instance template used in instance group manager is valid as + such, but its application does not make a lot of sense, + because it allows only single instance in instance group. + - When undeclared properties in the schema are present + - A given scope cannot be reached. + enumDeprecated: + - false + - false + - false + - false + - false + - false + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + enum: + - CLEANUP_FAILED + - DEPRECATED_RESOURCE_USED + - DEPRECATED_TYPE_USED + - DISK_SIZE_LARGER_THAN_IMAGE_SIZE + - EXPERIMENTAL_TYPE_USED + - EXTERNAL_API_WARNING + - FIELD_VALUE_OVERRIDEN + - INJECTED_KERNELS_DEPRECATED + - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB + - LARGE_DEPLOYMENT_WARNING + - LIST_OVERHEAD_QUOTA_EXCEED + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE + - NEXT_HOP_INSTANCE_NOT_FOUND + - NEXT_HOP_INSTANCE_NOT_ON_NETWORK + - NEXT_HOP_NOT_RUNNING + - NOT_CRITICAL_ERROR + - NO_RESULTS_ON_PAGE + - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE + - REQUIRED_TOS_AGREEMENT + - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING + - RESOURCE_NOT_DELETED + - SCHEMA_VALIDATION_IGNORED + - SINGLE_INSTANCE_PROPERTY_TEMPLATE + - UNDECLARED_PROPERTIES + - UNREACHABLE + message: + description: '[Output Only] A human-readable description of the warning code.' + type: string + data: + description: >- + [Output Only] Metadata about this warning in key: value format. + For example: "data": [ { "key": "scope", "value": + "zones/us-east1-d" } + type: array + items: + type: object + properties: + key: + description: >- + [Output Only] A key that provides more detail on the + warning being returned. For example, for warnings where + there are no results in a list request for a particular + zone, this key might be scope and the key value might be + the zone name. Other examples might be a key indicating a + deprecated resource and a suggested replacement, or a + warning about invalid network settings (for example, if an + instance attempts to perform IP forwarding but is not + enabled for IP forwarding). + type: string + value: + description: >- + [Output Only] A warning data value corresponding to the + key. + type: string + InstanceGroupsAddInstancesRequest: + id: InstanceGroupsAddInstancesRequest + type: object + properties: + instances: + description: The list of instances to add to the instance group. + type: array + items: + $ref: '#/components/schemas/InstanceReference' + InstanceReference: + id: InstanceReference + type: object + properties: + instance: 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])?' - annotations: - required: - - compute.instanceGroupManagers.insert - - compute.regionInstanceGroupManagers.insert - type: string - description: - description: An optional description of this resource. + The URL for a specific instance. @required + compute.instancegroups.addInstances/removeInstances type: string - zone: + InstanceGroupsRemoveInstancesRequest: + id: InstanceGroupsRemoveInstancesRequest + type: object + properties: + instances: + description: The list of instances to remove from the instance group. + type: array + items: + $ref: '#/components/schemas/InstanceReference' + InstanceGroupsListInstancesRequest: + id: InstanceGroupsListInstancesRequest + type: object + properties: + instanceState: description: >- - [Output Only] The URL of a zone where the managed instance group is - located (for zonal resources). + 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. type: string - region: + enumDescriptions: + - >- + Includes all instances in the generated list regardless of their + state. + - >- + Includes instances in the generated list only if they have a + RUNNING state. + enum: + - ALL + - RUNNING + InstanceGroupsListInstances: + id: InstanceGroupsListInstances + type: object + properties: + kind: description: >- - [Output Only] The URL of the region where the managed instance group - resides (for regional resources). + [Output Only] The resource type, which is always + compute#instanceGroupsListInstances for the list of instances in the + specified instance group. + default: compute#instanceGroupsListInstances type: string - distributionPolicy: - description: >- - Policy specifying the intended distribution of managed instances - across zones in a regional managed instance group. - $ref: '#/components/schemas/DistributionPolicy' - instanceTemplate: + id: 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. + [Output Only] Unique identifier for the resource; defined by the + server. type: string - 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: + description: A list of InstanceWithNamedPorts resources. type: array items: - $ref: '#/components/schemas/InstanceGroupManagerVersion' - allInstancesConfig: + $ref: '#/components/schemas/InstanceWithNamedPorts' + nextPageToken: description: >- - Specifies configuration that overrides the instance template - configuration for the group. - $ref: '#/components/schemas/InstanceGroupManagerAllInstancesConfig' - instanceGroup: - description: '[Output Only] The URL of the Instance Group resource.' + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. type: string - 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. - type: array - items: - type: string - baseInstanceName: - description: >- - The base instance name is a prefix that you want to attach to the - names of all VMs in a MIG. The maximum character length is 58 and - the name must comply with RFC1035 format. When a VM is created in - the group, the MIG appends a hyphen and a random four-character - string to the base instance name. If you want the MIG to assign - sequential numbers instead of a random string, then end the base - instance name with a hyphen followed by one or more hash symbols. - The hash symbols indicate the number of digits. For example, a base - instance name of "vm-###" results in "vm-001" as a VM name. @pattern - [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,51}-#{1,10}(\\[[0-9]{1,10}\\])?)) + selfLink: + description: '[Output Only] Server-defined URL for this resource.' type: string - 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. + warning: + description: '[Output Only] Informational warning message.' + type: object + properties: + code: + description: >- + [Output Only] A warning code, if applicable. For example, + Compute Engine returns NO_RESULTS_ON_PAGE if there are no + results in the response. + type: string + enumDescriptions: + - >- + Warning about failed cleanup of transient changes made by a + failed operation. + - A link to a deprecated resource was created. + - >- + When deploying and at least one of the resources has a type + marked as deprecated + - The user created a boot disk that is larger than image size. + - >- + When deploying and at least one of the resources has a type + marked as experimental + - Warning that is present in an external api call + - >- + Warning that value of a field has been overridden. Deprecated + unused field. + - >- + The operation involved use of an injected kernel, which is + deprecated. + - >- + A WEIGHTED_MAGLEV backend service is associated with a health + check that is not of type HTTP/HTTPS/HTTP2. + - >- + When deploying a deployment with a exceedingly large number of + resources + - >- + Resource can't be retrieved due to list overhead quota exceed + which captures the amount of resources filtered out by + user-defined list filter. + - A resource depends on a missing type + - >- + The route's nextHopIp address is not assigned to an instance + on the network. + - The route's next hop instance cannot ip forward. + - >- + The route's nextHopInstance URL refers to an instance that + does not have an ipv6 interface on the same network as the + route. + - >- + The route's nextHopInstance URL refers to an instance that + does not exist. + - >- + The route's nextHopInstance URL refers to an instance that is + not on the same network as the route. + - >- + The route's next hop instance does not have a status of + RUNNING. + - >- + Error which is not critical. We decided to continue the + process despite the mentioned error. + - No results are present on a particular list page. + - >- + Success is reported, but some results may be missing due to + errors + - >- + Quota information is not available to client requests (e.g: + regions.list). + - >- + The user attempted to use a resource that requires a TOS they + have not accepted. + - Warning that a resource is in use. + - >- + One or more of the resources set to auto-delete could not be + deleted because they were in use. + - When a resource schema validation is ignored. + - >- + Instance template used in instance group manager is valid as + such, but its application does not make a lot of sense, + because it allows only single instance in instance group. + - When undeclared properties in the schema are present + - A given scope cannot be reached. + enumDeprecated: + - false + - false + - false + - false + - false + - false + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + enum: + - CLEANUP_FAILED + - DEPRECATED_RESOURCE_USED + - DEPRECATED_TYPE_USED + - DISK_SIZE_LARGER_THAN_IMAGE_SIZE + - EXPERIMENTAL_TYPE_USED + - EXTERNAL_API_WARNING + - FIELD_VALUE_OVERRIDEN + - INJECTED_KERNELS_DEPRECATED + - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB + - LARGE_DEPLOYMENT_WARNING + - LIST_OVERHEAD_QUOTA_EXCEED + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE + - NEXT_HOP_INSTANCE_NOT_FOUND + - NEXT_HOP_INSTANCE_NOT_ON_NETWORK + - NEXT_HOP_NOT_RUNNING + - NOT_CRITICAL_ERROR + - NO_RESULTS_ON_PAGE + - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE + - REQUIRED_TOS_AGREEMENT + - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING + - RESOURCE_NOT_DELETED + - SCHEMA_VALIDATION_IGNORED + - SINGLE_INSTANCE_PROPERTY_TEMPLATE + - UNDECLARED_PROPERTIES + - UNREACHABLE + message: + description: '[Output Only] A human-readable description of the warning code.' + type: string + data: + description: >- + [Output Only] Metadata about this warning in key: value format. + For example: "data": [ { "key": "scope", "value": + "zones/us-east1-d" } + type: array + items: + type: object + properties: + key: + description: >- + [Output Only] A key that provides more detail on the + warning being returned. For example, for warnings where + there are no results in a list request for a particular + zone, this key might be scope and the key value might be + the zone name. Other examples might be a key indicating a + deprecated resource and a suggested replacement, or a + warning about invalid network settings (for example, if an + instance attempts to perform IP forwarding but is not + enabled for IP forwarding). + type: string + value: + description: >- + [Output Only] A warning data value corresponding to the + key. + type: string + InstanceWithNamedPorts: + id: InstanceWithNamedPorts + type: object + properties: + instance: + description: '[Output Only] The URL of the instance.' type: string - format: byte - currentActions: - 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. - $ref: '#/components/schemas/InstanceGroupManagerActionsSummary' status: - description: '[Output Only] The status of this managed instance group.' - $ref: '#/components/schemas/InstanceGroupManagerStatus' - 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. - annotations: - required: - - compute.instanceGroupManagers.insert - - compute.regionInstanceGroupManagers.insert - type: integer - format: int32 - instanceFlexibilityPolicy: - description: >- - Instance flexibility allowing MIG to create VMs from multiple types - of machines. Instance flexibility configuration on MIG overrides - instance template configuration. - $ref: '#/components/schemas/InstanceGroupManagerInstanceFlexibilityPolicy' - listManagedInstancesResults: - description: >- - Pagination behavior of the listManagedInstances API method for this - managed instance group. + description: '[Output Only] The status of the instance.' type: string enumDescriptions: - >- - (Default) Pagination is disabled for the group's - listManagedInstances API method. maxResults and pageToken query - parameters are ignored and all instances are returned in a single - response. + The instance is halted and we are performing tear down tasks like + network deprogramming, releasing quota, IP, tearing down disks + etc. + - Resources are being allocated for the instance. + - The instance is in repair. + - The instance is running. - >- - Pagination is enabled for the group's listManagedInstances API - method. maxResults and pageToken query parameters are respected. + All required resources have been allocated and the instance is + being started. + - The instance has stopped successfully. + - >- + The instance is currently stopping (either being deleted or + killed). + - The instance has suspended. + - The instance is suspending. + - >- + The instance has stopped (either by explicit action or underlying + failure). enum: - - PAGELESS - - PAGINATED - selfLink: - description: >- - [Output Only] The URL for this managed instance group. The server - defines this URL. - type: string - autoHealingPolicies: - description: >- - The autohealing policy for this managed instance group. You can - specify only one value. - type: array - items: - $ref: '#/components/schemas/InstanceGroupManagerAutoHealingPolicy' - updatePolicy: - description: The update policy for this managed instance group. - $ref: '#/components/schemas/InstanceGroupManagerUpdatePolicy' + - DEPROVISIONING + - PROVISIONING + - REPAIRING + - RUNNING + - STAGING + - STOPPED + - STOPPING + - SUSPENDED + - SUSPENDING + - TERMINATED namedPorts: - description: >- - [Output Only] Named ports configured on the Instance Groups - complementary to this Instance Group Manager. + description: '[Output Only] The named ports that belong to this instance group.' type: array items: $ref: '#/components/schemas/NamedPort' - statefulPolicy: - description: Stateful configuration for this Instanced Group Manager - $ref: '#/components/schemas/StatefulPolicy' - instanceLifecyclePolicy: - description: The repair policy for this managed instance group. - $ref: '#/components/schemas/InstanceGroupManagerInstanceLifecyclePolicy' - satisfiesPzi: - description: '[Output Only] Reserved for future use.' - type: boolean - satisfiesPzs: - description: '[Output Only] Reserved for future use.' - type: boolean - DistributionPolicy: - id: DistributionPolicy + InstanceGroupsSetNamedPortsRequest: + id: InstanceGroupsSetNamedPortsRequest type: object properties: - zones: - description: >- - Zones where the regional managed instance group will create and - manage its instances. + namedPorts: + description: The list of named ports to set for this instance group. type: array items: - $ref: '#/components/schemas/DistributionPolicyZoneConfiguration' - targetShape: + $ref: '#/components/schemas/NamedPort' + fingerprint: description: >- - The distribution shape to which the group converges either - proactively or on resize events (depending on the value set in - updatePolicy.instanceRedistributionType). + 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. type: string - enumDescriptions: - - >- - The group picks zones for creating VM instances to fulfill the - requested number of VMs within present resource constraints and to - maximize utilization of unused zonal reservations. Recommended for - batch workloads that do not require high availability. - - >- - The group creates all VM instances within a single zone. The zone - is selected based on the present resource constraints and to - maximize utilization of unused zonal reservations. Recommended for - batch workloads with heavy interprocess communication. - - >- - The group prioritizes acquisition of resources, scheduling VMs in - zones where resources are available while distributing VMs as - evenly as possible across selected zones to minimize the impact of - zonal failure. Recommended for highly available serving workloads. - - >- - The group schedules VM instance creation and deletion to achieve - and maintain an even number of managed instances across the - selected zones. The distribution is even when the number of - managed instances does not differ by more than 1 between any two - zones. Recommended for highly available serving workloads. - enum: - - ANY - - ANY_SINGLE_ZONE - - BALANCED - - EVEN - DistributionPolicyZoneConfiguration: - id: DistributionPolicyZoneConfiguration + format: byte + RegionInstanceGroupList: + id: RegionInstanceGroupList + description: Contains a list of InstanceGroup resources. type: object properties: - zone: - description: >- - The URL of the zone. The zone must exist in the region where the - managed instance group is located. - annotations: - required: - - compute.regionInstanceGroupManagers.insert + kind: + description: The resource type. + default: compute#regionInstanceGroupList type: string - InstanceGroupManagerVersion: - id: InstanceGroupManagerVersion - type: object - properties: - name: + id: description: >- - Name of the version. Unique among all versions in the scope of this - managed instance group. + [Output Only] Unique identifier for the resource; defined by the + server. type: string - instanceTemplate: + items: + description: A list of InstanceGroup resources. + type: array + items: + $ref: '#/components/schemas/InstanceGroup' + nextPageToken: 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. + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. type: string - targetSize: - 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. - $ref: '#/components/schemas/FixedOrPercent' - FixedOrPercent: - id: FixedOrPercent - description: Encapsulates numeric value that can be either absolute or relative. - type: object - properties: - fixed: - description: >- - Specifies a fixed number of VM instances. This must be a positive - integer. - type: integer - format: int32 - percent: - description: >- - Specifies a percentage of instances between 0 to 100%, inclusive. - For example, specify 80 for 80%. - type: integer - format: int32 - 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. - type: integer - format: int32 - InstanceGroupManagerAllInstancesConfig: - id: InstanceGroupManagerAllInstancesConfig - type: object - properties: - properties: - description: >- - Properties to set on all instances in the group. You can add or - modify properties using the instanceGroupManagers.patch or - regionInstanceGroupManagers.patch. After setting allInstancesConfig - on the group, you must update the group's instances to apply the - configuration. To apply the configuration, set the group's - updatePolicy.type field to use proactive updates or use the - applyUpdatesToInstances method. - $ref: '#/components/schemas/InstancePropertiesPatch' - InstancePropertiesPatch: - id: InstancePropertiesPatch - description: Represents the change that you want to make to the instance properties. - type: object - properties: - metadata: - description: >- - The metadata key-value pairs that you want to patch onto the - instance. For more information, see Project and instance metadata. - type: object - additionalProperties: - type: string - labels: - description: The label key-value pairs that you want to patch onto the instance. - type: object - additionalProperties: - type: string - InstanceGroupManagerActionsSummary: - id: InstanceGroupManagerActionsSummary - type: object - properties: - none: - description: >- - [Output Only] The number of instances in the managed instance group - that are running and have no scheduled actions. - type: integer - format: int32 - 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. - type: integer - format: int32 - 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. - type: integer - format: int32 - 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. - type: integer - format: int32 - 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. - type: integer - format: int32 - deleting: - description: >- - [Output Only] The number of instances in the managed instance group - that are scheduled to be deleted or are currently being deleted. - type: integer - format: int32 - 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. - type: integer - format: int32 - restarting: - description: >- - [Output Only] The number of instances in the managed instance group - that are scheduled to be restarted or are currently being restarted. - type: integer - format: int32 - 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. - type: integer - format: int32 - suspending: - description: >- - [Output Only] The number of instances in the managed instance group - that are scheduled to be suspended or are currently being suspended. - type: integer - format: int32 - resuming: - description: >- - [Output Only] The number of instances in the managed instance group - that are scheduled to be resumed or are currently being resumed. - type: integer - format: int32 - stopping: - description: >- - [Output Only] The number of instances in the managed instance group - that are scheduled to be stopped or are currently being stopped. - type: integer - format: int32 - starting: - description: >- - [Output Only] The number of instances in the managed instance group - that are scheduled to be started or are currently being started. - type: integer - format: int32 - InstanceGroupManagerStatus: - id: InstanceGroupManagerStatus - type: object - properties: - 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 - allInstancesConfig: - description: '[Output only] Status of all-instances configuration on the group.' - $ref: '#/components/schemas/InstanceGroupManagerStatusAllInstancesConfig' - versionTarget: - description: >- - [Output Only] A status of consistency of Instances' versions with - their target version specified by version field on Instance Group - Manager. - $ref: '#/components/schemas/InstanceGroupManagerStatusVersionTarget' - stateful: - description: '[Output Only] Stateful status of the given Instance Group Manager.' - $ref: '#/components/schemas/InstanceGroupManagerStatusStateful' - autoscaler: - description: >- - [Output Only] The URL of the Autoscaler that targets this instance - group manager. - type: string - InstanceGroupManagerStatusAllInstancesConfig: - id: InstanceGroupManagerStatusAllInstancesConfig - type: object - properties: - effective: - description: >- - [Output Only] A bit indicating whether this configuration has been - applied to all managed instances in the group. - type: boolean - currentRevision: - description: >- - [Output Only] Current all-instances configuration revision. This - value is in RFC3339 text format. - type: string - InstanceGroupManagerStatusVersionTarget: - id: InstanceGroupManagerStatusVersionTarget - type: object - 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 - InstanceGroupManagerStatusStateful: - id: InstanceGroupManagerStatusStateful - type: object - 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 configuration even when there - is still some preserved state on a managed instance, for example, if - you have deleted all PICs but not yet applied those deletions. - type: boolean - perInstanceConfigs: - description: >- - [Output Only] Status of per-instance configurations on the - instances. - $ref: >- - #/components/schemas/InstanceGroupManagerStatusStatefulPerInstanceConfigs - InstanceGroupManagerStatusStatefulPerInstanceConfigs: - id: InstanceGroupManagerStatusStatefulPerInstanceConfigs - type: object - properties: - allEffective: - description: >- - A bit indicating if all of the group's per-instance configurations - (listed in the output of a listPerInstanceConfigs API call) have - status EFFECTIVE or there are no per-instance-configs. - type: boolean - InstanceGroupManagerInstanceFlexibilityPolicy: - id: InstanceGroupManagerInstanceFlexibilityPolicy - type: object - properties: - instanceSelections: - description: >- - Named instance selections configuring properties that the group will - use when creating new VMs. - type: object - additionalProperties: - $ref: >- - #/components/schemas/InstanceGroupManagerInstanceFlexibilityPolicyInstanceSelection - InstanceGroupManagerInstanceFlexibilityPolicyInstanceSelection: - id: InstanceGroupManagerInstanceFlexibilityPolicyInstanceSelection - type: object - properties: - machineTypes: - description: Full machine-type names, e.g. "n1-standard-16". - type: array - items: - type: string - rank: - description: >- - Preference of this instance selection. Lower number means higher - preference. MIG will first try to create a VM based on the - machine-type with lowest rank and fallback to next rank based on - availability. Machine types and instance selections with the same - rank have the same preference. - type: integer - format: int32 - InstanceGroupManagerAutoHealingPolicy: - id: InstanceGroupManagerAutoHealingPolicy - type: object - properties: - healthCheck: - description: The URL for the health check that signals autohealing. - type: string - initialDelaySec: - description: >- - The initial delay is the number of seconds that a new VM takes to - initialize and run its startup script. During a VM's initial delay - period, the MIG ignores unsuccessful health checks because the VM - might be in the startup process. This prevents the MIG from - prematurely recreating a VM. If the health check receives a healthy - response during the initial delay, it indicates that the startup - process is complete and the VM is ready. The value of initial delay - must be between 0 and 3600 seconds. The default value is 0. - type: integer - format: int32 - InstanceGroupManagerUpdatePolicy: - id: InstanceGroupManagerUpdatePolicy - type: object - properties: - type: - description: >- - The type of update process. You can specify either PROACTIVE so that - the MIG automatically updates VMs to the latest configurations or - OPPORTUNISTIC so that you can select the VMs that you want to - update. - type: string - enumDescriptions: - - >- - MIG will apply new configurations to existing VMs only when you - selectively target specific or all VMs to be updated. - - >- - MIG will automatically apply new configurations to all or a subset - of existing VMs and also to new VMs that are added to the group. - enum: - - OPPORTUNISTIC - - PROACTIVE - 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. - type: string - enumDescriptions: - - >- - No action is being proactively performed in order to bring this - IGM to its target instance distribution. - - >- - This IGM will actively converge to its target instance - distribution. - enum: - - NONE - - PROACTIVE - minimalAction: - description: >- - Minimal action to be taken on an instance. Use this option to - minimize disruption as much as possible or to apply a more - disruptive action than is necessary. - To limit disruption as much - as possible, set the minimal action to REFRESH. If your update - requires a more disruptive action, Compute Engine performs the - necessary action to execute the update. - To apply a more disruptive - action than is strictly necessary, set the minimal action to RESTART - or REPLACE. For example, Compute Engine does not need to restart a - VM to change its metadata. But if your application reads instance - metadata only when a VM is restarted, you can set the minimal action - to RESTART in order to pick up metadata changes. - type: string - enumDescriptions: - - Do not perform any action. - - Do not stop the instance. - - >- - (Default.) Replace the instance according to the replacement - method option. - - Stop the instance and start it again. - enum: - - NONE - - REFRESH - - REPLACE - - RESTART - mostDisruptiveAllowedAction: - description: >- - Most disruptive action that is allowed to be taken on an instance. - You can specify either NONE to forbid any actions, REFRESH to avoid - restarting the VM and to limit disruption as much as possible. - RESTART to allow actions that can be applied without instance - replacing or REPLACE to allow all possible actions. If the Updater - determines that the minimal update action needed is more disruptive - than most disruptive allowed action you specify it will not perform - the update at all. - type: string - enumDescriptions: - - Do not perform any action. - - Do not stop the instance. - - >- - (Default.) Replace the instance according to the replacement - method option. - - Stop the instance and start it again. - enum: - - NONE - - REFRESH - - REPLACE - - RESTART - maxSurge: - 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. - $ref: '#/components/schemas/FixedOrPercent' - maxUnavailable: - 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. - $ref: '#/components/schemas/FixedOrPercent' - replacementMethod: - description: >- - What action should be used to replace instances. See - minimal_action.REPLACE - type: string - enumDescriptions: - - Instances will be recreated (with the same name) - - >- - Default option: instances will be deleted and created (with a new - name) - enum: - - RECREATE - - SUBSTITUTE - StatefulPolicy: - id: StatefulPolicy - type: object - properties: - preservedState: - $ref: '#/components/schemas/StatefulPolicyPreservedState' - StatefulPolicyPreservedState: - id: StatefulPolicyPreservedState - description: Configuration of preserved resources. - type: object - properties: - disks: - 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 - additionalProperties: - $ref: '#/components/schemas/StatefulPolicyPreservedStateDiskDevice' - internalIPs: - description: >- - Internal network IPs assigned to the instances that will be - preserved on instance delete, update, etc. This map is keyed with - the network interface name. - type: object - additionalProperties: - $ref: '#/components/schemas/StatefulPolicyPreservedStateNetworkIp' - externalIPs: - description: >- - External network IPs assigned to the instances that will be - preserved on instance delete, update, etc. This map is keyed with - the network interface name. - type: object - additionalProperties: - $ref: '#/components/schemas/StatefulPolicyPreservedStateNetworkIp' - StatefulPolicyPreservedStateDiskDevice: - id: StatefulPolicyPreservedStateDiskDevice - type: object - 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. - type: string - enumDescriptions: - - '' - - '' - enum: - - NEVER - - ON_PERMANENT_INSTANCE_DELETION - StatefulPolicyPreservedStateNetworkIp: - id: StatefulPolicyPreservedStateNetworkIp - type: object - properties: - autoDelete: - description: >- - These stateful IPs will never be released during autohealing, update - or VM instance recreate operations. This flag is used to configure - if the IP reservation should be deleted after it is no longer used - by the group, e.g. when the given instance or the whole group is - deleted. - type: string - enumDescriptions: - - '' - - '' - enum: - - NEVER - - ON_PERMANENT_INSTANCE_DELETION - InstanceGroupManagerInstanceLifecyclePolicy: - id: InstanceGroupManagerInstanceLifecyclePolicy - type: object - properties: - forceUpdateOnRepair: - description: >- - A bit indicating whether to forcefully apply the group's latest - configuration when repairing a VM. Valid options are: - NO - (default): If configuration updates are available, they are not - forcefully applied during repair. Instead, configuration updates are - applied according to the group's update policy. - YES: If - configuration updates are available, they are applied during - repair. - type: string - enumDescriptions: - - '' - - '' - enum: - - 'NO' - - 'YES' - defaultActionOnFailure: - description: >- - The action that a MIG performs on a failed or an unhealthy VM. A VM - is marked as unhealthy when the application running on that VM fails - a health check. Valid values are - REPAIR (default): MIG - automatically repairs a failed or an unhealthy VM by recreating it. - For more information, see About repairing VMs in a MIG. - - DO_NOTHING: MIG does not repair a failed or an unhealthy VM. - type: string - enumDescriptions: - - MIG does not repair a failed or an unhealthy VM. - - >- - (Default) MIG automatically repairs a failed or an unhealthy VM by - recreating it. For more information, see About repairing VMs in a - MIG. - enum: - - DO_NOTHING - - REPAIR - InstanceGroupManagerAggregatedList: - id: InstanceGroupManagerAggregatedList - type: object - properties: - kind: - description: >- - [Output Only] The resource type, which is always - compute#instanceGroupManagerAggregatedList for an aggregated list of - managed instance groups. - default: compute#instanceGroupManagerAggregatedList - type: string - id: - description: >- - [Output Only] Unique identifier for the resource; defined by the - server. - type: string - items: - description: A list of InstanceGroupManagersScopedList resources. - type: object - additionalProperties: - description: >- - [Output Only] The name of the scope that contains this set of - managed instance groups. - $ref: '#/components/schemas/InstanceGroupManagersScopedList' - nextPageToken: - description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. - type: string - selfLink: - description: '[Output Only] Server-defined URL for this resource.' - type: string - warning: - description: '[Output Only] Informational warning message.' + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string + warning: + description: '[Output Only] Informational warning message.' type: object properties: code: @@ -14584,6 +14238,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -14627,6 +14284,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -14649,6 +14307,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -14685,29 +14344,65 @@ components: [Output Only] A warning data value corresponding to the key. type: string - unreachables: - description: '[Output Only] Unreachable resources.' - type: array - items: - type: string - InstanceGroupManagersScopedList: - id: InstanceGroupManagersScopedList + RegionInstanceGroupsListInstancesRequest: + id: RegionInstanceGroupsListInstancesRequest type: object properties: - instanceGroupManagers: + instanceState: description: >- - [Output Only] The list of managed instance groups that are contained - in the specified project and zone. + Instances in which state should be returned. Valid options are: + 'ALL', 'RUNNING'. By default, it lists all instances. + type: string + enumDescriptions: + - >- + Matches any status of the instances, running, non-running and + others. + - Instance is in RUNNING state if it is running. + enum: + - ALL + - RUNNING + 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 + RegionInstanceGroupsListInstances: + id: RegionInstanceGroupsListInstances + type: object + properties: + kind: + description: The resource type. + default: compute#regionInstanceGroupsListInstances + type: string + id: + description: >- + [Output Only] Unique identifier for the resource; defined by the + server. + type: string + items: + description: A list of InstanceWithNamedPorts resources. type: array items: - $ref: '#/components/schemas/InstanceGroupManager' - warning: + $ref: '#/components/schemas/InstanceWithNamedPorts' + nextPageToken: description: >- - [Output Only] The warning that replaces the list of managed instance - groups when the list is empty. - type: object - properties: - code: + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. + type: string + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string + warning: + description: '[Output Only] Informational warning message.' + type: object + properties: + code: description: >- [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no @@ -14767,6 +14462,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -14810,6 +14508,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -14832,6 +14531,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -14868,56 +14568,283 @@ components: [Output Only] A warning data value corresponding to the key. type: string - InstanceGroupManagersDeleteInstancesRequest: - id: InstanceGroupManagersDeleteInstancesRequest + RegionInstanceGroupsSetNamedPortsRequest: + id: RegionInstanceGroupsSetNamedPortsRequest type: object 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]. - Queued instances do not have URL and can be deleted only by name. - One cannot specify both URLs and names in a single request. + namedPorts: + description: The list of named ports to set for this instance group. type: array items: - type: string - skipInstancesOnValidationError: + $ref: '#/components/schemas/NamedPort' + fingerprint: 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 - InstanceGroupManagersAbandonInstancesRequest: - id: InstanceGroupManagersAbandonInstancesRequest + 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. + type: string + format: byte + InstanceGroupManagerList: + id: InstanceGroupManagerList + description: '[Output Only] A list of managed instance groups.' type: object properties: - instances: + id: 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]. + [Output Only] Unique identifier for the resource; defined by the + server. + type: string + items: + description: A list of InstanceGroupManager resources. type: array items: - type: string - InstanceGroupManagersRecreateInstancesRequest: - id: InstanceGroupManagersRecreateInstancesRequest - type: object - properties: - instances: + $ref: '#/components/schemas/InstanceGroupManager' + nextPageToken: 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]. - type: array - items: - type: string - InstanceGroupManagersSetInstanceTemplateRequest: - id: InstanceGroupManagersSetInstanceTemplateRequest + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. + type: string + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string + warning: + description: '[Output Only] Informational warning message.' + type: object + properties: + code: + description: >- + [Output Only] A warning code, if applicable. For example, + Compute Engine returns NO_RESULTS_ON_PAGE if there are no + results in the response. + type: string + enumDescriptions: + - >- + Warning about failed cleanup of transient changes made by a + failed operation. + - A link to a deprecated resource was created. + - >- + When deploying and at least one of the resources has a type + marked as deprecated + - The user created a boot disk that is larger than image size. + - >- + When deploying and at least one of the resources has a type + marked as experimental + - Warning that is present in an external api call + - >- + Warning that value of a field has been overridden. Deprecated + unused field. + - >- + The operation involved use of an injected kernel, which is + deprecated. + - >- + A WEIGHTED_MAGLEV backend service is associated with a health + check that is not of type HTTP/HTTPS/HTTP2. + - >- + When deploying a deployment with a exceedingly large number of + resources + - >- + Resource can't be retrieved due to list overhead quota exceed + which captures the amount of resources filtered out by + user-defined list filter. + - A resource depends on a missing type + - >- + The route's nextHopIp address is not assigned to an instance + on the network. + - The route's next hop instance cannot ip forward. + - >- + The route's nextHopInstance URL refers to an instance that + does not have an ipv6 interface on the same network as the + route. + - >- + The route's nextHopInstance URL refers to an instance that + does not exist. + - >- + The route's nextHopInstance URL refers to an instance that is + not on the same network as the route. + - >- + The route's next hop instance does not have a status of + RUNNING. + - >- + Error which is not critical. We decided to continue the + process despite the mentioned error. + - No results are present on a particular list page. + - >- + Success is reported, but some results may be missing due to + errors + - >- + Quota information is not available to client requests (e.g: + regions.list). + - >- + The user attempted to use a resource that requires a TOS they + have not accepted. + - Warning that a resource is in use. + - >- + One or more of the resources set to auto-delete could not be + deleted because they were in use. + - When a resource schema validation is ignored. + - >- + Instance template used in instance group manager is valid as + such, but its application does not make a lot of sense, + because it allows only single instance in instance group. + - When undeclared properties in the schema are present + - A given scope cannot be reached. + enumDeprecated: + - false + - false + - false + - false + - false + - false + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + enum: + - CLEANUP_FAILED + - DEPRECATED_RESOURCE_USED + - DEPRECATED_TYPE_USED + - DISK_SIZE_LARGER_THAN_IMAGE_SIZE + - EXPERIMENTAL_TYPE_USED + - EXTERNAL_API_WARNING + - FIELD_VALUE_OVERRIDEN + - INJECTED_KERNELS_DEPRECATED + - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB + - LARGE_DEPLOYMENT_WARNING + - LIST_OVERHEAD_QUOTA_EXCEED + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE + - NEXT_HOP_INSTANCE_NOT_FOUND + - NEXT_HOP_INSTANCE_NOT_ON_NETWORK + - NEXT_HOP_NOT_RUNNING + - NOT_CRITICAL_ERROR + - NO_RESULTS_ON_PAGE + - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE + - REQUIRED_TOS_AGREEMENT + - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING + - RESOURCE_NOT_DELETED + - SCHEMA_VALIDATION_IGNORED + - SINGLE_INSTANCE_PROPERTY_TEMPLATE + - UNDECLARED_PROPERTIES + - UNREACHABLE + message: + description: '[Output Only] A human-readable description of the warning code.' + type: string + data: + description: >- + [Output Only] Metadata about this warning in key: value format. + For example: "data": [ { "key": "scope", "value": + "zones/us-east1-d" } + type: array + items: + type: object + properties: + key: + description: >- + [Output Only] A key that provides more detail on the + warning being returned. For example, for warnings where + there are no results in a list request for a particular + zone, this key might be scope and the key value might be + the zone name. Other examples might be a key indicating a + deprecated resource and a suggested replacement, or a + warning about invalid network settings (for example, if an + instance attempts to perform IP forwarding but is not + enabled for IP forwarding). + type: string + value: + description: >- + [Output Only] A warning data value corresponding to the + key. + type: string + kind: + description: >- + [Output Only] The resource type, which is always + compute#instanceGroupManagerList for a list of managed instance + groups. + default: compute#instanceGroupManagerList + type: string + InstanceGroupManager: + id: 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. type: object properties: + kind: + description: >- + [Output Only] The resource type, which is always + compute#instanceGroupManager for managed instance groups. + default: compute#instanceGroupManager + type: string + id: + description: >- + [Output Only] A unique identifier for this resource type. The server + generates this identifier. + type: string + format: uint64 + creationTimestamp: + description: >- + [Output Only] The creation timestamp for this managed instance group + in RFC3339 text format. + 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])?' + annotations: + required: + - compute.instanceGroupManagers.insert + - compute.regionInstanceGroupManagers.insert + type: string + description: + description: An optional description of this resource. + type: string + zone: + description: >- + [Output Only] The URL of a zone where the managed instance group is + located (for zonal resources). + type: string + region: + description: >- + [Output Only] The URL of the region where the managed instance group + resides (for regional resources). + type: string + distributionPolicy: + description: >- + Policy specifying the intended distribution of managed instances + across zones in a regional managed instance group. + $ref: '#/components/schemas/DistributionPolicy' instanceTemplate: description: >- The URL of the instance template that is specified for this managed @@ -14927,538 +14854,841 @@ components: recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. type: string - InstanceGroupManagersSetTargetPoolsRequest: - id: InstanceGroupManagersSetTargetPoolsRequest - type: object - properties: - targetPools: + versions: 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. + 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. type: array items: - type: string - fingerprint: + $ref: '#/components/schemas/InstanceGroupManagerVersion' + allInstancesConfig: 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. + Specifies configuration that overrides the instance template + configuration for the group. + $ref: '#/components/schemas/InstanceGroupManagerAllInstancesConfig' + instanceGroup: + description: '[Output Only] The URL of the Instance Group resource.' type: string - format: byte - InstanceGroupManagersListManagedInstancesResponse: - id: InstanceGroupManagersListManagedInstancesResponse - type: object - properties: - managedInstances: - description: '[Output Only] The list of instances in the 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. type: array items: - $ref: '#/components/schemas/ManagedInstance' - nextPageToken: + type: string + baseInstanceName: description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. + The base instance name is a prefix that you want to attach to the + names of all VMs in a MIG. The maximum character length is 58 and + the name must comply with RFC1035 format. When a VM is created in + the group, the MIG appends a hyphen and a random four-character + string to the base instance name. If you want the MIG to assign + sequential numbers instead of a random string, then end the base + instance name with a hyphen followed by one or more hash symbols. + The hash symbols indicate the number of digits. For example, a base + instance name of "vm-###" results in "vm-001" as a VM name. @pattern + [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,51}-#{1,10}(\\[[0-9]{1,10}\\])?)) type: string - ManagedInstance: - id: ManagedInstance - description: A Managed Instance resource. - type: object - properties: - name: + fingerprint: description: >- - [Output Only] The name of the instance. The name always exists even - if the instance has not yet been created. + 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. type: string - instance: + format: byte + currentActions: description: >- - [Output Only] The URL of the instance. The URL can exist even if the - instance has not yet been created. - type: string - id: + [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. + $ref: '#/components/schemas/InstanceGroupManagerActionsSummary' + status: + description: '[Output Only] The status of this managed instance group.' + $ref: '#/components/schemas/InstanceGroupManagerStatus' + targetSize: description: >- - [Output only] The unique identifier for this resource. This field is - empty when instance does not exist. - type: string - format: uint64 - instanceStatus: + 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. + annotations: + required: + - compute.instanceGroupManagers.insert + - compute.regionInstanceGroupManagers.insert + type: integer + format: int32 + instanceFlexibilityPolicy: description: >- - [Output Only] The status of the instance. This field is empty when - the instance does not exist. + Instance flexibility allowing MIG to create VMs from multiple types + of machines. Instance flexibility configuration on MIG overrides + instance template configuration. + $ref: '#/components/schemas/InstanceGroupManagerInstanceFlexibilityPolicy' + targetStoppedSize: + description: >- + The target number of stopped instances for this managed instance + group. This number changes when you: - Stop instance using the + stopInstances method or start instances using the startInstances + method. - Manually change the targetStoppedSize using the update + method. + type: integer + format: int32 + targetSuspendedSize: + description: >- + The target number of suspended instances for this managed instance + group. This number changes when you: - Suspend instance using the + suspendInstances method or resume instances using the + resumeInstances method. - Manually change the targetSuspendedSize + using the update method. + type: integer + format: int32 + listManagedInstancesResults: + description: >- + Pagination behavior of the listManagedInstances API method for this + managed instance group. type: string enumDescriptions: - >- - The instance is halted and we are performing tear down tasks like - network deprogramming, releasing quota, IP, tearing down disks - etc. - - Resources are being allocated for the instance. - - The instance is in repair. - - The instance is running. - - >- - All required resources have been allocated and the instance is - being started. - - The instance has stopped successfully. - - >- - The instance is currently stopping (either being deleted or - killed). - - The instance has suspended. - - The instance is suspending. + (Default) Pagination is disabled for the group's + listManagedInstances API method. maxResults and pageToken query + parameters are ignored and all instances are returned in a single + response. - >- - The instance has stopped (either by explicit action or underlying - failure). + Pagination is enabled for the group's listManagedInstances API + method. maxResults and pageToken query parameters are respected. enum: - - DEPROVISIONING - - PROVISIONING - - REPAIRING - - RUNNING - - STAGING - - STOPPED - - STOPPING - - SUSPENDED - - SUSPENDING - - TERMINATED - version: - description: '[Output Only] Intended version of this instance.' - $ref: '#/components/schemas/ManagedInstanceVersion' - preservedStateFromPolicy: + - PAGELESS + - PAGINATED + standbyPolicy: + description: Standby policy for stopped and suspended instances. + $ref: '#/components/schemas/InstanceGroupManagerStandbyPolicy' + selfLink: description: >- - [Output Only] Preserved state generated based on stateful policy for - this instance. - $ref: '#/components/schemas/PreservedState' - preservedStateFromConfig: + [Output Only] The URL for this managed instance group. The server + defines this URL. + type: string + autoHealingPolicies: description: >- - [Output Only] Preserved state applied from per-instance config for - this instance. - $ref: '#/components/schemas/PreservedState' - currentAction: + The autohealing policy for this managed instance group. You can + specify only one value. + type: array + items: + $ref: '#/components/schemas/InstanceGroupManagerAutoHealingPolicy' + updatePolicy: + description: The update policy for this managed instance group. + $ref: '#/components/schemas/InstanceGroupManagerUpdatePolicy' + namedPorts: 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. + [Output Only] Named ports configured on the Instance Groups + complementary to this Instance Group Manager. + type: array + items: + $ref: '#/components/schemas/NamedPort' + statefulPolicy: + description: Stateful configuration for this Instanced Group Manager + $ref: '#/components/schemas/StatefulPolicy' + instanceLifecyclePolicy: + description: The repair policy for this managed instance group. + $ref: '#/components/schemas/InstanceGroupManagerInstanceLifecyclePolicy' + satisfiesPzi: + description: '[Output Only] Reserved for future use.' + type: boolean + satisfiesPzs: + description: '[Output Only] Reserved for future use.' + type: boolean + resourcePolicies: + description: Resource policies for this managed instance group. + $ref: '#/components/schemas/InstanceGroupManagerResourcePolicies' + DistributionPolicy: + id: DistributionPolicy + type: object + properties: + zones: + description: >- + Zones where the regional managed instance group will create and + manage its instances. + type: array + items: + $ref: '#/components/schemas/DistributionPolicyZoneConfiguration' + targetShape: + description: >- + The distribution shape to which the group converges either + proactively or on resize events (depending on the value set in + updatePolicy.instanceRedistributionType). type: string enumDescriptions: - >- - 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. - - >- - The managed instance group is creating this instance. If the group - fails to create this instance, it will try again until it is - successful. - - >- - 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. - - The managed instance group is permanently deleting this instance. + The group picks zones for creating VM instances to fulfill the + requested number of VMs within present resource constraints and to + maximize utilization of unused zonal reservations. Recommended for + batch workloads that do not require high availability. - >- - The managed instance group has not scheduled any actions for this - instance. - - The managed instance group is recreating this instance. + The group creates all VM instances within a single zone. The zone + is selected based on the present resource constraints and to + maximize utilization of unused zonal reservations. Recommended for + batch workloads with heavy interprocess communication. - >- - 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. - - The managed instance group is restarting this instance. - - The managed instance group is resuming this instance. - - The managed instance group is starting this instance. - - The managed instance group is stopping this instance. - - The managed instance group is suspending this instance. + The group prioritizes acquisition of resources, scheduling VMs in + zones where resources are available while distributing VMs as + evenly as possible across selected zones to minimize the impact of + zonal failure. Recommended for highly available serving workloads. - >- - The managed instance group is verifying this already created - instance. Verification happens every time the instance is - (re)created or restarted and consists of: 1. Waiting until health - check specified as part of this managed instance group's - autohealing policy reports HEALTHY. Note: Applies only if - autohealing policy has a health check specified 2. Waiting for - addition verification steps performed as post-instance creation - (subject to future extensions). + The group schedules VM instance creation and deletion to achieve + and maintain an even number of managed instances across the + selected zones. The distribution is even when the number of + managed instances does not differ by more than 1 between any two + zones. Recommended for highly available serving workloads. enum: - - ABANDONING - - CREATING - - CREATING_WITHOUT_RETRIES - - DELETING - - NONE - - RECREATING - - REFRESHING - - RESTARTING - - RESUMING - - STARTING - - STOPPING - - SUSPENDING - - VERIFYING - instanceHealth: - description: '[Output Only] Health state of the instance per health-check.' - type: array - items: - $ref: '#/components/schemas/ManagedInstanceInstanceHealth' - lastAttempt: - description: >- - [Output Only] Information about the last attempt to create or delete - the instance. - $ref: '#/components/schemas/ManagedInstanceLastAttempt' - propertiesFromFlexibilityPolicy: + - ANY + - ANY_SINGLE_ZONE + - BALANCED + - EVEN + DistributionPolicyZoneConfiguration: + id: DistributionPolicyZoneConfiguration + type: object + properties: + zone: description: >- - [Output Only] Instance properties selected for this instance - resulting from InstanceFlexibilityPolicy. - $ref: '#/components/schemas/ManagedInstancePropertiesFromFlexibilityPolicy' - ManagedInstanceVersion: - id: ManagedInstanceVersion + The URL of the zone. The zone must exist in the region where the + managed instance group is located. + annotations: + required: + - compute.regionInstanceGroupManagers.insert + type: string + InstanceGroupManagerVersion: + id: InstanceGroupManagerVersion type: object properties: name: - description: '[Output Only] Name of the version.' + description: >- + Name of the version. Unique among all versions in the scope of this + managed instance group. type: string instanceTemplate: description: >- - [Output Only] The intended template of the instance. This field is - empty when current_action is one of { DELETING, ABANDONING }. + 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 - PreservedState: - id: PreservedState - description: Preserved state for a given instance. + targetSize: + 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. + $ref: '#/components/schemas/FixedOrPercent' + FixedOrPercent: + id: FixedOrPercent + description: Encapsulates numeric value that can be either absolute or relative. type: object properties: - disks: + fixed: description: >- - Preserved disks defined for this instance. This map is keyed with - the device names of the disks. - type: object - additionalProperties: - $ref: '#/components/schemas/PreservedStatePreservedDisk' + Specifies a fixed number of VM instances. This must be a positive + integer. + type: integer + format: int32 + percent: + description: >- + Specifies a percentage of instances between 0 to 100%, inclusive. + For example, specify 80 for 80%. + type: integer + format: int32 + 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. + type: integer + format: int32 + InstanceGroupManagerAllInstancesConfig: + id: InstanceGroupManagerAllInstancesConfig + type: object + properties: + properties: + description: >- + Properties to set on all instances in the group. You can add or + modify properties using the instanceGroupManagers.patch or + regionInstanceGroupManagers.patch. After setting allInstancesConfig + on the group, you must update the group's instances to apply the + configuration. To apply the configuration, set the group's + updatePolicy.type field to use proactive updates or use the + applyUpdatesToInstances method. + $ref: '#/components/schemas/InstancePropertiesPatch' + InstancePropertiesPatch: + id: InstancePropertiesPatch + description: Represents the change that you want to make to the instance properties. + type: object + properties: metadata: - description: Preserved metadata defined for this instance. + description: >- + The metadata key-value pairs that you want to patch onto the + instance. For more information, see Project and instance metadata. type: object additionalProperties: type: string - internalIPs: - description: >- - Preserved internal IPs defined for this instance. This map is keyed - with the name of the network interface. + labels: + description: The label key-value pairs that you want to patch onto the instance. type: object additionalProperties: - $ref: '#/components/schemas/PreservedStatePreservedNetworkIp' - externalIPs: + type: string + InstanceGroupManagerActionsSummary: + id: InstanceGroupManagerActionsSummary + type: object + properties: + none: description: >- - Preserved external IPs defined for this instance. This map is keyed - with the name of the network interface. - type: object - additionalProperties: - $ref: '#/components/schemas/PreservedStatePreservedNetworkIp' - PreservedStatePreservedDisk: - id: PreservedStatePreservedDisk + [Output Only] The number of instances in the managed instance group + that are running and have no scheduled actions. + type: integer + format: int32 + 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. + type: integer + format: int32 + 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. + type: integer + format: int32 + 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. + type: integer + format: int32 + 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. + type: integer + format: int32 + deleting: + description: >- + [Output Only] The number of instances in the managed instance group + that are scheduled to be deleted or are currently being deleted. + type: integer + format: int32 + 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. + type: integer + format: int32 + restarting: + description: >- + [Output Only] The number of instances in the managed instance group + that are scheduled to be restarted or are currently being restarted. + type: integer + format: int32 + 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. + type: integer + format: int32 + suspending: + description: >- + [Output Only] The number of instances in the managed instance group + that are scheduled to be suspended or are currently being suspended. + type: integer + format: int32 + resuming: + description: >- + [Output Only] The number of instances in the managed instance group + that are scheduled to be resumed or are currently being resumed. + type: integer + format: int32 + stopping: + description: >- + [Output Only] The number of instances in the managed instance group + that are scheduled to be stopped or are currently being stopped. + type: integer + format: int32 + starting: + description: >- + [Output Only] The number of instances in the managed instance group + that are scheduled to be started or are currently being started. + type: integer + format: int32 + InstanceGroupManagerStatus: + id: InstanceGroupManagerStatus type: object properties: - source: + isStable: description: >- - The URL of the disk resource that is stateful and should be attached - to the VM instance. - type: string - mode: + [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 + allInstancesConfig: + description: '[Output only] Status of all-instances configuration on the group.' + $ref: '#/components/schemas/InstanceGroupManagerStatusAllInstancesConfig' + versionTarget: 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. - type: string - enumDescriptions: - - >- - Attaches this disk in read-only mode. Multiple VM instances can - use a disk in READ_ONLY mode at a time. - - >- - *[Default]* Attaches this disk in READ_WRITE mode. Only one VM - instance at a time can be attached to a disk in READ_WRITE mode. - enum: - - READ_ONLY - - READ_WRITE - autoDelete: + [Output Only] A status of consistency of Instances' versions with + their target version specified by version field on Instance Group + Manager. + $ref: '#/components/schemas/InstanceGroupManagerStatusVersionTarget' + stateful: + description: '[Output Only] Stateful status of the given Instance Group Manager.' + $ref: '#/components/schemas/InstanceGroupManagerStatusStateful' + autoscaler: 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. + [Output Only] The URL of the Autoscaler that targets this instance + group manager. type: string - enumDescriptions: - - '' - - '' - enum: - - NEVER - - ON_PERMANENT_INSTANCE_DELETION - PreservedStatePreservedNetworkIp: - id: PreservedStatePreservedNetworkIp + InstanceGroupManagerStatusAllInstancesConfig: + id: InstanceGroupManagerStatusAllInstancesConfig type: object properties: - autoDelete: + effective: description: >- - These stateful IPs will never be released during autohealing, update - or VM instance recreate operations. This flag is used to configure - if the IP reservation should be deleted after it is no longer used - by the group, e.g. when the given instance or the whole group is - deleted. + [Output Only] A bit indicating whether this configuration has been + applied to all managed instances in the group. + type: boolean + currentRevision: + description: >- + [Output Only] Current all-instances configuration revision. This + value is in RFC3339 text format. type: string - enumDescriptions: - - '' - - '' - enum: - - NEVER - - ON_PERMANENT_INSTANCE_DELETION - ipAddress: - description: Ip address representation - $ref: '#/components/schemas/PreservedStatePreservedNetworkIpIpAddress' - PreservedStatePreservedNetworkIpIpAddress: - id: PreservedStatePreservedNetworkIpIpAddress + InstanceGroupManagerStatusVersionTarget: + id: InstanceGroupManagerStatusVersionTarget type: object properties: - literal: + isReached: description: >- - An IPv4 internal network address to assign to the instance for this - network interface. - type: string - address: - description: The URL of the reservation for this IP address. - type: string - ManagedInstanceInstanceHealth: - id: ManagedInstanceInstanceHealth + [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 + InstanceGroupManagerStatusStateful: + id: InstanceGroupManagerStatusStateful type: object properties: - healthCheck: + hasStatefulConfig: description: >- - [Output Only] The URL for the health check that verifies whether the - instance is healthy. - type: string - detailedHealthState: - description: '[Output Only] The current detailed instance health state.' - type: string - enumDescriptions: - - >- - The instance is being drained. The existing connections to the - instance have time to complete, but the new ones are being - refused. - - >- - The instance is reachable i.e. a connection to the application - health checking endpoint can be established, and conforms to the - requirements defined by the health check. - - >- - The instance is unreachable i.e. a connection to the application - health checking endpoint cannot be established, or the server does - not respond within the specified timeout. - - >- - The instance is reachable, but does not conform to the - requirements defined by the health check. - - >- - The health checking system is aware of the instance but its health - is not known at the moment. - enum: - - DRAINING - - HEALTHY - - TIMEOUT - - UNHEALTHY - - UNKNOWN - ManagedInstanceLastAttempt: - id: ManagedInstanceLastAttempt + [Output Only] A bit indicating whether the managed instance group + has stateful configuration, that is, if you have configured any + items in a stateful policy or in per-instance configs. The group + might report that it has no stateful configuration even when there + is still some preserved state on a managed instance, for example, if + you have deleted all PICs but not yet applied those deletions. + type: boolean + perInstanceConfigs: + description: >- + [Output Only] Status of per-instance configurations on the + instances. + $ref: >- + #/components/schemas/InstanceGroupManagerStatusStatefulPerInstanceConfigs + InstanceGroupManagerStatusStatefulPerInstanceConfigs: + id: InstanceGroupManagerStatusStatefulPerInstanceConfigs type: object properties: - errors: + allEffective: description: >- - [Output Only] Encountered errors during the last attempt to create - or delete the instance. + A bit indicating if all of the group's per-instance configurations + (listed in the output of a listPerInstanceConfigs API call) have + status EFFECTIVE or there are no per-instance-configs. + type: boolean + InstanceGroupManagerInstanceFlexibilityPolicy: + id: InstanceGroupManagerInstanceFlexibilityPolicy + type: object + properties: + instanceSelections: + description: >- + Named instance selections configuring properties that the group will + use when creating new VMs. type: object - properties: - errors: - description: >- - [Output Only] The array of errors encountered while processing - this operation. - type: array - items: - type: object - 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 - errorDetails: - description: >- - [Output Only] An optional list of messages that contain - the error details. There is a set of defined message types - to use for providing details.The syntax depends on the - error code. For example, QuotaExceededInfo will have - details when the error code is QUOTA_EXCEEDED. - type: array - items: - type: object - properties: - errorInfo: - $ref: '#/components/schemas/ErrorInfo' - quotaInfo: - $ref: '#/components/schemas/QuotaExceededInfo' - help: - $ref: '#/components/schemas/Help' - localizedMessage: - $ref: '#/components/schemas/LocalizedMessage' - ManagedInstancePropertiesFromFlexibilityPolicy: - id: ManagedInstancePropertiesFromFlexibilityPolicy - type: object - properties: - machineType: - description: The machine type to be used for this instance. - type: string - InstanceGroupManagersListErrorsResponse: - id: InstanceGroupManagersListErrorsResponse + additionalProperties: + $ref: >- + #/components/schemas/InstanceGroupManagerInstanceFlexibilityPolicyInstanceSelection + InstanceGroupManagerInstanceFlexibilityPolicyInstanceSelection: + id: InstanceGroupManagerInstanceFlexibilityPolicyInstanceSelection type: object properties: - items: - description: '[Output Only] The list of errors of the managed instance group.' + machineTypes: + description: Full machine-type names, e.g. "n1-standard-16". type: array items: - $ref: '#/components/schemas/InstanceManagedByIgmError' - nextPageToken: + type: string + rank: description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. - type: string - InstanceManagedByIgmError: - id: InstanceManagedByIgmError + Preference of this instance selection. Lower number means higher + preference. MIG will first try to create a VM based on the + machine-type with lowest rank and fallback to next rank based on + availability. Machine types and instance selections with the same + rank have the same preference. + type: integer + format: int32 + InstanceGroupManagerStandbyPolicy: + id: InstanceGroupManagerStandbyPolicy type: object properties: - error: - description: '[Output Only] Contents of the error.' - $ref: '#/components/schemas/InstanceManagedByIgmErrorManagedInstanceError' - timestamp: + initialDelaySec: description: >- - [Output Only] The time that this error occurred. This value is in - RFC3339 text format. - type: string - instanceActionDetails: + Specifies the number of seconds that the MIG should wait to suspend + or stop a VM after that VM was created. The initial delay gives the + initialization script the time to prepare your VM for a quick scale + out. The value of initial delay must be between 0 and 3600 seconds. + The default value is 0. + type: integer + format: int32 + mode: 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. - $ref: '#/components/schemas/InstanceManagedByIgmErrorInstanceActionDetails' - InstanceManagedByIgmErrorManagedInstanceError: - id: InstanceManagedByIgmErrorManagedInstanceError + Defines how a MIG resumes or starts VMs from a standby pool when the + group scales out. The default mode is `MANUAL`. + type: string + enumDescriptions: + - >- + MIG does not automatically resume or start VMs in the standby pool + when the group scales out. + - >- + MIG automatically resumes or starts VMs in the standby pool when + the group scales out, and replenishes the standby pool afterwards. + enum: + - MANUAL + - SCALE_OUT_POOL + InstanceGroupManagerAutoHealingPolicy: + id: InstanceGroupManagerAutoHealingPolicy type: object properties: - code: - description: '[Output Only] Error code.' - type: string - message: - description: '[Output Only] Error message.' + healthCheck: + description: The URL for the health check that signals autohealing. type: string - InstanceManagedByIgmErrorInstanceActionDetails: - id: InstanceManagedByIgmErrorInstanceActionDetails + initialDelaySec: + description: >- + The initial delay is the number of seconds that a new VM takes to + initialize and run its startup script. During a VM's initial delay + period, the MIG ignores unsuccessful health checks because the VM + might be in the startup process. This prevents the MIG from + prematurely recreating a VM. If the health check receives a healthy + response during the initial delay, it indicates that the startup + process is complete and the VM is ready. The value of initial delay + must be between 0 and 3600 seconds. The default value is 0. + type: integer + format: int32 + InstanceGroupManagerUpdatePolicy: + id: InstanceGroupManagerUpdatePolicy type: object properties: - action: + type: description: >- - [Output Only] Action that managed instance group was executing on - the instance when the error occurred. Possible values: + The type of update process. You can specify either PROACTIVE so that + the MIG automatically updates VMs to the latest configurations or + OPPORTUNISTIC so that you can select the VMs that you want to + update. type: string enumDescriptions: - >- - 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. + MIG will apply new configurations to existing VMs only when you + selectively target specific or all VMs to be updated. - >- - The managed instance group is creating this instance. If the group - fails to create this instance, it will try again until it is - successful. + MIG will automatically apply new configurations to all or a subset + of existing VMs and also to new VMs that are added to the group. + enum: + - OPPORTUNISTIC + - PROACTIVE + 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. + type: string + enumDescriptions: - >- - 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. - - The managed instance group is permanently deleting this instance. + No action is being proactively performed in order to bring this + IGM to its target instance distribution. - >- - The managed instance group has not scheduled any actions for this - instance. - - The managed instance group is recreating this instance. + This IGM will actively converge to its target instance + distribution. + enum: + - NONE + - PROACTIVE + minimalAction: + description: >- + Minimal action to be taken on an instance. Use this option to + minimize disruption as much as possible or to apply a more + disruptive action than is necessary. - To limit disruption as much + as possible, set the minimal action to REFRESH. If your update + requires a more disruptive action, Compute Engine performs the + necessary action to execute the update. - To apply a more disruptive + action than is strictly necessary, set the minimal action to RESTART + or REPLACE. For example, Compute Engine does not need to restart a + VM to change its metadata. But if your application reads instance + metadata only when a VM is restarted, you can set the minimal action + to RESTART in order to pick up metadata changes. + type: string + enumDescriptions: + - Do not perform any action. + - Do not stop the instance. - >- - 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. - - The managed instance group is restarting this instance. - - The managed instance group is resuming this instance. - - The managed instance group is starting this instance. - - The managed instance group is stopping this instance. - - The managed instance group is suspending this instance. + (Default.) Replace the instance according to the replacement + method option. + - Stop the instance and start it again. + enum: + - NONE + - REFRESH + - REPLACE + - RESTART + mostDisruptiveAllowedAction: + description: >- + Most disruptive action that is allowed to be taken on an instance. + You can specify either NONE to forbid any actions, REFRESH to avoid + restarting the VM and to limit disruption as much as possible. + RESTART to allow actions that can be applied without instance + replacing or REPLACE to allow all possible actions. If the Updater + determines that the minimal update action needed is more disruptive + than most disruptive allowed action you specify it will not perform + the update at all. + type: string + enumDescriptions: + - Do not perform any action. + - Do not stop the instance. - >- - The managed instance group is verifying this already created - instance. Verification happens every time the instance is - (re)created or restarted and consists of: 1. Waiting until health - check specified as part of this managed instance group's - autohealing policy reports HEALTHY. Note: Applies only if - autohealing policy has a health check specified 2. Waiting for - addition verification steps performed as post-instance creation - (subject to future extensions). + (Default.) Replace the instance according to the replacement + method option. + - Stop the instance and start it again. enum: - - ABANDONING - - CREATING - - CREATING_WITHOUT_RETRIES - - DELETING - NONE - - RECREATING - - REFRESHING - - RESTARTING - - RESUMING - - STARTING - - STOPPING - - SUSPENDING - - VERIFYING - instance: + - REFRESH + - REPLACE + - RESTART + maxSurge: description: >- - [Output Only] The URL of the instance. The URL can be set even if - the instance has not yet been created. + 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. + $ref: '#/components/schemas/FixedOrPercent' + maxUnavailable: + 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. + $ref: '#/components/schemas/FixedOrPercent' + replacementMethod: + description: >- + What action should be used to replace instances. See + minimal_action.REPLACE type: string - version: + enumDescriptions: + - Instances will be recreated (with the same name) + - >- + Default option: instances will be deleted and created (with a new + name) + enum: + - RECREATE + - SUBSTITUTE + StatefulPolicy: + id: StatefulPolicy + type: object + properties: + preservedState: + $ref: '#/components/schemas/StatefulPolicyPreservedState' + StatefulPolicyPreservedState: + id: StatefulPolicyPreservedState + description: Configuration of preserved resources. + type: object + properties: + disks: 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. - $ref: '#/components/schemas/ManagedInstanceVersion' - InstanceGroupManagersListPerInstanceConfigsResp: - id: InstanceGroupManagersListPerInstanceConfigsResp + 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 + additionalProperties: + $ref: '#/components/schemas/StatefulPolicyPreservedStateDiskDevice' + internalIPs: + description: >- + Internal network IPs assigned to the instances that will be + preserved on instance delete, update, etc. This map is keyed with + the network interface name. + type: object + additionalProperties: + $ref: '#/components/schemas/StatefulPolicyPreservedStateNetworkIp' + externalIPs: + description: >- + External network IPs assigned to the instances that will be + preserved on instance delete, update, etc. This map is keyed with + the network interface name. + type: object + additionalProperties: + $ref: '#/components/schemas/StatefulPolicyPreservedStateNetworkIp' + StatefulPolicyPreservedStateDiskDevice: + id: StatefulPolicyPreservedStateDiskDevice + type: object + 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. + type: string + enumDescriptions: + - '' + - '' + enum: + - NEVER + - ON_PERMANENT_INSTANCE_DELETION + StatefulPolicyPreservedStateNetworkIp: + id: StatefulPolicyPreservedStateNetworkIp + type: object + properties: + autoDelete: + description: >- + These stateful IPs will never be released during autohealing, update + or VM instance recreate operations. This flag is used to configure + if the IP reservation should be deleted after it is no longer used + by the group, e.g. when the given instance or the whole group is + deleted. + type: string + enumDescriptions: + - '' + - '' + enum: + - NEVER + - ON_PERMANENT_INSTANCE_DELETION + InstanceGroupManagerInstanceLifecyclePolicy: + id: InstanceGroupManagerInstanceLifecyclePolicy + type: object + properties: + forceUpdateOnRepair: + description: >- + A bit indicating whether to forcefully apply the group's latest + configuration when repairing a VM. Valid options are: - NO + (default): If configuration updates are available, they are not + forcefully applied during repair. Instead, configuration updates are + applied according to the group's update policy. - YES: If + configuration updates are available, they are applied during + repair. + type: string + enumDescriptions: + - '' + - '' + enum: + - 'NO' + - 'YES' + defaultActionOnFailure: + description: >- + The action that a MIG performs on a failed or an unhealthy VM. A VM + is marked as unhealthy when the application running on that VM fails + a health check. Valid values are - REPAIR (default): MIG + automatically repairs a failed or an unhealthy VM by recreating it. + For more information, see About repairing VMs in a MIG. - + DO_NOTHING: MIG does not repair a failed or an unhealthy VM. + type: string + enumDescriptions: + - MIG does not repair a failed or an unhealthy VM. + - >- + (Default) MIG automatically repairs a failed or an unhealthy VM by + recreating it. For more information, see About repairing VMs in a + MIG. + enum: + - DO_NOTHING + - REPAIR + InstanceGroupManagerResourcePolicies: + id: InstanceGroupManagerResourcePolicies + type: object + properties: + workloadPolicy: + description: >- + The URL of the workload policy that is specified for this managed + instance group. It can be a full or partial URL. For example, the + following are all valid URLs to a workload policy: - + https://www.googleapis.com/compute/v1/projects/project/regions/region + /resourcePolicies/resourcePolicy - + projects/project/regions/region/resourcePolicies/resourcePolicy - + regions/region/resourcePolicies/resourcePolicy + type: string + InstanceGroupManagerAggregatedList: + id: InstanceGroupManagerAggregatedList type: object properties: + kind: + description: >- + [Output Only] The resource type, which is always + compute#instanceGroupManagerAggregatedList for an aggregated list of + managed instance groups. + default: compute#instanceGroupManagerAggregatedList + type: string + id: + description: >- + [Output Only] Unique identifier for the resource; defined by the + server. + type: string items: - description: '[Output Only] The list of PerInstanceConfig.' - type: array - items: - $ref: '#/components/schemas/PerInstanceConfig' + description: A list of InstanceGroupManagersScopedList resources. + type: object + additionalProperties: + description: >- + [Output Only] The name of the scope that contains this set of + managed instance groups. + $ref: '#/components/schemas/InstanceGroupManagersScopedList' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -15467,6 +15697,9 @@ components: pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. type: string + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string warning: description: '[Output Only] Informational warning message.' type: object @@ -15531,6 +15764,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -15574,6 +15810,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -15596,6 +15833,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -15632,414 +15870,26 @@ components: [Output Only] A warning data value corresponding to the key. type: string - PerInstanceConfig: - id: PerInstanceConfig - type: object - properties: - name: - description: >- - The name of a per-instance configuration and its corresponding - instance. Serves as a merge key during UpdatePerInstanceConfigs - operations, that is, if a per-instance configuration 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 configconfiguration for a VM instance that either - doesn't exist or is not part of the group will result in an error. - type: string - preservedState: - description: >- - The intended preserved state for the given instance. Does not - contain preserved state generated from a stateful policy. - $ref: '#/components/schemas/PreservedState' - status: - description: >- - The status of applying this per-instance configuration on the - corresponding managed instance. - type: string - enumDescriptions: - - >- - The per-instance configuration is being applied to the instance, - but is not yet effective, possibly waiting for the instance to, - for example, REFRESH. - - >- - The per-instance configuration deletion is being applied on the - instance, possibly waiting for the instance to, for example, - REFRESH. - - >- - The per-instance configuration is effective on the instance, - meaning that all disks, ips and metadata specified in this - configuration are attached or set on the instance. - - >- - *[Default]* The default status, when no per-instance configuration - exists. - - >- - The per-instance configuration is set on an instance but not been - applied yet. - - >- - The per-instance configuration has been deleted, but the deletion - is not yet applied. - enum: - - APPLYING - - DELETING - - EFFECTIVE - - NONE - - UNAPPLIED - - UNAPPLIED_DELETION - 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 configuration or the field needs to - be unset. - type: string - format: byte - InstanceGroupManagersUpdatePerInstanceConfigsReq: - id: InstanceGroupManagersUpdatePerInstanceConfigsReq - description: InstanceGroupManagers.updatePerInstanceConfigs - type: object - properties: - perInstanceConfigs: - description: >- - The list of per-instance configurations to insert or patch on this - managed instance group. + unreachables: + description: '[Output Only] Unreachable resources.' type: array items: - $ref: '#/components/schemas/PerInstanceConfig' - InstanceGroupManagersPatchPerInstanceConfigsReq: - id: InstanceGroupManagersPatchPerInstanceConfigsReq - description: InstanceGroupManagers.patchPerInstanceConfigs + type: string + InstanceGroupManagersScopedList: + id: InstanceGroupManagersScopedList type: object properties: - perInstanceConfigs: + instanceGroupManagers: description: >- - The list of per-instance configurations to insert or patch on this - managed instance group. - type: array - items: - $ref: '#/components/schemas/PerInstanceConfig' - InstanceGroupManagersDeletePerInstanceConfigsReq: - id: InstanceGroupManagersDeletePerInstanceConfigsReq - description: InstanceGroupManagers.deletePerInstanceConfigs - type: object - properties: - names: - description: >- - The list of instance names for which we want to delete per-instance - configs on this managed instance group. - type: array - items: - type: string - InstanceGroupManagersApplyUpdatesRequest: - id: InstanceGroupManagersApplyUpdatesRequest - description: InstanceGroupManagers.applyUpdatesToInstances - type: object - properties: - 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]. - type: array - items: - type: string - 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 and limit disruption as much as possible. - - 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. - type: string - enumDescriptions: - - Do not perform any action. - - Do not stop the instance. - - >- - (Default.) Replace the instance according to the replacement - method option. - - Stop the instance and start it again. - enum: - - NONE - - REFRESH - - REPLACE - - RESTART - 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 and limit disruption as much as possible. - - 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. - type: string - enumDescriptions: - - Do not perform any action. - - Do not stop the instance. - - >- - (Default.) Replace the instance according to the replacement - method option. - - Stop the instance and start it again. - enum: - - NONE - - REFRESH - - REPLACE - - RESTART - allInstances: - description: >- - Flag to update all instances instead of specified list of - “instances”. If the flag is set to true then the instances may not - be specified in the request. - type: boolean - InstanceGroupManagersCreateInstancesRequest: - id: InstanceGroupManagersCreateInstancesRequest - description: InstanceGroupManagers.createInstances - type: object - properties: - instances: - description: '[Required] List of specifications of per-instance configs.' - type: array - items: - $ref: '#/components/schemas/PerInstanceConfig' - InstanceGroupManagerResizeRequest: - id: InstanceGroupManagerResizeRequest - description: >- - InstanceGroupManagerResizeRequest represents a request to create a - number of VMs: either immediately or by queuing the request for the - specified time. This resize request is nested under InstanceGroupManager - and the VMs created by this request are added to the owning - InstanceGroupManager. - type: object - properties: - kind: - description: >- - [Output Only] The resource type, which is always - compute#instanceGroupManagerResizeRequest for resize requests. - default: compute#instanceGroupManagerResizeRequest - type: string - id: - description: >- - [Output Only] A unique identifier for this resource type. The server - generates this identifier. - type: string - format: uint64 - creationTimestamp: - description: >- - [Output Only] The creation timestamp for this resize request in - RFC3339 text format. - type: string - name: - description: >- - The name of this resize request. The name must be 1-63 characters - long, and comply with RFC1035. - pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' - annotations: - required: - - compute.instanceGroupManagerResizeRequests.insert - type: string - description: - description: An optional description of this resource. - type: string - zone: - description: >- - [Output Only] The URL of a zone where the resize request is located. - Populated only for zonal resize requests. - type: string - resizeBy: - description: >- - The number of instances to be created by this resize request. The - group's target size will be increased by this number. This field - cannot be used together with 'instances'. - type: integer - format: int32 - requestedRunDuration: - description: >- - Requested run duration for instances that will be created by this - request. At the end of the run duration instance will be deleted. - $ref: '#/components/schemas/Duration' - state: - description: '[Output only] Current state of the request.' - type: string - enumDescriptions: - - >- - The request was created successfully and was accepted for - provisioning when the capacity becomes available. - - The request is cancelled. - - Resize request is being created and may still fail creation. - - >- - The request failed before or during provisioning. If the request - fails during provisioning, any VMs that were created during - provisioning are rolled back and removed from the MIG. - - Default value. This value should never be returned. - - The request succeeded. - enum: - - ACCEPTED - - CANCELLED - - CREATING - - FAILED - - STATE_UNSPECIFIED - - SUCCEEDED - status: - description: '[Output only] Status of the request.' - $ref: '#/components/schemas/InstanceGroupManagerResizeRequestStatus' - selfLink: - description: >- - [Output Only] The URL for this resize request. The server defines - this URL. - type: string - selfLinkWithId: - description: >- - [Output Only] Server-defined URL for this resource with the resource - id. - type: string - InstanceGroupManagerResizeRequestStatus: - id: InstanceGroupManagerResizeRequestStatus - type: object - properties: - error: - description: >- - [Output only] Fatal errors encountered during the queueing or - provisioning phases of the ResizeRequest that caused the transition - to the FAILED state. Contrary to the last_attempt errors, this field - is final and errors are never removed from here, as the - ResizeRequest is not going to retry. - type: object - properties: - errors: - description: >- - [Output Only] The array of errors encountered while processing - this operation. - type: array - items: - type: object - 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 - errorDetails: - description: >- - [Output Only] An optional list of messages that contain - the error details. There is a set of defined message types - to use for providing details.The syntax depends on the - error code. For example, QuotaExceededInfo will have - details when the error code is QUOTA_EXCEEDED. - type: array - items: - type: object - properties: - errorInfo: - $ref: '#/components/schemas/ErrorInfo' - quotaInfo: - $ref: '#/components/schemas/QuotaExceededInfo' - help: - $ref: '#/components/schemas/Help' - localizedMessage: - $ref: '#/components/schemas/LocalizedMessage' - lastAttempt: - description: >- - [Output only] Information about the last attempt to fulfill the - request. The value is temporary since the ResizeRequest can retry, - as long as it's still active and the last attempt value can either - be cleared or replaced with a different error. Since ResizeRequest - retries infrequently, the value may be stale and no longer show an - active problem. The value is cleared when ResizeRequest transitions - to the final state (becomes inactive). If the final state is FAILED - the error describing it will be storred in the "error" field only. - $ref: >- - #/components/schemas/InstanceGroupManagerResizeRequestStatusLastAttempt - InstanceGroupManagerResizeRequestStatusLastAttempt: - id: InstanceGroupManagerResizeRequestStatusLastAttempt - type: object - properties: - error: - description: Errors that prevented the ResizeRequest to be fulfilled. - type: object - properties: - errors: - description: >- - [Output Only] The array of errors encountered while processing - this operation. - type: array - items: - type: object - 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 - errorDetails: - description: >- - [Output Only] An optional list of messages that contain - the error details. There is a set of defined message types - to use for providing details.The syntax depends on the - error code. For example, QuotaExceededInfo will have - details when the error code is QUOTA_EXCEEDED. - type: array - items: - type: object - properties: - errorInfo: - $ref: '#/components/schemas/ErrorInfo' - quotaInfo: - $ref: '#/components/schemas/QuotaExceededInfo' - help: - $ref: '#/components/schemas/Help' - localizedMessage: - $ref: '#/components/schemas/LocalizedMessage' - InstanceGroupManagerResizeRequestsListResponse: - id: InstanceGroupManagerResizeRequestsListResponse - description: '[Output Only] A list of resize requests.' - type: object - properties: - kind: - description: >- - [Output Only] Type of the resource. Always - compute#instanceGroupManagerResizeRequestList for a list of resize - requests. - default: compute#instanceGroupManagerResizeRequestList - type: string - id: - description: >- - [Output Only] Unique identifier for the resource; defined by the - server. - type: string - items: - description: A list of resize request resources. + [Output Only] The list of managed instance groups that are contained + in the specified project and zone. type: array items: - $ref: '#/components/schemas/InstanceGroupManagerResizeRequest' - nextPageToken: - description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. - type: string - selfLink: - description: '[Output Only] Server-defined URL for this resource.' - type: string + $ref: '#/components/schemas/InstanceGroupManager' warning: - description: '[Output Only] Informational warning message.' + description: >- + [Output Only] The warning that replaces the list of managed instance + groups when the list is empty. type: object properties: code: @@ -16102,6 +15952,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -16145,6 +15998,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -16167,6 +16021,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -16203,28 +16058,151 @@ components: [Output Only] A warning data value corresponding to the key. type: string - RegionInstanceGroupManagerList: - id: RegionInstanceGroupManagerList - description: Contains a list of managed instance groups. + InstanceGroupManagersDeleteInstancesRequest: + id: InstanceGroupManagersDeleteInstancesRequest type: object properties: - kind: + instances: description: >- - [Output Only] The resource type, which is always - compute#instanceGroupManagerList for a list of managed instance - groups that exist in th regional scope. - default: compute#regionInstanceGroupManagerList + 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]. + Queued instances do not have URL and can be deleted only by name. + One cannot specify both URLs and names in a single request. + type: array + items: + type: string + 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 + InstanceGroupManagersSuspendInstancesRequest: + id: InstanceGroupManagersSuspendInstancesRequest + type: object + properties: + instances: + description: >- + The URLs of one or more instances to suspend. This can be a full URL + or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + type: array + items: + type: string + forceSuspend: + description: >- + If this flag is set to true, the Instance Group Manager will proceed + to suspend the instances, skipping initialization on them. + type: boolean + InstanceGroupManagersResumeInstancesRequest: + id: InstanceGroupManagersResumeInstancesRequest + type: object + properties: + instances: + description: >- + The URLs of one or more instances to resume. This can be a full URL + or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + type: array + items: + type: string + InstanceGroupManagersStopInstancesRequest: + id: InstanceGroupManagersStopInstancesRequest + type: object + properties: + instances: + description: >- + The URLs of one or more instances to stop. This can be a full URL or + a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + type: array + items: + type: string + forceStop: + description: >- + If this flag is set to true, the Instance Group Manager will proceed + to stop the instances, skipping initialization on them. + type: boolean + InstanceGroupManagersStartInstancesRequest: + id: InstanceGroupManagersStartInstancesRequest + type: object + properties: + instances: + description: >- + The URLs of one or more instances to start. This can be a full URL + or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + type: array + items: + type: string + InstanceGroupManagersAbandonInstancesRequest: + id: InstanceGroupManagersAbandonInstancesRequest + type: object + 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]. + type: array + items: + type: string + InstanceGroupManagersRecreateInstancesRequest: + id: InstanceGroupManagersRecreateInstancesRequest + type: object + 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]. + type: array + items: + type: string + InstanceGroupManagersSetInstanceTemplateRequest: + id: InstanceGroupManagersSetInstanceTemplateRequest + type: object + 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 - id: + InstanceGroupManagersSetTargetPoolsRequest: + id: InstanceGroupManagersSetTargetPoolsRequest + type: object + properties: + targetPools: description: >- - [Output Only] Unique identifier for the resource; defined by the - server. + 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. + type: array + items: + type: string + 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. type: string - items: - description: A list of InstanceGroupManager resources. + format: byte + InstanceGroupManagersListManagedInstancesResponse: + id: InstanceGroupManagersListManagedInstancesResponse + type: object + properties: + managedInstances: + description: '[Output Only] The list of instances in the managed instance group.' type: array items: - $ref: '#/components/schemas/InstanceGroupManager' + $ref: '#/components/schemas/ManagedInstance' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -16233,314 +16211,523 @@ components: pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. type: string - selfLink: - description: '[Output Only] Server-defined URL for this resource.' + ManagedInstance: + id: ManagedInstance + description: A Managed Instance resource. + type: object + properties: + name: + description: >- + [Output Only] The name of the instance. The name always exists even + if the instance has not yet been created. type: string - warning: - description: '[Output Only] Informational warning message.' - type: object - properties: - code: - description: >- - [Output Only] A warning code, if applicable. For example, - Compute Engine returns NO_RESULTS_ON_PAGE if there are no - results in the response. - type: string - enumDescriptions: - - >- - Warning about failed cleanup of transient changes made by a - failed operation. - - A link to a deprecated resource was created. - - >- - When deploying and at least one of the resources has a type - marked as deprecated - - The user created a boot disk that is larger than image size. - - >- - When deploying and at least one of the resources has a type - marked as experimental - - Warning that is present in an external api call - - >- - Warning that value of a field has been overridden. Deprecated - unused field. - - >- - The operation involved use of an injected kernel, which is - deprecated. - - >- - A WEIGHTED_MAGLEV backend service is associated with a health - check that is not of type HTTP/HTTPS/HTTP2. - - >- - When deploying a deployment with a exceedingly large number of - resources - - >- - Resource can't be retrieved due to list overhead quota exceed - which captures the amount of resources filtered out by - user-defined list filter. - - A resource depends on a missing type - - >- - The route's nextHopIp address is not assigned to an instance - on the network. - - The route's next hop instance cannot ip forward. - - >- - The route's nextHopInstance URL refers to an instance that - does not have an ipv6 interface on the same network as the - route. - - >- - The route's nextHopInstance URL refers to an instance that - does not exist. - - >- - The route's nextHopInstance URL refers to an instance that is - not on the same network as the route. - - >- - The route's next hop instance does not have a status of - RUNNING. - - >- - Error which is not critical. We decided to continue the - process despite the mentioned error. - - No results are present on a particular list page. - - >- - Success is reported, but some results may be missing due to - errors - - >- - The user attempted to use a resource that requires a TOS they - have not accepted. - - Warning that a resource is in use. - - >- - One or more of the resources set to auto-delete could not be - deleted because they were in use. - - When a resource schema validation is ignored. - - >- - Instance template used in instance group manager is valid as - such, but its application does not make a lot of sense, - because it allows only single instance in instance group. - - When undeclared properties in the schema are present - - A given scope cannot be reached. - enumDeprecated: - - false - - false - - false - - false - - false - - false - - true - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - enum: - - CLEANUP_FAILED - - DEPRECATED_RESOURCE_USED - - DEPRECATED_TYPE_USED - - DISK_SIZE_LARGER_THAN_IMAGE_SIZE - - EXPERIMENTAL_TYPE_USED - - EXTERNAL_API_WARNING - - FIELD_VALUE_OVERRIDEN - - INJECTED_KERNELS_DEPRECATED - - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB - - LARGE_DEPLOYMENT_WARNING - - LIST_OVERHEAD_QUOTA_EXCEED - - MISSING_TYPE_DEPENDENCY - - NEXT_HOP_ADDRESS_NOT_ASSIGNED - - NEXT_HOP_CANNOT_IP_FORWARD - - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE - - NEXT_HOP_INSTANCE_NOT_FOUND - - NEXT_HOP_INSTANCE_NOT_ON_NETWORK - - NEXT_HOP_NOT_RUNNING - - NOT_CRITICAL_ERROR - - NO_RESULTS_ON_PAGE - - PARTIAL_SUCCESS - - REQUIRED_TOS_AGREEMENT - - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - - RESOURCE_NOT_DELETED - - SCHEMA_VALIDATION_IGNORED - - SINGLE_INSTANCE_PROPERTY_TEMPLATE - - UNDECLARED_PROPERTIES - - UNREACHABLE - message: - description: '[Output Only] A human-readable description of the warning code.' - type: string - data: - description: >- - [Output Only] Metadata about this warning in key: value format. - For example: "data": [ { "key": "scope", "value": - "zones/us-east1-d" } - type: array - items: - type: object - properties: - key: - description: >- - [Output Only] A key that provides more detail on the - warning being returned. For example, for warnings where - there are no results in a list request for a particular - zone, this key might be scope and the key value might be - the zone name. Other examples might be a key indicating a - deprecated resource and a suggested replacement, or a - warning about invalid network settings (for example, if an - instance attempts to perform IP forwarding but is not - enabled for IP forwarding). - type: string - value: - description: >- - [Output Only] A warning data value corresponding to the - key. - type: string - RegionInstanceGroupManagersDeleteInstancesRequest: - id: RegionInstanceGroupManagersDeleteInstancesRequest - type: object - properties: - instances: + instance: 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]. + [Output Only] The URL of the instance. The URL can exist even if the + instance has not yet been created. + type: string + id: + description: >- + [Output only] The unique identifier for this resource. This field is + empty when instance does not exist. + type: string + format: uint64 + instanceStatus: + description: >- + [Output Only] The status of the instance. This field is empty when + the instance does not exist. + type: string + enumDescriptions: + - >- + The instance is halted and we are performing tear down tasks like + network deprogramming, releasing quota, IP, tearing down disks + etc. + - Resources are being allocated for the instance. + - The instance is in repair. + - The instance is running. + - >- + All required resources have been allocated and the instance is + being started. + - The instance has stopped successfully. + - >- + The instance is currently stopping (either being deleted or + killed). + - The instance has suspended. + - The instance is suspending. + - >- + The instance has stopped (either by explicit action or underlying + failure). + enum: + - DEPROVISIONING + - PROVISIONING + - REPAIRING + - RUNNING + - STAGING + - STOPPED + - STOPPING + - SUSPENDED + - SUSPENDING + - TERMINATED + version: + description: '[Output Only] Intended version of this instance.' + $ref: '#/components/schemas/ManagedInstanceVersion' + preservedStateFromPolicy: + description: >- + [Output Only] Preserved state generated based on stateful policy for + this instance. + $ref: '#/components/schemas/PreservedState' + preservedStateFromConfig: + description: >- + [Output Only] Preserved state applied from per-instance config for + this instance. + $ref: '#/components/schemas/PreservedState' + 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. + type: string + enumDescriptions: + - >- + 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. + - >- + The managed instance group is creating this instance. If the group + fails to create this instance, it will try again until it is + successful. + - >- + 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. + - The managed instance group is permanently deleting this instance. + - >- + The managed instance group has not scheduled any actions for this + instance. + - The managed instance group is recreating this instance. + - >- + 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. + - The managed instance group is restarting this instance. + - The managed instance group is resuming this instance. + - The managed instance group is starting this instance. + - The managed instance group is stopping this instance. + - The managed instance group is suspending this instance. + - >- + The managed instance group is verifying this already created + instance. Verification happens every time the instance is + (re)created or restarted and consists of: 1. Waiting until health + check specified as part of this managed instance group's + autohealing policy reports HEALTHY. Note: Applies only if + autohealing policy has a health check specified 2. Waiting for + addition verification steps performed as post-instance creation + (subject to future extensions). + enum: + - ABANDONING + - CREATING + - CREATING_WITHOUT_RETRIES + - DELETING + - NONE + - RECREATING + - REFRESHING + - RESTARTING + - RESUMING + - STARTING + - STOPPING + - SUSPENDING + - VERIFYING + instanceHealth: + description: '[Output Only] Health state of the instance per health-check.' type: array items: - type: string - skipInstancesOnValidationError: + $ref: '#/components/schemas/ManagedInstanceInstanceHealth' + lastAttempt: 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 - RegionInstanceGroupManagersAbandonInstancesRequest: - id: RegionInstanceGroupManagersAbandonInstancesRequest + [Output Only] Information about the last attempt to create or delete + the instance. + $ref: '#/components/schemas/ManagedInstanceLastAttempt' + propertiesFromFlexibilityPolicy: + description: >- + [Output Only] Instance properties selected for this instance + resulting from InstanceFlexibilityPolicy. + $ref: '#/components/schemas/ManagedInstancePropertiesFromFlexibilityPolicy' + ManagedInstanceVersion: + id: ManagedInstanceVersion type: object properties: - instances: + name: + description: '[Output Only] Name of the version.' + type: string + instanceTemplate: 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]. - type: array - items: - type: string - RegionInstanceGroupManagersRecreateRequest: - id: RegionInstanceGroupManagersRecreateRequest + [Output Only] The intended template of the instance. This field is + empty when current_action is one of { DELETING, ABANDONING }. + type: string + PreservedState: + id: PreservedState + description: Preserved state for a given instance. type: object properties: - instances: + disks: 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]. - type: array - items: + Preserved disks defined for this instance. This map is keyed with + the device names of the disks. + type: object + additionalProperties: + $ref: '#/components/schemas/PreservedStatePreservedDisk' + metadata: + description: Preserved metadata defined for this instance. + type: object + additionalProperties: type: string - RegionInstanceGroupManagersSetTemplateRequest: - id: RegionInstanceGroupManagersSetTemplateRequest + internalIPs: + description: >- + Preserved internal IPs defined for this instance. This map is keyed + with the name of the network interface. + type: object + additionalProperties: + $ref: '#/components/schemas/PreservedStatePreservedNetworkIp' + externalIPs: + description: >- + Preserved external IPs defined for this instance. This map is keyed + with the name of the network interface. + type: object + additionalProperties: + $ref: '#/components/schemas/PreservedStatePreservedNetworkIp' + PreservedStatePreservedDisk: + id: PreservedStatePreservedDisk type: object properties: - instanceTemplate: + source: description: >- - URL of the InstanceTemplate resource from which all new instances - will be created. + The URL of the disk resource that is stateful and should be attached + to the VM instance. type: string - RegionInstanceGroupManagersSetTargetPoolsRequest: - id: RegionInstanceGroupManagersSetTargetPoolsRequest - type: object - properties: - targetPools: + mode: 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. - type: array - items: - type: string - fingerprint: + 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. + type: string + enumDescriptions: + - >- + Attaches this disk in read-only mode. Multiple VM instances can + use a disk in READ_ONLY mode at a time. + - >- + *[Default]* Attaches this disk in READ_WRITE mode. Only one VM + instance at a time can be attached to a disk in READ_WRITE mode. + enum: + - READ_ONLY + - READ_WRITE + autoDelete: 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. + 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. type: string - format: byte - RegionInstanceGroupManagersListInstancesResponse: - id: RegionInstanceGroupManagersListInstancesResponse + enumDescriptions: + - '' + - '' + enum: + - NEVER + - ON_PERMANENT_INSTANCE_DELETION + PreservedStatePreservedNetworkIp: + id: PreservedStatePreservedNetworkIp type: object properties: - managedInstances: - description: A list of managed instances. - type: array - items: - $ref: '#/components/schemas/ManagedInstance' - nextPageToken: + autoDelete: description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. + These stateful IPs will never be released during autohealing, update + or VM instance recreate operations. This flag is used to configure + if the IP reservation should be deleted after it is no longer used + by the group, e.g. when the given instance or the whole group is + deleted. type: string - RegionInstanceGroupManagersListErrorsResponse: - id: RegionInstanceGroupManagersListErrorsResponse + enumDescriptions: + - '' + - '' + enum: + - NEVER + - ON_PERMANENT_INSTANCE_DELETION + ipAddress: + description: Ip address representation + $ref: '#/components/schemas/PreservedStatePreservedNetworkIpIpAddress' + PreservedStatePreservedNetworkIpIpAddress: + id: PreservedStatePreservedNetworkIpIpAddress type: object properties: - items: - description: '[Output Only] The list of errors of the managed instance group.' - type: array - items: - $ref: '#/components/schemas/InstanceManagedByIgmError' - nextPageToken: + literal: description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. + An IPv4 internal network address to assign to the instance for this + network interface. type: string - RegionInstanceGroupManagersListInstanceConfigsResp: - id: RegionInstanceGroupManagersListInstanceConfigsResp + address: + description: The URL of the reservation for this IP address. + type: string + ManagedInstanceInstanceHealth: + id: ManagedInstanceInstanceHealth type: object properties: - items: - description: '[Output Only] The list of PerInstanceConfig.' - type: array - items: - $ref: '#/components/schemas/PerInstanceConfig' - nextPageToken: + healthCheck: description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. + [Output Only] The URL for the health check that verifies whether the + instance is healthy. type: string - warning: - description: '[Output Only] Informational warning message.' + detailedHealthState: + description: '[Output Only] The current detailed instance health state.' + type: string + enumDescriptions: + - >- + The instance is being drained. The existing connections to the + instance have time to complete, but the new ones are being + refused. + - >- + The instance is reachable i.e. a connection to the application + health checking endpoint can be established, and conforms to the + requirements defined by the health check. + - >- + The instance is unreachable i.e. a connection to the application + health checking endpoint cannot be established, or the server does + not respond within the specified timeout. + - >- + The instance is reachable, but does not conform to the + requirements defined by the health check. + - >- + The health checking system is aware of the instance but its health + is not known at the moment. + enum: + - DRAINING + - HEALTHY + - TIMEOUT + - UNHEALTHY + - UNKNOWN + ManagedInstanceLastAttempt: + id: ManagedInstanceLastAttempt + type: object + properties: + errors: + description: >- + [Output Only] Encountered errors during the last attempt to create + or delete the instance. type: object properties: - code: + errors: description: >- - [Output Only] A warning code, if applicable. For example, - Compute Engine returns NO_RESULTS_ON_PAGE if there are no - results in the response. - type: string - enumDescriptions: - - >- - Warning about failed cleanup of transient changes made by a - failed operation. - - A link to a deprecated resource was created. - - >- - When deploying and at least one of the resources has a type + [Output Only] The array of errors encountered while processing + this operation. + type: array + items: + type: object + 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 + errorDetails: + description: >- + [Output Only] An optional list of messages that contain + the error details. There is a set of defined message types + to use for providing details.The syntax depends on the + error code. For example, QuotaExceededInfo will have + details when the error code is QUOTA_EXCEEDED. + type: array + items: + type: object + properties: + errorInfo: + $ref: '#/components/schemas/ErrorInfo' + quotaInfo: + $ref: '#/components/schemas/QuotaExceededInfo' + help: + $ref: '#/components/schemas/Help' + localizedMessage: + $ref: '#/components/schemas/LocalizedMessage' + ManagedInstancePropertiesFromFlexibilityPolicy: + id: ManagedInstancePropertiesFromFlexibilityPolicy + type: object + properties: + machineType: + description: The machine type to be used for this instance. + type: string + InstanceGroupManagersListErrorsResponse: + id: InstanceGroupManagersListErrorsResponse + type: object + properties: + items: + description: '[Output Only] The list of errors of the managed instance group.' + type: array + items: + $ref: '#/components/schemas/InstanceManagedByIgmError' + nextPageToken: + description: >- + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. + type: string + InstanceManagedByIgmError: + id: InstanceManagedByIgmError + type: object + properties: + error: + description: '[Output Only] Contents of the error.' + $ref: '#/components/schemas/InstanceManagedByIgmErrorManagedInstanceError' + timestamp: + description: >- + [Output Only] The time that this error occurred. This value is in + RFC3339 text format. + type: string + instanceActionDetails: + 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. + $ref: '#/components/schemas/InstanceManagedByIgmErrorInstanceActionDetails' + InstanceManagedByIgmErrorManagedInstanceError: + id: InstanceManagedByIgmErrorManagedInstanceError + type: object + properties: + code: + description: '[Output Only] Error code.' + type: string + message: + description: '[Output Only] Error message.' + type: string + InstanceManagedByIgmErrorInstanceActionDetails: + id: InstanceManagedByIgmErrorInstanceActionDetails + type: object + properties: + action: + description: >- + [Output Only] Action that managed instance group was executing on + the instance when the error occurred. Possible values: + type: string + enumDescriptions: + - >- + 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. + - >- + The managed instance group is creating this instance. If the group + fails to create this instance, it will try again until it is + successful. + - >- + 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. + - The managed instance group is permanently deleting this instance. + - >- + The managed instance group has not scheduled any actions for this + instance. + - The managed instance group is recreating this instance. + - >- + 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. + - The managed instance group is restarting this instance. + - The managed instance group is resuming this instance. + - The managed instance group is starting this instance. + - The managed instance group is stopping this instance. + - The managed instance group is suspending this instance. + - >- + The managed instance group is verifying this already created + instance. Verification happens every time the instance is + (re)created or restarted and consists of: 1. Waiting until health + check specified as part of this managed instance group's + autohealing policy reports HEALTHY. Note: Applies only if + autohealing policy has a health check specified 2. Waiting for + addition verification steps performed as post-instance creation + (subject to future extensions). + enum: + - ABANDONING + - CREATING + - CREATING_WITHOUT_RETRIES + - DELETING + - NONE + - RECREATING + - REFRESHING + - RESTARTING + - RESUMING + - STARTING + - STOPPING + - SUSPENDING + - VERIFYING + 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: + 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. + $ref: '#/components/schemas/ManagedInstanceVersion' + InstanceGroupManagersListPerInstanceConfigsResp: + id: InstanceGroupManagersListPerInstanceConfigsResp + type: object + properties: + items: + description: '[Output Only] The list of PerInstanceConfig.' + type: array + items: + $ref: '#/components/schemas/PerInstanceConfig' + nextPageToken: + description: >- + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the 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.' + type: object + properties: + code: + description: >- + [Output Only] A warning code, if applicable. For example, + Compute Engine returns NO_RESULTS_ON_PAGE if there are no + results in the response. + type: string + enumDescriptions: + - >- + Warning about failed cleanup of transient changes made by a + failed operation. + - A link to a deprecated resource was created. + - >- + When deploying and at least one of the resources has a type marked as deprecated - The user created a boot disk that is larger than image size. - >- @@ -16588,6 +16775,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -16631,6 +16821,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -16653,6 +16844,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -16689,9 +16881,71 @@ components: [Output Only] A warning data value corresponding to the key. type: string - RegionInstanceGroupManagerUpdateInstanceConfigReq: - id: RegionInstanceGroupManagerUpdateInstanceConfigReq - description: RegionInstanceGroupManagers.updatePerInstanceConfigs + PerInstanceConfig: + id: PerInstanceConfig + type: object + properties: + name: + description: >- + The name of a per-instance configuration and its corresponding + instance. Serves as a merge key during UpdatePerInstanceConfigs + operations, that is, if a per-instance configuration 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 configuration for a VM instance that either doesn't + exist or is not part of the group will result in an error. + type: string + preservedState: + description: >- + The intended preserved state for the given instance. Does not + contain preserved state generated from a stateful policy. + $ref: '#/components/schemas/PreservedState' + status: + description: >- + The status of applying this per-instance configuration on the + corresponding managed instance. + type: string + enumDescriptions: + - >- + The per-instance configuration is being applied to the instance, + but is not yet effective, possibly waiting for the instance to, + for example, REFRESH. + - >- + The per-instance configuration deletion is being applied on the + instance, possibly waiting for the instance to, for example, + REFRESH. + - >- + The per-instance configuration is effective on the instance, + meaning that all disks, ips and metadata specified in this + configuration are attached or set on the instance. + - >- + *[Default]* The default status, when no per-instance configuration + exists. + - >- + The per-instance configuration is set on an instance but not been + applied yet. + - >- + The per-instance configuration has been deleted, but the deletion + is not yet applied. + enum: + - APPLYING + - DELETING + - EFFECTIVE + - NONE + - UNAPPLIED + - UNAPPLIED_DELETION + 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 configuration or the field needs to + be unset. + type: string + format: byte + InstanceGroupManagersUpdatePerInstanceConfigsReq: + id: InstanceGroupManagersUpdatePerInstanceConfigsReq + description: InstanceGroupManagers.updatePerInstanceConfigs type: object properties: perInstanceConfigs: @@ -16701,9 +16955,9 @@ components: type: array items: $ref: '#/components/schemas/PerInstanceConfig' - RegionInstanceGroupManagerPatchInstanceConfigReq: - id: RegionInstanceGroupManagerPatchInstanceConfigReq - description: RegionInstanceGroupManagers.patchPerInstanceConfigs + InstanceGroupManagersPatchPerInstanceConfigsReq: + id: InstanceGroupManagersPatchPerInstanceConfigsReq + description: InstanceGroupManagers.patchPerInstanceConfigs type: object properties: perInstanceConfigs: @@ -16713,9 +16967,9 @@ components: type: array items: $ref: '#/components/schemas/PerInstanceConfig' - RegionInstanceGroupManagerDeleteInstanceConfigReq: - id: RegionInstanceGroupManagerDeleteInstanceConfigReq - description: RegionInstanceGroupManagers.deletePerInstanceConfigs + InstanceGroupManagersDeletePerInstanceConfigsReq: + id: InstanceGroupManagersDeletePerInstanceConfigsReq + description: InstanceGroupManagers.deletePerInstanceConfigs type: object properties: names: @@ -16725,9 +16979,9 @@ components: type: array items: type: string - RegionInstanceGroupManagersApplyUpdatesRequest: - id: RegionInstanceGroupManagersApplyUpdatesRequest - description: RegionInstanceGroupManagers.applyUpdatesToInstances + InstanceGroupManagersApplyUpdatesRequest: + id: InstanceGroupManagersApplyUpdatesRequest + description: InstanceGroupManagers.applyUpdatesToInstances type: object properties: instances: @@ -16790,9 +17044,9 @@ components: “instances”. If the flag is set to true then the instances may not be specified in the request. type: boolean - RegionInstanceGroupManagersCreateInstancesRequest: - id: RegionInstanceGroupManagersCreateInstancesRequest - description: RegionInstanceGroupManagers.createInstances + InstanceGroupManagersCreateInstancesRequest: + id: InstanceGroupManagersCreateInstancesRequest + description: InstanceGroupManagers.createInstances type: object properties: instances: @@ -16800,16 +17054,217 @@ components: type: array items: $ref: '#/components/schemas/PerInstanceConfig' - AutoscalerList: - id: AutoscalerList - description: Contains a list of Autoscaler resources. + InstanceGroupManagerResizeRequest: + id: InstanceGroupManagerResizeRequest + description: >- + InstanceGroupManagerResizeRequest represents a request to create a + number of VMs: either immediately or by queuing the request for the + specified time. This resize request is nested under InstanceGroupManager + and the VMs created by this request are added to the owning + InstanceGroupManager. type: object properties: kind: description: >- - [Output Only] Type of resource. Always compute#autoscalerList for - lists of autoscalers. - default: compute#autoscalerList + [Output Only] The resource type, which is always + compute#instanceGroupManagerResizeRequest for resize requests. + default: compute#instanceGroupManagerResizeRequest + type: string + id: + description: >- + [Output Only] A unique identifier for this resource type. The server + generates this identifier. + type: string + format: uint64 + creationTimestamp: + description: >- + [Output Only] The creation timestamp for this resize request in + RFC3339 text format. + type: string + name: + description: >- + The name of this resize request. The name must be 1-63 characters + long, and comply with RFC1035. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + annotations: + required: + - compute.instanceGroupManagerResizeRequests.insert + type: string + description: + description: An optional description of this resource. + type: string + zone: + description: >- + [Output Only] The URL of a zone where the resize request is located. + Populated only for zonal resize requests. + type: string + resizeBy: + description: >- + The number of instances to be created by this resize request. The + group's target size will be increased by this number. This field + cannot be used together with 'instances'. + type: integer + format: int32 + requestedRunDuration: + description: >- + Requested run duration for instances that will be created by this + request. At the end of the run duration instance will be deleted. + $ref: '#/components/schemas/Duration' + state: + description: '[Output only] Current state of the request.' + type: string + enumDescriptions: + - >- + The request was created successfully and was accepted for + provisioning when the capacity becomes available. + - The request is cancelled. + - Resize request is being created and may still fail creation. + - >- + The request failed before or during provisioning. If the request + fails during provisioning, any VMs that were created during + provisioning are rolled back and removed from the MIG. + - Default value. This value should never be returned. + - The request succeeded. + enum: + - ACCEPTED + - CANCELLED + - CREATING + - FAILED + - STATE_UNSPECIFIED + - SUCCEEDED + status: + description: '[Output only] Status of the request.' + $ref: '#/components/schemas/InstanceGroupManagerResizeRequestStatus' + selfLink: + description: >- + [Output Only] The URL for this resize request. The server defines + this URL. + type: string + selfLinkWithId: + description: >- + [Output Only] Server-defined URL for this resource with the resource + id. + type: string + InstanceGroupManagerResizeRequestStatus: + id: InstanceGroupManagerResizeRequestStatus + type: object + properties: + error: + description: >- + [Output only] Fatal errors encountered during the queueing or + provisioning phases of the ResizeRequest that caused the transition + to the FAILED state. Contrary to the last_attempt errors, this field + is final and errors are never removed from here, as the + ResizeRequest is not going to retry. + type: object + properties: + errors: + description: >- + [Output Only] The array of errors encountered while processing + this operation. + type: array + items: + type: object + 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 + errorDetails: + description: >- + [Output Only] An optional list of messages that contain + the error details. There is a set of defined message types + to use for providing details.The syntax depends on the + error code. For example, QuotaExceededInfo will have + details when the error code is QUOTA_EXCEEDED. + type: array + items: + type: object + properties: + errorInfo: + $ref: '#/components/schemas/ErrorInfo' + quotaInfo: + $ref: '#/components/schemas/QuotaExceededInfo' + help: + $ref: '#/components/schemas/Help' + localizedMessage: + $ref: '#/components/schemas/LocalizedMessage' + lastAttempt: + description: >- + [Output only] Information about the last attempt to fulfill the + request. The value is temporary since the ResizeRequest can retry, + as long as it's still active and the last attempt value can either + be cleared or replaced with a different error. Since ResizeRequest + retries infrequently, the value may be stale and no longer show an + active problem. The value is cleared when ResizeRequest transitions + to the final state (becomes inactive). If the final state is FAILED + the error describing it will be storred in the "error" field only. + $ref: >- + #/components/schemas/InstanceGroupManagerResizeRequestStatusLastAttempt + InstanceGroupManagerResizeRequestStatusLastAttempt: + id: InstanceGroupManagerResizeRequestStatusLastAttempt + type: object + properties: + error: + description: Errors that prevented the ResizeRequest to be fulfilled. + type: object + properties: + errors: + description: >- + [Output Only] The array of errors encountered while processing + this operation. + type: array + items: + type: object + 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 + errorDetails: + description: >- + [Output Only] An optional list of messages that contain + the error details. There is a set of defined message types + to use for providing details.The syntax depends on the + error code. For example, QuotaExceededInfo will have + details when the error code is QUOTA_EXCEEDED. + type: array + items: + type: object + properties: + errorInfo: + $ref: '#/components/schemas/ErrorInfo' + quotaInfo: + $ref: '#/components/schemas/QuotaExceededInfo' + help: + $ref: '#/components/schemas/Help' + localizedMessage: + $ref: '#/components/schemas/LocalizedMessage' + InstanceGroupManagerResizeRequestsListResponse: + id: InstanceGroupManagerResizeRequestsListResponse + description: '[Output Only] A list of resize requests.' + type: object + properties: + kind: + description: >- + [Output Only] Type of the resource. Always + compute#instanceGroupManagerResizeRequestList for a list of resize + requests. + default: compute#instanceGroupManagerResizeRequestList type: string id: description: >- @@ -16817,10 +17272,10 @@ components: server. type: string items: - description: A list of Autoscaler resources. + description: A list of resize request resources. type: array items: - $ref: '#/components/schemas/Autoscaler' + $ref: '#/components/schemas/InstanceGroupManagerResizeRequest' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -16896,6 +17351,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -16939,6 +17397,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -16961,6 +17420,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -16997,605 +17457,378 @@ components: [Output Only] A warning data value corresponding to the key. type: string - Autoscaler: - id: 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. + RegionInstanceGroupManagerList: + id: RegionInstanceGroupManagerList + description: Contains a list of managed instance groups. type: object properties: kind: description: >- - [Output Only] Type of the resource. Always compute#autoscaler for - autoscalers. - default: compute#autoscaler + [Output Only] The resource type, which is always + compute#instanceGroupManagerList for a list of managed instance + groups that exist in th regional scope. + default: compute#regionInstanceGroupManagerList type: string id: description: >- - [Output Only] The unique identifier for the resource. This - identifier is defined by the server. - type: string - format: uint64 - creationTimestamp: - description: '[Output Only] Creation timestamp in RFC3339 text format.' - 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])?' - annotations: - required: - - compute.autoscalers.insert - type: string - description: - description: >- - An optional description of this resource. Provide this property when - you create the resource. - type: string - target: - description: >- - URL of the managed instance group that this autoscaler will scale. - This field is required when creating an autoscaler. - type: string - 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%. - $ref: '#/components/schemas/AutoscalingPolicy' - zone: - description: >- - [Output Only] URL of the zone where the instance group resides (for - autoscalers living in zonal scope). + [Output Only] Unique identifier for the resource; defined by the + server. type: string - region: + items: + description: A list of InstanceGroupManager resources. + type: array + items: + $ref: '#/components/schemas/InstanceGroupManager' + nextPageToken: description: >- - [Output Only] URL of the region where the instance group resides - (for autoscalers living in regional scope). + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. type: string 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. + description: '[Output Only] Server-defined URL for this resource.' type: string - enumDescriptions: - - Configuration is acknowledged to be effective - - Configuration is being deleted - - Configuration has errors. Actionable for users. - - Autoscaler backend hasn't read new/updated configuration - enum: - - ACTIVE - - DELETING - - ERROR - - PENDING - statusDetails: + warning: + description: '[Output Only] Informational warning message.' + type: object + properties: + code: + description: >- + [Output Only] A warning code, if applicable. For example, + Compute Engine returns NO_RESULTS_ON_PAGE if there are no + results in the response. + type: string + enumDescriptions: + - >- + Warning about failed cleanup of transient changes made by a + failed operation. + - A link to a deprecated resource was created. + - >- + When deploying and at least one of the resources has a type + marked as deprecated + - The user created a boot disk that is larger than image size. + - >- + When deploying and at least one of the resources has a type + marked as experimental + - Warning that is present in an external api call + - >- + Warning that value of a field has been overridden. Deprecated + unused field. + - >- + The operation involved use of an injected kernel, which is + deprecated. + - >- + A WEIGHTED_MAGLEV backend service is associated with a health + check that is not of type HTTP/HTTPS/HTTP2. + - >- + When deploying a deployment with a exceedingly large number of + resources + - >- + Resource can't be retrieved due to list overhead quota exceed + which captures the amount of resources filtered out by + user-defined list filter. + - A resource depends on a missing type + - >- + The route's nextHopIp address is not assigned to an instance + on the network. + - The route's next hop instance cannot ip forward. + - >- + The route's nextHopInstance URL refers to an instance that + does not have an ipv6 interface on the same network as the + route. + - >- + The route's nextHopInstance URL refers to an instance that + does not exist. + - >- + The route's nextHopInstance URL refers to an instance that is + not on the same network as the route. + - >- + The route's next hop instance does not have a status of + RUNNING. + - >- + Error which is not critical. We decided to continue the + process despite the mentioned error. + - No results are present on a particular list page. + - >- + Success is reported, but some results may be missing due to + errors + - >- + Quota information is not available to client requests (e.g: + regions.list). + - >- + The user attempted to use a resource that requires a TOS they + have not accepted. + - Warning that a resource is in use. + - >- + One or more of the resources set to auto-delete could not be + deleted because they were in use. + - When a resource schema validation is ignored. + - >- + Instance template used in instance group manager is valid as + such, but its application does not make a lot of sense, + because it allows only single instance in instance group. + - When undeclared properties in the schema are present + - A given scope cannot be reached. + enumDeprecated: + - false + - false + - false + - false + - false + - false + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + enum: + - CLEANUP_FAILED + - DEPRECATED_RESOURCE_USED + - DEPRECATED_TYPE_USED + - DISK_SIZE_LARGER_THAN_IMAGE_SIZE + - EXPERIMENTAL_TYPE_USED + - EXTERNAL_API_WARNING + - FIELD_VALUE_OVERRIDEN + - INJECTED_KERNELS_DEPRECATED + - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB + - LARGE_DEPLOYMENT_WARNING + - LIST_OVERHEAD_QUOTA_EXCEED + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE + - NEXT_HOP_INSTANCE_NOT_FOUND + - NEXT_HOP_INSTANCE_NOT_ON_NETWORK + - NEXT_HOP_NOT_RUNNING + - NOT_CRITICAL_ERROR + - NO_RESULTS_ON_PAGE + - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE + - REQUIRED_TOS_AGREEMENT + - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING + - RESOURCE_NOT_DELETED + - SCHEMA_VALIDATION_IGNORED + - SINGLE_INSTANCE_PROPERTY_TEMPLATE + - UNDECLARED_PROPERTIES + - UNREACHABLE + message: + description: '[Output Only] A human-readable description of the warning code.' + type: string + data: + description: >- + [Output Only] Metadata about this warning in key: value format. + For example: "data": [ { "key": "scope", "value": + "zones/us-east1-d" } + type: array + items: + type: object + properties: + key: + description: >- + [Output Only] A key that provides more detail on the + warning being returned. For example, for warnings where + there are no results in a list request for a particular + zone, this key might be scope and the key value might be + the zone name. Other examples might be a key indicating a + deprecated resource and a suggested replacement, or a + warning about invalid network settings (for example, if an + instance attempts to perform IP forwarding but is not + enabled for IP forwarding). + type: string + value: + description: >- + [Output Only] A warning data value corresponding to the + key. + type: string + RegionInstanceGroupManagersDeleteInstancesRequest: + id: RegionInstanceGroupManagersDeleteInstancesRequest + type: object + properties: + instances: 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. + 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]. type: array items: - $ref: '#/components/schemas/AutoscalerStatusDetails' - recommendedSize: + type: string + skipInstancesOnValidationError: 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. - type: integer - format: int32 - scalingScheduleStatus: - description: '[Output Only] Status information of existing scaling schedules.' - type: object - additionalProperties: - $ref: '#/components/schemas/ScalingScheduleStatus' - AutoscalingPolicy: - id: AutoscalingPolicy - description: Cloud Autoscaler policy. + 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 + RegionInstanceGroupManagersSuspendInstancesRequest: + id: RegionInstanceGroupManagersSuspendInstancesRequest type: object properties: - 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. - type: integer - format: int32 - maxNumReplicas: + instances: 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. - type: integer - format: int32 - scaleInControl: - $ref: '#/components/schemas/AutoscalingPolicyScaleInControl' - coolDownPeriodSec: + The URLs of one or more instances to suspend. This can be a full URL + or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + type: array + items: + type: string + forceSuspend: description: >- - The number of seconds that your application takes to initialize on a - VM instance. This is referred to as the [initialization - period](/compute/docs/autoscaler#cool_down_period). Specifying an - accurate initialization period improves autoscaler decisions. For - example, when scaling out, the autoscaler ignores data from VMs that - are still initializing because those VMs might not yet represent - normal usage of your application. The default initialization period - is 60 seconds. Initialization periods might vary because of numerous - factors. We recommend that you test how long your application takes - to initialize. To do this, create a VM and time your application's - startup process. - type: integer - format: int32 - cpuUtilization: + If this flag is set to true, the Instance Group Manager will proceed + to suspend the instances, skipping initialization on them. + type: boolean + RegionInstanceGroupManagersResumeInstancesRequest: + id: RegionInstanceGroupManagersResumeInstancesRequest + type: object + properties: + instances: description: >- - Defines the CPU utilization policy that allows the autoscaler to - scale based on the average CPU utilization of a managed instance - group. - $ref: '#/components/schemas/AutoscalingPolicyCpuUtilization' - customMetricUtilizations: - description: Configuration parameters of autoscaling based on a custom metric. + The URLs of one or more instances to resume. This can be a full URL + or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. type: array items: - $ref: '#/components/schemas/AutoscalingPolicyCustomMetricUtilization' - loadBalancingUtilization: - description: Configuration parameters of autoscaling based on load balancer. - $ref: '#/components/schemas/AutoscalingPolicyLoadBalancingUtilization' - mode: + type: string + RegionInstanceGroupManagersStopInstancesRequest: + id: RegionInstanceGroupManagersStopInstancesRequest + type: object + properties: + instances: description: >- - Defines the operating mode for this policy. The following modes are - available: - OFF: Disables the autoscaler but maintains its - configuration. - ONLY_SCALE_OUT: Restricts the autoscaler to add VM - instances only. - ON: Enables all autoscaler activities according to - its policy. For more information, see "Turning off or restricting an - autoscaler" - type: string - enumDescriptions: - - >- - Do not automatically scale the MIG in or out. The recommended_size - field contains the size of MIG that would be set if the actuation - mode was enabled. - - Automatically scale the MIG in and out according to the policy. - - >- - Automatically create VMs according to the policy, but do not scale - the MIG in. - - >- - Automatically create VMs according to the policy, but do not scale - the MIG in. - enum: - - 'OFF' - - 'ON' - - ONLY_SCALE_OUT - - ONLY_UP - scalingSchedules: + The URLs of one or more instances to stop. This can be a full URL or + a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + type: array + items: + type: string + forceStop: 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 - additionalProperties: - $ref: '#/components/schemas/AutoscalingPolicyScalingSchedule' - AutoscalingPolicyScaleInControl: - id: 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. + If this flag is set to true, the Instance Group Manager will proceed + to stop the instances, skipping initialization on them. + type: boolean + RegionInstanceGroupManagersStartInstancesRequest: + id: RegionInstanceGroupManagersStartInstancesRequest type: object properties: - maxScaledInReplicas: + instances: 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. - $ref: '#/components/schemas/FixedOrPercent' - timeWindowSec: + The URLs of one or more instances to start. This can be a full URL + or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + type: array + items: + type: string + RegionInstanceGroupManagersAbandonInstancesRequest: + id: RegionInstanceGroupManagersAbandonInstancesRequest + type: object + properties: + instances: description: >- - How far back autoscaling looks when computing recommendations to - include directives regarding slower scale in, as described above. - type: integer - format: int32 - AutoscalingPolicyCpuUtilization: - id: AutoscalingPolicyCpuUtilization - description: CPU utilization policy. + 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]. + type: array + items: + type: string + RegionInstanceGroupManagersRecreateRequest: + id: RegionInstanceGroupManagersRecreateRequest type: object properties: - utilizationTarget: + instances: 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. - type: number - format: double - predictiveMethod: + 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]. + type: array + items: + type: string + RegionInstanceGroupManagersSetTemplateRequest: + id: RegionInstanceGroupManagersSetTemplateRequest + type: object + properties: + instanceTemplate: 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. + URL of the InstanceTemplate resource from which all new instances + will be created. type: string - enumDescriptions: - - >- - No predictive method is used. The autoscaler scales the group to - meet current demand based on real-time metrics - - >- - Predictive autoscaling improves availability by monitoring daily - and weekly load patterns and scaling out ahead of anticipated - demand. - enum: - - NONE - - OPTIMIZE_AVAILABILITY - AutoscalingPolicyCustomMetricUtilization: - id: AutoscalingPolicyCustomMetricUtilization - description: Custom utilization metric policy. + RegionInstanceGroupManagersSetTargetPoolsRequest: + id: RegionInstanceGroupManagersSetTargetPoolsRequest type: object properties: - metric: + targetPools: 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. + 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. + type: array + items: + type: string + 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. type: string - filter: + format: byte + RegionInstanceGroupManagersListInstancesResponse: + id: RegionInstanceGroupManagersListInstancesResponse + type: object + properties: + managedInstances: + description: A list of managed instances. + type: array + items: + $ref: '#/components/schemas/ManagedInstance' + nextPageToken: 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 - 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. - type: number - format: double - 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. - type: number - format: double - utilizationTargetType: - description: >- - Defines how target utilization value is expressed for a Stackdriver - Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or - DELTA_PER_MINUTE. - type: string - enumDescriptions: - - >- - Sets the utilization target value for a cumulative or delta - metric, expressed as the rate of growth per minute. - - >- - Sets the utilization target value for a cumulative or delta - metric, expressed as the rate of growth per second. - - >- - Sets the utilization target value for a gauge metric. The - autoscaler will collect the average utilization of the virtual - machines from the last couple of minutes, and compare the value to - the utilization target value to perform autoscaling. - enum: - - DELTA_PER_MINUTE - - DELTA_PER_SECOND - - GAUGE - AutoscalingPolicyLoadBalancingUtilization: - id: AutoscalingPolicyLoadBalancingUtilization - description: Configuration parameters of autoscaling based on load balancing. - type: object - 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. - type: number - format: double - AutoscalingPolicyScalingSchedule: - id: 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. - type: object - properties: - minRequiredReplicas: - description: >- - The minimum number of VM instances that the autoscaler will - recommend in time intervals starting according to schedule. This - field is required. - type: integer - format: int32 - 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: - https://en.wikipedia.org/wiki/Tz_database. This field is assigned a - default value of "UTC" if left empty. - type: string - 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. - type: integer - format: int32 - 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 - description: - description: A description of a scaling schedule. - type: string - AutoscalerStatusDetails: - id: AutoscalerStatusDetails - type: object - 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. + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. type: string - enumDescriptions: - - >- - All instances in the instance group are unhealthy (not in RUNNING - state). - - There is no backend service attached to the instance group. - - Autoscaler recommends a size greater than maxNumReplicas. - - >- - The custom metric samples are not exported often enough to be a - credible base for autoscaling. - - >- - The custom metric that was specified does not exist or does not - have the necessary labels. - - >- - The minNumReplicas is equal to maxNumReplicas. This means the - autoscaler cannot add or remove instances from the instance group. - - >- - The autoscaler did not receive any data from the custom metric - configured for autoscaling. - - >- - 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. - - >- - Autoscaling is turned off. The number of instances in the group - won't change automatically. The autoscaling configuration is - preserved. - - >- - Autoscaling is in the "Autoscale only scale out" mode. Instances - in the group will be only added. - - >- - Autoscaling is in the "Autoscale only out" mode. Instances in the - group will be only added. - - >- - The instance group cannot be autoscaled because it has more than - one backend service attached to it. - - >- - There is insufficient quota for the necessary resources, such as - CPU or number of instances. - - >- - Showed only for regional autoscalers: there is a resource stockout - in the chosen region. - - The target to be scaled does not exist. - - >- - For some scaling schedules minRequiredReplicas is greater than - maxNumReplicas. Autoscaler always recommends at most - maxNumReplicas instances. - - >- - For some scaling schedules minRequiredReplicas is less than - minNumReplicas. Autoscaler always recommends at least - minNumReplicas instances. - - '' - - >- - Autoscaling does not work with an HTTP/S load balancer that has - been configured for maxRate. - - >- - 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. - 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 - ScalingScheduleStatus: - id: ScalingScheduleStatus + RegionInstanceGroupManagersListErrorsResponse: + id: RegionInstanceGroupManagersListErrorsResponse type: object properties: - 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 - lastStartTime: + items: + description: '[Output Only] The list of errors of the managed instance group.' + type: array + items: + $ref: '#/components/schemas/InstanceManagedByIgmError' + nextPageToken: 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 - state: - description: '[Output Only] The current state of a scaling schedule.' + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. type: string - enumDescriptions: - - >- - The current autoscaling recommendation is influenced by this - scaling schedule. - - This scaling schedule has been disabled by the user. - - This scaling schedule will never become active again. - - >- - The current autoscaling recommendation is not influenced by this - scaling schedule. - enum: - - ACTIVE - - DISABLED - - OBSOLETE - - READY - AutoscalerAggregatedList: - id: AutoscalerAggregatedList + RegionInstanceGroupManagersListInstanceConfigsResp: + id: RegionInstanceGroupManagersListInstanceConfigsResp type: object properties: - kind: - description: >- - [Output Only] Type of resource. Always - compute#autoscalerAggregatedList for aggregated lists of - autoscalers. - default: compute#autoscalerAggregatedList - type: string - id: - description: >- - [Output Only] Unique identifier for the resource; defined by the - server. - type: string items: - description: A list of AutoscalersScopedList resources. - type: object - additionalProperties: - description: >- - [Output Only] Name of the scope containing this set of - autoscalers. - $ref: '#/components/schemas/AutoscalersScopedList' + description: '[Output Only] The list of PerInstanceConfig.' + type: array + items: + $ref: '#/components/schemas/PerInstanceConfig' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -17604,9 +17837,6 @@ components: pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. type: string - selfLink: - description: '[Output Only] Server-defined URL for this resource.' - type: string warning: description: '[Output Only] Informational warning message.' type: object @@ -17671,6 +17901,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -17714,6 +17947,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -17736,6 +17970,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -17772,26 +18007,151 @@ components: [Output Only] A warning data value corresponding to the key. type: string - unreachables: + RegionInstanceGroupManagerUpdateInstanceConfigReq: + id: RegionInstanceGroupManagerUpdateInstanceConfigReq + description: RegionInstanceGroupManagers.updatePerInstanceConfigs + type: object + properties: + perInstanceConfigs: description: >- - [Output Only] Unreachable resources. end_interface: - MixerListResponseWithEtagBuilder + The list of per-instance configurations to insert or patch on this + managed instance group. + type: array + items: + $ref: '#/components/schemas/PerInstanceConfig' + RegionInstanceGroupManagerPatchInstanceConfigReq: + id: RegionInstanceGroupManagerPatchInstanceConfigReq + description: RegionInstanceGroupManagers.patchPerInstanceConfigs + type: object + properties: + perInstanceConfigs: + description: >- + The list of per-instance configurations to insert or patch on this + managed instance group. + type: array + items: + $ref: '#/components/schemas/PerInstanceConfig' + RegionInstanceGroupManagerDeleteInstanceConfigReq: + id: RegionInstanceGroupManagerDeleteInstanceConfigReq + description: RegionInstanceGroupManagers.deletePerInstanceConfigs + type: object + properties: + names: + description: >- + The list of instance names for which we want to delete per-instance + configs on this managed instance group. type: array items: type: string - AutoscalersScopedList: - id: AutoscalersScopedList + RegionInstanceGroupManagersApplyUpdatesRequest: + id: RegionInstanceGroupManagersApplyUpdatesRequest + description: RegionInstanceGroupManagers.applyUpdatesToInstances type: object properties: - autoscalers: - description: '[Output Only] A list of autoscalers contained in this scope.' + 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]. + type: array + items: + type: string + 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 and limit disruption as much as possible. - + 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. + type: string + enumDescriptions: + - Do not perform any action. + - Do not stop the instance. + - >- + (Default.) Replace the instance according to the replacement + method option. + - Stop the instance and start it again. + enum: + - NONE + - REFRESH + - REPLACE + - RESTART + 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 and limit disruption as much as possible. - + 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. + type: string + enumDescriptions: + - Do not perform any action. + - Do not stop the instance. + - >- + (Default.) Replace the instance according to the replacement + method option. + - Stop the instance and start it again. + enum: + - NONE + - REFRESH + - REPLACE + - RESTART + allInstances: + description: >- + Flag to update all instances instead of specified list of + “instances”. If the flag is set to true then the instances may not + be specified in the request. + type: boolean + RegionInstanceGroupManagersCreateInstancesRequest: + id: RegionInstanceGroupManagersCreateInstancesRequest + description: RegionInstanceGroupManagers.createInstances + type: object + properties: + instances: + description: '[Required] List of specifications of per-instance configs.' + type: array + items: + $ref: '#/components/schemas/PerInstanceConfig' + AutoscalerList: + id: AutoscalerList + description: Contains a list of Autoscaler resources. + type: object + properties: + kind: + description: >- + [Output Only] Type of resource. Always compute#autoscalerList for + lists of autoscalers. + default: compute#autoscalerList + type: string + id: + description: >- + [Output Only] Unique identifier for the resource; defined by the + server. + type: string + items: + description: A list of Autoscaler resources. type: array items: $ref: '#/components/schemas/Autoscaler' - warning: + nextPageToken: description: >- - [Output Only] Informational warning which replaces the list of - autoscalers when the list is empty. + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. + type: string + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string + warning: + description: '[Output Only] Informational warning message.' type: object properties: code: @@ -17854,6 +18214,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -17897,6 +18260,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -17919,6 +18283,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -17955,412 +18320,30 @@ components: [Output Only] A warning data value corresponding to the key. type: string - RegionAutoscalerList: - id: RegionAutoscalerList - description: Contains a list of autoscalers. + Autoscaler: + id: 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. type: object properties: kind: - description: Type of resource. - default: compute#regionAutoscalerList + description: >- + [Output Only] Type of the resource. Always compute#autoscaler for + autoscalers. + default: compute#autoscaler type: string id: description: >- - [Output Only] Unique identifier for the resource; defined by the - server. - type: string - items: - description: A list of Autoscaler resources. - type: array - items: - $ref: '#/components/schemas/Autoscaler' - nextPageToken: - description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. - type: string - selfLink: - description: '[Output Only] Server-defined URL for this resource.' - type: string - warning: - description: '[Output Only] Informational warning message.' - type: object - properties: - code: - description: >- - [Output Only] A warning code, if applicable. For example, - Compute Engine returns NO_RESULTS_ON_PAGE if there are no - results in the response. - type: string - enumDescriptions: - - >- - Warning about failed cleanup of transient changes made by a - failed operation. - - A link to a deprecated resource was created. - - >- - When deploying and at least one of the resources has a type - marked as deprecated - - The user created a boot disk that is larger than image size. - - >- - When deploying and at least one of the resources has a type - marked as experimental - - Warning that is present in an external api call - - >- - Warning that value of a field has been overridden. Deprecated - unused field. - - >- - The operation involved use of an injected kernel, which is - deprecated. - - >- - A WEIGHTED_MAGLEV backend service is associated with a health - check that is not of type HTTP/HTTPS/HTTP2. - - >- - When deploying a deployment with a exceedingly large number of - resources - - >- - Resource can't be retrieved due to list overhead quota exceed - which captures the amount of resources filtered out by - user-defined list filter. - - A resource depends on a missing type - - >- - The route's nextHopIp address is not assigned to an instance - on the network. - - The route's next hop instance cannot ip forward. - - >- - The route's nextHopInstance URL refers to an instance that - does not have an ipv6 interface on the same network as the - route. - - >- - The route's nextHopInstance URL refers to an instance that - does not exist. - - >- - The route's nextHopInstance URL refers to an instance that is - not on the same network as the route. - - >- - The route's next hop instance does not have a status of - RUNNING. - - >- - Error which is not critical. We decided to continue the - process despite the mentioned error. - - No results are present on a particular list page. - - >- - Success is reported, but some results may be missing due to - errors - - >- - The user attempted to use a resource that requires a TOS they - have not accepted. - - Warning that a resource is in use. - - >- - One or more of the resources set to auto-delete could not be - deleted because they were in use. - - When a resource schema validation is ignored. - - >- - Instance template used in instance group manager is valid as - such, but its application does not make a lot of sense, - because it allows only single instance in instance group. - - When undeclared properties in the schema are present - - A given scope cannot be reached. - enumDeprecated: - - false - - false - - false - - false - - false - - false - - true - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - enum: - - CLEANUP_FAILED - - DEPRECATED_RESOURCE_USED - - DEPRECATED_TYPE_USED - - DISK_SIZE_LARGER_THAN_IMAGE_SIZE - - EXPERIMENTAL_TYPE_USED - - EXTERNAL_API_WARNING - - FIELD_VALUE_OVERRIDEN - - INJECTED_KERNELS_DEPRECATED - - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB - - LARGE_DEPLOYMENT_WARNING - - LIST_OVERHEAD_QUOTA_EXCEED - - MISSING_TYPE_DEPENDENCY - - NEXT_HOP_ADDRESS_NOT_ASSIGNED - - NEXT_HOP_CANNOT_IP_FORWARD - - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE - - NEXT_HOP_INSTANCE_NOT_FOUND - - NEXT_HOP_INSTANCE_NOT_ON_NETWORK - - NEXT_HOP_NOT_RUNNING - - NOT_CRITICAL_ERROR - - NO_RESULTS_ON_PAGE - - PARTIAL_SUCCESS - - REQUIRED_TOS_AGREEMENT - - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - - RESOURCE_NOT_DELETED - - SCHEMA_VALIDATION_IGNORED - - SINGLE_INSTANCE_PROPERTY_TEMPLATE - - UNDECLARED_PROPERTIES - - UNREACHABLE - message: - description: '[Output Only] A human-readable description of the warning code.' - type: string - data: - description: >- - [Output Only] Metadata about this warning in key: value format. - For example: "data": [ { "key": "scope", "value": - "zones/us-east1-d" } - type: array - items: - type: object - properties: - key: - description: >- - [Output Only] A key that provides more detail on the - warning being returned. For example, for warnings where - there are no results in a list request for a particular - zone, this key might be scope and the key value might be - the zone name. Other examples might be a key indicating a - deprecated resource and a suggested replacement, or a - warning about invalid network settings (for example, if an - instance attempts to perform IP forwarding but is not - enabled for IP forwarding). - type: string - value: - description: >- - [Output Only] A warning data value corresponding to the - key. - type: string - BackendBucketList: - id: BackendBucketList - description: Contains a list of BackendBucket resources. - type: object - properties: - kind: - description: Type of resource. - default: compute#backendBucketList - type: string - id: - description: >- - [Output Only] Unique identifier for the resource; defined by the - server. - type: string - items: - description: A list of BackendBucket resources. - type: array - items: - $ref: '#/components/schemas/BackendBucket' - nextPageToken: - description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. - type: string - selfLink: - description: '[Output Only] Server-defined URL for this resource.' - type: string - warning: - description: '[Output Only] Informational warning message.' - type: object - properties: - code: - description: >- - [Output Only] A warning code, if applicable. For example, - Compute Engine returns NO_RESULTS_ON_PAGE if there are no - results in the response. - type: string - enumDescriptions: - - >- - Warning about failed cleanup of transient changes made by a - failed operation. - - A link to a deprecated resource was created. - - >- - When deploying and at least one of the resources has a type - marked as deprecated - - The user created a boot disk that is larger than image size. - - >- - When deploying and at least one of the resources has a type - marked as experimental - - Warning that is present in an external api call - - >- - Warning that value of a field has been overridden. Deprecated - unused field. - - >- - The operation involved use of an injected kernel, which is - deprecated. - - >- - A WEIGHTED_MAGLEV backend service is associated with a health - check that is not of type HTTP/HTTPS/HTTP2. - - >- - When deploying a deployment with a exceedingly large number of - resources - - >- - Resource can't be retrieved due to list overhead quota exceed - which captures the amount of resources filtered out by - user-defined list filter. - - A resource depends on a missing type - - >- - The route's nextHopIp address is not assigned to an instance - on the network. - - The route's next hop instance cannot ip forward. - - >- - The route's nextHopInstance URL refers to an instance that - does not have an ipv6 interface on the same network as the - route. - - >- - The route's nextHopInstance URL refers to an instance that - does not exist. - - >- - The route's nextHopInstance URL refers to an instance that is - not on the same network as the route. - - >- - The route's next hop instance does not have a status of - RUNNING. - - >- - Error which is not critical. We decided to continue the - process despite the mentioned error. - - No results are present on a particular list page. - - >- - Success is reported, but some results may be missing due to - errors - - >- - The user attempted to use a resource that requires a TOS they - have not accepted. - - Warning that a resource is in use. - - >- - One or more of the resources set to auto-delete could not be - deleted because they were in use. - - When a resource schema validation is ignored. - - >- - Instance template used in instance group manager is valid as - such, but its application does not make a lot of sense, - because it allows only single instance in instance group. - - When undeclared properties in the schema are present - - A given scope cannot be reached. - enumDeprecated: - - false - - false - - false - - false - - false - - false - - true - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - enum: - - CLEANUP_FAILED - - DEPRECATED_RESOURCE_USED - - DEPRECATED_TYPE_USED - - DISK_SIZE_LARGER_THAN_IMAGE_SIZE - - EXPERIMENTAL_TYPE_USED - - EXTERNAL_API_WARNING - - FIELD_VALUE_OVERRIDEN - - INJECTED_KERNELS_DEPRECATED - - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB - - LARGE_DEPLOYMENT_WARNING - - LIST_OVERHEAD_QUOTA_EXCEED - - MISSING_TYPE_DEPENDENCY - - NEXT_HOP_ADDRESS_NOT_ASSIGNED - - NEXT_HOP_CANNOT_IP_FORWARD - - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE - - NEXT_HOP_INSTANCE_NOT_FOUND - - NEXT_HOP_INSTANCE_NOT_ON_NETWORK - - NEXT_HOP_NOT_RUNNING - - NOT_CRITICAL_ERROR - - NO_RESULTS_ON_PAGE - - PARTIAL_SUCCESS - - REQUIRED_TOS_AGREEMENT - - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - - RESOURCE_NOT_DELETED - - SCHEMA_VALIDATION_IGNORED - - SINGLE_INSTANCE_PROPERTY_TEMPLATE - - UNDECLARED_PROPERTIES - - UNREACHABLE - message: - description: '[Output Only] A human-readable description of the warning code.' - type: string - data: - description: >- - [Output Only] Metadata about this warning in key: value format. - For example: "data": [ { "key": "scope", "value": - "zones/us-east1-d" } - type: array - items: - type: object - properties: - key: - description: >- - [Output Only] A key that provides more detail on the - warning being returned. For example, for warnings where - there are no results in a list request for a particular - zone, this key might be scope and the key value might be - the zone name. Other examples might be a key indicating a - deprecated resource and a suggested replacement, or a - warning about invalid network settings (for example, if an - instance attempts to perform IP forwarding but is not - enabled for IP forwarding). - type: string - value: - description: >- - [Output Only] A warning data value corresponding to the - key. - type: string - BackendBucket: - id: 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. - type: object - properties: - kind: - description: Type of the resource. - default: compute#backendBucket - type: string - id: - description: >- - [Output Only] Unique identifier for the resource; defined by the - server. + [Output Only] The unique identifier for the resource. This + identifier is defined by the server. type: string format: uint64 creationTimestamp: @@ -18376,384 +18359,618 @@ components: 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])?' + annotations: + required: + - compute.autoscalers.insert type: string description: description: >- - An optional textual description of the resource; provided by the - client when the resource is created. - type: string - selfLink: - description: '[Output Only] Server-defined URL for the resource.' + An optional description of this resource. Provide this property when + you create the resource. type: string - bucketName: - description: Cloud Storage bucket name. + target: + description: >- + URL of the managed instance group that this autoscaler will scale. + This field is required when creating an autoscaler. type: string - enableCdn: - description: If true, enable Cloud CDN for this BackendBucket. - type: boolean - cdnPolicy: - description: Cloud CDN configuration for this BackendBucket. - $ref: '#/components/schemas/BackendBucketCdnPolicy' - customResponseHeaders: + autoscalingPolicy: description: >- - Headers that the Application Load Balancer should add to proxied - responses. - type: array - items: - type: string - edgeSecurityPolicy: + 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%. + $ref: '#/components/schemas/AutoscalingPolicy' + zone: description: >- - [Output Only] The resource URL for the edge security policy - associated with this backend bucket. + [Output Only] URL of the zone where the instance group resides (for + autoscalers living in zonal scope). type: string - compressionMode: + region: description: >- - Compress text responses using Brotli or gzip compression, based on - the client's Accept-Encoding header. + [Output Only] URL of the region where the instance group resides + (for autoscalers living in regional scope). + type: string + 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. type: string enumDescriptions: - - >- - Automatically uses the best compression based on the - Accept-Encoding header sent by the client. - - >- - Disables compression. Existing compressed responses cached by - Cloud CDN will not be served to clients. + - Configuration is acknowledged to be effective + - Configuration is being deleted + - Configuration has errors. Actionable for users. + - Autoscaler backend hasn't read new/updated configuration enum: - - AUTOMATIC - - DISABLED - usedBy: - description: '[Output Only] List of resources referencing that backend bucket.' + - ACTIVE + - DELETING + - ERROR + - PENDING + 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. type: array items: - $ref: '#/components/schemas/BackendBucketUsedBy' - BackendBucketCdnPolicy: - id: BackendBucketCdnPolicy - description: Message containing Cloud CDN configuration for a backend bucket. + $ref: '#/components/schemas/AutoscalerStatusDetails' + 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. + type: integer + format: int32 + scalingScheduleStatus: + description: '[Output Only] Status information of existing scaling schedules.' + type: object + additionalProperties: + $ref: '#/components/schemas/ScalingScheduleStatus' + AutoscalingPolicy: + id: AutoscalingPolicy + description: Cloud Autoscaler policy. type: object properties: - signedUrlKeyNames: - description: '[Output Only] Names of the keys for signing request URLs.' - type: array - items: - type: string - signedUrlCacheMaxAgeSec: + minNumReplicas: 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. - type: string - format: int64 - 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 - 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. - type: string - enumDescriptions: - - >- - 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. - - >- - 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. - - '' - - >- - 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. - enum: - - CACHE_ALL_STATIC - - FORCE_CACHE_ALL - - INVALID_CACHE_MODE - - USE_ORIGIN_HEADERS - 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. + 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. type: integer format: int32 - maxTtl: + maxNumReplicas: 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. + 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. type: integer format: int32 - clientTtl: + scaleInControl: + $ref: '#/components/schemas/AutoscalingPolicyScaleInControl' + coolDownPeriodSec: 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). + The number of seconds that your application takes to initialize on a + VM instance. This is referred to as the [initialization + period](/compute/docs/autoscaler#cool_down_period). Specifying an + accurate initialization period improves autoscaler decisions. For + example, when scaling out, the autoscaler ignores data from VMs that + are still initializing because those VMs might not yet represent + normal usage of your application. The default initialization period + is 60 seconds. Initialization periods might vary because of numerous + factors. We recommend that you test how long your application takes + to initialize. To do this, create a VM and time your application's + startup process. type: integer format: int32 - 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: + cpuUtilization: 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. + Defines the CPU utilization policy that allows the autoscaler to + scale based on the average CPU utilization of a managed instance + group. + $ref: '#/components/schemas/AutoscalingPolicyCpuUtilization' + customMetricUtilizations: + description: Configuration parameters of autoscaling based on a custom metric. type: array items: - $ref: '#/components/schemas/BackendBucketCdnPolicyNegativeCachingPolicy' - bypassCacheOnRequestHeaders: + $ref: '#/components/schemas/AutoscalingPolicyCustomMetricUtilization' + loadBalancingUtilization: + description: Configuration parameters of autoscaling based on load balancer. + $ref: '#/components/schemas/AutoscalingPolicyLoadBalancingUtilization' + mode: 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. - type: array - items: - $ref: >- - #/components/schemas/BackendBucketCdnPolicyBypassCacheOnRequestHeader - serveWhileStale: + Defines the operating mode for this policy. The following modes are + available: - OFF: Disables the autoscaler but maintains its + configuration. - ONLY_SCALE_OUT: Restricts the autoscaler to add VM + instances only. - ON: Enables all autoscaler activities according to + its policy. For more information, see "Turning off or restricting an + autoscaler" + type: string + enumDescriptions: + - >- + Do not automatically scale the MIG in or out. The recommended_size + field contains the size of MIG that would be set if the actuation + mode was enabled. + - Automatically scale the MIG in and out according to the policy. + - >- + Automatically create VMs according to the policy, but do not scale + the MIG in. + - >- + Automatically create VMs according to the policy, but do not scale + the MIG in. + enum: + - 'OFF' + - 'ON' + - ONLY_SCALE_OUT + - ONLY_UP + scalingSchedules: 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. - type: integer - format: int32 - cacheKeyPolicy: - description: The CacheKeyPolicy for this CdnPolicy. - $ref: '#/components/schemas/BackendBucketCdnPolicyCacheKeyPolicy' - BackendBucketCdnPolicyNegativeCachingPolicy: - id: BackendBucketCdnPolicyNegativeCachingPolicy - description: Specify CDN TTLs for response error codes. + 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 + additionalProperties: + $ref: '#/components/schemas/AutoscalingPolicyScalingSchedule' + AutoscalingPolicyScaleInControl: + id: 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. type: object properties: - code: + maxScaledInReplicas: 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. - type: integer - format: int32 - ttl: + 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. + $ref: '#/components/schemas/FixedOrPercent' + timeWindowSec: 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. + How far back autoscaling looks when computing recommendations to + include directives regarding slower scale in, as described above. type: integer format: int32 - BackendBucketCdnPolicyBypassCacheOnRequestHeader: - id: 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. + AutoscalingPolicyCpuUtilization: + id: AutoscalingPolicyCpuUtilization + description: CPU utilization policy. type: object properties: - headerName: + utilizationTarget: description: >- - The header field name to match on when bypassing cache. Values are - case-insensitive. + 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. + type: number + format: double + 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. type: string - BackendBucketCdnPolicyCacheKeyPolicy: - id: BackendBucketCdnPolicyCacheKeyPolicy - description: >- - Message containing what to include in the cache key for a request for - Cloud CDN. + enumDescriptions: + - >- + No predictive method is used. The autoscaler scales the group to + meet current demand based on real-time metrics + - >- + Predictive autoscaling improves availability by monitoring daily + and weekly load patterns and scaling out ahead of anticipated + demand. + enum: + - NONE + - OPTIMIZE_AVAILABILITY + AutoscalingPolicyCustomMetricUtilization: + id: AutoscalingPolicyCustomMetricUtilization + description: Custom utilization metric policy. type: object properties: - queryStringWhitelist: + utilizationTarget: description: >- - Names of query string parameters to include in cache keys. Default - parameters are always included. '&' and '=' will be percent encoded - and not treated as delimiters. - type: array - items: - type: string - includeHttpHeaders: - description: Allows HTTP request headers (by name) to be used in the cache key. - type: array - items: - type: string - BackendBucketUsedBy: - id: BackendBucketUsedBy - type: object - properties: - reference: + 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. + type: number + format: double + singleInstanceAssignment: description: >- - [Output Only] Server-defined URL for UrlMaps referencing that - BackendBucket. + 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. + type: number + format: double + 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 - SignedUrlKey: - id: SignedUrlKey - description: Represents a customer-supplied Signing Key used by Cloud CDN Signed URLs - type: object - properties: - keyName: + filter: 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])?' + 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 - keyValue: + utilizationTargetType: description: >- - 128-bit key value used for signing the URL. The key value must be a - valid RFC 4648 Section 5 base64url encoded string. + Defines how target utilization value is expressed for a Stackdriver + Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or + DELTA_PER_MINUTE. type: string - SecurityPolicyReference: - id: SecurityPolicyReference + enumDescriptions: + - >- + Sets the utilization target value for a cumulative or delta + metric, expressed as the rate of growth per minute. + - >- + Sets the utilization target value for a cumulative or delta + metric, expressed as the rate of growth per second. + - >- + Sets the utilization target value for a gauge metric. The + autoscaler will collect the average utilization of the virtual + machines from the last couple of minutes, and compare the value to + the utilization target value to perform autoscaling. + enum: + - DELTA_PER_MINUTE + - DELTA_PER_SECOND + - GAUGE + AutoscalingPolicyLoadBalancingUtilization: + id: AutoscalingPolicyLoadBalancingUtilization + description: Configuration parameters of autoscaling based on load balancing. type: object properties: - securityPolicy: - type: string - BackendServiceList: - id: BackendServiceList - description: Contains a list of BackendService resources. + 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. + type: number + format: double + AutoscalingPolicyScalingSchedule: + id: 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. type: object properties: - kind: + minRequiredReplicas: description: >- - [Output Only] Type of resource. Always compute#backendServiceList - for lists of backend services. - default: compute#backendServiceList + The minimum number of VM instances that the autoscaler will + recommend in time intervals starting according to schedule. This + field is required. + type: integer + format: int32 + 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 - id: + timeZone: description: >- - [Output Only] Unique identifier for the resource; defined by the - server. + The time zone to use when interpreting the schedule. The value of + this field must be a time zone name from the tz database: + https://en.wikipedia.org/wiki/Tz_database. This field is assigned a + default value of "UTC" if left empty. type: string - items: - description: A list of BackendService resources. - type: array - items: - $ref: '#/components/schemas/BackendService' - nextPageToken: + durationSec: description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. + 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. + type: integer + format: int32 + 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 + description: + description: A description of a scaling schedule. type: string - selfLink: - description: '[Output Only] Server-defined URL for this resource.' + AutoscalerStatusDetails: + id: AutoscalerStatusDetails + type: object + properties: + message: + description: The status message. type: string - warning: - description: '[Output Only] Informational warning message.' - type: object - properties: - code: - description: >- - [Output Only] A warning code, if applicable. For example, - Compute Engine returns NO_RESULTS_ON_PAGE if there are no - results in the response. - type: string - enumDescriptions: - - >- - Warning about failed cleanup of transient changes made by a - failed operation. - - A link to a deprecated resource was created. - - >- - When deploying and at least one of the resources has a type - marked as deprecated - - The user created a boot disk that is larger than image size. - - >- - When deploying and at least one of the resources has a type - marked as experimental - - Warning that is present in an external api call - - >- - Warning that value of a field has been overridden. Deprecated - unused field. - - >- - The operation involved use of an injected kernel, which is - deprecated. - - >- - A WEIGHTED_MAGLEV backend service is associated with a health - check that is not of type HTTP/HTTPS/HTTP2. - - >- - When deploying a deployment with a exceedingly large number of - resources - - >- - Resource can't be retrieved due to list overhead quota exceed - which captures the amount of resources filtered out by - user-defined list filter. - - A resource depends on a missing type - - >- + 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. + type: string + enumDescriptions: + - >- + All instances in the instance group are unhealthy (not in RUNNING + state). + - There is no backend service attached to the instance group. + - Autoscaler recommends a size greater than maxNumReplicas. + - >- + The custom metric samples are not exported often enough to be a + credible base for autoscaling. + - >- + The custom metric that was specified does not exist or does not + have the necessary labels. + - >- + The minNumReplicas is equal to maxNumReplicas. This means the + autoscaler cannot add or remove instances from the instance group. + - >- + The autoscaler did not receive any data from the custom metric + configured for autoscaling. + - >- + 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. + - >- + Autoscaling is turned off. The number of instances in the group + won't change automatically. The autoscaling configuration is + preserved. + - >- + Autoscaling is in the "Autoscale only scale out" mode. Instances + in the group will be only added. + - >- + Autoscaling is in the "Autoscale only out" mode. Instances in the + group will be only added. + - >- + The instance group cannot be autoscaled because it has more than + one backend service attached to it. + - >- + There is insufficient quota for the necessary resources, such as + CPU or number of instances. + - >- + Showed only for regional autoscalers: there is a resource stockout + in the chosen region. + - The target to be scaled does not exist. + - >- + For some scaling schedules minRequiredReplicas is greater than + maxNumReplicas. Autoscaler always recommends at most + maxNumReplicas instances. + - >- + For some scaling schedules minRequiredReplicas is less than + minNumReplicas. Autoscaler always recommends at least + minNumReplicas instances. + - '' + - >- + Autoscaling does not work with an HTTP/S load balancer that has + been configured for maxRate. + - >- + 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. + 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 + ScalingScheduleStatus: + id: ScalingScheduleStatus + type: object + properties: + 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 + 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 + state: + description: '[Output Only] The current state of a scaling schedule.' + type: string + enumDescriptions: + - >- + The current autoscaling recommendation is influenced by this + scaling schedule. + - This scaling schedule has been disabled by the user. + - This scaling schedule will never become active again. + - >- + The current autoscaling recommendation is not influenced by this + scaling schedule. + enum: + - ACTIVE + - DISABLED + - OBSOLETE + - READY + AutoscalerAggregatedList: + id: AutoscalerAggregatedList + type: object + properties: + kind: + description: >- + [Output Only] Type of resource. Always + compute#autoscalerAggregatedList for aggregated lists of + autoscalers. + default: compute#autoscalerAggregatedList + type: string + id: + description: >- + [Output Only] Unique identifier for the resource; defined by the + server. + type: string + items: + description: A list of AutoscalersScopedList resources. + type: object + additionalProperties: + description: >- + [Output Only] Name of the scope containing this set of + autoscalers. + $ref: '#/components/schemas/AutoscalersScopedList' + nextPageToken: + description: >- + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. + type: string + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string + warning: + description: '[Output Only] Informational warning message.' + type: object + properties: + code: + description: >- + [Output Only] A warning code, if applicable. For example, + Compute Engine returns NO_RESULTS_ON_PAGE if there are no + results in the response. + type: string + enumDescriptions: + - >- + Warning about failed cleanup of transient changes made by a + failed operation. + - A link to a deprecated resource was created. + - >- + When deploying and at least one of the resources has a type + marked as deprecated + - The user created a boot disk that is larger than image size. + - >- + When deploying and at least one of the resources has a type + marked as experimental + - Warning that is present in an external api call + - >- + Warning that value of a field has been overridden. Deprecated + unused field. + - >- + The operation involved use of an injected kernel, which is + deprecated. + - >- + A WEIGHTED_MAGLEV backend service is associated with a health + check that is not of type HTTP/HTTPS/HTTP2. + - >- + When deploying a deployment with a exceedingly large number of + resources + - >- + Resource can't be retrieved due to list overhead quota exceed + which captures the amount of resources filtered out by + user-defined list filter. + - A resource depends on a missing type + - >- The route's nextHopIp address is not assigned to an instance on the network. - The route's next hop instance cannot ip forward. @@ -18777,6 +18994,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -18820,6 +19040,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -18842,6 +19063,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -18878,992 +19100,906 @@ components: [Output Only] A warning data value corresponding to the key. type: string - BackendService: - id: 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. + unreachables: + description: >- + [Output Only] Unreachable resources. end_interface: + MixerListResponseWithEtagBuilder + type: array + items: + type: string + AutoscalersScopedList: + id: AutoscalersScopedList type: object properties: - kind: + autoscalers: + description: '[Output Only] A list of autoscalers contained in this scope.' + type: array + items: + $ref: '#/components/schemas/Autoscaler' + warning: description: >- - [Output Only] Type of resource. Always compute#backendService for - backend services. - default: compute#backendService + [Output Only] Informational warning which replaces the list of + autoscalers when the list is empty. + type: object + properties: + code: + description: >- + [Output Only] A warning code, if applicable. For example, + Compute Engine returns NO_RESULTS_ON_PAGE if there are no + results in the response. + type: string + enumDescriptions: + - >- + Warning about failed cleanup of transient changes made by a + failed operation. + - A link to a deprecated resource was created. + - >- + When deploying and at least one of the resources has a type + marked as deprecated + - The user created a boot disk that is larger than image size. + - >- + When deploying and at least one of the resources has a type + marked as experimental + - Warning that is present in an external api call + - >- + Warning that value of a field has been overridden. Deprecated + unused field. + - >- + The operation involved use of an injected kernel, which is + deprecated. + - >- + A WEIGHTED_MAGLEV backend service is associated with a health + check that is not of type HTTP/HTTPS/HTTP2. + - >- + When deploying a deployment with a exceedingly large number of + resources + - >- + Resource can't be retrieved due to list overhead quota exceed + which captures the amount of resources filtered out by + user-defined list filter. + - A resource depends on a missing type + - >- + The route's nextHopIp address is not assigned to an instance + on the network. + - The route's next hop instance cannot ip forward. + - >- + The route's nextHopInstance URL refers to an instance that + does not have an ipv6 interface on the same network as the + route. + - >- + The route's nextHopInstance URL refers to an instance that + does not exist. + - >- + The route's nextHopInstance URL refers to an instance that is + not on the same network as the route. + - >- + The route's next hop instance does not have a status of + RUNNING. + - >- + Error which is not critical. We decided to continue the + process despite the mentioned error. + - No results are present on a particular list page. + - >- + Success is reported, but some results may be missing due to + errors + - >- + Quota information is not available to client requests (e.g: + regions.list). + - >- + The user attempted to use a resource that requires a TOS they + have not accepted. + - Warning that a resource is in use. + - >- + One or more of the resources set to auto-delete could not be + deleted because they were in use. + - When a resource schema validation is ignored. + - >- + Instance template used in instance group manager is valid as + such, but its application does not make a lot of sense, + because it allows only single instance in instance group. + - When undeclared properties in the schema are present + - A given scope cannot be reached. + enumDeprecated: + - false + - false + - false + - false + - false + - false + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + enum: + - CLEANUP_FAILED + - DEPRECATED_RESOURCE_USED + - DEPRECATED_TYPE_USED + - DISK_SIZE_LARGER_THAN_IMAGE_SIZE + - EXPERIMENTAL_TYPE_USED + - EXTERNAL_API_WARNING + - FIELD_VALUE_OVERRIDEN + - INJECTED_KERNELS_DEPRECATED + - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB + - LARGE_DEPLOYMENT_WARNING + - LIST_OVERHEAD_QUOTA_EXCEED + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE + - NEXT_HOP_INSTANCE_NOT_FOUND + - NEXT_HOP_INSTANCE_NOT_ON_NETWORK + - NEXT_HOP_NOT_RUNNING + - NOT_CRITICAL_ERROR + - NO_RESULTS_ON_PAGE + - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE + - REQUIRED_TOS_AGREEMENT + - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING + - RESOURCE_NOT_DELETED + - SCHEMA_VALIDATION_IGNORED + - SINGLE_INSTANCE_PROPERTY_TEMPLATE + - UNDECLARED_PROPERTIES + - UNREACHABLE + message: + description: '[Output Only] A human-readable description of the warning code.' + type: string + data: + description: >- + [Output Only] Metadata about this warning in key: value format. + For example: "data": [ { "key": "scope", "value": + "zones/us-east1-d" } + type: array + items: + type: object + properties: + key: + description: >- + [Output Only] A key that provides more detail on the + warning being returned. For example, for warnings where + there are no results in a list request for a particular + zone, this key might be scope and the key value might be + the zone name. Other examples might be a key indicating a + deprecated resource and a suggested replacement, or a + warning about invalid network settings (for example, if an + instance attempts to perform IP forwarding but is not + enabled for IP forwarding). + type: string + value: + description: >- + [Output Only] A warning data value corresponding to the + key. + type: string + RegionAutoscalerList: + id: RegionAutoscalerList + description: Contains a list of autoscalers. + type: object + properties: + kind: + description: Type of resource. + default: compute#regionAutoscalerList type: string id: description: >- - [Output Only] The unique identifier for the resource. This - identifier is defined by the server. - type: string - format: uint64 - creationTimestamp: - description: '[Output Only] Creation timestamp in RFC3339 text format.' - 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])?' + [Output Only] Unique identifier for the resource; defined by the + server. type: string - description: + items: + description: A list of Autoscaler resources. + type: array + items: + $ref: '#/components/schemas/Autoscaler' + nextPageToken: description: >- - An optional description of this resource. Provide this property when - you create the resource. + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. type: string selfLink: - description: '[Output Only] Server-defined URL for the resource.' + description: '[Output Only] Server-defined URL for this resource.' type: string - backends: - description: The list of backends that serve this BackendService. - type: array - items: - $ref: '#/components/schemas/Backend' - 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. - type: array - items: - type: string - timeoutSec: - description: >- - The backend service timeout has a different meaning depending on the - type of load balancer. For more information see, Backend service - settings. The default is 30 seconds. The full range of timeout - values allowed goes from 1 through 2,147,483,647 seconds. This value - can be overridden in the PathMatcher configuration of the UrlMap - that references this backend service. 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. - type: integer - format: int32 - port: - description: >- - Deprecated in favor of portName. The TCP port to connect on the - backend. The default value is 80. For internal passthrough Network - Load Balancers and external passthrough Network Load Balancers, omit - port. - deprecated: true - type: integer - format: int32 - protocol: + warning: + description: '[Output Only] Informational warning message.' + type: object + properties: + code: + description: >- + [Output Only] A warning code, if applicable. For example, + Compute Engine returns NO_RESULTS_ON_PAGE if there are no + results in the response. + type: string + enumDescriptions: + - >- + Warning about failed cleanup of transient changes made by a + failed operation. + - A link to a deprecated resource was created. + - >- + When deploying and at least one of the resources has a type + marked as deprecated + - The user created a boot disk that is larger than image size. + - >- + When deploying and at least one of the resources has a type + marked as experimental + - Warning that is present in an external api call + - >- + Warning that value of a field has been overridden. Deprecated + unused field. + - >- + The operation involved use of an injected kernel, which is + deprecated. + - >- + A WEIGHTED_MAGLEV backend service is associated with a health + check that is not of type HTTP/HTTPS/HTTP2. + - >- + When deploying a deployment with a exceedingly large number of + resources + - >- + Resource can't be retrieved due to list overhead quota exceed + which captures the amount of resources filtered out by + user-defined list filter. + - A resource depends on a missing type + - >- + The route's nextHopIp address is not assigned to an instance + on the network. + - The route's next hop instance cannot ip forward. + - >- + The route's nextHopInstance URL refers to an instance that + does not have an ipv6 interface on the same network as the + route. + - >- + The route's nextHopInstance URL refers to an instance that + does not exist. + - >- + The route's nextHopInstance URL refers to an instance that is + not on the same network as the route. + - >- + The route's next hop instance does not have a status of + RUNNING. + - >- + Error which is not critical. We decided to continue the + process despite the mentioned error. + - No results are present on a particular list page. + - >- + Success is reported, but some results may be missing due to + errors + - >- + Quota information is not available to client requests (e.g: + regions.list). + - >- + The user attempted to use a resource that requires a TOS they + have not accepted. + - Warning that a resource is in use. + - >- + One or more of the resources set to auto-delete could not be + deleted because they were in use. + - When a resource schema validation is ignored. + - >- + Instance template used in instance group manager is valid as + such, but its application does not make a lot of sense, + because it allows only single instance in instance group. + - When undeclared properties in the schema are present + - A given scope cannot be reached. + enumDeprecated: + - false + - false + - false + - false + - false + - false + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + enum: + - CLEANUP_FAILED + - DEPRECATED_RESOURCE_USED + - DEPRECATED_TYPE_USED + - DISK_SIZE_LARGER_THAN_IMAGE_SIZE + - EXPERIMENTAL_TYPE_USED + - EXTERNAL_API_WARNING + - FIELD_VALUE_OVERRIDEN + - INJECTED_KERNELS_DEPRECATED + - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB + - LARGE_DEPLOYMENT_WARNING + - LIST_OVERHEAD_QUOTA_EXCEED + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE + - NEXT_HOP_INSTANCE_NOT_FOUND + - NEXT_HOP_INSTANCE_NOT_ON_NETWORK + - NEXT_HOP_NOT_RUNNING + - NOT_CRITICAL_ERROR + - NO_RESULTS_ON_PAGE + - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE + - REQUIRED_TOS_AGREEMENT + - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING + - RESOURCE_NOT_DELETED + - SCHEMA_VALIDATION_IGNORED + - SINGLE_INSTANCE_PROPERTY_TEMPLATE + - UNDECLARED_PROPERTIES + - UNREACHABLE + message: + description: '[Output Only] A human-readable description of the warning code.' + type: string + data: + description: >- + [Output Only] Metadata about this warning in key: value format. + For example: "data": [ { "key": "scope", "value": + "zones/us-east1-d" } + type: array + items: + type: object + properties: + key: + description: >- + [Output Only] A key that provides more detail on the + warning being returned. For example, for warnings where + there are no results in a list request for a particular + zone, this key might be scope and the key value might be + the zone name. Other examples might be a key indicating a + deprecated resource and a suggested replacement, or a + warning about invalid network settings (for example, if an + instance attempts to perform IP forwarding but is not + enabled for IP forwarding). + type: string + value: + description: >- + [Output Only] A warning data value corresponding to the + key. + type: string + BackendBucketList: + id: BackendBucketList + description: Contains a list of BackendBucket resources. + type: object + properties: + kind: + description: Type of resource. + default: compute#backendBucketList + type: string + id: 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. + [Output Only] Unique identifier for the resource; defined by the + server. type: string - enumDescriptions: - - gRPC (available for Traffic Director). - - '' - - HTTP/2 with SSL. - - '' - - TCP proxying with SSL. - - TCP proxying or TCP pass-through. - - UDP. - - >- - If a Backend Service has UNSPECIFIED as its protocol, it can be - used with any L3/L4 Forwarding Rules. - enum: - - GRPC - - HTTP - - HTTP2 - - HTTPS - - SSL - - TCP - - UDP - - UNSPECIFIED - fingerprint: + items: + description: A list of BackendBucket resources. + type: array + items: + $ref: '#/components/schemas/BackendBucket' + nextPageToken: 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. + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. type: string - format: byte - portName: + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string + warning: + description: '[Output Only] Informational warning message.' + type: object + properties: + code: + description: >- + [Output Only] A warning code, if applicable. For example, + Compute Engine returns NO_RESULTS_ON_PAGE if there are no + results in the response. + type: string + enumDescriptions: + - >- + Warning about failed cleanup of transient changes made by a + failed operation. + - A link to a deprecated resource was created. + - >- + When deploying and at least one of the resources has a type + marked as deprecated + - The user created a boot disk that is larger than image size. + - >- + When deploying and at least one of the resources has a type + marked as experimental + - Warning that is present in an external api call + - >- + Warning that value of a field has been overridden. Deprecated + unused field. + - >- + The operation involved use of an injected kernel, which is + deprecated. + - >- + A WEIGHTED_MAGLEV backend service is associated with a health + check that is not of type HTTP/HTTPS/HTTP2. + - >- + When deploying a deployment with a exceedingly large number of + resources + - >- + Resource can't be retrieved due to list overhead quota exceed + which captures the amount of resources filtered out by + user-defined list filter. + - A resource depends on a missing type + - >- + The route's nextHopIp address is not assigned to an instance + on the network. + - The route's next hop instance cannot ip forward. + - >- + The route's nextHopInstance URL refers to an instance that + does not have an ipv6 interface on the same network as the + route. + - >- + The route's nextHopInstance URL refers to an instance that + does not exist. + - >- + The route's nextHopInstance URL refers to an instance that is + not on the same network as the route. + - >- + The route's next hop instance does not have a status of + RUNNING. + - >- + Error which is not critical. We decided to continue the + process despite the mentioned error. + - No results are present on a particular list page. + - >- + Success is reported, but some results may be missing due to + errors + - >- + Quota information is not available to client requests (e.g: + regions.list). + - >- + The user attempted to use a resource that requires a TOS they + have not accepted. + - Warning that a resource is in use. + - >- + One or more of the resources set to auto-delete could not be + deleted because they were in use. + - When a resource schema validation is ignored. + - >- + Instance template used in instance group manager is valid as + such, but its application does not make a lot of sense, + because it allows only single instance in instance group. + - When undeclared properties in the schema are present + - A given scope cannot be reached. + enumDeprecated: + - false + - false + - false + - false + - false + - false + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + enum: + - CLEANUP_FAILED + - DEPRECATED_RESOURCE_USED + - DEPRECATED_TYPE_USED + - DISK_SIZE_LARGER_THAN_IMAGE_SIZE + - EXPERIMENTAL_TYPE_USED + - EXTERNAL_API_WARNING + - FIELD_VALUE_OVERRIDEN + - INJECTED_KERNELS_DEPRECATED + - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB + - LARGE_DEPLOYMENT_WARNING + - LIST_OVERHEAD_QUOTA_EXCEED + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE + - NEXT_HOP_INSTANCE_NOT_FOUND + - NEXT_HOP_INSTANCE_NOT_ON_NETWORK + - NEXT_HOP_NOT_RUNNING + - NOT_CRITICAL_ERROR + - NO_RESULTS_ON_PAGE + - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE + - REQUIRED_TOS_AGREEMENT + - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING + - RESOURCE_NOT_DELETED + - SCHEMA_VALIDATION_IGNORED + - SINGLE_INSTANCE_PROPERTY_TEMPLATE + - UNDECLARED_PROPERTIES + - UNREACHABLE + message: + description: '[Output Only] A human-readable description of the warning code.' + type: string + data: + description: >- + [Output Only] Metadata about this warning in key: value format. + For example: "data": [ { "key": "scope", "value": + "zones/us-east1-d" } + type: array + items: + type: object + properties: + key: + description: >- + [Output Only] A key that provides more detail on the + warning being returned. For example, for warnings where + there are no results in a list request for a particular + zone, this key might be scope and the key value might be + the zone name. Other examples might be a key indicating a + deprecated resource and a suggested replacement, or a + warning about invalid network settings (for example, if an + instance attempts to perform IP forwarding but is not + enabled for IP forwarding). + type: string + value: + description: >- + [Output Only] A warning data value corresponding to the + key. + type: string + BackendBucket: + id: 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. + type: object + properties: + kind: + description: Type of the resource. + default: compute#backendBucket + type: string + id: 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 - passthrough Network Load Balancers and external passthrough Network - Load Balancers, omit port_name. + [Output Only] Unique identifier for the resource; defined by the + server. type: string - enableCDN: + format: uint64 + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + name: description: >- - If true, enables Cloud CDN for the backend service of a global - external Application Load Balancer. + 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 + description: + description: >- + An optional textual description of the resource; provided by the + client when the resource is created. + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + bucketName: + description: Cloud Storage bucket name. + type: string + enableCdn: + description: If true, enable Cloud CDN for this BackendBucket. type: boolean - sessionAffinity: + cdnPolicy: + description: Cloud CDN configuration for this BackendBucket. + $ref: '#/components/schemas/BackendBucketCdnPolicy' + customResponseHeaders: description: >- - Type of session affinity to use. The default is NONE. Only NONE and - HEADER_FIELD are 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. For more details, see: - [Session - Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). + Headers that the Application Load Balancer should add to proxied + responses. + type: array + items: + type: string + edgeSecurityPolicy: + description: >- + [Output Only] The resource URL for the edge security policy + associated with this backend bucket. + type: string + compressionMode: + description: >- + Compress text responses using Brotli or gzip compression, based on + the client's Accept-Encoding header. type: string enumDescriptions: - >- - 2-tuple hash on packet's source and destination IP addresses. - Connections from the same source IP address to the same - destination IP address will be served by the same backend VM while - that VM remains healthy. - - >- - 1-tuple hash only on packet's source IP address. Connections from - the same source IP address will be served by the same backend VM - while that VM remains healthy. This option can only be used for - Internal TCP/UDP Load Balancing. - - >- - 5-tuple hash on packet's source and destination IP addresses, IP - protocol, and source and destination ports. Connections for the - same IP protocol from the same source IP address and port to the - same destination IP address and port will be served by the same - backend VM while that VM remains healthy. This option cannot be - used for HTTP(S) load balancing. + Automatically uses the best compression based on the + Accept-Encoding header sent by the client. - >- - 3-tuple hash on packet's source and destination IP addresses, and - IP protocol. Connections for the same IP protocol from the same - source IP address to the same destination IP address will be - served by the same backend VM while that VM remains healthy. This - option cannot be used for HTTP(S) load balancing. - - >- - Hash based on a cookie generated by the L7 loadbalancer. Only - valid for HTTP(S) load balancing. - - The hash is based on a user specified header field. - - The hash is based on a user provided cookie. - - >- - No session affinity. Connections from the same client IP may go to - any instance in the pool. - - >- - Strong cookie-based affinity. Connections bearing the same cookie - will be served by the same backend VM while that VM remains - healthy, as long as the cookie has not expired. - enum: - - CLIENT_IP - - CLIENT_IP_NO_DESTINATION - - CLIENT_IP_PORT_PROTO - - CLIENT_IP_PROTO - - GENERATED_COOKIE - - HEADER_FIELD - - HTTP_COOKIE - - NONE - - STRONG_COOKIE_AFFINITY - affinityCookieTtlSec: - description: >- - Lifetime of cookies in seconds. This setting is applicable to - Application 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 two weeks - (1,209,600). 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. - type: integer - format: int32 - 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 - failoverPolicy: - description: >- - Requires at least one backend instance group to be defined as a - backup (failover) backend. For load balancers that have configurable - failover: [Internal passthrough Network Load - Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) - and [external passthrough Network Load - Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). - $ref: '#/components/schemas/BackendServiceFailoverPolicy' - 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. - type: string - enumDescriptions: - - >- - Signifies that this will be used for classic Application Load - Balancers, global external proxy Network Load Balancers, or - external passthrough Network Load Balancers. - - >- - Signifies that this will be used for global external Application - Load Balancers, regional external Application Load Balancers, or - regional external proxy Network Load Balancers. - - >- - Signifies that this will be used for internal passthrough Network - Load Balancers. + Disables compression. Existing compressed responses cached by + Cloud CDN will not be served to clients. + enum: + - AUTOMATIC + - DISABLED + loadBalancingScheme: + description: >- + The value can only be INTERNAL_MANAGED for cross-region internal + layer 7 load balancer. If loadBalancingScheme is not specified, the + backend bucket can be used by classic global external load + balancers, or global application external load balancers, or both. + type: string + enumDescriptions: - >- Signifies that this will be used for internal Application Load Balancers. - - Signifies that this will be used by Traffic Director. - - '' enum: - - EXTERNAL - - EXTERNAL_MANAGED - - INTERNAL - INTERNAL_MANAGED - - INTERNAL_SELF_MANAGED - - INVALID_LOAD_BALANCING_SCHEME - connectionDraining: - $ref: '#/components/schemas/ConnectionDraining' - iap: - description: >- - The configurations for Identity-Aware Proxy on this resource. Not - available for internal passthrough Network Load Balancers and - external passthrough Network Load Balancers. - $ref: '#/components/schemas/BackendServiceIAP' - cdnPolicy: - description: >- - Cloud CDN configuration for this BackendService. Only available for - specified load balancer types. - $ref: '#/components/schemas/BackendServiceCdnPolicy' - customRequestHeaders: + params: description: >- - Headers that the load balancer adds to proxied requests. See - [Creating custom - headers](https://cloud.google.com/load-balancing/docs/custom-headers). + Input only. [Input Only] Additional params passed with the request, + but not persisted as part of resource payload. + $ref: '#/components/schemas/BackendBucketParams' + usedBy: + description: '[Output Only] List of resources referencing that backend bucket.' type: array items: - type: string - customResponseHeaders: - description: >- - Headers that the load balancer adds to proxied responses. See - [Creating custom - headers](https://cloud.google.com/load-balancing/docs/custom-headers). + $ref: '#/components/schemas/BackendBucketUsedBy' + BackendBucketCdnPolicy: + id: BackendBucketCdnPolicy + description: Message containing Cloud CDN configuration for a backend bucket. + type: object + properties: + signedUrlKeyNames: + description: '[Output Only] Names of the keys for signing request URLs.' type: array items: type: string - securityPolicy: - description: >- - [Output Only] The resource URL for the security policy associated - with this backend service. - type: string - edgeSecurityPolicy: + signedUrlCacheMaxAgeSec: description: >- - [Output Only] The resource URL for the edge security policy - associated with this backend service. + 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. type: string - logConfig: - 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. - $ref: '#/components/schemas/BackendServiceLogConfig' - securitySettings: + format: int64 + requestCoalescing: description: >- - This field specifies the security settings that apply to this - backend service. This field is applicable to a global backend - service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. - $ref: '#/components/schemas/SecuritySettings' - localityLbPolicy: + If true then Cloud CDN will combine multiple concurrent cache fill + requests into a small number of requests to the origin. + type: boolean + cacheMode: 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, - INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not - configured—that is, if session affinity remains at the default value - of NONE—then the default value for localityLbPolicy is ROUND_ROBIN. - If session affinity is set to a value other than NONE, then the - default value for localityLbPolicy is MAGLEV. Only ROUND_ROBIN and - RING_HASH are 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. + 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. If no value is provided for + cdnPolicy.cacheMode, it defaults to CACHE_ALL_STATIC. type: string enumDescriptions: - - '' - - >- - An O(1) algorithm which selects two random healthy hosts and picks - the host which has fewer active requests. - - >- - This algorithm implements consistent hashing to backends. Maglev - can be 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 - - >- - 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. - - The load balancer selects a random healthy host. - >- - 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. + 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. - >- - This is a simple policy in which each healthy backend is selected - in round robin order. This is the default. + 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. + - '' - >- - Per-instance weighted Load Balancing via health check reported - weights. If set, the Backend Service must configure a non legacy - HTTP-based Health Check, and health check replies are expected to - contain non-standard HTTP response header field - X-Load-Balancing-Endpoint-Weight to specify the per-instance - weights. If set, Load Balancing is weighted based on the - per-instance weights reported in the last processed health check - replies, as long as every instance either reported a valid weight - or had UNAVAILABLE_WEIGHT. Otherwise, Load Balancing remains - equal-weight. This option is only supported in Network Load - Balancing. + 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. enum: - - INVALID_LB_POLICY - - LEAST_REQUEST - - MAGLEV - - ORIGINAL_DESTINATION - - RANDOM - - RING_HASH - - ROUND_ROBIN - - WEIGHTED_MAGLEV - consistentHash: - 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. - $ref: '#/components/schemas/ConsistentHashLoadBalancerSettings' - circuitBreakers: - $ref: '#/components/schemas/CircuitBreakers' - outlierDetection: - description: >- - Settings controlling the ejection of unhealthy backend endpoints - from the load balancing pool of each individual proxy instance that - processes the traffic for the given backend service. If not set, - this feature is considered disabled. Results of the outlier - detection algorithm (ejection of endpoints from the load balancing - pool and returning them back to the pool) are executed independently - by each proxy instance of the load balancer. In most cases, more - than one proxy instance handles the traffic received by a backend - service. Thus, it is possible that an unhealthy endpoint is detected - and ejected by only some of the proxies, and while this happens, - other proxies may continue to send requests to the same unhealthy - endpoint until they detect and eject the unhealthy endpoint. - Applicable backend endpoints can be: - VM instances in an Instance - Group - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT) - - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT) - - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud - Functions Services - Private Service Connect NEGs, that resolve to - Google-managed regional API endpoints or managed services published - using Private Service Connect Applicable backend service types can - be: - A global backend service with the loadBalancingScheme set to - INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. - A regional backend - service with the serviceProtocol set to HTTP, HTTPS, or HTTP2, and - loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not - supported for Serverless NEGs. Not supported when the backend - service is referenced by a URL map that is bound to target gRPC - proxy that has validateForProxyless field set to true. - $ref: '#/components/schemas/OutlierDetection' - 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 - subsetting: - $ref: '#/components/schemas/Subsetting' - connectionTrackingPolicy: + - CACHE_ALL_STATIC + - FORCE_CACHE_ALL + - INVALID_CACHE_MODE + - USE_ORIGIN_HEADERS + defaultTtl: description: >- - Connection Tracking configuration for this BackendService. - Connection tracking policy settings are only available for external - passthrough Network Load Balancers and internal passthrough Network - Load Balancers. - $ref: '#/components/schemas/BackendServiceConnectionTrackingPolicy' - maxStreamDuration: + 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-maxage). 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. + type: integer + format: int32 + maxTtl: 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. - $ref: '#/components/schemas/Duration' - compressionMode: + 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. + type: integer + format: int32 + clientTtl: description: >- - Compress text responses using Brotli or gzip compression, based on - the client's Accept-Encoding header. - type: string - enumDescriptions: - - >- - Automatically uses the best compression based on the - Accept-Encoding header sent by the client. - - >- - Disables compression. Existing compressed responses cached by - Cloud CDN will not be served to clients. - enum: - - AUTOMATIC - - DISABLED - serviceLbPolicy: + 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). + type: integer + format: int32 + negativeCaching: description: >- - URL to networkservices.ServiceLbPolicy resource. Can only be set if - load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, - INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. - type: string - serviceBindings: + 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: >- - URLs of networkservices.ServiceBinding resources. Can only be set if - load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of - backends and health checks must be both empty. + 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. type: array items: - type: string - localityLbPolicies: + $ref: '#/components/schemas/BackendBucketCdnPolicyNegativeCachingPolicy' + bypassCacheOnRequestHeaders: description: >- - A list of locality load-balancing policies to be used in order of - preference. When you use localityLbPolicies, you must set at least - one value for either the localityLbPolicies[].policy or the - localityLbPolicies[].customPolicy field. localityLbPolicies - overrides any value set in the localityLbPolicy field. For an - example of how to use this field, see Define a list of preferred - policies. Caution: This field and its children are intended for use - in a service mesh that includes gRPC clients only. Envoy proxies - can't use backend services that have this configuration. + 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. type: array items: $ref: >- - #/components/schemas/BackendServiceLocalityLoadBalancingPolicyConfig - ipAddressSelectionPolicy: + #/components/schemas/BackendBucketCdnPolicyBypassCacheOnRequestHeader + serveWhileStale: description: >- - Specifies a preference for traffic sent from the proxy to the - backend (or from the client to the backend for proxyless gRPC). The - possible values are: - IPV4_ONLY: Only send IPv4 traffic to the - backends of the backend service (Instance Group, Managed Instance - Group, Network Endpoint Group), regardless of traffic from the - client to the proxy. Only IPv4 health checks are used to check the - health of the backends. This is the default setting. - PREFER_IPV6: - Prioritize the connection to the endpoint's IPv6 address over its - IPv4 address (provided there is a healthy IPv6 address). - - IPV6_ONLY: Only send IPv6 traffic to the backends of the backend - service (Instance Group, Managed Instance Group, Network Endpoint - Group), regardless of traffic from the client to the proxy. Only - IPv6 health checks are used to check the health of the backends. - This field is applicable to either: - Advanced global external - Application Load Balancer (load balancing scheme EXTERNAL_MANAGED), - - Regional external Application Load Balancer, - Internal proxy - Network Load Balancer (load balancing scheme INTERNAL_MANAGED), - - Regional internal Application Load Balancer (load balancing scheme - INTERNAL_MANAGED), - Traffic Director with Envoy proxies and - proxyless gRPC (load balancing scheme INTERNAL_SELF_MANAGED). - type: string - enumDescriptions: - - >- - Only send IPv4 traffic to the backends of the Backend Service - (Instance Group, Managed Instance Group, Network Endpoint Group) - regardless of traffic from the client to the proxy. Only IPv4 - health-checks are used to check the health of the backends. This - is the default setting. - - >- - Only send IPv6 traffic to the backends of the Backend Service - (Instance Group, Managed Instance Group, Network Endpoint Group) - regardless of traffic from the client to the proxy. Only IPv6 - health-checks are used to check the health of the backends. - - Unspecified IP address selection policy. - - >- - Prioritize the connection to the endpoints IPv6 address over its - IPv4 address (provided there is a healthy IPv6 address). - enum: - - IPV4_ONLY - - IPV6_ONLY - - IP_ADDRESS_SELECTION_POLICY_UNSPECIFIED - - PREFER_IPV6 - metadatas: + 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-maxage) of a cached response. + The maximum allowed value is 604800 (1 week). Set this to zero (0) + to disable serve-while-stale. + type: integer + format: int32 + cacheKeyPolicy: + description: The CacheKeyPolicy for this CdnPolicy. + $ref: '#/components/schemas/BackendBucketCdnPolicyCacheKeyPolicy' + BackendBucketCdnPolicyNegativeCachingPolicy: + id: BackendBucketCdnPolicyNegativeCachingPolicy + description: Specify CDN TTLs for response error codes. + type: object + properties: + code: description: >- - Deployment metadata associated with the resource to be set by a GKE - hub controller and read by the backend RCTH - type: object - additionalProperties: - type: string - usedBy: - description: '[Output Only] List of resources referencing given backend service.' - type: array - items: - $ref: '#/components/schemas/BackendServiceUsedBy' - strongSessionAffinityCookie: + 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. + type: integer + format: int32 + ttl: description: >- - Describes the HTTP cookie used for stateful session affinity. This - field is applicable and required if the sessionAffinity is set to - STRONG_COOKIE_AFFINITY. - $ref: '#/components/schemas/BackendServiceHttpCookie' - Backend: - id: Backend - description: Message containing information of one individual backend. + 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. + type: integer + format: int32 + BackendBucketCdnPolicyBypassCacheOnRequestHeader: + id: 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. type: object properties: - description: + headerName: description: >- - An optional description of this resource. Provide this property when - you create the resource. + The header field name to match on when bypassing cache. Values are + case-insensitive. type: string - 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 - 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. - type: string - enumDescriptions: - - Balance based on the number of simultaneous connections. - - Balance based on requests per second (RPS). - - Balance based on the backend utilization. - enum: - - CONNECTION - - RATE - - UTILIZATION - maxUtilization: - description: >- - Optional parameter to define a target capacity for the UTILIZATION - balancing mode. The valid range is [0.0, 1.0]. For usage guidelines, - see Utilization balancing mode. - type: number - format: float - 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. - type: integer - format: int32 - 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. - type: number - format: float - 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. - type: number - format: float - 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. - type: integer - format: int32 - 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. - type: integer - format: int32 - 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. - type: integer - format: int32 - 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. Not available with backends that - don't support using a balancingMode. This includes backends such as - global internet NEGs, regional serverless NEGs, and PSC NEGs. - type: number - format: float - 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 - preference: - description: >- - This field indicates whether this backend should be fully utilized - before sending traffic to backends with default preference. The - possible values are: - PREFERRED: Backends with this preference - level will be filled up to their capacity limits first, based on - RTT. - DEFAULT: If preferred backends don't have enough capacity, - backends in this layer would be used and traffic would be assigned - based on the load balancing algorithm you use. This is the default - type: string - enumDescriptions: - - No preference. - - If preference is unspecified, we set it to the DEFAULT value - - Traffic will be sent to this backend first. - enum: - - DEFAULT - - PREFERENCE_UNSPECIFIED - - PREFERRED - BackendServiceFailoverPolicy: - id: BackendServiceFailoverPolicy - description: >- - For load balancers that have configurable failover: [Internal - passthrough Network Load - Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) - and [external passthrough Network Load - Balancers](https://cloud.google.com/load-balancing/docs/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). - type: object - 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 passthrough Network Load - Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) - and [external passthrough Network Load - Balancers](https://cloud.google.com/load-balancing/docs/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](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). - type: number - format: float - ConnectionDraining: - id: ConnectionDraining - description: Message containing connection draining configuration. - type: object - 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. - type: integer - format: int32 - BackendServiceIAP: - id: BackendServiceIAP - description: Identity-Aware Proxy - type: object - properties: - enabled: - description: >- - Whether the serving infrastructure will authenticate and authorize - all incoming requests. - 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 - BackendServiceCdnPolicy: - id: BackendServiceCdnPolicy - description: Message containing Cloud CDN configuration for a backend service. - type: object - properties: - cacheKeyPolicy: - description: The CacheKeyPolicy for this CdnPolicy. - $ref: '#/components/schemas/CacheKeyPolicy' - signedUrlKeyNames: - description: '[Output Only] Names of the keys for signing request URLs.' - type: array - items: - type: string - 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. - type: string - format: int64 - 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 - 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. - type: string - enumDescriptions: - - >- - 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. - - >- - 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. - - '' - - >- - 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. - enum: - - CACHE_ALL_STATIC - - FORCE_CACHE_ALL - - INVALID_CACHE_MODE - - USE_ORIGIN_HEADERS - 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. - type: integer - format: int32 - 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. - type: integer - format: int32 - 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). - type: integer - format: int32 - 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. - type: array - items: - $ref: '#/components/schemas/BackendServiceCdnPolicyNegativeCachingPolicy' - 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. - type: array - items: - $ref: >- - #/components/schemas/BackendServiceCdnPolicyBypassCacheOnRequestHeader - 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. - type: integer - format: int32 - CacheKeyPolicy: - id: CacheKeyPolicy + BackendBucketCdnPolicyCacheKeyPolicy: + id: BackendBucketCdnPolicyCacheKeyPolicy description: >- Message containing what to include in the cache key for a request for Cloud CDN. type: object properties: - includeProtocol: - description: If true, http and https requests will be cached separately. - type: boolean - includeHost: - description: If true, requests to different hosts 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 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. - type: array - items: - type: string - 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. + Names of query string parameters to include in cache keys. Default + parameters are always included. '&' and '=' will be percent encoded + and not treated as delimiters. type: array items: type: string @@ -19872,587 +20008,70 @@ components: type: array items: type: string - includeNamedCookies: - description: >- - Allows HTTP cookies (by name) to be used in the cache key. The - name=value pair will be used in the cache key Cloud CDN generates. - type: array - items: - type: string - BackendServiceCdnPolicyNegativeCachingPolicy: - id: BackendServiceCdnPolicyNegativeCachingPolicy - description: Specify CDN TTLs for response error codes. + BackendBucketParams: + id: BackendBucketParams + description: Additional Backend Bucket parameters. type: object 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. - type: integer - format: int32 - ttl: + resourceManagerTags: 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. - type: integer - format: int32 - BackendServiceCdnPolicyBypassCacheOnRequestHeader: - id: 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. + Tag keys/values directly bound to this resource. Tag keys and values + have the same definition as resource manager tags. The field is + allowed for INSERT only. The keys/values to set on the resource + should be specified in either ID { : } or Namespaced format { : }. + For example the following are valid inputs: * {"tagKeys/333" : + "tagValues/444", "tagKeys/123" : "tagValues/456"} * + {"123/environment" : "production", "345/abc" : "xyz"} Note: * + Invalid combinations of ID & namespaced format is not supported. For + instance: {"123/environment" : "tagValues/444"} is invalid. + type: object + additionalProperties: + type: string + BackendBucketUsedBy: + id: BackendBucketUsedBy type: object properties: - headerName: + reference: description: >- - The header field name to match on when bypassing cache. Values are - case-insensitive. + [Output Only] Server-defined URL for UrlMaps referencing that + BackendBucket. type: string - BackendServiceLogConfig: - id: BackendServiceLogConfig - description: >- - The available logging options for the load balancer traffic served by - this backend service. + SignedUrlKey: + id: SignedUrlKey + description: Represents a customer-supplied Signing Key used by Cloud CDN Signed URLs type: object properties: - enable: - description: >- - Denotes whether to enable logging for the load balancer traffic - served by this backend service. The default value is false. - 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. - type: number - format: float - optionalMode: + keyName: description: >- - This field can only be specified if logging is enabled for this - backend service. Configures whether all, none or a subset of - optional fields should be added to the reported logs. One of - [INCLUDE_ALL_OPTIONAL, EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is - EXCLUDE_ALL_OPTIONAL. + 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 - enumDescriptions: - - A subset of optional fields. - - None optional fields. - - All optional fields. - enum: - - CUSTOM - - EXCLUDE_ALL_OPTIONAL - - INCLUDE_ALL_OPTIONAL - optionalFields: + keyValue: description: >- - This field can only be specified if logging is enabled for this - backend service and "logConfig.optionalMode" was set to CUSTOM. - Contains a list of optional fields you want to include in the logs. - For example: serverInstance, serverGkeDetails.cluster, - serverGkeDetails.pod.podNamespace - type: array - items: - type: string - SecuritySettings: - id: SecuritySettings - description: The authentication and authorization settings for a BackendService. + 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 + SecurityPolicyReference: + id: SecurityPolicyReference type: object 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. + securityPolicy: type: string - subjectAltNames: + BackendServiceList: + id: BackendServiceList + description: Contains a list of BackendService resources. + type: object + properties: + kind: 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). - type: array - items: - type: string - awsV4Authentication: - description: >- - The configuration needed to generate a signature for access to - private storage buckets that support AWS's Signature Version 4 for - authentication. Allowed only for INTERNET_IP_PORT and - INTERNET_FQDN_PORT NEG backends. - $ref: '#/components/schemas/AWSV4Signature' - AWSV4Signature: - id: AWSV4Signature - description: >- - Contains the configurations necessary to generate a signature for access - to private storage buckets that support Signature Version 4 for - authentication. The service name for generating the authentication - header will always default to 's3'. - type: object - properties: - accessKeyId: - description: The identifier of an access key used for s3 bucket authentication. - type: string - accessKey: - description: >- - The access key used for s3 bucket authentication. Required for - updating or creating a backend that uses AWS v4 signature - authentication, but will not be returned as part of the - configuration when queried with a REST API GET request. @InputOnly - type: string - accessKeyVersion: - description: >- - The optional version identifier for the access key. You can use this - to keep track of different iterations of your access key. - type: string - originRegion: - description: >- - The name of the cloud region of your origin. This is a free-form - field with the name of the region your cloud uses to host your - origin. For example, "us-east-1" for AWS or "us-ashburn-1" for OCI. - type: string - ConsistentHashLoadBalancerSettings: - id: ConsistentHashLoadBalancerSettings - description: This message defines settings for a consistent hash style load balancer. - type: object - properties: - httpCookie: - 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. - 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. - $ref: '#/components/schemas/ConsistentHashLoadBalancerSettingsHttpCookie' - 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. - type: string - format: int64 - ConsistentHashLoadBalancerSettingsHttpCookie: - id: ConsistentHashLoadBalancerSettingsHttpCookie - description: >- - The information about the HTTP Cookie on which the hash function is - based for load balancing policies that use a consistent hash. - type: object - properties: - name: - description: Name of the cookie. - type: string - path: - description: Path to set for the cookie. - type: string - ttl: - description: Lifetime of the cookie. - $ref: '#/components/schemas/Duration' - CircuitBreakers: - id: CircuitBreakers - description: >- - Settings controlling the volume of requests, connections and retries to - this backend service. - type: object - properties: - maxRequestsPerConnection: - description: >- - Maximum requests for a single connection to the backend service. - This parameter is respected by both the HTTP/1.1 and HTTP/2 - implementations. If not specified, there is no limit. Setting this - parameter to 1 will effectively disable keep alive. 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. - type: integer - format: int32 - maxConnections: - description: >- - The maximum number of connections to the backend service. If not - specified, there is no limit. 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. - type: integer - format: int32 - maxPendingRequests: - description: >- - The maximum number of pending requests allowed to the backend - service. If not specified, there is no limit. 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. - type: integer - format: int32 - maxRequests: - description: >- - The maximum number of parallel requests that allowed to the backend - service. If not specified, there is no limit. - type: integer - format: int32 - maxRetries: - description: >- - The maximum number of parallel retries allowed to the backend - cluster. If not specified, the default is 1. 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. - type: integer - format: int32 - OutlierDetection: - id: OutlierDetection - description: >- - Settings controlling the eviction of unhealthy hosts from the load - balancing pool for the backend service. - type: object - properties: - consecutiveErrors: - description: >- - Number of consecutive errors before a backend endpoint is ejected - from the load balancing pool. When the backend endpoint is accessed - over HTTP, a 5xx return code qualifies as an error. Defaults to 5. - type: integer - format: int32 - interval: - description: >- - Time interval between ejection analysis sweeps. This can result in - both new ejections and backend endpoints being returned to service. - The interval is equal to the number of seconds as defined in - outlierDetection.interval.seconds plus the number of nanoseconds as - defined in outlierDetection.interval.nanos. Defaults to 1 second. - $ref: '#/components/schemas/Duration' - baseEjectionTime: - description: >- - The base time that a backend endpoint is ejected for. Defaults to - 30000ms or 30s. After a backend endpoint is returned back to the - load balancing pool, it can be ejected again in another ejection - analysis. Thus, the total ejection time is equal to the base - ejection time multiplied by the number of times the backend endpoint - has been ejected. Defaults to 30000ms or 30s. - $ref: '#/components/schemas/Duration' - maxEjectionPercent: - description: >- - Maximum percentage of backend endpoints in the load balancing pool - for the backend service that can be ejected if the ejection - conditions are met. Defaults to 50%. - type: integer - format: int32 - enforcingConsecutiveErrors: - description: >- - The percentage chance that a backend endpoint will be ejected when - an outlier status is detected through consecutive 5xx. This setting - can be used to disable ejection or to ramp it up slowly. Defaults to - 0. - type: integer - format: int32 - enforcingSuccessRate: - description: >- - The percentage chance that a backend endpoint will be ejected when - an outlier status is detected through success rate statistics. This - setting can be used to disable ejection or to ramp it up slowly. - Defaults to 100. Not supported when the backend service uses - Serverless NEG. - type: integer - format: int32 - successRateMinimumHosts: - description: >- - The number of backend endpoints in the load balancing pool that must - have enough request volume to detect success rate outliers. If the - number of backend endpoints is fewer than this setting, outlier - detection via success rate statistics is not performed for any - backend endpoint in the load balancing pool. Defaults to 5. Not - supported when the backend service uses Serverless NEG. - type: integer - format: int32 - 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 - backend endpoint in success rate based outlier detection. If the - volume is lower than this setting, outlier detection via success - rate statistics is not performed for that backend endpoint. Defaults - to 100. Not supported when the backend service uses Serverless NEG. - type: integer - format: int32 - 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 * - successRateStdevFactor). This factor is divided by a thousand to get - a double. That is, if the desired factor is 1.9, the runtime value - should be 1900. Defaults to 1900. Not supported when the backend - service uses Serverless NEG. - type: integer - format: int32 - 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. - type: integer - format: int32 - enforcingConsecutiveGatewayFailure: - description: >- - The percentage chance that a backend endpoint will be ejected when - an outlier status is detected through consecutive gateway failures. - This setting can be used to disable ejection or to ramp it up - slowly. Defaults to 100. - type: integer - format: int32 - Subsetting: - id: 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. - type: object - properties: - policy: - type: string - enumDescriptions: - - >- - Subsetting based on consistent hashing. For Traffic Director, the - number of backends per backend group (the subset size) is based on - the `subset_size` parameter. For Internal HTTP(S) load balancing, - the number of backends per backend group (the subset size) is - dynamically adjusted in two cases: - As the number of proxy - instances participating in Internal HTTP(S) load balancing - increases, the subset size decreases. - When the total number of - backends in a network exceeds the capacity of a single proxy - instance, subset sizes are reduced automatically for each service - that has backend subsetting enabled. - - >- - No Subsetting. Clients may open connections and send traffic to - all backends of this backend service. This can lead to performance - issues if there is substantial imbalance in the count of clients - and backends. - enum: - - CONSISTENT_HASH_SUBSETTING - - NONE - BackendServiceConnectionTrackingPolicy: - id: BackendServiceConnectionTrackingPolicy - description: Connection Tracking configuration for this BackendService. - type: object - properties: - trackingMode: - description: >- - Specifies the key used for connection tracking. There are two - options: - PER_CONNECTION: This is the default mode. The Connection - Tracking is performed as per the Connection Key (default Hash - Method) for the specific protocol. - PER_SESSION: The Connection - Tracking is performed as per the configured Session Affinity. It - matches the configured Session Affinity. For more details, see - [Tracking Mode for Network Load - Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#tracking-mode) - and [Tracking Mode for Internal TCP/UDP Load - Balancing](https://cloud.google.com/load-balancing/docs/internal#tracking-mode). - type: string - enumDescriptions: - - '' - - '' - - '' - enum: - - INVALID_TRACKING_MODE - - PER_CONNECTION - - PER_SESSION - connectionPersistenceOnUnhealthyBackends: - description: >- - Specifies connection persistence when backends are unhealthy. The - default value is DEFAULT_FOR_PROTOCOL. If set to - DEFAULT_FOR_PROTOCOL, the existing connections persist on unhealthy - backends only for connection-oriented protocols (TCP and SCTP) and - only if the Tracking Mode is PER_CONNECTION (default tracking mode) - or the Session Affinity is configured for 5-tuple. They do not - persist for UDP. If set to NEVER_PERSIST, after a backend becomes - unhealthy, the existing connections on the unhealthy backend are - never persisted on the unhealthy backend. They are always diverted - to newly selected healthy backends (unless all backends are - unhealthy). If set to ALWAYS_PERSIST, existing connections always - persist on unhealthy backends regardless of protocol and session - affinity. It is generally not recommended to use this mode - overriding the default. For more details, see [Connection - Persistence for Network Load - Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#connection-persistence) - and [Connection Persistence for Internal TCP/UDP Load - Balancing](https://cloud.google.com/load-balancing/docs/internal#connection-persistence). - type: string - enumDescriptions: - - '' - - '' - - '' - enum: - - ALWAYS_PERSIST - - DEFAULT_FOR_PROTOCOL - - NEVER_PERSIST - idleTimeoutSec: - description: >- - Specifies how long to keep a Connection Tracking entry while there - is no matching traffic (in seconds). For internal passthrough - Network Load Balancers: - The minimum (default) is 10 minutes and - the maximum is 16 hours. - It can be set only if Connection Tracking - is less than 5-tuple (i.e. Session Affinity is - CLIENT_IP_NO_DESTINATION, CLIENT_IP or CLIENT_IP_PROTO, and Tracking - Mode is PER_SESSION). For external passthrough Network Load - Balancers the default is 60 seconds. This option is not available - publicly. - type: integer - format: int32 - enableStrongAffinity: - description: >- - Enable Strong Session Affinity for external passthrough Network Load - Balancers. This option is not available publicly. - type: boolean - BackendServiceLocalityLoadBalancingPolicyConfig: - id: BackendServiceLocalityLoadBalancingPolicyConfig - description: >- - Container for either a built-in LB policy supported by gRPC or Envoy or - a custom one implemented by the end user. - type: object - properties: - policy: - $ref: >- - #/components/schemas/BackendServiceLocalityLoadBalancingPolicyConfigPolicy - customPolicy: - $ref: >- - #/components/schemas/BackendServiceLocalityLoadBalancingPolicyConfigCustomPolicy - BackendServiceLocalityLoadBalancingPolicyConfigPolicy: - id: BackendServiceLocalityLoadBalancingPolicyConfigPolicy - description: The configuration for a built-in load balancing policy. - type: object - properties: - name: - description: >- - The name of a locality load-balancing policy. Valid values include - ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information - about these values, see the description of localityLbPolicy. Do not - specify the same policy more than once for a backend. If you do, the - configuration is rejected. - type: string - enumDescriptions: - - '' - - >- - An O(1) algorithm which selects two random healthy hosts and picks - the host which has fewer active requests. - - >- - This algorithm implements consistent hashing to backends. Maglev - can be 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 - - >- - 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. - - The load balancer selects a random healthy host. - - >- - 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. - - >- - This is a simple policy in which each healthy backend is selected - in round robin order. This is the default. - - >- - Per-instance weighted Load Balancing via health check reported - weights. If set, the Backend Service must configure a non legacy - HTTP-based Health Check, and health check replies are expected to - contain non-standard HTTP response header field - X-Load-Balancing-Endpoint-Weight to specify the per-instance - weights. If set, Load Balancing is weighted based on the - per-instance weights reported in the last processed health check - replies, as long as every instance either reported a valid weight - or had UNAVAILABLE_WEIGHT. Otherwise, Load Balancing remains - equal-weight. This option is only supported in Network Load - Balancing. - enum: - - INVALID_LB_POLICY - - LEAST_REQUEST - - MAGLEV - - ORIGINAL_DESTINATION - - RANDOM - - RING_HASH - - ROUND_ROBIN - - WEIGHTED_MAGLEV - BackendServiceLocalityLoadBalancingPolicyConfigCustomPolicy: - id: BackendServiceLocalityLoadBalancingPolicyConfigCustomPolicy - description: >- - The configuration for a custom policy implemented by the user and - deployed with the client. - type: object - properties: - name: - description: >- - Identifies the custom policy. The value should match the name of a - custom implementation registered on the gRPC clients. It should - follow protocol buffer message naming conventions and include the - full path (for example, myorg.CustomLbPolicy). The maximum length is - 256 characters. Do not specify the same custom policy more than once - for a backend. If you do, the configuration is rejected. For an - example of how to use this field, see Use a custom policy. - type: string - data: - description: >- - An optional, arbitrary JSON object with configuration data, - understood by a locally installed custom policy implementation. - type: string - BackendServiceUsedBy: - id: BackendServiceUsedBy - type: object - properties: - reference: - description: >- - [Output Only] Server-defined URL for resources referencing given - BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and - ForwardingRule. - type: string - BackendServiceHttpCookie: - id: BackendServiceHttpCookie - description: The HTTP cookie used for stateful session affinity. - type: object - properties: - name: - description: Name of the cookie. - type: string - path: - description: Path to set for the cookie. - type: string - ttl: - description: Lifetime of the cookie. - $ref: '#/components/schemas/Duration' - BackendServiceAggregatedList: - id: BackendServiceAggregatedList - description: Contains a list of BackendServicesScopedList. - type: object - properties: - kind: - description: Type of resource. - default: compute#backendServiceAggregatedList + [Output Only] Type of resource. Always compute#backendServiceList + for lists of backend services. + default: compute#backendServiceList type: string id: description: >- @@ -20460,11 +20079,10 @@ components: server. type: string items: - description: A list of BackendServicesScopedList resources. - type: object - additionalProperties: - description: Name of the scope containing this set of BackendServices. - $ref: '#/components/schemas/BackendServicesScopedList' + description: A list of BackendService resources. + type: array + items: + $ref: '#/components/schemas/BackendService' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -20540,6 +20158,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -20583,6 +20204,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -20605,6 +20227,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -20641,1688 +20264,2011 @@ components: [Output Only] A warning data value corresponding to the key. type: string - unreachables: - description: '[Output Only] Unreachable resources.' - type: array - items: - type: string - BackendServicesScopedList: - id: BackendServicesScopedList - type: object - properties: - backendServices: - description: A list of BackendServices contained in this scope. - type: array - items: - $ref: '#/components/schemas/BackendService' - warning: - description: >- - Informational warning which replaces the list of backend services - when the list is empty. - type: object - properties: - code: - description: >- - [Output Only] A warning code, if applicable. For example, - Compute Engine returns NO_RESULTS_ON_PAGE if there are no - results in the response. - type: string - enumDescriptions: - - >- - Warning about failed cleanup of transient changes made by a - failed operation. - - A link to a deprecated resource was created. - - >- - When deploying and at least one of the resources has a type - marked as deprecated - - The user created a boot disk that is larger than image size. - - >- - When deploying and at least one of the resources has a type - marked as experimental - - Warning that is present in an external api call - - >- - Warning that value of a field has been overridden. Deprecated - unused field. - - >- - The operation involved use of an injected kernel, which is - deprecated. - - >- - A WEIGHTED_MAGLEV backend service is associated with a health - check that is not of type HTTP/HTTPS/HTTP2. - - >- - When deploying a deployment with a exceedingly large number of - resources - - >- - Resource can't be retrieved due to list overhead quota exceed - which captures the amount of resources filtered out by - user-defined list filter. - - A resource depends on a missing type - - >- - The route's nextHopIp address is not assigned to an instance - on the network. - - The route's next hop instance cannot ip forward. - - >- - The route's nextHopInstance URL refers to an instance that - does not have an ipv6 interface on the same network as the - route. - - >- - The route's nextHopInstance URL refers to an instance that - does not exist. - - >- - The route's nextHopInstance URL refers to an instance that is - not on the same network as the route. - - >- - The route's next hop instance does not have a status of - RUNNING. - - >- - Error which is not critical. We decided to continue the - process despite the mentioned error. - - No results are present on a particular list page. - - >- - Success is reported, but some results may be missing due to - errors - - >- - The user attempted to use a resource that requires a TOS they - have not accepted. - - Warning that a resource is in use. - - >- - One or more of the resources set to auto-delete could not be - deleted because they were in use. - - When a resource schema validation is ignored. - - >- - Instance template used in instance group manager is valid as - such, but its application does not make a lot of sense, - because it allows only single instance in instance group. - - When undeclared properties in the schema are present - - A given scope cannot be reached. - enumDeprecated: - - false - - false - - false - - false - - false - - false - - true - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - enum: - - CLEANUP_FAILED - - DEPRECATED_RESOURCE_USED - - DEPRECATED_TYPE_USED - - DISK_SIZE_LARGER_THAN_IMAGE_SIZE - - EXPERIMENTAL_TYPE_USED - - EXTERNAL_API_WARNING - - FIELD_VALUE_OVERRIDEN - - INJECTED_KERNELS_DEPRECATED - - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB - - LARGE_DEPLOYMENT_WARNING - - LIST_OVERHEAD_QUOTA_EXCEED - - MISSING_TYPE_DEPENDENCY - - NEXT_HOP_ADDRESS_NOT_ASSIGNED - - NEXT_HOP_CANNOT_IP_FORWARD - - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE - - NEXT_HOP_INSTANCE_NOT_FOUND - - NEXT_HOP_INSTANCE_NOT_ON_NETWORK - - NEXT_HOP_NOT_RUNNING - - NOT_CRITICAL_ERROR - - NO_RESULTS_ON_PAGE - - PARTIAL_SUCCESS - - REQUIRED_TOS_AGREEMENT - - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - - RESOURCE_NOT_DELETED - - SCHEMA_VALIDATION_IGNORED - - SINGLE_INSTANCE_PROPERTY_TEMPLATE - - UNDECLARED_PROPERTIES - - UNREACHABLE - message: - description: '[Output Only] A human-readable description of the warning code.' - type: string - data: - description: >- - [Output Only] Metadata about this warning in key: value format. - For example: "data": [ { "key": "scope", "value": - "zones/us-east1-d" } - type: array - items: - type: object - properties: - key: - description: >- - [Output Only] A key that provides more detail on the - warning being returned. For example, for warnings where - there are no results in a list request for a particular - zone, this key might be scope and the key value might be - the zone name. Other examples might be a key indicating a - deprecated resource and a suggested replacement, or a - warning about invalid network settings (for example, if an - instance attempts to perform IP forwarding but is not - enabled for IP forwarding). - type: string - value: - description: >- - [Output Only] A warning data value corresponding to the - key. - type: string - BackendServiceListUsable: - id: BackendServiceListUsable - description: Contains a list of usable BackendService resources. + BackendService: + id: 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. type: object properties: kind: description: >- - [Output Only] Type of resource. Always - compute#usableBackendServiceList for lists of usable backend - services. - default: compute#usableBackendServiceList + [Output Only] Type of resource. Always compute#backendService for + backend services. + default: compute#backendService type: string id: description: >- - [Output Only] Unique identifier for the resource; defined by the - server. - type: string - items: - description: A list of BackendService resources. - type: array - items: - $ref: '#/components/schemas/BackendService' - nextPageToken: - description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. + [Output Only] The unique identifier for the resource. This + identifier is defined by the server. type: string - selfLink: - description: '[Output Only] Server-defined URL for this resource.' + format: uint64 + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' type: string - warning: - description: '[Output Only] Informational warning message.' - type: object - properties: - code: - description: >- - [Output Only] A warning code, if applicable. For example, - Compute Engine returns NO_RESULTS_ON_PAGE if there are no - results in the response. - type: string - enumDescriptions: - - >- - Warning about failed cleanup of transient changes made by a - failed operation. - - A link to a deprecated resource was created. - - >- - When deploying and at least one of the resources has a type - marked as deprecated - - The user created a boot disk that is larger than image size. - - >- - When deploying and at least one of the resources has a type - marked as experimental - - Warning that is present in an external api call - - >- - Warning that value of a field has been overridden. Deprecated - unused field. - - >- - The operation involved use of an injected kernel, which is - deprecated. - - >- - A WEIGHTED_MAGLEV backend service is associated with a health - check that is not of type HTTP/HTTPS/HTTP2. - - >- - When deploying a deployment with a exceedingly large number of - resources - - >- - Resource can't be retrieved due to list overhead quota exceed - which captures the amount of resources filtered out by - user-defined list filter. - - A resource depends on a missing type - - >- - The route's nextHopIp address is not assigned to an instance - on the network. - - The route's next hop instance cannot ip forward. - - >- - The route's nextHopInstance URL refers to an instance that - does not have an ipv6 interface on the same network as the - route. - - >- - The route's nextHopInstance URL refers to an instance that - does not exist. - - >- - The route's nextHopInstance URL refers to an instance that is - not on the same network as the route. - - >- - The route's next hop instance does not have a status of - RUNNING. - - >- - Error which is not critical. We decided to continue the - process despite the mentioned error. - - No results are present on a particular list page. - - >- - Success is reported, but some results may be missing due to - errors - - >- - The user attempted to use a resource that requires a TOS they - have not accepted. - - Warning that a resource is in use. - - >- - One or more of the resources set to auto-delete could not be - deleted because they were in use. - - When a resource schema validation is ignored. - - >- - Instance template used in instance group manager is valid as - such, but its application does not make a lot of sense, - because it allows only single instance in instance group. - - When undeclared properties in the schema are present - - A given scope cannot be reached. - enumDeprecated: - - false - - false - - false - - false - - false - - false - - true - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - enum: - - CLEANUP_FAILED - - DEPRECATED_RESOURCE_USED - - DEPRECATED_TYPE_USED - - DISK_SIZE_LARGER_THAN_IMAGE_SIZE - - EXPERIMENTAL_TYPE_USED - - EXTERNAL_API_WARNING - - FIELD_VALUE_OVERRIDEN - - INJECTED_KERNELS_DEPRECATED - - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB - - LARGE_DEPLOYMENT_WARNING - - LIST_OVERHEAD_QUOTA_EXCEED - - MISSING_TYPE_DEPENDENCY - - NEXT_HOP_ADDRESS_NOT_ASSIGNED - - NEXT_HOP_CANNOT_IP_FORWARD - - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE - - NEXT_HOP_INSTANCE_NOT_FOUND - - NEXT_HOP_INSTANCE_NOT_ON_NETWORK - - NEXT_HOP_NOT_RUNNING - - NOT_CRITICAL_ERROR - - NO_RESULTS_ON_PAGE - - PARTIAL_SUCCESS - - REQUIRED_TOS_AGREEMENT - - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - - RESOURCE_NOT_DELETED - - SCHEMA_VALIDATION_IGNORED - - SINGLE_INSTANCE_PROPERTY_TEMPLATE - - UNDECLARED_PROPERTIES - - UNREACHABLE - message: - description: '[Output Only] A human-readable description of the warning code.' - type: string - data: - description: >- - [Output Only] Metadata about this warning in key: value format. - For example: "data": [ { "key": "scope", "value": - "zones/us-east1-d" } - type: array - items: - type: object - properties: - key: - description: >- - [Output Only] A key that provides more detail on the - warning being returned. For example, for warnings where - there are no results in a list request for a particular - zone, this key might be scope and the key value might be - the zone name. Other examples might be a key indicating a - deprecated resource and a suggested replacement, or a - warning about invalid network settings (for example, if an - instance attempts to perform IP forwarding but is not - enabled for IP forwarding). - type: string - value: - description: >- - [Output Only] A warning data value corresponding to the - key. - type: string - ResourceGroupReference: - id: ResourceGroupReference - type: object - properties: - group: + name: description: >- - A URI referencing one of the instance groups or network endpoint - groups listed in the backend service. + 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 - BackendServiceGroupHealth: - id: BackendServiceGroupHealth - type: object - properties: - kind: + description: description: >- - [Output Only] Type of resource. Always - compute#backendServiceGroupHealth for the health of backend - services. - default: compute#backendServiceGroupHealth + An optional description of this resource. Provide this property when + you create the resource. type: string - healthStatus: + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + backends: + description: The list of backends that serve this BackendService. + type: array + items: + $ref: '#/components/schemas/Backend' + healthChecks: description: >- - Health state of the backend instances or endpoints in requested - instance or network endpoint group, determined based on configured - health checks. + 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 unless haPolicy + is specified. Backend services with internet or serverless NEG + backends must not have a health check. healthChecks[] cannot be + specified with haPolicy. type: array items: - $ref: '#/components/schemas/HealthStatus' - annotations: - description: Metadata defined as annotations on the network endpoint group. - type: object - additionalProperties: type: string - HealthStatus: - id: HealthStatus - type: object - properties: - ipAddress: + timeoutSec: 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 - ipv6Address: - type: string + The backend service timeout has a different meaning depending on the + type of load balancer. For more information see, Backend service + settings. The default is 30 seconds. The full range of timeout + values allowed goes from 1 through 2,147,483,647 seconds. This value + can be overridden in the PathMatcher configuration of the UrlMap + that references this backend service. 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. + type: integer + format: int32 port: description: >- - The named port of the instance group, not necessarily the port that - is health-checked. + Deprecated in favor of portName. The TCP port to connect on the + backend. The default value is 80. For internal passthrough Network + Load Balancers and external passthrough Network Load Balancers, omit + port. + deprecated: true type: integer format: int32 - instance: - description: URL of the instance resource. - type: string - healthState: - description: Health state of the IPv4 address of the instance. - type: string - enumDescriptions: - - '' - - '' - enum: - - HEALTHY - - UNHEALTHY - ipv6HealthState: - description: Health state of the IPv6 address of the instance. + protocol: + description: >- + The protocol this BackendService uses to communicate with backends. + Possible values are HTTP, HTTPS, HTTP2, H2C, 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. type: string enumDescriptions: + - gRPC (available for Traffic Director). + - HTTP2 over cleartext - '' + - HTTP/2 with SSL. - '' - enum: - - HEALTHY - - UNHEALTHY - annotations: - description: Metadata defined as annotations for network endpoint. - type: object - additionalProperties: - type: string - weight: - type: string - weightError: - type: string - enumDescriptions: - - >- - The response to a Health Check probe had the HTTP response header - field X-Load-Balancing-Endpoint-Weight, but its content was - invalid (i.e., not a non-negative single-precision floating-point - number in decimal string representation). - - >- - The response to a Health Check probe did not have the HTTP - response header field X-Load-Balancing-Endpoint-Weight. - - >- - This is the value when the accompanied health status is either - TIMEOUT (i.e.,the Health Check probe was not able to get a - response in time) or UNKNOWN. For the latter, it should be - typically because there has not been sufficient time to parse and - report the weight for a new backend (which is with 0.0.0.0 ip - address). However, it can be also due to an outage case for which - the health status is explicitly reset to UNKNOWN. + - TCP proxying with SSL. + - TCP proxying or TCP pass-through. + - UDP. - >- - This is the default value when WeightReportMode is DISABLE, and is - also the initial value when WeightReportMode has just updated to - ENABLE or DRY_RUN and there has not been sufficient time to parse - and report the backend weight. + If a Backend Service has UNSPECIFIED as its protocol, it can be + used with any L3/L4 Forwarding Rules. enum: - - INVALID_WEIGHT - - MISSING_WEIGHT - - UNAVAILABLE_WEIGHT - - WEIGHT_NONE - forwardingRuleIp: - description: A forwarding rule IP address assigned to this instance. - type: string - forwardingRule: - description: >- - URL of the forwarding rule associated with the health status of the - instance. - type: string - CommitmentList: - id: CommitmentList - description: Contains a list of Commitment resources. - type: object - properties: - kind: - description: >- - [Output Only] Type of resource. Always compute#commitmentList for - lists of commitments. - default: compute#commitmentList - type: string - id: - description: >- - [Output Only] Unique identifier for the resource; defined by the - server. - type: string - items: - description: A list of Commitment resources. - type: array - items: - $ref: '#/components/schemas/Commitment' - nextPageToken: - description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. - type: string - selfLink: - description: '[Output Only] Server-defined URL for this resource.' - type: string - warning: - description: '[Output Only] Informational warning message.' - type: object - properties: - code: - description: >- - [Output Only] A warning code, if applicable. For example, - Compute Engine returns NO_RESULTS_ON_PAGE if there are no - results in the response. - type: string - enumDescriptions: - - >- - Warning about failed cleanup of transient changes made by a - failed operation. - - A link to a deprecated resource was created. - - >- - When deploying and at least one of the resources has a type - marked as deprecated - - The user created a boot disk that is larger than image size. - - >- - When deploying and at least one of the resources has a type - marked as experimental - - Warning that is present in an external api call - - >- - Warning that value of a field has been overridden. Deprecated - unused field. - - >- - The operation involved use of an injected kernel, which is - deprecated. - - >- - A WEIGHTED_MAGLEV backend service is associated with a health - check that is not of type HTTP/HTTPS/HTTP2. - - >- - When deploying a deployment with a exceedingly large number of - resources - - >- - Resource can't be retrieved due to list overhead quota exceed - which captures the amount of resources filtered out by - user-defined list filter. - - A resource depends on a missing type - - >- - The route's nextHopIp address is not assigned to an instance - on the network. - - The route's next hop instance cannot ip forward. - - >- - The route's nextHopInstance URL refers to an instance that - does not have an ipv6 interface on the same network as the - route. - - >- - The route's nextHopInstance URL refers to an instance that - does not exist. - - >- - The route's nextHopInstance URL refers to an instance that is - not on the same network as the route. - - >- - The route's next hop instance does not have a status of - RUNNING. - - >- - Error which is not critical. We decided to continue the - process despite the mentioned error. - - No results are present on a particular list page. - - >- - Success is reported, but some results may be missing due to - errors - - >- - The user attempted to use a resource that requires a TOS they - have not accepted. - - Warning that a resource is in use. - - >- - One or more of the resources set to auto-delete could not be - deleted because they were in use. - - When a resource schema validation is ignored. - - >- - Instance template used in instance group manager is valid as - such, but its application does not make a lot of sense, - because it allows only single instance in instance group. - - When undeclared properties in the schema are present - - A given scope cannot be reached. - enumDeprecated: - - false - - false - - false - - false - - false - - false - - true - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - enum: - - CLEANUP_FAILED - - DEPRECATED_RESOURCE_USED - - DEPRECATED_TYPE_USED - - DISK_SIZE_LARGER_THAN_IMAGE_SIZE - - EXPERIMENTAL_TYPE_USED - - EXTERNAL_API_WARNING - - FIELD_VALUE_OVERRIDEN - - INJECTED_KERNELS_DEPRECATED - - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB - - LARGE_DEPLOYMENT_WARNING - - LIST_OVERHEAD_QUOTA_EXCEED - - MISSING_TYPE_DEPENDENCY - - NEXT_HOP_ADDRESS_NOT_ASSIGNED - - NEXT_HOP_CANNOT_IP_FORWARD - - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE - - NEXT_HOP_INSTANCE_NOT_FOUND - - NEXT_HOP_INSTANCE_NOT_ON_NETWORK - - NEXT_HOP_NOT_RUNNING - - NOT_CRITICAL_ERROR - - NO_RESULTS_ON_PAGE - - PARTIAL_SUCCESS - - REQUIRED_TOS_AGREEMENT - - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - - RESOURCE_NOT_DELETED - - SCHEMA_VALIDATION_IGNORED - - SINGLE_INSTANCE_PROPERTY_TEMPLATE - - UNDECLARED_PROPERTIES - - UNREACHABLE - message: - description: '[Output Only] A human-readable description of the warning code.' - type: string - data: - description: >- - [Output Only] Metadata about this warning in key: value format. - For example: "data": [ { "key": "scope", "value": - "zones/us-east1-d" } - type: array - items: - type: object - properties: - key: - description: >- - [Output Only] A key that provides more detail on the - warning being returned. For example, for warnings where - there are no results in a list request for a particular - zone, this key might be scope and the key value might be - the zone name. Other examples might be a key indicating a - deprecated resource and a suggested replacement, or a - warning about invalid network settings (for example, if an - instance attempts to perform IP forwarding but is not - enabled for IP forwarding). - type: string - value: - description: >- - [Output Only] A warning data value corresponding to the - key. - type: string - Commitment: - id: 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. - type: object - properties: - kind: - description: >- - [Output Only] Type of the resource. Always compute#commitment for - commitments. - default: compute#commitment - type: string - id: + - GRPC + - H2C + - HTTP + - HTTP2 + - HTTPS + - SSL + - TCP + - UDP + - UNSPECIFIED + fingerprint: description: >- - [Output Only] The unique identifier for the resource. This - identifier is defined by the server. - type: string - format: uint64 - creationTimestamp: - description: '[Output Only] Creation timestamp in RFC3339 text format.' + 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. type: string - name: + format: byte + portName: 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])?' + 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 + passthrough Network Load Balancers and external passthrough Network + Load Balancers, omit port_name. type: string - description: + enableCDN: description: >- - An optional description of this resource. Provide this property when - you create the resource. - type: string - region: - description: '[Output Only] URL of the region where this commitment may be used.' - type: string - selfLink: - description: '[Output Only] Server-defined URL for the resource.' - type: string - status: + If true, enables Cloud CDN for the backend service of a global + external Application Load Balancer. + type: boolean + sessionAffinity: 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. + Type of session affinity to use. The default is NONE. Only NONE and + HEADER_FIELD are 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. For more details, see: + [Session + Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). + sessionAffinity cannot be specified with haPolicy. type: string enumDescriptions: - - '' - >- - Deprecate CANCELED status. Will use separate status to - differentiate cancel by mergeCud or manual cancellation. - - '' - - '' - - '' + 2-tuple hash on packet's source and destination IP addresses. + Connections from the same source IP address to the same + destination IP address will be served by the same backend VM while + that VM remains healthy. + - >- + 1-tuple hash only on packet's source IP address. Connections from + the same source IP address will be served by the same backend VM + while that VM remains healthy. This option can only be used for + Internal TCP/UDP Load Balancing. + - >- + 5-tuple hash on packet's source and destination IP addresses, IP + protocol, and source and destination ports. Connections for the + same IP protocol from the same source IP address and port to the + same destination IP address and port will be served by the same + backend VM while that VM remains healthy. This option cannot be + used for HTTP(S) load balancing. + - >- + 3-tuple hash on packet's source and destination IP addresses, and + IP protocol. Connections for the same IP protocol from the same + source IP address to the same destination IP address will be + served by the same backend VM while that VM remains healthy. This + option cannot be used for HTTP(S) load balancing. + - >- + Hash based on a cookie generated by the L7 loadbalancer. Only + valid for HTTP(S) load balancing. + - The hash is based on a user specified header field. + - The hash is based on a user provided cookie. + - >- + No session affinity. Connections from the same client IP may go to + any instance in the pool. + - >- + Strong cookie-based affinity. Connections bearing the same cookie + will be served by the same backend VM while that VM remains + healthy, as long as the cookie has not expired. enum: - - ACTIVE - - CANCELLED - - CREATING - - EXPIRED - - NOT_YET_ACTIVE - statusMessage: - description: '[Output Only] An optional, human-readable explanation of the status.' - type: string - plan: + - CLIENT_IP + - CLIENT_IP_NO_DESTINATION + - CLIENT_IP_PORT_PROTO + - CLIENT_IP_PROTO + - GENERATED_COOKIE + - HEADER_FIELD + - HTTP_COOKIE + - NONE + - STRONG_COOKIE_AFFINITY + affinityCookieTtlSec: 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). - type: string - enumDescriptions: - - '' - - '' - - '' - enum: - - INVALID - - THIRTY_SIX_MONTH - - TWELVE_MONTH - startTimestamp: - description: '[Output Only] Commitment start time in RFC3339 text format.' - type: string - endTimestamp: - description: '[Output Only] Commitment end time in RFC3339 text format.' + Lifetime of cookies in seconds. This setting is applicable to + Application 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 two weeks + (1,209,600). 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. + type: integer + format: int32 + 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 - resources: + failoverPolicy: description: >- - A list of commitment amounts for particular resources. Note that - VCPU and MEMORY resource commitments must occur together. - type: array - items: - $ref: '#/components/schemas/ResourceCommitment' - type: + Requires at least one backend instance group to be defined as a + backup (failover) backend. For load balancers that have configurable + failover: [Internal passthrough Network Load + Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) + and [external passthrough Network Load + Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). + failoverPolicy cannot be specified with haPolicy. + $ref: '#/components/schemas/BackendServiceFailoverPolicy' + loadBalancingScheme: 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. + 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. type: string enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' + - >- + Signifies that this will be used for classic Application Load + Balancers, global external proxy Network Load Balancers, or + external passthrough Network Load Balancers. + - >- + Signifies that this will be used for global external Application + Load Balancers, regional external Application Load Balancers, or + regional external proxy Network Load Balancers. + - >- + Signifies that this will be used for internal passthrough Network + Load Balancers. + - >- + Signifies that this will be used for internal Application Load + Balancers. + - Signifies that this will be used by Traffic Director. - '' enum: - - ACCELERATOR_OPTIMIZED - - ACCELERATOR_OPTIMIZED_A3 - - ACCELERATOR_OPTIMIZED_A3_MEGA - - COMPUTE_OPTIMIZED - - COMPUTE_OPTIMIZED_C2D - - COMPUTE_OPTIMIZED_C3 - - COMPUTE_OPTIMIZED_C3D - - COMPUTE_OPTIMIZED_H3 - - GENERAL_PURPOSE - - GENERAL_PURPOSE_C4 - - GENERAL_PURPOSE_E2 - - GENERAL_PURPOSE_N2 - - GENERAL_PURPOSE_N2D - - GENERAL_PURPOSE_N4 - - GENERAL_PURPOSE_T2D - - GRAPHICS_OPTIMIZED - - MEMORY_OPTIMIZED - - MEMORY_OPTIMIZED_M3 - - STORAGE_OPTIMIZED_Z3 - - TYPE_UNSPECIFIED - reservations: - description: List of create-on-create reservations for this commitment. - type: array - items: - $ref: '#/components/schemas/Reservation' - category: + - EXTERNAL + - EXTERNAL_MANAGED + - INTERNAL + - INTERNAL_MANAGED + - INTERNAL_SELF_MANAGED + - INVALID_LOAD_BALANCING_SCHEME + connectionDraining: + description: connectionDraining cannot be specified with haPolicy. + $ref: '#/components/schemas/ConnectionDraining' + iap: 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. - type: string - enumDescriptions: - - '' - - '' - - '' - enum: - - CATEGORY_UNSPECIFIED - - LICENSE - - MACHINE - licenseResource: - description: The license specification required as part of a license commitment. - $ref: '#/components/schemas/LicenseResourceCommitment' - autoRenew: + The configurations for Identity-Aware Proxy on this resource. Not + available for internal passthrough Network Load Balancers and + external passthrough Network Load Balancers. + $ref: '#/components/schemas/BackendServiceIAP' + cdnPolicy: description: >- - Specifies whether to enable automatic renewal for the commitment. - The default value is false if not specified. The field can be - updated until the day of the commitment expiration at 12:00am PST. - If the field is set to true, the commitment will be automatically - renewed for either one or three years according to the terms of the - existing commitment. - type: boolean - mergeSourceCommitments: - description: List of source commitments to be merged into a new commitment. + Cloud CDN configuration for this BackendService. Only available for + specified load balancer types. + $ref: '#/components/schemas/BackendServiceCdnPolicy' + customRequestHeaders: + description: >- + Headers that the load balancer adds to proxied requests. See + [Creating custom + headers](https://cloud.google.com/load-balancing/docs/custom-headers). type: array items: type: string - splitSourceCommitment: - description: Source commitment to be split into a new commitment. - type: string - resourceStatus: - description: '[Output Only] Status information for Commitment resource.' - $ref: '#/components/schemas/CommitmentResourceStatus' - existingReservations: + customResponseHeaders: description: >- - Specifies the already existing reservations to attach to the - Commitment. This field is optional, and it can be a full or partial - URL. For example, the following are valid URLs to an reservation: - - https://www.googleapis.com/compute/v1/projects/project/zones/zone - /reservations/reservation - - projects/project/zones/zone/reservations/reservation + Headers that the load balancer adds to proxied responses. See + [Creating custom + headers](https://cloud.google.com/load-balancing/docs/custom-headers). type: array items: type: string - customEndTimestamp: + securityPolicy: description: >- - [Input Only] Optional, specifies the CUD end time requested by the - customer in RFC3339 text format. Needed when the customer wants - CUD's end date is later than the start date + term duration. + [Output Only] The resource URL for the security policy associated + with this backend service. type: string - ResourceCommitment: - id: ResourceCommitment - description: >- - Commitment for a particular resource (a Commitment is composed of one or - more of these). - type: object - properties: - type: + edgeSecurityPolicy: description: >- - Type of resource for which this commitment applies. Possible values - are VCPU, MEMORY, LOCAL_SSD, and ACCELERATOR. + [Output Only] The resource URL for the edge security policy + associated with this backend service. type: string - enumDescriptions: - - '' - - '' + logConfig: + 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. + $ref: '#/components/schemas/BackendServiceLogConfig' + securitySettings: + description: >- + This field specifies the security settings that apply to this + backend service. This field is applicable to a global backend + service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. + $ref: '#/components/schemas/SecuritySettings' + 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 Maglev: A Fast and Reliable Software + Network Load Balancer. - WEIGHTED_ROUND_ROBIN: Per-endpoint Weighted + Round Robin Load Balancing using weights computed from Backend + reported Custom Metrics. If set, the Backend Service responses are + expected to contain non-standard HTTP response header field + Endpoint-Load-Metrics. The reported metrics to use for computing the + weights are specified via the customMetrics field. This field is + applicable to either: - A regional backend service with the + service_protocol set to HTTP, HTTPS, HTTP2 or H2C, and + load_balancing_scheme set to INTERNAL_MANAGED. - A global backend + service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, + INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not + configured—that is, if session affinity remains at the default value + of NONE—then the default value for localityLbPolicy is ROUND_ROBIN. + If session affinity is set to a value other than NONE, then the + default value for localityLbPolicy is MAGLEV. Only ROUND_ROBIN and + RING_HASH are 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. localityLbPolicy cannot be + specified with haPolicy. + type: string + enumDescriptions: + - '' + - >- + An O(1) algorithm which selects two random healthy hosts and picks + the host which has fewer active requests. + - >- + This algorithm implements consistent hashing to backends. Maglev + can be 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 Maglev: A Fast and Reliable Software + Network Load Balancer. + - >- + 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. + - The load balancer selects a random healthy host. + - >- + 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. + - >- + This is a simple policy in which each healthy backend is selected + in round robin order. This is the default. + - >- + Per-instance weighted Load Balancing via health check reported + weights. In internal passthrough network load balancing, it is + weighted rendezvous hashing. This option is only supported in + internal passthrough network load balancing. + - >- + Per-instance weighted Load Balancing via health check reported + weights. If set, the Backend Service must configure a non legacy + HTTP-based Health Check, and health check replies are expected to + contain non-standard HTTP response header field + X-Load-Balancing-Endpoint-Weight to specify the per-instance + weights. If set, Load Balancing is weighted based on the + per-instance weights reported in the last processed health check + replies, as long as every instance either reported a valid weight + or had UNAVAILABLE_WEIGHT. Otherwise, Load Balancing remains + equal-weight. This option is only supported in Network Load + Balancing. + - >- + Per-endpoint weighted round-robin Load Balancing using weights + computed from Backend reported Custom Metrics. If set, the Backend + Service responses are expected to contain non-standard HTTP + response header field Endpoint-Load-Metrics. The reported metrics + to use for computing the weights are specified via the + customMetrics fields. + enum: + - INVALID_LB_POLICY + - LEAST_REQUEST + - MAGLEV + - ORIGINAL_DESTINATION + - RANDOM + - RING_HASH + - ROUND_ROBIN + - WEIGHTED_GCP_RENDEZVOUS + - WEIGHTED_MAGLEV + - WEIGHTED_ROUND_ROBIN + consistentHash: + 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, HTTP2 or H2C, + and load_balancing_scheme set to INTERNAL_MANAGED. - A global + backend service with the load_balancing_scheme set to + INTERNAL_SELF_MANAGED. + $ref: '#/components/schemas/ConsistentHashLoadBalancerSettings' + circuitBreakers: + $ref: '#/components/schemas/CircuitBreakers' + outlierDetection: + description: >- + Settings controlling the ejection of unhealthy backend endpoints + from the load balancing pool of each individual proxy instance that + processes the traffic for the given backend service. If not set, + this feature is considered disabled. Results of the outlier + detection algorithm (ejection of endpoints from the load balancing + pool and returning them back to the pool) are executed independently + by each proxy instance of the load balancer. In most cases, more + than one proxy instance handles the traffic received by a backend + service. Thus, it is possible that an unhealthy endpoint is detected + and ejected by only some of the proxies, and while this happens, + other proxies may continue to send requests to the same unhealthy + endpoint until they detect and eject the unhealthy endpoint. + Applicable backend endpoints can be: - VM instances in an Instance + Group - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT) - + Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT) - + Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud + Functions Services - Private Service Connect NEGs, that resolve to + Google-managed regional API endpoints or managed services published + using Private Service Connect Applicable backend service types can + be: - A global backend service with the loadBalancingScheme set to + INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. - A regional backend + service with the serviceProtocol set to HTTP, HTTPS, HTTP2 or H2C, + and loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. + Not supported for Serverless NEGs. Not supported when the backend + service is referenced by a URL map that is bound to target gRPC + proxy that has validateForProxyless field set to true. + $ref: '#/components/schemas/OutlierDetection' + network: + description: >- + The URL of the network to which this backend service belongs. This + field must be set for Internal Passthrough Network Load Balancers + when the haPolicy is enabled, and for External Passthrough Network + Load Balancers when the haPolicy fastIpMove is enabled. This field + can only be specified when the load balancing scheme is set to + INTERNAL, or when the load balancing scheme is set to EXTERNAL and + haPolicy fastIpMove is enabled. + type: string + subsetting: + description: subsetting cannot be specified with haPolicy. + $ref: '#/components/schemas/Subsetting' + connectionTrackingPolicy: + description: >- + Connection Tracking configuration for this BackendService. + Connection tracking policy settings are only available for external + passthrough Network Load Balancers and internal passthrough Network + Load Balancers. connectionTrackingPolicy cannot be specified with + haPolicy. + $ref: '#/components/schemas/BackendServiceConnectionTrackingPolicy' + maxStreamDuration: + 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. + $ref: '#/components/schemas/Duration' + compressionMode: + description: >- + Compress text responses using Brotli or gzip compression, based on + the client's Accept-Encoding header. + type: string + enumDescriptions: + - >- + Automatically uses the best compression based on the + Accept-Encoding header sent by the client. + - >- + Disables compression. Existing compressed responses cached by + Cloud CDN will not be served to clients. + enum: + - AUTOMATIC + - DISABLED + serviceLbPolicy: + description: >- + URL to networkservices.ServiceLbPolicy resource. Can only be set if + load balancing scheme is EXTERNAL_MANAGED, INTERNAL_MANAGED or + INTERNAL_SELF_MANAGED and the scope is global. + type: string + serviceBindings: + description: >- + URLs of networkservices.ServiceBinding resources. Can only be set if + load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of + backends and health checks must be both empty. + type: array + items: + type: string + localityLbPolicies: + description: >- + A list of locality load-balancing policies to be used in order of + preference. When you use localityLbPolicies, you must set at least + one value for either the localityLbPolicies[].policy or the + localityLbPolicies[].customPolicy field. localityLbPolicies + overrides any value set in the localityLbPolicy field. For an + example of how to use this field, see Define a list of preferred + policies. Caution: This field and its children are intended for use + in a service mesh that includes gRPC clients only. Envoy proxies + can't use backend services that have this configuration. + type: array + items: + $ref: >- + #/components/schemas/BackendServiceLocalityLoadBalancingPolicyConfig + externalManagedMigrationState: + description: >- + Specifies the canary migration state. Possible values are PREPARE, + TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration + from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to + PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the + loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, + the TEST_BY_PERCENTAGE state can be used to migrate traffic by + percentage using externalManagedMigrationTestingPercentage. Rolling + back a migration requires the states to be set in reverse order. So + changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the + state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, + the TEST_BY_PERCENTAGE state can be used to migrate some traffic + back to EXTERNAL or PREPARE can be used to migrate all traffic back + to EXTERNAL. + type: string + enumDescriptions: - '' - '' - '' enum: - - ACCELERATOR - - LOCAL_SSD - - MEMORY - - UNSPECIFIED - - VCPU - amount: + - PREPARE + - TEST_ALL_TRAFFIC + - TEST_BY_PERCENTAGE + externalManagedMigrationTestingPercentage: + description: >- + Determines the fraction of requests that should be processed by the + Global external Application Load Balancer. The value of this field + must be in the range [0, 100]. Session affinity options will + slightly affect this routing behavior, for more details, see: + Session Affinity. This value can only be set if the + loadBalancingScheme in the BackendService is set to EXTERNAL (when + using the classic Application Load Balancer) and the migration state + is TEST_BY_PERCENTAGE. + type: number + format: float + ipAddressSelectionPolicy: 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. + Specifies a preference for traffic sent from the proxy to the + backend (or from the client to the backend for proxyless gRPC). The + possible values are: - IPV4_ONLY: Only send IPv4 traffic to the + backends of the backend service (Instance Group, Managed Instance + Group, Network Endpoint Group), regardless of traffic from the + client to the proxy. Only IPv4 health checks are used to check the + health of the backends. This is the default setting. - PREFER_IPV6: + Prioritize the connection to the endpoint's IPv6 address over its + IPv4 address (provided there is a healthy IPv6 address). - + IPV6_ONLY: Only send IPv6 traffic to the backends of the backend + service (Instance Group, Managed Instance Group, Network Endpoint + Group), regardless of traffic from the client to the proxy. Only + IPv6 health checks are used to check the health of the backends. + This field is applicable to either: - Advanced global external + Application Load Balancer (load balancing scheme EXTERNAL_MANAGED), + - Regional external Application Load Balancer, - Internal proxy + Network Load Balancer (load balancing scheme INTERNAL_MANAGED), - + Regional internal Application Load Balancer (load balancing scheme + INTERNAL_MANAGED), - Traffic Director with Envoy proxies and + proxyless gRPC (load balancing scheme INTERNAL_SELF_MANAGED). type: string - format: int64 - acceleratorType: + enumDescriptions: + - >- + Only send IPv4 traffic to the backends of the Backend Service + (Instance Group, Managed Instance Group, Network Endpoint Group) + regardless of traffic from the client to the proxy. Only IPv4 + health-checks are used to check the health of the backends. This + is the default setting. + - >- + Only send IPv6 traffic to the backends of the Backend Service + (Instance Group, Managed Instance Group, Network Endpoint Group) + regardless of traffic from the client to the proxy. Only IPv6 + health-checks are used to check the health of the backends. + - Unspecified IP address selection policy. + - >- + Prioritize the connection to the endpoints IPv6 address over its + IPv4 address (provided there is a healthy IPv6 address). + enum: + - IPV4_ONLY + - IPV6_ONLY + - IP_ADDRESS_SELECTION_POLICY_UNSPECIFIED + - PREFER_IPV6 + metadatas: description: >- - Name of the accelerator type resource. Applicable only when the type - is ACCELERATOR. - type: string - LicenseResourceCommitment: - id: LicenseResourceCommitment - description: Commitment for a particular license resource. + Deployment metadata associated with the resource to be set by a GKE + hub controller and read by the backend RCTH + type: object + additionalProperties: + type: string + haPolicy: + description: >- + Configures self-managed High Availability (HA) for External and + Internal Protocol Forwarding. The backends of this regional backend + service must only specify zonal network endpoint groups (NEGs) of + type GCE_VM_IP. When haPolicy is set for an Internal Passthrough + Network Load Balancer, the regional backend service must set the + network field. All zonal NEGs must belong to the same network. + However, individual NEGs can belong to different subnetworks of that + network. When haPolicy is specified, the set of attached network + endpoints across all backends comprise an High Availability domain + from which one endpoint is selected as the active endpoint (the + leader) that receives all traffic. haPolicy can be added only at + backend service creation time. Once set up, it cannot be deleted. + Note that haPolicy is not for load balancing, and therefore cannot + be specified with sessionAffinity, connectionTrackingPolicy, and + failoverPolicy. haPolicy requires customers to be responsible for + tracking backend endpoint health and electing a leader among the + healthy endpoints. Therefore, haPolicy cannot be specified with + healthChecks. haPolicy can only be specified for External + Passthrough Network Load Balancers and Internal Passthrough Network + Load Balancers. + $ref: '#/components/schemas/BackendServiceHAPolicy' + usedBy: + description: '[Output Only] List of resources referencing given backend service.' + type: array + items: + $ref: '#/components/schemas/BackendServiceUsedBy' + strongSessionAffinityCookie: + description: >- + Describes the HTTP cookie used for stateful session affinity. This + field is applicable and required if the sessionAffinity is set to + STRONG_COOKIE_AFFINITY. + $ref: '#/components/schemas/BackendServiceHttpCookie' + tlsSettings: + description: >- + Configuration for Backend Authenticated TLS and mTLS. May only be + specified when the backend protocol is SSL, HTTPS or HTTP2. + $ref: '#/components/schemas/BackendServiceTlsSettings' + customMetrics: + description: >- + List of custom metrics that are used for the WEIGHTED_ROUND_ROBIN + locality_lb_policy. + type: array + items: + $ref: '#/components/schemas/BackendServiceCustomMetric' + params: + description: >- + Input only. [Input Only] Additional params passed with the request, + but not persisted as part of resource payload. + $ref: '#/components/schemas/BackendServiceParams' + Backend: + id: Backend + description: Message containing information of one individual backend. type: object properties: - license: - description: Any applicable license URI. + description: + description: >- + An optional description of this resource. Provide this property when + you create the resource. type: string - amount: - description: The number of licenses purchased. + 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. If haPolicy is specified, backends + must refer to NEG resources of type GCE_VM_IP. type: string - format: int64 - coresPerLicense: + balancingMode: description: >- - Specifies the core range of the instance for which this license - applies. + 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. type: string - CommitmentResourceStatus: - id: CommitmentResourceStatus - description: '[Output Only] Contains output only fields.' + enumDescriptions: + - Balance based on the number of simultaneous connections. + - Based on custom defined and reported metrics. + - Balance based on requests per second (RPS). + - Balance based on the backend utilization. + enum: + - CONNECTION + - CUSTOM_METRICS + - RATE + - UTILIZATION + maxUtilization: + description: >- + Optional parameter to define a target capacity for the UTILIZATION + balancing mode. The valid range is [0.0, 1.0]. For usage guidelines, + see Utilization balancing mode. + type: number + format: float + 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. + type: integer + format: int32 + 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. + type: number + format: float + 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. + type: number + format: float + 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. + type: integer + format: int32 + 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. + type: integer + format: int32 + 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. + type: integer + format: int32 + 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. Not available with backends that + don't support using a balancingMode. This includes backends such as + global internet NEGs, regional serverless NEGs, and PSC NEGs. + type: number + format: float + 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 + preference: + description: >- + This field indicates whether this backend should be fully utilized + before sending traffic to backends with default preference. The + possible values are: - PREFERRED: Backends with this preference + level will be filled up to their capacity limits first, based on + RTT. - DEFAULT: If preferred backends don't have enough capacity, + backends in this layer would be used and traffic would be assigned + based on the load balancing algorithm you use. This is the default + type: string + enumDescriptions: + - No preference. + - If preference is unspecified, we set it to the DEFAULT value + - Traffic will be sent to this backend first. + enum: + - DEFAULT + - PREFERENCE_UNSPECIFIED + - PREFERRED + customMetrics: + description: >- + List of custom metrics that are used for CUSTOM_METRICS + BalancingMode. + type: array + items: + $ref: '#/components/schemas/BackendCustomMetric' + BackendCustomMetric: + id: BackendCustomMetric + description: Custom Metrics are used for CUSTOM_METRICS balancing_mode. type: object properties: - customTermEligibilityEndTimestamp: + name: description: >- - [Output Only] Indicates the end time of customer's eligibility to - send custom term requests in RFC3339 text format. Term extension - requests that (not the end time in the request) after this time will - be rejected. + Name of a custom utilization signal. The name must be 1-64 + characters long and match the regular expression + [a-z]([-_.a-z0-9]*[a-z0-9])? which means that the first character + must be a lowercase letter, and all following characters must be a + dash, period, underscore, lowercase letter, or digit, except the + last character, which cannot be a dash, period, or underscore. For + usage guidelines, see Custom Metrics balancing mode. This field can + only be used for a global or regional backend service with the + loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED + INTERNAL_SELF_MANAGED. type: string - CommitmentAggregatedList: - id: CommitmentAggregatedList + maxUtilization: + description: >- + Optional parameter to define a target utilization for the Custom + Metrics balancing mode. The valid range is [0.0, 1.0]. + type: number + format: float + dryRun: + description: >- + If true, the metric data is collected and reported to Cloud + Monitoring, but is not used for load balancing. + type: boolean + BackendServiceFailoverPolicy: + id: BackendServiceFailoverPolicy + description: >- + For load balancers that have configurable failover: [Internal + passthrough Network Load + Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) + and [external passthrough Network Load + Balancers](https://cloud.google.com/load-balancing/docs/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). type: object properties: - kind: + disableConnectionDrainOnFailover: description: >- - [Output Only] Type of resource. Always - compute#commitmentAggregatedList for aggregated lists of - commitments. - default: compute#commitmentAggregatedList + 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 passthrough Network Load + Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) + and [external passthrough Network Load + Balancers](https://cloud.google.com/load-balancing/docs/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](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). + type: number + format: float + ConnectionDraining: + id: ConnectionDraining + description: Message containing connection draining configuration. + type: object + 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. + type: integer + format: int32 + BackendServiceIAP: + id: BackendServiceIAP + description: Identity-Aware Proxy + type: object + properties: + enabled: + description: >- + Whether the serving infrastructure will authenticate and authorize + all incoming requests. + type: boolean + oauth2ClientId: + description: OAuth2 client ID to use for the authentication flow. type: string - id: + oauth2ClientSecret: description: >- - [Output Only] Unique identifier for the resource; defined by the - server. + 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 - items: - description: A list of CommitmentsScopedList resources. - type: object - additionalProperties: - description: >- - [Output Only] Name of the scope containing this set of - commitments. - $ref: '#/components/schemas/CommitmentsScopedList' - nextPageToken: + oauth2ClientSecretSha256: description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. - type: string - selfLink: - description: '[Output Only] Server-defined URL for this resource.' + [Output Only] SHA256 hash value for the field oauth2_client_secret + above. type: string - warning: - description: '[Output Only] Informational warning message.' - type: object - properties: - code: - description: >- - [Output Only] A warning code, if applicable. For example, - Compute Engine returns NO_RESULTS_ON_PAGE if there are no - results in the response. - type: string - enumDescriptions: - - >- - Warning about failed cleanup of transient changes made by a - failed operation. - - A link to a deprecated resource was created. - - >- - When deploying and at least one of the resources has a type - marked as deprecated - - The user created a boot disk that is larger than image size. - - >- - When deploying and at least one of the resources has a type - marked as experimental - - Warning that is present in an external api call - - >- - Warning that value of a field has been overridden. Deprecated - unused field. - - >- - The operation involved use of an injected kernel, which is - deprecated. - - >- - A WEIGHTED_MAGLEV backend service is associated with a health - check that is not of type HTTP/HTTPS/HTTP2. - - >- - When deploying a deployment with a exceedingly large number of - resources - - >- - Resource can't be retrieved due to list overhead quota exceed - which captures the amount of resources filtered out by - user-defined list filter. - - A resource depends on a missing type - - >- - The route's nextHopIp address is not assigned to an instance - on the network. - - The route's next hop instance cannot ip forward. - - >- - The route's nextHopInstance URL refers to an instance that - does not have an ipv6 interface on the same network as the - route. - - >- - The route's nextHopInstance URL refers to an instance that - does not exist. - - >- - The route's nextHopInstance URL refers to an instance that is - not on the same network as the route. - - >- - The route's next hop instance does not have a status of - RUNNING. - - >- - Error which is not critical. We decided to continue the - process despite the mentioned error. - - No results are present on a particular list page. - - >- - Success is reported, but some results may be missing due to - errors - - >- - The user attempted to use a resource that requires a TOS they - have not accepted. - - Warning that a resource is in use. - - >- - One or more of the resources set to auto-delete could not be - deleted because they were in use. - - When a resource schema validation is ignored. - - >- - Instance template used in instance group manager is valid as - such, but its application does not make a lot of sense, - because it allows only single instance in instance group. - - When undeclared properties in the schema are present - - A given scope cannot be reached. - enumDeprecated: - - false - - false - - false - - false - - false - - false - - true - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - enum: - - CLEANUP_FAILED - - DEPRECATED_RESOURCE_USED - - DEPRECATED_TYPE_USED - - DISK_SIZE_LARGER_THAN_IMAGE_SIZE - - EXPERIMENTAL_TYPE_USED - - EXTERNAL_API_WARNING - - FIELD_VALUE_OVERRIDEN - - INJECTED_KERNELS_DEPRECATED - - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB - - LARGE_DEPLOYMENT_WARNING - - LIST_OVERHEAD_QUOTA_EXCEED - - MISSING_TYPE_DEPENDENCY - - NEXT_HOP_ADDRESS_NOT_ASSIGNED - - NEXT_HOP_CANNOT_IP_FORWARD - - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE - - NEXT_HOP_INSTANCE_NOT_FOUND - - NEXT_HOP_INSTANCE_NOT_ON_NETWORK - - NEXT_HOP_NOT_RUNNING - - NOT_CRITICAL_ERROR - - NO_RESULTS_ON_PAGE - - PARTIAL_SUCCESS - - REQUIRED_TOS_AGREEMENT - - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - - RESOURCE_NOT_DELETED - - SCHEMA_VALIDATION_IGNORED - - SINGLE_INSTANCE_PROPERTY_TEMPLATE - - UNDECLARED_PROPERTIES - - UNREACHABLE - message: - description: '[Output Only] A human-readable description of the warning code.' - type: string - data: - description: >- - [Output Only] Metadata about this warning in key: value format. - For example: "data": [ { "key": "scope", "value": - "zones/us-east1-d" } - type: array - items: - type: object - properties: - key: - description: >- - [Output Only] A key that provides more detail on the - warning being returned. For example, for warnings where - there are no results in a list request for a particular - zone, this key might be scope and the key value might be - the zone name. Other examples might be a key indicating a - deprecated resource and a suggested replacement, or a - warning about invalid network settings (for example, if an - instance attempts to perform IP forwarding but is not - enabled for IP forwarding). - type: string - value: - description: >- - [Output Only] A warning data value corresponding to the - key. - type: string - unreachables: - description: '[Output Only] Unreachable resources.' - type: array - items: - type: string - CommitmentsScopedList: - id: CommitmentsScopedList + BackendServiceCdnPolicy: + id: BackendServiceCdnPolicy + description: Message containing Cloud CDN configuration for a backend service. type: object properties: - commitments: - description: '[Output Only] A list of commitments contained in this scope.' + cacheKeyPolicy: + description: The CacheKeyPolicy for this CdnPolicy. + $ref: '#/components/schemas/CacheKeyPolicy' + signedUrlKeyNames: + description: '[Output Only] Names of the keys for signing request URLs.' type: array items: - $ref: '#/components/schemas/Commitment' - warning: - description: >- - [Output Only] Informational warning which replaces the list of - commitments when the list is empty. - type: object - properties: - code: - description: >- - [Output Only] A warning code, if applicable. For example, - Compute Engine returns NO_RESULTS_ON_PAGE if there are no - results in the response. - type: string - enumDescriptions: - - >- - Warning about failed cleanup of transient changes made by a - failed operation. - - A link to a deprecated resource was created. - - >- - When deploying and at least one of the resources has a type - marked as deprecated - - The user created a boot disk that is larger than image size. - - >- - When deploying and at least one of the resources has a type - marked as experimental - - Warning that is present in an external api call - - >- - Warning that value of a field has been overridden. Deprecated - unused field. - - >- - The operation involved use of an injected kernel, which is - deprecated. - - >- - A WEIGHTED_MAGLEV backend service is associated with a health - check that is not of type HTTP/HTTPS/HTTP2. - - >- - When deploying a deployment with a exceedingly large number of - resources - - >- - Resource can't be retrieved due to list overhead quota exceed - which captures the amount of resources filtered out by - user-defined list filter. - - A resource depends on a missing type - - >- - The route's nextHopIp address is not assigned to an instance - on the network. - - The route's next hop instance cannot ip forward. - - >- - The route's nextHopInstance URL refers to an instance that - does not have an ipv6 interface on the same network as the - route. - - >- - The route's nextHopInstance URL refers to an instance that - does not exist. - - >- - The route's nextHopInstance URL refers to an instance that is - not on the same network as the route. - - >- - The route's next hop instance does not have a status of - RUNNING. - - >- - Error which is not critical. We decided to continue the - process despite the mentioned error. - - No results are present on a particular list page. - - >- - Success is reported, but some results may be missing due to - errors - - >- - The user attempted to use a resource that requires a TOS they - have not accepted. - - Warning that a resource is in use. - - >- - One or more of the resources set to auto-delete could not be - deleted because they were in use. - - When a resource schema validation is ignored. - - >- - Instance template used in instance group manager is valid as - such, but its application does not make a lot of sense, - because it allows only single instance in instance group. - - When undeclared properties in the schema are present - - A given scope cannot be reached. - enumDeprecated: - - false - - false - - false - - false - - false - - false - - true - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - enum: - - CLEANUP_FAILED - - DEPRECATED_RESOURCE_USED - - DEPRECATED_TYPE_USED - - DISK_SIZE_LARGER_THAN_IMAGE_SIZE - - EXPERIMENTAL_TYPE_USED - - EXTERNAL_API_WARNING - - FIELD_VALUE_OVERRIDEN - - INJECTED_KERNELS_DEPRECATED - - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB - - LARGE_DEPLOYMENT_WARNING - - LIST_OVERHEAD_QUOTA_EXCEED - - MISSING_TYPE_DEPENDENCY - - NEXT_HOP_ADDRESS_NOT_ASSIGNED - - NEXT_HOP_CANNOT_IP_FORWARD - - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE - - NEXT_HOP_INSTANCE_NOT_FOUND - - NEXT_HOP_INSTANCE_NOT_ON_NETWORK - - NEXT_HOP_NOT_RUNNING - - NOT_CRITICAL_ERROR - - NO_RESULTS_ON_PAGE - - PARTIAL_SUCCESS - - REQUIRED_TOS_AGREEMENT - - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - - RESOURCE_NOT_DELETED - - SCHEMA_VALIDATION_IGNORED - - SINGLE_INSTANCE_PROPERTY_TEMPLATE - - UNDECLARED_PROPERTIES - - UNREACHABLE - message: - description: '[Output Only] A human-readable description of the warning code.' - type: string - data: - description: >- - [Output Only] Metadata about this warning in key: value format. - For example: "data": [ { "key": "scope", "value": - "zones/us-east1-d" } - type: array - items: - type: object - properties: - key: - description: >- - [Output Only] A key that provides more detail on the - warning being returned. For example, for warnings where - there are no results in a list request for a particular - zone, this key might be scope and the key value might be - the zone name. Other examples might be a key indicating a - deprecated resource and a suggested replacement, or a - warning about invalid network settings (for example, if an - instance attempts to perform IP forwarding but is not - enabled for IP forwarding). - type: string - value: - description: >- - [Output Only] A warning data value corresponding to the - key. - type: string - DiskTypeList: - id: DiskTypeList - description: Contains a list of disk types. - type: object - properties: - kind: + type: string + signedUrlCacheMaxAgeSec: description: >- - [Output Only] Type of resource. Always compute#diskTypeList for disk - types. - default: compute#diskTypeList + 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. type: string - id: + format: int64 + requestCoalescing: description: >- - [Output Only] Unique identifier for the resource; defined by the - server. + If true then Cloud CDN will combine multiple concurrent cache fill + requests into a small number of requests to the origin. + type: boolean + 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. If no value is provided for + cdnPolicy.cacheMode, it defaults to CACHE_ALL_STATIC. type: string - items: - description: A list of DiskType resources. + enumDescriptions: + - >- + 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. + - >- + 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. + - '' + - >- + 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. + enum: + - CACHE_ALL_STATIC + - FORCE_CACHE_ALL + - INVALID_CACHE_MODE + - USE_ORIGIN_HEADERS + 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-maxage). 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. + type: integer + format: int32 + 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. + type: integer + format: int32 + 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). + type: integer + format: int32 + 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. type: array items: - $ref: '#/components/schemas/DiskType' - nextPageToken: + $ref: '#/components/schemas/BackendServiceCdnPolicyNegativeCachingPolicy' + bypassCacheOnRequestHeaders: description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. - type: string - selfLink: - description: '[Output Only] Server-defined URL for this resource.' - type: string - warning: - description: '[Output Only] Informational warning message.' - type: object - properties: - code: - description: >- - [Output Only] A warning code, if applicable. For example, - Compute Engine returns NO_RESULTS_ON_PAGE if there are no - results in the response. - type: string - enumDescriptions: - - >- - Warning about failed cleanup of transient changes made by a - failed operation. - - A link to a deprecated resource was created. - - >- - When deploying and at least one of the resources has a type - marked as deprecated - - The user created a boot disk that is larger than image size. - - >- - When deploying and at least one of the resources has a type - marked as experimental - - Warning that is present in an external api call - - >- - Warning that value of a field has been overridden. Deprecated - unused field. - - >- - The operation involved use of an injected kernel, which is - deprecated. - - >- - A WEIGHTED_MAGLEV backend service is associated with a health - check that is not of type HTTP/HTTPS/HTTP2. - - >- - When deploying a deployment with a exceedingly large number of - resources - - >- - Resource can't be retrieved due to list overhead quota exceed - which captures the amount of resources filtered out by - user-defined list filter. - - A resource depends on a missing type - - >- - The route's nextHopIp address is not assigned to an instance - on the network. - - The route's next hop instance cannot ip forward. - - >- - The route's nextHopInstance URL refers to an instance that - does not have an ipv6 interface on the same network as the - route. - - >- - The route's nextHopInstance URL refers to an instance that - does not exist. - - >- - The route's nextHopInstance URL refers to an instance that is - not on the same network as the route. - - >- - The route's next hop instance does not have a status of - RUNNING. - - >- - Error which is not critical. We decided to continue the - process despite the mentioned error. - - No results are present on a particular list page. - - >- - Success is reported, but some results may be missing due to - errors - - >- - The user attempted to use a resource that requires a TOS they - have not accepted. - - Warning that a resource is in use. - - >- - One or more of the resources set to auto-delete could not be - deleted because they were in use. - - When a resource schema validation is ignored. - - >- - Instance template used in instance group manager is valid as - such, but its application does not make a lot of sense, - because it allows only single instance in instance group. - - When undeclared properties in the schema are present - - A given scope cannot be reached. - enumDeprecated: - - false - - false - - false - - false - - false - - false - - true - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - enum: - - CLEANUP_FAILED - - DEPRECATED_RESOURCE_USED - - DEPRECATED_TYPE_USED - - DISK_SIZE_LARGER_THAN_IMAGE_SIZE - - EXPERIMENTAL_TYPE_USED - - EXTERNAL_API_WARNING - - FIELD_VALUE_OVERRIDEN - - INJECTED_KERNELS_DEPRECATED - - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB - - LARGE_DEPLOYMENT_WARNING - - LIST_OVERHEAD_QUOTA_EXCEED - - MISSING_TYPE_DEPENDENCY - - NEXT_HOP_ADDRESS_NOT_ASSIGNED - - NEXT_HOP_CANNOT_IP_FORWARD - - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE - - NEXT_HOP_INSTANCE_NOT_FOUND - - NEXT_HOP_INSTANCE_NOT_ON_NETWORK - - NEXT_HOP_NOT_RUNNING - - NOT_CRITICAL_ERROR - - NO_RESULTS_ON_PAGE - - PARTIAL_SUCCESS - - REQUIRED_TOS_AGREEMENT - - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - - RESOURCE_NOT_DELETED - - SCHEMA_VALIDATION_IGNORED - - SINGLE_INSTANCE_PROPERTY_TEMPLATE - - UNDECLARED_PROPERTIES - - UNREACHABLE - message: - description: '[Output Only] A human-readable description of the warning code.' - type: string - data: - description: >- - [Output Only] Metadata about this warning in key: value format. - For example: "data": [ { "key": "scope", "value": - "zones/us-east1-d" } - type: array - items: - type: object - properties: - key: - description: >- - [Output Only] A key that provides more detail on the - warning being returned. For example, for warnings where - there are no results in a list request for a particular - zone, this key might be scope and the key value might be - the zone name. Other examples might be a key indicating a - deprecated resource and a suggested replacement, or a - warning about invalid network settings (for example, if an - instance attempts to perform IP forwarding but is not - enabled for IP forwarding). - type: string - value: - description: >- - [Output Only] A warning data value corresponding to the - key. - type: string - DiskType: - id: DiskType + 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. + type: array + items: + $ref: >- + #/components/schemas/BackendServiceCdnPolicyBypassCacheOnRequestHeader + 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-maxage) of a cached response. + The maximum allowed value is 604800 (1 week). Set this to zero (0) + to disable serve-while-stale. + type: integer + format: int32 + CacheKeyPolicy: + id: CacheKeyPolicy 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. + Message containing what to include in the cache key for a request for + Cloud CDN. type: object properties: - kind: + includeProtocol: + description: If true, http and https requests will be cached separately. + type: boolean + includeHost: + description: If true, requests to different hosts will be cached separately. + type: boolean + includeQueryString: description: >- - [Output Only] Type of the resource. Always compute#diskType for disk - types. - default: compute#diskType - type: string - id: + 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 + queryStringWhitelist: description: >- - [Output Only] The unique identifier for the resource. This - identifier is defined by the server. - type: string - format: uint64 - creationTimestamp: - description: '[Output Only] Creation timestamp in RFC3339 text format.' - type: string - name: - description: '[Output Only] Name of the resource.' - pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + 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. + type: array + items: + type: string + 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. + type: array + items: + type: string + includeHttpHeaders: + description: Allows HTTP request headers (by name) to be used in the cache key. + type: array + items: + type: string + includeNamedCookies: + description: >- + Allows HTTP cookies (by name) to be used in the cache key. The + name=value pair will be used in the cache key Cloud CDN generates. + type: array + items: + type: string + BackendServiceCdnPolicyNegativeCachingPolicy: + id: BackendServiceCdnPolicyNegativeCachingPolicy + description: Specify CDN TTLs for response error codes. + type: object + 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. + type: integer + format: int32 + 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. + type: integer + format: int32 + BackendServiceCdnPolicyBypassCacheOnRequestHeader: + id: 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. + type: object + properties: + headerName: + description: >- + The header field name to match on when bypassing cache. Values are + case-insensitive. type: string - description: - description: '[Output Only] An optional description of this resource.' + BackendServiceLogConfig: + id: BackendServiceLogConfig + description: >- + The available logging options for the load balancer traffic served by + this backend service. + type: object + properties: + enable: + description: >- + Denotes whether to enable logging for the load balancer traffic + served by this backend service. The default value is false. + 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. + type: number + format: float + optionalMode: + description: >- + This field can only be specified if logging is enabled for this + backend service. Configures whether all, none or a subset of + optional fields should be added to the reported logs. One of + [INCLUDE_ALL_OPTIONAL, EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is + EXCLUDE_ALL_OPTIONAL. type: string - validDiskSize: + enumDescriptions: + - A subset of optional fields. + - None optional fields. + - All optional fields. + enum: + - CUSTOM + - EXCLUDE_ALL_OPTIONAL + - INCLUDE_ALL_OPTIONAL + optionalFields: description: >- - [Output Only] An optional textual description of the valid disk - size, such as "10GB-10TB". + This field can only be specified if logging is enabled for this + backend service and "logConfig.optionalMode" was set to CUSTOM. + Contains a list of optional fields you want to include in the logs. + For example: serverInstance, serverGkeDetails.cluster, + serverGkeDetails.pod.podNamespace + type: array + items: + type: string + SecuritySettings: + id: SecuritySettings + description: The authentication and authorization settings for a BackendService. + type: object + 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. type: string - deprecated: - description: '[Output Only] The deprecation status associated with this disk type.' - $ref: '#/components/schemas/DeprecationStatus' - zone: + subjectAltNames: 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. + 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). + type: array + items: + type: string + awsV4Authentication: + description: >- + The configuration needed to generate a signature for access to + private storage buckets that support AWS's Signature Version 4 for + authentication. Allowed only for INTERNET_IP_PORT and + INTERNET_FQDN_PORT NEG backends. + $ref: '#/components/schemas/AWSV4Signature' + AWSV4Signature: + id: AWSV4Signature + description: >- + Contains the configurations necessary to generate a signature for access + to private storage buckets that support Signature Version 4 for + authentication. The service name for generating the authentication + header will always default to 's3'. + type: object + properties: + accessKeyId: + description: The identifier of an access key used for s3 bucket authentication. type: string - selfLink: - description: '[Output Only] Server-defined URL for the resource.' + accessKey: + description: >- + The access key used for s3 bucket authentication. Required for + updating or creating a backend that uses AWS v4 signature + authentication, but will not be returned as part of the + configuration when queried with a REST API GET request. @InputOnly type: string - defaultDiskSizeGb: - description: '[Output Only] Server-defined default disk size in GB.' + accessKeyVersion: + description: >- + The optional version identifier for the access key. You can use this + to keep track of different iterations of your access key. type: string - format: int64 - region: + originRegion: 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. + The name of the cloud region of your origin. This is a free-form + field with the name of the region your cloud uses to host your + origin. For example, "us-east-1" for AWS or "us-ashburn-1" for OCI. type: string - DiskTypeAggregatedList: - id: DiskTypeAggregatedList + ConsistentHashLoadBalancerSettings: + id: ConsistentHashLoadBalancerSettings + description: This message defines settings for a consistent hash style load balancer. type: object properties: - kind: + httpCookie: description: >- - [Output Only] Type of resource. Always - compute#diskTypeAggregatedList. - default: compute#diskTypeAggregatedList - type: string - id: + 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. + 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. + $ref: '#/components/schemas/ConsistentHashLoadBalancerSettingsHttpCookie' + httpHeaderName: description: >- - [Output Only] Unique identifier for the resource; defined by the - server. + 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 - items: - description: A list of DiskTypesScopedList resources. - type: object - additionalProperties: - description: '[Output Only] Name of the scope containing this set of disk types.' - $ref: '#/components/schemas/DiskTypesScopedList' - nextPageToken: + minimumRingSize: description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. + 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. type: string - selfLink: - description: '[Output Only] Server-defined URL for this resource.' + format: int64 + ConsistentHashLoadBalancerSettingsHttpCookie: + id: ConsistentHashLoadBalancerSettingsHttpCookie + description: >- + The information about the HTTP Cookie on which the hash function is + based for load balancing policies that use a consistent hash. + type: object + properties: + name: + description: Name of the cookie. type: string - warning: - description: '[Output Only] Informational warning message.' - type: object - properties: - code: - description: >- - [Output Only] A warning code, if applicable. For example, - Compute Engine returns NO_RESULTS_ON_PAGE if there are no - results in the response. - type: string - enumDescriptions: - - >- - Warning about failed cleanup of transient changes made by a - failed operation. - - A link to a deprecated resource was created. - - >- - When deploying and at least one of the resources has a type - marked as deprecated - - The user created a boot disk that is larger than image size. - - >- - When deploying and at least one of the resources has a type - marked as experimental - - Warning that is present in an external api call - - >- - Warning that value of a field has been overridden. Deprecated - unused field. - - >- - The operation involved use of an injected kernel, which is - deprecated. - - >- - A WEIGHTED_MAGLEV backend service is associated with a health - check that is not of type HTTP/HTTPS/HTTP2. - - >- - When deploying a deployment with a exceedingly large number of - resources - - >- - Resource can't be retrieved due to list overhead quota exceed - which captures the amount of resources filtered out by - user-defined list filter. - - A resource depends on a missing type - - >- - The route's nextHopIp address is not assigned to an instance - on the network. + path: + description: Path to set for the cookie. + type: string + ttl: + description: Lifetime of the cookie. + $ref: '#/components/schemas/Duration' + CircuitBreakers: + id: CircuitBreakers + description: >- + Settings controlling the volume of requests, connections and retries to + this backend service. + type: object + properties: + maxRequestsPerConnection: + description: >- + Maximum requests for a single connection to the backend service. + This parameter is respected by both the HTTP/1.1 and HTTP/2 + implementations. If not specified, there is no limit. Setting this + parameter to 1 will effectively disable keep alive. 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. + type: integer + format: int32 + maxConnections: + description: >- + The maximum number of connections to the backend service. If not + specified, there is no limit. 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. + type: integer + format: int32 + maxPendingRequests: + description: >- + The maximum number of pending requests allowed to the backend + service. If not specified, there is no limit. 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. + type: integer + format: int32 + maxRequests: + description: >- + The maximum number of parallel requests that allowed to the backend + service. If not specified, there is no limit. + type: integer + format: int32 + maxRetries: + description: >- + The maximum number of parallel retries allowed to the backend + cluster. If not specified, the default is 1. 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. + type: integer + format: int32 + OutlierDetection: + id: OutlierDetection + description: >- + Settings controlling the eviction of unhealthy hosts from the load + balancing pool for the backend service. + type: object + properties: + consecutiveErrors: + description: >- + Number of consecutive errors before a backend endpoint is ejected + from the load balancing pool. When the backend endpoint is accessed + over HTTP, a 5xx return code qualifies as an error. Defaults to 5. + type: integer + format: int32 + interval: + description: >- + Time interval between ejection analysis sweeps. This can result in + both new ejections and backend endpoints being returned to service. + The interval is equal to the number of seconds as defined in + outlierDetection.interval.seconds plus the number of nanoseconds as + defined in outlierDetection.interval.nanos. Defaults to 1 second. + $ref: '#/components/schemas/Duration' + baseEjectionTime: + description: >- + The base time that a backend endpoint is ejected for. Defaults to + 30000ms or 30s. After a backend endpoint is returned back to the + load balancing pool, it can be ejected again in another ejection + analysis. Thus, the total ejection time is equal to the base + ejection time multiplied by the number of times the backend endpoint + has been ejected. Defaults to 30000ms or 30s. + $ref: '#/components/schemas/Duration' + maxEjectionPercent: + description: >- + Maximum percentage of backend endpoints in the load balancing pool + for the backend service that can be ejected if the ejection + conditions are met. Defaults to 50%. + type: integer + format: int32 + enforcingConsecutiveErrors: + description: >- + The percentage chance that a backend endpoint will be ejected when + an outlier status is detected through consecutive 5xx. This setting + can be used to disable ejection or to ramp it up slowly. Defaults to + 0. + type: integer + format: int32 + enforcingSuccessRate: + description: >- + The percentage chance that a backend endpoint will be ejected when + an outlier status is detected through success rate statistics. This + setting can be used to disable ejection or to ramp it up slowly. + Defaults to 100. Not supported when the backend service uses + Serverless NEG. + type: integer + format: int32 + successRateMinimumHosts: + description: >- + The number of backend endpoints in the load balancing pool that must + have enough request volume to detect success rate outliers. If the + number of backend endpoints is fewer than this setting, outlier + detection via success rate statistics is not performed for any + backend endpoint in the load balancing pool. Defaults to 5. Not + supported when the backend service uses Serverless NEG. + type: integer + format: int32 + 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 + backend endpoint in success rate based outlier detection. If the + volume is lower than this setting, outlier detection via success + rate statistics is not performed for that backend endpoint. Defaults + to 100. Not supported when the backend service uses Serverless NEG. + type: integer + format: int32 + 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 * + successRateStdevFactor). This factor is divided by a thousand to get + a double. That is, if the desired factor is 1.9, the runtime value + should be 1900. Defaults to 1900. Not supported when the backend + service uses Serverless NEG. + type: integer + format: int32 + 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. + type: integer + format: int32 + enforcingConsecutiveGatewayFailure: + description: >- + The percentage chance that a backend endpoint will be ejected when + an outlier status is detected through consecutive gateway failures. + This setting can be used to disable ejection or to ramp it up + slowly. Defaults to 100. + type: integer + format: int32 + Subsetting: + id: 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. + type: object + properties: + policy: + type: string + enumDescriptions: + - >- + Subsetting based on consistent hashing. For Traffic Director, the + number of backends per backend group (the subset size) is based on + the `subset_size` parameter. For Internal HTTP(S) load balancing, + the number of backends per backend group (the subset size) is + dynamically adjusted in two cases: - As the number of proxy + instances participating in Internal HTTP(S) load balancing + increases, the subset size decreases. - When the total number of + backends in a network exceeds the capacity of a single proxy + instance, subset sizes are reduced automatically for each service + that has backend subsetting enabled. + - >- + No Subsetting. Clients may open connections and send traffic to + all backends of this backend service. This can lead to performance + issues if there is substantial imbalance in the count of clients + and backends. + enum: + - CONSISTENT_HASH_SUBSETTING + - NONE + BackendServiceConnectionTrackingPolicy: + id: BackendServiceConnectionTrackingPolicy + description: Connection Tracking configuration for this BackendService. + type: object + properties: + trackingMode: + description: >- + Specifies the key used for connection tracking. There are two + options: - PER_CONNECTION: This is the default mode. The Connection + Tracking is performed as per the Connection Key (default Hash + Method) for the specific protocol. - PER_SESSION: The Connection + Tracking is performed as per the configured Session Affinity. It + matches the configured Session Affinity. For more details, see + [Tracking Mode for Network Load + Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#tracking-mode) + and [Tracking Mode for Internal TCP/UDP Load + Balancing](https://cloud.google.com/load-balancing/docs/internal#tracking-mode). + type: string + enumDescriptions: + - '' + - '' + - '' + enum: + - INVALID_TRACKING_MODE + - PER_CONNECTION + - PER_SESSION + connectionPersistenceOnUnhealthyBackends: + description: >- + Specifies connection persistence when backends are unhealthy. The + default value is DEFAULT_FOR_PROTOCOL. If set to + DEFAULT_FOR_PROTOCOL, the existing connections persist on unhealthy + backends only for connection-oriented protocols (TCP and SCTP) and + only if the Tracking Mode is PER_CONNECTION (default tracking mode) + or the Session Affinity is configured for 5-tuple. They do not + persist for UDP. If set to NEVER_PERSIST, after a backend becomes + unhealthy, the existing connections on the unhealthy backend are + never persisted on the unhealthy backend. They are always diverted + to newly selected healthy backends (unless all backends are + unhealthy). If set to ALWAYS_PERSIST, existing connections always + persist on unhealthy backends regardless of protocol and session + affinity. It is generally not recommended to use this mode + overriding the default. For more details, see [Connection + Persistence for Network Load + Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#connection-persistence) + and [Connection Persistence for Internal TCP/UDP Load + Balancing](https://cloud.google.com/load-balancing/docs/internal#connection-persistence). + type: string + enumDescriptions: + - '' + - '' + - '' + enum: + - ALWAYS_PERSIST + - DEFAULT_FOR_PROTOCOL + - NEVER_PERSIST + idleTimeoutSec: + description: >- + Specifies how long to keep a Connection Tracking entry while there + is no matching traffic (in seconds). For internal passthrough + Network Load Balancers: - The minimum (default) is 10 minutes and + the maximum is 16 hours. - It can be set only if Connection Tracking + is less than 5-tuple (i.e. Session Affinity is + CLIENT_IP_NO_DESTINATION, CLIENT_IP or CLIENT_IP_PROTO, and Tracking + Mode is PER_SESSION). For external passthrough Network Load + Balancers the default is 60 seconds. This option is not available + publicly. + type: integer + format: int32 + enableStrongAffinity: + description: >- + Enable Strong Session Affinity for external passthrough Network Load + Balancers. This option is not available publicly. + type: boolean + BackendServiceLocalityLoadBalancingPolicyConfig: + id: BackendServiceLocalityLoadBalancingPolicyConfig + description: >- + Container for either a built-in LB policy supported by gRPC or Envoy or + a custom one implemented by the end user. + type: object + properties: + policy: + $ref: >- + #/components/schemas/BackendServiceLocalityLoadBalancingPolicyConfigPolicy + customPolicy: + $ref: >- + #/components/schemas/BackendServiceLocalityLoadBalancingPolicyConfigCustomPolicy + BackendServiceLocalityLoadBalancingPolicyConfigPolicy: + id: BackendServiceLocalityLoadBalancingPolicyConfigPolicy + description: The configuration for a built-in load balancing policy. + type: object + properties: + name: + description: >- + The name of a locality load-balancing policy. Valid values include + ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information + about these values, see the description of localityLbPolicy. Do not + specify the same policy more than once for a backend. If you do, the + configuration is rejected. + type: string + enumDescriptions: + - '' + - >- + An O(1) algorithm which selects two random healthy hosts and picks + the host which has fewer active requests. + - >- + This algorithm implements consistent hashing to backends. Maglev + can be 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 Maglev: A Fast and Reliable Software + Network Load Balancer. + - >- + 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. + - The load balancer selects a random healthy host. + - >- + 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. + - >- + This is a simple policy in which each healthy backend is selected + in round robin order. This is the default. + - >- + Per-instance weighted Load Balancing via health check reported + weights. In internal passthrough network load balancing, it is + weighted rendezvous hashing. This option is only supported in + internal passthrough network load balancing. + - >- + Per-instance weighted Load Balancing via health check reported + weights. If set, the Backend Service must configure a non legacy + HTTP-based Health Check, and health check replies are expected to + contain non-standard HTTP response header field + X-Load-Balancing-Endpoint-Weight to specify the per-instance + weights. If set, Load Balancing is weighted based on the + per-instance weights reported in the last processed health check + replies, as long as every instance either reported a valid weight + or had UNAVAILABLE_WEIGHT. Otherwise, Load Balancing remains + equal-weight. This option is only supported in Network Load + Balancing. + - >- + Per-endpoint weighted round-robin Load Balancing using weights + computed from Backend reported Custom Metrics. If set, the Backend + Service responses are expected to contain non-standard HTTP + response header field Endpoint-Load-Metrics. The reported metrics + to use for computing the weights are specified via the + customMetrics fields. + enum: + - INVALID_LB_POLICY + - LEAST_REQUEST + - MAGLEV + - ORIGINAL_DESTINATION + - RANDOM + - RING_HASH + - ROUND_ROBIN + - WEIGHTED_GCP_RENDEZVOUS + - WEIGHTED_MAGLEV + - WEIGHTED_ROUND_ROBIN + BackendServiceLocalityLoadBalancingPolicyConfigCustomPolicy: + id: BackendServiceLocalityLoadBalancingPolicyConfigCustomPolicy + description: >- + The configuration for a custom policy implemented by the user and + deployed with the client. + type: object + properties: + name: + description: >- + Identifies the custom policy. The value should match the name of a + custom implementation registered on the gRPC clients. It should + follow protocol buffer message naming conventions and include the + full path (for example, myorg.CustomLbPolicy). The maximum length is + 256 characters. Do not specify the same custom policy more than once + for a backend. If you do, the configuration is rejected. For an + example of how to use this field, see Use a custom policy. + type: string + data: + description: >- + An optional, arbitrary JSON object with configuration data, + understood by a locally installed custom policy implementation. + type: string + BackendServiceHAPolicy: + id: BackendServiceHAPolicy + type: object + properties: + fastIPMove: + description: >- + Specifies whether fast IP move is enabled, and if so, the mechanism + to achieve it. Supported values are: - DISABLED: Fast IP Move is + disabled. You can only use the haPolicy.leader API to update the + leader. - >GARP_RA: Provides a method to very quickly define a new + network endpoint as the leader. This method is faster than updating + the leader using the haPolicy.leader API. Fast IP move works as + follows: The VM hosting the network endpoint that should become the + new leader sends either a Gratuitous ARP (GARP) packet (IPv4) or an + ICMPv6 Router Advertisement(RA) packet (IPv6). Google Cloud + immediately but temporarily associates the forwarding rule IP + address with that VM, and both new and in-flight packets are quickly + delivered to that VM. Note the important properties of the Fast IP + Move functionality: - The GARP/RA-initiated re-routing stays active + for approximately 20 minutes. After triggering fast failover, you + must also appropriately set the haPolicy.leader. - The new leader + instance should continue to send GARP/RA packets periodically every + 10 seconds until at least 10 minutes after updating the + haPolicy.leader (but stop immediately if it is no longer the + leader). - After triggering a fast failover, we recommend that you + wait at least 3 seconds before sending another GARP/RA packet from a + different VM instance to avoid race conditions. - Don't send GARP/RA + packets from different VM instances at the same time. If multiple + instances continue to send GARP/RA packets, traffic might be routed + to different destinations in an alternating order. This condition + ceases when a single instance issues a GARP/RA packet. - The GARP/RA + request always takes priority over the leader API. Using the + haPolicy.leader API to change the leader to a different instance + will have no effect until the GARP/RA request becomes inactive. - + The GARP/RA packets should follow the GARP/RA Packet + Specifications.. - When multiple forwarding rules refer to a + regional backend service, you need only send a GARP or RA packet for + a single forwarding rule virtual IP. The virtual IPs for all + forwarding rules targeting the same backend service will also be + moved to the sender of the GARP or RA packet. The following are the + Fast IP Move limitations (that is, when fastIPMove is not DISABLED): + - Multiple forwarding rules cannot use the same IP address if one of + them refers to a regional backend service with fastIPMove. - The + regional backend service must set the network field, and all NEGs + must belong to that network. However, individual NEGs can belong to + different subnetworks of that network. - The maximum number of + network endpoints across all backends of a backend service with + fastIPMove is 32. - The maximum number of backend services with + fastIPMove that can have the same network endpoint attached to one + of its backends is 64. - The maximum number of backend services with + fastIPMove in a VPC in a region is 64. - The network endpoints that + are attached to a backend of a backend service with fastIPMove + cannot resolve to Gen3+ machines for IPv6. - Traffic directed to the + leader by a static route next hop will not be redirected to a new + leader by fast failover. Such traffic will only be redirected once + an haPolicy.leader update has taken effect. Only traffic to the + forwarding rule's virtual IP will be redirected to a new leader by + fast failover. haPolicy.fastIPMove can be set only at backend + service creation time. Once set, it cannot be updated. By default, + fastIpMove is set to DISABLED. + type: string + enumDescriptions: + - '' + - '' + enum: + - DISABLED + - GARP_RA + leader: + description: >- + Selects one of the network endpoints attached to the backend NEGs of + this service as the active endpoint (the leader) that receives all + traffic. When the leader changes, there is no connection draining to + persist existing connections on the old leader. You are responsible + for selecting a suitable endpoint as the leader. For example, + preferring a healthy endpoint over unhealthy ones. Note that this + service does not track backend endpoint health, and selects the + configured leader unconditionally. + $ref: '#/components/schemas/BackendServiceHAPolicyLeader' + BackendServiceHAPolicyLeader: + id: BackendServiceHAPolicyLeader + type: object + properties: + backendGroup: + description: >- + A fully-qualified URL (starting with https://www.googleapis.com/) of + the zonal Network Endpoint Group (NEG) with `GCE_VM_IP` endpoints + that the leader is attached to. The leader's backendGroup must + already be specified as a backend of this backend service. Removing + a backend that is designated as the leader's backendGroup is not + permitted. + type: string + networkEndpoint: + description: >- + The network endpoint within the leader.backendGroup that is + designated as the leader. This network endpoint cannot be detached + from the NEG specified in the haPolicy.leader.backendGroup until the + leader is updated with another network endpoint, or the leader is + removed from the haPolicy. + $ref: '#/components/schemas/BackendServiceHAPolicyLeaderNetworkEndpoint' + BackendServiceHAPolicyLeaderNetworkEndpoint: + id: BackendServiceHAPolicyLeaderNetworkEndpoint + type: object + properties: + instance: + description: >- + The name of the VM instance of the leader network endpoint. The + instance must already be attached to the NEG specified in the + haPolicy.leader.backendGroup. The name must be 1-63 characters long, + and comply with RFC1035. Authorization requires the following IAM + permission on the specified resource instance: compute.instances.use + type: string + BackendServiceUsedBy: + id: BackendServiceUsedBy + type: object + properties: + reference: + description: >- + [Output Only] Server-defined URL for resources referencing given + BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and + ForwardingRule. + type: string + BackendServiceHttpCookie: + id: BackendServiceHttpCookie + description: The HTTP cookie used for stateful session affinity. + type: object + properties: + name: + description: Name of the cookie. + type: string + path: + description: Path to set for the cookie. + type: string + ttl: + description: Lifetime of the cookie. + $ref: '#/components/schemas/Duration' + BackendServiceTlsSettings: + id: BackendServiceTlsSettings + type: object + properties: + sni: + description: >- + Server Name Indication - see RFC3546 section 3.1. If set, the load + balancer sends this string as the SNI hostname in the TLS connection + to the backend, and requires that this string match a Subject + Alternative Name (SAN) in the backend's server certificate. With a + Regional Internet NEG backend, if the SNI is specified here, the + load balancer uses it regardless of whether the Regional Internet + NEG is specified with FQDN or IP address and port. When both sni and + subjectAltNames[] are specified, the load balancer matches the + backend certificate's SAN only to subjectAltNames[]. + type: string + subjectAltNames: + description: >- + A list of Subject Alternative Names (SANs) that the Load Balancer + verifies during a TLS handshake with the backend. When the server + presents its X.509 certificate to the Load Balancer, the Load + Balancer inspects the certificate's SAN field, and requires that at + least one SAN match one of the subjectAltNames in the list. This + field is limited to 5 entries. When both sni and subjectAltNames[] + are specified, the load balancer matches the backend certificate's + SAN only to subjectAltNames[]. + type: array + items: + $ref: '#/components/schemas/BackendServiceTlsSettingsSubjectAltName' + authenticationConfig: + description: >- + Reference to the BackendAuthenticationConfig resource from the + networksecurity.googleapis.com namespace. Can be used in + authenticating TLS connections to the backend, as specified by the + authenticationMode field. Can only be specified if + authenticationMode is not NONE. + type: string + BackendServiceTlsSettingsSubjectAltName: + id: BackendServiceTlsSettingsSubjectAltName + description: >- + A Subject Alternative Name that the load balancer matches against the + SAN field in the TLS certificate provided by the backend, specified as + either a DNS name or a URI, in accordance with RFC 5280 4.2.1.6 + type: object + properties: + dnsName: + description: The SAN specified as a DNS Name. + type: string + uniformResourceIdentifier: + description: The SAN specified as a URI. + type: string + BackendServiceCustomMetric: + id: BackendServiceCustomMetric + description: Custom Metrics are used for WEIGHTED_ROUND_ROBIN locality_lb_policy. + type: object + properties: + name: + description: >- + Name of a custom utilization signal. The name must be 1-64 + characters long and match the regular expression + [a-z]([-_.a-z0-9]*[a-z0-9])? which means that the first character + must be a lowercase letter, and all following characters must be a + dash, period, underscore, lowercase letter, or digit, except the + last character, which cannot be a dash, period, or underscore. For + usage guidelines, see Custom Metrics balancing mode. This field can + only be used for a global or regional backend service with the + loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED + INTERNAL_SELF_MANAGED. + type: string + dryRun: + description: If true, the metric data is not used for load balancing. + type: boolean + BackendServiceParams: + id: BackendServiceParams + description: Additional Backend Service parameters. + type: object + properties: + resourceManagerTags: + description: >- + Tag keys/values directly bound to this resource. Tag keys and values + have the same definition as resource manager tags. The field is + allowed for INSERT only. The keys/values to set on the resource + should be specified in either ID { : } or Namespaced format { : }. + For example the following are valid inputs: * {"tagKeys/333" : + "tagValues/444", "tagKeys/123" : "tagValues/456"} * + {"123/environment" : "production", "345/abc" : "xyz"} Note: * + Invalid combinations of ID & namespaced format is not supported. For + instance: {"123/environment" : "tagValues/444"} is invalid. + type: object + additionalProperties: + type: string + BackendServiceAggregatedList: + id: BackendServiceAggregatedList + description: Contains a list of BackendServicesScopedList. + type: object + properties: + kind: + description: Type of resource. + default: compute#backendServiceAggregatedList + type: string + id: + description: >- + [Output Only] Unique identifier for the resource; defined by the + server. + type: string + items: + description: A list of BackendServicesScopedList resources. + type: object + additionalProperties: + description: Name of the scope containing this set of BackendServices. + $ref: '#/components/schemas/BackendServicesScopedList' + nextPageToken: + description: >- + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. + type: string + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string + warning: + description: '[Output Only] Informational warning message.' + type: object + properties: + code: + description: >- + [Output Only] A warning code, if applicable. For example, + Compute Engine returns NO_RESULTS_ON_PAGE if there are no + results in the response. + type: string + enumDescriptions: + - >- + Warning about failed cleanup of transient changes made by a + failed operation. + - A link to a deprecated resource was created. + - >- + When deploying and at least one of the resources has a type + marked as deprecated + - The user created a boot disk that is larger than image size. + - >- + When deploying and at least one of the resources has a type + marked as experimental + - Warning that is present in an external api call + - >- + Warning that value of a field has been overridden. Deprecated + unused field. + - >- + The operation involved use of an injected kernel, which is + deprecated. + - >- + A WEIGHTED_MAGLEV backend service is associated with a health + check that is not of type HTTP/HTTPS/HTTP2. + - >- + When deploying a deployment with a exceedingly large number of + resources + - >- + Resource can't be retrieved due to list overhead quota exceed + which captures the amount of resources filtered out by + user-defined list filter. + - A resource depends on a missing type + - >- + The route's nextHopIp address is not assigned to an instance + on the network. - The route's next hop instance cannot ip forward. - >- The route's nextHopInstance URL refers to an instance that @@ -22344,6 +22290,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -22387,6 +22336,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -22409,6 +22359,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -22450,19 +22401,19 @@ components: type: array items: type: string - DiskTypesScopedList: - id: DiskTypesScopedList + BackendServicesScopedList: + id: BackendServicesScopedList type: object properties: - diskTypes: - description: '[Output Only] A list of disk types contained in this scope.' + backendServices: + description: A list of BackendServices contained in this scope. type: array items: - $ref: '#/components/schemas/DiskType' + $ref: '#/components/schemas/BackendService' warning: description: >- - [Output Only] Informational warning which replaces the list of disk - types when the list is empty. + Informational warning which replaces the list of backend services + when the list is empty. type: object properties: code: @@ -22525,6 +22476,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -22568,6 +22522,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -22590,6 +22545,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -22626,15 +22582,17 @@ components: [Output Only] A warning data value corresponding to the key. type: string - RegionDiskTypeList: - id: RegionDiskTypeList + BackendServiceListUsable: + id: BackendServiceListUsable + description: Contains a list of usable BackendService resources. type: object properties: kind: description: >- - [Output Only] Type of resource. Always compute#regionDiskTypeList - for region disk types. - default: compute#regionDiskTypeList + [Output Only] Type of resource. Always + compute#usableBackendServiceList for lists of usable backend + services. + default: compute#usableBackendServiceList type: string id: description: >- @@ -22642,10 +22600,10 @@ components: server. type: string items: - description: A list of DiskType resources. + description: A list of BackendService resources. type: array items: - $ref: '#/components/schemas/DiskType' + $ref: '#/components/schemas/BackendService' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -22721,6 +22679,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -22764,6 +22725,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -22786,6 +22748,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -22822,165 +22785,132 @@ components: [Output Only] A warning data value corresponding to the key. type: string - ExternalVpnGateway: - id: 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. + ResourceGroupReference: + id: ResourceGroupReference type: object properties: - kind: - description: >- - [Output Only] Type of the resource. Always - compute#externalVpnGateway for externalVpnGateways. - default: compute#externalVpnGateway - type: string - description: + group: description: >- - An optional description of this resource. Provide this property when - you create the resource. - type: string - selfLink: - description: '[Output Only] Server-defined URL for the resource.' + A URI referencing one of the instance groups or network endpoint + groups listed in the backend service. type: string - id: + BackendServiceGroupHealth: + id: BackendServiceGroupHealth + type: object + properties: + kind: description: >- - [Output Only] The unique identifier for the resource. This - identifier is defined by the server. - type: string - format: uint64 - creationTimestamp: - description: '[Output Only] Creation timestamp in RFC3339 text format.' + [Output Only] Type of resource. Always + compute#backendServiceGroupHealth for the health of backend + services. + default: compute#backendServiceGroupHealth type: string - name: + healthStatus: 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])?' - annotations: - required: - - compute.externalVpnGateways.insert + Health state of the backend instances or endpoints in requested + instance or network endpoint group, determined based on configured + health checks. + type: array + items: + $ref: '#/components/schemas/HealthStatus' + annotations: + description: Metadata defined as annotations on the network endpoint group. + type: object + additionalProperties: + type: string + HealthStatus: + id: HealthStatus + type: object + properties: + weight: type: string - redundancyType: - description: >- - Indicates the user-supplied redundancy type of this external VPN - gateway. + weightError: type: string enumDescriptions: - >- - The external VPN gateway has four public IP addresses; at the time - of writing this API, the AWS virtual private gateway is an example - which has four public IP addresses for high availability - connections; there should be two VPN connections in the AWS - virtual private gateway , each AWS VPN connection has two public - IP addresses; please make sure to put two public IP addresses from - one AWS VPN connection into interfaces 0 and 1 of this external - VPN gateway, and put the other two public IP addresses from - another AWS VPN connection into interfaces 2 and 3 of this - external VPN gateway. When displaying highly available - configuration status for the VPN tunnels connected to - FOUR_IPS_REDUNDANCY external VPN gateway, Google will always - detect whether interfaces 0 and 1 are connected on one interface - of HA Cloud VPN gateway, and detect whether interfaces 2 and 3 are - connected to another interface of the HA Cloud VPN gateway. + The response to a Health Check probe had the HTTP response header + field X-Load-Balancing-Endpoint-Weight, but its content was + invalid (i.e., not a non-negative single-precision floating-point + number in decimal string representation). - >- - The external VPN gateway has only one public IP address which - internally provide redundancy or failover. + The response to a Health Check probe did not have the HTTP + response header field X-Load-Balancing-Endpoint-Weight. - >- - The external VPN gateway has two public IP addresses which are - redundant with each other, the following two types of setup on - your on-premises side would have this type of redundancy: (1) Two - separate on-premises gateways, each with one public IP address, - the two on-premises gateways are redundant with each other. (2) A - single on-premise gateway with two public IP addresses that are - redundant with eatch other. + This is the value when the accompanied health status is either + TIMEOUT (i.e.,the Health Check probe was not able to get a + response in time) or UNKNOWN. For the latter, it should be + typically because there has not been sufficient time to parse and + report the weight for a new backend (which is with 0.0.0.0 ip + address). However, it can be also due to an outage case for which + the health status is explicitly reset to UNKNOWN. + - >- + This is the default value when WeightReportMode is DISABLE, and is + also the initial value when WeightReportMode has just updated to + ENABLE or DRY_RUN and there has not been sufficient time to parse + and report the backend weight. enum: - - FOUR_IPS_REDUNDANCY - - SINGLE_IP_INTERNALLY_REDUNDANT - - TWO_IPS_REDUNDANCY - interfaces: + - INVALID_WEIGHT + - MISSING_WEIGHT + - UNAVAILABLE_WEIGHT + - WEIGHT_NONE + ipAddress: 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. - type: array - items: - $ref: '#/components/schemas/ExternalVpnGatewayInterface' - labels: + 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 + ipv6Address: + type: string + port: 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. + The named port of the instance group, not necessarily the port that + is health-checked. + type: integer + format: int32 + instance: + description: URL of the instance resource. + type: string + healthState: + description: Health state of the IPv4 address of the instance. + type: string + enumDescriptions: + - '' + - '' + enum: + - HEALTHY + - UNHEALTHY + ipv6HealthState: + description: Health state of the IPv6 address of the instance. + type: string + enumDescriptions: + - '' + - '' + enum: + - HEALTHY + - UNHEALTHY + annotations: + description: Metadata defined as annotations for network endpoint. type: object additionalProperties: 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. - type: string - format: byte - ExternalVpnGatewayInterface: - id: ExternalVpnGatewayInterface - description: The interface for the external VPN gateway. - type: object - 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 - type: integer - format: uint32 - 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. + forwardingRuleIp: + description: A forwarding rule IP address assigned to this instance. type: string - ipv6Address: + forwardingRule: description: >- - IPv6 address of the interface in the external VPN gateway. This IPv6 - 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. Must specify an IPv6 address (not IPV4-mapped) using - any format described in RFC 4291 (e.g. 2001:db8:0:0:2d9:51:0:0). The - output format is RFC 5952 format (e.g. 2001:db8::2d9:51:0:0). + URL of the forwarding rule associated with the health status of the + instance. type: string - ExternalVpnGatewayList: - id: ExternalVpnGatewayList - description: >- - Response to the list request, and contains a list of - externalVpnGateways. + CommitmentList: + id: CommitmentList + description: Contains a list of Commitment resources. type: object properties: kind: description: >- - [Output Only] Type of resource. Always - compute#externalVpnGatewayList for lists of externalVpnGateways. - default: compute#externalVpnGatewayList + [Output Only] Type of resource. Always compute#commitmentList for + lists of commitments. + default: compute#commitmentList type: string id: description: >- @@ -22988,10 +22918,10 @@ components: server. type: string items: - description: A list of ExternalVpnGateway resources. + description: A list of Commitment resources. type: array items: - $ref: '#/components/schemas/ExternalVpnGateway' + $ref: '#/components/schemas/Commitment' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -23067,6 +22997,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -23110,6 +23043,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -23132,6 +23066,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -23168,16 +23103,346 @@ components: [Output Only] A warning data value corresponding to the key. type: string - etag: + Commitment: + id: Commitment + description: >- + Represents a regional resource-based commitment resource. Creating this + commitment resource means that you are purchasing a resource-based + committed use contract, with an explicit start and end time. You can + purchase resource-based commitments for both hardware and software + resources. For more information, read Resource-based committed use + discounts + type: object + properties: + kind: + description: >- + [Output Only] Type of the resource. Always compute#commitment for + commitments. + default: compute#commitment type: string - ForwardingRuleList: - id: ForwardingRuleList - description: Contains a list of ForwardingRule resources. + id: + description: >- + [Output Only] The unique identifier for the resource. This + identifier is defined by the server. + type: string + format: uint64 + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + name: + description: >- + Name of the commitment. You must specify a name when you purchase + the commitment. 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 + description: + description: >- + An optional description of the commitment. You can provide this + property when you create the resource. + type: string + region: + description: >- + [Output Only] URL of the region where the commitment and committed + resources are located. + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + status: + description: >- + [Output Only] Status of the commitment with regards to eventual + expiration (each commitment has an end date defined). Status can be + one of the following values: NOT_YET_ACTIVE, ACTIVE, or EXPIRED. + type: string + enumDescriptions: + - '' + - >- + Deprecate CANCELED status. Will use separate status to + differentiate cancel by mergeCud or manual cancellation. + - '' + - '' + - '' + enum: + - ACTIVE + - CANCELLED + - CREATING + - EXPIRED + - NOT_YET_ACTIVE + statusMessage: + description: '[Output Only] An optional, human-readable explanation of the status.' + type: string + plan: + description: >- + The minimum time duration that you commit to purchasing resources. + The plan that you choose determines the preset term length of the + commitment (which is 1 year or 3 years) and affects the discount + rate that you receive for your resources. Committing to a longer + time duration typically gives you a higher discount rate. The + supported values for this field are TWELVE_MONTH (1 year), and + THIRTY_SIX_MONTH (3 years). + type: string + enumDescriptions: + - '' + - '' + - '' + enum: + - INVALID + - THIRTY_SIX_MONTH + - TWELVE_MONTH + startTimestamp: + description: '[Output Only] Commitment start time in RFC3339 text format.' + type: string + endTimestamp: + description: '[Output Only] Commitment end time in RFC3339 text format.' + type: string + category: + description: >- + The category of the commitment; specifies whether the commitment is + for hardware or software resources. Category MACHINE specifies that + you are committing to hardware machine resources such as VCPU or + MEMORY, listed in resources. Category LICENSE specifies that you are + committing to software licenses, listed in licenseResources. Note + that if you specify MACHINE commitments, then you must also specify + a type to indicate the machine series of the hardware resource that + you are committing to. + type: string + enumDescriptions: + - '' + - '' + - '' + enum: + - CATEGORY_UNSPECIFIED + - LICENSE + - MACHINE + resources: + description: >- + The list of all the hardware resources, with their types and + amounts, that you want to commit to. Specify as a separate entry in + the list for each individual resource type. + type: array + items: + $ref: '#/components/schemas/ResourceCommitment' + type: + description: >- + The type of commitment; specifies the machine series for which you + want to commit to purchasing resources. The choice of machine series + affects the discount rate and the eligible resource types. The type + must be one of the following: ACCELERATOR_OPTIMIZED, + ACCELERATOR_OPTIMIZED_A3, ACCELERATOR_OPTIMIZED_A3_MEGA, + COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, COMPUTE_OPTIMIZED_C3, + COMPUTE_OPTIMIZED_C3D, COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE, + GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2, GENERAL_PURPOSE_N2, + GENERAL_PURPOSE_N2D, GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D, + GRAPHICS_OPTIMIZED, MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3, + MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For example, type + MEMORY_OPTIMIZED specifies a commitment that applies only to + eligible resources of memory optimized M1 and M2 machine series. + Type GENERAL_PURPOSE specifies a commitment that applies only to + eligible resources of general purpose N1 machine series. + type: string + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - >- + Note for internal users: When adding a new enum Type for v1, make + sure to also add it in the comment for the `optional Type type` + definition. This ensures that the public documentation displays + the new enum Type. + enum: + - ACCELERATOR_OPTIMIZED + - ACCELERATOR_OPTIMIZED_A3 + - ACCELERATOR_OPTIMIZED_A3_MEGA + - ACCELERATOR_OPTIMIZED_A3_ULTRA + - ACCELERATOR_OPTIMIZED_A4 + - COMPUTE_OPTIMIZED + - COMPUTE_OPTIMIZED_C2D + - COMPUTE_OPTIMIZED_C3 + - COMPUTE_OPTIMIZED_C3D + - COMPUTE_OPTIMIZED_H3 + - COMPUTE_OPTIMIZED_H4D + - GENERAL_PURPOSE + - GENERAL_PURPOSE_C4 + - GENERAL_PURPOSE_C4A + - GENERAL_PURPOSE_C4D + - GENERAL_PURPOSE_E2 + - GENERAL_PURPOSE_N2 + - GENERAL_PURPOSE_N2D + - GENERAL_PURPOSE_N4 + - GENERAL_PURPOSE_T2D + - GRAPHICS_OPTIMIZED + - MEMORY_OPTIMIZED + - MEMORY_OPTIMIZED_M3 + - MEMORY_OPTIMIZED_M4 + - MEMORY_OPTIMIZED_M4_6TB + - MEMORY_OPTIMIZED_X4_16TB + - MEMORY_OPTIMIZED_X4_24TB + - MEMORY_OPTIMIZED_X4_32TB + - STORAGE_OPTIMIZED_Z3 + - TYPE_UNSPECIFIED + reservations: + description: >- + The list of new reservations that you want to create and attach to + this commitment. You must attach reservations to your commitment if + your commitment specifies any GPUs or Local SSD disks. For more + information, see Attach reservations to resource-based commitments. + Specify this property only if you want to create new reservations to + attach. To attach existing reservations, specify the + existingReservations property instead. + type: array + items: + $ref: '#/components/schemas/Reservation' + licenseResource: + description: The license specification required as part of a license commitment. + $ref: '#/components/schemas/LicenseResourceCommitment' + autoRenew: + description: >- + Specifies whether to automatically renew the commitment at the end + of its current term. The default value is false. If you set the + field to true, each time your commitment reaches the end of its + term, Compute Engine automatically renews it for another term. You + can update this field anytime before the commitment expires. For + example, if the commitment is set to expire at 12 AM UTC-8 on + January 3, 2027, you can update this field until 11:59 PM UTC-8 on + January 2, 2027. + type: boolean + mergeSourceCommitments: + description: >- + The list of source commitments that you are merging to create the + new merged commitment. For more information, see Merging + commitments. + type: array + items: + type: string + splitSourceCommitment: + description: >- + The source commitment from which you are transferring resources to + create the new split commitment. For more information, see Split + commitments. + type: string + resourceStatus: + description: '[Output Only] Status information for Commitment resource.' + $ref: '#/components/schemas/CommitmentResourceStatus' + existingReservations: + type: array + items: + type: string + customEndTimestamp: + description: >- + [Input Only] Optional, specifies the requested commitment end time + in RFC3339 text format. Use this option when the desired + commitment's end date is later than the start date + term duration. + type: string + ResourceCommitment: + id: ResourceCommitment + description: >- + Commitment for a particular hardware resource (a commitment is composed + of one or more of these). + type: object + properties: + type: + description: >- + The type of hardware resource that you want to specify. You can + specify any of the following values: - VCPU - MEMORY - LOCAL_SSD - + ACCELERATOR Specify as a separate entry in the list for each + individual resource type. + type: string + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + enum: + - ACCELERATOR + - LOCAL_SSD + - MEMORY + - UNSPECIFIED + - VCPU + amount: + description: >- + The quantity of the hardware resource that you want to commit to + purchasing (in a type-dependent unit). - For vCPUs, you must specify + an integer value. - For memory, you specify the amount of MB that + you want. The value you specify must be a multiple of 256 MB, with + up to 6.5 GB of memory per every vCPU. - For GPUs, you must specify + an integer value. - For Local SSD disks, you must specify the amount + in GB. The size of a single Local SSD disk is 375 GB. + type: string + format: int64 + acceleratorType: + description: >- + Name of the accelerator type or GPU resource. Specify this field + only when the type of hardware resource is ACCELERATOR. + type: string + LicenseResourceCommitment: + id: LicenseResourceCommitment + description: Commitment for a particular license resource. + type: object + properties: + license: + description: The applicable license URI. + type: string + amount: + description: The number of licenses you plan to purchase. + type: string + format: int64 + coresPerLicense: + description: The number of cores per license. + type: string + CommitmentResourceStatus: + id: CommitmentResourceStatus + description: '[Output Only] Contains output only fields.' + type: object + properties: + customTermEligibilityEndTimestamp: + description: >- + [Output Only] Indicates the end time of customer's eligibility to + send custom term requests in RFC3339 text format. Term extension + requests that (not the end time in the request) after this time will + be rejected. + type: string + CommitmentAggregatedList: + id: CommitmentAggregatedList type: object properties: kind: - description: Type of resource. - default: compute#forwardingRuleList + description: >- + [Output Only] Type of resource. Always + compute#commitmentAggregatedList for aggregated lists of + commitments. + default: compute#commitmentAggregatedList type: string id: description: >- @@ -23185,10 +23450,13 @@ components: server. type: string items: - description: A list of ForwardingRule resources. - type: array - items: - $ref: '#/components/schemas/ForwardingRule' + description: A list of CommitmentsScopedList resources. + type: object + additionalProperties: + description: >- + [Output Only] Name of the scope containing this set of + commitments. + $ref: '#/components/schemas/CommitmentsScopedList' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -23264,6 +23532,195 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). + - >- + The user attempted to use a resource that requires a TOS they + have not accepted. + - Warning that a resource is in use. + - >- + One or more of the resources set to auto-delete could not be + deleted because they were in use. + - When a resource schema validation is ignored. + - >- + Instance template used in instance group manager is valid as + such, but its application does not make a lot of sense, + because it allows only single instance in instance group. + - When undeclared properties in the schema are present + - A given scope cannot be reached. + enumDeprecated: + - false + - false + - false + - false + - false + - false + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + enum: + - CLEANUP_FAILED + - DEPRECATED_RESOURCE_USED + - DEPRECATED_TYPE_USED + - DISK_SIZE_LARGER_THAN_IMAGE_SIZE + - EXPERIMENTAL_TYPE_USED + - EXTERNAL_API_WARNING + - FIELD_VALUE_OVERRIDEN + - INJECTED_KERNELS_DEPRECATED + - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB + - LARGE_DEPLOYMENT_WARNING + - LIST_OVERHEAD_QUOTA_EXCEED + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE + - NEXT_HOP_INSTANCE_NOT_FOUND + - NEXT_HOP_INSTANCE_NOT_ON_NETWORK + - NEXT_HOP_NOT_RUNNING + - NOT_CRITICAL_ERROR + - NO_RESULTS_ON_PAGE + - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE + - REQUIRED_TOS_AGREEMENT + - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING + - RESOURCE_NOT_DELETED + - SCHEMA_VALIDATION_IGNORED + - SINGLE_INSTANCE_PROPERTY_TEMPLATE + - UNDECLARED_PROPERTIES + - UNREACHABLE + message: + description: '[Output Only] A human-readable description of the warning code.' + type: string + data: + description: >- + [Output Only] Metadata about this warning in key: value format. + For example: "data": [ { "key": "scope", "value": + "zones/us-east1-d" } + type: array + items: + type: object + properties: + key: + description: >- + [Output Only] A key that provides more detail on the + warning being returned. For example, for warnings where + there are no results in a list request for a particular + zone, this key might be scope and the key value might be + the zone name. Other examples might be a key indicating a + deprecated resource and a suggested replacement, or a + warning about invalid network settings (for example, if an + instance attempts to perform IP forwarding but is not + enabled for IP forwarding). + type: string + value: + description: >- + [Output Only] A warning data value corresponding to the + key. + type: string + unreachables: + description: '[Output Only] Unreachable resources.' + type: array + items: + type: string + CommitmentsScopedList: + id: CommitmentsScopedList + type: object + properties: + commitments: + description: '[Output Only] The list of commitments contained in this scope.' + type: array + items: + $ref: '#/components/schemas/Commitment' + warning: + description: >- + [Output Only] Informational warning which replaces the list of + commitments when the list is empty. + type: object + properties: + code: + description: >- + [Output Only] A warning code, if applicable. For example, + Compute Engine returns NO_RESULTS_ON_PAGE if there are no + results in the response. + type: string + enumDescriptions: + - >- + Warning about failed cleanup of transient changes made by a + failed operation. + - A link to a deprecated resource was created. + - >- + When deploying and at least one of the resources has a type + marked as deprecated + - The user created a boot disk that is larger than image size. + - >- + When deploying and at least one of the resources has a type + marked as experimental + - Warning that is present in an external api call + - >- + Warning that value of a field has been overridden. Deprecated + unused field. + - >- + The operation involved use of an injected kernel, which is + deprecated. + - >- + A WEIGHTED_MAGLEV backend service is associated with a health + check that is not of type HTTP/HTTPS/HTTP2. + - >- + When deploying a deployment with a exceedingly large number of + resources + - >- + Resource can't be retrieved due to list overhead quota exceed + which captures the amount of resources filtered out by + user-defined list filter. + - A resource depends on a missing type + - >- + The route's nextHopIp address is not assigned to an instance + on the network. + - The route's next hop instance cannot ip forward. + - >- + The route's nextHopInstance URL refers to an instance that + does not have an ipv6 interface on the same network as the + route. + - >- + The route's nextHopInstance URL refers to an instance that + does not exist. + - >- + The route's nextHopInstance URL refers to an instance that is + not on the same network as the route. + - >- + The route's next hop instance does not have a status of + RUNNING. + - >- + Error which is not critical. We decided to continue the + process despite the mentioned error. + - No results are present on a particular list page. + - >- + Success is reported, but some results may be missing due to + errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -23307,6 +23764,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -23329,6 +23787,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -23365,565 +23824,37 @@ components: [Output Only] A warning data value corresponding to the key. type: string - ForwardingRule: - id: 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 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. + DiskTypeList: + id: DiskTypeList + description: Contains a list of disk types. type: object properties: kind: description: >- - [Output Only] Type of the resource. Always compute#forwardingRule - for forwarding rule resources. - default: compute#forwardingRule + [Output Only] Type of resource. Always compute#diskTypeList for disk + types. + default: compute#diskTypeList type: string id: description: >- - [Output Only] The unique identifier for the resource. This - identifier is defined by the server. - type: string - format: uint64 - creationTimestamp: - description: '[Output Only] Creation timestamp in RFC3339 text format.' - 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. 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])?' + [Output Only] Unique identifier for the resource; defined by the + server. type: string - description: + items: + description: A list of DiskType resources. + type: array + items: + $ref: '#/components/schemas/DiskType' + nextPageToken: description: >- - An optional description of this resource. Provide this property when - you create the resource. + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. 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 - IPAddress: - description: >- - IP address for which this forwarding rule accepts traffic. When a - client sends traffic to this IP address, the forwarding rule directs - the traffic to the referenced target or backendService. While - creating a forwarding rule, specifying an IPAddress is required - under the following circumstances: - When the target is set to - targetGrpcProxy and validateForProxyless is set to true, the - IPAddress should be set to 0.0.0.0. - When the target is a Private - Service Connect Google APIs bundle, you must specify an IPAddress. - Otherwise, you can optionally specify an IP address that references - an existing static (reserved) IP address resource. When omitted, - Google Cloud assigns an ephemeral IP address. Use one of the - following formats to specify an IP address while creating a - forwarding rule: * IP address number, as in `100.1.2.3` * IPv6 - address range, as in `2600:1234::/96` * Full resource 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 forwarding rule's - target or backendService, and in most cases, also the - loadBalancingScheme, 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). - When reading an IPAddress, the API always returns the IP address - number. - 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). - type: string - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - enum: - - AH - - ESP - - ICMP - - L3_DEFAULT - - SCTP - - TCP - - UDP - portRange: - description: >- - The ports, portRange, and allPorts fields are mutually exclusive. - Only packets addressed to ports in the specified range will be - forwarded to the backends configured with this forwarding rule. The - portRange field has the following limitations: - It requires that - the forwarding rule IPProtocol be TCP, UDP, or SCTP, and - It's - applicable only to the following products: external passthrough - Network Load Balancers, internal and external proxy Network Load - Balancers, internal and external Application Load Balancers, - external protocol forwarding, and Classic VPN. - Some products have - restrictions on what ports can be used. See port specifications for - details. For external forwarding rules, two or more forwarding rules - cannot use the same [IPAddress, IPProtocol] pair, and cannot have - overlapping portRanges. For internal forwarding rules within the - same VPC network, two or more forwarding rules cannot use the same - [IPAddress, IPProtocol] pair, and cannot have overlapping - portRanges. @pattern: \\d+(?:-\\d+)? - type: string - ports: - description: >- - The ports, portRange, and allPorts fields are mutually exclusive. - Only packets addressed to ports in the specified range will be - forwarded to the backends configured with this forwarding rule. The - ports field has the following limitations: - It requires that the - forwarding rule IPProtocol be TCP, UDP, or SCTP, and - It's - applicable only to the following products: internal passthrough - Network Load Balancers, backend service-based external passthrough - Network Load Balancers, and internal protocol forwarding. - You can - specify a list of up to five ports by number, separated by commas. - The ports can be contiguous or discontiguous. For external - forwarding rules, two or more forwarding rules cannot use the same - [IPAddress, IPProtocol] pair if they share at least one port number. - For internal forwarding rules within the same VPC network, two or - more forwarding rules cannot use the same [IPAddress, IPProtocol] - pair if they share at least one port number. @pattern: - \\d+(?:-\\d+)? - type: array - items: - type: string - target: - description: >- - The URL of the target resource to receive the matched traffic. For - regional forwarding rules, this target must be in the same region as - the forwarding rule. For global forwarding rules, this target must - be a global load balancing resource. The forwarded traffic must be - of a type appropriate to the target object. - For load balancers, - see the "Target" column in [Port - specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). - - For Private Service Connect forwarding rules that forward traffic - to Google APIs, provide the name of a supported Google API bundle: - - vpc-sc - APIs that support VPC Service Controls. - all-apis - All - supported Google APIs. - For Private Service Connect forwarding - rules that forward traffic to managed services, the target must be a - service attachment. The target is not mutable once set as a service - attachment. - type: string - selfLink: - description: '[Output Only] Server-defined URL for the resource.' - type: string - loadBalancingScheme: - description: >- - Specifies the forwarding rule type. For more information about - forwarding rules, refer to Forwarding rule concepts. - type: string - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - enum: - - EXTERNAL - - EXTERNAL_MANAGED - - INTERNAL - - INTERNAL_MANAGED - - INTERNAL_SELF_MANAGED - - INVALID - subnetwork: - description: >- - This field identifies the subnetwork that the load balanced IP - should belong to for this forwarding rule, used with internal load - balancers and external passthrough Network Load Balancers 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 - network: - description: >- - This field is not used for global external load balancing. For - internal passthrough Network Load Balancers, this field identifies - the network that the load balanced IP should belong to for this - forwarding rule. If the subnetwork is specified, the network of the - subnetwork will be used. If neither subnetwork nor this field is - 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 - backendService: - description: >- - Identifies the backend service to which the forwarding rule sends - traffic. Required for internal and external passthrough Network Load - Balancers; must be omitted for all other load balancer types. - type: string - serviceDirectoryRegistrations: - description: >- - Service Directory resources to register this forwarding rule with. - Currently, only supports a single Service Directory resource. - type: array - items: - $ref: '#/components/schemas/ForwardingRuleServiceDirectoryRegistration' - 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 - 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. - type: string - enumDescriptions: - - Public internet quality with fixed bandwidth. - - >- - High quality, Google-grade network tier, support for all - networking products. - - >- - Public internet quality, only limited support for other networking - products. - - >- - (Output only) Temporary tier for FIXED_STANDARD when fixed - standard tier is expired or not configured. - enum: - - FIXED_STANDARD - - PREMIUM - - STANDARD - - STANDARD_OVERRIDES_FIXED_STANDARD - labels: - 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 - additionalProperties: - 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. - type: string - format: byte - ipVersion: - description: >- - The IP Version that will be used by this forwarding rule. Valid - options are IPV4 or IPV6. - type: string - enumDescriptions: - - '' - - '' - - '' - enum: - - IPV4 - - IPV6 - - UNSPECIFIED_VERSION - 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. - type: string - format: byte - allPorts: - description: >- - The ports, portRange, and allPorts fields are mutually exclusive. - Only packets addressed to ports in the specified range will be - forwarded to the backends configured with this forwarding rule. The - allPorts field has the following limitations: - It requires that the - forwarding rule IPProtocol be TCP, UDP, SCTP, or L3_DEFAULT. - It's - applicable only to the following products: internal passthrough - Network Load Balancers, backend service-based external passthrough - Network Load Balancers, and internal and external protocol - forwarding. - Set this field to true to allow packets addressed to - any port or packets lacking destination port information (for - example, UDP fragments after the first fragment) to be forwarded to - the backends configured with this forwarding rule. The L3_DEFAULT - protocol requires allPorts be set to true. - type: boolean - allowGlobalAccess: - description: >- - If set to true, clients can access the internal passthrough Network - Load Balancers, the regional internal Application Load Balancer, and - the regional internal proxy Network Load Balancer from all regions. - If false, only allows access from the local region the load balancer - is located at. Note that for INTERNAL_MANAGED forwarding rules, this - field cannot be changed after the forwarding rule is created. - type: boolean - 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. - type: array - items: - $ref: '#/components/schemas/MetadataFilter' - 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 - sourceIpRanges: - description: >- - If not empty, this forwarding rule will only forward the traffic - when the source IP address matches one of the IP addresses or CIDR - ranges set here. Note that a forwarding rule can only have up to 64 - source IP ranges, and this field can only be used with a regional - forwarding rule whose scheme is EXTERNAL. Each source_ip_range entry - should be either an IP address (for example, 1.2.3.4) or a CIDR - range (for example, 1.2.3.0/24). - type: array - items: - type: string - pscConnectionId: - description: '[Output Only] The PSC connection id of the PSC forwarding rule.' - type: string - format: uint64 - pscConnectionStatus: - type: string - enumDescriptions: - - The connection has been accepted by the producer. - - >- - The connection has been closed by the producer and will not serve - traffic going forward. - - >- - The connection has been accepted by the producer, but the producer - needs to take further action before the forwarding rule can serve - traffic. - - The connection is pending acceptance by the producer. - - The connection has been rejected by the producer. - - '' - enum: - - ACCEPTED - - CLOSED - - NEEDS_ATTENTION - - PENDING - - REJECTED - - STATUS_UNSPECIFIED - baseForwardingRule: - description: >- - [Output Only] The URL for the corresponding base forwarding rule. By - base forwarding rule, we mean the forwarding rule that has the same - IP address, protocol, and port settings with the current forwarding - rule, but without sourceIPRanges specified. Always empty if the - current forwarding rule does not have sourceIPRanges specified. - type: string - allowPscGlobalAccess: - description: >- - This is used in PSC consumer ForwardingRule to control whether the - PSC endpoint can be accessed from another region. - type: boolean - noAutomateDnsZone: - description: >- - This is used in PSC consumer ForwardingRule to control whether it - should try to auto-generate a DNS zone or not. Non-PSC forwarding - rules do not use this field. Once set, this field is not mutable. - type: boolean - ipCollection: - description: >- - Resource reference of a PublicDelegatedPrefix. The PDP must be a - sub-PDP in EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode. Use one of - the following formats to specify a sub-PDP when creating an IPv6 - NetLB forwarding rule using BYOIP: Full resource URL, as in - https://www.googleapis.com/compute/v1/projects/project_id/regions/region - /publicDelegatedPrefixes/sub-pdp-name Partial URL, as in: - - projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name - - regions/region/publicDelegatedPrefixes/sub-pdp-name - type: string - ForwardingRuleServiceDirectoryRegistration: - id: 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. - type: object - 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 - MetadataFilter: - id: MetadataFilter - description: >- - Opaque filter criteria used by load balancers to restrict routing - configuration to a limited set of load balancing proxies. Proxies and - sidecars involved in load balancing would typically present metadata to - the load balancers that 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 load - balancing involves Envoys, they receive routing configuration when - values in metadataFilters match values supplied in of their XDS requests - to loadbalancers. - type: object - properties: - filterMatchCriteria: - description: >- - Specifies how individual filter label matches within the list of - filterLabels and contributes toward 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. - type: string - enumDescriptions: - - >- - Specifies that all filterLabels must match for the metadataFilter - to be considered a match. - - >- - Specifies that any filterLabel must match for the metadataFilter - to be considered a match. - - >- - Indicates that the match criteria was not set. A metadataFilter - must never be created with this value. - enum: - - MATCH_ALL - - MATCH_ANY - - NOT_SET - 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. - type: array - items: - $ref: '#/components/schemas/MetadataFilterLabelMatch' - MetadataFilterLabelMatch: - id: MetadataFilterLabelMatch - description: >- - MetadataFilter label name value pairs that are expected to match - corresponding labels presented as metadata to the load balancer. - type: object - 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 - TargetReference: - id: TargetReference - type: object - properties: - target: - type: string - ForwardingRuleAggregatedList: - id: ForwardingRuleAggregatedList - type: object - properties: - kind: - description: >- - [Output Only] Type of resource. Always - compute#forwardingRuleAggregatedList for lists of forwarding rules. - default: compute#forwardingRuleAggregatedList - type: string - id: - description: >- - [Output Only] Unique identifier for the resource; defined by the - server. - type: string - items: - description: A list of ForwardingRulesScopedList resources. - type: object - additionalProperties: - description: Name of the scope containing this set of addresses. - $ref: '#/components/schemas/ForwardingRulesScopedList' - nextPageToken: - description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. - type: string - selfLink: - description: '[Output Only] Server-defined URL for this resource.' + selfLink: + description: '[Output Only] Server-defined URL for this resource.' type: string warning: description: '[Output Only] Informational warning message.' @@ -23989,6 +23920,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -24032,6 +23966,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -24054,6 +23989,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -24090,24 +24026,103 @@ components: [Output Only] A warning data value corresponding to the key. type: string - unreachables: - description: '[Output Only] Unreachable resources.' - type: array - items: - type: string - ForwardingRulesScopedList: - id: ForwardingRulesScopedList - type: object - properties: - forwardingRules: - description: A list of forwarding rules contained in this scope. - type: array - items: - $ref: '#/components/schemas/ForwardingRule' - warning: + DiskType: + id: 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. + type: object + properties: + kind: description: >- - Informational warning which replaces the list of forwarding rules - when the list is empty. + [Output Only] Type of the resource. Always compute#diskType for disk + types. + default: compute#diskType + type: string + id: + description: >- + [Output Only] The unique identifier for the resource. This + identifier is defined by the server. + type: string + format: uint64 + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + name: + description: '[Output Only] Name of the resource.' + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + description: + description: '[Output Only] An optional description of this resource.' + type: string + validDiskSize: + description: >- + [Output Only] An optional textual description of the valid disk + size, such as "10GB-10TB". + type: string + deprecated: + description: '[Output Only] The deprecation status associated with this disk type.' + $ref: '#/components/schemas/DeprecationStatus' + 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 + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + defaultDiskSizeGb: + description: '[Output Only] Server-defined default disk size in GB.' + type: string + format: int64 + 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 + DiskTypeAggregatedList: + id: DiskTypeAggregatedList + type: object + properties: + kind: + description: >- + [Output Only] Type of resource. Always + compute#diskTypeAggregatedList. + default: compute#diskTypeAggregatedList + type: string + id: + description: >- + [Output Only] Unique identifier for the resource; defined by the + server. + type: string + items: + description: A list of DiskTypesScopedList resources. + type: object + additionalProperties: + description: '[Output Only] Name of the scope containing this set of disk types.' + $ref: '#/components/schemas/DiskTypesScopedList' + nextPageToken: + description: >- + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. + type: string + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string + warning: + description: '[Output Only] Informational warning message.' type: object properties: code: @@ -24170,6 +24185,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -24213,6 +24231,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -24235,6 +24254,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -24271,39 +24291,24 @@ components: [Output Only] A warning data value corresponding to the key. type: string - HealthCheckServicesList: - id: HealthCheckServicesList + unreachables: + description: '[Output Only] Unreachable resources.' + type: array + items: + type: string + DiskTypesScopedList: + id: DiskTypesScopedList type: object properties: - kind: - description: >- - [Output Only] Type of the resource. Always - compute#healthCheckServicesList for lists of HealthCheckServices. - default: compute#healthCheckServicesList - type: string - id: - description: >- - [Output Only] Unique identifier for the resource; defined by the - server. - type: string - items: - description: A list of HealthCheckService resources. + diskTypes: + description: '[Output Only] A list of disk types contained in this scope.' type: array items: - $ref: '#/components/schemas/HealthCheckService' - nextPageToken: - description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. - type: string - selfLink: - description: '[Output Only] Server-defined URL for this resource.' - type: string + $ref: '#/components/schemas/DiskType' warning: - description: '[Output Only] Informational warning message.' + description: >- + [Output Only] Informational warning which replaces the list of disk + types when the list is empty. type: object properties: code: @@ -24366,6 +24371,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -24409,6 +24417,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -24431,6 +24440,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -24467,132 +24477,15 @@ components: [Output Only] A warning data value corresponding to the key. type: string - HealthCheckService: - id: HealthCheckService - description: Represents a Health-Check as a Service resource. + RegionDiskTypeList: + id: RegionDiskTypeList type: object properties: kind: description: >- - [Output only] Type of the resource. Always - compute#healthCheckServicefor health check services. - default: compute#healthCheckService - type: string - id: - description: >- - [Output Only] The unique identifier for the resource. This - identifier is defined by the server. - type: string - format: uint64 - creationTimestamp: - description: '[Output Only] Creation timestamp in RFC3339 text format.' - type: string - selfLink: - description: '[Output Only] Server-defined URL for the resource.' - 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 - description: - description: >- - An optional description of this resource. Provide this property when - you create the resource. - type: string - 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 - 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. . This is only allowed - with regional HealthCheckService. - type: string - enumDescriptions: - - >- - If any backend's health check reports UNHEALTHY, then UNHEALTHY is - the HealthState of the entire health check service. If all - backend's are healthy, the HealthState of the health check service - is HEALTHY. - - >- - An EndpointHealth message is returned for each backend in the - health check service. - enum: - - AND - - NO_AGGREGATION - healthChecks: - description: >- - A list of URLs to the HealthCheck resources. Must have at least one - HealthCheck, and not more than 10 for regional HealthCheckService, - and not more than 1 for global HealthCheckService. 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 NetworkEndpointGroups. For global - HealthCheckService using global INTERNET_IP_PORT - NetworkEndpointGroups, the global HealthChecks must specify - sourceRegions, and HealthChecks that specify sourceRegions can only - be used with global INTERNET_IP_PORT NetworkEndpointGroups. - type: array - items: - 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. For global - HealthCheckServices, the NetworkEndpointGroups must be global - INTERNET_IP_PORT. - type: array - items: - type: string - 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. - type: array - items: - 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. - type: string - format: byte - HealthCheckList: - id: HealthCheckList - description: Contains a list of HealthCheck resources. - type: object - properties: - kind: - description: Type of resource. - default: compute#healthCheckList + [Output Only] Type of resource. Always compute#regionDiskTypeList + for region disk types. + default: compute#regionDiskTypeList type: string id: description: >- @@ -24600,10 +24493,10 @@ components: server. type: string items: - description: A list of HealthCheck resources. + description: A list of DiskType resources. type: array items: - $ref: '#/components/schemas/HealthCheck' + $ref: '#/components/schemas/DiskType' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -24679,6 +24572,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -24722,6 +24618,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -24744,6 +24641,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -24780,27 +24678,231 @@ components: [Output Only] A warning data value corresponding to the key. type: string - HealthCheck: - id: HealthCheck + InterconnectAttachmentList: + id: InterconnectAttachmentList description: >- - Represents a health check resource. Google Compute Engine has two health - check resources: * - [Regional](/compute/docs/reference/rest/v1/regionHealthChecks) * - [Global](/compute/docs/reference/rest/v1/healthChecks) These health - check resources can be used for load balancing and for autohealing VMs - in a managed instance group (MIG). **Load balancing** Health check - requirements vary depending on the type of load balancer. For details - about the type of health check supported for each load balancer and - corresponding backend type, see Health checks overview: Load balancer - guide. **Autohealing in MIGs** The health checks that you use for - autohealing VMs in a MIG can be either regional or global. For more - information, see Set up an application health check and autohealing. For - more information, see Health checks overview. + Response to the list request, and contains a list of interconnect + attachments. type: object properties: kind: - description: Type of the resource. - default: compute#healthCheck + description: >- + [Output Only] Type of resource. Always + compute#interconnectAttachmentList for lists of interconnect + attachments. + default: compute#interconnectAttachmentList + type: string + id: + description: >- + [Output Only] Unique identifier for the resource; defined by the + server. + type: string + items: + description: A list of InterconnectAttachment resources. + type: array + items: + $ref: '#/components/schemas/InterconnectAttachment' + nextPageToken: + description: >- + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. + type: string + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string + warning: + description: '[Output Only] Informational warning message.' + type: object + properties: + code: + description: >- + [Output Only] A warning code, if applicable. For example, + Compute Engine returns NO_RESULTS_ON_PAGE if there are no + results in the response. + type: string + enumDescriptions: + - >- + Warning about failed cleanup of transient changes made by a + failed operation. + - A link to a deprecated resource was created. + - >- + When deploying and at least one of the resources has a type + marked as deprecated + - The user created a boot disk that is larger than image size. + - >- + When deploying and at least one of the resources has a type + marked as experimental + - Warning that is present in an external api call + - >- + Warning that value of a field has been overridden. Deprecated + unused field. + - >- + The operation involved use of an injected kernel, which is + deprecated. + - >- + A WEIGHTED_MAGLEV backend service is associated with a health + check that is not of type HTTP/HTTPS/HTTP2. + - >- + When deploying a deployment with a exceedingly large number of + resources + - >- + Resource can't be retrieved due to list overhead quota exceed + which captures the amount of resources filtered out by + user-defined list filter. + - A resource depends on a missing type + - >- + The route's nextHopIp address is not assigned to an instance + on the network. + - The route's next hop instance cannot ip forward. + - >- + The route's nextHopInstance URL refers to an instance that + does not have an ipv6 interface on the same network as the + route. + - >- + The route's nextHopInstance URL refers to an instance that + does not exist. + - >- + The route's nextHopInstance URL refers to an instance that is + not on the same network as the route. + - >- + The route's next hop instance does not have a status of + RUNNING. + - >- + Error which is not critical. We decided to continue the + process despite the mentioned error. + - No results are present on a particular list page. + - >- + Success is reported, but some results may be missing due to + errors + - >- + Quota information is not available to client requests (e.g: + regions.list). + - >- + The user attempted to use a resource that requires a TOS they + have not accepted. + - Warning that a resource is in use. + - >- + One or more of the resources set to auto-delete could not be + deleted because they were in use. + - When a resource schema validation is ignored. + - >- + Instance template used in instance group manager is valid as + such, but its application does not make a lot of sense, + because it allows only single instance in instance group. + - When undeclared properties in the schema are present + - A given scope cannot be reached. + enumDeprecated: + - false + - false + - false + - false + - false + - false + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + enum: + - CLEANUP_FAILED + - DEPRECATED_RESOURCE_USED + - DEPRECATED_TYPE_USED + - DISK_SIZE_LARGER_THAN_IMAGE_SIZE + - EXPERIMENTAL_TYPE_USED + - EXTERNAL_API_WARNING + - FIELD_VALUE_OVERRIDEN + - INJECTED_KERNELS_DEPRECATED + - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB + - LARGE_DEPLOYMENT_WARNING + - LIST_OVERHEAD_QUOTA_EXCEED + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE + - NEXT_HOP_INSTANCE_NOT_FOUND + - NEXT_HOP_INSTANCE_NOT_ON_NETWORK + - NEXT_HOP_NOT_RUNNING + - NOT_CRITICAL_ERROR + - NO_RESULTS_ON_PAGE + - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE + - REQUIRED_TOS_AGREEMENT + - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING + - RESOURCE_NOT_DELETED + - SCHEMA_VALIDATION_IGNORED + - SINGLE_INSTANCE_PROPERTY_TEMPLATE + - UNDECLARED_PROPERTIES + - UNREACHABLE + message: + description: '[Output Only] A human-readable description of the warning code.' + type: string + data: + description: >- + [Output Only] Metadata about this warning in key: value format. + For example: "data": [ { "key": "scope", "value": + "zones/us-east1-d" } + type: array + items: + type: object + properties: + key: + description: >- + [Output Only] A key that provides more detail on the + warning being returned. For example, for warnings where + there are no results in a list request for a particular + zone, this key might be scope and the key value might be + the zone name. Other examples might be a key indicating a + deprecated resource and a suggested replacement, or a + warning about invalid network settings (for example, if an + instance attempts to perform IP forwarding but is not + enabled for IP forwarding). + type: string + value: + description: >- + [Output Only] A warning data value corresponding to the + key. + type: string + InterconnectAttachment: + id: 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. + type: object + properties: + kind: + description: >- + [Output Only] Type of the resource. Always + compute#interconnectAttachment for interconnect attachments. + default: compute#interconnectAttachment + type: string + description: + description: An optional description of this resource. + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' type: string id: description: >- @@ -24809,609 +24911,497 @@ components: type: string format: uint64 creationTimestamp: - description: '[Output Only] Creation timestamp in 3339 text format.' + description: '[Output Only] Creation timestamp in RFC3339 text format.' 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. 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. + 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 - description: + interconnect: description: >- - An optional description of this resource. Provide this property when - you create the resource. + URL of the underlying Interconnect object that this attachment's + traffic will traverse through. type: string - checkIntervalSec: - description: >- - How often (in seconds) to send a health check. The default value is - 5 seconds. - type: integer - format: int32 - 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. - type: integer - format: int32 - unhealthyThreshold: - description: >- - A so-far healthy instance will be marked unhealthy after this many - consecutive failures. The default value is 2. - type: integer - format: int32 - healthyThreshold: - description: >- - A so-far unhealthy instance will be marked healthy after this many - consecutive successes. The default value is 2. - type: integer - format: int32 - type: + router: description: >- - Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, - HTTP2 or GRPC. Exactly one of the protocol-specific health check - fields must be specified, which must match type field. + 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 - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - enum: - - GRPC - - HTTP - - HTTP2 - - HTTPS - - INVALID - - SSL - - TCP - tcpHealthCheck: - $ref: '#/components/schemas/TCPHealthCheck' - sslHealthCheck: - $ref: '#/components/schemas/SSLHealthCheck' - httpHealthCheck: - $ref: '#/components/schemas/HTTPHealthCheck' - httpsHealthCheck: - $ref: '#/components/schemas/HTTPSHealthCheck' - http2HealthCheck: - $ref: '#/components/schemas/HTTP2HealthCheck' - grpcHealthCheck: - $ref: '#/components/schemas/GRPCHealthCheck' - sourceRegions: + region: description: >- - The list of cloud regions from which health checks are performed. If - any regions are specified, then exactly 3 regions should be - specified. The region names must be valid names of Google Cloud - regions. This can only be set for global health check. If this list - is non-empty, then there are restrictions on what other health check - fields are supported and what other resources can use this health - check: - SSL, HTTP2, and GRPC protocols are not supported. - The TCP - request field is not supported. - The proxyHeader field for HTTP, - HTTPS, and TCP is not supported. - The checkIntervalSec field must - be at least 30. - The health check cannot be used with - BackendService nor with managed instance group auto-healing. - type: array - items: - type: string - selfLink: - description: '[Output Only] Server-defined URL for the resource.' + [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 - region: + googleReferenceId: description: >- - [Output Only] Region where the health check resides. Not applicable - to global health checks. + [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. + deprecated: true type: string - logConfig: - description: Configure logging on this health check. - $ref: '#/components/schemas/HealthCheckLogConfig' - TCPHealthCheck: - id: TCPHealthCheck - type: object - properties: - port: + mtu: description: >- - The TCP port number to which the health check prober sends packets. - The default value is 80. Valid values are 1 through 65535. + Maximum Transmission Unit (MTU), in bytes, of packets passing + through this interconnect attachment. Valid values are 1440, 1460, + 1500, and 8896. If not specified, the value will default to 1440. type: integer format: int32 - portName: - description: Not supported. - type: string - portSpecification: + privateInterconnectInfo: description: >- - Specifies how a port is selected for health checking. Can be one of - the following values: USE_FIXED_PORT: Specifies a port number - explicitly using the port field in the health check. Supported by - backend services for passthrough load balancers and backend services - for proxy load balancers. Not supported by target pools. The health - check supports all backends supported by the backend service - provided the backend can be health checked. For example, GCE_VM_IP - network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and - instance group backends. USE_NAMED_PORT: Not supported. - USE_SERVING_PORT: Provides an indirect method of specifying the - health check port by referring to the backend service. Only - supported by backend services for proxy load balancers. Not - supported by target pools. Not supported by backend services for - passthrough load balancers. Supports all backends that can be health - checked; for example, GCE_VM_IP_PORT network endpoint groups and - instance group backends. For GCE_VM_IP_PORT network endpoint group - backends, the health check uses the port number specified for each - endpoint in the network endpoint group. For instance group backends, - the health check uses the port number determined by looking up the - backend service's named port in the instance group's list of named - ports. + [Output Only] Information specific to an InterconnectAttachment. + This property is populated if the interconnect that this is attached + to is of type DEDICATED. + $ref: '#/components/schemas/InterconnectAttachmentPrivateInfo' + 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. type: string enumDescriptions: + - Indicates that attachment has been turned up and is ready to use. - >- - The port number in the health check's port is used for health - checking. Applies to network endpoint group and instance group - backends. - - Not supported. - - >- - For network endpoint group backends, the health check uses the - port number specified on each endpoint in the network endpoint - group. For instance group backends, the health check uses the port - number specified for the backend service's named port defined in - the instance group's named ports. + Indicates that attachment is not ready to use yet, because turnup + is not complete. enum: - - USE_FIXED_PORT - - USE_NAMED_PORT - - USE_SERVING_PORT - request: + - OS_ACTIVE + - OS_UNPROVISIONED + cloudRouterIpAddress: description: >- - Instructs the health check prober to send this exact ASCII string, - up to 1024 bytes in length, after establishing the TCP connection. + [Output Only] IPv4 address + prefix length to be configured on Cloud + Router Interface for this interconnect attachment. type: string - response: + customerRouterIpAddress: description: >- - Creates a content-based TCP health check. In addition to - establishing a TCP connection, you can configure the health check to - pass only when the backend sends this exact response ASCII string, - up to 1024 bytes in length. For details, see: - https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-ssl-tcp + [Output Only] IPv4 address + prefix length to be configured on the + customer router subinterface for this interconnect attachment. type: string - proxyHeader: + type: description: >- - Specifies the type of proxy header to append before sending data to - the backend, either NONE or PROXY_V1. The default is NONE. + 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. type: string enumDescriptions: - - '' - - '' + - Attachment to a dedicated interconnect. + - Attachment to a partner interconnect, created by the customer. + - Attachment to a partner interconnect, created by the partner. enum: - - NONE - - PROXY_V1 - SSLHealthCheck: - id: SSLHealthCheck - type: object - properties: - port: + - DEDICATED + - PARTNER + - PARTNER_PROVIDER + pairingKey: description: >- - The TCP port number to which the health check prober sends packets. - The default value is 443. Valid values are 1 through 65535. + [Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not + present for DEDICATED]. The opaque identifier of a PARTNER + attachment used to initiate provisioning with a selected partner. Of + the form "XXXXX/region/domain" + type: string + adminEnabled: + description: >- + Determines whether this Attachment will carry packets. Not present + for PARTNER_PROVIDER. + type: boolean + vlanTag8021q: + description: >- + The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093. + Only specified at creation time. type: integer format: int32 - portName: - description: Not supported. - type: string - portSpecification: + edgeAvailabilityDomain: description: >- - Specifies how a port is selected for health checking. Can be one of - the following values: USE_FIXED_PORT: Specifies a port number - explicitly using the port field in the health check. Supported by - backend services for passthrough load balancers and backend services - for proxy load balancers. Not supported by target pools. The health - check supports all backends supported by the backend service - provided the backend can be health checked. For example, GCE_VM_IP - network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and - instance group backends. USE_NAMED_PORT: Not supported. - USE_SERVING_PORT: Provides an indirect method of specifying the - health check port by referring to the backend service. Only - supported by backend services for proxy load balancers. Not - supported by target pools. Not supported by backend services for - passthrough load balancers. Supports all backends that can be health - checked; for example, GCE_VM_IP_PORT network endpoint groups and - instance group backends. For GCE_VM_IP_PORT network endpoint group - backends, the health check uses the port number specified for each - endpoint in the network endpoint group. For instance group backends, - the health check uses the port number determined by looking up the - backend service's named port in the instance group's list of named - ports. + Input only. 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. type: string enumDescriptions: - - >- - The port number in the health check's port is used for health - checking. Applies to network endpoint group and instance group - backends. - - Not supported. - - >- - For network endpoint group backends, the health check uses the - port number specified on each endpoint in the network endpoint - group. For instance group backends, the health check uses the port - number specified for the backend service's named port defined in - the instance group's named ports. + - '' + - '' + - '' enum: - - USE_FIXED_PORT - - USE_NAMED_PORT - - USE_SERVING_PORT - request: - description: >- - Instructs the health check prober to send this exact ASCII string, - up to 1024 bytes in length, after establishing the TCP connection - and SSL handshake. - type: string - response: + - AVAILABILITY_DOMAIN_1 + - AVAILABILITY_DOMAIN_2 + - AVAILABILITY_DOMAIN_ANY + candidateSubnets: description: >- - Creates a content-based SSL health check. In addition to - establishing a TCP connection and the TLS handshake, you can - configure the health check to pass only when the backend sends this - exact response ASCII string, up to 1024 bytes in length. For - details, see: - https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-ssl-tcp - type: string - proxyHeader: + Input only. 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. + type: array + items: + type: string + bandwidth: description: >- - Specifies the type of proxy header to append before sending data to - the backend, either NONE or PROXY_V1. The default is NONE. + 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 - BPS_100G: 100 Gbit/s type: string enumDescriptions: - - '' - - '' + - 100 Gbit/s + - 100 Mbit/s + - 10 Gbit/s + - 1 Gbit/s + - 200 Mbit/s + - 20 Gbit/s + - 2 Gbit/s + - 300 Mbit/s + - 400 Mbit/s + - 500 Mbit/s + - 50 Gbit/s + - 50 Mbit/s + - 5 Gbit/s enum: - - NONE - - PROXY_V1 - HTTPHealthCheck: - id: HTTPHealthCheck - type: object - properties: - port: + - BPS_100G + - BPS_100M + - BPS_10G + - BPS_1G + - BPS_200M + - BPS_20G + - BPS_2G + - BPS_300M + - BPS_400M + - BPS_500M + - BPS_50G + - BPS_50M + - BPS_5G + partnerMetadata: description: >- - The TCP port number to which the health check prober sends packets. - The default value is 80. Valid values are 1 through 65535. - type: integer - format: int32 - portName: - description: Not supported. + Informational metadata about Partner attachments from Partners to + display to customers. Output only for PARTNER type, mutable for + PARTNER_PROVIDER, not available for DEDICATED. + $ref: '#/components/schemas/InterconnectAttachmentPartnerMetadata' + labels: + 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 + additionalProperties: + type: string + labelFingerprint: + description: >- + A fingerprint for the labels being applied to this + InterconnectAttachment, 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 + InterconnectAttachment. type: string - portSpecification: + format: byte + state: description: >- - Specifies how a port is selected for health checking. Can be one of - the following values: USE_FIXED_PORT: Specifies a port number - explicitly using the port field in the health check. Supported by - backend services for passthrough load balancers and backend services - for proxy load balancers. Also supported in legacy HTTP health - checks for target pools. The health check supports all backends - supported by the backend service provided the backend can be health - checked. For example, GCE_VM_IP network endpoint groups, - GCE_VM_IP_PORT network endpoint groups, and instance group backends. - USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an - indirect method of specifying the health check port by referring to - the backend service. Only supported by backend services for proxy - load balancers. Not supported by target pools. Not supported by - backend services for pass-through load balancers. Supports all - backends that can be health checked; for example, GCE_VM_IP_PORT - network endpoint groups and instance group backends. For - GCE_VM_IP_PORT network endpoint group backends, the health check - uses the port number specified for each endpoint in the network - endpoint group. For instance group backends, the health check uses - the port number determined by looking up the backend service's named - port in the instance group's list of named ports. + [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. type: string enumDescriptions: + - Indicates that attachment has been turned up and is ready to use. - >- - The port number in the health check's port is used for health - checking. Applies to network endpoint group and instance group - backends. - - Not supported. + The attachment was deleted externally and is no longer functional. + This could be because the associated Interconnect was wiped out, + or because the other side of a Partner attachment was deleted. - >- - For network endpoint group backends, the health check uses the - port number specified on each endpoint in the network endpoint - group. For instance group backends, the health check uses the port - number specified for the backend service's named port defined in - the instance group's named ports. + A PARTNER attachment is in the process of provisioning after a + PARTNER_PROVIDER attachment was created that references it. + - >- + PARTNER or PARTNER_PROVIDER attachment that is waiting for the + customer to activate. + - >- + A newly created PARTNER attachment that has not yet been + configured on the Partner side. + - '' + - >- + Indicates that attachment is not ready to use yet, because turnup + is not complete. enum: - - USE_FIXED_PORT - - USE_NAMED_PORT - - USE_SERVING_PORT - host: - description: >- - The value of the host header in the HTTP health check request. If - left empty (default value), the host header is set to the - destination IP address to which health check packets are sent. The - destination IP address depends on the type of load balancer. For - details, see: - https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest - type: string - requestPath: + - ACTIVE + - DEFUNCT + - PARTNER_REQUEST_RECEIVED + - PENDING_CUSTOMER + - PENDING_PARTNER + - STATE_UNSPECIFIED + - UNPROVISIONED + partnerAsn: description: >- - The request path of the HTTP health check request. The default value - is /. Must comply with RFC3986. + 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. type: string - proxyHeader: + format: int64 + encryption: description: >- - Specifies the type of proxy header to append before sending data to - the backend, either NONE or PROXY_V1. The default is NONE. + 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 *HA VPN over + Cloud Interconnect*, the VLAN attachment must be created with this + option. type: string enumDescriptions: - - '' - - '' + - >- + The interconnect attachment will carry only encrypted traffic that + is encrypted by an IPsec device such as HA VPN gateway; VMs cannot + directly send traffic to or receive traffic from such an + interconnect attachment. To use HA VPN over Cloud Interconnect, + the interconnect attachment must be created with this option. + - >- + This is the default value, which means the Interconnect Attachment + will carry unencrypted traffic. VMs will be able to send traffic + to or receive traffic from such interconnect attachment. enum: + - IPSEC - NONE - - PROXY_V1 - response: + ipsecInternalAddresses: description: >- - Creates a content-based HTTP health check. In addition to the - required HTTP 200 (OK) status code, you can configure the health - check to pass only when the backend sends this specific ASCII - response string within the first 1024 bytes of the HTTP response - body. For details, see: - https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http - type: string - HTTPSHealthCheck: - id: HTTPSHealthCheck - type: object - properties: - port: + 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. + type: array + items: + type: string + dataplaneVersion: description: >- - The TCP port number to which the health check prober sends packets. - The default value is 443. Valid values are 1 through 65535. + [Output Only] Dataplane version for this InterconnectAttachment. + This field is only present for Dataplane version 2 and higher. + Absence of this field in the API output indicates that the Dataplane + is version 1. type: integer format: int32 - portName: - description: Not supported. - type: string - portSpecification: + satisfiesPzs: + description: '[Output Only] Reserved for future use.' + type: boolean + stackType: description: >- - Specifies how a port is selected for health checking. Can be one of - the following values: USE_FIXED_PORT: Specifies a port number - explicitly using the port field in the health check. Supported by - backend services for passthrough load balancers and backend services - for proxy load balancers. Not supported by target pools. The health - check supports all backends supported by the backend service - provided the backend can be health checked. For example, GCE_VM_IP - network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and - instance group backends. USE_NAMED_PORT: Not supported. - USE_SERVING_PORT: Provides an indirect method of specifying the - health check port by referring to the backend service. Only - supported by backend services for proxy load balancers. Not - supported by target pools. Not supported by backend services for - passthrough load balancers. Supports all backends that can be health - checked; for example, GCE_VM_IP_PORT network endpoint groups and - instance group backends. For GCE_VM_IP_PORT network endpoint group - backends, the health check uses the port number specified for each - endpoint in the network endpoint group. For instance group backends, - the health check uses the port number determined by looking up the - backend service's named port in the instance group's list of named - ports. + The stack type for this interconnect attachment 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 interconnect attachments + creation and update interconnect attachment operations. type: string enumDescriptions: - - >- - The port number in the health check's port is used for health - checking. Applies to network endpoint group and instance group - backends. - - Not supported. - - >- - For network endpoint group backends, the health check uses the - port number specified on each endpoint in the network endpoint - group. For instance group backends, the health check uses the port - number specified for the backend service's named port defined in - the instance group's named ports. + - The interconnect attachment can have both IPv4 and IPv6 addresses. + - The interconnect attachment will only be assigned IPv4 addresses. enum: - - USE_FIXED_PORT - - USE_NAMED_PORT - - USE_SERVING_PORT - host: + - IPV4_IPV6 + - IPV4_ONLY + cloudRouterIpv6Address: description: >- - The value of the host header in the HTTPS health check request. If - left empty (default value), the host header is set to the - destination IP address to which health check packets are sent. The - destination IP address depends on the type of load balancer. For - details, see: - https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest + [Output Only] IPv6 address + prefix length to be configured on Cloud + Router Interface for this interconnect attachment. type: string - requestPath: + customerRouterIpv6Address: description: >- - The request path of the HTTPS health check request. The default - value is /. Must comply with RFC3986. + [Output Only] IPv6 address + prefix length to be configured on the + customer router subinterface for this interconnect attachment. 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. + candidateIpv6Subnets: + description: This field is not available. + type: array + items: + type: string + cloudRouterIpv6InterfaceId: + description: This field is not available. type: string - enumDescriptions: - - '' - - '' - enum: - - NONE - - PROXY_V1 - response: - description: >- - Creates a content-based HTTPS health check. In addition to the - required HTTP 200 (OK) status code, you can configure the health - check to pass only when the backend sends this specific ASCII - response string within the first 1024 bytes of the HTTP response - body. For details, see: - https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http + customerRouterIpv6InterfaceId: + description: This field is not available. type: string - HTTP2HealthCheck: - id: HTTP2HealthCheck - type: object - properties: - port: + subnetLength: description: >- - The TCP port number to which the health check prober sends packets. - The default value is 443. Valid values are 1 through 65535. + Input only. Length of the IPv4 subnet mask. Allowed values: - 29 + (default) - 30 The default value is 29, except for Cross-Cloud + Interconnect connections that use an InterconnectRemoteLocation with + a constraints.subnetLengthRange.min equal to 30. For example, + connections that use an Azure remote location fall into this + category. In these cases, the default value is 30, and requesting 29 + returns an error. Where both 29 and 30 are allowed, 29 is preferred, + because it gives Google Cloud Support more debugging visibility. type: integer format: int32 - portName: - description: Not supported. - type: string - portSpecification: + remoteService: description: >- - Specifies how a port is selected for health checking. Can be one of - the following values: USE_FIXED_PORT: Specifies a port number - explicitly using the port field in the health check. Supported by - backend services for passthrough load balancers and backend services - for proxy load balancers. Not supported by target pools. The health - check supports all backends supported by the backend service - provided the backend can be health checked. For example, GCE_VM_IP - network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and - instance group backends. USE_NAMED_PORT: Not supported. - USE_SERVING_PORT: Provides an indirect method of specifying the - health check port by referring to the backend service. Only - supported by backend services for proxy load balancers. Not - supported by target pools. Not supported by backend services for - passthrough load balancers. Supports all backends that can be health - checked; for example, GCE_VM_IP_PORT network endpoint groups and - instance group backends. For GCE_VM_IP_PORT network endpoint group - backends, the health check uses the port number specified for each - endpoint in the network endpoint group. For instance group backends, - the health check uses the port number determined by looking up the - backend service's named port in the instance group's list of named - ports. + [Output Only] If the attachment is on a Cross-Cloud Interconnect + connection, this field contains the interconnect's remote location + service provider. Example values: "Amazon Web Services" "Microsoft + Azure". The field is set only for attachments on Cross-Cloud + Interconnect connections. Its value is copied from the + InterconnectRemoteLocation remoteService field. type: string - enumDescriptions: - - >- - The port number in the health check's port is used for health - checking. Applies to network endpoint group and instance group - backends. - - Not supported. - - >- - For network endpoint group backends, the health check uses the - port number specified on each endpoint in the network endpoint - group. For instance group backends, the health check uses the port - number specified for the backend service's named port defined in - the instance group's named ports. - enum: - - USE_FIXED_PORT - - USE_NAMED_PORT - - USE_SERVING_PORT - host: + configurationConstraints: description: >- - The value of the host header in the HTTP/2 health check request. If - left empty (default value), the host header is set to the - destination IP address to which health check packets are sent. The - destination IP address depends on the type of load balancer. For - details, see: - https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest + [Output Only] Constraints for this attachment, if any. The + attachment does not work if these constraints are not met. + $ref: '#/components/schemas/InterconnectAttachmentConfigurationConstraints' + attachmentGroup: + description: >- + [Output Only] URL of the AttachmentGroup that includes this + Attachment. type: string - requestPath: + InterconnectAttachmentPrivateInfo: + id: InterconnectAttachmentPrivateInfo + description: >- + Information for an interconnect attachment when this belongs to an + interconnect of type DEDICATED. + type: object + properties: + tag8021q: description: >- - The request path of the HTTP/2 health check request. The default - value is /. Must comply with RFC3986. + [Output Only] 802.1q encapsulation tag to be used for traffic + between Google and the customer, going to and from this network and + region. + type: integer + format: uint32 + InterconnectAttachmentPartnerMetadata: + id: 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. + type: object + properties: + partnerName: + description: >- + Plain text name of the Partner providing this attachment. This value + may be validated to match approved Partner values. type: string - proxyHeader: + interconnectName: description: >- - Specifies the type of proxy header to append before sending data to - the backend, either NONE or PROXY_V1. The default is NONE. + 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 - enumDescriptions: - - '' - - '' - enum: - - NONE - - PROXY_V1 - response: + portalUrl: description: >- - Creates a content-based HTTP/2 health check. In addition to the - required HTTP 200 (OK) status code, you can configure the health - check to pass only when the backend sends this specific ASCII - response string within the first 1024 bytes of the HTTP response - body. For details, see: - https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http + 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 - GRPCHealthCheck: - id: GRPCHealthCheck + InterconnectAttachmentConfigurationConstraints: + id: InterconnectAttachmentConfigurationConstraints type: object properties: - port: + bgpMd5: description: >- - The TCP port number to which the health check prober sends packets. - Valid values are 1 through 65535. - type: integer - format: int32 - portName: - description: Not supported. - type: string - portSpecification: - description: >- - Specifies how a port is selected for health checking. Can be one of - the following values: USE_FIXED_PORT: Specifies a port number - explicitly using the port field in the health check. Supported by - backend services for passthrough load balancers and backend services - for proxy load balancers. Not supported by target pools. The health - check supports all backends supported by the backend service - provided the backend can be health checked. For example, GCE_VM_IP - network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and - instance group backends. USE_NAMED_PORT: Not supported. - USE_SERVING_PORT: Provides an indirect method of specifying the - health check port by referring to the backend service. Only - supported by backend services for proxy load balancers. Not - supported by target pools. Not supported by backend services for - passthrough load balancers. Supports all backends that can be health - checked; for example, GCE_VM_IP_PORT network endpoint groups and - instance group backends. For GCE_VM_IP_PORT network endpoint group - backends, the health check uses the port number specified for each - endpoint in the network endpoint group. For instance group backends, - the health check uses the port number determined by looking up the - backend service's named port in the instance group's list of named - ports. + [Output Only] Whether the attachment's BGP session + requires/allows/disallows BGP MD5 authentication. This can take one + of the following values: MD5_OPTIONAL, MD5_REQUIRED, + MD5_UNSUPPORTED. For example, a Cross-Cloud Interconnect connection + to a remote cloud provider that requires BGP MD5 authentication has + the interconnectRemoteLocation + attachment_configuration_constraints.bgp_md5 field set to + MD5_REQUIRED, and that property is propagated to the attachment. + Similarly, if BGP MD5 is MD5_UNSUPPORTED, an error is returned if + MD5 is requested. type: string enumDescriptions: - >- - The port number in the health check's port is used for health - checking. Applies to network endpoint group and instance group - backends. - - Not supported. - - >- - For network endpoint group backends, the health check uses the - port number specified on each endpoint in the network endpoint - group. For instance group backends, the health check uses the port - number specified for the backend service's named port defined in - the instance group's named ports. + MD5_OPTIONAL: BGP MD5 authentication is supported and can + optionally be configured. + - 'MD5_REQUIRED: BGP MD5 authentication must be configured.' + - 'MD5_UNSUPPORTED: BGP MD5 authentication must not be configured' enum: - - USE_FIXED_PORT - - USE_NAMED_PORT - - USE_SERVING_PORT - grpcServiceName: + - MD5_OPTIONAL + - MD5_REQUIRED + - MD5_UNSUPPORTED + bgpPeerAsnRanges: 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 - HealthCheckLogConfig: - id: HealthCheckLogConfig - description: >- - Configuration of logging on a health check. If logging is enabled, logs - will be exported to Stackdriver. + [Output Only] List of ASN ranges that the remote location is known + to support. Formatted as an array of inclusive ranges {min: + min-value, max: max-value}. For example, [{min: 123, max: 123}, + {min: 64512, max: 65534}] allows the peer ASN to be 123 or anything + in the range 64512-65534. This field is only advisory. Although the + API accepts other ranges, these are the ranges that we recommend. + type: array + items: + $ref: >- + #/components/schemas/InterconnectAttachmentConfigurationConstraintsBgpPeerASNRange + InterconnectAttachmentConfigurationConstraintsBgpPeerASNRange: + id: InterconnectAttachmentConfigurationConstraintsBgpPeerASNRange type: object 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 - HealthChecksAggregatedList: - id: HealthChecksAggregatedList + min: + type: integer + format: uint32 + max: + type: integer + format: uint32 + InterconnectAttachmentAggregatedList: + id: InterconnectAttachmentAggregatedList type: object properties: kind: - description: Type of resource. - default: compute#healthChecksAggregatedList + description: >- + [Output Only] Type of resource. Always + compute#interconnectAttachmentAggregatedList for aggregated lists of + interconnect attachments. + default: compute#interconnectAttachmentAggregatedList type: string id: description: >- @@ -25419,11 +25409,11 @@ components: server. type: string items: - description: A list of HealthChecksScopedList resources. + description: A list of InterconnectAttachmentsScopedList resources. type: object additionalProperties: - description: Name of the scope containing this set of HealthChecks. - $ref: '#/components/schemas/HealthChecksScopedList' + description: Name of the scope containing this set of interconnect attachments. + $ref: '#/components/schemas/InterconnectAttachmentsScopedList' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -25499,6 +25489,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -25542,6 +25535,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -25564,6 +25558,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -25605,19 +25600,19 @@ components: type: array items: type: string - HealthChecksScopedList: - id: HealthChecksScopedList + InterconnectAttachmentsScopedList: + id: InterconnectAttachmentsScopedList type: object properties: - healthChecks: - description: A list of HealthChecks contained in this scope. + interconnectAttachments: + description: A list of interconnect attachments contained in this scope. type: array items: - $ref: '#/components/schemas/HealthCheck' + $ref: '#/components/schemas/InterconnectAttachment' warning: description: >- - Informational warning which replaces the list of backend services - when the list is empty. + Informational warning which replaces the list of addresses when the + list is empty. type: object properties: code: @@ -25680,6 +25675,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -25723,6 +25721,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -25745,6 +25744,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -25781,14 +25781,12 @@ components: [Output Only] A warning data value corresponding to the key. type: string - HttpHealthCheckList: - id: HttpHealthCheckList - description: Contains a list of HttpHealthCheck resources. + InterconnectAttachmentGroupsListResponse: + id: InterconnectAttachmentGroupsListResponse type: object properties: kind: - description: Type of resource. - default: compute#httpHealthCheckList + default: compute#interconnectAttachmentGroup type: string id: description: >- @@ -25796,10 +25794,10 @@ components: server. type: string items: - description: A list of HttpHealthCheck resources. + description: A list of InterconnectAttachmentGroup resources. type: array items: - $ref: '#/components/schemas/HttpHealthCheck' + $ref: '#/components/schemas/InterconnectAttachmentGroup' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -25875,6 +25873,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -25918,6 +25919,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -25940,6 +25942,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -25976,27 +25979,32 @@ components: [Output Only] A warning data value corresponding to the key. type: string - HttpHealthCheck: - id: HttpHealthCheck + etag: + type: string + unreachables: + description: >- + [Output Only] Unreachable resources. end_interface: + MixerListResponseWithEtagBuilder + type: array + items: + type: string + InterconnectAttachmentGroup: + id: InterconnectAttachmentGroup 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 . + An interconnect attachment group resource allows customers to create, + analyze, and expand highly available deployments. type: object properties: kind: description: >- - [Output Only] Type of the resource. Always compute#httpHealthCheck - for HTTP health checks. - default: compute#httpHealthCheck + [Output Only] Type of the resource. Always + compute#interconnectAttachmentGroup. + default: compute#interconnectAttachmentGroup type: string id: description: >- - [Output Only] The unique identifier for the resource. This - identifier is defined by the server. + [Output Only] The unique identifier for the resource type. The + server generates this identifier. type: string format: uint64 creationTimestamp: @@ -26018,565 +26026,387 @@ components: An optional description of this resource. Provide this property when you create the resource. type: string - 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. + selfLink: + description: '[Output Only] Server-defined URL for the resource.' type: string - requestPath: + etag: description: >- - The request path of the HTTP health check request. The default value - is /. This field does not support query parameters. Must comply with - RFC3986. + Opaque system-generated token that uniquely identifies the + configuration. If provided when patching a configuration in update + mode, the provided token must match the current token or the update + is rejected. This provides a reliable means of doing + read-modify-write (optimistic locking) as described by AIP 154. type: string - port: - description: >- - The TCP port number for the HTTP health check request. The default - value is 80. - type: integer - format: int32 - checkIntervalSec: - description: >- - How often (in seconds) to send a health check. The default value is - 5 seconds. - type: integer - format: int32 - 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. - type: integer - format: int32 - unhealthyThreshold: + attachments: description: >- - A so-far healthy instance will be marked unhealthy after this many - consecutive failures. The default value is 2. - type: integer - format: int32 - healthyThreshold: + Attachments in the AttachmentGroup. Keys are arbitrary + user-specified strings. Users are encouraged, but not required, to + use their preferred format for resource links as keys. Note that + there are add-members and remove-members methods in gcloud. The size + of this map is limited by an "Attachments per group" quota. + type: object + additionalProperties: + $ref: '#/components/schemas/InterconnectAttachmentGroupAttachment' + interconnectGroup: description: >- - A so-far unhealthy instance will be marked healthy after this many - consecutive successes. The default value is 2. - type: integer - format: int32 - selfLink: - description: '[Output Only] Server-defined URL for the resource.' + The URL of an InterconnectGroup that groups these Attachments' + Interconnects. Customers do not need to set this unless directed by + Google Support. type: string - HttpsHealthCheckList: - id: HttpsHealthCheckList - description: Contains a list of HttpsHealthCheck resources. + intent: + $ref: '#/components/schemas/InterconnectAttachmentGroupIntent' + logicalStructure: + $ref: '#/components/schemas/InterconnectAttachmentGroupLogicalStructure' + configured: + $ref: '#/components/schemas/InterconnectAttachmentGroupConfigured' + InterconnectAttachmentGroupAttachment: + id: InterconnectAttachmentGroupAttachment + description: An Attachment in this AttachmentGroup. type: object properties: - kind: - description: Type of resource. - default: compute#httpsHealthCheckList + attachment: type: string - id: - description: >- - [Output Only] Unique identifier for the resource; defined by the - server. + InterconnectAttachmentGroupIntent: + id: InterconnectAttachmentGroupIntent + description: >- + The user's intent for this AttachmentGroup. This is the only required + field besides the name that must be specified on group creation. + type: object + properties: + availabilitySla: type: string - items: - description: A list of HttpsHealthCheck resources. + enumDescriptions: + - '' + - '' + - '' + - '' + enum: + - AVAILABILITY_SLA_UNSPECIFIED + - NO_SLA + - PRODUCTION_CRITICAL + - PRODUCTION_NON_CRITICAL + InterconnectAttachmentGroupLogicalStructure: + id: InterconnectAttachmentGroupLogicalStructure + description: >- + [Output Only] An analysis of the logical layout of Attachments in this + group. Every Attachment in the group is shown once in this structure. + type: object + properties: + regions: type: array items: - $ref: '#/components/schemas/HttpsHealthCheck' - nextPageToken: - description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. + $ref: >- + #/components/schemas/InterconnectAttachmentGroupLogicalStructureRegion + InterconnectAttachmentGroupLogicalStructureRegion: + id: InterconnectAttachmentGroupLogicalStructureRegion + description: '[Output Only] The regions Attachments in this group are in.' + type: object + properties: + region: + description: '[Output Only] The name of a region, like "us-central1".' type: string - selfLink: - description: '[Output Only] Server-defined URL for this resource.' + metros: + type: array + items: + $ref: >- + #/components/schemas/InterconnectAttachmentGroupLogicalStructureRegionMetro + InterconnectAttachmentGroupLogicalStructureRegionMetro: + id: InterconnectAttachmentGroupLogicalStructureRegionMetro + description: '[Output Only] The metros of Attachments in this group in this region.' + type: object + properties: + metro: + description: >- + [Output Only] The name of the metro, as a three-letter lowercase + string like "iad". This is the first component of the location of an + Interconnect. type: string - warning: - description: '[Output Only] Informational warning message.' - type: object - properties: - code: - description: >- - [Output Only] A warning code, if applicable. For example, - Compute Engine returns NO_RESULTS_ON_PAGE if there are no - results in the response. - type: string - enumDescriptions: - - >- - Warning about failed cleanup of transient changes made by a - failed operation. - - A link to a deprecated resource was created. - - >- - When deploying and at least one of the resources has a type - marked as deprecated - - The user created a boot disk that is larger than image size. - - >- - When deploying and at least one of the resources has a type - marked as experimental - - Warning that is present in an external api call - - >- - Warning that value of a field has been overridden. Deprecated - unused field. - - >- - The operation involved use of an injected kernel, which is - deprecated. - - >- - A WEIGHTED_MAGLEV backend service is associated with a health - check that is not of type HTTP/HTTPS/HTTP2. - - >- - When deploying a deployment with a exceedingly large number of - resources - - >- - Resource can't be retrieved due to list overhead quota exceed - which captures the amount of resources filtered out by - user-defined list filter. - - A resource depends on a missing type - - >- - The route's nextHopIp address is not assigned to an instance - on the network. - - The route's next hop instance cannot ip forward. - - >- - The route's nextHopInstance URL refers to an instance that - does not have an ipv6 interface on the same network as the - route. - - >- - The route's nextHopInstance URL refers to an instance that - does not exist. - - >- - The route's nextHopInstance URL refers to an instance that is - not on the same network as the route. - - >- - The route's next hop instance does not have a status of - RUNNING. - - >- - Error which is not critical. We decided to continue the - process despite the mentioned error. - - No results are present on a particular list page. - - >- - Success is reported, but some results may be missing due to - errors - - >- - The user attempted to use a resource that requires a TOS they - have not accepted. - - Warning that a resource is in use. - - >- - One or more of the resources set to auto-delete could not be - deleted because they were in use. - - When a resource schema validation is ignored. - - >- - Instance template used in instance group manager is valid as - such, but its application does not make a lot of sense, - because it allows only single instance in instance group. - - When undeclared properties in the schema are present - - A given scope cannot be reached. - enumDeprecated: - - false - - false - - false - - false - - false - - false - - true - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - enum: - - CLEANUP_FAILED - - DEPRECATED_RESOURCE_USED - - DEPRECATED_TYPE_USED - - DISK_SIZE_LARGER_THAN_IMAGE_SIZE - - EXPERIMENTAL_TYPE_USED - - EXTERNAL_API_WARNING - - FIELD_VALUE_OVERRIDEN - - INJECTED_KERNELS_DEPRECATED - - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB - - LARGE_DEPLOYMENT_WARNING - - LIST_OVERHEAD_QUOTA_EXCEED - - MISSING_TYPE_DEPENDENCY - - NEXT_HOP_ADDRESS_NOT_ASSIGNED - - NEXT_HOP_CANNOT_IP_FORWARD - - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE - - NEXT_HOP_INSTANCE_NOT_FOUND - - NEXT_HOP_INSTANCE_NOT_ON_NETWORK - - NEXT_HOP_NOT_RUNNING - - NOT_CRITICAL_ERROR - - NO_RESULTS_ON_PAGE - - PARTIAL_SUCCESS - - REQUIRED_TOS_AGREEMENT - - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - - RESOURCE_NOT_DELETED - - SCHEMA_VALIDATION_IGNORED - - SINGLE_INSTANCE_PROPERTY_TEMPLATE - - UNDECLARED_PROPERTIES - - UNREACHABLE - message: - description: '[Output Only] A human-readable description of the warning code.' - type: string - data: - description: >- - [Output Only] Metadata about this warning in key: value format. - For example: "data": [ { "key": "scope", "value": - "zones/us-east1-d" } - type: array - items: - type: object - properties: - key: - description: >- - [Output Only] A key that provides more detail on the - warning being returned. For example, for warnings where - there are no results in a list request for a particular - zone, this key might be scope and the key value might be - the zone name. Other examples might be a key indicating a - deprecated resource and a suggested replacement, or a - warning about invalid network settings (for example, if an - instance attempts to perform IP forwarding but is not - enabled for IP forwarding). - type: string - value: - description: >- - [Output Only] A warning data value corresponding to the - key. - type: string - HttpsHealthCheck: - id: HttpsHealthCheck + facilities: + type: array + items: + $ref: >- + #/components/schemas/InterconnectAttachmentGroupLogicalStructureRegionMetroFacility + InterconnectAttachmentGroupLogicalStructureRegionMetroFacility: + id: InterconnectAttachmentGroupLogicalStructureRegionMetroFacility 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 . + [Output Only] The facilities used for this group's Attachments' + Interconnects. type: object properties: - kind: - description: Type of the resource. - default: compute#httpsHealthCheck - type: string - id: - description: >- - [Output Only] The unique identifier for the resource. This - identifier is defined by the server. + facility: + description: '[Output Only] The name of a facility, like "iad-1234".' type: string - format: uint64 - creationTimestamp: - description: '[Output Only] Creation timestamp in RFC3339 text format.' + zones: + type: array + items: + $ref: >- + #/components/schemas/InterconnectAttachmentGroupLogicalStructureRegionMetroFacilityZone + InterconnectAttachmentGroupLogicalStructureRegionMetroFacilityZone: + id: InterconnectAttachmentGroupLogicalStructureRegionMetroFacilityZone + description: >- + [Output Only] The zones that Attachments in this group are present in, + in the given facilities. This is inherited from their Interconnects. + type: object + properties: + zone: + description: '[Output Only] The name of a zone, either "zone1" or "zone2".' type: string - name: + attachments: 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])?' + [Output Only] URLs of Attachments in the given zone, to the given + region, on Interconnects in the given facility and metro. Every + Attachment in the AG has such an entry. + type: array + items: + type: string + InterconnectAttachmentGroupConfigured: + id: InterconnectAttachmentGroupConfigured + description: >- + [Output Only] The redundancy this group is configured to support. The + way a user queries what SLA their Attachment gets is by looking at this + field of the Attachment's AttachmentGroup. + type: object + properties: + availabilitySla: + $ref: >- + #/components/schemas/InterconnectAttachmentGroupConfiguredAvailabilitySLA + InterconnectAttachmentGroupConfiguredAvailabilitySLA: + id: InterconnectAttachmentGroupConfiguredAvailabilitySLA + description: >- + [Output Only] Which SLA this group is configured to support, and why + this group does or does not meet that SLA's requirements. + type: object + properties: + effectiveSla: type: string - description: - description: >- - An optional description of this resource. Provide this property when - you create the resource. + enumDescriptions: + - '' + - '' + - '' + - '' + enum: + - EFFECTIVE_SLA_UNSPECIFIED + - NO_SLA + - PRODUCTION_CRITICAL + - PRODUCTION_NON_CRITICAL + intendedSlaBlockers: + type: array + items: + $ref: >- + #/components/schemas/InterconnectAttachmentGroupConfiguredAvailabilitySLAIntendedSlaBlockers + InterconnectAttachmentGroupConfiguredAvailabilitySLAIntendedSlaBlockers: + id: InterconnectAttachmentGroupConfiguredAvailabilitySLAIntendedSlaBlockers + description: >- + [Output Only] Reasons why configuration.availabilitySLA.sla differs from + intent.availabilitySLA. This list is empty if and only if those are the + same. + type: object + properties: + blockerType: type: string - host: + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + enum: + - BLOCKER_TYPE_UNSPECIFIED + - INCOMPATIBLE_METROS + - INCOMPATIBLE_REGIONS + - MISSING_GLOBAL_ROUTING + - NO_ATTACHMENTS + - NO_ATTACHMENTS_IN_METRO_AND_ZONE + - OTHER + explanation: 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. + [Output Only] A human-readable explanation of this requirement and + why it's not met. This is set for every type of requirement. type: string - requestPath: + documentationLink: description: >- - The request path of the HTTPS health check request. The default - value is "/". Must comply with RFC3986. + [Output Only] The url of Google Cloud public documentation + explaining this requirement. This is set for every type of + requirement. type: string - port: + regions: description: >- - The TCP port number for the HTTPS health check request. The default - value is 443. - type: integer - format: int32 - checkIntervalSec: + [Output Only] Regions used to explain this blocker in more detail. + These are region names formatted like "us-central1". This will be + set for some blockers (like INCOMPATIBLE_REGIONS) but does not apply + to others. + type: array + items: + type: string + metros: description: >- - How often (in seconds) to send a health check. The default value is - 5 seconds. - type: integer - format: int32 - timeoutSec: + [Output Only] Metros used to explain this blocker in more detail. + These are three-letter lowercase strings like "iad". This will be + set for some blockers (like NO_ATTACHMENTS_IN_METRO_AND_ZONE) but + does not apply to others. + type: array + items: + type: string + zones: 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. - type: integer - format: int32 - unhealthyThreshold: + [Output Only] Zones used to explain this blocker in more detail. + Format is "zone1" and/or "zone2". This will be set for some blockers + (like MISSING_ZONE) but does not apply to others. + type: array + items: + type: string + attachments: description: >- - A so-far healthy instance will be marked unhealthy after this many - consecutive failures. The default value is 2. - type: integer - format: int32 - healthyThreshold: - description: >- - A so-far unhealthy instance will be marked healthy after this many - consecutive successes. The default value is 2. - type: integer - format: int32 - selfLink: - description: '[Output Only] Server-defined URL for the resource.' - type: string - InstanceTemplateList: - id: InstanceTemplateList - description: A list of instance templates. + [Output Only] URLs of any particular Attachments to explain this + blocker in more detail. + type: array + items: + type: string + InterconnectAttachmentGroupsGetOperationalStatusResponse: + id: InterconnectAttachmentGroupsGetOperationalStatusResponse + description: >- + Response for the + InterconnectAttachmentGroupsGetOperationalStatusResponse. type: object properties: - kind: - description: >- - [Output Only] The resource type, which is always - compute#instanceTemplatesListResponse for instance template lists. - default: compute#instanceTemplateList + result: + $ref: '#/components/schemas/InterconnectAttachmentGroupsOperationalStatus' + etag: type: string - id: - description: >- - [Output Only] Unique identifier for the resource; defined by the - server. + InterconnectAttachmentGroupsOperationalStatus: + id: InterconnectAttachmentGroupsOperationalStatus + type: object + properties: + groupStatus: + description: Summarizes the status of the group. type: string - items: - description: A list of InstanceTemplate resources. + enumDescriptions: + - '' + - '' + - '' + - '' + enum: + - DEGRADED + - FULLY_DOWN + - FULLY_UP + - UNSPECIFIED + attachmentStatuses: type: array items: - $ref: '#/components/schemas/InstanceTemplate' - nextPageToken: + $ref: >- + #/components/schemas/InterconnectAttachmentGroupsOperationalStatusAttachmentStatus + intent: + $ref: '#/components/schemas/InterconnectAttachmentGroupIntent' + configured: + $ref: '#/components/schemas/InterconnectAttachmentGroupConfigured' + operational: description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. + The operational state of the group, including only active + Attachments. + $ref: '#/components/schemas/InterconnectAttachmentGroupConfigured' + InterconnectAttachmentGroupsOperationalStatusAttachmentStatus: + id: InterconnectAttachmentGroupsOperationalStatusAttachmentStatus + description: The status of one Attachment in the group. List order is arbitrary. + type: object + properties: + attachment: + description: The URL of the Attachment being described. type: string - selfLink: - description: '[Output Only] Server-defined URL for this resource.' + isActive: + description: >- + Whether this Attachment is participating in the redundant + configuration. This will be ACTIVE if and only if the status below + is CONNECTION_UP. Any INACTIVE Attachments are excluded from the + analysis that generates operational.availabilitySLA. type: string - warning: - description: '[Output Only] Informational warning message.' - type: object - properties: - code: - description: >- - [Output Only] A warning code, if applicable. For example, - Compute Engine returns NO_RESULTS_ON_PAGE if there are no - results in the response. - type: string - enumDescriptions: - - >- - Warning about failed cleanup of transient changes made by a - failed operation. - - A link to a deprecated resource was created. - - >- - When deploying and at least one of the resources has a type - marked as deprecated - - The user created a boot disk that is larger than image size. - - >- - When deploying and at least one of the resources has a type - marked as experimental - - Warning that is present in an external api call - - >- - Warning that value of a field has been overridden. Deprecated - unused field. - - >- - The operation involved use of an injected kernel, which is - deprecated. - - >- - A WEIGHTED_MAGLEV backend service is associated with a health - check that is not of type HTTP/HTTPS/HTTP2. - - >- - When deploying a deployment with a exceedingly large number of - resources - - >- - Resource can't be retrieved due to list overhead quota exceed - which captures the amount of resources filtered out by - user-defined list filter. - - A resource depends on a missing type - - >- - The route's nextHopIp address is not assigned to an instance - on the network. - - The route's next hop instance cannot ip forward. - - >- - The route's nextHopInstance URL refers to an instance that - does not have an ipv6 interface on the same network as the - route. - - >- - The route's nextHopInstance URL refers to an instance that - does not exist. - - >- - The route's nextHopInstance URL refers to an instance that is - not on the same network as the route. - - >- - The route's next hop instance does not have a status of - RUNNING. - - >- - Error which is not critical. We decided to continue the - process despite the mentioned error. - - No results are present on a particular list page. - - >- - Success is reported, but some results may be missing due to - errors - - >- - The user attempted to use a resource that requires a TOS they - have not accepted. - - Warning that a resource is in use. - - >- - One or more of the resources set to auto-delete could not be - deleted because they were in use. - - When a resource schema validation is ignored. - - >- - Instance template used in instance group manager is valid as - such, but its application does not make a lot of sense, - because it allows only single instance in instance group. - - When undeclared properties in the schema are present - - A given scope cannot be reached. - enumDeprecated: - - false - - false - - false - - false - - false - - false - - true - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - enum: - - CLEANUP_FAILED - - DEPRECATED_RESOURCE_USED - - DEPRECATED_TYPE_USED - - DISK_SIZE_LARGER_THAN_IMAGE_SIZE - - EXPERIMENTAL_TYPE_USED - - EXTERNAL_API_WARNING - - FIELD_VALUE_OVERRIDEN - - INJECTED_KERNELS_DEPRECATED - - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB - - LARGE_DEPLOYMENT_WARNING - - LIST_OVERHEAD_QUOTA_EXCEED - - MISSING_TYPE_DEPENDENCY - - NEXT_HOP_ADDRESS_NOT_ASSIGNED - - NEXT_HOP_CANNOT_IP_FORWARD - - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE - - NEXT_HOP_INSTANCE_NOT_FOUND - - NEXT_HOP_INSTANCE_NOT_ON_NETWORK - - NEXT_HOP_NOT_RUNNING - - NOT_CRITICAL_ERROR - - NO_RESULTS_ON_PAGE - - PARTIAL_SUCCESS - - REQUIRED_TOS_AGREEMENT - - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - - RESOURCE_NOT_DELETED - - SCHEMA_VALIDATION_IGNORED - - SINGLE_INSTANCE_PROPERTY_TEMPLATE - - UNDECLARED_PROPERTIES - - UNREACHABLE - message: - description: '[Output Only] A human-readable description of the warning code.' - type: string - data: - description: >- - [Output Only] Metadata about this warning in key: value format. - For example: "data": [ { "key": "scope", "value": - "zones/us-east1-d" } - type: array - items: - type: object - properties: - key: - description: >- - [Output Only] A key that provides more detail on the - warning being returned. For example, for warnings where - there are no results in a list request for a particular - zone, this key might be scope and the key value might be - the zone name. Other examples might be a key indicating a - deprecated resource and a suggested replacement, or a - warning about invalid network settings (for example, if an - instance attempts to perform IP forwarding but is not - enabled for IP forwarding). - type: string - value: - description: >- - [Output Only] A warning data value corresponding to the - key. - type: string - InstanceTemplate: - id: InstanceTemplate + enumDescriptions: + - '' + - '' + - '' + enum: + - ACTIVE + - INACTIVE + - UNSPECIFIED + adminEnabled: + description: >- + Whether this Attachment is enabled. This becomes false when the + customer drains their Attachment. + type: boolean + status: + description: >- + Whether this Attachment is active, and if so, whether BGP is up. + This is based on the statuses available in the Pantheon UI here: + http://google3/java/com/google/cloud/boq/clientapi/gce/hybrid/api/interconnect_models.proto + type: string + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + enum: + - ATTACHMENT_STATUS_UNKNOWN + - CONNECTION_DISABLED + - CONNECTION_DOWN + - CONNECTION_UP + - DEFUNCT + - IPSEC_CONFIGURATION_NEEDED_STATUS + - IPSEC_READY_TO_RESUME_FLOW_STATUS + - IPV4_DOWN_IPV6_UP + - IPV4_UP_IPV6_DOWN + - PARTNER_REQUEST_RECEIVED + - PENDING_CUSTOMER + - PENDING_PARTNER + - PROVISIONED + - ROUTER_CONFIGURATION_BROKEN + - UNPROVISIONED + Interconnect: + id: Interconnect description: >- - Represents an Instance Template resource. Google Compute Engine has two - Instance Template resources: * - [Global](/compute/docs/reference/rest/v1/instanceTemplates) * - [Regional](/compute/docs/reference/rest/v1/regionInstanceTemplates) You - can reuse a global instance template in different regions whereas you - can use a regional instance template in a specified region only. If you - want to reduce cross-region dependency or achieve data residency, use a - regional instance template. To create VMs, managed instance groups, and - reservations, you can use either global or regional instance templates. - For more information, read Instance Templates. + Represents an Interconnect resource. An Interconnect resource is a + dedicated connection between the Google Cloud network and your + on-premises network. For more information, read the Dedicated + Interconnect Overview. type: object properties: kind: description: >- - [Output Only] The resource type, which is always - compute#instanceTemplate for instance templates. - default: compute#instanceTemplate + [Output Only] Type of the resource. Always compute#interconnect for + interconnects. + default: compute#interconnect + type: string + description: + description: >- + An optional description of this resource. Provide this property when + you create the resource. + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' type: string id: description: >- - [Output Only] A unique identifier for this instance template. The - server defines this identifier. + [Output Only] The unique identifier for the resource. This + identifier is defined by the server. type: string format: uint64 creationTimestamp: - description: >- - [Output Only] The creation timestamp for this instance template in - RFC3339 text format. + description: '[Output Only] Creation timestamp in RFC3339 text format.' type: string name: description: >- - Name of the resource; provided by the client when the resource is + 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 @@ -26586,154 +26416,524 @@ components: pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' annotations: required: - - compute.instanceTemplates.insert + - compute.interconnects.insert type: string - description: + location: description: >- - An optional description of this resource. Provide this property when - you create the resource. + URL of the InterconnectLocation object that represents where this + connection is to be provisioned. type: string - properties: - description: The instance properties for this instance template. - $ref: '#/components/schemas/InstanceProperties' - selfLink: + linkType: description: >- - [Output Only] The URL for this instance template. The server defines - this URL. + 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. - + LINK_TYPE_ETHERNET_400G_LR4: A 400G Ethernet with LR4 optics. Note + that this field indicates the speed of each of the links in the + bundle, not the speed of the entire bundle. type: string - sourceInstance: + enumDescriptions: + - 100G Ethernet, LR Optics. + - 10G Ethernet, LR Optics. [(rate_bps) = 10000000000]; + - 400G Ethernet, LR4 Optics. + enum: + - LINK_TYPE_ETHERNET_100G_LR + - LINK_TYPE_ETHERNET_10G_LR + - LINK_TYPE_ETHERNET_400G_LR4 + requestedLinkCount: 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: - description: The source instance params to use to create this instance template. - $ref: '#/components/schemas/SourceInstanceParams' - region: + Target number of physical links in the link bundle, as requested by + the customer. + type: integer + format: int32 + interconnectType: description: >- - [Output Only] URL of the region where the instance template resides. - Only applicable for regional resources. + 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. type: string - SourceInstanceParams: - id: SourceInstanceParams - description: >- - A specification of the parameters to use when creating the instance - template from a source instance. - type: object - properties: - diskConfigs: + enumDescriptions: + - A dedicated physical interconnection with the customer. + - >- + [Deprecated] A private, physical interconnection with the + customer. + - >- + A partner-managed interconnection shared between customers via + partner. + enum: + - DEDICATED + - IT_PRIVATE + - PARTNER + adminEnabled: description: >- - Attached disks configuration. If not provided, defaults are applied: - For boot disk and any other R/W disks, the source images for each - disk will be used. For read-only disks, they will be attached in - read-only mode. Local SSD disks will be created as blank volumes. - type: array - items: - $ref: '#/components/schemas/DiskInstantiationConfig' - DiskInstantiationConfig: - id: DiskInstantiationConfig - description: >- - A specification of the desired way to instantiate a disk in the instance - template when its created from a source instance. - type: object - properties: - deviceName: + 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 + nocContactEmail: description: >- - Specifies the device name of the disk to which the configurations - apply to. + Email address to contact the customer NOC for operations and + maintenance notifications regarding this Interconnect. If specified, + this will be used for notifications in addition to all other forms + described, such as Cloud Monitoring logs alerting and Cloud + Notifications. This field is required for users who sign up for + Cloud Interconnect using workforce identity federation. type: string - instantiateFrom: + customerName: 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. + Customer name, to put in the Letter of Authorization as the party + authorized to request a crossconnect. + 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. type: string enumDescriptions: - >- - Attach the existing disk in read-only mode. The request will fail - if the disk was attached in read-write mode on the source - instance. Applicable to: read-only disks. - - >- - Create a blank disk. The disk will be created unformatted. - Applicable to: additional read-write disks, local SSDs. - - >- - Use the custom image specified in the custom_image field. - Applicable to: boot disk, additional read-write disks. - - >- - Use the default instantiation option for the corresponding type of - disk. 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. - - >- - Do not include the disk in the instance template. Applicable to: - additional read-write disks, local SSDs, read-only disks. - - >- - Use the same source image used for creation of the source - instance's corresponding disk. The request will fail if the source - VM's disk was created from a snapshot. Applicable to: boot disk, - additional read-write disks. + The interconnect is valid, turned up, and ready to use. + Attachments may be provisioned on this interconnect. - >- - Use the same source image family used for creation of the source - instance's corresponding disk. The request will fail if the source - image of the source disk does not belong to any image family. - Applicable to: boot disk, additional read-write disks. + The interconnect has not completed turnup. No attachments may be + provisioned on this interconnect. enum: - - ATTACH_READ_ONLY - - BLANK - - CUSTOM_IMAGE - - DEFAULT - - DO_NOT_INCLUDE - - SOURCE_IMAGE - - SOURCE_IMAGE_FAMILY - autoDelete: + - OS_ACTIVE + - OS_UNPROVISIONED + provisionedLinkCount: 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: + [Output Only] Number of links actually provisioned in this + interconnect. + type: integer + format: int32 + interconnectAttachments: description: >- - The custom source image to be used to restore this disk when - instantiating this instance template. - type: string - InstanceTemplateAggregatedList: - id: InstanceTemplateAggregatedList - description: Contains a list of InstanceTemplatesScopedList. - type: object - properties: - kind: - description: Type of resource. - default: compute#instanceTemplateAggregatedList + [Output Only] A list of the URLs of all InterconnectAttachments + configured to use this Interconnect. + type: array + items: + 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 - id: + googleIpAddress: description: >- - [Output Only] Unique identifier for the resource; defined by the - server. + [Output Only] IP address configured on the Google side of the + Interconnect link. This can be used only for ping tests. type: string - items: - description: A list of InstanceTemplatesScopedList resources. - type: object - additionalProperties: - description: >- - The name of the scope that contains this set of instance - templates. - $ref: '#/components/schemas/InstanceTemplatesScopedList' - nextPageToken: + googleReferenceId: description: >- - [Output Only] This token allows you to get the next page of results + [Output Only] Google reference ID to be used when raising support + tickets with Google or otherwise to debug backend connectivity + issues. + type: string + expectedOutages: + description: '[Output Only] A list of outages expected for this Interconnect.' + type: array + items: + $ref: '#/components/schemas/InterconnectOutageNotification' + circuitInfos: + description: >- + [Output Only] A list of CircuitInfo objects, that describe the + individual circuits in this LAG. + type: array + items: + $ref: '#/components/schemas/InterconnectCircuitInfo' + labels: + 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 + additionalProperties: + type: string + labelFingerprint: + description: >- + A fingerprint for the labels being applied to this Interconnect, + 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 Interconnect. + type: string + format: byte + 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. + type: string + enumDescriptions: + - >- + The interconnect is valid, turned up, and ready to use. + Attachments may be provisioned on this interconnect. + - >- + The interconnect has not completed turnup. No attachments may be + provisioned on this interconnect. + enum: + - ACTIVE + - UNPROVISIONED + satisfiesPzs: + description: '[Output Only] Reserved for future use.' + type: boolean + macsec: + description: >- + Configuration that enables Media Access Control security (MACsec) on + the Cloud Interconnect connection between Google and your + on-premises router. + $ref: '#/components/schemas/InterconnectMacsec' + macsecEnabled: + description: >- + Enable or disable MACsec on this Interconnect connection. MACsec + enablement fails if the MACsec object is not specified. + type: boolean + remoteLocation: + description: >- + Indicates that this is a Cross-Cloud Interconnect. This field + specifies the location outside of Google's network that the + interconnect is connected to. + type: string + requestedFeatures: + description: >- + Optional. List of features requested for this Interconnect + connection, which can take one of the following values: - IF_MACSEC + If specified then the connection is created on MACsec capable + hardware ports. If not specified, the default value is false, which + allocates non-MACsec capable ports first if available. This + parameter can be provided only with Interconnect INSERT. It isn't + valid for Interconnect PATCH. + type: array + items: + type: string + enumDescriptions: + - Media Access Control security (MACsec) + enum: + - IF_MACSEC + availableFeatures: + description: >- + [Output only] List of features available for this Interconnect + connection, which can take one of the following values: - IF_MACSEC + If present then the Interconnect connection is provisioned on MACsec + capable hardware ports. If not present then the Interconnect + connection is provisioned on non-MACsec capable ports and MACsec + isn't supported and enabling MACsec fails. + type: array + items: + type: string + enumDescriptions: + - Media Access Control security (MACsec) + enum: + - IF_MACSEC + applicationAwareInterconnect: + description: >- + Configuration information for application awareness on this Cloud + Interconnect. + $ref: '#/components/schemas/InterconnectApplicationAwareInterconnect' + aaiEnabled: + description: >- + Enable or disable the application awareness feature on this Cloud + Interconnect. + type: boolean + interconnectGroups: + description: >- + [Output Only] URLs of InterconnectGroups that include this + Interconnect. Order is arbitrary and items are unique. + type: array + items: + type: string + InterconnectOutageNotification: + id: InterconnectOutageNotification + description: Description of a planned outage on this Interconnect. + type: object + properties: + name: + description: Unique identifier for this outage notification. + type: string + description: + description: A description about the purpose of the outage. + 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. + type: string + enumDescriptions: + - This notification was generated by Google. + - '[Deprecated] This notification was generated by Google.' + enum: + - GOOGLE + - NSRC_GOOGLE + 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. + type: string + enumDescriptions: + - >- + This outage notification is active. The event could be in the + future, present, or past. See start_time and end_time for + scheduling. + - >- + The outage associated with this notification was cancelled before + the outage was due to start. + - The outage associated with this notification is complete. + - >- + [Deprecated] This outage notification is active. The event could + be in the future, present, or past. See start_time and end_time + for scheduling. + - >- + [Deprecated] The outage associated with this notification was + canceled before the outage was due to start. + enum: + - ACTIVE + - CANCELLED + - COMPLETED + - NS_ACTIVE + - NS_CANCELED + 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. + type: string + enumDescriptions: + - >- + [Deprecated] The Interconnect may be completely out of service for + some or all of the specified window. + - >- + [Deprecated] Some circuits comprising the Interconnect will be out + of service during the expected window. The interconnect as a whole + should remain up, albeit with reduced bandwidth. + - >- + The Interconnect may be completely out of service for some or all + of the specified window. + - >- + Some circuits comprising the Interconnect will be out of service + during the expected window. The interconnect as a whole should + remain up, albeit with reduced bandwidth. + enum: + - IT_OUTAGE + - IT_PARTIAL_OUTAGE + - OUTAGE + - PARTIAL_OUTAGE + affectedCircuits: + description: >- + If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side + circuit IDs that will be affected. + type: array + items: + type: string + startTime: + description: Scheduled start time for the outage (milliseconds since Unix epoch). + type: string + format: int64 + endTime: + description: Scheduled end time for the outage (milliseconds since Unix epoch). + type: string + format: int64 + InterconnectCircuitInfo: + id: InterconnectCircuitInfo + description: >- + Describes a single physical circuit between the Customer and Google. + CircuitInfo objects are created by Google, so all fields are output + only. + type: object + properties: + 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 + customerDemarcId: + description: Customer-side demarc ID for this circuit. + type: string + InterconnectMacsec: + id: InterconnectMacsec + description: >- + Configuration information for enabling Media Access Control security + (MACsec) on this Cloud Interconnect connection between Google and your + on-premises router. + type: object + properties: + preSharedKeys: + description: >- + Required. A keychain placeholder describing a set of named key + objects along with their start times. A MACsec CKN/CAK is generated + for each key in the key chain. Google router automatically picks the + key with the most recent startTime when establishing or + re-establishing a MACsec secure link. + type: array + items: + $ref: '#/components/schemas/InterconnectMacsecPreSharedKey' + failOpen: + description: >- + If set to true, the Interconnect connection is configured with a + should-secure MACsec security policy, that allows the Google router + to fallback to cleartext traffic if the MKA session cannot be + established. By default, the Interconnect connection is configured + with a must-secure security policy that drops all traffic if the MKA + session cannot be established with your router. + type: boolean + InterconnectMacsecPreSharedKey: + id: InterconnectMacsecPreSharedKey + description: >- + Describes a pre-shared key used to setup MACsec in static connectivity + association key (CAK) mode. + type: object + properties: + name: + description: >- + Required. A name for this pre-shared key. The name must be 1-63 + characters long, and comply with RFC1035. Specifically, the name + must be 1-63 characters long and match the regular expression + `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be + a lowercase letter, and all following characters must be a dash, + lowercase letter, or digit, except the last character, which cannot + be a dash. + type: string + startTime: + description: >- + A RFC3339 timestamp on or after which the key is valid. startTime + can be in the future. If the keychain has a single key, startTime + can be omitted. If the keychain has multiple keys, startTime is + mandatory for each key. The start times of keys must be in + increasing order. The start times of two consecutive keys must be at + least 6 hours apart. + type: string + InterconnectApplicationAwareInterconnect: + id: InterconnectApplicationAwareInterconnect + description: >- + Configuration information for application awareness on this Cloud + Interconnect. + type: object + properties: + strictPriorityPolicy: + $ref: >- + #/components/schemas/InterconnectApplicationAwareInterconnectStrictPriorityPolicy + bandwidthPercentagePolicy: + $ref: >- + #/components/schemas/InterconnectApplicationAwareInterconnectBandwidthPercentagePolicy + profileDescription: + description: >- + Description for the application awareness profile on this Cloud + Interconnect. + type: string + shapeAveragePercentages: + description: >- + Optional field to specify a list of shape average percentages to be + applied in conjunction with StrictPriorityPolicy or + BandwidthPercentagePolicy. + type: array + items: + $ref: >- + #/components/schemas/InterconnectApplicationAwareInterconnectBandwidthPercentage + InterconnectApplicationAwareInterconnectStrictPriorityPolicy: + id: InterconnectApplicationAwareInterconnectStrictPriorityPolicy + description: Specify configuration for StrictPriorityPolicy. + type: object + properties: {} + InterconnectApplicationAwareInterconnectBandwidthPercentagePolicy: + id: InterconnectApplicationAwareInterconnectBandwidthPercentagePolicy + type: object + properties: + bandwidthPercentages: + description: >- + Specify bandwidth percentages for various traffic classes for + queuing type Bandwidth Percent. + type: array + items: + $ref: >- + #/components/schemas/InterconnectApplicationAwareInterconnectBandwidthPercentage + InterconnectApplicationAwareInterconnectBandwidthPercentage: + id: InterconnectApplicationAwareInterconnectBandwidthPercentage + description: >- + Specify bandwidth percentages [1-100] for various traffic classes in + BandwidthPercentagePolicy. The sum of all percentages must equal 100. + All traffic classes must have a percentage value specified. + type: object + properties: + trafficClass: + description: TrafficClass whose bandwidth percentage is being specified. + type: string + enumDescriptions: + - Traffic Class 1, corresponding to DSCP ranges (0-7) 000xxx. + - Traffic Class 2, corresponding to DSCP ranges (8-15) 001xxx. + - Traffic Class 3, corresponding to DSCP ranges (16-23) 010xxx. + - Traffic Class 4, corresponding to DSCP ranges (24-31) 011xxx. + - Traffic Class 5, corresponding to DSCP ranges (32-47) 10xxxx. + - Traffic Class 6, corresponding to DSCP ranges (48-63) 11xxxx. + enum: + - TC1 + - TC2 + - TC3 + - TC4 + - TC5 + - TC6 + percentage: + description: Bandwidth percentage for a specific traffic class. + type: integer + format: uint32 + InterconnectList: + id: InterconnectList + description: Response to the list request, and contains a list of interconnects. + type: object + properties: + kind: + description: >- + [Output Only] Type of resource. Always compute#interconnectList for + lists of interconnects. + default: compute#interconnectList + type: string + id: + description: >- + [Output Only] Unique identifier for the resource; defined by the + server. + type: string + items: + description: A list of Interconnect resources. + type: array + items: + $ref: '#/components/schemas/Interconnect' + nextPageToken: + description: >- + [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will @@ -26806,6 +27006,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -26849,6 +27052,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -26871,6 +27075,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -26907,248 +27112,255 @@ components: [Output Only] A warning data value corresponding to the key. type: string - InstanceTemplatesScopedList: - id: InstanceTemplatesScopedList + InterconnectsGetDiagnosticsResponse: + id: InterconnectsGetDiagnosticsResponse + description: Response for the InterconnectsGetDiagnosticsRequest. type: object properties: - instanceTemplates: + result: + $ref: '#/components/schemas/InterconnectDiagnostics' + InterconnectDiagnostics: + id: InterconnectDiagnostics + description: >- + Diagnostics information about the Interconnect connection, which + contains detailed and current technical information about Google's side + of the connection. + type: object + properties: + macAddress: + description: The MAC address of the Interconnect's bundle interface. + type: string + arpCaches: description: >- - [Output Only] A list of instance templates that are contained within - the specified project and zone. + 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. type: array items: - $ref: '#/components/schemas/InstanceTemplate' - warning: + $ref: '#/components/schemas/InterconnectDiagnosticsARPEntry' + links: description: >- - [Output Only] An informational warning that replaces the list of - instance templates when the list is empty. - type: object - properties: - code: - description: >- - [Output Only] A warning code, if applicable. For example, - Compute Engine returns NO_RESULTS_ON_PAGE if there are no - results in the response. - type: string - enumDescriptions: - - >- - Warning about failed cleanup of transient changes made by a - failed operation. - - A link to a deprecated resource was created. - - >- - When deploying and at least one of the resources has a type - marked as deprecated - - The user created a boot disk that is larger than image size. - - >- - When deploying and at least one of the resources has a type - marked as experimental - - Warning that is present in an external api call - - >- - Warning that value of a field has been overridden. Deprecated - unused field. - - >- - The operation involved use of an injected kernel, which is - deprecated. - - >- - A WEIGHTED_MAGLEV backend service is associated with a health - check that is not of type HTTP/HTTPS/HTTP2. - - >- - When deploying a deployment with a exceedingly large number of - resources - - >- - Resource can't be retrieved due to list overhead quota exceed - which captures the amount of resources filtered out by - user-defined list filter. - - A resource depends on a missing type - - >- - The route's nextHopIp address is not assigned to an instance - on the network. - - The route's next hop instance cannot ip forward. - - >- - The route's nextHopInstance URL refers to an instance that - does not have an ipv6 interface on the same network as the - route. - - >- - The route's nextHopInstance URL refers to an instance that - does not exist. - - >- - The route's nextHopInstance URL refers to an instance that is - not on the same network as the route. - - >- - The route's next hop instance does not have a status of - RUNNING. - - >- - Error which is not critical. We decided to continue the - process despite the mentioned error. - - No results are present on a particular list page. - - >- - Success is reported, but some results may be missing due to - errors - - >- - The user attempted to use a resource that requires a TOS they - have not accepted. - - Warning that a resource is in use. - - >- - One or more of the resources set to auto-delete could not be - deleted because they were in use. - - When a resource schema validation is ignored. - - >- - Instance template used in instance group manager is valid as - such, but its application does not make a lot of sense, - because it allows only single instance in instance group. - - When undeclared properties in the schema are present - - A given scope cannot be reached. - enumDeprecated: - - false - - false - - false - - false - - false - - false - - true - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - enum: - - CLEANUP_FAILED - - DEPRECATED_RESOURCE_USED - - DEPRECATED_TYPE_USED - - DISK_SIZE_LARGER_THAN_IMAGE_SIZE - - EXPERIMENTAL_TYPE_USED - - EXTERNAL_API_WARNING - - FIELD_VALUE_OVERRIDEN - - INJECTED_KERNELS_DEPRECATED - - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB - - LARGE_DEPLOYMENT_WARNING - - LIST_OVERHEAD_QUOTA_EXCEED - - MISSING_TYPE_DEPENDENCY - - NEXT_HOP_ADDRESS_NOT_ASSIGNED - - NEXT_HOP_CANNOT_IP_FORWARD - - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE - - NEXT_HOP_INSTANCE_NOT_FOUND - - NEXT_HOP_INSTANCE_NOT_ON_NETWORK - - NEXT_HOP_NOT_RUNNING - - NOT_CRITICAL_ERROR - - NO_RESULTS_ON_PAGE - - PARTIAL_SUCCESS - - REQUIRED_TOS_AGREEMENT - - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - - RESOURCE_NOT_DELETED - - SCHEMA_VALIDATION_IGNORED - - SINGLE_INSTANCE_PROPERTY_TEMPLATE - - UNDECLARED_PROPERTIES - - UNREACHABLE - message: - description: '[Output Only] A human-readable description of the warning code.' - type: string - data: - description: >- - [Output Only] Metadata about this warning in key: value format. - For example: "data": [ { "key": "scope", "value": - "zones/us-east1-d" } - type: array - items: - type: object - properties: - key: - description: >- - [Output Only] A key that provides more detail on the - warning being returned. For example, for warnings where - there are no results in a list request for a particular - zone, this key might be scope and the key value might be - the zone name. Other examples might be a key indicating a - deprecated resource and a suggested replacement, or a - warning about invalid network settings (for example, if an - instance attempts to perform IP forwarding but is not - enabled for IP forwarding). - type: string - value: - description: >- - [Output Only] A warning data value corresponding to the - key. - type: string - InstanceSettings: - id: InstanceSettings - description: >- - Represents a Instance Settings resource. You can use instance settings - to configure default settings for Compute Engine VM instances. For - example, you can use it to configure default machine type of Compute - Engine VM instances. + A list of InterconnectDiagnostics.LinkStatus objects, describing the + status for each link on the Interconnect. + type: array + items: + $ref: '#/components/schemas/InterconnectDiagnosticsLinkStatus' + bundleOperationalStatus: + description: The operational status of the bundle interface. + type: string + enumDescriptions: + - >- + If bundleAggregationType is LACP: LACP is not established and/or + all links in the bundle have DOWN operational status. If + bundleAggregationType is STATIC: one or more links in the bundle + has DOWN operational status. + - >- + If bundleAggregationType is LACP: LACP is established and at least + one link in the bundle has UP operational status. If + bundleAggregationType is STATIC: all links in the bundle + (typically just one) have UP operational status. + enum: + - BUNDLE_OPERATIONAL_STATUS_DOWN + - BUNDLE_OPERATIONAL_STATUS_UP + bundleAggregationType: + description: The aggregation type of the bundle interface. + type: string + enumDescriptions: + - LACP is enabled. + - LACP is disabled. + enum: + - BUNDLE_AGGREGATION_TYPE_LACP + - BUNDLE_AGGREGATION_TYPE_STATIC + InterconnectDiagnosticsARPEntry: + id: InterconnectDiagnosticsARPEntry + description: Describing the ARP neighbor entries seen on this link type: object properties: - kind: + macAddress: + description: The MAC address of this ARP neighbor. + type: string + ipAddress: + description: The IP address of this ARP neighbor. + type: string + InterconnectDiagnosticsLinkStatus: + id: InterconnectDiagnosticsLinkStatus + type: object + properties: + 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 + receivingOpticalPower: description: >- - [Output Only] Type of the resource. Always compute#instance_settings - for instance settings. - default: compute#instanceSettings + An InterconnectDiagnostics.LinkOpticalPower object, describing the + current value and status of the received light level. + $ref: '#/components/schemas/InterconnectDiagnosticsLinkOpticalPower' + transmittingOpticalPower: + description: >- + An InterconnectDiagnostics.LinkOpticalPower object, describing the + current value and status of the transmitted light level. + $ref: '#/components/schemas/InterconnectDiagnosticsLinkOpticalPower' + lacpStatus: + $ref: '#/components/schemas/InterconnectDiagnosticsLinkLACPStatus' + operationalStatus: + description: The operational status of the link. type: string - fingerprint: + enumDescriptions: + - The interface is unable to communicate with the remote end. + - The interface has low level communication with the remote end. + enum: + - LINK_OPERATIONAL_STATUS_DOWN + - LINK_OPERATIONAL_STATUS_UP + arpCaches: description: >- - Specifies a fingerprint for instance settings, which is essentially - a hash of the instance settings resource'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 settings resource. You must always provide an - up-to-date fingerprint hash in order to update or change the - resource, otherwise the request will fail with error 412 - conditionNotMet. To see the latest fingerprint, make a get() request - to retrieve the resource. + A list of InterconnectDiagnostics.ARPEntry objects, describing the + ARP neighbor entries seen on this link. This will be empty if the + link is bundled + type: array + items: + $ref: '#/components/schemas/InterconnectDiagnosticsARPEntry' + macsec: + description: Describes the status of MACsec encryption on this link. + $ref: '#/components/schemas/InterconnectDiagnosticsMacsecStatus' + InterconnectDiagnosticsLinkOpticalPower: + id: InterconnectDiagnosticsLinkOpticalPower + type: object + properties: + 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. + type: number + format: float + 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. type: string - format: byte - metadata: + enumDescriptions: + - The value has crossed above the high alarm threshold. + - >- + The value of the current optical power has crossed above the high + warning threshold. + - >- + The value of the current optical power has crossed below the low + alarm threshold. + - >- + The value of the current optical power has crossed below the low + warning threshold. + - >- + The value of the current optical power has not crossed a warning + threshold. + enum: + - HIGH_ALARM + - HIGH_WARNING + - LOW_ALARM + - LOW_WARNING + - OK + InterconnectDiagnosticsLinkLACPStatus: + id: InterconnectDiagnosticsLinkLACPStatus + type: object + properties: + state: description: >- - The metadata key/value pairs assigned to all the instances in the - corresponding scope. - $ref: '#/components/schemas/InstanceSettingsMetadata' - zone: + 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. + type: string + enumDescriptions: + - The link is configured and active within the bundle. + - >- + The link is not configured within the bundle, this means the rest + of the object should be empty. + enum: + - ACTIVE + - DETACHED + 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 + InterconnectDiagnosticsMacsecStatus: + id: InterconnectDiagnosticsMacsecStatus + description: Describes the status of MACsec encryption on the link. + type: object + properties: + operational: + description: Indicates whether or not MACsec is operational on this link. + type: boolean + ckn: description: >- - [Output Only] URL of the zone where the resource resides You must - specify this field as part of the HTTP request URL. It is not - settable as a field in the request body. + Indicates the Connectivity Association Key Name (CKN) currently + being used if MACsec is operational. type: string - InstanceSettingsMetadata: - id: InstanceSettingsMetadata + InterconnectsGetMacsecConfigResponse: + id: InterconnectsGetMacsecConfigResponse + description: Response for the InterconnectsGetMacsecConfigRequest. type: object properties: - kind: + result: + $ref: '#/components/schemas/InterconnectMacsecConfig' + etag: + description: 'end_interface: MixerGetResponseWithEtagBuilder' + type: string + InterconnectMacsecConfig: + id: InterconnectMacsecConfig + description: >- + MACsec configuration information for the Interconnect connection. + Contains the generated Connectivity Association Key Name (CKN) and the + key (CAK) for this Interconnect connection. + type: object + properties: + preSharedKeys: description: >- - [Output Only] Type of the resource. Always compute#metadata for - metadata. - default: compute#metadata + A keychain placeholder describing a set of named key objects along + with their start times. A MACsec CKN/CAK is generated for each key + in the key chain. Google router automatically picks the key with the + most recent startTime when establishing or re-establishing a MACsec + secure link. + type: array + items: + $ref: '#/components/schemas/InterconnectMacsecConfigPreSharedKey' + InterconnectMacsecConfigPreSharedKey: + id: InterconnectMacsecConfigPreSharedKey + description: >- + Describes a pre-shared key used to setup MACsec in static connectivity + association key (CAK) mode. + type: object + properties: + name: + description: User provided name for this pre-shared key. type: string - items: + ckn: description: >- - A metadata key/value items map. The total size of all keys and - values must be less than 512KB. - type: object - additionalProperties: - type: string - InstantSnapshotList: - id: InstantSnapshotList - description: Contains a list of InstantSnapshot resources. + An auto-generated Connectivity Association Key Name (CKN) for this + key. + type: string + cak: + description: An auto-generated Connectivity Association Key (CAK) for this key. + type: string + startTime: + description: User provided timestamp on or after which this key is valid. + type: string + InterconnectGroupsListResponse: + id: InterconnectGroupsListResponse type: object properties: kind: - description: Type of resource. - default: compute#instantSnapshotList + default: compute#InterconnectGroup type: string id: description: >- @@ -27156,10 +27368,10 @@ components: server. type: string items: - description: A list of InstantSnapshot resources. + description: A list of InterconnectGroup resources. type: array items: - $ref: '#/components/schemas/InstantSnapshot' + $ref: '#/components/schemas/InterconnectGroup' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -27235,6 +27447,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -27278,6 +27493,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -27300,6 +27516,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -27336,23 +27553,30 @@ components: [Output Only] A warning data value corresponding to the key. type: string - InstantSnapshot: - id: InstantSnapshot + etag: + type: string + unreachables: + description: >- + [Output Only] Unreachable resources. end_interface: + MixerListResponseWithEtagBuilder + type: array + items: + type: string + InterconnectGroup: + id: InterconnectGroup description: >- - Represents a InstantSnapshot resource. You can use instant snapshots to - create disk rollback points quickly.. + An interconnect group resource allows customers to create, analyze, and + expand their redundant connections. type: object properties: kind: - description: >- - [Output Only] Type of the resource. Always compute#instantSnapshot - for InstantSnapshot resources. - default: compute#instantSnapshot + description: '[Output Only] Type of the resource. Always compute#InterconnectGroup' + default: compute#InterconnectGroup type: string id: description: >- - [Output Only] The unique identifier for the resource. This - identifier is defined by the server. + [Output Only] The unique identifier for the resource type. The + server generates this identifier. type: string format: uint64 creationTimestamp: @@ -27360,7 +27584,7 @@ components: type: string name: description: >- - Name of the resource; provided by the client when the resource is + 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 @@ -27368,159 +27592,635 @@ components: 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])?' + annotations: + required: + - compute.interconnectGroups.insert type: string description: description: >- An optional description of this resource. Provide this property when you create the resource. type: string - status: - description: >- - [Output Only] The status of the instantSnapshot. This can be - CREATING, DELETING, FAILED, or READY. - type: string - enumDescriptions: - - InstantSnapshot creation is in progress. - - InstantSnapshot is currently being deleted. - - InstantSnapshot creation failed. - - InstantSnapshot has been created successfully. - - >- - InstantSnapshot is currently unavailable and cannot be used for - Disk restoration - enum: - - CREATING - - DELETING - - FAILED - - READY - - UNAVAILABLE - sourceDisk: - description: >- - URL of the source disk used to create this instant snapshot. Note - that the source disk must be in the same zone/region as the instant - snapshot to be created. This can be a full or valid partial URL. 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 ID value of the disk used to create this - InstantSnapshot. This value may be used to determine whether the - InstantSnapshot was taken from the current or a previous instance of - a given disk name. - type: string - diskSizeGb: - description: '[Output Only] Size of the source disk, specified in GB.' - type: string - format: int64 selfLink: description: '[Output Only] Server-defined URL for the resource.' type: string - selfLinkWithId: - description: '[Output Only] Server-defined URL for this resource''s resource id.' + etag: + description: >- + Opaque system-generated token that uniquely identifies the + configuration. If provided when patching a configuration in update + mode, the provided token must match the current token or the update + is rejected. This provides a reliable means of doing + read-modify-write (optimistic locking) as described by API 154. type: string - labels: + interconnects: description: >- - Labels to apply to this InstantSnapshot. These can be later modified - by the setLabels method. Label values may be empty. + Interconnects in the InterconnectGroup. Keys are arbitrary + user-specified strings. Users are encouraged, but not required, to + use their preferred format for resource links as keys. Note that + there are add-members and remove-members methods in gcloud. The size + of this map is limited by an "Interconnects per group" quota. type: object additionalProperties: - type: string - labelFingerprint: + $ref: '#/components/schemas/InterconnectGroupInterconnect' + intent: + $ref: '#/components/schemas/InterconnectGroupIntent' + physicalStructure: + $ref: '#/components/schemas/InterconnectGroupPhysicalStructure' + configured: + $ref: '#/components/schemas/InterconnectGroupConfigured' + InterconnectGroupInterconnect: + id: InterconnectGroupInterconnect + description: An Interconnect in this InterconnectGroup. + type: object + properties: + interconnect: description: >- - A fingerprint for the labels being applied to this InstantSnapshot, - 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 InstantSnapshot. + The URL of an Interconnect in this group. All Interconnects in the + group are unique. type: string - format: byte - zone: + InterconnectGroupIntent: + id: InterconnectGroupIntent + description: >- + The user's intent for this group. This is the only required field + besides the name that must be specified on group creation. + type: object + properties: + topologyCapability: + type: string + enumDescriptions: + - '' + - '' + - '' + - '' + enum: + - NO_SLA + - PRODUCTION_CRITICAL + - PRODUCTION_NON_CRITICAL + - UNSPECIFIED + InterconnectGroupPhysicalStructure: + id: InterconnectGroupPhysicalStructure + description: >- + [Output Only] An analysis of the physical layout of Interconnects in + this group. Every Interconnect in the group is shown once in this + structure. + type: object + properties: + metros: + type: array + items: + $ref: '#/components/schemas/InterconnectGroupPhysicalStructureMetros' + InterconnectGroupPhysicalStructureMetros: + id: InterconnectGroupPhysicalStructureMetros + description: '[Output Only] The metros Interconnects in this group are in.' + type: object + properties: + metro: description: >- - [Output Only] URL of the zone where the instant snapshot resides. - You must specify this field as part of the HTTP request URL. It is - not settable as a field in the request body. + [Output Only] The name of the metro, as a three-letter lowercase + string like "iad". This is the first component of the location of + Interconnects underneath this. type: string - region: + facilities: + type: array + items: + $ref: >- + #/components/schemas/InterconnectGroupPhysicalStructureMetrosFacilities + InterconnectGroupPhysicalStructureMetrosFacilities: + id: InterconnectGroupPhysicalStructureMetrosFacilities + description: '[Output Only] The facilities Interconnects in this metro are present in.' + type: object + properties: + facility: description: >- - [Output Only] URL of the region where the instant snapshot resides. - You must specify this field as part of the HTTP request URL. It is - not settable as a field in the request body. + [Output Only] The ID of this facility, as a numeric string like + "5467". This is the third component of the location of Interconnects + in this facility. type: string - satisfiesPzs: - description: '[Output Only] Reserved for future use.' - type: boolean - architecture: + zones: + type: array + items: + $ref: >- + #/components/schemas/InterconnectGroupPhysicalStructureMetrosFacilitiesZones + InterconnectGroupPhysicalStructureMetrosFacilitiesZones: + id: InterconnectGroupPhysicalStructureMetrosFacilitiesZones + description: >- + [Output Only] The zones that Interconnects in this facility are present + in. + type: object + properties: + zone: description: >- - [Output Only] The architecture of the instant snapshot. Valid values - are ARM64 or X86_64. + [Output Only] The name of the zone, either "zone1" or "zone2". This + is the second component of the location of Interconnects in this + facility. type: string - enumDescriptions: - - Default value indicating Architecture is not set. - - Machines with architecture ARM64 - - Machines with architecture X86_64 - enum: - - ARCHITECTURE_UNSPECIFIED - - ARM64 - - X86_64 - resourceStatus: - description: '[Output Only] Status information for the instant snapshot resource.' - $ref: '#/components/schemas/InstantSnapshotResourceStatus' - satisfiesPzi: - description: Output only. Reserved for future use. - readOnly: true - type: boolean - InstantSnapshotResourceStatus: - id: InstantSnapshotResourceStatus + interconnects: + description: >- + [Output Only] URLs of Interconnects in this redundancy group in the + given metro, facility, and zone. + type: array + items: + type: string + InterconnectGroupConfigured: + id: InterconnectGroupConfigured + description: >- + [Output Only] The status of the group as configured. This has the same + structure as the operational field reported by the OperationalStatus + method, but does not take into account the operational status of each + resource. type: object properties: - storageSizeBytes: - description: '[Output Only] The storage size of this instant snapshot.' + topologyCapability: + $ref: '#/components/schemas/InterconnectGroupConfiguredTopologyCapability' + InterconnectGroupConfiguredTopologyCapability: + id: InterconnectGroupConfiguredTopologyCapability + description: >- + [Output Only] How reliable this topology is configured to be, and why + this group does or does not meet the requirements for the intended + capability. + type: object + properties: + supportedSla: type: string - format: int64 - InstantSnapshotAggregatedList: - id: InstantSnapshotAggregatedList + enumDescriptions: + - '' + - '' + - '' + - '' + enum: + - NO_SLA + - PRODUCTION_CRITICAL + - PRODUCTION_NON_CRITICAL + - UNSPECIFIED + intendedCapabilityBlockers: + type: array + items: + $ref: >- + #/components/schemas/InterconnectGroupConfiguredTopologyCapabilityIntendedCapabilityBlockers + InterconnectGroupConfiguredTopologyCapabilityIntendedCapabilityBlockers: + id: InterconnectGroupConfiguredTopologyCapabilityIntendedCapabilityBlockers + description: >- + [Output Only] Reasons why configuration.topologyCapability.sla differs + from intent.topologyCapability. This list is empty if and only if those + are the same. type: object properties: - kind: + blockerType: + type: string + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + enum: + - INCOMPATIBLE_METROS + - NOT_AVAILABLE + - NO_INTERCONNECTS + - NO_INTERCONNECTS_IN_METRO_AND_ZONE + - OTHER + - UNSPECIFIED + explanation: description: >- - [Output Only] Type of resource. Always - compute#instantSnapshotAggregatedList for aggregated lists of - instantSnapshots. - default: compute#instantSnapshotAggregatedList + [Output Only] A human-readable explanation of this requirement and + why it's not met. This is set for every type of requirement. type: string - id: + documentationLink: description: >- - [Output Only] Unique identifier for the resource; defined by the - server. + [Output Only] The url of Google Cloud public documentation + explaining this requirement. This is set for every type of + requirement. type: string - items: - description: A list of InstantSnapshotsScopedList resources. - type: object - additionalProperties: - description: >- - [Output Only] Name of the scope containing this set of - instantSnapshots. - $ref: '#/components/schemas/InstantSnapshotsScopedList' - nextPageToken: + metros: description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. + [Output Only] Metros used to explain this blocker in more detail. + These are three-letter lowercase strings like "iad". A blocker like + INCOMPATIBLE_METROS will specify the problematic metros in this + field. + type: array + items: + type: string + facilities: + description: >- + [Output Only] Facilities used to explain this blocker in more + detail. Like physicalStructure.metros.facilities.facility, this is a + numeric string like "5467". + type: array + items: + type: string + zones: + description: >- + [Output Only] Zones used to explain this blocker in more detail. + Zone names are "zone1" and/or "zone2". + type: array + items: + type: string + interconnects: + description: >- + [Output Only] Interconnects used to explain this blocker in more + detail. + type: array + items: + type: string + InterconnectGroupsGetOperationalStatusResponse: + id: InterconnectGroupsGetOperationalStatusResponse + description: Response for the InterconnectGroupsGetOperationalStatusResponse. + type: object + properties: + result: + $ref: '#/components/schemas/InterconnectGroupsOperationalStatus' + etag: type: string - selfLink: - description: '[Output Only] Server-defined URL for this resource.' + InterconnectGroupsOperationalStatus: + id: InterconnectGroupsOperationalStatus + description: Request to get the status of the interconnect group with extra detail. + type: object + properties: + groupStatus: + description: Summarizes the status of the group. type: string - warning: + enumDescriptions: + - '' + - '' + - '' + - '' + enum: + - DEGRADED + - FULLY_DOWN + - FULLY_UP + - GROUPS_STATUS_UNSPECIFIED + interconnectStatuses: + type: array + items: + $ref: >- + #/components/schemas/InterconnectGroupsOperationalStatusInterconnectStatus + intent: + description: The intent of the resource, as returned by Get. + $ref: '#/components/schemas/InterconnectGroupIntent' + configured: + description: The configuration analysis, as returned by Get. + $ref: '#/components/schemas/InterconnectGroupConfigured' + operational: + description: >- + The operational state of the group, including only active + Interconnects. + $ref: '#/components/schemas/InterconnectGroupConfigured' + InterconnectGroupsOperationalStatusInterconnectStatus: + id: InterconnectGroupsOperationalStatusInterconnectStatus + description: The status of one Interconnect in the group. The order is arbitrary. + type: object + properties: + interconnect: + description: The URL of the Interconnect being described. + type: string + isActive: + description: >- + Whether this interconnect is participating in the redundant + configuration. + type: string + enumDescriptions: + - '' + - '' + - '' + enum: + - ACTIVE + - INACTIVE + - IS_ACTIVE_UNSPECIFIED + adminEnabled: + description: Whether the Interconnect is enabled. + type: boolean + diagnostics: + description: >- + The diagnostics of the Interconnect, as returned by the existing + get-diagnostics method. + $ref: '#/components/schemas/InterconnectDiagnostics' + InterconnectGroupsCreateMembersRequest: + id: InterconnectGroupsCreateMembersRequest + type: object + properties: + request: + $ref: '#/components/schemas/InterconnectGroupsCreateMembers' + InterconnectGroupsCreateMembers: + id: InterconnectGroupsCreateMembers + type: object + properties: + intentMismatchBehavior: + description: >- + How to behave when configured.topologyCapability.supportedSLA would + not equal intent.topologyCapability after this call. + type: string + enumDescriptions: + - '' + - '' + - '' + enum: + - CREATE + - REJECT + - UNSPECIFIED + templateInterconnect: + description: Parameters for the Interconnects to create. + $ref: >- + #/components/schemas/InterconnectGroupsCreateMembersInterconnectInput + interconnects: + type: array + items: + $ref: >- + #/components/schemas/InterconnectGroupsCreateMembersInterconnectInput + InterconnectGroupsCreateMembersInterconnectInput: + id: InterconnectGroupsCreateMembersInterconnectInput + description: LINT.IfChange + type: object + properties: + facility: + description: >- + A zone-free location to use for all Interconnects created in this + call, like "iad-1234". + type: string + description: + description: >- + An optional description of this resource. Provide this property when + you create the resource. + type: string + name: + description: >- + Name of the Interconnects to be created. This must be specified on + the template and/or on each individual interconnect. The name, if + not empty, must be 1-63 characters long, and comply with RFC1035. + Specifically, any nonempty 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 + 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. - + LINK_TYPE_ETHERNET_400G_LR4: A 400G Ethernet with LR4 optics. Note + that this field indicates the speed of each of the links in the + bundle, not the speed of the entire bundle. + type: string + enumDescriptions: + - 100G Ethernet, LR Optics. + - 10G Ethernet, LR Optics. [(rate_bps) = 10000000000]; + - 400G Ethernet, LR4 Optics. + enum: + - LINK_TYPE_ETHERNET_100G_LR + - LINK_TYPE_ETHERNET_10G_LR + - LINK_TYPE_ETHERNET_400G_LR4 + requestedLinkCount: + description: >- + Target number of physical links in the link bundle, as requested by + the customer. + type: integer + format: int32 + 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. + type: string + enumDescriptions: + - A dedicated physical interconnection with the customer. + - >- + [Deprecated] A private, physical interconnection with the + customer. + - >- + A partner-managed interconnection shared between customers via + partner. + enum: + - DEDICATED + - IT_PRIVATE + - PARTNER + 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 + 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 Cloud Monitoring logs alerting and Cloud + Notifications. This field is required for users who sign up for + Cloud Interconnect using workforce identity federation. + type: string + customerName: + description: >- + Customer name, to put in the Letter of Authorization as the party + authorized to request a crossconnect. + type: string + remoteLocation: + description: >- + Indicates that this is a Cross-Cloud Interconnect. This field + specifies the location outside of Google's network that the + interconnect is connected to. + type: string + requestedFeatures: + description: >- + Optional. List of features requested for this Interconnect + connection, which can take one of the following values: - IF_MACSEC + If specified then the connection is created on MACsec capable + hardware ports. If not specified, the default value is false, which + allocates non-MACsec capable ports first if available. This + parameter can be provided only with Interconnect INSERT. It isn't + valid for Interconnect PATCH. + type: array + items: + type: string + enumDescriptions: + - Media Access Control security (MACsec) + enum: + - IF_MACSEC + ExternalVpnGateway: + id: 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. + type: object + properties: + kind: + description: >- + [Output Only] Type of the resource. Always + compute#externalVpnGateway for externalVpnGateways. + default: compute#externalVpnGateway + type: string + description: + description: >- + An optional description of this resource. Provide this property when + you create the resource. + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + id: + description: >- + [Output Only] The unique identifier for the resource. This + identifier is defined by the server. + type: string + format: uint64 + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + 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])?' + annotations: + required: + - compute.externalVpnGateways.insert + type: string + redundancyType: + description: >- + Indicates the user-supplied redundancy type of this external VPN + gateway. + type: string + enumDescriptions: + - >- + The external VPN gateway has four public IP addresses; at the time + of writing this API, the AWS virtual private gateway is an example + which has four public IP addresses for high availability + connections; there should be two VPN connections in the AWS + virtual private gateway , each AWS VPN connection has two public + IP addresses; please make sure to put two public IP addresses from + one AWS VPN connection into interfaces 0 and 1 of this external + VPN gateway, and put the other two public IP addresses from + another AWS VPN connection into interfaces 2 and 3 of this + external VPN gateway. When displaying highly available + configuration status for the VPN tunnels connected to + FOUR_IPS_REDUNDANCY external VPN gateway, Google will always + detect whether interfaces 0 and 1 are connected on one interface + of HA Cloud VPN gateway, and detect whether interfaces 2 and 3 are + connected to another interface of the HA Cloud VPN gateway. + - >- + The external VPN gateway has only one public IP address which + internally provide redundancy or failover. + - >- + The external VPN gateway has two public IP addresses which are + redundant with each other, the following two types of setup on + your on-premises side would have this type of redundancy: (1) Two + separate on-premises gateways, each with one public IP address, + the two on-premises gateways are redundant with each other. (2) A + single on-premise gateway with two public IP addresses that are + redundant with eatch other. + enum: + - FOUR_IPS_REDUNDANCY + - SINGLE_IP_INTERNALLY_REDUNDANT + - TWO_IPS_REDUNDANCY + 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. + type: array + items: + $ref: '#/components/schemas/ExternalVpnGatewayInterface' + labels: + 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 + additionalProperties: + 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. + type: string + format: byte + ExternalVpnGatewayInterface: + id: ExternalVpnGatewayInterface + description: The interface for the external VPN gateway. + type: object + 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 + type: integer + format: uint32 + 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 + ipv6Address: + description: >- + IPv6 address of the interface in the external VPN gateway. This IPv6 + 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. Must specify an IPv6 address (not IPV4-mapped) using + any format described in RFC 4291 (e.g. 2001:db8:0:0:2d9:51:0:0). The + output format is RFC 5952 format (e.g. 2001:db8::2d9:51:0:0). + type: string + ExternalVpnGatewayList: + id: ExternalVpnGatewayList + description: >- + Response to the list request, and contains a list of + externalVpnGateways. + type: object + properties: + kind: + description: >- + [Output Only] Type of resource. Always + compute#externalVpnGatewayList for lists of externalVpnGateways. + default: compute#externalVpnGatewayList + type: string + id: + description: >- + [Output Only] Unique identifier for the resource; defined by the + server. + type: string + items: + description: A list of ExternalVpnGateway resources. + type: array + items: + $ref: '#/components/schemas/ExternalVpnGateway' + nextPageToken: + description: >- + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. + type: string + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string + warning: description: '[Output Only] Informational warning message.' type: object properties: @@ -27584,6 +28284,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -27627,6 +28330,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -27649,6 +28353,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -27685,24 +28390,40 @@ components: [Output Only] A warning data value corresponding to the key. type: string - unreachables: - description: '[Output Only] Unreachable resources.' - type: array - items: - type: string - InstantSnapshotsScopedList: - id: InstantSnapshotsScopedList + etag: + type: string + ForwardingRuleList: + id: ForwardingRuleList + description: Contains a list of ForwardingRule resources. type: object properties: - instantSnapshots: - description: '[Output Only] A list of instantSnapshots contained in this scope.' + kind: + description: Type of resource. + default: compute#forwardingRuleList + type: string + id: + description: >- + [Output Only] Unique identifier for the resource; defined by the + server. + type: string + items: + description: A list of ForwardingRule resources. type: array items: - $ref: '#/components/schemas/InstantSnapshot' - warning: + $ref: '#/components/schemas/ForwardingRule' + nextPageToken: description: >- - [Output Only] Informational warning which replaces the list of - instantSnapshots when the list is empty. + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. + type: string + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string + warning: + description: '[Output Only] Informational warning message.' type: object properties: code: @@ -27765,6 +28486,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -27808,6 +28532,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -27830,6 +28555,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -27866,423 +28592,278 @@ components: [Output Only] A warning data value corresponding to the key. type: string - InterconnectAttachmentList: - id: InterconnectAttachmentList + ForwardingRule: + id: ForwardingRule description: >- - Response to the list request, and contains a list of interconnect - attachments. + 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 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. type: object properties: kind: description: >- - [Output Only] Type of resource. Always - compute#interconnectAttachmentList for lists of interconnect - attachments. - default: compute#interconnectAttachmentList + [Output Only] Type of the resource. Always compute#forwardingRule + for forwarding rule resources. + default: compute#forwardingRule type: string id: description: >- - [Output Only] Unique identifier for the resource; defined by the - server. + [Output Only] The unique identifier for the resource. This + identifier is defined by the server. type: string - items: - description: A list of InterconnectAttachment resources. - type: array - items: - $ref: '#/components/schemas/InterconnectAttachment' - nextPageToken: + format: uint64 + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + name: description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. + 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 - selfLink: - description: '[Output Only] Server-defined URL for this resource.' + description: + description: >- + An optional description of this resource. Provide this property when + you create the resource. type: string - warning: - description: '[Output Only] Informational warning message.' - type: object - properties: - code: - description: >- - [Output Only] A warning code, if applicable. For example, - Compute Engine returns NO_RESULTS_ON_PAGE if there are no - results in the response. - type: string - enumDescriptions: - - >- - Warning about failed cleanup of transient changes made by a - failed operation. - - A link to a deprecated resource was created. - - >- - When deploying and at least one of the resources has a type - marked as deprecated - - The user created a boot disk that is larger than image size. - - >- - When deploying and at least one of the resources has a type - marked as experimental - - Warning that is present in an external api call - - >- - Warning that value of a field has been overridden. Deprecated - unused field. - - >- - The operation involved use of an injected kernel, which is - deprecated. - - >- - A WEIGHTED_MAGLEV backend service is associated with a health - check that is not of type HTTP/HTTPS/HTTP2. - - >- - When deploying a deployment with a exceedingly large number of - resources - - >- - Resource can't be retrieved due to list overhead quota exceed - which captures the amount of resources filtered out by - user-defined list filter. - - A resource depends on a missing type - - >- - The route's nextHopIp address is not assigned to an instance - on the network. - - The route's next hop instance cannot ip forward. - - >- - The route's nextHopInstance URL refers to an instance that - does not have an ipv6 interface on the same network as the - route. - - >- - The route's nextHopInstance URL refers to an instance that - does not exist. - - >- - The route's nextHopInstance URL refers to an instance that is - not on the same network as the route. - - >- - The route's next hop instance does not have a status of - RUNNING. - - >- - Error which is not critical. We decided to continue the - process despite the mentioned error. - - No results are present on a particular list page. - - >- - Success is reported, but some results may be missing due to - errors - - >- - The user attempted to use a resource that requires a TOS they - have not accepted. - - Warning that a resource is in use. - - >- - One or more of the resources set to auto-delete could not be - deleted because they were in use. - - When a resource schema validation is ignored. - - >- - Instance template used in instance group manager is valid as - such, but its application does not make a lot of sense, - because it allows only single instance in instance group. - - When undeclared properties in the schema are present - - A given scope cannot be reached. - enumDeprecated: - - false - - false - - false - - false - - false - - false - - true - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - enum: - - CLEANUP_FAILED - - DEPRECATED_RESOURCE_USED - - DEPRECATED_TYPE_USED - - DISK_SIZE_LARGER_THAN_IMAGE_SIZE - - EXPERIMENTAL_TYPE_USED - - EXTERNAL_API_WARNING - - FIELD_VALUE_OVERRIDEN - - INJECTED_KERNELS_DEPRECATED - - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB - - LARGE_DEPLOYMENT_WARNING - - LIST_OVERHEAD_QUOTA_EXCEED - - MISSING_TYPE_DEPENDENCY - - NEXT_HOP_ADDRESS_NOT_ASSIGNED - - NEXT_HOP_CANNOT_IP_FORWARD - - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE - - NEXT_HOP_INSTANCE_NOT_FOUND - - NEXT_HOP_INSTANCE_NOT_ON_NETWORK - - NEXT_HOP_NOT_RUNNING - - NOT_CRITICAL_ERROR - - NO_RESULTS_ON_PAGE - - PARTIAL_SUCCESS - - REQUIRED_TOS_AGREEMENT - - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - - RESOURCE_NOT_DELETED - - SCHEMA_VALIDATION_IGNORED - - SINGLE_INSTANCE_PROPERTY_TEMPLATE - - UNDECLARED_PROPERTIES - - UNREACHABLE - message: - description: '[Output Only] A human-readable description of the warning code.' - type: string - data: - description: >- - [Output Only] Metadata about this warning in key: value format. - For example: "data": [ { "key": "scope", "value": - "zones/us-east1-d" } - type: array - items: - type: object - properties: - key: - description: >- - [Output Only] A key that provides more detail on the - warning being returned. For example, for warnings where - there are no results in a list request for a particular - zone, this key might be scope and the key value might be - the zone name. Other examples might be a key indicating a - deprecated resource and a suggested replacement, or a - warning about invalid network settings (for example, if an - instance attempts to perform IP forwarding but is not - enabled for IP forwarding). - type: string - value: - description: >- - [Output Only] A warning data value corresponding to the - key. - type: string - InterconnectAttachment: - id: 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. - type: object - properties: - kind: + region: description: >- - [Output Only] Type of the resource. Always - compute#interconnectAttachment for interconnect attachments. - default: compute#interconnectAttachment - type: string - description: - description: An optional description of this resource. - type: string - selfLink: - description: '[Output Only] Server-defined URL for the resource.' + [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 - id: + IPAddress: description: >- - [Output Only] The unique identifier for the resource. This - identifier is defined by the server. - type: string - format: uint64 - creationTimestamp: - description: '[Output Only] Creation timestamp in RFC3339 text format.' + IP address for which this forwarding rule accepts traffic. When a + client sends traffic to this IP address, the forwarding rule directs + the traffic to the referenced target or backendService. While + creating a forwarding rule, specifying an IPAddress is required + under the following circumstances: - When the target is set to + targetGrpcProxy and validateForProxyless is set to true, the + IPAddress should be set to 0.0.0.0. - When the target is a Private + Service Connect Google APIs bundle, you must specify an IPAddress. + Otherwise, you can optionally specify an IP address that references + an existing static (reserved) IP address resource. When omitted, + Google Cloud assigns an ephemeral IP address. Use one of the + following formats to specify an IP address while creating a + forwarding rule: * IP address number, as in `100.1.2.3` * IPv6 + address range, as in `2600:1234::/96` * Full resource 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 forwarding rule's + target or backendService, and in most cases, also the + loadBalancingScheme, 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). + When reading an IPAddress, the API always returns the IP address + number. type: string - name: + IPProtocol: 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])?' + 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). type: string - interconnect: + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + enum: + - AH + - ESP + - ICMP + - L3_DEFAULT + - SCTP + - TCP + - UDP + portRange: description: >- - URL of the underlying Interconnect object that this attachment's - traffic will traverse through. + The ports, portRange, and allPorts fields are mutually exclusive. + Only packets addressed to ports in the specified range will be + forwarded to the backends configured with this forwarding rule. The + portRange field has the following limitations: - It requires that + the forwarding rule IPProtocol be TCP, UDP, or SCTP, and - It's + applicable only to the following products: external passthrough + Network Load Balancers, internal and external proxy Network Load + Balancers, internal and external Application Load Balancers, + external protocol forwarding, and Classic VPN. - Some products have + restrictions on what ports can be used. See port specifications for + details. For external forwarding rules, two or more forwarding rules + cannot use the same [IPAddress, IPProtocol] pair, and cannot have + overlapping portRanges. For internal forwarding rules within the + same VPC network, two or more forwarding rules cannot use the same + [IPAddress, IPProtocol] pair, and cannot have overlapping + portRanges. @pattern: \\d+(?:-\\d+)? type: string - router: + ports: 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 - region: + The ports, portRange, and allPorts fields are mutually exclusive. + Only packets addressed to ports in the specified range will be + forwarded to the backends configured with this forwarding rule. The + ports field has the following limitations: - It requires that the + forwarding rule IPProtocol be TCP, UDP, or SCTP, and - It's + applicable only to the following products: internal passthrough + Network Load Balancers, backend service-based external passthrough + Network Load Balancers, and internal protocol forwarding. - You can + specify a list of up to five ports by number, separated by commas. + The ports can be contiguous or discontiguous. For external + forwarding rules, two or more forwarding rules cannot use the same + [IPAddress, IPProtocol] pair if they share at least one port number. + For internal forwarding rules within the same VPC network, two or + more forwarding rules cannot use the same [IPAddress, IPProtocol] + pair if they share at least one port number. @pattern: + \\d+(?:-\\d+)? + type: array + items: + type: string + target: 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. + The URL of the target resource to receive the matched traffic. For + regional forwarding rules, this target must be in the same region as + the forwarding rule. For global forwarding rules, this target must + be a global load balancing resource. The forwarded traffic must be + of a type appropriate to the target object. - For load balancers, + see the "Target" column in [Port + specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). + - For Private Service Connect forwarding rules that forward traffic + to Google APIs, provide the name of a supported Google API bundle: - + vpc-sc - APIs that support VPC Service Controls. - all-apis - All + supported Google APIs. - For Private Service Connect forwarding + rules that forward traffic to managed services, the target must be a + service attachment. The target is not mutable once set as a service + attachment. 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. - deprecated: true + selfLink: + description: '[Output Only] Server-defined URL for the resource.' 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. - type: integer - format: int32 - privateInterconnectInfo: + selfLinkWithId: description: >- - [Output Only] Information specific to an InterconnectAttachment. - This property is populated if the interconnect that this is attached - to is of type DEDICATED. - $ref: '#/components/schemas/InterconnectAttachmentPrivateInfo' - operationalStatus: + [Output Only] Server-defined URL for this resource with the resource + id. + type: string + loadBalancingScheme: 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. + Specifies the forwarding rule type. For more information about + forwarding rules, refer to Forwarding rule concepts. type: string enumDescriptions: - - Indicates that attachment has been turned up and is ready to use. - - >- - Indicates that attachment is not ready to use yet, because turnup - is not complete. + - '' + - '' + - '' + - '' + - '' + - '' enum: - - OS_ACTIVE - - OS_UNPROVISIONED - cloudRouterIpAddress: - description: >- - [Output Only] IPv4 address + prefix length to be configured on Cloud - Router Interface for this interconnect attachment. - type: string - customerRouterIpAddress: + - EXTERNAL + - EXTERNAL_MANAGED + - INTERNAL + - INTERNAL_MANAGED + - INTERNAL_SELF_MANAGED + - INVALID + subnetwork: description: >- - [Output Only] IPv4 address + prefix length to be configured on the - customer router subinterface for this interconnect attachment. + This field identifies the subnetwork that the load balanced IP + should belong to for this forwarding rule, used with internal load + balancers and external passthrough Network Load Balancers 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 - type: + network: 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. + This field is not used for global external load balancing. For + internal passthrough Network Load Balancers, this field identifies + the network that the load balanced IP should belong to for this + forwarding rule. If the subnetwork is specified, the network of the + subnetwork will be used. If neither subnetwork nor this field is + 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 - enumDescriptions: - - Attachment to a dedicated interconnect. - - Attachment to a partner interconnect, created by the customer. - - Attachment to a partner interconnect, created by the partner. - enum: - - DEDICATED - - PARTNER - - PARTNER_PROVIDER - pairingKey: + backendService: description: >- - [Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not - present for DEDICATED]. The opaque identifier of a PARTNER - attachment used to initiate provisioning with a selected partner. Of - the form "XXXXX/region/domain" + Identifies the backend service to which the forwarding rule sends + traffic. Required for internal and external passthrough Network Load + Balancers; must be omitted for all other load balancer types. type: string - adminEnabled: - description: >- - Determines whether this Attachment will carry packets. Not present - for PARTNER_PROVIDER. - type: boolean - vlanTag8021q: + serviceDirectoryRegistrations: description: >- - The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093. - Only specified at creation time. - type: integer - format: int32 - edgeAvailabilityDomain: + Service Directory resources to register this forwarding rule with. + Currently, only supports a single Service Directory resource. + type: array + items: + $ref: '#/components/schemas/ForwardingRuleServiceDirectoryRegistration' + serviceLabel: 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. + 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 - enumDescriptions: - - '' - - '' - - '' - enum: - - AVAILABILITY_DOMAIN_1 - - AVAILABILITY_DOMAIN_2 - - AVAILABILITY_DOMAIN_ANY - candidateSubnets: + serviceName: 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. - type: array - items: - type: string - bandwidth: + [Output Only] The internal fully qualified service name for this + forwarding rule. This field is only used for internal load + balancing. + type: string + networkTier: 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 + 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. type: string enumDescriptions: - - 100 Mbit/s - - 10 Gbit/s - - 1 Gbit/s - - 200 Mbit/s - - 20 Gbit/s - - 2 Gbit/s - - 300 Mbit/s - - 400 Mbit/s - - 500 Mbit/s - - 50 Gbit/s - - 50 Mbit/s - - 5 Gbit/s + - Public internet quality with fixed bandwidth. + - >- + High quality, Google-grade network tier, support for all + networking products. + - >- + Public internet quality, only limited support for other networking + products. + - >- + (Output only) Temporary tier for FIXED_STANDARD when fixed + standard tier is expired or not configured. 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 - partnerMetadata: - description: >- - Informational metadata about Partner attachments from Partners to - display to customers. Output only for PARTNER type, mutable for - PARTNER_PROVIDER, not available for DEDICATED. - $ref: '#/components/schemas/InterconnectAttachmentPartnerMetadata' + - FIXED_STANDARD + - PREMIUM + - STANDARD + - STANDARD_OVERRIDES_FIXED_STANDARD labels: description: >- Labels for this resource. These can only be added or modified by the @@ -28293,291 +28874,302 @@ components: type: string labelFingerprint: description: >- - A fingerprint for the labels being applied to this - InterconnectAttachment, 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 - InterconnectAttachment. + 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. type: string format: byte - state: + ipVersion: 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. + The IP Version that will be used by this forwarding rule. Valid + options are IPV4 or IPV6. type: string enumDescriptions: - - Indicates that attachment has been turned up and is ready to use. - - >- - The attachment was deleted externally and is no longer functional. - This could be because the associated Interconnect was wiped out, - or because the other side of a Partner attachment was deleted. - - >- - A PARTNER attachment is in the process of provisioning after a - PARTNER_PROVIDER attachment was created that references it. - - >- - PARTNER or PARTNER_PROVIDER attachment that is waiting for the - customer to activate. - - >- - A newly created PARTNER attachment that has not yet been - configured on the Partner side. - '' - - >- - Indicates that attachment is not ready to use yet, because turnup - is not complete. + - '' + - '' enum: - - ACTIVE - - DEFUNCT - - PARTNER_REQUEST_RECEIVED - - PENDING_CUSTOMER - - PENDING_PARTNER - - STATE_UNSPECIFIED - - UNPROVISIONED - partnerAsn: + - IPV4 + - IPV6 + - UNSPECIFIED_VERSION + fingerprint: 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. + 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. type: string - format: int64 - encryption: + format: byte + allPorts: 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 *HA VPN over - Cloud Interconnect*, the VLAN attachment must be created with this - option. - type: string - enumDescriptions: - - >- - The interconnect attachment will carry only encrypted traffic that - is encrypted by an IPsec device such as HA VPN gateway; VMs cannot - directly send traffic to or receive traffic from such an - interconnect attachment. To use HA VPN over Cloud Interconnect, - the interconnect attachment must be created with this option. - - >- - This is the default value, which means the Interconnect Attachment - will carry unencrypted traffic. VMs will be able to send traffic - to or receive traffic from such interconnect attachment. - enum: - - IPSEC - - NONE - ipsecInternalAddresses: + The ports, portRange, and allPorts fields are mutually exclusive. + Only packets addressed to ports in the specified range will be + forwarded to the backends configured with this forwarding rule. The + allPorts field has the following limitations: - It requires that the + forwarding rule IPProtocol be TCP, UDP, SCTP, or L3_DEFAULT. - It's + applicable only to the following products: internal passthrough + Network Load Balancers, backend service-based external passthrough + Network Load Balancers, and internal and external protocol + forwarding. - Set this field to true to allow packets addressed to + any port or packets lacking destination port information (for + example, UDP fragments after the first fragment) to be forwarded to + the backends configured with this forwarding rule. The L3_DEFAULT + protocol requires allPorts be set to true. + type: boolean + allowGlobalAccess: 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. + If set to true, clients can access the internal passthrough Network + Load Balancers, the regional internal Application Load Balancer, and + the regional internal proxy Network Load Balancer from all regions. + If false, only allows access from the local region the load balancer + is located at. Note that for INTERNAL_MANAGED forwarding rules, this + field cannot be changed after the forwarding rule is created. + type: boolean + 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. type: array items: - type: string - dataplaneVersion: + $ref: '#/components/schemas/MetadataFilter' + isMirroringCollector: description: >- - [Output Only] Dataplane version for this InterconnectAttachment. - This field is only present for Dataplane version 2 and higher. - Absence of this field in the API output indicates that the Dataplane - is version 1. - type: integer - format: int32 - satisfiesPzs: - description: '[Output Only] Reserved for future use.' + 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 - stackType: - description: >- - The stack type for this interconnect attachment 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 interconnect attachments - creation and update interconnect attachment operations. - type: string - enumDescriptions: - - The interconnect attachment can have both IPv4 and IPv6 addresses. - - The interconnect attachment will only be assigned IPv4 addresses. - enum: - - IPV4_IPV6 - - IPV4_ONLY - cloudRouterIpv6Address: - description: >- - [Output Only] IPv6 address + prefix length to be configured on Cloud - Router Interface for this interconnect attachment. - type: string - customerRouterIpv6Address: + sourceIpRanges: description: >- - [Output Only] IPv6 address + prefix length to be configured on the - customer router subinterface for this interconnect attachment. - type: string - candidateIpv6Subnets: - description: This field is not available. + If not empty, this forwarding rule will only forward the traffic + when the source IP address matches one of the IP addresses or CIDR + ranges set here. Note that a forwarding rule can only have up to 64 + source IP ranges, and this field can only be used with a regional + forwarding rule whose scheme is EXTERNAL. Each source_ip_range entry + should be either an IP address (for example, 1.2.3.4) or a CIDR + range (for example, 1.2.3.0/24). type: array items: type: string - cloudRouterIpv6InterfaceId: - description: This field is not available. + pscConnectionId: + description: '[Output Only] The PSC connection id of the PSC forwarding rule.' type: string - customerRouterIpv6InterfaceId: - description: This field is not available. + format: uint64 + pscConnectionStatus: type: string - subnetLength: - description: >- - Length of the IPv4 subnet mask. Allowed values: - 29 (default) - 30 - The default value is 29, except for Cross-Cloud Interconnect - connections that use an InterconnectRemoteLocation with a - constraints.subnetLengthRange.min equal to 30. For example, - connections that use an Azure remote location fall into this - category. In these cases, the default value is 30, and requesting 29 - returns an error. Where both 29 and 30 are allowed, 29 is preferred, - because it gives Google Cloud Support more debugging visibility. - type: integer - format: int32 - remoteService: + enumDescriptions: + - The connection has been accepted by the producer. + - >- + The connection has been closed by the producer and will not serve + traffic going forward. + - >- + The connection has been accepted by the producer, but the producer + needs to take further action before the forwarding rule can serve + traffic. + - The connection is pending acceptance by the producer. + - The connection has been rejected by the producer. + - '' + enum: + - ACCEPTED + - CLOSED + - NEEDS_ATTENTION + - PENDING + - REJECTED + - STATUS_UNSPECIFIED + baseForwardingRule: description: >- - [Output Only] If the attachment is on a Cross-Cloud Interconnect - connection, this field contains the interconnect's remote location - service provider. Example values: "Amazon Web Services" "Microsoft - Azure". The field is set only for attachments on Cross-Cloud - Interconnect connections. Its value is copied from the - InterconnectRemoteLocation remoteService field. + [Output Only] The URL for the corresponding base forwarding rule. By + base forwarding rule, we mean the forwarding rule that has the same + IP address, protocol, and port settings with the current forwarding + rule, but without sourceIPRanges specified. Always empty if the + current forwarding rule does not have sourceIPRanges specified. type: string - configurationConstraints: + allowPscGlobalAccess: description: >- - [Output Only] Constraints for this attachment, if any. The - attachment does not work if these constraints are not met. - $ref: '#/components/schemas/InterconnectAttachmentConfigurationConstraints' - InterconnectAttachmentPrivateInfo: - id: InterconnectAttachmentPrivateInfo - description: >- - Information for an interconnect attachment when this belongs to an - interconnect of type DEDICATED. - type: object - properties: - tag8021q: + This is used in PSC consumer ForwardingRule to control whether the + PSC endpoint can be accessed from another region. + type: boolean + noAutomateDnsZone: 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. - type: integer - format: uint32 - InterconnectAttachmentPartnerMetadata: - id: InterconnectAttachmentPartnerMetadata + This is used in PSC consumer ForwardingRule to control whether it + should try to auto-generate a DNS zone or not. Non-PSC forwarding + rules do not use this field. Once set, this field is not mutable. + type: boolean + ipCollection: + description: >- + Resource reference of a PublicDelegatedPrefix. The PDP must be a + sub-PDP in EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode. Use one of + the following formats to specify a sub-PDP when creating an IPv6 + NetLB forwarding rule using BYOIP: Full resource URL, as in + https://www.googleapis.com/compute/v1/projects/project_id/regions/region + /publicDelegatedPrefixes/sub-pdp-name Partial URL, as in: - + projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name + - regions/region/publicDelegatedPrefixes/sub-pdp-name + type: string + externalManagedBackendBucketMigrationState: + description: >- + Specifies the canary migration state for the backend buckets + attached to this forwarding rule. Possible values are PREPARE, + TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration + from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to + PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the + loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, + the TEST_BY_PERCENTAGE state can be used to migrate traffic to + backend buckets attached to this forwarding rule by percentage using + externalManagedBackendBucketMigrationTestingPercentage. Rolling back + a migration requires the states to be set in reverse order. So + changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the + state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, + the TEST_BY_PERCENTAGE state can be used to migrate some traffic + back to EXTERNAL or PREPARE can be used to migrate all traffic back + to EXTERNAL. + type: string + enumDescriptions: + - '' + - '' + - '' + enum: + - PREPARE + - TEST_ALL_TRAFFIC + - TEST_BY_PERCENTAGE + externalManagedBackendBucketMigrationTestingPercentage: + description: >- + Determines the fraction of requests to backend buckets that should + be processed by the global external Application Load Balancer. The + value of this field must be in the range [0, 100]. This value can + only be set if the loadBalancingScheme in the BackendService is set + to EXTERNAL (when using the classic Application Load Balancer) and + the migration state is TEST_BY_PERCENTAGE. + type: number + format: float + ForwardingRuleServiceDirectoryRegistration: + id: ForwardingRuleServiceDirectoryRegistration 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. + 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. type: object properties: - partnerName: - description: >- - Plain text name of the Partner providing this attachment. This value - may be validated to match approved Partner values. + namespace: + description: Service Directory namespace to register the forwarding rule under. type: string - 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. + service: + description: Service Directory service to register the forwarding rule under. type: string - portalUrl: + serviceDirectoryRegion: 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. + [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 - InterconnectAttachmentConfigurationConstraints: - id: InterconnectAttachmentConfigurationConstraints + MetadataFilter: + id: MetadataFilter + description: >- + Opaque filter criteria used by load balancers to restrict routing + configuration to a limited set of load balancing proxies. Proxies and + sidecars involved in load balancing would typically present metadata to + the load balancers that 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 load + balancing involves Envoys, they receive routing configuration when + values in metadataFilters match values supplied in of their XDS requests + to loadbalancers. type: object properties: - bgpMd5: + filterMatchCriteria: description: >- - [Output Only] Whether the attachment's BGP session - requires/allows/disallows BGP MD5 authentication. This can take one - of the following values: MD5_OPTIONAL, MD5_REQUIRED, - MD5_UNSUPPORTED. For example, a Cross-Cloud Interconnect connection - to a remote cloud provider that requires BGP MD5 authentication has - the interconnectRemoteLocation - attachment_configuration_constraints.bgp_md5 field set to - MD5_REQUIRED, and that property is propagated to the attachment. - Similarly, if BGP MD5 is MD5_UNSUPPORTED, an error is returned if - MD5 is requested. + Specifies how individual filter label matches within the list of + filterLabels and contributes toward 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. type: string enumDescriptions: - >- - MD5_OPTIONAL: BGP MD5 authentication is supported and can - optionally be configured. - - 'MD5_REQUIRED: BGP MD5 authentication must be configured.' - - 'MD5_UNSUPPORTED: BGP MD5 authentication must not be configured' + Specifies that all filterLabels must match for the metadataFilter + to be considered a match. + - >- + Specifies that any filterLabel must match for the metadataFilter + to be considered a match. + - >- + Indicates that the match criteria was not set. A metadataFilter + must never be created with this value. enum: - - MD5_OPTIONAL - - MD5_REQUIRED - - MD5_UNSUPPORTED - bgpPeerAsnRanges: + - MATCH_ALL + - MATCH_ANY + - NOT_SET + filterLabels: description: >- - [Output Only] List of ASN ranges that the remote location is known - to support. Formatted as an array of inclusive ranges {min: - min-value, max: max-value}. For example, [{min: 123, max: 123}, - {min: 64512, max: 65534}] allows the peer ASN to be 123 or anything - in the range 64512-65534. This field is only advisory. Although the - API accepts other ranges, these are the ranges that we recommend. + 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. type: array items: - $ref: >- - #/components/schemas/InterconnectAttachmentConfigurationConstraintsBgpPeerASNRange - InterconnectAttachmentConfigurationConstraintsBgpPeerASNRange: - id: InterconnectAttachmentConfigurationConstraintsBgpPeerASNRange + $ref: '#/components/schemas/MetadataFilterLabelMatch' + MetadataFilterLabelMatch: + id: MetadataFilterLabelMatch + description: >- + MetadataFilter label name value pairs that are expected to match + corresponding labels presented as metadata to the load balancer. type: object properties: - min: - type: integer - format: uint32 - max: - type: integer - format: uint32 - InterconnectAttachmentAggregatedList: - id: InterconnectAttachmentAggregatedList + 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 + TargetReference: + id: TargetReference + type: object + properties: + target: + type: string + ForwardingRuleAggregatedList: + id: ForwardingRuleAggregatedList type: object properties: kind: description: >- [Output Only] Type of resource. Always - compute#interconnectAttachmentAggregatedList for aggregated lists of - interconnect attachments. - default: compute#interconnectAttachmentAggregatedList + compute#forwardingRuleAggregatedList for lists of forwarding rules. + default: compute#forwardingRuleAggregatedList type: string id: description: >- @@ -28585,11 +29177,11 @@ components: server. type: string items: - description: A list of InterconnectAttachmentsScopedList resources. + description: A list of ForwardingRulesScopedList resources. type: object additionalProperties: - description: Name of the scope containing this set of interconnect attachments. - $ref: '#/components/schemas/InterconnectAttachmentsScopedList' + description: Name of the scope containing this set of addresses. + $ref: '#/components/schemas/ForwardingRulesScopedList' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -28665,6 +29257,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -28708,6 +29303,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -28730,6 +29326,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -28771,19 +29368,19 @@ components: type: array items: type: string - InterconnectAttachmentsScopedList: - id: InterconnectAttachmentsScopedList + ForwardingRulesScopedList: + id: ForwardingRulesScopedList type: object properties: - interconnectAttachments: - description: A list of interconnect attachments contained in this scope. + forwardingRules: + description: A list of forwarding rules contained in this scope. type: array items: - $ref: '#/components/schemas/InterconnectAttachment' + $ref: '#/components/schemas/ForwardingRule' warning: description: >- - Informational warning which replaces the list of addresses when the - list is empty. + Informational warning which replaces the list of forwarding rules + when the list is empty. type: object properties: code: @@ -28846,6 +29443,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -28889,6 +29489,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -28911,6 +29512,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -28947,482 +29549,36 @@ components: [Output Only] A warning data value corresponding to the key. type: string - Interconnect: - id: Interconnect - description: >- - Represents an Interconnect resource. An Interconnect resource is a - dedicated connection between the Google Cloud network and your - on-premises network. For more information, read the Dedicated - Interconnect Overview. + HealthCheckServicesList: + id: HealthCheckServicesList type: object properties: kind: description: >- - [Output Only] Type of the resource. Always compute#interconnect for - interconnects. - default: compute#interconnect - type: string - description: - description: >- - An optional description of this resource. Provide this property when - you create the resource. - type: string - selfLink: - description: '[Output Only] Server-defined URL for the resource.' + [Output Only] Type of the resource. Always + compute#healthCheckServicesList for lists of HealthCheckServices. + default: compute#healthCheckServicesList type: string id: description: >- - [Output Only] The unique identifier for the resource. This - identifier is defined by the server. - type: string - format: uint64 - creationTimestamp: - description: '[Output Only] Creation timestamp in RFC3339 text format.' - 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])?' - annotations: - required: - - compute.interconnects.insert - type: string - location: - description: >- - URL of the InterconnectLocation object that represents where this - connection is to be provisioned. + [Output Only] Unique identifier for the resource; defined by the + server. type: string - linkType: + items: + description: A list of HealthCheckService resources. + type: array + items: + $ref: '#/components/schemas/HealthCheckService' + nextPageToken: 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. + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. type: string - enumDescriptions: - - 100G Ethernet, LR Optics. - - 10G Ethernet, LR Optics. [(rate_bps) = 10000000000]; - enum: - - LINK_TYPE_ETHERNET_100G_LR - - LINK_TYPE_ETHERNET_10G_LR - requestedLinkCount: - description: >- - Target number of physical links in the link bundle, as requested by - the customer. - type: integer - format: int32 - 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. - type: string - enumDescriptions: - - A dedicated physical interconnection with the customer. - - >- - [Deprecated] A private, physical interconnection with the - customer. - - >- - A partner-managed interconnection shared between customers via - partner. - enum: - - DEDICATED - - IT_PRIVATE - - PARTNER - 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 - 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 Cloud Monitoring logs alerting and Cloud - Notifications. This field is required for users who sign up for - Cloud Interconnect using workforce identity federation. - type: string - customerName: - description: >- - Customer name, to put in the Letter of Authorization as the party - authorized to request a crossconnect. - 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. - type: string - enumDescriptions: - - >- - The interconnect is valid, turned up, and ready to use. - Attachments may be provisioned on this interconnect. - - >- - The interconnect has not completed turnup. No attachments may be - provisioned on this interconnect. - enum: - - OS_ACTIVE - - OS_UNPROVISIONED - provisionedLinkCount: - description: >- - [Output Only] Number of links actually provisioned in this - interconnect. - type: integer - format: int32 - interconnectAttachments: - description: >- - [Output Only] A list of the URLs of all InterconnectAttachments - configured to use this Interconnect. - type: array - items: - 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 - 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 - expectedOutages: - description: '[Output Only] A list of outages expected for this Interconnect.' - type: array - items: - $ref: '#/components/schemas/InterconnectOutageNotification' - circuitInfos: - description: >- - [Output Only] A list of CircuitInfo objects, that describe the - individual circuits in this LAG. - type: array - items: - $ref: '#/components/schemas/InterconnectCircuitInfo' - labels: - 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 - additionalProperties: - type: string - labelFingerprint: - description: >- - A fingerprint for the labels being applied to this Interconnect, - 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 Interconnect. - type: string - format: byte - 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. - type: string - enumDescriptions: - - >- - The interconnect is valid, turned up, and ready to use. - Attachments may be provisioned on this interconnect. - - >- - The interconnect has not completed turnup. No attachments may be - provisioned on this interconnect. - enum: - - ACTIVE - - UNPROVISIONED - satisfiesPzs: - description: '[Output Only] Reserved for future use.' - type: boolean - macsec: - description: >- - Configuration that enables Media Access Control security (MACsec) on - the Cloud Interconnect connection between Google and your - on-premises router. - $ref: '#/components/schemas/InterconnectMacsec' - macsecEnabled: - description: >- - Enable or disable MACsec on this Interconnect connection. MACsec - enablement fails if the MACsec object is not specified. - type: boolean - remoteLocation: - description: >- - Indicates that this is a Cross-Cloud Interconnect. This field - specifies the location outside of Google's network that the - interconnect is connected to. - type: string - requestedFeatures: - description: >- - Optional. List of features requested for this Interconnect - connection, which can take one of the following values: - IF_MACSEC - If specified then the connection is created on MACsec capable - hardware ports. If not specified, the default value is false, which - allocates non-MACsec capable ports first if available. This - parameter can be provided only with Interconnect INSERT. It isn't - valid for Interconnect PATCH. - type: array - items: - type: string - enumDescriptions: - - Media Access Control security (MACsec) - enum: - - IF_MACSEC - availableFeatures: - description: >- - [Output only] List of features available for this Interconnect - connection, which can take one of the following values: - IF_MACSEC - If present then the Interconnect connection is provisioned on MACsec - capable hardware ports. If not present then the Interconnect - connection is provisioned on non-MACsec capable ports and MACsec - isn't supported and enabling MACsec fails. - type: array - items: - type: string - enumDescriptions: - - Media Access Control security (MACsec) - enum: - - IF_MACSEC - InterconnectOutageNotification: - id: InterconnectOutageNotification - description: Description of a planned outage on this Interconnect. - type: object - properties: - name: - description: Unique identifier for this outage notification. - type: string - description: - description: A description about the purpose of the outage. - 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. - type: string - enumDescriptions: - - This notification was generated by Google. - - '[Deprecated] This notification was generated by Google.' - enum: - - GOOGLE - - NSRC_GOOGLE - 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. - type: string - enumDescriptions: - - >- - This outage notification is active. The event could be in the - future, present, or past. See start_time and end_time for - scheduling. - - >- - The outage associated with this notification was cancelled before - the outage was due to start. - - The outage associated with this notification is complete. - - >- - [Deprecated] This outage notification is active. The event could - be in the future, present, or past. See start_time and end_time - for scheduling. - - >- - [Deprecated] The outage associated with this notification was - canceled before the outage was due to start. - enum: - - ACTIVE - - CANCELLED - - COMPLETED - - NS_ACTIVE - - NS_CANCELED - 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. - type: string - enumDescriptions: - - >- - [Deprecated] The Interconnect may be completely out of service for - some or all of the specified window. - - >- - [Deprecated] Some circuits comprising the Interconnect will be out - of service during the expected window. The interconnect as a whole - should remain up, albeit with reduced bandwidth. - - >- - The Interconnect may be completely out of service for some or all - of the specified window. - - >- - Some circuits comprising the Interconnect will be out of service - during the expected window. The interconnect as a whole should - remain up, albeit with reduced bandwidth. - enum: - - IT_OUTAGE - - IT_PARTIAL_OUTAGE - - OUTAGE - - PARTIAL_OUTAGE - affectedCircuits: - description: >- - If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side - circuit IDs that will be affected. - type: array - items: - type: string - startTime: - description: Scheduled start time for the outage (milliseconds since Unix epoch). - type: string - format: int64 - endTime: - description: Scheduled end time for the outage (milliseconds since Unix epoch). - type: string - format: int64 - InterconnectCircuitInfo: - id: InterconnectCircuitInfo - description: >- - Describes a single physical circuit between the Customer and Google. - CircuitInfo objects are created by Google, so all fields are output - only. - type: object - properties: - 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 - customerDemarcId: - description: Customer-side demarc ID for this circuit. - type: string - InterconnectMacsec: - id: InterconnectMacsec - description: >- - Configuration information for enabling Media Access Control security - (MACsec) on this Cloud Interconnect connection between Google and your - on-premises router. - type: object - properties: - preSharedKeys: - description: >- - Required. A keychain placeholder describing a set of named key - objects along with their start times. A MACsec CKN/CAK is generated - for each key in the key chain. Google router automatically picks the - key with the most recent startTime when establishing or - re-establishing a MACsec secure link. - type: array - items: - $ref: '#/components/schemas/InterconnectMacsecPreSharedKey' - failOpen: - description: >- - If set to true, the Interconnect connection is configured with a - should-secure MACsec security policy, that allows the Google router - to fallback to cleartext traffic if the MKA session cannot be - established. By default, the Interconnect connection is configured - with a must-secure security policy that drops all traffic if the MKA - session cannot be established with your router. - type: boolean - InterconnectMacsecPreSharedKey: - id: InterconnectMacsecPreSharedKey - description: >- - Describes a pre-shared key used to setup MACsec in static connectivity - association key (CAK) mode. - type: object - properties: - name: - description: >- - Required. A name for this pre-shared key. The name must be 1-63 - characters long, and comply with RFC1035. Specifically, the name - must be 1-63 characters long and match the regular expression - `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be - a lowercase letter, and all following characters must be a dash, - lowercase letter, or digit, except the last character, which cannot - be a dash. - type: string - startTime: - description: >- - A RFC3339 timestamp on or after which the key is valid. startTime - can be in the future. If the keychain has a single key, startTime - can be omitted. If the keychain has multiple keys, startTime is - mandatory for each key. The start times of keys must be in - increasing order. The start times of two consecutive keys must be at - least 6 hours apart. - type: string - InterconnectList: - id: InterconnectList - description: Response to the list request, and contains a list of interconnects. - type: object - properties: - kind: - description: >- - [Output Only] Type of resource. Always compute#interconnectList for - lists of interconnects. - default: compute#interconnectList - type: string - id: - description: >- - [Output Only] Unique identifier for the resource; defined by the - server. - type: string - items: - description: A list of Interconnect resources. - type: array - items: - $ref: '#/components/schemas/Interconnect' - nextPageToken: - description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. - type: string - selfLink: - description: '[Output Only] Server-defined URL for this resource.' + selfLink: + description: '[Output Only] Server-defined URL for this resource.' type: string warning: description: '[Output Only] Informational warning message.' @@ -29488,6 +29644,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -29531,6 +29690,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -29553,6 +29713,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -29589,262 +29750,132 @@ components: [Output Only] A warning data value corresponding to the key. type: string - InterconnectsGetDiagnosticsResponse: - id: InterconnectsGetDiagnosticsResponse - description: Response for the InterconnectsGetDiagnosticsRequest. - type: object - properties: - result: - $ref: '#/components/schemas/InterconnectDiagnostics' - InterconnectDiagnostics: - id: InterconnectDiagnostics - description: >- - Diagnostics information about the Interconnect connection, which - contains detailed and current technical information about Google's side - of the connection. + HealthCheckService: + id: HealthCheckService + description: Represents a Health-Check as a Service resource. type: object properties: - macAddress: - description: The MAC address of the Interconnect's bundle interface. - type: string - 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. - type: array - items: - $ref: '#/components/schemas/InterconnectDiagnosticsARPEntry' - links: + kind: description: >- - A list of InterconnectDiagnostics.LinkStatus objects, describing the - status for each link on the Interconnect. - type: array - items: - $ref: '#/components/schemas/InterconnectDiagnosticsLinkStatus' - bundleOperationalStatus: - description: The operational status of the bundle interface. - type: string - enumDescriptions: - - >- - If bundleAggregationType is LACP: LACP is not established and/or - all links in the bundle have DOWN operational status. If - bundleAggregationType is STATIC: one or more links in the bundle - has DOWN operational status. - - >- - If bundleAggregationType is LACP: LACP is established and at least - one link in the bundle has UP operational status. If - bundleAggregationType is STATIC: all links in the bundle - (typically just one) have UP operational status. - enum: - - BUNDLE_OPERATIONAL_STATUS_DOWN - - BUNDLE_OPERATIONAL_STATUS_UP - bundleAggregationType: - description: The aggregation type of the bundle interface. + [Output only] Type of the resource. Always + compute#healthCheckServicefor health check services. + default: compute#healthCheckService type: string - enumDescriptions: - - LACP is enabled. - - LACP is disabled. - enum: - - BUNDLE_AGGREGATION_TYPE_LACP - - BUNDLE_AGGREGATION_TYPE_STATIC - InterconnectDiagnosticsARPEntry: - id: InterconnectDiagnosticsARPEntry - description: Describing the ARP neighbor entries seen on this link - type: object - properties: - macAddress: - description: The MAC address of this ARP neighbor. + id: + description: >- + [Output Only] The unique identifier for the resource. This + identifier is defined by the server. type: string - ipAddress: - description: The IP address of this ARP neighbor. + format: uint64 + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' type: string - InterconnectDiagnosticsLinkStatus: - id: InterconnectDiagnosticsLinkStatus - type: object - properties: - circuitId: - description: The unique ID for this link assigned during turn up by Google. + selfLink: + description: '[Output Only] Server-defined URL for the resource.' type: string - googleDemarc: - description: The Demarc address assigned by Google and provided in the LoA. + 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 - receivingOpticalPower: + description: description: >- - An InterconnectDiagnostics.LinkOpticalPower object, describing the - current value and status of the received light level. - $ref: '#/components/schemas/InterconnectDiagnosticsLinkOpticalPower' - transmittingOpticalPower: + An optional description of this resource. Provide this property when + you create the resource. + type: string + region: description: >- - An InterconnectDiagnostics.LinkOpticalPower object, describing the - current value and status of the transmitted light level. - $ref: '#/components/schemas/InterconnectDiagnosticsLinkOpticalPower' - lacpStatus: - $ref: '#/components/schemas/InterconnectDiagnosticsLinkLACPStatus' - operationalStatus: - description: The operational status of the link. + [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 - enumDescriptions: - - The interface is unable to communicate with the remote end. - - The interface has low level communication with the remote end. - enum: - - LINK_OPERATIONAL_STATUS_DOWN - - LINK_OPERATIONAL_STATUS_UP - arpCaches: + healthStatusAggregationPolicy: 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 - type: array - items: - $ref: '#/components/schemas/InterconnectDiagnosticsARPEntry' - macsec: - description: Describes the status of MACsec encryption on this link. - $ref: '#/components/schemas/InterconnectDiagnosticsMacsecStatus' - InterconnectDiagnosticsLinkOpticalPower: - id: InterconnectDiagnosticsLinkOpticalPower - type: object - properties: - 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. - type: number - format: float - 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. + 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. . This is only allowed + with regional HealthCheckService. type: string enumDescriptions: - - The value has crossed above the high alarm threshold. - >- - The value of the current optical power has crossed above the high - warning threshold. - - >- - The value of the current optical power has crossed below the low - alarm threshold. - - >- - The value of the current optical power has crossed below the low - warning threshold. + If any backend's health check reports UNHEALTHY, then UNHEALTHY is + the HealthState of the entire health check service. If all + backend's are healthy, the HealthState of the health check service + is HEALTHY. - >- - The value of the current optical power has not crossed a warning - threshold. + An EndpointHealth message is returned for each backend in the + health check service. enum: - - HIGH_ALARM - - HIGH_WARNING - - LOW_ALARM - - LOW_WARNING - - OK - InterconnectDiagnosticsLinkLACPStatus: - id: InterconnectDiagnosticsLinkLACPStatus - type: object - properties: - state: + - AND + - NO_AGGREGATION + healthChecks: 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. - type: string - enumDescriptions: - - The link is configured and active within the bundle. - - >- - The link is not configured within the bundle, this means the rest - of the object should be empty. - enum: - - ACTIVE - - DETACHED - 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 - InterconnectDiagnosticsMacsecStatus: - id: InterconnectDiagnosticsMacsecStatus - description: Describes the status of MACsec encryption on the link. - type: object - properties: - operational: - description: Indicates whether or not MACsec is operational on this link. - type: boolean - ckn: + A list of URLs to the HealthCheck resources. Must have at least one + HealthCheck, and not more than 10 for regional HealthCheckService, + and not more than 1 for global HealthCheckService. 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 NetworkEndpointGroups. For global + HealthCheckService using global INTERNET_IP_PORT + NetworkEndpointGroups, the global HealthChecks must specify + sourceRegions, and HealthChecks that specify sourceRegions can only + be used with global INTERNET_IP_PORT NetworkEndpointGroups. + type: array + items: + type: string + networkEndpointGroups: description: >- - Indicates the Connectivity Association Key Name (CKN) currently - being used if MACsec is operational. - type: string - InterconnectsGetMacsecConfigResponse: - id: InterconnectsGetMacsecConfigResponse - description: Response for the InterconnectsGetMacsecConfigRequest. - type: object - properties: - result: - $ref: '#/components/schemas/InterconnectMacsecConfig' - etag: - description: 'end_interface: MixerGetResponseWithEtagBuilder' - type: string - InterconnectMacsecConfig: - id: InterconnectMacsecConfig - description: >- - MACsec configuration information for the Interconnect connection. - Contains the generated Connectivity Association Key Name (CKN) and the - key (CAK) for this Interconnect connection. - type: object - properties: - preSharedKeys: + 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. For global + HealthCheckServices, the NetworkEndpointGroups must be global + INTERNET_IP_PORT. + type: array + items: + type: string + notificationEndpoints: description: >- - A keychain placeholder describing a set of named key objects along - with their start times. A MACsec CKN/CAK is generated for each key - in the key chain. Google router automatically picks the key with the - most recent startTime when establishing or re-establishing a MACsec - secure link. + 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. type: array items: - $ref: '#/components/schemas/InterconnectMacsecConfigPreSharedKey' - InterconnectMacsecConfigPreSharedKey: - id: InterconnectMacsecConfigPreSharedKey - description: >- - Describes a pre-shared key used to setup MACsec in static connectivity - association key (CAK) mode. - type: object - properties: - name: - description: User provided name for this pre-shared key. - type: string - ckn: + type: string + fingerprint: description: >- - An auto-generated Connectivity Association Key Name (CKN) for this - key. - type: string - cak: - description: An auto-generated Connectivity Association Key (CAK) for this key. - type: string - startTime: - description: User provided timestamp on or after which this key is valid. + 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. type: string - InterconnectLocationList: - id: InterconnectLocationList - description: >- - Response to the list request, and contains a list of interconnect - locations. + format: byte + HealthCheckList: + id: HealthCheckList + description: Contains a list of HealthCheck resources. type: object properties: kind: - description: >- - [Output Only] Type of resource. Always - compute#interconnectLocationList for lists of interconnect - locations. - default: compute#interconnectLocationList + description: Type of resource. + default: compute#healthCheckList type: string id: description: >- @@ -29852,10 +29883,10 @@ components: server. type: string items: - description: A list of InterconnectLocation resources. + description: A list of HealthCheck resources. type: array items: - $ref: '#/components/schemas/InterconnectLocation' + $ref: '#/components/schemas/HealthCheck' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -29931,6 +29962,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -29974,6 +30008,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -29996,6 +30031,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -30032,26 +30068,27 @@ components: [Output Only] A warning data value corresponding to the key. type: string - InterconnectLocation: - id: InterconnectLocation + HealthCheck: + id: HealthCheck 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. + Represents a health check resource. Google Compute Engine has two health + check resources: * + [Regional](/compute/docs/reference/rest/v1/regionHealthChecks) * + [Global](/compute/docs/reference/rest/v1/healthChecks) These health + check resources can be used for load balancing and for autohealing VMs + in a managed instance group (MIG). **Load balancing** Health check + requirements vary depending on the type of load balancer. For details + about the type of health check supported for each load balancer and + corresponding backend type, see Health checks overview: Load balancer + guide. **Autohealing in MIGs** The health checks that you use for + autohealing VMs in a MIG can be either regional or global. For more + information, see Set up an application health check and autohealing. For + more information, see Health checks overview. type: object properties: kind: - description: >- - [Output Only] Type of the resource. Always - compute#interconnectLocation for interconnect locations. - default: compute#interconnectLocation - type: string - description: - description: '[Output Only] An optional description of the resource.' - type: string - selfLink: - description: '[Output Only] Server-defined URL for the resource.' + description: Type of the resource. + default: compute#healthCheck type: string id: description: >- @@ -30060,44 +30097,55 @@ components: type: string format: uint64 creationTimestamp: - description: '[Output Only] Creation timestamp in RFC3339 text format.' + description: '[Output Only] Creation timestamp in 3339 text format.' 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). + 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 - address: + description: description: >- - [Output Only] The postal address of the Point of Presence, each line - in the address is separated by a newline character. + An optional description of this resource. Provide this property when + you create the resource. type: string - facilityProvider: + checkIntervalSec: description: >- - [Output Only] The name of the provider for this facility (e.g., - EQUINIX). - type: string - facilityProviderFacilityId: + How often (in seconds) to send a health check. The default value is + 5 seconds. + type: integer + format: int32 + timeoutSec: description: >- - [Output Only] A provider-assigned Identifier for this facility - (e.g., Ashburn-DC1). - type: string - regionInfos: + 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. + type: integer + format: int32 + unhealthyThreshold: description: >- - [Output Only] A list of InterconnectLocation.RegionInfo objects, - that describe parameters pertaining to the relation between this - InterconnectLocation and various Google Cloud regions. - type: array - items: - $ref: '#/components/schemas/InterconnectLocationRegionInfo' - continent: + A so-far healthy instance will be marked unhealthy after this many + consecutive failures. The default value is 2. + type: integer + format: int32 + healthyThreshold: description: >- - [Output Only] Continent for this location, which can take one of the - following values: - AFRICA - ASIA_PAC - EUROPE - NORTH_AMERICA - - SOUTH_AMERICA + A so-far unhealthy instance will be marked healthy after this many + consecutive successes. The default value is 2. + type: integer + format: int32 + type: + description: >- + Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, + HTTP2 or GRPC. Exactly one of the protocol-specific health check + fields must be specified, which must match type field. type: string enumDescriptions: - '' @@ -30107,131 +30155,551 @@ components: - '' - '' - '' - - '' - - '' - - '' enum: - - AFRICA - - ASIA_PAC - - C_AFRICA - - C_ASIA_PAC - - C_EUROPE - - C_NORTH_AMERICA - - C_SOUTH_AMERICA - - EUROPE - - NORTH_AMERICA - - SOUTH_AMERICA - city: + - GRPC + - HTTP + - HTTP2 + - HTTPS + - INVALID + - SSL + - TCP + tcpHealthCheck: + $ref: '#/components/schemas/TCPHealthCheck' + sslHealthCheck: + $ref: '#/components/schemas/SSLHealthCheck' + httpHealthCheck: + $ref: '#/components/schemas/HTTPHealthCheck' + httpsHealthCheck: + $ref: '#/components/schemas/HTTPSHealthCheck' + http2HealthCheck: + $ref: '#/components/schemas/HTTP2HealthCheck' + grpcHealthCheck: + $ref: '#/components/schemas/GRPCHealthCheck' + sourceRegions: description: >- - [Output Only] Metropolitan area designator that indicates which city - an interconnect is located. For example: "Chicago, IL", "Amsterdam, - Netherlands". + The list of cloud regions from which health checks are performed. If + any regions are specified, then exactly 3 regions should be + specified. The region names must be valid names of Google Cloud + regions. This can only be set for global health check. If this list + is non-empty, then there are restrictions on what other health check + fields are supported and what other resources can use this health + check: - SSL, HTTP2, and GRPC protocols are not supported. - The TCP + request field is not supported. - The proxyHeader field for HTTP, + HTTPS, and TCP is not supported. - The checkIntervalSec field must + be at least 30. - The health check cannot be used with + BackendService nor with managed instance group auto-healing. + type: array + items: + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' type: string - availabilityZone: + region: 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". + [Output Only] Region where the health check resides. Not applicable + to global health checks. type: string - status: + logConfig: + description: Configure logging on this health check. + $ref: '#/components/schemas/HealthCheckLogConfig' + TCPHealthCheck: + id: TCPHealthCheck + type: object + properties: + port: 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. + The TCP port number to which the health check prober sends packets. + The default value is 80. Valid values are 1 through 65535. + type: integer + format: int32 + portName: + description: Not supported. + type: string + portSpecification: + description: >- + Specifies how a port is selected for health checking. Can be one of + the following values: USE_FIXED_PORT: Specifies a port number + explicitly using the port field in the health check. Supported by + backend services for passthrough load balancers and backend services + for proxy load balancers. Not supported by target pools. The health + check supports all backends supported by the backend service + provided the backend can be health checked. For example, GCE_VM_IP + network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and + instance group backends. USE_NAMED_PORT: Not supported. + USE_SERVING_PORT: Provides an indirect method of specifying the + health check port by referring to the backend service. Only + supported by backend services for proxy load balancers. Not + supported by target pools. Not supported by backend services for + passthrough load balancers. Supports all backends that can be health + checked; for example, GCE_VM_IP_PORT network endpoint groups and + instance group backends. For GCE_VM_IP_PORT network endpoint group + backends, the health check uses the port number specified for each + endpoint in the network endpoint group. For instance group backends, + the health check uses the port number determined by looking up the + backend service's named port in the instance group's list of named + ports. type: string enumDescriptions: - >- - The InterconnectLocation is available for provisioning new - Interconnects. + The port number in the health check's port is used for health + checking. Applies to network endpoint group and instance group + backends. + - Not supported. - >- - The InterconnectLocation is closed for provisioning new - Interconnects. + For network endpoint group backends, the health check uses the + port number specified on each endpoint in the network endpoint + group. For instance group backends, the health check uses the port + number specified for the backend service's named port defined in + the instance group's named ports. enum: - - AVAILABLE - - CLOSED - supportsPzs: - description: '[Output Only] Reserved for future use.' - type: boolean - availableFeatures: - description: >- - [Output only] List of features available at this - InterconnectLocation, which can take one of the following values: - - MACSEC - type: array - items: - type: string - enumDescriptions: - - Media Access Control security (MACsec) - enum: - - IF_MACSEC - availableLinkTypes: + - USE_FIXED_PORT + - USE_NAMED_PORT + - USE_SERVING_PORT + request: description: >- - [Output only] List of link types available at this - InterconnectLocation, which can take one of the following values: - - LINK_TYPE_ETHERNET_10G_LR - LINK_TYPE_ETHERNET_100G_LR - type: array - items: - type: string - enumDescriptions: - - 100G Ethernet, LR Optics. - - 10G Ethernet, LR Optics. [(rate_bps) = 10000000000]; - enum: - - LINK_TYPE_ETHERNET_100G_LR - - LINK_TYPE_ETHERNET_10G_LR - InterconnectLocationRegionInfo: - id: InterconnectLocationRegionInfo - description: >- - Information about any potential InterconnectAttachments between an - Interconnect at a specific InterconnectLocation, and a specific Cloud - Region. - type: object - properties: - region: - description: URL for the region of this location. + Instructs the health check prober to send this exact ASCII string, + up to 1024 bytes in length, after establishing the TCP connection. type: string - expectedRttMs: + response: description: >- - Expected round-trip time in milliseconds, from this - InterconnectLocation to a VM in this region. + Creates a content-based TCP health check. In addition to + establishing a TCP connection, you can configure the health check to + pass only when the backend sends this exact response ASCII string, + up to 1024 bytes in length. For details, see: + https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-ssl-tcp type: string - format: int64 - locationPresence: - description: Identifies the network presence of this location. + 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. type: string enumDescriptions: - - >- - This region is not in any common network presence with this - InterconnectLocation. - - >- - This region shares the same regional network presence as this - InterconnectLocation. - - >- - [Deprecated] This region is not in any common network presence - with this InterconnectLocation. - - >- - [Deprecated] This region shares the same regional network presence - as this InterconnectLocation. + - '' + - '' enum: - - GLOBAL - - LOCAL_REGION - - LP_GLOBAL - - LP_LOCAL_REGION - InterconnectRemoteLocationList: - id: InterconnectRemoteLocationList - description: >- - Response to the list request, and contains a list of interconnect remote - locations. + - NONE + - PROXY_V1 + SSLHealthCheck: + id: SSLHealthCheck type: object properties: - kind: + port: description: >- - [Output Only] Type of resource. Always - compute#interconnectRemoteLocationList for lists of interconnect - remote locations. - default: compute#interconnectRemoteLocationList + The TCP port number to which the health check prober sends packets. + The default value is 443. Valid values are 1 through 65535. + type: integer + format: int32 + portName: + description: Not supported. + type: string + portSpecification: + description: >- + Specifies how a port is selected for health checking. Can be one of + the following values: USE_FIXED_PORT: Specifies a port number + explicitly using the port field in the health check. Supported by + backend services for passthrough load balancers and backend services + for proxy load balancers. Not supported by target pools. The health + check supports all backends supported by the backend service + provided the backend can be health checked. For example, GCE_VM_IP + network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and + instance group backends. USE_NAMED_PORT: Not supported. + USE_SERVING_PORT: Provides an indirect method of specifying the + health check port by referring to the backend service. Only + supported by backend services for proxy load balancers. Not + supported by target pools. Not supported by backend services for + passthrough load balancers. Supports all backends that can be health + checked; for example, GCE_VM_IP_PORT network endpoint groups and + instance group backends. For GCE_VM_IP_PORT network endpoint group + backends, the health check uses the port number specified for each + endpoint in the network endpoint group. For instance group backends, + the health check uses the port number determined by looking up the + backend service's named port in the instance group's list of named + ports. + type: string + enumDescriptions: + - >- + The port number in the health check's port is used for health + checking. Applies to network endpoint group and instance group + backends. + - Not supported. + - >- + For network endpoint group backends, the health check uses the + port number specified on each endpoint in the network endpoint + group. For instance group backends, the health check uses the port + number specified for the backend service's named port defined in + the instance group's named ports. + enum: + - USE_FIXED_PORT + - USE_NAMED_PORT + - USE_SERVING_PORT + request: + description: >- + Instructs the health check prober to send this exact ASCII string, + up to 1024 bytes in length, after establishing the TCP connection + and SSL handshake. + type: string + response: + description: >- + Creates a content-based SSL health check. In addition to + establishing a TCP connection and the TLS handshake, you can + configure the health check to pass only when the backend sends this + exact response ASCII string, up to 1024 bytes in length. For + details, see: + https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-ssl-tcp + 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. + type: string + enumDescriptions: + - '' + - '' + enum: + - NONE + - PROXY_V1 + HTTPHealthCheck: + id: HTTPHealthCheck + type: object + properties: + port: + description: >- + The TCP port number to which the health check prober sends packets. + The default value is 80. Valid values are 1 through 65535. + type: integer + format: int32 + portName: + description: Not supported. + type: string + portSpecification: + description: >- + Specifies how a port is selected for health checking. Can be one of + the following values: USE_FIXED_PORT: Specifies a port number + explicitly using the port field in the health check. Supported by + backend services for passthrough load balancers and backend services + for proxy load balancers. Also supported in legacy HTTP health + checks for target pools. The health check supports all backends + supported by the backend service provided the backend can be health + checked. For example, GCE_VM_IP network endpoint groups, + GCE_VM_IP_PORT network endpoint groups, and instance group backends. + USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an + indirect method of specifying the health check port by referring to + the backend service. Only supported by backend services for proxy + load balancers. Not supported by target pools. Not supported by + backend services for pass-through load balancers. Supports all + backends that can be health checked; for example, GCE_VM_IP_PORT + network endpoint groups and instance group backends. For + GCE_VM_IP_PORT network endpoint group backends, the health check + uses the port number specified for each endpoint in the network + endpoint group. For instance group backends, the health check uses + the port number determined by looking up the backend service's named + port in the instance group's list of named ports. + type: string + enumDescriptions: + - >- + The port number in the health check's port is used for health + checking. Applies to network endpoint group and instance group + backends. + - Not supported. + - >- + For network endpoint group backends, the health check uses the + port number specified on each endpoint in the network endpoint + group. For instance group backends, the health check uses the port + number specified for the backend service's named port defined in + the instance group's named ports. + enum: + - USE_FIXED_PORT + - USE_NAMED_PORT + - USE_SERVING_PORT + host: + description: >- + The value of the host header in the HTTP health check request. If + left empty (default value), the host header is set to the + destination IP address to which health check packets are sent. The + destination IP address depends on the type of load balancer. For + details, see: + https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest + type: string + requestPath: + description: >- + The request path of the HTTP health check request. The default value + is /. Must comply with RFC3986. + 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. + type: string + enumDescriptions: + - '' + - '' + enum: + - NONE + - PROXY_V1 + response: + description: >- + Creates a content-based HTTP health check. In addition to the + required HTTP 200 (OK) status code, you can configure the health + check to pass only when the backend sends this specific ASCII + response string within the first 1024 bytes of the HTTP response + body. For details, see: + https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http + type: string + HTTPSHealthCheck: + id: HTTPSHealthCheck + type: object + properties: + port: + description: >- + The TCP port number to which the health check prober sends packets. + The default value is 443. Valid values are 1 through 65535. + type: integer + format: int32 + portName: + description: Not supported. + type: string + portSpecification: + description: >- + Specifies how a port is selected for health checking. Can be one of + the following values: USE_FIXED_PORT: Specifies a port number + explicitly using the port field in the health check. Supported by + backend services for passthrough load balancers and backend services + for proxy load balancers. Not supported by target pools. The health + check supports all backends supported by the backend service + provided the backend can be health checked. For example, GCE_VM_IP + network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and + instance group backends. USE_NAMED_PORT: Not supported. + USE_SERVING_PORT: Provides an indirect method of specifying the + health check port by referring to the backend service. Only + supported by backend services for proxy load balancers. Not + supported by target pools. Not supported by backend services for + passthrough load balancers. Supports all backends that can be health + checked; for example, GCE_VM_IP_PORT network endpoint groups and + instance group backends. For GCE_VM_IP_PORT network endpoint group + backends, the health check uses the port number specified for each + endpoint in the network endpoint group. For instance group backends, + the health check uses the port number determined by looking up the + backend service's named port in the instance group's list of named + ports. + type: string + enumDescriptions: + - >- + The port number in the health check's port is used for health + checking. Applies to network endpoint group and instance group + backends. + - Not supported. + - >- + For network endpoint group backends, the health check uses the + port number specified on each endpoint in the network endpoint + group. For instance group backends, the health check uses the port + number specified for the backend service's named port defined in + the instance group's named ports. + enum: + - USE_FIXED_PORT + - USE_NAMED_PORT + - USE_SERVING_PORT + host: + description: >- + The value of the host header in the HTTPS health check request. If + left empty (default value), the host header is set to the + destination IP address to which health check packets are sent. The + destination IP address depends on the type of load balancer. For + details, see: + https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest + type: string + requestPath: + description: >- + The request path of the HTTPS health check request. The default + value is /. Must comply with RFC3986. + 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. + type: string + enumDescriptions: + - '' + - '' + enum: + - NONE + - PROXY_V1 + response: + description: >- + Creates a content-based HTTPS health check. In addition to the + required HTTP 200 (OK) status code, you can configure the health + check to pass only when the backend sends this specific ASCII + response string within the first 1024 bytes of the HTTP response + body. For details, see: + https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http + type: string + HTTP2HealthCheck: + id: HTTP2HealthCheck + type: object + properties: + port: + description: >- + The TCP port number to which the health check prober sends packets. + The default value is 443. Valid values are 1 through 65535. + type: integer + format: int32 + portName: + description: Not supported. + type: string + portSpecification: + description: >- + Specifies how a port is selected for health checking. Can be one of + the following values: USE_FIXED_PORT: Specifies a port number + explicitly using the port field in the health check. Supported by + backend services for passthrough load balancers and backend services + for proxy load balancers. Not supported by target pools. The health + check supports all backends supported by the backend service + provided the backend can be health checked. For example, GCE_VM_IP + network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and + instance group backends. USE_NAMED_PORT: Not supported. + USE_SERVING_PORT: Provides an indirect method of specifying the + health check port by referring to the backend service. Only + supported by backend services for proxy load balancers. Not + supported by target pools. Not supported by backend services for + passthrough load balancers. Supports all backends that can be health + checked; for example, GCE_VM_IP_PORT network endpoint groups and + instance group backends. For GCE_VM_IP_PORT network endpoint group + backends, the health check uses the port number specified for each + endpoint in the network endpoint group. For instance group backends, + the health check uses the port number determined by looking up the + backend service's named port in the instance group's list of named + ports. + type: string + enumDescriptions: + - >- + The port number in the health check's port is used for health + checking. Applies to network endpoint group and instance group + backends. + - Not supported. + - >- + For network endpoint group backends, the health check uses the + port number specified on each endpoint in the network endpoint + group. For instance group backends, the health check uses the port + number specified for the backend service's named port defined in + the instance group's named ports. + enum: + - USE_FIXED_PORT + - USE_NAMED_PORT + - USE_SERVING_PORT + host: + description: >- + The value of the host header in the HTTP/2 health check request. If + left empty (default value), the host header is set to the + destination IP address to which health check packets are sent. The + destination IP address depends on the type of load balancer. For + details, see: + https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest + type: string + requestPath: + description: >- + The request path of the HTTP/2 health check request. The default + value is /. Must comply with RFC3986. + 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. + type: string + enumDescriptions: + - '' + - '' + enum: + - NONE + - PROXY_V1 + response: + description: >- + Creates a content-based HTTP/2 health check. In addition to the + required HTTP 200 (OK) status code, you can configure the health + check to pass only when the backend sends this specific ASCII + response string within the first 1024 bytes of the HTTP response + body. For details, see: + https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http + type: string + GRPCHealthCheck: + id: GRPCHealthCheck + type: object + properties: + port: + description: >- + The TCP port number to which the health check prober sends packets. + Valid values are 1 through 65535. + type: integer + format: int32 + portName: + description: Not supported. + type: string + portSpecification: + description: >- + Specifies how a port is selected for health checking. Can be one of + the following values: USE_FIXED_PORT: Specifies a port number + explicitly using the port field in the health check. Supported by + backend services for passthrough load balancers and backend services + for proxy load balancers. Not supported by target pools. The health + check supports all backends supported by the backend service + provided the backend can be health checked. For example, GCE_VM_IP + network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and + instance group backends. USE_NAMED_PORT: Not supported. + USE_SERVING_PORT: Provides an indirect method of specifying the + health check port by referring to the backend service. Only + supported by backend services for proxy load balancers. Not + supported by target pools. Not supported by backend services for + passthrough load balancers. Supports all backends that can be health + checked; for example, GCE_VM_IP_PORT network endpoint groups and + instance group backends. For GCE_VM_IP_PORT network endpoint group + backends, the health check uses the port number specified for each + endpoint in the network endpoint group. For instance group backends, + the health check uses the port number determined by looking up the + backend service's named port in the instance group's list of named + ports. + type: string + enumDescriptions: + - >- + The port number in the health check's port is used for health + checking. Applies to network endpoint group and instance group + backends. + - Not supported. + - >- + For network endpoint group backends, the health check uses the + port number specified on each endpoint in the network endpoint + group. For instance group backends, the health check uses the port + number specified for the backend service's named port defined in + the instance group's named ports. + enum: + - USE_FIXED_PORT + - USE_NAMED_PORT + - USE_SERVING_PORT + 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 + HealthCheckLogConfig: + id: HealthCheckLogConfig + description: >- + Configuration of logging on a health check. If logging is enabled, logs + will be exported to Stackdriver. + type: object + 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 + HealthChecksAggregatedList: + id: HealthChecksAggregatedList + type: object + properties: + kind: + description: Type of resource. + default: compute#healthChecksAggregatedList type: string id: description: >- @@ -30239,17 +30707,18 @@ components: server. type: string items: - description: A list of InterconnectRemoteLocation resources. - type: array - items: - $ref: '#/components/schemas/InterconnectRemoteLocation' + description: A list of HealthChecksScopedList resources. + type: object + additionalProperties: + description: Name of the scope containing this set of HealthChecks. + $ref: '#/components/schemas/HealthChecksScopedList' nextPageToken: description: >- - [Output Only] This token lets you get the next page of results for - list requests. If the number of results is larger than maxResults, - use the nextPageToken as a value for the query parameter pageToken - in the next list request. Subsequent list requests will have their - own nextPageToken to continue paging through the results. + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. type: string selfLink: description: '[Output Only] Server-defined URL for this resource.' @@ -30318,6 +30787,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -30361,6 +30833,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -30383,6 +30856,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -30419,417 +30893,24 @@ components: [Output Only] A warning data value corresponding to the key. type: string - InterconnectRemoteLocation: - id: InterconnectRemoteLocation - description: >- - Represents a Cross-Cloud Interconnect Remote Location resource. You can - use this resource to find remote location details about an Interconnect - attachment (VLAN). + unreachables: + description: '[Output Only] Unreachable resources.' + type: array + items: + type: string + HealthChecksScopedList: + id: HealthChecksScopedList type: object properties: - kind: - description: >- - [Output Only] Type of the resource. Always - compute#interconnectRemoteLocation for interconnect remote - locations. - default: compute#interconnectRemoteLocation - type: string - description: - description: '[Output Only] An optional description of the resource.' - type: string - selfLink: - description: '[Output Only] Server-defined URL for the resource.' - type: string - id: - description: >- - [Output Only] The unique identifier for the resource. This - identifier is defined by the server. - type: string - format: uint64 - creationTimestamp: - description: '[Output Only] Creation timestamp in RFC3339 text format.' - 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 - 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 - 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 - continent: + healthChecks: + description: A list of HealthChecks contained in this scope. + type: array + items: + $ref: '#/components/schemas/HealthCheck' + warning: description: >- - [Output Only] Continent for this location, which can take one of the - following values: - AFRICA - ASIA_PAC - EUROPE - NORTH_AMERICA - - SOUTH_AMERICA - type: string - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - enum: - - AFRICA - - ASIA_PAC - - EUROPE - - NORTH_AMERICA - - SOUTH_AMERICA - city: - description: >- - [Output Only] Metropolitan area designator that indicates which city - an interconnect is located. For example: "Chicago, IL", "Amsterdam, - Netherlands". - type: string - status: - description: >- - [Output Only] The status of this InterconnectRemoteLocation, which - can take one of the following values: - CLOSED: The - InterconnectRemoteLocation is closed and is unavailable for - provisioning new Cross-Cloud Interconnects. - AVAILABLE: The - InterconnectRemoteLocation is available for provisioning new - Cross-Cloud Interconnects. - type: string - enumDescriptions: - - >- - The InterconnectRemoteLocation is available for provisioning new - Cross-Cloud Interconnects. - - >- - The InterconnectRemoteLocation is closed for provisioning new - Cross-Cloud Interconnects. - enum: - - AVAILABLE - - CLOSED - remoteService: - description: >- - [Output Only] Indicates the service provider present at the remote - location. Example values: "Amazon Web Services", "Microsoft Azure". - type: string - permittedConnections: - description: '[Output Only] Permitted connections.' - type: array - items: - $ref: >- - #/components/schemas/InterconnectRemoteLocationPermittedConnections - constraints: - description: >- - [Output Only] Constraints on the parameters for creating Cross-Cloud - Interconnect and associated InterconnectAttachments. - $ref: '#/components/schemas/InterconnectRemoteLocationConstraints' - attachmentConfigurationConstraints: - description: >- - [Output Only] Subset of fields from InterconnectAttachment's - |configurationConstraints| field that apply to all attachments for - this remote location. - $ref: '#/components/schemas/InterconnectAttachmentConfigurationConstraints' - lacp: - description: >- - [Output Only] Link Aggregation Control Protocol (LACP) constraints, - which can take one of the following values: LACP_SUPPORTED, - LACP_UNSUPPORTED - type: string - enumDescriptions: - - >- - LACP_SUPPORTED: LACP is supported, and enabled by default on the - Cross-Cloud Interconnect. - - >- - LACP_UNSUPPORTED: LACP is not supported and is not be enabled on - this port. GetDiagnostics shows bundleAggregationType as "static". - GCP does not support LAGs without LACP, so requestedLinkCount must - be 1. - enum: - - LACP_SUPPORTED - - LACP_UNSUPPORTED - maxLagSize100Gbps: - description: >- - [Output Only] The maximum number of 100 Gbps ports supported in a - link aggregation group (LAG). When linkType is 100 Gbps, - requestedLinkCount cannot exceed max_lag_size_100_gbps. - type: integer - format: int32 - maxLagSize10Gbps: - description: >- - [Output Only] The maximum number of 10 Gbps ports supported in a - link aggregation group (LAG). When linkType is 10 Gbps, - requestedLinkCount cannot exceed max_lag_size_10_gbps. - type: integer - format: int32 - InterconnectRemoteLocationPermittedConnections: - id: InterconnectRemoteLocationPermittedConnections - type: object - properties: - interconnectLocation: - description: >- - [Output Only] URL of an Interconnect location that is permitted to - connect to this Interconnect remote location. - type: string - InterconnectRemoteLocationConstraints: - id: InterconnectRemoteLocationConstraints - type: object - properties: - subnetLengthRange: - description: >- - [Output Only] [min-length, max-length] The minimum and maximum value - (inclusive) for the IPv4 subnet length. For example, an - interconnectRemoteLocation for Azure has {min: 30, max: 30} because - Azure requires /30 subnets. This range specifies the values - supported by both cloud providers. Interconnect currently supports - /29 and /30 IPv4 subnet lengths. If a remote cloud has no constraint - on IPv4 subnet length, the range would thus be {min: 29, max: 30}. - $ref: >- - #/components/schemas/InterconnectRemoteLocationConstraintsSubnetLengthRange - portPairVlan: - description: >- - [Output Only] Port pair VLAN constraints, which can take one of the - following values: PORT_PAIR_UNCONSTRAINED_VLAN, - PORT_PAIR_MATCHING_VLAN - type: string - enumDescriptions: - - >- - If PORT_PAIR_MATCHING_VLAN, the Interconnect for this attachment - is part of a pair of ports that should have matching VLAN - allocations. This occurs with Cross-Cloud Interconnect to Azure - remote locations. While GCP's API does not explicitly group pairs - of ports, the UI uses this field to ensure matching VLAN ids when - configuring a redundant VLAN pair. - - PORT_PAIR_UNCONSTRAINED_VLAN means there is no constraint. - enum: - - PORT_PAIR_MATCHING_VLAN - - PORT_PAIR_UNCONSTRAINED_VLAN - portPairRemoteLocation: - description: >- - [Output Only] Port pair remote location constraints, which can take - one of the following values: - PORT_PAIR_UNCONSTRAINED_REMOTE_LOCATION, - PORT_PAIR_MATCHING_REMOTE_LOCATION. Google Cloud API refers only to - individual ports, but the UI uses this field when ordering a pair of - ports, to prevent users from accidentally ordering something that is - incompatible with their cloud provider. Specifically, when ordering - a redundant pair of Cross-Cloud Interconnect ports, and one of them - uses a remote location with portPairMatchingRemoteLocation set to - matching, the UI requires that both ports use the same remote - location. - type: string - enumDescriptions: - - >- - If PORT_PAIR_MATCHING_REMOTE_LOCATION, the remote cloud provider - allocates ports in pairs, and the user should choose the same - remote location for both ports. - - >- - If PORT_PAIR_UNCONSTRAINED_REMOTE_LOCATION, a user may opt to - provision a redundant pair of Cross-Cloud Interconnects using two - different remote locations in the same city. - enum: - - PORT_PAIR_MATCHING_REMOTE_LOCATION - - PORT_PAIR_UNCONSTRAINED_REMOTE_LOCATION - InterconnectRemoteLocationConstraintsSubnetLengthRange: - id: InterconnectRemoteLocationConstraintsSubnetLengthRange - type: object - properties: - min: - type: integer - format: int32 - max: - type: integer - format: int32 - LicenseCode: - id: 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. - type: object - properties: - kind: - description: >- - [Output Only] Type of resource. Always compute#licenseCode for - licenses. - default: compute#licenseCode - type: string - id: - description: >- - [Output Only] The unique identifier for the resource. This - identifier is defined by the server. - type: string - format: uint64 - 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}?' - annotations: - required: - - compute.licenses.insert - type: string - creationTimestamp: - description: '[Output Only] Creation timestamp in RFC3339 text format.' - type: string - description: - description: '[Output Only] Description of this License Code.' - type: string - selfLink: - description: '[Output Only] Server-defined URL for the resource.' - 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 - state: - description: '[Output Only] Current state of this License Code.' - type: string - enumDescriptions: - - >- - Machines are not allowed to attach boot disks with this License - Code. Requests to create new resources with this license will be - rejected. - - >- - Use is allowed for anyone with USE_READ_ONLY access to this - License Code. - - Use of this license is limited to a project whitelist. - - '' - - Reserved state. - enum: - - DISABLED - - ENABLED - - RESTRICTED - - STATE_UNSPECIFIED - - TERMINATED - licenseAlias: - description: >- - [Output Only] URL and description aliases of Licenses with the same - License Code. - type: array - items: - $ref: '#/components/schemas/LicenseCodeLicenseAlias' - LicenseCodeLicenseAlias: - id: LicenseCodeLicenseAlias - type: object - properties: - selfLink: - description: '[Output Only] URL of license corresponding to this License Code.' - type: string - description: - description: '[Output Only] Description of this License Code.' - type: string - License: - id: 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. - type: object - properties: - kind: - description: '[Output Only] Type of resource. Always compute#license for licenses.' - default: compute#license - 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])?' - annotations: - required: - - compute.images.insert - type: string - chargesUseFee: - description: >- - [Output Only] Deprecated. This field no longer reflects whether a - license charges a usage fee. - type: boolean - id: - description: >- - [Output Only] The unique identifier for the resource. This - identifier is defined by the server. - type: string - format: uint64 - licenseCode: - description: >- - [Output Only] The unique code used to attach this license to images, - snapshots, and disks. - type: string - format: uint64 - 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 - 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 - selfLink: - description: '[Output Only] Server-defined URL for the resource.' - type: string - resourceRequirements: - $ref: '#/components/schemas/LicenseResourceRequirements' - LicenseResourceRequirements: - id: LicenseResourceRequirements - type: object - properties: - minGuestCpuCount: - description: >- - Minimum number of guest cpus required to use the Instance. Enforced - at Instance creation and Instance start. - type: integer - format: int32 - minMemoryMb: - description: >- - Minimum memory required to use the Instance. Enforced at Instance - creation and Instance start. - type: integer - format: int32 - LicensesListResponse: - id: LicensesListResponse - type: object - properties: - id: - description: >- - [Output Only] Unique identifier for the resource; defined by the - server. - type: string - items: - description: A list of License resources. - type: array - items: - $ref: '#/components/schemas/License' - nextPageToken: - description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. - type: string - selfLink: - description: '[Output Only] Server-defined URL for this resource.' - type: string - warning: - description: '[Output Only] Informational warning message.' + Informational warning which replaces the list of backend services + when the list is empty. type: object properties: code: @@ -30892,6 +30973,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -30935,6 +31019,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -30957,6 +31042,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -30993,16 +31079,14 @@ components: [Output Only] A warning data value corresponding to the key. type: string - MachineImageList: - id: MachineImageList - description: A list of machine images. + HttpHealthCheckList: + id: HttpHealthCheckList + description: Contains a list of HttpHealthCheck resources. type: object properties: kind: - description: >- - [Output Only] The resource type, which is always - compute#machineImagesListResponse for machine image lists. - default: compute#machineImageList + description: Type of resource. + default: compute#httpHealthCheckList type: string id: description: >- @@ -31010,10 +31094,10 @@ components: server. type: string items: - description: A list of MachineImage resources. + description: A list of HttpHealthCheck resources. type: array items: - $ref: '#/components/schemas/MachineImage' + $ref: '#/components/schemas/HttpHealthCheck' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -31089,6 +31173,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -31132,6 +31219,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -31154,6 +31242,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -31190,35 +31279,35 @@ components: [Output Only] A warning data value corresponding to the key. type: string - MachineImage: - id: MachineImage + HttpHealthCheck: + id: HttpHealthCheck description: >- - Represents a machine image resource. A machine image is a Compute Engine - resource that stores all the configuration, metadata, permissions, and - data from one or more disks required to create a Virtual machine (VM) - instance. For more information, see Machine images. + 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 . type: object properties: kind: description: >- - [Output Only] The resource type, which is always - compute#machineImage for machine image. - default: compute#machineImage + [Output Only] Type of the resource. Always compute#httpHealthCheck + for HTTP health checks. + default: compute#httpHealthCheck type: string id: description: >- - [Output Only] A unique identifier for this machine image. The server - defines this identifier. + [Output Only] The unique identifier for the resource. This + identifier is defined by the server. type: string format: uint64 creationTimestamp: - description: >- - [Output Only] The creation timestamp for this machine image in - RFC3339 text format. + description: '[Output Only] Creation timestamp in RFC3339 text format.' type: string name: description: >- - Name of the resource; provided by the client when the resource is + 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 @@ -31226,417 +31315,78 @@ components: 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])?' - annotations: - required: - - compute.machineImages.insert type: string description: description: >- An optional description of this resource. Provide this property when you create the resource. type: string - selfLink: + host: description: >- - [Output Only] The URL for this machine image. The server defines - this URL. + 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 - sourceInstance: + requestPath: description: >- - The source instance used to create the machine image. 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 + The request path of the HTTP health check request. The default value + is /. This field does not support query parameters. Must comply with + RFC3986. type: string - status: + port: description: >- - [Output Only] The status of the machine image. One of the following - values: INVALID, CREATING, READY, DELETING, and UPLOADING. - type: string - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - enum: - - CREATING - - DELETING - - INVALID - - READY - - UPLOADING - sourceInstanceProperties: + The TCP port number for the HTTP health check request. The default + value is 80. + type: integer + format: int32 + checkIntervalSec: description: >- - [Output Only] DEPRECATED: Please use instance_properties instead for - source instance related properties. New properties will not be added - to this field. - $ref: '#/components/schemas/SourceInstanceProperties' - instanceProperties: - description: '[Output Only] Properties of source instance' - $ref: '#/components/schemas/InstanceProperties' - savedDisks: + How often (in seconds) to send a health check. The default value is + 5 seconds. + type: integer + format: int32 + timeoutSec: description: >- - An array of Machine Image specific properties for disks attached to - the source instance - type: array - items: - $ref: '#/components/schemas/SavedDisk' - storageLocations: + 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. + type: integer + format: int32 + unhealthyThreshold: description: >- - The regional or multi-regional Cloud Storage bucket location where - the machine image is stored. + A so-far healthy instance will be marked unhealthy after this many + consecutive failures. The default value is 2. + type: integer + format: int32 + healthyThreshold: + description: >- + A so-far unhealthy instance will be marked healthy after this many + consecutive successes. The default value is 2. + type: integer + format: int32 + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + HttpsHealthCheckList: + id: HttpsHealthCheckList + description: Contains a list of HttpsHealthCheck resources. + type: object + properties: + kind: + description: Type of resource. + default: compute#httpsHealthCheckList + type: string + id: + description: >- + [Output Only] Unique identifier for the resource; defined by the + server. + type: string + items: + description: A list of HttpsHealthCheck resources. type: array items: - type: string - machineImageEncryptionKey: - description: >- - Encrypts the machine image using a customer-supplied encryption key. - After you encrypt a machine image using a customer-supplied key, you - must provide the same key if you use the machine image later. For - example, you must provide the encryption key when you create an - instance from the encrypted machine image in a future request. - Customer-supplied encryption keys do not protect access to metadata - of the machine image. If you do not provide an encryption key when - creating the machine image, then the machine image will be encrypted - using an automatically generated key and you do not need to provide - a key to use the machine image later. - $ref: '#/components/schemas/CustomerEncryptionKey' - guestFlush: - description: >- - [Input Only] Whether to attempt an application consistent machine - image by informing the OS to prepare for the snapshot process. - type: boolean - sourceDiskEncryptionKeys: - description: >- - [Input Only] The customer-supplied encryption key of the disks - attached to the source instance. Required if the source disk is - protected by a customer-supplied encryption key. - type: array - items: - $ref: '#/components/schemas/SourceDiskEncryptionKey' - totalStorageBytes: - description: '[Output Only] Total size of the storage used by the machine image.' - type: string - format: int64 - satisfiesPzs: - description: '[Output Only] Reserved for future use.' - type: boolean - satisfiesPzi: - description: Output only. Reserved for future use. - readOnly: true - type: boolean - SourceInstanceProperties: - id: SourceInstanceProperties - description: >- - DEPRECATED: Please use compute#instanceProperties instead. New - properties will not be added to this field. - type: object - properties: - description: - description: >- - An optional text description for the instances that are created from - this machine image. - type: string - tags: - description: >- - A list of tags to apply to the instances that are created from this - machine image. 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. - $ref: '#/components/schemas/Tags' - machineType: - description: >- - The machine type to use for instances that are created from this - machine image. - type: string - canIpForward: - description: >- - Enables instances created based on this machine image 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 - networkInterfaces: - description: An array of network access configurations for this interface. - type: array - items: - $ref: '#/components/schemas/NetworkInterface' - disks: - description: >- - An array of disks that are associated with the instances that are - created from this machine image. - type: array - items: - $ref: '#/components/schemas/SavedAttachedDisk' - metadata: - description: >- - The metadata key/value pairs to assign to instances that are created - from this machine image. These pairs can consist of custom metadata - or predefined keys. See Project and instance metadata for more - information. - $ref: '#/components/schemas/Metadata' - 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 this machine image. Use metadata queries to obtain the - access tokens for these instances. - type: array - items: - $ref: '#/components/schemas/ServiceAccount' - scheduling: - description: >- - Specifies the scheduling options for the instances that are created - from this machine image. - $ref: '#/components/schemas/Scheduling' - labels: - description: >- - Labels to apply to instances that are created from this machine - image. - type: object - additionalProperties: - type: string - guestAccelerators: - description: >- - A list of guest accelerator cards' type and count to use for - instances created from this machine image. - type: array - items: - $ref: '#/components/schemas/AcceleratorConfig' - minCpuPlatform: - description: >- - Minimum cpu/platform to be used by instances created from this - machine image. 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 - deletionProtection: - description: >- - Whether the instance created from this machine image should be - protected against deletion. - type: boolean - keyRevocationActionType: - description: >- - KeyRevocationActionType of the instance. Supported options are - "STOP" and "NONE". The default value is "NONE" if it is not - specified. - type: string - enumDescriptions: - - Default value. This value is unused. - - Indicates user chose no operation. - - Indicates user chose to opt for VM shutdown on key revocation. - enum: - - KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED - - NONE - - STOP - SavedAttachedDisk: - id: SavedAttachedDisk - description: >- - DEPRECATED: Please use compute#savedDisk instead. An instance-attached - disk resource. - type: object - properties: - kind: - description: >- - [Output Only] Type of the resource. Always compute#attachedDisk for - attached disks. - default: compute#savedAttachedDisk - type: string - type: - description: >- - Specifies the type of the attached disk, either SCRATCH or - PERSISTENT. - type: string - enumDescriptions: - - '' - - '' - enum: - - PERSISTENT - - SCRATCH - mode: - description: >- - The mode in which this disk is attached to the source instance, - either READ_WRITE or READ_ONLY. - type: string - enumDescriptions: - - >- - Attaches this disk in read-only mode. Multiple virtual machines - can use a disk in read-only mode at a time. - - >- - *[Default]* Attaches this disk in read-write mode. Only one - virtual machine at a time can be attached to a disk in read-write - mode. - enum: - - READ_ONLY - - READ_WRITE - source: - description: Specifies a URL of the disk attached to the source instance. - type: string - deviceName: - description: Specifies the name of the disk attached to the source instance. - type: string - index: - description: >- - Specifies zero-based index of the disk that is attached to the - source instance. - type: integer - format: int32 - 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 - 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 - licenses: - description: '[Output Only] Any valid publicly visible licenses.' - type: array - items: - type: string - interface: - description: >- - Specifies the disk interface to use for attaching this disk, which - is either SCSI or NVME. - type: string - enumDescriptions: - - '' - - '' - enum: - - NVME - - SCSI - 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. - type: array - items: - $ref: '#/components/schemas/GuestOsFeature' - diskEncryptionKey: - description: The encryption key for the disk. - $ref: '#/components/schemas/CustomerEncryptionKey' - diskSizeGb: - description: The size of the disk in base-2 GB. - type: string - format: int64 - storageBytes: - description: >- - [Output Only] A size of the storage used by the disk's snapshot by - this machine image. - type: string - format: int64 - 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. - type: string - enumDescriptions: - - '' - - '' - enum: - - UPDATING - - UP_TO_DATE - diskType: - description: >- - [Output Only] URL of the disk type resource. For example: - projects/project /zones/zone/diskTypes/pd-standard or pd-ssd - type: string - SavedDisk: - id: SavedDisk - description: An instance-attached disk resource. - type: object - properties: - kind: - description: >- - [Output Only] Type of the resource. Always compute#savedDisk for - attached disks. - default: compute#savedDisk - type: string - sourceDisk: - description: Specifies a URL of the disk attached to the source instance. - type: string - storageBytes: - description: >- - [Output Only] Size of the individual disk snapshot used by this - machine image. - type: string - format: int64 - 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. - type: string - enumDescriptions: - - '' - - '' - enum: - - UPDATING - - UP_TO_DATE - architecture: - description: '[Output Only] The architecture of the attached disk.' - type: string - enumDescriptions: - - Default value indicating Architecture is not set. - - Machines with architecture ARM64 - - Machines with architecture X86_64 - enum: - - ARCHITECTURE_UNSPECIFIED - - ARM64 - - X86_64 - SourceDiskEncryptionKey: - id: SourceDiskEncryptionKey - type: object - properties: - sourceDisk: - description: >- - URL of the disk attached to the source instance. This can be a full - or valid partial URL. 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 - type: string - diskEncryptionKey: - description: >- - The customer-supplied encryption key of the source disk. Required if - the source disk is protected by a customer-supplied encryption key. - $ref: '#/components/schemas/CustomerEncryptionKey' - MachineTypeList: - id: MachineTypeList - description: Contains a list of machine types. - type: object - properties: - kind: - description: >- - [Output Only] Type of resource. Always compute#machineTypeList for - lists of machine types. - default: compute#machineTypeList - type: string - id: - description: >- - [Output Only] Unique identifier for the resource; defined by the - server. - type: string - items: - description: A list of MachineType resources. - type: array - items: - $ref: '#/components/schemas/MachineType' - nextPageToken: + $ref: '#/components/schemas/HttpsHealthCheck' + nextPageToken: description: >- [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than @@ -31711,6 +31461,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -31754,6 +31507,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -31776,6 +31530,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -31812,19 +31567,21 @@ components: [Output Only] A warning data value corresponding to the key. type: string - MachineType: - id: MachineType + HttpsHealthCheck: + id: HttpsHealthCheck 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. + 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 . type: object properties: kind: - description: >- - [Output Only] The type of the resource. Always compute#machineType - for machine types. - default: compute#machineType + description: Type of the resource. + default: compute#httpsHealthCheck type: string id: description: >- @@ -31836,106 +31593,76 @@ components: description: '[Output Only] Creation timestamp in RFC3339 text format.' type: string name: - description: '[Output Only] Name of the resource.' + 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 description: - description: '[Output Only] An optional textual description of the resource.' + description: >- + An optional description of this resource. Provide this property when + you create the resource. type: string - guestCpus: + host: description: >- - [Output Only] The number of virtual CPUs that are available to the - instance. + 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 + requestPath: + description: >- + The request path of the HTTPS health check request. The default + value is "/". Must comply with RFC3986. + type: string + port: + description: >- + The TCP port number for the HTTPS health check request. The default + value is 443. type: integer format: int32 - memoryMb: + checkIntervalSec: description: >- - [Output Only] The amount of physical memory available to the - instance, defined in MB. + How often (in seconds) to send a health check. The default value is + 5 seconds. type: integer format: int32 - imageSpaceGb: + timeoutSec: description: >- - [Deprecated] This property is deprecated and will never be populated - with any relevant values. + 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. type: integer format: int32 - scratchDisks: + unhealthyThreshold: description: >- - [Output Only] A list of extended scratch disks assigned to the - instance. - type: array - items: - type: object - properties: - diskGb: - description: Size of the scratch disk, defined in GB. - type: integer - format: int32 - maximumPersistentDisks: - description: '[Output Only] Maximum persistent disks allowed.' + A so-far healthy instance will be marked unhealthy after this many + consecutive failures. The default value is 2. type: integer format: int32 - maximumPersistentDisksSizeGb: - description: '[Output Only] Maximum total persistent disks size (GB) allowed.' - type: string - format: int64 - deprecated: - description: >- - [Output Only] The deprecation status associated with this machine - type. Only applicable if the machine type is unavailable. - $ref: '#/components/schemas/DeprecationStatus' - zone: + healthyThreshold: description: >- - [Output Only] The name of the zone where the machine type resides, - such as us-central1-a. - type: string + A so-far unhealthy instance will be marked healthy after this many + consecutive successes. The default value is 2. + type: integer + format: int32 selfLink: description: '[Output Only] Server-defined URL for the resource.' type: string - isSharedCpu: - description: >- - [Output Only] Whether this machine type has a shared CPU. See - Shared-core machine types for more information. - type: boolean - accelerators: - description: >- - [Output Only] A list of accelerator configurations assigned to this - machine type. - type: array - items: - type: object - properties: - guestAcceleratorType: - description: >- - The accelerator type resource name, not a full URL, e.g. - nvidia-tesla-t4. - type: string - guestAcceleratorCount: - description: Number of accelerator cards exposed to the guest. - type: integer - format: int32 - architecture: - description: '[Output Only] The architecture of the machine type.' - type: string - enumDescriptions: - - Default value indicating Architecture is not set. - - Machines with architecture ARM64 - - Machines with architecture X86_64 - enum: - - ARCHITECTURE_UNSPECIFIED - - ARM64 - - X86_64 - MachineTypeAggregatedList: - id: MachineTypeAggregatedList + InstanceTemplateList: + id: InstanceTemplateList + description: A list of instance templates. type: object properties: kind: description: >- - [Output Only] Type of resource. Always - compute#machineTypeAggregatedList for aggregated lists of machine - types. - default: compute#machineTypeAggregatedList + [Output Only] The resource type, which is always + compute#instanceTemplatesListResponse for instance template lists. + default: compute#instanceTemplateList type: string id: description: >- @@ -31943,13 +31670,10 @@ components: server. type: string items: - description: A list of MachineTypesScopedList resources. - type: object - additionalProperties: - description: >- - [Output Only] Name of the scope containing this set of machine - types. - $ref: '#/components/schemas/MachineTypesScopedList' + description: A list of InstanceTemplate resources. + type: array + items: + $ref: '#/components/schemas/InstanceTemplate' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -32025,6 +31749,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -32068,6 +31795,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -32090,6 +31818,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -32126,24 +31855,208 @@ components: [Output Only] A warning data value corresponding to the key. type: string - unreachables: - description: '[Output Only] Unreachable resources.' - type: array - items: - type: string - MachineTypesScopedList: - id: MachineTypesScopedList + InstanceTemplate: + id: InstanceTemplate + description: >- + Represents an Instance Template resource. Google Compute Engine has two + Instance Template resources: * + [Global](/compute/docs/reference/rest/v1/instanceTemplates) * + [Regional](/compute/docs/reference/rest/v1/regionInstanceTemplates) You + can reuse a global instance template in different regions whereas you + can use a regional instance template in a specified region only. If you + want to reduce cross-region dependency or achieve data residency, use a + regional instance template. To create VMs, managed instance groups, and + reservations, you can use either global or regional instance templates. + For more information, read Instance Templates. type: object properties: - machineTypes: - description: '[Output Only] A list of machine types contained in this scope.' + kind: + description: >- + [Output Only] The resource type, which is always + compute#instanceTemplate for instance templates. + default: compute#instanceTemplate + type: string + id: + description: >- + [Output Only] A unique identifier for this instance template. The + server defines this identifier. + type: string + format: uint64 + creationTimestamp: + description: >- + [Output Only] The creation timestamp for this instance template in + RFC3339 text format. + 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])?' + annotations: + required: + - compute.instanceTemplates.insert + type: string + description: + description: >- + An optional description of this resource. Provide this property when + you create the resource. + type: string + properties: + description: The instance properties for this instance template. + $ref: '#/components/schemas/InstanceProperties' + 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: + description: The source instance params to use to create this instance template. + $ref: '#/components/schemas/SourceInstanceParams' + region: + description: >- + [Output Only] URL of the region where the instance template resides. + Only applicable for regional resources. + type: string + SourceInstanceParams: + id: SourceInstanceParams + description: >- + A specification of the parameters to use when creating the instance + template from a source instance. + type: object + properties: + diskConfigs: + description: >- + Attached disks configuration. If not provided, defaults are applied: + For boot disk and any other R/W disks, the source images for each + disk will be used. For read-only disks, they will be attached in + read-only mode. Local SSD disks will be created as blank volumes. type: array items: - $ref: '#/components/schemas/MachineType' - warning: + $ref: '#/components/schemas/DiskInstantiationConfig' + DiskInstantiationConfig: + id: DiskInstantiationConfig + description: >- + A specification of the desired way to instantiate a disk in the instance + template when its created from a source instance. + type: object + properties: + deviceName: description: >- - [Output Only] An informational warning that appears when the machine - types list is empty. + 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. + type: string + enumDescriptions: + - >- + Attach the existing disk in read-only mode. The request will fail + if the disk was attached in read-write mode on the source + instance. Applicable to: read-only disks. + - >- + Create a blank disk. The disk will be created unformatted. + Applicable to: additional read-write disks, local SSDs. + - >- + Use the custom image specified in the custom_image field. + Applicable to: boot disk, additional read-write disks. + - >- + Use the default instantiation option for the corresponding type of + disk. 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. + - >- + Do not include the disk in the instance template. Applicable to: + additional read-write disks, local SSDs, read-only disks. + - >- + Use the same source image used for creation of the source + instance's corresponding disk. The request will fail if the source + VM's disk was created from a snapshot. Applicable to: boot disk, + additional read-write disks. + - >- + Use the same source image family used for creation of the source + instance's corresponding disk. The request will fail if the source + image of the source disk does not belong to any image family. + Applicable to: boot disk, additional read-write disks. + enum: + - ATTACH_READ_ONLY + - BLANK + - CUSTOM_IMAGE + - DEFAULT + - DO_NOT_INCLUDE + - SOURCE_IMAGE + - SOURCE_IMAGE_FAMILY + 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 + InstanceTemplateAggregatedList: + id: InstanceTemplateAggregatedList + description: Contains a list of InstanceTemplatesScopedList. + type: object + properties: + kind: + description: Type of resource. + default: compute#instanceTemplateAggregatedList + type: string + id: + description: >- + [Output Only] Unique identifier for the resource; defined by the + server. + type: string + items: + description: A list of InstanceTemplatesScopedList resources. + type: object + additionalProperties: + description: >- + The name of the scope that contains this set of instance + templates. + $ref: '#/components/schemas/InstanceTemplatesScopedList' + nextPageToken: + description: >- + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. + type: string + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string + warning: + description: '[Output Only] Informational warning message.' type: object properties: code: @@ -32206,6 +32119,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -32249,6 +32165,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -32271,6 +32188,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -32307,38 +32225,21 @@ components: [Output Only] A warning data value corresponding to the key. type: string - NetworkAttachmentAggregatedList: - id: NetworkAttachmentAggregatedList - description: Contains a list of NetworkAttachmentsScopedList. + InstanceTemplatesScopedList: + id: InstanceTemplatesScopedList type: object properties: - kind: - default: compute#networkAttachmentAggregatedList - type: string - id: - description: >- - [Output Only] Unique identifier for the resource; defined by the - server. - type: string - items: - description: A list of NetworkAttachmentsScopedList resources. - type: object - additionalProperties: - description: Name of the scope containing this set of NetworkAttachments. - $ref: '#/components/schemas/NetworkAttachmentsScopedList' - nextPageToken: + instanceTemplates: description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. - type: string - selfLink: - description: '[Output Only] Server-defined URL for this resource.' - type: string + [Output Only] A list of instance templates that are contained within + the specified project and zone. + type: array + items: + $ref: '#/components/schemas/InstanceTemplate' warning: - description: '[Output Only] Informational warning message.' + description: >- + [Output Only] An informational warning that replaces the list of + instance templates when the list is empty. type: object properties: code: @@ -32401,6 +32302,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -32444,6 +32348,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -32466,6 +32371,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -32502,19 +32408,94 @@ components: [Output Only] A warning data value corresponding to the key. type: string - NetworkAttachmentsScopedList: - id: NetworkAttachmentsScopedList + InstanceSettings: + id: InstanceSettings + description: >- + Represents a Instance Settings resource. You can use instance settings + to configure default settings for Compute Engine VM instances. For + example, you can use it to configure default machine type of Compute + Engine VM instances. type: object properties: - networkAttachments: - description: A list of NetworkAttachments contained in this scope. + kind: + description: >- + [Output Only] Type of the resource. Always compute#instance_settings + for instance settings. + default: compute#instanceSettings + type: string + fingerprint: + description: >- + Specifies a fingerprint for instance settings, which is essentially + a hash of the instance settings resource'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 settings resource. You must always provide an + up-to-date fingerprint hash in order to update or change the + resource, otherwise the request will fail with error 412 + conditionNotMet. To see the latest fingerprint, make a get() request + to retrieve the resource. + type: string + format: byte + metadata: + description: >- + The metadata key/value pairs assigned to all the instances in the + corresponding scope. + $ref: '#/components/schemas/InstanceSettingsMetadata' + zone: + description: >- + [Output Only] URL of the zone where the resource 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 + InstanceSettingsMetadata: + id: InstanceSettingsMetadata + type: object + properties: + kind: + description: >- + [Output Only] Type of the resource. Always compute#metadata for + metadata. + default: compute#metadata + type: string + items: + description: >- + A metadata key/value items map. The total size of all keys and + values must be less than 512KB. + type: object + additionalProperties: + type: string + InstantSnapshotList: + id: InstantSnapshotList + description: Contains a list of InstantSnapshot resources. + type: object + properties: + kind: + description: Type of resource. + default: compute#instantSnapshotList + type: string + id: + description: >- + [Output Only] Unique identifier for the resource; defined by the + server. + type: string + items: + description: A list of InstantSnapshot resources. type: array items: - $ref: '#/components/schemas/NetworkAttachment' - warning: + $ref: '#/components/schemas/InstantSnapshot' + nextPageToken: description: >- - Informational warning which replaces the list of network attachments - when the list is empty. + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. + type: string + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string + warning: + description: '[Output Only] Informational warning message.' type: object properties: code: @@ -32577,6 +32558,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -32620,6 +32604,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -32642,6 +32627,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -32678,19 +32664,23 @@ components: [Output Only] A warning data value corresponding to the key. type: string - NetworkAttachment: - id: NetworkAttachment - description: NetworkAttachments A network attachment resource ... + InstantSnapshot: + id: InstantSnapshot + description: >- + Represents a InstantSnapshot resource. You can use instant snapshots to + create disk rollback points quickly.. type: object properties: kind: - description: '[Output Only] Type of the resource.' - default: compute#networkAttachment + description: >- + [Output Only] Type of the resource. Always compute#instantSnapshot + for InstantSnapshot resources. + default: compute#instantSnapshot type: string id: description: >- - [Output Only] The unique identifier for the resource type. The - server generates this identifier. + [Output Only] The unique identifier for the resource. This + identifier is defined by the server. type: string format: uint64 creationTimestamp: @@ -32698,7 +32688,7 @@ components: type: string name: description: >- - Name of the resource. Provided by the client when the resource is + 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 @@ -32706,146 +32696,133 @@ components: 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])?' - annotations: - required: - - compute.networkAttachments.insert type: string description: description: >- An optional description of this resource. Provide this property when you create the resource. type: string - selfLink: - description: '[Output Only] Server-defined URL for the resource.' - type: string - selfLinkWithId: - description: '[Output Only] Server-defined URL for this resource''s resource id.' - type: string - region: + status: description: >- - [Output Only] URL of the region where the network 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 - connectionPreference: + [Output Only] The status of the instantSnapshot. This can be + CREATING, DELETING, FAILED, or READY. type: string enumDescriptions: - - '' - - '' - - '' + - InstantSnapshot creation is in progress. + - InstantSnapshot is currently being deleted. + - InstantSnapshot creation failed. + - InstantSnapshot has been created successfully. + - >- + InstantSnapshot is currently unavailable and cannot be used for + Disk restoration enum: - - ACCEPT_AUTOMATIC - - ACCEPT_MANUAL - - INVALID - connectionEndpoints: - description: >- - [Output Only] An array of connections for all the producers - connected to this network attachment. - type: array - items: - $ref: '#/components/schemas/NetworkAttachmentConnectedEndpoint' - subnetworks: + - CREATING + - DELETING + - FAILED + - READY + - UNAVAILABLE + sourceDisk: description: >- - An array of URLs where each entry is the URL of a subnet provided by - the service consumer to use for endpoints in the producers that - connect to this network attachment. - type: array - items: - type: string - producerRejectLists: + URL of the source disk used to create this instant snapshot. Note + that the source disk must be in the same zone/region as the instant + snapshot to be created. This can be a full or valid partial URL. 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: >- - Projects that are not allowed to connect to this network attachment. - The project can be specified using its id or number. - type: array - items: - type: string - producerAcceptLists: + [Output Only] The ID value of the disk used to create this + InstantSnapshot. This value may be used to determine whether the + InstantSnapshot was taken from the current or a previous instance of + a given disk name. + type: string + diskSizeGb: + description: '[Output Only] Size of the source disk, specified in GB.' + type: string + format: int64 + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + selfLinkWithId: + description: '[Output Only] Server-defined URL for this resource''s resource id.' + type: string + labels: description: >- - Projects that are allowed to connect to this network attachment. The - project can be specified using its id or number. - type: array - items: + Labels to apply to this InstantSnapshot. These can be later modified + by the setLabels method. Label values may be empty. + type: object + additionalProperties: type: string - fingerprint: + labelFingerprint: description: >- - Fingerprint of this resource. A hash of the contents stored in this - object. This field is used in optimistic locking. An up-to-date - fingerprint must be provided in order to patch. + A fingerprint for the labels being applied to this InstantSnapshot, + 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 InstantSnapshot. type: string format: byte - network: - description: >- - [Output Only] The URL of the network which the Network Attachment - belongs to. Practically it is inferred by fetching the network of - the first subnetwork associated. Because it is required that all the - subnetworks must be from the same network, it is assured that the - Network Attachment belongs to the same network as all the - subnetworks. - type: string - NetworkAttachmentConnectedEndpoint: - id: NetworkAttachmentConnectedEndpoint - description: '[Output Only] A connection connected to this network attachment.' - type: object - properties: - status: - description: The status of a connected endpoint to this network attachment. - type: string - enumDescriptions: - - The consumer allows traffic from the producer to reach its VPC. - - The consumer network attachment no longer exists. - - >- - The consumer needs to take further action before traffic can be - served. - - >- - The consumer neither allows nor prohibits traffic from the - producer to reach its VPC. - - The consumer prohibits traffic from the producer to reach its VPC. - - '' - enum: - - ACCEPTED - - CLOSED - - NEEDS_ATTENTION - - PENDING - - REJECTED - - STATUS_UNSPECIFIED - projectIdOrNum: + zone: description: >- - The project id or number of the interface to which the IP was - assigned. + [Output Only] URL of the zone where the instant snapshot 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 - subnetwork: + region: description: >- - The subnetwork used to assign the IP to the producer instance - network interface. + [Output Only] URL of the region where the instant snapshot 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 - ipAddress: + satisfiesPzs: + description: '[Output Only] Reserved for future use.' + type: boolean + architecture: description: >- - The IPv4 address assigned to the producer instance network - interface. This value will be a range in case of Serverless. + [Output Only] The architecture of the instant snapshot. Valid values + are ARM64 or X86_64. type: string - ipv6Address: - description: >- - The IPv6 address assigned to the producer instance network - interface. This is only assigned when the stack types of both the - instance network interface and the consumer subnet are IPv4_IPv6. - type: string - secondaryIpCidrRanges: - description: Alias IP ranges from the same subnetwork. - type: array - items: - type: string - subnetworkCidrRange: - description: >- - [Output Only] The CIDR range of the subnet from which the IPv4 - internal IP was allocated from. + enumDescriptions: + - Default value indicating Architecture is not set. + - Machines with architecture ARM64 + - Machines with architecture X86_64 + enum: + - ARCHITECTURE_UNSPECIFIED + - ARM64 + - X86_64 + resourceStatus: + description: '[Output Only] Status information for the instant snapshot resource.' + $ref: '#/components/schemas/InstantSnapshotResourceStatus' + satisfiesPzi: + description: Output only. Reserved for future use. + readOnly: true + type: boolean + InstantSnapshotResourceStatus: + id: InstantSnapshotResourceStatus + type: object + properties: + storageSizeBytes: + description: '[Output Only] The storage size of this instant snapshot.' type: string - NetworkAttachmentList: - id: NetworkAttachmentList + format: int64 + InstantSnapshotAggregatedList: + id: InstantSnapshotAggregatedList type: object properties: kind: - default: compute#networkAttachmentList + description: >- + [Output Only] Type of resource. Always + compute#instantSnapshotAggregatedList for aggregated lists of + instantSnapshots. + default: compute#instantSnapshotAggregatedList type: string id: description: >- @@ -32853,10 +32830,13 @@ components: server. type: string items: - description: A list of NetworkAttachment resources. - type: array - items: - $ref: '#/components/schemas/NetworkAttachment' + description: A list of InstantSnapshotsScopedList resources. + type: object + additionalProperties: + description: >- + [Output Only] Name of the scope containing this set of + instantSnapshots. + $ref: '#/components/schemas/InstantSnapshotsScopedList' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -32932,6 +32912,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -32975,6 +32958,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -32997,6 +32981,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -33033,107 +33018,24 @@ components: [Output Only] A warning data value corresponding to the key. type: string - NetworkEdgeSecurityService: - id: NetworkEdgeSecurityService - description: Represents a Google Cloud Armor network edge security service resource. - type: object - properties: - kind: - description: >- - [Output only] Type of the resource. Always - compute#networkEdgeSecurityService for NetworkEdgeSecurityServices - default: compute#networkEdgeSecurityService - type: string - id: - description: >- - [Output Only] The unique identifier for the resource. This - identifier is defined by the server. - type: string - format: uint64 - creationTimestamp: - description: '[Output Only] Creation timestamp in RFC3339 text format.' - 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 - description: - description: >- - An optional description of this resource. Provide this property when - you create the resource. - type: string - 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 - region: - description: >- - [Output Only] URL of the region where the resource 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 - 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 NetworkEdgeSecurityService. An up-to-date - fingerprint must be provided in order to update the - NetworkEdgeSecurityService, otherwise the request will fail with - error 412 conditionNotMet. To see the latest fingerprint, make a - get() request to retrieve a NetworkEdgeSecurityService. - type: string - format: byte - securityPolicy: - description: >- - The resource URL for the network edge security service associated - with this network edge security service. - type: string - NetworkEdgeSecurityServiceAggregatedList: - id: NetworkEdgeSecurityServiceAggregatedList + unreachables: + description: '[Output Only] Unreachable resources.' + type: array + items: + type: string + InstantSnapshotsScopedList: + id: InstantSnapshotsScopedList type: object properties: - kind: - description: >- - [Output Only] Type of resource. Always - compute#networkEdgeSecurityServiceAggregatedList for lists of - Network Edge Security Services. - default: compute#networkEdgeSecurityServiceAggregatedList - type: string - id: - description: >- - [Output Only] Unique identifier for the resource; defined by the - server. - type: string - items: - description: A list of NetworkEdgeSecurityServicesScopedList resources. - type: object - additionalProperties: - description: Name of the scope containing this set of security policies. - $ref: '#/components/schemas/NetworkEdgeSecurityServicesScopedList' - nextPageToken: - description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. - type: string - selfLink: - description: '[Output Only] Server-defined URL for this resource.' - type: string + instantSnapshots: + description: '[Output Only] A list of instantSnapshots contained in this scope.' + type: array + items: + $ref: '#/components/schemas/InstantSnapshot' warning: - description: '[Output Only] Informational warning message.' + description: >- + [Output Only] Informational warning which replaces the list of + instantSnapshots when the list is empty. type: object properties: code: @@ -33196,6 +33098,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -33239,6 +33144,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -33261,6 +33167,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -33297,26 +33204,43 @@ components: [Output Only] A warning data value corresponding to the key. type: string - etag: - type: string - unreachables: - description: '[Output Only] Unreachable resources.' - type: array - items: - type: string - NetworkEdgeSecurityServicesScopedList: - id: NetworkEdgeSecurityServicesScopedList + InterconnectLocationList: + id: InterconnectLocationList + description: >- + Response to the list request, and contains a list of interconnect + locations. type: object properties: - networkEdgeSecurityServices: - description: A list of NetworkEdgeSecurityServices contained in this scope. + kind: + description: >- + [Output Only] Type of resource. Always + compute#interconnectLocationList for lists of interconnect + locations. + default: compute#interconnectLocationList + type: string + id: + description: >- + [Output Only] Unique identifier for the resource; defined by the + server. + type: string + items: + description: A list of InterconnectLocation resources. type: array items: - $ref: '#/components/schemas/NetworkEdgeSecurityService' - warning: + $ref: '#/components/schemas/InterconnectLocation' + nextPageToken: description: >- - Informational warning which replaces the list of security policies - when the list is empty. + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. + type: string + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string + warning: + description: '[Output Only] Informational warning message.' type: object properties: code: @@ -33379,6 +33303,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -33422,6 +33349,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -33444,6 +33372,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -33480,15 +33409,209 @@ components: [Output Only] A warning data value corresponding to the key. type: string - NetworkEndpointGroupList: - id: NetworkEndpointGroupList + InterconnectLocation: + id: 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. type: object properties: kind: description: >- - [Output Only] The resource type, which is always - compute#networkEndpointGroupList for network endpoint group lists. - default: compute#networkEndpointGroupList + [Output Only] Type of the resource. Always + compute#interconnectLocation for interconnect locations. + default: compute#interconnectLocation + type: string + description: + description: '[Output Only] An optional description of the resource.' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + id: + description: >- + [Output Only] The unique identifier for the resource. This + identifier is defined by the server. + type: string + format: uint64 + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + 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 + 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 + 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 + 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. + type: array + items: + $ref: '#/components/schemas/InterconnectLocationRegionInfo' + continent: + description: >- + [Output Only] Continent for this location, which can take one of the + following values: - AFRICA - ASIA_PAC - EUROPE - NORTH_AMERICA - + SOUTH_AMERICA + type: string + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + enum: + - AFRICA + - ASIA_PAC + - C_AFRICA + - C_ASIA_PAC + - C_EUROPE + - C_NORTH_AMERICA + - C_SOUTH_AMERICA + - EUROPE + - NORTH_AMERICA + - SOUTH_AMERICA + city: + description: >- + [Output Only] Metropolitan area designator that indicates which city + an interconnect is located. For example: "Chicago, IL", "Amsterdam, + Netherlands". + 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 + 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. + type: string + enumDescriptions: + - >- + The InterconnectLocation is available for provisioning new + Interconnects. + - >- + The InterconnectLocation is closed for provisioning new + Interconnects. + enum: + - AVAILABLE + - CLOSED + supportsPzs: + description: '[Output Only] Reserved for future use.' + type: boolean + availableFeatures: + description: >- + [Output only] List of features available at this + InterconnectLocation, which can take one of the following values: - + IF_MACSEC + type: array + items: + type: string + enumDescriptions: + - Media Access Control security (MACsec) + enum: + - IF_MACSEC + availableLinkTypes: + description: >- + [Output only] List of link types available at this + InterconnectLocation, which can take one of the following values: - + LINK_TYPE_ETHERNET_10G_LR - LINK_TYPE_ETHERNET_100G_LR - + LINK_TYPE_ETHERNET_400G_LR4 + type: array + items: + type: string + enumDescriptions: + - 100G Ethernet, LR Optics. + - 10G Ethernet, LR Optics. [(rate_bps) = 10000000000]; + - 400G Ethernet, LR4 Optics. + enum: + - LINK_TYPE_ETHERNET_100G_LR + - LINK_TYPE_ETHERNET_10G_LR + - LINK_TYPE_ETHERNET_400G_LR4 + InterconnectLocationRegionInfo: + id: InterconnectLocationRegionInfo + description: >- + Information about any potential InterconnectAttachments between an + Interconnect at a specific InterconnectLocation, and a specific Cloud + Region. + type: object + properties: + region: + description: URL for the region of this location. + type: string + expectedRttMs: + description: >- + Expected round-trip time in milliseconds, from this + InterconnectLocation to a VM in this region. + type: string + format: int64 + locationPresence: + description: Identifies the network presence of this location. + type: string + enumDescriptions: + - >- + This region is not in any common network presence with this + InterconnectLocation. + - >- + This region shares the same regional network presence as this + InterconnectLocation. + - >- + [Deprecated] This region is not in any common network presence + with this InterconnectLocation. + - >- + [Deprecated] This region shares the same regional network presence + as this InterconnectLocation. + enum: + - GLOBAL + - LOCAL_REGION + - LP_GLOBAL + - LP_LOCAL_REGION + InterconnectRemoteLocationList: + id: InterconnectRemoteLocationList + description: >- + Response to the list request, and contains a list of interconnect remote + locations. + type: object + properties: + kind: + description: >- + [Output Only] Type of resource. Always + compute#interconnectRemoteLocationList for lists of interconnect + remote locations. + default: compute#interconnectRemoteLocationList type: string id: description: >- @@ -33496,17 +33619,17 @@ components: server. type: string items: - description: A list of NetworkEndpointGroup resources. + description: A list of InterconnectRemoteLocation resources. type: array items: - $ref: '#/components/schemas/NetworkEndpointGroup' + $ref: '#/components/schemas/InterconnectRemoteLocation' nextPageToken: description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. + [Output Only] This token lets you get the next page of results for + list requests. If the number of results is larger than maxResults, + use the nextPageToken as a value for the query parameter pageToken + in the next list request. Subsequent list requests will have their + own nextPageToken to continue paging through the results. type: string selfLink: description: '[Output Only] Server-defined URL for this resource.' @@ -33575,6 +33698,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -33618,6 +33744,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -33640,6 +33767,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -33676,20 +33804,26 @@ components: [Output Only] A warning data value corresponding to the key. type: string - NetworkEndpointGroup: - id: NetworkEndpointGroup + InterconnectRemoteLocation: + id: InterconnectRemoteLocation 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 for different use cases, see Network endpoint groups overview. + Represents a Cross-Cloud Interconnect Remote Location resource. You can + use this resource to find remote location details about an Interconnect + attachment (VLAN). type: object properties: kind: description: >- [Output Only] Type of the resource. Always - compute#networkEndpointGroup for network endpoint group. - default: compute#networkEndpointGroup + compute#interconnectRemoteLocation for interconnect remote + locations. + default: compute#interconnectRemoteLocation + type: string + description: + description: '[Output Only] An optional description of the resource.' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' type: string id: description: >- @@ -33700,291 +33834,434 @@ components: creationTimestamp: description: '[Output Only] Creation timestamp in RFC3339 text format.' type: string - selfLink: - description: '[Output Only] Server-defined URL for the resource.' - type: string name: + description: '[Output Only] Name of the resource.' + type: string + peeringdbFacilityId: 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. + [Output Only] The peeringdb identifier for this facility + (corresponding with a netfac type in peeringdb). type: string - description: + address: description: >- - An optional description of this resource. Provide this property when - you create the resource. + [Output Only] The postal address of the Point of Presence, each line + in the address is separated by a newline character. type: string - networkEndpointType: + facilityProvider: description: >- - Type of network endpoints in this network endpoint group. Can be one - of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, - INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, - PRIVATE_SERVICE_CONNECT, GCE_VM_IP_PORTMAP. + [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 + continent: + description: >- + [Output Only] Continent for this location, which can take one of the + following values: - AFRICA - ASIA_PAC - EUROPE - NORTH_AMERICA - + SOUTH_AMERICA type: string enumDescriptions: - - The network endpoint is represented by an IP address. - - The network endpoint is represented by IP address and port pair. - - >- - The network endpoint is represented by an IP, Port and Client - Destination Port. - - >- - The network endpoint is represented by fully qualified domain name - and port. - - >- - The network endpoint is represented by an internet IP address and - port. - - >- - The network endpoint is represented by an IP address and port. The - endpoint belongs to a VM or pod running in a customer's - on-premises. - - >- - The network endpoint is either public Google APIs or services - exposed by other GCP Project with a Service Attachment. The - connection is set up by private service connect - - >- - The network endpoint is handled by specified serverless - infrastructure. + - '' + - '' + - '' + - '' + - '' enum: - - GCE_VM_IP - - GCE_VM_IP_PORT - - GCE_VM_IP_PORTMAP - - INTERNET_FQDN_PORT - - INTERNET_IP_PORT - - NON_GCP_PRIVATE_IP_PORT - - PRIVATE_SERVICE_CONNECT - - SERVERLESS - size: - description: >- - [Output only] Number of network endpoints in the network endpoint - group. - type: integer - format: int32 - region: + - AFRICA + - ASIA_PAC + - EUROPE + - NORTH_AMERICA + - SOUTH_AMERICA + city: description: >- - [Output Only] The URL of the region where the network endpoint group - is located. + [Output Only] Metropolitan area designator that indicates which city + an interconnect is located. For example: "Chicago, IL", "Amsterdam, + Netherlands". type: string - zone: + status: description: >- - [Output Only] The URL of the zone where the network endpoint group - is located. + [Output Only] The status of this InterconnectRemoteLocation, which + can take one of the following values: - CLOSED: The + InterconnectRemoteLocation is closed and is unavailable for + provisioning new Cross-Cloud Interconnects. - AVAILABLE: The + InterconnectRemoteLocation is available for provisioning new + Cross-Cloud Interconnects. type: string - network: + enumDescriptions: + - >- + The InterconnectRemoteLocation is available for provisioning new + Cross-Cloud Interconnects. + - >- + The InterconnectRemoteLocation is closed for provisioning new + Cross-Cloud Interconnects. + enum: + - AVAILABLE + - CLOSED + remoteService: description: >- - The URL of the network to which all network endpoints in the NEG - belong. Uses default project network if unspecified. + [Output Only] Indicates the service provider present at the remote + location. Example values: "Amazon Web Services", "Microsoft Azure". type: string - subnetwork: + permittedConnections: + description: '[Output Only] Permitted connections.' + type: array + items: + $ref: >- + #/components/schemas/InterconnectRemoteLocationPermittedConnections + constraints: description: >- - Optional URL of the subnetwork to which all network endpoints in the - NEG belong. + [Output Only] Constraints on the parameters for creating Cross-Cloud + Interconnect and associated InterconnectAttachments. + $ref: '#/components/schemas/InterconnectRemoteLocationConstraints' + attachmentConfigurationConstraints: + description: >- + [Output Only] Subset of fields from InterconnectAttachment's + |configurationConstraints| field that apply to all attachments for + this remote location. + $ref: '#/components/schemas/InterconnectAttachmentConfigurationConstraints' + lacp: + description: >- + [Output Only] Link Aggregation Control Protocol (LACP) constraints, + which can take one of the following values: LACP_SUPPORTED, + LACP_UNSUPPORTED type: string - defaultPort: + enumDescriptions: + - >- + LACP_SUPPORTED: LACP is supported, and enabled by default on the + Cross-Cloud Interconnect. + - >- + LACP_UNSUPPORTED: LACP is not supported and is not be enabled on + this port. GetDiagnostics shows bundleAggregationType as "static". + GCP does not support LAGs without LACP, so requestedLinkCount must + be 1. + enum: + - LACP_SUPPORTED + - LACP_UNSUPPORTED + maxLagSize100Gbps: description: >- - The default port used if the port number is not specified in the - network endpoint. If the network endpoint type is either GCE_VM_IP, - SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be - specified. + [Output Only] The maximum number of 100 Gbps ports supported in a + link aggregation group (LAG). When linkType is 100 Gbps, + requestedLinkCount cannot exceed max_lag_size_100_gbps. type: integer format: int32 - annotations: - description: Metadata defined as annotations on the network endpoint group. - type: object - additionalProperties: - type: string - cloudRun: - description: >- - Only valid when networkEndpointType is SERVERLESS. Only one of - cloudRun, appEngine or cloudFunction may be set. - $ref: '#/components/schemas/NetworkEndpointGroupCloudRun' - appEngine: - description: >- - Only valid when networkEndpointType is SERVERLESS. Only one of - cloudRun, appEngine or cloudFunction may be set. - $ref: '#/components/schemas/NetworkEndpointGroupAppEngine' - cloudFunction: + maxLagSize10Gbps: description: >- - Only valid when networkEndpointType is SERVERLESS. Only one of - cloudRun, appEngine or cloudFunction may be set. - $ref: '#/components/schemas/NetworkEndpointGroupCloudFunction' - pscTargetService: + [Output Only] The maximum number of 10 Gbps ports supported in a + link aggregation group (LAG). When linkType is 10 Gbps, + requestedLinkCount cannot exceed max_lag_size_10_gbps. + type: integer + format: int32 + InterconnectRemoteLocationPermittedConnections: + id: InterconnectRemoteLocationPermittedConnections + type: object + properties: + interconnectLocation: description: >- - The target service url used to set up private service connection to - a Google API or a PSC Producer Service Attachment. An example value - is: asia-northeast3-cloudkms.googleapis.com + [Output Only] URL of an Interconnect location that is permitted to + connect to this Interconnect remote location. type: string - pscData: - $ref: '#/components/schemas/NetworkEndpointGroupPscData' - NetworkEndpointGroupCloudRun: - id: 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. + InterconnectRemoteLocationConstraints: + id: InterconnectRemoteLocationConstraints type: object properties: - service: + subnetLengthRange: 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: + [Output Only] [min-length, max-length] The minimum and maximum value + (inclusive) for the IPv4 subnet length. For example, an + interconnectRemoteLocation for Azure has {min: 30, max: 30} because + Azure requires /30 subnets. This range specifies the values + supported by both cloud providers. Interconnect currently supports + /29 and /30 IPv4 subnet lengths. If a remote cloud has no constraint + on IPv4 subnet length, the range would thus be {min: 29, max: 30}. + $ref: >- + #/components/schemas/InterconnectRemoteLocationConstraintsSubnetLengthRange + portPairVlan: 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". + [Output Only] Port pair VLAN constraints, which can take one of the + following values: PORT_PAIR_UNCONSTRAINED_VLAN, + PORT_PAIR_MATCHING_VLAN type: string - urlMask: + enumDescriptions: + - >- + If PORT_PAIR_MATCHING_VLAN, the Interconnect for this attachment + is part of a pair of ports that should have matching VLAN + allocations. This occurs with Cross-Cloud Interconnect to Azure + remote locations. While GCP's API does not explicitly group pairs + of ports, the UI uses this field to ensure matching VLAN ids when + configuring a redundant VLAN pair. + - PORT_PAIR_UNCONSTRAINED_VLAN means there is no constraint. + enum: + - PORT_PAIR_MATCHING_VLAN + - PORT_PAIR_UNCONSTRAINED_VLAN + portPairRemoteLocation: description: >- - An URL mask is one of the main components of the Cloud Function. A - template to parse and 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. + [Output Only] Port pair remote location constraints, which can take + one of the following values: + PORT_PAIR_UNCONSTRAINED_REMOTE_LOCATION, + PORT_PAIR_MATCHING_REMOTE_LOCATION. Google Cloud API refers only to + individual ports, but the UI uses this field when ordering a pair of + ports, to prevent users from accidentally ordering something that is + incompatible with their cloud provider. Specifically, when ordering + a redundant pair of Cross-Cloud Interconnect ports, and one of them + uses a remote location with portPairMatchingRemoteLocation set to + matching, the UI requires that both ports use the same remote + location. type: string - NetworkEndpointGroupAppEngine: - id: NetworkEndpointGroupAppEngine + enumDescriptions: + - >- + If PORT_PAIR_MATCHING_REMOTE_LOCATION, the remote cloud provider + allocates ports in pairs, and the user should choose the same + remote location for both ports. + - >- + If PORT_PAIR_UNCONSTRAINED_REMOTE_LOCATION, a user may opt to + provision a redundant pair of Cross-Cloud Interconnects using two + different remote locations in the same city. + enum: + - PORT_PAIR_MATCHING_REMOTE_LOCATION + - PORT_PAIR_UNCONSTRAINED_REMOTE_LOCATION + InterconnectRemoteLocationConstraintsSubnetLengthRange: + id: InterconnectRemoteLocationConstraintsSubnetLengthRange + type: object + properties: + min: + type: integer + format: int32 + max: + type: integer + format: int32 + LicenseCode: + id: LicenseCode 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. + 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. type: object properties: - service: + kind: description: >- - Optional serving service. The service name is case-sensitive and - must be 1-63 characters long. Example value: default, my-service. + [Output Only] Type of resource. Always compute#licenseCode for + licenses. + default: compute#licenseCode type: string - version: + id: description: >- - Optional serving version. The version name is case-sensitive and - must be 1-100 characters long. Example value: v1, v2. + [Output Only] The unique identifier for the resource. This + identifier is defined by the server. type: string - urlMask: + format: uint64 + name: description: >- - An URL mask is one of the main components of the Cloud Function. 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. + [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}?' + annotations: + required: + - compute.licenses.insert type: string - NetworkEndpointGroupCloudFunction: - id: 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. - type: object - properties: - function: + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: + description: '[Output Only] Description of this License Code.' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + transferable: 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. + [Output Only] If true, the license will remain attached when + creating images or snapshots from disks. Otherwise, the license is + not transferred. + type: boolean + state: + description: '[Output Only] Current state of this License Code.' type: string - urlMask: + enumDescriptions: + - >- + Machines are not allowed to attach boot disks with this License + Code. Requests to create new resources with this license will be + rejected. + - >- + Use is allowed for anyone with USE_READ_ONLY access to this + License Code. + - Use of this license is limited to a project whitelist. + - '' + - Reserved state. + enum: + - DISABLED + - ENABLED + - RESTRICTED + - STATE_UNSPECIFIED + - TERMINATED + licenseAlias: description: >- - An URL mask is one of the main components of the Cloud Function. 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. + [Output Only] URL and description aliases of Licenses with the same + License Code. + type: array + items: + $ref: '#/components/schemas/LicenseCodeLicenseAlias' + LicenseCodeLicenseAlias: + id: LicenseCodeLicenseAlias + type: object + properties: + selfLink: + description: '[Output Only] URL of license corresponding to this License Code.' type: string - NetworkEndpointGroupPscData: - id: NetworkEndpointGroupPscData + description: + description: '[Output Only] Description of this License Code.' + type: string + License: + id: License description: >- - All data that is specifically relevant to only network endpoint groups - of type PRIVATE_SERVICE_CONNECT. + 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. type: object properties: - consumerPscAddress: + kind: + description: '[Output Only] Type of resource. Always compute#license for licenses.' + default: compute#license + type: string + name: description: >- - [Output Only] Address allocated from given subnetwork for PSC. This - IP address acts as a VIP for a PSC NEG, allowing it to act as an - endpoint in L7 PSC-XLB. + 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])?' + annotations: + required: + - compute.images.insert type: string - pscConnectionId: + chargesUseFee: description: >- - [Output Only] The PSC connection id of the PSC Network Endpoint - Group Consumer. + [Output Only] Deprecated. This field no longer reflects whether a + license charges a usage fee. + type: boolean + id: + description: >- + [Output Only] The unique identifier for the resource. This + identifier is defined by the server. type: string format: uint64 - pscConnectionStatus: - description: '[Output Only] The connection status of the PSC Forwarding Rule.' + licenseCode: + description: >- + [Output Only] The unique code used to attach this license to images, + snapshots, and disks. type: string - enumDescriptions: - - The connection has been accepted by the producer. - - >- - The connection has been closed by the producer and will not serve - traffic going forward. - - >- - The connection has been accepted by the producer, but the producer - needs to take further action before the forwarding rule can serve - traffic. - - The connection is pending acceptance by the producer. - - The connection has been rejected by the producer. - - '' - enum: - - ACCEPTED - - CLOSED - - NEEDS_ATTENTION - - PENDING - - REJECTED - - STATUS_UNSPECIFIED - producerPort: + format: uint64 + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + description: description: >- - The psc producer port is used to connect PSC NEG with specific port - on the PSC Producer side; should only be used for the - PRIVATE_SERVICE_CONNECT NEG type + An optional textual description of the resource; provided by the + client when the resource is created. + 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 + 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 + resourceRequirements: + description: '[Input Only] Deprecated.' + $ref: '#/components/schemas/LicenseResourceRequirements' + appendableToDisk: + description: >- + If true, this license can be appended to an existing disk's set of + licenses. + type: boolean + removableFromDisk: + description: >- + If true, this license can be removed from a disk's set of licenses, + with no replacement license needed. + type: boolean + allowedReplacementLicenses: + description: >- + Specifies licenseCodes of licenses that can replace this license. + Note: such replacements are allowed even if removable_from_disk is + false. + type: array + items: + type: string + osLicense: + description: >- + If true, indicates this is an OS license. Only one OS license can be + attached to a disk or image at a time. + type: boolean + incompatibleLicenses: + description: >- + Specifies licenseCodes of licenses that are incompatible with this + license. If a license is incompatible with this license, it cannot + be attached to the same disk or image. + type: array + items: + type: string + requiredCoattachedLicenses: + description: >- + Specifies the set of permissible coattached licenseCodes of licenses + that satisfy the coattachment requirement of this license. At least + one license from the set must be attached to the same disk or image + as this license. + type: array + items: + type: string + soleTenantOnly: + description: If true, this license can only be used on VMs on sole tenant nodes. + type: boolean + multiTenantOnly: + description: If true, this license can only be used on VMs on multi tenant nodes. + type: boolean + minimumRetention: + description: >- + If set, this license will be unable to be removed or replaced once + attached to a disk until the minimum_retention period has passed. + $ref: '#/components/schemas/Duration' + updateTimestamp: + description: '[Output Only] Last update timestamp in RFC3339 text format.' + type: string + LicenseResourceRequirements: + id: LicenseResourceRequirements + type: object + properties: + minGuestCpuCount: + description: >- + [Input Only] Deprecated. This field no longer reflects the minimum + number of guest cpus required to use the Instance. type: integer format: int32 - NetworkEndpointGroupAggregatedList: - id: NetworkEndpointGroupAggregatedList + minMemoryMb: + description: >- + [Input Only] Deprecated. This field no longer reflects the minimum + memory required to use the Instance. + type: integer + format: int32 + LicensesListResponse: + id: LicensesListResponse type: object properties: - kind: - description: >- - [Output Only] The resource type, which is always - compute#networkEndpointGroupAggregatedList for aggregated lists of - network endpoint groups. - default: compute#networkEndpointGroupAggregatedList - type: string id: description: >- [Output Only] Unique identifier for the resource; defined by the server. type: string items: - description: A list of NetworkEndpointGroupsScopedList resources. - type: object - additionalProperties: - description: >- - The name of the scope that contains this set of network endpoint - groups. - $ref: '#/components/schemas/NetworkEndpointGroupsScopedList' + description: A list of License resources. + type: array + items: + $ref: '#/components/schemas/License' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -34060,6 +34337,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -34103,6 +34383,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -34125,6 +34406,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -34161,294 +34443,16 @@ components: [Output Only] A warning data value corresponding to the key. type: string - unreachables: - description: '[Output Only] Unreachable resources.' - type: array - items: - type: string - NetworkEndpointGroupsScopedList: - id: NetworkEndpointGroupsScopedList + MachineImageList: + id: MachineImageList + description: A list of machine images. type: object properties: - networkEndpointGroups: - description: >- - [Output Only] The list of network endpoint groups that are contained - in this scope. - type: array - items: - $ref: '#/components/schemas/NetworkEndpointGroup' - warning: - description: >- - [Output Only] An informational warning that replaces the list of - network endpoint groups when the list is empty. - type: object - properties: - code: - description: >- - [Output Only] A warning code, if applicable. For example, - Compute Engine returns NO_RESULTS_ON_PAGE if there are no - results in the response. - type: string - enumDescriptions: - - >- - Warning about failed cleanup of transient changes made by a - failed operation. - - A link to a deprecated resource was created. - - >- - When deploying and at least one of the resources has a type - marked as deprecated - - The user created a boot disk that is larger than image size. - - >- - When deploying and at least one of the resources has a type - marked as experimental - - Warning that is present in an external api call - - >- - Warning that value of a field has been overridden. Deprecated - unused field. - - >- - The operation involved use of an injected kernel, which is - deprecated. - - >- - A WEIGHTED_MAGLEV backend service is associated with a health - check that is not of type HTTP/HTTPS/HTTP2. - - >- - When deploying a deployment with a exceedingly large number of - resources - - >- - Resource can't be retrieved due to list overhead quota exceed - which captures the amount of resources filtered out by - user-defined list filter. - - A resource depends on a missing type - - >- - The route's nextHopIp address is not assigned to an instance - on the network. - - The route's next hop instance cannot ip forward. - - >- - The route's nextHopInstance URL refers to an instance that - does not have an ipv6 interface on the same network as the - route. - - >- - The route's nextHopInstance URL refers to an instance that - does not exist. - - >- - The route's nextHopInstance URL refers to an instance that is - not on the same network as the route. - - >- - The route's next hop instance does not have a status of - RUNNING. - - >- - Error which is not critical. We decided to continue the - process despite the mentioned error. - - No results are present on a particular list page. - - >- - Success is reported, but some results may be missing due to - errors - - >- - The user attempted to use a resource that requires a TOS they - have not accepted. - - Warning that a resource is in use. - - >- - One or more of the resources set to auto-delete could not be - deleted because they were in use. - - When a resource schema validation is ignored. - - >- - Instance template used in instance group manager is valid as - such, but its application does not make a lot of sense, - because it allows only single instance in instance group. - - When undeclared properties in the schema are present - - A given scope cannot be reached. - enumDeprecated: - - false - - false - - false - - false - - false - - false - - true - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - enum: - - CLEANUP_FAILED - - DEPRECATED_RESOURCE_USED - - DEPRECATED_TYPE_USED - - DISK_SIZE_LARGER_THAN_IMAGE_SIZE - - EXPERIMENTAL_TYPE_USED - - EXTERNAL_API_WARNING - - FIELD_VALUE_OVERRIDEN - - INJECTED_KERNELS_DEPRECATED - - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB - - LARGE_DEPLOYMENT_WARNING - - LIST_OVERHEAD_QUOTA_EXCEED - - MISSING_TYPE_DEPENDENCY - - NEXT_HOP_ADDRESS_NOT_ASSIGNED - - NEXT_HOP_CANNOT_IP_FORWARD - - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE - - NEXT_HOP_INSTANCE_NOT_FOUND - - NEXT_HOP_INSTANCE_NOT_ON_NETWORK - - NEXT_HOP_NOT_RUNNING - - NOT_CRITICAL_ERROR - - NO_RESULTS_ON_PAGE - - PARTIAL_SUCCESS - - REQUIRED_TOS_AGREEMENT - - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - - RESOURCE_NOT_DELETED - - SCHEMA_VALIDATION_IGNORED - - SINGLE_INSTANCE_PROPERTY_TEMPLATE - - UNDECLARED_PROPERTIES - - UNREACHABLE - message: - description: '[Output Only] A human-readable description of the warning code.' - type: string - data: - description: >- - [Output Only] Metadata about this warning in key: value format. - For example: "data": [ { "key": "scope", "value": - "zones/us-east1-d" } - type: array - items: - type: object - properties: - key: - description: >- - [Output Only] A key that provides more detail on the - warning being returned. For example, for warnings where - there are no results in a list request for a particular - zone, this key might be scope and the key value might be - the zone name. Other examples might be a key indicating a - deprecated resource and a suggested replacement, or a - warning about invalid network settings (for example, if an - instance attempts to perform IP forwarding but is not - enabled for IP forwarding). - type: string - value: - description: >- - [Output Only] A warning data value corresponding to the - key. - type: string - NetworkEndpointGroupsAttachEndpointsRequest: - id: NetworkEndpointGroupsAttachEndpointsRequest - type: object - properties: - networkEndpoints: - description: The list of network endpoints to be attached. - type: array - items: - $ref: '#/components/schemas/NetworkEndpoint' - NetworkEndpoint: - id: NetworkEndpoint - description: The network endpoint. - type: object - properties: - 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. This field is - redundant and need not be set for network endpoints of type - GCE_VM_IP. If set, it must be set to the primary internal IP address - of the attached VM instance that matches the subnetwork of the NEG. - The primary internal IP address from any NIC of a multi-NIC VM - instance can be added to a NEG as long as it matches the NEG - subnetwork. - type: string - ipv6Address: - description: Optional IPv6 address of network endpoint. - type: string - 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 - port: - description: >- - Optional port number of network endpoint. If not specified, the - defaultPort for the network endpoint group will be used. This field - can not be set for network endpoints of type GCE_VM_IP. - type: integer - format: int32 - clientDestinationPort: - description: >- - Represents the port number to which PSC consumer sends packets. Only - valid for network endpoint groups created with GCE_VM_IP_PORTMAP - endpoint type. - type: integer - format: int32 - instance: - description: >- - The name or a URL of VM instance of this network endpoint. This - field is required for network endpoints of type GCE_VM_IP and - GCE_VM_IP_PORT. The instance must be in the same zone of network - endpoint group (for zonal NEGs) or in the zone within the region of - the NEG (for regional NEGs). If the ipAddress is specified, it must - belongs to the VM instance. The name must be 1-63 characters long, - and comply with RFC1035 or be a valid URL pointing to an existing - instance. - type: string - annotations: - description: Metadata defined as annotations on the network endpoint. - type: object - additionalProperties: - type: string - NetworkEndpointGroupsDetachEndpointsRequest: - id: NetworkEndpointGroupsDetachEndpointsRequest - type: object - properties: - networkEndpoints: - description: The list of network endpoints to be detached. - type: array - items: - $ref: '#/components/schemas/NetworkEndpoint' - NetworkEndpointGroupsListEndpointsRequest: - id: NetworkEndpointGroupsListEndpointsRequest - type: object - 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. - type: string - enumDescriptions: - - >- - Show the health status for each network endpoint. Impacts latency - of the call. - - Health status for network endpoints will not be provided. - enum: - - SHOW - - SKIP - NetworkEndpointGroupsListNetworkEndpoints: - id: NetworkEndpointGroupsListNetworkEndpoints - type: object - properties: - kind: + kind: description: >- [Output Only] The resource type, which is always - compute#networkEndpointGroupsListNetworkEndpoints for the list of - network endpoints in the specified network endpoint group. - default: compute#networkEndpointGroupsListNetworkEndpoints + compute#machineImagesListResponse for machine image lists. + default: compute#machineImageList type: string id: description: >- @@ -34456,10 +34460,10 @@ components: server. type: string items: - description: A list of NetworkEndpointWithHealthStatus resources. + description: A list of MachineImage resources. type: array items: - $ref: '#/components/schemas/NetworkEndpointWithHealthStatus' + $ref: '#/components/schemas/MachineImage' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -34468,6 +34472,9 @@ components: pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. type: string + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string warning: description: '[Output Only] Informational warning message.' type: object @@ -34532,6 +34539,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -34575,6 +34585,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -34597,6 +34608,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -34633,155 +34645,459 @@ components: [Output Only] A warning data value corresponding to the key. type: string - NetworkEndpointWithHealthStatus: - id: NetworkEndpointWithHealthStatus - type: object - properties: - networkEndpoint: - description: '[Output only] The network endpoint;' - $ref: '#/components/schemas/NetworkEndpoint' - healths: - description: '[Output only] The health status of network endpoint;' - type: array - items: - $ref: '#/components/schemas/HealthStatusForNetworkEndpoint' - HealthStatusForNetworkEndpoint: - id: HealthStatusForNetworkEndpoint + MachineImage: + id: MachineImage + description: >- + Represents a machine image resource. A machine image is a Compute Engine + resource that stores all the configuration, metadata, permissions, and + data from one or more disks required to create a Virtual machine (VM) + instance. For more information, see Machine images. type: object properties: - forwardingRule: + kind: description: >- - URL of the forwarding rule associated with the health state of the - network endpoint. - $ref: '#/components/schemas/ForwardingRuleReference' - backendService: + [Output Only] The resource type, which is always + compute#machineImage for machine image. + default: compute#machineImage + type: string + id: description: >- - URL of the backend service associated with the health state of the - network endpoint. - $ref: '#/components/schemas/BackendServiceReference' - healthCheck: + [Output Only] A unique identifier for this machine image. The server + defines this identifier. + type: string + format: uint64 + creationTimestamp: description: >- - URL of the health check associated with the health state of the - network endpoint. - $ref: '#/components/schemas/HealthCheckReference' - healthCheckService: + [Output Only] The creation timestamp for this machine image in + RFC3339 text format. + type: string + name: description: >- - URL of the health check service associated with the health state of - the network endpoint. - $ref: '#/components/schemas/HealthCheckServiceReference' - healthState: + 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])?' + annotations: + required: + - compute.machineImages.insert + type: string + description: description: >- - Health state of the network endpoint determined based on the health - checks configured. + An optional description of this resource. Provide this property when + you create the resource. type: string - enumDescriptions: - - Endpoint is being drained. - - Endpoint is healthy. - - Endpoint is unhealthy. - - Health status of the endpoint is unknown. - enum: - - DRAINING - - HEALTHY - - UNHEALTHY - - UNKNOWN - ipv6HealthState: + selfLink: description: >- - Health state of the ipv6 network endpoint determined based on the - health checks configured. + [Output Only] The URL for this machine image. The server defines + this URL. + type: string + sourceInstance: + description: >- + The source instance used to create the machine image. 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 + status: + description: >- + [Output Only] The status of the machine image. One of the following + values: INVALID, CREATING, READY, DELETING, and UPLOADING. type: string enumDescriptions: - - Endpoint is being drained. - - Endpoint is healthy. - - Endpoint is unhealthy. - - Health status of the endpoint is unknown. + - '' + - '' + - '' + - '' + - '' enum: - - DRAINING - - HEALTHY - - UNHEALTHY - - UNKNOWN - ForwardingRuleReference: - id: ForwardingRuleReference - type: object - properties: - forwardingRule: + - CREATING + - DELETING + - INVALID + - READY + - UPLOADING + sourceInstanceProperties: + description: >- + [Output Only] DEPRECATED: Please use instance_properties instead for + source instance related properties. New properties will not be added + to this field. + $ref: '#/components/schemas/SourceInstanceProperties' + instanceProperties: + description: '[Output Only] Properties of source instance' + $ref: '#/components/schemas/InstanceProperties' + savedDisks: + description: >- + An array of Machine Image specific properties for disks attached to + the source instance + type: array + items: + $ref: '#/components/schemas/SavedDisk' + storageLocations: + description: >- + The regional or multi-regional Cloud Storage bucket location where + the machine image is stored. + type: array + items: + type: string + machineImageEncryptionKey: + description: >- + Encrypts the machine image using a customer-supplied encryption key. + After you encrypt a machine image using a customer-supplied key, you + must provide the same key if you use the machine image later. For + example, you must provide the encryption key when you create an + instance from the encrypted machine image in a future request. + Customer-supplied encryption keys do not protect access to metadata + of the machine image. If you do not provide an encryption key when + creating the machine image, then the machine image will be encrypted + using an automatically generated key and you do not need to provide + a key to use the machine image later. + $ref: '#/components/schemas/CustomerEncryptionKey' + labels: + description: >- + Labels to apply to this machine image. These can be later modified + by the setLabels method. + type: object + additionalProperties: + type: string + labelFingerprint: + description: >- + A fingerprint for the labels being applied to this machine image, + 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. To see the latest fingerprint, make get() request to + the machine image. type: string - BackendServiceReference: - id: BackendServiceReference - type: object - properties: - backendService: + format: byte + guestFlush: + description: >- + [Input Only] Whether to attempt an application consistent machine + image by informing the OS to prepare for the snapshot process. + type: boolean + sourceDiskEncryptionKeys: + description: >- + [Input Only] The customer-supplied encryption key of the disks + attached to the source instance. Required if the source disk is + protected by a customer-supplied encryption key. + type: array + items: + $ref: '#/components/schemas/SourceDiskEncryptionKey' + totalStorageBytes: + description: '[Output Only] Total size of the storage used by the machine image.' type: string - HealthCheckReference: - id: HealthCheckReference + format: int64 + satisfiesPzs: + description: '[Output Only] Reserved for future use.' + type: boolean + satisfiesPzi: + description: Output only. Reserved for future use. + readOnly: true + type: boolean + SourceInstanceProperties: + id: SourceInstanceProperties 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 + DEPRECATED: Please use compute#instanceProperties instead. New + properties will not be added to this field. type: object properties: - healthCheck: + description: + description: >- + An optional text description for the instances that are created from + this machine image. type: string - HealthCheckServiceReference: - id: 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 - type: object - properties: - healthCheckService: + tags: + description: >- + A list of tags to apply to the instances that are created from this + machine image. 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. + $ref: '#/components/schemas/Tags' + machineType: + description: >- + The machine type to use for instances that are created from this + machine image. type: string - GlobalNetworkEndpointGroupsAttachEndpointsRequest: - id: GlobalNetworkEndpointGroupsAttachEndpointsRequest - type: object - properties: - networkEndpoints: - description: The list of network endpoints to be attached. + canIpForward: + description: >- + Enables instances created based on this machine image 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 + networkInterfaces: + description: An array of network access configurations for this interface. type: array items: - $ref: '#/components/schemas/NetworkEndpoint' - GlobalNetworkEndpointGroupsDetachEndpointsRequest: - id: GlobalNetworkEndpointGroupsDetachEndpointsRequest - type: object - properties: - networkEndpoints: - description: The list of network endpoints to be detached. + $ref: '#/components/schemas/NetworkInterface' + disks: + description: >- + An array of disks that are associated with the instances that are + created from this machine image. type: array items: - $ref: '#/components/schemas/NetworkEndpoint' - RegionNetworkEndpointGroupsAttachEndpointsRequest: - id: RegionNetworkEndpointGroupsAttachEndpointsRequest - type: object - properties: - networkEndpoints: - description: The list of network endpoints to be attached. + $ref: '#/components/schemas/SavedAttachedDisk' + metadata: + description: >- + The metadata key/value pairs to assign to instances that are created + from this machine image. These pairs can consist of custom metadata + or predefined keys. See Project and instance metadata for more + information. + $ref: '#/components/schemas/Metadata' + 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 this machine image. Use metadata queries to obtain the + access tokens for these instances. type: array items: - $ref: '#/components/schemas/NetworkEndpoint' - RegionNetworkEndpointGroupsDetachEndpointsRequest: - id: RegionNetworkEndpointGroupsDetachEndpointsRequest + $ref: '#/components/schemas/ServiceAccount' + scheduling: + description: >- + Specifies the scheduling options for the instances that are created + from this machine image. + $ref: '#/components/schemas/Scheduling' + labels: + description: >- + Labels to apply to instances that are created from this machine + image. + type: object + additionalProperties: + type: string + guestAccelerators: + description: >- + A list of guest accelerator cards' type and count to use for + instances created from this machine image. + type: array + items: + $ref: '#/components/schemas/AcceleratorConfig' + minCpuPlatform: + description: >- + Minimum cpu/platform to be used by instances created from this + machine image. 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 + deletionProtection: + description: >- + Whether the instance created from this machine image should be + protected against deletion. + type: boolean + keyRevocationActionType: + description: >- + KeyRevocationActionType of the instance. Supported options are + "STOP" and "NONE". The default value is "NONE" if it is not + specified. + type: string + enumDescriptions: + - Default value. This value is unused. + - Indicates user chose no operation. + - Indicates user chose to opt for VM shutdown on key revocation. + enum: + - KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED + - NONE + - STOP + SavedAttachedDisk: + id: SavedAttachedDisk + description: >- + DEPRECATED: Please use compute#savedDisk instead. An instance-attached + disk resource. type: object properties: - networkEndpoints: - description: The list of network endpoints to be detached. + kind: + description: >- + [Output Only] Type of the resource. Always compute#attachedDisk for + attached disks. + default: compute#savedAttachedDisk + type: string + type: + description: >- + Specifies the type of the attached disk, either SCRATCH or + PERSISTENT. + type: string + enumDescriptions: + - '' + - '' + enum: + - PERSISTENT + - SCRATCH + mode: + description: >- + The mode in which this disk is attached to the source instance, + either READ_WRITE or READ_ONLY. + type: string + enumDescriptions: + - >- + Attaches this disk in read-only mode. Multiple virtual machines + can use a disk in read-only mode at a time. + - >- + *[Default]* Attaches this disk in read-write mode. Only one + virtual machine at a time can be attached to a disk in read-write + mode. + enum: + - READ_ONLY + - READ_WRITE + source: + description: Specifies a URL of the disk attached to the source instance. + type: string + deviceName: + description: Specifies the name of the disk attached to the source instance. + type: string + index: + description: >- + Specifies zero-based index of the disk that is attached to the + source instance. + type: integer + format: int32 + 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 + 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 + licenses: + description: '[Output Only] Any valid publicly visible licenses.' type: array items: - $ref: '#/components/schemas/NetworkEndpoint' - NetworkList: - id: NetworkList - description: Contains a list of networks. + type: string + interface: + description: >- + Specifies the disk interface to use for attaching this disk, which + is either SCSI or NVME. + type: string + enumDescriptions: + - '' + - '' + enum: + - NVME + - SCSI + 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. + type: array + items: + $ref: '#/components/schemas/GuestOsFeature' + diskEncryptionKey: + description: The encryption key for the disk. + $ref: '#/components/schemas/CustomerEncryptionKey' + diskSizeGb: + description: The size of the disk in base-2 GB. + type: string + format: int64 + storageBytes: + description: >- + [Output Only] A size of the storage used by the disk's snapshot by + this machine image. + type: string + format: int64 + 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. + type: string + enumDescriptions: + - '' + - '' + enum: + - UPDATING + - UP_TO_DATE + diskType: + description: >- + [Output Only] URL of the disk type resource. For example: + projects/project /zones/zone/diskTypes/pd-standard or pd-ssd + type: string + SavedDisk: + id: SavedDisk + description: An instance-attached disk resource. type: object properties: kind: description: >- - [Output Only] Type of resource. Always compute#networkList for lists - of networks. - default: compute#networkList + [Output Only] Type of the resource. Always compute#savedDisk for + attached disks. + default: compute#savedDisk + type: string + sourceDisk: + description: Specifies a URL of the disk attached to the source instance. + type: string + storageBytes: + description: >- + [Output Only] Size of the individual disk snapshot used by this + machine image. + type: string + format: int64 + 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. + type: string + enumDescriptions: + - '' + - '' + enum: + - UPDATING + - UP_TO_DATE + architecture: + description: '[Output Only] The architecture of the attached disk.' + type: string + enumDescriptions: + - Default value indicating Architecture is not set. + - Machines with architecture ARM64 + - Machines with architecture X86_64 + enum: + - ARCHITECTURE_UNSPECIFIED + - ARM64 + - X86_64 + SourceDiskEncryptionKey: + id: SourceDiskEncryptionKey + type: object + properties: + sourceDisk: + description: >- + URL of the disk attached to the source instance. This can be a full + or valid partial URL. 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 + type: string + diskEncryptionKey: + description: >- + The customer-supplied encryption key of the source disk. Required if + the source disk is protected by a customer-supplied encryption key. + $ref: '#/components/schemas/CustomerEncryptionKey' + MachineTypeList: + id: MachineTypeList + description: Contains a list of machine types. + type: object + properties: + kind: + description: >- + [Output Only] Type of resource. Always compute#machineTypeList for + lists of machine types. + default: compute#machineTypeList type: string id: description: >- @@ -34789,10 +35105,10 @@ components: server. type: string items: - description: A list of Network resources. + description: A list of MachineType resources. type: array items: - $ref: '#/components/schemas/Network' + $ref: '#/components/schemas/MachineType' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -34868,6 +35184,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -34911,6 +35230,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -34933,6 +35253,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -34969,19 +35290,19 @@ components: [Output Only] A warning data value corresponding to the key. type: string - Network: - id: Network + MachineType: + id: MachineType 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. + 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. type: object properties: kind: description: >- - [Output Only] Type of the resource. Always compute#network for - networks. - default: compute#network + [Output Only] The type of the resource. Always compute#machineType + for machine types. + default: compute#machineType type: string id: description: >- @@ -34993,375 +35314,115 @@ components: description: '[Output Only] Creation timestamp in RFC3339 text format.' 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. + description: '[Output Only] Name of the resource.' pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' - annotations: - required: - - compute.networks.insert type: string description: - description: >- - An optional description of this resource. Provide this field when - you create the resource. + description: '[Output Only] An optional textual description of the resource.' type: string - IPv4Range: + guestCpus: 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}' - deprecated: true + [Output Only] The number of virtual CPUs that are available to the + instance. + type: integer + format: int32 + memoryMb: + description: >- + [Output Only] The amount of physical memory available to the + instance, defined in MB. + type: integer + format: int32 + imageSpaceGb: + description: >- + [Deprecated] This property is deprecated and will never be populated + with any relevant values. + type: integer + format: int32 + maximumPersistentDisks: + description: '[Output Only] Maximum persistent disks allowed.' + type: integer + format: int32 + maximumPersistentDisksSizeGb: + description: '[Output Only] Maximum total persistent disks size (GB) allowed.' type: string - gatewayIPv4: + format: int64 + deprecated: description: >- - [Output Only] The gateway address for default routing out of the - network, selected by Google Cloud. - pattern: '[0-9]{1,3}(?:\.[0-9]{1,3}){3}' + [Output Only] The deprecation status associated with this machine + type. Only applicable if the machine type is unavailable. + $ref: '#/components/schemas/DeprecationStatus' + zone: + description: >- + [Output Only] The name of the zone where the machine type resides, + such as us-central1-a. type: string 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 - autoCreateSubnetworks: + isSharedCpu: 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. + [Output Only] Whether this machine type has a shared CPU. See + Shared-core machine types for more information. type: boolean - subnetworks: + accelerators: description: >- - [Output Only] Server-defined fully-qualified URLs for all - subnetworks in this VPC network. - type: array - items: - type: string - peerings: - description: '[Output Only] A list of network peerings for the resource.' + [Output Only] A list of accelerator configurations assigned to this + machine type. type: array items: - $ref: '#/components/schemas/NetworkPeering' - routingConfig: - description: >- - The network-level routing configuration for this network. Used by - Cloud Router to determine what type of network-wide routing behavior - to enforce. - $ref: '#/components/schemas/NetworkRoutingConfig' - mtu: - description: >- - Maximum Transmission Unit in bytes. The minimum value for this field - is 1300 and the maximum value is 8896. The suggested value is 1500, - which is the default MTU used on the Internet, or 8896 if you want - to use Jumbo frames. If unspecified, the value defaults to 1460. - type: integer - format: int32 - firewallPolicy: - description: >- - [Output Only] URL of the firewall policy the network is associated - with. - type: string - networkFirewallPolicyEnforcementOrder: - description: >- - The network firewall policy enforcement order. Can be either - AFTER_CLASSIC_FIREWALL or BEFORE_CLASSIC_FIREWALL. Defaults to - AFTER_CLASSIC_FIREWALL if the field is not specified. + type: object + properties: + guestAcceleratorType: + description: >- + The accelerator type resource name, not a full URL, e.g. + nvidia-tesla-t4. + type: string + guestAcceleratorCount: + description: Number of accelerator cards exposed to the guest. + type: integer + format: int32 + architecture: + description: '[Output Only] The architecture of the machine type.' type: string enumDescriptions: - - '' - - '' + - Default value indicating Architecture is not set. + - Machines with architecture ARM64 + - Machines with architecture X86_64 enum: - - AFTER_CLASSIC_FIREWALL - - BEFORE_CLASSIC_FIREWALL - enableUlaInternalIpv6: - description: >- - Enable ULA internal ipv6 on this network. Enabling this feature will - assign a /48 from google defined ULA prefix fd20::/20. . - type: boolean - internalIpv6Range: - description: >- - When enabling ula internal ipv6, caller optionally can specify the - /48 range they want from the google defined ULA prefix fd20::/20. - The input must be a valid /48 ULA IPv6 address and must be within - the fd20::/20. Operation will fail if the speficied /48 is already - in used by another resource. If the field is not speficied, then a - /48 range will be randomly allocated from fd20::/20 and returned via - this field. . - type: string - NetworkPeering: - id: 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. + - ARCHITECTURE_UNSPECIFIED + - ARM64 + - X86_64 + MachineTypeAggregatedList: + id: MachineTypeAggregatedList type: object properties: - name: + kind: 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. + [Output Only] Type of resource. Always + compute#machineTypeAggregatedList for aggregated lists of machine + types. + default: compute#machineTypeAggregatedList type: string - network: + id: 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. + [Output Only] Unique identifier for the resource; defined by the + server. type: string - state: + items: + description: A list of MachineTypesScopedList resources. + type: object + additionalProperties: + description: >- + [Output Only] Name of the scope containing this set of machine + types. + $ref: '#/components/schemas/MachineTypesScopedList' + nextPageToken: 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. - type: string - enumDescriptions: - - Matching configuration exists on the peer. - - >- - There is no matching configuration on the peer, including the case - when peer does not exist. - enum: - - ACTIVE - - INACTIVE - stateDetails: - description: '[Output Only] Details about the current state of the peering.' - type: string - 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 - exportCustomRoutes: - description: >- - Whether to export the custom routes to peer network. The default - value is false. - type: boolean - importCustomRoutes: - description: >- - Whether to import the custom routes from peer network. The default - value is false. - 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 - 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 - 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 - peerMtu: - description: Maximum Transmission Unit in bytes. - type: integer - format: int32 - stackType: - description: >- - Which IP version(s) of traffic and routes are allowed to be imported - or exported between peer networks. The default value is IPV4_ONLY. - type: string - enumDescriptions: - - >- - This Peering will allow IPv4 traffic and routes to be exchanged. - Additionally if the matching peering is IPV4_IPV6, IPv6 traffic - and routes will be exchanged as well. - - >- - This Peering will only allow IPv4 traffic and routes to be - exchanged, even if the matching peering is IPV4_IPV6. - enum: - - IPV4_IPV6 - - IPV4_ONLY - NetworkRoutingConfig: - id: 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. - type: object - 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. - type: string - enumDescriptions: - - '' - - '' - enum: - - GLOBAL - - REGIONAL - NetworksUpdatePeeringRequest: - id: NetworksUpdatePeeringRequest - type: object - properties: - networkPeering: - $ref: '#/components/schemas/NetworkPeering' - NetworksAddPeeringRequest: - id: NetworksAddPeeringRequest - type: object - properties: - name: - description: Name of the peering, which should conform to RFC1035. - annotations: - required: - - compute.networks.addPeering - type: string - 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 - 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 - 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. - $ref: '#/components/schemas/NetworkPeering' - NetworksRemovePeeringRequest: - id: NetworksRemovePeeringRequest - type: object - properties: - name: - description: Name of the peering, which should conform to RFC1035. - type: string - NetworksGetEffectiveFirewallsResponse: - id: NetworksGetEffectiveFirewallsResponse - type: object - properties: - firewalls: - description: Effective firewalls on the network. - type: array - items: - $ref: '#/components/schemas/Firewall' - firewallPolicys: - description: >- - [Output Only] Effective firewalls from firewall policy. It returns - Global Network Firewall Policies and Hierarchical Firewall Policies. - Use regionNetworkFirewallPolicies.getEffectiveFirewalls to get - Regional Network Firewall Policies as well. - type: array - items: - $ref: >- - #/components/schemas/NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy - NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy: - id: NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy - type: object - properties: - name: - description: '[Output Only] The name of the firewall policy.' - type: string - type: - description: '[Output Only] The type of the firewall policy.' - type: string - enumDescriptions: - - '' - - '' - - '' - - '' - enum: - - HIERARCHY - - NETWORK - - SYSTEM - - UNSPECIFIED - shortName: - description: '[Output Only] The short name of the firewall policy.' - type: string - displayName: - description: >- - [Output Only] Deprecated, please use short name instead. The display - name of the firewall policy. - deprecated: true - type: string - rules: - description: '[Output Only] The rules that apply to the network.' - type: array - items: - $ref: '#/components/schemas/FirewallPolicyRule' - priority: - description: >- - [Output only] Priority of firewall policy association. Not - applicable for type=HIERARCHY. - type: integer - format: int32 - ExchangedPeeringRoutesList: - id: ExchangedPeeringRoutesList - type: object - properties: - kind: - description: >- - [Output Only] Type of resource. Always - compute#exchangedPeeringRoutesList for exchanged peering routes - lists. - default: compute#exchangedPeeringRoutesList - type: string - id: - description: >- - [Output Only] Unique identifier for the resource; defined by the - server. - type: string - items: - description: A list of ExchangedPeeringRoute resources. - type: array - items: - $ref: '#/components/schemas/ExchangedPeeringRoute' - nextPageToken: - description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. type: string selfLink: description: '[Output Only] Server-defined URL for this resource.' @@ -35430,6 +35491,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -35473,6 +35537,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -35495,6 +35560,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -35531,75 +35597,24 @@ components: [Output Only] A warning data value corresponding to the key. type: string - ExchangedPeeringRoute: - id: ExchangedPeeringRoute - type: object - properties: - destRange: - description: The destination range of the route. - type: string - type: - description: The type of the peering route. - type: string - enumDescriptions: - - For routes exported from local network. - - The peering route. - - The peering route corresponding to subnetwork range. - enum: - - DYNAMIC_PEERING_ROUTE - - STATIC_PEERING_ROUTE - - SUBNET_PEERING_ROUTE - nextHopRegion: - description: >- - The region of peering route next hop, only applies to dynamic - routes. - type: string - priority: - description: The priority of the peering route. - type: integer - format: uint32 - 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 - NodeGroupList: - id: NodeGroupList - description: Contains a list of nodeGroups. + unreachables: + description: '[Output Only] Unreachable resources.' + type: array + items: + type: string + MachineTypesScopedList: + id: MachineTypesScopedList type: object properties: - kind: - description: >- - [Output Only] Type of resource.Always compute#nodeGroupList for - lists of node groups. - default: compute#nodeGroupList - type: string - id: - description: >- - [Output Only] Unique identifier for the resource; defined by the - server. - type: string - items: - description: A list of NodeGroup resources. + machineTypes: + description: '[Output Only] A list of machine types contained in this scope.' type: array items: - $ref: '#/components/schemas/NodeGroup' - nextPageToken: - description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. - type: string - selfLink: - description: '[Output Only] Server-defined URL for this resource.' - type: string + $ref: '#/components/schemas/MachineType' warning: - description: '[Output Only] Informational warning message.' + description: >- + [Output Only] An informational warning that appears when the machine + types list is empty. type: object properties: code: @@ -35662,6 +35677,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -35705,6 +35723,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -35727,6 +35746,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -35763,199 +35783,13 @@ components: [Output Only] A warning data value corresponding to the key. type: string - NodeGroup: - id: 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. - type: object - properties: - kind: - description: >- - [Output Only] The type of the resource. Always compute#nodeGroup for - node group. - default: compute#nodeGroup - type: string - id: - description: >- - [Output Only] The unique identifier for the resource. This - identifier is defined by the server. - type: string - format: uint64 - creationTimestamp: - description: '[Output Only] Creation timestamp in RFC3339 text format.' - 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 - description: - description: >- - An optional description of this resource. Provide this property when - you create the resource. - type: string - nodeTemplate: - description: URL of the node template to create the node group from. - type: string - zone: - description: >- - [Output Only] The name of the zone where the node group resides, - such as us-central1-a. - type: string - selfLink: - description: '[Output Only] Server-defined URL for the resource.' - type: string - status: - type: string - enumDescriptions: - - '' - - '' - - '' - - '' - enum: - - CREATING - - DELETING - - INVALID - - READY - size: - description: '[Output Only] The total number of nodes in the node group.' - type: integer - format: int32 - autoscalingPolicy: - description: Specifies how autoscaling should behave. - $ref: '#/components/schemas/NodeGroupAutoscalingPolicy' - 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. - type: string - enumDescriptions: - - >- - Allow the node and corresponding instances to retain default - maintenance behavior. - - '' - - >- - When maintenance must be done on a node, the instances on that - node will be moved to other nodes in the group. Instances with - onHostMaintenance = MIGRATE will live migrate to their - destinations while instances with onHostMaintenance = TERMINATE - will terminate and then restart on their destination nodes if - automaticRestart = true. - - >- - Instances in this group will restart on the same node when - maintenance has completed. Instances must have onHostMaintenance = - TERMINATE, and they will only restart if automaticRestart = true. - enum: - - DEFAULT - - MAINTENANCE_POLICY_UNSPECIFIED - - MIGRATE_WITHIN_NODE_GROUP - - RESTART_IN_PLACE - 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 - fingerprint: - type: string - format: byte - maintenanceWindow: - $ref: '#/components/schemas/NodeGroupMaintenanceWindow' - shareSettings: - description: Share-settings for the node group - $ref: '#/components/schemas/ShareSettings' - maintenanceInterval: - description: >- - Specifies the frequency of planned maintenance events. The accepted - values are: `AS_NEEDED` and `RECURRENT`. - type: string - enumDescriptions: - - >- - VMs are eligible to receive infrastructure and hypervisor updates - as they become available. This may result in more maintenance - operations (live migrations or terminations) for the VM than the - PERIODIC and RECURRENT options. - - >- - VMs receive infrastructure and hypervisor updates on a periodic - basis, minimizing the number of maintenance operations (live - migrations or terminations) on an individual VM. This may mean a - VM will take longer to receive an update than if it was configured - for AS_NEEDED. Security updates will still be applied as soon as - they are available. RECURRENT is used for GEN3 and Slice of - Hardware VMs. - enum: - - AS_NEEDED - - RECURRENT - NodeGroupAutoscalingPolicy: - id: NodeGroupAutoscalingPolicy - type: object - properties: - mode: - description: >- - The autoscaling mode. Set to one of: ON, OFF, or ONLY_SCALE_OUT. For - more information, see Autoscaler modes. - type: string - enumDescriptions: - - '' - - Autoscaling is disabled. - - Autocaling is fully enabled. - - Autoscaling will only scale out and will not remove nodes. - enum: - - MODE_UNSPECIFIED - - 'OFF' - - 'ON' - - ONLY_SCALE_OUT - minNodes: - description: The minimum number of nodes that the group should have. - type: integer - format: int32 - maxNodes: - description: >- - The maximum number of nodes that the group should have. Must be set - if autoscaling is enabled. Maximum value allowed is 100. - type: integer - format: int32 - NodeGroupMaintenanceWindow: - id: NodeGroupMaintenanceWindow - description: >- - Time window specified for daily maintenance operations. GCE's internal - maintenance will be performed within this window. - type: object - properties: - 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 - maintenanceDuration: - description: >- - [Output only] A predetermined duration for the window, automatically - chosen to be the smallest possible in the given scenario. - $ref: '#/components/schemas/Duration' - NodeGroupAggregatedList: - id: NodeGroupAggregatedList + NetworkAttachmentAggregatedList: + id: NetworkAttachmentAggregatedList + description: Contains a list of NetworkAttachmentsScopedList. type: object properties: kind: - description: >- - [Output Only] Type of resource.Always - compute#nodeGroupAggregatedList for aggregated lists of node groups. - default: compute#nodeGroupAggregatedList + default: compute#networkAttachmentAggregatedList type: string id: description: >- @@ -35963,13 +35797,11 @@ components: server. type: string items: - description: A list of NodeGroupsScopedList resources. + description: A list of NetworkAttachmentsScopedList resources. type: object additionalProperties: - description: >- - [Output Only] Name of the scope containing this set of node - groups. - $ref: '#/components/schemas/NodeGroupsScopedList' + description: Name of the scope containing this set of NetworkAttachments. + $ref: '#/components/schemas/NetworkAttachmentsScopedList' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -36045,6 +35877,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -36088,6 +35923,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -36110,6 +35946,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -36146,24 +35983,19 @@ components: [Output Only] A warning data value corresponding to the key. type: string - unreachables: - description: '[Output Only] Unreachable resources.' - type: array - items: - type: string - NodeGroupsScopedList: - id: NodeGroupsScopedList + NetworkAttachmentsScopedList: + id: NetworkAttachmentsScopedList type: object properties: - nodeGroups: - description: '[Output Only] A list of node groups contained in this scope.' + networkAttachments: + description: A list of NetworkAttachments contained in this scope. type: array items: - $ref: '#/components/schemas/NodeGroup' + $ref: '#/components/schemas/NetworkAttachment' warning: description: >- - [Output Only] An informational warning that appears when the - nodeGroup list is empty. + Informational warning which replaces the list of network attachments + when the list is empty. type: object properties: code: @@ -36226,6 +36058,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -36269,6 +36104,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -36291,6 +36127,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -36327,33 +36164,174 @@ components: [Output Only] A warning data value corresponding to the key. type: string - NodeGroupsAddNodesRequest: - id: NodeGroupsAddNodesRequest + NetworkAttachment: + id: NetworkAttachment + description: NetworkAttachments A network attachment resource ... type: object properties: - additionalNodeCount: - description: Count of additional nodes to be added to the node group. - type: integer - format: int32 - NodeGroupsDeleteNodesRequest: - id: NodeGroupsDeleteNodesRequest + kind: + description: '[Output Only] Type of the resource.' + default: compute#networkAttachment + type: string + id: + description: >- + [Output Only] The unique identifier for the resource type. The + server generates this identifier. + type: string + format: uint64 + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + 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])?' + annotations: + required: + - compute.networkAttachments.insert + type: string + description: + description: >- + An optional description of this resource. Provide this property when + you create the resource. + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + selfLinkWithId: + description: '[Output Only] Server-defined URL for this resource''s resource id.' + type: string + region: + description: >- + [Output Only] URL of the region where the network 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 + connectionPreference: + type: string + enumDescriptions: + - '' + - '' + - '' + enum: + - ACCEPT_AUTOMATIC + - ACCEPT_MANUAL + - INVALID + connectionEndpoints: + description: >- + [Output Only] An array of connections for all the producers + connected to this network attachment. + type: array + items: + $ref: '#/components/schemas/NetworkAttachmentConnectedEndpoint' + subnetworks: + description: >- + An array of URLs where each entry is the URL of a subnet provided by + the service consumer to use for endpoints in the producers that + connect to this network attachment. + type: array + items: + type: string + producerRejectLists: + description: >- + Projects that are not allowed to connect to this network attachment. + The project can be specified using its id or number. + type: array + items: + type: string + producerAcceptLists: + description: >- + Projects that are allowed to connect to this network attachment. The + project can be specified using its id or number. + type: array + items: + type: string + fingerprint: + description: >- + Fingerprint of this resource. A hash of the contents stored in this + object. This field is used in optimistic locking. An up-to-date + fingerprint must be provided in order to patch. + type: string + format: byte + network: + description: >- + [Output Only] The URL of the network which the Network Attachment + belongs to. Practically it is inferred by fetching the network of + the first subnetwork associated. Because it is required that all the + subnetworks must be from the same network, it is assured that the + Network Attachment belongs to the same network as all the + subnetworks. + type: string + NetworkAttachmentConnectedEndpoint: + id: NetworkAttachmentConnectedEndpoint + description: '[Output Only] A connection connected to this network attachment.' type: object properties: - nodes: - description: Names of the nodes to delete. + status: + description: The status of a connected endpoint to this network attachment. + type: string + enumDescriptions: + - The consumer allows traffic from the producer to reach its VPC. + - The consumer network attachment no longer exists. + - >- + The consumer needs to take further action before traffic can be + served. + - >- + The consumer neither allows nor prohibits traffic from the + producer to reach its VPC. + - The consumer prohibits traffic from the producer to reach its VPC. + - '' + enum: + - ACCEPTED + - CLOSED + - NEEDS_ATTENTION + - PENDING + - REJECTED + - STATUS_UNSPECIFIED + projectIdOrNum: + description: >- + The project id or number of the interface to which the IP was + assigned. + type: string + subnetwork: + description: >- + The subnetwork used to assign the IP to the producer instance + network interface. + type: string + ipAddress: + description: >- + The IPv4 address assigned to the producer instance network + interface. This value will be a range in case of Serverless. + type: string + ipv6Address: + description: >- + The IPv6 address assigned to the producer instance network + interface. This is only assigned when the stack types of both the + instance network interface and the consumer subnet are IPv4_IPv6. + type: string + secondaryIpCidrRanges: + description: Alias IP ranges from the same subnetwork. type: array items: type: string - NodeGroupsListNodes: - id: NodeGroupsListNodes + subnetworkCidrRange: + description: >- + [Output Only] The CIDR range of the subnet from which the IPv4 + internal IP was allocated from. + type: string + NetworkAttachmentList: + id: NetworkAttachmentList type: object properties: kind: - description: >- - [Output Only] The resource type, which is always - compute.nodeGroupsListNodes for the list of nodes in the specified - node group. - default: compute#nodeGroupsListNodes + default: compute#networkAttachmentList type: string id: description: >- @@ -36361,10 +36339,10 @@ components: server. type: string items: - description: A list of Node resources. + description: A list of NetworkAttachment resources. type: array items: - $ref: '#/components/schemas/NodeGroupNode' + $ref: '#/components/schemas/NetworkAttachment' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -36440,6 +36418,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -36483,6 +36464,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -36505,6 +36487,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -36541,187 +36524,82 @@ components: [Output Only] A warning data value corresponding to the key. type: string - NodeGroupNode: - id: NodeGroupNode + NetworkEdgeSecurityService: + id: NetworkEdgeSecurityService + description: Represents a Google Cloud Armor network edge security service resource. type: object properties: - name: - description: The name of the node. - type: string - status: - type: string - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - enum: - - CREATING - - DELETING - - INVALID - - READY - - REPAIRING - nodeType: - description: The type of this node. + kind: + description: >- + [Output only] Type of the resource. Always + compute#networkEdgeSecurityService for NetworkEdgeSecurityServices + default: compute#networkEdgeSecurityService type: string - serverBinding: - description: Binding properties for the physical server. - $ref: '#/components/schemas/ServerBinding' - serverId: - description: Server ID associated with this node. + id: + description: >- + [Output Only] The unique identifier for the resource. This + identifier is defined by the server. type: string - disks: - description: Local disk configurations. - type: array - items: - $ref: '#/components/schemas/LocalDisk' - accelerators: - description: Accelerators for this node. - type: array - items: - $ref: '#/components/schemas/AcceleratorConfig' - instances: - description: Instances scheduled on this node. - type: array - items: - type: string - instanceConsumptionData: - description: Instance data that shows consumed resources on the node. - type: array - items: - $ref: '#/components/schemas/InstanceConsumptionData' - consumedResources: - description: Node resources that are reserved by all instances. - $ref: '#/components/schemas/InstanceConsumptionInfo' - totalResources: - description: Total amount of available resources on the node. - $ref: '#/components/schemas/InstanceConsumptionInfo' - cpuOvercommitType: - description: CPU overcommit. + format: uint64 + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' type: string - enumDescriptions: - - '' - - '' - - '' - enum: - - CPU_OVERCOMMIT_TYPE_UNSPECIFIED - - ENABLED - - NONE - satisfiesPzs: - description: '[Output Only] Reserved for future use.' - type: boolean - upcomingMaintenance: - description: '[Output Only] The information about an upcoming maintenance event.' - $ref: '#/components/schemas/UpcomingMaintenance' - ServerBinding: - id: ServerBinding - type: object - properties: - type: + 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 - enumDescriptions: - - Node may associate with any physical server over its lifetime. - - >- - Node may associate with minimal physical servers over its - lifetime. - - '' - enum: - - RESTART_NODE_ON_ANY_SERVER - - RESTART_NODE_ON_MINIMAL_SERVERS - - SERVER_BINDING_TYPE_UNSPECIFIED - LocalDisk: - id: LocalDisk - type: object - properties: - diskType: + description: 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. + An optional description of this resource. Provide this property when + you create the resource. type: string - diskSizeGb: - description: Specifies the size of the disk in base-2 GB. - type: integer - format: int32 - diskCount: - description: Specifies the number of such disks. - type: integer - format: int32 - InstanceConsumptionData: - id: InstanceConsumptionData - type: object - properties: - instance: - description: Server-defined URL for the instance. + selfLink: + description: '[Output Only] Server-defined URL for the resource.' type: string - consumptionInfo: - description: Resources consumed by the instance. - $ref: '#/components/schemas/InstanceConsumptionInfo' - InstanceConsumptionInfo: - id: InstanceConsumptionInfo - type: object - properties: - minNodeCpus: - description: The minimal guaranteed number of virtual CPUs that are reserved. - type: integer - format: int32 - guestCpus: - description: The number of virtual CPUs that are available to the instance. - type: integer - format: int32 - memoryMb: + selfLinkWithId: description: >- - The amount of physical memory available to the instance, defined in - MiB. - type: integer - format: int32 - localSsdGb: + [Output Only] Server-defined URL for this resource with the resource + id. + type: string + region: description: >- - The amount of local SSD storage available to the instance, defined - in GiB. - type: integer - format: int32 - NodeGroupsSetNodeTemplateRequest: - id: NodeGroupsSetNodeTemplateRequest - type: object - properties: - nodeTemplate: + [Output Only] URL of the region where the resource 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 + fingerprint: description: >- - Full or partial URL of the node template resource to be updated for - this node group. + 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 NetworkEdgeSecurityService. An up-to-date + fingerprint must be provided in order to update the + NetworkEdgeSecurityService, otherwise the request will fail with + error 412 conditionNotMet. To see the latest fingerprint, make a + get() request to retrieve a NetworkEdgeSecurityService. type: string - NodeGroupsSimulateMaintenanceEventRequest: - id: NodeGroupsSimulateMaintenanceEventRequest - type: object - properties: - nodes: - description: Names of the nodes to go under maintenance simulation. - type: array - items: - type: string - NodeGroupsPerformMaintenanceRequest: - id: NodeGroupsPerformMaintenanceRequest - type: object - properties: - nodes: - description: '[Required] List of nodes affected by the call.' - type: array - items: - type: string - startTime: - description: The start time of the schedule. The timestamp is an RFC3339 string. + format: byte + securityPolicy: + description: >- + The resource URL for the network edge security service associated + with this network edge security service. type: string - NodeTemplateList: - id: NodeTemplateList - description: Contains a list of node templates. + NetworkEdgeSecurityServiceAggregatedList: + id: NetworkEdgeSecurityServiceAggregatedList type: object properties: kind: description: >- - [Output Only] Type of resource.Always compute#nodeTemplateList for - lists of node templates. - default: compute#nodeTemplateList + [Output Only] Type of resource. Always + compute#networkEdgeSecurityServiceAggregatedList for lists of + Network Edge Security Services. + default: compute#networkEdgeSecurityServiceAggregatedList type: string id: description: >- @@ -36729,10 +36607,11 @@ components: server. type: string items: - description: A list of NodeTemplate resources. - type: array - items: - $ref: '#/components/schemas/NodeTemplate' + description: A list of NetworkEdgeSecurityServicesScopedList resources. + type: object + additionalProperties: + description: Name of the scope containing this set of security policies. + $ref: '#/components/schemas/NetworkEdgeSecurityServicesScopedList' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -36808,6 +36687,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -36851,6 +36733,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -36873,6 +36756,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -36909,160 +36793,26 @@ components: [Output Only] A warning data value corresponding to the key. type: string - NodeTemplate: - id: 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. + etag: + type: string + unreachables: + description: '[Output Only] Unreachable resources.' + type: array + items: + type: string + NetworkEdgeSecurityServicesScopedList: + id: NetworkEdgeSecurityServicesScopedList type: object properties: - kind: - description: >- - [Output Only] The type of the resource. Always compute#nodeTemplate - for node templates. - default: compute#nodeTemplate - type: string - id: - description: >- - [Output Only] The unique identifier for the resource. This - identifier is defined by the server. - type: string - format: uint64 - creationTimestamp: - description: '[Output Only] Creation timestamp in RFC3339 text format.' - 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 - description: - description: >- - An optional description of this resource. Provide this property when - you create the resource. - type: string - nodeType: - description: >- - The node type to use for nodes group that are created from this - template. - type: string - nodeAffinityLabels: + networkEdgeSecurityServices: + description: A list of NetworkEdgeSecurityServices contained in this scope. + type: array + items: + $ref: '#/components/schemas/NetworkEdgeSecurityService' + warning: description: >- - Labels to use for node affinity, which will be used in instance - scheduling. - type: object - additionalProperties: - type: string - status: - description: >- - [Output Only] The status of the node template. One of the following - values: CREATING, READY, and DELETING. - type: string - enumDescriptions: - - Resources are being allocated. - - The node template is currently being deleted. - - Invalid status. - - The node template is ready. - enum: - - CREATING - - DELETING - - INVALID - - READY - statusMessage: - description: '[Output Only] An optional, human-readable explanation of the status.' - type: string - 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 - nodeTypeFlexibility: - description: Do not use. Instead, use the node_type property. - $ref: '#/components/schemas/NodeTemplateNodeTypeFlexibility' - 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. - $ref: '#/components/schemas/ServerBinding' - disks: - type: array - items: - $ref: '#/components/schemas/LocalDisk' - accelerators: - type: array - items: - $ref: '#/components/schemas/AcceleratorConfig' - cpuOvercommitType: - description: CPU overcommit. - type: string - enumDescriptions: - - '' - - '' - - '' - enum: - - CPU_OVERCOMMIT_TYPE_UNSPECIFIED - - ENABLED - - NONE - NodeTemplateNodeTypeFlexibility: - id: NodeTemplateNodeTypeFlexibility - type: object - properties: - cpus: - type: string - memory: - type: string - localSsd: - type: string - NodeTemplateAggregatedList: - id: NodeTemplateAggregatedList - type: object - properties: - kind: - description: >- - [Output Only] Type of resource.Always - compute#nodeTemplateAggregatedList for aggregated lists of node - templates. - default: compute#nodeTemplateAggregatedList - type: string - id: - description: >- - [Output Only] Unique identifier for the resource; defined by the - server. - type: string - items: - description: A list of NodeTemplatesScopedList resources. - type: object - additionalProperties: - description: >- - [Output Only] Name of the scope containing this set of node - templates. - $ref: '#/components/schemas/NodeTemplatesScopedList' - nextPageToken: - description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. - type: string - selfLink: - description: '[Output Only] Server-defined URL for this resource.' - type: string - warning: - description: '[Output Only] Informational warning message.' + Informational warning which replaces the list of security policies + when the list is empty. type: object properties: code: @@ -37125,6 +36875,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -37168,6 +36921,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -37190,6 +36944,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -37226,24 +36981,39 @@ components: [Output Only] A warning data value corresponding to the key. type: string - unreachables: - description: '[Output Only] Unreachable resources.' - type: array - items: - type: string - NodeTemplatesScopedList: - id: NodeTemplatesScopedList + NetworkEndpointGroupList: + id: NetworkEndpointGroupList type: object properties: - nodeTemplates: - description: '[Output Only] A list of node templates contained in this scope.' + kind: + description: >- + [Output Only] The resource type, which is always + compute#networkEndpointGroupList for network endpoint group lists. + default: compute#networkEndpointGroupList + type: string + id: + description: >- + [Output Only] Unique identifier for the resource; defined by the + server. + type: string + items: + description: A list of NetworkEndpointGroup resources. type: array items: - $ref: '#/components/schemas/NodeTemplate' - warning: + $ref: '#/components/schemas/NetworkEndpointGroup' + nextPageToken: description: >- - [Output Only] An informational warning that appears when the node - templates list is empty. + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. + type: string + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string + warning: + description: '[Output Only] Informational warning message.' type: object properties: code: @@ -37306,6 +37076,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -37349,6 +37122,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -37371,6 +37145,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -37407,16 +37182,307 @@ components: [Output Only] A warning data value corresponding to the key. type: string - NodeTypeList: - id: NodeTypeList - description: Contains a list of node types. + NetworkEndpointGroup: + id: 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 for different use cases, see Network endpoint groups overview. type: object properties: kind: description: >- - [Output Only] Type of resource.Always compute#nodeTypeList for lists - of node types. - default: compute#nodeTypeList + [Output Only] Type of the resource. Always + compute#networkEndpointGroup for network endpoint group. + default: compute#networkEndpointGroup + type: string + id: + description: >- + [Output Only] The unique identifier for the resource. This + identifier is defined by the server. + type: string + format: uint64 + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + selfLink: + description: '[Output Only] Server-defined URL for 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. + type: string + description: + description: >- + An optional description of this resource. Provide this property when + you create the resource. + type: string + networkEndpointType: + description: >- + Type of network endpoints in this network endpoint group. Can be one + of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, + INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, + PRIVATE_SERVICE_CONNECT, GCE_VM_IP_PORTMAP. + type: string + enumDescriptions: + - The network endpoint is represented by an IP address. + - The network endpoint is represented by IP address and port pair. + - >- + The network endpoint is represented by an IP, Port and Client + Destination Port. + - >- + The network endpoint is represented by fully qualified domain name + and port. + - >- + The network endpoint is represented by an internet IP address and + port. + - >- + The network endpoint is represented by an IP address and port. The + endpoint belongs to a VM or pod running in a customer's + on-premises. + - >- + The network endpoint is either public Google APIs or services + exposed by other GCP Project with a Service Attachment. The + connection is set up by private service connect + - >- + The network endpoint is handled by specified serverless + infrastructure. + enum: + - GCE_VM_IP + - GCE_VM_IP_PORT + - GCE_VM_IP_PORTMAP + - INTERNET_FQDN_PORT + - INTERNET_IP_PORT + - NON_GCP_PRIVATE_IP_PORT + - PRIVATE_SERVICE_CONNECT + - SERVERLESS + size: + description: >- + [Output only] Number of network endpoints in the network endpoint + group. + type: integer + format: int32 + region: + description: >- + [Output Only] The URL of the region where the network endpoint group + is located. + type: string + zone: + description: >- + [Output Only] The URL of the zone where the network endpoint group + is located. + 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 + subnetwork: + description: >- + Optional URL of the subnetwork to which all network endpoints in the + NEG belong. + type: string + defaultPort: + description: >- + The default port used if the port number is not specified in the + network endpoint. Optional. If the network endpoint type is either + GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must + not be specified. + type: integer + format: int32 + annotations: + description: >- + Optional. Metadata defined as annotations on the network endpoint + group. + type: object + additionalProperties: + type: string + cloudRun: + description: >- + Optional. Only valid when networkEndpointType is SERVERLESS. Only + one of cloudRun, appEngine or cloudFunction may be set. + $ref: '#/components/schemas/NetworkEndpointGroupCloudRun' + appEngine: + description: >- + Optional. Only valid when networkEndpointType is SERVERLESS. Only + one of cloudRun, appEngine or cloudFunction may be set. + $ref: '#/components/schemas/NetworkEndpointGroupAppEngine' + cloudFunction: + description: >- + Optional. Only valid when networkEndpointType is SERVERLESS. Only + one of cloudRun, appEngine or cloudFunction may be set. + $ref: '#/components/schemas/NetworkEndpointGroupCloudFunction' + pscTargetService: + description: >- + The target service url used to set up private service connection to + a Google API or a PSC Producer Service Attachment. An example value + is: asia-northeast3-cloudkms.googleapis.com. Optional. Only valid + when networkEndpointType is PRIVATE_SERVICE_CONNECT. + type: string + pscData: + description: >- + Optional. Only valid when networkEndpointType is + PRIVATE_SERVICE_CONNECT. + $ref: '#/components/schemas/NetworkEndpointGroupPscData' + NetworkEndpointGroupCloudRun: + id: 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. + type: object + 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: >- + An URL mask is one of the main components of the Cloud Function. A + template to parse and 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 + NetworkEndpointGroupAppEngine: + id: 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. + type: object + 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 + version: + description: >- + Optional serving version. The version name is case-sensitive and + must be 1-100 characters long. Example value: v1, v2. + type: string + urlMask: + description: >- + An URL mask is one of the main components of the Cloud Function. 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 + NetworkEndpointGroupCloudFunction: + id: 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. + type: object + 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: >- + An URL mask is one of the main components of the Cloud Function. 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 + NetworkEndpointGroupPscData: + id: NetworkEndpointGroupPscData + description: >- + All data that is specifically relevant to only network endpoint groups + of type PRIVATE_SERVICE_CONNECT. + type: object + properties: + consumerPscAddress: + description: >- + [Output Only] Address allocated from given subnetwork for PSC. This + IP address acts as a VIP for a PSC NEG, allowing it to act as an + endpoint in L7 PSC-XLB. + type: string + pscConnectionId: + description: >- + [Output Only] The PSC connection id of the PSC Network Endpoint + Group Consumer. + type: string + format: uint64 + pscConnectionStatus: + description: '[Output Only] The connection status of the PSC Forwarding Rule.' + type: string + enumDescriptions: + - The connection has been accepted by the producer. + - >- + The connection has been closed by the producer and will not serve + traffic going forward. + - >- + The connection has been accepted by the producer, but the producer + needs to take further action before the forwarding rule can serve + traffic. + - The connection is pending acceptance by the producer. + - The connection has been rejected by the producer. + - '' + enum: + - ACCEPTED + - CLOSED + - NEEDS_ATTENTION + - PENDING + - REJECTED + - STATUS_UNSPECIFIED + producerPort: + description: >- + The psc producer port is used to connect PSC NEG with specific port + on the PSC Producer side; should only be used for the + PRIVATE_SERVICE_CONNECT NEG type + type: integer + format: int32 + NetworkEndpointGroupAggregatedList: + id: NetworkEndpointGroupAggregatedList + type: object + properties: + kind: + description: >- + [Output Only] The resource type, which is always + compute#networkEndpointGroupAggregatedList for aggregated lists of + network endpoint groups. + default: compute#networkEndpointGroupAggregatedList type: string id: description: >- @@ -37424,10 +37490,13 @@ components: server. type: string items: - description: A list of NodeType resources. - type: array - items: - $ref: '#/components/schemas/NodeType' + description: A list of NetworkEndpointGroupsScopedList resources. + type: object + additionalProperties: + description: >- + The name of the scope that contains this set of network endpoint + groups. + $ref: '#/components/schemas/NetworkEndpointGroupsScopedList' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -37503,6 +37572,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -37546,6 +37618,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -37568,6 +37641,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -37604,102 +37678,26 @@ components: [Output Only] A warning data value corresponding to the key. type: string - NodeType: - id: 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. + unreachables: + description: '[Output Only] Unreachable resources.' + type: array + items: + type: string + NetworkEndpointGroupsScopedList: + id: NetworkEndpointGroupsScopedList type: object properties: - kind: - description: >- - [Output Only] The type of the resource. Always compute#nodeType for - node types. - default: compute#nodeType - type: string - id: - description: >- - [Output Only] The unique identifier for the resource. This - identifier is defined by the server. - type: string - format: uint64 - creationTimestamp: - description: '[Output Only] Creation timestamp in RFC3339 text format.' - type: string - name: - description: '[Output Only] Name of the resource.' - pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' - type: string - description: - description: '[Output Only] An optional textual description of the resource.' - type: string - cpuPlatform: - description: '[Output Only] The CPU platform used by this node type.' - type: string - guestCpus: - description: >- - [Output Only] The number of virtual CPUs that are available to the - node type. - type: integer - format: int32 - memoryMb: + networkEndpointGroups: description: >- - [Output Only] The amount of physical memory available to the node - type, defined in MB. - type: integer - format: int32 - localSsdGb: - description: '[Output Only] Local SSD available to the node type, defined in GB.' - type: integer - format: int32 - deprecated: - description: '[Output Only] The deprecation status associated with this node type.' - $ref: '#/components/schemas/DeprecationStatus' - zone: + [Output Only] The list of network endpoint groups that are contained + in this scope. + type: array + items: + $ref: '#/components/schemas/NetworkEndpointGroup' + warning: description: >- - [Output Only] The name of the zone where the node type resides, such - as us-central1-a. - type: string - selfLink: - description: '[Output Only] Server-defined URL for the resource.' - type: string - NodeTypeAggregatedList: - id: NodeTypeAggregatedList - type: object - properties: - kind: - description: >- - [Output Only] Type of resource.Always compute#nodeTypeAggregatedList - for aggregated lists of node types. - default: compute#nodeTypeAggregatedList - type: string - id: - description: >- - [Output Only] Unique identifier for the resource; defined by the - server. - type: string - items: - description: A list of NodeTypesScopedList resources. - type: object - additionalProperties: - description: '[Output Only] Name of the scope containing this set of node types.' - $ref: '#/components/schemas/NodeTypesScopedList' - nextPageToken: - description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. - type: string - selfLink: - description: '[Output Only] Server-defined URL for this resource.' - type: string - warning: - description: '[Output Only] Informational warning message.' + [Output Only] An informational warning that replaces the list of + network endpoint groups when the list is empty. type: object properties: code: @@ -37762,6 +37760,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -37805,6 +37806,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -37827,6 +37829,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -37863,24 +37866,133 @@ components: [Output Only] A warning data value corresponding to the key. type: string - unreachables: - description: '[Output Only] Unreachable resources.' + NetworkEndpointGroupsAttachEndpointsRequest: + id: NetworkEndpointGroupsAttachEndpointsRequest + type: object + properties: + networkEndpoints: + description: The list of network endpoints to be attached. type: array items: + $ref: '#/components/schemas/NetworkEndpoint' + NetworkEndpoint: + id: NetworkEndpoint + description: The network endpoint. + type: object + properties: + 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. This field is + redundant and need not be set for network endpoints of type + GCE_VM_IP. If set, it must be set to the primary internal IP address + of the attached VM instance that matches the subnetwork of the NEG. + The primary internal IP address from any NIC of a multi-NIC VM + instance can be added to a NEG as long as it matches the NEG + subnetwork. + type: string + ipv6Address: + description: Optional IPv6 address of network endpoint. + type: string + 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 + port: + description: >- + Optional port number of network endpoint. If not specified, the + defaultPort for the network endpoint group will be used. This field + can not be set for network endpoints of type GCE_VM_IP. + type: integer + format: int32 + clientDestinationPort: + description: >- + Represents the port number to which PSC consumer sends packets. + Optional. Only valid for network endpoint groups created with + GCE_VM_IP_PORTMAP endpoint type. + type: integer + format: int32 + instance: + description: >- + The name or a URL of VM instance of this network endpoint. Optional, + the field presence depends on the network endpoint type. The field + is required for network endpoints of type GCE_VM_IP and + GCE_VM_IP_PORT. The instance must be in the same zone of network + endpoint group (for zonal NEGs) or in the zone within the region of + the NEG (for regional NEGs). If the ipAddress is specified, it must + belongs to the VM instance. The name must be 1-63 characters long, + and comply with RFC1035 or be a valid URL pointing to an existing + instance. + type: string + annotations: + description: Optional metadata defined as annotations on the network endpoint. + type: object + additionalProperties: type: string - NodeTypesScopedList: - id: NodeTypesScopedList + NetworkEndpointGroupsDetachEndpointsRequest: + id: NetworkEndpointGroupsDetachEndpointsRequest type: object properties: - nodeTypes: - description: '[Output Only] A list of node types contained in this scope.' + networkEndpoints: + description: The list of network endpoints to be detached. type: array items: - $ref: '#/components/schemas/NodeType' - warning: + $ref: '#/components/schemas/NetworkEndpoint' + NetworkEndpointGroupsListEndpointsRequest: + id: NetworkEndpointGroupsListEndpointsRequest + type: object + properties: + healthStatus: description: >- - [Output Only] An informational warning that appears when the node - types list is empty. + 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. + type: string + enumDescriptions: + - >- + Show the health status for each network endpoint. Impacts latency + of the call. + - Health status for network endpoints will not be provided. + enum: + - SHOW + - SKIP + NetworkEndpointGroupsListNetworkEndpoints: + id: NetworkEndpointGroupsListNetworkEndpoints + type: object + properties: + kind: + description: >- + [Output Only] The resource type, which is always + compute#networkEndpointGroupsListNetworkEndpoints for the list of + network endpoints in the specified network endpoint group. + default: compute#networkEndpointGroupsListNetworkEndpoints + type: string + id: + description: >- + [Output Only] Unique identifier for the resource; defined by the + server. + type: string + items: + description: A list of NetworkEndpointWithHealthStatus resources. + type: array + items: + $ref: '#/components/schemas/NetworkEndpointWithHealthStatus' + nextPageToken: + description: >- + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the 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.' type: object properties: code: @@ -37943,6 +38055,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -37986,6 +38101,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -38008,6 +38124,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -38044,15 +38161,158 @@ components: [Output Only] A warning data value corresponding to the key. type: string - NotificationEndpointList: - id: NotificationEndpointList + NetworkEndpointWithHealthStatus: + id: NetworkEndpointWithHealthStatus + type: object + properties: + networkEndpoint: + description: '[Output only] The network endpoint.' + $ref: '#/components/schemas/NetworkEndpoint' + healths: + description: >- + [Output only] The health status of network endpoint. Optional. + Displayed only if the network endpoint has centralized health + checking configured. + type: array + items: + $ref: '#/components/schemas/HealthStatusForNetworkEndpoint' + HealthStatusForNetworkEndpoint: + id: HealthStatusForNetworkEndpoint + type: object + properties: + forwardingRule: + description: >- + URL of the forwarding rule associated with the health state of the + network endpoint. + $ref: '#/components/schemas/ForwardingRuleReference' + backendService: + description: >- + URL of the backend service associated with the health state of the + network endpoint. + $ref: '#/components/schemas/BackendServiceReference' + healthCheck: + description: >- + URL of the health check associated with the health state of the + network endpoint. + $ref: '#/components/schemas/HealthCheckReference' + healthCheckService: + description: >- + URL of the health check service associated with the health state of + the network endpoint. + $ref: '#/components/schemas/HealthCheckServiceReference' + healthState: + description: >- + Health state of the network endpoint determined based on the health + checks configured. + type: string + enumDescriptions: + - Endpoint is being drained. + - Endpoint is healthy. + - Endpoint is unhealthy. + - Health status of the endpoint is unknown. + enum: + - DRAINING + - HEALTHY + - UNHEALTHY + - UNKNOWN + ipv6HealthState: + description: >- + Health state of the ipv6 network endpoint determined based on the + health checks configured. + type: string + enumDescriptions: + - Endpoint is being drained. + - Endpoint is healthy. + - Endpoint is unhealthy. + - Health status of the endpoint is unknown. + enum: + - DRAINING + - HEALTHY + - UNHEALTHY + - UNKNOWN + ForwardingRuleReference: + id: ForwardingRuleReference + type: object + properties: + forwardingRule: + type: string + BackendServiceReference: + id: BackendServiceReference + type: object + properties: + backendService: + type: string + HealthCheckReference: + id: 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 + type: object + properties: + healthCheck: + type: string + HealthCheckServiceReference: + id: 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 + type: object + properties: + healthCheckService: + type: string + GlobalNetworkEndpointGroupsAttachEndpointsRequest: + id: GlobalNetworkEndpointGroupsAttachEndpointsRequest + type: object + properties: + networkEndpoints: + description: The list of network endpoints to be attached. + type: array + items: + $ref: '#/components/schemas/NetworkEndpoint' + GlobalNetworkEndpointGroupsDetachEndpointsRequest: + id: GlobalNetworkEndpointGroupsDetachEndpointsRequest + type: object + properties: + networkEndpoints: + description: The list of network endpoints to be detached. + type: array + items: + $ref: '#/components/schemas/NetworkEndpoint' + RegionNetworkEndpointGroupsAttachEndpointsRequest: + id: RegionNetworkEndpointGroupsAttachEndpointsRequest + type: object + properties: + networkEndpoints: + description: The list of network endpoints to be attached. + type: array + items: + $ref: '#/components/schemas/NetworkEndpoint' + RegionNetworkEndpointGroupsDetachEndpointsRequest: + id: RegionNetworkEndpointGroupsDetachEndpointsRequest + type: object + properties: + networkEndpoints: + description: The list of network endpoints to be detached. + type: array + items: + $ref: '#/components/schemas/NetworkEndpoint' + NetworkList: + id: NetworkList + description: Contains a list of networks. type: object properties: kind: description: >- - [Output Only] Type of the resource. Always - compute#notificationEndpoint for notification endpoints. - default: compute#notificationEndpointList + [Output Only] Type of resource. Always compute#networkList for lists + of networks. + default: compute#networkList type: string id: description: >- @@ -38060,10 +38320,10 @@ components: server. type: string items: - description: A list of NotificationEndpoint resources. + description: A list of Network resources. type: array items: - $ref: '#/components/schemas/NotificationEndpoint' + $ref: '#/components/schemas/Network' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -38139,6 +38399,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -38182,6 +38445,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -38204,6 +38468,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -38240,25 +38505,24 @@ components: [Output Only] A warning data value corresponding to the key. type: string - NotificationEndpoint: - id: NotificationEndpoint + Network: + id: Network 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. + Represents a VPC Network resource. Networks connect resources to each + other and to the internet. For more information, read Virtual Private + Cloud (VPC) Network. type: object properties: kind: description: >- - [Output Only] Type of the resource. Always - compute#notificationEndpoint for notification endpoints. - default: compute#notificationEndpoint + [Output Only] Type of the resource. Always compute#network for + networks. + default: compute#network type: string id: description: >- - [Output Only] A unique identifier for this resource type. The server - generates this identifier. + [Output Only] The unique identifier for the resource. This + identifier is defined by the server. type: string format: uint64 creationTimestamp: @@ -38269,301 +38533,593 @@ components: 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. + 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])?' + annotations: + required: + - compute.networks.insert type: string description: description: >- - An optional description of this resource. Provide this property when + An optional description of this resource. Provide this field when you create the resource. type: string + 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}' + deprecated: true + type: string + gatewayIPv4: + description: >- + [Output Only] The gateway address for default routing out of the + network, selected by Google Cloud. + pattern: '[0-9]{1,3}(?:\.[0-9]{1,3}){3}' + type: string selfLink: description: '[Output Only] Server-defined URL for the resource.' type: string - region: + selfLinkWithId: 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. + [Output Only] Server-defined URL for this resource with the resource + id. type: string - grpcSettings: + autoCreateSubnetworks: description: >- - Settings of the gRPC notification endpoint including the endpoint - URL and the retry duration. - $ref: '#/components/schemas/NotificationEndpointGrpcSettings' - NotificationEndpointGrpcSettings: - id: NotificationEndpointGrpcSettings - description: >- - Represents a gRPC setting that describes one gRPC notification endpoint - and the retry duration attempting to send notification to this endpoint. - type: object - properties: - endpoint: + 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 + subnetworks: description: >- - Endpoint to which gRPC notifications are sent. This must be a valid - gRPCLB DNS name. - type: string - retryDurationSec: + [Output Only] Server-defined fully-qualified URLs for all + subnetworks in this VPC network. + type: array + items: + type: string + peerings: + description: '[Output Only] A list of network peerings for the resource.' + type: array + items: + $ref: '#/components/schemas/NetworkPeering' + routingConfig: 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. + The network-level routing configuration for this network. Used by + Cloud Router to determine what type of network-wide routing behavior + to enforce. + $ref: '#/components/schemas/NetworkRoutingConfig' + mtu: + description: >- + Maximum Transmission Unit in bytes. The minimum value for this field + is 1300 and the maximum value is 8896. The suggested value is 1500, + which is the default MTU used on the Internet, or 8896 if you want + to use Jumbo frames. If unspecified, the value defaults to 1460. type: integer - format: uint32 - payloadName: + format: int32 + firewallPolicy: description: >- - Optional. If specified, this field is used to populate the "name" - field in gRPC requests. + [Output Only] URL of the firewall policy the network is associated + with. type: string - authority: + networkFirewallPolicyEnforcementOrder: 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 + The network firewall policy enforcement order. Can be either + AFTER_CLASSIC_FIREWALL or BEFORE_CLASSIC_FIREWALL. Defaults to + AFTER_CLASSIC_FIREWALL if the field is not specified. type: string - resendInterval: + enumDescriptions: + - '' + - '' + enum: + - AFTER_CLASSIC_FIREWALL + - BEFORE_CLASSIC_FIREWALL + enableUlaInternalIpv6: 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. Can only be set for regional - notification endpoints. - $ref: '#/components/schemas/Duration' - PacketMirroring: - id: PacketMirroring + Enable ULA internal ipv6 on this network. Enabling this feature will + assign a /48 from google defined ULA prefix fd20::/20. . + type: boolean + internalIpv6Range: + description: >- + When enabling ula internal ipv6, caller optionally can specify the + /48 range they want from the google defined ULA prefix fd20::/20. + The input must be a valid /48 ULA IPv6 address and must be within + the fd20::/20. Operation will fail if the speficied /48 is already + in used by another resource. If the field is not speficied, then a + /48 range will be randomly allocated from fd20::/20 and returned via + this field. . + type: string + networkProfile: + description: >- + A full or partial URL of the network profile to apply to this + network. This field can be set only at resource creation time. For + example, the following are valid URLs: - + https://www.googleapis.com/compute/{api_version}/projects/{project_id}/global/networkProfiles/{network_profile_name} + - + projects/{project_id}/global/networkProfiles/{network_profile_name} + type: string + params: + description: >- + Input only. [Input Only] Additional params passed with the request, + but not persisted as part of resource payload. + $ref: '#/components/schemas/NetworkParams' + NetworkPeering: + id: NetworkPeering 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. + 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. type: object properties: - kind: + name: description: >- - [Output Only] Type of the resource. Always compute#packetMirroring - for packet mirrorings. - default: compute#packetMirroring + 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 - id: + network: description: >- - [Output Only] The unique identifier for the resource. This - identifier is defined by the server. - type: string - format: uint64 - creationTimestamp: - description: '[Output Only] Creation timestamp in RFC3339 text format.' + 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 - selfLink: - description: '[Output Only] Server-defined URL for 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])?' - annotations: - required: - - compute.packetMirrorings.insert - type: string - description: + state: description: >- - An optional description of this resource. Provide this property when - you create the resource. + [Output Only] State for the peering, either `ACTIVE` or `INACTIVE`. + The peering is `ACTIVE` when there's a matching configuration in the + peer network. type: string - region: - description: '[Output Only] URI of the region where the packetMirroring resides.' + enumDescriptions: + - Matching configuration exists on the peer. + - >- + There is no matching configuration on the peer, including the case + when peer does not exist. + enum: + - ACTIVE + - INACTIVE + stateDetails: + description: '[Output Only] Details about the current state of the peering.' type: string - network: + autoCreateRoutes: 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. - annotations: - required: - - compute.packetMirrorings.insert - $ref: '#/components/schemas/PacketMirroringNetworkInfo' - priority: + 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 + exportCustomRoutes: 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. - type: integer - format: uint32 - collectorIlb: + Whether to export the custom routes to peer network. The default + value is false. + type: boolean + importCustomRoutes: 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. - $ref: '#/components/schemas/PacketMirroringForwardingRuleInfo' - mirroredResources: + Whether to import the custom routes from peer network. The default + value is false. + type: boolean + exchangeSubnetRoutes: 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. - $ref: '#/components/schemas/PacketMirroringMirroredResourceInfo' - filter: + 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 + exportSubnetRoutesWithPublicIp: description: >- - Filter for mirrored traffic. If unspecified, all IPv4 traffic is - mirrored. - $ref: '#/components/schemas/PacketMirroringFilter' - enable: + 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 + importSubnetRoutesWithPublicIp: 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. + 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 + peerMtu: + description: >- + [Output Only] Maximum Transmission Unit in bytes of the peer + network. + type: integer + format: int32 + stackType: + description: >- + Which IP version(s) of traffic and routes are allowed to be imported + or exported between peer networks. The default value is IPV4_ONLY. type: string enumDescriptions: - - '' - - '' + - >- + This Peering will allow IPv4 traffic and routes to be exchanged. + Additionally if the matching peering is IPV4_IPV6, IPv6 traffic + and routes will be exchanged as well. + - >- + This Peering will only allow IPv4 traffic and routes to be + exchanged, even if the matching peering is IPV4_IPV6. enum: - - 'FALSE' - - 'TRUE' - PacketMirroringNetworkInfo: - id: PacketMirroringNetworkInfo + - IPV4_IPV6 + - IPV4_ONLY + updateStrategy: + description: >- + The update strategy determines the semantics for updates and deletes + to the peering connection configuration. + type: string + enumDescriptions: + - >- + Updates are reflected in the local peering but aren't applied to + the peering connection until a complementary change is made to the + matching peering. To delete a peering with the consensus update + strategy, both the peerings must request the deletion of the + peering before the peering can be deleted. + - >- + In this mode, changes to the peering configuration can be + unilaterally altered by changing either side of the peering. This + is the default value if the field is unspecified. + - >- + Peerings with update strategy UNSPECIFIED are created with update + strategy INDEPENDENT. + enum: + - CONSENSUS + - INDEPENDENT + - UNSPECIFIED + connectionStatus: + description: >- + [Output Only] The effective state of the peering connection as a + whole. + $ref: '#/components/schemas/NetworkPeeringConnectionStatus' + NetworkPeeringConnectionStatus: + id: NetworkPeeringConnectionStatus + description: >- + [Output Only] Describes the state of a peering connection, not just the + local peering. This field provides information about the effective + settings for the connection as a whole, including pending delete/update + requests for CONSENSUS peerings. type: object properties: - url: - description: URL of the network resource. - type: string - canonicalUrl: + updateStrategy: description: >- - [Output Only] Unique identifier for the network; defined by the - server. + The update strategy determines the update/delete semantics for this + peering connection. type: string - PacketMirroringForwardingRuleInfo: - id: PacketMirroringForwardingRuleInfo + enumDescriptions: + - >- + Updates are reflected in the local peering but aren't applied to + the peering connection until a complementary change is made to the + matching peering. To delete a peering with the consensus update + strategy, both the peerings must request the deletion of the + peering before the peering can be deleted. + - >- + In this mode, changes to the peering configuration can be + unilaterally altered by changing either side of the peering. This + is the default value if the field is unspecified. + - >- + Peerings with update strategy UNSPECIFIED are created with update + strategy INDEPENDENT. + enum: + - CONSENSUS + - INDEPENDENT + - UNSPECIFIED + trafficConfiguration: + description: >- + The active connectivity settings for the peering connection based on + the settings of the network peerings. + $ref: >- + #/components/schemas/NetworkPeeringConnectionStatusTrafficConfiguration + consensusState: + description: >- + The consensus state contains information about the status of update + and delete for a consensus peering connection. + $ref: '#/components/schemas/NetworkPeeringConnectionStatusConsensusState' + NetworkPeeringConnectionStatusTrafficConfiguration: + id: NetworkPeeringConnectionStatusTrafficConfiguration type: object properties: - url: + stackType: description: >- - Resource URL to the forwarding rule representing the ILB configured - as destination of the mirrored traffic. + Which IP version(s) of traffic and routes are being imported or + exported between peer networks. type: string - canonicalUrl: + enumDescriptions: + - >- + This Peering will allow IPv4 traffic and routes to be exchanged. + Additionally if the matching peering is IPV4_IPV6, IPv6 traffic + and routes will be exchanged as well. + - >- + This Peering will only allow IPv4 traffic and routes to be + exchanged, even if the matching peering is IPV4_IPV6. + enum: + - IPV4_IPV6 + - IPV4_ONLY + importCustomRoutesFromPeer: + description: Whether custom routes are being imported from the peer network. + type: boolean + exportCustomRoutesToPeer: + description: Whether custom routes are being exported to the peer network. + type: boolean + importSubnetRoutesWithPublicIpFromPeer: description: >- - [Output Only] Unique identifier for the forwarding rule; defined by - the server. + Whether subnet routes with public IP ranges are being imported from + the peer network. + type: boolean + exportSubnetRoutesWithPublicIpToPeer: + description: >- + Whether subnet routes with public IP ranges are being exported to + the peer network. + type: boolean + NetworkPeeringConnectionStatusConsensusState: + id: NetworkPeeringConnectionStatusConsensusState + description: >- + The status of update/delete for a consensus peering connection. Only set + when connection_status.update_strategy is CONSENSUS or a network peering + is proposing to update the strategy to CONSENSUS. + type: object + properties: + deleteStatus: + description: The status of the delete request. type: string - PacketMirroringMirroredResourceInfo: - id: PacketMirroringMirroredResourceInfo + enumDescriptions: + - >- + Both network admins have agreed this consensus peering connection + can be deleted. + - '' + - Network admin has requested deletion of this peering connection. + - >- + The peer network admin has requested deletion of this peering + connection. + enum: + - DELETE_ACKNOWLEDGED + - DELETE_STATUS_UNSPECIFIED + - LOCAL_DELETE_REQUESTED + - PEER_DELETE_REQUESTED + updateStatus: + description: The status of the update request. + type: string + enumDescriptions: + - >- + No pending configuration update proposals to the peering + connection. + - >- + The peer network admin has made an updatePeering call. The change + is awaiting acknowledgment from this peering's network admin. + - >- + The local network admin has made an updatePeering call. The change + is awaiting acknowledgment from the peer network admin. + - '' + enum: + - IN_SYNC + - PENDING_LOCAL_ACKNOWLEDMENT + - PENDING_PEER_ACKNOWLEDGEMENT + - UPDATE_STATUS_UNSPECIFIED + NetworkRoutingConfig: + id: 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. type: object properties: - subnetworks: + routingMode: 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. - type: array - items: - $ref: '#/components/schemas/PacketMirroringMirroredResourceInfoSubnetInfo' - instances: + 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. + type: string + enumDescriptions: + - '' + - '' + enum: + - GLOBAL + - REGIONAL + bgpBestPathSelectionMode: 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. - type: array - items: - $ref: >- - #/components/schemas/PacketMirroringMirroredResourceInfoInstanceInfo - tags: + The BGP best path selection algorithm to be employed within this + network for dynamic routes learned by Cloud Routers. Can be LEGACY + (default) or STANDARD. + type: string + enumDescriptions: + - '' + - '' + enum: + - LEGACY + - STANDARD + bgpAlwaysCompareMed: description: >- - A set of mirrored tags. Traffic from/to all VM instances that have - one or more of these tags will be mirrored. - type: array - items: - type: string - PacketMirroringMirroredResourceInfoSubnetInfo: - id: PacketMirroringMirroredResourceInfoSubnetInfo + Enable comparison of Multi-Exit Discriminators (MED) across routes + with different neighbor ASNs when using the STANDARD BGP best path + selection algorithm. + type: boolean + bgpInterRegionCost: + description: >- + Allows to define a preferred approach for handling inter-region cost + in the selection process when using the STANDARD BGP best path + selection algorithm. Can be DEFAULT or ADD_COST_TO_MED. + type: string + enumDescriptions: + - '' + - '' + enum: + - ADD_COST_TO_MED + - DEFAULT + effectiveBgpAlwaysCompareMed: + description: '[Output Only] Effective value of the bgp_always_compare_med field.' + type: boolean + effectiveBgpInterRegionCost: + description: '[Output Only] Effective value of the bgp_inter_region_cost field.' + type: string + enumDescriptions: + - '' + - '' + enum: + - ADD_COST_TO_MED + - DEFAULT + NetworkParams: + id: NetworkParams + description: Additional network parameters. type: object properties: - url: + resourceManagerTags: description: >- - Resource URL to the subnetwork for which traffic from/to all VM - instances will be mirrored. + Tag keys/values directly bound to this resource. Tag keys and values + have the same definition as resource manager tags. The field is + allowed for INSERT only. The keys/values to set on the resource + should be specified in either ID { : } or Namespaced format { : }. + For example the following are valid inputs: * {"tagKeys/333" : + "tagValues/444", "tagKeys/123" : "tagValues/456"} * + {"123/environment" : "production", "345/abc" : "xyz"} Note: * + Invalid combinations of ID & namespaced format is not supported. For + instance: {"123/environment" : "tagValues/444"} is invalid. + type: object + additionalProperties: + type: string + NetworksUpdatePeeringRequest: + id: NetworksUpdatePeeringRequest + type: object + properties: + networkPeering: + $ref: '#/components/schemas/NetworkPeering' + NetworksAddPeeringRequest: + id: NetworksAddPeeringRequest + type: object + properties: + name: + description: Name of the peering, which should conform to RFC1035. + annotations: + required: + - compute.networks.addPeering type: string - canonicalUrl: + peerNetwork: description: >- - [Output Only] Unique identifier for the subnetwork; defined by the - server. + 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 - PacketMirroringMirroredResourceInfoInstanceInfo: - id: PacketMirroringMirroredResourceInfoInstanceInfo + 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 + 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. + $ref: '#/components/schemas/NetworkPeering' + NetworksRequestRemovePeeringRequest: + id: NetworksRequestRemovePeeringRequest type: object properties: - url: - description: >- - Resource URL to the virtual machine instance which is being - mirrored. + name: + description: Name of the peering, which should conform to RFC1035. type: string - canonicalUrl: - description: >- - [Output Only] Unique identifier for the instance; defined by the - server. + NetworksRemovePeeringRequest: + id: NetworksRemovePeeringRequest + type: object + properties: + name: + description: Name of the peering, which should conform to RFC1035. type: string - PacketMirroringFilter: - id: PacketMirroringFilter + NetworksGetEffectiveFirewallsResponse: + id: NetworksGetEffectiveFirewallsResponse type: object properties: - cidrRanges: - description: >- - One or more IPv4 or IPv6 CIDR ranges that apply as filters on the - source (ingress) or destination (egress) IP in the IP header. If no - ranges are specified, all IPv4 traffic that matches the specified - IPProtocols is mirrored. If neither cidrRanges nor IPProtocols is - specified, all IPv4 traffic is mirrored. To mirror all IPv4 and IPv6 - traffic, use "0.0.0.0/0,::/0". + firewalls: + description: Effective firewalls on the network. type: array items: - type: string - IPProtocols: + $ref: '#/components/schemas/Firewall' + firewallPolicys: 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 - IPv4 traffic is mirrored. + [Output Only] Effective firewalls from firewall policy. It returns + Global Network Firewall Policies and Hierarchical Firewall Policies. + Use regionNetworkFirewallPolicies.getEffectiveFirewalls to get + Regional Network Firewall Policies as well. type: array items: - type: string - direction: - description: >- - Direction of traffic to mirror, either INGRESS, EGRESS, or BOTH. The - default is BOTH. + $ref: >- + #/components/schemas/NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy + NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy: + id: NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy + type: object + properties: + name: + description: '[Output Only] The name of the firewall policy.' + type: string + type: + description: '[Output Only] The type of the firewall policy.' type: string enumDescriptions: - - Default, both directions are mirrored. - - Only egress traffic is mirrored. - - Only ingress traffic is mirrored. + - '' + - '' + - '' + - '' enum: - - BOTH - - EGRESS - - INGRESS - PacketMirroringList: - id: PacketMirroringList - description: Contains a list of PacketMirroring resources. + - HIERARCHY + - NETWORK + - SYSTEM + - UNSPECIFIED + shortName: + description: '[Output Only] The short name of the firewall policy.' + type: string + displayName: + description: >- + [Output Only] Deprecated, please use short name instead. The display + name of the firewall policy. + deprecated: true + type: string + rules: + description: '[Output Only] The rules that apply to the network.' + type: array + items: + $ref: '#/components/schemas/FirewallPolicyRule' + packetMirroringRules: + description: '[Output Only] The packet mirroring rules that apply to the network.' + type: array + items: + $ref: '#/components/schemas/FirewallPolicyRule' + priority: + description: >- + [Output only] Priority of firewall policy association. Not + applicable for type=HIERARCHY. + type: integer + format: int32 + ExchangedPeeringRoutesList: + id: ExchangedPeeringRoutesList type: object properties: kind: description: >- - [Output Only] Type of resource. Always compute#packetMirroring for - packetMirrorings. - default: compute#packetMirroringList + [Output Only] Type of resource. Always + compute#exchangedPeeringRoutesList for exchanged peering routes + lists. + default: compute#exchangedPeeringRoutesList type: string id: description: >- @@ -38571,10 +39127,10 @@ components: server. type: string items: - description: A list of PacketMirroring resources. + description: A list of ExchangedPeeringRoute resources. type: array items: - $ref: '#/components/schemas/PacketMirroring' + $ref: '#/components/schemas/ExchangedPeeringRoute' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -38650,6 +39206,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -38693,6 +39252,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -38715,6 +39275,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -38751,14 +39312,51 @@ components: [Output Only] A warning data value corresponding to the key. type: string - PacketMirroringAggregatedList: - id: PacketMirroringAggregatedList - description: Contains a list of packetMirrorings. + ExchangedPeeringRoute: + id: ExchangedPeeringRoute + type: object + properties: + destRange: + description: The destination range of the route. + type: string + type: + description: The type of the peering route. + type: string + enumDescriptions: + - For routes exported from local network. + - The peering route. + - The peering route corresponding to subnetwork range. + enum: + - DYNAMIC_PEERING_ROUTE + - STATIC_PEERING_ROUTE + - SUBNET_PEERING_ROUTE + nextHopRegion: + description: >- + The region of peering route next hop, only applies to dynamic + routes. + type: string + priority: + description: The priority of the peering route. + type: integer + format: uint32 + 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 + NodeGroupList: + id: NodeGroupList + description: Contains a list of nodeGroups. type: object properties: kind: - description: Type of resource. - default: compute#packetMirroringAggregatedList + description: >- + [Output Only] Type of resource.Always compute#nodeGroupList for + lists of node groups. + default: compute#nodeGroupList type: string id: description: >- @@ -38766,11 +39364,10 @@ components: server. type: string items: - description: A list of PacketMirroring resources. - type: object - additionalProperties: - description: Name of the scope containing this set of packetMirrorings. - $ref: '#/components/schemas/PacketMirroringsScopedList' + description: A list of NodeGroup resources. + type: array + items: + $ref: '#/components/schemas/NodeGroup' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -38846,6 +39443,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -38889,6 +39489,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -38911,6 +39512,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -38947,30 +39549,232 @@ components: [Output Only] A warning data value corresponding to the key. type: string - unreachables: - description: '[Output Only] Unreachable resources.' - type: array - items: - type: string - PacketMirroringsScopedList: - id: PacketMirroringsScopedList + NodeGroup: + id: 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. type: object properties: - packetMirrorings: - description: A list of packetMirrorings contained in this scope. - type: array - items: - $ref: '#/components/schemas/PacketMirroring' - warning: + kind: description: >- - Informational warning which replaces the list of packetMirrorings - when the list is empty. - type: object - properties: - code: - description: >- - [Output Only] A warning code, if applicable. For example, - Compute Engine returns NO_RESULTS_ON_PAGE if there are no + [Output Only] The type of the resource. Always compute#nodeGroup for + node group. + default: compute#nodeGroup + type: string + id: + description: >- + [Output Only] The unique identifier for the resource. This + identifier is defined by the server. + type: string + format: uint64 + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + 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 + description: + description: >- + An optional description of this resource. Provide this property when + you create the resource. + type: string + nodeTemplate: + description: URL of the node template to create the node group from. + type: string + zone: + description: >- + [Output Only] The name of the zone where the node group resides, + such as us-central1-a. + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + status: + type: string + enumDescriptions: + - '' + - '' + - '' + - '' + enum: + - CREATING + - DELETING + - INVALID + - READY + size: + description: '[Output Only] The total number of nodes in the node group.' + type: integer + format: int32 + autoscalingPolicy: + description: Specifies how autoscaling should behave. + $ref: '#/components/schemas/NodeGroupAutoscalingPolicy' + 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. + type: string + enumDescriptions: + - >- + Allow the node and corresponding instances to retain default + maintenance behavior. + - '' + - >- + When maintenance must be done on a node, the instances on that + node will be moved to other nodes in the group. Instances with + onHostMaintenance = MIGRATE will live migrate to their + destinations while instances with onHostMaintenance = TERMINATE + will terminate and then restart on their destination nodes if + automaticRestart = true. + - >- + Instances in this group will restart on the same node when + maintenance has completed. Instances must have onHostMaintenance = + TERMINATE, and they will only restart if automaticRestart = true. + enum: + - DEFAULT + - MAINTENANCE_POLICY_UNSPECIFIED + - MIGRATE_WITHIN_NODE_GROUP + - RESTART_IN_PLACE + 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 + fingerprint: + type: string + format: byte + maintenanceWindow: + $ref: '#/components/schemas/NodeGroupMaintenanceWindow' + shareSettings: + description: Share-settings for the node group + $ref: '#/components/schemas/ShareSettings' + maintenanceInterval: + description: >- + Specifies the frequency of planned maintenance events. The accepted + values are: `AS_NEEDED` and `RECURRENT`. + type: string + enumDescriptions: + - >- + VMs are eligible to receive infrastructure and hypervisor updates + as they become available. This may result in more maintenance + operations (live migrations or terminations) for the VM than the + PERIODIC and RECURRENT options. + - >- + VMs receive infrastructure and hypervisor updates on a periodic + basis, minimizing the number of maintenance operations (live + migrations or terminations) on an individual VM. This may mean a + VM will take longer to receive an update than if it was configured + for AS_NEEDED. Security updates will still be applied as soon as + they are available. RECURRENT is used for GEN3 and Slice of + Hardware VMs. + enum: + - AS_NEEDED + - RECURRENT + NodeGroupAutoscalingPolicy: + id: NodeGroupAutoscalingPolicy + type: object + properties: + mode: + description: >- + The autoscaling mode. Set to one of: ON, OFF, or ONLY_SCALE_OUT. For + more information, see Autoscaler modes. + type: string + enumDescriptions: + - '' + - Autoscaling is disabled. + - Autocaling is fully enabled. + - Autoscaling will only scale out and will not remove nodes. + enum: + - MODE_UNSPECIFIED + - 'OFF' + - 'ON' + - ONLY_SCALE_OUT + minNodes: + description: The minimum number of nodes that the group should have. + type: integer + format: int32 + maxNodes: + description: >- + The maximum number of nodes that the group should have. Must be set + if autoscaling is enabled. Maximum value allowed is 100. + type: integer + format: int32 + NodeGroupMaintenanceWindow: + id: NodeGroupMaintenanceWindow + description: >- + Time window specified for daily maintenance operations. GCE's internal + maintenance will be performed within this window. + type: object + properties: + 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 + maintenanceDuration: + description: >- + [Output only] A predetermined duration for the window, automatically + chosen to be the smallest possible in the given scenario. + $ref: '#/components/schemas/Duration' + NodeGroupAggregatedList: + id: NodeGroupAggregatedList + type: object + properties: + kind: + description: >- + [Output Only] Type of resource.Always + compute#nodeGroupAggregatedList for aggregated lists of node groups. + default: compute#nodeGroupAggregatedList + type: string + id: + description: >- + [Output Only] Unique identifier for the resource; defined by the + server. + type: string + items: + description: A list of NodeGroupsScopedList resources. + type: object + additionalProperties: + description: >- + [Output Only] Name of the scope containing this set of node + groups. + $ref: '#/components/schemas/NodeGroupsScopedList' + nextPageToken: + description: >- + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. + type: string + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string + warning: + description: '[Output Only] Informational warning message.' + type: object + properties: + code: + description: >- + [Output Only] A warning code, if applicable. For example, + Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. type: string enumDescriptions: @@ -39027,6 +39831,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -39070,6 +39877,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -39092,6 +39900,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -39128,584 +39937,237 @@ components: [Output Only] A warning data value corresponding to the key. type: string - Project: - id: 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. + unreachables: + description: '[Output Only] Unreachable resources.' + type: array + items: + type: string + NodeGroupsScopedList: + id: NodeGroupsScopedList type: object properties: - kind: - description: >- - [Output Only] Type of the resource. Always compute#project for - projects. - default: compute#project - type: string - 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. - type: string - format: uint64 - creationTimestamp: - description: '[Output Only] Creation timestamp in RFC3339 text format.' - type: string - name: - description: >- - The project ID. For example: my-example-project. Use the project ID - to make requests to Compute Engine. - type: string - description: - description: An optional textual description of the resource. - type: string - commonInstanceMetadata: - description: >- - Metadata key/value pairs available to all instances contained in - this project. See Custom metadata for more information. - $ref: '#/components/schemas/Metadata' - quotas: - description: '[Output Only] Quotas assigned to this project.' + nodeGroups: + description: '[Output Only] A list of node groups contained in this scope.' type: array items: - $ref: '#/components/schemas/Quota' - usageExportLocation: + $ref: '#/components/schemas/NodeGroup' + warning: description: >- - The naming prefix for daily usage reports and the Google Cloud - Storage bucket where they are stored. - $ref: '#/components/schemas/UsageExportLocation' - enabledFeatures: - description: Restricted features enabled for use on this project. + [Output Only] An informational warning that appears when the + nodeGroup list is empty. + type: object + properties: + code: + description: >- + [Output Only] A warning code, if applicable. For example, + Compute Engine returns NO_RESULTS_ON_PAGE if there are no + results in the response. + type: string + enumDescriptions: + - >- + Warning about failed cleanup of transient changes made by a + failed operation. + - A link to a deprecated resource was created. + - >- + When deploying and at least one of the resources has a type + marked as deprecated + - The user created a boot disk that is larger than image size. + - >- + When deploying and at least one of the resources has a type + marked as experimental + - Warning that is present in an external api call + - >- + Warning that value of a field has been overridden. Deprecated + unused field. + - >- + The operation involved use of an injected kernel, which is + deprecated. + - >- + A WEIGHTED_MAGLEV backend service is associated with a health + check that is not of type HTTP/HTTPS/HTTP2. + - >- + When deploying a deployment with a exceedingly large number of + resources + - >- + Resource can't be retrieved due to list overhead quota exceed + which captures the amount of resources filtered out by + user-defined list filter. + - A resource depends on a missing type + - >- + The route's nextHopIp address is not assigned to an instance + on the network. + - The route's next hop instance cannot ip forward. + - >- + The route's nextHopInstance URL refers to an instance that + does not have an ipv6 interface on the same network as the + route. + - >- + The route's nextHopInstance URL refers to an instance that + does not exist. + - >- + The route's nextHopInstance URL refers to an instance that is + not on the same network as the route. + - >- + The route's next hop instance does not have a status of + RUNNING. + - >- + Error which is not critical. We decided to continue the + process despite the mentioned error. + - No results are present on a particular list page. + - >- + Success is reported, but some results may be missing due to + errors + - >- + Quota information is not available to client requests (e.g: + regions.list). + - >- + The user attempted to use a resource that requires a TOS they + have not accepted. + - Warning that a resource is in use. + - >- + One or more of the resources set to auto-delete could not be + deleted because they were in use. + - When a resource schema validation is ignored. + - >- + Instance template used in instance group manager is valid as + such, but its application does not make a lot of sense, + because it allows only single instance in instance group. + - When undeclared properties in the schema are present + - A given scope cannot be reached. + enumDeprecated: + - false + - false + - false + - false + - false + - false + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + enum: + - CLEANUP_FAILED + - DEPRECATED_RESOURCE_USED + - DEPRECATED_TYPE_USED + - DISK_SIZE_LARGER_THAN_IMAGE_SIZE + - EXPERIMENTAL_TYPE_USED + - EXTERNAL_API_WARNING + - FIELD_VALUE_OVERRIDEN + - INJECTED_KERNELS_DEPRECATED + - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB + - LARGE_DEPLOYMENT_WARNING + - LIST_OVERHEAD_QUOTA_EXCEED + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE + - NEXT_HOP_INSTANCE_NOT_FOUND + - NEXT_HOP_INSTANCE_NOT_ON_NETWORK + - NEXT_HOP_NOT_RUNNING + - NOT_CRITICAL_ERROR + - NO_RESULTS_ON_PAGE + - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE + - REQUIRED_TOS_AGREEMENT + - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING + - RESOURCE_NOT_DELETED + - SCHEMA_VALIDATION_IGNORED + - SINGLE_INSTANCE_PROPERTY_TEMPLATE + - UNDECLARED_PROPERTIES + - UNREACHABLE + message: + description: '[Output Only] A human-readable description of the warning code.' + type: string + data: + description: >- + [Output Only] Metadata about this warning in key: value format. + For example: "data": [ { "key": "scope", "value": + "zones/us-east1-d" } + type: array + items: + type: object + properties: + key: + description: >- + [Output Only] A key that provides more detail on the + warning being returned. For example, for warnings where + there are no results in a list request for a particular + zone, this key might be scope and the key value might be + the zone name. Other examples might be a key indicating a + deprecated resource and a suggested replacement, or a + warning about invalid network settings (for example, if an + instance attempts to perform IP forwarding but is not + enabled for IP forwarding). + type: string + value: + description: >- + [Output Only] A warning data value corresponding to the + key. + type: string + NodeGroupsAddNodesRequest: + id: NodeGroupsAddNodesRequest + type: object + properties: + additionalNodeCount: + description: Count of additional nodes to be added to the node group. + type: integer + format: int32 + NodeGroupsDeleteNodesRequest: + id: NodeGroupsDeleteNodesRequest + type: object + properties: + nodes: + description: Names of the nodes to delete. type: array items: type: string - selfLink: - description: '[Output Only] Server-defined URL for the resource.' - type: string - defaultServiceAccount: + NodeGroupsListNodes: + id: NodeGroupsListNodes + type: object + properties: + kind: description: >- - [Output Only] Default service account used by VMs running in this - project. + [Output Only] The resource type, which is always + compute.nodeGroupsListNodes for the list of nodes in the specified + node group. + default: compute#nodeGroupsListNodes type: string - xpnProjectStatus: + id: 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. + [Output Only] Unique identifier for the resource; defined by the + server. type: string - enumDescriptions: - - '' - - '' - enum: - - HOST - - UNSPECIFIED_XPN_PROJECT_STATUS - defaultNetworkTier: + items: + description: A list of Node resources. + type: array + items: + $ref: '#/components/schemas/NodeGroupNode' + nextPageToken: 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. - type: string - enumDescriptions: - - Public internet quality with fixed bandwidth. - - >- - High quality, Google-grade network tier, support for all - networking products. - - >- - Public internet quality, only limited support for other networking - products. - - >- - (Output only) Temporary tier for FIXED_STANDARD when fixed - standard tier is expired or not configured. - enum: - - FIXED_STANDARD - - PREMIUM - - STANDARD - - STANDARD_OVERRIDES_FIXED_STANDARD - vmDnsSetting: - description: >- - [Output Only] Default internal DNS setting used by VMs running in - this project. - type: string - enumDescriptions: - - '' - - '' - - '' - - '' - enum: - - GLOBAL_DEFAULT - - UNSPECIFIED_VM_DNS_SETTING - - ZONAL_DEFAULT - - ZONAL_ONLY - cloudArmorTier: - description: >- - [Output Only] The Cloud Armor tier for this project. It can be one - of the following values: CA_STANDARD, CA_ENTERPRISE_PAYGO. If this - field is not specified, it is assumed to be CA_STANDARD. - type: string - enumDescriptions: - - Enterprise tier protection billed annually. - - Enterprise tier protection billed monthly. - - Standard protection. - enum: - - CA_ENTERPRISE_ANNUAL - - CA_ENTERPRISE_PAYGO - - CA_STANDARD - Quota: - id: Quota - description: A quotas entry. - type: object - properties: - metric: - description: '[Output Only] Name of the quota metric.' - type: string - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - Guest CPUs - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - The total number of snapshots allowed for a single project. - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - 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_M3_CPUS - - COMMITTED_MEMORY_OPTIMIZED_CPUS - - COMMITTED_N2A_CPUS - - COMMITTED_N2D_CPUS - - COMMITTED_N2_CPUS - - COMMITTED_NVIDIA_A100_80GB_GPUS - - COMMITTED_NVIDIA_A100_GPUS - - COMMITTED_NVIDIA_H100_GPUS - - COMMITTED_NVIDIA_K80_GPUS - - COMMITTED_NVIDIA_L4_GPUS - - COMMITTED_NVIDIA_P100_GPUS - - COMMITTED_NVIDIA_P4_GPUS - - COMMITTED_NVIDIA_T4_GPUS - - COMMITTED_NVIDIA_V100_GPUS - - COMMITTED_T2A_CPUS - - COMMITTED_T2D_CPUS - - COMMITTED_Z3_CPUS - - CPUS - - CPUS_ALL_REGIONS - - DISKS_TOTAL_GB - - E2_CPUS - - EXTERNAL_MANAGED_FORWARDING_RULES - - EXTERNAL_NETWORK_LB_FORWARDING_RULES - - EXTERNAL_PROTOCOL_FORWARDING_RULES - - EXTERNAL_VPN_GATEWAYS - - FIREWALLS - - FORWARDING_RULES - - GLOBAL_EXTERNAL_MANAGED_BACKEND_SERVICES - - GLOBAL_EXTERNAL_MANAGED_FORWARDING_RULES - - GLOBAL_EXTERNAL_PROXY_LB_BACKEND_SERVICES - - GLOBAL_INTERNAL_ADDRESSES - - GLOBAL_INTERNAL_MANAGED_BACKEND_SERVICES - - GLOBAL_INTERNAL_TRAFFIC_DIRECTOR_BACKEND_SERVICES - - GPUS_ALL_REGIONS - - HDB_TOTAL_GB - - HDB_TOTAL_IOPS - - HDB_TOTAL_THROUGHPUT - - 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 - - M3_CPUS - - MACHINE_IMAGES - - N2A_CPUS - - N2D_CPUS - - N2_CPUS - - NETWORKS - - NETWORK_ATTACHMENTS - - NETWORK_ENDPOINT_GROUPS - - NETWORK_FIREWALL_POLICIES - - NET_LB_SECURITY_POLICIES_PER_REGION - - NET_LB_SECURITY_POLICY_RULES_PER_REGION - - NET_LB_SECURITY_POLICY_RULE_ATTRIBUTES_PER_REGION - - NODE_GROUPS - - NODE_TEMPLATES - - NVIDIA_A100_80GB_GPUS - - NVIDIA_A100_GPUS - - NVIDIA_K80_GPUS - - NVIDIA_L4_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_80GB_GPUS - - PREEMPTIBLE_NVIDIA_A100_GPUS - - PREEMPTIBLE_NVIDIA_H100_GPUS - - PREEMPTIBLE_NVIDIA_K80_GPUS - - PREEMPTIBLE_NVIDIA_L4_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 - - PREEMPTIBLE_TPU_LITE_DEVICE_V5 - - PREEMPTIBLE_TPU_LITE_PODSLICE_V5 - - PREEMPTIBLE_TPU_PODSLICE_V4 - - PSC_ILB_CONSUMER_FORWARDING_RULES_PER_PRODUCER_NETWORK - - PSC_INTERNAL_LB_FORWARDING_RULES - - PUBLIC_ADVERTISED_PREFIXES - - PUBLIC_DELEGATED_PREFIXES - - REGIONAL_AUTOSCALERS - - REGIONAL_EXTERNAL_MANAGED_BACKEND_SERVICES - - REGIONAL_EXTERNAL_NETWORK_LB_BACKEND_SERVICES - - REGIONAL_INSTANCE_GROUP_MANAGERS - - REGIONAL_INTERNAL_LB_BACKEND_SERVICES - - REGIONAL_INTERNAL_MANAGED_BACKEND_SERVICES - - REGIONAL_INTERNAL_TRAFFIC_DIRECTOR_BACKEND_SERVICES - - RESERVATIONS - - RESOURCE_POLICIES - - ROUTERS - - ROUTES - - SECURITY_POLICIES - - SECURITY_POLICIES_PER_REGION - - SECURITY_POLICY_ADVANCED_RULES_PER_REGION - - SECURITY_POLICY_CEVAL_RULES - - SECURITY_POLICY_RULES - - SECURITY_POLICY_RULES_PER_REGION - - SERVICE_ATTACHMENTS - - SNAPSHOTS - - SSD_TOTAL_GB - - SSL_CERTIFICATES - - SSL_POLICIES - - STATIC_ADDRESSES - - STATIC_BYOIP_ADDRESSES - - STATIC_EXTERNAL_IPV6_ADDRESS_RANGES - - SUBNETWORKS - - T2A_CPUS - - T2D_CPUS - - TARGET_HTTPS_PROXIES - - TARGET_HTTP_PROXIES - - TARGET_INSTANCES - - TARGET_POOLS - - TARGET_SSL_PROXIES - - TARGET_TCP_PROXIES - - TARGET_VPN_GATEWAYS - - TPU_LITE_DEVICE_V5 - - TPU_LITE_PODSLICE_V5 - - TPU_PODSLICE_V4 - - URL_MAPS - - VARIABLE_IPV6_PUBLIC_DELEGATED_PREFIXES - - VPN_GATEWAYS - - VPN_TUNNELS - - XPN_SERVICE_PROJECTS - limit: - description: '[Output Only] Quota limit for this metric.' - type: number - format: double - usage: - description: '[Output Only] Current usage of this metric.' - type: number - format: double - owner: - description: >- - [Output Only] Owning resource. This is the resource on which this - quota is applied. - type: string - UsageExportLocation: - id: UsageExportLocation - description: >- - The location in Cloud Storage and naming method of the daily usage - report. Contains bucket_name and report_name prefix. - type: object - 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 - InstanceMoveRequest: - id: InstanceMoveRequest - type: object - properties: - 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 - 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 - DiskMoveRequest: - id: DiskMoveRequest - type: object - properties: - 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 - 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 - ProjectsListXpnHostsRequest: - id: ProjectsListXpnHostsRequest - type: object - 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 - XpnHostList: - id: XpnHostList - type: object - properties: - kind: - description: >- - [Output Only] Type of resource. Always compute#xpnHostList for lists - of shared VPC hosts. - default: compute#xpnHostList - type: string - 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.' - type: array - items: - $ref: '#/components/schemas/Project' - nextPageToken: - description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. type: string selfLink: description: '[Output Only] Server-defined URL for this resource.' @@ -39774,6 +40236,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -39817,6 +40282,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -39839,6 +40305,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -39875,113 +40342,187 @@ components: [Output Only] A warning data value corresponding to the key. type: string - ProjectsEnableXpnResourceRequest: - id: ProjectsEnableXpnResourceRequest - type: object - properties: - xpnResource: - description: Service resource (a.k.a service project) ID. - $ref: '#/components/schemas/XpnResourceId' - XpnResourceId: - id: XpnResourceId - description: Service resource (a.k.a service project) ID. + NodeGroupNode: + id: NodeGroupNode type: object properties: - type: - description: The type of the service resource. + name: + description: The name of the node. + type: string + status: type: string enumDescriptions: - '' - '' + - '' + - '' + - '' enum: - - PROJECT - - XPN_RESOURCE_TYPE_UNSPECIFIED - 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 - ProjectsDisableXpnResourceRequest: - id: ProjectsDisableXpnResourceRequest + - CREATING + - DELETING + - INVALID + - READY + - REPAIRING + nodeType: + description: The type of this node. + type: string + serverBinding: + description: Binding properties for the physical server. + $ref: '#/components/schemas/ServerBinding' + serverId: + description: Server ID associated with this node. + type: string + disks: + description: Local disk configurations. + type: array + items: + $ref: '#/components/schemas/LocalDisk' + accelerators: + description: Accelerators for this node. + type: array + items: + $ref: '#/components/schemas/AcceleratorConfig' + instances: + description: Instances scheduled on this node. + type: array + items: + type: string + instanceConsumptionData: + description: Instance data that shows consumed resources on the node. + type: array + items: + $ref: '#/components/schemas/InstanceConsumptionData' + consumedResources: + description: Node resources that are reserved by all instances. + $ref: '#/components/schemas/InstanceConsumptionInfo' + totalResources: + description: Total amount of available resources on the node. + $ref: '#/components/schemas/InstanceConsumptionInfo' + cpuOvercommitType: + description: CPU overcommit. + type: string + enumDescriptions: + - '' + - '' + - '' + enum: + - CPU_OVERCOMMIT_TYPE_UNSPECIFIED + - ENABLED + - NONE + satisfiesPzs: + description: '[Output Only] Reserved for future use.' + type: boolean + upcomingMaintenance: + description: '[Output Only] The information about an upcoming maintenance event.' + $ref: '#/components/schemas/UpcomingMaintenance' + ServerBinding: + id: ServerBinding type: object properties: - xpnResource: - description: Service resource (a.k.a service project) ID. - $ref: '#/components/schemas/XpnResourceId' - ProjectsGetXpnResources: - id: ProjectsGetXpnResources + type: + type: string + enumDescriptions: + - Node may associate with any physical server over its lifetime. + - >- + Node may associate with minimal physical servers over its + lifetime. + - '' + enum: + - RESTART_NODE_ON_ANY_SERVER + - RESTART_NODE_ON_MINIMAL_SERVERS + - SERVER_BINDING_TYPE_UNSPECIFIED + LocalDisk: + id: LocalDisk type: object properties: - kind: + diskType: description: >- - [Output Only] Type of resource. Always - compute#projectsGetXpnResources for lists of service resources - (a.k.a service projects) - default: compute#projectsGetXpnResources + 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 - resources: + diskSizeGb: + description: Specifies the size of the disk in base-2 GB. + type: integer + format: int32 + diskCount: + description: Specifies the number of such disks. + type: integer + format: int32 + InstanceConsumptionData: + id: InstanceConsumptionData + type: object + properties: + instance: + description: Server-defined URL for the instance. + type: string + consumptionInfo: + description: Resources consumed by the instance. + $ref: '#/components/schemas/InstanceConsumptionInfo' + InstanceConsumptionInfo: + id: InstanceConsumptionInfo + type: object + properties: + minNodeCpus: + description: The minimal guaranteed number of virtual CPUs that are reserved. + type: integer + format: int32 + guestCpus: + description: The number of virtual CPUs that are available to the instance. + type: integer + format: int32 + memoryMb: description: >- - Service resources (a.k.a service projects) attached to this project - as their shared VPC host. - type: array - items: - $ref: '#/components/schemas/XpnResourceId' - nextPageToken: + The amount of physical memory available to the instance, defined in + MiB. + type: integer + format: int32 + localSsdGb: description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. - type: string - ProjectsSetDefaultNetworkTierRequest: - id: ProjectsSetDefaultNetworkTierRequest + The amount of local SSD storage available to the instance, defined + in GiB. + type: integer + format: int32 + NodeGroupsSetNodeTemplateRequest: + id: NodeGroupsSetNodeTemplateRequest type: object properties: - networkTier: - description: Default network tier to be set. + nodeTemplate: + description: >- + Full or partial URL of the node template resource to be updated for + this node group. type: string - enumDescriptions: - - Public internet quality with fixed bandwidth. - - >- - High quality, Google-grade network tier, support for all - networking products. - - >- - Public internet quality, only limited support for other networking - products. - - >- - (Output only) Temporary tier for FIXED_STANDARD when fixed - standard tier is expired or not configured. - enum: - - FIXED_STANDARD - - PREMIUM - - STANDARD - - STANDARD_OVERRIDES_FIXED_STANDARD - ProjectsSetCloudArmorTierRequest: - id: ProjectsSetCloudArmorTierRequest + NodeGroupsSimulateMaintenanceEventRequest: + id: NodeGroupsSimulateMaintenanceEventRequest type: object properties: - cloudArmorTier: - description: Managed protection tier to be set. + nodes: + description: Names of the nodes to go under maintenance simulation. + type: array + items: + type: string + NodeGroupsPerformMaintenanceRequest: + id: NodeGroupsPerformMaintenanceRequest + type: object + properties: + nodes: + description: '[Required] List of nodes affected by the call.' + type: array + items: + type: string + startTime: + description: The start time of the schedule. The timestamp is an RFC3339 string. type: string - enumDescriptions: - - Enterprise tier protection billed annually. - - Enterprise tier protection billed monthly. - - Standard protection. - enum: - - CA_ENTERPRISE_ANNUAL - - CA_ENTERPRISE_PAYGO - - CA_STANDARD - PublicAdvertisedPrefixList: - id: PublicAdvertisedPrefixList + NodeTemplateList: + id: NodeTemplateList + description: Contains a list of node templates. type: object properties: kind: description: >- - [Output Only] Type of the resource. Always - compute#publicAdvertisedPrefix for public advertised prefixes. - default: compute#publicAdvertisedPrefixList + [Output Only] Type of resource.Always compute#nodeTemplateList for + lists of node templates. + default: compute#nodeTemplateList type: string id: description: >- @@ -39989,10 +40530,10 @@ components: server. type: string items: - description: A list of PublicAdvertisedPrefix resources. + description: A list of NodeTemplate resources. type: array items: - $ref: '#/components/schemas/PublicAdvertisedPrefix' + $ref: '#/components/schemas/NodeTemplate' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -40068,6 +40609,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -40111,6 +40655,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -40133,6 +40678,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -40169,24 +40715,24 @@ components: [Output Only] A warning data value corresponding to the key. type: string - PublicAdvertisedPrefix: - id: PublicAdvertisedPrefix + NodeTemplate: + id: NodeTemplate 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. + 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. type: object properties: kind: description: >- - [Output Only] Type of the resource. Always - compute#publicAdvertisedPrefix for public advertised prefixes. - default: compute#publicAdvertisedPrefix + [Output Only] The type of the resource. Always compute#nodeTemplate + for node templates. + default: compute#nodeTemplate type: string id: description: >- - [Output Only] The unique identifier for the resource type. The - server generates this identifier. + [Output Only] The unique identifier for the resource. This + identifier is defined by the server. type: string format: uint64 creationTimestamp: @@ -40194,163 +40740,108 @@ components: 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])?' - annotations: - required: - - compute.publicAdvertisedPrefixes.insert + 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 description: description: >- An optional description of this resource. Provide this property when you create the resource. type: string - selfLink: - description: '[Output Only] Server-defined URL for the resource.' - type: string - ipCidrRange: + nodeType: description: >- - The address range, in CIDR format, represented by this public - advertised prefix. - type: string - dnsVerificationIp: - description: The address to be used for reverse DNS verification. + The node type to use for nodes group that are created from this + template. type: string - sharedSecret: + nodeAffinityLabels: description: >- - [Output Only] The shared secret to be used for reverse DNS - verification. - type: string + Labels to use for node affinity, which will be used in instance + scheduling. + type: object + additionalProperties: + type: string status: description: >- - The status of the public advertised prefix. Possible values include: - - `INITIAL`: RPKI validation is complete. - `PTR_CONFIGURED`: User - has configured the PTR. - `VALIDATED`: Reverse DNS lookup is - successful. - `REVERSE_DNS_LOOKUP_FAILED`: Reverse DNS lookup - failed. - `PREFIX_CONFIGURATION_IN_PROGRESS`: The prefix is being - configured. - `PREFIX_CONFIGURATION_COMPLETE`: The prefix is fully - configured. - `PREFIX_REMOVAL_IN_PROGRESS`: The prefix is being - removed. + [Output Only] The status of the node template. One of the following + values: CREATING, READY, and DELETING. type: string enumDescriptions: - - The prefix is announced to Internet. - - RPKI validation is complete. - - The prefix is fully configured. - - The prefix is being configured. - - The prefix is being removed. - - User has configured the PTR. - - The prefix is currently withdrawn but ready to be announced. - - Reverse DNS lookup failed. - - Reverse DNS lookup is successful. + - Resources are being allocated. + - The node template is currently being deleted. + - Invalid status. + - The node template is ready. enum: - - ANNOUNCED_TO_INTERNET - - INITIAL - - PREFIX_CONFIGURATION_COMPLETE - - PREFIX_CONFIGURATION_IN_PROGRESS - - PREFIX_REMOVAL_IN_PROGRESS - - PTR_CONFIGURED - - READY_TO_ANNOUNCE - - REVERSE_DNS_LOOKUP_FAILED - - VALIDATED - pdpScope: + - CREATING + - DELETING + - INVALID + - READY + statusMessage: + description: '[Output Only] An optional, human-readable explanation of the status.' + type: string + region: description: >- - Specifies how child public delegated prefix will be scoped. It could - be one of following values: - `REGIONAL`: The public delegated - prefix is regional only. The provisioning will take a few minutes. - - `GLOBAL`: The public delegated prefix is global only. The - provisioning will take ~4 weeks. - `GLOBAL_AND_REGIONAL` [output - only]: The public delegated prefixes is BYOIP V1 legacy prefix. This - is output only value and no longer supported in BYOIP V2. + [Output Only] The name of the region where the node template + resides, such as us-central1. type: string - enumDescriptions: - - >- - The public delegated prefix is global only. The provisioning will - take ~4 weeks. - - >- - The public delegated prefixes is BYOIP V1 legacy prefix. This is - output only value and no longer supported in BYOIP V2. - - >- - The public delegated prefix is regional only. The provisioning - will take a few minutes. - enum: - - GLOBAL - - GLOBAL_AND_REGIONAL - - REGIONAL - publicDelegatedPrefixs: + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + nodeTypeFlexibility: + description: Do not use. Instead, use the node_type property. + $ref: '#/components/schemas/NodeTemplateNodeTypeFlexibility' + serverBinding: description: >- - [Output Only] The list of public delegated prefixes that exist for - this public advertised prefix. + 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. + $ref: '#/components/schemas/ServerBinding' + disks: type: array items: - $ref: '#/components/schemas/PublicAdvertisedPrefixPublicDelegatedPrefix' - 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. - type: string - format: byte - byoipApiVersion: - description: '[Output Only] The version of BYOIP API.' + $ref: '#/components/schemas/LocalDisk' + accelerators: + type: array + items: + $ref: '#/components/schemas/AcceleratorConfig' + cpuOvercommitType: + description: CPU overcommit. type: string enumDescriptions: - - >- - This public advertised prefix can be used to create both regional - and global public delegated prefixes. It usually takes 4 weeks to - create or delete a public delegated prefix. The BGP status cannot - be changed. - - >- - This public advertised prefix can only be used to create regional - public delegated prefixes. Public delegated prefix creation and - deletion takes minutes and the BGP status can be modified. + - '' + - '' + - '' enum: - - V1 - - V2 - PublicAdvertisedPrefixPublicDelegatedPrefix: - id: PublicAdvertisedPrefixPublicDelegatedPrefix - description: Represents a CIDR range which can be used to assign addresses. + - CPU_OVERCOMMIT_TYPE_UNSPECIFIED + - ENABLED + - NONE + NodeTemplateNodeTypeFlexibility: + id: NodeTemplateNodeTypeFlexibility type: object properties: - name: - description: The name 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 - project: - description: The project number of the public delegated prefix + cpus: 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. + memory: type: string - ipRange: - description: The IP address range of the public delegated prefix + localSsd: type: string - PublicDelegatedPrefixList: - id: PublicDelegatedPrefixList + NodeTemplateAggregatedList: + id: NodeTemplateAggregatedList type: object properties: kind: description: >- - [Output Only] Type of the resource. Always - compute#publicDelegatedPrefixList for public delegated prefixes. - default: compute#publicDelegatedPrefixList + [Output Only] Type of resource.Always + compute#nodeTemplateAggregatedList for aggregated lists of node + templates. + default: compute#nodeTemplateAggregatedList type: string id: description: >- @@ -40358,10 +40849,13 @@ components: server. type: string items: - description: A list of PublicDelegatedPrefix resources. - type: array - items: - $ref: '#/components/schemas/PublicDelegatedPrefix' + description: A list of NodeTemplatesScopedList resources. + type: object + additionalProperties: + description: >- + [Output Only] Name of the scope containing this set of node + templates. + $ref: '#/components/schemas/NodeTemplatesScopedList' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -40437,6 +40931,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -40480,6 +40977,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -40502,6 +41000,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -40538,250 +41037,24 @@ components: [Output Only] A warning data value corresponding to the key. type: string - PublicDelegatedPrefix: - id: 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. + unreachables: + description: '[Output Only] Unreachable resources.' + type: array + items: + type: string + NodeTemplatesScopedList: + id: NodeTemplatesScopedList type: object properties: - kind: - description: >- - [Output Only] Type of the resource. Always - compute#publicDelegatedPrefix for public delegated prefixes. - default: compute#publicDelegatedPrefix - type: string - id: - description: >- - [Output Only] The unique identifier for the resource type. The - server generates this identifier. - type: string - format: uint64 - creationTimestamp: - description: '[Output Only] Creation timestamp in RFC3339 text format.' - 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])?' - annotations: - required: - - compute.publicDelegatedPrefixes.insert - type: string - description: - description: >- - An optional description of this resource. Provide this property when - you create the resource. - type: string - selfLink: - description: '[Output Only] Server-defined URL for the resource.' - type: string - 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 - ipCidrRange: + nodeTemplates: + description: '[Output Only] A list of node templates contained in this scope.' + type: array + items: + $ref: '#/components/schemas/NodeTemplate' + warning: description: >- - The IP address range, in CIDR format, represented by this public - delegated prefix. - type: string - status: - description: >- - [Output Only] The status of the public delegated prefix, which can - be one of following values: - `INITIALIZING` The public delegated - prefix is being initialized and addresses cannot be created yet. - - `READY_TO_ANNOUNCE` The public delegated prefix is a live migration - prefix and is active. - `ANNOUNCED` The public delegated prefix is - active. - `DELETING` The public delegated prefix is being - deprovsioned. - type: string - enumDescriptions: - - The public delegated prefix is active. - - The prefix is announced within Google network. - - The prefix is announced to Internet and within Google. - - The public delegated prefix is being deprovsioned. - - >- - The public delegated prefix is being initialized and addresses - cannot be created yet. - - >- - The public delegated prefix is currently withdrawn but ready to be - announced. - enum: - - ANNOUNCED - - ANNOUNCED_TO_GOOGLE - - ANNOUNCED_TO_INTERNET - - DELETING - - INITIALIZING - - READY_TO_ANNOUNCE - 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. - type: array - items: - $ref: '#/components/schemas/PublicDelegatedPrefixPublicDelegatedSubPrefix' - isLiveMigration: - description: If true, the prefix will be live migrated. - 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 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. - type: string - format: byte - mode: - description: The public delegated prefix mode for IPv6 only. - type: string - enumDescriptions: - - >- - The public delegated prefix is used for further sub-delegation - only. Such prefixes cannot set allocatablePrefixLength. - - >- - The public delegated prefix is used for creating forwarding rules - only. Such prefixes cannot set publicDelegatedSubPrefixes. - enum: - - DELEGATION - - EXTERNAL_IPV6_FORWARDING_RULE_CREATION - allocatablePrefixLength: - description: >- - The allocatable prefix length supported by this public delegated - prefix. This field is optional and cannot be set for prefixes in - DELEGATION mode. It cannot be set for IPv4 prefixes either, and it - always defaults to 32. - type: integer - format: int32 - byoipApiVersion: - description: '[Output Only] The version of BYOIP API.' - type: string - enumDescriptions: - - >- - This public delegated prefix usually takes 4 weeks to delete, and - the BGP status cannot be changed. Announce and Withdraw APIs can - not be used on this prefix. - - >- - This public delegated prefix takes minutes to delete. Announce and - Withdraw APIs can be used on this prefix to change the BGP status. - enum: - - V1 - - V2 - PublicDelegatedPrefixPublicDelegatedSubPrefix: - id: PublicDelegatedPrefixPublicDelegatedSubPrefix - description: Represents a sub PublicDelegatedPrefix. - type: object - properties: - name: - description: The name of the sub public delegated prefix. - type: string - description: - description: >- - An optional description of this resource. Provide this property when - you create the resource. - 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.' - type: string - enumDescriptions: - - '' - - '' - enum: - - ACTIVE - - INACTIVE - ipCidrRange: - description: >- - The IP address range, in CIDR format, represented by this sub public - delegated prefix. - type: string - delegateeProject: - description: Name of the project scoping this PublicDelegatedSubPrefix. - type: string - isAddress: - description: >- - Whether the sub prefix is delegated to create Address resources in - the delegatee project. - type: boolean - mode: - description: The PublicDelegatedSubPrefix mode for IPv6 only. - type: string - enumDescriptions: - - >- - The public delegated prefix is used for further sub-delegation - only. Such prefixes cannot set allocatablePrefixLength. - - >- - The public delegated prefix is used for creating forwarding rules - only. Such prefixes cannot set publicDelegatedSubPrefixes. - enum: - - DELEGATION - - EXTERNAL_IPV6_FORWARDING_RULE_CREATION - allocatablePrefixLength: - description: >- - The allocatable prefix length supported by this - PublicDelegatedSubPrefix. - type: integer - format: int32 - PublicDelegatedPrefixAggregatedList: - id: PublicDelegatedPrefixAggregatedList - type: object - properties: - kind: - description: >- - [Output Only] Type of the resource. Always - compute#publicDelegatedPrefixAggregatedList for aggregated lists of - public delegated prefixes. - default: compute#publicDelegatedPrefixAggregatedList - type: string - id: - description: >- - [Output Only] Unique identifier for the resource; defined by the - server. - type: string - items: - description: A list of PublicDelegatedPrefixesScopedList resources. - type: object - additionalProperties: - description: >- - [Output Only] Name of the scope containing this set of - PublicDelegatedPrefixes. - $ref: '#/components/schemas/PublicDelegatedPrefixesScopedList' - nextPageToken: - description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. - type: string - selfLink: - description: '[Output Only] Server-defined URL for this resource.' - type: string - warning: - description: '[Output Only] Informational warning message.' + [Output Only] An informational warning that appears when the node + templates list is empty. type: object properties: code: @@ -40844,6 +41117,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -40887,6 +41163,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -40909,6 +41186,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -40945,26 +41223,40 @@ components: [Output Only] A warning data value corresponding to the key. type: string - unreachables: - description: '[Output Only] Unreachable resources.' - type: array - items: - type: string - PublicDelegatedPrefixesScopedList: - id: PublicDelegatedPrefixesScopedList + NodeTypeList: + id: NodeTypeList + description: Contains a list of node types. type: object properties: - publicDelegatedPrefixes: + kind: description: >- - [Output Only] A list of PublicDelegatedPrefixes contained in this - scope. + [Output Only] Type of resource.Always compute#nodeTypeList for lists + of node types. + default: compute#nodeTypeList + type: string + id: + description: >- + [Output Only] Unique identifier for the resource; defined by the + server. + type: string + items: + description: A list of NodeType resources. type: array items: - $ref: '#/components/schemas/PublicDelegatedPrefix' - warning: + $ref: '#/components/schemas/NodeType' + nextPageToken: description: >- - [Output Only] Informational warning which replaces the list of - public delegated prefixes when the list is empty. + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. + type: string + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string + warning: + description: '[Output Only] Informational warning message.' type: object properties: code: @@ -41027,6 +41319,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -41070,6 +41365,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -41092,6 +41388,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -41128,16 +41425,83 @@ components: [Output Only] A warning data value corresponding to the key. type: string - RegionList: - id: RegionList - description: Contains a list of region resources. + NodeType: + id: 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. type: object properties: kind: description: >- - [Output Only] Type of resource. Always compute#regionList for lists - of regions. - default: compute#regionList + [Output Only] The type of the resource. Always compute#nodeType for + node types. + default: compute#nodeType + type: string + id: + description: >- + [Output Only] The unique identifier for the resource. This + identifier is defined by the server. + type: string + format: uint64 + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + name: + description: '[Output Only] Name of the resource.' + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + description: + description: '[Output Only] An optional textual description of the resource.' + type: string + cpuPlatform: + description: '[Output Only] The CPU platform used by this node type.' + type: string + guestCpus: + description: >- + [Output Only] The number of virtual CPUs that are available to the + node type. + type: integer + format: int32 + memoryMb: + description: >- + [Output Only] The amount of physical memory available to the node + type, defined in MB. + type: integer + format: int32 + localSsdGb: + description: '[Output Only] Local SSD available to the node type, defined in GB.' + type: integer + format: int32 + deprecated: + description: '[Output Only] The deprecation status associated with this node type.' + $ref: '#/components/schemas/DeprecationStatus' + zone: + description: >- + [Output Only] The name of the zone where the node type resides, such + as us-central1-a. + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + maxVms: + description: >- + [Output Only] Maximum number of VMs that can be created for this + node type. + type: integer + format: int32 + NodeTypeAggregatedList: + id: NodeTypeAggregatedList + type: object + properties: + kind: + description: >- + [Output Only] Type of resource.Always compute#nodeTypeAggregatedList + for aggregated lists of node types. + default: compute#nodeTypeAggregatedList type: string id: description: >- @@ -41145,10 +41509,11 @@ components: server. type: string items: - description: A list of Region resources. - type: array - items: - $ref: '#/components/schemas/Region' + description: A list of NodeTypesScopedList resources. + type: object + additionalProperties: + description: '[Output Only] Name of the scope containing this set of node types.' + $ref: '#/components/schemas/NodeTypesScopedList' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -41224,6 +41589,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -41267,6 +41635,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -41289,6 +41658,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -41325,69 +41695,24 @@ components: [Output Only] A warning data value corresponding to the key. type: string - Region: - id: Region - description: >- - Represents a Region resource. A region is a geographical area where a - resource is located. For more information, read Regions and Zones. - type: object - properties: - kind: - description: >- - [Output Only] Type of the resource. Always compute#region for - regions. - default: compute#region - type: string - id: - description: >- - [Output Only] The unique identifier for the resource. This - identifier is defined by the server. - type: string - format: uint64 - creationTimestamp: - description: '[Output Only] Creation timestamp in RFC3339 text format.' - type: string - name: - description: '[Output Only] Name of the resource.' - type: string - description: - description: '[Output Only] Textual description of the resource.' - type: string - status: - description: '[Output Only] Status of the region, either UP or DOWN.' - type: string - enumDescriptions: - - '' - - '' - enum: - - DOWN - - UP - zones: - description: >- - [Output Only] A list of zones available in this region, in the form - of resource URLs. + unreachables: + description: '[Output Only] Unreachable resources.' type: array items: type: string - quotas: - description: '[Output Only] Quotas assigned to this region.' + NodeTypesScopedList: + id: NodeTypesScopedList + type: object + properties: + nodeTypes: + description: '[Output Only] A list of node types contained in this scope.' type: array items: - $ref: '#/components/schemas/Quota' - deprecated: - description: '[Output Only] The deprecation status associated with this region.' - $ref: '#/components/schemas/DeprecationStatus' - selfLink: - description: '[Output Only] Server-defined URL for the resource.' - type: string - supportsPzs: - description: '[Output Only] Reserved for future use.' - type: boolean - quotaStatusWarning: + $ref: '#/components/schemas/NodeType' + warning: description: >- - [Output Only] Warning of fetching the `quotas` field for this - region. This field is populated only if fetching of the `quotas` - field fails. + [Output Only] An informational warning that appears when the node + types list is empty. type: object properties: code: @@ -41450,6 +41775,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -41493,6 +41821,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -41515,6 +41844,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -41551,26 +41881,26 @@ components: [Output Only] A warning data value corresponding to the key. type: string - ResourcePolicyList: - id: ResourcePolicyList + NotificationEndpointList: + id: NotificationEndpointList type: object properties: kind: description: >- - [Output Only] Type of resource.Always compute#resourcePoliciesList - for listsof resourcePolicies - default: compute#resourcePolicyList + [Output Only] Type of the resource. Always + compute#notificationEndpoint for notification endpoints. + default: compute#notificationEndpointList type: string id: description: >- - [Output Only] The unique identifier for the resource. This - identifier is defined by the server. + [Output Only] Unique identifier for the resource; defined by the + server. type: string items: - description: '[Output Only] A list of ResourcePolicy resources.' + description: A list of NotificationEndpoint resources. type: array items: - $ref: '#/components/schemas/ResourcePolicy' + $ref: '#/components/schemas/NotificationEndpoint' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -41579,6 +41909,9 @@ components: pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. type: string + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string warning: description: '[Output Only] Informational warning message.' type: object @@ -41643,6 +41976,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -41686,6 +42022,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -41708,6 +42045,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -41744,24 +42082,115 @@ components: [Output Only] A warning data value corresponding to the key. type: string + NotificationEndpoint: + id: 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. + type: object + properties: + kind: + description: >- + [Output Only] Type of the resource. Always + compute#notificationEndpoint for notification endpoints. + default: compute#notificationEndpoint + type: string + id: + description: >- + [Output Only] A unique identifier for this resource type. The server + generates this identifier. + type: string + format: uint64 + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + 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 + description: + description: >- + An optional description of this resource. Provide this property when + you create the resource. + type: string selfLink: - description: '[Output Only] Server-defined URL for this resource.' + description: '[Output Only] Server-defined URL for the resource.' type: string - etag: + 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 - ResourcePolicy: - id: ResourcePolicy + grpcSettings: + description: >- + Settings of the gRPC notification endpoint including the endpoint + URL and the retry duration. + $ref: '#/components/schemas/NotificationEndpointGrpcSettings' + NotificationEndpointGrpcSettings: + id: NotificationEndpointGrpcSettings 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. + Represents a gRPC setting that describes one gRPC notification endpoint + and the retry duration attempting to send notification to this endpoint. + type: object + properties: + endpoint: + description: >- + Endpoint to which gRPC notifications are sent. This must be a valid + gRPCLB DNS name. + type: string + 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. + type: integer + format: uint32 + payloadName: + description: >- + Optional. If specified, this field is used to populate the "name" + field in gRPC requests. + type: string + 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 + resendInterval: + 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. Can only be set for regional + notification endpoints. + $ref: '#/components/schemas/Duration' + PacketMirroring: + id: 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. type: object properties: kind: description: >- - [Output Only] Type of the resource. Always compute#resource_policies - for resource policies. - default: compute#resourcePolicy + [Output Only] Type of the resource. Always compute#packetMirroring + for packet mirrorings. + default: compute#packetMirroring type: string id: description: >- @@ -41773,344 +42202,210 @@ components: description: '[Output Only] Creation timestamp in RFC3339 text format.' type: string selfLink: - description: '[Output Only] Server-defined fully-qualified URL for this resource.' - type: string - region: - type: string - description: + description: '[Output Only] Server-defined URL for the resource.' 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. + 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])?' annotations: required: - - compute.instances.insert + - compute.packetMirrorings.insert type: string - snapshotSchedulePolicy: - description: Resource policy for persistent disks for creating snapshots. - $ref: '#/components/schemas/ResourcePolicySnapshotSchedulePolicy' - groupPlacementPolicy: - description: Resource policy for instances for placement configuration. - $ref: '#/components/schemas/ResourcePolicyGroupPlacementPolicy' - instanceSchedulePolicy: - description: Resource policy for scheduling instance operations. - $ref: '#/components/schemas/ResourcePolicyInstanceSchedulePolicy' - diskConsistencyGroupPolicy: - description: Resource policy for disk consistency groups. - $ref: '#/components/schemas/ResourcePolicyDiskConsistencyGroupPolicy' - status: - description: '[Output Only] The status of resource policy creation.' + description: + description: >- + An optional description of this resource. Provide this property when + you create the resource. + type: string + region: + description: '[Output Only] URI of the region where the packetMirroring resides.' + type: string + network: + 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. + annotations: + required: + - compute.packetMirrorings.insert + $ref: '#/components/schemas/PacketMirroringNetworkInfo' + 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. + type: integer + format: uint32 + collectorIlb: + 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. + $ref: '#/components/schemas/PacketMirroringForwardingRuleInfo' + mirroredResources: + 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. + $ref: '#/components/schemas/PacketMirroringMirroredResourceInfo' + filter: + description: >- + Filter for mirrored traffic. If unspecified, all IPv4 traffic is + mirrored. + $ref: '#/components/schemas/PacketMirroringFilter' + 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. type: string enumDescriptions: - - Resource policy is being created. - - Resource policy is being deleted. - - Resource policy is expired and will not run again. - '' - - Resource policy is ready to be used. + - '' enum: - - CREATING - - DELETING - - EXPIRED - - INVALID - - READY - resourceStatus: - description: '[Output Only] The system status of the resource policy.' - $ref: '#/components/schemas/ResourcePolicyResourceStatus' - ResourcePolicySnapshotSchedulePolicy: - id: 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. + - 'FALSE' + - 'TRUE' + PacketMirroringNetworkInfo: + id: PacketMirroringNetworkInfo type: object properties: - schedule: - 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. - $ref: '#/components/schemas/ResourcePolicySnapshotSchedulePolicySchedule' - retentionPolicy: - description: >- - Retention policy applied to snapshots created by this resource - policy. - $ref: >- - #/components/schemas/ResourcePolicySnapshotSchedulePolicyRetentionPolicy - snapshotProperties: + url: + description: URL of the network resource. + type: string + canonicalUrl: description: >- - Properties with which snapshots are created such as labels, - encryption keys. - $ref: >- - #/components/schemas/ResourcePolicySnapshotSchedulePolicySnapshotProperties - ResourcePolicySnapshotSchedulePolicySchedule: - id: ResourcePolicySnapshotSchedulePolicySchedule - description: A schedule for disks where the schedueled operations are performed. - type: object - properties: - hourlySchedule: - $ref: '#/components/schemas/ResourcePolicyHourlyCycle' - dailySchedule: - $ref: '#/components/schemas/ResourcePolicyDailyCycle' - weeklySchedule: - $ref: '#/components/schemas/ResourcePolicyWeeklyCycle' - ResourcePolicyHourlyCycle: - id: ResourcePolicyHourlyCycle - description: Time window specified for hourly operations. + [Output Only] Unique identifier for the network; defined by the + server. + type: string + PacketMirroringForwardingRuleInfo: + id: PacketMirroringForwardingRuleInfo type: object properties: - hoursInCycle: - description: >- - Defines a schedule with units measured in hours. The value - determines how many hours pass between the start of each cycle. - type: integer - format: int32 - startTime: + url: 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. + Resource URL to the forwarding rule representing the ILB configured + as destination of the mirrored traffic. type: string - duration: + canonicalUrl: description: >- - [Output only] Duration of the time window, automatically chosen to - be smallest possible in the given scenario. + [Output Only] Unique identifier for the forwarding rule; defined by + the server. type: string - ResourcePolicyDailyCycle: - id: ResourcePolicyDailyCycle - description: Time window specified for daily operations. + PacketMirroringMirroredResourceInfo: + id: PacketMirroringMirroredResourceInfo type: object properties: - daysInCycle: + subnetworks: description: >- - Defines a schedule with units measured in days. The value determines - how many days pass between the start of each cycle. - type: integer - format: int32 - startTime: + 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. + type: array + items: + $ref: '#/components/schemas/PacketMirroringMirroredResourceInfoSubnetInfo' + instances: 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 - duration: + 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. + type: array + items: + $ref: >- + #/components/schemas/PacketMirroringMirroredResourceInfoInstanceInfo + tags: description: >- - [Output only] A predetermined duration for the window, automatically - chosen to be the smallest possible in the given scenario. - type: string - ResourcePolicyWeeklyCycle: - id: ResourcePolicyWeeklyCycle - description: Time window specified for weekly operations. - type: object - properties: - dayOfWeeks: - description: Up to 7 intervals/windows, one for each day of the week. + A set of mirrored tags. Traffic from/to all VM instances that have + one or more of these tags will be mirrored. type: array items: - $ref: '#/components/schemas/ResourcePolicyWeeklyCycleDayOfWeek' - ResourcePolicyWeeklyCycleDayOfWeek: - id: ResourcePolicyWeeklyCycleDayOfWeek + type: string + PacketMirroringMirroredResourceInfoSubnetInfo: + id: PacketMirroringMirroredResourceInfoSubnetInfo type: object 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. - type: string - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - enum: - - FRIDAY - - INVALID - - MONDAY - - SATURDAY - - SUNDAY - - THURSDAY - - TUESDAY - - WEDNESDAY - startTime: + url: 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. + Resource URL to the subnetwork for which traffic from/to all VM + instances will be mirrored. type: string - duration: + canonicalUrl: description: >- - [Output only] Duration of the time window, automatically chosen to - be smallest possible in the given scenario. + [Output Only] Unique identifier for the subnetwork; defined by the + server. type: string - ResourcePolicySnapshotSchedulePolicyRetentionPolicy: - id: ResourcePolicySnapshotSchedulePolicyRetentionPolicy - description: Policy for retention of scheduled snapshots. + PacketMirroringMirroredResourceInfoInstanceInfo: + id: PacketMirroringMirroredResourceInfoInstanceInfo type: object properties: - maxRetentionDays: - description: Maximum age of the snapshot that is allowed to be kept. - type: integer - format: int32 - onSourceDiskDelete: + url: description: >- - Specifies the behavior to apply to scheduled snapshots when the - source disk is deleted. + Resource URL to the virtual machine instance which is being + mirrored. type: string - enumDescriptions: - - '' - - '' - - '' - enum: - - APPLY_RETENTION_POLICY - - KEEP_AUTO_SNAPSHOTS - - UNSPECIFIED_ON_SOURCE_DISK_DELETE - ResourcePolicySnapshotSchedulePolicySnapshotProperties: - id: ResourcePolicySnapshotSchedulePolicySnapshotProperties - description: >- - Specified snapshot properties for scheduled snapshots created by this - policy. + canonicalUrl: + description: >- + [Output Only] Unique identifier for the instance; defined by the + server. + type: string + PacketMirroringFilter: + id: PacketMirroringFilter type: object properties: - labels: + cidrRanges: description: >- - Labels to apply to scheduled snapshots. These can be later modified - by the setLabels method. Label values may be empty. - type: object - additionalProperties: + One or more IPv4 or IPv6 CIDR ranges that apply as filters on the + source (ingress) or destination (egress) IP in the IP header. If no + ranges are specified, all IPv4 traffic that matches the specified + IPProtocols is mirrored. If neither cidrRanges nor IPProtocols is + specified, all IPv4 traffic is mirrored. To mirror all IPv4 and IPv6 + traffic, use "0.0.0.0/0,::/0". + type: array + items: type: string - storageLocations: + IPProtocols: description: >- - Cloud Storage bucket storage location of the auto snapshot (regional - or multi-regional). + 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 + IPv4 traffic is mirrored. type: array items: type: string - guestFlush: - description: Indication to perform a 'guest aware' snapshot. - type: boolean - chainName: - description: Chain name that the snapshot is created in. - type: string - ResourcePolicyGroupPlacementPolicy: - id: ResourcePolicyGroupPlacementPolicy - description: >- - A GroupPlacementPolicy specifies resource placement configuration. It - specifies the failure bucket separation - type: object - properties: - vmCount: - description: >- - Number of VMs in this placement group. Google does not recommend - that you use this field unless you use a compact policy and you want - your policy to work only if it contains this exact number of VMs. - type: integer - format: int32 - availabilityDomainCount: + direction: description: >- - The number of availability domains to spread instances across. If - two instances are in different availability domain, they are not in - the same low latency network. - type: integer - format: int32 - collocation: - description: Specifies network collocation + Direction of traffic to mirror, either INGRESS, EGRESS, or BOTH. The + default is BOTH. type: string enumDescriptions: - - '' - - '' + - Default, both directions are mirrored. + - Only egress traffic is mirrored. + - Only ingress traffic is mirrored. enum: - - COLLOCATED - - UNSPECIFIED_COLLOCATION - ResourcePolicyInstanceSchedulePolicy: - id: ResourcePolicyInstanceSchedulePolicy - description: >- - An InstanceSchedulePolicy specifies when and how frequent certain - operations are performed on the instance. + - BOTH + - EGRESS + - INGRESS + PacketMirroringList: + id: PacketMirroringList + description: Contains a list of PacketMirroring resources. type: object properties: - vmStartSchedule: - description: Specifies the schedule for starting instances. - $ref: '#/components/schemas/ResourcePolicyInstanceSchedulePolicySchedule' - vmStopSchedule: - description: Specifies the schedule for stopping instances. - $ref: '#/components/schemas/ResourcePolicyInstanceSchedulePolicySchedule' - timeZone: + kind: 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: https://wikipedia.org/wiki/Tz_database. - type: string - startTime: - description: The start time of the schedule. The timestamp is an RFC3339 string. - type: string - expirationTime: - description: >- - The expiration time of the schedule. The timestamp is an RFC3339 - string. - type: string - ResourcePolicyInstanceSchedulePolicySchedule: - id: ResourcePolicyInstanceSchedulePolicySchedule - description: Schedule for an instance operation. - type: object - properties: - schedule: - description: >- - Specifies the frequency for the operation, using the unix-cron - format. - type: string - ResourcePolicyDiskConsistencyGroupPolicy: - id: ResourcePolicyDiskConsistencyGroupPolicy - description: Resource policy for disk consistency groups. - type: object - properties: {} - ResourcePolicyResourceStatus: - id: 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. - type: object - properties: - instanceSchedulePolicy: - 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. - $ref: >- - #/components/schemas/ResourcePolicyResourceStatusInstanceSchedulePolicyStatus - ResourcePolicyResourceStatusInstanceSchedulePolicyStatus: - id: ResourcePolicyResourceStatusInstanceSchedulePolicyStatus - type: object - properties: - 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 - lastRunStartTime: - description: >- - [Output Only] The last time the schedule successfully ran. The - timestamp is an RFC3339 string. - type: string - ResourcePolicyAggregatedList: - id: ResourcePolicyAggregatedList - description: Contains a list of resourcePolicies. - type: object - properties: - kind: - description: Type of resource. - default: compute#resourcePolicyAggregatedList + [Output Only] Type of resource. Always compute#packetMirroring for + packetMirrorings. + default: compute#packetMirroringList type: string id: description: >- @@ -42118,11 +42413,10 @@ components: server. type: string items: - description: A list of ResourcePolicy resources. - type: object - additionalProperties: - description: Name of the scope containing this set of resourcePolicies. - $ref: '#/components/schemas/ResourcePoliciesScopedList' + description: A list of PacketMirroring resources. + type: array + items: + $ref: '#/components/schemas/PacketMirroring' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -42198,6 +42492,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -42241,6 +42538,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -42263,6 +42561,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -42299,26 +42598,39 @@ components: [Output Only] A warning data value corresponding to the key. type: string - etag: - type: string - unreachables: - description: '[Output Only] Unreachable resources.' - type: array - items: - type: string - ResourcePoliciesScopedList: - id: ResourcePoliciesScopedList + PacketMirroringAggregatedList: + id: PacketMirroringAggregatedList + description: Contains a list of packetMirrorings. type: object properties: - resourcePolicies: - description: A list of resourcePolicies contained in this scope. - type: array - items: - $ref: '#/components/schemas/ResourcePolicy' - warning: + kind: + description: Type of resource. + default: compute#packetMirroringAggregatedList + type: string + id: description: >- - Informational warning which replaces the list of resourcePolicies - when the list is empty. + [Output Only] Unique identifier for the resource; defined by the + server. + type: string + items: + description: A list of PacketMirroring resources. + type: object + additionalProperties: + description: Name of the scope containing this set of packetMirrorings. + $ref: '#/components/schemas/PacketMirroringsScopedList' + nextPageToken: + description: >- + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. + type: string + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string + warning: + description: '[Output Only] Informational warning message.' type: object properties: code: @@ -42381,6 +42693,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -42424,6 +42739,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -42446,6 +42762,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -42482,38 +42799,24 @@ components: [Output Only] A warning data value corresponding to the key. type: string - RouteList: - id: RouteList - description: Contains a list of Route resources. + unreachables: + description: '[Output Only] Unreachable resources.' + type: array + items: + type: string + PacketMirroringsScopedList: + id: PacketMirroringsScopedList type: object properties: - kind: - description: Type of resource. - default: compute#routeList - type: string - id: - description: >- - [Output Only] Unique identifier for the resource; defined by the - server. - type: string - items: - description: A list of Route resources. + packetMirrorings: + description: A list of packetMirrorings contained in this scope. type: array items: - $ref: '#/components/schemas/Route' - nextPageToken: - description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. - type: string - selfLink: - description: '[Output Only] Server-defined URL for this resource.' - type: string + $ref: '#/components/schemas/PacketMirroring' warning: - description: '[Output Only] Informational warning message.' + description: >- + Informational warning which replaces the list of packetMirrorings + when the list is empty. type: object properties: code: @@ -42576,6 +42879,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -42619,6 +42925,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -42641,6 +42948,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -42677,25 +42985,26 @@ components: [Output Only] A warning data value corresponding to the key. type: string - Route: - id: Route + Project: + id: Project 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. + 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. type: object properties: kind: description: >- - [Output Only] Type of this resource. Always compute#routes for Route - resources. - default: compute#route + [Output Only] Type of the resource. Always compute#project for + projects. + default: compute#project type: string id: description: >- [Output Only] The unique identifier for the resource. This - identifier is defined by the server. + 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. type: string format: uint64 creationTimestamp: @@ -42703,345 +43012,80 @@ components: 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])?' - annotations: - required: - - compute.routes.insert + The project ID. For example: my-example-project. Use the project ID + to make requests to Compute Engine. type: string description: - description: >- - An optional description of this resource. Provide this field when - you create the resource. - type: string - network: - description: Fully-qualified URL of the network that this route applies to. - annotations: - required: - - compute.routes.insert + description: An optional textual description of the resource. type: string - tags: - description: A list of instance tags to which this route applies. - annotations: - required: - - compute.routes.insert + commonInstanceMetadata: + description: >- + Metadata key/value pairs available to all instances contained in + this project. See Custom metadata for more information. + $ref: '#/components/schemas/Metadata' + quotas: + description: '[Output Only] Quotas assigned to this project.' type: array items: - type: string - destRange: - description: >- - The destination range of outgoing packets that this route applies - to. Both IPv4 and IPv6 are supported. Must specify an IPv4 range - (e.g. 192.0.2.0/24) or an IPv6 range in RFC 4291 format (e.g. - 2001:db8::/32). IPv6 range will be displayed using RFC 5952 - compressed format. - annotations: - required: - - compute.routes.insert - 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. - annotations: - required: - - compute.routes.insert - type: integer - format: uint32 - 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. Both IPv6 address and IPv4 addresses are supported. Must - specify an IPv4 address in dot-decimal notation (e.g. 192.0.2.99) or - an IPv6 address in RFC 4291 format (e.g. 2001:db8::2d9:51:0:0 or - 2001:db8:0:0:2d9:51:0:0). IPv6 addresses will be displayed using RFC - 5952 compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be - an IPv4-mapped IPv6 address. - type: string - nextHopNetwork: - description: The URL of the local network if it should handle matching packets. - 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 - nextHopPeering: - description: >- - [Output Only] The network peering name that should handle matching - packets, which should conform to RFC1035. - type: string - nextHopIlb: + $ref: '#/components/schemas/Quota' + usageExportLocation: 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: - - https://www.googleapis.com/compute/v1/projects/project/regions/region - /forwardingRules/forwardingRule - - regions/region/forwardingRules/forwardingRule If an IP address is - provided, must specify an IPv4 address in dot-decimal notation or an - IPv6 address in RFC 4291 format. For example, the following are all - valid IP addresses: - 10.128.0.56 - 2001:db8::2d9:51:0:0 - - 2001:db8:0:0:2d9:51:0:0 IPv6 addresses will be displayed using RFC - 5952 compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be - an IPv4-mapped IPv6 address. - type: string - warnings: + An optional naming prefix for daily usage reports and the Google + Cloud Storage bucket where they are stored. + $ref: '#/components/schemas/UsageExportLocation' + enabledFeatures: description: >- - [Output Only] If potential misconfigurations are detected for this - route, this field will be populated with warning messages. + An optional list of restricted features enabled for use on this + project. type: array items: - type: object - properties: - code: - description: >- - [Output Only] A warning code, if applicable. For example, - Compute Engine returns NO_RESULTS_ON_PAGE if there are no - results in the response. - type: string - enumDescriptions: - - >- - Warning about failed cleanup of transient changes made by a - failed operation. - - A link to a deprecated resource was created. - - >- - When deploying and at least one of the resources has a type - marked as deprecated - - The user created a boot disk that is larger than image size. - - >- - When deploying and at least one of the resources has a type - marked as experimental - - Warning that is present in an external api call - - >- - Warning that value of a field has been overridden. - Deprecated unused field. - - >- - The operation involved use of an injected kernel, which is - deprecated. - - >- - A WEIGHTED_MAGLEV backend service is associated with a - health check that is not of type HTTP/HTTPS/HTTP2. - - >- - When deploying a deployment with a exceedingly large number - of resources - - >- - Resource can't be retrieved due to list overhead quota - exceed which captures the amount of resources filtered out - by user-defined list filter. - - A resource depends on a missing type - - >- - The route's nextHopIp address is not assigned to an instance - on the network. - - The route's next hop instance cannot ip forward. - - >- - The route's nextHopInstance URL refers to an instance that - does not have an ipv6 interface on the same network as the - route. - - >- - The route's nextHopInstance URL refers to an instance that - does not exist. - - >- - The route's nextHopInstance URL refers to an instance that - is not on the same network as the route. - - >- - The route's next hop instance does not have a status of - RUNNING. - - >- - Error which is not critical. We decided to continue the - process despite the mentioned error. - - No results are present on a particular list page. - - >- - Success is reported, but some results may be missing due to - errors - - >- - The user attempted to use a resource that requires a TOS - they have not accepted. - - Warning that a resource is in use. - - >- - One or more of the resources set to auto-delete could not be - deleted because they were in use. - - When a resource schema validation is ignored. - - >- - Instance template used in instance group manager is valid as - such, but its application does not make a lot of sense, - because it allows only single instance in instance group. - - When undeclared properties in the schema are present - - A given scope cannot be reached. - enumDeprecated: - - false - - false - - false - - false - - false - - false - - true - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - enum: - - CLEANUP_FAILED - - DEPRECATED_RESOURCE_USED - - DEPRECATED_TYPE_USED - - DISK_SIZE_LARGER_THAN_IMAGE_SIZE - - EXPERIMENTAL_TYPE_USED - - EXTERNAL_API_WARNING - - FIELD_VALUE_OVERRIDEN - - INJECTED_KERNELS_DEPRECATED - - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB - - LARGE_DEPLOYMENT_WARNING - - LIST_OVERHEAD_QUOTA_EXCEED - - MISSING_TYPE_DEPENDENCY - - NEXT_HOP_ADDRESS_NOT_ASSIGNED - - NEXT_HOP_CANNOT_IP_FORWARD - - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE - - NEXT_HOP_INSTANCE_NOT_FOUND - - NEXT_HOP_INSTANCE_NOT_ON_NETWORK - - NEXT_HOP_NOT_RUNNING - - NOT_CRITICAL_ERROR - - NO_RESULTS_ON_PAGE - - PARTIAL_SUCCESS - - REQUIRED_TOS_AGREEMENT - - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - - RESOURCE_NOT_DELETED - - SCHEMA_VALIDATION_IGNORED - - SINGLE_INSTANCE_PROPERTY_TEMPLATE - - UNDECLARED_PROPERTIES - - UNREACHABLE - message: - description: >- - [Output Only] A human-readable description of the warning - code. - type: string - data: - description: >- - [Output Only] Metadata about this warning in key: value - format. For example: "data": [ { "key": "scope", "value": - "zones/us-east1-d" } - type: array - items: - type: object - properties: - key: - description: >- - [Output Only] A key that provides more detail on the - warning being returned. For example, for warnings where - there are no results in a list request for a particular - zone, this key might be scope and the key value might be - the zone name. Other examples might be a key indicating - a deprecated resource and a suggested replacement, or a - warning about invalid network settings (for example, if - an instance attempts to perform IP forwarding but is not - enabled for IP forwarding). - type: string - value: - description: >- - [Output Only] A warning data value corresponding to the - key. - type: string - nextHopVpnTunnel: - description: The URL to a VpnTunnel that should handle matching packets. + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' type: string - nextHopHub: + defaultServiceAccount: description: >- - [Output Only] The full resource name of the Network Connectivity - Center hub that will handle matching packets. - type: string - selfLink: - description: '[Output Only] Server-defined fully-qualified URL for this resource.' + [Output Only] Default service account used by VMs running in this + project. type: string - routeType: + xpnProjectStatus: 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 + [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. type: string enumDescriptions: - '' - '' - - '' - - '' enum: - - BGP - - STATIC - - SUBNET - - TRANSIT - asPaths: - description: '[Output Only] AS path.' - type: array - items: - $ref: '#/components/schemas/RouteAsPath' - routeStatus: - description: '[Output only] The status of the route.' + - HOST + - UNSPECIFIED_XPN_PROJECT_STATUS + 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. type: string enumDescriptions: - - This route is processed and active. + - Public internet quality with fixed bandwidth. - >- - The route is dropped due to the VPC exceeding the dynamic route - limit. For dynamic route limit, please refer to the Learned route - example + High quality, Google-grade network tier, support for all + networking products. - >- - This route is processed but inactive due to failure from the - backend. The backend may have rejected the route + Public internet quality, only limited support for other networking + products. - >- - This route is being processed internally. The status will change - once processed. + (Output only) Temporary tier for FIXED_STANDARD when fixed + standard tier is expired or not configured. enum: - - ACTIVE - - DROPPED - - INACTIVE - - PENDING - RouteAsPath: - id: RouteAsPath - type: object - properties: - pathSegmentType: + - FIXED_STANDARD + - PREMIUM + - STANDARD + - STANDARD_OVERRIDES_FIXED_STANDARD + vmDnsSetting: 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 + [Output Only] Default internal DNS setting used by VMs running in + this project. type: string enumDescriptions: - '' @@ -43049,920 +43093,471 @@ components: - '' - '' enum: - - AS_CONFED_SEQUENCE - - AS_CONFED_SET - - AS_SEQUENCE - - AS_SET - asLists: - description: '[Output Only] The AS numbers of the AS Path.' - type: array - items: - type: integer - format: uint32 - Router: - id: Router - description: >- - Represents a Cloud Router resource. For more information about Cloud - Router, read the Cloud Router overview. - type: object - properties: - kind: - description: '[Output Only] Type of resource. Always compute#router for routers.' - default: compute#router - type: string - id: - description: >- - [Output Only] The unique identifier for the resource. This - identifier is defined by the server. - type: string - format: uint64 - creationTimestamp: - description: '[Output Only] Creation timestamp in RFC3339 text format.' - 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])?' - annotations: - required: - - compute.routers.insert - type: string - description: - description: >- - An optional description of this resource. Provide this property when - you create the resource. - 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 - network: - description: URI of the network to which this router belongs. - annotations: - required: - - compute.routers.insert - - compute.routers.update - type: string - interfaces: - description: >- - Router interfaces. To create a BGP peer that uses a router - interface, the interface must have one of the following fields - specified: - linkedVpnTunnel - linkedInterconnectAttachment - - subnetwork You can create a router interface without any of these - fields specified. However, you cannot create a BGP peer that uses - that interface. - type: array - items: - $ref: '#/components/schemas/RouterInterface' - 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. - type: array - items: - $ref: '#/components/schemas/RouterBgpPeer' - bgp: - description: BGP information specific to this router. - $ref: '#/components/schemas/RouterBgp' - selfLink: - description: '[Output Only] Server-defined URL for the resource.' - type: string - nats: - description: A list of NAT services created in this router. - type: array - items: - $ref: '#/components/schemas/RouterNat' - encryptedInterconnectRouter: - description: >- - Indicates if a router is dedicated for use with encrypted VLAN - attachments (interconnectAttachments). - type: boolean - md5AuthenticationKeys: - description: Keys used for MD5 authentication. - type: array - items: - $ref: '#/components/schemas/RouterMd5AuthenticationKey' - RouterInterface: - id: RouterInterface - type: object - properties: - 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])?' - annotations: - required: - - compute.routers.insert - 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 subnetwork. - 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 - subnetwork. - type: string - ipRange: - description: >- - IP address and range of the interface. - For Internet Protocol - version 4 (IPv4), 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 IP address, as it - represents the IP address of the interface. - For Internet Protocol - version 6 (IPv6), the value must be a unique local address (ULA) - range from fdff:1::/64 with a mask length of 126 or less. This value - should be a CIDR-formatted string, for example, fc00:0:1:1::1/112. - Within the router's VPC, this IPv6 prefix will be reserved - exclusively for this connection and cannot be used for any other - purpose. - 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. - type: string - enumDescriptions: - - >- - The interface is automatically created for PARTNER type - InterconnectAttachment, Google will automatically - create/update/delete this interface when the PARTNER - InterconnectAttachment is created/provisioned/deleted. This type - of interface cannot be manually managed by user. - - >- - Default value, the interface is manually created and managed by - user. - enum: - - MANAGED_BY_ATTACHMENT - - MANAGED_BY_USER - 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: + - GLOBAL_DEFAULT + - UNSPECIFIED_VM_DNS_SETTING + - ZONAL_DEFAULT + - ZONAL_ONLY + cloudArmorTier: 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 - ipVersion: - description: IP version of this interface. + [Output Only] The Cloud Armor tier for this project. It can be one + of the following values: CA_STANDARD, CA_ENTERPRISE_PAYGO. If this + field is not specified, it is assumed to be CA_STANDARD. type: string enumDescriptions: - - '' - - '' + - Enterprise tier protection billed annually. + - Enterprise tier protection billed monthly. + - Standard protection. enum: - - IPV4 - - IPV6 - RouterBgpPeer: - id: RouterBgpPeer + - CA_ENTERPRISE_ANNUAL + - CA_ENTERPRISE_PAYGO + - CA_STANDARD + Quota: + id: Quota + description: A quotas entry. type: object properties: - 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])?' - annotations: - required: - - compute.routers.insert - 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. - type: string - peerIpAddress: - description: IP address of the BGP interface outside Google Cloud Platform. - type: string - peerAsn: - description: >- - Peer BGP Autonomous System Number (ASN). Each BGP interface may use - a different value. - annotations: - required: - - compute.routers.insert - type: integer - format: uint32 - 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. - type: integer - format: uint32 - advertiseMode: - description: User-specified flag to indicate which mode to use for advertisement. + metric: + description: '[Output Only] Name of the quota metric.' type: string enumDescriptions: - '' - '' - enum: - - CUSTOM - - DEFAULT - advertisedGroups: - description: >- - User-specified list of prefix groups to advertise in custom mode, - which currently supports the following option: - ALL_SUBNETS: - Advertises all of the router's own VPC subnets. This excludes any - routes learned for subnets that use VPC Network Peering. 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. - type: array - items: - type: string - enumDescriptions: - - Advertise all available subnets (including peer VPC subnets). - enum: - - ALL_SUBNETS - 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. - type: array - items: - $ref: '#/components/schemas/RouterAdvertisedIpRange' - 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. - type: string - enumDescriptions: - - >- - The BGP peer is automatically created for PARTNER type - InterconnectAttachment; Google will automatically create/delete - this BGP peer when the PARTNER InterconnectAttachment is - created/deleted, and Google will update the ipAddress and - peerIpAddress when the PARTNER InterconnectAttachment is - provisioned. This type of BGP peer cannot be created or deleted, - but can be modified for all fields except for name, ipAddress and - peerIpAddress. - - >- - Default value, the BGP peer is manually created and managed by - user. - enum: - - MANAGED_BY_ATTACHMENT - - MANAGED_BY_USER - 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. - type: string - enumDescriptions: - '' - '' - enum: - - 'FALSE' - - 'TRUE' - bfd: - description: BFD configuration for the BGP peering. - $ref: '#/components/schemas/RouterBgpPeerBfd' - 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 - enableIpv6: - description: >- - Enable IPv6 traffic over BGP Peer. It is enabled by default if the - peerIpAddress is version 6. - type: boolean - ipv6NexthopAddress: - description: IPv6 address of the interface inside Google Cloud Platform. - type: string - peerIpv6NexthopAddress: - description: IPv6 address of the BGP interface outside Google Cloud Platform. - type: string - md5AuthenticationKeyName: - description: >- - Present if MD5 authentication is enabled for the peering. Must be - the name of one of the entries in the - Router.md5_authentication_keys. The field must comply with RFC1035. - type: string - customLearnedRoutePriority: - description: >- - The user-defined custom learned route priority for a BGP session. - This value is applied to all custom learned route ranges for the - session. You can choose a value from `0` to `65335`. If you don't - provide a value, Google Cloud assigns a priority of `100` to the - ranges. - type: integer - format: int32 - customLearnedIpRanges: - description: >- - A list of user-defined custom learned route IP address ranges for a - BGP session. - type: array - items: - $ref: '#/components/schemas/RouterBgpPeerCustomLearnedIpRange' - enableIpv4: - description: >- - Enable IPv4 traffic over BGP Peer. It is enabled by default if the - peerIpAddress is version 4. - type: boolean - ipv4NexthopAddress: - description: IPv4 address of the interface inside Google Cloud Platform. - type: string - peerIpv4NexthopAddress: - description: IPv4 address of the BGP interface outside Google Cloud Platform. - type: string - exportPolicies: - description: >- - List of export policies applied to this peer, in the order they must - be evaluated. The name must correspond to an existing policy that - has ROUTE_POLICY_TYPE_EXPORT type. Note that Route Policies are - currently available in preview. Please use Beta API to use Route - Policies. - type: array - items: - type: string - importPolicies: - description: >- - List of import policies applied to this peer, in the order they must - be evaluated. The name must correspond to an existing policy that - has ROUTE_POLICY_TYPE_IMPORT type. Note that Route Policies are - currently available in preview. Please use Beta API to use Route - Policies. - type: array - items: - type: string - RouterAdvertisedIpRange: - id: RouterAdvertisedIpRange - description: Description-tagged IP ranges for the router to advertise. - type: object - properties: - range: - description: >- - The IP range to advertise. The value must be a CIDR-formatted - string. - type: string - description: - description: User-specified description for the IP range. - type: string - RouterBgpPeerBfd: - id: RouterBgpPeerBfd - type: object - properties: - 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 - DISABLED. - type: string - enumDescriptions: - '' - '' - '' - enum: - - ACTIVE - - DISABLED - - PASSIVE - 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. - type: integer - format: uint32 - 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. - type: integer - format: uint32 - 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. - type: integer - format: uint32 - RouterBgpPeerCustomLearnedIpRange: - id: RouterBgpPeerCustomLearnedIpRange - type: object - properties: - range: - description: >- - The custom learned route IP address range. Must be a valid - CIDR-formatted prefix. If an IP address is provided without a subnet - mask, it is interpreted as, for IPv4, a `/32` singular IP address - range, and, for IPv6, `/128`. - type: string - RouterBgp: - id: RouterBgp - type: object - properties: - 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. - type: integer - format: uint32 - advertiseMode: - description: >- - User-specified flag to indicate which mode to use for advertisement. - The options are DEFAULT or CUSTOM. - type: string - enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - Guest CPUs + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - The total number of snapshots allowed for a single project. + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' - '' - '' enum: - - CUSTOM - - DEFAULT - advertisedGroups: + - 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_M3_CPUS + - COMMITTED_MEMORY_OPTIMIZED_CPUS + - COMMITTED_N2A_CPUS + - COMMITTED_N2D_CPUS + - COMMITTED_N2_CPUS + - COMMITTED_NVIDIA_A100_80GB_GPUS + - COMMITTED_NVIDIA_A100_GPUS + - COMMITTED_NVIDIA_H100_GPUS + - COMMITTED_NVIDIA_K80_GPUS + - COMMITTED_NVIDIA_L4_GPUS + - COMMITTED_NVIDIA_P100_GPUS + - COMMITTED_NVIDIA_P4_GPUS + - COMMITTED_NVIDIA_T4_GPUS + - COMMITTED_NVIDIA_V100_GPUS + - COMMITTED_T2A_CPUS + - COMMITTED_T2D_CPUS + - COMMITTED_Z3_CPUS + - CPUS + - CPUS_ALL_REGIONS + - DISKS_TOTAL_GB + - E2_CPUS + - EXTERNAL_MANAGED_FORWARDING_RULES + - EXTERNAL_NETWORK_LB_FORWARDING_RULES + - EXTERNAL_PROTOCOL_FORWARDING_RULES + - EXTERNAL_VPN_GATEWAYS + - FIREWALLS + - FORWARDING_RULES + - GLOBAL_EXTERNAL_MANAGED_BACKEND_SERVICES + - GLOBAL_EXTERNAL_MANAGED_FORWARDING_RULES + - GLOBAL_EXTERNAL_PROXY_LB_BACKEND_SERVICES + - GLOBAL_INTERNAL_ADDRESSES + - GLOBAL_INTERNAL_MANAGED_BACKEND_SERVICES + - GLOBAL_INTERNAL_TRAFFIC_DIRECTOR_BACKEND_SERVICES + - GPUS_ALL_REGIONS + - HDB_TOTAL_GB + - HDB_TOTAL_IOPS + - HDB_TOTAL_THROUGHPUT + - 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 + - M3_CPUS + - MACHINE_IMAGES + - N2A_CPUS + - N2D_CPUS + - N2_CPUS + - NETWORKS + - NETWORK_ATTACHMENTS + - NETWORK_ENDPOINT_GROUPS + - NETWORK_FIREWALL_POLICIES + - NET_LB_SECURITY_POLICIES_PER_REGION + - NET_LB_SECURITY_POLICY_RULES_PER_REGION + - NET_LB_SECURITY_POLICY_RULE_ATTRIBUTES_PER_REGION + - NODE_GROUPS + - NODE_TEMPLATES + - NVIDIA_A100_80GB_GPUS + - NVIDIA_A100_GPUS + - NVIDIA_K80_GPUS + - NVIDIA_L4_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_80GB_GPUS + - PREEMPTIBLE_NVIDIA_A100_GPUS + - PREEMPTIBLE_NVIDIA_H100_GPUS + - PREEMPTIBLE_NVIDIA_K80_GPUS + - PREEMPTIBLE_NVIDIA_L4_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 + - PREEMPTIBLE_TPU_LITE_DEVICE_V5 + - PREEMPTIBLE_TPU_LITE_PODSLICE_V5 + - PREEMPTIBLE_TPU_PODSLICE_V4 + - PSC_ILB_CONSUMER_FORWARDING_RULES_PER_PRODUCER_NETWORK + - PSC_INTERNAL_LB_FORWARDING_RULES + - PUBLIC_ADVERTISED_PREFIXES + - PUBLIC_DELEGATED_PREFIXES + - REGIONAL_AUTOSCALERS + - REGIONAL_EXTERNAL_MANAGED_BACKEND_SERVICES + - REGIONAL_EXTERNAL_NETWORK_LB_BACKEND_SERVICES + - REGIONAL_INSTANCE_GROUP_MANAGERS + - REGIONAL_INTERNAL_LB_BACKEND_SERVICES + - REGIONAL_INTERNAL_MANAGED_BACKEND_SERVICES + - REGIONAL_INTERNAL_TRAFFIC_DIRECTOR_BACKEND_SERVICES + - RESERVATIONS + - RESOURCE_POLICIES + - ROUTERS + - ROUTES + - SECURITY_POLICIES + - SECURITY_POLICIES_PER_REGION + - SECURITY_POLICY_ADVANCED_RULES_PER_REGION + - SECURITY_POLICY_CEVAL_RULES + - SECURITY_POLICY_RULES + - SECURITY_POLICY_RULES_PER_REGION + - SERVICE_ATTACHMENTS + - SNAPSHOTS + - SSD_TOTAL_GB + - SSL_CERTIFICATES + - SSL_POLICIES + - STATIC_ADDRESSES + - STATIC_BYOIP_ADDRESSES + - STATIC_EXTERNAL_IPV6_ADDRESS_RANGES + - SUBNETWORKS + - T2A_CPUS + - T2D_CPUS + - TARGET_HTTPS_PROXIES + - TARGET_HTTP_PROXIES + - TARGET_INSTANCES + - TARGET_POOLS + - TARGET_SSL_PROXIES + - TARGET_TCP_PROXIES + - TARGET_VPN_GATEWAYS + - TPU_LITE_DEVICE_V5 + - TPU_LITE_PODSLICE_V5 + - TPU_PODSLICE_V4 + - URL_MAPS + - VARIABLE_IPV6_PUBLIC_DELEGATED_PREFIXES + - VPN_GATEWAYS + - VPN_TUNNELS + - XPN_SERVICE_PROJECTS + limit: + description: '[Output Only] Quota limit for this metric.' + type: number + format: double + usage: + description: '[Output Only] Current usage of this metric.' + type: number + format: double + owner: 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. - type: array - items: - type: string - enumDescriptions: - - Advertise all available subnets (including peer VPC subnets). - enum: - - ALL_SUBNETS - advertisedIpRanges: + [Output Only] Owning resource. This is the resource on which this + quota is applied. + type: string + UsageExportLocation: + id: UsageExportLocation + description: >- + The location in Cloud Storage and naming method of the daily usage + report. Contains bucket_name and report_name prefix. + type: object + properties: + bucketName: 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. - type: array - items: - $ref: '#/components/schemas/RouterAdvertisedIpRange' - keepaliveInterval: + 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: >- - 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. - type: integer - format: uint32 - identifierRange: + 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 + InstanceMoveRequest: + id: InstanceMoveRequest + type: object + properties: + targetInstance: description: >- - Explicitly specifies a range of valid BGP Identifiers for this - Router. It is provided as a link-local IPv4 range (from - 169.254.0.0/16), of size at least /30, even if the BGP sessions are - over IPv6. It must not overlap with any IPv4 BGP session ranges. - Other vendors commonly call this "router ID". + 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 - RouterNat: - id: 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. + 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 + DiskMoveRequest: + id: DiskMoveRequest type: object properties: - name: + targetDisk: 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])?' + 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: + destinationZone: description: >- - Indicates whether this NAT is used for public or private IP - translation. If unspecified, it defaults to PUBLIC. + 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 - enumDescriptions: - - NAT used for private IP translation. - - NAT used for public IP translation. This is the default. - enum: - - PRIVATE - - PUBLIC - autoNetworkTier: + ProjectsListXpnHostsRequest: + id: ProjectsListXpnHostsRequest + type: object + properties: + organization: description: >- - The network tier to use when automatically reserving NAT IP - addresses. Must be one of: PREMIUM, STANDARD. If not specified, then - the current project-level default tier is used. + 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 - enumDescriptions: - - Public internet quality with fixed bandwidth. - - >- - High quality, Google-grade network tier, support for all - networking products. - - >- - Public internet quality, only limited support for other networking - products. - - >- - (Output only) Temporary tier for FIXED_STANDARD when fixed - standard tier is expired or not configured. - enum: - - FIXED_STANDARD - - PREMIUM - - STANDARD - - STANDARD_OVERRIDES_FIXED_STANDARD - endpointTypes: + XpnHostList: + id: XpnHostList + type: object + properties: + kind: description: >- - List of NAT-ted endpoint types supported by the Nat Gateway. If the - list is empty, then it will be equivalent to include - ENDPOINT_TYPE_VM + [Output Only] Type of resource. Always compute#xpnHostList for lists + of shared VPC hosts. + default: compute#xpnHostList + type: string + 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.' type: array items: - type: string - enumDescriptions: - - >- - This is used for regional Application Load Balancers (internal - and external) and regional proxy Network Load Balancers - (internal and external) endpoints. - - This is used for Secure Web Gateway endpoints. - - This is the default. - enum: - - ENDPOINT_TYPE_MANAGED_PROXY_LB - - ENDPOINT_TYPE_SWG - - ENDPOINT_TYPE_VM - 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 then there should not - be any other Router.Nat section in any Router for this network in - this region. - type: string - enumDescriptions: - - All the IP ranges in every Subnetwork are allowed to Nat. - - All the primary IP ranges in every Subnetwork are allowed to Nat. - - >- - A list of Subnetworks are allowed to Nat (specified in the field - subnetwork below) - enum: - - ALL_SUBNETWORKS_ALL_IP_RANGES - - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES - - LIST_OF_SUBNETWORKS - 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. - type: array - items: - $ref: '#/components/schemas/RouterNatSubnetworkToNat' - 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. - type: array - items: - type: string - 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. - type: array - items: - 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. - type: string - enumDescriptions: - - >- - Nat IPs are allocated by GCP; customers can not specify any Nat - IPs. - - >- - Only use Nat IPs provided by customers. When specified Nat IPs are - not enough then the Nat service fails for new VMs. - enum: - - AUTO_ONLY - - MANUAL_ONLY - 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. - type: integer - format: int32 - maxPortsPerVm: - description: >- - Maximum number of ports allocated to a VM from this NAT config when - Dynamic Port Allocation is enabled. If Dynamic Port Allocation is - not enabled, this field has no effect. If Dynamic Port Allocation is - enabled, and this field is set, it must be set to a power of two - greater than minPortsPerVm, or 64 if minPortsPerVm is not set. If - Dynamic Port Allocation is enabled and this field is not set, a - maximum of 65536 ports will be allocated to a VM from this NAT - config. - type: integer - format: int32 - enableDynamicPortAllocation: - description: >- - Enable Dynamic Port Allocation. If not specified, it is disabled by - default. If set to true, - Dynamic Port Allocation will be enabled - on this NAT config. - enableEndpointIndependentMapping cannot be set - to true. - If minPorts is set, minPortsPerVm must be set to a power - of two greater than or equal to 32. If minPortsPerVm is not set, a - minimum of 32 ports will be allocated to a VM from this NAT config. - type: boolean - udpIdleTimeoutSec: - description: >- - Timeout (in seconds) for UDP connections. Defaults to 30s if not - set. - type: integer - format: int32 - icmpIdleTimeoutSec: - description: >- - Timeout (in seconds) for ICMP connections. Defaults to 30s if not - set. - type: integer - format: int32 - tcpEstablishedIdleTimeoutSec: - description: >- - Timeout (in seconds) for TCP established connections. Defaults to - 1200s if not set. - type: integer - format: int32 - tcpTransitoryIdleTimeoutSec: - description: >- - Timeout (in seconds) for TCP transitory connections. Defaults to 30s - if not set. - type: integer - format: int32 - tcpTimeWaitTimeoutSec: - description: >- - Timeout (in seconds) for TCP connections that are in TIME_WAIT - state. Defaults to 120s if not set. - type: integer - format: int32 - logConfig: - description: Configure logging on this NAT. - $ref: '#/components/schemas/RouterNatLogConfig' - rules: - description: A list of rules associated with this NAT. - type: array - items: - $ref: '#/components/schemas/RouterNatRule' - enableEndpointIndependentMapping: - type: boolean - RouterNatSubnetworkToNat: - id: RouterNatSubnetworkToNat - description: Defines the IP ranges that want to use NAT for a subnetwork. - type: object - properties: - name: - description: URL for the subnetwork resource that will use NAT. - type: string - 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] - type: array - items: - type: string - enumDescriptions: - - The primary and all the secondary ranges are allowed to Nat. - - A list of secondary ranges are allowed to Nat. - - The primary range is allowed to Nat. - enum: - - ALL_IP_RANGES - - LIST_OF_SECONDARY_IP_RANGES - - PRIMARY_IP_RANGE - 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. - type: array - items: - type: string - RouterNatLogConfig: - id: RouterNatLogConfig - description: Configuration of logging on a NAT. - type: object - 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. - type: string - enumDescriptions: - - Export logs for all (successful and unsuccessful) connections. - - Export logs for connection failures only. - - Export logs for successful connections only. - enum: - - ALL - - ERRORS_ONLY - - TRANSLATIONS_ONLY - RouterNatRule: - id: RouterNatRule - type: object - properties: - 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. - type: integer - format: uint32 - 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 == - '//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1'` - type: string - action: - description: The action to be enforced for traffic that matches this rule. - $ref: '#/components/schemas/RouterNatRuleAction' - RouterNatRuleAction: - id: RouterNatRuleAction - type: object - 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. - type: array - items: - type: string - 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. - type: array - items: - type: string - sourceNatActiveRanges: - description: >- - A list of URLs of the subnetworks used as source ranges for this NAT - Rule. These subnetworks must have purpose set to PRIVATE_NAT. This - field is used for private NAT. - type: array - items: - type: string - sourceNatDrainRanges: - description: >- - A list of URLs of subnetworks representing source ranges to be - drained. This is only supported on patch/update, and these - subnetworks must have previously been used as active ranges in this - NAT Rule. This field is used for private NAT. - type: array - items: - type: string - RouterMd5AuthenticationKey: - id: RouterMd5AuthenticationKey - type: object - properties: - name: - description: >- - Name used to identify the key. Must be unique within a router. Must - be referenced by exactly one bgpPeer. Must comply with RFC1035. - annotations: - required: - - compute.routers.insert - - compute.routers.update - type: string - key: - description: >- - [Input only] Value of the key. For patch and update calls, it can be - skipped to copy the value from the previous configuration. This is - allowed if the key with the same name existed before the operation. - Maximum length is 80 characters. Can only contain printable ASCII - characters. - annotations: - required: - - compute.routers.insert - type: string - RouterList: - id: RouterList - description: Contains a list of Router resources. - type: object - properties: - kind: - description: '[Output Only] Type of resource. Always compute#router for routers.' - default: compute#routerList - type: string - id: - description: >- - [Output Only] Unique identifier for the resource; defined by the - server. - type: string - items: - description: A list of Router resources. - type: array - items: - $ref: '#/components/schemas/Router' + $ref: '#/components/schemas/Project' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -44038,6 +43633,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -44081,6 +43679,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -44103,6 +43702,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -44139,14 +43739,113 @@ components: [Output Only] A warning data value corresponding to the key. type: string - RouterAggregatedList: - id: RouterAggregatedList - description: Contains a list of routers. + ProjectsEnableXpnResourceRequest: + id: ProjectsEnableXpnResourceRequest + type: object + properties: + xpnResource: + description: Service resource (a.k.a service project) ID. + $ref: '#/components/schemas/XpnResourceId' + XpnResourceId: + id: XpnResourceId + description: Service resource (a.k.a service project) ID. + type: object + properties: + type: + description: The type of the service resource. + type: string + enumDescriptions: + - '' + - '' + enum: + - PROJECT + - XPN_RESOURCE_TYPE_UNSPECIFIED + 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 + ProjectsDisableXpnResourceRequest: + id: ProjectsDisableXpnResourceRequest + type: object + properties: + xpnResource: + description: Service resource (a.k.a service project) ID. + $ref: '#/components/schemas/XpnResourceId' + ProjectsGetXpnResources: + id: ProjectsGetXpnResources type: object properties: kind: - description: Type of resource. - default: compute#routerAggregatedList + description: >- + [Output Only] Type of resource. Always + compute#projectsGetXpnResources for lists of service resources + (a.k.a service projects) + default: compute#projectsGetXpnResources + type: string + resources: + description: >- + Service resources (a.k.a service projects) attached to this project + as their shared VPC host. + type: array + items: + $ref: '#/components/schemas/XpnResourceId' + nextPageToken: + description: >- + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. + type: string + ProjectsSetDefaultNetworkTierRequest: + id: ProjectsSetDefaultNetworkTierRequest + type: object + properties: + networkTier: + description: Default network tier to be set. + type: string + enumDescriptions: + - Public internet quality with fixed bandwidth. + - >- + High quality, Google-grade network tier, support for all + networking products. + - >- + Public internet quality, only limited support for other networking + products. + - >- + (Output only) Temporary tier for FIXED_STANDARD when fixed + standard tier is expired or not configured. + enum: + - FIXED_STANDARD + - PREMIUM + - STANDARD + - STANDARD_OVERRIDES_FIXED_STANDARD + ProjectsSetCloudArmorTierRequest: + id: ProjectsSetCloudArmorTierRequest + type: object + properties: + cloudArmorTier: + description: Managed protection tier to be set. + type: string + enumDescriptions: + - Enterprise tier protection billed annually. + - Enterprise tier protection billed monthly. + - Standard protection. + enum: + - CA_ENTERPRISE_ANNUAL + - CA_ENTERPRISE_PAYGO + - CA_STANDARD + PublicAdvertisedPrefixList: + id: PublicAdvertisedPrefixList + type: object + properties: + kind: + description: >- + [Output Only] Type of the resource. Always + compute#publicAdvertisedPrefix for public advertised prefixes. + default: compute#publicAdvertisedPrefixList type: string id: description: >- @@ -44154,11 +43853,10 @@ components: server. type: string items: - description: A list of Router resources. - type: object - additionalProperties: - description: Name of the scope containing this set of routers. - $ref: '#/components/schemas/RoutersScopedList' + description: A list of PublicAdvertisedPrefix resources. + type: array + items: + $ref: '#/components/schemas/PublicAdvertisedPrefix' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -44234,6 +43932,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -44277,6 +43978,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -44299,6 +44001,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -44335,86 +44038,277 @@ components: [Output Only] A warning data value corresponding to the key. type: string - unreachables: - description: '[Output Only] Unreachable resources.' - type: array - items: - type: string - RoutersScopedList: - id: RoutersScopedList + PublicAdvertisedPrefix: + id: 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. type: object properties: - routers: - description: A list of routers contained in this scope. - type: array - items: - $ref: '#/components/schemas/Router' - warning: + kind: description: >- - Informational warning which replaces the list of routers when the - list is empty. - type: object - properties: - code: - description: >- - [Output Only] A warning code, if applicable. For example, - Compute Engine returns NO_RESULTS_ON_PAGE if there are no - results in the response. - type: string - enumDescriptions: - - >- - Warning about failed cleanup of transient changes made by a - failed operation. - - A link to a deprecated resource was created. - - >- - When deploying and at least one of the resources has a type - marked as deprecated - - The user created a boot disk that is larger than image size. - - >- - When deploying and at least one of the resources has a type - marked as experimental - - Warning that is present in an external api call - - >- - Warning that value of a field has been overridden. Deprecated - unused field. - - >- - The operation involved use of an injected kernel, which is - deprecated. - - >- - A WEIGHTED_MAGLEV backend service is associated with a health - check that is not of type HTTP/HTTPS/HTTP2. - - >- - When deploying a deployment with a exceedingly large number of - resources - - >- - Resource can't be retrieved due to list overhead quota exceed - which captures the amount of resources filtered out by - user-defined list filter. - - A resource depends on a missing type - - >- - The route's nextHopIp address is not assigned to an instance - on the network. - - The route's next hop instance cannot ip forward. - - >- - The route's nextHopInstance URL refers to an instance that - does not have an ipv6 interface on the same network as the - route. - - >- - The route's nextHopInstance URL refers to an instance that - does not exist. - - >- - The route's nextHopInstance URL refers to an instance that is - not on the same network as the route. - - >- - The route's next hop instance does not have a status of - RUNNING. - - >- - Error which is not critical. We decided to continue the + [Output Only] Type of the resource. Always + compute#publicAdvertisedPrefix for public advertised prefixes. + default: compute#publicAdvertisedPrefix + type: string + id: + description: >- + [Output Only] The unique identifier for the resource type. The + server generates this identifier. + type: string + format: uint64 + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + 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])?' + annotations: + required: + - compute.publicAdvertisedPrefixes.insert + type: string + description: + description: >- + An optional description of this resource. Provide this property when + you create the resource. + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + ipCidrRange: + description: >- + The address range, in CIDR format, represented by this public + advertised prefix. + type: string + dnsVerificationIp: + description: The address to be used for reverse DNS verification. + 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. Possible values include: + - `INITIAL`: RPKI validation is complete. - `PTR_CONFIGURED`: User + has configured the PTR. - `VALIDATED`: Reverse DNS lookup is + successful. - `REVERSE_DNS_LOOKUP_FAILED`: Reverse DNS lookup + failed. - `PREFIX_CONFIGURATION_IN_PROGRESS`: The prefix is being + configured. - `PREFIX_CONFIGURATION_COMPLETE`: The prefix is fully + configured. - `PREFIX_REMOVAL_IN_PROGRESS`: The prefix is being + removed. + type: string + enumDescriptions: + - The prefix is announced to Internet. + - RPKI validation is complete. + - The prefix is fully configured. + - The prefix is being configured. + - The prefix is being removed. + - User has configured the PTR. + - The prefix is currently withdrawn but ready to be announced. + - Reverse DNS lookup failed. + - Reverse DNS lookup is successful. + enum: + - ANNOUNCED_TO_INTERNET + - INITIAL + - PREFIX_CONFIGURATION_COMPLETE + - PREFIX_CONFIGURATION_IN_PROGRESS + - PREFIX_REMOVAL_IN_PROGRESS + - PTR_CONFIGURED + - READY_TO_ANNOUNCE + - REVERSE_DNS_LOOKUP_FAILED + - VALIDATED + pdpScope: + description: >- + Specifies how child public delegated prefix will be scoped. It could + be one of following values: - `REGIONAL`: The public delegated + prefix is regional only. The provisioning will take a few minutes. - + `GLOBAL`: The public delegated prefix is global only. The + provisioning will take ~4 weeks. - `GLOBAL_AND_REGIONAL` [output + only]: The public delegated prefixes is BYOIP V1 legacy prefix. This + is output only value and no longer supported in BYOIP V2. + type: string + enumDescriptions: + - >- + The public delegated prefix is global only. The provisioning will + take ~4 weeks. + - >- + The public delegated prefixes is BYOIP V1 legacy prefix. This is + output only value and no longer supported in BYOIP V2. + - >- + The public delegated prefix is regional only. The provisioning + will take a few minutes. + enum: + - GLOBAL + - GLOBAL_AND_REGIONAL + - REGIONAL + publicDelegatedPrefixs: + description: >- + [Output Only] The list of public delegated prefixes that exist for + this public advertised prefix. + type: array + items: + $ref: '#/components/schemas/PublicAdvertisedPrefixPublicDelegatedPrefix' + 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. + type: string + format: byte + byoipApiVersion: + description: '[Output Only] The version of BYOIP API.' + type: string + enumDescriptions: + - >- + This public advertised prefix can be used to create both regional + and global public delegated prefixes. It usually takes 4 weeks to + create or delete a public delegated prefix. The BGP status cannot + be changed. + - >- + This public advertised prefix can only be used to create regional + public delegated prefixes. Public delegated prefix creation and + deletion takes minutes and the BGP status can be modified. + enum: + - V1 + - V2 + PublicAdvertisedPrefixPublicDelegatedPrefix: + id: PublicAdvertisedPrefixPublicDelegatedPrefix + description: Represents a CIDR range which can be used to assign addresses. + type: object + properties: + name: + description: The name 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 + project: + description: The project number of the public delegated prefix + 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 + ipRange: + description: The IP address range of the public delegated prefix + type: string + PublicDelegatedPrefixList: + id: PublicDelegatedPrefixList + type: object + properties: + kind: + description: >- + [Output Only] Type of the resource. Always + compute#publicDelegatedPrefixList for public delegated prefixes. + default: compute#publicDelegatedPrefixList + type: string + id: + description: >- + [Output Only] Unique identifier for the resource; defined by the + server. + type: string + items: + description: A list of PublicDelegatedPrefix resources. + type: array + items: + $ref: '#/components/schemas/PublicDelegatedPrefix' + nextPageToken: + description: >- + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. + type: string + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string + warning: + description: '[Output Only] Informational warning message.' + type: object + properties: + code: + description: >- + [Output Only] A warning code, if applicable. For example, + Compute Engine returns NO_RESULTS_ON_PAGE if there are no + results in the response. + type: string + enumDescriptions: + - >- + Warning about failed cleanup of transient changes made by a + failed operation. + - A link to a deprecated resource was created. + - >- + When deploying and at least one of the resources has a type + marked as deprecated + - The user created a boot disk that is larger than image size. + - >- + When deploying and at least one of the resources has a type + marked as experimental + - Warning that is present in an external api call + - >- + Warning that value of a field has been overridden. Deprecated + unused field. + - >- + The operation involved use of an injected kernel, which is + deprecated. + - >- + A WEIGHTED_MAGLEV backend service is associated with a health + check that is not of type HTTP/HTTPS/HTTP2. + - >- + When deploying a deployment with a exceedingly large number of + resources + - >- + Resource can't be retrieved due to list overhead quota exceed + which captures the amount of resources filtered out by + user-defined list filter. + - A resource depends on a missing type + - >- + The route's nextHopIp address is not assigned to an instance + on the network. + - The route's next hop instance cannot ip forward. + - >- + The route's nextHopInstance URL refers to an instance that + does not have an ipv6 interface on the same network as the + route. + - >- + The route's nextHopInstance URL refers to an instance that + does not exist. + - >- + The route's nextHopInstance URL refers to an instance that is + not on the same network as the route. + - >- + The route's next hop instance does not have a status of + RUNNING. + - >- + Error which is not critical. We decided to continue the process despite the mentioned error. - No results are present on a particular list page. - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -44458,6 +44352,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -44480,6 +44375,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -44516,570 +44412,247 @@ components: [Output Only] A warning data value corresponding to the key. type: string - RouterStatusResponse: - id: RouterStatusResponse + PublicDelegatedPrefix: + id: 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. type: object properties: kind: - description: Type of resource. - default: compute#routerStatusResponse - type: string - result: - $ref: '#/components/schemas/RouterStatus' - RouterStatus: - id: RouterStatus - type: object - properties: - network: - description: URI of the network to which this router belongs. - type: string - bestRoutes: description: >- - A list of the best dynamic routes for this Cloud Router's Virtual - Private Cloud (VPC) network in the same region as this Cloud Router. - Lists all of the best routes per prefix that are programmed into - this region's VPC data plane. When global dynamic routing mode is - turned on in the VPC network, this list can include cross-region - dynamic routes from Cloud Routers in other regions. - type: array - items: - $ref: '#/components/schemas/Route' - bestRoutesForRouter: + [Output Only] Type of the resource. Always + compute#publicDelegatedPrefix for public delegated prefixes. + default: compute#publicDelegatedPrefix + type: string + id: description: >- - A list of the best BGP routes learned by this Cloud Router. It is - possible that routes listed might not be programmed into the data - plane, if the Google Cloud control plane finds a more optimal route - for a prefix than a route learned by this Cloud Router. - type: array - items: - $ref: '#/components/schemas/Route' - bgpPeerStatus: - type: array - items: - $ref: '#/components/schemas/RouterStatusBgpPeerStatus' - natStatus: - type: array - items: - $ref: '#/components/schemas/RouterStatusNatStatus' - RouterStatusBgpPeerStatus: - id: RouterStatusBgpPeerStatus - type: object - properties: - name: - description: Name of this BGP peer. Unique within the Routers resource. + [Output Only] The unique identifier for the resource type. The + server generates this identifier. type: string - linkedVpnTunnel: - description: URL of the VPN tunnel that this BGP peer controls. + format: uint64 + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' type: string - routerApplianceInstance: + name: 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 - ipAddress: - description: IP address of the local BGP interface. + 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])?' + annotations: + required: + - compute.publicDelegatedPrefixes.insert type: string - peerIpAddress: - description: IP address of the remote BGP interface. + description: + description: >- + An optional description of this resource. Provide this property when + you create the resource. type: string - ipv6NexthopAddress: - description: IPv6 address of the local BGP interface. + selfLink: + description: '[Output Only] Server-defined URL for the resource.' type: string - peerIpv6NexthopAddress: - description: IPv6 address of the remote BGP interface. + 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 - enableIpv6: + ipCidrRange: description: >- - Enable IPv6 traffic over BGP Peer. It is enabled by default if the - peerIpAddress is version 6. - type: boolean + The IP address range, in CIDR format, represented by this public + delegated prefix. + type: string status: - description: 'Status of the BGP peer: {UP, DOWN}' + description: >- + [Output Only] The status of the public delegated prefix, which can + be one of following values: - `INITIALIZING` The public delegated + prefix is being initialized and addresses cannot be created yet. - + `READY_TO_ANNOUNCE` The public delegated prefix is a live migration + prefix and is active. - `ANNOUNCED` The public delegated prefix is + announced and ready to use. - `DELETING` The public delegated prefix + is being deprovsioned. type: string enumDescriptions: - - '' - - '' - - '' + - The public delegated prefix is announced and ready to use. + - The prefix is announced within Google network. + - The prefix is announced to Internet and within Google. + - The public delegated prefix is being deprovsioned. + - >- + The public delegated prefix is being initialized and addresses + cannot be created yet. + - >- + The public delegated prefix is currently withdrawn but ready to be + announced. enum: - - DOWN - - UNKNOWN - - UP - state: + - ANNOUNCED + - ANNOUNCED_TO_GOOGLE + - ANNOUNCED_TO_INTERNET + - DELETING + - INITIALIZING + - READY_TO_ANNOUNCE + parentPrefix: description: >- - The state of the BGP session. For a list of possible values for this - field, see BGP session states. + The URL of parent prefix. Either PublicAdvertisedPrefix or + PublicDelegatedPrefix. type: string - uptime: + publicDelegatedSubPrefixs: 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 - numLearnedRoutes: - description: Number of routes learned from the remote BGP Peer. - type: integer - format: uint32 - advertisedRoutes: - description: Routes that were advertised to the remote BGP peer + The list of sub public delegated prefixes that exist for this public + delegated prefix. type: array items: - $ref: '#/components/schemas/Route' - bfdStatus: - $ref: '#/components/schemas/BfdStatus' - md5AuthEnabled: - description: Informs whether MD5 authentication is enabled on this BGP peer. + $ref: '#/components/schemas/PublicDelegatedPrefixPublicDelegatedSubPrefix' + isLiveMigration: + description: If true, the prefix will be live migrated. type: boolean - statusReason: - description: Indicates why particular status was returned. + 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. + type: string + format: byte + mode: + description: The public delegated prefix mode for IPv6 only. type: string enumDescriptions: - >- - BGP peer disabled because it requires IPv4 but the underlying - connection is IPv6-only. + The public delegated prefix is used for further sub-delegation + only. Such prefixes cannot set allocatablePrefixLength. - >- - BGP peer disabled because it requires IPv6 but the underlying - connection is IPv4-only. + The public delegated prefix is used for creating forwarding rules + only. Such prefixes cannot set publicDelegatedSubPrefixes. - >- - Indicates internal problems with configuration of MD5 - authentication. This particular reason can only be returned when - md5AuthEnabled is true and status is DOWN. - - '' + The public delegated prefix is used for creating dual-mode + subnetworks only. Such prefixes cannot set + publicDelegatedSubPrefixes. enum: - - IPV4_PEER_ON_IPV6_ONLY_CONNECTION - - IPV6_PEER_ON_IPV4_ONLY_CONNECTION - - MD5_AUTH_INTERNAL_PROBLEM - - STATUS_REASON_UNSPECIFIED - ipv4NexthopAddress: - description: IPv4 address of the local BGP interface. - type: string - peerIpv4NexthopAddress: - description: IPv4 address of the remote BGP interface. - type: string - enableIpv4: + - DELEGATION + - EXTERNAL_IPV6_FORWARDING_RULE_CREATION + - EXTERNAL_IPV6_SUBNETWORK_CREATION + allocatablePrefixLength: description: >- - Enable IPv4 traffic over BGP Peer. It is enabled by default if the - peerIpAddress is version 4. - type: boolean - BfdStatus: - id: BfdStatus - description: 'Next free: 15' + The allocatable prefix length supported by this public delegated + prefix. This field is optional and cannot be set for prefixes in + DELEGATION mode. It cannot be set for IPv4 prefixes either, and it + always defaults to 32. + type: integer + format: int32 + byoipApiVersion: + description: '[Output Only] The version of BYOIP API.' + type: string + enumDescriptions: + - >- + This public delegated prefix usually takes 4 weeks to delete, and + the BGP status cannot be changed. Announce and Withdraw APIs can + not be used on this prefix. + - >- + This public delegated prefix takes minutes to delete. Announce and + Withdraw APIs can be used on this prefix to change the BGP status. + enum: + - V1 + - V2 + PublicDelegatedPrefixPublicDelegatedSubPrefix: + id: PublicDelegatedPrefixPublicDelegatedSubPrefix + description: Represents a sub PublicDelegatedPrefix. type: object properties: - uptimeMs: + name: + description: The name of the sub public delegated prefix. + type: string + description: description: >- - Session uptime in milliseconds. Value will be 0 if session is not - up. + An optional description of this resource. Provide this property when + you create the resource. type: string - format: int64 - localState: + region: description: >- - The current BFD session state as seen by the transmitting system. - These states are specified in section 4.1 of RFC5880 + [Output Only] The region of the sub public delegated prefix if it is + regional. If absent, the sub prefix is global. type: string - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - enum: - - ADMIN_DOWN - - DOWN - - INIT - - STATE_UNSPECIFIED - - UP - 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 - type: string - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - 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 - controlPacketCounts: - description: Control packet counts for the current BFD session. - $ref: '#/components/schemas/BfdStatusPacketCounts' - txPacket: - description: The most recent Tx control packet for this BFD session. - $ref: '#/components/schemas/BfdPacket' - rxPacket: - description: The most recent Rx control packet for this BFD session. - $ref: '#/components/schemas/BfdPacket' - controlPacketIntervals: - description: Inter-packet time interval statistics for control packets. - type: array - items: - $ref: '#/components/schemas/PacketIntervals' - negotiatedLocalControlTxIntervalMs: - description: Negotiated transmit interval for control packets. - type: integer - format: uint32 - 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. + status: + description: '[Output Only] The status of the sub public delegated prefix.' type: string enumDescriptions: - '' - '' - - '' enum: - ACTIVE - - DISABLED - - PASSIVE - configUpdateTimestampMicros: - description: Unix timestamp of the most recent config update. - type: string - format: int64 - BfdStatusPacketCounts: - id: BfdStatusPacketCounts - type: object - properties: - numTx: - description: >- - Number of packets transmitted since the beginning of the current BFD - session. - type: integer - format: uint32 - numRx: - description: >- - Number of packets received since the beginning of the current BFD - session. - type: integer - format: uint32 - numRxSuccessful: - description: >- - Number of packets received that were successfully processed since - the beginning of the current BFD session. - type: integer - format: uint32 - numRxRejected: - description: >- - Number of packets received that were rejected because of errors - since the beginning of the current BFD session. - type: integer - format: uint32 - BfdPacket: - id: BfdPacket - type: object - properties: - version: - description: >- - The version number of the BFD protocol, as specified in section 4.1 - of RFC5880. - type: integer - format: uint32 - diagnostic: + - INACTIVE + ipCidrRange: 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 + The IP address range, in CIDR format, represented by this sub public + delegated prefix. type: string - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - 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 - state: - description: >- - The current BFD session state as seen by the transmitting system. - These states are specified in section 4.1 of RFC5880 + delegateeProject: + description: Name of the project scoping this PublicDelegatedSubPrefix. type: string - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - enum: - - ADMIN_DOWN - - DOWN - - INIT - - STATE_UNSPECIFIED - - UP - poll: - description: >- - The Poll bit of the BFD packet. This is specified in section 4.1 of - RFC5880 - type: boolean - final: - description: >- - The Final 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 - authenticationPresent: - description: >- - The Authentication Present 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 - multipoint: + isAddress: description: >- - The multipoint bit of the BFD packet. This is specified in section - 4.1 of RFC5880 + Whether the sub prefix is delegated to create Address resources in + the delegatee project. type: boolean - multiplier: - description: >- - The detection time multiplier of the BFD packet. This is specified - in section 4.1 of RFC5880 - type: integer - format: uint32 - length: - description: >- - The length of the BFD Control packet in bytes. This is specified in - section 4.1 of RFC5880 - type: integer - format: uint32 - myDiscriminator: - description: >- - The My Discriminator value in the BFD packet. This is specified in - section 4.1 of RFC5880 - type: integer - format: uint32 - yourDiscriminator: - description: >- - The Your Discriminator value in the BFD packet. This is specified in - section 4.1 of RFC5880 - type: integer - format: uint32 - minTxIntervalMs: - description: >- - The Desired Min TX Interval value in the BFD packet. This is - specified in section 4.1 of RFC5880 - type: integer - format: uint32 - minRxIntervalMs: - description: >- - The Required Min RX Interval value in the BFD packet. This is - specified in section 4.1 of RFC5880 - type: integer - format: uint32 - minEchoRxIntervalMs: - description: >- - The Required Min Echo RX Interval value in the BFD packet. This is - specified in section 4.1 of RFC5880 - type: integer - format: uint32 - PacketIntervals: - id: PacketIntervals - description: 'Next free: 7' - type: object - properties: - type: - description: The type of packets for which inter-packet intervals were computed. + mode: + description: The PublicDelegatedSubPrefix mode for IPv6 only. type: string enumDescriptions: - >- - Only applies to Echo packets. This shows the intervals between - sending and receiving the same packet. - - Intervals between received packets. - - Intervals between transmitted packets. - - '' - enum: - - LOOPBACK - - RECEIVE - - TRANSMIT - - TYPE_UNSPECIFIED - duration: - description: From how long ago in the past these intervals were observed. - type: string - enumDescriptions: - - '' - - '' - - From BfdSession object creation time. - - '' + The public delegated prefix is used for further sub-delegation + only. Such prefixes cannot set allocatablePrefixLength. + - >- + The public delegated prefix is used for creating forwarding rules + only. Such prefixes cannot set publicDelegatedSubPrefixes. + - >- + The public delegated prefix is used for creating dual-mode + subnetworks only. Such prefixes cannot set + publicDelegatedSubPrefixes. enum: - - DURATION_UNSPECIFIED - - HOUR - - MAX - - MINUTE - numIntervals: - description: >- - Number of inter-packet intervals from which these statistics were - derived. - type: string - format: int64 - minMs: - description: Minimum observed inter-packet interval in milliseconds. - type: string - format: int64 - maxMs: - description: Maximum observed inter-packet interval in milliseconds. - type: string - format: int64 - avgMs: - description: Average observed inter-packet interval in milliseconds. - type: string - format: int64 - RouterStatusNatStatus: - id: RouterStatusNatStatus - description: Status of a NAT contained in this router. - type: object - properties: - name: - description: Unique name of this NAT. - type: string - userAllocatedNatIpResources: - description: A list of fully qualified URLs of reserved IP address resources. - type: array - items: - type: string - drainUserAllocatedNatIps: - description: >- - A list of IPs user-allocated for NAT that are in drain mode. - Example: ["1.1.1.1", "179.12.26.133"]. - type: array - items: - type: string - userAllocatedNatIps: - description: >- - A list of IPs user-allocated for NAT. They will be raw IP strings - like "179.12.26.133". - type: array - items: - type: string - autoAllocatedNatIps: - description: >- - A list of IPs auto-allocated for NAT. Example: ["1.1.1.1", - "129.2.16.89"] - type: array - items: - type: string - drainAutoAllocatedNatIps: - description: >- - A list of IPs auto-allocated for NAT that are in drain mode. - Example: ["1.1.1.1", "179.12.26.133"]. - type: array - items: - type: string - 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. - type: integer - format: int32 - numVmEndpointsWithNatMappings: - description: Number of VM endpoints (i.e., Nics) that can use NAT. - type: integer - format: int32 - ruleStatus: - description: Status of rules in this NAT. - type: array - items: - $ref: '#/components/schemas/RouterStatusNatStatusNatRuleStatus' - RouterStatusNatStatusNatRuleStatus: - id: RouterStatusNatStatusNatRuleStatus - description: Status of a NAT Rule contained in this NAT. - type: object - properties: - ruleNumber: - description: Rule number of the rule. - type: integer - format: int32 - activeNatIps: - description: 'A list of active IPs for NAT. Example: ["1.1.1.1", "179.12.26.133"].' - type: array - items: - type: string - drainNatIps: - description: >- - A list of IPs for NAT that are in drain mode. Example: ["1.1.1.1", - "179.12.26.133"]. - type: array - items: - type: string - 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. - type: integer - format: int32 - numVmEndpointsWithNatMappings: + - DELEGATION + - EXTERNAL_IPV6_FORWARDING_RULE_CREATION + - EXTERNAL_IPV6_SUBNETWORK_CREATION + allocatablePrefixLength: description: >- - Number of VM endpoints (i.e., NICs) that have NAT Mappings from this - NAT Rule. + The allocatable prefix length supported by this + PublicDelegatedSubPrefix. type: integer format: int32 - VmEndpointNatMappingsList: - id: VmEndpointNatMappingsList - description: Contains a list of VmEndpointNatMappings. + PublicDelegatedPrefixAggregatedList: + id: PublicDelegatedPrefixAggregatedList type: object properties: kind: description: >- - [Output Only] Type of resource. Always - compute#vmEndpointNatMappingsList for lists of Nat mappings of VM - endpoints. - default: compute#vmEndpointNatMappingsList + [Output Only] Type of the resource. Always + compute#publicDelegatedPrefixAggregatedList for aggregated lists of + public delegated prefixes. + default: compute#publicDelegatedPrefixAggregatedList type: string id: description: >- - [Output Only] The unique identifier for the resource. This - identifier is defined by the server. + [Output Only] Unique identifier for the resource; defined by the + server. type: string - result: - description: '[Output Only] A list of Nat mapping information of VM endpoints.' - type: array - items: - $ref: '#/components/schemas/VmEndpointNatMappings' + items: + description: A list of PublicDelegatedPrefixesScopedList resources. + type: object + additionalProperties: + description: >- + [Output Only] Name of the scope containing this set of + PublicDelegatedPrefixes. + $ref: '#/components/schemas/PublicDelegatedPrefixesScopedList' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -45155,6 +44728,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -45198,6 +44774,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -45220,6 +44797,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -45256,200 +44834,26 @@ components: [Output Only] A warning data value corresponding to the key. type: string - VmEndpointNatMappings: - id: VmEndpointNatMappings - description: Contain information of Nat mapping for a VM endpoint (i.e., NIC). - type: object - properties: - instanceName: - description: Name of the VM instance which the endpoint belongs to - type: string - interfaceNatMappings: - type: array - items: - $ref: '#/components/schemas/VmEndpointNatMappingsInterfaceNatMappings' - VmEndpointNatMappingsInterfaceNatMappings: - id: VmEndpointNatMappingsInterfaceNatMappings - description: Contain information of Nat mapping for an interface of this endpoint. - type: object - properties: - sourceVirtualIp: - description: Primary IP of the VM for this NIC. - type: string - 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 - 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. - type: integer - format: int32 - 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"]. - type: array - items: - type: string - 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"]. + unreachables: + description: '[Output Only] Unreachable resources.' type: array items: type: string - 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. - type: integer - format: int32 - ruleMappings: - description: Information about mappings provided by rules in this NAT. - type: array - items: - $ref: >- - #/components/schemas/VmEndpointNatMappingsInterfaceNatMappingsNatRuleMappings - VmEndpointNatMappingsInterfaceNatMappingsNatRuleMappings: - id: VmEndpointNatMappingsInterfaceNatMappingsNatRuleMappings - description: Contains information of NAT Mappings provided by a NAT Rule. + PublicDelegatedPrefixesScopedList: + id: PublicDelegatedPrefixesScopedList type: object properties: - ruleNumber: - description: Rule number of the NAT Rule. - type: integer - format: int32 - numTotalNatPorts: - description: >- - Total number of ports across all NAT IPs allocated to this interface - by this rule. It equals the aggregated port number in the field - nat_ip_port_ranges. - type: integer - format: int32 - natIpPortRanges: + publicDelegatedPrefixes: description: >- - A list of all IP:port-range mappings assigned to this interface by - this rule. 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"]. + [Output Only] A list of PublicDelegatedPrefixes contained in this + scope. type: array items: - type: string - drainNatIpPortRanges: + $ref: '#/components/schemas/PublicDelegatedPrefix' + warning: description: >- - List of all drain IP:port-range mappings assigned to this interface - by this rule. 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"]. - type: array - items: - type: string - numTotalDrainNatPorts: - description: >- - Total number of drain ports across all NAT IPs allocated to this - interface by this rule. It equals the aggregated port number in the - field drain_nat_ip_port_ranges. - type: integer - format: int32 - NatIpInfoResponse: - id: NatIpInfoResponse - type: object - properties: - result: - description: '[Output Only] A list of NAT IP information.' - type: array - items: - $ref: '#/components/schemas/NatIpInfo' - NatIpInfo: - id: NatIpInfo - description: Contains NAT IP information of a NAT config (i.e. usage status, mode). - type: object - properties: - natName: - description: Name of the NAT config which the NAT IP belongs to. - type: string - natIpInfoMappings: - description: A list of all NAT IPs assigned to this NAT config. - type: array - items: - $ref: '#/components/schemas/NatIpInfoNatIpInfoMapping' - NatIpInfoNatIpInfoMapping: - id: NatIpInfoNatIpInfoMapping - description: Contains information of a NAT IP. - type: object - properties: - natIp: - description: 'NAT IP address. For example: 203.0.113.11.' - type: string - usage: - description: >- - Specifies whether NAT IP is currently serving at least one endpoint - or not. - type: string - enumDescriptions: - - '' - - '' - enum: - - IN_USE - - UNUSED - mode: - description: Specifies whether NAT IP is auto or manual. - type: string - enumDescriptions: - - '' - - '' - enum: - - AUTO - - MANUAL - RoutersPreviewResponse: - id: RoutersPreviewResponse - type: object - properties: - resource: - description: Preview of given router. - $ref: '#/components/schemas/Router' - ServiceAttachmentAggregatedList: - id: ServiceAttachmentAggregatedList - description: Contains a list of ServiceAttachmentsScopedList. - type: object - properties: - kind: - description: Type of resource. - default: compute#serviceAttachmentAggregatedList - type: string - id: - description: >- - [Output Only] Unique identifier for the resource; defined by the - server. - type: string - items: - description: A list of ServiceAttachmentsScopedList resources. - type: object - additionalProperties: - description: Name of the scope containing this set of ServiceAttachments. - $ref: '#/components/schemas/ServiceAttachmentsScopedList' - nextPageToken: - description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. - type: string - selfLink: - description: '[Output Only] Server-defined URL for this resource.' - type: string - warning: - description: '[Output Only] Informational warning message.' + [Output Only] Informational warning which replaces the list of + public delegated prefixes when the list is empty. type: object properties: code: @@ -45512,6 +44916,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -45555,6 +44962,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -45577,6 +44985,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -45613,24 +45022,40 @@ components: [Output Only] A warning data value corresponding to the key. type: string - unreachables: - description: '[Output Only] Unreachable resources.' - type: array - items: - type: string - ServiceAttachmentsScopedList: - id: ServiceAttachmentsScopedList + RegionList: + id: RegionList + description: Contains a list of region resources. type: object properties: - serviceAttachments: - description: A list of ServiceAttachments contained in this scope. + kind: + description: >- + [Output Only] Type of resource. Always compute#regionList for lists + of regions. + default: compute#regionList + type: string + id: + description: >- + [Output Only] Unique identifier for the resource; defined by the + server. + type: string + items: + description: A list of Region resources. type: array items: - $ref: '#/components/schemas/ServiceAttachment' - warning: + $ref: '#/components/schemas/Region' + nextPageToken: description: >- - Informational warning which replaces the list of service attachments - when the list is empty. + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. + type: string + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string + warning: + description: '[Output Only] Informational warning message.' type: object properties: code: @@ -45693,6 +45118,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -45736,6 +45164,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -45758,6 +45187,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -45794,279 +45224,69 @@ components: [Output Only] A warning data value corresponding to the key. type: string - ServiceAttachment: - id: ServiceAttachment + Region: + id: Region 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. + Represents a Region resource. A region is a geographical area where a + resource is located. For more information, read Regions and Zones. type: object properties: kind: description: >- - [Output Only] Type of the resource. Always compute#serviceAttachment - for service attachments. - default: compute#serviceAttachment + [Output Only] Type of the resource. Always compute#region for + regions. + default: compute#region type: string id: description: >- - [Output Only] The unique identifier for the resource type. The - server generates this identifier. + [Output Only] The unique identifier for the resource. This + identifier is defined by the server. type: string format: uint64 creationTimestamp: description: '[Output Only] Creation timestamp in RFC3339 text format.' 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])?' - annotations: - required: - - compute.serviceAttachments.insert + description: '[Output Only] Name of the resource.' type: string description: - description: >- - An optional description of this resource. Provide this property when - you create the resource. - type: string - selfLink: - description: '[Output Only] Server-defined URL for the resource.' - type: string - 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 - producerForwardingRule: - description: >- - The URL of a forwarding rule with loadBalancingScheme INTERNAL* that - is serving the endpoint identified by this service attachment. - deprecated: true - type: string - targetService: - description: >- - The URL of a service serving the endpoint identified by this service - attachment. + description: '[Output Only] Textual description of the resource.' type: string - 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. + status: + description: '[Output Only] Status of the region, either UP or DOWN.' type: string enumDescriptions: - '' - '' - - '' enum: - - ACCEPT_AUTOMATIC - - ACCEPT_MANUAL - - CONNECTION_PREFERENCE_UNSPECIFIED - connectedEndpoints: - description: >- - [Output Only] An array of connections for all the consumers - connected to this service attachment. - type: array - items: - $ref: '#/components/schemas/ServiceAttachmentConnectedEndpoint' - 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. - type: array - items: - 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 - consumerRejectLists: + - DOWN + - UP + zones: description: >- - Specifies a list of projects or networks that are not allowed to - connect to this service attachment. The project can be specified - using its project ID or project number and the network can be - specified using its URL. A given service attachment can manage - connections at either the project or network level. Therefore, both - the reject and accept lists for a given service attachment must - contain either only projects or only networks. + [Output Only] A list of zones available in this region, in the form + of resource URLs. type: array items: type: string - consumerAcceptLists: - description: >- - Specifies which consumer projects or networks are allowed to connect - to the service attachment. Each project or network has a connection - limit. A given service attachment can manage connections at either - the project or network level. Therefore, both the accept and reject - lists for a given service attachment must contain either only - projects or only networks. + quotas: + description: '[Output Only] Quotas assigned to this region.' type: array items: - $ref: '#/components/schemas/ServiceAttachmentConsumerProjectLimit' - pscServiceAttachmentId: - description: >- - [Output Only] An 128-bit global unique ID of the PSC service - attachment. - $ref: '#/components/schemas/Uint128' - 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. + $ref: '#/components/schemas/Quota' + deprecated: + description: '[Output Only] The deprecation status associated with this region.' + $ref: '#/components/schemas/DeprecationStatus' + selfLink: + description: '[Output Only] Server-defined URL for the resource.' type: string - format: byte - domainNames: - description: >- - If specified, the domain name will be used during the integration - between the PSC connected endpoints and the Cloud DNS. For example, - this is a valid domain name: "p.mycompany.com.". Current max number - of domain names supported is 1. - type: array - items: - type: string - reconcileConnections: - description: >- - This flag determines whether a consumer accept/reject list change - can reconcile the statuses of existing ACCEPTED or REJECTED PSC - endpoints. - If false, connection policy update will only affect - existing PENDING PSC endpoints. Existing ACCEPTED/REJECTED endpoints - will remain untouched regardless how the connection policy is - modified . - If true, update will affect both PENDING and - ACCEPTED/REJECTED PSC endpoints. For example, an ACCEPTED PSC - endpoint will be moved to REJECTED if its project is added to the - reject list. For newly created service attachment, this boolean - defaults to false. + supportsPzs: + description: '[Output Only] Reserved for future use.' type: boolean - propagatedConnectionLimit: - description: >- - The number of consumer spokes that connected Private Service Connect - endpoints can be propagated to through Network Connectivity Center. - This limit lets the service producer limit how many propagated - Private Service Connect connections can be established to this - service attachment from a single consumer. If the connection - preference of the service attachment is ACCEPT_MANUAL, the limit - applies to each project or network that is listed in the consumer - accept list. If the connection preference of the service attachment - is ACCEPT_AUTOMATIC, the limit applies to each project that contains - a connected endpoint. If unspecified, the default propagated - connection limit is 250. - type: integer - format: uint32 - ServiceAttachmentConnectedEndpoint: - id: ServiceAttachmentConnectedEndpoint - description: '[Output Only] A connection connected to this service attachment.' - type: object - properties: - status: - description: The status of a connected endpoint to this service attachment. - type: string - enumDescriptions: - - The connection has been accepted by the producer. - - The connection has been closed by the producer. - - >- - The connection has been accepted by the producer, but the producer - needs to take further action before the forwarding rule can serve - traffic. - - The connection is pending acceptance by the producer. - - The consumer is still connected but not using the connection. - - '' - enum: - - ACCEPTED - - CLOSED - - NEEDS_ATTENTION - - PENDING - - REJECTED - - STATUS_UNSPECIFIED - pscConnectionId: - description: The PSC connection id of the connected endpoint. - type: string - format: uint64 - endpoint: - description: The url of a connected endpoint. - type: string - consumerNetwork: - description: The url of the consumer network. - type: string - propagatedConnectionCount: - description: >- - The number of consumer Network Connectivity Center spokes that the - connected Private Service Connect endpoint has propagated to. - type: integer - format: uint32 - ServiceAttachmentConsumerProjectLimit: - id: ServiceAttachmentConsumerProjectLimit - type: object - properties: - projectIdOrNum: - description: The project id or number for the project to set the limit for. - type: string - networkUrl: - description: The network URL for the network to set the limit for. - type: string - connectionLimit: - description: The value of the limit to set. - type: integer - format: uint32 - Uint128: - id: Uint128 - type: object - properties: - high: - type: string - format: uint64 - low: - type: string - format: uint64 - ServiceAttachmentList: - id: ServiceAttachmentList - type: object - properties: - kind: - description: >- - [Output Only] Type of the resource. Always compute#serviceAttachment - for service attachments. - default: compute#serviceAttachmentList - type: string - id: - description: >- - [Output Only] Unique identifier for the resource; defined by the - server. - type: string - items: - description: A list of ServiceAttachment resources. - type: array - items: - $ref: '#/components/schemas/ServiceAttachment' - nextPageToken: + quotaStatusWarning: description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. - type: string - selfLink: - description: '[Output Only] Server-defined URL for this resource.' - type: string - warning: - description: '[Output Only] Informational warning message.' + [Output Only] Warning of fetching the `quotas` field for this + region. This field is populated only if fetching of the `quotas` + field fails. type: object properties: code: @@ -46129,6 +45349,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -46172,6 +45395,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -46194,6 +45418,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -46230,68 +45455,16 @@ components: [Output Only] A warning data value corresponding to the key. type: string - SnapshotSettings: - id: SnapshotSettings - type: object - properties: - storageLocation: - description: >- - Policy of which storage location is going to be resolved, and - additional data that particularizes how the policy is going to be - carried out. - $ref: '#/components/schemas/SnapshotSettingsStorageLocationSettings' - SnapshotSettingsStorageLocationSettings: - id: SnapshotSettingsStorageLocationSettings - type: object - properties: - policy: - description: The chosen location policy. - type: string - enumDescriptions: - - >- - Store snapshot in the same region as with the originating disk. No - additional parameters are needed. - - >- - Store snapshot in the nearest multi region Cloud Storage bucket, - relative to the originating disk. No additional parameters are - needed. - - >- - Store snapshot in the specific locations, as specified by the - user. The list of regions to store must be defined under the - `locations` field. - - '' - enum: - - LOCAL_REGION - - NEAREST_MULTI_REGION - - SPECIFIC_LOCATIONS - - STORAGE_LOCATION_POLICY_UNSPECIFIED - locations: - description: >- - When the policy is SPECIFIC_LOCATIONS, snapshots will be stored in - the locations listed in this field. Keys are Cloud Storage bucket - locations. Only one location can be specified. - type: object - additionalProperties: - $ref: >- - #/components/schemas/SnapshotSettingsStorageLocationSettingsStorageLocationPreference - SnapshotSettingsStorageLocationSettingsStorageLocationPreference: - id: SnapshotSettingsStorageLocationSettingsStorageLocationPreference - description: A structure for specifying storage locations. - type: object - properties: - name: - description: >- - Name of the location. It should be one of the Cloud Storage buckets. - Only one location can be specified. - type: string - SslCertificateList: - id: SslCertificateList - description: Contains a list of SslCertificate resources. + SubnetworkList: + id: SubnetworkList + description: Contains a list of Subnetwork resources. type: object properties: kind: - description: Type of resource. - default: compute#sslCertificateList + description: >- + [Output Only] Type of resource. Always compute#subnetworkList for + lists of subnetworks. + default: compute#subnetworkList type: string id: description: >- @@ -46299,10 +45472,10 @@ components: server. type: string items: - description: A list of SslCertificate resources. + description: A list of Subnetwork resources. type: array items: - $ref: '#/components/schemas/SslCertificate' + $ref: '#/components/schemas/Subnetwork' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -46378,6 +45551,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -46421,6 +45597,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -46443,6 +45620,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -46479,31 +45657,20 @@ components: [Output Only] A warning data value corresponding to the key. type: string - SslCertificate: - id: SslCertificate + Subnetwork: + id: Subnetwork 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 - global SSL certificates (sslCertificates) are used by: - Global external - Application Load Balancers - Classic Application Load Balancers - Proxy - Network Load Balancers (with target SSL proxies) The regional SSL - certificates (regionSslCertificates) are used by: - Regional external - Application Load Balancers - Regional internal Application 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. - type: object - properties: + 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. + type: object + properties: kind: description: >- - [Output Only] Type of the resource. Always compute#sslCertificate - for SSL certificates. - default: compute#sslCertificate + [Output Only] Type of the resource. Always compute#subnetwork for + Subnetwork resources. + default: compute#subnetwork type: string id: description: >- @@ -46516,11 +45683,11 @@ components: 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 + 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])?' @@ -46528,165 +45695,372 @@ components: description: description: >- An optional description of this resource. Provide this property when - you create the resource. + you create the resource. This field can be set only at resource + creation time. + 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 + 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 + reservedInternalRange: + description: The URL of the reserved internal range. + type: string + gatewayAddress: + description: >- + [Output Only] The gateway address for default routes to reach + destination addresses outside this subnetwork. + type: string + region: + description: >- + URL of the region where the Subnetwork resides. This field can be + set only at resource creation time. type: string selfLink: - description: '[Output only] Server-defined URL for the resource.' + description: '[Output Only] Server-defined URL for the resource.' type: string - certificate: + privateIpGoogleAccess: 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. + 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 + 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. + type: array + items: + $ref: '#/components/schemas/SubnetworkSecondaryRange' + 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. type: string - privateKey: + format: byte + enableFlowLogs: 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. + 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 determined by the org policy, if there is no + org policy specified, then it will default to disabled. This field + isn't supported if the subnet purpose field is set to + REGIONAL_MANAGED_PROXY. + type: boolean + privateIpv6GoogleAccess: + description: >- + This field is for internal use. This field can be both set at + resource creation time and updated using patch. type: string - managed: - description: Configuration and status of a managed SSL certificate. - $ref: '#/components/schemas/SslCertificateManagedSslCertificate' - selfManaged: - description: Configuration and status of a self-managed SSL certificate. - $ref: '#/components/schemas/SslCertificateSelfManagedSslCertificate' - type: + enumDescriptions: + - Disable private IPv6 access to/from Google services. + - Bidirectional private IPv6 access to/from Google services. + - >- + Outbound private IPv6 access from VMs in this subnet to Google + services. + enum: + - DISABLE_GOOGLE_ACCESS + - ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE + - ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE + ipv6CidrRange: + description: '[Output Only] This field is for internal use.' + type: string + externalIpv6Prefix: + description: The external IPv6 address range that is owned by this subnetwork. + type: string + internalIpv6Prefix: + description: The internal IPv6 address range that is owned by this subnetwork. + type: string + purpose: + type: string + enumDescriptions: + - Subnet reserved for Global Envoy-based Load Balancing. + - >- + Subnet reserved for Internal HTTP(S) Load Balancing. This is a + legacy purpose, please use REGIONAL_MANAGED_PROXY instead. + - >- + Subnetwork will be used for Migration from one peered VPC to + another. (a transient state of subnetwork while migrating + resources from one project to another). + - Regular user created or automatically created subnet. + - Subnetwork used as source range for Private NAT Gateways. + - Regular user created or automatically created subnet. + - >- + Subnetworks created for Private Service Connect in the producer + network. + - Subnetwork used for Regional Envoy-based Load Balancing. + enum: + - GLOBAL_MANAGED_PROXY + - INTERNAL_HTTPS_LOAD_BALANCER + - PEER_MIGRATION + - PRIVATE + - PRIVATE_NAT + - PRIVATE_RFC_1918 + - PRIVATE_SERVICE_CONNECT + - REGIONAL_MANAGED_PROXY + role: 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. + The role of subnetwork. Currently, this field is only used when + purpose is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. + The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is + one that is currently being used for Envoy-based load balancers in a + region. 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. + type: string + enumDescriptions: + - The ACTIVE subnet that is currently used. + - The BACKUP subnet that could be promoted to ACTIVE. + enum: + - ACTIVE + - BACKUP + 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 + type: string + enumDescriptions: + - Subnetwork is being drained. + - Subnetwork is ready for use. + enum: + - DRAINING + - READY + logConfig: + description: >- + This field denotes the VPC flow logging options for this subnetwork. + If logging is enabled, logs are exported to Cloud Logging. + $ref: '#/components/schemas/SubnetworkLogConfig' + stackType: + description: >- + The stack type for the subnet. If set to IPV4_ONLY, new VMs in the + subnet are assigned IPv4 addresses only. If set to IPV4_IPV6, new + VMs in the subnet can be assigned both IPv4 and IPv6 addresses. If + not specified, IPV4_ONLY is used. This field can be both set at + resource creation time and updated using patch. + type: string + enumDescriptions: + - New VMs in this subnet can have both IPv4 and IPv6 addresses. + - New VMs in this subnet will only be assigned IPv4 addresses. + - New VMs in this subnet will only be assigned IPv6 addresses. + enum: + - IPV4_IPV6 + - IPV4_ONLY + - IPV6_ONLY + 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. + type: string + enumDescriptions: + - >- + VMs on this subnet will be assigned IPv6 addresses that are + accessible via the Internet, as well as the VPC network. + - >- + VMs on this subnet will be assigned IPv6 addresses that are only + accessible over the VPC network. + enum: + - EXTERNAL + - INTERNAL + ipCollection: + description: >- + Reference to the source of IP, like a PublicDelegatedPrefix (PDP) + for BYOIP. The PDP must be a sub-PDP in + EXTERNAL_IPV6_SUBNETWORK_CREATION mode. Use one of the following + formats to specify a sub-PDP when creating a dual stack subnetwork + with external access using BYOIP: - Full resource URL, as in + https://www.googleapis.com/compute/v1/projects/projectId/regions/region + /publicDelegatedPrefixes/sub-pdp-name - Partial URL, as in - + projects/projectId/regions/region/publicDelegatedPrefixes/ + sub-pdp-name - regions/region/publicDelegatedPrefixes/sub-pdp-name + type: string + ipv6GceEndpoint: + description: >- + [Output Only] Possible endpoints of this subnetwork. It can be one + of the following: - VM_ONLY: The subnetwork can be used for creating + instances and IPv6 addresses with VM endpoint type. Such a + subnetwork gets external IPv6 ranges from a public delegated prefix + and cannot be used to create NetLb. - VM_AND_FR: The subnetwork can + be used for creating both VM instances and Forwarding Rules. It can + also be used to reserve IPv6 addresses with both VM and FR endpoint + types. Such a subnetwork gets its IPv6 range from Google IP Pool + directly. type: string enumDescriptions: - - Google-managed SSLCertificate. - - Certificate uploaded by user. + - '' - '' enum: - - MANAGED - - SELF_MANAGED - - TYPE_UNSPECIFIED - subjectAlternativeNames: + - VM_AND_FR + - VM_ONLY + params: description: >- - [Output Only] Domains associated with the certificate via Subject - Alternative Name. + Input only. [Input Only] Additional params passed with the request, + but not persisted as part of resource payload. + $ref: '#/components/schemas/SubnetworkParams' + systemReservedInternalIpv6Ranges: + description: >- + Output only. [Output Only] The array of internal IPv6 network ranges + reserved from the subnetwork's internal IPv6 range for system use. + readOnly: true type: array items: type: string - expireTime: - description: '[Output Only] Expire time of the certificate. RFC3339' + systemReservedExternalIpv6Ranges: + description: >- + Output only. [Output Only] The array of external IPv6 network ranges + reserved from the subnetwork's external IPv6 range for system use. + readOnly: true + type: array + items: + type: string + SubnetworkSecondaryRange: + id: SubnetworkSecondaryRange + description: Represents a secondary IP range of a subnetwork. + type: object + properties: + 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 - region: + ipCidrRange: description: >- - [Output Only] URL of the region where the regional SSL Certificate - resides. This field is not applicable to global SSL Certificate. + 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 - SslCertificateManagedSslCertificate: - id: SslCertificateManagedSslCertificate - description: Configuration and status of a managed SSL certificate. + reservedInternalRange: + description: The URL of the reserved internal range. + type: string + SubnetworkLogConfig: + id: SubnetworkLogConfig + description: The available logging options for this subnetwork. type: object properties: - domains: + enable: 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). - type: array - items: - type: string - status: - description: '[Output only] Status of the managed certificate resource.' + 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 determined by the org policy, if there is no + org policy specified, then it will default to disabled. Flow logging + isn't supported if the subnet purpose field is set to + REGIONAL_MANAGED_PROXY. + type: boolean + 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. type: string enumDescriptions: - - >- - The certificate management is working, and a certificate has been - provisioned. - '' - - >- - The certificate management is working. GCP will attempt to - provision the first certificate. - - >- - Certificate provisioning failed due to an issue with the DNS or - load balancing configuration. For details of which domain failed, - consult domain_status field. - - >- - Certificate provisioning failed due to an issue with the DNS or - load balancing configuration. It won't be retried. To try again - delete and create a new managed SslCertificate resource. For - details of which domain failed, consult domain_status field. - - >- - Renewal of the certificate has failed due to an issue with the DNS - or load balancing configuration. The existing cert is still - serving; however, it will expire shortly. To provision a renewed - certificate, delete and create a new managed SslCertificate - resource. For details on which domain failed, consult - domain_status field. + - '' + - '' + - '' + - '' + - '' enum: - - ACTIVE - - MANAGED_CERTIFICATE_STATUS_UNSPECIFIED - - PROVISIONING - - PROVISIONING_FAILED - - PROVISIONING_FAILED_PERMANENTLY - - RENEWAL_FAILED - domainStatus: + - INTERVAL_10_MIN + - INTERVAL_15_MIN + - INTERVAL_1_MIN + - INTERVAL_30_SEC + - INTERVAL_5_MIN + - INTERVAL_5_SEC + flowSampling: description: >- - [Output only] Detailed statuses of the domains specified for managed - certificate resource. - type: object - additionalProperties: - type: string - enumDescriptions: - - >- - A managed certificate can be provisioned, no issues for this - domain. - - '' - - Failed to check CAA records for the domain. - - >- - Certificate issuance forbidden by an explicit CAA record for the - domain. - - >- - There seems to be problem with the user's DNS or load balancer - configuration for this domain. - - >- - Reached rate-limit for certificates per top-level private - domain. - - >- - Certificate provisioning for this domain is under way. GCP will - attempt to provision the first certificate. - enum: - - ACTIVE - - DOMAIN_STATUS_UNSPECIFIED - - FAILED_CAA_CHECKING - - FAILED_CAA_FORBIDDEN - - FAILED_NOT_VISIBLE - - FAILED_RATE_LIMITED - - PROVISIONING - SslCertificateSelfManagedSslCertificate: - id: SslCertificateSelfManagedSslCertificate - description: Configuration and status of a self-managed SSL certificate. - type: object - properties: - certificate: + 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 unless otherwise specified by the org policy, which + means half of all collected logs are reported. + type: number + format: float + metadata: 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. + 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. type: string - privateKey: + enumDescriptions: + - '' + - '' + - '' + enum: + - CUSTOM_METADATA + - EXCLUDE_ALL_METADATA + - INCLUDE_ALL_METADATA + metadataFields: description: >- - A write-only private key in PEM format. Only insert requests will - include this field. + Can only be specified if VPC flow logs for this subnetwork is + enabled and "metadata" was set to CUSTOM_METADATA. + type: array + items: + type: string + filterExpr: + description: >- + Can only be specified if VPC flow logs for this subnetwork is + enabled. The filter expression is used to define which VPC flow logs + should be exported to Cloud Logging. type: string - SslCertificateAggregatedList: - id: SslCertificateAggregatedList + SubnetworkParams: + id: SubnetworkParams + description: Additional subnetwork parameters. + type: object + properties: + resourceManagerTags: + description: >- + Tag keys/values directly bound to this resource. Tag keys and values + have the same definition as resource manager tags. The field is + allowed for INSERT only. The keys/values to set on the resource + should be specified in either ID { : } or Namespaced format { : }. + For example the following are valid inputs: * {"tagKeys/333" : + "tagValues/444", "tagKeys/123" : "tagValues/456"} * + {"123/environment" : "production", "345/abc" : "xyz"} Note: * + Invalid combinations of ID & namespaced format is not supported. For + instance: {"123/environment" : "tagValues/444"} is invalid. + type: object + additionalProperties: + type: string + SubnetworkAggregatedList: + id: SubnetworkAggregatedList type: object properties: kind: description: >- [Output Only] Type of resource. Always - compute#sslCertificateAggregatedList for lists of SSL Certificates. - default: compute#sslCertificateAggregatedList + compute#subnetworkAggregatedList for aggregated lists of + subnetworks. + default: compute#subnetworkAggregatedList type: string id: description: >- @@ -46694,11 +46068,11 @@ components: server. type: string items: - description: A list of SslCertificatesScopedList resources. + description: A list of SubnetworksScopedList resources. type: object additionalProperties: - description: Name of the scope containing this set of SslCertificates. - $ref: '#/components/schemas/SslCertificatesScopedList' + description: Name of the scope containing this set of Subnetworks. + $ref: '#/components/schemas/SubnetworksScopedList' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -46774,6 +46148,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -46817,6 +46194,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -46839,6 +46217,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -46880,19 +46259,19 @@ components: type: array items: type: string - SslCertificatesScopedList: - id: SslCertificatesScopedList + SubnetworksScopedList: + id: SubnetworksScopedList type: object properties: - sslCertificates: - description: List of SslCertificates contained in this scope. + subnetworks: + description: A list of subnetworks contained in this scope. type: array items: - $ref: '#/components/schemas/SslCertificate' + $ref: '#/components/schemas/Subnetwork' warning: description: >- - Informational warning which replaces the list of backend services - when the list is empty. + An informational warning that appears when the list of addresses is + empty. type: object properties: code: @@ -46955,6 +46334,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -46998,6 +46380,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -47020,6 +46403,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -47056,26 +46440,27 @@ components: [Output Only] A warning data value corresponding to the key. type: string - SslPoliciesList: - id: SslPoliciesList + UsableSubnetworksAggregatedList: + id: UsableSubnetworksAggregatedList type: object properties: kind: description: >- - [Output Only] Type of the resource. Always compute#sslPoliciesList - for lists of sslPolicies. - default: compute#sslPoliciesList + [Output Only] Type of resource. Always + compute#usableSubnetworksAggregatedList for aggregated lists of + usable subnetworks. + default: compute#usableSubnetworksAggregatedList type: string id: description: >- - [Output Only] Unique identifier for the resource; defined by the - server. + [Output Only] The unique identifier for the resource. This + identifier is defined by the server. type: string items: - description: A list of SslPolicy resources. + description: '[Output] A list of usable subnetwork URLs.' type: array items: - $ref: '#/components/schemas/SslPolicy' + $ref: '#/components/schemas/UsableSubnetwork' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -47083,6 +46468,9 @@ components: maxResults, use the nextPageToken as a value 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.' @@ -47151,6 +46539,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -47194,6 +46585,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -47216,6 +46608,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -47252,330 +46645,150 @@ components: [Output Only] A warning data value corresponding to the key. type: string - SslPolicy: - id: SslPolicy + unreachables: + description: '[Output Only] Unreachable resources.' + type: array + items: + type: string + scopedWarnings: + description: >- + [Output Only] Informational warning messages for failures + encountered from scopes. + type: array + items: + $ref: '#/components/schemas/SubnetworksScopedWarning' + UsableSubnetwork: + id: UsableSubnetwork description: >- - Represents an SSL Policy resource. Use SSL policies to control SSL - features, such as versions and cipher suites, that are offered by - Application Load Balancers and proxy Network Load Balancers. For more - information, read SSL policies overview. + Subnetwork which the current user has compute.subnetworks.use permission + on. type: object properties: - kind: - description: >- - [Output only] Type of the resource. Always compute#sslPolicyfor SSL - policies. - default: compute#sslPolicy - type: string - id: - description: >- - [Output Only] The unique identifier for the resource. This - identifier is defined by the server. + subnetwork: + description: Subnetwork URL. type: string - format: uint64 - creationTimestamp: - description: '[Output Only] Creation timestamp in RFC3339 text format.' + network: + description: Network URL. type: string - selfLink: - description: '[Output Only] Server-defined URL for the resource.' - 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])?' + ipCidrRange: + description: The range of internal addresses that are owned by this subnetwork. type: string - description: + secondaryIpRanges: + description: Secondary IP ranges. + type: array + items: + $ref: '#/components/schemas/UsableSubnetworkSecondaryRange' + stackType: description: >- - An optional description of this resource. Provide this property when - you create the resource. + The stack type for the subnet. If set to IPV4_ONLY, new VMs in the + subnet are assigned IPv4 addresses only. If set to IPV4_IPV6, new + VMs in the subnet can be assigned both IPv4 and IPv6 addresses. If + not specified, IPV4_ONLY is used. This field can be both set at + resource creation time and updated using patch. type: string - profile: + enumDescriptions: + - New VMs in this subnet can have both IPv4 and IPv6 addresses. + - New VMs in this subnet will only be assigned IPv4 addresses. + - New VMs in this subnet will only be assigned IPv6 addresses. + enum: + - IPV4_IPV6 + - IPV4_ONLY + - IPV6_ONLY + ipv6AccessType: 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. + 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. type: string enumDescriptions: - >- - Compatible profile. Allows the broadset set of clients, even those - which support only out-of-date SSL features to negotiate with the - load balancer. + VMs on this subnet will be assigned IPv6 addresses that are + accessible via the Internet, as well as the VPC network. - >- - Custom profile. Allow only the set of allowed SSL features - specified in the customFeatures field. + VMs on this subnet will be assigned IPv6 addresses that are only + accessible over the VPC network. + enum: + - EXTERNAL + - INTERNAL + purpose: + type: string + enumDescriptions: + - Subnet reserved for Global Envoy-based Load Balancing. - >- - Modern profile. Supports a wide set of SSL features, allowing - modern clients to negotiate SSL with the load balancer. + Subnet reserved for Internal HTTP(S) Load Balancing. This is a + legacy purpose, please use REGIONAL_MANAGED_PROXY instead. - >- - Restricted profile. Supports a reduced set of SSL features, - intended to meet stricter compliance requirements. + Subnetwork will be used for Migration from one peered VPC to + another. (a transient state of subnetwork while migrating + resources from one project to another). + - Regular user created or automatically created subnet. + - Subnetwork used as source range for Private NAT Gateways. + - Regular user created or automatically created subnet. + - >- + Subnetworks created for Private Service Connect in the producer + network. + - Subnetwork used for Regional Envoy-based Load Balancing. enum: - - COMPATIBLE - - CUSTOM - - MODERN - - RESTRICTED - minTlsVersion: + - GLOBAL_MANAGED_PROXY + - INTERNAL_HTTPS_LOAD_BALANCER + - PEER_MIGRATION + - PRIVATE + - PRIVATE_NAT + - PRIVATE_RFC_1918 + - PRIVATE_SERVICE_CONNECT + - REGIONAL_MANAGED_PROXY + role: 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. + The role of subnetwork. Currently, this field is only used when + purpose is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. + The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is + one that is currently being used for Envoy-based load balancers in a + region. 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. type: string enumDescriptions: - - TLS 1.0 - - TLS 1.1 - - TLS 1.2 + - The ACTIVE subnet that is currently used. + - The BACKUP subnet that could be promoted to ACTIVE. enum: - - TLS_1_0 - - TLS_1_1 - - TLS_1_2 - enabledFeatures: - description: '[Output Only] The list of features enabled in the SSL policy.' - type: array - items: - 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. - type: array - items: - type: string - fingerprint: + - ACTIVE + - BACKUP + externalIpv6Prefix: 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. + [Output Only] The external IPv6 address range that is assigned to + this subnetwork. type: string - format: byte - warnings: - description: >- - [Output Only] If potential misconfigurations are detected for this - SSL policy, this field will be populated with warning messages. - type: array - items: - type: object - properties: - code: - description: >- - [Output Only] A warning code, if applicable. For example, - Compute Engine returns NO_RESULTS_ON_PAGE if there are no - results in the response. - type: string - enumDescriptions: - - >- - Warning about failed cleanup of transient changes made by a - failed operation. - - A link to a deprecated resource was created. - - >- - When deploying and at least one of the resources has a type - marked as deprecated - - The user created a boot disk that is larger than image size. - - >- - When deploying and at least one of the resources has a type - marked as experimental - - Warning that is present in an external api call - - >- - Warning that value of a field has been overridden. - Deprecated unused field. - - >- - The operation involved use of an injected kernel, which is - deprecated. - - >- - A WEIGHTED_MAGLEV backend service is associated with a - health check that is not of type HTTP/HTTPS/HTTP2. - - >- - When deploying a deployment with a exceedingly large number - of resources - - >- - Resource can't be retrieved due to list overhead quota - exceed which captures the amount of resources filtered out - by user-defined list filter. - - A resource depends on a missing type - - >- - The route's nextHopIp address is not assigned to an instance - on the network. - - The route's next hop instance cannot ip forward. - - >- - The route's nextHopInstance URL refers to an instance that - does not have an ipv6 interface on the same network as the - route. - - >- - The route's nextHopInstance URL refers to an instance that - does not exist. - - >- - The route's nextHopInstance URL refers to an instance that - is not on the same network as the route. - - >- - The route's next hop instance does not have a status of - RUNNING. - - >- - Error which is not critical. We decided to continue the - process despite the mentioned error. - - No results are present on a particular list page. - - >- - Success is reported, but some results may be missing due to - errors - - >- - The user attempted to use a resource that requires a TOS - they have not accepted. - - Warning that a resource is in use. - - >- - One or more of the resources set to auto-delete could not be - deleted because they were in use. - - When a resource schema validation is ignored. - - >- - Instance template used in instance group manager is valid as - such, but its application does not make a lot of sense, - because it allows only single instance in instance group. - - When undeclared properties in the schema are present - - A given scope cannot be reached. - enumDeprecated: - - false - - false - - false - - false - - false - - false - - true - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - enum: - - CLEANUP_FAILED - - DEPRECATED_RESOURCE_USED - - DEPRECATED_TYPE_USED - - DISK_SIZE_LARGER_THAN_IMAGE_SIZE - - EXPERIMENTAL_TYPE_USED - - EXTERNAL_API_WARNING - - FIELD_VALUE_OVERRIDEN - - INJECTED_KERNELS_DEPRECATED - - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB - - LARGE_DEPLOYMENT_WARNING - - LIST_OVERHEAD_QUOTA_EXCEED - - MISSING_TYPE_DEPENDENCY - - NEXT_HOP_ADDRESS_NOT_ASSIGNED - - NEXT_HOP_CANNOT_IP_FORWARD - - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE - - NEXT_HOP_INSTANCE_NOT_FOUND - - NEXT_HOP_INSTANCE_NOT_ON_NETWORK - - NEXT_HOP_NOT_RUNNING - - NOT_CRITICAL_ERROR - - NO_RESULTS_ON_PAGE - - PARTIAL_SUCCESS - - REQUIRED_TOS_AGREEMENT - - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - - RESOURCE_NOT_DELETED - - SCHEMA_VALIDATION_IGNORED - - SINGLE_INSTANCE_PROPERTY_TEMPLATE - - UNDECLARED_PROPERTIES - - UNREACHABLE - message: - description: >- - [Output Only] A human-readable description of the warning - code. - type: string - data: - description: >- - [Output Only] Metadata about this warning in key: value - format. For example: "data": [ { "key": "scope", "value": - "zones/us-east1-d" } - type: array - items: - type: object - properties: - key: - description: >- - [Output Only] A key that provides more detail on the - warning being returned. For example, for warnings where - there are no results in a list request for a particular - zone, this key might be scope and the key value might be - the zone name. Other examples might be a key indicating - a deprecated resource and a suggested replacement, or a - warning about invalid network settings (for example, if - an instance attempts to perform IP forwarding but is not - enabled for IP forwarding). - type: string - value: - description: >- - [Output Only] A warning data value corresponding to the - key. - type: string - region: + internalIpv6Prefix: description: >- - [Output Only] URL of the region where the regional SSL policy - resides. This field is not applicable to global SSL policies. + [Output Only] The internal IPv6 address range that is assigned to + this subnetwork. type: string - SslPoliciesListAvailableFeaturesResponse: - id: SslPoliciesListAvailableFeaturesResponse - type: object - properties: - features: - type: array - items: - type: string - SslPoliciesAggregatedList: - id: SslPoliciesAggregatedList + UsableSubnetworkSecondaryRange: + id: UsableSubnetworkSecondaryRange + description: Secondary IP range of a usable subnetwork. type: object properties: - kind: - description: >- - [Output Only] Type of resource. Always - compute#sslPolicyAggregatedList for lists of SSL Policies. - default: compute#sslPoliciesAggregatedList - type: string - id: + rangeName: description: >- - [Output Only] Unique identifier for the resource; defined by the - server. + 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 - items: - description: A list of SslPoliciesScopedList resources. - type: object - additionalProperties: - description: Name of the scope containing this set of SSL policies. - $ref: '#/components/schemas/SslPoliciesScopedList' - nextPageToken: + ipCidrRange: description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. + The range of IP addresses belonging to this subnetwork secondary + range. type: string - selfLink: - description: '[Output Only] Server-defined URL for this resource.' + SubnetworksScopedWarning: + id: SubnetworksScopedWarning + type: object + properties: + scopeName: + description: Name of the scope containing this set of Subnetworks. type: string warning: - description: '[Output Only] Informational warning message.' + description: An informational warning about unreachable scope type: object properties: code: @@ -47638,6 +46851,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -47681,6 +46897,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -47703,6 +46920,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -47739,26 +46957,57 @@ components: [Output Only] A warning data value corresponding to the key. type: string - etag: + SubnetworksExpandIpCidrRangeRequest: + id: SubnetworksExpandIpCidrRangeRequest + type: object + 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 - unreachables: - description: '[Output Only] Unreachable resources.' - type: array - items: - type: string - SslPoliciesScopedList: - id: SslPoliciesScopedList + SubnetworksSetPrivateIpGoogleAccessRequest: + id: SubnetworksSetPrivateIpGoogleAccessRequest type: object properties: - sslPolicies: - description: A list of SslPolicies contained in this scope. + privateIpGoogleAccess: + type: boolean + NetworkProfilesListResponse: + id: NetworkProfilesListResponse + description: Contains a list of network profiles. + type: object + properties: + kind: + description: >- + [Output Only] Type of resource. Always compute#networkProfileList + for network profiles. + default: compute#networkProfileList + type: string + id: + description: >- + [Output Only] Unique identifier for the resource; defined by the + server. + type: string + items: + description: A list of NetworkProfile resources. type: array items: - $ref: '#/components/schemas/SslPolicy' - warning: + $ref: '#/components/schemas/NetworkProfile' + nextPageToken: description: >- - Informational warning which replaces the list of SSL policies when - the list is empty. + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. + type: string + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string + warning: + description: '[Output Only] Informational warning message.' type: object properties: code: @@ -47821,6 +47070,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -47864,6 +47116,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -47886,6 +47139,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -47922,102 +47176,658 @@ components: [Output Only] A warning data value corresponding to the key. type: string - StoragePoolTypeList: - id: StoragePoolTypeList - description: Contains a list of storage pool types. + etag: + type: string + unreachables: + description: >- + [Output Only] Unreachable resources. end_interface: + MixerListResponseWithEtagBuilder + type: array + items: + type: string + NetworkProfile: + id: NetworkProfile + description: NetworkProfile represents a Google managed network profile resource. type: object properties: kind: description: >- - [Output Only] Type of resource. Always compute#storagePoolTypeList - for storage pool types. - default: compute#storagePoolTypeList + [Output Only] Type of the resource. Always compute#networkProfile + for network profiles. + default: compute#networkProfile type: string id: description: >- - [Output Only] Unique identifier for the resource; defined by the - server. + [Output Only] The unique identifier for the resource. This + identifier is defined by the server. type: string - items: - description: A list of StoragePoolType resources. - type: array - items: - $ref: '#/components/schemas/StoragePoolType' - nextPageToken: - description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. + format: uint64 + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + name: + description: '[Output Only] Name of the resource.' + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + type: string + description: + description: '[Output Only] An optional description of this resource.' type: string selfLink: - description: '[Output Only] Server-defined URL for this resource.' + description: '[Output Only] Server-defined URL for the resource.' type: string - warning: - description: '[Output Only] Informational warning message.' - type: object - properties: - code: - description: >- - [Output Only] A warning code, if applicable. For example, - Compute Engine returns NO_RESULTS_ON_PAGE if there are no - results in the response. - type: string - enumDescriptions: - - >- - Warning about failed cleanup of transient changes made by a - failed operation. - - A link to a deprecated resource was created. - - >- - When deploying and at least one of the resources has a type - marked as deprecated - - The user created a boot disk that is larger than image size. - - >- - When deploying and at least one of the resources has a type - marked as experimental - - Warning that is present in an external api call - - >- - Warning that value of a field has been overridden. Deprecated - unused field. - - >- - The operation involved use of an injected kernel, which is - deprecated. - - >- - A WEIGHTED_MAGLEV backend service is associated with a health - check that is not of type HTTP/HTTPS/HTTP2. - - >- - When deploying a deployment with a exceedingly large number of - resources - - >- - Resource can't be retrieved due to list overhead quota exceed - which captures the amount of resources filtered out by - user-defined list filter. - - A resource depends on a missing type - - >- - The route's nextHopIp address is not assigned to an instance - on the network. - - The route's next hop instance cannot ip forward. - - >- - The route's nextHopInstance URL refers to an instance that - does not have an ipv6 interface on the same network as the - route. - - >- - The route's nextHopInstance URL refers to an instance that - does not exist. - - >- - The route's nextHopInstance URL refers to an instance that is - not on the same network as the route. - - >- - The route's next hop instance does not have a status of - RUNNING. - - >- + selfLinkWithId: + description: >- + [Output Only] Server-defined URL for this resource with the resource + id. + type: string + location: + description: '[Output Only] Location to which the network is restricted.' + $ref: '#/components/schemas/NetworkProfileLocation' + features: + description: '[Output Only] Features supported by the network.' + $ref: '#/components/schemas/NetworkProfileNetworkFeatures' + NetworkProfileLocation: + id: NetworkProfileLocation + type: object + properties: + scope: + type: string + enumDescriptions: + - '' + - '' + enum: + - REGION + - ZONE + name: + type: string + NetworkProfileNetworkFeatures: + id: NetworkProfileNetworkFeatures + type: object + properties: + allowSameNetworkUnicast: + description: Specifies whether unicast within the same network is allowed. + type: string + enumDescriptions: + - '' + - '' + enum: + - SAME_NETWORK_UNICAST_ALLOWED + - SAME_NETWORK_UNICAST_BLOCKED + unicast: + description: Specifies which type of unicast is supported. + type: string + enumDescriptions: + - '' + - '' + enum: + - UNICAST_SDN + - UNICAST_ULL + allowAutoModeSubnet: + description: Specifies whether auto mode subnet creation is allowed. + type: string + enumDescriptions: + - '' + - '' + enum: + - AUTO_MODE_SUBNET_ALLOWED + - AUTO_MODE_SUBNET_BLOCKED + allowVpcPeering: + description: Specifies whether VPC peering is allowed. + type: string + enumDescriptions: + - '' + - '' + enum: + - VPC_PEERING_ALLOWED + - VPC_PEERING_BLOCKED + allowMultiNicInSameNetwork: + description: Specifies whether multi-nic in the same network is allowed. + type: string + enumDescriptions: + - '' + - '' + enum: + - MULTI_NIC_IN_SAME_NETWORK_ALLOWED + - MULTI_NIC_IN_SAME_NETWORK_BLOCKED + allowLoadBalancing: + description: Specifies whether cloud load balancing is allowed. + type: string + enumDescriptions: + - '' + - '' + enum: + - LOAD_BALANCING_ALLOWED + - LOAD_BALANCING_BLOCKED + allowStaticRoutes: + description: Specifies whether static route creation is allowed. + type: string + enumDescriptions: + - '' + - '' + enum: + - STATIC_ROUTES_ALLOWED + - STATIC_ROUTES_BLOCKED + allowPsc: + description: Specifies whether PSC creation is allowed. + type: string + enumDescriptions: + - '' + - '' + enum: + - PSC_ALLOWED + - PSC_BLOCKED + allowCloudRouter: + description: Specifies whether cloud router creation is allowed. + type: string + enumDescriptions: + - '' + - '' + enum: + - CLOUD_ROUTER_ALLOWED + - CLOUD_ROUTER_BLOCKED + allowCloudNat: + description: Specifies whether cloud NAT creation is allowed. + type: string + enumDescriptions: + - '' + - '' + enum: + - CLOUD_NAT_ALLOWED + - CLOUD_NAT_BLOCKED + allowVpn: + description: Specifies whether VPN creation is allowed. + type: string + enumDescriptions: + - '' + - '' + enum: + - VPN_ALLOWED + - VPN_BLOCKED + allowInterconnect: + description: Specifies whether Cloud Interconnect creation is allowed. + type: string + enumDescriptions: + - '' + - '' + enum: + - INTERCONNECT_ALLOWED + - INTERCONNECT_BLOCKED + allowPacketMirroring: + description: Specifies whether Packet Mirroring 1.0 is supported. + type: string + enumDescriptions: + - '' + - '' + enum: + - PACKET_MIRRORING_ALLOWED + - PACKET_MIRRORING_BLOCKED + subnetworkPurposes: + description: Specifies which subnetwork purposes are supported. + type: array + items: + type: string + enumDescriptions: + - Subnet reserved for Global Envoy-based Load Balancing. + - >- + Subnet reserved for Internal HTTP(S) Load Balancing. This is a + legacy purpose, please use REGIONAL_MANAGED_PROXY instead. + - >- + Subnetwork will be used for Migration from one peered VPC to + another. (a transient state of subnetwork while migrating + resources from one project to another). + - Regular user created or automatically created subnet. + - Subnetwork used as source range for Private NAT Gateways. + - Regular user created or automatically created subnet. + - >- + Subnetworks created for Private Service Connect in the producer + network. + - Subnetwork used for Regional Envoy-based Load Balancing. + enum: + - GLOBAL_MANAGED_PROXY + - INTERNAL_HTTPS_LOAD_BALANCER + - PEER_MIGRATION + - PRIVATE + - PRIVATE_NAT + - PRIVATE_RFC_1918 + - PRIVATE_SERVICE_CONNECT + - REGIONAL_MANAGED_PROXY + subnetworkStackTypes: + description: Specifies which subnetwork stack types are supported. + type: array + items: + type: string + enumDescriptions: + - New VMs in this subnet can have both IPv4 and IPv6 addresses. + - New VMs in this subnet will only be assigned IPv4 addresses. + - New VMs in this subnet will only be assigned IPv6 addresses. + enum: + - IPV4_IPV6 + - IPV4_ONLY + - IPV6_ONLY + subnetPurposes: + description: Specifies which subnetwork purposes are supported. + type: array + items: + type: string + enumDescriptions: + - '' + - '' + enum: + - SUBNET_PURPOSE_CUSTOM_HARDWARE + - SUBNET_PURPOSE_PRIVATE + subnetStackTypes: + description: Specifies which subnetwork stack types are supported. + type: array + items: + type: string + enumDescriptions: + - '' + - '' + - '' + enum: + - SUBNET_STACK_TYPE_IPV4_IPV6 + - SUBNET_STACK_TYPE_IPV4_ONLY + - SUBNET_STACK_TYPE_IPV6_ONLY + allowPrivateGoogleAccess: + description: Specifies whether private Google access is allowed. + type: string + enumDescriptions: + - '' + - '' + enum: + - PRIVATE_GOOGLE_ACCESS_ALLOWED + - PRIVATE_GOOGLE_ACCESS_BLOCKED + interfaceTypes: + description: >- + If set, limits the interface types that the network supports. If + empty, all interface types are supported. + type: array + items: + type: string + enumDescriptions: + - GVNIC + - IDPF + - IRDMA + - MRDMA + - No type specified. + - VIRTIO + enum: + - GVNIC + - IDPF + - IRDMA + - MRDMA + - UNSPECIFIED_NIC_TYPE + - VIRTIO_NET + allowClassDFirewalls: + description: >- + Specifies whether firewalls for Class D address ranges are + supported. + type: string + enumDescriptions: + - '' + - '' + enum: + - CLASS_D_FIREWALLS_ALLOWED + - CLASS_D_FIREWALLS_BLOCKED + allowSubInterfaces: + description: Specifies whether sub interfaces are allowed. + type: string + enumDescriptions: + - '' + - '' + enum: + - SUBINTERFACES_ALLOWED + - SUBINTERFACES_BLOCKED + allowExternalIpAccess: + description: >- + Specifies whether VMs are allowed to have external IP access on + network interfaces connected to this VPC. + type: string + enumDescriptions: + - '' + - '' + enum: + - EXTERNAL_IP_ACCESS_ALLOWED + - EXTERNAL_IP_ACCESS_BLOCKED + addressPurposes: + description: >- + Specifies what address purposes are supported. If empty, all address + purposes are supported. + type: array + items: + type: string + enumDescriptions: + - DNS resolver address in the subnetwork. + - VM internal/alias IP, Internal LB service IP, etc. + - >- + A regional internal IP address range reserved for the VLAN + attachment that is used in HA VPN over Cloud Interconnect. This + regional internal IP address range must not overlap with any IP + address range of subnet/route in the VPC network and its peering + networks. After the VLAN attachment is created with the reserved + IP address range, when creating a new VPN gateway, its interface + IP address is allocated from the associated VLAN attachment’s IP + address range. + - External IP automatically reserved for Cloud NAT. + - >- + A private network IP address that can be used to configure + Private Service Connect. This purpose can be specified only for + GLOBAL addresses of Type INTERNAL + - A regional internal IP address range reserved for Serverless. + - >- + A private network IP address that can be shared by multiple + Internal Load Balancer forwarding rules. + - IP range for peer networks. + enum: + - DNS_RESOLVER + - GCE_ENDPOINT + - IPSEC_INTERCONNECT + - NAT_AUTO + - PRIVATE_SERVICE_CONNECT + - SERVERLESS + - SHARED_LOADBALANCER_VIP + - VPC_PEERING + allowAliasIpRanges: + description: >- + Specifies whether alias IP ranges (and secondary address ranges) are + allowed. + type: string + enumDescriptions: + - '' + - '' + enum: + - ALIAS_IP_RANGES_ALLOWED + - ALIAS_IP_RANGES_BLOCKED + allowDefaultNicAttachment: + description: Specifies whether default NIC attachment is allowed. + type: string + enumDescriptions: + - '' + - '' + enum: + - DEFAULT_NIC_ATTACHMENT_ALLOWED + - DEFAULT_NIC_ATTACHMENT_BLOCKED + allowNcc: + description: Specifies whether NCC is allowed. + type: string + enumDescriptions: + - '' + - '' + enum: + - NCC_ALLOWED + - NCC_BLOCKED + allowIpForwarding: + description: Specifies whether IP forwarding is allowed. + type: string + enumDescriptions: + - '' + - '' + enum: + - IP_FORWARDING_ALLOWED + - IP_FORWARDING_BLOCKED + allowNetworkMigration: + description: Specifies whether VM network migration is allowed. + type: string + enumDescriptions: + - '' + - '' + enum: + - NETWORK_MIGRATION_ALLOWED + - NETWORK_MIGRATION_BLOCKED + ReservationBlocksGetResponse: + id: ReservationBlocksGetResponse + type: object + properties: + resource: + $ref: '#/components/schemas/ReservationBlock' + ReservationBlock: + id: ReservationBlock + description: Represents a reservation block resource. + type: object + properties: + kind: + description: >- + [Output Only] Type of the resource. Always compute#reservationBlock + for reservation blocks. + default: compute#reservationBlock + type: string + id: + description: >- + [Output Only] The unique identifier for the resource. This + identifier is defined by the server. + type: string + format: uint64 + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + name: + description: >- + [Output Only] The name of this reservation block generated by Google + Compute Engine. 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 + zone: + description: '[Output Only] Zone in which the reservation block resides.' + type: string + selfLink: + description: '[Output Only] Server-defined fully-qualified URL for this resource.' + type: string + selfLinkWithId: + description: >- + [Output Only] Server-defined URL for this resource with the resource + id. + type: string + count: + description: >- + [Output Only] The number of resources that are allocated in this + reservation block. + type: integer + format: int32 + inUseCount: + description: >- + [Output Only] The number of instances that are currently in use on + this reservation block. + type: integer + format: int32 + reservationMaintenance: + description: '[Output Only] Maintenance information for this reservation block.' + $ref: '#/components/schemas/GroupMaintenanceInfo' + status: + description: '[Output Only] Status of the reservation block.' + type: string + enumDescriptions: + - Resources are being allocated for the reservation block. + - Reservation block is currently being deleted. + - '' + - Reservation block has allocated all its resources. + enum: + - CREATING + - DELETING + - INVALID + - READY + physicalTopology: + description: '[Output Only] The physical topology of the reservation block.' + $ref: '#/components/schemas/ReservationBlockPhysicalTopology' + reservationSubBlockCount: + description: >- + [Output Only] The number of reservation subBlocks associated with + this reservation block. + type: integer + format: int32 + reservationSubBlockInUseCount: + description: >- + [Output Only] The number of in-use reservation subBlocks associated + with this reservation block. If at least one VM is running on a + subBlock, it is considered in-use. + type: integer + format: int32 + healthInfo: + description: '[Output Only] Health information for the reservation block.' + $ref: '#/components/schemas/ReservationBlockHealthInfo' + ReservationBlockPhysicalTopology: + id: ReservationBlockPhysicalTopology + type: object + properties: + cluster: + description: The cluster name of the reservation block. + type: string + block: + description: The hash of the capacity block within the cluster. + type: string + instances: + description: The detailed instances information for a given Block + type: array + items: + $ref: '#/components/schemas/ReservationBlockPhysicalTopologyInstance' + ReservationBlockPhysicalTopologyInstance: + id: ReservationBlockPhysicalTopologyInstance + description: The instances information for a given Block + type: object + properties: + instanceId: + description: The InstanceId of the instance + type: string + format: uint64 + projectId: + description: Project where the instance lives + type: string + format: uint64 + physicalHostTopology: + description: The PhysicalHostTopology of instances within a Block resource. + $ref: >- + #/components/schemas/ReservationBlockPhysicalTopologyInstancePhysicalHostTopology + ReservationBlockPhysicalTopologyInstancePhysicalHostTopology: + id: ReservationBlockPhysicalTopologyInstancePhysicalHostTopology + description: The PhysicalHostTopology of the instance within a Block resource. + type: object + properties: + subBlock: + description: Sub block hash for a given instance + type: string + host: + description: Host hash for a given instance + type: string + ReservationBlockHealthInfo: + id: ReservationBlockHealthInfo + description: Health information for the reservation block. + type: object + properties: + healthStatus: + description: The health status of the reservation block. + type: string + enumDescriptions: + - The reservation block is degraded. + - The reservation block is healthy. + - The health status of the reservation block is unspecified. + enum: + - DEGRADED + - HEALTHY + - HEALTH_STATUS_UNSPECIFIED + healthySubBlockCount: + description: The number of subBlocks that are healthy. + type: integer + format: int32 + degradedSubBlockCount: + description: The number of subBlocks that are degraded. + type: integer + format: int32 + ReservationBlocksListResponse: + id: ReservationBlocksListResponse + description: A list of reservation blocks under a single reservation. + type: object + properties: + kind: + description: >- + Type of the resource. Always compute#reservationBlock for a list of + reservation blocks. + default: compute#reservationBlock + type: string + id: + description: Unique identifier for the resource; defined by the server. + type: string + items: + description: A list of reservation block resources. + type: array + items: + $ref: '#/components/schemas/ReservationBlock' + nextPageToken: + description: >- + This token allows you to get the next page of results for list + requests. If the number of results is larger than maxResults, use + the nextPageToken as a value for the query parameter pageToken in + the next list request. Subsequent list requests will have their own + nextPageToken to continue paging through the results. + type: string + selfLink: + description: Server-defined URL for this resource. + type: string + warning: + description: Informational warning message. + type: object + properties: + code: + description: >- + [Output Only] A warning code, if applicable. For example, + Compute Engine returns NO_RESULTS_ON_PAGE if there are no + results in the response. + type: string + enumDescriptions: + - >- + Warning about failed cleanup of transient changes made by a + failed operation. + - A link to a deprecated resource was created. + - >- + When deploying and at least one of the resources has a type + marked as deprecated + - The user created a boot disk that is larger than image size. + - >- + When deploying and at least one of the resources has a type + marked as experimental + - Warning that is present in an external api call + - >- + Warning that value of a field has been overridden. Deprecated + unused field. + - >- + The operation involved use of an injected kernel, which is + deprecated. + - >- + A WEIGHTED_MAGLEV backend service is associated with a health + check that is not of type HTTP/HTTPS/HTTP2. + - >- + When deploying a deployment with a exceedingly large number of + resources + - >- + Resource can't be retrieved due to list overhead quota exceed + which captures the amount of resources filtered out by + user-defined list filter. + - A resource depends on a missing type + - >- + The route's nextHopIp address is not assigned to an instance + on the network. + - The route's next hop instance cannot ip forward. + - >- + The route's nextHopInstance URL refers to an instance that + does not have an ipv6 interface on the same network as the + route. + - >- + The route's nextHopInstance URL refers to an instance that + does not exist. + - >- + The route's nextHopInstance URL refers to an instance that is + not on the same network as the route. + - >- + The route's next hop instance does not have a status of + RUNNING. + - >- Error which is not critical. We decided to continue the process despite the mentioned error. - No results are present on a particular list page. - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -48061,6 +47871,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -48083,6 +47894,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -48119,15 +47931,48 @@ components: [Output Only] A warning data value corresponding to the key. type: string - StoragePoolType: - id: StoragePoolType + ReservationsBlocksPerformMaintenanceRequest: + id: ReservationsBlocksPerformMaintenanceRequest + type: object + properties: + maintenanceScope: + description: >- + Specifies if all, running or unused hosts are in scope for this + request. + type: string + enumDescriptions: + - >- + Trigger maintenance for all hosts belonging to this reservation + irrespective of whether VMs are running on them or not. + - Internal only + - >- + Trigger maintenance only on the hosts belonging to this + reservation which have VMs running on them. + - >- + Trigger maintenance only on the hosts belonging to this + reservation which do not have any VMs running on them. This is not + allowed for Standard ExR + enum: + - ALL + - MAINTENANCE_SCOPE_UNSPECIFIED + - RUNNING_VMS + - UNUSED_CAPACITY + ReservationSubBlocksGetResponse: + id: ReservationSubBlocksGetResponse + type: object + properties: + resource: + $ref: '#/components/schemas/ReservationSubBlock' + ReservationSubBlock: + id: ReservationSubBlock + description: Represents a reservation subBlock resource. type: object properties: kind: description: >- - [Output Only] Type of the resource. Always compute#storagePoolType - for storage pool types. - default: compute#storagePoolType + [Output Only] Type of the resource. Always + compute#reservationSubBlock for reservation subBlocks. + default: compute#reservationSubBlock type: string id: description: >- @@ -48139,104 +47984,137 @@ components: description: '[Output Only] Creation timestamp in RFC3339 text format.' type: string name: - description: '[Output Only] Name of the resource.' - pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' - type: string - description: - description: '[Output Only] An optional description of this resource.' - type: string - deprecated: description: >- - [Output Only] The deprecation status associated with this storage - pool type. - $ref: '#/components/schemas/DeprecationStatus' + [Output Only] The name of this reservation subBlock generated by + Google Compute Engine. 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 zone: - description: >- - [Output Only] URL of the zone where the storage pool 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. + description: '[Output Only] Zone in which the reservation subBlock resides.' type: string selfLink: - description: '[Output Only] Server-defined URL for the resource.' + description: '[Output Only] Server-defined fully-qualified URL for this resource.' type: string selfLinkWithId: description: >- [Output Only] Server-defined URL for this resource with the resource id. type: string - minSizeGb: + count: description: >- - [Deprecated] This field is deprecated. Use - minPoolProvisionedCapacityGb instead. - type: string - format: int64 - minPoolProvisionedCapacityGb: - description: '[Output Only] Minimum storage pool size in GB.' - type: string - format: int64 - maxPoolProvisionedCapacityGb: - description: '[Output Only] Maximum storage pool size in GB.' + [Output Only] The number of hosts that are allocated in this + reservation subBlock. + type: integer + format: int32 + inUseCount: + description: >- + [Output Only] The number of instances that are currently in use on + this reservation subBlock. + type: integer + format: int32 + reservationSubBlockMaintenance: + description: Maintenance information for this reservation subBlock. + $ref: '#/components/schemas/GroupMaintenanceInfo' + status: + description: '[Output Only] Status of the reservation subBlock.' type: string - format: int64 - minPoolProvisionedIops: - description: '[Output Only] Minimum provisioned IOPS.' + enumDescriptions: + - Resources are being allocated for the reservation subBlock. + - Reservation subBlock is currently being deleted. + - '' + - Reservation subBlock has allocated all its resources. + enum: + - CREATING + - DELETING + - INVALID + - READY + physicalTopology: + description: '[Output Only] The physical topology of the reservation subBlock.' + $ref: '#/components/schemas/ReservationSubBlockPhysicalTopology' + healthInfo: + description: '[Output Only] Health information for the reservation subBlock.' + $ref: '#/components/schemas/ReservationSubBlockHealthInfo' + ReservationSubBlockPhysicalTopology: + id: ReservationSubBlockPhysicalTopology + type: object + properties: + cluster: + description: The cluster name of the reservation subBlock. type: string - format: int64 - maxPoolProvisionedIops: - description: '[Output Only] Maximum provisioned IOPS.' + block: + description: The hash of the capacity block within the cluster. type: string - format: int64 - minPoolProvisionedThroughput: - description: '[Output Only] Minimum provisioned throughput.' + subBlock: + description: The hash of the capacity sub-block within the capacity block. type: string - format: int64 - maxPoolProvisionedThroughput: - description: '[Output Only] Maximum provisioned throughput.' + ReservationSubBlockHealthInfo: + id: ReservationSubBlockHealthInfo + description: Health information for the reservation subBlock. + type: object + properties: + healthStatus: + description: The health status of the reservation subBlock. type: string - format: int64 - supportedDiskTypes: + enumDescriptions: + - The reservation subBlock is degraded. + - The reservation subBlock is healthy. + - The health status of the reservation subBlock is unspecified. + enum: + - DEGRADED + - HEALTHY + - HEALTH_STATUS_UNSPECIFIED + healthyHostCount: + description: The number of healthy hosts in the reservation subBlock. + type: integer + format: int32 + degradedHostCount: + description: The number of degraded hosts in the reservation subBlock. + type: integer + format: int32 + healthyInfraCount: description: >- - [Output Only] The list of disk types supported in this storage pool - type. - type: array - items: - type: string - StoragePoolTypeAggregatedList: - id: StoragePoolTypeAggregatedList + The number of healthy infrastructure (e.g NV link domain) in the + reservation subblock. + type: integer + format: int32 + degradedInfraCount: + description: >- + The number of degraded infrastructure (e.g NV link domain) in the + reservation subblock. + type: integer + format: int32 + ReservationSubBlocksListResponse: + id: ReservationSubBlocksListResponse + description: A list of reservation subBlocks under a single reservation. type: object properties: kind: description: >- - [Output Only] Type of resource. Always - compute#storagePoolTypeAggregatedList . - default: compute#storagePoolTypeAggregatedList + Type of the resource. Always compute#reservationSubBlock for a list + of reservation subBlocks. + default: compute#reservationSubBlock type: string id: - description: >- - [Output Only] Unique identifier for the resource; defined by the - server. + description: Unique identifier for the resource; defined by the server. type: string items: - description: A list of StoragePoolTypesScopedList resources. - type: object - additionalProperties: - description: >- - [Output Only] Name of the scope containing this set of storage - pool types. - $ref: '#/components/schemas/StoragePoolTypesScopedList' + description: A list of reservation subBlock resources. + type: array + items: + $ref: '#/components/schemas/ReservationSubBlock' nextPageToken: description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. + This token allows you to get the next page of results for list + requests. If the number of results is larger than maxResults, use + the nextPageToken as a value for the query parameter pageToken in + the next list request. Subsequent list requests will have their own + nextPageToken to continue paging through the results. type: string selfLink: - description: '[Output Only] Server-defined URL for this resource.' + description: Server-defined URL for this resource. type: string warning: - description: '[Output Only] Informational warning message.' + description: Informational warning message. type: object properties: code: @@ -48299,6 +48177,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -48342,6 +48223,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -48364,6 +48246,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -48400,19 +48283,36 @@ components: [Output Only] A warning data value corresponding to the key. type: string - StoragePoolTypesScopedList: - id: StoragePoolTypesScopedList + ResourcePolicyList: + id: ResourcePolicyList type: object properties: - storagePoolTypes: - description: '[Output Only] A list of storage pool types contained in this scope.' + kind: + description: >- + [Output Only] Type of resource.Always compute#resourcePoliciesList + for listsof resourcePolicies + default: compute#resourcePolicyList + 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.' type: array items: - $ref: '#/components/schemas/StoragePoolType' - warning: + $ref: '#/components/schemas/ResourcePolicy' + nextPageToken: description: >- - [Output Only] Informational warning which replaces the list of - storage pool types when the list is empty. + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the 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.' type: object properties: code: @@ -48475,6 +48375,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -48518,6 +48421,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -48540,6 +48444,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -48576,27 +48481,427 @@ components: [Output Only] A warning data value corresponding to the key. type: string - StoragePoolList: - id: StoragePoolList - description: A list of StoragePool resources. - type: object - properties: - kind: - description: >- - [Output Only] Type of resource. Always compute#storagePoolList for - lists of storagePools. - default: compute#storagePoolList + selfLink: + description: '[Output Only] Server-defined URL for this resource.' type: string - id: - description: >- - [Output Only] Unique identifier for the resource; defined by the - server. + etag: type: string - items: - description: A list of StoragePool resources. - type: array + ResourcePolicy: + id: 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. + type: object + properties: + snapshotSchedulePolicy: + description: Resource policy for persistent disks for creating snapshots. + $ref: '#/components/schemas/ResourcePolicySnapshotSchedulePolicy' + groupPlacementPolicy: + description: Resource policy for instances for placement configuration. + $ref: '#/components/schemas/ResourcePolicyGroupPlacementPolicy' + instanceSchedulePolicy: + description: Resource policy for scheduling instance operations. + $ref: '#/components/schemas/ResourcePolicyInstanceSchedulePolicy' + diskConsistencyGroupPolicy: + description: Resource policy for disk consistency groups. + $ref: '#/components/schemas/ResourcePolicyDiskConsistencyGroupPolicy' + workloadPolicy: + description: Resource policy for defining instance placement for MIGs. + $ref: '#/components/schemas/ResourcePolicyWorkloadPolicy' + kind: + description: >- + [Output Only] Type of the resource. Always compute#resource_policies + for resource policies. + default: compute#resourcePolicy + type: string + id: + description: >- + [Output Only] The unique identifier for the resource. This + identifier is defined by the server. + type: string + format: uint64 + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + selfLink: + description: '[Output Only] Server-defined fully-qualified URL for this resource.' + type: string + region: + type: string + description: + 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])?' + annotations: + required: + - compute.instances.insert + type: string + status: + description: '[Output Only] The status of resource policy creation.' + type: string + enumDescriptions: + - Resource policy is being created. + - Resource policy is being deleted. + - Resource policy is expired and will not run again. + - '' + - Resource policy is ready to be used. + enum: + - CREATING + - DELETING + - EXPIRED + - INVALID + - READY + resourceStatus: + description: '[Output Only] The system status of the resource policy.' + $ref: '#/components/schemas/ResourcePolicyResourceStatus' + ResourcePolicySnapshotSchedulePolicy: + id: 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. + type: object + properties: + schedule: + 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. + $ref: '#/components/schemas/ResourcePolicySnapshotSchedulePolicySchedule' + retentionPolicy: + description: >- + Retention policy applied to snapshots created by this resource + policy. + $ref: >- + #/components/schemas/ResourcePolicySnapshotSchedulePolicyRetentionPolicy + snapshotProperties: + description: >- + Properties with which snapshots are created such as labels, + encryption keys. + $ref: >- + #/components/schemas/ResourcePolicySnapshotSchedulePolicySnapshotProperties + ResourcePolicySnapshotSchedulePolicySchedule: + id: ResourcePolicySnapshotSchedulePolicySchedule + description: A schedule for disks where the schedueled operations are performed. + type: object + properties: + hourlySchedule: + $ref: '#/components/schemas/ResourcePolicyHourlyCycle' + dailySchedule: + $ref: '#/components/schemas/ResourcePolicyDailyCycle' + weeklySchedule: + $ref: '#/components/schemas/ResourcePolicyWeeklyCycle' + ResourcePolicyHourlyCycle: + id: ResourcePolicyHourlyCycle + description: Time window specified for hourly operations. + type: object + properties: + hoursInCycle: + description: >- + Defines a schedule with units measured in hours. The value + determines how many hours pass between the start of each cycle. + type: integer + format: int32 + 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 + duration: + description: >- + [Output only] Duration of the time window, automatically chosen to + be smallest possible in the given scenario. + type: string + ResourcePolicyDailyCycle: + id: ResourcePolicyDailyCycle + description: Time window specified for daily operations. + type: object + properties: + daysInCycle: + description: >- + Defines a schedule with units measured in days. The value determines + how many days pass between the start of each cycle. + type: integer + format: int32 + 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 + duration: + description: >- + [Output only] A predetermined duration for the window, automatically + chosen to be the smallest possible in the given scenario. + type: string + ResourcePolicyWeeklyCycle: + id: ResourcePolicyWeeklyCycle + description: Time window specified for weekly operations. + type: object + properties: + dayOfWeeks: + description: Up to 7 intervals/windows, one for each day of the week. + type: array items: - $ref: '#/components/schemas/StoragePool' + $ref: '#/components/schemas/ResourcePolicyWeeklyCycleDayOfWeek' + ResourcePolicyWeeklyCycleDayOfWeek: + id: ResourcePolicyWeeklyCycleDayOfWeek + type: object + 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. + type: string + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + enum: + - FRIDAY + - INVALID + - MONDAY + - SATURDAY + - SUNDAY + - THURSDAY + - TUESDAY + - WEDNESDAY + 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 + duration: + description: >- + [Output only] Duration of the time window, automatically chosen to + be smallest possible in the given scenario. + type: string + ResourcePolicySnapshotSchedulePolicyRetentionPolicy: + id: ResourcePolicySnapshotSchedulePolicyRetentionPolicy + description: Policy for retention of scheduled snapshots. + type: object + properties: + maxRetentionDays: + description: Maximum age of the snapshot that is allowed to be kept. + type: integer + format: int32 + onSourceDiskDelete: + description: >- + Specifies the behavior to apply to scheduled snapshots when the + source disk is deleted. + type: string + enumDescriptions: + - '' + - '' + - '' + enum: + - APPLY_RETENTION_POLICY + - KEEP_AUTO_SNAPSHOTS + - UNSPECIFIED_ON_SOURCE_DISK_DELETE + ResourcePolicySnapshotSchedulePolicySnapshotProperties: + id: ResourcePolicySnapshotSchedulePolicySnapshotProperties + description: >- + Specified snapshot properties for scheduled snapshots created by this + policy. + type: object + properties: + labels: + description: >- + Labels to apply to scheduled snapshots. These can be later modified + by the setLabels method. Label values may be empty. + type: object + additionalProperties: + type: string + storageLocations: + description: >- + Cloud Storage bucket storage location of the auto snapshot (regional + or multi-regional). + type: array + items: + type: string + guestFlush: + description: Indication to perform a 'guest aware' snapshot. + type: boolean + chainName: + description: Chain name that the snapshot is created in. + type: string + ResourcePolicyGroupPlacementPolicy: + id: ResourcePolicyGroupPlacementPolicy + description: >- + A GroupPlacementPolicy specifies resource placement configuration. It + specifies the failure bucket separation + type: object + properties: + vmCount: + description: >- + Number of VMs in this placement group. Google does not recommend + that you use this field unless you use a compact policy and you want + your policy to work only if it contains this exact number of VMs. + type: integer + format: int32 + availabilityDomainCount: + description: >- + The number of availability domains to spread instances across. If + two instances are in different availability domain, they are not in + the same low latency network. + type: integer + format: int32 + collocation: + description: Specifies network collocation + type: string + enumDescriptions: + - '' + - '' + enum: + - COLLOCATED + - UNSPECIFIED_COLLOCATION + gpuTopology: + description: >- + Specifies the shape of the GPU slice, in slice based GPU families + eg. A4X. + type: string + ResourcePolicyInstanceSchedulePolicy: + id: ResourcePolicyInstanceSchedulePolicy + description: >- + An InstanceSchedulePolicy specifies when and how frequent certain + operations are performed on the instance. + type: object + properties: + vmStartSchedule: + description: Specifies the schedule for starting instances. + $ref: '#/components/schemas/ResourcePolicyInstanceSchedulePolicySchedule' + vmStopSchedule: + description: Specifies the schedule for stopping instances. + $ref: '#/components/schemas/ResourcePolicyInstanceSchedulePolicySchedule' + 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: https://wikipedia.org/wiki/Tz_database. + type: string + startTime: + description: The start time of the schedule. The timestamp is an RFC3339 string. + type: string + expirationTime: + description: >- + The expiration time of the schedule. The timestamp is an RFC3339 + string. + type: string + ResourcePolicyInstanceSchedulePolicySchedule: + id: ResourcePolicyInstanceSchedulePolicySchedule + description: Schedule for an instance operation. + type: object + properties: + schedule: + description: >- + Specifies the frequency for the operation, using the unix-cron + format. + type: string + ResourcePolicyDiskConsistencyGroupPolicy: + id: ResourcePolicyDiskConsistencyGroupPolicy + description: Resource policy for disk consistency groups. + type: object + properties: {} + ResourcePolicyWorkloadPolicy: + id: ResourcePolicyWorkloadPolicy + description: Represents the workload policy. + type: object + properties: + type: + description: Specifies the intent of the instance placement in the MIG. + type: string + enumDescriptions: + - >- + MIG spreads out the instances as much as possible for high + availability. + - >- + MIG provisions instances as close to each other as possible for + high throughput. + enum: + - HIGH_AVAILABILITY + - HIGH_THROUGHPUT + maxTopologyDistance: + description: Specifies the maximum distance between instances. + type: string + enumDescriptions: + - VMs must be provisioned in the same block. + - VMs must be provisioned in the same cluster. + - VMs must be provisioned in the same subblock. + enum: + - BLOCK + - CLUSTER + - SUBBLOCK + acceleratorTopology: + description: >- + Specifies the topology required to create a partition for VMs that + have interconnected GPUs. + type: string + ResourcePolicyResourceStatus: + id: 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. + type: object + properties: + instanceSchedulePolicy: + 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. + $ref: >- + #/components/schemas/ResourcePolicyResourceStatusInstanceSchedulePolicyStatus + ResourcePolicyResourceStatusInstanceSchedulePolicyStatus: + id: ResourcePolicyResourceStatusInstanceSchedulePolicyStatus + type: object + properties: + 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 + lastRunStartTime: + description: >- + [Output Only] The last time the schedule successfully ran. The + timestamp is an RFC3339 string. + type: string + ResourcePolicyAggregatedList: + id: ResourcePolicyAggregatedList + description: Contains a list of resourcePolicies. + type: object + properties: + kind: + description: Type of resource. + default: compute#resourcePolicyAggregatedList + type: string + id: + description: >- + [Output Only] Unique identifier for the resource; defined by the + server. + type: string + items: + description: A list of ResourcePolicy resources. + type: object + additionalProperties: + description: Name of the scope containing this set of resourcePolicies. + $ref: '#/components/schemas/ResourcePoliciesScopedList' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -48672,6 +48977,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -48715,6 +49023,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -48737,6 +49046,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -48776,257 +49086,23 @@ components: etag: type: string unreachables: - description: >- - [Output Only] Unreachable resources. end_interface: - MixerListResponseWithEtagBuilder + description: '[Output Only] Unreachable resources.' type: array items: type: string - StoragePool: - id: StoragePool - description: Represents a zonal storage pool resource. + ResourcePoliciesScopedList: + id: ResourcePoliciesScopedList type: object properties: - kind: - description: >- - [Output Only] Type of the resource. Always compute#storagePool for - storage pools. - default: compute#storagePool - type: string - id: - description: >- - [Output Only] The unique identifier for the resource. This - identifier is defined by the server. - type: string - format: uint64 - creationTimestamp: - description: '[Output Only] Creation timestamp in RFC3339 text format.' - 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])?' - annotations: - required: - - compute.storagePools.insert - type: string - description: - description: >- - An optional description of this resource. Provide this property when - you create the resource. - type: string - poolProvisionedCapacityGb: - description: >- - Size, in GiB, of the storage pool. For more information about the - size limits, see - https://cloud.google.com/compute/docs/disks/storage-pools. - annotations: - required: - - compute.storagePools.insert - type: string - format: int64 - poolProvisionedIops: - description: >- - Provisioned IOPS of the storage pool. Only relevant if the storage - pool type is hyperdisk-balanced. - type: string - format: int64 - poolProvisionedThroughput: - description: >- - Provisioned throughput of the storage pool. Only relevant if the - storage pool type is hyperdisk-balanced or hyperdisk-throughput. - type: string - format: int64 - zone: - description: >- - [Output Only] URL of the zone where the storage pool 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 - state: - description: >- - [Output Only] The status of storage pool creation. - CREATING: - Storage pool is provisioning. storagePool. - FAILED: Storage pool - creation failed. - READY: Storage pool is ready for use. - DELETING: - Storage pool is deleting. - type: string - enumDescriptions: - - StoragePool is provisioning - - StoragePool is deleting. - - StoragePool creation failed. - - StoragePool is ready for use. - enum: - - CREATING - - DELETING - - FAILED - - READY - selfLink: - description: '[Output Only] Server-defined fully-qualified URL for this resource.' - type: string - selfLinkWithId: - description: '[Output Only] Server-defined URL for this resource''s resource id.' - type: string - labels: + resourcePolicies: + description: A list of resourcePolicies contained in this scope. + type: array + items: + $ref: '#/components/schemas/ResourcePolicy' + warning: description: >- - Labels to apply to this storage pool. These can be later modified by - the setLabels method. - type: object - additionalProperties: - type: string - labelFingerprint: - description: >- - A fingerprint for the labels being applied to this storage pool, - 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 storage pool. - type: string - format: byte - resourceStatus: - description: '[Output Only] Status information for the storage pool resource.' - $ref: '#/components/schemas/StoragePoolResourceStatus' - storagePoolType: - description: Type of the storage pool. - type: string - status: - description: '[Output Only] Status information for the storage pool resource.' - $ref: '#/components/schemas/StoragePoolResourceStatus' - capacityProvisioningType: - description: Provisioning type of the byte capacity of the pool. - type: string - enumDescriptions: - - Advanced provisioning "thinly" allocates the related resource. - - >- - Standard provisioning allocates the related resource for the pool - disks' exclusive use. - - '' - enum: - - ADVANCED - - STANDARD - - UNSPECIFIED - performanceProvisioningType: - description: >- - Provisioning type of the performance-related parameters of the pool, - such as throughput and IOPS. - type: string - enumDescriptions: - - Advanced provisioning "thinly" allocates the related resource. - - >- - Standard provisioning allocates the related resource for the pool - disks' exclusive use. - - '' - enum: - - ADVANCED - - STANDARD - - UNSPECIFIED - StoragePoolResourceStatus: - id: StoragePoolResourceStatus - description: '[Output Only] Contains output only fields.' - type: object - properties: - lastResizeTimestamp: - description: >- - [Output Only] Timestamp of the last successful resize in RFC3339 - text format. - type: string - diskCount: - description: '[Output Only] Number of disks used.' - type: string - format: int64 - poolUsedCapacityBytes: - description: >- - [Output Only] Space used by data stored in disks within the storage - pool (in bytes). This will reflect the total number of bytes written - to the disks in the pool, in contrast to the capacity of those - disks. - type: string - format: int64 - poolUserWrittenBytes: - description: >- - [Output Only] Amount of data written into the pool, before it is - compacted. - type: string - format: int64 - totalProvisionedDiskCapacityGb: - description: >- - [Output Only] Sum of all the capacity provisioned in disks in this - storage pool. A disk's provisioned capacity is the same as its total - capacity. - type: string - format: int64 - maxTotalProvisionedDiskCapacityGb: - description: '[Output Only] Maximum allowed aggregate disk size in gigabytes.' - type: string - format: int64 - poolUsedIops: - description: >- - [Output Only] Sum of all the disks' provisioned IOPS, minus some - amount that is allowed per disk that is not counted towards pool's - IOPS capacity. For more information, see - https://cloud.google.com/compute/docs/disks/storage-pools. - type: string - format: int64 - totalProvisionedDiskIops: - description: '[Output Only] Sum of all the disks'' provisioned IOPS.' - type: string - format: int64 - poolUsedThroughput: - description: '[Output Only] Sum of all the disks'' provisioned throughput in MB/s.' - type: string - format: int64 - totalProvisionedDiskThroughput: - description: >- - [Output Only] Sum of all the disks' provisioned throughput in MB/s, - minus some amount that is allowed per disk that is not counted - towards pool's throughput capacity. - type: string - format: int64 - StoragePoolAggregatedList: - id: StoragePoolAggregatedList - type: object - properties: - kind: - description: >- - [Output Only] Type of resource. Always - compute#storagePoolAggregatedList for aggregated lists of storage - pools. - default: compute#storagePoolAggregatedList - type: string - id: - description: >- - [Output Only] Unique identifier for the resource; defined by the - server. - type: string - items: - description: A list of StoragePoolsScopedList resources. - type: object - additionalProperties: - description: >- - [Output Only] Name of the scope containing this set of storage - pool. - $ref: '#/components/schemas/StoragePoolsScopedList' - nextPageToken: - description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. - type: string - selfLink: - description: '[Output Only] Server-defined URL for this resource.' - type: string - warning: - description: '[Output Only] Informational warning message.' + Informational warning which replaces the list of resourcePolicies + when the list is empty. type: object properties: code: @@ -49090,188 +49166,8 @@ components: Success is reported, but some results may be missing due to errors - >- - The user attempted to use a resource that requires a TOS they - have not accepted. - - Warning that a resource is in use. - - >- - One or more of the resources set to auto-delete could not be - deleted because they were in use. - - When a resource schema validation is ignored. - - >- - Instance template used in instance group manager is valid as - such, but its application does not make a lot of sense, - because it allows only single instance in instance group. - - When undeclared properties in the schema are present - - A given scope cannot be reached. - enumDeprecated: - - false - - false - - false - - false - - false - - false - - true - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - enum: - - CLEANUP_FAILED - - DEPRECATED_RESOURCE_USED - - DEPRECATED_TYPE_USED - - DISK_SIZE_LARGER_THAN_IMAGE_SIZE - - EXPERIMENTAL_TYPE_USED - - EXTERNAL_API_WARNING - - FIELD_VALUE_OVERRIDEN - - INJECTED_KERNELS_DEPRECATED - - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB - - LARGE_DEPLOYMENT_WARNING - - LIST_OVERHEAD_QUOTA_EXCEED - - MISSING_TYPE_DEPENDENCY - - NEXT_HOP_ADDRESS_NOT_ASSIGNED - - NEXT_HOP_CANNOT_IP_FORWARD - - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE - - NEXT_HOP_INSTANCE_NOT_FOUND - - NEXT_HOP_INSTANCE_NOT_ON_NETWORK - - NEXT_HOP_NOT_RUNNING - - NOT_CRITICAL_ERROR - - NO_RESULTS_ON_PAGE - - PARTIAL_SUCCESS - - REQUIRED_TOS_AGREEMENT - - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - - RESOURCE_NOT_DELETED - - SCHEMA_VALIDATION_IGNORED - - SINGLE_INSTANCE_PROPERTY_TEMPLATE - - UNDECLARED_PROPERTIES - - UNREACHABLE - message: - description: '[Output Only] A human-readable description of the warning code.' - type: string - data: - description: >- - [Output Only] Metadata about this warning in key: value format. - For example: "data": [ { "key": "scope", "value": - "zones/us-east1-d" } - type: array - items: - type: object - properties: - key: - description: >- - [Output Only] A key that provides more detail on the - warning being returned. For example, for warnings where - there are no results in a list request for a particular - zone, this key might be scope and the key value might be - the zone name. Other examples might be a key indicating a - deprecated resource and a suggested replacement, or a - warning about invalid network settings (for example, if an - instance attempts to perform IP forwarding but is not - enabled for IP forwarding). - type: string - value: - description: >- - [Output Only] A warning data value corresponding to the - key. - type: string - etag: - type: string - unreachables: - description: '[Output Only] Unreachable resources.' - type: array - items: - type: string - StoragePoolsScopedList: - id: StoragePoolsScopedList - type: object - properties: - storagePools: - description: '[Output Only] A list of storage pool contained in this scope.' - type: array - items: - $ref: '#/components/schemas/StoragePool' - warning: - description: >- - [Output Only] Informational warning which replaces the list of - storage pool when the list is empty. - type: object - properties: - code: - description: >- - [Output Only] A warning code, if applicable. For example, - Compute Engine returns NO_RESULTS_ON_PAGE if there are no - results in the response. - type: string - enumDescriptions: - - >- - Warning about failed cleanup of transient changes made by a - failed operation. - - A link to a deprecated resource was created. - - >- - When deploying and at least one of the resources has a type - marked as deprecated - - The user created a boot disk that is larger than image size. - - >- - When deploying and at least one of the resources has a type - marked as experimental - - Warning that is present in an external api call - - >- - Warning that value of a field has been overridden. Deprecated - unused field. - - >- - The operation involved use of an injected kernel, which is - deprecated. - - >- - A WEIGHTED_MAGLEV backend service is associated with a health - check that is not of type HTTP/HTTPS/HTTP2. - - >- - When deploying a deployment with a exceedingly large number of - resources - - >- - Resource can't be retrieved due to list overhead quota exceed - which captures the amount of resources filtered out by - user-defined list filter. - - A resource depends on a missing type - - >- - The route's nextHopIp address is not assigned to an instance - on the network. - - The route's next hop instance cannot ip forward. - - >- - The route's nextHopInstance URL refers to an instance that - does not have an ipv6 interface on the same network as the - route. - - >- - The route's nextHopInstance URL refers to an instance that - does not exist. - - >- - The route's nextHopInstance URL refers to an instance that is - not on the same network as the route. - - >- - The route's next hop instance does not have a status of - RUNNING. - - >- - Error which is not critical. We decided to continue the - process despite the mentioned error. - - No results are present on a particular list page. - - >- - Success is reported, but some results may be missing due to - errors + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -49315,6 +49211,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -49337,6 +49234,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -49373,15 +49271,14 @@ components: [Output Only] A warning data value corresponding to the key. type: string - StoragePoolListDisks: - id: StoragePoolListDisks + RouteList: + id: RouteList + description: Contains a list of Route resources. type: object properties: kind: - description: >- - [Output Only] Type of resource. Always compute#storagePoolListDisks - for lists of disks in a storagePool. - default: compute#storagePoolListDisks + description: Type of resource. + default: compute#routeList type: string id: description: >- @@ -49389,10 +49286,10 @@ components: server. type: string items: - description: A list of StoragePoolDisk resources. + description: A list of Route resources. type: array items: - $ref: '#/components/schemas/StoragePoolDisk' + $ref: '#/components/schemas/Route' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -49468,6 +49365,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -49511,6 +49411,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -49533,6 +49434,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -49569,289 +49471,451 @@ components: [Output Only] A warning data value corresponding to the key. type: string - etag: - type: string - unreachables: - description: >- - [Output Only] Unreachable resources. end_interface: - MixerListResponseWithEtagBuilder - type: array - items: - type: string - StoragePoolDisk: - id: StoragePoolDisk + Route: + id: 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. type: object properties: - disk: - description: '[Output Only] The URL of the disk.' - type: string - name: - description: '[Output Only] The name of the disk.' - type: string - status: - description: '[Output Only] The disk status.' - type: string - enumDescriptions: - - Disk is provisioning - - Disk is deleting. - - Disk creation failed. - - Disk is ready for use. - - Source data is being copied into the disk. - - >- - Disk is currently unavailable and cannot be accessed, attached or - detached. - enum: - - CREATING - - DELETING - - FAILED - - READY - - RESTORING - - UNAVAILABLE - type: - description: '[Output Only] The disk type.' + kind: + description: >- + [Output Only] Type of this resource. Always compute#routes for Route + resources. + default: compute#route type: string - sizeGb: - description: '[Output Only] The disk size, in GB.' + id: + description: >- + [Output Only] The unique identifier for the resource. This + identifier is defined by the server. type: string - format: int64 - provisionedIops: - description: '[Output Only] The number of IOPS provisioned for the disk.' + format: uint64 + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' type: string - format: int64 - provisionedThroughput: - description: '[Output Only] The throughput provisioned for the disk.' + 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])?' + annotations: + required: + - compute.routes.insert type: string - format: int64 - usedBytes: - description: '[Output Only] Amount of disk space used.' + description: + description: >- + An optional description of this resource. Provide this field when + you create the resource. type: string - format: int64 - creationTimestamp: - description: '[Output Only] Creation timestamp in RFC3339 text format.' + network: + description: Fully-qualified URL of the network that this route applies to. + annotations: + required: + - compute.routes.insert type: string - attachedInstances: - description: '[Output Only] Instances this disk is attached to.' + tags: + description: A list of instance tags to which this route applies. type: array items: type: string - resourcePolicies: + destRange: description: >- - [Output Only] Resource policies applied to disk for automatic - snapshot creations. - type: array - items: - type: string - SubnetworkList: - id: SubnetworkList - description: Contains a list of Subnetwork resources. - type: object - properties: - kind: + The destination range of outgoing packets that this route applies + to. Both IPv4 and IPv6 are supported. Must specify an IPv4 range + (e.g. 192.0.2.0/24) or an IPv6 range in RFC 4291 format (e.g. + 2001:db8::/32). IPv6 range will be displayed using RFC 5952 + compressed format. + annotations: + required: + - compute.routes.insert + type: string + priority: description: >- - [Output Only] Type of resource. Always compute#subnetworkList for - lists of subnetworks. - default: compute#subnetworkList + 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. + annotations: + required: + - compute.routes.insert + type: integer + format: uint32 + 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 - id: + nextHopIp: description: >- - [Output Only] Unique identifier for the resource; defined by the - server. + The network IP address of an instance that should handle matching + packets. Both IPv6 address and IPv4 addresses are supported. Must + specify an IPv4 address in dot-decimal notation (e.g. 192.0.2.99) or + an IPv6 address in RFC 4291 format (e.g. 2001:db8::2d9:51:0:0 or + 2001:db8:0:0:2d9:51:0:0). IPv6 addresses will be displayed using RFC + 5952 compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be + an IPv4-mapped IPv6 address. type: string - items: - description: A list of Subnetwork resources. - type: array - items: - $ref: '#/components/schemas/Subnetwork' - nextPageToken: + nextHopNetwork: + description: The URL of the local network if it should handle matching packets. + type: string + nextHopGateway: description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. + 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 - selfLink: - description: '[Output Only] Server-defined URL for this resource.' + nextHopPeering: + description: >- + [Output Only] The network peering name that should handle matching + packets, which should conform to RFC1035. type: string - warning: - description: '[Output Only] Informational warning message.' - type: object - properties: - code: - description: >- - [Output Only] A warning code, if applicable. For example, - Compute Engine returns NO_RESULTS_ON_PAGE if there are no - results in the response. - type: string - enumDescriptions: - - >- - Warning about failed cleanup of transient changes made by a - failed operation. - - A link to a deprecated resource was created. - - >- - When deploying and at least one of the resources has a type - marked as deprecated - - The user created a boot disk that is larger than image size. - - >- - When deploying and at least one of the resources has a type - marked as experimental - - Warning that is present in an external api call - - >- - Warning that value of a field has been overridden. Deprecated - unused field. - - >- - The operation involved use of an injected kernel, which is - deprecated. - - >- - A WEIGHTED_MAGLEV backend service is associated with a health - check that is not of type HTTP/HTTPS/HTTP2. - - >- - When deploying a deployment with a exceedingly large number of - resources - - >- - Resource can't be retrieved due to list overhead quota exceed - which captures the amount of resources filtered out by - user-defined list filter. - - A resource depends on a missing type - - >- - The route's nextHopIp address is not assigned to an instance - on the network. - - The route's next hop instance cannot ip forward. - - >- - The route's nextHopInstance URL refers to an instance that - does not have an ipv6 interface on the same network as the - route. - - >- - The route's nextHopInstance URL refers to an instance that - does not exist. - - >- - The route's nextHopInstance URL refers to an instance that is - not on the same network as the route. - - >- - The route's next hop instance does not have a status of - RUNNING. - - >- - Error which is not critical. We decided to continue the - process despite the mentioned error. - - No results are present on a particular list page. - - >- - Success is reported, but some results may be missing due to - errors - - >- - The user attempted to use a resource that requires a TOS they - have not accepted. - - Warning that a resource is in use. - - >- - One or more of the resources set to auto-delete could not be - deleted because they were in use. - - When a resource schema validation is ignored. - - >- - Instance template used in instance group manager is valid as - such, but its application does not make a lot of sense, - because it allows only single instance in instance group. - - When undeclared properties in the schema are present - - A given scope cannot be reached. - enumDeprecated: - - false - - false - - false - - false - - false - - false - - true - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - enum: - - CLEANUP_FAILED - - DEPRECATED_RESOURCE_USED - - DEPRECATED_TYPE_USED - - DISK_SIZE_LARGER_THAN_IMAGE_SIZE - - EXPERIMENTAL_TYPE_USED - - EXTERNAL_API_WARNING - - FIELD_VALUE_OVERRIDEN - - INJECTED_KERNELS_DEPRECATED - - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB - - LARGE_DEPLOYMENT_WARNING - - LIST_OVERHEAD_QUOTA_EXCEED - - MISSING_TYPE_DEPENDENCY - - NEXT_HOP_ADDRESS_NOT_ASSIGNED - - NEXT_HOP_CANNOT_IP_FORWARD - - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE - - NEXT_HOP_INSTANCE_NOT_FOUND - - NEXT_HOP_INSTANCE_NOT_ON_NETWORK - - NEXT_HOP_NOT_RUNNING - - NOT_CRITICAL_ERROR - - NO_RESULTS_ON_PAGE - - PARTIAL_SUCCESS - - REQUIRED_TOS_AGREEMENT - - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - - RESOURCE_NOT_DELETED - - SCHEMA_VALIDATION_IGNORED - - SINGLE_INSTANCE_PROPERTY_TEMPLATE - - UNDECLARED_PROPERTIES - - UNREACHABLE - message: - description: '[Output Only] A human-readable description of the warning code.' - type: string - data: - description: >- - [Output Only] Metadata about this warning in key: value format. - For example: "data": [ { "key": "scope", "value": - "zones/us-east1-d" } - type: array - items: - type: object - properties: - key: - description: >- - [Output Only] A key that provides more detail on the - warning being returned. For example, for warnings where - there are no results in a list request for a particular - zone, this key might be scope and the key value might be - the zone name. Other examples might be a key indicating a - deprecated resource and a suggested replacement, or a - warning about invalid network settings (for example, if an - instance attempts to perform IP forwarding but is not - enabled for IP forwarding). - type: string - value: - description: >- - [Output Only] A warning data value corresponding to the - key. - type: string - Subnetwork: - id: Subnetwork + 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: - + https://www.googleapis.com/compute/v1/projects/project/regions/region + /forwardingRules/forwardingRule - + regions/region/forwardingRules/forwardingRule If an IP address is + provided, must specify an IPv4 address in dot-decimal notation or an + IPv6 address in RFC 4291 format. For example, the following are all + valid IP addresses: - 10.128.0.56 - 2001:db8::2d9:51:0:0 - + 2001:db8:0:0:2d9:51:0:0 IPv6 addresses will be displayed using RFC + 5952 compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be + an IPv4-mapped IPv6 address. + type: string + warnings: + description: >- + [Output Only] If potential misconfigurations are detected for this + route, this field will be populated with warning messages. + type: array + items: + type: object + properties: + code: + description: >- + [Output Only] A warning code, if applicable. For example, + Compute Engine returns NO_RESULTS_ON_PAGE if there are no + results in the response. + type: string + enumDescriptions: + - >- + Warning about failed cleanup of transient changes made by a + failed operation. + - A link to a deprecated resource was created. + - >- + When deploying and at least one of the resources has a type + marked as deprecated + - The user created a boot disk that is larger than image size. + - >- + When deploying and at least one of the resources has a type + marked as experimental + - Warning that is present in an external api call + - >- + Warning that value of a field has been overridden. + Deprecated unused field. + - >- + The operation involved use of an injected kernel, which is + deprecated. + - >- + A WEIGHTED_MAGLEV backend service is associated with a + health check that is not of type HTTP/HTTPS/HTTP2. + - >- + When deploying a deployment with a exceedingly large number + of resources + - >- + Resource can't be retrieved due to list overhead quota + exceed which captures the amount of resources filtered out + by user-defined list filter. + - A resource depends on a missing type + - >- + The route's nextHopIp address is not assigned to an instance + on the network. + - The route's next hop instance cannot ip forward. + - >- + The route's nextHopInstance URL refers to an instance that + does not have an ipv6 interface on the same network as the + route. + - >- + The route's nextHopInstance URL refers to an instance that + does not exist. + - >- + The route's nextHopInstance URL refers to an instance that + is not on the same network as the route. + - >- + The route's next hop instance does not have a status of + RUNNING. + - >- + Error which is not critical. We decided to continue the + process despite the mentioned error. + - No results are present on a particular list page. + - >- + Success is reported, but some results may be missing due to + errors + - >- + Quota information is not available to client requests (e.g: + regions.list). + - >- + The user attempted to use a resource that requires a TOS + they have not accepted. + - Warning that a resource is in use. + - >- + One or more of the resources set to auto-delete could not be + deleted because they were in use. + - When a resource schema validation is ignored. + - >- + Instance template used in instance group manager is valid as + such, but its application does not make a lot of sense, + because it allows only single instance in instance group. + - When undeclared properties in the schema are present + - A given scope cannot be reached. + enumDeprecated: + - false + - false + - false + - false + - false + - false + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + enum: + - CLEANUP_FAILED + - DEPRECATED_RESOURCE_USED + - DEPRECATED_TYPE_USED + - DISK_SIZE_LARGER_THAN_IMAGE_SIZE + - EXPERIMENTAL_TYPE_USED + - EXTERNAL_API_WARNING + - FIELD_VALUE_OVERRIDEN + - INJECTED_KERNELS_DEPRECATED + - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB + - LARGE_DEPLOYMENT_WARNING + - LIST_OVERHEAD_QUOTA_EXCEED + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE + - NEXT_HOP_INSTANCE_NOT_FOUND + - NEXT_HOP_INSTANCE_NOT_ON_NETWORK + - NEXT_HOP_NOT_RUNNING + - NOT_CRITICAL_ERROR + - NO_RESULTS_ON_PAGE + - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE + - REQUIRED_TOS_AGREEMENT + - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING + - RESOURCE_NOT_DELETED + - SCHEMA_VALIDATION_IGNORED + - SINGLE_INSTANCE_PROPERTY_TEMPLATE + - UNDECLARED_PROPERTIES + - UNREACHABLE + message: + description: >- + [Output Only] A human-readable description of the warning + code. + type: string + data: + description: >- + [Output Only] Metadata about this warning in key: value + format. For example: "data": [ { "key": "scope", "value": + "zones/us-east1-d" } + type: array + items: + type: object + properties: + key: + description: >- + [Output Only] A key that provides more detail on the + warning being returned. For example, for warnings where + there are no results in a list request for a particular + zone, this key might be scope and the key value might be + the zone name. Other examples might be a key indicating + a deprecated resource and a suggested replacement, or a + warning about invalid network settings (for example, if + an instance attempts to perform IP forwarding but is not + enabled for IP forwarding). + type: string + value: + description: >- + [Output Only] A warning data value corresponding to the + key. + type: string + nextHopVpnTunnel: + description: The URL to a VpnTunnel that should handle matching packets. + type: string + nextHopHub: + description: >- + [Output Only] The full resource name of the Network Connectivity + Center hub that will handle matching packets. + type: string + selfLink: + description: '[Output Only] Server-defined fully-qualified URL for this resource.' + type: string + 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 + type: string + enumDescriptions: + - '' + - '' + - '' + - '' + enum: + - BGP + - STATIC + - SUBNET + - TRANSIT + asPaths: + description: '[Output Only] AS path.' + type: array + items: + $ref: '#/components/schemas/RouteAsPath' + routeStatus: + description: '[Output only] The status of the route.' + type: string + enumDescriptions: + - This route is processed and active. + - >- + The route is dropped due to the VPC exceeding the dynamic route + limit. For dynamic route limit, please refer to the Learned route + example + - >- + This route is processed but inactive due to failure from the + backend. The backend may have rejected the route + - >- + This route is being processed internally. The status will change + once processed. + enum: + - ACTIVE + - DROPPED + - INACTIVE + - PENDING + nextHopOrigin: + description: >- + [Output Only] Indicates the origin of the route. Can be IGP + (Interior Gateway Protocol), EGP (Exterior Gateway Protocol), or + INCOMPLETE. + type: string + enumDescriptions: + - '' + - '' + - '' + enum: + - EGP + - IGP + - INCOMPLETE + nextHopMed: + description: >- + [Output Only] Multi-Exit Discriminator, a BGP route metric that + indicates the desirability of a particular route in a network. + type: integer + format: uint32 + nextHopInterRegionCost: + description: >- + [Output only] Internal fixed region-to-region cost that Google Cloud + calculates based on factors such as network performance, distance, + and available bandwidth between regions. + type: integer + format: uint32 + params: + description: >- + Input only. [Input Only] Additional params passed with the request, + but not persisted as part of resource payload. + $ref: '#/components/schemas/RouteParams' + RouteAsPath: + id: RouteAsPath + type: object + properties: + 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 + type: string + enumDescriptions: + - '' + - '' + - '' + - '' + enum: + - AS_CONFED_SEQUENCE + - AS_CONFED_SET + - AS_SEQUENCE + - AS_SET + asLists: + description: '[Output Only] The AS numbers of the AS Path.' + type: array + items: + type: integer + format: uint32 + RouteParams: + id: RouteParams + description: Additional route parameters. + type: object + properties: + resourceManagerTags: + description: >- + Tag keys/values directly bound to this resource. Tag keys and values + have the same definition as resource manager tags. The field is + allowed for INSERT only. The keys/values to set on the resource + should be specified in either ID { : } or Namespaced format { : }. + For example the following are valid inputs: * {"tagKeys/333" : + "tagValues/444", "tagKeys/123" : "tagValues/456"} * + {"123/environment" : "production", "345/abc" : "xyz"} Note: * + Invalid combinations of ID & namespaced format is not supported. For + instance: {"123/environment" : "tagValues/444"} is invalid. + type: object + additionalProperties: + type: string + Router: + id: Router 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. + Represents a Cloud Router resource. For more information about Cloud + Router, read the Cloud Router overview. type: object properties: kind: - description: >- - [Output Only] Type of the resource. Always compute#subnetwork for - Subnetwork resources. - default: compute#subnetwork + description: '[Output Only] Type of resource. Always compute#router for routers.' + default: compute#router type: string id: description: >- @@ -49864,335 +49928,924 @@ components: type: string 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 + 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])?' + annotations: + required: + - compute.routers.insert 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 - 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. + you create the resource. type: string - ipCidrRange: + region: 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. + [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 - reservedInternalRange: - description: The URL of the reserved internal range. + network: + description: URI of the network to which this router belongs. + annotations: + required: + - compute.routers.insert + - compute.routers.update type: string - gatewayAddress: + interfaces: description: >- - [Output Only] The gateway address for default routes to reach - destination addresses outside this subnetwork. - type: string - region: + Router interfaces. To create a BGP peer that uses a router + interface, the interface must have one of the following fields + specified: - linkedVpnTunnel - linkedInterconnectAttachment - + subnetwork You can create a router interface without any of these + fields specified. However, you cannot create a BGP peer that uses + that interface. + type: array + items: + $ref: '#/components/schemas/RouterInterface' + bgpPeers: description: >- - URL of the region where the Subnetwork resides. This field can be - set only at resource creation time. - type: string + 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. + type: array + items: + $ref: '#/components/schemas/RouterBgpPeer' + bgp: + description: BGP information specific to this router. + $ref: '#/components/schemas/RouterBgp' selfLink: description: '[Output Only] Server-defined URL for the resource.' type: string - privateIpGoogleAccess: + nats: + description: A list of NAT services created in this router. + type: array + items: + $ref: '#/components/schemas/RouterNat' + encryptedInterconnectRouter: 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. + Indicates if a router is dedicated for use with encrypted VLAN + attachments (interconnectAttachments). type: boolean - 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. + md5AuthenticationKeys: + description: Keys used for MD5 authentication. type: array items: - $ref: '#/components/schemas/SubnetworkSecondaryRange' - fingerprint: + $ref: '#/components/schemas/RouterMd5AuthenticationKey' + RouterInterface: + id: RouterInterface + type: object + properties: + name: 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. + 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])?' + annotations: + required: + - compute.routers.insert type: string - format: byte - 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 determined by the org policy, if there is no - org policy specified, then it will default to disabled. This field - isn't supported if the subnet purpose field is set to - REGIONAL_MANAGED_PROXY. - type: boolean - privateIpv6GoogleAccess: + linkedVpnTunnel: description: >- - This field is for internal use. This field can be both set at - resource creation time and updated using patch. - type: string - enumDescriptions: - - Disable private IPv6 access to/from Google services. - - Bidirectional private IPv6 access to/from Google services. - - >- - Outbound private IPv6 access from VMs in this subnet to Google - services. - enum: - - DISABLE_GOOGLE_ACCESS - - ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE - - ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE - ipv6CidrRange: - description: '[Output Only] This field is for internal use.' + 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 subnetwork. type: string - externalIpv6Prefix: - description: The external IPv6 address range that is owned by this subnetwork. + 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 + subnetwork. type: string - internalIpv6Prefix: - description: The internal IPv6 address range that is owned by this subnetwork. + ipRange: + description: >- + IP address and range of the interface. - For Internet Protocol + version 4 (IPv4), 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 IP address, as it + represents the IP address of the interface. - For Internet Protocol + version 6 (IPv6), the value must be a unique local address (ULA) + range from fdff:1::/64 with a mask length of 126 or less. This value + should be a CIDR-formatted string, for example, fdff:1::1/112. + Within the router's VPC, this IPv6 prefix will be reserved + exclusively for this connection and cannot be used for any other + purpose. type: string - purpose: + managementType: description: >- - The purpose of the resource. This field can be either PRIVATE, - GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, - PRIVATE_SERVICE_CONNECT, or PRIVATE is the default purpose for - user-created subnets or subnets that are automatically created in - auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY - or REGIONAL_MANAGED_PROXY are user-created subnetworks that are - reserved for Envoy-based load balancers. A subnet with purpose set - to PRIVATE_SERVICE_CONNECT is used to publish services using Private - Service Connect. If unspecified, the subnet purpose defaults to - PRIVATE. The enableFlowLogs field isn't supported if the subnet - purpose field is set to GLOBAL_MANAGED_PROXY or - REGIONAL_MANAGED_PROXY. + [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. type: string enumDescriptions: - - Subnet reserved for Global Envoy-based Load Balancing. - >- - Subnet reserved for Internal HTTP(S) Load Balancing. This is a - legacy purpose, please use REGIONAL_MANAGED_PROXY instead. - - Regular user created or automatically created subnet. - - Subnetwork used as source range for Private NAT Gateways. - - Regular user created or automatically created subnet. + The interface is automatically created for PARTNER type + InterconnectAttachment, Google will automatically + create/update/delete this interface when the PARTNER + InterconnectAttachment is created/provisioned/deleted. This type + of interface cannot be manually managed by user. - >- - Subnetworks created for Private Service Connect in the producer - network. - - Subnetwork used for Regional Envoy-based Load Balancing. + Default value, the interface is manually created and managed by + user. enum: - - GLOBAL_MANAGED_PROXY - - INTERNAL_HTTPS_LOAD_BALANCER - - PRIVATE - - PRIVATE_NAT - - PRIVATE_RFC_1918 - - PRIVATE_SERVICE_CONNECT - - REGIONAL_MANAGED_PROXY - role: + - MANAGED_BY_ATTACHMENT + - MANAGED_BY_USER + privateIpAddress: description: >- - The role of subnetwork. Currently, this field is only used when - purpose is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. - The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is - one that is currently being used for Envoy-based load balancers in a - region. 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. + 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 - enumDescriptions: - - The ACTIVE subnet that is currently used. - - The BACKUP subnet that could be promoted to ACTIVE. - enum: - - ACTIVE - - BACKUP - state: + redundantInterface: 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 + 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 - enumDescriptions: - - Subnetwork is being drained. - - Subnetwork is ready for use. - enum: - - DRAINING - - READY - logConfig: - description: >- - This field denotes the VPC flow logging options for this subnetwork. - If logging is enabled, logs are exported to Cloud Logging. - $ref: '#/components/schemas/SubnetworkLogConfig' - stackType: + subnetwork: description: >- - The stack type for the subnet. If set to IPV4_ONLY, new VMs in the - subnet are assigned IPv4 addresses only. If set to IPV4_IPV6, new - VMs in the subnet can be assigned both IPv4 and IPv6 addresses. If - not specified, IPV4_ONLY is used. This field can be both set at - resource creation time and updated using patch. + 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 - enumDescriptions: - - New VMs in this subnet can have both IPv4 and IPv6 addresses. - - New VMs in this subnet will only be assigned IPv4 addresses. - - New VMs in this subnet will only be assigned IPv6 addresses. - enum: - - IPV4_IPV6 - - IPV4_ONLY - - IPV6_ONLY - 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. + ipVersion: + description: IP version of this interface. type: string enumDescriptions: - - >- - VMs on this subnet will be assigned IPv6 addresses that are - accessible via the Internet, as well as the VPC network. - - >- - VMs on this subnet will be assigned IPv6 addresses that are only - accessible over the VPC network. + - '' + - '' enum: - - EXTERNAL - - INTERNAL - SubnetworkSecondaryRange: - id: SubnetworkSecondaryRange - description: Represents a secondary IP range of a subnetwork. + - IPV4 + - IPV6 + RouterBgpPeer: + id: RouterBgpPeer type: object properties: - rangeName: + name: 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. + 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])?' + annotations: + required: + - compute.routers.insert type: string - 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. + interfaceName: + description: Name of the interface the BGP peer is associated with. type: string - reservedInternalRange: - description: The URL of the reserved internal range. + ipAddress: + description: IP address of the interface inside Google Cloud Platform. type: string - SubnetworkLogConfig: - id: SubnetworkLogConfig - description: The available logging options for this subnetwork. - type: object - properties: - enable: + peerIpAddress: + description: IP address of the BGP interface outside Google Cloud Platform. + type: string + peerAsn: 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 determined by the org policy, if there is no - org policy specified, then it will default to disabled. Flow logging - isn't supported if the subnet purpose field is set to - REGIONAL_MANAGED_PROXY. - type: boolean - aggregationInterval: + Peer BGP Autonomous System Number (ASN). Each BGP interface may use + a different value. + annotations: + required: + - compute.routers.insert + type: integer + format: uint32 + advertisedRoutePriority: 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. + 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. + type: integer + format: uint32 + advertiseMode: + description: User-specified flag to indicate which mode to use for advertisement. type: string enumDescriptions: - '' - '' - - '' - - '' - - '' - - '' enum: - - INTERVAL_10_MIN - - INTERVAL_15_MIN - - INTERVAL_1_MIN - - INTERVAL_30_SEC - - INTERVAL_5_MIN - - INTERVAL_5_SEC - flowSampling: + - CUSTOM + - DEFAULT + advertisedGroups: 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 unless otherwise specified by the org policy, which - means half of all collected logs are reported. - type: number - format: float - metadata: + User-specified list of prefix groups to advertise in custom mode, + which currently supports the following option: - ALL_SUBNETS: + Advertises all of the router's own VPC subnets. This excludes any + routes learned for subnets that use VPC Network Peering. 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. + type: array + items: + type: string + enumDescriptions: + - Advertise all available subnets (including peer VPC subnets). + enum: + - ALL_SUBNETS + advertisedIpRanges: 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. + 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. + type: array + items: + $ref: '#/components/schemas/RouterAdvertisedIpRange' + 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. + type: string + enumDescriptions: + - >- + The BGP peer is automatically created for PARTNER type + InterconnectAttachment; Google will automatically create/delete + this BGP peer when the PARTNER InterconnectAttachment is + created/deleted, and Google will update the ipAddress and + peerIpAddress when the PARTNER InterconnectAttachment is + provisioned. This type of BGP peer cannot be created or deleted, + but can be modified for all fields except for name, ipAddress and + peerIpAddress. + - >- + Default value, the BGP peer is manually created and managed by + user. + enum: + - MANAGED_BY_ATTACHMENT + - MANAGED_BY_USER + 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. type: string enumDescriptions: - - '' - '' - '' enum: - - CUSTOM_METADATA - - EXCLUDE_ALL_METADATA - - INCLUDE_ALL_METADATA - metadataFields: + - 'FALSE' + - 'TRUE' + bfd: + description: BFD configuration for the BGP peering. + $ref: '#/components/schemas/RouterBgpPeerBfd' + routerApplianceInstance: description: >- - Can only be specified if VPC flow logs for this subnetwork is - enabled and "metadata" was set to CUSTOM_METADATA. + 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 + enableIpv6: + description: >- + Enable IPv6 traffic over BGP Peer. It is enabled by default if the + peerIpAddress is version 6. + type: boolean + ipv6NexthopAddress: + description: IPv6 address of the interface inside Google Cloud Platform. + type: string + peerIpv6NexthopAddress: + description: IPv6 address of the BGP interface outside Google Cloud Platform. + type: string + md5AuthenticationKeyName: + description: >- + Present if MD5 authentication is enabled for the peering. Must be + the name of one of the entries in the + Router.md5_authentication_keys. The field must comply with RFC1035. + type: string + customLearnedRoutePriority: + description: >- + The user-defined custom learned route priority for a BGP session. + This value is applied to all custom learned route ranges for the + session. You can choose a value from `0` to `65335`. If you don't + provide a value, Google Cloud assigns a priority of `100` to the + ranges. + type: integer + format: int32 + customLearnedIpRanges: + description: >- + A list of user-defined custom learned route IP address ranges for a + BGP session. type: array items: - type: string - filterExpr: + $ref: '#/components/schemas/RouterBgpPeerCustomLearnedIpRange' + enableIpv4: description: >- - Can only be specified if VPC flow logs for this subnetwork is - enabled. The filter expression is used to define which VPC flow logs - should be exported to Cloud Logging. + Enable IPv4 traffic over BGP Peer. It is enabled by default if the + peerIpAddress is version 4. + type: boolean + ipv4NexthopAddress: + description: IPv4 address of the interface inside Google Cloud Platform. type: string - SubnetworkAggregatedList: - id: SubnetworkAggregatedList + peerIpv4NexthopAddress: + description: IPv4 address of the BGP interface outside Google Cloud Platform. + type: string + exportPolicies: + description: >- + List of export policies applied to this peer, in the order they must + be evaluated. The name must correspond to an existing policy that + has ROUTE_POLICY_TYPE_EXPORT type. + type: array + items: + type: string + importPolicies: + description: >- + List of import policies applied to this peer, in the order they must + be evaluated. The name must correspond to an existing policy that + has ROUTE_POLICY_TYPE_IMPORT type. + type: array + items: + type: string + RouterAdvertisedIpRange: + id: RouterAdvertisedIpRange + description: Description-tagged IP ranges for the router to advertise. type: object properties: - kind: + range: description: >- - [Output Only] Type of resource. Always - compute#subnetworkAggregatedList for aggregated lists of - subnetworks. - default: compute#subnetworkAggregatedList + The IP range to advertise. The value must be a CIDR-formatted + string. type: string - id: - description: >- - [Output Only] Unique identifier for the resource; defined by the - server. + description: + description: User-specified description for the IP range. type: string - items: - description: A list of SubnetworksScopedList resources. - type: object - additionalProperties: - description: Name of the scope containing this set of Subnetworks. - $ref: '#/components/schemas/SubnetworksScopedList' - nextPageToken: + RouterBgpPeerBfd: + id: RouterBgpPeerBfd + type: object + properties: + 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 + DISABLED. + type: string + enumDescriptions: + - '' + - '' + - '' + enum: + - ACTIVE + - DISABLED + - PASSIVE + 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. + type: integer + format: uint32 + 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. + type: integer + format: uint32 + 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. + type: integer + format: uint32 + RouterBgpPeerCustomLearnedIpRange: + id: RouterBgpPeerCustomLearnedIpRange + type: object + properties: + range: + description: >- + The custom learned route IP address range. Must be a valid + CIDR-formatted prefix. If an IP address is provided without a subnet + mask, it is interpreted as, for IPv4, a `/32` singular IP address + range, and, for IPv6, `/128`. + type: string + RouterBgp: + id: RouterBgp + type: object + properties: + 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. + type: integer + format: uint32 + advertiseMode: + description: >- + User-specified flag to indicate which mode to use for advertisement. + The options are DEFAULT or CUSTOM. + type: string + enumDescriptions: + - '' + - '' + enum: + - CUSTOM + - DEFAULT + 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. + type: array + items: + type: string + enumDescriptions: + - Advertise all available subnets (including peer VPC subnets). + enum: + - ALL_SUBNETS + 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. + type: array + items: + $ref: '#/components/schemas/RouterAdvertisedIpRange' + 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. + type: integer + format: uint32 + identifierRange: + description: >- + Explicitly specifies a range of valid BGP Identifiers for this + Router. It is provided as a link-local IPv4 range (from + 169.254.0.0/16), of size at least /30, even if the BGP sessions are + over IPv6. It must not overlap with any IPv4 BGP session ranges. + Other vendors commonly call this "router ID". + type: string + RouterNat: + id: 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. + type: object + properties: + 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 + type: + description: >- + Indicates whether this NAT is used for public or private IP + translation. If unspecified, it defaults to PUBLIC. + type: string + enumDescriptions: + - NAT used for private IP translation. + - NAT used for public IP translation. This is the default. + enum: + - PRIVATE + - PUBLIC + autoNetworkTier: + description: >- + The network tier to use when automatically reserving NAT IP + addresses. Must be one of: PREMIUM, STANDARD. If not specified, then + the current project-level default tier is used. + type: string + enumDescriptions: + - Public internet quality with fixed bandwidth. + - >- + High quality, Google-grade network tier, support for all + networking products. + - >- + Public internet quality, only limited support for other networking + products. + - >- + (Output only) Temporary tier for FIXED_STANDARD when fixed + standard tier is expired or not configured. + enum: + - FIXED_STANDARD + - PREMIUM + - STANDARD + - STANDARD_OVERRIDES_FIXED_STANDARD + endpointTypes: + description: >- + List of NAT-ted endpoint types supported by the Nat Gateway. If the + list is empty, then it will be equivalent to include + ENDPOINT_TYPE_VM + type: array + items: + type: string + enumDescriptions: + - >- + This is used for regional Application Load Balancers (internal + and external) and regional proxy Network Load Balancers + (internal and external) endpoints. + - This is used for Secure Web Gateway endpoints. + - This is the default. + enum: + - ENDPOINT_TYPE_MANAGED_PROXY_LB + - ENDPOINT_TYPE_SWG + - ENDPOINT_TYPE_VM + 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 then there should not + be any other Router.Nat section in any Router for this network in + this region. + type: string + enumDescriptions: + - All the IP ranges in every Subnetwork are allowed to Nat. + - All the primary IP ranges in every Subnetwork are allowed to Nat. + - >- + A list of Subnetworks are allowed to Nat (specified in the field + subnetwork below) + enum: + - ALL_SUBNETWORKS_ALL_IP_RANGES + - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES + - LIST_OF_SUBNETWORKS + 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. + type: array + items: + $ref: '#/components/schemas/RouterNatSubnetworkToNat' + sourceSubnetworkIpRangesToNat64: + description: >- + Specify the Nat option for NAT64, which can take one of the + following values: - ALL_IPV6_SUBNETWORKS: All of the IP ranges in + every Subnetwork are allowed to Nat. - LIST_OF_IPV6_SUBNETWORKS: A + list of Subnetworks are allowed to Nat (specified in the field + nat64_subnetwork below) The default is NAT64_OPTION_UNSPECIFIED. + Note that if this field contains NAT64_ALL_V6_SUBNETWORKS no other + Router.Nat section in this region can also enable NAT64 for any + Subnetworks in this network. Other Router.Nat sections can still be + present to enable NAT44 only. + type: string + enumDescriptions: + - >- + NAT64 is enabled for all the IPv6 subnet ranges. In dual stack + subnets, NAT64 will only be enabled for IPv6-only VMs. + - >- + NAT64 is enabled for a list of IPv6 subnet ranges. In dual stack + subnets, NAT64 will only be enabled for IPv6-only VMs. If this + option is used, the nat64_subnetworks field must be specified. + enum: + - ALL_IPV6_SUBNETWORKS + - LIST_OF_IPV6_SUBNETWORKS + nat64Subnetworks: + description: >- + List of Subnetwork resources whose traffic should be translated by + NAT64 Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is + selected for the SubnetworkIpRangeToNat64Option above. + type: array + items: + $ref: '#/components/schemas/RouterNatSubnetworkToNat64' + 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. + type: array + items: + type: string + 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. + type: array + items: + 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. + type: string + enumDescriptions: + - >- + Nat IPs are allocated by GCP; customers can not specify any Nat + IPs. + - >- + Only use Nat IPs provided by customers. When specified Nat IPs are + not enough then the Nat service fails for new VMs. + enum: + - AUTO_ONLY + - MANUAL_ONLY + 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. + type: integer + format: int32 + maxPortsPerVm: + description: >- + Maximum number of ports allocated to a VM from this NAT config when + Dynamic Port Allocation is enabled. If Dynamic Port Allocation is + not enabled, this field has no effect. If Dynamic Port Allocation is + enabled, and this field is set, it must be set to a power of two + greater than minPortsPerVm, or 64 if minPortsPerVm is not set. If + Dynamic Port Allocation is enabled and this field is not set, a + maximum of 65536 ports will be allocated to a VM from this NAT + config. + type: integer + format: int32 + enableDynamicPortAllocation: + description: >- + Enable Dynamic Port Allocation. If not specified, it is disabled by + default. If set to true, - Dynamic Port Allocation will be enabled + on this NAT config. - enableEndpointIndependentMapping cannot be set + to true. - If minPorts is set, minPortsPerVm must be set to a power + of two greater than or equal to 32. If minPortsPerVm is not set, a + minimum of 32 ports will be allocated to a VM from this NAT config. + type: boolean + udpIdleTimeoutSec: + description: >- + Timeout (in seconds) for UDP connections. Defaults to 30s if not + set. + type: integer + format: int32 + icmpIdleTimeoutSec: + description: >- + Timeout (in seconds) for ICMP connections. Defaults to 30s if not + set. + type: integer + format: int32 + tcpEstablishedIdleTimeoutSec: + description: >- + Timeout (in seconds) for TCP established connections. Defaults to + 1200s if not set. + type: integer + format: int32 + tcpTransitoryIdleTimeoutSec: + description: >- + Timeout (in seconds) for TCP transitory connections. Defaults to 30s + if not set. + type: integer + format: int32 + tcpTimeWaitTimeoutSec: + description: >- + Timeout (in seconds) for TCP connections that are in TIME_WAIT + state. Defaults to 120s if not set. + type: integer + format: int32 + logConfig: + description: Configure logging on this NAT. + $ref: '#/components/schemas/RouterNatLogConfig' + rules: + description: A list of rules associated with this NAT. + type: array + items: + $ref: '#/components/schemas/RouterNatRule' + enableEndpointIndependentMapping: + type: boolean + RouterNatSubnetworkToNat: + id: RouterNatSubnetworkToNat + description: Defines the IP ranges that want to use NAT for a subnetwork. + type: object + properties: + name: + description: URL for the subnetwork resource that will use NAT. + type: string + 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] + type: array + items: + type: string + enumDescriptions: + - The primary and all the secondary ranges are allowed to Nat. + - A list of secondary ranges are allowed to Nat. + - The primary range is allowed to Nat. + enum: + - ALL_IP_RANGES + - LIST_OF_SECONDARY_IP_RANGES + - PRIMARY_IP_RANGE + 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. + type: array + items: + type: string + RouterNatSubnetworkToNat64: + id: RouterNatSubnetworkToNat64 + description: Specifies a subnetwork to enable NAT64. + type: object + properties: + name: + description: URL for the subnetwork resource that will use NAT64. + type: string + RouterNatLogConfig: + id: RouterNatLogConfig + description: Configuration of logging on a NAT. + type: object + 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. + type: string + enumDescriptions: + - Export logs for all (successful and unsuccessful) connections. + - Export logs for connection failures only. + - Export logs for successful connections only. + enum: + - ALL + - ERRORS_ONLY + - TRANSLATIONS_ONLY + RouterNatRule: + id: RouterNatRule + type: object + properties: + 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. + type: integer + format: uint32 + 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 == + '//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1'` + type: string + action: + description: The action to be enforced for traffic that matches this rule. + $ref: '#/components/schemas/RouterNatRuleAction' + RouterNatRuleAction: + id: RouterNatRuleAction + type: object + 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. + type: array + items: + type: string + 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. + type: array + items: + type: string + sourceNatActiveRanges: + description: >- + A list of URLs of the subnetworks used as source ranges for this NAT + Rule. These subnetworks must have purpose set to PRIVATE_NAT. This + field is used for private NAT. + type: array + items: + type: string + sourceNatDrainRanges: + description: >- + A list of URLs of subnetworks representing source ranges to be + drained. This is only supported on patch/update, and these + subnetworks must have previously been used as active ranges in this + NAT Rule. This field is used for private NAT. + type: array + items: + type: string + RouterMd5AuthenticationKey: + id: RouterMd5AuthenticationKey + type: object + properties: + name: + description: >- + Name used to identify the key. Must be unique within a router. Must + be referenced by exactly one bgpPeer. Must comply with RFC1035. + annotations: + required: + - compute.routers.insert + - compute.routers.update + type: string + key: + description: >- + [Input only] Value of the key. For patch and update calls, it can be + skipped to copy the value from the previous configuration. This is + allowed if the key with the same name existed before the operation. + Maximum length is 80 characters. Can only contain printable ASCII + characters. + annotations: + required: + - compute.routers.insert + type: string + RouterList: + id: RouterList + description: Contains a list of Router resources. + type: object + properties: + kind: + description: '[Output Only] Type of resource. Always compute#router for routers.' + default: compute#routerList + type: string + id: + description: >- + [Output Only] Unique identifier for the resource; defined by the + server. + type: string + items: + description: A list of Router resources. + type: array + items: + $ref: '#/components/schemas/Router' + nextPageToken: description: >- [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than @@ -50267,6 +50920,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -50310,6 +50966,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -50332,6 +50989,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -50368,24 +51026,39 @@ components: [Output Only] A warning data value corresponding to the key. type: string - unreachables: - description: '[Output Only] Unreachable resources.' - type: array - items: - type: string - SubnetworksScopedList: - id: SubnetworksScopedList + RouterAggregatedList: + id: RouterAggregatedList + description: Contains a list of routers. type: object properties: - subnetworks: - description: A list of subnetworks contained in this scope. - type: array - items: - $ref: '#/components/schemas/Subnetwork' - warning: + kind: + description: Type of resource. + default: compute#routerAggregatedList + type: string + id: description: >- - An informational warning that appears when the list of addresses is - empty. + [Output Only] Unique identifier for the resource; defined by the + server. + type: string + items: + description: A list of Router resources. + type: object + additionalProperties: + description: Name of the scope containing this set of routers. + $ref: '#/components/schemas/RoutersScopedList' + nextPageToken: + description: >- + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. + type: string + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string + warning: + description: '[Output Only] Informational warning message.' type: object properties: code: @@ -50448,6 +51121,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -50491,6 +51167,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -50513,6 +51190,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -50549,43 +51227,24 @@ components: [Output Only] A warning data value corresponding to the key. type: string - UsableSubnetworksAggregatedList: - id: UsableSubnetworksAggregatedList + unreachables: + description: '[Output Only] Unreachable resources.' + type: array + items: + type: string + RoutersScopedList: + id: RoutersScopedList type: object properties: - kind: - description: >- - [Output Only] Type of resource. Always - compute#usableSubnetworksAggregatedList for aggregated lists of - usable subnetworks. - default: compute#usableSubnetworksAggregatedList - type: string - 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.' + routers: + description: A list of routers contained in this scope. type: array items: - $ref: '#/components/schemas/UsableSubnetwork' - nextPageToken: - description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value 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 + $ref: '#/components/schemas/Router' warning: - description: '[Output Only] Informational warning message.' + description: >- + Informational warning which replaces the list of routers when the + list is empty. type: object properties: code: @@ -50648,6 +51307,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -50691,6 +51353,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -50713,6 +51376,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -50749,452 +51413,570 @@ components: [Output Only] A warning data value corresponding to the key. type: string - UsableSubnetwork: - id: UsableSubnetwork - description: >- - Subnetwork which the current user has compute.subnetworks.use permission - on. + RouterStatusResponse: + id: RouterStatusResponse type: object properties: - subnetwork: - description: Subnetwork URL. + kind: + description: Type of resource. + default: compute#routerStatusResponse type: string + result: + $ref: '#/components/schemas/RouterStatus' + RouterStatus: + id: RouterStatus + type: object + properties: network: - description: Network URL. - type: string - ipCidrRange: - description: The range of internal addresses that are owned by this subnetwork. + description: URI of the network to which this router belongs. type: string - secondaryIpRanges: - description: Secondary IP ranges. + bestRoutes: + description: >- + A list of the best dynamic routes for this Cloud Router's Virtual + Private Cloud (VPC) network in the same region as this Cloud Router. + Lists all of the best routes per prefix that are programmed into + this region's VPC data plane. When global dynamic routing mode is + turned on in the VPC network, this list can include cross-region + dynamic routes from Cloud Routers in other regions. type: array items: - $ref: '#/components/schemas/UsableSubnetworkSecondaryRange' - stackType: + $ref: '#/components/schemas/Route' + bestRoutesForRouter: description: >- - The stack type for the subnet. If set to IPV4_ONLY, new VMs in the - subnet are assigned IPv4 addresses only. If set to IPV4_IPV6, new - VMs in the subnet can be assigned both IPv4 and IPv6 addresses. If - not specified, IPV4_ONLY is used. This field can be both set at - resource creation time and updated using patch. + A list of the best BGP routes learned by this Cloud Router. It is + possible that routes listed might not be programmed into the data + plane, if the Google Cloud control plane finds a more optimal route + for a prefix than a route learned by this Cloud Router. + type: array + items: + $ref: '#/components/schemas/Route' + bgpPeerStatus: + type: array + items: + $ref: '#/components/schemas/RouterStatusBgpPeerStatus' + natStatus: + type: array + items: + $ref: '#/components/schemas/RouterStatusNatStatus' + RouterStatusBgpPeerStatus: + id: RouterStatusBgpPeerStatus + type: object + properties: + name: + description: Name of this BGP peer. Unique within the Routers resource. + type: string + linkedVpnTunnel: + description: URL of the VPN tunnel that this BGP peer controls. + 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 + ipAddress: + description: IP address of the local BGP interface. + type: string + peerIpAddress: + description: IP address of the remote BGP interface. + type: string + ipv6NexthopAddress: + description: IPv6 address of the local BGP interface. + type: string + peerIpv6NexthopAddress: + description: IPv6 address of the remote BGP interface. + type: string + enableIpv6: + description: >- + Enable IPv6 traffic over BGP Peer. It is enabled by default if the + peerIpAddress is version 6. + type: boolean + status: + description: 'Status of the BGP peer: {UP, DOWN}' type: string enumDescriptions: - - New VMs in this subnet can have both IPv4 and IPv6 addresses. - - New VMs in this subnet will only be assigned IPv4 addresses. - - New VMs in this subnet will only be assigned IPv6 addresses. + - '' + - '' + - '' enum: - - IPV4_IPV6 - - IPV4_ONLY - - IPV6_ONLY - ipv6AccessType: + - DOWN + - UNKNOWN + - UP + state: 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. + The state of the BGP session. For a list of possible values for this + field, see BGP session states. + 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 + numLearnedRoutes: + description: Number of routes learned from the remote BGP Peer. + type: integer + format: uint32 + advertisedRoutes: + description: Routes that were advertised to the remote BGP peer + type: array + items: + $ref: '#/components/schemas/Route' + bfdStatus: + $ref: '#/components/schemas/BfdStatus' + md5AuthEnabled: + description: Informs whether MD5 authentication is enabled on this BGP peer. + type: boolean + statusReason: + description: Indicates why particular status was returned. type: string enumDescriptions: - >- - VMs on this subnet will be assigned IPv6 addresses that are - accessible via the Internet, as well as the VPC network. + BGP peer disabled because it requires IPv4 but the underlying + connection is IPv6-only. - >- - VMs on this subnet will be assigned IPv6 addresses that are only - accessible over the VPC network. + BGP peer disabled because it requires IPv6 but the underlying + connection is IPv4-only. + - >- + Indicates internal problems with configuration of MD5 + authentication. This particular reason can only be returned when + md5AuthEnabled is true and status is DOWN. + - '' enum: - - EXTERNAL - - INTERNAL - purpose: + - IPV4_PEER_ON_IPV6_ONLY_CONNECTION + - IPV6_PEER_ON_IPV4_ONLY_CONNECTION + - MD5_AUTH_INTERNAL_PROBLEM + - STATUS_REASON_UNSPECIFIED + ipv4NexthopAddress: + description: IPv4 address of the local BGP interface. + type: string + peerIpv4NexthopAddress: + description: IPv4 address of the remote BGP interface. + type: string + enableIpv4: description: >- - The purpose of the resource. This field can be either PRIVATE, - GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, - PRIVATE_SERVICE_CONNECT, or PRIVATE is the default purpose for - user-created subnets or subnets that are automatically created in - auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY - or REGIONAL_MANAGED_PROXY are user-created subnetworks that are - reserved for Envoy-based load balancers. A subnet with purpose set - to PRIVATE_SERVICE_CONNECT is used to publish services using Private - Service Connect. If unspecified, the subnet purpose defaults to - PRIVATE. The enableFlowLogs field isn't supported if the subnet - purpose field is set to GLOBAL_MANAGED_PROXY or - REGIONAL_MANAGED_PROXY. + Enable IPv4 traffic over BGP Peer. It is enabled by default if the + peerIpAddress is version 4. + type: boolean + BfdStatus: + id: BfdStatus + description: 'Next free: 15' + type: object + properties: + uptimeMs: + description: >- + Session uptime in milliseconds. Value will be 0 if session is not + up. + type: string + format: int64 + localState: + description: >- + The current BFD session state as seen by the transmitting system. + These states are specified in section 4.1 of RFC5880 type: string enumDescriptions: - - Subnet reserved for Global Envoy-based Load Balancing. - - >- - Subnet reserved for Internal HTTP(S) Load Balancing. This is a - legacy purpose, please use REGIONAL_MANAGED_PROXY instead. - - Regular user created or automatically created subnet. - - Subnetwork used as source range for Private NAT Gateways. - - Regular user created or automatically created subnet. - - >- - Subnetworks created for Private Service Connect in the producer - network. - - Subnetwork used for Regional Envoy-based Load Balancing. + - '' + - '' + - '' + - '' + - '' enum: - - GLOBAL_MANAGED_PROXY - - INTERNAL_HTTPS_LOAD_BALANCER - - PRIVATE - - PRIVATE_NAT - - PRIVATE_RFC_1918 - - PRIVATE_SERVICE_CONNECT - - REGIONAL_MANAGED_PROXY - role: + - ADMIN_DOWN + - DOWN + - INIT + - STATE_UNSPECIFIED + - UP + localDiagnostic: description: >- - The role of subnetwork. Currently, this field is only used when - purpose is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. - The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is - one that is currently being used for Envoy-based load balancers in a - region. 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. + 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 type: string enumDescriptions: - - The ACTIVE subnet that is currently used. - - The BACKUP subnet that could be promoted to ACTIVE. + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' enum: - - ACTIVE - - BACKUP - externalIpv6Prefix: + - 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 + controlPacketCounts: + description: Control packet counts for the current BFD session. + $ref: '#/components/schemas/BfdStatusPacketCounts' + txPacket: + description: The most recent Tx control packet for this BFD session. + $ref: '#/components/schemas/BfdPacket' + rxPacket: + description: The most recent Rx control packet for this BFD session. + $ref: '#/components/schemas/BfdPacket' + controlPacketIntervals: + description: Inter-packet time interval statistics for control packets. + type: array + items: + $ref: '#/components/schemas/PacketIntervals' + negotiatedLocalControlTxIntervalMs: + description: Negotiated transmit interval for control packets. + type: integer + format: uint32 + bfdSessionInitializationMode: description: >- - [Output Only] The external IPv6 address range that is assigned to - this subnetwork. + 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. type: string - internalIpv6Prefix: - description: >- - [Output Only] The internal IPv6 address range that is assigned to - this subnetwork. + enumDescriptions: + - '' + - '' + - '' + enum: + - ACTIVE + - DISABLED + - PASSIVE + configUpdateTimestampMicros: + description: Unix timestamp of the most recent config update. type: string - UsableSubnetworkSecondaryRange: - id: UsableSubnetworkSecondaryRange - description: Secondary IP range of a usable subnetwork. + format: int64 + BfdStatusPacketCounts: + id: BfdStatusPacketCounts type: object properties: - rangeName: + numTx: 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 - ipCidrRange: + Number of packets transmitted since the beginning of the current BFD + session. + type: integer + format: uint32 + numRx: description: >- - The range of IP addresses belonging to this subnetwork secondary - range. - type: string - SubnetworksExpandIpCidrRangeRequest: - id: SubnetworksExpandIpCidrRangeRequest - type: object - properties: - ipCidrRange: + Number of packets received since the beginning of the current BFD + session. + type: integer + format: uint32 + numRxSuccessful: 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 - SubnetworksSetPrivateIpGoogleAccessRequest: - id: SubnetworksSetPrivateIpGoogleAccessRequest - type: object - properties: - privateIpGoogleAccess: - type: boolean - TargetGrpcProxyList: - id: TargetGrpcProxyList + Number of packets received that were successfully processed since + the beginning of the current BFD session. + type: integer + format: uint32 + numRxRejected: + description: >- + Number of packets received that were rejected because of errors + since the beginning of the current BFD session. + type: integer + format: uint32 + BfdPacket: + id: BfdPacket type: object properties: - kind: + version: description: >- - [Output Only] Type of the resource. Always compute#targetGrpcProxy - for target grpc proxies. - default: compute#targetGrpcProxyList - type: string - id: + The version number of the BFD protocol, as specified in section 4.1 + of RFC5880. + type: integer + format: uint32 + diagnostic: description: >- - [Output Only] Unique identifier for the resource; defined by the - server. + 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 type: string - items: - description: A list of TargetGrpcProxy resources. - type: array - items: - $ref: '#/components/schemas/TargetGrpcProxy' - nextPageToken: + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + 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 + state: description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. - type: string - selfLink: - description: '[Output Only] Server-defined URL for this resource.' + The current BFD session state as seen by the transmitting system. + These states are specified in section 4.1 of RFC5880 type: string - warning: - description: '[Output Only] Informational warning message.' - type: object - properties: - code: - description: >- - [Output Only] A warning code, if applicable. For example, - Compute Engine returns NO_RESULTS_ON_PAGE if there are no - results in the response. - type: string - enumDescriptions: - - >- - Warning about failed cleanup of transient changes made by a - failed operation. - - A link to a deprecated resource was created. - - >- - When deploying and at least one of the resources has a type - marked as deprecated - - The user created a boot disk that is larger than image size. - - >- - When deploying and at least one of the resources has a type - marked as experimental - - Warning that is present in an external api call - - >- - Warning that value of a field has been overridden. Deprecated - unused field. - - >- - The operation involved use of an injected kernel, which is - deprecated. - - >- - A WEIGHTED_MAGLEV backend service is associated with a health - check that is not of type HTTP/HTTPS/HTTP2. - - >- - When deploying a deployment with a exceedingly large number of - resources - - >- - Resource can't be retrieved due to list overhead quota exceed - which captures the amount of resources filtered out by - user-defined list filter. - - A resource depends on a missing type - - >- - The route's nextHopIp address is not assigned to an instance - on the network. - - The route's next hop instance cannot ip forward. - - >- - The route's nextHopInstance URL refers to an instance that - does not have an ipv6 interface on the same network as the - route. - - >- - The route's nextHopInstance URL refers to an instance that - does not exist. - - >- - The route's nextHopInstance URL refers to an instance that is - not on the same network as the route. - - >- - The route's next hop instance does not have a status of - RUNNING. - - >- - Error which is not critical. We decided to continue the - process despite the mentioned error. - - No results are present on a particular list page. - - >- - Success is reported, but some results may be missing due to - errors - - >- - The user attempted to use a resource that requires a TOS they - have not accepted. - - Warning that a resource is in use. - - >- - One or more of the resources set to auto-delete could not be - deleted because they were in use. - - When a resource schema validation is ignored. - - >- - Instance template used in instance group manager is valid as - such, but its application does not make a lot of sense, - because it allows only single instance in instance group. - - When undeclared properties in the schema are present - - A given scope cannot be reached. - enumDeprecated: - - false - - false - - false - - false - - false - - false - - true - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - enum: - - CLEANUP_FAILED - - DEPRECATED_RESOURCE_USED - - DEPRECATED_TYPE_USED - - DISK_SIZE_LARGER_THAN_IMAGE_SIZE - - EXPERIMENTAL_TYPE_USED - - EXTERNAL_API_WARNING - - FIELD_VALUE_OVERRIDEN - - INJECTED_KERNELS_DEPRECATED - - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB - - LARGE_DEPLOYMENT_WARNING - - LIST_OVERHEAD_QUOTA_EXCEED - - MISSING_TYPE_DEPENDENCY - - NEXT_HOP_ADDRESS_NOT_ASSIGNED - - NEXT_HOP_CANNOT_IP_FORWARD - - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE - - NEXT_HOP_INSTANCE_NOT_FOUND - - NEXT_HOP_INSTANCE_NOT_ON_NETWORK - - NEXT_HOP_NOT_RUNNING - - NOT_CRITICAL_ERROR - - NO_RESULTS_ON_PAGE - - PARTIAL_SUCCESS - - REQUIRED_TOS_AGREEMENT - - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - - RESOURCE_NOT_DELETED - - SCHEMA_VALIDATION_IGNORED - - SINGLE_INSTANCE_PROPERTY_TEMPLATE - - UNDECLARED_PROPERTIES - - UNREACHABLE - message: - description: '[Output Only] A human-readable description of the warning code.' - type: string - data: - description: >- - [Output Only] Metadata about this warning in key: value format. - For example: "data": [ { "key": "scope", "value": - "zones/us-east1-d" } - type: array - items: - type: object - properties: - key: - description: >- - [Output Only] A key that provides more detail on the - warning being returned. For example, for warnings where - there are no results in a list request for a particular - zone, this key might be scope and the key value might be - the zone name. Other examples might be a key indicating a - deprecated resource and a suggested replacement, or a - warning about invalid network settings (for example, if an - instance attempts to perform IP forwarding but is not - enabled for IP forwarding). - type: string - value: - description: >- - [Output Only] A warning data value corresponding to the - key. - type: string - TargetGrpcProxy: - id: 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. - type: object - properties: - kind: + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + enum: + - ADMIN_DOWN + - DOWN + - INIT + - STATE_UNSPECIFIED + - UP + poll: description: >- - [Output Only] Type of the resource. Always compute#targetGrpcProxy - for target grpc proxies. - default: compute#targetGrpcProxy - type: string - id: + The Poll bit of the BFD packet. This is specified in section 4.1 of + RFC5880 + type: boolean + final: description: >- - [Output Only] The unique identifier for the resource type. The - server generates this identifier. + The Final 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 + authenticationPresent: + description: >- + The Authentication Present 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 + multipoint: + description: >- + The multipoint bit of the BFD packet. This is specified in section + 4.1 of RFC5880 + type: boolean + multiplier: + description: >- + The detection time multiplier of the BFD packet. This is specified + in section 4.1 of RFC5880 + type: integer + format: uint32 + length: + description: >- + The length of the BFD Control packet in bytes. This is specified in + section 4.1 of RFC5880 + type: integer + format: uint32 + myDiscriminator: + description: >- + The My Discriminator value in the BFD packet. This is specified in + section 4.1 of RFC5880 + type: integer + format: uint32 + yourDiscriminator: + description: >- + The Your Discriminator value in the BFD packet. This is specified in + section 4.1 of RFC5880 + type: integer + format: uint32 + minTxIntervalMs: + description: >- + The Desired Min TX Interval value in the BFD packet. This is + specified in section 4.1 of RFC5880 + type: integer + format: uint32 + minRxIntervalMs: + description: >- + The Required Min RX Interval value in the BFD packet. This is + specified in section 4.1 of RFC5880 + type: integer + format: uint32 + minEchoRxIntervalMs: + description: >- + The Required Min Echo RX Interval value in the BFD packet. This is + specified in section 4.1 of RFC5880 + type: integer + format: uint32 + PacketIntervals: + id: PacketIntervals + description: 'Next free: 7' + type: object + properties: + type: + description: The type of packets for which inter-packet intervals were computed. type: string - format: uint64 - creationTimestamp: - description: '[Output Only] Creation timestamp in RFC3339 text format.' + enumDescriptions: + - >- + Only applies to Echo packets. This shows the intervals between + sending and receiving the same packet. + - Intervals between received packets. + - Intervals between transmitted packets. + - '' + enum: + - LOOPBACK + - RECEIVE + - TRANSMIT + - TYPE_UNSPECIFIED + duration: + description: From how long ago in the past these intervals were observed. type: string - name: + enumDescriptions: + - '' + - '' + - From BfdSession object creation time. + - '' + enum: + - DURATION_UNSPECIFIED + - HOUR + - MAX + - MINUTE + numIntervals: 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])?' - annotations: - required: - - compute.targetGrpcProxies.insert + Number of inter-packet intervals from which these statistics were + derived. type: string - description: - description: >- - An optional description of this resource. Provide this property when - you create the resource. + format: int64 + minMs: + description: Minimum observed inter-packet interval in milliseconds. type: string - selfLink: - description: '[Output Only] Server-defined URL for the resource.' + format: int64 + maxMs: + description: Maximum observed inter-packet interval in milliseconds. type: string - selfLinkWithId: - description: '[Output Only] Server-defined URL with id for the resource.' + format: int64 + avgMs: + description: Average observed inter-packet interval in milliseconds. 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. + format: int64 + RouterStatusNatStatus: + id: RouterStatusNatStatus + description: Status of a NAT contained in this router. + type: object + properties: + name: + description: Unique name of this NAT. type: string - validateForProxyless: + userAllocatedNatIpResources: + description: A list of fully qualified URLs of reserved IP address resources. + type: array + items: + type: string + drainUserAllocatedNatIps: 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 - fingerprint: + A list of IPs user-allocated for NAT that are in drain mode. + Example: ["1.1.1.1", "179.12.26.133"]. + type: array + items: + type: string + userAllocatedNatIps: 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. - type: string - format: byte - TargetHttpProxyList: - id: TargetHttpProxyList - description: A list of TargetHttpProxy resources. + A list of IPs user-allocated for NAT. They will be raw IP strings + like "179.12.26.133". + type: array + items: + type: string + autoAllocatedNatIps: + description: >- + A list of IPs auto-allocated for NAT. Example: ["1.1.1.1", + "129.2.16.89"] + type: array + items: + type: string + drainAutoAllocatedNatIps: + description: >- + A list of IPs auto-allocated for NAT that are in drain mode. + Example: ["1.1.1.1", "179.12.26.133"]. + type: array + items: + type: string + 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. + type: integer + format: int32 + numVmEndpointsWithNatMappings: + description: Number of VM endpoints (i.e., Nics) that can use NAT. + type: integer + format: int32 + ruleStatus: + description: Status of rules in this NAT. + type: array + items: + $ref: '#/components/schemas/RouterStatusNatStatusNatRuleStatus' + RouterStatusNatStatusNatRuleStatus: + id: RouterStatusNatStatusNatRuleStatus + description: Status of a NAT Rule contained in this NAT. + type: object + properties: + ruleNumber: + description: Rule number of the rule. + type: integer + format: int32 + activeNatIps: + description: 'A list of active IPs for NAT. Example: ["1.1.1.1", "179.12.26.133"].' + type: array + items: + type: string + drainNatIps: + description: >- + A list of IPs for NAT that are in drain mode. Example: ["1.1.1.1", + "179.12.26.133"]. + type: array + items: + type: string + 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. + type: integer + format: int32 + numVmEndpointsWithNatMappings: + description: >- + Number of VM endpoints (i.e., NICs) that have NAT Mappings from this + NAT Rule. + type: integer + format: int32 + VmEndpointNatMappingsList: + id: VmEndpointNatMappingsList + description: Contains a list of VmEndpointNatMappings. type: object properties: kind: description: >- - Type of resource. Always compute#targetHttpProxyList for lists of - target HTTP proxies. - default: compute#targetHttpProxyList + [Output Only] Type of resource. Always + compute#vmEndpointNatMappingsList for lists of Nat mappings of VM + endpoints. + default: compute#vmEndpointNatMappingsList type: string id: description: >- - [Output Only] Unique identifier for the resource; defined by the - server. + [Output Only] The unique identifier for the resource. This + identifier is defined by the server. type: string - items: - description: A list of TargetHttpProxy resources. + result: + description: '[Output Only] A list of Nat mapping information of VM endpoints.' type: array items: - $ref: '#/components/schemas/TargetHttpProxy' + $ref: '#/components/schemas/VmEndpointNatMappings' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -51270,6 +52052,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -51313,6 +52098,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -51335,6 +52121,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -51371,130 +52158,255 @@ components: [Output Only] A warning data value corresponding to the key. type: string - TargetHttpProxy: - id: 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 Google Cloud HTTP load balancers. * - targetHttpProxies are used by global external Application Load - Balancers, classic Application Load Balancers, cross-region internal - Application Load Balancers, and Traffic Director. * - regionTargetHttpProxies are used by regional internal Application Load - Balancers and regional external Application 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. + VmEndpointNatMappings: + id: VmEndpointNatMappings + description: Contain information of Nat mapping for a VM endpoint (i.e., NIC). type: object properties: - kind: - description: >- - [Output Only] Type of resource. Always compute#targetHttpProxy for - target HTTP proxies. - default: compute#targetHttpProxy + instanceName: + description: Name of the VM instance which the endpoint belongs to type: string - id: - description: >- - [Output Only] The unique identifier for the resource. This - identifier is defined by the server. + interfaceNatMappings: + type: array + items: + $ref: '#/components/schemas/VmEndpointNatMappingsInterfaceNatMappings' + VmEndpointNatMappingsInterfaceNatMappings: + id: VmEndpointNatMappingsInterfaceNatMappings + description: Contain information of Nat mapping for an interface of this endpoint. + type: object + properties: + sourceVirtualIp: + description: Primary IP of the VM for this NIC. type: string - format: uint64 - creationTimestamp: - description: '[Output Only] Creation timestamp in RFC3339 text format.' + 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 - name: + numTotalNatPorts: 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 - 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. + type: integer + format: int32 + natIpPortRanges: description: >- - An optional description of this resource. Provide this property when - you create the resource. + 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"]. + type: array + items: + type: string + 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"]. + type: array + items: + type: string + 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. + type: integer + format: int32 + ruleMappings: + description: Information about mappings provided by rules in this NAT. + type: array + items: + $ref: >- + #/components/schemas/VmEndpointNatMappingsInterfaceNatMappingsNatRuleMappings + VmEndpointNatMappingsInterfaceNatMappingsNatRuleMappings: + id: VmEndpointNatMappingsInterfaceNatMappingsNatRuleMappings + description: Contains information of NAT Mappings provided by a NAT Rule. + type: object + properties: + ruleNumber: + description: Rule number of the NAT Rule. + type: integer + format: int32 + numTotalNatPorts: + description: >- + Total number of ports across all NAT IPs allocated to this interface + by this rule. It equals the aggregated port number in the field + nat_ip_port_ranges. + type: integer + format: int32 + natIpPortRanges: + description: >- + A list of all IP:port-range mappings assigned to this interface by + this rule. 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"]. + type: array + items: + type: string + drainNatIpPortRanges: + description: >- + List of all drain IP:port-range mappings assigned to this interface + by this rule. 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"]. + type: array + items: + type: string + numTotalDrainNatPorts: + description: >- + Total number of drain ports across all NAT IPs allocated to this + interface by this rule. It equals the aggregated port number in the + field drain_nat_ip_port_ranges. + type: integer + format: int32 + NatIpInfoResponse: + id: NatIpInfoResponse + type: object + properties: + result: + description: '[Output Only] A list of NAT IP information.' + type: array + items: + $ref: '#/components/schemas/NatIpInfo' + NatIpInfo: + id: NatIpInfo + description: Contains NAT IP information of a NAT config (i.e. usage status, mode). + type: object + properties: + natName: + description: Name of the NAT config which the NAT IP belongs to. type: string - selfLink: - description: '[Output Only] Server-defined URL for the resource.' + natIpInfoMappings: + description: A list of all NAT IPs assigned to this NAT config. + type: array + items: + $ref: '#/components/schemas/NatIpInfoNatIpInfoMapping' + NatIpInfoNatIpInfoMapping: + id: NatIpInfoNatIpInfoMapping + description: Contains information of a NAT IP. + type: object + properties: + natIp: + description: 'NAT IP address. For example: 203.0.113.11.' type: string - urlMap: + usage: description: >- - URL to the UrlMap resource that defines the mapping from URL to the - BackendService. + Specifies whether NAT IP is currently serving at least one endpoint + or not. type: string - region: + enumDescriptions: + - '' + - '' + enum: + - IN_USE + - UNUSED + mode: + description: Specifies whether NAT IP is auto or manual. + type: string + enumDescriptions: + - '' + - '' + enum: + - AUTO + - MANUAL + RoutersPreviewResponse: + id: RoutersPreviewResponse + type: object + properties: + resource: + description: Preview of given router. + $ref: '#/components/schemas/Router' + RoutePolicy: + id: RoutePolicy + type: object + properties: + name: description: >- - [Output Only] URL of the region where the regional Target HTTP Proxy - resides. This field is not applicable to global Target HTTP Proxies. + Route Policy name, which must be a resource ID segment and unique + within all the router's Route Policies. Name should conform to + RFC1035. type: string - proxyBind: + type: + type: string + enumDescriptions: + - The Route Policy is an Export Policy. + - The Route Policy is an Import Policy. + enum: + - ROUTE_POLICY_TYPE_EXPORT + - ROUTE_POLICY_TYPE_IMPORT + terms: 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 + List of terms (the order in the list is not important, they are + evaluated in order of priority). Order of policies is not retained + and might change when getting policy later. + type: array + items: + $ref: '#/components/schemas/RoutePolicyPolicyTerm' 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. + A fingerprint for the Route Policy being applied to this Router, + which is essentially a hash of the Route Policy used for optimistic + locking. The fingerprint is initially generated by Compute Engine + and changes after every request to modify or update Route Policy. + You must always provide an up-to-date fingerprint hash in order to + update or change labels. To see the latest fingerprint, make a + getRoutePolicy() request to retrieve a Route Policy. type: string format: byte - httpKeepAliveTimeoutSec: + description: + description: An optional description of route policy. + type: string + RoutePolicyPolicyTerm: + id: RoutePolicyPolicyTerm + type: object + properties: + priority: description: >- - Specifies how long to keep a connection open, after completing a - response, while there is no matching traffic (in seconds). If an - HTTP keep-alive is not specified, a default value (610 seconds) will - be used. For global external Application Load Balancers, the minimum - allowed value is 5 seconds and the maximum allowed value is 1200 - seconds. For classic Application Load Balancers, this option is not - supported. + The evaluation priority for this term, which must be between 0 + (inclusive) and 2^31 (exclusive), and unique within the list. type: integer format: int32 - UrlMapReference: - id: UrlMapReference + match: + description: >- + CEL expression evaluated against a route to determine if this term + applies. When not set, the term applies to all routes. + $ref: '#/components/schemas/Expr' + actions: + description: >- + CEL expressions to evaluate to modify a route when this term + matches. + type: array + items: + $ref: '#/components/schemas/Expr' + RoutersGetRoutePolicyResponse: + id: RoutersGetRoutePolicyResponse type: object properties: - urlMap: - type: string - TargetHttpProxyAggregatedList: - id: TargetHttpProxyAggregatedList + resource: + $ref: '#/components/schemas/RoutePolicy' + RoutersListRoutePolicies: + id: RoutersListRoutePolicies type: object properties: kind: description: >- [Output Only] Type of resource. Always - compute#targetHttpProxyAggregatedList for lists of Target HTTP - Proxies. - default: compute#targetHttpProxyAggregatedList + compute#routersListRoutePolicies for lists of route policies. + default: compute#routersListRoutePolicies type: string id: description: >- - [Output Only] Unique identifier for the resource; defined by the - server. + [Output Only] The unique identifier for the resource. This + identifier is defined by the server. type: string - items: - description: A list of TargetHttpProxiesScopedList resources. - type: object - additionalProperties: - description: Name of the scope containing this set of TargetHttpProxies. - $ref: '#/components/schemas/TargetHttpProxiesScopedList' + result: + description: '[Output Only] A list of route policies.' + type: array + items: + $ref: '#/components/schemas/RoutePolicy' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -51506,24 +52418,8 @@ components: selfLink: description: '[Output Only] Server-defined URL for this resource.' type: string - unreachables: - description: '[Output Only] Unreachable resources.' - type: array - items: - type: string - TargetHttpProxiesScopedList: - id: TargetHttpProxiesScopedList - type: object - properties: - targetHttpProxies: - description: A list of TargetHttpProxies contained in this scope. - type: array - items: - $ref: '#/components/schemas/TargetHttpProxy' warning: - description: >- - Informational warning which replaces the list of backend services - when the list is empty. + description: '[Output Only] Informational warning message.' type: object properties: code: @@ -51586,6 +52482,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -51629,6 +52528,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -51651,6 +52551,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -51687,27 +52588,33 @@ components: [Output Only] A warning data value corresponding to the key. type: string - TargetHttpsProxyList: - id: TargetHttpsProxyList - description: Contains a list of TargetHttpsProxy resources. + etag: + type: string + unreachables: + description: '[Output Only] Unreachable resources.' + type: array + items: + type: string + RoutersListBgpRoutes: + id: RoutersListBgpRoutes type: object properties: kind: description: >- - Type of resource. Always compute#targetHttpsProxyList for lists of - target HTTPS proxies. - default: compute#targetHttpsProxyList + [Output Only] Type of resource. Always compute#routersListBgpRoutes + for lists of bgp routes. + default: compute#routersListBgpRoutes type: string id: description: >- - [Output Only] Unique identifier for the resource; defined by the - server. + [Output Only] The unique identifier for the resource. This + identifier is defined by the server. type: string - items: - description: A list of TargetHttpsProxy resources. + result: + description: '[Output Only] A list of bgp routes.' type: array items: - $ref: '#/components/schemas/TargetHttpsProxy' + $ref: '#/components/schemas/BgpRoute' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -51783,6 +52690,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -51826,6 +52736,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -51848,6 +52759,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -51884,222 +52796,90 @@ components: [Output Only] A warning data value corresponding to the key. type: string - TargetHttpsProxy: - id: 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. * - targetHttpProxies are used by global external Application Load - Balancers, classic Application Load Balancers, cross-region internal - Application Load Balancers, and Traffic Director. * - regionTargetHttpProxies are used by regional internal Application Load - Balancers and regional external Application 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. + etag: + type: string + unreachables: + description: '[Output Only] Unreachable resources.' + type: array + items: + type: string + BgpRoute: + id: BgpRoute type: object properties: - kind: - description: >- - [Output Only] Type of resource. Always compute#targetHttpsProxy for - target HTTPS proxies. - default: compute#targetHttpsProxy - type: string - id: - description: >- - [Output Only] The unique identifier for the resource. This - identifier is defined by the server. - type: string - format: uint64 - creationTimestamp: - description: '[Output Only] Creation timestamp in RFC3339 text format.' - 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 - description: - description: >- - An optional description of this resource. Provide this property when - you create the resource. - type: string - selfLink: - description: '[Output Only] Server-defined URL for the resource.' - 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 - sslCertificates: + destination: 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. SslCertificates do not apply when the - load balancing scheme is set to INTERNAL_SELF_MANAGED. The URLs - should refer to a SSL Certificate resource or Certificate Manager - Certificate resource. Mixing Classic Certificates and Certificate - Manager Certificates is not allowed. Certificate Manager - Certificates must include the certificatemanager API. Certificate - Manager Certificates are not supported by Global external - Application Load Balancer or Classic Application Load Balancer, use - certificate_map instead. Currently, you may specify up to 15 Classic - SSL Certificates. Certificate Manager Certificates accepted formats - are: - - //certificatemanager.googleapis.com/projects/{project}/locations/{ - location}/certificates/{resourceName}. - - https://certificatemanager.googleapis.com/v1alpha1/projects/{project - }/locations/{location}/certificates/{resourceName}. + [Output only] Destination IP range for the route, in human-readable + CIDR format + $ref: '#/components/schemas/BgpRouteNetworkLayerReachabilityInformation' + asPaths: + description: '[Output only] AS-PATH for the route' + type: array + items: + $ref: '#/components/schemas/BgpRouteAsPath' + communities: + description: '[Output only] BGP communities in human-readable A:B format.' type: array items: type: string - certificateMap: - description: >- - URL of a certificate map that identifies a certificate map - associated with the given target proxy. This field can only be set - for Global external Application Load Balancer or Classic Application - Load Balancer. For other products use Certificate Manager - Certificates instead. If set, sslCertificates will be ignored. - Accepted format is - //certificatemanager.googleapis.com/projects/{project - }/locations/{location}/certificateMaps/{resourceName}. - type: string - 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. + origin: + description: '[Output only] BGP origin (EGP, IGP or INCOMPLETE)' type: string enumDescriptions: - - The load balancer will not attempt to negotiate QUIC with clients. - - The load balancer will attempt to negotiate QUIC with clients. - - >- - No overrides to the default QUIC policy. This option is implicit - if no QUIC override has been specified in the request. + - '' + - '' + - '' enum: - - DISABLE - - ENABLE - - NONE - 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 - region: - description: >- - [Output Only] URL of the region where the regional TargetHttpsProxy - resides. This field is not applicable to global TargetHttpsProxies. - 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 - 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 or EXTERNAL or EXTERNAL_MANAGED. For - details which ServerTlsPolicy resources are accepted with - INTERNAL_SELF_MANAGED and which with EXTERNAL, EXTERNAL_MANAGED - loadBalancingScheme consult ServerTlsPolicy documentation. If left - blank, communications are not encrypted. - type: string - 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 - 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. + - BGP_ORIGIN_EGP + - BGP_ORIGIN_IGP + - BGP_ORIGIN_INCOMPLETE + med: + description: '[Output only] BGP multi-exit discriminator' + type: integer + format: uint32 + BgpRouteNetworkLayerReachabilityInformation: + id: BgpRouteNetworkLayerReachabilityInformation + description: Network Layer Reachability Information (NLRI) for a route. + type: object + properties: + prefix: + description: Human readable CIDR notation for a prefix. E.g. 10.42.0.0/16. type: string - format: byte - httpKeepAliveTimeoutSec: + pathId: description: >- - Specifies how long to keep a connection open, after completing a - response, while there is no matching traffic (in seconds). If an - HTTP keep-alive is not specified, a default value (610 seconds) will - be used. For global external Application Load Balancers, the minimum - allowed value is 5 seconds and the maximum allowed value is 1200 - seconds. For classic Application Load Balancers, this option is not - supported. + If the BGP session supports multiple paths (RFC 7911), the path + identifier for this route. type: integer - format: int32 - tlsEarlyData: - description: ' Specifies whether TLS 1.3 0-RTT Data ("Early Data") should be accepted for this service. Early Data allows a TLS resumption handshake to include the initial application payload (a HTTP request) alongside the handshake, reducing the effective round trips to "zero". This applies to TLS 1.3 connections over TCP (HTTP/2) as well as over UDP (QUIC/h3). This can improve application performance, especially on networks where interruptions may be common, such as on mobile. Requests with Early Data will have the "Early-Data" HTTP header set on the request, with a value of "1", to allow the backend to determine whether Early Data was included. Note: TLS Early Data may allow requests to be replayed, as the data is sent to the backend before the handshake has fully completed. Applications that allow idempotent HTTP methods to make non-idempotent changes, such as a GET request updating a database, should not accept Early Data on those requests, and reject requests with the "Early-Data: 1" HTTP header by returning a HTTP 425 (Too Early) status code, in order to remain RFC compliant. The default value is DISABLED.' + format: uint32 + BgpRouteAsPath: + id: BgpRouteAsPath + type: object + properties: + type: + description: '[Output only] Type of AS-PATH segment (SEQUENCE or SET)' type: string enumDescriptions: - - >- - TLS 1.3 Early Data is not advertised, and any (invalid) attempts - to send Early Data will be rejected by closing the connection. - - >- - This enables TLS 1.3 0-RTT, and only allows Early Data to be - included on requests with safe HTTP methods (GET, HEAD, OPTIONS, - TRACE). This mode does not enforce any other limitations for - requests with Early Data. The application owner should validate - that Early Data is acceptable for a given request path. - - >- - This enables TLS 1.3 0-RTT, and only allows Early Data to be - included on requests with safe HTTP methods (GET, HEAD, OPTIONS, - TRACE) without query parameters. Requests that send Early Data - with non-idempotent HTTP methods or with query parameters will be - rejected with a HTTP 425. + - '' + - '' enum: - - DISABLED - - PERMISSIVE - - STRICT - TargetHttpsProxyAggregatedList: - id: TargetHttpsProxyAggregatedList + - AS_PATH_TYPE_SEQUENCE + - AS_PATH_TYPE_SET + asns: + description: >- + [Output only] ASNs in the path segment. When type is SEQUENCE, these + are ordered. + type: array + items: + type: integer + format: int32 + ServiceAttachmentAggregatedList: + id: ServiceAttachmentAggregatedList + description: Contains a list of ServiceAttachmentsScopedList. type: object properties: kind: - description: >- - [Output Only] Type of resource. Always - compute#targetHttpsProxyAggregatedList for lists of Target HTTP - Proxies. - default: compute#targetHttpsProxyAggregatedList + description: Type of resource. + default: compute#serviceAttachmentAggregatedList type: string id: description: >- @@ -52107,11 +52887,11 @@ components: server. type: string items: - description: A list of TargetHttpsProxiesScopedList resources. + description: A list of ServiceAttachmentsScopedList resources. type: object additionalProperties: - description: Name of the scope containing this set of TargetHttpsProxies. - $ref: '#/components/schemas/TargetHttpsProxiesScopedList' + description: Name of the scope containing this set of ServiceAttachments. + $ref: '#/components/schemas/ServiceAttachmentsScopedList' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -52187,6 +52967,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -52230,6 +53013,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -52252,6 +53036,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -52293,18 +53078,18 @@ components: type: array items: type: string - TargetHttpsProxiesScopedList: - id: TargetHttpsProxiesScopedList + ServiceAttachmentsScopedList: + id: ServiceAttachmentsScopedList type: object properties: - targetHttpsProxies: - description: A list of TargetHttpsProxies contained in this scope. + serviceAttachments: + description: A list of ServiceAttachments contained in this scope. type: array items: - $ref: '#/components/schemas/TargetHttpsProxy' + $ref: '#/components/schemas/ServiceAttachment' warning: description: >- - Informational warning which replaces the list of backend services + Informational warning which replaces the list of service attachments when the list is empty. type: object properties: @@ -52368,6 +53153,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -52411,6 +53199,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -52433,6 +53222,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -52469,74 +53259,262 @@ components: [Output Only] A warning data value corresponding to the key. type: string - TargetHttpsProxiesSetSslCertificatesRequest: - id: TargetHttpsProxiesSetSslCertificatesRequest + ServiceAttachment: + id: 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. type: object properties: - sslCertificates: + kind: 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. + [Output Only] Type of the resource. Always compute#serviceAttachment + for service attachments. + default: compute#serviceAttachment + type: string + id: + description: >- + [Output Only] The unique identifier for the resource type. The + server generates this identifier. + type: string + format: uint64 + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + 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])?' + annotations: + required: + - compute.serviceAttachments.insert + type: string + description: + description: >- + An optional description of this resource. Provide this property when + you create the resource. + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + 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 + producerForwardingRule: + description: >- + The URL of a forwarding rule with loadBalancingScheme INTERNAL* that + is serving the endpoint identified by this service attachment. + deprecated: true + type: string + targetService: + description: >- + The URL of a service serving the endpoint identified by this service + attachment. + type: string + 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. + type: string + enumDescriptions: + - '' + - '' + - '' + enum: + - ACCEPT_AUTOMATIC + - ACCEPT_MANUAL + - CONNECTION_PREFERENCE_UNSPECIFIED + connectedEndpoints: + description: >- + [Output Only] An array of connections for all the consumers + connected to this service attachment. + type: array + items: + $ref: '#/components/schemas/ServiceAttachmentConnectedEndpoint' + 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. type: array items: type: string - TargetHttpsProxiesSetCertificateMapRequest: - id: TargetHttpsProxiesSetCertificateMapRequest - type: object - properties: - certificateMap: + enableProxyProtocol: description: >- - URL of the Certificate Map to associate with this TargetHttpsProxy. - Accepted format is - //certificatemanager.googleapis.com/projects/{project - }/locations/{location}/certificateMaps/{resourceName}. - type: string - SslPolicyReference: - id: SslPolicyReference - type: object - properties: - sslPolicy: + 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 + consumerRejectLists: description: >- - URL of the SSL policy resource. Set this to empty string to clear - any existing SSL policy associated with the target proxy resource. + Specifies a list of projects or networks that are not allowed to + connect to this service attachment. The project can be specified + using its project ID or project number and the network can be + specified using its URL. A given service attachment can manage + connections at either the project or network level. Therefore, both + the reject and accept lists for a given service attachment must + contain either only projects or only networks. + type: array + items: + type: string + consumerAcceptLists: + description: >- + Specifies which consumer projects or networks are allowed to connect + to the service attachment. Each project or network has a connection + limit. A given service attachment can manage connections at either + the project or network level. Therefore, both the accept and reject + lists for a given service attachment must contain either only + projects or only networks or only endpoints. + type: array + items: + $ref: '#/components/schemas/ServiceAttachmentConsumerProjectLimit' + pscServiceAttachmentId: + description: >- + [Output Only] An 128-bit global unique ID of the PSC service + attachment. + $ref: '#/components/schemas/Uint128' + 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. type: string - TargetHttpsProxiesSetQuicOverrideRequest: - id: TargetHttpsProxiesSetQuicOverrideRequest + format: byte + domainNames: + description: >- + If specified, the domain name will be used during the integration + between the PSC connected endpoints and the Cloud DNS. For example, + this is a valid domain name: "p.mycompany.com.". Current max number + of domain names supported is 1. + type: array + items: + type: string + reconcileConnections: + description: >- + This flag determines whether a consumer accept/reject list change + can reconcile the statuses of existing ACCEPTED or REJECTED PSC + endpoints. - If false, connection policy update will only affect + existing PENDING PSC endpoints. Existing ACCEPTED/REJECTED endpoints + will remain untouched regardless how the connection policy is + modified . - If true, update will affect both PENDING and + ACCEPTED/REJECTED PSC endpoints. For example, an ACCEPTED PSC + endpoint will be moved to REJECTED if its project is added to the + reject list. For newly created service attachment, this boolean + defaults to false. + type: boolean + propagatedConnectionLimit: + description: >- + The number of consumer spokes that connected Private Service Connect + endpoints can be propagated to through Network Connectivity Center. + This limit lets the service producer limit how many propagated + Private Service Connect connections can be established to this + service attachment from a single consumer. If the connection + preference of the service attachment is ACCEPT_MANUAL, the limit + applies to each project or network that is listed in the consumer + accept list. If the connection preference of the service attachment + is ACCEPT_AUTOMATIC, the limit applies to each project that contains + a connected endpoint. If unspecified, the default propagated + connection limit is 250. + type: integer + format: uint32 + metadata: + description: Metadata of the service attachment. + type: object + additionalProperties: + type: string + ServiceAttachmentConnectedEndpoint: + id: ServiceAttachmentConnectedEndpoint + description: '[Output Only] A connection connected to this service attachment.' type: object properties: - quicOverride: - description: QUIC policy for the TargetHttpsProxy resource. + status: + description: The status of a connected endpoint to this service attachment. type: string enumDescriptions: - - The load balancer will not attempt to negotiate QUIC with clients. - - The load balancer will attempt to negotiate QUIC with clients. + - The connection has been accepted by the producer. + - The connection has been closed by the producer. - >- - No overrides to the default QUIC policy. This option is implicit - if no QUIC override has been specified in the request. + The connection has been accepted by the producer, but the producer + needs to take further action before the forwarding rule can serve + traffic. + - The connection is pending acceptance by the producer. + - The consumer is still connected but not using the connection. + - '' enum: - - DISABLE - - ENABLE - - NONE - RegionTargetHttpsProxiesSetSslCertificatesRequest: - id: RegionTargetHttpsProxiesSetSslCertificatesRequest + - ACCEPTED + - CLOSED + - NEEDS_ATTENTION + - PENDING + - REJECTED + - STATUS_UNSPECIFIED + pscConnectionId: + description: The PSC connection id of the connected endpoint. + type: string + format: uint64 + endpoint: + description: The url of a connected endpoint. + type: string + consumerNetwork: + description: The url of the consumer network. + type: string + propagatedConnectionCount: + description: >- + The number of consumer Network Connectivity Center spokes that the + connected Private Service Connect endpoint has propagated to. + type: integer + format: uint32 + ServiceAttachmentConsumerProjectLimit: + id: ServiceAttachmentConsumerProjectLimit type: object properties: - sslCertificates: + projectIdOrNum: + description: The project id or number for the project to set the limit for. + type: string + networkUrl: + description: The network URL for the network to set the limit for. + type: string + connectionLimit: description: >- - New set of SslCertificate resources to associate with this - TargetHttpsProxy resource. - type: array - items: - type: string - TargetInstanceList: - id: TargetInstanceList - description: Contains a list of TargetInstance resources. + The value of the limit to set. For endpoint_url, the limit should be + no more than 1. + type: integer + format: uint32 + Uint128: + id: Uint128 + type: object + properties: + high: + type: string + format: uint64 + low: + type: string + format: uint64 + ServiceAttachmentList: + id: ServiceAttachmentList type: object properties: kind: - description: Type of resource. - default: compute#targetInstanceList + description: >- + [Output Only] Type of the resource. Always compute#serviceAttachment + for service attachments. + default: compute#serviceAttachmentList type: string id: description: >- @@ -52544,10 +53522,10 @@ components: server. type: string items: - description: A list of TargetInstance resources. + description: A list of ServiceAttachment resources. type: array items: - $ref: '#/components/schemas/TargetInstance' + $ref: '#/components/schemas/ServiceAttachment' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -52623,6 +53601,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -52666,6 +53647,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -52688,6 +53670,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -52724,94 +53707,68 @@ components: [Output Only] A warning data value corresponding to the key. type: string - TargetInstance: - id: 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. + SnapshotSettings: + id: SnapshotSettings type: object properties: - kind: - description: >- - [Output Only] The type of the resource. Always - compute#targetInstance for target instances. - default: compute#targetInstance - type: string - id: - description: >- - [Output Only] The unique identifier for the resource. This - identifier is defined by the server. - type: string - format: uint64 - creationTimestamp: - description: '[Output Only] Creation timestamp in RFC3339 text format.' - 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 - description: - description: >- - An optional description of this resource. Provide this property when - you create 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 - natPolicy: + storageLocation: description: >- - Must have a value of NO_NAT. Protocol forwarding delivers packets - while preserving the destination IP address of the forwarding rule - referencing the target instance. + Policy of which storage location is going to be resolved, and + additional data that particularizes how the policy is going to be + carried out. + $ref: '#/components/schemas/SnapshotSettingsStorageLocationSettings' + SnapshotSettingsStorageLocationSettings: + id: SnapshotSettingsStorageLocationSettings + type: object + properties: + policy: + description: The chosen location policy. type: string enumDescriptions: - - No NAT performed. + - >- + Store snapshot in the same region as with the originating disk. No + additional parameters are needed. + - >- + Store snapshot in the nearest multi region Cloud Storage bucket, + relative to the originating disk. No additional parameters are + needed. + - >- + Store snapshot in the specific locations, as specified by the + user. The list of regions to store must be defined under the + `locations` field. + - '' enum: - - NO_NAT - 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 - selfLink: - description: '[Output Only] Server-defined URL for the resource.' - type: string - network: + - LOCAL_REGION + - NEAREST_MULTI_REGION + - SPECIFIC_LOCATIONS + - STORAGE_LOCATION_POLICY_UNSPECIFIED + locations: 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 - securityPolicy: + When the policy is SPECIFIC_LOCATIONS, snapshots will be stored in + the locations listed in this field. Keys are Cloud Storage bucket + locations. Only one location can be specified. + type: object + additionalProperties: + $ref: >- + #/components/schemas/SnapshotSettingsStorageLocationSettingsStorageLocationPreference + SnapshotSettingsStorageLocationSettingsStorageLocationPreference: + id: SnapshotSettingsStorageLocationSettingsStorageLocationPreference + description: A structure for specifying storage locations. + type: object + properties: + name: description: >- - [Output Only] The resource URL for the security policy associated - with this target instance. + Name of the location. It should be one of the Cloud Storage buckets. + Only one location can be specified. type: string - TargetInstanceAggregatedList: - id: TargetInstanceAggregatedList + SslCertificateList: + id: SslCertificateList + description: Contains a list of SslCertificate resources. type: object properties: kind: description: Type of resource. - default: compute#targetInstanceAggregatedList + default: compute#sslCertificateList type: string id: description: >- @@ -52819,11 +53776,10 @@ components: server. type: string items: - description: A list of TargetInstance resources. - type: object - additionalProperties: - description: Name of the scope containing this set of target instances. - $ref: '#/components/schemas/TargetInstancesScopedList' + description: A list of SslCertificate resources. + type: array + items: + $ref: '#/components/schemas/SslCertificate' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -52899,6 +53855,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -52942,6 +53901,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -52964,6 +53924,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -53000,24 +53961,239 @@ components: [Output Only] A warning data value corresponding to the key. type: string - unreachables: - description: '[Output Only] Unreachable resources.' - type: array - items: - type: string - TargetInstancesScopedList: - id: TargetInstancesScopedList + SslCertificate: + id: 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 + global SSL certificates (sslCertificates) are used by: - Global external + Application Load Balancers - Classic Application Load Balancers - Proxy + Network Load Balancers (with target SSL proxies) The regional SSL + certificates (regionSslCertificates) are used by: - Regional external + Application Load Balancers - Regional internal Application 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. type: object properties: - targetInstances: - description: A list of target instances contained in this scope. + kind: + description: >- + [Output Only] Type of the resource. Always compute#sslCertificate + for SSL certificates. + default: compute#sslCertificate + type: string + id: + description: >- + [Output Only] The unique identifier for the resource. This + identifier is defined by the server. + type: string + format: uint64 + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + 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 + description: + description: >- + An optional description of this resource. Provide this property when + you create the resource. + type: string + selfLink: + description: '[Output only] Server-defined URL for the resource.' + type: string + 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 + 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 + managed: + description: Configuration and status of a managed SSL certificate. + $ref: '#/components/schemas/SslCertificateManagedSslCertificate' + selfManaged: + description: Configuration and status of a self-managed SSL certificate. + $ref: '#/components/schemas/SslCertificateSelfManagedSslCertificate' + 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. + type: string + enumDescriptions: + - Google-managed SSLCertificate. + - Certificate uploaded by user. + - '' + enum: + - MANAGED + - SELF_MANAGED + - TYPE_UNSPECIFIED + subjectAlternativeNames: + description: >- + [Output Only] Domains associated with the certificate via Subject + Alternative Name. type: array items: - $ref: '#/components/schemas/TargetInstance' - warning: + type: string + expireTime: + description: '[Output Only] Expire time of the certificate. RFC3339' + type: string + region: description: >- - Informational warning which replaces the list of addresses when the - list is empty. + [Output Only] URL of the region where the regional SSL Certificate + resides. This field is not applicable to global SSL Certificate. + type: string + SslCertificateManagedSslCertificate: + id: SslCertificateManagedSslCertificate + description: Configuration and status of a managed SSL certificate. + type: object + properties: + 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). + type: array + items: + type: string + status: + description: '[Output only] Status of the managed certificate resource.' + type: string + enumDescriptions: + - >- + The certificate management is working, and a certificate has been + provisioned. + - '' + - >- + The certificate management is working. GCP will attempt to + provision the first certificate. + - >- + Certificate provisioning failed due to an issue with the DNS or + load balancing configuration. For details of which domain failed, + consult domain_status field. + - >- + Certificate provisioning failed due to an issue with the DNS or + load balancing configuration. It won't be retried. To try again + delete and create a new managed SslCertificate resource. For + details of which domain failed, consult domain_status field. + - >- + Renewal of the certificate has failed due to an issue with the DNS + or load balancing configuration. The existing cert is still + serving; however, it will expire shortly. To provision a renewed + certificate, delete and create a new managed SslCertificate + resource. For details on which domain failed, consult + domain_status field. + enum: + - ACTIVE + - MANAGED_CERTIFICATE_STATUS_UNSPECIFIED + - PROVISIONING + - PROVISIONING_FAILED + - PROVISIONING_FAILED_PERMANENTLY + - RENEWAL_FAILED + domainStatus: + description: >- + [Output only] Detailed statuses of the domains specified for managed + certificate resource. + type: object + additionalProperties: + type: string + enumDescriptions: + - >- + A managed certificate can be provisioned, no issues for this + domain. + - '' + - Failed to check CAA records for the domain. + - >- + Certificate issuance forbidden by an explicit CAA record for the + domain. + - >- + There seems to be problem with the user's DNS or load balancer + configuration for this domain. + - >- + Reached rate-limit for certificates per top-level private + domain. + - >- + Certificate provisioning for this domain is under way. GCP will + attempt to provision the first certificate. + enum: + - ACTIVE + - DOMAIN_STATUS_UNSPECIFIED + - FAILED_CAA_CHECKING + - FAILED_CAA_FORBIDDEN + - FAILED_NOT_VISIBLE + - FAILED_RATE_LIMITED + - PROVISIONING + SslCertificateSelfManagedSslCertificate: + id: SslCertificateSelfManagedSslCertificate + description: Configuration and status of a self-managed SSL certificate. + type: object + 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 + SslCertificateAggregatedList: + id: SslCertificateAggregatedList + type: object + properties: + kind: + description: >- + [Output Only] Type of resource. Always + compute#sslCertificateAggregatedList for lists of SSL Certificates. + default: compute#sslCertificateAggregatedList + type: string + id: + description: >- + [Output Only] Unique identifier for the resource; defined by the + server. + type: string + items: + description: A list of SslCertificatesScopedList resources. + type: object + additionalProperties: + description: Name of the scope containing this set of SslCertificates. + $ref: '#/components/schemas/SslCertificatesScopedList' + nextPageToken: + description: >- + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. + type: string + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string + warning: + description: '[Output Only] Informational warning message.' type: object properties: code: @@ -53080,6 +54256,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -53123,6 +54302,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -53145,6 +54325,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -53181,40 +54362,24 @@ components: [Output Only] A warning data value corresponding to the key. type: string - TargetPoolList: - id: TargetPoolList - description: Contains a list of TargetPool resources. + unreachables: + description: '[Output Only] Unreachable resources.' + type: array + items: + type: string + SslCertificatesScopedList: + id: SslCertificatesScopedList type: object properties: - kind: - description: >- - [Output Only] Type of resource. Always compute#targetPoolList for - lists of target pools. - default: compute#targetPoolList - type: string - id: - description: >- - [Output Only] Unique identifier for the resource; defined by the - server. - type: string - items: - description: A list of TargetPool resources. + sslCertificates: + description: List of SslCertificates contained in this scope. type: array items: - $ref: '#/components/schemas/TargetPool' - nextPageToken: - description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. - type: string - selfLink: - description: '[Output Only] Server-defined URL for this resource.' - type: string + $ref: '#/components/schemas/SslCertificate' warning: - description: '[Output Only] Informational warning message.' + description: >- + Informational warning which replaces the list of backend services + when the list is empty. type: object properties: code: @@ -53277,6 +54442,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -53320,6 +54488,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -53342,6 +54511,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -53378,173 +54548,15 @@ components: [Output Only] A warning data value corresponding to the key. type: string - TargetPool: - id: TargetPool - description: >- - Represents a Target Pool resource. Target pools are used with external - passthrough Network Load Balancers. A target pool references member - instances, an associated legacy HttpHealthCheck resource, and, - optionally, a backup target pool. For more information, read Using - target pools. - type: object - properties: - kind: - description: >- - [Output Only] Type of the resource. Always compute#targetPool for - target pools. - default: compute#targetPool - type: string - id: - description: >- - [Output Only] The unique identifier for the resource. This - identifier is defined by the server. - type: string - format: uint64 - creationTimestamp: - description: '[Output Only] Creation timestamp in RFC3339 text format.' - 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 - description: - description: >- - An optional description of this resource. Provide this property when - you create the resource. - type: string - region: - description: '[Output Only] URL of the region where the target pool resides.' - type: string - 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. - type: array - items: - 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. - type: array - items: - 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. - type: string - enumDescriptions: - - >- - 2-tuple hash on packet's source and destination IP addresses. - Connections from the same source IP address to the same - destination IP address will be served by the same backend VM while - that VM remains healthy. - - >- - 1-tuple hash only on packet's source IP address. Connections from - the same source IP address will be served by the same backend VM - while that VM remains healthy. This option can only be used for - Internal TCP/UDP Load Balancing. - - >- - 5-tuple hash on packet's source and destination IP addresses, IP - protocol, and source and destination ports. Connections for the - same IP protocol from the same source IP address and port to the - same destination IP address and port will be served by the same - backend VM while that VM remains healthy. This option cannot be - used for HTTP(S) load balancing. - - >- - 3-tuple hash on packet's source and destination IP addresses, and - IP protocol. Connections for the same IP protocol from the same - source IP address to the same destination IP address will be - served by the same backend VM while that VM remains healthy. This - option cannot be used for HTTP(S) load balancing. - - >- - Hash based on a cookie generated by the L7 loadbalancer. Only - valid for HTTP(S) load balancing. - - The hash is based on a user specified header field. - - The hash is based on a user provided cookie. - - >- - No session affinity. Connections from the same client IP may go to - any instance in the pool. - - >- - Strong cookie-based affinity. Connections bearing the same cookie - will be served by the same backend VM while that VM remains - healthy, as long as the cookie has not expired. - enum: - - CLIENT_IP - - CLIENT_IP_NO_DESTINATION - - CLIENT_IP_PORT_PROTO - - CLIENT_IP_PROTO - - GENERATED_COOKIE - - HEADER_FIELD - - HTTP_COOKIE - - NONE - - STRONG_COOKIE_AFFINITY - 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. - type: number - format: float - 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 - selfLink: - description: '[Output Only] Server-defined URL for the resource.' - type: string - securityPolicy: - description: >- - [Output Only] The resource URL for the security policy associated - with this target pool. - type: string - TargetPoolAggregatedList: - id: TargetPoolAggregatedList + SslPoliciesList: + id: SslPoliciesList type: object properties: kind: description: >- - [Output Only] Type of resource. Always - compute#targetPoolAggregatedList for aggregated lists of target - pools. - default: compute#targetPoolAggregatedList + [Output Only] Type of the resource. Always compute#sslPoliciesList + for lists of sslPolicies. + default: compute#sslPoliciesList type: string id: description: >- @@ -53552,11 +54564,10 @@ components: server. type: string items: - description: A list of TargetPool resources. - type: object - additionalProperties: - description: Name of the scope containing this set of target pools. - $ref: '#/components/schemas/TargetPoolsScopedList' + description: A list of SslPolicy resources. + type: array + items: + $ref: '#/components/schemas/SslPolicy' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -53632,6 +54643,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -53675,6 +54689,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -53697,6 +54712,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -53733,72 +54749,383 @@ components: [Output Only] A warning data value corresponding to the key. type: string - unreachables: - description: '[Output Only] Unreachable resources.' + SslPolicy: + id: SslPolicy + description: >- + Represents an SSL Policy resource. Use SSL policies to control SSL + features, such as versions and cipher suites, that are offered by + Application Load Balancers and proxy Network Load Balancers. For more + information, read SSL policies overview. + type: object + properties: + kind: + description: >- + [Output only] Type of the resource. Always compute#sslPolicyfor SSL + policies. + default: compute#sslPolicy + type: string + id: + description: >- + [Output Only] The unique identifier for the resource. This + identifier is defined by the server. + type: string + format: uint64 + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + 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 + description: + description: >- + An optional description of this resource. Provide this property when + you create the resource. + 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. + type: string + enumDescriptions: + - >- + Compatible profile. Allows the broadset set of clients, even those + which support only out-of-date SSL features to negotiate with the + load balancer. + - >- + Custom profile. Allow only the set of allowed SSL features + specified in the customFeatures field. + - >- + Modern profile. Supports a wide set of SSL features, allowing + modern clients to negotiate SSL with the load balancer. + - >- + Restricted profile. Supports a reduced set of SSL features, + intended to meet stricter compliance requirements. + enum: + - COMPATIBLE + - CUSTOM + - MODERN + - RESTRICTED + 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. + type: string + enumDescriptions: + - TLS 1.0 + - TLS 1.1 + - TLS 1.2 + enum: + - TLS_1_0 + - TLS_1_1 + - TLS_1_2 + enabledFeatures: + description: '[Output Only] The list of features enabled in the SSL policy.' type: array items: type: string - TargetPoolsScopedList: - id: TargetPoolsScopedList - type: object - properties: - targetPools: - description: A list of target pools contained in this scope. + 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. type: array items: - $ref: '#/components/schemas/TargetPool' - warning: + type: string + fingerprint: description: >- - Informational warning which replaces the list of addresses when the - list is empty. - type: object - properties: - code: - description: >- - [Output Only] A warning code, if applicable. For example, - Compute Engine returns NO_RESULTS_ON_PAGE if there are no - results in the response. - type: string - enumDescriptions: - - >- - Warning about failed cleanup of transient changes made by a - failed operation. - - A link to a deprecated resource was created. - - >- - When deploying and at least one of the resources has a type - marked as deprecated - - The user created a boot disk that is larger than image size. - - >- - When deploying and at least one of the resources has a type - marked as experimental - - Warning that is present in an external api call - - >- - Warning that value of a field has been overridden. Deprecated - unused field. - - >- - The operation involved use of an injected kernel, which is - deprecated. - - >- - A WEIGHTED_MAGLEV backend service is associated with a health - check that is not of type HTTP/HTTPS/HTTP2. - - >- - When deploying a deployment with a exceedingly large number of - resources - - >- - Resource can't be retrieved due to list overhead quota exceed - which captures the amount of resources filtered out by - user-defined list filter. - - A resource depends on a missing type - - >- - The route's nextHopIp address is not assigned to an instance - on the network. - - The route's next hop instance cannot ip forward. - - >- - The route's nextHopInstance URL refers to an instance that - does not have an ipv6 interface on the same network as the - route. - - >- - The route's nextHopInstance URL refers to an instance that + 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. + type: string + format: byte + warnings: + description: >- + [Output Only] If potential misconfigurations are detected for this + SSL policy, this field will be populated with warning messages. + type: array + items: + type: object + properties: + code: + description: >- + [Output Only] A warning code, if applicable. For example, + Compute Engine returns NO_RESULTS_ON_PAGE if there are no + results in the response. + type: string + enumDescriptions: + - >- + Warning about failed cleanup of transient changes made by a + failed operation. + - A link to a deprecated resource was created. + - >- + When deploying and at least one of the resources has a type + marked as deprecated + - The user created a boot disk that is larger than image size. + - >- + When deploying and at least one of the resources has a type + marked as experimental + - Warning that is present in an external api call + - >- + Warning that value of a field has been overridden. + Deprecated unused field. + - >- + The operation involved use of an injected kernel, which is + deprecated. + - >- + A WEIGHTED_MAGLEV backend service is associated with a + health check that is not of type HTTP/HTTPS/HTTP2. + - >- + When deploying a deployment with a exceedingly large number + of resources + - >- + Resource can't be retrieved due to list overhead quota + exceed which captures the amount of resources filtered out + by user-defined list filter. + - A resource depends on a missing type + - >- + The route's nextHopIp address is not assigned to an instance + on the network. + - The route's next hop instance cannot ip forward. + - >- + The route's nextHopInstance URL refers to an instance that + does not have an ipv6 interface on the same network as the + route. + - >- + The route's nextHopInstance URL refers to an instance that + does not exist. + - >- + The route's nextHopInstance URL refers to an instance that + is not on the same network as the route. + - >- + The route's next hop instance does not have a status of + RUNNING. + - >- + Error which is not critical. We decided to continue the + process despite the mentioned error. + - No results are present on a particular list page. + - >- + Success is reported, but some results may be missing due to + errors + - >- + Quota information is not available to client requests (e.g: + regions.list). + - >- + The user attempted to use a resource that requires a TOS + they have not accepted. + - Warning that a resource is in use. + - >- + One or more of the resources set to auto-delete could not be + deleted because they were in use. + - When a resource schema validation is ignored. + - >- + Instance template used in instance group manager is valid as + such, but its application does not make a lot of sense, + because it allows only single instance in instance group. + - When undeclared properties in the schema are present + - A given scope cannot be reached. + enumDeprecated: + - false + - false + - false + - false + - false + - false + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + enum: + - CLEANUP_FAILED + - DEPRECATED_RESOURCE_USED + - DEPRECATED_TYPE_USED + - DISK_SIZE_LARGER_THAN_IMAGE_SIZE + - EXPERIMENTAL_TYPE_USED + - EXTERNAL_API_WARNING + - FIELD_VALUE_OVERRIDEN + - INJECTED_KERNELS_DEPRECATED + - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB + - LARGE_DEPLOYMENT_WARNING + - LIST_OVERHEAD_QUOTA_EXCEED + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE + - NEXT_HOP_INSTANCE_NOT_FOUND + - NEXT_HOP_INSTANCE_NOT_ON_NETWORK + - NEXT_HOP_NOT_RUNNING + - NOT_CRITICAL_ERROR + - NO_RESULTS_ON_PAGE + - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE + - REQUIRED_TOS_AGREEMENT + - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING + - RESOURCE_NOT_DELETED + - SCHEMA_VALIDATION_IGNORED + - SINGLE_INSTANCE_PROPERTY_TEMPLATE + - UNDECLARED_PROPERTIES + - UNREACHABLE + message: + description: >- + [Output Only] A human-readable description of the warning + code. + type: string + data: + description: >- + [Output Only] Metadata about this warning in key: value + format. For example: "data": [ { "key": "scope", "value": + "zones/us-east1-d" } + type: array + items: + type: object + properties: + key: + description: >- + [Output Only] A key that provides more detail on the + warning being returned. For example, for warnings where + there are no results in a list request for a particular + zone, this key might be scope and the key value might be + the zone name. Other examples might be a key indicating + a deprecated resource and a suggested replacement, or a + warning about invalid network settings (for example, if + an instance attempts to perform IP forwarding but is not + enabled for IP forwarding). + type: string + value: + description: >- + [Output Only] A warning data value corresponding to the + key. + type: string + region: + description: >- + [Output Only] URL of the region where the regional SSL policy + resides. This field is not applicable to global SSL policies. + type: string + SslPoliciesListAvailableFeaturesResponse: + id: SslPoliciesListAvailableFeaturesResponse + type: object + properties: + features: + type: array + items: + type: string + SslPoliciesAggregatedList: + id: SslPoliciesAggregatedList + type: object + properties: + kind: + description: >- + [Output Only] Type of resource. Always + compute#sslPolicyAggregatedList for lists of SSL Policies. + default: compute#sslPoliciesAggregatedList + type: string + id: + description: >- + [Output Only] Unique identifier for the resource; defined by the + server. + type: string + items: + description: A list of SslPoliciesScopedList resources. + type: object + additionalProperties: + description: Name of the scope containing this set of SSL policies. + $ref: '#/components/schemas/SslPoliciesScopedList' + nextPageToken: + description: >- + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. + type: string + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string + warning: + description: '[Output Only] Informational warning message.' + type: object + properties: + code: + description: >- + [Output Only] A warning code, if applicable. For example, + Compute Engine returns NO_RESULTS_ON_PAGE if there are no + results in the response. + type: string + enumDescriptions: + - >- + Warning about failed cleanup of transient changes made by a + failed operation. + - A link to a deprecated resource was created. + - >- + When deploying and at least one of the resources has a type + marked as deprecated + - The user created a boot disk that is larger than image size. + - >- + When deploying and at least one of the resources has a type + marked as experimental + - Warning that is present in an external api call + - >- + Warning that value of a field has been overridden. Deprecated + unused field. + - >- + The operation involved use of an injected kernel, which is + deprecated. + - >- + A WEIGHTED_MAGLEV backend service is associated with a health + check that is not of type HTTP/HTTPS/HTTP2. + - >- + When deploying a deployment with a exceedingly large number of + resources + - >- + Resource can't be retrieved due to list overhead quota exceed + which captures the amount of resources filtered out by + user-defined list filter. + - A resource depends on a missing type + - >- + The route's nextHopIp address is not assigned to an instance + on the network. + - The route's next hop instance cannot ip forward. + - >- + The route's nextHopInstance URL refers to an instance that + does not have an ipv6 interface on the same network as the + route. + - >- + The route's nextHopInstance URL refers to an instance that does not exist. - >- The route's nextHopInstance URL refers to an instance that is @@ -53813,6 +55140,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -53856,6 +55186,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -53878,6 +55209,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -53914,102 +55246,26 @@ components: [Output Only] A warning data value corresponding to the key. type: string - TargetPoolInstanceHealth: - id: TargetPoolInstanceHealth - type: object - properties: - kind: - description: >- - [Output Only] Type of resource. Always - compute#targetPoolInstanceHealth when checking the health of an - instance. - default: compute#targetPoolInstanceHealth + etag: type: string - healthStatus: - type: array - items: - $ref: '#/components/schemas/HealthStatus' - TargetPoolsAddHealthCheckRequest: - id: TargetPoolsAddHealthCheckRequest - type: object - properties: - healthChecks: - description: The HttpHealthCheck to add to the target pool. - type: array - items: - $ref: '#/components/schemas/HealthCheckReference' - TargetPoolsRemoveHealthCheckRequest: - id: TargetPoolsRemoveHealthCheckRequest - type: object - 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 - type: array - items: - $ref: '#/components/schemas/HealthCheckReference' - TargetPoolsAddInstanceRequest: - id: TargetPoolsAddInstanceRequest - type: object - 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 - type: array - items: - $ref: '#/components/schemas/InstanceReference' - TargetPoolsRemoveInstanceRequest: - id: TargetPoolsRemoveInstanceRequest - type: object - properties: - instances: - description: URLs of the instances to be removed from target pool. + unreachables: + description: '[Output Only] Unreachable resources.' type: array items: - $ref: '#/components/schemas/InstanceReference' - TargetSslProxyList: - id: TargetSslProxyList - description: Contains a list of TargetSslProxy resources. + type: string + SslPoliciesScopedList: + id: SslPoliciesScopedList type: object properties: - kind: - description: Type of resource. - default: compute#targetSslProxyList - type: string - id: - description: >- - [Output Only] Unique identifier for the resource; defined by the - server. - type: string - items: - description: A list of TargetSslProxy resources. + sslPolicies: + description: A list of SslPolicies contained in this scope. type: array items: - $ref: '#/components/schemas/TargetSslProxy' - nextPageToken: - description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. - type: string - selfLink: - description: '[Output Only] Server-defined URL for this resource.' - type: string + $ref: '#/components/schemas/SslPolicy' warning: - description: '[Output Only] Informational warning message.' + description: >- + Informational warning which replaces the list of SSL policies when + the list is empty. type: object properties: code: @@ -54072,6 +55328,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -54115,6 +55374,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -54137,6 +55397,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -54173,163 +55434,37 @@ components: [Output Only] A warning data value corresponding to the key. type: string - TargetSslProxy: - id: TargetSslProxy - description: >- - Represents a Target SSL Proxy resource. A target SSL proxy is a - component of a Proxy Network Load Balancer. The forwarding rule - references the target SSL proxy, and the target proxy then references a - backend service. For more information, read Proxy Network Load Balancer - overview. + StoragePoolTypeList: + id: StoragePoolTypeList + description: Contains a list of storage pool types. type: object properties: kind: description: >- - [Output Only] Type of the resource. Always compute#targetSslProxy - for target SSL proxies. - default: compute#targetSslProxy + [Output Only] Type of resource. Always compute#storagePoolTypeList + for storage pool types. + default: compute#storagePoolTypeList type: string id: description: >- - [Output Only] The unique identifier for the resource. This - identifier is defined by the server. - type: string - format: uint64 - creationTimestamp: - description: '[Output Only] Creation timestamp in RFC3339 text format.' - 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 - description: - description: >- - An optional description of this resource. Provide this property when - you create the resource. - 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. - type: array - items: - type: string - certificateMap: - description: >- - URL of a certificate map that identifies a certificate map - associated with the given target proxy. This field can only be set - for global target proxies. If set, sslCertificates will be ignored. - Accepted format is - //certificatemanager.googleapis.com/projects/{project - }/locations/{location}/certificateMaps/{resourceName}. - 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. - type: string - enumDescriptions: - - '' - - '' - enum: - - NONE - - PROXY_V1 - 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 - TargetSslProxiesSetBackendServiceRequest: - id: TargetSslProxiesSetBackendServiceRequest - type: object - properties: - service: - description: The URL of the new BackendService resource for the targetSslProxy. + [Output Only] Unique identifier for the resource; defined by the + server. type: string - TargetSslProxiesSetSslCertificatesRequest: - id: TargetSslProxiesSetSslCertificatesRequest - type: object - 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: + description: A list of StoragePoolType resources. type: array items: - type: string - TargetSslProxiesSetCertificateMapRequest: - id: TargetSslProxiesSetCertificateMapRequest - type: object - properties: - certificateMap: + $ref: '#/components/schemas/StoragePoolType' + nextPageToken: description: >- - URL of the Certificate Map to associate with this TargetSslProxy. - Accepted format is - //certificatemanager.googleapis.com/projects/{project - }/locations/{location}/certificateMaps/{resourceName}. + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. type: string - TargetSslProxiesSetProxyHeaderRequest: - id: TargetSslProxiesSetProxyHeaderRequest - type: object - properties: - proxyHeader: - description: >- - The new type of proxy header to append before sending data to the - backend. NONE or PROXY_V1 are allowed. - type: string - enumDescriptions: - - '' - - '' - enum: - - NONE - - PROXY_V1 - TargetTcpProxyList: - id: TargetTcpProxyList - description: Contains a list of TargetTcpProxy resources. - type: object - properties: - kind: - description: Type of resource. - default: compute#targetTcpProxyList - type: string - id: - description: >- - [Output Only] Unique identifier for the resource; defined by the - server. - type: string - items: - description: A list of TargetTcpProxy resources. - type: array - items: - $ref: '#/components/schemas/TargetTcpProxy' - nextPageToken: - description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. - type: string - selfLink: - description: '[Output Only] Server-defined URL for this resource.' + selfLink: + description: '[Output Only] Server-defined URL for this resource.' type: string warning: description: '[Output Only] Informational warning message.' @@ -54395,6 +55530,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -54438,6 +55576,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -54460,6 +55599,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -54496,21 +55636,15 @@ components: [Output Only] A warning data value corresponding to the key. type: string - TargetTcpProxy: - id: TargetTcpProxy - description: >- - Represents a Target TCP Proxy resource. A target TCP proxy is a - component of a Proxy Network Load Balancer. The forwarding rule - references the target TCP proxy, and the target proxy then references a - backend service. For more information, read Proxy Network Load Balancer - overview. + StoragePoolType: + id: StoragePoolType type: object properties: kind: description: >- - [Output Only] Type of the resource. Always compute#targetTcpProxy - for target TCP proxies. - default: compute#targetTcpProxy + [Output Only] Type of the resource. Always compute#storagePoolType + for storage pool types. + default: compute#storagePoolType type: string id: description: >- @@ -54522,65 +55656,77 @@ components: description: '[Output Only] Creation timestamp in RFC3339 text format.' 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. + description: '[Output Only] Name of the resource.' pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' type: string description: + description: '[Output Only] An optional description of this resource.' + type: string + deprecated: description: >- - An optional description of this resource. Provide this property when - you create the resource. + [Output Only] The deprecation status associated with this storage + pool type. + $ref: '#/components/schemas/DeprecationStatus' + zone: + description: >- + [Output Only] URL of the zone where the storage pool 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 selfLink: description: '[Output Only] Server-defined URL for the resource.' type: string - service: - description: URL to the BackendService resource. - type: string - proxyHeader: + selfLinkWithId: description: >- - Specifies the type of proxy header to append before sending data to - the backend, either NONE or PROXY_V1. The default is NONE. + [Output Only] Server-defined URL for this resource with the resource + id. type: string - enumDescriptions: - - '' - - '' - enum: - - NONE - - PROXY_V1 - 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: + minSizeGb: description: >- - [Output Only] URL of the region where the regional TCP proxy - resides. This field is not applicable to global TCP proxy. + [Deprecated] This field is deprecated. Use + minPoolProvisionedCapacityGb instead. type: string - TargetTcpProxyAggregatedList: - id: TargetTcpProxyAggregatedList + format: int64 + minPoolProvisionedCapacityGb: + description: '[Output Only] Minimum storage pool size in GB.' + type: string + format: int64 + maxPoolProvisionedCapacityGb: + description: '[Output Only] Maximum storage pool size in GB.' + type: string + format: int64 + minPoolProvisionedIops: + description: '[Output Only] Minimum provisioned IOPS.' + type: string + format: int64 + maxPoolProvisionedIops: + description: '[Output Only] Maximum provisioned IOPS.' + type: string + format: int64 + minPoolProvisionedThroughput: + description: '[Output Only] Minimum provisioned throughput.' + type: string + format: int64 + maxPoolProvisionedThroughput: + description: '[Output Only] Maximum provisioned throughput.' + type: string + format: int64 + supportedDiskTypes: + description: >- + [Output Only] The list of disk types supported in this storage pool + type. + type: array + items: + type: string + StoragePoolTypeAggregatedList: + id: StoragePoolTypeAggregatedList type: object properties: kind: description: >- [Output Only] Type of resource. Always - compute#targetTcpProxyAggregatedList for lists of Target TCP - Proxies. - default: compute#targetTcpProxyAggregatedList + compute#storagePoolTypeAggregatedList . + default: compute#storagePoolTypeAggregatedList type: string id: description: >- @@ -54588,11 +55734,13 @@ components: server. type: string items: - description: A list of TargetTcpProxiesScopedList resources. + description: A list of StoragePoolTypesScopedList resources. type: object additionalProperties: - description: Name of the scope containing this set of TargetTcpProxies. - $ref: '#/components/schemas/TargetTcpProxiesScopedList' + description: >- + [Output Only] Name of the scope containing this set of storage + pool types. + $ref: '#/components/schemas/StoragePoolTypesScopedList' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -54668,6 +55816,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -54711,6 +55862,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -54733,6 +55885,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -54769,24 +55922,19 @@ components: [Output Only] A warning data value corresponding to the key. type: string - unreachables: - description: '[Output Only] Unreachable resources.' - type: array - items: - type: string - TargetTcpProxiesScopedList: - id: TargetTcpProxiesScopedList + StoragePoolTypesScopedList: + id: StoragePoolTypesScopedList type: object properties: - targetTcpProxies: - description: A list of TargetTcpProxies contained in this scope. + storagePoolTypes: + description: '[Output Only] A list of storage pool types contained in this scope.' type: array items: - $ref: '#/components/schemas/TargetTcpProxy' + $ref: '#/components/schemas/StoragePoolType' warning: description: >- - Informational warning which replaces the list of backend services - when the list is empty. + [Output Only] Informational warning which replaces the list of + storage pool types when the list is empty. type: object properties: code: @@ -54849,6 +55997,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -54892,6 +56043,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -54914,6 +56066,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -54950,38 +56103,16 @@ components: [Output Only] A warning data value corresponding to the key. type: string - TargetTcpProxiesSetBackendServiceRequest: - id: TargetTcpProxiesSetBackendServiceRequest - type: object - properties: - service: - description: The URL of the new BackendService resource for the targetTcpProxy. - type: string - TargetTcpProxiesSetProxyHeaderRequest: - id: TargetTcpProxiesSetProxyHeaderRequest - type: object - properties: - proxyHeader: - description: >- - The new type of proxy header to append before sending data to the - backend. NONE or PROXY_V1 are allowed. - type: string - enumDescriptions: - - '' - - '' - enum: - - NONE - - PROXY_V1 - TargetVpnGatewayList: - id: TargetVpnGatewayList - description: Contains a list of TargetVpnGateway resources. + StoragePoolList: + id: StoragePoolList + description: A list of StoragePool resources. type: object properties: kind: description: >- - [Output Only] Type of resource. Always compute#targetVpnGateway for - target VPN gateways. - default: compute#targetVpnGatewayList + [Output Only] Type of resource. Always compute#storagePoolList for + lists of storagePools. + default: compute#storagePoolList type: string id: description: >- @@ -54989,10 +56120,10 @@ components: server. type: string items: - description: A list of TargetVpnGateway resources. + description: A list of StoragePool resources. type: array items: - $ref: '#/components/schemas/TargetVpnGateway' + $ref: '#/components/schemas/StoragePool' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -55068,6 +56199,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -55111,6 +56245,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -55133,6 +56268,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -55169,19 +56305,25 @@ components: [Output Only] A warning data value corresponding to the key. type: string - TargetVpnGateway: - id: 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. + etag: + type: string + unreachables: + description: >- + [Output Only] Unreachable resources. end_interface: + MixerListResponseWithEtagBuilder + type: array + items: + type: string + StoragePool: + id: StoragePool + description: Represents a zonal storage pool resource. type: object properties: kind: description: >- - [Output Only] Type of resource. Always compute#targetVpnGateway for - target VPN gateways. - default: compute#targetVpnGateway + [Output Only] Type of the resource. Always compute#storagePool for + storage pools. + default: compute#storagePool type: string id: description: >- @@ -55204,90 +56346,193 @@ components: pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' annotations: required: - - compute.targetVpnGateways.insert + - compute.storagePools.insert type: string description: description: >- An optional description of this resource. Provide this property when you create the resource. 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 - network: + poolProvisionedCapacityGb: description: >- - URL of the network to which this VPN gateway is attached. Provided - by the client when the VPN gateway is created. + Size of the storage pool in GiB. For more information about the size + limits, see + https://cloud.google.com/compute/docs/disks/storage-pools. annotations: required: - - compute.targetVpnGateways.insert + - compute.storagePools.insert type: string - tunnels: + format: int64 + poolProvisionedIops: 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. - type: array - items: - type: string - status: + Provisioned IOPS of the storage pool. Only relevant if the storage + pool type is hyperdisk-balanced. + type: string + format: int64 + poolProvisionedThroughput: description: >- - [Output Only] The status of the VPN gateway, which can be one of the - following: CREATING, READY, FAILED, or DELETING. + Provisioned throughput of the storage pool in MiB/s. Only relevant + if the storage pool type is hyperdisk-balanced or + hyperdisk-throughput. + type: string + format: int64 + zone: + description: >- + [Output Only] URL of the zone where the storage pool 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 + state: + description: >- + [Output Only] The status of storage pool creation. - CREATING: + Storage pool is provisioning. storagePool. - FAILED: Storage pool + creation failed. - READY: Storage pool is ready for use. - DELETING: + Storage pool is deleting. type: string enumDescriptions: - - '' - - '' - - '' - - '' + - StoragePool is provisioning + - StoragePool is deleting. + - StoragePool creation failed. + - StoragePool is ready for use. enum: - CREATING - DELETING - FAILED - READY selfLink: - description: '[Output Only] Server-defined URL for the resource.' + description: '[Output Only] Server-defined fully-qualified URL for this resource.' + type: string + selfLinkWithId: + description: '[Output Only] Server-defined URL for this resource''s resource id.' 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. - type: array - items: - type: string labels: 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. + Labels to apply to this storage pool. These can be later modified by + the setLabels method. type: object additionalProperties: type: string labelFingerprint: description: >- - A fingerprint for the labels being applied to this TargetVpnGateway, + A fingerprint for the labels being applied to this storage pool, 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 TargetVpnGateway. + to retrieve a storage pool. type: string format: byte - TargetVpnGatewayAggregatedList: - id: TargetVpnGatewayAggregatedList + resourceStatus: + description: '[Output Only] Status information for the storage pool resource.' + $ref: '#/components/schemas/StoragePoolResourceStatus' + storagePoolType: + description: Type of the storage pool. + type: string + status: + description: '[Output Only] Status information for the storage pool resource.' + $ref: '#/components/schemas/StoragePoolResourceStatus' + capacityProvisioningType: + description: Provisioning type of the byte capacity of the pool. + type: string + enumDescriptions: + - Advanced provisioning "thinly" allocates the related resource. + - >- + Standard provisioning allocates the related resource for the pool + disks' exclusive use. + - '' + enum: + - ADVANCED + - STANDARD + - UNSPECIFIED + performanceProvisioningType: + description: >- + Provisioning type of the performance-related parameters of the pool, + such as throughput and IOPS. + type: string + enumDescriptions: + - Advanced provisioning "thinly" allocates the related resource. + - >- + Standard provisioning allocates the related resource for the pool + disks' exclusive use. + - '' + enum: + - ADVANCED + - STANDARD + - UNSPECIFIED + StoragePoolResourceStatus: + id: StoragePoolResourceStatus + description: '[Output Only] Contains output only fields.' + type: object + properties: + lastResizeTimestamp: + description: >- + [Output Only] Timestamp of the last successful resize in RFC3339 + text format. + type: string + diskCount: + description: '[Output Only] Number of disks used.' + type: string + format: int64 + poolUsedCapacityBytes: + description: >- + [Output Only] Space used by data stored in disks within the storage + pool (in bytes). This will reflect the total number of bytes written + to the disks in the pool, in contrast to the capacity of those + disks. + type: string + format: int64 + poolUserWrittenBytes: + description: >- + [Output Only] Amount of data written into the pool, before it is + compacted. + type: string + format: int64 + totalProvisionedDiskCapacityGb: + description: >- + [Output Only] Sum of all the disks' provisioned capacity (in GiB) in + this storage pool. A disk's provisioned capacity is the same as its + total capacity. + type: string + format: int64 + maxTotalProvisionedDiskCapacityGb: + description: '[Output Only] Maximum allowed aggregate disk size in GiB.' + type: string + format: int64 + poolUsedIops: + description: >- + [Output Only] Sum of all the disks' provisioned IOPS, minus some + amount that is allowed per disk that is not counted towards pool's + IOPS capacity. For more information, see + https://cloud.google.com/compute/docs/disks/storage-pools. + type: string + format: int64 + totalProvisionedDiskIops: + description: '[Output Only] Sum of all the disks'' provisioned IOPS.' + type: string + format: int64 + poolUsedThroughput: + description: '[Output Only] Sum of all the disks'' provisioned throughput in MiB/s.' + type: string + format: int64 + totalProvisionedDiskThroughput: + description: >- + [Output Only] Sum of all the disks' provisioned throughput in MiB/s, + minus some amount that is allowed per disk that is not counted + towards pool's throughput capacity. + type: string + format: int64 + StoragePoolAggregatedList: + id: StoragePoolAggregatedList type: object properties: kind: description: >- - [Output Only] Type of resource. Always compute#targetVpnGateway for - target VPN gateways. - default: compute#targetVpnGatewayAggregatedList + [Output Only] Type of resource. Always + compute#storagePoolAggregatedList for aggregated lists of storage + pools. + default: compute#storagePoolAggregatedList type: string id: description: >- @@ -55295,13 +56540,13 @@ components: server. type: string items: - description: A list of TargetVpnGateway resources. + description: A list of StoragePoolsScopedList resources. type: object additionalProperties: description: >- - [Output Only] Name of the scope containing this set of target VPN - gateways. - $ref: '#/components/schemas/TargetVpnGatewaysScopedList' + [Output Only] Name of the scope containing this set of storage + pool. + $ref: '#/components/schemas/StoragePoolsScopedList' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -55377,6 +56622,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -55420,6 +56668,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -55442,6 +56691,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -55478,24 +56728,26 @@ components: [Output Only] A warning data value corresponding to the key. type: string + etag: + type: string unreachables: description: '[Output Only] Unreachable resources.' type: array items: type: string - TargetVpnGatewaysScopedList: - id: TargetVpnGatewaysScopedList + StoragePoolsScopedList: + id: StoragePoolsScopedList type: object properties: - targetVpnGateways: - description: '[Output Only] A list of target VPN gateways contained in this scope.' + storagePools: + description: '[Output Only] A list of storage pool contained in this scope.' type: array items: - $ref: '#/components/schemas/TargetVpnGateway' + $ref: '#/components/schemas/StoragePool' warning: description: >- [Output Only] Informational warning which replaces the list of - addresses when the list is empty. + storage pool when the list is empty. type: object properties: code: @@ -55558,6 +56810,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -55601,6 +56856,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -55623,6 +56879,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -55659,14 +56916,15 @@ components: [Output Only] A warning data value corresponding to the key. type: string - UrlMapList: - id: UrlMapList - description: Contains a list of UrlMap resources. + StoragePoolListDisks: + id: StoragePoolListDisks type: object properties: kind: - description: Type of resource. - default: compute#urlMapList + description: >- + [Output Only] Type of resource. Always compute#storagePoolListDisks + for lists of disks in a storagePool. + default: compute#storagePoolListDisks type: string id: description: >- @@ -55674,10 +56932,10 @@ components: server. type: string items: - description: A list of UrlMap resources. + description: A list of StoragePoolDisk resources. type: array items: - $ref: '#/components/schemas/UrlMap' + $ref: '#/components/schemas/StoragePoolDisk' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -55753,6 +57011,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -55796,6 +57057,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -55818,6 +57080,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -55854,40 +57117,300 @@ components: [Output Only] A warning data value corresponding to the key. type: string - UrlMap: - id: UrlMap + etag: + type: string + unreachables: + description: >- + [Output Only] Unreachable resources. end_interface: + MixerListResponseWithEtagBuilder + type: array + items: + type: string + StoragePoolDisk: + id: StoragePoolDisk + type: object + properties: + disk: + description: '[Output Only] The URL of the disk.' + type: string + name: + description: '[Output Only] The name of the disk.' + type: string + status: + description: '[Output Only] The disk status.' + type: string + enumDescriptions: + - Disk is provisioning + - Disk is deleting. + - Disk creation failed. + - Disk is ready for use. + - Source data is being copied into the disk. + - >- + Disk is currently unavailable and cannot be accessed, attached or + detached. + enum: + - CREATING + - DELETING + - FAILED + - READY + - RESTORING + - UNAVAILABLE + type: + description: '[Output Only] The disk type.' + type: string + sizeGb: + description: '[Output Only] The disk size, in GB.' + type: string + format: int64 + provisionedIops: + description: '[Output Only] The number of IOPS provisioned for the disk.' + type: string + format: int64 + provisionedThroughput: + description: '[Output Only] The throughput provisioned for the disk.' + type: string + format: int64 + usedBytes: + description: '[Output Only] Amount of disk space used.' + type: string + format: int64 + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + attachedInstances: + description: '[Output Only] Instances this disk is attached to.' + type: array + items: + type: string + resourcePolicies: + description: >- + [Output Only] Resource policies applied to disk for automatic + snapshot creations. + type: array + items: + type: string + TargetGrpcProxyList: + id: TargetGrpcProxyList + type: object + properties: + kind: + description: >- + [Output Only] Type of the resource. Always compute#targetGrpcProxy + for target grpc proxies. + default: compute#targetGrpcProxyList + type: string + id: + description: >- + [Output Only] Unique identifier for the resource; defined by the + server. + type: string + items: + description: A list of TargetGrpcProxy resources. + type: array + items: + $ref: '#/components/schemas/TargetGrpcProxy' + nextPageToken: + description: >- + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. + type: string + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string + warning: + description: '[Output Only] Informational warning message.' + type: object + properties: + code: + description: >- + [Output Only] A warning code, if applicable. For example, + Compute Engine returns NO_RESULTS_ON_PAGE if there are no + results in the response. + type: string + enumDescriptions: + - >- + Warning about failed cleanup of transient changes made by a + failed operation. + - A link to a deprecated resource was created. + - >- + When deploying and at least one of the resources has a type + marked as deprecated + - The user created a boot disk that is larger than image size. + - >- + When deploying and at least one of the resources has a type + marked as experimental + - Warning that is present in an external api call + - >- + Warning that value of a field has been overridden. Deprecated + unused field. + - >- + The operation involved use of an injected kernel, which is + deprecated. + - >- + A WEIGHTED_MAGLEV backend service is associated with a health + check that is not of type HTTP/HTTPS/HTTP2. + - >- + When deploying a deployment with a exceedingly large number of + resources + - >- + Resource can't be retrieved due to list overhead quota exceed + which captures the amount of resources filtered out by + user-defined list filter. + - A resource depends on a missing type + - >- + The route's nextHopIp address is not assigned to an instance + on the network. + - The route's next hop instance cannot ip forward. + - >- + The route's nextHopInstance URL refers to an instance that + does not have an ipv6 interface on the same network as the + route. + - >- + The route's nextHopInstance URL refers to an instance that + does not exist. + - >- + The route's nextHopInstance URL refers to an instance that is + not on the same network as the route. + - >- + The route's next hop instance does not have a status of + RUNNING. + - >- + Error which is not critical. We decided to continue the + process despite the mentioned error. + - No results are present on a particular list page. + - >- + Success is reported, but some results may be missing due to + errors + - >- + Quota information is not available to client requests (e.g: + regions.list). + - >- + The user attempted to use a resource that requires a TOS they + have not accepted. + - Warning that a resource is in use. + - >- + One or more of the resources set to auto-delete could not be + deleted because they were in use. + - When a resource schema validation is ignored. + - >- + Instance template used in instance group manager is valid as + such, but its application does not make a lot of sense, + because it allows only single instance in instance group. + - When undeclared properties in the schema are present + - A given scope cannot be reached. + enumDeprecated: + - false + - false + - false + - false + - false + - false + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + enum: + - CLEANUP_FAILED + - DEPRECATED_RESOURCE_USED + - DEPRECATED_TYPE_USED + - DISK_SIZE_LARGER_THAN_IMAGE_SIZE + - EXPERIMENTAL_TYPE_USED + - EXTERNAL_API_WARNING + - FIELD_VALUE_OVERRIDEN + - INJECTED_KERNELS_DEPRECATED + - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB + - LARGE_DEPLOYMENT_WARNING + - LIST_OVERHEAD_QUOTA_EXCEED + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE + - NEXT_HOP_INSTANCE_NOT_FOUND + - NEXT_HOP_INSTANCE_NOT_ON_NETWORK + - NEXT_HOP_NOT_RUNNING + - NOT_CRITICAL_ERROR + - NO_RESULTS_ON_PAGE + - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE + - REQUIRED_TOS_AGREEMENT + - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING + - RESOURCE_NOT_DELETED + - SCHEMA_VALIDATION_IGNORED + - SINGLE_INSTANCE_PROPERTY_TEMPLATE + - UNDECLARED_PROPERTIES + - UNREACHABLE + message: + description: '[Output Only] A human-readable description of the warning code.' + type: string + data: + description: >- + [Output Only] Metadata about this warning in key: value format. + For example: "data": [ { "key": "scope", "value": + "zones/us-east1-d" } + type: array + items: + type: object + properties: + key: + description: >- + [Output Only] A key that provides more detail on the + warning being returned. For example, for warnings where + there are no results in a list request for a particular + zone, this key might be scope and the key value might be + the zone name. Other examples might be a key indicating a + deprecated resource and a suggested replacement, or a + warning about invalid network settings (for example, if an + instance attempts to perform IP forwarding but is not + enabled for IP forwarding). + type: string + value: + description: >- + [Output Only] A warning data value corresponding to the + key. + type: string + TargetGrpcProxy: + id: TargetGrpcProxy description: >- - Represents a URL Map resource. 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 cloud load balancers and - Traffic Director: * urlMaps are used by global external Application Load - Balancers, classic Application Load Balancers, and cross-region internal - Application Load Balancers. * regionUrlMaps are used by internal - Application Load Balancers, regional external Application Load Balancers - and regional internal Application Load Balancers. For a list of - supported URL map features by the 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 hostnames 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, - EXTERNAL_MANAGED, 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. + 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. type: object properties: kind: description: >- - [Output Only] Type of the resource. Always compute#urlMaps for url - maps. - default: compute#urlMap + [Output Only] Type of the resource. Always compute#targetGrpcProxy + for target grpc proxies. + default: compute#targetGrpcProxy type: string id: description: >- - [Output Only] The unique identifier for the resource. This - identifier is defined by the server. + [Output Only] The unique identifier for the resource type. The + server generates this identifier. type: string format: uint64 creationTimestamp: @@ -55903,6 +57426,9 @@ components: 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])?' + annotations: + required: + - compute.targetGrpcProxies.insert type: string description: description: >- @@ -55912,1288 +57438,1014 @@ components: selfLink: description: '[Output Only] Server-defined URL for the resource.' type: string - hostRules: - description: The list of host rules to use against the URL. - type: array - items: - $ref: '#/components/schemas/HostRule' - pathMatchers: - description: The list of named PathMatchers to use against the URL. - type: array - items: - $ref: '#/components/schemas/PathMatcher' - tests: - description: >- - The list of expected URL mapping tests. Request to update the UrlMap - succeeds only if all test cases pass. You can specify a maximum of - 100 tests per UrlMap. Not supported when the URL map is bound to a - target gRPC proxy that has validateForProxyless field set to true. - type: array - items: - $ref: '#/components/schemas/UrlMapTest' - 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 also specified, advanced routing actions, such - as URL rewrites, take effect before sending the request to the - backend. However, if defaultService is specified, defaultRouteAction - cannot contain any defaultRouteAction.weightedBackendServices. - Conversely, if defaultRouteAction specifies any - defaultRouteAction.weightedBackendServices, defaultService must not - be specified. If defaultService is specified, then set either - defaultUrlRedirect , or defaultRouteAction.weightedBackendService - Don't set both. defaultService has no effect when the URL map is - bound to a target gRPC proxy that has the validateForProxyless field - set to true. + selfLinkWithId: + description: '[Output Only] Server-defined URL with id for the resource.' type: string - defaultRouteAction: - description: >- - defaultRouteAction takes effect when none of the hostRules match. - The load balancer performs advanced routing actions, such as URL - rewrites and header transformations, before 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. URL maps for classic Application - Load Balancers only support the urlRewrite action within - defaultRouteAction. defaultRouteAction has no effect when the URL - map is bound to a target gRPC proxy that has the - validateForProxyless field set to true. - $ref: '#/components/schemas/HttpRouteAction' - defaultUrlRedirect: - 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 a target gRPC proxy. - $ref: '#/components/schemas/HttpRedirectAction' - headerAction: + urlMap: 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. - headerAction is not supported for load balancers that have their - loadBalancingScheme set to EXTERNAL. Not supported when the URL map - is bound to a target gRPC proxy that has validateForProxyless field - set to true. - $ref: '#/components/schemas/HttpHeaderAction' - defaultCustomErrorResponsePolicy: + 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: >- - defaultCustomErrorResponsePolicy specifies how the Load Balancer - returns error responses when BackendServiceor BackendBucket responds - with an error. This policy takes effect at the load balancer level - and applies only when no policy has been defined for the error code - at lower levels like PathMatcher, RouteRule and PathRule within this - UrlMap. For example, consider a UrlMap with the following - configuration: - defaultCustomErrorResponsePolicy containing - policies for responding to 5xx and 4xx errors - A PathMatcher - configured for *.example.com has defaultCustomErrorResponsePolicy - for 4xx. If a request for http://www.example.com/ encounters a 404, - the policy in pathMatcher.defaultCustomErrorResponsePolicy will be - enforced. When the request for http://www.example.com/ encounters a - 502, the policy in UrlMap.defaultCustomErrorResponsePolicy will be - enforced. When a request that does not match any host in - *.example.com such as http://www.myotherexample.com/, encounters a - 404, UrlMap.defaultCustomErrorResponsePolicy takes effect. When used - in conjunction with defaultRouteAction.retryPolicy, retries take - precedence. Only once all retries are exhausted, the - defaultCustomErrorResponsePolicy is applied. While attempting a - retry, if load balancer is successful in reaching the service, the - defaultCustomErrorResponsePolicy is ignored and the response from - the service is returned to the client. - defaultCustomErrorResponsePolicy is supported only for global - external Application Load Balancers. - $ref: '#/components/schemas/CustomErrorResponsePolicy' + 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 fingerprint: description: >- Fingerprint of this resource. A hash of the contents stored in this - object. This field is used in optimistic locking. This field is - 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. + 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. type: string format: byte - 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 - HostRule: - id: HostRule - description: >- - UrlMaps A host-matching rule for a URL. If matched, will use the named - PathMatcher to select the BackendService. + TargetHttpProxyList: + id: TargetHttpProxyList + description: A list of TargetHttpProxy resources. type: object properties: - description: + kind: description: >- - An optional description of this resource. Provide this property when - you create the resource. + Type of resource. Always compute#targetHttpProxyList for lists of + target HTTP proxies. + default: compute#targetHttpProxyList type: string - hosts: + id: 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 if followed by anything, the immediate following - character must be either - or .. * based matching is not supported - when the URL map is bound to a target gRPC proxy that has the - validateForProxyless field set to true. + [Output Only] Unique identifier for the resource; defined by the + server. + type: string + items: + description: A list of TargetHttpProxy resources. type: array items: - type: string - pathMatcher: + $ref: '#/components/schemas/TargetHttpProxy' + nextPageToken: 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. + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. type: string - PathMatcher: - id: 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 is used. - type: object - properties: - name: - description: The name to which this PathMatcher is referred by the HostRule. + selfLink: + description: '[Output Only] Server-defined URL for this resource.' type: string - description: - description: >- - An optional description of this resource. Provide this property when - you create the resource. + warning: + description: '[Output Only] Informational warning message.' + type: object + properties: + code: + description: >- + [Output Only] A warning code, if applicable. For example, + Compute Engine returns NO_RESULTS_ON_PAGE if there are no + results in the response. + type: string + enumDescriptions: + - >- + Warning about failed cleanup of transient changes made by a + failed operation. + - A link to a deprecated resource was created. + - >- + When deploying and at least one of the resources has a type + marked as deprecated + - The user created a boot disk that is larger than image size. + - >- + When deploying and at least one of the resources has a type + marked as experimental + - Warning that is present in an external api call + - >- + Warning that value of a field has been overridden. Deprecated + unused field. + - >- + The operation involved use of an injected kernel, which is + deprecated. + - >- + A WEIGHTED_MAGLEV backend service is associated with a health + check that is not of type HTTP/HTTPS/HTTP2. + - >- + When deploying a deployment with a exceedingly large number of + resources + - >- + Resource can't be retrieved due to list overhead quota exceed + which captures the amount of resources filtered out by + user-defined list filter. + - A resource depends on a missing type + - >- + The route's nextHopIp address is not assigned to an instance + on the network. + - The route's next hop instance cannot ip forward. + - >- + The route's nextHopInstance URL refers to an instance that + does not have an ipv6 interface on the same network as the + route. + - >- + The route's nextHopInstance URL refers to an instance that + does not exist. + - >- + The route's nextHopInstance URL refers to an instance that is + not on the same network as the route. + - >- + The route's next hop instance does not have a status of + RUNNING. + - >- + Error which is not critical. We decided to continue the + process despite the mentioned error. + - No results are present on a particular list page. + - >- + Success is reported, but some results may be missing due to + errors + - >- + Quota information is not available to client requests (e.g: + regions.list). + - >- + The user attempted to use a resource that requires a TOS they + have not accepted. + - Warning that a resource is in use. + - >- + One or more of the resources set to auto-delete could not be + deleted because they were in use. + - When a resource schema validation is ignored. + - >- + Instance template used in instance group manager is valid as + such, but its application does not make a lot of sense, + because it allows only single instance in instance group. + - When undeclared properties in the schema are present + - A given scope cannot be reached. + enumDeprecated: + - false + - false + - false + - false + - false + - false + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + enum: + - CLEANUP_FAILED + - DEPRECATED_RESOURCE_USED + - DEPRECATED_TYPE_USED + - DISK_SIZE_LARGER_THAN_IMAGE_SIZE + - EXPERIMENTAL_TYPE_USED + - EXTERNAL_API_WARNING + - FIELD_VALUE_OVERRIDEN + - INJECTED_KERNELS_DEPRECATED + - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB + - LARGE_DEPLOYMENT_WARNING + - LIST_OVERHEAD_QUOTA_EXCEED + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE + - NEXT_HOP_INSTANCE_NOT_FOUND + - NEXT_HOP_INSTANCE_NOT_ON_NETWORK + - NEXT_HOP_NOT_RUNNING + - NOT_CRITICAL_ERROR + - NO_RESULTS_ON_PAGE + - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE + - REQUIRED_TOS_AGREEMENT + - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING + - RESOURCE_NOT_DELETED + - SCHEMA_VALIDATION_IGNORED + - SINGLE_INSTANCE_PROPERTY_TEMPLATE + - UNDECLARED_PROPERTIES + - UNREACHABLE + message: + description: '[Output Only] A human-readable description of the warning code.' + type: string + data: + description: >- + [Output Only] Metadata about this warning in key: value format. + For example: "data": [ { "key": "scope", "value": + "zones/us-east1-d" } + type: array + items: + type: object + properties: + key: + description: >- + [Output Only] A key that provides more detail on the + warning being returned. For example, for warnings where + there are no results in a list request for a particular + zone, this key might be scope and the key value might be + the zone name. Other examples might be a key indicating a + deprecated resource and a suggested replacement, or a + warning about invalid network settings (for example, if an + instance attempts to perform IP forwarding but is not + enabled for IP forwarding). + type: string + value: + description: >- + [Output Only] A warning data value corresponding to the + key. + type: string + TargetHttpProxy: + id: 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 Google Cloud HTTP load balancers. * + targetHttpProxies are used by global external Application Load + Balancers, classic Application Load Balancers, cross-region internal + Application Load Balancers, and Traffic Director. * + regionTargetHttpProxies are used by regional internal Application Load + Balancers and regional external Application 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. + type: object + properties: + kind: + description: >- + [Output Only] Type of resource. Always compute#targetHttpProxy for + target HTTP proxies. + default: compute#targetHttpProxy type: string - defaultService: + id: description: >- - The full or partial URL to the BackendService resource. This URL is - 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 also - specified, advanced routing actions, such as URL rewrites, take - effect before 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. - If defaultService is specified, then set either defaultUrlRedirect - or defaultRouteAction.weightedBackendService. Don't set both. - Authorization requires one or more of the following Google IAM - permissions on the specified resource default_service: - - compute.backendBuckets.use - compute.backendServices.use + [Output Only] The unique identifier for the resource. This + identifier is defined by the server. type: string - defaultRouteAction: + format: uint64 + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + name: description: >- - defaultRouteAction takes effect when none of the pathRules or - routeRules match. The load balancer performs advanced routing - actions, such as URL rewrites and header transformations, before - 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. If - defaultRouteAction is specified, don't set defaultUrlRedirect. If - defaultRouteAction.weightedBackendServices is specified, don't set - defaultService. URL maps for classic Application Load Balancers only - support the urlRewrite action within a path matcher's - defaultRouteAction. - $ref: '#/components/schemas/HttpRouteAction' - defaultUrlRedirect: + 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 + description: description: >- - When none of the specified pathRules or routeRules match, the - request is redirected to a URL specified by defaultUrlRedirect. If - defaultUrlRedirect is specified, then set either defaultService or - defaultRouteAction. Don't set both. Not supported when the URL map - is bound to a target gRPC proxy. - $ref: '#/components/schemas/HttpRedirectAction' - pathRules: + An optional description of this resource. Provide this property when + you create the resource. + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + urlMap: 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. - type: array - items: - $ref: '#/components/schemas/PathRule' - routeRules: + URL to the UrlMap resource that defines the mapping from URL to the + BackendService. + type: string + region: 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. - type: array - items: - $ref: '#/components/schemas/HttpRouteRule' - headerAction: + [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 + proxyBind: description: >- - Specifies changes to request and response headers that need to take - effect for the selected backend service. HeaderAction specified here - are applied after the matching HttpRouteRule HeaderAction and before - the HeaderAction in the UrlMap HeaderAction is not supported for - load balancers that have their loadBalancingScheme set to EXTERNAL. - Not supported when the URL map is bound to a target gRPC proxy that - has validateForProxyless field set to true. - $ref: '#/components/schemas/HttpHeaderAction' - defaultCustomErrorResponsePolicy: + 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 + fingerprint: description: >- - defaultCustomErrorResponsePolicy specifies how the Load Balancer - returns error responses when BackendServiceor BackendBucket responds - with an error. This policy takes effect at the PathMatcher level and - applies only when no policy has been defined for the error code at - lower levels like RouteRule and PathRule within this PathMatcher. If - an error code does not have a policy defined in - defaultCustomErrorResponsePolicy, then a policy defined for the - error code in UrlMap.defaultCustomErrorResponsePolicy takes effect. - For example, consider a UrlMap with the following configuration: - - UrlMap.defaultCustomErrorResponsePolicy is configured with policies - for 5xx and 4xx errors - A RouteRule for /coming_soon/ is configured - for the error code 404. If the request is for www.myotherdomain.com - and a 404 is encountered, the policy under - UrlMap.defaultCustomErrorResponsePolicy takes effect. If a 404 - response is encountered for the request - www.example.com/current_events/, the pathMatcher's policy takes - effect. If however, the request for www.example.com/coming_soon/ - encounters a 404, the policy in RouteRule.customErrorResponsePolicy - takes effect. If any of the requests in this example encounter a 500 - error code, the policy at UrlMap.defaultCustomErrorResponsePolicy - takes effect. When used in conjunction with - pathMatcher.defaultRouteAction.retryPolicy, retries take precedence. - Only once all retries are exhausted, the - defaultCustomErrorResponsePolicy is applied. While attempting a - retry, if load balancer is successful in reaching the service, the - defaultCustomErrorResponsePolicy is ignored and the response from - the service is returned to the client. - defaultCustomErrorResponsePolicy is supported only for global - external Application Load Balancers. - $ref: '#/components/schemas/CustomErrorResponsePolicy' - HttpRouteAction: - id: HttpRouteAction + 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. + type: string + format: byte + httpKeepAliveTimeoutSec: + description: >- + Specifies how long to keep a connection open, after completing a + response, while there is no matching traffic (in seconds). If an + HTTP keep-alive is not specified, a default value (610 seconds) will + be used. For global external Application Load Balancers, the minimum + allowed value is 5 seconds and the maximum allowed value is 1200 + seconds. For classic Application Load Balancers, this option is not + supported. + type: integer + format: int32 + UrlMapReference: + id: UrlMapReference type: object properties: - 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. After a - backend service 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. - type: array - items: - $ref: '#/components/schemas/WeightedBackendService' - urlRewrite: - description: >- - The spec to modify the URL of the request, before forwarding the - request to the matched service. urlRewrite is the only action - supported in UrlMaps for classic Application Load Balancers. Not - supported when the URL map is bound to a target gRPC proxy that has - the validateForProxyless field set to true. - $ref: '#/components/schemas/UrlRewrite' - timeout: - description: >- - Specifies the timeout for the selected route. Timeout is computed - from the time the request has been fully processed (known as - *end-of-stream*) up until the response has been processed. Timeout - includes all retries. If not specified, this field uses the largest - timeout among all backend services associated with the route. Not - supported when the URL map is bound to a target gRPC proxy that has - validateForProxyless field set to true. - $ref: '#/components/schemas/Duration' - retryPolicy: - description: Specifies the retry policy associated with this route. - $ref: '#/components/schemas/HttpRetryPolicy' - requestMirrorPolicy: - description: >- - Specifies the policy on how requests intended for the route's - backends are shadowed to a separate mirrored backend service. The - load balancer does not wait for responses from the shadow service. - Before sending traffic to the shadow service, the host / authority - header is suffixed with -shadow. Not supported when the URL map is - bound to a target gRPC proxy that has the validateForProxyless field - set to true. - $ref: '#/components/schemas/RequestMirrorPolicy' - corsPolicy: - description: >- - The specification for allowing client-side cross-origin requests. - For more information about the W3C recommendation for cross-origin - resource sharing (CORS), see Fetch API Living Standard. Not - supported when the URL map is bound to a target gRPC proxy. - $ref: '#/components/schemas/CorsPolicy' - faultInjectionPolicy: - 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 a load balancer on a percentage of - requests before sending those requests to the backend service. - Similarly requests from clients can be aborted by the load balancer - for a percentage of requests. timeout and retry_policy is ignored by - clients that are configured with a fault_injection_policy if: 1. The - traffic is generated by fault injection AND 2. The fault injection - is not a delay fault injection. Fault injection is not supported - with the classic Application Load Balancer . To see which load - balancers support fault injection, see Load balancing: Routing and - traffic management features. - $ref: '#/components/schemas/HttpFaultInjection' - maxStreamDuration: - 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 (known as - *end-of-stream*), the duration in this field is computed from the - beginning of the stream until the response has been processed, - including all retries. A stream that does not complete in this - duration is closed. If not specified, this field uses the maximum - maxStreamDuration value 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. - $ref: '#/components/schemas/Duration' - WeightedBackendService: - id: 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 backend services. The volume of traffic for - each backend service is proportional to the weight specified in each - WeightedBackendService + urlMap: + type: string + TargetHttpProxyAggregatedList: + id: TargetHttpProxyAggregatedList type: object properties: - backendService: + kind: description: >- - The full or partial URL to the default BackendService resource. - Before forwarding the request to backendService, the load balancer - applies any relevant headerActions specified as part of this - backendServiceWeight. + [Output Only] Type of resource. Always + compute#targetHttpProxyAggregatedList for lists of Target HTTP + Proxies. + default: compute#targetHttpProxyAggregatedList type: string - weight: - description: >- - Specifies the fraction of traffic sent to a backend service, - 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 - backend service, subsequent requests are sent to the same backend - service as determined by the backend service's session affinity - policy. Don't configure session affinity if you're using weighted - traffic splitting. If you do, the weighted traffic splitting - configuration takes precedence. The value must be from 0 to 1000. - type: integer - format: uint32 - headerAction: + id: 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. headerAction is not supported for load - balancers that have their loadBalancingScheme set to EXTERNAL. Not - supported when the URL map is bound to a target gRPC proxy that has - validateForProxyless field set to true. - $ref: '#/components/schemas/HttpHeaderAction' - HttpHeaderAction: - id: HttpHeaderAction - description: >- - The request and response header transformations that take effect before - the request is passed along to the selected backendService. - type: object - properties: - requestHeadersToRemove: + [Output Only] Unique identifier for the resource; defined by the + server. + type: string + items: + description: A list of TargetHttpProxiesScopedList resources. + type: object + additionalProperties: + description: Name of the scope containing this set of TargetHttpProxies. + $ref: '#/components/schemas/TargetHttpProxiesScopedList' + nextPageToken: description: >- - A list of header names for headers that need to be removed from the - request before forwarding the request to the backendService. + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + 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.' type: array items: type: string - requestHeadersToAdd: - description: >- - Headers to add to a matching request before forwarding the request - to the backendService. + TargetHttpProxiesScopedList: + id: TargetHttpProxiesScopedList + type: object + properties: + targetHttpProxies: + description: A list of TargetHttpProxies contained in this scope. type: array items: - $ref: '#/components/schemas/HttpHeaderOption' - responseHeadersToRemove: + $ref: '#/components/schemas/TargetHttpProxy' + warning: description: >- - A list of header names for headers that need to be removed from the - response before sending the response back to the client. - type: array - items: - type: string - responseHeadersToAdd: - description: >- - Headers to add the response before sending the response back to the - client. - type: array - items: - $ref: '#/components/schemas/HttpHeaderOption' - HttpHeaderOption: - id: HttpHeaderOption - description: >- - Specification determining how headers are added to requests or - responses. + Informational warning which replaces the list of backend services + when the list is empty. + type: object + properties: + code: + description: >- + [Output Only] A warning code, if applicable. For example, + Compute Engine returns NO_RESULTS_ON_PAGE if there are no + results in the response. + type: string + enumDescriptions: + - >- + Warning about failed cleanup of transient changes made by a + failed operation. + - A link to a deprecated resource was created. + - >- + When deploying and at least one of the resources has a type + marked as deprecated + - The user created a boot disk that is larger than image size. + - >- + When deploying and at least one of the resources has a type + marked as experimental + - Warning that is present in an external api call + - >- + Warning that value of a field has been overridden. Deprecated + unused field. + - >- + The operation involved use of an injected kernel, which is + deprecated. + - >- + A WEIGHTED_MAGLEV backend service is associated with a health + check that is not of type HTTP/HTTPS/HTTP2. + - >- + When deploying a deployment with a exceedingly large number of + resources + - >- + Resource can't be retrieved due to list overhead quota exceed + which captures the amount of resources filtered out by + user-defined list filter. + - A resource depends on a missing type + - >- + The route's nextHopIp address is not assigned to an instance + on the network. + - The route's next hop instance cannot ip forward. + - >- + The route's nextHopInstance URL refers to an instance that + does not have an ipv6 interface on the same network as the + route. + - >- + The route's nextHopInstance URL refers to an instance that + does not exist. + - >- + The route's nextHopInstance URL refers to an instance that is + not on the same network as the route. + - >- + The route's next hop instance does not have a status of + RUNNING. + - >- + Error which is not critical. We decided to continue the + process despite the mentioned error. + - No results are present on a particular list page. + - >- + Success is reported, but some results may be missing due to + errors + - >- + Quota information is not available to client requests (e.g: + regions.list). + - >- + The user attempted to use a resource that requires a TOS they + have not accepted. + - Warning that a resource is in use. + - >- + One or more of the resources set to auto-delete could not be + deleted because they were in use. + - When a resource schema validation is ignored. + - >- + Instance template used in instance group manager is valid as + such, but its application does not make a lot of sense, + because it allows only single instance in instance group. + - When undeclared properties in the schema are present + - A given scope cannot be reached. + enumDeprecated: + - false + - false + - false + - false + - false + - false + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + enum: + - CLEANUP_FAILED + - DEPRECATED_RESOURCE_USED + - DEPRECATED_TYPE_USED + - DISK_SIZE_LARGER_THAN_IMAGE_SIZE + - EXPERIMENTAL_TYPE_USED + - EXTERNAL_API_WARNING + - FIELD_VALUE_OVERRIDEN + - INJECTED_KERNELS_DEPRECATED + - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB + - LARGE_DEPLOYMENT_WARNING + - LIST_OVERHEAD_QUOTA_EXCEED + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE + - NEXT_HOP_INSTANCE_NOT_FOUND + - NEXT_HOP_INSTANCE_NOT_ON_NETWORK + - NEXT_HOP_NOT_RUNNING + - NOT_CRITICAL_ERROR + - NO_RESULTS_ON_PAGE + - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE + - REQUIRED_TOS_AGREEMENT + - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING + - RESOURCE_NOT_DELETED + - SCHEMA_VALIDATION_IGNORED + - SINGLE_INSTANCE_PROPERTY_TEMPLATE + - UNDECLARED_PROPERTIES + - UNREACHABLE + message: + description: '[Output Only] A human-readable description of the warning code.' + type: string + data: + description: >- + [Output Only] Metadata about this warning in key: value format. + For example: "data": [ { "key": "scope", "value": + "zones/us-east1-d" } + type: array + items: + type: object + properties: + key: + description: >- + [Output Only] A key that provides more detail on the + warning being returned. For example, for warnings where + there are no results in a list request for a particular + zone, this key might be scope and the key value might be + the zone name. Other examples might be a key indicating a + deprecated resource and a suggested replacement, or a + warning about invalid network settings (for example, if an + instance attempts to perform IP forwarding but is not + enabled for IP forwarding). + type: string + value: + description: >- + [Output Only] A warning data value corresponding to the + key. + type: string + TargetHttpsProxyList: + id: TargetHttpsProxyList + description: Contains a list of TargetHttpsProxy resources. type: object properties: - headerName: - description: The name of the header. + kind: + description: >- + Type of resource. Always compute#targetHttpsProxyList for lists of + target HTTPS proxies. + default: compute#targetHttpsProxyList type: string - headerValue: - description: The value of the header to add. + id: + description: >- + [Output Only] Unique identifier for the resource; defined by the + server. type: string - replace: + items: + description: A list of TargetHttpsProxy resources. + type: array + items: + $ref: '#/components/schemas/TargetHttpsProxy' + nextPageToken: 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 - UrlRewrite: - id: UrlRewrite + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. + type: string + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string + warning: + description: '[Output Only] Informational warning message.' + type: object + properties: + code: + description: >- + [Output Only] A warning code, if applicable. For example, + Compute Engine returns NO_RESULTS_ON_PAGE if there are no + results in the response. + type: string + enumDescriptions: + - >- + Warning about failed cleanup of transient changes made by a + failed operation. + - A link to a deprecated resource was created. + - >- + When deploying and at least one of the resources has a type + marked as deprecated + - The user created a boot disk that is larger than image size. + - >- + When deploying and at least one of the resources has a type + marked as experimental + - Warning that is present in an external api call + - >- + Warning that value of a field has been overridden. Deprecated + unused field. + - >- + The operation involved use of an injected kernel, which is + deprecated. + - >- + A WEIGHTED_MAGLEV backend service is associated with a health + check that is not of type HTTP/HTTPS/HTTP2. + - >- + When deploying a deployment with a exceedingly large number of + resources + - >- + Resource can't be retrieved due to list overhead quota exceed + which captures the amount of resources filtered out by + user-defined list filter. + - A resource depends on a missing type + - >- + The route's nextHopIp address is not assigned to an instance + on the network. + - The route's next hop instance cannot ip forward. + - >- + The route's nextHopInstance URL refers to an instance that + does not have an ipv6 interface on the same network as the + route. + - >- + The route's nextHopInstance URL refers to an instance that + does not exist. + - >- + The route's nextHopInstance URL refers to an instance that is + not on the same network as the route. + - >- + The route's next hop instance does not have a status of + RUNNING. + - >- + Error which is not critical. We decided to continue the + process despite the mentioned error. + - No results are present on a particular list page. + - >- + Success is reported, but some results may be missing due to + errors + - >- + Quota information is not available to client requests (e.g: + regions.list). + - >- + The user attempted to use a resource that requires a TOS they + have not accepted. + - Warning that a resource is in use. + - >- + One or more of the resources set to auto-delete could not be + deleted because they were in use. + - When a resource schema validation is ignored. + - >- + Instance template used in instance group manager is valid as + such, but its application does not make a lot of sense, + because it allows only single instance in instance group. + - When undeclared properties in the schema are present + - A given scope cannot be reached. + enumDeprecated: + - false + - false + - false + - false + - false + - false + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + enum: + - CLEANUP_FAILED + - DEPRECATED_RESOURCE_USED + - DEPRECATED_TYPE_USED + - DISK_SIZE_LARGER_THAN_IMAGE_SIZE + - EXPERIMENTAL_TYPE_USED + - EXTERNAL_API_WARNING + - FIELD_VALUE_OVERRIDEN + - INJECTED_KERNELS_DEPRECATED + - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB + - LARGE_DEPLOYMENT_WARNING + - LIST_OVERHEAD_QUOTA_EXCEED + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE + - NEXT_HOP_INSTANCE_NOT_FOUND + - NEXT_HOP_INSTANCE_NOT_ON_NETWORK + - NEXT_HOP_NOT_RUNNING + - NOT_CRITICAL_ERROR + - NO_RESULTS_ON_PAGE + - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE + - REQUIRED_TOS_AGREEMENT + - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING + - RESOURCE_NOT_DELETED + - SCHEMA_VALIDATION_IGNORED + - SINGLE_INSTANCE_PROPERTY_TEMPLATE + - UNDECLARED_PROPERTIES + - UNREACHABLE + message: + description: '[Output Only] A human-readable description of the warning code.' + type: string + data: + description: >- + [Output Only] Metadata about this warning in key: value format. + For example: "data": [ { "key": "scope", "value": + "zones/us-east1-d" } + type: array + items: + type: object + properties: + key: + description: >- + [Output Only] A key that provides more detail on the + warning being returned. For example, for warnings where + there are no results in a list request for a particular + zone, this key might be scope and the key value might be + the zone name. Other examples might be a key indicating a + deprecated resource and a suggested replacement, or a + warning about invalid network settings (for example, if an + instance attempts to perform IP forwarding but is not + enabled for IP forwarding). + type: string + value: + description: >- + [Output Only] A warning data value corresponding to the + key. + type: string + TargetHttpsProxy: + id: TargetHttpsProxy description: >- - The spec for modifying the path before sending the request to the - matched backend service. + 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 Google Cloud HTTPS load balancers. + * targetHttpsProxies are used by global external Application Load + Balancers, classic Application Load Balancers, cross-region internal + Application Load Balancers, and Traffic Director. * + regionTargetHttpsProxies are used by regional internal Application Load + Balancers and regional external Application 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. type: object properties: - pathPrefixRewrite: + kind: description: >- - Before forwarding the request to the selected backend service, the - matching portion of the request's path is replaced by - pathPrefixRewrite. The value must be from 1 to 1024 characters. + [Output Only] Type of resource. Always compute#targetHttpsProxy for + target HTTPS proxies. + default: compute#targetHttpsProxy type: string - hostRewrite: + id: description: >- - Before forwarding the request to the selected service, the request's - host header is replaced with contents of hostRewrite. The value must - be from 1 to 255 characters. + [Output Only] The unique identifier for the resource. This + identifier is defined by the server. type: string - pathTemplateRewrite: - description: ' If specified, the pattern rewrites the URL path (based on the :path header) using the HTTP template syntax. A corresponding path_template_match must be specified. Any template variables must exist in the path_template_match field. - -At least one variable must be specified in the path_template_match field - You can omit variables from the rewritten URL - The * and ** operators cannot be matched unless they have a corresponding variable name - e.g. {format=*} or {var=**}. For example, a path_template_match of /static/{format=**} could be rewritten as /static/content/{format} to prefix /content to the URL. Variables can also be re-ordered in a rewrite, so that /{country}/{format}/{suffix=**} can be rewritten as /content/{format}/{country}/{suffix}. At least one non-empty routeRules[].matchRules[].path_template_match is required. Only one of path_prefix_rewrite or path_template_rewrite may be specified.' + format: uint64 + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' type: string - HttpRetryPolicy: - id: HttpRetryPolicy - description: The retry policy associates with HttpRouteRule - type: object - properties: - retryConditions: + name: description: >- - Specifies one or more conditions when this retry policy applies. - Valid values are: - 5xx: retry is attempted if the instance or - endpoint responds with any 5xx response code, or if the instance or - endpoint does not respond at all. For 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 is attempted on failures - connecting to the instance or endpoint. For example, connection - timeouts. - retriable-4xx: a retry is attempted if the instance or - endpoint responds with a 4xx response code. The only error that you - can retry is error code 409. - refused-stream: a retry is 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 is attempted if the gRPC status code in the - response header is set to cancelled. - deadline-exceeded: a retry is - attempted if the gRPC status code in the response header is set to - deadline-exceeded. - internal: a retry is attempted if the gRPC - status code in the response header is set to internal. - - resource-exhausted: a retry is attempted if the gRPC status code in - the response header is set to resource-exhausted. - unavailable: a - retry is attempted if the gRPC status code in the response header is - set to unavailable. Only the following codes are supported when the - URL map is bound to target gRPC proxy that has validateForProxyless - field set to true. - cancelled - deadline-exceeded - internal - - resource-exhausted - unavailable + 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 + description: + description: >- + An optional description of this resource. Provide this property when + you create the resource. + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + 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 + 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. SslCertificates do not apply when the + load balancing scheme is set to INTERNAL_SELF_MANAGED. The URLs + should refer to a SSL Certificate resource or Certificate Manager + Certificate resource. Mixing Classic Certificates and Certificate + Manager Certificates is not allowed. Certificate Manager + Certificates must include the certificatemanager API namespace. + Using Certificate Manager Certificates in this field is not + supported by Global external Application Load Balancer or Classic + Application Load Balancer, use certificate_map instead. Currently, + you may specify up to 15 Classic SSL Certificates or up to 100 + Certificate Manager Certificates. Certificate Manager Certificates + accepted formats are: - + //certificatemanager.googleapis.com/projects/{project}/locations/{ + location}/certificates/{resourceName}. - + https://certificatemanager.googleapis.com/v1alpha1/projects/{project + }/locations/{location}/certificates/{resourceName}. type: array items: type: string - numRetries: + certificateMap: description: >- - Specifies the allowed number retries. This number must be > 0. If - not specified, defaults to 1. - type: integer - format: uint32 - perTryTimeout: + URL of a certificate map that identifies a certificate map + associated with the given target proxy. This field can only be set + for Global external Application Load Balancer or Classic Application + Load Balancer. For other products use Certificate Manager + Certificates instead. If set, sslCertificates will be ignored. + Accepted format is + //certificatemanager.googleapis.com/projects/{project + }/locations/{location}/certificateMaps/{resourceName}. + type: string + quicOverride: description: >- - Specifies a non-zero timeout per retry attempt. If not specified, - will use the timeout set in the HttpRouteAction field. If timeout in - the HttpRouteAction field is not set, this field uses the largest - timeout among all backend services associated with the route. Not - supported when the URL map is bound to a target gRPC proxy that has - the validateForProxyless field set to true. - $ref: '#/components/schemas/Duration' - RequestMirrorPolicy: - id: RequestMirrorPolicy - description: >- - A policy that specifies how requests intended for the route's backends - are shadowed to a separate mirrored backend service. The load balancer - doesn't wait for responses from the shadow service. Before sending - traffic to the shadow service, the host or authority header is suffixed - with -shadow. - type: object - properties: - backendService: - description: >- - The full or partial URL to the BackendService resource being - mirrored to. The backend service configured for a mirroring policy - must reference backends that are of the same type as the original - backend service matched in the URL map. Serverless NEG backends are - not currently supported as a mirrored backend service. + 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. type: string - CorsPolicy: - id: CorsPolicy - description: >- - The specification for allowing client-side cross-origin requests. For - more information about the W3C recommendation for cross-origin resource - sharing (CORS), see Fetch API Living Standard. - type: object - properties: - allowOrigins: - description: >- - Specifies the list of origins that is allowed to do CORS requests. - An origin is allowed if it matches either an item in allowOrigins or - an item in allowOriginRegexes. - type: array - items: - type: string - allowOriginRegexes: - description: >- - Specifies a regular expression that matches allowed origins. For - more information, see regular expression syntax . An origin is - allowed if it matches either an item in allowOrigins or an item in - allowOriginRegexes. Regular expressions can only be used when the - loadBalancingScheme is set to INTERNAL_SELF_MANAGED. - type: array - items: - type: string - allowMethods: - description: Specifies the content for the Access-Control-Allow-Methods header. - type: array - items: - type: string - allowHeaders: - description: Specifies the content for the Access-Control-Allow-Headers header. - type: array - items: - type: string - exposeHeaders: - description: Specifies the content for the Access-Control-Expose-Headers header. - type: array - items: - type: string - maxAge: + enumDescriptions: + - The load balancer will not attempt to negotiate QUIC with clients. + - The load balancer will attempt to negotiate QUIC with clients. + - >- + No overrides to the default QUIC policy. This option is implicit + if no QUIC override has been specified in the request. + enum: + - DISABLE + - ENABLE + - NONE + sslPolicy: description: >- - Specifies how long results of a preflight request can be cached in - seconds. This field translates to the Access-Control-Max-Age header. - type: integer - format: int32 - allowCredentials: + 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 + region: description: >- - In response to a preflight request, setting this to true indicates - that the actual request can include user credentials. This field - translates to the Access-Control-Allow-Credentials header. Default - is false. - type: boolean - disabled: + [Output Only] URL of the region where the regional TargetHttpsProxy + resides. This field is not applicable to global TargetHttpsProxies. + type: string + proxyBind: description: >- - If true, disables the CORS policy. The default value is false, which - indicates that the CORS policy is in effect. + 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 - HttpFaultInjection: - id: 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 the load balancer on a percentage of requests before - sending those request to the backend service. Similarly requests from - clients can be aborted by the load balancer for a percentage of - requests. - type: object - properties: - delay: - description: >- - The specification for how client requests are delayed as part of - fault injection, before being sent to a backend service. - $ref: '#/components/schemas/HttpFaultDelay' - abort: - description: >- - The specification for how client requests are aborted as part of - fault injection. - $ref: '#/components/schemas/HttpFaultAbort' - HttpFaultDelay: - id: HttpFaultDelay - description: >- - Specifies the delay introduced by the load balancer before forwarding - the request to the backend service as part of fault injection. - type: object - properties: - fixedDelay: - description: Specifies the value of the fixed delay interval. - $ref: '#/components/schemas/Duration' - percentage: - description: >- - The percentage of traffic for connections, operations, or requests - for which a delay is introduced as part of fault injection. The - value must be from 0.0 to 100.0 inclusive. - type: number - format: double - HttpFaultAbort: - id: HttpFaultAbort - description: Specification for how requests are aborted as part of fault injection. - type: object - properties: - httpStatus: - description: >- - The HTTP status code used to abort the request. The value must be - from 200 to 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. - type: integer - format: uint32 - percentage: - description: >- - The percentage of traffic for connections, operations, or requests - that is aborted as part of fault injection. The value must be from - 0.0 to 100.0 inclusive. - type: number - format: double - HttpRedirectAction: - id: HttpRedirectAction - description: Specifies settings for an HTTP redirect. - type: object - properties: - hostRedirect: + serverTlsPolicy: description: >- - The host that is used in the redirect response instead of the one - that was supplied in the request. The value must be from 1 to 255 - characters. + 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 or EXTERNAL or EXTERNAL_MANAGED or + INTERNAL_MANAGED. It also applies to a regional TargetHttpsProxy + attached to regional forwardingRules with the loadBalancingScheme + set to EXTERNAL_MANAGED or INTERNAL_MANAGED. For details which + ServerTlsPolicy resources are accepted with INTERNAL_SELF_MANAGED + and which with EXTERNAL, INTERNAL_MANAGED, EXTERNAL_MANAGED + loadBalancingScheme consult ServerTlsPolicy documentation. If left + blank, communications are not encrypted. type: string - pathRedirect: + authorizationPolicy: description: >- - The path that is 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 is used for - the redirect. The value must be from 1 to 1024 characters. + 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 - prefixRedirect: + fingerprint: 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 is used for the - redirect. The value must be from 1 to 1024 characters. + 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. type: string - redirectResponseCode: + format: byte + httpKeepAliveTimeoutSec: 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 is retained. - - PERMANENT_REDIRECT, which corresponds to 308. In this case, the - request method is retained. + Specifies how long to keep a connection open, after completing a + response, while there is no matching traffic (in seconds). If an + HTTP keep-alive is not specified, a default value (610 seconds) will + be used. For global external Application Load Balancers, the minimum + allowed value is 5 seconds and the maximum allowed value is 1200 + seconds. For classic Application Load Balancers, this option is not + supported. + type: integer + format: int32 + tlsEarlyData: + description: ' Specifies whether TLS 1.3 0-RTT Data ("Early Data") should be accepted for this service. Early Data allows a TLS resumption handshake to include the initial application payload (a HTTP request) alongside the handshake, reducing the effective round trips to "zero". This applies to TLS 1.3 connections over TCP (HTTP/2) as well as over UDP (QUIC/h3). This can improve application performance, especially on networks where interruptions may be common, such as on mobile. Requests with Early Data will have the "Early-Data" HTTP header set on the request, with a value of "1", to allow the backend to determine whether Early Data was included. Note: TLS Early Data may allow requests to be replayed, as the data is sent to the backend before the handshake has fully completed. Applications that allow idempotent HTTP methods to make non-idempotent changes, such as a GET request updating a database, should not accept Early Data on those requests, and reject requests with the "Early-Data: 1" HTTP header by returning a HTTP 425 (Too Early) status code, in order to remain RFC compliant. The default value is DISABLED.' type: string enumDescriptions: - - Http Status Code 302 - Found. - - Http Status Code 301 - Moved Permanently. - - Http Status Code 308 - Permanent Redirect maintaining HTTP method. - - Http Status Code 303 - See Other. - - Http Status Code 307 - Temporary Redirect maintaining HTTP method. + - >- + TLS 1.3 Early Data is not advertised, and any (invalid) attempts + to send Early Data will be rejected by closing the connection. + - >- + This enables TLS 1.3 0-RTT, and only allows Early Data to be + included on requests with safe HTTP methods (GET, HEAD, OPTIONS, + TRACE). This mode does not enforce any other limitations for + requests with Early Data. The application owner should validate + that Early Data is acceptable for a given request path. + - >- + This enables TLS 1.3 0-RTT, and only allows Early Data to be + included on requests with safe HTTP methods (GET, HEAD, OPTIONS, + TRACE) without query parameters. Requests that send Early Data + with non-idempotent HTTP methods or with query parameters will be + rejected with a HTTP 425. + - >- + This enables TLS 1.3 Early Data for requests with any HTTP method + including non-idempotent methods list POST. This mode does not + enforce any other limitations. This may be valuable for gRPC use + cases. However, we do not recommend this method unless you have + evaluated your security stance and mitigated the risk of replay + attacks using other mechanisms. enum: - - FOUND - - MOVED_PERMANENTLY_DEFAULT - - PERMANENT_REDIRECT - - SEE_OTHER - - TEMPORARY_REDIRECT - 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 - remains the same as that of the request. This must only be set for - URL maps used in TargetHttpProxys. Setting this true for - TargetHttpsProxy is not permitted. The default is set to false. - type: boolean - stripQuery: - description: >- - If set to true, any accompanying query portion of the original URL - is removed before redirecting the request. If set to false, the - query portion of the original URL is retained. The default is set to - false. - type: boolean - PathRule: - id: PathRule - description: >- - A path-matching rule for a URL. If matched, will use the specified - BackendService to handle the traffic arriving at this URL. - type: object - properties: - 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 also - specified, advanced routing actions, such as URL rewrites, take - effect before sending the request to the backend. However, if - service is specified, routeAction cannot contain any - weightedBackendServices. Conversely, if routeAction specifies any - weightedBackendServices, service must not be specified. Only one of - urlRedirect, service or routeAction.weightedBackendService must be - set. - type: string - routeAction: - description: >- - In response to a matching path, the load balancer performs advanced - routing actions, such as URL rewrites and header transformations, - before 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. URL maps for classic Application Load Balancers only support - the urlRewrite action within a path rule's routeAction. - $ref: '#/components/schemas/HttpRouteAction' - urlRedirect: - 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 a target gRPC proxy. - $ref: '#/components/schemas/HttpRedirectAction' - 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. - type: array - items: - type: string - customErrorResponsePolicy: - description: >- - customErrorResponsePolicy specifies how the Load Balancer returns - error responses when BackendServiceor BackendBucket responds with an - error. If a policy for an error code is not configured for the - PathRule, a policy for the error code configured in - pathMatcher.defaultCustomErrorResponsePolicy is applied. If one is - not specified in pathMatcher.defaultCustomErrorResponsePolicy, the - policy configured in UrlMap.defaultCustomErrorResponsePolicy takes - effect. For example, consider a UrlMap with the following - configuration: - UrlMap.defaultCustomErrorResponsePolicy are - configured with policies for 5xx and 4xx errors - A PathRule for - /coming_soon/ is configured for the error code 404. If the request - is for www.myotherdomain.com and a 404 is encountered, the policy - under UrlMap.defaultCustomErrorResponsePolicy takes effect. If a 404 - response is encountered for the request - www.example.com/current_events/, the pathMatcher's policy takes - effect. If however, the request for www.example.com/coming_soon/ - encounters a 404, the policy in PathRule.customErrorResponsePolicy - takes effect. If any of the requests in this example encounter a 500 - error code, the policy at UrlMap.defaultCustomErrorResponsePolicy - takes effect. customErrorResponsePolicy is supported only for global - external Application Load Balancers. - $ref: '#/components/schemas/CustomErrorResponsePolicy' - CustomErrorResponsePolicy: - id: CustomErrorResponsePolicy - description: >- - Specifies the custom error response policy that must be applied when the - backend service or backend bucket responds with an error. + - DISABLED + - PERMISSIVE + - STRICT + - UNRESTRICTED + TargetHttpsProxyAggregatedList: + id: TargetHttpsProxyAggregatedList type: object properties: - errorResponseRules: - description: >- - Specifies rules for returning error responses. In a given policy, if - you specify rules for both a range of error codes as well as rules - for specific error codes then rules with specific error codes have a - higher priority. For example, assume that you configure a rule for - 401 (Un-authorized) code, and another for all 4 series error codes - (4XX). If the backend service returns a 401, then the rule for 401 - will be applied. However if the backend service returns a 403, the - rule for 4xx takes effect. - type: array - items: - $ref: >- - #/components/schemas/CustomErrorResponsePolicyCustomErrorResponseRule - errorService: + kind: description: >- - The full or partial URL to the BackendBucket resource that contains - the custom error content. Examples are: - - https://www.googleapis.com/compute/v1/projects/project/global/backendBuckets/myBackendBucket - - compute/v1/projects/project/global/backendBuckets/myBackendBucket - - global/backendBuckets/myBackendBucket If errorService is not - specified at lower levels like pathMatcher, pathRule and routeRule, - an errorService specified at a higher level in the UrlMap will be - used. If UrlMap.defaultCustomErrorResponsePolicy contains one or - more errorResponseRules[], it must specify errorService. If load - balancer cannot reach the backendBucket, a simple Not Found Error - will be returned, with the original response code (or - overrideResponseCode if configured). errorService is not supported - for internal or regional HTTP/HTTPS load balancers. + [Output Only] Type of resource. Always + compute#targetHttpsProxyAggregatedList for lists of Target HTTP + Proxies. + default: compute#targetHttpsProxyAggregatedList type: string - CustomErrorResponsePolicyCustomErrorResponseRule: - id: CustomErrorResponsePolicyCustomErrorResponseRule - description: >- - Specifies the mapping between the response code that will be returned - along with the custom error content and the response code returned by - the backend service. - type: object - properties: - matchResponseCodes: - description: >- - Valid values include: - A number between 400 and 599: For example - 401 or 503, in which case the load balancer applies the policy if - the error code exactly matches this value. - 5xx: Load Balancer will - apply the policy if the backend service responds with any response - code in the range of 500 to 599. - 4xx: Load Balancer will apply the - policy if the backend service responds with any response code in the - range of 400 to 499. Values must be unique within matchResponseCodes - and across all errorResponseRules of CustomErrorResponsePolicy. - type: array - items: - type: string - path: + id: description: >- - The full path to a file within backendBucket . For example: - /errors/defaultError.html path must start with a leading slash. path - cannot have trailing slashes. If the file is not available in - backendBucket or the load balancer cannot reach the BackendBucket, a - simple Not Found Error is returned to the client. The value must be - from 1 to 1024 characters + [Output Only] Unique identifier for the resource; defined by the + server. type: string - overrideResponseCode: - description: >- - The HTTP status code returned with the response containing the - custom error content. If overrideResponseCode is not supplied, the - same response code returned by the original backend bucket or - backend service is returned to the client. - type: integer - format: int32 - HttpRouteRule: - id: HttpRouteRule - description: >- - The HttpRouteRule setting specifies how to match an HTTP request and the - corresponding routing action that load balancing proxies perform. - type: object - properties: - priority: - description: >- - For routeRules within a given pathMatcher, priority determines the - order in which a load balancer interprets 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 from 0 to 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. - type: integer - format: int32 - description: + items: + description: A list of TargetHttpsProxiesScopedList resources. + type: object + additionalProperties: + description: Name of the scope containing this set of TargetHttpsProxies. + $ref: '#/components/schemas/TargetHttpsProxiesScopedList' + nextPageToken: description: >- - The short description conveying the intent of this routeRule. The - description can have a maximum length of 1024 characters. + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. type: string - 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. - type: array - items: - $ref: '#/components/schemas/HttpRouteRuleMatch' - 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 also - specified, advanced routing actions, such as URL rewrites, take - effect before sending the request to the backend. However, if - service is specified, routeAction cannot contain any - weightedBackendServices. Conversely, if routeAction specifies any - weightedBackendServices, service must not be specified. Only one of - urlRedirect, service or routeAction.weightedBackendService must be - set. - type: string - routeAction: - description: >- - In response to a matching matchRule, the load balancer performs - advanced routing actions, such as URL rewrites and header - transformations, before 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. URL maps - for classic Application Load Balancers only support the urlRewrite - action within a route rule's routeAction. - $ref: '#/components/schemas/HttpRouteAction' - urlRedirect: - 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 a target gRPC proxy. - $ref: '#/components/schemas/HttpRedirectAction' - headerAction: - description: >- - Specifies changes to request and response headers that need to take - effect for the selected backendService. The headerAction value - specified here is applied before the matching - pathMatchers[].headerAction and after - pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction - HeaderAction is not supported for load balancers that have their - loadBalancingScheme set to EXTERNAL. Not supported when the URL map - is bound to a target gRPC proxy that has validateForProxyless field - set to true. - $ref: '#/components/schemas/HttpHeaderAction' - customErrorResponsePolicy: - description: >- - customErrorResponsePolicy specifies how the Load Balancer returns - error responses when BackendServiceor BackendBucket responds with an - error. If a policy for an error code is not configured for the - RouteRule, a policy for the error code configured in - pathMatcher.defaultCustomErrorResponsePolicy is applied. If one is - not specified in pathMatcher.defaultCustomErrorResponsePolicy, the - policy configured in UrlMap.defaultCustomErrorResponsePolicy takes - effect. For example, consider a UrlMap with the following - configuration: - UrlMap.defaultCustomErrorResponsePolicy are - configured with policies for 5xx and 4xx errors - A RouteRule for - /coming_soon/ is configured for the error code 404. If the request - is for www.myotherdomain.com and a 404 is encountered, the policy - under UrlMap.defaultCustomErrorResponsePolicy takes effect. If a 404 - response is encountered for the request - www.example.com/current_events/, the pathMatcher's policy takes - effect. If however, the request for www.example.com/coming_soon/ - encounters a 404, the policy in RouteRule.customErrorResponsePolicy - takes effect. If any of the requests in this example encounter a 500 - error code, the policy at UrlMap.defaultCustomErrorResponsePolicy - takes effect. When used in conjunction with - routeRules.routeAction.retryPolicy, retries take precedence. Only - once all retries are exhausted, the customErrorResponsePolicy is - applied. While attempting a retry, if load balancer is successful in - reaching the service, the customErrorResponsePolicy is ignored and - the response from the service is returned to the client. - customErrorResponsePolicy is supported only for global external - Application Load Balancers. - $ref: '#/components/schemas/CustomErrorResponsePolicy' - HttpRouteRuleMatch: - id: 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. - type: object - properties: - 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 from 1 to 1024 characters. Only one of - prefixMatch, fullPathMatch or regexMatch must be specified. - type: string - 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 from 1 to 1024 characters. Only one of - prefixMatch, fullPathMatch or regexMatch must be specified. - type: string - 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 more information about regular expression syntax, see - Syntax. Only one of prefixMatch, fullPathMatch or regexMatch must be - specified. Regular expressions can only be used when the - loadBalancingScheme is set to INTERNAL_SELF_MANAGED. - type: string - 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 a target - gRPC proxy. - type: boolean - headerMatches: - description: >- - Specifies a list of header match criteria, all of which must match - corresponding headers in the request. - type: array - items: - $ref: '#/components/schemas/HttpHeaderMatch' - 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 a target gRPC proxy. - type: array - items: - $ref: '#/components/schemas/HttpQueryParameterMatch' - metadataFilters: - description: >- - Opaque filter criteria used by the load balancer to restrict routing - configuration to a limited set of xDS compliant clients. In their - xDS requests to the load balancer, 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 metadata filters are - specified, all of them need to be satisfied in order to be - considered a match. metadataFilters specified here is applied after - those specified in ForwardingRule that refers to the UrlMap this - HttpRouteRuleMatch belongs to. metadataFilters only applies to load - balancers that have loadBalancingScheme set to - INTERNAL_SELF_MANAGED. Not supported when the URL map is bound to a - target gRPC proxy that has validateForProxyless field set to true. - type: array - items: - $ref: '#/components/schemas/MetadataFilter' - pathTemplateMatch: - description: >- - If specified, the route is a pattern match expression that must - match the :path header once the query string is removed. A pattern - match allows you to match - The value must be between 1 and 1024 - characters - The pattern must start with a leading slash ("/") - - There may be no more than 5 operators in pattern Precisely one of - prefix_match, full_path_match, regex_match or path_template_match - must be set. - type: string - HttpHeaderMatch: - id: HttpHeaderMatch - description: matchRule criteria for request header matches. - type: object - properties: - 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 a target gRPC proxy that has - the 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 - 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 - regexMatch: - description: >- - The value of the header must match the regular expression specified - in regexMatch. For more information about regular expression syntax, - see 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. Regular expressions can only - be used when the loadBalancingScheme is set to - INTERNAL_SELF_MANAGED. - type: string - rangeMatch: - 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. rangeMatch is not supported for load balancers that - have loadBalancingScheme set to EXTERNAL. - $ref: '#/components/schemas/Int64RangeMatch' - 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 - 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 - 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 - invertMatch: - description: >- - If set to false, the headerMatch is considered a match if the - preceding match criteria are met. If set to true, the headerMatch is - considered a match if the preceding match criteria are NOT met. The - default setting is false. - type: boolean - Int64RangeMatch: - id: Int64RangeMatch - description: >- - HttpRouteRuleMatch criteria for field values that must stay within the - specified integer range. - type: object - properties: - rangeStart: - description: The start of the range (inclusive) in signed long integer format. - type: string - format: int64 - rangeEnd: - description: The end of the range (exclusive) in signed long integer format. - type: string - format: int64 - HttpQueryParameterMatch: - id: HttpQueryParameterMatch - description: HttpRouteRuleMatch criteria for a request's query parameter. - type: object - properties: - 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 - 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 - regexMatch: - description: >- - The queryParameterMatch matches if the value of the parameter - matches the regular expression specified by regexMatch. For more - information about regular expression syntax, see Syntax. Only one of - presentMatch, exactMatch, or regexMatch must be set. Regular - expressions can only be used when the loadBalancingScheme is set to - INTERNAL_SELF_MANAGED. - type: string - UrlMapTest: - id: UrlMapTest - description: Message for the expected URL mappings. - type: object - properties: - description: - description: Description of this test case. - type: string - 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 - headers: - description: >- - HTTP headers for this request. If headers contains a host header, - then host must also match the header value. - type: array - items: - $ref: '#/components/schemas/UrlMapTestHeader' - service: - description: >- - Expected BackendService or BackendBucket resource the given URL - should be mapped to. The service field cannot be set if - expectedRedirectResponseCode is set. - type: string - expectedOutputUrl: - description: >- - The expected output URL evaluated by the 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 the 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. - type: integer - format: int32 - UrlMapTestHeader: - id: UrlMapTestHeader - description: HTTP headers used in UrlMapTests. - type: object - properties: - name: - description: Header name. - type: string - value: - description: Header value. - type: string - UrlMapsAggregatedList: - id: UrlMapsAggregatedList - type: object - properties: - kind: - description: Type of resource. - default: compute#urlMapsAggregatedList - type: string - id: - description: >- - [Output Only] Unique identifier for the resource; defined by the - server. - type: string - items: - description: A list of UrlMapsScopedList resources. - type: object - additionalProperties: - description: Name of the scope containing this set of UrlMaps. - $ref: '#/components/schemas/UrlMapsScopedList' - nextPageToken: - description: >- - [Output Only] This token allows you to get the next page of results - for list requests. If the number of results is larger than - maxResults, use the nextPageToken as a value for the query parameter - pageToken in the next list request. Subsequent list requests will - have their own nextPageToken to continue paging through the results. - type: string - selfLink: - description: '[Output Only] Server-defined URL for this resource.' + selfLink: + description: '[Output Only] Server-defined URL for this resource.' type: string warning: description: '[Output Only] Informational warning message.' @@ -57259,6 +58511,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -57302,6 +58557,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -57324,6 +58580,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -57365,15 +58622,15 @@ components: type: array items: type: string - UrlMapsScopedList: - id: UrlMapsScopedList + TargetHttpsProxiesScopedList: + id: TargetHttpsProxiesScopedList type: object properties: - urlMaps: - description: A list of UrlMaps contained in this scope. + targetHttpsProxies: + description: A list of TargetHttpsProxies contained in this scope. type: array items: - $ref: '#/components/schemas/UrlMap' + $ref: '#/components/schemas/TargetHttpsProxy' warning: description: >- Informational warning which replaces the list of backend services @@ -57440,6 +58697,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -57483,6 +58743,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -57505,6 +58766,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -57541,149 +58803,74 @@ components: [Output Only] A warning data value corresponding to the key. type: string - UrlMapsValidateRequest: - id: UrlMapsValidateRequest + TargetHttpsProxiesSetSslCertificatesRequest: + id: TargetHttpsProxiesSetSslCertificatesRequest type: object properties: - resource: - description: Content of the UrlMap to be validated. - $ref: '#/components/schemas/UrlMap' - loadBalancingSchemes: + sslCertificates: description: >- - Specifies the load balancer type(s) this validation request is for. - Use EXTERNAL_MANAGED for global external Application Load Balancers - and regional external Application Load Balancers. Use EXTERNAL for - classic Application Load Balancers. Use INTERNAL_MANAGED for - internal Application Load Balancers. For more information, refer to - Choosing a load balancer. If unspecified, the load balancing scheme - will be inferred from the backend service resources this URL map - references. If that can not be inferred (for example, this URL map - only references backend buckets, or this Url map is for rewrites and - redirects only and doesn't reference any backends), EXTERNAL will be - used as the default type. If specified, the scheme(s) must not - conflict with the load balancing scheme of the backend service - resources this Url map references. + 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. type: array items: type: string - enumDescriptions: - - >- - Signifies that this will be used for classic Application Load - Balancers. - - >- - Signifies that this will be used for Envoy-based global external - Application Load Balancers. - - >- - If unspecified, the validation will try to infer the scheme from - the backend service resources this Url map references. If the - inference is not possible, EXTERNAL will be used as the default - type. - enum: - - EXTERNAL - - EXTERNAL_MANAGED - - LOAD_BALANCING_SCHEME_UNSPECIFIED - UrlMapsValidateResponse: - id: UrlMapsValidateResponse - type: object - properties: - result: - $ref: '#/components/schemas/UrlMapValidationResult' - UrlMapValidationResult: - id: UrlMapValidationResult - description: Message representing the validation result for a UrlMap. + TargetHttpsProxiesSetCertificateMapRequest: + id: TargetHttpsProxiesSetCertificateMapRequest type: object properties: - loadSucceeded: - description: >- - Whether the given UrlMap can be successfully loaded. If false, - 'loadErrors' indicates the reasons. - type: boolean - loadErrors: - type: array - items: - type: string - testPassed: + certificateMap: description: >- - If successfully loaded, this field indicates whether the test - passed. If false, 'testFailures's indicate the reason of failure. - type: boolean - testFailures: - type: array - items: - $ref: '#/components/schemas/TestFailure' - TestFailure: - id: TestFailure + URL of the Certificate Map to associate with this TargetHttpsProxy. + Accepted format is + //certificatemanager.googleapis.com/projects/{project + }/locations/{location}/certificateMaps/{resourceName}. + type: string + SslPolicyReference: + id: SslPolicyReference type: object properties: - host: - description: Host portion of the URL. - type: string - path: - description: Path portion including query parameters in the URL. - type: string - headers: - description: HTTP headers of the request. - type: array - items: - $ref: '#/components/schemas/UrlMapTestHeader' - expectedService: - description: >- - Expected BackendService or BackendBucket resource the given URL - should be mapped to. - type: string - actualService: - description: BackendService or BackendBucket returned by load balancer. - type: string - expectedOutputUrl: - description: >- - The expected output URL evaluated by a load balancer containing the - scheme, host, path and query parameters. - type: string - actualOutputUrl: + sslPolicy: description: >- - The actual output URL evaluated by a load balancer containing the - scheme, host, path and query parameters. + 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 - expectedRedirectResponseCode: - description: >- - Expected HTTP status code for rule with `urlRedirect` calculated by - load balancer - type: integer - format: int32 - actualRedirectResponseCode: - description: >- - Actual HTTP status code for rule with `urlRedirect` calculated by - load balancer - type: integer - format: int32 - CacheInvalidationRule: - id: CacheInvalidationRule + TargetHttpsProxiesSetQuicOverrideRequest: + id: TargetHttpsProxiesSetQuicOverrideRequest type: object properties: - path: - type: string - host: - description: >- - If set, this invalidation rule will only apply to requests with a - Host header matching host. + quicOverride: + description: QUIC policy for the TargetHttpsProxy resource. type: string - RegionUrlMapsValidateRequest: - id: RegionUrlMapsValidateRequest + enumDescriptions: + - The load balancer will not attempt to negotiate QUIC with clients. + - The load balancer will attempt to negotiate QUIC with clients. + - >- + No overrides to the default QUIC policy. This option is implicit + if no QUIC override has been specified in the request. + enum: + - DISABLE + - ENABLE + - NONE + RegionTargetHttpsProxiesSetSslCertificatesRequest: + id: RegionTargetHttpsProxiesSetSslCertificatesRequest type: object properties: - resource: - description: Content of the UrlMap to be validated. - $ref: '#/components/schemas/UrlMap' - VpnGatewayList: - id: VpnGatewayList - description: Contains a list of VpnGateway resources. + sslCertificates: + description: >- + New set of SslCertificate resources to associate with this + TargetHttpsProxy resource. + type: array + items: + type: string + TargetInstanceList: + id: TargetInstanceList + description: Contains a list of TargetInstance resources. type: object properties: kind: - description: >- - [Output Only] Type of resource. Always compute#vpnGateway for VPN - gateways. - default: compute#vpnGatewayList + description: Type of resource. + default: compute#targetInstanceList type: string id: description: >- @@ -57691,10 +58878,10 @@ components: server. type: string items: - description: A list of VpnGateway resources. + description: A list of TargetInstance resources. type: array items: - $ref: '#/components/schemas/VpnGateway' + $ref: '#/components/schemas/TargetInstance' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -57770,6 +58957,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -57813,6 +59003,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -57835,6 +59026,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -57871,21 +59063,21 @@ components: [Output Only] A warning data value corresponding to the key. type: string - VpnGateway: - id: VpnGateway + TargetInstance: + id: TargetInstance 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 . + 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. type: object properties: kind: description: >- - [Output Only] Type of resource. Always compute#vpnGateway for VPN - gateways. - default: compute#vpnGateway + [Output Only] The type of the resource. Always + compute#targetInstance for target instances. + default: compute#targetInstance type: string id: description: >- @@ -57906,127 +59098,59 @@ components: 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])?' - annotations: - required: - - compute.vpnGateways.insert type: string description: description: >- An optional description of this resource. Provide this property when you create the resource. type: string - region: - description: '[Output Only] URL of the region where the VPN gateway resides.' - 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. - annotations: - required: - - compute.vpnGateways.insert - type: string - selfLink: - description: '[Output Only] Server-defined URL for the resource.' - type: string - labels: - 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 - additionalProperties: - type: string - labelFingerprint: + zone: 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 a VpnGateway. + [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 - format: byte - vpnInterfaces: - description: The list of VPN interfaces associated with this VPN gateway. - type: array - items: - $ref: '#/components/schemas/VpnGatewayVpnGatewayInterface' - stackType: + natPolicy: description: >- - The stack type for this VPN gateway to identify the IP protocols - that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6, - IPV6_ONLY. If not specified, IPV4_ONLY is used if the gateway IP - version is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6. + Must have a value of NO_NAT. Protocol forwarding delivers packets + while preserving the destination IP address of the forwarding rule + referencing the target instance. type: string enumDescriptions: - - Enable VPN gateway with both IPv4 and IPv6 protocols. - - Enable VPN gateway with only IPv4 protocol. - - Enable VPN gateway with only IPv6 protocol. + - No NAT performed. enum: - - IPV4_IPV6 - - IPV4_ONLY - - IPV6_ONLY - gatewayIpVersion: + - NO_NAT + instance: description: >- - The IP family of the gateway IPs for the HA-VPN gateway interfaces. - If not specified, IPV4 will be used. + 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 - enumDescriptions: - - Every HA-VPN gateway interface is configured with an IPv4 address. - - Every HA-VPN gateway interface is configured with an IPv6 address. - enum: - - IPV4 - - IPV6 - VpnGatewayVpnGatewayInterface: - id: VpnGatewayVpnGatewayInterface - description: A VPN gateway interface. - type: object - properties: - id: - description: >- - [Output Only] Numeric identifier for this VPN interface associated - with the VPN gateway. - type: integer - format: uint32 - 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 HA VPN over Cloud - Interconnect, the IP addresses for both interfaces could either be - regional internal IP addresses or regional external IP addresses. - For regular (non HA VPN over Cloud Interconnect) HA VPN tunnels, the - IP address must be a regional external IP address. + selfLink: + description: '[Output Only] Server-defined URL for the resource.' type: string - ipv6Address: + network: description: >- - [Output Only] IPv6 address for this VPN interface associated with - the VPN gateway. The IPv6 address must be a regional external IPv6 - address. The format is RFC 5952 format (e.g. 2001:db8::2d9:51:0:0). + 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 - interconnectAttachment: + securityPolicy: 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 HA VPN over Cloud Interconnect; all - egress or ingress traffic for this VPN gateway interface goes - through the specified VLAN attachment resource. + [Output Only] The resource URL for the security policy associated + with this target instance. type: string - VpnGatewayAggregatedList: - id: VpnGatewayAggregatedList + TargetInstanceAggregatedList: + id: TargetInstanceAggregatedList type: object properties: kind: - description: >- - [Output Only] Type of resource. Always compute#vpnGateway for VPN - gateways. - default: compute#vpnGatewayAggregatedList + description: Type of resource. + default: compute#targetInstanceAggregatedList type: string id: description: >- @@ -58034,13 +59158,11 @@ components: server. type: string items: - description: A list of VpnGateway resources. + description: A list of TargetInstance resources. type: object additionalProperties: - description: >- - [Output Only] Name of the scope containing this set of VPN - gateways. - $ref: '#/components/schemas/VpnGatewaysScopedList' + description: Name of the scope containing this set of target instances. + $ref: '#/components/schemas/TargetInstancesScopedList' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -58116,6 +59238,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -58159,6 +59284,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -58181,6 +59307,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -58222,19 +59349,19 @@ components: type: array items: type: string - VpnGatewaysScopedList: - id: VpnGatewaysScopedList + TargetInstancesScopedList: + id: TargetInstancesScopedList type: object properties: - vpnGateways: - description: '[Output Only] A list of VPN gateways contained in this scope.' + targetInstances: + description: A list of target instances contained in this scope. type: array items: - $ref: '#/components/schemas/VpnGateway' + $ref: '#/components/schemas/TargetInstance' warning: description: >- - [Output Only] Informational warning which replaces the list of - addresses when the list is empty. + Informational warning which replaces the list of addresses when the + list is empty. type: object properties: code: @@ -58297,6 +59424,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -58340,6 +59470,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -58362,6 +59493,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -58398,117 +59530,16 @@ components: [Output Only] A warning data value corresponding to the key. type: string - VpnGatewaysGetStatusResponse: - id: VpnGatewaysGetStatusResponse - type: object - properties: - result: - $ref: '#/components/schemas/VpnGatewayStatus' - VpnGatewayStatus: - id: VpnGatewayStatus - type: object - properties: - vpnConnections: - description: List of VPN connection for this VpnGateway. - type: array - items: - $ref: '#/components/schemas/VpnGatewayStatusVpnConnection' - VpnGatewayStatusVpnConnection: - id: VpnGatewayStatusVpnConnection - description: >- - A VPN connection contains all VPN tunnels connected from this VpnGateway - to the same peer gateway. The peer gateway could either be an external - VPN gateway or a Google Cloud VPN gateway. - type: object - 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 - tunnels: - description: List of VPN tunnels that are in this VPN connection. - type: array - items: - $ref: '#/components/schemas/VpnGatewayStatusTunnel' - state: - description: HighAvailabilityRequirementState for the VPN connection. - $ref: >- - #/components/schemas/VpnGatewayStatusHighAvailabilityRequirementState - VpnGatewayStatusTunnel: - id: VpnGatewayStatusTunnel - description: Contains some information about a VPN tunnel. - type: object - properties: - localGatewayInterface: - description: The VPN gateway interface this VPN tunnel is associated with. - type: integer - format: uint32 - peerGatewayInterface: - description: >- - The peer gateway interface this VPN tunnel is connected to, the peer - gateway could either be an external VPN gateway or a Google Cloud - VPN gateway. - type: integer - format: uint32 - tunnelUrl: - description: URL reference to the VPN tunnel. - type: string - VpnGatewayStatusHighAvailabilityRequirementState: - id: VpnGatewayStatusHighAvailabilityRequirementState - description: >- - Describes the high availability requirement state for the VPN connection - between this Cloud VPN gateway and a peer gateway. - type: object - properties: - state: - description: >- - Indicates the high availability requirement state for the VPN - connection. Valid values are CONNECTION_REDUNDANCY_MET, - CONNECTION_REDUNDANCY_NOT_MET. - type: string - enumDescriptions: - - >- - VPN tunnels are configured with adequate redundancy from Cloud VPN - gateway to the peer VPN gateway. For both GCP-to-non-GCP and - GCP-to-GCP connections, the adequate redundancy is a - pre-requirement for users to get 99.99% availability on GCP side; - please note that for any connection, end-to-end 99.99% - availability is subject to proper configuration on the peer VPN - gateway. - - >- - VPN tunnels are not configured with adequate redundancy from the - Cloud VPN gateway to the peer gateway - enum: - - CONNECTION_REDUNDANCY_MET - - CONNECTION_REDUNDANCY_NOT_MET - unsatisfiedReason: - description: >- - Indicates the reason why the VPN connection does not meet the high - availability redundancy criteria/requirement. Valid values is - INCOMPLETE_TUNNELS_COVERAGE. - type: string - enumDescriptions: - - '' - enum: - - INCOMPLETE_TUNNELS_COVERAGE - VpnTunnelList: - id: VpnTunnelList - description: Contains a list of VpnTunnel resources. + TargetPoolList: + id: TargetPoolList + description: Contains a list of TargetPool resources. type: object properties: kind: description: >- - [Output Only] Type of resource. Always compute#vpnTunnel for VPN - tunnels. - default: compute#vpnTunnelList + [Output Only] Type of resource. Always compute#targetPoolList for + lists of target pools. + default: compute#targetPoolList type: string id: description: >- @@ -58516,10 +59547,10 @@ components: server. type: string items: - description: A list of VpnTunnel resources. + description: A list of TargetPool resources. type: array items: - $ref: '#/components/schemas/VpnTunnel' + $ref: '#/components/schemas/TargetPool' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -58595,6 +59626,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -58638,6 +59672,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -58660,6 +59695,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -58696,18 +59732,21 @@ components: [Output Only] A warning data value corresponding to the key. type: string - VpnTunnel: - id: VpnTunnel + TargetPool: + id: TargetPool description: >- - Represents a Cloud VPN Tunnel resource. For more information about VPN, - read the the Cloud VPN Overview. + Represents a Target Pool resource. Target pools are used with external + passthrough Network Load Balancers. A target pool references member + instances, an associated legacy HttpHealthCheck resource, and, + optionally, a backup target pool. For more information, read Using + target pools. type: object properties: kind: description: >- - [Output Only] Type of resource. Always compute#vpnTunnel for VPN - tunnels. - default: compute#vpnTunnel + [Output Only] Type of the resource. Always compute#targetPool for + target pools. + default: compute#targetPool type: string id: description: >- @@ -58728,9 +59767,6 @@ components: 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])?' - annotations: - required: - - compute.vpnTunnels.insert type: string description: description: >- @@ -58738,191 +59774,131 @@ components: you create the resource. 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 - 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. - This field can be set only for Classic VPN tunnels. - 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. Possible values are: `0`, `1`. - type: integer - format: int32 - 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. Possible values are: `0`, `1`, `2`, `3`. The number of IDs - in use depends on the external VPN gateway redundancy type. - type: integer - format: int32 - peerGcpGateway: - description: >- - URL of the peer side HA 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 Google Cloud VPN - gateway. - type: string - router: - description: URL of the router resource to be used for dynamic routing. + description: '[Output Only] URL of the region where the target pool resides.' type: string - peerIp: + healthChecks: description: >- - IP address of the peer VPN gateway. Only IPv4 is supported. This - field can be set only for Classic VPN tunnels. - type: string - sharedSecret: + 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. + type: array + items: + type: string + instances: 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: + 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. + type: array + items: + type: string + sessionAffinity: 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. + 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. type: string enumDescriptions: - >- - Cloud VPN is in the process of allocating all required resources - (specifically, a borg task). - - Auth error (e.g. bad shared secret). - - Resources is being deallocated for the VPN tunnel. - - Secure session is successfully established with peer VPN. - - Tunnel creation has failed and the tunnel is not ready to be used. - - Successful first handshake with peer VPN. - - Handshake failed. - - Deprecated, replaced by NO_INCOMING_PACKETS - - No incoming packets from peer - - Resource is being allocated for the VPN tunnel. + 2-tuple hash on packet's source and destination IP addresses. + Connections from the same source IP address to the same + destination IP address will be served by the same backend VM while + that VM remains healthy. - >- - Tunnel configuration was rejected, can be result of being - denylisted. - - Tunnel is stopped due to its Forwarding Rules being deleted. + 1-tuple hash only on packet's source IP address. Connections from + the same source IP address will be served by the same backend VM + while that VM remains healthy. This option can only be used for + Internal TCP/UDP Load Balancing. - >- - Waiting to receive all VPN-related configs from user. Network, - TargetVpnGateway, VpnTunnel, ForwardingRule and Route resources - are needed to setup VPN tunnel. + 5-tuple hash on packet's source and destination IP addresses, IP + protocol, and source and destination ports. Connections for the + same IP protocol from the same source IP address and port to the + same destination IP address and port will be served by the same + backend VM while that VM remains healthy. This option cannot be + used for HTTP(S) load balancing. + - >- + 3-tuple hash on packet's source and destination IP addresses, and + IP protocol. Connections for the same IP protocol from the same + source IP address to the same destination IP address will be + served by the same backend VM while that VM remains healthy. This + option cannot be used for HTTP(S) load balancing. + - >- + Hash based on a cookie generated by the L7 loadbalancer. Only + valid for HTTP(S) load balancing. + - The hash is based on a user specified header field. + - The hash is based on a user provided cookie. + - >- + No session affinity. Connections from the same client IP may go to + any instance in the pool. + - >- + Strong cookie-based affinity. Connections bearing the same cookie + will be served by the same backend VM while that VM remains + healthy, as long as the cookie has not expired. enum: - - ALLOCATING_RESOURCES - - AUTHORIZATION_ERROR - - DEPROVISIONING - - ESTABLISHED - - FAILED - - FIRST_HANDSHAKE - - NEGOTIATION_FAILURE - - NETWORK_ERROR - - NO_INCOMING_PACKETS - - PROVISIONING - - REJECTED - - STOPPED - - WAITING_FOR_FULL_CONFIG + - CLIENT_IP + - CLIENT_IP_NO_DESTINATION + - CLIENT_IP_PORT_PROTO + - CLIENT_IP_PROTO + - GENERATED_COOKIE + - HEADER_FIELD + - HTTP_COOKIE + - NONE + - STRONG_COOKIE_AFFINITY + 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. + type: number + format: float + 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 selfLink: description: '[Output Only] Server-defined URL for the resource.' 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. - type: integer - format: int32 - detailedStatus: - description: '[Output Only] Detailed status message for the VPN tunnel.' - 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 for Classic VPN tunnels. This field is output only for - HA VPN tunnels. - type: array - items: - 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 for Classic VPN tunnels. This field is output - only for HA VPN tunnels. - type: array - items: - type: string - labels: - 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 - additionalProperties: - type: string - labelFingerprint: + securityPolicy: description: >- - A fingerprint for the labels being applied to this VpnTunnel, 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 VpnTunnel. + [Output Only] The resource URL for the security policy associated + with this target pool. type: string - format: byte - VpnTunnelAggregatedList: - id: VpnTunnelAggregatedList + TargetPoolAggregatedList: + id: TargetPoolAggregatedList type: object properties: kind: description: >- - [Output Only] Type of resource. Always compute#vpnTunnel for VPN - tunnels. - default: compute#vpnTunnelAggregatedList + [Output Only] Type of resource. Always + compute#targetPoolAggregatedList for aggregated lists of target + pools. + default: compute#targetPoolAggregatedList type: string id: description: >- @@ -58930,11 +59906,11 @@ components: server. type: string items: - description: A list of VpnTunnelsScopedList resources. + description: A list of TargetPool resources. type: object additionalProperties: - description: Name of the scope containing this set of VPN tunnels. - $ref: '#/components/schemas/VpnTunnelsScopedList' + description: Name of the scope containing this set of target pools. + $ref: '#/components/schemas/TargetPoolsScopedList' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -59010,6 +59986,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -59053,6 +60032,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -59075,6 +60055,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -59116,15 +60097,15 @@ components: type: array items: type: string - VpnTunnelsScopedList: - id: VpnTunnelsScopedList + TargetPoolsScopedList: + id: TargetPoolsScopedList type: object properties: - vpnTunnels: - description: A list of VPN tunnels contained in this scope. + targetPools: + description: A list of target pools contained in this scope. type: array items: - $ref: '#/components/schemas/VpnTunnel' + $ref: '#/components/schemas/TargetPool' warning: description: >- Informational warning which replaces the list of addresses when the @@ -59191,6 +60172,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -59234,6 +60218,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -59256,6 +60241,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -59292,14 +60278,78 @@ components: [Output Only] A warning data value corresponding to the key. type: string - ZoneList: - id: ZoneList - description: Contains a list of zone resources. + TargetPoolInstanceHealth: + id: TargetPoolInstanceHealth + type: object + properties: + kind: + description: >- + [Output Only] Type of resource. Always + compute#targetPoolInstanceHealth when checking the health of an + instance. + default: compute#targetPoolInstanceHealth + type: string + healthStatus: + type: array + items: + $ref: '#/components/schemas/HealthStatus' + TargetPoolsAddHealthCheckRequest: + id: TargetPoolsAddHealthCheckRequest + type: object + properties: + healthChecks: + description: The HttpHealthCheck to add to the target pool. + type: array + items: + $ref: '#/components/schemas/HealthCheckReference' + TargetPoolsRemoveHealthCheckRequest: + id: TargetPoolsRemoveHealthCheckRequest + type: object + 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 + type: array + items: + $ref: '#/components/schemas/HealthCheckReference' + TargetPoolsAddInstanceRequest: + id: TargetPoolsAddInstanceRequest + type: object + 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 + type: array + items: + $ref: '#/components/schemas/InstanceReference' + TargetPoolsRemoveInstanceRequest: + id: TargetPoolsRemoveInstanceRequest + type: object + properties: + instances: + description: URLs of the instances to be removed from target pool. + type: array + items: + $ref: '#/components/schemas/InstanceReference' + TargetSslProxyList: + id: TargetSslProxyList + description: Contains a list of TargetSslProxy resources. type: object properties: kind: description: Type of resource. - default: compute#zoneList + default: compute#targetSslProxyList type: string id: description: >- @@ -59307,10 +60357,10 @@ components: server. type: string items: - description: A list of Zone resources. + description: A list of TargetSslProxy resources. type: array items: - $ref: '#/components/schemas/Zone' + $ref: '#/components/schemas/TargetSslProxy' nextPageToken: description: >- [Output Only] This token allows you to get the next page of results @@ -59386,6 +60436,9 @@ components: - >- Success is reported, but some results may be missing due to errors + - >- + Quota information is not available to client requests (e.g: + regions.list). - >- The user attempted to use a resource that requires a TOS they have not accepted. @@ -59429,6 +60482,7 @@ components: - false - false - false + - false enum: - CLEANUP_FAILED - DEPRECATED_RESOURCE_USED @@ -59451,6 +60505,7 @@ components: - NOT_CRITICAL_ERROR - NO_RESULTS_ON_PAGE - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE - REQUIRED_TOS_AGREEMENT - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING - RESOURCE_NOT_DELETED @@ -59487,18 +60542,21 @@ components: [Output Only] A warning data value corresponding to the key. type: string - Zone: - id: Zone + TargetSslProxy: + id: TargetSslProxy 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-b is located in the us-east1 region. For more information, read - Regions and Zones. + Represents a Target SSL Proxy resource. A target SSL proxy is a + component of a Proxy Network Load Balancer. The forwarding rule + references the target SSL proxy, and the target proxy then references a + backend service. For more information, read Proxy Network Load Balancer + overview. type: object properties: kind: - description: '[Output Only] Type of the resource. Always compute#zone for zones.' - default: compute#zone + description: >- + [Output Only] Type of the resource. Always compute#targetSslProxy + for target SSL proxies. + default: compute#targetSslProxy type: string id: description: >- @@ -59510,389 +60568,5599 @@ components: description: '[Output Only] Creation timestamp in RFC3339 text format.' type: string name: - description: '[Output Only] Name of the resource.' + 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 description: - description: '[Output Only] Textual description of the resource.' + description: >- + An optional description of this resource. Provide this property when + you create the resource. type: string - status: - description: '[Output Only] Status of the zone, either UP or DOWN.' + 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. + type: array + items: + type: string + certificateMap: + description: >- + URL of a certificate map that identifies a certificate map + associated with the given target proxy. This field can only be set + for global target proxies. If set, sslCertificates will be ignored. + Accepted format is + //certificatemanager.googleapis.com/projects/{project + }/locations/{location}/certificateMaps/{resourceName}. + 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. type: string enumDescriptions: - '' - '' enum: - - DOWN - - UP - deprecated: - description: '[Output Only] The deprecation status associated with this zone.' - $ref: '#/components/schemas/DeprecationStatus' - region: - description: '[Output Only] Full URL reference to the region which hosts the zone.' + - NONE + - PROXY_V1 + 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 - selfLink: - description: '[Output Only] Server-defined URL for the resource.' + TargetSslProxiesSetBackendServiceRequest: + id: TargetSslProxiesSetBackendServiceRequest + type: object + properties: + service: + description: The URL of the new BackendService resource for the targetSslProxy. type: string - availableCpuPlatforms: - description: '[Output Only] Available cpu/platform selections for the zone.' + TargetSslProxiesSetSslCertificatesRequest: + id: TargetSslProxiesSetSslCertificatesRequest + type: object + 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. type: array items: type: string - supportsPzs: - description: '[Output Only] Reserved for future use.' - type: boolean - parameters: - 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: - type: string - enum: - - json - - media - - proto - 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: + TargetSslProxiesSetCertificateMapRequest: + id: TargetSslProxiesSetCertificateMapRequest + type: object + properties: + certificateMap: + description: >- + URL of the Certificate Map to associate with this TargetSslProxy. + Accepted format is + //certificatemanager.googleapis.com/projects/{project + }/locations/{location}/certificateMaps/{resourceName}. + type: string + TargetSslProxiesSetProxyHeaderRequest: + id: TargetSslProxiesSetProxyHeaderRequest + type: object + properties: + proxyHeader: + description: >- + The new type of proxy header to append before sending data to the + backend. NONE or PROXY_V1 are allowed. + type: string + enumDescriptions: + - '' + - '' + enum: + - NONE + - PROXY_V1 + TargetTcpProxyList: + id: TargetTcpProxyList + description: Contains a list of TargetTcpProxy resources. + type: object + properties: + kind: + description: Type of resource. + default: compute#targetTcpProxyList + type: string + id: + description: >- + [Output Only] Unique identifier for the resource; defined by the + server. + type: string + items: + description: A list of TargetTcpProxy resources. + type: array + items: + $ref: '#/components/schemas/TargetTcpProxy' + nextPageToken: + description: >- + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. + type: string + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string + warning: + description: '[Output Only] Informational warning message.' + type: object + properties: + code: + description: >- + [Output Only] A warning code, if applicable. For example, + Compute Engine returns NO_RESULTS_ON_PAGE if there are no + results in the response. + type: string + enumDescriptions: + - >- + Warning about failed cleanup of transient changes made by a + failed operation. + - A link to a deprecated resource was created. + - >- + When deploying and at least one of the resources has a type + marked as deprecated + - The user created a boot disk that is larger than image size. + - >- + When deploying and at least one of the resources has a type + marked as experimental + - Warning that is present in an external api call + - >- + Warning that value of a field has been overridden. Deprecated + unused field. + - >- + The operation involved use of an injected kernel, which is + deprecated. + - >- + A WEIGHTED_MAGLEV backend service is associated with a health + check that is not of type HTTP/HTTPS/HTTP2. + - >- + When deploying a deployment with a exceedingly large number of + resources + - >- + Resource can't be retrieved due to list overhead quota exceed + which captures the amount of resources filtered out by + user-defined list filter. + - A resource depends on a missing type + - >- + The route's nextHopIp address is not assigned to an instance + on the network. + - The route's next hop instance cannot ip forward. + - >- + The route's nextHopInstance URL refers to an instance that + does not have an ipv6 interface on the same network as the + route. + - >- + The route's nextHopInstance URL refers to an instance that + does not exist. + - >- + The route's nextHopInstance URL refers to an instance that is + not on the same network as the route. + - >- + The route's next hop instance does not have a status of + RUNNING. + - >- + Error which is not critical. We decided to continue the + process despite the mentioned error. + - No results are present on a particular list page. + - >- + Success is reported, but some results may be missing due to + errors + - >- + Quota information is not available to client requests (e.g: + regions.list). + - >- + The user attempted to use a resource that requires a TOS they + have not accepted. + - Warning that a resource is in use. + - >- + One or more of the resources set to auto-delete could not be + deleted because they were in use. + - When a resource schema validation is ignored. + - >- + Instance template used in instance group manager is valid as + such, but its application does not make a lot of sense, + because it allows only single instance in instance group. + - When undeclared properties in the schema are present + - A given scope cannot be reached. + enumDeprecated: + - false + - false + - false + - false + - false + - false + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + enum: + - CLEANUP_FAILED + - DEPRECATED_RESOURCE_USED + - DEPRECATED_TYPE_USED + - DISK_SIZE_LARGER_THAN_IMAGE_SIZE + - EXPERIMENTAL_TYPE_USED + - EXTERNAL_API_WARNING + - FIELD_VALUE_OVERRIDEN + - INJECTED_KERNELS_DEPRECATED + - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB + - LARGE_DEPLOYMENT_WARNING + - LIST_OVERHEAD_QUOTA_EXCEED + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE + - NEXT_HOP_INSTANCE_NOT_FOUND + - NEXT_HOP_INSTANCE_NOT_ON_NETWORK + - NEXT_HOP_NOT_RUNNING + - NOT_CRITICAL_ERROR + - NO_RESULTS_ON_PAGE + - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE + - REQUIRED_TOS_AGREEMENT + - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING + - RESOURCE_NOT_DELETED + - SCHEMA_VALIDATION_IGNORED + - SINGLE_INSTANCE_PROPERTY_TEMPLATE + - UNDECLARED_PROPERTIES + - UNREACHABLE + message: + description: '[Output Only] A human-readable description of the warning code.' + type: string + data: + description: >- + [Output Only] Metadata about this warning in key: value format. + For example: "data": [ { "key": "scope", "value": + "zones/us-east1-d" } + type: array + items: + type: object + properties: + key: + description: >- + [Output Only] A key that provides more detail on the + warning being returned. For example, for warnings where + there are no results in a list request for a particular + zone, this key might be scope and the key value might be + the zone name. Other examples might be a key indicating a + deprecated resource and a suggested replacement, or a + warning about invalid network settings (for example, if an + instance attempts to perform IP forwarding but is not + enabled for IP forwarding). + type: string + value: + description: >- + [Output Only] A warning data value corresponding to the + key. + type: string + TargetTcpProxy: + id: TargetTcpProxy 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 - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string - userIp: - description: Legacy name for parameter that has been superseded by `quotaUser`. - in: query - name: userIp - schema: - type: string - _.xgafv: - description: V1 error format. - in: query - name: $.xgafv - schema: - type: string - enum: - - '1' - - '2' - x-stackQL-resources: - accelerator_types: - id: google.compute.accelerator_types - name: accelerator_types - title: Accelerator_types - methods: - list: - operation: - $ref: '#/paths/~1projects~1{project}~1zones~1{zone}~1acceleratorTypes/get' - response: - mediaType: application/json - openAPIDocKey: '200' - aggregated_list: - operation: - $ref: '#/paths/~1projects~1{project}~1aggregated~1acceleratorTypes/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.items[*].acceleratorTypes[*] - get: - operation: - $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1acceleratorTypes~1{acceleratorType}/get - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accelerator_types/methods/get' - - $ref: '#/components/x-stackQL-resources/accelerator_types/methods/list' - - $ref: >- - #/components/x-stackQL-resources/accelerator_types/methods/aggregated_list - insert: [] - update: [] - replace: [] - delete: [] - global_operations: - id: google.compute.global_operations - name: global_operations - title: Global_operations - methods: - list: - operation: - $ref: '#/paths/~1projects~1{project}~1global~1operations/get' - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: '#/paths/~1projects~1{project}~1global~1operations~1{operation}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: >- - #/paths/~1projects~1{project}~1global~1operations~1{operation}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - wait: - operation: - $ref: >- - #/paths/~1projects~1{project}~1global~1operations~1{operation}~1wait/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/global_operations/methods/get' - - $ref: '#/components/x-stackQL-resources/global_operations/methods/list' - insert: [] - update: [] - replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/global_operations/methods/delete' - global_operations_aggregated: - id: google.compute.global_operations_aggregated - name: global_operations_aggregated - title: Global_operations_aggregated - methods: - aggregated_list: - operation: - $ref: '#/paths/~1projects~1{project}~1aggregated~1operations/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.items[*].operations[*] - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/global_operations_aggregated/methods/aggregated_list - insert: [] - update: [] - replace: [] - delete: [] - global_organization_operations: - id: google.compute.global_organization_operations - name: global_organization_operations - title: Global_organization_operations - methods: - list: - operation: - $ref: '#/paths/~1locations~1global~1operations/get' - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: '#/paths/~1locations~1global~1operations~1{operation}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: '#/paths/~1locations~1global~1operations~1{operation}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/global_organization_operations/methods/get - - $ref: >- - #/components/x-stackQL-resources/global_organization_operations/methods/list - insert: [] - update: [] - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/global_organization_operations/methods/delete - zone_operations: - id: google.compute.zone_operations - name: zone_operations - title: Zone_operations + Represents a Target TCP Proxy resource. A target TCP proxy is a + component of a Proxy Network Load Balancer. The forwarding rule + references the target TCP proxy, and the target proxy then references a + backend service. For more information, read Proxy Network Load Balancer + overview. + type: object + properties: + kind: + description: >- + [Output Only] Type of the resource. Always compute#targetTcpProxy + for target TCP proxies. + default: compute#targetTcpProxy + type: string + id: + description: >- + [Output Only] The unique identifier for the resource. This + identifier is defined by the server. + type: string + format: uint64 + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + 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 + description: + description: >- + An optional description of this resource. Provide this property when + you create the resource. + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + service: + description: URL to the BackendService resource. + 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. + type: string + enumDescriptions: + - '' + - '' + enum: + - NONE + - PROXY_V1 + 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 TCP proxy + resides. This field is not applicable to global TCP proxy. + type: string + TargetTcpProxyAggregatedList: + id: TargetTcpProxyAggregatedList + type: object + properties: + kind: + description: >- + [Output Only] Type of resource. Always + compute#targetTcpProxyAggregatedList for lists of Target TCP + Proxies. + default: compute#targetTcpProxyAggregatedList + type: string + id: + description: >- + [Output Only] Unique identifier for the resource; defined by the + server. + type: string + items: + description: A list of TargetTcpProxiesScopedList resources. + type: object + additionalProperties: + description: Name of the scope containing this set of TargetTcpProxies. + $ref: '#/components/schemas/TargetTcpProxiesScopedList' + nextPageToken: + description: >- + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. + type: string + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string + warning: + description: '[Output Only] Informational warning message.' + type: object + properties: + code: + description: >- + [Output Only] A warning code, if applicable. For example, + Compute Engine returns NO_RESULTS_ON_PAGE if there are no + results in the response. + type: string + enumDescriptions: + - >- + Warning about failed cleanup of transient changes made by a + failed operation. + - A link to a deprecated resource was created. + - >- + When deploying and at least one of the resources has a type + marked as deprecated + - The user created a boot disk that is larger than image size. + - >- + When deploying and at least one of the resources has a type + marked as experimental + - Warning that is present in an external api call + - >- + Warning that value of a field has been overridden. Deprecated + unused field. + - >- + The operation involved use of an injected kernel, which is + deprecated. + - >- + A WEIGHTED_MAGLEV backend service is associated with a health + check that is not of type HTTP/HTTPS/HTTP2. + - >- + When deploying a deployment with a exceedingly large number of + resources + - >- + Resource can't be retrieved due to list overhead quota exceed + which captures the amount of resources filtered out by + user-defined list filter. + - A resource depends on a missing type + - >- + The route's nextHopIp address is not assigned to an instance + on the network. + - The route's next hop instance cannot ip forward. + - >- + The route's nextHopInstance URL refers to an instance that + does not have an ipv6 interface on the same network as the + route. + - >- + The route's nextHopInstance URL refers to an instance that + does not exist. + - >- + The route's nextHopInstance URL refers to an instance that is + not on the same network as the route. + - >- + The route's next hop instance does not have a status of + RUNNING. + - >- + Error which is not critical. We decided to continue the + process despite the mentioned error. + - No results are present on a particular list page. + - >- + Success is reported, but some results may be missing due to + errors + - >- + Quota information is not available to client requests (e.g: + regions.list). + - >- + The user attempted to use a resource that requires a TOS they + have not accepted. + - Warning that a resource is in use. + - >- + One or more of the resources set to auto-delete could not be + deleted because they were in use. + - When a resource schema validation is ignored. + - >- + Instance template used in instance group manager is valid as + such, but its application does not make a lot of sense, + because it allows only single instance in instance group. + - When undeclared properties in the schema are present + - A given scope cannot be reached. + enumDeprecated: + - false + - false + - false + - false + - false + - false + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + enum: + - CLEANUP_FAILED + - DEPRECATED_RESOURCE_USED + - DEPRECATED_TYPE_USED + - DISK_SIZE_LARGER_THAN_IMAGE_SIZE + - EXPERIMENTAL_TYPE_USED + - EXTERNAL_API_WARNING + - FIELD_VALUE_OVERRIDEN + - INJECTED_KERNELS_DEPRECATED + - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB + - LARGE_DEPLOYMENT_WARNING + - LIST_OVERHEAD_QUOTA_EXCEED + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE + - NEXT_HOP_INSTANCE_NOT_FOUND + - NEXT_HOP_INSTANCE_NOT_ON_NETWORK + - NEXT_HOP_NOT_RUNNING + - NOT_CRITICAL_ERROR + - NO_RESULTS_ON_PAGE + - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE + - REQUIRED_TOS_AGREEMENT + - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING + - RESOURCE_NOT_DELETED + - SCHEMA_VALIDATION_IGNORED + - SINGLE_INSTANCE_PROPERTY_TEMPLATE + - UNDECLARED_PROPERTIES + - UNREACHABLE + message: + description: '[Output Only] A human-readable description of the warning code.' + type: string + data: + description: >- + [Output Only] Metadata about this warning in key: value format. + For example: "data": [ { "key": "scope", "value": + "zones/us-east1-d" } + type: array + items: + type: object + properties: + key: + description: >- + [Output Only] A key that provides more detail on the + warning being returned. For example, for warnings where + there are no results in a list request for a particular + zone, this key might be scope and the key value might be + the zone name. Other examples might be a key indicating a + deprecated resource and a suggested replacement, or a + warning about invalid network settings (for example, if an + instance attempts to perform IP forwarding but is not + enabled for IP forwarding). + type: string + value: + description: >- + [Output Only] A warning data value corresponding to the + key. + type: string + unreachables: + description: '[Output Only] Unreachable resources.' + type: array + items: + type: string + TargetTcpProxiesScopedList: + id: TargetTcpProxiesScopedList + type: object + properties: + targetTcpProxies: + description: A list of TargetTcpProxies contained in this scope. + type: array + items: + $ref: '#/components/schemas/TargetTcpProxy' + warning: + description: >- + Informational warning which replaces the list of backend services + when the list is empty. + type: object + properties: + code: + description: >- + [Output Only] A warning code, if applicable. For example, + Compute Engine returns NO_RESULTS_ON_PAGE if there are no + results in the response. + type: string + enumDescriptions: + - >- + Warning about failed cleanup of transient changes made by a + failed operation. + - A link to a deprecated resource was created. + - >- + When deploying and at least one of the resources has a type + marked as deprecated + - The user created a boot disk that is larger than image size. + - >- + When deploying and at least one of the resources has a type + marked as experimental + - Warning that is present in an external api call + - >- + Warning that value of a field has been overridden. Deprecated + unused field. + - >- + The operation involved use of an injected kernel, which is + deprecated. + - >- + A WEIGHTED_MAGLEV backend service is associated with a health + check that is not of type HTTP/HTTPS/HTTP2. + - >- + When deploying a deployment with a exceedingly large number of + resources + - >- + Resource can't be retrieved due to list overhead quota exceed + which captures the amount of resources filtered out by + user-defined list filter. + - A resource depends on a missing type + - >- + The route's nextHopIp address is not assigned to an instance + on the network. + - The route's next hop instance cannot ip forward. + - >- + The route's nextHopInstance URL refers to an instance that + does not have an ipv6 interface on the same network as the + route. + - >- + The route's nextHopInstance URL refers to an instance that + does not exist. + - >- + The route's nextHopInstance URL refers to an instance that is + not on the same network as the route. + - >- + The route's next hop instance does not have a status of + RUNNING. + - >- + Error which is not critical. We decided to continue the + process despite the mentioned error. + - No results are present on a particular list page. + - >- + Success is reported, but some results may be missing due to + errors + - >- + Quota information is not available to client requests (e.g: + regions.list). + - >- + The user attempted to use a resource that requires a TOS they + have not accepted. + - Warning that a resource is in use. + - >- + One or more of the resources set to auto-delete could not be + deleted because they were in use. + - When a resource schema validation is ignored. + - >- + Instance template used in instance group manager is valid as + such, but its application does not make a lot of sense, + because it allows only single instance in instance group. + - When undeclared properties in the schema are present + - A given scope cannot be reached. + enumDeprecated: + - false + - false + - false + - false + - false + - false + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + enum: + - CLEANUP_FAILED + - DEPRECATED_RESOURCE_USED + - DEPRECATED_TYPE_USED + - DISK_SIZE_LARGER_THAN_IMAGE_SIZE + - EXPERIMENTAL_TYPE_USED + - EXTERNAL_API_WARNING + - FIELD_VALUE_OVERRIDEN + - INJECTED_KERNELS_DEPRECATED + - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB + - LARGE_DEPLOYMENT_WARNING + - LIST_OVERHEAD_QUOTA_EXCEED + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE + - NEXT_HOP_INSTANCE_NOT_FOUND + - NEXT_HOP_INSTANCE_NOT_ON_NETWORK + - NEXT_HOP_NOT_RUNNING + - NOT_CRITICAL_ERROR + - NO_RESULTS_ON_PAGE + - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE + - REQUIRED_TOS_AGREEMENT + - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING + - RESOURCE_NOT_DELETED + - SCHEMA_VALIDATION_IGNORED + - SINGLE_INSTANCE_PROPERTY_TEMPLATE + - UNDECLARED_PROPERTIES + - UNREACHABLE + message: + description: '[Output Only] A human-readable description of the warning code.' + type: string + data: + description: >- + [Output Only] Metadata about this warning in key: value format. + For example: "data": [ { "key": "scope", "value": + "zones/us-east1-d" } + type: array + items: + type: object + properties: + key: + description: >- + [Output Only] A key that provides more detail on the + warning being returned. For example, for warnings where + there are no results in a list request for a particular + zone, this key might be scope and the key value might be + the zone name. Other examples might be a key indicating a + deprecated resource and a suggested replacement, or a + warning about invalid network settings (for example, if an + instance attempts to perform IP forwarding but is not + enabled for IP forwarding). + type: string + value: + description: >- + [Output Only] A warning data value corresponding to the + key. + type: string + TargetTcpProxiesSetBackendServiceRequest: + id: TargetTcpProxiesSetBackendServiceRequest + type: object + properties: + service: + description: The URL of the new BackendService resource for the targetTcpProxy. + type: string + TargetTcpProxiesSetProxyHeaderRequest: + id: TargetTcpProxiesSetProxyHeaderRequest + type: object + properties: + proxyHeader: + description: >- + The new type of proxy header to append before sending data to the + backend. NONE or PROXY_V1 are allowed. + type: string + enumDescriptions: + - '' + - '' + enum: + - NONE + - PROXY_V1 + TargetVpnGatewayList: + id: TargetVpnGatewayList + description: Contains a list of TargetVpnGateway resources. + type: object + properties: + kind: + description: >- + [Output Only] Type of resource. Always compute#targetVpnGateway for + target VPN gateways. + default: compute#targetVpnGatewayList + type: string + id: + description: >- + [Output Only] Unique identifier for the resource; defined by the + server. + type: string + items: + description: A list of TargetVpnGateway resources. + type: array + items: + $ref: '#/components/schemas/TargetVpnGateway' + nextPageToken: + description: >- + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. + type: string + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string + warning: + description: '[Output Only] Informational warning message.' + type: object + properties: + code: + description: >- + [Output Only] A warning code, if applicable. For example, + Compute Engine returns NO_RESULTS_ON_PAGE if there are no + results in the response. + type: string + enumDescriptions: + - >- + Warning about failed cleanup of transient changes made by a + failed operation. + - A link to a deprecated resource was created. + - >- + When deploying and at least one of the resources has a type + marked as deprecated + - The user created a boot disk that is larger than image size. + - >- + When deploying and at least one of the resources has a type + marked as experimental + - Warning that is present in an external api call + - >- + Warning that value of a field has been overridden. Deprecated + unused field. + - >- + The operation involved use of an injected kernel, which is + deprecated. + - >- + A WEIGHTED_MAGLEV backend service is associated with a health + check that is not of type HTTP/HTTPS/HTTP2. + - >- + When deploying a deployment with a exceedingly large number of + resources + - >- + Resource can't be retrieved due to list overhead quota exceed + which captures the amount of resources filtered out by + user-defined list filter. + - A resource depends on a missing type + - >- + The route's nextHopIp address is not assigned to an instance + on the network. + - The route's next hop instance cannot ip forward. + - >- + The route's nextHopInstance URL refers to an instance that + does not have an ipv6 interface on the same network as the + route. + - >- + The route's nextHopInstance URL refers to an instance that + does not exist. + - >- + The route's nextHopInstance URL refers to an instance that is + not on the same network as the route. + - >- + The route's next hop instance does not have a status of + RUNNING. + - >- + Error which is not critical. We decided to continue the + process despite the mentioned error. + - No results are present on a particular list page. + - >- + Success is reported, but some results may be missing due to + errors + - >- + Quota information is not available to client requests (e.g: + regions.list). + - >- + The user attempted to use a resource that requires a TOS they + have not accepted. + - Warning that a resource is in use. + - >- + One or more of the resources set to auto-delete could not be + deleted because they were in use. + - When a resource schema validation is ignored. + - >- + Instance template used in instance group manager is valid as + such, but its application does not make a lot of sense, + because it allows only single instance in instance group. + - When undeclared properties in the schema are present + - A given scope cannot be reached. + enumDeprecated: + - false + - false + - false + - false + - false + - false + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + enum: + - CLEANUP_FAILED + - DEPRECATED_RESOURCE_USED + - DEPRECATED_TYPE_USED + - DISK_SIZE_LARGER_THAN_IMAGE_SIZE + - EXPERIMENTAL_TYPE_USED + - EXTERNAL_API_WARNING + - FIELD_VALUE_OVERRIDEN + - INJECTED_KERNELS_DEPRECATED + - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB + - LARGE_DEPLOYMENT_WARNING + - LIST_OVERHEAD_QUOTA_EXCEED + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE + - NEXT_HOP_INSTANCE_NOT_FOUND + - NEXT_HOP_INSTANCE_NOT_ON_NETWORK + - NEXT_HOP_NOT_RUNNING + - NOT_CRITICAL_ERROR + - NO_RESULTS_ON_PAGE + - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE + - REQUIRED_TOS_AGREEMENT + - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING + - RESOURCE_NOT_DELETED + - SCHEMA_VALIDATION_IGNORED + - SINGLE_INSTANCE_PROPERTY_TEMPLATE + - UNDECLARED_PROPERTIES + - UNREACHABLE + message: + description: '[Output Only] A human-readable description of the warning code.' + type: string + data: + description: >- + [Output Only] Metadata about this warning in key: value format. + For example: "data": [ { "key": "scope", "value": + "zones/us-east1-d" } + type: array + items: + type: object + properties: + key: + description: >- + [Output Only] A key that provides more detail on the + warning being returned. For example, for warnings where + there are no results in a list request for a particular + zone, this key might be scope and the key value might be + the zone name. Other examples might be a key indicating a + deprecated resource and a suggested replacement, or a + warning about invalid network settings (for example, if an + instance attempts to perform IP forwarding but is not + enabled for IP forwarding). + type: string + value: + description: >- + [Output Only] A warning data value corresponding to the + key. + type: string + TargetVpnGateway: + id: 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. + type: object + properties: + kind: + description: >- + [Output Only] Type of resource. Always compute#targetVpnGateway for + target VPN gateways. + default: compute#targetVpnGateway + type: string + id: + description: >- + [Output Only] The unique identifier for the resource. This + identifier is defined by the server. + type: string + format: uint64 + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + 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])?' + annotations: + required: + - compute.targetVpnGateways.insert + type: string + description: + description: >- + An optional description of this resource. Provide this property when + you create the resource. + 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 + network: + description: >- + URL of the network to which this VPN gateway is attached. Provided + by the client when the VPN gateway is created. + annotations: + required: + - compute.targetVpnGateways.insert + 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. + type: array + items: + type: string + status: + description: >- + [Output Only] The status of the VPN gateway, which can be one of the + following: CREATING, READY, FAILED, or DELETING. + type: string + enumDescriptions: + - '' + - '' + - '' + - '' + enum: + - CREATING + - DELETING + - FAILED + - READY + selfLink: + description: '[Output Only] Server-defined URL for 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. + type: array + items: + type: string + labels: + 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 + additionalProperties: + type: string + labelFingerprint: + description: >- + A fingerprint for the labels being applied to this TargetVpnGateway, + 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 TargetVpnGateway. + type: string + format: byte + TargetVpnGatewayAggregatedList: + id: TargetVpnGatewayAggregatedList + type: object + properties: + kind: + description: >- + [Output Only] Type of resource. Always compute#targetVpnGateway for + target VPN gateways. + default: compute#targetVpnGatewayAggregatedList + type: string + id: + description: >- + [Output Only] Unique identifier for the resource; defined by the + server. + type: string + items: + description: A list of TargetVpnGateway resources. + type: object + additionalProperties: + description: >- + [Output Only] Name of the scope containing this set of target VPN + gateways. + $ref: '#/components/schemas/TargetVpnGatewaysScopedList' + nextPageToken: + description: >- + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. + type: string + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string + warning: + description: '[Output Only] Informational warning message.' + type: object + properties: + code: + description: >- + [Output Only] A warning code, if applicable. For example, + Compute Engine returns NO_RESULTS_ON_PAGE if there are no + results in the response. + type: string + enumDescriptions: + - >- + Warning about failed cleanup of transient changes made by a + failed operation. + - A link to a deprecated resource was created. + - >- + When deploying and at least one of the resources has a type + marked as deprecated + - The user created a boot disk that is larger than image size. + - >- + When deploying and at least one of the resources has a type + marked as experimental + - Warning that is present in an external api call + - >- + Warning that value of a field has been overridden. Deprecated + unused field. + - >- + The operation involved use of an injected kernel, which is + deprecated. + - >- + A WEIGHTED_MAGLEV backend service is associated with a health + check that is not of type HTTP/HTTPS/HTTP2. + - >- + When deploying a deployment with a exceedingly large number of + resources + - >- + Resource can't be retrieved due to list overhead quota exceed + which captures the amount of resources filtered out by + user-defined list filter. + - A resource depends on a missing type + - >- + The route's nextHopIp address is not assigned to an instance + on the network. + - The route's next hop instance cannot ip forward. + - >- + The route's nextHopInstance URL refers to an instance that + does not have an ipv6 interface on the same network as the + route. + - >- + The route's nextHopInstance URL refers to an instance that + does not exist. + - >- + The route's nextHopInstance URL refers to an instance that is + not on the same network as the route. + - >- + The route's next hop instance does not have a status of + RUNNING. + - >- + Error which is not critical. We decided to continue the + process despite the mentioned error. + - No results are present on a particular list page. + - >- + Success is reported, but some results may be missing due to + errors + - >- + Quota information is not available to client requests (e.g: + regions.list). + - >- + The user attempted to use a resource that requires a TOS they + have not accepted. + - Warning that a resource is in use. + - >- + One or more of the resources set to auto-delete could not be + deleted because they were in use. + - When a resource schema validation is ignored. + - >- + Instance template used in instance group manager is valid as + such, but its application does not make a lot of sense, + because it allows only single instance in instance group. + - When undeclared properties in the schema are present + - A given scope cannot be reached. + enumDeprecated: + - false + - false + - false + - false + - false + - false + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + enum: + - CLEANUP_FAILED + - DEPRECATED_RESOURCE_USED + - DEPRECATED_TYPE_USED + - DISK_SIZE_LARGER_THAN_IMAGE_SIZE + - EXPERIMENTAL_TYPE_USED + - EXTERNAL_API_WARNING + - FIELD_VALUE_OVERRIDEN + - INJECTED_KERNELS_DEPRECATED + - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB + - LARGE_DEPLOYMENT_WARNING + - LIST_OVERHEAD_QUOTA_EXCEED + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE + - NEXT_HOP_INSTANCE_NOT_FOUND + - NEXT_HOP_INSTANCE_NOT_ON_NETWORK + - NEXT_HOP_NOT_RUNNING + - NOT_CRITICAL_ERROR + - NO_RESULTS_ON_PAGE + - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE + - REQUIRED_TOS_AGREEMENT + - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING + - RESOURCE_NOT_DELETED + - SCHEMA_VALIDATION_IGNORED + - SINGLE_INSTANCE_PROPERTY_TEMPLATE + - UNDECLARED_PROPERTIES + - UNREACHABLE + message: + description: '[Output Only] A human-readable description of the warning code.' + type: string + data: + description: >- + [Output Only] Metadata about this warning in key: value format. + For example: "data": [ { "key": "scope", "value": + "zones/us-east1-d" } + type: array + items: + type: object + properties: + key: + description: >- + [Output Only] A key that provides more detail on the + warning being returned. For example, for warnings where + there are no results in a list request for a particular + zone, this key might be scope and the key value might be + the zone name. Other examples might be a key indicating a + deprecated resource and a suggested replacement, or a + warning about invalid network settings (for example, if an + instance attempts to perform IP forwarding but is not + enabled for IP forwarding). + type: string + value: + description: >- + [Output Only] A warning data value corresponding to the + key. + type: string + unreachables: + description: '[Output Only] Unreachable resources.' + type: array + items: + type: string + TargetVpnGatewaysScopedList: + id: TargetVpnGatewaysScopedList + type: object + properties: + targetVpnGateways: + description: '[Output Only] A list of target VPN gateways contained in this scope.' + type: array + items: + $ref: '#/components/schemas/TargetVpnGateway' + warning: + description: >- + [Output Only] Informational warning which replaces the list of + addresses when the list is empty. + type: object + properties: + code: + description: >- + [Output Only] A warning code, if applicable. For example, + Compute Engine returns NO_RESULTS_ON_PAGE if there are no + results in the response. + type: string + enumDescriptions: + - >- + Warning about failed cleanup of transient changes made by a + failed operation. + - A link to a deprecated resource was created. + - >- + When deploying and at least one of the resources has a type + marked as deprecated + - The user created a boot disk that is larger than image size. + - >- + When deploying and at least one of the resources has a type + marked as experimental + - Warning that is present in an external api call + - >- + Warning that value of a field has been overridden. Deprecated + unused field. + - >- + The operation involved use of an injected kernel, which is + deprecated. + - >- + A WEIGHTED_MAGLEV backend service is associated with a health + check that is not of type HTTP/HTTPS/HTTP2. + - >- + When deploying a deployment with a exceedingly large number of + resources + - >- + Resource can't be retrieved due to list overhead quota exceed + which captures the amount of resources filtered out by + user-defined list filter. + - A resource depends on a missing type + - >- + The route's nextHopIp address is not assigned to an instance + on the network. + - The route's next hop instance cannot ip forward. + - >- + The route's nextHopInstance URL refers to an instance that + does not have an ipv6 interface on the same network as the + route. + - >- + The route's nextHopInstance URL refers to an instance that + does not exist. + - >- + The route's nextHopInstance URL refers to an instance that is + not on the same network as the route. + - >- + The route's next hop instance does not have a status of + RUNNING. + - >- + Error which is not critical. We decided to continue the + process despite the mentioned error. + - No results are present on a particular list page. + - >- + Success is reported, but some results may be missing due to + errors + - >- + Quota information is not available to client requests (e.g: + regions.list). + - >- + The user attempted to use a resource that requires a TOS they + have not accepted. + - Warning that a resource is in use. + - >- + One or more of the resources set to auto-delete could not be + deleted because they were in use. + - When a resource schema validation is ignored. + - >- + Instance template used in instance group manager is valid as + such, but its application does not make a lot of sense, + because it allows only single instance in instance group. + - When undeclared properties in the schema are present + - A given scope cannot be reached. + enumDeprecated: + - false + - false + - false + - false + - false + - false + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + enum: + - CLEANUP_FAILED + - DEPRECATED_RESOURCE_USED + - DEPRECATED_TYPE_USED + - DISK_SIZE_LARGER_THAN_IMAGE_SIZE + - EXPERIMENTAL_TYPE_USED + - EXTERNAL_API_WARNING + - FIELD_VALUE_OVERRIDEN + - INJECTED_KERNELS_DEPRECATED + - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB + - LARGE_DEPLOYMENT_WARNING + - LIST_OVERHEAD_QUOTA_EXCEED + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE + - NEXT_HOP_INSTANCE_NOT_FOUND + - NEXT_HOP_INSTANCE_NOT_ON_NETWORK + - NEXT_HOP_NOT_RUNNING + - NOT_CRITICAL_ERROR + - NO_RESULTS_ON_PAGE + - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE + - REQUIRED_TOS_AGREEMENT + - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING + - RESOURCE_NOT_DELETED + - SCHEMA_VALIDATION_IGNORED + - SINGLE_INSTANCE_PROPERTY_TEMPLATE + - UNDECLARED_PROPERTIES + - UNREACHABLE + message: + description: '[Output Only] A human-readable description of the warning code.' + type: string + data: + description: >- + [Output Only] Metadata about this warning in key: value format. + For example: "data": [ { "key": "scope", "value": + "zones/us-east1-d" } + type: array + items: + type: object + properties: + key: + description: >- + [Output Only] A key that provides more detail on the + warning being returned. For example, for warnings where + there are no results in a list request for a particular + zone, this key might be scope and the key value might be + the zone name. Other examples might be a key indicating a + deprecated resource and a suggested replacement, or a + warning about invalid network settings (for example, if an + instance attempts to perform IP forwarding but is not + enabled for IP forwarding). + type: string + value: + description: >- + [Output Only] A warning data value corresponding to the + key. + type: string + UrlMapList: + id: UrlMapList + description: Contains a list of UrlMap resources. + type: object + properties: + kind: + description: Type of resource. + default: compute#urlMapList + type: string + id: + description: >- + [Output Only] Unique identifier for the resource; defined by the + server. + type: string + items: + description: A list of UrlMap resources. + type: array + items: + $ref: '#/components/schemas/UrlMap' + nextPageToken: + description: >- + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. + type: string + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string + warning: + description: '[Output Only] Informational warning message.' + type: object + properties: + code: + description: >- + [Output Only] A warning code, if applicable. For example, + Compute Engine returns NO_RESULTS_ON_PAGE if there are no + results in the response. + type: string + enumDescriptions: + - >- + Warning about failed cleanup of transient changes made by a + failed operation. + - A link to a deprecated resource was created. + - >- + When deploying and at least one of the resources has a type + marked as deprecated + - The user created a boot disk that is larger than image size. + - >- + When deploying and at least one of the resources has a type + marked as experimental + - Warning that is present in an external api call + - >- + Warning that value of a field has been overridden. Deprecated + unused field. + - >- + The operation involved use of an injected kernel, which is + deprecated. + - >- + A WEIGHTED_MAGLEV backend service is associated with a health + check that is not of type HTTP/HTTPS/HTTP2. + - >- + When deploying a deployment with a exceedingly large number of + resources + - >- + Resource can't be retrieved due to list overhead quota exceed + which captures the amount of resources filtered out by + user-defined list filter. + - A resource depends on a missing type + - >- + The route's nextHopIp address is not assigned to an instance + on the network. + - The route's next hop instance cannot ip forward. + - >- + The route's nextHopInstance URL refers to an instance that + does not have an ipv6 interface on the same network as the + route. + - >- + The route's nextHopInstance URL refers to an instance that + does not exist. + - >- + The route's nextHopInstance URL refers to an instance that is + not on the same network as the route. + - >- + The route's next hop instance does not have a status of + RUNNING. + - >- + Error which is not critical. We decided to continue the + process despite the mentioned error. + - No results are present on a particular list page. + - >- + Success is reported, but some results may be missing due to + errors + - >- + Quota information is not available to client requests (e.g: + regions.list). + - >- + The user attempted to use a resource that requires a TOS they + have not accepted. + - Warning that a resource is in use. + - >- + One or more of the resources set to auto-delete could not be + deleted because they were in use. + - When a resource schema validation is ignored. + - >- + Instance template used in instance group manager is valid as + such, but its application does not make a lot of sense, + because it allows only single instance in instance group. + - When undeclared properties in the schema are present + - A given scope cannot be reached. + enumDeprecated: + - false + - false + - false + - false + - false + - false + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + enum: + - CLEANUP_FAILED + - DEPRECATED_RESOURCE_USED + - DEPRECATED_TYPE_USED + - DISK_SIZE_LARGER_THAN_IMAGE_SIZE + - EXPERIMENTAL_TYPE_USED + - EXTERNAL_API_WARNING + - FIELD_VALUE_OVERRIDEN + - INJECTED_KERNELS_DEPRECATED + - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB + - LARGE_DEPLOYMENT_WARNING + - LIST_OVERHEAD_QUOTA_EXCEED + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE + - NEXT_HOP_INSTANCE_NOT_FOUND + - NEXT_HOP_INSTANCE_NOT_ON_NETWORK + - NEXT_HOP_NOT_RUNNING + - NOT_CRITICAL_ERROR + - NO_RESULTS_ON_PAGE + - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE + - REQUIRED_TOS_AGREEMENT + - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING + - RESOURCE_NOT_DELETED + - SCHEMA_VALIDATION_IGNORED + - SINGLE_INSTANCE_PROPERTY_TEMPLATE + - UNDECLARED_PROPERTIES + - UNREACHABLE + message: + description: '[Output Only] A human-readable description of the warning code.' + type: string + data: + description: >- + [Output Only] Metadata about this warning in key: value format. + For example: "data": [ { "key": "scope", "value": + "zones/us-east1-d" } + type: array + items: + type: object + properties: + key: + description: >- + [Output Only] A key that provides more detail on the + warning being returned. For example, for warnings where + there are no results in a list request for a particular + zone, this key might be scope and the key value might be + the zone name. Other examples might be a key indicating a + deprecated resource and a suggested replacement, or a + warning about invalid network settings (for example, if an + instance attempts to perform IP forwarding but is not + enabled for IP forwarding). + type: string + value: + description: >- + [Output Only] A warning data value corresponding to the + key. + type: string + UrlMap: + id: UrlMap + description: >- + Represents a URL Map resource. 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 cloud load balancers and + Traffic Director: * urlMaps are used by global external Application Load + Balancers, classic Application Load Balancers, and cross-region internal + Application Load Balancers. * regionUrlMaps are used by internal + Application Load Balancers, regional external Application Load Balancers + and regional internal Application Load Balancers. For a list of + supported URL map features by the 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 hostnames 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, + EXTERNAL_MANAGED, 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. + type: object + properties: + kind: + description: >- + [Output Only] Type of the resource. Always compute#urlMaps for url + maps. + default: compute#urlMap + type: string + id: + description: >- + [Output Only] The unique identifier for the resource. This + identifier is defined by the server. + type: string + format: uint64 + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + 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 + description: + description: >- + An optional description of this resource. Provide this property when + you create the resource. + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + hostRules: + description: The list of host rules to use against the URL. + type: array + items: + $ref: '#/components/schemas/HostRule' + pathMatchers: + description: The list of named PathMatchers to use against the URL. + type: array + items: + $ref: '#/components/schemas/PathMatcher' + tests: + description: >- + The list of expected URL mapping tests. Request to update the UrlMap + succeeds only if all test cases pass. You can specify a maximum of + 100 tests per UrlMap. Not supported when the URL map is bound to a + target gRPC proxy that has validateForProxyless field set to true. + type: array + items: + $ref: '#/components/schemas/UrlMapTest' + 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 also specified, advanced routing actions, such + as URL rewrites, take effect before sending the request to the + backend. Only one of defaultUrlRedirect, defaultService or + defaultRouteAction.weightedBackendService can be set. defaultService + has no effect when the URL map is bound to a target gRPC proxy that + has the validateForProxyless field set to true. + type: string + defaultRouteAction: + description: >- + defaultRouteAction takes effect when none of the hostRules match. + The load balancer performs advanced routing actions, such as URL + rewrites and header transformations, before forwarding the request + to the selected backend. Only one of defaultUrlRedirect, + defaultService or defaultRouteAction.weightedBackendService can be + set. URL maps for classic Application Load Balancers only support + the urlRewrite action within defaultRouteAction. defaultRouteAction + has no effect when the URL map is bound to a target gRPC proxy that + has the validateForProxyless field set to true. + $ref: '#/components/schemas/HttpRouteAction' + defaultUrlRedirect: + description: >- + When none of the specified hostRules match, the request is + redirected to a URL specified by defaultUrlRedirect. Only one of + defaultUrlRedirect, defaultService or + defaultRouteAction.weightedBackendService can be set. Not supported + when the URL map is bound to a target gRPC proxy. + $ref: '#/components/schemas/HttpRedirectAction' + headerAction: + 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. + headerAction is not supported for load balancers that have their + loadBalancingScheme set to EXTERNAL. Not supported when the URL map + is bound to a target gRPC proxy that has validateForProxyless field + set to true. + $ref: '#/components/schemas/HttpHeaderAction' + defaultCustomErrorResponsePolicy: + description: >- + defaultCustomErrorResponsePolicy specifies how the Load Balancer + returns error responses when BackendServiceor BackendBucket responds + with an error. This policy takes effect at the load balancer level + and applies only when no policy has been defined for the error code + at lower levels like PathMatcher, RouteRule and PathRule within this + UrlMap. For example, consider a UrlMap with the following + configuration: - defaultCustomErrorResponsePolicy containing + policies for responding to 5xx and 4xx errors - A PathMatcher + configured for *.example.com has defaultCustomErrorResponsePolicy + for 4xx. If a request for http://www.example.com/ encounters a 404, + the policy in pathMatcher.defaultCustomErrorResponsePolicy will be + enforced. When the request for http://www.example.com/ encounters a + 502, the policy in UrlMap.defaultCustomErrorResponsePolicy will be + enforced. When a request that does not match any host in + *.example.com such as http://www.myotherexample.com/, encounters a + 404, UrlMap.defaultCustomErrorResponsePolicy takes effect. When used + in conjunction with defaultRouteAction.retryPolicy, retries take + precedence. Only once all retries are exhausted, the + defaultCustomErrorResponsePolicy is applied. While attempting a + retry, if load balancer is successful in reaching the service, the + defaultCustomErrorResponsePolicy is ignored and the response from + the service is returned to the client. + defaultCustomErrorResponsePolicy is supported only for global + external Application Load Balancers. + $ref: '#/components/schemas/CustomErrorResponsePolicy' + fingerprint: + description: >- + Fingerprint of this resource. A hash of the contents stored in this + object. This field is used in optimistic locking. This field is + 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. + type: string + format: byte + 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 + HostRule: + id: HostRule + description: >- + UrlMaps A host-matching rule for a URL. If matched, will use the named + PathMatcher to select the BackendService. + type: object + 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 if followed by anything, the immediate following + character must be either - or .. * based matching is not supported + when the URL map is bound to a target gRPC proxy that has the + validateForProxyless field set to true. + type: array + items: + type: string + 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 + PathMatcher: + id: 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 is used. + type: object + properties: + name: + description: The name to which this PathMatcher is referred by the HostRule. + type: string + description: + description: >- + An optional description of this resource. Provide this property when + you create the resource. + type: string + defaultService: + description: >- + The full or partial URL to the BackendService resource. This URL is + 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 also + specified, advanced routing actions, such as URL rewrites, take + effect before sending the request to the backend. Only one of + defaultUrlRedirect, defaultService or + defaultRouteAction.weightedBackendService can 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 + defaultRouteAction: + description: >- + defaultRouteAction takes effect when none of the pathRules or + routeRules match. The load balancer performs advanced routing + actions, such as URL rewrites and header transformations, before + forwarding the request to the selected backend. Only one of + defaultUrlRedirect, defaultService or + defaultRouteAction.weightedBackendService can be set. URL maps for + classic Application Load Balancers only support the urlRewrite + action within a path matcher's defaultRouteAction. + $ref: '#/components/schemas/HttpRouteAction' + defaultUrlRedirect: + description: >- + When none of the specified pathRules or routeRules match, the + request is redirected to a URL specified by defaultUrlRedirect. Only + one of defaultUrlRedirect, defaultService or + defaultRouteAction.weightedBackendService can be set. Not supported + when the URL map is bound to a target gRPC proxy. + $ref: '#/components/schemas/HttpRedirectAction' + 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. + type: array + items: + $ref: '#/components/schemas/PathRule' + 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. + type: array + items: + $ref: '#/components/schemas/HttpRouteRule' + headerAction: + description: >- + Specifies changes to request and response headers that need to take + effect for the selected backend service. HeaderAction specified here + are applied after the matching HttpRouteRule HeaderAction and before + the HeaderAction in the UrlMap HeaderAction is not supported for + load balancers that have their loadBalancingScheme set to EXTERNAL. + Not supported when the URL map is bound to a target gRPC proxy that + has validateForProxyless field set to true. + $ref: '#/components/schemas/HttpHeaderAction' + defaultCustomErrorResponsePolicy: + description: >- + defaultCustomErrorResponsePolicy specifies how the Load Balancer + returns error responses when BackendServiceor BackendBucket responds + with an error. This policy takes effect at the PathMatcher level and + applies only when no policy has been defined for the error code at + lower levels like RouteRule and PathRule within this PathMatcher. If + an error code does not have a policy defined in + defaultCustomErrorResponsePolicy, then a policy defined for the + error code in UrlMap.defaultCustomErrorResponsePolicy takes effect. + For example, consider a UrlMap with the following configuration: - + UrlMap.defaultCustomErrorResponsePolicy is configured with policies + for 5xx and 4xx errors - A RouteRule for /coming_soon/ is configured + for the error code 404. If the request is for www.myotherdomain.com + and a 404 is encountered, the policy under + UrlMap.defaultCustomErrorResponsePolicy takes effect. If a 404 + response is encountered for the request + www.example.com/current_events/, the pathMatcher's policy takes + effect. If however, the request for www.example.com/coming_soon/ + encounters a 404, the policy in RouteRule.customErrorResponsePolicy + takes effect. If any of the requests in this example encounter a 500 + error code, the policy at UrlMap.defaultCustomErrorResponsePolicy + takes effect. When used in conjunction with + pathMatcher.defaultRouteAction.retryPolicy, retries take precedence. + Only once all retries are exhausted, the + defaultCustomErrorResponsePolicy is applied. While attempting a + retry, if load balancer is successful in reaching the service, the + defaultCustomErrorResponsePolicy is ignored and the response from + the service is returned to the client. + defaultCustomErrorResponsePolicy is supported only for global + external Application Load Balancers. + $ref: '#/components/schemas/CustomErrorResponsePolicy' + HttpRouteAction: + id: HttpRouteAction + type: object + properties: + 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. After a + backend service 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. + type: array + items: + $ref: '#/components/schemas/WeightedBackendService' + urlRewrite: + description: >- + The spec to modify the URL of the request, before forwarding the + request to the matched service. urlRewrite is the only action + supported in UrlMaps for classic Application Load Balancers. Not + supported when the URL map is bound to a target gRPC proxy that has + the validateForProxyless field set to true. + $ref: '#/components/schemas/UrlRewrite' + timeout: + description: >- + Specifies the timeout for the selected route. Timeout is computed + from the time the request has been fully processed (known as + *end-of-stream*) up until the response has been processed. Timeout + includes all retries. If not specified, this field uses the largest + timeout among all backend services associated with the route. Not + supported when the URL map is bound to a target gRPC proxy that has + validateForProxyless field set to true. + $ref: '#/components/schemas/Duration' + retryPolicy: + description: Specifies the retry policy associated with this route. + $ref: '#/components/schemas/HttpRetryPolicy' + requestMirrorPolicy: + description: >- + Specifies the policy on how requests intended for the route's + backends are shadowed to a separate mirrored backend service. The + load balancer does not wait for responses from the shadow service. + Before sending traffic to the shadow service, the host / authority + header is suffixed with -shadow. Not supported when the URL map is + bound to a target gRPC proxy that has the validateForProxyless field + set to true. + $ref: '#/components/schemas/RequestMirrorPolicy' + corsPolicy: + description: >- + The specification for allowing client-side cross-origin requests. + For more information about the W3C recommendation for cross-origin + resource sharing (CORS), see Fetch API Living Standard. Not + supported when the URL map is bound to a target gRPC proxy. + $ref: '#/components/schemas/CorsPolicy' + faultInjectionPolicy: + 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 a load balancer on a percentage of + requests before sending those requests to the backend service. + Similarly requests from clients can be aborted by the load balancer + for a percentage of requests. timeout and retry_policy is ignored by + clients that are configured with a fault_injection_policy if: 1. The + traffic is generated by fault injection AND 2. The fault injection + is not a delay fault injection. Fault injection is not supported + with the classic Application Load Balancer . To see which load + balancers support fault injection, see Load balancing: Routing and + traffic management features. + $ref: '#/components/schemas/HttpFaultInjection' + maxStreamDuration: + 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 (known as + *end-of-stream*), the duration in this field is computed from the + beginning of the stream until the response has been processed, + including all retries. A stream that does not complete in this + duration is closed. If not specified, this field uses the maximum + maxStreamDuration value 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. + $ref: '#/components/schemas/Duration' + WeightedBackendService: + id: 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 backend services. The volume of traffic for + each backend service is proportional to the weight specified in each + WeightedBackendService + type: object + properties: + backendService: + description: >- + The full or partial URL to the default BackendService resource. + Before forwarding the request to backendService, the load balancer + applies any relevant headerActions specified as part of this + backendServiceWeight. + type: string + weight: + description: >- + Specifies the fraction of traffic sent to a backend service, + 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 + backend service, subsequent requests are sent to the same backend + service as determined by the backend service's session affinity + policy. Don't configure session affinity if you're using weighted + traffic splitting. If you do, the weighted traffic splitting + configuration takes precedence. The value must be from 0 to 1000. + type: integer + format: uint32 + headerAction: + 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. headerAction is not supported for load + balancers that have their loadBalancingScheme set to EXTERNAL. Not + supported when the URL map is bound to a target gRPC proxy that has + validateForProxyless field set to true. + $ref: '#/components/schemas/HttpHeaderAction' + HttpHeaderAction: + id: HttpHeaderAction + description: >- + The request and response header transformations that take effect before + the request is passed along to the selected backendService. + type: object + properties: + requestHeadersToRemove: + description: >- + A list of header names for headers that need to be removed from the + request before forwarding the request to the backendService. + type: array + items: + type: string + requestHeadersToAdd: + description: >- + Headers to add to a matching request before forwarding the request + to the backendService. + type: array + items: + $ref: '#/components/schemas/HttpHeaderOption' + responseHeadersToRemove: + description: >- + A list of header names for headers that need to be removed from the + response before sending the response back to the client. + type: array + items: + type: string + responseHeadersToAdd: + description: >- + Headers to add the response before sending the response back to the + client. + type: array + items: + $ref: '#/components/schemas/HttpHeaderOption' + HttpHeaderOption: + id: HttpHeaderOption + description: >- + Specification determining how headers are added to requests or + responses. + type: object + 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 true, unless a variable is present in headerValue, in which + case the default value is false. . + type: boolean + UrlRewrite: + id: UrlRewrite + description: >- + The spec for modifying the path before sending the request to the + matched backend service. + type: object + properties: + pathPrefixRewrite: + description: >- + Before forwarding the request to the selected backend service, the + matching portion of the request's path is replaced by + pathPrefixRewrite. The value must be from 1 to 1024 characters. + type: string + hostRewrite: + description: >- + Before forwarding the request to the selected service, the request's + host header is replaced with contents of hostRewrite. The value must + be from 1 to 255 characters. + type: string + pathTemplateRewrite: + description: ' If specified, the pattern rewrites the URL path (based on the :path header) using the HTTP template syntax. A corresponding path_template_match must be specified. Any template variables must exist in the path_template_match field. - -At least one variable must be specified in the path_template_match field - You can omit variables from the rewritten URL - The * and ** operators cannot be matched unless they have a corresponding variable name - e.g. {format=*} or {var=**}. For example, a path_template_match of /static/{format=**} could be rewritten as /static/content/{format} to prefix /content to the URL. Variables can also be re-ordered in a rewrite, so that /{country}/{format}/{suffix=**} can be rewritten as /content/{format}/{country}/{suffix}. At least one non-empty routeRules[].matchRules[].path_template_match is required. Only one of path_prefix_rewrite or path_template_rewrite may be specified.' + type: string + HttpRetryPolicy: + id: HttpRetryPolicy + description: The retry policy associates with HttpRouteRule + type: object + properties: + retryConditions: + description: >- + Specifies one or more conditions when this retry policy applies. + Valid values are: - 5xx: retry is attempted if the instance or + endpoint responds with any 5xx response code, or if the instance or + endpoint does not respond at all. For 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 is attempted on failures + connecting to the instance or endpoint. For example, connection + timeouts. - retriable-4xx: a retry is attempted if the instance or + endpoint responds with a 4xx response code. The only error that you + can retry is error code 409. - refused-stream: a retry is 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 is attempted if the gRPC status code in the + response header is set to cancelled. - deadline-exceeded: a retry is + attempted if the gRPC status code in the response header is set to + deadline-exceeded. - internal: a retry is attempted if the gRPC + status code in the response header is set to internal. - + resource-exhausted: a retry is attempted if the gRPC status code in + the response header is set to resource-exhausted. - unavailable: a + retry is attempted if the gRPC status code in the response header is + set to unavailable. Only the following codes are supported when the + URL map is bound to target gRPC proxy that has validateForProxyless + field set to true. - cancelled - deadline-exceeded - internal - + resource-exhausted - unavailable + type: array + items: + type: string + numRetries: + description: >- + Specifies the allowed number retries. This number must be > 0. If + not specified, defaults to 1. + type: integer + format: uint32 + perTryTimeout: + description: >- + Specifies a non-zero timeout per retry attempt. If not specified, + will use the timeout set in the HttpRouteAction field. If timeout in + the HttpRouteAction field is not set, this field uses the largest + timeout among all backend services associated with the route. Not + supported when the URL map is bound to a target gRPC proxy that has + the validateForProxyless field set to true. + $ref: '#/components/schemas/Duration' + RequestMirrorPolicy: + id: RequestMirrorPolicy + description: >- + A policy that specifies how requests intended for the route's backends + are shadowed to a separate mirrored backend service. The load balancer + doesn't wait for responses from the shadow service. Before sending + traffic to the shadow service, the host or authority header is suffixed + with -shadow. + type: object + properties: + backendService: + description: >- + The full or partial URL to the BackendService resource being + mirrored to. The backend service configured for a mirroring policy + must reference backends that are of the same type as the original + backend service matched in the URL map. Serverless NEG backends are + not currently supported as a mirrored backend service. + type: string + CorsPolicy: + id: CorsPolicy + description: >- + The specification for allowing client-side cross-origin requests. For + more information about the W3C recommendation for cross-origin resource + sharing (CORS), see Fetch API Living Standard. + type: object + properties: + allowOrigins: + description: >- + Specifies the list of origins that is allowed to do CORS requests. + An origin is allowed if it matches either an item in allowOrigins or + an item in allowOriginRegexes. + type: array + items: + type: string + allowOriginRegexes: + description: >- + Specifies a regular expression that matches allowed origins. For + more information, see regular expression syntax . An origin is + allowed if it matches either an item in allowOrigins or an item in + allowOriginRegexes. Regular expressions can only be used when the + loadBalancingScheme is set to INTERNAL_SELF_MANAGED. + type: array + items: + type: string + allowMethods: + description: Specifies the content for the Access-Control-Allow-Methods header. + type: array + items: + type: string + allowHeaders: + description: Specifies the content for the Access-Control-Allow-Headers header. + type: array + items: + type: string + exposeHeaders: + description: Specifies the content for the Access-Control-Expose-Headers header. + type: array + items: + type: string + maxAge: + description: >- + Specifies how long results of a preflight request can be cached in + seconds. This field translates to the Access-Control-Max-Age header. + type: integer + format: int32 + allowCredentials: + description: >- + In response to a preflight request, setting this to true indicates + that the actual request can include user credentials. This field + translates to the Access-Control-Allow-Credentials header. Default + is false. + type: boolean + disabled: + description: >- + If true, disables the CORS policy. The default value is false, which + indicates that the CORS policy is in effect. + type: boolean + HttpFaultInjection: + id: 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 the load balancer on a percentage of requests before + sending those request to the backend service. Similarly requests from + clients can be aborted by the load balancer for a percentage of + requests. + type: object + properties: + delay: + description: >- + The specification for how client requests are delayed as part of + fault injection, before being sent to a backend service. + $ref: '#/components/schemas/HttpFaultDelay' + abort: + description: >- + The specification for how client requests are aborted as part of + fault injection. + $ref: '#/components/schemas/HttpFaultAbort' + HttpFaultDelay: + id: HttpFaultDelay + description: >- + Specifies the delay introduced by the load balancer before forwarding + the request to the backend service as part of fault injection. + type: object + properties: + fixedDelay: + description: Specifies the value of the fixed delay interval. + $ref: '#/components/schemas/Duration' + percentage: + description: >- + The percentage of traffic for connections, operations, or requests + for which a delay is introduced as part of fault injection. The + value must be from 0.0 to 100.0 inclusive. + type: number + format: double + HttpFaultAbort: + id: HttpFaultAbort + description: Specification for how requests are aborted as part of fault injection. + type: object + properties: + httpStatus: + description: >- + The HTTP status code used to abort the request. The value must be + from 200 to 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. + type: integer + format: uint32 + percentage: + description: >- + The percentage of traffic for connections, operations, or requests + that is aborted as part of fault injection. The value must be from + 0.0 to 100.0 inclusive. + type: number + format: double + HttpRedirectAction: + id: HttpRedirectAction + description: Specifies settings for an HTTP redirect. + type: object + properties: + hostRedirect: + description: >- + The host that is used in the redirect response instead of the one + that was supplied in the request. The value must be from 1 to 255 + characters. + type: string + pathRedirect: + description: >- + The path that is 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 is used for + the redirect. The value must be from 1 to 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 is used for the + redirect. The value must be from 1 to 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 is retained. - + PERMANENT_REDIRECT, which corresponds to 308. In this case, the + request method is retained. + type: string + enumDescriptions: + - Http Status Code 302 - Found. + - Http Status Code 301 - Moved Permanently. + - Http Status Code 308 - Permanent Redirect maintaining HTTP method. + - Http Status Code 303 - See Other. + - Http Status Code 307 - Temporary Redirect maintaining HTTP method. + enum: + - FOUND + - MOVED_PERMANENTLY_DEFAULT + - PERMANENT_REDIRECT + - SEE_OTHER + - TEMPORARY_REDIRECT + 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 + remains the same as that of the request. This must only be set for + URL maps used in TargetHttpProxys. Setting this true for + TargetHttpsProxy is not permitted. The default is set to false. + type: boolean + stripQuery: + description: >- + If set to true, any accompanying query portion of the original URL + is removed before redirecting the request. If set to false, the + query portion of the original URL is retained. The default is set to + false. + type: boolean + PathRule: + id: PathRule + description: >- + A path-matching rule for a URL. If matched, will use the specified + BackendService to handle the traffic arriving at this URL. + type: object + properties: + 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 also + specified, advanced routing actions, such as URL rewrites, take + effect before sending the request to the backend. Only one of + urlRedirect, service or routeAction.weightedBackendService can be + set. + type: string + routeAction: + description: >- + In response to a matching path, the load balancer performs advanced + routing actions, such as URL rewrites and header transformations, + before forwarding the request to the selected backend. Only one of + urlRedirect, service or routeAction.weightedBackendService can be + set. URL maps for classic Application Load Balancers only support + the urlRewrite action within a path rule's routeAction. + $ref: '#/components/schemas/HttpRouteAction' + urlRedirect: + description: >- + When a path pattern is matched, the request is redirected to a URL + specified by urlRedirect. Only one of urlRedirect, service or + routeAction.weightedBackendService can be set. Not supported when + the URL map is bound to a target gRPC proxy. + $ref: '#/components/schemas/HttpRedirectAction' + 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. + type: array + items: + type: string + customErrorResponsePolicy: + description: >- + customErrorResponsePolicy specifies how the Load Balancer returns + error responses when BackendServiceor BackendBucket responds with an + error. If a policy for an error code is not configured for the + PathRule, a policy for the error code configured in + pathMatcher.defaultCustomErrorResponsePolicy is applied. If one is + not specified in pathMatcher.defaultCustomErrorResponsePolicy, the + policy configured in UrlMap.defaultCustomErrorResponsePolicy takes + effect. For example, consider a UrlMap with the following + configuration: - UrlMap.defaultCustomErrorResponsePolicy are + configured with policies for 5xx and 4xx errors - A PathRule for + /coming_soon/ is configured for the error code 404. If the request + is for www.myotherdomain.com and a 404 is encountered, the policy + under UrlMap.defaultCustomErrorResponsePolicy takes effect. If a 404 + response is encountered for the request + www.example.com/current_events/, the pathMatcher's policy takes + effect. If however, the request for www.example.com/coming_soon/ + encounters a 404, the policy in PathRule.customErrorResponsePolicy + takes effect. If any of the requests in this example encounter a 500 + error code, the policy at UrlMap.defaultCustomErrorResponsePolicy + takes effect. customErrorResponsePolicy is supported only for global + external Application Load Balancers. + $ref: '#/components/schemas/CustomErrorResponsePolicy' + CustomErrorResponsePolicy: + id: CustomErrorResponsePolicy + description: >- + Specifies the custom error response policy that must be applied when the + backend service or backend bucket responds with an error. + type: object + properties: + errorResponseRules: + description: >- + Specifies rules for returning error responses. In a given policy, if + you specify rules for both a range of error codes as well as rules + for specific error codes then rules with specific error codes have a + higher priority. For example, assume that you configure a rule for + 401 (Un-authorized) code, and another for all 4 series error codes + (4XX). If the backend service returns a 401, then the rule for 401 + will be applied. However if the backend service returns a 403, the + rule for 4xx takes effect. + type: array + items: + $ref: >- + #/components/schemas/CustomErrorResponsePolicyCustomErrorResponseRule + errorService: + description: >- + The full or partial URL to the BackendBucket resource that contains + the custom error content. Examples are: - + https://www.googleapis.com/compute/v1/projects/project/global/backendBuckets/myBackendBucket + - compute/v1/projects/project/global/backendBuckets/myBackendBucket + - global/backendBuckets/myBackendBucket If errorService is not + specified at lower levels like pathMatcher, pathRule and routeRule, + an errorService specified at a higher level in the UrlMap will be + used. If UrlMap.defaultCustomErrorResponsePolicy contains one or + more errorResponseRules[], it must specify errorService. If load + balancer cannot reach the backendBucket, a simple Not Found Error + will be returned, with the original response code (or + overrideResponseCode if configured). errorService is not supported + for internal or regional HTTP/HTTPS load balancers. + type: string + CustomErrorResponsePolicyCustomErrorResponseRule: + id: CustomErrorResponsePolicyCustomErrorResponseRule + description: >- + Specifies the mapping between the response code that will be returned + along with the custom error content and the response code returned by + the backend service. + type: object + properties: + matchResponseCodes: + description: >- + Valid values include: - A number between 400 and 599: For example + 401 or 503, in which case the load balancer applies the policy if + the error code exactly matches this value. - 5xx: Load Balancer will + apply the policy if the backend service responds with any response + code in the range of 500 to 599. - 4xx: Load Balancer will apply the + policy if the backend service responds with any response code in the + range of 400 to 499. Values must be unique within matchResponseCodes + and across all errorResponseRules of CustomErrorResponsePolicy. + type: array + items: + type: string + path: + description: >- + The full path to a file within backendBucket . For example: + /errors/defaultError.html path must start with a leading slash. path + cannot have trailing slashes. If the file is not available in + backendBucket or the load balancer cannot reach the BackendBucket, a + simple Not Found Error is returned to the client. The value must be + from 1 to 1024 characters + type: string + overrideResponseCode: + description: >- + The HTTP status code returned with the response containing the + custom error content. If overrideResponseCode is not supplied, the + same response code returned by the original backend bucket or + backend service is returned to the client. + type: integer + format: int32 + HttpRouteRule: + id: HttpRouteRule + description: >- + The HttpRouteRule setting specifies how to match an HTTP request and the + corresponding routing action that load balancing proxies perform. + type: object + properties: + priority: + description: >- + For routeRules within a given pathMatcher, priority determines the + order in which a load balancer interprets 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 from 0 to 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. + type: integer + format: int32 + description: + description: >- + The short description conveying the intent of this routeRule. The + description can have a maximum length of 1024 characters. + type: string + 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. + type: array + items: + $ref: '#/components/schemas/HttpRouteRuleMatch' + 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 also + specified, advanced routing actions, such as URL rewrites, take + effect before sending the request to the backend. Only one of + urlRedirect, service or routeAction.weightedBackendService can be + set. + type: string + routeAction: + description: >- + In response to a matching matchRule, the load balancer performs + advanced routing actions, such as URL rewrites and header + transformations, before forwarding the request to the selected + backend. Only one of urlRedirect, service or + routeAction.weightedBackendService can be set. URL maps for classic + Application Load Balancers only support the urlRewrite action within + a route rule's routeAction. + $ref: '#/components/schemas/HttpRouteAction' + urlRedirect: + description: >- + When this rule is matched, the request is redirected to a URL + specified by urlRedirect. Only one of urlRedirect, service or + routeAction.weightedBackendService can be set. Not supported when + the URL map is bound to a target gRPC proxy. + $ref: '#/components/schemas/HttpRedirectAction' + headerAction: + description: >- + Specifies changes to request and response headers that need to take + effect for the selected backendService. The headerAction value + specified here is applied before the matching + pathMatchers[].headerAction and after + pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction + HeaderAction is not supported for load balancers that have their + loadBalancingScheme set to EXTERNAL. Not supported when the URL map + is bound to a target gRPC proxy that has validateForProxyless field + set to true. + $ref: '#/components/schemas/HttpHeaderAction' + customErrorResponsePolicy: + description: >- + customErrorResponsePolicy specifies how the Load Balancer returns + error responses when BackendServiceor BackendBucket responds with an + error. If a policy for an error code is not configured for the + RouteRule, a policy for the error code configured in + pathMatcher.defaultCustomErrorResponsePolicy is applied. If one is + not specified in pathMatcher.defaultCustomErrorResponsePolicy, the + policy configured in UrlMap.defaultCustomErrorResponsePolicy takes + effect. For example, consider a UrlMap with the following + configuration: - UrlMap.defaultCustomErrorResponsePolicy are + configured with policies for 5xx and 4xx errors - A RouteRule for + /coming_soon/ is configured for the error code 404. If the request + is for www.myotherdomain.com and a 404 is encountered, the policy + under UrlMap.defaultCustomErrorResponsePolicy takes effect. If a 404 + response is encountered for the request + www.example.com/current_events/, the pathMatcher's policy takes + effect. If however, the request for www.example.com/coming_soon/ + encounters a 404, the policy in RouteRule.customErrorResponsePolicy + takes effect. If any of the requests in this example encounter a 500 + error code, the policy at UrlMap.defaultCustomErrorResponsePolicy + takes effect. When used in conjunction with + routeRules.routeAction.retryPolicy, retries take precedence. Only + once all retries are exhausted, the customErrorResponsePolicy is + applied. While attempting a retry, if load balancer is successful in + reaching the service, the customErrorResponsePolicy is ignored and + the response from the service is returned to the client. + customErrorResponsePolicy is supported only for global external + Application Load Balancers. + $ref: '#/components/schemas/CustomErrorResponsePolicy' + HttpRouteRuleMatch: + id: 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. + type: object + properties: + 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 from 1 to 1024 characters. Only one of + prefixMatch, fullPathMatch or regexMatch must be specified. + type: string + 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 from 1 to 1024 characters. Only one of + prefixMatch, fullPathMatch or regexMatch must be specified. + type: string + 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 more information about regular expression syntax, see + Syntax. Only one of prefixMatch, fullPathMatch or regexMatch must be + specified. Regular expressions can only be used when the + loadBalancingScheme is set to INTERNAL_SELF_MANAGED. + type: string + 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 a target + gRPC proxy. + type: boolean + headerMatches: + description: >- + Specifies a list of header match criteria, all of which must match + corresponding headers in the request. + type: array + items: + $ref: '#/components/schemas/HttpHeaderMatch' + 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 a target gRPC proxy. + type: array + items: + $ref: '#/components/schemas/HttpQueryParameterMatch' + metadataFilters: + description: >- + Opaque filter criteria used by the load balancer to restrict routing + configuration to a limited set of xDS compliant clients. In their + xDS requests to the load balancer, 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 metadata filters are + specified, all of them need to be satisfied in order to be + considered a match. metadataFilters specified here is applied after + those specified in ForwardingRule that refers to the UrlMap this + HttpRouteRuleMatch belongs to. metadataFilters only applies to load + balancers that have loadBalancingScheme set to + INTERNAL_SELF_MANAGED. Not supported when the URL map is bound to a + target gRPC proxy that has validateForProxyless field set to true. + type: array + items: + $ref: '#/components/schemas/MetadataFilter' + pathTemplateMatch: + description: >- + If specified, the route is a pattern match expression that must + match the :path header once the query string is removed. A pattern + match allows you to match - The value must be between 1 and 1024 + characters - The pattern must start with a leading slash ("/") - + There may be no more than 5 operators in pattern Precisely one of + prefix_match, full_path_match, regex_match or path_template_match + must be set. + type: string + HttpHeaderMatch: + id: HttpHeaderMatch + description: matchRule criteria for request header matches. + type: object + properties: + 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 a target gRPC proxy that has + the 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 + 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 + regexMatch: + description: >- + The value of the header must match the regular expression specified + in regexMatch. For more information about regular expression syntax, + see 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. Regular expressions can only + be used when the loadBalancingScheme is set to + INTERNAL_SELF_MANAGED. + type: string + rangeMatch: + 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. rangeMatch is not supported for load balancers that + have loadBalancingScheme set to EXTERNAL. + $ref: '#/components/schemas/Int64RangeMatch' + 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 + 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 + 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 + invertMatch: + description: >- + If set to false, the headerMatch is considered a match if the + preceding match criteria are met. If set to true, the headerMatch is + considered a match if the preceding match criteria are NOT met. The + default setting is false. + type: boolean + Int64RangeMatch: + id: Int64RangeMatch + description: >- + HttpRouteRuleMatch criteria for field values that must stay within the + specified integer range. + type: object + properties: + rangeStart: + description: The start of the range (inclusive) in signed long integer format. + type: string + format: int64 + rangeEnd: + description: The end of the range (exclusive) in signed long integer format. + type: string + format: int64 + HttpQueryParameterMatch: + id: HttpQueryParameterMatch + description: HttpRouteRuleMatch criteria for a request's query parameter. + type: object + properties: + 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 + 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 + regexMatch: + description: >- + The queryParameterMatch matches if the value of the parameter + matches the regular expression specified by regexMatch. For more + information about regular expression syntax, see Syntax. Only one of + presentMatch, exactMatch, or regexMatch must be set. Regular + expressions can only be used when the loadBalancingScheme is set to + INTERNAL_SELF_MANAGED. + type: string + UrlMapTest: + id: UrlMapTest + description: Message for the expected URL mappings. + type: object + properties: + description: + description: Description of this test case. + type: string + 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 + headers: + description: >- + HTTP headers for this request. If headers contains a host header, + then host must also match the header value. + type: array + items: + $ref: '#/components/schemas/UrlMapTestHeader' + service: + description: >- + Expected BackendService or BackendBucket resource the given URL + should be mapped to. The service field cannot be set if + expectedRedirectResponseCode is set. + type: string + expectedOutputUrl: + description: >- + The expected output URL evaluated by the 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 the 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. + type: integer + format: int32 + UrlMapTestHeader: + id: UrlMapTestHeader + description: HTTP headers used in UrlMapTests. + type: object + properties: + name: + description: Header name. + type: string + value: + description: Header value. + type: string + UrlMapsAggregatedList: + id: UrlMapsAggregatedList + type: object + properties: + kind: + description: Type of resource. + default: compute#urlMapsAggregatedList + type: string + id: + description: >- + [Output Only] Unique identifier for the resource; defined by the + server. + type: string + items: + description: A list of UrlMapsScopedList resources. + type: object + additionalProperties: + description: Name of the scope containing this set of UrlMaps. + $ref: '#/components/schemas/UrlMapsScopedList' + nextPageToken: + description: >- + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. + type: string + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string + warning: + description: '[Output Only] Informational warning message.' + type: object + properties: + code: + description: >- + [Output Only] A warning code, if applicable. For example, + Compute Engine returns NO_RESULTS_ON_PAGE if there are no + results in the response. + type: string + enumDescriptions: + - >- + Warning about failed cleanup of transient changes made by a + failed operation. + - A link to a deprecated resource was created. + - >- + When deploying and at least one of the resources has a type + marked as deprecated + - The user created a boot disk that is larger than image size. + - >- + When deploying and at least one of the resources has a type + marked as experimental + - Warning that is present in an external api call + - >- + Warning that value of a field has been overridden. Deprecated + unused field. + - >- + The operation involved use of an injected kernel, which is + deprecated. + - >- + A WEIGHTED_MAGLEV backend service is associated with a health + check that is not of type HTTP/HTTPS/HTTP2. + - >- + When deploying a deployment with a exceedingly large number of + resources + - >- + Resource can't be retrieved due to list overhead quota exceed + which captures the amount of resources filtered out by + user-defined list filter. + - A resource depends on a missing type + - >- + The route's nextHopIp address is not assigned to an instance + on the network. + - The route's next hop instance cannot ip forward. + - >- + The route's nextHopInstance URL refers to an instance that + does not have an ipv6 interface on the same network as the + route. + - >- + The route's nextHopInstance URL refers to an instance that + does not exist. + - >- + The route's nextHopInstance URL refers to an instance that is + not on the same network as the route. + - >- + The route's next hop instance does not have a status of + RUNNING. + - >- + Error which is not critical. We decided to continue the + process despite the mentioned error. + - No results are present on a particular list page. + - >- + Success is reported, but some results may be missing due to + errors + - >- + Quota information is not available to client requests (e.g: + regions.list). + - >- + The user attempted to use a resource that requires a TOS they + have not accepted. + - Warning that a resource is in use. + - >- + One or more of the resources set to auto-delete could not be + deleted because they were in use. + - When a resource schema validation is ignored. + - >- + Instance template used in instance group manager is valid as + such, but its application does not make a lot of sense, + because it allows only single instance in instance group. + - When undeclared properties in the schema are present + - A given scope cannot be reached. + enumDeprecated: + - false + - false + - false + - false + - false + - false + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + enum: + - CLEANUP_FAILED + - DEPRECATED_RESOURCE_USED + - DEPRECATED_TYPE_USED + - DISK_SIZE_LARGER_THAN_IMAGE_SIZE + - EXPERIMENTAL_TYPE_USED + - EXTERNAL_API_WARNING + - FIELD_VALUE_OVERRIDEN + - INJECTED_KERNELS_DEPRECATED + - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB + - LARGE_DEPLOYMENT_WARNING + - LIST_OVERHEAD_QUOTA_EXCEED + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE + - NEXT_HOP_INSTANCE_NOT_FOUND + - NEXT_HOP_INSTANCE_NOT_ON_NETWORK + - NEXT_HOP_NOT_RUNNING + - NOT_CRITICAL_ERROR + - NO_RESULTS_ON_PAGE + - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE + - REQUIRED_TOS_AGREEMENT + - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING + - RESOURCE_NOT_DELETED + - SCHEMA_VALIDATION_IGNORED + - SINGLE_INSTANCE_PROPERTY_TEMPLATE + - UNDECLARED_PROPERTIES + - UNREACHABLE + message: + description: '[Output Only] A human-readable description of the warning code.' + type: string + data: + description: >- + [Output Only] Metadata about this warning in key: value format. + For example: "data": [ { "key": "scope", "value": + "zones/us-east1-d" } + type: array + items: + type: object + properties: + key: + description: >- + [Output Only] A key that provides more detail on the + warning being returned. For example, for warnings where + there are no results in a list request for a particular + zone, this key might be scope and the key value might be + the zone name. Other examples might be a key indicating a + deprecated resource and a suggested replacement, or a + warning about invalid network settings (for example, if an + instance attempts to perform IP forwarding but is not + enabled for IP forwarding). + type: string + value: + description: >- + [Output Only] A warning data value corresponding to the + key. + type: string + unreachables: + description: '[Output Only] Unreachable resources.' + type: array + items: + type: string + UrlMapsScopedList: + id: UrlMapsScopedList + type: object + properties: + urlMaps: + description: A list of UrlMaps contained in this scope. + type: array + items: + $ref: '#/components/schemas/UrlMap' + warning: + description: >- + Informational warning which replaces the list of backend services + when the list is empty. + type: object + properties: + code: + description: >- + [Output Only] A warning code, if applicable. For example, + Compute Engine returns NO_RESULTS_ON_PAGE if there are no + results in the response. + type: string + enumDescriptions: + - >- + Warning about failed cleanup of transient changes made by a + failed operation. + - A link to a deprecated resource was created. + - >- + When deploying and at least one of the resources has a type + marked as deprecated + - The user created a boot disk that is larger than image size. + - >- + When deploying and at least one of the resources has a type + marked as experimental + - Warning that is present in an external api call + - >- + Warning that value of a field has been overridden. Deprecated + unused field. + - >- + The operation involved use of an injected kernel, which is + deprecated. + - >- + A WEIGHTED_MAGLEV backend service is associated with a health + check that is not of type HTTP/HTTPS/HTTP2. + - >- + When deploying a deployment with a exceedingly large number of + resources + - >- + Resource can't be retrieved due to list overhead quota exceed + which captures the amount of resources filtered out by + user-defined list filter. + - A resource depends on a missing type + - >- + The route's nextHopIp address is not assigned to an instance + on the network. + - The route's next hop instance cannot ip forward. + - >- + The route's nextHopInstance URL refers to an instance that + does not have an ipv6 interface on the same network as the + route. + - >- + The route's nextHopInstance URL refers to an instance that + does not exist. + - >- + The route's nextHopInstance URL refers to an instance that is + not on the same network as the route. + - >- + The route's next hop instance does not have a status of + RUNNING. + - >- + Error which is not critical. We decided to continue the + process despite the mentioned error. + - No results are present on a particular list page. + - >- + Success is reported, but some results may be missing due to + errors + - >- + Quota information is not available to client requests (e.g: + regions.list). + - >- + The user attempted to use a resource that requires a TOS they + have not accepted. + - Warning that a resource is in use. + - >- + One or more of the resources set to auto-delete could not be + deleted because they were in use. + - When a resource schema validation is ignored. + - >- + Instance template used in instance group manager is valid as + such, but its application does not make a lot of sense, + because it allows only single instance in instance group. + - When undeclared properties in the schema are present + - A given scope cannot be reached. + enumDeprecated: + - false + - false + - false + - false + - false + - false + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + enum: + - CLEANUP_FAILED + - DEPRECATED_RESOURCE_USED + - DEPRECATED_TYPE_USED + - DISK_SIZE_LARGER_THAN_IMAGE_SIZE + - EXPERIMENTAL_TYPE_USED + - EXTERNAL_API_WARNING + - FIELD_VALUE_OVERRIDEN + - INJECTED_KERNELS_DEPRECATED + - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB + - LARGE_DEPLOYMENT_WARNING + - LIST_OVERHEAD_QUOTA_EXCEED + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE + - NEXT_HOP_INSTANCE_NOT_FOUND + - NEXT_HOP_INSTANCE_NOT_ON_NETWORK + - NEXT_HOP_NOT_RUNNING + - NOT_CRITICAL_ERROR + - NO_RESULTS_ON_PAGE + - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE + - REQUIRED_TOS_AGREEMENT + - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING + - RESOURCE_NOT_DELETED + - SCHEMA_VALIDATION_IGNORED + - SINGLE_INSTANCE_PROPERTY_TEMPLATE + - UNDECLARED_PROPERTIES + - UNREACHABLE + message: + description: '[Output Only] A human-readable description of the warning code.' + type: string + data: + description: >- + [Output Only] Metadata about this warning in key: value format. + For example: "data": [ { "key": "scope", "value": + "zones/us-east1-d" } + type: array + items: + type: object + properties: + key: + description: >- + [Output Only] A key that provides more detail on the + warning being returned. For example, for warnings where + there are no results in a list request for a particular + zone, this key might be scope and the key value might be + the zone name. Other examples might be a key indicating a + deprecated resource and a suggested replacement, or a + warning about invalid network settings (for example, if an + instance attempts to perform IP forwarding but is not + enabled for IP forwarding). + type: string + value: + description: >- + [Output Only] A warning data value corresponding to the + key. + type: string + UrlMapsValidateRequest: + id: UrlMapsValidateRequest + type: object + properties: + resource: + description: Content of the UrlMap to be validated. + $ref: '#/components/schemas/UrlMap' + loadBalancingSchemes: + description: >- + Specifies the load balancer type(s) this validation request is for. + Use EXTERNAL_MANAGED for global external Application Load Balancers + and regional external Application Load Balancers. Use EXTERNAL for + classic Application Load Balancers. Use INTERNAL_MANAGED for + internal Application Load Balancers. For more information, refer to + Choosing a load balancer. If unspecified, the load balancing scheme + will be inferred from the backend service resources this URL map + references. If that can not be inferred (for example, this URL map + only references backend buckets, or this Url map is for rewrites and + redirects only and doesn't reference any backends), EXTERNAL will be + used as the default type. If specified, the scheme(s) must not + conflict with the load balancing scheme of the backend service + resources this Url map references. + type: array + items: + type: string + enumDescriptions: + - >- + Signifies that this will be used for classic Application Load + Balancers. + - >- + Signifies that this will be used for Envoy-based global external + Application Load Balancers. + - >- + If unspecified, the validation will try to infer the scheme from + the backend service resources this Url map references. If the + inference is not possible, EXTERNAL will be used as the default + type. + enum: + - EXTERNAL + - EXTERNAL_MANAGED + - LOAD_BALANCING_SCHEME_UNSPECIFIED + UrlMapsValidateResponse: + id: UrlMapsValidateResponse + type: object + properties: + result: + $ref: '#/components/schemas/UrlMapValidationResult' + UrlMapValidationResult: + id: UrlMapValidationResult + description: Message representing the validation result for a UrlMap. + type: object + properties: + loadSucceeded: + description: >- + Whether the given UrlMap can be successfully loaded. If false, + 'loadErrors' indicates the reasons. + type: boolean + loadErrors: + type: array + items: + type: string + testPassed: + description: >- + If successfully loaded, this field indicates whether the test + passed. If false, 'testFailures's indicate the reason of failure. + type: boolean + testFailures: + type: array + items: + $ref: '#/components/schemas/TestFailure' + TestFailure: + id: TestFailure + type: object + properties: + host: + description: Host portion of the URL. + type: string + path: + description: Path portion including query parameters in the URL. + type: string + headers: + description: HTTP headers of the request. + type: array + items: + $ref: '#/components/schemas/UrlMapTestHeader' + expectedService: + description: >- + Expected BackendService or BackendBucket resource the given URL + should be mapped to. + type: string + actualService: + description: BackendService or BackendBucket returned by load balancer. + type: string + expectedOutputUrl: + description: >- + The expected output URL evaluated by a load balancer containing the + scheme, host, path and query parameters. + type: string + actualOutputUrl: + description: >- + The actual output URL evaluated by a 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 + type: integer + format: int32 + actualRedirectResponseCode: + description: >- + Actual HTTP status code for rule with `urlRedirect` calculated by + load balancer + type: integer + format: int32 + CacheInvalidationRule: + id: CacheInvalidationRule + type: object + properties: + path: + type: string + host: + description: >- + If set, this invalidation rule will only apply to requests with a + Host header matching host. + type: string + cacheTags: + description: >- + A list of cache tags used to identify cached objects. - Cache tags + are specified when the response is first cached, by setting the + `Cache-Tag` response header at the origin. - Multiple cache tags in + the same invalidation request are treated as Boolean `OR` - for + example, `tag1 OR tag2 OR tag3`. - If other fields are also + specified, these are treated as Boolean `AND` with any tags. Up to + 10 tags can be specified in a single invalidation request. + type: array + items: + type: string + RegionUrlMapsValidateRequest: + id: RegionUrlMapsValidateRequest + type: object + properties: + resource: + description: Content of the UrlMap to be validated. + $ref: '#/components/schemas/UrlMap' + VpnGatewayList: + id: VpnGatewayList + description: Contains a list of VpnGateway resources. + type: object + properties: + kind: + description: >- + [Output Only] Type of resource. Always compute#vpnGateway for VPN + gateways. + default: compute#vpnGatewayList + type: string + id: + description: >- + [Output Only] Unique identifier for the resource; defined by the + server. + type: string + items: + description: A list of VpnGateway resources. + type: array + items: + $ref: '#/components/schemas/VpnGateway' + nextPageToken: + description: >- + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. + type: string + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string + warning: + description: '[Output Only] Informational warning message.' + type: object + properties: + code: + description: >- + [Output Only] A warning code, if applicable. For example, + Compute Engine returns NO_RESULTS_ON_PAGE if there are no + results in the response. + type: string + enumDescriptions: + - >- + Warning about failed cleanup of transient changes made by a + failed operation. + - A link to a deprecated resource was created. + - >- + When deploying and at least one of the resources has a type + marked as deprecated + - The user created a boot disk that is larger than image size. + - >- + When deploying and at least one of the resources has a type + marked as experimental + - Warning that is present in an external api call + - >- + Warning that value of a field has been overridden. Deprecated + unused field. + - >- + The operation involved use of an injected kernel, which is + deprecated. + - >- + A WEIGHTED_MAGLEV backend service is associated with a health + check that is not of type HTTP/HTTPS/HTTP2. + - >- + When deploying a deployment with a exceedingly large number of + resources + - >- + Resource can't be retrieved due to list overhead quota exceed + which captures the amount of resources filtered out by + user-defined list filter. + - A resource depends on a missing type + - >- + The route's nextHopIp address is not assigned to an instance + on the network. + - The route's next hop instance cannot ip forward. + - >- + The route's nextHopInstance URL refers to an instance that + does not have an ipv6 interface on the same network as the + route. + - >- + The route's nextHopInstance URL refers to an instance that + does not exist. + - >- + The route's nextHopInstance URL refers to an instance that is + not on the same network as the route. + - >- + The route's next hop instance does not have a status of + RUNNING. + - >- + Error which is not critical. We decided to continue the + process despite the mentioned error. + - No results are present on a particular list page. + - >- + Success is reported, but some results may be missing due to + errors + - >- + Quota information is not available to client requests (e.g: + regions.list). + - >- + The user attempted to use a resource that requires a TOS they + have not accepted. + - Warning that a resource is in use. + - >- + One or more of the resources set to auto-delete could not be + deleted because they were in use. + - When a resource schema validation is ignored. + - >- + Instance template used in instance group manager is valid as + such, but its application does not make a lot of sense, + because it allows only single instance in instance group. + - When undeclared properties in the schema are present + - A given scope cannot be reached. + enumDeprecated: + - false + - false + - false + - false + - false + - false + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + enum: + - CLEANUP_FAILED + - DEPRECATED_RESOURCE_USED + - DEPRECATED_TYPE_USED + - DISK_SIZE_LARGER_THAN_IMAGE_SIZE + - EXPERIMENTAL_TYPE_USED + - EXTERNAL_API_WARNING + - FIELD_VALUE_OVERRIDEN + - INJECTED_KERNELS_DEPRECATED + - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB + - LARGE_DEPLOYMENT_WARNING + - LIST_OVERHEAD_QUOTA_EXCEED + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE + - NEXT_HOP_INSTANCE_NOT_FOUND + - NEXT_HOP_INSTANCE_NOT_ON_NETWORK + - NEXT_HOP_NOT_RUNNING + - NOT_CRITICAL_ERROR + - NO_RESULTS_ON_PAGE + - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE + - REQUIRED_TOS_AGREEMENT + - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING + - RESOURCE_NOT_DELETED + - SCHEMA_VALIDATION_IGNORED + - SINGLE_INSTANCE_PROPERTY_TEMPLATE + - UNDECLARED_PROPERTIES + - UNREACHABLE + message: + description: '[Output Only] A human-readable description of the warning code.' + type: string + data: + description: >- + [Output Only] Metadata about this warning in key: value format. + For example: "data": [ { "key": "scope", "value": + "zones/us-east1-d" } + type: array + items: + type: object + properties: + key: + description: >- + [Output Only] A key that provides more detail on the + warning being returned. For example, for warnings where + there are no results in a list request for a particular + zone, this key might be scope and the key value might be + the zone name. Other examples might be a key indicating a + deprecated resource and a suggested replacement, or a + warning about invalid network settings (for example, if an + instance attempts to perform IP forwarding but is not + enabled for IP forwarding). + type: string + value: + description: >- + [Output Only] A warning data value corresponding to the + key. + type: string + VpnGateway: + id: 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 . + type: object + properties: + kind: + description: >- + [Output Only] Type of resource. Always compute#vpnGateway for VPN + gateways. + default: compute#vpnGateway + type: string + id: + description: >- + [Output Only] The unique identifier for the resource. This + identifier is defined by the server. + type: string + format: uint64 + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + 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])?' + annotations: + required: + - compute.vpnGateways.insert + type: string + description: + description: >- + An optional description of this resource. Provide this property when + you create the resource. + type: string + region: + description: '[Output Only] URL of the region where the VPN gateway resides.' + 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. + annotations: + required: + - compute.vpnGateways.insert + type: string + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + type: string + labels: + 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 + additionalProperties: + 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 a VpnGateway. + type: string + format: byte + vpnInterfaces: + description: The list of VPN interfaces associated with this VPN gateway. + type: array + items: + $ref: '#/components/schemas/VpnGatewayVpnGatewayInterface' + stackType: + description: >- + The stack type for this VPN gateway to identify the IP protocols + that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6, + IPV6_ONLY. If not specified, IPV4_ONLY is used if the gateway IP + version is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6. + type: string + enumDescriptions: + - Enable VPN gateway with both IPv4 and IPv6 protocols. + - Enable VPN gateway with only IPv4 protocol. + - Enable VPN gateway with only IPv6 protocol. + enum: + - IPV4_IPV6 + - IPV4_ONLY + - IPV6_ONLY + gatewayIpVersion: + description: >- + The IP family of the gateway IPs for the HA-VPN gateway interfaces. + If not specified, IPV4 will be used. + type: string + enumDescriptions: + - Every HA-VPN gateway interface is configured with an IPv4 address. + - Every HA-VPN gateway interface is configured with an IPv6 address. + enum: + - IPV4 + - IPV6 + VpnGatewayVpnGatewayInterface: + id: VpnGatewayVpnGatewayInterface + description: A VPN gateway interface. + type: object + properties: + id: + description: >- + [Output Only] Numeric identifier for this VPN interface associated + with the VPN gateway. + type: integer + format: uint32 + 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 HA VPN over Cloud + Interconnect, the IP addresses for both interfaces could either be + regional internal IP addresses or regional external IP addresses. + For regular (non HA VPN over Cloud Interconnect) HA VPN tunnels, the + IP address must be a regional external IP address. + type: string + ipv6Address: + description: >- + [Output Only] IPv6 address for this VPN interface associated with + the VPN gateway. The IPv6 address must be a regional external IPv6 + address. The format is RFC 5952 format (e.g. 2001:db8::2d9:51:0:0). + type: string + 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 HA VPN over Cloud Interconnect; all + egress or ingress traffic for this VPN gateway interface goes + through the specified VLAN attachment resource. + type: string + VpnGatewayAggregatedList: + id: VpnGatewayAggregatedList + type: object + properties: + kind: + description: >- + [Output Only] Type of resource. Always compute#vpnGateway for VPN + gateways. + default: compute#vpnGatewayAggregatedList + type: string + id: + description: >- + [Output Only] Unique identifier for the resource; defined by the + server. + type: string + items: + description: A list of VpnGateway resources. + type: object + additionalProperties: + description: >- + [Output Only] Name of the scope containing this set of VPN + gateways. + $ref: '#/components/schemas/VpnGatewaysScopedList' + nextPageToken: + description: >- + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. + type: string + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string + warning: + description: '[Output Only] Informational warning message.' + type: object + properties: + code: + description: >- + [Output Only] A warning code, if applicable. For example, + Compute Engine returns NO_RESULTS_ON_PAGE if there are no + results in the response. + type: string + enumDescriptions: + - >- + Warning about failed cleanup of transient changes made by a + failed operation. + - A link to a deprecated resource was created. + - >- + When deploying and at least one of the resources has a type + marked as deprecated + - The user created a boot disk that is larger than image size. + - >- + When deploying and at least one of the resources has a type + marked as experimental + - Warning that is present in an external api call + - >- + Warning that value of a field has been overridden. Deprecated + unused field. + - >- + The operation involved use of an injected kernel, which is + deprecated. + - >- + A WEIGHTED_MAGLEV backend service is associated with a health + check that is not of type HTTP/HTTPS/HTTP2. + - >- + When deploying a deployment with a exceedingly large number of + resources + - >- + Resource can't be retrieved due to list overhead quota exceed + which captures the amount of resources filtered out by + user-defined list filter. + - A resource depends on a missing type + - >- + The route's nextHopIp address is not assigned to an instance + on the network. + - The route's next hop instance cannot ip forward. + - >- + The route's nextHopInstance URL refers to an instance that + does not have an ipv6 interface on the same network as the + route. + - >- + The route's nextHopInstance URL refers to an instance that + does not exist. + - >- + The route's nextHopInstance URL refers to an instance that is + not on the same network as the route. + - >- + The route's next hop instance does not have a status of + RUNNING. + - >- + Error which is not critical. We decided to continue the + process despite the mentioned error. + - No results are present on a particular list page. + - >- + Success is reported, but some results may be missing due to + errors + - >- + Quota information is not available to client requests (e.g: + regions.list). + - >- + The user attempted to use a resource that requires a TOS they + have not accepted. + - Warning that a resource is in use. + - >- + One or more of the resources set to auto-delete could not be + deleted because they were in use. + - When a resource schema validation is ignored. + - >- + Instance template used in instance group manager is valid as + such, but its application does not make a lot of sense, + because it allows only single instance in instance group. + - When undeclared properties in the schema are present + - A given scope cannot be reached. + enumDeprecated: + - false + - false + - false + - false + - false + - false + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + enum: + - CLEANUP_FAILED + - DEPRECATED_RESOURCE_USED + - DEPRECATED_TYPE_USED + - DISK_SIZE_LARGER_THAN_IMAGE_SIZE + - EXPERIMENTAL_TYPE_USED + - EXTERNAL_API_WARNING + - FIELD_VALUE_OVERRIDEN + - INJECTED_KERNELS_DEPRECATED + - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB + - LARGE_DEPLOYMENT_WARNING + - LIST_OVERHEAD_QUOTA_EXCEED + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE + - NEXT_HOP_INSTANCE_NOT_FOUND + - NEXT_HOP_INSTANCE_NOT_ON_NETWORK + - NEXT_HOP_NOT_RUNNING + - NOT_CRITICAL_ERROR + - NO_RESULTS_ON_PAGE + - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE + - REQUIRED_TOS_AGREEMENT + - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING + - RESOURCE_NOT_DELETED + - SCHEMA_VALIDATION_IGNORED + - SINGLE_INSTANCE_PROPERTY_TEMPLATE + - UNDECLARED_PROPERTIES + - UNREACHABLE + message: + description: '[Output Only] A human-readable description of the warning code.' + type: string + data: + description: >- + [Output Only] Metadata about this warning in key: value format. + For example: "data": [ { "key": "scope", "value": + "zones/us-east1-d" } + type: array + items: + type: object + properties: + key: + description: >- + [Output Only] A key that provides more detail on the + warning being returned. For example, for warnings where + there are no results in a list request for a particular + zone, this key might be scope and the key value might be + the zone name. Other examples might be a key indicating a + deprecated resource and a suggested replacement, or a + warning about invalid network settings (for example, if an + instance attempts to perform IP forwarding but is not + enabled for IP forwarding). + type: string + value: + description: >- + [Output Only] A warning data value corresponding to the + key. + type: string + unreachables: + description: '[Output Only] Unreachable resources.' + type: array + items: + type: string + VpnGatewaysScopedList: + id: VpnGatewaysScopedList + type: object + properties: + vpnGateways: + description: '[Output Only] A list of VPN gateways contained in this scope.' + type: array + items: + $ref: '#/components/schemas/VpnGateway' + warning: + description: >- + [Output Only] Informational warning which replaces the list of + addresses when the list is empty. + type: object + properties: + code: + description: >- + [Output Only] A warning code, if applicable. For example, + Compute Engine returns NO_RESULTS_ON_PAGE if there are no + results in the response. + type: string + enumDescriptions: + - >- + Warning about failed cleanup of transient changes made by a + failed operation. + - A link to a deprecated resource was created. + - >- + When deploying and at least one of the resources has a type + marked as deprecated + - The user created a boot disk that is larger than image size. + - >- + When deploying and at least one of the resources has a type + marked as experimental + - Warning that is present in an external api call + - >- + Warning that value of a field has been overridden. Deprecated + unused field. + - >- + The operation involved use of an injected kernel, which is + deprecated. + - >- + A WEIGHTED_MAGLEV backend service is associated with a health + check that is not of type HTTP/HTTPS/HTTP2. + - >- + When deploying a deployment with a exceedingly large number of + resources + - >- + Resource can't be retrieved due to list overhead quota exceed + which captures the amount of resources filtered out by + user-defined list filter. + - A resource depends on a missing type + - >- + The route's nextHopIp address is not assigned to an instance + on the network. + - The route's next hop instance cannot ip forward. + - >- + The route's nextHopInstance URL refers to an instance that + does not have an ipv6 interface on the same network as the + route. + - >- + The route's nextHopInstance URL refers to an instance that + does not exist. + - >- + The route's nextHopInstance URL refers to an instance that is + not on the same network as the route. + - >- + The route's next hop instance does not have a status of + RUNNING. + - >- + Error which is not critical. We decided to continue the + process despite the mentioned error. + - No results are present on a particular list page. + - >- + Success is reported, but some results may be missing due to + errors + - >- + Quota information is not available to client requests (e.g: + regions.list). + - >- + The user attempted to use a resource that requires a TOS they + have not accepted. + - Warning that a resource is in use. + - >- + One or more of the resources set to auto-delete could not be + deleted because they were in use. + - When a resource schema validation is ignored. + - >- + Instance template used in instance group manager is valid as + such, but its application does not make a lot of sense, + because it allows only single instance in instance group. + - When undeclared properties in the schema are present + - A given scope cannot be reached. + enumDeprecated: + - false + - false + - false + - false + - false + - false + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + enum: + - CLEANUP_FAILED + - DEPRECATED_RESOURCE_USED + - DEPRECATED_TYPE_USED + - DISK_SIZE_LARGER_THAN_IMAGE_SIZE + - EXPERIMENTAL_TYPE_USED + - EXTERNAL_API_WARNING + - FIELD_VALUE_OVERRIDEN + - INJECTED_KERNELS_DEPRECATED + - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB + - LARGE_DEPLOYMENT_WARNING + - LIST_OVERHEAD_QUOTA_EXCEED + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE + - NEXT_HOP_INSTANCE_NOT_FOUND + - NEXT_HOP_INSTANCE_NOT_ON_NETWORK + - NEXT_HOP_NOT_RUNNING + - NOT_CRITICAL_ERROR + - NO_RESULTS_ON_PAGE + - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE + - REQUIRED_TOS_AGREEMENT + - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING + - RESOURCE_NOT_DELETED + - SCHEMA_VALIDATION_IGNORED + - SINGLE_INSTANCE_PROPERTY_TEMPLATE + - UNDECLARED_PROPERTIES + - UNREACHABLE + message: + description: '[Output Only] A human-readable description of the warning code.' + type: string + data: + description: >- + [Output Only] Metadata about this warning in key: value format. + For example: "data": [ { "key": "scope", "value": + "zones/us-east1-d" } + type: array + items: + type: object + properties: + key: + description: >- + [Output Only] A key that provides more detail on the + warning being returned. For example, for warnings where + there are no results in a list request for a particular + zone, this key might be scope and the key value might be + the zone name. Other examples might be a key indicating a + deprecated resource and a suggested replacement, or a + warning about invalid network settings (for example, if an + instance attempts to perform IP forwarding but is not + enabled for IP forwarding). + type: string + value: + description: >- + [Output Only] A warning data value corresponding to the + key. + type: string + VpnGatewaysGetStatusResponse: + id: VpnGatewaysGetStatusResponse + type: object + properties: + result: + $ref: '#/components/schemas/VpnGatewayStatus' + VpnGatewayStatus: + id: VpnGatewayStatus + type: object + properties: + vpnConnections: + description: List of VPN connection for this VpnGateway. + type: array + items: + $ref: '#/components/schemas/VpnGatewayStatusVpnConnection' + VpnGatewayStatusVpnConnection: + id: VpnGatewayStatusVpnConnection + description: >- + A VPN connection contains all VPN tunnels connected from this VpnGateway + to the same peer gateway. The peer gateway could either be an external + VPN gateway or a Google Cloud VPN gateway. + type: object + 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 + tunnels: + description: List of VPN tunnels that are in this VPN connection. + type: array + items: + $ref: '#/components/schemas/VpnGatewayStatusTunnel' + state: + description: HighAvailabilityRequirementState for the VPN connection. + $ref: >- + #/components/schemas/VpnGatewayStatusHighAvailabilityRequirementState + VpnGatewayStatusTunnel: + id: VpnGatewayStatusTunnel + description: Contains some information about a VPN tunnel. + type: object + properties: + localGatewayInterface: + description: The VPN gateway interface this VPN tunnel is associated with. + type: integer + format: uint32 + peerGatewayInterface: + description: >- + The peer gateway interface this VPN tunnel is connected to, the peer + gateway could either be an external VPN gateway or a Google Cloud + VPN gateway. + type: integer + format: uint32 + tunnelUrl: + description: URL reference to the VPN tunnel. + type: string + VpnGatewayStatusHighAvailabilityRequirementState: + id: VpnGatewayStatusHighAvailabilityRequirementState + description: >- + Describes the high availability requirement state for the VPN connection + between this Cloud VPN gateway and a peer gateway. + type: object + properties: + state: + description: >- + Indicates the high availability requirement state for the VPN + connection. Valid values are CONNECTION_REDUNDANCY_MET, + CONNECTION_REDUNDANCY_NOT_MET. + type: string + enumDescriptions: + - >- + VPN tunnels are configured with adequate redundancy from Cloud VPN + gateway to the peer VPN gateway. For both GCP-to-non-GCP and + GCP-to-GCP connections, the adequate redundancy is a + pre-requirement for users to get 99.99% availability on GCP side; + please note that for any connection, end-to-end 99.99% + availability is subject to proper configuration on the peer VPN + gateway. + - >- + VPN tunnels are not configured with adequate redundancy from the + Cloud VPN gateway to the peer gateway + enum: + - CONNECTION_REDUNDANCY_MET + - CONNECTION_REDUNDANCY_NOT_MET + unsatisfiedReason: + description: >- + Indicates the reason why the VPN connection does not meet the high + availability redundancy criteria/requirement. Valid values is + INCOMPLETE_TUNNELS_COVERAGE. + type: string + enumDescriptions: + - '' + enum: + - INCOMPLETE_TUNNELS_COVERAGE + VpnTunnelList: + id: VpnTunnelList + description: Contains a list of VpnTunnel resources. + type: object + properties: + kind: + description: >- + [Output Only] Type of resource. Always compute#vpnTunnel for VPN + tunnels. + default: compute#vpnTunnelList + type: string + id: + description: >- + [Output Only] Unique identifier for the resource; defined by the + server. + type: string + items: + description: A list of VpnTunnel resources. + type: array + items: + $ref: '#/components/schemas/VpnTunnel' + nextPageToken: + description: >- + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. + type: string + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string + warning: + description: '[Output Only] Informational warning message.' + type: object + properties: + code: + description: >- + [Output Only] A warning code, if applicable. For example, + Compute Engine returns NO_RESULTS_ON_PAGE if there are no + results in the response. + type: string + enumDescriptions: + - >- + Warning about failed cleanup of transient changes made by a + failed operation. + - A link to a deprecated resource was created. + - >- + When deploying and at least one of the resources has a type + marked as deprecated + - The user created a boot disk that is larger than image size. + - >- + When deploying and at least one of the resources has a type + marked as experimental + - Warning that is present in an external api call + - >- + Warning that value of a field has been overridden. Deprecated + unused field. + - >- + The operation involved use of an injected kernel, which is + deprecated. + - >- + A WEIGHTED_MAGLEV backend service is associated with a health + check that is not of type HTTP/HTTPS/HTTP2. + - >- + When deploying a deployment with a exceedingly large number of + resources + - >- + Resource can't be retrieved due to list overhead quota exceed + which captures the amount of resources filtered out by + user-defined list filter. + - A resource depends on a missing type + - >- + The route's nextHopIp address is not assigned to an instance + on the network. + - The route's next hop instance cannot ip forward. + - >- + The route's nextHopInstance URL refers to an instance that + does not have an ipv6 interface on the same network as the + route. + - >- + The route's nextHopInstance URL refers to an instance that + does not exist. + - >- + The route's nextHopInstance URL refers to an instance that is + not on the same network as the route. + - >- + The route's next hop instance does not have a status of + RUNNING. + - >- + Error which is not critical. We decided to continue the + process despite the mentioned error. + - No results are present on a particular list page. + - >- + Success is reported, but some results may be missing due to + errors + - >- + Quota information is not available to client requests (e.g: + regions.list). + - >- + The user attempted to use a resource that requires a TOS they + have not accepted. + - Warning that a resource is in use. + - >- + One or more of the resources set to auto-delete could not be + deleted because they were in use. + - When a resource schema validation is ignored. + - >- + Instance template used in instance group manager is valid as + such, but its application does not make a lot of sense, + because it allows only single instance in instance group. + - When undeclared properties in the schema are present + - A given scope cannot be reached. + enumDeprecated: + - false + - false + - false + - false + - false + - false + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + enum: + - CLEANUP_FAILED + - DEPRECATED_RESOURCE_USED + - DEPRECATED_TYPE_USED + - DISK_SIZE_LARGER_THAN_IMAGE_SIZE + - EXPERIMENTAL_TYPE_USED + - EXTERNAL_API_WARNING + - FIELD_VALUE_OVERRIDEN + - INJECTED_KERNELS_DEPRECATED + - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB + - LARGE_DEPLOYMENT_WARNING + - LIST_OVERHEAD_QUOTA_EXCEED + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE + - NEXT_HOP_INSTANCE_NOT_FOUND + - NEXT_HOP_INSTANCE_NOT_ON_NETWORK + - NEXT_HOP_NOT_RUNNING + - NOT_CRITICAL_ERROR + - NO_RESULTS_ON_PAGE + - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE + - REQUIRED_TOS_AGREEMENT + - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING + - RESOURCE_NOT_DELETED + - SCHEMA_VALIDATION_IGNORED + - SINGLE_INSTANCE_PROPERTY_TEMPLATE + - UNDECLARED_PROPERTIES + - UNREACHABLE + message: + description: '[Output Only] A human-readable description of the warning code.' + type: string + data: + description: >- + [Output Only] Metadata about this warning in key: value format. + For example: "data": [ { "key": "scope", "value": + "zones/us-east1-d" } + type: array + items: + type: object + properties: + key: + description: >- + [Output Only] A key that provides more detail on the + warning being returned. For example, for warnings where + there are no results in a list request for a particular + zone, this key might be scope and the key value might be + the zone name. Other examples might be a key indicating a + deprecated resource and a suggested replacement, or a + warning about invalid network settings (for example, if an + instance attempts to perform IP forwarding but is not + enabled for IP forwarding). + type: string + value: + description: >- + [Output Only] A warning data value corresponding to the + key. + type: string + VpnTunnel: + id: VpnTunnel + description: >- + Represents a Cloud VPN Tunnel resource. For more information about VPN, + read the the Cloud VPN Overview. + type: object + properties: + kind: + description: >- + [Output Only] Type of resource. Always compute#vpnTunnel for VPN + tunnels. + default: compute#vpnTunnel + type: string + id: + description: >- + [Output Only] The unique identifier for the resource. This + identifier is defined by the server. + type: string + format: uint64 + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + 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])?' + annotations: + required: + - compute.vpnTunnels.insert + type: string + description: + description: >- + An optional description of this resource. Provide this property when + you create the resource. + 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 + 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. + This field can be set only for Classic VPN tunnels. + 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. Possible values are: `0`, `1`. + type: integer + format: int32 + 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. Possible values are: `0`, `1`, `2`, `3`. The number of IDs + in use depends on the external VPN gateway redundancy type. + type: integer + format: int32 + peerGcpGateway: + description: >- + URL of the peer side HA 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 Google Cloud VPN + gateway. + type: string + router: + description: URL of the router resource to be used for dynamic routing. + type: string + peerIp: + description: >- + IP address of the peer VPN gateway. Only IPv4 is supported. This + field can be set only for Classic VPN tunnels. + 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. + type: string + enumDescriptions: + - >- + Cloud VPN is in the process of allocating all required resources + (specifically, a borg task). + - Auth error (e.g. bad shared secret). + - Resources is being deallocated for the VPN tunnel. + - Secure session is successfully established with peer VPN. + - Tunnel creation has failed and the tunnel is not ready to be used. + - Successful first handshake with peer VPN. + - Handshake failed. + - Deprecated, replaced by NO_INCOMING_PACKETS + - No incoming packets from peer + - Resource is being allocated for the VPN tunnel. + - >- + Tunnel configuration was rejected, can be result of being + denylisted. + - Tunnel is stopped due to its Forwarding Rules being deleted. + - >- + Waiting to receive all VPN-related configs from user. Network, + TargetVpnGateway, VpnTunnel, ForwardingRule and Route resources + are needed to setup 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 + selfLink: + description: '[Output Only] Server-defined URL for the resource.' + 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. + type: integer + format: int32 + detailedStatus: + description: '[Output Only] Detailed status message for the VPN tunnel.' + 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 for Classic VPN tunnels. This field is output only for + HA VPN tunnels. + type: array + items: + 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 for Classic VPN tunnels. This field is output + only for HA VPN tunnels. + type: array + items: + type: string + labels: + 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 + additionalProperties: + type: string + labelFingerprint: + description: >- + A fingerprint for the labels being applied to this VpnTunnel, 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 VpnTunnel. + type: string + format: byte + VpnTunnelAggregatedList: + id: VpnTunnelAggregatedList + type: object + properties: + kind: + description: >- + [Output Only] Type of resource. Always compute#vpnTunnel for VPN + tunnels. + default: compute#vpnTunnelAggregatedList + type: string + id: + description: >- + [Output Only] Unique identifier for the resource; defined by the + server. + type: string + items: + description: A list of VpnTunnelsScopedList resources. + type: object + additionalProperties: + description: Name of the scope containing this set of VPN tunnels. + $ref: '#/components/schemas/VpnTunnelsScopedList' + nextPageToken: + description: >- + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. + type: string + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string + warning: + description: '[Output Only] Informational warning message.' + type: object + properties: + code: + description: >- + [Output Only] A warning code, if applicable. For example, + Compute Engine returns NO_RESULTS_ON_PAGE if there are no + results in the response. + type: string + enumDescriptions: + - >- + Warning about failed cleanup of transient changes made by a + failed operation. + - A link to a deprecated resource was created. + - >- + When deploying and at least one of the resources has a type + marked as deprecated + - The user created a boot disk that is larger than image size. + - >- + When deploying and at least one of the resources has a type + marked as experimental + - Warning that is present in an external api call + - >- + Warning that value of a field has been overridden. Deprecated + unused field. + - >- + The operation involved use of an injected kernel, which is + deprecated. + - >- + A WEIGHTED_MAGLEV backend service is associated with a health + check that is not of type HTTP/HTTPS/HTTP2. + - >- + When deploying a deployment with a exceedingly large number of + resources + - >- + Resource can't be retrieved due to list overhead quota exceed + which captures the amount of resources filtered out by + user-defined list filter. + - A resource depends on a missing type + - >- + The route's nextHopIp address is not assigned to an instance + on the network. + - The route's next hop instance cannot ip forward. + - >- + The route's nextHopInstance URL refers to an instance that + does not have an ipv6 interface on the same network as the + route. + - >- + The route's nextHopInstance URL refers to an instance that + does not exist. + - >- + The route's nextHopInstance URL refers to an instance that is + not on the same network as the route. + - >- + The route's next hop instance does not have a status of + RUNNING. + - >- + Error which is not critical. We decided to continue the + process despite the mentioned error. + - No results are present on a particular list page. + - >- + Success is reported, but some results may be missing due to + errors + - >- + Quota information is not available to client requests (e.g: + regions.list). + - >- + The user attempted to use a resource that requires a TOS they + have not accepted. + - Warning that a resource is in use. + - >- + One or more of the resources set to auto-delete could not be + deleted because they were in use. + - When a resource schema validation is ignored. + - >- + Instance template used in instance group manager is valid as + such, but its application does not make a lot of sense, + because it allows only single instance in instance group. + - When undeclared properties in the schema are present + - A given scope cannot be reached. + enumDeprecated: + - false + - false + - false + - false + - false + - false + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + enum: + - CLEANUP_FAILED + - DEPRECATED_RESOURCE_USED + - DEPRECATED_TYPE_USED + - DISK_SIZE_LARGER_THAN_IMAGE_SIZE + - EXPERIMENTAL_TYPE_USED + - EXTERNAL_API_WARNING + - FIELD_VALUE_OVERRIDEN + - INJECTED_KERNELS_DEPRECATED + - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB + - LARGE_DEPLOYMENT_WARNING + - LIST_OVERHEAD_QUOTA_EXCEED + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE + - NEXT_HOP_INSTANCE_NOT_FOUND + - NEXT_HOP_INSTANCE_NOT_ON_NETWORK + - NEXT_HOP_NOT_RUNNING + - NOT_CRITICAL_ERROR + - NO_RESULTS_ON_PAGE + - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE + - REQUIRED_TOS_AGREEMENT + - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING + - RESOURCE_NOT_DELETED + - SCHEMA_VALIDATION_IGNORED + - SINGLE_INSTANCE_PROPERTY_TEMPLATE + - UNDECLARED_PROPERTIES + - UNREACHABLE + message: + description: '[Output Only] A human-readable description of the warning code.' + type: string + data: + description: >- + [Output Only] Metadata about this warning in key: value format. + For example: "data": [ { "key": "scope", "value": + "zones/us-east1-d" } + type: array + items: + type: object + properties: + key: + description: >- + [Output Only] A key that provides more detail on the + warning being returned. For example, for warnings where + there are no results in a list request for a particular + zone, this key might be scope and the key value might be + the zone name. Other examples might be a key indicating a + deprecated resource and a suggested replacement, or a + warning about invalid network settings (for example, if an + instance attempts to perform IP forwarding but is not + enabled for IP forwarding). + type: string + value: + description: >- + [Output Only] A warning data value corresponding to the + key. + type: string + unreachables: + description: '[Output Only] Unreachable resources.' + type: array + items: + type: string + VpnTunnelsScopedList: + id: VpnTunnelsScopedList + type: object + properties: + vpnTunnels: + description: A list of VPN tunnels contained in this scope. + type: array + items: + $ref: '#/components/schemas/VpnTunnel' + warning: + description: >- + Informational warning which replaces the list of addresses when the + list is empty. + type: object + properties: + code: + description: >- + [Output Only] A warning code, if applicable. For example, + Compute Engine returns NO_RESULTS_ON_PAGE if there are no + results in the response. + type: string + enumDescriptions: + - >- + Warning about failed cleanup of transient changes made by a + failed operation. + - A link to a deprecated resource was created. + - >- + When deploying and at least one of the resources has a type + marked as deprecated + - The user created a boot disk that is larger than image size. + - >- + When deploying and at least one of the resources has a type + marked as experimental + - Warning that is present in an external api call + - >- + Warning that value of a field has been overridden. Deprecated + unused field. + - >- + The operation involved use of an injected kernel, which is + deprecated. + - >- + A WEIGHTED_MAGLEV backend service is associated with a health + check that is not of type HTTP/HTTPS/HTTP2. + - >- + When deploying a deployment with a exceedingly large number of + resources + - >- + Resource can't be retrieved due to list overhead quota exceed + which captures the amount of resources filtered out by + user-defined list filter. + - A resource depends on a missing type + - >- + The route's nextHopIp address is not assigned to an instance + on the network. + - The route's next hop instance cannot ip forward. + - >- + The route's nextHopInstance URL refers to an instance that + does not have an ipv6 interface on the same network as the + route. + - >- + The route's nextHopInstance URL refers to an instance that + does not exist. + - >- + The route's nextHopInstance URL refers to an instance that is + not on the same network as the route. + - >- + The route's next hop instance does not have a status of + RUNNING. + - >- + Error which is not critical. We decided to continue the + process despite the mentioned error. + - No results are present on a particular list page. + - >- + Success is reported, but some results may be missing due to + errors + - >- + Quota information is not available to client requests (e.g: + regions.list). + - >- + The user attempted to use a resource that requires a TOS they + have not accepted. + - Warning that a resource is in use. + - >- + One or more of the resources set to auto-delete could not be + deleted because they were in use. + - When a resource schema validation is ignored. + - >- + Instance template used in instance group manager is valid as + such, but its application does not make a lot of sense, + because it allows only single instance in instance group. + - When undeclared properties in the schema are present + - A given scope cannot be reached. + enumDeprecated: + - false + - false + - false + - false + - false + - false + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + enum: + - CLEANUP_FAILED + - DEPRECATED_RESOURCE_USED + - DEPRECATED_TYPE_USED + - DISK_SIZE_LARGER_THAN_IMAGE_SIZE + - EXPERIMENTAL_TYPE_USED + - EXTERNAL_API_WARNING + - FIELD_VALUE_OVERRIDEN + - INJECTED_KERNELS_DEPRECATED + - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB + - LARGE_DEPLOYMENT_WARNING + - LIST_OVERHEAD_QUOTA_EXCEED + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE + - NEXT_HOP_INSTANCE_NOT_FOUND + - NEXT_HOP_INSTANCE_NOT_ON_NETWORK + - NEXT_HOP_NOT_RUNNING + - NOT_CRITICAL_ERROR + - NO_RESULTS_ON_PAGE + - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE + - REQUIRED_TOS_AGREEMENT + - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING + - RESOURCE_NOT_DELETED + - SCHEMA_VALIDATION_IGNORED + - SINGLE_INSTANCE_PROPERTY_TEMPLATE + - UNDECLARED_PROPERTIES + - UNREACHABLE + message: + description: '[Output Only] A human-readable description of the warning code.' + type: string + data: + description: >- + [Output Only] Metadata about this warning in key: value format. + For example: "data": [ { "key": "scope", "value": + "zones/us-east1-d" } + type: array + items: + type: object + properties: + key: + description: >- + [Output Only] A key that provides more detail on the + warning being returned. For example, for warnings where + there are no results in a list request for a particular + zone, this key might be scope and the key value might be + the zone name. Other examples might be a key indicating a + deprecated resource and a suggested replacement, or a + warning about invalid network settings (for example, if an + instance attempts to perform IP forwarding but is not + enabled for IP forwarding). + type: string + value: + description: >- + [Output Only] A warning data value corresponding to the + key. + type: string + ZoneList: + id: ZoneList + description: Contains a list of zone resources. + type: object + properties: + kind: + description: Type of resource. + default: compute#zoneList + type: string + id: + description: >- + [Output Only] Unique identifier for the resource; defined by the + server. + type: string + items: + description: A list of Zone resources. + type: array + items: + $ref: '#/components/schemas/Zone' + nextPageToken: + description: >- + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. + type: string + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string + warning: + description: '[Output Only] Informational warning message.' + type: object + properties: + code: + description: >- + [Output Only] A warning code, if applicable. For example, + Compute Engine returns NO_RESULTS_ON_PAGE if there are no + results in the response. + type: string + enumDescriptions: + - >- + Warning about failed cleanup of transient changes made by a + failed operation. + - A link to a deprecated resource was created. + - >- + When deploying and at least one of the resources has a type + marked as deprecated + - The user created a boot disk that is larger than image size. + - >- + When deploying and at least one of the resources has a type + marked as experimental + - Warning that is present in an external api call + - >- + Warning that value of a field has been overridden. Deprecated + unused field. + - >- + The operation involved use of an injected kernel, which is + deprecated. + - >- + A WEIGHTED_MAGLEV backend service is associated with a health + check that is not of type HTTP/HTTPS/HTTP2. + - >- + When deploying a deployment with a exceedingly large number of + resources + - >- + Resource can't be retrieved due to list overhead quota exceed + which captures the amount of resources filtered out by + user-defined list filter. + - A resource depends on a missing type + - >- + The route's nextHopIp address is not assigned to an instance + on the network. + - The route's next hop instance cannot ip forward. + - >- + The route's nextHopInstance URL refers to an instance that + does not have an ipv6 interface on the same network as the + route. + - >- + The route's nextHopInstance URL refers to an instance that + does not exist. + - >- + The route's nextHopInstance URL refers to an instance that is + not on the same network as the route. + - >- + The route's next hop instance does not have a status of + RUNNING. + - >- + Error which is not critical. We decided to continue the + process despite the mentioned error. + - No results are present on a particular list page. + - >- + Success is reported, but some results may be missing due to + errors + - >- + Quota information is not available to client requests (e.g: + regions.list). + - >- + The user attempted to use a resource that requires a TOS they + have not accepted. + - Warning that a resource is in use. + - >- + One or more of the resources set to auto-delete could not be + deleted because they were in use. + - When a resource schema validation is ignored. + - >- + Instance template used in instance group manager is valid as + such, but its application does not make a lot of sense, + because it allows only single instance in instance group. + - When undeclared properties in the schema are present + - A given scope cannot be reached. + enumDeprecated: + - false + - false + - false + - false + - false + - false + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + enum: + - CLEANUP_FAILED + - DEPRECATED_RESOURCE_USED + - DEPRECATED_TYPE_USED + - DISK_SIZE_LARGER_THAN_IMAGE_SIZE + - EXPERIMENTAL_TYPE_USED + - EXTERNAL_API_WARNING + - FIELD_VALUE_OVERRIDEN + - INJECTED_KERNELS_DEPRECATED + - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB + - LARGE_DEPLOYMENT_WARNING + - LIST_OVERHEAD_QUOTA_EXCEED + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE + - NEXT_HOP_INSTANCE_NOT_FOUND + - NEXT_HOP_INSTANCE_NOT_ON_NETWORK + - NEXT_HOP_NOT_RUNNING + - NOT_CRITICAL_ERROR + - NO_RESULTS_ON_PAGE + - PARTIAL_SUCCESS + - QUOTA_INFO_UNAVAILABLE + - REQUIRED_TOS_AGREEMENT + - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING + - RESOURCE_NOT_DELETED + - SCHEMA_VALIDATION_IGNORED + - SINGLE_INSTANCE_PROPERTY_TEMPLATE + - UNDECLARED_PROPERTIES + - UNREACHABLE + message: + description: '[Output Only] A human-readable description of the warning code.' + type: string + data: + description: >- + [Output Only] Metadata about this warning in key: value format. + For example: "data": [ { "key": "scope", "value": + "zones/us-east1-d" } + type: array + items: + type: object + properties: + key: + description: >- + [Output Only] A key that provides more detail on the + warning being returned. For example, for warnings where + there are no results in a list request for a particular + zone, this key might be scope and the key value might be + the zone name. Other examples might be a key indicating a + deprecated resource and a suggested replacement, or a + warning about invalid network settings (for example, if an + instance attempts to perform IP forwarding but is not + enabled for IP forwarding). + type: string + value: + description: >- + [Output Only] A warning data value corresponding to the + key. + type: string + Zone: + id: 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-b is located in the us-east1 region. For more information, read + Regions and Zones. + type: object + properties: + kind: + description: '[Output Only] Type of the resource. Always compute#zone for zones.' + default: compute#zone + type: string + id: + description: >- + [Output Only] The unique identifier for the resource. This + identifier is defined by the server. + type: string + format: uint64 + creationTimestamp: + description: '[Output Only] Creation timestamp in RFC3339 text format.' + type: string + name: + description: '[Output Only] Name of the resource.' + type: string + description: + description: '[Output Only] Textual description of the resource.' + type: string + status: + description: '[Output Only] Status of the zone, either UP or DOWN.' + type: string + enumDescriptions: + - '' + - '' + enum: + - DOWN + - UP + deprecated: + description: '[Output Only] The deprecation status associated with this zone.' + $ref: '#/components/schemas/DeprecationStatus' + 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 + availableCpuPlatforms: + description: '[Output Only] Available cpu/platform selections for the zone.' + type: array + items: + type: string + supportsPzs: + description: '[Output Only] Reserved for future use.' + type: boolean + parameters: + 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: + type: string + enum: + - json + - media + - proto + 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 + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + userIp: + description: Legacy name for parameter that has been superseded by `quotaUser`. + in: query + name: userIp + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + x-stackQL-resources: + operations: + id: google.compute.operations + name: operations + title: Operations methods: list: operation: - $ref: '#/paths/~1projects~1{project}~1zones~1{zone}~1operations/get' + $ref: '#/paths/~1projects~1{project}~1regions~1{region}~1operations/get' response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1operations~1{operation}/get + #/paths/~1projects~1{project}~1regions~1{region}~1operations~1{operation}/get response: mediaType: application/json openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1operations~1{operation}/delete + #/paths/~1projects~1{project}~1regions~1{region}~1operations~1{operation}/delete response: mediaType: application/json openAPIDocKey: '200' wait: operation: $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1operations~1{operation}~1wait/post + #/paths/~1projects~1{project}~1regions~1{region}~1operations~1{operation}~1wait/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/zone_operations/methods/get' - - $ref: '#/components/x-stackQL-resources/zone_operations/methods/list' + - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] replace: [] delete: - - $ref: '#/components/x-stackQL-resources/zone_operations/methods/delete' - region_operations: - id: google.compute.region_operations - name: region_operations - title: Region_operations + - $ref: '#/components/x-stackQL-resources/operations/methods/delete' + operations_aggregated: + id: google.compute.operations_aggregated + name: operations_aggregated + title: Operations_aggregated methods: - list: - operation: - $ref: '#/paths/~1projects~1{project}~1regions~1{region}~1operations/get' - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1operations~1{operation}/get - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1operations~1{operation}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - wait: + aggregated_list: operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1operations~1{operation}~1wait/post + $ref: '#/paths/~1projects~1{project}~1aggregated~1operations/get' response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.items[*].operations[*] sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/region_operations/methods/get' - - $ref: '#/components/x-stackQL-resources/region_operations/methods/list' + - $ref: >- + #/components/x-stackQL-resources/operations_aggregated/methods/aggregated_list insert: [] update: [] replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/region_operations/methods/delete' - global_addresses: - id: google.compute.global_addresses - name: global_addresses - title: Global_addresses + delete: [] + accelerator_types: + id: google.compute.accelerator_types + name: accelerator_types + title: Accelerator_types methods: list: operation: - $ref: '#/paths/~1projects~1{project}~1global~1addresses/get' + $ref: '#/paths/~1projects~1{project}~1zones~1{zone}~1acceleratorTypes/get' response: mediaType: application/json openAPIDocKey: '200' - insert: + aggregated_list: operation: - $ref: '#/paths/~1projects~1{project}~1global~1addresses/post' + $ref: '#/paths/~1projects~1{project}~1aggregated~1acceleratorTypes/get' response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.items[*].acceleratorTypes[*] get: - operation: - $ref: '#/paths/~1projects~1{project}~1global~1addresses~1{address}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: '#/paths/~1projects~1{project}~1global~1addresses~1{address}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - move: - operation: - $ref: >- - #/paths/~1projects~1{project}~1global~1addresses~1{address}~1move/post - response: - mediaType: application/json - openAPIDocKey: '200' - set_labels: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1addresses~1{resource}~1setLabels/post + #/paths/~1projects~1{project}~1zones~1{zone}~1acceleratorTypes~1{acceleratorType}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/global_addresses/methods/get' - - $ref: '#/components/x-stackQL-resources/global_addresses/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/global_addresses/methods/insert' + - $ref: '#/components/x-stackQL-resources/accelerator_types/methods/get' + - $ref: '#/components/x-stackQL-resources/accelerator_types/methods/list' + - $ref: >- + #/components/x-stackQL-resources/accelerator_types/methods/aggregated_list + insert: [] update: [] replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/global_addresses/methods/delete' + delete: [] addresses: id: google.compute.addresses name: addresses @@ -59910,13 +66178,6 @@ components: response: mediaType: application/json openAPIDocKey: '200' - aggregated_list: - operation: - $ref: '#/paths/~1projects~1{project}~1aggregated~1addresses/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.items[*].addresses[*] get: operation: $ref: >- @@ -59945,6 +66206,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + aggregated_list: + operation: + $ref: '#/paths/~1projects~1{project}~1aggregated~1addresses/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items[*].addresses[*] sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/addresses/methods/get' @@ -59991,6 +66259,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + get_from_family: + operation: + $ref: >- + #/paths/~1projects~1{project}~1global~1images~1family~1{family}/get + response: + mediaType: application/json + openAPIDocKey: '200' set_labels: operation: $ref: >- @@ -60008,6 +66283,7 @@ components: sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/images/methods/get' + - $ref: '#/components/x-stackQL-resources/images/methods/get_from_family' - $ref: '#/components/x-stackQL-resources/images/methods/list' insert: - $ref: '#/components/x-stackQL-resources/images/methods/insert' @@ -60016,26 +66292,6 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/images/methods/delete' - images_from_family: - id: google.compute.images_from_family - name: images_from_family - title: Images_from_family - methods: - get_from_family: - operation: - $ref: >- - #/paths/~1projects~1{project}~1global~1images~1family~1{family}/get - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/images_from_family/methods/get_from_family - insert: [] - update: [] - replace: [] - delete: [] images_iam_policies: id: google.compute.images_iam_policies name: images_iam_policies @@ -60106,231 +66362,48 @@ components: insert: operation: $ref: '#/paths/~1projects~1{project}~1global~1snapshots/post' - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: '#/paths/~1projects~1{project}~1global~1snapshots~1{snapshot}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: >- - #/paths/~1projects~1{project}~1global~1snapshots~1{snapshot}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - set_labels: - operation: - $ref: >- - #/paths/~1projects~1{project}~1global~1snapshots~1{resource}~1setLabels/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/snapshots/methods/get' - - $ref: '#/components/x-stackQL-resources/snapshots/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/snapshots/methods/insert' - update: [] - replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/snapshots/methods/delete' - snapshots_iam_policies: - id: google.compute.snapshots_iam_policies - name: snapshots_iam_policies - title: Snapshots_iam_policies - methods: - get_iam_policy: - operation: - $ref: >- - #/paths/~1projects~1{project}~1global~1snapshots~1{resource}~1getIamPolicy/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.bindings - set_iam_policy: - operation: - $ref: >- - #/paths/~1projects~1{project}~1global~1snapshots~1{resource}~1setIamPolicy/post - response: - mediaType: application/json - openAPIDocKey: '200' - test_iam_permissions: - operation: - $ref: >- - #/paths/~1projects~1{project}~1global~1snapshots~1{resource}~1testIamPermissions/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/snapshots_iam_policies/methods/get_iam_policy - insert: [] - update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/snapshots_iam_policies/methods/set_iam_policy - delete: [] - disks: - id: google.compute.disks - name: disks - title: Disks - methods: - list: - operation: - $ref: '#/paths/~1projects~1{project}~1zones~1{zone}~1disks/get' - response: - mediaType: application/json - openAPIDocKey: '200' - insert: - operation: - $ref: '#/paths/~1projects~1{project}~1zones~1{zone}~1disks/post' - response: - mediaType: application/json - openAPIDocKey: '200' - aggregated_list: - operation: - $ref: '#/paths/~1projects~1{project}~1aggregated~1disks/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.items[*].disks[*] - get: - operation: - $ref: '#/paths/~1projects~1{project}~1zones~1{zone}~1disks~1{disk}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: '#/paths/~1projects~1{project}~1zones~1{zone}~1disks~1{disk}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - update: - operation: - $ref: '#/paths/~1projects~1{project}~1zones~1{zone}~1disks~1{disk}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - set_labels: - operation: - $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1disks~1{resource}~1setLabels/post - response: - mediaType: application/json - openAPIDocKey: '200' - resize: - operation: - $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1disks~1{disk}~1resize/post - response: - mediaType: application/json - openAPIDocKey: '200' - start_async_replication: - operation: - $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1disks~1{disk}~1startAsyncReplication/post - response: - mediaType: application/json - openAPIDocKey: '200' - stop_async_replication: - operation: - $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1disks~1{disk}~1stopAsyncReplication/post - response: - mediaType: application/json - openAPIDocKey: '200' - stop_group_async_replication: - operation: - $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1disks~1stopGroupAsyncReplication/post - response: - mediaType: application/json - openAPIDocKey: '200' - bulk_insert: - operation: - $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1disks~1bulkInsert/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/disks/methods/get' - - $ref: '#/components/x-stackQL-resources/disks/methods/list' - - $ref: '#/components/x-stackQL-resources/disks/methods/aggregated_list' - insert: - - $ref: '#/components/x-stackQL-resources/disks/methods/insert' - - $ref: '#/components/x-stackQL-resources/disks/methods/bulk_insert' - update: - - $ref: '#/components/x-stackQL-resources/disks/methods/update' - replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/disks/methods/delete' - disks_snapshot: - id: google.compute.disks_snapshot - name: disks_snapshot - title: Disks_snapshot - methods: - create_snapshot: - operation: - $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1disks~1{disk}~1createSnapshot/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: >- - #/components/x-stackQL-resources/disks_snapshot/methods/create_snapshot - update: [] - replace: [] - delete: [] - disks_resource_policies: - id: google.compute.disks_resource_policies - name: disks_resource_policies - title: Disks_resource_policies - methods: - add_resource_policies: + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1projects~1{project}~1global~1snapshots~1{snapshot}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: operation: $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1disks~1{disk}~1addResourcePolicies/post + #/paths/~1projects~1{project}~1global~1snapshots~1{snapshot}/delete response: mediaType: application/json openAPIDocKey: '200' - remove_resource_policies: + set_labels: operation: $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1disks~1{disk}~1removeResourcePolicies/post + #/paths/~1projects~1{project}~1global~1snapshots~1{resource}~1setLabels/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: '#/components/x-stackQL-resources/snapshots/methods/get' + - $ref: '#/components/x-stackQL-resources/snapshots/methods/list' insert: - - $ref: >- - #/components/x-stackQL-resources/disks_resource_policies/methods/add_resource_policies + - $ref: '#/components/x-stackQL-resources/snapshots/methods/insert' update: [] replace: [] delete: - - $ref: >- - #/components/x-stackQL-resources/disks_resource_policies/methods/remove_resource_policies - disks_iam_policies: - id: google.compute.disks_iam_policies - name: disks_iam_policies - title: Disks_iam_policies + - $ref: '#/components/x-stackQL-resources/snapshots/methods/delete' + snapshots_iam_policies: + id: google.compute.snapshots_iam_policies + name: snapshots_iam_policies + title: Snapshots_iam_policies methods: get_iam_policy: operation: $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1disks~1{resource}~1getIamPolicy/get + #/paths/~1projects~1{project}~1global~1snapshots~1{resource}~1getIamPolicy/get response: mediaType: application/json openAPIDocKey: '200' @@ -60338,31 +66411,31 @@ components: set_iam_policy: operation: $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1disks~1{resource}~1setIamPolicy/post + #/paths/~1projects~1{project}~1global~1snapshots~1{resource}~1setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' test_iam_permissions: operation: $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1disks~1{resource}~1testIamPermissions/post + #/paths/~1projects~1{project}~1global~1snapshots~1{resource}~1testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/disks_iam_policies/methods/get_iam_policy + #/components/x-stackQL-resources/snapshots_iam_policies/methods/get_iam_policy insert: [] update: [] replace: - $ref: >- - #/components/x-stackQL-resources/disks_iam_policies/methods/set_iam_policy + #/components/x-stackQL-resources/snapshots_iam_policies/methods/set_iam_policy delete: [] - region_disks: - id: google.compute.region_disks - name: region_disks - title: Region_disks + disks: + id: google.compute.disks + name: disks + title: Disks methods: list: operation: @@ -60376,6 +66449,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + aggregated_list: + operation: + $ref: '#/paths/~1projects~1{project}~1aggregated~1disks/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items[*].disks[*] get: operation: $ref: >- @@ -60404,6 +66484,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + bulk_set_labels: + operation: + $ref: >- + #/paths/~1projects~1{project}~1zones~1{zone}~1disks~1bulkSetLabels/post + response: + mediaType: application/json + openAPIDocKey: '200' resize: operation: $ref: >- @@ -60441,20 +66528,20 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/region_disks/methods/get' - - $ref: '#/components/x-stackQL-resources/region_disks/methods/list' + - $ref: '#/components/x-stackQL-resources/disks/methods/get' + - $ref: '#/components/x-stackQL-resources/disks/methods/list' + - $ref: '#/components/x-stackQL-resources/disks/methods/aggregated_list' insert: - - $ref: '#/components/x-stackQL-resources/region_disks/methods/insert' - - $ref: '#/components/x-stackQL-resources/region_disks/methods/bulk_insert' + - $ref: '#/components/x-stackQL-resources/disks/methods/insert' update: - - $ref: '#/components/x-stackQL-resources/region_disks/methods/update' + - $ref: '#/components/x-stackQL-resources/disks/methods/update' replace: [] delete: - - $ref: '#/components/x-stackQL-resources/region_disks/methods/delete' - region_disks_snapshot: - id: google.compute.region_disks_snapshot - name: region_disks_snapshot - title: Region_disks_snapshot + - $ref: '#/components/x-stackQL-resources/disks/methods/delete' + disks_snapshot: + id: google.compute.disks_snapshot + name: disks_snapshot + title: Disks_snapshot methods: create_snapshot: operation: @@ -60467,14 +66554,14 @@ components: select: [] insert: - $ref: >- - #/components/x-stackQL-resources/region_disks_snapshot/methods/create_snapshot + #/components/x-stackQL-resources/disks_snapshot/methods/create_snapshot update: [] replace: [] delete: [] - region_disks_resource_policies: - id: google.compute.region_disks_resource_policies - name: region_disks_resource_policies - title: Region_disks_resource_policies + disks_resource_policies: + id: google.compute.disks_resource_policies + name: disks_resource_policies + title: Disks_resource_policies methods: add_resource_policies: operation: @@ -60494,16 +66581,16 @@ components: select: [] insert: - $ref: >- - #/components/x-stackQL-resources/region_disks_resource_policies/methods/add_resource_policies + #/components/x-stackQL-resources/disks_resource_policies/methods/add_resource_policies update: [] replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/region_disks_resource_policies/methods/remove_resource_policies - region_disks_iam_policies: - id: google.compute.region_disks_iam_policies - name: region_disks_iam_policies - title: Region_disks_iam_policies + #/components/x-stackQL-resources/disks_resource_policies/methods/remove_resource_policies + disks_iam_policies: + id: google.compute.disks_iam_policies + name: disks_iam_policies + title: Disks_iam_policies methods: get_iam_policy: operation: @@ -60530,12 +66617,12 @@ components: sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/region_disks_iam_policies/methods/get_iam_policy + #/components/x-stackQL-resources/disks_iam_policies/methods/get_iam_policy insert: [] update: [] replace: - $ref: >- - #/components/x-stackQL-resources/region_disks_iam_policies/methods/set_iam_policy + #/components/x-stackQL-resources/disks_iam_policies/methods/set_iam_policy delete: [] firewalls: id: google.compute.firewalls @@ -60598,55 +66685,50 @@ components: methods: list: operation: - $ref: '#/paths/~1locations~1global~1firewallPolicies/get' + $ref: >- + #/paths/~1projects~1{project}~1regions~1{region}~1firewallPolicies/get response: mediaType: application/json openAPIDocKey: '200' insert: operation: - $ref: '#/paths/~1locations~1global~1firewallPolicies/post' + $ref: >- + #/paths/~1projects~1{project}~1regions~1{region}~1firewallPolicies/post response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1locations~1global~1firewallPolicies~1{firewallPolicy}/get + #/paths/~1projects~1{project}~1regions~1{region}~1firewallPolicies~1{firewallPolicy}/get response: mediaType: application/json openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1locations~1global~1firewallPolicies~1{firewallPolicy}/delete + #/paths/~1projects~1{project}~1regions~1{region}~1firewallPolicies~1{firewallPolicy}/delete response: mediaType: application/json openAPIDocKey: '200' patch: operation: $ref: >- - #/paths/~1locations~1global~1firewallPolicies~1{firewallPolicy}/patch + #/paths/~1projects~1{project}~1regions~1{region}~1firewallPolicies~1{firewallPolicy}/patch response: mediaType: application/json openAPIDocKey: '200' - patch_rule: + move: operation: $ref: >- - #/paths/~1locations~1global~1firewallPolicies~1{firewallPolicy}~1patchRule/post + #/paths/~1locations~1global~1firewallPolicies~1{firewallPolicy}~1move/post response: mediaType: application/json openAPIDocKey: '200' clone_rules: operation: $ref: >- - #/paths/~1locations~1global~1firewallPolicies~1{firewallPolicy}~1cloneRules/post - response: - mediaType: application/json - openAPIDocKey: '200' - move: - operation: - $ref: >- - #/paths/~1locations~1global~1firewallPolicies~1{firewallPolicy}~1move/post + #/paths/~1projects~1{project}~1regions~1{region}~1firewallPolicies~1{firewallPolicy}~1cloneRules/post response: mediaType: application/json openAPIDocKey: '200' @@ -60658,8 +66740,6 @@ components: - $ref: '#/components/x-stackQL-resources/firewall_policies/methods/insert' update: - $ref: '#/components/x-stackQL-resources/firewall_policies/methods/patch' - - $ref: >- - #/components/x-stackQL-resources/firewall_policies/methods/patch_rule replace: [] delete: - $ref: '#/components/x-stackQL-resources/firewall_policies/methods/delete' @@ -60671,248 +66751,108 @@ components: get_rule: operation: $ref: >- - #/paths/~1locations~1global~1firewallPolicies~1{firewallPolicy}~1getRule/get + #/paths/~1projects~1{project}~1regions~1{region}~1firewallPolicies~1{firewallPolicy}~1getRule/get response: mediaType: application/json openAPIDocKey: '200' add_rule: operation: $ref: >- - #/paths/~1locations~1global~1firewallPolicies~1{firewallPolicy}~1addRule/post + #/paths/~1projects~1{project}~1regions~1{region}~1firewallPolicies~1{firewallPolicy}~1addRule/post response: mediaType: application/json openAPIDocKey: '200' remove_rule: operation: $ref: >- - #/paths/~1locations~1global~1firewallPolicies~1{firewallPolicy}~1removeRule/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/firewall_policies_rule/methods/get_rule - insert: - - $ref: >- - #/components/x-stackQL-resources/firewall_policies_rule/methods/add_rule - update: [] - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/firewall_policies_rule/methods/remove_rule - firewall_policies_association: - id: google.compute.firewall_policies_association - name: firewall_policies_association - title: Firewall_policies_association - methods: - add_association: - operation: - $ref: >- - #/paths/~1locations~1global~1firewallPolicies~1{firewallPolicy}~1addAssociation/post + #/paths/~1projects~1{project}~1regions~1{region}~1firewallPolicies~1{firewallPolicy}~1removeRule/post response: mediaType: application/json openAPIDocKey: '200' - remove_association: + patch_rule: operation: $ref: >- - #/paths/~1locations~1global~1firewallPolicies~1{firewallPolicy}~1removeAssociation/post + #/paths/~1projects~1{project}~1regions~1{region}~1firewallPolicies~1{firewallPolicy}~1patchRule/post response: mediaType: application/json openAPIDocKey: '200' - get_association: + clone_rules: operation: $ref: >- - #/paths/~1locations~1global~1firewallPolicies~1{firewallPolicy}~1getAssociation/get + #/paths/~1locations~1global~1firewallPolicies~1{firewallPolicy}~1cloneRules/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/firewall_policies_association/methods/get_association + #/components/x-stackQL-resources/firewall_policies_rule/methods/get_rule insert: - $ref: >- - #/components/x-stackQL-resources/firewall_policies_association/methods/add_association - update: [] + #/components/x-stackQL-resources/firewall_policies_rule/methods/add_rule + update: + - $ref: >- + #/components/x-stackQL-resources/firewall_policies_rule/methods/patch_rule replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/firewall_policies_association/methods/remove_association + #/components/x-stackQL-resources/firewall_policies_rule/methods/remove_rule firewall_policies_associations: id: google.compute.firewall_policies_associations name: firewall_policies_associations title: Firewall_policies_associations methods: - list_associations: - operation: - $ref: >- - #/paths/~1locations~1global~1firewallPolicies~1listAssociations/get - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/firewall_policies_associations/methods/list_associations - insert: [] - update: [] - replace: [] - delete: [] - firewall_policies_iam_policies: - id: google.compute.firewall_policies_iam_policies - name: firewall_policies_iam_policies - title: Firewall_policies_iam_policies - methods: - get_iam_policy: - operation: - $ref: >- - #/paths/~1locations~1global~1firewallPolicies~1{resource}~1getIamPolicy/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.bindings - set_iam_policy: - operation: - $ref: >- - #/paths/~1locations~1global~1firewallPolicies~1{resource}~1setIamPolicy/post - response: - mediaType: application/json - openAPIDocKey: '200' - test_iam_permissions: - operation: - $ref: >- - #/paths/~1locations~1global~1firewallPolicies~1{resource}~1testIamPermissions/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/firewall_policies_iam_policies/methods/get_iam_policy - insert: [] - update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/firewall_policies_iam_policies/methods/set_iam_policy - delete: [] - network_firewall_policies: - id: google.compute.network_firewall_policies - name: network_firewall_policies - title: Network_firewall_policies - methods: - list: - operation: - $ref: '#/paths/~1projects~1{project}~1global~1firewallPolicies/get' - response: - mediaType: application/json - openAPIDocKey: '200' - insert: - operation: - $ref: '#/paths/~1projects~1{project}~1global~1firewallPolicies/post' - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: >- - #/paths/~1projects~1{project}~1global~1firewallPolicies~1{firewallPolicy}/get - response: - mediaType: application/json - openAPIDocKey: '200' - delete: + add_association: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1firewallPolicies~1{firewallPolicy}/delete + #/paths/~1projects~1{project}~1regions~1{region}~1firewallPolicies~1{firewallPolicy}~1addAssociation/post response: mediaType: application/json openAPIDocKey: '200' - patch: + remove_association: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1firewallPolicies~1{firewallPolicy}/patch + #/paths/~1projects~1{project}~1regions~1{region}~1firewallPolicies~1{firewallPolicy}~1removeAssociation/post response: mediaType: application/json openAPIDocKey: '200' - patch_rule: + list_associations: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1firewallPolicies~1{firewallPolicy}~1patchRule/post + #/paths/~1locations~1global~1firewallPolicies~1listAssociations/get response: mediaType: application/json openAPIDocKey: '200' - clone_rules: + get_association: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1firewallPolicies~1{firewallPolicy}~1cloneRules/post + #/paths/~1projects~1{project}~1regions~1{region}~1firewallPolicies~1{firewallPolicy}~1getAssociation/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/network_firewall_policies/methods/get - - $ref: >- - #/components/x-stackQL-resources/network_firewall_policies/methods/list - insert: - - $ref: >- - #/components/x-stackQL-resources/network_firewall_policies/methods/insert - update: - - $ref: >- - #/components/x-stackQL-resources/network_firewall_policies/methods/patch - - $ref: >- - #/components/x-stackQL-resources/network_firewall_policies/methods/patch_rule - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/network_firewall_policies/methods/delete - network_firewall_policies_rule: - id: google.compute.network_firewall_policies_rule - name: network_firewall_policies_rule - title: Network_firewall_policies_rule - methods: - get_rule: - operation: - $ref: >- - #/paths/~1projects~1{project}~1global~1firewallPolicies~1{firewallPolicy}~1getRule/get - response: - mediaType: application/json - openAPIDocKey: '200' - add_rule: - operation: - $ref: >- - #/paths/~1projects~1{project}~1global~1firewallPolicies~1{firewallPolicy}~1addRule/post - response: - mediaType: application/json - openAPIDocKey: '200' - remove_rule: - operation: - $ref: >- - #/paths/~1projects~1{project}~1global~1firewallPolicies~1{firewallPolicy}~1removeRule/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: + #/components/x-stackQL-resources/firewall_policies_associations/methods/get_association - $ref: >- - #/components/x-stackQL-resources/network_firewall_policies_rule/methods/get_rule + #/components/x-stackQL-resources/firewall_policies_associations/methods/list_associations insert: - $ref: >- - #/components/x-stackQL-resources/network_firewall_policies_rule/methods/add_rule + #/components/x-stackQL-resources/firewall_policies_associations/methods/add_association update: [] replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/network_firewall_policies_rule/methods/remove_rule - network_firewall_policies_iam_policies: - id: google.compute.network_firewall_policies_iam_policies - name: network_firewall_policies_iam_policies - title: Network_firewall_policies_iam_policies + #/components/x-stackQL-resources/firewall_policies_associations/methods/remove_association + firewall_policies_iam_policies: + id: google.compute.firewall_policies_iam_policies + name: firewall_policies_iam_policies + title: Firewall_policies_iam_policies methods: get_iam_policy: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1firewallPolicies~1{resource}~1getIamPolicy/get + #/paths/~1projects~1{project}~1regions~1{region}~1firewallPolicies~1{resource}~1getIamPolicy/get response: mediaType: application/json openAPIDocKey: '200' @@ -60920,270 +66860,94 @@ components: set_iam_policy: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1firewallPolicies~1{resource}~1setIamPolicy/post + #/paths/~1projects~1{project}~1regions~1{region}~1firewallPolicies~1{resource}~1setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' test_iam_permissions: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1firewallPolicies~1{resource}~1testIamPermissions/post + #/paths/~1projects~1{project}~1regions~1{region}~1firewallPolicies~1{resource}~1testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/network_firewall_policies_iam_policies/methods/get_iam_policy + #/components/x-stackQL-resources/firewall_policies_iam_policies/methods/get_iam_policy insert: [] update: [] replace: - $ref: >- - #/components/x-stackQL-resources/network_firewall_policies_iam_policies/methods/set_iam_policy + #/components/x-stackQL-resources/firewall_policies_iam_policies/methods/set_iam_policy delete: [] - network_firewall_policies_association: - id: google.compute.network_firewall_policies_association - name: network_firewall_policies_association - title: Network_firewall_policies_association - methods: - add_association: - operation: - $ref: >- - #/paths/~1projects~1{project}~1global~1firewallPolicies~1{firewallPolicy}~1addAssociation/post - response: - mediaType: application/json - openAPIDocKey: '200' - remove_association: - operation: - $ref: >- - #/paths/~1projects~1{project}~1global~1firewallPolicies~1{firewallPolicy}~1removeAssociation/post - response: - mediaType: application/json - openAPIDocKey: '200' - get_association: - operation: - $ref: >- - #/paths/~1projects~1{project}~1global~1firewallPolicies~1{firewallPolicy}~1getAssociation/get - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/network_firewall_policies_association/methods/get_association - insert: - - $ref: >- - #/components/x-stackQL-resources/network_firewall_policies_association/methods/add_association - update: [] - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/network_firewall_policies_association/methods/remove_association - region_network_firewall_policies: - id: google.compute.region_network_firewall_policies - name: region_network_firewall_policies - title: Region_network_firewall_policies + packet_mirroring_rule: + id: google.compute.packet_mirroring_rule + name: packet_mirroring_rule + title: Packet_mirroring_rule methods: - list: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1firewallPolicies/get - response: - mediaType: application/json - openAPIDocKey: '200' - insert: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1firewallPolicies/post - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1firewallPolicies~1{firewallPolicy}/get - response: - mediaType: application/json - openAPIDocKey: '200' - delete: + get_packet_mirroring_rule: operation: $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1firewallPolicies~1{firewallPolicy}/delete + #/paths/~1projects~1{project}~1global~1firewallPolicies~1{firewallPolicy}~1getPacketMirroringRule/get response: mediaType: application/json openAPIDocKey: '200' - patch: + add_packet_mirroring_rule: operation: $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1firewallPolicies~1{firewallPolicy}/patch + #/paths/~1projects~1{project}~1global~1firewallPolicies~1{firewallPolicy}~1addPacketMirroringRule/post response: mediaType: application/json openAPIDocKey: '200' - patch_rule: + remove_packet_mirroring_rule: operation: $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1firewallPolicies~1{firewallPolicy}~1patchRule/post + #/paths/~1projects~1{project}~1global~1firewallPolicies~1{firewallPolicy}~1removePacketMirroringRule/post response: mediaType: application/json openAPIDocKey: '200' - clone_rules: + patch_packet_mirroring_rule: operation: $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1firewallPolicies~1{firewallPolicy}~1cloneRules/post + #/paths/~1projects~1{project}~1global~1firewallPolicies~1{firewallPolicy}~1patchPacketMirroringRule/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/region_network_firewall_policies/methods/get - - $ref: >- - #/components/x-stackQL-resources/region_network_firewall_policies/methods/list + #/components/x-stackQL-resources/packet_mirroring_rule/methods/get_packet_mirroring_rule insert: - $ref: >- - #/components/x-stackQL-resources/region_network_firewall_policies/methods/insert + #/components/x-stackQL-resources/packet_mirroring_rule/methods/add_packet_mirroring_rule update: - $ref: >- - #/components/x-stackQL-resources/region_network_firewall_policies/methods/patch - - $ref: >- - #/components/x-stackQL-resources/region_network_firewall_policies/methods/patch_rule - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/region_network_firewall_policies/methods/delete - region_network_firewall_policies_rule: - id: google.compute.region_network_firewall_policies_rule - name: region_network_firewall_policies_rule - title: Region_network_firewall_policies_rule - methods: - get_rule: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1firewallPolicies~1{firewallPolicy}~1getRule/get - response: - mediaType: application/json - openAPIDocKey: '200' - add_rule: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1firewallPolicies~1{firewallPolicy}~1addRule/post - response: - mediaType: application/json - openAPIDocKey: '200' - remove_rule: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1firewallPolicies~1{firewallPolicy}~1removeRule/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/region_network_firewall_policies_rule/methods/get_rule - insert: - - $ref: >- - #/components/x-stackQL-resources/region_network_firewall_policies_rule/methods/add_rule - update: [] - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/region_network_firewall_policies_rule/methods/remove_rule - region_network_firewall_policies_association: - id: google.compute.region_network_firewall_policies_association - name: region_network_firewall_policies_association - title: Region_network_firewall_policies_association - methods: - get_association: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1firewallPolicies~1{firewallPolicy}~1getAssociation/get - response: - mediaType: application/json - openAPIDocKey: '200' - add_association: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1firewallPolicies~1{firewallPolicy}~1addAssociation/post - response: - mediaType: application/json - openAPIDocKey: '200' - remove_association: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1firewallPolicies~1{firewallPolicy}~1removeAssociation/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/region_network_firewall_policies_association/methods/get_association - insert: - - $ref: >- - #/components/x-stackQL-resources/region_network_firewall_policies_association/methods/add_association - update: [] + #/components/x-stackQL-resources/packet_mirroring_rule/methods/patch_packet_mirroring_rule replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/region_network_firewall_policies_association/methods/remove_association - region_network_firewall_policies_effective_firewalls: - id: google.compute.region_network_firewall_policies_effective_firewalls - name: region_network_firewall_policies_effective_firewalls - title: Region_network_firewall_policies_effective_firewalls + #/components/x-stackQL-resources/packet_mirroring_rule/methods/remove_packet_mirroring_rule + effective_firewalls: + id: google.compute.effective_firewalls + name: effective_firewalls + title: Effective_firewalls methods: get_effective_firewalls: operation: $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1firewallPolicies~1getEffectiveFirewalls/get + #/paths/~1projects~1{project}~1zones~1{zone}~1instances~1{instance}~1getEffectiveFirewalls/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/region_network_firewall_policies_effective_firewalls/methods/get_effective_firewalls + #/components/x-stackQL-resources/effective_firewalls/methods/get_effective_firewalls insert: [] update: [] replace: [] delete: [] - region_network_firewall_policies_iam_policies: - id: google.compute.region_network_firewall_policies_iam_policies - name: region_network_firewall_policies_iam_policies - title: Region_network_firewall_policies_iam_policies - methods: - get_iam_policy: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1firewallPolicies~1{resource}~1getIamPolicy/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.bindings - set_iam_policy: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1firewallPolicies~1{resource}~1setIamPolicy/post - response: - mediaType: application/json - openAPIDocKey: '200' - test_iam_permissions: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1firewallPolicies~1{resource}~1testIamPermissions/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/region_network_firewall_policies_iam_policies/methods/get_iam_policy - insert: [] - update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/region_network_firewall_policies_iam_policies/methods/set_iam_policy - delete: [] security_policies: id: google.compute.security_policies name: security_policies @@ -61191,48 +66955,50 @@ components: methods: list: operation: - $ref: '#/paths/~1projects~1{project}~1global~1securityPolicies/get' + $ref: >- + #/paths/~1projects~1{project}~1regions~1{region}~1securityPolicies/get response: mediaType: application/json openAPIDocKey: '200' insert: operation: - $ref: '#/paths/~1projects~1{project}~1global~1securityPolicies/post' + $ref: >- + #/paths/~1projects~1{project}~1regions~1{region}~1securityPolicies/post response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1securityPolicies~1{securityPolicy}/get + #/paths/~1projects~1{project}~1regions~1{region}~1securityPolicies~1{securityPolicy}/get response: mediaType: application/json openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1securityPolicies~1{securityPolicy}/delete + #/paths/~1projects~1{project}~1regions~1{region}~1securityPolicies~1{securityPolicy}/delete response: mediaType: application/json openAPIDocKey: '200' patch: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1securityPolicies~1{securityPolicy}/patch + #/paths/~1projects~1{project}~1regions~1{region}~1securityPolicies~1{securityPolicy}/patch response: mediaType: application/json openAPIDocKey: '200' patch_rule: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1securityPolicies~1{securityPolicy}~1patchRule/post + #/paths/~1projects~1{project}~1regions~1{region}~1securityPolicies~1{securityPolicy}~1patchRule/post response: mediaType: application/json openAPIDocKey: '200' set_labels: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1securityPolicies~1{resource}~1setLabels/post + #/paths/~1projects~1{project}~1regions~1{region}~1securityPolicies~1{resource}~1setLabels/post response: mediaType: application/json openAPIDocKey: '200' @@ -61257,21 +67023,21 @@ components: get_rule: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1securityPolicies~1{securityPolicy}~1getRule/get + #/paths/~1projects~1{project}~1regions~1{region}~1securityPolicies~1{securityPolicy}~1getRule/get response: mediaType: application/json openAPIDocKey: '200' add_rule: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1securityPolicies~1{securityPolicy}~1addRule/post + #/paths/~1projects~1{project}~1regions~1{region}~1securityPolicies~1{securityPolicy}~1addRule/post response: mediaType: application/json openAPIDocKey: '200' remove_rule: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1securityPolicies~1{securityPolicy}~1removeRule/post + #/paths/~1projects~1{project}~1regions~1{region}~1securityPolicies~1{securityPolicy}~1removeRule/post response: mediaType: application/json openAPIDocKey: '200' @@ -61287,10 +67053,10 @@ components: delete: - $ref: >- #/components/x-stackQL-resources/security_policies_rule/methods/remove_rule - security_policies_preconfigured_expression_sets: - id: google.compute.security_policies_preconfigured_expression_sets - name: security_policies_preconfigured_expression_sets - title: Security_policies_preconfigured_expression_sets + security_policies_expression_sets: + id: google.compute.security_policies_expression_sets + name: security_policies_expression_sets + title: Security_policies_expression_sets methods: list_preconfigured_expression_sets: operation: @@ -61302,7 +67068,7 @@ components: sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/security_policies_preconfigured_expression_sets/methods/list_preconfigured_expression_sets + #/components/x-stackQL-resources/security_policies_expression_sets/methods/list_preconfigured_expression_sets insert: [] update: [] replace: [] @@ -61327,109 +67093,6 @@ components: update: [] replace: [] delete: [] - region_security_policies: - id: google.compute.region_security_policies - name: region_security_policies - title: Region_security_policies - methods: - list: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1securityPolicies/get - response: - mediaType: application/json - openAPIDocKey: '200' - insert: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1securityPolicies/post - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1securityPolicies~1{securityPolicy}/get - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1securityPolicies~1{securityPolicy}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - patch: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1securityPolicies~1{securityPolicy}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - patch_rule: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1securityPolicies~1{securityPolicy}~1patchRule/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/region_security_policies/methods/get - - $ref: >- - #/components/x-stackQL-resources/region_security_policies/methods/list - insert: - - $ref: >- - #/components/x-stackQL-resources/region_security_policies/methods/insert - update: - - $ref: >- - #/components/x-stackQL-resources/region_security_policies/methods/patch - - $ref: >- - #/components/x-stackQL-resources/region_security_policies/methods/patch_rule - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/region_security_policies/methods/delete - region_security_policies_rule: - id: google.compute.region_security_policies_rule - name: region_security_policies_rule - title: Region_security_policies_rule - methods: - get_rule: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1securityPolicies~1{securityPolicy}~1getRule/get - response: - mediaType: application/json - openAPIDocKey: '200' - add_rule: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1securityPolicies~1{securityPolicy}~1addRule/post - response: - mediaType: application/json - openAPIDocKey: '200' - remove_rule: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1securityPolicies~1{securityPolicy}~1removeRule/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/region_security_policies_rule/methods/get_rule - insert: - - $ref: >- - #/components/x-stackQL-resources/region_security_policies_rule/methods/add_rule - update: [] - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/region_security_policies_rule/methods/remove_rule instances: id: google.compute.instances name: instances @@ -61496,6 +67159,20 @@ components: response: mediaType: application/json openAPIDocKey: '200' + report_host_as_faulty: + operation: + $ref: >- + #/paths/~1projects~1{project}~1zones~1{zone}~1instances~1{instance}~1reportHostAsFaulty/post + response: + mediaType: application/json + openAPIDocKey: '200' + update_network_interface: + operation: + $ref: >- + #/paths/~1projects~1{project}~1zones~1{zone}~1instances~1{instance}~1updateNetworkInterface/patch + response: + mediaType: application/json + openAPIDocKey: '200' set_scheduling: operation: $ref: >- @@ -61629,6 +67306,20 @@ components: response: mediaType: application/json openAPIDocKey: '200' + update_shielded_instance_config: + operation: + $ref: >- + #/paths/~1projects~1{project}~1zones~1{zone}~1instances~1{instance}~1updateShieldedInstanceConfig/patch + response: + mediaType: application/json + openAPIDocKey: '200' + update_display_device: + operation: + $ref: >- + #/paths/~1projects~1{project}~1zones~1{zone}~1instances~1{instance}~1updateDisplayDevice/patch + response: + mediaType: application/json + openAPIDocKey: '200' set_shielded_instance_integrity_policy: operation: $ref: >- @@ -61646,7 +67337,7 @@ components: bulk_insert: operation: $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1instances~1bulkInsert/post + #/paths/~1projects~1{project}~1regions~1{region}~1instances~1bulkInsert/post response: mediaType: application/json openAPIDocKey: '200' @@ -61657,7 +67348,6 @@ components: - $ref: '#/components/x-stackQL-resources/instances/methods/aggregated_list' insert: - $ref: '#/components/x-stackQL-resources/instances/methods/insert' - - $ref: '#/components/x-stackQL-resources/instances/methods/bulk_insert' update: [] replace: - $ref: '#/components/x-stackQL-resources/instances/methods/update' @@ -61721,26 +67411,6 @@ components: delete: - $ref: >- #/components/x-stackQL-resources/instances_access_config/methods/delete_access_config - instances_network_interface: - id: google.compute.instances_network_interface - name: instances_network_interface - title: Instances_network_interface - methods: - update_network_interface: - operation: - $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1instances~1{instance}~1updateNetworkInterface/patch - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: - - $ref: >- - #/components/x-stackQL-resources/instances_network_interface/methods/update_network_interface - replace: [] - delete: [] instances_serial_port_output: id: google.compute.instances_serial_port_output name: instances_serial_port_output @@ -61867,50 +67537,10 @@ components: delete: - $ref: >- #/components/x-stackQL-resources/instances_resource_policies/methods/remove_resource_policies - instances_shielded_instance_config: - id: google.compute.instances_shielded_instance_config - name: instances_shielded_instance_config - title: Instances_shielded_instance_config - methods: - update_shielded_instance_config: - operation: - $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1instances~1{instance}~1updateShieldedInstanceConfig/patch - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: - - $ref: >- - #/components/x-stackQL-resources/instances_shielded_instance_config/methods/update_shielded_instance_config - replace: [] - delete: [] - instances_display_device: - id: google.compute.instances_display_device - name: instances_display_device - title: Instances_display_device - methods: - update_display_device: - operation: - $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1instances~1{instance}~1updateDisplayDevice/patch - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: - - $ref: >- - #/components/x-stackQL-resources/instances_display_device/methods/update_display_device - replace: [] - delete: [] - instances_shielded_instance_identity: - id: google.compute.instances_shielded_instance_identity - name: instances_shielded_instance_identity - title: Instances_shielded_instance_identity + shielded_instance_identity: + id: google.compute.shielded_instance_identity + name: shielded_instance_identity + title: Shielded_instance_identity methods: get_shielded_instance_identity: operation: @@ -61922,51 +67552,11 @@ components: sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/instances_shielded_instance_identity/methods/get_shielded_instance_identity - insert: [] - update: [] - replace: [] - delete: [] - instances_effective_firewalls: - id: google.compute.instances_effective_firewalls - name: instances_effective_firewalls - title: Instances_effective_firewalls - methods: - get_effective_firewalls: - operation: - $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1instances~1{instance}~1getEffectiveFirewalls/get - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/instances_effective_firewalls/methods/get_effective_firewalls + #/components/x-stackQL-resources/shielded_instance_identity/methods/get_shielded_instance_identity insert: [] update: [] replace: [] delete: [] - region_instances: - id: google.compute.region_instances - name: region_instances - title: Region_instances - methods: - bulk_insert: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1instances~1bulkInsert/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: >- - #/components/x-stackQL-resources/region_instances/methods/bulk_insert - update: [] - replace: [] - delete: [] reservations: id: google.compute.reservations name: reservations @@ -62019,6 +67609,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + perform_maintenance: + operation: + $ref: >- + #/paths/~1projects~1{project}~1zones~1{zone}~1reservations~1{reservation}~1performMaintenance/post + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/reservations/methods/get' @@ -62076,7 +67673,8 @@ components: methods: list: operation: - $ref: '#/paths/~1projects~1{project}~1zones~1{zone}~1instanceGroups/get' + $ref: >- + #/paths/~1projects~1{project}~1regions~1{region}~1instanceGroups/get response: mediaType: application/json openAPIDocKey: '200' @@ -62096,7 +67694,7 @@ components: get: operation: $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1instanceGroups~1{instanceGroup}/get + #/paths/~1projects~1{project}~1regions~1{region}~1instanceGroups~1{instanceGroup}/get response: mediaType: application/json openAPIDocKey: '200' @@ -62110,7 +67708,7 @@ components: set_named_ports: operation: $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1instanceGroups~1{instanceGroup}~1setNamedPorts/post + #/paths/~1projects~1{project}~1regions~1{region}~1instanceGroups~1{instanceGroup}~1setNamedPorts/post response: mediaType: application/json openAPIDocKey: '200' @@ -62148,7 +67746,7 @@ components: list_instances: operation: $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1instanceGroups~1{instanceGroup}~1listInstances/post + #/paths/~1projects~1{project}~1regions~1{region}~1instanceGroups~1{instanceGroup}~1listInstances/post response: mediaType: application/json openAPIDocKey: '200' @@ -62164,156 +67762,128 @@ components: delete: - $ref: >- #/components/x-stackQL-resources/instance_groups_instances/methods/remove_instances - region_instance_groups: - id: google.compute.region_instance_groups - name: region_instance_groups - title: Region_instance_groups + instance_group_managers: + id: google.compute.instance_group_managers + name: instance_group_managers + title: Instance_group_managers methods: list: operation: $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1instanceGroups/get + #/paths/~1projects~1{project}~1regions~1{region}~1instanceGroupManagers/get response: mediaType: application/json openAPIDocKey: '200' - get: + insert: operation: $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1instanceGroups~1{instanceGroup}/get + #/paths/~1projects~1{project}~1regions~1{region}~1instanceGroupManagers/post response: mediaType: application/json openAPIDocKey: '200' - set_named_ports: + aggregated_list: operation: $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1instanceGroups~1{instanceGroup}~1setNamedPorts/post + #/paths/~1projects~1{project}~1aggregated~1instanceGroupManagers/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/region_instance_groups/methods/get - - $ref: >- - #/components/x-stackQL-resources/region_instance_groups/methods/list - insert: [] - update: [] - replace: [] - delete: [] - region_instance_groups_instances: - id: google.compute.region_instance_groups_instances - name: region_instance_groups_instances - title: Region_instance_groups_instances - methods: - list_instances: + objectKey: $.items[*].instanceGroupManagers[*] + get: operation: $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1instanceGroups~1{instanceGroup}~1listInstances/post + #/paths/~1projects~1{project}~1regions~1{region}~1instanceGroupManagers~1{instanceGroupManager}/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/region_instance_groups_instances/methods/list_instances - insert: [] - update: [] - replace: [] - delete: [] - instance_group_managers: - id: google.compute.instance_group_managers - name: instance_group_managers - title: Instance_group_managers - methods: - list: + patch: operation: $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1instanceGroupManagers/get + #/paths/~1projects~1{project}~1regions~1{region}~1instanceGroupManagers~1{instanceGroupManager}/patch response: mediaType: application/json openAPIDocKey: '200' - insert: + delete: operation: $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1instanceGroupManagers/post + #/paths/~1projects~1{project}~1regions~1{region}~1instanceGroupManagers~1{instanceGroupManager}/delete response: mediaType: application/json openAPIDocKey: '200' - aggregated_list: + suspend_instances: operation: $ref: >- - #/paths/~1projects~1{project}~1aggregated~1instanceGroupManagers/get + #/paths/~1projects~1{project}~1regions~1{region}~1instanceGroupManagers~1{instanceGroupManager}~1suspendInstances/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.items[*].instanceGroupManagers[*] - get: + resume_instances: operation: $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1instanceGroupManagers~1{instanceGroupManager}/get + #/paths/~1projects~1{project}~1regions~1{region}~1instanceGroupManagers~1{instanceGroupManager}~1resumeInstances/post response: mediaType: application/json openAPIDocKey: '200' - patch: + stop_instances: operation: $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1instanceGroupManagers~1{instanceGroupManager}/patch + #/paths/~1projects~1{project}~1regions~1{region}~1instanceGroupManagers~1{instanceGroupManager}~1stopInstances/post response: mediaType: application/json openAPIDocKey: '200' - delete: + start_instances: operation: $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1instanceGroupManagers~1{instanceGroupManager}/delete + #/paths/~1projects~1{project}~1regions~1{region}~1instanceGroupManagers~1{instanceGroupManager}~1startInstances/post response: mediaType: application/json openAPIDocKey: '200' abandon_instances: operation: $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1instanceGroupManagers~1{instanceGroupManager}~1abandonInstances/post + #/paths/~1projects~1{project}~1regions~1{region}~1instanceGroupManagers~1{instanceGroupManager}~1abandonInstances/post response: mediaType: application/json openAPIDocKey: '200' recreate_instances: operation: $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1instanceGroupManagers~1{instanceGroupManager}~1recreateInstances/post + #/paths/~1projects~1{project}~1regions~1{region}~1instanceGroupManagers~1{instanceGroupManager}~1recreateInstances/post response: mediaType: application/json openAPIDocKey: '200' resize: operation: $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1instanceGroupManagers~1{instanceGroupManager}~1resize/post + #/paths/~1projects~1{project}~1regions~1{region}~1instanceGroupManagers~1{instanceGroupManager}~1resize/post response: mediaType: application/json openAPIDocKey: '200' set_instance_template: operation: $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1instanceGroupManagers~1{instanceGroupManager}~1setInstanceTemplate/post + #/paths/~1projects~1{project}~1regions~1{region}~1instanceGroupManagers~1{instanceGroupManager}~1setInstanceTemplate/post response: mediaType: application/json openAPIDocKey: '200' set_target_pools: operation: $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1instanceGroupManagers~1{instanceGroupManager}~1setTargetPools/post + #/paths/~1projects~1{project}~1regions~1{region}~1instanceGroupManagers~1{instanceGroupManager}~1setTargetPools/post response: mediaType: application/json openAPIDocKey: '200' patch_per_instance_configs: operation: $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1instanceGroupManagers~1{instanceGroupManager}~1patchPerInstanceConfigs/post + #/paths/~1projects~1{project}~1regions~1{region}~1instanceGroupManagers~1{instanceGroupManager}~1patchPerInstanceConfigs/post response: mediaType: application/json openAPIDocKey: '200' apply_updates_to_instances: operation: $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1instanceGroupManagers~1{instanceGroupManager}~1applyUpdatesToInstances/post + #/paths/~1projects~1{project}~1regions~1{region}~1instanceGroupManagers~1{instanceGroupManager}~1applyUpdatesToInstances/post response: mediaType: application/json openAPIDocKey: '200' @@ -62345,47 +67915,36 @@ components: delete_instances: operation: $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1instanceGroupManagers~1{instanceGroupManager}~1deleteInstances/post + #/paths/~1projects~1{project}~1regions~1{region}~1instanceGroupManagers~1{instanceGroupManager}~1deleteInstances/post response: mediaType: application/json openAPIDocKey: '200' - create_instances: + list_managed_instances: operation: $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1instanceGroupManagers~1{instanceGroupManager}~1createInstances/post + #/paths/~1projects~1{project}~1regions~1{region}~1instanceGroupManagers~1{instanceGroupManager}~1listManagedInstances/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: >- - #/components/x-stackQL-resources/instance_group_managers_instances/methods/create_instances - update: [] - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/instance_group_managers_instances/methods/delete_instances - instance_group_managers_managed_instances: - id: google.compute.instance_group_managers_managed_instances - name: instance_group_managers_managed_instances - title: Instance_group_managers_managed_instances - methods: - list_managed_instances: + create_instances: operation: $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1instanceGroupManagers~1{instanceGroupManager}~1listManagedInstances/post + #/paths/~1projects~1{project}~1regions~1{region}~1instanceGroupManagers~1{instanceGroupManager}~1createInstances/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/instance_group_managers_managed_instances/methods/list_managed_instances - insert: [] + #/components/x-stackQL-resources/instance_group_managers_instances/methods/list_managed_instances + insert: + - $ref: >- + #/components/x-stackQL-resources/instance_group_managers_instances/methods/create_instances update: [] replace: [] - delete: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/instance_group_managers_instances/methods/delete_instances instance_group_managers_errors: id: google.compute.instance_group_managers_errors name: instance_group_managers_errors @@ -62394,7 +67953,7 @@ components: list_errors: operation: $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1instanceGroupManagers~1{instanceGroupManager}~1listErrors/get + #/paths/~1projects~1{project}~1regions~1{region}~1instanceGroupManagers~1{instanceGroupManager}~1listErrors/get response: mediaType: application/json openAPIDocKey: '200' @@ -62414,21 +67973,21 @@ components: list_per_instance_configs: operation: $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1instanceGroupManagers~1{instanceGroupManager}~1listPerInstanceConfigs/post + #/paths/~1projects~1{project}~1regions~1{region}~1instanceGroupManagers~1{instanceGroupManager}~1listPerInstanceConfigs/post response: mediaType: application/json openAPIDocKey: '200' update_per_instance_configs: operation: $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1instanceGroupManagers~1{instanceGroupManager}~1updatePerInstanceConfigs/post + #/paths/~1projects~1{project}~1regions~1{region}~1instanceGroupManagers~1{instanceGroupManager}~1updatePerInstanceConfigs/post response: mediaType: application/json openAPIDocKey: '200' delete_per_instance_configs: operation: $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1instanceGroupManagers~1{instanceGroupManager}~1deletePerInstanceConfigs/post + #/paths/~1projects~1{project}~1regions~1{region}~1instanceGroupManagers~1{instanceGroupManager}~1deletePerInstanceConfigs/post response: mediaType: application/json openAPIDocKey: '200' @@ -62498,220 +68057,6 @@ components: delete: - $ref: >- #/components/x-stackQL-resources/instance_group_manager_resize_requests/methods/delete - region_instance_group_managers: - id: google.compute.region_instance_group_managers - name: region_instance_group_managers - title: Region_instance_group_managers - methods: - list: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1instanceGroupManagers/get - response: - mediaType: application/json - openAPIDocKey: '200' - insert: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1instanceGroupManagers/post - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1instanceGroupManagers~1{instanceGroupManager}/get - response: - mediaType: application/json - openAPIDocKey: '200' - patch: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1instanceGroupManagers~1{instanceGroupManager}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1instanceGroupManagers~1{instanceGroupManager}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - abandon_instances: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1instanceGroupManagers~1{instanceGroupManager}~1abandonInstances/post - response: - mediaType: application/json - openAPIDocKey: '200' - recreate_instances: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1instanceGroupManagers~1{instanceGroupManager}~1recreateInstances/post - response: - mediaType: application/json - openAPIDocKey: '200' - resize: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1instanceGroupManagers~1{instanceGroupManager}~1resize/post - response: - mediaType: application/json - openAPIDocKey: '200' - set_instance_template: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1instanceGroupManagers~1{instanceGroupManager}~1setInstanceTemplate/post - response: - mediaType: application/json - openAPIDocKey: '200' - set_target_pools: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1instanceGroupManagers~1{instanceGroupManager}~1setTargetPools/post - response: - mediaType: application/json - openAPIDocKey: '200' - patch_per_instance_configs: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1instanceGroupManagers~1{instanceGroupManager}~1patchPerInstanceConfigs/post - response: - mediaType: application/json - openAPIDocKey: '200' - apply_updates_to_instances: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1instanceGroupManagers~1{instanceGroupManager}~1applyUpdatesToInstances/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/region_instance_group_managers/methods/get - - $ref: >- - #/components/x-stackQL-resources/region_instance_group_managers/methods/list - insert: - - $ref: >- - #/components/x-stackQL-resources/region_instance_group_managers/methods/insert - update: - - $ref: >- - #/components/x-stackQL-resources/region_instance_group_managers/methods/patch - - $ref: >- - #/components/x-stackQL-resources/region_instance_group_managers/methods/patch_per_instance_configs - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/region_instance_group_managers/methods/delete - region_instance_group_managers_instances: - id: google.compute.region_instance_group_managers_instances - name: region_instance_group_managers_instances - title: Region_instance_group_managers_instances - methods: - delete_instances: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1instanceGroupManagers~1{instanceGroupManager}~1deleteInstances/post - response: - mediaType: application/json - openAPIDocKey: '200' - create_instances: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1instanceGroupManagers~1{instanceGroupManager}~1createInstances/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: >- - #/components/x-stackQL-resources/region_instance_group_managers_instances/methods/create_instances - update: [] - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/region_instance_group_managers_instances/methods/delete_instances - region_instance_group_managers_managed_instances: - id: google.compute.region_instance_group_managers_managed_instances - name: region_instance_group_managers_managed_instances - title: Region_instance_group_managers_managed_instances - methods: - list_managed_instances: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1instanceGroupManagers~1{instanceGroupManager}~1listManagedInstances/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/region_instance_group_managers_managed_instances/methods/list_managed_instances - insert: [] - update: [] - replace: [] - delete: [] - region_instance_group_managers_errors: - id: google.compute.region_instance_group_managers_errors - name: region_instance_group_managers_errors - title: Region_instance_group_managers_errors - methods: - list_errors: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1instanceGroupManagers~1{instanceGroupManager}~1listErrors/get - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/region_instance_group_managers_errors/methods/list_errors - insert: [] - update: [] - replace: [] - delete: [] - region_instance_group_managers_per_instance_configs: - id: google.compute.region_instance_group_managers_per_instance_configs - name: region_instance_group_managers_per_instance_configs - title: Region_instance_group_managers_per_instance_configs - methods: - list_per_instance_configs: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1instanceGroupManagers~1{instanceGroupManager}~1listPerInstanceConfigs/post - response: - mediaType: application/json - openAPIDocKey: '200' - update_per_instance_configs: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1instanceGroupManagers~1{instanceGroupManager}~1updatePerInstanceConfigs/post - response: - mediaType: application/json - openAPIDocKey: '200' - delete_per_instance_configs: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1instanceGroupManagers~1{instanceGroupManager}~1deletePerInstanceConfigs/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/region_instance_group_managers_per_instance_configs/methods/list_per_instance_configs - insert: [] - update: - - $ref: >- - #/components/x-stackQL-resources/region_instance_group_managers_per_instance_configs/methods/update_per_instance_configs - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/region_instance_group_managers_per_instance_configs/methods/delete_per_instance_configs autoscalers: id: google.compute.autoscalers name: autoscalers @@ -62719,25 +68064,26 @@ components: methods: list: operation: - $ref: '#/paths/~1projects~1{project}~1zones~1{zone}~1autoscalers/get' + $ref: '#/paths/~1projects~1{project}~1regions~1{region}~1autoscalers/get' response: mediaType: application/json openAPIDocKey: '200' insert: operation: - $ref: '#/paths/~1projects~1{project}~1zones~1{zone}~1autoscalers/post' + $ref: '#/paths/~1projects~1{project}~1regions~1{region}~1autoscalers/post' response: mediaType: application/json openAPIDocKey: '200' update: operation: - $ref: '#/paths/~1projects~1{project}~1zones~1{zone}~1autoscalers/put' + $ref: '#/paths/~1projects~1{project}~1regions~1{region}~1autoscalers/put' response: mediaType: application/json openAPIDocKey: '200' patch: operation: - $ref: '#/paths/~1projects~1{project}~1zones~1{zone}~1autoscalers/patch' + $ref: >- + #/paths/~1projects~1{project}~1regions~1{region}~1autoscalers/patch response: mediaType: application/json openAPIDocKey: '200' @@ -62751,14 +68097,14 @@ components: get: operation: $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1autoscalers~1{autoscaler}/get + #/paths/~1projects~1{project}~1regions~1{region}~1autoscalers~1{autoscaler}/get response: mediaType: application/json openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1autoscalers~1{autoscaler}/delete + #/paths/~1projects~1{project}~1regions~1{region}~1autoscalers~1{autoscaler}/delete response: mediaType: application/json openAPIDocKey: '200' @@ -62776,62 +68122,6 @@ components: - $ref: '#/components/x-stackQL-resources/autoscalers/methods/update' delete: - $ref: '#/components/x-stackQL-resources/autoscalers/methods/delete' - region_autoscalers: - id: google.compute.region_autoscalers - name: region_autoscalers - title: Region_autoscalers - methods: - list: - operation: - $ref: '#/paths/~1projects~1{project}~1regions~1{region}~1autoscalers/get' - response: - mediaType: application/json - openAPIDocKey: '200' - insert: - operation: - $ref: '#/paths/~1projects~1{project}~1regions~1{region}~1autoscalers/post' - response: - mediaType: application/json - openAPIDocKey: '200' - update: - operation: - $ref: '#/paths/~1projects~1{project}~1regions~1{region}~1autoscalers/put' - response: - mediaType: application/json - openAPIDocKey: '200' - patch: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1autoscalers/patch - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1autoscalers~1{autoscaler}/get - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1autoscalers~1{autoscaler}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/region_autoscalers/methods/get' - - $ref: '#/components/x-stackQL-resources/region_autoscalers/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/region_autoscalers/methods/insert' - update: - - $ref: '#/components/x-stackQL-resources/region_autoscalers/methods/patch' - replace: - - $ref: '#/components/x-stackQL-resources/region_autoscalers/methods/update' - delete: - - $ref: '#/components/x-stackQL-resources/region_autoscalers/methods/delete' backend_buckets: id: google.compute.backend_buckets name: backend_buckets @@ -62877,54 +68167,39 @@ components: response: mediaType: application/json openAPIDocKey: '200' - set_edge_security_policy: + add_signed_url_key: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1backendBuckets~1{backendBucket}~1setEdgeSecurityPolicy/post + #/paths/~1projects~1{project}~1global~1backendBuckets~1{backendBucket}~1addSignedUrlKey/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/backend_buckets/methods/get' - - $ref: '#/components/x-stackQL-resources/backend_buckets/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/backend_buckets/methods/insert' - update: - - $ref: '#/components/x-stackQL-resources/backend_buckets/methods/patch' - replace: - - $ref: '#/components/x-stackQL-resources/backend_buckets/methods/update' - delete: - - $ref: '#/components/x-stackQL-resources/backend_buckets/methods/delete' - backend_buckets_signed_url_key: - id: google.compute.backend_buckets_signed_url_key - name: backend_buckets_signed_url_key - title: Backend_buckets_signed_url_key - methods: - add_signed_url_key: + delete_signed_url_key: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1backendBuckets~1{backendBucket}~1addSignedUrlKey/post + #/paths/~1projects~1{project}~1global~1backendBuckets~1{backendBucket}~1deleteSignedUrlKey/post response: mediaType: application/json openAPIDocKey: '200' - delete_signed_url_key: + set_edge_security_policy: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1backendBuckets~1{backendBucket}~1deleteSignedUrlKey/post + #/paths/~1projects~1{project}~1global~1backendBuckets~1{backendBucket}~1setEdgeSecurityPolicy/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: '#/components/x-stackQL-resources/backend_buckets/methods/get' + - $ref: '#/components/x-stackQL-resources/backend_buckets/methods/list' insert: - - $ref: >- - #/components/x-stackQL-resources/backend_buckets_signed_url_key/methods/add_signed_url_key - update: [] - replace: [] + - $ref: '#/components/x-stackQL-resources/backend_buckets/methods/insert' + update: + - $ref: '#/components/x-stackQL-resources/backend_buckets/methods/patch' + replace: + - $ref: '#/components/x-stackQL-resources/backend_buckets/methods/update' delete: - - $ref: >- - #/components/x-stackQL-resources/backend_buckets_signed_url_key/methods/delete_signed_url_key + - $ref: '#/components/x-stackQL-resources/backend_buckets/methods/delete' backend_buckets_iam_policies: id: google.compute.backend_buckets_iam_policies name: backend_buckets_iam_policies @@ -62969,48 +68244,64 @@ components: methods: list: operation: - $ref: '#/paths/~1projects~1{project}~1global~1backendServices/get' + $ref: >- + #/paths/~1projects~1{project}~1regions~1{region}~1backendServices/get response: mediaType: application/json openAPIDocKey: '200' insert: operation: - $ref: '#/paths/~1projects~1{project}~1global~1backendServices/post' + $ref: >- + #/paths/~1projects~1{project}~1regions~1{region}~1backendServices/post response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1backendServices~1{backendService}/get + #/paths/~1projects~1{project}~1regions~1{region}~1backendServices~1{backendService}/get response: mediaType: application/json openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1backendServices~1{backendService}/delete + #/paths/~1projects~1{project}~1regions~1{region}~1backendServices~1{backendService}/delete response: mediaType: application/json openAPIDocKey: '200' update: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1backendServices~1{backendService}/put + #/paths/~1projects~1{project}~1regions~1{region}~1backendServices~1{backendService}/put response: mediaType: application/json openAPIDocKey: '200' patch: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1backendServices~1{backendService}/patch + #/paths/~1projects~1{project}~1regions~1{region}~1backendServices~1{backendService}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + add_signed_url_key: + operation: + $ref: >- + #/paths/~1projects~1{project}~1global~1backendServices~1{backendService}~1addSignedUrlKey/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete_signed_url_key: + operation: + $ref: >- + #/paths/~1projects~1{project}~1global~1backendServices~1{backendService}~1deleteSignedUrlKey/post response: mediaType: application/json openAPIDocKey: '200' set_security_policy: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1backendServices~1{backendService}~1setSecurityPolicy/post + #/paths/~1projects~1{project}~1regions~1{region}~1backendServices~1{backendService}~1setSecurityPolicy/post response: mediaType: application/json openAPIDocKey: '200' @@ -63061,7 +68352,7 @@ components: list_usable: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1backendServices~1listUsable/get + #/paths/~1projects~1{project}~1regions~1{region}~1backendServices~1listUsable/get response: mediaType: application/json openAPIDocKey: '200' @@ -63073,35 +68364,6 @@ components: update: [] replace: [] delete: [] - backend_services_signed_url_key: - id: google.compute.backend_services_signed_url_key - name: backend_services_signed_url_key - title: Backend_services_signed_url_key - methods: - add_signed_url_key: - operation: - $ref: >- - #/paths/~1projects~1{project}~1global~1backendServices~1{backendService}~1addSignedUrlKey/post - response: - mediaType: application/json - openAPIDocKey: '200' - delete_signed_url_key: - operation: - $ref: >- - #/paths/~1projects~1{project}~1global~1backendServices~1{backendService}~1deleteSignedUrlKey/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: >- - #/components/x-stackQL-resources/backend_services_signed_url_key/methods/add_signed_url_key - update: [] - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/backend_services_signed_url_key/methods/delete_signed_url_key backend_services_health: id: google.compute.backend_services_health name: backend_services_health @@ -63110,7 +68372,7 @@ components: get_health: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1backendServices~1{backendService}~1getHealth/post + #/paths/~1projects~1{project}~1regions~1{region}~1backendServices~1{backendService}~1getHealth/post response: mediaType: application/json openAPIDocKey: '200' @@ -63130,7 +68392,7 @@ components: get_iam_policy: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1backendServices~1{resource}~1getIamPolicy/get + #/paths/~1projects~1{project}~1regions~1{region}~1backendServices~1{resource}~1getIamPolicy/get response: mediaType: application/json openAPIDocKey: '200' @@ -63138,14 +68400,14 @@ components: set_iam_policy: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1backendServices~1{resource}~1setIamPolicy/post + #/paths/~1projects~1{project}~1regions~1{region}~1backendServices~1{resource}~1setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' test_iam_permissions: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1backendServices~1{resource}~1testIamPermissions/post + #/paths/~1projects~1{project}~1regions~1{region}~1backendServices~1{resource}~1testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' @@ -63159,614 +68421,703 @@ components: - $ref: >- #/components/x-stackQL-resources/backend_services_iam_policies/methods/set_iam_policy delete: [] - region_backend_services: - id: google.compute.region_backend_services - name: region_backend_services - title: Region_backend_services + commitments: + id: google.compute.commitments + name: commitments + title: Commitments methods: list: operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1backendServices/get + $ref: '#/paths/~1projects~1{project}~1regions~1{region}~1commitments/get' response: mediaType: application/json openAPIDocKey: '200' insert: operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1backendServices/post + $ref: '#/paths/~1projects~1{project}~1regions~1{region}~1commitments/post' response: mediaType: application/json openAPIDocKey: '200' - get: + aggregated_list: operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1backendServices~1{backendService}/get + $ref: '#/paths/~1projects~1{project}~1aggregated~1commitments/get' response: mediaType: application/json openAPIDocKey: '200' - delete: + objectKey: $.items[*].commitments[*] + get: operation: $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1backendServices~1{backendService}/delete + #/paths/~1projects~1{project}~1regions~1{region}~1commitments~1{commitment}/get response: mediaType: application/json openAPIDocKey: '200' update: operation: $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1backendServices~1{backendService}/put + #/paths/~1projects~1{project}~1regions~1{region}~1commitments~1{commitment}/patch response: mediaType: application/json openAPIDocKey: '200' - patch: + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/commitments/methods/get' + - $ref: '#/components/x-stackQL-resources/commitments/methods/list' + - $ref: >- + #/components/x-stackQL-resources/commitments/methods/aggregated_list + insert: + - $ref: '#/components/x-stackQL-resources/commitments/methods/insert' + update: + - $ref: '#/components/x-stackQL-resources/commitments/methods/update' + replace: [] + delete: [] + disk_types: + id: google.compute.disk_types + name: disk_types + title: Disk_types + methods: + list: operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1backendServices~1{backendService}/patch + $ref: '#/paths/~1projects~1{project}~1regions~1{region}~1diskTypes/get' response: mediaType: application/json openAPIDocKey: '200' - set_security_policy: + aggregated_list: operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1backendServices~1{backendService}~1setSecurityPolicy/post + $ref: '#/paths/~1projects~1{project}~1aggregated~1diskTypes/get' response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/region_backend_services/methods/get - - $ref: >- - #/components/x-stackQL-resources/region_backend_services/methods/list - insert: - - $ref: >- - #/components/x-stackQL-resources/region_backend_services/methods/insert - update: - - $ref: >- - #/components/x-stackQL-resources/region_backend_services/methods/patch - replace: - - $ref: >- - #/components/x-stackQL-resources/region_backend_services/methods/update - delete: - - $ref: >- - #/components/x-stackQL-resources/region_backend_services/methods/delete - region_backend_services_usable: - id: google.compute.region_backend_services_usable - name: region_backend_services_usable - title: Region_backend_services_usable - methods: - list_usable: + objectKey: $.items[*].diskTypes[*] + get: operation: $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1backendServices~1listUsable/get + #/paths/~1projects~1{project}~1regions~1{region}~1diskTypes~1{diskType}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/disk_types/methods/get' + - $ref: '#/components/x-stackQL-resources/disk_types/methods/list' - $ref: >- - #/components/x-stackQL-resources/region_backend_services_usable/methods/list_usable + #/components/x-stackQL-resources/disk_types/methods/aggregated_list insert: [] update: [] replace: [] delete: [] - region_backend_services_health: - id: google.compute.region_backend_services_health - name: region_backend_services_health - title: Region_backend_services_health + interconnect_attachments: + id: google.compute.interconnect_attachments + name: interconnect_attachments + title: Interconnect_attachments methods: - get_health: + list: operation: $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1backendServices~1{backendService}~1getHealth/post + #/paths/~1projects~1{project}~1regions~1{region}~1interconnectAttachments/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/region_backend_services_health/methods/get_health - insert: [] - update: [] - replace: [] - delete: [] - region_backend_services_iam_policies: - id: google.compute.region_backend_services_iam_policies - name: region_backend_services_iam_policies - title: Region_backend_services_iam_policies - methods: - get_iam_policy: + insert: operation: $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1backendServices~1{resource}~1getIamPolicy/get + #/paths/~1projects~1{project}~1regions~1{region}~1interconnectAttachments/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.bindings - set_iam_policy: + aggregated_list: operation: $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1backendServices~1{resource}~1setIamPolicy/post + #/paths/~1projects~1{project}~1aggregated~1interconnectAttachments/get response: mediaType: application/json openAPIDocKey: '200' - test_iam_permissions: + objectKey: $.items[*].interconnectAttachments[*] + get: operation: $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1backendServices~1{resource}~1testIamPermissions/post + #/paths/~1projects~1{project}~1regions~1{region}~1interconnectAttachments~1{interconnectAttachment}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1projects~1{project}~1regions~1{region}~1interconnectAttachments~1{interconnectAttachment}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1projects~1{project}~1regions~1{region}~1interconnectAttachments~1{interconnectAttachment}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + set_labels: + operation: + $ref: >- + #/paths/~1projects~1{project}~1regions~1{region}~1interconnectAttachments~1{resource}~1setLabels/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/region_backend_services_iam_policies/methods/get_iam_policy - insert: [] - update: [] - replace: + #/components/x-stackQL-resources/interconnect_attachments/methods/get - $ref: >- - #/components/x-stackQL-resources/region_backend_services_iam_policies/methods/set_iam_policy - delete: [] - region_commitments: - id: google.compute.region_commitments - name: region_commitments - title: Region_commitments + #/components/x-stackQL-resources/interconnect_attachments/methods/list + - $ref: >- + #/components/x-stackQL-resources/interconnect_attachments/methods/aggregated_list + insert: + - $ref: >- + #/components/x-stackQL-resources/interconnect_attachments/methods/insert + update: + - $ref: >- + #/components/x-stackQL-resources/interconnect_attachments/methods/patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/interconnect_attachments/methods/delete + interconnect_attachment_groups: + id: google.compute.interconnect_attachment_groups + name: interconnect_attachment_groups + title: Interconnect_attachment_groups methods: list: operation: - $ref: '#/paths/~1projects~1{project}~1regions~1{region}~1commitments/get' + $ref: >- + #/paths/~1projects~1{project}~1global~1interconnectAttachmentGroups/get response: mediaType: application/json openAPIDocKey: '200' insert: operation: - $ref: '#/paths/~1projects~1{project}~1regions~1{region}~1commitments/post' + $ref: >- + #/paths/~1projects~1{project}~1global~1interconnectAttachmentGroups/post response: mediaType: application/json openAPIDocKey: '200' - aggregated_list: + get: operation: - $ref: '#/paths/~1projects~1{project}~1aggregated~1commitments/get' + $ref: >- + #/paths/~1projects~1{project}~1global~1interconnectAttachmentGroups~1{interconnectAttachmentGroup}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.items[*].commitments[*] - get: + delete: operation: $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1commitments~1{commitment}/get + #/paths/~1projects~1{project}~1global~1interconnectAttachmentGroups~1{interconnectAttachmentGroup}/delete response: mediaType: application/json openAPIDocKey: '200' - update: + patch: operation: $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1commitments~1{commitment}/patch + #/paths/~1projects~1{project}~1global~1interconnectAttachmentGroups~1{interconnectAttachmentGroup}/patch response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/region_commitments/methods/get' - - $ref: '#/components/x-stackQL-resources/region_commitments/methods/list' - $ref: >- - #/components/x-stackQL-resources/region_commitments/methods/aggregated_list + #/components/x-stackQL-resources/interconnect_attachment_groups/methods/get + - $ref: >- + #/components/x-stackQL-resources/interconnect_attachment_groups/methods/list insert: - - $ref: '#/components/x-stackQL-resources/region_commitments/methods/insert' + - $ref: >- + #/components/x-stackQL-resources/interconnect_attachment_groups/methods/insert update: - - $ref: '#/components/x-stackQL-resources/region_commitments/methods/update' + - $ref: >- + #/components/x-stackQL-resources/interconnect_attachment_groups/methods/patch replace: [] - delete: [] - disk_types: - id: google.compute.disk_types - name: disk_types - title: Disk_types + delete: + - $ref: >- + #/components/x-stackQL-resources/interconnect_attachment_groups/methods/delete + interconnect_attachment_groups_iam_policies: + id: google.compute.interconnect_attachment_groups_iam_policies + name: interconnect_attachment_groups_iam_policies + title: Interconnect_attachment_groups_iam_policies methods: - list: + get_iam_policy: operation: - $ref: '#/paths/~1projects~1{project}~1zones~1{zone}~1diskTypes/get' + $ref: >- + #/paths/~1projects~1{project}~1global~1interconnectAttachmentGroups~1{resource}~1getIamPolicy/get response: mediaType: application/json openAPIDocKey: '200' - aggregated_list: + objectKey: $.bindings + set_iam_policy: operation: - $ref: '#/paths/~1projects~1{project}~1aggregated~1diskTypes/get' + $ref: >- + #/paths/~1projects~1{project}~1global~1interconnectAttachmentGroups~1{resource}~1setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.items[*].diskTypes[*] - get: + test_iam_permissions: operation: $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1diskTypes~1{diskType}/get + #/paths/~1projects~1{project}~1global~1interconnectAttachmentGroups~1{resource}~1testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/disk_types/methods/get' - - $ref: '#/components/x-stackQL-resources/disk_types/methods/list' - $ref: >- - #/components/x-stackQL-resources/disk_types/methods/aggregated_list + #/components/x-stackQL-resources/interconnect_attachment_groups_iam_policies/methods/get_iam_policy insert: [] update: [] - replace: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/interconnect_attachment_groups_iam_policies/methods/set_iam_policy delete: [] - region_disk_types: - id: google.compute.region_disk_types - name: region_disk_types - title: Region_disk_types + interconnect_attachment_groups_operational_status: + id: google.compute.interconnect_attachment_groups_operational_status + name: interconnect_attachment_groups_operational_status + title: Interconnect_attachment_groups_operational_status methods: - list: - operation: - $ref: '#/paths/~1projects~1{project}~1regions~1{region}~1diskTypes/get' - response: - mediaType: application/json - openAPIDocKey: '200' - get: + get_operational_status: operation: $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1diskTypes~1{diskType}/get + #/paths/~1projects~1{project}~1global~1interconnectAttachmentGroups~1{interconnectAttachmentGroup}~1getOperationalStatus/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/region_disk_types/methods/get' - - $ref: '#/components/x-stackQL-resources/region_disk_types/methods/list' + - $ref: >- + #/components/x-stackQL-resources/interconnect_attachment_groups_operational_status/methods/get_operational_status insert: [] update: [] replace: [] delete: [] - external_vpn_gateways: - id: google.compute.external_vpn_gateways - name: external_vpn_gateways - title: External_vpn_gateways + interconnects: + id: google.compute.interconnects + name: interconnects + title: Interconnects methods: insert: operation: - $ref: '#/paths/~1projects~1{project}~1global~1externalVpnGateways/post' + $ref: '#/paths/~1projects~1{project}~1global~1interconnects/post' response: mediaType: application/json openAPIDocKey: '200' list: operation: - $ref: '#/paths/~1projects~1{project}~1global~1externalVpnGateways/get' + $ref: '#/paths/~1projects~1{project}~1global~1interconnects/get' response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1externalVpnGateways~1{externalVpnGateway}/get + #/paths/~1projects~1{project}~1global~1interconnects~1{interconnect}/get response: mediaType: application/json openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1externalVpnGateways~1{externalVpnGateway}/delete + #/paths/~1projects~1{project}~1global~1interconnects~1{interconnect}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1projects~1{project}~1global~1interconnects~1{interconnect}/patch response: mediaType: application/json openAPIDocKey: '200' set_labels: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1externalVpnGateways~1{resource}~1setLabels/post + #/paths/~1projects~1{project}~1global~1interconnects~1{resource}~1setLabels/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/external_vpn_gateways/methods/get' - - $ref: >- - #/components/x-stackQL-resources/external_vpn_gateways/methods/list + - $ref: '#/components/x-stackQL-resources/interconnects/methods/get' + - $ref: '#/components/x-stackQL-resources/interconnects/methods/list' insert: - - $ref: >- - #/components/x-stackQL-resources/external_vpn_gateways/methods/insert - update: [] + - $ref: '#/components/x-stackQL-resources/interconnects/methods/insert' + update: + - $ref: '#/components/x-stackQL-resources/interconnects/methods/patch' replace: [] delete: + - $ref: '#/components/x-stackQL-resources/interconnects/methods/delete' + interconnects_diagnostics: + id: google.compute.interconnects_diagnostics + name: interconnects_diagnostics + title: Interconnects_diagnostics + methods: + get_diagnostics: + operation: + $ref: >- + #/paths/~1projects~1{project}~1global~1interconnects~1{interconnect}~1getDiagnostics/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: - $ref: >- - #/components/x-stackQL-resources/external_vpn_gateways/methods/delete - external_vpn_gateways_iam_policies: - id: google.compute.external_vpn_gateways_iam_policies - name: external_vpn_gateways_iam_policies - title: External_vpn_gateways_iam_policies + #/components/x-stackQL-resources/interconnects_diagnostics/methods/get_diagnostics + insert: [] + update: [] + replace: [] + delete: [] + interconnects_macsec_config: + id: google.compute.interconnects_macsec_config + name: interconnects_macsec_config + title: Interconnects_macsec_config methods: - test_iam_permissions: + get_macsec_config: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1externalVpnGateways~1{resource}~1testIamPermissions/post + #/paths/~1projects~1{project}~1global~1interconnects~1{interconnect}~1getMacsecConfig/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/interconnects_macsec_config/methods/get_macsec_config insert: [] update: [] replace: [] delete: [] - global_forwarding_rules: - id: google.compute.global_forwarding_rules - name: global_forwarding_rules - title: Global_forwarding_rules + interconnect_groups: + id: google.compute.interconnect_groups + name: interconnect_groups + title: Interconnect_groups methods: list: operation: - $ref: '#/paths/~1projects~1{project}~1global~1forwardingRules/get' + $ref: '#/paths/~1projects~1{project}~1global~1interconnectGroups/get' response: mediaType: application/json openAPIDocKey: '200' insert: operation: - $ref: '#/paths/~1projects~1{project}~1global~1forwardingRules/post' + $ref: '#/paths/~1projects~1{project}~1global~1interconnectGroups/post' response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1forwardingRules~1{forwardingRule}/get + #/paths/~1projects~1{project}~1global~1interconnectGroups~1{interconnectGroup}/get response: mediaType: application/json openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1forwardingRules~1{forwardingRule}/delete + #/paths/~1projects~1{project}~1global~1interconnectGroups~1{interconnectGroup}/delete response: mediaType: application/json openAPIDocKey: '200' patch: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1forwardingRules~1{forwardingRule}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - set_target: - operation: - $ref: >- - #/paths/~1projects~1{project}~1global~1forwardingRules~1{forwardingRule}~1setTarget/post + #/paths/~1projects~1{project}~1global~1interconnectGroups~1{interconnectGroup}/patch response: mediaType: application/json openAPIDocKey: '200' - set_labels: + create_members: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1forwardingRules~1{resource}~1setLabels/post + #/paths/~1projects~1{project}~1global~1interconnectGroups~1{interconnectGroup}~1createMembers/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/global_forwarding_rules/methods/get - - $ref: >- - #/components/x-stackQL-resources/global_forwarding_rules/methods/list + - $ref: '#/components/x-stackQL-resources/interconnect_groups/methods/get' + - $ref: '#/components/x-stackQL-resources/interconnect_groups/methods/list' insert: - $ref: >- - #/components/x-stackQL-resources/global_forwarding_rules/methods/insert - update: + #/components/x-stackQL-resources/interconnect_groups/methods/create_members - $ref: >- - #/components/x-stackQL-resources/global_forwarding_rules/methods/patch + #/components/x-stackQL-resources/interconnect_groups/methods/insert + update: + - $ref: '#/components/x-stackQL-resources/interconnect_groups/methods/patch' replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/global_forwarding_rules/methods/delete - forwarding_rules: - id: google.compute.forwarding_rules - name: forwarding_rules - title: Forwarding_rules + #/components/x-stackQL-resources/interconnect_groups/methods/delete + interconnect_groups_operational_status: + id: google.compute.interconnect_groups_operational_status + name: interconnect_groups_operational_status + title: Interconnect_groups_operational_status methods: - list: + get_operational_status: operation: $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1forwardingRules/get + #/paths/~1projects~1{project}~1global~1interconnectGroups~1{interconnectGroup}~1getOperationalStatus/get response: mediaType: application/json openAPIDocKey: '200' - insert: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/interconnect_groups_operational_status/methods/get_operational_status + insert: [] + update: [] + replace: [] + delete: [] + interconnect_groups_iam_policies: + id: google.compute.interconnect_groups_iam_policies + name: interconnect_groups_iam_policies + title: Interconnect_groups_iam_policies + methods: + get_iam_policy: operation: $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1forwardingRules/post + #/paths/~1projects~1{project}~1global~1interconnectGroups~1{resource}~1getIamPolicy/get response: mediaType: application/json openAPIDocKey: '200' - aggregated_list: + objectKey: $.bindings + set_iam_policy: operation: - $ref: '#/paths/~1projects~1{project}~1aggregated~1forwardingRules/get' + $ref: >- + #/paths/~1projects~1{project}~1global~1interconnectGroups~1{resource}~1setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.items[*].forwardingRules[*] - get: + test_iam_permissions: operation: $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1forwardingRules~1{forwardingRule}/get + #/paths/~1projects~1{project}~1global~1interconnectGroups~1{resource}~1testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' - delete: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/interconnect_groups_iam_policies/methods/get_iam_policy + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/interconnect_groups_iam_policies/methods/set_iam_policy + delete: [] + external_vpn_gateways: + id: google.compute.external_vpn_gateways + name: external_vpn_gateways + title: External_vpn_gateways + methods: + insert: operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1forwardingRules~1{forwardingRule}/delete + $ref: '#/paths/~1projects~1{project}~1global~1externalVpnGateways/post' response: mediaType: application/json openAPIDocKey: '200' - patch: + list: + operation: + $ref: '#/paths/~1projects~1{project}~1global~1externalVpnGateways/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get: operation: $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1forwardingRules~1{forwardingRule}/patch + #/paths/~1projects~1{project}~1global~1externalVpnGateways~1{externalVpnGateway}/get response: mediaType: application/json openAPIDocKey: '200' - set_target: + delete: operation: $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1forwardingRules~1{forwardingRule}~1setTarget/post + #/paths/~1projects~1{project}~1global~1externalVpnGateways~1{externalVpnGateway}/delete response: mediaType: application/json openAPIDocKey: '200' set_labels: operation: $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1forwardingRules~1{resource}~1setLabels/post + #/paths/~1projects~1{project}~1global~1externalVpnGateways~1{resource}~1setLabels/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/forwarding_rules/methods/get' - - $ref: '#/components/x-stackQL-resources/forwarding_rules/methods/list' + - $ref: '#/components/x-stackQL-resources/external_vpn_gateways/methods/get' - $ref: >- - #/components/x-stackQL-resources/forwarding_rules/methods/aggregated_list + #/components/x-stackQL-resources/external_vpn_gateways/methods/list insert: - - $ref: '#/components/x-stackQL-resources/forwarding_rules/methods/insert' - update: - - $ref: '#/components/x-stackQL-resources/forwarding_rules/methods/patch' + - $ref: >- + #/components/x-stackQL-resources/external_vpn_gateways/methods/insert + update: [] replace: [] delete: - - $ref: '#/components/x-stackQL-resources/forwarding_rules/methods/delete' - region_health_check_services: - id: google.compute.region_health_check_services - name: region_health_check_services - title: Region_health_check_services + - $ref: >- + #/components/x-stackQL-resources/external_vpn_gateways/methods/delete + external_vpn_gateways_iam_policies: + id: google.compute.external_vpn_gateways_iam_policies + name: external_vpn_gateways_iam_policies + title: External_vpn_gateways_iam_policies + methods: + test_iam_permissions: + operation: + $ref: >- + #/paths/~1projects~1{project}~1global~1externalVpnGateways~1{resource}~1testIamPermissions/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + forwarding_rules: + id: google.compute.forwarding_rules + name: forwarding_rules + title: Forwarding_rules methods: list: operation: $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1healthCheckServices/get + #/paths/~1projects~1{project}~1regions~1{region}~1forwardingRules/get response: mediaType: application/json openAPIDocKey: '200' insert: operation: $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1healthCheckServices/post + #/paths/~1projects~1{project}~1regions~1{region}~1forwardingRules/post response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1healthCheckServices~1{healthCheckService}/get + #/paths/~1projects~1{project}~1regions~1{region}~1forwardingRules~1{forwardingRule}/get response: mediaType: application/json openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1healthCheckServices~1{healthCheckService}/delete + #/paths/~1projects~1{project}~1regions~1{region}~1forwardingRules~1{forwardingRule}/delete response: mediaType: application/json openAPIDocKey: '200' patch: operation: $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1healthCheckServices~1{healthCheckService}/patch + #/paths/~1projects~1{project}~1regions~1{region}~1forwardingRules~1{forwardingRule}/patch response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/region_health_check_services/methods/get - - $ref: >- - #/components/x-stackQL-resources/region_health_check_services/methods/list - insert: - - $ref: >- - #/components/x-stackQL-resources/region_health_check_services/methods/insert - update: - - $ref: >- - #/components/x-stackQL-resources/region_health_check_services/methods/patch - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/region_health_check_services/methods/delete - health_checks: - id: google.compute.health_checks - name: health_checks - title: Health_checks - methods: - list: + set_target: operation: - $ref: '#/paths/~1projects~1{project}~1global~1healthChecks/get' + $ref: >- + #/paths/~1projects~1{project}~1regions~1{region}~1forwardingRules~1{forwardingRule}~1setTarget/post response: mediaType: application/json openAPIDocKey: '200' - insert: + set_labels: operation: - $ref: '#/paths/~1projects~1{project}~1global~1healthChecks/post' + $ref: >- + #/paths/~1projects~1{project}~1regions~1{region}~1forwardingRules~1{resource}~1setLabels/post response: mediaType: application/json openAPIDocKey: '200' - get: + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/forwarding_rules/methods/get' + - $ref: '#/components/x-stackQL-resources/forwarding_rules/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/forwarding_rules/methods/insert' + update: + - $ref: '#/components/x-stackQL-resources/forwarding_rules/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/forwarding_rules/methods/delete' + forwarding_rules_aggregated: + id: google.compute.forwarding_rules_aggregated + name: forwarding_rules_aggregated + title: Forwarding_rules_aggregated + methods: + aggregated_list: operation: - $ref: >- - #/paths/~1projects~1{project}~1global~1healthChecks~1{healthCheck}/get + $ref: '#/paths/~1projects~1{project}~1aggregated~1forwardingRules/get' response: mediaType: application/json openAPIDocKey: '200' - delete: + objectKey: $.items[*].forwardingRules[*] + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/forwarding_rules_aggregated/methods/aggregated_list + insert: [] + update: [] + replace: [] + delete: [] + health_check_services: + id: google.compute.health_check_services + name: health_check_services + title: Health_check_services + methods: + list: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1healthChecks~1{healthCheck}/delete + #/paths/~1projects~1{project}~1regions~1{region}~1healthCheckServices/get response: mediaType: application/json openAPIDocKey: '200' - update: + insert: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1healthChecks~1{healthCheck}/put + #/paths/~1projects~1{project}~1regions~1{region}~1healthCheckServices/post response: mediaType: application/json openAPIDocKey: '200' - patch: + get: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1healthChecks~1{healthCheck}/patch + #/paths/~1projects~1{project}~1regions~1{region}~1healthCheckServices~1{healthCheckService}/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/health_checks/methods/get' - - $ref: '#/components/x-stackQL-resources/health_checks/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/health_checks/methods/insert' - update: - - $ref: '#/components/x-stackQL-resources/health_checks/methods/patch' - replace: - - $ref: '#/components/x-stackQL-resources/health_checks/methods/update' delete: - - $ref: '#/components/x-stackQL-resources/health_checks/methods/delete' - health_checks_aggregated: - id: google.compute.health_checks_aggregated - name: health_checks_aggregated - title: Health_checks_aggregated - methods: - aggregated_list: operation: - $ref: '#/paths/~1projects~1{project}~1aggregated~1healthChecks/get' + $ref: >- + #/paths/~1projects~1{project}~1regions~1{region}~1healthCheckServices~1{healthCheckService}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1projects~1{project}~1regions~1{region}~1healthCheckServices~1{healthCheckService}/patch response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.items[*].healthChecks[*] sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/health_check_services/methods/get' - $ref: >- - #/components/x-stackQL-resources/health_checks_aggregated/methods/aggregated_list - insert: [] - update: [] + #/components/x-stackQL-resources/health_check_services/methods/list + insert: + - $ref: >- + #/components/x-stackQL-resources/health_check_services/methods/insert + update: + - $ref: >- + #/components/x-stackQL-resources/health_check_services/methods/patch replace: [] - delete: [] - region_health_checks: - id: google.compute.region_health_checks - name: region_health_checks - title: Region_health_checks + delete: + - $ref: >- + #/components/x-stackQL-resources/health_check_services/methods/delete + health_checks: + id: google.compute.health_checks + name: health_checks + title: Health_checks methods: list: operation: @@ -63811,20 +69162,36 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/region_health_checks/methods/get' - - $ref: '#/components/x-stackQL-resources/region_health_checks/methods/list' + - $ref: '#/components/x-stackQL-resources/health_checks/methods/get' + - $ref: '#/components/x-stackQL-resources/health_checks/methods/list' insert: - - $ref: >- - #/components/x-stackQL-resources/region_health_checks/methods/insert + - $ref: '#/components/x-stackQL-resources/health_checks/methods/insert' update: - - $ref: >- - #/components/x-stackQL-resources/region_health_checks/methods/patch + - $ref: '#/components/x-stackQL-resources/health_checks/methods/patch' replace: - - $ref: >- - #/components/x-stackQL-resources/region_health_checks/methods/update + - $ref: '#/components/x-stackQL-resources/health_checks/methods/update' delete: + - $ref: '#/components/x-stackQL-resources/health_checks/methods/delete' + health_checks_aggregated: + id: google.compute.health_checks_aggregated + name: health_checks_aggregated + title: Health_checks_aggregated + methods: + aggregated_list: + operation: + $ref: '#/paths/~1projects~1{project}~1aggregated~1healthChecks/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items[*].healthChecks[*] + sqlVerbs: + select: - $ref: >- - #/components/x-stackQL-resources/region_health_checks/methods/delete + #/components/x-stackQL-resources/health_checks_aggregated/methods/aggregated_list + insert: [] + update: [] + replace: [] + delete: [] http_health_checks: id: google.compute.http_health_checks name: http_health_checks @@ -63949,27 +69316,29 @@ components: methods: list: operation: - $ref: '#/paths/~1projects~1{project}~1global~1instanceTemplates/get' + $ref: >- + #/paths/~1projects~1{project}~1regions~1{region}~1instanceTemplates/get response: mediaType: application/json openAPIDocKey: '200' insert: operation: - $ref: '#/paths/~1projects~1{project}~1global~1instanceTemplates/post' + $ref: >- + #/paths/~1projects~1{project}~1regions~1{region}~1instanceTemplates/post response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1instanceTemplates~1{instanceTemplate}/get + #/paths/~1projects~1{project}~1regions~1{region}~1instanceTemplates~1{instanceTemplate}/get response: mediaType: application/json openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1instanceTemplates~1{instanceTemplate}/delete + #/paths/~1projects~1{project}~1regions~1{region}~1instanceTemplates~1{instanceTemplate}/delete response: mediaType: application/json openAPIDocKey: '200' @@ -64040,53 +69409,6 @@ components: - $ref: >- #/components/x-stackQL-resources/instance_templates_iam_policies/methods/set_iam_policy delete: [] - region_instance_templates: - id: google.compute.region_instance_templates - name: region_instance_templates - title: Region_instance_templates - methods: - list: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1instanceTemplates/get - response: - mediaType: application/json - openAPIDocKey: '200' - insert: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1instanceTemplates/post - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1instanceTemplates~1{instanceTemplate}/get - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1instanceTemplates~1{instanceTemplate}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/region_instance_templates/methods/get - - $ref: >- - #/components/x-stackQL-resources/region_instance_templates/methods/list - insert: - - $ref: >- - #/components/x-stackQL-resources/region_instance_templates/methods/insert - update: [] - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/region_instance_templates/methods/delete instance_settings: id: google.compute.instance_settings name: instance_settings @@ -64120,35 +69442,36 @@ components: methods: list: operation: - $ref: '#/paths/~1projects~1{project}~1zones~1{zone}~1instantSnapshots/get' + $ref: >- + #/paths/~1projects~1{project}~1regions~1{region}~1instantSnapshots/get response: mediaType: application/json openAPIDocKey: '200' insert: operation: $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1instantSnapshots/post + #/paths/~1projects~1{project}~1regions~1{region}~1instantSnapshots/post response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1instantSnapshots~1{instantSnapshot}/get + #/paths/~1projects~1{project}~1regions~1{region}~1instantSnapshots~1{instantSnapshot}/get response: mediaType: application/json openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1instantSnapshots~1{instantSnapshot}/delete + #/paths/~1projects~1{project}~1regions~1{region}~1instantSnapshots~1{instantSnapshot}/delete response: mediaType: application/json openAPIDocKey: '200' set_labels: operation: $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1instantSnapshots~1{resource}~1setLabels/post + #/paths/~1projects~1{project}~1regions~1{region}~1instantSnapshots~1{resource}~1setLabels/post response: mediaType: application/json openAPIDocKey: '200' @@ -64175,97 +69498,6 @@ components: id: google.compute.instant_snapshots_iam_policies name: instant_snapshots_iam_policies title: Instant_snapshots_iam_policies - methods: - get_iam_policy: - operation: - $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1instantSnapshots~1{resource}~1getIamPolicy/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.bindings - set_iam_policy: - operation: - $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1instantSnapshots~1{resource}~1setIamPolicy/post - response: - mediaType: application/json - openAPIDocKey: '200' - test_iam_permissions: - operation: - $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1instantSnapshots~1{resource}~1testIamPermissions/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/instant_snapshots_iam_policies/methods/get_iam_policy - insert: [] - update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/instant_snapshots_iam_policies/methods/set_iam_policy - delete: [] - region_instant_snapshots: - id: google.compute.region_instant_snapshots - name: region_instant_snapshots - title: Region_instant_snapshots - methods: - list: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1instantSnapshots/get - response: - mediaType: application/json - openAPIDocKey: '200' - insert: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1instantSnapshots/post - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1instantSnapshots~1{instantSnapshot}/get - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1instantSnapshots~1{instantSnapshot}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - set_labels: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1instantSnapshots~1{resource}~1setLabels/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/region_instant_snapshots/methods/get - - $ref: >- - #/components/x-stackQL-resources/region_instant_snapshots/methods/list - insert: - - $ref: >- - #/components/x-stackQL-resources/region_instant_snapshots/methods/insert - update: [] - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/region_instant_snapshots/methods/delete - region_instant_snapshots_iam_policies: - id: google.compute.region_instant_snapshots_iam_policies - name: region_instant_snapshots_iam_policies - title: Region_instant_snapshots_iam_policies methods: get_iam_policy: operation: @@ -64292,181 +69524,12 @@ components: sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/region_instant_snapshots_iam_policies/methods/get_iam_policy + #/components/x-stackQL-resources/instant_snapshots_iam_policies/methods/get_iam_policy insert: [] update: [] replace: - $ref: >- - #/components/x-stackQL-resources/region_instant_snapshots_iam_policies/methods/set_iam_policy - delete: [] - interconnect_attachments: - id: google.compute.interconnect_attachments - name: interconnect_attachments - title: Interconnect_attachments - methods: - list: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1interconnectAttachments/get - response: - mediaType: application/json - openAPIDocKey: '200' - insert: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1interconnectAttachments/post - response: - mediaType: application/json - openAPIDocKey: '200' - aggregated_list: - operation: - $ref: >- - #/paths/~1projects~1{project}~1aggregated~1interconnectAttachments/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.items[*].interconnectAttachments[*] - get: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1interconnectAttachments~1{interconnectAttachment}/get - response: - mediaType: application/json - openAPIDocKey: '200' - patch: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1interconnectAttachments~1{interconnectAttachment}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1interconnectAttachments~1{interconnectAttachment}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - set_labels: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1interconnectAttachments~1{resource}~1setLabels/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/interconnect_attachments/methods/get - - $ref: >- - #/components/x-stackQL-resources/interconnect_attachments/methods/list - - $ref: >- - #/components/x-stackQL-resources/interconnect_attachments/methods/aggregated_list - insert: - - $ref: >- - #/components/x-stackQL-resources/interconnect_attachments/methods/insert - update: - - $ref: >- - #/components/x-stackQL-resources/interconnect_attachments/methods/patch - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/interconnect_attachments/methods/delete - interconnects: - id: google.compute.interconnects - name: interconnects - title: Interconnects - methods: - insert: - operation: - $ref: '#/paths/~1projects~1{project}~1global~1interconnects/post' - response: - mediaType: application/json - openAPIDocKey: '200' - list: - operation: - $ref: '#/paths/~1projects~1{project}~1global~1interconnects/get' - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: >- - #/paths/~1projects~1{project}~1global~1interconnects~1{interconnect}/get - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: >- - #/paths/~1projects~1{project}~1global~1interconnects~1{interconnect}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - patch: - operation: - $ref: >- - #/paths/~1projects~1{project}~1global~1interconnects~1{interconnect}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - set_labels: - operation: - $ref: >- - #/paths/~1projects~1{project}~1global~1interconnects~1{resource}~1setLabels/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/interconnects/methods/get' - - $ref: '#/components/x-stackQL-resources/interconnects/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/interconnects/methods/insert' - update: - - $ref: '#/components/x-stackQL-resources/interconnects/methods/patch' - replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/interconnects/methods/delete' - interconnects_diagnostics: - id: google.compute.interconnects_diagnostics - name: interconnects_diagnostics - title: Interconnects_diagnostics - methods: - get_diagnostics: - operation: - $ref: >- - #/paths/~1projects~1{project}~1global~1interconnects~1{interconnect}~1getDiagnostics/get - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/interconnects_diagnostics/methods/get_diagnostics - insert: [] - update: [] - replace: [] - delete: [] - interconnects_macsec_config: - id: google.compute.interconnects_macsec_config - name: interconnects_macsec_config - title: Interconnects_macsec_config - methods: - get_macsec_config: - operation: - $ref: >- - #/paths/~1projects~1{project}~1global~1interconnects~1{interconnect}~1getMacsecConfig/get - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/interconnects_macsec_config/methods/get_macsec_config - insert: [] - update: [] - replace: [] + #/components/x-stackQL-resources/instant_snapshots_iam_policies/methods/set_iam_policy delete: [] interconnect_locations: id: google.compute.interconnect_locations @@ -64579,6 +69642,12 @@ components: response: mediaType: application/json openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1projects~1{project}~1global~1licenses~1{license}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' list: operation: $ref: '#/paths/~1projects~1{project}~1global~1licenses/get' @@ -64597,7 +69666,8 @@ components: - $ref: '#/components/x-stackQL-resources/licenses/methods/list' insert: - $ref: '#/components/x-stackQL-resources/licenses/methods/insert' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/licenses/methods/update' replace: [] delete: - $ref: '#/components/x-stackQL-resources/licenses/methods/delete' @@ -64669,6 +69739,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + set_labels: + operation: + $ref: >- + #/paths/~1projects~1{project}~1global~1machineImages~1{resource}~1setLabels/post + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/machine_images/methods/get' @@ -64915,14 +69992,14 @@ components: list: operation: $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1networkEndpointGroups/get + #/paths/~1projects~1{project}~1regions~1{region}~1networkEndpointGroups/get response: mediaType: application/json openAPIDocKey: '200' insert: operation: $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1networkEndpointGroups/post + #/paths/~1projects~1{project}~1regions~1{region}~1networkEndpointGroups/post response: mediaType: application/json openAPIDocKey: '200' @@ -64934,186 +70011,6 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.items[*].networkEndpointGroups[*] - get: - operation: - $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1networkEndpointGroups~1{networkEndpointGroup}/get - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1networkEndpointGroups~1{networkEndpointGroup}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - attach_network_endpoints: - operation: - $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1networkEndpointGroups~1{networkEndpointGroup}~1attachNetworkEndpoints/post - response: - mediaType: application/json - openAPIDocKey: '200' - detach_network_endpoints: - operation: - $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1networkEndpointGroups~1{networkEndpointGroup}~1detachNetworkEndpoints/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/network_endpoint_groups/methods/get - - $ref: >- - #/components/x-stackQL-resources/network_endpoint_groups/methods/list - - $ref: >- - #/components/x-stackQL-resources/network_endpoint_groups/methods/aggregated_list - insert: - - $ref: >- - #/components/x-stackQL-resources/network_endpoint_groups/methods/insert - update: [] - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/network_endpoint_groups/methods/delete - network_endpoint_groups_network_endpoints: - id: google.compute.network_endpoint_groups_network_endpoints - name: network_endpoint_groups_network_endpoints - title: Network_endpoint_groups_network_endpoints - methods: - list_network_endpoints: - operation: - $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1networkEndpointGroups~1{networkEndpointGroup}~1listNetworkEndpoints/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/network_endpoint_groups_network_endpoints/methods/list_network_endpoints - insert: [] - update: [] - replace: [] - delete: [] - network_endpoint_groups_iam_policies: - id: google.compute.network_endpoint_groups_iam_policies - name: network_endpoint_groups_iam_policies - title: Network_endpoint_groups_iam_policies - methods: - test_iam_permissions: - operation: - $ref: >- - #/paths/~1projects~1{project}~1zones~1{zone}~1networkEndpointGroups~1{resource}~1testIamPermissions/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: [] - global_network_endpoint_groups: - id: google.compute.global_network_endpoint_groups - name: global_network_endpoint_groups - title: Global_network_endpoint_groups - methods: - list: - operation: - $ref: '#/paths/~1projects~1{project}~1global~1networkEndpointGroups/get' - response: - mediaType: application/json - openAPIDocKey: '200' - insert: - operation: - $ref: '#/paths/~1projects~1{project}~1global~1networkEndpointGroups/post' - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: >- - #/paths/~1projects~1{project}~1global~1networkEndpointGroups~1{networkEndpointGroup}/get - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: >- - #/paths/~1projects~1{project}~1global~1networkEndpointGroups~1{networkEndpointGroup}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - attach_network_endpoints: - operation: - $ref: >- - #/paths/~1projects~1{project}~1global~1networkEndpointGroups~1{networkEndpointGroup}~1attachNetworkEndpoints/post - response: - mediaType: application/json - openAPIDocKey: '200' - detach_network_endpoints: - operation: - $ref: >- - #/paths/~1projects~1{project}~1global~1networkEndpointGroups~1{networkEndpointGroup}~1detachNetworkEndpoints/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/global_network_endpoint_groups/methods/get - - $ref: >- - #/components/x-stackQL-resources/global_network_endpoint_groups/methods/list - insert: - - $ref: >- - #/components/x-stackQL-resources/global_network_endpoint_groups/methods/insert - update: [] - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/global_network_endpoint_groups/methods/delete - global_network_endpoint_groups_network_endpoints: - id: google.compute.global_network_endpoint_groups_network_endpoints - name: global_network_endpoint_groups_network_endpoints - title: Global_network_endpoint_groups_network_endpoints - methods: - list_network_endpoints: - operation: - $ref: >- - #/paths/~1projects~1{project}~1global~1networkEndpointGroups~1{networkEndpointGroup}~1listNetworkEndpoints/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/global_network_endpoint_groups_network_endpoints/methods/list_network_endpoints - insert: [] - update: [] - replace: [] - delete: [] - region_network_endpoint_groups: - id: google.compute.region_network_endpoint_groups - name: region_network_endpoint_groups - title: Region_network_endpoint_groups - methods: - list: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1networkEndpointGroups/get - response: - mediaType: application/json - openAPIDocKey: '200' - insert: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1networkEndpointGroups/post - response: - mediaType: application/json - openAPIDocKey: '200' get: operation: $ref: >- @@ -65145,21 +70042,23 @@ components: sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/region_network_endpoint_groups/methods/get + #/components/x-stackQL-resources/network_endpoint_groups/methods/get + - $ref: >- + #/components/x-stackQL-resources/network_endpoint_groups/methods/list - $ref: >- - #/components/x-stackQL-resources/region_network_endpoint_groups/methods/list + #/components/x-stackQL-resources/network_endpoint_groups/methods/aggregated_list insert: - $ref: >- - #/components/x-stackQL-resources/region_network_endpoint_groups/methods/insert + #/components/x-stackQL-resources/network_endpoint_groups/methods/insert update: [] replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/region_network_endpoint_groups/methods/delete - region_network_endpoint_groups_network_endpoints: - id: google.compute.region_network_endpoint_groups_network_endpoints - name: region_network_endpoint_groups_network_endpoints - title: Region_network_endpoint_groups_network_endpoints + #/components/x-stackQL-resources/network_endpoint_groups/methods/delete + network_endpoints: + id: google.compute.network_endpoints + name: network_endpoints + title: Network_endpoints methods: list_network_endpoints: operation: @@ -65171,7 +70070,25 @@ components: sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/region_network_endpoint_groups_network_endpoints/methods/list_network_endpoints + #/components/x-stackQL-resources/network_endpoints/methods/list_network_endpoints + insert: [] + update: [] + replace: [] + delete: [] + network_endpoint_groups_iam_policies: + id: google.compute.network_endpoint_groups_iam_policies + name: network_endpoint_groups_iam_policies + title: Network_endpoint_groups_iam_policies + methods: + test_iam_permissions: + operation: + $ref: >- + #/paths/~1projects~1{project}~1zones~1{zone}~1networkEndpointGroups~1{resource}~1testIamPermissions/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] insert: [] update: [] replace: [] @@ -65193,9 +70110,6 @@ components: response: mediaType: application/json openAPIDocKey: '200' - asyncOverrideMediaType: application/json - async_schema_override: - $ref: '#/components/schemas/Network' get: operation: $ref: '#/paths/~1projects~1{project}~1global~1networks~1{network}/get' @@ -65214,6 +70128,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + request_remove_peering: + operation: + $ref: >- + #/paths/~1projects~1{project}~1global~1networks~1{network}~1requestRemovePeering/post + response: + mediaType: application/json + openAPIDocKey: '200' switch_to_custom_mode: operation: $ref: >- @@ -65588,10 +70509,10 @@ components: update: [] replace: [] delete: [] - region_notification_endpoints: - id: google.compute.region_notification_endpoints - name: region_notification_endpoints - title: Region_notification_endpoints + notification_endpoints: + id: google.compute.notification_endpoints + name: notification_endpoints + title: Notification_endpoints methods: list: operation: @@ -65624,17 +70545,17 @@ components: sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/region_notification_endpoints/methods/get + #/components/x-stackQL-resources/notification_endpoints/methods/get - $ref: >- - #/components/x-stackQL-resources/region_notification_endpoints/methods/list + #/components/x-stackQL-resources/notification_endpoints/methods/list insert: - $ref: >- - #/components/x-stackQL-resources/region_notification_endpoints/methods/insert + #/components/x-stackQL-resources/notification_endpoints/methods/insert update: [] replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/region_notification_endpoints/methods/delete + #/components/x-stackQL-resources/notification_endpoints/methods/delete packet_mirrorings: id: google.compute.packet_mirrorings name: packet_mirrorings @@ -65802,18 +70723,6 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/xpn_hosts/methods/list_xpn_hosts' - insert: [] - update: [] - replace: [] - delete: [] - xpn_host: - id: google.compute.xpn_host - name: xpn_host - title: Xpn_host - methods: get_xpn_host: operation: $ref: '#/paths/~1projects~1{project}~1getXpnHost/get' @@ -65822,7 +70731,8 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/xpn_host/methods/get_xpn_host' + - $ref: '#/components/x-stackQL-resources/xpn_hosts/methods/list_xpn_hosts' + - $ref: '#/components/x-stackQL-resources/xpn_hosts/methods/get_xpn_host' insert: [] update: [] replace: [] @@ -65917,162 +70827,343 @@ components: delete: - $ref: >- #/components/x-stackQL-resources/public_advertised_prefixes/methods/delete - global_public_delegated_prefixes: - id: google.compute.global_public_delegated_prefixes - name: global_public_delegated_prefixes - title: Global_public_delegated_prefixes + public_delegated_prefixes: + id: google.compute.public_delegated_prefixes + name: public_delegated_prefixes + title: Public_delegated_prefixes methods: list: operation: - $ref: '#/paths/~1projects~1{project}~1global~1publicDelegatedPrefixes/get' + $ref: >- + #/paths/~1projects~1{project}~1regions~1{region}~1publicDelegatedPrefixes/get response: mediaType: application/json openAPIDocKey: '200' insert: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1publicDelegatedPrefixes/post + #/paths/~1projects~1{project}~1regions~1{region}~1publicDelegatedPrefixes/post response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1publicDelegatedPrefixes~1{publicDelegatedPrefix}/get + #/paths/~1projects~1{project}~1regions~1{region}~1publicDelegatedPrefixes~1{publicDelegatedPrefix}/get response: mediaType: application/json openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1publicDelegatedPrefixes~1{publicDelegatedPrefix}/delete + #/paths/~1projects~1{project}~1regions~1{region}~1publicDelegatedPrefixes~1{publicDelegatedPrefix}/delete response: mediaType: application/json openAPIDocKey: '200' patch: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1publicDelegatedPrefixes~1{publicDelegatedPrefix}/patch + #/paths/~1projects~1{project}~1regions~1{region}~1publicDelegatedPrefixes~1{publicDelegatedPrefix}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + announce: + operation: + $ref: >- + #/paths/~1projects~1{project}~1regions~1{region}~1publicDelegatedPrefixes~1{publicDelegatedPrefix}~1announce/post + response: + mediaType: application/json + openAPIDocKey: '200' + withdraw: + operation: + $ref: >- + #/paths/~1projects~1{project}~1regions~1{region}~1publicDelegatedPrefixes~1{publicDelegatedPrefix}~1withdraw/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/global_public_delegated_prefixes/methods/get + #/components/x-stackQL-resources/public_delegated_prefixes/methods/get - $ref: >- - #/components/x-stackQL-resources/global_public_delegated_prefixes/methods/list + #/components/x-stackQL-resources/public_delegated_prefixes/methods/list insert: - $ref: >- - #/components/x-stackQL-resources/global_public_delegated_prefixes/methods/insert + #/components/x-stackQL-resources/public_delegated_prefixes/methods/insert update: - $ref: >- - #/components/x-stackQL-resources/global_public_delegated_prefixes/methods/patch + #/components/x-stackQL-resources/public_delegated_prefixes/methods/patch replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/global_public_delegated_prefixes/methods/delete - public_delegated_prefixes: - id: google.compute.public_delegated_prefixes - name: public_delegated_prefixes - title: Public_delegated_prefixes + #/components/x-stackQL-resources/public_delegated_prefixes/methods/delete + public_delegated_prefixes_aggregated: + id: google.compute.public_delegated_prefixes_aggregated + name: public_delegated_prefixes_aggregated + title: Public_delegated_prefixes_aggregated methods: - list: + aggregated_list: operation: $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1publicDelegatedPrefixes/get + #/paths/~1projects~1{project}~1aggregated~1publicDelegatedPrefixes/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items[*].publicDelegatedPrefixes[*] + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/public_delegated_prefixes_aggregated/methods/aggregated_list + insert: [] + update: [] + replace: [] + delete: [] + regions: + id: google.compute.regions + name: regions + title: Regions + methods: + list: + operation: + $ref: '#/paths/~1projects~1{project}~1regions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1projects~1{project}~1regions~1{region}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/regions/methods/get' + - $ref: '#/components/x-stackQL-resources/regions/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + subnetworks: + id: google.compute.subnetworks + name: subnetworks + title: Subnetworks + methods: + list: + operation: + $ref: '#/paths/~1projects~1{project}~1regions~1{region}~1subnetworks/get' response: mediaType: application/json openAPIDocKey: '200' insert: operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1publicDelegatedPrefixes/post + $ref: '#/paths/~1projects~1{project}~1regions~1{region}~1subnetworks/post' response: mediaType: application/json openAPIDocKey: '200' + aggregated_list: + operation: + $ref: '#/paths/~1projects~1{project}~1aggregated~1subnetworks/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items[*].subnetworks[*] get: operation: $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1publicDelegatedPrefixes~1{publicDelegatedPrefix}/get + #/paths/~1projects~1{project}~1regions~1{region}~1subnetworks~1{subnetwork}/get response: mediaType: application/json openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1publicDelegatedPrefixes~1{publicDelegatedPrefix}/delete + #/paths/~1projects~1{project}~1regions~1{region}~1subnetworks~1{subnetwork}/delete response: mediaType: application/json openAPIDocKey: '200' patch: operation: $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1publicDelegatedPrefixes~1{publicDelegatedPrefix}/patch + #/paths/~1projects~1{project}~1regions~1{region}~1subnetworks~1{subnetwork}/patch response: mediaType: application/json openAPIDocKey: '200' - announce: + expand_ip_cidr_range: operation: $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1publicDelegatedPrefixes~1{publicDelegatedPrefix}~1announce/post + #/paths/~1projects~1{project}~1regions~1{region}~1subnetworks~1{subnetwork}~1expandIpCidrRange/post response: mediaType: application/json openAPIDocKey: '200' - withdraw: + set_private_ip_google_access: operation: $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1publicDelegatedPrefixes~1{publicDelegatedPrefix}~1withdraw/post + #/paths/~1projects~1{project}~1regions~1{region}~1subnetworks~1{subnetwork}~1setPrivateIpGoogleAccess/post response: mediaType: application/json openAPIDocKey: '200' - aggregated_list: + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/subnetworks/methods/get' + - $ref: '#/components/x-stackQL-resources/subnetworks/methods/list' + - $ref: >- + #/components/x-stackQL-resources/subnetworks/methods/aggregated_list + insert: + - $ref: '#/components/x-stackQL-resources/subnetworks/methods/insert' + update: + - $ref: '#/components/x-stackQL-resources/subnetworks/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/subnetworks/methods/delete' + subnetworks_usable: + id: google.compute.subnetworks_usable + name: subnetworks_usable + title: Subnetworks_usable + methods: + list_usable: operation: $ref: >- - #/paths/~1projects~1{project}~1aggregated~1publicDelegatedPrefixes/get + #/paths/~1projects~1{project}~1aggregated~1subnetworks~1listUsable/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.items[*].publicDelegatedPrefixes[*] sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/public_delegated_prefixes/methods/get - - $ref: >- - #/components/x-stackQL-resources/public_delegated_prefixes/methods/list - - $ref: >- - #/components/x-stackQL-resources/public_delegated_prefixes/methods/aggregated_list - insert: + #/components/x-stackQL-resources/subnetworks_usable/methods/list_usable + insert: [] + update: [] + replace: [] + delete: [] + subnetworks_iam_policies: + id: google.compute.subnetworks_iam_policies + name: subnetworks_iam_policies + title: Subnetworks_iam_policies + methods: + get_iam_policy: + operation: + $ref: >- + #/paths/~1projects~1{project}~1regions~1{region}~1subnetworks~1{resource}~1getIamPolicy/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.bindings + set_iam_policy: + operation: + $ref: >- + #/paths/~1projects~1{project}~1regions~1{region}~1subnetworks~1{resource}~1setIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + test_iam_permissions: + operation: + $ref: >- + #/paths/~1projects~1{project}~1regions~1{region}~1subnetworks~1{resource}~1testIamPermissions/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: - $ref: >- - #/components/x-stackQL-resources/public_delegated_prefixes/methods/insert - update: + #/components/x-stackQL-resources/subnetworks_iam_policies/methods/get_iam_policy + insert: [] + update: [] + replace: - $ref: >- - #/components/x-stackQL-resources/public_delegated_prefixes/methods/patch + #/components/x-stackQL-resources/subnetworks_iam_policies/methods/set_iam_policy + delete: [] + network_profiles: + id: google.compute.network_profiles + name: network_profiles + title: Network_profiles + methods: + list: + operation: + $ref: '#/paths/~1projects~1{project}~1global~1networkProfiles/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1projects~1{project}~1global~1networkProfiles~1{networkProfile}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/network_profiles/methods/get' + - $ref: '#/components/x-stackQL-resources/network_profiles/methods/list' + insert: [] + update: [] replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/public_delegated_prefixes/methods/delete - regions: - id: google.compute.regions - name: regions - title: Regions + delete: [] + reservation_blocks: + id: google.compute.reservation_blocks + name: reservation_blocks + title: Reservation_blocks methods: + get: + operation: + $ref: >- + #/paths/~1projects~1{project}~1zones~1{zone}~1reservations~1{reservation}~1reservationBlocks~1{reservationBlock}/get + response: + mediaType: application/json + openAPIDocKey: '200' list: operation: - $ref: '#/paths/~1projects~1{project}~1regions/get' + $ref: >- + #/paths/~1projects~1{project}~1zones~1{zone}~1reservations~1{reservation}~1reservationBlocks/get + response: + mediaType: application/json + openAPIDocKey: '200' + perform_maintenance: + operation: + $ref: >- + #/paths/~1projects~1{project}~1zones~1{zone}~1reservations~1{reservation}~1reservationBlocks~1{reservationBlock}~1performMaintenance/post response: mediaType: application/json openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/reservation_blocks/methods/get' + - $ref: '#/components/x-stackQL-resources/reservation_blocks/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + reservation_sub_blocks: + id: google.compute.reservation_sub_blocks + name: reservation_sub_blocks + title: Reservation_sub_blocks + methods: get: operation: - $ref: '#/paths/~1projects~1{project}~1regions~1{region}/get' + $ref: >- + #/paths/~1projects~1{project}~1zones~1{zone}~1{parentName}~1reservationSubBlocks~1{reservationSubBlock}/get + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1projects~1{project}~1zones~1{zone}~1{parentName}~1reservationSubBlocks/get + response: + mediaType: application/json + openAPIDocKey: '200' + perform_maintenance: + operation: + $ref: >- + #/paths/~1projects~1{project}~1zones~1{zone}~1{parentName}~1reservationSubBlocks~1{reservationSubBlock}~1performMaintenance/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/regions/methods/get' - - $ref: '#/components/x-stackQL-resources/regions/methods/list' + - $ref: >- + #/components/x-stackQL-resources/reservation_sub_blocks/methods/get + - $ref: >- + #/components/x-stackQL-resources/reservation_sub_blocks/methods/list insert: [] update: [] replace: [] @@ -66272,6 +71363,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + patch_route_policy: + operation: + $ref: >- + #/paths/~1projects~1{project}~1regions~1{region}~1routers~1{router}~1patchRoutePolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/routers/methods/get' @@ -66281,14 +71379,16 @@ components: - $ref: '#/components/x-stackQL-resources/routers/methods/insert' update: - $ref: '#/components/x-stackQL-resources/routers/methods/patch' + - $ref: >- + #/components/x-stackQL-resources/routers/methods/patch_route_policy replace: - $ref: '#/components/x-stackQL-resources/routers/methods/update' delete: - $ref: '#/components/x-stackQL-resources/routers/methods/delete' - routers_router_status: - id: google.compute.routers_router_status - name: routers_router_status - title: Routers_router_status + router_status: + id: google.compute.router_status + name: router_status + title: Router_status methods: get_router_status: operation: @@ -66300,15 +71400,15 @@ components: sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/routers_router_status/methods/get_router_status + #/components/x-stackQL-resources/router_status/methods/get_router_status insert: [] update: [] replace: [] delete: [] - routers_nat_mapping_info: - id: google.compute.routers_nat_mapping_info - name: routers_nat_mapping_info - title: Routers_nat_mapping_info + router_nat_mapping_info: + id: google.compute.router_nat_mapping_info + name: router_nat_mapping_info + title: Router_nat_mapping_info methods: get_nat_mapping_info: operation: @@ -66321,15 +71421,15 @@ components: sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/routers_nat_mapping_info/methods/get_nat_mapping_info + #/components/x-stackQL-resources/router_nat_mapping_info/methods/get_nat_mapping_info insert: [] update: [] replace: [] delete: [] - routers_nat_ip_info: - id: google.compute.routers_nat_ip_info - name: routers_nat_ip_info - title: Routers_nat_ip_info + router_nat_ip_info: + id: google.compute.router_nat_ip_info + name: router_nat_ip_info + title: Router_nat_ip_info methods: get_nat_ip_info: operation: @@ -66341,7 +71441,74 @@ components: sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/routers_nat_ip_info/methods/get_nat_ip_info + #/components/x-stackQL-resources/router_nat_ip_info/methods/get_nat_ip_info + insert: [] + update: [] + replace: [] + delete: [] + route_policies: + id: google.compute.route_policies + name: route_policies + title: Route_policies + methods: + update_route_policy: + operation: + $ref: >- + #/paths/~1projects~1{project}~1regions~1{region}~1routers~1{router}~1updateRoutePolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete_route_policy: + operation: + $ref: >- + #/paths/~1projects~1{project}~1regions~1{region}~1routers~1{router}~1deleteRoutePolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + get_route_policy: + operation: + $ref: >- + #/paths/~1projects~1{project}~1regions~1{region}~1routers~1{router}~1getRoutePolicy/get + response: + mediaType: application/json + openAPIDocKey: '200' + list_route_policies: + operation: + $ref: >- + #/paths/~1projects~1{project}~1regions~1{region}~1routers~1{router}~1listRoutePolicies/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/route_policies/methods/get_route_policy + - $ref: >- + #/components/x-stackQL-resources/route_policies/methods/list_route_policies + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/route_policies/methods/update_route_policy + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/route_policies/methods/delete_route_policy + router_bgp_routes: + id: google.compute.router_bgp_routes + name: router_bgp_routes + title: Router_bgp_routes + methods: + list_bgp_routes: + operation: + $ref: >- + #/paths/~1projects~1{project}~1regions~1{region}~1routers~1{router}~1listBgpRoutes/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/router_bgp_routes/methods/list_bgp_routes insert: [] update: [] replace: [] @@ -66477,27 +71644,29 @@ components: methods: list: operation: - $ref: '#/paths/~1projects~1{project}~1global~1sslCertificates/get' + $ref: >- + #/paths/~1projects~1{project}~1regions~1{region}~1sslCertificates/get response: mediaType: application/json openAPIDocKey: '200' insert: operation: - $ref: '#/paths/~1projects~1{project}~1global~1sslCertificates/post' + $ref: >- + #/paths/~1projects~1{project}~1regions~1{region}~1sslCertificates/post response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1sslCertificates~1{sslCertificate}/get + #/paths/~1projects~1{project}~1regions~1{region}~1sslCertificates~1{sslCertificate}/get response: mediaType: application/json openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1sslCertificates~1{sslCertificate}/delete + #/paths/~1projects~1{project}~1regions~1{region}~1sslCertificates~1{sslCertificate}/delete response: mediaType: application/json openAPIDocKey: '200' @@ -66531,53 +71700,6 @@ components: update: [] replace: [] delete: [] - region_ssl_certificates: - id: google.compute.region_ssl_certificates - name: region_ssl_certificates - title: Region_ssl_certificates - methods: - list: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1sslCertificates/get - response: - mediaType: application/json - openAPIDocKey: '200' - insert: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1sslCertificates/post - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1sslCertificates~1{sslCertificate}/get - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1sslCertificates~1{sslCertificate}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/region_ssl_certificates/methods/get - - $ref: >- - #/components/x-stackQL-resources/region_ssl_certificates/methods/list - insert: - - $ref: >- - #/components/x-stackQL-resources/region_ssl_certificates/methods/insert - update: [] - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/region_ssl_certificates/methods/delete ssl_policies: id: google.compute.ssl_policies name: ssl_policies @@ -66585,34 +71707,34 @@ components: methods: list: operation: - $ref: '#/paths/~1projects~1{project}~1global~1sslPolicies/get' + $ref: '#/paths/~1projects~1{project}~1regions~1{region}~1sslPolicies/get' response: mediaType: application/json openAPIDocKey: '200' insert: operation: - $ref: '#/paths/~1projects~1{project}~1global~1sslPolicies/post' + $ref: '#/paths/~1projects~1{project}~1regions~1{region}~1sslPolicies/post' response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1sslPolicies~1{sslPolicy}/get + #/paths/~1projects~1{project}~1regions~1{region}~1sslPolicies~1{sslPolicy}/get response: mediaType: application/json openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1sslPolicies~1{sslPolicy}/delete + #/paths/~1projects~1{project}~1regions~1{region}~1sslPolicies~1{sslPolicy}/delete response: mediaType: application/json openAPIDocKey: '200' patch: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1sslPolicies~1{sslPolicy}/patch + #/paths/~1projects~1{project}~1regions~1{region}~1sslPolicies~1{sslPolicy}/patch response: mediaType: application/json openAPIDocKey: '200' @@ -66635,7 +71757,7 @@ components: list_available_features: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1sslPolicies~1listAvailableFeatures/get + #/paths/~1projects~1{project}~1regions~1{region}~1sslPolicies~1listAvailableFeatures/get response: mediaType: application/json openAPIDocKey: '200' @@ -66667,77 +71789,6 @@ components: update: [] replace: [] delete: [] - region_ssl_policies: - id: google.compute.region_ssl_policies - name: region_ssl_policies - title: Region_ssl_policies - methods: - list: - operation: - $ref: '#/paths/~1projects~1{project}~1regions~1{region}~1sslPolicies/get' - response: - mediaType: application/json - openAPIDocKey: '200' - insert: - operation: - $ref: '#/paths/~1projects~1{project}~1regions~1{region}~1sslPolicies/post' - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1sslPolicies~1{sslPolicy}/get - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1sslPolicies~1{sslPolicy}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - patch: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1sslPolicies~1{sslPolicy}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/region_ssl_policies/methods/get' - - $ref: '#/components/x-stackQL-resources/region_ssl_policies/methods/list' - insert: - - $ref: >- - #/components/x-stackQL-resources/region_ssl_policies/methods/insert - update: - - $ref: '#/components/x-stackQL-resources/region_ssl_policies/methods/patch' - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/region_ssl_policies/methods/delete - region_ssl_policies_available_features: - id: google.compute.region_ssl_policies_available_features - name: region_ssl_policies_available_features - title: Region_ssl_policies_available_features - methods: - list_available_features: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1sslPolicies~1listAvailableFeatures/get - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/region_ssl_policies_available_features/methods/list_available_features - insert: [] - update: [] - replace: [] - delete: [] storage_pool_types: id: google.compute.storage_pool_types name: storage_pool_types @@ -66888,135 +71939,6 @@ components: update: [] replace: [] delete: [] - subnetworks: - id: google.compute.subnetworks - name: subnetworks - title: Subnetworks - methods: - list: - operation: - $ref: '#/paths/~1projects~1{project}~1regions~1{region}~1subnetworks/get' - response: - mediaType: application/json - openAPIDocKey: '200' - insert: - operation: - $ref: '#/paths/~1projects~1{project}~1regions~1{region}~1subnetworks/post' - response: - mediaType: application/json - openAPIDocKey: '200' - aggregated_list: - operation: - $ref: '#/paths/~1projects~1{project}~1aggregated~1subnetworks/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.items[*].subnetworks[*] - get: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1subnetworks~1{subnetwork}/get - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1subnetworks~1{subnetwork}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - patch: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1subnetworks~1{subnetwork}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - expand_ip_cidr_range: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1subnetworks~1{subnetwork}~1expandIpCidrRange/post - response: - mediaType: application/json - openAPIDocKey: '200' - set_private_ip_google_access: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1subnetworks~1{subnetwork}~1setPrivateIpGoogleAccess/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/subnetworks/methods/get' - - $ref: '#/components/x-stackQL-resources/subnetworks/methods/list' - - $ref: >- - #/components/x-stackQL-resources/subnetworks/methods/aggregated_list - insert: - - $ref: '#/components/x-stackQL-resources/subnetworks/methods/insert' - update: - - $ref: '#/components/x-stackQL-resources/subnetworks/methods/patch' - replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/subnetworks/methods/delete' - subnetworks_usable: - id: google.compute.subnetworks_usable - name: subnetworks_usable - title: Subnetworks_usable - methods: - list_usable: - operation: - $ref: >- - #/paths/~1projects~1{project}~1aggregated~1subnetworks~1listUsable/get - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/subnetworks_usable/methods/list_usable - insert: [] - update: [] - replace: [] - delete: [] - subnetworks_iam_policies: - id: google.compute.subnetworks_iam_policies - name: subnetworks_iam_policies - title: Subnetworks_iam_policies - methods: - get_iam_policy: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1subnetworks~1{resource}~1getIamPolicy/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.bindings - set_iam_policy: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1subnetworks~1{resource}~1setIamPolicy/post - response: - mediaType: application/json - openAPIDocKey: '200' - test_iam_permissions: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1subnetworks~1{resource}~1testIamPermissions/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/subnetworks_iam_policies/methods/get_iam_policy - insert: [] - update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/subnetworks_iam_policies/methods/set_iam_policy - delete: [] target_grpc_proxies: id: google.compute.target_grpc_proxies name: target_grpc_proxies @@ -67075,27 +71997,29 @@ components: methods: list: operation: - $ref: '#/paths/~1projects~1{project}~1global~1targetHttpProxies/get' + $ref: >- + #/paths/~1projects~1{project}~1regions~1{region}~1targetHttpProxies/get response: mediaType: application/json openAPIDocKey: '200' insert: operation: - $ref: '#/paths/~1projects~1{project}~1global~1targetHttpProxies/post' + $ref: >- + #/paths/~1projects~1{project}~1regions~1{region}~1targetHttpProxies/post response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1targetHttpProxies~1{targetHttpProxy}/get + #/paths/~1projects~1{project}~1regions~1{region}~1targetHttpProxies~1{targetHttpProxy}/get response: mediaType: application/json openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1targetHttpProxies~1{targetHttpProxy}/delete + #/paths/~1projects~1{project}~1regions~1{region}~1targetHttpProxies~1{targetHttpProxy}/delete response: mediaType: application/json openAPIDocKey: '200' @@ -67109,7 +72033,7 @@ components: set_url_map: operation: $ref: >- - #/paths/~1projects~1{project}~1targetHttpProxies~1{targetHttpProxy}~1setUrlMap/post + #/paths/~1projects~1{project}~1regions~1{region}~1targetHttpProxies~1{targetHttpProxy}~1setUrlMap/post response: mediaType: application/json openAPIDocKey: '200' @@ -67146,60 +72070,6 @@ components: update: [] replace: [] delete: [] - region_target_http_proxies: - id: google.compute.region_target_http_proxies - name: region_target_http_proxies - title: Region_target_http_proxies - methods: - list: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1targetHttpProxies/get - response: - mediaType: application/json - openAPIDocKey: '200' - insert: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1targetHttpProxies/post - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1targetHttpProxies~1{targetHttpProxy}/get - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1targetHttpProxies~1{targetHttpProxy}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - set_url_map: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1targetHttpProxies~1{targetHttpProxy}~1setUrlMap/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/region_target_http_proxies/methods/get - - $ref: >- - #/components/x-stackQL-resources/region_target_http_proxies/methods/list - insert: - - $ref: >- - #/components/x-stackQL-resources/region_target_http_proxies/methods/insert - update: [] - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/region_target_http_proxies/methods/delete target_https_proxies: id: google.compute.target_https_proxies name: target_https_proxies @@ -67207,48 +72077,50 @@ components: methods: list: operation: - $ref: '#/paths/~1projects~1{project}~1global~1targetHttpsProxies/get' + $ref: >- + #/paths/~1projects~1{project}~1regions~1{region}~1targetHttpsProxies/get response: mediaType: application/json openAPIDocKey: '200' insert: operation: - $ref: '#/paths/~1projects~1{project}~1global~1targetHttpsProxies/post' + $ref: >- + #/paths/~1projects~1{project}~1regions~1{region}~1targetHttpsProxies/post response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1targetHttpsProxies~1{targetHttpsProxy}/get + #/paths/~1projects~1{project}~1regions~1{region}~1targetHttpsProxies~1{targetHttpsProxy}/get response: mediaType: application/json openAPIDocKey: '200' patch: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1targetHttpsProxies~1{targetHttpsProxy}/patch + #/paths/~1projects~1{project}~1regions~1{region}~1targetHttpsProxies~1{targetHttpsProxy}/patch response: mediaType: application/json openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1targetHttpsProxies~1{targetHttpsProxy}/delete + #/paths/~1projects~1{project}~1regions~1{region}~1targetHttpsProxies~1{targetHttpsProxy}/delete response: mediaType: application/json openAPIDocKey: '200' set_url_map: operation: $ref: >- - #/paths/~1projects~1{project}~1targetHttpsProxies~1{targetHttpsProxy}~1setUrlMap/post + #/paths/~1projects~1{project}~1regions~1{region}~1targetHttpsProxies~1{targetHttpsProxy}~1setUrlMap/post response: mediaType: application/json openAPIDocKey: '200' set_ssl_certificates: operation: $ref: >- - #/paths/~1projects~1{project}~1targetHttpsProxies~1{targetHttpsProxy}~1setSslCertificates/post + #/paths/~1projects~1{project}~1regions~1{region}~1targetHttpsProxies~1{targetHttpsProxy}~1setSslCertificates/post response: mediaType: application/json openAPIDocKey: '200' @@ -67307,76 +72179,6 @@ components: update: [] replace: [] delete: [] - region_target_https_proxies: - id: google.compute.region_target_https_proxies - name: region_target_https_proxies - title: Region_target_https_proxies - methods: - list: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1targetHttpsProxies/get - response: - mediaType: application/json - openAPIDocKey: '200' - insert: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1targetHttpsProxies/post - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1targetHttpsProxies~1{targetHttpsProxy}/get - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1targetHttpsProxies~1{targetHttpsProxy}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - patch: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1targetHttpsProxies~1{targetHttpsProxy}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - set_url_map: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1targetHttpsProxies~1{targetHttpsProxy}~1setUrlMap/post - response: - mediaType: application/json - openAPIDocKey: '200' - set_ssl_certificates: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1targetHttpsProxies~1{targetHttpsProxy}~1setSslCertificates/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/region_target_https_proxies/methods/get - - $ref: >- - #/components/x-stackQL-resources/region_target_https_proxies/methods/list - insert: - - $ref: >- - #/components/x-stackQL-resources/region_target_https_proxies/methods/insert - update: - - $ref: >- - #/components/x-stackQL-resources/region_target_https_proxies/methods/patch - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/region_target_https_proxies/methods/delete target_instances: id: google.compute.target_instances name: target_instances @@ -67498,10 +72300,10 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/target_pools/methods/delete' - target_pools_health: - id: google.compute.target_pools_health - name: target_pools_health - title: Target_pools_health + target_pools_health_check: + id: google.compute.target_pools_health_check + name: target_pools_health_check + title: Target_pools_health_check methods: get_health: operation: @@ -67510,19 +72312,6 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/target_pools_health/methods/get_health - insert: [] - update: [] - replace: [] - delete: [] - target_pools_health_check: - id: google.compute.target_pools_health_check - name: target_pools_health_check - title: Target_pools_health_check - methods: add_health_check: operation: $ref: >- @@ -67538,7 +72327,9 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/target_pools_health_check/methods/get_health insert: - $ref: >- #/components/x-stackQL-resources/target_pools_health_check/methods/add_health_check @@ -67659,27 +72450,29 @@ components: methods: list: operation: - $ref: '#/paths/~1projects~1{project}~1global~1targetTcpProxies/get' + $ref: >- + #/paths/~1projects~1{project}~1regions~1{region}~1targetTcpProxies/get response: mediaType: application/json openAPIDocKey: '200' insert: operation: - $ref: '#/paths/~1projects~1{project}~1global~1targetTcpProxies/post' + $ref: >- + #/paths/~1projects~1{project}~1regions~1{region}~1targetTcpProxies/post response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1targetTcpProxies~1{targetTcpProxy}/get + #/paths/~1projects~1{project}~1regions~1{region}~1targetTcpProxies~1{targetTcpProxy}/get response: mediaType: application/json openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1targetTcpProxies~1{targetTcpProxy}/delete + #/paths/~1projects~1{project}~1regions~1{region}~1targetTcpProxies~1{targetTcpProxy}/delete response: mediaType: application/json openAPIDocKey: '200' @@ -67727,53 +72520,6 @@ components: update: [] replace: [] delete: [] - region_target_tcp_proxies: - id: google.compute.region_target_tcp_proxies - name: region_target_tcp_proxies - title: Region_target_tcp_proxies - methods: - list: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1targetTcpProxies/get - response: - mediaType: application/json - openAPIDocKey: '200' - insert: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1targetTcpProxies/post - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1targetTcpProxies~1{targetTcpProxy}/get - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1targetTcpProxies~1{targetTcpProxy}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/region_target_tcp_proxies/methods/get - - $ref: >- - #/components/x-stackQL-resources/region_target_tcp_proxies/methods/list - insert: - - $ref: >- - #/components/x-stackQL-resources/region_target_tcp_proxies/methods/insert - update: [] - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/region_target_tcp_proxies/methods/delete target_vpn_gateways: id: google.compute.target_vpn_gateways name: target_vpn_gateways @@ -67842,44 +72588,48 @@ components: methods: list: operation: - $ref: '#/paths/~1projects~1{project}~1global~1urlMaps/get' + $ref: '#/paths/~1projects~1{project}~1regions~1{region}~1urlMaps/get' response: mediaType: application/json openAPIDocKey: '200' insert: operation: - $ref: '#/paths/~1projects~1{project}~1global~1urlMaps/post' + $ref: '#/paths/~1projects~1{project}~1regions~1{region}~1urlMaps/post' response: mediaType: application/json openAPIDocKey: '200' get: operation: - $ref: '#/paths/~1projects~1{project}~1global~1urlMaps~1{urlMap}/get' + $ref: >- + #/paths/~1projects~1{project}~1regions~1{region}~1urlMaps~1{urlMap}/get response: mediaType: application/json openAPIDocKey: '200' delete: operation: - $ref: '#/paths/~1projects~1{project}~1global~1urlMaps~1{urlMap}/delete' + $ref: >- + #/paths/~1projects~1{project}~1regions~1{region}~1urlMaps~1{urlMap}/delete response: mediaType: application/json openAPIDocKey: '200' update: operation: - $ref: '#/paths/~1projects~1{project}~1global~1urlMaps~1{urlMap}/put' + $ref: >- + #/paths/~1projects~1{project}~1regions~1{region}~1urlMaps~1{urlMap}/put response: mediaType: application/json openAPIDocKey: '200' patch: operation: - $ref: '#/paths/~1projects~1{project}~1global~1urlMaps~1{urlMap}/patch' + $ref: >- + #/paths/~1projects~1{project}~1regions~1{region}~1urlMaps~1{urlMap}/patch response: mediaType: application/json openAPIDocKey: '200' validate: operation: $ref: >- - #/paths/~1projects~1{project}~1global~1urlMaps~1{urlMap}~1validate/post + #/paths/~1projects~1{project}~1regions~1{region}~1urlMaps~1{urlMap}~1validate/post response: mediaType: application/json openAPIDocKey: '200' @@ -67902,90 +72652,26 @@ components: - $ref: '#/components/x-stackQL-resources/url_maps/methods/update' delete: - $ref: '#/components/x-stackQL-resources/url_maps/methods/delete' - url_maps_aggregated: - id: google.compute.url_maps_aggregated - name: url_maps_aggregated - title: Url_maps_aggregated - methods: - aggregated_list: - operation: - $ref: '#/paths/~1projects~1{project}~1aggregated~1urlMaps/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.items[*].urlMaps[*] - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/url_maps_aggregated/methods/aggregated_list - insert: [] - update: [] - replace: [] - delete: [] - region_url_maps: - id: google.compute.region_url_maps - name: region_url_maps - title: Region_url_maps - methods: - list: - operation: - $ref: '#/paths/~1projects~1{project}~1regions~1{region}~1urlMaps/get' - response: - mediaType: application/json - openAPIDocKey: '200' - insert: - operation: - $ref: '#/paths/~1projects~1{project}~1regions~1{region}~1urlMaps/post' - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1urlMaps~1{urlMap}/get - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1urlMaps~1{urlMap}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - update: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1urlMaps~1{urlMap}/put - response: - mediaType: application/json - openAPIDocKey: '200' - patch: - operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1urlMaps~1{urlMap}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - validate: + url_maps_aggregated: + id: google.compute.url_maps_aggregated + name: url_maps_aggregated + title: Url_maps_aggregated + methods: + aggregated_list: operation: - $ref: >- - #/paths/~1projects~1{project}~1regions~1{region}~1urlMaps~1{urlMap}~1validate/post + $ref: '#/paths/~1projects~1{project}~1aggregated~1urlMaps/get' response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.items[*].urlMaps[*] sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/region_url_maps/methods/get' - - $ref: '#/components/x-stackQL-resources/region_url_maps/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/region_url_maps/methods/insert' - update: - - $ref: '#/components/x-stackQL-resources/region_url_maps/methods/patch' - replace: - - $ref: '#/components/x-stackQL-resources/region_url_maps/methods/update' - delete: - - $ref: '#/components/x-stackQL-resources/region_url_maps/methods/delete' + - $ref: >- + #/components/x-stackQL-resources/url_maps_aggregated/methods/aggregated_list + insert: [] + update: [] + replace: [] + delete: [] vpn_gateways: id: google.compute.vpn_gateways name: vpn_gateways @@ -68145,7 +72831,7 @@ components: methods: list: operation: - $ref: '#/paths/~1projects~1{project}~1zones/get' + $ref: '#/paths/~1projects~1{project}~1regions~1{region}~1zones/get' response: mediaType: application/json openAPIDocKey: '200' @@ -68163,44 +72849,2176 @@ components: update: [] replace: [] delete: [] - region_zones: - id: google.compute.region_zones - name: region_zones - title: Region_zones - methods: - list: - operation: - $ref: '#/paths/~1projects~1{project}~1regions~1{region}~1zones/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/region_zones/methods/list' - insert: [] - update: [] - replace: [] - delete: [] paths: + /projects/{project}/global/operations: + parameters: &ref_1 + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/userIp' + - $ref: '#/components/parameters/_.xgafv' + get: + description: >- + Retrieves a list of Operation resources contained within the specified + project. + operationId: compute.globalOperations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/OperationList' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean + /projects/{project}/aggregated/operations: + parameters: *ref_1 + get: + description: >- + Retrieves an aggregated list of all operations. To prevent failure, + Google recommends that you set the `returnPartialSuccess` parameter to + `true`. + operationId: compute.globalOperations.aggregatedList + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/OperationAggregatedList' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: includeAllScopes + schema: + type: boolean + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean + - in: query + name: serviceProjectNumber + schema: + type: string + format: int64 + /projects/{project}/global/operations/{operation}: + parameters: *ref_1 + get: + description: Retrieves the specified Operations resource. + operationId: compute.globalOperations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: operation + required: true + schema: + type: string + delete: + description: Deletes the specified Operations resource. + operationId: compute.globalOperations.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + responses: + '204': + description: No Content + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: operation + required: true + schema: + type: string + /projects/{project}/global/operations/{operation}/wait: + parameters: *ref_1 + 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 + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: operation + required: true + schema: + type: string + /locations/global/operations: + parameters: *ref_1 + get: + description: >- + Retrieves a list of Operation resources contained within the specified + organization. + operationId: compute.globalOrganizationOperations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/OperationList' + parameters: + - in: query + name: filter + schema: + type: string + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: parentId + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean + /locations/global/operations/{operation}: + parameters: *ref_1 + get: + description: >- + Retrieves the specified Operations resource. Gets a list of operations + by making a `list()` request. + operationId: compute.globalOrganizationOperations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: operation + required: true + schema: + type: string + - in: query + name: parentId + schema: + type: string + delete: + description: Deletes the specified Operations resource. + operationId: compute.globalOrganizationOperations.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + responses: + '204': + description: No Content + parameters: + - in: path + name: operation + required: true + schema: + type: string + - in: query + name: parentId + schema: + type: string + /projects/{project}/zones/{zone}/operations: + parameters: *ref_1 + get: + description: >- + Retrieves a list of Operation resources contained within the specified + zone. + operationId: compute.zoneOperations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/OperationList' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: zone + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean + /projects/{project}/zones/{zone}/operations/{operation}: + parameters: *ref_1 + get: + description: Retrieves the specified zone-specific Operations resource. + operationId: compute.zoneOperations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: zone + required: true + schema: + type: string + - in: path + name: operation + required: true + schema: + type: string + delete: + description: Deletes the specified zone-specific Operations resource. + operationId: compute.zoneOperations.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + responses: + '204': + description: No Content + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: zone + required: true + schema: + type: string + - in: path + name: operation + required: true + schema: + type: string + /projects/{project}/zones/{zone}/operations/{operation}/wait: + parameters: *ref_1 + 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 + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: zone + required: true + schema: + type: string + - in: path + name: operation + required: true + schema: + type: string + /projects/{project}/regions/{region}/operations: + parameters: *ref_1 + get: + description: >- + Retrieves a list of Operation resources contained within the specified + region. + operationId: compute.regionOperations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/OperationList' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: region + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean + /projects/{project}/regions/{region}/operations/{operation}: + parameters: *ref_1 + get: + description: Retrieves the specified region-specific Operations resource. + operationId: compute.regionOperations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: region + required: true + schema: + type: string + - in: path + name: operation + required: true + schema: + type: string + delete: + description: Deletes the specified region-specific Operations resource. + operationId: compute.regionOperations.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + responses: + '204': + description: No Content + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: region + required: true + schema: + type: string + - in: path + name: operation + required: true + schema: + type: string + /projects/{project}/regions/{region}/operations/{operation}/wait: + parameters: *ref_1 + 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 + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: region + required: true + schema: + type: string + - in: path + name: operation + required: true + schema: + type: string /projects/{project}/zones/{zone}/acceleratorTypes: - parameters: &ref_1 - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/userIp' - - $ref: '#/components/parameters/_.xgafv' + parameters: *ref_1 + get: + description: >- + Retrieves a list of accelerator types that are available to the + specified project. + operationId: compute.acceleratorTypes.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/AcceleratorTypeList' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: zone + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean + /projects/{project}/aggregated/acceleratorTypes: + parameters: *ref_1 + get: + description: >- + Retrieves an aggregated list of accelerator types. To prevent failure, + Google recommends that you set the `returnPartialSuccess` parameter to + `true`. + operationId: compute.acceleratorTypes.aggregatedList + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/AcceleratorTypeAggregatedList' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: includeAllScopes + schema: + type: boolean + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean + - in: query + name: serviceProjectNumber + schema: + type: string + format: int64 + /projects/{project}/zones/{zone}/acceleratorTypes/{acceleratorType}: + parameters: *ref_1 + get: + description: Returns the specified accelerator type. + operationId: compute.acceleratorTypes.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/AcceleratorType' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: zone + required: true + schema: + type: string + - in: path + name: acceleratorType + required: true + schema: + type: string + /projects/{project}/global/addresses: + parameters: *ref_1 + get: + description: Retrieves a list of global addresses. + operationId: compute.globalAddresses.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/AddressList' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean + post: + description: >- + Creates an address resource in the specified project by using the data + included in the request. + operationId: compute.globalAddresses.insert + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Address' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + /projects/{project}/global/addresses/{address}: + parameters: *ref_1 + get: + description: Returns the specified address resource. + operationId: compute.globalAddresses.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Address' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: address + required: true + schema: + type: string + delete: + description: Deletes the specified address resource. + operationId: compute.globalAddresses.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: address + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + /projects/{project}/global/addresses/{address}/move: + parameters: *ref_1 + post: + description: >- + Moves the specified address resource from one project to another + project. + operationId: compute.globalAddresses.move + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GlobalAddressesMoveRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: address + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + /projects/{project}/global/addresses/{resource}/setLabels: + parameters: *ref_1 + post: + description: >- + Sets the labels on a GlobalAddress. To learn more about labels, read the + Labeling Resources documentation. + operationId: compute.globalAddresses.setLabels + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GlobalSetLabelsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: resource + required: true + schema: + type: string + /projects/{project}/regions/{region}/addresses: + parameters: *ref_1 + get: + description: Retrieves a list of addresses contained within the specified region. + operationId: compute.addresses.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/AddressList' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: region + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean + post: + description: >- + Creates an address resource in the specified project by using the data + included in the request. + operationId: compute.addresses.insert + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Address' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: region + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + /projects/{project}/aggregated/addresses: + parameters: *ref_1 + get: + description: >- + Retrieves an aggregated list of addresses. To prevent failure, Google + recommends that you set the `returnPartialSuccess` parameter to `true`. + operationId: compute.addresses.aggregatedList + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/AddressAggregatedList' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: includeAllScopes + schema: + type: boolean + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean + - in: query + name: serviceProjectNumber + schema: + type: string + format: int64 + /projects/{project}/regions/{region}/addresses/{address}: + parameters: *ref_1 + get: + description: Returns the specified address resource. + operationId: compute.addresses.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Address' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: region + required: true + schema: + type: string + - in: path + name: address + required: true + schema: + type: string + delete: + description: Deletes the specified address resource. + operationId: compute.addresses.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: region + required: true + schema: + type: string + - in: path + name: address + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + /projects/{project}/regions/{region}/addresses/{address}/move: + parameters: *ref_1 + post: + description: Moves the specified address resource. + operationId: compute.addresses.move + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RegionAddressesMoveRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: region + required: true + schema: + type: string + - in: path + name: address + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + /projects/{project}/regions/{region}/addresses/{resource}/setLabels: + parameters: *ref_1 + post: + description: >- + Sets the labels on an Address. To learn more about labels, read the + Labeling Resources documentation. + operationId: compute.addresses.setLabels + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RegionSetLabelsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: region + required: true + schema: + type: string + - in: path + name: resource + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + /projects/{project}/global/images: + parameters: *ref_1 + 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 + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ImageList' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean + post: + description: >- + Creates an image in the specified project using the data included in the + request. + operationId: compute.images.insert + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Image' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: query + name: forceCreate + schema: + type: boolean + - in: query + name: requestId + schema: + type: string + /projects/{project}/global/images/{image}: + parameters: *ref_1 + get: + description: Returns the specified image. + operationId: compute.images.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Image' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: image + required: true + schema: + type: string + delete: + description: Deletes the specified image. + operationId: compute.images.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: image + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Image' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: image + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + /projects/{project}/global/images/family/{family}: + parameters: *ref_1 + get: + description: >- + Returns the latest image that is part of an image family and is not + deprecated. For more information on image families, see Public image + families documentation. + operationId: compute.images.getFromFamily + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Image' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: family + required: true + schema: + type: string + /projects/{project}/global/images/{resource}/setLabels: + parameters: *ref_1 + post: + description: >- + Sets the labels on an image. To learn more about labels, read the + Labeling Resources documentation. + operationId: compute.images.setLabels + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GlobalSetLabelsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: resource + required: true + schema: + type: string + /projects/{project}/global/images/{image}/deprecate: + parameters: *ref_1 + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeprecationStatus' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: image + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + /projects/{project}/global/images/{resource}/getIamPolicy: + parameters: *ref_1 + get: + description: >- + Gets the access control policy for a resource. May be empty if no such + policy or resource exists. + operationId: compute.images.getIamPolicy + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: resource + required: true + schema: + type: string + - in: query + name: optionsRequestedPolicyVersion + schema: + type: integer + format: int32 + /projects/{project}/global/images/{resource}/setIamPolicy: + parameters: *ref_1 + post: + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy. + operationId: compute.images.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GlobalSetPolicyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: resource + required: true + schema: + type: string + /projects/{project}/global/images/{resource}/testIamPermissions: + parameters: *ref_1 + post: + description: Returns permissions that a caller has on the specified resource. + operationId: compute.images.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsResponse' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: resource + required: true + schema: + type: string + /projects/{project}/zones/{zone}/imageFamilyViews/{family}: + parameters: *ref_1 + 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 + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ImageFamilyView' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: zone + required: true + schema: + type: string + - in: path + name: family + required: true + schema: + type: string + /projects/{project}/global/snapshots: + parameters: *ref_1 + get: + description: >- + Retrieves the list of Snapshot resources contained within the specified + project. + operationId: compute.snapshots.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SnapshotList' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean + post: + description: >- + Creates a snapshot in the specified project using the data included in + the request. For regular snapshot creation, consider using this method + instead of disks.createSnapshot, as this method supports more features, + such as creating snapshots in a project different from the source disk + project. + operationId: compute.snapshots.insert + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Snapshot' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + /projects/{project}/global/snapshots/{snapshot}: + parameters: *ref_1 get: + description: Returns the specified Snapshot resource. + operationId: compute.snapshots.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Snapshot' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: snapshot + required: true + schema: + type: string + delete: description: >- - Retrieves a list of accelerator types that are available to the - specified project. - operationId: compute.acceleratorTypes.list + 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 + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: snapshot + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + /projects/{project}/global/snapshots/{resource}/setLabels: + parameters: *ref_1 + post: + description: >- + Sets the labels on a snapshot. To learn more about labels, read the + Labeling Resources documentation. + operationId: compute.snapshots.setLabels + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GlobalSetLabelsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: resource + required: true + schema: + type: string + /projects/{project}/global/snapshots/{resource}/getIamPolicy: + parameters: *ref_1 + get: + description: >- + Gets the access control policy for a resource. May be empty if no such + policy or resource exists. + operationId: compute.snapshots.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -68220,7 +75038,130 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AcceleratorTypeList' + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: resource + required: true + schema: + type: string + - in: query + name: optionsRequestedPolicyVersion + schema: + type: integer + format: int32 + /projects/{project}/global/snapshots/{resource}/setIamPolicy: + parameters: *ref_1 + post: + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy. + operationId: compute.snapshots.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GlobalSetPolicyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: resource + required: true + schema: + type: string + /projects/{project}/global/snapshots/{resource}/testIamPermissions: + parameters: *ref_1 + post: + description: Returns permissions that a caller has on the specified resource. + operationId: compute.snapshots.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsResponse' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: resource + required: true + schema: + type: string + /projects/{project}/zones/{zone}/disks: + parameters: *ref_1 + get: + description: >- + Retrieves a list of persistent disks contained within the specified + zone. + operationId: compute.disks.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/DiskList' parameters: - in: path name: project @@ -68253,14 +75194,62 @@ paths: name: returnPartialSuccess schema: type: boolean - /projects/{project}/aggregated/acceleratorTypes: + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Disk' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: zone + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + - in: query + name: sourceImage + schema: + type: string + /projects/{project}/aggregated/disks: parameters: *ref_1 get: description: >- - Retrieves an aggregated list of accelerator types. To prevent failure, + Retrieves an aggregated list of persistent disks. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. - operationId: compute.acceleratorTypes.aggregatedList + operationId: compute.disks.aggregatedList security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -68280,7 +75269,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AcceleratorTypeAggregatedList' + $ref: '#/components/schemas/DiskAggregatedList' parameters: - in: path name: project @@ -68317,11 +75306,11 @@ paths: schema: type: string format: int64 - /projects/{project}/zones/{zone}/acceleratorTypes/{acceleratorType}: + /projects/{project}/zones/{zone}/disks/{disk}: parameters: *ref_1 get: - description: Returns the specified accelerator type. - operationId: compute.acceleratorTypes.get + description: Returns the specified persistent disk. + operationId: compute.disks.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -68341,7 +75330,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AcceleratorType' + $ref: '#/components/schemas/Disk' parameters: - in: path name: project @@ -68354,17 +75343,169 @@ paths: schema: type: string - in: path - name: acceleratorType + name: disk required: true schema: type: string - /projects/{project}/global/operations: + 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 + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: zone + required: true + schema: + type: string + - in: path + name: disk + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + patch: + description: >- + Updates the specified disk with the data included in the request. The + update is performed only on selected fields included as part of + update-mask. Only the following fields can be modified: user_license. + operationId: compute.disks.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Disk' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: zone + required: true + schema: + type: string + - in: path + name: disk + required: true + schema: + type: string + - in: query + name: paths + schema: + type: string + - in: query + name: requestId + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /projects/{project}/zones/{zone}/disks/{resource}/setLabels: parameters: *ref_1 - get: + post: description: >- - Retrieves a list of Operation resources contained within the specified - project. - operationId: compute.globalOperations.list + Sets the labels on a disk. To learn more about labels, read the Labeling + Resources documentation. + operationId: compute.disks.setLabels + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZoneSetLabelsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: zone + required: true + schema: + type: string + - in: path + name: resource + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + /projects/{project}/zones/{zone}/disks/bulkSetLabels: + parameters: *ref_1 + post: + description: >- + Sets the labels on many disks at once. To learn more about labels, read + the Labeling Resources documentation. + operationId: compute.disks.bulkSetLabels + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BulkZoneSetLabelsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -68374,52 +75515,46 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/OperationList' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project required: true schema: type: string - - in: query - name: filter + - in: path + name: zone + required: true schema: type: string - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy + name: requestId schema: type: string - in: query - name: pageToken + name: resource schema: type: string - - in: query - name: returnPartialSuccess - schema: - type: boolean - /projects/{project}/aggregated/operations: + /projects/{project}/zones/{zone}/disks/{disk}/createSnapshot: parameters: *ref_1 - get: + post: description: >- - Retrieves an aggregated list of all operations. To prevent failure, - Google recommends that you set the `returnPartialSuccess` parameter to - `true`. - operationId: compute.globalOperations.aggregatedList + Creates a snapshot of a specified persistent disk. For regular snapshot + creation, consider using snapshots.insert instead, as that method + supports more features, such as creating snapshots in a project + different from the source disk project. + operationId: compute.disks.createSnapshot + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Snapshot' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -68429,58 +75564,49 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/OperationAggregatedList' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: includeAllScopes - schema: - type: boolean - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy + - in: path + name: zone + required: true schema: type: string - - in: query - name: pageToken + - in: path + name: disk + required: true schema: type: string - in: query - name: returnPartialSuccess + name: guestFlush schema: type: boolean - in: query - name: serviceProjectNumber + name: requestId schema: type: string - format: int64 - /projects/{project}/global/operations/{operation}: + /projects/{project}/zones/{zone}/disks/{disk}/resize: parameters: *ref_1 - get: - description: Retrieves the specified Operations resource. - operationId: compute.globalOperations.get + post: + description: >- + Resizes the specified persistent disk. You can only increase the size of + the disk. + operationId: compute.disks.resize + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DisksResizeRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -68490,10 +75616,6 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response @@ -68508,13 +75630,31 @@ paths: schema: type: string - in: path - name: operation + name: zone required: true schema: type: string - delete: - description: Deletes the specified Operations resource. - operationId: compute.globalOperations.delete + - in: path + name: disk + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + /projects/{project}/zones/{zone}/disks/{disk}/addResourcePolicies: + parameters: *ref_1 + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DisksAddResourcePoliciesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -68525,8 +75665,12 @@ paths: Oauth2c: - https://www.googleapis.com/auth/compute responses: - '204': - description: No Content + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -68534,26 +75678,29 @@ paths: schema: type: string - in: path - name: operation + name: zone required: true schema: type: string - /projects/{project}/global/operations/{operation}/wait: + - in: path + name: disk + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + /projects/{project}/zones/{zone}/disks/{disk}/removeResourcePolicies: parameters: *ref_1 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 + description: Removes resource policies from a disk. + operationId: compute.disks.removeResourcePolicies + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DisksRemoveResourcePoliciesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -68563,10 +75710,6 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response @@ -68581,17 +75724,26 @@ paths: schema: type: string - in: path - name: operation + name: zone required: true schema: type: string - /locations/global/operations: + - in: path + name: disk + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + /projects/{project}/zones/{zone}/disks/{resource}/getIamPolicy: parameters: *ref_1 get: description: >- - Retrieves a list of Operation resources contained within the specified - organization. - operationId: compute.globalOrganizationOperations.list + Gets the access control policy for a resource. May be empty if no such + policy or resource exists. + operationId: compute.disks.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -68611,40 +75763,40 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/OperationList' + $ref: '#/components/schemas/Policy' parameters: - - in: query - name: filter - schema: - type: string - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy + - in: path + name: project + required: true schema: type: string - - in: query - name: pageToken + - in: path + name: zone + required: true schema: type: string - - in: query - name: parentId + - in: path + name: resource + required: true schema: type: string - in: query - name: returnPartialSuccess + name: optionsRequestedPolicyVersion schema: - type: boolean - /locations/global/operations/{operation}: + type: integer + format: int32 + /projects/{project}/zones/{zone}/disks/{resource}/setIamPolicy: parameters: *ref_1 - get: + post: description: >- - Retrieves the specified Operations resource. Gets a list of operations - by making a `list()` request. - operationId: compute.globalOrganizationOperations.get + Sets the access control policy on the specified resource. Replaces any + existing policy. + operationId: compute.disks.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZoneSetPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -68654,30 +75806,39 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Policy' parameters: - in: path - name: operation + name: project required: true schema: type: string - - in: query - name: parentId + - in: path + name: zone + required: true schema: type: string - delete: - description: Deletes the specified Operations resource. - operationId: compute.globalOrganizationOperations.delete + - in: path + name: resource + required: true + schema: + type: string + /projects/{project}/zones/{zone}/disks/{resource}/testIamPermissions: + parameters: *ref_1 + post: + description: Returns permissions that a caller has on the specified resource. + operationId: compute.disks.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -68687,26 +75848,43 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: - '204': - description: No Content + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsResponse' parameters: - in: path - name: operation + name: project required: true schema: type: string - - in: query - name: parentId + - in: path + name: zone + required: true schema: type: string - /projects/{project}/zones/{zone}/operations: + - in: path + name: resource + required: true + schema: + type: string + /projects/{project}/zones/{zone}/disks/{disk}/startAsyncReplication: parameters: *ref_1 - get: - description: >- - Retrieves a list of Operation resources contained within the specified - zone. - operationId: compute.zoneOperations.list + post: + description: Starts asynchronous replication. Must be invoked on the primary disk. + operationId: compute.disks.startAsyncReplication + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DisksStartAsyncReplicationRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -68716,17 +75894,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/OperationList' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -68738,32 +75912,22 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy + - in: path + name: disk + required: true schema: type: string - in: query - name: pageToken + name: requestId schema: type: string - - in: query - name: returnPartialSuccess - schema: - type: boolean - /projects/{project}/zones/{zone}/operations/{operation}: + /projects/{project}/zones/{zone}/disks/{disk}/stopAsyncReplication: parameters: *ref_1 - get: - description: Retrieves the specified zone-specific Operations resource. - operationId: compute.zoneOperations.get + post: + description: >- + Stops asynchronous replication. Can be invoked either on the primary or + on the secondary disk. + operationId: compute.disks.stopAsyncReplication security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -68773,10 +75937,6 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response @@ -68796,13 +75956,26 @@ paths: schema: type: string - in: path - name: operation + name: disk required: true schema: type: string - delete: - description: Deletes the specified zone-specific Operations resource. - operationId: compute.zoneOperations.delete + - in: query + name: requestId + schema: + type: string + /projects/{project}/zones/{zone}/disks/stopGroupAsyncReplication: + parameters: *ref_1 + post: + description: >- + Stops asynchronous replication for a consistency group of disks. Can be + invoked either in the primary or secondary scope. + operationId: compute.disks.stopGroupAsyncReplication + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DisksStopGroupAsyncReplicationResource' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -68813,8 +75986,12 @@ paths: Oauth2c: - https://www.googleapis.com/auth/compute responses: - '204': - description: No Content + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -68826,26 +76003,20 @@ paths: required: true schema: type: string - - in: path - name: operation - required: true + - in: query + name: requestId schema: type: string - /projects/{project}/zones/{zone}/operations/{operation}/wait: + /projects/{project}/zones/{zone}/disks/bulkInsert: parameters: *ref_1 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 + description: Bulk create a set of disks. + operationId: compute.disks.bulkInsert + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BulkInsertDiskResource' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -68855,10 +76026,6 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response @@ -68877,18 +76044,17 @@ paths: required: true schema: type: string - - in: path - name: operation - required: true + - in: query + name: requestId schema: type: string - /projects/{project}/regions/{region}/operations: + /projects/{project}/regions/{region}/disks: parameters: *ref_1 get: description: >- - Retrieves a list of Operation resources contained within the specified + Retrieves the list of persistent disks contained within the specified region. - operationId: compute.regionOperations.list + operationId: compute.regionDisks.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -68908,7 +76074,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/OperationList' + $ref: '#/components/schemas/DiskList' parameters: - in: path name: project @@ -68941,11 +76107,16 @@ paths: name: returnPartialSuccess schema: type: boolean - /projects/{project}/regions/{region}/operations/{operation}: - parameters: *ref_1 - get: - description: Retrieves the specified region-specific Operations resource. - operationId: compute.regionOperations.get + post: + description: >- + Creates a persistent regional disk in the specified project using the + data included in the request. + operationId: compute.regionDisks.insert + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Disk' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -68955,10 +76126,6 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response @@ -68977,14 +76144,19 @@ paths: required: true schema: type: string - - in: path - name: operation - required: true + - in: query + name: requestId schema: type: string - delete: - description: Deletes the specified region-specific Operations resource. - operationId: compute.regionOperations.delete + - in: query + name: sourceImage + schema: + type: string + /projects/{project}/regions/{region}/disks/{disk}: + parameters: *ref_1 + get: + description: Returns a specified regional persistent disk. + operationId: compute.regionDisks.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -68994,9 +76166,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: - '204': - description: No Content + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Disk' parameters: - in: path name: project @@ -69009,26 +76189,17 @@ paths: schema: type: string - in: path - name: operation + name: disk required: true schema: type: string - /projects/{project}/regions/{region}/operations/{operation}/wait: - parameters: *ref_1 - post: + delete: 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 + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -69038,10 +76209,6 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response @@ -69061,15 +76228,25 @@ paths: schema: type: string - in: path - name: operation + name: disk required: true schema: type: string - /projects/{project}/global/addresses: - parameters: *ref_1 - get: - description: Retrieves a list of global addresses. - operationId: compute.globalAddresses.list + - in: query + name: requestId + schema: + type: string + patch: + description: >- + Update the specified disk with the data included in the request. Update + is performed only on selected fields included as part of update-mask. + Only the following fields can be modified: user_license. + operationId: compute.regionDisks.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Disk' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -69079,54 +76256,52 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/AddressList' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project required: true schema: type: string - - in: query - name: filter + - in: path + name: region + required: true schema: type: string - - in: query - name: maxResults + - in: path + name: disk + required: true schema: - type: integer - format: uint32 + type: string - in: query - name: orderBy + name: paths schema: type: string - in: query - name: pageToken + name: requestId schema: type: string - in: query - name: returnPartialSuccess + name: updateMask schema: - type: boolean + type: string + format: google-fieldmask + /projects/{project}/regions/{region}/disks/{resource}/setLabels: + parameters: *ref_1 post: - description: >- - Creates an address resource in the specified project by using the data - included in the request. - operationId: compute.globalAddresses.insert + description: Sets the labels on the target regional disk. + operationId: compute.regionDisks.setLabels requestBody: content: application/json: schema: - $ref: '#/components/schemas/Address' + $ref: '#/components/schemas/RegionSetLabelsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -69149,15 +76324,34 @@ paths: required: true schema: type: string + - in: path + name: region + required: true + schema: + type: string + - in: path + name: resource + required: true + schema: + type: string - in: query name: requestId schema: type: string - /projects/{project}/global/addresses/{address}: + /projects/{project}/regions/{region}/disks/{disk}/createSnapshot: parameters: *ref_1 - get: - description: Returns the specified address resource. - operationId: compute.globalAddresses.get + post: + description: >- + Creates a snapshot of a specified persistent disk. For regular snapshot + creation, consider using snapshots.insert instead, as that method + supports more features, such as creating snapshots in a project + different from the source disk project. + operationId: compute.regionDisks.createSnapshot + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Snapshot' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -69167,17 +76361,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Address' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -69185,13 +76375,29 @@ paths: schema: type: string - in: path - name: address + name: region required: true schema: type: string - delete: - description: Deletes the specified address resource. - operationId: compute.globalAddresses.delete + - in: path + name: disk + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + /projects/{project}/regions/{region}/disks/{disk}/resize: + parameters: *ref_1 + post: + description: Resizes the specified regional persistent disk. + operationId: compute.regionDisks.resize + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RegionDisksResizeRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -69215,7 +76421,12 @@ paths: schema: type: string - in: path - name: address + name: region + required: true + schema: + type: string + - in: path + name: disk required: true schema: type: string @@ -69223,18 +76434,19 @@ paths: name: requestId schema: type: string - /projects/{project}/global/addresses/{address}/move: + /projects/{project}/regions/{region}/disks/{disk}/addResourcePolicies: parameters: *ref_1 post: description: >- - Moves the specified address resource from one project to another - project. - operationId: compute.globalAddresses.move + 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 requestBody: content: application/json: schema: - $ref: '#/components/schemas/GlobalAddressesMoveRequest' + $ref: '#/components/schemas/RegionDisksAddResourcePoliciesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -69258,7 +76470,12 @@ paths: schema: type: string - in: path - name: address + name: region + required: true + schema: + type: string + - in: path + name: disk required: true schema: type: string @@ -69266,18 +76483,16 @@ paths: name: requestId schema: type: string - /projects/{project}/global/addresses/{resource}/setLabels: + /projects/{project}/regions/{region}/disks/{disk}/removeResourcePolicies: parameters: *ref_1 post: - description: >- - Sets the labels on a GlobalAddress. To learn more about labels, read the - Labeling Resources documentation. - operationId: compute.globalAddresses.setLabels + description: Removes resource policies from a regional disk. + operationId: compute.regionDisks.removeResourcePolicies requestBody: content: application/json: schema: - $ref: '#/components/schemas/GlobalSetLabelsRequest' + $ref: '#/components/schemas/RegionDisksRemoveResourcePoliciesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -69301,15 +76516,26 @@ paths: schema: type: string - in: path - name: resource + name: region required: true schema: type: string - /projects/{project}/regions/{region}/addresses: + - in: path + name: disk + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + /projects/{project}/regions/{region}/disks/{resource}/getIamPolicy: parameters: *ref_1 get: - description: Retrieves a list of addresses contained within the specified region. - operationId: compute.addresses.list + description: >- + Gets the access control policy for a resource. May be empty if no such + policy or resource exists. + operationId: compute.regionDisks.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -69329,7 +76555,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AddressList' + $ref: '#/components/schemas/Policy' parameters: - in: path name: project @@ -69341,37 +76567,28 @@ paths: required: true schema: type: string - - in: query - name: filter + - in: path + name: resource + required: true schema: type: string - in: query - name: maxResults + name: optionsRequestedPolicyVersion schema: type: integer - format: uint32 - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: returnPartialSuccess - schema: - type: boolean + format: int32 + /projects/{project}/regions/{region}/disks/{resource}/setIamPolicy: + parameters: *ref_1 post: description: >- - Creates an address resource in the specified project by using the data - included in the request. - operationId: compute.addresses.insert + Sets the access control policy on the specified resource. Replaces any + existing policy. + operationId: compute.regionDisks.setIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/Address' + $ref: '#/components/schemas/RegionSetPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -69387,7 +76604,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Policy' parameters: - in: path name: project @@ -69399,17 +76616,21 @@ paths: required: true schema: type: string - - in: query - name: requestId + - in: path + name: resource + required: true schema: type: string - /projects/{project}/aggregated/addresses: + /projects/{project}/regions/{region}/disks/{resource}/testIamPermissions: parameters: *ref_1 - get: - description: >- - Retrieves an aggregated list of addresses. To prevent failure, Google - recommends that you set the `returnPartialSuccess` parameter to `true`. - operationId: compute.addresses.aggregatedList + post: + description: Returns permissions that a caller has on the specified resource. + operationId: compute.regionDisks.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -69429,48 +76650,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AddressAggregatedList' + $ref: '#/components/schemas/TestPermissionsResponse' parameters: - in: path name: project required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: includeAllScopes - schema: - type: boolean - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken + - in: path + name: region + required: true schema: type: string - - in: query - name: returnPartialSuccess - schema: - type: boolean - - in: query - name: serviceProjectNumber + - in: path + name: resource + required: true schema: type: string - format: int64 - /projects/{project}/regions/{region}/addresses/{address}: + /projects/{project}/regions/{region}/disks/{disk}/startAsyncReplication: parameters: *ref_1 - get: - description: Returns the specified address resource. - operationId: compute.addresses.get + post: + description: Starts asynchronous replication. Must be invoked on the primary disk. + operationId: compute.regionDisks.startAsyncReplication + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RegionDisksStartAsyncReplicationRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -69480,17 +76686,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Address' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -69503,13 +76705,21 @@ paths: schema: type: string - in: path - name: address + name: disk required: true schema: type: string - delete: - description: Deletes the specified address resource. - operationId: compute.addresses.delete + - in: query + name: requestId + schema: + type: string + /projects/{project}/regions/{region}/disks/{disk}/stopAsyncReplication: + parameters: *ref_1 + post: + description: >- + Stops asynchronous replication. Can be invoked either on the primary or + on the secondary disk. + operationId: compute.regionDisks.stopAsyncReplication security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -69538,7 +76748,7 @@ paths: schema: type: string - in: path - name: address + name: disk required: true schema: type: string @@ -69546,16 +76756,18 @@ paths: name: requestId schema: type: string - /projects/{project}/regions/{region}/addresses/{address}/move: + /projects/{project}/regions/{region}/disks/stopGroupAsyncReplication: parameters: *ref_1 post: - description: Moves the specified address resource. - operationId: compute.addresses.move + description: >- + Stops asynchronous replication for a consistency group of disks. Can be + invoked either in the primary or secondary scope. + operationId: compute.regionDisks.stopGroupAsyncReplication requestBody: content: application/json: schema: - $ref: '#/components/schemas/RegionAddressesMoveRequest' + $ref: '#/components/schemas/DisksStopGroupAsyncReplicationResource' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -69583,27 +76795,20 @@ paths: required: true schema: type: string - - in: path - name: address - required: true - schema: - type: string - in: query name: requestId schema: type: string - /projects/{project}/regions/{region}/addresses/{resource}/setLabels: + /projects/{project}/regions/{region}/disks/bulkInsert: parameters: *ref_1 post: - description: >- - Sets the labels on an Address. To learn more about labels, read the - Labeling Resources documentation. - operationId: compute.addresses.setLabels + description: Bulk create a set of disks. + operationId: compute.regionDisks.bulkInsert requestBody: content: application/json: schema: - $ref: '#/components/schemas/RegionSetLabelsRequest' + $ref: '#/components/schemas/BulkInsertDiskResource' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -69631,26 +76836,15 @@ paths: required: true schema: type: string - - in: path - name: resource - required: true - schema: - type: string - in: query name: requestId schema: type: string - /projects/{project}/global/images: + /projects/{project}/global/firewalls: parameters: *ref_1 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 + description: Retrieves the list of firewall rules available to the specified project. + operationId: compute.firewalls.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -69670,7 +76864,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ImageList' + $ref: '#/components/schemas/FirewallList' parameters: - in: path name: project @@ -69700,14 +76894,14 @@ paths: type: boolean post: description: >- - Creates an image in the specified project using the data included in the - request. - operationId: compute.images.insert + Creates a firewall rule in the specified project using the data included + in the request. + operationId: compute.firewalls.insert requestBody: content: application/json: schema: - $ref: '#/components/schemas/Image' + $ref: '#/components/schemas/Firewall' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -69717,18 +76911,6 @@ paths: - 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 responses: '200': description: Successful response @@ -69742,19 +76924,15 @@ paths: required: true schema: type: string - - in: query - name: forceCreate - schema: - type: boolean - in: query name: requestId schema: type: string - /projects/{project}/global/images/{image}: + /projects/{project}/global/firewalls/{firewall}: parameters: *ref_1 get: - description: Returns the specified image. - operationId: compute.images.get + description: Returns the specified firewall. + operationId: compute.firewalls.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -69774,7 +76952,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Image' + $ref: '#/components/schemas/Firewall' parameters: - in: path name: project @@ -69782,13 +76960,13 @@ paths: schema: type: string - in: path - name: image + name: firewall required: true schema: type: string delete: - description: Deletes the specified image. - operationId: compute.images.delete + description: Deletes the specified firewall. + operationId: compute.firewalls.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -69812,7 +76990,50 @@ paths: schema: type: string - in: path - name: image + name: firewall + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Firewall' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: firewall required: true schema: type: string @@ -69822,15 +77043,15 @@ paths: type: string 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 + 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 requestBody: content: application/json: schema: - $ref: '#/components/schemas/Image' + $ref: '#/components/schemas/Firewall' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -69854,7 +77075,7 @@ paths: schema: type: string - in: path - name: image + name: firewall required: true schema: type: string @@ -69862,14 +77083,13 @@ paths: name: requestId schema: type: string - /projects/{project}/global/images/family/{family}: + /locations/global/firewallPolicies: parameters: *ref_1 get: description: >- - Returns the latest image that is part of an image family and is not - deprecated. For more information on image families, see Public image - families documentation. - operationId: compute.images.getFromFamily + Lists all the policies that have been configured for the specified + folder or organization. + operationId: compute.firewallPolicies.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -69889,30 +77109,102 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Image' + $ref: '#/components/schemas/FirewallPolicyList' parameters: - - in: path - name: project - required: true + - in: query + name: filter + schema: + type: string + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: parentId + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean + post: + description: >- + Creates a new policy in the specified project using the data included in + the request. + operationId: compute.firewallPolicies.insert + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FirewallPolicy' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: query + name: parentId + schema: + type: string + - in: query + name: requestId schema: type: string + /locations/global/firewallPolicies/{firewallPolicy}: + parameters: *ref_1 + get: + description: Returns the specified firewall policy. + operationId: compute.firewallPolicies.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/FirewallPolicy' + parameters: - in: path - name: family + name: firewallPolicy required: true schema: type: string - /projects/{project}/global/images/{resource}/setLabels: - parameters: *ref_1 - post: - description: >- - Sets the labels on an image. To learn more about labels, read the - Labeling Resources documentation. - operationId: compute.images.setLabels - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GlobalSetLabelsRequest' + delete: + description: Deletes the specified policy. + operationId: compute.firewallPolicies.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -69931,27 +77223,22 @@ paths: $ref: '#/components/schemas/Operation' parameters: - in: path - name: project + name: firewallPolicy required: true schema: type: string - - in: path - name: resource - required: true + - in: query + name: requestId schema: type: string - /projects/{project}/global/images/{image}/deprecate: - parameters: *ref_1 - 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 + patch: + description: Patches the specified policy with the data included in the request. + operationId: compute.firewallPolicies.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/DeprecationStatus' + $ref: '#/components/schemas/FirewallPolicy' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -69970,12 +77257,7 @@ paths: $ref: '#/components/schemas/Operation' parameters: - in: path - name: project - required: true - schema: - type: string - - in: path - name: image + name: firewallPolicy required: true schema: type: string @@ -69983,13 +77265,11 @@ paths: name: requestId schema: type: string - /projects/{project}/global/images/{resource}/getIamPolicy: + /locations/global/firewallPolicies/{firewallPolicy}/getRule: parameters: *ref_1 get: - description: >- - Gets the access control policy for a resource. May be empty if no such - policy or resource exists. - operationId: compute.images.getIamPolicy + description: Gets a rule of the specified priority. + operationId: compute.firewallPolicies.getRule security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -70009,35 +77289,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/FirewallPolicyRule' parameters: - in: path - name: project - required: true - schema: - type: string - - in: path - name: resource + name: firewallPolicy required: true schema: type: string - in: query - name: optionsRequestedPolicyVersion + name: priority schema: type: integer format: int32 - /projects/{project}/global/images/{resource}/setIamPolicy: + /locations/global/firewallPolicies/{firewallPolicy}/addRule: parameters: *ref_1 post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. - operationId: compute.images.setIamPolicy + description: Inserts a rule into a firewall policy. + operationId: compute.firewallPolicies.addRule requestBody: content: application/json: schema: - $ref: '#/components/schemas/GlobalSetPolicyRequest' + $ref: '#/components/schemas/FirewallPolicyRule' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -70053,28 +77326,22 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Operation' parameters: - in: path - name: project + name: firewallPolicy required: true schema: type: string - - in: path - name: resource - required: true + - in: query + name: requestId schema: type: string - /projects/{project}/global/images/{resource}/testIamPermissions: + /locations/global/firewallPolicies/{firewallPolicy}/removeRule: parameters: *ref_1 post: - description: Returns permissions that a caller has on the specified resource. - operationId: compute.images.testIamPermissions - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TestPermissionsRequest' + description: Deletes a rule of the specified priority. + operationId: compute.firewallPolicies.removeRule security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -70084,35 +77351,38 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/TestPermissionsResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path - name: project + name: firewallPolicy required: true schema: type: string - - in: path - name: resource - required: true + - in: query + name: priority + schema: + type: integer + format: int32 + - in: query + name: requestId schema: type: string - /projects/{project}/zones/{zone}/imageFamilyViews/{family}: + /locations/global/firewallPolicies/{firewallPolicy}/patchRule: parameters: *ref_1 - 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 + post: + description: Patches a rule of the specified priority. + operationId: compute.firewallPolicies.patchRule + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FirewallPolicyRule' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -70122,40 +77392,38 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/ImageFamilyView' + $ref: '#/components/schemas/Operation' parameters: - in: path - name: project + name: firewallPolicy required: true schema: type: string - - in: path - name: zone - required: true + - in: query + name: priority schema: - type: string - - in: path - name: family - required: true + type: integer + format: int32 + - in: query + name: requestId schema: type: string - /projects/{project}/global/snapshots: + /locations/global/firewallPolicies/{firewallPolicy}/addAssociation: parameters: *ref_1 - get: - description: >- - Retrieves the list of Snapshot resources contained within the specified - project. - operationId: compute.snapshots.list + post: + description: Inserts an association for the specified firewall policy. + operationId: compute.firewallPolicies.addAssociation + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FirewallPolicyAssociation' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -70165,57 +77433,32 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/SnapshotList' + $ref: '#/components/schemas/Operation' parameters: - in: path - name: project + name: firewallPolicy required: true schema: type: string - in: query - name: filter - schema: - type: string - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy + name: replaceExistingAssociation schema: - type: string + type: boolean - in: query - name: pageToken + name: requestId schema: type: string - - in: query - name: returnPartialSuccess - schema: - type: boolean + /locations/global/firewallPolicies/{firewallPolicy}/removeAssociation: + parameters: *ref_1 post: - description: >- - Creates a snapshot in the specified project using the data included in - the request. For regular snapshot creation, consider using this method - instead of disks.createSnapshot, as this method supports more features, - such as creating snapshots in a project different from the source disk - project. - operationId: compute.snapshots.insert - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Snapshot' + description: Removes an association for the specified firewall policy. + operationId: compute.firewallPolicies.removeAssociation security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -70234,19 +77477,23 @@ paths: $ref: '#/components/schemas/Operation' parameters: - in: path - name: project + name: firewallPolicy required: true schema: type: string + - in: query + name: name + schema: + type: string - in: query name: requestId schema: type: string - /projects/{project}/global/snapshots/{snapshot}: + /locations/global/firewallPolicies/listAssociations: parameters: *ref_1 get: - description: Returns the specified Snapshot resource. - operationId: compute.snapshots.get + description: Lists associations of a specified target, i.e., organization or folder. + operationId: compute.firewallPolicies.listAssociations security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -70266,26 +77513,52 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Snapshot' + $ref: '#/components/schemas/FirewallPoliciesListAssociationsResponse' parameters: - - in: path - name: project - required: true + - in: query + name: targetResource schema: type: string + /locations/global/firewallPolicies/{firewallPolicy}/getAssociation: + parameters: *ref_1 + get: + description: Gets an association with the specified name. + operationId: compute.firewallPolicies.getAssociation + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/FirewallPolicyAssociation' + parameters: - in: path - name: snapshot + name: firewallPolicy required: true schema: type: string - 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 + - in: query + name: name + schema: + type: string + /locations/global/firewallPolicies/{firewallPolicy}/cloneRules: + parameters: *ref_1 + post: + description: Copies rules to the specified firewall policy. + operationId: compute.firewallPolicies.cloneRules security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -70304,31 +77577,23 @@ paths: $ref: '#/components/schemas/Operation' parameters: - in: path - name: project + name: firewallPolicy required: true schema: type: string - - in: path - name: snapshot - required: true + - in: query + name: requestId schema: type: string - in: query - name: requestId + name: sourceFirewallPolicy schema: type: string - /projects/{project}/global/snapshots/{resource}/setLabels: + /locations/global/firewallPolicies/{firewallPolicy}/move: parameters: *ref_1 post: - description: >- - Sets the labels on a snapshot. To learn more about labels, read the - Labeling Resources documentation. - operationId: compute.snapshots.setLabels - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GlobalSetLabelsRequest' + description: Moves the specified firewall policy. + operationId: compute.firewallPolicies.move security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -70347,22 +77612,25 @@ paths: $ref: '#/components/schemas/Operation' parameters: - in: path - name: project + name: firewallPolicy required: true schema: type: string - - in: path - name: resource - required: true + - in: query + name: parentId schema: type: string - /projects/{project}/global/snapshots/{resource}/getIamPolicy: + - in: query + name: requestId + schema: + type: string + /locations/global/firewallPolicies/{resource}/getIamPolicy: parameters: *ref_1 get: description: >- Gets the access control policy for a resource. May be empty if no such policy or resource exists. - operationId: compute.snapshots.getIamPolicy + operationId: compute.firewallPolicies.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -70384,11 +77652,6 @@ paths: schema: $ref: '#/components/schemas/Policy' parameters: - - in: path - name: project - required: true - schema: - type: string - in: path name: resource required: true @@ -70399,18 +77662,18 @@ paths: schema: type: integer format: int32 - /projects/{project}/global/snapshots/{resource}/setIamPolicy: + /locations/global/firewallPolicies/{resource}/setIamPolicy: parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any existing policy. - operationId: compute.snapshots.setIamPolicy + operationId: compute.firewallPolicies.setIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/GlobalSetPolicyRequest' + $ref: '#/components/schemas/GlobalOrganizationSetPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -70428,21 +77691,16 @@ paths: schema: $ref: '#/components/schemas/Policy' parameters: - - in: path - name: project - required: true - schema: - type: string - in: path name: resource required: true schema: type: string - /projects/{project}/global/snapshots/{resource}/testIamPermissions: + /locations/global/firewallPolicies/{resource}/testIamPermissions: parameters: *ref_1 post: description: Returns permissions that a caller has on the specified resource. - operationId: compute.snapshots.testIamPermissions + operationId: compute.firewallPolicies.testIamPermissions requestBody: content: application/json: @@ -70469,23 +77727,18 @@ paths: schema: $ref: '#/components/schemas/TestPermissionsResponse' parameters: - - in: path - name: project - required: true - schema: - type: string - in: path name: resource required: true schema: type: string - /projects/{project}/zones/{zone}/disks: + /projects/{project}/global/firewallPolicies: parameters: *ref_1 get: description: >- - Retrieves a list of persistent disks contained within the specified - zone. - operationId: compute.disks.list + Lists all the policies that have been configured for the specified + project. + operationId: compute.networkFirewallPolicies.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -70505,18 +77758,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DiskList' + $ref: '#/components/schemas/FirewallPolicyList' parameters: - in: path name: project required: true schema: type: string - - in: path - name: zone - required: true - schema: - type: string - in: query name: filter schema: @@ -70540,17 +77788,14 @@ paths: type: boolean 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 + Creates a new policy in the specified project using the data included in + the request. + operationId: compute.networkFirewallPolicies.insert requestBody: content: application/json: schema: - $ref: '#/components/schemas/Disk' + $ref: '#/components/schemas/FirewallPolicy' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -70573,27 +77818,15 @@ paths: required: true schema: type: string - - in: path - name: zone - required: true - schema: - type: string - in: query name: requestId schema: type: string - - in: query - name: sourceImage - schema: - type: string - /projects/{project}/aggregated/disks: + /projects/{project}/global/firewallPolicies/{firewallPolicy}: parameters: *ref_1 get: - description: >- - Retrieves an aggregated list of persistent disks. To prevent failure, - Google recommends that you set the `returnPartialSuccess` parameter to - `true`. - operationId: compute.disks.aggregatedList + description: Returns the specified network firewall policy. + operationId: compute.networkFirewallPolicies.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -70613,48 +77846,96 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DiskAggregatedList' + $ref: '#/components/schemas/FirewallPolicy' parameters: - in: path name: project required: true schema: type: string - - in: query - name: filter + - in: path + name: firewallPolicy + required: true schema: type: string - - in: query - name: includeAllScopes + delete: + description: Deletes the specified policy. + operationId: compute.networkFirewallPolicies.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: project + required: true schema: - type: boolean - - in: query - name: maxResults + type: string + - in: path + name: firewallPolicy + required: true schema: - type: integer - format: uint32 + type: string - in: query - name: orderBy + name: requestId schema: type: string - - in: query - name: pageToken + patch: + description: Patches the specified policy with the data included in the request. + operationId: compute.networkFirewallPolicies.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FirewallPolicy' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: project + required: true schema: type: string - - in: query - name: returnPartialSuccess + - in: path + name: firewallPolicy + required: true schema: - type: boolean + type: string - in: query - name: serviceProjectNumber + name: requestId schema: type: string - format: int64 - /projects/{project}/zones/{zone}/disks/{disk}: + /projects/{project}/global/firewallPolicies/{firewallPolicy}/getRule: parameters: *ref_1 get: - description: Returns the specified persistent disk. - operationId: compute.disks.get + description: Gets a rule of the specified priority. + operationId: compute.networkFirewallPolicies.getRule security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -70674,7 +77955,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Disk' + $ref: '#/components/schemas/FirewallPolicyRule' parameters: - in: path name: project @@ -70682,22 +77963,20 @@ paths: schema: type: string - in: path - name: zone + name: firewallPolicy required: true schema: type: string - - in: path - name: disk - required: true + - in: query + name: priority schema: - type: string - 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 + type: integer + format: int32 + /projects/{project}/global/firewallPolicies/{firewallPolicy}/getPacketMirroringRule: + parameters: *ref_1 + get: + description: Gets a packet mirroring rule of the specified priority. + operationId: compute.networkFirewallPolicies.getPacketMirroringRule security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -70707,13 +77986,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/FirewallPolicyRule' parameters: - in: path name: project @@ -70721,30 +78004,25 @@ paths: schema: type: string - in: path - name: zone - required: true - schema: - type: string - - in: path - name: disk + name: firewallPolicy required: true schema: - type: string - - in: query - name: requestId - schema: - type: string - patch: - description: >- - Updates the specified disk with the data included in the request. The - update is performed only on selected fields included as part of - update-mask. Only the following fields can be modified: user_license. - operationId: compute.disks.update + type: string + - in: query + name: priority + schema: + type: integer + format: int32 + /projects/{project}/global/firewallPolicies/{firewallPolicy}/addRule: + parameters: *ref_1 + post: + description: Inserts a rule into a firewall policy. + operationId: compute.networkFirewallPolicies.addRule requestBody: content: application/json: schema: - $ref: '#/components/schemas/Disk' + $ref: '#/components/schemas/FirewallPolicyRule' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -70768,40 +78046,34 @@ paths: schema: type: string - in: path - name: zone - required: true - schema: - type: string - - in: path - name: disk + name: firewallPolicy required: true schema: type: string - in: query - name: paths + name: maxPriority schema: - type: string + type: integer + format: int32 - in: query - name: requestId + name: minPriority schema: - type: string + type: integer + format: int32 - in: query - name: updateMask + name: requestId schema: type: string - format: google-fieldmask - /projects/{project}/zones/{zone}/disks/{resource}/setLabels: + /projects/{project}/global/firewallPolicies/{firewallPolicy}/addPacketMirroringRule: parameters: *ref_1 post: - description: >- - Sets the labels on a disk. To learn more about labels, read the Labeling - Resources documentation. - operationId: compute.disks.setLabels + description: Inserts a packet mirroring rule into a firewall policy. + operationId: compute.networkFirewallPolicies.addPacketMirroringRule requestBody: content: application/json: schema: - $ref: '#/components/schemas/ZoneSetLabelsRequest' + $ref: '#/components/schemas/FirewallPolicyRule' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -70825,33 +78097,29 @@ paths: schema: type: string - in: path - name: zone + name: firewallPolicy required: true schema: type: string - - in: path - name: resource - required: true + - in: query + name: maxPriority schema: - type: string + type: integer + format: int32 + - in: query + name: minPriority + schema: + type: integer + format: int32 - in: query name: requestId schema: type: string - /projects/{project}/zones/{zone}/disks/{disk}/createSnapshot: + /projects/{project}/global/firewallPolicies/{firewallPolicy}/removeRule: parameters: *ref_1 post: - description: >- - Creates a snapshot of a specified persistent disk. For regular snapshot - creation, consider using snapshots.insert instead, as that method - supports more features, such as creating snapshots in a project - different from the source disk project. - operationId: compute.disks.createSnapshot - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Snapshot' + description: Deletes a rule of the specified priority. + operationId: compute.networkFirewallPolicies.removeRule security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -70875,35 +78143,24 @@ paths: schema: type: string - in: path - name: zone - required: true - schema: - type: string - - in: path - name: disk + name: firewallPolicy required: true schema: type: string - in: query - name: guestFlush + name: priority schema: - type: boolean + type: integer + format: int32 - in: query name: requestId schema: type: string - /projects/{project}/zones/{zone}/disks/{disk}/resize: + /projects/{project}/global/firewallPolicies/{firewallPolicy}/removePacketMirroringRule: parameters: *ref_1 post: - description: >- - Resizes the specified persistent disk. You can only increase the size of - the disk. - operationId: compute.disks.resize - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DisksResizeRequest' + description: Deletes a packet mirroring rule of the specified priority. + operationId: compute.networkFirewallPolicies.removePacketMirroringRule security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -70927,31 +78184,29 @@ paths: schema: type: string - in: path - name: zone + name: firewallPolicy required: true schema: type: string - - in: path - name: disk - required: true + - in: query + name: priority schema: - type: string + type: integer + format: int32 - in: query name: requestId schema: type: string - /projects/{project}/zones/{zone}/disks/{disk}/addResourcePolicies: + /projects/{project}/global/firewallPolicies/{firewallPolicy}/patchRule: parameters: *ref_1 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 + description: Patches a rule of the specified priority. + operationId: compute.networkFirewallPolicies.patchRule requestBody: content: application/json: schema: - $ref: '#/components/schemas/DisksAddResourcePoliciesRequest' + $ref: '#/components/schemas/FirewallPolicyRule' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -70975,29 +78230,29 @@ paths: schema: type: string - in: path - name: zone + name: firewallPolicy required: true schema: type: string - - in: path - name: disk - required: true + - in: query + name: priority schema: - type: string + type: integer + format: int32 - in: query name: requestId schema: type: string - /projects/{project}/zones/{zone}/disks/{disk}/removeResourcePolicies: + /projects/{project}/global/firewallPolicies/{firewallPolicy}/patchPacketMirroringRule: parameters: *ref_1 post: - description: Removes resource policies from a disk. - operationId: compute.disks.removeResourcePolicies + description: Patches a packet mirroring rule of the specified priority. + operationId: compute.networkFirewallPolicies.patchPacketMirroringRule requestBody: content: application/json: schema: - $ref: '#/components/schemas/DisksRemoveResourcePoliciesRequest' + $ref: '#/components/schemas/FirewallPolicyRule' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -71021,26 +78276,26 @@ paths: schema: type: string - in: path - name: zone + name: firewallPolicy required: true schema: type: string - - in: path - name: disk - required: true + - in: query + name: priority schema: - type: string + type: integer + format: int32 - in: query name: requestId schema: type: string - /projects/{project}/zones/{zone}/disks/{resource}/getIamPolicy: + /projects/{project}/global/firewallPolicies/{resource}/getIamPolicy: parameters: *ref_1 get: description: >- Gets the access control policy for a resource. May be empty if no such policy or resource exists. - operationId: compute.disks.getIamPolicy + operationId: compute.networkFirewallPolicies.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -71067,11 +78322,6 @@ paths: required: true schema: type: string - - in: path - name: zone - required: true - schema: - type: string - in: path name: resource required: true @@ -71082,18 +78332,18 @@ paths: schema: type: integer format: int32 - /projects/{project}/zones/{zone}/disks/{resource}/setIamPolicy: + /projects/{project}/global/firewallPolicies/{resource}/setIamPolicy: parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any existing policy. - operationId: compute.disks.setIamPolicy + operationId: compute.networkFirewallPolicies.setIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/ZoneSetPolicyRequest' + $ref: '#/components/schemas/GlobalSetPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -71116,21 +78366,16 @@ paths: required: true schema: type: string - - in: path - name: zone - required: true - schema: - type: string - in: path name: resource required: true schema: type: string - /projects/{project}/zones/{zone}/disks/{resource}/testIamPermissions: + /projects/{project}/global/firewallPolicies/{resource}/testIamPermissions: parameters: *ref_1 post: description: Returns permissions that a caller has on the specified resource. - operationId: compute.disks.testIamPermissions + operationId: compute.networkFirewallPolicies.testIamPermissions requestBody: content: application/json: @@ -71162,26 +78407,21 @@ paths: required: true schema: type: string - - in: path - name: zone - required: true - schema: - type: string - in: path name: resource required: true schema: type: string - /projects/{project}/zones/{zone}/disks/{disk}/startAsyncReplication: + /projects/{project}/global/firewallPolicies/{firewallPolicy}/addAssociation: parameters: *ref_1 post: - description: Starts asynchronous replication. Must be invoked on the primary disk. - operationId: compute.disks.startAsyncReplication + description: Inserts an association for the specified firewall policy. + operationId: compute.networkFirewallPolicies.addAssociation requestBody: content: application/json: schema: - $ref: '#/components/schemas/DisksStartAsyncReplicationRequest' + $ref: '#/components/schemas/FirewallPolicyAssociation' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -71205,26 +78445,23 @@ paths: schema: type: string - in: path - name: zone + name: firewallPolicy required: true schema: type: string - - in: path - name: disk - required: true + - in: query + name: replaceExistingAssociation schema: - type: string + type: boolean - in: query name: requestId schema: type: string - /projects/{project}/zones/{zone}/disks/{disk}/stopAsyncReplication: + /projects/{project}/global/firewallPolicies/{firewallPolicy}/removeAssociation: parameters: *ref_1 post: - description: >- - Stops asynchronous replication. Can be invoked either on the primary or - on the secondary disk. - operationId: compute.disks.stopAsyncReplication + description: Removes an association for the specified firewall policy. + operationId: compute.networkFirewallPolicies.removeAssociation security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -71248,31 +78485,23 @@ paths: schema: type: string - in: path - name: zone + name: firewallPolicy required: true schema: type: string - - in: path - name: disk - required: true + - in: query + name: name schema: type: string - in: query name: requestId schema: type: string - /projects/{project}/zones/{zone}/disks/stopGroupAsyncReplication: + /projects/{project}/global/firewallPolicies/{firewallPolicy}/getAssociation: parameters: *ref_1 - post: - description: >- - Stops asynchronous replication for a consistency group of disks. Can be - invoked either in the primary or secondary scope. - operationId: compute.disks.stopGroupAsyncReplication - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DisksStopGroupAsyncReplicationResource' + get: + description: Gets an association with the specified name. + operationId: compute.networkFirewallPolicies.getAssociation security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -71282,13 +78511,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/FirewallPolicyAssociation' parameters: - in: path name: project @@ -71296,24 +78529,19 @@ paths: schema: type: string - in: path - name: zone + name: firewallPolicy required: true schema: type: string - in: query - name: requestId + name: name schema: type: string - /projects/{project}/zones/{zone}/disks/bulkInsert: + /projects/{project}/global/firewallPolicies/{firewallPolicy}/cloneRules: parameters: *ref_1 post: - description: Bulk create a set of disks. - operationId: compute.disks.bulkInsert - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/BulkInsertDiskResource' + description: Copies rules to the specified firewall policy. + operationId: compute.networkFirewallPolicies.cloneRules security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -71337,7 +78565,7 @@ paths: schema: type: string - in: path - name: zone + name: firewallPolicy required: true schema: type: string @@ -71345,13 +78573,19 @@ paths: name: requestId schema: type: string - /projects/{project}/regions/{region}/disks: + - in: query + name: sourceFirewallPolicy + schema: + type: string + /projects/{project}/aggregated/firewallPolicies: parameters: *ref_1 get: description: >- - Retrieves the list of persistent disks contained within the specified - region. - operationId: compute.regionDisks.list + Retrieves an aggregated list of network firewall policies, listing + network firewall policies from all applicable scopes (global and + regional) and grouping the results per scope. To prevent failure, Google + recommends that you set the `returnPartialSuccess` parameter to `true`. + operationId: compute.networkFirewallPolicies.aggregatedList security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -71371,22 +78605,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DiskList' + $ref: '#/components/schemas/NetworkFirewallPolicyAggregatedList' parameters: - in: path name: project required: true schema: type: string - - in: path - name: region - required: true - schema: - type: string - in: query name: filter schema: type: string + - in: query + name: includeAllScopes + schema: + type: boolean - in: query name: maxResults schema: @@ -71404,56 +78637,18 @@ paths: name: returnPartialSuccess schema: type: boolean - post: - description: >- - Creates a persistent regional disk in the specified project using the - data included in the request. - operationId: compute.regionDisks.insert - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Disk' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/compute - Oauth2c: - - https://www.googleapis.com/auth/compute - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: project - required: true - schema: - type: string - - in: path - name: region - required: true - schema: - type: string - - in: query - name: requestId - schema: - type: string - in: query - name: sourceImage + name: serviceProjectNumber schema: type: string - /projects/{project}/regions/{region}/disks/{disk}: + format: int64 + /projects/{project}/regions/{region}/firewallPolicies: parameters: *ref_1 get: - description: Returns a specified regional persistent disk. - operationId: compute.regionDisks.get + description: >- + Lists all the network firewall policies that have been configured for + the specified project in the given region. + operationId: compute.regionNetworkFirewallPolicies.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -71473,46 +78668,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Disk' - parameters: - - in: path - name: project - required: true - schema: - type: string - - in: path - name: region - required: true - schema: - type: string - - in: path - name: disk - required: true - schema: - type: string - 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 - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/compute - Oauth2c: - - https://www.googleapis.com/auth/compute - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/FirewallPolicyList' parameters: - in: path name: project @@ -71524,131 +78680,37 @@ paths: required: true schema: type: string - - in: path - name: disk - required: true - schema: - type: string - in: query - name: requestId - schema: - type: string - patch: - description: >- - Update the specified disk with the data included in the request. Update - is performed only on selected fields included as part of update-mask. - Only the following fields can be modified: user_license. - operationId: compute.regionDisks.update - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Disk' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/compute - Oauth2c: - - https://www.googleapis.com/auth/compute - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: project - required: true - schema: - type: string - - in: path - name: region - required: true - schema: - type: string - - in: path - name: disk - required: true + name: filter schema: type: string - in: query - name: paths + name: maxResults schema: - type: string + type: integer + format: uint32 - in: query - name: requestId + name: orderBy schema: type: string - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /projects/{project}/regions/{region}/disks/{resource}/setLabels: - parameters: *ref_1 - post: - description: Sets the labels on the target regional disk. - operationId: compute.regionDisks.setLabels - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RegionSetLabelsRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/compute - Oauth2c: - - https://www.googleapis.com/auth/compute - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: project - required: true - schema: - type: string - - in: path - name: region - required: true - schema: - type: string - - in: path - name: resource - required: true + name: pageToken schema: type: string - in: query - name: requestId + name: returnPartialSuccess schema: - type: string - /projects/{project}/regions/{region}/disks/{disk}/createSnapshot: - parameters: *ref_1 + type: boolean post: description: >- - Creates a snapshot of a specified persistent disk. For regular snapshot - creation, consider using snapshots.insert instead, as that method - supports more features, such as creating snapshots in a project - different from the source disk project. - operationId: compute.regionDisks.createSnapshot + Creates a new network firewall policy in the specified project and + region. + operationId: compute.regionNetworkFirewallPolicies.insert requestBody: content: application/json: schema: - $ref: '#/components/schemas/Snapshot' + $ref: '#/components/schemas/FirewallPolicy' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -71676,25 +78738,15 @@ paths: required: true schema: type: string - - in: path - name: disk - required: true - schema: - type: string - in: query name: requestId schema: type: string - /projects/{project}/regions/{region}/disks/{disk}/resize: + /projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}: parameters: *ref_1 - post: - description: Resizes the specified regional persistent disk. - operationId: compute.regionDisks.resize - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RegionDisksResizeRequest' + get: + description: Returns the specified network firewall policy. + operationId: compute.regionNetworkFirewallPolicies.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -71704,13 +78756,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/FirewallPolicy' parameters: - in: path name: project @@ -71723,27 +78779,13 @@ paths: schema: type: string - in: path - name: disk + name: firewallPolicy required: true schema: type: string - - in: query - name: requestId - schema: - type: string - /projects/{project}/regions/{region}/disks/{disk}/addResourcePolicies: - parameters: *ref_1 - 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 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RegionDisksAddResourcePoliciesRequest' + delete: + description: Deletes the specified network firewall policy. + operationId: compute.regionNetworkFirewallPolicies.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -71772,7 +78814,7 @@ paths: schema: type: string - in: path - name: disk + name: firewallPolicy required: true schema: type: string @@ -71780,16 +78822,14 @@ paths: name: requestId schema: type: string - /projects/{project}/regions/{region}/disks/{disk}/removeResourcePolicies: - parameters: *ref_1 - post: - description: Removes resource policies from a regional disk. - operationId: compute.regionDisks.removeResourcePolicies + patch: + description: Patches the specified network firewall policy. + operationId: compute.regionNetworkFirewallPolicies.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/RegionDisksRemoveResourcePoliciesRequest' + $ref: '#/components/schemas/FirewallPolicy' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -71818,7 +78858,7 @@ paths: schema: type: string - in: path - name: disk + name: firewallPolicy required: true schema: type: string @@ -71826,13 +78866,11 @@ paths: name: requestId schema: type: string - /projects/{project}/regions/{region}/disks/{resource}/getIamPolicy: + /projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getRule: parameters: *ref_1 get: - description: >- - Gets the access control policy for a resource. May be empty if no such - policy or resource exists. - operationId: compute.regionDisks.getIamPolicy + description: Gets a rule of the specified priority. + operationId: compute.regionNetworkFirewallPolicies.getRule security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -71852,7 +78890,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/FirewallPolicyRule' parameters: - in: path name: project @@ -71865,27 +78903,25 @@ paths: schema: type: string - in: path - name: resource + name: firewallPolicy required: true schema: type: string - in: query - name: optionsRequestedPolicyVersion + name: priority schema: type: integer format: int32 - /projects/{project}/regions/{region}/disks/{resource}/setIamPolicy: + /projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addRule: parameters: *ref_1 post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. - operationId: compute.regionDisks.setIamPolicy + description: Inserts a rule into a network firewall policy. + operationId: compute.regionNetworkFirewallPolicies.addRule requestBody: content: application/json: schema: - $ref: '#/components/schemas/RegionSetPolicyRequest' + $ref: '#/components/schemas/FirewallPolicyRule' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -71901,7 +78937,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -71914,20 +78950,29 @@ paths: schema: type: string - in: path - name: resource + name: firewallPolicy required: true schema: type: string - /projects/{project}/regions/{region}/disks/{resource}/testIamPermissions: + - in: query + name: maxPriority + schema: + type: integer + format: int32 + - in: query + name: minPriority + schema: + type: integer + format: int32 + - in: query + name: requestId + schema: + type: string + /projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeRule: parameters: *ref_1 post: - description: Returns permissions that a caller has on the specified resource. - operationId: compute.regionDisks.testIamPermissions - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TestPermissionsRequest' + description: Deletes a rule of the specified priority. + operationId: compute.regionNetworkFirewallPolicies.removeRule security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -71937,17 +78982,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/TestPermissionsResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -71960,20 +79001,29 @@ paths: schema: type: string - in: path - name: resource + name: firewallPolicy required: true schema: type: string - /projects/{project}/regions/{region}/disks/{disk}/startAsyncReplication: + - in: query + name: priority + schema: + type: integer + format: int32 + - in: query + name: requestId + schema: + type: string + /projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/patchRule: parameters: *ref_1 post: - description: Starts asynchronous replication. Must be invoked on the primary disk. - operationId: compute.regionDisks.startAsyncReplication + description: Patches a rule of the specified priority. + operationId: compute.regionNetworkFirewallPolicies.patchRule requestBody: content: application/json: schema: - $ref: '#/components/schemas/RegionDisksStartAsyncReplicationRequest' + $ref: '#/components/schemas/FirewallPolicyRule' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -72002,21 +79052,24 @@ paths: schema: type: string - in: path - name: disk + name: firewallPolicy required: true schema: type: string + - in: query + name: priority + schema: + type: integer + format: int32 - in: query name: requestId schema: type: string - /projects/{project}/regions/{region}/disks/{disk}/stopAsyncReplication: + /projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/cloneRules: parameters: *ref_1 post: - description: >- - Stops asynchronous replication. Can be invoked either on the primary or - on the secondary disk. - operationId: compute.regionDisks.stopAsyncReplication + description: Copies rules to the specified network firewall policy. + operationId: compute.regionNetworkFirewallPolicies.cloneRules security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -72045,7 +79098,7 @@ paths: schema: type: string - in: path - name: disk + name: firewallPolicy required: true schema: type: string @@ -72053,18 +79106,15 @@ paths: name: requestId schema: type: string - /projects/{project}/regions/{region}/disks/stopGroupAsyncReplication: + - in: query + name: sourceFirewallPolicy + schema: + type: string + /projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getAssociation: parameters: *ref_1 - post: - description: >- - Stops asynchronous replication for a consistency group of disks. Can be - invoked either in the primary or secondary scope. - operationId: compute.regionDisks.stopGroupAsyncReplication - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DisksStopGroupAsyncReplicationResource' + get: + description: Gets an association with the specified name. + operationId: compute.regionNetworkFirewallPolicies.getAssociation security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -72074,13 +79124,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/FirewallPolicyAssociation' parameters: - in: path name: project @@ -72092,20 +79146,25 @@ paths: required: true schema: type: string + - in: path + name: firewallPolicy + required: true + schema: + type: string - in: query - name: requestId + name: name schema: type: string - /projects/{project}/regions/{region}/disks/bulkInsert: + /projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addAssociation: parameters: *ref_1 post: - description: Bulk create a set of disks. - operationId: compute.regionDisks.bulkInsert + description: Inserts an association for the specified network firewall policy. + operationId: compute.regionNetworkFirewallPolicies.addAssociation requestBody: content: application/json: schema: - $ref: '#/components/schemas/BulkInsertDiskResource' + $ref: '#/components/schemas/FirewallPolicyAssociation' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -72133,15 +79192,24 @@ paths: required: true schema: type: string + - in: path + name: firewallPolicy + required: true + schema: + type: string + - in: query + name: replaceExistingAssociation + schema: + type: boolean - in: query name: requestId schema: type: string - /projects/{project}/global/firewalls: + /projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeAssociation: parameters: *ref_1 - get: - description: Retrieves the list of firewall rules available to the specified project. - operationId: compute.firewalls.list + post: + description: Removes an association for the specified network firewall policy. + operationId: compute.regionNetworkFirewallPolicies.removeAssociation security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -72151,54 +79219,42 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/FirewallList' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project required: true schema: type: string - - in: query - name: filter + - in: path + name: region + required: true schema: type: string - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy + - in: path + name: firewallPolicy + required: true schema: type: string - in: query - name: pageToken + name: name schema: type: string - in: query - name: returnPartialSuccess + name: requestId schema: - type: boolean - post: - description: >- - Creates a firewall rule in the specified project using the data included - in the request. - operationId: compute.firewalls.insert - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Firewall' + type: string + /projects/{project}/regions/{region}/firewallPolicies/getEffectiveFirewalls: + parameters: *ref_1 + get: + description: Returns the effective firewalls on a given network. + operationId: compute.regionNetworkFirewallPolicies.getEffectiveFirewalls security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -72208,28 +79264,41 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: >- + #/components/schemas/RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse parameters: - in: path name: project required: true schema: type: string + - in: path + name: region + required: true + schema: + type: string - in: query - name: requestId + name: network + required: true schema: type: string - /projects/{project}/global/firewalls/{firewall}: + /projects/{project}/regions/{region}/firewallPolicies/{resource}/getIamPolicy: parameters: *ref_1 get: - description: Returns the specified firewall. - operationId: compute.firewalls.get + description: >- + Gets the access control policy for a resource. May be empty if no such + policy or resource exists. + operationId: compute.regionNetworkFirewallPolicies.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -72249,7 +79318,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Firewall' + $ref: '#/components/schemas/Policy' parameters: - in: path name: project @@ -72257,56 +79326,32 @@ paths: schema: type: string - in: path - name: firewall - required: true - schema: - type: string - delete: - description: Deletes the specified firewall. - operationId: compute.firewalls.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/compute - Oauth2c: - - https://www.googleapis.com/auth/compute - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: project + name: region required: true schema: type: string - in: path - name: firewall + name: resource required: true schema: type: string - in: query - name: requestId + name: optionsRequestedPolicyVersion schema: - type: string - put: + type: integer + format: int32 + /projects/{project}/regions/{region}/firewallPolicies/{resource}/setIamPolicy: + parameters: *ref_1 + post: 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 + Sets the access control policy on the specified resource. Replaces any + existing policy. + operationId: compute.regionNetworkFirewallPolicies.setIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/Firewall' + $ref: '#/components/schemas/RegionSetPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -72322,7 +79367,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Policy' parameters: - in: path name: project @@ -72330,25 +79375,25 @@ paths: schema: type: string - in: path - name: firewall + name: region required: true schema: type: string - - in: query - name: requestId + - in: path + name: resource + required: true schema: type: string - 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 + /projects/{project}/regions/{region}/firewallPolicies/{resource}/testIamPermissions: + parameters: *ref_1 + post: + description: Returns permissions that a caller has on the specified resource. + operationId: compute.regionNetworkFirewallPolicies.testIamPermissions requestBody: content: application/json: schema: - $ref: '#/components/schemas/Firewall' + $ref: '#/components/schemas/TestPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -72358,13 +79403,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/TestPermissionsResponse' parameters: - in: path name: project @@ -72372,21 +79421,22 @@ paths: schema: type: string - in: path - name: firewall + name: region required: true schema: type: string - - in: query - name: requestId + - in: path + name: resource + required: true schema: type: string - /locations/global/firewallPolicies: + /projects/{project}/global/securityPolicies: parameters: *ref_1 get: description: >- - Lists all the policies that have been configured for the specified - folder or organization. - operationId: compute.firewallPolicies.list + List all the policies that have been configured for the specified + project. + operationId: compute.securityPolicies.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -72406,8 +79456,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FirewallPolicyList' + $ref: '#/components/schemas/SecurityPolicyList' parameters: + - in: path + name: project + required: true + schema: + type: string - in: query name: filter schema: @@ -72425,10 +79480,6 @@ paths: name: pageToken schema: type: string - - in: query - name: parentId - schema: - type: string - in: query name: returnPartialSuccess schema: @@ -72437,12 +79488,12 @@ paths: description: >- Creates a new policy in the specified project using the data included in the request. - operationId: compute.firewallPolicies.insert + operationId: compute.securityPolicies.insert requestBody: content: application/json: schema: - $ref: '#/components/schemas/FirewallPolicy' + $ref: '#/components/schemas/SecurityPolicy' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -72460,19 +79511,24 @@ paths: schema: $ref: '#/components/schemas/Operation' parameters: - - in: query - name: parentId + - in: path + name: project + required: true schema: type: string - in: query name: requestId schema: type: string - /locations/global/firewallPolicies/{firewallPolicy}: + - in: query + name: validateOnly + schema: + type: boolean + /projects/{project}/global/securityPolicies/{securityPolicy}: parameters: *ref_1 get: - description: Returns the specified firewall policy. - operationId: compute.firewallPolicies.get + description: List all of the ordered rules present in a single specified policy. + operationId: compute.securityPolicies.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -72492,16 +79548,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FirewallPolicy' + $ref: '#/components/schemas/SecurityPolicy' parameters: - in: path - name: firewallPolicy + name: project + required: true + schema: + type: string + - in: path + name: securityPolicy required: true schema: type: string delete: description: Deletes the specified policy. - operationId: compute.firewallPolicies.delete + operationId: compute.securityPolicies.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -72520,7 +79581,12 @@ paths: $ref: '#/components/schemas/Operation' parameters: - in: path - name: firewallPolicy + name: project + required: true + schema: + type: string + - in: path + name: securityPolicy required: true schema: type: string @@ -72529,13 +79595,18 @@ paths: schema: type: string patch: - description: Patches the specified policy with the data included in the request. - operationId: compute.firewallPolicies.patch + description: >- + Patches the specified policy with the data included in the request. To + clear fields in the policy, leave the fields empty and specify them in + the updateMask. 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 requestBody: content: application/json: schema: - $ref: '#/components/schemas/FirewallPolicy' + $ref: '#/components/schemas/SecurityPolicy' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -72554,7 +79625,12 @@ paths: $ref: '#/components/schemas/Operation' parameters: - in: path - name: firewallPolicy + name: project + required: true + schema: + type: string + - in: path + name: securityPolicy required: true schema: type: string @@ -72562,11 +79638,16 @@ paths: name: requestId schema: type: string - /locations/global/firewallPolicies/{firewallPolicy}/getRule: + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /projects/{project}/global/securityPolicies/{securityPolicy}/getRule: parameters: *ref_1 get: - description: Gets a rule of the specified priority. - operationId: compute.firewallPolicies.getRule + description: Gets a rule at the specified priority. + operationId: compute.securityPolicies.getRule security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -72586,10 +79667,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FirewallPolicyRule' + $ref: '#/components/schemas/SecurityPolicyRule' parameters: - in: path - name: firewallPolicy + name: project + required: true + schema: + type: string + - in: path + name: securityPolicy required: true schema: type: string @@ -72598,16 +79684,16 @@ paths: schema: type: integer format: int32 - /locations/global/firewallPolicies/{firewallPolicy}/addRule: + /projects/{project}/global/securityPolicies/{securityPolicy}/addRule: parameters: *ref_1 post: - description: Inserts a rule into a firewall policy. - operationId: compute.firewallPolicies.addRule + description: Inserts a rule into a security policy. + operationId: compute.securityPolicies.addRule requestBody: content: application/json: schema: - $ref: '#/components/schemas/FirewallPolicyRule' + $ref: '#/components/schemas/SecurityPolicyRule' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -72626,60 +79712,24 @@ paths: $ref: '#/components/schemas/Operation' parameters: - in: path - name: firewallPolicy + name: project required: true schema: type: string - - in: query - name: requestId - schema: - type: string - /locations/global/firewallPolicies/{firewallPolicy}/removeRule: - parameters: *ref_1 - post: - description: Deletes a rule of the specified priority. - operationId: compute.firewallPolicies.removeRule - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/compute - Oauth2c: - - https://www.googleapis.com/auth/compute - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - in: path - name: firewallPolicy + name: securityPolicy required: true schema: type: string - in: query - name: priority - schema: - type: integer - format: int32 - - in: query - name: requestId + name: validateOnly schema: - type: string - /locations/global/firewallPolicies/{firewallPolicy}/patchRule: + type: boolean + /projects/{project}/global/securityPolicies/{securityPolicy}/removeRule: parameters: *ref_1 post: - description: Patches a rule of the specified priority. - operationId: compute.firewallPolicies.patchRule - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/FirewallPolicyRule' + description: Deletes a rule at the specified priority. + operationId: compute.securityPolicies.removeRule security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -72698,7 +79748,12 @@ paths: $ref: '#/components/schemas/Operation' parameters: - in: path - name: firewallPolicy + name: project + required: true + schema: + type: string + - in: path + name: securityPolicy required: true schema: type: string @@ -72707,20 +79762,18 @@ paths: schema: type: integer format: int32 - - in: query - name: requestId - schema: - type: string - /locations/global/firewallPolicies/{firewallPolicy}/addAssociation: + /projects/{project}/global/securityPolicies/{securityPolicy}/patchRule: parameters: *ref_1 post: - description: Inserts an association for the specified firewall policy. - operationId: compute.firewallPolicies.addAssociation + description: >- + Patches a rule at the specified priority. To clear fields in the rule, + leave the fields empty and specify them in the updateMask. + operationId: compute.securityPolicies.patchRule requestBody: content: application/json: schema: - $ref: '#/components/schemas/FirewallPolicyAssociation' + $ref: '#/components/schemas/SecurityPolicyRule' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -72739,23 +79792,36 @@ paths: $ref: '#/components/schemas/Operation' parameters: - in: path - name: firewallPolicy + name: project + required: true + schema: + type: string + - in: path + name: securityPolicy required: true schema: type: string - in: query - name: replaceExistingAssociation + name: priority schema: - type: boolean + type: integer + format: int32 - in: query - name: requestId + name: updateMask schema: type: string - /locations/global/firewallPolicies/{firewallPolicy}/removeAssociation: + format: google-fieldmask + - in: query + name: validateOnly + schema: + type: boolean + /projects/{project}/global/securityPolicies/listPreconfiguredExpressionSets: parameters: *ref_1 - post: - description: Removes an association for the specified firewall policy. - operationId: compute.firewallPolicies.removeAssociation + get: + description: >- + Gets the current list of preconfigured Web Application Firewall (WAF) + expressions. + operationId: compute.securityPolicies.listPreconfiguredExpressionSets security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -72765,32 +79831,57 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: >- + #/components/schemas/SecurityPoliciesListPreconfiguredExpressionSetsResponse parameters: - in: path - name: firewallPolicy + name: project required: true schema: type: string - in: query - name: name + name: filter schema: type: string - in: query - name: requestId + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy schema: type: string - /locations/global/firewallPolicies/listAssociations: + - in: query + name: pageToken + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean + /projects/{project}/global/securityPolicies/{resource}/setLabels: parameters: *ref_1 - get: - description: Lists associations of a specified target, i.e., organization or folder. - operationId: compute.firewallPolicies.listAssociations + post: + description: >- + Sets the labels on a security policy. To learn more about labels, read + the Labeling Resources documentation. + operationId: compute.securityPolicies.setLabels + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GlobalSetLabelsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -72800,27 +79891,32 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/FirewallPoliciesListAssociationsResponse' + $ref: '#/components/schemas/Operation' parameters: - - in: query - name: targetResource + - in: path + name: project + required: true schema: type: string - /locations/global/firewallPolicies/{firewallPolicy}/getAssociation: + - in: path + name: resource + required: true + schema: + type: string + /projects/{project}/aggregated/securityPolicies: parameters: *ref_1 get: - description: Gets an association with the specified name. - operationId: compute.firewallPolicies.getAssociation + description: >- + Retrieves the list of all SecurityPolicy resources, regional and global, + available to the specified project. To prevent failure, Google + recommends that you set the `returnPartialSuccess` parameter to `true`. + operationId: compute.securityPolicies.aggregatedList security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -72840,22 +79936,50 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FirewallPolicyAssociation' + $ref: '#/components/schemas/SecurityPoliciesAggregatedList' parameters: - in: path - name: firewallPolicy + name: project required: true schema: type: string - in: query - name: name + name: filter schema: type: string - /locations/global/firewallPolicies/{firewallPolicy}/cloneRules: + - in: query + name: includeAllScopes + schema: + type: boolean + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean + - in: query + name: serviceProjectNumber + schema: + type: string + format: int64 + /projects/{project}/regions/{region}/securityPolicies: parameters: *ref_1 - post: - description: Copies rules to the specified firewall policy. - operationId: compute.firewallPolicies.cloneRules + get: + description: >- + List all the policies that have been configured for the specified + project and region. + operationId: compute.regionSecurityPolicies.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -72865,32 +79989,59 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/SecurityPolicyList' parameters: - in: path - name: firewallPolicy + name: project + required: true + schema: + type: string + - in: path + name: region required: true schema: type: string - in: query - name: requestId + name: filter schema: type: string - in: query - name: sourceFirewallPolicy + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy schema: type: string - /locations/global/firewallPolicies/{firewallPolicy}/move: - parameters: *ref_1 + - in: query + name: pageToken + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean post: - description: Moves the specified firewall policy. - operationId: compute.firewallPolicies.move + description: >- + Creates a new policy in the specified project using the data included in + the request. + operationId: compute.regionSecurityPolicies.insert + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SecurityPolicy' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -72909,25 +80060,28 @@ paths: $ref: '#/components/schemas/Operation' parameters: - in: path - name: firewallPolicy + name: project required: true schema: type: string - - in: query - name: parentId + - in: path + name: region + required: true schema: type: string - in: query name: requestId schema: type: string - /locations/global/firewallPolicies/{resource}/getIamPolicy: + - in: query + name: validateOnly + schema: + type: boolean + /projects/{project}/regions/{region}/securityPolicies/{securityPolicy}: parameters: *ref_1 get: - description: >- - Gets the access control policy for a resource. May be empty if no such - policy or resource exists. - operationId: compute.firewallPolicies.getIamPolicy + description: List all of the ordered rules present in a single specified policy. + operationId: compute.regionSecurityPolicies.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -72947,30 +80101,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/SecurityPolicy' parameters: - in: path - name: resource + name: project required: true schema: type: string - - in: query - name: optionsRequestedPolicyVersion + - in: path + name: region + required: true schema: - type: integer - format: int32 - /locations/global/firewallPolicies/{resource}/setIamPolicy: - parameters: *ref_1 - post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. - operationId: compute.firewallPolicies.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GlobalOrganizationSetPolicyRequest' + type: string + - in: path + name: securityPolicy + required: true + schema: + type: string + delete: + description: Deletes the specified policy. + operationId: compute.regionSecurityPolicies.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -72986,23 +80136,40 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Operation' parameters: - in: path - name: resource + name: project required: true schema: type: string - /locations/global/firewallPolicies/{resource}/testIamPermissions: - parameters: *ref_1 - post: - description: Returns permissions that a caller has on the specified resource. - operationId: compute.firewallPolicies.testIamPermissions + - in: path + name: region + required: true + schema: + type: string + - in: path + name: securityPolicy + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + patch: + description: >- + Patches the specified policy with the data included in the request. To + clear fields in the policy, leave the fields empty and specify them in + the updateMask. 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.regionSecurityPolicies.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/TestPermissionsRequest' + $ref: '#/components/schemas/SecurityPolicy' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -73012,30 +80179,43 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/TestPermissionsResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path - name: resource + name: project required: true schema: type: string - /projects/{project}/global/firewallPolicies: + - in: path + name: region + required: true + schema: + type: string + - in: path + name: securityPolicy + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/getRule: parameters: *ref_1 get: - description: >- - Lists all the policies that have been configured for the specified - project. - operationId: compute.networkFirewallPolicies.list + description: Gets a rule at the specified priority. + operationId: compute.regionSecurityPolicies.getRule security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -73055,44 +80235,38 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FirewallPolicyList' + $ref: '#/components/schemas/SecurityPolicyRule' parameters: - in: path name: project required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy + - in: path + name: region + required: true schema: type: string - - in: query - name: pageToken + - in: path + name: securityPolicy + required: true schema: type: string - in: query - name: returnPartialSuccess + name: priority schema: - type: boolean + type: integer + format: int32 + /projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/addRule: + parameters: *ref_1 post: - description: >- - Creates a new policy in the specified project using the data included in - the request. - operationId: compute.networkFirewallPolicies.insert + description: Inserts a rule into a security policy. + operationId: compute.regionSecurityPolicies.addRule requestBody: content: application/json: schema: - $ref: '#/components/schemas/FirewallPolicy' + $ref: '#/components/schemas/SecurityPolicyRule' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -73115,15 +80289,25 @@ paths: required: true schema: type: string - - in: query - name: requestId + - in: path + name: region + required: true schema: type: string - /projects/{project}/global/firewallPolicies/{firewallPolicy}: + - in: path + name: securityPolicy + required: true + schema: + type: string + - in: query + name: validateOnly + schema: + type: boolean + /projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/removeRule: parameters: *ref_1 - get: - description: Returns the specified network firewall policy. - operationId: compute.networkFirewallPolicies.get + post: + description: Deletes a rule at the specified priority. + operationId: compute.regionSecurityPolicies.removeRule security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -73133,17 +80317,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/FirewallPolicy' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -73151,13 +80331,32 @@ paths: schema: type: string - in: path - name: firewallPolicy + name: region required: true schema: type: string - delete: - description: Deletes the specified policy. - operationId: compute.networkFirewallPolicies.delete + - in: path + name: securityPolicy + required: true + schema: + type: string + - in: query + name: priority + schema: + type: integer + format: int32 + /projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/patchRule: + parameters: *ref_1 + post: + description: >- + Patches a rule at the specified priority. To clear fields in the rule, + leave the fields empty and specify them in the updateMask. + operationId: compute.regionSecurityPolicies.patchRule + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SecurityPolicyRule' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -73181,22 +80380,41 @@ paths: schema: type: string - in: path - name: firewallPolicy + name: region + required: true + schema: + type: string + - in: path + name: securityPolicy required: true schema: type: string - in: query - name: requestId + name: priority + schema: + type: integer + format: int32 + - in: query + name: updateMask schema: type: string - patch: - description: Patches the specified policy with the data included in the request. - operationId: compute.networkFirewallPolicies.patch + format: google-fieldmask + - in: query + name: validateOnly + schema: + type: boolean + /projects/{project}/regions/{region}/securityPolicies/{resource}/setLabels: + parameters: *ref_1 + post: + description: >- + Sets the labels on a security policy. To learn more about labels, read + the Labeling Resources documentation. + operationId: compute.regionSecurityPolicies.setLabels requestBody: content: application/json: schema: - $ref: '#/components/schemas/FirewallPolicy' + $ref: '#/components/schemas/RegionSetLabelsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -73220,7 +80438,12 @@ paths: schema: type: string - in: path - name: firewallPolicy + name: region + required: true + schema: + type: string + - in: path + name: resource required: true schema: type: string @@ -73228,11 +80451,11 @@ paths: name: requestId schema: type: string - /projects/{project}/global/firewallPolicies/{firewallPolicy}/getRule: + /projects/{project}/zones/{zone}/instances: parameters: *ref_1 get: - description: Gets a rule of the specified priority. - operationId: compute.networkFirewallPolicies.getRule + description: Retrieves the list of instances contained within the specified zone. + operationId: compute.instances.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -73252,7 +80475,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FirewallPolicyRule' + $ref: '#/components/schemas/InstanceList' parameters: - in: path name: project @@ -73260,25 +80483,41 @@ paths: schema: type: string - in: path - name: firewallPolicy + name: zone required: true schema: type: string - in: query - name: priority + name: filter + schema: + type: string + - in: query + name: maxResults schema: type: integer - format: int32 - /projects/{project}/global/firewallPolicies/{firewallPolicy}/addRule: - parameters: *ref_1 + format: uint32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean post: - description: Inserts a rule into a firewall policy. - operationId: compute.networkFirewallPolicies.addRule + description: >- + Creates an instance resource in the specified project using the data + included in the request. + operationId: compute.instances.insert requestBody: content: application/json: schema: - $ref: '#/components/schemas/FirewallPolicyRule' + $ref: '#/components/schemas/Instance' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -73302,29 +80541,32 @@ paths: schema: type: string - in: path - name: firewallPolicy + name: zone required: true schema: type: string - in: query - name: maxPriority + name: requestId schema: - type: integer - format: int32 + type: string - in: query - name: minPriority + name: sourceInstanceTemplate schema: - type: integer - format: int32 + type: string - in: query - name: requestId + name: sourceMachineImage schema: type: string - /projects/{project}/global/firewallPolicies/{firewallPolicy}/removeRule: + /projects/{project}/aggregated/instances: parameters: *ref_1 - post: - description: Deletes a rule of the specified priority. - operationId: compute.networkFirewallPolicies.removeRule + 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. To prevent failure, Google recommends that you set the + `returnPartialSuccess` parameter to `true`. + operationId: compute.instances.aggregatedList security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -73334,43 +80576,62 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/InstanceAggregatedList' parameters: - in: path name: project required: true schema: type: string - - in: path - name: firewallPolicy - required: true + - in: query + name: filter schema: type: string - in: query - name: priority + name: includeAllScopes + schema: + type: boolean + - in: query + name: maxResults schema: type: integer - format: int32 + format: uint32 - in: query - name: requestId + name: orderBy schema: type: string - /projects/{project}/global/firewallPolicies/{firewallPolicy}/patchRule: + - in: query + name: pageToken + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean + - in: query + name: serviceProjectNumber + schema: + type: string + format: int64 + /projects/{project}/zones/{zone}/instances/{instance}/referrers: parameters: *ref_1 - post: - description: Patches a rule of the specified priority. - operationId: compute.networkFirewallPolicies.patchRule - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/FirewallPolicyRule' + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -73380,13 +80641,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/InstanceListReferrers' parameters: - in: path name: project @@ -73394,26 +80659,41 @@ paths: schema: type: string - in: path - name: firewallPolicy + name: zone + required: true + schema: + type: string + - in: path + name: instance required: true schema: type: string - in: query - name: priority + name: filter + schema: + type: string + - in: query + name: maxResults schema: type: integer - format: int32 + format: uint32 - in: query - name: requestId + name: orderBy schema: type: string - /projects/{project}/global/firewallPolicies/{resource}/getIamPolicy: + - in: query + name: pageToken + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean + /projects/{project}/zones/{zone}/instances/{instance}: parameters: *ref_1 get: - description: >- - Gets the access control policy for a resource. May be empty if no such - policy or resource exists. - operationId: compute.networkFirewallPolicies.getIamPolicy + description: Returns the specified Instance resource. + operationId: compute.instances.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -73433,7 +80713,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Instance' parameters: - in: path name: project @@ -73441,27 +80721,20 @@ paths: schema: type: string - in: path - name: resource + name: zone required: true schema: type: string - - in: query - name: optionsRequestedPolicyVersion + - in: path + name: instance + required: true schema: - type: integer - format: int32 - /projects/{project}/global/firewallPolicies/{resource}/setIamPolicy: - parameters: *ref_1 - post: + type: string + delete: description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. - operationId: compute.networkFirewallPolicies.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GlobalSetPolicyRequest' + Deletes the specified Instance resource. For more information, see + Deleting an instance. + operationId: compute.instances.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -73477,7 +80750,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -73485,20 +80758,30 @@ paths: schema: type: string - in: path - name: resource + name: zone required: true schema: type: string - /projects/{project}/global/firewallPolicies/{resource}/testIamPermissions: - parameters: *ref_1 - post: - description: Returns permissions that a caller has on the specified resource. - operationId: compute.networkFirewallPolicies.testIamPermissions + - in: path + name: instance + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + 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 requestBody: content: application/json: schema: - $ref: '#/components/schemas/TestPermissionsRequest' + $ref: '#/components/schemas/Instance' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -73508,17 +80791,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/TestPermissionsResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -73526,20 +80805,34 @@ paths: schema: type: string - in: path - name: resource + name: zone required: true schema: type: string - /projects/{project}/global/firewallPolicies/{firewallPolicy}/addAssociation: + - in: path + name: instance + required: true + schema: + type: string + - in: query + name: minimalAction + schema: + type: string + - in: query + name: mostDisruptiveAllowedAction + schema: + type: string + - in: query + name: requestId + schema: + type: string + /projects/{project}/zones/{zone}/instances/{instance}/reset: parameters: *ref_1 post: - description: Inserts an association for the specified firewall policy. - operationId: compute.networkFirewallPolicies.addAssociation - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/FirewallPolicyAssociation' + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -73563,23 +80856,26 @@ paths: schema: type: string - in: path - name: firewallPolicy + name: zone required: true schema: type: string - - in: query - name: replaceExistingAssociation + - in: path + name: instance + required: true schema: - type: boolean + type: string - in: query name: requestId schema: type: string - /projects/{project}/global/firewallPolicies/{firewallPolicy}/removeAssociation: + /projects/{project}/zones/{zone}/instances/{instance}/simulateMaintenanceEvent: parameters: *ref_1 post: - description: Removes an association for the specified firewall policy. - operationId: compute.networkFirewallPolicies.removeAssociation + description: >- + Simulates a host maintenance event on a VM. For more information, see + Simulate a host maintenance event. + operationId: compute.instances.simulateMaintenanceEvent security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -73603,23 +80899,28 @@ paths: schema: type: string - in: path - name: firewallPolicy + name: zone required: true schema: type: string - - in: query - name: name + - in: path + name: instance + required: true schema: type: string - in: query name: requestId schema: type: string - /projects/{project}/global/firewallPolicies/{firewallPolicy}/getAssociation: + - in: query + name: withExtendedNotifications + schema: + type: boolean + /projects/{project}/zones/{zone}/instances/{instance}/performMaintenance: parameters: *ref_1 - get: - description: Gets an association with the specified name. - operationId: compute.networkFirewallPolicies.getAssociation + post: + description: Perform a manual maintenance on the instance. + operationId: compute.instances.performMaintenance security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -73629,17 +80930,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/FirewallPolicyAssociation' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -73647,19 +80944,29 @@ paths: schema: type: string - in: path - name: firewallPolicy + name: zone + required: true + schema: + type: string + - in: path + name: instance required: true schema: type: string - in: query - name: name + name: requestId schema: type: string - /projects/{project}/global/firewallPolicies/{firewallPolicy}/cloneRules: + /projects/{project}/zones/{zone}/instances/{instance}/reportHostAsFaulty: parameters: *ref_1 post: - description: Copies rules to the specified firewall policy. - operationId: compute.networkFirewallPolicies.cloneRules + description: Mark the host as faulty and try to restart the instance on a new host. + operationId: compute.instances.reportHostAsFaulty + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstancesReportHostAsFaultyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -73683,25 +80990,29 @@ paths: schema: type: string - in: path - name: firewallPolicy + name: zone required: true schema: type: string - - in: query - name: requestId + - in: path + name: instance + required: true schema: type: string - in: query - name: sourceFirewallPolicy + name: requestId schema: type: string - /projects/{project}/regions/{region}/firewallPolicies: + /projects/{project}/zones/{zone}/instances/{instance}/addAccessConfig: parameters: *ref_1 - get: - description: >- - Lists all the network firewall policies that have been configured for - the specified project in the given region. - operationId: compute.regionNetworkFirewallPolicies.list + post: + description: Adds an access config to an instance's network interface. + operationId: compute.instances.addAccessConfig + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AccessConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -73711,17 +81022,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/FirewallPolicyList' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -73729,41 +81036,29 @@ paths: schema: type: string - in: path - name: region + name: zone required: true schema: type: string - - in: query - name: filter + - in: path + name: instance + required: true schema: type: string - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy + name: networkInterface + required: true schema: type: string - in: query - name: pageToken + name: requestId schema: type: string - - in: query - name: returnPartialSuccess - schema: - type: boolean + /projects/{project}/zones/{zone}/instances/{instance}/deleteAccessConfig: + parameters: *ref_1 post: - description: >- - Creates a new network firewall policy in the specified project and - region. - operationId: compute.regionNetworkFirewallPolicies.insert - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/FirewallPolicy' + description: Deletes an access config from an instance's network interface. + operationId: compute.instances.deleteAccessConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -73787,7 +81082,22 @@ paths: schema: type: string - in: path - name: region + name: zone + required: true + schema: + type: string + - in: path + name: instance + required: true + schema: + type: string + - in: query + name: accessConfig + required: true + schema: + type: string + - in: query + name: networkInterface required: true schema: type: string @@ -73795,11 +81105,19 @@ paths: name: requestId schema: type: string - /projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}: + /projects/{project}/zones/{zone}/instances/{instance}/updateAccessConfig: parameters: *ref_1 - get: - description: Returns the specified network firewall policy. - operationId: compute.regionNetworkFirewallPolicies.get + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AccessConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -73809,17 +81127,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/FirewallPolicy' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -73827,18 +81141,39 @@ paths: schema: type: string - in: path - name: region + name: zone required: true schema: type: string - in: path - name: firewallPolicy + name: instance required: true schema: type: string - delete: - description: Deletes the specified network firewall policy. - operationId: compute.regionNetworkFirewallPolicies.delete + - in: query + name: networkInterface + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + /projects/{project}/zones/{zone}/instances/{instance}/updateNetworkInterface: + parameters: *ref_1 + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkInterface' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -73862,12 +81197,17 @@ paths: schema: type: string - in: path - name: region + name: zone required: true schema: type: string - in: path - name: firewallPolicy + name: instance + required: true + schema: + type: string + - in: query + name: networkInterface required: true schema: type: string @@ -73875,14 +81215,21 @@ paths: name: requestId schema: type: string - patch: - description: Patches the specified network firewall policy. - operationId: compute.regionNetworkFirewallPolicies.patch + /projects/{project}/zones/{zone}/instances/{instance}/setScheduling: + parameters: *ref_1 + 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. For more information about setting scheduling options + for a VM, see Set VM host maintenance policy. + operationId: compute.instances.setScheduling requestBody: content: application/json: schema: - $ref: '#/components/schemas/FirewallPolicy' + $ref: '#/components/schemas/Scheduling' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -73906,12 +81253,12 @@ paths: schema: type: string - in: path - name: region + name: zone required: true schema: type: string - in: path - name: firewallPolicy + name: instance required: true schema: type: string @@ -73919,11 +81266,11 @@ paths: name: requestId schema: type: string - /projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getRule: + /projects/{project}/zones/{zone}/instances/{instance}/serialPort: parameters: *ref_1 get: - description: Gets a rule of the specified priority. - operationId: compute.regionNetworkFirewallPolicies.getRule + description: Returns the last 1 MB of serial port output from the specified instance. + operationId: compute.instances.getSerialPortOutput security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -73943,7 +81290,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FirewallPolicyRule' + $ref: '#/components/schemas/SerialPortOutput' parameters: - in: path name: project @@ -73951,30 +81298,30 @@ paths: schema: type: string - in: path - name: region + name: zone required: true schema: type: string - in: path - name: firewallPolicy + name: instance required: true schema: type: string - in: query - name: priority + name: port schema: type: integer format: int32 - /projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addRule: + - in: query + name: start + schema: + type: string + format: int64 + /projects/{project}/zones/{zone}/instances/{instance}/screenshot: parameters: *ref_1 - post: - description: Inserts a rule into a network firewall policy. - operationId: compute.regionNetworkFirewallPolicies.addRule - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/FirewallPolicyRule' + get: + description: Returns the screenshot from the specified instance. + operationId: compute.instances.getScreenshot security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -73984,13 +81331,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Screenshot' parameters: - in: path name: project @@ -73998,34 +81349,53 @@ paths: schema: type: string - in: path - name: region + name: zone required: true schema: type: string - in: path - name: firewallPolicy + name: instance required: true schema: type: string - - in: query - name: maxPriority + /projects/{project}/zones/{zone}/instances/{instance}/sendDiagnosticInterrupt: + parameters: *ref_1 + post: + description: Sends diagnostic interrupt to the instance. + operationId: compute.instances.sendDiagnosticInterrupt + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + responses: + '204': + description: No Content + parameters: + - in: path + name: project + required: true schema: - type: integer - format: int32 - - in: query - name: minPriority + type: string + - in: path + name: zone + required: true schema: - type: integer - format: int32 - - in: query - name: requestId + type: string + - in: path + name: instance + required: true schema: type: string - /projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeRule: + /projects/{project}/zones/{zone}/instances/{instance}/getGuestAttributes: parameters: *ref_1 - post: - description: Deletes a rule of the specified priority. - operationId: compute.regionNetworkFirewallPolicies.removeRule + get: + description: Returns the specified guest attributes entry. + operationId: compute.instances.getGuestAttributes security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -74035,13 +81405,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/GuestAttributes' parameters: - in: path name: project @@ -74049,34 +81423,37 @@ paths: schema: type: string - in: path - name: region + name: zone required: true schema: type: string - in: path - name: firewallPolicy + name: instance required: true schema: type: string - in: query - name: priority + name: queryPath schema: - type: integer - format: int32 + type: string - in: query - name: requestId + name: variableKey schema: type: string - /projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/patchRule: + /projects/{project}/zones/{zone}/instances/{instance}/attachDisk: parameters: *ref_1 post: - description: Patches a rule of the specified priority. - operationId: compute.regionNetworkFirewallPolicies.patchRule + 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 requestBody: content: application/json: schema: - $ref: '#/components/schemas/FirewallPolicyRule' + $ref: '#/components/schemas/AttachedDisk' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -74100,29 +81477,28 @@ paths: schema: type: string - in: path - name: region + name: zone required: true schema: type: string - in: path - name: firewallPolicy + name: instance required: true schema: type: string - in: query - name: priority + name: forceAttach schema: - type: integer - format: int32 + type: boolean - in: query name: requestId schema: type: string - /projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/cloneRules: + /projects/{project}/zones/{zone}/instances/{instance}/detachDisk: parameters: *ref_1 post: - description: Copies rules to the specified network firewall policy. - operationId: compute.regionNetworkFirewallPolicies.cloneRules + description: Detaches a disk from an instance. + operationId: compute.instances.detachDisk security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -74146,28 +81522,36 @@ paths: schema: type: string - in: path - name: region + name: zone required: true schema: type: string - in: path - name: firewallPolicy + name: instance required: true schema: type: string - in: query - name: requestId + name: deviceName + required: true schema: type: string - in: query - name: sourceFirewallPolicy + name: requestId schema: type: string - /projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getAssociation: + /projects/{project}/zones/{zone}/instances/{instance}/setMachineResources: parameters: *ref_1 - get: - description: Gets an association with the specified name. - operationId: compute.regionNetworkFirewallPolicies.getAssociation + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstancesSetMachineResourcesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -74177,17 +81561,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/FirewallPolicyAssociation' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -74195,29 +81575,31 @@ paths: schema: type: string - in: path - name: region + name: zone required: true schema: type: string - in: path - name: firewallPolicy + name: instance required: true schema: type: string - in: query - name: name + name: requestId schema: type: string - /projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addAssociation: + /projects/{project}/zones/{zone}/instances/{instance}/setMachineType: parameters: *ref_1 post: - description: Inserts an association for the specified network firewall policy. - operationId: compute.regionNetworkFirewallPolicies.addAssociation + description: >- + Changes the machine type for a stopped instance to the machine type + specified in the request. + operationId: compute.instances.setMachineType requestBody: content: application/json: schema: - $ref: '#/components/schemas/FirewallPolicyAssociation' + $ref: '#/components/schemas/InstancesSetMachineTypeRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -74241,28 +81623,31 @@ paths: schema: type: string - in: path - name: region + name: zone required: true schema: type: string - in: path - name: firewallPolicy + name: instance required: true schema: type: string - - in: query - name: replaceExistingAssociation - schema: - type: boolean - in: query name: requestId schema: type: string - /projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeAssociation: + /projects/{project}/zones/{zone}/instances/{instance}/setMetadata: parameters: *ref_1 post: - description: Removes an association for the specified network firewall policy. - operationId: compute.regionNetworkFirewallPolicies.removeAssociation + description: >- + Sets metadata for the specified instance to the data included in the + request. + operationId: compute.instances.setMetadata + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Metadata' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -74286,28 +81671,32 @@ paths: schema: type: string - in: path - name: region + name: zone required: true schema: type: string - in: path - name: firewallPolicy + name: instance required: true schema: type: string - - in: query - name: name - schema: - type: string - in: query name: requestId schema: type: string - /projects/{project}/regions/{region}/firewallPolicies/getEffectiveFirewalls: + /projects/{project}/zones/{zone}/instances/{instance}/setMinCpuPlatform: parameters: *ref_1 - get: - description: Returns the effective firewalls on a given network. - operationId: compute.regionNetworkFirewallPolicies.getEffectiveFirewalls + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstancesSetMinCpuPlatformRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -74317,18 +81706,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -74336,22 +81720,31 @@ paths: schema: type: string - in: path - name: region + name: zone required: true schema: type: string - - in: query - name: network + - in: path + name: instance required: true schema: type: string - /projects/{project}/regions/{region}/firewallPolicies/{resource}/getIamPolicy: + - in: query + name: requestId + schema: + type: string + /projects/{project}/zones/{zone}/instances/{instance}/setTags: parameters: *ref_1 - get: + post: description: >- - Gets the access control policy for a resource. May be empty if no such - policy or resource exists. - operationId: compute.regionNetworkFirewallPolicies.getIamPolicy + Sets network tags for the specified instance to the data included in the + request. + operationId: compute.instances.setTags + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Tags' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -74361,17 +81754,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -74379,32 +81768,31 @@ paths: schema: type: string - in: path - name: region + name: zone required: true schema: type: string - in: path - name: resource + name: instance required: true schema: type: string - in: query - name: optionsRequestedPolicyVersion + name: requestId schema: - type: integer - format: int32 - /projects/{project}/regions/{region}/firewallPolicies/{resource}/setIamPolicy: + type: string + /projects/{project}/zones/{zone}/instances/{instance}/setLabels: parameters: *ref_1 post: description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. - operationId: compute.regionNetworkFirewallPolicies.setIamPolicy + Sets labels on an instance. To learn more about labels, read the + Labeling Resources documentation. + operationId: compute.instances.setLabels requestBody: content: application/json: schema: - $ref: '#/components/schemas/RegionSetPolicyRequest' + $ref: '#/components/schemas/InstancesSetLabelsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -74420,7 +81808,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -74428,25 +81816,29 @@ paths: schema: type: string - in: path - name: region + name: zone required: true schema: type: string - in: path - name: resource + name: instance required: true schema: type: string - /projects/{project}/regions/{region}/firewallPolicies/{resource}/testIamPermissions: + - in: query + name: requestId + schema: + type: string + /projects/{project}/zones/{zone}/instances/{instance}/setName: parameters: *ref_1 post: - description: Returns permissions that a caller has on the specified resource. - operationId: compute.regionNetworkFirewallPolicies.testIamPermissions + description: Sets name of an instance. + operationId: compute.instances.setName requestBody: content: application/json: schema: - $ref: '#/components/schemas/TestPermissionsRequest' + $ref: '#/components/schemas/InstancesSetNameRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -74456,17 +81848,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/TestPermissionsResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -74474,22 +81862,24 @@ paths: schema: type: string - in: path - name: region + name: zone required: true schema: type: string - in: path - name: resource + name: instance required: true schema: type: string - /projects/{project}/global/securityPolicies: + - in: query + name: requestId + schema: + type: string + /projects/{project}/zones/{zone}/instances/{instance}/setDiskAutoDelete: parameters: *ref_1 - get: - description: >- - List all the policies that have been configured for the specified - project. - operationId: compute.securityPolicies.list + post: + description: Sets the auto-delete flag for a disk attached to an instance. + operationId: compute.instances.setDiskAutoDelete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -74499,54 +81889,50 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/SecurityPolicyList' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project required: true schema: type: string - - in: query - name: filter + - in: path + name: zone + required: true schema: type: string - - in: query - name: maxResults + - in: path + name: instance + required: true schema: - type: integer - format: uint32 + type: string - in: query - name: orderBy + name: autoDelete + required: true schema: - type: string + type: boolean - in: query - name: pageToken + name: deviceName + required: true schema: type: string - in: query - name: returnPartialSuccess + name: requestId schema: - type: boolean + type: string + /projects/{project}/zones/{zone}/instances/{instance}/start: + parameters: *ref_1 post: description: >- - Creates a new policy in the specified project using the data included in - the request. - operationId: compute.securityPolicies.insert - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SecurityPolicy' + Starts an instance that was stopped using the instances().stop method. + For more information, see Restart an instance. + operationId: compute.instances.start security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -74569,19 +81955,32 @@ paths: required: true schema: type: string - - in: query - name: requestId + - in: path + name: zone + required: true + schema: + type: string + - in: path + name: instance + required: true schema: type: string - in: query - name: validateOnly + name: requestId schema: - type: boolean - /projects/{project}/global/securityPolicies/{securityPolicy}: + type: string + /projects/{project}/zones/{zone}/instances/{instance}/startWithEncryptionKey: parameters: *ref_1 - get: - description: List all of the ordered rules present in a single specified policy. - operationId: compute.securityPolicies.get + post: + description: >- + Starts an instance that was stopped using the instances().stop method. + For more information, see Restart an instance. + operationId: compute.instances.startWithEncryptionKey + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstancesStartWithEncryptionKeyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -74591,17 +81990,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/SecurityPolicy' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -74609,13 +82004,30 @@ paths: schema: type: string - in: path - name: securityPolicy + name: zone required: true schema: type: string - delete: - description: Deletes the specified policy. - operationId: compute.securityPolicies.delete + - in: path + name: instance + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + /projects/{project}/zones/{zone}/instances/{instance}/stop: + parameters: *ref_1 + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -74639,27 +82051,30 @@ paths: schema: type: string - in: path - name: securityPolicy + name: zone + required: true + schema: + type: string + - in: path + name: instance required: true schema: type: string + - in: query + name: discardLocalSsd + schema: + type: boolean - in: query name: requestId schema: type: string - patch: + /projects/{project}/zones/{zone}/instances/{resource}/getIamPolicy: + parameters: *ref_1 + get: description: >- - Patches the specified policy with the data included in the request. To - clear fields in the policy, leave the fields empty and specify them in - the updateMask. 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 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SecurityPolicy' + Gets the access control policy for a resource. May be empty if no such + policy or resource exists. + operationId: compute.instances.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -74669,13 +82084,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Policy' parameters: - in: path name: project @@ -74683,24 +82102,32 @@ paths: schema: type: string - in: path - name: securityPolicy + name: zone required: true schema: type: string - - in: query - name: requestId + - in: path + name: resource + required: true schema: type: string - in: query - name: updateMask + name: optionsRequestedPolicyVersion schema: - type: string - format: google-fieldmask - /projects/{project}/global/securityPolicies/{securityPolicy}/getRule: + type: integer + format: int32 + /projects/{project}/zones/{zone}/instances/{resource}/setIamPolicy: parameters: *ref_1 - get: - description: Gets a rule at the specified priority. - operationId: compute.securityPolicies.getRule + post: + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy. + operationId: compute.instances.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZoneSetPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -74710,17 +82137,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/SecurityPolicyRule' + $ref: '#/components/schemas/Policy' parameters: - in: path name: project @@ -74728,25 +82151,25 @@ paths: schema: type: string - in: path - name: securityPolicy + name: zone required: true schema: type: string - - in: query - name: priority + - in: path + name: resource + required: true schema: - type: integer - format: int32 - /projects/{project}/global/securityPolicies/{securityPolicy}/addRule: + type: string + /projects/{project}/zones/{zone}/instances/{resource}/testIamPermissions: parameters: *ref_1 post: - description: Inserts a rule into a security policy. - operationId: compute.securityPolicies.addRule + description: Returns permissions that a caller has on the specified resource. + operationId: compute.instances.testIamPermissions requestBody: content: application/json: schema: - $ref: '#/components/schemas/SecurityPolicyRule' + $ref: '#/components/schemas/TestPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -74756,13 +82179,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/TestPermissionsResponse' parameters: - in: path name: project @@ -74770,19 +82197,27 @@ paths: schema: type: string - in: path - name: securityPolicy + name: zone required: true schema: type: string - - in: query - name: validateOnly + - in: path + name: resource + required: true schema: - type: boolean - /projects/{project}/global/securityPolicies/{securityPolicy}/removeRule: + type: string + /projects/{project}/zones/{zone}/instances/{instance}/setServiceAccount: parameters: *ref_1 post: - description: Deletes a rule at the specified priority. - operationId: compute.securityPolicies.removeRule + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstancesSetServiceAccountRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -74806,27 +82241,24 @@ paths: schema: type: string - in: path - name: securityPolicy + name: zone + required: true + schema: + type: string + - in: path + name: instance required: true schema: type: string - in: query - name: priority + name: requestId schema: - type: integer - format: int32 - /projects/{project}/global/securityPolicies/{securityPolicy}/patchRule: + type: string + /projects/{project}/zones/{zone}/instances/{resource}/setDeletionProtection: parameters: *ref_1 post: - description: >- - Patches a rule at the specified priority. To clear fields in the rule, - leave the fields empty and specify them in the updateMask. - operationId: compute.securityPolicies.patchRule - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SecurityPolicyRule' + description: Sets deletion protection on the instance. + operationId: compute.instances.setDeletionProtection security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -74850,31 +82282,36 @@ paths: schema: type: string - in: path - name: securityPolicy + name: zone required: true schema: type: string - - in: query - name: priority - schema: - type: integer - format: int32 - - in: query - name: updateMask + - in: path + name: resource + required: true schema: type: string - format: google-fieldmask - in: query - name: validateOnly + name: deletionProtection schema: type: boolean - /projects/{project}/global/securityPolicies/listPreconfiguredExpressionSets: + - in: query + name: requestId + schema: + type: string + /projects/{project}/zones/{zone}/instances/{instance}/suspend: parameters: *ref_1 - get: + post: description: >- - Gets the current list of preconfigured Web Application Firewall (WAF) - expressions. - operationId: compute.securityPolicies.listPreconfiguredExpressionSets + This method suspends a running instance, saving its state to persistent + storage, and allows you to resume the instance at a later time. + Suspended instances have no compute costs (cores or RAM), and incur only + storage charges for the saved VM memory and localSSD data. Any charged + resources the virtual machine was using, such as persistent disks and + static IP addresses, will continue to be charged while the instance is + suspended. For more information, see Suspending and resuming an + instance. + operationId: compute.instances.suspend security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -74884,57 +82321,44 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/SecurityPoliciesListPreconfiguredExpressionSetsResponse + $ref: '#/components/schemas/Operation' parameters: - in: path name: project required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy + - in: path + name: zone + required: true schema: type: string - - in: query - name: pageToken + - in: path + name: instance + required: true schema: type: string - in: query - name: returnPartialSuccess + name: discardLocalSsd schema: type: boolean - /projects/{project}/global/securityPolicies/{resource}/setLabels: + - in: query + name: requestId + schema: + type: string + /projects/{project}/zones/{zone}/instances/{instance}/resume: parameters: *ref_1 post: description: >- - Sets the labels on a security policy. To learn more about labels, read - the Labeling Resources documentation. - operationId: compute.securityPolicies.setLabels - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GlobalSetLabelsRequest' + Resumes an instance that was suspended using the instances().suspend + method. + operationId: compute.instances.resume security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -74958,18 +82382,32 @@ paths: schema: type: string - in: path - name: resource + name: zone required: true schema: type: string - /projects/{project}/aggregated/securityPolicies: + - in: path + name: instance + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + /projects/{project}/zones/{zone}/instances/{instance}/addResourcePolicies: parameters: *ref_1 - get: + post: description: >- - Retrieves the list of all SecurityPolicy resources, regional and global, - available to the specified project. To prevent failure, Google - recommends that you set the `returnPartialSuccess` parameter to `true`. - operationId: compute.securityPolicies.aggregatedList + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstancesAddResourcePoliciesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -74979,60 +82417,43 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/SecurityPoliciesAggregatedList' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: includeAllScopes - schema: - type: boolean - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy + - in: path + name: zone + required: true schema: type: string - - in: query - name: pageToken + - in: path + name: instance + required: true schema: type: string - in: query - name: returnPartialSuccess - schema: - type: boolean - - in: query - name: serviceProjectNumber + name: requestId schema: type: string - format: int64 - /projects/{project}/regions/{region}/securityPolicies: + /projects/{project}/zones/{zone}/instances/{instance}/removeResourcePolicies: parameters: *ref_1 - get: - description: >- - List all the policies that have been configured for the specified - project and region. - operationId: compute.regionSecurityPolicies.list + post: + description: Removes resource policies from an instance. + operationId: compute.instances.removeResourcePolicies + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstancesRemoveResourcePoliciesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -75042,17 +82463,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/SecurityPolicyList' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -75060,41 +82477,32 @@ paths: schema: type: string - in: path - name: region + name: zone required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy + - in: path + name: instance + required: true schema: type: string - in: query - name: pageToken + name: requestId schema: type: string - - in: query - name: returnPartialSuccess - schema: - type: boolean - post: + /projects/{project}/zones/{zone}/instances/{instance}/updateShieldedInstanceConfig: + parameters: *ref_1 + patch: description: >- - Creates a new policy in the specified project using the data included in - the request. - operationId: compute.regionSecurityPolicies.insert + 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 requestBody: content: application/json: schema: - $ref: '#/components/schemas/SecurityPolicy' + $ref: '#/components/schemas/ShieldedInstanceConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -75118,23 +82526,32 @@ paths: schema: type: string - in: path - name: region + name: zone required: true schema: type: string - - in: query - name: requestId + - in: path + name: instance + required: true schema: type: string - in: query - name: validateOnly + name: requestId schema: - type: boolean - /projects/{project}/regions/{region}/securityPolicies/{securityPolicy}: + type: string + /projects/{project}/zones/{zone}/instances/{instance}/updateDisplayDevice: parameters: *ref_1 - get: - description: List all of the ordered rules present in a single specified policy. - operationId: compute.regionSecurityPolicies.get + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DisplayDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -75144,17 +82561,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/SecurityPolicy' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -75162,18 +82575,32 @@ paths: schema: type: string - in: path - name: region + name: zone required: true schema: type: string - in: path - name: securityPolicy + name: instance required: true schema: type: string - delete: - description: Deletes the specified policy. - operationId: compute.regionSecurityPolicies.delete + - in: query + name: requestId + schema: + type: string + /projects/{project}/zones/{zone}/instances/{instance}/setShieldedInstanceIntegrityPolicy: + parameters: *ref_1 + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ShieldedInstanceIntegrityPolicy' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -75197,12 +82624,12 @@ paths: schema: type: string - in: path - name: region + name: zone required: true schema: type: string - in: path - name: securityPolicy + name: instance required: true schema: type: string @@ -75210,19 +82637,18 @@ paths: name: requestId schema: type: string - patch: + /projects/{project}/zones/{zone}/instances/{instance}/setSecurityPolicy: + parameters: *ref_1 + post: description: >- - Patches the specified policy with the data included in the request. To - clear fields in the policy, leave the fields empty and specify them in - the updateMask. 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.regionSecurityPolicies.patch + Sets the Google Cloud Armor security policy for the specified instance. + For more information, see Google Cloud Armor Overview + operationId: compute.instances.setSecurityPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/SecurityPolicy' + $ref: '#/components/schemas/InstancesSetSecurityPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -75246,12 +82672,12 @@ paths: schema: type: string - in: path - name: region + name: zone required: true schema: type: string - in: path - name: securityPolicy + name: instance required: true schema: type: string @@ -75259,16 +82685,11 @@ paths: name: requestId schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/getRule: + /projects/{project}/zones/{zone}/instances/{instance}/getShieldedInstanceIdentity: parameters: *ref_1 get: - description: Gets a rule at the specified priority. - operationId: compute.regionSecurityPolicies.getRule + description: Returns the Shielded Instance Identity of an instance + operationId: compute.instances.getShieldedInstanceIdentity security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -75288,7 +82709,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SecurityPolicyRule' + $ref: '#/components/schemas/ShieldedInstanceIdentity' parameters: - in: path name: project @@ -75296,30 +82717,27 @@ paths: schema: type: string - in: path - name: region + name: zone required: true schema: type: string - in: path - name: securityPolicy + name: instance required: true schema: type: string - - in: query - name: priority - schema: - type: integer - format: int32 - /projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/addRule: + /projects/{project}/zones/{zone}/instances/bulkInsert: parameters: *ref_1 post: - description: Inserts a rule into a security policy. - operationId: compute.regionSecurityPolicies.addRule + description: >- + Creates multiple instances. Count specifies the number of instances to + create. For more information, see About bulk creation of VMs. + operationId: compute.instances.bulkInsert requestBody: content: application/json: schema: - $ref: '#/components/schemas/SecurityPolicyRule' + $ref: '#/components/schemas/BulkInsertInstanceResource' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -75343,24 +82761,19 @@ paths: schema: type: string - in: path - name: region - required: true - schema: - type: string - - in: path - name: securityPolicy + name: zone required: true schema: type: string - in: query - name: validateOnly + name: requestId schema: - type: boolean - /projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/removeRule: + type: string + /projects/{project}/zones/{zone}/instances/{instance}/getEffectiveFirewalls: parameters: *ref_1 - post: - description: Deletes a rule at the specified priority. - operationId: compute.regionSecurityPolicies.removeRule + get: + description: Returns effective firewalls applied to an interface of the instance. + operationId: compute.instances.getEffectiveFirewalls security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -75370,13 +82783,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/InstancesGetEffectiveFirewallsResponse' parameters: - in: path name: project @@ -75384,32 +82801,32 @@ paths: schema: type: string - in: path - name: region + name: zone required: true schema: type: string - in: path - name: securityPolicy + name: instance required: true schema: type: string - in: query - name: priority + name: networkInterface + required: true schema: - type: integer - format: int32 - /projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/patchRule: + type: string + /projects/{project}/regions/{region}/instances/bulkInsert: parameters: *ref_1 post: description: >- - Patches a rule at the specified priority. To clear fields in the rule, - leave the fields empty and specify them in the updateMask. - operationId: compute.regionSecurityPolicies.patchRule + Creates multiple instances in a given region. Count specifies the number + of instances to create. + operationId: compute.regionInstances.bulkInsert requestBody: content: application/json: schema: - $ref: '#/components/schemas/SecurityPolicyRule' + $ref: '#/components/schemas/BulkInsertInstanceResource' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -75437,30 +82854,17 @@ paths: required: true schema: type: string - - in: path - name: securityPolicy - required: true - schema: - type: string - - in: query - name: priority - schema: - type: integer - format: int32 - in: query - name: updateMask + name: requestId schema: type: string - format: google-fieldmask - - in: query - name: validateOnly - schema: - type: boolean - /projects/{project}/zones/{zone}/instances: + /projects/{project}/zones/{zone}/reservations: parameters: *ref_1 get: - description: Retrieves the list of instances contained within the specified zone. - operationId: compute.instances.list + description: >- + A list of all the reservations that have been configured for the + specified project in specified zone. + operationId: compute.reservations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -75480,7 +82884,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InstanceList' + $ref: '#/components/schemas/ReservationList' parameters: - in: path name: project @@ -75515,14 +82919,14 @@ paths: type: boolean post: description: >- - Creates an instance resource in the specified project using the data - included in the request. - operationId: compute.instances.insert + Creates a new reservation. For more information, read Reserving zonal + resources. + operationId: compute.reservations.insert requestBody: content: application/json: schema: - $ref: '#/components/schemas/Instance' + $ref: '#/components/schemas/Reservation' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -75554,24 +82958,13 @@ paths: name: requestId schema: type: string - - in: query - name: sourceInstanceTemplate - schema: - type: string - - in: query - name: sourceMachineImage - schema: - type: string - /projects/{project}/aggregated/instances: + /projects/{project}/aggregated/reservations: parameters: *ref_1 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. To prevent failure, Google recommends that you set the - `returnPartialSuccess` parameter to `true`. - operationId: compute.instances.aggregatedList + Retrieves an aggregated list of reservations. To prevent failure, Google + recommends that you set the `returnPartialSuccess` parameter to `true`. + operationId: compute.reservations.aggregatedList security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -75591,7 +82984,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InstanceAggregatedList' + $ref: '#/components/schemas/ReservationAggregatedList' parameters: - in: path name: project @@ -75628,77 +83021,11 @@ paths: schema: type: string format: int64 - /projects/{project}/zones/{zone}/instances/{instance}/referrers: - parameters: *ref_1 - 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 - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/compute - Oauth2c: - - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/InstanceListReferrers' - parameters: - - in: path - name: project - required: true - schema: - type: string - - in: path - name: zone - required: true - schema: - type: string - - in: path - name: instance - required: true - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: returnPartialSuccess - schema: - type: boolean - /projects/{project}/zones/{zone}/instances/{instance}: + /projects/{project}/zones/{zone}/reservations/{reservation}: parameters: *ref_1 get: - description: Returns the specified Instance resource. - operationId: compute.instances.get + description: Retrieves information about the specified reservation. + operationId: compute.reservations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -75718,7 +83045,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Instance' + $ref: '#/components/schemas/Reservation' parameters: - in: path name: project @@ -75731,15 +83058,13 @@ paths: schema: type: string - in: path - name: instance + name: reservation required: true schema: type: string delete: - description: >- - Deletes the specified Instance resource. For more information, see - Deleting an instance. - operationId: compute.instances.delete + description: Deletes the specified reservation. + operationId: compute.reservations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -75768,7 +83093,7 @@ paths: schema: type: string - in: path - name: instance + name: reservation required: true schema: type: string @@ -75776,17 +83101,14 @@ paths: name: requestId schema: type: string - 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 + patch: + description: Update share settings of the reservation. + operationId: compute.reservations.update requestBody: content: application/json: schema: - $ref: '#/components/schemas/Instance' + $ref: '#/components/schemas/Reservation' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -75815,72 +83137,35 @@ paths: schema: type: string - in: path - name: instance + name: reservation required: true schema: type: string - in: query - name: minimalAction - schema: - type: string - - in: query - name: mostDisruptiveAllowedAction + name: paths schema: type: string - in: query name: requestId schema: type: string - /projects/{project}/zones/{zone}/instances/{instance}/reset: - parameters: *ref_1 - 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 - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/compute - Oauth2c: - - https://www.googleapis.com/auth/compute - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: project - required: true - schema: - type: string - - in: path - name: zone - required: true - schema: - type: string - - in: path - name: instance - required: true - schema: - type: string - in: query - name: requestId + name: updateMask schema: type: string - /projects/{project}/zones/{zone}/instances/{instance}/simulateMaintenanceEvent: + format: google-fieldmask + /projects/{project}/zones/{zone}/reservations/{reservation}/resize: parameters: *ref_1 post: description: >- - Simulates a host maintenance event on a VM. For more information, see - Simulate a host maintenance event. - operationId: compute.instances.simulateMaintenanceEvent + Resizes the reservation (applicable to standalone reservations only). + For more information, read Modifying reservations. + operationId: compute.reservations.resize + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ReservationsResizeRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -75909,7 +83194,7 @@ paths: schema: type: string - in: path - name: instance + name: reservation required: true schema: type: string @@ -75917,15 +83202,13 @@ paths: name: requestId schema: type: string - - in: query - name: withExtendedNotifications - schema: - type: boolean - /projects/{project}/zones/{zone}/instances/{instance}/performMaintenance: + /projects/{project}/zones/{zone}/reservations/{resource}/getIamPolicy: parameters: *ref_1 - post: - description: Perform a manual maintenance on the instance. - operationId: compute.instances.performMaintenance + get: + description: >- + Gets the access control policy for a resource. May be empty if no such + policy or resource exists. + operationId: compute.reservations.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -75935,13 +83218,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Policy' parameters: - in: path name: project @@ -75954,24 +83241,27 @@ paths: schema: type: string - in: path - name: instance + name: resource required: true schema: type: string - in: query - name: requestId + name: optionsRequestedPolicyVersion schema: - type: string - /projects/{project}/zones/{zone}/instances/{instance}/addAccessConfig: + type: integer + format: int32 + /projects/{project}/zones/{zone}/reservations/{resource}/setIamPolicy: parameters: *ref_1 post: - description: Adds an access config to an instance's network interface. - operationId: compute.instances.addAccessConfig + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy. + operationId: compute.reservations.setIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/AccessConfig' + $ref: '#/components/schemas/ZoneSetPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -75987,7 +83277,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Policy' parameters: - in: path name: project @@ -76000,24 +83290,20 @@ paths: schema: type: string - in: path - name: instance - required: true - schema: - type: string - - in: query - name: networkInterface + name: resource required: true schema: type: string - - in: query - name: requestId - schema: - type: string - /projects/{project}/zones/{zone}/instances/{instance}/deleteAccessConfig: + /projects/{project}/zones/{zone}/reservations/{resource}/testIamPermissions: parameters: *ref_1 post: - description: Deletes an access config from an instance's network interface. - operationId: compute.instances.deleteAccessConfig + description: Returns permissions that a caller has on the specified resource. + operationId: compute.reservations.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -76027,13 +83313,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/TestPermissionsResponse' parameters: - in: path name: project @@ -76046,37 +83336,20 @@ paths: schema: type: string - in: path - name: instance - required: true - schema: - type: string - - in: query - name: accessConfig - required: true - schema: - type: string - - in: query - name: networkInterface + name: resource required: true schema: type: string - - in: query - name: requestId - schema: - type: string - /projects/{project}/zones/{zone}/instances/{instance}/updateAccessConfig: + /projects/{project}/zones/{zone}/reservations/{reservation}/performMaintenance: parameters: *ref_1 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 + description: Perform maintenance on an extended reservation + operationId: compute.reservations.performMaintenance requestBody: content: application/json: schema: - $ref: '#/components/schemas/AccessConfig' + $ref: '#/components/schemas/ReservationsPerformMaintenanceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -76105,12 +83378,7 @@ paths: schema: type: string - in: path - name: instance - required: true - schema: - type: string - - in: query - name: networkInterface + name: reservation required: true schema: type: string @@ -76118,21 +83386,14 @@ paths: name: requestId schema: type: string - /projects/{project}/zones/{zone}/instances/{instance}/updateNetworkInterface: + /projects/{project}/zones/{zone}/instanceGroups: parameters: *ref_1 - patch: + get: 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 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/NetworkInterface' + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -76142,13 +83403,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/InstanceGroupList' parameters: - in: path name: project @@ -76160,35 +83425,37 @@ paths: required: true schema: type: string - - in: path - name: instance - required: true + - in: query + name: filter schema: type: string - in: query - name: networkInterface - required: true + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy schema: type: string - in: query - name: requestId + name: pageToken schema: type: string - /projects/{project}/zones/{zone}/instances/{instance}/setScheduling: - parameters: *ref_1 + - in: query + name: returnPartialSuccess + schema: + type: boolean 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. For more information about setting scheduling options - for a VM, see Set VM host maintenance policy. - operationId: compute.instances.setScheduling + Creates an instance group in the specified project using the parameters + that are included in the request. + operationId: compute.instanceGroups.insert requestBody: content: application/json: schema: - $ref: '#/components/schemas/Scheduling' + $ref: '#/components/schemas/InstanceGroup' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -76216,20 +83483,18 @@ paths: required: true schema: type: string - - in: path - name: instance - required: true - schema: - type: string - in: query name: requestId schema: type: string - /projects/{project}/zones/{zone}/instances/{instance}/serialPort: + /projects/{project}/aggregated/instanceGroups: parameters: *ref_1 get: - description: Returns the last 1 MB of serial port output from the specified instance. - operationId: compute.instances.getSerialPortOutput + description: >- + Retrieves the list of instance groups and sorts them by zone. To prevent + failure, Google recommends that you set the `returnPartialSuccess` + parameter to `true`. + operationId: compute.instanceGroups.aggregatedList security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -76249,38 +83514,52 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SerialPortOutput' + $ref: '#/components/schemas/InstanceGroupAggregatedList' parameters: - in: path name: project required: true schema: type: string - - in: path - name: zone - required: true + - in: query + name: filter schema: type: string - - in: path - name: instance - required: true + - in: query + name: includeAllScopes schema: - type: string + type: boolean - in: query - name: port + name: maxResults schema: type: integer - format: int32 + format: uint32 - in: query - name: start + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean + - in: query + name: serviceProjectNumber schema: type: string format: int64 - /projects/{project}/zones/{zone}/instances/{instance}/screenshot: + /projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}: parameters: *ref_1 get: - description: Returns the screenshot from the specified instance. - operationId: compute.instances.getScreenshot + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -76300,40 +83579,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Screenshot' - parameters: - - in: path - name: project - required: true - schema: - type: string - - in: path - name: zone - required: true - schema: - type: string - - in: path - name: instance - required: true - schema: - type: string - /projects/{project}/zones/{zone}/instances/{instance}/sendDiagnosticInterrupt: - parameters: *ref_1 - post: - description: Sends diagnostic interrupt to the instance. - operationId: compute.instances.sendDiagnosticInterrupt - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/compute - Oauth2c: - - https://www.googleapis.com/auth/compute - responses: - '204': - description: No Content + $ref: '#/components/schemas/InstanceGroup' parameters: - in: path name: project @@ -76346,15 +83592,16 @@ paths: schema: type: string - in: path - name: instance + name: instanceGroup required: true schema: type: string - /projects/{project}/zones/{zone}/instances/{instance}/getGuestAttributes: - parameters: *ref_1 - get: - description: Returns the specified guest attributes entry. - operationId: compute.instances.getGuestAttributes + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -76364,17 +83611,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GuestAttributes' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -76387,32 +83630,27 @@ paths: schema: type: string - in: path - name: instance + name: instanceGroup required: true schema: type: string - in: query - name: queryPath - schema: - type: string - - in: query - name: variableKey + name: requestId schema: type: string - /projects/{project}/zones/{zone}/instances/{instance}/attachDisk: + /projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/addInstances: parameters: *ref_1 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 + 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 requestBody: content: application/json: schema: - $ref: '#/components/schemas/AttachedDisk' + $ref: '#/components/schemas/InstanceGroupsAddInstancesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -76441,23 +83679,29 @@ paths: schema: type: string - in: path - name: instance + name: instanceGroup required: true schema: type: string - - in: query - name: forceAttach - schema: - type: boolean - in: query name: requestId schema: type: string - /projects/{project}/zones/{zone}/instances/{instance}/detachDisk: + /projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/removeInstances: parameters: *ref_1 post: - description: Detaches a disk from an instance. - operationId: compute.instances.detachDisk + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceGroupsRemoveInstancesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -76486,12 +83730,7 @@ paths: schema: type: string - in: path - name: instance - required: true - schema: - type: string - - in: query - name: deviceName + name: instanceGroup required: true schema: type: string @@ -76499,18 +83738,20 @@ paths: name: requestId schema: type: string - /projects/{project}/zones/{zone}/instances/{instance}/setMachineResources: + /projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/listInstances: parameters: *ref_1 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 + Lists the instances in the specified instance group. The orderBy query + parameter is not supported. The filter query parameter is supported, but + only for expressions that use `eq` (equal) or `ne` (not equal) + operators. + operationId: compute.instanceGroups.listInstances requestBody: content: application/json: schema: - $ref: '#/components/schemas/InstancesSetMachineResourcesRequest' + $ref: '#/components/schemas/InstanceGroupsListInstancesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -76520,13 +83761,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/InstanceGroupsListInstances' parameters: - in: path name: project @@ -76539,26 +83784,41 @@ paths: schema: type: string - in: path - name: instance + name: instanceGroup required: true schema: type: string - in: query - name: requestId + name: filter schema: type: string - /projects/{project}/zones/{zone}/instances/{instance}/setMachineType: + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean + /projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/setNamedPorts: parameters: *ref_1 post: - description: >- - Changes the machine type for a stopped instance to the machine type - specified in the request. - operationId: compute.instances.setMachineType + description: Sets the named ports for the specified instance group. + operationId: compute.instanceGroups.setNamedPorts requestBody: content: application/json: schema: - $ref: '#/components/schemas/InstancesSetMachineTypeRequest' + $ref: '#/components/schemas/InstanceGroupsSetNamedPortsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -76587,7 +83847,7 @@ paths: schema: type: string - in: path - name: instance + name: instanceGroup required: true schema: type: string @@ -76595,18 +83855,13 @@ paths: name: requestId schema: type: string - /projects/{project}/zones/{zone}/instances/{instance}/setMetadata: + /projects/{project}/regions/{region}/instanceGroups: parameters: *ref_1 - post: + get: description: >- - Sets metadata for the specified instance to the data included in the - request. - operationId: compute.instances.setMetadata - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Metadata' + Retrieves the list of instance group resources contained within the + specified region. + operationId: compute.regionInstanceGroups.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -76616,13 +83871,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/RegionInstanceGroupList' parameters: - in: path name: project @@ -76630,32 +83889,36 @@ paths: schema: type: string - in: path - name: zone + name: region required: true schema: type: string - - in: path - name: instance - required: true + - in: query + name: filter schema: type: string - in: query - name: requestId + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy schema: type: string - /projects/{project}/zones/{zone}/instances/{instance}/setMinCpuPlatform: + - in: query + name: pageToken + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean + /projects/{project}/regions/{region}/instanceGroups/{instanceGroup}: parameters: *ref_1 - 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 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/InstancesSetMinCpuPlatformRequest' + get: + description: Returns the specified instance group resource. + operationId: compute.regionInstanceGroups.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -76665,13 +83928,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/InstanceGroup' parameters: - in: path name: project @@ -76679,31 +83946,29 @@ paths: schema: type: string - in: path - name: zone + name: region required: true schema: type: string - in: path - name: instance + name: instanceGroup required: true schema: type: string - - in: query - name: requestId - schema: - type: string - /projects/{project}/zones/{zone}/instances/{instance}/setTags: + /projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/listInstances: parameters: *ref_1 post: description: >- - Sets network tags for the specified instance to the data included in the - request. - operationId: compute.instances.setTags + 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 requestBody: content: application/json: schema: - $ref: '#/components/schemas/Tags' + $ref: '#/components/schemas/RegionInstanceGroupsListInstancesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -76713,13 +83978,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/RegionInstanceGroupsListInstances' parameters: - in: path name: project @@ -76727,31 +83996,46 @@ paths: schema: type: string - in: path - name: zone + name: region required: true schema: type: string - in: path - name: instance + name: instanceGroup required: true schema: type: string - in: query - name: requestId + name: filter schema: type: string - /projects/{project}/zones/{zone}/instances/{instance}/setLabels: + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean + /projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/setNamedPorts: parameters: *ref_1 post: - description: >- - Sets labels on an instance. To learn more about labels, read the - Labeling Resources documentation. - operationId: compute.instances.setLabels + description: Sets the named ports for the specified regional instance group. + operationId: compute.regionInstanceGroups.setNamedPorts requestBody: content: application/json: schema: - $ref: '#/components/schemas/InstancesSetLabelsRequest' + $ref: '#/components/schemas/RegionInstanceGroupsSetNamedPortsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -76775,12 +84059,12 @@ paths: schema: type: string - in: path - name: zone + name: region required: true schema: type: string - in: path - name: instance + name: instanceGroup required: true schema: type: string @@ -76788,16 +84072,13 @@ paths: name: requestId schema: type: string - /projects/{project}/zones/{zone}/instances/{instance}/setName: + /projects/{project}/zones/{zone}/instanceGroupManagers: parameters: *ref_1 - post: - description: Sets name of an instance. - operationId: compute.instances.setName - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/InstancesSetNameRequest' + get: + description: >- + Retrieves a list of managed instance groups that are contained within + the specified project and zone. + operationId: compute.instanceGroupManagers.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -76807,13 +84088,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/InstanceGroupManagerList' parameters: - in: path name: project @@ -76825,20 +84110,43 @@ paths: required: true schema: type: string - - in: path - name: instance - required: true + - in: query + name: filter schema: type: string - in: query - name: requestId + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy schema: type: string - /projects/{project}/zones/{zone}/instances/{instance}/setDiskAutoDelete: - parameters: *ref_1 + - in: query + name: pageToken + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean post: - description: Sets the auto-delete flag for a disk attached to an instance. - operationId: compute.instances.setDiskAutoDelete + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceGroupManager' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -76866,32 +84174,18 @@ paths: required: true schema: type: string - - in: path - name: instance - required: true - schema: - type: string - - in: query - name: autoDelete - required: true - schema: - type: boolean - - in: query - name: deviceName - required: true - schema: - type: string - in: query name: requestId schema: type: string - /projects/{project}/zones/{zone}/instances/{instance}/start: + /projects/{project}/aggregated/instanceGroupManagers: parameters: *ref_1 - post: + get: description: >- - Starts an instance that was stopped using the instances().stop method. - For more information, see Restart an instance. - operationId: compute.instances.start + Retrieves the list of managed instance groups and groups them by zone. + To prevent failure, Google recommends that you set the + `returnPartialSuccess` parameter to `true`. + operationId: compute.instanceGroupManagers.aggregatedList security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -76901,45 +84195,58 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/InstanceGroupManagerAggregatedList' parameters: - in: path name: project required: true schema: type: string - - in: path - name: zone - required: true + - in: query + name: filter schema: type: string - - in: path - name: instance - required: true + - in: query + name: includeAllScopes + schema: + type: boolean + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy schema: type: string - in: query - name: requestId + name: pageToken schema: type: string - /projects/{project}/zones/{zone}/instances/{instance}/startWithEncryptionKey: + - in: query + name: returnPartialSuccess + schema: + type: boolean + - in: query + name: serviceProjectNumber + schema: + type: string + format: int64 + /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}: parameters: *ref_1 - post: - description: >- - Starts an instance that was stopped using the instances().stop method. - For more information, see Restart an instance. - operationId: compute.instances.startWithEncryptionKey - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/InstancesStartWithEncryptionKeyRequest' + get: + description: Returns all of the details about the specified managed instance group. + operationId: compute.instanceGroupManagers.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -76949,13 +84256,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/InstanceGroupManager' parameters: - in: path name: project @@ -76968,25 +84279,29 @@ paths: schema: type: string - in: path - name: instance + name: instanceGroupManager required: true schema: type: string - - in: query - name: requestId - schema: - type: string - /projects/{project}/zones/{zone}/instances/{instance}/stop: - parameters: *ref_1 - post: + patch: 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 + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceGroupManager' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -77015,25 +84330,20 @@ paths: schema: type: string - in: path - name: instance + name: instanceGroupManager required: true schema: type: string - - in: query - name: discardLocalSsd - schema: - type: boolean - in: query name: requestId schema: type: string - /projects/{project}/zones/{zone}/instances/{resource}/getIamPolicy: - parameters: *ref_1 - get: + delete: description: >- - Gets the access control policy for a resource. May be empty if no such - policy or resource exists. - operationId: compute.instances.getIamPolicy + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -77043,17 +84353,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -77066,27 +84372,35 @@ paths: schema: type: string - in: path - name: resource + name: instanceGroupManager required: true schema: type: string - in: query - name: optionsRequestedPolicyVersion + name: requestId schema: - type: integer - format: int32 - /projects/{project}/zones/{zone}/instances/{resource}/setIamPolicy: + type: string + /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deleteInstances: parameters: *ref_1 post: description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. - operationId: compute.instances.setIamPolicy + 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 requestBody: content: application/json: schema: - $ref: '#/components/schemas/ZoneSetPolicyRequest' + $ref: '#/components/schemas/InstanceGroupManagersDeleteInstancesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -77102,7 +84416,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -77115,20 +84429,44 @@ paths: schema: type: string - in: path - name: resource + name: instanceGroupManager required: true schema: type: string - /projects/{project}/zones/{zone}/instances/{resource}/testIamPermissions: + - in: query + name: requestId + schema: + type: string + /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/suspendInstances: parameters: *ref_1 post: - description: Returns permissions that a caller has on the specified resource. - operationId: compute.instances.testIamPermissions + description: >- + Flags the specified instances in the managed instance group to be + immediately suspended. You can only specify instances that are running + in this request. This method reduces the targetSize and increases the + targetSuspendedSize of the managed instance group by the number of + instances that you suspend. The suspendInstances operation is marked + DONE if the suspendInstances request is successful. The underlying + actions take additional time. You must separately verify the status of + the SUSPENDING action with the listmanagedinstances method. If the + standbyPolicy.initialDelaySec field is set, the group delays suspension + of the instances until initialDelaySec have passed from + instance.creationTimestamp (that is, when the instance was created). + This delay gives your application time to set itself up and initialize + on the instance. If more than initialDelaySec seconds have passed since + instance.creationTimestamp when this method is called, there will be + zero delay. 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 suspended. + Suspended instances can be resumed using the resumeInstances method. You + can specify a maximum of 1000 instances with this method per request. + operationId: compute.instanceGroupManagers.suspendInstances requestBody: content: application/json: schema: - $ref: '#/components/schemas/TestPermissionsRequest' + $ref: >- + #/components/schemas/InstanceGroupManagersSuspendInstancesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -77138,17 +84476,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/TestPermissionsResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -77161,22 +84495,37 @@ paths: schema: type: string - in: path - name: resource + name: instanceGroupManager required: true schema: type: string - /projects/{project}/zones/{zone}/instances/{instance}/setServiceAccount: + - in: query + name: requestId + schema: + type: string + /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resumeInstances: parameters: *ref_1 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 + Flags the specified instances in the managed instance group to be + resumed. This method increases the targetSize and decreases the + targetSuspendedSize of the managed instance group by the number of + instances that you resume. The resumeInstances operation is marked DONE + if the resumeInstances request is successful. The underlying actions + take additional time. You must separately verify the status of the + RESUMING action with the listmanagedinstances method. In this request, + you can only specify instances that are suspended. For example, if an + instance was previously suspended using the suspendInstances method, it + can be resumed using the resumeInstances method. If a health check is + attached to the managed instance group, the specified instances will be + verified as healthy after they are resumed. You can specify a maximum of + 1000 instances with this method per request. + operationId: compute.instanceGroupManagers.resumeInstances requestBody: content: application/json: schema: - $ref: '#/components/schemas/InstancesSetServiceAccountRequest' + $ref: '#/components/schemas/InstanceGroupManagersResumeInstancesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -77205,7 +84554,7 @@ paths: schema: type: string - in: path - name: instance + name: instanceGroupManager required: true schema: type: string @@ -77213,11 +84562,35 @@ paths: name: requestId schema: type: string - /projects/{project}/zones/{zone}/instances/{resource}/setDeletionProtection: + /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/stopInstances: parameters: *ref_1 post: - description: Sets deletion protection on the instance. - operationId: compute.instances.setDeletionProtection + description: >- + Flags the specified instances in the managed instance group to be + immediately stopped. You can only specify instances that are running in + this request. This method reduces the targetSize and increases the + targetStoppedSize of the managed instance group by the number of + instances that you stop. The stopInstances operation is marked DONE if + the stopInstances request is successful. The underlying actions take + additional time. You must separately verify the status of the STOPPING + action with the listmanagedinstances method. If the + standbyPolicy.initialDelaySec field is set, the group delays stopping + the instances until initialDelaySec have passed from + instance.creationTimestamp (that is, when the instance was created). + This delay gives your application time to set itself up and initialize + on the instance. If more than initialDelaySec seconds have passed since + instance.creationTimestamp when this method is called, there will be + zero delay. 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 stopped. Stopped + instances can be started using the startInstances method. You can + specify a maximum of 1000 instances with this method per request. + operationId: compute.instanceGroupManagers.stopInstances + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceGroupManagersStopInstancesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -77246,31 +84619,37 @@ paths: schema: type: string - in: path - name: resource + name: instanceGroupManager required: true schema: type: string - - in: query - name: deletionProtection - schema: - type: boolean - in: query name: requestId schema: type: string - /projects/{project}/zones/{zone}/instances/{instance}/suspend: + /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/startInstances: parameters: *ref_1 post: description: >- - This method suspends a running instance, saving its state to persistent - storage, and allows you to resume the instance at a later time. - Suspended instances have no compute costs (cores or RAM), and incur only - storage charges for the saved VM memory and localSSD data. Any charged - resources the virtual machine was using, such as persistent disks and - static IP addresses, will continue to be charged while the instance is - suspended. For more information, see Suspending and resuming an - instance. - operationId: compute.instances.suspend + Flags the specified instances in the managed instance group to be + started. This method increases the targetSize and decreases the + targetStoppedSize of the managed instance group by the number of + instances that you start. The startInstances operation is marked DONE if + the startInstances request is successful. The underlying actions take + additional time. You must separately verify the status of the STARTING + action with the listmanagedinstances method. In this request, you can + only specify instances that are stopped. For example, if an instance was + previously stopped using the stopInstances method, it can be started + using the startInstances method. If a health check is attached to the + managed instance group, the specified instances will be verified as + healthy after they are started. You can specify a maximum of 1000 + instances with this method per request. + operationId: compute.instanceGroupManagers.startInstances + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceGroupManagersStartInstancesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -77299,25 +84678,38 @@ paths: schema: type: string - in: path - name: instance + name: instanceGroupManager required: true schema: type: string - - in: query - name: discardLocalSsd - schema: - type: boolean - in: query name: requestId schema: type: string - /projects/{project}/zones/{zone}/instances/{instance}/resume: + /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/abandonInstances: parameters: *ref_1 post: description: >- - Resumes an instance that was suspended using the instances().suspend - method. - operationId: compute.instances.resume + 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 + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/InstanceGroupManagersAbandonInstancesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -77346,7 +84738,7 @@ paths: schema: type: string - in: path - name: instance + name: instanceGroupManager required: true schema: type: string @@ -77354,19 +84746,28 @@ paths: name: requestId schema: type: string - /projects/{project}/zones/{zone}/instances/{instance}/addResourcePolicies: + /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/recreateInstances: parameters: *ref_1 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 + 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 requestBody: content: application/json: schema: - $ref: '#/components/schemas/InstancesAddResourcePoliciesRequest' + $ref: >- + #/components/schemas/InstanceGroupManagersRecreateInstancesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -77395,7 +84796,7 @@ paths: schema: type: string - in: path - name: instance + name: instanceGroupManager required: true schema: type: string @@ -77403,16 +84804,26 @@ paths: name: requestId schema: type: string - /projects/{project}/zones/{zone}/instances/{instance}/removeResourcePolicies: + /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resize: parameters: *ref_1 post: - description: Removes resource policies from an instance. - operationId: compute.instances.removeResourcePolicies - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/InstancesRemoveResourcePoliciesRequest' + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -77441,27 +84852,35 @@ paths: schema: type: string - in: path - name: instance + name: instanceGroupManager required: true schema: type: string + - in: query + name: size + required: true + schema: + type: integer + format: int32 - in: query name: requestId schema: type: string - /projects/{project}/zones/{zone}/instances/{instance}/updateShieldedInstanceConfig: + /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate: parameters: *ref_1 - patch: + post: 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 + 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 requestBody: content: application/json: schema: - $ref: '#/components/schemas/ShieldedInstanceConfig' + $ref: >- + #/components/schemas/InstanceGroupManagersSetInstanceTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -77490,7 +84909,7 @@ paths: schema: type: string - in: path - name: instance + name: instanceGroupManager required: true schema: type: string @@ -77498,19 +84917,22 @@ paths: name: requestId schema: type: string - /projects/{project}/zones/{zone}/instances/{instance}/updateDisplayDevice: + /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setTargetPools: parameters: *ref_1 - patch: + post: 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 + 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 requestBody: content: application/json: schema: - $ref: '#/components/schemas/DisplayDevice' + $ref: '#/components/schemas/InstanceGroupManagersSetTargetPoolsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -77539,7 +84961,7 @@ paths: schema: type: string - in: path - name: instance + name: instanceGroupManager required: true schema: type: string @@ -77547,19 +84969,19 @@ paths: name: requestId schema: type: string - /projects/{project}/zones/{zone}/instances/{instance}/setShieldedInstanceIntegrityPolicy: + /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances: parameters: *ref_1 - patch: + post: 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 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ShieldedInstanceIntegrityPolicy' + 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. The + `pageToken` query parameter is supported only if the group's + `listManagedInstancesResults` field is set to `PAGINATED`. + operationId: compute.instanceGroupManagers.listManagedInstances security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -77569,13 +84991,18 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: >- + #/components/schemas/InstanceGroupManagersListManagedInstancesResponse parameters: - in: path name: project @@ -77588,26 +85015,39 @@ paths: schema: type: string - in: path - name: instance + name: instanceGroupManager required: true schema: type: string - in: query - name: requestId + name: filter schema: type: string - /projects/{project}/zones/{zone}/instances/{instance}/setSecurityPolicy: + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean + /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listErrors: parameters: *ref_1 - post: + get: description: >- - Sets the Google Cloud Armor security policy for the specified instance. - For more information, see Google Cloud Armor Overview - operationId: compute.instances.setSecurityPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/InstancesSetSecurityPolicyRequest' + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -77617,13 +85057,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/InstanceGroupManagersListErrorsResponse' parameters: - in: path name: project @@ -77636,19 +85080,38 @@ paths: schema: type: string - in: path - name: instance + name: instanceGroupManager required: true schema: type: string - in: query - name: requestId + name: filter schema: type: string - /projects/{project}/zones/{zone}/instances/{instance}/getShieldedInstanceIdentity: + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean + /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs: parameters: *ref_1 - get: - description: Returns the Shielded Instance Identity of an instance - operationId: compute.instances.getShieldedInstanceIdentity + post: + description: >- + Lists all of the per-instance configurations defined for the managed + instance group. The orderBy query parameter is not supported. + operationId: compute.instanceGroupManagers.listPerInstanceConfigs security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -77668,7 +85131,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ShieldedInstanceIdentity' + $ref: >- + #/components/schemas/InstanceGroupManagersListPerInstanceConfigsResp parameters: - in: path name: project @@ -77681,22 +85145,45 @@ paths: schema: type: string - in: path - name: instance + name: instanceGroupManager required: true schema: type: string - /projects/{project}/zones/{zone}/instances/bulkInsert: + - in: query + name: filter + schema: + type: string + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean + /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs: parameters: *ref_1 post: description: >- - Creates multiple instances. Count specifies the number of instances to - create. For more information, see About bulk creation of VMs. - operationId: compute.instances.bulkInsert + Inserts or updates per-instance configurations for the managed instance + group. perInstanceConfig.name serves as a key used to distinguish + whether to perform insert or patch. + operationId: compute.instanceGroupManagers.updatePerInstanceConfigs requestBody: content: application/json: schema: - $ref: '#/components/schemas/BulkInsertInstanceResource' + $ref: >- + #/components/schemas/InstanceGroupManagersUpdatePerInstanceConfigsReq security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -77724,15 +85211,29 @@ paths: required: true schema: type: string + - in: path + name: instanceGroupManager + required: true + schema: + type: string - in: query name: requestId schema: type: string - /projects/{project}/zones/{zone}/instances/{instance}/getEffectiveFirewalls: + /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs: parameters: *ref_1 - get: - description: Returns effective firewalls applied to an interface of the instance. - operationId: compute.instances.getEffectiveFirewalls + post: + description: >- + Inserts or patches per-instance configurations for the managed instance + group. perInstanceConfig.name serves as a key used to distinguish + whether to perform insert or patch. + operationId: compute.instanceGroupManagers.patchPerInstanceConfigs + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/InstanceGroupManagersPatchPerInstanceConfigsReq security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -77742,17 +85243,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/InstancesGetEffectiveFirewallsResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -77765,27 +85262,27 @@ paths: schema: type: string - in: path - name: instance + name: instanceGroupManager required: true schema: type: string - in: query - name: networkInterface - required: true + name: requestId schema: type: string - /projects/{project}/regions/{region}/instances/bulkInsert: + /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs: parameters: *ref_1 post: description: >- - Creates multiple instances in a given region. Count specifies the number - of instances to create. - operationId: compute.regionInstances.bulkInsert + Deletes selected per-instance configurations for the managed instance + group. + operationId: compute.instanceGroupManagers.deletePerInstanceConfigs requestBody: content: application/json: schema: - $ref: '#/components/schemas/BulkInsertInstanceResource' + $ref: >- + #/components/schemas/InstanceGroupManagersDeletePerInstanceConfigsReq security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -77809,21 +85306,27 @@ paths: schema: type: string - in: path - name: region + name: zone required: true schema: type: string - - in: query - name: requestId + - in: path + name: instanceGroupManager + required: true schema: type: string - /projects/{project}/zones/{zone}/reservations: + /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances: parameters: *ref_1 - get: + post: description: >- - A list of all the reservations that have been configured for the - specified project in specified zone. - operationId: compute.reservations.list + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceGroupManagersApplyUpdatesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -77833,17 +85336,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/ReservationList' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -77855,37 +85354,27 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken + - in: path + name: instanceGroupManager + required: true schema: type: string - - in: query - name: returnPartialSuccess - schema: - type: boolean + /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/createInstances: + parameters: *ref_1 post: description: >- - Creates a new reservation. For more information, read Reserving zonal - resources. - operationId: compute.reservations.insert + Creates instances with per-instance configurations 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 requestBody: content: application/json: schema: - $ref: '#/components/schemas/Reservation' + $ref: '#/components/schemas/InstanceGroupManagersCreateInstancesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -77913,17 +85402,20 @@ paths: required: true schema: type: string + - in: path + name: instanceGroupManager + required: true + schema: + type: string - in: query name: requestId schema: type: string - /projects/{project}/aggregated/reservations: + /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}: parameters: *ref_1 get: - description: >- - Retrieves an aggregated list of reservations. To prevent failure, Google - recommends that you set the `returnPartialSuccess` parameter to `true`. - operationId: compute.reservations.aggregatedList + description: Returns all of the details about the specified resize request. + operationId: compute.instanceGroupManagerResizeRequests.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -77943,48 +85435,34 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ReservationAggregatedList' + $ref: '#/components/schemas/InstanceGroupManagerResizeRequest' parameters: - in: path name: project required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: includeAllScopes - schema: - type: boolean - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy + - in: path + name: zone + required: true schema: type: string - - in: query - name: pageToken + - in: path + name: instanceGroupManager + required: true schema: type: string - - in: query - name: returnPartialSuccess - schema: - type: boolean - - in: query - name: serviceProjectNumber + - in: path + name: resizeRequest + required: true schema: type: string - format: int64 - /projects/{project}/zones/{zone}/reservations/{reservation}: - parameters: *ref_1 - get: - description: Retrieves information about the specified reservation. - operationId: compute.reservations.get + delete: + description: >- + Deletes the specified, inactive resize request. Requests that are still + active cannot be deleted. Deleting request does not delete instances + that were provisioned previously. + operationId: compute.instanceGroupManagerResizeRequests.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -77994,17 +85472,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Reservation' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -78017,13 +85491,31 @@ paths: schema: type: string - in: path - name: reservation + name: instanceGroupManager required: true schema: type: string - delete: - description: Deletes the specified reservation. - operationId: compute.reservations.delete + - in: path + name: resizeRequest + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests: + parameters: *ref_1 + post: + description: >- + Creates a new resize request that starts provisioning VMs immediately or + queues VM creation. + operationId: compute.instanceGroupManagerResizeRequests.insert + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceGroupManagerResizeRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -78052,7 +85544,7 @@ paths: schema: type: string - in: path - name: reservation + name: instanceGroupManager required: true schema: type: string @@ -78060,14 +85552,11 @@ paths: name: requestId schema: type: string - patch: - description: Update share settings of the reservation. - operationId: compute.reservations.update - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Reservation' + get: + description: >- + Retrieves a list of resize requests that are contained in the managed + instance group. + operationId: compute.instanceGroupManagerResizeRequests.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -78077,13 +85566,18 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: >- + #/components/schemas/InstanceGroupManagerResizeRequestsListResponse parameters: - in: path name: project @@ -78096,35 +85590,40 @@ paths: schema: type: string - in: path - name: reservation + name: instanceGroupManager required: true schema: type: string - in: query - name: paths + name: filter schema: type: string - in: query - name: requestId + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy schema: type: string - in: query - name: updateMask + name: pageToken schema: type: string - format: google-fieldmask - /projects/{project}/zones/{zone}/reservations/{reservation}/resize: + - in: query + name: returnPartialSuccess + schema: + type: boolean + /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}/cancel: parameters: *ref_1 post: description: >- - Resizes the reservation (applicable to standalone reservations only). - For more information, read Modifying reservations. - operationId: compute.reservations.resize - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ReservationsResizeRequest' + Cancels the specified resize request and removes it from the queue. + Cancelled resize request does no longer wait for the resources to be + provisioned. Cancel is only possible for requests that are accepted in + the queue. + operationId: compute.instanceGroupManagerResizeRequests.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -78153,7 +85652,12 @@ paths: schema: type: string - in: path - name: reservation + name: instanceGroupManager + required: true + schema: + type: string + - in: path + name: resizeRequest required: true schema: type: string @@ -78161,13 +85665,13 @@ paths: name: requestId schema: type: string - /projects/{project}/zones/{zone}/reservations/{resource}/getIamPolicy: + /projects/{project}/regions/{region}/instanceGroupManagers: parameters: *ref_1 get: description: >- - Gets the access control policy for a resource. May be empty if no such - policy or resource exists. - operationId: compute.reservations.getIamPolicy + Retrieves the list of managed instance groups that are contained within + the specified region. + operationId: compute.regionInstanceGroupManagers.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -78187,7 +85691,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/RegionInstanceGroupManagerList' parameters: - in: path name: project @@ -78195,74 +85699,46 @@ paths: schema: type: string - in: path - name: zone + name: region required: true schema: type: string - - in: path - name: resource - required: true + - in: query + name: filter schema: type: string - in: query - name: optionsRequestedPolicyVersion + name: maxResults schema: type: integer - format: int32 - /projects/{project}/zones/{zone}/reservations/{resource}/setIamPolicy: - parameters: *ref_1 - post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. - operationId: compute.reservations.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ZoneSetPolicyRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/compute - Oauth2c: - - https://www.googleapis.com/auth/compute - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Policy' - parameters: - - in: path - name: project - required: true + format: uint32 + - in: query + name: orderBy schema: type: string - - in: path - name: zone - required: true + - in: query + name: pageToken schema: type: string - - in: path - name: resource - required: true + - in: query + name: returnPartialSuccess schema: - type: string - /projects/{project}/zones/{zone}/reservations/{resource}/testIamPermissions: - parameters: *ref_1 + type: boolean post: - description: Returns permissions that a caller has on the specified resource. - operationId: compute.reservations.testIamPermissions + 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 requestBody: content: application/json: schema: - $ref: '#/components/schemas/TestPermissionsRequest' + $ref: '#/components/schemas/InstanceGroupManager' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -78272,17 +85748,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/TestPermissionsResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -78290,23 +85762,19 @@ paths: schema: type: string - in: path - name: zone + name: region required: true schema: type: string - - in: path - name: resource - required: true + - in: query + name: requestId schema: type: string - /projects/{project}/zones/{zone}/instanceGroups: + /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}: parameters: *ref_1 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 + description: Returns all of the details about the specified managed instance group. + operationId: compute.regionInstanceGroupManagers.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -78326,7 +85794,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InstanceGroupList' + $ref: '#/components/schemas/InstanceGroupManager' parameters: - in: path name: project @@ -78334,41 +85802,34 @@ paths: schema: type: string - in: path - name: zone + name: region required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken + - in: path + name: instanceGroupManager + required: true schema: type: string - - in: query - name: returnPartialSuccess - schema: - type: boolean - post: + patch: description: >- - Creates an instance group in the specified project using the parameters - that are included in the request. - operationId: compute.instanceGroups.insert + 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 requestBody: content: application/json: schema: - $ref: '#/components/schemas/InstanceGroup' + $ref: '#/components/schemas/InstanceGroupManager' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -78392,7 +85853,12 @@ paths: schema: type: string - in: path - name: zone + name: region + required: true + schema: + type: string + - in: path + name: instanceGroupManager required: true schema: type: string @@ -78400,14 +85866,11 @@ paths: name: requestId schema: type: string - /projects/{project}/aggregated/instanceGroups: - parameters: *ref_1 - get: + delete: description: >- - Retrieves the list of instance groups and sorts them by zone. To prevent - failure, Google recommends that you set the `returnPartialSuccess` - parameter to `true`. - operationId: compute.instanceGroups.aggregatedList + Deletes the specified managed instance group and all of the instances in + that group. + operationId: compute.regionInstanceGroupManagers.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -78417,62 +85880,56 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/InstanceGroupAggregatedList' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: includeAllScopes - schema: - type: boolean - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy + - in: path + name: region + required: true schema: type: string - - in: query - name: pageToken + - in: path + name: instanceGroupManager + required: true schema: type: string - in: query - name: returnPartialSuccess - schema: - type: boolean - - in: query - name: serviceProjectNumber + name: requestId schema: type: string - format: int64 - /projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}: + /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deleteInstances: parameters: *ref_1 - get: + post: 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 + 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 + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/RegionInstanceGroupManagersDeleteInstancesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -78482,17 +85939,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/InstanceGroup' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -78500,21 +85953,49 @@ paths: schema: type: string - in: path - name: zone + name: region required: true schema: type: string - in: path - name: instanceGroup + name: instanceGroupManager required: true schema: type: string - delete: + - in: query + name: requestId + schema: + type: string + /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/suspendInstances: + parameters: *ref_1 + post: 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 + Flags the specified instances in the managed instance group to be + immediately suspended. You can only specify instances that are running + in this request. This method reduces the targetSize and increases the + targetSuspendedSize of the managed instance group by the number of + instances that you suspend. The suspendInstances operation is marked + DONE if the suspendInstances request is successful. The underlying + actions take additional time. You must separately verify the status of + the SUSPENDING action with the listmanagedinstances method. If the + standbyPolicy.initialDelaySec field is set, the group delays suspension + of the instances until initialDelaySec have passed from + instance.creationTimestamp (that is, when the instance was created). + This delay gives your application time to set itself up and initialize + on the instance. If more than initialDelaySec seconds have passed since + instance.creationTimestamp when this method is called, there will be + zero delay. 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 suspended. + Suspended instances can be resumed using the resumeInstances method. You + can specify a maximum of 1000 instances with this method per request. + operationId: compute.regionInstanceGroupManagers.suspendInstances + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/RegionInstanceGroupManagersSuspendInstancesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -78538,12 +86019,12 @@ paths: schema: type: string - in: path - name: zone + name: region required: true schema: type: string - in: path - name: instanceGroup + name: instanceGroupManager required: true schema: type: string @@ -78551,19 +86032,30 @@ paths: name: requestId schema: type: string - /projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/addInstances: + /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resumeInstances: parameters: *ref_1 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 + Flags the specified instances in the managed instance group to be + resumed. This method increases the targetSize and decreases the + targetSuspendedSize of the managed instance group by the number of + instances that you resume. The resumeInstances operation is marked DONE + if the resumeInstances request is successful. The underlying actions + take additional time. You must separately verify the status of the + RESUMING action with the listmanagedinstances method. In this request, + you can only specify instances that are suspended. For example, if an + instance was previously suspended using the suspendInstances method, it + can be resumed using the resumeInstances method. If a health check is + attached to the managed instance group, the specified instances will be + verified as healthy after they are resumed. You can specify a maximum of + 1000 instances with this method per request. + operationId: compute.regionInstanceGroupManagers.resumeInstances requestBody: content: application/json: schema: - $ref: '#/components/schemas/InstanceGroupsAddInstancesRequest' + $ref: >- + #/components/schemas/RegionInstanceGroupManagersResumeInstancesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -78587,12 +86079,12 @@ paths: schema: type: string - in: path - name: zone + name: region required: true schema: type: string - in: path - name: instanceGroup + name: instanceGroupManager required: true schema: type: string @@ -78600,21 +86092,36 @@ paths: name: requestId schema: type: string - /projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/removeInstances: + /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/stopInstances: parameters: *ref_1 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 + Flags the specified instances in the managed instance group to be + immediately stopped. You can only specify instances that are running in + this request. This method reduces the targetSize and increases the + targetStoppedSize of the managed instance group by the number of + instances that you stop. The stopInstances operation is marked DONE if + the stopInstances request is successful. The underlying actions take + additional time. You must separately verify the status of the STOPPING + action with the listmanagedinstances method. If the + standbyPolicy.initialDelaySec field is set, the group delays stopping + the instances until initialDelaySec have passed from + instance.creationTimestamp (that is, when the instance was created). + This delay gives your application time to set itself up and initialize + on the instance. If more than initialDelaySec seconds have passed since + instance.creationTimestamp when this method is called, there will be + zero delay. 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 stopped. Stopped + instances can be started using the startInstances method. You can + specify a maximum of 1000 instances with this method per request. + operationId: compute.regionInstanceGroupManagers.stopInstances requestBody: content: application/json: schema: - $ref: '#/components/schemas/InstanceGroupsRemoveInstancesRequest' + $ref: >- + #/components/schemas/RegionInstanceGroupManagersStopInstancesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -78638,12 +86145,12 @@ paths: schema: type: string - in: path - name: zone + name: region required: true schema: type: string - in: path - name: instanceGroup + name: instanceGroupManager required: true schema: type: string @@ -78651,20 +86158,30 @@ paths: name: requestId schema: type: string - /projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/listInstances: + /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/startInstances: parameters: *ref_1 post: description: >- - Lists the instances in the specified instance group. The orderBy query - parameter is not supported. The filter query parameter is supported, but - only for expressions that use `eq` (equal) or `ne` (not equal) - operators. - operationId: compute.instanceGroups.listInstances + Flags the specified instances in the managed instance group to be + started. This method increases the targetSize and decreases the + targetStoppedSize of the managed instance group by the number of + instances that you start. The startInstances operation is marked DONE if + the startInstances request is successful. The underlying actions take + additional time. You must separately verify the status of the STARTING + action with the listmanagedinstances method. In this request, you can + only specify instances that are stopped. For example, if an instance was + previously stopped using the stopInstances method, it can be started + using the startInstances method. If a health check is attached to the + managed instance group, the specified instances will be verified as + healthy after they are started. You can specify a maximum of 1000 + instances with this method per request. + operationId: compute.regionInstanceGroupManagers.startInstances requestBody: content: application/json: schema: - $ref: '#/components/schemas/InstanceGroupsListInstancesRequest' + $ref: >- + #/components/schemas/RegionInstanceGroupManagersStartInstancesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -78674,17 +86191,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/InstanceGroupsListInstances' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -78692,46 +86205,43 @@ paths: schema: type: string - in: path - name: zone + name: region required: true schema: type: string - in: path - name: instanceGroup + name: instanceGroupManager required: true schema: type: string - in: query - name: filter - schema: - type: string - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken + name: requestId schema: type: string - - in: query - name: returnPartialSuccess - schema: - type: boolean - /projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/setNamedPorts: + /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/abandonInstances: parameters: *ref_1 post: - description: Sets the named ports for the specified instance group. - operationId: compute.instanceGroups.setNamedPorts + 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 requestBody: content: application/json: schema: - $ref: '#/components/schemas/InstanceGroupsSetNamedPortsRequest' + $ref: >- + #/components/schemas/RegionInstanceGroupManagersAbandonInstancesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -78755,12 +86265,12 @@ paths: schema: type: string - in: path - name: zone + name: region required: true schema: type: string - in: path - name: instanceGroup + name: instanceGroupManager required: true schema: type: string @@ -78768,13 +86278,27 @@ paths: name: requestId schema: type: string - /projects/{project}/regions/{region}/instanceGroups: + /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/recreateInstances: parameters: *ref_1 - get: + post: description: >- - Retrieves the list of instance group resources contained within the - specified region. - operationId: compute.regionInstanceGroups.list + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RegionInstanceGroupManagersRecreateRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -78784,17 +86308,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/RegionInstanceGroupList' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -78806,32 +86326,30 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy + - in: path + name: instanceGroupManager + required: true schema: type: string - in: query - name: pageToken + name: requestId schema: type: string - - in: query - name: returnPartialSuccess - schema: - type: boolean - /projects/{project}/regions/{region}/instanceGroups/{instanceGroup}: + /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resize: parameters: *ref_1 - get: - description: Returns the specified instance group resource. - operationId: compute.regionInstanceGroups.get + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -78841,17 +86359,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/InstanceGroup' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -78864,24 +86378,33 @@ paths: schema: type: string - in: path - name: instanceGroup + name: instanceGroupManager required: true schema: type: string - /projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/listInstances: + - in: query + name: size + required: true + schema: + type: integer + format: int32 + - in: query + name: requestId + schema: + type: string + /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate: parameters: *ref_1 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 + 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 requestBody: content: application/json: schema: - $ref: '#/components/schemas/RegionInstanceGroupsListInstancesRequest' + $ref: >- + #/components/schemas/RegionInstanceGroupManagersSetTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -78891,17 +86414,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/RegionInstanceGroupsListInstances' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -78914,41 +86433,27 @@ paths: schema: type: string - in: path - name: instanceGroup + name: instanceGroupManager required: true schema: type: string - in: query - name: filter - schema: - type: string - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken + name: requestId schema: type: string - - in: query - name: returnPartialSuccess - schema: - type: boolean - /projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/setNamedPorts: + /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setTargetPools: parameters: *ref_1 post: - description: Sets the named ports for the specified regional instance group. - operationId: compute.regionInstanceGroups.setNamedPorts + 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 requestBody: content: application/json: schema: - $ref: '#/components/schemas/RegionInstanceGroupsSetNamedPortsRequest' + $ref: >- + #/components/schemas/RegionInstanceGroupManagersSetTargetPoolsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -78977,7 +86482,7 @@ paths: schema: type: string - in: path - name: instanceGroup + name: instanceGroupManager required: true schema: type: string @@ -78985,13 +86490,16 @@ paths: name: requestId schema: type: string - /projects/{project}/zones/{zone}/instanceGroupManagers: + /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances: parameters: *ref_1 - get: + post: description: >- - Retrieves a list of managed instance groups that are contained within - the specified project and zone. - operationId: compute.instanceGroupManagers.list + 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. The `pageToken` query parameter is supported only if the + group's `listManagedInstancesResults` field is set to `PAGINATED`. + operationId: compute.regionInstanceGroupManagers.listManagedInstances security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -79011,7 +86519,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InstanceGroupManagerList' + $ref: >- + #/components/schemas/RegionInstanceGroupManagersListInstancesResponse parameters: - in: path name: project @@ -79019,7 +86528,12 @@ paths: schema: type: string - in: path - name: zone + name: region + required: true + schema: + type: string + - in: path + name: instanceGroupManager required: true schema: type: string @@ -79044,22 +86558,14 @@ paths: name: returnPartialSuccess schema: type: boolean - post: + /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listErrors: + parameters: *ref_1 + get: 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 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/InstanceGroupManager' + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -79069,13 +86575,18 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: >- + #/components/schemas/RegionInstanceGroupManagersListErrorsResponse parameters: - in: path name: project @@ -79083,22 +86594,43 @@ paths: schema: type: string - in: path - name: zone + name: region + required: true + schema: + type: string + - in: path + name: instanceGroupManager required: true schema: type: string - in: query - name: requestId + name: filter schema: type: string - /projects/{project}/aggregated/instanceGroupManagers: + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean + /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs: parameters: *ref_1 - get: + post: description: >- - Retrieves the list of managed instance groups and groups them by zone. - To prevent failure, Google recommends that you set the - `returnPartialSuccess` parameter to `true`. - operationId: compute.instanceGroupManagers.aggregatedList + Lists all of the per-instance configurations defined for the managed + instance group. The orderBy query parameter is not supported. + operationId: compute.regionInstanceGroupManagers.listPerInstanceConfigs security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -79118,21 +86650,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InstanceGroupManagerAggregatedList' + $ref: >- + #/components/schemas/RegionInstanceGroupManagersListInstanceConfigsResp parameters: - in: path name: project required: true schema: type: string - - in: query - name: filter + - in: path + name: region + required: true + schema: + type: string + - in: path + name: instanceGroupManager + required: true schema: type: string - in: query - name: includeAllScopes + name: filter schema: - type: boolean + type: string - in: query name: maxResults schema: @@ -79150,16 +86689,20 @@ paths: name: returnPartialSuccess schema: type: boolean - - in: query - name: serviceProjectNumber - schema: - type: string - format: int64 - /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}: + /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs: parameters: *ref_1 - get: - description: Returns all of the details about the specified managed instance group. - operationId: compute.instanceGroupManagers.get + post: + description: >- + Inserts or updates per-instance configurations for the managed instance + group. perInstanceConfig.name serves as a key used to distinguish + whether to perform insert or patch. + operationId: compute.regionInstanceGroupManagers.updatePerInstanceConfigs + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/RegionInstanceGroupManagerUpdateInstanceConfigReq security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -79169,17 +86712,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/InstanceGroupManager' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -79187,7 +86726,7 @@ paths: schema: type: string - in: path - name: zone + name: region required: true schema: type: string @@ -79196,25 +86735,24 @@ paths: required: true schema: type: string - patch: + - in: query + name: requestId + schema: + type: string + /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs: + parameters: *ref_1 + post: 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 + Inserts or patches per-instance configurations for the managed instance + group. perInstanceConfig.name serves as a key used to distinguish + whether to perform insert or patch. + operationId: compute.regionInstanceGroupManagers.patchPerInstanceConfigs requestBody: content: application/json: schema: - $ref: '#/components/schemas/InstanceGroupManager' + $ref: >- + #/components/schemas/RegionInstanceGroupManagerPatchInstanceConfigReq security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -79238,7 +86776,7 @@ paths: schema: type: string - in: path - name: zone + name: region required: true schema: type: string @@ -79251,12 +86789,19 @@ paths: name: requestId schema: type: string - delete: + /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs: + parameters: *ref_1 + post: 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 + Deletes selected per-instance configurations for the managed instance + group. + operationId: compute.regionInstanceGroupManagers.deletePerInstanceConfigs + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/RegionInstanceGroupManagerDeleteInstanceConfigReq security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -79280,7 +86825,7 @@ paths: schema: type: string - in: path - name: zone + name: region required: true schema: type: string @@ -79289,31 +86834,17 @@ paths: required: true schema: type: string - - in: query - name: requestId - schema: - type: string - /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deleteInstances: + /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances: parameters: *ref_1 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 + description: Apply updates to selected instances the managed instance group. + operationId: compute.regionInstanceGroupManagers.applyUpdatesToInstances requestBody: content: application/json: schema: - $ref: '#/components/schemas/InstanceGroupManagersDeleteInstancesRequest' + $ref: >- + #/components/schemas/RegionInstanceGroupManagersApplyUpdatesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -79337,7 +86868,7 @@ paths: schema: type: string - in: path - name: zone + name: region required: true schema: type: string @@ -79346,34 +86877,23 @@ paths: required: true schema: type: string - - in: query - name: requestId - schema: - type: string - /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/abandonInstances: + /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/createInstances: parameters: *ref_1 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 + Creates instances with per-instance configurations 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 requestBody: content: application/json: schema: $ref: >- - #/components/schemas/InstanceGroupManagersAbandonInstancesRequest + #/components/schemas/RegionInstanceGroupManagersCreateInstancesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -79397,7 +86917,7 @@ paths: schema: type: string - in: path - name: zone + name: region required: true schema: type: string @@ -79410,28 +86930,11 @@ paths: name: requestId schema: type: string - /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/recreateInstances: + /projects/{project}/zones/{zone}/autoscalers: parameters: *ref_1 - 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 - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/InstanceGroupManagersRecreateInstancesRequest + get: + description: Retrieves a list of autoscalers contained within the specified zone. + operationId: compute.autoscalers.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -79441,13 +86944,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/AutoscalerList' parameters: - in: path name: project @@ -79459,35 +86966,37 @@ paths: required: true schema: type: string - - in: path - name: instanceGroupManager - required: true + - in: query + name: filter schema: type: string - in: query - name: requestId + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy schema: type: string - /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resize: - parameters: *ref_1 + - in: query + name: pageToken + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean 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 + Creates an autoscaler in the specified project using the data included + in the request. + operationId: compute.autoscalers.insert + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Autoscaler' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -79515,36 +87024,20 @@ paths: required: true schema: type: string - - in: path - name: instanceGroupManager - required: true - schema: - type: string - - in: query - name: size - required: true - schema: - type: integer - format: int32 - in: query name: requestId schema: type: string - /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate: - parameters: *ref_1 - post: + put: 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 + Updates an autoscaler in the specified project using the data included + in the request. + operationId: compute.autoscalers.update requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/InstanceGroupManagersSetInstanceTemplateRequest + $ref: '#/components/schemas/Autoscaler' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -79572,31 +87065,25 @@ paths: required: true schema: type: string - - in: path - name: instanceGroupManager - required: true + - in: query + name: autoscaler schema: type: string - in: query name: requestId schema: type: string - /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setTargetPools: - parameters: *ref_1 - post: + patch: 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 + 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 requestBody: content: application/json: schema: - $ref: '#/components/schemas/InstanceGroupManagersSetTargetPoolsRequest' + $ref: '#/components/schemas/Autoscaler' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -79624,28 +87111,21 @@ paths: required: true schema: type: string - - in: path - name: instanceGroupManager - required: true + - in: query + name: autoscaler schema: type: string - in: query name: requestId schema: type: string - /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances: + /projects/{project}/aggregated/autoscalers: parameters: *ref_1 - post: + get: 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. The - `pageToken` query parameter is supported only if the group's - `listManagedInstancesResults` field is set to `PAGINATED`. - operationId: compute.instanceGroupManagers.listManagedInstances + Retrieves an aggregated list of autoscalers. To prevent failure, Google + recommends that you set the `returnPartialSuccess` parameter to `true`. + operationId: compute.autoscalers.aggregatedList security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -79665,28 +87145,21 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/InstanceGroupManagersListManagedInstancesResponse + $ref: '#/components/schemas/AutoscalerAggregatedList' parameters: - in: path name: project required: true schema: type: string - - in: path - name: zone - required: true - schema: - type: string - - in: path - name: instanceGroupManager - required: true - schema: - type: string - in: query name: filter schema: type: string + - in: query + name: includeAllScopes + schema: + type: boolean - in: query name: maxResults schema: @@ -79704,14 +87177,16 @@ paths: name: returnPartialSuccess schema: type: boolean - /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listErrors: + - in: query + name: serviceProjectNumber + schema: + type: string + format: int64 + /projects/{project}/zones/{zone}/autoscalers/{autoscaler}: parameters: *ref_1 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 + description: Returns the specified autoscaler resource. + operationId: compute.autoscalers.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -79731,7 +87206,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InstanceGroupManagersListErrorsResponse' + $ref: '#/components/schemas/Autoscaler' parameters: - in: path name: project @@ -79744,38 +87219,54 @@ paths: schema: type: string - in: path - name: instanceGroupManager + name: autoscaler required: true schema: type: string - - in: query - name: filter + delete: + description: Deletes the specified autoscaler. + operationId: compute.autoscalers.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: project + required: true schema: type: string - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy + - in: path + name: zone + required: true schema: type: string - - in: query - name: pageToken + - in: path + name: autoscaler + required: true schema: type: string - in: query - name: returnPartialSuccess + name: requestId schema: - type: boolean - /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs: + type: string + /projects/{project}/regions/{region}/autoscalers: parameters: *ref_1 - post: - description: >- - Lists all of the per-instance configurations defined for the managed - instance group. The orderBy query parameter is not supported. - operationId: compute.instanceGroupManagers.listPerInstanceConfigs + get: + description: Retrieves a list of autoscalers contained within the specified region. + operationId: compute.regionAutoscalers.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -79795,8 +87286,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/InstanceGroupManagersListPerInstanceConfigsResp + $ref: '#/components/schemas/RegionAutoscalerList' parameters: - in: path name: project @@ -79804,12 +87294,7 @@ paths: schema: type: string - in: path - name: zone - required: true - schema: - type: string - - in: path - name: instanceGroupManager + name: region required: true schema: type: string @@ -79834,20 +87319,16 @@ paths: name: returnPartialSuccess schema: type: boolean - /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs: - parameters: *ref_1 post: description: >- - Inserts or updates per-instance configurations for the managed instance - group. perInstanceConfig.name serves as a key used to distinguish - whether to perform insert or patch. - operationId: compute.instanceGroupManagers.updatePerInstanceConfigs + Creates an autoscaler in the specified project using the data included + in the request. + operationId: compute.regionAutoscalers.insert requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/InstanceGroupManagersUpdatePerInstanceConfigsReq + $ref: '#/components/schemas/Autoscaler' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -79871,12 +87352,7 @@ paths: schema: type: string - in: path - name: zone - required: true - schema: - type: string - - in: path - name: instanceGroupManager + name: region required: true schema: type: string @@ -79884,20 +87360,16 @@ paths: name: requestId schema: type: string - /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs: - parameters: *ref_1 - post: + put: description: >- - Inserts or patches per-instance configurations for the managed instance - group. perInstanceConfig.name serves as a key used to distinguish - whether to perform insert or patch. - operationId: compute.instanceGroupManagers.patchPerInstanceConfigs + Updates an autoscaler in the specified project using the data included + in the request. + operationId: compute.regionAutoscalers.update requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/InstanceGroupManagersPatchPerInstanceConfigsReq + $ref: '#/components/schemas/Autoscaler' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -79921,32 +87393,29 @@ paths: schema: type: string - in: path - name: zone + name: region required: true schema: type: string - - in: path - name: instanceGroupManager - required: true + - in: query + name: autoscaler schema: type: string - in: query name: requestId schema: type: string - /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs: - parameters: *ref_1 - post: + patch: description: >- - Deletes selected per-instance configurations for the managed instance - group. - operationId: compute.instanceGroupManagers.deletePerInstanceConfigs + 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 requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/InstanceGroupManagersDeletePerInstanceConfigsReq + $ref: '#/components/schemas/Autoscaler' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -79970,27 +87439,23 @@ paths: schema: type: string - in: path - name: zone + name: region required: true schema: type: string - - in: path - name: instanceGroupManager - required: true + - in: query + name: autoscaler schema: type: string - /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances: + - in: query + name: requestId + schema: + type: string + /projects/{project}/regions/{region}/autoscalers/{autoscaler}: parameters: *ref_1 - 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 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/InstanceGroupManagersApplyUpdatesRequest' + get: + description: Returns the specified autoscaler. + operationId: compute.regionAutoscalers.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -80000,13 +87465,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Autoscaler' parameters: - in: path name: project @@ -80014,31 +87483,18 @@ paths: schema: type: string - in: path - name: zone + name: region required: true schema: type: string - in: path - name: instanceGroupManager + name: autoscaler required: true schema: type: string - /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/createInstances: - parameters: *ref_1 - post: - description: >- - Creates instances with per-instance configurations 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 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/InstanceGroupManagersCreateInstancesRequest' + delete: + description: Deletes the specified autoscaler. + operationId: compute.regionAutoscalers.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -80062,12 +87518,12 @@ paths: schema: type: string - in: path - name: zone + name: region required: true schema: type: string - in: path - name: instanceGroupManager + name: autoscaler required: true schema: type: string @@ -80075,11 +87531,13 @@ paths: name: requestId schema: type: string - /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}: + /projects/{project}/global/backendBuckets: parameters: *ref_1 get: - description: Returns all of the details about the specified resize request. - operationId: compute.instanceGroupManagerResizeRequests.get + description: >- + Retrieves the list of BackendBucket resources available to the specified + project. + operationId: compute.backendBuckets.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -80099,87 +87557,44 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InstanceGroupManagerResizeRequest' + $ref: '#/components/schemas/BackendBucketList' parameters: - in: path name: project required: true schema: type: string - - in: path - name: zone - required: true - schema: - type: string - - in: path - name: instanceGroupManager - required: true - schema: - type: string - - in: path - name: resizeRequest - required: true - schema: - type: string - delete: - description: >- - Deletes the specified, inactive resize request. Requests that are still - active cannot be deleted. Deleting request does not delete instances - that were provisioned previously. - operationId: compute.instanceGroupManagerResizeRequests.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/compute - Oauth2c: - - https://www.googleapis.com/auth/compute - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: project - required: true + - in: query + name: filter schema: type: string - - in: path - name: zone - required: true + - in: query + name: maxResults schema: - type: string - - in: path - name: instanceGroupManager - required: true + type: integer + format: uint32 + - in: query + name: orderBy schema: type: string - - in: path - name: resizeRequest - required: true + - in: query + name: pageToken schema: type: string - in: query - name: requestId + name: returnPartialSuccess schema: - type: string - /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests: - parameters: *ref_1 + type: boolean post: description: >- - Creates a new resize request that starts provisioning VMs immediately or - queues VM creation. - operationId: compute.instanceGroupManagerResizeRequests.insert + Creates a BackendBucket resource in the specified project using the data + included in the request. + operationId: compute.backendBuckets.insert requestBody: content: application/json: schema: - $ref: '#/components/schemas/InstanceGroupManagerResizeRequest' + $ref: '#/components/schemas/BackendBucket' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -80202,25 +87617,15 @@ paths: required: true schema: type: string - - in: path - name: zone - required: true - schema: - type: string - - in: path - name: instanceGroupManager - required: true - schema: - type: string - in: query name: requestId schema: type: string + /projects/{project}/global/backendBuckets/{backendBucket}: + parameters: *ref_1 get: - description: >- - Retrieves a list of resize requests that are contained in the managed - instance group. - operationId: compute.instanceGroupManagerResizeRequests.list + description: Returns the specified BackendBucket resource. + operationId: compute.backendBuckets.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -80240,8 +87645,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/InstanceGroupManagerResizeRequestsListResponse + $ref: '#/components/schemas/BackendBucket' parameters: - in: path name: project @@ -80249,45 +87653,13 @@ paths: schema: type: string - in: path - name: zone - required: true - schema: - type: string - - in: path - name: instanceGroupManager + name: backendBucket required: true - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: returnPartialSuccess - schema: - type: boolean - /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}/cancel: - parameters: *ref_1 - post: - description: >- - Cancels the specified resize request and removes it from the queue. - Cancelled resize request does no longer wait for the resources to be - provisioned. Cancel is only possible for requests that are accepted in - the queue. - operationId: compute.instanceGroupManagerResizeRequests.cancel + schema: + type: string + delete: + description: Deletes the specified BackendBucket resource. + operationId: compute.backendBuckets.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -80311,17 +87683,7 @@ paths: schema: type: string - in: path - name: zone - required: true - schema: - type: string - - in: path - name: instanceGroupManager - required: true - schema: - type: string - - in: path - name: resizeRequest + name: backendBucket required: true schema: type: string @@ -80329,13 +87691,16 @@ paths: name: requestId schema: type: string - /projects/{project}/regions/{region}/instanceGroupManagers: - parameters: *ref_1 - get: + put: description: >- - Retrieves the list of managed instance groups that are contained within - the specified region. - operationId: compute.regionInstanceGroupManagers.list + Updates the specified BackendBucket resource with the data included in + the request. + operationId: compute.backendBuckets.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BackendBucket' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -80345,17 +87710,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/RegionInstanceGroupManagerList' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -80363,46 +87724,25 @@ paths: schema: type: string - in: path - name: region + name: backendBucket required: true schema: type: string - in: query - name: filter - schema: - type: string - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken + name: requestId schema: type: string - - in: query - name: returnPartialSuccess - schema: - type: boolean - post: + patch: 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 + 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 requestBody: content: application/json: schema: - $ref: '#/components/schemas/InstanceGroupManager' + $ref: '#/components/schemas/BackendBucket' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -80426,7 +87766,7 @@ paths: schema: type: string - in: path - name: region + name: backendBucket required: true schema: type: string @@ -80434,11 +87774,18 @@ paths: name: requestId schema: type: string - /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}: + /projects/{project}/global/backendBuckets/{backendBucket}/addSignedUrlKey: parameters: *ref_1 - get: - description: Returns all of the details about the specified managed instance group. - operationId: compute.regionInstanceGroupManagers.get + post: + description: >- + Adds a key for validating requests with signed URLs for this backend + bucket. + operationId: compute.backendBuckets.addSignedUrlKey + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SignedUrlKey' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -80448,17 +87795,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/InstanceGroupManager' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -80466,34 +87809,21 @@ paths: schema: type: string - in: path - name: region + name: backendBucket required: true schema: type: string - - in: path - name: instanceGroupManager - required: true + - in: query + name: requestId schema: type: string - patch: + /projects/{project}/global/backendBuckets/{backendBucket}/deleteSignedUrlKey: + parameters: *ref_1 + post: 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 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/InstanceGroupManager' + Deletes a key for validating requests with signed URLs for this backend + bucket. + operationId: compute.backendBuckets.deleteSignedUrlKey security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -80517,12 +87847,12 @@ paths: schema: type: string - in: path - name: region + name: backendBucket required: true schema: type: string - - in: path - name: instanceGroupManager + - in: query + name: keyName required: true schema: type: string @@ -80530,11 +87860,16 @@ paths: name: requestId schema: type: string - delete: - description: >- - Deletes the specified managed instance group and all of the instances in - that group. - operationId: compute.regionInstanceGroupManagers.delete + /projects/{project}/global/backendBuckets/{backendBucket}/setEdgeSecurityPolicy: + parameters: *ref_1 + post: + description: Sets the edge security policy for the specified backend bucket. + operationId: compute.backendBuckets.setEdgeSecurityPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SecurityPolicyReference' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -80558,12 +87893,7 @@ paths: schema: type: string - in: path - name: region - required: true - schema: - type: string - - in: path - name: instanceGroupManager + name: backendBucket required: true schema: type: string @@ -80571,29 +87901,13 @@ paths: name: requestId schema: type: string - /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deleteInstances: + /projects/{project}/global/backendBuckets/{resource}/getIamPolicy: parameters: *ref_1 - post: + get: 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 - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/RegionInstanceGroupManagersDeleteInstancesRequest + Gets the access control policy for a resource. May be empty if no such + policy or resource exists. + operationId: compute.backendBuckets.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -80603,13 +87917,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Policy' parameters: - in: path name: project @@ -80617,43 +87935,27 @@ paths: schema: type: string - in: path - name: region - required: true - schema: - type: string - - in: path - name: instanceGroupManager + name: resource required: true schema: type: string - in: query - name: requestId + name: optionsRequestedPolicyVersion schema: - type: string - /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/abandonInstances: + type: integer + format: int32 + /projects/{project}/global/backendBuckets/{resource}/setIamPolicy: parameters: *ref_1 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 + Sets the access control policy on the specified resource. Replaces any + existing policy. + operationId: compute.backendBuckets.setIamPolicy requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/RegionInstanceGroupManagersAbandonInstancesRequest + $ref: '#/components/schemas/GlobalSetPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -80669,7 +87971,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Policy' parameters: - in: path name: project @@ -80677,40 +87979,20 @@ paths: schema: type: string - in: path - name: region - required: true - schema: - type: string - - in: path - name: instanceGroupManager + name: resource required: true schema: type: string - - in: query - name: requestId - schema: - type: string - /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/recreateInstances: + /projects/{project}/global/backendBuckets/{resource}/testIamPermissions: parameters: *ref_1 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 + description: Returns permissions that a caller has on the specified resource. + operationId: compute.backendBuckets.testIamPermissions requestBody: content: application/json: schema: - $ref: '#/components/schemas/RegionInstanceGroupManagersRecreateRequest' + $ref: '#/components/schemas/TestPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -80720,13 +88002,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/TestPermissionsResponse' parameters: - in: path name: project @@ -80734,34 +88020,17 @@ paths: schema: type: string - in: path - name: region - required: true - schema: - type: string - - in: path - name: instanceGroupManager + name: resource required: true schema: type: string - - in: query - name: requestId - schema: - type: string - /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resize: + /projects/{project}/global/backendServices: parameters: *ref_1 - post: + get: 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 + Retrieves the list of BackendService resources available to the + specified project. + operationId: compute.backendServices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -80771,52 +88040,55 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/BackendServiceList' parameters: - in: path name: project required: true schema: type: string - - in: path - name: region - required: true - schema: - type: string - - in: path - name: instanceGroupManager - required: true + - in: query + name: filter schema: type: string - in: query - name: size - required: true + name: maxResults schema: type: integer - format: int32 + format: uint32 - in: query - name: requestId + name: orderBy schema: type: string - /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate: - parameters: *ref_1 + - in: query + name: pageToken + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean 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 + 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 requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/RegionInstanceGroupManagersSetTemplateRequest + $ref: '#/components/schemas/BackendService' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -80839,33 +88111,18 @@ paths: required: true schema: type: string - - in: path - name: region - required: true - schema: - type: string - - in: path - name: instanceGroupManager - required: true - schema: - type: string - in: query name: requestId schema: type: string - /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setTargetPools: + /projects/{project}/aggregated/backendServices: parameters: *ref_1 - post: + get: 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 - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/RegionInstanceGroupManagersSetTargetPoolsRequest + Retrieves the list of all BackendService resources, regional and global, + available to the specified project. To prevent failure, Google + recommends that you set the `returnPartialSuccess` parameter to `true`. + operationId: compute.backendServices.aggregatedList security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -80875,43 +88132,60 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/BackendServiceAggregatedList' parameters: - in: path name: project required: true schema: type: string - - in: path - name: region - required: true + - in: query + name: filter schema: type: string - - in: path - name: instanceGroupManager - required: true + - in: query + name: includeAllScopes + schema: + type: boolean + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy schema: type: string - in: query - name: requestId + name: pageToken schema: type: string - /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances: + - in: query + name: returnPartialSuccess + schema: + type: boolean + - in: query + name: serviceProjectNumber + schema: + type: string + format: int64 + /projects/{project}/global/backendServices/listUsable: parameters: *ref_1 - post: + get: 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. The `pageToken` query parameter is supported only if the - group's `listManagedInstancesResults` field is set to `PAGINATED`. - operationId: compute.regionInstanceGroupManagers.listManagedInstances + Retrieves a list of all usable backend services in the specified + project. + operationId: compute.backendServices.listUsable security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -80931,24 +88205,13 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/RegionInstanceGroupManagersListInstancesResponse + $ref: '#/components/schemas/BackendServiceListUsable' parameters: - in: path name: project required: true schema: type: string - - in: path - name: region - required: true - schema: - type: string - - in: path - name: instanceGroupManager - required: true - schema: - type: string - in: query name: filter schema: @@ -80970,14 +88233,11 @@ paths: name: returnPartialSuccess schema: type: boolean - /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listErrors: + /projects/{project}/global/backendServices/{backendService}: parameters: *ref_1 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 + description: Returns the specified BackendService resource. + operationId: compute.backendServices.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -80997,8 +88257,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/RegionInstanceGroupManagersListErrorsResponse + $ref: '#/components/schemas/BackendService' parameters: - in: path name: project @@ -81006,43 +88265,97 @@ paths: schema: type: string - in: path - name: region + name: backendService required: true schema: type: string + delete: + description: Deletes the specified BackendService resource. + operationId: compute.backendServices.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: - in: path - name: instanceGroupManager + name: project required: true schema: type: string - - in: query - name: filter + - in: path + name: backendService + required: true schema: type: string - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy + name: requestId schema: type: string - - in: query - name: pageToken + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BackendService' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: project + required: true schema: type: string - - in: query - name: returnPartialSuccess + - in: path + name: backendService + required: true schema: - type: boolean - /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs: - parameters: *ref_1 - post: + type: string + - in: query + name: requestId + schema: + type: string + patch: description: >- - Lists all of the per-instance configurations defined for the managed - instance group. The orderBy query parameter is not supported. - operationId: compute.regionInstanceGroupManagers.listPerInstanceConfigs + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BackendService' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -81052,18 +88365,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/RegionInstanceGroupManagersListInstanceConfigsResp + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -81071,50 +88379,26 @@ paths: schema: type: string - in: path - name: region - required: true - schema: - type: string - - in: path - name: instanceGroupManager + name: backendService required: true schema: type: string - in: query - name: filter - schema: - type: string - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken + name: requestId schema: type: string - - in: query - name: returnPartialSuccess - schema: - type: boolean - /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs: + /projects/{project}/global/backendServices/{backendService}/addSignedUrlKey: parameters: *ref_1 post: description: >- - Inserts or updates per-instance configurations for the managed instance - group. perInstanceConfig.name serves as a key used to distinguish - whether to perform insert or patch. - operationId: compute.regionInstanceGroupManagers.updatePerInstanceConfigs + Adds a key for validating requests with signed URLs for this backend + service. + operationId: compute.backendServices.addSignedUrlKey requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/RegionInstanceGroupManagerUpdateInstanceConfigReq + $ref: '#/components/schemas/SignedUrlKey' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -81138,12 +88422,7 @@ paths: schema: type: string - in: path - name: region - required: true - schema: - type: string - - in: path - name: instanceGroupManager + name: backendService required: true schema: type: string @@ -81151,20 +88430,13 @@ paths: name: requestId schema: type: string - /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs: + /projects/{project}/global/backendServices/{backendService}/deleteSignedUrlKey: parameters: *ref_1 post: description: >- - Inserts or patches per-instance configurations for the managed instance - group. perInstanceConfig.name serves as a key used to distinguish - whether to perform insert or patch. - operationId: compute.regionInstanceGroupManagers.patchPerInstanceConfigs - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/RegionInstanceGroupManagerPatchInstanceConfigReq + Deletes a key for validating requests with signed URLs for this backend + service. + operationId: compute.backendServices.deleteSignedUrlKey security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -81188,12 +88460,12 @@ paths: schema: type: string - in: path - name: region + name: backendService required: true schema: type: string - - in: path - name: instanceGroupManager + - in: query + name: keyName required: true schema: type: string @@ -81201,19 +88473,18 @@ paths: name: requestId schema: type: string - /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs: + /projects/{project}/global/backendServices/{backendService}/setSecurityPolicy: parameters: *ref_1 post: description: >- - Deletes selected per-instance configurations for the managed instance - group. - operationId: compute.regionInstanceGroupManagers.deletePerInstanceConfigs + Sets the Google Cloud Armor security policy for the specified backend + service. For more information, see Google Cloud Armor Overview + operationId: compute.backendServices.setSecurityPolicy requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/RegionInstanceGroupManagerDeleteInstanceConfigReq + $ref: '#/components/schemas/SecurityPolicyReference' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -81237,26 +88508,24 @@ paths: schema: type: string - in: path - name: region + name: backendService required: true schema: type: string - - in: path - name: instanceGroupManager - required: true + - in: query + name: requestId schema: type: string - /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances: + /projects/{project}/global/backendServices/{backendService}/setEdgeSecurityPolicy: parameters: *ref_1 post: - description: Apply updates to selected instances the managed instance group. - operationId: compute.regionInstanceGroupManagers.applyUpdatesToInstances + description: Sets the edge security policy for the specified backend service. + operationId: compute.backendServices.setEdgeSecurityPolicy requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/RegionInstanceGroupManagersApplyUpdatesRequest + $ref: '#/components/schemas/SecurityPolicyReference' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -81280,32 +88549,27 @@ paths: schema: type: string - in: path - name: region + name: backendService required: true schema: type: string - - in: path - name: instanceGroupManager - required: true + - in: query + name: requestId schema: type: string - /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/createInstances: + /projects/{project}/global/backendServices/{backendService}/getHealth: parameters: *ref_1 post: description: >- - Creates instances with per-instance configurations 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 + 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 requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/RegionInstanceGroupManagersCreateInstancesRequest + $ref: '#/components/schemas/ResourceGroupReference' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -81315,13 +88579,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/BackendServiceGroupHealth' parameters: - in: path name: project @@ -81329,24 +88597,17 @@ paths: schema: type: string - in: path - name: region - required: true - schema: - type: string - - in: path - name: instanceGroupManager + name: backendService required: true schema: type: string - - in: query - name: requestId - schema: - type: string - /projects/{project}/zones/{zone}/autoscalers: + /projects/{project}/global/backendServices/{resource}/getIamPolicy: parameters: *ref_1 get: - description: Retrieves a list of autoscalers contained within the specified zone. - operationId: compute.autoscalers.list + description: >- + Gets the access control policy for a resource. May be empty if no such + policy or resource exists. + operationId: compute.backendServices.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -81366,7 +88627,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AutoscalerList' + $ref: '#/components/schemas/Policy' parameters: - in: path name: project @@ -81374,41 +88635,27 @@ paths: schema: type: string - in: path - name: zone + name: resource required: true schema: type: string - in: query - name: filter - schema: - type: string - - in: query - name: maxResults + name: optionsRequestedPolicyVersion schema: type: integer - format: uint32 - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: returnPartialSuccess - schema: - type: boolean + format: int32 + /projects/{project}/global/backendServices/{resource}/setIamPolicy: + parameters: *ref_1 post: description: >- - Creates an autoscaler in the specified project using the data included - in the request. - operationId: compute.autoscalers.insert + Sets the access control policy on the specified resource. Replaces any + existing policy. + operationId: compute.backendServices.setIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/Autoscaler' + $ref: '#/components/schemas/GlobalSetPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -81424,7 +88671,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Policy' parameters: - in: path name: project @@ -81432,24 +88679,20 @@ paths: schema: type: string - in: path - name: zone + name: resource required: true schema: type: string - - in: query - name: requestId - schema: - type: string - put: - description: >- - Updates an autoscaler in the specified project using the data included - in the request. - operationId: compute.autoscalers.update + /projects/{project}/global/backendServices/{resource}/testIamPermissions: + parameters: *ref_1 + post: + description: Returns permissions that a caller has on the specified resource. + operationId: compute.backendServices.testIamPermissions requestBody: content: application/json: schema: - $ref: '#/components/schemas/Autoscaler' + $ref: '#/components/schemas/TestPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -81459,13 +88702,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/TestPermissionsResponse' parameters: - in: path name: project @@ -81473,29 +88720,80 @@ paths: schema: type: string - in: path - name: zone + name: resource + required: true + schema: + type: string + /projects/{project}/regions/{region}/backendServices: + parameters: *ref_1 + get: + description: >- + Retrieves the list of regional BackendService resources available to the + specified project in the given region. + operationId: compute.regionBackendServices.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/BackendServiceList' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: region required: true schema: type: string - in: query - name: autoscaler + name: filter schema: type: string - in: query - name: requestId + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy schema: type: string - patch: + - in: query + name: pageToken + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean + post: 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 + 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 requestBody: content: application/json: schema: - $ref: '#/components/schemas/Autoscaler' + $ref: '#/components/schemas/BackendService' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -81519,25 +88817,21 @@ paths: schema: type: string - in: path - name: zone + name: region required: true schema: type: string - - in: query - name: autoscaler - schema: - type: string - in: query name: requestId schema: type: string - /projects/{project}/aggregated/autoscalers: + /projects/{project}/regions/{region}/backendServices/listUsable: parameters: *ref_1 get: description: >- - Retrieves an aggregated list of autoscalers. To prevent failure, Google - recommends that you set the `returnPartialSuccess` parameter to `true`. - operationId: compute.autoscalers.aggregatedList + Retrieves a list of all usable backend services in the specified project + in the given region. + operationId: compute.regionBackendServices.listUsable security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -81557,21 +88851,22 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AutoscalerAggregatedList' + $ref: '#/components/schemas/BackendServiceListUsable' parameters: - in: path name: project required: true schema: type: string - - in: query - name: filter + - in: path + name: region + required: true schema: type: string - in: query - name: includeAllScopes + name: filter schema: - type: boolean + type: string - in: query name: maxResults schema: @@ -81589,16 +88884,11 @@ paths: name: returnPartialSuccess schema: type: boolean - - in: query - name: serviceProjectNumber - schema: - type: string - format: int64 - /projects/{project}/zones/{zone}/autoscalers/{autoscaler}: + /projects/{project}/regions/{region}/backendServices/{backendService}: parameters: *ref_1 get: - description: Returns the specified autoscaler resource. - operationId: compute.autoscalers.get + description: Returns the specified regional BackendService resource. + operationId: compute.regionBackendServices.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -81618,7 +88908,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Autoscaler' + $ref: '#/components/schemas/BackendService' parameters: - in: path name: project @@ -81626,18 +88916,18 @@ paths: schema: type: string - in: path - name: zone + name: region required: true schema: type: string - in: path - name: autoscaler + name: backendService required: true schema: type: string delete: - description: Deletes the specified autoscaler. - operationId: compute.autoscalers.delete + description: Deletes the specified regional BackendService resource. + operationId: compute.regionBackendServices.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -81661,12 +88951,12 @@ paths: schema: type: string - in: path - name: zone + name: region required: true schema: type: string - in: path - name: autoscaler + name: backendService required: true schema: type: string @@ -81674,11 +88964,17 @@ paths: name: requestId schema: type: string - /projects/{project}/regions/{region}/autoscalers: - parameters: *ref_1 - get: - description: Retrieves a list of autoscalers contained within the specified region. - operationId: compute.regionAutoscalers.list + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BackendService' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -81688,17 +88984,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/RegionAutoscalerList' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -81710,37 +89002,27 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy + - in: path + name: backendService + required: true schema: type: string - in: query - name: pageToken + name: requestId schema: type: string - - in: query - name: returnPartialSuccess - schema: - type: boolean - post: + patch: description: >- - Creates an autoscaler in the specified project using the data included - in the request. - operationId: compute.regionAutoscalers.insert + 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 requestBody: content: application/json: schema: - $ref: '#/components/schemas/Autoscaler' + $ref: '#/components/schemas/BackendService' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -81768,20 +89050,27 @@ paths: required: true schema: type: string + - in: path + name: backendService + required: true + schema: + type: string - in: query name: requestId schema: type: string - put: + /projects/{project}/regions/{region}/backendServices/{backendService}/setSecurityPolicy: + parameters: *ref_1 + post: description: >- - Updates an autoscaler in the specified project using the data included - in the request. - operationId: compute.regionAutoscalers.update + Sets the Google Cloud Armor security policy for the specified backend + service. For more information, see Google Cloud Armor Overview + operationId: compute.regionBackendServices.setSecurityPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/Autoscaler' + $ref: '#/components/schemas/SecurityPolicyReference' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -81809,25 +89098,27 @@ paths: required: true schema: type: string - - in: query - name: autoscaler + - in: path + name: backendService + required: true schema: type: string - in: query name: requestId schema: type: string - patch: + /projects/{project}/regions/{region}/backendServices/{backendService}/getHealth: + parameters: *ref_1 + post: 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 + Gets the most recent health check results for this regional + BackendService. + operationId: compute.regionBackendServices.getHealth requestBody: content: application/json: schema: - $ref: '#/components/schemas/Autoscaler' + $ref: '#/components/schemas/ResourceGroupReference' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -81837,13 +89128,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/BackendServiceGroupHealth' parameters: - in: path name: project @@ -81855,19 +89150,18 @@ paths: required: true schema: type: string - - in: query - name: autoscaler - schema: - type: string - - in: query - name: requestId + - in: path + name: backendService + required: true schema: type: string - /projects/{project}/regions/{region}/autoscalers/{autoscaler}: + /projects/{project}/regions/{region}/backendServices/{resource}/getIamPolicy: parameters: *ref_1 get: - description: Returns the specified autoscaler. - operationId: compute.regionAutoscalers.get + description: >- + Gets the access control policy for a resource. May be empty if no such + policy or resource exists. + operationId: compute.regionBackendServices.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -81887,7 +89181,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Autoscaler' + $ref: '#/components/schemas/Policy' parameters: - in: path name: project @@ -81900,13 +89194,69 @@ paths: schema: type: string - in: path - name: autoscaler + name: resource required: true schema: type: string - delete: - description: Deletes the specified autoscaler. - operationId: compute.regionAutoscalers.delete + - in: query + name: optionsRequestedPolicyVersion + schema: + type: integer + format: int32 + /projects/{project}/regions/{region}/backendServices/{resource}/setIamPolicy: + parameters: *ref_1 + post: + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy. + operationId: compute.regionBackendServices.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RegionSetPolicyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: region + required: true + schema: + type: string + - in: path + name: resource + required: true + schema: + type: string + /projects/{project}/regions/{region}/backendServices/{resource}/testIamPermissions: + parameters: *ref_1 + post: + description: Returns permissions that a caller has on the specified resource. + operationId: compute.regionBackendServices.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -81916,13 +89266,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/TestPermissionsResponse' parameters: - in: path name: project @@ -81935,21 +89289,15 @@ paths: schema: type: string - in: path - name: autoscaler + name: resource required: true schema: type: string - - in: query - name: requestId - schema: - type: string - /projects/{project}/global/backendBuckets: + /projects/{project}/regions/{region}/commitments: parameters: *ref_1 get: - description: >- - Retrieves the list of BackendBucket resources available to the specified - project. - operationId: compute.backendBuckets.list + description: Retrieves a list of commitments contained within the specified region. + operationId: compute.regionCommitments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -81969,13 +89317,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BackendBucketList' + $ref: '#/components/schemas/CommitmentList' parameters: - in: path name: project required: true schema: type: string + - in: path + name: region + required: true + schema: + type: string - in: query name: filter schema: @@ -81999,14 +89352,14 @@ paths: type: boolean post: description: >- - Creates a BackendBucket resource in the specified project using the data - included in the request. - operationId: compute.backendBuckets.insert + Creates a commitment in the specified project using the data included in + the request. + operationId: compute.regionCommitments.insert requestBody: content: application/json: schema: - $ref: '#/components/schemas/BackendBucket' + $ref: '#/components/schemas/Commitment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -82029,15 +89382,23 @@ paths: required: true schema: type: string + - in: path + name: region + required: true + schema: + type: string - in: query name: requestId schema: type: string - /projects/{project}/global/backendBuckets/{backendBucket}: + /projects/{project}/aggregated/commitments: parameters: *ref_1 get: - description: Returns the specified BackendBucket resource. - operationId: compute.backendBuckets.get + description: >- + Retrieves an aggregated list of commitments by region. To prevent + failure, Google recommends that you set the `returnPartialSuccess` + parameter to `true`. + operationId: compute.regionCommitments.aggregatedList security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -82057,62 +89418,48 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BackendBucket' + $ref: '#/components/schemas/CommitmentAggregatedList' parameters: - in: path name: project required: true schema: type: string - - in: path - name: backendBucket - required: true + - in: query + name: filter schema: type: string - delete: - description: Deletes the specified BackendBucket resource. - operationId: compute.backendBuckets.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/compute - Oauth2c: - - https://www.googleapis.com/auth/compute - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: project - required: true + - in: query + name: includeAllScopes + schema: + type: boolean + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy schema: type: string - - in: path - name: backendBucket - required: true + - in: query + name: pageToken schema: type: string - in: query - name: requestId + name: returnPartialSuccess + schema: + type: boolean + - in: query + name: serviceProjectNumber schema: type: string - put: - description: >- - Updates the specified BackendBucket resource with the data included in - the request. - operationId: compute.backendBuckets.update - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/BackendBucket' + format: int64 + /projects/{project}/regions/{region}/commitments/{commitment}: + parameters: *ref_1 + get: + description: Returns the specified commitment resource. + operationId: compute.regionCommitments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -82122,13 +89469,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Commitment' parameters: - in: path name: project @@ -82136,25 +89487,27 @@ paths: schema: type: string - in: path - name: backendBucket + name: region required: true schema: type: string - - in: query - name: requestId + - in: path + name: commitment + required: true schema: type: string 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 + Updates the specified commitment with the data included in the request. + Update is performed only on selected fields included as part of + update-mask. Only the following fields can be updated: auto_renew and + plan. + operationId: compute.regionCommitments.update requestBody: content: application/json: schema: - $ref: '#/components/schemas/BackendBucket' + $ref: '#/components/schemas/Commitment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -82178,26 +89531,33 @@ paths: schema: type: string - in: path - name: backendBucket + name: region required: true schema: type: string + - in: path + name: commitment + required: true + schema: + type: string + - in: query + name: paths + schema: + type: string - in: query name: requestId schema: type: string - /projects/{project}/global/backendBuckets/{backendBucket}/addSignedUrlKey: + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /projects/{project}/zones/{zone}/diskTypes: parameters: *ref_1 - post: - description: >- - Adds a key for validating requests with signed URLs for this backend - bucket. - operationId: compute.backendBuckets.addSignedUrlKey - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SignedUrlKey' + get: + description: Retrieves a list of disk types available to the specified project. + operationId: compute.diskTypes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -82207,13 +89567,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/DiskTypeList' parameters: - in: path name: project @@ -82221,21 +89585,38 @@ paths: schema: type: string - in: path - name: backendBucket + name: zone required: true schema: type: string - in: query - name: requestId + name: filter schema: type: string - /projects/{project}/global/backendBuckets/{backendBucket}/deleteSignedUrlKey: + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean + /projects/{project}/aggregated/diskTypes: parameters: *ref_1 - post: + get: description: >- - Deletes a key for validating requests with signed URLs for this backend - bucket. - operationId: compute.backendBuckets.deleteSignedUrlKey + Retrieves an aggregated list of disk types. To prevent failure, Google + recommends that you set the `returnPartialSuccess` parameter to `true`. + operationId: compute.diskTypes.aggregatedList security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -82245,43 +89626,58 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/DiskTypeAggregatedList' parameters: - in: path name: project required: true schema: type: string - - in: path - name: backendBucket - required: true + - in: query + name: filter schema: type: string - in: query - name: keyName - required: true + name: includeAllScopes + schema: + type: boolean + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy schema: type: string - in: query - name: requestId + name: pageToken schema: type: string - /projects/{project}/global/backendBuckets/{backendBucket}/setEdgeSecurityPolicy: + - in: query + name: returnPartialSuccess + schema: + type: boolean + - in: query + name: serviceProjectNumber + schema: + type: string + format: int64 + /projects/{project}/zones/{zone}/diskTypes/{diskType}: parameters: *ref_1 - post: - description: Sets the edge security policy for the specified backend bucket. - operationId: compute.backendBuckets.setEdgeSecurityPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SecurityPolicyReference' + get: + description: Returns the specified disk type. + operationId: compute.diskTypes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -82291,13 +89687,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/DiskType' parameters: - in: path name: project @@ -82305,21 +89705,22 @@ paths: schema: type: string - in: path - name: backendBucket + name: zone required: true schema: type: string - - in: query - name: requestId + - in: path + name: diskType + required: true schema: type: string - /projects/{project}/global/backendBuckets/{resource}/getIamPolicy: + /projects/{project}/regions/{region}/diskTypes: parameters: *ref_1 get: description: >- - Gets the access control policy for a resource. May be empty if no such - policy or resource exists. - operationId: compute.backendBuckets.getIamPolicy + Retrieves a list of regional disk types available to the specified + project. + operationId: compute.regionDiskTypes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -82339,7 +89740,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/RegionDiskTypeList' parameters: - in: path name: project @@ -82347,64 +89748,36 @@ paths: schema: type: string - in: path - name: resource + name: region required: true schema: type: string - in: query - name: optionsRequestedPolicyVersion + name: filter + schema: + type: string + - in: query + name: maxResults schema: type: integer - format: int32 - /projects/{project}/global/backendBuckets/{resource}/setIamPolicy: - parameters: *ref_1 - post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. - operationId: compute.backendBuckets.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GlobalSetPolicyRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/compute - Oauth2c: - - https://www.googleapis.com/auth/compute - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Policy' - parameters: - - in: path - name: project - required: true + format: uint32 + - in: query + name: orderBy schema: type: string - - in: path - name: resource - required: true + - in: query + name: pageToken schema: type: string - /projects/{project}/global/backendBuckets/{resource}/testIamPermissions: + - in: query + name: returnPartialSuccess + schema: + type: boolean + /projects/{project}/regions/{region}/diskTypes/{diskType}: parameters: *ref_1 - post: - description: Returns permissions that a caller has on the specified resource. - operationId: compute.backendBuckets.testIamPermissions - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TestPermissionsRequest' + get: + description: Returns the specified regional disk type. + operationId: compute.regionDiskTypes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -82424,7 +89797,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TestPermissionsResponse' + $ref: '#/components/schemas/DiskType' parameters: - in: path name: project @@ -82432,17 +89805,22 @@ paths: schema: type: string - in: path - name: resource + name: region required: true schema: type: string - /projects/{project}/global/backendServices: + - in: path + name: diskType + required: true + schema: + type: string + /projects/{project}/regions/{region}/interconnectAttachments: parameters: *ref_1 get: description: >- - Retrieves the list of BackendService resources available to the - specified project. - operationId: compute.backendServices.list + Retrieves the list of interconnect attachments contained within the + specified region. + operationId: compute.interconnectAttachments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -82462,13 +89840,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BackendServiceList' + $ref: '#/components/schemas/InterconnectAttachmentList' parameters: - in: path name: project required: true schema: type: string + - in: path + name: region + required: true + schema: + type: string - in: query name: filter schema: @@ -82492,15 +89875,14 @@ paths: type: boolean 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 + Creates an InterconnectAttachment in the specified project using the + data included in the request. + operationId: compute.interconnectAttachments.insert requestBody: content: application/json: schema: - $ref: '#/components/schemas/BackendService' + $ref: '#/components/schemas/InterconnectAttachment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -82523,18 +89905,27 @@ paths: required: true schema: type: string + - in: path + name: region + required: true + schema: + type: string - in: query name: requestId schema: type: string - /projects/{project}/aggregated/backendServices: + - in: query + name: validateOnly + schema: + type: boolean + /projects/{project}/aggregated/interconnectAttachments: parameters: *ref_1 get: description: >- - Retrieves the list of all BackendService resources, regional and global, - available to the specified project. To prevent failure, Google - recommends that you set the `returnPartialSuccess` parameter to `true`. - operationId: compute.backendServices.aggregatedList + Retrieves an aggregated list of interconnect attachments. To prevent + failure, Google recommends that you set the `returnPartialSuccess` + parameter to `true`. + operationId: compute.interconnectAttachments.aggregatedList security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -82554,7 +89945,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BackendServiceAggregatedList' + $ref: '#/components/schemas/InterconnectAttachmentAggregatedList' parameters: - in: path name: project @@ -82591,65 +89982,11 @@ paths: schema: type: string format: int64 - /projects/{project}/global/backendServices/listUsable: - parameters: *ref_1 - get: - description: >- - Retrieves a list of all usable backend services in the specified - project. - operationId: compute.backendServices.listUsable - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/compute - Oauth2c: - - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/BackendServiceListUsable' - parameters: - - in: path - name: project - required: true - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: returnPartialSuccess - schema: - type: boolean - /projects/{project}/global/backendServices/{backendService}: + /projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}: parameters: *ref_1 get: - description: Returns the specified BackendService resource. - operationId: compute.backendServices.get + description: Returns the specified interconnect attachment. + operationId: compute.interconnectAttachments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -82669,7 +90006,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BackendService' + $ref: '#/components/schemas/InterconnectAttachment' parameters: - in: path name: project @@ -82677,54 +90014,26 @@ paths: schema: type: string - in: path - name: backendService - required: true - schema: - type: string - delete: - description: Deletes the specified BackendService resource. - operationId: compute.backendServices.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/compute - Oauth2c: - - https://www.googleapis.com/auth/compute - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: project + name: region required: true schema: type: string - in: path - name: backendService + name: interconnectAttachment required: true schema: type: string - - in: query - name: requestId - schema: - type: string - put: + patch: description: >- - Updates the specified BackendService resource with the data included in - the request. For more information, see Backend services overview. - operationId: compute.backendServices.update + 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 requestBody: content: application/json: schema: - $ref: '#/components/schemas/BackendService' + $ref: '#/components/schemas/InterconnectAttachment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -82748,7 +90057,12 @@ paths: schema: type: string - in: path - name: backendService + name: region + required: true + schema: + type: string + - in: path + name: interconnectAttachment required: true schema: type: string @@ -82756,18 +90070,9 @@ paths: name: requestId schema: type: string - 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 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/BackendService' + delete: + description: Deletes the specified interconnect attachment. + operationId: compute.interconnectAttachments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -82791,7 +90096,12 @@ paths: schema: type: string - in: path - name: backendService + name: region + required: true + schema: + type: string + - in: path + name: interconnectAttachment required: true schema: type: string @@ -82799,18 +90109,18 @@ paths: name: requestId schema: type: string - /projects/{project}/global/backendServices/{backendService}/addSignedUrlKey: + /projects/{project}/regions/{region}/interconnectAttachments/{resource}/setLabels: parameters: *ref_1 post: description: >- - Adds a key for validating requests with signed URLs for this backend - service. - operationId: compute.backendServices.addSignedUrlKey + Sets the labels on an InterconnectAttachment. To learn more about + labels, read the Labeling Resources documentation. + operationId: compute.interconnectAttachments.setLabels requestBody: content: application/json: schema: - $ref: '#/components/schemas/SignedUrlKey' + $ref: '#/components/schemas/RegionSetLabelsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -82834,7 +90144,12 @@ paths: schema: type: string - in: path - name: backendService + name: region + required: true + schema: + type: string + - in: path + name: resource required: true schema: type: string @@ -82842,13 +90157,11 @@ paths: name: requestId schema: type: string - /projects/{project}/global/backendServices/{backendService}/deleteSignedUrlKey: + /projects/{project}/global/interconnectAttachmentGroups: parameters: *ref_1 - post: - description: >- - Deletes a key for validating requests with signed URLs for this backend - service. - operationId: compute.backendServices.deleteSignedUrlKey + get: + description: Lists the InterconnectAttachmentGroups for a project in the given scope. + operationId: compute.interconnectAttachmentGroups.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -82858,45 +90171,54 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/InterconnectAttachmentGroupsListResponse' parameters: - in: path name: project required: true schema: type: string - - in: path - name: backendService - required: true + - in: query + name: filter schema: type: string - in: query - name: keyName - required: true + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy schema: type: string - in: query - name: requestId + name: pageToken schema: type: string - /projects/{project}/global/backendServices/{backendService}/setSecurityPolicy: - parameters: *ref_1 + - in: query + name: returnPartialSuccess + schema: + type: boolean 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 + Creates a InterconnectAttachmentGroup in the specified project in the + given scope using the parameters that are included in the request. + operationId: compute.interconnectAttachmentGroups.insert requestBody: content: application/json: schema: - $ref: '#/components/schemas/SecurityPolicyReference' + $ref: '#/components/schemas/InterconnectAttachmentGroup' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -82919,25 +90241,51 @@ paths: required: true schema: type: string + - in: query + name: requestId + schema: + type: string + /projects/{project}/global/interconnectAttachmentGroups/{interconnectAttachmentGroup}: + parameters: *ref_1 + get: + description: >- + Returns the specified InterconnectAttachmentGroup resource in the given + scope. + operationId: compute.interconnectAttachmentGroups.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/InterconnectAttachmentGroup' + parameters: - in: path - name: backendService + name: project required: true schema: type: string - - in: query - name: requestId + - in: path + name: interconnectAttachmentGroup + required: true schema: type: string - /projects/{project}/global/backendServices/{backendService}/setEdgeSecurityPolicy: - parameters: *ref_1 - post: - description: Sets the edge security policy for the specified backend service. - operationId: compute.backendServices.setEdgeSecurityPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SecurityPolicyReference' + delete: + description: Deletes the specified InterconnectAttachmentGroup in the given scope + operationId: compute.interconnectAttachmentGroups.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -82961,7 +90309,7 @@ paths: schema: type: string - in: path - name: backendService + name: interconnectAttachmentGroup required: true schema: type: string @@ -82969,19 +90317,17 @@ paths: name: requestId schema: type: string - /projects/{project}/global/backendServices/{backendService}/getHealth: - parameters: *ref_1 - post: + patch: 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 + Patches the specified InterconnectAttachmentGroup resource with the data + included in the request. This method supports PATCH semantics and uses + JSON merge patch format and processing rules. + operationId: compute.interconnectAttachmentGroups.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/ResourceGroupReference' + $ref: '#/components/schemas/InterconnectAttachmentGroup' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -82991,17 +90337,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/BackendServiceGroupHealth' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -83009,17 +90351,26 @@ paths: schema: type: string - in: path - name: backendService + name: interconnectAttachmentGroup required: true schema: type: string - /projects/{project}/global/backendServices/{resource}/getIamPolicy: + - in: query + name: requestId + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /projects/{project}/global/interconnectAttachmentGroups/{resource}/getIamPolicy: parameters: *ref_1 get: description: >- Gets the access control policy for a resource. May be empty if no such policy or resource exists. - operationId: compute.backendServices.getIamPolicy + operationId: compute.interconnectAttachmentGroups.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -83056,13 +90407,13 @@ paths: schema: type: integer format: int32 - /projects/{project}/global/backendServices/{resource}/setIamPolicy: + /projects/{project}/global/interconnectAttachmentGroups/{resource}/setIamPolicy: parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any existing policy. - operationId: compute.backendServices.setIamPolicy + operationId: compute.interconnectAttachmentGroups.setIamPolicy requestBody: content: application/json: @@ -83095,11 +90446,11 @@ paths: required: true schema: type: string - /projects/{project}/global/backendServices/{resource}/testIamPermissions: + /projects/{project}/global/interconnectAttachmentGroups/{resource}/testIamPermissions: parameters: *ref_1 post: description: Returns permissions that a caller has on the specified resource. - operationId: compute.backendServices.testIamPermissions + operationId: compute.interconnectAttachmentGroups.testIamPermissions requestBody: content: application/json: @@ -83136,13 +90487,13 @@ paths: required: true schema: type: string - /projects/{project}/regions/{region}/backendServices: + /projects/{project}/global/interconnectAttachmentGroups/{interconnectAttachmentGroup}/getOperationalStatus: parameters: *ref_1 get: description: >- - Retrieves the list of regional BackendService resources available to the - specified project in the given region. - operationId: compute.regionBackendServices.list + Returns the InterconnectAttachmentStatuses for the specified + InterconnectAttachmentGroup resource. + operationId: compute.interconnectAttachmentGroups.getOperationalStatus security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -83162,7 +90513,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BackendServiceList' + $ref: >- + #/components/schemas/InterconnectAttachmentGroupsGetOperationalStatusResponse parameters: - in: path name: project @@ -83170,42 +90522,22 @@ paths: schema: type: string - in: path - name: region + name: interconnectAttachmentGroup required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: returnPartialSuccess - schema: - type: boolean + /projects/{project}/global/interconnects: + parameters: *ref_1 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 + Creates an Interconnect in the specified project using the data included + in the request. + operationId: compute.interconnects.insert requestBody: content: application/json: schema: - $ref: '#/components/schemas/BackendService' + $ref: '#/components/schemas/Interconnect' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -83228,22 +90560,13 @@ paths: required: true schema: type: string - - in: path - name: region - required: true - schema: - type: string - in: query name: requestId schema: type: string - /projects/{project}/regions/{region}/backendServices/listUsable: - parameters: *ref_1 get: - description: >- - Retrieves a list of all usable backend services in the specified project - in the given region. - operationId: compute.regionBackendServices.listUsable + description: Retrieves the list of Interconnects available to the specified project. + operationId: compute.interconnects.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -83263,18 +90586,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BackendServiceListUsable' + $ref: '#/components/schemas/InterconnectList' parameters: - in: path name: project required: true schema: type: string - - in: path - name: region - required: true - schema: - type: string - in: query name: filter schema: @@ -83296,11 +90614,16 @@ paths: name: returnPartialSuccess schema: type: boolean - /projects/{project}/regions/{region}/backendServices/{backendService}: + /projects/{project}/global/interconnects/{interconnect}/getDiagnostics: parameters: *ref_1 get: - description: Returns the specified regional BackendService resource. - operationId: compute.regionBackendServices.get + description: >- + Returns the interconnectDiagnostics for the specified Interconnect. In + the event of a global outage, do not use this API to make decisions + about where to redirect your network traffic. Unlike a VLAN attachment, + which is regional, a Cloud Interconnect connection is a global resource. + A global outage can prevent this API from functioning properly. + operationId: compute.interconnects.getDiagnostics security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -83320,7 +90643,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BackendService' + $ref: '#/components/schemas/InterconnectsGetDiagnosticsResponse' parameters: - in: path name: project @@ -83328,18 +90651,15 @@ paths: schema: type: string - in: path - name: region - required: true - schema: - type: string - - in: path - name: backendService + name: interconnect required: true schema: type: string - delete: - description: Deletes the specified regional BackendService resource. - operationId: compute.regionBackendServices.delete + /projects/{project}/global/interconnects/{interconnect}/getMacsecConfig: + parameters: *ref_1 + get: + description: Returns the interconnectMacsecConfig for the specified Interconnect. + operationId: compute.interconnects.getMacsecConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -83349,13 +90669,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/InterconnectsGetMacsecConfigResponse' parameters: - in: path name: project @@ -83363,30 +90687,51 @@ paths: schema: type: string - in: path - name: region + name: interconnect required: true schema: type: string + /projects/{project}/global/interconnects/{interconnect}: + parameters: *ref_1 + get: + description: >- + Returns the specified Interconnect. Get a list of available + Interconnects by making a list() request. + operationId: compute.interconnects.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Interconnect' + parameters: - in: path - name: backendService + name: project required: true schema: type: string - - in: query - name: requestId + - in: path + name: interconnect + required: true schema: type: string - 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 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/BackendService' + delete: + description: Deletes the specified Interconnect. + operationId: compute.interconnects.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -83410,12 +90755,7 @@ paths: schema: type: string - in: path - name: region - required: true - schema: - type: string - - in: path - name: backendService + name: interconnect required: true schema: type: string @@ -83425,16 +90765,15 @@ paths: type: string 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 + 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.regionBackendServices.patch + operationId: compute.interconnects.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/BackendService' + $ref: '#/components/schemas/Interconnect' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -83458,12 +90797,7 @@ paths: schema: type: string - in: path - name: region - required: true - schema: - type: string - - in: path - name: backendService + name: interconnect required: true schema: type: string @@ -83471,18 +90805,18 @@ paths: name: requestId schema: type: string - /projects/{project}/regions/{region}/backendServices/{backendService}/setSecurityPolicy: + /projects/{project}/global/interconnects/{resource}/setLabels: parameters: *ref_1 post: description: >- - Sets the Google Cloud Armor security policy for the specified backend - service. For more information, see Google Cloud Armor Overview - operationId: compute.regionBackendServices.setSecurityPolicy + Sets the labels on an Interconnect. To learn more about labels, read the + Labeling Resources documentation. + operationId: compute.interconnects.setLabels requestBody: content: application/json: schema: - $ref: '#/components/schemas/SecurityPolicyReference' + $ref: '#/components/schemas/GlobalSetLabelsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -83506,31 +90840,72 @@ paths: schema: type: string - in: path - name: region + name: resource required: true schema: type: string + /projects/{project}/global/interconnectGroups: + parameters: *ref_1 + get: + description: Lists the InterconnectGroups for a project in the given scope. + operationId: compute.interconnectGroups.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/InterconnectGroupsListResponse' + parameters: - in: path - name: backendService + name: project required: true schema: type: string - in: query - name: requestId + name: filter schema: type: string - /projects/{project}/regions/{region}/backendServices/{backendService}/getHealth: - parameters: *ref_1 + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean post: description: >- - Gets the most recent health check results for this regional - BackendService. - operationId: compute.regionBackendServices.getHealth + Creates a InterconnectGroup in the specified project in the given scope + using the parameters that are included in the request. + operationId: compute.interconnectGroups.insert requestBody: content: application/json: schema: - $ref: '#/components/schemas/ResourceGroupReference' + $ref: '#/components/schemas/InterconnectGroup' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -83540,40 +90915,28 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/BackendServiceGroupHealth' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project required: true schema: type: string - - in: path - name: region - required: true - schema: - type: string - - in: path - name: backendService - required: true + - in: query + name: requestId schema: type: string - /projects/{project}/regions/{region}/backendServices/{resource}/getIamPolicy: + /projects/{project}/global/interconnectGroups/{interconnectGroup}: parameters: *ref_1 get: - description: >- - Gets the access control policy for a resource. May be empty if no such - policy or resource exists. - operationId: compute.regionBackendServices.getIamPolicy + description: Returns the specified InterconnectGroup resource in the given scope. + operationId: compute.interconnectGroups.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -83593,7 +90956,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/InterconnectGroup' parameters: - in: path name: project @@ -83601,32 +90964,13 @@ paths: schema: type: string - in: path - name: region - required: true - schema: - type: string - - in: path - name: resource + name: interconnectGroup required: true schema: type: string - - in: query - name: optionsRequestedPolicyVersion - schema: - type: integer - format: int32 - /projects/{project}/regions/{region}/backendServices/{resource}/setIamPolicy: - parameters: *ref_1 - post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. - operationId: compute.regionBackendServices.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RegionSetPolicyRequest' + delete: + description: Deletes the specified InterconnectGroup in the given scope + operationId: compute.interconnectGroups.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -83642,7 +90986,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -83650,25 +90994,25 @@ paths: schema: type: string - in: path - name: region + name: interconnectGroup required: true schema: type: string - - in: path - name: resource - required: true + - in: query + name: requestId schema: type: string - /projects/{project}/regions/{region}/backendServices/{resource}/testIamPermissions: - parameters: *ref_1 - post: - description: Returns permissions that a caller has on the specified resource. - operationId: compute.regionBackendServices.testIamPermissions + patch: + description: >- + Patches the specified InterconnectGroup resource with the data included + in the request. This method supports PATCH semantics and uses JSON merge + patch format and processing rules. + operationId: compute.interconnectGroups.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/TestPermissionsRequest' + $ref: '#/components/schemas/InterconnectGroup' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -83678,17 +91022,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/TestPermissionsResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -83696,20 +91036,24 @@ paths: schema: type: string - in: path - name: region + name: interconnectGroup required: true schema: type: string - - in: path - name: resource - required: true + - in: query + name: requestId schema: type: string - /projects/{project}/regions/{region}/commitments: + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /projects/{project}/global/interconnectGroups/{interconnectGroup}/getOperationalStatus: parameters: *ref_1 get: - description: Retrieves a list of commitments contained within the specified region. - operationId: compute.regionCommitments.list + description: Returns the interconnectStatuses for the specified InterconnectGroup. + operationId: compute.interconnectGroups.getOperationalStatus security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -83729,7 +91073,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CommitmentList' + $ref: >- + #/components/schemas/InterconnectGroupsGetOperationalStatusResponse parameters: - in: path name: project @@ -83737,41 +91082,17 @@ paths: schema: type: string - in: path - name: region + name: interconnectGroup required: true - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: returnPartialSuccess - schema: - type: boolean - post: - description: >- - Creates a commitment in the specified project using the data included in - the request. - operationId: compute.regionCommitments.insert - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Commitment' + schema: + type: string + /projects/{project}/global/interconnectGroups/{resource}/getIamPolicy: + parameters: *ref_1 + get: + description: >- + Gets the access control policy for a resource. May be empty if no such + policy or resource exists. + operationId: compute.interconnectGroups.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -83781,13 +91102,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Policy' parameters: - in: path name: project @@ -83795,22 +91120,27 @@ paths: schema: type: string - in: path - name: region + name: resource required: true schema: type: string - in: query - name: requestId + name: optionsRequestedPolicyVersion schema: - type: string - /projects/{project}/aggregated/commitments: + type: integer + format: int32 + /projects/{project}/global/interconnectGroups/{resource}/setIamPolicy: parameters: *ref_1 - get: + post: description: >- - Retrieves an aggregated list of commitments by region. To prevent - failure, Google recommends that you set the `returnPartialSuccess` - parameter to `true`. - operationId: compute.regionCommitments.aggregatedList + Sets the access control policy on the specified resource. Replaces any + existing policy. + operationId: compute.interconnectGroups.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GlobalSetPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -83820,58 +91150,34 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/CommitmentAggregatedList' + $ref: '#/components/schemas/Policy' parameters: - in: path name: project required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: includeAllScopes - schema: - type: boolean - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: returnPartialSuccess - schema: - type: boolean - - in: query - name: serviceProjectNumber + - in: path + name: resource + required: true schema: type: string - format: int64 - /projects/{project}/regions/{region}/commitments/{commitment}: + /projects/{project}/global/interconnectGroups/{resource}/testIamPermissions: parameters: *ref_1 - get: - description: Returns the specified commitment resource. - operationId: compute.regionCommitments.get + post: + description: Returns permissions that a caller has on the specified resource. + operationId: compute.interconnectGroups.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -83891,7 +91197,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Commitment' + $ref: '#/components/schemas/TestPermissionsResponse' parameters: - in: path name: project @@ -83899,26 +91205,22 @@ paths: schema: type: string - in: path - name: region - required: true - schema: - type: string - - in: path - name: commitment + name: resource required: true schema: type: string - patch: + /projects/{project}/global/interconnectGroups/{interconnectGroup}/createMembers: + parameters: *ref_1 + post: description: >- - Updates the specified commitment with the data included in the request. - Update is performed only on selected fields included as part of - update-mask. Only the following fields can be modified: auto_renew. - operationId: compute.regionCommitments.update + Create Interconnects with redundancy by creating them in a specified + interconnect group. + operationId: compute.interconnectGroups.createMembers requestBody: content: application/json: schema: - $ref: '#/components/schemas/Commitment' + $ref: '#/components/schemas/InterconnectGroupsCreateMembersRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -83942,33 +91244,22 @@ paths: schema: type: string - in: path - name: region - required: true - schema: - type: string - - in: path - name: commitment + name: interconnectGroup required: true schema: type: string - - in: query - name: paths - schema: - type: string - - in: query - name: requestId - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /projects/{project}/zones/{zone}/diskTypes: + /projects/{project}/global/externalVpnGateways: parameters: *ref_1 - get: - description: Retrieves a list of disk types available to the specified project. - operationId: compute.diskTypes.list + post: + description: >- + Creates a ExternalVpnGateway in the specified project using the data + included in the request. + operationId: compute.externalVpnGateways.insert + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExternalVpnGateway' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -83978,56 +91269,28 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/DiskTypeList' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project required: true schema: type: string - - in: path - name: zone - required: true - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy - schema: - type: string - in: query - name: pageToken + name: requestId schema: type: string - - in: query - name: returnPartialSuccess - schema: - type: boolean - /projects/{project}/aggregated/diskTypes: - parameters: *ref_1 get: description: >- - Retrieves an aggregated list of disk types. To prevent failure, Google - recommends that you set the `returnPartialSuccess` parameter to `true`. - operationId: compute.diskTypes.aggregatedList + Retrieves the list of ExternalVpnGateway available to the specified + project. + operationId: compute.externalVpnGateways.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -84047,7 +91310,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DiskTypeAggregatedList' + $ref: '#/components/schemas/ExternalVpnGatewayList' parameters: - in: path name: project @@ -84058,10 +91321,6 @@ paths: name: filter schema: type: string - - in: query - name: includeAllScopes - schema: - type: boolean - in: query name: maxResults schema: @@ -84079,16 +91338,13 @@ paths: name: returnPartialSuccess schema: type: boolean - - in: query - name: serviceProjectNumber - schema: - type: string - format: int64 - /projects/{project}/zones/{zone}/diskTypes/{diskType}: + /projects/{project}/global/externalVpnGateways/{externalVpnGateway}: parameters: *ref_1 get: - description: Returns the specified disk type. - operationId: compute.diskTypes.get + description: >- + Returns the specified externalVpnGateway. Get a list of available + externalVpnGateways by making a list() request. + operationId: compute.externalVpnGateways.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -84108,7 +91364,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DiskType' + $ref: '#/components/schemas/ExternalVpnGateway' parameters: - in: path name: project @@ -84116,22 +91372,13 @@ paths: schema: type: string - in: path - name: zone - required: true - schema: - type: string - - in: path - name: diskType + name: externalVpnGateway required: true schema: type: string - /projects/{project}/regions/{region}/diskTypes: - parameters: *ref_1 - get: - description: >- - Retrieves a list of regional disk types available to the specified - project. - operationId: compute.regionDiskTypes.list + delete: + description: Deletes the specified externalVpnGateway. + operationId: compute.externalVpnGateways.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -84141,17 +91388,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/RegionDiskTypeList' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -84159,36 +91402,24 @@ paths: schema: type: string - in: path - name: region + name: externalVpnGateway required: true schema: type: string - in: query - name: filter - schema: - type: string - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken + name: requestId schema: type: string - - in: query - name: returnPartialSuccess - schema: - type: boolean - /projects/{project}/regions/{region}/diskTypes/{diskType}: + /projects/{project}/global/externalVpnGateways/{resource}/testIamPermissions: parameters: *ref_1 - get: - description: Returns the specified regional disk type. - operationId: compute.regionDiskTypes.get + post: + description: Returns permissions that a caller has on the specified resource. + operationId: compute.externalVpnGateways.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -84208,7 +91439,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DiskType' + $ref: '#/components/schemas/TestPermissionsResponse' parameters: - in: path name: project @@ -84216,27 +91447,22 @@ paths: schema: type: string - in: path - name: region - required: true - schema: - type: string - - in: path - name: diskType + name: resource required: true schema: type: string - /projects/{project}/global/externalVpnGateways: + /projects/{project}/global/externalVpnGateways/{resource}/setLabels: parameters: *ref_1 post: description: >- - Creates a ExternalVpnGateway in the specified project using the data - included in the request. - operationId: compute.externalVpnGateways.insert + Sets the labels on an ExternalVpnGateway. To learn more about labels, + read the Labeling Resources documentation. + operationId: compute.externalVpnGateways.setLabels requestBody: content: application/json: schema: - $ref: '#/components/schemas/ExternalVpnGateway' + $ref: '#/components/schemas/GlobalSetLabelsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -84259,15 +91485,18 @@ paths: required: true schema: type: string - - in: query - name: requestId + - in: path + name: resource + required: true schema: type: string + /projects/{project}/global/forwardingRules: + parameters: *ref_1 get: description: >- - Retrieves the list of ExternalVpnGateway available to the specified - project. - operationId: compute.externalVpnGateways.list + Retrieves a list of GlobalForwardingRule resources available to the + specified project. + operationId: compute.globalForwardingRules.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -84287,7 +91516,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ExternalVpnGatewayList' + $ref: '#/components/schemas/ForwardingRuleList' parameters: - in: path name: project @@ -84315,13 +91544,49 @@ paths: name: returnPartialSuccess schema: type: boolean - /projects/{project}/global/externalVpnGateways/{externalVpnGateway}: + post: + description: >- + Creates a GlobalForwardingRule resource in the specified project using + the data included in the request. + operationId: compute.globalForwardingRules.insert + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ForwardingRule' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + /projects/{project}/global/forwardingRules/{forwardingRule}: parameters: *ref_1 get: description: >- - Returns the specified externalVpnGateway. Get a list of available - externalVpnGateways by making a list() request. - operationId: compute.externalVpnGateways.get + Returns the specified GlobalForwardingRule resource. Gets a list of + available forwarding rules by making a list() request. + operationId: compute.globalForwardingRules.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -84341,7 +91606,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ExternalVpnGateway' + $ref: '#/components/schemas/ForwardingRule' parameters: - in: path name: project @@ -84349,13 +91614,13 @@ paths: schema: type: string - in: path - name: externalVpnGateway + name: forwardingRule required: true schema: type: string delete: - description: Deletes the specified externalVpnGateway. - operationId: compute.externalVpnGateways.delete + description: Deletes the specified GlobalForwardingRule resource. + operationId: compute.globalForwardingRules.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -84379,7 +91644,7 @@ paths: schema: type: string - in: path - name: externalVpnGateway + name: forwardingRule required: true schema: type: string @@ -84387,16 +91652,18 @@ paths: name: requestId schema: type: string - /projects/{project}/global/externalVpnGateways/{resource}/testIamPermissions: - parameters: *ref_1 - post: - description: Returns permissions that a caller has on the specified resource. - operationId: compute.externalVpnGateways.testIamPermissions + 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 requestBody: content: application/json: schema: - $ref: '#/components/schemas/TestPermissionsRequest' + $ref: '#/components/schemas/ForwardingRule' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -84406,17 +91673,56 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: forwardingRule + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + /projects/{project}/global/forwardingRules/{forwardingRule}/setTarget: + parameters: *ref_1 + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TargetReference' + security: - Oauth2: - - https://www.googleapis.com/auth/compute.readonly + - https://www.googleapis.com/auth/cloud-platform Oauth2c: - - https://www.googleapis.com/auth/compute.readonly + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/TestPermissionsResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -84424,17 +91730,21 @@ paths: schema: type: string - in: path - name: resource + name: forwardingRule required: true schema: type: string - /projects/{project}/global/externalVpnGateways/{resource}/setLabels: + - in: query + name: requestId + schema: + type: string + /projects/{project}/global/forwardingRules/{resource}/setLabels: parameters: *ref_1 post: description: >- - Sets the labels on an ExternalVpnGateway. To learn more about labels, - read the Labeling Resources documentation. - operationId: compute.externalVpnGateways.setLabels + Sets the labels on the specified resource. To learn more about labels, + read the Labeling resources documentation. + operationId: compute.globalForwardingRules.setLabels requestBody: content: application/json: @@ -84467,13 +91777,13 @@ paths: required: true schema: type: string - /projects/{project}/global/forwardingRules: + /projects/{project}/regions/{region}/forwardingRules: parameters: *ref_1 get: description: >- - Retrieves a list of GlobalForwardingRule resources available to the - specified project. - operationId: compute.globalForwardingRules.list + Retrieves a list of ForwardingRule resources available to the specified + project and region. + operationId: compute.forwardingRules.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -84500,6 +91810,11 @@ paths: required: true schema: type: string + - in: path + name: region + required: true + schema: + type: string - in: query name: filter schema: @@ -84523,9 +91838,9 @@ paths: type: boolean post: description: >- - Creates a GlobalForwardingRule resource in the specified project using - the data included in the request. - operationId: compute.globalForwardingRules.insert + Creates a ForwardingRule resource in the specified project and region + using the data included in the request. + operationId: compute.forwardingRules.insert requestBody: content: application/json: @@ -84553,17 +91868,84 @@ paths: required: true schema: type: string + - in: path + name: region + required: true + schema: + type: string - in: query name: requestId schema: type: string - /projects/{project}/global/forwardingRules/{forwardingRule}: + /projects/{project}/aggregated/forwardingRules: parameters: *ref_1 get: description: >- - Returns the specified GlobalForwardingRule resource. Gets a list of - available forwarding rules by making a list() request. - operationId: compute.globalForwardingRules.get + Retrieves an aggregated list of forwarding rules. To prevent failure, + Google recommends that you set the `returnPartialSuccess` parameter to + `true`. + operationId: compute.forwardingRules.aggregatedList + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ForwardingRuleAggregatedList' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: includeAllScopes + schema: + type: boolean + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean + - in: query + name: serviceProjectNumber + schema: + type: string + format: int64 + /projects/{project}/regions/{region}/forwardingRules/{forwardingRule}: + parameters: *ref_1 + get: + description: Returns the specified ForwardingRule resource. + operationId: compute.forwardingRules.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -84590,14 +91972,19 @@ paths: required: true schema: type: string + - in: path + name: region + required: true + schema: + type: string - in: path name: forwardingRule required: true schema: type: string delete: - description: Deletes the specified GlobalForwardingRule resource. - operationId: compute.globalForwardingRules.delete + description: Deletes the specified ForwardingRule resource. + operationId: compute.forwardingRules.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -84620,6 +92007,11 @@ paths: required: true schema: type: string + - in: path + name: region + required: true + schema: + type: string - in: path name: forwardingRule required: true @@ -84635,7 +92027,7 @@ paths: 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 + operationId: compute.forwardingRules.patch requestBody: content: application/json: @@ -84663,6 +92055,11 @@ paths: required: true schema: type: string + - in: path + name: region + required: true + schema: + type: string - in: path name: forwardingRule required: true @@ -84672,13 +92069,13 @@ paths: name: requestId schema: type: string - /projects/{project}/global/forwardingRules/{forwardingRule}/setTarget: + /projects/{project}/regions/{region}/forwardingRules/{forwardingRule}/setTarget: parameters: *ref_1 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 + Changes target URL for forwarding rule. The new target should be of the + same type as the old target. + operationId: compute.forwardingRules.setTarget requestBody: content: application/json: @@ -84706,6 +92103,11 @@ paths: required: true schema: type: string + - in: path + name: region + required: true + schema: + type: string - in: path name: forwardingRule required: true @@ -84715,18 +92117,18 @@ paths: name: requestId schema: type: string - /projects/{project}/global/forwardingRules/{resource}/setLabels: + /projects/{project}/regions/{region}/forwardingRules/{resource}/setLabels: parameters: *ref_1 post: description: >- Sets the labels on the specified resource. To learn more about labels, - read the Labeling resources documentation. - operationId: compute.globalForwardingRules.setLabels + read the Labeling Resources documentation. + operationId: compute.forwardingRules.setLabels requestBody: content: application/json: schema: - $ref: '#/components/schemas/GlobalSetLabelsRequest' + $ref: '#/components/schemas/RegionSetLabelsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -84749,18 +92151,27 @@ paths: required: true schema: type: string + - in: path + name: region + required: true + schema: + type: string - in: path name: resource required: true schema: type: string - /projects/{project}/regions/{region}/forwardingRules: + - in: query + name: requestId + schema: + type: string + /projects/{project}/regions/{region}/healthCheckServices: parameters: *ref_1 get: description: >- - Retrieves a list of ForwardingRule resources available to the specified - project and region. - operationId: compute.forwardingRules.list + Lists all the HealthCheckService resources that have been configured for + the specified project in the given region. + operationId: compute.regionHealthCheckServices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -84780,7 +92191,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ForwardingRuleList' + $ref: '#/components/schemas/HealthCheckServicesList' parameters: - in: path name: project @@ -84815,14 +92226,14 @@ paths: type: boolean post: description: >- - Creates a ForwardingRule resource in the specified project and region - using the data included in the request. - operationId: compute.forwardingRules.insert + Creates a regional HealthCheckService resource in the specified project + and region using the data included in the request. + operationId: compute.regionHealthCheckServices.insert requestBody: content: application/json: schema: - $ref: '#/components/schemas/ForwardingRule' + $ref: '#/components/schemas/HealthCheckService' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -84854,75 +92265,11 @@ paths: name: requestId schema: type: string - /projects/{project}/aggregated/forwardingRules: - parameters: *ref_1 - get: - description: >- - Retrieves an aggregated list of forwarding rules. To prevent failure, - Google recommends that you set the `returnPartialSuccess` parameter to - `true`. - operationId: compute.forwardingRules.aggregatedList - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/compute - Oauth2c: - - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/ForwardingRuleAggregatedList' - parameters: - - in: path - name: project - required: true - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: includeAllScopes - schema: - type: boolean - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: returnPartialSuccess - schema: - type: boolean - - in: query - name: serviceProjectNumber - schema: - type: string - format: int64 - /projects/{project}/regions/{region}/forwardingRules/{forwardingRule}: + /projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}: parameters: *ref_1 get: - description: Returns the specified ForwardingRule resource. - operationId: compute.forwardingRules.get + description: Returns the specified regional HealthCheckService resource. + operationId: compute.regionHealthCheckServices.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -84942,7 +92289,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ForwardingRule' + $ref: '#/components/schemas/HealthCheckService' parameters: - in: path name: project @@ -84955,13 +92302,13 @@ paths: schema: type: string - in: path - name: forwardingRule + name: healthCheckService required: true schema: type: string delete: - description: Deletes the specified ForwardingRule resource. - operationId: compute.forwardingRules.delete + description: Deletes the specified regional HealthCheckService. + operationId: compute.regionHealthCheckServices.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -84990,7 +92337,7 @@ paths: schema: type: string - in: path - name: forwardingRule + name: healthCheckService required: true schema: type: string @@ -85000,16 +92347,15 @@ paths: type: string 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 + 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 requestBody: content: application/json: schema: - $ref: '#/components/schemas/ForwardingRule' + $ref: '#/components/schemas/HealthCheckService' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -85038,7 +92384,7 @@ paths: schema: type: string - in: path - name: forwardingRule + name: healthCheckService required: true schema: type: string @@ -85046,18 +92392,13 @@ paths: name: requestId schema: type: string - /projects/{project}/regions/{region}/forwardingRules/{forwardingRule}/setTarget: + /projects/{project}/global/healthChecks: parameters: *ref_1 - post: + get: description: >- - Changes target URL for forwarding rule. The new target should be of the - same type as the old target. - operationId: compute.forwardingRules.setTarget - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TargetReference' + Retrieves the list of HealthCheck resources available to the specified + project. + operationId: compute.healthChecks.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -85067,45 +92408,54 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/HealthCheckList' parameters: - in: path name: project required: true schema: type: string - - in: path - name: region - required: true + - in: query + name: filter schema: type: string - - in: path - name: forwardingRule - required: true + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy schema: type: string - in: query - name: requestId + name: pageToken schema: type: string - /projects/{project}/regions/{region}/forwardingRules/{resource}/setLabels: - parameters: *ref_1 + - in: query + name: returnPartialSuccess + schema: + type: boolean post: description: >- - Sets the labels on the specified resource. To learn more about labels, - read the Labeling Resources documentation. - operationId: compute.forwardingRules.setLabels + Creates a HealthCheck resource in the specified project using the data + included in the request. + operationId: compute.healthChecks.insert requestBody: content: application/json: schema: - $ref: '#/components/schemas/RegionSetLabelsRequest' + $ref: '#/components/schemas/HealthCheck' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -85128,27 +92478,18 @@ paths: required: true schema: type: string - - in: path - name: region - required: true - schema: - type: string - - in: path - name: resource - required: true - schema: - type: string - in: query name: requestId schema: type: string - /projects/{project}/regions/{region}/healthCheckServices: + /projects/{project}/aggregated/healthChecks: parameters: *ref_1 get: description: >- - Lists all the HealthCheckService resources that have been configured for - the specified project in the given region. - operationId: compute.regionHealthCheckServices.list + Retrieves the list of all HealthCheck resources, regional and global, + available to the specified project. To prevent failure, Google + recommends that you set the `returnPartialSuccess` parameter to `true`. + operationId: compute.healthChecks.aggregatedList security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -85168,22 +92509,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/HealthCheckServicesList' + $ref: '#/components/schemas/HealthChecksAggregatedList' parameters: - in: path name: project required: true schema: type: string - - in: path - name: region - required: true - schema: - type: string - in: query name: filter schema: type: string + - in: query + name: includeAllScopes + schema: + type: boolean - in: query name: maxResults schema: @@ -85201,16 +92541,50 @@ paths: name: returnPartialSuccess schema: type: boolean - post: - description: >- - Creates a regional HealthCheckService resource in the specified project - and region using the data included in the request. - operationId: compute.regionHealthCheckServices.insert - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/HealthCheckService' + - in: query + name: serviceProjectNumber + schema: + type: string + format: int64 + /projects/{project}/global/healthChecks/{healthCheck}: + parameters: *ref_1 + get: + description: Returns the specified HealthCheck resource. + operationId: compute.healthChecks.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/HealthCheck' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: healthCheck + required: true + schema: + type: string + delete: + description: Deletes the specified HealthCheck resource. + operationId: compute.healthChecks.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -85234,7 +92608,7 @@ paths: schema: type: string - in: path - name: region + name: healthCheck required: true schema: type: string @@ -85242,50 +92616,16 @@ paths: name: requestId schema: type: string - /projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}: - parameters: *ref_1 - get: - description: Returns the specified regional HealthCheckService resource. - operationId: compute.regionHealthCheckServices.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/compute - Oauth2c: - - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/HealthCheckService' - parameters: - - in: path - name: project - required: true - schema: - type: string - - in: path - name: region - required: true - schema: - type: string - - in: path - name: healthCheckService - required: true - schema: - type: string - delete: - description: Deletes the specified regional HealthCheckService. - operationId: compute.regionHealthCheckServices.delete + put: + description: >- + Updates a HealthCheck resource in the specified project using the data + included in the request. + operationId: compute.healthChecks.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/HealthCheck' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -85309,12 +92649,7 @@ paths: schema: type: string - in: path - name: region - required: true - schema: - type: string - - in: path - name: healthCheckService + name: healthCheck required: true schema: type: string @@ -85324,15 +92659,15 @@ paths: type: string patch: description: >- - Updates the specified regional HealthCheckService resource with the data + 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.regionHealthCheckServices.patch + operationId: compute.healthChecks.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/HealthCheckService' + $ref: '#/components/schemas/HealthCheck' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -85356,12 +92691,7 @@ paths: schema: type: string - in: path - name: region - required: true - schema: - type: string - - in: path - name: healthCheckService + name: healthCheck required: true schema: type: string @@ -85369,13 +92699,13 @@ paths: name: requestId schema: type: string - /projects/{project}/global/healthChecks: + /projects/{project}/regions/{region}/healthChecks: parameters: *ref_1 get: description: >- Retrieves the list of HealthCheck resources available to the specified project. - operationId: compute.healthChecks.list + operationId: compute.regionHealthChecks.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -85402,6 +92732,11 @@ paths: required: true schema: type: string + - in: path + name: region + required: true + schema: + type: string - in: query name: filter schema: @@ -85427,7 +92762,7 @@ paths: description: >- Creates a HealthCheck resource in the specified project using the data included in the request. - operationId: compute.healthChecks.insert + operationId: compute.regionHealthChecks.insert requestBody: content: application/json: @@ -85455,79 +92790,20 @@ paths: required: true schema: type: string - - in: query - name: requestId - schema: - type: string - /projects/{project}/aggregated/healthChecks: - parameters: *ref_1 - get: - description: >- - Retrieves the list of all HealthCheck resources, regional and global, - available to the specified project. To prevent failure, Google - recommends that you set the `returnPartialSuccess` parameter to `true`. - operationId: compute.healthChecks.aggregatedList - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/compute - Oauth2c: - - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/HealthChecksAggregatedList' - parameters: - in: path - name: project + name: region required: true schema: type: string - in: query - name: filter - schema: - type: string - - in: query - name: includeAllScopes - schema: - type: boolean - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: returnPartialSuccess - schema: - type: boolean - - in: query - name: serviceProjectNumber + name: requestId schema: type: string - format: int64 - /projects/{project}/global/healthChecks/{healthCheck}: + /projects/{project}/regions/{region}/healthChecks/{healthCheck}: parameters: *ref_1 get: description: Returns the specified HealthCheck resource. - operationId: compute.healthChecks.get + operationId: compute.regionHealthChecks.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -85554,6 +92830,11 @@ paths: required: true schema: type: string + - in: path + name: region + required: true + schema: + type: string - in: path name: healthCheck required: true @@ -85561,7 +92842,7 @@ paths: type: string delete: description: Deletes the specified HealthCheck resource. - operationId: compute.healthChecks.delete + operationId: compute.regionHealthChecks.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -85584,6 +92865,11 @@ paths: required: true schema: type: string + - in: path + name: region + required: true + schema: + type: string - in: path name: healthCheck required: true @@ -85597,7 +92883,7 @@ paths: description: >- Updates a HealthCheck resource in the specified project using the data included in the request. - operationId: compute.healthChecks.update + operationId: compute.regionHealthChecks.update requestBody: content: application/json: @@ -85625,6 +92911,11 @@ paths: required: true schema: type: string + - in: path + name: region + required: true + schema: + type: string - in: path name: healthCheck required: true @@ -85639,7 +92930,7 @@ paths: 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 + operationId: compute.regionHealthChecks.patch requestBody: content: application/json: @@ -85667,6 +92958,11 @@ paths: required: true schema: type: string + - in: path + name: region + required: true + schema: + type: string - in: path name: healthCheck required: true @@ -85676,13 +92972,13 @@ paths: name: requestId schema: type: string - /projects/{project}/regions/{region}/healthChecks: + /projects/{project}/global/httpHealthChecks: parameters: *ref_1 get: description: >- - Retrieves the list of HealthCheck resources available to the specified - project. - operationId: compute.regionHealthChecks.list + Retrieves the list of HttpHealthCheck resources available to the + specified project. + operationId: compute.httpHealthChecks.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -85702,18 +92998,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/HealthCheckList' + $ref: '#/components/schemas/HttpHealthCheckList' parameters: - in: path name: project required: true schema: type: string - - in: path - name: region - required: true - schema: - type: string - in: query name: filter schema: @@ -85737,14 +93028,14 @@ paths: type: boolean post: description: >- - Creates a HealthCheck resource in the specified project using the data - included in the request. - operationId: compute.regionHealthChecks.insert + Creates a HttpHealthCheck resource in the specified project using the + data included in the request. + operationId: compute.httpHealthChecks.insert requestBody: content: application/json: schema: - $ref: '#/components/schemas/HealthCheck' + $ref: '#/components/schemas/HttpHealthCheck' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -85767,20 +93058,15 @@ paths: required: true schema: type: string - - in: path - name: region - required: true - schema: - type: string - in: query name: requestId schema: type: string - /projects/{project}/regions/{region}/healthChecks/{healthCheck}: + /projects/{project}/global/httpHealthChecks/{httpHealthCheck}: parameters: *ref_1 get: - description: Returns the specified HealthCheck resource. - operationId: compute.regionHealthChecks.get + description: Returns the specified HttpHealthCheck resource. + operationId: compute.httpHealthChecks.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -85800,7 +93086,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/HealthCheck' + $ref: '#/components/schemas/HttpHealthCheck' parameters: - in: path name: project @@ -85808,18 +93094,13 @@ paths: schema: type: string - in: path - name: region - required: true - schema: - type: string - - in: path - name: healthCheck + name: httpHealthCheck required: true schema: type: string delete: - description: Deletes the specified HealthCheck resource. - operationId: compute.regionHealthChecks.delete + description: Deletes the specified HttpHealthCheck resource. + operationId: compute.httpHealthChecks.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -85843,12 +93124,7 @@ paths: schema: type: string - in: path - name: region - required: true - schema: - type: string - - in: path - name: healthCheck + name: httpHealthCheck required: true schema: type: string @@ -85858,14 +93134,14 @@ paths: type: string put: description: >- - Updates a HealthCheck resource in the specified project using the data - included in the request. - operationId: compute.regionHealthChecks.update + Updates a HttpHealthCheck resource in the specified project using the + data included in the request. + operationId: compute.httpHealthChecks.update requestBody: content: application/json: schema: - $ref: '#/components/schemas/HealthCheck' + $ref: '#/components/schemas/HttpHealthCheck' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -85889,12 +93165,7 @@ paths: schema: type: string - in: path - name: region - required: true - schema: - type: string - - in: path - name: healthCheck + name: httpHealthCheck required: true schema: type: string @@ -85904,15 +93175,15 @@ paths: type: string 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 + 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 requestBody: content: application/json: schema: - $ref: '#/components/schemas/HealthCheck' + $ref: '#/components/schemas/HttpHealthCheck' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -85936,12 +93207,7 @@ paths: schema: type: string - in: path - name: region - required: true - schema: - type: string - - in: path - name: healthCheck + name: httpHealthCheck required: true schema: type: string @@ -85949,13 +93215,13 @@ paths: name: requestId schema: type: string - /projects/{project}/global/httpHealthChecks: + /projects/{project}/global/httpsHealthChecks: parameters: *ref_1 get: description: >- - Retrieves the list of HttpHealthCheck resources available to the + Retrieves the list of HttpsHealthCheck resources available to the specified project. - operationId: compute.httpHealthChecks.list + operationId: compute.httpsHealthChecks.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -85975,7 +93241,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/HttpHealthCheckList' + $ref: '#/components/schemas/HttpsHealthCheckList' parameters: - in: path name: project @@ -86005,14 +93271,14 @@ paths: type: boolean post: description: >- - Creates a HttpHealthCheck resource in the specified project using the + Creates a HttpsHealthCheck resource in the specified project using the data included in the request. - operationId: compute.httpHealthChecks.insert + operationId: compute.httpsHealthChecks.insert requestBody: content: application/json: schema: - $ref: '#/components/schemas/HttpHealthCheck' + $ref: '#/components/schemas/HttpsHealthCheck' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -86039,11 +93305,11 @@ paths: name: requestId schema: type: string - /projects/{project}/global/httpHealthChecks/{httpHealthCheck}: + /projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}: parameters: *ref_1 get: - description: Returns the specified HttpHealthCheck resource. - operationId: compute.httpHealthChecks.get + description: Returns the specified HttpsHealthCheck resource. + operationId: compute.httpsHealthChecks.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -86063,7 +93329,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/HttpHealthCheck' + $ref: '#/components/schemas/HttpsHealthCheck' parameters: - in: path name: project @@ -86071,13 +93337,13 @@ paths: schema: type: string - in: path - name: httpHealthCheck + name: httpsHealthCheck required: true schema: type: string delete: - description: Deletes the specified HttpHealthCheck resource. - operationId: compute.httpHealthChecks.delete + description: Deletes the specified HttpsHealthCheck resource. + operationId: compute.httpsHealthChecks.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -86101,7 +93367,7 @@ paths: schema: type: string - in: path - name: httpHealthCheck + name: httpsHealthCheck required: true schema: type: string @@ -86111,14 +93377,14 @@ paths: type: string put: description: >- - Updates a HttpHealthCheck resource in the specified project using the + Updates a HttpsHealthCheck resource in the specified project using the data included in the request. - operationId: compute.httpHealthChecks.update + operationId: compute.httpsHealthChecks.update requestBody: content: application/json: schema: - $ref: '#/components/schemas/HttpHealthCheck' + $ref: '#/components/schemas/HttpsHealthCheck' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -86142,7 +93408,7 @@ paths: schema: type: string - in: path - name: httpHealthCheck + name: httpsHealthCheck required: true schema: type: string @@ -86152,15 +93418,15 @@ paths: type: string patch: description: >- - Updates a HttpHealthCheck resource in the specified project using the + 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.httpHealthChecks.patch + operationId: compute.httpsHealthChecks.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/HttpHealthCheck' + $ref: '#/components/schemas/HttpsHealthCheck' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -86184,7 +93450,7 @@ paths: schema: type: string - in: path - name: httpHealthCheck + name: httpsHealthCheck required: true schema: type: string @@ -86192,13 +93458,13 @@ paths: name: requestId schema: type: string - /projects/{project}/global/httpsHealthChecks: + /projects/{project}/global/instanceTemplates: parameters: *ref_1 get: description: >- - Retrieves the list of HttpsHealthCheck resources available to the + Retrieves a list of instance templates that are contained within the specified project. - operationId: compute.httpsHealthChecks.list + operationId: compute.instanceTemplates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -86218,7 +93484,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/HttpsHealthCheckList' + $ref: '#/components/schemas/InstanceTemplateList' parameters: - in: path name: project @@ -86248,14 +93514,17 @@ paths: type: boolean post: description: >- - Creates a HttpsHealthCheck resource in the specified project using the - data included in the request. - operationId: compute.httpsHealthChecks.insert + 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 requestBody: content: application/json: schema: - $ref: '#/components/schemas/HttpsHealthCheck' + $ref: '#/components/schemas/InstanceTemplate' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -86282,11 +93551,11 @@ paths: name: requestId schema: type: string - /projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}: + /projects/{project}/global/instanceTemplates/{instanceTemplate}: parameters: *ref_1 get: - description: Returns the specified HttpsHealthCheck resource. - operationId: compute.httpsHealthChecks.get + description: Returns the specified instance template. + operationId: compute.instanceTemplates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -86306,7 +93575,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/HttpsHealthCheck' + $ref: '#/components/schemas/InstanceTemplate' parameters: - in: path name: project @@ -86314,13 +93583,16 @@ paths: schema: type: string - in: path - name: httpsHealthCheck + name: instanceTemplate required: true schema: type: string delete: - description: Deletes the specified HttpsHealthCheck resource. - operationId: compute.httpsHealthChecks.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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -86344,7 +93616,7 @@ paths: schema: type: string - in: path - name: httpsHealthCheck + name: instanceTemplate required: true schema: type: string @@ -86352,16 +93624,14 @@ paths: name: requestId schema: type: string - put: + /projects/{project}/aggregated/instanceTemplates: + parameters: *ref_1 + get: description: >- - Updates a HttpsHealthCheck resource in the specified project using the - data included in the request. - operationId: compute.httpsHealthChecks.update - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/HttpsHealthCheck' + Retrieves the list of all InstanceTemplates resources, regional and + global, available to the specified project. To prevent failure, Google + recommends that you set the `returnPartialSuccess` parameter to `true`. + operationId: compute.instanceTemplates.aggregatedList security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -86371,39 +93641,108 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/InstanceTemplateAggregatedList' parameters: - in: path name: project required: true schema: type: string + - in: query + name: filter + schema: + type: string + - in: query + name: includeAllScopes + schema: + type: boolean + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean + - in: query + name: serviceProjectNumber + schema: + type: string + format: int64 + /projects/{project}/global/instanceTemplates/{resource}/getIamPolicy: + parameters: *ref_1 + get: + description: >- + Gets the access control policy for a resource. May be empty if no such + policy or resource exists. + operationId: compute.instanceTemplates.getIamPolicy + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: - in: path - name: httpsHealthCheck + name: project required: true schema: type: string - - in: query - name: requestId + - in: path + name: resource + required: true schema: type: string - patch: + - in: query + name: optionsRequestedPolicyVersion + schema: + type: integer + format: int32 + /projects/{project}/global/instanceTemplates/{resource}/setIamPolicy: + parameters: *ref_1 + post: 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 + Sets the access control policy on the specified resource. Replaces any + existing policy. + operationId: compute.instanceTemplates.setIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/HttpsHealthCheck' + $ref: '#/components/schemas/GlobalSetPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -86419,7 +93758,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Policy' parameters: - in: path name: project @@ -86427,21 +93766,58 @@ paths: schema: type: string - in: path - name: httpsHealthCheck + name: resource required: true schema: type: string - - in: query - name: requestId + /projects/{project}/global/instanceTemplates/{resource}/testIamPermissions: + parameters: *ref_1 + post: + description: Returns permissions that a caller has on the specified resource. + operationId: compute.instanceTemplates.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsResponse' + parameters: + - in: path + name: project + required: true schema: type: string - /projects/{project}/global/instanceTemplates: + - in: path + name: resource + required: true + schema: + type: string + /projects/{project}/regions/{region}/instanceTemplates: parameters: *ref_1 get: description: >- Retrieves a list of instance templates that are contained within the - specified project. - operationId: compute.instanceTemplates.list + specified project and region. + operationId: compute.regionInstanceTemplates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -86468,6 +93844,11 @@ paths: required: true schema: type: string + - in: path + name: region + required: true + schema: + type: string - in: query name: filter schema: @@ -86491,12 +93872,9 @@ paths: type: boolean 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 + Creates an instance template in the specified project and region using + the global instance template whose URL is included in the request. + operationId: compute.regionInstanceTemplates.insert requestBody: content: application/json: @@ -86524,15 +93902,20 @@ paths: required: true schema: type: string + - in: path + name: region + required: true + schema: + type: string - in: query name: requestId schema: type: string - /projects/{project}/global/instanceTemplates/{instanceTemplate}: + /projects/{project}/regions/{region}/instanceTemplates/{instanceTemplate}: parameters: *ref_1 get: description: Returns the specified instance template. - operationId: compute.instanceTemplates.get + operationId: compute.regionInstanceTemplates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -86559,6 +93942,11 @@ paths: required: true schema: type: string + - in: path + name: region + required: true + schema: + type: string - in: path name: instanceTemplate required: true @@ -86567,9 +93955,8 @@ paths: 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 + is permanent and cannot be undone. + operationId: compute.regionInstanceTemplates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -86592,6 +93979,11 @@ paths: required: true schema: type: string + - in: path + name: region + required: true + schema: + type: string - in: path name: instanceTemplate required: true @@ -86601,14 +93993,11 @@ paths: name: requestId schema: type: string - /projects/{project}/aggregated/instanceTemplates: + /projects/{project}/zones/{zone}/instanceSettings: parameters: *ref_1 get: - description: >- - Retrieves the list of all InstanceTemplates resources, regional and - global, available to the specified project. To prevent failure, Google - recommends that you set the `returnPartialSuccess` parameter to `true`. - operationId: compute.instanceTemplates.aggregatedList + description: Get Instance settings. + operationId: compute.instanceSettings.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -86628,50 +94017,69 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InstanceTemplateAggregatedList' + $ref: '#/components/schemas/InstanceSettings' parameters: - in: path name: project required: true schema: type: string - - in: query - name: filter + - in: path + name: zone + required: true schema: type: string - - in: query - name: includeAllScopes - schema: - type: boolean - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy + patch: + description: Patch Instance settings + operationId: compute.instanceSettings.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstanceSettings' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: project + required: true schema: type: string - - in: query - name: pageToken + - in: path + name: zone + required: true schema: type: string - in: query - name: returnPartialSuccess + name: requestId schema: - type: boolean + type: string - in: query - name: serviceProjectNumber + name: updateMask schema: type: string - format: int64 - /projects/{project}/global/instanceTemplates/{resource}/getIamPolicy: + format: google-fieldmask + /projects/{project}/zones/{zone}/instantSnapshots: parameters: *ref_1 get: description: >- - Gets the access control policy for a resource. May be empty if no such - policy or resource exists. - operationId: compute.instanceTemplates.getIamPolicy + Retrieves the list of InstantSnapshot resources contained within the + specified zone. + operationId: compute.instantSnapshots.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -86691,7 +94099,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/InstantSnapshotList' parameters: - in: path name: project @@ -86699,27 +94107,39 @@ paths: schema: type: string - in: path - name: resource + name: zone required: true schema: type: string - in: query - name: optionsRequestedPolicyVersion + name: filter + schema: + type: string + - in: query + name: maxResults schema: type: integer - format: int32 - /projects/{project}/global/instanceTemplates/{resource}/setIamPolicy: - parameters: *ref_1 + format: uint32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. - operationId: compute.instanceTemplates.setIamPolicy + description: Creates an instant snapshot in the specified zone. + operationId: compute.instantSnapshots.insert requestBody: content: application/json: schema: - $ref: '#/components/schemas/GlobalSetPolicyRequest' + $ref: '#/components/schemas/InstantSnapshot' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -86735,7 +94155,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -86743,20 +94163,19 @@ paths: schema: type: string - in: path - name: resource + name: zone required: true schema: type: string - /projects/{project}/global/instanceTemplates/{resource}/testIamPermissions: + - in: query + name: requestId + schema: + type: string + /projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}: parameters: *ref_1 - post: - description: Returns permissions that a caller has on the specified resource. - operationId: compute.instanceTemplates.testIamPermissions - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TestPermissionsRequest' + get: + description: Returns the specified InstantSnapshot resource in the specified zone. + operationId: compute.instantSnapshots.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -86776,7 +94195,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TestPermissionsResponse' + $ref: '#/components/schemas/InstantSnapshot' parameters: - in: path name: project @@ -86784,17 +94203,24 @@ paths: schema: type: string - in: path - name: resource + name: zone required: true schema: type: string - /projects/{project}/regions/{region}/instanceTemplates: - parameters: *ref_1 - get: + - in: path + name: instantSnapshot + required: true + schema: + type: string + delete: description: >- - Retrieves a list of instance templates that are contained within the - specified project and region. - operationId: compute.regionInstanceTemplates.list + Deletes the specified InstantSnapshot resource. Keep in mind that + deleting a single instantSnapshot might not necessarily delete all the + data on that instantSnapshot. If any data on the instantSnapshot that is + marked for deletion is needed for subsequent instantSnapshots, the data + will be moved to the next corresponding instantSnapshot. For more + information, see Deleting instantSnapshots. + operationId: compute.instantSnapshots.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -86804,17 +94230,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/InstanceTemplateList' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -86822,41 +94244,31 @@ paths: schema: type: string - in: path - name: region + name: zone required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy + - in: path + name: instantSnapshot + required: true schema: type: string - in: query - name: pageToken + name: requestId schema: type: string - - in: query - name: returnPartialSuccess - schema: - type: boolean + /projects/{project}/zones/{zone}/instantSnapshots/{resource}/setLabels: + parameters: *ref_1 post: description: >- - Creates an instance template in the specified project and region using - the global instance template whose URL is included in the request. - operationId: compute.regionInstanceTemplates.insert + Sets the labels on a instantSnapshot in the given zone. To learn more + about labels, read the Labeling Resources documentation. + operationId: compute.instantSnapshots.setLabels requestBody: content: application/json: schema: - $ref: '#/components/schemas/InstanceTemplate' + $ref: '#/components/schemas/ZoneSetLabelsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -86880,7 +94292,12 @@ paths: schema: type: string - in: path - name: region + name: zone + required: true + schema: + type: string + - in: path + name: resource required: true schema: type: string @@ -86888,11 +94305,13 @@ paths: name: requestId schema: type: string - /projects/{project}/regions/{region}/instanceTemplates/{instanceTemplate}: + /projects/{project}/zones/{zone}/instantSnapshots/{resource}/getIamPolicy: parameters: *ref_1 get: - description: Returns the specified instance template. - operationId: compute.regionInstanceTemplates.get + description: >- + Gets the access control policy for a resource. May be empty if no such + policy or resource exists. + operationId: compute.instantSnapshots.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -86912,7 +94331,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InstanceTemplate' + $ref: '#/components/schemas/Policy' parameters: - in: path name: project @@ -86920,20 +94339,32 @@ paths: schema: type: string - in: path - name: region + name: zone required: true schema: type: string - in: path - name: instanceTemplate + name: resource required: true schema: type: string - delete: + - in: query + name: optionsRequestedPolicyVersion + schema: + type: integer + format: int32 + /projects/{project}/zones/{zone}/instantSnapshots/{resource}/setIamPolicy: + parameters: *ref_1 + post: description: >- - Deletes the specified instance template. Deleting an instance template - is permanent and cannot be undone. - operationId: compute.regionInstanceTemplates.delete + Sets the access control policy on the specified resource. Replaces any + existing policy. + operationId: compute.instantSnapshots.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZoneSetPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -86949,7 +94380,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Policy' parameters: - in: path name: project @@ -86957,24 +94388,25 @@ paths: schema: type: string - in: path - name: region + name: zone required: true schema: type: string - in: path - name: instanceTemplate + name: resource required: true schema: type: string - - in: query - name: requestId - schema: - type: string - /projects/{project}/zones/{zone}/instanceSettings: + /projects/{project}/zones/{zone}/instantSnapshots/{resource}/testIamPermissions: parameters: *ref_1 - get: - description: Get Instance settings. - operationId: compute.instanceSettings.get + post: + description: Returns permissions that a caller has on the specified resource. + operationId: compute.instantSnapshots.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -86994,7 +94426,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InstanceSettings' + $ref: '#/components/schemas/TestPermissionsResponse' parameters: - in: path name: project @@ -87006,14 +94438,19 @@ paths: required: true schema: type: string - patch: - description: Patch Instance settings - operationId: compute.instanceSettings.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/InstanceSettings' + - in: path + name: resource + required: true + schema: + type: string + /projects/{project}/aggregated/instantSnapshots: + parameters: *ref_1 + get: + description: >- + Retrieves an aggregated list of instantSnapshots. To prevent failure, + Google recommends that you set the `returnPartialSuccess` parameter to + `true`. + operationId: compute.instantSnapshots.aggregatedList security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -87023,40 +94460,60 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/InstantSnapshotAggregatedList' parameters: - in: path name: project required: true schema: type: string - - in: path - name: zone - required: true + - in: query + name: filter schema: type: string - in: query - name: requestId + name: includeAllScopes + schema: + type: boolean + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy schema: type: string - in: query - name: updateMask + name: pageToken schema: type: string - format: google-fieldmask - /projects/{project}/zones/{zone}/instantSnapshots: + - in: query + name: returnPartialSuccess + schema: + type: boolean + - in: query + name: serviceProjectNumber + schema: + type: string + format: int64 + /projects/{project}/regions/{region}/instantSnapshots: parameters: *ref_1 get: description: >- Retrieves the list of InstantSnapshot resources contained within the - specified zone. - operationId: compute.instantSnapshots.list + specified region. + operationId: compute.regionInstantSnapshots.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -87084,7 +94541,7 @@ paths: schema: type: string - in: path - name: zone + name: region required: true schema: type: string @@ -87110,8 +94567,8 @@ paths: schema: type: boolean post: - description: Creates an instant snapshot in the specified zone. - operationId: compute.instantSnapshots.insert + description: Creates an instant snapshot in the specified region. + operationId: compute.regionInstantSnapshots.insert requestBody: content: application/json: @@ -87140,7 +94597,7 @@ paths: schema: type: string - in: path - name: zone + name: region required: true schema: type: string @@ -87148,11 +94605,11 @@ paths: name: requestId schema: type: string - /projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}: + /projects/{project}/regions/{region}/instantSnapshots/{instantSnapshot}: parameters: *ref_1 get: - description: Returns the specified InstantSnapshot resource in the specified zone. - operationId: compute.instantSnapshots.get + description: Returns the specified InstantSnapshot resource in the specified region. + operationId: compute.regionInstantSnapshots.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -87180,7 +94637,7 @@ paths: schema: type: string - in: path - name: zone + name: region required: true schema: type: string @@ -87197,7 +94654,7 @@ paths: marked for deletion is needed for subsequent instantSnapshots, the data will be moved to the next corresponding instantSnapshot. For more information, see Deleting instantSnapshots. - operationId: compute.instantSnapshots.delete + operationId: compute.regionInstantSnapshots.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -87221,7 +94678,7 @@ paths: schema: type: string - in: path - name: zone + name: region required: true schema: type: string @@ -87234,18 +94691,18 @@ paths: name: requestId schema: type: string - /projects/{project}/zones/{zone}/instantSnapshots/{resource}/setLabels: + /projects/{project}/regions/{region}/instantSnapshots/{resource}/setLabels: parameters: *ref_1 post: description: >- - Sets the labels on a instantSnapshot in the given zone. To learn more + Sets the labels on a instantSnapshot in the given region. To learn more about labels, read the Labeling Resources documentation. - operationId: compute.instantSnapshots.setLabels + operationId: compute.regionInstantSnapshots.setLabels requestBody: content: application/json: schema: - $ref: '#/components/schemas/ZoneSetLabelsRequest' + $ref: '#/components/schemas/RegionSetLabelsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -87269,7 +94726,7 @@ paths: schema: type: string - in: path - name: zone + name: region required: true schema: type: string @@ -87282,13 +94739,13 @@ paths: name: requestId schema: type: string - /projects/{project}/zones/{zone}/instantSnapshots/{resource}/getIamPolicy: + /projects/{project}/regions/{region}/instantSnapshots/{resource}/getIamPolicy: parameters: *ref_1 get: description: >- Gets the access control policy for a resource. May be empty if no such policy or resource exists. - operationId: compute.instantSnapshots.getIamPolicy + operationId: compute.regionInstantSnapshots.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -87316,7 +94773,7 @@ paths: schema: type: string - in: path - name: zone + name: region required: true schema: type: string @@ -87330,18 +94787,18 @@ paths: schema: type: integer format: int32 - /projects/{project}/zones/{zone}/instantSnapshots/{resource}/setIamPolicy: + /projects/{project}/regions/{region}/instantSnapshots/{resource}/setIamPolicy: parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any existing policy. - operationId: compute.instantSnapshots.setIamPolicy + operationId: compute.regionInstantSnapshots.setIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/ZoneSetPolicyRequest' + $ref: '#/components/schemas/RegionSetPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -87365,7 +94822,7 @@ paths: schema: type: string - in: path - name: zone + name: region required: true schema: type: string @@ -87374,11 +94831,11 @@ paths: required: true schema: type: string - /projects/{project}/zones/{zone}/instantSnapshots/{resource}/testIamPermissions: + /projects/{project}/regions/{region}/instantSnapshots/{resource}/testIamPermissions: parameters: *ref_1 post: description: Returns permissions that a caller has on the specified resource. - operationId: compute.instantSnapshots.testIamPermissions + operationId: compute.regionInstantSnapshots.testIamPermissions requestBody: content: application/json: @@ -87411,7 +94868,7 @@ paths: schema: type: string - in: path - name: zone + name: region required: true schema: type: string @@ -87420,14 +94877,13 @@ paths: required: true schema: type: string - /projects/{project}/aggregated/instantSnapshots: + /projects/{project}/global/interconnectLocations: parameters: *ref_1 get: description: >- - Retrieves an aggregated list of instantSnapshots. To prevent failure, - Google recommends that you set the `returnPartialSuccess` parameter to - `true`. - operationId: compute.instantSnapshots.aggregatedList + Retrieves the list of interconnect locations available to the specified + project. + operationId: compute.interconnectLocations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -87447,7 +94903,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InstantSnapshotAggregatedList' + $ref: '#/components/schemas/InterconnectLocationList' parameters: - in: path name: project @@ -87459,9 +94915,97 @@ paths: schema: type: string - in: query - name: includeAllScopes + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: returnPartialSuccess schema: type: boolean + /projects/{project}/global/interconnectLocations/{interconnectLocation}: + parameters: *ref_1 + 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 + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/InterconnectLocation' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: interconnectLocation + required: true + schema: + type: string + /projects/{project}/global/interconnectRemoteLocations: + parameters: *ref_1 + get: + description: >- + Retrieves the list of interconnect remote locations available to the + specified project. + operationId: compute.interconnectRemoteLocations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/InterconnectRemoteLocationList' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string - in: query name: maxResults schema: @@ -87475,22 +95019,141 @@ paths: name: pageToken schema: type: string - - in: query - name: returnPartialSuccess - schema: - type: boolean - - in: query - name: serviceProjectNumber + - in: query + name: returnPartialSuccess + schema: + type: boolean + /projects/{project}/global/interconnectRemoteLocations/{interconnectRemoteLocation}: + parameters: *ref_1 + get: + description: >- + Returns the details for the specified interconnect remote location. Gets + a list of available interconnect remote locations by making a list() + request. + operationId: compute.interconnectRemoteLocations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/InterconnectRemoteLocation' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: interconnectRemoteLocation + required: true + schema: + type: string + /projects/{project}/global/licenseCodes/{licenseCode}: + parameters: *ref_1 + 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 + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/LicenseCode' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: licenseCode + required: true + schema: + type: string + /projects/{project}/global/licenseCodes/{resource}/testIamPermissions: + parameters: *ref_1 + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsResponse' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: resource + required: true schema: type: string - format: int64 - /projects/{project}/regions/{region}/instantSnapshots: + /projects/{project}/global/licenses/{license}: parameters: *ref_1 get: description: >- - Retrieves the list of InstantSnapshot resources contained within the - specified region. - operationId: compute.regionInstantSnapshots.list + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -87510,7 +95173,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InstantSnapshotList' + $ref: '#/components/schemas/License' parameters: - in: path name: project @@ -87518,39 +95181,16 @@ paths: schema: type: string - in: path - name: region + name: license required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: returnPartialSuccess - schema: - type: boolean - post: - description: Creates an instant snapshot in the specified region. - operationId: compute.regionInstantSnapshots.insert - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/InstantSnapshot' + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -87574,7 +95214,7 @@ paths: schema: type: string - in: path - name: region + name: license required: true schema: type: string @@ -87582,11 +95222,17 @@ paths: name: requestId schema: type: string - /projects/{project}/regions/{region}/instantSnapshots/{instantSnapshot}: - parameters: *ref_1 - get: - description: Returns the specified InstantSnapshot resource in the specified region. - operationId: compute.regionInstantSnapshots.get + patch: + description: >- + Updates 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.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/License' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -87596,17 +95242,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/InstantSnapshot' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -87614,24 +95256,32 @@ paths: schema: type: string - in: path - name: region + name: license required: true schema: type: string - - in: path - name: instantSnapshot - required: true + - in: query + name: requestId schema: type: string - delete: + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /projects/{project}/global/licenses: + parameters: *ref_1 + get: description: >- - Deletes the specified InstantSnapshot resource. Keep in mind that - deleting a single instantSnapshot might not necessarily delete all the - data on that instantSnapshot. If any data on the instantSnapshot that is - marked for deletion is needed for subsequent instantSnapshots, the data - will be moved to the next corresponding instantSnapshot. For more - information, see Deleting instantSnapshots. - operationId: compute.regionInstantSnapshots.delete + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -87641,45 +95291,55 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/LicensesListResponse' parameters: - in: path name: project required: true schema: type: string - - in: path - name: region - required: true + - in: query + name: filter schema: type: string - - in: path - name: instantSnapshot - required: true + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy schema: type: string - in: query - name: requestId + name: pageToken schema: type: string - /projects/{project}/regions/{region}/instantSnapshots/{resource}/setLabels: - parameters: *ref_1 + - in: query + name: returnPartialSuccess + schema: + type: boolean post: description: >- - Sets the labels on a instantSnapshot in the given region. To learn more - about labels, read the Labeling Resources documentation. - operationId: compute.regionInstantSnapshots.setLabels + 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 requestBody: content: application/json: schema: - $ref: '#/components/schemas/RegionSetLabelsRequest' + $ref: '#/components/schemas/License' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -87689,6 +95349,18 @@ paths: - 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 responses: '200': description: Successful response @@ -87702,27 +95374,18 @@ paths: required: true schema: type: string - - in: path - name: region - required: true - schema: - type: string - - in: path - name: resource - required: true - schema: - type: string - in: query name: requestId schema: type: string - /projects/{project}/regions/{region}/instantSnapshots/{resource}/getIamPolicy: + /projects/{project}/global/licenses/{resource}/getIamPolicy: parameters: *ref_1 get: description: >- Gets the access control policy for a resource. May be empty if no such - policy or resource exists. - operationId: compute.regionInstantSnapshots.getIamPolicy + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -87749,11 +95412,6 @@ paths: required: true schema: type: string - - in: path - name: region - required: true - schema: - type: string - in: path name: resource required: true @@ -87764,18 +95422,19 @@ paths: schema: type: integer format: int32 - /projects/{project}/regions/{region}/instantSnapshots/{resource}/setIamPolicy: + /projects/{project}/global/licenses/{resource}/setIamPolicy: parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any - existing policy. - operationId: compute.regionInstantSnapshots.setIamPolicy + existing policy. *Caution* This resource is intended for use only by + third-party partners who are creating Cloud Marketplace images. + operationId: compute.licenses.setIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/RegionSetPolicyRequest' + $ref: '#/components/schemas/GlobalSetPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -87798,21 +95457,19 @@ paths: required: true schema: type: string - - in: path - name: region - required: true - schema: - type: string - in: path name: resource required: true schema: type: string - /projects/{project}/regions/{region}/instantSnapshots/{resource}/testIamPermissions: + /projects/{project}/global/licenses/{resource}/testIamPermissions: parameters: *ref_1 post: - description: Returns permissions that a caller has on the specified resource. - operationId: compute.regionInstantSnapshots.testIamPermissions + 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 requestBody: content: application/json: @@ -87844,23 +95501,18 @@ paths: required: true schema: type: string - - in: path - name: region - required: true - schema: - type: string - in: path name: resource required: true schema: type: string - /projects/{project}/regions/{region}/interconnectAttachments: + /projects/{project}/global/machineImages: parameters: *ref_1 get: description: >- - Retrieves the list of interconnect attachments contained within the - specified region. - operationId: compute.interconnectAttachments.list + Retrieves a list of machine images that are contained within the + specified project. + operationId: compute.machineImages.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -87880,18 +95532,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InterconnectAttachmentList' + $ref: '#/components/schemas/MachineImageList' parameters: - in: path name: project required: true schema: type: string - - in: path - name: region - required: true - schema: - type: string - in: query name: filter schema: @@ -87915,14 +95562,16 @@ paths: type: boolean post: description: >- - Creates an InterconnectAttachment in the specified project using the - data included in the request. - operationId: compute.interconnectAttachments.insert + Creates a machine image in the specified project using the data that is + included in the request. If you are creating a new machine image to + update an existing instance, your new machine image should use the same + network or, if applicable, the same subnetwork as the original instance. + operationId: compute.machineImages.insert requestBody: content: application/json: schema: - $ref: '#/components/schemas/InterconnectAttachment' + $ref: '#/components/schemas/MachineImage' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -87945,27 +95594,19 @@ paths: required: true schema: type: string - - in: path - name: region - required: true - schema: - type: string - in: query name: requestId schema: type: string - in: query - name: validateOnly + name: sourceInstance schema: - type: boolean - /projects/{project}/aggregated/interconnectAttachments: + type: string + /projects/{project}/global/machineImages/{machineImage}: parameters: *ref_1 get: - description: >- - Retrieves an aggregated list of interconnect attachments. To prevent - failure, Google recommends that you set the `returnPartialSuccess` - parameter to `true`. - operationId: compute.interconnectAttachments.aggregatedList + description: Returns the specified machine image. + operationId: compute.machineImages.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -87985,48 +95626,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InterconnectAttachmentAggregatedList' + $ref: '#/components/schemas/MachineImage' parameters: - in: path name: project required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: includeAllScopes - schema: - type: boolean - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: returnPartialSuccess - schema: - type: boolean - - in: query - name: serviceProjectNumber + - in: path + name: machineImage + required: true schema: type: string - format: int64 - /projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}: - parameters: *ref_1 - get: - description: Returns the specified interconnect attachment. - operationId: compute.interconnectAttachments.get + delete: + description: >- + Deletes the specified machine image. Deleting a machine image is + permanent and cannot be undone. + operationId: compute.machineImages.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -88036,17 +95652,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/InterconnectAttachment' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -88054,26 +95666,26 @@ paths: schema: type: string - in: path - name: region + name: machineImage required: true schema: type: string - - in: path - name: interconnectAttachment - required: true + - in: query + name: requestId schema: type: string - patch: + /projects/{project}/global/machineImages/{resource}/setLabels: + parameters: *ref_1 + post: 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 + Sets the labels on a machine image. To learn more about labels, read the + Labeling Resources documentation. + operationId: compute.machineImages.setLabels requestBody: content: application/json: schema: - $ref: '#/components/schemas/InterconnectAttachment' + $ref: '#/components/schemas/GlobalSetLabelsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -88097,22 +95709,17 @@ paths: schema: type: string - in: path - name: region - required: true - schema: - type: string - - in: path - name: interconnectAttachment + name: resource required: true schema: type: string - - in: query - name: requestId - schema: - type: string - delete: - description: Deletes the specified interconnect attachment. - operationId: compute.interconnectAttachments.delete + /projects/{project}/global/machineImages/{resource}/getIamPolicy: + parameters: *ref_1 + get: + description: >- + Gets the access control policy for a resource. May be empty if no such + policy or resource exists. + operationId: compute.machineImages.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -88122,13 +95729,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Policy' parameters: - in: path name: project @@ -88136,31 +95747,27 @@ paths: schema: type: string - in: path - name: region - required: true - schema: - type: string - - in: path - name: interconnectAttachment + name: resource required: true schema: type: string - in: query - name: requestId + name: optionsRequestedPolicyVersion schema: - type: string - /projects/{project}/regions/{region}/interconnectAttachments/{resource}/setLabels: + type: integer + format: int32 + /projects/{project}/global/machineImages/{resource}/setIamPolicy: parameters: *ref_1 post: description: >- - Sets the labels on an InterconnectAttachment. To learn more about - labels, read the Labeling Resources documentation. - operationId: compute.interconnectAttachments.setLabels + Sets the access control policy on the specified resource. Replaces any + existing policy. + operationId: compute.machineImages.setIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/RegionSetLabelsRequest' + $ref: '#/components/schemas/GlobalSetPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -88176,39 +95783,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Policy' parameters: - in: path name: project required: true schema: type: string - - in: path - name: region - required: true - schema: - type: string - in: path name: resource required: true schema: type: string - - in: query - name: requestId - schema: - type: string - /projects/{project}/global/interconnects: + /projects/{project}/global/machineImages/{resource}/testIamPermissions: parameters: *ref_1 post: - description: >- - Creates an Interconnect in the specified project using the data included - in the request. - operationId: compute.interconnects.insert + description: Returns permissions that a caller has on the specified resource. + operationId: compute.machineImages.testIamPermissions requestBody: content: application/json: schema: - $ref: '#/components/schemas/Interconnect' + $ref: '#/components/schemas/TestPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -88218,26 +95814,33 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/TestPermissionsResponse' parameters: - in: path name: project required: true schema: type: string - - in: query - name: requestId + - in: path + name: resource + required: true schema: type: string + /projects/{project}/zones/{zone}/machineTypes: + parameters: *ref_1 get: - description: Retrieves the list of Interconnects available to the specified project. - operationId: compute.interconnects.list + description: Retrieves a list of machine types available to the specified project. + operationId: compute.machineTypes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -88257,13 +95860,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InterconnectList' + $ref: '#/components/schemas/MachineTypeList' parameters: - in: path name: project required: true schema: type: string + - in: path + name: zone + required: true + schema: + type: string - in: query name: filter schema: @@ -88285,16 +95893,14 @@ paths: name: returnPartialSuccess schema: type: boolean - /projects/{project}/global/interconnects/{interconnect}/getDiagnostics: + /projects/{project}/aggregated/machineTypes: parameters: *ref_1 get: description: >- - Returns the interconnectDiagnostics for the specified Interconnect. In - the event of a global outage, do not use this API to make decisions - about where to redirect your network traffic. Unlike a VLAN attachment, - which is regional, a Cloud Interconnect connection is a global resource. - A global outage can prevent this API from functioning properly. - operationId: compute.interconnects.getDiagnostics + Retrieves an aggregated list of machine types. To prevent failure, + Google recommends that you set the `returnPartialSuccess` parameter to + `true`. + operationId: compute.machineTypes.aggregatedList security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -88314,61 +95920,48 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InterconnectsGetDiagnosticsResponse' + $ref: '#/components/schemas/MachineTypeAggregatedList' parameters: - in: path name: project required: true schema: type: string - - in: path - name: interconnect - required: true + - in: query + name: filter schema: type: string - /projects/{project}/global/interconnects/{interconnect}/getMacsecConfig: - parameters: *ref_1 - get: - description: Returns the interconnectMacsecConfig for the specified Interconnect. - operationId: compute.interconnects.getMacsecConfig - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/compute - Oauth2c: - - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/InterconnectsGetMacsecConfigResponse' - parameters: - - in: path - name: project - required: true + - in: query + name: includeAllScopes + schema: + type: boolean + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy schema: type: string - - in: path - name: interconnect - required: true + - in: query + name: pageToken schema: type: string - /projects/{project}/global/interconnects/{interconnect}: + - in: query + name: returnPartialSuccess + schema: + type: boolean + - in: query + name: serviceProjectNumber + schema: + type: string + format: int64 + /projects/{project}/zones/{zone}/machineTypes/{machineType}: parameters: *ref_1 - get: - description: >- - Returns the specified Interconnect. Get a list of available - Interconnects by making a list() request. - operationId: compute.interconnects.get + get: + description: Returns the specified machine type. + operationId: compute.machineTypes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -88388,7 +95981,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Interconnect' + $ref: '#/components/schemas/MachineType' parameters: - in: path name: project @@ -88396,13 +95989,23 @@ paths: schema: type: string - in: path - name: interconnect + name: zone required: true schema: type: string - delete: - description: Deletes the specified Interconnect. - operationId: compute.interconnects.delete + - in: path + name: machineType + required: true + schema: + type: string + /projects/{project}/aggregated/networkAttachments: + parameters: *ref_1 + get: + description: >- + Retrieves the list of all NetworkAttachment resources, regional and + global, available to the specified project. To prevent failure, Google + recommends that you set the `returnPartialSuccess` parameter to `true`. + operationId: compute.networkAttachments.aggregatedList security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -88412,39 +96015,58 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/NetworkAttachmentAggregatedList' parameters: - in: path name: project required: true schema: type: string - - in: path - name: interconnect - required: true + - in: query + name: filter schema: type: string - in: query - name: requestId + name: includeAllScopes + schema: + type: boolean + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy schema: type: string - 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 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Interconnect' + - in: query + name: pageToken + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean + - in: query + name: serviceProjectNumber + schema: + type: string + format: int64 + /projects/{project}/regions/{region}/networkAttachments: + parameters: *ref_1 + get: + description: Lists the NetworkAttachments for a project in the given scope. + operationId: compute.networkAttachments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -88454,13 +96076,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/NetworkAttachmentList' parameters: - in: path name: project @@ -88468,26 +96094,41 @@ paths: schema: type: string - in: path - name: interconnect + name: region required: true schema: type: string - in: query - name: requestId + name: filter schema: type: string - /projects/{project}/global/interconnects/{resource}/setLabels: - parameters: *ref_1 + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean post: description: >- - Sets the labels on an Interconnect. To learn more about labels, read the - Labeling Resources documentation. - operationId: compute.interconnects.setLabels + Creates a NetworkAttachment in the specified project in the given scope + using the parameters that are included in the request. + operationId: compute.networkAttachments.insert requestBody: content: application/json: schema: - $ref: '#/components/schemas/GlobalSetLabelsRequest' + $ref: '#/components/schemas/NetworkAttachment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -88511,17 +96152,19 @@ paths: schema: type: string - in: path - name: resource + name: region required: true schema: type: string - /projects/{project}/global/interconnectLocations: + - in: query + name: requestId + schema: + type: string + /projects/{project}/regions/{region}/networkAttachments/{networkAttachment}: parameters: *ref_1 get: - description: >- - Retrieves the list of interconnect locations available to the specified - project. - operationId: compute.interconnectLocations.list + description: Returns the specified NetworkAttachment resource in the given scope. + operationId: compute.networkAttachments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -88541,41 +96184,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InterconnectLocationList' + $ref: '#/components/schemas/NetworkAttachment' parameters: - in: path name: project required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy + - in: path + name: region + required: true schema: type: string - - in: query - name: pageToken + - in: path + name: networkAttachment + required: true schema: type: string - - in: query - name: returnPartialSuccess - schema: - type: boolean - /projects/{project}/global/interconnectLocations/{interconnectLocation}: - parameters: *ref_1 - 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 + delete: + description: Deletes the specified NetworkAttachment in the given scope + operationId: compute.networkAttachments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -88585,17 +96213,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/InterconnectLocation' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -88603,17 +96227,30 @@ paths: schema: type: string - in: path - name: interconnectLocation + name: region required: true schema: type: string - /projects/{project}/global/interconnectRemoteLocations: - parameters: *ref_1 - get: + - in: path + name: networkAttachment + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + patch: description: >- - Retrieves the list of interconnect remote locations available to the - specified project. - operationId: compute.interconnectRemoteLocations.list + Patches the specified NetworkAttachment resource with the data included + in the request. This method supports PATCH semantics and uses JSON merge + patch format and processing rules. + operationId: compute.networkAttachments.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkAttachment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -88623,52 +96260,40 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/InterconnectRemoteLocationList' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project required: true schema: type: string - - in: query - name: filter + - in: path + name: region + required: true schema: type: string - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy + - in: path + name: networkAttachment + required: true schema: type: string - in: query - name: pageToken + name: requestId schema: type: string - - in: query - name: returnPartialSuccess - schema: - type: boolean - /projects/{project}/global/interconnectRemoteLocations/{interconnectRemoteLocation}: + /projects/{project}/regions/{region}/networkAttachments/{resource}/getIamPolicy: parameters: *ref_1 get: description: >- - Returns the details for the specified interconnect remote location. Gets - a list of available interconnect remote locations by making a list() - request. - operationId: compute.interconnectRemoteLocations.get + Gets the access control policy for a resource. May be empty if no such + policy or resource exists. + operationId: compute.networkAttachments.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -88688,7 +96313,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InterconnectRemoteLocation' + $ref: '#/components/schemas/Policy' parameters: - in: path name: project @@ -88696,19 +96321,32 @@ paths: schema: type: string - in: path - name: interconnectRemoteLocation + name: region required: true schema: type: string - /projects/{project}/global/licenseCodes/{licenseCode}: + - in: path + name: resource + required: true + schema: + type: string + - in: query + name: optionsRequestedPolicyVersion + schema: + type: integer + format: int32 + /projects/{project}/regions/{region}/networkAttachments/{resource}/setIamPolicy: parameters: *ref_1 - get: + post: 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 + Sets the access control policy on the specified resource. Replaces any + existing policy. + operationId: compute.networkAttachments.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RegionSetPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -88718,17 +96356,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/LicenseCode' + $ref: '#/components/schemas/Policy' parameters: - in: path name: project @@ -88736,18 +96370,20 @@ paths: schema: type: string - in: path - name: licenseCode + name: region required: true schema: type: string - /projects/{project}/global/licenseCodes/{resource}/testIamPermissions: + - in: path + name: resource + required: true + schema: + type: string + /projects/{project}/regions/{region}/networkAttachments/{resource}/testIamPermissions: parameters: *ref_1 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 + description: Returns permissions that a caller has on the specified resource. + operationId: compute.networkAttachments.testIamPermissions requestBody: content: application/json: @@ -88779,19 +96415,21 @@ paths: required: true schema: type: string + - in: path + name: region + required: true + schema: + type: string - in: path name: resource required: true schema: type: string - /projects/{project}/global/licenses/{license}: + /projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}: parameters: *ref_1 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 + description: Gets a specified NetworkEdgeSecurityService. + operationId: compute.networkEdgeSecurityServices.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -88811,7 +96449,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/License' + $ref: '#/components/schemas/NetworkEdgeSecurityService' parameters: - in: path name: project @@ -88819,16 +96457,18 @@ paths: schema: type: string - in: path - name: license + name: region + required: true + schema: + type: string + - in: path + name: networkEdgeSecurityService required: true schema: type: string 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 + description: Deletes the specified service. + operationId: compute.networkEdgeSecurityServices.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -88852,7 +96492,12 @@ paths: schema: type: string - in: path - name: license + name: region + required: true + schema: + type: string + - in: path + name: networkEdgeSecurityService required: true schema: type: string @@ -88860,19 +96505,14 @@ paths: name: requestId schema: type: string - /projects/{project}/global/licenses: - parameters: *ref_1 - 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 + patch: + description: Patches the specified policy with the data included in the request. + operationId: compute.networkEdgeSecurityServices.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkEdgeSecurityService' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -88882,55 +96522,54 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/LicensesListResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project required: true schema: type: string - - in: query - name: filter + - in: path + name: region + required: true schema: type: string - - in: query - name: maxResults + - in: path + name: networkEdgeSecurityService + required: true schema: - type: integer - format: uint32 + type: string - in: query - name: orderBy + name: paths schema: type: string - in: query - name: pageToken + name: requestId schema: type: string - in: query - name: returnPartialSuccess + name: updateMask schema: - type: boolean + type: string + format: google-fieldmask + /projects/{project}/regions/{region}/networkEdgeSecurityServices: + parameters: *ref_1 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 + Creates a new service in the specified project using the data included + in the request. + operationId: compute.networkEdgeSecurityServices.insert requestBody: content: application/json: schema: - $ref: '#/components/schemas/License' + $ref: '#/components/schemas/NetworkEdgeSecurityService' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -88940,18 +96579,6 @@ paths: - 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 responses: '200': description: Successful response @@ -88965,18 +96592,27 @@ paths: required: true schema: type: string + - in: path + name: region + required: true + schema: + type: string - in: query name: requestId schema: type: string - /projects/{project}/global/licenses/{resource}/getIamPolicy: + - in: query + name: validateOnly + schema: + type: boolean + /projects/{project}/aggregated/networkEdgeSecurityServices: parameters: *ref_1 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 + Retrieves the list of all NetworkEdgeSecurityService resources available + to the specified project. To prevent failure, Google recommends that you + set the `returnPartialSuccess` parameter to `true`. + operationId: compute.networkEdgeSecurityServices.aggregatedList security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -88996,114 +96632,50 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/NetworkEdgeSecurityServiceAggregatedList' parameters: - in: path name: project required: true schema: type: string - - in: path - name: resource - required: true + - in: query + name: filter schema: type: string - in: query - name: optionsRequestedPolicyVersion + name: includeAllScopes + schema: + type: boolean + - in: query + name: maxResults schema: type: integer - format: int32 - /projects/{project}/global/licenses/{resource}/setIamPolicy: - parameters: *ref_1 - 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 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GlobalSetPolicyRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/compute - Oauth2c: - - https://www.googleapis.com/auth/compute - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Policy' - parameters: - - in: path - name: project - required: true + format: uint32 + - in: query + name: orderBy schema: type: string - - in: path - name: resource - required: true + - in: query + name: pageToken schema: type: string - /projects/{project}/global/licenses/{resource}/testIamPermissions: - parameters: *ref_1 - 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 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TestPermissionsRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/compute - Oauth2c: - - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/TestPermissionsResponse' - parameters: - - in: path - name: project - required: true + - in: query + name: returnPartialSuccess schema: - type: string - - in: path - name: resource - required: true + type: boolean + - in: query + name: serviceProjectNumber schema: type: string - /projects/{project}/global/machineImages: + format: int64 + /projects/{project}/zones/{zone}/networkEndpointGroups: parameters: *ref_1 get: description: >- - Retrieves a list of machine images that are contained within the - specified project. - operationId: compute.machineImages.list + Retrieves the list of network endpoint groups that are located in the + specified project and zone. + operationId: compute.networkEndpointGroups.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -89123,13 +96695,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MachineImageList' + $ref: '#/components/schemas/NetworkEndpointGroupList' parameters: - in: path name: project required: true schema: type: string + - in: path + name: zone + required: true + schema: + type: string - in: query name: filter schema: @@ -89153,16 +96730,14 @@ paths: type: boolean post: description: >- - Creates a machine image in the specified project using the data that is - included in the request. If you are creating a new machine image to - update an existing instance, your new machine image should use the same - network or, if applicable, the same subnetwork as the original instance. - operationId: compute.machineImages.insert + Creates a network endpoint group in the specified project using the + parameters that are included in the request. + operationId: compute.networkEndpointGroups.insert requestBody: content: application/json: schema: - $ref: '#/components/schemas/MachineImage' + $ref: '#/components/schemas/NetworkEndpointGroup' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -89185,19 +96760,23 @@ paths: required: true schema: type: string - - in: query - name: requestId + - in: path + name: zone + required: true schema: type: string - in: query - name: sourceInstance + name: requestId schema: type: string - /projects/{project}/global/machineImages/{machineImage}: + /projects/{project}/aggregated/networkEndpointGroups: parameters: *ref_1 get: - description: Returns the specified machine image. - operationId: compute.machineImages.get + description: >- + Retrieves the list of network endpoint groups and sorts them by zone. To + prevent failure, Google recommends that you set the + `returnPartialSuccess` parameter to `true`. + operationId: compute.networkEndpointGroups.aggregatedList security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -89217,61 +96796,48 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MachineImage' + $ref: '#/components/schemas/NetworkEndpointGroupAggregatedList' parameters: - in: path name: project required: true schema: type: string - - in: path - name: machineImage - required: true + - in: query + name: filter schema: type: string - delete: - description: >- - Deletes the specified machine image. Deleting a machine image is - permanent and cannot be undone. - operationId: compute.machineImages.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/compute - Oauth2c: - - https://www.googleapis.com/auth/compute - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: project - required: true + - in: query + name: includeAllScopes + schema: + type: boolean + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy schema: type: string - - in: path - name: machineImage - required: true + - in: query + name: pageToken schema: type: string - in: query - name: requestId + name: returnPartialSuccess + schema: + type: boolean + - in: query + name: serviceProjectNumber schema: type: string - /projects/{project}/global/machineImages/{resource}/getIamPolicy: + format: int64 + /projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}: parameters: *ref_1 get: - description: >- - Gets the access control policy for a resource. May be empty if no such - policy or resource exists. - operationId: compute.machineImages.getIamPolicy + description: Returns the specified network endpoint group. + operationId: compute.networkEndpointGroups.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -89291,7 +96857,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/NetworkEndpointGroup' parameters: - in: path name: project @@ -89299,27 +96865,22 @@ paths: schema: type: string - in: path - name: resource + name: zone required: true schema: type: string - - in: query - name: optionsRequestedPolicyVersion + - in: path + name: networkEndpointGroup + required: true schema: - type: integer - format: int32 - /projects/{project}/global/machineImages/{resource}/setIamPolicy: - parameters: *ref_1 - post: + type: string + delete: description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. - operationId: compute.machineImages.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GlobalSetPolicyRequest' + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -89335,7 +96896,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -89343,20 +96904,31 @@ paths: schema: type: string - in: path - name: resource + name: zone required: true schema: type: string - /projects/{project}/global/machineImages/{resource}/testIamPermissions: + - in: path + name: networkEndpointGroup + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + /projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints: parameters: *ref_1 post: - description: Returns permissions that a caller has on the specified resource. - operationId: compute.machineImages.testIamPermissions + description: >- + Attach a list of network endpoints to the specified network endpoint + group. + operationId: compute.networkEndpointGroups.attachNetworkEndpoints requestBody: content: application/json: schema: - $ref: '#/components/schemas/TestPermissionsRequest' + $ref: '#/components/schemas/NetworkEndpointGroupsAttachEndpointsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -89366,17 +96938,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/TestPermissionsResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -89384,15 +96952,31 @@ paths: schema: type: string - in: path - name: resource + name: zone required: true schema: type: string - /projects/{project}/zones/{zone}/machineTypes: + - in: path + name: networkEndpointGroup + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + /projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints: parameters: *ref_1 - get: - description: Retrieves a list of machine types available to the specified project. - operationId: compute.machineTypes.list + post: + description: >- + Detach a list of network endpoints from the specified network endpoint + group. + operationId: compute.networkEndpointGroups.detachNetworkEndpoints + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkEndpointGroupsDetachEndpointsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -89402,17 +96986,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/MachineTypeList' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -89424,35 +97004,25 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy + - in: path + name: networkEndpointGroup + required: true schema: type: string - in: query - name: pageToken + name: requestId schema: type: string - - in: query - name: returnPartialSuccess - schema: - type: boolean - /projects/{project}/aggregated/machineTypes: + /projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints: parameters: *ref_1 - get: - description: >- - Retrieves an aggregated list of machine types. To prevent failure, - Google recommends that you set the `returnPartialSuccess` parameter to - `true`. - operationId: compute.machineTypes.aggregatedList + post: + description: Lists the network endpoints in the specified network endpoint group. + operationId: compute.networkEndpointGroups.listNetworkEndpoints + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkEndpointGroupsListEndpointsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -89472,21 +97042,27 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MachineTypeAggregatedList' + $ref: '#/components/schemas/NetworkEndpointGroupsListNetworkEndpoints' parameters: - in: path name: project required: true schema: type: string - - in: query - name: filter + - in: path + name: zone + required: true + schema: + type: string + - in: path + name: networkEndpointGroup + required: true schema: type: string - in: query - name: includeAllScopes + name: filter schema: - type: boolean + type: string - in: query name: maxResults schema: @@ -89504,16 +97080,16 @@ paths: name: returnPartialSuccess schema: type: boolean - - in: query - name: serviceProjectNumber - schema: - type: string - format: int64 - /projects/{project}/zones/{zone}/machineTypes/{machineType}: + /projects/{project}/zones/{zone}/networkEndpointGroups/{resource}/testIamPermissions: parameters: *ref_1 - get: - description: Returns the specified machine type. - operationId: compute.machineTypes.get + post: + description: Returns permissions that a caller has on the specified resource. + operationId: compute.networkEndpointGroups.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -89533,7 +97109,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MachineType' + $ref: '#/components/schemas/TestPermissionsResponse' parameters: - in: path name: project @@ -89546,18 +97122,17 @@ paths: schema: type: string - in: path - name: machineType + name: resource required: true schema: type: string - /projects/{project}/aggregated/networkAttachments: + /projects/{project}/global/networkEndpointGroups: parameters: *ref_1 get: description: >- - Retrieves the list of all NetworkAttachment resources, regional and - global, available to the specified project. To prevent failure, Google - recommends that you set the `returnPartialSuccess` parameter to `true`. - operationId: compute.networkAttachments.aggregatedList + Retrieves the list of network endpoint groups that are located in the + specified project. + operationId: compute.globalNetworkEndpointGroups.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -89577,7 +97152,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/NetworkAttachmentAggregatedList' + $ref: '#/components/schemas/NetworkEndpointGroupList' parameters: - in: path name: project @@ -89588,10 +97163,6 @@ paths: name: filter schema: type: string - - in: query - name: includeAllScopes - schema: - type: boolean - in: query name: maxResults schema: @@ -89609,16 +97180,16 @@ paths: name: returnPartialSuccess schema: type: boolean - - in: query - name: serviceProjectNumber - schema: - type: string - format: int64 - /projects/{project}/regions/{region}/networkAttachments: - parameters: *ref_1 - get: - description: Lists the NetworkAttachments for a project in the given scope. - operationId: compute.networkAttachments.list + post: + description: >- + Creates a network endpoint group in the specified project using the + parameters that are included in the request. + operationId: compute.globalNetworkEndpointGroups.insert + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkEndpointGroup' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -89628,59 +97199,28 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/NetworkAttachmentList' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project required: true schema: type: string - - in: path - name: region - required: true - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy - schema: - type: string - in: query - name: pageToken + name: requestId schema: type: string - - in: query - name: returnPartialSuccess - schema: - type: boolean - post: - description: >- - Creates a NetworkAttachment in the specified project in the given scope - using the parameters that are included in the request. - operationId: compute.networkAttachments.insert - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/NetworkAttachment' + /projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}: + parameters: *ref_1 + get: + description: Returns the specified network endpoint group. + operationId: compute.globalNetworkEndpointGroups.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -89690,13 +97230,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/NetworkEndpointGroup' parameters: - in: path name: project @@ -89704,19 +97248,15 @@ paths: schema: type: string - in: path - name: region + name: networkEndpointGroup required: true schema: type: string - - in: query - name: requestId - schema: - type: string - /projects/{project}/regions/{region}/networkAttachments/{networkAttachment}: - parameters: *ref_1 - get: - description: Returns the specified NetworkAttachment resource in the given scope. - operationId: compute.networkAttachments.get + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -89726,17 +97266,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/NetworkAttachment' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -89744,18 +97280,25 @@ paths: schema: type: string - in: path - name: region + name: networkEndpointGroup required: true schema: type: string - - in: path - name: networkAttachment - required: true + - in: query + name: requestId schema: type: string - delete: - description: Deletes the specified NetworkAttachment in the given scope - operationId: compute.networkAttachments.delete + /projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints: + parameters: *ref_1 + post: + description: Attach a network endpoint to the specified network endpoint group. + operationId: compute.globalNetworkEndpointGroups.attachNetworkEndpoints + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GlobalNetworkEndpointGroupsAttachEndpointsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -89779,12 +97322,7 @@ paths: schema: type: string - in: path - name: region - required: true - schema: - type: string - - in: path - name: networkAttachment + name: networkEndpointGroup required: true schema: type: string @@ -89792,17 +97330,17 @@ paths: name: requestId schema: type: string - patch: - description: >- - Patches the specified NetworkAttachment resource with the data included - in the request. This method supports PATCH semantics and uses JSON merge - patch format and processing rules. - operationId: compute.networkAttachments.patch + /projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints: + parameters: *ref_1 + post: + description: Detach the network endpoint from the specified network endpoint group. + operationId: compute.globalNetworkEndpointGroups.detachNetworkEndpoints requestBody: content: application/json: schema: - $ref: '#/components/schemas/NetworkAttachment' + $ref: >- + #/components/schemas/GlobalNetworkEndpointGroupsDetachEndpointsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -89826,12 +97364,7 @@ paths: schema: type: string - in: path - name: region - required: true - schema: - type: string - - in: path - name: networkAttachment + name: networkEndpointGroup required: true schema: type: string @@ -89839,13 +97372,11 @@ paths: name: requestId schema: type: string - /projects/{project}/regions/{region}/networkAttachments/{resource}/getIamPolicy: + /projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints: parameters: *ref_1 - get: - description: >- - Gets the access control policy for a resource. May be empty if no such - policy or resource exists. - operationId: compute.networkAttachments.getIamPolicy + post: + description: Lists the network endpoints in the specified network endpoint group. + operationId: compute.globalNetworkEndpointGroups.listNetworkEndpoints security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -89865,7 +97396,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/NetworkEndpointGroupsListNetworkEndpoints' parameters: - in: path name: project @@ -89873,32 +97404,38 @@ paths: schema: type: string - in: path - name: region + name: networkEndpointGroup required: true schema: type: string - - in: path - name: resource - required: true + - in: query + name: filter schema: type: string - in: query - name: optionsRequestedPolicyVersion + name: maxResults schema: type: integer - format: int32 - /projects/{project}/regions/{region}/networkAttachments/{resource}/setIamPolicy: + format: uint32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean + /projects/{project}/regions/{region}/networkEndpointGroups: parameters: *ref_1 - post: + get: description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. - operationId: compute.networkAttachments.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RegionSetPolicyRequest' + Retrieves the list of regional network endpoint groups available to the + specified project in the given region. + operationId: compute.regionNetworkEndpointGroups.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -89908,13 +97445,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/NetworkEndpointGroupList' parameters: - in: path name: project @@ -89926,21 +97467,37 @@ paths: required: true schema: type: string - - in: path - name: resource - required: true + - in: query + name: filter schema: type: string - /projects/{project}/regions/{region}/networkAttachments/{resource}/testIamPermissions: - parameters: *ref_1 + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean post: - description: Returns permissions that a caller has on the specified resource. - operationId: compute.networkAttachments.testIamPermissions + description: >- + Creates a network endpoint group in the specified project using the + parameters that are included in the request. + operationId: compute.regionNetworkEndpointGroups.insert requestBody: content: application/json: schema: - $ref: '#/components/schemas/TestPermissionsRequest' + $ref: '#/components/schemas/NetworkEndpointGroup' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -89950,17 +97507,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/TestPermissionsResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -89972,16 +97525,15 @@ paths: required: true schema: type: string - - in: path - name: resource - required: true + - in: query + name: requestId schema: type: string - /projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}: + /projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}: parameters: *ref_1 get: - description: Gets a specified NetworkEdgeSecurityService. - operationId: compute.networkEdgeSecurityServices.get + description: Returns the specified network endpoint group. + operationId: compute.regionNetworkEndpointGroups.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -90001,7 +97553,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/NetworkEdgeSecurityService' + $ref: '#/components/schemas/NetworkEndpointGroup' parameters: - in: path name: project @@ -90014,13 +97566,15 @@ paths: schema: type: string - in: path - name: networkEdgeSecurityService + name: networkEndpointGroup required: true schema: type: string delete: - description: Deletes the specified service. - operationId: compute.networkEdgeSecurityServices.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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -90049,7 +97603,7 @@ paths: schema: type: string - in: path - name: networkEdgeSecurityService + name: networkEndpointGroup required: true schema: type: string @@ -90057,14 +97611,19 @@ paths: name: requestId schema: type: string - patch: - description: Patches the specified policy with the data included in the request. - operationId: compute.networkEdgeSecurityServices.patch + /projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints: + parameters: *ref_1 + post: + description: >- + Attach a list of network endpoints to the specified network endpoint + group. + operationId: compute.regionNetworkEndpointGroups.attachNetworkEndpoints requestBody: content: application/json: schema: - $ref: '#/components/schemas/NetworkEdgeSecurityService' + $ref: >- + #/components/schemas/RegionNetworkEndpointGroupsAttachEndpointsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -90093,35 +97652,25 @@ paths: schema: type: string - in: path - name: networkEdgeSecurityService + name: networkEndpointGroup required: true schema: type: string - - in: query - name: paths - schema: - type: string - in: query name: requestId schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /projects/{project}/regions/{region}/networkEdgeSecurityServices: + /projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints: parameters: *ref_1 post: - description: >- - Creates a new service in the specified project using the data included - in the request. - operationId: compute.networkEdgeSecurityServices.insert + description: Detach the network endpoint from the specified network endpoint group. + operationId: compute.regionNetworkEndpointGroups.detachNetworkEndpoints requestBody: content: application/json: schema: - $ref: '#/components/schemas/NetworkEdgeSecurityService' + $ref: >- + #/components/schemas/RegionNetworkEndpointGroupsDetachEndpointsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -90149,22 +97698,20 @@ paths: required: true schema: type: string - - in: query - name: requestId + - in: path + name: networkEndpointGroup + required: true schema: type: string - in: query - name: validateOnly + name: requestId schema: - type: boolean - /projects/{project}/aggregated/networkEdgeSecurityServices: + type: string + /projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints: parameters: *ref_1 - get: - description: >- - Retrieves the list of all NetworkEdgeSecurityService resources available - to the specified project. To prevent failure, Google recommends that you - set the `returnPartialSuccess` parameter to `true`. - operationId: compute.networkEdgeSecurityServices.aggregatedList + post: + description: Lists the network endpoints in the specified network endpoint group. + operationId: compute.regionNetworkEndpointGroups.listNetworkEndpoints security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -90184,21 +97731,27 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/NetworkEdgeSecurityServiceAggregatedList' + $ref: '#/components/schemas/NetworkEndpointGroupsListNetworkEndpoints' parameters: - in: path name: project required: true schema: type: string - - in: query - name: filter + - in: path + name: region + required: true + schema: + type: string + - in: path + name: networkEndpointGroup + required: true schema: type: string - in: query - name: includeAllScopes + name: filter schema: - type: boolean + type: string - in: query name: maxResults schema: @@ -90216,18 +97769,11 @@ paths: name: returnPartialSuccess schema: type: boolean - - in: query - name: serviceProjectNumber - schema: - type: string - format: int64 - /projects/{project}/zones/{zone}/networkEndpointGroups: + /projects/{project}/global/networks: parameters: *ref_1 get: - description: >- - Retrieves the list of network endpoint groups that are located in the - specified project and zone. - operationId: compute.networkEndpointGroups.list + description: Retrieves the list of networks available to the specified project. + operationId: compute.networks.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -90247,18 +97793,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/NetworkEndpointGroupList' + $ref: '#/components/schemas/NetworkList' parameters: - in: path name: project required: true schema: type: string - - in: path - name: zone - required: true - schema: - type: string - in: query name: filter schema: @@ -90282,14 +97823,14 @@ paths: type: boolean post: description: >- - Creates a network endpoint group in the specified project using the - parameters that are included in the request. - operationId: compute.networkEndpointGroups.insert + Creates a network in the specified project using the data included in + the request. + operationId: compute.networks.insert requestBody: content: application/json: schema: - $ref: '#/components/schemas/NetworkEndpointGroup' + $ref: '#/components/schemas/Network' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -90312,23 +97853,15 @@ paths: required: true schema: type: string - - in: path - name: zone - required: true - schema: - type: string - in: query name: requestId schema: type: string - /projects/{project}/aggregated/networkEndpointGroups: + /projects/{project}/global/networks/{network}: parameters: *ref_1 get: - description: >- - Retrieves the list of network endpoint groups and sorts them by zone. To - prevent failure, Google recommends that you set the - `returnPartialSuccess` parameter to `true`. - operationId: compute.networkEndpointGroups.aggregatedList + description: Returns the specified network. + operationId: compute.networks.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -90348,48 +97881,62 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/NetworkEndpointGroupAggregatedList' + $ref: '#/components/schemas/Network' parameters: - in: path name: project required: true schema: type: string - - in: query - name: filter + - in: path + name: network + required: true schema: type: string - - in: query - name: includeAllScopes - schema: - type: boolean - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy + delete: + description: Deletes the specified network. + operationId: compute.networks.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: project + required: true schema: type: string - - in: query - name: pageToken + - in: path + name: network + required: true schema: type: string - in: query - name: returnPartialSuccess - schema: - type: boolean - - in: query - name: serviceProjectNumber + name: requestId schema: type: string - format: int64 - /projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}: - parameters: *ref_1 - get: - description: Returns the specified network endpoint group. - operationId: compute.networkEndpointGroups.get + patch: + description: >- + Patches the specified network with the data included in the request. + Only routingConfig can be modified. + operationId: compute.networks.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Network' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -90399,17 +97946,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/NetworkEndpointGroup' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -90417,22 +97960,27 @@ paths: schema: type: string - in: path - name: zone + name: network required: true schema: type: string - - in: path - name: networkEndpointGroup - required: true + - in: query + name: requestId schema: type: string - delete: + /projects/{project}/global/networks/{network}/updatePeering: + parameters: *ref_1 + patch: 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 + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NetworksUpdatePeeringRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -90456,12 +98004,7 @@ paths: schema: type: string - in: path - name: zone - required: true - schema: - type: string - - in: path - name: networkEndpointGroup + name: network required: true schema: type: string @@ -90469,18 +98012,16 @@ paths: name: requestId schema: type: string - /projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints: + /projects/{project}/global/networks/{network}/addPeering: parameters: *ref_1 post: - description: >- - Attach a list of network endpoints to the specified network endpoint - group. - operationId: compute.networkEndpointGroups.attachNetworkEndpoints + description: Adds a peering to the specified network. + operationId: compute.networks.addPeering requestBody: content: application/json: schema: - $ref: '#/components/schemas/NetworkEndpointGroupsAttachEndpointsRequest' + $ref: '#/components/schemas/NetworksAddPeeringRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -90504,12 +98045,7 @@ paths: schema: type: string - in: path - name: zone - required: true - schema: - type: string - - in: path - name: networkEndpointGroup + name: network required: true schema: type: string @@ -90517,18 +98053,18 @@ paths: name: requestId schema: type: string - /projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints: + /projects/{project}/global/networks/{network}/requestRemovePeering: parameters: *ref_1 post: description: >- - Detach a list of network endpoints from the specified network endpoint - group. - operationId: compute.networkEndpointGroups.detachNetworkEndpoints + Requests to remove a peering from the specified network. Applicable only + for PeeringConnection with update_strategy=CONSENSUS. + operationId: compute.networks.requestRemovePeering requestBody: content: application/json: schema: - $ref: '#/components/schemas/NetworkEndpointGroupsDetachEndpointsRequest' + $ref: '#/components/schemas/NetworksRequestRemovePeeringRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -90552,12 +98088,7 @@ paths: schema: type: string - in: path - name: zone - required: true - schema: - type: string - - in: path - name: networkEndpointGroup + name: network required: true schema: type: string @@ -90565,16 +98096,16 @@ paths: name: requestId schema: type: string - /projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints: + /projects/{project}/global/networks/{network}/removePeering: parameters: *ref_1 post: - description: Lists the network endpoints in the specified network endpoint group. - operationId: compute.networkEndpointGroups.listNetworkEndpoints + description: Removes a peering from the specified network. + operationId: compute.networks.removePeering requestBody: content: application/json: schema: - $ref: '#/components/schemas/NetworkEndpointGroupsListEndpointsRequest' + $ref: '#/components/schemas/NetworksRemovePeeringRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -90584,17 +98115,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/NetworkEndpointGroupsListNetworkEndpoints' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -90602,46 +98129,91 @@ paths: schema: type: string - in: path - name: zone + name: network required: true schema: type: string + - in: query + name: requestId + schema: + type: string + /projects/{project}/global/networks/{network}/switchToCustomMode: + parameters: *ref_1 + post: + description: Switches the network mode from auto subnet mode to custom subnet mode. + operationId: compute.networks.switchToCustomMode + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: - in: path - name: networkEndpointGroup + name: project required: true schema: type: string - - in: query - name: filter + - in: path + name: network + required: true schema: type: string - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy + name: requestId schema: type: string - - in: query - name: pageToken + /projects/{project}/global/networks/{network}/getEffectiveFirewalls: + parameters: *ref_1 + get: + description: Returns the effective firewalls on a given network. + operationId: compute.networks.getEffectiveFirewalls + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/NetworksGetEffectiveFirewallsResponse' + parameters: + - in: path + name: project + required: true schema: type: string - - in: query - name: returnPartialSuccess + - in: path + name: network + required: true schema: - type: boolean - /projects/{project}/zones/{zone}/networkEndpointGroups/{resource}/testIamPermissions: + type: string + /projects/{project}/global/networks/{network}/listPeeringRoutes: parameters: *ref_1 - post: - description: Returns permissions that a caller has on the specified resource. - operationId: compute.networkEndpointGroups.testIamPermissions - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TestPermissionsRequest' + get: + description: Lists the peering routes exchanged over peering connection. + operationId: compute.networks.listPeeringRoutes security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -90661,7 +98233,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TestPermissionsResponse' + $ref: '#/components/schemas/ExchangedPeeringRoutesList' parameters: - in: path name: project @@ -90669,22 +98241,50 @@ paths: schema: type: string - in: path - name: zone + name: network required: true schema: type: string - - in: path - name: resource - required: true + - in: query + name: direction schema: type: string - /projects/{project}/global/networkEndpointGroups: + - in: query + name: filter + schema: + type: string + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: peeringName + schema: + type: string + - in: query + name: region + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean + /projects/{project}/zones/{zone}/nodeGroups: parameters: *ref_1 get: description: >- - Retrieves the list of network endpoint groups that are located in the - specified project. - operationId: compute.globalNetworkEndpointGroups.list + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -90704,13 +98304,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/NetworkEndpointGroupList' + $ref: '#/components/schemas/NodeGroupList' parameters: - in: path name: project required: true schema: type: string + - in: path + name: zone + required: true + schema: + type: string - in: query name: filter schema: @@ -90734,14 +98339,14 @@ paths: type: boolean post: description: >- - Creates a network endpoint group in the specified project using the - parameters that are included in the request. - operationId: compute.globalNetworkEndpointGroups.insert + Creates a NodeGroup resource in the specified project using the data + included in the request. + operationId: compute.nodeGroups.insert requestBody: content: application/json: schema: - $ref: '#/components/schemas/NetworkEndpointGroup' + $ref: '#/components/schemas/NodeGroup' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -90764,15 +98369,94 @@ paths: required: true schema: type: string + - in: path + name: zone + required: true + schema: + type: string + - in: query + name: initialNodeCount + required: true + schema: + type: integer + format: int32 + - in: query + name: requestId + schema: + type: string + /projects/{project}/aggregated/nodeGroups: + parameters: *ref_1 + get: + description: >- + Retrieves an aggregated list of node groups. Note: use + nodeGroups.listNodes for more details about each group. To prevent + failure, Google recommends that you set the `returnPartialSuccess` + parameter to `true`. + operationId: compute.nodeGroups.aggregatedList + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/NodeGroupAggregatedList' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: includeAllScopes + schema: + type: boolean + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy + schema: + type: string - in: query - name: requestId + name: pageToken schema: type: string - /projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}: + - in: query + name: returnPartialSuccess + schema: + type: boolean + - in: query + name: serviceProjectNumber + schema: + type: string + format: int64 + /projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}: parameters: *ref_1 get: - description: Returns the specified network endpoint group. - operationId: compute.globalNetworkEndpointGroups.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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -90792,7 +98476,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/NetworkEndpointGroup' + $ref: '#/components/schemas/NodeGroup' parameters: - in: path name: project @@ -90800,15 +98484,18 @@ paths: schema: type: string - in: path - name: networkEndpointGroup + name: zone + required: true + schema: + type: string + - in: path + name: nodeGroup required: true schema: type: string 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 + description: Deletes the specified NodeGroup resource. + operationId: compute.nodeGroups.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -90832,7 +98519,12 @@ paths: schema: type: string - in: path - name: networkEndpointGroup + name: zone + required: true + schema: + type: string + - in: path + name: nodeGroup required: true schema: type: string @@ -90840,17 +98532,14 @@ paths: name: requestId schema: type: string - /projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints: - parameters: *ref_1 - post: - description: Attach a network endpoint to the specified network endpoint group. - operationId: compute.globalNetworkEndpointGroups.attachNetworkEndpoints + patch: + description: Updates the specified node group. + operationId: compute.nodeGroups.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GlobalNetworkEndpointGroupsAttachEndpointsRequest + $ref: '#/components/schemas/NodeGroup' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -90874,7 +98563,12 @@ paths: schema: type: string - in: path - name: networkEndpointGroup + name: zone + required: true + schema: + type: string + - in: path + name: nodeGroup required: true schema: type: string @@ -90882,17 +98576,16 @@ paths: name: requestId schema: type: string - /projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints: + /projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/addNodes: parameters: *ref_1 post: - description: Detach the network endpoint from the specified network endpoint group. - operationId: compute.globalNetworkEndpointGroups.detachNetworkEndpoints + description: Adds specified number of nodes to the node group. + operationId: compute.nodeGroups.addNodes requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GlobalNetworkEndpointGroupsDetachEndpointsRequest + $ref: '#/components/schemas/NodeGroupsAddNodesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -90916,7 +98609,12 @@ paths: schema: type: string - in: path - name: networkEndpointGroup + name: zone + required: true + schema: + type: string + - in: path + name: nodeGroup required: true schema: type: string @@ -90924,11 +98622,16 @@ paths: name: requestId schema: type: string - /projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints: + /projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/deleteNodes: parameters: *ref_1 post: - description: Lists the network endpoints in the specified network endpoint group. - operationId: compute.globalNetworkEndpointGroups.listNetworkEndpoints + description: Deletes specified nodes from the node group. + operationId: compute.nodeGroups.deleteNodes + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NodeGroupsDeleteNodesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -90938,17 +98641,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/NetworkEndpointGroupsListNetworkEndpoints' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -90956,38 +98655,24 @@ paths: schema: type: string - in: path - name: networkEndpointGroup + name: zone required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy + - in: path + name: nodeGroup + required: true schema: type: string - in: query - name: pageToken + name: requestId schema: type: string - - in: query - name: returnPartialSuccess - schema: - type: boolean - /projects/{project}/regions/{region}/networkEndpointGroups: + /projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/listNodes: parameters: *ref_1 - get: - description: >- - Retrieves the list of regional network endpoint groups available to the - specified project in the given region. - operationId: compute.regionNetworkEndpointGroups.list + post: + description: Lists nodes in the node group. + operationId: compute.nodeGroups.listNodes security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -91007,7 +98692,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/NetworkEndpointGroupList' + $ref: '#/components/schemas/NodeGroupsListNodes' parameters: - in: path name: project @@ -91015,7 +98700,12 @@ paths: schema: type: string - in: path - name: region + name: zone + required: true + schema: + type: string + - in: path + name: nodeGroup required: true schema: type: string @@ -91040,16 +98730,16 @@ paths: name: returnPartialSuccess schema: type: boolean + /projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/setNodeTemplate: + parameters: *ref_1 post: - description: >- - Creates a network endpoint group in the specified project using the - parameters that are included in the request. - operationId: compute.regionNetworkEndpointGroups.insert + description: Updates the node template of the node group. + operationId: compute.nodeGroups.setNodeTemplate requestBody: content: application/json: schema: - $ref: '#/components/schemas/NetworkEndpointGroup' + $ref: '#/components/schemas/NodeGroupsSetNodeTemplateRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -91073,7 +98763,12 @@ paths: schema: type: string - in: path - name: region + name: zone + required: true + schema: + type: string + - in: path + name: nodeGroup required: true schema: type: string @@ -91081,11 +98776,16 @@ paths: name: requestId schema: type: string - /projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}: + /projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/simulateMaintenanceEvent: parameters: *ref_1 - get: - description: Returns the specified network endpoint group. - operationId: compute.regionNetworkEndpointGroups.get + post: + description: Simulates maintenance event on specified nodes from the node group. + operationId: compute.nodeGroups.simulateMaintenanceEvent + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NodeGroupsSimulateMaintenanceEventRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -91095,17 +98795,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/NetworkEndpointGroup' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -91113,20 +98809,29 @@ paths: schema: type: string - in: path - name: region + name: zone required: true schema: type: string - in: path - name: networkEndpointGroup + name: nodeGroup required: true schema: type: string - 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 + - in: query + name: requestId + schema: + type: string + /projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/performMaintenance: + parameters: *ref_1 + post: + description: Perform maintenance on a subset of nodes in the node group. + operationId: compute.nodeGroups.performMaintenance + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NodeGroupsPerformMaintenanceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -91150,12 +98855,12 @@ paths: schema: type: string - in: path - name: region + name: zone required: true schema: type: string - in: path - name: networkEndpointGroup + name: nodeGroup required: true schema: type: string @@ -91163,19 +98868,13 @@ paths: name: requestId schema: type: string - /projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints: + /projects/{project}/zones/{zone}/nodeGroups/{resource}/getIamPolicy: parameters: *ref_1 - post: + get: description: >- - Attach a list of network endpoints to the specified network endpoint - group. - operationId: compute.regionNetworkEndpointGroups.attachNetworkEndpoints - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/RegionNetworkEndpointGroupsAttachEndpointsRequest + Gets the access control policy for a resource. May be empty if no such + policy or resource exists. + operationId: compute.nodeGroups.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -91185,13 +98884,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Policy' parameters: - in: path name: project @@ -91199,30 +98902,32 @@ paths: schema: type: string - in: path - name: region + name: zone required: true schema: type: string - in: path - name: networkEndpointGroup + name: resource required: true schema: type: string - in: query - name: requestId + name: optionsRequestedPolicyVersion schema: - type: string - /projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints: + type: integer + format: int32 + /projects/{project}/zones/{zone}/nodeGroups/{resource}/setIamPolicy: parameters: *ref_1 post: - description: Detach the network endpoint from the specified network endpoint group. - operationId: compute.regionNetworkEndpointGroups.detachNetworkEndpoints + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy. + operationId: compute.nodeGroups.setIamPolicy requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/RegionNetworkEndpointGroupsDetachEndpointsRequest + $ref: '#/components/schemas/ZoneSetPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -91238,7 +98943,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Policy' parameters: - in: path name: project @@ -91246,24 +98951,25 @@ paths: schema: type: string - in: path - name: region + name: zone required: true schema: type: string - in: path - name: networkEndpointGroup + name: resource required: true schema: type: string - - in: query - name: requestId - schema: - type: string - /projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints: + /projects/{project}/zones/{zone}/nodeGroups/{resource}/testIamPermissions: parameters: *ref_1 post: - description: Lists the network endpoints in the specified network endpoint group. - operationId: compute.regionNetworkEndpointGroups.listNetworkEndpoints + description: Returns permissions that a caller has on the specified resource. + operationId: compute.nodeGroups.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -91283,7 +98989,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/NetworkEndpointGroupsListNetworkEndpoints' + $ref: '#/components/schemas/TestPermissionsResponse' parameters: - in: path name: project @@ -91291,41 +98997,20 @@ paths: schema: type: string - in: path - name: region + name: zone required: true schema: type: string - in: path - name: networkEndpointGroup + name: resource required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: returnPartialSuccess - schema: - type: boolean - /projects/{project}/global/networks: + /projects/{project}/regions/{region}/nodeTemplates: parameters: *ref_1 get: - description: Retrieves the list of networks available to the specified project. - operationId: compute.networks.list + description: Retrieves a list of node templates available to the specified project. + operationId: compute.nodeTemplates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -91345,13 +99030,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/NetworkList' + $ref: '#/components/schemas/NodeTemplateList' parameters: - in: path name: project required: true schema: type: string + - in: path + name: region + required: true + schema: + type: string - in: query name: filter schema: @@ -91375,14 +99065,14 @@ paths: type: boolean post: description: >- - Creates a network in the specified project using the data included in - the request. - operationId: compute.networks.insert + Creates a NodeTemplate resource in the specified project using the data + included in the request. + operationId: compute.nodeTemplates.insert requestBody: content: application/json: schema: - $ref: '#/components/schemas/Network' + $ref: '#/components/schemas/NodeTemplate' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -91405,15 +99095,23 @@ paths: required: true schema: type: string + - in: path + name: region + required: true + schema: + type: string - in: query name: requestId schema: type: string - /projects/{project}/global/networks/{network}: + /projects/{project}/aggregated/nodeTemplates: parameters: *ref_1 get: - description: Returns the specified network. - operationId: compute.networks.get + description: >- + Retrieves an aggregated list of node templates. To prevent failure, + Google recommends that you set the `returnPartialSuccess` parameter to + `true`. + operationId: compute.nodeTemplates.aggregatedList security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -91433,62 +99131,48 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Network' + $ref: '#/components/schemas/NodeTemplateAggregatedList' parameters: - in: path name: project required: true schema: type: string - - in: path - name: network - required: true + - in: query + name: filter schema: type: string - delete: - description: Deletes the specified network. - operationId: compute.networks.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/compute - Oauth2c: - - https://www.googleapis.com/auth/compute - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: project - required: true + - in: query + name: includeAllScopes + schema: + type: boolean + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy schema: type: string - - in: path - name: network - required: true + - in: query + name: pageToken schema: type: string - in: query - name: requestId + name: returnPartialSuccess + schema: + type: boolean + - in: query + name: serviceProjectNumber schema: type: string - patch: - description: >- - Patches the specified network with the data included in the request. - Only routingConfig can be modified. - operationId: compute.networks.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Network' + format: int64 + /projects/{project}/regions/{region}/nodeTemplates/{nodeTemplate}: + parameters: *ref_1 + get: + description: Returns the specified node template. + operationId: compute.nodeTemplates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -91498,13 +99182,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/NodeTemplate' parameters: - in: path name: project @@ -91512,27 +99200,18 @@ paths: schema: type: string - in: path - name: network + name: region required: true schema: type: string - - in: query - name: requestId + - in: path + name: nodeTemplate + required: true schema: type: string - /projects/{project}/global/networks/{network}/updatePeering: - parameters: *ref_1 - 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 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/NetworksUpdatePeeringRequest' + delete: + description: Deletes the specified NodeTemplate resource. + operationId: compute.nodeTemplates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -91556,7 +99235,12 @@ paths: schema: type: string - in: path - name: network + name: region + required: true + schema: + type: string + - in: path + name: nodeTemplate required: true schema: type: string @@ -91564,16 +99248,13 @@ paths: name: requestId schema: type: string - /projects/{project}/global/networks/{network}/addPeering: + /projects/{project}/regions/{region}/nodeTemplates/{resource}/getIamPolicy: parameters: *ref_1 - post: - description: Adds a peering to the specified network. - operationId: compute.networks.addPeering - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/NetworksAddPeeringRequest' + get: + description: >- + Gets the access control policy for a resource. May be empty if no such + policy or resource exists. + operationId: compute.nodeTemplates.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -91583,13 +99264,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Policy' parameters: - in: path name: project @@ -91597,24 +99282,32 @@ paths: schema: type: string - in: path - name: network + name: region required: true schema: type: string - - in: query - name: requestId + - in: path + name: resource + required: true schema: type: string - /projects/{project}/global/networks/{network}/removePeering: + - in: query + name: optionsRequestedPolicyVersion + schema: + type: integer + format: int32 + /projects/{project}/regions/{region}/nodeTemplates/{resource}/setIamPolicy: parameters: *ref_1 post: - description: Removes a peering from the specified network. - operationId: compute.networks.removePeering + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy. + operationId: compute.nodeTemplates.setIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/NetworksRemovePeeringRequest' + $ref: '#/components/schemas/RegionSetPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -91630,7 +99323,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Policy' parameters: - in: path name: project @@ -91638,55 +99331,25 @@ paths: schema: type: string - in: path - name: network - required: true - schema: - type: string - - in: query - name: requestId - schema: - type: string - /projects/{project}/global/networks/{network}/switchToCustomMode: - parameters: *ref_1 - post: - description: Switches the network mode from auto subnet mode to custom subnet mode. - operationId: compute.networks.switchToCustomMode - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/compute - Oauth2c: - - https://www.googleapis.com/auth/compute - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: project + name: region required: true schema: type: string - in: path - name: network + name: resource required: true schema: type: string - - in: query - name: requestId - schema: - type: string - /projects/{project}/global/networks/{network}/getEffectiveFirewalls: + /projects/{project}/regions/{region}/nodeTemplates/{resource}/testIamPermissions: parameters: *ref_1 - get: - description: Returns the effective firewalls on a given network. - operationId: compute.networks.getEffectiveFirewalls + post: + description: Returns permissions that a caller has on the specified resource. + operationId: compute.nodeTemplates.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -91706,7 +99369,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/NetworksGetEffectiveFirewallsResponse' + $ref: '#/components/schemas/TestPermissionsResponse' parameters: - in: path name: project @@ -91714,15 +99377,20 @@ paths: schema: type: string - in: path - name: network + name: region required: true schema: type: string - /projects/{project}/global/networks/{network}/listPeeringRoutes: + - in: path + name: resource + required: true + schema: + type: string + /projects/{project}/zones/{zone}/nodeTypes: parameters: *ref_1 get: - description: Lists the peering routes exchanged over peering connection. - operationId: compute.networks.listPeeringRoutes + description: Retrieves a list of node types available to the specified project. + operationId: compute.nodeTypes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -91742,7 +99410,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ExchangedPeeringRoutesList' + $ref: '#/components/schemas/NodeTypeList' parameters: - in: path name: project @@ -91750,14 +99418,10 @@ paths: schema: type: string - in: path - name: network + name: zone required: true schema: type: string - - in: query - name: direction - schema: - type: string - in: query name: filter schema: @@ -91775,25 +99439,17 @@ paths: name: pageToken schema: type: string - - in: query - name: peeringName - schema: - type: string - - in: query - name: region - schema: - type: string - in: query name: returnPartialSuccess schema: type: boolean - /projects/{project}/zones/{zone}/nodeGroups: + /projects/{project}/aggregated/nodeTypes: parameters: *ref_1 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 + Retrieves an aggregated list of node types. To prevent failure, Google + recommends that you set the `returnPartialSuccess` parameter to `true`. + operationId: compute.nodeTypes.aggregatedList security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -91813,22 +99469,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/NodeGroupList' + $ref: '#/components/schemas/NodeTypeAggregatedList' parameters: - in: path name: project required: true schema: type: string - - in: path - name: zone - required: true - schema: - type: string - in: query name: filter schema: type: string + - in: query + name: includeAllScopes + schema: + type: boolean - in: query name: maxResults schema: @@ -91846,16 +99501,16 @@ paths: name: returnPartialSuccess schema: type: boolean - post: - description: >- - Creates a NodeGroup resource in the specified project using the data - included in the request. - operationId: compute.nodeGroups.insert - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/NodeGroup' + - in: query + name: serviceProjectNumber + schema: + type: string + format: int64 + /projects/{project}/zones/{zone}/nodeTypes/{nodeType}: + parameters: *ref_1 + get: + description: Returns the specified node type. + operationId: compute.nodeTypes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -91865,13 +99520,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/NodeType' parameters: - in: path name: project @@ -91883,25 +99542,16 @@ paths: required: true schema: type: string - - in: query - name: initialNodeCount + - in: path + name: nodeType required: true - schema: - type: integer - format: int32 - - in: query - name: requestId schema: type: string - /projects/{project}/aggregated/nodeGroups: + /projects/{project}/regions/{region}/notificationEndpoints: parameters: *ref_1 get: - description: >- - Retrieves an aggregated list of node groups. Note: use - nodeGroups.listNodes for more details about each group. To prevent - failure, Google recommends that you set the `returnPartialSuccess` - parameter to `true`. - operationId: compute.nodeGroups.aggregatedList + description: Lists the NotificationEndpoints for a project in the given region. + operationId: compute.regionNotificationEndpoints.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -91921,21 +99571,22 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/NodeGroupAggregatedList' + $ref: '#/components/schemas/NotificationEndpointList' parameters: - in: path name: project required: true schema: type: string - - in: query - name: filter + - in: path + name: region + required: true schema: type: string - in: query - name: includeAllScopes + name: filter schema: - type: boolean + type: string - in: query name: maxResults schema: @@ -91953,19 +99604,52 @@ paths: name: returnPartialSuccess schema: type: boolean + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationEndpoint' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: region + required: true + schema: + type: string - in: query - name: serviceProjectNumber + name: requestId schema: type: string - format: int64 - /projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}: + /projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}: parameters: *ref_1 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 + description: Returns the specified NotificationEndpoint resource in the given region. + operationId: compute.regionNotificationEndpoints.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -91985,7 +99669,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/NodeGroup' + $ref: '#/components/schemas/NotificationEndpoint' parameters: - in: path name: project @@ -91993,18 +99677,18 @@ paths: schema: type: string - in: path - name: zone + name: region required: true schema: type: string - in: path - name: nodeGroup + name: notificationEndpoint required: true schema: type: string delete: - description: Deletes the specified NodeGroup resource. - operationId: compute.nodeGroups.delete + description: Deletes the specified NotificationEndpoint in the given region + operationId: compute.regionNotificationEndpoints.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -92028,12 +99712,12 @@ paths: schema: type: string - in: path - name: zone + name: region required: true schema: type: string - in: path - name: nodeGroup + name: notificationEndpoint required: true schema: type: string @@ -92041,14 +99725,58 @@ paths: name: requestId schema: type: string + /projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}: + parameters: *ref_1 + get: + description: Returns the specified PacketMirroring resource. + operationId: compute.packetMirrorings.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/PacketMirroring' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: region + required: true + schema: + type: string + - in: path + name: packetMirroring + required: true + schema: + type: string patch: - description: Updates the specified node group. - operationId: compute.nodeGroups.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 requestBody: content: application/json: schema: - $ref: '#/components/schemas/NodeGroup' + $ref: '#/components/schemas/PacketMirroring' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -92072,12 +99800,12 @@ paths: schema: type: string - in: path - name: zone + name: region required: true schema: type: string - in: path - name: nodeGroup + name: packetMirroring required: true schema: type: string @@ -92085,16 +99813,9 @@ paths: name: requestId schema: type: string - /projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/addNodes: - parameters: *ref_1 - post: - description: Adds specified number of nodes to the node group. - operationId: compute.nodeGroups.addNodes - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/NodeGroupsAddNodesRequest' + delete: + description: Deletes the specified PacketMirroring resource. + operationId: compute.packetMirrorings.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -92118,12 +99839,12 @@ paths: schema: type: string - in: path - name: zone + name: region required: true schema: type: string - in: path - name: nodeGroup + name: packetMirroring required: true schema: type: string @@ -92131,16 +99852,18 @@ paths: name: requestId schema: type: string - /projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/deleteNodes: + /projects/{project}/regions/{region}/packetMirrorings: parameters: *ref_1 post: - description: Deletes specified nodes from the node group. - operationId: compute.nodeGroups.deleteNodes + description: >- + Creates a PacketMirroring resource in the specified project and region + using the data included in the request. + operationId: compute.packetMirrorings.insert requestBody: content: application/json: schema: - $ref: '#/components/schemas/NodeGroupsDeleteNodesRequest' + $ref: '#/components/schemas/PacketMirroring' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -92164,12 +99887,7 @@ paths: schema: type: string - in: path - name: zone - required: true - schema: - type: string - - in: path - name: nodeGroup + name: region required: true schema: type: string @@ -92177,11 +99895,11 @@ paths: name: requestId schema: type: string - /projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/listNodes: - parameters: *ref_1 - post: - description: Lists nodes in the node group. - operationId: compute.nodeGroups.listNodes + get: + description: >- + Retrieves a list of PacketMirroring resources available to the specified + project and region. + operationId: compute.packetMirrorings.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -92201,7 +99919,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/NodeGroupsListNodes' + $ref: '#/components/schemas/PacketMirroringList' parameters: - in: path name: project @@ -92209,12 +99927,7 @@ paths: schema: type: string - in: path - name: zone - required: true - schema: - type: string - - in: path - name: nodeGroup + name: region required: true schema: type: string @@ -92239,16 +99952,14 @@ paths: name: returnPartialSuccess schema: type: boolean - /projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/setNodeTemplate: + /projects/{project}/aggregated/packetMirrorings: parameters: *ref_1 - post: - description: Updates the node template of the node group. - operationId: compute.nodeGroups.setNodeTemplate - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/NodeGroupsSetNodeTemplateRequest' + get: + description: >- + Retrieves an aggregated list of packetMirrorings. To prevent failure, + Google recommends that you set the `returnPartialSuccess` parameter to + `true`. + operationId: compute.packetMirrorings.aggregatedList security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -92258,43 +99969,63 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/PacketMirroringAggregatedList' parameters: - in: path name: project required: true schema: type: string - - in: path - name: zone - required: true + - in: query + name: filter schema: type: string - - in: path - name: nodeGroup - required: true + - in: query + name: includeAllScopes + schema: + type: boolean + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy schema: type: string - in: query - name: requestId + name: pageToken schema: type: string - /projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/simulateMaintenanceEvent: + - in: query + name: returnPartialSuccess + schema: + type: boolean + - in: query + name: serviceProjectNumber + schema: + type: string + format: int64 + /projects/{project}/regions/{region}/packetMirrorings/{resource}/testIamPermissions: parameters: *ref_1 post: - description: Simulates maintenance event on specified nodes from the node group. - operationId: compute.nodeGroups.simulateMaintenanceEvent + description: Returns permissions that a caller has on the specified resource. + operationId: compute.packetMirrorings.testIamPermissions requestBody: content: application/json: schema: - $ref: '#/components/schemas/NodeGroupsSimulateMaintenanceEventRequest' + $ref: '#/components/schemas/TestPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -92304,13 +100035,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/TestPermissionsResponse' parameters: - in: path name: project @@ -92318,29 +100053,66 @@ paths: schema: type: string - in: path - name: zone + name: region required: true schema: type: string - in: path - name: nodeGroup + name: resource required: true schema: type: string - - in: query - name: requestId + /projects/{project}: + parameters: *ref_1 + get: + description: >- + Returns the specified Project resource. To decrease latency for this + method, you can optionally omit any unneeded information from the + response by using a field mask. This practice is especially recommended + for unused quota information (the `quotas` field). To exclude one or + more fields, set your request's `fields` query parameter to only include + the fields you need. For example, to only include the `id` and + `selfLink` fields, add the query parameter `?fields=id,selfLink` to your + request. + operationId: compute.projects.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Project' + parameters: + - in: path + name: project + required: true schema: type: string - /projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/performMaintenance: + /projects/{project}/setCommonInstanceMetadata: parameters: *ref_1 post: - description: Perform maintenance on a subset of nodes in the node group. - operationId: compute.nodeGroups.performMaintenance + description: >- + Sets metadata common to all instances within the specified project using + the data included in the request. + operationId: compute.projects.setCommonInstanceMetadata requestBody: content: application/json: schema: - $ref: '#/components/schemas/NodeGroupsPerformMaintenanceRequest' + $ref: '#/components/schemas/Metadata' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -92363,27 +100135,23 @@ paths: required: true schema: type: string - - in: path - name: zone - required: true - schema: - type: string - - in: path - name: nodeGroup - required: true - schema: - type: string - in: query name: requestId schema: type: string - /projects/{project}/zones/{zone}/nodeGroups/{resource}/getIamPolicy: + /projects/{project}/setUsageExportBucket: parameters: *ref_1 - get: + post: description: >- - Gets the access control policy for a resource. May be empty if no such - policy or resource exists. - operationId: compute.nodeGroups.getIamPolicy + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UsageExportLocation' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -92394,49 +100162,50 @@ paths: Oauth2c: - https://www.googleapis.com/auth/compute - Oauth2: - - https://www.googleapis.com/auth/compute.readonly + - https://www.googleapis.com/auth/devstorage.full_control Oauth2c: - - https://www.googleapis.com/auth/compute.readonly + - 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 responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project required: true schema: type: string - - in: path - name: zone - required: true - schema: - type: string - - in: path - name: resource - required: true - schema: - type: string - in: query - name: optionsRequestedPolicyVersion + name: requestId schema: - type: integer - format: int32 - /projects/{project}/zones/{zone}/nodeGroups/{resource}/setIamPolicy: + type: string + /projects/{project}/moveInstance: parameters: *ref_1 post: description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. - operationId: compute.nodeGroups.setIamPolicy + Moves an instance and its attached persistent disks from one zone to + another. *Note*: Moving VMs or disks by using this method might cause + unexpected behavior. For more information, see the [known + issue](/compute/docs/troubleshooting/known-issues#moving_vms_or_disks_using_the_moveinstance_api_or_the_causes_unexpected_behavior). + [Deprecated] This method is deprecated. See [moving instance across + zones](/compute/docs/instances/moving-instance-across-zones) instead. + operationId: compute.projects.moveInstance requestBody: content: application/json: schema: - $ref: '#/components/schemas/ZoneSetPolicyRequest' + $ref: '#/components/schemas/InstanceMoveRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -92452,33 +100221,27 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project required: true schema: type: string - - in: path - name: zone - required: true - schema: - type: string - - in: path - name: resource - required: true + - in: query + name: requestId schema: type: string - /projects/{project}/zones/{zone}/nodeGroups/{resource}/testIamPermissions: + /projects/{project}/moveDisk: parameters: *ref_1 post: - description: Returns permissions that a caller has on the specified resource. - operationId: compute.nodeGroups.testIamPermissions + description: Moves a persistent disk from one zone to another. + operationId: compute.projects.moveDisk requestBody: content: application/json: schema: - $ref: '#/components/schemas/TestPermissionsRequest' + $ref: '#/components/schemas/DiskMoveRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -92488,38 +100251,35 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/TestPermissionsResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project required: true schema: type: string - - in: path - name: zone - required: true - schema: - type: string - - in: path - name: resource - required: true - schema: - type: string - /projects/{project}/regions/{region}/nodeTemplates: + - in: query + name: requestId + schema: + type: string + /projects/{project}/listXpnHosts: parameters: *ref_1 - get: - description: Retrieves a list of node templates available to the specified project. - operationId: compute.nodeTemplates.list + post: + description: >- + Lists all shared VPC host projects visible to the user in an + organization. + operationId: compute.projects.listXpnHosts + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ProjectsListXpnHostsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -92529,28 +100289,19 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/NodeTemplateList' + $ref: '#/components/schemas/XpnHostList' parameters: - in: path name: project required: true schema: type: string - - in: path - name: region - required: true - schema: - type: string - in: query name: filter schema: @@ -92572,16 +100323,11 @@ paths: name: returnPartialSuccess schema: type: boolean + /projects/{project}/enableXpnHost: + parameters: *ref_1 post: - description: >- - Creates a NodeTemplate resource in the specified project using the data - included in the request. - operationId: compute.nodeTemplates.insert - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/NodeTemplate' + description: Enable this project as a shared VPC host project. + operationId: compute.projects.enableXpnHost security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -92604,23 +100350,15 @@ paths: required: true schema: type: string - - in: path - name: region - required: true - schema: - type: string - in: query name: requestId schema: type: string - /projects/{project}/aggregated/nodeTemplates: + /projects/{project}/disableXpnHost: parameters: *ref_1 - get: - description: >- - Retrieves an aggregated list of node templates. To prevent failure, - Google recommends that you set the `returnPartialSuccess` parameter to - `true`. - operationId: compute.nodeTemplates.aggregatedList + post: + description: Disable this project as a shared VPC host project. + operationId: compute.projects.disableXpnHost security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -92630,17 +100368,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/NodeTemplateAggregatedList' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -92648,40 +100382,22 @@ paths: schema: type: string - in: query - name: filter - schema: - type: string - - in: query - name: includeAllScopes - schema: - type: boolean - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: returnPartialSuccess - schema: - type: boolean - - in: query - name: serviceProjectNumber + name: requestId schema: type: string - format: int64 - /projects/{project}/regions/{region}/nodeTemplates/{nodeTemplate}: + /projects/{project}/enableXpnResource: parameters: *ref_1 - get: - description: Returns the specified node template. - operationId: compute.nodeTemplates.get + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ProjectsEnableXpnResourceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -92691,36 +100407,35 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/NodeTemplate' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project required: true schema: type: string - - in: path - name: region - required: true - schema: - type: string - - in: path - name: nodeTemplate - required: true + - in: query + name: requestId schema: type: string - delete: - description: Deletes the specified NodeTemplate resource. - operationId: compute.nodeTemplates.delete + /projects/{project}/disableXpnResource: + parameters: *ref_1 + post: + description: >- + Disable a service resource (also known as service project) associated + with this host project. + operationId: compute.projects.disableXpnResource + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ProjectsDisableXpnResourceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -92743,27 +100458,17 @@ paths: required: true schema: type: string - - in: path - name: region - required: true - schema: - type: string - - in: path - name: nodeTemplate - required: true - schema: - type: string - in: query name: requestId schema: type: string - /projects/{project}/regions/{region}/nodeTemplates/{resource}/getIamPolicy: + /projects/{project}/getXpnHost: parameters: *ref_1 get: description: >- - Gets the access control policy for a resource. May be empty if no such - policy or resource exists. - operationId: compute.nodeTemplates.getIamPolicy + Gets the shared VPC host project that this project links to. May be + empty if no link exists. + operationId: compute.projects.getXpnHost security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -92773,50 +100478,82 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Project' parameters: - in: path name: project required: true schema: type: string + /projects/{project}/getXpnResources: + parameters: *ref_1 + get: + description: >- + Gets service resources (a.k.a service project) associated with this host + project. + operationId: compute.projects.getXpnResources + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ProjectsGetXpnResources' + parameters: - in: path - name: region + name: project required: true schema: type: string - - in: path - name: resource - required: true + - in: query + name: filter schema: type: string - in: query - name: optionsRequestedPolicyVersion + name: maxResults schema: type: integer - format: int32 - /projects/{project}/regions/{region}/nodeTemplates/{resource}/setIamPolicy: + format: uint32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean + /projects/{project}/setDefaultNetworkTier: parameters: *ref_1 post: description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. - operationId: compute.nodeTemplates.setIamPolicy + 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 requestBody: content: application/json: schema: - $ref: '#/components/schemas/RegionSetPolicyRequest' + $ref: '#/components/schemas/ProjectsSetDefaultNetworkTierRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -92832,33 +100569,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project required: true schema: type: string - - in: path - name: region - required: true - schema: - type: string - - in: path - name: resource - required: true + - in: query + name: requestId schema: type: string - /projects/{project}/regions/{region}/nodeTemplates/{resource}/testIamPermissions: + /projects/{project}/setCloudArmorTier: parameters: *ref_1 post: - description: Returns permissions that a caller has on the specified resource. - operationId: compute.nodeTemplates.testIamPermissions + description: >- + Sets the Cloud Armor tier of the project. To set ENTERPRISE or above the + billing account of the project must be subscribed to Cloud Armor + Enterprise. See Subscribing to Cloud Armor Enterprise for more + information. + operationId: compute.projects.setCloudArmorTier requestBody: content: application/json: schema: - $ref: '#/components/schemas/TestPermissionsRequest' + $ref: '#/components/schemas/ProjectsSetCloudArmorTierRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -92868,38 +100603,28 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/TestPermissionsResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project required: true schema: type: string - - in: path - name: region - required: true - schema: - type: string - - in: path - name: resource - required: true + - in: query + name: requestId schema: type: string - /projects/{project}/zones/{zone}/nodeTypes: + /projects/{project}/global/publicAdvertisedPrefixes: parameters: *ref_1 get: - description: Retrieves a list of node types available to the specified project. - operationId: compute.nodeTypes.list + description: Lists the PublicAdvertisedPrefixes for a project. + operationId: compute.publicAdvertisedPrefixes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -92919,18 +100644,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/NodeTypeList' + $ref: '#/components/schemas/PublicAdvertisedPrefixList' parameters: - in: path name: project required: true schema: type: string - - in: path - name: zone - required: true - schema: - type: string - in: query name: filter schema: @@ -92952,13 +100672,16 @@ paths: name: returnPartialSuccess schema: type: boolean - /projects/{project}/aggregated/nodeTypes: - parameters: *ref_1 - get: + post: description: >- - Retrieves an aggregated list of node types. To prevent failure, Google - recommends that you set the `returnPartialSuccess` parameter to `true`. - operationId: compute.nodeTypes.aggregatedList + Creates a PublicAdvertisedPrefix in the specified project using the + parameters that are included in the request. + operationId: compute.publicAdvertisedPrefixes.insert + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PublicAdvertisedPrefix' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -92968,17 +100691,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/NodeTypeAggregatedList' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -92986,40 +100705,14 @@ paths: schema: type: string - in: query - name: filter - schema: - type: string - - in: query - name: includeAllScopes - schema: - type: boolean - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: returnPartialSuccess - schema: - type: boolean - - in: query - name: serviceProjectNumber + name: requestId schema: type: string - format: int64 - /projects/{project}/zones/{zone}/nodeTypes/{nodeType}: + /projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}: parameters: *ref_1 get: - description: Returns the specified node type. - operationId: compute.nodeTypes.get + description: Returns the specified PublicAdvertisedPrefix resource. + operationId: compute.publicAdvertisedPrefixes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -93039,7 +100732,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/NodeType' + $ref: '#/components/schemas/PublicAdvertisedPrefix' parameters: - in: path name: project @@ -93047,20 +100740,13 @@ paths: schema: type: string - in: path - name: zone - required: true - schema: - type: string - - in: path - name: nodeType + name: publicAdvertisedPrefix required: true schema: type: string - /projects/{project}/regions/{region}/notificationEndpoints: - parameters: *ref_1 - get: - description: Lists the NotificationEndpoints for a project in the given region. - operationId: compute.regionNotificationEndpoints.list + delete: + description: Deletes the specified PublicAdvertisedPrefix + operationId: compute.publicAdvertisedPrefixes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -93070,17 +100756,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/NotificationEndpointList' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -93088,41 +100770,25 @@ paths: schema: type: string - in: path - name: region + name: publicAdvertisedPrefix required: true schema: type: string - in: query - name: filter - schema: - type: string - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken + name: requestId schema: type: string - - in: query - name: returnPartialSuccess - schema: - type: boolean - post: + patch: 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 + 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 requestBody: content: application/json: schema: - $ref: '#/components/schemas/NotificationEndpoint' + $ref: '#/components/schemas/PublicAdvertisedPrefix' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -93146,7 +100812,7 @@ paths: schema: type: string - in: path - name: region + name: publicAdvertisedPrefix required: true schema: type: string @@ -93154,11 +100820,11 @@ paths: name: requestId schema: type: string - /projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}: + /projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}/announce: parameters: *ref_1 - get: - description: Returns the specified NotificationEndpoint resource in the given region. - operationId: compute.regionNotificationEndpoints.get + post: + description: Announces the specified PublicAdvertisedPrefix + operationId: compute.publicAdvertisedPrefixes.announce security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -93168,17 +100834,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/NotificationEndpoint' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -93186,18 +100848,19 @@ paths: schema: type: string - in: path - name: region + name: publicAdvertisedPrefix required: true schema: type: string - - in: path - name: notificationEndpoint - required: true + - in: query + name: requestId schema: type: string - delete: - description: Deletes the specified NotificationEndpoint in the given region - operationId: compute.regionNotificationEndpoints.delete + /projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}/withdraw: + parameters: *ref_1 + post: + description: Withdraws the specified PublicAdvertisedPrefix + operationId: compute.publicAdvertisedPrefixes.withdraw security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -93221,12 +100884,7 @@ paths: schema: type: string - in: path - name: region - required: true - schema: - type: string - - in: path - name: notificationEndpoint + name: publicAdvertisedPrefix required: true schema: type: string @@ -93234,11 +100892,11 @@ paths: name: requestId schema: type: string - /projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}: + /projects/{project}/global/publicDelegatedPrefixes: parameters: *ref_1 get: - description: Returns the specified PacketMirroring resource. - operationId: compute.packetMirrorings.get + description: Lists the global PublicDelegatedPrefixes for a project. + operationId: compute.globalPublicDelegatedPrefixes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -93258,34 +100916,44 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PacketMirroring' + $ref: '#/components/schemas/PublicDelegatedPrefixList' parameters: - in: path name: project required: true schema: type: string - - in: path - name: region - required: true + - in: query + name: filter schema: type: string - - in: path - name: packetMirroring - required: true + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy schema: type: string - patch: + - in: query + name: pageToken + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean + post: 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 + Creates a global PublicDelegatedPrefix in the specified project using + the parameters that are included in the request. + operationId: compute.globalPublicDelegatedPrefixes.insert requestBody: content: application/json: schema: - $ref: '#/components/schemas/PacketMirroring' + $ref: '#/components/schemas/PublicDelegatedPrefix' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -93308,23 +100976,15 @@ paths: required: true schema: type: string - - in: path - name: region - required: true - schema: - type: string - - in: path - name: packetMirroring - required: true - schema: - type: string - in: query name: requestId schema: type: string - delete: - description: Deletes the specified PacketMirroring resource. - operationId: compute.packetMirrorings.delete + /projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}: + parameters: *ref_1 + get: + description: Returns the specified global PublicDelegatedPrefix resource. + operationId: compute.globalPublicDelegatedPrefixes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -93334,13 +100994,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/PublicDelegatedPrefix' parameters: - in: path name: project @@ -93348,31 +101012,13 @@ paths: schema: type: string - in: path - name: region - required: true - schema: - type: string - - in: path - name: packetMirroring + name: publicDelegatedPrefix required: true schema: type: string - - in: query - name: requestId - schema: - type: string - /projects/{project}/regions/{region}/packetMirrorings: - parameters: *ref_1 - post: - description: >- - Creates a PacketMirroring resource in the specified project and region - using the data included in the request. - operationId: compute.packetMirrorings.insert - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PacketMirroring' + delete: + description: Deletes the specified global PublicDelegatedPrefix. + operationId: compute.globalPublicDelegatedPrefixes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -93396,7 +101042,7 @@ paths: schema: type: string - in: path - name: region + name: publicDelegatedPrefix required: true schema: type: string @@ -93404,11 +101050,17 @@ paths: name: requestId schema: type: string - get: + patch: description: >- - Retrieves a list of PacketMirroring resources available to the specified - project and region. - operationId: compute.packetMirrorings.list + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PublicDelegatedPrefix' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -93418,17 +101070,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/PacketMirroringList' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -93436,39 +101084,19 @@ paths: schema: type: string - in: path - name: region + name: publicDelegatedPrefix required: true schema: type: string - in: query - name: filter - schema: - type: string - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken + name: requestId schema: type: string - - in: query - name: returnPartialSuccess - schema: - type: boolean - /projects/{project}/aggregated/packetMirrorings: + /projects/{project}/regions/{region}/publicDelegatedPrefixes: parameters: *ref_1 get: - description: >- - Retrieves an aggregated list of packetMirrorings. To prevent failure, - Google recommends that you set the `returnPartialSuccess` parameter to - `true`. - operationId: compute.packetMirrorings.aggregatedList + description: Lists the PublicDelegatedPrefixes for a project in the given region. + operationId: compute.publicDelegatedPrefixes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -93488,21 +101116,22 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PacketMirroringAggregatedList' + $ref: '#/components/schemas/PublicDelegatedPrefixList' parameters: - in: path name: project required: true schema: type: string - - in: query - name: filter + - in: path + name: region + required: true schema: type: string - in: query - name: includeAllScopes + name: filter schema: - type: boolean + type: string - in: query name: maxResults schema: @@ -93520,21 +101149,16 @@ paths: name: returnPartialSuccess schema: type: boolean - - in: query - name: serviceProjectNumber - schema: - type: string - format: int64 - /projects/{project}/regions/{region}/packetMirrorings/{resource}/testIamPermissions: - parameters: *ref_1 post: - description: Returns permissions that a caller has on the specified resource. - operationId: compute.packetMirrorings.testIamPermissions + 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 requestBody: content: application/json: schema: - $ref: '#/components/schemas/TestPermissionsRequest' + $ref: '#/components/schemas/PublicDelegatedPrefix' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -93544,17 +101168,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/TestPermissionsResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -93566,24 +101186,17 @@ paths: required: true schema: type: string - - in: path - name: resource - required: true + - in: query + name: requestId schema: type: string - /projects/{project}: + /projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}: parameters: *ref_1 get: description: >- - Returns the specified Project resource. To decrease latency for this - method, you can optionally omit any unneeded information from the - response by using a field mask. This practice is especially recommended - for unused quota information (the `quotas` field). To exclude one or - more fields, set your request's `fields` query parameter to only include - the fields you need. For example, to only include the `id` and - `selfLink` fields, add the query parameter `?fields=id,selfLink` to your - request. - operationId: compute.projects.get + Returns the specified PublicDelegatedPrefix resource in the given + region. + operationId: compute.publicDelegatedPrefixes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -93603,25 +101216,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Project' + $ref: '#/components/schemas/PublicDelegatedPrefix' parameters: - in: path name: project required: true schema: type: string - /projects/{project}/setCommonInstanceMetadata: - parameters: *ref_1 - post: - description: >- - Sets metadata common to all instances within the specified project using - the data included in the request. - operationId: compute.projects.setCommonInstanceMetadata - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Metadata' + - in: path + name: region + required: true + schema: + type: string + - in: path + name: publicDelegatedPrefix + required: true + schema: + type: string + delete: + description: Deletes the specified PublicDelegatedPrefix in the given region. + operationId: compute.publicDelegatedPrefixes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -93644,23 +101258,31 @@ paths: required: true schema: type: string + - in: path + name: region + required: true + schema: + type: string + - in: path + name: publicDelegatedPrefix + required: true + schema: + type: string - in: query name: requestId schema: type: string - /projects/{project}/setUsageExportBucket: - parameters: *ref_1 - post: + patch: 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 + 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 requestBody: content: application/json: schema: - $ref: '#/components/schemas/UsageExportLocation' + $ref: '#/components/schemas/PublicDelegatedPrefix' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -93670,18 +101292,6 @@ paths: - 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 responses: '200': description: Successful response @@ -93695,26 +101305,25 @@ paths: required: true schema: type: string + - in: path + name: region + required: true + schema: + type: string + - in: path + name: publicDelegatedPrefix + required: true + schema: + type: string - in: query name: requestId schema: type: string - /projects/{project}/moveInstance: + /projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}/announce: parameters: *ref_1 post: - description: >- - Moves an instance and its attached persistent disks from one zone to - another. *Note*: Moving VMs or disks by using this method might cause - unexpected behavior. For more information, see the [known - issue](/compute/docs/troubleshooting/known-issues#moving_vms_or_disks_using_the_moveinstance_api_or_the_causes_unexpected_behavior). - [Deprecated] This method is deprecated. See [moving instance across - zones](/compute/docs/instances/moving-instance-across-zones) instead. - operationId: compute.projects.moveInstance - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/InstanceMoveRequest' + description: Announces the specified PublicDelegatedPrefix in the given region. + operationId: compute.publicDelegatedPrefixes.announce security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -93737,20 +101346,25 @@ paths: required: true schema: type: string + - in: path + name: region + required: true + schema: + type: string + - in: path + name: publicDelegatedPrefix + required: true + schema: + type: string - in: query name: requestId schema: type: string - /projects/{project}/moveDisk: + /projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}/withdraw: parameters: *ref_1 post: - description: Moves a persistent disk from one zone to another. - operationId: compute.projects.moveDisk - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DiskMoveRequest' + description: Withdraws the specified PublicDelegatedPrefix in the given region. + operationId: compute.publicDelegatedPrefixes.withdraw security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -93773,22 +101387,28 @@ paths: required: true schema: type: string + - in: path + name: region + required: true + schema: + type: string + - in: path + name: publicDelegatedPrefix + required: true + schema: + type: string - in: query name: requestId schema: type: string - /projects/{project}/listXpnHosts: + /projects/{project}/aggregated/publicDelegatedPrefixes: parameters: *ref_1 - post: + get: description: >- - Lists all shared VPC host projects visible to the user in an - organization. - operationId: compute.projects.listXpnHosts - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ProjectsListXpnHostsRequest' + Lists all PublicDelegatedPrefix resources owned by the specific project + across all scopes. To prevent failure, Google recommends that you set + the `returnPartialSuccess` parameter to `true`. + operationId: compute.publicDelegatedPrefixes.aggregatedList security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -93798,13 +101418,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/XpnHostList' + $ref: '#/components/schemas/PublicDelegatedPrefixAggregatedList' parameters: - in: path name: project @@ -93815,6 +101439,10 @@ paths: name: filter schema: type: string + - in: query + name: includeAllScopes + schema: + type: boolean - in: query name: maxResults schema: @@ -93832,42 +101460,31 @@ paths: name: returnPartialSuccess schema: type: boolean - /projects/{project}/enableXpnHost: - parameters: *ref_1 - post: - description: Enable this project as a shared VPC host project. - operationId: compute.projects.enableXpnHost - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/compute - Oauth2c: - - https://www.googleapis.com/auth/compute - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: project - required: true - schema: - type: string - in: query - name: requestId + name: serviceProjectNumber schema: type: string - /projects/{project}/disableXpnHost: + format: int64 + /projects/{project}/regions: parameters: *ref_1 - post: - description: Disable this project as a shared VPC host project. - operationId: compute.projects.disableXpnHost + get: + description: >- + Retrieves the list of region resources available to the specified + project. To decrease latency for this method, you can optionally omit + any unneeded information from the response by using a field mask. This + practice is especially recommended for unused quota information (the + `items.quotas` field). To exclude one or more fields, set your request's + `fields` query parameter to only include the fields you need. For + example, to only include the `id` and `selfLink` fields, add the query + parameter `?fields=id,selfLink` to your request. This method fails if + the quota information is unavailable for the region and if the + organization policy constraint compute.requireBasicQuotaInResponse is + enforced. This constraint, when enforced, disables the fail-open + behaviour when quota information (the `items.quotas` field) is + unavailable for the region. It is recommended to use the default setting + for the constraint unless your application requires the fail-closed + behaviour for this method. + operationId: compute.regions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -93877,13 +101494,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/RegionList' parameters: - in: path name: project @@ -93891,60 +101512,45 @@ paths: schema: type: string - in: query - name: requestId + name: filter schema: type: string - /projects/{project}/enableXpnResource: - parameters: *ref_1 - 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 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ProjectsEnableXpnResourceRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/compute - Oauth2c: - - https://www.googleapis.com/auth/compute - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: project - required: true + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy schema: type: string - in: query - name: requestId + name: pageToken schema: type: string - /projects/{project}/disableXpnResource: + - in: query + name: returnPartialSuccess + schema: + type: boolean + /projects/{project}/regions/{region}: parameters: *ref_1 - post: + get: description: >- - Disable a service resource (also known as service project) associated - with this host project. - operationId: compute.projects.disableXpnResource - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ProjectsDisableXpnResourceRequest' + Returns the specified Region resource. To decrease latency for this + method, you can optionally omit any unneeded information from the + response by using a field mask. This practice is especially recommended + for unused quota information (the `quotas` field). To exclude one or + more fields, set your request's `fields` query parameter to only include + the fields you need. For example, to only include the `id` and + `selfLink` fields, add the query parameter `?fields=id,selfLink` to your + request. This method fails if the quota information is unavailable for + the region and if the organization policy constraint + compute.requireBasicQuotaInResponse is enforced. This constraint, when + enforced, disables the fail-open behaviour when quota information (the + `items.quotas` field) is unavailable for the region. It is recommended + to use the default setting for the constraint unless your application + requires the fail-closed behaviour for this method. + operationId: compute.regions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -93954,30 +101560,33 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Region' parameters: - in: path name: project required: true schema: type: string - - in: query - name: requestId + - in: path + name: region + required: true schema: type: string - /projects/{project}/getXpnHost: + /projects/{project}/regions/{region}/subnetworks: parameters: *ref_1 get: - description: >- - Gets the shared VPC host project that this project links to. May be - empty if no link exists. - operationId: compute.projects.getXpnHost + description: Retrieves a list of subnetworks available to the specified project. + operationId: compute.subnetworks.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -93987,45 +101596,25 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Project' + $ref: '#/components/schemas/SubnetworkList' parameters: - in: path name: project required: true schema: type: string - /projects/{project}/getXpnResources: - parameters: *ref_1 - get: - description: >- - Gets service resources (a.k.a service project) associated with this host - project. - operationId: compute.projects.getXpnResources - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/compute - Oauth2c: - - https://www.googleapis.com/auth/compute - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/ProjectsGetXpnResources' - parameters: - in: path - name: project + name: region required: true schema: type: string @@ -94050,19 +101639,16 @@ paths: name: returnPartialSuccess schema: type: boolean - /projects/{project}/setDefaultNetworkTier: - parameters: *ref_1 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 + Creates a subnetwork in the specified project using the data included in + the request. + operationId: compute.subnetworks.insert requestBody: content: application/json: schema: - $ref: '#/components/schemas/ProjectsSetDefaultNetworkTierRequest' + $ref: '#/components/schemas/Subnetwork' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -94085,24 +101671,22 @@ paths: required: true schema: type: string + - in: path + name: region + required: true + schema: + type: string - in: query name: requestId schema: type: string - /projects/{project}/setCloudArmorTier: + /projects/{project}/aggregated/subnetworks: parameters: *ref_1 - post: + get: description: >- - Sets the Cloud Armor tier of the project. To set ENTERPRISE or above the - billing account of the project must be subscribed to Cloud Armor - Enterprise. See Subscribing to Cloud Armor Enterprise for more - information. - operationId: compute.projects.setCloudArmorTier - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ProjectsSetCloudArmorTierRequest' + Retrieves an aggregated list of subnetworks. To prevent failure, Google + recommends that you set the `returnPartialSuccess` parameter to `true`. + operationId: compute.subnetworks.aggregatedList security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -94112,13 +101696,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/SubnetworkAggregatedList' parameters: - in: path name: project @@ -94126,14 +101714,40 @@ paths: schema: type: string - in: query - name: requestId + name: filter schema: type: string - /projects/{project}/global/publicAdvertisedPrefixes: + - in: query + name: includeAllScopes + schema: + type: boolean + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean + - in: query + name: serviceProjectNumber + schema: + type: string + format: int64 + /projects/{project}/aggregated/subnetworks/listUsable: parameters: *ref_1 get: - description: Lists the PublicAdvertisedPrefixes for a project. - operationId: compute.publicAdvertisedPrefixes.list + description: Retrieves an aggregated list of all usable subnetworks in the project. + operationId: compute.subnetworks.listUsable security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -94153,7 +101767,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PublicAdvertisedPrefixList' + $ref: '#/components/schemas/UsableSubnetworksAggregatedList' parameters: - in: path name: project @@ -94181,47 +101795,15 @@ paths: name: returnPartialSuccess schema: type: boolean - post: - description: >- - Creates a PublicAdvertisedPrefix in the specified project using the - parameters that are included in the request. - operationId: compute.publicAdvertisedPrefixes.insert - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PublicAdvertisedPrefix' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/compute - Oauth2c: - - https://www.googleapis.com/auth/compute - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: project - required: true - schema: - type: string - in: query - name: requestId + name: serviceProject schema: type: string - /projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}: + /projects/{project}/regions/{region}/subnetworks/{subnetwork}: parameters: *ref_1 get: - description: Returns the specified PublicAdvertisedPrefix resource. - operationId: compute.publicAdvertisedPrefixes.get + description: Returns the specified subnetwork. + operationId: compute.subnetworks.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -94241,7 +101823,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PublicAdvertisedPrefix' + $ref: '#/components/schemas/Subnetwork' parameters: - in: path name: project @@ -94249,13 +101831,18 @@ paths: schema: type: string - in: path - name: publicAdvertisedPrefix + name: region + required: true + schema: + type: string + - in: path + name: subnetwork required: true schema: type: string delete: - description: Deletes the specified PublicAdvertisedPrefix - operationId: compute.publicAdvertisedPrefixes.delete + description: Deletes the specified subnetwork. + operationId: compute.subnetworks.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -94279,7 +101866,12 @@ paths: schema: type: string - in: path - name: publicAdvertisedPrefix + name: region + required: true + schema: + type: string + - in: path + name: subnetwork required: true schema: type: string @@ -94289,15 +101881,16 @@ paths: type: string 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 + 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 requestBody: content: application/json: schema: - $ref: '#/components/schemas/PublicAdvertisedPrefix' + $ref: '#/components/schemas/Subnetwork' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -94321,55 +101914,34 @@ paths: schema: type: string - in: path - name: publicAdvertisedPrefix + name: region required: true schema: type: string - - in: query - name: requestId - schema: - type: string - /projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}/announce: - parameters: *ref_1 - post: - description: Announces the specified PublicAdvertisedPrefix - operationId: compute.publicAdvertisedPrefixes.announce - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/compute - Oauth2c: - - https://www.googleapis.com/auth/compute - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - in: path - name: project + name: subnetwork required: true schema: type: string - - in: path - name: publicAdvertisedPrefix - required: true + - in: query + name: drainTimeoutSeconds schema: - type: string + type: integer + format: int32 - in: query name: requestId schema: type: string - /projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}/withdraw: + /projects/{project}/regions/{region}/subnetworks/{subnetwork}/expandIpCidrRange: parameters: *ref_1 post: - description: Withdraws the specified PublicAdvertisedPrefix - operationId: compute.publicAdvertisedPrefixes.withdraw + description: Expands the IP CIDR range of the subnetwork to a specified value. + operationId: compute.subnetworks.expandIpCidrRange + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SubnetworksExpandIpCidrRangeRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -94393,7 +101965,12 @@ paths: schema: type: string - in: path - name: publicAdvertisedPrefix + name: region + required: true + schema: + type: string + - in: path + name: subnetwork required: true schema: type: string @@ -94401,11 +101978,13 @@ paths: name: requestId schema: type: string - /projects/{project}/global/publicDelegatedPrefixes: + /projects/{project}/regions/{region}/subnetworks/{resource}/getIamPolicy: parameters: *ref_1 get: - description: Lists the global PublicDelegatedPrefixes for a project. - operationId: compute.globalPublicDelegatedPrefixes.list + description: >- + Gets the access control policy for a resource. May be empty if no such + policy or resource exists. + operationId: compute.subnetworks.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -94425,44 +102004,40 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PublicDelegatedPrefixList' + $ref: '#/components/schemas/Policy' parameters: - in: path name: project required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy + - in: path + name: region + required: true schema: type: string - - in: query - name: pageToken + - in: path + name: resource + required: true schema: type: string - in: query - name: returnPartialSuccess + name: optionsRequestedPolicyVersion schema: - type: boolean + type: integer + format: int32 + /projects/{project}/regions/{region}/subnetworks/{resource}/setIamPolicy: + parameters: *ref_1 post: description: >- - Creates a global PublicDelegatedPrefix in the specified project using - the parameters that are included in the request. - operationId: compute.globalPublicDelegatedPrefixes.insert + Sets the access control policy on the specified resource. Replaces any + existing policy. + operationId: compute.subnetworks.setIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/PublicDelegatedPrefix' + $ref: '#/components/schemas/RegionSetPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -94478,22 +102053,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Policy' parameters: - in: path name: project required: true schema: type: string - - in: query - name: requestId + - in: path + name: region + required: true schema: type: string - /projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}: + - in: path + name: resource + required: true + schema: + type: string + /projects/{project}/regions/{region}/subnetworks/{resource}/testIamPermissions: parameters: *ref_1 - get: - description: Returns the specified global PublicDelegatedPrefix resource. - operationId: compute.globalPublicDelegatedPrefixes.get + post: + description: Returns permissions that a caller has on the specified resource. + operationId: compute.subnetworks.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -94513,7 +102099,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PublicDelegatedPrefix' + $ref: '#/components/schemas/TestPermissionsResponse' parameters: - in: path name: project @@ -94521,55 +102107,27 @@ paths: schema: type: string - in: path - name: publicDelegatedPrefix - required: true - schema: - type: string - delete: - description: Deletes the specified global PublicDelegatedPrefix. - operationId: compute.globalPublicDelegatedPrefixes.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/compute - Oauth2c: - - https://www.googleapis.com/auth/compute - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: project + name: region required: true schema: type: string - in: path - name: publicDelegatedPrefix + name: resource required: true schema: type: string - - in: query - name: requestId - schema: - type: string - patch: + /projects/{project}/regions/{region}/subnetworks/{subnetwork}/setPrivateIpGoogleAccess: + parameters: *ref_1 + post: 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 + Set whether VMs in this subnet can access Google services without + assigning external IP addresses through Private Google Access. + operationId: compute.subnetworks.setPrivateIpGoogleAccess requestBody: content: application/json: schema: - $ref: '#/components/schemas/PublicDelegatedPrefix' + $ref: '#/components/schemas/SubnetworksSetPrivateIpGoogleAccessRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -94593,7 +102151,12 @@ paths: schema: type: string - in: path - name: publicDelegatedPrefix + name: region + required: true + schema: + type: string + - in: path + name: subnetwork required: true schema: type: string @@ -94601,11 +102164,11 @@ paths: name: requestId schema: type: string - /projects/{project}/regions/{region}/publicDelegatedPrefixes: + /projects/{project}/global/networkProfiles: parameters: *ref_1 get: - description: Lists the PublicDelegatedPrefixes for a project in the given region. - operationId: compute.publicDelegatedPrefixes.list + description: Retrieves a list of network profiles available to the specified project. + operationId: compute.networkProfiles.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -94625,18 +102188,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PublicDelegatedPrefixList' + $ref: '#/components/schemas/NetworkProfilesListResponse' parameters: - in: path name: project required: true schema: type: string - - in: path - name: region - required: true - schema: - type: string - in: query name: filter schema: @@ -94658,16 +102216,11 @@ paths: name: returnPartialSuccess schema: type: boolean - 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 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PublicDelegatedPrefix' + /projects/{project}/global/networkProfiles/{networkProfile}: + parameters: *ref_1 + get: + description: Returns the specified network profile. + operationId: compute.networkProfiles.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -94677,13 +102230,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/NetworkProfile' parameters: - in: path name: project @@ -94691,21 +102248,15 @@ paths: schema: type: string - in: path - name: region + name: networkProfile required: true schema: type: string - - in: query - name: requestId - schema: - type: string - /projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}: + /projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservationBlock}: parameters: *ref_1 get: - description: >- - Returns the specified PublicDelegatedPrefix resource in the given - region. - operationId: compute.publicDelegatedPrefixes.get + description: Retrieves information about the specified reservation block. + operationId: compute.reservationBlocks.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -94725,7 +102276,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PublicDelegatedPrefix' + $ref: '#/components/schemas/ReservationBlocksGetResponse' parameters: - in: path name: project @@ -94733,65 +102284,29 @@ paths: schema: type: string - in: path - name: region - required: true - schema: - type: string - - in: path - name: publicDelegatedPrefix - required: true - schema: - type: string - delete: - description: Deletes the specified PublicDelegatedPrefix in the given region. - operationId: compute.publicDelegatedPrefixes.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/compute - Oauth2c: - - https://www.googleapis.com/auth/compute - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: project + name: zone required: true schema: type: string - in: path - name: region + name: reservation required: true schema: type: string - in: path - name: publicDelegatedPrefix + name: reservationBlock required: true schema: type: string - in: query - name: requestId + name: view schema: type: string - 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 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PublicDelegatedPrefix' + /projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks: + parameters: *ref_1 + get: + description: Retrieves a list of reservation blocks under a single reservation. + operationId: compute.reservationBlocks.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -94801,13 +102316,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/ReservationBlocksListResponse' parameters: - in: path name: project @@ -94815,65 +102334,46 @@ paths: schema: type: string - in: path - name: region + name: zone required: true schema: type: string - in: path - name: publicDelegatedPrefix + name: reservation required: true schema: type: string - in: query - name: requestId + name: filter schema: type: string - /projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}/announce: - parameters: *ref_1 - post: - description: Announces the specified PublicDelegatedPrefix in the given region. - operationId: compute.publicDelegatedPrefixes.announce - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/compute - Oauth2c: - - https://www.googleapis.com/auth/compute - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: project - required: true + - in: query + name: maxResults schema: - type: string - - in: path - name: region - required: true + type: integer + format: uint32 + - in: query + name: orderBy schema: type: string - - in: path - name: publicDelegatedPrefix - required: true + - in: query + name: pageToken schema: type: string - in: query - name: requestId + name: returnPartialSuccess schema: - type: string - /projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}/withdraw: + type: boolean + /projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservationBlock}/performMaintenance: parameters: *ref_1 post: - description: Withdraws the specified PublicDelegatedPrefix in the given region. - operationId: compute.publicDelegatedPrefixes.withdraw + description: Allows customers to perform maintenance on a reservation block + operationId: compute.reservationBlocks.performMaintenance + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ReservationsBlocksPerformMaintenanceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -94897,12 +102397,17 @@ paths: schema: type: string - in: path - name: region + name: zone required: true schema: type: string - in: path - name: publicDelegatedPrefix + name: reservation + required: true + schema: + type: string + - in: path + name: reservationBlock required: true schema: type: string @@ -94910,14 +102415,11 @@ paths: name: requestId schema: type: string - /projects/{project}/aggregated/publicDelegatedPrefixes: + /projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}: parameters: *ref_1 get: - description: >- - Lists all PublicDelegatedPrefix resources owned by the specific project - across all scopes. To prevent failure, Google recommends that you set - the `returnPartialSuccess` parameter to `true`. - operationId: compute.publicDelegatedPrefixes.aggregatedList + description: Retrieves information about the specified reservation subBlock. + operationId: compute.reservationSubBlocks.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -94937,63 +102439,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PublicDelegatedPrefixAggregatedList' + $ref: '#/components/schemas/ReservationSubBlocksGetResponse' parameters: - in: path name: project required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: includeAllScopes - schema: - type: boolean - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy + - in: path + name: zone + required: true schema: type: string - - in: query - name: pageToken + - in: path + name: parentName + required: true schema: type: string - - in: query - name: returnPartialSuccess - schema: - type: boolean - - in: query - name: serviceProjectNumber + - in: path + name: reservationSubBlock + required: true schema: type: string - format: int64 - /projects/{project}/regions: + /projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks: parameters: *ref_1 get: - description: >- - Retrieves the list of region resources available to the specified - project. To decrease latency for this method, you can optionally omit - any unneeded information from the response by using a field mask. This - practice is especially recommended for unused quota information (the - `items.quotas` field). To exclude one or more fields, set your request's - `fields` query parameter to only include the fields you need. For - example, to only include the `id` and `selfLink` fields, add the query - parameter `?fields=id,selfLink` to your request. This method fails if - the quota information is unavailable for the region and if the - organization policy constraint compute.requireBasicQuotaInResponse is - enforced. This constraint, when enforced, disables the fail-open - behaviour when quota information (the `items.quotas` field) is - unavailable for the region. It is recommended to use the default setting - for the constraint unless your application requires the fail-closed - behaviour for this method. - operationId: compute.regions.list + description: Retrieves a list of reservation subBlocks under a single reservation. + operationId: compute.reservationSubBlocks.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -95013,13 +102485,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RegionList' + $ref: '#/components/schemas/ReservationSubBlocksListResponse' parameters: - in: path name: project required: true schema: type: string + - in: path + name: zone + required: true + schema: + type: string + - in: path + name: parentName + required: true + schema: + type: string - in: query name: filter schema: @@ -95041,25 +102523,11 @@ paths: name: returnPartialSuccess schema: type: boolean - /projects/{project}/regions/{region}: + /projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/performMaintenance: parameters: *ref_1 - get: - description: >- - Returns the specified Region resource. To decrease latency for this - method, you can optionally omit any unneeded information from the - response by using a field mask. This practice is especially recommended - for unused quota information (the `quotas` field). To exclude one or - more fields, set your request's `fields` query parameter to only include - the fields you need. For example, to only include the `id` and - `selfLink` fields, add the query parameter `?fields=id,selfLink` to your - request. This method fails if the quota information is unavailable for - the region and if the organization policy constraint - compute.requireBasicQuotaInResponse is enforced. This constraint, when - enforced, disables the fail-open behaviour when quota information (the - `items.quotas` field) is unavailable for the region. It is recommended - to use the default setting for the constraint unless your application - requires the fail-closed behaviour for this method. - operationId: compute.regions.get + post: + description: Allows customers to perform maintenance on a reservation subBlock + operationId: compute.reservationSubBlocks.performMaintenance security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -95069,17 +102537,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Region' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -95087,10 +102551,24 @@ paths: schema: type: string - in: path - name: region + name: zone + required: true + schema: + type: string + - in: path + name: parentName required: true schema: type: string + - in: path + name: reservationSubBlock + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string /projects/{project}/regions/{region}/resourcePolicies: parameters: *ref_1 get: @@ -96206,14 +103684,344 @@ paths: required: true schema: type: string - - in: path - name: region - required: true + - in: path + name: region + required: true + schema: + type: string + - in: path + name: router + required: true + schema: + type: string + /projects/{project}/regions/{region}/routers/{router}/updateRoutePolicy: + parameters: *ref_1 + post: + description: Updates or creates new Route Policy + operationId: compute.routers.updateRoutePolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RoutePolicy' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: region + required: true + schema: + type: string + - in: path + name: router + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + /projects/{project}/regions/{region}/routers/{router}/patchRoutePolicy: + parameters: *ref_1 + post: + description: Patches Route Policy + operationId: compute.routers.patchRoutePolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RoutePolicy' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: region + required: true + schema: + type: string + - in: path + name: router + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + /projects/{project}/regions/{region}/routers/{router}/deleteRoutePolicy: + parameters: *ref_1 + post: + description: Deletes Route Policy + operationId: compute.routers.deleteRoutePolicy + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: region + required: true + schema: + type: string + - in: path + name: router + required: true + schema: + type: string + - in: query + name: policy + schema: + type: string + - in: query + name: requestId + schema: + type: string + /projects/{project}/regions/{region}/routers/{router}/getRoutePolicy: + parameters: *ref_1 + get: + description: Returns specified Route Policy + operationId: compute.routers.getRoutePolicy + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/RoutersGetRoutePolicyResponse' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: region + required: true + schema: + type: string + - in: path + name: router + required: true + schema: + type: string + - in: query + name: policy + schema: + type: string + /projects/{project}/regions/{region}/routers/{router}/listRoutePolicies: + parameters: *ref_1 + get: + description: >- + Retrieves a list of router route policy subresources available to the + specified project. + operationId: compute.routers.listRoutePolicies + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/RoutersListRoutePolicies' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: region + required: true + schema: + type: string + - in: path + name: router + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean + /projects/{project}/regions/{region}/routers/{router}/listBgpRoutes: + parameters: *ref_1 + get: + description: >- + Retrieves a list of router bgp routes available to the specified + project. + operationId: compute.routers.listBgpRoutes + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/RoutersListBgpRoutes' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: region + required: true + schema: + type: string + - in: path + name: router + required: true + schema: + type: string + - in: query + name: addressFamily + schema: + type: string + - in: query + name: destinationPrefix + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: peer schema: type: string - - in: path - name: router - required: true + - in: query + name: policyApplied + schema: + type: boolean + - in: query + name: returnPartialSuccess + schema: + type: boolean + - in: query + name: routeType schema: type: string /projects/{project}/aggregated/serviceAttachments: @@ -96866,521 +104674,21 @@ paths: type: string - in: path name: sslCertificate - required: true - schema: - type: string - - in: query - name: requestId - schema: - type: string - /projects/{project}/aggregated/sslCertificates: - parameters: *ref_1 - get: - description: >- - Retrieves the list of all SslCertificate resources, regional and global, - available to the specified project. To prevent failure, Google - recommends that you set the `returnPartialSuccess` parameter to `true`. - operationId: compute.sslCertificates.aggregatedList - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/compute - Oauth2c: - - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/SslCertificateAggregatedList' - parameters: - - in: path - name: project - required: true - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: includeAllScopes - schema: - type: boolean - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: returnPartialSuccess - schema: - type: boolean - - in: query - name: serviceProjectNumber - schema: - type: string - format: int64 - /projects/{project}/regions/{region}/sslCertificates: - parameters: *ref_1 - get: - description: >- - Retrieves the list of SslCertificate resources available to the - specified project in the specified region. - operationId: compute.regionSslCertificates.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/compute - Oauth2c: - - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/SslCertificateList' - parameters: - - in: path - name: project - required: true - schema: - type: string - - in: path - name: region - required: true - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: returnPartialSuccess - schema: - type: boolean - post: - description: >- - Creates a SslCertificate resource in the specified project and region - using the data included in the request - operationId: compute.regionSslCertificates.insert - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SslCertificate' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/compute - Oauth2c: - - https://www.googleapis.com/auth/compute - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: project - required: true - schema: - type: string - - in: path - name: region - required: true - schema: - type: string - - in: query - name: requestId - schema: - type: string - /projects/{project}/regions/{region}/sslCertificates/{sslCertificate}: - parameters: *ref_1 - 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 - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/compute - Oauth2c: - - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/SslCertificate' - parameters: - - in: path - name: project - required: true - schema: - type: string - - in: path - name: region - required: true - schema: - type: string - - in: path - name: sslCertificate - required: true - schema: - type: string - delete: - description: Deletes the specified SslCertificate resource in the region. - operationId: compute.regionSslCertificates.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/compute - Oauth2c: - - https://www.googleapis.com/auth/compute - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: project - required: true - schema: - type: string - - in: path - name: region - required: true - schema: - type: string - - in: path - name: sslCertificate - required: true - schema: - type: string - - in: query - name: requestId - schema: - type: string - /projects/{project}/global/sslPolicies: - parameters: *ref_1 - get: - description: >- - Lists all the SSL policies that have been configured for the specified - project. - operationId: compute.sslPolicies.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/compute - Oauth2c: - - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/SslPoliciesList' - parameters: - - in: path - name: project - required: true - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: returnPartialSuccess - schema: - type: boolean - post: - description: Returns the specified SSL policy resource. - operationId: compute.sslPolicies.insert - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SslPolicy' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/compute - Oauth2c: - - https://www.googleapis.com/auth/compute - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: project - required: true - schema: - type: string - - in: query - name: requestId - schema: - type: string - /projects/{project}/global/sslPolicies/{sslPolicy}: - parameters: *ref_1 - get: - description: Lists all of the ordered rules present in a single specified policy. - operationId: compute.sslPolicies.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/compute - Oauth2c: - - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/SslPolicy' - parameters: - - in: path - name: project - required: true - schema: - type: string - - in: path - name: sslPolicy - required: true - schema: - type: string - 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 - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/compute - Oauth2c: - - https://www.googleapis.com/auth/compute - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: project - required: true - schema: - type: string - - in: path - name: sslPolicy - required: true - schema: - type: string - - in: query - name: requestId - schema: - type: string - patch: - description: Patches the specified SSL policy with the data included in the request. - operationId: compute.sslPolicies.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SslPolicy' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/compute - Oauth2c: - - https://www.googleapis.com/auth/compute - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: project - required: true - schema: - type: string - - in: path - name: sslPolicy - required: true - schema: - type: string - - in: query - name: requestId - schema: - type: string - /projects/{project}/global/sslPolicies/listAvailableFeatures: - parameters: *ref_1 - get: - description: >- - Lists all features that can be specified in the SSL policy when using - custom profile. - operationId: compute.sslPolicies.listAvailableFeatures - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/compute - Oauth2c: - - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/SslPoliciesListAvailableFeaturesResponse' - parameters: - - in: path - name: project - required: true - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy + required: true schema: type: string - in: query - name: pageToken + name: requestId schema: type: string - - in: query - name: returnPartialSuccess - schema: - type: boolean - /projects/{project}/aggregated/sslPolicies: + /projects/{project}/aggregated/sslCertificates: parameters: *ref_1 get: description: >- - Retrieves the list of all SslPolicy resources, regional and global, + Retrieves the list of all SslCertificate resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. - operationId: compute.sslPolicies.aggregatedList + operationId: compute.sslCertificates.aggregatedList security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -97400,7 +104708,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SslPoliciesAggregatedList' + $ref: '#/components/schemas/SslCertificateAggregatedList' parameters: - in: path name: project @@ -97437,13 +104745,13 @@ paths: schema: type: string format: int64 - /projects/{project}/regions/{region}/sslPolicies: + /projects/{project}/regions/{region}/sslCertificates: parameters: *ref_1 get: description: >- - Lists all the SSL policies that have been configured for the specified - project and region. - operationId: compute.regionSslPolicies.list + Retrieves the list of SslCertificate resources available to the + specified project in the specified region. + operationId: compute.regionSslCertificates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -97463,7 +104771,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SslPoliciesList' + $ref: '#/components/schemas/SslCertificateList' parameters: - in: path name: project @@ -97498,14 +104806,14 @@ paths: type: boolean post: description: >- - Creates a new policy in the specified project and region using the data - included in the request. - operationId: compute.regionSslPolicies.insert + Creates a SslCertificate resource in the specified project and region + using the data included in the request + operationId: compute.regionSslCertificates.insert requestBody: content: application/json: schema: - $ref: '#/components/schemas/SslPolicy' + $ref: '#/components/schemas/SslCertificate' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -97537,11 +104845,13 @@ paths: name: requestId schema: type: string - /projects/{project}/regions/{region}/sslPolicies/{sslPolicy}: + /projects/{project}/regions/{region}/sslCertificates/{sslCertificate}: parameters: *ref_1 get: - description: Lists all of the ordered rules present in a single specified policy. - operationId: compute.regionSslPolicies.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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -97561,7 +104871,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SslPolicy' + $ref: '#/components/schemas/SslCertificate' parameters: - in: path name: project @@ -97574,16 +104884,13 @@ paths: schema: type: string - in: path - name: sslPolicy + name: sslCertificate required: true schema: type: string 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.regionSslPolicies.delete + description: Deletes the specified SslCertificate resource in the region. + operationId: compute.regionSslCertificates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -97612,7 +104919,7 @@ paths: schema: type: string - in: path - name: sslPolicy + name: sslCertificate required: true schema: type: string @@ -97620,14 +104927,13 @@ paths: name: requestId schema: type: string - patch: - description: Patches the specified SSL policy with the data included in the request. - operationId: compute.regionSslPolicies.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SslPolicy' + /projects/{project}/global/sslPolicies: + parameters: *ref_1 + get: + description: >- + Lists all the SSL policies that have been configured for the specified + project. + operationId: compute.sslPolicies.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -97637,40 +104943,52 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/SslPoliciesList' parameters: - in: path name: project required: true schema: type: string - - in: path - name: region - required: true + - in: query + name: filter schema: type: string - - in: path - name: sslPolicy - required: true + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy schema: type: string - in: query - name: requestId + name: pageToken schema: type: string - /projects/{project}/regions/{region}/sslPolicies/listAvailableFeatures: - parameters: *ref_1 - get: - description: >- - Lists all features that can be specified in the SSL policy when using - custom profile. - operationId: compute.regionSslPolicies.listAvailableFeatures + - in: query + name: returnPartialSuccess + schema: + type: boolean + post: + description: Returns the specified SSL policy resource. + operationId: compute.sslPolicies.insert + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SslPolicy' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -97680,56 +104998,28 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/SslPoliciesListAvailableFeaturesResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project required: true schema: type: string - - in: path - name: region - required: true - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy - schema: - type: string - in: query - name: pageToken + name: requestId schema: type: string - - in: query - name: returnPartialSuccess - schema: - type: boolean - /projects/{project}/zones/{zone}/storagePoolTypes: + /projects/{project}/global/sslPolicies/{sslPolicy}: parameters: *ref_1 get: - description: >- - Retrieves a list of storage pool types available to the specified - project. - operationId: compute.storagePoolTypes.list + description: Lists all of the ordered rules present in a single specified policy. + operationId: compute.sslPolicies.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -97749,7 +105039,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/StoragePoolTypeList' + $ref: '#/components/schemas/SslPolicy' parameters: - in: path name: project @@ -97757,39 +105047,16 @@ paths: schema: type: string - in: path - name: zone + name: sslPolicy required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: returnPartialSuccess - schema: - type: boolean - /projects/{project}/aggregated/storagePoolTypes: - parameters: *ref_1 - get: + delete: description: >- - Retrieves an aggregated list of storage pool types. To prevent failure, - Google recommends that you set the `returnPartialSuccess` parameter to - `true`. - operationId: compute.storagePoolTypes.aggregatedList + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -97799,58 +105066,36 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/StoragePoolTypeAggregatedList' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: includeAllScopes - schema: - type: boolean - - in: query - name: maxResults - schema: - type: integer - format: uint32 - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken + - in: path + name: sslPolicy + required: true schema: type: string - in: query - name: returnPartialSuccess - schema: - type: boolean - - in: query - name: serviceProjectNumber + name: requestId schema: type: string - format: int64 - /projects/{project}/zones/{zone}/storagePoolTypes/{storagePoolType}: - parameters: *ref_1 - get: - description: Returns the specified storage pool type. - operationId: compute.storagePoolTypes.get + patch: + description: Patches the specified SSL policy with the data included in the request. + operationId: compute.sslPolicies.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SslPolicy' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -97860,17 +105105,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/StoragePoolType' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -97878,20 +105119,21 @@ paths: schema: type: string - in: path - name: zone + name: sslPolicy required: true schema: type: string - - in: path - name: storagePoolType - required: true + - in: query + name: requestId schema: type: string - /projects/{project}/zones/{zone}/storagePools: + /projects/{project}/global/sslPolicies/listAvailableFeatures: parameters: *ref_1 get: - description: Retrieves a list of storage pools contained within the specified zone. - operationId: compute.storagePools.list + description: >- + Lists all features that can be specified in the SSL policy when using + custom profile. + operationId: compute.sslPolicies.listAvailableFeatures security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -97911,18 +105153,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/StoragePoolList' + $ref: '#/components/schemas/SslPoliciesListAvailableFeaturesResponse' parameters: - in: path name: project required: true schema: type: string - - in: path - name: zone - required: true - schema: - type: string - in: query name: filter schema: @@ -97944,55 +105181,14 @@ paths: name: returnPartialSuccess schema: type: boolean - post: - description: >- - Creates a storage pool in the specified project using the data in the - request. - operationId: compute.storagePools.insert - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/StoragePool' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/compute - Oauth2c: - - https://www.googleapis.com/auth/compute - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: project - required: true - schema: - type: string - - in: path - name: zone - required: true - schema: - type: string - - in: query - name: requestId - schema: - type: string - /projects/{project}/aggregated/storagePools: + /projects/{project}/aggregated/sslPolicies: parameters: *ref_1 get: description: >- - Retrieves an aggregated list of storage pools. To prevent failure, - Google recommends that you set the `returnPartialSuccess` parameter to - `true`. - operationId: compute.storagePools.aggregatedList + Retrieves the list of all SslPolicy resources, regional and global, + available to the specified project. To prevent failure, Google + recommends that you set the `returnPartialSuccess` parameter to `true`. + operationId: compute.sslPolicies.aggregatedList security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -98012,7 +105208,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/StoragePoolAggregatedList' + $ref: '#/components/schemas/SslPoliciesAggregatedList' parameters: - in: path name: project @@ -98049,13 +105245,13 @@ paths: schema: type: string format: int64 - /projects/{project}/zones/{zone}/storagePools/{storagePool}: + /projects/{project}/regions/{region}/sslPolicies: parameters: *ref_1 get: description: >- - Returns a specified storage pool. Gets a list of available storage pools - by making a list() request. - operationId: compute.storagePools.get + Lists all the SSL policies that have been configured for the specified + project and region. + operationId: compute.regionSslPolicies.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -98075,7 +105271,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/StoragePool' + $ref: '#/components/schemas/SslPoliciesList' parameters: - in: path name: project @@ -98083,22 +105279,41 @@ paths: schema: type: string - in: path - name: zone + name: region required: true schema: type: string - - in: path - name: storagePool - required: true + - in: query + name: filter schema: type: string - delete: + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean + post: description: >- - Deletes the specified storage pool. Deleting a storagePool removes its - data permanently and is irreversible. However, deleting a storagePool - does not delete any snapshots previously made from the storagePool. You - must separately delete snapshots. - operationId: compute.storagePools.delete + Creates a new policy in the specified project and region using the data + included in the request. + operationId: compute.regionSslPolicies.insert + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SslPolicy' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -98122,12 +105337,7 @@ paths: schema: type: string - in: path - name: zone - required: true - schema: - type: string - - in: path - name: storagePool + name: region required: true schema: type: string @@ -98135,19 +105345,11 @@ paths: name: requestId schema: type: string - patch: - description: >- - Updates the specified storagePool with the data included in the request. - The update is performed only on selected fields included as part of - update-mask. Only the following fields can be modified: - pool_provisioned_capacity_gb, pool_provisioned_iops and - pool_provisioned_throughput. - operationId: compute.storagePools.update - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/StoragePool' + /projects/{project}/regions/{region}/sslPolicies/{sslPolicy}: + parameters: *ref_1 + get: + description: Lists all of the ordered rules present in a single specified policy. + operationId: compute.regionSslPolicies.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -98157,13 +105359,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/SslPolicy' parameters: - in: path name: project @@ -98171,31 +105377,21 @@ paths: schema: type: string - in: path - name: zone + name: region required: true schema: type: string - in: path - name: storagePool + name: sslPolicy required: true schema: type: string - - in: query - name: requestId - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /projects/{project}/zones/{zone}/storagePools/{resource}/getIamPolicy: - parameters: *ref_1 - get: + delete: description: >- - Gets the access control policy for a resource. May be empty if no such - policy or resource exists. - operationId: compute.storagePools.getIamPolicy + 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.regionSslPolicies.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -98205,17 +105401,13 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -98223,32 +105415,27 @@ paths: schema: type: string - in: path - name: zone + name: region required: true schema: type: string - in: path - name: resource + name: sslPolicy required: true schema: type: string - in: query - name: optionsRequestedPolicyVersion + name: requestId schema: - type: integer - format: int32 - /projects/{project}/zones/{zone}/storagePools/{resource}/setIamPolicy: - parameters: *ref_1 - post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. - operationId: compute.storagePools.setIamPolicy + type: string + patch: + description: Patches the specified SSL policy with the data included in the request. + operationId: compute.regionSslPolicies.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/ZoneSetPolicyRequest' + $ref: '#/components/schemas/SslPolicy' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -98264,7 +105451,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Operation' parameters: - in: path name: project @@ -98272,25 +105459,26 @@ paths: schema: type: string - in: path - name: zone + name: region required: true schema: type: string - in: path - name: resource + name: sslPolicy required: true schema: type: string - /projects/{project}/zones/{zone}/storagePools/{resource}/testIamPermissions: + - in: query + name: requestId + schema: + type: string + /projects/{project}/regions/{region}/sslPolicies/listAvailableFeatures: parameters: *ref_1 - post: - description: Returns permissions that a caller has on the specified resource. - operationId: compute.storagePools.testIamPermissions - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TestPermissionsRequest' + get: + description: >- + Lists all features that can be specified in the SSL policy when using + custom profile. + operationId: compute.regionSslPolicies.listAvailableFeatures security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -98310,7 +105498,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TestPermissionsResponse' + $ref: '#/components/schemas/SslPoliciesListAvailableFeaturesResponse' parameters: - in: path name: project @@ -98318,20 +105506,38 @@ paths: schema: type: string - in: path - name: zone + name: region required: true schema: type: string - - in: path - name: resource - required: true + - in: query + name: filter schema: type: string - /projects/{project}/zones/{zone}/storagePools/{storagePool}/listDisks: + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean + /projects/{project}/zones/{zone}/storagePoolTypes: parameters: *ref_1 get: - description: Lists the disks in a specified storage pool. - operationId: compute.storagePools.listDisks + description: >- + Retrieves a list of storage pool types available to the specified + project. + operationId: compute.storagePoolTypes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -98351,7 +105557,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/StoragePoolListDisks' + $ref: '#/components/schemas/StoragePoolTypeList' parameters: - in: path name: project @@ -98363,11 +105569,6 @@ paths: required: true schema: type: string - - in: path - name: storagePool - required: true - schema: - type: string - in: query name: filter schema: @@ -98389,11 +105590,14 @@ paths: name: returnPartialSuccess schema: type: boolean - /projects/{project}/regions/{region}/subnetworks: + /projects/{project}/aggregated/storagePoolTypes: parameters: *ref_1 get: - description: Retrieves a list of subnetworks available to the specified project. - operationId: compute.subnetworks.list + description: >- + Retrieves an aggregated list of storage pool types. To prevent failure, + Google recommends that you set the `returnPartialSuccess` parameter to + `true`. + operationId: compute.storagePoolTypes.aggregatedList security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -98413,22 +105617,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SubnetworkList' + $ref: '#/components/schemas/StoragePoolTypeAggregatedList' parameters: - in: path name: project required: true schema: type: string - - in: path - name: region - required: true - schema: - type: string - in: query name: filter schema: type: string + - in: query + name: includeAllScopes + schema: + type: boolean - in: query name: maxResults schema: @@ -98446,16 +105649,16 @@ paths: name: returnPartialSuccess schema: type: boolean - post: - description: >- - Creates a subnetwork in the specified project using the data included in - the request. - operationId: compute.subnetworks.insert - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Subnetwork' + - in: query + name: serviceProjectNumber + schema: + type: string + format: int64 + /projects/{project}/zones/{zone}/storagePoolTypes/{storagePoolType}: + parameters: *ref_1 + get: + description: Returns the specified storage pool type. + operationId: compute.storagePoolTypes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -98465,13 +105668,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/StoragePoolType' parameters: - in: path name: project @@ -98479,21 +105686,20 @@ paths: schema: type: string - in: path - name: region + name: zone required: true schema: type: string - - in: query - name: requestId + - in: path + name: storagePoolType + required: true schema: type: string - /projects/{project}/aggregated/subnetworks: + /projects/{project}/zones/{zone}/storagePools: parameters: *ref_1 get: - description: >- - Retrieves an aggregated list of subnetworks. To prevent failure, Google - recommends that you set the `returnPartialSuccess` parameter to `true`. - operationId: compute.subnetworks.aggregatedList + description: Retrieves a list of storage pools contained within the specified zone. + operationId: compute.storagePools.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -98513,21 +105719,22 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SubnetworkAggregatedList' + $ref: '#/components/schemas/StoragePoolList' parameters: - in: path name: project required: true schema: type: string - - in: query - name: filter + - in: path + name: zone + required: true schema: type: string - in: query - name: includeAllScopes + name: filter schema: - type: boolean + type: string - in: query name: maxResults schema: @@ -98545,16 +105752,55 @@ paths: name: returnPartialSuccess schema: type: boolean + post: + description: >- + Creates a storage pool in the specified project using the data in the + request. + operationId: compute.storagePools.insert + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StoragePool' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: zone + required: true + schema: + type: string - in: query - name: serviceProjectNumber + name: requestId schema: type: string - format: int64 - /projects/{project}/aggregated/subnetworks/listUsable: + /projects/{project}/aggregated/storagePools: parameters: *ref_1 get: - description: Retrieves an aggregated list of all usable subnetworks in the project. - operationId: compute.subnetworks.listUsable + description: >- + Retrieves an aggregated list of storage pools. To prevent failure, + Google recommends that you set the `returnPartialSuccess` parameter to + `true`. + operationId: compute.storagePools.aggregatedList security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -98574,7 +105820,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UsableSubnetworksAggregatedList' + $ref: '#/components/schemas/StoragePoolAggregatedList' parameters: - in: path name: project @@ -98585,6 +105831,10 @@ paths: name: filter schema: type: string + - in: query + name: includeAllScopes + schema: + type: boolean - in: query name: maxResults schema: @@ -98602,11 +105852,18 @@ paths: name: returnPartialSuccess schema: type: boolean - /projects/{project}/regions/{region}/subnetworks/{subnetwork}: + - in: query + name: serviceProjectNumber + schema: + type: string + format: int64 + /projects/{project}/zones/{zone}/storagePools/{storagePool}: parameters: *ref_1 get: - description: Returns the specified subnetwork. - operationId: compute.subnetworks.get + description: >- + Returns a specified storage pool. Gets a list of available storage pools + by making a list() request. + operationId: compute.storagePools.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -98626,7 +105883,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Subnetwork' + $ref: '#/components/schemas/StoragePool' parameters: - in: path name: project @@ -98634,18 +105891,22 @@ paths: schema: type: string - in: path - name: region + name: zone required: true schema: type: string - in: path - name: subnetwork + name: storagePool required: true schema: type: string delete: - description: Deletes the specified subnetwork. - operationId: compute.subnetworks.delete + description: >- + Deletes the specified storage pool. Deleting a storagePool removes its + data permanently and is irreversible. However, deleting a storagePool + does not delete any snapshots previously made from the storagePool. You + must separately delete snapshots. + operationId: compute.storagePools.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -98669,12 +105930,12 @@ paths: schema: type: string - in: path - name: region + name: zone required: true schema: type: string - in: path - name: subnetwork + name: storagePool required: true schema: type: string @@ -98684,16 +105945,17 @@ paths: type: string 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 + Updates the specified storagePool with the data included in the request. + The update is performed only on selected fields included as part of + update-mask. Only the following fields can be modified: + pool_provisioned_capacity_gb, pool_provisioned_iops and + pool_provisioned_throughput. + operationId: compute.storagePools.update requestBody: content: application/json: schema: - $ref: '#/components/schemas/Subnetwork' + $ref: '#/components/schemas/StoragePool' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -98717,77 +105979,31 @@ paths: schema: type: string - in: path - name: region + name: zone required: true schema: type: string - in: path - name: subnetwork + name: storagePool required: true schema: type: string - - in: query - name: drainTimeoutSeconds - schema: - type: integer - format: int32 - in: query name: requestId schema: type: string - /projects/{project}/regions/{region}/subnetworks/{subnetwork}/expandIpCidrRange: - parameters: *ref_1 - post: - description: Expands the IP CIDR range of the subnetwork to a specified value. - operationId: compute.subnetworks.expandIpCidrRange - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SubnetworksExpandIpCidrRangeRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/compute - Oauth2c: - - https://www.googleapis.com/auth/compute - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: project - required: true - schema: - type: string - - in: path - name: region - required: true - schema: - type: string - - in: path - name: subnetwork - required: true - schema: - type: string - in: query - name: requestId + name: updateMask schema: type: string - /projects/{project}/regions/{region}/subnetworks/{resource}/getIamPolicy: + format: google-fieldmask + /projects/{project}/zones/{zone}/storagePools/{resource}/getIamPolicy: parameters: *ref_1 get: description: >- Gets the access control policy for a resource. May be empty if no such policy or resource exists. - operationId: compute.subnetworks.getIamPolicy + operationId: compute.storagePools.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -98815,7 +106031,7 @@ paths: schema: type: string - in: path - name: region + name: zone required: true schema: type: string @@ -98829,18 +106045,18 @@ paths: schema: type: integer format: int32 - /projects/{project}/regions/{region}/subnetworks/{resource}/setIamPolicy: + /projects/{project}/zones/{zone}/storagePools/{resource}/setIamPolicy: parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any existing policy. - operationId: compute.subnetworks.setIamPolicy + operationId: compute.storagePools.setIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/RegionSetPolicyRequest' + $ref: '#/components/schemas/ZoneSetPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -98864,7 +106080,7 @@ paths: schema: type: string - in: path - name: region + name: zone required: true schema: type: string @@ -98873,11 +106089,11 @@ paths: required: true schema: type: string - /projects/{project}/regions/{region}/subnetworks/{resource}/testIamPermissions: + /projects/{project}/zones/{zone}/storagePools/{resource}/testIamPermissions: parameters: *ref_1 post: description: Returns permissions that a caller has on the specified resource. - operationId: compute.subnetworks.testIamPermissions + operationId: compute.storagePools.testIamPermissions requestBody: content: application/json: @@ -98910,7 +106126,7 @@ paths: schema: type: string - in: path - name: region + name: zone required: true schema: type: string @@ -98919,18 +106135,11 @@ paths: required: true schema: type: string - /projects/{project}/regions/{region}/subnetworks/{subnetwork}/setPrivateIpGoogleAccess: + /projects/{project}/zones/{zone}/storagePools/{storagePool}/listDisks: parameters: *ref_1 - 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 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SubnetworksSetPrivateIpGoogleAccessRequest' + get: + description: Lists the disks in a specified storage pool. + operationId: compute.storagePools.listDisks security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -98940,13 +106149,17 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/StoragePoolListDisks' parameters: - in: path name: project @@ -98954,19 +106167,36 @@ paths: schema: type: string - in: path - name: region + name: zone required: true schema: type: string - in: path - name: subnetwork + name: storagePool required: true schema: type: string - in: query - name: requestId + name: filter + schema: + type: string + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken schema: type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean /projects/{project}/global/targetGrpcProxies: parameters: *ref_1 get: diff --git a/providers/src/googleapis.com/v00.00.00000/services/config.yaml b/providers/src/googleapis.com/v00.00.00000/services/config.yaml index 7d75d1ca..2675d432 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/config.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/config.yaml @@ -7,8 +7,8 @@ info: title: Infrastructure Manager API description: Creates and manages Google Cloud Platform resources and infrastructure. version: v1 - x-discovery-doc-revision: '20241023' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250813' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/infrastructure-manager/docs servers: @@ -178,7 +178,7 @@ components: $ref: '#/components/schemas/TerraformBlueprint' name: description: >- - Resource name of the deployment. Format: + Identifier. Resource name of the deployment. Format: `projects/{project}/locations/{location}/deployments/{deployment}` type: string createTime: @@ -192,7 +192,7 @@ components: type: string format: google-datetime labels: - description: User-defined metadata for the deployment. + description: Optional. User-defined metadata for the deployment. type: object additionalProperties: type: string @@ -303,7 +303,7 @@ components: type: string serviceAccount: description: >- - Optional. User-specified Service Account (SA) credentials to be used + Required. User-specified Service Account (SA) credentials to be used when actuating resources. Format: `projects/{projectID}/serviceAccounts/{serviceAccount}` type: string @@ -387,6 +387,9 @@ components: type: object additionalProperties: type: string + providerConfig: + description: Optional. This field specifies the provider configurations. + $ref: '#/components/schemas/ProviderConfig' TerraformBlueprint: id: TerraformBlueprint description: >- @@ -404,7 +407,7 @@ components: description: URI of a public Git repo. $ref: '#/components/schemas/GitSource' inputValues: - description: Input variable values for the Terraform blueprint. + description: Optional. Input variable values for the Terraform blueprint. type: object additionalProperties: $ref: '#/components/schemas/TerraformVariable' @@ -432,7 +435,7 @@ components: type: object properties: inputValue: - description: Input variable value. + description: Optional. Input variable value. type: any ApplyResults: id: ApplyResults @@ -488,8 +491,25 @@ components: description: A human-readable error description. type: string error: - description: Original error response from underlying Google API, if available. + description: >- + Output only. Original error response from underlying Google API, if + available. + readOnly: true $ref: '#/components/schemas/Status' + ProviderConfig: + id: ProviderConfig + description: ProviderConfig contains the provider configurations. + type: object + properties: + sourceType: + description: Optional. ProviderSource specifies the source type of the provider. + type: string + enumDescriptions: + - Unspecified source type, default to public sources. + - Service maintained provider source type. + enum: + - PROVIDER_SOURCE_UNSPECIFIED + - SERVICE_MAINTAINED ListRevisionsResponse: id: ListRevisionsResponse description: A response to a 'ListRevisions' call. Contains a list of Revisions. @@ -692,6 +712,10 @@ components: - QUOTA_VALIDATION_UNSPECIFIED - ENABLED - ENFORCED + providerConfig: + description: Output only. This field specifies the provider configurations. + readOnly: true + $ref: '#/components/schemas/ProviderConfig' Resource: id: Resource description: >- @@ -786,7 +810,7 @@ components: type: object properties: resources: - description: List of Resourcess. + description: List of Resources. type: array items: $ref: '#/components/schemas/Resource' @@ -970,7 +994,7 @@ components: - DELETE serviceAccount: description: >- - Optional. User-specified Service Account (SA) credentials to be used + Required. User-specified Service Account (SA) credentials to be used when previewing resources. Format: `projects/{projectID}/serviceAccounts/{serviceAccount}` type: string @@ -1064,12 +1088,15 @@ components: annotations: description: >- Optional. Arbitrary key-value metadata storage e.g. to help client - tools identifiy preview during automation. See + tools identify preview during automation. See https://google.aip.dev/148#annotations for details on format and size limitations. type: object additionalProperties: type: string + providerConfig: + description: Optional. This field specifies the provider configurations. + $ref: '#/components/schemas/ProviderConfig' PreviewArtifacts: id: PreviewArtifacts description: Artifacts created by preview. @@ -1093,7 +1120,7 @@ components: type: object properties: previews: - description: List of Previewss. + description: List of Previews. type: array items: $ref: '#/components/schemas/Preview' @@ -1197,6 +1224,226 @@ components: readOnly: true type: string format: google-datetime + ListResourceChangesResponse: + id: ListResourceChangesResponse + description: >- + A response to a 'ListResourceChanges' call. Contains a list of + ResourceChanges. + type: object + properties: + resourceChanges: + description: List of ResourceChanges. + type: array + items: + $ref: '#/components/schemas/ResourceChange' + nextPageToken: + description: >- + A token to request the next page of resources from the + 'ListResourceChanges' method. The value of an empty string means + that there are no more resources to return. + type: string + unreachable: + description: Unreachable resources, if any. + type: array + items: + type: string + ResourceChange: + id: ResourceChange + description: A resource change represents a change to a resource in the state file. + type: object + properties: + name: + description: >- + Identifier. The name of the resource change. Format: + 'projects/{project_id}/locations/{location}/previews/{preview}/resourceChanges/{resource_change}'. + type: string + terraformInfo: + description: Output only. Terraform info of the resource change. + readOnly: true + $ref: '#/components/schemas/ResourceChangeTerraformInfo' + intent: + description: Output only. The intent of the resource change. + readOnly: true + type: string + enumDescriptions: + - The default value. + - The resource will be created. + - The resource will be updated. + - The resource will be deleted. + - The resource will be recreated. + - The resource will be untouched. + enum: + - INTENT_UNSPECIFIED + - CREATE + - UPDATE + - DELETE + - RECREATE + - UNCHANGED + propertyChanges: + description: Output only. The property changes of the resource change. + readOnly: true + type: array + items: + $ref: '#/components/schemas/PropertyChange' + ResourceChangeTerraformInfo: + id: ResourceChangeTerraformInfo + description: Terraform info of a ResourceChange. + type: object + properties: + address: + description: >- + Output only. TF resource address that uniquely identifies the + resource. + readOnly: true + type: string + type: + description: Output only. TF resource type. + readOnly: true + type: string + resourceName: + description: Output only. TF resource name. + readOnly: true + type: string + provider: + description: Output only. TF resource provider. + readOnly: true + type: string + actions: + description: Output only. TF resource actions. + readOnly: true + type: array + items: + type: string + PropertyChange: + id: PropertyChange + description: A property change represents a change to a property in the state file. + type: object + properties: + path: + description: Output only. The path of the property change. + readOnly: true + type: string + beforeSensitivePaths: + description: >- + Output only. The paths of sensitive fields in `before`. Paths are + relative to `path`. + readOnly: true + type: array + items: + type: string + before: + description: Output only. Representations of the object value before the actions. + readOnly: true + type: any + afterSensitivePaths: + description: >- + Output only. The paths of sensitive fields in `after`. Paths are + relative to `path`. + readOnly: true + type: array + items: + type: string + after: + description: Output only. Representations of the object value after the actions. + readOnly: true + type: any + ListResourceDriftsResponse: + id: ListResourceDriftsResponse + description: >- + A response to a 'ListResourceDrifts' call. Contains a list of + ResourceDrifts. + type: object + properties: + resourceDrifts: + description: List of ResourceDrifts. + type: array + items: + $ref: '#/components/schemas/ResourceDrift' + nextPageToken: + description: >- + A token to request the next page of resources from the + 'ListResourceDrifts' method. The value of an empty string means that + there are no more resources to return. + type: string + unreachable: + description: Unreachable resources, if any. + type: array + items: + type: string + ResourceDrift: + id: ResourceDrift + description: A resource drift represents a drift to a resource in the state file. + type: object + properties: + name: + description: >- + Identifier. The name of the resource drift. Format: + 'projects/{project_id}/locations/{location}/previews/{preview}/resourceDrifts/{resource_drift}'. + type: string + terraformInfo: + description: Output only. Terraform info of the resource drift. + readOnly: true + $ref: '#/components/schemas/ResourceDriftTerraformInfo' + propertyDrifts: + description: Output only. The property drifts of the resource drift. + readOnly: true + type: array + items: + $ref: '#/components/schemas/PropertyDrift' + ResourceDriftTerraformInfo: + id: ResourceDriftTerraformInfo + description: Terraform info of a ResourceChange. + type: object + properties: + address: + description: Output only. The address of the drifted resource. + readOnly: true + type: string + type: + description: Output only. The type of the drifted resource. + readOnly: true + type: string + resourceName: + description: Output only. TF resource name. + readOnly: true + type: string + provider: + description: Output only. The provider of the drifted resource. + readOnly: true + type: string + PropertyDrift: + id: PropertyDrift + description: A property drift represents a drift to a property in the state file. + type: object + properties: + path: + description: Output only. The path of the property drift. + readOnly: true + type: string + beforeSensitivePaths: + description: >- + Output only. The paths of sensitive fields in `before`. Paths are + relative to `path`. + readOnly: true + type: array + items: + type: string + before: + description: Output only. Representations of the object value before the actions. + readOnly: true + type: any + afterSensitivePaths: + description: >- + Output only. The paths of sensitive fields in `after`. Paths are + relative to `path`. + readOnly: true + type: array + items: + type: string + after: + description: Output only. Representations of the object value after the actions. + readOnly: true + type: any ListLocationsResponse: id: ListLocationsResponse description: The response message for Locations.ListLocations. @@ -1619,8 +1866,8 @@ components: description: >- Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled - have Operation.error value with a google.rpc.Status.code of 1, - corresponding to `Code.CANCELLED`. + have google.longrunning.Operation.error value with a + google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. readOnly: true type: boolean apiVersion: @@ -1934,6 +2181,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + delete_state: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deployments~1{deploymentsId}:deleteState/post + response: + mediaType: application/json + openAPIDocKey: '200' lock: operation: $ref: >- @@ -1966,26 +2220,6 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/deployments/methods/delete' - deployments_state: - id: google.config.deployments_state - name: deployments_state - title: Deployments_state - methods: - delete_state: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deployments~1{deploymentsId}:deleteState/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/deployments_state/methods/delete_state deployments_iam_policies: id: google.config.deployments_iam_policies name: deployments_iam_policies @@ -2137,6 +2371,62 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/previews/methods/delete' + resource_changes: + id: google.config.resource_changes + name: resource_changes + title: Resource_changes + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1previews~1{previewsId}~1resourceChanges/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.resourceChanges + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1previews~1{previewsId}~1resourceChanges~1{resourceChangesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/resource_changes/methods/get' + - $ref: '#/components/x-stackQL-resources/resource_changes/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + resource_drifts: + id: google.config.resource_drifts + name: resource_drifts + title: Resource_drifts + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1previews~1{previewsId}~1resourceDrifts/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.resourceDrifts + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1previews~1{previewsId}~1resourceDrifts~1{resourceDriftsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/resource_drifts/methods/get' + - $ref: '#/components/x-stackQL-resources/resource_drifts/methods/list' + insert: [] + update: [] + replace: [] + delete: [] terraform_versions: id: google.config.terraform_versions name: terraform_versions @@ -2213,6 +2503,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: @@ -2367,7 +2661,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: config.projects.locations.operations.cancel requestBody: content: @@ -3375,6 +3669,182 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/previews/{previewsId}/resourceChanges: + parameters: *ref_1 + get: + description: Lists ResourceChanges for a given preview. + operationId: config.projects.locations.previews.resourceChanges.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListResourceChangesResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: previewsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/previews/{previewsId}/resourceChanges/{resourceChangesId}: + parameters: *ref_1 + get: + description: Get a ResourceChange for a given preview. + operationId: config.projects.locations.previews.resourceChanges.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceChange' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: previewsId + required: true + schema: + type: string + - in: path + name: resourceChangesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/previews/{previewsId}/resourceDrifts: + parameters: *ref_1 + get: + description: List ResourceDrifts for a given preview. + operationId: config.projects.locations.previews.resourceDrifts.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListResourceDriftsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: previewsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/previews/{previewsId}/resourceDrifts/{resourceDriftsId}: + parameters: *ref_1 + get: + description: Get a ResourceDrift for a given preview. + operationId: config.projects.locations.previews.resourceDrifts.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceDrift' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: previewsId + required: true + schema: + type: string + - in: path + name: resourceDriftsId + required: true + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/terraformVersions: parameters: *ref_1 get: diff --git a/providers/src/googleapis.com/v00.00.00000/services/connectors.yaml b/providers/src/googleapis.com/v00.00.00000/services/connectors.yaml index bb4737ac..77f84815 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/connectors.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/connectors.yaml @@ -9,8 +9,8 @@ info: Enables users to create and manage connections to Google Cloud services and third-party business applications using the Connectors interface. version: v2 - x-discovery-doc-revision: '20241015' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250813' + x-generated-date: '2025-08-28' externalDocs: url: >- https://cloud.google.com/apigee/docs/api-platform/connectors/about-connectors @@ -69,6 +69,14 @@ components: additionalProperties: type: any description: Properties of the object. + metadata: + description: Metadata like service latency, etc. + type: object + additionalProperties: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. ListActionsResponse: id: ListActionsResponse description: Response message for ActionService.ListActions @@ -89,6 +97,14 @@ components: nextPageToken: description: Next page token if more actions available. type: string + metadata: + description: Metadata like service latency, etc. + type: object + additionalProperties: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. Action: id: Action description: >- @@ -121,6 +137,14 @@ components: description: description: Brief Description of action type: string + metadata: + description: Metadata like service latency, etc. + type: object + additionalProperties: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. InputParameter: id: InputParameter description: >- @@ -695,6 +719,14 @@ components: When the connector is not in ACTIVE state, the description must be populated to specify the reason why it's not in ACTIVE state. type: string + metadata: + description: Metadata like service latency, etc. + type: object + additionalProperties: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. CheckReadinessResponse: id: CheckReadinessResponse description: Response containing status of the connector for readiness prober. @@ -733,6 +765,13 @@ components: OAuth redirect URI passed in during the auth code flow, required by some OAuth backends. type: string + scopes: + description: >- + Scopes the connection will request when the user performs the auth + code flow. + type: array + items: + type: string ExchangeAuthCodeResponse: id: ExchangeAuthCodeResponse description: >- @@ -742,6 +781,14 @@ components: properties: accessCredentials: $ref: '#/components/schemas/AccessCredentials' + metadata: + description: Metadata like service latency, etc. + type: object + additionalProperties: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. AccessCredentials: id: AccessCredentials description: >- @@ -778,6 +825,66 @@ components: properties: accessCredentials: $ref: '#/components/schemas/AccessCredentials' + metadata: + description: Metadata like service latency, etc. + type: object + additionalProperties: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + ListToolsResponse: + id: ListToolsResponse + description: Response message for ConnectorAgentService.ListTools + type: object + properties: + tools: + description: List of available tools. + type: array + items: + $ref: '#/components/schemas/Tool' + nextPageToken: + description: Next page token. + type: string + Tool: + id: Tool + description: Message representing a single tool. + type: object + properties: + name: + description: Name of the tool. + type: string + description: + description: Description of the tool. + type: string + inputSchema: + description: JSON schema for the input parameters of the tool. + $ref: '#/components/schemas/JsonSchema' + outputSchema: + description: JSON schema for the output of the tool. + $ref: '#/components/schemas/JsonSchema' + ExecuteToolRequest: + id: ExecuteToolRequest + description: Request message for ConnectorAgentService.ExecuteTool + type: object + properties: + parameters: + description: Input parameters for the tool. + type: object + additionalProperties: + type: any + description: Properties of the object. + ExecuteToolResponse: + id: ExecuteToolResponse + description: Response message for ConnectorAgentService.ExecuteTool + type: object + properties: + result: + description: Output from the tool execution. + type: object + additionalProperties: + type: any + description: Properties of the object. EntityType: id: EntityType description: >- @@ -816,6 +923,16 @@ components: - CREATE - UPDATE - DELETE + defaultSortBy: + type: string + metadata: + description: Metadata like service latency, etc. + type: object + additionalProperties: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. Field: id: Field description: Message contains EntityType's Field metadata. @@ -1030,6 +1147,14 @@ components: type: array items: type: string + metadata: + description: Metadata like service latency, etc. + type: object + additionalProperties: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. ListEntitiesResponse: id: ListEntitiesResponse description: Response message for EntityService.ListEntities @@ -1043,6 +1168,14 @@ components: nextPageToken: description: Next page token if more records are available. type: string + metadata: + description: Metadata like service latency, etc. + type: object + additionalProperties: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. Entity: id: Entity description: '''Entity row''/ ''Entity'' refers to a single row of an entity type.' @@ -1062,6 +1195,14 @@ components: type: object additionalProperties: type: any + metadata: + description: Metadata like service latency, etc. + type: object + additionalProperties: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. UpdateEntitiesWithConditionsResponse: id: UpdateEntitiesWithConditionsResponse description: Response message for EntityService.UpdateEntitiesWithConditions @@ -1073,6 +1214,14 @@ components: additionalProperties: type: any description: Properties of the object. + metadata: + description: Metadata like service latency, etc. + type: object + additionalProperties: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. Empty: id: Empty description: >- @@ -1458,6 +1607,18 @@ components: type: object additionalProperties: $ref: '#/components/schemas/NotificationParameter' + consumerProjectNumber: + description: >- + Optional. The consumer_project_number associated with this Apigee + instance. This field is added specifically to support Apigee + integration with SLM Rollout and UMM. It represents the numerical + project ID of the GCP project that consumes this Apigee instance. It + is used for SLM rollout notifications and UMM integration, enabling + proper mapping to customer projects and log delivery for Apigee + instances. This field complements consumer_project_id and may be + used for specific Apigee scenarios where the numerical ID is + required. + type: string ProvisionedResource: id: ProvisionedResource description: Describes provisioned dataplane resources. @@ -2070,6 +2231,33 @@ components: update: [] replace: [] delete: [] + tools: + id: google.connectors.tools + name: tools + title: Tools + methods: + list: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1tools/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.tools + execute: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1tools~1{toolsId}:execute/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tools/methods/list' + insert: [] + update: [] + replace: [] + delete: [] entity_types: id: google.connectors.entity_types name: entity_types @@ -2139,22 +2327,6 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/entities/methods/get' - - $ref: '#/components/x-stackQL-resources/entities/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/entities/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/entities/methods/patch' - replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/entities/methods/delete' - entities_entities_with_conditions: - id: google.connectors.entities_entities_with_conditions - name: entities_entities_with_conditions - title: Entities_entities_with_conditions - methods: update_entities_with_conditions: operation: $ref: >- @@ -2170,15 +2342,20 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] - insert: [] + select: + - $ref: '#/components/x-stackQL-resources/entities/methods/get' + - $ref: '#/components/x-stackQL-resources/entities/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/entities/methods/create' update: + - $ref: '#/components/x-stackQL-resources/entities/methods/patch' - $ref: >- - #/components/x-stackQL-resources/entities_entities_with_conditions/methods/update_entities_with_conditions + #/components/x-stackQL-resources/entities/methods/update_entities_with_conditions replace: [] delete: + - $ref: '#/components/x-stackQL-resources/entities/methods/delete' - $ref: >- - #/components/x-stackQL-resources/entities_entities_with_conditions/methods/delete_entities_with_conditions + #/components/x-stackQL-resources/entities/methods/delete_entities_with_conditions paths: /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:checkStatus: parameters: &ref_1 @@ -2515,6 +2692,95 @@ paths: required: true schema: type: string + - in: query + name: view + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/tools: + parameters: *ref_1 + get: + description: Lists all available tools. + operationId: connectors.projects.locations.connections.tools.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListToolsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: connectionsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/tools/{toolsId}:execute: + parameters: *ref_1 + post: + description: Executes a specific tool. + operationId: connectors.projects.locations.connections.tools.execute + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExecuteToolRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ExecuteToolResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: connectionsId + required: true + schema: + type: string + - in: path + name: toolsId + required: true + schema: + type: string /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/entityTypes/{entityTypesId}: parameters: *ref_1 get: @@ -2553,6 +2819,14 @@ paths: required: true schema: type: string + - in: query + name: view + schema: + type: string + - in: query + name: contextMetadata + schema: + type: string /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/entityTypes: parameters: *ref_1 get: @@ -2662,6 +2936,10 @@ paths: name: sortBy schema: type: string + - in: query + name: sortOrder + schema: + type: string - in: query name: conditions schema: diff --git a/providers/src/googleapis.com/v00.00.00000/services/contactcenteraiplatform.yaml b/providers/src/googleapis.com/v00.00.00000/services/contactcenteraiplatform.yaml index c7ef99b4..0cb868e5 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/contactcenteraiplatform.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/contactcenteraiplatform.yaml @@ -7,8 +7,8 @@ info: title: Contact Center AI Platform API description: '' version: v1alpha1 - x-discovery-doc-revision: '20241023' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250821' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/solutions/contact-center-ai-platform servers: @@ -165,7 +165,7 @@ components: type: string ContactCenter: id: ContactCenter - description: 'Message describing ContactCenter object Next ID: 24' + description: Message describing ContactCenter object type: object properties: name: @@ -279,6 +279,16 @@ components: critical: description: Optional. Critical release channel. $ref: '#/components/schemas/Critical' + advancedReportingEnabled: + description: Optional. Whether the advanced reporting feature is enabled. + type: boolean + releaseVersion: + description: Output only. UJET release version, unique for each new release. + readOnly: true + type: string + featureConfig: + description: Optional. Feature configuration to populate the feature flags. + $ref: '#/components/schemas/FeatureConfig' URIs: id: URIs description: Message storing the URIs of the ContactCenter. @@ -312,13 +322,16 @@ components: - Instance Size STANDARD_XLARGE. - Instance Size STANDARD_2XLARGE. - Instance Size STANDARD_3XLARGE. - - Instance Size DEV_EXTRA_SMALL. - Instance Size MULTIREGION_SMALL - Instance Size MULTIREGION_MEDIUM - Instance Size MULTIREGION_LARGE - Instance Size MULTIREGION_XLARGE - Instance Size MULTIREGION_2XLARGE. - Instance Size MULTIREGION_3XLARGE. + - Instance Size DEV_SMALL + - Instance Size SANDBOX_SMALL + - Instance Size TRIAL_SMALL + - Instance Size TIME_LIMITED_TRIAL_SMALL enum: - INSTANCE_SIZE_UNSPECIFIED - STANDARD_SMALL @@ -327,13 +340,16 @@ components: - STANDARD_XLARGE - STANDARD_2XLARGE - STANDARD_3XLARGE - - DEV_XSMALL - MULTIREGION_SMALL - MULTIREGION_MEDIUM - MULTIREGION_LARGE - MULTIREGION_XLARGE - MULTIREGION_2XLARGE - MULTIREGION_3XLARGE + - DEV_SMALL + - SANDBOX_SMALL + - TRIAL_SMALL + - TIME_LIMITED_TRIAL_SMALL SAMLParams: id: SAMLParams description: Message storing SAML params to enable Google as IDP. @@ -669,6 +685,15 @@ components: to 0 and less than or equal to 999,999,999. type: integer format: int32 + FeatureConfig: + id: FeatureConfig + type: object + properties: + agentDesktopEnabled: + description: >- + Optional. If true - enables the agent desktop feature. Default is + false. + type: boolean ContactCenterQuota: id: ContactCenterQuota description: Represents a quota for contact centers. @@ -717,13 +742,16 @@ components: - Instance Size STANDARD_XLARGE. - Instance Size STANDARD_2XLARGE. - Instance Size STANDARD_3XLARGE. - - Instance Size DEV_EXTRA_SMALL. - Instance Size MULTIREGION_SMALL - Instance Size MULTIREGION_MEDIUM - Instance Size MULTIREGION_LARGE - Instance Size MULTIREGION_XLARGE - Instance Size MULTIREGION_2XLARGE. - Instance Size MULTIREGION_3XLARGE. + - Instance Size DEV_SMALL + - Instance Size SANDBOX_SMALL + - Instance Size TRIAL_SMALL + - Instance Size TIME_LIMITED_TRIAL_SMALL enum: - INSTANCE_SIZE_UNSPECIFIED - STANDARD_SMALL @@ -732,13 +760,16 @@ components: - STANDARD_XLARGE - STANDARD_2XLARGE - STANDARD_3XLARGE - - DEV_XSMALL - MULTIREGION_SMALL - MULTIREGION_MEDIUM - MULTIREGION_LARGE - MULTIREGION_XLARGE - MULTIREGION_2XLARGE - MULTIREGION_3XLARGE + - DEV_SMALL + - SANDBOX_SMALL + - TRIAL_SMALL + - TIME_LIMITED_TRIAL_SMALL ListLocationsResponse: id: ListLocationsResponse description: The response message for Locations.ListLocations. @@ -821,8 +852,8 @@ components: description: >- Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully - have Operation.error value with a google.rpc.Status.code of 1, - corresponding to `Code.CANCELLED`. + have google.longrunning.Operation.error value with a + google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. readOnly: true type: boolean apiVersion: @@ -1163,6 +1194,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v1alpha1/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: @@ -1317,7 +1352,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: contactcenteraiplatform.projects.locations.operations.cancel requestBody: content: diff --git a/providers/src/googleapis.com/v00.00.00000/services/contactcenterinsights.yaml b/providers/src/googleapis.com/v00.00.00000/services/contactcenterinsights.yaml index dc6fc880..2d604f49 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/contactcenterinsights.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/contactcenterinsights.yaml @@ -7,8 +7,8 @@ info: title: Contact Center AI Insights API description: '' version: v1 - x-discovery-doc-revision: '20241028' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250825' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/contact-center/insights/docs servers: @@ -34,586 +34,577 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudContactcenterinsightsV1DimensionIssueDimensionMetadata: + GoogleLongrunningListOperationsResponse: + id: GoogleLongrunningListOperationsResponse + description: The response message for Operations.ListOperations. type: object properties: - issueModelId: - type: string - description: The parent issue model ID. - issueId: - type: string - description: The issue ID. - issueDisplayName: - type: string - description: The issue display name. - id: GoogleCloudContactcenterinsightsV1DimensionIssueDimensionMetadata - description: Metadata about the issue dimension. - GoogleCloudContactcenterinsightsV1ListQaQuestionsResponse: - description: The response from a ListQaQuestions request. - properties: - nextPageToken: + operations: description: >- - A token, which can be sent as `page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. - type: string - qaQuestions: - description: The QaQuestions under the parent. + A list of operations that matches the specified filter in the + request. type: array items: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestion' - id: GoogleCloudContactcenterinsightsV1ListQaQuestionsResponse - type: object - GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec: + $ref: '#/components/schemas/GoogleLongrunningOperation' + nextPageToken: + description: The standard List next-page token. + type: string + GoogleLongrunningOperation: + id: GoogleLongrunningOperation description: >- - A customer-managed encryption key specification that can be applied to - all created resources (e.g. `Conversation`). + This resource represents a long-running operation that is the result of + a network API call. + type: object properties: - kmsKey: - description: >- - Required. The name of customer-managed encryption key that is used - to secure a resource and its sub-resources. If empty, the resource - is secured by our default encryption key. Only the key in the same - location as this resource is allowed to be used for encryption. - Format: - `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}` - type: string name: description: >- - Immutable. The resource name of the encryption key specification - resource. Format: - projects/{project}/locations/{location}/encryptionSpec + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. type: string - id: GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec - type: object - GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest: - properties: - force: + metadata: description: >- - If set to true, all of this conversation's analyses will also be - deleted. Otherwise, the request will only succeed if the - conversation has no analyses. + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + done: + description: >- + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. type: boolean - maxDeleteCount: - format: int32 - description: Maximum number of conversations to delete. - type: integer - filter: - description: Filter used to select the subset of conversations to delete. - type: string - parent: + error: description: >- - Required. The parent resource to delete conversations from. Format: - projects/{project}/locations/{location} - type: string - id: GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest + The error result of the operation in case of failure or + cancellation. + $ref: '#/components/schemas/GoogleRpcStatus' + response: + description: >- + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + GoogleRpcStatus: + id: GoogleRpcStatus + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). type: object - description: The request to delete conversations in bulk. - GoogleIamV1SetIamPolicyRequest: - id: GoogleIamV1SetIamPolicyRequest properties: - updateMask: - format: google-fieldmask - type: string + code: + description: The status code, which should be an enum value of google.rpc.Code. + type: integer + format: int32 + message: description: >- - OPTIONAL: A FieldMask specifying which fields of the policy to - modify. Only the fields in the mask will be modified. If no mask is - provided, the following default mask is used: `paths: "bindings, - etag"` - policy: - $ref: '#/components/schemas/GoogleIamV1Policy' + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + type: string + details: description: >- - REQUIRED: The complete policy to be applied to the `resource`. The - size of the policy is limited to a few 10s of KB. An empty policy is - a valid policy but certain Google Cloud services (such as Projects) - might reject them. + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + type: array + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + GoogleProtobufEmpty: + id: GoogleProtobufEmpty + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } type: object - description: Request message for `SetIamPolicy` method. - GoogleCloudContactcenterinsightsV1CreateIssueModelMetadata: - id: GoogleCloudContactcenterinsightsV1CreateIssueModelMetadata + properties: {} + GoogleCloudContactcenterinsightsV1Conversation: + id: GoogleCloudContactcenterinsightsV1Conversation + description: The conversation resource. type: object - description: Metadata for creating an issue model. properties: - endTime: + callMetadata: + description: Call-specific metadata. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationCallMetadata + expireTime: + description: >- + The time at which this conversation should expire. After this time, + the conversation data and any associated analyses will be deleted. + type: string format: google-datetime - readOnly: true + ttl: + description: >- + Input only. The TTL for this resource. If specified, then this TTL + will be used to calculate the expire time. type: string - description: Output only. The time the operation finished running. + format: google-duration + name: + description: >- + Immutable. The resource name of the conversation. Format: + projects/{project}/locations/{location}/conversations/{conversation} + type: string + dataSource: + description: The source of the audio and transcription for the conversation. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationDataSource createTime: + description: Output only. The time at which the conversation was created. readOnly: true - description: Output only. The time the operation was created. type: string format: google-datetime - request: - description: The original request for creation. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1CreateIssueModelRequest - GoogleCloudContactcenterinsightsV1CallAnnotation: - id: GoogleCloudContactcenterinsightsV1CallAnnotation - description: A piece of metadata that applies to a window of a call. - type: object - properties: - entityMentionData: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1EntityMentionData - description: Data specifying an entity mention. - holdData: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1HoldData' - description: Data specifying a hold. - silenceData: - description: Data specifying silence. - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SilenceData' - channelTag: - type: integer - format: int32 + updateTime: description: >- - The channel of the audio where the annotation occurs. For - single-channel audio, this field is not populated. - phraseMatchData: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchData - description: Data specifying a phrase match. - issueMatchData: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueMatchData - description: Data specifying an issue match. - interruptionData: - description: Data specifying an interruption. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1InterruptionData - annotationStartBoundary: + Output only. The most recent time at which the conversation was + updated. + readOnly: true + type: string + format: google-datetime + startTime: + description: The time at which the conversation started. + type: string + format: google-datetime + languageCode: + description: A user-specified language code for the conversation. + type: string + agentId: description: >- - The boundary in the conversation where the annotation starts, - inclusive. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotationBoundary - sentimentData: - description: Data specifying sentiment. - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData' - intentMatchData: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IntentMatchData - description: Data specifying an intent match. - annotationEndBoundary: + An opaque, user-specified string representing the human agent who + handled the conversation. + type: string + labels: + description: >- + A map for the user to specify any custom fields. A maximum of 100 + labels per conversation is allowed, with a maximum of 256 characters + per entry. + type: object + additionalProperties: + type: string + qualityMetadata: + description: Conversation metadata related to quality management. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotationBoundary + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationQualityMetadata + metadataJson: description: >- - The boundary in the conversation where the annotation ends, - inclusive. - GoogleCloudContactcenterinsightsV1Issue: - description: The issue resource. - type: object - properties: - updateTime: - description: Output only. The most recent time that this issue was updated. - format: google-datetime - readOnly: true + Input only. JSON metadata encoded as a string. This field is + primarily used by Insights integrations with various telephony + systems and must be in one of Insight's supported formats. type: string - sampleUtterances: - type: array - items: - type: string + transcript: + description: Output only. The conversation transcript. readOnly: true + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationTranscript + medium: description: >- - Output only. Resource names of the sample representative utterances - that match to this issue. - displayDescription: - description: Representative description of the issue. + Immutable. The conversation medium, if unspecified will default to + PHONE_CALL. type: string - displayName: + enumDescriptions: + - Default value, if unspecified will default to PHONE_CALL. + - The format for conversations that took place over the phone. + - The format for conversations that took place over chat. + enum: + - MEDIUM_UNSPECIFIED + - PHONE_CALL + - CHAT + duration: + description: Output only. The duration of the conversation. + readOnly: true type: string - description: The representative name for the issue. - name: + format: google-duration + turnCount: + description: Output only. The number of turns in the conversation. + readOnly: true + type: integer + format: int32 + latestAnalysis: + description: Output only. The conversation's latest analysis, if one exists. + readOnly: true + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Analysis' + latestSummary: + description: Output only. Latest summary of the conversation. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData + runtimeAnnotations: description: >- - Immutable. The resource name of the issue. Format: - projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue} - type: string - createTime: + Output only. The annotations that were generated during the customer + and agent interaction. readOnly: true - format: google-datetime - type: string - description: Output only. The time at which this issue was created. - id: GoogleCloudContactcenterinsightsV1Issue - GoogleCloudContactcenterinsightsV1ListQaScorecardsResponse: - description: The response from a ListQaScorecards request. - properties: - qaScorecards: type: array - description: The QaScorecards under the parent. items: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecard' - nextPageToken: - type: string + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1RuntimeAnnotation + dialogflowIntents: description: >- - A token, which can be sent as `page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. - type: object - id: GoogleCloudContactcenterinsightsV1ListQaScorecardsResponse - GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment: - id: >- - GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment - description: A segment of a full transcript. + Output only. All the matched Dialogflow intents in the call. The key + corresponds to a Dialogflow intent, format: + projects/{project}/agent/{agent}/intents/{intent} + readOnly: true + type: object + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1DialogflowIntent + obfuscatedUserId: + description: Obfuscated user ID which the customer sent to us. + type: string + GoogleCloudContactcenterinsightsV1ConversationCallMetadata: + id: GoogleCloudContactcenterinsightsV1ConversationCallMetadata + description: Call-specific metadata. type: object properties: - words: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo - description: >- - A list of the word-specific information for each word in the - segment. - channelTag: + customerChannel: + description: The audio channel that contains the customer. type: integer - description: >- - For conversations derived from multi-channel audio, this is the - channel number corresponding to the audio from that channel. For - audioChannelCount = N, its output values can range from '1' to 'N'. - A channel tag of 0 indicates that the audio is mono. format: int32 - segmentParticipant: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant - description: The participant of this segment. - messageTime: - description: The time that the message occurred, if provided. - type: string - format: google-datetime - sentiment: - description: The sentiment for this transcript segment. + agentChannel: + description: The audio channel that contains the agent. + type: integer + format: int32 + GoogleCloudContactcenterinsightsV1ConversationDataSource: + id: GoogleCloudContactcenterinsightsV1ConversationDataSource + description: The conversation source, which is a combination of transcript and audio. + type: object + properties: + gcsSource: + description: A Cloud Storage location specification for the audio and transcript. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1GcsSource' + dialogflowSource: + description: The source when the conversation comes from Dialogflow. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData - text: - description: The text of this segment. + #/components/schemas/GoogleCloudContactcenterinsightsV1DialogflowSource + metadataUri: + description: >- + Cloud Storage URI that points to a file that contains the + conversation metadata. type: string - confidence: + GoogleCloudContactcenterinsightsV1GcsSource: + id: GoogleCloudContactcenterinsightsV1GcsSource + description: A Cloud Storage source of conversation data. + type: object + properties: + audioUri: description: >- - A confidence estimate between 0.0 and 1.0 of the fidelity of this - segment. A default value of 0.0 indicates that the value is unset. - type: number - format: float - languageCode: + Cloud Storage URI that points to a file that contains the + conversation audio. + type: string + transcriptUri: description: >- - The language code of this segment as a - [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. - Example: "en-US". + Immutable. Cloud Storage URI that points to a file that contains the + conversation transcript. type: string - dialogflowSegmentMetadata: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata - description: CCAI metadata relating to the current transcript segment. - GoogleCloudContactcenterinsightsV1QaAnswerAnswerSource: + GoogleCloudContactcenterinsightsV1DialogflowSource: + id: GoogleCloudContactcenterinsightsV1DialogflowSource + description: A Dialogflow source of conversation data. type: object - description: >- - A question may have multiple answers from varying sources, one of which - becomes the "main" answer above. AnswerSource represents each individual - answer. - id: GoogleCloudContactcenterinsightsV1QaAnswerAnswerSource properties: - answerValue: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue - description: The answer value from this source. - sourceType: - enumDescriptions: - - Source type is unspecified. - - Answer was system-generated; created during an Insights analysis. - - Answer was created by a human via manual edit. - description: What created the answer. - enum: - - SOURCE_TYPE_UNSPECIFIED - - SYSTEM_GENERATED - - MANUAL_EDIT + dialogflowConversation: + description: >- + Output only. The name of the Dialogflow conversation that this + conversation resource is derived from. Format: + projects/{project}/locations/{location}/conversations/{conversation} + readOnly: true type: string - GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecResponse: + audioUri: + description: >- + Cloud Storage URI that points to a file that contains the + conversation audio. + type: string + GoogleCloudContactcenterinsightsV1ConversationQualityMetadata: + id: GoogleCloudContactcenterinsightsV1ConversationQualityMetadata + description: Conversation metadata related to quality management. type: object - properties: {} - id: GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecResponse - description: The response to initialize a location-level encryption specification. - GoogleCloudContactcenterinsightsV1QueryMetricsResponseSlice: properties: - timeSeries: + customerSatisfactionRating: description: >- - A time series of metric values. This is only populated if the - request specifies a time granularity other than NONE. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceTimeSeries - dimensions: + An arbitrary integer value indicating the customer's satisfaction + rating. + type: integer + format: int32 + waitDuration: + description: The amount of time the customer waited to connect with an agent. + type: string + format: google-duration + menuPath: + description: >- + An arbitrary string value specifying the menu path the customer + took. + type: string + agentInfo: + description: Information about agents involved in the call. type: array items: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Dimension' - description: A unique combination of dimensions that this slice represents. - total: - description: >- - The total metric value. The interval of this data point is [starting - create time, ending create time) from the request. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPoint + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo + feedbackLabels: + description: Input only. The feedback labels associated with the conversation. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel + GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo: + id: GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo + description: Information about an agent involved in the conversation. type: object + properties: + agentId: + description: A user-specified string representing the agent. + type: string + displayName: + description: The agent's name. + type: string + team: + description: >- + A user-specified string representing the agent's team. Deprecated in + favor of the `teams` field. + deprecated: true + type: string + teams: + description: User-specified strings representing the agent's teams. + type: array + items: + type: string + dispositionCode: + description: >- + A user-provided string indicating the outcome of the agent's segment + of the call. + type: string + agentType: + description: The agent type, e.g. HUMAN_AGENT. + type: string + enumDescriptions: + - Participant's role is not set. + - Participant is a human agent. + - Participant is an automated agent. + - Participant is an end user who conversed with the contact center. + - Participant is either a human or automated agent. + enum: + - ROLE_UNSPECIFIED + - HUMAN_AGENT + - AUTOMATED_AGENT + - END_USER + - ANY_AGENT + location: + description: The agent's location. + type: string + GoogleCloudContactcenterinsightsV1FeedbackLabel: + id: GoogleCloudContactcenterinsightsV1FeedbackLabel description: >- - A slice contains a total and (if the request specified a time - granularity) a time series of metric values. Each slice contains a - unique combination of the cardinality of dimensions from the request. - For example, if the request specifies a single ISSUE dimension and it - has a cardinality of 2 (i.e. the data used to compute the metrics has 2 - issues in total), the response will have 2 slices: * Slice 1 -> - dimensions=[Issue 1] * Slice 2 -> dimensions=[Issue 2] - id: GoogleCloudContactcenterinsightsV1QueryMetricsResponseSlice - GoogleCloudContactcenterinsightsV1ListViewsResponse: - id: GoogleCloudContactcenterinsightsV1ListViewsResponse + Represents a conversation, resource, and label provided by the user. Can + take the form of a string label or a QaAnswer label. QaAnswer labels are + used for Quality AI example conversations. String labels are used for + Topic Modeling. AgentAssistSummary labels are used for Agent Assist + Summarization. type: object - description: The response of listing views. properties: - views: - items: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' - description: The views that match the request. - type: array - nextPageToken: + label: + description: String label used for Topic Modeling. type: string + qaAnswerLabel: + description: QaAnswer label used for Quality AI example conversations. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue + name: description: >- - A token, which can be sent as `page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. - GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataResponse: - type: object - id: GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataResponse - description: Response for an export insights operation. - properties: {} - GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData: - description: Conversation summarization suggestion data. + Immutable. Resource name of the FeedbackLabel. Format: + projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label} + type: string + labeledResource: + description: >- + Name of the resource to be labeled. Supported resources are: * + `projects/{project}/locations/{location}/qaScorecards/{scorecard}/revisions/{revision}/qaQuestions/{question}` + * + `projects/{project}/locations/{location}/issueModels/{issue_model}` + * + `projects/{project}/locations/{location}/generators/{generator_id}` + type: string + createTime: + description: Output only. Create time of the label. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. Update time of the label. + readOnly: true + type: string + format: google-datetime + GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue: + id: GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue + description: >- + Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice + defines the possible answer values for a question. type: object - id: >- - GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData properties: - text: - description: The summarization content that is concatenated into one string. + strValue: + description: String value. type: string - metadata: - additionalProperties: - type: string + numValue: + description: Numerical value. + type: number + format: double + boolValue: + description: Boolean value. + type: boolean + naValue: + description: A value of "Not Applicable (N/A)". Should only ever be `true`. + type: boolean + skipValue: description: >- - A map that contains metadata about the summarization and the - document from which it originates. - type: object - conversationModel: + Output only. A value of "Skip". If provided, this field may only be + set to `true`. If a question receives this answer, it will be + excluded from any score calculations. This would mean that the + question was not evaluated. + readOnly: true + type: boolean + key: description: >- - The name of the model that generates this summary. Format: - projects/{project}/locations/{location}/conversationModels/{conversation_model} - type: string - answerRecord: + A short string used as an identifier. Matches the value used in + QaQuestion.AnswerChoice.key. type: string + score: + description: Output only. Numerical score of the answer. + readOnly: true + type: number + format: double + potentialScore: + description: Output only. The maximum potential score of the question. + readOnly: true + type: number + format: double + normalizedScore: description: >- - The name of the answer record. Format: - projects/{project}/locations/{location}/answerRecords/{answer_record} - confidence: + Output only. Normalized score of the questions. Calculated as score + / potential_score. + readOnly: true type: number - format: float - description: The confidence score of the summarization. - textSections: + format: double + GoogleCloudContactcenterinsightsV1ConversationTranscript: + id: GoogleCloudContactcenterinsightsV1ConversationTranscript + description: A message representing the transcript of a conversation. + type: object + properties: + transcriptSegments: description: >- - The summarization content that is divided into sections. The key is - the section's name and the value is the section's content. There is - no specific format for the key or value. - additionalProperties: - type: string - type: object - GoogleCloudContactcenterinsightsV1QueryMetricsRequest: + A list of sequential transcript segments that comprise the + conversation. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment + GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment: + id: >- + GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment + description: A segment of a full transcript. type: object - description: The request for querying metrics. - id: GoogleCloudContactcenterinsightsV1QueryMetricsRequest properties: - measureMask: + messageTime: + description: The time that the message occurred, if provided. + type: string + format: google-datetime + text: + description: The text of this segment. type: string + confidence: description: >- - Measures to return. Defaults to all measures if this field is - unspecified. A valid mask should traverse from the `measure` field - from the response. For example, a path from a measure mask to get - the conversation count is "conversation_measure.count". - format: google-fieldmask - timeGranularity: + A confidence estimate between 0.0 and 1.0 of the fidelity of this + segment. A default value of 0.0 indicates that the value is unset. + type: number + format: float + words: description: >- - The time granularity of each data point in the time series. Defaults - to NONE if this field is unspecified. - enumDescriptions: - - The time granularity is unspecified and will default to NONE. - - >- - No time granularity. The response won't contain a time series. - This is the default value if no time granularity is specified. - - >- - Data points in the time series will aggregate at a daily - granularity. 1 day means [midnight to midnight). - - >- - Data points in the time series will aggregate at a daily - granularity. 1 HOUR means [01:00 to 02:00). - - >- - Data points in the time series will aggregate at a daily - granularity. PER_MINUTE means [01:00 to 01:01). - - >- - Data points in the time series will aggregate at a 1 minute - granularity. PER_5_MINUTES means [01:00 to 01:05). - enum: - - TIME_GRANULARITY_UNSPECIFIED - - NONE - - DAILY - - HOURLY - - PER_MINUTE - - PER_5_MINUTES - type: string - dimensions: + A list of the word-specific information for each word in the + segment. type: array - description: >- - The dimensions that determine the grouping key for the query. - Defaults to no dimension if this field is unspecified. If a - dimension is specified, its key must also be specified. Each - dimension's key must be unique. If a time granularity is also - specified, metric values in the dimension will be bucketed by this - granularity. Up to one dimension is supported for now. items: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Dimension' - filter: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo + languageCode: description: >- - Required. Filter to select a subset of conversations to compute the - metrics. Must specify a window of the conversation create time to - compute the metrics. The returned metrics will be from the range - [DATE(starting create time), DATE(ending create time)). + The language code of this segment as a + [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. + Example: "en-US". type: string - GoogleCloudContactcenterinsightsV1alpha1IssueMatchData: - type: object - properties: - issueAssignment: - description: Information about the issue's assignment. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueAssignment - id: GoogleCloudContactcenterinsightsV1alpha1IssueMatchData - description: The data for an issue match annotation. - GoogleCloudContactcenterinsightsV1QueryMetricsMetadata: - type: object - description: The metadata from querying metrics. - id: GoogleCloudContactcenterinsightsV1QueryMetricsMetadata - properties: {} - GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata: - type: object - description: Conversation metadata related to quality management. - id: GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata - properties: - agentInfo: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo - description: Information about agents involved in the call. - customerSatisfactionRating: - type: integer + channelTag: description: >- - An arbitrary integer value indicating the customer's satisfaction - rating. + For conversations derived from multi-channel audio, this is the + channel number corresponding to the audio from that channel. For + audioChannelCount = N, its output values can range from '1' to 'N'. + A channel tag of 0 indicates that the audio is mono. + type: integer format: int32 - menuPath: - type: string - description: >- - An arbitrary string value specifying the menu path the customer - took. - waitDuration: - format: google-duration - description: The amount of time the customer waited to connect with an agent. - type: string - GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPoint: - description: A data point contains the metric values mapped to an interval. - properties: - interval: - $ref: '#/components/schemas/GoogleTypeInterval' - description: >- - The interval that this data point represents. * If this is the total - data point, the interval is [starting create time, ending create - time) from the request. * If this a data point from the time series, - the interval is [time, time + time granularity from the request). - conversationMeasure: - description: The measure related to conversations. + segmentParticipant: + description: The participant of this segment. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure - type: object - id: GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPoint - GoogleCloudContactcenterinsightsV1HoldData: - description: The data for a hold annotation. - properties: {} - id: GoogleCloudContactcenterinsightsV1HoldData + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationParticipant + dialogflowSegmentMetadata: + description: CCAI metadata relating to the current transcript segment. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata + sentiment: + description: The sentiment for this transcript segment. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData' + GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo: + id: >- + GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo + description: Word-level info for words in a transcript. type: object - GoogleCloudContactcenterinsightsV1DimensionAgentDimensionMetadata: - id: GoogleCloudContactcenterinsightsV1DimensionAgentDimensionMetadata - description: Metadata about the agent dimension. properties: - agentTeam: - description: Optional. A user-specified string representing the agent's team. + startOffset: + description: >- + Time offset of the start of this word relative to the beginning of + the total conversation. type: string - agentId: - description: Optional. A user-specified string representing the agent. + format: google-duration + endOffset: + description: >- + Time offset of the end of this word relative to the beginning of the + total conversation. type: string - agentDisplayName: - description: Optional. The agent's name + format: google-duration + word: + description: The word itself. Includes punctuation marks that surround the word. type: string + confidence: + description: >- + A confidence estimate between 0.0 and 1.0 of the fidelity of this + word. A default value of 0.0 indicates that the value is unset. + type: number + format: float + GoogleCloudContactcenterinsightsV1ConversationParticipant: + id: GoogleCloudContactcenterinsightsV1ConversationParticipant + description: The call participant speaking for a given utterance. type: object - GoogleCloudContactcenterinsightsV1IngestConversationsRequest: - description: The request to ingest conversations. properties: - transcriptObjectConfig: - description: Configuration for when `source` contains conversation transcripts. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig - sampleSize: - type: integer - description: >- - Optional. If set, this fields indicates the number of objects to - ingest from the Cloud Storage bucket. If empty, the entire bucket - will be ingested. Unless they are first deleted, conversations - produced through sampling won't be ingested by subsequent ingest - requests. - format: int32 - redactionConfig: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1RedactionConfig + dialogflowParticipantName: description: >- - Optional. DLP settings for transcript redaction. Optional, will - default to the config specified in Settings. - parent: + The name of the participant provided by Dialogflow. Format: + projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} type: string - description: Required. The parent resource for new conversations. - speechConfig: - description: >- - Optional. Default Speech-to-Text configuration. Optional, will - default to the config specified in Settings. - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SpeechConfig' - gcsSource: - description: >- - A cloud storage bucket source. Note that any previously ingested - objects from the source will be skipped to avoid duplication. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource - conversationConfig: - description: Configuration that applies to all conversations. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig - type: object - id: GoogleCloudContactcenterinsightsV1IngestConversationsRequest - GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant: - description: The call participant speaking for a given utterance. - id: GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant - properties: userId: - type: string description: A user-specified ID representing the participant. - role: - enum: - - ROLE_UNSPECIFIED - - HUMAN_AGENT - - AUTOMATED_AGENT - - END_USER - - ANY_AGENT - description: The role of the participant. - enumDescriptions: - - Participant's role is not set. - - Participant is a human agent. - - Participant is an automated agent. - - Participant is an end user who conversed with the contact center. - - Participant is either a human or automated agent. type: string dialogflowParticipant: description: >- @@ -622,396 +613,276 @@ components: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} deprecated: true type: string - dialogflowParticipantName: - description: >- - The name of the participant provided by Dialogflow. Format: - projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} - type: string obfuscatedExternalUserId: - type: string description: Obfuscated user ID from Dialogflow. - type: object - GoogleCloudContactcenterinsightsV1alpha1RedactionConfig: - id: GoogleCloudContactcenterinsightsV1alpha1RedactionConfig - description: >- - DLP resources used for redaction while ingesting conversations. DLP - settings are applied to conversations ingested from the - `UploadConversation` and `IngestConversations` endpoints, including - conversation coming from CCAI Platform. They are not applied to - conversations ingested from the `CreateConversation` endpoint or the - Dialogflow / Agent Assist runtime integrations. When using Dialogflow / - Agent Assist runtime integrations, redaction should be performed in - Dialogflow / Agent Assist. + type: string + role: + description: The role of the participant. + type: string + enumDescriptions: + - Participant's role is not set. + - Participant is a human agent. + - Participant is an automated agent. + - Participant is an end user who conversed with the contact center. + - Participant is either a human or automated agent. + enum: + - ROLE_UNSPECIFIED + - HUMAN_AGENT + - AUTOMATED_AGENT + - END_USER + - ANY_AGENT + GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata: + id: >- + GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata + description: Metadata from Dialogflow relating to the current transcript segment. type: object properties: - inspectTemplate: - type: string + smartReplyAllowlistCovered: description: >- - The fully-qualified DLP inspect template resource name. Format: - `projects/{project}/locations/{location}/inspectTemplates/{template}` - deidentifyTemplate: - type: string + Whether the transcript segment was covered under the configured + smart reply allowlist in Agent Assist. + type: boolean + GoogleCloudContactcenterinsightsV1SentimentData: + id: GoogleCloudContactcenterinsightsV1SentimentData + description: The data for a sentiment annotation. + type: object + properties: + magnitude: description: >- - The fully-qualified DLP deidentify template resource name. Format: - `projects/{project}/deidentifyTemplates/{template}` - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats: - description: Statistics for IngestConversations operation. + A non-negative number from 0 to infinity which represents the + absolute magnitude of sentiment regardless of score. + type: number + format: float + score: + description: The sentiment score between -1.0 (negative) and 1.0 (positive). + type: number + format: float + GoogleCloudContactcenterinsightsV1Analysis: + id: GoogleCloudContactcenterinsightsV1Analysis + description: The analysis resource. + type: object properties: - duplicatesSkippedCount: - type: integer + name: description: >- - Output only. The number of objects skipped because another - conversation with the same transcript uri had already been ingested. - format: int32 + Immutable. The resource name of the analysis. Format: + projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} + type: string + requestTime: + description: Output only. The time at which the analysis was requested. readOnly: true - failedIngestCount: - format: int32 - type: integer + type: string + format: google-datetime + createTime: + description: >- + Output only. The time at which the analysis was created, which + occurs when the long-running operation completes. readOnly: true + type: string + format: google-datetime + analysisResult: description: >- - Output only. The number of objects which were unable to be ingested - due to errors. The errors are populated in the partial_errors field. - successfulIngestCount: - description: >- - Output only. The number of new conversations added during this - ingest operation. - readOnly: true - format: int32 - type: integer - processedObjectCount: - type: integer + Output only. The result of the analysis, which is populated when the + analysis finishes. readOnly: true - format: int32 + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AnalysisResult + annotatorSelector: description: >- - Output only. The number of objects processed during the ingest - operation. - id: >- - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats + To select the annotators to run and the phrase matchers to use (if + any). If not specified, all annotators will be run. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelector + GoogleCloudContactcenterinsightsV1AnalysisResult: + id: GoogleCloudContactcenterinsightsV1AnalysisResult + description: The result of an analysis. type: object - GoogleCloudContactcenterinsightsV1QueryMetricsResponse: properties: - slices: + callAnalysisMetadata: + description: Call-specific metadata created by the analysis. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata + endTime: + description: The time at which the analysis ended. + type: string + format: google-datetime + GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata: + id: GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata + description: Call-specific metadata created during analysis. + type: object + properties: + annotations: + description: A list of call annotations that apply to this call. type: array items: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsResponseSlice - description: >- - A slice contains a total and (if the request specified a time - granularity) a time series of metric values. Each slice contains a - unique combination of the cardinality of dimensions from the - request. - macroAverageSlice: - description: >- - The macro average slice contains aggregated averages across the - selected dimension. i.e. if group_by agent is specified this field - will contain the average across all agents. This field is only - populated if the request specifies a Dimension. + #/components/schemas/GoogleCloudContactcenterinsightsV1CallAnnotation + entities: + description: All the entities in the call. + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Entity' + sentiments: + description: Overall conversation-level sentiment for each channel of the call. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationLevelSentiment + silence: + description: Overall conversation-level silence during the call. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsResponseSlice - updateTime: - description: The metrics last update time. - format: google-datetime - type: string - location: - description: >- - Required. The location of the data. - "projects/{project}/locations/{location}" - type: string - type: object - description: The response for querying metrics. - id: GoogleCloudContactcenterinsightsV1QueryMetricsResponse - GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequestGcsSource: - description: Google Cloud Storage Object details to get the feedback label file from. + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationLevelSilence + intents: + description: All the matched intents in the call. + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Intent' + phraseMatchers: + description: All the matched phrase matchers in the call. + type: object + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchData + issueModelResult: + description: Overall conversation-level issue modeling result. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelResult + qaScorecardResults: + description: Results of scoring QaScorecards. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecardResult + GoogleCloudContactcenterinsightsV1CallAnnotation: + id: GoogleCloudContactcenterinsightsV1CallAnnotation + description: A piece of metadata that applies to a window of a call. type: object properties: - format: - enum: - - FORMAT_UNSPECIFIED - - CSV - - JSON - type: string - description: Required. File format which will be ingested. - enumDescriptions: - - Unspecified format. - - CSV format. - - JSON format. - objectUri: - description: >- - Required. The Google Cloud Storage URI of the file to import. - Format: `gs://bucket_name/object_name` - type: string - id: >- - GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequestGcsSource - GoogleCloudContactcenterinsightsV1alpha1Dimension: - properties: - agentDimensionMetadata: - description: Output only. Metadata about the agent dimension. + interruptionData: + description: Data specifying an interruption. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DimensionAgentDimensionMetadata - readOnly: true - qaQuestionAnswerDimensionMetadata: - description: Output only. Metadata about the QA question-answer dimension. + #/components/schemas/GoogleCloudContactcenterinsightsV1InterruptionData + sentimentData: + description: Data specifying sentiment. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData' + silenceData: + description: Data specifying silence. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SilenceData' + holdData: + description: Data specifying a hold. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1HoldData' + entityMentionData: + description: Data specifying an entity mention. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionAnswerDimensionMetadata - readOnly: true - qaQuestionDimensionMetadata: - description: Output only. Metadata about the QA question dimension. - readOnly: true + #/components/schemas/GoogleCloudContactcenterinsightsV1EntityMentionData + intentMatchData: + description: Data specifying an intent match. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionDimensionMetadata - dimensionKey: - enumDescriptions: - - The key of the dimension is unspecified. - - The dimension is keyed by issues. - - The dimension is keyed by agents. - - The dimension is keyed by agent teams. - - >- - The dimension is keyed by QaQuestionIds. Note that: We only group - by the QuestionId and not the revision-id of the scorecard this - question is a part of. This allows for showing stats for the same - question across different scorecard revisions. - - >- - The dimension is keyed by QaQuestionIds-Answer value pairs. Note - that: We only group by the QuestionId and not the revision-id of - the scorecard this question is a part of. This allows for showing - distribution of answers per question across different scorecard - revisions. - - The dimension is keyed by the conversation profile ID. - type: string - enum: - - DIMENSION_KEY_UNSPECIFIED - - ISSUE - - AGENT - - AGENT_TEAM - - QA_QUESTION_ID - - QA_QUESTION_ANSWER_VALUE - - CONVERSATION_PROFILE_ID - description: The key of the dimension. - issueDimensionMetadata: - readOnly: true - description: Output only. Metadata about the issue dimension. + #/components/schemas/GoogleCloudContactcenterinsightsV1IntentMatchData + phraseMatchData: + description: Data specifying a phrase match. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DimensionIssueDimensionMetadata - id: GoogleCloudContactcenterinsightsV1alpha1Dimension - type: object - description: >- - A dimension determines the grouping key for the query. In SQL terms, - these would be part of both the "SELECT" and "GROUP BY" clauses. - GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsMetadata: - description: The metadata for a bulk analyze conversations operation. - properties: - totalRequestedAnalysesCount: + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchData + issueMatchData: + description: Data specifying an issue match. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueMatchData + channelTag: description: >- - Total number of analyses requested. Computed by the number of - conversations returned by `filter` multiplied by - `analysis_percentage` in the request. - format: int32 + The channel of the audio where the annotation occurs. For + single-channel audio, this field is not populated. type: integer - request: - description: The original request for bulk analyze. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest - createTime: - description: The time the operation was created. - type: string - format: google-datetime - completedAnalysesCount: format: int32 - type: integer + annotationStartBoundary: description: >- - The number of requested analyses that have completed successfully so - far. - failedAnalysesCount: - description: The number of requested analyses that have failed so far. - format: int32 - type: integer - partialErrors: - type: array - items: - $ref: '#/components/schemas/GoogleRpcStatus' - readOnly: true + The boundary in the conversation where the annotation starts, + inclusive. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotationBoundary + annotationEndBoundary: description: >- - Output only. Partial errors during bulk analyze operation that might - cause the operation output to be incomplete. - endTime: - description: The time the operation finished running. - format: google-datetime - type: string + The boundary in the conversation where the annotation ends, + inclusive. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotationBoundary + GoogleCloudContactcenterinsightsV1InterruptionData: + id: GoogleCloudContactcenterinsightsV1InterruptionData + description: The data for an interruption annotation. type: object - id: GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsMetadata - GoogleCloudContactcenterinsightsV1Dimension: + properties: {} + GoogleCloudContactcenterinsightsV1SilenceData: + id: GoogleCloudContactcenterinsightsV1SilenceData + description: The data for a silence annotation. type: object - description: >- - A dimension determines the grouping key for the query. In SQL terms, - these would be part of both the "SELECT" and "GROUP BY" clauses. - id: GoogleCloudContactcenterinsightsV1Dimension - properties: - qaQuestionDimensionMetadata: - readOnly: true - description: Output only. Metadata about the QA question dimension. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1DimensionQaQuestionDimensionMetadata - issueDimensionMetadata: - readOnly: true - description: Output only. Metadata about the issue dimension. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1DimensionIssueDimensionMetadata - dimensionKey: - description: The key of the dimension. - type: string - enumDescriptions: - - The key of the dimension is unspecified. - - The dimension is keyed by issues. - - The dimension is keyed by agents. - - The dimension is keyed by agent teams. - - >- - The dimension is keyed by QaQuestionIds. Note that: We only group - by the QuestionId and not the revision-id of the scorecard this - question is a part of. This allows for showing stats for the same - question across different scorecard revisions. - - >- - The dimension is keyed by QaQuestionIds-Answer value pairs. Note - that: We only group by the QuestionId and not the revision-id of - the scorecard this question is a part of. This allows for showing - distribution of answers per question across different scorecard - revisions. - - The dimension is keyed by the conversation profile ID. - enum: - - DIMENSION_KEY_UNSPECIFIED - - ISSUE - - AGENT - - AGENT_TEAM - - QA_QUESTION_ID - - QA_QUESTION_ANSWER_VALUE - - CONVERSATION_PROFILE_ID - qaQuestionAnswerDimensionMetadata: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1DimensionQaQuestionAnswerDimensionMetadata - description: Output only. Metadata about the QA question-answer dimension. - readOnly: true - agentDimensionMetadata: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1DimensionAgentDimensionMetadata - readOnly: true - description: Output only. Metadata about the agent dimension. - GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment: - id: GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment - description: One channel of conversation-level sentiment data. + properties: {} + GoogleCloudContactcenterinsightsV1HoldData: + id: GoogleCloudContactcenterinsightsV1HoldData + description: The data for a hold annotation. type: object - properties: - sentimentData: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData - description: Data specifying sentiment. - channelTag: - type: integer - description: The channel of the audio that the data applies to. - format: int32 - GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest: + properties: {} + GoogleCloudContactcenterinsightsV1EntityMentionData: + id: GoogleCloudContactcenterinsightsV1EntityMentionData + description: >- + The data for an entity mention annotation. This represents a mention of + an `Entity` in the conversation. type: object - description: The request to export insights. - id: GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest properties: - kmsKey: - type: string + entityUniqueId: description: >- - A fully qualified KMS key name for BigQuery tables protected by - CMEK. Format: - projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version} - bigQueryDestination: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination - description: Specified if sink is a BigQuery table. - writeDisposition: + The key of this entity in conversation entities. Can be used to + retrieve the exact `Entity` this mention is attached to. + type: string + type: + description: The type of the entity mention. type: string enumDescriptions: - - Write disposition is not specified. Defaults to WRITE_TRUNCATE. - - >- - If the table already exists, BigQuery will overwrite the table - data and use the schema from the load. - - >- - If the table already exists, BigQuery will append data to the - table. - description: Options for what to do if the destination table already exists. + - Unspecified. + - Proper noun. + - Common noun (or noun compound). enum: - - WRITE_DISPOSITION_UNSPECIFIED - - WRITE_TRUNCATE - - WRITE_APPEND - parent: - description: Required. The parent resource to export data from. - type: string - filter: + - MENTION_TYPE_UNSPECIFIED + - PROPER + - COMMON + sentiment: + description: Sentiment expressed for this mention of the entity. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData' + GoogleCloudContactcenterinsightsV1IntentMatchData: + id: GoogleCloudContactcenterinsightsV1IntentMatchData + description: >- + The data for an intent match. Represents an intent match for a text + segment in the conversation. A text segment can be part of a sentence, a + complete sentence, or an utterance with multiple sentences. + type: object + properties: + intentUniqueId: description: >- - A filter to reduce results to a specific subset. Useful for - exporting conversations with specific properties. + The id of the matched intent. Can be used to retrieve the + corresponding intent information. type: string - GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelMetadata: + GoogleCloudContactcenterinsightsV1PhraseMatchData: + id: GoogleCloudContactcenterinsightsV1PhraseMatchData + description: >- + The data for a matched phrase matcher. Represents information + identifying a phrase matcher for a given match. type: object - description: Metadata for creating an issue model. - id: GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelMetadata properties: - endTime: - format: google-datetime - description: Output only. The time the operation finished running. - readOnly: true + phraseMatcher: + description: The unique identifier (the resource name) of the phrase matcher. type: string - createTime: - readOnly: true - format: google-datetime - description: Output only. The time the operation was created. + displayName: + description: The human-readable name of the phrase matcher. type: string - request: - description: The original request for creation. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest - GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata: - description: Call-specific metadata created during analysis. + GoogleCloudContactcenterinsightsV1IssueMatchData: + id: GoogleCloudContactcenterinsightsV1IssueMatchData + description: The data for an issue match annotation. + type: object properties: - entities: - additionalProperties: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Entity' - description: All the entities in the call. - type: object - silence: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationLevelSilence - description: Overall conversation-level silence during the call. - phraseMatchers: - type: object - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchData - description: All the matched phrase matchers in the call. - annotations: - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1CallAnnotation - type: array - description: A list of call annotations that apply to this call. - qaScorecardResults: - description: Results of scoring QaScorecards. - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecardResult - type: array - issueModelResult: - description: Overall conversation-level issue modeling result. + issueAssignment: + description: Information about the issue's assignment. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelResult - sentiments: - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationLevelSentiment - type: array - description: Overall conversation-level sentiment for each channel of the call. - intents: - description: All the matched intents in the call. - additionalProperties: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Intent' - type: object - type: object - id: GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata - GoogleCloudContactcenterinsightsV1alpha1IssueAssignment: + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueAssignment + GoogleCloudContactcenterinsightsV1IssueAssignment: + id: GoogleCloudContactcenterinsightsV1IssueAssignment + description: Information about the issue. type: object properties: issue: @@ -1024,1778 +895,1810 @@ components: type: number format: double displayName: - type: string description: >- Immutable. Display name of the assigned issue. This field is set at - time of analyis and immutable since then. - description: Information about the issue. - id: GoogleCloudContactcenterinsightsV1alpha1IssueAssignment - GoogleCloudContactcenterinsightsV1alpha1QaAnswer: - id: GoogleCloudContactcenterinsightsV1alpha1QaAnswer + time of analysis and immutable since then. + type: string + GoogleCloudContactcenterinsightsV1AnnotationBoundary: + id: GoogleCloudContactcenterinsightsV1AnnotationBoundary + description: >- + A point in a conversation that marks the start or the end of an + annotation. type: object - description: An answer to a QaQuestion. properties: - answerValue: - description: The main answer value, incorporating any manual edits if they exist. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue - answerSources: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerSource - description: List of all individual answers given to the question. - questionBody: - description: Question text. E.g., "Did the agent greet the customer?" - type: string - qaQuestion: - type: string - description: The QaQuestion answered by this answer. - tags: - type: array - items: - type: string + wordIndex: description: >- - User-defined list of arbitrary tags. Matches the value from - QaScorecard.ScorecardQuestion.tags. Used for grouping/organization - and for weighting the score of each answer. - conversation: - description: The conversation the answer applies to. - type: string - potentialScore: - format: double - deprecated: true - type: number + The word index of this boundary with respect to the first word in + the transcript piece. This index starts at zero. + type: integer + format: int32 + transcriptIndex: description: >- - The maximum potential score of the question. If the question was - answered using `na_value`, this field will be zero. Deprecated: Use - AnswerValue.potential_score instead. - GoogleCloudContactcenterinsightsV1UndeployIssueModelMetadata: + The index in the sequence of transcribed pieces of the conversation + where the boundary is located. This index starts at zero. + type: integer + format: int32 + GoogleCloudContactcenterinsightsV1Entity: + id: GoogleCloudContactcenterinsightsV1Entity + description: >- + The data for an entity annotation. Represents a phrase in the + conversation that is a known entity, such as a person, an organization, + or location. + type: object properties: - request: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest - description: The original request for undeployment. - createTime: + displayName: + description: The representative name for the entity. type: string - format: google-datetime - description: Output only. The time the operation was created. - readOnly: true - endTime: - description: Output only. The time the operation finished running. - format: google-datetime + type: + description: The entity type. type: string - readOnly: true - type: object - description: Metadata for undeploying an issue model. - id: GoogleCloudContactcenterinsightsV1UndeployIssueModelMetadata - GoogleCloudContactcenterinsightsV1ExactMatchConfig: + enumDescriptions: + - Unspecified. + - Person. + - Location. + - Organization. + - Event. + - Artwork. + - Consumer product. + - Other types of entities. + - >- + Phone number. The metadata lists the phone number (formatted + according to local convention), plus whichever additional elements + appear in the text: * `number` - The actual number, broken down + into sections according to local convention. * `national_prefix` - + Country code, if detected. * `area_code` - Region or area code, if + detected. * `extension` - Phone extension (to be dialed after + connection), if detected. + - >- + Address. The metadata identifies the street number and locality + plus whichever additional elements appear in the text: * + `street_number` - Street number. * `locality` - City or town. * + `street_name` - Street/route name, if detected. * `postal_code` - + Postal code, if detected. * `country` - Country, if detected. * + `broad_region` - Administrative area, such as the state, if + detected. * `narrow_region` - Smaller administrative area, such as + county, if detected. * `sublocality` - Used in Asian addresses to + demark a district within a city, if detected. + - >- + Date. The metadata identifies the components of the date: * `year` + - Four digit year, if detected. * `month` - Two digit month + number, if detected. * `day` - Two digit day number, if detected. + - Number. The metadata is the number itself. + - Price. The metadata identifies the `value` and `currency`. + enum: + - TYPE_UNSPECIFIED + - PERSON + - LOCATION + - ORGANIZATION + - EVENT + - WORK_OF_ART + - CONSUMER_GOOD + - OTHER + - PHONE_NUMBER + - ADDRESS + - DATE + - NUMBER + - PRICE + metadata: + description: >- + Metadata associated with the entity. For most entity types, the + metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph + MID (`mid`), if they are available. For the metadata associated with + other entity types, see the Type table below. + type: object + additionalProperties: + type: string + salience: + description: >- + The salience score associated with the entity in the [0, 1.0] range. + The salience score for an entity provides information about the + importance or centrality of that entity to the entire document text. + Scores closer to 0 are less salient, while scores closer to 1.0 are + highly salient. + type: number + format: float + sentiment: + description: >- + The aggregate sentiment expressed for this entity in the + conversation. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData' + GoogleCloudContactcenterinsightsV1ConversationLevelSentiment: + id: GoogleCloudContactcenterinsightsV1ConversationLevelSentiment + description: One channel of conversation-level sentiment data. type: object - description: Exact match configuration. properties: - caseSensitive: - description: Whether to consider case sensitivity when performing an exact match. - type: boolean - id: GoogleCloudContactcenterinsightsV1ExactMatchConfig - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig: + channelTag: + description: The channel of the audio that the data applies to. + type: integer + format: int32 + sentimentData: + description: Data specifying sentiment. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData' + GoogleCloudContactcenterinsightsV1ConversationLevelSilence: + id: GoogleCloudContactcenterinsightsV1ConversationLevelSilence + description: Conversation-level silence data. type: object properties: - medium: + silenceDuration: + description: Amount of time calculated to be in silence. type: string - enum: - - MEDIUM_UNSPECIFIED - - PHONE_CALL - - CHAT - enumDescriptions: - - Default value, if unspecified will default to PHONE_CALL. - - The format for conversations that took place over the phone. - - The format for conversations that took place over chat. - description: Required. The medium transcript objects represent. - id: >- - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig - description: Configuration for processing transcript objects. - GoogleProtobufEmpty: + format: google-duration + silencePercentage: + description: Percentage of the total conversation spent in silence. + type: number + format: float + GoogleCloudContactcenterinsightsV1Intent: + id: GoogleCloudContactcenterinsightsV1Intent description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } - type: object - id: GoogleProtobufEmpty - properties: {} - GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionAnswerDimensionMetadata: + The data for an intent. Represents a detected intent in the + conversation, for example MAKES_PROMISE. type: object properties: - questionBody: - type: string - description: Optional. The full body of the question. - answerValue: - description: Optional. The full body of the question. + id: + description: The unique identifier of the intent. type: string - qaScorecardId: + displayName: + description: The human-readable name of the intent. type: string - description: Optional. The QA scorecard ID. - qaQuestionId: - description: Optional. The QA question ID. + GoogleCloudContactcenterinsightsV1IssueModelResult: + id: GoogleCloudContactcenterinsightsV1IssueModelResult + description: Issue Modeling result on a conversation. + type: object + properties: + issueModel: + description: >- + Issue model that generates the result. Format: + projects/{project}/locations/{location}/issueModels/{issue_model} type: string - id: >- - GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionAnswerDimensionMetadata + issues: + description: All the matched issues. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueAssignment + GoogleCloudContactcenterinsightsV1QaScorecardResult: + id: GoogleCloudContactcenterinsightsV1QaScorecardResult description: >- - Metadata about the QA question-answer dimension. This is useful for - showing the answer distribution for questions for a given scorecard. - GoogleCloudContactcenterinsightsV1alpha1InterruptionData: + The results of scoring a single conversation against a QaScorecard. + Contains a collection of QaAnswers and aggregate score. type: object - description: The data for an interruption annotation. - id: GoogleCloudContactcenterinsightsV1alpha1InterruptionData - properties: {} - GoogleCloudContactcenterinsightsV1IssueModel: - id: GoogleCloudContactcenterinsightsV1IssueModel properties: - state: - enum: - - STATE_UNSPECIFIED - - UNDEPLOYED - - DEPLOYING - - DEPLOYED - - UNDEPLOYING - - DELETING - readOnly: true - enumDescriptions: - - Unspecified. - - Model is not deployed but is ready to deploy. - - Model is being deployed. - - >- - Model is deployed and is ready to be used. A model can only be - used in analysis if it's in this state. - - Model is being undeployed. - - Model is being deleted. - description: Output only. State of the model. + name: + description: >- + Identifier. The name of the scorecard result. Format: + projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result} type: string - issueCount: + qaScorecardRevision: + description: The QaScorecardRevision scored by this result. type: string - readOnly: true - description: Output only. Number of issues in this issue model. - format: int64 - modelType: - description: Type of the model. - enumDescriptions: - - Unspecified model type. - - Type V1. - - Type V2. - enum: - - MODEL_TYPE_UNSPECIFIED - - TYPE_V1 - - TYPE_V2 + conversation: + description: The conversation scored by this result. type: string - displayName: + createTime: + description: Output only. The timestamp that the revision was created. + readOnly: true type: string - description: The representative name for the issue model. - languageCode: - description: Language of the model. + format: google-datetime + agentId: + description: ID of the agent that handled the conversation. type: string - inputDataConfig: - description: Configs for the input data that used to create the issue model. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig - updateTime: - format: google-datetime - type: string - readOnly: true - description: >- - Output only. The most recent time at which the issue model was - updated. - trainingStats: - description: >- - Output only. Immutable. The issue model's label statistics on its - training data. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelLabelStats - readOnly: true - createTime: - readOnly: true - format: google-datetime - type: string - description: Output only. The time at which this issue model was created. - name: - type: string - description: >- - Immutable. The resource name of the issue model. Format: - projects/{project}/locations/{location}/issueModels/{issue_model} - description: The issue model resource. - type: object - GoogleCloudContactcenterinsightsV1QaScorecardResult: - id: GoogleCloudContactcenterinsightsV1QaScorecardResult - description: >- - The results of scoring a single conversation against a QaScorecard. - Contains a collection of QaAnswers and aggregate score. - properties: - createTime: - readOnly: true - description: Output only. The timestamp that the revision was created. - type: string - format: google-datetime - scoreSources: - description: List of all individual score sets. + qaAnswers: + description: Set of QaAnswers represented in the result. type: array items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecardResultScoreSource - conversation: - type: string - description: The conversation scored by this result. - name: - description: >- - Identifier. The name of the scorecard result. Format: - projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result} - type: string - qaScorecardRevision: - description: The QaScorecardRevision scored by this result. - type: string - qaTagResults: - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecardResultQaTagResult - type: array - description: Collection of tags and their scores. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1QaAnswer' score: - type: number description: >- The overall numerical score of the result, incorporating any manual edits if they exist. + type: number format: double - agentId: - description: ID of the agent that handled the conversation. - type: string - normalizedScore: - format: double + potentialScore: + description: >- + The maximum potential overall score of the scorecard. Any questions + answered using `na_value` are excluded from this calculation. type: number + format: double + normalizedScore: description: >- The normalized score, which is the score divided by the potential score. Any manual edits are included if they exist. - potentialScore: type: number format: double - description: >- - The maximum potential overall score of the scorecard. Any questions - answered using `na_value` are excluded from this calculation. - qaAnswers: + qaTagResults: + description: Collection of tags and their scores. type: array - items: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1QaAnswer' - description: Set of QaAnswers represented in the result. - type: object - GoogleCloudContactcenterinsightsV1BulkDeleteConversationsResponse: - id: GoogleCloudContactcenterinsightsV1BulkDeleteConversationsResponse - type: object - description: The response for a bulk delete conversations operation. - properties: {} - GoogleCloudContactcenterinsightsV1ListAllFeedbackLabelsResponse: - description: The response for listing all feedback labels. - properties: - nextPageToken: - description: >- - A token, which can be sent as `page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. - type: string - feedbackLabels: items: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel - description: The feedback labels that match the request. + #/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecardResultQaTagResult + scoreSources: + description: List of all individual score sets. type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecardResultScoreSource + GoogleCloudContactcenterinsightsV1QaAnswer: + id: GoogleCloudContactcenterinsightsV1QaAnswer + description: An answer to a QaQuestion. type: object - id: GoogleCloudContactcenterinsightsV1ListAllFeedbackLabelsResponse - GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig: properties: - filter: + qaQuestion: + description: The QaQuestion answered by this answer. type: string - description: >- - A filter to reduce the conversations used for training the model to - a specific subset. - medium: + conversation: + description: The conversation the answer applies to. type: string - enum: - - MEDIUM_UNSPECIFIED - - PHONE_CALL - - CHAT - enumDescriptions: - - Default value, if unspecified will default to PHONE_CALL. - - The format for conversations that took place over the phone. - - The format for conversations that took place over chat. - deprecated: true - description: >- - Medium of conversations used in training data. This field is being - deprecated. To specify the medium to be used in training a new issue - model, set the `medium` field on `filter`. - trainingConversationsCount: - description: Output only. Number of conversations used in training. Output only. - readOnly: true + questionBody: + description: Question text. E.g., "Did the agent greet the customer?" type: string - format: int64 + answerValue: + description: The main answer value, incorporating any manual edits if they exist. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue + tags: + description: >- + User-defined list of arbitrary tags. Matches the value from + QaScorecard.ScorecardQuestion.tags. Used for grouping/organization + and for weighting the score of each answer. + type: array + items: + type: string + answerSources: + description: List of all individual answers given to the question. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1QaAnswerAnswerSource + GoogleCloudContactcenterinsightsV1QaAnswerAnswerSource: + id: GoogleCloudContactcenterinsightsV1QaAnswerAnswerSource + description: >- + A question may have multiple answers from varying sources, one of which + becomes the "main" answer above. AnswerSource represents each individual + answer. type: object - description: Configs for the input data used to create the issue model. - id: GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig - GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelMetadata: properties: - request: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest - description: The original request for undeployment. - endTime: - format: google-datetime - description: Output only. The time the operation finished running. - readOnly: true - type: string - createTime: + sourceType: + description: What created the answer. type: string - description: Output only. The time the operation was created. - readOnly: true - format: google-datetime - id: GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelMetadata - type: object - description: Metadata for undeploying an issue model. - GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest: - description: Request to export an issue model. + enumDescriptions: + - Source type is unspecified. + - Answer was system-generated; created during an Insights analysis. + - Answer was created by a human via manual edit. + enum: + - SOURCE_TYPE_UNSPECIFIED + - SYSTEM_GENERATED + - MANUAL_EDIT + answerValue: + description: The answer value from this source. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue + GoogleCloudContactcenterinsightsV1QaScorecardResultQaTagResult: + id: GoogleCloudContactcenterinsightsV1QaScorecardResultQaTagResult + description: Tags and their corresponding results. type: object - id: GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest properties: - gcsDestination: - description: Google Cloud Storage URI to export the issue model to. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination - name: - description: Required. The issue model to export. + tag: + description: The tag the score applies to. type: string - GoogleIamV1AuditLogConfig: - type: object + score: + description: The score the tag applies to. + type: number + format: double + potentialScore: + description: The potential score the tag applies to. + type: number + format: double + normalizedScore: + description: The normalized score the tag applies to. + type: number + format: double + GoogleCloudContactcenterinsightsV1QaScorecardResultScoreSource: + id: GoogleCloudContactcenterinsightsV1QaScorecardResultScoreSource 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. - id: GoogleIamV1AuditLogConfig + A scorecard result may have multiple sets of scores from varying + sources, one of which becomes the "main" answer above. A ScoreSource + represents each individual set of scores. + type: object properties: - exemptedMembers: - type: array - items: - type: string - description: >- - Specifies the identities that do not cause logging for this type of - permission. Follows the same format of Binding.members. - logType: - description: The log type that this config enables. + sourceType: + description: What created the score. type: string - enum: - - LOG_TYPE_UNSPECIFIED - - ADMIN_READ - - DATA_WRITE - - DATA_READ enumDescriptions: - - Default case. Should never be this. - - 'Admin reads. Example: CloudIAM getIamPolicy' - - 'Data writes. Example: CloudSQL Users create' - - 'Data reads. Example: CloudSQL Users list' - GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData: - description: Agent Assist frequently-asked-question answer data. - properties: - answer: - description: The piece of text from the `source` knowledge base document. - type: string - confidenceScore: - format: float + - Source type is unspecified. + - Score is derived only from system-generated answers. + - >- + Score is derived from both system-generated answers, and includes + any manual edits if they exist. + enum: + - SOURCE_TYPE_UNSPECIFIED + - SYSTEM_GENERATED_ONLY + - INCLUDES_MANUAL_EDITS + score: + description: The overall numerical score of the result. + type: number + format: double + potentialScore: description: >- - The system's confidence score that this answer is a good match for - this conversation, ranging from 0.0 (completely uncertain) to 1.0 - (completely certain). + The maximum potential overall score of the scorecard. Any questions + answered using `na_value` are excluded from this calculation. type: number - source: - type: string + format: double + normalizedScore: description: >- - The knowledge document that this answer was extracted from. Format: - projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}. - queryRecord: - type: string + The normalized score, which is the score divided by the potential + score. + type: number + format: double + qaTagResults: + description: Collection of tags and their scores. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecardResultQaTagResult + GoogleCloudContactcenterinsightsV1AnnotatorSelector: + id: GoogleCloudContactcenterinsightsV1AnnotatorSelector + description: Selector of all available annotators and phrase matchers to run. + type: object + properties: + runInterruptionAnnotator: + description: Whether to run the interruption annotator. + type: boolean + runSilenceAnnotator: + description: Whether to run the silence annotator. + type: boolean + runPhraseMatcherAnnotator: + description: Whether to run the active phrase matcher annotator(s). + type: boolean + phraseMatchers: description: >- - The name of the answer record. Format: - projects/{project}/locations/{location}/answerRecords/{answer_record} - metadata: - type: object + The list of phrase matchers to run. If not provided, all active + phrase matchers will be used. If inactive phrase matchers are + provided, they will not be used. Phrase matchers will be run only if + run_phrase_matcher_annotator is set to true. Format: + projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} + type: array + items: + type: string + runSentimentAnnotator: + description: Whether to run the sentiment annotator. + type: boolean + runEntityAnnotator: + description: Whether to run the entity annotator. + type: boolean + runIntentAnnotator: + description: Whether to run the intent annotator. + type: boolean + runIssueModelAnnotator: description: >- - Map that contains metadata about the FAQ answer and the document - that it originates from. - additionalProperties: + Whether to run the issue model annotator. A model should have + already been deployed for this to take effect. + type: boolean + issueModels: + description: >- + The issue model to run. If not provided, the most recently deployed + topic model will be used. The provided issue model will only be used + for inference if the issue model is deployed and if + run_issue_model_annotator is set to true. If more than one issue + model is provided, only the first provided issue model will be used + for inference. + type: array + items: type: string - question: - description: The corresponding FAQ question. - type: string - id: GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData + runSummarizationAnnotator: + description: Whether to run the summarization annotator. + type: boolean + summarizationConfig: + description: Configuration for the summarization annotator. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig + runQaAnnotator: + description: Whether to run the QA annotator. + type: boolean + qaConfig: + description: Configuration for the QA annotator. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfig + GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig: + id: GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig + description: Configuration for summarization. type: object - GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest: - id: GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest properties: - name: + conversationProfile: + description: >- + Resource name of the Dialogflow conversation profile. Format: + projects/{project}/locations/{location}/conversationProfiles/{conversation_profile} type: string - description: Required. The issue model to undeploy. - type: object - description: The request to undeploy an issue model. - GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest: - id: GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest + summarizationModel: + description: Default summarization model to be used. + type: string + enumDescriptions: + - Unspecified summarization model. + - >- + The CCAI baseline model. This model is deprecated and will be + removed in the future. We recommend using `generator` instead. + - >- + The CCAI baseline model, V2.0. This model is deprecated and will + be removed in the future. We recommend using `generator` instead. + enumDeprecated: + - false + - true + - true + enum: + - SUMMARIZATION_MODEL_UNSPECIFIED + - BASELINE_MODEL + - BASELINE_MODEL_V2_0 + generator: + description: >- + The resource name of the existing created generator. Format: + projects//locations//generators/ + type: string + GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfig: + id: GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfig + description: Configuration for the QA feature. type: object - description: The request to undeploy an issue model. properties: - name: - type: string - description: Required. The issue model to undeploy. - GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData: - description: >- - The data for a matched phrase matcher. Represents information - identifying a phrase matcher for a given match. + scorecardList: + description: A manual list of scorecards to score. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfigScorecardList + GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfigScorecardList: + id: GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfigScorecardList + description: Container for a list of scorecards. + type: object properties: - phraseMatcher: - description: The unique identifier (the resource name) of the phrase matcher. - type: string - displayName: - type: string - description: The human-readable name of the phrase matcher. - id: GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData + qaScorecardRevisions: + description: List of QaScorecardRevisions. + type: array + items: + type: string + GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData: + id: >- + GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData + description: Conversation summarization suggestion data. type: object - GoogleTypeExpr: 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: + text: + description: The summarization content that is concatenated into one string. type: string + textSections: description: >- - Textual representation of an expression in Common Expression - Language syntax. - title: - type: string + The summarization content that is divided into sections. The key is + the section's name and the value is the section's content. There is + no specific format for the key or value. + type: object + additionalProperties: + type: string + confidence: + description: The confidence score of the summarization. + type: number + format: float + metadata: 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. - location: + A map that contains metadata about the summarization and the + document from which it originates. + type: object + additionalProperties: + type: string + answerRecord: + description: >- + The name of the answer record. Format: + projects/{project}/locations/{location}/answerRecords/{answer_record} type: string + conversationModel: description: >- - Optional. String indicating the location of the expression for error - reporting, e.g. a file name and a position in the file. - id: GoogleTypeExpr - type: object + The name of the model that generates this summary. Format: + projects/{project}/locations/{location}/conversationModels/{conversation_model} + type: string + generatorId: + description: Agent Assist generator ID. + type: string + GoogleCloudContactcenterinsightsV1RuntimeAnnotation: + id: GoogleCloudContactcenterinsightsV1RuntimeAnnotation 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. - GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionDimensionMetadata: - id: >- - GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionDimensionMetadata + An annotation that was generated during the customer and agent + interaction. type: object properties: - qaScorecardId: - description: Optional. The QA scorecard ID. - type: string - questionBody: - type: string - description: Optional. The full body of the question. - qaQuestionId: - type: string - description: Optional. The QA question ID. - description: Metadata about the QA question dimension. - GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroup: - id: GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroup - properties: - type: - enumDescriptions: - - Unspecified. - - Must meet all phrase match rules or there is no match. - - If any of the phrase match rules are met, there is a match. - enum: - - PHRASE_MATCH_RULE_GROUP_TYPE_UNSPECIFIED - - ALL_OF - - ANY_OF - type: string - description: Required. The type of this phrase match rule group. - phraseMatchRules: - description: A list of phrase match rules that are included in this group. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchRule - description: A message representing a rule in the phrase matcher. - type: object - GoogleCloudContactcenterinsightsV1CreateAnalysisOperationMetadata: - id: GoogleCloudContactcenterinsightsV1CreateAnalysisOperationMetadata - type: object - description: Metadata for a create analysis operation. - properties: - endTime: - readOnly: true - format: google-datetime + articleSuggestion: + description: Agent Assist Article Suggestion data. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ArticleSuggestionData + faqAnswer: + description: Agent Assist FAQ answer data. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1FaqAnswerData' + smartReply: + description: Agent Assist Smart Reply data. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1SmartReplyData + smartComposeSuggestion: + description: Agent Assist Smart Compose suggestion data. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData + dialogflowInteraction: + description: Dialogflow interaction data. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1DialogflowInteractionData + conversationSummarizationSuggestion: + description: Conversation summarization suggestion data. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData + annotationId: + description: >- + The unique identifier of the annotation. Format: + projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation} type: string - description: Output only. The time the operation finished running. createTime: + description: The time at which this annotation was created. type: string - readOnly: true format: google-datetime - description: Output only. The time the operation was created. - conversation: - type: string - readOnly: true + startBoundary: description: >- - Output only. The Conversation that this Analysis Operation belongs - to. - annotatorSelector: - readOnly: true - description: Output only. The annotator selector used for the analysis (if any). + The boundary in the conversation where the annotation starts, + inclusive. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelector - GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequest: + #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotationBoundary + endBoundary: + description: >- + The boundary in the conversation where the annotation ends, + inclusive. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotationBoundary + answerFeedback: + description: The feedback that the customer has about the answer in `data`. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AnswerFeedback + userInput: + description: Explicit input used for generating the answer + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1RuntimeAnnotationUserInput + GoogleCloudContactcenterinsightsV1ArticleSuggestionData: + id: GoogleCloudContactcenterinsightsV1ArticleSuggestionData + description: Agent Assist Article Suggestion data. type: object - id: GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequest - description: Request for the BulkDownloadFeedbackLabel endpoint. properties: - gcsDestination: - description: A cloud storage bucket destination. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestGcsDestination - parent: + title: + description: Article title. type: string - description: Required. The parent resource for new feedback labels. - feedbackLabelType: - enum: - - FEEDBACK_LABEL_TYPE_UNSPECIFIED - - QUALITY_AI - - TOPIC_MODELING - description: Optional. The type of feedback labels that will be downloaded. + uri: + description: Article URI. type: string - enumDescriptions: - - Unspecified format - - >- - Downloaded file will contain all Quality AI labels from the latest - scorecard revision. - - Downloaded file will contain only Topic Modeling labels. - templateQaScorecardId: + confidenceScore: description: >- - Optional. If set, a template for labeling conversations and - scorecard questions will be created from the conversation_filter and - the questions under the scorecard(s). The feedback label `filter` - will be ignored. - items: + The system's confidence score that this article is a good match for + this conversation, ranging from 0.0 (completely uncertain) to 1.0 + (completely certain). + type: number + format: float + metadata: + description: >- + Map that contains metadata about the Article Suggestion and the + document that it originates from. + type: object + additionalProperties: type: string - type: array - conversationFilter: + queryRecord: description: >- - Optional. Filter parent conversations to download feedback labels - for. When specified, the feedback labels will be downloaded for the - conversations that match the filter. If `template_qa_scorecard_id` - is set, all the conversations that match the filter will be paired - with the questions under the scorecard for labeling. + The name of the answer record. Format: + projects/{project}/locations/{location}/answerRecords/{answer_record} type: string - filter: + source: description: >- - Optional. A filter to reduce results to a specific subset. Supports - disjunctions (OR) and conjunctions (AND). Supported fields: * - `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * - `min_create_time` * `max_create_time` * `min_update_time` * - `max_update_time` * `feedback_label_type`: QUALITY_AI, - TOPIC_MODELING + The knowledge document that this answer was extracted from. Format: + projects/{project}/knowledgeBases/{knowledge_base}/documents/{document} type: string - maxDownloadCount: - format: int32 - description: >- - Optional. Limits the maximum number of feedback labels that will be - downloaded. The first `N` feedback labels will be downloaded. - type: integer - GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest: - description: The request to delete conversations in bulk. - id: GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest + GoogleCloudContactcenterinsightsV1FaqAnswerData: + id: GoogleCloudContactcenterinsightsV1FaqAnswerData + description: Agent Assist frequently-asked-question answer data. + type: object properties: - force: + answer: + description: The piece of text from the `source` knowledge base document. + type: string + confidenceScore: description: >- - If set to true, all of this conversation's analyses will also be - deleted. Otherwise, the request will only succeed if the - conversation has no analyses. - type: boolean - maxDeleteCount: - type: integer - description: Maximum number of conversations to delete. - format: int32 - parent: + The system's confidence score that this answer is a good match for + this conversation, ranging from 0.0 (completely uncertain) to 1.0 + (completely certain). + type: number + format: float + question: + description: The corresponding FAQ question. + type: string + metadata: description: >- - Required. The parent resource to delete conversations from. Format: - projects/{project}/locations/{location} + Map that contains metadata about the FAQ answer and the document + that it originates from. + type: object + additionalProperties: + type: string + queryRecord: + description: >- + The name of the answer record. Format: + projects/{project}/locations/{location}/answerRecords/{answer_record} type: string - filter: + source: + description: >- + The knowledge document that this answer was extracted from. Format: + projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}. type: string - description: Filter used to select the subset of conversations to delete. - type: object - GoogleCloudContactcenterinsightsV1InterruptionData: - id: GoogleCloudContactcenterinsightsV1InterruptionData + GoogleCloudContactcenterinsightsV1SmartReplyData: + id: GoogleCloudContactcenterinsightsV1SmartReplyData + description: Agent Assist Smart Reply data. type: object - description: The data for an interruption annotation. - properties: {} - GoogleCloudContactcenterinsightsV1UploadConversationMetadata: properties: - appliedRedactionConfig: - readOnly: true - description: >- - Output only. The redaction config applied to the uploaded - conversation. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1RedactionConfig - analysisOperation: + reply: + description: The content of the reply. type: string + confidenceScore: description: >- - Output only. The operation name for a successfully created analysis - operation, if any. - readOnly: true - createTime: - readOnly: true - description: Output only. The time the operation was created. - format: google-datetime + The system's confidence score that this reply is a good match for + this conversation, ranging from 0.0 (completely uncertain) to 1.0 + (completely certain). + type: number + format: double + metadata: + description: >- + Map that contains metadata about the Smart Reply and the document + from which it originates. + type: object + additionalProperties: + type: string + queryRecord: + description: >- + The name of the answer record. Format: + projects/{project}/locations/{location}/answerRecords/{answer_record} type: string - request: - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1UploadConversationRequest - description: Output only. The original request. - endTime: - type: string - readOnly: true - description: Output only. The time the operation finished running. - format: google-datetime - id: GoogleCloudContactcenterinsightsV1UploadConversationMetadata - type: object - description: The metadata for an `UploadConversation` operation. - GoogleCloudContactcenterinsightsV1AnnotationBoundary: - id: GoogleCloudContactcenterinsightsV1AnnotationBoundary + GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData: + id: GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData + description: Agent Assist Smart Compose suggestion data. type: object - description: >- - A point in a conversation that marks the start or the end of an - annotation. properties: - wordIndex: - type: integer - format: int32 + suggestion: + description: The content of the suggestion. + type: string + confidenceScore: description: >- - The word index of this boundary with respect to the first word in - the transcript piece. This index starts at zero. - transcriptIndex: - format: int32 + The system's confidence score that this suggestion is a good match + for this conversation, ranging from 0.0 (completely uncertain) to + 1.0 (completely certain). + type: number + format: double + metadata: description: >- - The index in the sequence of transcribed pieces of the conversation - where the boundary is located. This index starts at zero. - type: integer - GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo: - type: object - properties: - displayName: - type: string - description: The agent's name. - team: - type: string - description: A user-specified string representing the agent's team. - agentId: - type: string - description: A user-specified string representing the agent. - dispositionCode: + Map that contains metadata about the Smart Compose suggestion and + the document from which it originates. + type: object + additionalProperties: + type: string + queryRecord: description: >- - A user-provided string indicating the outcome of the agent's segment - of the call. - type: string - id: >- - GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo - description: Information about an agent involved in the conversation. - GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerSource: - type: object - id: GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerSource - properties: - sourceType: - type: string - enum: - - SOURCE_TYPE_UNSPECIFIED - - SYSTEM_GENERATED - - MANUAL_EDIT - enumDescriptions: - - Source type is unspecified. - - Answer was system-generated; created during an Insights analysis. - - Answer was created by a human via manual edit. - description: What created the answer. - answerValue: - description: The answer value from this source. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue - description: >- - A question may have multiple answers from varying sources, one of which - becomes the "main" answer above. AnswerSource represents each individual - answer. - GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest: - description: The request to delete an issue model. - properties: - name: - description: Required. The name of the issue model to delete. + The name of the answer record. Format: + projects/{project}/locations/{location}/answerRecords/{answer_record} type: string - type: object - id: GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest - GoogleCloudContactcenterinsightsV1ListPhraseMatchersResponse: - description: The response of listing phrase matchers. - id: GoogleCloudContactcenterinsightsV1ListPhraseMatchersResponse + GoogleCloudContactcenterinsightsV1DialogflowInteractionData: + id: GoogleCloudContactcenterinsightsV1DialogflowInteractionData + description: Dialogflow interaction data. type: object properties: - nextPageToken: + dialogflowIntentId: description: >- - A token, which can be sent as `page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. + The Dialogflow intent resource path. Format: + projects/{project}/agent/{agent}/intents/{intent} type: string - phraseMatchers: - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher - type: array - description: The phrase matchers that match the request. - GoogleCloudContactcenterinsightsV1DeployIssueModelResponse: - properties: {} - id: GoogleCloudContactcenterinsightsV1DeployIssueModelResponse - description: The response to deploy an issue model. - type: object + confidence: + description: >- + The confidence of the match ranging from 0.0 (completely uncertain) + to 1.0 (completely certain). + type: number + format: float GoogleCloudContactcenterinsightsV1AnswerFeedback: + id: GoogleCloudContactcenterinsightsV1AnswerFeedback description: >- The feedback that the customer has about a certain answer in the conversation. type: object properties: - clicked: - description: Indicates whether an answer or item was clicked by the human agent. - type: boolean correctnessLevel: + description: The correctness level of an answer. + type: string enumDescriptions: - Correctness level unspecified. - Answer is totally wrong. - Answer is partially correct. - Answer is fully correct. - description: The correctness level of an answer. - type: string enum: - CORRECTNESS_LEVEL_UNSPECIFIED - NOT_CORRECT - PARTIALLY_CORRECT - FULLY_CORRECT + clicked: + description: Indicates whether an answer or item was clicked by the human agent. + type: boolean displayed: description: >- Indicates whether an answer or item was displayed to the human agent in the agent desktop UI. type: boolean - id: GoogleCloudContactcenterinsightsV1AnswerFeedback - GoogleCloudContactcenterinsightsV1alpha1ListFeedbackLabelsResponse: + GoogleCloudContactcenterinsightsV1RuntimeAnnotationUserInput: + id: GoogleCloudContactcenterinsightsV1RuntimeAnnotationUserInput + description: Explicit input used for generating the answer type: object properties: - nextPageToken: + query: + description: >- + Query text. Article Search uses this to store the input query used + to generate the search results. type: string - description: The next page token. - feedbackLabels: - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel - description: The feedback labels that match the request. - type: array - description: The response for listing feedback labels. - id: GoogleCloudContactcenterinsightsV1alpha1ListFeedbackLabelsResponse - GoogleCloudContactcenterinsightsV1ListQaScorecardRevisionsResponse: - properties: - qaScorecardRevisions: - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecardRevision - type: array - description: The QaScorecards under the parent. - nextPageToken: + generatorName: description: >- - A token, which can be sent as `page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. + The resource name of associated generator. Format: + `projects//locations//generators/` + type: string + querySource: + description: Query source for the answer. type: string + enumDescriptions: + - Unknown query source. + - The query is from agents. + - >- + The query is a query from previous suggestions, e.g. from a + preceding SuggestKnowledgeAssist response. + enum: + - QUERY_SOURCE_UNSPECIFIED + - AGENT_QUERY + - SUGGESTED_QUERY + GoogleCloudContactcenterinsightsV1DialogflowIntent: + id: GoogleCloudContactcenterinsightsV1DialogflowIntent + description: >- + The data for a Dialogflow intent. Represents a detected intent in the + conversation, e.g. MAKES_PROMISE. type: object - description: The response from a ListQaScorecardRevisions request. - id: GoogleCloudContactcenterinsightsV1ListQaScorecardRevisionsResponse - GoogleCloudContactcenterinsightsV1DeleteIssueModelMetadata: properties: - createTime: - format: google-datetime - readOnly: true - type: string - description: Output only. The time the operation was created. - endTime: - readOnly: true - format: google-datetime + displayName: + description: The human-readable name of the intent. type: string - description: Output only. The time the operation finished running. - request: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest - description: The original request for deletion. - id: GoogleCloudContactcenterinsightsV1DeleteIssueModelMetadata - description: Metadata for deleting an issue model. - type: object - GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsMetadata: + GoogleCloudContactcenterinsightsV1UploadConversationRequest: + id: GoogleCloudContactcenterinsightsV1UploadConversationRequest + description: Request to upload a conversation. type: object - id: GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsMetadata properties: - createTime: + parent: + description: Required. The parent resource of the conversation. type: string - description: The time the operation was created. - format: google-datetime - failedAnalysesCount: - type: integer - description: The number of requested analyses that have failed so far. - format: int32 - endTime: - format: google-datetime - description: The time the operation finished running. + conversation: + description: Required. The conversation resource to create. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Conversation' + conversationId: + description: >- + Optional. A unique ID for the new conversation. This ID will become + the final component of the conversation's resource name. If no ID is + specified, a server-generated ID will be used. This value should be + 4-64 characters and must match the regular expression + `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-` type: string - request: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest - description: The original request for bulk analyze. - totalRequestedAnalysesCount: + redactionConfig: description: >- - Total number of analyses requested. Computed by the number of - conversations returned by `filter` multiplied by - `analysis_percentage` in the request. - type: integer - format: int32 - partialErrors: - type: array - items: - $ref: '#/components/schemas/GoogleRpcStatus' + Optional. DLP settings for transcript redaction. Will default to the + config specified in Settings. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1RedactionConfig + speechConfig: description: >- - Output only. Partial errors during bulk analyze operation that might - cause the operation output to be incomplete. - readOnly: true - completedAnalysesCount: - type: integer - format: int32 - description: >- - The number of requested analyses that have completed successfully so - far. - description: The metadata for a bulk analyze conversations operation. - GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultScoreSource: + Optional. Speech-to-Text configuration. Will default to the config + specified in Settings. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SpeechConfig' + GoogleCloudContactcenterinsightsV1RedactionConfig: + id: GoogleCloudContactcenterinsightsV1RedactionConfig description: >- - A scorecard result may have multiple sets of scores from varying - sources, one of which becomes the "main" answer above. A ScoreSource - represents each individual set of scores. - id: GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultScoreSource + DLP resources used for redaction while ingesting conversations. DLP + settings are applied to conversations ingested from the + `UploadConversation` and `IngestConversations` endpoints, including + conversation coming from CCAI Platform. They are not applied to + conversations ingested from the `CreateConversation` endpoint or the + Dialogflow / Agent Assist runtime integrations. When using Dialogflow / + Agent Assist runtime integrations, redaction should be performed in + Dialogflow / Agent Assist. + type: object properties: - normalizedScore: + deidentifyTemplate: description: >- - The normalized score, which is the score divided by the potential - score. - format: double - type: number - score: - description: The overall numerical score of the result. - type: number - format: double - qaTagResults: - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultQaTagResult - description: Collection of tags and their scores. - type: array - sourceType: - description: What created the score. + The fully-qualified DLP deidentify template resource name. Format: + `projects/{project}/deidentifyTemplates/{template}` type: string - enumDescriptions: - - Source type is unspecified. - - Score is derived only from system-generated answers. - - >- - Score is derived from both system-generated answers, and includes - any manual edits if they exist. - enum: - - SOURCE_TYPE_UNSPECIFIED - - SYSTEM_GENERATED_ONLY - - INCLUDES_MANUAL_EDITS - potentialScore: - type: number - format: double + inspectTemplate: description: >- - The maximum potential overall score of the scorecard. Any questions - answered using `na_value` are excluded from this calculation. + The fully-qualified DLP inspect template resource name. Format: + `projects/{project}/locations/{location}/inspectTemplates/{template}` + type: string + GoogleCloudContactcenterinsightsV1SpeechConfig: + id: GoogleCloudContactcenterinsightsV1SpeechConfig + description: >- + Speech-to-Text configuration. Speech-to-Text settings are applied to + conversations ingested from the `UploadConversation` and + `IngestConversations` endpoints, including conversation coming from CCAI + Platform. They are not applied to conversations ingested from the + `CreateConversation` endpoint. type: object - GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure: properties: - averageClientSentimentScore: - format: float - type: number - description: The average client's sentiment score. - averageQaQuestionNormalizedScore: - format: double - description: >- - Average QA normalized score averaged for questions averaged across - all revisions of the parent scorecard. Will be only populated if the - request specifies a dimension of QA_QUESTION_ID. - type: number - averageCustomerSatisfactionRating: - format: double - description: The average customer satisfaction rating. - type: number - averageQaNormalizedScore: - format: double + speechRecognizer: description: >- - Average QA normalized score. Will exclude 0's in average - calculation. - type: number - averageDuration: - format: google-duration + The fully-qualified Speech Recognizer resource name. Format: + `projects/{project_id}/locations/{location}/recognizer/{recognizer}` type: string - description: The average duration. - averageTurnCount: - description: The average turn count. - type: number - format: float - qaTagScores: + GoogleCloudContactcenterinsightsV1ListConversationsResponse: + id: GoogleCloudContactcenterinsightsV1ListConversationsResponse + description: The response of listing conversations. + type: object + properties: + conversations: + description: The conversations that match the request. + type: array items: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore - description: Average QA normalized score for all the tags. - type: array - conversationCount: - description: The conversation count. - format: int32 - type: integer - averageAgentSentimentScore: - type: number - description: The average agent's sentiment score. - format: float - averageSilencePercentage: - format: float - description: The average silence percentage. - type: number - id: >- - GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure + #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation + nextPageToken: + description: >- + A token which can be sent as `page_token` to retrieve the next page. + If this field is set, it means there is another page available. If + it is not set, it means no other pages are available. + type: string + GoogleCloudContactcenterinsightsV1Dataset: + id: GoogleCloudContactcenterinsightsV1Dataset + description: >- + Dataset resource represents a collection of conversations that may be + bounded (Static Dataset, e.g. golden dataset for training), or unbounded + (Dynamic Dataset, e.g. live traffic, or agent training traffic) type: object - description: The measure related to conversations. - GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelMetadata: properties: - endTime: - description: Output only. The time the operation finished running. + name: + description: >- + Immutable. Identifier. Resource name of the dataset. Format: + projects/{project}/locations/{location}/datasets/{dataset} type: string - readOnly: true - format: google-datetime - request: - description: The original request for deletion. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest + displayName: + description: Display name for the dataaset + type: string + description: + description: Dataset description. + type: string + type: + description: Dataset usage type. + type: string + enumDescriptions: + - Default value for unspecified. + - For evals only. + - >- + Dataset with new conversations coming in regularly (Insights + legacy conversations and AI trainer) + enum: + - TYPE_UNSPECIFIED + - EVAL + - LIVE + ttl: + description: Optional. Option TTL for the dataset. + type: string + format: google-duration createTime: + description: Output only. Dataset create time. + readOnly: true type: string + format: google-datetime + updateTime: + description: Output only. Dataset update time. readOnly: true + type: string format: google-datetime - description: Output only. The time the operation was created. + GoogleCloudContactcenterinsightsV1ListDatasetsResponse: + id: GoogleCloudContactcenterinsightsV1ListDatasetsResponse + description: The response to list datasets. type: object - description: Metadata for deleting an issue model. - id: GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelMetadata - GoogleCloudContactcenterinsightsV1RuntimeAnnotation: + properties: + datasets: + description: The datasets that match the request. + type: array + items: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Dataset' + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + GoogleCloudContactcenterinsightsV1SampleConversationsRequest: + id: GoogleCloudContactcenterinsightsV1SampleConversationsRequest + description: The request to sample conversations to a dataset. type: object - id: GoogleCloudContactcenterinsightsV1RuntimeAnnotation properties: - conversationSummarizationSuggestion: - description: Conversation summarization suggestion data. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData - answerFeedback: - description: The feedback that the customer has about the answer in `data`. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnswerFeedback - dialogflowInteraction: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1DialogflowInteractionData - description: Dialogflow interaction data. - createTime: - format: google-datetime - description: The time at which this annotation was created. + destinationDataset: + description: The dataset resource to copy the sampled conversations to. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Dataset' + parent: + description: Required. The parent resource of the dataset. type: string - smartComposeSuggestion: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData - description: Agent Assist Smart Compose suggestion data. - faqAnswer: - description: Agent Assist FAQ answer data. - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1FaqAnswerData' - annotationId: + sampleRule: + description: Optional. The sample rule used for sampling conversations. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SampleRule' + GoogleCloudContactcenterinsightsV1SampleRule: + id: GoogleCloudContactcenterinsightsV1SampleRule + description: Message for sampling conversations. + type: object + properties: + samplePercentage: description: >- - The unique identifier of the annotation. Format: - projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation} + Percentage of conversations that we should sample based on the + dimension between [0, 100]. + type: number + format: double + sampleRow: + description: >- + Number of the conversations that we should sample based on the + dimension. type: string - endBoundary: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotationBoundary + format: int64 + dimension: description: >- - The boundary in the conversation where the annotation ends, - inclusive. - articleSuggestion: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ArticleSuggestionData - description: Agent Assist Article Suggestion data. - smartReply: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1SmartReplyData - description: Agent Assist Smart Reply data. - startBoundary: + Optional. Group by dimension to sample the conversation. If no + dimension is provided, the sampling will be applied to the project + level. Current supported dimensions is + 'quality_metadata.agent_info.agent_id'. + type: string + conversationFilter: description: >- - The boundary in the conversation where the annotation starts, - inclusive. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotationBoundary - userInput: - description: Explicit input used for generating the answer - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1RuntimeAnnotationUserInput - description: >- - An annotation that was generated during the customer and agent - interaction. - GoogleCloudContactcenterinsightsV1alpha1ListAllFeedbackLabelsResponse: - id: GoogleCloudContactcenterinsightsV1alpha1ListAllFeedbackLabelsResponse - description: The response for listing all feedback labels. + To specify the filter for the conversions that should apply this + sample rule. An empty filter means this sample rule applies to all + conversations. + type: string + GoogleCloudContactcenterinsightsV1ListAnalysesResponse: + id: GoogleCloudContactcenterinsightsV1ListAnalysesResponse + description: The response to list analyses. type: object properties: + analyses: + description: The analyses that match the request. + type: array + items: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Analysis' nextPageToken: - type: string description: >- A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. - feedbackLabels: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel - description: The feedback labels that match the request. - GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination: - type: object - id: >- - GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination - properties: - objectUri: type: string - description: 'Required. Format: `gs:///`' - description: Google Cloud Storage Object URI to save the issue model to. - GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo: - id: >- - GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo + GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest: + id: GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest + description: The request to analyze conversations in bulk. type: object - description: Word-level info for words in a transcript. properties: - word: + parent: + description: Required. The parent resource to create analyses in. type: string - description: The word itself. Includes punctuation marks that surround the word. - confidence: + filter: description: >- - A confidence estimate between 0.0 and 1.0 of the fidelity of this - word. A default value of 0.0 indicates that the value is unset. + Required. Filter used to select the subset of conversations to + analyze. + type: string + analysisPercentage: + description: >- + Required. Percentage of selected conversation to analyze, between + [0, 100]. type: number format: float - startOffset: + annotatorSelector: description: >- - Time offset of the start of this word relative to the beginning of - the total conversation. + To select the annotators to run and the phrase matchers to use (if + any). If not specified, all annotators will be run. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelector + GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest: + id: GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest + description: The request to delete conversations in bulk. + type: object + properties: + parent: + description: >- + Required. The parent resource to delete conversations from. Format: + projects/{project}/locations/{location} type: string - format: google-duration - endOffset: + filter: + description: Filter used to select the subset of conversations to delete. type: string - format: google-duration + maxDeleteCount: + description: Maximum number of conversations to delete. + type: integer + format: int32 + force: description: >- - Time offset of the end of this word relative to the beginning of the - total conversation. - GoogleCloudContactcenterinsightsV1UploadConversationRequest: - id: GoogleCloudContactcenterinsightsV1UploadConversationRequest + If set to true, all of this conversation's analyses will also be + deleted. Otherwise, the request will only succeed if the + conversation has no analyses. + type: boolean + GoogleCloudContactcenterinsightsV1IngestConversationsRequest: + id: GoogleCloudContactcenterinsightsV1IngestConversationsRequest + description: The request to ingest conversations. + type: object properties: + gcsSource: + description: >- + A cloud storage bucket source. Note that any previously ingested + objects from the source will be skipped to avoid duplication. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource + transcriptObjectConfig: + description: Configuration for when `source` contains conversation transcripts. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig + parent: + description: Required. The parent resource for new conversations. + type: string + conversationConfig: + description: Configuration that applies to all conversations. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig redactionConfig: + description: >- + Optional. DLP settings for transcript redaction. Optional, will + default to the config specified in Settings. $ref: >- #/components/schemas/GoogleCloudContactcenterinsightsV1RedactionConfig - description: >- - Optional. DLP settings for transcript redaction. Will default to the - config specified in Settings. speechConfig: description: >- - Optional. Speech-to-Text configuration. Will default to the config - specified in Settings. + Optional. Default Speech-to-Text configuration. Optional, will + default to the config specified in Settings. $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SpeechConfig' - conversationId: - type: string + sampleSize: description: >- - Optional. A unique ID for the new conversation. This ID will become - the final component of the conversation's resource name. If no ID is - specified, a server-generated ID will be used. This value should be - 4-64 characters and must match the regular expression - `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-` - conversation: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Conversation' - description: Required. The conversation resource to create. - parent: - type: string - description: Required. The parent resource of the conversation. + Optional. If set, this fields indicates the number of objects to + ingest from the Cloud Storage bucket. If empty, the entire bucket + will be ingested. Unless they are first deleted, conversations + produced through sampling won't be ingested by subsequent ingest + requests. + type: integer + format: int32 + GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource: + id: GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource + description: Configuration for Cloud Storage bucket sources. type: object - description: Request to upload a conversation. - GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo: properties: - agentId: - description: A user-specified string representing the agent. - type: string - dispositionCode: - type: string + bucketUri: description: >- - A user-provided string indicating the outcome of the agent's segment - of the call. - team: - description: A user-specified string representing the agent's team. + Optional. The Cloud Storage bucket containing source objects. Avoid + passing this. Pass this through one of `transcript_bucket_uri` or + `audio_bucket_uri`. type: string - displayName: - description: The agent's name. - type: string - type: object - description: Information about an agent involved in the conversation. - id: GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo - GoogleCloudContactcenterinsightsV1alpha1QaScorecardResult: - properties: - createTime: - description: Output only. The timestamp that the revision was created. - readOnly: true - format: google-datetime + bucketObjectType: + description: >- + Optional. Specifies the type of the objects in `bucket_uri`. Avoid + passing this. This is inferred from the `transcript_bucket_uri`, + `audio_bucket_uri`. type: string - scoreSources: - description: List of all individual score sets. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultScoreSource - potentialScore: - format: double - type: number + enumDescriptions: + - The object type is unspecified and will default to `TRANSCRIPT`. + - The object is a transcript. + - The object is an audio file. + enum: + - BUCKET_OBJECT_TYPE_UNSPECIFIED + - TRANSCRIPT + - AUDIO + transcriptBucketUri: description: >- - The maximum potential overall score of the scorecard. Any questions - answered using `na_value` are excluded from this calculation. - name: + Optional. The Cloud Storage path to the conversation transcripts. + Note that: [1] Transcript files are expected to be in JSON format. + [2] Transcript, audio, metadata files must be in separate buckets / + folders. [3] A source file and its corresponding metadata file must + share the same name to be properly ingested, E.g. + `gs://bucket/audio/conversation1.mp3` and + `gs://bucket/metadata/conversation1.json`. + type: string + audioBucketUri: description: >- - Identifier. The name of the scorecard result. Format: - projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result} + Optional. The Cloud Storage path to the conversation audio file. + Note that: [1] Audio files will be transcribed if not already. [2] + Audio files and transcript files must be in separate buckets / + folders. [3] A source file and its corresponding audio file must + share the same name to be properly ingested, E.g. + `gs://bucket/transcript/conversation1.json` and + `gs://bucket/audio/conversation1.mp3`. type: string - normalizedScore: - type: number - format: double + metadataBucketUri: description: >- - The normalized score, which is the score divided by the potential - score. Any manual edits are included if they exist. - agentId: - description: ID of the agent that handled the conversation. + Optional. The Cloud Storage path to the conversation metadata. Note + that: [1] Metadata files are expected to be in JSON format. [2] + Metadata and source files (transcripts or audio) must be in separate + buckets / folders. [3] A source file and its corresponding metadata + file must share the same name to be properly ingested, E.g. + `gs://bucket/audio/conversation1.mp3` and + `gs://bucket/metadata/conversation1.json`. type: string - qaAnswers: - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaAnswer + customMetadataKeys: + description: >- + Optional. Custom keys to extract as conversation labels from + metadata files in `metadata_bucket_uri`. Keys not included in this + field will be ignored. Note that there is a limit of 100 labels per + conversation. type: array - description: Set of QaAnswers represented in the result. - qaTagResults: items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultQaTagResult - type: array - description: Collection of tags and their scores. - conversation: - type: string - description: The conversation scored by this result. - qaScorecardRevision: - description: The QaScorecardRevision scored by this result. - type: string - score: - type: number - format: double - description: >- - The overall numerical score of the result, incorporating any manual - edits if they exist. - description: >- - The results of scoring a single conversation against a QaScorecard. - Contains a collection of QaAnswers and aggregate score. - id: GoogleCloudContactcenterinsightsV1alpha1QaScorecardResult + type: string + GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig: + id: >- + GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig + description: Configuration for processing transcript objects. type: object - GoogleCloudContactcenterinsightsV1CalculateStatsResponse: - id: GoogleCloudContactcenterinsightsV1CalculateStatsResponse - description: The response for calculating conversation statistics. + properties: + medium: + description: Required. The medium transcript objects represent. + type: string + enumDescriptions: + - Default value, if unspecified will default to PHONE_CALL. + - The format for conversations that took place over the phone. + - The format for conversations that took place over chat. + enum: + - MEDIUM_UNSPECIFIED + - PHONE_CALL + - CHAT + GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig: + id: >- + GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig + description: Configuration that applies to all conversations. type: object properties: - averageTurnCount: - type: integer - format: int32 - description: The average number of turns per conversation. - averageDuration: - format: google-duration + agentId: description: >- - The average duration of all conversations. The average is calculated - using only conversations that have a time duration. - type: string - issueMatches: - description: >- - A map associating each issue resource name with its respective - number of matches in the set of conversations. Key has the format: - `projects//locations//issueModels//issues/` Deprecated, use - `issue_matches_stats` field instead. - deprecated: true - type: object - additionalProperties: - format: int32 - type: integer - conversationCountTimeSeries: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeries - description: >- - A time series representing the count of conversations created over - time that match that requested filter criteria. - issueMatchesStats: - type: object - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats - description: >- - A map associating each issue resource name with its respective - number of matches in the set of conversations. Key has the format: - `projects//locations//issueModels//issues/` - customHighlighterMatches: - type: object + Optional. An opaque, user-specified string representing a human + agent who handled all conversations in the import. Note that this + will be overridden if per-conversation metadata is provided through + the `metadata_bucket_uri`. + type: string + agentChannel: description: >- - A map associating each custom highlighter resource name with its - respective number of matches in the set of conversations. - additionalProperties: - format: int32 - type: integer - conversationCount: + Optional. Indicates which of the channels, 1 or 2, contains the + agent. Note that this must be set for conversations to be properly + displayed and analyzed. type: integer format: int32 - description: The total number of conversations. - smartHighlighterMatches: + customerChannel: description: >- - A map associating each smart highlighter display name with its - respective number of matches in the set of conversations. - additionalProperties: - type: integer - format: int32 - type: object - GoogleCloudContactcenterinsightsV1alpha1DimensionIssueDimensionMetadata: - id: GoogleCloudContactcenterinsightsV1alpha1DimensionIssueDimensionMetadata - description: Metadata about the issue dimension. + Optional. Indicates which of the channels, 1 or 2, contains the + agent. Note that this must be set for conversations to be properly + displayed and analyzed. + type: integer + format: int32 + GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest: + id: GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest + description: The request to export insights. type: object properties: - issueDisplayName: - type: string - description: The issue display name. - issueId: - type: string - description: The issue ID. - issueModelId: + bigQueryDestination: + description: Specified if sink is a BigQuery table. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination + parent: + description: Required. The parent resource to export data from. type: string - description: The parent issue model ID. - GoogleCloudContactcenterinsightsV1PhraseMatchRule: - description: The data for a phrase match rule. - properties: - negated: + filter: description: >- - Specifies whether the phrase must be missing from the transcript - segment or present in the transcript segment. - type: boolean - config: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchRuleConfig + A filter to reduce results to a specific subset. Useful for + exporting conversations with specific properties. + type: string + kmsKey: description: >- - Provides additional information about the rule that specifies how to - apply the rule. - query: + A fully qualified KMS key name for BigQuery tables protected by + CMEK. Format: + projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version} type: string - description: Required. The phrase to be matched. - id: GoogleCloudContactcenterinsightsV1PhraseMatchRule - type: object - GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData: - id: GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData + writeDisposition: + description: Options for what to do if the destination table already exists. + type: string + enumDescriptions: + - Write disposition is not specified. Defaults to WRITE_TRUNCATE. + - >- + If the table already exists, BigQuery will overwrite the table + data and use the schema from the load. + - >- + If the table already exists, BigQuery will append data to the + table. + enum: + - WRITE_DISPOSITION_UNSPECIFIED + - WRITE_TRUNCATE + - WRITE_APPEND + exportSchemaVersion: + description: Optional. Version of the export schema. + type: string + enumDescriptions: + - Unspecified. Defaults to EXPORT_V3. + - Export schema version 1. + - Export schema version 2. + - Export schema version 3. + - Export schema version 4. + - Export schema version 5. + - Export schema version 6. + - Export schema version 7. + - Export schema version 8. + - Export schema version 9. + - Export schema version 10. + - Export schema version latest available. + enum: + - EXPORT_SCHEMA_VERSION_UNSPECIFIED + - EXPORT_V1 + - EXPORT_V2 + - EXPORT_V3 + - EXPORT_V4 + - EXPORT_V5 + - EXPORT_V6 + - EXPORT_V7 + - EXPORT_V8 + - EXPORT_V9 + - EXPORT_V10 + - EXPORT_VERSION_LATEST_AVAILABLE + GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination: + id: >- + GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination + description: A BigQuery Table Reference. type: object properties: - dialogflowIntentId: + projectId: + description: >- + A project ID or number. If specified, then export will attempt to + write data to this project instead of the resource project. + Otherwise, the resource project will be used. type: string + dataset: description: >- - The Dialogflow intent resource path. Format: - projects/{project}/agent/{agent}/intents/{intent} - confidence: - type: number - format: float + Required. The name of the BigQuery dataset that the snapshot result + should be exported to. If this dataset does not exist, the export + call returns an INVALID_ARGUMENT error. + type: string + table: description: >- - The confidence of the match ranging from 0.0 (completely uncertain) - to 1.0 (completely certain). - description: Dialogflow interaction data. - GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelMetadata: - description: Metadata for deploying an issue model. + The BigQuery table name to which the insights data should be + written. If this table does not exist, the export call returns an + INVALID_ARGUMENT error. + type: string + GoogleCloudContactcenterinsightsV1IssueModel: + id: GoogleCloudContactcenterinsightsV1IssueModel + description: The issue model resource. + type: object properties: + name: + description: >- + Immutable. The resource name of the issue model. Format: + projects/{project}/locations/{location}/issueModels/{issue_model} + type: string + displayName: + description: The representative name for the issue model. + type: string createTime: + description: Output only. The time at which this issue model was created. readOnly: true type: string format: google-datetime - description: Output only. The time the operation was created. - request: - description: The original request for deployment. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest - endTime: - description: Output only. The time the operation finished running. + updateTime: + description: >- + Output only. The most recent time at which the issue model was + updated. + readOnly: true type: string format: google-datetime + issueCount: + description: Output only. Number of issues in this issue model. readOnly: true - id: GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelMetadata - type: object - GoogleCloudContactcenterinsightsV1QaQuestionAnswerChoice: - type: object - description: Message representing a possible answer to the question. - id: GoogleCloudContactcenterinsightsV1QaQuestionAnswerChoice - properties: - strValue: - description: String value. - type: string - naValue: - type: boolean - description: >- - A value of "Not Applicable (N/A)". If provided, this field may only - be set to `true`. If a question receives this answer, it will be - excluded from any score calculations. - numValue: - format: double - type: number - description: Numerical value. - key: - description: A short string used as an identifier. type: string - score: - type: number - format: double - description: >- - Numerical score of the answer, used for generating the overall score - of a QaScorecardResult. If the answer uses na_value, this field is - unused. - boolValue: - type: boolean - description: Boolean value. - GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelResponse: - type: object - description: Response from import issue model - id: GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelResponse - properties: {} - GoogleCloudContactcenterinsightsV1EntityMentionData: - id: GoogleCloudContactcenterinsightsV1EntityMentionData - properties: - sentiment: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData' - description: Sentiment expressed for this mention of the entity. - type: + format: int64 + state: + description: Output only. State of the model. + readOnly: true type: string - enum: - - MENTION_TYPE_UNSPECIFIED - - PROPER - - COMMON enumDescriptions: - Unspecified. - - Proper noun. - - Common noun (or noun compound). - description: The type of the entity mention. - entityUniqueId: + - Model is not deployed but is ready to deploy. + - Model is being deployed. + - >- + Model is deployed and is ready to be used. A model can only be + used in analysis if it's in this state. + - Model is being undeployed. + - Model is being deleted. + enum: + - STATE_UNSPECIFIED + - UNDEPLOYED + - DEPLOYING + - DEPLOYED + - UNDEPLOYING + - DELETING + inputDataConfig: + description: Configs for the input data that used to create the issue model. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig + trainingStats: description: >- - The key of this entity in conversation entities. Can be used to - retrieve the exact `Entity` this mention is attached to. - type: string - description: >- - The data for an entity mention annotation. This represents a mention of - an `Entity` in the conversation. + Output only. Immutable. The issue model's label statistics on its + training data. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelLabelStats + modelType: + description: Type of the model. + type: string + enumDescriptions: + - Unspecified model type. + - Type V1. + - Type V2. + enum: + - MODEL_TYPE_UNSPECIFIED + - TYPE_V1 + - TYPE_V2 + languageCode: + description: Language of the model. + type: string + GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig: + id: GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig + description: Configs for the input data used to create the issue model. type: object - GoogleCloudContactcenterinsightsV1ConversationLevelSentiment: - description: One channel of conversation-level sentiment data. properties: - sentimentData: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData' - description: Data specifying sentiment. - channelTag: - format: int32 - description: The channel of the audio that the data applies to. - type: integer - id: GoogleCloudContactcenterinsightsV1ConversationLevelSentiment + medium: + description: >- + Medium of conversations used in training data. This field is being + deprecated. To specify the medium to be used in training a new issue + model, set the `medium` field on `filter`. + deprecated: true + type: string + enumDescriptions: + - Default value, if unspecified will default to PHONE_CALL. + - The format for conversations that took place over the phone. + - The format for conversations that took place over chat. + enum: + - MEDIUM_UNSPECIFIED + - PHONE_CALL + - CHAT + trainingConversationsCount: + description: Output only. Number of conversations used in training. Output only. + readOnly: true + type: string + format: int64 + filter: + description: >- + A filter to reduce the conversations used for training the model to + a specific subset. Refer to + https://cloud.google.com/contact-center/insights/docs/filtering for + details. + type: string + GoogleCloudContactcenterinsightsV1IssueModelLabelStats: + id: GoogleCloudContactcenterinsightsV1IssueModelLabelStats + description: Aggregated statistics about an issue model. type: object - GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest: properties: - parent: + analyzedConversationsCount: + description: >- + Number of conversations the issue model has analyzed at this point + in time. type: string - description: Required. The parent resource to create analyses in. - annotatorSelector: + format: int64 + unclassifiedConversationsCount: description: >- - To select the annotators to run and the phrase matchers to use (if - any). If not specified, all annotators will be run. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector - analysisPercentage: - type: number - format: float + Number of analyzed conversations for which no issue was applicable + at this point in time. + type: string + format: int64 + issueStats: + description: Statistics on each issue. Key is the issue's resource name. + type: object + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats + GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats: + id: GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats + description: Aggregated statistics about an issue. + type: object + properties: + issue: description: >- - Required. Percentage of selected conversation to analyze, between - [0, 100]. - filter: + Issue resource. Format: + projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue} + type: string + labeledConversationsCount: + description: Number of conversations attached to the issue at this point in time. + type: string + format: int64 + displayName: + description: Display name of the issue. + type: string + GoogleCloudContactcenterinsightsV1ListIssueModelsResponse: + id: GoogleCloudContactcenterinsightsV1ListIssueModelsResponse + description: The response of listing issue models. + type: object + properties: + issueModels: + description: The issue models that match the request. + type: array + items: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel' + GoogleCloudContactcenterinsightsV1DeployIssueModelRequest: + id: GoogleCloudContactcenterinsightsV1DeployIssueModelRequest + description: The request to deploy an issue model. + type: object + properties: + name: + description: Required. The issue model to deploy. + type: string + GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest: + id: GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest + description: The request to undeploy an issue model. + type: object + properties: + name: + description: Required. The issue model to undeploy. + type: string + GoogleCloudContactcenterinsightsV1ExportIssueModelRequest: + id: GoogleCloudContactcenterinsightsV1ExportIssueModelRequest + description: Request to export an issue model. + type: object + properties: + gcsDestination: + description: Google Cloud Storage URI to export the issue model to. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination + name: + description: Required. The issue model to export. + type: string + GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination: + id: GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination + description: Google Cloud Storage Object URI to save the issue model to. + type: object + properties: + objectUri: + description: 'Required. Format: `gs:///`' + type: string + GoogleCloudContactcenterinsightsV1ImportIssueModelRequest: + id: GoogleCloudContactcenterinsightsV1ImportIssueModelRequest + description: Request to import an issue model. + type: object + properties: + gcsSource: + description: Google Cloud Storage source message. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource + parent: + description: Required. The parent resource of the issue model. + type: string + createNewModel: description: >- - Required. Filter used to select the subset of conversations to - analyze. + Optional. If set to true, will create an issue model from the + imported file with randomly generated IDs for the issue model and + corresponding issues. Otherwise, replaces an existing model with the + same ID as the file. + type: boolean + GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource: + id: GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource + description: Google Cloud Storage Object URI to get the issue model file from. + type: object + properties: + objectUri: + description: 'Required. Format: `gs:///`' type: string - id: GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest - description: The request to analyze conversations in bulk. + GoogleCloudContactcenterinsightsV1Issue: + id: GoogleCloudContactcenterinsightsV1Issue + description: The issue resource. type: object - GoogleCloudContactcenterinsightsV1QaScorecardRevision: properties: + name: + description: >- + Immutable. The resource name of the issue. Format: + projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue} + type: string + displayName: + description: The representative name for the issue. + type: string createTime: + description: Output only. The time at which this issue was created. readOnly: true type: string - description: Output only. The timestamp that the revision was created. format: google-datetime - snapshot: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecard' - description: >- - The snapshot of the scorecard at the time of this revision's - creation. - alternateIds: + updateTime: + description: Output only. The most recent time that this issue was updated. + readOnly: true + type: string + format: google-datetime + sampleUtterances: description: >- - Output only. Alternative IDs for this revision of the scorecard, - e.g., `latest`. - type: array + Output only. Resource names of the sample representative utterances + that match to this issue. readOnly: true + type: array items: type: string + displayDescription: + description: Representative description of the issue. + type: string + GoogleCloudContactcenterinsightsV1ListIssuesResponse: + id: GoogleCloudContactcenterinsightsV1ListIssuesResponse + description: The response of listing issues. + type: object + properties: + issues: + description: The issues that match the request. + type: array + items: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Issue' + GoogleCloudContactcenterinsightsV1CalculateIssueModelStatsResponse: + id: GoogleCloudContactcenterinsightsV1CalculateIssueModelStatsResponse + description: Response of querying an issue model's statistics. + type: object + properties: + currentStats: + description: >- + The latest label statistics for the queried issue model. Includes + results on both training data and data labeled after deployment. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelLabelStats + GoogleCloudContactcenterinsightsV1PhraseMatcher: + id: GoogleCloudContactcenterinsightsV1PhraseMatcher + description: The phrase matcher resource. + type: object + properties: name: + description: >- + The resource name of the phrase matcher. Format: + projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} type: string + revisionId: description: >- - Identifier. The name of the scorecard revision. Format: - projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision} - state: + Output only. Immutable. The revision ID of the phrase matcher. A new + revision is committed whenever the matcher is changed, except when + it is activated or deactivated. A server generated random ID will be + used. Example: + locations/global/phraseMatchers/my-first-matcher@1234567 readOnly: true - description: >- - Output only. State of the scorecard revision, indicating whether - it's ready to be used in analysis. - enum: - - STATE_UNSPECIFIED - - EDITABLE - - TRAINING - - TRAINING_FAILED - - READY - - DELETING - - TRAINING_CANCELLED + type: string + versionTag: + description: >- + The customized version tag to use for the phrase matcher. If not + specified, it will default to `revision_id`. + type: string + revisionCreateTime: + description: >- + Output only. The timestamp of when the revision was created. It is + also the create time when a new matcher is added. + readOnly: true + type: string + format: google-datetime + displayName: + description: The human-readable name of the phrase matcher. + type: string + type: + description: Required. The type of this phrase matcher. + type: string enumDescriptions: - Unspecified. - - The scorecard revision can be edited. - - Scorecard model training is in progress. - - Scorecard revision model training failed. - - The revision can be used in analysis. - - Scorecard is being deleted. - - Scorecard model training was explicitly cancelled by the user. - type: string - type: object - id: GoogleCloudContactcenterinsightsV1QaScorecardRevision - description: >- - A revision of a QaScorecard. Modifying published scorecard fields would - invalidate existing scorecard results — the questions may have changed, - or the score weighting will make existing scores impossible to - understand. So changes must create a new revision, rather than modifying - the existing resource. - GoogleIamV1Policy: - id: GoogleIamV1Policy - properties: - bindings: + - Must meet all phrase match rule groups or there is no match. + - If any of the phrase match rule groups are met, there is a match. + enum: + - PHRASE_MATCHER_TYPE_UNSPECIFIED + - ALL_OF + - ANY_OF + active: + description: Applies the phrase matcher only when it is active. + type: boolean + phraseMatchRuleGroups: + description: A list of phase match rule groups that are included in this matcher. + type: array items: - $ref: '#/components/schemas/GoogleIamV1Binding' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroup + activationUpdateTime: description: >- - Associates a list of `members`, or principals, with a `role`. - Optionally, may specify a `condition` that determines how and when - the `bindings` are applied. Each of the `bindings` must contain at - least one principal. The `bindings` in a `Policy` can refer to up to - 1,500 principals; up to 250 of these principals can be Google - groups. Each occurrence of a principal counts towards these limits. - For example, if the `bindings` grant 50 different roles to - `user:alice@example.com`, and not to any other principal, then you - can add another 1,450 principals to the `bindings` in the `Policy`. - type: array - etag: + Output only. The most recent time at which the activation status was + updated. + readOnly: true + type: string + format: google-datetime + roleMatch: 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 + The role whose utterances the phrase matcher should be matched + against. If the role is ROLE_UNSPECIFIED it will be matched against + any utterances in the transcript. type: string - auditConfigs: - items: - $ref: '#/components/schemas/GoogleIamV1AuditConfig' - description: Specifies cloud audit logging configuration for this policy. - type: array - version: - format: int32 - type: integer + enumDescriptions: + - Participant's role is not set. + - Participant is a human agent. + - Participant is an automated agent. + - Participant is an end user who conversed with the contact center. + - Participant is either a human or automated agent. + enum: + - ROLE_UNSPECIFIED + - HUMAN_AGENT + - AUTOMATED_AGENT + - END_USER + - ANY_AGENT + updateTime: 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). + Output only. The most recent time at which the phrase matcher was + updated. + readOnly: true + type: string + format: google-datetime + GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroup: + id: GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroup + description: A message representing a rule in the phrase matcher. type: object - description: >- - An Identity and Access Management (IAM) policy, which specifies access - controls for Google Cloud resources. A `Policy` is a collection of - `bindings`. A `binding` binds one or more `members`, or principals, to a - single `role`. Principals can be user accounts, service accounts, Google - groups, and domains (such as G Suite). A `role` is a named list of - permissions; each `role` can be an IAM predefined role or a user-created - custom role. For some types of Google Cloud resources, a `binding` can - also specify a `condition`, which is a logical expression that allows - access to a resource only if the expression evaluates to `true`. A - condition can add constraints based on attributes of the request, the - resource, or both. To learn which resources support conditions in their - IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - **JSON example:** ``` { "bindings": [ { "role": - "roles/resourcemanager.organizationAdmin", "members": [ - "user:mike@example.com", "group:admins@example.com", - "domain:google.com", - "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { - "role": "roles/resourcemanager.organizationViewer", "members": [ - "user:eve@example.com" ], "condition": { "title": "expirable access", - "description": "Does not grant access after Sep 2020", "expression": - "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": - "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - - members: - user:mike@example.com - group:admins@example.com - - domain:google.com - - serviceAccount:my-project-id@appspot.gserviceaccount.com role: - roles/resourcemanager.organizationAdmin - members: - - user:eve@example.com role: roles/resourcemanager.organizationViewer - condition: title: expirable access description: Does not grant access - after Sep 2020 expression: request.time < - timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` - For a description of IAM and its features, see the [IAM - documentation](https://cloud.google.com/iam/docs/). - GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata: properties: - sentiments: - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment - type: array - description: Overall conversation-level sentiment for each channel of the call. - issueModelResult: - description: Overall conversation-level issue modeling result. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelResult - qaScorecardResults: - description: Results of scoring QaScorecards. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaScorecardResult - entities: - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Entity - description: All the entities in the call. - type: object - silence: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence - description: Overall conversation-level silence during the call. - intents: - description: All the matched intents in the call. - type: object - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Intent - phraseMatchers: - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData - type: object - description: All the matched phrase matchers in the call. - annotations: + type: + description: Required. The type of this phrase match rule group. + type: string + enumDescriptions: + - Unspecified. + - Must meet all phrase match rules or there is no match. + - If any of the phrase match rules are met, there is a match. + enum: + - PHRASE_MATCH_RULE_GROUP_TYPE_UNSPECIFIED + - ALL_OF + - ANY_OF + phraseMatchRules: + description: A list of phrase match rules that are included in this group. type: array - description: A list of call annotations that apply to this call. items: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1CallAnnotation - id: >- - GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata - description: Call-specific metadata created during analysis. - type: object - GoogleCloudContactcenterinsightsV1ConversationTranscript: + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchRule + GoogleCloudContactcenterinsightsV1PhraseMatchRule: + id: GoogleCloudContactcenterinsightsV1PhraseMatchRule + description: The data for a phrase match rule. type: object - id: GoogleCloudContactcenterinsightsV1ConversationTranscript - description: A message representing the transcript of a conversation. properties: - transcriptSegments: - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment + query: + description: Required. The phrase to be matched. + type: string + negated: description: >- - A list of sequential transcript segments that comprise the - conversation. - type: array - GoogleCloudContactcenterinsightsV1alpha1GcsSource: - properties: - audioUri: - description: >- - Cloud Storage URI that points to a file that contains the - conversation audio. - type: string - transcriptUri: - type: string + Specifies whether the phrase must be missing from the transcript + segment or present in the transcript segment. + type: boolean + config: description: >- - Immutable. Cloud Storage URI that points to a file that contains the - conversation transcript. - id: GoogleCloudContactcenterinsightsV1alpha1GcsSource - description: A Cloud Storage source of conversation data. + Provides additional information about the rule that specifies how to + apply the rule. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchRuleConfig + GoogleCloudContactcenterinsightsV1PhraseMatchRuleConfig: + id: GoogleCloudContactcenterinsightsV1PhraseMatchRuleConfig + description: Configuration information of a phrase match rule. type: object - GoogleCloudContactcenterinsightsV1alpha1SpeechConfig: - id: GoogleCloudContactcenterinsightsV1alpha1SpeechConfig - description: >- - Speech-to-Text configuration. Speech-to-Text settings are applied to - conversations ingested from the `UploadConversation` and - `IngestConversations` endpoints, including conversation coming from CCAI - Platform. They are not applied to conversations ingested from the - `CreateConversation` endpoint. + properties: + exactMatchConfig: + description: The configuration for the exact match rule. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ExactMatchConfig + GoogleCloudContactcenterinsightsV1ExactMatchConfig: + id: GoogleCloudContactcenterinsightsV1ExactMatchConfig + description: Exact match configuration. type: object properties: - speechRecognizer: + caseSensitive: + description: Whether to consider case sensitivity when performing an exact match. + type: boolean + GoogleCloudContactcenterinsightsV1ListPhraseMatchersResponse: + id: GoogleCloudContactcenterinsightsV1ListPhraseMatchersResponse + description: The response of listing phrase matchers. + type: object + properties: + phraseMatchers: + description: The phrase matchers that match the request. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher + nextPageToken: description: >- - The fully-qualified Speech Recognizer resource name. Format: - `projects/{project_id}/locations/{location}/recognizer/{recognizer}` + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. type: string - GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfig: - properties: - scorecardList: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfigScorecardList - description: A manual list of scorecards to score. + GoogleCloudContactcenterinsightsV1CalculateStatsResponse: + id: GoogleCloudContactcenterinsightsV1CalculateStatsResponse + description: The response for calculating conversation statistics. type: object - id: GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfig - description: Configuration for the QA feature. - GoogleCloudContactcenterinsightsV1alpha1CallAnnotation: - id: GoogleCloudContactcenterinsightsV1alpha1CallAnnotation - description: A piece of metadata that applies to a window of a call. properties: - entityMentionData: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1EntityMentionData - description: Data specifying an entity mention. - holdData: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1HoldData - description: Data specifying a hold. - annotationEndBoundary: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary - description: >- - The boundary in the conversation where the annotation ends, - inclusive. - intentMatchData: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IntentMatchData - description: Data specifying an intent match. - annotationStartBoundary: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary - description: >- - The boundary in the conversation where the annotation starts, - inclusive. - phraseMatchData: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData - description: Data specifying a phrase match. - issueMatchData: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueMatchData - description: Data specifying an issue match. - interruptionData: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1InterruptionData - description: Data specifying an interruption. - channelTag: + averageDuration: description: >- - The channel of the audio where the annotation occurs. For - single-channel audio, this field is not populated. + The average duration of all conversations. The average is calculated + using only conversations that have a time duration. + type: string + format: google-duration + averageTurnCount: + description: The average number of turns per conversation. type: integer format: int32 - sentimentData: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData - description: Data specifying sentiment. - silenceData: + conversationCount: + description: The total number of conversations. + type: integer + format: int32 + smartHighlighterMatches: + description: >- + A map associating each smart highlighter display name with its + respective number of matches in the set of conversations. + type: object + additionalProperties: + type: integer + format: int32 + customHighlighterMatches: + description: >- + A map associating each custom highlighter resource name with its + respective number of matches in the set of conversations. + type: object + additionalProperties: + type: integer + format: int32 + issueMatches: + description: >- + A map associating each issue resource name with its respective + number of matches in the set of conversations. Key has the format: + `projects//locations//issueModels//issues/` Deprecated, use + `issue_matches_stats` field instead. + deprecated: true + type: object + additionalProperties: + type: integer + format: int32 + issueMatchesStats: + description: >- + A map associating each issue resource name with its respective + number of matches in the set of conversations. Key has the format: + `projects//locations//issueModels//issues/` + type: object + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats + conversationCountTimeSeries: + description: >- + A time series representing the count of conversations created over + time that match that requested filter criteria. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SilenceData - description: Data specifying silence. - type: object - GoogleCloudContactcenterinsightsV1ExportInsightsDataResponse: - description: Response for an export insights operation. - type: object - id: GoogleCloudContactcenterinsightsV1ExportInsightsDataResponse - properties: {} - GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData: - id: GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData + #/components/schemas/GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeries + GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeries: + id: GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeries + description: A time series representing conversations over time. type: object properties: - suggestion: + intervalDuration: + description: The duration of each interval. type: string - description: The content of the suggestion. - metadata: - additionalProperties: - type: string + format: google-duration + points: description: >- - Map that contains metadata about the Smart Compose suggestion and - the document from which it originates. - type: object - queryRecord: + An ordered list of intervals from earliest to latest, where each + interval represents the number of conversations that transpired + during the time window. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeriesInterval + GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeriesInterval: + id: >- + GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeriesInterval + description: A single interval in a time series. + type: object + properties: + startTime: + description: The start time of this interval. type: string + format: google-datetime + conversationCount: + description: The number of conversations created in this interval. + type: integer + format: int32 + GoogleCloudContactcenterinsightsV1CalculateStatsRequest: + id: GoogleCloudContactcenterinsightsV1CalculateStatsRequest + description: The request for calculating conversation statistics. + type: object + properties: + filter: description: >- - The name of the answer record. Format: - projects/{project}/locations/{location}/answerRecords/{answer_record} - confidenceScore: - type: number - description: >- - The system's confidence score that this suggestion is a good match - for this conversation, ranging from 0.0 (completely uncertain) to - 1.0 (completely certain). - format: double - description: Agent Assist Smart Compose suggestion data. + A filter to reduce results to a specific subset. This field is + useful for getting statistics about conversations with specific + properties. + type: string GoogleCloudContactcenterinsightsV1Settings: + id: GoogleCloudContactcenterinsightsV1Settings + description: >- + The CCAI Insights project wide settings. Use these settings to configure + the behavior of Insights. View these settings with + [`getsettings`](https://cloud.google.com/contact-center/insights/docs/reference/rest/v1/projects.locations/getSettings) + and change the settings with + [`updateSettings`](https://cloud.google.com/contact-center/insights/docs/reference/rest/v1/projects.locations/updateSettings). + type: object properties: name: description: >- @@ -2803,33 +2706,31 @@ components: projects/{project}/locations/{location}/settings type: string createTime: - readOnly: true description: Output only. The time at which the settings was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. The time at which the settings were last updated. + readOnly: true + type: string format: google-datetime + languageCode: + description: >- + A language code to be applied to each transcript segment unless the + segment already specifies a language code. Language code defaults to + "en-US" if it is neither specified on the segment nor here. type: string - analysisConfig: - description: Default analysis settings. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1SettingsAnalysisConfig conversationTtl: - type: string description: >- The default TTL for newly-created conversations. If a conversation has a specified expiration, that value will be used instead. Changing this value will not change the expiration of existing conversations. Conversations with no expire time persist until they are deleted. + type: string format: google-duration - speechConfig: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SpeechConfig' - description: >- - Optional. Default Speech-to-Text resources to use while ingesting - audio files. Optional, CCAI Insights will create a default if not - provided. This applies to conversations ingested from the - `UploadConversation` and `IngestConversations` endpoints, including - conversations coming from CCAI Platform. pubsubNotificationSettings: - type: object description: >- A map that maps a notification trigger to a Pub/Sub topic. Each time a specified trigger occurs, Insights will notify the corresponding @@ -2844,13 +2745,13 @@ components: "upload-conversation": Notify when an UploadConversation LRO is complete. Values are Pub/Sub topics. The format of each Pub/Sub topic is: projects/{project}/topics/{topic} + type: object additionalProperties: type: string - updateTime: - format: google-datetime - type: string - description: Output only. The time at which the settings were last updated. - readOnly: true + analysisConfig: + description: Default analysis settings. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1SettingsAnalysisConfig redactionConfig: description: >- Default DLP redaction resources to be applied while ingesting @@ -2859,765 +2760,933 @@ components: conversations coming from CCAI Platform. $ref: >- #/components/schemas/GoogleCloudContactcenterinsightsV1RedactionConfig - languageCode: - type: string + speechConfig: description: >- - A language code to be applied to each transcript segment unless the - segment already specifies a language code. Language code defaults to - "en-US" if it is neither specified on the segment nor here. + Optional. Default Speech-to-Text resources to use while ingesting + audio files. Optional, CCAI Insights will create a default if not + provided. This applies to conversations ingested from the + `UploadConversation` and `IngestConversations` endpoints, including + conversations coming from CCAI Platform. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SpeechConfig' + GoogleCloudContactcenterinsightsV1SettingsAnalysisConfig: + id: GoogleCloudContactcenterinsightsV1SettingsAnalysisConfig + description: Default configuration when creating Analyses in Insights. type: object - id: GoogleCloudContactcenterinsightsV1Settings - description: >- - The CCAI Insights project wide settings. Use these settings to configure - the behavior of Insights. View these settings with - [`getsettings`](https://cloud.google.com/contact-center/insights/docs/reference/rest/v1/projects.locations/getSettings) - and change the settings with - [`updateSettings`](https://cloud.google.com/contact-center/insights/docs/reference/rest/v1/projects.locations/updateSettings). - GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData: - description: Agent Assist Article Suggestion data. properties: - confidenceScore: - format: float + runtimeIntegrationAnalysisPercentage: + description: >- + Percentage of conversations created using Dialogflow runtime + integration to analyze automatically, between [0, 100]. type: number + format: double + uploadConversationAnalysisPercentage: description: >- - The system's confidence score that this article is a good match for - this conversation, ranging from 0.0 (completely uncertain) to 1.0 - (completely certain). - source: + Percentage of conversations created using the UploadConversation + endpoint to analyze automatically, between [0, 100]. + type: number + format: double + annotatorSelector: description: >- - The knowledge document that this answer was extracted from. Format: - projects/{project}/knowledgeBases/{knowledge_base}/documents/{document} + To select the annotators to run and the phrase matchers to use (if + any). If not specified, all annotators will be run. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelector + GoogleCloudContactcenterinsightsV1AnalysisRule: + id: GoogleCloudContactcenterinsightsV1AnalysisRule + description: >- + The CCAI Insights project wide analysis rule. This rule will be applied + to all conversations that match the filter defined in the rule. For a + conversation matches the filter, the annotators specified in the rule + will be run. If a conversation matches multiple rules, a union of all + the annotators will be run. One project can have multiple analysis + rules. + type: object + properties: + name: + description: >- + Identifier. The resource name of the analysis rule. Format: + projects/{project}/locations/{location}/analysisRules/{analysis_rule} type: string - queryRecord: + createTime: + description: Output only. The time at which this analysis rule was created. + readOnly: true type: string + format: google-datetime + updateTime: description: >- - The name of the answer record. Format: - projects/{project}/locations/{location}/answerRecords/{answer_record} - metadata: - additionalProperties: - type: string - type: object - description: >- - Map that contains metadata about the Article Suggestion and the - document that it originates from. - title: + Output only. The most recent time at which this analysis rule was + updated. + readOnly: true type: string - description: Article title. - uri: + format: google-datetime + displayName: + description: Display Name of the analysis rule. type: string - description: Article URI. - type: object - id: GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData - GoogleCloudContactcenterinsightsV1alpha1Entity: - properties: - metadata: - type: object + conversationFilter: description: >- - Metadata associated with the entity. For most entity types, the - metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph - MID (`mid`), if they are available. For the metadata associated with - other entity types, see the Type table below. - additionalProperties: - type: string - type: - description: The entity type. - enumDescriptions: - - Unspecified. - - Person. - - Location. - - Organization. - - Event. - - Artwork. - - Consumer product. - - Other types of entities. - - >- - Phone number. The metadata lists the phone number (formatted - according to local convention), plus whichever additional elements - appear in the text: * `number` - The actual number, broken down - into sections according to local convention. * `national_prefix` - - Country code, if detected. * `area_code` - Region or area code, if - detected. * `extension` - Phone extension (to be dialed after - connection), if detected. - - >- - Address. The metadata identifies the street number and locality - plus whichever additional elements appear in the text: * - `street_number` - Street number. * `locality` - City or town. * - `street_name` - Street/route name, if detected. * `postal_code` - - Postal code, if detected. * `country` - Country, if detected. * - `broad_region` - Administrative area, such as the state, if - detected. * `narrow_region` - Smaller administrative area, such as - county, if detected. * `sublocality` - Used in Asian addresses to - demark a district within a city, if detected. - - >- - Date. The metadata identifies the components of the date: * `year` - - Four digit year, if detected. * `month` - Two digit month - number, if detected. * `day` - Two digit day number, if detected. - - Number. The metadata is the number itself. - - Price. The metadata identifies the `value` and `currency`. + Filter for the conversations that should apply this analysis rule. + An empty filter means this analysis rule applies to all + conversations. Refer to + https://cloud.google.com/contact-center/insights/docs/filtering for + details. type: string - enum: - - TYPE_UNSPECIFIED - - PERSON - - LOCATION - - ORGANIZATION - - EVENT - - WORK_OF_ART - - CONSUMER_GOOD - - OTHER - - PHONE_NUMBER - - ADDRESS - - DATE - - NUMBER - - PRICE - sentiment: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData + annotatorSelector: description: >- - The aggregate sentiment expressed for this entity in the - conversation. - salience: + Selector of annotators to run and the phrase matchers to use for + conversations that matches the conversation_filter. If not + specified, NO annotators will be run. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelector + analysisPercentage: description: >- - The salience score associated with the entity in the [0, 1.0] range. - The salience score for an entity provides information about the - importance or centrality of that entity to the entire document text. - Scores closer to 0 are less salient, while scores closer to 1.0 are - highly salient. + Percentage of conversations that we should apply this analysis + setting automatically, between [0, 1]. For example, 0.1 means 10%. + Conversations are sampled in a determenestic way. The original + runtime_percentage & upload percentage will be replaced by defining + filters on the conversation. type: number - format: float - displayName: - description: The representative name for the entity. + format: double + active: + description: >- + If true, apply this rule to conversations. Otherwise, this rule is + inactive and saved as a draft. + type: boolean + GoogleCloudContactcenterinsightsV1ListAnalysisRulesResponse: + id: GoogleCloudContactcenterinsightsV1ListAnalysisRulesResponse + description: The response of listing views. + type: object + properties: + analysisRules: + description: The analysis_rule that match the request. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AnalysisRule + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. type: string + GoogleCloudContactcenterinsightsV1AssessmentRule: + id: GoogleCloudContactcenterinsightsV1AssessmentRule description: >- - The data for an entity annotation. Represents a phrase in the - conversation that is a known entity, such as a person, an organization, - or location. - id: GoogleCloudContactcenterinsightsV1alpha1Entity + The CCAI Insights project wide assessment rule. This assessment rule + will be applied to all conversations from the previous sampling cycle + that match the sample rule defined in the assessment rule. One project + can have multiple assessment rules. type: object - GoogleCloudContactcenterinsightsV1QaScorecard: properties: + name: + description: >- + Identifier. The resource name of the assessment rule. Format: + projects/{project}/locations/{location}/assessmentRules/{assessment_rule} + type: string createTime: + description: Output only. The time at which this assessment rule was created. + readOnly: true type: string - description: Output only. The time at which this scorecard was created. + format: google-datetime + updateTime: + description: >- + Output only. The most recent time at which this assessment rule was + updated. readOnly: true + type: string format: google-datetime + active: + description: >- + If true, apply this rule to conversations. Otherwise, this rule is + inactive. + type: boolean displayName: + description: Display Name of the assessment rule. + type: string + sampleRule: + description: The sample rule for the assessment rule. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SampleRule' + scheduleInfo: + description: Schedule info for the assessment rule. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1ScheduleInfo' + GoogleCloudContactcenterinsightsV1ScheduleInfo: + id: GoogleCloudContactcenterinsightsV1ScheduleInfo + description: Message for schedule info. + type: object + properties: + startTime: + description: >- + Start time of the schedule. If not specified, will start as soon as + the schedule is created. type: string - description: The user-specified display name of the scorecard. - updateTime: format: google-datetime + endTime: description: >- - Output only. The most recent time at which the scorecard was - updated. - readOnly: true + End time of the schedule. If not specified, will keep scheduling new + pipelines for execution util the schedule is no longer active or + deleted. type: string - name: + format: google-datetime + schedule: + description: >- + The groc expression. Format: `every number [synchronized]` Time + units can be: minutes, hours Synchronized is optional and indicates + that the schedule should be synchronized to the start of the + interval: every 5 minutes synchronized means 00:00, 00:05 ... + Otherwise the start time is random within the interval. Example: + `every 5 minutes` could be 00:02, 00:07, 00:12, ... type: string + timeZone: description: >- - Identifier. The scorecard name. Format: - projects/{project}/locations/{location}/qaScorecards/{qa_scorecard} - description: - description: A text description explaining the intent of the scorecard. + The timezone to use for the groc expression. If not specified, + defaults to UTC. type: string - id: GoogleCloudContactcenterinsightsV1QaScorecard - description: >- - A QaScorecard represents a collection of questions to be scored during - analysis. + GoogleCloudContactcenterinsightsV1ListAssessmentRulesResponse: + id: GoogleCloudContactcenterinsightsV1ListAssessmentRulesResponse + description: The response of listing assessment rules. type: object - GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource: properties: - objectUri: + assessmentRules: + description: The assessment rules that match the request. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AssessmentRule + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. type: string - description: 'Required. Format: `gs:///`' + GoogleCloudContactcenterinsightsV1EncryptionSpec: + id: GoogleCloudContactcenterinsightsV1EncryptionSpec + description: >- + A customer-managed encryption key specification that can be applied to + all created resources (e.g. `Conversation`). type: object - description: Google Cloud Storage Object URI to get the issue model file from. - id: GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource - GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig: - id: GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig properties: - medium: - type: string - enumDescriptions: - - Default value, if unspecified will default to PHONE_CALL. - - The format for conversations that took place over the phone. - - The format for conversations that took place over chat. - description: >- - Medium of conversations used in training data. This field is being - deprecated. To specify the medium to be used in training a new issue - model, set the `medium` field on `filter`. - deprecated: true - enum: - - MEDIUM_UNSPECIFIED - - PHONE_CALL - - CHAT - filter: + name: description: >- - A filter to reduce the conversations used for training the model to - a specific subset. + Immutable. The resource name of the encryption key specification + resource. Format: + projects/{project}/locations/{location}/encryptionSpec type: string - trainingConversationsCount: - format: int64 + kmsKey: + description: >- + Required. The name of customer-managed encryption key that is used + to secure a resource and its sub-resources. If empty, the resource + is secured by our default encryption key. Only the key in the same + location as this resource is allowed to be used for encryption. + Format: + `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}` type: string - description: Output only. Number of conversations used in training. Output only. - readOnly: true - type: object - description: Configs for the input data used to create the issue model. - GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsMetadata: - id: GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsMetadata - description: The metadata for a bulk delete conversations operation. + GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest: + id: GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest + description: The request to initialize a location-level encryption specification. type: object properties: - endTime: - description: The time the operation finished running. - format: google-datetime - type: string - request: - description: The original request for bulk delete. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest - createTime: - format: google-datetime - type: string - description: The time the operation was created. - partialErrors: - items: - $ref: '#/components/schemas/GoogleRpcStatus' - type: array + encryptionSpec: description: >- - Partial errors during bulk delete conversations operation that might - cause the operation output to be incomplete. - GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo: + Required. The encryption spec used for CMEK encryption. It is + required that the kms key is in the same region as the endpoint. The + same key will be used for all provisioned resources, if encryption + is available. If the `kms_key_name` field is left empty, no + encryption will be enforced. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1EncryptionSpec + GoogleCloudContactcenterinsightsV1View: + id: GoogleCloudContactcenterinsightsV1View + description: The View resource. + type: object properties: - confidence: - type: number - format: float - description: >- - A confidence estimate between 0.0 and 1.0 of the fidelity of this - word. A default value of 0.0 indicates that the value is unset. - endOffset: + name: description: >- - Time offset of the end of this word relative to the beginning of the - total conversation. + Immutable. The resource name of the view. Format: + projects/{project}/locations/{location}/views/{view} type: string - format: google-duration - startOffset: + displayName: + description: The human-readable display name of the view. + type: string + createTime: + description: Output only. The time at which this view was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. The most recent time at which the view was updated. + readOnly: true type: string + format: google-datetime + value: description: >- - Time offset of the start of this word relative to the beginning of - the total conversation. - format: google-duration - word: + A filter to reduce conversation results to a specific subset. Refer + to https://cloud.google.com/contact-center/insights/docs/filtering + for details. type: string - description: The word itself. Includes punctuation marks that surround the word. - id: >- - GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo - description: Word-level info for words in a transcript. - type: object - GoogleCloudContactcenterinsightsV1IssueModelLabelStats: + GoogleCloudContactcenterinsightsV1ListViewsResponse: + id: GoogleCloudContactcenterinsightsV1ListViewsResponse + description: The response of listing views. type: object - description: Aggregated statistics about an issue model. properties: - unclassifiedConversationsCount: - description: >- - Number of analyzed conversations for which no issue was applicable - at this point in time. - type: string - format: int64 - analyzedConversationsCount: - format: int64 + views: + description: The views that match the request. + type: array + items: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' + nextPageToken: description: >- - Number of conversations the issue model has analyzed at this point - in time. + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. type: string - issueStats: - description: Statistics on each issue. Key is the issue's resource name. - type: object - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats - id: GoogleCloudContactcenterinsightsV1IssueModelLabelStats - GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelResponse: + GoogleCloudContactcenterinsightsV1QueryMetricsRequest: + id: GoogleCloudContactcenterinsightsV1QueryMetricsRequest + description: The request for querying metrics. type: object - id: GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelResponse - properties: {} - description: The response to undeploy an issue model. - GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination: properties: - table: - type: string + filter: description: >- - The BigQuery table name to which the insights data should be - written. If this table does not exist, the export call returns an - INVALID_ARGUMENT error. - dataset: + Required. Filter to select a subset of conversations to compute the + metrics. Must specify a window of the conversation create time to + compute the metrics. The returned metrics will be from the range + [DATE(starting create time), DATE(ending create time)). type: string + timeGranularity: description: >- - Required. The name of the BigQuery dataset that the snapshot result - should be exported to. If this dataset does not exist, the export - call returns an INVALID_ARGUMENT error. - projectId: - description: >- - A project ID or number. If specified, then export will attempt to - write data to this project instead of the resource project. - Otherwise, the resource project will be used. + The time granularity of each data point in the time series. Defaults + to NONE if this field is unspecified. type: string - type: object - description: A BigQuery Table Reference. - id: >- - GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination - GoogleCloudContactcenterinsightsV1IssueAssignment: - properties: - score: + enumDescriptions: + - The time granularity is unspecified and will default to NONE. + - >- + No time granularity. The response won't contain a time series. + This is the default value if no time granularity is specified. + - >- + Data points in the time series will aggregate at a daily + granularity. 1 day means [midnight to midnight). + - >- + Data points in the time series will aggregate at a daily + granularity. 1 HOUR means [01:00 to 02:00). + - >- + Data points in the time series will aggregate at a daily + granularity. PER_MINUTE means [01:00 to 01:01). + - >- + Data points in the time series will aggregate at a 1 minute + granularity. PER_5_MINUTES means [01:00 to 01:05). + - >- + Data points in the time series will aggregate at a monthly + granularity. 1 MONTH means [01st of the month to 1st of the next + month). + enum: + - TIME_GRANULARITY_UNSPECIFIED + - NONE + - DAILY + - HOURLY + - PER_MINUTE + - PER_5_MINUTES + - MONTHLY + dimensions: description: >- - Score indicating the likelihood of the issue assignment. currently - bounded on [0,1]. - type: number - format: double - displayName: - type: string + The dimensions that determine the grouping key for the query. + Defaults to no dimension if this field is unspecified. If a + dimension is specified, its key must also be specified. Each + dimension's key must be unique. If a time granularity is also + specified, metric values in the dimension will be bucketed by this + granularity. Up to one dimension is supported for now. + type: array + items: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Dimension' + measureMask: description: >- - Immutable. Display name of the assigned issue. This field is set at - time of analyis and immutable since then. - issue: - description: Resource name of the assigned issue. + Measures to return. Defaults to all measures if this field is + unspecified. A valid mask should traverse from the `measure` field + from the response. For example, a path from a measure mask to get + the conversation count is "conversation_measure.count". type: string - id: GoogleCloudContactcenterinsightsV1IssueAssignment - description: Information about the issue. - type: object - GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence: + format: google-fieldmask + GoogleCloudContactcenterinsightsV1Dimension: + id: GoogleCloudContactcenterinsightsV1Dimension + description: >- + A dimension determines the grouping key for the query. In SQL terms, + these would be part of both the "SELECT" and "GROUP BY" clauses. type: object properties: - silenceDuration: - format: google-duration - type: string - description: Amount of time calculated to be in silence. - silencePercentage: - type: number - description: Percentage of the total conversation spent in silence. - format: float - id: GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence - description: Conversation-level silence data. - GoogleIamV1Binding: + issueDimensionMetadata: + description: Output only. Metadata about the issue dimension. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1DimensionIssueDimensionMetadata + agentDimensionMetadata: + description: Output only. Metadata about the agent dimension. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1DimensionAgentDimensionMetadata + qaQuestionDimensionMetadata: + description: Output only. Metadata about the QA question dimension. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1DimensionQaQuestionDimensionMetadata + qaQuestionAnswerDimensionMetadata: + description: Output only. Metadata about the QA question-answer dimension. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1DimensionQaQuestionAnswerDimensionMetadata + dimensionKey: + description: The key of the dimension. + type: string + enumDescriptions: + - The key of the dimension is unspecified. + - The dimension is keyed by issues. + - The dimension is keyed by issue names. + - The dimension is keyed by agents. + - The dimension is keyed by agent teams. + - >- + The dimension is keyed by QaQuestionIds. Note that: We only group + by the QuestionId and not the revision-id of the scorecard this + question is a part of. This allows for showing stats for the same + question across different scorecard revisions. + - >- + The dimension is keyed by QaQuestionIds-Answer value pairs. Note + that: We only group by the QuestionId and not the revision-id of + the scorecard this question is a part of. This allows for showing + distribution of answers per question across different scorecard + revisions. + - >- + The dimension is keyed by QaScorecardIds. Note that: We only group + by the ScorecardId and not the revision-id of the scorecard. This + allows for showing stats for the same scorecard across different + revisions. This metric is mostly only useful if querying the + average normalized score per scorecard. + - The dimension is keyed by the conversation profile ID. + - The dimension is keyed by the conversation medium. + enum: + - DIMENSION_KEY_UNSPECIFIED + - ISSUE + - ISSUE_NAME + - AGENT + - AGENT_TEAM + - QA_QUESTION_ID + - QA_QUESTION_ANSWER_VALUE + - QA_SCORECARD_ID + - CONVERSATION_PROFILE_ID + - MEDIUM + GoogleCloudContactcenterinsightsV1DimensionIssueDimensionMetadata: + id: GoogleCloudContactcenterinsightsV1DimensionIssueDimensionMetadata + description: Metadata about the issue dimension. + type: object properties: - role: + issueId: + description: The issue ID. type: string - description: >- - Role that is assigned to the list of `members`, or principals. For - example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an - overview of the IAM roles and permissions, see the [IAM - documentation](https://cloud.google.com/iam/docs/roles-overview). - For a list of the available pre-defined roles, see - [here](https://cloud.google.com/iam/docs/understanding-roles). - members: - items: - type: string - type: array - description: >- - Specifies the principals requesting access for a Google Cloud - 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. Does not include identities - that come from external identity providers (IdPs) through identity - federation. * `user:{emailid}`: An email address that represents a - specific Google account. For example, `alice@example.com` . * - `serviceAccount:{emailid}`: An email address that represents a - Google service account. For example, - `my-other-app@appspot.gserviceaccount.com`. * - `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: - An identifier for a [Kubernetes service - account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). - For example, - `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * - `group:{emailid}`: An email address that represents a Google group. - For example, `admins@example.com`. * `domain:{domain}`: The G Suite - domain (primary) that represents all the users of that domain. For - example, `google.com` or `example.com`. * - `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workforce identity pool. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: - All workforce identities in a group. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All workforce identities with a specific attribute value. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: - All identities in a workforce identity pool. * - `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workload identity pool. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: - A workload identity pool group. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All identities in a workload identity pool with a certain attribute. - * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: - All identities in a workload identity pool. * - `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. * - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - Deleted single identity in a workforce identity pool. For example, - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. - condition: - $ref: '#/components/schemas/GoogleTypeExpr' - description: >- - The condition that is associated with this binding. If the condition - evaluates to `true`, then this binding applies to the current - request. If the condition evaluates to `false`, then this binding - does not apply to the current request. However, a different role - binding might grant the same role to one or more of the principals - in this binding. To learn which resources support conditions in - their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - id: GoogleIamV1Binding - description: Associates `members`, or principals, with a `role`. + issueDisplayName: + description: The issue display name. + type: string + issueModelId: + description: The parent issue model ID. + type: string + GoogleCloudContactcenterinsightsV1DimensionAgentDimensionMetadata: + id: GoogleCloudContactcenterinsightsV1DimensionAgentDimensionMetadata + description: Metadata about the agent dimension. type: object - GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest: properties: - encryptionSpec: - description: >- - Required. The encryption spec used for CMEK encryption. It is - required that the kms key is in the same region as the endpoint. The - same key will be used for all provisioned resources, if encryption - is available. If the `kms_key_name` field is left empty, no - encryption will be enforced. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec + agentId: + description: Optional. A user-specified string representing the agent. + type: string + agentDisplayName: + description: Optional. The agent's name + type: string + agentTeam: + description: Optional. A user-specified string representing the agent's team. + type: string + GoogleCloudContactcenterinsightsV1DimensionQaQuestionDimensionMetadata: + id: GoogleCloudContactcenterinsightsV1DimensionQaQuestionDimensionMetadata + description: Metadata about the QA question dimension. type: object - id: GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest - description: The request to initialize a location-level encryption specification. - GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata: properties: - customerChannel: - format: int32 - description: The audio channel that contains the customer. - type: integer - agentChannel: - description: The audio channel that contains the agent. - format: int32 - type: integer - description: Call-specific metadata. - id: GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata + qaScorecardId: + description: Optional. The QA scorecard ID. + type: string + qaQuestionId: + description: Optional. The QA question ID. + type: string + questionBody: + description: Optional. The full body of the question. + type: string + GoogleCloudContactcenterinsightsV1DimensionQaQuestionAnswerDimensionMetadata: + id: >- + GoogleCloudContactcenterinsightsV1DimensionQaQuestionAnswerDimensionMetadata + description: >- + Metadata about the QA question-answer dimension. This is useful for + showing the answer distribution for questions for a given scorecard. type: object - GoogleCloudContactcenterinsightsV1SpeechConfig: + properties: + qaScorecardId: + description: Optional. The QA scorecard ID. + type: string + qaQuestionId: + description: Optional. The QA question ID. + type: string + questionBody: + description: Optional. The full body of the question. + type: string + answerValue: + description: Optional. The full body of the question. + type: string + GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewRequest: + id: GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewRequest description: >- - Speech-to-Text configuration. Speech-to-Text settings are applied to - conversations ingested from the `UploadConversation` and - `IngestConversations` endpoints, including conversation coming from CCAI - Platform. They are not applied to conversations ingested from the - `CreateConversation` endpoint. + The request for summarizing performance according to different metrics + for conversations over a specified time window. + type: object properties: - speechRecognizer: + agentPerformanceSource: + description: Conversations are from a single agent. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewRequestAgentSource + filter: description: >- - The fully-qualified Speech Recognizer resource name. Format: - `projects/{project_id}/locations/{location}/recognizer/{recognizer}` + Optional. Filter to select a subset of conversations to compute the + performance overview. Supports the same filters as the filter field + in QueryMetricsRequest. The source and query interval/comparison + query interval should not be included here. type: string - id: GoogleCloudContactcenterinsightsV1SpeechConfig - type: object - GoogleCloudContactcenterinsightsV1DeployIssueModelRequest: - id: GoogleCloudContactcenterinsightsV1DeployIssueModelRequest + queryInterval: + description: >- + Required. The time window of the conversations to derive performance + stats from. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1QueryInterval' + comparisonQueryInterval: + description: The time window of the conversations to compare the performance to. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1QueryInterval' + GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewRequestAgentSource: + id: >- + GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewRequestAgentSource + description: The entity whose performance is being queried is a single agent. type: object properties: - name: + agentId: + description: Required. Agent id to query performance overview for. type: string - description: Required. The issue model to deploy. - description: The request to deploy an issue model. - GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecMetadata: + GoogleCloudContactcenterinsightsV1QueryInterval: + id: GoogleCloudContactcenterinsightsV1QueryInterval + description: A time window for querying conversations. + type: object properties: - request: - description: Output only. The original request for initialization. - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest - partialErrors: - items: - $ref: '#/components/schemas/GoogleRpcStatus' - type: array - description: >- - Partial errors during initializing operation that might cause the - operation output to be incomplete. - createTime: + startTime: + description: Required. The start time of the time window. type: string - readOnly: true format: google-datetime - description: Output only. The time the operation was created. endTime: - description: Output only. The time the operation finished running. - format: google-datetime - readOnly: true + description: Required. The end time of the time window. type: string - description: Metadata for initializing a location-level encryption specification. - id: GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecMetadata + format: google-datetime + GoogleCloudContactcenterinsightsV1QaQuestion: + id: GoogleCloudContactcenterinsightsV1QaQuestion + description: A single question to be scored by the Insights QA feature. type: object - GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary: - id: GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary properties: - wordIndex: - type: integer + name: description: >- - The word index of this boundary with respect to the first word in - the transcript piece. This index starts at zero. - format: int32 - transcriptIndex: - format: int32 + Identifier. The resource name of the question. Format: + projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}/qaQuestions/{qa_question} + type: string + abbreviation: + description: >- + Short, descriptive string, used in the UI where it's not practical + to display the full question body. E.g., "Greeting". + type: string + createTime: + description: Output only. The time at which this question was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. The most recent time at which the question was updated. + readOnly: true + type: string + format: google-datetime + questionType: + description: The type of question. + type: string + enumDescriptions: + - The type of the question is unspecified. + - >- + The default question type. The question is fully customizable by + the user. + - >- + The question type is using a predefined model provided by CCAI + teams. Users are not allowed to edit the question_body, + answer_choices, upload feedback labels for the question nor + fine-tune the question. However, users may edit other fields like + question tags, question order, etc. + enum: + - QA_QUESTION_TYPE_UNSPECIFIED + - CUSTOMIZABLE + - PREDEFINED + predefinedQuestionConfig: + description: >- + The configuration of the predefined question. This field will only + be set if the Question Type is predefined. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestionPredefinedQuestionConfig + questionBody: + description: Question text. E.g., "Did the agent greet the customer?" + type: string + answerInstructions: + description: Instructions describing how to determine the answer. + type: string + answerChoices: + description: >- + A list of valid answers to the question, which the LLM must choose + from. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestionAnswerChoice + tags: + description: >- + Questions are tagged for categorization and scoring. Tags can either + be: - Default Tags: These are predefined categories. They are + identified by their string value (e.g., "BUSINESS", "COMPLIANCE", + and "CUSTOMER"). - Custom Tags: These are user-defined categories. + They are identified by their full resource name (e.g., + projects/{project}/locations/{location}/qaQuestionTags/{qa_question_tag}). + Both default and custom tags are used to group questions and to + influence the scoring of each question. + type: array + items: + type: string + order: + description: >- + Defines the order of the question within its parent scorecard + revision. type: integer + format: int32 + metrics: description: >- - The index in the sequence of transcribed pieces of the conversation - where the boundary is located. This index starts at zero. - type: object + Metrics of the underlying tuned LLM over a holdout/test set while + fine tuning the underlying LLM for the given question. This field + will only be populated if and only if the question is part of a + scorecard revision that has been tuned. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestionMetrics + tuningMetadata: + description: >- + Metadata about the tuning operation for the question.This field will + only be populated if and only if the question is part of a scorecard + revision that has been tuned. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestionTuningMetadata + GoogleCloudContactcenterinsightsV1QaQuestionPredefinedQuestionConfig: + id: GoogleCloudContactcenterinsightsV1QaQuestionPredefinedQuestionConfig description: >- - A point in a conversation that marks the start or the end of an - annotation. - GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotationUserInput: - id: GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotationUserInput + Configuration for a predefined question. This field will only be set if + the Question Type is predefined. type: object properties: - querySource: + type: + description: The type of the predefined question. type: string - description: Query source for the answer. enumDescriptions: - - Unknown query source. - - The query is from agents. + - The type of the predefined question is unspecified. - >- - The query is a query from previous suggestions, e.g. from a - preceding SuggestKnowledgeAssist response. + A prebuilt classifier classfying the outcome of the conversation. + For example, if the customer issue mentioned in a conversation has + been resolved or not. + - >- + A prebuilt classifier classfying the initiator of the conversation + escalation. For example, if it was initiated by the customer or + the agent. enum: - - QUERY_SOURCE_UNSPECIFIED - - AGENT_QUERY - - SUGGESTED_QUERY - query: + - PREDEFINED_QUESTION_TYPE_UNSPECIFIED + - CONVERSATION_OUTCOME + - CONVERSATION_OUTCOME_ESCALATION_INITIATOR_ROLE + GoogleCloudContactcenterinsightsV1QaQuestionAnswerChoice: + id: GoogleCloudContactcenterinsightsV1QaQuestionAnswerChoice + description: Message representing a possible answer to the question. + type: object + properties: + strValue: + description: String value. type: string + numValue: + description: Numerical value. + type: number + format: double + boolValue: + description: Boolean value. + type: boolean + naValue: description: >- - Query text. Article Search uses this to store the input query used - to generate the search results. - generatorName: + A value of "Not Applicable (N/A)". If provided, this field may only + be set to `true`. If a question receives this answer, it will be + excluded from any score calculations. + type: boolean + key: + description: A short string used as an identifier. type: string + score: description: >- - The resource name of associated generator. Format: - `projects//locations//generators/` - description: Explicit input used for generating the answer - GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecResponse: + Numerical score of the answer, used for generating the overall score + of a QaScorecardResult. If the answer uses na_value, this field is + unused. + type: number + format: double + GoogleCloudContactcenterinsightsV1QaQuestionMetrics: + id: GoogleCloudContactcenterinsightsV1QaQuestionMetrics + description: >- + A wrapper representing metrics calculated against a test-set on a LLM + that was fine tuned for this question. type: object - id: GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecResponse - description: The response to initialize a location-level encryption specification. - properties: {} - GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats: properties: - issue: + accuracy: description: >- - Issue resource. Format: - projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue} - type: string - displayName: - description: Display name of the issue. - type: string - labeledConversationsCount: - type: string - description: Number of conversations attached to the issue at this point in time. - format: int64 + Output only. Accuracy of the model. Measures the percentage of + correct answers the model gave on the test set. + readOnly: true + type: number + format: double + GoogleCloudContactcenterinsightsV1QaQuestionTuningMetadata: + id: GoogleCloudContactcenterinsightsV1QaQuestionTuningMetadata + description: >- + Metadata about the tuning operation for the question. Will only be set + if a scorecard containing this question has been tuned. type: object - id: GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats - description: Aggregated statistics about an issue. - GoogleIamV1TestIamPermissionsResponse: - id: GoogleIamV1TestIamPermissionsResponse properties: - permissions: + totalValidLabelCount: + description: >- + Total number of valid labels provided for the question at the time + of tuining. + type: string + format: int64 + datasetValidationWarnings: + description: >- + A list of any applicable data validation warnings about the + question's feedback labels. + type: array items: type: string + enumDescriptions: + - Unspecified data validation warning. + - A non-trivial percentage of the feedback labels are invalid. + - >- + The quantity of valid feedback labels provided is less than the + recommended minimum. + - >- + One or more of the answers have less than the recommended + minimum of feedback labels. + - All the labels in the dataset come from a single answer choice. + enum: + - DATASET_VALIDATION_WARNING_UNSPECIFIED + - TOO_MANY_INVALID_FEEDBACK_LABELS + - INSUFFICIENT_FEEDBACK_LABELS + - INSUFFICIENT_FEEDBACK_LABELS_PER_ANSWER + - ALL_FEEDBACK_LABELS_HAVE_THE_SAME_ANSWER + tuningError: + description: >- + Error status of the tuning operation for the question. Will only be + set if the tuning operation failed. + type: string + GoogleCloudContactcenterinsightsV1ListQaQuestionsResponse: + id: GoogleCloudContactcenterinsightsV1ListQaQuestionsResponse + description: The response from a ListQaQuestions request. + type: object + properties: + qaQuestions: + description: The QaQuestions under the parent. type: array + items: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestion' + nextPageToken: description: >- - A subset of `TestPermissionsRequest.permissions` that the caller is - allowed. + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + GoogleCloudContactcenterinsightsV1QaQuestionTag: + id: GoogleCloudContactcenterinsightsV1QaQuestionTag + description: >- + A tag is a resource which aims to categorize a set of questions across + multiple scorecards, e.g., "Customer Satisfaction","Billing", etc. type: object - description: Response message for `TestIamPermissions` method. - GoogleCloudContactcenterinsightsV1alpha1Analysis: - description: The analysis resource. properties: name: - type: string description: >- - Immutable. The resource name of the analysis. Format: - projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} - requestTime: - format: google-datetime - readOnly: true - description: Output only. The time at which the analysis was requested. + Identifier. Resource name for the QaQuestionTag Format + projects/{project}/locations/{location}/qaQuestionTags/{qa_question_tag} + In the above format, the last segment, i.e., qa_question_tag, is a + server-generated ID corresponding to the tag resource. type: string - analysisResult: + displayName: + description: Required. A user-specified display name for the tag. + type: string + qaQuestionIds: description: >- - Output only. The result of the analysis, which is populated when the - analysis finishes. - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnalysisResult + Optional. The list of Scorecard Question IDs that the tag applies + to. Each QaQuestionId is represented as a full resource name + containing the Question ID. Lastly, Since a tag may not necessarily + be referenced by any Scorecard Questions, we treat this field as + optional. + type: array + items: + type: string createTime: + description: Output only. The time at which the question tag was created. + readOnly: true type: string format: google-datetime + updateTime: description: >- - Output only. The time at which the analysis was created, which - occurs when the long-running operation completes. + Output only. The most recent time at which the question tag was + updated. readOnly: true - annotatorSelector: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector - description: >- - To select the annotators to run and the phrase matchers to use (if - any). If not specified, all annotators will be run. + type: string + format: google-datetime + GoogleCloudContactcenterinsightsV1ListQaQuestionTagsResponse: + id: GoogleCloudContactcenterinsightsV1ListQaQuestionTagsResponse + description: The response from a ListQaQuestionTags request. + type: object + properties: + qaQuestionTags: + description: The parent resource of the questions. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestionTag + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + GoogleCloudContactcenterinsightsV1QaScorecard: + id: GoogleCloudContactcenterinsightsV1QaScorecard + description: >- + A QaScorecard represents a collection of questions to be scored during + analysis. type: object - id: GoogleCloudContactcenterinsightsV1alpha1Analysis - GoogleCloudContactcenterinsightsV1FeedbackLabel: properties: name: description: >- - Immutable. Resource name of the FeedbackLabel. Format: - projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label} + Identifier. The scorecard name. Format: + projects/{project}/locations/{location}/qaScorecards/{qa_scorecard} + type: string + displayName: + description: The user-specified display name of the scorecard. + type: string + description: + description: A text description explaining the intent of the scorecard. type: string - qaAnswerLabel: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue - description: QaAnswer label. createTime: + description: Output only. The time at which this scorecard was created. readOnly: true - format: google-datetime - description: Output only. Create time of the label. - type: string - label: - description: String label. type: string + format: google-datetime updateTime: + description: >- + Output only. The most recent time at which the scorecard was + updated. readOnly: true - description: Output only. Update time of the label. - format: google-datetime type: string - labeledResource: - description: Resource name of the resource to be labeled. + format: google-datetime + isDefault: + description: >- + Whether the scorecard is the default one for the project. A default + scorecard cannot be deleted and will always appear first in + scorecard selector. + type: boolean + source: + description: Output only. The source of the scorecard. + readOnly: true type: string + enumDescriptions: + - >- + The source of the scorecard is unspecified. Default to + QA_SCORECARD_SOURCE_CUSTOMER_DEFINED. + - The scorecard is a custom scorecard created by the user. + - >- + The scorecard is a scorecard created through discovery engine + deployment. + enum: + - QA_SCORECARD_SOURCE_UNSPECIFIED + - QA_SCORECARD_SOURCE_CUSTOMER_DEFINED + - QA_SCORECARD_SOURCE_DISCOVERY_ENGINE + GoogleCloudContactcenterinsightsV1ListQaScorecardsResponse: + id: GoogleCloudContactcenterinsightsV1ListQaScorecardsResponse + description: The response from a ListQaScorecards request. type: object - id: GoogleCloudContactcenterinsightsV1FeedbackLabel - description: Represents a conversation, resource, and label provided by the user. - GoogleCloudContactcenterinsightsV1BulkDeleteConversationsMetadata: - id: GoogleCloudContactcenterinsightsV1BulkDeleteConversationsMetadata - description: The metadata for a bulk delete conversations operation. + properties: + qaScorecards: + description: The QaScorecards under the parent. + type: array + items: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecard' + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + GoogleCloudContactcenterinsightsV1QaScorecardRevision: + id: GoogleCloudContactcenterinsightsV1QaScorecardRevision + description: >- + A revision of a QaScorecard. Modifying published scorecard fields would + invalidate existing scorecard results — the questions may have changed, + or the score weighting will make existing scores impossible to + understand. So changes must create a new revision, rather than modifying + the existing resource. type: object properties: - request: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest - description: The original request for bulk delete. - endTime: - format: google-datetime - description: The time the operation finished running. + name: + description: >- + Identifier. The name of the scorecard revision. Format: + projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision} type: string + snapshot: + description: >- + The snapshot of the scorecard at the time of this revision's + creation. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecard' createTime: - description: The time the operation was created. + description: Output only. The timestamp that the revision was created. + readOnly: true type: string format: google-datetime - partialErrors: + alternateIds: description: >- - Partial errors during bulk delete conversations operation that might - cause the operation output to be incomplete. - type: array - items: - $ref: '#/components/schemas/GoogleRpcStatus' - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadata: - id: GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadata - description: The metadata for an IngestConversations operation. - type: object - properties: - request: + Output only. Alternative IDs for this revision of the scorecard, + e.g., `latest`. readOnly: true - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest - description: Output only. The original request for ingest. - partialErrors: type: array items: - $ref: '#/components/schemas/GoogleRpcStatus' - readOnly: true + type: string + state: description: >- - Output only. Partial errors during ingest operation that might cause - the operation output to be incomplete. - endTime: - format: google-datetime - description: Output only. The time the operation finished running. + Output only. State of the scorecard revision, indicating whether + it's ready to be used in analysis. readOnly: true type: string - createTime: - format: google-datetime - description: Output only. The time the operation was created. - type: string - readOnly: true - ingestConversationsStats: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats - description: Output only. Statistics for IngestConversations operation. - readOnly: true - GoogleLongrunningOperation: + enumDescriptions: + - Unspecified. + - The scorecard revision can be edited. + - Scorecard model training is in progress. + - Scorecard revision model training failed. + - The revision can be used in analysis. + - Scorecard is being deleted. + - Scorecard model training was explicitly cancelled by the user. + enum: + - STATE_UNSPECIFIED + - EDITABLE + - TRAINING + - TRAINING_FAILED + - READY + - DELETING + - TRAINING_CANCELLED + GoogleCloudContactcenterinsightsV1TuneQaScorecardRevisionRequest: + id: GoogleCloudContactcenterinsightsV1TuneQaScorecardRevisionRequest + description: Request for TuneQaScorecardRevision endpoint. type: object - id: GoogleLongrunningOperation - description: >- - This resource represents a long-running operation that is the result of - a network API call. properties: - response: - description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - done: - description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - type: boolean - name: + filter: description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. + Required. Filter for selecting the feedback labels that needs to be + used for training. This filter can be used to limit the feedback + labels used for tuning to a feedback labels created or updated for a + specific time-window etc. type: string - metadata: - type: object - description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - error: - description: >- - The error result of the operation in case of failure or - cancellation. - $ref: '#/components/schemas/GoogleRpcStatus' - GoogleCloudContactcenterinsightsV1TuneQaScorecardRevisionRequest: - type: object - id: GoogleCloudContactcenterinsightsV1TuneQaScorecardRevisionRequest - properties: validateOnly: description: >- Optional. Run in validate only mode, no fine tuning will actually @@ -3626,146 +3695,197 @@ components: run but once the validations complete we will proceed with the fine tune, if applicable. type: boolean - filter: + GoogleCloudContactcenterinsightsV1DeployQaScorecardRevisionRequest: + id: GoogleCloudContactcenterinsightsV1DeployQaScorecardRevisionRequest + description: The request to deploy a QaScorecardRevision + type: object + properties: {} + GoogleCloudContactcenterinsightsV1UndeployQaScorecardRevisionRequest: + id: GoogleCloudContactcenterinsightsV1UndeployQaScorecardRevisionRequest + description: The request to undeploy a QaScorecardRevision + type: object + properties: {} + GoogleCloudContactcenterinsightsV1ListQaScorecardRevisionsResponse: + id: GoogleCloudContactcenterinsightsV1ListQaScorecardRevisionsResponse + description: The response from a ListQaScorecardRevisions request. + type: object + properties: + qaScorecardRevisions: + description: The QaScorecards under the parent. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecardRevision + nextPageToken: description: >- - Required. Filter for selecting the feedback labels that needs to be - used for training. This filter can be used to limit the feedback - labels used for tuning to a feedback labels created or updated for a - specific time-window etc. + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. type: string - description: Request for TuneQaScorecardRevision endpoint. - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest: - description: The request to ingest conversations. + GoogleCloudContactcenterinsightsV1ListFeedbackLabelsResponse: + id: GoogleCloudContactcenterinsightsV1ListFeedbackLabelsResponse + description: The response for listing feedback labels. type: object properties: - redactionConfig: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RedactionConfig - description: >- - Optional. DLP settings for transcript redaction. Optional, will - default to the config specified in Settings. - gcsSource: - description: >- - A cloud storage bucket source. Note that any previously ingested - objects from the source will be skipped to avoid duplication. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource - conversationConfig: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig - description: Configuration that applies to all conversations. - speechConfig: - description: >- - Optional. Default Speech-to-Text configuration. Optional, will - default to the config specified in Settings. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SpeechConfig - sampleSize: - format: int32 - type: integer + feedbackLabels: + description: The feedback labels that match the request. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel + nextPageToken: + description: The next page token. + type: string + GoogleCloudContactcenterinsightsV1ListAllFeedbackLabelsResponse: + id: GoogleCloudContactcenterinsightsV1ListAllFeedbackLabelsResponse + description: The response for listing all feedback labels. + type: object + properties: + feedbackLabels: + description: The feedback labels that match the request. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel + nextPageToken: description: >- - Optional. If set, this fields indicates the number of objects to - ingest from the Cloud Storage bucket. If empty, the entire bucket - will be ingested. Unless they are first deleted, conversations - produced through sampling won't be ingested by subsequent ingest - requests. - parent: - description: Required. The parent resource for new conversations. + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. type: string - transcriptObjectConfig: + GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequest: + id: GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequest + description: The request for bulk uploading feedback labels. + type: object + properties: + gcsSource: + description: A cloud storage bucket source. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig - description: Configuration for when `source` contains conversation transcripts. - id: GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest - GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource: + #/components/schemas/GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequestGcsSource + sheetsSource: + description: A sheets document source. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequestSheetsSource + validateOnly: + description: >- + Optional. If set, upload will not happen and the labels will be + validated. If not set, then default behavior will be to upload the + labels after validation is complete. + type: boolean + GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequestGcsSource: + id: >- + GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequestGcsSource + description: Google Cloud Storage Object details to get the feedback label file from. + type: object properties: - metadataBucketUri: + format: + description: Required. File format which will be ingested. type: string + enumDescriptions: + - Unspecified format. + - CSV format. + - JSON format. + enum: + - FORMAT_UNSPECIFIED + - CSV + - JSON + objectUri: description: >- - Optional. The Cloud Storage path to the conversation metadata. Note - that: [1] Metadata files are expected to be in JSON format. [2] - Metadata and source files (transcripts or audio) must be in separate - buckets. [3] A source file and its corresponding metadata file must - share the same name to be properly ingested, E.g. - `gs://bucket/audio/conversation1.mp3` and - `gs://bucket/metadata/conversation1.json`. - bucketUri: - description: Required. The Cloud Storage bucket containing source objects. + Required. The Google Cloud Storage URI of the file to import. + Format: `gs://bucket_name/object_name` type: string - customMetadataKeys: - type: array + GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequestSheetsSource: + id: >- + GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequestSheetsSource + description: Google Sheets document details to get the feedback label file from. + type: object + properties: + spreadsheetUri: description: >- - Optional. Custom keys to extract as conversation labels from - metadata files in `metadata_bucket_uri`. Keys not included in this - field will be ignored. Note that there is a limit of 20 labels per - conversation. - items: - type: string - bucketObjectType: - enumDescriptions: - - The object type is unspecified and will default to `TRANSCRIPT`. - - The object is a transcript. - - The object is an audio file. + Required. The Google Sheets document to write the feedback labels + to. Retrieved from Google Sheets URI. E.g. + `https://docs.google.com/spreadsheets/d/1234567890` The spreadsheet + must be shared with the Insights P4SA. type: string - enum: - - BUCKET_OBJECT_TYPE_UNSPECIFIED - - TRANSCRIPT - - AUDIO - description: Optional. Specifies the type of the objects in `bucket_uri`. - type: object - description: Configuration for Cloud Storage bucket sources. - id: GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource - GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig: + GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequest: + id: GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequest + description: Request for the BulkDownloadFeedbackLabel endpoint. type: object - id: >- - GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig properties: - medium: - description: Required. The medium transcript objects represent. + gcsDestination: + description: A cloud storage bucket destination. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestGcsDestination + sheetsDestination: + description: A sheets document destination. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestSheetsDestination + parent: + description: Required. The parent resource for new feedback labels. + type: string + filter: + description: >- + Optional. A filter to reduce results to a specific subset. Supports + disjunctions (OR) and conjunctions (AND). Supported fields: * + `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * + `min_create_time` * `max_create_time` * `min_update_time` * + `max_update_time` * `feedback_label_type`: QUALITY_AI, + TOPIC_MODELING + type: string + maxDownloadCount: + description: >- + Optional. Limits the maximum number of feedback labels that will be + downloaded. The first `N` feedback labels will be downloaded. + type: integer + format: int32 + feedbackLabelType: + description: Optional. The type of feedback labels that will be downloaded. type: string enumDescriptions: - - Default value, if unspecified will default to PHONE_CALL. - - The format for conversations that took place over the phone. - - The format for conversations that took place over chat. + - Unspecified format + - >- + Downloaded file will contain all Quality AI labels from the latest + scorecard revision. + - Downloaded file will contain only Topic Modeling labels. + - Agent Assist Summarization labels. enum: - - MEDIUM_UNSPECIFIED - - PHONE_CALL - - CHAT - description: Configuration for processing transcript objects. + - FEEDBACK_LABEL_TYPE_UNSPECIFIED + - QUALITY_AI + - TOPIC_MODELING + - AGENT_ASSIST_SUMMARY + conversationFilter: + description: >- + Optional. Filter parent conversations to download feedback labels + for. When specified, the feedback labels will be downloaded for the + conversations that match the filter. If `template_qa_scorecard_id` + is set, all the conversations that match the filter will be paired + with the questions under the scorecard for labeling. + type: string + templateQaScorecardId: + description: >- + Optional. If set, a template for labeling conversations and + scorecard questions will be created from the conversation_filter and + the questions under the scorecard(s). The feedback label `filter` + will be ignored. + type: array + items: + type: string GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestGcsDestination: + id: >- + GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestGcsDestination description: Google Cloud Storage Object details to write the feedback labels to. type: object properties: - recordsPerFileCount: - description: >- - Optional. The number of records per file. Applicable for either - format. - format: int64 - type: string - alwaysPrintEmptyFields: - description: >- - Optional. Always print fields with no presence. This is useful for - printing fields that are not set, like implicit 0 value or empty - lists/maps. Only applicable for JSON format. - type: boolean - addWhitespace: - type: boolean - description: >- - Optional. Add whitespace to the JSON file. Makes easier to read, but - increases file size. Only applicable for JSON format. format: description: Required. File format in which the labels will be exported. + type: string enumDescriptions: - Unspecified format. - CSV format. 1,000 labels are stored per CSV file by default. - JSON format. 1 label stored per JSON file by default. - type: string enum: - FORMAT_UNSPECIFIED - CSV - JSON objectUri: - type: string description: >- Required. The Google Cloud Storage URI to write the feedback labels to. The file name will be used as a prefix for the files written to @@ -3773,3722 +3893,5675 @@ components: otherwise it will be used as is. The file extension will be appended to the file name based on the format selected. E.g. `gs://bucket_name/object_uri_prefix` + type: string + addWhitespace: + description: >- + Optional. Add whitespace to the JSON file. Makes easier to read, but + increases file size. Only applicable for JSON format. + type: boolean + alwaysPrintEmptyFields: + description: >- + Optional. Always print fields with no presence. This is useful for + printing fields that are not set, like implicit 0 value or empty + lists/maps. Only applicable for JSON format. + type: boolean + recordsPerFileCount: + description: >- + Optional. The number of records per file. Applicable for either + format. + type: string + format: int64 + GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestSheetsDestination: id: >- - GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestGcsDestination - GoogleTypeInterval: - id: GoogleTypeInterval - description: >- - Represents a time interval, encoded as a Timestamp start (inclusive) and - a Timestamp end (exclusive). The start must be less than or equal to the - end. When the start equals the end, the interval is empty (matches no - time). When both start and end are unspecified, the interval matches any - time. + GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequestSheetsDestination + description: Google Sheets document details to write the feedback labels to. type: object properties: - endTime: + spreadsheetUri: description: >- - Optional. Exclusive end of the interval. If specified, a Timestamp - matching this interval will have to be before the end. + Required. The Google Sheets document to write the feedback labels + to. Retrieved from Google Sheets URI. E.g. + `https://docs.google.com/spreadsheets/d/1234567890` The spreadsheet + must be shared with the Insights P4SA. The spreadsheet ID written to + will be returned as `file_names` in the + BulkDownloadFeedbackLabelsMetadata. type: string - format: google-datetime - startTime: + sheetTitle: + description: >- + Optional. The title of the new sheet to write the feedback labels + to. type: string - format: google-datetime + GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsRequest: + id: GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsRequest + description: Request for the BulkDeleteFeedbackLabels endpoint. + type: object + properties: + parent: + description: Required. The parent resource for new feedback labels. + type: string + filter: description: >- - Optional. Inclusive start of the interval. If specified, a Timestamp - matching this interval will have to be the same or after the start. - GoogleCloudContactcenterinsightsV1alpha1DialogflowSource: - id: GoogleCloudContactcenterinsightsV1alpha1DialogflowSource + Optional. A filter to reduce results to a specific subset. Supports + disjunctions (OR) and conjunctions (AND). Supported fields: * + `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * + `min_create_time` * `max_create_time` * `min_update_time` * + `max_update_time` * `feedback_label_type`: QUALITY_AI, + TOPIC_MODELING + type: string + GoogleCloudContactcenterinsightsV1AuthorizedViewSet: + id: GoogleCloudContactcenterinsightsV1AuthorizedViewSet + description: An AuthorizedViewSet contains a set of AuthorizedView resources. type: object - description: A Dialogflow source of conversation data. properties: - audioUri: + name: description: >- - Cloud Storage URI that points to a file that contains the - conversation audio. + Identifier. The resource name of the AuthorizedViewSet. Format: + projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set} type: string - dialogflowConversation: + displayName: + description: Display Name. Limit 64 characters. type: string - description: >- - Output only. The name of the Dialogflow conversation that this - conversation resource is derived from. Format: - projects/{project}/locations/{location}/conversations/{conversation} + createTime: + description: Output only. Create time. readOnly: true - GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata: - properties: - smartReplyAllowlistCovered: - description: >- - Whether the transcript segment was covered under the configured - smart reply allowlist in Agent Assist. - type: boolean - type: object - id: >- - GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata - description: Metadata from Dialogflow relating to the current transcript segment. - GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource: - id: GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource - properties: - dialogflowSource: - description: The source when the conversation comes from Dialogflow. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DialogflowSource - gcsSource: - description: A Cloud Storage location specification for the audio and transcript. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GcsSource - type: object - description: The conversation source, which is a combination of transcript and audio. - GoogleCloudContactcenterinsightsV1alpha1SilenceData: - id: GoogleCloudContactcenterinsightsV1alpha1SilenceData - description: The data for a silence annotation. - type: object - properties: {} - GoogleCloudContactcenterinsightsV1ImportIssueModelResponse: - properties: {} - description: Response from import issue model + type: string + format: google-datetime + updateTime: + description: Output only. Update time. + readOnly: true + type: string + format: google-datetime + GoogleCloudContactcenterinsightsV1ListAuthorizedViewSetsResponse: + id: GoogleCloudContactcenterinsightsV1ListAuthorizedViewSetsResponse + description: The response from a ListAuthorizedViewSet request. type: object - id: GoogleCloudContactcenterinsightsV1ImportIssueModelResponse - GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequest: properties: - validateOnly: - type: boolean + authorizedViewSets: + description: The AuthorizedViewSets under the parent. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AuthorizedViewSet + nextPageToken: description: >- - Optional. If set, upload will not happen and the labels will be - validated. If not set, then default behavior will be to upload the - labels after validation is complete. - gcsSource: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequestGcsSource - description: A cloud storage bucket source. - id: GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequest - description: The request for bulk uploading feedback labels. + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + GoogleCloudContactcenterinsightsV1AuthorizedView: + id: GoogleCloudContactcenterinsightsV1AuthorizedView + description: >- + An AuthorizedView represents a view of accessible Insights resources + (for example, Conversation and Scorecard). Who have read access to the + AuthorizedView resource will have access to these Insight resources as + well. type: object - GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelMetadata: properties: - endTime: + name: + description: >- + Identifier. The resource name of the AuthorizedView. Format: + projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}/authorizedViews/{authorized_view} + type: string + displayName: + description: Display Name. Limit 64 characters. + type: string + conversationFilter: + description: >- + A filter to reduce conversation results to a specific subset. The + AuthorizedView's assigned permission (read/write) could be applied + to the subset of conversations. If conversation_filter is empty, + there is no restriction on the conversations that the AuthorizedView + can access. Having *authorizedViews.get* access to the + AuthorizedView means having the same read/write access to the + Conversations (as well as metadata/annotations linked to the + conversation) that this AuthorizedView has. type: string - format: google-datetime - description: The time the operation finished running. - request: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest - description: The original import request. createTime: + description: Output only. The time at which the authorized view was created. + readOnly: true type: string - description: The time the operation was created. format: google-datetime - type: object - id: GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelMetadata - description: Metadata used for import issue model. - GoogleCloudContactcenterinsightsV1ImportIssueModelRequest: + updateTime: + description: >- + Output only. The most recent time at which the authorized view was + updated. + readOnly: true + type: string + format: google-datetime + GoogleCloudContactcenterinsightsV1ListAuthorizedViewsResponse: + id: GoogleCloudContactcenterinsightsV1ListAuthorizedViewsResponse + description: The response from a ListAuthorizedViews request. type: object properties: - gcsSource: - description: Google Cloud Storage source message. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource - parent: - type: string - description: Required. The parent resource of the issue model. - createNewModel: + authorizedViews: + description: The AuthorizedViews under the parent. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AuthorizedView + nextPageToken: description: >- - Optional. If set to true, will create an issue model from the - imported file with randomly generated IDs for the issue model and - corresponding issues. Otherwise, replaces an existing model with the - same ID as the file. - type: boolean - description: Request to import an issue model. - id: GoogleCloudContactcenterinsightsV1ImportIssueModelRequest - GoogleCloudContactcenterinsightsV1ListIssuesResponse: + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + GoogleCloudContactcenterinsightsV1SearchAuthorizedViewsResponse: + id: GoogleCloudContactcenterinsightsV1SearchAuthorizedViewsResponse + description: The response from a ListAuthorizedViews request. type: object - id: GoogleCloudContactcenterinsightsV1ListIssuesResponse - description: The response of listing issues. properties: - issues: - description: The issues that match the request. - items: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Issue' + authorizedViews: + description: The AuthorizedViews under the parent. type: array - GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig: - properties: - agentChannel: - format: int32 - description: >- - Optional. Indicates which of the channels, 1 or 2, contains the - agent. Note that this must be set for conversations to be properly - displayed and analyzed. - type: integer - customerChannel: - format: int32 - type: integer - description: >- - Optional. Indicates which of the channels, 1 or 2, contains the - agent. Note that this must be set for conversations to be properly - displayed and analyzed. - agentId: + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AuthorizedView + nextPageToken: description: >- - Optional. An opaque, user-specified string representing a human - agent who handled all conversations in the import. Note that this - will be overridden if per-conversation metadata is provided through - the `metadata_bucket_uri`. + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. type: string - description: Configuration that applies to all conversations. - type: object - id: >- - GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig - GoogleCloudContactcenterinsightsV1AnalysisRule: + GoogleCloudContactcenterinsightsV1Assessment: + id: GoogleCloudContactcenterinsightsV1Assessment + description: The assessment resource. type: object - id: GoogleCloudContactcenterinsightsV1AnalysisRule properties: + name: + description: >- + Identifier. The resource name of the assessment. Format: + projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment} + type: string createTime: - description: Output only. The time at which this analysis rule was created. + description: Output only. The time at which the assessment was created. readOnly: true - format: google-datetime type: string + format: google-datetime updateTime: - type: string + description: Output only. The time at which the assessment was last updated. readOnly: true - description: >- - Output only. The most recent time at which this analysis rule was - updated. - format: google-datetime - annotatorSelector: - description: >- - Selector of annotators to run and the phrase matchers to use for - conversations that matches the conversation_filter. If not - specified, NO annotators will be run. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelector - analysisPercentage: - format: double - description: >- - Percentage of conversations that we should apply this analysis - setting automatically, between [0, 1]. For example, 0.1 means 10%. - Conversations are sampled in a determenestic way. The original - runtime_percentage & upload percentage will be replaced by defining - filters on the conversation. - type: number - active: - type: boolean - description: >- - If true, apply this rule to conversations. Otherwise, this rule is - inactive and saved as a draft. - name: type: string - description: >- - Identifier. The resource name of the analysis rule. Format: - projects/{project}/locations/{location}/analysisRules/{analysis_rule} - displayName: + format: google-datetime + state: + description: Output only. The state of the assessment. + readOnly: true type: string - description: Display Name of the analysis rule. - conversationFilter: + enumDescriptions: + - The state is unspecified. This value should not be used. + - The default state of all new assessments. + - The assessment has been published. + - The assessment has been appealed. + - The assessment has been finalized. + enum: + - STATE_UNSPECIFIED + - DRAFT + - PUBLISHED + - APPEALED + - FINALIZED + agentInfo: + description: Information about the agent the assessment is for. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo + GoogleCloudContactcenterinsightsV1ListAssessmentsResponse: + id: GoogleCloudContactcenterinsightsV1ListAssessmentsResponse + description: The response of listing assessments. + type: object + properties: + assessments: + description: The assessments that match the request. + type: array + items: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Assessment' + nextPageToken: description: >- - Filter for the conversations that should apply this analysis rule. - An empty filter means this analysis rule applies to all - conversations. + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. type: string + GoogleCloudContactcenterinsightsV1PublishAssessmentRequest: + id: GoogleCloudContactcenterinsightsV1PublishAssessmentRequest description: >- - The CCAI Insights project wide analysis rule. This rule will be applied - to all conversations that match the filter defined in the rule. For a - conversation matches the filter, the annotators specified in the rule - will be run. If a conversation matches multiple rules, a union of all - the annotators will be run. One project can have multiple analysis - rules. - GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsResponse: + The message to publish an assessment. Draft and appealed assessments can + be published. Publishing simply changes the state of the assessment to + published, allowing the console and authorized views to filter on the + state. + type: object properties: {} + GoogleCloudContactcenterinsightsV1AppealAssessmentRequest: + id: GoogleCloudContactcenterinsightsV1AppealAssessmentRequest + description: The message to appeal an assessment. type: object - id: GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsResponse - description: Response for the BulkDownloadFeedbackLabel endpoint. - GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination: + properties: {} + GoogleCloudContactcenterinsightsV1FinalizeAssessmentRequest: + id: GoogleCloudContactcenterinsightsV1FinalizeAssessmentRequest + description: >- + The message to finalize an assessment. Finalizing makes an assessment + and its notes immutable. + type: object + properties: {} + GoogleCloudContactcenterinsightsV1Note: + id: GoogleCloudContactcenterinsightsV1Note + description: The conversation assessment note resource. type: object - id: >- - GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination properties: - dataset: + conversationTurnNote: + description: The note is associated with a conversation turn. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1NoteConversationTurnNote + qaQuestionNote: description: >- - Required. The name of the BigQuery dataset that the snapshot result - should be exported to. If this dataset does not exist, the export - call returns an INVALID_ARGUMENT error. - type: string - table: + The note is associated with a QA question in one of the + conversation's scorecard results. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1NoteQaQuestionNote + assessmentNote: + description: The note is associated to the entire parent assessment. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1NoteAssessmentNote + name: description: >- - The BigQuery table name to which the insights data should be - written. If this table does not exist, the export call returns an - INVALID_ARGUMENT error. + Identifier. The resource name of the note. Format: + projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}/notes/{note} type: string - projectId: - description: >- - A project ID or number. If specified, then export will attempt to - write data to this project instead of the resource project. - Otherwise, the resource project will be used. + createTime: + description: Output only. The time at which the note was created. + readOnly: true type: string - description: A BigQuery Table Reference. - GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig: - type: object - properties: - summarizationModel: - enumDescriptions: - - Unspecified summarization model. - - The CCAI baseline model. - - The CCAI baseline model, V2.0. - description: Default summarization model to be used. - enum: - - SUMMARIZATION_MODEL_UNSPECIFIED - - BASELINE_MODEL - - BASELINE_MODEL_V2_0 - type: string - conversationProfile: - type: string - description: >- - Resource name of the Dialogflow conversation profile. Format: - projects/{project}/locations/{location}/conversationProfiles/{conversation_profile} - description: Configuration for summarization. - id: GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig - GoogleCloudContactcenterinsightsV1FaqAnswerData: - type: object - description: Agent Assist frequently-asked-question answer data. - id: GoogleCloudContactcenterinsightsV1FaqAnswerData - properties: - source: - description: >- - The knowledge document that this answer was extracted from. Format: - projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}. - type: string - metadata: - additionalProperties: - type: string - description: >- - Map that contains metadata about the FAQ answer and the document - that it originates from. - type: object - question: - description: The corresponding FAQ question. - type: string - answer: - type: string - description: The piece of text from the `source` knowledge base document. - confidenceScore: - description: >- - The system's confidence score that this answer is a good match for - this conversation, ranging from 0.0 (completely uncertain) to 1.0 - (completely certain). - format: float - type: number - queryRecord: - description: >- - The name of the answer record. Format: - projects/{project}/locations/{location}/answerRecords/{answer_record} - type: string - GoogleCloudContactcenterinsightsV1ListConversationsResponse: - properties: - nextPageToken: - description: >- - A token which can be sent as `page_token` to retrieve the next page. - If this field is set, it means there is another page available. If - it is not set, it means no other pages are available. - type: string - conversations: - type: array - description: The conversations that match the request. - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation - id: GoogleCloudContactcenterinsightsV1ListConversationsResponse - type: object - description: The response of listing conversations. - GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest: - type: object - id: GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest - properties: - encryptionSpec: - description: >- - Required. The encryption spec used for CMEK encryption. It is - required that the kms key is in the same region as the endpoint. The - same key will be used for all provisioned resources, if encryption - is available. If the `kms_key_name` field is left empty, no - encryption will be enforced. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1EncryptionSpec - description: The request to initialize a location-level encryption specification. - GoogleCloudContactcenterinsightsV1alpha1IssueModelResult: - type: object - id: GoogleCloudContactcenterinsightsV1alpha1IssueModelResult - description: Issue Modeling result on a conversation. - properties: - issueModel: - description: >- - Issue model that generates the result. Format: - projects/{project}/locations/{location}/issueModels/{issue_model} - type: string - issues: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueAssignment - description: All the matched issues. - GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore: - type: object - id: >- - GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore - description: Average QA normalized score for the tag. - properties: - averageTagNormalizedScore: - type: number - format: double - description: Average tag normalized score per tag. - tag: - type: string - description: Tag name. - GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponse: - properties: - slices: - description: >- - A slice contains a total and (if the request specified a time - granularity) a time series of metric values. Each slice contains a - unique combination of the cardinality of dimensions from the - request. - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSlice - type: array + format: google-datetime updateTime: + description: Output only. The time at which the note was last updated. + readOnly: true type: string format: google-datetime - description: The metrics last update time. - location: + noteCreator: + description: Output only. The user that created the note. + readOnly: true + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1UserInfo' + content: + description: The note content. type: string - description: >- - Required. The location of the data. - "projects/{project}/locations/{location}" - macroAverageSlice: - description: >- - The macro average slice contains aggregated averages across the - selected dimension. i.e. if group_by agent is specified this field - will contain the average across all agents. This field is only - populated if the request specifies a Dimension. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSlice - description: The response for querying metrics. - id: GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponse + GoogleCloudContactcenterinsightsV1NoteConversationTurnNote: + id: GoogleCloudContactcenterinsightsV1NoteConversationTurnNote + description: A note about a conversation turn. type: object - GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeriesInterval: properties: - conversationCount: + turnIndex: + description: The conversation turn index that the note is associated with. type: integer - description: The number of conversations created in this interval. format: int32 - startTime: - description: The start time of this interval. - format: google-datetime - type: string + GoogleCloudContactcenterinsightsV1NoteQaQuestionNote: + id: GoogleCloudContactcenterinsightsV1NoteQaQuestionNote + description: A note about a QA question. type: object - id: >- - GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeriesInterval - description: A single interval in a time series. - GoogleCloudContactcenterinsightsV1ExportIssueModelRequest: - id: GoogleCloudContactcenterinsightsV1ExportIssueModelRequest - description: Request to export an issue model. - properties: - gcsDestination: - description: Google Cloud Storage URI to export the issue model to. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination - name: - description: Required. The issue model to export. - type: string - type: object - GoogleCloudContactcenterinsightsV1DeployIssueModelMetadata: properties: - request: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1DeployIssueModelRequest - description: The original request for deployment. - createTime: - type: string - readOnly: true - description: Output only. The time the operation was created. - format: google-datetime - endTime: - description: Output only. The time the operation finished running. - format: google-datetime + qaQuestion: + description: The question resource that the note is associated with. type: string - readOnly: true - id: GoogleCloudContactcenterinsightsV1DeployIssueModelMetadata + GoogleCloudContactcenterinsightsV1NoteAssessmentNote: + id: GoogleCloudContactcenterinsightsV1NoteAssessmentNote + description: A note about the entire parent assessment. type: object - description: Metadata for deploying an issue model. - GoogleCloudContactcenterinsightsV1IntentMatchData: + properties: {} + GoogleCloudContactcenterinsightsV1UserInfo: + id: GoogleCloudContactcenterinsightsV1UserInfo + description: Information about a user. type: object - id: GoogleCloudContactcenterinsightsV1IntentMatchData - description: >- - The data for an intent match. Represents an intent match for a text - segment in the conversation. A text segment can be part of a sentence, a - complete sentence, or an utterance with multiple sentences. properties: - intentUniqueId: - description: >- - The id of the matched intent. Can be used to retrieve the - corresponding intent information. + username: + description: The user's username. type: string - GoogleCloudContactcenterinsightsV1IngestConversationsResponse: + GoogleCloudContactcenterinsightsV1ListNotesResponse: + id: GoogleCloudContactcenterinsightsV1ListNotesResponse + description: The response of listing notes. type: object - id: GoogleCloudContactcenterinsightsV1IngestConversationsResponse - description: The response to an IngestConversations operation. - properties: {} - GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfigScorecardList: - id: >- - GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfigScorecardList properties: - qaScorecardRevisions: - items: - type: string + notes: + description: The notes that match the request. type: array - description: List of QaScorecardRevisions. - type: object - description: Container for a list of scorecards. - GoogleCloudContactcenterinsightsV1UndeployQaScorecardRevisionRequest: - type: object - properties: {} - id: GoogleCloudContactcenterinsightsV1UndeployQaScorecardRevisionRequest - description: The request to undeploy a QaScorecardRevision - GoogleCloudContactcenterinsightsV1QaQuestionMetrics: - description: >- - A wrapper representing metrics calculated against a test-set on a LLM - that was fine tuned for this question. - id: GoogleCloudContactcenterinsightsV1QaQuestionMetrics - type: object - properties: - accuracy: + items: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Note' + nextPageToken: description: >- - Output only. Accuracy of the model. Measures the percentage of - correct answers the model gave on the test set. - format: double - type: number - readOnly: true - GoogleCloudContactcenterinsightsV1ExportIssueModelMetadata: - properties: - request: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ExportIssueModelRequest - description: The original export request. - createTime: - format: google-datetime - description: The time the operation was created. - type: string - endTime: + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. type: string - format: google-datetime - description: The time the operation finished running. - id: GoogleCloudContactcenterinsightsV1ExportIssueModelMetadata - type: object - description: Metadata used for export issue model. - GoogleCloudContactcenterinsightsV1QaQuestionTuningMetadata: + GoogleIamV1SetIamPolicyRequest: + id: GoogleIamV1SetIamPolicyRequest + description: Request message for `SetIamPolicy` method. type: object - id: GoogleCloudContactcenterinsightsV1QaQuestionTuningMetadata properties: - tuningError: + policy: description: >- - Error status of the tuning operation for the question. Will only be - set if the tuning operation failed. - type: string - datasetValidationWarnings: - type: array + REQUIRED: The complete policy to be applied to the `resource`. The + size of the policy is limited to a few 10s of KB. An empty policy is + a valid policy but certain Google Cloud services (such as Projects) + might reject them. + $ref: '#/components/schemas/GoogleIamV1Policy' + updateMask: description: >- - A list of any applicable data validation warnings about the - question's feedback labels. - items: - type: string - enumDescriptions: - - Unspecified data validation warning. - - A non-trivial percentage of the feedback labels are invalid. - - >- - The quantity of valid feedback labels provided is less than the - recommended minimum. - - >- - One or more of the answers have less than the recommended - minimum of feedback labels. - - All the labels in the dataset come from a single answer choice. - enum: - - DATASET_VALIDATION_WARNING_UNSPECIFIED - - TOO_MANY_INVALID_FEEDBACK_LABELS - - INSUFFICIENT_FEEDBACK_LABELS - - INSUFFICIENT_FEEDBACK_LABELS_PER_ANSWER - - ALL_FEEDBACK_LABELS_HAVE_THE_SAME_ANSWER - totalValidLabelCount: - description: >- - Total number of valid labels provided for the question at the time - of tuining. + OPTIONAL: A FieldMask specifying which fields of the policy to + modify. Only the fields in the mask will be modified. If no mask is + provided, the following default mask is used: `paths: "bindings, + etag"` type: string - format: int64 + format: google-fieldmask + GoogleIamV1Policy: + id: GoogleIamV1Policy description: >- - Metadata about the tuning operation for the question. Will only be set - if a scorecard containing this question has been tuned. - GoogleCloudContactcenterinsightsV1ListAnalysisRulesResponse: + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. A `Policy` is a collection of + `bindings`. A `binding` binds one or more `members`, or principals, to a + single `role`. Principals can be user accounts, service accounts, Google + groups, and domains (such as G Suite). A `role` is a named list of + permissions; each `role` can be an IAM predefined role or a user-created + custom role. For some types of Google Cloud resources, a `binding` can + also specify a `condition`, which is a logical expression that allows + access to a resource only if the expression evaluates to `true`. A + condition can add constraints based on attributes of the request, the + resource, or both. To learn which resources support conditions in their + IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + **JSON example:** ``` { "bindings": [ { "role": + "roles/resourcemanager.organizationAdmin", "members": [ + "user:mike@example.com", "group:admins@example.com", + "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { + "role": "roles/resourcemanager.organizationViewer", "members": [ + "user:eve@example.com" ], "condition": { "title": "expirable access", + "description": "Does not grant access after Sep 2020", "expression": + "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": + "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - + members: - user:mike@example.com - group:admins@example.com - + domain:google.com - + serviceAccount:my-project-id@appspot.gserviceaccount.com role: + roles/resourcemanager.organizationAdmin - members: - + user:eve@example.com role: roles/resourcemanager.organizationViewer + condition: title: expirable access description: Does not grant access + after Sep 2020 expression: request.time < + timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` + For a description of IAM and its features, see the [IAM + documentation](https://cloud.google.com/iam/docs/). type: object properties: - analysisRules: + 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). + type: integer + format: int32 + bindings: + description: >- + Associates a list of `members`, or principals, with a `role`. + Optionally, may specify a `condition` that determines how and when + the `bindings` are applied. Each of the `bindings` must contain at + least one principal. The `bindings` in a `Policy` can refer to up to + 1,500 principals; up to 250 of these principals can be Google + groups. Each occurrence of a principal counts towards these limits. + For example, if the `bindings` grant 50 different roles to + `user:alice@example.com`, and not to any other principal, then you + can add another 1,450 principals to the `bindings` in the `Policy`. + type: array items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnalysisRule + $ref: '#/components/schemas/GoogleIamV1Binding' + auditConfigs: + description: Specifies cloud audit logging configuration for this policy. type: array - description: The analysis_rule that match the request. - nextPageToken: + items: + $ref: '#/components/schemas/GoogleIamV1AuditConfig' + etag: description: >- - A token, which can be sent as `page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. + `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. type: string - id: GoogleCloudContactcenterinsightsV1ListAnalysisRulesResponse - description: The response of listing views. - GoogleCloudContactcenterinsightsV1alpha1Intent: - id: GoogleCloudContactcenterinsightsV1alpha1Intent + format: byte + GoogleIamV1Binding: + id: GoogleIamV1Binding + description: Associates `members`, or principals, with a `role`. type: object properties: - displayName: - type: string - description: The human-readable name of the intent. - id: - description: The unique identifier of the intent. + role: + description: >- + Role that is assigned to the list of `members`, or principals. For + example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an + overview of the IAM roles and permissions, see the [IAM + documentation](https://cloud.google.com/iam/docs/roles-overview). + For a list of the available pre-defined roles, see + [here](https://cloud.google.com/iam/docs/understanding-roles). type: string + members: + description: >- + Specifies the principals requesting access for a Google Cloud + 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. Does not include identities + that come from external identity providers (IdPs) through identity + federation. * `user:{emailid}`: An email address that represents a + specific Google account. For example, `alice@example.com` . * + `serviceAccount:{emailid}`: An email address that represents a + Google service account. For example, + `my-other-app@appspot.gserviceaccount.com`. * + `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: + An identifier for a [Kubernetes service + account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). + For example, + `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * + `group:{emailid}`: An email address that represents a Google group. + For example, `admins@example.com`. * `domain:{domain}`: The G Suite + domain (primary) that represents all the users of that domain. For + example, `google.com` or `example.com`. * + `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workforce identity pool. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: + All workforce identities in a group. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All workforce identities with a specific attribute value. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: + All identities in a workforce identity pool. * + `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workload identity pool. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: + A workload identity pool group. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All identities in a workload identity pool with a certain attribute. + * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: + All identities in a workload identity pool. * + `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. * + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + Deleted single identity in a workforce identity pool. For example, + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + type: array + items: + type: string + condition: + description: >- + The condition that is associated with this binding. If the condition + evaluates to `true`, then this binding applies to the current + request. If the condition evaluates to `false`, then this binding + does not apply to the current request. However, a different role + binding might grant the same role to one or more of the principals + in this binding. To learn which resources support conditions in + their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + $ref: '#/components/schemas/GoogleTypeExpr' + GoogleTypeExpr: + id: GoogleTypeExpr description: >- - The data for an intent. Represents a detected intent in the - conversation, for example MAKES_PROMISE. - GoogleCloudContactcenterinsightsV1alpha1SentimentData: - id: GoogleCloudContactcenterinsightsV1alpha1SentimentData + 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. type: object properties: - score: - format: float - description: The sentiment score between -1.0 (negative) and 1.0 (positive). - type: number - magnitude: + expression: description: >- - A non-negative number from 0 to infinity which represents the - abolute magnitude of sentiment regardless of score. - type: number - format: float - description: The data for a sentiment annotation. - GoogleCloudContactcenterinsightsV1SentimentData: - id: GoogleCloudContactcenterinsightsV1SentimentData - properties: - magnitude: + Textual representation of an expression in Common Expression + Language syntax. + type: string + title: description: >- - A non-negative number from 0 to infinity which represents the - abolute magnitude of sentiment regardless of score. - format: float - type: number - score: - format: float - type: number - description: The sentiment score between -1.0 (negative) and 1.0 (positive). - description: The data for a sentiment annotation. + 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 + 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 + 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 + GoogleIamV1AuditConfig: + id: GoogleIamV1AuditConfig + 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. type: object - GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats: properties: - labeledConversationsCount: - format: int64 - description: Number of conversations attached to the issue at this point in time. - type: string - displayName: + 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 - description: Display name of the issue. - issue: + auditLogConfigs: + description: The configuration for logging of each type of permission. + type: array + items: + $ref: '#/components/schemas/GoogleIamV1AuditLogConfig' + GoogleIamV1AuditLogConfig: + id: GoogleIamV1AuditLogConfig + 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. + type: object + properties: + logType: + description: The log type that this config enables. type: string + enumDescriptions: + - Default case. Should never be this. + - 'Admin reads. Example: CloudIAM getIamPolicy' + - 'Data writes. Example: CloudSQL Users create' + - 'Data reads. Example: CloudSQL Users list' + enum: + - LOG_TYPE_UNSPECIFIED + - ADMIN_READ + - DATA_WRITE + - DATA_READ + exemptedMembers: description: >- - Issue resource. Format: - projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue} + Specifies the identities that do not cause logging for this type of + permission. Follows the same format of Binding.members. + type: array + items: + type: string + GoogleIamV1TestIamPermissionsRequest: + id: GoogleIamV1TestIamPermissionsRequest + description: Request message for `TestIamPermissions` method. + type: object + properties: + permissions: + description: >- + The set of permissions to check for the `resource`. Permissions with + wildcards (such as `*` or `storage.*`) are not allowed. For more + information see [IAM + Overview](https://cloud.google.com/iam/docs/overview#permissions). + type: array + items: + type: string + GoogleIamV1TestIamPermissionsResponse: + id: GoogleIamV1TestIamPermissionsResponse + description: Response message for `TestIamPermissions` method. + type: object + properties: + permissions: + description: >- + A subset of `TestPermissionsRequest.permissions` that the caller is + allowed. + type: array + items: + type: string + GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsMetadata: + id: GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsMetadata + description: The metadata for a bulk analyze conversations operation. type: object - description: Aggregated statistics about an issue. - id: GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats - GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecMetadata: properties: createTime: - format: google-datetime - readOnly: true + description: The time the operation was created. type: string - description: Output only. The time the operation was created. + format: google-datetime endTime: + description: The time the operation finished running. + type: string format: google-datetime + request: + description: The original request for bulk analyze. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest + completedAnalysesCount: + description: >- + The number of requested analyses that have completed successfully so + far. + type: integer + format: int32 + failedAnalysesCount: + description: The number of requested analyses that have failed so far. + type: integer + format: int32 + totalRequestedAnalysesCount: + description: >- + Total number of analyses requested. Computed by the number of + conversations returned by `filter` multiplied by + `analysis_percentage` in the request. + type: integer + format: int32 + partialErrors: + description: >- + Output only. Partial errors during bulk analyze operation that might + cause the operation output to be incomplete. readOnly: true - description: Output only. The time the operation finished running. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsResponse: + id: GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsResponse + description: The response for a bulk analyze conversations operation. + type: object + properties: + successfulAnalysisCount: + description: Count of successful analyses. + type: integer + format: int32 + failedAnalysisCount: + description: Count of failed analyses. + type: integer + format: int32 + GoogleCloudContactcenterinsightsV1BulkDeleteConversationsMetadata: + id: GoogleCloudContactcenterinsightsV1BulkDeleteConversationsMetadata + description: The metadata for a bulk delete conversations operation. + type: object + properties: + createTime: + description: The time the operation was created. + type: string + format: google-datetime + endTime: + description: The time the operation finished running. type: string + format: google-datetime request: - description: Output only. The original request for initialization. + description: The original request for bulk delete. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest + #/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest + partialErrors: + description: >- + Partial errors during bulk delete conversations operation that might + cause the operation output to be incomplete. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudContactcenterinsightsV1BulkDeleteConversationsResponse: + id: GoogleCloudContactcenterinsightsV1BulkDeleteConversationsResponse + description: The response for a bulk delete conversations operation. + type: object + properties: {} + GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsMetadata: + id: GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsMetadata + description: Metadata for the BulkDeleteFeedbackLabels endpoint. + type: object + properties: + request: + description: Output only. The original request for delete. readOnly: true + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsRequest partialErrors: description: >- - Partial errors during initializing operation that might cause the + Partial errors during deletion operation that might cause the operation output to be incomplete. type: array items: $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsResponse: + id: GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsResponse + description: Response for the BulkDeleteFeedbackLabels endpoint. type: object - description: Metadata for initializing a location-level encryption specification. - id: GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecMetadata - GoogleCloudContactcenterinsightsV1alpha1UploadConversationMetadata: - id: GoogleCloudContactcenterinsightsV1alpha1UploadConversationMetadata + properties: {} + GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadata: + id: GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadata + description: Metadata for the BulkDownloadFeedbackLabel endpoint. type: object properties: createTime: description: Output only. The time the operation was created. readOnly: true - format: google-datetime type: string + format: google-datetime endTime: description: Output only. The time the operation finished running. - format: google-datetime - type: string readOnly: true + type: string + format: google-datetime request: - description: Output only. The original request. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest - readOnly: true - analysisOperation: + description: Output only. The original request for download. readOnly: true - type: string - description: >- - Output only. The operation name for a successfully created analysis - operation, if any. - appliedRedactionConfig: - description: >- - Output only. The redaction config applied to the uploaded - conversation. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RedactionConfig + #/components/schemas/GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequest + partialErrors: + description: >- + Partial errors during ingest operation that might cause the + operation output to be incomplete. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + downloadStats: + description: Output only. Statistics for BulkDownloadFeedbackLabels operation. readOnly: true - description: The metadata for an `UploadConversation` operation. - GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelResponse: - properties: {} + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadataDownloadStats + GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadataDownloadStats: + id: >- + GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadataDownloadStats + description: Statistics for BulkDownloadFeedbackLabels operation. type: object - description: The response to deploy an issue model. - id: GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelResponse - GoogleCloudContactcenterinsightsV1EncryptionSpec: - id: GoogleCloudContactcenterinsightsV1EncryptionSpec properties: - name: - description: >- - Immutable. The resource name of the encryption key specification - resource. Format: - projects/{project}/locations/{location}/encryptionSpec - type: string - kmsKey: - type: string + processedObjectCount: + description: The number of objects processed during the download operation. + type: integer + format: int32 + successfulDownloadCount: description: >- - Required. The name of customer-managed encryption key that is used - to secure a resource and its sub-resources. If empty, the resource - is secured by our default encryption key. Only the key in the same - location as this resource is allowed to be used for encryption. - Format: - `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}` - description: >- - A customer-managed encryption key specification that can be applied to - all created resources (e.g. `Conversation`). + The number of new feedback labels downloaded during this operation. + Different from "processed" because some labels might not be + downloaded because an error. + type: integer + format: int32 + totalFilesWritten: + description: Total number of files written to the provided Cloud Storage bucket. + type: integer + format: int32 + fileNames: + description: Output only. Full name of the files written to Cloud storage. + readOnly: true + type: array + items: + type: string + GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsResponse: + id: GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsResponse + description: Response for the BulkDownloadFeedbackLabel endpoint. type: object - GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats: - id: GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats + properties: {} + GoogleCloudContactcenterinsightsV1CreateAnalysisOperationMetadata: + id: GoogleCloudContactcenterinsightsV1CreateAnalysisOperationMetadata + description: Metadata for a create analysis operation. type: object - description: Aggregated statistics about an issue model. properties: - issueStats: - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats - description: Statistics on each issue. Key is the issue's resource name. - type: object - analyzedConversationsCount: + createTime: + description: Output only. The time the operation was created. + readOnly: true type: string - format: int64 - description: >- - Number of conversations the issue model has analyzed at this point - in time. - unclassifiedConversationsCount: + format: google-datetime + endTime: + description: Output only. The time the operation finished running. + readOnly: true + type: string + format: google-datetime + conversation: description: >- - Number of analyzed conversations for which no issue was applicable - at this point in time. + Output only. The Conversation that this Analysis Operation belongs + to. + readOnly: true type: string - format: int64 - GoogleCloudContactcenterinsightsV1QaAnswer: - description: An answer to a QaQuestion. - id: GoogleCloudContactcenterinsightsV1QaAnswer + annotatorSelector: + description: Output only. The annotator selector used for the analysis (if any). + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelector + GoogleCloudContactcenterinsightsV1CreateIssueMetadata: + id: GoogleCloudContactcenterinsightsV1CreateIssueMetadata + description: Metadata for creating an issue. type: object properties: - tags: - description: >- - User-defined list of arbitrary tags. Matches the value from - QaScorecard.ScorecardQuestion.tags. Used for grouping/organization - and for weighting the score of each answer. - type: array - items: - type: string - conversation: + createTime: + description: Output only. The time the operation was created. + readOnly: true type: string - description: The conversation the answer applies to. - answerSources: - description: List of all individual answers given to the question. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1QaAnswerAnswerSource - answerValue: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue - description: The main answer value, incorporating any manual edits if they exist. - qaQuestion: + format: google-datetime + endTime: + description: Output only. The time the operation finished running. + readOnly: true type: string - description: The QaQuestion answered by this answer. - potentialScore: - deprecated: true - type: number - format: double - description: >- - The maximum potential score of the question. If the question was - answered using `na_value`, this field will be zero. Deprecated: Use - AnswerValue.potential_score instead. - questionBody: - description: Question text. E.g., "Did the agent greet the customer?" + format: google-datetime + request: + description: The original request for creation. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1CreateIssueRequest + GoogleCloudContactcenterinsightsV1CreateIssueRequest: + id: GoogleCloudContactcenterinsightsV1CreateIssueRequest + description: The request to create an issue. + type: object + properties: + parent: + description: Required. The parent resource of the issue. type: string - GoogleCloudContactcenterinsightsV1PhraseMatchData: - id: GoogleCloudContactcenterinsightsV1PhraseMatchData + issue: + description: Required. The values for the new issue. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Issue' + GoogleCloudContactcenterinsightsV1CreateIssueModelMetadata: + id: GoogleCloudContactcenterinsightsV1CreateIssueModelMetadata + description: Metadata for creating an issue model. + type: object properties: - phraseMatcher: + createTime: + description: Output only. The time the operation was created. + readOnly: true type: string - description: The unique identifier (the resource name) of the phrase matcher. - displayName: - description: The human-readable name of the phrase matcher. + format: google-datetime + endTime: + description: Output only. The time the operation finished running. + readOnly: true type: string - type: object - description: >- - The data for a matched phrase matcher. Represents information - identifying a phrase matcher for a given match. - GoogleLongrunningListOperationsResponse: - description: The response message for Operations.ListOperations. - id: GoogleLongrunningListOperationsResponse + format: google-datetime + request: + description: The original request for creation. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1CreateIssueModelRequest + GoogleCloudContactcenterinsightsV1CreateIssueModelRequest: + id: GoogleCloudContactcenterinsightsV1CreateIssueModelRequest + description: The request to create an issue model. type: object properties: - operations: - type: array - description: >- - A list of operations that matches the specified filter in the - request. - items: - $ref: '#/components/schemas/GoogleLongrunningOperation' - nextPageToken: + parent: + description: Required. The parent resource of the issue model. type: string - description: The standard List next-page token. - GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig: + issueModel: + description: Required. The issue model to create. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel' + GoogleCloudContactcenterinsightsV1DeleteIssueModelMetadata: + id: GoogleCloudContactcenterinsightsV1DeleteIssueModelMetadata + description: Metadata for deleting an issue model. type: object - id: >- - GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig properties: - summarizationModel: + createTime: + description: Output only. The time the operation was created. + readOnly: true type: string - enumDescriptions: - - Unspecified summarization model. - - The CCAI baseline model. - - The CCAI baseline model, V2.0. - description: Default summarization model to be used. - enum: - - SUMMARIZATION_MODEL_UNSPECIFIED - - BASELINE_MODEL - - BASELINE_MODEL_V2_0 - conversationProfile: - description: >- - Resource name of the Dialogflow conversation profile. Format: - projects/{project}/locations/{location}/conversationProfiles/{conversation_profile} + format: google-datetime + endTime: + description: Output only. The time the operation finished running. + readOnly: true type: string - description: Configuration for summarization. - GoogleCloudContactcenterinsightsV1RuntimeAnnotationUserInput: + format: google-datetime + request: + description: The original request for deletion. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest + GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest: + id: GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest + description: The request to delete an issue model. + type: object properties: - query: + name: + description: Required. The name of the issue model to delete. type: string - description: >- - Query text. Article Search uses this to store the input query used - to generate the search results. - querySource: - enumDescriptions: - - Unknown query source. - - The query is from agents. - - >- - The query is a query from previous suggestions, e.g. from a - preceding SuggestKnowledgeAssist response. - enum: - - QUERY_SOURCE_UNSPECIFIED - - AGENT_QUERY - - SUGGESTED_QUERY - description: Query source for the answer. + GoogleCloudContactcenterinsightsV1DeleteQaQuestionTagMetadata: + id: GoogleCloudContactcenterinsightsV1DeleteQaQuestionTagMetadata + description: The metadata for deleting a QaQuestionTag Resource. + type: object + properties: + createTime: + description: Output only. The time the operation was created. + readOnly: true type: string - generatorName: - description: >- - The resource name of associated generator. Format: - `projects//locations//generators/` + format: google-datetime + endTime: + description: Output only. The time the operation finished running. + readOnly: true type: string + format: google-datetime + request: + description: Output only. The original request. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1DeleteQaQuestionTagRequest + GoogleCloudContactcenterinsightsV1DeleteQaQuestionTagRequest: + id: GoogleCloudContactcenterinsightsV1DeleteQaQuestionTagRequest + description: The request for deleting a QaQuestionTag. type: object - description: Explicit input used for generating the answer - id: GoogleCloudContactcenterinsightsV1RuntimeAnnotationUserInput - GoogleCloudContactcenterinsightsV1UndeployIssueModelResponse: - type: object - id: GoogleCloudContactcenterinsightsV1UndeployIssueModelResponse - description: The response to undeploy an issue model. - properties: {} - GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsResponse: - id: GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsResponse properties: - failedAnalysisCount: - description: Count of failed analyses. - format: int32 - type: integer - successfulAnalysisCount: - type: integer - format: int32 - description: Count of successful analyses. - description: The response for a bulk analyze conversations operation. - type: object - GoogleCloudContactcenterinsightsV1PhraseMatchRuleConfig: + name: + description: Required. The name of the QaQuestionTag to delete. + type: string + GoogleCloudContactcenterinsightsV1DeployIssueModelMetadata: + id: GoogleCloudContactcenterinsightsV1DeployIssueModelMetadata + description: Metadata for deploying an issue model. type: object - id: GoogleCloudContactcenterinsightsV1PhraseMatchRuleConfig - description: Configuration information of a phrase match rule. - properties: - exactMatchConfig: - description: The configuration for the exact match rule. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ExactMatchConfig - GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeries: - id: GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeries properties: - points: - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeriesInterval - description: >- - An ordered list of intervals from earliest to latest, where each - interval represents the number of conversations that transpired - during the time window. - type: array - intervalDuration: - format: google-duration + createTime: + description: Output only. The time the operation was created. + readOnly: true type: string - description: The duration of each interval. - description: A time series representing conversations over time. + format: google-datetime + endTime: + description: Output only. The time the operation finished running. + readOnly: true + type: string + format: google-datetime + request: + description: The original request for deployment. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1DeployIssueModelRequest + GoogleCloudContactcenterinsightsV1DeployIssueModelResponse: + id: GoogleCloudContactcenterinsightsV1DeployIssueModelResponse + description: The response to deploy an issue model. type: object - GoogleCloudContactcenterinsightsV1ConversationCallMetadata: - description: Call-specific metadata. + properties: {} + GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata: + id: GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata + description: Metadata for an export insights operation. type: object properties: - customerChannel: - type: integer - format: int32 - description: The audio channel that contains the customer. - agentChannel: - format: int32 - type: integer - description: The audio channel that contains the agent. - id: GoogleCloudContactcenterinsightsV1ConversationCallMetadata - GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest: - id: GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest - properties: - createNewModel: - type: boolean - description: >- - Optional. If set to true, will create an issue model from the - imported file with randomly generated IDs for the issue model and - corresponding issues. Otherwise, replaces an existing model with the - same ID as the file. - gcsSource: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource - description: Google Cloud Storage source message. - parent: - description: Required. The parent resource of the issue model. + createTime: + description: Output only. The time the operation was created. + readOnly: true type: string - type: object - description: Request to import an issue model. - GoogleCloudContactcenterinsightsV1ConversationQualityMetadata: - properties: - waitDuration: + format: google-datetime + endTime: + description: Output only. The time the operation finished running. + readOnly: true type: string - format: google-duration - description: The amount of time the customer waited to connect with an agent. - agentInfo: - description: Information about agents involved in the call. + format: google-datetime + request: + description: The original request for export. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest + partialErrors: + description: >- + Partial errors during export operation that might cause the + operation output to be incomplete. type: array items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo - customerSatisfactionRating: + $ref: '#/components/schemas/GoogleRpcStatus' + completedExportCount: + description: The number of conversations that were exported successfully. type: integer format: int32 - description: >- - An arbitrary integer value indicating the customer's satisfaction - rating. - menuPath: - description: >- - An arbitrary string value specifying the menu path the customer - took. - type: string + failedExportCount: + description: The number of conversations that failed to be exported. + type: integer + format: int32 + GoogleCloudContactcenterinsightsV1ExportInsightsDataResponse: + id: GoogleCloudContactcenterinsightsV1ExportInsightsDataResponse + description: Response for an export insights operation. type: object - id: GoogleCloudContactcenterinsightsV1ConversationQualityMetadata - description: Conversation metadata related to quality management. - GoogleCloudContactcenterinsightsV1ExportIssueModelResponse: properties: {} - description: Response from export issue model - id: GoogleCloudContactcenterinsightsV1ExportIssueModelResponse - type: object - GoogleCloudContactcenterinsightsV1IssueModelResult: + GoogleCloudContactcenterinsightsV1ExportIssueModelMetadata: + id: GoogleCloudContactcenterinsightsV1ExportIssueModelMetadata + description: Metadata used for export issue model. type: object - description: Issue Modeling result on a conversation. properties: - issueModel: + createTime: + description: The time the operation was created. type: string - description: >- - Issue model that generates the result. Format: - projects/{project}/locations/{location}/issueModels/{issue_model} - issues: - description: All the matched issues. - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueAssignment - type: array - id: GoogleCloudContactcenterinsightsV1IssueModelResult - GoogleCloudContactcenterinsightsV1QaScorecardResultQaTagResult: - type: object - description: Tags and their corresponding results. - properties: - potentialScore: - description: The potential score the tag applies to. - format: double - type: number - score: - description: The score the tag applies to. - format: double - type: number - normalizedScore: - format: double - description: The normalized score the tag applies to. - type: number - tag: - description: The tag the score applies to. + format: google-datetime + endTime: + description: The time the operation finished running. type: string - id: GoogleCloudContactcenterinsightsV1QaScorecardResultQaTagResult - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsResponse: + format: google-datetime + request: + description: The original export request. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ExportIssueModelRequest + GoogleCloudContactcenterinsightsV1ExportIssueModelResponse: + id: GoogleCloudContactcenterinsightsV1ExportIssueModelResponse + description: Response from export issue model + type: object properties: {} + GoogleCloudContactcenterinsightsV1ImportIssueModelMetadata: + id: GoogleCloudContactcenterinsightsV1ImportIssueModelMetadata + description: Metadata used for import issue model. type: object - id: GoogleCloudContactcenterinsightsV1alpha1IngestConversationsResponse - description: The response to an IngestConversations operation. - GoogleCloudContactcenterinsightsV1DialogflowIntent: - id: GoogleCloudContactcenterinsightsV1DialogflowIntent properties: - displayName: + createTime: + description: The time the operation was created. type: string - description: The human-readable name of the intent. - description: >- - The data for a Dialogflow intent. Represents a detected intent in the - conversation, e.g. MAKES_PROMISE. + format: google-datetime + endTime: + description: The time the operation finished running. + type: string + format: google-datetime + request: + description: The original import request. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ImportIssueModelRequest + GoogleCloudContactcenterinsightsV1ImportIssueModelResponse: + id: GoogleCloudContactcenterinsightsV1ImportIssueModelResponse + description: Response from import issue model type: object - GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataMetadata: - description: Metadata for an export insights operation. + properties: + issueModel: + description: The issue model that was imported. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel' + GoogleCloudContactcenterinsightsV1IngestConversationsMetadata: + id: GoogleCloudContactcenterinsightsV1IngestConversationsMetadata + description: The metadata for an IngestConversations operation. type: object properties: - partialErrors: - type: array - items: - $ref: '#/components/schemas/GoogleRpcStatus' - description: >- - Partial errors during export operation that might cause the - operation output to be incomplete. - request: - description: The original request for export. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest createTime: - type: string - format: google-datetime description: Output only. The time the operation was created. readOnly: true - endTime: + type: string format: google-datetime + endTime: description: Output only. The time the operation finished running. readOnly: true type: string - id: GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataMetadata - GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadata: - properties: - downloadStats: + format: google-datetime + request: + description: Output only. The original request for ingest. readOnly: true $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadataDownloadStats - description: Output only. Statistics for BulkDownloadFeedbackLabels operation. + #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequest partialErrors: + description: >- + Output only. Partial errors during ingest operation that might cause + the operation output to be incomplete. + readOnly: true + type: array items: $ref: '#/components/schemas/GoogleRpcStatus' - type: array + ingestConversationsStats: + description: Output only. Statistics for IngestConversations operation. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats + sampledConversations: description: >- - Partial errors during ingest operation that might cause the - operation output to be incomplete. + Output only. Stores the conversation resources produced by ingest + sampling operations. + readOnly: true + type: array + items: + type: string + GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats: + id: >- + GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats + description: Statistics for IngestConversations operation. + type: object + properties: + processedObjectCount: + description: >- + Output only. The number of objects processed during the ingest + operation. + readOnly: true + type: integer + format: int32 + duplicatesSkippedCount: + description: >- + Output only. The number of objects skipped because another + conversation with the same transcript uri had already been ingested. + readOnly: true + type: integer + format: int32 + successfulIngestCount: + description: >- + Output only. The number of new conversations added during this + ingest operation. + readOnly: true + type: integer + format: int32 + failedIngestCount: + description: >- + Output only. The number of objects which were unable to be ingested + due to errors. The errors are populated in the partial_errors field. + readOnly: true + type: integer + format: int32 + GoogleCloudContactcenterinsightsV1IngestConversationsResponse: + id: GoogleCloudContactcenterinsightsV1IngestConversationsResponse + description: The response to an IngestConversations operation. + type: object + properties: {} + GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecMetadata: + id: GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecMetadata + description: Metadata for initializing a location-level encryption specification. + type: object + properties: createTime: + description: Output only. The time the operation was created. + readOnly: true + type: string format: google-datetime + endTime: + description: Output only. The time the operation finished running. readOnly: true type: string - description: Output only. The time the operation was created. + format: google-datetime request: + description: Output only. The original request for initialization. readOnly: true - description: Output only. The original request for download. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequest - endTime: - readOnly: true - format: google-datetime - description: Output only. The time the operation finished running. - type: string - description: Metadata for the BulkDownloadFeedbackLabel endpoint. - id: GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadata - type: object - GoogleCloudContactcenterinsightsV1alpha1QueryMetricsMetadata: + #/components/schemas/GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest + partialErrors: + description: >- + Partial errors during initializing operation that might cause the + operation output to be incomplete. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecResponse: + id: GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecResponse + description: The response to initialize a location-level encryption specification. type: object properties: {} - id: GoogleCloudContactcenterinsightsV1alpha1QueryMetricsMetadata + GoogleCloudContactcenterinsightsV1QueryMetricsMetadata: + id: GoogleCloudContactcenterinsightsV1QueryMetricsMetadata description: The metadata from querying metrics. - GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback: + type: object properties: - displayed: + resultIsTruncated: description: >- - Indicates whether an answer or item was displayed to the human agent - in the agent desktop UI. - type: boolean - correctnessLevel: - description: The correctness level of an answer. - enumDescriptions: - - Correctness level unspecified. - - Answer is totally wrong. - - Answer is partially correct. - - Answer is fully correct. - enum: - - CORRECTNESS_LEVEL_UNSPECIFIED - - NOT_CORRECT - - PARTIALLY_CORRECT - - FULLY_CORRECT - type: string - clicked: - description: Indicates whether an answer or item was clicked by the human agent. + Whether the result rows were truncated because the result row size + is too large to materialize. type: boolean - id: GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback + GoogleCloudContactcenterinsightsV1QueryMetricsResponse: + id: GoogleCloudContactcenterinsightsV1QueryMetricsResponse + description: The response for querying metrics. type: object + properties: + location: + description: >- + Required. The location of the data. + "projects/{project}/locations/{location}" + type: string + updateTime: + description: The metrics last update time. + type: string + format: google-datetime + slices: + description: >- + A slice contains a total and (if the request specified a time + granularity) a time series of metric values. Each slice contains a + unique combination of the cardinality of dimensions from the + request. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsResponseSlice + macroAverageSlice: + description: >- + The macro average slice contains aggregated averages across the + selected dimension. i.e. if group_by agent is specified this field + will contain the average across all agents. This field is only + populated if the request specifies a Dimension. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsResponseSlice + GoogleCloudContactcenterinsightsV1QueryMetricsResponseSlice: + id: GoogleCloudContactcenterinsightsV1QueryMetricsResponseSlice description: >- - The feedback that the customer has about a certain answer in the - conversation. - GoogleCloudContactcenterinsightsV1SilenceData: + A slice contains a total and (if the request specified a time + granularity) a time series of metric values. Each slice contains a + unique combination of the cardinality of dimensions from the request. + For example, if the request specifies a single ISSUE dimension and it + has a cardinality of 2 (i.e. the data used to compute the metrics has 2 + issues in total), the response will have 2 slices: * Slice 1 -> + dimensions=[Issue 1] * Slice 2 -> dimensions=[Issue 2] type: object - id: GoogleCloudContactcenterinsightsV1SilenceData - properties: {} - description: The data for a silence annotation. - GoogleCloudContactcenterinsightsV1Entity: + properties: + dimensions: + description: A unique combination of dimensions that this slice represents. + type: array + items: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Dimension' + total: + description: >- + The total metric value. The interval of this data point is [starting + create time, ending create time) from the request. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPoint + timeSeries: + description: >- + A time series of metric values. This is only populated if the + request specifies a time granularity other than NONE. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceTimeSeries + GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPoint: + id: GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPoint + description: A data point contains the metric values mapped to an interval. type: object - id: GoogleCloudContactcenterinsightsV1Entity properties: - sentiment: + conversationMeasure: + description: The measure related to conversations. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure + interval: description: >- - The aggregate sentiment expressed for this entity in the - conversation. - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData' - salience: + The interval that this data point represents. * If this is the total + data point, the interval is [starting create time, ending create + time) from the request. * If this a data point from the time series, + the interval is [time, time + time granularity from the request). + $ref: '#/components/schemas/GoogleTypeInterval' + GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure: + id: >- + GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure + description: The measure related to conversations. + type: object + properties: + conversationCount: + description: The conversation count. + type: integer + format: int32 + averageSilencePercentage: + description: The average silence percentage. type: number format: float - description: >- - The salience score associated with the entity in the [0, 1.0] range. - The salience score for an entity provides information about the - importance or centrality of that entity to the entire document text. - Scores closer to 0 are less salient, while scores closer to 1.0 are - highly salient. - displayName: + averageDuration: + description: The average duration. type: string - description: The representative name for the entity. - metadata: - additionalProperties: - type: string + format: google-duration + averageTurnCount: + description: The average turn count. + type: number + format: float + averageAgentSentimentScore: + description: The average agent's sentiment score. + type: number + format: float + averageClientSentimentScore: + description: The average client's sentiment score. + type: number + format: float + averageCustomerSatisfactionRating: + description: The average customer satisfaction rating. + type: number + format: double + averageQaNormalizedScore: description: >- - Metadata associated with the entity. For most entity types, the - metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph - MID (`mid`), if they are available. For the metadata associated with - other entity types, see the Type table below. - type: object - type: - description: The entity type. - enum: - - TYPE_UNSPECIFIED - - PERSON - - LOCATION - - ORGANIZATION - - EVENT - - WORK_OF_ART - - CONSUMER_GOOD - - OTHER - - PHONE_NUMBER - - ADDRESS - - DATE - - NUMBER - - PRICE - enumDescriptions: - - Unspecified. - - Person. - - Location. - - Organization. - - Event. - - Artwork. - - Consumer product. - - Other types of entities. - - >- - Phone number. The metadata lists the phone number (formatted - according to local convention), plus whichever additional elements - appear in the text: * `number` - The actual number, broken down - into sections according to local convention. * `national_prefix` - - Country code, if detected. * `area_code` - Region or area code, if - detected. * `extension` - Phone extension (to be dialed after - connection), if detected. - - >- - Address. The metadata identifies the street number and locality - plus whichever additional elements appear in the text: * - `street_number` - Street number. * `locality` - City or town. * - `street_name` - Street/route name, if detected. * `postal_code` - - Postal code, if detected. * `country` - Country, if detected. * - `broad_region` - Administrative area, such as the state, if - detected. * `narrow_region` - Smaller administrative area, such as - county, if detected. * `sublocality` - Used in Asian addresses to - demark a district within a city, if detected. - - >- - Date. The metadata identifies the components of the date: * `year` - - Four digit year, if detected. * `month` - Two digit month - number, if detected. * `day` - Two digit day number, if detected. - - Number. The metadata is the number itself. - - Price. The metadata identifies the `value` and `currency`. - type: string - description: >- - The data for an entity annotation. Represents a phrase in the - conversation that is a known entity, such as a person, an organization, - or location. - GoogleCloudContactcenterinsightsV1IssueMatchData: - properties: - issueAssignment: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueAssignment - description: Information about the issue's assignment. - id: GoogleCloudContactcenterinsightsV1IssueMatchData - description: The data for an issue match annotation. + Average QA normalized score. Will exclude 0's in average + calculation. + type: number + format: double + qaTagScores: + description: Average QA normalized score for all the tags. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore + averageQaQuestionNormalizedScore: + description: >- + Average QA normalized score averaged for questions averaged across + all revisions of the parent scorecard. Will be only populated if the + request specifies a dimension of QA_QUESTION_ID. + type: number + format: double + GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore: + id: >- + GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore + description: Average QA normalized score for the tag. type: object - GoogleCloudContactcenterinsightsV1SmartReplyData: - id: GoogleCloudContactcenterinsightsV1SmartReplyData - description: Agent Assist Smart Reply data. properties: - metadata: - additionalProperties: - type: string - description: >- - Map that contains metadata about the Smart Reply and the document - from which it originates. - type: object - reply: - description: The content of the reply. + tag: + description: Tag name. type: string - confidenceScore: + averageTagNormalizedScore: + description: Average tag normalized score per tag. type: number format: double + GoogleTypeInterval: + id: GoogleTypeInterval + description: >- + Represents a time interval, encoded as a Timestamp start (inclusive) and + a Timestamp end (exclusive). The start must be less than or equal to the + end. When the start equals the end, the interval is empty (matches no + time). When both start and end are unspecified, the interval matches any + time. + type: object + properties: + startTime: description: >- - The system's confidence score that this reply is a good match for - this conversation, ranging from 0.0 (completely uncertain) to 1.0 - (completely certain). - queryRecord: + Optional. Inclusive start of the interval. If specified, a Timestamp + matching this interval will have to be the same or after the start. type: string + format: google-datetime + endTime: description: >- - The name of the answer record. Format: - projects/{project}/locations/{location}/answerRecords/{answer_record} - type: object - GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript: + Optional. Exclusive end of the interval. If specified, a Timestamp + matching this interval will have to be before the end. + type: string + format: google-datetime + GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceTimeSeries: + id: GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceTimeSeries + description: A time series of metric values. type: object - description: A message representing the transcript of a conversation. - id: GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript properties: - transcriptSegments: - description: >- - A list of sequential transcript segments that comprise the - conversation. + dataPoints: + description: The data points that make up the time series . type: array items: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment - GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest: + #/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPoint + GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewMetadata: + id: GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewMetadata + description: The metadata for querying performance overview. + type: object + properties: {} + GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewResponse: + id: GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewResponse + description: The response for querying performance overview. type: object - id: GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest properties: - filter: - description: >- - A filter to reduce results to a specific subset. Useful for - exporting conversations with specific properties. - type: string - writeDisposition: - enumDescriptions: - - Write disposition is not specified. Defaults to WRITE_TRUNCATE. - - >- - If the table already exists, BigQuery will overwrite the table - data and use the schema from the load. - - >- - If the table already exists, BigQuery will append data to the - table. - enum: - - WRITE_DISPOSITION_UNSPECIFIED - - WRITE_TRUNCATE - - WRITE_APPEND - description: Options for what to do if the destination table already exists. + summaryText: + description: The summary text of the performance. type: string - kmsKey: - type: string - description: >- - A fully qualified KMS key name for BigQuery tables protected by - CMEK. Format: - projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version} - parent: - type: string - description: Required. The parent resource to export data from. - bigQueryDestination: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination - description: Specified if sink is a BigQuery table. - description: The request to export insights. - GoogleCloudContactcenterinsightsV1IngestConversationsMetadata: - description: The metadata for an IngestConversations operation. - id: GoogleCloudContactcenterinsightsV1IngestConversationsMetadata + GoogleCloudContactcenterinsightsV1SampleConversationsMetadata: + id: GoogleCloudContactcenterinsightsV1SampleConversationsMetadata + description: The metadata for an SampleConversations operation. + type: object properties: createTime: description: Output only. The time the operation was created. readOnly: true - format: google-datetime type: string + format: google-datetime endTime: + description: Output only. The time the operation finished running. readOnly: true type: string - description: Output only. The time the operation finished running. format: google-datetime request: + description: >- + Output only. The original request for sample conversations to + dataset. readOnly: true - description: Output only. The original request for ingest. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequest - ingestConversationsStats: - description: Output only. Statistics for IngestConversations operation. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats - readOnly: true + #/components/schemas/GoogleCloudContactcenterinsightsV1SampleConversationsRequest partialErrors: + description: >- + Output only. Partial errors during sample conversations operation + that might cause the operation output to be incomplete. + readOnly: true type: array items: $ref: '#/components/schemas/GoogleRpcStatus' - description: >- - Output only. Partial errors during ingest operation that might cause - the operation output to be incomplete. + sampleConversationsStats: + description: Output only. Statistics for SampleConversations operation. readOnly: true - type: object - GoogleCloudContactcenterinsightsV1CreateIssueModelRequest: - description: The request to create an issue model. - type: object - id: GoogleCloudContactcenterinsightsV1CreateIssueModelRequest - properties: - issueModel: - description: Required. The issue model to create. - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel' - parent: - description: Required. The parent resource of the issue model. - type: string - GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata: - description: Metadata from Dialogflow relating to the current transcript segment. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1SampleConversationsMetadataSampleConversationsStats + GoogleCloudContactcenterinsightsV1SampleConversationsMetadataSampleConversationsStats: id: >- - GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata + GoogleCloudContactcenterinsightsV1SampleConversationsMetadataSampleConversationsStats + description: Statistics for SampleConversations operation. type: object properties: - smartReplyAllowlistCovered: - description: >- - Whether the transcript segment was covered under the configured - smart reply allowlist in Agent Assist. - type: boolean - GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment: - properties: - languageCode: - type: string - description: >- - The language code of this segment as a - [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. - Example: "en-US". - dialogflowSegmentMetadata: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata - description: CCAI metadata relating to the current transcript segment. - sentiment: - description: The sentiment for this transcript segment. - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData' - words: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo + successfulSampleCount: description: >- - A list of the word-specific information for each word in the - segment. - segmentParticipant: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationParticipant - description: The participant of this segment. - channelTag: + Output only. The number of new conversations added during this + sample operation. + readOnly: true + type: integer + format: int32 + failedSampleCount: description: >- - For conversations derived from multi-channel audio, this is the - channel number corresponding to the audio from that channel. For - audioChannelCount = N, its output values can range from '1' to 'N'. - A channel tag of 0 indicates that the audio is mono. + Output only. The number of objects which were unable to be sampled + due to errors. The errors are populated in the partial_errors field. + readOnly: true type: integer format: int32 - text: - description: The text of this segment. + GoogleCloudContactcenterinsightsV1SampleConversationsResponse: + id: GoogleCloudContactcenterinsightsV1SampleConversationsResponse + description: The response to an SampleConversations operation. + type: object + properties: {} + GoogleCloudContactcenterinsightsV1UndeployIssueModelMetadata: + id: GoogleCloudContactcenterinsightsV1UndeployIssueModelMetadata + description: Metadata for undeploying an issue model. + type: object + properties: + createTime: + description: Output only. The time the operation was created. + readOnly: true type: string - confidence: - description: >- - A confidence estimate between 0.0 and 1.0 of the fidelity of this - segment. A default value of 0.0 indicates that the value is unset. - type: number - format: float - messageTime: format: google-datetime + endTime: + description: Output only. The time the operation finished running. + readOnly: true type: string - description: The time that the message occurred, if provided. - id: >- - GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment - description: A segment of a full transcript. + format: google-datetime + request: + description: The original request for undeployment. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest + GoogleCloudContactcenterinsightsV1UndeployIssueModelResponse: + id: GoogleCloudContactcenterinsightsV1UndeployIssueModelResponse + description: The response to undeploy an issue model. + type: object + properties: {} + GoogleCloudContactcenterinsightsV1UpdateQaQuestionTagMetadata: + id: GoogleCloudContactcenterinsightsV1UpdateQaQuestionTagMetadata + description: The metadata for updating a QaQuestionTag Resource. type: object - GoogleCloudContactcenterinsightsV1SettingsAnalysisConfig: - description: Default configuration when creating Analyses in Insights. properties: - annotatorSelector: + createTime: + description: Output only. The time the operation was created. + readOnly: true + type: string + format: google-datetime + endTime: + description: Output only. The time the operation finished running. + readOnly: true + type: string + format: google-datetime + request: + description: Output only. The original request. + readOnly: true $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelector - description: >- - To select the annotators to run and the phrase matchers to use (if - any). If not specified, all annotators will be run. - runtimeIntegrationAnalysisPercentage: - description: >- - Percentage of conversations created using Dialogflow runtime - integration to analyze automatically, between [0, 100]. - format: double - type: number - uploadConversationAnalysisPercentage: - type: number - description: >- - Percentage of conversations created using the UploadConversation - endpoint to analyze automatically, between [0, 100]. - format: double - id: GoogleCloudContactcenterinsightsV1SettingsAnalysisConfig - type: object - GoogleCloudContactcenterinsightsV1ListAnalysesResponse: + #/components/schemas/GoogleCloudContactcenterinsightsV1UpdateQaQuestionTagRequest + GoogleCloudContactcenterinsightsV1UpdateQaQuestionTagRequest: + id: GoogleCloudContactcenterinsightsV1UpdateQaQuestionTagRequest + description: The request for updating a QaQuestionTag. type: object - description: The response to list analyses. - id: GoogleCloudContactcenterinsightsV1ListAnalysesResponse properties: - analyses: - items: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Analysis' - type: array - description: The analyses that match the request. - nextPageToken: + qaQuestionTag: + description: Required. The QaQuestionTag to update. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestionTag' + updateMask: description: >- - A token, which can be sent as `page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. + Optional. The list of fields to be updated. All possible fields can + be updated by passing `*`, or a subset of the following updateable + fields can be provided: * `qa_question_tag_name` - the name of the + tag * `qa_question_ids` - the list of questions the tag applies to type: string - GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData: - description: Agent Assist Smart Compose suggestion data. + format: google-fieldmask + GoogleCloudContactcenterinsightsV1UploadConversationMetadata: + id: GoogleCloudContactcenterinsightsV1UploadConversationMetadata + description: The metadata for an `UploadConversation` operation. + type: object properties: - suggestion: - description: The content of the suggestion. + createTime: + description: Output only. The time the operation was created. + readOnly: true type: string - metadata: - description: >- - Map that contains metadata about the Smart Compose suggestion and - the document from which it originates. - type: object - additionalProperties: - type: string - confidenceScore: + format: google-datetime + endTime: + description: Output only. The time the operation finished running. + readOnly: true + type: string + format: google-datetime + request: + description: Output only. The original request. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1UploadConversationRequest + analysisOperation: description: >- - The system's confidence score that this suggestion is a good match - for this conversation, ranging from 0.0 (completely uncertain) to - 1.0 (completely certain). - type: number - format: double - queryRecord: + Output only. The operation name for a successfully created analysis + operation, if any. + readOnly: true type: string + appliedRedactionConfig: description: >- - The name of the answer record. Format: - projects/{project}/locations/{location}/answerRecords/{answer_record} - id: GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData + Output only. The redaction config applied to the uploaded + conversation. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1RedactionConfig + GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsMetadata: + id: GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsMetadata + description: The metadata for a bulk analyze conversations operation. type: object - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig: properties: - agentId: - description: >- - Optional. An opaque, user-specified string representing a human - agent who handled all conversations in the import. Note that this - will be overridden if per-conversation metadata is provided through - the `metadata_bucket_uri`. + createTime: + description: The time the operation was created. type: string - customerChannel: - format: int32 + format: google-datetime + endTime: + description: The time the operation finished running. + type: string + format: google-datetime + request: + description: The original request for bulk analyze. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest + completedAnalysesCount: description: >- - Optional. Indicates which of the channels, 1 or 2, contains the - agent. Note that this must be set for conversations to be properly - displayed and analyzed. + The number of requested analyses that have completed successfully so + far. type: integer - agentChannel: + format: int32 + failedAnalysesCount: + description: The number of requested analyses that have failed so far. + type: integer + format: int32 + totalRequestedAnalysesCount: description: >- - Optional. Indicates which of the channels, 1 or 2, contains the - agent. Note that this must be set for conversations to be properly - displayed and analyzed. + Total number of analyses requested. Computed by the number of + conversations returned by `filter` multiplied by + `analysis_percentage` in the request. type: integer format: int32 - type: object - description: Configuration that applies to all conversations. - id: >- - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig - GoogleCloudContactcenterinsightsV1alpha1IntentMatchData: - description: >- - The data for an intent match. Represents an intent match for a text - segment in the conversation. A text segment can be part of a sentence, a - complete sentence, or an utterance with multiple sentences. - id: GoogleCloudContactcenterinsightsV1alpha1IntentMatchData - type: object - properties: - intentUniqueId: + partialErrors: description: >- - The id of the matched intent. Can be used to retrieve the - corresponding intent information. - type: string - GoogleCloudContactcenterinsightsV1QaScorecardResultScoreSource: - description: >- - A scorecard result may have multiple sets of scores from varying - sources, one of which becomes the "main" answer above. A ScoreSource - represents each individual set of scores. + Output only. Partial errors during bulk analyze operation that might + cause the operation output to be incomplete. + readOnly: true + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest: + id: GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest + description: The request to analyze conversations in bulk. type: object properties: - score: - format: double - description: The overall numerical score of the result. - type: number - normalizedScore: - type: number - format: double + parent: + description: Required. The parent resource to create analyses in. + type: string + filter: description: >- - The normalized score, which is the score divided by the potential - score. - sourceType: + Required. Filter used to select the subset of conversations to + analyze. type: string - description: What created the score. - enumDescriptions: - - Source type is unspecified. - - Score is derived only from system-generated answers. - - >- - Score is derived from both system-generated answers, and includes - any manual edits if they exist. - enum: - - SOURCE_TYPE_UNSPECIFIED - - SYSTEM_GENERATED_ONLY - - INCLUDES_MANUAL_EDITS - qaTagResults: - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecardResultQaTagResult - type: array - description: Collection of tags and their scores. - potentialScore: + analysisPercentage: description: >- - The maximum potential overall score of the scorecard. Any questions - answered using `na_value` are excluded from this calculation. - format: double + Required. Percentage of selected conversation to analyze, between + [0, 100]. type: number - id: GoogleCloudContactcenterinsightsV1QaScorecardResultScoreSource - GoogleCloudContactcenterinsightsV1GcsSource: + format: float + annotatorSelector: + description: >- + To select the annotators to run and the phrase matchers to use (if + any). If not specified, all annotators will be run. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector + GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector: + id: GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector + description: Selector of all available annotators and phrase matchers to run. type: object - description: A Cloud Storage source of conversation data. - id: GoogleCloudContactcenterinsightsV1GcsSource properties: - transcriptUri: - type: string + runInterruptionAnnotator: + description: Whether to run the interruption annotator. + type: boolean + runSilenceAnnotator: + description: Whether to run the silence annotator. + type: boolean + runPhraseMatcherAnnotator: + description: Whether to run the active phrase matcher annotator(s). + type: boolean + phraseMatchers: description: >- - Immutable. Cloud Storage URI that points to a file that contains the - conversation transcript. - audioUri: - type: string + The list of phrase matchers to run. If not provided, all active + phrase matchers will be used. If inactive phrase matchers are + provided, they will not be used. Phrase matchers will be run only if + run_phrase_matcher_annotator is set to true. Format: + projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} + type: array + items: + type: string + runSentimentAnnotator: + description: Whether to run the sentiment annotator. + type: boolean + runEntityAnnotator: + description: Whether to run the entity annotator. + type: boolean + runIntentAnnotator: + description: Whether to run the intent annotator. + type: boolean + runIssueModelAnnotator: description: >- - Cloud Storage URI that points to a file that contains the - conversation audio. - GoogleCloudContactcenterinsightsV1ConversationLevelSilence: - properties: - silenceDuration: - description: Amount of time calculated to be in silence. - type: string - format: google-duration - silencePercentage: - format: float - type: number - description: Percentage of the total conversation spent in silence. - id: GoogleCloudContactcenterinsightsV1ConversationLevelSilence - type: object - description: Conversation-level silence data. - GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsResponse: + Whether to run the issue model annotator. A model should have + already been deployed for this to take effect. + type: boolean + issueModels: + description: >- + The issue model to run. If not provided, the most recently deployed + topic model will be used. The provided issue model will only be used + for inference if the issue model is deployed and if + run_issue_model_annotator is set to true. If more than one issue + model is provided, only the first provided issue model will be used + for inference. + type: array + items: + type: string + runSummarizationAnnotator: + description: Whether to run the summarization annotator. + type: boolean + summarizationConfig: + description: Configuration for the summarization annotator. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig + runQaAnnotator: + description: Whether to run the QA annotator. + type: boolean + qaConfig: + description: Configuration for the QA annotator. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfig + GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig: + id: >- + GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig + description: Configuration for summarization. type: object - properties: {} - description: The response for a bulk delete conversations operation. - id: GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsResponse - GoogleCloudContactcenterinsightsV1DialogflowSource: properties: - audioUri: - type: string + conversationProfile: description: >- - Cloud Storage URI that points to a file that contains the - conversation audio. - dialogflowConversation: - readOnly: true + Resource name of the Dialogflow conversation profile. Format: + projects/{project}/locations/{location}/conversationProfiles/{conversation_profile} + type: string + summarizationModel: + description: Default summarization model to be used. + type: string + enumDescriptions: + - Unspecified summarization model. + - >- + The CCAI baseline model. This model is deprecated and will be + removed in the future. We recommend using `generator` instead. + - >- + The CCAI baseline model, V2.0. This model is deprecated and will + be removed in the future. We recommend using `generator` instead. + enumDeprecated: + - false + - true + - true + enum: + - SUMMARIZATION_MODEL_UNSPECIFIED + - BASELINE_MODEL + - BASELINE_MODEL_V2_0 + generator: description: >- - Output only. The name of the Dialogflow conversation that this - conversation resource is derived from. Format: - projects/{project}/locations/{location}/conversations/{conversation} + The resource name of the existing created generator. Format: + projects//locations//generators/ type: string - description: A Dialogflow source of conversation data. + GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfig: + id: GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfig + description: Configuration for the QA feature. type: object - id: GoogleCloudContactcenterinsightsV1DialogflowSource - GoogleCloudContactcenterinsightsV1CalculateIssueModelStatsResponse: properties: - currentStats: - description: >- - The latest label statistics for the queried issue model. Includes - results on both training data and data labeled after deployment. + scorecardList: + description: A manual list of scorecards to score. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelLabelStats + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfigScorecardList + GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfigScorecardList: + id: >- + GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfigScorecardList + description: Container for a list of scorecards. type: object - id: GoogleCloudContactcenterinsightsV1CalculateIssueModelStatsResponse - description: Response of querying an issue model's statistics. - GoogleCloudContactcenterinsightsV1alpha1HoldData: - id: GoogleCloudContactcenterinsightsV1alpha1HoldData - description: The data for a hold annotation. - properties: {} + properties: + qaScorecardRevisions: + description: List of QaScorecardRevisions. + type: array + items: + type: string + GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsResponse: + id: GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsResponse + description: The response for a bulk analyze conversations operation. type: object - GoogleCloudContactcenterinsightsV1PhraseMatcher: + properties: + successfulAnalysisCount: + description: Count of successful analyses. + type: integer + format: int32 + failedAnalysisCount: + description: Count of failed analyses. + type: integer + format: int32 + GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsMetadata: + id: GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsMetadata + description: The metadata for a bulk delete conversations operation. type: object - description: The phrase matcher resource. properties: - phraseMatchRuleGroups: + createTime: + description: The time the operation was created. + type: string + format: google-datetime + endTime: + description: The time the operation finished running. + type: string + format: google-datetime + request: + description: The original request for bulk delete. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest + partialErrors: + description: >- + Partial errors during bulk delete conversations operation that might + cause the operation output to be incomplete. type: array - description: A list of phase match rule groups that are included in this matcher. items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroup - type: + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest: + id: GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest + description: The request to delete conversations in bulk. + type: object + properties: + parent: + description: >- + Required. The parent resource to delete conversations from. Format: + projects/{project}/locations/{location} type: string - enum: - - PHRASE_MATCHER_TYPE_UNSPECIFIED - - ALL_OF - - ANY_OF - description: Required. The type of this phrase matcher. - enumDescriptions: - - Unspecified. - - Must meet all phrase match rule groups or there is no match. - - If any of the phrase match rule groups are met, there is a match. - displayName: - description: The human-readable name of the phrase matcher. + filter: + description: Filter used to select the subset of conversations to delete. type: string - active: + maxDeleteCount: + description: Maximum number of conversations to delete. + type: integer + format: int32 + force: + description: >- + If set to true, all of this conversation's analyses will also be + deleted. Otherwise, the request will only succeed if the + conversation has no analyses. type: boolean - description: Applies the phrase matcher only when it is active. - updateTime: - type: string - format: google-datetime + GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsResponse: + id: GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsResponse + description: The response for a bulk delete conversations operation. + type: object + properties: {} + GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsMetadata: + id: GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsMetadata + description: Metadata for the BulkDeleteFeedbackLabels endpoint. + type: object + properties: + request: + description: Output only. The original request for delete. readOnly: true + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsRequest + partialErrors: description: >- - Output only. The most recent time at which the phrase matcher was - updated. - versionTag: + Partial errors during deletion operation that might cause the + operation output to be incomplete. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsRequest: + id: GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsRequest + description: Request for the BulkDeleteFeedbackLabels endpoint. + type: object + properties: + parent: + description: Required. The parent resource for new feedback labels. + type: string + filter: description: >- - The customized version tag to use for the phrase matcher. If not - specified, it will default to `revision_id`. + Optional. A filter to reduce results to a specific subset. Supports + disjunctions (OR) and conjunctions (AND). Supported fields: * + `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * + `min_create_time` * `max_create_time` * `min_update_time` * + `max_update_time` * `feedback_label_type`: QUALITY_AI, + TOPIC_MODELING type: string - name: + GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsResponse: + id: GoogleCloudContactcenterinsightsV1alpha1BulkDeleteFeedbackLabelsResponse + description: Response for the BulkDeleteFeedbackLabels endpoint. + type: object + properties: {} + GoogleCloudContactcenterinsightsV1alpha1CreateAnalysisOperationMetadata: + id: GoogleCloudContactcenterinsightsV1alpha1CreateAnalysisOperationMetadata + description: Metadata for a create analysis operation. + type: object + properties: + createTime: + description: Output only. The time the operation was created. + readOnly: true type: string - description: >- - The resource name of the phrase matcher. Format: - projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} - revisionCreateTime: - description: >- - Output only. The timestamp of when the revision was created. It is - also the create time when a new matcher is added. format: google-datetime + endTime: + description: Output only. The time the operation finished running. readOnly: true type: string - roleMatch: - enum: - - ROLE_UNSPECIFIED - - HUMAN_AGENT - - AUTOMATED_AGENT - - END_USER - - ANY_AGENT - type: string + format: google-datetime + conversation: description: >- - The role whose utterances the phrase matcher should be matched - against. If the role is ROLE_UNSPECIFIED it will be matched against - any utterances in the transcript. - enumDescriptions: - - Participant's role is not set. - - Participant is a human agent. - - Participant is an automated agent. - - Participant is an end user who conversed with the contact center. - - Participant is either a human or automated agent. - revisionId: + Output only. The Conversation that this Analysis Operation belongs + to. + readOnly: true + type: string + annotatorSelector: + description: Output only. The annotator selector used for the analysis (if any). + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector + GoogleCloudContactcenterinsightsV1alpha1CreateIssueMetadata: + id: GoogleCloudContactcenterinsightsV1alpha1CreateIssueMetadata + description: Metadata for creating an issue. + type: object + properties: + createTime: + description: Output only. The time the operation was created. readOnly: true - description: >- - Output only. Immutable. The revision ID of the phrase matcher. A new - revision is committed whenever the matcher is changed, except when - it is activated or deactivated. A server generated random ID will be - used. Example: - locations/global/phraseMatchers/my-first-matcher@1234567 type: string - activationUpdateTime: format: google-datetime + endTime: + description: Output only. The time the operation finished running. readOnly: true type: string - description: >- - Output only. The most recent time at which the activation status was - updated. - id: GoogleCloudContactcenterinsightsV1PhraseMatcher - GoogleCloudContactcenterinsightsV1ListIssueModelsResponse: - description: The response of listing issue models. + format: google-datetime + request: + description: The original request for creation. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1CreateIssueRequest + GoogleCloudContactcenterinsightsV1alpha1CreateIssueRequest: + id: GoogleCloudContactcenterinsightsV1alpha1CreateIssueRequest + description: The request to create an issue. type: object properties: - issueModels: - type: array - items: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel' - description: The issue models that match the request. - id: GoogleCloudContactcenterinsightsV1ListIssueModelsResponse - GoogleCloudContactcenterinsightsV1ArticleSuggestionData: - description: Agent Assist Article Suggestion data. + parent: + description: Required. The parent resource of the issue. + type: string + issue: + description: Required. The values for the new issue. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Issue' + GoogleCloudContactcenterinsightsV1alpha1Issue: + id: GoogleCloudContactcenterinsightsV1alpha1Issue + description: The issue resource. type: object - id: GoogleCloudContactcenterinsightsV1ArticleSuggestionData properties: - confidenceScore: + name: description: >- - The system's confidence score that this article is a good match for - this conversation, ranging from 0.0 (completely uncertain) to 1.0 - (completely certain). - format: float - type: number - queryRecord: + Immutable. The resource name of the issue. Format: + projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue} type: string - description: >- - The name of the answer record. Format: - projects/{project}/locations/{location}/answerRecords/{answer_record} - metadata: - additionalProperties: - type: string - type: object - description: >- - Map that contains metadata about the Article Suggestion and the - document that it originates from. - uri: - description: Article URI. + displayName: + description: The representative name for the issue. type: string - source: - description: >- - The knowledge document that this answer was extracted from. Format: - projects/{project}/knowledgeBases/{knowledge_base}/documents/{document} + createTime: + description: Output only. The time at which this issue was created. + readOnly: true type: string - title: + format: google-datetime + updateTime: + description: Output only. The most recent time that this issue was updated. + readOnly: true type: string - description: Article title. - GoogleCloudContactcenterinsightsV1DimensionQaQuestionDimensionMetadata: - properties: - qaQuestionId: + format: google-datetime + sampleUtterances: + description: >- + Output only. Resource names of the sample representative utterances + that match to this issue. + readOnly: true + type: array + items: + type: string + displayDescription: + description: Representative description of the issue. type: string - description: Optional. The QA question ID. - questionBody: + GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelMetadata: + id: GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelMetadata + description: Metadata for creating an issue model. + type: object + properties: + createTime: + description: Output only. The time the operation was created. + readOnly: true type: string - description: Optional. The full body of the question. - qaScorecardId: - description: Optional. The QA scorecard ID. + format: google-datetime + endTime: + description: Output only. The time the operation finished running. + readOnly: true type: string - id: GoogleCloudContactcenterinsightsV1DimensionQaQuestionDimensionMetadata + format: google-datetime + request: + description: The original request for creation. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest + GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest: + id: GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest + description: The request to create an issue model. type: object - description: Metadata about the QA question dimension. - GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfig: properties: - scorecardList: - description: A manual list of scorecards to score. + parent: + description: Required. The parent resource of the issue model. + type: string + issueModel: + description: Required. The issue model to create. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfigScorecardList - description: Configuration for the QA feature. - type: object - id: GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfig - GoogleCloudContactcenterinsightsV1DeployQaScorecardRevisionRequest: - type: object - description: The request to deploy a QaScorecardRevision - properties: {} - id: GoogleCloudContactcenterinsightsV1DeployQaScorecardRevisionRequest - GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelMetadata: + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModel + GoogleCloudContactcenterinsightsV1alpha1IssueModel: + id: GoogleCloudContactcenterinsightsV1alpha1IssueModel + description: The issue model resource. type: object - description: Metadata used for export issue model. - id: GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelMetadata properties: + name: + description: >- + Immutable. The resource name of the issue model. Format: + projects/{project}/locations/{location}/issueModels/{issue_model} + type: string + displayName: + description: The representative name for the issue model. + type: string createTime: + description: Output only. The time at which this issue model was created. + readOnly: true + type: string format: google-datetime + updateTime: + description: >- + Output only. The most recent time at which the issue model was + updated. + readOnly: true type: string - description: The time the operation was created. - request: - description: The original export request. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest - endTime: format: google-datetime + issueCount: + description: Output only. Number of issues in this issue model. + readOnly: true type: string - description: The time the operation finished running. - GoogleCloudContactcenterinsightsV1RedactionConfig: - type: object - properties: - inspectTemplate: + format: int64 + state: + description: Output only. State of the model. + readOnly: true + type: string + enumDescriptions: + - Unspecified. + - Model is not deployed but is ready to deploy. + - Model is being deployed. + - >- + Model is deployed and is ready to be used. A model can only be + used in analysis if it's in this state. + - Model is being undeployed. + - Model is being deleted. + enum: + - STATE_UNSPECIFIED + - UNDEPLOYED + - DEPLOYING + - DEPLOYED + - UNDEPLOYING + - DELETING + inputDataConfig: + description: Configs for the input data that used to create the issue model. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig + trainingStats: description: >- - The fully-qualified DLP inspect template resource name. Format: - `projects/{project}/locations/{location}/inspectTemplates/{template}` + Output only. Immutable. The issue model's label statistics on its + training data. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats + modelType: + description: Type of the model. type: string - deidentifyTemplate: + enumDescriptions: + - Unspecified model type. + - Type V1. + - Type V2. + enum: + - MODEL_TYPE_UNSPECIFIED + - TYPE_V1 + - TYPE_V2 + languageCode: + description: Language of the model. type: string - description: >- - The fully-qualified DLP deidentify template resource name. Format: - `projects/{project}/deidentifyTemplates/{template}` - description: >- - DLP resources used for redaction while ingesting conversations. DLP - settings are applied to conversations ingested from the - `UploadConversation` and `IngestConversations` endpoints, including - conversation coming from CCAI Platform. They are not applied to - conversations ingested from the `CreateConversation` endpoint or the - Dialogflow / Agent Assist runtime integrations. When using Dialogflow / - Agent Assist runtime integrations, redaction should be performed in - Dialogflow / Agent Assist. - id: GoogleCloudContactcenterinsightsV1RedactionConfig - GoogleIamV1TestIamPermissionsRequest: - id: GoogleIamV1TestIamPermissionsRequest + GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig: + id: GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig + description: Configs for the input data used to create the issue model. type: object properties: - permissions: + medium: description: >- - The set of permissions to check for the `resource`. Permissions with - wildcards (such as `*` or `storage.*`) are not allowed. For more - information see [IAM - Overview](https://cloud.google.com/iam/docs/overview#permissions). - items: - type: string - type: array - description: Request message for `TestIamPermissions` method. - GoogleIamV1AuditConfig: - id: GoogleIamV1AuditConfig - properties: - auditLogConfigs: - type: array - description: The configuration for logging of each type of permission. - items: - $ref: '#/components/schemas/GoogleIamV1AuditLogConfig' - service: + Medium of conversations used in training data. This field is being + deprecated. To specify the medium to be used in training a new issue + model, set the `medium` field on `filter`. + deprecated: true + type: string + enumDescriptions: + - Default value, if unspecified will default to PHONE_CALL. + - The format for conversations that took place over the phone. + - The format for conversations that took place over chat. + enum: + - MEDIUM_UNSPECIFIED + - PHONE_CALL + - CHAT + trainingConversationsCount: + description: Output only. Number of conversations used in training. Output only. + readOnly: true type: string + format: int64 + filter: 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. - 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. - type: object - GoogleCloudContactcenterinsightsV1ListFeedbackLabelsResponse: - properties: - nextPageToken: + A filter to reduce the conversations used for training the model to + a specific subset. Refer to + https://cloud.google.com/contact-center/insights/docs/filtering for + details. type: string - description: The next page token. - feedbackLabels: - type: array - description: The feedback labels that match the request. - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel - type: object - id: GoogleCloudContactcenterinsightsV1ListFeedbackLabelsResponse - description: The response for listing feedback labels. - GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource: + GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats: + id: GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats + description: Aggregated statistics about an issue model. type: object properties: - objectUri: - type: string - description: 'Required. Format: `gs:///`' - id: GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource - description: Google Cloud Storage Object URI to get the issue model file from. - GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData: - properties: - textSections: + analyzedConversationsCount: description: >- - The summarization content that is divided into sections. The key is - the section's name and the value is the section's content. There is - no specific format for the key or value. - additionalProperties: - type: string - type: object - text: + Number of conversations the issue model has analyzed at this point + in time. type: string - description: The summarization content that is concatenated into one string. - metadata: + format: int64 + unclassifiedConversationsCount: description: >- - A map that contains metadata about the summarization and the - document from which it originates. - additionalProperties: - type: string + Number of analyzed conversations for which no issue was applicable + at this point in time. + type: string + format: int64 + issueStats: + description: Statistics on each issue. Key is the issue's resource name. type: object - conversationModel: + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats + GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats: + id: GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats + description: Aggregated statistics about an issue. + type: object + properties: + issue: description: >- - The name of the model that generates this summary. Format: - projects/{project}/locations/{location}/conversationModels/{conversation_model} + Issue resource. Format: + projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue} type: string - answerRecord: - description: >- - The name of the answer record. Format: - projects/{project}/locations/{location}/answerRecords/{answer_record} + labeledConversationsCount: + description: Number of conversations attached to the issue at this point in time. type: string - confidence: - format: float - description: The confidence score of the summarization. - type: number - description: Conversation summarization suggestion data. - id: >- - GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData - type: object - GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent: - description: >- - The data for a Dialogflow intent. Represents a detected intent in the - conversation, e.g. MAKES_PROMISE. - id: GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent - properties: + format: int64 displayName: - description: The human-readable name of the intent. + description: Display name of the issue. type: string + GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelMetadata: + id: GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelMetadata + description: Metadata for deleting an issue model. type: object - GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats: properties: - successfulIngestCount: - type: integer - readOnly: true - format: int32 - description: >- - Output only. The number of new conversations added during this - ingest operation. - processedObjectCount: - type: integer - format: int32 - readOnly: true - description: >- - Output only. The number of objects processed during the ingest - operation. - failedIngestCount: - description: >- - Output only. The number of objects which were unable to be ingested - due to errors. The errors are populated in the partial_errors field. - format: int32 - type: integer + createTime: + description: Output only. The time the operation was created. readOnly: true - duplicatesSkippedCount: - type: integer - format: int32 + type: string + format: google-datetime + endTime: + description: Output only. The time the operation finished running. readOnly: true - description: >- - Output only. The number of objects skipped because another - conversation with the same transcript uri had already been ingested. - id: >- - GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats + type: string + format: google-datetime + request: + description: The original request for deletion. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest + GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest: + id: GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest + description: The request to delete an issue model. type: object - description: Statistics for IngestConversations operation. - GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination: properties: - objectUri: + name: + description: Required. The name of the issue model to delete. type: string - description: 'Required. Format: `gs:///`' - id: GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination - description: Google Cloud Storage Object URI to save the issue model to. + GoogleCloudContactcenterinsightsV1alpha1DeleteQaQuestionTagMetadata: + id: GoogleCloudContactcenterinsightsV1alpha1DeleteQaQuestionTagMetadata + description: The metadata for deleting a QaQuestionTag Resource. type: object - GoogleCloudContactcenterinsightsV1alpha1IssueModel: properties: createTime: - description: Output only. The time at which this issue model was created. + description: Output only. The time the operation was created. readOnly: true type: string format: google-datetime - name: - description: >- - Immutable. The resource name of the issue model. Format: - projects/{project}/locations/{location}/issueModels/{issue_model} - type: string - displayName: - description: The representative name for the issue model. + endTime: + description: Output only. The time the operation finished running. + readOnly: true type: string - trainingStats: - description: >- - Output only. Immutable. The issue model's label statistics on its - training data. + format: google-datetime + request: + description: Output only. The original request. readOnly: true $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats - inputDataConfig: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig - description: Configs for the input data that used to create the issue model. - issueCount: - format: int64 - description: Output only. Number of issues in this issue model. + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DeleteQaQuestionTagRequest + GoogleCloudContactcenterinsightsV1alpha1DeleteQaQuestionTagRequest: + id: GoogleCloudContactcenterinsightsV1alpha1DeleteQaQuestionTagRequest + description: The request for deleting a QaQuestionTag. + type: object + properties: + name: + description: Required. The name of the QaQuestionTag to delete. type: string + GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelMetadata: + id: GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelMetadata + description: Metadata for deploying an issue model. + type: object + properties: + createTime: + description: Output only. The time the operation was created. readOnly: true - state: type: string + format: google-datetime + endTime: + description: Output only. The time the operation finished running. readOnly: true - enumDescriptions: - - Unspecified. - - Model is not deployed but is ready to deploy. - - Model is being deployed. - - >- - Model is deployed and is ready to be used. A model can only be - used in analysis if it's in this state. - - Model is being undeployed. - - Model is being deleted. - enum: - - STATE_UNSPECIFIED - - UNDEPLOYED - - DEPLOYING - - DEPLOYED - - UNDEPLOYING - - DELETING - description: Output only. State of the model. - updateTime: type: string - description: >- - Output only. The most recent time at which the issue model was - updated. format: google-datetime - readOnly: true - modelType: - description: Type of the model. - enumDescriptions: - - Unspecified model type. - - Type V1. - - Type V2. - type: string - enum: - - MODEL_TYPE_UNSPECIFIED - - TYPE_V1 - - TYPE_V2 - languageCode: - description: Language of the model. + request: + description: The original request for deployment. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest + GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest: + id: GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest + description: The request to deploy an issue model. + type: object + properties: + name: + description: Required. The issue model to deploy. type: string - description: The issue model resource. - id: GoogleCloudContactcenterinsightsV1alpha1IssueModel + GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelResponse: + id: GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelResponse + description: The response to deploy an issue model. type: object - GoogleCloudContactcenterinsightsV1alpha1DimensionAgentDimensionMetadata: + properties: {} + GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataMetadata: + id: GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataMetadata + description: Metadata for an export insights operation. type: object properties: - agentDisplayName: - description: Optional. The agent's name - type: string - agentId: - description: Optional. A user-specified string representing the agent. + createTime: + description: Output only. The time the operation was created. + readOnly: true type: string - agentTeam: + format: google-datetime + endTime: + description: Output only. The time the operation finished running. + readOnly: true type: string - description: Optional. A user-specified string representing the agent's team. - id: GoogleCloudContactcenterinsightsV1alpha1DimensionAgentDimensionMetadata - description: Metadata about the agent dimension. - GoogleCloudContactcenterinsightsV1ConversationParticipant: + format: google-datetime + request: + description: The original request for export. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest + partialErrors: + description: >- + Partial errors during export operation that might cause the + operation output to be incomplete. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + completedExportCount: + description: The number of conversations that were exported successfully. + type: integer + format: int32 + failedExportCount: + description: The number of conversations that failed to be exported. + type: integer + format: int32 + GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest: + id: GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest + description: The request to export insights. type: object - description: The call participant speaking for a given utterance. - id: GoogleCloudContactcenterinsightsV1ConversationParticipant properties: - dialogflowParticipantName: - description: >- - The name of the participant provided by Dialogflow. Format: - projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} + bigQueryDestination: + description: Specified if sink is a BigQuery table. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination + parent: + description: Required. The parent resource to export data from. type: string - dialogflowParticipant: + filter: + description: >- + A filter to reduce results to a specific subset. Useful for + exporting conversations with specific properties. type: string + kmsKey: description: >- - Deprecated. Use `dialogflow_participant_name` instead. The name of - the Dialogflow participant. Format: - projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} - deprecated: true - role: + A fully qualified KMS key name for BigQuery tables protected by + CMEK. Format: + projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version} + type: string + writeDisposition: + description: Options for what to do if the destination table already exists. + type: string enumDescriptions: - - Participant's role is not set. - - Participant is a human agent. - - Participant is an automated agent. - - Participant is an end user who conversed with the contact center. - - Participant is either a human or automated agent. + - Write disposition is not specified. Defaults to WRITE_TRUNCATE. + - >- + If the table already exists, BigQuery will overwrite the table + data and use the schema from the load. + - >- + If the table already exists, BigQuery will append data to the + table. + enum: + - WRITE_DISPOSITION_UNSPECIFIED + - WRITE_TRUNCATE + - WRITE_APPEND + exportSchemaVersion: + description: Optional. Version of the export schema. type: string - description: The role of the participant. + enumDescriptions: + - Unspecified. Defaults to EXPORT_V3. + - Export schema version 1. + - Export schema version 2. + - Export schema version 3. + - Export schema version 4. + - Export schema version 5. + - Export schema version 6. + - Export schema version 7. + - Export schema version 8. + - Export schema version 9. + - Export schema version 10. + - Export schema version latest available. enum: - - ROLE_UNSPECIFIED - - HUMAN_AGENT - - AUTOMATED_AGENT - - END_USER - - ANY_AGENT - userId: - description: A user-specified ID representing the participant. + - EXPORT_SCHEMA_VERSION_UNSPECIFIED + - EXPORT_V1 + - EXPORT_V2 + - EXPORT_V3 + - EXPORT_V4 + - EXPORT_V5 + - EXPORT_V6 + - EXPORT_V7 + - EXPORT_V8 + - EXPORT_V9 + - EXPORT_V10 + - EXPORT_VERSION_LATEST_AVAILABLE + GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination: + id: >- + GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination + description: A BigQuery Table Reference. + type: object + properties: + projectId: + description: >- + A project ID or number. If specified, then export will attempt to + write data to this project instead of the resource project. + Otherwise, the resource project will be used. type: string - obfuscatedExternalUserId: + dataset: + description: >- + Required. The name of the BigQuery dataset that the snapshot result + should be exported to. If this dataset does not exist, the export + call returns an INVALID_ARGUMENT error. type: string - description: Obfuscated user ID from Dialogflow. - GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel: + table: + description: >- + The BigQuery table name to which the insights data should be + written. If this table does not exist, the export call returns an + INVALID_ARGUMENT error. + type: string + GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataResponse: + id: GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataResponse + description: Response for an export insights operation. + type: object + properties: {} + GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelMetadata: + id: GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelMetadata + description: Metadata used for export issue model. + type: object properties: - qaAnswerLabel: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue - description: QaAnswer label. - label: - description: String label. + createTime: + description: The time the operation was created. type: string - labeledResource: - description: Resource name of the resource to be labeled. + format: google-datetime + endTime: + description: The time the operation finished running. type: string + format: google-datetime + request: + description: The original export request. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest + GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest: + id: GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest + description: Request to export an issue model. + type: object + properties: + gcsDestination: + description: Google Cloud Storage URI to export the issue model to. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination name: - description: >- - Immutable. Resource name of the FeedbackLabel. Format: - projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label} + description: Required. The issue model to export. type: string - updateTime: + GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination: + id: >- + GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination + description: Google Cloud Storage Object URI to save the issue model to. + type: object + properties: + objectUri: + description: 'Required. Format: `gs:///`' type: string - format: google-datetime - description: Output only. Update time of the label. - readOnly: true + GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelResponse: + id: GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelResponse + description: Response from export issue model + type: object + properties: {} + GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelMetadata: + id: GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelMetadata + description: Metadata used for import issue model. + type: object + properties: createTime: - description: Output only. Create time of the label. - readOnly: true + description: The time the operation was created. + type: string format: google-datetime + endTime: + description: The time the operation finished running. type: string - description: Represents a conversation, resource, and label provided by the user. - type: object - id: GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel - GoogleCloudContactcenterinsightsV1AnnotatorSelector: + format: google-datetime + request: + description: The original import request. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest + GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest: + id: GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest + description: Request to import an issue model. type: object properties: - runEntityAnnotator: - type: boolean - description: Whether to run the entity annotator. - qaConfig: + gcsSource: + description: Google Cloud Storage source message. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfig - description: Configuration for the QA annotator. - runSentimentAnnotator: + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource + parent: + description: Required. The parent resource of the issue model. + type: string + createNewModel: + description: >- + Optional. If set to true, will create an issue model from the + imported file with randomly generated IDs for the issue model and + corresponding issues. Otherwise, replaces an existing model with the + same ID as the file. type: boolean - description: Whether to run the sentiment annotator. - summarizationConfig: - description: Configuration for the summarization annotator. + GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource: + id: GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource + description: Google Cloud Storage Object URI to get the issue model file from. + type: object + properties: + objectUri: + description: 'Required. Format: `gs:///`' + type: string + GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelResponse: + id: GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelResponse + description: Response from import issue model + type: object + properties: + issueModel: + description: The issue model that was imported. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig - phraseMatchers: - items: - type: string - type: array - description: >- - The list of phrase matchers to run. If not provided, all active - phrase matchers will be used. If inactive phrase matchers are - provided, they will not be used. Phrase matchers will be run only if - run_phrase_matcher_annotator is set to true. Format: - projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} - runIssueModelAnnotator: - type: boolean - description: >- - Whether to run the issue model annotator. A model should have - already been deployed for this to take effect. - runIntentAnnotator: - type: boolean - description: Whether to run the intent annotator. - issueModels: - type: array - items: - type: string - description: >- - The issue model to run. If not provided, the most recently deployed - topic model will be used. The provided issue model will only be used - for inference if the issue model is deployed and if - run_issue_model_annotator is set to true. If more than one issue - model is provided, only the first provided issue model will be used - for inference. - runInterruptionAnnotator: - type: boolean - description: Whether to run the interruption annotator. - runPhraseMatcherAnnotator: - description: Whether to run the active phrase matcher annotator(s). - type: boolean - runSummarizationAnnotator: - type: boolean - description: Whether to run the summarization annotator. - runQaAnnotator: - type: boolean - description: Whether to run the QA annotator. - runSilenceAnnotator: - type: boolean - description: Whether to run the silence annotator. - id: GoogleCloudContactcenterinsightsV1AnnotatorSelector - description: Selector of all available annotators and phrase matchers to run. - GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue: + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModel + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadata: + id: GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadata + description: The metadata for an IngestConversations operation. type: object - description: >- - Message for holding the value of the answer. QaQuestion.AnswerChoice - defines the possible answer values for a question. - id: GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue properties: - normalizedScore: - readOnly: true - description: >- - Output only. Normalized score of the questions. Calculated as score - / potential_score iff potential_score != 0 else 0 - type: number - format: double - score: - description: Output only. Numerical score of the answer. + createTime: + description: Output only. The time the operation was created. readOnly: true - type: number - format: double - strValue: - description: String value. type: string - boolValue: - description: Boolean value. - type: boolean - key: + format: google-datetime + endTime: + description: Output only. The time the operation finished running. + readOnly: true type: string + format: google-datetime + request: + description: Output only. The original request for ingest. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest + partialErrors: description: >- - A short string used as an identifier. Matches the value used in - QaQuestion.AnswerChoice.key. - potentialScore: - format: double - type: number - description: Output only. The maximum potential score of the question. + Output only. Partial errors during ingest operation that might cause + the operation output to be incomplete. readOnly: true - naValue: - type: boolean - description: A value of "Not Applicable (N/A)". - numValue: - description: Numerical value. - type: number - format: double - GoogleRpcStatus: - id: GoogleRpcStatus - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - properties: - details: type: array items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object + $ref: '#/components/schemas/GoogleRpcStatus' + ingestConversationsStats: + description: Output only. Statistics for IngestConversations operation. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats + sampledConversations: description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - message: + Output only. Stores the conversation resources produced by ingest + sampling operations. + readOnly: true + type: array + items: + type: string + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest: + id: GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest + description: The request to ingest conversations. + type: object + properties: + gcsSource: + description: >- + A cloud storage bucket source. Note that any previously ingested + objects from the source will be skipped to avoid duplication. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource + transcriptObjectConfig: + description: Configuration for when `source` contains conversation transcripts. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig + parent: + description: Required. The parent resource for new conversations. type: string + conversationConfig: + description: Configuration that applies to all conversations. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig + redactionConfig: description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - code: - description: The status code, which should be an enum value of google.rpc.Code. - format: int32 + Optional. DLP settings for transcript redaction. Optional, will + default to the config specified in Settings. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RedactionConfig + speechConfig: + description: >- + Optional. Default Speech-to-Text configuration. Optional, will + default to the config specified in Settings. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SpeechConfig + sampleSize: + description: >- + Optional. If set, this fields indicates the number of objects to + ingest from the Cloud Storage bucket. If empty, the entire bucket + will be ingested. Unless they are first deleted, conversations + produced through sampling won't be ingested by subsequent ingest + requests. type: integer - type: object - GoogleCloudContactcenterinsightsV1DimensionQaQuestionAnswerDimensionMetadata: - type: object + format: int32 + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource: id: >- - GoogleCloudContactcenterinsightsV1DimensionQaQuestionAnswerDimensionMetadata - description: >- - Metadata about the QA question-answer dimension. This is useful for - showing the answer distribution for questions for a given scorecard. + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource + description: Configuration for Cloud Storage bucket sources. + type: object properties: - qaScorecardId: - type: string - description: Optional. The QA scorecard ID. - answerValue: - description: Optional. The full body of the question. - type: string - questionBody: + bucketUri: + description: >- + Optional. The Cloud Storage bucket containing source objects. Avoid + passing this. Pass this through one of `transcript_bucket_uri` or + `audio_bucket_uri`. type: string - description: Optional. The full body of the question. - qaQuestionId: - description: Optional. The QA question ID. + bucketObjectType: + description: >- + Optional. Specifies the type of the objects in `bucket_uri`. Avoid + passing this. This is inferred from the `transcript_bucket_uri`, + `audio_bucket_uri`. type: string - GoogleCloudContactcenterinsightsV1alpha1SmartReplyData: - properties: - queryRecord: + enumDescriptions: + - The object type is unspecified and will default to `TRANSCRIPT`. + - The object is a transcript. + - The object is an audio file. + enum: + - BUCKET_OBJECT_TYPE_UNSPECIFIED + - TRANSCRIPT + - AUDIO + transcriptBucketUri: + description: >- + Optional. The Cloud Storage path to the conversation transcripts. + Note that: [1] Transcript files are expected to be in JSON format. + [2] Transcript, audio, metadata files must be in separate buckets / + folders. [3] A source file and its corresponding metadata file must + share the same name to be properly ingested, E.g. + `gs://bucket/audio/conversation1.mp3` and + `gs://bucket/metadata/conversation1.json`. type: string + audioBucketUri: description: >- - The name of the answer record. Format: - projects/{project}/locations/{location}/answerRecords/{answer_record} - metadata: - additionalProperties: - type: string + Optional. The Cloud Storage path to the conversation audio file. + Note that: [1] Audio files will be transcribed if not already. [2] + Audio files and transcript files must be in separate buckets / + folders. [3] A source file and its corresponding audio file must + share the same name to be properly ingested, E.g. + `gs://bucket/transcript/conversation1.json` and + `gs://bucket/audio/conversation1.mp3`. + type: string + metadataBucketUri: description: >- - Map that contains metadata about the Smart Reply and the document - from which it originates. - type: object - reply: - description: The content of the reply. + Optional. The Cloud Storage path to the conversation metadata. Note + that: [1] Metadata files are expected to be in JSON format. [2] + Metadata and source files (transcripts or audio) must be in separate + buckets / folders. [3] A source file and its corresponding metadata + file must share the same name to be properly ingested, E.g. + `gs://bucket/audio/conversation1.mp3` and + `gs://bucket/metadata/conversation1.json`. type: string - confidenceScore: - type: number + customMetadataKeys: description: >- - The system's confidence score that this reply is a good match for - this conversation, ranging from 0.0 (completely uncertain) to 1.0 - (completely certain). - format: double - id: GoogleCloudContactcenterinsightsV1alpha1SmartReplyData - description: Agent Assist Smart Reply data. - type: object - GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultQaTagResult: - description: Tags and their corresponding results. + Optional. Custom keys to extract as conversation labels from + metadata files in `metadata_bucket_uri`. Keys not included in this + field will be ignored. Note that there is a limit of 100 labels per + conversation. + type: array + items: + type: string + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig: + id: >- + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig + description: Configuration for processing transcript objects. type: object properties: - score: - type: number - description: The score the tag applies to. - format: double - potentialScore: - description: The potential score the tag applies to. - format: double - type: number - tag: + medium: + description: Required. The medium transcript objects represent. type: string - description: The tag the score applies to. - normalizedScore: - format: double - type: number - description: The normalized score the tag applies to. - id: GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultQaTagResult - GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelResponse: - description: Response from export issue model + enumDescriptions: + - Default value, if unspecified will default to PHONE_CALL. + - The format for conversations that took place over the phone. + - The format for conversations that took place over chat. + enum: + - MEDIUM_UNSPECIFIED + - PHONE_CALL + - CHAT + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig: + id: >- + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig + description: Configuration that applies to all conversations. type: object - properties: {} - id: GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelResponse - GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSlice: properties: - total: + agentId: description: >- - The total metric value. The interval of this data point is [starting - create time, ending create time) from the request. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPoint - timeSeries: + Optional. An opaque, user-specified string representing a human + agent who handled all conversations in the import. Note that this + will be overridden if per-conversation metadata is provided through + the `metadata_bucket_uri`. + type: string + agentChannel: description: >- - A time series of metric values. This is only populated if the - request specifies a time granularity other than NONE. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceTimeSeries - dimensions: - description: A unique combination of dimensions that this slice represents. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Dimension + Optional. Indicates which of the channels, 1 or 2, contains the + agent. Note that this must be set for conversations to be properly + displayed and analyzed. + type: integer + format: int32 + customerChannel: + description: >- + Optional. Indicates which of the channels, 1 or 2, contains the + agent. Note that this must be set for conversations to be properly + displayed and analyzed. + type: integer + format: int32 + GoogleCloudContactcenterinsightsV1alpha1RedactionConfig: + id: GoogleCloudContactcenterinsightsV1alpha1RedactionConfig description: >- - A slice contains a total and (if the request specified a time - granularity) a time series of metric values. Each slice contains a - unique combination of the cardinality of dimensions from the request. - For example, if the request specifies a single ISSUE dimension and it - has a cardinality of 2 (i.e. the data used to compute the metrics has 2 - issues in total), the response will have 2 slices: * Slice 1 -> - dimensions=[Issue 1] * Slice 2 -> dimensions=[Issue 2] - type: object - id: GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSlice - GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceTimeSeries: - properties: - dataPoints: - type: array - description: The data points that make up the time series . - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPoint - id: >- - GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceTimeSeries - description: A time series of metric values. - type: object - GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest: + DLP resources used for redaction while ingesting conversations. DLP + settings are applied to conversations ingested from the + `UploadConversation` and `IngestConversations` endpoints, including + conversation coming from CCAI Platform. They are not applied to + conversations ingested from the `CreateConversation` endpoint or the + Dialogflow / Agent Assist runtime integrations. When using Dialogflow / + Agent Assist runtime integrations, redaction should be performed in + Dialogflow / Agent Assist. type: object - description: The request to deploy an issue model. - properties: - name: - type: string - description: Required. The issue model to deploy. - id: GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest - GoogleCloudContactcenterinsightsV1DialogflowInteractionData: - id: GoogleCloudContactcenterinsightsV1DialogflowInteractionData properties: - dialogflowIntentId: + deidentifyTemplate: description: >- - The Dialogflow intent resource path. Format: - projects/{project}/agent/{agent}/intents/{intent} + The fully-qualified DLP deidentify template resource name. Format: + `projects/{project}/deidentifyTemplates/{template}` type: string - confidence: - type: number + inspectTemplate: description: >- - The confidence of the match ranging from 0.0 (completely uncertain) - to 1.0 (completely certain). - format: float - type: object - description: Dialogflow interaction data. - GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfigScorecardList: - id: GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfigScorecardList - properties: - qaScorecardRevisions: - type: array - description: List of QaScorecardRevisions. - items: - type: string - type: object - description: Container for a list of scorecards. - GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest: - id: GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest - description: The request to create an issue model. - properties: - parent: + The fully-qualified DLP inspect template resource name. Format: + `projects/{project}/locations/{location}/inspectTemplates/{template}` type: string - description: Required. The parent resource of the issue model. - issueModel: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModel - description: Required. The issue model to create. - type: object - GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore: + GoogleCloudContactcenterinsightsV1alpha1SpeechConfig: + id: GoogleCloudContactcenterinsightsV1alpha1SpeechConfig + description: >- + Speech-to-Text configuration. Speech-to-Text settings are applied to + conversations ingested from the `UploadConversation` and + `IngestConversations` endpoints, including conversation coming from CCAI + Platform. They are not applied to conversations ingested from the + `CreateConversation` endpoint. type: object properties: - averageTagNormalizedScore: - type: number - description: Average tag normalized score per tag. - format: double - tag: + speechRecognizer: + description: >- + The fully-qualified Speech Recognizer resource name. Format: + `projects/{project_id}/locations/{location}/recognizer/{recognizer}` type: string - description: Tag name. - description: Average QA normalized score for the tag. + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats: id: >- - GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore - GoogleCloudContactcenterinsightsV1Analysis: + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats + description: Statistics for IngestConversations operation. + type: object properties: - annotatorSelector: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelector + processedObjectCount: description: >- - To select the annotators to run and the phrase matchers to use (if - any). If not specified, all annotators will be run. - createTime: + Output only. The number of objects processed during the ingest + operation. readOnly: true - format: google-datetime - description: >- - Output only. The time at which the analysis was created, which - occurs when the long-running operation completes. - type: string - name: + type: integer + format: int32 + duplicatesSkippedCount: description: >- - Immutable. The resource name of the analysis. Format: - projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} - type: string - analysisResult: + Output only. The number of objects skipped because another + conversation with the same transcript uri had already been ingested. readOnly: true - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnalysisResult + type: integer + format: int32 + successfulIngestCount: description: >- - Output only. The result of the analysis, which is populated when the - analysis finishes. - requestTime: + Output only. The number of new conversations added during this + ingest operation. readOnly: true - description: Output only. The time at which the analysis was requested. - format: google-datetime - type: string - id: GoogleCloudContactcenterinsightsV1Analysis - description: The analysis resource. - type: object - GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsResponse: - properties: - failedAnalysisCount: type: integer - description: Count of failed analyses. format: int32 - successfulAnalysisCount: + failedIngestCount: + description: >- + Output only. The number of objects which were unable to be ingested + due to errors. The errors are populated in the partial_errors field. + readOnly: true type: integer format: int32 - description: Count of successful analyses. - id: GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsResponse - description: The response for a bulk analyze conversations operation. + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsResponse: + id: GoogleCloudContactcenterinsightsV1alpha1IngestConversationsResponse + description: The response to an IngestConversations operation. + type: object + properties: {} + GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecMetadata: + id: GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecMetadata + description: Metadata for initializing a location-level encryption specification. type: object - GoogleCloudContactcenterinsightsV1alpha1CreateAnalysisOperationMetadata: properties: createTime: - type: string - format: google-datetime description: Output only. The time the operation was created. readOnly: true - endTime: type: string - readOnly: true format: google-datetime + endTime: description: Output only. The time the operation finished running. - annotatorSelector: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector - description: Output only. The annotator selector used for the analysis (if any). - readOnly: true - conversation: readOnly: true - description: >- - Output only. The Conversation that this Analysis Operation belongs - to. type: string - type: object - id: GoogleCloudContactcenterinsightsV1alpha1CreateAnalysisOperationMetadata - description: Metadata for a create analysis operation. - GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata: - properties: + format: google-datetime + request: + description: Output only. The original request for initialization. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest partialErrors: - items: - $ref: '#/components/schemas/GoogleRpcStatus' description: >- - Partial errors during export operation that might cause the + Partial errors during initializing operation that might cause the operation output to be incomplete. type: array - createTime: - type: string - format: google-datetime - readOnly: true - description: Output only. The time the operation was created. - endTime: - readOnly: true - description: Output only. The time the operation finished running. - format: google-datetime - type: string - request: - description: The original request for export. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest - id: GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata - type: object - description: Metadata for an export insights operation. - GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceTimeSeries: + items: + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest: + id: GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest + description: The request to initialize a location-level encryption specification. type: object - description: A time series of metric values. properties: - dataPoints: - description: The data points that make up the time series . - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPoint - type: array - id: GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceTimeSeries - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource: + encryptionSpec: + description: >- + Required. The encryption spec used for CMEK encryption. It is + required that the kms key is in the same region as the endpoint. The + same key will be used for all provisioned resources, if encryption + is available. If the `kms_key_name` field is left empty, no + encryption will be enforced. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec + GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec: + id: GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec + description: >- + A customer-managed encryption key specification that can be applied to + all created resources (e.g. `Conversation`). type: object properties: - bucketUri: - description: Required. The Cloud Storage bucket containing source objects. - type: string - metadataBucketUri: - type: string + name: description: >- - Optional. The Cloud Storage path to the conversation metadata. Note - that: [1] Metadata files are expected to be in JSON format. [2] - Metadata and source files (transcripts or audio) must be in separate - buckets. [3] A source file and its corresponding metadata file must - share the same name to be properly ingested, E.g. - `gs://bucket/audio/conversation1.mp3` and - `gs://bucket/metadata/conversation1.json`. - customMetadataKeys: + Immutable. The resource name of the encryption key specification + resource. Format: + projects/{project}/locations/{location}/encryptionSpec + type: string + kmsKey: description: >- - Optional. Custom keys to extract as conversation labels from - metadata files in `metadata_bucket_uri`. Keys not included in this - field will be ignored. Note that there is a limit of 20 labels per - conversation. + Required. The name of customer-managed encryption key that is used + to secure a resource and its sub-resources. If empty, the resource + is secured by our default encryption key. Only the key in the same + location as this resource is allowed to be used for encryption. + Format: + `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}` + type: string + GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecResponse: + id: GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecResponse + description: The response to initialize a location-level encryption specification. + type: object + properties: {} + GoogleCloudContactcenterinsightsV1alpha1ListAllFeedbackLabelsResponse: + id: GoogleCloudContactcenterinsightsV1alpha1ListAllFeedbackLabelsResponse + description: The response for listing all feedback labels. + type: object + properties: + feedbackLabels: + description: The feedback labels that match the request. type: array items: - type: string - bucketObjectType: - description: Optional. Specifies the type of the objects in `bucket_uri`. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. type: string - enumDescriptions: - - The object type is unspecified and will default to `TRANSCRIPT`. - - The object is a transcript. - - The object is an audio file. - enum: - - BUCKET_OBJECT_TYPE_UNSPECIFIED - - TRANSCRIPT - - AUDIO - description: Configuration for Cloud Storage bucket sources. - id: >- - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource - GoogleCloudContactcenterinsightsV1View: - id: GoogleCloudContactcenterinsightsV1View + GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel: + id: GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel + description: >- + Represents a conversation, resource, and label provided by the user. Can + take the form of a string label or a QaAnswer label. QaAnswer labels are + used for Quality AI example conversations. String labels are used for + Topic Modeling. AgentAssistSummary labels are used for Agent Assist + Summarization. type: object - description: The View resource. properties: - value: - description: String with specific view properties, must be non-empty. + label: + description: String label used for Topic Modeling. type: string + qaAnswerLabel: + description: QaAnswer label used for Quality AI example conversations. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue name: + description: >- + Immutable. Resource name of the FeedbackLabel. Format: + projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label} type: string + labeledResource: description: >- - Immutable. The resource name of the view. Format: - projects/{project}/locations/{location}/views/{view} - displayName: - description: The human-readable display name of the view. + Name of the resource to be labeled. Supported resources are: * + `projects/{project}/locations/{location}/qaScorecards/{scorecard}/revisions/{revision}/qaQuestions/{question}` + * + `projects/{project}/locations/{location}/issueModels/{issue_model}` + * + `projects/{project}/locations/{location}/generators/{generator_id}` type: string createTime: - description: Output only. The time at which this view was created. - type: string + description: Output only. Create time of the label. readOnly: true + type: string format: google-datetime updateTime: - type: string + description: Output only. Update time of the label. readOnly: true - format: google-datetime - description: Output only. The most recent time at which the view was updated. - GoogleCloudContactcenterinsightsV1ConversationDataSource: - description: The conversation source, which is a combination of transcript and audio. - type: object - id: GoogleCloudContactcenterinsightsV1ConversationDataSource - properties: - dialogflowSource: - description: The source when the conversation comes from Dialogflow. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1DialogflowSource - gcsSource: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1GcsSource' - description: A Cloud Storage location specification for the audio and transcript. - GoogleCloudContactcenterinsightsV1AnalysisResult: - properties: - callAnalysisMetadata: - description: Call-specific metadata created by the analysis. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata - endTime: - description: The time at which the analysis ended. - format: google-datetime type: string + format: google-datetime + GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue: + id: GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue + description: >- + Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice + defines the possible answer values for a question. type: object - id: GoogleCloudContactcenterinsightsV1AnalysisResult - description: The result of an analysis. - GoogleCloudContactcenterinsightsV1alpha1Conversation: - description: The conversation resource. - id: GoogleCloudContactcenterinsightsV1alpha1Conversation properties: - ttl: + strValue: + description: String value. type: string + numValue: + description: Numerical value. + type: number + format: double + boolValue: + description: Boolean value. + type: boolean + naValue: + description: A value of "Not Applicable (N/A)". Should only ever be `true`. + type: boolean + skipValue: description: >- - Input only. The TTL for this resource. If specified, then this TTL - will be used to calculate the expire time. - format: google-duration - latestAnalysis: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Analysis - readOnly: true - description: Output only. The conversation's latest analysis, if one exists. - turnCount: - format: int32 - type: integer - description: Output only. The number of turns in the conversation. - readOnly: true - createTime: - description: Output only. The time at which the conversation was created. - type: string + Output only. A value of "Skip". If provided, this field may only be + set to `true`. If a question receives this answer, it will be + excluded from any score calculations. This would mean that the + question was not evaluated. readOnly: true - format: google-datetime - agentId: - type: string - description: >- - An opaque, user-specified string representing the human agent who - handled the conversation. - name: - description: >- - Immutable. The resource name of the conversation. Format: - projects/{project}/locations/{location}/conversations/{conversation} - type: string - metadataJson: + type: boolean + key: description: >- - Input only. JSON metadata encoded as a string. This field is - primarily used by Insights integrations with various telphony - systems and must be in one of Insight's supported formats. + A short string used as an identifier. Matches the value used in + QaQuestion.AnswerChoice.key. type: string - dataSource: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource - description: The source of the audio and transcription for the conversation. - latestSummary: - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData - description: Output only. Latest summary of the conversation. - duration: + score: + description: Output only. Numerical score of the answer. readOnly: true - format: google-duration - description: Output only. The duration of the conversation. - type: string - runtimeAnnotations: + type: number + format: double + potentialScore: + description: Output only. The maximum potential score of the question. readOnly: true + type: number + format: double + normalizedScore: description: >- - Output only. The annotations that were generated during the customer - and agent interaction. - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation - type: array - callMetadata: - description: Call-specific metadata. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata - obfuscatedUserId: - type: string - description: Obfuscated user ID which the customer sent to us. - medium: - enum: - - MEDIUM_UNSPECIFIED - - PHONE_CALL - - CHAT - type: string - enumDescriptions: - - Default value, if unspecified will default to PHONE_CALL. - - The format for conversations that took place over the phone. - - The format for conversations that took place over chat. - description: >- - Immutable. The conversation medium, if unspecified will default to - PHONE_CALL. - dialogflowIntents: + Output only. Normalized score of the questions. Calculated as score + / potential_score. readOnly: true - description: >- - Output only. All the matched Dialogflow intents in the call. The key - corresponds to a Dialogflow intent, format: - projects/{project}/agent/{agent}/intents/{intent} - type: object - additionalProperties: + type: number + format: double + GoogleCloudContactcenterinsightsV1alpha1ListFeedbackLabelsResponse: + id: GoogleCloudContactcenterinsightsV1alpha1ListFeedbackLabelsResponse + description: The response for listing feedback labels. + type: object + properties: + feedbackLabels: + description: The feedback labels that match the request. + type: array + items: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent - updateTime: - description: >- - Output only. The most recent time at which the conversation was - updated. - format: google-datetime - type: string - readOnly: true - labels: - description: >- - A map for the user to specify any custom fields. A maximum of 20 - labels per conversation is allowed, with a maximum of 256 characters - per entry. - additionalProperties: - type: string - type: object - languageCode: - type: string - description: A user-specified language code for the conversation. - qualityMetadata: - description: Conversation metadata related to quality management. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata - expireTime: - description: >- - The time at which this conversation should expire. After this time, - the conversation data and any associated analyses will be deleted. - format: google-datetime - type: string - transcript: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript - description: Output only. The conversation transcript. - readOnly: true - startTime: - format: google-datetime + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel + nextPageToken: + description: The next page token. type: string - description: The time at which the conversation started. + GoogleCloudContactcenterinsightsV1alpha1QueryMetricsMetadata: + id: GoogleCloudContactcenterinsightsV1alpha1QueryMetricsMetadata + description: The metadata from querying metrics. type: object - GoogleCloudContactcenterinsightsV1alpha1EntityMentionData: - description: >- - The data for an entity mention annotation. This represents a mention of - an `Entity` in the conversation. - id: GoogleCloudContactcenterinsightsV1alpha1EntityMentionData properties: - type: - type: string - enumDescriptions: - - Unspecified. - - Proper noun. - - Common noun (or noun compound). - description: The type of the entity mention. - enum: - - MENTION_TYPE_UNSPECIFIED - - PROPER - - COMMON - entityUniqueId: + resultIsTruncated: description: >- - The key of this entity in conversation entities. Can be used to - retrieve the exact `Entity` this mention is attached to. - type: string - sentiment: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData - description: Sentiment expressed for this mention of the entity. - type: object - GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure: - id: >- - GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure + Whether the result rows were truncated because the result row size + is too large to materialize. + type: boolean + GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponse: + id: GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponse + description: The response for querying metrics. type: object properties: - averageQaQuestionNormalizedScore: + location: description: >- - Average QA normalized score averaged for questions averaged across - all revisions of the parent scorecard. Will be only populated if the - request specifies a dimension of QA_QUESTION_ID. - type: number - format: double - averageCustomerSatisfactionRating: - type: number - format: double - description: The average customer satisfaction rating. - averageTurnCount: - format: float - type: number - description: The average turn count. - averageSilencePercentage: - description: The average silence percentage. - type: number - format: float - averageAgentSentimentScore: - description: The average agent's sentiment score. - format: float - type: number - conversationCount: - type: integer - format: int32 - description: The conversation count. - averageDuration: - description: The average duration. - format: google-duration + Required. The location of the data. + "projects/{project}/locations/{location}" type: string - averageQaNormalizedScore: - format: double + updateTime: + description: The metrics last update time. + type: string + format: google-datetime + slices: description: >- - Average QA normalized score. Will exclude 0's in average - calculation. - type: number - averageClientSentimentScore: - description: The average client's sentiment score. - type: number - format: float - qaTagScores: + A slice contains a total and (if the request specified a time + granularity) a time series of metric values. Each slice contains a + unique combination of the cardinality of dimensions from the + request. + type: array items: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore - type: array - description: Average QA normalized score for all the tags. - description: The measure related to conversations. - GoogleCloudContactcenterinsightsV1ImportIssueModelMetadata: - id: GoogleCloudContactcenterinsightsV1ImportIssueModelMetadata - properties: - createTime: - format: google-datetime - type: string - description: The time the operation was created. - endTime: - format: google-datetime - type: string - description: The time the operation finished running. - request: - description: The original import request. + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSlice + macroAverageSlice: + description: >- + The macro average slice contains aggregated averages across the + selected dimension. i.e. if group_by agent is specified this field + will contain the average across all agents. This field is only + populated if the request specifies a Dimension. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ImportIssueModelRequest - description: Metadata used for import issue model. + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSlice + GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSlice: + id: GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSlice + description: >- + A slice contains a total and (if the request specified a time + granularity) a time series of metric values. Each slice contains a + unique combination of the cardinality of dimensions from the request. + For example, if the request specifies a single ISSUE dimension and it + has a cardinality of 2 (i.e. the data used to compute the metrics has 2 + issues in total), the response will have 2 slices: * Slice 1 -> + dimensions=[Issue 1] * Slice 2 -> dimensions=[Issue 2] type: object - GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest: properties: - analysisPercentage: - description: >- - Required. Percentage of selected conversation to analyze, between - [0, 100]. - format: float - type: number - filter: - type: string + dimensions: + description: A unique combination of dimensions that this slice represents. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Dimension + total: description: >- - Required. Filter used to select the subset of conversations to - analyze. - annotatorSelector: + The total metric value. The interval of this data point is [starting + create time, ending create time) from the request. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPoint + timeSeries: description: >- - To select the annotators to run and the phrase matchers to use (if - any). If not specified, all annotators will be run. + A time series of metric values. This is only populated if the + request specifies a time granularity other than NONE. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelector - parent: - description: Required. The parent resource to create analyses in. - type: string - id: GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest - type: object - description: The request to analyze conversations in bulk. - GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest: + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceTimeSeries + GoogleCloudContactcenterinsightsV1alpha1Dimension: + id: GoogleCloudContactcenterinsightsV1alpha1Dimension + description: >- + A dimension determines the grouping key for the query. In SQL terms, + these would be part of both the "SELECT" and "GROUP BY" clauses. type: object - id: GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest properties: - conversationId: - description: >- - Optional. A unique ID for the new conversation. This ID will become - the final component of the conversation's resource name. If no ID is - specified, a server-generated ID will be used. This value should be - 4-64 characters and must match the regular expression - `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-` - type: string - conversation: - description: Required. The conversation resource to create. + issueDimensionMetadata: + description: Output only. Metadata about the issue dimension. + readOnly: true $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Conversation - parent: - type: string - description: Required. The parent resource of the conversation. - speechConfig: - description: >- - Optional. Speech-to-Text configuration. Will default to the config - specified in Settings. + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DimensionIssueDimensionMetadata + agentDimensionMetadata: + description: Output only. Metadata about the agent dimension. + readOnly: true $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SpeechConfig - redactionConfig: - description: >- - Optional. DLP settings for transcript redaction. Will default to the - config specified in Settings. + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DimensionAgentDimensionMetadata + qaQuestionDimensionMetadata: + description: Output only. Metadata about the QA question dimension. + readOnly: true $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RedactionConfig - description: Request to upload a conversation. - GoogleCloudContactcenterinsightsV1alpha1AnalysisResult: + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionDimensionMetadata + qaQuestionAnswerDimensionMetadata: + description: Output only. Metadata about the QA question-answer dimension. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionAnswerDimensionMetadata + dimensionKey: + description: The key of the dimension. + type: string + enumDescriptions: + - The key of the dimension is unspecified. + - The dimension is keyed by issues. + - The dimension is keyed by issue names. + - The dimension is keyed by agents. + - The dimension is keyed by agent teams. + - >- + The dimension is keyed by QaQuestionIds. Note that: We only group + by the QuestionId and not the revision-id of the scorecard this + question is a part of. This allows for showing stats for the same + question across different scorecard revisions. + - >- + The dimension is keyed by QaQuestionIds-Answer value pairs. Note + that: We only group by the QuestionId and not the revision-id of + the scorecard this question is a part of. This allows for showing + distribution of answers per question across different scorecard + revisions. + - >- + The dimension is keyed by QaScorecardIds. Note that: We only group + by the ScorecardId and not the revision-id of the scorecard. This + allows for showing stats for the same scorecard across different + revisions. This metric is mostly only useful if querying the + average normalized score per scorecard. + - The dimension is keyed by the conversation profile ID. + - The dimension is keyed by the conversation medium. + enum: + - DIMENSION_KEY_UNSPECIFIED + - ISSUE + - ISSUE_NAME + - AGENT + - AGENT_TEAM + - QA_QUESTION_ID + - QA_QUESTION_ANSWER_VALUE + - QA_SCORECARD_ID + - CONVERSATION_PROFILE_ID + - MEDIUM + GoogleCloudContactcenterinsightsV1alpha1DimensionIssueDimensionMetadata: + id: GoogleCloudContactcenterinsightsV1alpha1DimensionIssueDimensionMetadata + description: Metadata about the issue dimension. type: object properties: - endTime: - format: google-datetime - description: The time at which the analysis ended. + issueId: + description: The issue ID. type: string - callAnalysisMetadata: - description: Call-specific metadata created by the analysis. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata - description: The result of an analysis. - id: GoogleCloudContactcenterinsightsV1alpha1AnalysisResult - GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector: - id: GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector - description: Selector of all available annotators and phrase matchers to run. + issueDisplayName: + description: The issue display name. + type: string + issueModelId: + description: The parent issue model ID. + type: string + GoogleCloudContactcenterinsightsV1alpha1DimensionAgentDimensionMetadata: + id: GoogleCloudContactcenterinsightsV1alpha1DimensionAgentDimensionMetadata + description: Metadata about the agent dimension. + type: object properties: - runPhraseMatcherAnnotator: - type: boolean - description: Whether to run the active phrase matcher annotator(s). - runSentimentAnnotator: - description: Whether to run the sentiment annotator. - type: boolean - runSilenceAnnotator: - description: Whether to run the silence annotator. - type: boolean - issueModels: - description: >- - The issue model to run. If not provided, the most recently deployed - topic model will be used. The provided issue model will only be used - for inference if the issue model is deployed and if - run_issue_model_annotator is set to true. If more than one issue - model is provided, only the first provided issue model will be used - for inference. - type: array - items: - type: string - phraseMatchers: - description: >- - The list of phrase matchers to run. If not provided, all active - phrase matchers will be used. If inactive phrase matchers are - provided, they will not be used. Phrase matchers will be run only if - run_phrase_matcher_annotator is set to true. Format: - projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} - type: array - items: - type: string - summarizationConfig: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig - description: Configuration for the summarization annotator. - runSummarizationAnnotator: - description: Whether to run the summarization annotator. - type: boolean - qaConfig: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorQaConfig - description: Configuration for the QA annotator. - runIssueModelAnnotator: - type: boolean - description: >- - Whether to run the issue model annotator. A model should have - already been deployed for this to take effect. - runEntityAnnotator: - type: boolean - description: Whether to run the entity annotator. - runIntentAnnotator: - type: boolean - description: Whether to run the intent annotator. - runInterruptionAnnotator: - type: boolean - description: Whether to run the interruption annotator. - runQaAnnotator: - type: boolean - description: Whether to run the QA annotator. + agentId: + description: Optional. A user-specified string representing the agent. + type: string + agentDisplayName: + description: Optional. The agent's name + type: string + agentTeam: + description: Optional. A user-specified string representing the agent's team. + type: string + GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionDimensionMetadata: + id: >- + GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionDimensionMetadata + description: Metadata about the QA question dimension. type: object - GoogleCloudContactcenterinsightsV1Intent: - id: GoogleCloudContactcenterinsightsV1Intent + properties: + qaScorecardId: + description: Optional. The QA scorecard ID. + type: string + qaQuestionId: + description: Optional. The QA question ID. + type: string + questionBody: + description: Optional. The full body of the question. + type: string + GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionAnswerDimensionMetadata: + id: >- + GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionAnswerDimensionMetadata description: >- - The data for an intent. Represents a detected intent in the - conversation, for example MAKES_PROMISE. + Metadata about the QA question-answer dimension. This is useful for + showing the answer distribution for questions for a given scorecard. type: object properties: - displayName: + qaScorecardId: + description: Optional. The QA scorecard ID. type: string - description: The human-readable name of the intent. - id: + qaQuestionId: + description: Optional. The QA question ID. type: string - description: The unique identifier of the intent. - GoogleCloudContactcenterinsightsV1Conversation: - description: The conversation resource. + questionBody: + description: Optional. The full body of the question. + type: string + answerValue: + description: Optional. The full body of the question. + type: string + GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPoint: + id: >- + GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPoint + description: A data point contains the metric values mapped to an interval. + type: object properties: - callMetadata: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationCallMetadata - description: Call-specific metadata. - qualityMetadata: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationQualityMetadata - description: Conversation metadata related to quality management. - transcript: + conversationMeasure: + description: The measure related to conversations. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationTranscript - readOnly: true - description: Output only. The conversation transcript. - medium: - enumDescriptions: - - Default value, if unspecified will default to PHONE_CALL. - - The format for conversations that took place over the phone. - - The format for conversations that took place over chat. - type: string - enum: - - MEDIUM_UNSPECIFIED - - PHONE_CALL - - CHAT + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure + interval: description: >- - Immutable. The conversation medium, if unspecified will default to - PHONE_CALL. - latestAnalysis: - description: Output only. The conversation's latest analysis, if one exists. - readOnly: true - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Analysis' - createTime: - format: google-datetime - description: Output only. The time at which the conversation was created. + The interval that this data point represents. * If this is the total + data point, the interval is [starting create time, ending create + time) from the request. * If this a data point from the time series, + the interval is [time, time + time granularity from the request). + $ref: '#/components/schemas/GoogleTypeInterval' + GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure: + id: >- + GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure + description: The measure related to conversations. + type: object + properties: + conversationCount: + description: The conversation count. + type: integer + format: int32 + averageSilencePercentage: + description: The average silence percentage. + type: number + format: float + averageDuration: + description: The average duration. type: string - readOnly: true - updateTime: - readOnly: true + format: google-duration + averageTurnCount: + description: The average turn count. + type: number + format: float + averageAgentSentimentScore: + description: The average agent's sentiment score. + type: number + format: float + averageClientSentimentScore: + description: The average client's sentiment score. + type: number + format: float + averageCustomerSatisfactionRating: + description: The average customer satisfaction rating. + type: number + format: double + averageQaNormalizedScore: description: >- - Output only. The most recent time at which the conversation was - updated. - type: string - format: google-datetime - runtimeAnnotations: + Average QA normalized score. Will exclude 0's in average + calculation. + type: number + format: double + qaTagScores: + description: Average QA normalized score for all the tags. type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore + averageQaQuestionNormalizedScore: description: >- - Output only. The annotations that were generated during the customer - and agent interaction. - readOnly: true + Average QA normalized score averaged for questions averaged across + all revisions of the parent scorecard. Will be only populated if the + request specifies a dimension of QA_QUESTION_ID. + type: number + format: double + GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore: + id: >- + GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore + description: Average QA normalized score for the tag. + type: object + properties: + tag: + description: Tag name. + type: string + averageTagNormalizedScore: + description: Average tag normalized score per tag. + type: number + format: double + GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceTimeSeries: + id: >- + GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceTimeSeries + description: A time series of metric values. + type: object + properties: + dataPoints: + description: The data points that make up the time series . + type: array items: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1RuntimeAnnotation - dialogflowIntents: + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPoint + GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewMetadata: + id: GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewMetadata + description: The metadata for querying performance overview. + type: object + properties: {} + GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewResponse: + id: GoogleCloudContactcenterinsightsV1alpha1QueryPerformanceOverviewResponse + description: The response for querying performance overview. + type: object + properties: + summaryText: + description: The summary text of the performance. + type: string + GoogleCloudContactcenterinsightsV1alpha1SampleConversationsMetadata: + id: GoogleCloudContactcenterinsightsV1alpha1SampleConversationsMetadata + description: The metadata for an SampleConversations operation. + type: object + properties: + createTime: + description: Output only. The time the operation was created. + readOnly: true + type: string + format: google-datetime + endTime: + description: Output only. The time the operation finished running. + readOnly: true + type: string + format: google-datetime + request: description: >- - Output only. All the matched Dialogflow intents in the call. The key - corresponds to a Dialogflow intent, format: - projects/{project}/agent/{agent}/intents/{intent} + Output only. The original request for sample conversations to + dataset. readOnly: true - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1DialogflowIntent - type: object - ttl: - format: google-duration + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SampleConversationsRequest + partialErrors: description: >- - Input only. The TTL for this resource. If specified, then this TTL - will be used to calculate the expire time. + Output only. Partial errors during sample conversations operation + that might cause the operation output to be incomplete. + readOnly: true + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + sampleConversationsStats: + description: Output only. Statistics for SampleConversations operation. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SampleConversationsMetadataSampleConversationsStats + GoogleCloudContactcenterinsightsV1alpha1SampleConversationsRequest: + id: GoogleCloudContactcenterinsightsV1alpha1SampleConversationsRequest + description: The request to sample conversations to a dataset. + type: object + properties: + destinationDataset: + description: The dataset resource to copy the sampled conversations to. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Dataset' + parent: + description: Required. The parent resource of the dataset. type: string - labels: - type: object - additionalProperties: - type: string - description: >- - A map for the user to specify any custom fields. A maximum of 20 - labels per conversation is allowed, with a maximum of 256 characters - per entry. + sampleRule: + description: Optional. The sample rule used for sampling conversations. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SampleRule + GoogleCloudContactcenterinsightsV1alpha1Dataset: + id: GoogleCloudContactcenterinsightsV1alpha1Dataset + description: >- + Dataset resource represents a collection of conversations that may be + bounded (Static Dataset, e.g. golden dataset for training), or unbounded + (Dynamic Dataset, e.g. live traffic, or agent training traffic) + type: object + properties: name: - type: string description: >- - Immutable. The resource name of the conversation. Format: - projects/{project}/locations/{location}/conversations/{conversation} - metadataJson: + Immutable. Identifier. Resource name of the dataset. Format: + projects/{project}/locations/{location}/datasets/{dataset} type: string - description: >- - Input only. JSON metadata encoded as a string. This field is - primarily used by Insights integrations with various telphony - systems and must be in one of Insight's supported formats. - expireTime: + displayName: + description: Display name for the dataaset type: string - format: google-datetime - description: >- - The time at which this conversation should expire. After this time, - the conversation data and any associated analyses will be deleted. - languageCode: + description: + description: Dataset description. type: string - description: A user-specified language code for the conversation. - obfuscatedUserId: - description: Obfuscated user ID which the customer sent to us. + type: + description: Dataset usage type. type: string - duration: - readOnly: true - format: google-duration - description: Output only. The duration of the conversation. + enumDescriptions: + - Default value for unspecified. + - For evals only. + - >- + Dataset with new conversations coming in regularly (Insights + legacy conversations and AI trainer) + enum: + - TYPE_UNSPECIFIED + - EVAL + - LIVE + ttl: + description: Optional. Option TTL for the dataset. type: string - turnCount: - type: integer + format: google-duration + createTime: + description: Output only. Dataset create time. readOnly: true - format: int32 - description: Output only. The number of turns in the conversation. - agentId: type: string - description: >- - An opaque, user-specified string representing the human agent who - handled the conversation. - latestSummary: + format: google-datetime + updateTime: + description: Output only. Dataset update time. readOnly: true - description: Output only. Latest summary of the conversation. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData - dataSource: - description: The source of the audio and transcription for the conversation. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationDataSource - startTime: type: string format: google-datetime - description: The time at which the conversation started. + GoogleCloudContactcenterinsightsV1alpha1SampleRule: + id: GoogleCloudContactcenterinsightsV1alpha1SampleRule + description: Message for sampling conversations. type: object - id: GoogleCloudContactcenterinsightsV1Conversation - GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPoint: properties: - conversationMeasure: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure - description: The measure related to conversations. - interval: - $ref: '#/components/schemas/GoogleTypeInterval' + samplePercentage: description: >- - The interval that this data point represents. * If this is the total - data point, the interval is [starting create time, ending create - time) from the request. * If this a data point from the time series, - the interval is [time, time + time granularity from the request). + Percentage of conversations that we should sample based on the + dimension between [0, 100]. + type: number + format: double + sampleRow: + description: >- + Number of the conversations that we should sample based on the + dimension. + type: string + format: int64 + dimension: + description: >- + Optional. Group by dimension to sample the conversation. If no + dimension is provided, the sampling will be applied to the project + level. Current supported dimensions is + 'quality_metadata.agent_info.agent_id'. + type: string + conversationFilter: + description: >- + To specify the filter for the conversions that should apply this + sample rule. An empty filter means this sample rule applies to all + conversations. + type: string + GoogleCloudContactcenterinsightsV1alpha1SampleConversationsMetadataSampleConversationsStats: id: >- - GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPoint - description: A data point contains the metric values mapped to an interval. + GoogleCloudContactcenterinsightsV1alpha1SampleConversationsMetadataSampleConversationsStats + description: Statistics for SampleConversations operation. type: object - GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation: properties: - smartComposeSuggestion: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData - description: Agent Assist Smart Compose suggestion data. - conversationSummarizationSuggestion: - description: Conversation summarization suggestion data. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData - endBoundary: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary + successfulSampleCount: description: >- - The boundary in the conversation where the annotation ends, - inclusive. - dialogflowInteraction: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData - description: Dialogflow interaction data. - userInput: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotationUserInput - description: Explicit input used for generating the answer - startBoundary: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary + Output only. The number of new conversations added during this + sample operation. + readOnly: true + type: integer + format: int32 + failedSampleCount: description: >- - The boundary in the conversation where the annotation starts, - inclusive. - answerFeedback: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback - description: The feedback that the customer has about the answer in `data`. + Output only. The number of objects which were unable to be sampled + due to errors. The errors are populated in the partial_errors field. + readOnly: true + type: integer + format: int32 + GoogleCloudContactcenterinsightsV1alpha1SampleConversationsResponse: + id: GoogleCloudContactcenterinsightsV1alpha1SampleConversationsResponse + description: The response to an SampleConversations operation. + type: object + properties: {} + GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelMetadata: + id: GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelMetadata + description: Metadata for undeploying an issue model. + type: object + properties: createTime: - description: The time at which this annotation was created. + description: Output only. The time the operation was created. + readOnly: true + type: string format: google-datetime + endTime: + description: Output only. The time the operation finished running. + readOnly: true type: string - faqAnswer: + format: google-datetime + request: + description: The original request for undeployment. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData - description: Agent Assist FAQ answer data. - smartReply: - description: Agent Assist Smart Reply data. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SmartReplyData - articleSuggestion: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData - description: Agent Assist Article Suggestion data. - annotationId: - type: string - description: >- - The unique identifier of the annotation. Format: - projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation} - id: GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation - description: >- - An annotation that was generated during the customer and agent - interaction. + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest + GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest: + id: GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest + description: The request to undeploy an issue model. type: object - GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest: properties: name: - description: Required. The name of the issue model to delete. + description: Required. The issue model to undeploy. type: string - description: The request to delete an issue model. + GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelResponse: + id: GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelResponse + description: The response to undeploy an issue model. type: object - id: GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest - GoogleCloudContactcenterinsightsV1QaQuestion: - id: GoogleCloudContactcenterinsightsV1QaQuestion + properties: {} + GoogleCloudContactcenterinsightsV1alpha1UpdateQaQuestionTagMetadata: + id: GoogleCloudContactcenterinsightsV1alpha1UpdateQaQuestionTagMetadata + description: The metadata for updating a QaQuestionTag Resource. type: object properties: - abbreviation: - type: string - description: >- - Short, descriptive string, used in the UI where it's not practical - to display the full question body. E.g., "Greeting". - metrics: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestionMetrics - description: >- - Metrics of the underlying tuned LLM over a holdout/test set while - fine tuning the underlying LLM for the given question. This field - will only be populated if and only if the question is part of a - scorecard revision that has been tuned. createTime: + description: Output only. The time the operation was created. + readOnly: true + type: string format: google-datetime + endTime: + description: Output only. The time the operation finished running. + readOnly: true type: string - description: Output only. The time at which this question was created. + format: google-datetime + request: + description: Output only. The original request. readOnly: true - order: - type: integer - description: >- - Defines the order of the question within its parent scorecard - revision. - format: int32 - answerChoices: - description: >- - A list of valid answers to the question, which the LLM must choose - from. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestionAnswerChoice - tuningMetadata: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestionTuningMetadata + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1UpdateQaQuestionTagRequest + GoogleCloudContactcenterinsightsV1alpha1UpdateQaQuestionTagRequest: + id: GoogleCloudContactcenterinsightsV1alpha1UpdateQaQuestionTagRequest + description: The request for updating a QaQuestionTag. + type: object + properties: + qaQuestionTag: + description: Required. The QaQuestionTag to update. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag + updateMask: description: >- - Metadata about the tuning operation for the question.This field will - only be populated if and only if the question is part of a scorecard - revision that has been tuned. - name: + Optional. The list of fields to be updated. All possible fields can + be updated by passing `*`, or a subset of the following updateable + fields can be provided: * `qa_question_tag_name` - the name of the + tag * `qa_question_ids` - the list of questions the tag applies to type: string + format: google-fieldmask + GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag: + id: GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag + description: >- + A tag is a resource which aims to categorize a set of questions across + multiple scorecards, e.g., "Customer Satisfaction","Billing", etc. + type: object + properties: + name: description: >- - Identifier. The resource name of the question. Format: - projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}/qaQuestions/{qa_question} - tags: + Identifier. Resource name for the QaQuestionTag Format + projects/{project}/locations/{location}/qaQuestionTags/{qa_question_tag} + In the above format, the last segment, i.e., qa_question_tag, is a + server-generated ID corresponding to the tag resource. + type: string + displayName: + description: Required. A user-specified display name for the tag. + type: string + qaQuestionIds: description: >- - User-defined list of arbitrary tags for the question. Used for - grouping/organization and for weighting the score of each question. + Optional. The list of Scorecard Question IDs that the tag applies + to. Each QaQuestionId is represented as a full resource name + containing the Question ID. Lastly, Since a tag may not necessarily + be referenced by any Scorecard Questions, we treat this field as + optional. type: array items: type: string - updateTime: + createTime: + description: Output only. The time at which the question tag was created. readOnly: true type: string - description: Output only. The most recent time at which the question was updated. format: google-datetime - questionBody: - type: string - description: Question text. E.g., "Did the agent greet the customer?" - answerInstructions: - description: Instructions describing how to determine the answer. + updateTime: + description: >- + Output only. The most recent time at which the question tag was + updated. + readOnly: true type: string - description: A single question to be scored by the Insights QA feature. - GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue: - id: GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue + format: google-datetime + GoogleCloudContactcenterinsightsV1alpha1UploadConversationMetadata: + id: GoogleCloudContactcenterinsightsV1alpha1UploadConversationMetadata + description: The metadata for an `UploadConversation` operation. + type: object properties: - strValue: + createTime: + description: Output only. The time the operation was created. + readOnly: true type: string - description: String value. - numValue: - type: number - format: double - description: Numerical value. - normalizedScore: + format: google-datetime + endTime: + description: Output only. The time the operation finished running. readOnly: true - description: >- - Output only. Normalized score of the questions. Calculated as score - / potential_score iff potential_score != 0 else 0 - format: double - type: number - boolValue: - type: boolean - description: Boolean value. - score: - description: Output only. Numerical score of the answer. - type: number - format: double + type: string + format: google-datetime + request: + description: Output only. The original request. readOnly: true - potentialScore: - description: Output only. The maximum potential score of the question. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest + analysisOperation: + description: >- + Output only. The operation name for a successfully created analysis + operation, if any. readOnly: true - format: double - type: number - key: type: string + appliedRedactionConfig: description: >- - A short string used as an identifier. Matches the value used in - QaQuestion.AnswerChoice.key. - naValue: - type: boolean - description: A value of "Not Applicable (N/A)". - description: >- - Message for holding the value of the answer. QaQuestion.AnswerChoice - defines the possible answer values for a question. + Output only. The redaction config applied to the uploaded + conversation. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RedactionConfig + GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest: + id: GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest + description: Request to upload a conversation. type: object - GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadataDownloadStats: - description: Statistics for BulkDownloadFeedbackLabels operation. + properties: + parent: + description: Required. The parent resource of the conversation. + type: string + conversation: + description: Required. The conversation resource to create. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Conversation + conversationId: + description: >- + Optional. A unique ID for the new conversation. This ID will become + the final component of the conversation's resource name. If no ID is + specified, a server-generated ID will be used. This value should be + 4-64 characters and must match the regular expression + `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-` + type: string + redactionConfig: + description: >- + Optional. DLP settings for transcript redaction. Will default to the + config specified in Settings. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RedactionConfig + speechConfig: + description: >- + Optional. Speech-to-Text configuration. Will default to the config + specified in Settings. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SpeechConfig + GoogleCloudContactcenterinsightsV1alpha1Conversation: + id: GoogleCloudContactcenterinsightsV1alpha1Conversation + description: The conversation resource. type: object - id: >- - GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsMetadataDownloadStats properties: - totalFilesWritten: - type: integer - format: int32 - description: Total number of files written to the provided Cloud Storage bucket. - successfulDownloadCount: - type: integer + callMetadata: + description: Call-specific metadata. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata + expireTime: description: >- - The number of new feedback labels downloaded during this operation. - Different from "processed" because some labels might not be - downloaded because an error. - format: int32 - processedObjectCount: - type: integer - format: int32 - description: The number of objects processed during the download operation. - fileNames: + The time at which this conversation should expire. After this time, + the conversation data and any associated analyses will be deleted. + type: string + format: google-datetime + ttl: + description: >- + Input only. The TTL for this resource. If specified, then this TTL + will be used to calculate the expire time. + type: string + format: google-duration + name: + description: >- + Immutable. The resource name of the conversation. Format: + projects/{project}/locations/{location}/conversations/{conversation} + type: string + dataSource: + description: The source of the audio and transcription for the conversation. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource + createTime: + description: Output only. The time at which the conversation was created. readOnly: true - description: Output only. Full name of the files written to Cloud storage. - type: array - items: - type: string - parameters: - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string - _.xgafv: - description: V1 error format. - in: query - name: $.xgafv - schema: - type: string - enum: - - '1' - - '2' - alt: - description: Data format for response. - in: query - name: alt - schema: - type: string - enum: - - json - - media - - proto - 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 - 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 - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - type: string - access_token: - description: OAuth access token. - in: query - name: access_token - schema: - type: string - callback: - description: JSONP - in: query - name: callback - schema: - type: string - oauth_token: - description: OAuth 2.0 token for the current user. - in: query - name: oauth_token - schema: - type: string - x-stackQL-resources: - phrase_matchers: - id: google.contactcenterinsights.phrase_matchers - name: phrase_matchers - title: Phrase_matchers - methods: - patch: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1phraseMatchers~1{phraseMatchersId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1phraseMatchers~1{phraseMatchersId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1phraseMatchers~1{phraseMatchersId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - create: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1phraseMatchers/post - response: - mediaType: application/json - openAPIDocKey: '200' - list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1phraseMatchers/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.phraseMatchers - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/phrase_matchers/methods/get' - - $ref: '#/components/x-stackQL-resources/phrase_matchers/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/phrase_matchers/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/phrase_matchers/methods/patch' - replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/phrase_matchers/methods/delete' - encryption_spec: - id: google.contactcenterinsights.encryption_spec - name: encryption_spec - title: Encryption_spec - methods: - initialize: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1encryptionSpec:initialize/post - response: - mediaType: application/json - openAPIDocKey: '200' - get_encryption_spec: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1encryptionSpec/get - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/encryption_spec/methods/get_encryption_spec - insert: [] - update: [] - replace: [] - delete: [] - feedback_labels: - id: google.contactcenterinsights.feedback_labels - name: feedback_labels - title: Feedback_labels - methods: - get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSet~1{authorizedViewSetId}~1authorizedViews~1{authorizedViewsId}~1conversations~1{conversationsId}~1feedbackLabels~1{feedbackLabelsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - patch: - operation: + type: string + format: google-datetime + updateTime: + description: >- + Output only. The most recent time at which the conversation was + updated. + readOnly: true + type: string + format: google-datetime + startTime: + description: The time at which the conversation started. + type: string + format: google-datetime + languageCode: + description: A user-specified language code for the conversation. + type: string + agentId: + description: >- + An opaque, user-specified string representing the human agent who + handled the conversation. + type: string + labels: + description: >- + A map for the user to specify any custom fields. A maximum of 100 + labels per conversation is allowed, with a maximum of 256 characters + per entry. + type: object + additionalProperties: + type: string + qualityMetadata: + description: Conversation metadata related to quality management. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata + metadataJson: + description: >- + Input only. JSON metadata encoded as a string. This field is + primarily used by Insights integrations with various telephony + systems and must be in one of Insight's supported formats. + type: string + transcript: + description: Output only. The conversation transcript. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript + medium: + description: >- + Immutable. The conversation medium, if unspecified will default to + PHONE_CALL. + type: string + enumDescriptions: + - Default value, if unspecified will default to PHONE_CALL. + - The format for conversations that took place over the phone. + - The format for conversations that took place over chat. + enum: + - MEDIUM_UNSPECIFIED + - PHONE_CALL + - CHAT + duration: + description: Output only. The duration of the conversation. + readOnly: true + type: string + format: google-duration + turnCount: + description: Output only. The number of turns in the conversation. + readOnly: true + type: integer + format: int32 + latestAnalysis: + description: Output only. The conversation's latest analysis, if one exists. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Analysis + latestSummary: + description: Output only. Latest summary of the conversation. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData + runtimeAnnotations: + description: >- + Output only. The annotations that were generated during the customer + and agent interaction. + readOnly: true + type: array + items: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSet~1{authorizedViewSetId}~1authorizedViews~1{authorizedViewsId}~1conversations~1{conversationsId}~1feedbackLabels~1{feedbackLabelsId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation + dialogflowIntents: + description: >- + Output only. All the matched Dialogflow intents in the call. The key + corresponds to a Dialogflow intent, format: + projects/{project}/agent/{agent}/intents/{intent} + readOnly: true + type: object + additionalProperties: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSet~1{authorizedViewSetId}~1authorizedViews~1{authorizedViewsId}~1conversations~1{conversationsId}~1feedbackLabels~1{feedbackLabelsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSet~1{authorizedViewSetId}~1authorizedViews~1{authorizedViewsId}~1conversations~1{conversationsId}~1feedbackLabels/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.feedbackLabels - create: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSet~1{authorizedViewSetId}~1authorizedViews~1{authorizedViewsId}~1conversations~1{conversationsId}~1feedbackLabels/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/feedback_labels/methods/get' - - $ref: '#/components/x-stackQL-resources/feedback_labels/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/feedback_labels/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/feedback_labels/methods/patch' - replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/feedback_labels/methods/delete' - analyses: - id: google.contactcenterinsights.analyses - name: analyses - title: Analyses - methods: - list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews~1{authorizedViewsId}~1conversations~1{conversationsId}~1analyses/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.analyses - create: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews~1{authorizedViewsId}~1conversations~1{conversationsId}~1analyses/post - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent + obfuscatedUserId: + description: Obfuscated user ID which the customer sent to us. + type: string + GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata: + id: GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata + description: Call-specific metadata. + type: object + properties: + customerChannel: + description: The audio channel that contains the customer. + type: integer + format: int32 + agentChannel: + description: The audio channel that contains the agent. + type: integer + format: int32 + GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource: + id: GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource + description: The conversation source, which is a combination of transcript and audio. + type: object + properties: + gcsSource: + description: A Cloud Storage location specification for the audio and transcript. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GcsSource + dialogflowSource: + description: The source when the conversation comes from Dialogflow. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DialogflowSource + metadataUri: + description: >- + Cloud Storage URI that points to a file that contains the + conversation metadata. + type: string + GoogleCloudContactcenterinsightsV1alpha1GcsSource: + id: GoogleCloudContactcenterinsightsV1alpha1GcsSource + description: A Cloud Storage source of conversation data. + type: object + properties: + audioUri: + description: >- + Cloud Storage URI that points to a file that contains the + conversation audio. + type: string + transcriptUri: + description: >- + Immutable. Cloud Storage URI that points to a file that contains the + conversation transcript. + type: string + GoogleCloudContactcenterinsightsV1alpha1DialogflowSource: + id: GoogleCloudContactcenterinsightsV1alpha1DialogflowSource + description: A Dialogflow source of conversation data. + type: object + properties: + dialogflowConversation: + description: >- + Output only. The name of the Dialogflow conversation that this + conversation resource is derived from. Format: + projects/{project}/locations/{location}/conversations/{conversation} + readOnly: true + type: string + audioUri: + description: >- + Cloud Storage URI that points to a file that contains the + conversation audio. + type: string + GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata: + id: GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata + description: Conversation metadata related to quality management. + type: object + properties: + customerSatisfactionRating: + description: >- + An arbitrary integer value indicating the customer's satisfaction + rating. + type: integer + format: int32 + waitDuration: + description: The amount of time the customer waited to connect with an agent. + type: string + format: google-duration + menuPath: + description: >- + An arbitrary string value specifying the menu path the customer + took. + type: string + agentInfo: + description: Information about agents involved in the call. + type: array + items: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews~1{authorizedViewsId}~1conversations~1{conversationsId}~1analyses~1{analysesId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo + feedbackLabels: + description: Input only. The feedback labels associated with the conversation. + type: array + items: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews~1{authorizedViewsId}~1conversations~1{conversationsId}~1analyses~1{analysesId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/analyses/methods/get' - - $ref: '#/components/x-stackQL-resources/analyses/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/analyses/methods/create' - update: [] - replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/analyses/methods/delete' - conversations: - id: google.contactcenterinsights.conversations - name: conversations - title: Conversations - methods: - calculate_stats: - operation: + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel + GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo: + id: >- + GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo + description: Information about an agent involved in the conversation. + type: object + properties: + agentId: + description: A user-specified string representing the agent. + type: string + displayName: + description: The agent's name. + type: string + team: + description: >- + A user-specified string representing the agent's team. Deprecated in + favor of the `teams` field. + deprecated: true + type: string + teams: + description: User-specified strings representing the agent's teams. + type: array + items: + type: string + dispositionCode: + description: >- + A user-provided string indicating the outcome of the agent's segment + of the call. + type: string + agentType: + description: The agent type, e.g. HUMAN_AGENT. + type: string + enumDescriptions: + - Participant's role is not set. + - Participant is a human agent. + - Participant is an automated agent. + - Participant is an end user who conversed with the contact center. + - Participant is either a human or automated agent. + enum: + - ROLE_UNSPECIFIED + - HUMAN_AGENT + - AUTOMATED_AGENT + - END_USER + - ANY_AGENT + location: + description: The agent's location. + type: string + GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript: + id: GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript + description: A message representing the transcript of a conversation. + type: object + properties: + transcriptSegments: + description: >- + A list of sequential transcript segments that comprise the + conversation. + type: array + items: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations:calculateStats/get - response: - mediaType: application/json - openAPIDocKey: '200' - list: - operation: + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment + GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment: + id: >- + GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment + description: A segment of a full transcript. + type: object + properties: + messageTime: + description: The time that the message occurred, if provided. + type: string + format: google-datetime + text: + description: The text of this segment. + type: string + confidence: + description: >- + A confidence estimate between 0.0 and 1.0 of the fidelity of this + segment. A default value of 0.0 indicates that the value is unset. + type: number + format: float + words: + description: >- + A list of the word-specific information for each word in the + segment. + type: array + items: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews~1{authorizedViewsId}~1conversations/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.conversations - create: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews~1{authorizedViewsId}~1conversations/post - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews~1{authorizedViewsId}~1conversations~1{conversationsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo + languageCode: + description: >- + The language code of this segment as a + [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. + Example: "en-US". + type: string + channelTag: + description: >- + For conversations derived from multi-channel audio, this is the + channel number corresponding to the audio from that channel. For + audioChannelCount = N, its output values can range from '1' to 'N'. + A channel tag of 0 indicates that the audio is mono. + type: integer + format: int32 + segmentParticipant: + description: The participant of this segment. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant + dialogflowSegmentMetadata: + description: CCAI metadata relating to the current transcript segment. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata + sentiment: + description: The sentiment for this transcript segment. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData + GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo: + id: >- + GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo + description: Word-level info for words in a transcript. + type: object + properties: + startOffset: + description: >- + Time offset of the start of this word relative to the beginning of + the total conversation. + type: string + format: google-duration + endOffset: + description: >- + Time offset of the end of this word relative to the beginning of the + total conversation. + type: string + format: google-duration + word: + description: The word itself. Includes punctuation marks that surround the word. + type: string + confidence: + description: >- + A confidence estimate between 0.0 and 1.0 of the fidelity of this + word. A default value of 0.0 indicates that the value is unset. + type: number + format: float + GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant: + id: GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant + description: The call participant speaking for a given utterance. + type: object + properties: + dialogflowParticipantName: + description: >- + The name of the participant provided by Dialogflow. Format: + projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} + type: string + userId: + description: A user-specified ID representing the participant. + type: string + dialogflowParticipant: + description: >- + Deprecated. Use `dialogflow_participant_name` instead. The name of + the Dialogflow participant. Format: + projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} + deprecated: true + type: string + obfuscatedExternalUserId: + description: Obfuscated user ID from Dialogflow. + type: string + role: + description: The role of the participant. + type: string + enumDescriptions: + - Participant's role is not set. + - Participant is a human agent. + - Participant is an automated agent. + - Participant is an end user who conversed with the contact center. + - Participant is either a human or automated agent. + enum: + - ROLE_UNSPECIFIED + - HUMAN_AGENT + - AUTOMATED_AGENT + - END_USER + - ANY_AGENT + GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata: + id: >- + GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata + description: Metadata from Dialogflow relating to the current transcript segment. + type: object + properties: + smartReplyAllowlistCovered: + description: >- + Whether the transcript segment was covered under the configured + smart reply allowlist in Agent Assist. + type: boolean + GoogleCloudContactcenterinsightsV1alpha1SentimentData: + id: GoogleCloudContactcenterinsightsV1alpha1SentimentData + description: The data for a sentiment annotation. + type: object + properties: + magnitude: + description: >- + A non-negative number from 0 to infinity which represents the + absolute magnitude of sentiment regardless of score. + type: number + format: float + score: + description: The sentiment score between -1.0 (negative) and 1.0 (positive). + type: number + format: float + GoogleCloudContactcenterinsightsV1alpha1Analysis: + id: GoogleCloudContactcenterinsightsV1alpha1Analysis + description: The analysis resource. + type: object + properties: + name: + description: >- + Immutable. The resource name of the analysis. Format: + projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} + type: string + requestTime: + description: Output only. The time at which the analysis was requested. + readOnly: true + type: string + format: google-datetime + createTime: + description: >- + Output only. The time at which the analysis was created, which + occurs when the long-running operation completes. + readOnly: true + type: string + format: google-datetime + analysisResult: + description: >- + Output only. The result of the analysis, which is populated when the + analysis finishes. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnalysisResult + annotatorSelector: + description: >- + To select the annotators to run and the phrase matchers to use (if + any). If not specified, all annotators will be run. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector + GoogleCloudContactcenterinsightsV1alpha1AnalysisResult: + id: GoogleCloudContactcenterinsightsV1alpha1AnalysisResult + description: The result of an analysis. + type: object + properties: + callAnalysisMetadata: + description: Call-specific metadata created by the analysis. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata + endTime: + description: The time at which the analysis ended. + type: string + format: google-datetime + GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata: + id: >- + GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata + description: Call-specific metadata created during analysis. + type: object + properties: + annotations: + description: A list of call annotations that apply to this call. + type: array + items: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews~1{authorizedViewsId}~1conversations~1{conversationsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - patch: - operation: + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1CallAnnotation + entities: + description: All the entities in the call. + type: object + additionalProperties: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews~1{authorizedViewsId}~1conversations~1{conversationsId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - ingest: - operation: + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Entity + sentiments: + description: Overall conversation-level sentiment for each channel of the call. + type: array + items: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations:ingest/post - response: - mediaType: application/json - openAPIDocKey: '200' - bulk_analyze: - operation: + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment + silence: + description: Overall conversation-level silence during the call. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence + intents: + description: All the matched intents in the call. + type: object + additionalProperties: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations:bulkAnalyze/post - response: - mediaType: application/json - openAPIDocKey: '200' - upload: - operation: + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Intent + phraseMatchers: + description: All the matched phrase matchers in the call. + type: object + additionalProperties: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews~1{authorizedViewsId}~1conversations:upload/post - response: - mediaType: application/json - openAPIDocKey: '200' - bulk_delete: - operation: + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData + issueModelResult: + description: Overall conversation-level issue modeling result. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelResult + qaScorecardResults: + description: Results of scoring QaScorecards. + type: array + items: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations:bulkDelete/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/conversations/methods/get' - - $ref: '#/components/x-stackQL-resources/conversations/methods/list' - insert: + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaScorecardResult + GoogleCloudContactcenterinsightsV1alpha1CallAnnotation: + id: GoogleCloudContactcenterinsightsV1alpha1CallAnnotation + description: A piece of metadata that applies to a window of a call. + type: object + properties: + interruptionData: + description: Data specifying an interruption. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1InterruptionData + sentimentData: + description: Data specifying sentiment. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData + silenceData: + description: Data specifying silence. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SilenceData + holdData: + description: Data specifying a hold. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1HoldData + entityMentionData: + description: Data specifying an entity mention. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1EntityMentionData + intentMatchData: + description: Data specifying an intent match. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IntentMatchData + phraseMatchData: + description: Data specifying a phrase match. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData + issueMatchData: + description: Data specifying an issue match. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueMatchData + channelTag: + description: >- + The channel of the audio where the annotation occurs. For + single-channel audio, this field is not populated. + type: integer + format: int32 + annotationStartBoundary: + description: >- + The boundary in the conversation where the annotation starts, + inclusive. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary + annotationEndBoundary: + description: >- + The boundary in the conversation where the annotation ends, + inclusive. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary + GoogleCloudContactcenterinsightsV1alpha1InterruptionData: + id: GoogleCloudContactcenterinsightsV1alpha1InterruptionData + description: The data for an interruption annotation. + type: object + properties: {} + GoogleCloudContactcenterinsightsV1alpha1SilenceData: + id: GoogleCloudContactcenterinsightsV1alpha1SilenceData + description: The data for a silence annotation. + type: object + properties: {} + GoogleCloudContactcenterinsightsV1alpha1HoldData: + id: GoogleCloudContactcenterinsightsV1alpha1HoldData + description: The data for a hold annotation. + type: object + properties: {} + GoogleCloudContactcenterinsightsV1alpha1EntityMentionData: + id: GoogleCloudContactcenterinsightsV1alpha1EntityMentionData + description: >- + The data for an entity mention annotation. This represents a mention of + an `Entity` in the conversation. + type: object + properties: + entityUniqueId: + description: >- + The key of this entity in conversation entities. Can be used to + retrieve the exact `Entity` this mention is attached to. + type: string + type: + description: The type of the entity mention. + type: string + enumDescriptions: + - Unspecified. + - Proper noun. + - Common noun (or noun compound). + enum: + - MENTION_TYPE_UNSPECIFIED + - PROPER + - COMMON + sentiment: + description: Sentiment expressed for this mention of the entity. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData + GoogleCloudContactcenterinsightsV1alpha1IntentMatchData: + id: GoogleCloudContactcenterinsightsV1alpha1IntentMatchData + description: >- + The data for an intent match. Represents an intent match for a text + segment in the conversation. A text segment can be part of a sentence, a + complete sentence, or an utterance with multiple sentences. + type: object + properties: + intentUniqueId: + description: >- + The id of the matched intent. Can be used to retrieve the + corresponding intent information. + type: string + GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData: + id: GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData + description: >- + The data for a matched phrase matcher. Represents information + identifying a phrase matcher for a given match. + type: object + properties: + phraseMatcher: + description: The unique identifier (the resource name) of the phrase matcher. + type: string + displayName: + description: The human-readable name of the phrase matcher. + type: string + GoogleCloudContactcenterinsightsV1alpha1IssueMatchData: + id: GoogleCloudContactcenterinsightsV1alpha1IssueMatchData + description: The data for an issue match annotation. + type: object + properties: + issueAssignment: + description: Information about the issue's assignment. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueAssignment + GoogleCloudContactcenterinsightsV1alpha1IssueAssignment: + id: GoogleCloudContactcenterinsightsV1alpha1IssueAssignment + description: Information about the issue. + type: object + properties: + issue: + description: Resource name of the assigned issue. + type: string + score: + description: >- + Score indicating the likelihood of the issue assignment. currently + bounded on [0,1]. + type: number + format: double + displayName: + description: >- + Immutable. Display name of the assigned issue. This field is set at + time of analysis and immutable since then. + type: string + GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary: + id: GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary + description: >- + A point in a conversation that marks the start or the end of an + annotation. + type: object + properties: + wordIndex: + description: >- + The word index of this boundary with respect to the first word in + the transcript piece. This index starts at zero. + type: integer + format: int32 + transcriptIndex: + description: >- + The index in the sequence of transcribed pieces of the conversation + where the boundary is located. This index starts at zero. + type: integer + format: int32 + GoogleCloudContactcenterinsightsV1alpha1Entity: + id: GoogleCloudContactcenterinsightsV1alpha1Entity + description: >- + The data for an entity annotation. Represents a phrase in the + conversation that is a known entity, such as a person, an organization, + or location. + type: object + properties: + displayName: + description: The representative name for the entity. + type: string + type: + description: The entity type. + type: string + enumDescriptions: + - Unspecified. + - Person. + - Location. + - Organization. + - Event. + - Artwork. + - Consumer product. + - Other types of entities. + - >- + Phone number. The metadata lists the phone number (formatted + according to local convention), plus whichever additional elements + appear in the text: * `number` - The actual number, broken down + into sections according to local convention. * `national_prefix` - + Country code, if detected. * `area_code` - Region or area code, if + detected. * `extension` - Phone extension (to be dialed after + connection), if detected. + - >- + Address. The metadata identifies the street number and locality + plus whichever additional elements appear in the text: * + `street_number` - Street number. * `locality` - City or town. * + `street_name` - Street/route name, if detected. * `postal_code` - + Postal code, if detected. * `country` - Country, if detected. * + `broad_region` - Administrative area, such as the state, if + detected. * `narrow_region` - Smaller administrative area, such as + county, if detected. * `sublocality` - Used in Asian addresses to + demark a district within a city, if detected. + - >- + Date. The metadata identifies the components of the date: * `year` + - Four digit year, if detected. * `month` - Two digit month + number, if detected. * `day` - Two digit day number, if detected. + - Number. The metadata is the number itself. + - Price. The metadata identifies the `value` and `currency`. + enum: + - TYPE_UNSPECIFIED + - PERSON + - LOCATION + - ORGANIZATION + - EVENT + - WORK_OF_ART + - CONSUMER_GOOD + - OTHER + - PHONE_NUMBER + - ADDRESS + - DATE + - NUMBER + - PRICE + metadata: + description: >- + Metadata associated with the entity. For most entity types, the + metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph + MID (`mid`), if they are available. For the metadata associated with + other entity types, see the Type table below. + type: object + additionalProperties: + type: string + salience: + description: >- + The salience score associated with the entity in the [0, 1.0] range. + The salience score for an entity provides information about the + importance or centrality of that entity to the entire document text. + Scores closer to 0 are less salient, while scores closer to 1.0 are + highly salient. + type: number + format: float + sentiment: + description: >- + The aggregate sentiment expressed for this entity in the + conversation. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData + GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment: + id: GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment + description: One channel of conversation-level sentiment data. + type: object + properties: + channelTag: + description: The channel of the audio that the data applies to. + type: integer + format: int32 + sentimentData: + description: Data specifying sentiment. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData + GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence: + id: GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence + description: Conversation-level silence data. + type: object + properties: + silenceDuration: + description: Amount of time calculated to be in silence. + type: string + format: google-duration + silencePercentage: + description: Percentage of the total conversation spent in silence. + type: number + format: float + GoogleCloudContactcenterinsightsV1alpha1Intent: + id: GoogleCloudContactcenterinsightsV1alpha1Intent + description: >- + The data for an intent. Represents a detected intent in the + conversation, for example MAKES_PROMISE. + type: object + properties: + id: + description: The unique identifier of the intent. + type: string + displayName: + description: The human-readable name of the intent. + type: string + GoogleCloudContactcenterinsightsV1alpha1IssueModelResult: + id: GoogleCloudContactcenterinsightsV1alpha1IssueModelResult + description: Issue Modeling result on a conversation. + type: object + properties: + issueModel: + description: >- + Issue model that generates the result. Format: + projects/{project}/locations/{location}/issueModels/{issue_model} + type: string + issues: + description: All the matched issues. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueAssignment + GoogleCloudContactcenterinsightsV1alpha1QaScorecardResult: + id: GoogleCloudContactcenterinsightsV1alpha1QaScorecardResult + description: >- + The results of scoring a single conversation against a QaScorecard. + Contains a collection of QaAnswers and aggregate score. + type: object + properties: + name: + description: >- + Identifier. The name of the scorecard result. Format: + projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result} + type: string + qaScorecardRevision: + description: The QaScorecardRevision scored by this result. + type: string + conversation: + description: The conversation scored by this result. + type: string + createTime: + description: Output only. The timestamp that the revision was created. + readOnly: true + type: string + format: google-datetime + agentId: + description: ID of the agent that handled the conversation. + type: string + qaAnswers: + description: Set of QaAnswers represented in the result. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaAnswer + score: + description: >- + The overall numerical score of the result, incorporating any manual + edits if they exist. + type: number + format: double + potentialScore: + description: >- + The maximum potential overall score of the scorecard. Any questions + answered using `na_value` are excluded from this calculation. + type: number + format: double + normalizedScore: + description: >- + The normalized score, which is the score divided by the potential + score. Any manual edits are included if they exist. + type: number + format: double + qaTagResults: + description: Collection of tags and their scores. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultQaTagResult + scoreSources: + description: List of all individual score sets. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultScoreSource + GoogleCloudContactcenterinsightsV1alpha1QaAnswer: + id: GoogleCloudContactcenterinsightsV1alpha1QaAnswer + description: An answer to a QaQuestion. + type: object + properties: + qaQuestion: + description: The QaQuestion answered by this answer. + type: string + conversation: + description: The conversation the answer applies to. + type: string + questionBody: + description: Question text. E.g., "Did the agent greet the customer?" + type: string + answerValue: + description: The main answer value, incorporating any manual edits if they exist. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue + tags: + description: >- + User-defined list of arbitrary tags. Matches the value from + QaScorecard.ScorecardQuestion.tags. Used for grouping/organization + and for weighting the score of each answer. + type: array + items: + type: string + answerSources: + description: List of all individual answers given to the question. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerSource + GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerSource: + id: GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerSource + description: >- + A question may have multiple answers from varying sources, one of which + becomes the "main" answer above. AnswerSource represents each individual + answer. + type: object + properties: + sourceType: + description: What created the answer. + type: string + enumDescriptions: + - Source type is unspecified. + - Answer was system-generated; created during an Insights analysis. + - Answer was created by a human via manual edit. + enum: + - SOURCE_TYPE_UNSPECIFIED + - SYSTEM_GENERATED + - MANUAL_EDIT + answerValue: + description: The answer value from this source. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue + GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultQaTagResult: + id: GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultQaTagResult + description: Tags and their corresponding results. + type: object + properties: + tag: + description: The tag the score applies to. + type: string + score: + description: The score the tag applies to. + type: number + format: double + potentialScore: + description: The potential score the tag applies to. + type: number + format: double + normalizedScore: + description: The normalized score the tag applies to. + type: number + format: double + GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultScoreSource: + id: GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultScoreSource + description: >- + A scorecard result may have multiple sets of scores from varying + sources, one of which becomes the "main" answer above. A ScoreSource + represents each individual set of scores. + type: object + properties: + sourceType: + description: What created the score. + type: string + enumDescriptions: + - Source type is unspecified. + - Score is derived only from system-generated answers. + - >- + Score is derived from both system-generated answers, and includes + any manual edits if they exist. + enum: + - SOURCE_TYPE_UNSPECIFIED + - SYSTEM_GENERATED_ONLY + - INCLUDES_MANUAL_EDITS + score: + description: The overall numerical score of the result. + type: number + format: double + potentialScore: + description: >- + The maximum potential overall score of the scorecard. Any questions + answered using `na_value` are excluded from this calculation. + type: number + format: double + normalizedScore: + description: >- + The normalized score, which is the score divided by the potential + score. + type: number + format: double + qaTagResults: + description: Collection of tags and their scores. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultQaTagResult + GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData: + id: >- + GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData + description: Conversation summarization suggestion data. + type: object + properties: + text: + description: The summarization content that is concatenated into one string. + type: string + textSections: + description: >- + The summarization content that is divided into sections. The key is + the section's name and the value is the section's content. There is + no specific format for the key or value. + type: object + additionalProperties: + type: string + confidence: + description: The confidence score of the summarization. + type: number + format: float + metadata: + description: >- + A map that contains metadata about the summarization and the + document from which it originates. + type: object + additionalProperties: + type: string + answerRecord: + description: >- + The name of the answer record. Format: + projects/{project}/locations/{location}/answerRecords/{answer_record} + type: string + conversationModel: + description: >- + The name of the model that generates this summary. Format: + projects/{project}/locations/{location}/conversationModels/{conversation_model} + type: string + generatorId: + description: Agent Assist generator ID. + type: string + GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation: + id: GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation + description: >- + An annotation that was generated during the customer and agent + interaction. + type: object + properties: + articleSuggestion: + description: Agent Assist Article Suggestion data. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData + faqAnswer: + description: Agent Assist FAQ answer data. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData + smartReply: + description: Agent Assist Smart Reply data. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SmartReplyData + smartComposeSuggestion: + description: Agent Assist Smart Compose suggestion data. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData + dialogflowInteraction: + description: Dialogflow interaction data. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData + conversationSummarizationSuggestion: + description: Conversation summarization suggestion data. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData + annotationId: + description: >- + The unique identifier of the annotation. Format: + projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation} + type: string + createTime: + description: The time at which this annotation was created. + type: string + format: google-datetime + startBoundary: + description: >- + The boundary in the conversation where the annotation starts, + inclusive. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary + endBoundary: + description: >- + The boundary in the conversation where the annotation ends, + inclusive. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary + answerFeedback: + description: The feedback that the customer has about the answer in `data`. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback + userInput: + description: Explicit input used for generating the answer + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotationUserInput + GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData: + id: GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData + description: Agent Assist Article Suggestion data. + type: object + properties: + title: + description: Article title. + type: string + uri: + description: Article URI. + type: string + confidenceScore: + description: >- + The system's confidence score that this article is a good match for + this conversation, ranging from 0.0 (completely uncertain) to 1.0 + (completely certain). + type: number + format: float + metadata: + description: >- + Map that contains metadata about the Article Suggestion and the + document that it originates from. + type: object + additionalProperties: + type: string + queryRecord: + description: >- + The name of the answer record. Format: + projects/{project}/locations/{location}/answerRecords/{answer_record} + type: string + source: + description: >- + The knowledge document that this answer was extracted from. Format: + projects/{project}/knowledgeBases/{knowledge_base}/documents/{document} + type: string + GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData: + id: GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData + description: Agent Assist frequently-asked-question answer data. + type: object + properties: + answer: + description: The piece of text from the `source` knowledge base document. + type: string + confidenceScore: + description: >- + The system's confidence score that this answer is a good match for + this conversation, ranging from 0.0 (completely uncertain) to 1.0 + (completely certain). + type: number + format: float + question: + description: The corresponding FAQ question. + type: string + metadata: + description: >- + Map that contains metadata about the FAQ answer and the document + that it originates from. + type: object + additionalProperties: + type: string + queryRecord: + description: >- + The name of the answer record. Format: + projects/{project}/locations/{location}/answerRecords/{answer_record} + type: string + source: + description: >- + The knowledge document that this answer was extracted from. Format: + projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}. + type: string + GoogleCloudContactcenterinsightsV1alpha1SmartReplyData: + id: GoogleCloudContactcenterinsightsV1alpha1SmartReplyData + description: Agent Assist Smart Reply data. + type: object + properties: + reply: + description: The content of the reply. + type: string + confidenceScore: + description: >- + The system's confidence score that this reply is a good match for + this conversation, ranging from 0.0 (completely uncertain) to 1.0 + (completely certain). + type: number + format: double + metadata: + description: >- + Map that contains metadata about the Smart Reply and the document + from which it originates. + type: object + additionalProperties: + type: string + queryRecord: + description: >- + The name of the answer record. Format: + projects/{project}/locations/{location}/answerRecords/{answer_record} + type: string + GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData: + id: GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData + description: Agent Assist Smart Compose suggestion data. + type: object + properties: + suggestion: + description: The content of the suggestion. + type: string + confidenceScore: + description: >- + The system's confidence score that this suggestion is a good match + for this conversation, ranging from 0.0 (completely uncertain) to + 1.0 (completely certain). + type: number + format: double + metadata: + description: >- + Map that contains metadata about the Smart Compose suggestion and + the document from which it originates. + type: object + additionalProperties: + type: string + queryRecord: + description: >- + The name of the answer record. Format: + projects/{project}/locations/{location}/answerRecords/{answer_record} + type: string + GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData: + id: GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData + description: Dialogflow interaction data. + type: object + properties: + dialogflowIntentId: + description: >- + The Dialogflow intent resource path. Format: + projects/{project}/agent/{agent}/intents/{intent} + type: string + confidence: + description: >- + The confidence of the match ranging from 0.0 (completely uncertain) + to 1.0 (completely certain). + type: number + format: float + GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback: + id: GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback + description: >- + The feedback that the customer has about a certain answer in the + conversation. + type: object + properties: + correctnessLevel: + description: The correctness level of an answer. + type: string + enumDescriptions: + - Correctness level unspecified. + - Answer is totally wrong. + - Answer is partially correct. + - Answer is fully correct. + enum: + - CORRECTNESS_LEVEL_UNSPECIFIED + - NOT_CORRECT + - PARTIALLY_CORRECT + - FULLY_CORRECT + clicked: + description: Indicates whether an answer or item was clicked by the human agent. + type: boolean + displayed: + description: >- + Indicates whether an answer or item was displayed to the human agent + in the agent desktop UI. + type: boolean + GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotationUserInput: + id: GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotationUserInput + description: Explicit input used for generating the answer + type: object + properties: + query: + description: >- + Query text. Article Search uses this to store the input query used + to generate the search results. + type: string + generatorName: + description: >- + The resource name of associated generator. Format: + `projects//locations//generators/` + type: string + querySource: + description: Query source for the answer. + type: string + enumDescriptions: + - Unknown query source. + - The query is from agents. + - >- + The query is a query from previous suggestions, e.g. from a + preceding SuggestKnowledgeAssist response. + enum: + - QUERY_SOURCE_UNSPECIFIED + - AGENT_QUERY + - SUGGESTED_QUERY + GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent: + id: GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent + description: >- + The data for a Dialogflow intent. Represents a detected intent in the + conversation, e.g. MAKES_PROMISE. + type: object + properties: + displayName: + description: The human-readable name of the intent. + type: string + parameters: + 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: + type: string + enum: + - json + - media + - proto + 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 + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + x-stackQL-resources: + settings: + id: google.contactcenterinsights.settings + name: settings + title: Settings + methods: + get_settings: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1settings/get + response: + mediaType: application/json + openAPIDocKey: '200' + update_settings: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1settings/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/settings/methods/get_settings' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/settings/methods/update_settings' + replace: [] + delete: [] + encryption_spec: + id: google.contactcenterinsights.encryption_spec + name: encryption_spec + title: Encryption_spec + methods: + get_encryption_spec: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1encryptionSpec/get + response: + mediaType: application/json + openAPIDocKey: '200' + initialize: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1encryptionSpec:initialize/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/encryption_spec/methods/get_encryption_spec + insert: [] + update: [] + replace: [] + delete: [] + locations: + id: google.contactcenterinsights.locations + name: locations + title: Locations + methods: + query_metrics: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:queryMetrics/post + response: + mediaType: application/json + openAPIDocKey: '200' + query_performance_overview: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:queryPerformanceOverview/post + response: + mediaType: application/json + openAPIDocKey: '200' + bulk_upload_feedback_labels: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:bulkUploadFeedbackLabels/post + response: + mediaType: application/json + openAPIDocKey: '200' + bulk_download_feedback_labels: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:bulkDownloadFeedbackLabels/post + response: + mediaType: application/json + openAPIDocKey: '200' + bulk_delete_feedback_labels: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:bulkDeleteFeedbackLabels/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/locations/methods/bulk_delete_feedback_labels + feedback_labels: + id: google.contactcenterinsights.feedback_labels + name: feedback_labels + title: Feedback_labels + methods: + list_all_feedback_labels: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}:listAllFeedbackLabels/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.feedbackLabels + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews~1{authorizedViewsId}~1conversations~1{conversationsId}~1feedbackLabels/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews~1{authorizedViewsId}~1conversations~1{conversationsId}~1feedbackLabels/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.feedbackLabels + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews~1{authorizedViewsId}~1conversations~1{conversationsId}~1feedbackLabels~1{feedbackLabelsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews~1{authorizedViewsId}~1conversations~1{conversationsId}~1feedbackLabels~1{feedbackLabelsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews~1{authorizedViewsId}~1conversations~1{conversationsId}~1feedbackLabels~1{feedbackLabelsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/feedback_labels/methods/get' + - $ref: '#/components/x-stackQL-resources/feedback_labels/methods/list' + - $ref: >- + #/components/x-stackQL-resources/feedback_labels/methods/list_all_feedback_labels + insert: + - $ref: '#/components/x-stackQL-resources/feedback_labels/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/feedback_labels/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/feedback_labels/methods/delete' + operations: + id: google.contactcenterinsights.operations + name: operations + title: Operations + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews~1{authorizedViewsId}~1operations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.operations + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews~1{authorizedViewsId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + cancel: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews~1{authorizedViewsId}~1operations~1{operationsId}:cancel/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + conversations: + id: google.contactcenterinsights.conversations + name: conversations + title: Conversations + methods: + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews~1{authorizedViewsId}~1conversations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.conversations + upload: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations:upload/post + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations~1{conversationsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews~1{authorizedViewsId}~1conversations~1{conversationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews~1{authorizedViewsId}~1conversations~1{conversationsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sample: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1conversations:sample/post + response: + mediaType: application/json + openAPIDocKey: '200' + bulk_analyze: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews~1{authorizedViewsId}~1conversations:bulkAnalyze/post + response: + mediaType: application/json + openAPIDocKey: '200' + bulk_delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1conversations:bulkDelete/post + response: + mediaType: application/json + openAPIDocKey: '200' + ingest: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1conversations:ingest/post + response: + mediaType: application/json + openAPIDocKey: '200' + calculate_stats: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews~1{authorizedViewsId}~1conversations:calculateStats/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/conversations/methods/get' + - $ref: '#/components/x-stackQL-resources/conversations/methods/list' + insert: - $ref: '#/components/x-stackQL-resources/conversations/methods/create' update: - - $ref: '#/components/x-stackQL-resources/conversations/methods/patch' + - $ref: '#/components/x-stackQL-resources/conversations/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/conversations/methods/delete' + - $ref: '#/components/x-stackQL-resources/conversations/methods/bulk_delete' + analyses: + id: google.contactcenterinsights.analyses + name: analyses + title: Analyses + methods: + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews~1{authorizedViewsId}~1conversations~1{conversationsId}~1analyses/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews~1{authorizedViewsId}~1conversations~1{conversationsId}~1analyses/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.analyses + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews~1{authorizedViewsId}~1conversations~1{conversationsId}~1analyses~1{analysesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews~1{authorizedViewsId}~1conversations~1{conversationsId}~1analyses~1{analysesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/analyses/methods/get' + - $ref: '#/components/x-stackQL-resources/analyses/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/analyses/methods/create' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/analyses/methods/delete' + assessments: + id: google.contactcenterinsights.assessments + name: assessments + title: Assessments + methods: + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews~1{authorizedViewsId}~1conversations~1{conversationsId}~1assessments/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews~1{authorizedViewsId}~1conversations~1{conversationsId}~1assessments/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.assessments + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews~1{authorizedViewsId}~1conversations~1{conversationsId}~1assessments~1{assessmentsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews~1{authorizedViewsId}~1conversations~1{conversationsId}~1assessments~1{assessmentsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + publish: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews~1{authorizedViewsId}~1conversations~1{conversationsId}~1assessments~1{assessmentsId}:publish/post + response: + mediaType: application/json + openAPIDocKey: '200' + appeal: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews~1{authorizedViewsId}~1conversations~1{conversationsId}~1assessments~1{assessmentsId}:appeal/post + response: + mediaType: application/json + openAPIDocKey: '200' + finalize: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews~1{authorizedViewsId}~1conversations~1{conversationsId}~1assessments~1{assessmentsId}:finalize/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/assessments/methods/get' + - $ref: '#/components/x-stackQL-resources/assessments/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/assessments/methods/create' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/assessments/methods/delete' + notes: + id: google.contactcenterinsights.notes + name: notes + title: Notes + methods: + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews~1{authorizedViewsId}~1conversations~1{conversationsId}~1assessments~1{assessmentsId}~1notes/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews~1{authorizedViewsId}~1conversations~1{conversationsId}~1assessments~1{assessmentsId}~1notes/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.notes + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews~1{authorizedViewsId}~1conversations~1{conversationsId}~1assessments~1{assessmentsId}~1notes~1{notesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews~1{authorizedViewsId}~1conversations~1{conversationsId}~1assessments~1{assessmentsId}~1notes~1{notesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/notes/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/notes/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/notes/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/notes/methods/delete' + datasets: + id: google.contactcenterinsights.datasets + name: datasets + title: Datasets + methods: + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.datasets + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + bulk_upload_feedback_labels: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}:bulkUploadFeedbackLabels/post + response: + mediaType: application/json + openAPIDocKey: '200' + bulk_download_feedback_labels: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}:bulkDownloadFeedbackLabels/post + response: + mediaType: application/json + openAPIDocKey: '200' + bulk_delete_feedback_labels: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}:bulkDeleteFeedbackLabels/post + response: + mediaType: application/json + openAPIDocKey: '200' + export: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1insightsdata:export/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/datasets/methods/get' + - $ref: '#/components/x-stackQL-resources/datasets/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/datasets/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/datasets/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/datasets/methods/delete' + - $ref: >- + #/components/x-stackQL-resources/datasets/methods/bulk_delete_feedback_labels + insightsdata: + id: google.contactcenterinsights.insightsdata + name: insightsdata + title: Insightsdata + methods: + export: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1insightsdata:export/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + issue_models: + id: google.contactcenterinsights.issue_models + name: issue_models + title: Issue_models + methods: + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + deploy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}:deploy/post + response: + mediaType: application/json + openAPIDocKey: '200' + undeploy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}:undeploy/post + response: + mediaType: application/json + openAPIDocKey: '200' + export: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}:export/post + response: + mediaType: application/json + openAPIDocKey: '200' + import: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels:import/post + response: + mediaType: application/json + openAPIDocKey: '200' + calculate_issue_model_stats: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}:calculateIssueModelStats/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/issue_models/methods/get' + - $ref: '#/components/x-stackQL-resources/issue_models/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/issue_models/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/issue_models/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/issue_models/methods/delete' + issues: + id: google.contactcenterinsights.issues + name: issues + title: Issues + methods: + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}~1issues~1{issuesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}~1issues~1{issuesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}~1issues~1{issuesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}~1issues/get + response: + mediaType: application/json + openAPIDocKey: '200' + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}~1issues/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/issues/methods/get' + - $ref: '#/components/x-stackQL-resources/issues/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/issues/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/issues/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/issues/methods/delete' + phrase_matchers: + id: google.contactcenterinsights.phrase_matchers + name: phrase_matchers + title: Phrase_matchers + methods: + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1phraseMatchers/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1phraseMatchers/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.phraseMatchers + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1phraseMatchers~1{phraseMatchersId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1phraseMatchers~1{phraseMatchersId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1phraseMatchers~1{phraseMatchersId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/phrase_matchers/methods/get' + - $ref: '#/components/x-stackQL-resources/phrase_matchers/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/phrase_matchers/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/phrase_matchers/methods/patch' replace: [] delete: - - $ref: '#/components/x-stackQL-resources/conversations/methods/delete' - - $ref: '#/components/x-stackQL-resources/conversations/methods/bulk_delete' + - $ref: '#/components/x-stackQL-resources/phrase_matchers/methods/delete' analysis_rules: id: google.contactcenterinsights.analysis_rules name: analysis_rules title: Analysis_rules methods: - patch: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1analysisRules~1{analysisRulesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1analysisRules/post response: mediaType: application/json openAPIDocKey: '200' - delete: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1analysisRules~1{analysisRulesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1analysisRules/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.analysisRules get: operation: $ref: >- @@ -7496,21 +9569,20 @@ components: response: mediaType: application/json openAPIDocKey: '200' - create: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1analysisRules/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1analysisRules~1{analysisRulesId}/patch response: mediaType: application/json openAPIDocKey: '200' - list: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1analysisRules/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1analysisRules~1{analysisRulesId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.analysisRules sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/analysis_rules/methods/get' @@ -7522,216 +9594,203 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/analysis_rules/methods/delete' - views: - id: google.contactcenterinsights.views - name: views - title: Views + assessment_rules: + id: google.contactcenterinsights.assessment_rules + name: assessment_rules + title: Assessment_rules methods: - delete: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1views~1{viewsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1assessmentRules/post response: mediaType: application/json openAPIDocKey: '200' - patch: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1views~1{viewsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1assessmentRules/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.assessmentRules get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1views~1{viewsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1assessmentRules~1{assessmentRulesId}/get response: mediaType: application/json openAPIDocKey: '200' - list: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1views/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1assessmentRules~1{assessmentRulesId}/patch response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.views - create: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1views/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1assessmentRules~1{assessmentRulesId}/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/views/methods/get' - - $ref: '#/components/x-stackQL-resources/views/methods/list' + - $ref: '#/components/x-stackQL-resources/assessment_rules/methods/get' + - $ref: '#/components/x-stackQL-resources/assessment_rules/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/views/methods/create' + - $ref: '#/components/x-stackQL-resources/assessment_rules/methods/create' update: - - $ref: '#/components/x-stackQL-resources/views/methods/patch' + - $ref: '#/components/x-stackQL-resources/assessment_rules/methods/patch' replace: [] delete: - - $ref: '#/components/x-stackQL-resources/views/methods/delete' - revisions: - id: google.contactcenterinsights.revisions - name: revisions - title: Revisions + - $ref: '#/components/x-stackQL-resources/assessment_rules/methods/delete' + views: + id: google.contactcenterinsights.views + name: views + title: Views methods: - list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1qaScorecards~1{qaScorecardsId}~1revisions/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.qaScorecardRevisions create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1qaScorecards~1{qaScorecardsId}~1revisions/post - response: - mediaType: application/json - openAPIDocKey: '200' - deploy: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1qaScorecards~1{qaScorecardsId}~1revisions~1{revisionsId}:deploy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1views/post response: mediaType: application/json openAPIDocKey: '200' - tune_qa_scorecard_revision: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1qaScorecards~1{qaScorecardsId}~1revisions~1{revisionsId}:tuneQaScorecardRevision/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1views/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.views get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1qaScorecards~1{qaScorecardsId}~1revisions~1{revisionsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1views~1{viewsId}/get response: mediaType: application/json openAPIDocKey: '200' - delete: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1qaScorecards~1{qaScorecardsId}~1revisions~1{revisionsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1views~1{viewsId}/patch response: mediaType: application/json openAPIDocKey: '200' - undeploy: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1qaScorecards~1{qaScorecardsId}~1revisions~1{revisionsId}:undeploy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1views~1{viewsId}/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/revisions/methods/get' - - $ref: '#/components/x-stackQL-resources/revisions/methods/list' + - $ref: '#/components/x-stackQL-resources/views/methods/get' + - $ref: '#/components/x-stackQL-resources/views/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/revisions/methods/create' - update: [] + - $ref: '#/components/x-stackQL-resources/views/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/views/methods/patch' replace: [] delete: - - $ref: '#/components/x-stackQL-resources/revisions/methods/delete' - qa_questions: - id: google.contactcenterinsights.qa_questions - name: qa_questions - title: Qa_questions + - $ref: '#/components/x-stackQL-resources/views/methods/delete' + qa_question_tags: + id: google.contactcenterinsights.qa_question_tags + name: qa_question_tags + title: Qa_question_tags methods: - patch: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1qaScorecards~1{qaScorecardsId}~1revisions~1{revisionsId}~1qaQuestions~1{qaQuestionsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1qaQuestionTags/post response: mediaType: application/json openAPIDocKey: '200' - delete: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1qaScorecards~1{qaScorecardsId}~1revisions~1{revisionsId}~1qaQuestions~1{qaQuestionsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1qaQuestionTags/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.qaQuestionTags get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1qaScorecards~1{qaScorecardsId}~1revisions~1{revisionsId}~1qaQuestions~1{qaQuestionsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1qaQuestionTags~1{qaQuestionTagsId}/get response: mediaType: application/json openAPIDocKey: '200' - create: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1qaScorecards~1{qaScorecardsId}~1revisions~1{revisionsId}~1qaQuestions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1qaQuestionTags~1{qaQuestionTagsId}/patch response: mediaType: application/json openAPIDocKey: '200' - list: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1qaScorecards~1{qaScorecardsId}~1revisions~1{revisionsId}~1qaQuestions/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1qaQuestionTags~1{qaQuestionTagsId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.qaQuestions sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/qa_questions/methods/get' - - $ref: '#/components/x-stackQL-resources/qa_questions/methods/list' + - $ref: '#/components/x-stackQL-resources/qa_question_tags/methods/get' + - $ref: '#/components/x-stackQL-resources/qa_question_tags/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/qa_questions/methods/create' + - $ref: '#/components/x-stackQL-resources/qa_question_tags/methods/create' update: - - $ref: '#/components/x-stackQL-resources/qa_questions/methods/patch' + - $ref: '#/components/x-stackQL-resources/qa_question_tags/methods/patch' replace: [] delete: - - $ref: '#/components/x-stackQL-resources/qa_questions/methods/delete' + - $ref: '#/components/x-stackQL-resources/qa_question_tags/methods/delete' qa_scorecards: id: google.contactcenterinsights.qa_scorecards name: qa_scorecards title: Qa_scorecards methods: - patch: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1qaScorecards~1{qaScorecardsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1qaScorecards/post response: mediaType: application/json openAPIDocKey: '200' - get: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1qaScorecards~1{qaScorecardsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1qaScorecards/get response: mediaType: application/json openAPIDocKey: '200' - delete: + objectKey: $.qaScorecards + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1qaScorecards~1{qaScorecardsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1qaScorecards~1{qaScorecardsId}/get response: mediaType: application/json openAPIDocKey: '200' - create: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1qaScorecards/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1qaScorecards~1{qaScorecardsId}/patch response: mediaType: application/json openAPIDocKey: '200' - list: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1qaScorecards/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1qaScorecards~1{qaScorecardsId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.qaScorecards sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/qa_scorecards/methods/get' @@ -7743,353 +9802,3665 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/qa_scorecards/methods/delete' - insightsdata: - id: google.contactcenterinsights.insightsdata - name: insightsdata - title: Insightsdata + revisions: + id: google.contactcenterinsights.revisions + name: revisions + title: Revisions methods: - export: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1insightsdata:export/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1qaScorecards~1{qaScorecardsId}~1revisions/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: [] - operations: - id: google.contactcenterinsights.operations - name: operations - title: Operations - methods: list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1qaScorecards~1{qaScorecardsId}~1revisions/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.operations + objectKey: $.qaScorecardRevisions get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1qaScorecards~1{qaScorecardsId}~1revisions~1{revisionsId}/get response: mediaType: application/json openAPIDocKey: '200' - cancel: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1qaScorecards~1{qaScorecardsId}~1revisions~1{revisionsId}/delete response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - insert: [] - update: [] - replace: [] - delete: [] - authorized_views_iam_policies: - id: google.contactcenterinsights.authorized_views_iam_policies - name: authorized_views_iam_policies - title: Authorized_views_iam_policies - methods: - get_iam_policy: + tune_qa_scorecard_revision: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews~1{authorizedViewsId}:getIamPolicy/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1qaScorecards~1{qaScorecardsId}~1revisions~1{revisionsId}:tuneQaScorecardRevision/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.bindings - set_iam_policy: + deploy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews~1{authorizedViewsId}:setIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1qaScorecards~1{qaScorecardsId}~1revisions~1{revisionsId}:deploy/post response: mediaType: application/json openAPIDocKey: '200' - test_iam_permissions: + undeploy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews~1{authorizedViewsId}:testIamPermissions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1qaScorecards~1{qaScorecardsId}~1revisions~1{revisionsId}:undeploy/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/authorized_views_iam_policies/methods/get_iam_policy - insert: [] + - $ref: '#/components/x-stackQL-resources/revisions/methods/get' + - $ref: '#/components/x-stackQL-resources/revisions/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/revisions/methods/create' update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/authorized_views_iam_policies/methods/set_iam_policy - delete: [] - authorized_view: - id: google.contactcenterinsights.authorized_view - name: authorized_view - title: Authorized_view + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/revisions/methods/delete' + qa_questions: + id: google.contactcenterinsights.qa_questions + name: qa_questions + title: Qa_questions methods: - calculate_stats: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSet~1{authorizedViewSetId}~1authorizedView~1{authorizedViewId}:calculateStats/get - response: - mediaType: application/json - openAPIDocKey: '200' - query_metrics: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSet~1{authorizedViewSetId}~1authorizedView~1{authorizedViewId}:queryMetrics/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1qaScorecards~1{qaScorecardsId}~1revisions~1{revisionsId}~1qaQuestions/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: [] - issues: - id: google.contactcenterinsights.issues - name: issues - title: Issues - methods: - patch: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}~1issues~1{issuesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1qaScorecards~1{qaScorecardsId}~1revisions~1{revisionsId}~1qaQuestions/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.qaQuestions get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}~1issues~1{issuesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1qaScorecards~1{qaScorecardsId}~1revisions~1{revisionsId}~1qaQuestions~1{qaQuestionsId}/get response: mediaType: application/json openAPIDocKey: '200' - delete: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}~1issues~1{issuesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1qaScorecards~1{qaScorecardsId}~1revisions~1{revisionsId}~1qaQuestions~1{qaQuestionsId}/patch response: mediaType: application/json openAPIDocKey: '200' - list: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}~1issues/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1qaScorecards~1{qaScorecardsId}~1revisions~1{revisionsId}~1qaQuestions~1{qaQuestionsId}/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/issues/methods/get' - - $ref: '#/components/x-stackQL-resources/issues/methods/list' - insert: [] + - $ref: '#/components/x-stackQL-resources/qa_questions/methods/get' + - $ref: '#/components/x-stackQL-resources/qa_questions/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/qa_questions/methods/create' update: - - $ref: '#/components/x-stackQL-resources/issues/methods/patch' + - $ref: '#/components/x-stackQL-resources/qa_questions/methods/patch' replace: [] delete: - - $ref: '#/components/x-stackQL-resources/issues/methods/delete' - issue_models: - id: google.contactcenterinsights.issue_models - name: issue_models - title: Issue_models + - $ref: '#/components/x-stackQL-resources/qa_questions/methods/delete' + authorized_view_sets: + id: google.contactcenterinsights.authorized_view_sets + name: authorized_view_sets + title: Authorized_view_sets methods: - delete: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets/post response: mediaType: application/json openAPIDocKey: '200' - patch: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.authorizedViewSets get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}/get response: mediaType: application/json openAPIDocKey: '200' - import: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels:import/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}/patch response: mediaType: application/json openAPIDocKey: '200' - deploy: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}:deploy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}/delete response: mediaType: application/json openAPIDocKey: '200' - create: + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/authorized_view_sets/methods/get' + - $ref: '#/components/x-stackQL-resources/authorized_view_sets/methods/list' + insert: + - $ref: >- + #/components/x-stackQL-resources/authorized_view_sets/methods/create + update: + - $ref: >- + #/components/x-stackQL-resources/authorized_view_sets/methods/patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/authorized_view_sets/methods/delete + authorized_views: + id: google.contactcenterinsights.authorized_views + name: authorized_views + title: Authorized_views + methods: + query_metrics: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews~1{authorizedViewsId}:queryMetrics/post response: mediaType: application/json openAPIDocKey: '200' - list: + query_performance_overview: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews~1{authorizedViewsId}:queryPerformanceOverview/post response: mediaType: application/json openAPIDocKey: '200' - undeploy: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}:undeploy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews/post response: mediaType: application/json openAPIDocKey: '200' - export: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}:export/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews/get response: mediaType: application/json openAPIDocKey: '200' - calculate_issue_model_stats: + objectKey: $.authorizedViews + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}:calculateIssueModelStats/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews~1{authorizedViewsId}/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/issue_models/methods/get' - - $ref: '#/components/x-stackQL-resources/issue_models/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/issue_models/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/issue_models/methods/patch' - replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/issue_models/methods/delete' - settings: - id: google.contactcenterinsights.settings - name: settings - title: Settings - methods: - update_settings: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1settings/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews~1{authorizedViewsId}/patch response: mediaType: application/json openAPIDocKey: '200' - get_settings: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1settings/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews~1{authorizedViewsId}/delete response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/settings/methods/get_settings' - insert: [] - update: - - $ref: '#/components/x-stackQL-resources/settings/methods/update_settings' - replace: [] - delete: [] - all_feedback_labels: - id: google.contactcenterinsights.all_feedback_labels - name: all_feedback_labels - title: All_feedback_labels - methods: - list_all_feedback_labels: + search: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:listAllFeedbackLabels/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews:search/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.feedbackLabels sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/all_feedback_labels/methods/list_all_feedback_labels - insert: [] - update: [] + - $ref: '#/components/x-stackQL-resources/authorized_views/methods/get' + - $ref: '#/components/x-stackQL-resources/authorized_views/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/authorized_views/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/authorized_views/methods/patch' replace: [] - delete: [] - locations: - id: google.contactcenterinsights.locations - name: locations - title: Locations + delete: + - $ref: '#/components/x-stackQL-resources/authorized_views/methods/delete' + authorized_views_iam_policies: + id: google.contactcenterinsights.authorized_views_iam_policies + name: authorized_views_iam_policies + title: Authorized_views_iam_policies methods: - bulk_download_feedback_labels: + set_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:bulkDownloadFeedbackLabels/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews~1{authorizedViewsId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - query_metrics: + get_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:queryMetrics/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews~1{authorizedViewsId}:getIamPolicy/get response: mediaType: application/json openAPIDocKey: '200' - bulk_upload_feedback_labels: + objectKey: $.bindings + test_iam_permissions: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:bulkUploadFeedbackLabels/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizedViewSets~1{authorizedViewSetsId}~1authorizedViews~1{authorizedViewsId}:testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/authorized_views_iam_policies/methods/get_iam_policy insert: [] update: [] - replace: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/authorized_views_iam_policies/methods/set_iam_policy delete: [] paths: - /v1/projects/{projectsId}/locations/{locationsId}/phraseMatchers/{phraseMatchersId}: + /v1/projects/{projectsId}/locations/{locationsId}/settings: parameters: &ref_1 + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/oauth_token' + get: + description: Gets project-level settings. + operationId: contactcenterinsights.projects.locations.getSettings + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1Settings + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + patch: + description: Updates project-level settings. + operationId: contactcenterinsights.projects.locations.updateSettings + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Settings' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1Settings + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/encryptionSpec: + parameters: *ref_1 + get: + description: Gets location-level encryption key specification. + operationId: contactcenterinsights.projects.locations.getEncryptionSpec + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1EncryptionSpec + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}:queryMetrics: + parameters: *ref_1 + post: + description: Query metrics. + operationId: contactcenterinsights.projects.locations.queryMetrics + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}:queryPerformanceOverview: + parameters: *ref_1 + post: + description: >- + Generates a summary of predefined performance metrics for a set of + conversations. Conversations can be specified by specifying a time + window and an agent id, for now. The summary includes a comparison of + metrics computed for conversations in the previous time period, and also + a comparison with peers in the same time period. + operationId: contactcenterinsights.projects.locations.queryPerformanceOverview + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}:listAllFeedbackLabels: + parameters: *ref_1 + get: + description: List all feedback labels by project number. + operationId: contactcenterinsights.projects.locations.listAllFeedbackLabels + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ListAllFeedbackLabelsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}:bulkUploadFeedbackLabels: + parameters: *ref_1 + post: + description: >- + Upload feedback labels from an external source in bulk. Currently + supports labeling Quality AI example conversations. + operationId: contactcenterinsights.projects.locations.bulkUploadFeedbackLabels + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}:bulkDownloadFeedbackLabels: + parameters: *ref_1 + post: + description: >- + Download feedback labels in bulk from an external source. Currently + supports exporting Quality AI example conversations with transcripts and + question bodies. + operationId: contactcenterinsights.projects.locations.bulkDownloadFeedbackLabels + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}:bulkDeleteFeedbackLabels: + parameters: *ref_1 + post: + description: Delete feedback labels in bulk using a filter. + operationId: contactcenterinsights.projects.locations.bulkDeleteFeedbackLabels + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: contactcenterinsights.projects.locations.operations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: contactcenterinsights.projects.locations.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + `1`, corresponding to `Code.CANCELLED`. + operationId: contactcenterinsights.projects.locations.operations.cancel + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/conversations: + parameters: *ref_1 + post: + description: >- + Creates a conversation. Note that this method does not support audio + transcription or redaction. Use `conversations.upload` instead. + operationId: contactcenterinsights.projects.locations.conversations.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: conversationId + schema: + type: string + get: + description: Lists conversations. + operationId: contactcenterinsights.projects.locations.conversations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ListConversationsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + - in: query + name: view + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/conversations:upload: + parameters: *ref_1 + post: + description: >- + Create a long-running conversation upload operation. This method differs + from `CreateConversation` by allowing audio transcription and optional + DLP redaction. + operationId: contactcenterinsights.projects.locations.conversations.upload + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1UploadConversationRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}: + parameters: *ref_1 + patch: + description: Updates a conversation. + operationId: contactcenterinsights.projects.locations.conversations.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: conversationsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: allowMissing + schema: + type: boolean + get: + description: Gets a conversation. + operationId: contactcenterinsights.projects.locations.conversations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: conversationsId + required: true + schema: + type: string + - in: query + name: view + schema: + type: string + delete: + description: Deletes a conversation. + operationId: contactcenterinsights.projects.locations.conversations.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: conversationsId + required: true + schema: + type: string + - in: query + name: force + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/conversations:sample: + parameters: *ref_1 + post: + description: >- + Samples conversations based on user configuration and handles the + sampled conversations for different use cases. + operationId: contactcenterinsights.projects.locations.conversations.sample + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1SampleConversationsRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/conversations:bulkAnalyze: + parameters: *ref_1 + post: + description: Analyzes multiple conversations in a single request. + operationId: contactcenterinsights.projects.locations.conversations.bulkAnalyze + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/conversations:bulkDelete: + parameters: *ref_1 + post: + description: Deletes multiple conversations in a single request. + operationId: contactcenterinsights.projects.locations.conversations.bulkDelete + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/conversations:ingest: + parameters: *ref_1 + post: + description: >- + Imports conversations and processes them according to the user's + configuration. + operationId: contactcenterinsights.projects.locations.conversations.ingest + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/conversations:calculateStats: + parameters: *ref_1 + get: + description: Gets conversation statistics. + operationId: contactcenterinsights.projects.locations.conversations.calculateStats + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1CalculateStatsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses: + parameters: *ref_1 + post: + description: >- + Creates an analysis. The long running operation is done when the + analysis has completed. + operationId: contactcenterinsights.projects.locations.conversations.analyses.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Analysis' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: conversationsId + required: true + schema: + type: string + get: + description: Lists analyses. + operationId: contactcenterinsights.projects.locations.conversations.analyses.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ListAnalysesResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: conversationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses/{analysesId}: + parameters: *ref_1 + get: + description: Gets an analysis. + operationId: contactcenterinsights.projects.locations.conversations.analyses.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1Analysis + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: conversationsId + required: true + schema: + type: string + - in: path + name: analysesId + required: true + schema: + type: string + delete: + description: Deletes an analysis. + operationId: contactcenterinsights.projects.locations.conversations.analyses.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: conversationsId + required: true + schema: + type: string + - in: path + name: analysesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/feedbackLabels: + parameters: *ref_1 + post: + description: Create feedback label. + operationId: >- + contactcenterinsights.projects.locations.conversations.feedbackLabels.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: conversationsId + required: true + schema: + type: string + - in: query + name: feedbackLabelId + schema: + type: string + get: + description: List feedback labels. + operationId: >- + contactcenterinsights.projects.locations.conversations.feedbackLabels.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ListFeedbackLabelsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: conversationsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}: + parameters: *ref_1 + get: + description: Get feedback label. + operationId: >- + contactcenterinsights.projects.locations.conversations.feedbackLabels.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: conversationsId + required: true + schema: + type: string + - in: path + name: feedbackLabelsId + required: true + schema: + type: string + patch: + description: Update feedback label. + operationId: >- + contactcenterinsights.projects.locations.conversations.feedbackLabels.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: conversationsId + required: true + schema: + type: string + - in: path + name: feedbackLabelsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Delete feedback label. + operationId: >- + contactcenterinsights.projects.locations.conversations.feedbackLabels.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: conversationsId + required: true + schema: + type: string + - in: path + name: feedbackLabelsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments: + parameters: *ref_1 + post: + description: Create Assessment. + operationId: >- + contactcenterinsights.projects.locations.conversations.assessments.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1Assessment + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1Assessment + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: conversationsId + required: true + schema: + type: string + get: + description: List Assessments. + operationId: contactcenterinsights.projects.locations.conversations.assessments.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ListAssessmentsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: conversationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}: + parameters: *ref_1 + get: + description: Get Assessment. + operationId: contactcenterinsights.projects.locations.conversations.assessments.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1Assessment + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: conversationsId + required: true + schema: + type: string + - in: path + name: assessmentsId + required: true + schema: + type: string + delete: + description: Delete an Assessment. + operationId: >- + contactcenterinsights.projects.locations.conversations.assessments.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: conversationsId + required: true + schema: + type: string + - in: path + name: assessmentsId + required: true + schema: + type: string + - in: query + name: force + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}:publish: + parameters: *ref_1 + post: + description: Publish an Assessment. + operationId: >- + contactcenterinsights.projects.locations.conversations.assessments.publish + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1PublishAssessmentRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1Assessment + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: conversationsId + required: true + schema: + type: string + - in: path + name: assessmentsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}:appeal: + parameters: *ref_1 + post: + description: Appeal an Assessment. + operationId: >- + contactcenterinsights.projects.locations.conversations.assessments.appeal + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AppealAssessmentRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1Assessment + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: conversationsId + required: true + schema: + type: string + - in: path + name: assessmentsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}:finalize: + parameters: *ref_1 + post: + description: Finalize an Assessment. + operationId: >- + contactcenterinsights.projects.locations.conversations.assessments.finalize + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1FinalizeAssessmentRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1Assessment + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: conversationsId + required: true + schema: + type: string + - in: path + name: assessmentsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes: + parameters: *ref_1 + post: + description: Create Note. + operationId: >- + contactcenterinsights.projects.locations.conversations.assessments.notes.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Note' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Note' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: conversationsId + required: true + schema: + type: string + - in: path + name: assessmentsId + required: true + schema: + type: string + get: + description: List Notes. + operationId: >- + contactcenterinsights.projects.locations.conversations.assessments.notes.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ListNotesResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: conversationsId + required: true + schema: + type: string + - in: path + name: assessmentsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes/{notesId}: + parameters: *ref_1 + patch: + description: Update Note. + operationId: >- + contactcenterinsights.projects.locations.conversations.assessments.notes.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Note' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Note' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: conversationsId + required: true + schema: + type: string + - in: path + name: assessmentsId + required: true + schema: + type: string + - in: path + name: notesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a Note. + operationId: >- + contactcenterinsights.projects.locations.conversations.assessments.notes.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: conversationsId + required: true + schema: + type: string + - in: path + name: assessmentsId + required: true + schema: + type: string + - in: path + name: notesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets: + parameters: *ref_1 + post: + description: Creates a dataset. + operationId: contactcenterinsights.projects.locations.datasets.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Dataset' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Dataset' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: datasetId + schema: + type: string + get: + description: List datasets matching the input. + operationId: contactcenterinsights.projects.locations.datasets.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ListDatasetsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}: + parameters: *ref_1 + get: + description: Gets a dataset. + operationId: contactcenterinsights.projects.locations.datasets.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Dataset' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + patch: + description: Updates a dataset. + operationId: contactcenterinsights.projects.locations.datasets.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Dataset' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Dataset' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Delete a dataset. + operationId: contactcenterinsights.projects.locations.datasets.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:listAllFeedbackLabels: + parameters: *ref_1 + get: + description: List all feedback labels by project number. + operationId: contactcenterinsights.projects.locations.datasets.listAllFeedbackLabels + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ListAllFeedbackLabelsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:bulkUploadFeedbackLabels: + parameters: *ref_1 + post: + description: >- + Upload feedback labels from an external source in bulk. Currently + supports labeling Quality AI example conversations. + operationId: >- + contactcenterinsights.projects.locations.datasets.bulkUploadFeedbackLabels + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:bulkDownloadFeedbackLabels: + parameters: *ref_1 + post: + description: >- + Download feedback labels in bulk from an external source. Currently + supports exporting Quality AI example conversations with transcripts and + question bodies. + operationId: >- + contactcenterinsights.projects.locations.datasets.bulkDownloadFeedbackLabels + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:bulkDeleteFeedbackLabels: + parameters: *ref_1 + post: + description: Delete feedback labels in bulk using a filter. + operationId: >- + contactcenterinsights.projects.locations.datasets.bulkDeleteFeedbackLabels + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}: + parameters: *ref_1 + get: + description: Gets a conversation. + operationId: contactcenterinsights.projects.locations.datasets.conversations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: conversationsId + required: true + schema: + type: string + - in: query + name: view + schema: + type: string + delete: + description: Deletes a conversation. + operationId: contactcenterinsights.projects.locations.datasets.conversations.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: conversationsId + required: true + schema: + type: string + - in: query + name: force + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations: + parameters: *ref_1 + get: + description: Lists conversations. + operationId: contactcenterinsights.projects.locations.datasets.conversations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ListConversationsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + - in: query + name: view + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations:sample: + parameters: *ref_1 + post: + description: >- + Samples conversations based on user configuration and handles the + sampled conversations for different use cases. + operationId: contactcenterinsights.projects.locations.datasets.conversations.sample + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1SampleConversationsRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations:bulkAnalyze: + parameters: *ref_1 + post: + description: Analyzes multiple conversations in a single request. + operationId: >- + contactcenterinsights.projects.locations.datasets.conversations.bulkAnalyze + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations:bulkDelete: + parameters: *ref_1 + post: + description: Deletes multiple conversations in a single request. + operationId: >- + contactcenterinsights.projects.locations.datasets.conversations.bulkDelete + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations:ingest: + parameters: *ref_1 + post: + description: >- + Imports conversations and processes them according to the user's + configuration. + operationId: contactcenterinsights.projects.locations.datasets.conversations.ingest + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations:calculateStats: + parameters: *ref_1 + post: + description: Gets conversation statistics. + operationId: >- + contactcenterinsights.projects.locations.datasets.conversations.calculateStats + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1CalculateStatsRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1CalculateStatsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/analyses: + parameters: *ref_1 + post: + description: >- + Creates an analysis. The long running operation is done when the + analysis has completed. + operationId: >- + contactcenterinsights.projects.locations.datasets.conversations.analyses.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Analysis' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: conversationsId + required: true + schema: + type: string + get: + description: Lists analyses. + operationId: >- + contactcenterinsights.projects.locations.datasets.conversations.analyses.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ListAnalysesResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: conversationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/analyses/{analysesId}: + parameters: *ref_1 + get: + description: Gets an analysis. + operationId: >- + contactcenterinsights.projects.locations.datasets.conversations.analyses.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1Analysis + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: conversationsId + required: true + schema: + type: string + - in: path + name: analysesId + required: true + schema: + type: string + delete: + description: Deletes an analysis. + operationId: >- + contactcenterinsights.projects.locations.datasets.conversations.analyses.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: conversationsId + required: true + schema: + type: string + - in: path + name: analysesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/feedbackLabels: + parameters: *ref_1 + post: + description: Create feedback label. + operationId: >- + contactcenterinsights.projects.locations.datasets.conversations.feedbackLabels.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: conversationsId + required: true + schema: + type: string + - in: query + name: feedbackLabelId + schema: + type: string + get: + description: List feedback labels. + operationId: >- + contactcenterinsights.projects.locations.datasets.conversations.feedbackLabels.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ListFeedbackLabelsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: conversationsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}: + parameters: *ref_1 + get: + description: Get feedback label. + operationId: >- + contactcenterinsights.projects.locations.datasets.conversations.feedbackLabels.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: conversationsId + required: true + schema: + type: string + - in: path + name: feedbackLabelsId + required: true + schema: + type: string + patch: + description: Update feedback label. + operationId: >- + contactcenterinsights.projects.locations.datasets.conversations.feedbackLabels.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: conversationsId + required: true + schema: + type: string + - in: path + name: feedbackLabelsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Delete feedback label. + operationId: >- + contactcenterinsights.projects.locations.datasets.conversations.feedbackLabels.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: conversationsId + required: true + schema: + type: string + - in: path + name: feedbackLabelsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/insightsdata:export: + parameters: *ref_1 + post: + description: Export insights data to a destination defined in the request body. + operationId: contactcenterinsights.projects.locations.datasets.insightsdata.export + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/insightsdata:export: + parameters: *ref_1 + post: + description: Export insights data to a destination defined in the request body. + operationId: contactcenterinsights.projects.locations.insightsdata.export + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/issueModels: + parameters: *ref_1 + post: + description: Creates an issue model. + operationId: contactcenterinsights.projects.locations.issueModels.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + get: + description: Lists issue models. + operationId: contactcenterinsights.projects.locations.issueModels.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ListIssueModelsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}: + parameters: *ref_1 patch: - description: Updates a phrase matcher. - operationId: contactcenterinsights.projects.locations.phraseMatchers.patch + description: Updates an issue model. + operationId: contactcenterinsights.projects.locations.issueModels.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: issueModelsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + get: + description: Gets an issue model. + operationId: contactcenterinsights.projects.locations.issueModels.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: issueModelsId + required: true + schema: + type: string + delete: + description: Deletes an issue model. + operationId: contactcenterinsights.projects.locations.issueModels.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: issueModelsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:deploy: + parameters: *ref_1 + post: + description: >- + Deploys an issue model. Returns an error if a model is already deployed. + An issue model can only be used in analysis after it has been deployed. + operationId: contactcenterinsights.projects.locations.issueModels.deploy + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1DeployIssueModelRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: issueModelsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:undeploy: + parameters: *ref_1 + post: + description: >- + Undeploys an issue model. An issue model can not be used in analysis + after it has been undeployed. + operationId: contactcenterinsights.projects.locations.issueModels.undeploy requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher + #/components/schemas/GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: issueModelsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:export: + parameters: *ref_1 + post: + description: Exports an issue model to the provided destination. + operationId: contactcenterinsights.projects.locations.issueModels.export + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ExportIssueModelRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: issueModelsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/issueModels:import: + parameters: *ref_1 + post: + description: Imports an issue model from a Cloud Storage bucket. + operationId: contactcenterinsights.projects.locations.issueModels.import + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ImportIssueModelRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:calculateIssueModelStats: + parameters: *ref_1 + get: + description: Gets an issue model's statistics. + operationId: >- + contactcenterinsights.projects.locations.issueModels.calculateIssueModelStats + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1CalculateIssueModelStatsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: issueModelsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues/{issuesId}: + parameters: *ref_1 + get: + description: Gets an issue. + operationId: contactcenterinsights.projects.locations.issueModels.issues.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Issue' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: issueModelsId + required: true + schema: + type: string + - in: path + name: issuesId + required: true + schema: + type: string + patch: + description: Updates an issue. + operationId: contactcenterinsights.projects.locations.issueModels.issues.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Issue' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Issue' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: issueModelsId + required: true + schema: + type: string + - in: path + name: issuesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes an issue. + operationId: contactcenterinsights.projects.locations.issueModels.issues.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8101,8 +13472,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -8115,18 +13485,20 @@ paths: schema: type: string - in: path - name: phraseMatchersId + name: issueModelsId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: issuesId + required: true schema: type: string - format: google-fieldmask - delete: - description: Deletes a phrase matcher. - operationId: contactcenterinsights.projects.locations.phraseMatchers.delete + /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues: + parameters: *ref_1 + get: + description: Lists issues. + operationId: contactcenterinsights.projects.locations.issueModels.issues.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8138,7 +13510,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ListIssuesResponse parameters: - in: path name: projectsId @@ -8151,13 +13524,18 @@ paths: schema: type: string - in: path - name: phraseMatchersId + name: issueModelsId required: true schema: type: string - get: - description: Gets a phrase matcher. - operationId: contactcenterinsights.projects.locations.phraseMatchers.get + post: + description: Creates an issue. + operationId: contactcenterinsights.projects.locations.issueModels.issues.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Issue' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8169,8 +13547,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -8183,7 +13560,7 @@ paths: schema: type: string - in: path - name: phraseMatchersId + name: issueModelsId required: true schema: type: string @@ -8249,10 +13626,6 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - in: query name: pageSize schema: @@ -8262,22 +13635,15 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/encryptionSpec:initialize: + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/phraseMatchers/{phraseMatchersId}: parameters: *ref_1 - post: - description: >- - Initializes a location-level encryption key specification. An error will - result if the location has resources already created before the - initialization. After the encryption specification is initialized at a - location, it is immutable and all newly created resources under the - location will be encrypted with the existing specification. - operationId: contactcenterinsights.projects.locations.encryptionSpec.initialize - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest + get: + description: Gets a phrase matcher. + operationId: contactcenterinsights.projects.locations.phraseMatchers.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8289,7 +13655,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher parameters: - in: path name: projectsId @@ -8301,12 +13668,14 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}: - parameters: *ref_1 - get: - description: Get feedback label. - operationId: >- - contactcenterinsights.projects.locations.conversations.feedbackLabels.get + - in: path + name: phraseMatchersId + required: true + schema: + type: string + delete: + description: Deletes a phrase matcher. + operationId: contactcenterinsights.projects.locations.phraseMatchers.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8318,8 +13687,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -8332,25 +13700,19 @@ paths: schema: type: string - in: path - name: conversationsId - required: true - schema: - type: string - - in: path - name: feedbackLabelsId + name: phraseMatchersId required: true schema: type: string patch: - description: Update feedback label. - operationId: >- - contactcenterinsights.projects.locations.conversations.feedbackLabels.patch + description: Updates a phrase matcher. + operationId: contactcenterinsights.projects.locations.phraseMatchers.patch requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8363,7 +13725,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher parameters: - in: path name: projectsId @@ -8376,12 +13738,7 @@ paths: schema: type: string - in: path - name: conversationsId - required: true - schema: - type: string - - in: path - name: feedbackLabelsId + name: phraseMatchersId required: true schema: type: string @@ -8390,10 +13747,17 @@ paths: schema: type: string format: google-fieldmask - delete: - description: Delete feedback label. - operationId: >- - contactcenterinsights.projects.locations.conversations.feedbackLabels.delete + /v1/projects/{projectsId}/locations/{locationsId}/analysisRules: + parameters: *ref_1 + post: + description: Creates a analysis rule. + operationId: contactcenterinsights.projects.locations.analysisRules.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AnalysisRule security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8405,7 +13769,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AnalysisRule parameters: - in: path name: projectsId @@ -8417,22 +13782,47 @@ paths: required: true schema: type: string + get: + description: Lists analysis rules. + operationId: contactcenterinsights.projects.locations.analysisRules.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ListAnalysisRulesResponse + parameters: - in: path - name: conversationsId + name: projectsId required: true schema: type: string - in: path - name: feedbackLabelsId + name: locationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/feedbackLabels: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/analysisRules/{analysisRulesId}: parameters: *ref_1 get: - description: List feedback labels. - operationId: >- - contactcenterinsights.projects.locations.conversations.feedbackLabels.list + description: Get a analysis rule. + operationId: contactcenterinsights.projects.locations.analysisRules.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8445,7 +13835,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ListFeedbackLabelsResponse + #/components/schemas/GoogleCloudContactcenterinsightsV1AnalysisRule parameters: - in: path name: projectsId @@ -8458,33 +13848,19 @@ paths: schema: type: string - in: path - name: conversationsId + name: analysisRulesId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - post: - description: Create feedback label. - operationId: >- - contactcenterinsights.projects.locations.conversations.feedbackLabels.create + patch: + description: Updates a analysis rule. + operationId: contactcenterinsights.projects.locations.analysisRules.patch requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel + #/components/schemas/GoogleCloudContactcenterinsightsV1AnalysisRule security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8497,7 +13873,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel + #/components/schemas/GoogleCloudContactcenterinsightsV1AnalysisRule parameters: - in: path name: projectsId @@ -8510,19 +13886,18 @@ paths: schema: type: string - in: path - name: conversationsId + name: analysisRulesId required: true schema: type: string - in: query - name: feedbackLabelId + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses: - parameters: *ref_1 - get: - description: Lists analyses. - operationId: contactcenterinsights.projects.locations.conversations.analyses.list + format: google-fieldmask + delete: + description: Deletes a analysis rule. + operationId: contactcenterinsights.projects.locations.analysisRules.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8534,8 +13909,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ListAnalysesResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -8548,33 +13922,52 @@ paths: schema: type: string - in: path - name: conversationsId + name: analysisRulesId required: true schema: type: string - - in: query - name: pageToken + /v1/projects/{projectsId}/locations/{locationsId}/assessmentRules: + parameters: *ref_1 + post: + description: Creates an assessment rule. + operationId: contactcenterinsights.projects.locations.assessmentRules.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AssessmentRule + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AssessmentRule + parameters: + - in: path + name: projectsId + required: true schema: type: string - - in: query - name: pageSize + - in: path + name: locationsId + required: true schema: - type: integer - format: int32 + type: string - in: query - name: filter + name: assessmentRuleId schema: type: string - post: - description: >- - Creates an analysis. The long running operation is done when the - analysis has completed. - operationId: contactcenterinsights.projects.locations.conversations.analyses.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Analysis' + get: + description: Lists assessment rules. + operationId: contactcenterinsights.projects.locations.assessmentRules.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8586,7 +13979,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ListAssessmentRulesResponse parameters: - in: path name: projectsId @@ -8598,16 +13992,20 @@ paths: required: true schema: type: string - - in: path - name: conversationsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses/{analysesId}: + /v1/projects/{projectsId}/locations/{locationsId}/assessmentRules/{assessmentRulesId}: parameters: *ref_1 get: - description: Gets an analysis. - operationId: contactcenterinsights.projects.locations.conversations.analyses.get + description: Get an assessment rule. + operationId: contactcenterinsights.projects.locations.assessmentRules.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8620,7 +14018,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1Analysis + #/components/schemas/GoogleCloudContactcenterinsightsV1AssessmentRule parameters: - in: path name: projectsId @@ -8633,18 +14031,19 @@ paths: schema: type: string - in: path - name: conversationsId - required: true - schema: - type: string - - in: path - name: analysesId + name: assessmentRulesId required: true schema: type: string - delete: - description: Deletes an analysis. - operationId: contactcenterinsights.projects.locations.conversations.analyses.delete + patch: + description: Updates an assessment rule. + operationId: contactcenterinsights.projects.locations.assessmentRules.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AssessmentRule security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8656,7 +14055,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AssessmentRule parameters: - in: path name: projectsId @@ -8669,20 +14069,18 @@ paths: schema: type: string - in: path - name: conversationsId + name: assessmentRulesId required: true schema: type: string - - in: path - name: analysesId - required: true + - in: query + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/conversations:calculateStats: - parameters: *ref_1 - get: - description: Gets conversation statistics. - operationId: contactcenterinsights.projects.locations.conversations.calculateStats + format: google-fieldmask + delete: + description: Deletes an assessment rule. + operationId: contactcenterinsights.projects.locations.assessmentRules.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8694,8 +14092,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1CalculateStatsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -8707,15 +14104,27 @@ paths: required: true schema: type: string - - in: query - name: filter + - in: path + name: assessmentRulesId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/conversations: + /v1/projects/{projectsId}/locations/{locationsId}/encryptionSpec:initialize: parameters: *ref_1 - get: - description: Lists conversations. - operationId: contactcenterinsights.projects.locations.conversations.list + post: + description: >- + Initializes a location-level encryption key specification. An error will + result if the location has resources already created before the + initialization. After the encryption specification is initialized at a + location, it is immutable and all newly created resources under the + location will be encrypted with the existing specification. + operationId: contactcenterinsights.projects.locations.encryptionSpec.initialize + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8727,8 +14136,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ListConversationsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -8740,38 +14148,16 @@ paths: required: true schema: type: string - - in: query - name: view - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: orderBy - schema: - type: string + /v1/projects/{projectsId}/locations/{locationsId}/views: + parameters: *ref_1 post: - description: >- - Creates a conversation. Note that this method does not support audio - transcription or redaction. Use `conversations.upload` instead. - operationId: contactcenterinsights.projects.locations.conversations.create + description: Creates a view. + operationId: contactcenterinsights.projects.locations.views.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8783,8 +14169,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' parameters: - in: path name: projectsId @@ -8796,15 +14181,9 @@ paths: required: true schema: type: string - - in: query - name: conversationId - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}: - parameters: *ref_1 get: - description: Gets a conversation. - operationId: contactcenterinsights.projects.locations.conversations.get + description: Lists views. + operationId: contactcenterinsights.projects.locations.views.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8817,7 +14196,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation + #/components/schemas/GoogleCloudContactcenterinsightsV1ListViewsResponse parameters: - in: path name: projectsId @@ -8829,18 +14208,20 @@ paths: required: true schema: type: string - - in: path - name: conversationsId - required: true + - in: query + name: pageSize schema: - type: string + type: integer + format: int32 - in: query - name: view + name: pageToken schema: type: string - delete: - description: Deletes a conversation. - operationId: contactcenterinsights.projects.locations.conversations.delete + /v1/projects/{projectsId}/locations/{locationsId}/views/{viewsId}: + parameters: *ref_1 + get: + description: Gets a view. + operationId: contactcenterinsights.projects.locations.views.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8852,7 +14233,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' parameters: - in: path name: projectsId @@ -8865,23 +14246,18 @@ paths: schema: type: string - in: path - name: conversationsId + name: viewsId required: true schema: type: string - - in: query - name: force - schema: - type: boolean patch: - description: Updates a conversation. - operationId: contactcenterinsights.projects.locations.conversations.patch + description: Updates a view. + operationId: contactcenterinsights.projects.locations.views.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8893,8 +14269,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' parameters: - in: path name: projectsId @@ -8907,7 +14282,7 @@ paths: schema: type: string - in: path - name: conversationsId + name: viewsId required: true schema: type: string @@ -8916,19 +14291,9 @@ paths: schema: type: string format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/conversations:ingest: - parameters: *ref_1 - post: - description: >- - Imports conversations and processes them according to the user's - configuration. - operationId: contactcenterinsights.projects.locations.conversations.ingest - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequest + delete: + description: Deletes a view. + operationId: contactcenterinsights.projects.locations.views.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8940,7 +14305,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -8952,54 +14317,22 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/conversations:bulkAnalyze: - parameters: *ref_1 - post: - description: Analyzes multiple conversations in a single request. - operationId: contactcenterinsights.projects.locations.conversations.bulkAnalyze - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - in: path - name: locationsId + name: viewsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/conversations:upload: + /v1/projects/{projectsId}/locations/{locationsId}/qaQuestionTags: parameters: *ref_1 post: - description: >- - Create a long-running conversation upload operation. This method differs - from `CreateConversation` by allowing audio transcription and optional - DLP redaction. - operationId: contactcenterinsights.projects.locations.conversations.upload + description: Creates a QaQuestionTag. + operationId: contactcenterinsights.projects.locations.qaQuestionTags.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1UploadConversationRequest + #/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestionTag security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9011,7 +14344,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestionTag parameters: - in: path name: projectsId @@ -9023,17 +14357,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/conversations:bulkDelete: - parameters: *ref_1 - post: - description: Deletes multiple conversations in a single request. - operationId: contactcenterinsights.projects.locations.conversations.bulkDelete - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest + - in: query + name: qaQuestionTagId + schema: + type: string + get: + description: Lists the question tags. + operationId: contactcenterinsights.projects.locations.qaQuestionTags.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9045,7 +14375,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ListQaQuestionTagsResponse parameters: - in: path name: projectsId @@ -9057,17 +14388,15 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/analysisRules/{analysisRulesId}: + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/qaQuestionTags/{qaQuestionTagsId}: parameters: *ref_1 - patch: - description: Updates a analysis rule. - operationId: contactcenterinsights.projects.locations.analysisRules.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnalysisRule + get: + description: Gets a QaQuestionTag. + operationId: contactcenterinsights.projects.locations.qaQuestionTags.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9080,7 +14409,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnalysisRule + #/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestionTag parameters: - in: path name: projectsId @@ -9092,19 +14421,20 @@ paths: required: true schema: type: string - - in: path - name: analysisRulesId - required: true - schema: - type: string - - in: query - name: updateMask + - in: path + name: qaQuestionTagsId + required: true schema: type: string - format: google-fieldmask - delete: - description: Deletes a analysis rule. - operationId: contactcenterinsights.projects.locations.analysisRules.delete + patch: + description: Updates a QaQuestionTag. + operationId: contactcenterinsights.projects.locations.qaQuestionTags.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1QaQuestionTag security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9116,7 +14446,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -9129,13 +14459,18 @@ paths: schema: type: string - in: path - name: analysisRulesId + name: qaQuestionTagsId required: true schema: type: string - get: - description: Get a analysis rule. - operationId: contactcenterinsights.projects.locations.analysisRules.get + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a QaQuestionTag. + operationId: contactcenterinsights.projects.locations.qaQuestionTags.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9147,8 +14482,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnalysisRule + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -9161,21 +14495,21 @@ paths: schema: type: string - in: path - name: analysisRulesId + name: qaQuestionTagsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/analysisRules: + /v1/projects/{projectsId}/locations/{locationsId}/qaScorecards: parameters: *ref_1 post: - description: Creates a analysis rule. - operationId: contactcenterinsights.projects.locations.analysisRules.create + description: Create a QaScorecard. + operationId: contactcenterinsights.projects.locations.qaScorecards.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnalysisRule + #/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecard security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9188,7 +14522,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnalysisRule + #/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecard parameters: - in: path name: projectsId @@ -9200,9 +14534,13 @@ paths: required: true schema: type: string + - in: query + name: qaScorecardId + schema: + type: string get: - description: Lists analysis rules. - operationId: contactcenterinsights.projects.locations.analysisRules.list + description: Lists QaScorecards. + operationId: contactcenterinsights.projects.locations.qaScorecards.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9215,7 +14553,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ListAnalysisRulesResponse + #/components/schemas/GoogleCloudContactcenterinsightsV1ListQaScorecardsResponse parameters: - in: path name: projectsId @@ -9236,11 +14574,15 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/views/{viewsId}: + - in: query + name: qaScorecardSources + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}: parameters: *ref_1 - delete: - description: Deletes a view. - operationId: contactcenterinsights.projects.locations.views.delete + get: + description: Gets a QaScorecard. + operationId: contactcenterinsights.projects.locations.qaScorecards.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9252,7 +14594,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecard parameters: - in: path name: projectsId @@ -9265,18 +14608,19 @@ paths: schema: type: string - in: path - name: viewsId + name: qaScorecardsId required: true schema: type: string patch: - description: Updates a view. - operationId: contactcenterinsights.projects.locations.views.patch + description: Updates a QaScorecard. + operationId: contactcenterinsights.projects.locations.qaScorecards.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecard security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9288,7 +14632,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecard parameters: - in: path name: projectsId @@ -9301,7 +14646,7 @@ paths: schema: type: string - in: path - name: viewsId + name: qaScorecardsId required: true schema: type: string @@ -9310,9 +14655,9 @@ paths: schema: type: string format: google-fieldmask - get: - description: Gets a view. - operationId: contactcenterinsights.projects.locations.views.get + delete: + description: Deletes a QaScorecard. + operationId: contactcenterinsights.projects.locations.qaScorecards.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9324,7 +14669,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -9337,15 +14682,25 @@ paths: schema: type: string - in: path - name: viewsId + name: qaScorecardsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/views: + - in: query + name: force + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions: parameters: *ref_1 - get: - description: Lists views. - operationId: contactcenterinsights.projects.locations.views.list + post: + description: Creates a QaScorecardRevision. + operationId: contactcenterinsights.projects.locations.qaScorecards.revisions.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecardRevision security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9358,7 +14713,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ListViewsResponse + #/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecardRevision parameters: - in: path name: projectsId @@ -9370,48 +14725,15 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - post: - description: Creates a view. - operationId: contactcenterinsights.projects.locations.views.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' - parameters: - in: path - name: projectsId + name: qaScorecardsId required: true schema: type: string - - in: path - name: locationsId - required: true + - in: query + name: qaScorecardRevisionId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions: - parameters: *ref_1 get: description: Lists all revisions under the parent QaScorecard. operationId: contactcenterinsights.projects.locations.qaScorecards.revisions.list @@ -9457,15 +14779,15 @@ paths: name: filter schema: type: string - post: - description: Creates a QaScorecardRevision. - operationId: contactcenterinsights.projects.locations.qaScorecards.revisions.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecardRevision + - in: query + name: qaScorecardSources + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}: + parameters: *ref_1 + get: + description: Gets a QaScorecardRevision. + operationId: contactcenterinsights.projects.locations.qaScorecards.revisions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9495,21 +14817,14 @@ paths: required: true schema: type: string - - in: query - name: qaScorecardRevisionId + - in: path + name: revisionsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}:deploy: - parameters: *ref_1 - post: - description: Deploy a QaScorecardRevision. - operationId: contactcenterinsights.projects.locations.qaScorecards.revisions.deploy - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1DeployQaScorecardRevisionRequest + delete: + description: Deletes a QaScorecardRevision. + operationId: contactcenterinsights.projects.locations.qaScorecards.revisions.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9521,8 +14836,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecardRevision + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -9544,6 +14858,10 @@ paths: required: true schema: type: string + - in: query + name: force + schema: + type: boolean /v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}:tuneQaScorecardRevision: parameters: *ref_1 post: @@ -9589,11 +14907,17 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}: + /v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}:deploy: parameters: *ref_1 - get: - description: Gets a QaScorecardRevision. - operationId: contactcenterinsights.projects.locations.qaScorecards.revisions.get + post: + description: Deploy a QaScorecardRevision. + operationId: contactcenterinsights.projects.locations.qaScorecards.revisions.deploy + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1DeployQaScorecardRevisionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9628,46 +14952,6 @@ paths: required: true schema: type: string - delete: - description: Deletes a QaScorecardRevision. - operationId: contactcenterinsights.projects.locations.qaScorecards.revisions.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: qaScorecardsId - required: true - schema: - type: string - - in: path - name: revisionsId - required: true - schema: - type: string - - in: query - name: force - schema: - type: boolean /v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}:undeploy: parameters: *ref_1 post: @@ -9713,12 +14997,12 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}/qaQuestions/{qaQuestionsId}: + /v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}/qaQuestions: parameters: *ref_1 - patch: - description: Updates a QaQuestion. + post: + description: Create a QaQuestion. operationId: >- - contactcenterinsights.projects.locations.qaScorecards.revisions.qaQuestions.patch + contactcenterinsights.projects.locations.qaScorecards.revisions.qaQuestions.create requestBody: content: application/json: @@ -9755,24 +15039,18 @@ paths: schema: type: string - in: path - name: revisionsId - required: true - schema: - type: string - - in: path - name: qaQuestionsId + name: revisionsId required: true schema: type: string - in: query - name: updateMask + name: qaQuestionId schema: type: string - format: google-fieldmask - delete: - description: Deletes a QaQuestion. + get: + description: Lists QaQuestions. operationId: >- - contactcenterinsights.projects.locations.qaScorecards.revisions.qaQuestions.delete + contactcenterinsights.projects.locations.qaScorecards.revisions.qaQuestions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9784,7 +15062,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ListQaQuestionsResponse parameters: - in: path name: projectsId @@ -9806,11 +15085,17 @@ paths: required: true schema: type: string - - in: path - name: qaQuestionsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}/qaQuestions/{qaQuestionsId}: + parameters: *ref_1 get: description: Gets a QaQuestion. operationId: >- @@ -9854,12 +15139,10 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}/revisions/{revisionsId}/qaQuestions: - parameters: *ref_1 - post: - description: Create a QaQuestion. + patch: + description: Updates a QaQuestion. operationId: >- - contactcenterinsights.projects.locations.qaScorecards.revisions.qaQuestions.create + contactcenterinsights.projects.locations.qaScorecards.revisions.qaQuestions.patch requestBody: content: application/json: @@ -9900,14 +15183,20 @@ paths: required: true schema: type: string + - in: path + name: qaQuestionsId + required: true + schema: + type: string - in: query - name: qaQuestionId + name: updateMask schema: type: string - get: - description: Lists QaQuestions. + format: google-fieldmask + delete: + description: Deletes a QaQuestion. operationId: >- - contactcenterinsights.projects.locations.qaScorecards.revisions.qaQuestions.list + contactcenterinsights.projects.locations.qaScorecards.revisions.qaQuestions.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9919,8 +15208,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ListQaQuestionsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -9942,26 +15230,22 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: qaQuestionsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/qaScorecards/{qaScorecardsId}: + /v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets: parameters: *ref_1 - patch: - description: Updates a QaScorecard. - operationId: contactcenterinsights.projects.locations.qaScorecards.patch + post: + description: Create AuthorizedViewSet + operationId: contactcenterinsights.projects.locations.authorizedViewSets.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecard + #/components/schemas/GoogleCloudContactcenterinsightsV1AuthorizedViewSet security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9974,7 +15258,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecard + #/components/schemas/GoogleCloudContactcenterinsightsV1AuthorizedViewSet parameters: - in: path name: projectsId @@ -9986,19 +15270,13 @@ paths: required: true schema: type: string - - in: path - name: qaScorecardsId - required: true - schema: - type: string - in: query - name: updateMask + name: authorizedViewSetId schema: type: string - format: google-fieldmask get: - description: Gets a QaScorecard. - operationId: contactcenterinsights.projects.locations.qaScorecards.get + description: List AuthorizedViewSets + operationId: contactcenterinsights.projects.locations.authorizedViewSets.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10011,7 +15289,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecard + #/components/schemas/GoogleCloudContactcenterinsightsV1ListAuthorizedViewSetsResponse parameters: - in: path name: projectsId @@ -10023,14 +15301,28 @@ paths: required: true schema: type: string - - in: path - name: qaScorecardsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - delete: - description: Deletes a QaScorecard. - operationId: contactcenterinsights.projects.locations.qaScorecards.delete + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}: + parameters: *ref_1 + get: + description: Get AuthorizedViewSet + operationId: contactcenterinsights.projects.locations.authorizedViewSets.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10042,7 +15334,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AuthorizedViewSet parameters: - in: path name: projectsId @@ -10055,25 +15348,19 @@ paths: schema: type: string - in: path - name: qaScorecardsId + name: authorizedViewSetsId required: true schema: type: string - - in: query - name: force - schema: - type: boolean - /v1/projects/{projectsId}/locations/{locationsId}/qaScorecards: - parameters: *ref_1 - post: - description: Create a QaScorecard. - operationId: contactcenterinsights.projects.locations.qaScorecards.create + patch: + description: Updates an AuthorizedViewSet. + operationId: contactcenterinsights.projects.locations.authorizedViewSets.patch requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecard + #/components/schemas/GoogleCloudContactcenterinsightsV1AuthorizedViewSet security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10086,7 +15373,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1QaScorecard + #/components/schemas/GoogleCloudContactcenterinsightsV1AuthorizedViewSet parameters: - in: path name: projectsId @@ -10098,13 +15385,19 @@ paths: required: true schema: type: string + - in: path + name: authorizedViewSetsId + required: true + schema: + type: string - in: query - name: qaScorecardId + name: updateMask schema: type: string - get: - description: Lists QaScorecards. - operationId: contactcenterinsights.projects.locations.qaScorecards.list + format: google-fieldmask + delete: + description: Deletes an AuthorizedViewSet. + operationId: contactcenterinsights.projects.locations.authorizedViewSets.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10116,8 +15409,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ListQaScorecardsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -10129,26 +15421,27 @@ paths: required: true schema: type: string - - in: query - name: pageSize + - in: path + name: authorizedViewSetsId + required: true schema: - type: integer - format: int32 + type: string - in: query - name: pageToken + name: force schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/insightsdata:export: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:queryMetrics: parameters: *ref_1 post: - description: Export insights data to a destination defined in the request body. - operationId: contactcenterinsights.projects.locations.insightsdata.export + description: Query metrics. + operationId: >- + contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.queryMetrics requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest + #/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10172,12 +15465,33 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}: + - in: path + name: authorizedViewSetsId + required: true + schema: + type: string + - in: path + name: authorizedViewsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:queryPerformanceOverview: parameters: *ref_1 - delete: - description: Deletes a conversation. + post: + description: >- + Generates a summary of predefined performance metrics for a set of + conversations. Conversations can be specified by specifying a time + window and an agent id, for now. The summary includes a comparison of + metrics computed for conversations in the previous time period, and also + a comparison with peers in the same time period. operationId: >- - contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.delete + contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.queryPerformanceOverview + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1QueryPerformanceOverviewRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10189,7 +15503,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -10211,19 +15525,18 @@ paths: required: true schema: type: string - - in: path - name: conversationsId - required: true - schema: - type: string - - in: query - name: force - schema: - type: boolean - get: - description: Gets a conversation. + /v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews: + parameters: *ref_1 + post: + description: Create AuthorizedView operationId: >- - contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.get + contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AuthorizedView security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10236,7 +15549,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation + #/components/schemas/GoogleCloudContactcenterinsightsV1AuthorizedView parameters: - in: path name: projectsId @@ -10253,30 +15566,14 @@ paths: required: true schema: type: string - - in: path - name: authorizedViewsId - required: true - schema: - type: string - - in: path - name: conversationsId - required: true - schema: - type: string - in: query - name: view + name: authorizedViewId schema: type: string - patch: - description: Updates a conversation. + get: + description: List AuthorizedViewSets operationId: >- - contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation + contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10289,7 +15586,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation + #/components/schemas/GoogleCloudContactcenterinsightsV1ListAuthorizedViewsResponse parameters: - in: path name: projectsId @@ -10306,35 +15603,29 @@ paths: required: true schema: type: string - - in: path - name: authorizedViewsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - - in: path - name: conversationsId - required: true + - in: query + name: filter schema: type: string - in: query - name: updateMask + name: orderBy schema: type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations: + /v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}: parameters: *ref_1 - post: - description: >- - Creates a conversation. Note that this method does not support audio - transcription or redaction. Use `conversations.upload` instead. + get: + description: Get AuthorizedView operationId: >- - contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation + contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10347,7 +15638,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation + #/components/schemas/GoogleCloudContactcenterinsightsV1AuthorizedView parameters: - in: path name: projectsId @@ -10369,14 +15660,16 @@ paths: required: true schema: type: string - - in: query - name: conversationId - schema: - type: string - get: - description: Lists conversations. + patch: + description: Updates an AuthorizedView. operationId: >- - contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.list + contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AuthorizedView security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10389,7 +15682,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ListConversationsResponse + #/components/schemas/GoogleCloudContactcenterinsightsV1AuthorizedView parameters: - in: path name: projectsId @@ -10412,41 +15705,14 @@ paths: schema: type: string - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: view - schema: - type: string - - in: query - name: filter + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations:upload: - parameters: *ref_1 - post: - description: >- - Create a long-running conversation upload operation. This method differs - from `CreateConversation` by allowing audio transcription and optional - DLP redaction. + format: google-fieldmask + delete: + description: Deletes an AuthorizedView. operationId: >- - contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.upload - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation + contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10458,7 +15724,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -10480,28 +15746,12 @@ paths: required: true schema: type: string - - in: query - name: speechConfig.speechRecognizer - schema: - type: string - - in: query - name: redactionConfig.inspectTemplate - schema: - type: string - - in: query - name: conversationId - schema: - type: string - - in: query - name: redactionConfig.deidentifyTemplate - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/analyses: + /v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews:search: parameters: *ref_1 get: - description: Lists analyses. + description: SearchAuthorizedViewSets operationId: >- - contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.list + contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.search security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10514,7 +15764,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ListAnalysesResponse + #/components/schemas/GoogleCloudContactcenterinsightsV1SearchAuthorizedViewsResponse parameters: - in: path name: projectsId @@ -10531,16 +15781,6 @@ paths: required: true schema: type: string - - in: path - name: authorizedViewsId - required: true - schema: - type: string - - in: path - name: conversationsId - required: true - schema: - type: string - in: query name: pageSize schema: @@ -10551,20 +15791,27 @@ paths: schema: type: string - in: query - name: filter + name: query + schema: + type: string + - in: query + name: orderBy schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:setIamPolicy: + parameters: *ref_1 post: description: >- - Creates an analysis. The long running operation is done when the - analysis has completed. + Sets the access control policy on the specified resource. Replaces any + existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and + `PERMISSION_DENIED` errors. operationId: >- - contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.create + contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.setIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Analysis' + $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10576,7 +15823,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -10598,17 +15845,14 @@ paths: required: true schema: type: string - - in: path - name: conversationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/analyses/{analysesId}: + /v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:getIamPolicy: parameters: *ref_1 get: - description: Gets an analysis. + description: >- + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. operationId: >- - contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.get + contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10620,8 +15864,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1Analysis + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -10643,20 +15886,27 @@ paths: required: true schema: type: string - - in: path - name: conversationsId - required: true - schema: - type: string - - in: path - name: analysesId - required: true + - in: query + name: options.requestedPolicyVersion schema: - type: string - delete: - description: Deletes an analysis. + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:testIamPermissions: + parameters: *ref_1 + post: + description: >- + Returns permissions that a caller has on the specified resource. If the + resource does not exist, this will return an empty set of permissions, + not a `NOT_FOUND` error. Note: This operation is designed to be used for + building permission-aware UIs and command-line tools, not for + authorization checking. This operation may "fail open" without warning. operationId: >- - contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.delete + contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10668,7 +15918,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' parameters: - in: path name: projectsId @@ -10690,16 +15940,6 @@ paths: required: true schema: type: string - - in: path - name: conversationsId - required: true - schema: - type: string - - in: path - name: analysesId - required: true - schema: - type: string /v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/operations: parameters: *ref_1 get: @@ -10813,7 +16053,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: >- contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.operations.cancel security: @@ -10854,66 +16094,12 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:getIamPolicy: + /v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}: parameters: *ref_1 get: - description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: >- - contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.getIamPolicy - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1Policy' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: authorizedViewSetsId - required: true - schema: - type: string - - in: path - name: authorizedViewsId - required: true - schema: - type: string - - in: query - name: options.requestedPolicyVersion - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:setIamPolicy: - parameters: *ref_1 - post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - `PERMISSION_DENIED` errors. + description: Gets a conversation. operationId: >- - contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' + contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10925,7 +16111,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation parameters: - in: path name: projectsId @@ -10947,61 +16134,19 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:testIamPermissions: - parameters: *ref_1 - post: - description: >- - Returns permissions that a caller has on the specified resource. If the - resource does not exist, this will return an empty set of permissions, - not a `NOT_FOUND` error. Note: This operation is designed to be used for - building permission-aware UIs and command-line tools, not for - authorization checking. This operation may "fail open" without warning. - operationId: >- - contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.testIamPermissions - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - in: path - name: authorizedViewSetsId + name: conversationsId required: true schema: type: string - - in: path - name: authorizedViewsId - required: true + - in: query + name: view schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSet/{authorizedViewSetId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}: - parameters: *ref_1 delete: - description: Delete feedback label. + description: Deletes a conversation. operationId: >- - contactcenterinsights.projects.locations.authorizedViewSet.authorizedViews.conversations.feedbackLabels.delete + contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11026,7 +16171,7 @@ paths: schema: type: string - in: path - name: authorizedViewSetId + name: authorizedViewSetsId required: true schema: type: string @@ -11040,15 +16185,16 @@ paths: required: true schema: type: string - - in: path - name: feedbackLabelsId - required: true + - in: query + name: force schema: - type: string + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations: + parameters: *ref_1 get: - description: Get feedback label. + description: Lists conversations. operationId: >- - contactcenterinsights.projects.locations.authorizedViewSet.authorizedViews.conversations.feedbackLabels.get + contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11061,7 +16207,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel + #/components/schemas/GoogleCloudContactcenterinsightsV1ListConversationsResponse parameters: - in: path name: projectsId @@ -11074,7 +16220,7 @@ paths: schema: type: string - in: path - name: authorizedViewSetId + name: authorizedViewSetsId required: true schema: type: string @@ -11083,26 +16229,39 @@ paths: required: true schema: type: string - - in: path - name: conversationsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - - in: path - name: feedbackLabelsId - required: true + - in: query + name: filter schema: type: string - patch: - description: Update feedback label. + - in: query + name: orderBy + schema: + type: string + - in: query + name: view + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations:bulkAnalyze: + parameters: *ref_1 + post: + description: Analyzes multiple conversations in a single request. operationId: >- - contactcenterinsights.projects.locations.authorizedViewSet.authorizedViews.conversations.feedbackLabels.patch + contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.bulkAnalyze requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel + #/components/schemas/GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11114,8 +16273,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -11128,7 +16286,7 @@ paths: schema: type: string - in: path - name: authorizedViewSetId + name: authorizedViewSetsId required: true schema: type: string @@ -11137,27 +16295,12 @@ paths: required: true schema: type: string - - in: path - name: conversationsId - required: true - schema: - type: string - - in: path - name: feedbackLabelsId - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSet/{authorizedViewSetId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels: + /v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations:calculateStats: parameters: *ref_1 get: - description: List feedback labels. + description: Gets conversation statistics. operationId: >- - contactcenterinsights.projects.locations.authorizedViewSet.authorizedViews.conversations.feedbackLabels.list + contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.calculateStats security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11170,7 +16313,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ListFeedbackLabelsResponse + #/components/schemas/GoogleCloudContactcenterinsightsV1CalculateStatsResponse parameters: - in: path name: projectsId @@ -11183,7 +16326,7 @@ paths: schema: type: string - in: path - name: authorizedViewSetId + name: authorizedViewSetsId required: true schema: type: string @@ -11192,34 +16335,23 @@ paths: required: true schema: type: string - - in: path - name: conversationsId - required: true - schema: - type: string - - in: query - name: pageToken - schema: - type: string - in: query name: filter schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/analyses: + parameters: *ref_1 post: - description: Create feedback label. + description: >- + Creates an analysis. The long running operation is done when the + analysis has completed. operationId: >- - contactcenterinsights.projects.locations.authorizedViewSet.authorizedViews.conversations.feedbackLabels.create + contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Analysis' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11231,8 +16363,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -11245,7 +16376,7 @@ paths: schema: type: string - in: path - name: authorizedViewSetId + name: authorizedViewSetsId required: true schema: type: string @@ -11259,16 +16390,10 @@ paths: required: true schema: type: string - - in: query - name: feedbackLabelId - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSet/{authorizedViewSetId}/authorizedView/{authorizedViewId}:calculateStats: - parameters: *ref_1 get: - description: Gets conversation statistics. + description: Lists analyses. operationId: >- - contactcenterinsights.projects.locations.authorizedViewSet.authorizedView.calculateStats + contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11281,7 +16406,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1CalculateStatsResponse + #/components/schemas/GoogleCloudContactcenterinsightsV1ListAnalysesResponse parameters: - in: path name: projectsId @@ -11294,31 +16419,39 @@ paths: schema: type: string - in: path - name: authorizedViewSetId + name: authorizedViewSetsId required: true schema: type: string - in: path - name: authorizedViewId + name: authorizedViewsId + required: true + schema: + type: string + - in: path + name: conversationsId required: true schema: type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string - in: query name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSet/{authorizedViewSetId}/authorizedView/{authorizedViewId}:queryMetrics: + /v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/analyses/{analysesId}: parameters: *ref_1 - post: - description: Query metrics. + get: + description: Gets an analysis. operationId: >- - contactcenterinsights.projects.locations.authorizedViewSet.authorizedView.queryMetrics - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsRequest + contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11330,7 +16463,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1Analysis parameters: - in: path name: projectsId @@ -11343,25 +16477,29 @@ paths: schema: type: string - in: path - name: authorizedViewSetId + name: authorizedViewSetsId required: true schema: type: string - in: path - name: authorizedViewId + name: authorizedViewsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues/{issuesId}: - parameters: *ref_1 - patch: - description: Updates an issue. - operationId: contactcenterinsights.projects.locations.issueModels.issues.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Issue' + - in: path + name: conversationsId + required: true + schema: + type: string + - in: path + name: analysesId + required: true + schema: + type: string + delete: + description: Deletes an analysis. + operationId: >- + contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11373,7 +16511,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Issue' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -11386,23 +16524,37 @@ paths: schema: type: string - in: path - name: issueModelsId + name: authorizedViewSetsId required: true schema: type: string - in: path - name: issuesId + name: authorizedViewsId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: conversationsId + required: true schema: type: string - format: google-fieldmask - get: - description: Gets an issue. - operationId: contactcenterinsights.projects.locations.issueModels.issues.get + - in: path + name: analysesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels: + parameters: *ref_1 + post: + description: Create feedback label. + operationId: >- + contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11414,7 +16566,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Issue' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel parameters: - in: path name: projectsId @@ -11427,18 +16580,28 @@ paths: schema: type: string - in: path - name: issueModelsId + name: authorizedViewSetsId required: true schema: type: string - in: path - name: issuesId + name: authorizedViewsId required: true schema: type: string - delete: - description: Deletes an issue. - operationId: contactcenterinsights.projects.locations.issueModels.issues.delete + - in: path + name: conversationsId + required: true + schema: + type: string + - in: query + name: feedbackLabelId + schema: + type: string + get: + description: List feedback labels. + operationId: >- + contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11450,7 +16613,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ListFeedbackLabelsResponse parameters: - in: path name: projectsId @@ -11463,20 +16627,39 @@ paths: schema: type: string - in: path - name: issueModelsId + name: authorizedViewSetsId required: true schema: type: string - in: path - name: issuesId + name: authorizedViewsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues: + - in: path + name: conversationsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}: parameters: *ref_1 get: - description: Lists issues. - operationId: contactcenterinsights.projects.locations.issueModels.issues.list + description: Get feedback label. + operationId: >- + contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11489,7 +16672,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ListIssuesResponse + #/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel parameters: - in: path name: projectsId @@ -11502,52 +16685,35 @@ paths: schema: type: string - in: path - name: issueModelsId + name: authorizedViewSetsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}: - parameters: *ref_1 - delete: - description: Deletes an issue model. - operationId: contactcenterinsights.projects.locations.issueModels.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - in: path - name: projectsId + name: authorizedViewsId required: true schema: type: string - in: path - name: locationsId + name: conversationsId required: true schema: type: string - in: path - name: issueModelsId + name: feedbackLabelsId required: true schema: type: string patch: - description: Updates an issue model. - operationId: contactcenterinsights.projects.locations.issueModels.patch + description: Update feedback label. + operationId: >- + contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.patch requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel + #/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11560,7 +16726,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel + #/components/schemas/GoogleCloudContactcenterinsightsV1FeedbackLabel parameters: - in: path name: projectsId @@ -11573,7 +16739,22 @@ paths: schema: type: string - in: path - name: issueModelsId + name: authorizedViewSetsId + required: true + schema: + type: string + - in: path + name: authorizedViewsId + required: true + schema: + type: string + - in: path + name: conversationsId + required: true + schema: + type: string + - in: path + name: feedbackLabelsId required: true schema: type: string @@ -11582,9 +16763,10 @@ paths: schema: type: string format: google-fieldmask - get: - description: Gets an issue model. - operationId: contactcenterinsights.projects.locations.issueModels.get + delete: + description: Delete feedback label. + operationId: >- + contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11596,8 +16778,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -11610,57 +16791,37 @@ paths: schema: type: string - in: path - name: issueModelsId + name: authorizedViewSetsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/issueModels:import: - parameters: *ref_1 - post: - description: Imports an issue model from a Cloud Storage bucket. - operationId: contactcenterinsights.projects.locations.issueModels.import - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ImportIssueModelRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - in: path - name: projectsId + name: authorizedViewsId required: true schema: type: string - in: path - name: locationsId + name: conversationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:deploy: + - in: path + name: feedbackLabelsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments: parameters: *ref_1 post: - description: >- - Deploys an issue model. Returns an error if a model is already deployed. - An issue model can only be used in analysis after it has been deployed. - operationId: contactcenterinsights.projects.locations.issueModels.deploy + description: Create Assessment. + operationId: >- + contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1DeployIssueModelRequest + #/components/schemas/GoogleCloudContactcenterinsightsV1Assessment security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11672,7 +16833,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1Assessment parameters: - in: path name: projectsId @@ -11685,21 +16847,24 @@ paths: schema: type: string - in: path - name: issueModelsId + name: authorizedViewSetsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/issueModels: - parameters: *ref_1 - post: - description: Creates an issue model. - operationId: contactcenterinsights.projects.locations.issueModels.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel + - in: path + name: authorizedViewsId + required: true + schema: + type: string + - in: path + name: conversationsId + required: true + schema: + type: string + get: + description: List Assessments. + operationId: >- + contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11711,7 +16876,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ListAssessmentsResponse parameters: - in: path name: projectsId @@ -11723,9 +16889,40 @@ paths: required: true schema: type: string + - in: path + name: authorizedViewSetsId + required: true + schema: + type: string + - in: path + name: authorizedViewsId + required: true + schema: + type: string + - in: path + name: conversationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}: + parameters: *ref_1 get: - description: Lists issue models. - operationId: contactcenterinsights.projects.locations.issueModels.list + description: Get Assessment. + operationId: >- + contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11738,7 +16935,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ListIssueModelsResponse + #/components/schemas/GoogleCloudContactcenterinsightsV1Assessment parameters: - in: path name: projectsId @@ -11750,19 +16947,30 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:undeploy: - parameters: *ref_1 - post: - description: >- - Undeploys an issue model. An issue model can not be used in analysis - after it has been undeployed. - operationId: contactcenterinsights.projects.locations.issueModels.undeploy - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest + - in: path + name: authorizedViewSetsId + required: true + schema: + type: string + - in: path + name: authorizedViewsId + required: true + schema: + type: string + - in: path + name: conversationsId + required: true + schema: + type: string + - in: path + name: assessmentsId + required: true + schema: + type: string + delete: + description: Delete an Assessment. + operationId: >- + contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11774,7 +16982,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -11787,21 +16995,41 @@ paths: schema: type: string - in: path - name: issueModelsId + name: authorizedViewSetsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:export: + - in: path + name: authorizedViewsId + required: true + schema: + type: string + - in: path + name: conversationsId + required: true + schema: + type: string + - in: path + name: assessmentsId + required: true + schema: + type: string + - in: query + name: force + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}:publish: parameters: *ref_1 post: - description: Exports an issue model to the provided destination. - operationId: contactcenterinsights.projects.locations.issueModels.export + description: Publish an Assessment. + operationId: >- + contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.publish requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ExportIssueModelRequest + #/components/schemas/GoogleCloudContactcenterinsightsV1PublishAssessmentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11813,7 +17041,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1Assessment parameters: - in: path name: projectsId @@ -11826,52 +17055,37 @@ paths: schema: type: string - in: path - name: issueModelsId + name: authorizedViewSetsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:calculateIssueModelStats: - parameters: *ref_1 - get: - description: Gets an issue model's statistics. - operationId: >- - contactcenterinsights.projects.locations.issueModels.calculateIssueModelStats - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1CalculateIssueModelStatsResponse - parameters: - in: path - name: projectsId + name: authorizedViewsId required: true schema: type: string - in: path - name: locationsId + name: conversationsId required: true schema: type: string - in: path - name: issueModelsId + name: assessmentsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}:appeal: parameters: *ref_1 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: contactcenterinsights.projects.locations.operations.list + post: + description: Appeal an Assessment. + operationId: >- + contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.appeal + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AppealAssessmentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11883,7 +17097,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1Assessment parameters: - in: path name: projectsId @@ -11895,33 +17110,38 @@ paths: required: true schema: type: string - - in: query - name: filter + - in: path + name: authorizedViewSetsId + required: true schema: type: string - - in: query - name: pageToken + - in: path + name: authorizedViewsId + required: true schema: type: string - - in: query - name: pageSize + - in: path + name: conversationsId + required: true schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: + type: string + - in: path + name: assessmentsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}:finalize: parameters: *ref_1 post: - description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: contactcenterinsights.projects.locations.operations.cancel + description: Finalize an Assessment. + operationId: >- + contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.finalize + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1FinalizeAssessmentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11933,7 +17153,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1Assessment parameters: - in: path name: projectsId @@ -11946,56 +17167,36 @@ paths: schema: type: string - in: path - name: operationsId + name: authorizedViewSetsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_1 - get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: contactcenterinsights.projects.locations.operations.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - in: path - name: projectsId + name: authorizedViewsId required: true schema: type: string - in: path - name: locationsId + name: conversationsId required: true schema: type: string - in: path - name: operationsId + name: assessmentsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/settings: + /v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes: parameters: *ref_1 - patch: - description: Updates project-level settings. - operationId: contactcenterinsights.projects.locations.updateSettings + post: + description: Create Note. + operationId: >- + contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.notes.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Settings' + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Note' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12007,8 +17208,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1Settings + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Note' parameters: - in: path name: projectsId @@ -12020,43 +17220,30 @@ paths: required: true schema: type: string - - in: query - name: updateMask + - in: path + name: authorizedViewSetsId + required: true schema: type: string - format: google-fieldmask - get: - description: Gets project-level settings. - operationId: contactcenterinsights.projects.locations.getSettings - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1Settings - parameters: - in: path - name: projectsId + name: authorizedViewsId required: true schema: type: string - in: path - name: locationsId + name: conversationsId + required: true + schema: + type: string + - in: path + name: assessmentsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}:listAllFeedbackLabels: - parameters: *ref_1 get: - description: List all feedback labels by project number. - operationId: contactcenterinsights.projects.locations.listAllFeedbackLabels + description: List Notes. + operationId: >- + contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.notes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12069,7 +17256,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ListAllFeedbackLabelsResponse + #/components/schemas/GoogleCloudContactcenterinsightsV1ListNotesResponse parameters: - in: path name: projectsId @@ -12081,8 +17268,24 @@ paths: required: true schema: type: string - - in: query - name: pageToken + - in: path + name: authorizedViewSetsId + required: true + schema: + type: string + - in: path + name: authorizedViewsId + required: true + schema: + type: string + - in: path + name: conversationsId + required: true + schema: + type: string + - in: path + name: assessmentsId + required: true schema: type: string - in: query @@ -12091,20 +17294,20 @@ paths: type: integer format: int32 - in: query - name: filter + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}:bulkDownloadFeedbackLabels: + /v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/assessments/{assessmentsId}/notes/{notesId}: parameters: *ref_1 - post: - description: Download feedback labels in bulk. - operationId: contactcenterinsights.projects.locations.bulkDownloadFeedbackLabels + patch: + description: Update Note. + operationId: >- + contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.notes.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequest + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Note' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12116,7 +17319,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Note' parameters: - in: path name: projectsId @@ -12128,79 +17331,40 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}:queryMetrics: - parameters: *ref_1 - post: - description: Query metrics. - operationId: contactcenterinsights.projects.locations.queryMetrics - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1QueryMetricsRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - in: path - name: projectsId + name: authorizedViewSetsId required: true schema: type: string - in: path - name: locationsId + name: authorizedViewsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}:bulkUploadFeedbackLabels: - parameters: *ref_1 - post: - description: Upload feedback labels in bulk. - operationId: contactcenterinsights.projects.locations.bulkUploadFeedbackLabels - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - in: path - name: projectsId + name: conversationsId required: true schema: type: string - in: path - name: locationsId + name: assessmentsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/encryptionSpec: - parameters: *ref_1 - get: - description: Gets location-level encryption key specification. - operationId: contactcenterinsights.projects.locations.getEncryptionSpec + - in: path + name: notesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a Note. + operationId: >- + contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.notes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12212,8 +17376,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1EncryptionSpec + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -12225,3 +17388,28 @@ paths: required: true schema: type: string + - in: path + name: authorizedViewSetsId + required: true + schema: + type: string + - in: path + name: authorizedViewsId + required: true + schema: + type: string + - in: path + name: conversationsId + required: true + schema: + type: string + - in: path + name: assessmentsId + required: true + schema: + type: string + - in: path + name: notesId + required: true + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/container.yaml b/providers/src/googleapis.com/v00.00.00000/services/container.yaml index 06d45379..3e0107b0 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/container.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/container.yaml @@ -9,8 +9,8 @@ info: Builds and manages container-based applications, powered by the open source Kubernetes technology. version: v1 - x-discovery-doc-revision: '20241024' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250812' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/kubernetes-engine/docs/ servers: @@ -75,14 +75,14 @@ components: description: >- The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource - quota](https://cloud.google.com/compute/quotas) is sufficient for - this number of instances. You must also have available firewall and - routes quota. For requests, this field should only be used in lieu - of a "node_pool" object, since this configuration (along with the - "node_config") will be used to create a "NodePool" object with an - auto-generated name. Do not use this and a node_pool at the same - time. This field is deprecated, use node_pool.initial_node_count - instead. + quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) + is sufficient for this number of instances. You must also have + available firewall and routes quota. For requests, this field should + only be used in lieu of a "node_pool" object, since this + configuration (along with the "node_config") will be used to create + a "NodePool" object with an auto-generated name. Do not use this and + a node_pool at the same time. This field is deprecated, use + node_pool.initial_node_count instead. deprecated: true type: integer format: int32 @@ -122,7 +122,7 @@ components: description: >- The monitoring service the cluster should use to write metrics. Currently available options: * - "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring + `monitoring.googleapis.com/kubernetes` - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be @@ -133,7 +133,7 @@ components: network: description: >- The name of the Google Compute Engine - [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) + [network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used. type: string @@ -152,8 +152,8 @@ components: subnetwork: description: >- The name of the Google Compute Engine - [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to - which the cluster is connected. + [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/subnetworks) + to which the cluster is connected. type: string nodePools: description: >- @@ -165,13 +165,13 @@ components: locations: description: >- The list of Google Compute Engine - [zones](https://cloud.google.com/compute/docs/zones#available) in - which the cluster's nodes should be located. This field provides a - default value if - [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) + [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) + in which the cluster's nodes should be located. This field provides + a default value if + [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the - [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) + [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. type: array @@ -186,6 +186,14 @@ components: disabled. Alpha enabled clusters are automatically deleted thirty days after creation. type: boolean + alphaClusterFeatureGates: + description: >- + The list of user specified Kubernetes feature gates. Each string + represents the activation status of a feature gate (e.g. + "featureX=true" or "featureX=false") + type: array + items: + type: string resourceLabels: description: >- The resource labels for the cluster to use to annotate any related @@ -291,8 +299,8 @@ components: zone: description: >- Output only. The name of the Google Compute Engine - [zone](https://cloud.google.com/compute/docs/zones#available) in - which the cluster resides. This field is deprecated, use location + [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) + in which the cluster resides. This field is deprecated, use location instead. readOnly: true deprecated: true @@ -326,7 +334,7 @@ components: currentNodeVersion: description: >- Output only. Deprecated, use - [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) + [NodePools.version](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all @@ -421,22 +429,29 @@ components: location: description: >- Output only. The name of the Google Compute Engine - [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) + [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or - [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) + [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. readOnly: true type: string enableTpu: - description: Enable the ability to use Cloud TPUs in this cluster. + description: >- + Enable the ability to use Cloud TPUs in this cluster. This field is + deprecated due to the deprecation of 2VM TPU. The end of life date + for 2VM TPU is 2025-04-25. + deprecated: true type: boolean tpuIpv4CidrBlock: description: >- Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) - notation (e.g. `1.2.3.4/29`). + notation (e.g. `1.2.3.4/29`). This field is deprecated due to the + deprecation of 2VM TPU. The end of life date for 2VM TPU is + 2025-04-25. readOnly: true + deprecated: true type: string conditions: description: Which conditions caused the current cluster state. @@ -472,6 +487,9 @@ components: Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. $ref: '#/components/schemas/NodePoolAutoConfig' + podAutoscaling: + description: The config for pod autoscaling. + $ref: '#/components/schemas/PodAutoscaling' etag: description: >- This checksum is computed by the server based on the value of @@ -515,6 +533,14 @@ components: RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created. $ref: '#/components/schemas/RBACBindingConfig' + gkeAutoUpgradeConfig: + description: Configuration for GKE auto upgrades. + $ref: '#/components/schemas/GkeAutoUpgradeConfig' + anonymousAuthenticationConfig: + description: >- + Configuration for limiting anonymous access to all endpoints except + the health checks. + $ref: '#/components/schemas/AnonymousAuthenticationConfig' NodeConfig: id: NodeConfig description: >- @@ -526,8 +552,8 @@ components: machineType: description: >- The name of a Google Compute Engine [machine - type](https://cloud.google.com/compute/docs/machine-types) If - unspecified, the default machine type is `e2-medium`. + type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types) + If unspecified, the default machine type is `e2-medium`. type: string diskSizeGb: description: >- @@ -545,8 +571,8 @@ components: persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container - Registry](https://cloud.google.com/container-registry/)). If - unspecified, no scopes are added, unless Cloud Logging or Cloud + Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). + If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. type: array @@ -584,7 +610,7 @@ components: description: >- The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see - https://cloud.google.com/kubernetes-engine/docs/concepts/node-images + https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types. type: string labels: @@ -605,8 +631,8 @@ components: The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: - https://cloud.google.com/compute/docs/disks/local-ssd for more - information. + https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd + for more information. type: integer format: int32 tags: @@ -621,14 +647,14 @@ components: preemptible: description: >- Whether the nodes are created as preemptible VM instances. See: - https://cloud.google.com/compute/docs/instances/preemptible for more - information about preemptible VM instances. + https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible + for more information about preemptible VM instances. type: boolean accelerators: description: >- A list of hardware accelerators to be attached to each node. See - https://cloud.google.com/compute/docs/gpus for more information - about support for GPUs. + https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus + for more information about support for GPUs. type: array items: $ref: '#/components/schemas/AcceleratorConfig' @@ -645,7 +671,7 @@ components: values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU - platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) + platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform) type: string workloadMetadataConfig: description: The workload metadata configuration for this node. @@ -666,13 +692,13 @@ components: Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant - nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). + nodes](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes). type: string reservationAffinity: description: >- The optional reservation affinity. Setting this field will apply the specified [Zonal Compute - Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) + Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool. $ref: '#/components/schemas/ReservationAffinity' shieldedInstanceConfig: @@ -685,7 +711,7 @@ components: description: Node kubelet configs. $ref: '#/components/schemas/NodeKubeletConfig' bootDiskKmsKey: - description: ' The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption' + description: ' The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption' type: string gcfsConfig: description: Google Container File System (image streaming) configs. @@ -759,10 +785,16 @@ components: secondaryBootDiskUpdateStrategy: description: Secondary boot disk update strategy. $ref: '#/components/schemas/SecondaryBootDiskUpdateStrategy' + maxRunDuration: + description: >- + The maximum duration for the nodes to exist. If unspecified, the + nodes can exist indefinitely. + type: string + format: google-duration localSsdEncryptionMode: description: >- Specifies which method should be used for encrypting the Local SSDs - attahced to the node. + attached to the node. type: string enumDescriptions: - >- @@ -804,6 +836,12 @@ components: - EFFECTIVE_CGROUP_MODE_UNSPECIFIED - EFFECTIVE_CGROUP_MODE_V1 - EFFECTIVE_CGROUP_MODE_V2 + flexStart: + description: Flex Start flag for enabling Flex Start VM. + type: boolean + bootDisk: + description: The boot disk configuration for the node pool. + $ref: '#/components/schemas/BootDisk' AcceleratorConfig: id: AcceleratorConfig description: AcceleratorConfig represents a Hardware Accelerator request. @@ -816,7 +854,7 @@ components: acceleratorType: description: >- The accelerator type resource name. List of supported accelerators - [here](https://cloud.google.com/compute/docs/gpus) + [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus) type: string gpuPartitionSize: description: >- @@ -945,7 +983,7 @@ components: ReservationAffinity: id: ReservationAffinity description: >- - [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) + [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. type: object @@ -1007,9 +1045,21 @@ components: The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog - net.core.rmem_max net.core.wmem_default net.core.wmem_max - net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem - net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse + net.core.rmem_max net.core.rmem_default net.core.wmem_default + net.core.wmem_max net.core.optmem_max net.core.somaxconn + net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse + net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max + net.netfilter.nf_conntrack_buckets + net.netfilter.nf_conntrack_tcp_timeout_close_wait + net.netfilter.nf_conntrack_tcp_timeout_time_wait + net.netfilter.nf_conntrack_tcp_timeout_established + net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax + kernel.shmall fs.aio-max-nr fs.file-max + fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open + vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio + vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory + vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness + vm.watermark_scale_factor vm.min_free_kbytes type: object additionalProperties: type: string @@ -1033,6 +1083,70 @@ components: hugepages: description: Optional. Amounts for 2M and 1G hugepages $ref: '#/components/schemas/HugepagesConfig' + transparentHugepageEnabled: + description: >- + Optional. Transparent hugepage support for anonymous memory can be + entirely disabled (mostly for debugging purposes) or only enabled + inside MADV_HUGEPAGE regions (to avoid the risk of consuming more + memory resources) or enabled system wide. See + https://docs.kernel.org/admin-guide/mm/transhuge.html for more + details. + type: string + enumDescriptions: + - Default value. GKE will not modify the kernel configuration. + - >- + Transparent hugepage support for anonymous memory is enabled + system wide. + - >- + Transparent hugepage support for anonymous memory is enabled + inside MADV_HUGEPAGE regions. This is the default kernel + configuration. + - Transparent hugepage support for anonymous memory is disabled. + enum: + - TRANSPARENT_HUGEPAGE_ENABLED_UNSPECIFIED + - TRANSPARENT_HUGEPAGE_ENABLED_ALWAYS + - TRANSPARENT_HUGEPAGE_ENABLED_MADVISE + - TRANSPARENT_HUGEPAGE_ENABLED_NEVER + transparentHugepageDefrag: + description: >- + Optional. Defines the transparent hugepage defrag configuration on + the node. VM hugepage allocation can be managed by either limiting + defragmentation for delayed allocation or skipping it entirely for + immediate allocation only. See + https://docs.kernel.org/admin-guide/mm/transhuge.html for more + details. + type: string + enumDescriptions: + - Default value. GKE will not modify the kernel configuration. + - >- + It means that an application requesting THP will stall on + allocation failure and directly reclaim pages and compact memory + in an effort to allocate a THP immediately. + - >- + It means that an application will wake kswapd in the background to + reclaim pages and wake kcompactd to compact memory so that THP is + available in the near future. It’s the responsibility of + khugepaged to then install the THP pages later. + - >- + It means that an application will enter direct reclaim and + compaction like always, but only for regions that have used + madvise(MADV_HUGEPAGE); all other regions will wake kswapd in the + background to reclaim pages and wake kcompactd to compact memory + so that THP is available in the near future. + - >- + It means that an application will enter direct reclaim like always + but only for regions that are have used madvise(MADV_HUGEPAGE). + This is the default kernel configuration. + - >- + It means that an application will never enter direct reclaim or + compaction. + enum: + - TRANSPARENT_HUGEPAGE_DEFRAG_UNSPECIFIED + - TRANSPARENT_HUGEPAGE_DEFRAG_ALWAYS + - TRANSPARENT_HUGEPAGE_DEFRAG_DEFER + - TRANSPARENT_HUGEPAGE_DEFRAG_DEFER_WITH_MADVISE + - TRANSPARENT_HUGEPAGE_DEFRAG_MADVISE + - TRANSPARENT_HUGEPAGE_DEFRAG_NEVER HugepagesConfig: id: HugepagesConfig description: Hugepages amount in both 2m and 1g size @@ -1061,6 +1175,18 @@ components: affinity and exclusivity on the node. The default value is 'none' if unspecified. type: string + topologyManager: + description: >- + Optional. Controls Topology Manager configuration on the node. For + more information, see: + https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + $ref: '#/components/schemas/TopologyManager' + memoryManager: + description: >- + Optional. Controls NUMA-aware Memory Manager configuration on the + node. For more information, see: + https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/ + $ref: '#/components/schemas/MemoryManager' cpuCfsQuota: description: >- Enable CPU CFS quota enforcement for containers that specify CPU @@ -1093,6 +1219,328 @@ components: insecureKubeletReadonlyPortEnabled: description: Enable or disable Kubelet read only port. type: boolean + imageGcLowThresholdPercent: + description: >- + Optional. Defines the percent of disk usage before which image + garbage collection is never run. Lowest disk usage to garbage + collect to. The percent is calculated as this field value out of + 100. The value must be between 10 and 85, inclusive and smaller than + image_gc_high_threshold_percent. The default value is 80 if + unspecified. + type: integer + format: int32 + imageGcHighThresholdPercent: + description: >- + Optional. Defines the percent of disk usage after which image + garbage collection is always run. The percent is calculated as this + field value out of 100. The value must be between 10 and 85, + inclusive and greater than image_gc_low_threshold_percent. The + default value is 85 if unspecified. + type: integer + format: int32 + imageMinimumGcAge: + description: >- + Optional. Defines the minimum age for an unused image before it is + garbage collected. The string must be a sequence of decimal numbers, + each with optional fraction and a unit suffix, such as "300s", + "1.5h", and "2h45m". Valid time units are "ns", "us" (or "µs"), + "ms", "s", "m", "h". The value must be a positive duration less than + or equal to 2 minutes. The default value is "2m0s" if unspecified. + type: string + imageMaximumGcAge: + description: >- + Optional. Defines the maximum age an image can be unused before it + is garbage collected. The string must be a sequence of decimal + numbers, each with optional fraction and a unit suffix, such as + "300s", "1.5h", and "2h45m". Valid time units are "ns", "us" (or + "µs"), "ms", "s", "m", "h". The value must be a positive duration + greater than image_minimum_gc_age or "0s". The default value is "0s" + if unspecified, which disables this field, meaning images won't be + garbage collected based on being unused for too long. + type: string + containerLogMaxSize: + description: >- + Optional. Defines the maximum size of the container log file before + it is rotated. See + https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation + Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid + units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, + inclusive. Note that the total container log size + (container_log_max_size * container_log_max_files) cannot exceed 1% + of the total storage of the node, to avoid disk pressure caused by + log files. The default value is 10Mi if unspecified. + type: string + containerLogMaxFiles: + description: >- + Optional. Defines the maximum number of container log files that can + be present for a container. See + https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation + The value must be an integer between 2 and 10, inclusive. The + default value is 5 if unspecified. + type: integer + format: int32 + allowedUnsafeSysctls: + description: >- + Optional. Defines a comma-separated allowlist of unsafe sysctls or + sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups + are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and + `net.*`. Leaving this allowlist empty means they cannot be set on + Pods. To allow certain sysctls or sysctl patterns to be set on Pods, + list them separated by commas. For example: + `kernel.msg*,net.ipv4.route.min_pmtu`. See + https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ + for more details. + type: array + items: + type: string + evictionSoft: + description: >- + Optional. eviction_soft is a map of signal names to quantities that + defines soft eviction thresholds. Each signal is compared to its + corresponding threshold to determine if a pod eviction should occur. + $ref: '#/components/schemas/EvictionSignals' + evictionSoftGracePeriod: + description: >- + Optional. eviction_soft_grace_period is a map of signal names to + quantities that defines grace periods for each soft eviction signal. + The grace period is the amount of time that a pod must be under + pressure before an eviction occurs. + $ref: '#/components/schemas/EvictionGracePeriod' + evictionMinimumReclaim: + description: >- + Optional. eviction_minimum_reclaim is a map of signal names to + quantities that defines minimum reclaims, which describe the minimum + amount of a given resource the kubelet will reclaim when performing + a pod eviction while that resource is under pressure. + $ref: '#/components/schemas/EvictionMinimumReclaim' + evictionMaxPodGracePeriodSeconds: + description: >- + Optional. eviction_max_pod_grace_period_seconds is the maximum + allowed grace period (in seconds) to use when terminating pods in + response to a soft eviction threshold being met. This value + effectively caps the Pod's terminationGracePeriodSeconds value + during soft evictions. Default: 0. Range: [0, 300]. + type: integer + format: int32 + maxParallelImagePulls: + description: >- + Optional. Defines the maximum number of image pulls in parallel. The + range is 2 to 5, inclusive. The default value is 2 or 3 depending on + the disk type. See + https://kubernetes.io/docs/concepts/containers/images/#maximum-parallel-image-pulls + for more details. + type: integer + format: int32 + singleProcessOomKill: + description: >- + Optional. Defines whether to enable single process OOM killer. If + true, will prevent the memory.oom.group flag from being set for + container cgroups in cgroups v2. This causes processes in the + container to be OOM killed individually instead of as a group. + type: boolean + TopologyManager: + id: TopologyManager + description: >- + TopologyManager defines the configuration options for Topology Manager + feature. See + https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + type: object + properties: + policy: + description: >- + Configures the strategy for resource alignment. Allowed values are: + * none: the default policy, and does not perform any topology + alignment. * restricted: the topology manager stores the preferred + NUMA node affinity for the container, and will reject the pod if the + affinity if not preferred. * best-effort: the topology manager + stores the preferred NUMA node affinity for the container. If the + affinity is not preferred, the topology manager will admit the pod + to the node anyway. * single-numa-node: the topology manager + determines if the single NUMA node affinity is possible. If it is, + Topology Manager will store this and the Hint Providers can then use + this information when making the resource allocation decision. If, + however, this is not possible then the Topology Manager will reject + the pod from the node. This will result in a pod in a Terminated + state with a pod admission failure. The default policy value is + 'none' if unspecified. Details about each strategy can be found + [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). + type: string + scope: + description: >- + The Topology Manager aligns resources in following scopes: * + container * pod The default scope is 'container' if unspecified. See + https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes + type: string + MemoryManager: + id: MemoryManager + description: >- + The option enables the Kubernetes NUMA-aware Memory Manager feature. + Detailed description about the feature can be found + [here](https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/). + type: object + properties: + policy: + description: >- + Controls the memory management policy on the Node. See + https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies + The following values are allowed. * "none" * "static" The default + value is 'none' if unspecified. + type: string + EvictionSignals: + id: EvictionSignals + description: >- + Eviction signals are the current state of a particular resource at a + specific point in time. The kubelet uses eviction signals to make + eviction decisions by comparing the signals to eviction thresholds, + which are the minimum amount of the resource that should be available on + the node. + type: object + properties: + memoryAvailable: + description: >- + Optional. Memory available (i.e. capacity - workingSet), in bytes. + Defines the amount of "memory.available" signal in kubelet. Default + is unset, if not specified in the kubelet config. Format: positive + number + unit, e.g. 100Ki, 10Mi, 5Gi. Valid units are Ki, Mi, Gi. + Must be >= 100Mi and <= 50% of the node's memory. See + https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals + type: string + nodefsAvailable: + description: >- + Optional. Amount of storage available on filesystem that kubelet + uses for volumes, daemon logs, etc. Defines the amount of + "nodefs.available" signal in kubelet. Default is unset, if not + specified in the kubelet config. It takses percentage value for now. + Sample format: "30%". Must be >= 10% and <= 50%. See + https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals + type: string + nodefsInodesFree: + description: >- + Optional. Amount of inodes available on filesystem that kubelet uses + for volumes, daemon logs, etc. Defines the amount of + "nodefs.inodesFree" signal in kubelet. Default is unset, if not + specified in the kubelet config. Linux only. It takses percentage + value for now. Sample format: "30%". Must be >= 5% and <= 50%. See + https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals + type: string + imagefsAvailable: + description: >- + Optional. Amount of storage available on filesystem that container + runtime uses for storing images layers. If the container filesystem + and image filesystem are not separate, then imagefs can store both + image layers and writeable layers. Defines the amount of + "imagefs.available" signal in kubelet. Default is unset, if not + specified in the kubelet config. It takses percentage value for now. + Sample format: "30%". Must be >= 15% and <= 50%. See + https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals + type: string + imagefsInodesFree: + description: >- + Optional. Amount of inodes available on filesystem that container + runtime uses for storing images layers. Defines the amount of + "imagefs.inodesFree" signal in kubelet. Default is unset, if not + specified in the kubelet config. Linux only. It takses percentage + value for now. Sample format: "30%". Must be >= 5% and <= 50%. See + https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals + type: string + pidAvailable: + description: >- + Optional. Amount of PID available for pod allocation. Defines the + amount of "pid.available" signal in kubelet. Default is unset, if + not specified in the kubelet config. It takses percentage value for + now. Sample format: "30%". Must be >= 10% and <= 50%. See + https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals + type: string + EvictionGracePeriod: + id: EvictionGracePeriod + description: Eviction grace periods are grace periods for each eviction signal. + type: object + properties: + memoryAvailable: + description: >- + Optional. Grace period for eviction due to memory available signal. + Sample format: "10s". Must be >= 0. See + https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals + type: string + nodefsAvailable: + description: >- + Optional. Grace period for eviction due to nodefs available signal. + Sample format: "10s". Must be >= 0. See + https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals + type: string + nodefsInodesFree: + description: >- + Optional. Grace period for eviction due to nodefs inodes free + signal. Sample format: "10s". Must be >= 0. See + https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals + type: string + imagefsAvailable: + description: >- + Optional. Grace period for eviction due to imagefs available signal. + Sample format: "10s". Must be >= 0. See + https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals + type: string + imagefsInodesFree: + description: >- + Optional. Grace period for eviction due to imagefs inodes free + signal. Sample format: "10s". Must be >= 0. See + https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals + type: string + pidAvailable: + description: >- + Optional. Grace period for eviction due to pid available signal. + Sample format: "10s". Must be >= 0. See + https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals + type: string + EvictionMinimumReclaim: + id: EvictionMinimumReclaim + description: >- + Eviction minimum reclaims are the resource amounts of minimum reclaims + for each eviction signal. + type: object + properties: + memoryAvailable: + description: >- + Optional. Minimum reclaim for eviction due to memory available + signal. Only take percentage value for now. Sample format: "10%". + Must be <=10%. See + https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals + type: string + nodefsAvailable: + description: >- + Optional. Minimum reclaim for eviction due to nodefs available + signal. Only take percentage value for now. Sample format: "10%". + Must be <=10%. See + https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals + type: string + nodefsInodesFree: + description: >- + Optional. Minimum reclaim for eviction due to nodefs inodes free + signal. Only take percentage value for now. Sample format: "10%". + Must be <=10%. See + https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals + type: string + imagefsAvailable: + description: >- + Optional. Minimum reclaim for eviction due to imagefs available + signal. Only take percentage value for now. Sample format: "10%". + Must be <=10%. See + https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals + type: string + imagefsInodesFree: + description: >- + Optional. Minimum reclaim for eviction due to imagefs inodes free + signal. Only take percentage value for now. Sample format: "10%". + Must be <=10%. See + https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals + type: string + pidAvailable: + description: >- + Optional. Minimum reclaim for eviction due to pid available signal. + Only take percentage value for now. Sample format: "10%". Must be + <=10%. See + https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals + type: string GcfsConfig: id: GcfsConfig description: >- @@ -1118,6 +1566,21 @@ components: enableNestedVirtualization: description: Whether or not to enable nested virtualization (defaults to false). type: boolean + performanceMonitoringUnit: + description: >- + Type of Performance Monitoring Unit (PMU) requested on node pool + instances. If unset, PMU will not be available to the node. + type: string + enumDescriptions: + - PMU not enabled. + - Architecturally defined non-LLC events. + - Most documented core/L2 events. + - Most documented core/L2 and LLC events. + enum: + - PERFORMANCE_MONITORING_UNIT_UNSPECIFIED + - ARCHITECTURAL + - STANDARD + - ENHANCED VirtualNIC: id: VirtualNIC description: Configuration of gVNIC feature. @@ -1136,6 +1599,19 @@ components: enabled: description: Whether Confidential Nodes feature is enabled. type: boolean + confidentialInstanceType: + description: Defines the type of technology used by the confidential node. + type: string + enumDescriptions: + - No type specified. Do not use this value. + - AMD Secure Encrypted Virtualization. + - AMD Secure Encrypted Virtualization - Secure Nested Paging. + - Intel Trust Domain eXtension. + enum: + - CONFIDENTIAL_INSTANCE_TYPE_UNSPECIFIED + - SEV + - SEV_SNP + - TDX FastSocket: id: FastSocket description: Configuration of Fast Socket feature. @@ -1173,20 +1649,20 @@ components: description: >- Parameters that can be configured on Windows nodes. Windows Node Config that define the parameters that will be used to configure the Windows - node pool settings + node pool settings. type: object properties: osVersion: - description: OSVersion specifies the Windows node config to be used on the node + description: OSVersion specifies the Windows node config to be used on the node. type: string enumDescriptions: - - When OSVersion is not specified + - When OSVersion is not specified. - >- LTSC2019 specifies to use LTSC2019 as the Windows Servercore Base - Image + Image. - >- LTSC2022 specifies to use LTSC2022 as the Windows Servercore Base - Image + Image. enum: - OS_VERSION_UNSPECIFIED - OS_VERSION_LTSC2019 @@ -1202,8 +1678,9 @@ components: description: >- Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per - zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for - more information. A zero (or unset) value has different meanings + zone. See: + https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd + for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 @@ -1212,7 +1689,7 @@ components: that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See - https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds + https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. type: integer format: int32 @@ -1231,17 +1708,22 @@ components: flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per - zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for - more information. 2. For Gen3 machines which dictate a specific + zone. See: + https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd + for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See - https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds + https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. type: integer format: int32 + dataCacheCount: + description: Number of local SSDs to use for GKE Data Cache. + type: integer + format: int32 SoleTenantConfig: id: SoleTenantConfig description: >- @@ -1254,12 +1736,19 @@ components: type: array items: $ref: '#/components/schemas/NodeAffinity' + minNodeCpus: + description: >- + Optional. The minimum number of virtual CPUs this instance will + consume when running on a sole-tenant node. This field can only be + set if the node pool is created in a shared sole-tenant node group. + type: integer + format: int32 NodeAffinity: id: NodeAffinity description: >- Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group - affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). + affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). type: object properties: key: @@ -1316,7 +1805,7 @@ components: fqdns: description: >- List of fully qualified domain names (FQDN). Specifying port is - supported. Wilcards are NOT supported. Examples: - + supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 type: array items: @@ -1328,7 +1817,8 @@ components: id: GCPSecretManagerCertificateConfig description: >- GCPSecretManagerCertificateConfig configures a secret from [Google - Secret Manager](https://cloud.google.com/secret-manager). + Secret + Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). type: object properties: secretUri: @@ -1343,7 +1833,7 @@ components: A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in - https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. + https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. type: object @@ -1386,6 +1876,30 @@ components: disks. type: object properties: {} + BootDisk: + id: BootDisk + description: BootDisk specifies the boot disk configuration for nodepools. + type: object + properties: + diskType: + description: >- + Disk type of the boot disk. (i.e. Hyperdisk-Balanced, PD-Balanced, + etc.) + type: string + sizeGb: + description: Disk size in GB. Replaces NodeConfig.disk_size_gb + type: string + format: int64 + provisionedIops: + description: For Hyperdisk-Balanced only, the provisioned IOPS config value. + type: string + format: int64 + provisionedThroughput: + description: >- + For Hyperdisk-Balanced only, the provisioned throughput config + value. + type: string + format: int64 MasterAuth: id: MasterAuth description: >- @@ -1402,7 +1916,7 @@ components: string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: - https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication + https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication deprecated: true type: string password: @@ -1414,7 +1928,7 @@ components: authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: - https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication + https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication deprecated: true type: string clientCertificateConfig: @@ -1475,7 +1989,7 @@ components: deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: - https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards + https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/dashboards deprecated: true $ref: '#/components/schemas/KubernetesDashboard' networkPolicyConfig: @@ -1518,6 +2032,12 @@ components: rayOperatorConfig: description: Optional. Configuration for Ray Operator addon. $ref: '#/components/schemas/RayOperatorConfig' + highScaleCheckpointingConfig: + description: Configuration for the High Scale Checkpointing add-on. + $ref: '#/components/schemas/HighScaleCheckpointingConfig' + lustreCsiDriverConfig: + description: Configuration for the Lustre CSI driver. + $ref: '#/components/schemas/LustreCsiDriverConfig' HttpLoadBalancing: id: HttpLoadBalancing description: >- @@ -1686,6 +2206,32 @@ components: enabled: description: Enable metrics collection for Ray clusters. type: boolean + HighScaleCheckpointingConfig: + id: HighScaleCheckpointingConfig + description: Configuration for the High Scale Checkpointing. + type: object + properties: + enabled: + description: Whether the High Scale Checkpointing is enabled for this cluster. + type: boolean + LustreCsiDriverConfig: + id: LustreCsiDriverConfig + description: Configuration for the Lustre CSI driver. + type: object + properties: + enabled: + description: Whether the Lustre CSI driver is enabled for this cluster. + type: boolean + enableLegacyLustrePort: + description: >- + If set to true, the Lustre CSI driver will install Lustre kernel + modules using port 6988. This serves as a workaround for a port + conflict with the gke-metadata-server. This field is required ONLY + under the following conditions: 1. The GKE node version is older + than 1.33.2-gke.4655000. 2. You're connecting to a Lustre instance + that has the 'gke-support-enabled' flag. + deprecated: true + type: boolean NodePool: id: NodePool description: >- @@ -1707,18 +2253,18 @@ components: description: >- The initial node count for the pool. You must ensure that your Compute Engine [resource - quota](https://cloud.google.com/compute/quotas) is sufficient for - this number of instances. You must also have available firewall and - routes quota. + quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) + is sufficient for this number of instances. You must also have + available firewall and routes quota. type: integer format: int32 locations: description: >- The list of Google Compute Engine - [zones](https://cloud.google.com/compute/docs/zones#available) in - which the NodePool's nodes should be located. If this value is + [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) + in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the - [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) + [Cluster.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. type: array @@ -1737,12 +2283,12 @@ components: description: >- The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described - [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version). + [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version). type: string instanceGroupUrls: description: >- Output only. The resource URLs of the [managed instance - groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) + groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. readOnly: true @@ -1835,6 +2381,11 @@ components: bestEffortProvisioning: description: Enable best effort provisioning for nodes $ref: '#/components/schemas/BestEffortProvisioning' + autopilotConfig: + description: >- + Specifies the autopilot configuration for this node pool. This field + is exclusively reserved for Cluster Autoscaler. + $ref: '#/components/schemas/AutopilotConfig' NodeNetworkConfig: id: NodeNetworkConfig description: Parameters for node pool-level network config. @@ -1912,6 +2463,22 @@ components: readOnly: true type: number format: double + subnetwork: + description: >- + Output only. The subnetwork path for the node pool. Format: + projects/{project}/regions/{region}/subnetworks/{subnetwork} If the + cluster is associated with multiple subnetworks, the subnetwork for + the node pool is picked based on the IP utilization during node pool + creation and is immutable. + readOnly: true + type: string + networkTierConfig: + description: >- + Output only. The network tier configuration for the node pool + inherits from the cluster-level configuration and remains immutable + throughout the node pool's lifecycle, including during upgrades. + readOnly: true + $ref: '#/components/schemas/NetworkTierConfig' NetworkPerformanceConfig: id: NetworkPerformanceConfig description: Configuration of all network bandwidth tiers @@ -1981,6 +2548,33 @@ components: description: Constraint enforced on the max num of pods per node. type: string format: int64 + NetworkTierConfig: + id: NetworkTierConfig + description: NetworkTierConfig contains network tier information. + type: object + properties: + networkTier: + description: Network tier configuration. + type: string + enumDescriptions: + - >- + By default, use project-level configuration. When unspecified, the + behavior defaults to NETWORK_TIER_DEFAULT. For cluster updates, + this implies no action (no-op). + - >- + Default network tier. Use project-level configuration. User can + specify this value, meaning they want to keep the same behaviour + as before cluster level network tier configuration is introduced. + This field ensures backward compatibility for the network tier of + cluster resources, such as node pools and load balancers, for + their external IP addresses. + - Premium network tier. + - Standard network tier. + enum: + - NETWORK_TIER_UNSPECIFIED + - NETWORK_TIER_DEFAULT + - NETWORK_TIER_PREMIUM + - NETWORK_TIER_STANDARD NodePoolAutoscaling: id: NodePoolAutoscaling description: >- @@ -2109,6 +2703,10 @@ components: Unable to perform an encrypt operation against the CloudKMS key used for etcd level encryption. - Cluster CA is expiring soon. + - Node service account is missing permissions. + - >- + Cloud KMS key version used for etcd level encryption has been + destroyed. This is a permanent error. enum: - UNKNOWN - GCE_STOCKOUT @@ -2117,6 +2715,8 @@ components: - SET_BY_OPERATOR - CLOUD_KMS_KEY_ERROR - CA_EXPIRING + - NODE_SERVICE_ACCOUNT_MISSING_PERMISSIONS + - CLOUD_KMS_KEY_DESTROYED message: description: Human-friendly representation of the condition type: string @@ -2363,7 +2963,7 @@ components: tpuTopology: description: >- Optional. TPU placement topology for pod slice node pool. - https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies + https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies type: string policyName: description: >- @@ -2463,6 +3063,16 @@ components: eventually when stockout issue has been resolved. type: integer format: int32 + AutopilotConfig: + id: AutopilotConfig + description: >- + AutopilotConfig contains configuration of autopilot feature for this + nodepool. + type: object + properties: + enabled: + description: Denotes that nodes belonging to this node pool are Autopilot nodes. + type: boolean LegacyAbac: id: LegacyAbac description: >- @@ -2594,7 +3204,10 @@ components: [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a - specific range to use. + specific range to use. This field is deprecated due to the + deprecation of 2VM TPU. The end of life date for 2VM TPU is + 2025-04-25. + deprecated: true type: string useRoutes: description: >- @@ -2662,6 +3275,28 @@ components: readOnly: true type: number format: double + additionalIpRangesConfigs: + description: >- + Output only. The additional IP ranges that are added to the cluster. + These IP ranges can be used by new node pools to allocate node and + pod IPs automatically. Each AdditionalIPRangesConfig corresponds to + a single subnetwork. Once a range is removed it will not show up in + IPAllocationPolicy. + readOnly: true + type: array + items: + $ref: '#/components/schemas/AdditionalIPRangesConfig' + autoIpamConfig: + description: >- + Optional. AutoIpamConfig contains all information related to Auto + IPAM + $ref: '#/components/schemas/AutoIpamConfig' + networkTierConfig: + description: >- + Cluster-level network tier configuration is used to determine the + default network tier for external IP addresses on cluster resources, + such as node pools and load balancers. + $ref: '#/components/schemas/NetworkTierConfig' AdditionalPodRangesConfig: id: AdditionalPodRangesConfig description: >- @@ -2698,6 +3333,35 @@ components: readOnly: true type: number format: double + AdditionalIPRangesConfig: + id: AdditionalIPRangesConfig + description: >- + AdditionalIPRangesConfig is the configuration for individual additional + subnetwork attached to the cluster + type: object + properties: + subnetwork: + description: >- + Name of the subnetwork. This can be the full path of the subnetwork + or just the name. Example1: my-subnet Example2: + projects/gke-project/regions/us-central1/subnetworks/my-subnet + type: string + podIpv4RangeNames: + description: >- + List of secondary ranges names within this subnetwork that can be + used for pod IPs. Example1: gke-pod-range1 Example2: + gke-pod-range1,gke-pod-range2 + type: array + items: + type: string + AutoIpamConfig: + id: AutoIpamConfig + description: AutoIpamConfig contains all information related to Auto IPAM + type: object + properties: + enabled: + description: The flag that enables Auto IPAM on this cluster + type: boolean MasterAuthorizedNetworksConfig: id: MasterAuthorizedNetworksConfig description: >- @@ -2719,7 +3383,7 @@ components: $ref: '#/components/schemas/CidrBlock' gcpPublicCidrsAccessEnabled: description: >- - Whether master is accessbile via Google Compute Engine Public IP + Whether master is accessible via Google Compute Engine Public IP addresses. type: boolean privateEndpointEnforcementEnabled: @@ -2944,11 +3608,14 @@ components: autoprovisioningLocations: description: >- The list of Google Compute Engine - [zones](https://cloud.google.com/compute/docs/zones#available) in - which the NodePool's nodes can be created by NAP. + [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) + in which the NodePool's nodes can be created by NAP. type: array items: type: string + defaultComputeClassConfig: + description: Default compute class is a configuration for default compute class. + $ref: '#/components/schemas/DefaultComputeClassConfig' ResourceLimit: id: ResourceLimit description: >- @@ -2997,7 +3664,7 @@ components: platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU - platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). + platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field @@ -3027,16 +3694,24 @@ components: projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: - https://cloud.google.com/compute/docs/disks/customer-managed-encryption + https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption type: string imageType: description: >- The image type to use for NAP created node. Please see - https://cloud.google.com/kubernetes-engine/docs/concepts/node-images + https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types. type: string insecureKubeletReadonlyPortEnabled: - description: Enable or disable Kubelet read only port. + description: DEPRECATED. Use NodePoolAutoConfig.NodeKubeletConfig instead. + type: boolean + DefaultComputeClassConfig: + id: DefaultComputeClassConfig + description: DefaultComputeClassConfig defines default compute class configuration. + type: object + properties: + enabled: + description: Enables default compute class. type: boolean NetworkConfig: id: NetworkConfig @@ -3046,7 +3721,7 @@ components: network: description: >- Output only. The relative name of the Google Compute Engine - network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) + [network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network readOnly: true @@ -3054,8 +3729,8 @@ components: subnetwork: description: >- Output only. The relative name of the Google Compute Engine - [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the - cluster is connected. Example: + [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/vpc) + to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet readOnly: true type: string @@ -3085,7 +3760,7 @@ components: - >- Use the eBPF based GKE Dataplane V2 with additional features. See the [GKE Dataplane V2 - documentation](https://cloud.google.com/kubernetes-engine/docs/how-to/dataplane-v2) + documentation](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/dataplane-v2) for more. enum: - DATAPATH_PROVIDER_UNSPECIFIED @@ -3156,6 +3831,9 @@ components: and this field at the same time. To update the default setting, use ClusterUpdate.desired_default_enable_private_nodes type: boolean + disableL4LbFirewallReconciliation: + description: Disable L4 load balancer VPC firewalls to enable firewall policies. + type: boolean DefaultSnatStatus: id: DefaultSnatStatus description: >- @@ -3613,11 +4291,13 @@ components: - Corresponds with UpgradeAvailableEvent. - Corresponds with UpgradeEvent. - Corresponds with SecurityBulletinEvent. + - Corresponds with UpgradeInfoEvent. enum: - EVENT_TYPE_UNSPECIFIED - UPGRADE_AVAILABLE_EVENT - UPGRADE_EVENT - SECURITY_BULLETIN_EVENT + - UPGRADE_INFO_EVENT IdentityServiceConfig: id: IdentityServiceConfig description: >- @@ -3637,18 +4317,48 @@ components: description: Enable Autopilot type: boolean workloadPolicyConfig: - description: Workload policy configuration for Autopilot. + description: >- + WorkloadPolicyConfig is the configuration related to GCW workload + policy $ref: '#/components/schemas/WorkloadPolicyConfig' + privilegedAdmissionConfig: + description: >- + PrivilegedAdmissionConfig is the configuration related to privileged + admission control. + $ref: '#/components/schemas/PrivilegedAdmissionConfig' WorkloadPolicyConfig: id: WorkloadPolicyConfig - description: >- - WorkloadPolicyConfig is the configuration of workload policy for - autopilot clusters. + description: WorkloadPolicyConfig is the configuration related to GCW workload policy type: object properties: allowNetAdmin: description: If true, workloads can use NET_ADMIN capability. type: boolean + autopilotCompatibilityAuditingEnabled: + description: >- + If true, enables the GCW Auditor that audits workloads on standard + clusters. + type: boolean + PrivilegedAdmissionConfig: + id: PrivilegedAdmissionConfig + description: >- + PrivilegedAdmissionConfig stores the list of authorized allowlist paths + for the cluster. + type: object + properties: + allowlistPaths: + description: >- + The customer allowlist Cloud Storage paths for the cluster. These + paths are used with the `--autopilot-privileged-admission` flag to + authorize privileged workloads in Autopilot clusters. Paths can be + GKE-owned, in the format `gke:////`, or customer-owned, in the + format `gs:///`. Wildcards (`*`) are supported to authorize all + allowlists under specific paths or directories. Example: + `gs://my-bucket/*` will authorize all allowlists under the + `my-bucket` bucket. + type: array + items: + type: string ParentProductConfig: id: ParentProductConfig description: >- @@ -3722,6 +4432,7 @@ components: - kube-controller-manager - kcp-sshd - kcp connection logs + - horizontal pod autoscaler decision logs enum: - COMPONENT_UNSPECIFIED - SYSTEM_COMPONENTS @@ -3731,6 +4442,7 @@ components: - CONTROLLER_MANAGER - KCP_SSHD - KCP_CONNECTION + - KCP_HPA MonitoringConfig: id: MonitoringConfig description: MonitoringConfig is cluster monitoring configuration. @@ -3772,6 +4484,7 @@ components: - CADVISOR - KUBELET - NVIDIA Data Center GPU Manager (DCGM) + - JobSet enum: - COMPONENT_UNSPECIFIED - SYSTEM_COMPONENTS @@ -3787,6 +4500,7 @@ components: - CADVISOR - KUBELET - DCGM + - JOBSET ManagedPrometheusConfig: id: ManagedPrometheusConfig description: >- @@ -3797,6 +4511,27 @@ components: enabled: description: Enable Managed Collection. type: boolean + autoMonitoringConfig: + description: GKE Workload Auto-Monitoring Configuration. + $ref: '#/components/schemas/AutoMonitoringConfig' + AutoMonitoringConfig: + id: AutoMonitoringConfig + description: >- + AutoMonitoringConfig defines the configuration for GKE Workload + Auto-Monitoring. + type: object + properties: + scope: + description: Scope for GKE Workload Auto-Monitoring. + type: string + enumDescriptions: + - Not set. + - Auto-Monitoring is enabled for all supported applications. + - Disable Auto-Monitoring. + enum: + - SCOPE_UNSPECIFIED + - ALL + - NONE AdvancedDatapathObservabilityConfig: id: AdvancedDatapathObservabilityConfig description: >- @@ -3864,6 +4599,27 @@ components: type: array items: type: string + PodAutoscaling: + id: PodAutoscaling + description: >- + PodAutoscaling is used for configuration of parameters for workload + autoscaling. + type: object + properties: + hpaProfile: + description: Selected Horizontal Pod Autoscaling profile. + type: string + enumDescriptions: + - HPA_PROFILE_UNSPECIFIED is used when no custom HPA profile is set. + - Customers explicitly opt-out of HPA profiles. + - >- + PERFORMANCE is used when customers opt-in to the performance HPA + profile. In this profile we support a higher number of HPAs per + cluster and faster metrics collection for workload autoscaling. + enum: + - HPA_PROFILE_UNSPECIFIED + - NONE + - PERFORMANCE Fleet: id: Fleet description: Fleet is the fleet configuration for the cluster. @@ -3888,6 +4644,15 @@ components: fleet API. readOnly: true type: boolean + membershipType: + description: The type of the cluster's fleet membership. + type: string + enumDescriptions: + - The MembershipType is not set. + - The membership supports only lightweight compatible features. + enum: + - MEMBERSHIP_TYPE_UNSPECIFIED + - LIGHTWEIGHT SecurityPostureConfig: id: SecurityPostureConfig description: >- @@ -4053,6 +4818,23 @@ components: enabled: description: Enable/Disable Secret Manager Config. type: boolean + rotationConfig: + description: Rotation config for secret manager. + $ref: '#/components/schemas/RotationConfig' + RotationConfig: + id: RotationConfig + description: RotationConfig is config for secret manager auto rotation. + type: object + properties: + enabled: + description: Whether the rotation is enabled. + type: boolean + rotationInterval: + description: >- + The interval between two consecutive rotations. Default rotation + interval is 2 minutes. + type: string + format: google-duration CompliancePostureConfig: id: CompliancePostureConfig description: >- @@ -4155,6 +4937,47 @@ components: Setting this to true will allow any ClusterRoleBinding and RoleBinding with subjects system:authenticated. type: boolean + GkeAutoUpgradeConfig: + id: GkeAutoUpgradeConfig + description: GkeAutoUpgradeConfig is the configuration for GKE auto upgrades. + type: object + properties: + patchMode: + description: >- + PatchMode specifies how auto upgrade patch builds should be + selected. + type: string + enumDescriptions: + - >- + PATCH_MODE_UNSPECIFIED defaults to using the upgrade target from + the channel's patch upgrade targets as the upgrade target for the + version. + - >- + ACCELERATED denotes that the latest patch build in the channel + should be used as the upgrade target for the version. + enum: + - PATCH_MODE_UNSPECIFIED + - ACCELERATED + AnonymousAuthenticationConfig: + id: AnonymousAuthenticationConfig + description: >- + AnonymousAuthenticationConfig defines the settings needed to limit + endpoints that allow anonymous authentication. + type: object + properties: + mode: + description: Defines the mode of limiting anonymous access in the cluster. + type: string + enumDescriptions: + - Default value not specified. + - Anonymous authentication is allowed for all endpoints. + - >- + Anonymous authentication is allowed for only health check + endpoints. + enum: + - MODE_UNSPECIFIED + - ENABLED + - LIMITED CreateClusterRequest: id: CreateClusterRequest description: CreateClusterRequest creates a cluster. @@ -4163,22 +4986,22 @@ components: projectId: description: >- Deprecated. The Google Developers Console [project ID or project - number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). + number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. deprecated: true type: string zone: description: >- Deprecated. The name of the Google Compute Engine - [zone](https://cloud.google.com/compute/docs/zones#available) in - which the cluster resides. This field has been deprecated and + [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced by the parent field. deprecated: true type: string cluster: description: >- Required. A [cluster - resource](https://cloud.google.com/container-engine/reference/rest/v1/projects.locations.clusters) + resource](https://{$universe.dns_names.final_documentation_domain}/container-engine/reference/rest/v1/projects.locations.clusters) $ref: '#/components/schemas/Cluster' parent: description: >- @@ -4199,9 +5022,9 @@ components: zone: description: >- Output only. The name of the Google Compute Engine - [zone](https://cloud.google.com/compute/docs/zones#available) in - which the operation is taking place. This field is deprecated, use - location instead. + [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) + in which the operation is taking place. This field is deprecated, + use location instead. readOnly: true deprecated: true type: string @@ -4225,23 +5048,23 @@ components: The cluster version is being updated. Note that this includes "upgrades" to the same version, which are simply a recreation. This also includes - [auto-upgrades](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-upgrades#upgrading_automatically). + [auto-upgrades](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/cluster-upgrades#upgrading_automatically). For more details, see [documentation on cluster - upgrades](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-upgrades#cluster_upgrades). + upgrades](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/cluster-upgrades#cluster_upgrades). - >- A node pool is being updated. Despite calling this an "upgrade", this includes most forms of updates to node pools. This also includes - [auto-upgrades](https://cloud.google.com/kubernetes-engine/docs/how-to/node-auto-upgrades). + [auto-upgrades](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/node-auto-upgrades). This operation sets the progress field and may be canceled. The upgrade strategy depends on [node pool - configuration](https://cloud.google.com/kubernetes-engine/docs/concepts/node-pool-upgrade-strategies). + configuration](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-pool-upgrade-strategies). The nodes are generally still usable during this operation. - >- A problem has been detected with the control plane and is being repaired. This operation type is initiated by GKE. For more details, see [documentation on - repairs](https://cloud.google.com/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions#repairs). + repairs](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions#repairs). - >- The cluster is being updated. This is a broad category of operations and includes operations that only change metadata as @@ -4252,14 +5075,14 @@ components: the update may not be completely functional until the node pools recreations finish. Node recreations will generally follow [maintenance - policies](https://cloud.google.com/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions). + policies](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions). Some GKE-initiated operations use this type. This includes certain types of auto-upgrades and incident mitigations. - >- A node pool is being created. The node pool should be assumed to be unusable until this operation finishes. In the event of an error, the node pool may be partially created. If enabled, [node - autoprovisioning](https://cloud.google.com/kubernetes-engine/docs/how-to/node-auto-provisioning) + autoprovisioning](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/node-auto-provisioning) may have automatically initiated such operations. - >- The node pool is being deleted. The node pool should be assumed to @@ -4270,7 +5093,7 @@ components: other operations. - >- A problem has been detected with nodes and [they are being - repaired](https://cloud.google.com/kubernetes-engine/docs/how-to/node-auto-repair). + repaired](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/node-auto-repair). This operation type is initiated by GKE, typically automatically. This operation may be concurrent with other operations and there may be multiple repairs occurring on the same node pool. @@ -4289,7 +5112,7 @@ components: preemptively to ensure that the control plane has sufficient resources and is not typically an indication of issues. For more details, see [documentation on - resizes](https://cloud.google.com/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions#repairs). + resizes](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions#repairs). - >- Fleet features of GKE Enterprise are being upgraded. The cluster should be assumed to be blocked for other upgrades until the @@ -4383,9 +5206,9 @@ components: location: description: >- Output only. The name of the Google Compute Engine - [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) + [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or - [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) + [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. readOnly: true type: string @@ -4522,15 +5345,15 @@ components: projectId: description: >- Deprecated. The Google Developers Console [project ID or project - number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). + number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. deprecated: true type: string zone: description: >- Deprecated. The name of the Google Compute Engine - [zone](https://cloud.google.com/compute/docs/zones#available) in - which the cluster resides. This field has been deprecated and + [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced by the name field. deprecated: true type: string @@ -4571,7 +5394,7 @@ components: description: >- The monitoring service the cluster should use to write metrics. Currently available options: * - "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring + `monitoring.googleapis.com/kubernetes` - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be @@ -4628,9 +5451,9 @@ components: desiredLocations: description: >- The desired list of Google Compute Engine - [zones](https://cloud.google.com/compute/docs/zones#available) in - which the cluster's nodes should be located. This list must always - include the cluster's primary zone. Warning: changing cluster + [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) + in which the cluster's nodes should be located. This list must + always include the cluster's primary zone. Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed. type: array @@ -4703,7 +5526,7 @@ components: - >- Use the eBPF based GKE Dataplane V2 with additional features. See the [GKE Dataplane V2 - documentation](https://cloud.google.com/kubernetes-engine/docs/how-to/dataplane-v2) + documentation](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/dataplane-v2) for more. enum: - DATAPATH_PROVIDER_UNSPECIFIED @@ -4784,6 +5607,9 @@ components: pools in autopilot clusters and node auto-provisioning enabled clusters. $ref: '#/components/schemas/NetworkTags' + desiredPodAutoscaling: + description: The desired config for pod autoscaling. + $ref: '#/components/schemas/PodAutoscaling' desiredGatewayApiConfig: description: The desired config of Gateway API on this cluster. $ref: '#/components/schemas/GatewayAPIConfig' @@ -4841,7 +5667,9 @@ components: description: Enable/Disable FQDN Network Policy for the cluster. type: boolean desiredAutopilotWorkloadPolicyConfig: - description: The desired workload policy configuration for the autopilot cluster. + description: >- + WorkloadPolicyConfig is the configuration related to GCW workload + policy $ref: '#/components/schemas/WorkloadPolicyConfig' desiredK8sBetaApis: description: Desired Beta APIs to be enabled for cluster. @@ -4891,22 +5719,51 @@ components: in autopilot clusters and node auto-provisioning enabled clusters. $ref: '#/components/schemas/NodeKubeletConfig' userManagedKeysConfig: - description: The Custom keys configuration for the cluster. + description: >- + The Custom keys configuration for the cluster. This field is + deprecated. Use ClusterUpdate.desired_user_managed_keys_config + instead. + deprecated: true $ref: '#/components/schemas/UserManagedKeysConfig' desiredRbacBindingConfig: description: >- RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created. $ref: '#/components/schemas/RBACBindingConfig' + desiredAdditionalIpRangesConfig: + description: >- + The desired config for additional subnetworks attached to the + cluster. + $ref: '#/components/schemas/DesiredAdditionalIPRangesConfig' desiredEnterpriseConfig: description: The desired enterprise configuration for the cluster. $ref: '#/components/schemas/DesiredEnterpriseConfig' + desiredAutoIpamConfig: + description: AutoIpamConfig contains all information related to Auto IPAM + $ref: '#/components/schemas/AutoIpamConfig' + desiredDisableL4LbFirewallReconciliation: + description: Enable/Disable L4 LB VPC firewall reconciliation for the cluster. + type: boolean desiredNodePoolAutoConfigLinuxNodeConfig: description: >- The desired Linux node config for all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. Currently only `cgroup_mode` can be set here. $ref: '#/components/schemas/LinuxNodeConfig' + desiredUserManagedKeysConfig: + description: The desired user managed keys config for the cluster. + $ref: '#/components/schemas/UserManagedKeysConfig' + desiredAnonymousAuthenticationConfig: + description: >- + Configuration for limiting anonymous access to all endpoints except + the health checks. + $ref: '#/components/schemas/AnonymousAuthenticationConfig' + gkeAutoUpgradeConfig: + description: Configuration for GKE auto upgrade. + $ref: '#/components/schemas/GkeAutoUpgradeConfig' + desiredNetworkTierConfig: + description: The desired network tier configuration for the cluster. + $ref: '#/components/schemas/NetworkTierConfig' IntraNodeVisibilityConfig: id: IntraNodeVisibilityConfig description: >- @@ -4927,14 +5784,28 @@ components: enabled: description: Enables l4 ILB subsetting for this cluster. type: boolean - DesiredEnterpriseConfig: - id: DesiredEnterpriseConfig + DesiredAdditionalIPRangesConfig: + id: DesiredAdditionalIPRangesConfig description: >- - DesiredEnterpriseConfig is a wrapper used for updating - enterprise_config. + DesiredAdditionalIPRangesConfig is a wrapper used for cluster update + operation and contains multiple AdditionalIPRangesConfigs. type: object properties: - desiredTier: + additionalIpRangesConfigs: + description: >- + List of additional IP ranges configs where each + AdditionalIPRangesConfig corresponds to one subnetwork's IP ranges + type: array + items: + $ref: '#/components/schemas/AdditionalIPRangesConfig' + DesiredEnterpriseConfig: + id: DesiredEnterpriseConfig + description: >- + DesiredEnterpriseConfig is a wrapper used for updating + enterprise_config. + type: object + properties: + desiredTier: description: desired_tier specifies the desired tier of the cluster. type: string enumDescriptions: @@ -4953,15 +5824,15 @@ components: projectId: description: >- Deprecated. The Google Developers Console [project ID or project - number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). + number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. deprecated: true type: string zone: description: >- Deprecated. The name of the Google Compute Engine - [zone](https://cloud.google.com/compute/docs/zones#available) in - which the cluster resides. This field has been deprecated and + [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced by the name field. deprecated: true type: string @@ -4991,7 +5862,7 @@ components: imageType: description: >- Required. The desired image type for the node pool. Please see - https://cloud.google.com/kubernetes-engine/docs/concepts/node-images + https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types. type: string name: @@ -5003,8 +5874,8 @@ components: locations: description: >- The desired list of Google Compute Engine - [zones](https://cloud.google.com/compute/docs/zones#available) in - which the node pool's nodes should be located. Changing the + [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) + in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed. @@ -5081,17 +5952,17 @@ components: accelerators: description: >- A list of hardware accelerators to be attached to each node. See - https://cloud.google.com/compute/docs/gpus for more information - about support for GPUs. + https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus + for more information about support for GPUs. type: array items: $ref: '#/components/schemas/AcceleratorConfig' machineType: description: >- Optional. The desired [Google Compute Engine machine - type](https://cloud.google.com/compute/docs/machine-types) for nodes - in the node pool. Initiates an upgrade operation that migrates the - nodes in the node pool to the specified machine type. + type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types) + for nodes in the node pool. Initiates an upgrade operation that + migrates the nodes in the node pool to the specified machine type. type: string diskType: description: >- @@ -5129,6 +6000,21 @@ components: type: array items: type: string + maxRunDuration: + description: >- + The maximum duration for the nodes to exist. If unspecified, the + nodes can exist indefinitely. + type: string + format: google-duration + flexStart: + description: Flex Start flag for enabling Flex Start VM. + type: boolean + bootDisk: + description: >- + The desired boot disk config for nodes in the node pool. Initiates + an upgrade operation that migrates the nodes in the node pool to the + specified boot disk config. + $ref: '#/components/schemas/BootDisk' NodeTaints: id: NodeTaints description: >- @@ -5157,7 +6043,7 @@ components: id: ResourceLabels description: >- Collection of [GCP - labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels). + labels](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-labels). type: object properties: labels: @@ -5175,15 +6061,15 @@ components: projectId: description: >- Deprecated. The Google Developers Console [project ID or project - number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). + number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. deprecated: true type: string zone: description: >- Deprecated. The name of the Google Compute Engine - [zone](https://cloud.google.com/compute/docs/zones#available) in - which the cluster resides. This field has been deprecated and + [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced by the name field. deprecated: true type: string @@ -5216,15 +6102,15 @@ components: projectId: description: >- Deprecated. The Google Developers Console [project ID or project - number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). + number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. deprecated: true type: string zone: description: >- Deprecated. The name of the Google Compute Engine - [zone](https://cloud.google.com/compute/docs/zones#available) in - which the cluster resides. This field has been deprecated and + [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced by the name field. deprecated: true type: string @@ -5258,15 +6144,15 @@ components: projectId: description: >- Deprecated. The Google Developers Console [project ID or project - number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). + number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. deprecated: true type: string zone: description: >- Deprecated. The name of the Google Compute Engine - [zone](https://cloud.google.com/compute/docs/zones#available) in - which the cluster resides. This field has been deprecated and + [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced by the name field. deprecated: true type: string @@ -5280,7 +6166,7 @@ components: description: >- Required. The monitoring service the cluster should use to write metrics. Currently available options: * - "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring + `monitoring.googleapis.com/kubernetes` - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be @@ -5302,15 +6188,15 @@ components: projectId: description: >- Deprecated. The Google Developers Console [project ID or project - number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). + number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. deprecated: true type: string zone: description: >- Deprecated. The name of the Google Compute Engine - [zone](https://cloud.google.com/compute/docs/zones#available) in - which the cluster resides. This field has been deprecated and + [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced by the name field. deprecated: true type: string @@ -5338,15 +6224,15 @@ components: projectId: description: >- Deprecated. The Google Developers Console [project ID or project - number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). + number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. deprecated: true type: string zone: description: >- Deprecated. The name of the Google Compute Engine - [zone](https://cloud.google.com/compute/docs/zones#available) in - which the cluster resides. This field has been deprecated and + [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced by the name field. deprecated: true type: string @@ -5359,11 +6245,12 @@ components: locations: description: >- Required. The desired list of Google Compute Engine - [zones](https://cloud.google.com/compute/docs/zones#available) in - which the cluster's nodes should be located. Changing the locations - a cluster is in will result in nodes being either created or removed - from the cluster, depending on whether locations are being added or - removed. This list must always include the cluster's primary zone. + [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) + in which the cluster's nodes should be located. Changing the + locations a cluster is in will result in nodes being either created + or removed from the cluster, depending on whether locations are + being added or removed. This list must always include the cluster's + primary zone. type: array items: type: string @@ -5381,15 +6268,15 @@ components: projectId: description: >- Deprecated. The Google Developers Console [project ID or project - number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). + number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. deprecated: true type: string zone: description: >- Deprecated. The name of the Google Compute Engine - [zone](https://cloud.google.com/compute/docs/zones#available) in - which the cluster resides. This field has been deprecated and + [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced by the name field. deprecated: true type: string @@ -5423,15 +6310,15 @@ components: projectId: description: >- Deprecated. The Google Developers Console [project ID or project - number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). + number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. deprecated: true type: string zone: description: >- Deprecated. The name of the Google Compute Engine - [zone](https://cloud.google.com/compute/docs/zones#available) in - which the cluster resides. This field has been deprecated and + [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced by the name field. deprecated: true type: string @@ -5491,15 +6378,15 @@ components: projectId: description: >- Deprecated. The Google Developers Console [project ID or project - number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). + number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. deprecated: true type: string zone: description: >- Deprecated. The name of the Google Compute Engine - [zone](https://cloud.google.com/compute/docs/zones#available) in - which the operation resides. This field has been deprecated and + [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) + in which the operation resides. This field has been deprecated and replaced by the name field. deprecated: true type: string @@ -5659,7 +6546,7 @@ components: GetJSONWebKeysResponse: id: GetJSONWebKeysResponse description: >- - GetJSONWebKeysResponse is a valid JSON Web Key Set as specififed in rfc + GetJSONWebKeysResponse is a valid JSON Web Key Set as specified in rfc 7517 type: object properties: @@ -5725,15 +6612,15 @@ components: projectId: description: >- Deprecated. The Google Developers Console [project ID or project - number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). + number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. deprecated: true type: string zone: description: >- Deprecated. The name of the Google Compute Engine - [zone](https://cloud.google.com/compute/docs/zones#available) in - which the cluster resides. This field has been deprecated and + [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced by the parent field. deprecated: true type: string @@ -5770,15 +6657,15 @@ components: projectId: description: >- Deprecated. The Google Developers Console [project ID or project - number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). + number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. deprecated: true type: string zone: description: >- Deprecated. The name of the Google Compute Engine - [zone](https://cloud.google.com/compute/docs/zones#available) in - which the cluster resides. This field has been deprecated and + [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced by the name field. deprecated: true type: string @@ -5815,15 +6702,15 @@ components: projectId: description: >- Deprecated. The Google Developers Console [project ID or project - number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). + number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. deprecated: true type: string zone: description: >- Deprecated. The name of the Google Compute Engine - [zone](https://cloud.google.com/compute/docs/zones#available) in - which the cluster resides. This field has been deprecated and + [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced by the name field. deprecated: true type: string @@ -5859,15 +6746,15 @@ components: projectId: description: >- Deprecated. The Google Developers Console [project ID or project - number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). + number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. deprecated: true type: string zone: description: >- Deprecated. The name of the Google Compute Engine - [zone](https://cloud.google.com/compute/docs/zones#available) in - which the cluster resides. This field has been deprecated and + [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced by the name field. deprecated: true type: string @@ -5906,15 +6793,15 @@ components: projectId: description: >- Deprecated. The Google Developers Console [project ID or project - number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). + number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. deprecated: true type: string zone: description: >- Deprecated. The name of the Google Compute Engine - [zone](https://cloud.google.com/compute/docs/zones#available) in - which the cluster resides. This field has been deprecated and + [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced by the name field. deprecated: true type: string @@ -5943,15 +6830,15 @@ components: projectId: description: >- Deprecated. The Google Developers Console [project ID or project - number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). + number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. deprecated: true type: string zone: description: >- Deprecated. The name of the Google Compute Engine - [zone](https://cloud.google.com/compute/docs/zones#available) in - which the cluster resides. This field has been deprecated and + [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced by the name field. deprecated: true type: string @@ -5980,15 +6867,15 @@ components: projectId: description: >- Deprecated. The Google Developers Console [project ID or project - number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). + number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. deprecated: true type: string zone: description: >- Deprecated. The name of the Google Compute Engine - [zone](https://cloud.google.com/compute/docs/zones#available) in - which the cluster resides. This field has been deprecated and + [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced by the name field. deprecated: true type: string @@ -6012,15 +6899,15 @@ components: projectId: description: >- Deprecated. The Google Developers Console [project ID or project - number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). + number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. deprecated: true type: string zone: description: >- Deprecated. The name of the Google Compute Engine - [zone](https://cloud.google.com/compute/docs/zones#available) in - which the cluster resides. This field has been deprecated and + [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced by the name field. deprecated: true type: string @@ -6054,15 +6941,15 @@ components: projectId: description: >- Deprecated. The Google Developers Console [project ID or project - number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). + number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. deprecated: true type: string zone: description: >- Deprecated. The name of the Google Compute Engine - [zone](https://cloud.google.com/compute/docs/zones#available) in - which the cluster resides. This field has been deprecated and + [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) + in which the cluster resides. This field has been deprecated and replaced by the name field. deprecated: true type: string @@ -6089,13 +6976,13 @@ components: projectId: description: >- Required. The Google Developers Console [project ID or project - number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). + number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). type: string zone: description: >- Required. The name of the Google Compute Engine - [zone](https://cloud.google.com/compute/docs/zones#available) in - which the cluster resides. + [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) + in which the cluster resides. type: string clusterId: description: Required. The name of the cluster to update. @@ -6260,12 +7147,208 @@ components: type: string documentationUrl: description: >- - A URL to a public documnetation, which addresses resolving this + A URL to a public documentation, which addresses resolving this issue. type: string description: description: The description of the issue. type: string + ClusterUpgradeInfo: + id: ClusterUpgradeInfo + description: ClusterUpgradeInfo contains the upgrade information of a cluster. + type: object + properties: + minorTargetVersion: + description: minor_target_version indicates the target version for minor upgrade. + type: string + patchTargetVersion: + description: patch_target_version indicates the target version for patch upgrade. + type: string + autoUpgradeStatus: + description: The auto upgrade status. + type: array + items: + type: string + enumDescriptions: + - UNKNOWN indicates an unknown status. + - ACTIVE indicates an active status. + - >- + MINOR_UPGRADE_PAUSED indicates the minor version upgrade is + paused. + - UPGRADE_PAUSED indicates the upgrade is paused. + enum: + - UNKNOWN + - ACTIVE + - MINOR_UPGRADE_PAUSED + - UPGRADE_PAUSED + pausedReason: + description: The auto upgrade paused reason. + type: array + items: + type: string + enumDescriptions: + - >- + AUTO_UPGRADE_PAUSED_REASON_UNSPECIFIED indicates an unspecified + reason. + - >- + MAINTENANCE_WINDOW indicates the cluster is outside customer + maintenance window. + - >- + MAINTENANCE_EXCLUSION_NO_UPGRADES indicates the cluster is in a + maintenance exclusion with scope NO_UPGRADES. + - >- + MAINTENANCE_EXCLUSION_NO_MINOR_UPGRADES indicates the cluster is + in a maintenance exclusion with scope NO_MINOR_UPGRADES. + - >- + CLUSTER_DISRUPTION_BUDGET indicates the cluster is outside the + cluster disruption budget. + - >- + CLUSTER_DISRUPTION_BUDGET_MINOR_UPGRADE indicates the cluster is + outside the cluster disruption budget for minor version upgrade. + - >- + SYSTEM_CONFIG indicates the cluster upgrade is paused by system + config. + enum: + - AUTO_UPGRADE_PAUSED_REASON_UNSPECIFIED + - MAINTENANCE_WINDOW + - MAINTENANCE_EXCLUSION_NO_UPGRADES + - MAINTENANCE_EXCLUSION_NO_MINOR_UPGRADES + - CLUSTER_DISRUPTION_BUDGET + - CLUSTER_DISRUPTION_BUDGET_MINOR_UPGRADE + - SYSTEM_CONFIG + upgradeDetails: + description: The list of past auto upgrades. + type: array + items: + $ref: '#/components/schemas/UpgradeDetails' + endOfStandardSupportTimestamp: + description: >- + The cluster's current minor version's end of standard support + timestamp. + type: string + endOfExtendedSupportTimestamp: + description: >- + The cluster's current minor version's end of extended support + timestamp. + type: string + UpgradeDetails: + id: UpgradeDetails + description: >- + UpgradeDetails contains detailed information of each individual upgrade + operation. + type: object + properties: + state: + description: Output only. The state of the upgrade. + readOnly: true + type: string + enumDescriptions: + - Upgrade state is unknown. + - Upgrade has failed with an error. + - Upgrade has succeeded. + - Upgrade has been canceled. + - Upgrade is running. + enum: + - UNKNOWN + - FAILED + - SUCCEEDED + - CANCELED + - RUNNING + startTime: + description: The start timestamp of the upgrade. + type: string + format: google-datetime + endTime: + description: The end timestamp of the upgrade. + type: string + format: google-datetime + initialVersion: + description: The version before the upgrade. + type: string + targetVersion: + description: The version after the upgrade. + type: string + startType: + description: The start type of the upgrade. + type: string + enumDescriptions: + - Upgrade start type is unspecified. + - Upgrade started automatically. + - Upgrade started manually. + enum: + - START_TYPE_UNSPECIFIED + - AUTOMATIC + - MANUAL + NodePoolUpgradeInfo: + id: NodePoolUpgradeInfo + description: NodePoolUpgradeInfo contains the upgrade information of a nodepool. + type: object + properties: + minorTargetVersion: + description: minor_target_version indicates the target version for minor upgrade. + type: string + patchTargetVersion: + description: patch_target_version indicates the target version for patch upgrade. + type: string + autoUpgradeStatus: + description: The auto upgrade status. + type: array + items: + type: string + enumDescriptions: + - UNKNOWN indicates an unknown status. + - ACTIVE indicates an active status. + - >- + MINOR_UPGRADE_PAUSED indicates the minor version upgrade is + paused. + - UPGRADE_PAUSED indicates the upgrade is paused. + enum: + - UNKNOWN + - ACTIVE + - MINOR_UPGRADE_PAUSED + - UPGRADE_PAUSED + pausedReason: + description: The auto upgrade paused reason. + type: array + items: + type: string + enumDescriptions: + - >- + AUTO_UPGRADE_PAUSED_REASON_UNSPECIFIED indicates an unspecified + reason. + - >- + MAINTENANCE_WINDOW indicates the cluster is outside customer + maintenance window. + - >- + MAINTENANCE_EXCLUSION_NO_UPGRADES indicates the cluster is in a + maintenance exclusion with scope NO_UPGRADES. + - >- + MAINTENANCE_EXCLUSION_NO_MINOR_UPGRADES indicates the cluster is + in a maintenance exclusion with scope NO_MINOR_UPGRADES. + - >- + SYSTEM_CONFIG indicates the cluster upgrade is paused by system + config. + enum: + - AUTO_UPGRADE_PAUSED_REASON_UNSPECIFIED + - MAINTENANCE_WINDOW + - MAINTENANCE_EXCLUSION_NO_UPGRADES + - MAINTENANCE_EXCLUSION_NO_MINOR_UPGRADES + - SYSTEM_CONFIG + upgradeDetails: + description: The list of past auto upgrades. + type: array + items: + $ref: '#/components/schemas/UpgradeDetails' + endOfStandardSupportTimestamp: + description: >- + The nodepool's current minor version's end of standard support + timestamp. + type: string + endOfExtendedSupportTimestamp: + description: >- + The nodepool's current minor version's end of extended support + timestamp. + type: string UpgradeEvent: id: UpgradeEvent description: >- @@ -6358,9 +7441,38 @@ components: - SUCCEEDED - FAILED - CANCELED + standardSupportEndTime: + description: The end of standard support timestamp. + type: string + format: google-datetime + extendedSupportEndTime: + description: The end of extended support timestamp. + type: string + format: google-datetime description: description: A brief description of the event. type: string + eventType: + description: The type of the event. + type: string + enumDescriptions: + - EVENT_TYPE_UNSPECIFIED indicates the event type is unspecified. + - >- + END_OF_SUPPORT indicates GKE version reaches end of support, check + standard_support_end_time and extended_support_end_time for more + details. + - >- + COS_MILESTONE_VERSION_UPDATE indicates that the COS node image + will update COS milestone version for new patch versions starting + with the one in the description. + - >- + UPGRADE_LIFECYCLE indicates the event is about the upgrade + lifecycle. + enum: + - EVENT_TYPE_UNSPECIFIED + - END_OF_SUPPORT + - COS_MILESTONE_VERSION_UPDATE + - UPGRADE_LIFECYCLE UpgradeAvailableEvent: id: UpgradeAvailableEvent description: >- @@ -6448,6 +7560,11 @@ components: If this field is specified, it means there are manual steps that the user must take to make their clusters safe. type: boolean + mitigatedVersions: + description: The GKE versions where this vulnerability is mitigated. + type: array + items: + type: string parameters: access_token: description: OAuth access token. @@ -6618,6 +7735,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + projects_locations_clusters_update_master: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clusters~1{clustersId}:updateMaster/post + response: + mediaType: application/json + openAPIDocKey: '200' projects_locations_clusters_set_master_auth: operation: $ref: >- @@ -6721,6 +7845,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + projects_zones_clusters_addons: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectId}~1zones~1{zone}~1clusters~1{clusterId}~1addons/post + response: + mediaType: application/json + openAPIDocKey: '200' projects_zones_clusters_locations: operation: $ref: >- @@ -6810,42 +7941,51 @@ components: #/components/x-stackQL-resources/clusters/methods/projects_locations_clusters_delete - $ref: >- #/components/x-stackQL-resources/clusters/methods/projects_zones_clusters_delete - clusters_master: - id: google.container.clusters_master - name: clusters_master - title: Clusters_master + clusters_jwks: + id: google.container.clusters_jwks + name: clusters_jwks + title: Clusters_jwks methods: - projects_locations_clusters_update_master: + projects_locations_clusters_get_jwks: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clusters~1{clustersId}:updateMaster/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clusters~1{clustersId}~1jwks/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] - insert: [] - update: + select: - $ref: >- - #/components/x-stackQL-resources/clusters_master/methods/projects_locations_clusters_update_master + #/components/x-stackQL-resources/clusters_jwks/methods/projects_locations_clusters_get_jwks + insert: [] + update: [] replace: [] delete: [] - clusters_jwks: - id: google.container.clusters_jwks - name: clusters_jwks - title: Clusters_jwks + cluster_upgrade_info: + id: google.container.cluster_upgrade_info + name: cluster_upgrade_info + title: Cluster_upgrade_info methods: - projects_locations_clusters_get_jwks: + projects_locations_clusters_fetch_cluster_upgrade_info: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clusters~1{clustersId}~1jwks/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clusters~1{clustersId}:fetchClusterUpgradeInfo/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_zones_clusters_fetch_cluster_upgrade_info: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1zones~1{zonesId}~1clusters~1{clustersId}:fetchClusterUpgradeInfo/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/clusters_jwks/methods/projects_locations_clusters_get_jwks + #/components/x-stackQL-resources/cluster_upgrade_info/methods/projects_locations_clusters_fetch_cluster_upgrade_info + - $ref: >- + #/components/x-stackQL-resources/cluster_upgrade_info/methods/projects_zones_clusters_fetch_cluster_upgrade_info insert: [] update: [] replace: [] @@ -7014,6 +8154,35 @@ components: #/components/x-stackQL-resources/node_pools/methods/projects_locations_clusters_node_pools_delete - $ref: >- #/components/x-stackQL-resources/node_pools/methods/projects_zones_clusters_node_pools_delete + node_pool_upgrade_info: + id: google.container.node_pool_upgrade_info + name: node_pool_upgrade_info + title: Node_pool_upgrade_info + methods: + projects_locations_clusters_node_pools_fetch_node_pool_upgrade_info: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clusters~1{clustersId}~1nodePools~1{nodePoolsId}:fetchNodePoolUpgradeInfo/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_zones_clusters_node_pools_fetch_node_pool_upgrade_info: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1zones~1{zonesId}~1clusters~1{clustersId}~1nodePools~1{nodePoolsId}:fetchNodePoolUpgradeInfo/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/node_pool_upgrade_info/methods/projects_locations_clusters_node_pools_fetch_node_pool_upgrade_info + - $ref: >- + #/components/x-stackQL-resources/node_pool_upgrade_info/methods/projects_zones_clusters_node_pools_fetch_node_pool_upgrade_info + insert: [] + update: [] + replace: [] + delete: [] well_known_openid_configuration: id: google.container.well_known_openid_configuration name: well_known_openid_configuration @@ -7114,26 +8283,6 @@ components: update: [] replace: [] delete: [] - clusters_ons: - id: google.container.clusters_ons - name: clusters_ons - title: Clusters_ons - methods: - projects_zones_clusters_addons: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectId}~1zones~1{zone}~1clusters~1{clusterId}~1addons/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: >- - #/components/x-stackQL-resources/clusters_ons/methods/projects_zones_clusters_addons - update: [] - replace: [] - delete: [] usable_subnetworks: id: google.container.usable_subnetworks name: usable_subnetworks @@ -7246,7 +8395,7 @@ paths: Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default - network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). + network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an @@ -7529,7 +8678,7 @@ paths: post: description: >- Sets the locations for a specific cluster. Deprecated. Use - [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) + [projects.locations.clusters.update](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) instead. operationId: container.projects.locations.clusters.setLocations requestBody: @@ -7938,6 +9087,43 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:fetchClusterUpgradeInfo: + parameters: *ref_1 + get: + description: Fetch upgrade information of a specific cluster. + operationId: container.projects.locations.clusters.fetchClusterUpgradeInfo + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ClusterUpgradeInfo' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + - in: query + name: version + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}: parameters: *ref_1 put: @@ -8388,6 +9574,48 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:fetchNodePoolUpgradeInfo: + parameters: *ref_1 + get: + description: Fetch upgrade information of a specific nodepool. + operationId: container.projects.locations.clusters.nodePools.fetchNodePoolUpgradeInfo + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/NodePoolUpgradeInfo' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + - in: path + name: nodePoolsId + required: true + schema: + type: string + - in: query + name: version + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/.well-known/openid-configuration: parameters: *ref_1 get: @@ -8611,7 +9839,7 @@ paths: Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default - network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). + network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an @@ -8878,7 +10106,7 @@ paths: post: description: >- Sets the locations for a specific cluster. Deprecated. Use - [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) + [projects.locations.clusters.update](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) instead. operationId: container.projects.zones.clusters.locations requestBody: @@ -9221,6 +10449,43 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/zones/{zonesId}/clusters/{clustersId}:fetchClusterUpgradeInfo: + parameters: *ref_1 + get: + description: Fetch upgrade information of a specific cluster. + operationId: container.projects.zones.clusters.fetchClusterUpgradeInfo + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ClusterUpgradeInfo' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: zonesId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + - in: query + name: version + schema: + type: string /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/update: parameters: *ref_1 post: @@ -9596,6 +10861,48 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/zones/{zonesId}/clusters/{clustersId}/nodePools/{nodePoolsId}:fetchNodePoolUpgradeInfo: + parameters: *ref_1 + get: + description: Fetch upgrade information of a specific nodepool. + operationId: container.projects.zones.clusters.nodePools.fetchNodePoolUpgradeInfo + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/NodePoolUpgradeInfo' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: zonesId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + - in: path + name: nodePoolsId + required: true + schema: + type: string + - in: query + name: version + schema: + type: string /v1/projects/{projectId}/zones/{zone}/operations: parameters: *ref_1 get: diff --git a/providers/src/googleapis.com/v00.00.00000/services/containeranalysis.yaml b/providers/src/googleapis.com/v00.00.00000/services/containeranalysis.yaml index cd26f7c1..63f5a026 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/containeranalysis.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/containeranalysis.yaml @@ -7,13 +7,12 @@ info: title: Container Analysis API description: >- This API is a prerequisite for leveraging Artifact Analysis scanning - capabilities in both Artifact Registry and with Advanced Vulnerability - Insights (runtime scanning) in GKE. In addition, the Container Analysis API + capabilities in Artifact Registry. In addition, the Container Analysis API is an implementation of the Grafeas API, which enables storing, querying, and retrieval of critical metadata about all of your software artifacts. version: v1 - x-discovery-doc-revision: '20241025' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250813' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/container-analysis/api/reference/rest/ servers: @@ -39,120 +38,132 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - Digest: - id: Digest - description: Digest information. + Occurrence: + id: Occurrence + description: An instance of an analysis type that has been found on a resource. + type: object properties: - algo: + name: + description: >- + Output only. The name of the occurrence in the form of + `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. type: string - description: '`SHA1`, `SHA512` etc.' - digestBytes: - format: byte - description: Value of the digest. + resourceUri: + description: >- + Required. Immutable. A URI that represents the resource for which + the occurrence applies. For example, + `https://gcr.io/project/image@sha256:123abc` for a Docker image. type: string - type: object - TestIamPermissionsRequest: - properties: - permissions: - items: - type: string - type: array + noteName: description: >- - The set of permissions to check for the `resource`. Permissions with - wildcards (such as `*` or `storage.*`) are not allowed. For more - information see [IAM - Overview](https://cloud.google.com/iam/docs/overview#permissions). - id: TestIamPermissionsRequest - description: Request message for `TestIamPermissions` method. - type: object - UpgradeNote: - type: object - id: UpgradeNote - properties: - package: + Required. Immutable. The analysis note associated with this + occurrence, in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. + This field can be used as a filter in list requests. type: string - description: Required for non-Windows OS. The package this Upgrade is for. - windowsUpdate: - $ref: '#/components/schemas/WindowsUpdate' + kind: description: >- - Required for Windows OS. Represents the metadata about the Windows - update. - version: - $ref: '#/components/schemas/Version' + Output only. This explicitly denotes which of the occurrence details + are specified. This field can be used as a filter in list requests. + type: string + enumDescriptions: + - Default value. This value is unused. + - The note and occurrence represent a package vulnerability. + - The note and occurrence assert build provenance. + - This represents an image basis relationship. + - This represents a package installed via a package manager. + - The note and occurrence track deployment events. + - >- + The note and occurrence track the initial discovery status of a + resource. + - This represents a logical "role" that can attest to artifacts. + - This represents an available package upgrade. + - This represents a Compliance Note + - This represents a DSSE attestation Note + - This represents a Vulnerability Assessment. + - This represents an SBOM Reference. + - This represents a secret. + enum: + - NOTE_KIND_UNSPECIFIED + - VULNERABILITY + - BUILD + - IMAGE + - PACKAGE + - DEPLOYMENT + - DISCOVERY + - ATTESTATION + - UPGRADE + - COMPLIANCE + - DSSE_ATTESTATION + - VULNERABILITY_ASSESSMENT + - SBOM_REFERENCE + - SECRET + remediation: + description: A description of actions that can be taken to remedy the note. + type: string + createTime: + description: Output only. The time this occurrence was created. + type: string + format: google-datetime + updateTime: + description: Output only. The time this occurrence was last updated. + type: string + format: google-datetime + vulnerability: + description: Describes a security vulnerability. + $ref: '#/components/schemas/VulnerabilityOccurrence' + build: + description: Describes a verifiable build. + $ref: '#/components/schemas/BuildOccurrence' + image: description: >- - Required for non-Windows OS. The version of the package in machine + - human readable form. - distributions: - items: - $ref: '#/components/schemas/UpgradeDistribution' - type: array - description: Metadata about the upgrade for each specific operating system. - description: >- - An Upgrade Note represents a potential upgrade of a package to a given - version. For each package version combination (i.e. bash 4.0, bash 4.1, - bash 4.1.2), there will be an Upgrade Note. For Windows, windows_update - field represents the information related to the update. + Describes how this resource derives from the basis in the associated + note. + $ref: '#/components/schemas/ImageOccurrence' + package: + description: Describes the installation of a package on the linked resource. + $ref: '#/components/schemas/PackageOccurrence' + deployment: + description: Describes the deployment of an artifact on a runtime. + $ref: '#/components/schemas/DeploymentOccurrence' + discovery: + description: Describes when a resource was discovered. + $ref: '#/components/schemas/DiscoveryOccurrence' + attestation: + description: Describes an attestation of an artifact. + $ref: '#/components/schemas/AttestationOccurrence' + upgrade: + description: Describes an available package upgrade on the linked resource. + $ref: '#/components/schemas/UpgradeOccurrence' + compliance: + description: Describes a compliance violation on a linked resource. + $ref: '#/components/schemas/ComplianceOccurrence' + dsseAttestation: + description: Describes an attestation of an artifact using dsse. + $ref: '#/components/schemas/DSSEAttestationOccurrence' + sbomReference: + description: Describes a specific SBOM reference occurrences. + $ref: '#/components/schemas/SBOMReferenceOccurrence' + secret: + description: Describes a secret. + $ref: '#/components/schemas/SecretOccurrence' + envelope: + description: https://github.com/secure-systems-lab/dsse + $ref: '#/components/schemas/Envelope' VulnerabilityOccurrence: - description: An occurrence of a severity vulnerability on a resource. id: VulnerabilityOccurrence + description: An occurrence of a severity vulnerability on a resource. type: object properties: - cvssVersion: - enumDescriptions: - - '' - - '' - - '' - description: Output only. CVSS version used to populate cvss_score and severity. - enum: - - CVSS_VERSION_UNSPECIFIED - - CVSS_VERSION_2 - - CVSS_VERSION_3 - type: string - fixAvailable: - type: boolean - description: >- - Output only. Whether at least one of the affected packages has a fix - available. - cvssv3: - $ref: '#/components/schemas/CVSS' - description: The cvss v3 score for the vulnerability. - shortDescription: - type: string - description: Output only. A one sentence description of this vulnerability. - relatedUrls: - items: - $ref: '#/components/schemas/RelatedUrl' - description: Output only. URLs related to this vulnerability. - type: array type: description: >- The type of package; whether native or non native (e.g., ruby gems, node.js packages, etc.). type: string - cvssScore: - format: float - type: number - description: >- - Output only. The CVSS score of this vulnerability. CVSS score is on - a scale of 0 - 10 where 0 indicates low severity and 10 indicates - high severity. - extraDetails: - type: string - description: Occurrence-specific extra details about the vulnerability. - packageIssue: - description: >- - Required. The set of affected locations and their fixes (if - available) within the associated resource. - items: - $ref: '#/components/schemas/PackageIssue' - type: array - vexAssessment: - $ref: '#/components/schemas/VexAssessment' severity: - type: string description: >- Output only. The note provider assigned severity of this vulnerability. + type: string enumDescriptions: - Unknown. - Minimal severity. @@ -167,22 +178,35 @@ components: - MEDIUM - HIGH - CRITICAL - effectiveSeverity: + cvssScore: + description: >- + Output only. The CVSS score of this vulnerability. CVSS score is on + a scale of 0 - 10 where 0 indicates low severity and 10 indicates + high severity. + type: number + format: float + cvssv3: + description: The cvss v3 score for the vulnerability. + $ref: '#/components/schemas/CVSS' + packageIssue: + description: >- + Required. The set of affected locations and their fixes (if + available) within the associated resource. + type: array + items: + $ref: '#/components/schemas/PackageIssue' + shortDescription: + description: Output only. A one sentence description of this vulnerability. type: string - enum: - - SEVERITY_UNSPECIFIED - - MINIMAL - - LOW - - MEDIUM - - HIGH - - CRITICAL - enumDescriptions: - - Unknown. - - Minimal severity. - - Low severity. - - Medium severity. - - High severity. - - Critical severity. + longDescription: + description: Output only. A detailed description of this vulnerability. + type: string + relatedUrls: + description: Output only. URLs related to this vulnerability. + type: array + items: + $ref: '#/components/schemas/RelatedUrl' + effectiveSeverity: description: >- The distro assigned severity for this vulnerability when it is available, otherwise this is the note provider assigned severity. @@ -193,497 +217,485 @@ components: the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. - cvssV2: - $ref: '#/components/schemas/CVSS' - description: The cvss v2 score for the vulnerability. - longDescription: - type: string - description: Output only. A detailed description of this vulnerability. - Assessment: - type: object - properties: - remediations: - description: >- - Specifies details on how to handle (and presumably, fix) a - vulnerability. - type: array - items: - $ref: '#/components/schemas/Remediation' - cve: type: string - deprecated: true - description: >- - Holds the MITRE standard Common Vulnerabilities and Exposures (CVE) - tracking number for the vulnerability. Deprecated: Use - vulnerability_id instead to denote CVEs. - relatedUris: - description: >- - Holds a list of references associated with this vulnerability item - and assessment. These uris have additional information about the - vulnerability and the assessment itself. E.g. Link to a document - which details how this assessment concluded the state of this - vulnerability. - items: - $ref: '#/components/schemas/RelatedUrl' - type: array - vulnerabilityId: - type: string - description: >- - The vulnerability identifier for this Assessment. Will hold one of - common identifiers e.g. CVE, GHSA etc. - longDescription: - description: A detailed description of this Vex. - type: string - impacts: - description: >- - Contains information about the impact of this vulnerability, this - will change with time. - type: array - items: - type: string - justification: - $ref: '#/components/schemas/Justification' + enumDescriptions: + - Unknown. + - Minimal severity. + - Low severity. + - Medium severity. + - High severity. + - Critical severity. + enum: + - SEVERITY_UNSPECIFIED + - MINIMAL + - LOW + - MEDIUM + - HIGH + - CRITICAL + fixAvailable: description: >- - Justification provides the justification when the state of the - assessment if NOT_AFFECTED. - shortDescription: - description: A one sentence description of this Vex. + Output only. Whether at least one of the affected packages has a fix + available. + type: boolean + cvssVersion: + description: Output only. CVSS version used to populate cvss_score and severity. type: string - state: enumDescriptions: - - No state is specified. - - This product is known to be affected by this vulnerability. - - This product is known to be not affected by this vulnerability. - - This product contains a fix for this vulnerability. - - >- - It is not known yet whether these versions are or are not affected - by the vulnerability. However, it is still under investigation. + - '' + - '' + - '' enum: - - STATE_UNSPECIFIED - - AFFECTED - - NOT_AFFECTED - - FIXED - - UNDER_INVESTIGATION + - CVSS_VERSION_UNSPECIFIED + - CVSS_VERSION_2 + - CVSS_VERSION_3 + cvssV2: + description: The cvss v2 score for the vulnerability. + $ref: '#/components/schemas/CVSS' + vexAssessment: + $ref: '#/components/schemas/VexAssessment' + extraDetails: + description: Occurrence-specific extra details about the vulnerability. type: string - description: Provides the state of this Vulnerability assessment. - id: Assessment + risk: + description: Risk information about the vulnerability, such as CISA, EPSS, etc. + $ref: '#/components/schemas/Risk' + CVSS: + id: CVSS description: >- - Assessment provides all information that is related to a single - vulnerability for this product. - BuildOccurrence: + Common Vulnerability Scoring System. For details, see + https://www.first.org/cvss/specification-document This is a message we + will try to use for storing various versions of CVSS rather than making + a separate proto for storing a specific version. type: object - description: Details of a build occurrence. properties: - intotoProvenance: - $ref: '#/components/schemas/InTotoProvenance' - description: >- - Deprecated. See InTotoStatement for the replacement. In-toto - Provenance representation as defined in spec. - intotoStatement: - description: >- - In-toto Statement representation as defined in spec. The - intoto_statement can contain any type of provenance. The serialized - payload of the statement can be stored and signed in the - Occurrence's envelope. - $ref: '#/components/schemas/InTotoStatement' - inTotoSlsaProvenanceV1: + baseScore: + description: The base score is a function of the base metric scores. + type: number + format: float + exploitabilityScore: + type: number + format: float + impactScore: + type: number + format: float + attackVector: description: >- - In-Toto Slsa Provenance V1 represents a slsa provenance meeting the - slsa spec, wrapped in an in-toto statement. This allows for direct - jsonification of a to-spec in-toto slsa statement with a to-spec - slsa provenance. - $ref: '#/components/schemas/InTotoSlsaProvenanceV1' - provenance: - $ref: '#/components/schemas/BuildProvenance' - description: The actual provenance for the build. - provenanceBytes: + Base Metrics Represents the intrinsic characteristics of a + vulnerability that are constant over time and across user + environments. type: string - description: >- - Serialized JSON representation of the provenance, used in generating - the build signature in the corresponding build note. After verifying - the signature, `provenance_bytes` can be unmarshalled and compared - to the provenance to confirm that it is unchanged. A base64-encoded - string representation of the provenance bytes is used for the - signature in order to interoperate with openssl which expects this - format for signature verification. The serialized form is captured - both to avoid ambiguity in how the provenance is marshalled to json - as well to prevent incompatibilities with future changes. - id: BuildOccurrence - Hash: - type: object - id: Hash - description: Container message for hash values. - properties: - type: - description: Required. The type of hash that was performed, e.g. "SHA-256". + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + enum: + - ATTACK_VECTOR_UNSPECIFIED + - ATTACK_VECTOR_NETWORK + - ATTACK_VECTOR_ADJACENT + - ATTACK_VECTOR_LOCAL + - ATTACK_VECTOR_PHYSICAL + attackComplexity: type: string - value: - format: byte + enumDescriptions: + - '' + - '' + - '' + - '' + enum: + - ATTACK_COMPLEXITY_UNSPECIFIED + - ATTACK_COMPLEXITY_LOW + - ATTACK_COMPLEXITY_HIGH + - ATTACK_COMPLEXITY_MEDIUM + authentication: type: string - description: Required. The hash value. - GerritSourceContext: - properties: - aliasContext: - description: An alias, which may be a branch or tag. - $ref: '#/components/schemas/AliasContext' - revisionId: + enumDescriptions: + - '' + - '' + - '' + - '' + enum: + - AUTHENTICATION_UNSPECIFIED + - AUTHENTICATION_MULTIPLE + - AUTHENTICATION_SINGLE + - AUTHENTICATION_NONE + privilegesRequired: type: string - description: A revision (commit) ID. - gerritProject: + enumDescriptions: + - '' + - '' + - '' + - '' + enum: + - PRIVILEGES_REQUIRED_UNSPECIFIED + - PRIVILEGES_REQUIRED_NONE + - PRIVILEGES_REQUIRED_LOW + - PRIVILEGES_REQUIRED_HIGH + userInteraction: type: string - description: >- - The full project name within the host. Projects may be nested, so - "project/subproject" is a valid project name. The "repo name" is the - hostURI/project. - hostUri: + enumDescriptions: + - '' + - '' + - '' + enum: + - USER_INTERACTION_UNSPECIFIED + - USER_INTERACTION_NONE + - USER_INTERACTION_REQUIRED + scope: type: string - description: The URI of a running Gerrit instance. - id: GerritSourceContext - type: object - description: A SourceContext referring to a Gerrit project. - Metadata: - id: Metadata - description: Other properties of the build. - properties: - buildFinishedOn: + enumDescriptions: + - '' + - '' + - '' + enum: + - SCOPE_UNSPECIFIED + - SCOPE_UNCHANGED + - SCOPE_CHANGED + confidentialityImpact: type: string - description: The timestamp of when the build completed. - format: google-datetime - buildInvocationId: + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + enum: + - IMPACT_UNSPECIFIED + - IMPACT_HIGH + - IMPACT_LOW + - IMPACT_NONE + - IMPACT_PARTIAL + - IMPACT_COMPLETE + integrityImpact: type: string - description: >- - Identifies the particular build invocation, which can be useful for - finding associated logs or other ad-hoc analysis. The value SHOULD - be globally unique, per in-toto Provenance spec. - reproducible: - type: boolean - description: >- - If true, the builder claims that running the recipe on materials - will produce bit-for-bit identical output. - completeness: - $ref: '#/components/schemas/Completeness' - description: >- - Indicates that the builder claims certain fields in this message to - be complete. - buildStartedOn: - type: string - description: The timestamp of when the build started. - format: google-datetime - type: object - GrafeasV1SlsaProvenanceZeroTwoSlsaInvocation: - type: object - id: GrafeasV1SlsaProvenanceZeroTwoSlsaInvocation - properties: - parameters: - type: object - additionalProperties: - type: any - description: Properties of the object. - configSource: - $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaConfigSource' - environment: - additionalProperties: - description: Properties of the object. - type: any - type: object - description: Identifies the event that kicked off the build. - DiscoveryNote: - id: DiscoveryNote - description: >- - A note that indicates a type of analysis a provider would perform. This - note exists in a provider's project. A `Discovery` occurrence is created - in a consumer's project at the start of analysis. - properties: - analysisKind: - enum: - - NOTE_KIND_UNSPECIFIED - - VULNERABILITY - - BUILD - - IMAGE - - PACKAGE - - DEPLOYMENT - - DISCOVERY - - ATTESTATION - - UPGRADE - - COMPLIANCE - - DSSE_ATTESTATION - - VULNERABILITY_ASSESSMENT - - SBOM_REFERENCE enumDescriptions: - - Default value. This value is unused. - - The note and occurrence represent a package vulnerability. - - The note and occurrence assert build provenance. - - This represents an image basis relationship. - - This represents a package installed via a package manager. - - The note and occurrence track deployment events. - - >- - The note and occurrence track the initial discovery status of a - resource. - - This represents a logical "role" that can attest to artifacts. - - This represents an available package upgrade. - - This represents a Compliance Note - - This represents a DSSE attestation Note - - This represents a Vulnerability Assessment. - - This represents an SBOM Reference. + - '' + - '' + - '' + - '' + - '' + - '' + enum: + - IMPACT_UNSPECIFIED + - IMPACT_HIGH + - IMPACT_LOW + - IMPACT_NONE + - IMPACT_PARTIAL + - IMPACT_COMPLETE + availabilityImpact: type: string - description: >- - Required. Immutable. The kind of analysis that is handled by this - discovery. - type: object - SBOMReferenceOccurrence: - id: SBOMReferenceOccurrence + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + enum: + - IMPACT_UNSPECIFIED + - IMPACT_HIGH + - IMPACT_LOW + - IMPACT_NONE + - IMPACT_PARTIAL + - IMPACT_COMPLETE + PackageIssue: + id: PackageIssue description: >- - The occurrence representing an SBOM reference as applied to a specific - resource. The occurrence follows the DSSE specification. See - https://github.com/secure-systems-lab/dsse/blob/master/envelope.md for - more details. - properties: - signatures: - type: array - description: The signatures over the payload. - items: - $ref: '#/components/schemas/EnvelopeSignature' - payloadType: - description: >- - The kind of payload that SbomReferenceIntotoPayload takes. Since - it's in the intoto format, this value is expected to be - 'application/vnd.in-toto+json'. - type: string - payload: - $ref: '#/components/schemas/SbomReferenceIntotoPayload' - description: The actual payload that contains the SBOM reference data. - type: object - ContaineranalysisGoogleDevtoolsCloudbuildV1SecretManagerSecret: + A detail for a distro and package this vulnerability occurrence was + found in and its associated fix (if one is available). type: object - description: >- - Pairs a secret environment variable with a SecretVersion in Secret - Manager. properties: - env: - description: >- - Environment variable name to associate with the secret. Secret - environment variables must be unique across all of a build's - secrets, and must be used by at least one build step. - type: string - versionName: + affectedCpeUri: description: >- - Resource name of the SecretVersion. In format: - projects/*/secrets/*/versions/* + Required. The [CPE URI](https://cpe.mitre.org/specification/) this + vulnerability was found in. type: string - id: ContaineranalysisGoogleDevtoolsCloudbuildV1SecretManagerSecret - ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsMavenArtifact: - properties: - groupId: + affectedPackage: + description: Required. The package this vulnerability was found in. type: string + affectedVersion: description: >- - Maven `groupId` value used when uploading the artifact to Artifact - Registry. - artifactId: - type: string + Required. The version of the package that is installed on the + resource affected by this vulnerability. + $ref: '#/components/schemas/Version' + fixedCpeUri: description: >- - Maven `artifactId` value used when uploading the artifact to - Artifact Registry. - version: + The [CPE URI](https://cpe.mitre.org/specification/) this + vulnerability was fixed in. It is possible for this to be different + from the affected_cpe_uri. type: string + fixedPackage: description: >- - Maven `version` value used when uploading the artifact to Artifact - Registry. - repository: + The package this vulnerability was fixed in. It is possible for this + to be different from the affected_package. + type: string + fixedVersion: description: >- - Artifact Registry repository, in the form - "https://$REGION-maven.pkg.dev/$PROJECT/$REPOSITORY" Artifact in the - workspace specified by path will be uploaded to Artifact Registry - with this location as a prefix. + Required. The version of the package this vulnerability was fixed + in. Setting this to VersionKind.MAXIMUM means no fix is yet + available. + $ref: '#/components/schemas/Version' + fixAvailable: + description: Output only. Whether a fix is available for this package. + type: boolean + packageType: + description: The type of package (e.g. OS, MAVEN, GO). type: string - path: + effectiveSeverity: description: >- - Path to an artifact in the build's workspace to be uploaded to - Artifact Registry. This can be either an absolute path, e.g. - /workspace/my-app/target/my-app-1.0.SNAPSHOT.jar or a relative path - from /workspace, e.g. my-app/target/my-app-1.0.SNAPSHOT.jar. + Output only. The distro or language system assigned severity for + this vulnerability when that is available and note provider assigned + severity when it is not available. + readOnly: true type: string + enumDescriptions: + - Unknown. + - Minimal severity. + - Low severity. + - Medium severity. + - High severity. + - Critical severity. + enum: + - SEVERITY_UNSPECIFIED + - MINIMAL + - LOW + - MEDIUM + - HIGH + - CRITICAL + fileLocation: + description: The location at which this package was found. + type: array + items: + $ref: '#/components/schemas/GrafeasV1FileLocation' + Version: + id: Version + description: Version contains structured information about the version of a package. type: object - description: >- - A Maven artifact to upload to Artifact Registry upon successful - completion of all build steps. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsMavenArtifact - NonCompliantFile: - id: NonCompliantFile properties: - reason: - type: string - description: Explains why a file is non compliant for a CIS check. - path: - description: Empty if `display_command` is set. + epoch: + description: Used to correct mistakes in the version numbering scheme. + type: integer + format: int32 + name: + description: >- + Required only when version kind is NORMAL. The main part of the + version name. type: string - displayCommand: + revision: + description: The iteration of the package build from the above version. type: string - description: Command to display the non-compliant files. - description: >- - Details about files that caused a compliance check to fail. - display_command is a single command that can be used to display a list - of non compliant files. When there is no such command, we can also - iterate a list of non compliant file using 'path'. - type: object - GetIamPolicyRequest: - properties: - options: - $ref: '#/components/schemas/GetPolicyOptions' + inclusive: description: >- - OPTIONAL: A `GetPolicyOptions` object for specifying options to - `GetIamPolicy`. - type: object - id: GetIamPolicyRequest - description: Request message for `GetIamPolicy` method. - Remediation: - type: object - description: >- - Specifies details on how to handle (and presumably, fix) a - vulnerability. - properties: - remediationUri: - description: Contains the URL where to obtain the remediation. - $ref: '#/components/schemas/RelatedUrl' - remediationType: - enum: - - REMEDIATION_TYPE_UNSPECIFIED - - MITIGATION - - NO_FIX_PLANNED - - NONE_AVAILABLE - - VENDOR_FIX - - WORKAROUND + Whether this version is specifying part of an inclusive range. + Grafeas does not have the capability to specify version ranges; + instead we have fields that specify start version and end versions. + At times this is insufficient - we also need to specify whether the + version is included in the range or is excluded from the range. This + boolean is expected to be set to true when the version is included + in a range. + type: boolean + kind: + description: >- + Required. Distinguishes between sentinel MIN/MAX versions and normal + versions. + type: string enumDescriptions: - - No remediation type specified. - - A MITIGATION is available. - - No fix is planned. - - Not available. - - A vendor fix is available. - - A workaround is available. + - Unknown. + - A standard package version. + - A special version representing negative infinity. + - A special version representing positive infinity. + enum: + - VERSION_KIND_UNSPECIFIED + - NORMAL + - MINIMUM + - MAXIMUM + fullName: + description: >- + Human readable version string. This string is of the form :- and is + only set when kind is NORMAL. type: string - description: The type of remediation that can be applied. - details: + GrafeasV1FileLocation: + id: GrafeasV1FileLocation + description: Indicates the location at which a package was found. + type: object + properties: + filePath: + description: >- + For jars that are contained inside .war files, this filepath can + indicate the path to war file combined with the path to jar file. type: string + layerDetails: description: >- - Contains a comprehensive human-readable discussion of the - remediation. - id: Remediation - ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfigHttpConfig: - description: HttpConfig is a configuration for HTTP related git operations. + Each package found in a file should have its own layer metadata + (that is, information from the origin layer of the package). + $ref: '#/components/schemas/LayerDetails' + LayerDetails: + id: LayerDetails + description: Details about the layer a package was found in. type: object properties: - proxySecretVersionName: + index: + description: The index of the layer in the container image. + type: integer + format: int32 + diffId: + description: >- + The diff ID (typically a sha256 hash) of the layer in the container + image. type: string + chainId: description: >- - SecretVersion resource of the HTTP proxy URL. The Service Account - used in the build (either the default Service Account or - user-specified Service Account) should have - `secretmanager.versions.access` permissions on this secret. The - proxy URL should be in format `protocol://@]proxyhost[:port]`. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfigHttpConfig - GitSourceContext: - id: GitSourceContext + The layer chain ID (sha256 hash) of the layer in the container + image. + https://github.com/opencontainers/image-spec/blob/main/config.md#layer-chainid + type: string + command: + description: >- + The layer build command that was used to build the layer. This may + not be found in all layers depending on how the container image is + built. + type: string + baseImages: + description: The base images the layer is found within. + type: array + items: + $ref: '#/components/schemas/BaseImage' + BaseImage: + id: BaseImage + description: BaseImage describes a base image of a container image. + type: object + properties: + name: + description: The name of the base image. + type: string + repository: + description: The repository name in which the base image is from. + type: string + layerCount: + description: The number of layers that the base image is composed of. + type: integer + format: int32 + RelatedUrl: + id: RelatedUrl + description: Metadata for any related URL information. type: object properties: url: + description: Specific URL associated with the resource. type: string - description: Git repository URL. - revisionId: - description: Git commit hash. + label: + description: Label to describe usage of the URL. type: string + VexAssessment: + id: VexAssessment description: >- - A GitSourceContext denotes a particular revision in a third party Git - repository (e.g., GitHub). - SBOMReferenceNote: + VexAssessment provides all publisher provided Vex information that is + related to this vulnerability. type: object - description: The note representing an SBOM reference. - id: SBOMReferenceNote properties: - version: + cve: + description: >- + Holds the MITRE standard Common Vulnerabilities and Exposures (CVE) + tracking number for the vulnerability. Deprecated: Use + vulnerability_id instead to denote CVEs. + deprecated: true type: string + vulnerabilityId: description: >- - The version of the format that the SBOM takes. E.g. if the format is - spdx, the version may be 2.3. - format: + The vulnerability identifier for this Assessment. Will hold one of + common identifiers e.g. CVE, GHSA etc. type: string - description: The format that SBOM takes. E.g. may be spdx, cyclonedx, etc... - AttestationOccurrence: - id: AttestationOccurrence - description: >- - Occurrence that represents a single "attestation". The authenticity of - an attestation can be verified using the attached signature. If the - verifier trusts the public key of the signer, then verifying the - signature is sufficient to establish trust. In this circumstance, the - authority to which this attestation is attached is primarily useful for - lookup (how to find this attestation if you already know the authority - and artifact to be verified) and intent (for which authority this - attestation was intended to sign. - properties: - signatures: + relatedUris: + description: >- + Holds a list of references associated with this vulnerability item + and assessment. type: array + items: + $ref: '#/components/schemas/RelatedUrl' + noteName: description: >- - One or more signatures over `serialized_payload`. Verifier - implementations should consider this attestation message verified if - at least one `signature` verifies `serialized_payload`. See - `Signature` in common.proto for more details on signature structure - and verification. + The VulnerabilityAssessment note from which this VexAssessment was + generated. This will be of the form: + `projects/[PROJECT_ID]/notes/[NOTE_ID]`. + type: string + state: + description: Provides the state of this Vulnerability assessment. + type: string + enumDescriptions: + - No state is specified. + - This product is known to be affected by this vulnerability. + - This product is known to be not affected by this vulnerability. + - This product contains a fix for this vulnerability. + - >- + It is not known yet whether these versions are or are not affected + by the vulnerability. However, it is still under investigation. + enum: + - STATE_UNSPECIFIED + - AFFECTED + - NOT_AFFECTED + - FIXED + - UNDER_INVESTIGATION + impacts: + description: >- + Contains information about the impact of this vulnerability, this + will change with time. + type: array items: - $ref: '#/components/schemas/Signature' - jwts: + type: string + remediations: description: >- - One or more JWTs encoding a self-contained attestation. Each JWT - encodes the payload that it verifies within the JWT itself. Verifier - implementation SHOULD ignore the `serialized_payload` field when - verifying these JWTs. If only JWTs are present on this - AttestationOccurrence, then the `serialized_payload` SHOULD be left - empty. Each JWT SHOULD encode a claim specific to the `resource_uri` - of this Occurrence, but this is not validated by Grafeas metadata - API implementations. The JWT itself is opaque to Grafeas. + Specifies details on how to handle (and presumably, fix) a + vulnerability. type: array items: - $ref: '#/components/schemas/Jwt' - serializedPayload: - format: byte - type: string + $ref: '#/components/schemas/Remediation' + justification: description: >- - Required. The serialized payload that is verified by one or more - `signatures`. + Justification provides the justification when the state of the + assessment if NOT_AFFECTED. + $ref: '#/components/schemas/Justification' + Remediation: + id: Remediation + description: >- + Specifies details on how to handle (and presumably, fix) a + vulnerability. type: object - ContaineranalysisGoogleDevtoolsCloudbuildV1BuiltImage: properties: - digest: + remediationType: + description: The type of remediation that can be applied. type: string - description: Docker Registry 2.0 digest. - name: + enumDescriptions: + - No remediation type specified. + - A MITIGATION is available. + - No fix is planned. + - Not available. + - A vendor fix is available. + - A workaround is available. + enum: + - REMEDIATION_TYPE_UNSPECIFIED + - MITIGATION + - NO_FIX_PLANNED + - NONE_AVAILABLE + - VENDOR_FIX + - WORKAROUND + details: description: >- - Name used to push the container image to Google Container Registry, - as presented to `docker push`. + Contains a comprehensive human-readable discussion of the + remediation. type: string - pushTiming: - readOnly: true - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan - description: >- - Output only. Stores timing information for pushing the specified - image. - type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuiltImage - description: An image built by the pipeline. + remediationUri: + description: Contains the URL where to obtain the remediation. + $ref: '#/components/schemas/RelatedUrl' Justification: + id: Justification description: >- Justification provides the justification when the state of the assessment if NOT_AFFECTED. + type: object properties: - details: - type: string - description: Additional details on why this justification was chosen. justificationType: - enum: - - JUSTIFICATION_TYPE_UNSPECIFIED - - COMPONENT_NOT_PRESENT - - VULNERABLE_CODE_NOT_PRESENT - - VULNERABLE_CODE_NOT_IN_EXECUTE_PATH - - VULNERABLE_CODE_CANNOT_BE_CONTROLLED_BY_ADVERSARY - - INLINE_MITIGATIONS_ALREADY_EXIST description: The justification type for this vulnerability. type: string enumDescriptions: @@ -706,684 +718,523 @@ components: cannot be subverted by the attacker and cannot be configured or disabled by the user. These mitigations completely prevent exploitation based on known attack vectors. - id: Justification - type: object - Fingerprint: + enum: + - JUSTIFICATION_TYPE_UNSPECIFIED + - COMPONENT_NOT_PRESENT + - VULNERABLE_CODE_NOT_PRESENT + - VULNERABLE_CODE_NOT_IN_EXECUTE_PATH + - VULNERABLE_CODE_CANNOT_BE_CONTROLLED_BY_ADVERSARY + - INLINE_MITIGATIONS_ALREADY_EXIST + details: + description: Additional details on why this justification was chosen. + type: string + Risk: + id: Risk type: object properties: - v1Name: - type: string + cisaKev: description: >- - Required. The layer ID of the final layer in the Docker image's v1 - representation. - v2Blob: - items: - type: string - type: array - description: Required. The ordered list of v2 blobs that represent a given image. - v2Name: - type: string + CISA maintains the authoritative source of vulnerabilities that have + been exploited in the wild. + $ref: '#/components/schemas/CISAKnownExploitedVulnerabilities' + epss: description: >- - Output only. The name of the image's v2 blobs computed via: [bottom] - := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the - name of the final blob is kept. - description: A set of properties that uniquely identify a given Docker image. - id: Fingerprint - PackageNote: - description: PackageNote represents a particular package version. - id: PackageNote + The Exploit Prediction Scoring System (EPSS) estimates the + likelihood (probability) that a software vulnerability will be + exploited in the wild. + $ref: '#/components/schemas/ExploitPredictionScoringSystem' + CISAKnownExploitedVulnerabilities: + id: CISAKnownExploitedVulnerabilities type: object properties: - digest: - type: array - items: - $ref: '#/components/schemas/Digest' + knownRansomwareCampaignUse: description: >- - Hash value, typically a file digest, that allows unique - identification a specific package. - name: - type: string - description: Required. Immutable. The name of the package. - architecture: - enum: - - ARCHITECTURE_UNSPECIFIED - - X86 - - X64 + Whether the vulnerability is known to have been leveraged as part of + a ransomware campaign. type: string + ExploitPredictionScoringSystem: + id: ExploitPredictionScoringSystem + type: object + properties: + percentile: description: >- - The CPU architecture for which packages in this distribution channel - were built. Architecture will be blank for language packages. - enumDescriptions: - - Unknown architecture. - - X86 architecture. - - X64 architecture. - cpeUri: + The percentile of the current score, the proportion of all scored + vulnerabilities with the same or a lower EPSS score + type: number + format: double + score: description: >- - The cpe_uri in [CPE format](https://cpe.mitre.org/specification/) - denoting the package manager version distributing a package. The - cpe_uri will be blank for language packages. - type: string - license: - $ref: '#/components/schemas/License' - description: Licenses that have been declared by the authors of the package. - url: - description: The homepage for this package. + The EPSS score representing the probability [0-1] of exploitation in + the wild in the next 30 days + type: number + format: double + BuildOccurrence: + id: BuildOccurrence + description: Details of a build occurrence. + type: object + properties: + provenance: + description: The actual provenance for the build. + $ref: '#/components/schemas/BuildProvenance' + provenanceBytes: + description: >- + Serialized JSON representation of the provenance, used in generating + the build signature in the corresponding build note. After verifying + the signature, `provenance_bytes` can be unmarshalled and compared + to the provenance to confirm that it is unchanged. A base64-encoded + string representation of the provenance bytes is used for the + signature in order to interoperate with openssl which expects this + format for signature verification. The serialized form is captured + both to avoid ambiguity in how the provenance is marshalled to json + as well to prevent incompatibilities with future changes. type: string - maintainer: + intotoProvenance: + description: >- + Deprecated. See InTotoStatement for the replacement. In-toto + Provenance representation as defined in spec. + $ref: '#/components/schemas/InTotoProvenance' + intotoStatement: + description: >- + In-toto Statement representation as defined in spec. The + intoto_statement can contain any type of provenance. The serialized + payload of the statement can be stored and signed in the + Occurrence's envelope. + $ref: '#/components/schemas/InTotoStatement' + inTotoSlsaProvenanceV1: + description: >- + In-Toto Slsa Provenance V1 represents a slsa provenance meeting the + slsa spec, wrapped in an in-toto statement. This allows for direct + jsonification of a to-spec in-toto slsa statement with a to-spec + slsa provenance. + $ref: '#/components/schemas/InTotoSlsaProvenanceV1' + BuildProvenance: + id: BuildProvenance + description: >- + Provenance of a build. Contains all information needed to verify the + full details about the build from source to completion. + type: object + properties: + id: + description: Required. Unique identifier of the build. type: string - description: A freeform text denoting the maintainer of this package. - packageType: + projectId: + description: ID of the project. type: string - description: >- - The type of package; whether native or non native (e.g., ruby gems, - node.js packages, etc.). - version: - $ref: '#/components/schemas/Version' - description: The version of the package. - distribution: + commands: + description: Commands requested by the build. + type: array items: - $ref: '#/components/schemas/Distribution' + $ref: '#/components/schemas/Command' + builtArtifacts: + description: Output of the build. type: array - description: Deprecated. The various channels by which a package is distributed. - description: + items: + $ref: '#/components/schemas/Artifact' + createTime: + description: Time at which the build was created. type: string - description: The description of this package. - ResourceDescriptor: - type: object - properties: - uri: + format: google-datetime + startTime: + description: Time at which execution of the build was started. type: string - mediaType: + format: google-datetime + endTime: + description: Time at which execution of the build was finished. type: string - name: + format: google-datetime + creator: + description: >- + E-mail address of the user who initiated this build. Note that this + was the user's e-mail address at the time the build was initiated; + this address may not represent the same end-user for all time. type: string - digest: - additionalProperties: - type: string - type: object - annotations: - additionalProperties: - type: any - type: object - downloadLocation: + logsUri: + description: URI where any logs for this provenance were written. type: string - content: - format: byte + sourceProvenance: + description: Details of the Source input to the build. + $ref: '#/components/schemas/Source' + triggerId: + description: >- + Trigger identifier if the build was triggered automatically; empty + if not. type: string - id: ResourceDescriptor - Subject: - type: object - properties: - digest: + buildOptions: + description: >- + Special options applied to this build. This is a catch-all field + where build providers can enter any desired additional details. type: object additionalProperties: type: string - description: >- - `"": ""` Algorithms can be e.g. sha256, sha512 See - https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet - name: + builderVersion: + description: Version string of the builder at the time this build was executed. type: string - id: Subject - ContaineranalysisGoogleDevtoolsCloudbuildV1BuildWarning: - description: A non-fatal problem encountered during the execution of the build. + Command: + id: Command + description: Command describes a step performed as part of the build pipeline. + type: object properties: - priority: - enumDescriptions: - - Should not be used. - - e.g. deprecation warnings and alternative feature highlights. - - e.g. automated detection of possible issues with the build. - - e.g. alerts that a feature used in the build is pending removal + name: + description: >- + Required. Name of the command, as presented on the command line, or + if the command is packaged as a Docker container, as presented to + `docker pull`. type: string - enum: - - PRIORITY_UNSPECIFIED - - INFO - - WARNING - - ALERT - description: The priority for this warning. - text: + env: + description: Environment variables set before running this command. + type: array + items: + type: string + args: + description: Command-line arguments used when executing this command. + type: array + items: + type: string + dir: + description: >- + Working directory (relative to project source root) used when + running this command. type: string - description: Explanation of the warning generated. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildWarning + id: + description: >- + Optional unique identifier for this command, used in wait_for to + reference this command as a dependency. + type: string + waitFor: + description: The ID(s) of the command(s) that this command depends on. + type: array + items: + type: string + Artifact: + id: Artifact + description: Artifact describes a build product. type: object - CVSSv3: properties: - scope: - enumDescriptions: - - '' - - '' - - '' - enum: - - SCOPE_UNSPECIFIED - - SCOPE_UNCHANGED - - SCOPE_CHANGED - type: string - baseScore: - format: float - type: number - description: The base score is a function of the base metric scores. - impactScore: - format: float - type: number - attackVector: - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - enum: - - ATTACK_VECTOR_UNSPECIFIED - - ATTACK_VECTOR_NETWORK - - ATTACK_VECTOR_ADJACENT - - ATTACK_VECTOR_LOCAL - - ATTACK_VECTOR_PHYSICAL + checksum: description: >- - Base Metrics Represents the intrinsic characteristics of a - vulnerability that are constant over time and across user - environments. - type: string - exploitabilityScore: - type: number - format: float - attackComplexity: - enumDescriptions: - - '' - - '' - - '' - enum: - - ATTACK_COMPLEXITY_UNSPECIFIED - - ATTACK_COMPLEXITY_LOW - - ATTACK_COMPLEXITY_HIGH - type: string - userInteraction: - enumDescriptions: - - '' - - '' - - '' - type: string - enum: - - USER_INTERACTION_UNSPECIFIED - - USER_INTERACTION_NONE - - USER_INTERACTION_REQUIRED - privilegesRequired: - type: string - enum: - - PRIVILEGES_REQUIRED_UNSPECIFIED - - PRIVILEGES_REQUIRED_NONE - - PRIVILEGES_REQUIRED_LOW - - PRIVILEGES_REQUIRED_HIGH - enumDescriptions: - - '' - - '' - - '' - - '' - integrityImpact: - enum: - - IMPACT_UNSPECIFIED - - IMPACT_HIGH - - IMPACT_LOW - - IMPACT_NONE - type: string - enumDescriptions: - - '' - - '' - - '' - - '' - confidentialityImpact: + Hash or checksum value of a binary, or Docker Registry 2.0 digest of + a container. type: string - enum: - - IMPACT_UNSPECIFIED - - IMPACT_HIGH - - IMPACT_LOW - - IMPACT_NONE - enumDescriptions: - - '' - - '' - - '' - - '' - availabilityImpact: + id: + description: >- + Artifact ID, if any; for container images, this will be a URL by + digest like `gcr.io/projectID/imagename@sha256:123456`. type: string - enum: - - IMPACT_UNSPECIFIED - - IMPACT_HIGH - - IMPACT_LOW - - IMPACT_NONE - enumDescriptions: - - '' - - '' - - '' - - '' - type: object - description: >- - Common Vulnerability Scoring System version 3. For details, see - https://www.first.org/cvss/specification-document - id: CVSSv3 - GoogleDevtoolsContaineranalysisV1alpha1OperationMetadata: + names: + description: >- + Related artifact names. This may be the path to a binary or jar + file, or in the case of a container build, the name used to push the + container image to Google Container Registry, as presented to + `docker push`. Note that a single Artifact ID can have multiple + names, for example if two tags are applied to one image. + type: array + items: + type: string + Source: + id: Source + description: Source describes the location of the source used for the build. type: object - id: GoogleDevtoolsContaineranalysisV1alpha1OperationMetadata properties: - endTime: - format: google-datetime + artifactStorageSourceUri: description: >- - Output only. The time that this operation was marked completed or - failed. - type: string - createTime: - description: Output only. The time this operation was created. - type: string - format: google-datetime - description: >- - Metadata for all operations used and required for all operations that - created by Container Analysis Providers - Hint: - properties: - humanReadableName: + If provided, the input binary artifacts for the build came from this + location. type: string + fileHashes: description: >- - Required. The human readable name of this attestation authority, for - example "qa". - id: Hint - type: object - description: >- - This submessage provides human-readable hints about the purpose of the - authority. Because the name of a note acts as its resource reference, it - is important to disambiguate the canonical name of the Note (which might - be a UUID for security purposes) from "readable" names more suitable for - debug output. Note that these hints should not be used to look up - authorities in security sensitive contexts, such as when looking up - attestations to verify. - ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes: + Hash(es) of the build source, which can be used to verify that the + original source integrity was maintained in the build. The keys to + this map are file paths used as build source and the values contain + the hash values for those files. If the build source came in a + single package such as a gzipped tarfile (.tar.gz), the FileHash + will be for the single path to that file. + type: object + additionalProperties: + $ref: '#/components/schemas/FileHashes' + context: + description: >- + If provided, the source code used for the build came from this + location. + $ref: '#/components/schemas/SourceContext' + additionalContexts: + description: >- + If provided, some of the source code used for the build may be found + in these locations, in the case where the source repository had + multiple remotes or submodules. This list will not include the + context specified in the context field. + type: array + items: + $ref: '#/components/schemas/SourceContext' + FileHashes: + id: FileHashes description: >- - Container message for hashes of byte content of files, used in - SourceProvenance messages to verify integrity of source input to the - build. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes + Container message for hashes of byte content of files, used in source + messages to verify integrity of source input to the build. + type: object properties: fileHash: - description: Collection of file hashes. + description: Required. Collection of file hashes. type: array items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Hash + $ref: '#/components/schemas/Hash' + Hash: + id: Hash + description: Container message for hash values. type: object - ComplianceNote: properties: - version: - items: - $ref: '#/components/schemas/ComplianceVersion' - type: array - description: The OS and config versions the benchmark applies to. - impact: - type: string - cisBenchmark: - $ref: '#/components/schemas/CisBenchmark' - description: - type: string - description: A description about this compliance check. - rationale: - description: A rationale for the existence of this compliance check. - type: string - remediation: + type: + description: Required. The type of hash that was performed, e.g. "SHA-256". type: string - description: A description of remediation steps if the compliance check fails. - title: - description: The title that identifies this compliance check. + value: + description: Required. The hash value. type: string - scanInstructions: format: byte - type: string - description: Serialized scan instructions with a predefined format. - id: ComplianceNote - type: object - ContaineranalysisGoogleDevtoolsCloudbuildV1BuildStep: - id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildStep - description: A step in the build pipeline. + SourceContext: + id: SourceContext + description: >- + A SourceContext is a reference to a tree of files. A SourceContext + together with a path point to a unique revision of a single file or + directory. type: object properties: - volumes: - items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Volume - description: >- - List of volumes to mount into the build step. Each volume is created - as an empty volume prior to execution of the build step. Upon - completion of the build, volumes and their contents are discarded. - Using a named volume in only one step is not valid as it is - indicative of a build request with an incorrect configuration. - type: array - automapSubstitutions: - type: boolean + cloudRepo: description: >- - Option to include built-in and custom substitutions as env variables - for this build step. This option will override the global option in - BuildOption. - timing: + A SourceContext referring to a revision in a Google Cloud Source + Repo. + $ref: '#/components/schemas/CloudRepoSourceContext' + gerrit: + description: A SourceContext referring to a Gerrit project. + $ref: '#/components/schemas/GerritSourceContext' + git: description: >- - Output only. Stores timing information for executing this build - step. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan - readOnly: true - script: + A SourceContext referring to any third party Git repo (e.g., + GitHub). + $ref: '#/components/schemas/GitSourceContext' + labels: + description: Labels with user defined metadata. + type: object + additionalProperties: + type: string + CloudRepoSourceContext: + id: CloudRepoSourceContext + description: >- + A CloudRepoSourceContext denotes a particular revision in a Google Cloud + Source Repo. + type: object + properties: + repoId: + description: The ID of the repo. + $ref: '#/components/schemas/RepoId' + revisionId: + description: A revision ID. type: string - description: >- - A shell script to be executed in the step. When script is provided, - the user cannot specify the entrypoint or args. - allowExitCodes: - items: - format: int32 - type: integer - description: >- - Allow this build step to fail without failing the entire build if - and only if the exit code is one of the specified codes. If - allow_failure is also specified, this field will take precedence. - type: array - entrypoint: + aliasContext: + description: An alias, which may be a branch or tag. + $ref: '#/components/schemas/AliasContext' + RepoId: + id: RepoId + description: A unique identifier for a Cloud Repo. + type: object + properties: + projectRepoId: + description: A combination of a project ID and a repo name. + $ref: '#/components/schemas/ProjectRepoId' + uid: + description: A server-assigned, globally unique identifier. type: string - description: >- - Entrypoint to be used instead of the build step image's default - entrypoint. If unset, the image's default entrypoint is used. - timeout: + ProjectRepoId: + id: ProjectRepoId + description: >- + Selects a repo using a Google Cloud Platform project ID (e.g., + winged-cargo-31) and a repo name within that project. + type: object + properties: + projectId: + description: The ID of the project. + type: string + repoName: + description: The name of the repo. Leave empty for the default repo. + type: string + AliasContext: + id: AliasContext + description: An alias to a repo revision. + type: object + properties: + kind: + description: The alias kind. type: string - description: >- - Time limit for executing this build step. If not defined, the step - has no time limit and will be allowed to continue to run until - either it completes or the build itself times out. - format: google-duration - env: - description: >- - A list of environment variable definitions to be used when running a - step. The elements are of the form "KEY=VALUE" for the environment - variable "KEY" being given the value "VALUE". - items: - type: string - type: array - status: - enum: - - STATUS_UNKNOWN - - PENDING - - QUEUED - - WORKING - - SUCCESS - - FAILURE - - INTERNAL_ERROR - - TIMEOUT - - CANCELLED - - EXPIRED enumDescriptions: - - Status of the build is unknown. + - Unknown. + - Git tag. + - Git branch. - >- - Build has been created and is pending execution and queuing. It - has not been queued. - - Build or step is queued; work has not yet begun. - - Build or step is being executed. - - Build or step finished successfully. - - Build or step failed to complete successfully. - - Build or step failed due to an internal cause. - - Build or step took longer than was allowed. - - Build or step was canceled by a user. - - Build was enqueued for longer than the value of `queue_ttl`. + Used to specify non-standard aliases. For example, if a Git repo + has a ref named "refs/foo/bar". + enum: + - KIND_UNSPECIFIED + - FIXED + - MOVABLE + - OTHER + name: + description: The alias name. type: string - readOnly: true + GerritSourceContext: + id: GerritSourceContext + description: A SourceContext referring to a Gerrit project. + type: object + properties: + hostUri: + description: The URI of a running Gerrit instance. + type: string + gerritProject: description: >- - Output only. Status of the build step. At this time, build step - status is only updated on build completion; step status is not - updated in real-time as the build progresses. - args: + The full project name within the host. Projects may be nested, so + "project/subproject" is a valid project name. The "repo name" is the + hostURI/project. + type: string + revisionId: + description: A revision (commit) ID. + type: string + aliasContext: + description: An alias, which may be a branch or tag. + $ref: '#/components/schemas/AliasContext' + GitSourceContext: + id: GitSourceContext + description: >- + A GitSourceContext denotes a particular revision in a third party Git + repository (e.g., GitHub). + type: object + properties: + url: + description: Git repository URL. + type: string + revisionId: + description: Git commit hash. + type: string + InTotoProvenance: + id: InTotoProvenance + type: object + properties: + builderConfig: + description: required + $ref: '#/components/schemas/BuilderConfig' + recipe: + description: >- + Identifies the configuration used for the build. When combined with + materials, this SHOULD fully describe the build, such that + re-running this recipe results in bit-for-bit identical output (if + the build is reproducible). required + $ref: '#/components/schemas/Recipe' + metadata: + $ref: '#/components/schemas/Metadata' + materials: + description: >- + The collection of artifacts that influenced the build including + sources, dependencies, build tools, base images, and so on. This is + considered to be incomplete unless metadata.completeness.materials + is true. Unset or null is equivalent to empty. type: array items: type: string - description: >- - A list of arguments that will be presented to the step when it is - started. If the image used to run the step's container has an - entrypoint, the `args` are used as arguments to that entrypoint. If - the image does not define an entrypoint, the first element in args - is used as the entrypoint, and the remainder will be used as - arguments. + BuilderConfig: + id: BuilderConfig + type: object + properties: id: type: string + Recipe: + id: Recipe + description: >- + Steps taken to build the artifact. For a TaskRun, typically each + container corresponds to one step in the recipe. + type: object + properties: + type: description: >- - Unique identifier for this build step, used in `wait_for` to - reference this build step as a dependency. - allowFailure: + URI indicating what type of recipe was performed. It determines the + meaning of recipe.entryPoint, recipe.arguments, recipe.environment, + and materials. + type: string + definedInMaterial: description: >- - Allow this build step to fail without failing the entire build. If - false, the entire build will fail if this step fails. Otherwise, the - build will succeed, but this step will still have a failure status. - Error information will be reported in the failure_detail field. - type: boolean - name: + Index in materials containing the recipe steps that are not implied + by recipe.type. For example, if the recipe type were "make", then + this would point to the source containing the Makefile, not the make + program itself. Set to -1 if the recipe doesn't come from a + material, as zero is default unset value for int64. + type: string + format: int64 + entryPoint: description: >- - Required. The name of the container image that will run this - particular build step. If the image is available in the host's - Docker daemon's cache, it will be run directly. If not, the host - will attempt to pull the image first, using the builder service - account's credentials if necessary. The Docker daemon's cache will - already have the latest versions of all of the officially supported - build steps - ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). - The Docker daemon will also have cached many of the layers for some - popular images, like "ubuntu", "debian", but they will be refreshed - at the time you attempt to use them. If you built an image in a - previous build step, it will be stored in the host's Docker daemon's - cache and is available to use as the name for a later build step. + String identifying the entry point into the build. This is often a + path to a configuration file and/or a target label within that file. + The syntax and meaning are defined by recipe.type. For example, if + the recipe type were "make", then this would reference the directory + in which to run make as well as which target to use. type: string - waitFor: + arguments: + description: >- + Collection of all external inputs that influenced the build on top + of recipe.definedInMaterial and recipe.entryPoint. For example, if + the recipe type were "make", then this might be the flags passed to + make aside from the target, which is captured in recipe.entryPoint. + Since the arguments field can greatly vary in structure, depending + on the builder and recipe type, this is of form "Any". type: array items: - type: string + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + environment: description: >- - The ID(s) of the step(s) that this build step depends on. This build - step will not start until all the build steps in `wait_for` have - completed successfully. If `wait_for` is empty, this build step will - start when all previous build steps in the `Build.Steps` list have - completed successfully. - secretEnv: - items: - type: string - type: array - description: >- - A list of environment variables which are encrypted using a Cloud - Key Management Service crypto key. These values must be specified in - the build's `Secret`. - pullTiming: - description: >- - Output only. Stores timing information for pulling this build step's - builder image only. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan - readOnly: true - dir: - type: string - description: >- - Working directory to use when running this step's container. If this - value is a relative path, it is relative to the build's working - directory. If this value is absolute, it may be outside the build's - working directory, in which case the contents of the path may not be - persisted across build step executions, unless a `volume` for that - path is specified. If the build specifies a `RepoSource` with `dir` - and a step with a `dir`, which specifies an absolute path, the - `RepoSource` `dir` is ignored for the step's execution. - exitCode: - type: integer - format: int32 - description: Output only. Return code from running the step. - readOnly: true - ContaineranalysisGoogleDevtoolsCloudbuildV1Artifacts: - properties: - objects: - description: >- - A list of objects to be uploaded to Cloud Storage upon successful - completion of all build steps. Files in the workspace matching - specified paths globs will be uploaded to the specified Cloud - Storage location using the builder service account's credentials. - The location and generation of the uploaded objects will be stored - in the Build resource's results field. If any objects fail to be - pushed, the build is marked FAILURE. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsArtifactObjects - npmPackages: - items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsNpmPackage - description: >- - A list of npm packages to be uploaded to Artifact Registry upon - successful completion of all build steps. Npm packages in the - specified paths will be uploaded to the specified Artifact Registry - repository using the builder service account's credentials. If any - packages fail to be pushed, the build is marked FAILURE. - type: array - pythonPackages: - description: >- - A list of Python packages to be uploaded to Artifact Registry upon - successful completion of all build steps. The build service account - credentials will be used to perform the upload. If any objects fail - to be pushed, the build is marked FAILURE. - type: array - items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsPythonPackage - mavenArtifacts: - description: >- - A list of Maven artifacts to be uploaded to Artifact Registry upon - successful completion of all build steps. Artifacts in the workspace - matching specified paths globs will be uploaded to the specified - Artifact Registry repository using the builder service account's - credentials. If any artifacts fail to be pushed, the build is marked - FAILURE. - items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsMavenArtifact - type: array - images: - description: >- - A list of images to be pushed upon the successful completion of all - build steps. The images will be pushed using the builder service - account's credentials. The digests of the pushed images will be - stored in the Build resource's results field. If any of the images - fail to be pushed, the build is marked FAILURE. + Any other builder-controlled inputs necessary for correctly + evaluating the recipe. Usually only needed for reproducing the build + but not evaluated as part of policy. Since the environment field can + greatly vary in structure, depending on the builder and recipe type, + this is of form "Any". type: array items: - type: string - id: ContaineranalysisGoogleDevtoolsCloudbuildV1Artifacts - description: >- - Artifacts produced by a build that should be uploaded upon successful - completion of all build steps. - type: object - ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalResult: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + Metadata: + id: Metadata + description: Other properties of the build. type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalResult properties: - decision: - description: Required. The decision of this manual approval. - enumDescriptions: - - Default enum type. This should not be used. - - Build is approved. - - Build is rejected. - type: string - enum: - - DECISION_UNSPECIFIED - - APPROVED - - REJECTED - url: + buildInvocationId: description: >- - Optional. An optional URL tied to this manual approval result. This - field is essentially the same as comment, except that it will be - rendered by the UI differently. An example use case is a link to an - external job that approved this Build. - type: string - approverAccount: - readOnly: true + Identifies the particular build invocation, which can be useful for + finding associated logs or other ad-hoc analysis. The value SHOULD + be globally unique, per in-toto Provenance spec. type: string - description: >- - Output only. Email of the user that called the ApproveBuild API to - approve or reject a build at the time that the API was called. - approvalTime: - description: Output only. The time when the approval decision was made. + buildStartedOn: + description: The timestamp of when the build started. type: string format: google-datetime - readOnly: true - comment: - description: Optional. An optional comment for this manual approval result. - type: string - description: >- - ApprovalResult describes the decision and associated metadata of a - manual approval of a build. - ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource: - id: ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource - description: Location of the source in an archive file in Cloud Storage. - properties: - sourceFetcher: - enum: - - SOURCE_FETCHER_UNSPECIFIED - - GSUTIL - - GCS_FETCHER - enumDescriptions: - - Unspecified defaults to GSUTIL. - - Use the "gsutil" tool to download the source file. - - Use the Cloud Storage Fetcher tool to download the source file. - type: string - description: >- - Optional. Option to specify the tool to fetch the source file for - the build. - generation: - type: string - format: int64 - description: >- - Optional. Cloud Storage generation for the object. If the generation - is omitted, the latest generation will be used. - bucket: - description: >- - Cloud Storage bucket containing the source (see [Bucket Name - Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). - type: string - object: + buildFinishedOn: + description: The timestamp of when the build completed. type: string + format: google-datetime + completeness: description: >- - Required. Cloud Storage object containing the source. This object - must be a zipped (`.zip`) or gzipped archive file (`.tar.gz`) - containing source to build. - type: object - Category: - description: The category to which the update belongs. - type: object - id: Category - properties: - categoryId: - description: The identifier of the category. - type: string - name: - description: The localized name of the category. - type: string - DSSEHint: - properties: - humanReadableName: + Indicates that the builder claims certain fields in this message to + be complete. + $ref: '#/components/schemas/Completeness' + reproducible: description: >- - Required. The human readable name of this attestation authority, for - example "cloudbuild-prod". - type: string - description: >- - This submessage provides human-readable hints about the purpose of the - authority. Because the name of a note acts as its resource reference, it - is important to disambiguate the canonical name of the Note (which might - be a UUID for security purposes) from "readable" names more suitable for - debug output. Note that these hints should not be used to look up - authorities in security sensitive contexts, such as when looking up - attestations to verify. - type: object - id: DSSEHint + If true, the builder claims that running the recipe on materials + will produce bit-for-bit identical output. + type: boolean Completeness: + id: Completeness description: >- Indicates that the builder claims certain fields in this message to be complete. - id: Completeness + type: object properties: - materials: - type: boolean - description: >- - If true, the builder claims that materials are complete, usually - through some controls to prevent network access. Sometimes called - "hermetic". arguments: description: >- If true, the builder claims that recipe.arguments is complete, @@ -1391,2435 +1242,3080 @@ components: recipe. type: boolean environment: - type: boolean description: >- If true, the builder claims that recipe.environment is claimed to be complete. + type: boolean + materials: + description: >- + If true, the builder claims that materials are complete, usually + through some controls to prevent network access. Sometimes called + "hermetic". + type: boolean + InTotoStatement: + id: InTotoStatement + description: >- + Spec defined at + https://github.com/in-toto/attestation/tree/main/spec#statement The + serialized InTotoStatement will be stored as Envelope.payload. + Envelope.payloadType is always "application/vnd.in-toto+json". type: object - Publisher: - type: object - description: Publisher contains information about the publisher of this Note. - id: Publisher properties: - name: - description: 'Name of the publisher. Examples: ''Google'', ''Google Cloud Platform''.' + _type: + description: Always `https://in-toto.io/Statement/v0.1`. type: string - publisherNamespace: + subject: + type: array + items: + $ref: '#/components/schemas/Subject' + predicateType: + description: '`https://slsa.dev/provenance/v0.1` for SlsaProvenance.' type: string - description: >- - The context or namespace. Contains a URL which is under control of - the issuing party and can be used as a globally unique identifier - for that issuing party. Example: https://csaf.io - issuingAuthority: - description: >- - Provides information about the authority of the issuing party to - release the document, in particular, the party's constituency and - responsibilities or other obligations. - type: string - CVSS: + provenance: + $ref: '#/components/schemas/InTotoProvenance' + slsaProvenance: + $ref: '#/components/schemas/SlsaProvenance' + slsaProvenanceZeroTwo: + $ref: '#/components/schemas/SlsaProvenanceZeroTwo' + Subject: + id: Subject type: object - id: CVSS - description: >- - Common Vulnerability Scoring System. For details, see - https://www.first.org/cvss/specification-document This is a message we - will try to use for storing various versions of CVSS rather than making - a separate proto for storing a specific version. properties: - attackVector: + name: type: string - enum: - - ATTACK_VECTOR_UNSPECIFIED - - ATTACK_VECTOR_NETWORK - - ATTACK_VECTOR_ADJACENT - - ATTACK_VECTOR_LOCAL - - ATTACK_VECTOR_PHYSICAL + digest: description: >- - Base Metrics Represents the intrinsic characteristics of a - vulnerability that are constant over time and across user - environments. - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - availabilityImpact: - type: string - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - enum: - - IMPACT_UNSPECIFIED - - IMPACT_HIGH - - IMPACT_LOW - - IMPACT_NONE - - IMPACT_PARTIAL - - IMPACT_COMPLETE - exploitabilityScore: - type: number - format: float - impactScore: - format: float - type: number - scope: - type: string - enumDescriptions: - - '' - - '' - - '' - enum: - - SCOPE_UNSPECIFIED - - SCOPE_UNCHANGED - - SCOPE_CHANGED - authentication: - type: string - enumDescriptions: - - '' - - '' - - '' - - '' - enum: - - AUTHENTICATION_UNSPECIFIED - - AUTHENTICATION_MULTIPLE - - AUTHENTICATION_SINGLE - - AUTHENTICATION_NONE - userInteraction: - enumDescriptions: - - '' - - '' - - '' - enum: - - USER_INTERACTION_UNSPECIFIED - - USER_INTERACTION_NONE - - USER_INTERACTION_REQUIRED - type: string - privilegesRequired: - enum: - - PRIVILEGES_REQUIRED_UNSPECIFIED - - PRIVILEGES_REQUIRED_NONE - - PRIVILEGES_REQUIRED_LOW - - PRIVILEGES_REQUIRED_HIGH - type: string - enumDescriptions: - - '' - - '' - - '' - - '' - confidentialityImpact: - type: string - enum: - - IMPACT_UNSPECIFIED - - IMPACT_HIGH - - IMPACT_LOW - - IMPACT_NONE - - IMPACT_PARTIAL - - IMPACT_COMPLETE - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - attackComplexity: - enumDescriptions: - - '' - - '' - - '' - - '' - type: string - enum: - - ATTACK_COMPLEXITY_UNSPECIFIED - - ATTACK_COMPLEXITY_LOW - - ATTACK_COMPLEXITY_HIGH - - ATTACK_COMPLEXITY_MEDIUM - integrityImpact: - enum: - - IMPACT_UNSPECIFIED - - IMPACT_HIGH - - IMPACT_LOW - - IMPACT_NONE - - IMPACT_PARTIAL - - IMPACT_COMPLETE - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - type: string - baseScore: - description: The base score is a function of the base metric scores. - format: float - type: number - InTotoProvenance: - properties: - materials: - type: array - items: + `"": ""` Algorithms can be e.g. sha256, sha512 See + https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet + type: object + additionalProperties: type: string - description: >- - The collection of artifacts that influenced the build including - sources, dependencies, build tools, base images, and so on. This is - considered to be incomplete unless metadata.completeness.materials - is true. Unset or null is equivalent to empty. - builderConfig: + SlsaProvenance: + id: SlsaProvenance + type: object + properties: + builder: description: required - $ref: '#/components/schemas/BuilderConfig' - metadata: - $ref: '#/components/schemas/Metadata' + $ref: '#/components/schemas/SlsaBuilder' recipe: description: >- Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required - $ref: '#/components/schemas/Recipe' - id: InTotoProvenance - type: object - SlsaMetadata: - description: Other properties of the build. - id: SlsaMetadata - properties: - buildStartedOn: - type: string - format: google-datetime - description: The timestamp of when the build started. - buildFinishedOn: - description: The timestamp of when the build completed. - format: google-datetime - type: string - completeness: - $ref: '#/components/schemas/SlsaCompleteness' - description: >- - Indicates that the builder claims certain fields in this message to - be complete. - reproducible: - type: boolean - description: >- - If true, the builder claims that running the recipe on materials - will produce bit-for-bit identical output. - buildInvocationId: + $ref: '#/components/schemas/SlsaRecipe' + metadata: + $ref: '#/components/schemas/SlsaMetadata' + materials: description: >- - Identifies the particular build invocation, which can be useful for - finding associated logs or other ad-hoc analysis. The value SHOULD - be globally unique, per in-toto Provenance spec. - type: string - type: object + The collection of artifacts that influenced the build including + sources, dependencies, build tools, base images, and so on. This is + considered to be incomplete unless metadata.completeness.materials + is true. Unset or null is equivalent to empty. + type: array + items: + $ref: '#/components/schemas/Material' SlsaBuilder: + id: SlsaBuilder type: object properties: id: type: string - id: SlsaBuilder - WindowsUpdate: - id: WindowsUpdate - type: object + SlsaRecipe: + id: SlsaRecipe description: >- - Windows Update represents the metadata about the update for the Windows - operating system. The fields in this message come from the Windows - Update API documented at - https://docs.microsoft.com/en-us/windows/win32/api/wuapi/nn-wuapi-iupdate. + Steps taken to build the artifact. For a TaskRun, typically each + container corresponds to one step in the recipe. + type: object properties: - supportUrl: - description: The hyperlink to the support information for the update. + type: + description: >- + URI indicating what type of recipe was performed. It determines the + meaning of recipe.entryPoint, recipe.arguments, recipe.environment, + and materials. type: string - lastPublishedTimestamp: - format: google-datetime + definedInMaterial: + description: >- + Index in materials containing the recipe steps that are not implied + by recipe.type. For example, if the recipe type were "make", then + this would point to the source containing the Makefile, not the make + program itself. Set to -1 if the recipe doesn't come from a + material, as zero is default unset value for int64. type: string - description: The last published timestamp of the update. - identity: - description: Required - The unique identifier for the update. - $ref: '#/components/schemas/Identity' - categories: - items: - $ref: '#/components/schemas/Category' - description: The list of categories to which the update belongs. - type: array - description: - description: The localized description of the update. - type: string - kbArticleIds: - items: - type: string - type: array + format: int64 + entryPoint: description: >- - The Microsoft Knowledge Base article IDs that are associated with - the update. - title: + String identifying the entry point into the build. This is often a + path to a configuration file and/or a target label within that file. + The syntax and meaning are defined by recipe.type. For example, if + the recipe type were "make", then this would reference the directory + in which to run make as well as which target to use. type: string - description: The localized title of the update. - BatchCreateOccurrencesRequest: - description: Request to create occurrences in batch. - type: object - id: BatchCreateOccurrencesRequest - properties: - occurrences: - description: Required. The occurrences to create. Max allowed length is 1000. - items: - $ref: '#/components/schemas/Occurrence' - type: array - ContaineranalysisGoogleDevtoolsCloudbuildV1RepoSource: - properties: - substitutions: + arguments: + description: >- + Collection of all external inputs that influenced the build on top + of recipe.definedInMaterial and recipe.entryPoint. For example, if + the recipe type were "make", then this might be the flags passed to + make aside from the target, which is captured in recipe.entryPoint. + Depending on the recipe Type, the structure may be different. + type: object additionalProperties: - type: string + type: any + description: Properties of the object. Contains field @type with type URL. + environment: description: >- - Optional. Substitutions to use in a triggered build. Should only be - used with RunBuildTrigger + Any other builder-controlled inputs necessary for correctly + evaluating the recipe. Usually only needed for reproducing the build + but not evaluated as part of policy. Depending on the recipe Type, + the structure may be different. type: object - projectId: - type: string + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + SlsaMetadata: + id: SlsaMetadata + description: Other properties of the build. + type: object + properties: + buildInvocationId: description: >- - Optional. ID of the project that owns the Cloud Source Repository. - If omitted, the project ID requesting the build is assumed. - repoName: - description: Required. Name of the Cloud Source Repository. + Identifies the particular build invocation, which can be useful for + finding associated logs or other ad-hoc analysis. The value SHOULD + be globally unique, per in-toto Provenance spec. type: string - branchName: + buildStartedOn: + description: The timestamp of when the build started. + type: string + format: google-datetime + buildFinishedOn: + description: The timestamp of when the build completed. type: string + format: google-datetime + completeness: description: >- - Regex matching branches to build. The syntax of the regular - expressions accepted is the syntax accepted by RE2 and described at - https://github.com/google/re2/wiki/Syntax - invertRegex: + Indicates that the builder claims certain fields in this message to + be complete. + $ref: '#/components/schemas/SlsaCompleteness' + reproducible: description: >- - Optional. Only trigger a build if the revision regex does NOT match - the revision regex. + If true, the builder claims that running the recipe on materials + will produce bit-for-bit identical output. type: boolean - tagName: - type: string + SlsaCompleteness: + id: SlsaCompleteness + description: >- + Indicates that the builder claims certain fields in this message to be + complete. + type: object + properties: + arguments: description: >- - Regex matching tags to build. The syntax of the regular expressions - accepted is the syntax accepted by RE2 and described at - https://github.com/google/re2/wiki/Syntax - dir: + If true, the builder claims that recipe.arguments is complete, + meaning that all external inputs are properly captured in the + recipe. + type: boolean + environment: description: >- - Optional. Directory, relative to the source root, in which to run - the build. This must be a relative path. If a step's `dir` is - specified and is an absolute path, this value is ignored for that - step's execution. + If true, the builder claims that recipe.environment is claimed to be + complete. + type: boolean + materials: + description: >- + If true, the builder claims that materials are complete, usually + through some controls to prevent network access. Sometimes called + "hermetic". + type: boolean + Material: + id: Material + type: object + properties: + uri: type: string - commitSha: + digest: + type: object + additionalProperties: + type: string + SlsaProvenanceZeroTwo: + id: SlsaProvenanceZeroTwo + description: See full explanation of fields at slsa.dev/provenance/v0.2. + type: object + properties: + builder: + $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaBuilder' + buildType: type: string - description: Explicit commit SHA to build. - description: Location of the source in a Google Cloud Source Repository. + invocation: + $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaInvocation' + buildConfig: + type: object + additionalProperties: + type: any + description: Properties of the object. + metadata: + $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaMetadata' + materials: + type: array + items: + $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaMaterial' + GrafeasV1SlsaProvenanceZeroTwoSlsaBuilder: + id: GrafeasV1SlsaProvenanceZeroTwoSlsaBuilder + description: >- + Identifies the entity that executed the recipe, which is trusted to have + correctly performed the operation and populated this provenance. type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1RepoSource - GrafeasV1FileLocation: - id: GrafeasV1FileLocation - description: Indicates the location at which a package was found. properties: - filePath: + id: type: string - description: >- - For jars that are contained inside .war files, this filepath can - indicate the path to war file combined with the path to jar file. + GrafeasV1SlsaProvenanceZeroTwoSlsaInvocation: + id: GrafeasV1SlsaProvenanceZeroTwoSlsaInvocation + description: Identifies the event that kicked off the build. type: object - SourceContext: - id: SourceContext properties: - cloudRepo: - $ref: '#/components/schemas/CloudRepoSourceContext' - description: >- - A SourceContext referring to a revision in a Google Cloud Source - Repo. - labels: + configSource: + $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaConfigSource' + parameters: + type: object additionalProperties: - type: string - description: Labels with user defined metadata. + type: any + description: Properties of the object. + environment: type: object - git: - description: >- - A SourceContext referring to any third party Git repo (e.g., - GitHub). - $ref: '#/components/schemas/GitSourceContext' - gerrit: - $ref: '#/components/schemas/GerritSourceContext' - description: A SourceContext referring to a Gerrit project. - type: object + additionalProperties: + type: any + description: Properties of the object. + GrafeasV1SlsaProvenanceZeroTwoSlsaConfigSource: + id: GrafeasV1SlsaProvenanceZeroTwoSlsaConfigSource description: >- - A SourceContext is a reference to a tree of files. A SourceContext - together with a path point to a unique revision of a single file or - directory. - TimeSpan: + Describes where the config file that kicked off the build came from. + This is effectively a pointer to the source where buildConfig came from. + type: object properties: - startTime: + uri: type: string - format: google-datetime - description: Start of time span. - endTime: - format: google-datetime - description: End of time span. + digest: + type: object + additionalProperties: + type: string + entryPoint: type: string - description: 'Start and end times for a build execution phase. Next ID: 3' + GrafeasV1SlsaProvenanceZeroTwoSlsaMetadata: + id: GrafeasV1SlsaProvenanceZeroTwoSlsaMetadata + description: Other properties of the build. type: object - id: TimeSpan - ContaineranalysisGoogleDevtoolsCloudbuildV1Hash: properties: - type: + buildInvocationId: type: string - description: The type of hash that was performed. - enum: - - NONE - - SHA256 - - MD5 - - SHA512 - enumDescriptions: - - No hash requested. - - Use a sha256 hash. - - Use a md5 hash. - - Use a sha512 hash. - value: - description: The hash value. + buildStartedOn: type: string - format: byte - type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1Hash - description: Container message for hash values. - Status: - type: object - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). + format: google-datetime + buildFinishedOn: + type: string + format: google-datetime + completeness: + $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaCompleteness' + reproducible: + type: boolean + GrafeasV1SlsaProvenanceZeroTwoSlsaCompleteness: + id: GrafeasV1SlsaProvenanceZeroTwoSlsaCompleteness + description: >- + Indicates that the builder claims certain fields in this message to be + complete. + type: object properties: - message: - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. + parameters: + type: boolean + environment: + type: boolean + materials: + type: boolean + GrafeasV1SlsaProvenanceZeroTwoSlsaMaterial: + id: GrafeasV1SlsaProvenanceZeroTwoSlsaMaterial + description: >- + The collection of artifacts that influenced the build including sources, + dependencies, build tools, base images, and so on. + type: object + properties: + uri: type: string - details: + digest: + type: object + additionalProperties: + type: string + InTotoSlsaProvenanceV1: + id: InTotoSlsaProvenanceV1 + type: object + properties: + _type: description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. + InToto spec defined at + https://github.com/in-toto/attestation/tree/main/spec#statement + type: string + subject: type: array items: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - code: - format: int32 - type: integer - description: The status code, which should be an enum value of google.rpc.Code. - id: Status - ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSourceManifest: + $ref: '#/components/schemas/Subject' + predicateType: + type: string + predicate: + $ref: '#/components/schemas/SlsaProvenanceV1' + SlsaProvenanceV1: + id: SlsaProvenanceV1 + description: >- + Keep in sync with schema at + https://github.com/slsa-framework/slsa/blob/main/docs/provenance/schema/v1/provenance.proto + Builder renamed to ProvenanceBuilder because of Java conflicts. type: object properties: - object: - description: >- - Required. Cloud Storage object containing the source manifest. This - object must be a JSON file. + buildDefinition: + $ref: '#/components/schemas/BuildDefinition' + runDetails: + $ref: '#/components/schemas/RunDetails' + BuildDefinition: + id: BuildDefinition + type: object + properties: + buildType: type: string - bucket: - description: >- - Required. Cloud Storage bucket containing the source manifest (see - [Bucket Name - Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). + externalParameters: + type: object + additionalProperties: + type: any + description: Properties of the object. + internalParameters: + type: object + additionalProperties: + type: any + description: Properties of the object. + resolvedDependencies: + type: array + items: + $ref: '#/components/schemas/ResourceDescriptor' + ResourceDescriptor: + id: ResourceDescriptor + type: object + properties: + name: type: string - generation: - format: int64 - description: >- - Cloud Storage generation for the object. If the generation is - omitted, the latest generation will be used. + uri: type: string - id: ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSourceManifest - description: >- - Location of the source manifest in Cloud Storage. This feature is in - Preview; see description - [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher). - VulnerabilityAssessmentNote: - id: VulnerabilityAssessmentNote - properties: - product: - description: The product affected by this vex. - $ref: '#/components/schemas/Product' - title: + digest: + type: object + additionalProperties: + type: string + content: type: string - description: The title of the note. E.g. `Vex-Debian-11.4` - shortDescription: - description: A one sentence description of this Vex. + format: byte + downloadLocation: type: string - languageCode: - description: >- - Identifies the language used by this document, corresponding to IETF - BCP 47 / RFC 5646. + mediaType: type: string - publisher: - description: Publisher details of this Note. - $ref: '#/components/schemas/Publisher' - longDescription: + annotations: + type: object + additionalProperties: + type: any + RunDetails: + id: RunDetails + type: object + properties: + builder: + $ref: '#/components/schemas/ProvenanceBuilder' + metadata: + $ref: '#/components/schemas/BuildMetadata' + byproducts: + type: array + items: + $ref: '#/components/schemas/ResourceDescriptor' + ProvenanceBuilder: + id: ProvenanceBuilder + type: object + properties: + id: type: string - description: A detailed description of this Vex. - assessment: - $ref: '#/components/schemas/Assessment' - description: Represents a vulnerability assessment for the product. + version: + type: object + additionalProperties: + type: string + builderDependencies: + type: array + items: + $ref: '#/components/schemas/ResourceDescriptor' + BuildMetadata: + id: BuildMetadata type: object + properties: + invocationId: + type: string + startedOn: + type: string + format: google-datetime + finishedOn: + type: string + format: google-datetime + ImageOccurrence: + id: ImageOccurrence description: >- - A single VulnerabilityAssessmentNote represents one particular product's - vulnerability assessment for one CVE. - VexAssessment: - id: VexAssessment - description: >- - VexAssessment provides all publisher provided Vex information that is - related to this vulnerability. + Details of the derived image portion of the DockerImage relationship. + This image would be produced from a Dockerfile with FROM . type: object properties: - justification: - $ref: '#/components/schemas/Justification' + fingerprint: + description: Required. The fingerprint of the derived image. + $ref: '#/components/schemas/Fingerprint' + distance: description: >- - Justification provides the justification when the state of the - assessment if NOT_AFFECTED. - remediations: + Output only. The number of layers by which this image differs from + the associated image basis. + type: integer + format: int32 + layerInfo: + description: >- + This contains layer-specific metadata, if populated it has length + "distance" and is ordered with [distance] being the layer + immediately following the base image and [1] being the final layer. type: array items: - $ref: '#/components/schemas/Remediation' + $ref: '#/components/schemas/Layer' + baseResourceUrl: description: >- - Specifies details on how to handle (and presumably, fix) a - vulnerability. - noteName: + Output only. This contains the base image URL for the derived image + occurrence. type: string + Fingerprint: + id: Fingerprint + description: A set of properties that uniquely identify a given Docker image. + type: object + properties: + v1Name: description: >- - The VulnerabilityAssessment note from which this VexAssessment was - generated. This will be of the form: - `projects/[PROJECT_ID]/notes/[NOTE_ID]`. - vulnerabilityId: + Required. The layer ID of the final layer in the Docker image's v1 + representation. type: string + v2Blob: + description: Required. The ordered list of v2 blobs that represent a given image. + type: array + items: + type: string + v2Name: description: >- - The vulnerability identifier for this Assessment. Will hold one of - common identifiers e.g. CVE, GHSA etc. - state: - enumDescriptions: - - No state is specified. - - This product is known to be affected by this vulnerability. - - This product is known to be not affected by this vulnerability. - - This product contains a fix for this vulnerability. - - >- - It is not known yet whether these versions are or are not affected - by the vulnerability. However, it is still under investigation. - description: Provides the state of this Vulnerability assessment. - enum: - - STATE_UNSPECIFIED - - AFFECTED - - NOT_AFFECTED - - FIXED - - UNDER_INVESTIGATION - type: string - impacts: - description: >- - Contains information about the impact of this vulnerability, this - will change with time. - items: - type: string - type: array - cve: - deprecated: true - description: >- - Holds the MITRE standard Common Vulnerabilities and Exposures (CVE) - tracking number for the vulnerability. Deprecated: Use - vulnerability_id instead to denote CVEs. + Output only. The name of the image's v2 blobs computed via: [bottom] + := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the + name of the final blob is kept. type: string - relatedUris: - items: - $ref: '#/components/schemas/RelatedUrl' - description: >- - Holds a list of references associated with this vulnerability item - and assessment. - type: array - Signature: - id: Signature + Layer: + id: Layer + description: Layer holds metadata specific to a layer of a Docker image. type: object properties: - signature: - type: string - format: byte + directive: description: >- - The content of the signature, an opaque bytestring. The payload that - this signature verifies MUST be unambiguously provided with the - Signature during verification. A wrapper message might provide the - payload explicitly. Alternatively, a message might have a canonical - serialization that can always be unambiguously computed to derive - the payload. - publicKeyId: + Required. The recovered Dockerfile directive used to construct this + layer. See https://docs.docker.com/engine/reference/builder/ for + more information. type: string - description: >- - The identifier for the public key that verifies this signature. * - The `public_key_id` is required. * The `public_key_id` SHOULD be an - RFC3986 conformant URI. * When possible, the `public_key_id` SHOULD - be an immutable reference, such as a cryptographic digest. Examples - of valid `public_key_id`s: OpenPGP V4 public key fingerprint: * - "openpgp4fpr:74FAF3B861BDA0870C7B6DEF607E48D2A663AEEA" See - https://www.iana.org/assignments/uri-schemes/prov/openpgp4fpr for - more details on this scheme. RFC6920 digest-named - SubjectPublicKeyInfo (digest of the DER serialization): * - "ni:///sha-256;cD9o9Cq6LG3jD0iKXqEi_vdjJGecm_iXkbqVoScViaU" * - "nih:///sha-256;703f68f42aba2c6de30f488a5ea122fef76324679c9bf89791ba95a1271589a5" - description: >- - Verifiers (e.g. Kritis implementations) MUST verify signatures with - respect to the trust anchors defined in policy (e.g. a Kritis policy). - Typically this means that the verifier has been configured with a map - from `public_key_id` to public key material (and any required - parameters, e.g. signing algorithm). In particular, verification - implementations MUST NOT treat the signature `public_key_id` as anything - more than a key lookup hint. The `public_key_id` DOES NOT validate or - authenticate a public key; it only provides a mechanism for quickly - selecting a public key ALREADY CONFIGURED on the verifier through a - trusted channel. Verification implementations MUST reject signatures in - any of the following circumstances: * The `public_key_id` is not - recognized by the verifier. * The public key that `public_key_id` refers - to does not verify the signature with respect to the payload. The - `signature` contents SHOULD NOT be "attached" (where the payload is - included with the serialized `signature` bytes). Verifiers MUST ignore - any "attached" payload and only verify signatures with respect to - explicitly provided payload (e.g. a `payload` field on the proto message - that holds this Signature, or the canonical serialization of the proto - message that holds this signature). - ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan: - description: Start and end times for a build execution phase. + arguments: + description: The recovered arguments to the Dockerfile directive. + type: string + PackageOccurrence: + id: PackageOccurrence + description: Details on how a particular software package was installed on a system. type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan properties: - endTime: - description: End of time span. - format: google-datetime + name: + description: Required. Output only. The name of the installed package. + readOnly: true type: string - startTime: - format: google-datetime - description: Start of time span. + location: + description: >- + All of the places within the filesystem versions of this package + have been found. + type: array + items: + $ref: '#/components/schemas/Location' + packageType: + description: >- + Output only. The type of package; whether native or non native + (e.g., ruby gems, node.js packages, etc.). + readOnly: true type: string - ImageNote: - properties: - fingerprint: - $ref: '#/components/schemas/Fingerprint' - description: Required. Immutable. The fingerprint of the base image. - resourceUrl: + cpeUri: + description: >- + Output only. The cpe_uri in [CPE + format](https://cpe.mitre.org/specification/) denoting the package + manager version distributing a package. The cpe_uri will be blank + for language packages. + readOnly: true type: string + architecture: description: >- - Required. Immutable. The resource_url for the resource representing - the basis of associated occurrence images. + Output only. The CPU architecture for which packages in this + distribution channel were built. Architecture will be blank for + language packages. + readOnly: true + type: string + enumDescriptions: + - Unknown architecture. + - X86 architecture. + - X64 architecture. + enum: + - ARCHITECTURE_UNSPECIFIED + - X86 + - X64 + license: + description: Licenses that have been declared by the authors of the package. + $ref: '#/components/schemas/License' + version: + description: Output only. The version of the package. + readOnly: true + $ref: '#/components/schemas/Version' + Location: + id: Location description: >- - Basis describes the base image portion (Note) of the DockerImage - relationship. Linked occurrences are derived from this or an equivalent - image via: FROM Or an equivalent reference, e.g., a tag of the - resource_url. - type: object - id: ImageNote - SbomReferenceIntotoPredicate: + An occurrence of a particular package installation found within a + system's filesystem. E.g., glibc was found in `/var/lib/dpkg/status`. type: object - id: SbomReferenceIntotoPredicate - description: A predicate which describes the SBOM being referenced. properties: - referrerId: - description: The person or system referring this predicate to the consumer. - type: string - location: - description: The location of the SBOM. + cpeUri: + description: >- + Deprecated. The CPE URI in [CPE + format](https://cpe.mitre.org/specification/) type: string - digest: - type: object - description: A map of algorithm to digest of the contents of the SBOM. - additionalProperties: - type: string - mimeType: + version: + description: Deprecated. The version installed at this location. + $ref: '#/components/schemas/Version' + path: + description: >- + The path from which we gathered that this package/version is + installed. type: string - description: The mime type of the SBOM. - SetIamPolicyRequest: + License: + id: License + description: License information. type: object - id: SetIamPolicyRequest - properties: - policy: - $ref: '#/components/schemas/Policy' - description: >- - REQUIRED: The complete policy to be applied to the `resource`. The - size of the policy is limited to a few 10s of KB. An empty policy is - a valid policy but certain Google Cloud services (such as Projects) - might reject them. - description: Request message for `SetIamPolicy` method. - ContaineranalysisGoogleDevtoolsCloudbuildV1DeveloperConnectConfig: properties: - gitRepositoryLink: - type: string - description: >- - Required. The Developer Connect Git repository link, formatted as - `projects/*/locations/*/connections/*/gitRepositoryLink/*`. - revision: + expression: description: >- - Required. The revision to fetch from the Git repository such as a - branch, a tag, a commit SHA, or any Git ref. + Often a single license can be used to represent the licensing terms. + Sometimes it is necessary to include a choice of one or more + licenses or some combination of license identifiers. Examples: + "LGPL-2.1-only OR MIT", "LGPL-2.1-only AND MIT", "GPL-2.0-or-later + WITH Bison-exception-2.2". type: string - dir: + comments: + description: Comments type: string - description: >- - Required. Directory, relative to the source root, in which to run - the build. + DeploymentOccurrence: + id: DeploymentOccurrence + description: The period during which some deployable was active in a runtime. type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1DeveloperConnectConfig - description: This config defines the location of a source through Developer Connect. - EnvelopeSignature: properties: - keyid: + userEmail: + description: Identity of the user that triggered this deployment. type: string - sig: - format: byte + deployTime: + description: Required. Beginning of the lifetime of this deployment. type: string - id: EnvelopeSignature - type: object - TestIamPermissionsResponse: - description: Response message for `TestIamPermissions` method. - id: TestIamPermissionsResponse - type: object - properties: - permissions: - type: array - description: >- - A subset of `TestPermissionsRequest.permissions` that the caller is - allowed. - items: - type: string - InTotoStatement: - properties: - _type: + format: google-datetime + undeployTime: + description: End of the lifetime of this deployment. type: string - description: Always `https://in-toto.io/Statement/v0.1`. - slsaProvenance: - $ref: '#/components/schemas/SlsaProvenance' - subject: + format: google-datetime + config: + description: Configuration used to create this deployment. + type: string + address: + description: Address of the runtime element hosting this deployment. + type: string + resourceUri: + description: >- + Output only. Resource URI for the artifact being deployed taken from + the deployable field with the same name. type: array items: - $ref: '#/components/schemas/Subject' - slsaProvenanceZeroTwo: - $ref: '#/components/schemas/SlsaProvenanceZeroTwo' - predicateType: - description: '`https://slsa.dev/provenance/v0.1` for SlsaProvenance.' + type: string + platform: + description: Platform hosting this deployment. type: string - provenance: - $ref: '#/components/schemas/InTotoProvenance' - id: InTotoStatement - description: >- - Spec defined at - https://github.com/in-toto/attestation/tree/main/spec#statement The - serialized InTotoStatement will be stored as Envelope.payload. - Envelope.payloadType is always "application/vnd.in-toto+json". + enumDescriptions: + - Unknown. + - Google Container Engine. + - 'Google App Engine: Flexible Environment.' + - Custom user-defined platform. + enum: + - PLATFORM_UNSPECIFIED + - GKE + - FLEX + - CUSTOM + DiscoveryOccurrence: + id: DiscoveryOccurrence + description: Provides information about the analysis status of a discovered resource. type: object - Volume: properties: - path: + continuousAnalysis: + description: Whether the resource is continuously analyzed. type: string - description: >- - Path at which to mount the volume. Paths must be absolute and cannot - conflict with other volume paths on the same build step or with - certain reserved volume paths. - name: + enumDescriptions: + - Unknown. + - The resource is continuously analyzed. + - The resource is ignored for continuous analysis. + enum: + - CONTINUOUS_ANALYSIS_UNSPECIFIED + - ACTIVE + - INACTIVE + analysisStatus: + description: The status of discovery for the resource. type: string + enumDescriptions: + - Unknown. + - Resource is known but no action has been taken yet. + - Resource is being analyzed. + - Analysis has finished successfully. + - Analysis has completed. + - >- + Analysis has finished unsuccessfully, the analysis itself is in a + bad state. + - The resource is known not to be supported. + enum: + - ANALYSIS_STATUS_UNSPECIFIED + - PENDING + - SCANNING + - FINISHED_SUCCESS + - COMPLETE + - FINISHED_FAILED + - FINISHED_UNSUPPORTED + analysisCompleted: + $ref: '#/components/schemas/AnalysisCompleted' + analysisError: description: >- - Name of the volume to mount. Volume names must be unique per build - step and must be valid names for Docker volumes. Each named volume - must be used by at least two build steps. - id: Volume - type: object - description: >- - Volume describes a Docker container volume which is mounted into build - steps in order to persist files across build step execution. Next ID: 3 - Command: - type: object - description: Command describes a step performed as part of the build pipeline. - id: Command - properties: - waitFor: - type: array - description: The ID(s) of the command(s) that this command depends on. - items: - type: string - env: - type: array - items: - type: string - description: Environment variables set before running this command. - args: + Indicates any errors encountered during analysis of a resource. + There could be 0 or more of these errors. type: array items: - type: string - description: Command-line arguments used when executing this command. - id: - description: >- - Optional unique identifier for this command, used in wait_for to - reference this command as a dependency. - type: string - dir: + $ref: '#/components/schemas/Status' + analysisStatusError: description: >- - Working directory (relative to project source root) used when - running this command. + When an error is encountered this will contain a LocalizedMessage + under details to show to the user. The LocalizedMessage is output + only and populated by the API. + $ref: '#/components/schemas/Status' + cpe: + description: The CPE of the resource being scanned. type: string - name: + lastScanTime: + description: The last time this resource was scanned. type: string + format: google-datetime + archiveTime: description: >- - Required. Name of the command, as presented on the command line, or - if the command is packaged as a Docker container, as presented to - `docker pull`. - Artifact: - id: Artifact + Output only. The time occurrences related to this discovery + occurrence were archived. + readOnly: true + type: string + format: google-datetime + sbomStatus: + description: The status of an SBOM generation. + $ref: '#/components/schemas/SBOMStatus' + files: + description: Files that make up the resource described by the occurrence. + type: array + items: + $ref: '#/components/schemas/File' + AnalysisCompleted: + id: AnalysisCompleted + description: >- + Indicates which analysis completed successfully. Multiple types of + analysis can be performed on a single resource. + type: object properties: - names: + analysisType: + type: array items: type: string + Status: + id: Status + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + type: object + properties: + code: + description: The status code, which should be an enum value of google.rpc.Code. + type: integer + format: int32 + message: description: >- - Related artifact names. This may be the path to a binary or jar - file, or in the case of a container build, the name used to push the - container image to Google Container Registry, as presented to - `docker push`. Note that a single Artifact ID can have multiple - names, for example if two tags are applied to one image. - type: array - id: + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. type: string + details: description: >- - Artifact ID, if any; for container images, this will be a URL by - digest like `gcr.io/projectID/imagename@sha256:123456`. - checksum: + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + type: array + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + SBOMStatus: + id: SBOMStatus + description: The status of an SBOM generation. + type: object + properties: + sbomState: + description: The progress of the SBOM generation. type: string + enumDescriptions: + - Default unknown state. + - SBOM scanning is pending. + - SBOM scanning has completed. + enum: + - SBOM_STATE_UNSPECIFIED + - PENDING + - COMPLETE + error: description: >- - Hash or checksum value of a binary, or Docker Registry 2.0 digest of - a container. - description: Artifact describes a build product. - type: object - ProjectRepoId: + If there was an error generating an SBOM, this will indicate what + that error was. + type: string + File: + id: File type: object properties: - projectId: - type: string - description: The ID of the project. - repoName: - description: The name of the repo. Leave empty for the default repo. + name: type: string - id: ProjectRepoId + digest: + type: object + additionalProperties: + type: string + AttestationOccurrence: + id: AttestationOccurrence description: >- - Selects a repo using a Google Cloud Platform project ID (e.g., - winged-cargo-31) and a repo name within that project. - Expr: + Occurrence that represents a single "attestation". The authenticity of + an attestation can be verified using the attached signature. If the + verifier trusts the public key of the signer, then verifying the + signature is sufficient to establish trust. In this circumstance, the + authority to which this attestation is attached is primarily useful for + lookup (how to find this attestation if you already know the authority + and artifact to be verified) and intent (for which authority this + attestation was intended to sign. + type: object properties: - description: + serializedPayload: 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 - title: + Required. The serialized payload that is verified by one or more + `signatures`. type: string + format: byte + signatures: 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. - location: + One or more signatures over `serialized_payload`. Verifier + implementations should consider this attestation message verified if + at least one `signature` verifies `serialized_payload`. See + `Signature` in common.proto for more details on signature structure + and verification. + type: array + items: + $ref: '#/components/schemas/Signature' + jwts: 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 - expression: + One or more JWTs encoding a self-contained attestation. Each JWT + encodes the payload that it verifies within the JWT itself. Verifier + implementation SHOULD ignore the `serialized_payload` field when + verifying these JWTs. If only JWTs are present on this + AttestationOccurrence, then the `serialized_payload` SHOULD be left + empty. Each JWT SHOULD encode a claim specific to the `resource_uri` + of this Occurrence, but this is not validated by Grafeas metadata + API implementations. The JWT itself is opaque to Grafeas. + type: array + items: + $ref: '#/components/schemas/Jwt' + Signature: + id: Signature + description: >- + Verifiers (e.g. Kritis implementations) MUST verify signatures with + respect to the trust anchors defined in policy (e.g. a Kritis policy). + Typically this means that the verifier has been configured with a map + from `public_key_id` to public key material (and any required + parameters, e.g. signing algorithm). In particular, verification + implementations MUST NOT treat the signature `public_key_id` as anything + more than a key lookup hint. The `public_key_id` DOES NOT validate or + authenticate a public key; it only provides a mechanism for quickly + selecting a public key ALREADY CONFIGURED on the verifier through a + trusted channel. Verification implementations MUST reject signatures in + any of the following circumstances: * The `public_key_id` is not + recognized by the verifier. * The public key that `public_key_id` refers + to does not verify the signature with respect to the payload. The + `signature` contents SHOULD NOT be "attached" (where the payload is + included with the serialized `signature` bytes). Verifiers MUST ignore + any "attached" payload and only verify signatures with respect to + explicitly provided payload (e.g. a `payload` field on the proto message + that holds this Signature, or the canonical serialization of the proto + message that holds this signature). + type: object + properties: + signature: + description: >- + The content of the signature, an opaque bytestring. The payload that + this signature verifies MUST be unambiguously provided with the + Signature during verification. A wrapper message might provide the + payload explicitly. Alternatively, a message might have a canonical + serialization that can always be unambiguously computed to derive + the payload. type: string + format: byte + publicKeyId: description: >- - Textual representation of an expression in Common Expression - Language syntax. + The identifier for the public key that verifies this signature. * + The `public_key_id` is required. * The `public_key_id` SHOULD be an + RFC3986 conformant URI. * When possible, the `public_key_id` SHOULD + be an immutable reference, such as a cryptographic digest. Examples + of valid `public_key_id`s: OpenPGP V4 public key fingerprint: * + "openpgp4fpr:74FAF3B861BDA0870C7B6DEF607E48D2A663AEEA" See + https://www.iana.org/assignments/uri-schemes/prov/openpgp4fpr for + more details on this scheme. RFC6920 digest-named + SubjectPublicKeyInfo (digest of the DER serialization): * + "ni:///sha-256;cD9o9Cq6LG3jD0iKXqEi_vdjJGecm_iXkbqVoScViaU" * + "nih:///sha-256;703f68f42aba2c6de30f488a5ea122fef76324679c9bf89791ba95a1271589a5" + type: string + Jwt: + id: Jwt type: object - id: 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. - ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedNpmPackage: + properties: + compactJwt: + description: >- + The compact encoding of a JWS, which is always three base64 encoded + strings joined by periods. For details, see: + https://tools.ietf.org/html/rfc7515.html#section-3.1 + type: string + UpgradeOccurrence: + id: UpgradeOccurrence description: >- - An npm package uploaded to Artifact Registry using the NpmPackage - directive. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedNpmPackage + An Upgrade Occurrence represents that a specific resource_url could + install a specific upgrade. This presence is supplied via local sources + (i.e. it is present in the mirror and the running system has noticed its + availability). For Windows, both distribution and windows_update contain + information for the Windows update. type: object properties: - uri: - description: URI of the uploaded npm package. + package: + description: Required for non-Windows OS. The package this Upgrade is for. type: string - fileHashes: - description: Hash types and values of the npm package. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes - pushTiming: - readOnly: true - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan + parsedVersion: description: >- - Output only. Stores timing information for pushing the specified - artifact. - VulnerabilityOccurrencesSummary: + Required for non-Windows OS. The version of the package in a machine + + human readable form. + $ref: '#/components/schemas/Version' + distribution: + description: >- + Metadata about the upgrade for available for the specific operating + system for the resource_url. This allows efficient filtering, as + well as making it easier to use the occurrence. + $ref: '#/components/schemas/UpgradeDistribution' + windowsUpdate: + description: >- + Required for Windows OS. Represents the metadata about the Windows + update. + $ref: '#/components/schemas/WindowsUpdate' + UpgradeDistribution: + id: UpgradeDistribution description: >- - A summary of how many vulnerability occurrences there are per resource - and severity type. + The Upgrade Distribution represents metadata about the Upgrade for each + operating system (CPE). Some distributions have additional metadata + around updates, classifying them into various categories and severities. + type: object properties: - counts: + cpeUri: description: >- - A listing by resource of the number of fixable and total - vulnerabilities. + Required - The specific operating system this metadata applies to. + See https://cpe.mitre.org/specification/. + type: string + classification: + description: >- + The operating system classification of this Upgrade, as specified by + the upstream operating system upgrade feed. For Windows the + classification is one of the category_ids listed at + https://docs.microsoft.com/en-us/previous-versions/windows/desktop/ff357803(v=vs.85) + type: string + severity: + description: The severity as specified by the upstream operating system. + type: string + cve: + description: The cve tied to this Upgrade. type: array items: - $ref: '#/components/schemas/FixableTotalByDigest' + type: string + WindowsUpdate: + id: WindowsUpdate + description: >- + Windows Update represents the metadata about the update for the Windows + operating system. The fields in this message come from the Windows + Update API documented at + https://docs.microsoft.com/en-us/windows/win32/api/wuapi/nn-wuapi-iupdate. type: object - id: VulnerabilityOccurrencesSummary - ContaineranalysisGoogleDevtoolsCloudbuildV1BuildFailureInfo: properties: - type: + identity: + description: Required - The unique identifier for the update. + $ref: '#/components/schemas/Identity' + title: + description: The localized title of the update. type: string - enum: - - FAILURE_TYPE_UNSPECIFIED - - PUSH_FAILED - - PUSH_IMAGE_NOT_FOUND - - PUSH_NOT_AUTHORIZED - - LOGGING_FAILURE - - USER_BUILD_STEP - - FETCH_SOURCE_FAILED - description: The name of the failure. - enumDescriptions: - - Type unspecified - - Unable to push the image to the repository. - - Final image not found. - - Unauthorized push of the final image. - - Backend logging failures. Should retry. - - A build step has failed. - - The source fetching has failed. - detail: - description: Explains the failure issue in more detail using hard-coded text. + description: + description: The localized description of the update. + type: string + categories: + description: The list of categories to which the update belongs. + type: array + items: + $ref: '#/components/schemas/Category' + kbArticleIds: + description: >- + The Microsoft Knowledge Base article IDs that are associated with + the update. + type: array + items: + type: string + supportUrl: + description: The hyperlink to the support information for the update. + type: string + lastPublishedTimestamp: + description: The last published timestamp of the update. type: string + format: google-datetime + Identity: + id: Identity + description: The unique identifier of the update. type: object - description: A fatal problem encountered during the execution of the build. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildFailureInfo - Occurrence: + properties: + updateId: + description: The revision independent identifier of the update. + type: string + revision: + description: The revision number of the update. + type: integer + format: int32 + Category: + id: Category + description: The category to which the update belongs. type: object - id: Occurrence - description: An instance of an analysis type that has been found on a resource. properties: - envelope: - description: https://github.com/secure-systems-lab/dsse - $ref: '#/components/schemas/Envelope' - build: - $ref: '#/components/schemas/BuildOccurrence' - description: Describes a verifiable build. - image: - $ref: '#/components/schemas/ImageOccurrence' - description: >- - Describes how this resource derives from the basis in the associated - note. - deployment: - $ref: '#/components/schemas/DeploymentOccurrence' - description: Describes the deployment of an artifact on a runtime. - compliance: - $ref: '#/components/schemas/ComplianceOccurrence' - description: Describes a compliance violation on a linked resource. - kind: - description: >- - Output only. This explicitly denotes which of the occurrence details - are specified. This field can be used as a filter in list requests. - enumDescriptions: - - Default value. This value is unused. - - The note and occurrence represent a package vulnerability. - - The note and occurrence assert build provenance. - - This represents an image basis relationship. - - This represents a package installed via a package manager. - - The note and occurrence track deployment events. - - >- - The note and occurrence track the initial discovery status of a - resource. - - This represents a logical "role" that can attest to artifacts. - - This represents an available package upgrade. - - This represents a Compliance Note - - This represents a DSSE attestation Note - - This represents a Vulnerability Assessment. - - This represents an SBOM Reference. - type: string - enum: - - NOTE_KIND_UNSPECIFIED - - VULNERABILITY - - BUILD - - IMAGE - - PACKAGE - - DEPLOYMENT - - DISCOVERY - - ATTESTATION - - UPGRADE - - COMPLIANCE - - DSSE_ATTESTATION - - VULNERABILITY_ASSESSMENT - - SBOM_REFERENCE - vulnerability: - description: Describes a security vulnerability. - $ref: '#/components/schemas/VulnerabilityOccurrence' - remediation: - type: string - description: A description of actions that can be taken to remedy the note. - attestation: - $ref: '#/components/schemas/AttestationOccurrence' - description: Describes an attestation of an artifact. - package: - $ref: '#/components/schemas/PackageOccurrence' - description: Describes the installation of a package on the linked resource. - upgrade: - description: Describes an available package upgrade on the linked resource. - $ref: '#/components/schemas/UpgradeOccurrence' - resourceUri: - description: >- - Required. Immutable. A URI that represents the resource for which - the occurrence applies. For example, - `https://gcr.io/project/image@sha256:123abc` for a Docker image. - type: string - dsseAttestation: - description: Describes an attestation of an artifact using dsse. - $ref: '#/components/schemas/DSSEAttestationOccurrence' - noteName: - description: >- - Required. Immutable. The analysis note associated with this - occurrence, in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. - This field can be used as a filter in list requests. - type: string - updateTime: - description: Output only. The time this occurrence was last updated. - format: google-datetime - type: string - discovery: - $ref: '#/components/schemas/DiscoveryOccurrence' - description: Describes when a resource was discovered. - createTime: - description: Output only. The time this occurrence was created. - format: google-datetime + categoryId: + description: The identifier of the category. type: string - sbomReference: - description: Describes a specific SBOM reference occurrences. - $ref: '#/components/schemas/SBOMReferenceOccurrence' name: + description: The localized name of the category. type: string - description: >- - Output only. The name of the occurrence in the form of - `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. - ContaineranalysisGoogleDevtoolsCloudbuildV1Results: + ComplianceOccurrence: + id: ComplianceOccurrence + description: >- + An indication that the compliance checks in the associated + ComplianceNote were not satisfied for particular resources or a + specified reason. + type: object properties: - mavenArtifacts: - type: array - items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedMavenArtifact - description: >- - Maven artifacts uploaded to Artifact Registry at the end of the - build. - artifactManifest: - type: string - description: >- - Path to the artifact manifest for non-container artifacts uploaded - to Cloud Storage. Only populated when artifacts are uploaded to - Cloud Storage. - npmPackages: - description: Npm packages uploaded to Artifact Registry at the end of the build. - type: array - items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedNpmPackage - artifactTiming: - description: Time to push all non-container artifacts to Cloud Storage. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan - buildStepOutputs: - description: >- - List of build step outputs, produced by builder images, in the order - corresponding to build step indices. [Cloud - Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) - can produce this output by writing to `$BUILDER_OUTPUT/output`. Only - the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` - variable is read-only and can't be substituted. + nonCompliantFiles: type: array items: - type: string - format: byte - images: - description: Container images that were built as a part of the build. - items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuiltImage - type: array - numArtifacts: + $ref: '#/components/schemas/NonCompliantFile' + nonComplianceReason: type: string - description: >- - Number of non-container artifacts uploaded to Cloud Storage. Only - populated when artifacts are uploaded to Cloud Storage. - format: int64 - buildStepImages: - description: >- - List of build step digests, in the order corresponding to build step - indices. - type: array - items: - type: string - pythonPackages: - description: >- - Python artifacts uploaded to Artifact Registry at the end of the - build. - type: array - items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedPythonPackage - description: Artifacts created by the build pipeline. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1Results - type: object - Location: + version: + description: The OS and config version the benchmark was run on. + $ref: '#/components/schemas/ComplianceVersion' + NonCompliantFile: + id: NonCompliantFile description: >- - An occurrence of a particular package installation found within a - system's filesystem. E.g., glibc was found in `/var/lib/dpkg/status`. + Details about files that caused a compliance check to fail. + display_command is a single command that can be used to display a list + of non compliant files. When there is no such command, we can also + iterate a list of non compliant file using 'path'. type: object properties: path: - description: >- - The path from which we gathered that this package/version is - installed. + description: Empty if `display_command` is set. type: string - cpeUri: - description: >- - Deprecated. The CPE URI in [CPE - format](https://cpe.mitre.org/specification/) + displayCommand: + description: Command to display the non-compliant files. type: string - version: - description: Deprecated. The version installed at this location. - $ref: '#/components/schemas/Version' - id: Location - BuildMetadata: - id: BuildMetadata + reason: + description: Explains why a file is non compliant for a CIS check. + type: string + ComplianceVersion: + id: ComplianceVersion + description: >- + Describes the CIS benchmark version that is applicable to a given OS and + os version. + type: object properties: - invocationId: + cpeUri: + description: >- + The CPE URI (https://cpe.mitre.org/specification/) this benchmark is + applicable to. type: string - finishedOn: - format: google-datetime + benchmarkDocument: + description: >- + The name of the document that defines this benchmark, e.g. "CIS + Container-Optimized OS". type: string - startedOn: + version: + description: >- + The version of the benchmark. This is set to the version of the + OS-specific CIS document the benchmark is defined in. type: string - format: google-datetime + DSSEAttestationOccurrence: + id: DSSEAttestationOccurrence + description: >- + Deprecated. Prefer to use a regular Occurrence, and populate the + Envelope at the top level of the Occurrence. type: object - ContaineranalysisGoogleDevtoolsCloudbuildV1Build: + properties: + envelope: + description: >- + If doing something security critical, make sure to verify the + signatures in this metadata. + $ref: '#/components/schemas/Envelope' + statement: + $ref: '#/components/schemas/InTotoStatement' + Envelope: + id: Envelope description: >- - A build resource in the Cloud Build API. At a high level, a `Build` - describes where to find source code, how to build it (for example, the - builder image to run on the source), and where to store the built - artifacts. Fields can include the following variables, which will be - expanded when the build is created: - $PROJECT_ID: the project ID of the - build. - $PROJECT_NUMBER: the project number of the build. - $LOCATION: - the location/region of the build. - $BUILD_ID: the autogenerated ID of - the build. - $REPO_NAME: the source repository name specified by - RepoSource. - $BRANCH_NAME: the branch name specified by RepoSource. - - $TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID or - $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the - specified branch or tag. - $SHORT_SHA: first 7 characters of - $REVISION_ID or $COMMIT_SHA. + MUST match + https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. + An authenticated message of arbitrary type. type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1Build properties: - source: - description: Optional. The location of the source files to build. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Source - startTime: + payload: type: string - readOnly: true - description: Output only. Time at which execution of the build was started. - format: google-datetime - failureInfo: - description: >- - Output only. Contains information about the build when - status=FAILURE. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildFailureInfo - readOnly: true - statusDetail: - description: Output only. Customer-readable message about the current status. + format: byte + payloadType: type: string - readOnly: true - name: + signatures: + type: array + items: + $ref: '#/components/schemas/EnvelopeSignature' + EnvelopeSignature: + id: EnvelopeSignature + type: object + properties: + sig: type: string - readOnly: true - description: >- - Output only. The 'Build' name with format: - `projects/{project}/locations/{location}/builds/{build}`, where - {build} is a unique identifier generated by the service. - options: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions - description: Special options for this build. - warnings: - readOnly: true + format: byte + keyid: + type: string + SBOMReferenceOccurrence: + id: SBOMReferenceOccurrence + description: >- + The occurrence representing an SBOM reference as applied to a specific + resource. The occurrence follows the DSSE specification. See + https://github.com/secure-systems-lab/dsse/blob/master/envelope.md for + more details. + type: object + properties: + payload: + description: The actual payload that contains the SBOM reference data. + $ref: '#/components/schemas/SbomReferenceIntotoPayload' + payloadType: description: >- - Output only. Non-fatal problems encountered during the execution of - the build. - items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildWarning + The kind of payload that SbomReferenceIntotoPayload takes. Since + it's in the intoto format, this value is expected to be + 'application/vnd.in-toto+json'. + type: string + signatures: + description: The signatures over the payload. type: array - timing: - readOnly: true + items: + $ref: '#/components/schemas/EnvelopeSignature' + SbomReferenceIntotoPayload: + id: SbomReferenceIntotoPayload + description: >- + The actual payload that contains the SBOM Reference data. The payload + follows the intoto statement specification. See + https://github.com/in-toto/attestation/blob/main/spec/v1.0/statement.md + for more details. + type: object + properties: + _type: + description: Identifier for the schema of the Statement. + type: string + predicateType: + description: URI identifying the type of the Predicate. + type: string + subject: description: >- - Output only. Stores timing information for phases of the build. - Valid keys are: * BUILD: time to execute all build steps. * PUSH: - time to push all artifacts including docker images and non docker - artifacts. * FETCHSOURCE: time to fetch source. * SETUPBUILD: time - to set up build. If the build does not specify source or images, - these keys will not be included. - type: object - additionalProperties: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan - steps: + Set of software artifacts that the attestation applies to. Each + element represents a single software artifact. type: array - description: Required. The operations to be performed on the workspace. items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildStep - gitConfig: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfig - description: Optional. Configuration for git operations. - queueTtl: - format: google-duration + $ref: '#/components/schemas/Subject' + predicate: description: >- - TTL in queue for this build. If provided and the build is enqueued - longer than this value, the build will expire and the build status - will be `EXPIRED`. The TTL starts ticking from create_time. + Additional parameters of the Predicate. Includes the actual data + about the SBOM. + $ref: '#/components/schemas/SbomReferenceIntotoPredicate' + SbomReferenceIntotoPredicate: + id: SbomReferenceIntotoPredicate + description: A predicate which describes the SBOM being referenced. + type: object + properties: + referrerId: + description: The person or system referring this predicate to the consumer. type: string - buildTriggerId: - readOnly: true - description: >- - Output only. The ID of the `BuildTrigger` that triggered this build, - if it was triggered automatically. + location: + description: The location of the SBOM. + type: string + mimeType: + description: The mime type of the SBOM. + type: string + digest: + description: A map of algorithm to digest of the contents of the SBOM. + type: object + additionalProperties: + type: string + SecretOccurrence: + id: SecretOccurrence + description: The occurrence provides details of a secret. + type: object + properties: + kind: + description: Required. Type of secret. type: string - status: enumDescriptions: - - Status of the build is unknown. + - Unspecified + - The secret kind is unknown. - >- - Build has been created and is pending execution and queuing. It - has not been queued. - - Build or step is queued; work has not yet begun. - - Build or step is being executed. - - Build or step finished successfully. - - Build or step failed to complete successfully. - - Build or step failed due to an internal cause. - - Build or step took longer than was allowed. - - Build or step was canceled by a user. - - Build was enqueued for longer than the value of `queue_ttl`. - readOnly: true + A GCP service account key per: + https://cloud.google.com/iam/docs/creating-managing-service-account-keys + enum: + - SECRET_KIND_UNSPECIFIED + - SECRET_KIND_UNKNOWN + - SECRET_KIND_GCP_SERVICE_ACCOUNT_KEY + locations: + description: Optional. Locations where the secret is detected. + type: array + items: + $ref: '#/components/schemas/SecretLocation' + statuses: + description: Optional. Status of the secret. + type: array + items: + $ref: '#/components/schemas/SecretStatus' + SecretLocation: + id: SecretLocation + description: The location of the secret. + type: object + properties: + fileLocation: + description: The secret is found from a file. + $ref: '#/components/schemas/GrafeasV1FileLocation' + SecretStatus: + id: SecretStatus + description: The status of the secret with a timestamp. + type: object + properties: + status: + description: Optional. The status of the secret. type: string - description: Output only. Status of the build. + enumDescriptions: + - Unspecified + - The status of the secret is unknown. + - The secret is valid. + - The secret is invalid. enum: - - STATUS_UNKNOWN - - PENDING - - QUEUED - - WORKING - - SUCCESS - - FAILURE - - INTERNAL_ERROR - - TIMEOUT - - CANCELLED - - EXPIRED - results: - description: Output only. Results of the build. - readOnly: true - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Results - finishTime: + - STATUS_UNSPECIFIED + - UNKNOWN + - VALID + - INVALID + updateTime: + description: Optional. The time the secret status was last updated. type: string format: google-datetime - description: >- - Output only. Time at which execution of the build was finished. The - difference between finish_time and start_time is the duration of the - build's execution. - readOnly: true - serviceAccount: + message: + description: Optional. Optional message about the status code. type: string - description: >- - IAM service account whose credentials will be used at build runtime. - Must be of the format - `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. ACCOUNT can be - email address or uniqueId of the service account. - images: - items: - type: string - description: >- - A list of images to be pushed upon the successful completion of all - build steps. The images are pushed using the builder service - account's credentials. The digests of the pushed images will be - stored in the `Build` resource's results field. If any of the images - fail to be pushed, the build status is marked `FAILURE`. + ListOccurrencesResponse: + id: ListOccurrencesResponse + description: Response for listing occurrences. + type: object + properties: + occurrences: + description: The occurrences requested. type: array - artifacts: + items: + $ref: '#/components/schemas/Occurrence' + nextPageToken: description: >- - Artifacts produced by the build that should be uploaded upon - successful completion of all build steps. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Artifacts - availableSecrets: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Secrets - description: Secrets and secret environment variables. - timeout: + The next pagination token in the list response. It should be used as + `page_token` for the following request. An empty value means no more + results. type: string + unreachable: description: >- - Amount of time that this build should be allowed to run, to second - granularity. If this amount of time elapses, work on the build will - cease and the build status will be `TIMEOUT`. `timeout` starts - ticking from `startTime`. Default time is 60 minutes. - format: google-duration - tags: - description: Tags for annotation of a `Build`. These are not docker tags. + Unordered list. Unreachable regions. Populated for requests from the + global region when `return_partial_success` is set. Format: + `projects/[PROJECT_ID]/locations/[LOCATION]` + type: array items: type: string + Empty: + id: Empty + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + type: object + properties: {} + BatchCreateOccurrencesRequest: + id: BatchCreateOccurrencesRequest + description: Request to create occurrences in batch. + type: object + properties: + occurrences: + description: Required. The occurrences to create. Max allowed length is 1000. type: array - substitutions: - type: object - additionalProperties: - type: string - description: Substitutions data for `Build` resource. - approval: + items: + $ref: '#/components/schemas/Occurrence' + BatchCreateOccurrencesResponse: + id: BatchCreateOccurrencesResponse + description: Response for creating occurrences in batch. + type: object + properties: + occurrences: + description: The occurrences that were created. + type: array + items: + $ref: '#/components/schemas/Occurrence' + Note: + id: Note + description: A type of analysis that can be done for a resource. + type: object + properties: + name: description: >- - Output only. Describes this build's approval configuration, status, - and result. - readOnly: true - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildApproval - logUrl: - readOnly: true - description: Output only. URL to logs for this build in Google Cloud Console. + Output only. The name of the note in the form of + `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. type: string - createTime: - format: google-datetime - description: >- - Output only. Time at which the request to create the build was - received. - readOnly: true + shortDescription: + description: A one sentence description of this note. type: string - logsBucket: + longDescription: + description: A detailed description of this note. + type: string + kind: description: >- - Cloud Storage bucket where logs should be written (see [Bucket Name - Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). - Logs file names will be of the format - `${logs_bucket}/log-${build_id}.txt`. + Output only. The type of analysis. This field can be used as a + filter in list requests. type: string - secrets: + enumDescriptions: + - Default value. This value is unused. + - The note and occurrence represent a package vulnerability. + - The note and occurrence assert build provenance. + - This represents an image basis relationship. + - This represents a package installed via a package manager. + - The note and occurrence track deployment events. + - >- + The note and occurrence track the initial discovery status of a + resource. + - This represents a logical "role" that can attest to artifacts. + - This represents an available package upgrade. + - This represents a Compliance Note + - This represents a DSSE attestation Note + - This represents a Vulnerability Assessment. + - This represents an SBOM Reference. + - This represents a secret. + enum: + - NOTE_KIND_UNSPECIFIED + - VULNERABILITY + - BUILD + - IMAGE + - PACKAGE + - DEPLOYMENT + - DISCOVERY + - ATTESTATION + - UPGRADE + - COMPLIANCE + - DSSE_ATTESTATION + - VULNERABILITY_ASSESSMENT + - SBOM_REFERENCE + - SECRET + relatedUrl: + description: URLs associated with this note. type: array - description: >- - Secrets to decrypt using Cloud Key Management Service. Note: Secret - Manager is the recommended technique for managing sensitive data - with Cloud Build. Use `available_secrets` to configure builds to - access secrets from Secret Manager. For instructions, see: - https://cloud.google.com/cloud-build/docs/securing-builds/use-secrets items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Secret - sourceProvenance: - readOnly: true - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1SourceProvenance - description: Output only. A permanent fixed identifier for source. - id: - description: Output only. Unique identifier of the build. - readOnly: true - type: string - projectId: - readOnly: true - description: Output only. ID of the project. - type: string - RelatedUrl: - description: Metadata for any related URL information. - id: RelatedUrl - type: object - properties: - url: + $ref: '#/components/schemas/RelatedUrl' + expirationTime: + description: Time of expiration for this note. Empty if note does not expire. type: string - description: Specific URL associated with the resource. - label: + format: google-datetime + createTime: + description: >- + Output only. The time this note was created. This field can be used + as a filter in list requests. type: string - description: Label to describe usage of the URL. - ProvenanceBuilder: - type: object - id: ProvenanceBuilder - properties: - id: + format: google-datetime + updateTime: + description: >- + Output only. The time this note was last updated. This field can be + used as a filter in list requests. type: string - version: - additionalProperties: - type: string - type: object - builderDependencies: - items: - $ref: '#/components/schemas/ResourceDescriptor' + format: google-datetime + relatedNoteNames: + description: Other notes related to this note. type: array - DSSEAttestationNote: - properties: - hint: - description: DSSEHint hints at the purpose of the attestation authority. - $ref: '#/components/schemas/DSSEHint' - type: object - id: DSSEAttestationNote - DeploymentNote: - properties: - resourceUri: - description: Required. Resource URI for the artifact being deployed. items: type: string - type: array - type: object - id: DeploymentNote - description: An artifact that can be deployed in some runtime. - SlsaCompleteness: + vulnerability: + description: A note describing a package vulnerability. + $ref: '#/components/schemas/VulnerabilityNote' + build: + description: A note describing build provenance for a verifiable build. + $ref: '#/components/schemas/BuildNote' + image: + description: A note describing a base image. + $ref: '#/components/schemas/ImageNote' + package: + description: A note describing a package hosted by various package managers. + $ref: '#/components/schemas/PackageNote' + deployment: + description: A note describing something that can be deployed. + $ref: '#/components/schemas/DeploymentNote' + discovery: + description: A note describing the initial analysis of a resource. + $ref: '#/components/schemas/DiscoveryNote' + attestation: + description: A note describing an attestation role. + $ref: '#/components/schemas/AttestationNote' + upgrade: + description: A note describing available package upgrades. + $ref: '#/components/schemas/UpgradeNote' + compliance: + description: A note describing a compliance check. + $ref: '#/components/schemas/ComplianceNote' + dsseAttestation: + description: A note describing a dsse attestation note. + $ref: '#/components/schemas/DSSEAttestationNote' + vulnerabilityAssessment: + description: A note describing a vulnerability assessment. + $ref: '#/components/schemas/VulnerabilityAssessmentNote' + sbomReference: + description: A note describing an SBOM reference. + $ref: '#/components/schemas/SBOMReferenceNote' + secret: + description: A note describing a secret. + $ref: '#/components/schemas/SecretNote' + VulnerabilityNote: + id: VulnerabilityNote + description: A security vulnerability that can be found in resources. type: object properties: - environment: - type: boolean + cvssScore: description: >- - If true, the builder claims that recipe.environment is claimed to be - complete. - materials: + The CVSS score of this vulnerability. CVSS score is on a scale of 0 + - 10 where 0 indicates low severity and 10 indicates high severity. + type: number + format: float + severity: + description: The note provider assigned severity of this vulnerability. + type: string + enumDescriptions: + - Unknown. + - Minimal severity. + - Low severity. + - Medium severity. + - High severity. + - Critical severity. + enum: + - SEVERITY_UNSPECIFIED + - MINIMAL + - LOW + - MEDIUM + - HIGH + - CRITICAL + details: description: >- - If true, the builder claims that materials are complete, usually - through some controls to prevent network access. Sometimes called - "hermetic". - type: boolean - arguments: - type: boolean + Details of all known distros and packages affected by this + vulnerability. + type: array + items: + $ref: '#/components/schemas/Detail' + cvssV3: + description: The full description of the CVSSv3 for this vulnerability. + $ref: '#/components/schemas/CVSSv3' + windowsDetails: description: >- - If true, the builder claims that recipe.arguments is complete, - meaning that all external inputs are properly captured in the - recipe. - description: >- - Indicates that the builder claims certain fields in this message to be - complete. - id: SlsaCompleteness - ContaineranalysisGoogleDevtoolsCloudbuildV1GitSource: - id: ContaineranalysisGoogleDevtoolsCloudbuildV1GitSource - properties: - dir: + Windows details get their own format because the information format + and model don't match a normal detail. Specifically Windows updates + are done as patches, thus Windows vulnerabilities really are a + missing package, rather than a package being at an incorrect + version. + type: array + items: + $ref: '#/components/schemas/WindowsDetail' + sourceUpdateTime: description: >- - Optional. Directory, relative to the source root, in which to run - the build. This must be a relative path. If a step's `dir` is - specified and is an absolute path, this value is ignored for that - step's execution. - type: string - url: - description: >- - Required. Location of the Git repo to build. This will be used as a - `git remote`, see https://git-scm.com/docs/git-remote. + The time this information was last changed at the source. This is an + upstream timestamp from the underlying information source - e.g. + Ubuntu security tracker. type: string - revision: + format: google-datetime + cvssVersion: + description: CVSS version used to populate cvss_score and severity. type: string - description: >- - Optional. The revision to fetch from the Git repository such as a - branch, a tag, a commit SHA, or any Git ref. Cloud Build uses `git - fetch` to fetch the revision from the Git repository; therefore make - sure that the string you provide for `revision` is parsable by the - command. For information on string values accepted by `git fetch`, - see https://git-scm.com/docs/gitrevisions#_specifying_revisions. For - information on `git fetch`, see https://git-scm.com/docs/git-fetch. - type: object - description: Location of the source in any accessible Git repository. - Jwt: + enumDescriptions: + - '' + - '' + - '' + enum: + - CVSS_VERSION_UNSPECIFIED + - CVSS_VERSION_2 + - CVSS_VERSION_3 + cvssV2: + description: The full description of the v2 CVSS for this vulnerability. + $ref: '#/components/schemas/CVSS' + Detail: + id: Detail + description: >- + A detail for a distro and package affected by this vulnerability and its + associated fix (if one is available). type: object - id: Jwt properties: - compactJwt: + severityName: + description: The distro assigned severity of this vulnerability. + type: string + description: + description: A vendor-specific description of this vulnerability. type: string + packageType: description: >- - The compact encoding of a JWS, which is always three base64 encoded - strings joined by periods. For details, see: - https://tools.ietf.org/html/rfc7515.html#section-3.1 - ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsPythonPackage: - description: >- - Python package to upload to Artifact Registry upon successful completion - of all build steps. A package can encapsulate multiple objects to be - uploaded to a single repository. - type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsPythonPackage - properties: - paths: - items: - type: string + The type of package; whether native or non native (e.g., ruby gems, + node.js packages, etc.). + type: string + affectedCpeUri: description: >- - Path globs used to match files in the build's workspace. For Python/ - Twine, this is usually `dist/*`, and sometimes additionally an - `.asc` file. - type: array - repository: + Required. The [CPE URI](https://cpe.mitre.org/specification/) this + vulnerability affects. type: string + affectedPackage: + description: Required. The package this vulnerability affects. + type: string + affectedVersionStart: description: >- - Artifact Registry repository, in the form - "https://$REGION-python.pkg.dev/$PROJECT/$REPOSITORY" Files in the - workspace matching any path pattern will be uploaded to Artifact - Registry with this location as a prefix. - Identity: - type: object - properties: - updateId: - description: The revision independent identifier of the update. + The version number at the start of an interval in which this + vulnerability exists. A vulnerability can affect a package between + version numbers that are disjoint sets of intervals (example: + [1.0.0-1.1.0], [2.4.6-2.4.8] and [4.5.6-4.6.8]) each of which will + be represented in its own Detail. If a specific affected version is + provided by a vulnerability database, affected_version_start and + affected_version_end will be the same in that Detail. + $ref: '#/components/schemas/Version' + affectedVersionEnd: + description: >- + The version number at the end of an interval in which this + vulnerability exists. A vulnerability can affect a package between + version numbers that are disjoint sets of intervals (example: + [1.0.0-1.1.0], [2.4.6-2.4.8] and [4.5.6-4.6.8]) each of which will + be represented in its own Detail. If a specific affected version is + provided by a vulnerability database, affected_version_start and + affected_version_end will be the same in that Detail. + $ref: '#/components/schemas/Version' + fixedCpeUri: + description: >- + The distro recommended [CPE + URI](https://cpe.mitre.org/specification/) to update to that + contains a fix for this vulnerability. It is possible for this to be + different from the affected_cpe_uri. type: string - revision: - description: The revision number of the update. - format: int32 - type: integer - description: The unique identifier of the update. - id: Identity - Empty: - type: object - description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } - id: Empty - properties: {} - VulnerabilityNote: - id: VulnerabilityNote - description: A security vulnerability that can be found in resources. - properties: - severity: - enumDescriptions: - - Unknown. - - Minimal severity. - - Low severity. - - Medium severity. - - High severity. - - Critical severity. - enum: - - SEVERITY_UNSPECIFIED - - MINIMAL - - LOW - - MEDIUM - - HIGH - - CRITICAL - description: The note provider assigned severity of this vulnerability. + fixedPackage: + description: >- + The distro recommended package to update to that contains a fix for + this vulnerability. It is possible for this to be different from the + affected_package. type: string + fixedVersion: + description: >- + The distro recommended version to update to that contains a fix for + this vulnerability. Setting this to VersionKind.MAXIMUM means no + such version is yet available. + $ref: '#/components/schemas/Version' + isObsolete: + description: >- + Whether this detail is obsolete. Occurrences are expected not to + point to obsolete details. + type: boolean sourceUpdateTime: - type: string - format: google-datetime description: >- The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker. - cvssV2: - $ref: '#/components/schemas/CVSS' - description: The full description of the v2 CVSS for this vulnerability. - cvssScore: - description: >- - The CVSS score of this vulnerability. CVSS score is on a scale of 0 - - 10 where 0 indicates low severity and 10 indicates high severity. + type: string + format: google-datetime + source: + description: The source from which the information in this Detail was obtained. + type: string + vendor: + description: The name of the vendor of the product. + type: string + CVSSv3: + id: CVSSv3 + description: >- + Common Vulnerability Scoring System version 3. For details, see + https://www.first.org/cvss/specification-document + type: object + properties: + baseScore: + description: The base score is a function of the base metric scores. type: number format: float - windowsDetails: + exploitabilityScore: + type: number + format: float + impactScore: + type: number + format: float + attackVector: description: >- - Windows details get their own format because the information format - and model don't match a normal detail. Specifically Windows updates - are done as patches, thus Windows vulnerabilities really are a - missing package, rather than a package being at an incorrect - version. - items: - $ref: '#/components/schemas/WindowsDetail' - type: array - cvssVersion: - enum: - - CVSS_VERSION_UNSPECIFIED - - CVSS_VERSION_2 - - CVSS_VERSION_3 + Base Metrics Represents the intrinsic characteristics of a + vulnerability that are constant over time and across user + environments. + type: string enumDescriptions: - '' - '' - '' - description: CVSS version used to populate cvss_score and severity. + - '' + - '' + enum: + - ATTACK_VECTOR_UNSPECIFIED + - ATTACK_VECTOR_NETWORK + - ATTACK_VECTOR_ADJACENT + - ATTACK_VECTOR_LOCAL + - ATTACK_VECTOR_PHYSICAL + attackComplexity: type: string - cvssV3: - description: The full description of the CVSSv3 for this vulnerability. - $ref: '#/components/schemas/CVSSv3' - details: - type: array - description: >- - Details of all known distros and packages affected by this - vulnerability. - items: - $ref: '#/components/schemas/Detail' - type: object - ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptionsPoolOption: - properties: - name: - description: >- - The `WorkerPool` resource to execute the build on. You must have - `cloudbuild.workerpools.use` on the project hosting the WorkerPool. - Format - projects/{project}/locations/{location}/workerPools/{workerPoolId} + enumDescriptions: + - '' + - '' + - '' + enum: + - ATTACK_COMPLEXITY_UNSPECIFIED + - ATTACK_COMPLEXITY_LOW + - ATTACK_COMPLEXITY_HIGH + privilegesRequired: type: string - description: >- - Details about how a build should be executed on a `WorkerPool`. See - [running builds in a private - pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) - for more information. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptionsPoolOption - type: object - Product: - description: >- - Product contains information about a product and how to uniquely - identify it. - id: Product - properties: - genericUri: + enumDescriptions: + - '' + - '' + - '' + - '' + enum: + - PRIVILEGES_REQUIRED_UNSPECIFIED + - PRIVILEGES_REQUIRED_NONE + - PRIVILEGES_REQUIRED_LOW + - PRIVILEGES_REQUIRED_HIGH + userInteraction: type: string - description: >- - Contains a URI which is vendor-specific. Example: The artifact - repository URL of an image. - name: + enumDescriptions: + - '' + - '' + - '' + enum: + - USER_INTERACTION_UNSPECIFIED + - USER_INTERACTION_NONE + - USER_INTERACTION_REQUIRED + scope: type: string - description: Name of the product. - id: + enumDescriptions: + - '' + - '' + - '' + enum: + - SCOPE_UNSPECIFIED + - SCOPE_UNCHANGED + - SCOPE_CHANGED + confidentialityImpact: type: string - description: >- - Token that identifies a product so that it can be referred to from - other parts in the document. There is no predefined format as long - as it uniquely identifies a group in the context of the current - document. + enumDescriptions: + - '' + - '' + - '' + - '' + enum: + - IMPACT_UNSPECIFIED + - IMPACT_HIGH + - IMPACT_LOW + - IMPACT_NONE + integrityImpact: + type: string + enumDescriptions: + - '' + - '' + - '' + - '' + enum: + - IMPACT_UNSPECIFIED + - IMPACT_HIGH + - IMPACT_LOW + - IMPACT_NONE + availabilityImpact: + type: string + enumDescriptions: + - '' + - '' + - '' + - '' + enum: + - IMPACT_UNSPECIFIED + - IMPACT_HIGH + - IMPACT_LOW + - IMPACT_NONE + WindowsDetail: + id: WindowsDetail type: object - Binding: properties: - role: - type: string + cpeUri: description: >- - Role that is assigned to the list of `members`, or principals. For - example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an - overview of the IAM roles and permissions, see the [IAM - documentation](https://cloud.google.com/iam/docs/roles-overview). - For a list of the available pre-defined roles, see - [here](https://cloud.google.com/iam/docs/understanding-roles). - condition: + Required. The [CPE URI](https://cpe.mitre.org/specification/) this + vulnerability affects. + type: string + name: + description: Required. The name of this vulnerability. + type: string + description: + description: The description of this vulnerability. + type: string + fixingKbs: description: >- - The condition that is associated with this binding. If the condition - evaluates to `true`, then this binding applies to the current - request. If the condition evaluates to `false`, then this binding - does not apply to the current request. However, a different role - binding might grant the same role to one or more of the principals - in this binding. To learn which resources support conditions in - their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - $ref: '#/components/schemas/Expr' - members: + Required. The names of the KBs which have hotfixes to mitigate this + vulnerability. Note that there may be multiple hotfixes (and thus + multiple KBs) that mitigate a given vulnerability. Currently any + listed KBs presence is considered a fix. type: array items: - type: string - description: >- - Specifies the principals requesting access for a Google Cloud - 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. Does not include identities - that come from external identity providers (IdPs) through identity - federation. * `user:{emailid}`: An email address that represents a - specific Google account. For example, `alice@example.com` . * - `serviceAccount:{emailid}`: An email address that represents a - Google service account. For example, - `my-other-app@appspot.gserviceaccount.com`. * - `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: - An identifier for a [Kubernetes service - account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). - For example, - `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * - `group:{emailid}`: An email address that represents a Google group. - For example, `admins@example.com`. * `domain:{domain}`: The G Suite - domain (primary) that represents all the users of that domain. For - example, `google.com` or `example.com`. * - `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workforce identity pool. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: - All workforce identities in a group. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All workforce identities with a specific attribute value. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: - All identities in a workforce identity pool. * - `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workload identity pool. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: - A workload identity pool group. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All identities in a workload identity pool with a certain attribute. - * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: - All identities in a workload identity pool. * - `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. * - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - Deleted single identity in a workforce identity pool. For example, - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. - type: object - description: Associates `members`, or principals, with a `role`. - id: Binding - DeploymentOccurrence: - description: The period during which some deployable was active in a runtime. + $ref: '#/components/schemas/KnowledgeBase' + KnowledgeBase: + id: KnowledgeBase type: object - id: DeploymentOccurrence properties: - address: - description: Address of the runtime element hosting this deployment. + name: + description: The KB name (generally of the form KB[0-9]+ (e.g., KB123456)). type: string - resourceUri: - items: - type: string - type: array + url: description: >- - Output only. Resource URI for the artifact being deployed taken from - the deployable field with the same name. - userEmail: - description: Identity of the user that triggered this deployment. - type: string - deployTime: - format: google-datetime - type: string - description: Required. Beginning of the lifetime of this deployment. - platform: - enumDescriptions: - - Unknown. - - Google Container Engine. - - 'Google App Engine: Flexible Environment.' - - Custom user-defined platform. - enum: - - PLATFORM_UNSPECIFIED - - GKE - - FLEX - - CUSTOM - type: string - description: Platform hosting this deployment. - undeployTime: - description: End of the lifetime of this deployment. - type: string - format: google-datetime - config: + A link to the KB in the [Windows update catalog] + (https://www.catalog.update.microsoft.com/). type: string - description: Configuration used to create this deployment. - ContaineranalysisGoogleDevtoolsCloudbuildV1Volume: - id: ContaineranalysisGoogleDevtoolsCloudbuildV1Volume + BuildNote: + id: BuildNote description: >- - Volume describes a Docker container volume which is mounted into build - steps in order to persist files across build step execution. + Note holding the version of the provider's builder and the signature of + the provenance message in the build details occurrence. type: object properties: - name: + builderVersion: description: >- - Name of the volume to mount. Volume names must be unique per build - step and must be valid names for Docker volumes. Each named volume - must be used by at least two build steps. - type: string - path: + Required. Immutable. Version of the builder which produced this + build. type: string - description: >- - Path at which to mount the volume. Paths must be absolute and cannot - conflict with other volume paths on the same build step or with - certain reserved volume paths. - SbomReferenceIntotoPayload: - type: object - id: SbomReferenceIntotoPayload + ImageNote: + id: ImageNote description: >- - The actual payload that contains the SBOM Reference data. The payload - follows the intoto statement specification. See - https://github.com/in-toto/attestation/blob/main/spec/v1.0/statement.md - for more details. + Basis describes the base image portion (Note) of the DockerImage + relationship. Linked occurrences are derived from this or an equivalent + image via: FROM Or an equivalent reference, e.g., a tag of the + resource_url. + type: object properties: - predicateType: - type: string - description: URI identifying the type of the Predicate. - predicate: - $ref: '#/components/schemas/SbomReferenceIntotoPredicate' - description: >- - Additional parameters of the Predicate. Includes the actual data - about the SBOM. - subject: + resourceUrl: description: >- - Set of software artifacts that the attestation applies to. Each - element represents a single software artifact. - items: - $ref: '#/components/schemas/Subject' - type: array - _type: + Required. Immutable. The resource_url for the resource representing + the basis of associated occurrence images. type: string - description: Identifier for the schema of the Statement. - ContaineranalysisGoogleDevtoolsCloudbuildV1ConnectedRepository: + fingerprint: + description: Required. Immutable. The fingerprint of the base image. + $ref: '#/components/schemas/Fingerprint' + PackageNote: + id: PackageNote + description: PackageNote represents a particular package version. + type: object properties: - repository: - description: >- - Required. Name of the Google Cloud Build repository, formatted as - `projects/*/locations/*/connections/*/repositories/*`. + name: + description: Required. Immutable. The name of the package. type: string - revision: + distribution: + description: Deprecated. The various channels by which a package is distributed. + type: array + items: + $ref: '#/components/schemas/Distribution' + packageType: + description: >- + The type of package; whether native or non native (e.g., ruby gems, + node.js packages, etc.). type: string + cpeUri: description: >- - Required. The revision to fetch from the Git repository such as a - branch, a tag, a commit SHA, or any Git ref. - dir: + The cpe_uri in [CPE format](https://cpe.mitre.org/specification/) + denoting the package manager version distributing a package. The + cpe_uri will be blank for language packages. + type: string + architecture: description: >- - Optional. Directory, relative to the source root, in which to run - the build. + The CPU architecture for which packages in this distribution channel + were built. Architecture will be blank for language packages. type: string - description: >- - Location of the source in a 2nd-gen Google Cloud Build repository - resource. - type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1ConnectedRepository - GrafeasV1SlsaProvenanceZeroTwoSlsaMaterial: - description: >- - The collection of artifacts that influenced the build including sources, - dependencies, build tools, base images, and so on. - type: object - id: GrafeasV1SlsaProvenanceZeroTwoSlsaMaterial - properties: - digest: - additionalProperties: - type: string - type: object - uri: + enumDescriptions: + - Unknown architecture. + - X86 architecture. + - X64 architecture. + enum: + - ARCHITECTURE_UNSPECIFIED + - X86 + - X64 + version: + description: The version of the package. + $ref: '#/components/schemas/Version' + maintainer: + description: A freeform text denoting the maintainer of this package. type: string - Layer: - description: Layer holds metadata specific to a layer of a Docker image. - id: Layer - properties: - directive: - description: >- - Required. The recovered Dockerfile directive used to construct this - layer. See https://docs.docker.com/engine/reference/builder/ for - more information. + url: + description: The homepage for this package. type: string - arguments: - description: The recovered arguments to the Dockerfile directive. + description: + description: The description of this package. type: string - type: object + license: + description: Licenses that have been declared by the authors of the package. + $ref: '#/components/schemas/License' + digest: + description: >- + Hash value, typically a file digest, that allows unique + identification a specific package. + type: array + items: + $ref: '#/components/schemas/Digest' Distribution: + id: Distribution description: >- This represents a particular channel of distribution for a given package. E.g., Debian's jessie-backports dpkg mirror. - id: Distribution type: object properties: cpeUri: - type: string description: >- Required. The cpe_uri in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package. + type: string architecture: - enum: - - ARCHITECTURE_UNSPECIFIED - - X86 - - X64 description: >- The CPU architecture for which packages in this distribution channel were built. + type: string enumDescriptions: - Unknown architecture. - X86 architecture. - X64 architecture. - type: string - description: - type: string - description: The distribution channel-specific description of this package. + enum: + - ARCHITECTURE_UNSPECIFIED + - X86 + - X64 + latestVersion: + description: >- + The latest available version of this package in this distribution + channel. + $ref: '#/components/schemas/Version' maintainer: - type: string description: A freeform string denoting the maintainer of this package. + type: string url: description: The distribution channel-specific homepage for this package. type: string - latestVersion: - $ref: '#/components/schemas/Version' - description: >- - The latest available version of this package in this distribution - channel. - GrafeasV1SlsaProvenanceZeroTwoSlsaCompleteness: + description: + description: The distribution channel-specific description of this package. + type: string + Digest: + id: Digest + description: Digest information. type: object - id: GrafeasV1SlsaProvenanceZeroTwoSlsaCompleteness properties: - environment: - type: boolean - parameters: - type: boolean - materials: - type: boolean - description: >- - Indicates that the builder claims certain fields in this message to be - complete. - ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions: - description: Optional arguments to enable specific features of builds. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions + algo: + description: '`SHA1`, `SHA512` etc.' + type: string + digestBytes: + description: Value of the digest. + type: string + format: byte + DeploymentNote: + id: DeploymentNote + description: An artifact that can be deployed in some runtime. + type: object properties: - pool: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptionsPoolOption - description: >- - Optional. Specification for execution on a `WorkerPool`. See - [running builds in a private - pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) - for more information. - env: - description: >- - A list of global environment variable definitions that will exist - for all build steps in this build. If a variable is defined in both - globally and in a build step, the variable will use the build step - value. The elements are of the form "KEY=VALUE" for the environment - variable "KEY" being given the value "VALUE". + resourceUri: + description: Required. Resource URI for the artifact being deployed. type: array items: type: string - diskSizeGb: - format: int64 - type: string - description: >- - Requested disk size for the VM that runs the build. Note that this - is *NOT* "disk free"; some of the space will be used by the - operating system and build utilities. Also note that this is the - minimum disk size that will be allocated for the build -- the build - may run with a larger disk than requested. At present, the maximum - disk size is 4000GB; builds that request more than the maximum are - rejected with an error. - dynamicSubstitutions: + DiscoveryNote: + id: DiscoveryNote + description: >- + A note that indicates a type of analysis a provider would perform. This + note exists in a provider's project. A `Discovery` occurrence is created + in a consumer's project at the start of analysis. + type: object + properties: + analysisKind: description: >- - Option to specify whether or not to apply bash style string - operations to the substitutions. NOTE: this is always enabled for - triggered builds and cannot be overridden in the build configuration - file. - type: boolean - machineType: - enumDescriptions: - - Standard machine type. - - Highcpu machine with 8 CPUs. - - Highcpu machine with 32 CPUs. - - Highcpu e2 machine with 8 CPUs. - - Highcpu e2 machine with 32 CPUs. - - E2 machine with 1 CPU. - enumDeprecated: - - false - - true - - true - - false - - false - - false - enum: - - UNSPECIFIED - - N1_HIGHCPU_8 - - N1_HIGHCPU_32 - - E2_HIGHCPU_8 - - E2_HIGHCPU_32 - - E2_MEDIUM - description: Compute Engine machine type on which to run the build. + Required. Immutable. The kind of analysis that is handled by this + discovery. type: string - defaultLogsBucketBehavior: enumDescriptions: - - Unspecified. - - >- - Bucket is located in user-owned project in the same region as the - build. The builder service account must have access to create and - write to Cloud Storage buckets in the build project. - - >- - Bucket is located in a Google-owned project and is not - regionalized. + - Default value. This value is unused. + - The note and occurrence represent a package vulnerability. + - The note and occurrence assert build provenance. + - This represents an image basis relationship. + - This represents a package installed via a package manager. + - The note and occurrence track deployment events. + - >- + The note and occurrence track the initial discovery status of a + resource. + - This represents a logical "role" that can attest to artifacts. + - This represents an available package upgrade. + - This represents a Compliance Note + - This represents a DSSE attestation Note + - This represents a Vulnerability Assessment. + - This represents an SBOM Reference. + - This represents a secret. + enum: + - NOTE_KIND_UNSPECIFIED + - VULNERABILITY + - BUILD + - IMAGE + - PACKAGE + - DEPLOYMENT + - DISCOVERY + - ATTESTATION + - UPGRADE + - COMPLIANCE + - DSSE_ATTESTATION + - VULNERABILITY_ASSESSMENT + - SBOM_REFERENCE + - SECRET + AttestationNote: + id: AttestationNote + description: >- + Note kind that represents a logical attestation "role" or "authority". + For example, an organization might have one `Authority` for "QA" and one + for "build". This note is intended to act strictly as a grouping + mechanism for the attached occurrences (Attestations). This grouping + mechanism also provides a security boundary, since IAM ACLs gate the + ability for a principle to attach an occurrence to a given note. It also + provides a single point of lookup to find all attached attestation + occurrences, even if they don't all live in the same project. + type: object + properties: + hint: + description: Hint hints at the purpose of the attestation authority. + $ref: '#/components/schemas/Hint' + Hint: + id: Hint + description: >- + This submessage provides human-readable hints about the purpose of the + authority. Because the name of a note acts as its resource reference, it + is important to disambiguate the canonical name of the Note (which might + be a UUID for security purposes) from "readable" names more suitable for + debug output. Note that these hints should not be used to look up + authorities in security sensitive contexts, such as when looking up + attestations to verify. + type: object + properties: + humanReadableName: + description: >- + Required. The human readable name of this attestation authority, for + example "qa". + type: string + UpgradeNote: + id: UpgradeNote + description: >- + An Upgrade Note represents a potential upgrade of a package to a given + version. For each package version combination (i.e. bash 4.0, bash 4.1, + bash 4.1.2), there will be an Upgrade Note. For Windows, windows_update + field represents the information related to the update. + type: object + properties: + package: + description: Required for non-Windows OS. The package this Upgrade is for. + type: string + version: + description: >- + Required for non-Windows OS. The version of the package in machine + + human readable form. + $ref: '#/components/schemas/Version' + distributions: + description: Metadata about the upgrade for each specific operating system. + type: array + items: + $ref: '#/components/schemas/UpgradeDistribution' + windowsUpdate: + description: >- + Required for Windows OS. Represents the metadata about the Windows + update. + $ref: '#/components/schemas/WindowsUpdate' + ComplianceNote: + id: ComplianceNote + type: object + properties: + title: + description: The title that identifies this compliance check. + type: string + description: + description: A description about this compliance check. + type: string + version: + description: The OS and config versions the benchmark applies to. + type: array + items: + $ref: '#/components/schemas/ComplianceVersion' + rationale: + description: A rationale for the existence of this compliance check. + type: string + remediation: + description: A description of remediation steps if the compliance check fails. + type: string + cisBenchmark: + $ref: '#/components/schemas/CisBenchmark' + scanInstructions: + description: Serialized scan instructions with a predefined format. + type: string + format: byte + impact: + type: string + CisBenchmark: + id: CisBenchmark + description: A compliance check that is a CIS benchmark. + type: object + properties: + profileLevel: + type: integer + format: int32 + severity: + type: string + enumDescriptions: + - Unknown. + - Minimal severity. + - Low severity. + - Medium severity. + - High severity. + - Critical severity. + enum: + - SEVERITY_UNSPECIFIED + - MINIMAL + - LOW + - MEDIUM + - HIGH + - CRITICAL + DSSEAttestationNote: + id: DSSEAttestationNote + type: object + properties: + hint: + description: DSSEHint hints at the purpose of the attestation authority. + $ref: '#/components/schemas/DSSEHint' + DSSEHint: + id: DSSEHint + description: >- + This submessage provides human-readable hints about the purpose of the + authority. Because the name of a note acts as its resource reference, it + is important to disambiguate the canonical name of the Note (which might + be a UUID for security purposes) from "readable" names more suitable for + debug output. Note that these hints should not be used to look up + authorities in security sensitive contexts, such as when looking up + attestations to verify. + type: object + properties: + humanReadableName: + description: >- + Required. The human readable name of this attestation authority, for + example "cloudbuild-prod". + type: string + VulnerabilityAssessmentNote: + id: VulnerabilityAssessmentNote + description: >- + A single VulnerabilityAssessmentNote represents one particular product's + vulnerability assessment for one CVE. + type: object + properties: + title: + description: The title of the note. E.g. `Vex-Debian-11.4` + type: string + shortDescription: + description: A one sentence description of this Vex. + type: string + longDescription: + description: A detailed description of this Vex. + type: string + languageCode: + description: >- + Identifies the language used by this document, corresponding to IETF + BCP 47 / RFC 5646. + type: string + publisher: + description: Publisher details of this Note. + $ref: '#/components/schemas/Publisher' + product: + description: The product affected by this vex. + $ref: '#/components/schemas/Product' + assessment: + description: Represents a vulnerability assessment for the product. + $ref: '#/components/schemas/Assessment' + Publisher: + id: Publisher + description: Publisher contains information about the publisher of this Note. + type: object + properties: + name: + description: 'Name of the publisher. Examples: ''Google'', ''Google Cloud Platform''.' + type: string + issuingAuthority: + description: >- + Provides information about the authority of the issuing party to + release the document, in particular, the party's constituency and + responsibilities or other obligations. + type: string + publisherNamespace: + description: >- + The context or namespace. Contains a URL which is under control of + the issuing party and can be used as a globally unique identifier + for that issuing party. Example: https://csaf.io + type: string + Product: + id: Product + description: >- + Product contains information about a product and how to uniquely + identify it. + type: object + properties: + name: + description: Name of the product. + type: string + id: + description: >- + Token that identifies a product so that it can be referred to from + other parts in the document. There is no predefined format as long + as it uniquely identifies a group in the context of the current + document. + type: string + genericUri: + description: >- + Contains a URI which is vendor-specific. Example: The artifact + repository URL of an image. + type: string + Assessment: + id: Assessment + description: >- + Assessment provides all information that is related to a single + vulnerability for this product. + type: object + properties: + cve: + description: >- + Holds the MITRE standard Common Vulnerabilities and Exposures (CVE) + tracking number for the vulnerability. Deprecated: Use + vulnerability_id instead to denote CVEs. + deprecated: true + type: string + vulnerabilityId: + description: >- + The vulnerability identifier for this Assessment. Will hold one of + common identifiers e.g. CVE, GHSA etc. + type: string + shortDescription: + description: A one sentence description of this Vex. + type: string + longDescription: + description: A detailed description of this Vex. + type: string + relatedUris: + description: >- + Holds a list of references associated with this vulnerability item + and assessment. These uris have additional information about the + vulnerability and the assessment itself. E.g. Link to a document + which details how this assessment concluded the state of this + vulnerability. + type: array + items: + $ref: '#/components/schemas/RelatedUrl' + state: + description: Provides the state of this Vulnerability assessment. + type: string + enumDescriptions: + - No state is specified. + - This product is known to be affected by this vulnerability. + - This product is known to be not affected by this vulnerability. + - This product contains a fix for this vulnerability. + - >- + It is not known yet whether these versions are or are not affected + by the vulnerability. However, it is still under investigation. + enum: + - STATE_UNSPECIFIED + - AFFECTED + - NOT_AFFECTED + - FIXED + - UNDER_INVESTIGATION + impacts: + description: >- + Contains information about the impact of this vulnerability, this + will change with time. + type: array + items: + type: string + justification: + description: >- + Justification provides the justification when the state of the + assessment if NOT_AFFECTED. + $ref: '#/components/schemas/Justification' + remediations: + description: >- + Specifies details on how to handle (and presumably, fix) a + vulnerability. + type: array + items: + $ref: '#/components/schemas/Remediation' + SBOMReferenceNote: + id: SBOMReferenceNote + description: The note representing an SBOM reference. + type: object + properties: + format: + description: The format that SBOM takes. E.g. may be spdx, cyclonedx, etc... + type: string + version: + description: >- + The version of the format that the SBOM takes. E.g. if the format is + spdx, the version may be 2.3. + type: string + SecretNote: + id: SecretNote + description: The note representing a secret. + type: object + properties: {} + ListNotesResponse: + id: ListNotesResponse + description: Response for listing notes. + type: object + properties: + notes: + description: The notes requested. + type: array + items: + $ref: '#/components/schemas/Note' + nextPageToken: + description: >- + The next pagination token in the list response. It should be used as + `page_token` for the following request. An empty value means no more + results. + type: string + unreachable: + description: >- + Unordered list. Unreachable regions. Populated for requests from the + global region when `return_partial_success` is set. Format: + `projects/[PROJECT_ID]/locations/[LOCATION]` + type: array + items: + type: string + BatchCreateNotesRequest: + id: BatchCreateNotesRequest + description: Request to create notes in batch. + type: object + properties: + notes: + description: Required. The notes to create. Max allowed length is 1000. + type: object + additionalProperties: + $ref: '#/components/schemas/Note' + BatchCreateNotesResponse: + id: BatchCreateNotesResponse + description: Response for creating notes in batch. + type: object + properties: + notes: + description: The notes that were created. + type: array + items: + $ref: '#/components/schemas/Note' + ListNoteOccurrencesResponse: + id: ListNoteOccurrencesResponse + description: Response for listing occurrences for a note. + type: object + properties: + occurrences: + description: The occurrences attached to the specified note. + type: array + items: + $ref: '#/components/schemas/Occurrence' + nextPageToken: + description: Token to provide to skip to a particular spot in the list. + type: string + SetIamPolicyRequest: + id: SetIamPolicyRequest + description: Request message for `SetIamPolicy` method. + type: object + properties: + policy: + description: >- + REQUIRED: The complete policy to be applied to the `resource`. The + size of the policy is limited to a few 10s of KB. An empty policy is + a valid policy but certain Google Cloud services (such as Projects) + might reject them. + $ref: '#/components/schemas/Policy' + Policy: + id: Policy + description: >- + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. A `Policy` is a collection of + `bindings`. A `binding` binds one or more `members`, or principals, to a + single `role`. Principals can be user accounts, service accounts, Google + groups, and domains (such as G Suite). A `role` is a named list of + permissions; each `role` can be an IAM predefined role or a user-created + custom role. For some types of Google Cloud resources, a `binding` can + also specify a `condition`, which is a logical expression that allows + access to a resource only if the expression evaluates to `true`. A + condition can add constraints based on attributes of the request, the + resource, or both. To learn which resources support conditions in their + IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + **JSON example:** ``` { "bindings": [ { "role": + "roles/resourcemanager.organizationAdmin", "members": [ + "user:mike@example.com", "group:admins@example.com", + "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { + "role": "roles/resourcemanager.organizationViewer", "members": [ + "user:eve@example.com" ], "condition": { "title": "expirable access", + "description": "Does not grant access after Sep 2020", "expression": + "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": + "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - + members: - user:mike@example.com - group:admins@example.com - + domain:google.com - + serviceAccount:my-project-id@appspot.gserviceaccount.com role: + roles/resourcemanager.organizationAdmin - members: - + user:eve@example.com role: roles/resourcemanager.organizationViewer + condition: title: expirable access description: Does not grant access + after Sep 2020 expression: request.time < + timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` + For a description of IAM and its features, see the [IAM + documentation](https://cloud.google.com/iam/docs/). + type: object + properties: + 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). + type: integer + format: int32 + bindings: + description: >- + Associates a list of `members`, or principals, with a `role`. + Optionally, may specify a `condition` that determines how and when + the `bindings` are applied. Each of the `bindings` must contain at + least one principal. The `bindings` in a `Policy` can refer to up to + 1,500 principals; up to 250 of these principals can be Google + groups. Each occurrence of a principal counts towards these limits. + For example, if the `bindings` grant 50 different roles to + `user:alice@example.com`, and not to any other principal, then you + can add another 1,450 principals to the `bindings` in the `Policy`. + type: array + items: + $ref: '#/components/schemas/Binding' + 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. + type: string + format: byte + Binding: + id: Binding + description: Associates `members`, or principals, with a `role`. + type: object + properties: + role: + description: >- + Role that is assigned to the list of `members`, or principals. For + example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an + overview of the IAM roles and permissions, see the [IAM + documentation](https://cloud.google.com/iam/docs/roles-overview). + For a list of the available pre-defined roles, see + [here](https://cloud.google.com/iam/docs/understanding-roles). + type: string + members: + description: >- + Specifies the principals requesting access for a Google Cloud + 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. Does not include identities + that come from external identity providers (IdPs) through identity + federation. * `user:{emailid}`: An email address that represents a + specific Google account. For example, `alice@example.com` . * + `serviceAccount:{emailid}`: An email address that represents a + Google service account. For example, + `my-other-app@appspot.gserviceaccount.com`. * + `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: + An identifier for a [Kubernetes service + account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). + For example, + `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * + `group:{emailid}`: An email address that represents a Google group. + For example, `admins@example.com`. * `domain:{domain}`: The G Suite + domain (primary) that represents all the users of that domain. For + example, `google.com` or `example.com`. * + `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workforce identity pool. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: + All workforce identities in a group. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All workforce identities with a specific attribute value. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: + All identities in a workforce identity pool. * + `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workload identity pool. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: + A workload identity pool group. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All identities in a workload identity pool with a certain attribute. + * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: + All identities in a workload identity pool. * + `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. * + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + Deleted single identity in a workforce identity pool. For example, + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + type: array + items: + type: string + condition: + description: >- + The condition that is associated with this binding. If the condition + evaluates to `true`, then this binding applies to the current + request. If the condition evaluates to `false`, then this binding + does not apply to the current request. However, a different role + binding might grant the same role to one or more of the principals + in this binding. To learn which resources support conditions in + their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + $ref: '#/components/schemas/Expr' + Expr: + id: 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. + type: object + properties: + expression: + description: >- + Textual representation of an expression in Common Expression + Language syntax. + 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 + 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 + 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 + GetIamPolicyRequest: + id: GetIamPolicyRequest + description: Request message for `GetIamPolicy` method. + type: object + properties: + options: + description: >- + OPTIONAL: A `GetPolicyOptions` object for specifying options to + `GetIamPolicy`. + $ref: '#/components/schemas/GetPolicyOptions' + GetPolicyOptions: + id: GetPolicyOptions + description: Encapsulates settings provided to GetIamPolicy. + type: object + properties: + requestedPolicyVersion: + description: >- + Optional. The maximum policy version that will be used to format the + policy. Valid values are 0, 1, and 3. Requests specifying an invalid + value will be rejected. Requests for policies with any conditional + role bindings must specify version 3. Policies with no conditional + role bindings may specify any valid value or leave the field unset. + The policy in the response might use the policy version that you + specified, or it might use a lower policy version. For example, if + you specify version 3, but the policy has no conditional role + bindings, the response uses version 1. To learn which resources + support conditions in their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + type: integer + format: int32 + TestIamPermissionsRequest: + id: TestIamPermissionsRequest + description: Request message for `TestIamPermissions` method. + type: object + properties: + permissions: + description: >- + The set of permissions to check for the `resource`. Permissions with + wildcards (such as `*` or `storage.*`) are not allowed. For more + information see [IAM + Overview](https://cloud.google.com/iam/docs/overview#permissions). + type: array + items: + type: string + TestIamPermissionsResponse: + id: TestIamPermissionsResponse + description: Response message for `TestIamPermissions` method. + type: object + properties: + permissions: + description: >- + A subset of `TestPermissionsRequest.permissions` that the caller is + allowed. + type: array + items: + type: string + VulnerabilityOccurrencesSummary: + id: VulnerabilityOccurrencesSummary + description: >- + A summary of how many vulnerability occurrences there are per resource + and severity type. + type: object + properties: + counts: + description: >- + A listing by resource of the number of fixable and total + vulnerabilities. + type: array + items: + $ref: '#/components/schemas/FixableTotalByDigest' + unreachable: + description: >- + Unordered list. Unreachable regions. Populated for requests from the + global region when `return_partial_success` is set. Format: + `projects/[PROJECT_ID]/locations/[LOCATION]` + type: array + items: + type: string + FixableTotalByDigest: + id: FixableTotalByDigest + description: Per resource and severity counts of fixable and total vulnerabilities. + type: object + properties: + resourceUri: + description: The affected resource. + type: string + severity: + description: >- + The severity for this count. SEVERITY_UNSPECIFIED indicates total + across all severities. + type: string + enumDescriptions: + - Unknown. + - Minimal severity. + - Low severity. + - Medium severity. + - High severity. + - Critical severity. + enum: + - SEVERITY_UNSPECIFIED + - MINIMAL + - LOW + - MEDIUM + - HIGH + - CRITICAL + fixableCount: + description: The number of fixable vulnerabilities associated with this resource. type: string - enum: - - DEFAULT_LOGS_BUCKET_BEHAVIOR_UNSPECIFIED - - REGIONAL_USER_OWNED_BUCKET - - LEGACY_BUCKET - description: Optional. Option to specify how default logs buckets are setup. - workerPool: - description: This field deprecated; please use `pool.name` instead. - deprecated: true + format: int64 + totalCount: + description: The total number of vulnerabilities associated with this resource. type: string - requestedVerifyOption: - enum: - - NOT_VERIFIED - - VERIFIED - enumDescriptions: - - Not a verifiable build (the default). - - Build must be verified. - description: Requested verifiability options. + format: int64 + ExportSBOMRequest: + id: ExportSBOMRequest + description: >- + The request to generate and export SBOM. Target must be specified for + the request. + type: object + properties: + cloudStorageLocation: + description: >- + Optional. Empty placeholder to denote that this is a Google Cloud + Storage export request. + $ref: '#/components/schemas/CloudStorageLocation' + CloudStorageLocation: + id: CloudStorageLocation + description: >- + Empty placeholder to denote that this is a Google Cloud Storage export + request. + type: object + properties: {} + ExportSBOMResponse: + id: ExportSBOMResponse + description: The response from a call to ExportSBOM. + type: object + properties: + discoveryOccurrence: + description: >- + The name of the discovery occurrence in the form + "projects/{project_id}/occurrences/{OCCURRENCE_ID} It can be used to + track the progress of the SBOM export. type: string - logging: + GoogleDevtoolsContaineranalysisV1alpha1OperationMetadata: + id: GoogleDevtoolsContaineranalysisV1alpha1OperationMetadata + description: >- + Metadata for all operations used and required for all operations that + created by Container Analysis Providers + type: object + properties: + createTime: + description: Output only. The time this operation was created. + type: string + format: google-datetime + endTime: description: >- - Option to specify the logging mode, which determines if and where - build logs are stored. - enumDeprecated: - - false - - false - - false - - true - - false - - false + Output only. The time that this operation was marked completed or + failed. type: string - enum: - - LOGGING_UNSPECIFIED - - LEGACY - - GCS_ONLY - - STACKDRIVER_ONLY - - CLOUD_LOGGING_ONLY - - NONE - enumDescriptions: - - >- - The service determines the logging mode. The default is `LEGACY`. - Do not rely on the default logging behavior as it may change in - the future. - - Build logs are stored in Cloud Logging and Cloud Storage. - - Build logs are stored in Cloud Storage. - - This option is the same as CLOUD_LOGGING_ONLY. - - >- - Build logs are stored in Cloud Logging. Selecting this option will - not allow [logs - streaming](https://cloud.google.com/sdk/gcloud/reference/builds/log). - - Turn off all logging. No build logs will be captured. - sourceProvenanceHash: + format: google-datetime + ContaineranalysisGoogleDevtoolsCloudbuildV1BuildStep: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildStep + description: A step in the build pipeline. + type: object + properties: + name: + description: >- + Required. The name of the container image that will run this + particular build step. If the image is available in the host's + Docker daemon's cache, it will be run directly. If not, the host + will attempt to pull the image first, using the builder service + account's credentials if necessary. The Docker daemon's cache will + already have the latest versions of all of the officially supported + build steps + ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). + The Docker daemon will also have cached many of the layers for some + popular images, like "ubuntu", "debian", but they will be refreshed + at the time you attempt to use them. If you built an image in a + previous build step, it will be stored in the host's Docker daemon's + cache and is available to use as the name for a later build step. + type: string + env: + description: >- + A list of environment variable definitions to be used when running a + step. The elements are of the form "KEY=VALUE" for the environment + variable "KEY" being given the value "VALUE". + type: array items: - enumDescriptions: - - No hash requested. - - Use a sha256 hash. - - Use a md5 hash. - - Use a sha512 hash. type: string - enum: - - NONE - - SHA256 - - MD5 - - SHA512 - description: Requested hash for SourceProvenance. + args: + description: >- + A list of arguments that will be presented to the step when it is + started. If the image used to run the step's container has an + entrypoint, the `args` are used as arguments to that entrypoint. If + the image does not define an entrypoint, the first element in args + is used as the entrypoint, and the remainder will be used as + arguments. + type: array + items: + type: string + dir: + description: >- + Working directory to use when running this step's container. If this + value is a relative path, it is relative to the build's working + directory. If this value is absolute, it may be outside the build's + working directory, in which case the contents of the path may not be + persisted across build step executions, unless a `volume` for that + path is specified. If the build specifies a `RepoSource` with `dir` + and a step with a `dir`, which specifies an absolute path, the + `RepoSource` `dir` is ignored for the step's execution. + type: string + id: + description: >- + Unique identifier for this build step, used in `wait_for` to + reference this build step as a dependency. + type: string + waitFor: + description: >- + The ID(s) of the step(s) that this build step depends on. This build + step will not start until all the build steps in `wait_for` have + completed successfully. If `wait_for` is empty, this build step will + start when all previous build steps in the `Build.Steps` list have + completed successfully. + type: array + items: + type: string + entrypoint: + description: >- + Entrypoint to be used instead of the build step image's default + entrypoint. If unset, the image's default entrypoint is used. + type: string + secretEnv: + description: >- + A list of environment variables which are encrypted using a Cloud + Key Management Service crypto key. These values must be specified in + the build's `Secret`. type: array + items: + type: string volumes: description: >- - Global list of volumes to mount for ALL build steps Each volume is - created as an empty volume prior to starting the build process. Upon + List of volumes to mount into the build step. Each volume is created + as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. - Global volume names and paths cannot conflict with the volumes - defined a build step. Using a global volume in a build with only one - step is not valid as it is indicative of a build request with an - incorrect configuration. + Using a named volume in only one step is not valid as it is + indicative of a build request with an incorrect configuration. + type: array items: $ref: >- #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Volume - type: array - secretEnv: + timing: + description: >- + Output only. Stores timing information for executing this build + step. + readOnly: true + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan + pullTiming: + description: >- + Output only. Stores timing information for pulling this build step's + builder image only. + readOnly: true + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan + timeout: + description: >- + Time limit for executing this build step. If not defined, the step + has no time limit and will be allowed to continue to run until + either it completes or the build itself times out. + type: string + format: google-duration + status: + description: >- + Output only. Status of the build step. At this time, build step + status is only updated on build completion; step status is not + updated in real-time as the build progresses. + readOnly: true + type: string + enumDescriptions: + - Status of the build is unknown. + - >- + Build has been created and is pending execution and queuing. It + has not been queued. + - Build or step is queued; work has not yet begun. + - Build or step is being executed. + - Build or step finished successfully. + - Build or step failed to complete successfully. + - Build or step failed due to an internal cause. + - Build or step took longer than was allowed. + - Build or step was canceled by a user. + - Build was enqueued for longer than the value of `queue_ttl`. + enum: + - STATUS_UNKNOWN + - PENDING + - QUEUED + - WORKING + - SUCCESS + - FAILURE + - INTERNAL_ERROR + - TIMEOUT + - CANCELLED + - EXPIRED + allowFailure: + description: >- + Allow this build step to fail without failing the entire build. If + false, the entire build will fail if this step fails. Otherwise, the + build will succeed, but this step will still have a failure status. + Error information will be reported in the failure_detail field. + type: boolean + exitCode: + description: Output only. Return code from running the step. + readOnly: true + type: integer + format: int32 + allowExitCodes: description: >- - A list of global environment variables, which are encrypted using a - Cloud Key Management Service crypto key. These values must be - specified in the build's `Secret`. These variables will be available - to all build steps in this build. + Allow this build step to fail without failing the entire build if + and only if the exit code is one of the specified codes. If + allow_failure is also specified, this field will take precedence. type: array items: - type: string + type: integer + format: int32 + script: + description: >- + A shell script to be executed in the step. When script is provided, + the user cannot specify the entrypoint or args. + type: string automapSubstitutions: - type: boolean description: >- Option to include built-in and custom substitutions as env variables - for all build steps. - substitutionOption: - enumDescriptions: - - >- - Fails the build if error in substitutions checks, like missing a - substitution in the template or in the map. - - Do not fail the build if error in substitutions checks. + for this build step. This option will override the global option in + BuildOption. + type: boolean + ContaineranalysisGoogleDevtoolsCloudbuildV1Volume: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1Volume + description: >- + Volume describes a Docker container volume which is mounted into build + steps in order to persist files across build step execution. + type: object + properties: + name: description: >- - Option to specify behavior when there is an error in the - substitution checks. NOTE: this is always set to ALLOW_LOOSE for - triggered builds and cannot be overridden in the build configuration - file. - enum: - - MUST_MATCH - - ALLOW_LOOSE + Name of the volume to mount. Volume names must be unique per build + step and must be valid names for Docker volumes. Each named volume + must be used by at least two build steps. type: string - logStreamingOption: - description: Option to define build log streaming behavior to Cloud Storage. + path: + description: >- + Path at which to mount the volume. Paths must be absolute and cannot + conflict with other volume paths on the same build step or with + certain reserved volume paths. type: string - enum: - - STREAM_DEFAULT - - STREAM_ON - - STREAM_OFF - enumDescriptions: - - Service may automatically determine build log streaming behavior. - - Build logs should be streamed to Cloud Storage. - - >- - Build logs should not be streamed to Cloud Storage; they will be - written when the build is completed. + ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan + description: Start and end times for a build execution phase. type: object - Policy: - description: >- - An Identity and Access Management (IAM) policy, which specifies access - controls for Google Cloud resources. A `Policy` is a collection of - `bindings`. A `binding` binds one or more `members`, or principals, to a - single `role`. Principals can be user accounts, service accounts, Google - groups, and domains (such as G Suite). A `role` is a named list of - permissions; each `role` can be an IAM predefined role or a user-created - custom role. For some types of Google Cloud resources, a `binding` can - also specify a `condition`, which is a logical expression that allows - access to a resource only if the expression evaluates to `true`. A - condition can add constraints based on attributes of the request, the - resource, or both. To learn which resources support conditions in their - IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - **JSON example:** ``` { "bindings": [ { "role": - "roles/resourcemanager.organizationAdmin", "members": [ - "user:mike@example.com", "group:admins@example.com", - "domain:google.com", - "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { - "role": "roles/resourcemanager.organizationViewer", "members": [ - "user:eve@example.com" ], "condition": { "title": "expirable access", - "description": "Does not grant access after Sep 2020", "expression": - "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": - "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - - members: - user:mike@example.com - group:admins@example.com - - domain:google.com - - serviceAccount:my-project-id@appspot.gserviceaccount.com role: - roles/resourcemanager.organizationAdmin - members: - - user:eve@example.com role: roles/resourcemanager.organizationViewer - condition: title: expirable access description: Does not grant access - after Sep 2020 expression: request.time < - timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` - For a description of IAM and its features, see the [IAM - documentation](https://cloud.google.com/iam/docs/). properties: - etag: - format: byte + startTime: + description: Start of time span. type: string - 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. - bindings: - type: array - items: - $ref: '#/components/schemas/Binding' - description: >- - Associates a list of `members`, or principals, with a `role`. - Optionally, may specify a `condition` that determines how and when - the `bindings` are applied. Each of the `bindings` must contain at - least one principal. The `bindings` in a `Policy` can refer to up to - 1,500 principals; up to 250 of these principals can be Google - groups. Each occurrence of a principal counts towards these limits. - For example, if the `bindings` grant 50 different roles to - `user:alice@example.com`, and not to any other principal, then you - can add another 1,450 principals to the `bindings` in the `Policy`. - 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 - id: Policy - ImageOccurrence: - description: >- - Details of the derived image portion of the DockerImage relationship. - This image would be produced from a Dockerfile with FROM . + format: google-datetime + endTime: + description: End of time span. + type: string + format: google-datetime + BuildStep: + id: BuildStep + description: 'A step in the build pipeline. Next ID: 23' type: object properties: - fingerprint: - description: Required. The fingerprint of the derived image. - $ref: '#/components/schemas/Fingerprint' - baseResourceUrl: + name: + description: >- + Required. The name of the container image that will run this + particular build step. If the image is available in the host's + Docker daemon's cache, it will be run directly. If not, the host + will attempt to pull the image first, using the builder service + account's credentials if necessary. The Docker daemon's cache will + already have the latest versions of all of the officially supported + build steps + ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). + The Docker daemon will also have cached many of the layers for some + popular images, like "ubuntu", "debian", but they will be refreshed + at the time you attempt to use them. If you built an image in a + previous build step, it will be stored in the host's Docker daemon's + cache and is available to use as the name for a later build step. type: string + env: description: >- - Output only. This contains the base image URL for the derived image - occurrence. - distance: + A list of environment variable definitions to be used when running a + step. The elements are of the form "KEY=VALUE" for the environment + variable "KEY" being given the value "VALUE". + type: array + items: + type: string + args: description: >- - Output only. The number of layers by which this image differs from - the associated image basis. - format: int32 - type: integer - layerInfo: + A list of arguments that will be presented to the step when it is + started. If the image used to run the step's container has an + entrypoint, the `args` are used as arguments to that entrypoint. If + the image does not define an entrypoint, the first element in args + is used as the entrypoint, and the remainder will be used as + arguments. type: array items: - $ref: '#/components/schemas/Layer' + type: string + dir: description: >- - This contains layer-specific metadata, if populated it has length - "distance" and is ordered with [distance] being the layer - immediately following the base image and [1] being the final layer. - id: ImageOccurrence - ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedMavenArtifact: - properties: - uri: + Working directory to use when running this step's container. If this + value is a relative path, it is relative to the build's working + directory. If this value is absolute, it may be outside the build's + working directory, in which case the contents of the path may not be + persisted across build step executions, unless a `volume` for that + path is specified. If the build specifies a `RepoSource` with `dir` + and a step with a `dir`, which specifies an absolute path, the + `RepoSource` `dir` is ignored for the step's execution. type: string - description: URI of the uploaded artifact. - fileHashes: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes - description: Hash types and values of the Maven Artifact. - pushTiming: + id: description: >- - Output only. Stores timing information for pushing the specified - artifact. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan - readOnly: true - description: A Maven artifact uploaded using the MavenArtifact directive. - type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedMavenArtifact - Version: - properties: - epoch: - format: int32 - type: integer - description: Used to correct mistakes in the version numbering scheme. - revision: - description: The iteration of the package build from the above version. - type: string - name: + Unique identifier for this build step, used in `wait_for` to + reference this build step as a dependency. type: string + waitFor: description: >- - Required only when version kind is NORMAL. The main part of the - version name. - fullName: + The ID(s) of the step(s) that this build step depends on. This build + step will not start until all the build steps in `wait_for` have + completed successfully. If `wait_for` is empty, this build step will + start when all previous build steps in the `Build.Steps` list have + completed successfully. + type: array + items: + type: string + entrypoint: + description: >- + Entrypoint to be used instead of the build step image's default + entrypoint. If unset, the image's default entrypoint is used. type: string + secretEnv: description: >- - Human readable version string. This string is of the form :- and is - only set when kind is NORMAL. - inclusive: - type: boolean + A list of environment variables which are encrypted using a Cloud + Key Management Service crypto key. These values must be specified in + the build's `Secret`. + type: array + items: + type: string + volumes: description: >- - Whether this version is specifying part of an inclusive range. - Grafeas does not have the capability to specify version ranges; - instead we have fields that specify start version and end versions. - At times this is insufficient - we also need to specify whether the - version is included in the range or is excluded from the range. This - boolean is expected to be set to true when the version is included - in a range. - kind: - type: string - enumDescriptions: - - Unknown. - - A standard package version. - - A special version representing negative infinity. - - A special version representing positive infinity. + List of volumes to mount into the build step. Each volume is created + as an empty volume prior to execution of the build step. Upon + completion of the build, volumes and their contents are discarded. + Using a named volume in only one step is not valid as it is + indicative of a build request with an incorrect configuration. + type: array + items: + $ref: '#/components/schemas/Volume' + timing: description: >- - Required. Distinguishes between sentinel MIN/MAX versions and normal - versions. - enum: - - VERSION_KIND_UNSPECIFIED - - NORMAL - - MINIMUM - - MAXIMUM - id: Version - type: object - description: Version contains structured information about the version of a package. - ComplianceVersion: - type: object - properties: - benchmarkDocument: + Output only. Stores timing information for executing this build + step. + $ref: '#/components/schemas/TimeSpan' + pullTiming: + description: >- + Output only. Stores timing information for pulling this build step's + builder image only. + $ref: '#/components/schemas/TimeSpan' + timeout: + description: >- + Time limit for executing this build step. If not defined, the step + has no time limit and will be allowed to continue to run until + either it completes or the build itself times out. type: string + format: google-duration + status: description: >- - The name of the document that defines this benchmark, e.g. "CIS - Container-Optimized OS". - cpeUri: + Output only. Status of the build step. At this time, build step + status is only updated on build completion; step status is not + updated in real-time as the build progresses. type: string + enumDescriptions: + - Status of the build is unknown. + - >- + Build has been created and is pending execution and queuing. It + has not been queued. + - Build has been received and is being queued. + - Build or step is queued; work has not yet begun. + - Build or step is being executed. + - Build or step finished successfully. + - Build or step failed to complete successfully. + - Build or step failed due to an internal cause. + - Build or step took longer than was allowed. + - Build or step was canceled by a user. + - Build was enqueued for longer than the value of `queue_ttl`. + enum: + - STATUS_UNKNOWN + - PENDING + - QUEUING + - QUEUED + - WORKING + - SUCCESS + - FAILURE + - INTERNAL_ERROR + - TIMEOUT + - CANCELLED + - EXPIRED + allowFailure: description: >- - The CPE URI (https://cpe.mitre.org/specification/) this benchmark is - applicable to. - version: + Allow this build step to fail without failing the entire build. If + false, the entire build will fail if this step fails. Otherwise, the + build will succeed, but this step will still have a failure status. + Error information will be reported in the failure_detail field. + type: boolean + exitCode: + description: Output only. Return code from running the step. + type: integer + format: int32 + allowExitCodes: description: >- - The version of the benchmark. This is set to the version of the - OS-specific CIS document the benchmark is defined in. - type: string - description: >- - Describes the CIS benchmark version that is applicable to a given OS and - os version. - id: ComplianceVersion - ListNotesResponse: - description: Response for listing notes. - id: ListNotesResponse - type: object - properties: - nextPageToken: + Allow this build step to fail without failing the entire build if + and only if the exit code is one of the specified codes. If + allow_failure is also specified, this field will take precedence. + type: array + items: + type: integer + format: int32 + script: description: >- - The next pagination token in the list response. It should be used as - `page_token` for the following request. An empty value means no more - results. + A shell script to be executed in the step. When script is provided, + the user cannot specify the entrypoint or args. type: string - notes: - description: The notes requested. - items: - $ref: '#/components/schemas/Note' + automapSubstitutions: + description: >- + Option to include built-in and custom substitutions as env variables + for this build step. This option will override the global option in + BuildOption. + type: boolean + results: type: array - Material: - type: object - properties: - uri: + items: + $ref: '#/components/schemas/StepResult' + remoteConfig: + description: Remote configuration for the build step. type: string - digest: - additionalProperties: - type: string - type: object - id: Material - ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsNpmPackage: + Volume: + id: Volume + description: >- + Volume describes a Docker container volume which is mounted into build + steps in order to persist files across build step execution. Next ID: 3 type: object properties: - packagePath: - type: string - description: Path to the package.json. e.g. workspace/path/to/package - repository: - type: string + name: description: >- - Artifact Registry repository, in the form - "https://$REGION-npm.pkg.dev/$PROJECT/$REPOSITORY" Npm package in - the workspace specified by path will be zipped and uploaded to - Artifact Registry with this location as a prefix. - description: >- - Npm package to upload to Artifact Registry upon successful completion of - all build steps. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsNpmPackage - ContaineranalysisGoogleDevtoolsCloudbuildV1InlineSecret: - properties: - kmsKeyName: + Name of the volume to mount. Volume names must be unique per build + step and must be valid names for Docker volumes. Each named volume + must be used by at least two build steps. type: string + path: description: >- - Resource name of Cloud KMS crypto key to decrypt the encrypted - value. In format: projects/*/locations/*/keyRings/*/cryptoKeys/* - envMap: - description: >- - Map of environment variable name to its encrypted value. Secret - environment variables must be unique across all of a build's - secrets, and must be used by at least one build step. Values can be - at most 64 KB in size. There can be at most 100 secret values across - all of a build's secrets. - additionalProperties: - type: string - format: byte - type: object - type: object - description: >- - Pairs a set of secret environment variables mapped to encrypted values - with the Cloud KMS key to use to decrypt the value. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1InlineSecret - ListNoteOccurrencesResponse: - description: Response for listing occurrences for a note. - properties: - nextPageToken: - description: Token to provide to skip to a particular spot in the list. + Path at which to mount the volume. Paths must be absolute and cannot + conflict with other volume paths on the same build step or with + certain reserved volume paths. type: string - occurrences: - items: - $ref: '#/components/schemas/Occurrence' - description: The occurrences attached to the specified note. - type: array - id: ListNoteOccurrencesResponse - type: object - WindowsDetail: - id: WindowsDetail + TimeSpan: + id: TimeSpan + description: 'Start and end times for a build execution phase. Next ID: 3' type: object properties: - fixingKbs: - items: - $ref: '#/components/schemas/KnowledgeBase' - type: array - description: >- - Required. The names of the KBs which have hotfixes to mitigate this - vulnerability. Note that there may be multiple hotfixes (and thus - multiple KBs) that mitigate a given vulnerability. Currently any - listed KBs presence is considered a fix. - cpeUri: - type: string - description: >- - Required. The [CPE URI](https://cpe.mitre.org/specification/) this - vulnerability affects. - name: + startTime: + description: Start of time span. type: string - description: Required. The name of this vulnerability. - description: - description: The description of this vulnerability. + format: google-datetime + endTime: + description: End of time span. type: string - GrafeasV1SlsaProvenanceZeroTwoSlsaConfigSource: + format: google-datetime + StepResult: + id: StepResult + description: StepResult is the declaration of a result for a build step. type: object - description: >- - Describes where the config file that kicked off the build came from. - This is effectively a pointer to the source where buildConfig came from. properties: - entryPoint: + name: type: string - uri: + attestationContentName: type: string - digest: - type: object - additionalProperties: - type: string - id: GrafeasV1SlsaProvenanceZeroTwoSlsaConfigSource - BuildStep: - id: BuildStep + attestationType: + type: string + ContaineranalysisGoogleDevtoolsCloudbuildV1Build: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1Build + description: >- + A build resource in the Cloud Build API. At a high level, a `Build` + describes where to find source code, how to build it (for example, the + builder image to run on the source), and where to store the built + artifacts. Fields can include the following variables, which will be + expanded when the build is created: - $PROJECT_ID: the project ID of the + build. - $PROJECT_NUMBER: the project number of the build. - $LOCATION: + the location/region of the build. - $BUILD_ID: the autogenerated ID of + the build. - $REPO_NAME: the source repository name specified by + RepoSource. - $BRANCH_NAME: the branch name specified by RepoSource. - + $TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID or + $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the + specified branch or tag. - $SHORT_SHA: first 7 characters of + $REVISION_ID or $COMMIT_SHA. + type: object properties: - entrypoint: + name: description: >- - Entrypoint to be used instead of the build step image's default - entrypoint. If unset, the image's default entrypoint is used. + Output only. The 'Build' name with format: + `projects/{project}/locations/{location}/builds/{build}`, where + {build} is a unique identifier generated by the service. + readOnly: true + type: string + id: + description: Output only. Unique identifier of the build. + readOnly: true + type: string + projectId: + description: Output only. ID of the project. + readOnly: true type: string - volumes: - items: - $ref: '#/components/schemas/Volume' - description: >- - List of volumes to mount into the build step. Each volume is created - as an empty volume prior to execution of the build step. Upon - completion of the build, volumes and their contents are discarded. - Using a named volume in only one step is not valid as it is - indicative of a build request with an incorrect configuration. - type: array status: + description: Output only. Status of the build. + readOnly: true + type: string enumDescriptions: - Status of the build is unknown. - >- Build has been created and is pending execution and queuing. It has not been queued. - - Build has been received and is being queued. - Build or step is queued; work has not yet begun. - Build or step is being executed. - Build or step finished successfully. @@ -3828,11 +4324,9 @@ components: - Build or step took longer than was allowed. - Build or step was canceled by a user. - Build was enqueued for longer than the value of `queue_ttl`. - type: string enum: - STATUS_UNKNOWN - PENDING - - QUEUING - QUEUED - WORKING - SUCCESS @@ -3841,1524 +4335,1395 @@ components: - TIMEOUT - CANCELLED - EXPIRED - description: >- - Output only. Status of the build step. At this time, build step - status is only updated on build completion; step status is not - updated in real-time as the build progresses. - exitCode: - type: integer - description: Output only. Return code from running the step. - format: int32 - timing: - $ref: '#/components/schemas/TimeSpan' - description: >- - Output only. Stores timing information for executing this build - step. - allowExitCodes: - type: array - items: - format: int32 - type: integer - description: >- - Allow this build step to fail without failing the entire build if - and only if the exit code is one of the specified codes. If - allow_failure is also specified, this field will take precedence. - timeout: - description: >- - Time limit for executing this build step. If not defined, the step - has no time limit and will be allowed to continue to run until - either it completes or the build itself times out. - type: string - format: google-duration - name: - type: string - description: >- - Required. The name of the container image that will run this - particular build step. If the image is available in the host's - Docker daemon's cache, it will be run directly. If not, the host - will attempt to pull the image first, using the builder service - account's credentials if necessary. The Docker daemon's cache will - already have the latest versions of all of the officially supported - build steps - ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). - The Docker daemon will also have cached many of the layers for some - popular images, like "ubuntu", "debian", but they will be refreshed - at the time you attempt to use them. If you built an image in a - previous build step, it will be stored in the host's Docker daemon's - cache and is available to use as the name for a later build step. - pullTiming: - $ref: '#/components/schemas/TimeSpan' - description: >- - Output only. Stores timing information for pulling this build step's - builder image only. - dir: - description: >- - Working directory to use when running this step's container. If this - value is a relative path, it is relative to the build's working - directory. If this value is absolute, it may be outside the build's - working directory, in which case the contents of the path may not be - persisted across build step executions, unless a `volume` for that - path is specified. If the build specifies a `RepoSource` with `dir` - and a step with a `dir`, which specifies an absolute path, the - `RepoSource` `dir` is ignored for the step's execution. - type: string - secretEnv: - type: array - items: - type: string - description: >- - A list of environment variables which are encrypted using a Cloud - Key Management Service crypto key. These values must be specified in - the build's `Secret`. - automapSubstitutions: - description: >- - Option to include built-in and custom substitutions as env variables - for this build step. This option will override the global option in - BuildOption. - type: boolean - waitFor: - items: - type: string - type: array - description: >- - The ID(s) of the step(s) that this build step depends on. This build - step will not start until all the build steps in `wait_for` have - completed successfully. If `wait_for` is empty, this build step will - start when all previous build steps in the `Build.Steps` list have - completed successfully. - allowFailure: - type: boolean - description: >- - Allow this build step to fail without failing the entire build. If - false, the entire build will fail if this step fails. Otherwise, the - build will succeed, but this step will still have a failure status. - Error information will be reported in the failure_detail field. - script: - type: string - description: >- - A shell script to be executed in the step. When script is provided, - the user cannot specify the entrypoint or args. - id: + statusDetail: + description: Output only. Customer-readable message about the current status. + readOnly: true type: string - description: >- - Unique identifier for this build step, used in `wait_for` to - reference this build step as a dependency. - env: - items: - type: string - description: >- - A list of environment variable definitions to be used when running a - step. The elements are of the form "KEY=VALUE" for the environment - variable "KEY" being given the value "VALUE". - type: array - args: + source: + description: Optional. The location of the source files to build. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Source + steps: + description: Required. The operations to be performed on the workspace. type: array items: - type: string - description: >- - A list of arguments that will be presented to the step when it is - started. If the image used to run the step's container has an - entrypoint, the `args` are used as arguments to that entrypoint. If - the image does not define an entrypoint, the first element in args - is used as the entrypoint, and the remainder will be used as - arguments. - description: 'A step in the build pipeline. Next ID: 21' - type: object - UpgradeDistribution: - type: object - description: >- - The Upgrade Distribution represents metadata about the Upgrade for each - operating system (CPE). Some distributions have additional metadata - around updates, classifying them into various categories and severities. - properties: - cpeUri: - description: >- - Required - The specific operating system this metadata applies to. - See https://cpe.mitre.org/specification/. - type: string - classification: - description: >- - The operating system classification of this Upgrade, as specified by - the upstream operating system upgrade feed. For Windows the - classification is one of the category_ids listed at - https://docs.microsoft.com/en-us/previous-versions/windows/desktop/ff357803(v=vs.85) - type: string - cve: - items: - type: string - type: array - description: The cve tied to this Upgrade. - severity: - type: string - description: The severity as specified by the upstream operating system. - id: UpgradeDistribution - CloudRepoSourceContext: - description: >- - A CloudRepoSourceContext denotes a particular revision in a Google Cloud - Source Repo. - properties: - repoId: - description: The ID of the repo. - $ref: '#/components/schemas/RepoId' - aliasContext: - $ref: '#/components/schemas/AliasContext' - description: An alias, which may be a branch or tag. - revisionId: - type: string - description: A revision ID. - id: CloudRepoSourceContext - type: object - ExportSBOMResponse: - description: The response from a call to ExportSBOM. - id: ExportSBOMResponse - properties: - discoveryOccurrence: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildStep + results: + description: Output only. Results of the build. + readOnly: true + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Results + createTime: + description: >- + Output only. Time at which the request to create the build was + received. + readOnly: true + type: string + format: google-datetime + startTime: + description: Output only. Time at which execution of the build was started. + readOnly: true type: string + format: google-datetime + finishTime: description: >- - The name of the discovery occurrence in the form - "projects/{project_id}/occurrences/{OCCURRENCE_ID} It can be used to - track the progress of the SBOM export. - type: object - SBOMStatus: - properties: - sbomState: - enum: - - SBOM_STATE_UNSPECIFIED - - PENDING - - COMPLETE - description: The progress of the SBOM generation. - enumDescriptions: - - Default unknown state. - - SBOM scanning is pending. - - SBOM scanning has completed. + Output only. Time at which execution of the build was finished. The + difference between finish_time and start_time is the duration of the + build's execution. + readOnly: true type: string - error: + format: google-datetime + timeout: description: >- - If there was an error generating an SBOM, this will indicate what - that error was. + Amount of time that this build should be allowed to run, to second + granularity. If this amount of time elapses, work on the build will + cease and the build status will be `TIMEOUT`. `timeout` starts + ticking from `startTime`. Default time is 60 minutes. type: string - id: SBOMStatus - description: The status of an SBOM generation. - type: object - SlsaProvenance: - id: SlsaProvenance - type: object - properties: - metadata: - $ref: '#/components/schemas/SlsaMetadata' - materials: - items: - $ref: '#/components/schemas/Material' + format: google-duration + images: description: >- - The collection of artifacts that influenced the build including - sources, dependencies, build tools, base images, and so on. This is - considered to be incomplete unless metadata.completeness.materials - is true. Unset or null is equivalent to empty. + A list of images to be pushed upon the successful completion of all + build steps. The images are pushed using the builder service + account's credentials. The digests of the pushed images will be + stored in the `Build` resource's results field. If any of the images + fail to be pushed, the build status is marked `FAILURE`. type: array - builder: - $ref: '#/components/schemas/SlsaBuilder' - description: required - recipe: - $ref: '#/components/schemas/SlsaRecipe' + items: + type: string + queueTtl: description: >- - Identifies the configuration used for the build. When combined with - materials, this SHOULD fully describe the build, such that - re-running this recipe results in bit-for-bit identical output (if - the build is reproducible). required - DiscoveryOccurrence: - properties: - lastScanTime: - format: google-datetime + TTL in queue for this build. If provided and the build is enqueued + longer than this value, the build will expire and the build status + will be `EXPIRED`. The TTL starts ticking from create_time. type: string - description: The last time this resource was scanned. - archiveTime: + format: google-duration + artifacts: + description: >- + Artifacts produced by the build that should be uploaded upon + successful completion of all build steps. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Artifacts + logsBucket: + description: >- + Cloud Storage bucket where logs should be written (see [Bucket Name + Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). + Logs file names will be of the format + `${logs_bucket}/log-${build_id}.txt`. type: string + sourceProvenance: + description: Output only. A permanent fixed identifier for source. + readOnly: true + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1SourceProvenance + buildTriggerId: description: >- - Output only. The time occurrences related to this discovery - occurrence were archived. - format: google-datetime + Output only. The ID of the `BuildTrigger` that triggered this build, + if it was triggered automatically. readOnly: true - analysisError: + type: string + options: + description: Special options for this build. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions + logUrl: + description: Output only. URL to logs for this build in Google Cloud Console. + readOnly: true + type: string + substitutions: + description: Substitutions data for `Build` resource. + type: object + additionalProperties: + type: string + tags: + description: Tags for annotation of a `Build`. These are not docker tags. + type: array items: - $ref: '#/components/schemas/Status' + type: string + secrets: description: >- - Indicates any errors encountered during analysis of a resource. - There could be 0 or more of these errors. + Secrets to decrypt using Cloud Key Management Service. Note: Secret + Manager is the recommended technique for managing sensitive data + with Cloud Build. Use `available_secrets` to configure builds to + access secrets from Secret Manager. For instructions, see: + https://cloud.google.com/cloud-build/docs/securing-builds/use-secrets type: array - analysisStatusError: + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Secret + timing: description: >- - When an error is encountered this will contain a LocalizedMessage - under details to show to the user. The LocalizedMessage is output - only and populated by the API. - $ref: '#/components/schemas/Status' - sbomStatus: - $ref: '#/components/schemas/SBOMStatus' - description: The status of an SBOM generation. - analysisStatus: - enum: - - ANALYSIS_STATUS_UNSPECIFIED - - PENDING - - SCANNING - - FINISHED_SUCCESS - - COMPLETE - - FINISHED_FAILED - - FINISHED_UNSUPPORTED - description: The status of discovery for the resource. - type: string - enumDescriptions: - - Unknown. - - Resource is known but no action has been taken yet. - - Resource is being analyzed. - - Analysis has finished successfully. - - Analysis has completed. - - >- - Analysis has finished unsuccessfully, the analysis itself is in a - bad state. - - The resource is known not to be supported. - cpe: - description: The CPE of the resource being scanned. - type: string - analysisCompleted: - $ref: '#/components/schemas/AnalysisCompleted' - continuousAnalysis: - enum: - - CONTINUOUS_ANALYSIS_UNSPECIFIED - - ACTIVE - - INACTIVE - enumDescriptions: - - Unknown. - - The resource is continuously analyzed. - - The resource is ignored for continuous analysis. + Output only. Stores timing information for phases of the build. + Valid keys are: * BUILD: time to execute all build steps. * PUSH: + time to push all artifacts including docker images and non docker + artifacts. * FETCHSOURCE: time to fetch source. * SETUPBUILD: time + to set up build. If the build does not specify source or images, + these keys will not be included. + readOnly: true + type: object + additionalProperties: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan + approval: + description: >- + Output only. Describes this build's approval configuration, status, + and result. + readOnly: true + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildApproval + serviceAccount: + description: >- + IAM service account whose credentials will be used at build runtime. + Must be of the format + `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. ACCOUNT can be + email address or uniqueId of the service account. type: string - description: Whether the resource is continuously analyzed. - type: object - id: DiscoveryOccurrence - description: Provides information about the analysis status of a discovered resource. - ListOccurrencesResponse: - id: ListOccurrencesResponse - type: object - properties: - occurrences: + availableSecrets: + description: Secrets and secret environment variables. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Secrets + warnings: + description: >- + Output only. Non-fatal problems encountered during the execution of + the build. + readOnly: true type: array items: - $ref: '#/components/schemas/Occurrence' - description: The occurrences requested. - nextPageToken: - description: >- - The next pagination token in the list response. It should be used as - `page_token` for the following request. An empty value means no more - results. - type: string - description: Response for listing occurrences. - AttestationNote: - id: AttestationNote - properties: - hint: - description: Hint hints at the purpose of the attestation authority. - $ref: '#/components/schemas/Hint' - type: object - description: >- - Note kind that represents a logical attestation "role" or "authority". - For example, an organization might have one `Authority` for "QA" and one - for "build". This note is intended to act strictly as a grouping - mechanism for the attached occurrences (Attestations). This grouping - mechanism also provides a security boundary, since IAM ACLs gate the - ability for a principle to attach an occurrence to a given note. It also - provides a single point of lookup to find all attached attestation - occurrences, even if they don't all live in the same project. - FileHashes: - description: >- - Container message for hashes of byte content of files, used in source - messages to verify integrity of source input to the build. - properties: - fileHash: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildWarning + gitConfig: + description: Optional. Configuration for git operations. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfig + failureInfo: + description: >- + Output only. Contains information about the build when + status=FAILURE. + readOnly: true + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildFailureInfo + dependencies: + description: >- + Optional. Dependencies that the Cloud Build worker will fetch before + executing user steps. type: array - description: Required. Collection of file hashes. items: - $ref: '#/components/schemas/Hash' - id: FileHashes + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Dependency + ContaineranalysisGoogleDevtoolsCloudbuildV1Source: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1Source + description: Location of the source in a supported storage service. type: object - CisBenchmark: - id: CisBenchmark properties: - severity: - enumDescriptions: - - Unknown. - - Minimal severity. - - Low severity. - - Medium severity. - - High severity. - - Critical severity. - type: string - enum: - - SEVERITY_UNSPECIFIED - - MINIMAL - - LOW - - MEDIUM - - HIGH - - CRITICAL - profileLevel: - type: integer - format: int32 + storageSource: + description: If provided, get the source from this location in Cloud Storage. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource + repoSource: + description: >- + If provided, get the source from this location in a Cloud Source + Repository. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1RepoSource + gitSource: + description: If provided, get the source from this Git repository. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1GitSource + storageSourceManifest: + description: >- + If provided, get the source from this manifest in Cloud Storage. + This feature is in Preview; see description + [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher). + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSourceManifest + connectedRepository: + description: >- + Optional. If provided, get the source from this 2nd-gen Google Cloud + Build repository resource. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ConnectedRepository + developerConnectConfig: + description: If provided, get the source from this Developer Connect config. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1DeveloperConnectConfig + ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource + description: Location of the source in an archive file in Cloud Storage. type: object - description: A compliance check that is a CIS benchmark. - BuildProvenance: - id: BuildProvenance - description: >- - Provenance of a build. Contains all information needed to verify the - full details about the build from source to completion. properties: - buildOptions: - type: object - additionalProperties: - type: string + bucket: description: >- - Special options applied to this build. This is a catch-all field - where build providers can enter any desired additional details. - logsUri: - description: URI where any logs for this provenance were written. + Cloud Storage bucket containing the source (see [Bucket Name + Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). type: string - projectId: - description: ID of the project. + object: + description: >- + Required. Cloud Storage object containing the source. This object + must be a zipped (`.zip`) or gzipped archive file (`.tar.gz`) + containing source to build. type: string - builtArtifacts: - type: array - description: Output of the build. - items: - $ref: '#/components/schemas/Artifact' - commands: - type: array - items: - $ref: '#/components/schemas/Command' - description: Commands requested by the build. - createTime: + generation: + description: >- + Optional. Cloud Storage generation for the object. If the generation + is omitted, the latest generation will be used. type: string - format: google-datetime - description: Time at which the build was created. - endTime: + format: int64 + sourceFetcher: + description: >- + Optional. Option to specify the tool to fetch the source file for + the build. type: string - description: Time at which execution of the build was finished. - format: google-datetime - sourceProvenance: - description: Details of the Source input to the build. - $ref: '#/components/schemas/Source' - creator: + enumDescriptions: + - Unspecified defaults to GSUTIL. + - Use the "gsutil" tool to download the source file. + - Use the Cloud Storage Fetcher tool to download the source file. + enum: + - SOURCE_FETCHER_UNSPECIFIED + - GSUTIL + - GCS_FETCHER + ContaineranalysisGoogleDevtoolsCloudbuildV1RepoSource: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1RepoSource + description: Location of the source in a Google Cloud Source Repository. + type: object + properties: + projectId: description: >- - E-mail address of the user who initiated this build. Note that this - was the user's e-mail address at the time the build was initiated; - this address may not represent the same end-user for all time. + Optional. ID of the project that owns the Cloud Source Repository. + If omitted, the project ID requesting the build is assumed. type: string - startTime: - format: google-datetime + repoName: + description: Required. Name of the Cloud Source Repository. type: string - description: Time at which execution of the build was started. - id: + branchName: + description: >- + Regex matching branches to build. The syntax of the regular + expressions accepted is the syntax accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax type: string - description: Required. Unique identifier of the build. - builderVersion: + tagName: + description: >- + Regex matching tags to build. The syntax of the regular expressions + accepted is the syntax accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax type: string - description: Version string of the builder at the time this build was executed. - triggerId: + commitSha: + description: Explicit commit SHA to build. type: string + dir: description: >- - Trigger identifier if the build was triggered automatically; empty - if not. - type: object - ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfig: - id: ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfig - description: GitConfig is a configuration for git operations. - properties: - http: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfigHttpConfig - description: Configuration for HTTP related git operations. - type: object - CloudStorageLocation: - type: object - description: >- - Empty placeholder to denote that this is a Google Cloud Storage export - request. - properties: {} - id: CloudStorageLocation - RunDetails: - id: RunDetails - properties: - metadata: - $ref: '#/components/schemas/BuildMetadata' - builder: - $ref: '#/components/schemas/ProvenanceBuilder' - byproducts: - type: array - items: - $ref: '#/components/schemas/ResourceDescriptor' - type: object - ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalConfig: - id: ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalConfig - description: ApprovalConfig describes configuration for manual approval of a build. - properties: - approvalRequired: + Optional. Directory, relative to the source root, in which to run + the build. This must be a relative path. If a step's `dir` is + specified and is an absolute path, this value is ignored for that + step's execution. + type: string + invertRegex: + description: >- + Optional. Only trigger a build if the revision regex does NOT match + the revision regex. type: boolean + substitutions: description: >- - Whether or not approval is needed. If this is set on a build, it - will become pending when created, and will need to be explicitly - approved to start. + Optional. Substitutions to use in a triggered build. Should only be + used with RunBuildTrigger + type: object + additionalProperties: + type: string + ContaineranalysisGoogleDevtoolsCloudbuildV1GitSource: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1GitSource + description: Location of the source in any accessible Git repository. type: object - PackageIssue: + properties: + url: + description: >- + Required. Location of the Git repo to build. This will be used as a + `git remote`, see https://git-scm.com/docs/git-remote. + type: string + dir: + description: >- + Optional. Directory, relative to the source root, in which to run + the build. This must be a relative path. If a step's `dir` is + specified and is an absolute path, this value is ignored for that + step's execution. + type: string + revision: + description: >- + Optional. The revision to fetch from the Git repository such as a + branch, a tag, a commit SHA, or any Git ref. Cloud Build uses `git + fetch` to fetch the revision from the Git repository; therefore make + sure that the string you provide for `revision` is parsable by the + command. For information on string values accepted by `git fetch`, + see https://git-scm.com/docs/gitrevisions#_specifying_revisions. For + information on `git fetch`, see https://git-scm.com/docs/git-fetch. + type: string + ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSourceManifest: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSourceManifest + description: >- + Location of the source manifest in Cloud Storage. This feature is in + Preview; see description + [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher). type: object - description: >- - A detail for a distro and package this vulnerability occurrence was - found in and its associated fix (if one is available). properties: - fixedVersion: - $ref: '#/components/schemas/Version' + bucket: description: >- - Required. The version of the package this vulnerability was fixed - in. Setting this to VersionKind.MAXIMUM means no fix is yet - available. - packageType: + Required. Cloud Storage bucket containing the source manifest (see + [Bucket Name + Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). type: string - description: The type of package (e.g. OS, MAVEN, GO). - affectedVersion: - $ref: '#/components/schemas/Version' + object: description: >- - Required. The version of the package that is installed on the - resource affected by this vulnerability. - fixedCpeUri: + Required. Cloud Storage object containing the source manifest. This + object must be a JSON file. + type: string + generation: description: >- - The [CPE URI](https://cpe.mitre.org/specification/) this - vulnerability was fixed in. It is possible for this to be different - from the affected_cpe_uri. + Cloud Storage generation for the object. If the generation is + omitted, the latest generation will be used. type: string - effectiveSeverity: - enumDescriptions: - - Unknown. - - Minimal severity. - - Low severity. - - Medium severity. - - High severity. - - Critical severity. - readOnly: true + format: int64 + ContaineranalysisGoogleDevtoolsCloudbuildV1ConnectedRepository: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1ConnectedRepository + description: >- + Location of the source in a 2nd-gen Google Cloud Build repository + resource. + type: object + properties: + repository: description: >- - Output only. The distro or language system assigned severity for - this vulnerability when that is available and note provider assigned - severity when it is not available. - enum: - - SEVERITY_UNSPECIFIED - - MINIMAL - - LOW - - MEDIUM - - HIGH - - CRITICAL + Required. Name of the Google Cloud Build repository, formatted as + `projects/*/locations/*/connections/*/repositories/*`. type: string - fixAvailable: - type: boolean - description: Output only. Whether a fix is available for this package. - fixedPackage: + dir: description: >- - The package this vulnerability was fixed in. It is possible for this - to be different from the affected_package. + Optional. Directory, relative to the source root, in which to run + the build. type: string - affectedPackage: - description: Required. The package this vulnerability was found in. + revision: + description: >- + Required. The revision to fetch from the Git repository such as a + branch, a tag, a commit SHA, or any Git ref. type: string - affectedCpeUri: + ContaineranalysisGoogleDevtoolsCloudbuildV1DeveloperConnectConfig: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1DeveloperConnectConfig + description: This config defines the location of a source through Developer Connect. + type: object + properties: + gitRepositoryLink: + description: >- + Required. The Developer Connect Git repository link, formatted as + `projects/*/locations/*/connections/*/gitRepositoryLink/*`. type: string + dir: description: >- - Required. The [CPE URI](https://cpe.mitre.org/specification/) this - vulnerability was found in. - fileLocation: - description: The location at which this package was found. - type: array - items: - $ref: '#/components/schemas/GrafeasV1FileLocation' - id: PackageIssue - ContaineranalysisGoogleDevtoolsCloudbuildV1SourceProvenance: + Required. Directory, relative to the source root, in which to run + the build. + type: string + revision: + description: >- + Required. The revision to fetch from the Git repository such as a + branch, a tag, a commit SHA, or any Git ref. + type: string + ContaineranalysisGoogleDevtoolsCloudbuildV1Results: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1Results + description: Artifacts created by the build pipeline. type: object properties: - resolvedStorageSourceManifest: - description: >- - A copy of the build's `source.storage_source_manifest`, if exists, - with any revisions resolved. This feature is in Preview. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSourceManifest - fileHashes: - type: object - additionalProperties: + images: + description: Container images that were built as a part of the build. + type: array + items: $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes - description: >- - Output only. Hash(es) of the build source, which can be used to - verify that the original source integrity was maintained in the - build. Note that `FileHashes` will only be populated if - `BuildOptions` has requested a `SourceProvenanceHash`. The keys to - this map are file paths used as build source and the values contain - the hash values for those files. If the build source came in a - single package such as a gzipped tarfile (`.tar.gz`), the `FileHash` - will be for the single path to that file. - readOnly: true - resolvedGitSource: + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuiltImage + buildStepImages: description: >- - Output only. A copy of the build's `source.git_source`, if exists, - with any revisions resolved. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1GitSource - readOnly: true - resolvedConnectedRepository: - readOnly: true + List of build step digests, in the order corresponding to build step + indices. + type: array + items: + type: string + artifactManifest: description: >- - Output only. A copy of the build's `source.connected_repository`, if - exists, with any revisions resolved. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ConnectedRepository - resolvedRepoSource: + Path to the artifact manifest for non-container artifacts uploaded + to Cloud Storage. Only populated when artifacts are uploaded to + Cloud Storage. + type: string + numArtifacts: description: >- - A copy of the build's `source.repo_source`, if exists, with any - revisions resolved. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1RepoSource - resolvedStorageSource: + Number of non-container artifacts uploaded to Cloud Storage. Only + populated when artifacts are uploaded to Cloud Storage. + type: string + format: int64 + buildStepOutputs: description: >- - A copy of the build's `source.storage_source`, if exists, with any - generations resolved. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource - id: ContaineranalysisGoogleDevtoolsCloudbuildV1SourceProvenance - description: >- - Provenance of the source. Ways to find the original source, or verify - that some source was used for this build. - ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedPythonPackage: - properties: - pushTiming: + List of build step outputs, produced by builder images, in the order + corresponding to build step indices. [Cloud + Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) + can produce this output by writing to `$BUILDER_OUTPUT/output`. Only + the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` + variable is read-only and can't be substituted. + type: array + items: + type: string + format: byte + artifactTiming: + description: Time to push all non-container artifacts to Cloud Storage. $ref: >- #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan - readOnly: true + pythonPackages: description: >- - Output only. Stores timing information for pushing the specified - artifact. - fileHashes: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes - description: Hash types and values of the Python Artifact. - uri: - type: string - description: URI of the uploaded artifact. - type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedPythonPackage - description: Artifact uploaded using the PythonPackage directive. - GrafeasV1SlsaProvenanceZeroTwoSlsaMetadata: - description: Other properties of the build. - id: GrafeasV1SlsaProvenanceZeroTwoSlsaMetadata - properties: - buildStartedOn: - type: string - format: google-datetime - buildInvocationId: - type: string - buildFinishedOn: - format: google-datetime - type: string - completeness: - $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaCompleteness' - reproducible: - type: boolean - type: object - UpgradeOccurrence: - type: object - id: UpgradeOccurrence - description: >- - An Upgrade Occurrence represents that a specific resource_url could - install a specific upgrade. This presence is supplied via local sources - (i.e. it is present in the mirror and the running system has noticed its - availability). For Windows, both distribution and windows_update contain - information for the Windows update. + Python artifacts uploaded to Artifact Registry at the end of the + build. + type: array + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedPythonPackage + mavenArtifacts: + description: >- + Maven artifacts uploaded to Artifact Registry at the end of the + build. + type: array + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedMavenArtifact + goModules: + description: >- + Optional. Go module artifacts uploaded to Artifact Registry at the + end of the build. + type: array + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedGoModule + npmPackages: + description: Npm packages uploaded to Artifact Registry at the end of the build. + type: array + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedNpmPackage + ContaineranalysisGoogleDevtoolsCloudbuildV1BuiltImage: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuiltImage + description: An image built by the pipeline. + type: object properties: - windowsUpdate: - description: >- - Required for Windows OS. Represents the metadata about the Windows - update. - $ref: '#/components/schemas/WindowsUpdate' - parsedVersion: - $ref: '#/components/schemas/Version' + name: description: >- - Required for non-Windows OS. The version of the package in a machine - + human readable form. - package: + Name used to push the container image to Google Container Registry, + as presented to `docker push`. type: string - description: Required for non-Windows OS. The package this Upgrade is for. - distribution: + digest: + description: Docker Registry 2.0 digest. + type: string + pushTiming: description: >- - Metadata about the upgrade for available for the specific operating - system for the resource_url. This allows efficient filtering, as - well as making it easier to use the occurrence. - $ref: '#/components/schemas/UpgradeDistribution' - SlsaProvenanceZeroTwo: + Output only. Stores timing information for pushing the specified + image. + readOnly: true + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan + ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedPythonPackage: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedPythonPackage + description: Artifact uploaded using the PythonPackage directive. + type: object properties: - builder: - $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaBuilder' - buildType: + uri: + description: URI of the uploaded artifact. type: string - materials: - items: - $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaMaterial' - type: array - invocation: - $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaInvocation' - metadata: - $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaMetadata' - buildConfig: - type: object - additionalProperties: - description: Properties of the object. - type: any - id: SlsaProvenanceZeroTwo + fileHashes: + description: Hash types and values of the Python Artifact. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes + pushTiming: + description: >- + Output only. Stores timing information for pushing the specified + artifact. + readOnly: true + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan + ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes + description: >- + Container message for hashes of byte content of files, used in + SourceProvenance messages to verify integrity of source input to the + build. type: object - description: See full explanation of fields at slsa.dev/provenance/v0.2. - ContaineranalysisGoogleDevtoolsCloudbuildV1BuildApproval: + properties: + fileHash: + description: Collection of file hashes. + type: array + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Hash + ContaineranalysisGoogleDevtoolsCloudbuildV1Hash: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1Hash + description: Container message for hash values. type: object - description: >- - BuildApproval describes a build's approval configuration, state, and - result. properties: - state: - enumDescriptions: - - Default enum type. This should not be used. - - Build approval is pending. - - Build approval has been approved. - - Build approval has been rejected. - - Build was cancelled while it was still pending approval. - description: Output only. The state of this build's approval. - readOnly: true + type: + description: The type of hash that was performed. type: string + enumDescriptions: + - No hash requested. + - Use a sha256 hash. + - Use a md5 hash. + - Dirhash of a Go module's source code which is then hex-encoded. + - Use a sha512 hash. enum: - - STATE_UNSPECIFIED - - PENDING - - APPROVED - - REJECTED - - CANCELLED - config: + - NONE + - SHA256 + - MD5 + - GO_MODULE_H1 + - SHA512 + value: + description: The hash value. + type: string + format: byte + ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedMavenArtifact: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedMavenArtifact + description: A Maven artifact uploaded using the MavenArtifact directive. + type: object + properties: + uri: + description: URI of the uploaded artifact. + type: string + fileHashes: + description: Hash types and values of the Maven Artifact. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes + pushTiming: + description: >- + Output only. Stores timing information for pushing the specified + artifact. readOnly: true $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalConfig - description: Output only. Configuration for manual approval of this build. - result: + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan + ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedGoModule: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedGoModule + description: >- + A Go module artifact uploaded to Artifact Registry using the GoModule + directive. + type: object + properties: + uri: + description: URI of the uploaded artifact. + type: string + fileHashes: + description: Hash types and values of the Go Module Artifact. $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalResult - description: Output only. Result of manual approval for this Build. + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes + pushTiming: + description: >- + Output only. Stores timing information for pushing the specified + artifact. readOnly: true - id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildApproval - GrafeasV1SlsaProvenanceZeroTwoSlsaBuilder: - id: GrafeasV1SlsaProvenanceZeroTwoSlsaBuilder + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan + ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedNpmPackage: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedNpmPackage + description: >- + An npm package uploaded to Artifact Registry using the NpmPackage + directive. + type: object properties: - id: + uri: + description: URI of the uploaded npm package. type: string - type: object + fileHashes: + description: Hash types and values of the npm package. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes + pushTiming: + description: >- + Output only. Stores timing information for pushing the specified + artifact. + readOnly: true + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan + ContaineranalysisGoogleDevtoolsCloudbuildV1Artifacts: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1Artifacts description: >- - Identifies the entity that executed the recipe, which is trusted to have - correctly performed the operation and populated this provenance. - BuildDefinition: + Artifacts produced by a build that should be uploaded upon successful + completion of all build steps. + type: object properties: - internalParameters: - additionalProperties: - type: any - description: Properties of the object. - type: object - resolvedDependencies: + images: + description: >- + A list of images to be pushed upon the successful completion of all + build steps. The images will be pushed using the builder service + account's credentials. The digests of the pushed images will be + stored in the Build resource's results field. If any of the images + fail to be pushed, the build is marked FAILURE. + type: array items: - $ref: '#/components/schemas/ResourceDescriptor' + type: string + objects: + description: >- + A list of objects to be uploaded to Cloud Storage upon successful + completion of all build steps. Files in the workspace matching + specified paths globs will be uploaded to the specified Cloud + Storage location using the builder service account's credentials. + The location and generation of the uploaded objects will be stored + in the Build resource's results field. If any objects fail to be + pushed, the build is marked FAILURE. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsArtifactObjects + mavenArtifacts: + description: >- + A list of Maven artifacts to be uploaded to Artifact Registry upon + successful completion of all build steps. Artifacts in the workspace + matching specified paths globs will be uploaded to the specified + Artifact Registry repository using the builder service account's + credentials. If any artifacts fail to be pushed, the build is marked + FAILURE. type: array - externalParameters: - type: object - additionalProperties: - description: Properties of the object. - type: any - buildType: - type: string - type: object - id: BuildDefinition - KnowledgeBase: - id: KnowledgeBase - type: object - properties: - url: + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsMavenArtifact + goModules: description: >- - A link to the KB in the [Windows update catalog] - (https://www.catalog.update.microsoft.com/). - type: string - name: - description: The KB name (generally of the form KB[0-9]+ (e.g., KB123456)). - type: string + Optional. A list of Go modules to be uploaded to Artifact Registry + upon successful completion of all build steps. If any objects fail + to be pushed, the build is marked FAILURE. + type: array + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule + pythonPackages: + description: >- + A list of Python packages to be uploaded to Artifact Registry upon + successful completion of all build steps. The build service account + credentials will be used to perform the upload. If any objects fail + to be pushed, the build is marked FAILURE. + type: array + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsPythonPackage + npmPackages: + description: >- + A list of npm packages to be uploaded to Artifact Registry upon + successful completion of all build steps. Npm packages in the + specified paths will be uploaded to the specified Artifact Registry + repository using the builder service account's credentials. If any + packages fail to be pushed, the build is marked FAILURE. + type: array + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsNpmPackage ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsArtifactObjects: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsArtifactObjects description: >- Files in the workspace to upload to Cloud Storage upon successful completion of all build steps. type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsArtifactObjects properties: location: - type: string description: >- Cloud Storage bucket and optional object path, in the form "gs://bucket/path/to/somewhere/". (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Files in the workspace matching any path pattern will be uploaded to Cloud Storage with this location as a prefix. + type: string paths: + description: Path globs used to match files in the build's workspace. type: array items: type: string - description: Path globs used to match files in the build's workspace. timing: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan description: >- Output only. Stores timing information for pushing all artifact objects. readOnly: true - FixableTotalByDigest: - description: Per resource and severity counts of fixable and total vulnerabilities. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan + ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsMavenArtifact: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsMavenArtifact + description: >- + A Maven artifact to upload to Artifact Registry upon successful + completion of all build steps. type: object - id: FixableTotalByDigest properties: - resourceUri: + repository: + description: >- + Artifact Registry repository, in the form + "https://$REGION-maven.pkg.dev/$PROJECT/$REPOSITORY" Artifact in the + workspace specified by path will be uploaded to Artifact Registry + with this location as a prefix. type: string - description: The affected resource. - fixableCount: + path: + description: >- + Optional. Path to an artifact in the build's workspace to be + uploaded to Artifact Registry. This can be either an absolute path, + e.g. /workspace/my-app/target/my-app-1.0.SNAPSHOT.jar or a relative + path from /workspace, e.g. my-app/target/my-app-1.0.SNAPSHOT.jar. type: string - description: The number of fixable vulnerabilities associated with this resource. - format: int64 - totalCount: + artifactId: + description: >- + Maven `artifactId` value used when uploading the artifact to + Artifact Registry. type: string - description: The total number of vulnerabilities associated with this resource. - format: int64 - severity: + groupId: description: >- - The severity for this count. SEVERITY_UNSPECIFIED indicates total - across all severities. + Maven `groupId` value used when uploading the artifact to Artifact + Registry. type: string - enumDescriptions: - - Unknown. - - Minimal severity. - - Low severity. - - Medium severity. - - High severity. - - Critical severity. - enum: - - SEVERITY_UNSPECIFIED - - MINIMAL - - LOW - - MEDIUM - - HIGH - - CRITICAL - BatchCreateNotesRequest: - id: BatchCreateNotesRequest - description: Request to create notes in batch. + version: + description: >- + Maven `version` value used when uploading the artifact to Artifact + Registry. + type: string + ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsGoModule + description: >- + Go module to upload to Artifact Registry upon successful completion of + all build steps. A module refers to all dependencies in a go.mod file. type: object properties: - notes: + repositoryName: + description: >- + Optional. Artifact Registry repository name. Specified Go modules + will be zipped and uploaded to Artifact Registry with this location + as a prefix. e.g. my-go-repo + type: string + repositoryLocation: + description: >- + Optional. Location of the Artifact Registry repository. i.e. + us-east1 Defaults to the build’s location. + type: string + repositoryProjectId: + description: >- + Optional. Project ID of the Artifact Registry repository. Defaults + to the build project. + type: string + sourcePath: + description: >- + Optional. Source path of the go.mod file in the build's workspace. + If not specified, this will default to the current directory. e.g. + ~/code/go/mypackage + type: string + modulePath: + description: Optional. The Go module's "module path". e.g. example.com/foo/v2 + type: string + moduleVersion: + description: >- + Optional. The Go module's semantic version in the form vX.Y.Z. e.g. + v0.1.1 Pre-release identifiers can also be added by appending a dash + and dot separated ASCII alphanumeric characters and hyphens. e.g. + v0.2.3-alpha.x.12m.5 + type: string + ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsPythonPackage: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsPythonPackage + description: >- + Python package to upload to Artifact Registry upon successful completion + of all build steps. A package can encapsulate multiple objects to be + uploaded to a single repository. + type: object + properties: + repository: + description: >- + Artifact Registry repository, in the form + "https://$REGION-python.pkg.dev/$PROJECT/$REPOSITORY" Files in the + workspace matching any path pattern will be uploaded to Artifact + Registry with this location as a prefix. + type: string + paths: + description: >- + Path globs used to match files in the build's workspace. For Python/ + Twine, this is usually `dist/*`, and sometimes additionally an + `.asc` file. + type: array + items: + type: string + ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsNpmPackage: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsNpmPackage + description: >- + Npm package to upload to Artifact Registry upon successful completion of + all build steps. + type: object + properties: + repository: + description: >- + Artifact Registry repository, in the form + "https://$REGION-npm.pkg.dev/$PROJECT/$REPOSITORY" Npm package in + the workspace specified by path will be zipped and uploaded to + Artifact Registry with this location as a prefix. + type: string + packagePath: + description: Path to the package.json. e.g. workspace/path/to/package + type: string + ContaineranalysisGoogleDevtoolsCloudbuildV1SourceProvenance: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1SourceProvenance + description: >- + Provenance of the source. Ways to find the original source, or verify + that some source was used for this build. + type: object + properties: + resolvedStorageSource: + description: >- + A copy of the build's `source.storage_source`, if exists, with any + generations resolved. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource + resolvedRepoSource: + description: >- + A copy of the build's `source.repo_source`, if exists, with any + revisions resolved. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1RepoSource + resolvedStorageSourceManifest: + description: >- + A copy of the build's `source.storage_source_manifest`, if exists, + with any revisions resolved. This feature is in Preview. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSourceManifest + resolvedConnectedRepository: + description: >- + Output only. A copy of the build's `source.connected_repository`, if + exists, with any revisions resolved. + readOnly: true + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ConnectedRepository + resolvedGitSource: + description: >- + Output only. A copy of the build's `source.git_source`, if exists, + with any revisions resolved. + readOnly: true + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1GitSource + fileHashes: + description: >- + Output only. Hash(es) of the build source, which can be used to + verify that the original source integrity was maintained in the + build. Note that `FileHashes` will only be populated if + `BuildOptions` has requested a `SourceProvenanceHash`. The keys to + this map are file paths used as build source and the values contain + the hash values for those files. If the build source came in a + single package such as a gzipped tarfile (`.tar.gz`), the `FileHash` + will be for the single path to that file. + readOnly: true type: object - description: Required. The notes to create. Max allowed length is 1000. additionalProperties: - $ref: '#/components/schemas/Note' - AliasContext: - id: AliasContext - description: An alias to a repo revision. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes + ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions + description: Optional arguments to enable specific features of builds. type: object properties: - name: - description: The alias name. + sourceProvenanceHash: + description: Requested hash for SourceProvenance. + type: array + items: + type: string + enumDescriptions: + - No hash requested. + - Use a sha256 hash. + - Use a md5 hash. + - Dirhash of a Go module's source code which is then hex-encoded. + - Use a sha512 hash. + enum: + - NONE + - SHA256 + - MD5 + - GO_MODULE_H1 + - SHA512 + requestedVerifyOption: + description: Requested verifiability options. type: string - kind: + enumDescriptions: + - Not a verifiable build (the default). + - Build must be verified. + enum: + - NOT_VERIFIED + - VERIFIED + machineType: + description: Compute Engine machine type on which to run the build. + type: string + enumDescriptions: + - Standard machine type. + - Highcpu machine with 8 CPUs. + - Highcpu machine with 32 CPUs. + - Highcpu e2 machine with 8 CPUs. + - Highcpu e2 machine with 32 CPUs. + - E2 machine with 1 CPU. + enumDeprecated: + - false + - true + - true + - false + - false + - false + enum: + - UNSPECIFIED + - N1_HIGHCPU_8 + - N1_HIGHCPU_32 + - E2_HIGHCPU_8 + - E2_HIGHCPU_32 + - E2_MEDIUM + diskSizeGb: + description: >- + Requested disk size for the VM that runs the build. Note that this + is *NOT* "disk free"; some of the space will be used by the + operating system and build utilities. Also note that this is the + minimum disk size that will be allocated for the build -- the build + may run with a larger disk than requested. At present, the maximum + disk size is 4000GB; builds that request more than the maximum are + rejected with an error. + type: string + format: int64 + substitutionOption: + description: >- + Option to specify behavior when there is an error in the + substitution checks. NOTE: this is always set to ALLOW_LOOSE for + triggered builds and cannot be overridden in the build configuration + file. type: string - description: The alias kind. enumDescriptions: - - Unknown. - - Git tag. - - Git branch. - >- - Used to specify non-standard aliases. For example, if a Git repo - has a ref named "refs/foo/bar". + Fails the build if error in substitutions checks, like missing a + substitution in the template or in the map. + - Do not fail the build if error in substitutions checks. enum: - - KIND_UNSPECIFIED - - FIXED - - MOVABLE - - OTHER - InTotoSlsaProvenanceV1: - type: object - id: InTotoSlsaProvenanceV1 - properties: - predicate: - $ref: '#/components/schemas/SlsaProvenanceV1' - predicateType: - type: string - _type: + - MUST_MATCH + - ALLOW_LOOSE + dynamicSubstitutions: description: >- - InToto spec defined at - https://github.com/in-toto/attestation/tree/main/spec#statement - type: string - subject: - items: - $ref: '#/components/schemas/Subject' - type: array - Envelope: - properties: - payloadType: + Option to specify whether or not to apply bash style string + operations to the substitutions. NOTE: this is always enabled for + triggered builds and cannot be overridden in the build configuration + file. + type: boolean + automapSubstitutions: + description: >- + Option to include built-in and custom substitutions as env variables + for all build steps. + type: boolean + logStreamingOption: + description: Option to define build log streaming behavior to Cloud Storage. type: string - payload: - format: byte + enumDescriptions: + - Service may automatically determine build log streaming behavior. + - Build logs should be streamed to Cloud Storage. + - >- + Build logs should not be streamed to Cloud Storage; they will be + written when the build is completed. + enum: + - STREAM_DEFAULT + - STREAM_ON + - STREAM_OFF + workerPool: + description: This field deprecated; please use `pool.name` instead. + deprecated: true type: string - signatures: - type: array - items: - $ref: '#/components/schemas/EnvelopeSignature' - id: Envelope - description: >- - MUST match - https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. - An authenticated message of arbitrary type. - type: object - Recipe: - description: >- - Steps taken to build the artifact. For a TaskRun, typically each - container corresponds to one step in the recipe. - id: Recipe - type: object - properties: - environment: - type: array + pool: description: >- - Any other builder-controlled inputs necessary for correctly - evaluating the recipe. Usually only needed for reproducing the build - but not evaluated as part of policy. Since the environment field can - greatly vary in structure, depending on the builder and recipe type, - this is of form "Any". - items: - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: object - entryPoint: + Optional. Specification for execution on a `WorkerPool`. See + [running builds in a private + pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) + for more information. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptionsPoolOption + logging: description: >- - String identifying the entry point into the build. This is often a - path to a configuration file and/or a target label within that file. - The syntax and meaning are defined by recipe.type. For example, if - the recipe type were "make", then this would reference the directory - in which to run make as well as which target to use. + Option to specify the logging mode, which determines if and where + build logs are stored. type: string - arguments: - type: array + enumDescriptions: + - >- + The service determines the logging mode. The default is `LEGACY`. + Do not rely on the default logging behavior as it may change in + the future. + - Build logs are stored in Cloud Logging and Cloud Storage. + - Build logs are stored in Cloud Storage. + - This option is the same as CLOUD_LOGGING_ONLY. + - >- + Build logs are stored in Cloud Logging. Selecting this option will + not allow [logs + streaming](https://cloud.google.com/sdk/gcloud/reference/builds/log). + - Turn off all logging. No build logs will be captured. + enumDeprecated: + - false + - false + - false + - true + - false + - false + enum: + - LOGGING_UNSPECIFIED + - LEGACY + - GCS_ONLY + - STACKDRIVER_ONLY + - CLOUD_LOGGING_ONLY + - NONE + env: description: >- - Collection of all external inputs that influenced the build on top - of recipe.definedInMaterial and recipe.entryPoint. For example, if - the recipe type were "make", then this might be the flags passed to - make aside from the target, which is captured in recipe.entryPoint. - Since the arguments field can greatly vary in structure, depending - on the builder and recipe type, this is of form "Any". + A list of global environment variable definitions that will exist + for all build steps in this build. If a variable is defined in both + globally and in a build step, the variable will use the build step + value. The elements are of the form "KEY=VALUE" for the environment + variable "KEY" being given the value "VALUE". + type: array items: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - definedInMaterial: - format: int64 - description: >- - Index in materials containing the recipe steps that are not implied - by recipe.type. For example, if the recipe type were "make", then - this would point to the source containing the Makefile, not the make - program itself. Set to -1 if the recipe doesn't come from a - material, as zero is default unset value for int64. - type: string - type: - type: string - description: >- - URI indicating what type of recipe was performed. It determines the - meaning of recipe.entryPoint, recipe.arguments, recipe.environment, - and materials. - BuilderConfig: - id: BuilderConfig - properties: - id: - type: string - type: object - GetPolicyOptions: - type: object - id: GetPolicyOptions - description: Encapsulates settings provided to GetIamPolicy. - properties: - requestedPolicyVersion: - format: int32 + type: string + secretEnv: description: >- - Optional. The maximum policy version that will be used to format the - policy. Valid values are 0, 1, and 3. Requests specifying an invalid - value will be rejected. Requests for policies with any conditional - role bindings must specify version 3. Policies with no conditional - role bindings may specify any valid value or leave the field unset. - The policy in the response might use the policy version that you - specified, or it might use a lower policy version. For example, if - you specify version 3, but the policy has no conditional role - bindings, the response uses version 1. To learn which resources - support conditions in their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - type: integer - ComplianceOccurrence: - type: object - id: ComplianceOccurrence - properties: - version: - $ref: '#/components/schemas/ComplianceVersion' - description: The OS and config version the benchmark was run on. - nonCompliantFiles: + A list of global environment variables, which are encrypted using a + Cloud Key Management Service crypto key. These values must be + specified in the build's `Secret`. These variables will be available + to all build steps in this build. type: array items: - $ref: '#/components/schemas/NonCompliantFile' - nonComplianceReason: - type: string - description: >- - An indication that the compliance checks in the associated - ComplianceNote were not satisfied for particular resources or a - specified reason. - Detail: - id: Detail - description: >- - A detail for a distro and package affected by this vulnerability and its - associated fix (if one is available). - type: object - properties: - affectedVersionEnd: - description: >- - The version number at the end of an interval in which this - vulnerability exists. A vulnerability can affect a package between - version numbers that are disjoint sets of intervals (example: - [1.0.0-1.1.0], [2.4.6-2.4.8] and [4.5.6-4.6.8]) each of which will - be represented in its own Detail. If a specific affected version is - provided by a vulnerability database, affected_version_start and - affected_version_end will be the same in that Detail. - $ref: '#/components/schemas/Version' - fixedVersion: - description: >- - The distro recommended version to update to that contains a fix for - this vulnerability. Setting this to VersionKind.MAXIMUM means no - such version is yet available. - $ref: '#/components/schemas/Version' - isObsolete: + type: string + volumes: description: >- - Whether this detail is obsolete. Occurrences are expected not to - point to obsolete details. - type: boolean - sourceUpdateTime: + Global list of volumes to mount for ALL build steps Each volume is + created as an empty volume prior to starting the build process. Upon + completion of the build, volumes and their contents are discarded. + Global volume names and paths cannot conflict with the volumes + defined a build step. Using a global volume in a build with only one + step is not valid as it is indicative of a build request with an + incorrect configuration. + type: array + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Volume + defaultLogsBucketBehavior: + description: Optional. Option to specify how default logs buckets are setup. type: string + enumDescriptions: + - Unspecified. + - >- + Bucket is located in user-owned project in the same region as the + build. The builder service account must have access to create and + write to Cloud Storage buckets in the build project. + - >- + Bucket is located in a Google-owned project and is not + regionalized. + enum: + - DEFAULT_LOGS_BUCKET_BEHAVIOR_UNSPECIFIED + - REGIONAL_USER_OWNED_BUCKET + - LEGACY_BUCKET + enableStructuredLogging: description: >- - The time this information was last changed at the source. This is an - upstream timestamp from the underlying information source - e.g. - Ubuntu security tracker. - format: google-datetime - vendor: - type: string - description: The name of the vendor of the product. - affectedCpeUri: + Optional. Option to specify whether structured logging is enabled. + If true, JSON-formatted logs are parsed as structured logs. + type: boolean + pubsubTopic: description: >- - Required. The [CPE URI](https://cpe.mitre.org/specification/) this - vulnerability affects. - type: string - fixedPackage: + Optional. Option to specify the Pub/Sub topic to receive build + status updates. type: string + ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptionsPoolOption: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptionsPoolOption + description: >- + Details about how a build should be executed on a `WorkerPool`. See + [running builds in a private + pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) + for more information. + type: object + properties: + name: description: >- - The distro recommended package to update to that contains a fix for - this vulnerability. It is possible for this to be different from the - affected_package. - packageType: + The `WorkerPool` resource to execute the build on. You must have + `cloudbuild.workerpools.use` on the project hosting the WorkerPool. + Format + projects/{project}/locations/{location}/workerPools/{workerPoolId} type: string - description: >- - The type of package; whether native or non native (e.g., ruby gems, - node.js packages, etc.). - description: - description: A vendor-specific description of this vulnerability. + ContaineranalysisGoogleDevtoolsCloudbuildV1Secret: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1Secret + description: >- + Pairs a set of secret environment variables containing encrypted values + with the Cloud KMS key to use to decrypt the value. Note: Use + `kmsKeyName` with `available_secrets` instead of using `kmsKeyName` with + `secret`. For instructions see: + https://cloud.google.com/cloud-build/docs/securing-builds/use-encrypted-credentials. + type: object + properties: + kmsKeyName: + description: Cloud KMS key name to use to decrypt these envs. type: string - affectedVersionStart: - description: >- - The version number at the start of an interval in which this - vulnerability exists. A vulnerability can affect a package between - version numbers that are disjoint sets of intervals (example: - [1.0.0-1.1.0], [2.4.6-2.4.8] and [4.5.6-4.6.8]) each of which will - be represented in its own Detail. If a specific affected version is - provided by a vulnerability database, affected_version_start and - affected_version_end will be the same in that Detail. - $ref: '#/components/schemas/Version' - fixedCpeUri: + secretEnv: description: >- - The distro recommended [CPE - URI](https://cpe.mitre.org/specification/) to update to that - contains a fix for this vulnerability. It is possible for this to be - different from the affected_cpe_uri. - type: string - source: - type: string - description: The source from which the information in this Detail was obtained. - severityName: - type: string - description: The distro assigned severity of this vulnerability. - affectedPackage: - description: Required. The package this vulnerability affects. - type: string - ContaineranalysisGoogleDevtoolsCloudbuildV1Source: - id: ContaineranalysisGoogleDevtoolsCloudbuildV1Source + Map of environment variable name to its encrypted value. Secret + environment variables must be unique across all of a build's + secrets, and must be used by at least one build step. Values can be + at most 64 KB in size. There can be at most 100 secret values across + all of a build's secrets. + type: object + additionalProperties: + type: string + format: byte + ContaineranalysisGoogleDevtoolsCloudbuildV1BuildApproval: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildApproval + description: >- + BuildApproval describes a build's approval configuration, state, and + result. + type: object properties: - storageSource: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource - description: If provided, get the source from this location in Cloud Storage. - gitSource: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1GitSource - description: If provided, get the source from this Git repository. - developerConnectConfig: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1DeveloperConnectConfig - description: If provided, get the source from this Developer Connect config. - storageSourceManifest: - description: >- - If provided, get the source from this manifest in Cloud Storage. - This feature is in Preview; see description - [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher). - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSourceManifest - repoSource: + state: + description: Output only. The state of this build's approval. + readOnly: true + type: string + enumDescriptions: + - Default enum type. This should not be used. + - Build approval is pending. + - Build approval has been approved. + - Build approval has been rejected. + - Build was cancelled while it was still pending approval. + enum: + - STATE_UNSPECIFIED + - PENDING + - APPROVED + - REJECTED + - CANCELLED + config: + description: Output only. Configuration for manual approval of this build. + readOnly: true $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1RepoSource - description: >- - If provided, get the source from this location in a Cloud Source - Repository. - connectedRepository: + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalConfig + result: + description: Output only. Result of manual approval for this Build. + readOnly: true $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ConnectedRepository + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalResult + ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalConfig: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalConfig + description: ApprovalConfig describes configuration for manual approval of a build. + type: object + properties: + approvalRequired: description: >- - Optional. If provided, get the source from this 2nd-gen Google Cloud - Build repository resource. + Whether or not approval is needed. If this is set on a build, it + will become pending when created, and will need to be explicitly + approved to start. + type: boolean + ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalResult: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalResult + description: >- + ApprovalResult describes the decision and associated metadata of a + manual approval of a build. type: object - description: Location of the source in a supported storage service. - PackageOccurrence: properties: - license: - description: Licenses that have been declared by the authors of the package. - $ref: '#/components/schemas/License' - name: - description: Required. Output only. The name of the installed package. - type: string - readOnly: true - version: - $ref: '#/components/schemas/Version' - description: Output only. The version of the package. - readOnly: true - location: - type: array - items: - $ref: '#/components/schemas/Location' + approverAccount: description: >- - All of the places within the filesystem versions of this package - have been found. - cpeUri: + Output only. Email of the user that called the ApproveBuild API to + approve or reject a build at the time that the API was called. readOnly: true - description: >- - Output only. The cpe_uri in [CPE - format](https://cpe.mitre.org/specification/) denoting the package - manager version distributing a package. The cpe_uri will be blank - for language packages. - type: string - packageType: type: string - description: >- - Output only. The type of package; whether native or non native - (e.g., ruby gems, node.js packages, etc.). + approvalTime: + description: Output only. The time when the approval decision was made. readOnly: true - architecture: type: string - description: >- - Output only. The CPU architecture for which packages in this - distribution channel were built. Architecture will be blank for - language packages. - readOnly: true - enum: - - ARCHITECTURE_UNSPECIFIED - - X86 - - X64 + format: google-datetime + decision: + description: Required. The decision of this manual approval. + type: string enumDescriptions: - - Unknown architecture. - - X86 architecture. - - X64 architecture. - id: PackageOccurrence - description: Details on how a particular software package was installed on a system. - type: object - BuildNote: - description: >- - Note holding the version of the provider's builder and the signature of - the provenance message in the build details occurrence. - type: object - id: BuildNote - properties: - builderVersion: + - Default enum type. This should not be used. + - Build is approved. + - Build is rejected. + enum: + - DECISION_UNSPECIFIED + - APPROVED + - REJECTED + comment: + description: Optional. An optional comment for this manual approval result. type: string + url: description: >- - Required. Immutable. Version of the builder which produced this - build. + Optional. An optional URL tied to this manual approval result. This + field is essentially the same as comment, except that it will be + rendered by the UI differently. An example use case is a link to an + external job that approved this Build. + type: string ContaineranalysisGoogleDevtoolsCloudbuildV1Secrets: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1Secrets + description: Secrets and secret environment variables. type: object properties: secretManager: - items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1SecretManagerSecret description: >- Secrets in Secret Manager and associated secret environment variable. type: array + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1SecretManagerSecret inline: description: >- Secrets encrypted with KMS key and the associated secret environment variable. + type: array items: $ref: >- #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1InlineSecret - type: array - description: Secrets and secret environment variables. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1Secrets - DSSEAttestationOccurrence: - properties: - statement: - $ref: '#/components/schemas/InTotoStatement' - envelope: - description: >- - If doing something security critical, make sure to verify the - signatures in this metadata. - $ref: '#/components/schemas/Envelope' - id: DSSEAttestationOccurrence - type: object - description: >- - Deprecated. Prefer to use a regular Occurrence, and populate the - Envelope at the top level of the Occurrence. - SlsaProvenanceV1: - type: object + ContaineranalysisGoogleDevtoolsCloudbuildV1SecretManagerSecret: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1SecretManagerSecret description: >- - Keep in sync with schema at - https://github.com/slsa-framework/slsa/blob/main/docs/provenance/schema/v1/provenance.proto - Builder renamed to ProvenanceBuilder because of Java conflicts. - id: SlsaProvenanceV1 - properties: - runDetails: - $ref: '#/components/schemas/RunDetails' - buildDefinition: - $ref: '#/components/schemas/BuildDefinition' - Note: - id: Note + Pairs a secret environment variable with a SecretVersion in Secret + Manager. type: object - description: A type of analysis that can be done for a resource. properties: - relatedUrl: - items: - $ref: '#/components/schemas/RelatedUrl' - description: URLs associated with this note. - type: array - longDescription: - type: string - description: A detailed description of this note. - kind: - type: string - enumDescriptions: - - Default value. This value is unused. - - The note and occurrence represent a package vulnerability. - - The note and occurrence assert build provenance. - - This represents an image basis relationship. - - This represents a package installed via a package manager. - - The note and occurrence track deployment events. - - >- - The note and occurrence track the initial discovery status of a - resource. - - This represents a logical "role" that can attest to artifacts. - - This represents an available package upgrade. - - This represents a Compliance Note - - This represents a DSSE attestation Note - - This represents a Vulnerability Assessment. - - This represents an SBOM Reference. - enum: - - NOTE_KIND_UNSPECIFIED - - VULNERABILITY - - BUILD - - IMAGE - - PACKAGE - - DEPLOYMENT - - DISCOVERY - - ATTESTATION - - UPGRADE - - COMPLIANCE - - DSSE_ATTESTATION - - VULNERABILITY_ASSESSMENT - - SBOM_REFERENCE - description: >- - Output only. The type of analysis. This field can be used as a - filter in list requests. - attestation: - $ref: '#/components/schemas/AttestationNote' - description: A note describing an attestation role. - compliance: - $ref: '#/components/schemas/ComplianceNote' - description: A note describing a compliance check. - discovery: - $ref: '#/components/schemas/DiscoveryNote' - description: A note describing the initial analysis of a resource. - sbomReference: - description: A note describing an SBOM reference. - $ref: '#/components/schemas/SBOMReferenceNote' - expirationTime: - format: google-datetime - type: string - description: Time of expiration for this note. Empty if note does not expire. - dsseAttestation: - $ref: '#/components/schemas/DSSEAttestationNote' - description: A note describing a dsse attestation note. - build: - $ref: '#/components/schemas/BuildNote' - description: A note describing build provenance for a verifiable build. - image: - $ref: '#/components/schemas/ImageNote' - description: A note describing a base image. - deployment: - $ref: '#/components/schemas/DeploymentNote' - description: A note describing something that can be deployed. - updateTime: - format: google-datetime - type: string - description: >- - Output only. The time this note was last updated. This field can be - used as a filter in list requests. - createTime: - format: google-datetime + versionName: description: >- - Output only. The time this note was created. This field can be used - as a filter in list requests. - type: string - shortDescription: + Resource name of the SecretVersion. In format: + projects/*/secrets/*/versions/* type: string - description: A one sentence description of this note. - vulnerability: - $ref: '#/components/schemas/VulnerabilityNote' - description: A note describing a package vulnerability. - relatedNoteNames: - items: - type: string - description: Other notes related to this note. - type: array - upgrade: - description: A note describing available package upgrades. - $ref: '#/components/schemas/UpgradeNote' - vulnerabilityAssessment: - $ref: '#/components/schemas/VulnerabilityAssessmentNote' - description: A note describing a vulnerability assessment. - name: + env: description: >- - Output only. The name of the note in the form of - `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. + Environment variable name to associate with the secret. Secret + environment variables must be unique across all of a build's + secrets, and must be used by at least one build step. type: string - package: - $ref: '#/components/schemas/PackageNote' - description: A note describing a package hosted by various package managers. - AnalysisCompleted: - properties: - analysisType: - items: - type: string - type: array + ContaineranalysisGoogleDevtoolsCloudbuildV1InlineSecret: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1InlineSecret description: >- - Indicates which analysis completed successfully. Multiple types of - analysis can be performed on a single resource. - type: object - id: AnalysisCompleted - Source: - id: Source + Pairs a set of secret environment variables mapped to encrypted values + with the Cloud KMS key to use to decrypt the value. type: object - description: Source describes the location of the source used for the build. properties: - context: - $ref: '#/components/schemas/SourceContext' - description: >- - If provided, the source code used for the build came from this - location. - fileHashes: - type: object + kmsKeyName: description: >- - Hash(es) of the build source, which can be used to verify that the - original source integrity was maintained in the build. The keys to - this map are file paths used as build source and the values contain - the hash values for those files. If the build source came in a - single package such as a gzipped tarfile (.tar.gz), the FileHash - will be for the single path to that file. - additionalProperties: - $ref: '#/components/schemas/FileHashes' - artifactStorageSourceUri: + Resource name of Cloud KMS crypto key to decrypt the encrypted + value. In format: projects/*/locations/*/keyRings/*/cryptoKeys/* type: string - description: >- - If provided, the input binary artifacts for the build came from this - location. - additionalContexts: - type: array - description: >- - If provided, some of the source code used for the build may be found - in these locations, in the case where the source repository had - multiple remotes or submodules. This list will not include the - context specified in the context field. - items: - $ref: '#/components/schemas/SourceContext' - BatchCreateOccurrencesResponse: - id: BatchCreateOccurrencesResponse - properties: - occurrences: - type: array - items: - $ref: '#/components/schemas/Occurrence' - description: The occurrences that were created. - description: Response for creating occurrences in batch. - type: object - ContaineranalysisGoogleDevtoolsCloudbuildV1Secret: - type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1Secret - description: >- - Pairs a set of secret environment variables containing encrypted values - with the Cloud KMS key to use to decrypt the value. Note: Use - `kmsKeyName` with `available_secrets` instead of using `kmsKeyName` with - `secret`. For instructions see: - https://cloud.google.com/cloud-build/docs/securing-builds/use-encrypted-credentials. - properties: - secretEnv: + envMap: description: >- Map of environment variable name to its encrypted value. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. Values can be at most 64 KB in size. There can be at most 100 secret values across all of a build's secrets. + type: object additionalProperties: type: string format: byte - type: object - kmsKeyName: - type: string - description: Cloud KMS key name to use to decrypt these envs. - BatchCreateNotesResponse: - id: BatchCreateNotesResponse + ContaineranalysisGoogleDevtoolsCloudbuildV1BuildWarning: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildWarning + description: A non-fatal problem encountered during the execution of the build. type: object properties: - notes: - items: - $ref: '#/components/schemas/Note' - type: array - description: The notes that were created. - description: Response for creating notes in batch. - ExportSBOMRequest: + text: + description: Explanation of the warning generated. + type: string + priority: + description: The priority for this warning. + type: string + enumDescriptions: + - Should not be used. + - e.g. deprecation warnings and alternative feature highlights. + - e.g. automated detection of possible issues with the build. + - e.g. alerts that a feature used in the build is pending removal + enum: + - PRIORITY_UNSPECIFIED + - INFO + - WARNING + - ALERT + ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfig: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfig + description: GitConfig is a configuration for git operations. type: object properties: - cloudStorageLocation: - $ref: '#/components/schemas/CloudStorageLocation' - description: >- - Empty placeholder to denote that this is a Google Cloud Storage - export request. - id: ExportSBOMRequest - description: >- - The request to generate and export SBOM. Target must be specified for - the request. - License: - id: License + http: + description: Configuration for HTTP related git operations. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfigHttpConfig + ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfigHttpConfig: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfigHttpConfig + description: HttpConfig is a configuration for HTTP related git operations. + type: object properties: - expression: + proxySecretVersionName: description: >- - Often a single license can be used to represent the licensing terms. - Sometimes it is necessary to include a choice of one or more - licenses or some combination of license identifiers. Examples: - "LGPL-2.1-only OR MIT", "LGPL-2.1-only AND MIT", "GPL-2.0-or-later - WITH Bison-exception-2.2". - type: string - comments: - description: Comments + SecretVersion resource of the HTTP proxy URL. The Service Account + used in the build (either the default Service Account or + user-specified Service Account) should have + `secretmanager.versions.access` permissions on this secret. The + proxy URL should be in format `protocol://@]proxyhost[:port]`. type: string + ContaineranalysisGoogleDevtoolsCloudbuildV1BuildFailureInfo: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildFailureInfo + description: A fatal problem encountered during the execution of the build. type: object - description: License information. - SlsaRecipe: + properties: + type: + description: The name of the failure. + type: string + enumDescriptions: + - Type unspecified + - Unable to push the image to the repository. + - Final image not found. + - Unauthorized push of the final image. + - Backend logging failures. Should retry. + - A build step has failed. + - The source fetching has failed. + enum: + - FAILURE_TYPE_UNSPECIFIED + - PUSH_FAILED + - PUSH_IMAGE_NOT_FOUND + - PUSH_NOT_AUTHORIZED + - LOGGING_FAILURE + - USER_BUILD_STEP + - FETCH_SOURCE_FAILED + detail: + description: Explains the failure issue in more detail using hard-coded text. + type: string + ContaineranalysisGoogleDevtoolsCloudbuildV1Dependency: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1Dependency description: >- - Steps taken to build the artifact. For a TaskRun, typically each - container corresponds to one step in the recipe. + A dependency that the Cloud Build worker will fetch before executing + user steps. type: object - id: SlsaRecipe properties: - definedInMaterial: - format: int64 - type: string + empty: description: >- - Index in materials containing the recipe steps that are not implied - by recipe.type. For example, if the recipe type were "make", then - this would point to the source containing the Makefile, not the make - program itself. Set to -1 if the recipe doesn't come from a - material, as zero is default unset value for int64. - type: + If set to true disable all dependency fetching (ignoring the default + source as well). + type: boolean + gitSource: + description: Represents a git repository as a build dependency. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency + ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependency + description: Represents a git repository as a build dependency. + type: object + properties: + repository: + description: Required. The kind of repo (url or dev connect). + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceRepository + revision: + description: Required. The revision that we will fetch the repo at. type: string + recurseSubmodules: + description: Optional. True if submodules should be fetched too (default false). + type: boolean + depth: description: >- - URI indicating what type of recipe was performed. It determines the - meaning of recipe.entryPoint, recipe.arguments, recipe.environment, - and materials. - arguments: - description: >- - Collection of all external inputs that influenced the build on top - of recipe.definedInMaterial and recipe.entryPoint. For example, if - the recipe type were "make", then this might be the flags passed to - make aside from the target, which is captured in recipe.entryPoint. - Depending on the recipe Type, the structure may be different. - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: object - environment: - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - description: >- - Any other builder-controlled inputs necessary for correctly - evaluating the recipe. Usually only needed for reproducing the build - but not evaluated as part of policy. Depending on the recipe Type, - the structure may be different. - entryPoint: + Optional. How much history should be fetched for the build (default + 1, -1 for all history). type: string - description: >- - String identifying the entry point into the build. This is often a - path to a configuration file and/or a target label within that file. - The syntax and meaning are defined by recipe.type. For example, if - the recipe type were "make", then this would reference the directory - in which to run make as well as which target to use. - RepoId: - description: A unique identifier for a Cloud Repo. + format: int64 + destPath: + description: Required. Where should the files be placed on the worker. + type: string + ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceRepository: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceRepository + description: A repository for a git source. type: object - id: RepoId properties: - projectRepoId: - $ref: '#/components/schemas/ProjectRepoId' - description: A combination of a project ID and a repo name. - uid: + url: + description: Location of the Git repository. + type: string + developerConnect: + description: >- + The Developer Connect Git repository link formatted as + `projects/*/locations/*/connections/*/gitRepositoryLink/*` type: string - description: A server-assigned, globally unique identifier. parameters: - _.xgafv: - description: V1 error format. - in: query - name: $.xgafv - schema: - type: string - enum: - - '1' - - '2' - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string - oauth_token: - description: OAuth 2.0 token for the current user. + access_token: + description: OAuth access token. in: query - name: oauth_token + name: access_token schema: type: string alt: @@ -5371,45 +5736,39 @@ components: - json - media - proto - 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 callback: description: JSONP in: query name: callback schema: type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - 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 - access_token: - description: OAuth access token. - in: query - name: access_token - schema: - type: string quotaUser: description: >- Available to use for quota purposes for server-side applications. Can be @@ -5419,86 +5778,44 @@ components: name: quotaUser schema: type: string - x-stackQL-resources: - occurrences_iam_policies: - id: google.containeranalysis.occurrences_iam_policies - name: occurrences_iam_policies - title: Occurrences_iam_policies - methods: - projects_occurrences_test_iam_permissions: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}:testIamPermissions/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_occurrences_get_iam_policy: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}:getIamPolicy/post - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.bindings - projects_occurrences_set_iam_policy: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}:setIamPolicy/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_occurrences_test_iam_permissions: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences~1{occurrencesId}:testIamPermissions/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_occurrences_get_iam_policy: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences~1{occurrencesId}:getIamPolicy/post - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.bindings - projects_locations_occurrences_set_iam_policy: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences~1{occurrencesId}:setIamPolicy/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/occurrences_iam_policies/methods/projects_locations_occurrences_get_iam_policy - - $ref: >- - #/components/x-stackQL-resources/occurrences_iam_policies/methods/projects_occurrences_get_iam_policy - insert: [] - update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/occurrences_iam_policies/methods/projects_locations_occurrences_set_iam_policy - - $ref: >- - #/components/x-stackQL-resources/occurrences_iam_policies/methods/projects_occurrences_set_iam_policy - delete: [] + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + x-stackQL-resources: occurrences: id: google.containeranalysis.occurrences name: occurrences title: Occurrences methods: - projects_occurrences_delete: + projects_occurrences_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_occurrences_get: + projects_occurrences_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}/get + #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}/delete response: mediaType: application/json openAPIDocKey: '200' @@ -5509,12 +5826,6 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_occurrences_create: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1occurrences/post' - response: - mediaType: application/json - openAPIDocKey: '200' projects_occurrences_list: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1occurrences/get' @@ -5522,24 +5833,22 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.occurrences - projects_occurrences_batch_create: + projects_occurrences_create: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1occurrences:batchCreate/post' + $ref: '#/paths/~1v1~1projects~1{projectsId}~1occurrences/post' response: mediaType: application/json openAPIDocKey: '200' - projects_locations_notes_occurrences_list: + projects_occurrences_batch_create: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes~1{notesId}~1occurrences/get + $ref: '#/paths/~1v1~1projects~1{projectsId}~1occurrences:batchCreate/post' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.occurrences - projects_locations_occurrences_batch_create: + projects_locations_occurrences_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences:batchCreate/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences~1{occurrencesId}/get response: mediaType: application/json openAPIDocKey: '200' @@ -5550,13 +5859,6 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_locations_occurrences_get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences~1{occurrencesId}/get - response: - mediaType: application/json - openAPIDocKey: '200' projects_locations_occurrences_patch: operation: $ref: >- @@ -5579,6 +5881,21 @@ components: response: mediaType: application/json openAPIDocKey: '200' + projects_locations_occurrences_batch_create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences:batchCreate/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_notes_occurrences_list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes~1{notesId}~1occurrences/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.occurrences projects_notes_occurrences_list: operation: $ref: >- @@ -5589,10 +5906,10 @@ components: objectKey: $.occurrences sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/occurrences/methods/projects_locations_notes_occurrences_list - $ref: >- #/components/x-stackQL-resources/occurrences/methods/projects_locations_occurrences_get + - $ref: >- + #/components/x-stackQL-resources/occurrences/methods/projects_locations_notes_occurrences_list - $ref: >- #/components/x-stackQL-resources/occurrences/methods/projects_occurrences_get - $ref: >- @@ -5602,10 +5919,10 @@ components: - $ref: >- #/components/x-stackQL-resources/occurrences/methods/projects_occurrences_list insert: - - $ref: >- - #/components/x-stackQL-resources/occurrences/methods/projects_locations_occurrences_batch_create - $ref: >- #/components/x-stackQL-resources/occurrences/methods/projects_locations_occurrences_create + - $ref: >- + #/components/x-stackQL-resources/occurrences/methods/projects_locations_occurrences_batch_create - $ref: >- #/components/x-stackQL-resources/occurrences/methods/projects_occurrences_create - $ref: >- @@ -5650,302 +5967,316 @@ components: update: [] replace: [] delete: [] - occurrences_vulnerability_summary: - id: google.containeranalysis.occurrences_vulnerability_summary - name: occurrences_vulnerability_summary - title: Occurrences_vulnerability_summary + occurrences_iam_policies: + id: google.containeranalysis.occurrences_iam_policies + name: occurrences_iam_policies + title: Occurrences_iam_policies methods: - projects_occurrences_get_vulnerability_summary: + projects_occurrences_set_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1occurrences:vulnerabilitySummary/get + #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_occurrences_get_vulnerability_summary: + projects_occurrences_get_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences:vulnerabilitySummary/get + #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}:getIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.bindings + projects_occurrences_test_iam_permissions: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}:testIamPermissions/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_occurrences_set_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences~1{occurrencesId}:setIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_occurrences_get_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences~1{occurrencesId}:getIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.bindings + projects_locations_occurrences_test_iam_permissions: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences~1{occurrencesId}:testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/occurrences_vulnerability_summary/methods/projects_locations_occurrences_get_vulnerability_summary + #/components/x-stackQL-resources/occurrences_iam_policies/methods/projects_locations_occurrences_get_iam_policy - $ref: >- - #/components/x-stackQL-resources/occurrences_vulnerability_summary/methods/projects_occurrences_get_vulnerability_summary + #/components/x-stackQL-resources/occurrences_iam_policies/methods/projects_occurrences_get_iam_policy insert: [] update: [] - replace: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/occurrences_iam_policies/methods/projects_locations_occurrences_set_iam_policy + - $ref: >- + #/components/x-stackQL-resources/occurrences_iam_policies/methods/projects_occurrences_set_iam_policy delete: [] - resources: - id: google.containeranalysis.resources - name: resources - title: Resources + vulnerability_summary: + id: google.containeranalysis.vulnerability_summary + name: vulnerability_summary + title: Vulnerability_summary methods: - projects_resources_export_sbom: + projects_occurrences_get_vulnerability_summary: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1resources~1{resourcesId}:exportSBOM/post + #/paths/~1v1~1projects~1{projectsId}~1occurrences:vulnerabilitySummary/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_resources_export_sbom: + projects_locations_occurrences_get_vulnerability_summary: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1resources~1{resourcesId}:exportSBOM/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences:vulnerabilitySummary/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/vulnerability_summary/methods/projects_locations_occurrences_get_vulnerability_summary + - $ref: >- + #/components/x-stackQL-resources/vulnerability_summary/methods/projects_occurrences_get_vulnerability_summary insert: [] update: [] replace: [] delete: [] - notes_iam_policies: - id: google.containeranalysis.notes_iam_policies - name: notes_iam_policies - title: Notes_iam_policies + notes: + id: google.containeranalysis.notes + name: notes + title: Notes methods: - projects_locations_notes_set_iam_policy: + projects_locations_notes_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes~1{notesId}:setIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes~1{notesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_notes_test_iam_permissions: + projects_locations_notes_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes~1{notesId}:testIamPermissions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes~1{notesId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_notes_get_iam_policy: + projects_locations_notes_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes~1{notesId}:getIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes~1{notesId}/patch response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.bindings - projects_notes_get_iam_policy: + projects_locations_notes_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}:getIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.bindings - projects_notes_test_iam_permissions: + objectKey: $.notes + projects_locations_notes_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}:testIamPermissions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes/post response: mediaType: application/json openAPIDocKey: '200' - projects_notes_set_iam_policy: + projects_locations_notes_batch_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}:setIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes:batchCreate/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/notes_iam_policies/methods/projects_locations_notes_get_iam_policy - - $ref: >- - #/components/x-stackQL-resources/notes_iam_policies/methods/projects_notes_get_iam_policy - insert: [] - update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/notes_iam_policies/methods/projects_locations_notes_set_iam_policy - - $ref: >- - #/components/x-stackQL-resources/notes_iam_policies/methods/projects_notes_set_iam_policy - delete: [] - notes: - id: google.containeranalysis.notes - name: notes - title: Notes - methods: - projects_locations_notes_create: + projects_notes_get: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes/post + $ref: '#/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}/get' response: mediaType: application/json openAPIDocKey: '200' - projects_locations_notes_list: + projects_notes_delete: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes/get + $ref: '#/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + projects_notes_patch: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + projects_notes_list: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1notes/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.notes - projects_locations_notes_batch_create: + projects_notes_create: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes:batchCreate/post + $ref: '#/paths/~1v1~1projects~1{projectsId}~1notes/post' response: mediaType: application/json openAPIDocKey: '200' - projects_locations_notes_patch: + projects_notes_batch_create: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes~1{notesId}/patch + $ref: '#/paths/~1v1~1projects~1{projectsId}~1notes:batchCreate/post' response: mediaType: application/json openAPIDocKey: '200' - projects_locations_notes_get: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/notes/methods/projects_locations_notes_get + - $ref: >- + #/components/x-stackQL-resources/notes/methods/projects_locations_notes_list + - $ref: '#/components/x-stackQL-resources/notes/methods/projects_notes_get' + - $ref: '#/components/x-stackQL-resources/notes/methods/projects_notes_list' + insert: + - $ref: >- + #/components/x-stackQL-resources/notes/methods/projects_locations_notes_create + - $ref: >- + #/components/x-stackQL-resources/notes/methods/projects_locations_notes_batch_create + - $ref: >- + #/components/x-stackQL-resources/notes/methods/projects_notes_create + - $ref: >- + #/components/x-stackQL-resources/notes/methods/projects_notes_batch_create + update: + - $ref: >- + #/components/x-stackQL-resources/notes/methods/projects_locations_notes_patch + - $ref: >- + #/components/x-stackQL-resources/notes/methods/projects_notes_patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/notes/methods/projects_locations_notes_delete + - $ref: >- + #/components/x-stackQL-resources/notes/methods/projects_notes_delete + notes_iam_policies: + id: google.containeranalysis.notes_iam_policies + name: notes_iam_policies + title: Notes_iam_policies + methods: + projects_locations_notes_set_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes~1{notesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes~1{notesId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_notes_delete: + projects_locations_notes_get_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes~1{notesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes~1{notesId}:getIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - projects_notes_create: + objectKey: $.bindings + projects_locations_notes_test_iam_permissions: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1notes/post' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes~1{notesId}:testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' - projects_notes_list: + projects_notes_set_iam_policy: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1notes/get' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.notes - projects_notes_batch_create: + projects_notes_get_iam_policy: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1notes:batchCreate/post' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}:getIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - projects_notes_delete: + objectKey: $.bindings + projects_notes_test_iam_permissions: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}/delete' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}:testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' - projects_notes_get: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/notes_iam_policies/methods/projects_locations_notes_get_iam_policy + - $ref: >- + #/components/x-stackQL-resources/notes_iam_policies/methods/projects_notes_get_iam_policy + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/notes_iam_policies/methods/projects_locations_notes_set_iam_policy + - $ref: >- + #/components/x-stackQL-resources/notes_iam_policies/methods/projects_notes_set_iam_policy + delete: [] + resources: + id: google.containeranalysis.resources + name: resources + title: Resources + methods: + projects_locations_resources_export_sbom: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}/get' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1resources~1{resourcesId}:exportSBOM/post response: mediaType: application/json openAPIDocKey: '200' - projects_notes_patch: + projects_resources_export_sbom: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}/patch' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1resources~1{resourcesId}:exportSBOM/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/notes/methods/projects_locations_notes_get - - $ref: >- - #/components/x-stackQL-resources/notes/methods/projects_locations_notes_list - - $ref: '#/components/x-stackQL-resources/notes/methods/projects_notes_get' - - $ref: '#/components/x-stackQL-resources/notes/methods/projects_notes_list' - insert: - - $ref: >- - #/components/x-stackQL-resources/notes/methods/projects_locations_notes_create - - $ref: >- - #/components/x-stackQL-resources/notes/methods/projects_locations_notes_batch_create - - $ref: >- - #/components/x-stackQL-resources/notes/methods/projects_notes_create - - $ref: >- - #/components/x-stackQL-resources/notes/methods/projects_notes_batch_create - update: - - $ref: >- - #/components/x-stackQL-resources/notes/methods/projects_locations_notes_patch - - $ref: >- - #/components/x-stackQL-resources/notes/methods/projects_notes_patch + select: [] + insert: [] + update: [] replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/notes/methods/projects_locations_notes_delete - - $ref: >- - #/components/x-stackQL-resources/notes/methods/projects_notes_delete + delete: [] paths: - /v1/projects/{projectsId}/occurrences/{occurrencesId}:testIamPermissions: + /v1/projects/{projectsId}/occurrences/{occurrencesId}: parameters: &ref_1 - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/quotaUser' - post: - description: >- - Returns the permissions that a caller has on the specified note or - occurrence. Requires list permission on the project (for example, - `containeranalysis.notes.list`). The resource takes the format - `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and - `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. - operationId: containeranalysis.projects.occurrences.testIamPermissions - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TestIamPermissionsRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/TestIamPermissionsResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: occurrencesId - required: true - schema: - type: string - /v1/projects/{projectsId}/occurrences/{occurrencesId}:getIamPolicy: - parameters: *ref_1 - post: - description: >- - Gets the access control policy for a note or an occurrence resource. - Requires `containeranalysis.notes.setIamPolicy` or - `containeranalysis.occurrences.setIamPolicy` permission if the resource - is a note or occurrence, respectively. The resource takes the format - `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and - `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. - operationId: containeranalysis.projects.occurrences.getIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GetIamPolicyRequest' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' + get: + description: Gets the specified occurrence. + operationId: containeranalysis.projects.occurrences.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5957,7 +6288,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Occurrence' parameters: - in: path name: projectsId @@ -5969,8 +6300,6 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/occurrences/{occurrencesId}: - parameters: *ref_1 delete: description: >- Deletes the specified occurrence. For example, use this method to delete @@ -6000,32 +6329,6 @@ paths: required: true schema: type: string - get: - description: Gets the specified occurrence. - operationId: containeranalysis.projects.occurrences.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Occurrence' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: occurrencesId - required: true - schema: - type: string patch: description: Updates the specified occurrence. operationId: containeranalysis.projects.occurrences.patch @@ -6050,76 +6353,20 @@ paths: - in: path name: projectsId required: true - schema: - type: string - - in: path - name: occurrencesId - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1/projects/{projectsId}/occurrences/{occurrencesId}/notes: - parameters: *ref_1 - get: - description: >- - Gets the note attached to the specified occurrence. Consumer projects - can use this method to get a note that belongs to a provider project. - operationId: containeranalysis.projects.occurrences.getNotes - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Note' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: occurrencesId - required: true - schema: - type: string - /v1/projects/{projectsId}/occurrences: - parameters: *ref_1 - post: - description: Creates a new occurrence. - operationId: containeranalysis.projects.occurrences.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Occurrence' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Occurrence' - parameters: + schema: + type: string - in: path - name: projectsId + name: occurrencesId required: true schema: type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/occurrences: + parameters: *ref_1 get: description: Lists occurrences for the specified project. operationId: containeranalysis.projects.occurrences.list @@ -6145,15 +6392,45 @@ paths: name: filter schema: type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 - in: query name: pageToken schema: type: string - in: query - name: pageSize + name: returnPartialSuccess schema: - type: integer - format: int32 + type: boolean + post: + description: Creates a new occurrence. + operationId: containeranalysis.projects.occurrences.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Occurrence' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Occurrence' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string /v1/projects/{projectsId}/occurrences:batchCreate: parameters: *ref_1 post: @@ -6182,11 +6459,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/occurrences:vulnerabilitySummary: + /v1/projects/{projectsId}/occurrences/{occurrencesId}/notes: parameters: *ref_1 get: - description: Gets a summary of the number and severity of occurrences. - operationId: containeranalysis.projects.occurrences.getVulnerabilitySummary + description: >- + Gets the note attached to the specified occurrence. Consumer projects + can use this method to get a note that belongs to a provider project. + operationId: containeranalysis.projects.occurrences.getNotes security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6198,15 +6477,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/VulnerabilityOccurrencesSummary' + $ref: '#/components/schemas/Note' parameters: - in: path name: projectsId required: true schema: type: string - - in: query - name: filter + - in: path + name: occurrencesId + required: true schema: type: string /v1/projects/{projectsId}/occurrences/{occurrencesId}:setIamPolicy: @@ -6248,16 +6528,22 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/resources/{resourcesId}:exportSBOM: + /v1/projects/{projectsId}/occurrences/{occurrencesId}:getIamPolicy: parameters: *ref_1 post: - description: Generates an SBOM for the given resource. - operationId: containeranalysis.projects.resources.exportSBOM + description: >- + Gets the access control policy for a note or an occurrence resource. + Requires `containeranalysis.notes.setIamPolicy` or + `containeranalysis.occurrences.setIamPolicy` permission if the resource + is a note or occurrence, respectively. The resource takes the format + `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and + `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. + operationId: containeranalysis.projects.occurrences.getIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/ExportSBOMRequest' + $ref: '#/components/schemas/GetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6269,7 +6555,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ExportSBOMResponse' + $ref: '#/components/schemas/Policy' parameters: - in: path name: projectsId @@ -6277,26 +6563,25 @@ paths: schema: type: string - in: path - name: resourcesId + name: occurrencesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}:setIamPolicy: + /v1/projects/{projectsId}/occurrences/{occurrencesId}:testIamPermissions: parameters: *ref_1 post: description: >- - Sets the access control policy on the specified note or occurrence. - Requires `containeranalysis.notes.setIamPolicy` or - `containeranalysis.occurrences.setIamPolicy` permission if the resource - is a note or an occurrence, respectively. The resource takes the format + Returns the permissions that a caller has on the specified note or + occurrence. Requires list permission on the project (for example, + `containeranalysis.notes.list`). The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. - operationId: containeranalysis.projects.locations.notes.setIamPolicy + operationId: containeranalysis.projects.occurrences.testIamPermissions requestBody: content: application/json: schema: - $ref: '#/components/schemas/SetIamPolicyRequest' + $ref: '#/components/schemas/TestIamPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6308,7 +6593,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/TestIamPermissionsResponse' parameters: - in: path name: projectsId @@ -6316,30 +6601,46 @@ paths: schema: type: string - in: path - name: locationsId + name: occurrencesId required: true schema: type: string + /v1/projects/{projectsId}/occurrences:vulnerabilitySummary: + parameters: *ref_1 + get: + description: Gets a summary of the number and severity of occurrences. + operationId: containeranalysis.projects.occurrences.getVulnerabilitySummary + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/VulnerabilityOccurrencesSummary' + parameters: - in: path - name: notesId + name: projectsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}:testIamPermissions: + - in: query + name: filter + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}: parameters: *ref_1 - post: - description: >- - Returns the permissions that a caller has on the specified note or - occurrence. Requires list permission on the project (for example, - `containeranalysis.notes.list`). The resource takes the format - `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and - `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. - operationId: containeranalysis.projects.locations.notes.testIamPermissions - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TestIamPermissionsRequest' + get: + description: Gets the specified occurrence. + operationId: containeranalysis.projects.locations.occurrences.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6351,7 +6652,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TestIamPermissionsResponse' + $ref: '#/components/schemas/Occurrence' parameters: - in: path name: projectsId @@ -6364,20 +6665,16 @@ paths: schema: type: string - in: path - name: notesId + name: occurrencesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notes: - parameters: *ref_1 - post: - description: Creates a new note. - operationId: containeranalysis.projects.locations.notes.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Note' + delete: + description: >- + Deletes the specified occurrence. For example, use this method to delete + an occurrence when the occurrence is no longer applicable for the given + resource. + operationId: containeranalysis.projects.locations.occurrences.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6389,7 +6686,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Note' + $ref: '#/components/schemas/Empty' parameters: - in: path name: projectsId @@ -6401,13 +6698,19 @@ paths: required: true schema: type: string - - in: query - name: noteId + - in: path + name: occurrencesId + required: true schema: type: string - get: - description: Lists notes for the specified project. - operationId: containeranalysis.projects.locations.notes.list + patch: + description: Updates the specified occurrence. + operationId: containeranalysis.projects.locations.occurrences.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Occurrence' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6419,7 +6722,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListNotesResponse' + $ref: '#/components/schemas/Occurrence' parameters: - in: path name: projectsId @@ -6431,29 +6734,21 @@ paths: required: true schema: type: string - - in: query - name: pageToken + - in: path + name: occurrencesId + required: true schema: type: string - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notes:batchCreate: + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/occurrences: parameters: *ref_1 - post: - description: Creates new notes in batch. - operationId: containeranalysis.projects.locations.notes.batchCreate - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/BatchCreateNotesRequest' + get: + description: Lists occurrences for the specified project. + operationId: containeranalysis.projects.locations.occurrences.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6465,7 +6760,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BatchCreateNotesResponse' + $ref: '#/components/schemas/ListOccurrencesResponse' parameters: - in: path name: projectsId @@ -6477,16 +6772,31 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}: - parameters: *ref_1 - patch: - description: Updates the specified note. - operationId: containeranalysis.projects.locations.notes.patch + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean + post: + description: Creates a new occurrence. + operationId: containeranalysis.projects.locations.occurrences.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/Note' + $ref: '#/components/schemas/Occurrence' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6498,7 +6808,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Note' + $ref: '#/components/schemas/Occurrence' parameters: - in: path name: projectsId @@ -6510,19 +6820,16 @@ paths: required: true schema: type: string - - in: path - name: notesId - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - get: - description: Gets the specified note. - operationId: containeranalysis.projects.locations.notes.get + /v1/projects/{projectsId}/locations/{locationsId}/occurrences:batchCreate: + parameters: *ref_1 + post: + description: Creates new occurrences in batch. + operationId: containeranalysis.projects.locations.occurrences.batchCreate + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BatchCreateOccurrencesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6534,7 +6841,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Note' + $ref: '#/components/schemas/BatchCreateOccurrencesResponse' parameters: - in: path name: projectsId @@ -6546,14 +6853,13 @@ paths: required: true schema: type: string - - in: path - name: notesId - required: true - schema: - type: string - delete: - description: Deletes the specified note. - operationId: containeranalysis.projects.locations.notes.delete + /v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}/notes: + parameters: *ref_1 + get: + description: >- + Gets the note attached to the specified occurrence. Consumer projects + can use this method to get a note that belongs to a provider project. + operationId: containeranalysis.projects.locations.occurrences.getNotes security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6565,7 +6871,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/Note' parameters: - in: path name: projectsId @@ -6578,26 +6884,26 @@ paths: schema: type: string - in: path - name: notesId + name: occurrencesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}:getIamPolicy: + /v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}:setIamPolicy: parameters: *ref_1 post: description: >- - Gets the access control policy for a note or an occurrence resource. + Sets the access control policy on the specified note or occurrence. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource - is a note or occurrence, respectively. The resource takes the format + is a note or an occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. - operationId: containeranalysis.projects.locations.notes.getIamPolicy + operationId: containeranalysis.projects.locations.occurrences.setIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/GetIamPolicyRequest' + $ref: '#/components/schemas/SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6622,18 +6928,26 @@ paths: schema: type: string - in: path - name: notesId + name: occurrencesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}/occurrences: + /v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}:getIamPolicy: parameters: *ref_1 - get: + post: description: >- - Lists occurrences referencing the specified note. Provider projects can - use this method to get all occurrences across consumer projects - referencing the specified note. - operationId: containeranalysis.projects.locations.notes.occurrences.list + Gets the access control policy for a note or an occurrence resource. + Requires `containeranalysis.notes.setIamPolicy` or + `containeranalysis.occurrences.setIamPolicy` permission if the resource + is a note or occurrence, respectively. The resource takes the format + `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and + `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. + operationId: containeranalysis.projects.locations.occurrences.getIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6645,7 +6959,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListNoteOccurrencesResponse' + $ref: '#/components/schemas/Policy' parameters: - in: path name: projectsId @@ -6658,33 +6972,25 @@ paths: schema: type: string - in: path - name: notesId + name: occurrencesId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/resources/{resourcesId}:exportSBOM: + /v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}:testIamPermissions: parameters: *ref_1 post: - description: Generates an SBOM for the given resource. - operationId: containeranalysis.projects.locations.resources.exportSBOM + description: >- + Returns the permissions that a caller has on the specified note or + occurrence. Requires list permission on the project (for example, + `containeranalysis.notes.list`). The resource takes the format + `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and + `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. + operationId: containeranalysis.projects.locations.occurrences.testIamPermissions requestBody: content: application/json: schema: - $ref: '#/components/schemas/ExportSBOMRequest' + $ref: '#/components/schemas/TestIamPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6696,7 +7002,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ExportSBOMResponse' + $ref: '#/components/schemas/TestIamPermissionsResponse' parameters: - in: path name: projectsId @@ -6709,20 +7015,15 @@ paths: schema: type: string - in: path - name: resourcesId + name: occurrencesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/occurrences:batchCreate: + /v1/projects/{projectsId}/locations/{locationsId}/occurrences:vulnerabilitySummary: parameters: *ref_1 - post: - description: Creates new occurrences in batch. - operationId: containeranalysis.projects.locations.occurrences.batchCreate - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/BatchCreateOccurrencesRequest' + get: + description: Gets a summary of the number and severity of occurrences. + operationId: containeranalysis.projects.locations.occurrences.getVulnerabilitySummary security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6734,7 +7035,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BatchCreateOccurrencesResponse' + $ref: '#/components/schemas/VulnerabilityOccurrencesSummary' parameters: - in: path name: projectsId @@ -6746,14 +7047,19 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}: + - in: query + name: filter + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}: parameters: *ref_1 - delete: - description: >- - Deletes the specified occurrence. For example, use this method to delete - an occurrence when the occurrence is no longer applicable for the given - resource. - operationId: containeranalysis.projects.locations.occurrences.delete + get: + description: Gets the specified note. + operationId: containeranalysis.projects.locations.notes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6765,7 +7071,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/Note' parameters: - in: path name: projectsId @@ -6778,13 +7084,13 @@ paths: schema: type: string - in: path - name: occurrencesId + name: notesId required: true schema: type: string - get: - description: Gets the specified occurrence. - operationId: containeranalysis.projects.locations.occurrences.get + delete: + description: Deletes the specified note. + operationId: containeranalysis.projects.locations.notes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6796,7 +7102,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Occurrence' + $ref: '#/components/schemas/Empty' parameters: - in: path name: projectsId @@ -6809,18 +7115,18 @@ paths: schema: type: string - in: path - name: occurrencesId + name: notesId required: true schema: type: string patch: - description: Updates the specified occurrence. - operationId: containeranalysis.projects.locations.occurrences.patch + description: Updates the specified note. + operationId: containeranalysis.projects.locations.notes.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/Occurrence' + $ref: '#/components/schemas/Note' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6832,7 +7138,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Occurrence' + $ref: '#/components/schemas/Note' parameters: - in: path name: projectsId @@ -6845,7 +7151,7 @@ paths: schema: type: string - in: path - name: occurrencesId + name: notesId required: true schema: type: string @@ -6854,11 +7160,11 @@ paths: schema: type: string format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/occurrences: + /v1/projects/{projectsId}/locations/{locationsId}/notes: parameters: *ref_1 get: - description: Lists occurrences for the specified project. - operationId: containeranalysis.projects.locations.occurrences.list + description: Lists notes for the specified project. + operationId: containeranalysis.projects.locations.notes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6870,7 +7176,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListOccurrencesResponse' + $ref: '#/components/schemas/ListNotesResponse' parameters: - in: path name: projectsId @@ -6882,27 +7188,68 @@ paths: required: true schema: type: string + - in: query + name: filter + schema: + type: string - in: query name: pageSize schema: type: integer format: int32 - in: query - name: filter + name: pageToken schema: type: string - in: query - name: pageToken + name: returnPartialSuccess + schema: + type: boolean + post: + description: Creates a new note. + operationId: containeranalysis.projects.locations.notes.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Note' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Note' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: noteId schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/notes:batchCreate: + parameters: *ref_1 post: - description: Creates a new occurrence. - operationId: containeranalysis.projects.locations.occurrences.create + description: Creates new notes in batch. + operationId: containeranalysis.projects.locations.notes.batchCreate requestBody: content: application/json: schema: - $ref: '#/components/schemas/Occurrence' + $ref: '#/components/schemas/BatchCreateNotesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6914,7 +7261,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Occurrence' + $ref: '#/components/schemas/BatchCreateNotesResponse' parameters: - in: path name: projectsId @@ -6926,13 +7273,22 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}/notes: + /v1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}:setIamPolicy: parameters: *ref_1 - get: + post: description: >- - Gets the note attached to the specified occurrence. Consumer projects - can use this method to get a note that belongs to a provider project. - operationId: containeranalysis.projects.locations.occurrences.getNotes + Sets the access control policy on the specified note or occurrence. + Requires `containeranalysis.notes.setIamPolicy` or + `containeranalysis.occurrences.setIamPolicy` permission if the resource + is a note or an occurrence, respectively. The resource takes the format + `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and + `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. + operationId: containeranalysis.projects.locations.notes.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6944,7 +7300,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Note' + $ref: '#/components/schemas/Policy' parameters: - in: path name: projectsId @@ -6957,25 +7313,26 @@ paths: schema: type: string - in: path - name: occurrencesId + name: notesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}:testIamPermissions: + /v1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}:getIamPolicy: parameters: *ref_1 post: description: >- - Returns the permissions that a caller has on the specified note or - occurrence. Requires list permission on the project (for example, - `containeranalysis.notes.list`). The resource takes the format + Gets the access control policy for a note or an occurrence resource. + Requires `containeranalysis.notes.setIamPolicy` or + `containeranalysis.occurrences.setIamPolicy` permission if the resource + is a note or occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. - operationId: containeranalysis.projects.locations.occurrences.testIamPermissions + operationId: containeranalysis.projects.locations.notes.getIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/TestIamPermissionsRequest' + $ref: '#/components/schemas/GetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6987,7 +7344,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TestIamPermissionsResponse' + $ref: '#/components/schemas/Policy' parameters: - in: path name: projectsId @@ -7000,26 +7357,25 @@ paths: schema: type: string - in: path - name: occurrencesId + name: notesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}:getIamPolicy: + /v1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}:testIamPermissions: parameters: *ref_1 post: description: >- - Gets the access control policy for a note or an occurrence resource. - Requires `containeranalysis.notes.setIamPolicy` or - `containeranalysis.occurrences.setIamPolicy` permission if the resource - is a note or occurrence, respectively. The resource takes the format + Returns the permissions that a caller has on the specified note or + occurrence. Requires list permission on the project (for example, + `containeranalysis.notes.list`). The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. - operationId: containeranalysis.projects.locations.occurrences.getIamPolicy + operationId: containeranalysis.projects.locations.notes.testIamPermissions requestBody: content: application/json: schema: - $ref: '#/components/schemas/GetIamPolicyRequest' + $ref: '#/components/schemas/TestIamPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7031,7 +7387,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/TestIamPermissionsResponse' parameters: - in: path name: projectsId @@ -7044,15 +7400,18 @@ paths: schema: type: string - in: path - name: occurrencesId + name: notesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/occurrences:vulnerabilitySummary: + /v1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}/occurrences: parameters: *ref_1 get: - description: Gets a summary of the number and severity of occurrences. - operationId: containeranalysis.projects.locations.occurrences.getVulnerabilitySummary + description: >- + Lists occurrences referencing the specified note. Provider projects can + use this method to get all occurrences across consumer projects + referencing the specified note. + operationId: containeranalysis.projects.locations.notes.occurrences.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7064,7 +7423,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/VulnerabilityOccurrencesSummary' + $ref: '#/components/schemas/ListNoteOccurrencesResponse' parameters: - in: path name: projectsId @@ -7076,26 +7435,34 @@ paths: required: true schema: type: string + - in: path + name: notesId + required: true + schema: + type: string - in: query name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}:setIamPolicy: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/resources/{resourcesId}:exportSBOM: parameters: *ref_1 post: - description: >- - Sets the access control policy on the specified note or occurrence. - Requires `containeranalysis.notes.setIamPolicy` or - `containeranalysis.occurrences.setIamPolicy` permission if the resource - is a note or an occurrence, respectively. The resource takes the format - `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and - `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. - operationId: containeranalysis.projects.locations.occurrences.setIamPolicy + description: Generates an SBOM for the given resource. + operationId: containeranalysis.projects.locations.resources.exportSBOM requestBody: content: application/json: schema: - $ref: '#/components/schemas/SetIamPolicyRequest' + $ref: '#/components/schemas/ExportSBOMRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7107,7 +7474,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/ExportSBOMResponse' parameters: - in: path name: projectsId @@ -7120,18 +7487,15 @@ paths: schema: type: string - in: path - name: occurrencesId + name: resourcesId required: true schema: type: string - /v1/projects/{projectsId}/notes/{notesId}/occurrences: + /v1/projects/{projectsId}/notes/{notesId}: parameters: *ref_1 get: - description: >- - Lists occurrences referencing the specified note. Provider projects can - use this method to get all occurrences across consumer projects - referencing the specified note. - operationId: containeranalysis.projects.notes.occurrences.list + description: Gets the specified note. + operationId: containeranalysis.projects.notes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7143,7 +7507,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListNoteOccurrencesResponse' + $ref: '#/components/schemas/Note' parameters: - in: path name: projectsId @@ -7155,24 +7519,35 @@ paths: required: true schema: type: string - - in: query - name: pageToken + delete: + description: Deletes the specified note. + operationId: containeranalysis.projects.notes.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true schema: type: string - - in: query - name: filter + - in: path + name: notesId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/notes: - parameters: *ref_1 - post: - description: Creates a new note. - operationId: containeranalysis.projects.notes.create + patch: + description: Updates the specified note. + operationId: containeranalysis.projects.notes.patch requestBody: content: application/json: @@ -7196,10 +7571,18 @@ paths: required: true schema: type: string + - in: path + name: notesId + required: true + schema: + type: string - in: query - name: noteId + name: updateMask schema: type: string + format: google-fieldmask + /v1/projects/{projectsId}/notes: + parameters: *ref_1 get: description: Lists notes for the specified project. operationId: containeranalysis.projects.notes.list @@ -7221,6 +7604,10 @@ paths: required: true schema: type: string + - in: query + name: filter + schema: + type: string - in: query name: pageSize schema: @@ -7231,42 +7618,17 @@ paths: schema: type: string - in: query - name: filter + name: returnPartialSuccess schema: - type: string - /v1/projects/{projectsId}/notes:batchCreate: - parameters: *ref_1 + type: boolean post: - description: Creates new notes in batch. - operationId: containeranalysis.projects.notes.batchCreate + description: Creates a new note. + operationId: containeranalysis.projects.notes.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/BatchCreateNotesRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/BatchCreateNotesResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - /v1/projects/{projectsId}/notes/{notesId}: - parameters: *ref_1 - delete: - description: Deletes the specified note. - operationId: containeranalysis.projects.notes.delete + $ref: '#/components/schemas/Note' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7278,21 +7640,27 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/Note' parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: notesId - required: true + - in: query + name: noteId schema: type: string - get: - description: Gets the specified note. - operationId: containeranalysis.projects.notes.get + /v1/projects/{projectsId}/notes:batchCreate: + parameters: *ref_1 + post: + description: Creates new notes in batch. + operationId: containeranalysis.projects.notes.batchCreate + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BatchCreateNotesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7304,26 +7672,29 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Note' + $ref: '#/components/schemas/BatchCreateNotesResponse' parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: notesId - required: true - schema: - type: string - patch: - description: Updates the specified note. - operationId: containeranalysis.projects.notes.patch + /v1/projects/{projectsId}/notes/{notesId}:setIamPolicy: + parameters: *ref_1 + post: + description: >- + Sets the access control policy on the specified note or occurrence. + Requires `containeranalysis.notes.setIamPolicy` or + `containeranalysis.occurrences.setIamPolicy` permission if the resource + is a note or an occurrence, respectively. The resource takes the format + `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and + `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. + operationId: containeranalysis.projects.notes.setIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/Note' + $ref: '#/components/schemas/SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7335,7 +7706,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Note' + $ref: '#/components/schemas/Policy' parameters: - in: path name: projectsId @@ -7347,11 +7718,6 @@ paths: required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask /v1/projects/{projectsId}/notes/{notesId}:getIamPolicy: parameters: *ref_1 post: @@ -7429,22 +7795,60 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/notes/{notesId}:setIamPolicy: + /v1/projects/{projectsId}/notes/{notesId}/occurrences: parameters: *ref_1 - post: + get: description: >- - Sets the access control policy on the specified note or occurrence. - Requires `containeranalysis.notes.setIamPolicy` or - `containeranalysis.occurrences.setIamPolicy` permission if the resource - is a note or an occurrence, respectively. The resource takes the format - `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and - `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. - operationId: containeranalysis.projects.notes.setIamPolicy + Lists occurrences referencing the specified note. Provider projects can + use this method to get all occurrences across consumer projects + referencing the specified note. + operationId: containeranalysis.projects.notes.occurrences.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListNoteOccurrencesResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: notesId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/resources/{resourcesId}:exportSBOM: + parameters: *ref_1 + post: + description: Generates an SBOM for the given resource. + operationId: containeranalysis.projects.resources.exportSBOM requestBody: content: application/json: schema: - $ref: '#/components/schemas/SetIamPolicyRequest' + $ref: '#/components/schemas/ExportSBOMRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7456,7 +7860,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/ExportSBOMResponse' parameters: - in: path name: projectsId @@ -7464,7 +7868,7 @@ paths: schema: type: string - in: path - name: notesId + name: resourcesId required: true schema: type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/contentwarehouse.yaml b/providers/src/googleapis.com/v00.00.00000/services/contentwarehouse.yaml index 345e6a44..aace6810 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/contentwarehouse.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/contentwarehouse.yaml @@ -7,8 +7,8 @@ info: title: Document AI Warehouse API description: '' version: v1 - x-discovery-doc-revision: '20240809' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250206' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/document-warehouse servers: @@ -34,634 +34,772 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudContentwarehouseV1InitializeProjectRequest: - id: GoogleCloudContentwarehouseV1InitializeProjectRequest + GoogleCloudDocumentaiV1DocumentPageDetectedBarcode: + type: object + id: GoogleCloudDocumentaiV1DocumentPageDetectedBarcode properties: - kmsKey: - type: string - description: >- - Optional. The KMS key used for CMEK encryption. It is required that - the kms key is in the same region as the endpoint. The same key will - be used for all provisioned resources, if encryption is available. - If the kms_key is left empty, no encryption will be enforced. - enableCalUserEmailLogging: - type: boolean - description: Optional. Whether to enable CAL user email logging. - databaseType: - enum: - - DB_UNKNOWN - - DB_INFRA_SPANNER - - DB_CLOUD_SQL_POSTGRES - enumDescriptions: - - This value is required by protobuf best practices - - Internal Spanner - - Cloud Sql with a Postgres Sql instance - type: string - description: Required. The type of database used to store customer data - enumDeprecated: - - false - - false - - true - accessControlMode: + layout: + description: Layout for DetectedBarcode. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + barcode: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Barcode' + description: Detailed barcode information of the DetectedBarcode. + description: A detected barcode. + GoogleCloudContentwarehouseV1RequestMetadata: + type: object + id: GoogleCloudContentwarehouseV1RequestMetadata + description: Meta information is used to improve the performance of the service. + properties: + userInfo: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1UserInfo' + description: Provides user unique identification and groups information. + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow: + properties: + cells: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell + description: A table row is a list of table cells. + type: array + id: >- + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow + description: Represents a row in a table. + type: object + GoogleCloudContentwarehouseV1InitializeProjectResponse: + description: Response message for projectService.InitializeProject + properties: + state: + description: The state of the project initialization process. type: string - description: Required. The access control mode for accessing the customer data enumDescriptions: - - This value is required by protobuf best practices - - 'Universal Access: No document level access control.' - - Document level access control with customer own Identity Service. - - Document level access control using Google Cloud Identity. - enum: - - ACL_MODE_UNKNOWN - - ACL_MODE_UNIVERSAL_ACCESS - - ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_BYOID - - ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_GCI - documentCreatorDefaultRole: - enumDescriptions: - - Unspecified, will be default to document admin role. - - >- - Document Admin, same as - contentwarehouse.googleapis.com/documentAdmin. - - >- - Document Editor, same as - contentwarehouse.googleapis.com/documentEditor. - - >- - Document Viewer, same as - contentwarehouse.googleapis.com/documentViewer. - description: Optional. The default role for the person who create a document. + - Clients should never see this. + - Finished project initialization without error. + - Finished project initialization with an error. + - Client canceled the LRO. + - Ask the customer to check the operation for results. enum: - - DOCUMENT_CREATOR_DEFAULT_ROLE_UNSPECIFIED - - DOCUMENT_ADMIN - - DOCUMENT_EDITOR - - DOCUMENT_VIEWER + - STATE_UNSPECIFIED + - SUCCEEDED + - FAILED + - CANCELLED + - RUNNING + message: type: string + description: The message of the project initialization process. type: object - description: Request message for projectService.InitializeProject - GoogleCloudContentwarehouseV1CustomWeightsMetadata: - id: GoogleCloudContentwarehouseV1CustomWeightsMetadata - description: To support the custom weighting across document schemas. + id: GoogleCloudContentwarehouseV1InitializeProjectResponse + GoogleCloudContentwarehouseV1GetDocumentRequest: type: object + description: Request message for DocumentService.GetDocument. + id: GoogleCloudContentwarehouseV1GetDocumentRequest properties: - weightedSchemaProperties: + requestMetadata: + description: >- + The meta information collected about the end user, used to enforce + access control for the service. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' + GoogleCloudContentwarehouseV1DeleteDocumentRequest: + description: Request message for DocumentService.DeleteDocument. + type: object + id: GoogleCloudContentwarehouseV1DeleteDocumentRequest + properties: + requestMetadata: + description: >- + The meta information collected about the end user, used to enforce + access control for the service. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' + GoogleCloudDocumentaiV1DocumentPageVisualElement: + id: GoogleCloudDocumentaiV1DocumentPageVisualElement + properties: + detectedLanguages: + description: A list of detected languages together with confidence. items: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1WeightedSchemaProperty + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage type: array + layout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: Layout for VisualElement. + type: + description: Type of the VisualElement. + type: string + description: >- + Detected non-text visual elements e.g. checkbox, signature etc. on the + page. + type: object + GoogleTypeTimeZone: + properties: + id: + type: string + description: IANA Time Zone Database time zone. For example "America/New_York". + version: description: >- - List of schema and property name. Allows a maximum of 10 schemas to - be specified for relevance boosting. - GoogleCloudDocumentaiV1BoundingPoly: + Optional. IANA Time Zone Database version number. For example + "2019a". + type: string + type: object + description: >- + Represents a time zone from the [IANA Time Zone + Database](https://www.iana.org/time-zones). + id: GoogleTypeTimeZone + GoogleCloudContentwarehouseV1IngestPipelineConfig: + type: object + description: The ingestion pipeline config. properties: - vertices: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Vertex' - description: The bounding polygon vertices. + documentAclPolicy: + description: >- + The document level acl policy config. This refers to an Identity and + Access (IAM) policy, which specifies access controls for all + documents ingested by the pipeline. The role and members under the + policy needs to be specified. The following roles are supported for + document level acl control: * roles/contentwarehouse.documentAdmin * + roles/contentwarehouse.documentEditor * + roles/contentwarehouse.documentViewer The following members are + supported for document level acl control: * + user:user-email@example.com * group:group-email@example.com Note + that for documents searched with LLM, only single level user or + group acl check is supported. + $ref: '#/components/schemas/GoogleIamV1Policy' + cloudFunction: + description: >- + The Cloud Function resource name. The Cloud Function needs to live + inside consumer project and is accessible to Document AI Warehouse + P4SA. Only Cloud Functions V2 is supported. Cloud function execution + should complete within 5 minutes or this file ingestion may fail due + to timeout. Format: + `https://{region}-{project_id}.cloudfunctions.net/{cloud_function}` + The following keys are available the request json payload. * + display_name * properties * plain_text * reference_id * + document_schema_name * raw_document_path * raw_document_file_type + The following keys from the cloud function json response payload + will be ingested to the Document AI Warehouse as part of Document + proto content and/or related information. The original values will + be overridden if any key is present in the response. * display_name + * properties * plain_text * document_acl_policy * folder + type: string + enableDocumentTextExtraction: + description: >- + The document text extraction enabled flag. If the flag is set to + true, DWH will perform text extraction on the raw document. + type: boolean + folder: + description: >- + Optional. The name of the folder to which all ingested documents + will be linked during ingestion process. Format is + `projects/{project}/locations/{location}/documents/{folder_id}` + type: string + id: GoogleCloudContentwarehouseV1IngestPipelineConfig + GoogleCloudDocumentaiV1DocumentPageSymbol: + description: A detected symbol. + type: object + properties: + layout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: Layout for Symbol. + detectedLanguages: type: array - normalizedVertices: + description: A list of detected languages together with confidence. items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1NormalizedVertex' - type: array - description: The bounding polygon normalized vertices. - description: A bounding polygon for the detected image annotation. - id: GoogleCloudDocumentaiV1BoundingPoly - type: object - GoogleCloudContentwarehouseV1FloatArray: - description: Float values. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + id: GoogleCloudDocumentaiV1DocumentPageSymbol + GoogleCloudContentwarehouseV1WeightedSchemaProperty: properties: - values: - description: List of float values. + propertyNames: type: array items: - format: float - type: number - id: GoogleCloudContentwarehouseV1FloatArray + type: string + description: The property definition names in the schema. + documentSchemaName: + description: The document schema name. + type: string + id: GoogleCloudContentwarehouseV1WeightedSchemaProperty + description: Specifies the schema property name. type: object - GoogleCloudContentwarehouseV1ActionOutput: + GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk: type: object + id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk + description: Represents a chunk. properties: - actionId: + sourceBlockIds: + items: + type: string + type: array + description: Unused. + chunkId: type: string - description: ID of the action. - actionState: - enum: - - UNKNOWN - - ACTION_SUCCEEDED - - ACTION_FAILED - - ACTION_TIMED_OUT - - ACTION_PENDING - description: State of an action. - type: string - enumDescriptions: - - The unknown state. - - State indicating action executed successfully. - - State indicating action failed. - - State indicating action timed out. - - State indicating action is pending. - outputMessage: - description: Action execution output message. + description: ID of the chunk. + pageSpan: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan + description: Page span of the chunk. + content: type: string - id: GoogleCloudContentwarehouseV1ActionOutput - description: Represents the result of executing an action. - GoogleCloudContentwarehouseV1MapProperty: - type: object - id: GoogleCloudContentwarehouseV1MapProperty - properties: - fields: - description: Unordered map of dynamically typed values. - type: object - additionalProperties: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Value' - description: >- - Map property value. Represents a structured entries of key value pairs, - consisting of field names which map to dynamically typed values. - GoogleCloudContentwarehouseV1RuleActionsPair: + description: Text content of the chunk. + pageHeaders: + description: Page headers associated with the chunk. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader + pageFooters: + description: Page footers associated with the chunk. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter + CloudAiPlatformTenantresourceGcsBucketConfig: + id: CloudAiPlatformTenantresourceGcsBucketConfig properties: - actionOutputs: - description: Outputs of executing the actions associated with the above rule. + viewers: + description: Input/Output [Required]. IAM roles (viewer/admin) put on the bucket. type: array items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ActionOutput' - rule: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Rule' - description: Represents the rule. - id: GoogleCloudContentwarehouseV1RuleActionsPair + type: string + kmsKeyReference: + description: >- + Input/Output [Optional]. The KMS key name or the KMS grant name used + for CMEK encryption. Only set this field when provisioning new GCS + bucket. For existing GCS bucket, this field will be ignored because + CMEK re-encryption is not supported. + type: string + ttlDays: + format: int32 + description: >- + Input/Output [Optional]. Only needed when the content in bucket need + to be garbage collected within some amount of days. + type: integer + entityName: + description: >- + Input/Output [Optional]. Only needed for per-entity tenant GCP + resources. During Deprovision API, the on-demand deletion will only + cover the tenant GCP resources with the specified entity name. + type: string + admins: + items: + type: string + type: array + bucketName: + type: string + description: >- + Input/Output [Optional]. The name of a GCS bucket with max length of + 63 chars. If not set, a random UUID will be generated as bucket + name. type: object - description: Represents a rule and outputs of associated actions. - GoogleCloudContentwarehouseV1DocumentLink: - description: A document-link between source and target document. + description: The identity to configure a GCS bucket. + GoogleCloudContentwarehouseV1InitializeProjectRequest: properties: - targetDocumentReference: - description: Document references of the target document. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentReference' - sourceDocumentReference: - description: Document references of the source document. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentReference' - state: + documentCreatorDefaultRole: + enum: + - DOCUMENT_CREATOR_DEFAULT_ROLE_UNSPECIFIED + - DOCUMENT_ADMIN + - DOCUMENT_EDITOR + - DOCUMENT_VIEWER enumDescriptions: - - Unknown state of documentlink. - - The documentlink has both source and target documents detected. + - Unspecified, will be default to document admin role. - >- - Target document is deleted, and mark the documentlink as - soft-deleted. + Document Admin, same as + contentwarehouse.googleapis.com/documentAdmin. + - >- + Document Editor, same as + contentwarehouse.googleapis.com/documentEditor. + - >- + Document Viewer, same as + contentwarehouse.googleapis.com/documentViewer. + description: Optional. The default role for the person who create a document. type: string + databaseType: + enumDeprecated: + - false + - false + - true enum: - - STATE_UNSPECIFIED - - ACTIVE - - SOFT_DELETED - description: >- - The state of the documentlink. If target node has been deleted, the - link is marked as invalid. Removing a source node will result in - removal of all associated links. - updateTime: - readOnly: true - format: google-datetime - description: Output only. The time when the documentLink is last updated. + - DB_UNKNOWN + - DB_INFRA_SPANNER + - DB_CLOUD_SQL_POSTGRES + enumDescriptions: + - This value is required by protobuf best practices + - Internal Spanner + - Cloud Sql with a Postgres Sql instance + description: Required. The type of database used to store customer data type: string - name: + kmsKey: type: string description: >- - Name of this document-link. It is required that the parent derived - form the name to be consistent with the source document reference. - Otherwise an exception will be thrown. Format: - projects/{project_number}/locations/{location}/documents/{source_document_id}/documentLinks/{document_link_id}. - createTime: - type: string - description: Output only. The time when the documentLink is created. - format: google-datetime - readOnly: true - description: - description: Description of this document-link. + Optional. The KMS key used for CMEK encryption. It is required that + the kms key is in the same region as the endpoint. The same key will + be used for all provisioned resources, if encryption is available. + If the kms_key is left empty, no encryption will be enforced. + accessControlMode: + enumDescriptions: + - This value is required by protobuf best practices + - 'Universal Access: No document level access control.' + - Document level access control with customer own Identity Service. + - Document level access control using Google Cloud Identity. + description: Required. The access control mode for accessing the customer data type: string + enum: + - ACL_MODE_UNKNOWN + - ACL_MODE_UNIVERSAL_ACCESS + - ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_BYOID + - ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_GCI + enableCalUserEmailLogging: + description: Optional. Whether to enable CAL user email logging. + type: boolean + description: Request message for projectService.InitializeProject type: object - id: GoogleCloudContentwarehouseV1DocumentLink - GoogleCloudContentwarehouseV1TimestampArray: + id: GoogleCloudContentwarehouseV1InitializeProjectRequest + GoogleCloudContentwarehouseV1ActionOutput: + id: GoogleCloudContentwarehouseV1ActionOutput type: object - description: Timestamp values. + description: Represents the result of executing an action. properties: - values: - description: List of timestamp values. - type: array - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TimestampValue' - id: GoogleCloudContentwarehouseV1TimestampArray - GoogleLongrunningOperation: - type: object - id: GoogleLongrunningOperation - description: >- - This resource represents a long-running operation that is the result of - a network API call. + outputMessage: + description: Action execution output message. + type: string + actionState: + enumDescriptions: + - The unknown state. + - State indicating action executed successfully. + - State indicating action failed. + - State indicating action timed out. + - State indicating action is pending. + enum: + - UNKNOWN + - ACTION_SUCCEEDED + - ACTION_FAILED + - ACTION_TIMED_OUT + - ACTION_PENDING + type: string + description: State of an action. + actionId: + type: string + description: ID of the action. + GoogleCloudContentwarehouseV1HistogramQuery: + description: The histogram request. + id: GoogleCloudContentwarehouseV1HistogramQuery properties: - name: + requirePreciseResultSize: + type: boolean + description: >- + Controls if the histogram query requires the return of a precise + count. Enable this flag may adversely impact performance. Defaults + to true. + filters: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1HistogramQueryPropertyNameFilter + description: >- + Optional. Filter the result of histogram query by the property + names. It only works with histogram query + count('FilterableProperties'). It is an optional. It will perform + histogram on all the property names for all the document schemas. + Setting this field will have a better performance. + histogramQuery: type: string description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. - response: + An expression specifies a histogram request against matching + documents for searches. See SearchDocumentsRequest.histogram_queries + for details about syntax. + type: object + GoogleCloudDocumentaiV1DocumentRevisionHumanReview: + id: GoogleCloudDocumentaiV1DocumentRevisionHumanReview + description: Human Review information of the document. + properties: + stateMessage: description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: object - metadata: - description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - error: - $ref: '#/components/schemas/GoogleRpcStatus' - description: >- - The error result of the operation in case of failure or - cancellation. - done: - type: boolean - description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - GoogleCloudContentwarehouseV1ListLinkedTargetsRequest: + A message providing more details about the current state of + processing. For example, the rejection reason when the state is + `rejected`. + type: string + state: + type: string + description: Human review state. e.g. `requested`, `succeeded`, `rejected`. type: object + GoogleCloudContentwarehouseV1ListDocumentSchemasResponse: properties: - requestMetadata: + nextPageToken: description: >- - The meta information collected about the document creator, used to - enforce access control for the service. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' - id: GoogleCloudContentwarehouseV1ListLinkedTargetsRequest - description: Request message for DocumentLinkService.ListLinkedTargets. - GoogleCloudContentwarehouseV1DocumentQuery: - type: object - properties: - documentSchemaNames: + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + documentSchemas: + description: The document schemas from the specified parent. type: array items: - type: string + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema' + id: GoogleCloudContentwarehouseV1ListDocumentSchemasResponse + type: object + description: Response message for DocumentSchemaService.ListDocumentSchemas. + GoogleCloudContentwarehouseV1PropertyFilter: + properties: + documentSchemaName: + type: string description: >- - This filter specifies the exact document schema - Document.document_schema_name of the documents to search against. If - a value isn't specified, documents within the search results are - associated with any schema. If multiple values are specified, - documents within the search results may be associated with any of - the specified schemas. At most 20 document schema names are allowed. - query: + The Document schema name Document.document_schema_name. Format: + projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. + condition: description: >- - The query string that matches against the full text of the document - and the searchable properties. The query partially supports [Google - AIP style syntax](https://google.aip.dev/160). Specifically, the - query supports literals, logical operators, negation operators, - comparison operators, and functions. Literals: A bare literal value - (examples: "42", "Hugo") is a value to be matched against. It - searches over the full text of the document and the searchable - properties. Logical operators: "AND", "and", "OR", and "or" are - binary logical operators (example: "engineer OR developer"). - Negation operators: "NOT" and "!" are negation operators (example: - "NOT software"). Comparison operators: support the binary comparison - operators =, !=, <, >, <= and >= for string, numeric, enum, boolean. - Also support like operator `~~` for string. It provides semantic - search functionality by parsing, stemming and doing synonyms - expansion against the input query. To specify a property in the - query, the left hand side expression in the comparison must be the - property ID including the parent. The right hand side must be - literals. For example: "\"projects/123/locations/us\".property_a < - 1" matches results whose "property_a" is less than 1 in project 123 - and us location. The literals and comparison expression can be - connected in a single query (example: "software engineer - \"projects/123/locations/us\".salary > 100"). Functions: supported - functions are `LOWER([property_name])` to perform a case insensitive - match and `EMPTY([property_name])` to filter on the existence of a - key. Support nested expressions connected using parenthesis and - logical operators. The default logical operators is `AND` if there - is no operators between expressions. The query can be used with - other filters e.g. `time_filters` and `folder_name_filter`. They are - connected with `AND` operator under the hood. The maximum number of - allowed characters is 255. + The filter condition. The syntax for this expression is a subset of + SQL syntax. Supported operators are: `=`, `!=`, `<`, `<=`, `>`, + `>=`, and `~~` where the left of the operator is a property name and + the right of the operator is a number or a quoted string. You must + escape backslash (\\) and quote (\") characters. `~~` is the LIKE + operator. The right of the operator must be a string. The only + supported property data type for LIKE is text_values. It provides + semantic search functionality by parsing, stemming and doing + synonyms expansion against the input query. It matches if the + property contains semantic similar content to the query. It is not + regex matching or wildcard matching. For example, "property.company + ~~ \"google\"" will match records whose property `property.compnay` + have values like "Google Inc.", "Google LLC" or "Google Company". + Supported functions are `LOWER([property_name])` to perform a case + insensitive match and `EMPTY([property_name])` to filter on the + existence of a key. Boolean expressions (AND/OR/NOT) are supported + up to 3 levels of nesting (for example, "((A AND B AND C) OR NOT D) + AND E"), a maximum of 100 comparisons or functions are allowed in + the expression. The expression must be < 6000 bytes in length. Only + properties that are marked filterable are allowed + (PropertyDefinition.is_filterable). Property names do not need to be + prefixed by the document schema id (as is the case with histograms), + however property names will need to be prefixed by its parent + hierarchy, if any. For example: top_property_name.sub_property_name. + Sample Query: `(LOWER(driving_license)="class \"a\"" OR + EMPTY(driving_license)) AND driving_years > 10` CMEK compliant + deployment only supports: * Operators: `=`, `<`, `<=`, `>`, and + `>=`. * Boolean expressions: AND and OR. type: string - timeFilters: - description: >- - Documents created/updated within a range specified by this filter - are searched against. - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TimeFilter' - type: array - folderNameFilter: + type: object + id: GoogleCloudContentwarehouseV1PropertyFilter + GoogleCloudContentwarehouseV1ListRuleSetsResponse: + description: Response message for RuleSetService.ListRuleSets. + properties: + nextPageToken: description: >- - Search all the documents under this specified folder. Format: - projects/{project_number}/locations/{location}/documents/{document_id}. + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. type: string - propertyFilter: + ruleSets: + description: The rule sets from the specified parent. type: array items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1PropertyFilter' + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleSet' + id: GoogleCloudContentwarehouseV1ListRuleSetsResponse + type: object + GoogleCloudContentwarehouseV1FloatTypeOptions: + description: Configurations for a float property. + id: GoogleCloudContentwarehouseV1FloatTypeOptions + properties: {} + type: object + CloudAiPlatformTenantresourceTenantServiceAccountIdentity: + properties: + serviceAccountEmail: + type: string + description: Output only. The email address of the generated service account. + serviceName: + type: string description: >- - This filter specifies a structured syntax to match against the - PropertyDefinition.is_filterable marked as `true`. The relationship - between the PropertyFilters is OR. - queryContext: + Input/Output [Required]. The service that the service account + belongs to. (e.g. cloudbuild.googleapis.com for GCB service + accounts) + id: CloudAiPlatformTenantresourceTenantServiceAccountIdentity + description: >- + The identity of service accounts that have been explicitly created under + tenant projects. + type: object + GoogleCloudDocumentaiV1DocumentPageToken: + description: A detected token. + properties: + detectedLanguages: items: - type: string + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage type: array - description: >- - For custom synonyms. Customers provide the synonyms based on - context. One customer can provide multiple set of synonyms based on - different context. The search query will be expanded based on the - custom synonyms of the query context set. By default, no custom - synonyms wll be applied if no query context is provided. It is not - supported for CMEK compliant deployment. - customPropertyFilter: - type: string - description: >- - This filter specifies a structured syntax to match against the - [PropertyDefinition].is_filterable marked as `true`. The syntax for - this expression is a subset of SQL syntax. Supported operators are: - `=`, `!=`, `<`, `<=`, `>`, and `>=` where the left of the operator - is a property name and the right of the operator is a number or a - quoted string. You must escape backslash (\\) and quote (\") - characters. Supported functions are `LOWER([property_name])` to - perform a case insensitive match and `EMPTY([property_name])` to - filter on the existence of a key. Boolean expressions (AND/OR/NOT) - are supported up to 3 levels of nesting (for example, "((A AND B AND - C) OR NOT D) AND E"), a maximum of 100 comparisons or functions are - allowed in the expression. The expression must be < 6000 bytes in - length. Sample Query: `(LOWER(driving_license)="class \"a\"" OR - EMPTY(driving_license)) AND driving_years > 10` + description: A list of detected languages together with confidence. + layout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: Layout for Token. + provenance: + description: The history of this annotation. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' deprecated: true - documentCreatorFilter: + styleInfo: + description: Text style attributes. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo + detectedBreak: + description: Detected break at the end of a Token. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak + id: GoogleCloudDocumentaiV1DocumentPageToken + type: object + GoogleCloudContentwarehouseV1RuleActionsPair: + properties: + rule: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Rule' + description: Represents the rule. + actionOutputs: + items: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ActionOutput' type: array + description: Outputs of executing the actions associated with the above rule. + description: Represents a rule and outputs of associated actions. + type: object + id: GoogleCloudContentwarehouseV1RuleActionsPair + GoogleCloudDocumentaiV1DocumentEntityNormalizedValue: + properties: + datetimeValue: + $ref: '#/components/schemas/GoogleTypeDateTime' description: >- - The exact creator(s) of the documents to search against. If a value - isn't specified, documents within the search results are associated - with any creator. If multiple values are specified, documents within - the search results may be associated with any of the specified - creators. - items: - type: string - customWeightsMetadata: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1CustomWeightsMetadata + DateTime value. Includes date, time, and timezone. See also: + https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto + addressValue: description: >- - To support the custom weighting across document schemas, customers - need to provide the properties to be used to boost the ranking in - the search request. For a search query with CustomWeightsMetadata - specified, only the RetrievalImportance for the properties in the - CustomWeightsMetadata will be honored. - isNlQuery: + Postal address. See also: + https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto + $ref: '#/components/schemas/GoogleTypePostalAddress' + moneyValue: description: >- - Experimental, do not use. If the query is a natural language - question. False by default. If true, then the question-answering - feature will be used instead of search, and `result_count` in - SearchDocumentsRequest must be set. In addition, all other input - fields related to search (pagination, histograms, etc.) will be - ignored. - type: boolean - fileTypeFilter: + Money value. See also: + https://github.com/googleapis/googleapis/blob/master/google/type/money.proto + $ref: '#/components/schemas/GoogleTypeMoney' + floatValue: + format: float + type: number + description: Float value. + text: description: >- - This filter specifies the types of files to return: ALL, FOLDER, or - FILE. If FOLDER or FILE is specified, then only either folders or - files will be returned, respectively. If ALL is specified, both - folders and files will be returned. If no value is specified, ALL - files will be returned. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1FileTypeFilter' - documentNameFilter: + Optional. An optional field to store a normalized string. For some + entity types, one of respective `structured_value` fields may also + be populated. Also not all the types of `structured_value` will be + normalized. For example, some processors may not generate `float` or + `integer` normalized text by default. Below are sample formats + mapped to structured values. - Money/Currency type (`money_value`) + is in the ISO 4217 text format. - Date type (`date_value`) is in the + ISO 8601 text format. - Datetime type (`datetime_value`) is in the + ISO 8601 text format. + type: string + integerValue: + description: Integer value. + format: int32 + type: integer + dateValue: description: >- - Search the documents in the list. Format: - projects/{project_number}/locations/{location}/documents/{document_id}. - type: array - items: - type: string - id: GoogleCloudContentwarehouseV1DocumentQuery - GoogleCloudContentwarehouseV1PublishAction: - description: >- - Represents the action responsible for publishing messages to a Pub/Sub - topic. - properties: - topicId: + Date value. Includes year, month, day. See also: + https://github.com/googleapis/googleapis/blob/master/google/type/date.proto + $ref: '#/components/schemas/GoogleTypeDate' + booleanValue: description: >- - The topic id in the Pub/Sub service for which messages will be - published to. - type: string - messages: - type: array - description: Messages to be published. - items: - type: string - type: object - id: GoogleCloudContentwarehouseV1PublishAction - GoogleCloudContentwarehouseV1FetchAclResponse: + Boolean value. Can be used for entities with binary values, or for + checkboxes. + type: boolean type: object + description: Parsed and normalized entity value. + id: GoogleCloudDocumentaiV1DocumentEntityNormalizedValue + GoogleCloudContentwarehouseV1DocumentReference: + description: References to the documents. + id: GoogleCloudContentwarehouseV1DocumentReference properties: - metadata: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ResponseMetadata' + documentIsRetentionFolder: + type: boolean + description: Document is a folder with retention policy. + documentIsLegalHoldFolder: + type: boolean + description: Document is a folder with legal hold. + displayName: description: >- - Additional information for the API invocation, such as the request - tracking id. - policy: - $ref: '#/components/schemas/GoogleIamV1Policy' - description: The IAM policy. - description: Response message for DocumentService.FetchAcl. - id: GoogleCloudContentwarehouseV1FetchAclResponse - GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan: - description: Represents where the chunk starts and ends in the document. - type: object - id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan - properties: - pageEnd: - description: Page where chunk ends in the document. - format: int32 - type: integer - pageStart: - type: integer - format: int32 - description: Page where chunk starts in the document. - GoogleCloudContentwarehouseV1FloatTypeOptions: - properties: {} - id: GoogleCloudContentwarehouseV1FloatTypeOptions - description: Configurations for a float property. + display_name of the referenced document; this name does not need to + be consistent to the display_name in the Document proto, depending + on the ACL constraint. + type: string + createTime: + description: Output only. The time when the document is created. + readOnly: true + type: string + format: google-datetime + documentName: + description: Required. Name of the referenced document. + type: string + updateTime: + description: Output only. The time when the document is last updated. + readOnly: true + type: string + format: google-datetime + snippet: + description: >- + Stores the subset of the referenced document's content. This is + useful to allow user peek the information of the referenced + document. + type: string + deleteTime: + description: Output only. The time when the document is deleted. + type: string + readOnly: true + format: google-datetime + documentIsFolder: + type: boolean + description: The document type of the document being referenced. type: object - GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader: - id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader + GoogleIamV1AuditLogConfig: type: object - description: Represents the page header associated with the chunk. properties: - pageSpan: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan - description: Page span of the header. - text: + exemptedMembers: + items: + type: string + type: array + description: >- + Specifies the identities that do not cause logging for this type of + permission. Follows the same format of Binding.members. + logType: type: string - description: Header in text format. - GoogleTypeDateTime: - id: GoogleTypeDateTime - type: object + description: The log type that this config enables. + enum: + - LOG_TYPE_UNSPECIFIED + - ADMIN_READ + - DATA_WRITE + - DATA_READ + enumDescriptions: + - Default case. Should never be this. + - 'Admin reads. Example: CloudIAM getIamPolicy' + - 'Data writes. Example: CloudSQL Users create' + - 'Data reads. Example: CloudSQL Users list' description: >- - Represents civil time (or occasionally physical time). This type can - represent a civil time in one of a few possible ways: * When utc_offset - is set and time_zone is unset: a civil time on a calendar day with a - particular offset from UTC. * When time_zone is set and utc_offset is - unset: a civil time on a calendar day in a particular time zone. * When - neither time_zone nor utc_offset is set: a civil time on a calendar day - in local time. The date is relative to the Proleptic Gregorian Calendar. - If year, month, or day are 0, the DateTime is considered not to have a - specific year, month, or day respectively. This type may also be used to - represent a physical time if all the date and time fields are set and - either case of the `time_offset` oneof is set. Consider using - `Timestamp` message for physical time instead. If your use case also - would like to store the user's timezone, that can be done in another - field. This type is more flexible than some applications may want. Make - sure to document and validate your application's limitations. + 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. + id: GoogleIamV1AuditLogConfig + GoogleCloudDocumentaiV1DocumentRevision: + description: Contains past or forward revisions of this document. + type: object properties: - nanos: - format: int32 - description: >- - Optional. Fractions of seconds in nanoseconds. Must be from 0 to - 999,999,999, defaults to 0. - type: integer - minutes: - description: >- - Optional. Minutes of hour of day. Must be from 0 to 59, defaults to - 0. - format: int32 - type: integer - month: - type: integer - format: int32 - description: >- - Optional. Month of year. Must be from 1 to 12, or 0 if specifying a - datetime without a month. - year: + parent: + type: array + items: + type: integer + format: int32 description: >- - Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a - datetime without a year. - type: integer - format: int32 - hours: + The revisions that this revision is based on. This can include one + or more parent (when documents are merged.) This field represents + the index into the `revisions` field. + deprecated: true + agent: + type: string description: >- - Optional. Hours of day in 24 hour format. Should be from 0 to 23, - defaults to 0 (midnight). An API may choose to allow the value - "24:00:00" for scenarios like business closing time. - format: int32 - type: integer - utcOffset: + If the change was made by a person specify the name or id of that + person. + humanReview: + description: Human Review information of this revision. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentRevisionHumanReview + processor: type: string - format: google-duration description: >- - UTC offset. Must be whole seconds, between -18 hours and +18 hours. - For example, a UTC offset of -4:00 would be represented as { - seconds: -14400 }. - day: - format: int32 + If the annotation was made by processor identify the processor by + its resource name. + parentIds: + items: + type: string + type: array description: >- - Optional. Day of month. Must be from 1 to 31 and valid for the year - and month, or 0 if specifying a datetime without a day. - type: integer - timeZone: - $ref: '#/components/schemas/GoogleTypeTimeZone' - description: Time zone. - seconds: - type: integer - format: int32 + The revisions that this revision is based on. Must include all the + ids that have anything to do with this revision - eg. there are + `provenance.parent.revision` fields that index into this field. + createTime: + type: string + format: google-datetime description: >- - Optional. Seconds of minutes of the time. Must normally be from 0 to - 59, defaults to 0. An API may allow the value 60 if it allows - leap-seconds. - GoogleCloudDocumentaiV1DocumentPageSymbol: - type: object - description: A detected symbol. + The time that the revision was created, internally generated by doc + proto storage at the time of create. + id: + description: >- + Id of the revision, internally generated by doc proto storage. + Unique within the context of the document. + type: string + id: GoogleCloudDocumentaiV1DocumentRevision + GoogleCloudContentwarehouseV1Action: properties: - detectedLanguages: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - type: array - description: A list of detected languages together with confidence. - layout: - description: Layout for Symbol. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - id: GoogleCloudDocumentaiV1DocumentPageSymbol - CloudAiPlatformTenantresourceCloudSqlInstanceConfig: + accessControl: + description: Action triggering access control operations. + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1AccessControlAction + dataValidation: + description: Action triggering data validation operations. + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1DataValidationAction + publishToPubSub: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1PublishAction' + description: Action publish to Pub/Sub operation. + deleteDocumentAction: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1DeleteDocumentAction + description: Action deleting the document. + removeFromFolderAction: + description: Action removing a document from a folder. + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1RemoveFromFolderAction + dataUpdate: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DataUpdateAction' + description: Action triggering data update operations. + addToFolder: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1AddToFolderAction' + description: Action triggering create document link operation. + actionId: + description: ID of the action. Managed internally. + type: string + description: Represents the action triggered by Rule Engine when the rule is true. + id: GoogleCloudContentwarehouseV1Action + type: object + GoogleCloudContentwarehouseV1ExportToCdwPipeline: + id: GoogleCloudContentwarehouseV1ExportToCdwPipeline + description: >- + The configuration of exporting documents from the Document Warehouse to + CDW pipeline. type: object properties: - slmInstanceType: - type: string - description: Input [Required]. The SLM instance type to provision CloudSQL. - kmsKeyReference: + exportFolderPath: type: string description: >- - Input [Optional]. The KMS key name or the KMS grant name used for - CMEK encryption. Only set this field when provisioning new CloudSQL - instances. For existing CloudSQL instances, this field will be - ignored because CMEK re-encryption is not supported. - slmInstanceName: - description: Output only. The SLM instance's full resource name. - type: string - cloudSqlInstanceConnectionName: - type: string - description: Output only. The CloudSQL instance connection name. - mdbRolesForCorpAccess: + The Cloud Storage folder path used to store the exported documents + before being sent to CDW. Format: `gs:///`. + trainingSplitRatio: + description: >- + Ratio of training dataset split. When importing into Document AI + Workbench, documents will be automatically split into training and + test split category with the specified ratio. This field is required + if doc_ai_dataset is set. + type: number + format: float + documents: items: type: string + description: >- + The list of all the resource names of the documents to be processed. + Format: + projects/{project_number}/locations/{location}/documents/{document_id}. type: array - description: Input [Optional]. MDB roles for corp access to CloudSQL instance. - cloudSqlInstanceName: + docAiDataset: description: >- - Input/Output [Optional]. The CloudSQL instance name within SLM - instance. If not set, a random UUIC will be generated as instance - name. - type: string - slmInstanceTemplate: + Optional. The CDW dataset resource name. This field is optional. If + not set, the documents will be exported to Cloud Storage only. + Format: + projects/{project}/locations/{location}/processors/{processor}/dataset type: string - description: Input [Required]. The SLM instance template to provision CloudSQL. - id: CloudAiPlatformTenantresourceCloudSqlInstanceConfig - description: >- - The identity to configure a CloudSQL instance provisioned via SLM - Terraform. GoogleCloudDocumentaiV1DocumentPage: + id: GoogleCloudDocumentaiV1DocumentPage + description: A page in a Document. type: object properties: - visualElements: - description: >- - A list of detected non-text visual elements e.g. checkbox, signature - etc. on the page. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageVisualElement - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for the page. formFields: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageFormField' description: A list of visually detected form fields on the page. type: array - provenance: - description: The history of this page. - deprecated: true - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - detectedLanguages: items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - type: array - description: A list of detected languages together with confidence. - tokens: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageFormField' + symbols: + description: A list of visually detected symbols on the page. type: array - description: A list of visually detected tokens on the page. items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageToken' + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageSymbol' blocks: items: $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageBlock' @@ -670,55 +808,61 @@ components: set of lines (collected into paragraphs) that have a common line-spacing and orientation. type: array - pageNumber: - format: int32 + transforms: description: >- - 1-based index for current Page in a parent Document. Useful when a - page is taken out of a Document for individual processing. - type: integer - symbols: + Transformation matrices that were applied to the original document + image to produce Page.image. + type: array items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageSymbol' + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageMatrix' + visualElements: + description: >- + A list of detected non-text visual elements e.g. checkbox, signature + etc. on the page. type: array - description: A list of visually detected symbols on the page. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageVisualElement + layout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: Layout for the page. + imageQualityScores: + description: Image quality scores. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageImageQualityScores + provenance: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + description: The history of this page. + deprecated: true + lines: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLine' + type: array + description: >- + A list of visually detected text lines on the page. A collection of + tokens that a human would perceive as a line. image: $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageImage' description: >- Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned. - tables: + tokens: type: array + description: A list of visually detected tokens on the page. items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageTable' - description: A list of visually detected tables on the page. - lines: - description: >- - A list of visually detected text lines on the page. A collection of - tokens that a human would perceive as a line. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLine' - type: array - detectedBarcodes: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageToken' + detectedLanguages: type: array - description: A list of detected barcodes. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedBarcode - transforms: - description: >- - Transformation matrices that were applied to the original document - image to produce Page.image. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageMatrix' + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + description: A list of detected languages together with confidence. + tables: + description: A list of visually detected tables on the page. type: array - imageQualityScores: - description: Image quality scores. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageImageQualityScores - dimension: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageDimension' - description: Physical dimension of the page. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageTable' paragraphs: type: array description: >- @@ -726,303 +870,286 @@ components: collection of lines that a human would perceive as a paragraph. items: $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageParagraph' - description: A page in a Document. - id: GoogleCloudDocumentaiV1DocumentPage - GoogleIamV1Binding: - id: GoogleIamV1Binding - type: object - properties: - members: - items: - type: string - type: array + pageNumber: + type: integer description: >- - Specifies the principals requesting access for a Google Cloud - 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. Does not include identities - that come from external identity providers (IdPs) through identity - federation. * `user:{emailid}`: An email address that represents a - specific Google account. For example, `alice@example.com` . * - `serviceAccount:{emailid}`: An email address that represents a - Google service account. For example, - `my-other-app@appspot.gserviceaccount.com`. * - `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: - An identifier for a [Kubernetes service - account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). - For example, - `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * - `group:{emailid}`: An email address that represents a Google group. - For example, `admins@example.com`. * `domain:{domain}`: The G Suite - domain (primary) that represents all the users of that domain. For - example, `google.com` or `example.com`. * - `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workforce identity pool. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: - All workforce identities in a group. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All workforce identities with a specific attribute value. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: - All identities in a workforce identity pool. * - `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workload identity pool. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: - A workload identity pool group. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All identities in a workload identity pool with a certain attribute. - * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: - All identities in a workload identity pool. * - `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. * - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - Deleted single identity in a workforce identity pool. For example, - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. - role: - type: string - description: >- - Role that is assigned to the list of `members`, or principals. For - example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an - overview of the IAM roles and permissions, see the [IAM - documentation](https://cloud.google.com/iam/docs/roles-overview). - For a list of the available pre-defined roles, see - [here](https://cloud.google.com/iam/docs/understanding-roles). - condition: - $ref: '#/components/schemas/GoogleTypeExpr' - description: >- - The condition that is associated with this binding. If the condition - evaluates to `true`, then this binding applies to the current - request. If the condition evaluates to `false`, then this binding - does not apply to the current request. However, a different role - binding might grant the same role to one or more of the principals - in this binding. To learn which resources support conditions in - their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - description: Associates `members`, or principals, with a `role`. - GoogleCloudContentwarehouseV1DataValidationAction: - id: GoogleCloudContentwarehouseV1DataValidationAction - description: Represents the action responsible for data validation operations. - type: object - properties: - conditions: - type: object - additionalProperties: - type: string - description: >- - Map of (K, V) -> (field, string condition to be evaluated on the - field) E.g., ("age", "age > 18 && age < 60") entry triggers - validation of field age with the given condition. Map entries will - be ANDed during validation. - GoogleCloudContentwarehouseV1PropertyArray: - id: GoogleCloudContentwarehouseV1PropertyArray - description: Property values. - properties: - properties: - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Property' - description: List of property values. + 1-based index for current Page in a parent Document. Useful when a + page is taken out of a Document for individual processing. + format: int32 + dimension: + description: Physical dimension of the page. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageDimension' + detectedBarcodes: type: array - type: object + description: A list of detected barcodes. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedBarcode CloudAiPlatformTenantresourceServiceAccountIdentity: - id: CloudAiPlatformTenantresourceServiceAccountIdentity - description: The identity to configure a service account. type: object properties: serviceAccountEmail: type: string description: Output only. The service account email that has been created. tag: - type: string description: >- Input/Output [Optional]. The tag that configures the service account, as defined in google3/configs/production/cdpush/acl-zanzibar-cloud-prod/activation_grants/activation_grants.gcl. Note: The default P4 service account has the empty tag. - GoogleCloudContentwarehouseV1WeightedSchemaProperty: - type: object - properties: - propertyNames: - type: array - items: - type: string - description: The property definition names in the schema. - documentSchemaName: - description: The document schema name. type: string - description: Specifies the schema property name. - id: GoogleCloudContentwarehouseV1WeightedSchemaProperty - GoogleCloudContentwarehouseV1RuleSet: + id: CloudAiPlatformTenantresourceServiceAccountIdentity + description: The identity to configure a service account. + GoogleLongrunningOperation: type: object - id: GoogleCloudContentwarehouseV1RuleSet - description: Represents a set of rules from a single customer. properties: - rules: - type: array - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Rule' - description: List of rules given by the customer. name: - type: string description: >- - The resource name of the rule set. Managed internally. Format: - projects/{project_number}/locations/{location}/ruleSet/{rule_set_id}. - The name is ignored when creating a rule set. - description: - type: string - description: Short description of the rule-set. - source: + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. type: string - description: Source of the rules i.e., customer name. - GoogleProtobufEmpty: - properties: {} - id: GoogleProtobufEmpty + error: + description: >- + The error result of the operation in case of failure or + cancellation. + $ref: '#/components/schemas/GoogleRpcStatus' + metadata: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + description: >- + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + done: + description: >- + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + type: boolean + response: + description: >- + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + This resource represents a long-running operation that is the result of + a network API call. + id: GoogleLongrunningOperation + GoogleCloudContentwarehouseV1TimestampArray: + id: GoogleCloudContentwarehouseV1TimestampArray type: object - CloudAiPlatformTenantresourceTenantProjectResource: - id: CloudAiPlatformTenantresourceTenantProjectResource - description: 'The tenant project and tenant resources. Next ID: 10' properties: - tenantProjectId: - type: string - description: Output only. The tenant project ID that has been created. - tenantProjectNumber: - type: string - description: Output only. The tenant project number that has been created. - format: int64 - cloudSqlInstances: + values: type: array + description: List of timestamp values. items: - $ref: >- - #/components/schemas/CloudAiPlatformTenantresourceCloudSqlInstanceConfig + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TimestampValue' + description: Timestamp values. + GoogleCloudContentwarehouseV1ListLinkedSourcesRequest: + id: GoogleCloudContentwarehouseV1ListLinkedSourcesRequest + properties: + pageSize: + format: int32 + type: integer description: >- - The CloudSQL instances that are provisioned under the tenant - project. - tag: + The maximum number of document-links to return. The service may + return fewer than this value. If unspecified, at most 50 + document-links will be returned. The maximum value is 1000; values + above 1000 will be coerced to 1000. + requestMetadata: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' description: >- - Input/Output [Required]. The tag that uniquely identifies a tenant - project within a tenancy unit. Note: for the same tenant project - tag, all tenant manager operations should be idempotent. + The meta information collected about the document creator, used to + enforce access control for the service. + pageToken: + description: >- + A page token, received from a previous `ListLinkedSources` call. + Provide this to retrieve the subsequent page. When paginating, all + other parameters provided to `ListLinkedSources` must match the call + that provided the page token. type: string - iamPolicyBindings: - type: array - items: - $ref: '#/components/schemas/CloudAiPlatformTenantresourceIamPolicyBinding' + description: Response message for DocumentLinkService.ListLinkedSources. + type: object + GoogleCloudContentwarehouseV1UpdateDocumentResponse: + properties: + document: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' + description: Updated document after executing update request. + ruleEngineOutput: description: >- - The dynamic IAM bindings that are granted under the tenant project. - Note: this should only add new bindings to the project if they don't - exist and the existing bindings won't be affected. - tenantServiceAccounts: - description: >- - The service account identities (or enabled API service's P4SA) that - are expclicitly created under the tenant project (before JIT - provisioning during enabled API services). - items: - $ref: >- - #/components/schemas/CloudAiPlatformTenantresourceTenantServiceAccountIdentity - type: array - gcsBuckets: - type: array - items: - $ref: '#/components/schemas/CloudAiPlatformTenantresourceGcsBucketConfig' - description: The GCS buckets that are provisioned under the tenant project. - tenantProjectConfig: - $ref: >- - #/components/schemas/CloudAiPlatformTenantresourceTenantProjectConfig - description: The configurations of a tenant project. - infraSpannerConfigs: + Output from Rule Engine recording the rule evaluator and action + executor's output. Refer format in: + google/cloud/contentwarehouse/v1/rule_engine.proto + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleEngineOutput' + metadata: description: >- - The Infra Spanner databases that are provisioned under the tenant - project. Note: this is an experimental feature. - type: array - items: - $ref: >- - #/components/schemas/CloudAiPlatformTenantresourceInfraSpannerConfig + Additional information for the API invocation, such as the request + tracking id. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ResponseMetadata' type: object - GoogleCloudDocumentaiV1DocumentChunkedDocument: - id: GoogleCloudDocumentaiV1DocumentChunkedDocument + description: Response message for DocumentService.UpdateDocument. + id: GoogleCloudContentwarehouseV1UpdateDocumentResponse + GoogleApiServiceconsumermanagementV1BillingConfig: + description: Describes the billing configuration for a new tenant project. + id: GoogleApiServiceconsumermanagementV1BillingConfig type: object - description: Represents the chunks that the document is divided into. - properties: - chunks: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk - description: List of chunks. - type: array - GoogleCloudContentwarehouseV1CloudAIDocumentOption: properties: - customizedEntitiesPropertiesConversions: - description: If set, only selected entities will be converted to properties. - additionalProperties: - type: string - type: object - enableEntitiesConversions: - description: Whether to convert all the entities to properties. - type: boolean - description: Request Option for processing Cloud AI Document in CW Document. - id: GoogleCloudContentwarehouseV1CloudAIDocumentOption + billingAccount: + description: >- + Name of the billing account. For example + `billingAccounts/012345-567890-ABCDEF`. + type: string + GoogleCloudContentwarehouseV1UpdateOptions: + description: Options for Update operations. + id: GoogleCloudContentwarehouseV1UpdateOptions type: object - CloudAiPlatformTenantresourceTenantServiceAccountIdentity: properties: - serviceAccountEmail: - description: Output only. The email address of the generated service account. + updateMask: + description: >- + Field mask for merging Document fields. For the `FieldMask` + definition, see + https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + format: google-fieldmask type: string - serviceName: + mergeFieldsOptions: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1MergeFieldsOptions' + description: Options for merging. + updateType: + enumDescriptions: + - Defaults to full replace behavior, ie. FULL_REPLACE. + - >- + Fully replace all the fields (including previously linked raw + document). Any field masks will be ignored. + - Merge the fields into the existing entities. + - Inserts the properties by names. + - Replace the properties by names. + - Delete the properties by names. + - >- + For each of the property, replaces the property if the it exists, + otherwise inserts a new property. And for the rest of the fields, + merge them based on update mask and merge fields options. type: string + enum: + - UPDATE_TYPE_UNSPECIFIED + - UPDATE_TYPE_REPLACE + - UPDATE_TYPE_MERGE + - UPDATE_TYPE_INSERT_PROPERTIES_BY_NAMES + - UPDATE_TYPE_REPLACE_PROPERTIES_BY_NAMES + - UPDATE_TYPE_DELETE_PROPERTIES_BY_NAMES + - UPDATE_TYPE_MERGE_AND_REPLACE_OR_INSERT_PROPERTIES_BY_NAMES + description: Type for update. + GoogleCloudContentwarehouseV1ResponseMetadata: + properties: + requestId: description: >- - Input/Output [Required]. The service that the service account - belongs to. (e.g. cloudbuild.googleapis.com for GCB service - accounts) - id: CloudAiPlatformTenantresourceTenantServiceAccountIdentity - type: object - description: >- - The identity of service accounts that have been explicitly created under - tenant projects. - GoogleCloudDocumentaiV1DocumentProvenance: - id: GoogleCloudDocumentaiV1DocumentProvenance + A unique id associated with this call. This id is logged for + tracking purpose. + type: string description: >- - Structure to identify provenance relationships between annotations in - different revisions. + Additional information returned to client, such as debugging + information. + type: object + id: GoogleCloudContentwarehouseV1ResponseMetadata + GoogleCloudContentwarehouseV1TimestampValue: + type: object + id: GoogleCloudContentwarehouseV1TimestampValue properties: - id: - deprecated: true + textValue: + type: string + description: >- + The string must represent a valid instant in UTC and is parsed using + java.time.format.DateTimeFormatter.ISO_INSTANT. e.g. + "2013-09-29T18:46:19Z" + timestampValue: + type: string + description: Timestamp value + format: google-datetime + description: Timestamp value type. + GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo: + description: Font and other text style attributes. + type: object + id: GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo + properties: + fontWeight: + description: >- + TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). + Normal is `400`, bold is `700`. type: integer format: int32 + letterSpacing: + description: Letter spacing in points. + type: number + format: double + italic: + type: boolean + description: Whether the text is italic. + subscript: + description: Whether the text is a subscript. This feature is not supported yet. + type: boolean + bold: description: >- - The Id of this operation. Needs to be unique within the scope of the - revision. - type: - enumDeprecated: - - false - - false - - false - - false - - false - - true - - true - - true + Whether the text is bold (equivalent to font_weight is at least + `700`). + type: boolean + fontSize: + format: int32 + type: integer + description: Font size in points (`1` point is `¹⁄₇₂` inches). + textColor: + $ref: '#/components/schemas/GoogleTypeColor' + description: Color of the text. + fontType: type: string + description: Name or style of the font. + pixelFontSize: + description: >- + Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ + `72.0`. + type: number + format: double + smallcaps: + type: boolean + description: >- + Whether the text is in small caps. This feature is not supported + yet. + backgroundColor: + $ref: '#/components/schemas/GoogleTypeColor' + description: Color of the background. + strikeout: + description: >- + Whether the text is strikethrough. This feature is not supported + yet. + type: boolean + handwritten: + type: boolean + description: Whether the text is handwritten. + superscript: + description: >- + Whether the text is a superscript. This feature is not supported + yet. + type: boolean + underlined: + type: boolean + description: Whether the text is underlined. + GoogleCloudDocumentaiV1DocumentProvenance: + type: object + properties: + type: enum: - OPERATION_TYPE_UNSPECIFIED - ADD @@ -1032,7 +1159,6 @@ components: - EVAL_REQUESTED - EVAL_APPROVED - EVAL_SKIPPED - description: The type of provenance operation. enumDescriptions: - >- Operation type unspecified. If no operation is specified a @@ -1052,299 +1178,298 @@ components: Deprecated. Element is reviewed and approved at human review, confidence will be set to 1.0. - Deprecated. Element is skipped in the validation process. - revision: - description: The index of the revision that produced this element. - deprecated: true - format: int32 - type: integer + type: string + enumDeprecated: + - false + - false + - false + - false + - false + - true + - true + - true + description: The type of provenance operation. parents: - description: References to the original elements that are replaced. items: $ref: >- #/components/schemas/GoogleCloudDocumentaiV1DocumentProvenanceParent + description: References to the original elements that are replaced. type: array - type: object - GoogleCloudContentwarehouseV1CreateDocumentResponse: - description: Response message for DocumentService.CreateDocument. - properties: - longRunningOperations: - items: - $ref: '#/components/schemas/GoogleLongrunningOperation' - type: array - description: post-processing LROs - ruleEngineOutput: + revision: + description: The index of the revision that produced this element. + type: integer + deprecated: true + format: int32 + id: + deprecated: true description: >- - Output from Rule Engine recording the rule evaluator and action - executor's output. Refer format in: - google/cloud/contentwarehouse/v1/rule_engine.proto - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleEngineOutput' - document: - description: Document created after executing create request. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' - metadata: - description: >- - Additional information for the API invocation, such as the request - tracking id. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ResponseMetadata' - id: GoogleCloudContentwarehouseV1CreateDocumentResponse - type: object - GoogleCloudDocumentaiV1NormalizedVertex: + The Id of this operation. Needs to be unique within the scope of the + revision. + type: integer + format: int32 + id: GoogleCloudDocumentaiV1DocumentProvenance description: >- - A vertex represents a 2D point in the image. NOTE: the normalized vertex - coordinates are relative to the original image and range from 0 to 1. - type: object - id: GoogleCloudDocumentaiV1NormalizedVertex - properties: - 'y': - format: float - type: number - description: Y coordinate (starts from the top of the image). - x: - type: number - format: float - description: X coordinate. - GoogleApiServiceconsumermanagementV1PolicyBinding: - description: Translates to IAM Policy bindings (without auditing at this level) - type: object + Structure to identify provenance relationships between annotations in + different revisions. + GoogleCloudContentwarehouseV1DocumentSchema: + description: A document schema used to define document structure. properties: - members: - type: array + description: + type: string + description: Schema description. + displayName: + type: string description: >- - Uses the same format as in IAM policy. `member` must include both a - prefix and ID. For example, `user:{emailId}`, - `serviceAccount:{emailId}`, `group:{emailId}`. + Required. Name of the schema given by the user. Must be unique per + project. + propertyDefinitions: + description: Document details. items: - type: string - role: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1PropertyDefinition + type: array + createTime: + description: Output only. The time when the document schema is created. + readOnly: true + format: google-datetime + type: string + name: description: >- - Role. (https://cloud.google.com/iam/docs/understanding-roles) For - example, `roles/viewer`, `roles/editor`, or `roles/owner`. + The resource name of the document schema. Format: + projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. + The name is ignored when creating a document schema. type: string - id: GoogleApiServiceconsumermanagementV1PolicyBinding - CloudAiPlatformTenantresourceTenantProjectConfig: - id: CloudAiPlatformTenantresourceTenantProjectConfig - properties: - folder: + updateTime: + readOnly: true + description: Output only. The time when the document schema is last updated. + format: google-datetime type: string + documentIsFolder: + type: boolean description: >- - Input/Output [Required]. The folder that holds tenant projects and - folder-level permissions will be automatically granted to all tenant - projects under the folder. Note: the valid folder format is - `folders/{folder_number}`. - billingConfig: - $ref: >- - #/components/schemas/GoogleApiServiceconsumermanagementV1BillingConfig - description: >- - Input/Output [Required]. The billing account properties to create - the tenant project. - services: + Document Type, true refers the document is a folder, otherwise it is + a typical document. + type: object + id: GoogleCloudContentwarehouseV1DocumentSchema + GoogleCloudContentwarehouseV1InvalidRule: + id: GoogleCloudContentwarehouseV1InvalidRule + type: object + description: A triggered rule that failed the validation check(s) after parsing. + properties: + rule: + description: Triggered rule. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Rule' + error: + description: Validation error on a parsed expression. + type: string + GoogleCloudContentwarehouseV1ListLinkedTargetsResponse: + type: object + properties: + documentLinks: type: array - description: >- - Input/Output [Required]. The API services that are enabled on the - tenant project during creation. items: - type: string - policyBindings: - items: - $ref: >- - #/components/schemas/GoogleApiServiceconsumermanagementV1PolicyBinding + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentLink' + description: Target document-links. + nextPageToken: + type: string description: >- - Input/Output [Required]. The policy bindings that are applied to the - tenant project during creation. At least one binding must have the - role `roles/owner` with either `user` or `group` type. - type: array - description: The identity to configure a tenant project. - type: object - GoogleCloudDocumentaiV1DocumentPageParagraph: + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + description: Response message for DocumentLinkService.ListLinkedTargets. + id: GoogleCloudContentwarehouseV1ListLinkedTargetsResponse + GoogleCloudDocumentaiV1DocumentPageBlock: + id: GoogleCloudDocumentaiV1DocumentPageBlock type: object + description: >- + A block has a set of lines (collected into paragraphs) that have a + common line-spacing and orientation. properties: provenance: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - description: The history of this annotation. deprecated: true - layout: - description: Layout for Paragraph. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: The history of this annotation. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' detectedLanguages: type: array - description: A list of detected languages together with confidence. items: $ref: >- #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - description: A collection of lines that a human would perceive as a paragraph. - id: GoogleCloudDocumentaiV1DocumentPageParagraph - GoogleTypePostalAddress: - id: GoogleTypePostalAddress + description: A list of detected languages together with confidence. + layout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: Layout for Block. + GoogleCloudContentwarehouseV1MergeFieldsOptions: + properties: + replaceRepeatedFields: + type: boolean + description: >- + When merging repeated fields, the default behavior is to append + entries from the source repeated field to the destination repeated + field. If you instead want to keep only the entries from the source + repeated field, set this flag to true. If you want to replace a + repeated field within a message field on the destination message, + you must set both replace_repeated_fields and replace_message_fields + to true, otherwise the repeated fields will be appended. + replaceMessageFields: + description: >- + When merging message fields, the default behavior is to merge the + content of two message fields together. If you instead want to use + the field from the source message to replace the corresponding field + in the destination message, set this flag to true. When this flag is + set, specified submessage fields that are missing in source will be + cleared in destination. + type: boolean + type: object + id: GoogleCloudContentwarehouseV1MergeFieldsOptions + description: Options for merging updated fields. + GoogleCloudContentwarehouseV1AccessControlAction: + id: GoogleCloudContentwarehouseV1AccessControlAction + description: >- + Represents the action responsible for access control list management + operations. type: object properties: - recipients: + operationType: + enum: + - UNKNOWN + - ADD_POLICY_BINDING + - REMOVE_POLICY_BINDING + - REPLACE_POLICY_BINDING + enumDescriptions: + - The unknown operation type. + - Adds newly given policy bindings in the existing bindings list. + - >- + Removes newly given policy bindings from the existing bindings + list. + - >- + Replaces existing policy bindings with the given policy binding + list + description: Identifies the type of operation. + type: string + policy: description: >- - Optional. The recipient at the address. This field may, under - certain circumstances, contain multiline information. For example, - it might contain "care of" information. + Represents the new policy from which bindings are added, removed or + replaced based on the type of the operation. the policy is limited + to a few 10s of KB. + $ref: '#/components/schemas/GoogleIamV1Policy' + GoogleCloudContentwarehouseV1CustomWeightsMetadata: + type: object + id: GoogleCloudContentwarehouseV1CustomWeightsMetadata + properties: + weightedSchemaProperties: items: - type: string + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1WeightedSchemaProperty + description: >- + List of schema and property name. Allows a maximum of 10 schemas to + be specified for relevance boosting. type: array - organization: - description: Optional. The name of the organization at the address. - type: string - locality: + description: To support the custom weighting across document schemas. + GoogleCloudContentwarehouseV1ProcessWithDocAiPipeline: + id: GoogleCloudContentwarehouseV1ProcessWithDocAiPipeline + properties: + processorResultsFolderPath: type: string description: >- - Optional. Generally refers to the city/town portion of the address. - Examples: US city, IT comune, UK post town. In regions of the world - where localities are not well defined or do not fit into this - structure well, leave locality empty and use address_lines. - regionCode: + The Cloud Storage folder path used to store the raw results from + processors. Format: `gs:///`. + processorInfo: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ProcessorInfo' + description: The CDW processor information. + documents: + type: array + items: + type: string description: >- - Required. CLDR region code of the country/region of the address. - This is never inferred and it is up to the user to ensure the value - is correct. See https://cldr.unicode.org/ and - https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html - for details. Example: "CH" for Switzerland. - type: string - languageCode: + The list of all the resource names of the documents to be processed. + Format: + projects/{project_number}/locations/{location}/documents/{document_id}. + exportFolderPath: description: >- - Optional. BCP-47 language code of the contents of this address (if - known). This is often the UI language of the input form or is - expected to match one of the languages used in the address' - country/region, or their transliterated equivalents. This can affect - formatting in certain countries, but is not critical to the - correctness of the data and will never affect any validation or - other non-formatting related operations. If this value is not known, - it should be omitted (rather than specifying a possibly incorrect - default). Examples: "zh-Hant", "ja", "ja-Latn", "en". - type: string - sublocality: + The Cloud Storage folder path used to store the exported documents + before being sent to CDW. Format: `gs:///`. type: string - description: >- - Optional. Sublocality of the address. For example, this can be - neighborhoods, boroughs, districts. - revision: - description: >- - The schema revision of the `PostalAddress`. This must be set to 0, - which is the latest revision. All new revisions **must** be backward - compatible with old revisions. - format: int32 - type: integer - sortingCode: + description: >- + The configuration of processing documents in Document Warehouse with + DocAi processors pipeline. + type: object + GoogleCloudContentwarehouseV1RunPipelineMetadataGcsIngestPipelineMetadata: + type: object + description: The metadata message for GcsIngest pipeline. + properties: + inputPath: + description: 'The input Cloud Storage folder in this pipeline. Format: `gs:///`.' type: string + id: >- + GoogleCloudContentwarehouseV1RunPipelineMetadataGcsIngestPipelineMetadata + GoogleCloudContentwarehouseV1SetAclResponse: + id: GoogleCloudContentwarehouseV1SetAclResponse + properties: + metadata: description: >- - Optional. Additional, country-specific, sorting code. This is not - used in most regions. Where it is used, the value is either a string - like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or - just a number alone, representing the "sector code" (Jamaica), - "delivery area indicator" (Malawi) or "post office indicator" (e.g. - Côte d'Ivoire). - postalCode: - description: >- - Optional. Postal code of the address. Not all countries use or - require postal codes to be present, but where they are used, they - may trigger additional validation with other parts of the address - (e.g. state/zip validation in the U.S.A.). + Additional information for the API invocation, such as the request + tracking id. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ResponseMetadata' + policy: + description: The policy will be attached to a resource (e.g. projecct, document). + $ref: '#/components/schemas/GoogleIamV1Policy' + description: Response message for DocumentService.SetAcl. + type: object + GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSource: + type: object + id: GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSource + properties: + name: + description: The schema name in the source. type: string - addressLines: - items: - type: string - type: array - description: >- - Unstructured address lines describing the lower levels of an - address. Because values in address_lines do not have type - information and may sometimes contain multiple values in a single - field (e.g. "Austin, TX"), it is important that the line order is - clear. The order of address lines should be "envelope order" for the - country/region of the address. In places where this can vary (e.g. - Japan), address_language is used to make it explicit (e.g. "ja" for - large-to-small ordering and "ja-Latn" or "en" for small-to-large). - This way, the most specific line of an address can be selected based - on the language. The minimum permitted structural representation of - an address consists of a region_code with all remaining information - placed in the address_lines. It would be possible to format such an - address very approximately without geocoding, but no semantic - reasoning could be made about any of the address components until it - was at least partially resolved. Creating an address only containing - a region_code and address_lines, and then geocoding is the - recommended way to handle completely unstructured addresses (as - opposed to guessing which parts of the address should be localities - or administrative areas). - administrativeArea: - description: >- - Optional. Highest administrative subdivision which is used for - postal addresses of a country or region. For example, this can be a - state, a province, an oblast, or a prefecture. Specifically, for - Spain this is the province and not the autonomous community (e.g. - "Barcelona" and not "Catalonia"). Many countries don't use an - administrative area in postal addresses. E.g. in Switzerland this - should be left unpopulated. + processorType: type: string - description: >- - Represents a postal address, e.g. for postal delivery or payments - addresses. Given a postal address, a postal service can deliver items to - a premise, P.O. Box or similar. It is not intended to model geographical - locations (roads, towns, mountains). In typical usage an address would - be created via user input or from importing existing data, depending on - the type of process. Advice on address input / editing: - Use an - internationalization-ready address widget such as - https://github.com/google/libaddressinput) - Users should not be - presented with UI elements for input or editing of fields outside - countries where that field is used. For more guidance on how to use this - schema, please see: https://support.google.com/business/answer/6397478 - GoogleCloudContentwarehouseV1PropertyFilter: + description: The Doc AI processor type name. + description: The schema source information. + GoogleCloudDocumentaiV1DocumentStyle: type: object + id: GoogleCloudDocumentaiV1DocumentStyle properties: - condition: + textAnchor: + description: Text anchor indexing into the Document.text. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' + textStyle: description: >- - The filter condition. The syntax for this expression is a subset of - SQL syntax. Supported operators are: `=`, `!=`, `<`, `<=`, `>`, - `>=`, and `~~` where the left of the operator is a property name and - the right of the operator is a number or a quoted string. You must - escape backslash (\\) and quote (\") characters. `~~` is the LIKE - operator. The right of the operator must be a string. The only - supported property data type for LIKE is text_values. It provides - semantic search functionality by parsing, stemming and doing - synonyms expansion against the input query. It matches if the - property contains semantic similar content to the query. It is not - regex matching or wildcard matching. For example, "property.company - ~~ \"google\"" will match records whose property `property.compnay` - have values like "Google Inc.", "Google LLC" or "Google Company". - Supported functions are `LOWER([property_name])` to perform a case - insensitive match and `EMPTY([property_name])` to filter on the - existence of a key. Boolean expressions (AND/OR/NOT) are supported - up to 3 levels of nesting (for example, "((A AND B AND C) OR NOT D) - AND E"), a maximum of 100 comparisons or functions are allowed in - the expression. The expression must be < 6000 bytes in length. Only - properties that are marked filterable are allowed - (PropertyDefinition.is_filterable). Property names do not need to be - prefixed by the document schema id (as is the case with histograms), - however property names will need to be prefixed by its parent - hierarchy, if any. For example: top_property_name.sub_property_name. - Sample Query: `(LOWER(driving_license)="class \"a\"" OR - EMPTY(driving_license)) AND driving_years > 10` CMEK compliant - deployment only supports: * Operators: `=`, `<`, `<=`, `>`, and - `>=`. * Boolean expressions: AND and OR. + [Text + style](https://www.w3schools.com/cssref/pr_font_font-style.asp). + Possible values are `normal`, `italic`, and `oblique`. type: string - documentSchemaName: + textDecoration: type: string description: >- - The Document schema name Document.document_schema_name. Format: - projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. - id: GoogleCloudContentwarehouseV1PropertyFilter - GoogleCloudContentwarehouseV1EnumValue: - description: Represents the string value of the enum field. - properties: - value: + [Text + decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). + Follows CSS standard. + backgroundColor: + $ref: '#/components/schemas/GoogleTypeColor' + description: Text background color. + color: + description: Text color. + $ref: '#/components/schemas/GoogleTypeColor' + fontWeight: type: string description: >- - String value of the enum field. This must match defined set of enums - in document schema using EnumTypeOptions. - type: object - id: GoogleCloudContentwarehouseV1EnumValue + [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). + Possible values are `normal`, `bold`, `bolder`, and `lighter`. + fontSize: + description: Font size. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentStyleFontSize' + fontFamily: + description: >- + Font family such as `Arial`, `Times New Roman`. + https://www.w3schools.com/cssref/pr_font_font-family.asp + type: string + description: >- + Annotation for common text style attributes. This adheres to CSS + conventions as much as possible. GoogleCloudDocumentaiV1DocumentTextChange: type: object + id: GoogleCloudDocumentaiV1DocumentTextChange properties: - changedText: - description: The text that replaces the text identified in the `text_anchor`. - type: string textAnchor: description: >- Provenance of the correction. Text anchor indexing into the @@ -1353,1478 +1478,1429 @@ components: same, the text change is inserted before that index. $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' provenance: - deprecated: true type: array - description: The history of this annotation. items: $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - id: GoogleCloudDocumentaiV1DocumentTextChange + description: The history of this annotation. + deprecated: true + changedText: + type: string + description: The text that replaces the text identified in the `text_anchor`. description: This message is used for text changes aka. OCR corrections. - GoogleCloudContentwarehouseV1DeleteDocumentRequest: + GoogleCloudDocumentaiV1DocumentStyleFontSize: + id: GoogleCloudDocumentaiV1DocumentStyleFontSize + type: object properties: - requestMetadata: + size: + format: float + description: Font size for the text. + type: number + unit: description: >- - The meta information collected about the end user, used to enforce - access control for the service. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' - description: Request message for DocumentService.DeleteDocument. - type: object - id: GoogleCloudContentwarehouseV1DeleteDocumentRequest - GoogleCloudDocumentaiV1DocumentPageTable: - type: object - id: GoogleCloudDocumentaiV1DocumentPageTable - description: A table representation similar to HTML table structure. + Unit for the font size. Follows CSS naming (such as `in`, `px`, and + `pt`). + type: string + description: Font size with unit. + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell: + id: >- + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell + description: Represents a cell in a table row. properties: - layout: - description: Layout for Table. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - headerRows: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableRow - description: Header rows of the table. + rowSpan: + description: How many rows this cell spans. + format: int32 + type: integer + blocks: type: array - detectedLanguages: - description: A list of detected languages together with confidence. + description: >- + A table cell is a list of blocks. Repeated blocks support further + hierarchies and nested blocks. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - type: array - provenance: - description: The history of this table. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - deprecated: true - bodyRows: - description: Body rows of the table. + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + colSpan: + description: How many columns this cell spans. + format: int32 + type: integer + type: object + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock: + properties: + listEntries: type: array + description: List entries that constitute a list block. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableRow - GoogleCloudDocumentaiV1DocumentEntityRelation: - type: object - description: Relationship between Entities. - id: GoogleCloudDocumentaiV1DocumentEntityRelation - properties: - relation: - type: string - description: Relationship description. - subjectId: - description: Subject entity id. - type: string - objectId: - description: Object entity id. + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry + type: + description: >- + Type of the list_entries (if exist). Available options are `ordered` + and `unordered`. type: string - GoogleCloudContentwarehouseV1DocumentReference: - id: GoogleCloudContentwarehouseV1DocumentReference type: object - properties: - documentIsRetentionFolder: - description: Document is a folder with retention policy. - type: boolean - createTime: - description: Output only. The time when the document is created. - format: google-datetime - readOnly: true - type: string - snippet: - type: string - description: >- - Stores the subset of the referenced document's content. This is - useful to allow user peek the information of the referenced - document. - deleteTime: - description: Output only. The time when the document is deleted. - readOnly: true - format: google-datetime - type: string - displayName: + description: Represents a list type block. + id: >- + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock + GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak: + properties: + type: + enum: + - TYPE_UNSPECIFIED + - SPACE + - WIDE_SPACE + - HYPHEN + description: Detected break type. + enumDescriptions: + - Unspecified break type. + - A single whitespace. + - A wider whitespace. + - A hyphen that indicates that a token has been split across lines. type: string + description: Detected break at the end of a Token. + id: GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak + type: object + GoogleCloudContentwarehouseV1DateTimeTypeOptions: + id: GoogleCloudContentwarehouseV1DateTimeTypeOptions + description: Configurations for a date time property. + properties: {} + type: object + GoogleCloudContentwarehouseV1FetchAclRequest: + description: Request message for DocumentService.FetchAcl + type: object + properties: + projectOwner: description: >- - display_name of the referenced document; this name does not need to - be consistent to the display_name in the Document proto, depending - on the ACL constraint. - documentName: - description: Required. Name of the referenced document. - type: string - documentIsLegalHoldFolder: - type: boolean - description: Document is a folder with legal hold. - updateTime: - type: string - format: google-datetime - description: Output only. The time when the document is last updated. - readOnly: true - documentIsFolder: - description: The document type of the document being referenced. + For Get Project ACL only. Authorization check for end user will be + ignored when project_owner=true. type: boolean - description: References to the documents. - GoogleCloudContentwarehouseV1SearchDocumentsRequest: - id: GoogleCloudContentwarehouseV1SearchDocumentsRequest - properties: requestMetadata: - description: >- - The meta information collected about the end user, used to enforce - access control and improve the search quality of the service. $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' - totalResultSize: - type: string - enum: - - TOTAL_RESULT_SIZE_UNSPECIFIED - - ESTIMATED_SIZE - - ACTUAL_SIZE - enumDescriptions: - - Total number calculation will be skipped. - - >- - Estimate total number. The total result size will be accurated up - to 10,000. This option will add cost and latency to your request. - - It may adversely impact performance. The limit is 1000,000. description: >- - Controls if the search document request requires the return of a - total size of matched documents. See - SearchDocumentsResponse.total_size. - offset: + The meta information collected about the end user, used to enforce + access control for the service. + id: GoogleCloudContentwarehouseV1FetchAclRequest + GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan: + properties: + pageEnd: format: int32 - description: >- - An integer that specifies the current offset (that is, starting - result location, amongst the documents deemed by the API as - relevant) in search results. This field is only considered if - page_token is unset. The maximum allowed value is 5000. Otherwise an - error is thrown. For example, 0 means to return results starting - from the first matching document, and 10 means to return from the - 11th document. This can be used for pagination, (for example, - pageSize = 10 and offset = 10 means to return from the second page). - type: integer - histogramQueries: - description: >- - An expression specifying a histogram request against matching - documents. Expression syntax is an aggregation function call with - histogram facets and other options. The following aggregation - functions are supported: * `count(string_histogram_facet)`: Count - the number of matching entities for each distinct attribute value. - Data types: * Histogram facet (aka filterable properties): Facet - names with format .. Facets will have the format - of: `a-zA-Z`. If the facet is a child facet, then the parent - hierarchy needs to be specified separated by dots in the prefix - after the schema id. Thus, the format for a multi- level facet is: - .. . Example: - schema123.root_parent_facet.middle_facet.child_facet * - DocumentSchemaId: (with no schema id prefix) to get histograms for - each document type (returns the schema id path, e.g. - projects/12345/locations/us-west/documentSchemas/abc123). Example - expression: * Document type counts: count('DocumentSchemaId') * For - schema id, abc123, get the counts for MORTGAGE_TYPE: - count('abc123.MORTGAGE_TYPE') - type: array - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1HistogramQuery' - pageSize: + description: Page where chunk ends in the document. type: integer - format: int32 - description: >- - A limit on the number of documents returned in the search results. - Increasing this value above the default value of 10 can increase - search response time. The value can be between 1 and 100. - qaSizeLimit: + pageStart: type: integer + description: Page where chunk starts in the document. format: int32 - description: >- - Experimental, do not use. The limit on the number of documents - returned for the question-answering feature. To enable the - question-answering feature, set [DocumentQuery].is_nl_query to true. - pageToken: - type: string - description: >- - The token specifying the current offset within search results. See - SearchDocumentsResponse.next_page_token for an explanation of how to - obtain the next set of query results. - orderBy: - type: string - description: >- - The criteria determining how search results are sorted. For - non-empty query, default is `"relevance desc"`. For empty query, - default is `"upload_date desc"`. Supported options are: * - `"relevance desc"`: By relevance descending, as determined by the - API algorithms. * `"upload_date desc"`: By upload date descending. * - `"upload_date"`: By upload date ascending. * `"update_date desc"`: - By last updated date descending. * `"update_date"`: By last updated - date ascending. * `"retrieval_importance desc"`: By retrieval - importance of properties descending. This feature is still under - development, please do not use unless otherwise instructed to do so. - requireTotalSize: - type: boolean - description: >- - Controls if the search document request requires the return of a - total size of matched documents. See - SearchDocumentsResponse.total_size. Enabling this flag may adversely - impact performance. Hint: If this is used with pagination, set this - flag on the initial query but set this to false on subsequent page - calls (keep the total count locally). Defaults to false. - documentQuery: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentQuery' - description: Query used to search against documents (keyword, filters, etc.). - type: object - description: Request message for DocumentService.SearchDocuments. - GoogleCloudContentwarehouseV1DataUpdateAction: - id: GoogleCloudContentwarehouseV1DataUpdateAction - description: Represents the action responsible for properties update operations. type: object - properties: - entries: - additionalProperties: - type: string - description: >- - Map of (K, V) -> (valid name of the field, new value of the field) - E.g., ("age", "60") entry triggers update of field age with a value - of 60. If the field is not present then new entry is added. During - update action execution, value strings will be casted to appropriate - types. - type: object + description: Represents where the chunk starts and ends in the document. + id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan GoogleCloudContentwarehouseV1SynonymSetSynonym: properties: words: - description: 'For example: sale, invoice, bill, order' - type: array items: type: string - id: GoogleCloudContentwarehouseV1SynonymSetSynonym + description: 'For example: sale, invoice, bill, order' + type: array description: >- Represents a list of words given by the customer All these words are synonyms of each other. type: object - GoogleCloudDocumentaiV1DocumentPageVisualElement: - id: GoogleCloudDocumentaiV1DocumentPageVisualElement - type: object + id: GoogleCloudContentwarehouseV1SynonymSetSynonym + CloudAiPlatformTenantresourceCloudSqlInstanceConfig: description: >- - Detected non-text visual elements e.g. checkbox, signature etc. on the - page. + The identity to configure a CloudSQL instance provisioned via SLM + Terraform. properties: - layout: - description: Layout for VisualElement. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - detectedLanguages: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - description: A list of detected languages together with confidence. + mdbRolesForCorpAccess: + description: Input [Optional]. MDB roles for corp access to CloudSQL instance. type: array - type: + items: + type: string + cloudSqlInstanceName: type: string - description: Type of the VisualElement. - GoogleCloudContentwarehouseV1Action: + description: >- + Input/Output [Optional]. The CloudSQL instance name within SLM + instance. If not set, a random UUIC will be generated as instance + name. + slmInstanceName: + description: Output only. The SLM instance's full resource name. + type: string + slmInstanceTemplate: + type: string + description: Input [Required]. The SLM instance template to provision CloudSQL. + slmInstanceType: + type: string + description: Input [Required]. The SLM instance type to provision CloudSQL. + kmsKeyReference: + type: string + description: >- + Input [Optional]. The KMS key name or the KMS grant name used for + CMEK encryption. Only set this field when provisioning new CloudSQL + instances. For existing CloudSQL instances, this field will be + ignored because CMEK re-encryption is not supported. + cloudSqlInstanceConnectionName: + type: string + description: Output only. The CloudSQL instance connection name. + id: CloudAiPlatformTenantresourceCloudSqlInstanceConfig type: object - id: GoogleCloudContentwarehouseV1Action + GoogleCloudContentwarehouseV1TimeFilter: + type: object + id: GoogleCloudContentwarehouseV1TimeFilter properties: - addToFolder: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1AddToFolderAction' - description: Action triggering create document link operation. - actionId: - type: string - description: ID of the action. Managed internally. - dataValidation: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1DataValidationAction - description: Action triggering data validation operations. - dataUpdate: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DataUpdateAction' - description: Action triggering data update operations. - accessControl: - description: Action triggering access control operations. - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1AccessControlAction - publishToPubSub: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1PublishAction' - description: Action publish to Pub/Sub operation. - removeFromFolderAction: - description: Action removing a document from a folder. + timeRange: + $ref: '#/components/schemas/GoogleTypeInterval' + timeField: + enum: + - TIME_FIELD_UNSPECIFIED + - CREATE_TIME + - UPDATE_TIME + - DISPOSITION_TIME + description: >- + Specifies which time field to filter documents on. Defaults to + TimeField.UPLOAD_TIME. + enumDescriptions: + - Default value. + - Earliest document create time. + - Latest document update time. + - Time when document becomes mutable again. + type: string + description: Filter on create timestamp or update timestamp of documents. + GoogleCloudContentwarehouseV1RuleEngineOutput: + properties: + ruleEvaluatorOutput: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1RemoveFromFolderAction - deleteDocumentAction: + #/components/schemas/GoogleCloudContentwarehouseV1RuleEvaluatorOutput + description: >- + Output from Rule Evaluator containing matched, unmatched and invalid + rules. + actionExecutorOutput: + description: >- + Output from Action Executor containing rule and corresponding + actions execution result. $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1DeleteDocumentAction - description: Action deleting the document. - description: Represents the action triggered by Rule Engine when the rule is true. - GoogleCloudDocumentaiV1Vertex: - id: GoogleCloudDocumentaiV1Vertex - properties: - x: - format: int32 - description: X coordinate. - type: integer - 'y': - type: integer - description: Y coordinate (starts from the top of the image). - format: int32 + #/components/schemas/GoogleCloudContentwarehouseV1ActionExecutorOutput + documentName: + type: string + description: >- + Name of the document against which the rules and actions were + evaluated. description: >- - A vertex represents a 2D point in the image. NOTE: the vertex - coordinates are in the same scale as the original image. + Records the output of Rule Engine including rule evaluation and actions + result. type: object - GoogleCloudDocumentaiV1DocumentPageDimension: + id: GoogleCloudContentwarehouseV1RuleEngineOutput + GoogleCloudContentwarehouseV1ListLinkedTargetsRequest: + description: Request message for DocumentLinkService.ListLinkedTargets. properties: - width: - description: Page width. - type: number - format: float - height: - type: number - description: Page height. - format: float - unit: - type: string - description: Dimension unit. - id: GoogleCloudDocumentaiV1DocumentPageDimension - description: Dimension for the page. + requestMetadata: + description: >- + The meta information collected about the document creator, used to + enforce access control for the service. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' type: object - GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo: - id: GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo - description: Font and other text style attributes. + id: GoogleCloudContentwarehouseV1ListLinkedTargetsRequest + GoogleCloudContentwarehouseV1DataValidationAction: + description: Represents the action responsible for data validation operations. type: object + id: GoogleCloudContentwarehouseV1DataValidationAction properties: - fontSize: - description: Font size in points (`1` point is `¹⁄₇₂` inches). - type: integer - format: int32 - bold: - description: >- - Whether the text is bold (equivalent to font_weight is at least - `700`). - type: boolean - subscript: - description: Whether the text is a subscript. This feature is not supported yet. - type: boolean - handwritten: - description: Whether the text is handwritten. - type: boolean - italic: - description: Whether the text is italic. - type: boolean - strikeout: - type: boolean + conditions: + additionalProperties: + type: string + type: object description: >- - Whether the text is strikethrough. This feature is not supported - yet. - backgroundColor: - description: Color of the background. - $ref: '#/components/schemas/GoogleTypeColor' - fontWeight: - type: integer + Map of (K, V) -> (field, string condition to be evaluated on the + field) E.g., ("age", "age > 18 && age < 60") entry triggers + validation of field age with the given condition. Map entries will + be ANDed during validation. + GoogleCloudDocumentaiV1Barcode: + properties: + format: + type: string description: >- - TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). - Normal is `400`, bold is `700`. - format: int32 - underlined: - description: Whether the text is underlined. - type: boolean - superscript: + Format of a barcode. The supported formats are: - `CODE_128`: Code + 128 type. - `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - + `CODABAR`: Codabar type. - `DATA_MATRIX`: 2D Data Matrix type. - + `ITF`: ITF type. - `EAN_13`: EAN-13 type. - `EAN_8`: EAN-8 type. - + `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A type. - `UPC_E`: UPC-E + type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code type. - + `DATABAR`: GS1 DataBar code type. + rawValue: description: >- - Whether the text is a superscript. This feature is not supported - yet. - type: boolean - letterSpacing: - description: Letter spacing in points. - type: number - format: double - textColor: - $ref: '#/components/schemas/GoogleTypeColor' - description: Color of the text. - fontType: - description: Name or style of the font. + Raw value encoded in the barcode. For example: + `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`. + type: string + valueFormat: type: string - smallcaps: - type: boolean - description: >- - Whether the text is in small caps. This feature is not supported - yet. - pixelFontSize: - format: double - type: number description: >- - Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ - `72.0`. - GoogleCloudContentwarehouseV1TextTypeOptions: - properties: {} - id: GoogleCloudContentwarehouseV1TextTypeOptions - description: Configurations for a text property. - type: object - GoogleCloudContentwarehouseV1EnumArray: - description: Enum values. + Value format describes the format of the value that a barcode + encodes. The supported formats are: - `CONTACT_INFO`: Contact + information. - `EMAIL`: Email address. - `ISBN`: ISBN identifier. - + `PHONE`: Phone number. - `PRODUCT`: Product. - `SMS`: SMS message. - + `TEXT`: Text string. - `URL`: URL address. - `WIFI`: Wifi + information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`: Calendar + event. - `DRIVER_LICENSE`: Driver's license. type: object - id: GoogleCloudContentwarehouseV1EnumArray + description: Encodes the detailed information of a barcode. + id: GoogleCloudDocumentaiV1Barcode + GoogleCloudContentwarehouseV1ListLinkedSourcesResponse: properties: - values: + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + documentLinks: + description: Source document-links. items: - type: string + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentLink' type: array - description: List of enum values. - GoogleCloudDocumentaiV1DocumentPageAnchorPageRef: + id: GoogleCloudContentwarehouseV1ListLinkedSourcesResponse + description: Response message for DocumentLinkService.ListLinkedSources. + type: object + GoogleTypeExpr: + id: GoogleTypeExpr + type: object + 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: - boundingPoly: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1BoundingPoly' - description: >- - Optional. Identifies the bounding polygon of a layout element on the - page. If `layout_type` is set, the bounding polygon must be exactly - the same to the layout element it's referring to. - layoutId: - deprecated: true - description: Optional. Deprecated. Use PageRef.bounding_poly instead. + expression: type: string - confidence: - format: float - type: number description: >- - Optional. Confidence of detected page element, if applicable. Range - `[0, 1]`. - layoutType: + Textual representation of an expression in Common Expression + Language syntax. + location: + type: string description: >- - Optional. The type of the layout element that is being referenced if - any. - enum: - - LAYOUT_TYPE_UNSPECIFIED - - BLOCK - - PARAGRAPH - - LINE - - TOKEN - - VISUAL_ELEMENT - - TABLE - - FORM_FIELD + Optional. String indicating the location of the expression for error + reporting, e.g. a file name and a position in the file. + title: type: string - enumDescriptions: - - Layout Unspecified. - - References a Page.blocks element. - - References a Page.paragraphs element. - - References a Page.lines element. - - References a Page.tokens element. - - References a Page.visual_elements element. - - Refrrences a Page.tables element. - - References a Page.form_fields element. - page: description: >- - Required. Index into the Document.pages element, for example using - `Document.pages` to locate the related page element. This field is - skipped when its value is the default `0`. See - https://developers.google.com/protocol-buffers/docs/proto3#json. - format: int64 + 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. + description: + type: string + description: >- + Optional. Description of the expression. This is a longer text which + describes the expression, e.g. when hovered over it in a UI. + GoogleCloudDocumentaiV1DocumentPageImage: + properties: + mimeType: + type: string + description: >- + Encoding [media type (MIME + type)](https://www.iana.org/assignments/media-types/media-types.xhtml) + for the image. + content: + format: byte + description: Raw byte content of the image. type: string + height: + description: Height of the image in pixels. + format: int32 + type: integer + width: + description: Width of the image in pixels. + format: int32 + type: integer type: object - id: GoogleCloudDocumentaiV1DocumentPageAnchorPageRef - description: Represents a weak reference to a page element within a document. - GoogleCloudDocumentaiV1DocumentPageTableTableRow: - description: A row of table cells. + description: Rendered image contents for this page. + id: GoogleCloudDocumentaiV1DocumentPageImage + GoogleCloudContentwarehouseV1AddToFolderAction: type: object + id: GoogleCloudContentwarehouseV1AddToFolderAction properties: - cells: + folders: + description: >- + Names of the folder under which new document is to be added. Format: + projects/{project_number}/locations/{location}/documents/{document_id}. items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableCell + type: string type: array - description: Cells that make up this row. - id: GoogleCloudDocumentaiV1DocumentPageTableTableRow - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock: - id: >- - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock + description: Represents the action responsible for adding document under a folder. + CloudAiPlatformTenantresourceTenantProjectResource: properties: - type: + tag: + description: >- + Input/Output [Required]. The tag that uniquely identifies a tenant + project within a tenancy unit. Note: for the same tenant project + tag, all tenant manager operations should be idempotent. type: string + tenantProjectConfig: + description: The configurations of a tenant project. + $ref: >- + #/components/schemas/CloudAiPlatformTenantresourceTenantProjectConfig + cloudSqlInstances: description: >- - Type of the list_entries (if exist). Available options are `ordered` - and `unordered`. - listEntries: - description: List entries that constitute a list block. + The CloudSQL instances that are provisioned under the tenant + project. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry + #/components/schemas/CloudAiPlatformTenantresourceCloudSqlInstanceConfig type: array - type: object - description: Represents a list type block. - GoogleCloudDocumentaiV1DocumentPageFormField: - id: GoogleCloudDocumentaiV1DocumentPageFormField - properties: - provenance: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - description: The history of this annotation. - valueType: - type: string + infraSpannerConfigs: + type: array + items: + $ref: >- + #/components/schemas/CloudAiPlatformTenantresourceInfraSpannerConfig description: >- - If the value is non-textual, this field represents the type. Current - valid values are: - blank (this indicates the `field_value` is - normal text) - `unfilled_checkbox` - `filled_checkbox` - valueDetectedLanguages: + The Infra Spanner databases that are provisioned under the tenant + project. Note: this is an experimental feature. + tenantServiceAccounts: + description: >- + The service account identities (or enabled API service's P4SA) that + are expclicitly created under the tenant project (before JIT + provisioning during enabled API services). items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + #/components/schemas/CloudAiPlatformTenantresourceTenantServiceAccountIdentity type: array - description: A list of detected languages for value together with confidence. - correctedValueText: + tenantProjectId: type: string + description: Output only. The tenant project ID that has been created. + iamPolicyBindings: + items: + $ref: '#/components/schemas/CloudAiPlatformTenantresourceIamPolicyBinding' + type: array description: >- - Created for Labeling UI to export value text. If corrections were - made to the text identified by the `field_value.text_anchor`, this - field will contain the correction. - nameDetectedLanguages: + The dynamic IAM bindings that are granted under the tenant project. + Note: this should only add new bindings to the project if they don't + exist and the existing bindings won't be affected. + gcsBuckets: + description: The GCS buckets that are provisioned under the tenant project. type: array - description: A list of detected languages for name together with confidence. items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - fieldValue: - description: Layout for the FormField value. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - correctedKeyText: - description: >- - Created for Labeling UI to export key text. If corrections were made - to the text identified by the `field_name.text_anchor`, this field - will contain the correction. + $ref: '#/components/schemas/CloudAiPlatformTenantresourceGcsBucketConfig' + tenantProjectNumber: type: string - fieldName: - description: >- - Layout for the FormField name. e.g. `Address`, `Email`, `Grand - total`, `Phone number`, etc. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: A form field detected on the page. + format: int64 + description: Output only. The tenant project number that has been created. + description: 'The tenant project and tenant resources. Next ID: 10' type: object - GoogleIamV1Policy: + id: CloudAiPlatformTenantresourceTenantProjectResource + GoogleCloudDocumentaiV1DocumentEntity: type: object - id: GoogleIamV1Policy + id: GoogleCloudDocumentaiV1DocumentEntity description: >- - An Identity and Access Management (IAM) policy, which specifies access - controls for Google Cloud resources. A `Policy` is a collection of - `bindings`. A `binding` binds one or more `members`, or principals, to a - single `role`. Principals can be user accounts, service accounts, Google - groups, and domains (such as G Suite). A `role` is a named list of - permissions; each `role` can be an IAM predefined role or a user-created - custom role. For some types of Google Cloud resources, a `binding` can - also specify a `condition`, which is a logical expression that allows - access to a resource only if the expression evaluates to `true`. A - condition can add constraints based on attributes of the request, the - resource, or both. To learn which resources support conditions in their - IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - **JSON example:** ``` { "bindings": [ { "role": - "roles/resourcemanager.organizationAdmin", "members": [ - "user:mike@example.com", "group:admins@example.com", - "domain:google.com", - "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { - "role": "roles/resourcemanager.organizationViewer", "members": [ - "user:eve@example.com" ], "condition": { "title": "expirable access", - "description": "Does not grant access after Sep 2020", "expression": - "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": - "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - - members: - user:mike@example.com - group:admins@example.com - - domain:google.com - - serviceAccount:my-project-id@appspot.gserviceaccount.com role: - roles/resourcemanager.organizationAdmin - members: - - user:eve@example.com role: roles/resourcemanager.organizationViewer - condition: title: expirable access description: Does not grant access - after Sep 2020 expression: request.time < - timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` - For a description of IAM and its features, see the [IAM - documentation](https://cloud.google.com/iam/docs/). + An entity that could be a phrase in the text or a property that belongs + to the document. It is a known entity type, such as a person, an + organization, or location. properties: - version: - type: integer - 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 - auditConfigs: - description: Specifies cloud audit logging configuration for this policy. - items: - $ref: '#/components/schemas/GoogleIamV1AuditConfig' - type: array - etag: - format: byte + textAnchor: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' 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. + Optional. Provenance of the entity. Text anchor indexing into the + Document.text. + provenance: + description: Optional. The history of this annotation. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + mentionId: type: string - bindings: - type: array + description: Optional. Deprecated. Use `id` field instead. + redacted: + type: boolean description: >- - Associates a list of `members`, or principals, with a `role`. - Optionally, may specify a `condition` that determines how and when - the `bindings` are applied. Each of the `bindings` must contain at - least one principal. The `bindings` in a `Policy` can refer to up to - 1,500 principals; up to 250 of these principals can be Google - groups. Each occurrence of a principal counts towards these limits. - For example, if the `bindings` grant 50 different roles to - `user:alice@example.com`, and not to any other principal, then you - can add another 1,450 principals to the `bindings` in the `Policy`. + Optional. Whether the entity will be redacted for de-identification + purposes. + confidence: + format: float + type: number + description: Optional. Confidence of detected Schema entity. Range `[0, 1]`. + id: + type: string + description: >- + Optional. Canonical id. This will be a unique value in the entity + list for this document. + type: + description: Required. Entity type from a schema e.g. `Address`. + type: string + properties: items: - $ref: '#/components/schemas/GoogleIamV1Binding' - GoogleCloudDocumentaiV1DocumentPageLine: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntity' + description: >- + Optional. Entities can be nested to form a hierarchical data + structure representing the content in the document. + type: array + mentionText: + type: string + description: Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`. + pageAnchor: + description: >- + Optional. Represents the provenance of this entity wrt. the location + on the page where it was found. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageAnchor' + normalizedValue: + description: >- + Optional. Normalized entity value. Absent if the extracted value + could not be converted or the type (e.g. address) is not supported + for certain parsers. This field is also only populated for certain + supported document types. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentEntityNormalizedValue + GoogleCloudContentwarehouseV1TextArray: + properties: + values: + items: + type: string + type: array + description: List of text values. type: object - id: GoogleCloudDocumentaiV1DocumentPageLine + id: GoogleCloudContentwarehouseV1TextArray + description: String/text values. + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock: + description: Represents a table type block. properties: - detectedLanguages: + headerRows: + description: Header rows at the top of the table. type: array items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - description: A list of detected languages together with confidence. - provenance: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - description: The history of this annotation. - deprecated: true - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for Line. + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow + bodyRows: + type: array + description: Body rows containing main table content. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow + caption: + description: Table caption/title. + type: string + id: >- + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock + type: object + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock: + description: Represents a text type block. + properties: + blocks: + description: >- + A text block could further have child blocks. Repeated blocks + support further hierarchies and nested blocks. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + text: + type: string + description: Text content stored in the block. + type: + description: >- + Type of the text in the block. Available options are: `paragraph`, + `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, + `heading-5`, `header`, `footer`. + type: string + type: object + id: >- + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock + GoogleIamV1AuditConfig: + id: GoogleIamV1AuditConfig + properties: + service: + type: string + 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. + auditLogConfigs: + type: array + items: + $ref: '#/components/schemas/GoogleIamV1AuditLogConfig' + description: The configuration for logging of each type of permission. + type: object description: >- - A collection of tokens that a human would perceive as a line. Does not - cross column boundaries, can be horizontal, vertical, etc. + 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. + GoogleCloudDocumentaiV1DocumentEntityRelation: + description: Relationship between Entities. + id: GoogleCloudDocumentaiV1DocumentEntityRelation + type: object + properties: + subjectId: + type: string + description: Subject entity id. + relation: + type: string + description: Relationship description. + objectId: + description: Object entity id. + type: string GoogleCloudContentwarehouseV1beta1InitializeProjectResponse: + description: Response message for projectService.InitializeProject + id: GoogleCloudContentwarehouseV1beta1InitializeProjectResponse type: object properties: + message: + description: The message of the project initialization process. + type: string state: type: string - enumDescriptions: - - Clients should never see this. - - Finished project initialization without error. - - Finished project initialization with an error. - - Client canceled the LRO. - - Ask the customer to check the operation for results. enum: - STATE_UNSPECIFIED - SUCCEEDED - FAILED - CANCELLED - RUNNING + enumDescriptions: + - Clients should never see this. + - Finished project initialization without error. + - Finished project initialization with an error. + - Client canceled the LRO. + - Ask the customer to check the operation for results. description: The state of the project initialization process. - message: - description: The message of the project initialization process. - type: string - id: GoogleCloudContentwarehouseV1beta1InitializeProjectResponse - description: Response message for projectService.InitializeProject - GoogleCloudContentwarehouseV1SetAclRequest: - type: object - properties: - policy: - $ref: '#/components/schemas/GoogleIamV1Policy' - description: >- - Required. REQUIRED: The complete policy to be applied to the - `resource`. The size of the policy is limited to a few 10s of KB. - This refers to an Identity and Access (IAM) policy, which specifies - access controls for the Document. You can set ACL with condition for - projects only. Supported operators are: `=`, `!=`, `<`, `<=`, `>`, - and `>=` where the left of the operator is `DocumentSchemaId` or - property name and the right of the operator is a number or a quoted - string. You must escape backslash (\\) and quote (\") characters. - Boolean expressions (AND/OR) are supported up to 3 levels of nesting - (for example, "((A AND B AND C) OR D) AND E"), a maximum of 10 - comparisons are allowed in the expression. The expression must be < - 6000 bytes in length. Sample condition: `"DocumentSchemaId = \"some - schema id\" OR SchemaId.floatPropertyName >= 10"` - requestMetadata: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' - description: >- - The meta information collected about the end user, used to enforce - access control for the service. - projectOwner: - description: >- - For Set Project ACL only. Authorization check for end user will be - ignored when project_owner=true. - type: boolean - id: GoogleCloudContentwarehouseV1SetAclRequest - description: Request message for DocumentService.SetAcl. - GoogleCloudContentwarehouseV1Rule: - id: GoogleCloudContentwarehouseV1Rule - type: object + CloudAiPlatformTenantresourceIamPolicyBinding: + description: >- + The dynamic IAM bindings to be granted after tenant projects are + created. properties: - actions: - type: array - description: List of actions that are executed when the rule is satisfied. - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Action' - ruleId: + resource: type: string description: >- - ID of the rule. It has to be unique across all the examples. This is - managed internally. - condition: - type: string + Input/Output [Required]. The resource name that will be accessed by + members, which also depends on resource_type. Note: placeholders are + supported in resource names. For example, ${tpn} will be used when + the tenant project number is not ready. + members: + items: + type: string + type: array description: >- - Represents the conditional expression to be evaluated. Expression - should evaluate to a boolean result. When the condition is true - actions are executed. Example: user_role = "hsbc_role_1" AND - doc.salary > 20000 - description: - description: Short description of the rule and its context. + Input/Output [Required]. The member service accounts with the roles + above. Note: placeholders are same as the resource above. + role: + description: Input/Output [Required]. The role for members below. type: string - triggerType: + resourceType: enum: - - UNKNOWN - - ON_CREATE - - ON_UPDATE - - ON_CREATE_LINK - - ON_DELETE_LINK - type: string - description: Identifies the trigger type for running the policy. - enumDescriptions: - - Trigger for unknown action. - - Trigger for create document action. - - Trigger for update document action. - - Trigger for create link action. - - Trigger for delete link action. - description: Represents the rule for a content warehouse trigger. - GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSource: - id: GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSource - properties: - name: - type: string - description: The schema name in the source. - processorType: + - RESOURCE_TYPE_UNSPECIFIED + - PROJECT + - SERVICE_ACCOUNT + - GCS_BUCKET + - SERVICE_CONSUMER + - AR_REPO + description: >- + Input/Output [Required]. Specifies the type of resource that will be + accessed by members. + enumDescriptions: + - '' + - >- + The value of resource field is the ID or number of a project. + Format is + - >- + The value of resource field is the resource name of a service + account. Format is projects//serviceAccounts/ + - >- + The value of resource field is the name of a GCS bucket (not its + resource name). Format is . + - >- + The value of resource field is the resource name of a service + consumer. Format is services//consumers/ + - >- + The value of the resource field is the AR Image Uri which + identifies an AR REPO. Allowed formats are: /// ///: ///@ type: string - description: The Doc AI processor type name. - description: The schema source information. type: object - GoogleCloudContentwarehouseV1TextArray: + id: CloudAiPlatformTenantresourceIamPolicyBinding + GoogleCloudDocumentaiV1BoundingPoly: properties: - values: + normalizedVertices: items: - type: string - description: List of text values. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1NormalizedVertex' + type: array + description: The bounding polygon normalized vertices. + vertices: type: array + description: The bounding polygon vertices. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Vertex' type: object - description: String/text values. - id: GoogleCloudContentwarehouseV1TextArray - GoogleCloudDocumentaiV1DocumentPageImage: - id: GoogleCloudDocumentaiV1DocumentPageImage + id: GoogleCloudDocumentaiV1BoundingPoly + description: A bounding polygon for the detected image annotation. + GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect: + type: object + description: Image Quality Defects + id: GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect properties: - height: - description: Height of the image in pixels. - format: int32 - type: integer - mimeType: + confidence: description: >- - Encoding [media type (MIME - type)](https://www.iana.org/assignments/media-types/media-types.xhtml) - for the image. - type: string - content: - format: byte - description: Raw byte content of the image. + Confidence of detected defect. Range `[0, 1]` where `1` indicates + strong confidence that the defect exists. + type: number + format: float + type: type: string - width: - type: integer - description: Width of the image in pixels. - format: int32 - description: Rendered image contents for this page. - type: object - GoogleCloudContentwarehouseV1QAResultHighlight: - id: GoogleCloudContentwarehouseV1QAResultHighlight - description: >- - A text span in the search text snippet that represents a highlighted - section (answer context, highly relevant sentence, etc.). + description: >- + Name of the defect type. Supported values are: - + `quality/defect_blurry` - `quality/defect_noisy` - + `quality/defect_dark` - `quality/defect_faint` - + `quality/defect_text_too_small` - `quality/defect_document_cutoff` - + `quality/defect_text_cutoff` - `quality/defect_glare` + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan: type: object properties: - endIndex: - format: int32 + pageEnd: + description: Page where block ends in the document. type: integer - description: End index of the highlight, exclusive. - startIndex: format: int32 - description: Start index of the highlight. + pageStart: + description: Page where block starts in the document. type: integer - GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak: + format: int32 + description: Represents where the block starts and ends in the document. + id: >- + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan + GoogleCloudContentwarehouseV1TextTypeOptions: + id: GoogleCloudContentwarehouseV1TextTypeOptions + description: Configurations for a text property. type: object - id: GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak + properties: {} + GoogleProtobufEmpty: + type: object + id: GoogleProtobufEmpty + properties: {} + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + GoogleCloudContentwarehouseV1UpdateRuleSetRequest: + type: object + id: GoogleCloudContentwarehouseV1UpdateRuleSetRequest + description: Request message for RuleSetService.UpdateRuleSet. properties: - type: - type: string - enum: - - TYPE_UNSPECIFIED - - SPACE - - WIDE_SPACE - - HYPHEN - enumDescriptions: - - Unspecified break type. - - A single whitespace. - - A wider whitespace. - - A hyphen that indicates that a token has been split across lines. - description: Detected break type. - description: Detected break at the end of a Token. - GoogleCloudDocumentaiV1DocumentDocumentLayout: + ruleSet: + description: Required. The rule set to update. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleSet' + GoogleCloudContentwarehouseV1PropertyArray: + description: Property values. + id: GoogleCloudContentwarehouseV1PropertyArray properties: - blocks: + properties: + description: List of property values. items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Property' type: array - description: List of blocks in the document. - description: >- - Represents the parsed layout of a document as a collection of blocks - that the document is divided into. - id: GoogleCloudDocumentaiV1DocumentDocumentLayout type: object - GoogleCloudContentwarehouseV1UpdateDocumentResponse: - description: Response message for DocumentService.UpdateDocument. - id: GoogleCloudContentwarehouseV1UpdateDocumentResponse + GoogleIamV1Policy: + description: >- + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. A `Policy` is a collection of + `bindings`. A `binding` binds one or more `members`, or principals, to a + single `role`. Principals can be user accounts, service accounts, Google + groups, and domains (such as G Suite). A `role` is a named list of + permissions; each `role` can be an IAM predefined role or a user-created + custom role. For some types of Google Cloud resources, a `binding` can + also specify a `condition`, which is a logical expression that allows + access to a resource only if the expression evaluates to `true`. A + condition can add constraints based on attributes of the request, the + resource, or both. To learn which resources support conditions in their + IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + **JSON example:** ``` { "bindings": [ { "role": + "roles/resourcemanager.organizationAdmin", "members": [ + "user:mike@example.com", "group:admins@example.com", + "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { + "role": "roles/resourcemanager.organizationViewer", "members": [ + "user:eve@example.com" ], "condition": { "title": "expirable access", + "description": "Does not grant access after Sep 2020", "expression": + "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": + "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - + members: - user:mike@example.com - group:admins@example.com - + domain:google.com - + serviceAccount:my-project-id@appspot.gserviceaccount.com role: + roles/resourcemanager.organizationAdmin - members: - + user:eve@example.com role: roles/resourcemanager.organizationViewer + condition: title: expirable access description: Does not grant access + after Sep 2020 expression: request.time < + timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` + For a description of IAM and its features, see the [IAM + documentation](https://cloud.google.com/iam/docs/). + id: GoogleIamV1Policy type: object properties: - metadata: + bindings: + type: array description: >- - Additional information for the API invocation, such as the request - tracking id. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ResponseMetadata' - ruleEngineOutput: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleEngineOutput' + Associates a list of `members`, or principals, with a `role`. + Optionally, may specify a `condition` that determines how and when + the `bindings` are applied. Each of the `bindings` must contain at + least one principal. The `bindings` in a `Policy` can refer to up to + 1,500 principals; up to 250 of these principals can be Google + groups. Each occurrence of a principal counts towards these limits. + For example, if the `bindings` grant 50 different roles to + `user:alice@example.com`, and not to any other principal, then you + can add another 1,450 principals to the `bindings` in the `Policy`. + items: + $ref: '#/components/schemas/GoogleIamV1Binding' + version: description: >- - Output from Rule Engine recording the rule evaluator and action - executor's output. Refer format in: - google/cloud/contentwarehouse/v1/rule_engine.proto - document: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' - description: Updated document after executing update request. - GoogleTypeInterval: - id: GoogleTypeInterval - properties: - startTime: + 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). + type: integer + format: int32 + etag: description: >- - Optional. Inclusive start of the interval. If specified, a Timestamp - matching this interval will have to be the same or after the start. - format: google-datetime - type: string - endTime: + `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 + auditConfigs: + type: array + items: + $ref: '#/components/schemas/GoogleIamV1AuditConfig' + description: Specifies cloud audit logging configuration for this policy. + GoogleCloudContentwarehouseV1SynonymSet: + properties: + context: type: string - format: google-datetime description: >- - Optional. Exclusive end of the interval. If specified, a Timestamp - matching this interval will have to be before the end. - description: >- - Represents a time interval, encoded as a Timestamp start (inclusive) and - a Timestamp end (exclusive). The start must be less than or equal to the - end. When the start equals the end, the interval is empty (matches no - time). When both start and end are unspecified, the interval matches any - time. + This is a freeform field. Example contexts can be "sales," + "engineering," "real estate," "accounting," etc. The context can be + supplied during search requests. + synonyms: + description: List of Synonyms for the context. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1SynonymSetSynonym + name: + type: string + description: >- + The resource name of the SynonymSet This is mandatory for + google.api.resource. Format: + projects/{project_number}/locations/{location}/synonymSets/{context}. + id: GoogleCloudContentwarehouseV1SynonymSet type: object - GoogleCloudContentwarehouseV1FetchAclRequest: + description: >- + Represents a list of synonyms for a given context. For example a context + "sales" could contain: Synonym 1: sale, invoice, bill, order Synonym 2: + money, credit, finance, payment Synonym 3: shipping, freight, transport + Each SynonymSets should be disjoint + GoogleCloudDocumentaiV1Vertex: + description: >- + A vertex represents a 2D point in the image. NOTE: the vertex + coordinates are in the same scale as the original image. + properties: + x: + type: integer + format: int32 + description: X coordinate. + 'y': + type: integer + description: Y coordinate (starts from the top of the image). + format: int32 + id: GoogleCloudDocumentaiV1Vertex type: object + GoogleIamV1Binding: + id: GoogleIamV1Binding properties: - projectOwner: - type: boolean + role: description: >- - For Get Project ACL only. Authorization check for end user will be - ignored when project_owner=true. - requestMetadata: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' + Role that is assigned to the list of `members`, or principals. For + example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an + overview of the IAM roles and permissions, see the [IAM + documentation](https://cloud.google.com/iam/docs/roles-overview). + For a list of the available pre-defined roles, see + [here](https://cloud.google.com/iam/docs/understanding-roles). + type: string + condition: description: >- - The meta information collected about the end user, used to enforce - access control for the service. - id: GoogleCloudContentwarehouseV1FetchAclRequest - description: Request message for DocumentService.FetchAcl - GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter: + The condition that is associated with this binding. If the condition + evaluates to `true`, then this binding applies to the current + request. If the condition evaluates to `false`, then this binding + does not apply to the current request. However, a different role + binding might grant the same role to one or more of the principals + in this binding. To learn which resources support conditions in + their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + $ref: '#/components/schemas/GoogleTypeExpr' + members: + description: >- + Specifies the principals requesting access for a Google Cloud + 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. Does not include identities + that come from external identity providers (IdPs) through identity + federation. * `user:{emailid}`: An email address that represents a + specific Google account. For example, `alice@example.com` . * + `serviceAccount:{emailid}`: An email address that represents a + Google service account. For example, + `my-other-app@appspot.gserviceaccount.com`. * + `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: + An identifier for a [Kubernetes service + account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). + For example, + `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * + `group:{emailid}`: An email address that represents a Google group. + For example, `admins@example.com`. * `domain:{domain}`: The G Suite + domain (primary) that represents all the users of that domain. For + example, `google.com` or `example.com`. * + `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workforce identity pool. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: + All workforce identities in a group. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All workforce identities with a specific attribute value. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: + All identities in a workforce identity pool. * + `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workload identity pool. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: + A workload identity pool group. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All identities in a workload identity pool with a certain attribute. + * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: + All identities in a workload identity pool. * + `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. * + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + Deleted single identity in a workforce identity pool. For example, + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + items: + type: string + type: array type: object + description: Associates `members`, or principals, with a `role`. + GoogleCloudContentwarehouseV1ActionExecutorOutput: properties: - pageSpan: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan - description: Page span of the footer. - text: - type: string - description: Footer in text format. - id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter - description: Represents the page footer associated with the chunk. - GoogleCloudContentwarehouseV1InvalidRule: + ruleActionsPairs: + type: array + description: List of rule and corresponding actions result. + items: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleActionsPair' + type: object + id: GoogleCloudContentwarehouseV1ActionExecutorOutput + description: Represents the output of the Action Executor. + GoogleCloudContentwarehouseV1ListSynonymSetsResponse: properties: - rule: - description: Triggered rule. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Rule' - error: - description: Validation error on a parsed expression. + nextPageToken: type: string + description: >- + A page token, received from a previous `ListSynonymSets` call. + Provide this to retrieve the subsequent page. + synonymSets: + items: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' + type: array + description: The synonymSets from the specified parent. + id: GoogleCloudContentwarehouseV1ListSynonymSetsResponse + description: Response message for SynonymSetService.ListSynonymSets. + type: object + GoogleCloudContentwarehouseV1EnumValue: + id: GoogleCloudContentwarehouseV1EnumValue + description: Represents the string value of the enum field. type: object - description: A triggered rule that failed the validation check(s) after parsing. - id: GoogleCloudContentwarehouseV1InvalidRule - GoogleCloudContentwarehouseV1Document: properties: - rawDocumentFileType: - type: string - enum: - - RAW_DOCUMENT_FILE_TYPE_UNSPECIFIED - - RAW_DOCUMENT_FILE_TYPE_PDF - - RAW_DOCUMENT_FILE_TYPE_DOCX - - RAW_DOCUMENT_FILE_TYPE_XLSX - - RAW_DOCUMENT_FILE_TYPE_PPTX - - RAW_DOCUMENT_FILE_TYPE_TEXT - - RAW_DOCUMENT_FILE_TYPE_TIFF + value: description: >- - This is used when DocAI was not used to load the document and - parsing/ extracting is needed for the inline_raw_document. For - example, if inline_raw_document is the byte representation of a PDF - file, then this should be set to: RAW_DOCUMENT_FILE_TYPE_PDF. - enumDescriptions: - - No raw document specified or it is non-parsable - - Adobe PDF format - - Microsoft Word format - - Microsoft Excel format - - Microsoft Powerpoint format - - UTF-8 encoded text format - - TIFF or TIF image file format - legalHold: - type: boolean - readOnly: true - description: Output only. Indicates if the document has a legal hold on it. - updateTime: - readOnly: true + String value of the enum field. This must match defined set of enums + in document schema using EnumTypeOptions. type: string - description: Output only. The time when the document is last updated. + GoogleTypeInterval: + type: object + description: >- + Represents a time interval, encoded as a Timestamp start (inclusive) and + a Timestamp end (exclusive). The start must be less than or equal to the + end. When the start equals the end, the interval is empty (matches no + time). When both start and end are unspecified, the interval matches any + time. + properties: + startTime: + description: >- + Optional. Inclusive start of the interval. If specified, a Timestamp + matching this interval will have to be the same or after the start. format: google-datetime - createTime: type: string - description: Output only. The time when the document is created. - readOnly: true + endTime: format: google-datetime - properties: - description: List of values that are user supplied metadata. - type: array - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Property' - updater: - type: string - description: The user who lastly updates the document. - cloudAiDocument: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Document' - description: Document AI format to save the structured content, including OCR. - dispositionTime: - format: google-datetime - readOnly: true - description: >- - Output only. If linked to a Collection with RetentionPolicy, the - date when the document becomes mutable. - type: string - textExtractionDisabled: - type: boolean - description: If true, text extraction will not be performed. - deprecated: true - textExtractionEnabled: - description: If true, text extraction will be performed. - type: boolean - displayUri: - type: string - description: Uri to display the document, for example, in the UI. - name: type: string description: >- - The resource name of the document. Format: - projects/{project_number}/locations/{location}/documents/{document_id}. - The name is ignored when creating a document. - documentSchemaName: - type: string + Optional. Exclusive end of the interval. If specified, a Timestamp + matching this interval will have to be before the end. + id: GoogleTypeInterval + GoogleCloudContentwarehouseV1RunPipelineMetadataProcessWithDocAiPipelineMetadata: + type: object + properties: + documents: description: >- - The Document schema name. Format: - projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. - contentCategory: - enum: - - CONTENT_CATEGORY_UNSPECIFIED - - CONTENT_CATEGORY_IMAGE - - CONTENT_CATEGORY_AUDIO - - CONTENT_CATEGORY_VIDEO + The input list of all the resource names of the documents to be + processed. + items: + type: string + type: array + processorInfo: + description: The DocAI processor to process the documents with. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ProcessorInfo' + description: The metadata message for Process-with-DocAi pipeline. + id: >- + GoogleCloudContentwarehouseV1RunPipelineMetadataProcessWithDocAiPipelineMetadata + GoogleCloudDocumentaiV1DocumentPageLayout: + type: object + id: GoogleCloudDocumentaiV1DocumentPageLayout + description: Visual element describing a layout unit on a page. + properties: + textAnchor: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' + description: Text anchor indexing into the Document.text. + boundingPoly: + description: The bounding polygon for the Layout. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1BoundingPoly' + orientation: enumDescriptions: - - No category is specified. - - Content is of image type. - - Content is of audio type. - - Content is of video type. + - Unspecified orientation. + - Orientation is aligned with page up. + - >- + Orientation is aligned with page right. Turn the head 90 degrees + clockwise from upright to read. + - >- + Orientation is aligned with page down. Turn the head 180 degrees + from upright to read. + - >- + Orientation is aligned with page left. Turn the head 90 degrees + counterclockwise from upright to read. type: string + enum: + - ORIENTATION_UNSPECIFIED + - PAGE_UP + - PAGE_RIGHT + - PAGE_DOWN + - PAGE_LEFT + description: Detected orientation for the Layout. + confidence: + format: float + type: number description: >- - Indicates the category (image, audio, video etc.) of the original - content. - creator: - description: The user who creates the document. - type: string - title: + Confidence of the current Layout within context of the object this + layout is for. e.g. confidence can be for a single token, a table, a + visual element, etc. depending on context. Range `[0, 1]`. + GoogleCloudContentwarehouseV1SearchDocumentsResponse: + properties: + matchingDocuments: description: >- - Title that describes the document. This can be the top heading or - text that describes the document. - type: string - displayName: - type: string + The document entities that match the specified + SearchDocumentsRequest. + items: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1SearchDocumentsResponseMatchingDocument + type: array + metadata: description: >- - Required. Display name of the document given by the user. This name - will be displayed in the UI. Customer can populate this field with - the name of the document. This differs from the 'title' field as - 'title' is optional and stores the top heading in the document. - referenceId: - type: string + Additional information for the API invocation, such as the request + tracking id. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ResponseMetadata' + totalSize: + type: integer description: >- - The reference ID set by customers. Must be unique per project and - location. - rawDocumentPath: - description: Raw document file in Cloud Storage path. - type: string - inlineRawDocument: + The total number of matched documents which is available only if the + client set SearchDocumentsRequest.require_total_size to `true` or + set SearchDocumentsRequest.total_result_size to `ESTIMATED_SIZE` or + `ACTUAL_SIZE`. Otherwise, the value will be `-1`. Typically a UI + would handle this condition by displaying "of many", for example: + "Displaying 10 of many". + format: int32 + questionAnswer: type: string - description: Raw document content. - format: byte - plainText: + description: Experimental. Question answer from the query against the document. + nextPageToken: type: string - description: Other document format, such as PPTX, XLXS + description: >- + The token that specifies the starting position of the next page of + results. This field is empty if there are no more results. + histogramQueryResults: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1HistogramQueryResult + description: >- + The histogram results that match with the specified + SearchDocumentsRequest.histogram_queries. + description: Response message for DocumentService.SearchDocuments. type: object - description: Defines the structure for content warehouse document proto. - id: GoogleCloudContentwarehouseV1Document - GoogleCloudContentwarehouseV1TimestampValue: - description: Timestamp value type. - id: GoogleCloudContentwarehouseV1TimestampValue + id: GoogleCloudContentwarehouseV1SearchDocumentsResponse + GoogleCloudDocumentaiV1DocumentPageTableTableCell: + id: GoogleCloudDocumentaiV1DocumentPageTableTableCell + description: A cell representation inside the table. properties: - textValue: - description: >- - The string must represent a valid instant in UTC and is parsed using - java.time.format.DateTimeFormatter.ISO_INSTANT. e.g. - "2013-09-29T18:46:19Z" - type: string - timestampValue: - format: google-datetime - type: string - description: Timestamp value + layout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: Layout for TableCell. + colSpan: + type: integer + description: How many columns this cell spans. + format: int32 + detectedLanguages: + description: A list of detected languages together with confidence. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + type: array + rowSpan: + format: int32 + description: How many rows this cell spans. + type: integer type: object - GoogleCloudContentwarehouseV1ProjectStatus: + GoogleCloudDocumentaiV1NormalizedVertex: type: object - id: GoogleCloudContentwarehouseV1ProjectStatus properties: - state: + x: + type: number + format: float + description: X coordinate. + 'y': + format: float + description: Y coordinate (starts from the top of the image). + type: number + description: >- + A vertex represents a 2D point in the image. NOTE: the normalized vertex + coordinates are relative to the original image and range from 0 to 1. + id: GoogleCloudDocumentaiV1NormalizedVertex + GoogleCloudContentwarehouseV1CreateDocumentResponse: + type: object + properties: + metadata: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ResponseMetadata' + description: >- + Additional information for the API invocation, such as the request + tracking id. + document: + description: Document created after executing create request. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' + ruleEngineOutput: + description: >- + Output from Rule Engine recording the rule evaluator and action + executor's output. Refer format in: + google/cloud/contentwarehouse/v1/rule_engine.proto + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleEngineOutput' + longRunningOperations: + type: array + items: + $ref: '#/components/schemas/GoogleLongrunningOperation' + description: post-processing LROs + description: Response message for DocumentService.CreateDocument. + id: GoogleCloudContentwarehouseV1CreateDocumentResponse + GoogleCloudContentwarehouseV1CreateDocumentRequest: + id: GoogleCloudContentwarehouseV1CreateDocumentRequest + properties: + cloudAiDocumentOption: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1CloudAIDocumentOption + description: >- + Request Option for processing Cloud AI Document in Document + Warehouse. This field offers limited support for mapping entities + from Cloud AI Document to Warehouse Document. Please consult with + product team before using this field and other available options. + createMask: + description: >- + Field mask for creating Document fields. If mask path is empty, it + means all fields are masked. For the `FieldMask` definition, see + https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask. type: string - enum: - - PROJECT_STATE_UNSPECIFIED - - PROJECT_STATE_PENDING - - PROJECT_STATE_COMPLETED - - PROJECT_STATE_FAILED - - PROJECT_STATE_DELETING - - PROJECT_STATE_DELETING_FAILED - - PROJECT_STATE_DELETED - - PROJECT_STATE_NOT_FOUND - enumDescriptions: - - Default status, required by protobuf best practices. - - The project is in the middle of a provision process. - - All dependencies have been provisioned. - - A provision process was previously initiated, but failed. - - The project is in the middle of a deletion process. - - A deleting process was initiated, but failed. - - The project is deleted. - - The project is not found. - description: State of the project. - accessControlMode: - type: string - description: Access control mode. - enum: - - ACL_MODE_UNKNOWN - - ACL_MODE_UNIVERSAL_ACCESS - - ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_BYOID - - ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_GCI - enumDescriptions: - - This value is required by protobuf best practices - - 'Universal Access: No document level access control.' - - Document level access control with customer own Identity Service. - - Document level access control using Google Cloud Identity. - location: - description: The location of the queried project. - type: string - databaseType: - type: string - description: Database type. - enumDescriptions: - - This value is required by protobuf best practices - - Internal Spanner - - Cloud Sql with a Postgres Sql instance - enum: - - DB_UNKNOWN - - DB_INFRA_SPANNER - - DB_CLOUD_SQL_POSTGRES - enumDeprecated: - - false - - false - - true - qaEnabled: - description: If the qa is enabled on this project. - type: boolean - documentCreatorDefaultRole: - description: The default role for the person who create a document. - type: string - description: >- - Status of a project, including the project state, dbType, aclMode and - etc. - GoogleRpcStatus: - properties: - details: - type: array - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - items: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - code: - type: integer - format: int32 - description: The status code, which should be an enum value of google.rpc.Code. - message: - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - type: string - type: object - id: GoogleRpcStatus - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - GoogleApiServiceconsumermanagementV1BillingConfig: - type: object - id: GoogleApiServiceconsumermanagementV1BillingConfig - description: Describes the billing configuration for a new tenant project. - properties: - billingAccount: + format: google-fieldmask + policy: description: >- - Name of the billing account. For example - `billingAccounts/012345-567890-ABCDEF`. - type: string - GoogleCloudContentwarehouseV1IntegerArray: - type: object - description: Integer values. - properties: - values: - items: - type: integer - format: int32 - type: array - description: List of integer values. - id: GoogleCloudContentwarehouseV1IntegerArray - GoogleCloudContentwarehouseV1DateTimeTypeOptions: - description: Configurations for a date time property. - id: GoogleCloudContentwarehouseV1DateTimeTypeOptions - type: object - properties: {} - GoogleCloudContentwarehouseV1DeleteDocumentLinkRequest: - type: object - properties: + Default document policy during creation. This refers to an Identity + and Access (IAM) policy, which specifies access controls for the + Document. Conditions defined in the policy will be ignored. + $ref: '#/components/schemas/GoogleIamV1Policy' requestMetadata: description: >- - The meta information collected about the document creator, used to - enforce access control for the service. + The meta information collected about the end user, used to enforce + access control for the service. $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' - id: GoogleCloudContentwarehouseV1DeleteDocumentLinkRequest - description: Request message for DocumentLinkService.DeleteDocumentLink. - GoogleCloudContentwarehouseV1RequestMetadata: - id: GoogleCloudContentwarehouseV1RequestMetadata + document: + description: Required. The document to create. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' type: object + description: Request message for DocumentService.CreateDocument. + GoogleCloudContentwarehouseV1EnumArray: properties: - userInfo: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1UserInfo' - description: Provides user unique identification and groups information. - description: Meta information is used to improve the performance of the service. - GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect: + values: + description: List of enum values. + type: array + items: + type: string type: object - id: GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect + description: Enum values. + id: GoogleCloudContentwarehouseV1EnumArray + CloudAiPlatformTenantresourceInfraSpannerConfigCreateDatabaseOptions: properties: - type: + cmekCloudResourceType: type: string description: >- - Name of the defect type. Supported values are: - - `quality/defect_blurry` - `quality/defect_noisy` - - `quality/defect_dark` - `quality/defect_faint` - - `quality/defect_text_too_small` - `quality/defect_document_cutoff` - - `quality/defect_text_cutoff` - `quality/defect_glare` - confidence: - type: number - description: >- - Confidence of detected defect. Range `[0, 1]` where `1` indicates - strong confidence that the defect exists. - format: float - description: Image Quality Defects - GoogleCloudContentwarehouseV1GetDocumentRequest: - properties: - requestMetadata: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' - description: >- - The meta information collected about the end user, used to enforce - access control for the service. - type: object - id: GoogleCloudContentwarehouseV1GetDocumentRequest - description: Request message for DocumentService.GetDocument. - GoogleTypeDate: - description: >- - Represents a whole or partial calendar date, such as a birthday. The - time of day and time zone are either specified elsewhere or are - insignificant. The date is relative to the Gregorian Calendar. This can - represent one of the following: * A full date, with non-zero year, - month, and day values. * A month and day, with a zero year (for example, - an anniversary). * A year on its own, with a zero month and a zero day. - * A year and month, with a zero day (for example, a credit card - expiration date). Related types: * google.type.TimeOfDay * - google.type.DateTime * google.protobuf.Timestamp - type: object - properties: - month: - type: integer - description: >- - Month of a year. Must be from 1 to 12, or 0 to specify a year - without a month and day. - format: int32 - year: - description: >- - Year of the date. Must be from 1 to 9999, or 0 to specify a date - without a year. - format: int32 - type: integer - day: - format: int32 + The cloud resource type for the CMEK encryption. For example, + contentwarehouse.googleapis.com/Location + cmekServiceName: description: >- - Day of a month. Must be from 1 to 31 and valid for the year and - month, or 0 to specify a year by itself or a year and month where - the day isn't significant. - type: integer - id: GoogleTypeDate - GoogleCloudDocumentaiV1DocumentShardInfo: - type: object - id: GoogleCloudDocumentaiV1DocumentShardInfo - properties: - shardIndex: - format: int64 - type: string - description: The 0-based index of this shard. - shardCount: - type: string - description: Total number of shards. - format: int64 - textOffset: + The service name for the CMEK encryption. For example, + contentwarehouse.googleapis.com type: string + cmekCloudResourceName: description: >- - The index of the first character in Document.text in the overall - document global text. - format: int64 + The cloud resource name for the CMEK encryption. For example, + projects//locations/ + type: string description: >- - For a large document, sharding may be performed to produce several - document shards. Each document shard contains this field to detail which - shard it is. - GoogleCloudContentwarehouseV1ListLinkedTargetsResponse: + The options to create a spanner database. KMS key access audit logging + and AxT logging will be associated with the given resource name, + resource type and service name. Please ensure to give right options to + enable correct audit logging and AxT logging. + id: CloudAiPlatformTenantresourceInfraSpannerConfigCreateDatabaseOptions type: object - description: Response message for DocumentLinkService.ListLinkedTargets. - id: GoogleCloudContentwarehouseV1ListLinkedTargetsResponse + GoogleCloudContentwarehouseV1DocumentQuery: properties: - documentLinks: + documentNameFilter: type: array - description: Target document-links. + description: >- + Search the documents in the list. Format: + projects/{project_number}/locations/{location}/documents/{document_id}. items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentLink' - nextPageToken: + type: string + folderNameFilter: description: >- - A token, which can be sent as `page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. - type: string - GoogleCloudContentwarehouseV1FileTypeFilter: - type: object - properties: - fileType: - enum: - - FILE_TYPE_UNSPECIFIED - - ALL - - FOLDER - - DOCUMENT - - ROOT_FOLDER - description: The type of files to return. + Search all the documents under this specified folder. Format: + projects/{project_number}/locations/{location}/documents/{document_id}. type: string - enumDescriptions: - - Default document type. If set, disables the filter. - - Returns all document types, including folders. - - Returns only folders. - - Returns only non-folder documents. - - Returns only root folders - id: GoogleCloudContentwarehouseV1FileTypeFilter - description: Filter for the specific types of documents returned. - GoogleCloudContentwarehouseV1ActionExecutorOutput: - properties: - ruleActionsPairs: - description: List of rule and corresponding actions result. + isNlQuery: + description: >- + Experimental, do not use. If the query is a natural language + question. False by default. If true, then the question-answering + feature will be used instead of search, and `result_count` in + SearchDocumentsRequest must be set. In addition, all other input + fields related to search (pagination, histograms, etc.) will be + ignored. + type: boolean + queryContext: + description: >- + For custom synonyms. Customers provide the synonyms based on + context. One customer can provide multiple set of synonyms based on + different context. The search query will be expanded based on the + custom synonyms of the query context set. By default, no custom + synonyms wll be applied if no query context is provided. It is not + supported for CMEK compliant deployment. + type: array items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleActionsPair' + type: string + customPropertyFilter: + deprecated: true + description: >- + This filter specifies a structured syntax to match against the + [PropertyDefinition].is_filterable marked as `true`. The syntax for + this expression is a subset of SQL syntax. Supported operators are: + `=`, `!=`, `<`, `<=`, `>`, and `>=` where the left of the operator + is a property name and the right of the operator is a number or a + quoted string. You must escape backslash (\\) and quote (\") + characters. Supported functions are `LOWER([property_name])` to + perform a case insensitive match and `EMPTY([property_name])` to + filter on the existence of a key. Boolean expressions (AND/OR/NOT) + are supported up to 3 levels of nesting (for example, "((A AND B AND + C) OR NOT D) AND E"), a maximum of 100 comparisons or functions are + allowed in the expression. The expression must be < 6000 bytes in + length. Sample Query: `(LOWER(driving_license)="class \"a\"" OR + EMPTY(driving_license)) AND driving_years > 10` + type: string + fileTypeFilter: + description: >- + This filter specifies the types of files to return: ALL, FOLDER, or + FILE. If FOLDER or FILE is specified, then only either folders or + files will be returned, respectively. If ALL is specified, both + folders and files will be returned. If no value is specified, ALL + files will be returned. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1FileTypeFilter' + timeFilters: + description: >- + Documents created/updated within a range specified by this filter + are searched against. + items: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TimeFilter' type: array - description: Represents the output of the Action Executor. - type: object - id: GoogleCloudContentwarehouseV1ActionExecutorOutput - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow: - id: >- - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow - properties: - cells: + documentSchemaNames: + items: + type: string + description: >- + This filter specifies the exact document schema + Document.document_schema_name of the documents to search against. If + a value isn't specified, documents within the search results are + associated with any schema. If multiple values are specified, + documents within the search results may be associated with any of + the specified schemas. At most 20 document schema names are allowed. + type: array + customWeightsMetadata: + description: >- + To support the custom weighting across document schemas, customers + need to provide the properties to be used to boost the ranking in + the search request. For a search query with CustomWeightsMetadata + specified, only the RetrievalImportance for the properties in the + CustomWeightsMetadata will be honored. + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1CustomWeightsMetadata + propertyFilter: + description: >- + This filter specifies a structured syntax to match against the + PropertyDefinition.is_filterable marked as `true`. The relationship + between the PropertyFilters is OR. type: array - description: A table row is a list of table cells. items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell - type: object - description: Represents a row in a table. - GoogleCloudContentwarehouseV1ListLinkedSourcesResponse: - description: Response message for DocumentLinkService.ListLinkedSources. - type: object - id: GoogleCloudContentwarehouseV1ListLinkedSourcesResponse - properties: - nextPageToken: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1PropertyFilter' + query: type: string description: >- - A token, which can be sent as `page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. - documentLinks: + The query string that matches against the full text of the document + and the searchable properties. The query partially supports [Google + AIP style syntax](https://google.aip.dev/160). Specifically, the + query supports literals, logical operators, negation operators, + comparison operators, and functions. Literals: A bare literal value + (examples: "42", "Hugo") is a value to be matched against. It + searches over the full text of the document and the searchable + properties. Logical operators: "AND", "and", "OR", and "or" are + binary logical operators (example: "engineer OR developer"). + Negation operators: "NOT" and "!" are negation operators (example: + "NOT software"). Comparison operators: support the binary comparison + operators =, !=, <, >, <= and >= for string, numeric, enum, boolean. + Also support like operator `~~` for string. It provides semantic + search functionality by parsing, stemming and doing synonyms + expansion against the input query. To specify a property in the + query, the left hand side expression in the comparison must be the + property ID including the parent. The right hand side must be + literals. For example: "\"projects/123/locations/us\".property_a < + 1" matches results whose "property_a" is less than 1 in project 123 + and us location. The literals and comparison expression can be + connected in a single query (example: "software engineer + \"projects/123/locations/us\".salary > 100"). Functions: supported + functions are `LOWER([property_name])` to perform a case insensitive + match and `EMPTY([property_name])` to filter on the existence of a + key. Support nested expressions connected using parenthesis and + logical operators. The default logical operators is `AND` if there + is no operators between expressions. The query can be used with + other filters e.g. `time_filters` and `folder_name_filter`. They are + connected with `AND` operator under the hood. The maximum number of + allowed characters is 255. + documentCreatorFilter: items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentLink' - description: Source document-links. + type: string type: array - GoogleCloudDocumentaiV1DocumentProvenanceParent: + description: >- + The exact creator(s) of the documents to search against. If a value + isn't specified, documents within the search results are associated + with any creator. If multiple values are specified, documents within + the search results may be associated with any of the specified + creators. type: object - description: >- - The parent element the current element is based on. Used for - referencing/aligning, removal and replacement operations. + id: GoogleCloudContentwarehouseV1DocumentQuery + GoogleCloudContentwarehouseV1MapProperty: + type: object + id: GoogleCloudContentwarehouseV1MapProperty properties: - index: - description: >- - The index of the parent item in the corresponding item list (eg. - list of entities, properties within entities, etc.) in the parent - revision. - format: int32 - type: integer - id: - type: integer - deprecated: true - format: int32 - description: The id of the parent provenance. - revision: - format: int32 - description: The index of the index into current revision's parent_ids list. - type: integer - id: GoogleCloudDocumentaiV1DocumentProvenanceParent - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock: - id: >- - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock - description: Represents a table type block. + fields: + description: Unordered map of dynamically typed values. + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Value' + description: >- + Map property value. Represents a structured entries of key value pairs, + consisting of field names which map to dynamically typed values. + CloudAiPlatformTenantresourceTenantResource: + id: CloudAiPlatformTenantresourceTenantResource type: object + description: A collection of tenant resources. properties: - bodyRows: + p4ServiceAccounts: + description: A list of P4 service accounts (go/p4sa) to provision or deprovision. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow - description: Body rows containing main table content. + #/components/schemas/CloudAiPlatformTenantresourceServiceAccountIdentity type: array - headerRows: - description: Header rows at the top of the table. + tenantProjectResources: + type: array + description: >- + A list of tenant projects and tenant resources to provision or + deprovision. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow - type: array - caption: - description: Table caption/title. - type: string - GoogleCloudContentwarehouseV1CreateDocumentRequest: - id: GoogleCloudContentwarehouseV1CreateDocumentRequest - description: Request message for DocumentService.CreateDocument. + #/components/schemas/CloudAiPlatformTenantresourceTenantProjectResource + GoogleTypeColor: + id: GoogleTypeColor type: object properties: - cloudAiDocumentOption: - description: >- - Request Option for processing Cloud AI Document in Document - Warehouse. This field offers limited support for mapping entities - from Cloud AI Document to Warehouse Document. Please consult with - product team before using this field and other available options. - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1CloudAIDocumentOption - policy: - $ref: '#/components/schemas/GoogleIamV1Policy' - description: >- - Default document policy during creation. This refers to an Identity - and Access (IAM) policy, which specifies access controls for the - Document. Conditions defined in the policy will be ignored. - requestMetadata: - description: >- - The meta information collected about the end user, used to enforce - access control for the service. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' - document: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' - description: Required. The document to create. - createMask: - description: >- - Field mask for creating Document fields. If mask path is empty, it - means all fields are masked. For the `FieldMask` definition, see - https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask. - format: google-fieldmask - type: string - GoogleCloudContentwarehouseV1SearchDocumentsResponse: - properties: - metadata: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ResponseMetadata' - description: >- - Additional information for the API invocation, such as the request - tracking id. - questionAnswer: - description: Experimental. Question answer from the query against the document. - type: string - histogramQueryResults: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1HistogramQueryResult - description: >- - The histogram results that match with the specified - SearchDocumentsRequest.histogram_queries. - matchingDocuments: - description: >- - The document entities that match the specified - SearchDocumentsRequest. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1SearchDocumentsResponseMatchingDocument - totalSize: - type: integer - format: int32 - description: >- - The total number of matched documents which is available only if the - client set SearchDocumentsRequest.require_total_size to `true` or - set SearchDocumentsRequest.total_result_size to `ESTIMATED_SIZE` or - `ACTUAL_SIZE`. Otherwise, the value will be `-1`. Typically a UI - would handle this condition by displaying "of many", for example: - "Displaying 10 of many". - nextPageToken: - type: string - description: >- - The token that specifies the starting position of the next page of - results. This field is empty if there are no more results. - description: Response message for DocumentService.SearchDocuments. - type: object - id: GoogleCloudContentwarehouseV1SearchDocumentsResponse - GoogleTypeColor: - id: GoogleTypeColor - properties: - blue: - type: number - format: float - description: The amount of blue in the color as a value in the interval [0, 1]. - alpha: + green: + format: float + description: The amount of green in the color as a value in the interval [0, 1]. + type: number + red: + format: float + type: number + description: The amount of red in the color as a value in the interval [0, 1]. + alpha: + format: float description: >- The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = @@ -2837,15 +2913,10 @@ components: color (as if the alpha value had been explicitly given a value of 1.0). type: number + blue: format: float - red: - type: number - description: The amount of red in the color as a value in the interval [0, 1]. - format: float - green: type: number - description: The amount of green in the color as a value in the interval [0, 1]. - format: float + description: The amount of blue in the color as a value in the interval [0, 1]. description: >- Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations @@ -2897,488 +2968,653 @@ components: resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... + GoogleCloudContentwarehouseV1DeleteDocumentLinkRequest: + description: Request message for DocumentLinkService.DeleteDocumentLink. + properties: + requestMetadata: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' + description: >- + The meta information collected about the document creator, used to + enforce access control for the service. + id: GoogleCloudContentwarehouseV1DeleteDocumentLinkRequest type: object - GoogleCloudDocumentaiV1Document: - type: object + GoogleTypeDateTime: description: >- - Document represents the canonical document resource in Document AI. It - is an interchange format that provides insights into documents and - allows for collaboration between users and Document AI to iterate and - optimize for quality. + Represents civil time (or occasionally physical time). This type can + represent a civil time in one of a few possible ways: * When utc_offset + is set and time_zone is unset: a civil time on a calendar day with a + particular offset from UTC. * When time_zone is set and utc_offset is + unset: a civil time on a calendar day in a particular time zone. * When + neither time_zone nor utc_offset is set: a civil time on a calendar day + in local time. The date is relative to the Proleptic Gregorian Calendar. + If year, month, or day are 0, the DateTime is considered not to have a + specific year, month, or day respectively. This type may also be used to + represent a physical time if all the date and time fields are set and + either case of the `time_offset` oneof is set. Consider using + `Timestamp` message for physical time instead. If your use case also + would like to store the user's timezone, that can be done in another + field. This type is more flexible than some applications may want. Make + sure to document and validate your application's limitations. + type: object + id: GoogleTypeDateTime properties: - textStyles: - description: Styles for the Document.text. - deprecated: true - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentStyle' - type: array - entities: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntity' - description: >- - A list of entities detected on Document.text. For document shards, - entities in this list may cross shard boundaries. - type: array - shardInfo: + utcOffset: description: >- - Information about the sharding if this document is sharded part of a - larger document. If the document is not sharded, this message is not - specified. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentShardInfo' - documentLayout: - description: Parsed layout of the document. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayout' - text: - description: Optional. UTF-8 encoded text in reading order from the document. - type: string - uri: + UTC offset. Must be whole seconds, between -18 hours and +18 hours. + For example, a UTC offset of -4:00 would be represented as { + seconds: -14400 }. type: string + format: google-duration + month: description: >- - Optional. Currently supports Google Cloud Storage URI of the form - `gs://bucket_name/object_name`. Object versioning is not supported. - For more information, refer to [Google Cloud Storage Request - URIs](https://cloud.google.com/storage/docs/reference-uris). - mimeType: + Optional. Month of year. Must be from 1 to 12, or 0 if specifying a + datetime without a month. + type: integer + format: int32 + timeZone: + description: Time zone. + $ref: '#/components/schemas/GoogleTypeTimeZone' + minutes: + format: int32 + type: integer description: >- - An IANA published [media type (MIME - type)](https://www.iana.org/assignments/media-types/media-types.xhtml). - type: string - revisions: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentRevision' - type: array - description: Placeholder. Revision history of this document. - content: - format: byte + Optional. Minutes of hour of day. Must be from 0 to 59, defaults to + 0. + day: + type: integer + format: int32 description: >- - Optional. Inline document content, represented as a stream of bytes. - Note: As with all `bytes` fields, protobuffers use a pure binary - representation, whereas JSON representations use base64. - type: string - chunkedDocument: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocument' - description: Document chunked based on chunking config. - error: - description: Any error that occurred while processing this document. - $ref: '#/components/schemas/GoogleRpcStatus' - pages: - type: array - description: Visual page layout for the Document. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPage' - entityRelations: - type: array - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntityRelation' - description: Placeholder. Relationship among Document.entities. - textChanges: - type: array - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextChange' + Optional. Day of month. Must be from 1 to 31 and valid for the year + and month, or 0 if specifying a datetime without a day. + year: description: >- - Placeholder. A list of text corrections made to Document.text. This - is usually used for annotating corrections to OCR mistakes. Text - changes for a given revision may not overlap with each other. - id: GoogleCloudDocumentaiV1Document - GoogleCloudDocumentaiV1DocumentPageTableTableCell: - properties: - colSpan: + Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a + datetime without a year. format: int32 type: integer - description: How many columns this cell spans. - rowSpan: + hours: format: int32 - description: How many rows this cell spans. + description: >- + Optional. Hours of day in 24 hour format. Should be from 0 to 23, + defaults to 0 (midnight). An API may choose to allow the value + "24:00:00" for scenarios like business closing time. type: integer - detectedLanguages: - description: A list of detected languages together with confidence. + nanos: + format: int32 + type: integer + description: >- + Optional. Fractions of seconds in nanoseconds. Must be from 0 to + 999,999,999, defaults to 0. + seconds: + description: >- + Optional. Seconds of minutes of the time. Must normally be from 0 to + 59, defaults to 0. An API may allow the value 60 if it allows + leap-seconds. + type: integer + format: int32 + GoogleApiServiceconsumermanagementV1PolicyBinding: + id: GoogleApiServiceconsumermanagementV1PolicyBinding + description: Translates to IAM Policy bindings (without auditing at this level) + properties: + role: + type: string + description: >- + Role. (https://cloud.google.com/iam/docs/understanding-roles) For + example, `roles/viewer`, `roles/editor`, or `roles/owner`. + members: + description: >- + Uses the same format as in IAM policy. `member` must include both a + prefix and ID. For example, `user:{emailId}`, + `serviceAccount:{emailId}`, `group:{emailId}`. items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + type: string type: array - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for TableCell. - description: A cell representation inside the table. type: object - id: GoogleCloudDocumentaiV1DocumentPageTableTableCell - GoogleCloudContentwarehouseV1ListDocumentSchemasResponse: + GoogleCloudContentwarehouseV1IntegerTypeOptions: + id: GoogleCloudContentwarehouseV1IntegerTypeOptions type: object - id: GoogleCloudContentwarehouseV1ListDocumentSchemasResponse - properties: - documentSchemas: - description: The document schemas from the specified parent. - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema' - type: array - nextPageToken: - type: string - description: >- - A token, which can be sent as `page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. - description: Response message for DocumentSchemaService.ListDocumentSchemas. - GoogleCloudDocumentaiV1DocumentPageToken: + description: Configurations for an integer property. + properties: {} + GoogleCloudDocumentaiV1DocumentPageLine: + id: GoogleCloudDocumentaiV1DocumentPageLine + description: >- + A collection of tokens that a human would perceive as a line. Does not + cross column boundaries, can be horizontal, vertical, etc. type: object - id: GoogleCloudDocumentaiV1DocumentPageToken properties: - detectedBreak: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak - description: Detected break at the end of a Token. - styleInfo: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo - description: Text style attributes. + provenance: + deprecated: true + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + description: The history of this annotation. detectedLanguages: + description: A list of detected languages together with confidence. items: $ref: >- #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - description: A list of detected languages together with confidence. type: array - provenance: - deprecated: true - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - description: The history of this annotation. layout: - description: Layout for Token. $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: A detected token. - GoogleCloudContentwarehouseV1ProcessWithDocAiPipeline: - description: >- - The configuration of processing documents in Document Warehouse with - DocAi processors pipeline. + description: Layout for Line. + GoogleCloudContentwarehouseV1Value: type: object + description: >- + `Value` represents a dynamically typed value which can be either be a + float, a integer, a string, or a datetime value. A producer of value is + expected to set one of these variants. Absence of any variant indicates + an error. properties: - processorResultsFolderPath: - type: string - description: >- - The Cloud Storage folder path used to store the raw results from - processors. Format: `gs:///`. - documents: - type: array - description: >- - The list of all the resource names of the documents to be processed. - Format: - projects/{project_number}/locations/{location}/documents/{document_id}. - items: - type: string - exportFolderPath: - description: >- - The Cloud Storage folder path used to store the exported documents - before being sent to CDW. Format: `gs:///`. + floatValue: + description: Represents a float value. + format: float + type: number + datetimeValue: + description: Represents a datetime value. + $ref: '#/components/schemas/GoogleTypeDateTime' + stringValue: + description: Represents a string value. type: string - processorInfo: - description: The CDW processor information. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ProcessorInfo' - id: GoogleCloudContentwarehouseV1ProcessWithDocAiPipeline - GoogleCloudContentwarehouseV1ResponseMetadata: - description: >- - Additional information returned to client, such as debugging - information. + enumValue: + description: Represents an enum value. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1EnumValue' + timestampValue: + description: Represents a timestamp value. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TimestampValue' + intValue: + type: integer + format: int32 + description: Represents a integer value. + booleanValue: + type: boolean + description: Represents a boolean value. + id: GoogleCloudContentwarehouseV1Value + GoogleCloudDocumentaiV1DocumentPageDetectedLanguage: + description: Detected language for a structural component. properties: - requestId: + languageCode: type: string description: >- - A unique id associated with this call. This id is logged for - tracking purpose. + The [BCP-47 language + code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), + such as `en-US` or `sr-Latn`. + confidence: + format: float + type: number + description: Confidence of detected language. Range `[0, 1]`. type: object - id: GoogleCloudContentwarehouseV1ResponseMetadata - GoogleCloudContentwarehouseV1ListLinkedSourcesRequest: + id: GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + GoogleCloudContentwarehouseV1RemoveFromFolderAction: + id: GoogleCloudContentwarehouseV1RemoveFromFolderAction + description: >- + Represents the action responsible for remove a document from a specific + folder. type: object - id: GoogleCloudContentwarehouseV1ListLinkedSourcesRequest properties: - requestMetadata: + folder: description: >- - The meta information collected about the document creator, used to - enforce access control for the service. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' - pageToken: + Name of the folder under which new document is to be added. Format: + projects/{project_number}/locations/{location}/documents/{document_id}. type: string - description: >- - A page token, received from a previous `ListLinkedSources` call. - Provide this to retrieve the subsequent page. When paginating, all - other parameters provided to `ListLinkedSources` must match the call - that provided the page token. - pageSize: - description: >- - The maximum number of document-links to return. The service may - return fewer than this value. If unspecified, at most 50 - document-links will be returned. The maximum value is 1000; values - above 1000 will be coerced to 1000. - type: integer - format: int32 - description: Response message for DocumentLinkService.ListLinkedSources. - GoogleCloudContentwarehouseV1DocumentSchema: + condition: + description: Condition of the action to be executed. + type: string + CloudAiPlatformTenantresourceInfraSpannerConfig: properties: - description: + spannerBorgServiceAccount: type: string - description: Schema description. - documentIsFolder: description: >- - Document Type, true refers the document is a folder, otherwise it is - a typical document. - type: boolean - createTime: - type: string - readOnly: true - description: Output only. The time when the document schema is created. - format: google-datetime - propertyDefinitions: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1PropertyDefinition - description: Document details. - name: + Input [Optional]. The spanner borg service account for delegating + the kms key to. For example, + spanner-infra-cmek-nonprod@system.gserviceaccount.com, for the + nonprod universe. + createDatabaseOptions: + description: >- + Input [Optional]. The options to create a spanner database. Note: + give the right options to ensure the right KMS key access audit + logging and AxT logging in expected logging category. + $ref: >- + #/components/schemas/CloudAiPlatformTenantresourceInfraSpannerConfigCreateDatabaseOptions + spannerUniverse: type: string description: >- - The resource name of the document schema. Format: - projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. - The name is ignored when creating a document schema. - displayName: + Input [Required]. Every database in Spanner can be identified by the + following path name: /span//: + kmsKeyReference: description: >- - Required. Name of the schema given by the user. Must be unique per - project. + Input [Optional]. The KMS key name or the KMS grant name used for + CMEK encryption. Only set this field when provisioning new Infra + Spanner databases. For existing Infra Spanner databases, this field + will be ignored because CMEK re-encryption is not supported. For + example, projects//locations//keyRings//cryptoKeys/ type: string - updateTime: - readOnly: true - format: google-datetime - description: Output only. The time when the document schema is last updated. + spannerLocalNamePrefix: + type: string + sdlBundlePath: + description: Input [Required]. The file path to the spanner SDL bundle. + type: string + spannerNamespace: type: string + description: 'The configuration for a spanner database provisioning. Next ID: 8' + id: CloudAiPlatformTenantresourceInfraSpannerConfig type: object - description: A document schema used to define document structure. - id: GoogleCloudContentwarehouseV1DocumentSchema - CloudAiPlatformTenantresourceInfraSpannerConfigCreateDatabaseOptions: - description: >- - The options to create a spanner database. KMS key access audit logging - and AxT logging will be associated with the given resource name, - resource type and service name. Please ensure to give right options to - enable correct audit logging and AxT logging. + GoogleTypePostalAddress: type: object - id: CloudAiPlatformTenantresourceInfraSpannerConfigCreateDatabaseOptions + description: >- + Represents a postal address. For example for postal delivery or payments + addresses. Given a postal address, a postal service can deliver items to + a premise, P.O. Box or similar. It is not intended to model geographical + locations (roads, towns, mountains). In typical usage an address would + be created by user input or from importing existing data, depending on + the type of process. Advice on address input / editing: - Use an + internationalization-ready address widget such as + https://github.com/google/libaddressinput) - Users should not be + presented with UI elements for input or editing of fields outside + countries where that field is used. For more guidance on how to use this + schema, see: https://support.google.com/business/answer/6397478 + id: GoogleTypePostalAddress properties: - cmekCloudResourceName: + postalCode: + description: >- + Optional. Postal code of the address. Not all countries use or + require postal codes to be present, but where they are used, they + may trigger additional validation with other parts of the address + (For example state/zip validation in the U.S.A.). type: string + addressLines: + type: array description: >- - The cloud resource name for the CMEK encryption. For example, - projects//locations/ - cmekCloudResourceType: + Unstructured address lines describing the lower levels of an + address. Because values in address_lines do not have type + information and may sometimes contain multiple values in a single + field (For example "Austin, TX"), it is important that the line + order is clear. The order of address lines should be "envelope + order" for the country/region of the address. In places where this + can vary (For example Japan), address_language is used to make it + explicit (For example "ja" for large-to-small ordering and "ja-Latn" + or "en" for small-to-large). This way, the most specific line of an + address can be selected based on the language. The minimum permitted + structural representation of an address consists of a region_code + with all remaining information placed in the address_lines. It would + be possible to format such an address very approximately without + geocoding, but no semantic reasoning could be made about any of the + address components until it was at least partially resolved. + Creating an address only containing a region_code and address_lines, + and then geocoding is the recommended way to handle completely + unstructured addresses (as opposed to guessing which parts of the + address should be localities or administrative areas). + items: + type: string + revision: + format: int32 + description: >- + The schema revision of the `PostalAddress`. This must be set to 0, + which is the latest revision. All new revisions **must** be backward + compatible with old revisions. + type: integer + sortingCode: type: string description: >- - The cloud resource type for the CMEK encryption. For example, - contentwarehouse.googleapis.com/Location - cmekServiceName: + Optional. Additional, country-specific, sorting code. This is not + used in most regions. Where it is used, the value is either a string + like "CEDEX", optionally followed by a number (For example "CEDEX + 7"), or just a number alone, representing the "sector code" + (Jamaica), "delivery area indicator" (Malawi) or "post office + indicator" (For example Côte d'Ivoire). + organization: + description: Optional. The name of the organization at the address. + type: string + locality: type: string description: >- - The service name for the CMEK encryption. For example, - contentwarehouse.googleapis.com - GoogleCloudDocumentaiV1DocumentStyleFontSize: - type: object - description: Font size with unit. - id: GoogleCloudDocumentaiV1DocumentStyleFontSize - properties: - size: - type: number - format: float - description: Font size for the text. - unit: - description: >- - Unit for the font size. Follows CSS naming (such as `in`, `px`, and - `pt`). + Optional. Generally refers to the city/town portion of the address. + Examples: US city, IT comune, UK post town. In regions of the world + where localities are not well defined or do not fit into this + structure well, leave locality empty and use address_lines. + administrativeArea: type: string - GoogleIamV1AuditConfig: - 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: - items: - $ref: '#/components/schemas/GoogleIamV1AuditLogConfig' - description: The configuration for logging of each type of permission. - 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 - id: GoogleIamV1AuditConfig - type: object - GoogleCloudContentwarehouseV1LockDocumentRequest: - id: GoogleCloudContentwarehouseV1LockDocumentRequest - type: object - description: Request message for DocumentService.LockDocument. - properties: - lockingUser: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1UserInfo' - description: The user information who locks the document. - collectionId: - description: The collection the document connects to. - type: string - GoogleCloudContentwarehouseV1UpdateDocumentSchemaRequest: - properties: - documentSchema: - description: Required. The document schema to update with. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema' - id: GoogleCloudContentwarehouseV1UpdateDocumentSchemaRequest - description: Request message for DocumentSchemaService.UpdateDocumentSchema. - type: object - GoogleTypeTimeZone: - properties: - version: - description: Optional. IANA Time Zone Database version number, e.g. "2019a". + Optional. Highest administrative subdivision which is used for + postal addresses of a country or region. For example, this can be a + state, a province, an oblast, or a prefecture. Specifically, for + Spain this is the province and not the autonomous community (For + example "Barcelona" and not "Catalonia"). Many countries don't use + an administrative area in postal addresses. For example in + Switzerland this should be left unpopulated. + regionCode: type: string - id: - description: IANA Time Zone Database time zone, e.g. "America/New_York". + description: >- + Required. CLDR region code of the country/region of the address. + This is never inferred and it is up to the user to ensure the value + is correct. See https://cldr.unicode.org/ and + https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html + for details. Example: "CH" for Switzerland. + sublocality: type: string - description: >- - Represents a time zone from the [IANA Time Zone - Database](https://www.iana.org/time-zones). - type: object - id: GoogleTypeTimeZone - GoogleCloudDocumentaiV1DocumentPageDetectedLanguage: - type: object - description: Detected language for a structural component. - properties: + description: >- + Optional. Sublocality of the address. For example, this can be + neighborhoods, boroughs, districts. languageCode: + description: >- + Optional. BCP-47 language code of the contents of this address (if + known). This is often the UI language of the input form or is + expected to match one of the languages used in the address' + country/region, or their transliterated equivalents. This can affect + formatting in certain countries, but is not critical to the + correctness of the data and will never affect any validation or + other non-formatting related operations. If this value is not known, + it should be omitted (rather than specifying a possibly incorrect + default). Examples: "zh-Hant", "ja", "ja-Latn", "en". type: string + recipients: description: >- - The [BCP-47 language - code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), - such as `en-US` or `sr-Latn`. - confidence: - format: float - description: Confidence of detected language. Range `[0, 1]`. - type: number - id: GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - GoogleCloudDocumentaiV1DocumentPageDetectedBarcode: - description: A detected barcode. - type: object - id: GoogleCloudDocumentaiV1DocumentPageDetectedBarcode - properties: - barcode: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Barcode' - description: Detailed barcode information of the DetectedBarcode. - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for DetectedBarcode. - GoogleCloudContentwarehouseV1CreateDocumentLinkRequest: - type: object + Optional. The recipient at the address. This field may, under + certain circumstances, contain multiline information. For example, + it might contain "care of" information. + type: array + items: + type: string + GoogleCloudContentwarehouseV1SearchDocumentsRequest: properties: + offset: + type: integer + description: >- + An integer that specifies the current offset (that is, starting + result location, amongst the documents deemed by the API as + relevant) in search results. This field is only considered if + page_token is unset. The maximum allowed value is 5000. Otherwise an + error is thrown. For example, 0 means to return results starting + from the first matching document, and 10 means to return from the + 11th document. This can be used for pagination, (for example, + pageSize = 10 and offset = 10 means to return from the second page). + format: int32 requestMetadata: description: >- - The meta information collected about the document creator, used to - enforce access control for the service. + The meta information collected about the end user, used to enforce + access control and improve the search quality of the service. $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' - documentLink: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentLink' - description: >- - Required. Document links associated with the source documents - (source_document_id). - description: Request message for DocumentLinkService.CreateDocumentLink. - id: GoogleCloudContentwarehouseV1CreateDocumentLinkRequest - GoogleCloudDocumentaiV1Barcode: - description: Encodes the detailed information of a barcode. - properties: - valueFormat: - type: string - description: >- - Value format describes the format of the value that a barcode - encodes. The supported formats are: - `CONTACT_INFO`: Contact - information. - `EMAIL`: Email address. - `ISBN`: ISBN identifier. - - `PHONE`: Phone number. - `PRODUCT`: Product. - `SMS`: SMS message. - - `TEXT`: Text string. - `URL`: URL address. - `WIFI`: Wifi - information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`: Calendar - event. - `DRIVER_LICENSE`: Driver's license. - format: - type: string - description: >- - Format of a barcode. The supported formats are: - `CODE_128`: Code - 128 type. - `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - - `CODABAR`: Codabar type. - `DATA_MATRIX`: 2D Data Matrix type. - - `ITF`: ITF type. - `EAN_13`: EAN-13 type. - `EAN_8`: EAN-8 type. - - `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A type. - `UPC_E`: UPC-E - type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code type. - - `DATABAR`: GS1 DataBar code type. - rawValue: + documentQuery: + description: Query used to search against documents (keyword, filters, etc.). + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentQuery' + totalResultSize: type: string + enum: + - TOTAL_RESULT_SIZE_UNSPECIFIED + - ESTIMATED_SIZE + - ACTUAL_SIZE + enumDescriptions: + - Total number calculation will be skipped. + - >- + Estimate total number. The total result size will be accurated up + to 10,000. This option will add cost and latency to your request. + - It may adversely impact performance. The limit is 1000,000. description: >- - Raw value encoded in the barcode. For example: - `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`. - id: GoogleCloudDocumentaiV1Barcode - type: object - GoogleCloudDocumentaiV1DocumentRevision: - type: object - properties: - id: + Controls if the search document request requires the return of a + total size of matched documents. See + SearchDocumentsResponse.total_size. + pageToken: type: string description: >- - Id of the revision, internally generated by doc proto storage. - Unique within the context of the document. - parent: - items: - format: int32 - type: integer + The token specifying the current offset within search results. See + SearchDocumentsResponse.next_page_token for an explanation of how to + obtain the next set of query results. + requireTotalSize: description: >- - The revisions that this revision is based on. This can include one - or more parent (when documents are merged.) This field represents - the index into the `revisions` field. - deprecated: true - type: array - humanReview: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentRevisionHumanReview - description: Human Review information of this revision. - agent: + Controls if the search document request requires the return of a + total size of matched documents. See + SearchDocumentsResponse.total_size. Enabling this flag may adversely + impact performance. Hint: If this is used with pagination, set this + flag on the initial query but set this to false on subsequent page + calls (keep the total count locally). Defaults to false. + type: boolean + orderBy: description: >- - If the change was made by a person specify the name or id of that - person. - type: string - processor: + The criteria determining how search results are sorted. For + non-empty query, default is `"relevance desc"`. For empty query, + default is `"upload_date desc"`. Supported options are: * + `"relevance desc"`: By relevance descending, as determined by the + API algorithms. * `"upload_date desc"`: By upload date descending. * + `"upload_date"`: By upload date ascending. * `"update_date desc"`: + By last updated date descending. * `"update_date"`: By last updated + date ascending. * `"retrieval_importance desc"`: By retrieval + importance of properties descending. This feature is still under + development, please do not use unless otherwise instructed to do so. type: string + pageSize: + format: int32 + type: integer description: >- - If the annotation was made by processor identify the processor by - its resource name. - createTime: - format: google-datetime + A limit on the number of documents returned in the search results. + Increasing this value above the default value of 10 can increase + search response time. The value can be between 1 and 100. + histogramQueries: description: >- - The time that the revision was created, internally generated by doc - proto storage at the time of create. + An expression specifying a histogram request against matching + documents. Expression syntax is an aggregation function call with + histogram facets and other options. The following aggregation + functions are supported: * `count(string_histogram_facet)`: Count + the number of matching entities for each distinct attribute value. + Data types: * Histogram facet (aka filterable properties): Facet + names with format .. Facets will have the format + of: `a-zA-Z`. If the facet is a child facet, then the parent + hierarchy needs to be specified separated by dots in the prefix + after the schema id. Thus, the format for a multi- level facet is: + .. . Example: + schema123.root_parent_facet.middle_facet.child_facet * + DocumentSchemaId: (with no schema id prefix) to get histograms for + each document type (returns the schema id path, e.g. + projects/12345/locations/us-west/documentSchemas/abc123). Example + expression: * Document type counts: count('DocumentSchemaId') * For + schema id, abc123, get the counts for MORTGAGE_TYPE: + count('abc123.MORTGAGE_TYPE') + type: array + items: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1HistogramQuery' + qaSizeLimit: + description: >- + Experimental, do not use. The limit on the number of documents + returned for the question-answering feature. To enable the + question-answering feature, set [DocumentQuery].is_nl_query to true. + type: integer + format: int32 + type: object + id: GoogleCloudContentwarehouseV1SearchDocumentsRequest + description: Request message for DocumentService.SearchDocuments. + GoogleCloudDocumentaiV1DocumentPageAnchorPageRef: + properties: + boundingPoly: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1BoundingPoly' + description: >- + Optional. Identifies the bounding polygon of a layout element on the + page. If `layout_type` is set, the bounding polygon must be exactly + the same to the layout element it's referring to. + page: type: string - parentIds: + description: >- + Required. Index into the Document.pages element, for example using + `Document.pages` to locate the related page element. This field is + skipped when its value is the default `0`. See + https://developers.google.com/protocol-buffers/docs/proto3#json. + format: int64 + layoutType: + description: >- + Optional. The type of the layout element that is being referenced if + any. + type: string + enumDescriptions: + - Layout Unspecified. + - References a Page.blocks element. + - References a Page.paragraphs element. + - References a Page.lines element. + - References a Page.tokens element. + - References a Page.visual_elements element. + - Refrrences a Page.tables element. + - References a Page.form_fields element. + enum: + - LAYOUT_TYPE_UNSPECIFIED + - BLOCK + - PARAGRAPH + - LINE + - TOKEN + - VISUAL_ELEMENT + - TABLE + - FORM_FIELD + layoutId: + type: string + deprecated: true + description: Optional. Deprecated. Use PageRef.bounding_poly instead. + confidence: + format: float + description: >- + Optional. Confidence of detected page element, if applicable. Range + `[0, 1]`. + type: number + description: Represents a weak reference to a page element within a document. + id: GoogleCloudDocumentaiV1DocumentPageAnchorPageRef + type: object + GoogleCloudContentwarehouseV1LockDocumentRequest: + id: GoogleCloudContentwarehouseV1LockDocumentRequest + type: object + description: Request message for DocumentService.LockDocument. + properties: + collectionId: + description: The collection the document connects to. + type: string + lockingUser: + description: The user information who locks the document. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1UserInfo' + GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment: + properties: + endIndex: + type: string + description: TextSegment half open end UTF-8 char index in the Document.text. + format: int64 + startIndex: + description: TextSegment start UTF-8 char index in the Document.text. + type: string + format: int64 + type: object + description: >- + A text segment in the Document.text. The indices may be out of bounds + which indicate that the text extends into another document shard for + large sharded documents. See ShardInfo.text_offset + id: GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment + GoogleCloudContentwarehouseV1Property: + type: object + properties: + textValues: + description: String/text property values. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TextArray' + mapProperty: + description: Map property values. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1MapProperty' + timestampValues: + description: >- + Timestamp property values. It is not supported by CMEK compliant + deployment. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TimestampArray' + floatValues: + description: Float property values. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1FloatArray' + dateTimeValues: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DateTimeArray' + description: >- + Date time property values. It is not supported by CMEK compliant + deployment. + propertyValues: + description: Nested structured data property values. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1PropertyArray' + name: + description: >- + Required. Must match the name of a PropertyDefinition in the + DocumentSchema. + type: string + integerValues: + description: Integer property values. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1IntegerArray' + enumValues: + description: Enum property values. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1EnumArray' + id: GoogleCloudContentwarehouseV1Property + description: Property of a document. + GoogleCloudContentwarehouseV1UpdateDocumentMetadata: + id: GoogleCloudContentwarehouseV1UpdateDocumentMetadata + type: object + properties: {} + description: Metadata object for UpdateDocument request (currently empty). + GoogleCloudContentwarehouseV1SearchDocumentsResponseMatchingDocument: + id: GoogleCloudContentwarehouseV1SearchDocumentsResponseMatchingDocument + properties: + qaResult: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1QAResult' + description: >- + Experimental. Additional result info if the question-answering + feature is enabled. + searchTextSnippet: + type: string + description: >- + Contains snippets of text from the document full raw text that most + closely match a search query's keywords, if available. All HTML tags + in the original fields are stripped when returned in this field, and + matching query keywords are enclosed in HTML bold tags. If the + question-answering feature is enabled, this field will instead + contain a snippet that answers the user's natural-language query. No + HTML bold tags will be present, and highlights in the answer snippet + can be found in QAResult.highlights. + document: + description: >- + Document that matches the specified SearchDocumentsRequest. This + document only contains indexed metadata information. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' + matchedTokenPageIndices: + description: >- + Return the 1-based page indices where those pages have one or more + matched tokens. type: array items: type: string - description: >- - The revisions that this revision is based on. Must include all the - ids that have anything to do with this revision - eg. there are - `provenance.parent.revision` fields that index into this field. - id: GoogleCloudDocumentaiV1DocumentRevision - description: Contains past or forward revisions of this document. - GoogleCloudContentwarehouseV1PropertyDefinition: - description: Defines the metadata for a schema property. + format: int64 + description: Document entry with metadata inside SearchDocumentsResponse + type: object + GoogleCloudContentwarehouseV1UserInfo: + description: The user information. type: object properties: - isFilterable: + id: description: >- - Whether the property can be filtered. If this is a sub-property, all - the parent properties must be marked filterable. + A unique user identification string, as determined by the client. + The maximum number of allowed characters is 255. Allowed characters + include numbers 0 to 9, uppercase and lowercase letters, and + restricted special symbols (:, @, +, -, _, ~) The format is + "user:xxxx@example.com"; + type: string + groupIds: + type: array + description: >- + The unique group identifications which the user is belong to. The + format is "group:yyyy@example.com"; + items: + type: string + id: GoogleCloudContentwarehouseV1UserInfo + GoogleCloudContentwarehouseV1PropertyDefinition: + properties: + mapTypeOptions: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1MapTypeOptions' + description: Map property. + propertyTypeOptions: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1PropertyTypeOptions + description: Nested structured data property. + isRepeatable: + type: boolean + description: Whether the property can have multiple values. + isRequired: type: boolean + description: >- + Whether the property is mandatory. Default is 'false', i.e. + populating property value can be skipped. If 'true' then user must + populate the value for this property. + integerTypeOptions: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1IntegerTypeOptions' + description: Integer property. name: type: string description: >- @@ -3386,24 +3622,34 @@ components: document schema and is case insensitive. Names must be non-blank, start with a letter, and can contain alphanumeric characters and: /, :, -, _, and . - displayName: - description: The display-name for the property, used for front-end. - type: string - mapTypeOptions: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1MapTypeOptions' - description: Map property. - enumTypeOptions: - description: Enum/categorical property. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1EnumTypeOptions' + isSearchable: + description: Indicates that the property should be included in a global search. + type: boolean isMetadata: description: >- Whether the property is user supplied metadata. This out-of-the box placeholder setting can be used to tag derived properties. Its value and interpretation logic should be implemented by API user. type: boolean - retrievalImportance: - description: The retrieval importance of the property during search. - enum: + schemaSources: + type: array + description: >- + The mapping information between this property to another schema + source. + items: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSource + textTypeOptions: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TextTypeOptions' + description: Text/string property. + timestampTypeOptions: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1TimestampTypeOptions + description: >- + Timestamp property. It is not supported by CMEK compliant + deployment. + retrievalImportance: + enum: - RETRIEVAL_IMPORTANCE_UNSPECIFIED - HIGHEST - HIGHER @@ -3412,6 +3658,7 @@ components: - LOW - LOWEST type: string + description: The retrieval importance of the property during search. enumDescriptions: - No importance specified. Default medium importance. - Highest importance. @@ -3420,158 +3667,175 @@ components: - Medium importance. - Low importance (negative). - Lowest importance (negative). - schemaSources: - items: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSource - type: array - description: >- - The mapping information between this property to another schema - source. - isRequired: - description: >- - Whether the property is mandatory. Default is 'false', i.e. - populating property value can be skipped. If 'true' then user must - populate the value for this property. - type: boolean - textTypeOptions: - description: Text/string property. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TextTypeOptions' - propertyTypeOptions: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1PropertyTypeOptions - description: Nested structured data property. - integerTypeOptions: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1IntegerTypeOptions' - description: Integer property. dateTimeTypeOptions: description: >- Date time property. It is not supported by CMEK compliant deployment. $ref: >- #/components/schemas/GoogleCloudContentwarehouseV1DateTimeTypeOptions + enumTypeOptions: + description: Enum/categorical property. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1EnumTypeOptions' + isFilterable: + description: >- + Whether the property can be filtered. If this is a sub-property, all + the parent properties must be marked filterable. + type: boolean + displayName: + type: string + description: The display-name for the property, used for front-end. floatTypeOptions: $ref: '#/components/schemas/GoogleCloudContentwarehouseV1FloatTypeOptions' description: Float property. - isRepeatable: - description: Whether the property can have multiple values. - type: boolean - isSearchable: - description: Indicates that the property should be included in a global search. - type: boolean - timestampTypeOptions: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1TimestampTypeOptions - description: >- - Timestamp property. It is not supported by CMEK compliant - deployment. + description: Defines the metadata for a schema property. id: GoogleCloudContentwarehouseV1PropertyDefinition - GoogleCloudContentwarehouseV1DeleteDocumentAction: type: object - description: Represents the action responsible for deleting the document. - id: GoogleCloudContentwarehouseV1DeleteDocumentAction + GoogleCloudContentwarehouseV1beta1CreateDocumentMetadata: + description: Metadata object for CreateDocument request (currently empty). + type: object + id: GoogleCloudContentwarehouseV1beta1CreateDocumentMetadata + properties: {} + GoogleCloudContentwarehouseV1SetAclRequest: + type: object + description: Request message for DocumentService.SetAcl. + id: GoogleCloudContentwarehouseV1SetAclRequest properties: - enableHardDelete: + requestMetadata: + description: >- + The meta information collected about the end user, used to enforce + access control for the service. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' + policy: + $ref: '#/components/schemas/GoogleIamV1Policy' + description: >- + Required. REQUIRED: The complete policy to be applied to the + `resource`. The size of the policy is limited to a few 10s of KB. + This refers to an Identity and Access (IAM) policy, which specifies + access controls for the Document. You can set ACL with condition for + projects only. Supported operators are: `=`, `!=`, `<`, `<=`, `>`, + and `>=` where the left of the operator is `DocumentSchemaId` or + property name and the right of the operator is a number or a quoted + string. You must escape backslash (\\) and quote (\") characters. + Boolean expressions (AND/OR) are supported up to 3 levels of nesting + (for example, "((A AND B AND C) OR D) AND E"), a maximum of 10 + comparisons are allowed in the expression. The expression must be < + 6000 bytes in length. Sample condition: `"DocumentSchemaId = \"some + schema id\" OR SchemaId.floatPropertyName >= 10"` + projectOwner: + description: >- + For Set Project ACL only. Authorization check for end user will be + ignored when project_owner=true. type: boolean + GoogleCloudContentwarehouseV1RunPipelineMetadataExportToCdwPipelineMetadata: + type: object + description: The metadata message for Export-to-CDW pipeline. + properties: + docAiDataset: + type: string + description: The output CDW dataset resource name. + documents: description: >- - Boolean field to select between hard vs soft delete options. Set - 'true' for 'hard delete' and 'false' for 'soft delete'. - GoogleCloudContentwarehouseV1TimestampTypeOptions: - properties: {} - id: GoogleCloudContentwarehouseV1TimestampTypeOptions + The input list of all the resource names of the documents to be + exported. + items: + type: string + type: array + outputPath: + type: string + description: The output Cloud Storage folder in this pipeline. + id: >- + GoogleCloudContentwarehouseV1RunPipelineMetadataExportToCdwPipelineMetadata + GoogleCloudDocumentaiV1DocumentDocumentLayout: + properties: + blocks: + description: List of blocks in the document. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + type: array + id: GoogleCloudDocumentaiV1DocumentDocumentLayout + description: >- + Represents the parsed layout of a document as a collection of blocks + that the document is divided into. type: object - description: Configurations for a timestamp property. GoogleCloudContentwarehouseV1RuleEvaluatorOutput: - type: object - id: GoogleCloudContentwarehouseV1RuleEvaluatorOutput description: Represents the output of the Rule Evaluator. properties: matchedRules: - type: array description: >- A subset of triggered rules that are evaluated true for a given request. items: $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Rule' + type: array triggeredRules: + items: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Rule' type: array description: >- List of rules fetched from database for the given request trigger type. - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Rule' invalidRules: - description: >- - A subset of triggered rules that failed the validation check(s) - after parsing. type: array items: $ref: '#/components/schemas/GoogleCloudContentwarehouseV1InvalidRule' - GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk: - description: Represents a chunk. - properties: - pageHeaders: - description: Page headers associated with the chunk. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader - pageSpan: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan - description: Page span of the chunk. - pageFooters: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter - description: Page footers associated with the chunk. - chunkId: - description: ID of the chunk. - type: string - content: - type: string - description: Text content of the chunk. - sourceBlockIds: - type: array - description: Unused. - items: - type: string + description: >- + A subset of triggered rules that failed the validation check(s) + after parsing. + id: GoogleCloudContentwarehouseV1RuleEvaluatorOutput type: object - id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk - GoogleCloudContentwarehouseV1SynonymSet: + GoogleTypeDate: + id: GoogleTypeDate properties: - context: + day: description: >- - This is a freeform field. Example contexts can be "sales," - "engineering," "real estate," "accounting," etc. The context can be - supplied during search requests. - type: string - name: - type: string + Day of a month. Must be from 1 to 31 and valid for the year and + month, or 0 to specify a year by itself or a year and month where + the day isn't significant. + format: int32 + type: integer + month: + format: int32 + type: integer description: >- - The resource name of the SynonymSet This is mandatory for - google.api.resource. Format: - projects/{project_number}/locations/{location}/synonymSets/{context}. - synonyms: - description: List of Synonyms for the context. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1SynonymSetSynonym - id: GoogleCloudContentwarehouseV1SynonymSet + Month of a year. Must be from 1 to 12, or 0 to specify a year + without a month and day. + year: + format: int32 + type: integer + description: >- + Year of the date. Must be from 1 to 9999, or 0 to specify a date + without a year. description: >- - Represents a list of synonyms for a given context. For example a context - "sales" could contain: Synonym 1: sale, invoice, bill, order Synonym 2: - money, credit, finance, payment Synonym 3: shipping, freight, transport - Each SynonymSets should be disjoint + Represents a whole or partial calendar date, such as a birthday. The + time of day and time zone are either specified elsewhere or are + insignificant. The date is relative to the Gregorian Calendar. This can + represent one of the following: * A full date, with non-zero year, + month, and day values. * A month and day, with a zero year (for example, + an anniversary). * A year on its own, with a zero month and a zero day. + * A year and month, with a zero day (for example, a credit card + expiration date). Related types: * google.type.TimeOfDay * + google.type.DateTime * google.protobuf.Timestamp type: object - GoogleCloudContentwarehouseV1beta1CreateDocumentMetadata: - id: GoogleCloudContentwarehouseV1beta1CreateDocumentMetadata + GoogleCloudContentwarehouseV1QAResultHighlight: + id: GoogleCloudContentwarehouseV1QAResultHighlight + properties: + endIndex: + type: integer + format: int32 + description: End index of the highlight, exclusive. + startIndex: + format: int32 + description: Start index of the highlight. + type: integer type: object - description: Metadata object for CreateDocument request (currently empty). - properties: {} + description: >- + A text span in the search text snippet that represents a highlighted + section (answer context, highly relevant sentence, etc.). GoogleTypeMoney: + type: object + id: GoogleTypeMoney + description: Represents an amount of money with its currency type. properties: units: type: string @@ -3580,10 +3844,9 @@ components: `"USD"`, then 1 unit is one US dollar. format: int64 currencyCode: - description: The three-letter currency code defined in ISO 4217. type: string + description: The three-letter currency code defined in ISO 4217. nanos: - format: int32 type: integer description: >- Number of nano (10^-9) units of the amount. The value must be @@ -3592,1143 +3855,980 @@ components: `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. - id: GoogleTypeMoney + format: int32 + GoogleCloudContentwarehouseV1TimestampTypeOptions: + properties: {} + type: object + description: Configurations for a timestamp property. + id: GoogleCloudContentwarehouseV1TimestampTypeOptions + GoogleCloudContentwarehouseV1DeleteDocumentAction: + description: Represents the action responsible for deleting the document. + id: GoogleCloudContentwarehouseV1DeleteDocumentAction type: object - description: Represents an amount of money with its currency type. - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock: properties: - text: - type: string - description: Text content stored in the block. - type: - type: string - description: >- - Type of the text in the block. Available options are: `paragraph`, - `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, - `heading-5`, `header`, `footer`. - blocks: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + enableHardDelete: description: >- - A text block could further have child blocks. Repeated blocks - support further hierarchies and nested blocks. - type: array - id: >- - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock + Boolean field to select between hard vs soft delete options. Set + 'true' for 'hard delete' and 'false' for 'soft delete'. + type: boolean + GoogleCloudContentwarehouseV1RuleSet: + description: Represents a set of rules from a single customer. + id: GoogleCloudContentwarehouseV1RuleSet type: object - description: Represents a text type block. - GoogleCloudContentwarehouseV1AddToFolderAction: - description: Represents the action responsible for adding document under a folder. properties: - folders: + name: + type: string description: >- - Names of the folder under which new document is to be added. Format: - projects/{project_number}/locations/{location}/documents/{document_id}. + The resource name of the rule set. Managed internally. Format: + projects/{project_number}/locations/{location}/ruleSet/{rule_set_id}. + The name is ignored when creating a rule set. + description: + description: Short description of the rule-set. + type: string + source: + type: string + description: Source of the rules i.e., customer name. + rules: type: array + description: List of rules given by the customer. items: - type: string - id: GoogleCloudContentwarehouseV1AddToFolderAction - type: object - GoogleCloudContentwarehouseV1GcsIngestWithDocAiProcessorsPipeline: - id: GoogleCloudContentwarehouseV1GcsIngestWithDocAiProcessorsPipeline + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Rule' + GoogleCloudDocumentaiV1DocumentPageMatrix: type: object + id: GoogleCloudDocumentaiV1DocumentPageMatrix description: >- - The configuration of the Cloud Storage Ingestion with DocAI Processors - pipeline. + Representation for transformation matrix, intended to be compatible and + used with OpenCV format for image manipulation. properties: - extractProcessorInfos: - type: array - description: >- - The extract processors information. One matched extract processor - will be used to process documents based on the classify processor - result. If no classify processor is specified, the first extract - processor will be used. - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ProcessorInfo' - pipelineConfig: - description: >- - Optional. The config for the Cloud Storage Ingestion with DocAI - Processors pipeline. It provides additional customization options to - run the pipeline and can be skipped if it is not applicable. - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1IngestPipelineConfig - skipIngestedDocuments: - description: >- - The flag whether to skip ingested documents. If it is set to true, - documents in Cloud Storage contains key "status" with value - "status=ingested" in custom metadata will be skipped to ingest. - type: boolean - inputPath: - type: string - description: >- - The input Cloud Storage folder. All files under this folder will be - imported to Document Warehouse. Format: `gs:///`. - splitClassifyProcessorInfo: - description: >- - The split and classify processor information. The split and classify - result will be used to find a matched extract processor. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ProcessorInfo' - processorResultsFolderPath: + data: + description: The matrix data. + format: byte type: string + rows: + format: int32 + type: integer + description: Number of rows in the matrix. + type: description: >- - The Cloud Storage folder path used to store the raw results from - processors. Format: `gs:///`. - GoogleCloudContentwarehouseV1SearchDocumentsResponseMatchingDocument: - description: Document entry with metadata inside SearchDocumentsResponse + This encodes information about what data type the matrix uses. For + example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of + OpenCV primitive data types, please refer to + https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html + type: integer + format: int32 + cols: + description: Number of columns in the matrix. + type: integer + format: int32 + GoogleCloudDocumentaiV1DocumentPageImageQualityScores: + id: GoogleCloudDocumentaiV1DocumentPageImageQualityScores type: object properties: - document: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' - description: >- - Document that matches the specified SearchDocumentsRequest. This - document only contains indexed metadata information. - qaResult: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1QAResult' - description: >- - Experimental. Additional result info if the question-answering - feature is enabled. - matchedTokenPageIndices: - items: - type: string - format: int64 + qualityScore: + type: number + format: float description: >- - Return the 1-based page indices where those pages have one or more - matched tokens. + The overall quality score. Range `[0, 1]` where `1` is perfect + quality. + detectedDefects: + description: A list of detected defects. type: array - searchTextSnippet: - type: string - description: >- - Contains snippets of text from the document full raw text that most - closely match a search query's keywords, if available. All HTML tags - in the original fields are stripped when returned in this field, and - matching query keywords are enclosed in HTML bold tags. If the - question-answering feature is enabled, this field will instead - contain a snippet that answers the user's natural-language query. No - HTML bold tags will be present, and highlights in the answer snippet - can be found in QAResult.highlights. - id: GoogleCloudContentwarehouseV1SearchDocumentsResponseMatchingDocument - GoogleCloudContentwarehouseV1PropertyTypeOptions: - description: Configurations for a nested structured data property. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect + description: Image quality scores for the page image. + GoogleCloudDocumentaiV1DocumentPageTableTableRow: + type: object + id: GoogleCloudDocumentaiV1DocumentPageTableTableRow properties: - propertyDefinitions: - description: Required. List of property definitions. + cells: + description: Cells that make up this row. type: array items: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1PropertyDefinition - id: GoogleCloudContentwarehouseV1PropertyTypeOptions - type: object - CloudAiPlatformTenantresourceInfraSpannerConfig: - type: object - description: 'The configuration for a spanner database provisioning. Next ID: 8' - id: CloudAiPlatformTenantresourceInfraSpannerConfig + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableCell + description: A row of table cells. + GoogleCloudDocumentaiV1DocumentPageDimension: + description: Dimension for the page. + id: GoogleCloudDocumentaiV1DocumentPageDimension properties: - sdlBundlePath: + height: + format: float + type: number + description: Page height. + unit: + description: Dimension unit. type: string - description: Input [Required]. The file path to the spanner SDL bundle. - createDatabaseOptions: + width: + type: number + description: Page width. + format: float + type: object + GoogleCloudContentwarehouseV1UpdateDocumentRequest: + properties: + updateOptions: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1UpdateOptions' + description: Options for the update operation. + document: + description: Required. The document to update. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' + requestMetadata: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' description: >- - Input [Optional]. The options to create a spanner database. Note: - give the right options to ensure the right KMS key access audit - logging and AxT logging in expected logging category. + The meta information collected about the end user, used to enforce + access control for the service. + cloudAiDocumentOption: + description: >- + Request Option for processing Cloud AI Document in Document + Warehouse. This field offers limited support for mapping entities + from Cloud AI Document to Warehouse Document. Please consult with + product team before using this field and other available options. $ref: >- - #/components/schemas/CloudAiPlatformTenantresourceInfraSpannerConfigCreateDatabaseOptions - spannerLocalNamePrefix: - type: string - spannerBorgServiceAccount: - type: string + #/components/schemas/GoogleCloudContentwarehouseV1CloudAIDocumentOption + description: Request message for DocumentService.UpdateDocument. + type: object + id: GoogleCloudContentwarehouseV1UpdateDocumentRequest + GoogleCloudContentwarehouseV1Rule: + type: object + id: GoogleCloudContentwarehouseV1Rule + description: Represents the rule for a content warehouse trigger. + properties: + ruleId: description: >- - Input [Optional]. The spanner borg service account for delegating - the kms key to. For example, - spanner-infra-cmek-nonprod@system.gserviceaccount.com, for the - nonprod universe. - kmsKeyReference: + ID of the rule. It has to be unique across all the examples. This is + managed internally. type: string - description: >- - Input [Optional]. The KMS key name or the KMS grant name used for - CMEK encryption. Only set this field when provisioning new Infra - Spanner databases. For existing Infra Spanner databases, this field - will be ignored because CMEK re-encryption is not supported. For - example, projects//locations//keyRings//cryptoKeys/ - spannerUniverse: - description: >- - Input [Required]. Every database in Spanner can be identified by the - following path name: /span//: - type: string - spannerNamespace: - type: string - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell: - description: Represents a cell in a table row. - id: >- - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell - properties: - colSpan: - type: integer - format: int32 - description: How many columns this cell spans. - blocks: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock - type: array - description: >- - A table cell is a list of blocks. Repeated blocks support further - hierarchies and nested blocks. - rowSpan: - type: integer - description: How many rows this cell spans. - format: int32 - type: object - GoogleCloudContentwarehouseV1RunPipelineMetadata: - properties: - gcsIngestPipelineMetadata: - description: The pipeline metadata for GcsIngest pipeline. - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1RunPipelineMetadataGcsIngestPipelineMetadata - exportToCdwPipelineMetadata: - description: The pipeline metadata for Export-to-CDW pipeline. - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1RunPipelineMetadataExportToCdwPipelineMetadata - failedFileCount: - format: int32 - description: Number of files that have failed at some point in the pipeline. - type: integer - individualDocumentStatuses: + actions: items: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1RunPipelineMetadataIndividualDocumentStatus - description: The list of response details of each document. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Action' type: array - totalFileCount: - format: int32 - type: integer - description: Number of files that were processed by the pipeline. - userInfo: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1UserInfo' - description: User unique identification and groups information. - processWithDocAiPipelineMetadata: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1RunPipelineMetadataProcessWithDocAiPipelineMetadata - description: The pipeline metadata for Process-with-DocAi pipeline. - id: GoogleCloudContentwarehouseV1RunPipelineMetadata - type: object - description: Metadata message of RunPipeline method. - GoogleCloudContentwarehouseV1UpdateOptions: - properties: - updateMask: + description: List of actions that are executed when the rule is satisfied. + triggerType: + enum: + - UNKNOWN + - ON_CREATE + - ON_UPDATE + - ON_CREATE_LINK + - ON_DELETE_LINK + enumDescriptions: + - Trigger for unknown action. + - Trigger for create document action. + - Trigger for update document action. + - Trigger for create link action. + - Trigger for delete link action. + description: Identifies the trigger type for running the policy. + type: string + description: type: string + description: Short description of the rule and its context. + condition: description: >- - Field mask for merging Document fields. For the `FieldMask` - definition, see - https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask - format: google-fieldmask - mergeFieldsOptions: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1MergeFieldsOptions' - description: Options for merging. - updateType: - enumDescriptions: - - Defaults to full replace behavior, ie. FULL_REPLACE. - - >- - Fully replace all the fields (including previously linked raw - document). Any field masks will be ignored. - - Merge the fields into the existing entities. - - Inserts the properties by names. - - Replace the properties by names. - - Delete the properties by names. - - >- - For each of the property, replaces the property if the it exists, - otherwise inserts a new property. And for the rest of the fields, - merge them based on update mask and merge fields options. - enum: - - UPDATE_TYPE_UNSPECIFIED - - UPDATE_TYPE_REPLACE - - UPDATE_TYPE_MERGE - - UPDATE_TYPE_INSERT_PROPERTIES_BY_NAMES - - UPDATE_TYPE_REPLACE_PROPERTIES_BY_NAMES - - UPDATE_TYPE_DELETE_PROPERTIES_BY_NAMES - - UPDATE_TYPE_MERGE_AND_REPLACE_OR_INSERT_PROPERTIES_BY_NAMES + Represents the conditional expression to be evaluated. Expression + should evaluate to a boolean result. When the condition is true + actions are executed. Example: user_role = "hsbc_role_1" AND + doc.salary > 20000 type: string - description: Type for update. - description: Options for Update operations. + GoogleCloudDocumentaiV1Document: + id: GoogleCloudDocumentaiV1Document + description: >- + Document represents the canonical document resource in Document AI. It + is an interchange format that provides insights into documents and + allows for collaboration between users and Document AI to iterate and + optimize for quality. type: object - id: GoogleCloudContentwarehouseV1UpdateOptions - GoogleCloudContentwarehouseV1GcsIngestPipeline: - description: The configuration of the Cloud Storage Ingestion pipeline. properties: - inputPath: - type: string + entityRelations: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntityRelation' + type: array + description: Placeholder. Relationship among Document.entities. + error: + description: Any error that occurred while processing this document. + $ref: '#/components/schemas/GoogleRpcStatus' + chunkedDocument: + description: Document chunked based on chunking config. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocument' + textStyles: + deprecated: true + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentStyle' + description: Styles for the Document.text. + type: array + revisions: + type: array + description: Placeholder. Revision history of this document. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentRevision' + textChanges: description: >- - The input Cloud Storage folder. All files under this folder will be - imported to Document Warehouse. Format: `gs:///`. - processorType: + Placeholder. A list of text corrections made to Document.text. This + is usually used for annotating corrections to OCR mistakes. Text + changes for a given revision may not overlap with each other. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextChange' + type: array + uri: type: string description: >- - The Doc AI processor type name. Only used when the format of - ingested files is Doc AI Document proto format. - skipIngestedDocuments: - type: boolean - description: >- - The flag whether to skip ingested documents. If it is set to true, - documents in Cloud Storage contains key "status" with value - "status=ingested" in custom metadata will be skipped to ingest. - schemaName: + Optional. Currently supports Google Cloud Storage URI of the form + `gs://bucket_name/object_name`. Object versioning is not supported. + For more information, refer to [Google Cloud Storage Request + URIs](https://cloud.google.com/storage/docs/reference-uris). + documentLayout: + description: Parsed layout of the document. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayout' + shardInfo: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentShardInfo' description: >- - The Document Warehouse schema resource name. All documents processed - by this pipeline will use this schema. Format: - projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. + Information about the sharding if this document is sharded part of a + larger document. If the document is not sharded, this message is not + specified. + mimeType: type: string - pipelineConfig: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1IngestPipelineConfig description: >- - Optional. The config for the Cloud Storage Ingestion pipeline. It - provides additional customization options to run the pipeline and - can be skipped if it is not applicable. - id: GoogleCloudContentwarehouseV1GcsIngestPipeline - type: object - GoogleCloudContentwarehouseV1RunPipelineMetadataExportToCdwPipelineMetadata: - id: >- - GoogleCloudContentwarehouseV1RunPipelineMetadataExportToCdwPipelineMetadata - properties: - outputPath: - type: string - description: The output Cloud Storage folder in this pipeline. - docAiDataset: - description: The output CDW dataset resource name. + An IANA published [media type (MIME + type)](https://www.iana.org/assignments/media-types/media-types.xhtml). + content: type: string - documents: description: >- - The input list of all the resource names of the documents to be - exported. + Optional. Inline document content, represented as a stream of bytes. + Note: As with all `bytes` fields, protobuffers use a pure binary + representation, whereas JSON representations use base64. + format: byte + pages: type: array + description: Visual page layout for the Document. items: - type: string - type: object - description: The metadata message for Export-to-CDW pipeline. - GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment: - properties: - endIndex: - type: string - description: TextSegment half open end UTF-8 char index in the Document.text. - format: int64 - startIndex: - format: int64 + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPage' + text: + description: Optional. UTF-8 encoded text in reading order from the document. type: string - description: TextSegment start UTF-8 char index in the Document.text. - id: GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment + entities: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntity' + type: array + description: >- + A list of entities detected on Document.text. For document shards, + entities in this list may cross shard boundaries. + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock: description: >- - A text segment in the Document.text. The indices may be out of bounds - which indicate that the text extends into another document shard for - large sharded documents. See ShardInfo.text_offset + Represents a block. A block could be one of the various types (text, + table, list) supported. type: object - GoogleCloudContentwarehouseV1Property: - description: Property of a document. + id: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock properties: - timestampValues: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TimestampArray' - description: >- - Timestamp property values. It is not supported by CMEK compliant - deployment. - enumValues: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1EnumArray' - description: Enum property values. - dateTimeValues: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DateTimeArray' - description: >- - Date time property values. It is not supported by CMEK compliant - deployment. - propertyValues: - description: Nested structured data property values. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1PropertyArray' - mapProperty: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1MapProperty' - description: Map property values. - textValues: - description: String/text property values. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TextArray' - integerValues: - description: Integer property values. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1IntegerArray' - floatValues: - description: Float property values. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1FloatArray' - name: - description: >- - Required. Must match the name of a PropertyDefinition in the - DocumentSchema. - type: string - type: object - id: GoogleCloudContentwarehouseV1Property - GoogleCloudContentwarehouseV1Value: - properties: - enumValue: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1EnumValue' - description: Represents an enum value. - datetimeValue: - $ref: '#/components/schemas/GoogleTypeDateTime' - description: Represents a datetime value. - floatValue: - type: number - description: Represents a float value. - format: float - timestampValue: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TimestampValue' - description: Represents a timestamp value. - booleanValue: - type: boolean - description: Represents a boolean value. - intValue: - description: Represents a integer value. - type: integer - format: int32 - stringValue: - description: Represents a string value. + pageSpan: + description: Page span of the block. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan + tableBlock: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock + description: Block consisting of table content/structure. + listBlock: + description: Block consisting of list content/structure. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock + textBlock: + description: Block consisting of text content. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock + blockId: type: string - type: object - description: >- - `Value` represents a dynamically typed value which can be either be a - float, a integer, a string, or a datetime value. A producer of value is - expected to set one of these variants. Absence of any variant indicates - an error. - id: GoogleCloudContentwarehouseV1Value + description: ID of the block. GoogleCloudContentwarehouseV1MapTypeOptions: type: object - id: GoogleCloudContentwarehouseV1MapTypeOptions - properties: {} description: Configurations for a Map property. - GoogleCloudContentwarehouseV1beta1UpdateDocumentMetadata: - type: object - description: Metadata object for UpdateDocument request (currently empty). - id: GoogleCloudContentwarehouseV1beta1UpdateDocumentMetadata + id: GoogleCloudContentwarehouseV1MapTypeOptions properties: {} - GoogleCloudContentwarehouseV1RemoveFromFolderAction: - type: object - description: >- - Represents the action responsible for remove a document from a specific - folder. + GoogleCloudContentwarehouseV1QAResult: properties: - folder: - type: string + confidenceScore: description: >- - Name of the folder under which new document is to be added. Format: - projects/{project_number}/locations/{location}/documents/{document_id}. - condition: - description: Condition of the action to be executed. - type: string - id: GoogleCloudContentwarehouseV1RemoveFromFolderAction - GoogleCloudContentwarehouseV1HistogramQueryPropertyNameFilter: - properties: - documentSchemas: - items: - type: string + The calibrated confidence score for this document, in the range [0., + 1.]. This represents the confidence level for whether the returned + document and snippet answers the user's query. + format: float + type: number + highlights: type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1QAResultHighlight + description: Highlighted sections in the snippet. + id: GoogleCloudContentwarehouseV1QAResult + description: Additional result info for the question-answering feature. + type: object + GoogleCloudContentwarehouseV1DocumentLink: + id: GoogleCloudContentwarehouseV1DocumentLink + properties: + targetDocumentReference: + description: Document references of the target document. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentReference' + state: description: >- - This filter specifies the exact document schema(s) - Document.document_schema_name to run histogram query against. It is - optional. It will perform histogram for property names for all the - document schemas if it is not set. At most 10 document schema names - are allowed. Format: - projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. - yAxis: - description: >- - By default, the y_axis is HISTOGRAM_YAXIS_DOCUMENT if this field is - not set. + The state of the documentlink. If target node has been deleted, the + link is marked as invalid. Removing a source node will result in + removal of all associated links. type: string enumDescriptions: - - Count the documents per property name. - - Count the properties per property name. + - Unknown state of documentlink. + - The documentlink has both source and target documents detected. + - >- + Target document is deleted, and mark the documentlink as + soft-deleted. enum: - - HISTOGRAM_YAXIS_DOCUMENT - - HISTOGRAM_YAXIS_PROPERTY - propertyNames: - items: - type: string - type: array + - STATE_UNSPECIFIED + - ACTIVE + - SOFT_DELETED + description: + type: string + description: Description of this document-link. + name: + type: string description: >- - It is optional. It will perform histogram for all the property names - if it is not set. The properties need to be defined with the - is_filterable flag set to true and the name of the property should - be in the format: "schemaId.propertyName". The property needs to be - defined in the schema. Example: the schema id is abc. Then the name - of property for property MORTGAGE_TYPE will be "abc.MORTGAGE_TYPE". + Name of this document-link. It is required that the parent derived + form the name to be consistent with the source document reference. + Otherwise an exception will be thrown. Format: + projects/{project_number}/locations/{location}/documents/{source_document_id}/documentLinks/{document_link_id}. + sourceDocumentReference: + description: Document references of the source document. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentReference' + updateTime: + type: string + format: google-datetime + readOnly: true + description: Output only. The time when the documentLink is last updated. + createTime: + type: string + readOnly: true + description: Output only. The time when the documentLink is created. + format: google-datetime type: object - id: GoogleCloudContentwarehouseV1HistogramQueryPropertyNameFilter - GoogleCloudDocumentaiV1DocumentEntity: + description: A document-link between source and target document. + GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader: properties: - mentionText: - description: Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`. - type: string - type: - description: Required. Entity type from a schema e.g. `Address`. + text: + description: Header in text format. type: string - redacted: - type: boolean + pageSpan: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan + description: Page span of the header. + type: object + id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader + description: Represents the page header associated with the chunk. + GoogleCloudContentwarehouseV1GcsIngestPipeline: + id: GoogleCloudContentwarehouseV1GcsIngestPipeline + description: The configuration of the Cloud Storage Ingestion pipeline. + type: object + properties: + pipelineConfig: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1IngestPipelineConfig description: >- - Optional. Whether the entity will be redacted for de-identification - purposes. - normalizedValue: + Optional. The config for the Cloud Storage Ingestion pipeline. It + provides additional customization options to run the pipeline and + can be skipped if it is not applicable. + inputPath: description: >- - Optional. Normalized entity value. Absent if the extracted value - could not be converted or the type (e.g. address) is not supported - for certain parsers. This field is also only populated for certain - supported document types. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentEntityNormalizedValue - mentionId: - description: Optional. Deprecated. Use `id` field instead. + The input Cloud Storage folder. All files under this folder will be + imported to Document Warehouse. Format: `gs:///`. type: string - id: + schemaName: + description: >- + The Document Warehouse schema resource name. All documents processed + by this pipeline will use this schema. Format: + projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. + type: string + processorType: type: string description: >- - Optional. Canonical id. This will be a unique value in the entity - list for this document. - provenance: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - description: Optional. The history of this annotation. - properties: + The Doc AI processor type name. Only used when the format of + ingested files is Doc AI Document proto format. + skipIngestedDocuments: description: >- - Optional. Entities can be nested to form a hierarchical data - structure representing the content in the document. - type: array + The flag whether to skip ingested documents. If it is set to true, + documents in Cloud Storage contains key "status" with value + "status=ingested" in custom metadata will be skipped to ingest. + type: boolean + GoogleCloudContentwarehouseV1PropertyTypeOptions: + properties: + propertyDefinitions: items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntity' - confidence: - type: number - description: Optional. Confidence of detected Schema entity. Range `[0, 1]`. - format: float - textAnchor: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' - description: >- - Optional. Provenance of the entity. Text anchor indexing into the - Document.text. - pageAnchor: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageAnchor' - description: >- - Optional. Represents the provenance of this entity wrt. the location - on the page where it was found. - description: >- - An entity that could be a phrase in the text or a property that belongs - to the document. It is a known entity type, such as a person, an - organization, or location. - id: GoogleCloudDocumentaiV1DocumentEntity + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1PropertyDefinition + type: array + description: Required. List of property definitions. type: object - GoogleCloudContentwarehouseV1ExportToCdwPipeline: - description: >- - The configuration of exporting documents from the Document Warehouse to - CDW pipeline. - id: GoogleCloudContentwarehouseV1ExportToCdwPipeline + description: Configurations for a nested structured data property. + id: GoogleCloudContentwarehouseV1PropertyTypeOptions + GoogleCloudContentwarehouseV1Document: properties: - docAiDataset: - description: >- - Optional. The CDW dataset resource name. This field is optional. If - not set, the documents will be exported to Cloud Storage only. - Format: - projects/{project}/locations/{location}/processors/{processor}/dataset + updateTime: + description: Output only. The time when the document is last updated. + readOnly: true type: string - exportFolderPath: + format: google-datetime + cloudAiDocument: + description: Document AI format to save the structured content, including OCR. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Document' + documentSchemaName: description: >- - The Cloud Storage folder path used to store the exported documents - before being sent to CDW. Format: `gs:///`. + The Document schema name. Format: + projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. type: string - trainingSplitRatio: - format: float - type: number + plainText: + type: string + description: Other document format, such as PPTX, XLXS + referenceId: description: >- - Ratio of training dataset split. When importing into Document AI - Workbench, documents will be automatically split into training and - test split category with the specified ratio. This field is required - if doc_ai_dataset is set. - documents: + The reference ID set by customers. Must be unique per project and + location. + type: string + rawDocumentFileType: + enum: + - RAW_DOCUMENT_FILE_TYPE_UNSPECIFIED + - RAW_DOCUMENT_FILE_TYPE_PDF + - RAW_DOCUMENT_FILE_TYPE_DOCX + - RAW_DOCUMENT_FILE_TYPE_XLSX + - RAW_DOCUMENT_FILE_TYPE_PPTX + - RAW_DOCUMENT_FILE_TYPE_TEXT + - RAW_DOCUMENT_FILE_TYPE_TIFF description: >- - The list of all the resource names of the documents to be processed. - Format: - projects/{project_number}/locations/{location}/documents/{document_id}. - items: - type: string - type: array - type: object - GoogleCloudContentwarehouseV1RunPipelineMetadataIndividualDocumentStatus: - id: GoogleCloudContentwarehouseV1RunPipelineMetadataIndividualDocumentStatus - description: The status of processing a document. - type: object - properties: - status: - description: The status processing the document. - $ref: '#/components/schemas/GoogleRpcStatus' - documentId: + This is used when DocAI was not used to load the document and + parsing/ extracting is needed for the inline_raw_document. For + example, if inline_raw_document is the byte representation of a PDF + file, then this should be set to: RAW_DOCUMENT_FILE_TYPE_PDF. + enumDescriptions: + - No raw document specified or it is non-parsable + - Adobe PDF format + - Microsoft Word format + - Microsoft Excel format + - Microsoft Powerpoint format + - UTF-8 encoded text format + - TIFF or TIF image file format type: string - description: Document identifier of an existing document. - GoogleCloudDocumentaiV1DocumentPageLayout: - type: object - properties: - textAnchor: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' - description: Text anchor indexing into the Document.text. - confidence: + updater: + description: The user who lastly updates the document. + type: string + textExtractionDisabled: + deprecated: true + description: If true, text extraction will not be performed. + type: boolean + contentCategory: description: >- - Confidence of the current Layout within context of the object this - layout is for. e.g. confidence can be for a single token, a table, a - visual element, etc. depending on context. Range `[0, 1]`. - format: float - type: number - orientation: - description: Detected orientation for the Layout. + Indicates the category (image, audio, video etc.) of the original + content. enum: - - ORIENTATION_UNSPECIFIED - - PAGE_UP - - PAGE_RIGHT - - PAGE_DOWN - - PAGE_LEFT - type: string + - CONTENT_CATEGORY_UNSPECIFIED + - CONTENT_CATEGORY_IMAGE + - CONTENT_CATEGORY_AUDIO + - CONTENT_CATEGORY_VIDEO enumDescriptions: - - Unspecified orientation. - - Orientation is aligned with page up. - - >- - Orientation is aligned with page right. Turn the head 90 degrees - clockwise from upright to read. - - >- - Orientation is aligned with page down. Turn the head 180 degrees - from upright to read. - - >- - Orientation is aligned with page left. Turn the head 90 degrees - counterclockwise from upright to read. - boundingPoly: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1BoundingPoly' - description: The bounding polygon for the Layout. - description: Visual element describing a layout unit on a page. - id: GoogleCloudDocumentaiV1DocumentPageLayout - GoogleCloudDocumentaiV1DocumentRevisionHumanReview: - id: GoogleCloudDocumentaiV1DocumentRevisionHumanReview - properties: - stateMessage: + - No category is specified. + - Content is of image type. + - Content is of audio type. + - Content is of video type. type: string - description: >- - A message providing more details about the current state of - processing. For example, the rejection reason when the state is - `rejected`. - state: + creator: + type: string + description: The user who creates the document. + displayUri: + type: string + description: Uri to display the document, for example, in the UI. + rawDocumentPath: + type: string + description: Raw document file in Cloud Storage path. + name: type: string - description: Human review state. e.g. `requested`, `succeeded`, `rejected`. - type: object - description: Human Review information of the document. - CloudAiPlatformTenantresourceGcsBucketConfig: - id: CloudAiPlatformTenantresourceGcsBucketConfig - properties: - admins: - items: - type: string - type: array - bucketName: description: >- - Input/Output [Optional]. The name of a GCS bucket with max length of - 63 chars. If not set, a random UUID will be generated as bucket - name. + The resource name of the document. Format: + projects/{project_number}/locations/{location}/documents/{document_id}. + The name is ignored when creating a document. + createTime: + readOnly: true + format: google-datetime type: string - kmsKeyReference: + description: Output only. The time when the document is created. + dispositionTime: + readOnly: true + type: string + format: google-datetime description: >- - Input/Output [Optional]. The KMS key name or the KMS grant name used - for CMEK encryption. Only set this field when provisioning new GCS - bucket. For existing GCS bucket, this field will be ignored because - CMEK re-encryption is not supported. + Output only. If linked to a Collection with RetentionPolicy, the + date when the document becomes mutable. + displayName: + description: >- + Required. Display name of the document given by the user. This name + will be displayed in the UI. Customer can populate this field with + the name of the document. This differs from the 'title' field as + 'title' is optional and stores the top heading in the document. type: string - viewers: - description: Input/Output [Required]. IAM roles (viewer/admin) put on the bucket. - items: - type: string + textExtractionEnabled: + type: boolean + description: If true, text extraction will be performed. + properties: type: array - ttlDays: - type: integer - description: >- - Input/Output [Optional]. Only needed when the content in bucket need - to be garbage collected within some amount of days. - format: int32 - entityName: + items: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Property' + description: List of values that are user supplied metadata. + legalHold: + type: boolean + readOnly: true + description: Output only. Indicates if the document has a legal hold on it. + title: type: string description: >- - Input/Output [Optional]. Only needed for per-entity tenant GCP - resources. During Deprovision API, the on-demand deletion will only - cover the tenant GCP resources with the specified entity name. - description: The identity to configure a GCS bucket. - type: object - GoogleCloudDocumentaiV1DocumentPageMatrix: - type: object - id: GoogleCloudDocumentaiV1DocumentPageMatrix - properties: - data: - description: The matrix data. + Title that describes the document. This can be the top heading or + text that describes the document. + inlineRawDocument: type: string format: byte - cols: - description: Number of columns in the matrix. - type: integer - format: int32 - rows: - format: int32 - type: integer - description: Number of rows in the matrix. - type: - format: int32 - description: >- - This encodes information about what data type the matrix uses. For - example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of - OpenCV primitive data types, please refer to - https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html - type: integer - description: >- - Representation for transformation matrix, intended to be compatible and - used with OpenCV format for image manipulation. - GoogleCloudDocumentaiV1DocumentPageAnchor: - id: GoogleCloudDocumentaiV1DocumentPageAnchor - properties: - pageRefs: - description: One or more references to visual page elements - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageAnchorPageRef + description: Raw document content. + id: GoogleCloudContentwarehouseV1Document + description: Defines the structure for content warehouse document proto. type: object + GoogleCloudContentwarehouseV1ProjectStatus: description: >- - Referencing the visual context of the entity in the Document.pages. Page - anchors can be cross-page, consist of multiple bounding polygons and - optionally reference specific layout element types. - GoogleCloudContentwarehouseV1UserInfo: - properties: - id: - type: string - description: >- - A unique user identification string, as determined by the client. - The maximum number of allowed characters is 255. Allowed characters - include numbers 0 to 9, uppercase and lowercase letters, and - restricted special symbols (:, @, +, -, _, ~) The format is - "user:xxxx@example.com"; - groupIds: - type: array - description: >- - The unique group identifications which the user is belong to. The - format is "group:yyyy@example.com"; - items: - type: string + Status of a project, including the project state, dbType, aclMode and + etc. type: object - description: The user information. - id: GoogleCloudContentwarehouseV1UserInfo - GoogleCloudDocumentaiV1DocumentTextAnchor: properties: - textSegments: - type: array - description: The text segments from the Document.text. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment - content: - description: >- - Contains the content of the text span so that users do not have to - look it up in the text_segments. It is always populated for - formFields. + qaEnabled: + type: boolean + description: If the qa is enabled on this project. + documentCreatorDefaultRole: + description: The default role for the person who create a document. type: string + accessControlMode: + type: string + enum: + - ACL_MODE_UNKNOWN + - ACL_MODE_UNIVERSAL_ACCESS + - ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_BYOID + - ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_GCI + description: Access control mode. + enumDescriptions: + - This value is required by protobuf best practices + - 'Universal Access: No document level access control.' + - Document level access control with customer own Identity Service. + - Document level access control using Google Cloud Identity. + location: + description: The location of the queried project. + type: string + state: + description: State of the project. + enum: + - PROJECT_STATE_UNSPECIFIED + - PROJECT_STATE_PENDING + - PROJECT_STATE_COMPLETED + - PROJECT_STATE_FAILED + - PROJECT_STATE_DELETING + - PROJECT_STATE_DELETING_FAILED + - PROJECT_STATE_DELETED + - PROJECT_STATE_NOT_FOUND + enumDescriptions: + - Default status, required by protobuf best practices. + - The project is in the middle of a provision process. + - All dependencies have been provisioned. + - A provision process was previously initiated, but failed. + - The project is in the middle of a deletion process. + - A deleting process was initiated, but failed. + - The project is deleted. + - The project is not found. + type: string + databaseType: + enumDescriptions: + - This value is required by protobuf best practices + - Internal Spanner + - Cloud Sql with a Postgres Sql instance + enumDeprecated: + - false + - false + - true + type: string + enum: + - DB_UNKNOWN + - DB_INFRA_SPANNER + - DB_CLOUD_SQL_POSTGRES + description: Database type. + id: GoogleCloudContentwarehouseV1ProjectStatus + GoogleCloudDocumentaiV1DocumentProvenanceParent: + description: >- + The parent element the current element is based on. Used for + referencing/aligning, removal and replacement operations. type: object - description: Text reference indexing into the Document.text. - id: GoogleCloudDocumentaiV1DocumentTextAnchor - GoogleCloudContentwarehouseV1UpdateDocumentRequest: - type: object - description: Request message for DocumentService.UpdateDocument. + id: GoogleCloudDocumentaiV1DocumentProvenanceParent properties: - cloudAiDocumentOption: - description: >- - Request Option for processing Cloud AI Document in Document - Warehouse. This field offers limited support for mapping entities - from Cloud AI Document to Warehouse Document. Please consult with - product team before using this field and other available options. - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1CloudAIDocumentOption - updateOptions: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1UpdateOptions' - description: Options for the update operation. - document: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' - description: Required. The document to update. - requestMetadata: + index: + type: integer + format: int32 description: >- - The meta information collected about the end user, used to enforce - access control for the service. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' - id: GoogleCloudContentwarehouseV1UpdateDocumentRequest - GoogleCloudContentwarehouseV1IntegerTypeOptions: + The index of the parent item in the corresponding item list (eg. + list of entities, properties within entities, etc.) in the parent + revision. + id: + deprecated: true + type: integer + format: int32 + description: The id of the parent provenance. + revision: + type: integer + format: int32 + description: The index of the index into current revision's parent_ids list. + GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter: type: object - description: Configurations for an integer property. - id: GoogleCloudContentwarehouseV1IntegerTypeOptions - properties: {} - CloudAiPlatformTenantresourceIamPolicyBinding: - description: >- - The dynamic IAM bindings to be granted after tenant projects are - created. + description: Represents the page footer associated with the chunk. + id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter properties: - resourceType: - enum: - - RESOURCE_TYPE_UNSPECIFIED - - PROJECT - - SERVICE_ACCOUNT - - GCS_BUCKET - - SERVICE_CONSUMER - - AR_REPO - description: >- - Input/Output [Required]. Specifies the type of resource that will be - accessed by members. - enumDescriptions: - - '' - - >- - The value of resource field is the ID or number of a project. - Format is - - >- - The value of resource field is the resource name of a service - account. Format is projects//serviceAccounts/ - - >- - The value of resource field is the name of a GCS bucket (not its - resource name). Format is . - - >- - The value of resource field is the resource name of a service - consumer. Format is services//consumers/ - - >- - The value of the resource field is the AR Image Uri which - identifies an AR REPO. Allowed formats are: /// ///: ///@ - type: string - role: - description: Input/Output [Required]. The role for members below. + pageSpan: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan + description: Page span of the footer. + text: + description: Footer in text format. type: string - members: - items: - type: string - description: >- - Input/Output [Required]. The member service accounts with the roles - above. Note: placeholders are same as the resource above. - type: array - resource: + GoogleCloudContentwarehouseV1RunPipelineMetadataIndividualDocumentStatus: + id: GoogleCloudContentwarehouseV1RunPipelineMetadataIndividualDocumentStatus + description: The status of processing a document. + properties: + documentId: type: string - description: >- - Input/Output [Required]. The resource name that will be accessed by - members, which also depends on resource_type. Note: placeholders are - supported in resource names. For example, ${tpn} will be used when - the tenant project number is not ready. + description: Document identifier of an existing document. + status: + description: The status processing the document. + $ref: '#/components/schemas/GoogleRpcStatus' type: object - id: CloudAiPlatformTenantresourceIamPolicyBinding - GoogleCloudContentwarehouseV1ListSynonymSetsResponse: - id: GoogleCloudContentwarehouseV1ListSynonymSetsResponse - description: Response message for SynonymSetService.ListSynonymSets. + GoogleRpcStatus: + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). type: object properties: - synonymSets: - description: The synonymSets from the specified parent. + code: + format: int32 + type: integer + description: The status code, which should be an enum value of google.rpc.Code. + details: items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' - type: array - nextPageToken: - type: string + type: object + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any description: >- - A page token, received from a previous `ListSynonymSets` call. - Provide this to retrieve the subsequent page. - GoogleIamV1AuditLogConfig: - id: GoogleIamV1AuditLogConfig - type: object - properties: - exemptedMembers: - items: - type: string + A list of messages that carry the error details. There is a common + set of message types for APIs to use. type: array + message: description: >- - Specifies the identities that do not cause logging for this type of - permission. Follows the same format of Binding.members. - logType: - enumDescriptions: - - Default case. Should never be this. - - 'Admin reads. Example: CloudIAM getIamPolicy' - - 'Data writes. Example: CloudSQL Users create' - - 'Data reads. Example: CloudSQL Users list' - description: The log type that this config enables. - enum: - - LOG_TYPE_UNSPECIFIED - - ADMIN_READ - - DATA_WRITE - - DATA_READ + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. type: string - 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. + id: GoogleRpcStatus GoogleCloudContentwarehouseV1CreateDocumentMetadata: - description: Metadata object for CreateDocument request (currently empty). - type: object id: GoogleCloudContentwarehouseV1CreateDocumentMetadata + description: Metadata object for CreateDocument request (currently empty). properties: {} - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry: - properties: - blocks: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock - description: >- - A list entry is a list of blocks. Repeated blocks support further - hierarchies and nested blocks. - type: array - description: Represents an entry in the list. type: object - id: >- - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry - GoogleCloudDocumentaiV1DocumentPageBlock: + GoogleCloudDocumentaiV1DocumentTextAnchor: type: object + id: GoogleCloudDocumentaiV1DocumentTextAnchor + description: Text reference indexing into the Document.text. properties: - provenance: - description: The history of this annotation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - deprecated: true - detectedLanguages: + textSegments: + description: The text segments from the Document.text. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + #/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment type: array - description: A list of detected languages together with confidence. - layout: - description: Layout for Block. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: >- - A block has a set of lines (collected into paragraphs) that have a - common line-spacing and orientation. - id: GoogleCloudDocumentaiV1DocumentPageBlock + content: + description: >- + Contains the content of the text span so that users do not have to + look it up in the text_segments. It is always populated for + formFields. + type: string GoogleCloudContentwarehouseV1ProcessorInfo: - description: The DocAI processor information. - id: GoogleCloudContentwarehouseV1ProcessorInfo properties: - schemaName: + documentType: + description: The processor will process the documents with this document type. type: string - description: >- - The Document schema resource name. All documents processed by this - processor will use this schema. Format: - projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. processorName: description: >- The processor resource name. Format is `projects/{project}/locations/{location}/processors/{processor}`, or `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` type: string - documentType: - description: The processor will process the documents with this document type. + schemaName: + description: >- + The Document schema resource name. All documents processed by this + processor will use this schema. Format: + projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. type: string + id: GoogleCloudContentwarehouseV1ProcessorInfo + description: The DocAI processor information. type: object - GoogleCloudContentwarehouseV1IngestPipelineConfig: - id: GoogleCloudContentwarehouseV1IngestPipelineConfig + GoogleCloudContentwarehouseV1beta1UpdateDocumentMetadata: + properties: {} + type: object + description: Metadata object for UpdateDocument request (currently empty). + id: GoogleCloudContentwarehouseV1beta1UpdateDocumentMetadata + GoogleCloudContentwarehouseV1FileTypeFilter: type: object properties: - enableDocumentTextExtraction: - type: boolean - description: >- - The document text extraction enabled flag. If the flag is set to - true, DWH will perform text extraction on the raw document. - folder: - description: >- - Optional. The name of the folder to which all ingested documents - will be linked during ingestion process. Format is - `projects/{project}/locations/{location}/documents/{folder_id}` + fileType: + enum: + - FILE_TYPE_UNSPECIFIED + - ALL + - FOLDER + - DOCUMENT + - ROOT_FOLDER + enumDescriptions: + - Default document type. If set, disables the filter. + - Returns all document types, including folders. + - Returns only folders. + - Returns only non-folder documents. + - Returns only root folders + description: The type of files to return. type: string - documentAclPolicy: - $ref: '#/components/schemas/GoogleIamV1Policy' + id: GoogleCloudContentwarehouseV1FileTypeFilter + description: Filter for the specific types of documents returned. + GoogleCloudContentwarehouseV1CreateDocumentLinkRequest: + properties: + requestMetadata: description: >- - The document level acl policy config. This refers to an Identity and - Access (IAM) policy, which specifies access controls for all - documents ingested by the pipeline. The role and members under the - policy needs to be specified. The following roles are supported for - document level acl control: * roles/contentwarehouse.documentAdmin * - roles/contentwarehouse.documentEditor * - roles/contentwarehouse.documentViewer The following members are - supported for document level acl control: * - user:user-email@example.com * group:group-email@example.com Note - that for documents searched with LLM, only single level user or - group acl check is supported. - cloudFunction: - type: string + The meta information collected about the document creator, used to + enforce access control for the service. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' + documentLink: description: >- - The Cloud Function resource name. The Cloud Function needs to live - inside consumer project and is accessible to Document AI Warehouse - P4SA. Only Cloud Functions V2 is supported. Cloud function execution - should complete within 5 minutes or this file ingestion may fail due - to timeout. Format: - `https://{region}-{project_id}.cloudfunctions.net/{cloud_function}` - The following keys are available the request json payload. * - display_name * properties * plain_text * reference_id * - document_schema_name * raw_document_path * raw_document_file_type - The following keys from the cloud function json response payload - will be ingested to the Document AI Warehouse as part of Document - proto content and/or related information. The original values will - be overridden if any key is present in the response. * display_name - * properties * plain_text * document_acl_policy * folder - description: The ingestion pipeline config. - GoogleCloudContentwarehouseV1RunPipelineRequest: - description: Request message for DocumentService.RunPipeline. + Required. Document links associated with the source documents + (source_document_id). + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentLink' + description: Request message for DocumentLinkService.CreateDocumentLink. + id: GoogleCloudContentwarehouseV1CreateDocumentLinkRequest + type: object + GoogleCloudDocumentaiV1DocumentPageParagraph: + id: GoogleCloudDocumentaiV1DocumentPageParagraph + description: A collection of lines that a human would perceive as a paragraph. + type: object + properties: + layout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: Layout for Paragraph. + provenance: + description: The history of this annotation. + deprecated: true + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + detectedLanguages: + type: array + description: A list of detected languages together with confidence. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + GoogleCloudContentwarehouseV1CloudAIDocumentOption: + type: object + id: GoogleCloudContentwarehouseV1CloudAIDocumentOption + properties: + enableEntitiesConversions: + type: boolean + description: Whether to convert all the entities to properties. + customizedEntitiesPropertiesConversions: + description: If set, only selected entities will be converted to properties. + type: object + additionalProperties: + type: string + description: Request Option for processing Cloud AI Document in CW Document. + CloudAiPlatformTenantresourceTenantProjectConfig: properties: - requestMetadata: + policyBindings: + type: array + items: + $ref: >- + #/components/schemas/GoogleApiServiceconsumermanagementV1PolicyBinding description: >- - The meta information collected about the end user, used to enforce - access control for the service. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' - gcsIngestWithDocAiProcessorsPipeline: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1GcsIngestWithDocAiProcessorsPipeline + Input/Output [Required]. The policy bindings that are applied to the + tenant project during creation. At least one binding must have the + role `roles/owner` with either `user` or `group` type. + folder: + type: string description: >- - Use DocAI processors to process documents in Cloud Storage and - ingest them to Document Warehouse. - exportCdwPipeline: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1ExportToCdwPipeline + Input/Output [Required]. The folder that holds tenant projects and + folder-level permissions will be automatically granted to all tenant + projects under the folder. Note: the valid folder format is + `folders/{folder_number}`. + billingConfig: description: >- - Export docuemnts from Document Warehouse to CDW for training - purpose. - gcsIngestPipeline: - description: Cloud Storage ingestion pipeline. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1GcsIngestPipeline' - processWithDocAiPipeline: + Input/Output [Required]. The billing account properties to create + the tenant project. $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1ProcessWithDocAiPipeline + #/components/schemas/GoogleApiServiceconsumermanagementV1BillingConfig + services: + items: + type: string description: >- - Use a DocAI processor to process documents in Document Warehouse, - and re-ingest the updated results into Document Warehouse. + Input/Output [Required]. The API services that are enabled on the + tenant project during creation. + type: array type: object - id: GoogleCloudContentwarehouseV1RunPipelineRequest - GoogleCloudContentwarehouseV1SetAclResponse: + id: CloudAiPlatformTenantresourceTenantProjectConfig + description: The identity to configure a tenant project. + GoogleCloudDocumentaiV1DocumentPageFormField: type: object - id: GoogleCloudContentwarehouseV1SetAclResponse - description: Response message for DocumentService.SetAcl. properties: - metadata: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ResponseMetadata' + nameDetectedLanguages: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + description: A list of detected languages for name together with confidence. + correctedKeyText: description: >- - Additional information for the API invocation, such as the request - tracking id. - policy: - $ref: '#/components/schemas/GoogleIamV1Policy' - description: The policy will be attached to a resource (e.g. projecct, document). - GoogleCloudContentwarehouseV1MergeFieldsOptions: - type: object - properties: - replaceMessageFields: - type: boolean + Created for Labeling UI to export key text. If corrections were made + to the text identified by the `field_name.text_anchor`, this field + will contain the correction. + type: string + valueDetectedLanguages: + type: array + description: A list of detected languages for value together with confidence. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + provenance: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + description: The history of this annotation. + fieldValue: + description: Layout for the FormField value. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + correctedValueText: description: >- - When merging message fields, the default behavior is to merge the - content of two message fields together. If you instead want to use - the field from the source message to replace the corresponding field - in the destination message, set this flag to true. When this flag is - set, specified submessage fields that are missing in source will be - cleared in destination. - replaceRepeatedFields: - type: boolean + Created for Labeling UI to export value text. If corrections were + made to the text identified by the `field_value.text_anchor`, this + field will contain the correction. + type: string + valueType: description: >- - When merging repeated fields, the default behavior is to append - entries from the source repeated field to the destination repeated - field. If you instead want to keep only the entries from the source - repeated field, set this flag to true. If you want to replace a - repeated field within a message field on the destination message, - you must set both replace_repeated_fields and replace_message_fields - to true, otherwise the repeated fields will be appended. - id: GoogleCloudContentwarehouseV1MergeFieldsOptions - description: Options for merging updated fields. - GoogleCloudContentwarehouseV1QAResult: - type: object - description: Additional result info for the question-answering feature. - id: GoogleCloudContentwarehouseV1QAResult + If the value is non-textual, this field represents the type. Current + valid values are: - blank (this indicates the `field_value` is + normal text) - `unfilled_checkbox` - `filled_checkbox` + type: string + fieldName: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: >- + Layout for the FormField name. e.g. `Address`, `Email`, `Grand + total`, `Phone number`, etc. + id: GoogleCloudDocumentaiV1DocumentPageFormField + description: A form field detected on the page. + GoogleCloudContentwarehouseV1PublishAction: properties: - confidenceScore: - format: float + topicId: description: >- - The calibrated confidence score for this document, in the range [0., - 1.]. This represents the confidence level for whether the returned - document and snippet answers the user's query. - type: number - highlights: - description: Highlighted sections in the snippet. + The topic id in the Pub/Sub service for which messages will be + published to. + type: string + messages: + items: + type: string + type: array + description: Messages to be published. + type: object + id: GoogleCloudContentwarehouseV1PublishAction + description: >- + Represents the action responsible for publishing messages to a Pub/Sub + topic. + GoogleCloudDocumentaiV1DocumentChunkedDocument: + type: object + properties: + chunks: type: array items: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1QAResultHighlight - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan: - id: >- - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan + #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk + description: List of chunks. + description: Represents the chunks that the document is divided into. + id: GoogleCloudDocumentaiV1DocumentChunkedDocument + GoogleCloudContentwarehouseV1IntegerArray: + properties: + values: + type: array + items: + type: integer + format: int32 + description: List of integer values. type: object - description: Represents where the block starts and ends in the document. + description: Integer values. + id: GoogleCloudContentwarehouseV1IntegerArray + GoogleCloudContentwarehouseV1RunPipelineMetadata: + id: GoogleCloudContentwarehouseV1RunPipelineMetadata + description: Metadata message of RunPipeline method. properties: - pageStart: - format: int32 + individualDocumentStatuses: + items: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1RunPipelineMetadataIndividualDocumentStatus + type: array + description: The list of response details of each document. + userInfo: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1UserInfo' + description: User unique identification and groups information. + exportToCdwPipelineMetadata: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1RunPipelineMetadataExportToCdwPipelineMetadata + description: The pipeline metadata for Export-to-CDW pipeline. + gcsIngestPipelineMetadata: + description: The pipeline metadata for GcsIngest pipeline. + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1RunPipelineMetadataGcsIngestPipelineMetadata + totalFileCount: + description: Number of files that were processed by the pipeline. type: integer - description: Page where block starts in the document. - pageEnd: format: int32 - description: Page where block ends in the document. + processWithDocAiPipelineMetadata: + description: The pipeline metadata for Process-with-DocAi pipeline. + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1RunPipelineMetadataProcessWithDocAiPipelineMetadata + failedFileCount: + format: int32 + description: Number of files that have failed at some point in the pipeline. type: integer - GoogleTypeExpr: - id: GoogleTypeExpr - properties: - 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 - expression: - type: string - description: >- - Textual representation of an expression in Common Expression - Language syntax. - 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 - description: - type: string - 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: object - 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. - GoogleCloudContentwarehouseV1HistogramQueryResult: - id: GoogleCloudContentwarehouseV1HistogramQueryResult - properties: - histogram: - additionalProperties: - format: int64 + GoogleCloudContentwarehouseV1EnumTypeOptions: + description: Configurations for an enum/categorical property. + properties: + possibleValues: + items: type: string - type: object + description: Required. List of possible enum values. + type: array + validationCheckDisabled: + type: boolean description: >- - A map from the values of the facet associated with distinct values - to the number of matching entries with corresponding value. The key - format is: * (for string histogram) string values stored in the - field. - histogramQuery: - description: Requested histogram expression. - type: string - description: Histogram result that matches HistogramQuery specified in searches. + Make sure the Enum property value provided in the document is in the + possile value list during document creation. The validation check + runs by default. + id: GoogleCloudContentwarehouseV1EnumTypeOptions type: object - GoogleCloudContentwarehouseV1UpdateDocumentMetadata: - id: GoogleCloudContentwarehouseV1UpdateDocumentMetadata + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry: + description: Represents an entry in the list. type: object - properties: {} - description: Metadata object for UpdateDocument request (currently empty). + properties: + blocks: + description: >- + A list entry is a list of blocks. Repeated blocks support further + hierarchies and nested blocks. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + id: >- + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry GoogleCloudContentwarehouseV1DateTimeArray: - description: DateTime values. type: object id: GoogleCloudContentwarehouseV1DateTimeArray properties: @@ -4739,349 +4839,263 @@ components: description: >- List of datetime values. Both OffsetDateTime and ZonedDateTime are supported. - GoogleCloudContentwarehouseV1RunPipelineMetadataGcsIngestPipelineMetadata: - description: The metadata message for GcsIngest pipeline. - properties: - inputPath: - type: string - description: 'The input Cloud Storage folder in this pipeline. Format: `gs:///`.' - id: >- - GoogleCloudContentwarehouseV1RunPipelineMetadataGcsIngestPipelineMetadata - type: object - GoogleCloudContentwarehouseV1TimeFilter: + description: DateTime values. + GoogleCloudContentwarehouseV1UpdateDocumentSchemaRequest: type: object - id: GoogleCloudContentwarehouseV1TimeFilter - description: Filter on create timestamp or update timestamp of documents. + description: Request message for DocumentSchemaService.UpdateDocumentSchema. properties: - timeField: - description: >- - Specifies which time field to filter documents on. Defaults to - TimeField.UPLOAD_TIME. - enumDescriptions: - - Default value. - - Earliest document create time. - - Latest document update time. - - Time when document becomes mutable again. - type: string - enum: - - TIME_FIELD_UNSPECIFIED - - CREATE_TIME - - UPDATE_TIME - - DISPOSITION_TIME - timeRange: - $ref: '#/components/schemas/GoogleTypeInterval' - GoogleCloudContentwarehouseV1InitializeProjectResponse: - description: Response message for projectService.InitializeProject + documentSchema: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema' + description: Required. The document schema to update with. + id: GoogleCloudContentwarehouseV1UpdateDocumentSchemaRequest + GoogleCloudDocumentaiV1DocumentPageAnchor: properties: - state: - enum: - - STATE_UNSPECIFIED - - SUCCEEDED - - FAILED - - CANCELLED - - RUNNING - enumDescriptions: - - Clients should never see this. - - Finished project initialization without error. - - Finished project initialization with an error. - - Client canceled the LRO. - - Ask the customer to check the operation for results. - description: The state of the project initialization process. - type: string - message: - description: The message of the project initialization process. - type: string + pageRefs: + description: One or more references to visual page elements + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageAnchorPageRef + type: array + id: GoogleCloudDocumentaiV1DocumentPageAnchor type: object - id: GoogleCloudContentwarehouseV1InitializeProjectResponse - GoogleCloudContentwarehouseV1RuleEngineOutput: + description: >- + Referencing the visual context of the entity in the Document.pages. Page + anchors can be cross-page, consist of multiple bounding polygons and + optionally reference specific layout element types. + GoogleCloudContentwarehouseV1GcsIngestWithDocAiProcessorsPipeline: + id: GoogleCloudContentwarehouseV1GcsIngestWithDocAiProcessorsPipeline + description: >- + The configuration of the Cloud Storage Ingestion with DocAI Processors + pipeline. properties: - documentName: - description: >- - Name of the document against which the rules and actions were - evaluated. + processorResultsFolderPath: type: string - ruleEvaluatorOutput: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1RuleEvaluatorOutput description: >- - Output from Rule Evaluator containing matched, unmatched and invalid - rules. - actionExecutorOutput: + The Cloud Storage folder path used to store the raw results from + processors. Format: `gs:///`. + splitClassifyProcessorInfo: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ProcessorInfo' + description: >- + The split and classify processor information. The split and classify + result will be used to find a matched extract processor. + pipelineConfig: + description: >- + Optional. The config for the Cloud Storage Ingestion with DocAI + Processors pipeline. It provides additional customization options to + run the pipeline and can be skipped if it is not applicable. $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1ActionExecutorOutput + #/components/schemas/GoogleCloudContentwarehouseV1IngestPipelineConfig + inputPath: description: >- - Output from Action Executor containing rule and corresponding - actions execution result. - id: GoogleCloudContentwarehouseV1RuleEngineOutput - description: >- - Records the output of Rule Engine including rule evaluation and actions - result. + The input Cloud Storage folder. All files under this folder will be + imported to Document Warehouse. Format: `gs:///`. + type: string + extractProcessorInfos: + type: array + items: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ProcessorInfo' + description: >- + The extract processors information. One matched extract processor + will be used to process documents based on the classify processor + result. If no classify processor is specified, the first extract + processor will be used. + skipIngestedDocuments: + description: >- + The flag whether to skip ingested documents. If it is set to true, + documents in Cloud Storage contains key "status" with value + "status=ingested" in custom metadata will be skipped to ingest. + type: boolean type: object - GoogleCloudContentwarehouseV1EnumTypeOptions: - id: GoogleCloudContentwarehouseV1EnumTypeOptions + GoogleCloudContentwarehouseV1HistogramQueryPropertyNameFilter: type: object - description: Configurations for an enum/categorical property. properties: - possibleValues: + propertyNames: + type: array + description: >- + It is optional. It will perform histogram for all the property names + if it is not set. The properties need to be defined with the + is_filterable flag set to true and the name of the property should + be in the format: "schemaId.propertyName". The property needs to be + defined in the schema. Example: the schema id is abc. Then the name + of property for property MORTGAGE_TYPE will be "abc.MORTGAGE_TYPE". items: type: string - description: Required. List of possible enum values. - type: array - validationCheckDisabled: - type: boolean + documentSchemas: description: >- - Make sure the Enum property value provided in the document is in the - possile value list during document creation. The validation check - runs by default. - GoogleCloudContentwarehouseV1AccessControlAction: - id: GoogleCloudContentwarehouseV1AccessControlAction - description: >- - Represents the action responsible for access control list management - operations. - properties: - policy: - $ref: '#/components/schemas/GoogleIamV1Policy' + This filter specifies the exact document schema(s) + Document.document_schema_name to run histogram query against. It is + optional. It will perform histogram for property names for all the + document schemas if it is not set. At most 10 document schema names + are allowed. Format: + projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. + type: array + items: + type: string + yAxis: description: >- - Represents the new policy from which bindings are added, removed or - replaced based on the type of the operation. the policy is limited - to a few 10s of KB. - operationType: - enum: - - UNKNOWN - - ADD_POLICY_BINDING - - REMOVE_POLICY_BINDING - - REPLACE_POLICY_BINDING + By default, the y_axis is HISTOGRAM_YAXIS_DOCUMENT if this field is + not set. type: string - description: Identifies the type of operation. enumDescriptions: - - The unknown operation type. - - Adds newly given policy bindings in the existing bindings list. - - >- - Removes newly given policy bindings from the existing bindings - list. - - >- - Replaces existing policy bindings with the given policy binding - list + - Count the documents per property name. + - Count the properties per property name. + enum: + - HISTOGRAM_YAXIS_DOCUMENT + - HISTOGRAM_YAXIS_PROPERTY + id: GoogleCloudContentwarehouseV1HistogramQueryPropertyNameFilter + GoogleCloudContentwarehouseV1RunPipelineRequest: + id: GoogleCloudContentwarehouseV1RunPipelineRequest type: object - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock: - description: >- - Represents a block. A block could be one of the various types (text, - table, list) supported. properties: - textBlock: - description: Block consisting of text content. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock - pageSpan: - description: Page span of the block. + gcsIngestWithDocAiProcessorsPipeline: + description: >- + Use DocAI processors to process documents in Cloud Storage and + ingest them to Document Warehouse. $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan - blockId: - type: string - description: ID of the block. - tableBlock: - description: Block consisting of table content/structure. + #/components/schemas/GoogleCloudContentwarehouseV1GcsIngestWithDocAiProcessorsPipeline + gcsIngestPipeline: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1GcsIngestPipeline' + description: Cloud Storage ingestion pipeline. + processWithDocAiPipeline: + description: >- + Use a DocAI processor to process documents in Document Warehouse, + and re-ingest the updated results into Document Warehouse. $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock - listBlock: - description: Block consisting of list content/structure. + #/components/schemas/GoogleCloudContentwarehouseV1ProcessWithDocAiPipeline + exportCdwPipeline: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock - id: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + #/components/schemas/GoogleCloudContentwarehouseV1ExportToCdwPipeline + description: >- + Export docuemnts from Document Warehouse to CDW for training + purpose. + requestMetadata: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' + description: >- + The meta information collected about the end user, used to enforce + access control for the service. + description: Request message for DocumentService.RunPipeline. + GoogleCloudDocumentaiV1DocumentShardInfo: + id: GoogleCloudDocumentaiV1DocumentShardInfo type: object - GoogleCloudDocumentaiV1DocumentStyle: properties: - fontSize: - description: Font size. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentStyleFontSize' - fontFamily: - description: >- - Font family such as `Arial`, `Times New Roman`. - https://www.w3schools.com/cssref/pr_font_font-family.asp + shardIndex: type: string - backgroundColor: - $ref: '#/components/schemas/GoogleTypeColor' - description: Text background color. - textAnchor: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' - description: Text anchor indexing into the Document.text. - color: - description: Text color. - $ref: '#/components/schemas/GoogleTypeColor' - textDecoration: + description: The 0-based index of this shard. + format: int64 + textOffset: + format: int64 description: >- - [Text - decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). - Follows CSS standard. - type: string - fontWeight: + The index of the first character in Document.text in the overall + document global text. type: string - description: >- - [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). - Possible values are `normal`, `bold`, `bolder`, and `lighter`. - textStyle: + shardCount: type: string - description: >- - [Text - style](https://www.w3schools.com/cssref/pr_font_font-style.asp). - Possible values are `normal`, `italic`, and `oblique`. - type: object - id: GoogleCloudDocumentaiV1DocumentStyle + description: Total number of shards. + format: int64 description: >- - Annotation for common text style attributes. This adheres to CSS - conventions as much as possible. - GoogleCloudContentwarehouseV1UpdateRuleSetRequest: - properties: - ruleSet: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleSet' - description: Required. The rule set to update. - id: GoogleCloudContentwarehouseV1UpdateRuleSetRequest - type: object - description: Request message for RuleSetService.UpdateRuleSet. - GoogleCloudDocumentaiV1DocumentPageImageQualityScores: + For a large document, sharding may be performed to produce several + document shards. Each document shard contains this field to detail which + shard it is. + GoogleCloudDocumentaiV1DocumentPageTable: type: object + id: GoogleCloudDocumentaiV1DocumentPageTable + description: A table representation similar to HTML table structure. properties: - qualityScore: - description: >- - The overall quality score. Range `[0, 1]` where `1` is perfect - quality. - type: number - format: float - detectedDefects: - description: A list of detected defects. - type: array + bodyRows: items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect - description: Image quality scores for the page image. - id: GoogleCloudDocumentaiV1DocumentPageImageQualityScores - CloudAiPlatformTenantresourceTenantResource: - type: object - description: A collection of tenant resources. - id: CloudAiPlatformTenantresourceTenantResource - properties: - p4ServiceAccounts: + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableRow + type: array + description: Body rows of the table. + layout: + description: Layout for Table. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + headerRows: type: array items: $ref: >- - #/components/schemas/CloudAiPlatformTenantresourceServiceAccountIdentity - description: A list of P4 service accounts (go/p4sa) to provision or deprovision. - tenantProjectResources: + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableRow + description: Header rows of the table. + detectedLanguages: + type: array + description: A list of detected languages together with confidence. items: $ref: >- - #/components/schemas/CloudAiPlatformTenantresourceTenantProjectResource - type: array - description: >- - A list of tenant projects and tenant resources to provision or - deprovision. - GoogleCloudContentwarehouseV1HistogramQuery: - id: GoogleCloudContentwarehouseV1HistogramQuery + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + provenance: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + deprecated: true + description: The history of this table. + GoogleCloudContentwarehouseV1HistogramQueryResult: type: object - description: The histogram request. + description: Histogram result that matches HistogramQuery specified in searches. + id: GoogleCloudContentwarehouseV1HistogramQueryResult properties: - filters: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1HistogramQueryPropertyNameFilter - description: >- - Optional. Filter the result of histogram query by the property - names. It only works with histogram query - count('FilterableProperties'). It is an optional. It will perform - histogram on all the property names for all the document schemas. - Setting this field will have a better performance. - requirePreciseResultSize: - type: boolean + histogram: description: >- - Controls if the histogram query requires the return of a precise - count. Enable this flag may adversely impact performance. Defaults - to true. + A map from the values of the facet associated with distinct values + to the number of matching entries with corresponding value. The key + format is: * (for string histogram) string values stored in the + field. + additionalProperties: + format: int64 + type: string + type: object histogramQuery: - description: >- - An expression specifies a histogram request against matching - documents for searches. See SearchDocumentsRequest.histogram_queries - for details about syntax. - type: string - GoogleCloudDocumentaiV1DocumentEntityNormalizedValue: - type: object - id: GoogleCloudDocumentaiV1DocumentEntityNormalizedValue - description: Parsed and normalized entity value. - properties: - text: type: string - description: >- - Optional. An optional field to store a normalized string. For some - entity types, one of respective `structured_value` fields may also - be populated. Also not all the types of `structured_value` will be - normalized. For example, some processors may not generate `float` or - `integer` normalized text by default. Below are sample formats - mapped to structured values. - Money/Currency type (`money_value`) - is in the ISO 4217 text format. - Date type (`date_value`) is in the - ISO 8601 text format. - Datetime type (`datetime_value`) is in the - ISO 8601 text format. - integerValue: - format: int32 - description: Integer value. - type: integer - dateValue: - $ref: '#/components/schemas/GoogleTypeDate' - description: >- - Date value. Includes year, month, day. See also: - https://github.com/googleapis/googleapis/blob/master/google/type/date.proto - moneyValue: - description: >- - Money value. See also: - https://github.com/googleapis/googleapis/blob/master/google/type/money.proto - $ref: '#/components/schemas/GoogleTypeMoney' - addressValue: - description: >- - Postal address. See also: - https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto - $ref: '#/components/schemas/GoogleTypePostalAddress' - datetimeValue: - $ref: '#/components/schemas/GoogleTypeDateTime' - description: >- - DateTime value. Includes date, time, and timezone. See also: - https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto - booleanValue: - type: boolean - description: >- - Boolean value. Can be used for entities with binary values, or for - checkboxes. - floatValue: - description: Float value. - format: float - type: number - GoogleCloudContentwarehouseV1ListRuleSetsResponse: - id: GoogleCloudContentwarehouseV1ListRuleSetsResponse + description: Requested histogram expression. + GoogleCloudContentwarehouseV1FetchAclResponse: properties: - ruleSets: - type: array - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleSet' - description: The rule sets from the specified parent. - nextPageToken: - type: string + metadata: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ResponseMetadata' description: >- - A token, which can be sent as `page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. - description: Response message for RuleSetService.ListRuleSets. + Additional information for the API invocation, such as the request + tracking id. + policy: + $ref: '#/components/schemas/GoogleIamV1Policy' + description: The IAM policy. + id: GoogleCloudContentwarehouseV1FetchAclResponse + type: object + description: Response message for DocumentService.FetchAcl. + GoogleCloudContentwarehouseV1DataUpdateAction: type: object - GoogleCloudContentwarehouseV1RunPipelineMetadataProcessWithDocAiPipelineMetadata: - description: The metadata message for Process-with-DocAi pipeline. - id: >- - GoogleCloudContentwarehouseV1RunPipelineMetadataProcessWithDocAiPipelineMetadata properties: - documents: - description: >- - The input list of all the resource names of the documents to be - processed. - type: array - items: + entries: + type: object + additionalProperties: type: string - processorInfo: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ProcessorInfo' - description: The DocAI processor to process the documents with. + description: >- + Map of (K, V) -> (valid name of the field, new value of the field) + E.g., ("age", "60") entry triggers update of field age with a value + of 60. If the field is not present then new entry is added. During + update action execution, value strings will be casted to appropriate + types. + id: GoogleCloudContentwarehouseV1DataUpdateAction + description: Represents the action responsible for properties update operations. + GoogleCloudContentwarehouseV1FloatArray: + id: GoogleCloudContentwarehouseV1FloatArray + description: Float values. type: object + properties: + values: + items: + type: number + format: float + type: array + description: List of float values. parameters: + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string quotaUser: description: >- Available to use for quota purposes for server-side applications. Can be @@ -5091,33 +5105,33 @@ components: name: quotaUser schema: type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + access_token: + description: OAuth access token. in: query - name: uploadType + name: access_token schema: type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + _.xgafv: + description: V1 error format. in: query - name: upload_protocol + name: $.xgafv 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. + enum: + - '1' + - '2' + callback: + description: JSONP in: query - name: key + name: callback schema: type: string - prettyPrint: - description: Returns response with indentations and line breaks. + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: prettyPrint + name: upload_protocol schema: - type: boolean + type: string alt: description: Data format for response. in: query @@ -5128,37 +5142,25 @@ components: - json - media - proto - access_token: - description: OAuth access token. - in: query - name: access_token - schema: - type: string - _.xgafv: - description: V1 error format. + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: $.xgafv + name: oauth_token schema: type: string - enum: - - '1' - - '2' fields: description: Selector specifying which fields to include in a partial response. in: query name: fields schema: type: string - callback: - description: JSONP - in: query - name: callback - schema: - type: string - oauth_token: - description: OAuth 2.0 token for the current user. + 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: oauth_token + name: key schema: type: string x-stackQL-resources: @@ -5179,20 +5181,65 @@ components: update: [] replace: [] delete: [] - acl: - id: google.contentwarehouse.acl - name: acl - title: Acl + acls: + id: google.contentwarehouse.acls + name: acls + title: Acls methods: fetch_acl: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}:fetchAcl/post' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}:fetchAcl/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/acls/methods/fetch_acl' + insert: [] + update: [] + replace: [] + delete: [] + status: + id: google.contentwarehouse.status + name: status + title: Status + methods: + get_status: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:getStatus/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/acl/methods/fetch_acl' + - $ref: '#/components/x-stackQL-resources/status/methods/get_status' + insert: [] + update: [] + replace: [] + delete: [] + locations: + id: google.contentwarehouse.locations + name: locations + title: Locations + methods: + initialize: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:initialize/post + response: + mediaType: application/json + openAPIDocKey: '200' + run_pipeline: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:runPipeline/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] insert: [] update: [] replace: [] @@ -5216,144 +5263,105 @@ components: update: [] replace: [] delete: [] - synonym_sets: - id: google.contentwarehouse.synonym_sets - name: synonym_sets - title: Synonym_sets + document_schemas: + id: google.contentwarehouse.document_schemas + name: document_schemas + title: Document_schemas methods: - get: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1synonymSets~1{synonymSetsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documentSchemas~1{documentSchemasId}/delete response: mediaType: application/json openAPIDocKey: '200' patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1synonymSets~1{synonymSetsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documentSchemas~1{documentSchemasId}/patch response: mediaType: application/json openAPIDocKey: '200' - delete: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1synonymSets~1{synonymSetsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documentSchemas~1{documentSchemasId}/get response: mediaType: application/json openAPIDocKey: '200' - list: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1synonymSets/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documentSchemas/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.synonymSets - create: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1synonymSets/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documentSchemas/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.documentSchemas sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/synonym_sets/methods/get' - - $ref: '#/components/x-stackQL-resources/synonym_sets/methods/list' + - $ref: '#/components/x-stackQL-resources/document_schemas/methods/get' + - $ref: '#/components/x-stackQL-resources/document_schemas/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/synonym_sets/methods/create' + - $ref: '#/components/x-stackQL-resources/document_schemas/methods/create' update: - - $ref: '#/components/x-stackQL-resources/synonym_sets/methods/patch' + - $ref: '#/components/x-stackQL-resources/document_schemas/methods/patch' replace: [] delete: - - $ref: '#/components/x-stackQL-resources/synonym_sets/methods/delete' - reference_id: - id: google.contentwarehouse.reference_id - name: reference_id - title: Reference_id + - $ref: '#/components/x-stackQL-resources/document_schemas/methods/delete' + documents: + id: google.contentwarehouse.documents + name: documents + title: Documents methods: get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1referenceId~1{referenceIdId}:get/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}:get/post response: mediaType: application/json openAPIDocKey: '200' patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1referenceId~1{referenceIdId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}/patch response: mediaType: application/json openAPIDocKey: '200' - delete: + set_acl: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1referenceId~1{referenceIdId}:delete/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}:setAcl/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/reference_id/methods/get' - insert: [] - update: - - $ref: '#/components/x-stackQL-resources/reference_id/methods/patch' - replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/reference_id/methods/delete' - document_links: - id: google.contentwarehouse.document_links - name: document_links - title: Document_links - methods: - delete: + lock: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}~1documentLinks~1{documentLinksId}:delete/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}:lock/post response: mediaType: application/json openAPIDocKey: '200' - create: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}~1documentLinks/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}:delete/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/document_links/methods/create' - update: [] - replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/document_links/methods/delete' - documents_acl: - id: google.contentwarehouse.documents_acl - name: documents_acl - title: Documents_acl - methods: - fetch_acl: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}:fetchAcl/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/documents_acl/methods/fetch_acl' - insert: [] - update: [] - replace: [] - delete: [] - documents: - id: google.contentwarehouse.documents - name: documents - title: Documents - methods: linked_targets: operation: $ref: >- @@ -5361,162 +5369,182 @@ components: response: mediaType: application/json openAPIDocKey: '200' - linked_sources: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}~1linkedSources/post - response: - mediaType: application/json - openAPIDocKey: '200' - create: + search: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents:search/post response: mediaType: application/json openAPIDocKey: '200' - delete: + linked_sources: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}:delete/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}~1linkedSources/post response: mediaType: application/json openAPIDocKey: '200' - patch: + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/documents/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/documents/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/documents/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/documents/methods/delete' + document_links: + id: google.contentwarehouse.document_links + name: document_links + title: Document_links + methods: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}~1documentLinks/post response: mediaType: application/json openAPIDocKey: '200' - search: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents:search/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}~1documentLinks~1{documentLinksId}:delete/post response: mediaType: application/json openAPIDocKey: '200' - set_acl: + sqlVerbs: + select: [] + insert: + - $ref: '#/components/x-stackQL-resources/document_links/methods/create' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/document_links/methods/delete' + reference_id: + id: google.contentwarehouse.reference_id + name: reference_id + title: Reference_id + methods: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}:setAcl/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1referenceId~1{referenceIdId}:get/post response: mediaType: application/json openAPIDocKey: '200' - get: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}:get/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1referenceId~1{referenceIdId}/patch response: mediaType: application/json openAPIDocKey: '200' - lock: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}:lock/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1referenceId~1{referenceIdId}:delete/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/documents/methods/get' - insert: - - $ref: '#/components/x-stackQL-resources/documents/methods/create' + - $ref: '#/components/x-stackQL-resources/reference_id/methods/get' + insert: [] update: - - $ref: '#/components/x-stackQL-resources/documents/methods/patch' + - $ref: '#/components/x-stackQL-resources/reference_id/methods/patch' replace: [] delete: - - $ref: '#/components/x-stackQL-resources/documents/methods/delete' - document_schemas: - id: google.contentwarehouse.document_schemas - name: document_schemas - title: Document_schemas + - $ref: '#/components/x-stackQL-resources/reference_id/methods/delete' + synonym_sets: + id: google.contentwarehouse.synonym_sets + name: synonym_sets + title: Synonym_sets methods: - create: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documentSchemas/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1synonymSets~1{synonymSetsId}/get response: mediaType: application/json openAPIDocKey: '200' - list: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documentSchemas/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1synonymSets~1{synonymSetsId}/patch response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.documentSchemas delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documentSchemas~1{documentSchemasId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1synonymSets~1{synonymSetsId}/delete response: mediaType: application/json openAPIDocKey: '200' - get: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documentSchemas~1{documentSchemasId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1synonymSets/post response: mediaType: application/json openAPIDocKey: '200' - patch: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documentSchemas~1{documentSchemasId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1synonymSets/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.synonymSets sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/document_schemas/methods/get' - - $ref: '#/components/x-stackQL-resources/document_schemas/methods/list' + - $ref: '#/components/x-stackQL-resources/synonym_sets/methods/get' + - $ref: '#/components/x-stackQL-resources/synonym_sets/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/document_schemas/methods/create' + - $ref: '#/components/x-stackQL-resources/synonym_sets/methods/create' update: - - $ref: '#/components/x-stackQL-resources/document_schemas/methods/patch' + - $ref: '#/components/x-stackQL-resources/synonym_sets/methods/patch' replace: [] delete: - - $ref: '#/components/x-stackQL-resources/document_schemas/methods/delete' + - $ref: '#/components/x-stackQL-resources/synonym_sets/methods/delete' rule_sets: id: google.contentwarehouse.rule_sets name: rule_sets title: Rule_sets methods: - delete: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ruleSets~1{ruleSetsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ruleSets/post response: mediaType: application/json openAPIDocKey: '200' - get: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ruleSets~1{ruleSetsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ruleSets/get response: mediaType: application/json openAPIDocKey: '200' - patch: + objectKey: $.ruleSets + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ruleSets~1{ruleSetsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ruleSets~1{ruleSetsId}/get response: mediaType: application/json openAPIDocKey: '200' - list: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ruleSets/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ruleSets~1{ruleSetsId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.ruleSets - create: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ruleSets/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ruleSets~1{ruleSetsId}/patch response: mediaType: application/json openAPIDocKey: '200' @@ -5531,64 +5559,20 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/rule_sets/methods/delete' - status: - id: google.contentwarehouse.status - name: status - title: Status - methods: - get_status: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:getStatus/get - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/status/methods/get_status' - insert: [] - update: [] - replace: [] - delete: [] - locations: - id: google.contentwarehouse.locations - name: locations - title: Locations - methods: - initialize: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:initialize/post - response: - mediaType: application/json - openAPIDocKey: '200' - run_pipeline: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:runPipeline/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: [] paths: /v1/projects/{projectsId}:setAcl: parameters: &ref_1 - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' post: description: >- Sets the access control policy for a resource. Replaces any existing @@ -5651,14 +5635,11 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}:getStatus: parameters: *ref_1 get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: contentwarehouse.projects.locations.operations.get + description: Get the project status. + operationId: contentwarehouse.projects.locations.getStatus security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5670,7 +5651,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1ProjectStatus parameters: - in: path name: projectsId @@ -5682,18 +5664,19 @@ paths: required: true schema: type: string - - in: path - name: operationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/synonymSets/{synonymSetsId}: + /v1/projects/{projectsId}/locations/{locationsId}:initialize: parameters: *ref_1 - get: + post: description: >- - Gets a SynonymSet for a particular context. Throws a NOT_FOUND exception - if the Synonymset does not exist - operationId: contentwarehouse.projects.locations.synonymSets.get + Provisions resources for given tenant project. Returns a long running + operation. + operationId: contentwarehouse.projects.locations.initialize + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1InitializeProjectRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5705,7 +5688,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -5717,21 +5700,48 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}:runPipeline: + parameters: *ref_1 + post: + description: Run a predefined pipeline. + operationId: contentwarehouse.projects.locations.runPipeline + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1RunPipelineRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: - in: path - name: synonymSetsId + name: projectsId required: true schema: type: string - patch: + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: + parameters: *ref_1 + get: description: >- - Remove the existing SynonymSet for the context and replaces it with a - new one. Throws a NOT_FOUND exception if the SynonymSet is not found. - operationId: contentwarehouse.projects.locations.synonymSets.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: contentwarehouse.projects.locations.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5743,7 +5753,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -5756,15 +5766,18 @@ paths: schema: type: string - in: path - name: synonymSetsId + name: operationsId required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/documentSchemas/{documentSchemasId}: + parameters: *ref_1 delete: description: >- - Deletes a SynonymSet for a given context. Throws a NOT_FOUND exception - if the SynonymSet is not found. - operationId: contentwarehouse.projects.locations.synonymSets.delete + Deletes a document schema. Returns NOT_FOUND if the document schema does + not exist. Returns BAD_REQUEST if the document schema has documents + depending on it. + operationId: contentwarehouse.projects.locations.documentSchemas.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5789,15 +5802,25 @@ paths: schema: type: string - in: path - name: synonymSetsId + name: documentSchemasId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/synonymSets: - parameters: *ref_1 - get: - description: Returns all SynonymSets (for all contexts) for the specified location. - operationId: contentwarehouse.projects.locations.synonymSets.list + patch: + description: >- + Updates a Document Schema. Returns INVALID_ARGUMENT if the name of the + Document Schema is non-empty and does not equal the existing name. + Supports only appending new properties, adding new ENUM possible values, + and updating the EnumTypeOptions.validation_check_disabled flag for ENUM + possible values. Updating existing properties will result into + INVALID_ARGUMENT. + operationId: contentwarehouse.projects.locations.documentSchemas.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1UpdateDocumentSchemaRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5810,7 +5833,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1ListSynonymSetsResponse + #/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema parameters: - in: path name: projectsId @@ -5822,25 +5845,16 @@ paths: required: true schema: type: string - - in: query - name: pageToken + - in: path + name: documentSchemasId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - post: + get: description: >- - Creates a SynonymSet for a single context. Throws an ALREADY_EXISTS - exception if a synonymset already exists for the context. - operationId: contentwarehouse.projects.locations.synonymSets.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' + Gets a document schema. Returns NOT_FOUND if the document schema does + not exist. + operationId: contentwarehouse.projects.locations.documentSchemas.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5852,7 +5866,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema parameters: - in: path name: projectsId @@ -5864,17 +5879,21 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/referenceId/{referenceIdId}:get: + - in: path + name: documentSchemasId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/documentSchemas: parameters: *ref_1 post: - description: Gets a document. Returns NOT_FOUND if the document does not exist. - operationId: contentwarehouse.projects.locations.documents.referenceId.get + description: Creates a document schema. + operationId: contentwarehouse.projects.locations.documentSchemas.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1GetDocumentRequest + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5886,7 +5905,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema parameters: - in: path name: projectsId @@ -5898,24 +5918,9 @@ paths: required: true schema: type: string - - in: path - name: referenceIdId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/referenceId/{referenceIdId}: - parameters: *ref_1 - patch: - description: >- - Updates a document. Returns INVALID_ARGUMENT if the name of the document - is non-empty and does not equal the existing name. - operationId: contentwarehouse.projects.locations.documents.referenceId.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1UpdateDocumentRequest + get: + description: Lists document schemas. + operationId: contentwarehouse.projects.locations.documentSchemas.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5928,7 +5933,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1UpdateDocumentResponse + #/components/schemas/GoogleCloudContentwarehouseV1ListDocumentSchemasResponse parameters: - in: path name: projectsId @@ -5940,22 +5945,29 @@ paths: required: true schema: type: string - - in: path - name: referenceIdId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/referenceId/{referenceIdId}:delete: + /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:fetchAcl: parameters: *ref_1 post: - description: Deletes a document. Returns NOT_FOUND if the document does not exist. - operationId: contentwarehouse.projects.locations.documents.referenceId.delete + description: >- + Gets the access control policy for a resource. Returns NOT_FOUND error + if the resource does not exist. Returns an empty policy if the resource + exists but does not have a policy set. + operationId: contentwarehouse.projects.locations.documents.fetchAcl requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1DeleteDocumentRequest + #/components/schemas/GoogleCloudContentwarehouseV1FetchAclRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5967,7 +5979,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1FetchAclResponse parameters: - in: path name: projectsId @@ -5980,21 +5993,21 @@ paths: schema: type: string - in: path - name: referenceIdId + name: documentsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}/documentLinks/{documentLinksId}:delete: + /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:get: parameters: *ref_1 post: - description: Remove the link between the source and target documents. - operationId: contentwarehouse.projects.locations.documents.documentLinks.delete + description: Gets a document. Returns NOT_FOUND if the document does not exist. + operationId: contentwarehouse.projects.locations.documents.get requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1DeleteDocumentLinkRequest + #/components/schemas/GoogleCloudContentwarehouseV1GetDocumentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6006,7 +6019,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' parameters: - in: path name: projectsId @@ -6023,22 +6036,19 @@ paths: required: true schema: type: string - - in: path - name: documentLinksId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}/documentLinks: + /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}: parameters: *ref_1 - post: - description: Create a link between a source document and a target document. - operationId: contentwarehouse.projects.locations.documents.documentLinks.create + patch: + description: >- + Updates a document. Returns INVALID_ARGUMENT if the name of the document + is non-empty and does not equal the existing name. + operationId: contentwarehouse.projects.locations.documents.patch requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1CreateDocumentLinkRequest + #/components/schemas/GoogleCloudContentwarehouseV1UpdateDocumentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6050,7 +6060,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentLink' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1UpdateDocumentResponse parameters: - in: path name: projectsId @@ -6067,20 +6078,18 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:fetchAcl: + /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:setAcl: parameters: *ref_1 post: description: >- - Gets the access control policy for a resource. Returns NOT_FOUND error - if the resource does not exist. Returns an empty policy if the resource - exists but does not have a policy set. - operationId: contentwarehouse.projects.locations.documents.fetchAcl + Sets the access control policy for a resource. Replaces any existing + policy. + operationId: contentwarehouse.projects.locations.documents.setAcl requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1FetchAclRequest + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SetAclRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6093,7 +6102,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1FetchAclResponse + #/components/schemas/GoogleCloudContentwarehouseV1SetAclResponse parameters: - in: path name: projectsId @@ -6110,17 +6119,17 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}/linkedTargets: + /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:lock: parameters: *ref_1 post: - description: Return all target document-links from the document. - operationId: contentwarehouse.projects.locations.documents.linkedTargets + description: Lock the document so the document cannot be updated by other users. + operationId: contentwarehouse.projects.locations.documents.lock requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1ListLinkedTargetsRequest + #/components/schemas/GoogleCloudContentwarehouseV1LockDocumentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6132,8 +6141,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1ListLinkedTargetsResponse + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' parameters: - in: path name: projectsId @@ -6150,17 +6158,17 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}/linkedSources: + /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:delete: parameters: *ref_1 post: - description: Return all source document-links from the document. - operationId: contentwarehouse.projects.locations.documents.linkedSources + description: Deletes a document. Returns NOT_FOUND if the document does not exist. + operationId: contentwarehouse.projects.locations.documents.delete requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1ListLinkedSourcesRequest + #/components/schemas/GoogleCloudContentwarehouseV1DeleteDocumentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6172,8 +6180,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1ListLinkedSourcesResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -6225,17 +6232,17 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:delete: + /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}/linkedTargets: parameters: *ref_1 post: - description: Deletes a document. Returns NOT_FOUND if the document does not exist. - operationId: contentwarehouse.projects.locations.documents.delete + description: Return all target document-links from the document. + operationId: contentwarehouse.projects.locations.documents.linkedTargets requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1DeleteDocumentRequest + #/components/schemas/GoogleCloudContentwarehouseV1ListLinkedTargetsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6247,7 +6254,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1ListLinkedTargetsResponse parameters: - in: path name: projectsId @@ -6264,19 +6272,19 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}: + /v1/projects/{projectsId}/locations/{locationsId}/documents:search: parameters: *ref_1 - patch: + post: description: >- - Updates a document. Returns INVALID_ARGUMENT if the name of the document - is non-empty and does not equal the existing name. - operationId: contentwarehouse.projects.locations.documents.patch + Searches for documents using provided SearchDocumentsRequest. This call + only returns documents that the caller has permission to search against. + operationId: contentwarehouse.projects.locations.documents.search requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1UpdateDocumentRequest + #/components/schemas/GoogleCloudContentwarehouseV1SearchDocumentsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6289,7 +6297,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1UpdateDocumentResponse + #/components/schemas/GoogleCloudContentwarehouseV1SearchDocumentsResponse parameters: - in: path name: projectsId @@ -6301,24 +6309,17 @@ paths: required: true schema: type: string - - in: path - name: documentsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents:search: + /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}/linkedSources: parameters: *ref_1 post: - description: >- - Searches for documents using provided SearchDocumentsRequest. This call - only returns documents that the caller has permission to search against. - operationId: contentwarehouse.projects.locations.documents.search + description: Return all source document-links from the document. + operationId: contentwarehouse.projects.locations.documents.linkedSources requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1SearchDocumentsRequest + #/components/schemas/GoogleCloudContentwarehouseV1ListLinkedSourcesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6331,7 +6332,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1SearchDocumentsResponse + #/components/schemas/GoogleCloudContentwarehouseV1ListLinkedSourcesResponse parameters: - in: path name: projectsId @@ -6343,18 +6344,22 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:setAcl: + - in: path + name: documentsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}/documentLinks: parameters: *ref_1 post: - description: >- - Sets the access control policy for a resource. Replaces any existing - policy. - operationId: contentwarehouse.projects.locations.documents.setAcl + description: Create a link between a source document and a target document. + operationId: contentwarehouse.projects.locations.documents.documentLinks.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SetAclRequest' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1CreateDocumentLinkRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6366,8 +6371,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1SetAclResponse + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentLink' parameters: - in: path name: projectsId @@ -6384,17 +6388,17 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:get: + /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}/documentLinks/{documentLinksId}:delete: parameters: *ref_1 post: - description: Gets a document. Returns NOT_FOUND if the document does not exist. - operationId: contentwarehouse.projects.locations.documents.get + description: Remove the link between the source and target documents. + operationId: contentwarehouse.projects.locations.documents.documentLinks.delete requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1GetDocumentRequest + #/components/schemas/GoogleCloudContentwarehouseV1DeleteDocumentLinkRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6406,7 +6410,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -6423,17 +6427,22 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:lock: + - in: path + name: documentLinksId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/documents/referenceId/{referenceIdId}:get: parameters: *ref_1 post: - description: Lock the document so the document cannot be updated by other users. - operationId: contentwarehouse.projects.locations.documents.lock + description: Gets a document. Returns NOT_FOUND if the document does not exist. + operationId: contentwarehouse.projects.locations.documents.referenceId.get requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1LockDocumentRequest + #/components/schemas/GoogleCloudContentwarehouseV1GetDocumentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6458,20 +6467,23 @@ paths: schema: type: string - in: path - name: documentsId + name: referenceIdId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documentSchemas: + /v1/projects/{projectsId}/locations/{locationsId}/documents/referenceId/{referenceIdId}: parameters: *ref_1 - post: - description: Creates a document schema. - operationId: contentwarehouse.projects.locations.documentSchemas.create + patch: + description: >- + Updates a document. Returns INVALID_ARGUMENT if the name of the document + is non-empty and does not equal the existing name. + operationId: contentwarehouse.projects.locations.documents.referenceId.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1UpdateDocumentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6484,7 +6496,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema + #/components/schemas/GoogleCloudContentwarehouseV1UpdateDocumentResponse parameters: - in: path name: projectsId @@ -6496,9 +6508,22 @@ paths: required: true schema: type: string - get: - description: Lists document schemas. - operationId: contentwarehouse.projects.locations.documentSchemas.list + - in: path + name: referenceIdId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/documents/referenceId/{referenceIdId}:delete: + parameters: *ref_1 + post: + description: Deletes a document. Returns NOT_FOUND if the document does not exist. + operationId: contentwarehouse.projects.locations.documents.referenceId.delete + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1DeleteDocumentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6510,8 +6535,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1ListDocumentSchemasResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -6523,23 +6547,18 @@ paths: required: true schema: type: string - - in: query - name: pageToken + - in: path + name: referenceIdId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/documentSchemas/{documentSchemasId}: + /v1/projects/{projectsId}/locations/{locationsId}/synonymSets/{synonymSetsId}: parameters: *ref_1 - delete: + get: description: >- - Deletes a document schema. Returns NOT_FOUND if the document schema does - not exist. Returns BAD_REQUEST if the document schema has documents - depending on it. - operationId: contentwarehouse.projects.locations.documentSchemas.delete + Gets a SynonymSet for a particular context. Throws a NOT_FOUND exception + if the Synonymset does not exist + operationId: contentwarehouse.projects.locations.synonymSets.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6551,7 +6570,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' parameters: - in: path name: projectsId @@ -6564,15 +6583,20 @@ paths: schema: type: string - in: path - name: documentSchemasId + name: synonymSetsId required: true schema: type: string - get: + patch: description: >- - Gets a document schema. Returns NOT_FOUND if the document schema does - not exist. - operationId: contentwarehouse.projects.locations.documentSchemas.get + Remove the existing SynonymSet for the context and replaces it with a + new one. Throws a NOT_FOUND exception if the SynonymSet is not found. + operationId: contentwarehouse.projects.locations.synonymSets.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6584,8 +6608,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' parameters: - in: path name: projectsId @@ -6598,25 +6621,15 @@ paths: schema: type: string - in: path - name: documentSchemasId + name: synonymSetsId required: true schema: type: string - patch: + delete: description: >- - Updates a Document Schema. Returns INVALID_ARGUMENT if the name of the - Document Schema is non-empty and does not equal the existing name. - Supports only appending new properties, adding new ENUM possible values, - and updating the EnumTypeOptions.validation_check_disabled flag for ENUM - possible values. Updating existing properties will result into - INVALID_ARGUMENT. - operationId: contentwarehouse.projects.locations.documentSchemas.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1UpdateDocumentSchemaRequest + Deletes a SynonymSet for a given context. Throws a NOT_FOUND exception + if the SynonymSet is not found. + operationId: contentwarehouse.projects.locations.synonymSets.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6628,8 +6641,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -6642,15 +6654,22 @@ paths: schema: type: string - in: path - name: documentSchemasId + name: synonymSetsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/ruleSets/{ruleSetsId}: + /v1/projects/{projectsId}/locations/{locationsId}/synonymSets: parameters: *ref_1 - delete: - description: Deletes a ruleset. Returns NOT_FOUND if the document does not exist. - operationId: contentwarehouse.projects.locations.ruleSets.delete + post: + description: >- + Creates a SynonymSet for a single context. Throws an ALREADY_EXISTS + exception if a synonymset already exists for the context. + operationId: contentwarehouse.projects.locations.synonymSets.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6662,7 +6681,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' parameters: - in: path name: projectsId @@ -6674,14 +6693,9 @@ paths: required: true schema: type: string - - in: path - name: ruleSetsId - required: true - schema: - type: string get: - description: Gets a ruleset. Returns NOT_FOUND if the ruleset does not exist. - operationId: contentwarehouse.projects.locations.ruleSets.get + description: Returns all SynonymSets (for all contexts) for the specified location. + operationId: contentwarehouse.projects.locations.synonymSets.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6693,7 +6707,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleSet' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1ListSynonymSetsResponse parameters: - in: path name: projectsId @@ -6705,22 +6720,25 @@ paths: required: true schema: type: string - - in: path - name: ruleSetsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - patch: - description: >- - Updates a ruleset. Returns INVALID_ARGUMENT if the name of the ruleset - is non-empty and does not equal the existing name. - operationId: contentwarehouse.projects.locations.ruleSets.patch + /v1/projects/{projectsId}/locations/{locationsId}/ruleSets: + parameters: *ref_1 + post: + description: Creates a ruleset. + operationId: contentwarehouse.projects.locations.ruleSets.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1UpdateRuleSetRequest + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleSet' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6744,13 +6762,6 @@ paths: required: true schema: type: string - - in: path - name: ruleSetsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/ruleSets: - parameters: *ref_1 get: description: Lists rulesets. operationId: contentwarehouse.projects.locations.ruleSets.list @@ -6787,14 +6798,11 @@ paths: name: pageToken schema: type: string - post: - description: Creates a ruleset. - operationId: contentwarehouse.projects.locations.ruleSets.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleSet' + /v1/projects/{projectsId}/locations/{locationsId}/ruleSets/{ruleSetsId}: + parameters: *ref_1 + get: + description: Gets a ruleset. Returns NOT_FOUND if the ruleset does not exist. + operationId: contentwarehouse.projects.locations.ruleSets.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6818,11 +6826,14 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}:getStatus: - parameters: *ref_1 - get: - description: Get the project status. - operationId: contentwarehouse.projects.locations.getStatus + - in: path + name: ruleSetsId + required: true + schema: + type: string + delete: + description: Deletes a ruleset. Returns NOT_FOUND if the document does not exist. + operationId: contentwarehouse.projects.locations.ruleSets.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6834,8 +6845,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1ProjectStatus + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -6847,19 +6857,22 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}:initialize: - parameters: *ref_1 - post: + - in: path + name: ruleSetsId + required: true + schema: + type: string + patch: description: >- - Provisions resources for given tenant project. Returns a long running - operation. - operationId: contentwarehouse.projects.locations.initialize + Updates a ruleset. Returns INVALID_ARGUMENT if the name of the ruleset + is non-empty and does not equal the existing name. + operationId: contentwarehouse.projects.locations.ruleSets.patch requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1InitializeProjectRequest + #/components/schemas/GoogleCloudContentwarehouseV1UpdateRuleSetRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6871,7 +6884,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleSet' parameters: - in: path name: projectsId @@ -6883,37 +6896,8 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}:runPipeline: - parameters: *ref_1 - post: - description: Run a predefined pipeline. - operationId: contentwarehouse.projects.locations.runPipeline - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1RunPipelineRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - in: path - name: locationsId + name: ruleSetsId required: true schema: type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/datacatalog.yaml b/providers/src/googleapis.com/v00.00.00000/services/datacatalog.yaml index 06f8acce..357e35f7 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/datacatalog.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/datacatalog.yaml @@ -9,8 +9,8 @@ info: A fully managed and highly scalable data discovery and metadata management service. version: v1 - x-discovery-doc-revision: '20241029' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250822' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/data-catalog/docs/ servers: @@ -340,7 +340,7 @@ components: - BigQuery. - Cloud Pub/Sub. - Dataproc Metastore. - - Dataplex. + - Dataplex Universal Catalog. - Cloud Spanner - Cloud Bigtable - Cloud Sql @@ -411,8 +411,8 @@ components: transferredToDataplex: description: >- Optional. When set to [true], it means DataCatalog EntryGroup was - transferred to Dataplex Catalog Service. It makes EntryGroup and its - Entries to be read-only in DataCatalog. However, new Tags on + transferred to Dataplex Universal Catalog. It makes EntryGroup and + its Entries to be read-only in DataCatalog. However, new Tags on EntryGroup and its Entries can be created. After setting the flag to [true] it cannot be unset. type: boolean @@ -519,8 +519,8 @@ components: - A database. - Connection to a data source. For example, a BigQuery connection. - Routine, for example, a BigQuery routine. - - A Dataplex lake. - - A Dataplex zone. + - A Dataplex Universal Catalog lake. + - A Dataplex Universal Catalog zone. - A service, for example, a Dataproc Metastore service. - Schema within a relational database. - A Dashboard, for example from Looker. @@ -576,7 +576,7 @@ components: - BigQuery. - Cloud Pub/Sub. - Dataproc Metastore. - - Dataplex. + - Dataplex Universal Catalog. - Cloud Spanner - Cloud Bigtable - Cloud Sql @@ -789,11 +789,11 @@ components: description: >- Required. Patterns to identify a set of files in Google Cloud Storage. For more information, see [Wildcard Names] - (https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames). - Note: Currently, bucket wildcards are not supported. Examples of - valid `file_patterns`: * `gs://bucket_name/dir/*`: matches all files - in `bucket_name/dir` directory * `gs://bucket_name/dir/**`: matches - all files in `bucket_name/dir` and all subdirectories * + (https://cloud.google.com/storage/docs/wildcards). Note: Currently, + bucket wildcards are not supported. Examples of valid + `file_patterns`: * `gs://bucket_name/dir/*`: matches all files in + `bucket_name/dir` directory * `gs://bucket_name/dir/**`: matches all + files in `bucket_name/dir` and all subdirectories * `gs://bucket_name/file*`: matches files prefixed by `file` in `bucket_name` * `gs://bucket_name/??.txt`: matches files with two characters followed by `.txt` in `bucket_name` * @@ -940,31 +940,31 @@ components: - EXTERNAL dataplexTable: description: >- - Output only. Fields specific to a Dataplex table and present only in - the Dataplex table entries. + Output only. Fields specific to a Dataplex Universal Catalog table + and present only in the Dataplex Universal Catalog table entries. readOnly: true $ref: '#/components/schemas/GoogleCloudDatacatalogV1DataplexTableSpec' databaseViewSpec: description: >- - Spec what aplies to tables that are actually views. Not set for + Spec what applies to tables that are actually views. Not set for "real" tables. $ref: >- #/components/schemas/GoogleCloudDatacatalogV1DatabaseTableSpecDatabaseViewSpec GoogleCloudDatacatalogV1DataplexTableSpec: id: GoogleCloudDatacatalogV1DataplexTableSpec - description: Entry specification for a Dataplex table. + description: Entry specification for a Dataplex Universal Catalog table. type: object properties: externalTables: description: >- - List of external tables registered by Dataplex in other systems - based on the same underlying data. External tables allow to query - this data in those systems. + List of external tables registered by Dataplex Universal Catalog in + other systems based on the same underlying data. External tables + allow to query this data in those systems. type: array items: $ref: '#/components/schemas/GoogleCloudDatacatalogV1DataplexExternalTable' dataplexSpec: - description: Common Dataplex fields. + description: Common Dataplex Universal Catalog fields. $ref: '#/components/schemas/GoogleCloudDatacatalogV1DataplexSpec' userManaged: description: Indicates if the table schema is managed by the user or not. @@ -972,12 +972,12 @@ components: GoogleCloudDatacatalogV1DataplexExternalTable: id: GoogleCloudDatacatalogV1DataplexExternalTable description: >- - External table registered by Dataplex. Dataplex publishes data - discovered from an asset into multiple other systems (BigQuery, DPMS) in - form of tables. We call them "external tables". External tables are also - synced into the Data Catalog. This message contains pointers to those - external tables (fully qualified name, resource name et cetera) within - the Data Catalog. + External table registered by Dataplex Universal Catalog. Dataplex + Universal Catalog publishes data discovered from an asset into multiple + other systems (BigQuery, DPMS) in form of tables. We call them "external + tables". External tables are also synced into the Data Catalog. This + message contains pointers to those external tables (fully qualified + name, resource name et cetera) within the Data Catalog. type: object properties: system: @@ -988,7 +988,7 @@ components: - BigQuery. - Cloud Pub/Sub. - Dataproc Metastore. - - Dataplex. + - Dataplex Universal Catalog. - Cloud Spanner - Cloud Bigtable - Cloud Sql @@ -1016,14 +1016,14 @@ components: type: string GoogleCloudDatacatalogV1DataplexSpec: id: GoogleCloudDatacatalogV1DataplexSpec - description: Common Dataplex fields. + description: Common Dataplex Universal Catalog fields. type: object properties: asset: description: >- - Fully qualified resource name of an asset in Dataplex, to which the - underlying data source (Cloud Storage bucket or BigQuery dataset) of - the entity is attached. + Fully qualified resource name of an asset in Dataplex Universal + Catalog, to which the underlying data source (Cloud Storage bucket + or BigQuery dataset) of the entity is attached. type: string dataFormat: description: Format of the data. @@ -1034,8 +1034,8 @@ components: projectId: description: >- Project ID of the underlying Cloud Storage or BigQuery data. Note - that this may not be the same project as the correspondingly - Dataplex lake / zone / asset. + that this may not be the same project as the corresponding Dataplex + Universal Catalog lake / zone / asset. type: string GoogleCloudDatacatalogV1PhysicalSchema: id: GoogleCloudDatacatalogV1PhysicalSchema @@ -1330,16 +1330,16 @@ components: properties: dataplexFileset: description: >- - Fields specific to a Dataplex fileset and present only in the - Dataplex fileset entries. + Fields specific to a Dataplex Universal Catalog fileset and present + only in the Dataplex Universal Catalog fileset entries. $ref: '#/components/schemas/GoogleCloudDatacatalogV1DataplexFilesetSpec' GoogleCloudDatacatalogV1DataplexFilesetSpec: id: GoogleCloudDatacatalogV1DataplexFilesetSpec - description: Entry specyfication for a Dataplex fileset. + description: Entry specification for a Dataplex Universal Catalog fileset. type: object properties: dataplexSpec: - description: Common Dataplex fields. + description: Common Dataplex Universal Catalog fields. $ref: '#/components/schemas/GoogleCloudDatacatalogV1DataplexSpec' GoogleCloudDatacatalogV1ServiceSpec: id: GoogleCloudDatacatalogV1ServiceSpec @@ -1460,15 +1460,13 @@ components: type: object properties: storageType: - description: >- - Output only. Type of underelaying storage for the - FeatureOnlineStore. + description: Output only. Type of underlying storage for the FeatureOnlineStore. readOnly: true type: string enumDescriptions: - Should not be used. - Underlsying storgae is Bigtable. - - Underlaying is optimized online server (Lightning). + - Underlying is optimized online server (Lightning). enum: - STORAGE_TYPE_UNSPECIFIED - BIGTABLE @@ -1853,17 +1851,17 @@ components: enumDescriptions: - >- Default value. TagTemplate and its tags are only visible and - editable in DataCatalog. + editable in Data Catalog. - >- - TagTemplate and its tags are auto-copied to Dataplex service. - Visible in both services. Editable in DataCatalog, read-only in - Dataplex. Deprecated: Individual TagTemplate migration is - deprecated in favor of organization or project wide TagTemplate - migration opt-in. + TagTemplate and its tags are auto-copied to Dataplex Universal + Catalog service. Visible in both services. Editable in Data + Catalog, read-only in Dataplex Universal Catalog. Deprecated: + Individual TagTemplate migration is deprecated in favor of + organization or project wide TagTemplate migration opt-in. - >- - TagTemplate and its tags are auto-copied to Dataplex service. - Visible in both services. Editable in Dataplex, read-only in - DataCatalog. + TagTemplate and its tags are auto-copied to Dataplex Universal + Catalog service. Visible in both services. Editable in Dataplex + Universal Catalog, read-only in Data Catalog. enumDeprecated: - false - true @@ -2031,17 +2029,17 @@ components: enumDescriptions: - >- Default value. TagTemplate and its tags are only visible and - editable in DataCatalog. + editable in Data Catalog. - >- - TagTemplate and its tags are auto-copied to Dataplex service. - Visible in both services. Editable in DataCatalog, read-only in - Dataplex. Deprecated: Individual TagTemplate migration is - deprecated in favor of organization or project wide TagTemplate - migration opt-in. + TagTemplate and its tags are auto-copied to Dataplex Universal + Catalog service. Visible in both services. Editable in Data + Catalog, read-only in Dataplex Universal Catalog. Deprecated: + Individual TagTemplate migration is deprecated in favor of + organization or project wide TagTemplate migration opt-in. - >- - TagTemplate and its tags are auto-copied to Dataplex service. - Visible in both services. Editable in Dataplex, read-only in - DataCatalog. + TagTemplate and its tags are auto-copied to Dataplex Universal + Catalog service. Visible in both services. Editable in Dataplex + Universal Catalog, read-only in Data Catalog. enumDeprecated: - false - true @@ -2130,10 +2128,6 @@ components: reconciliation. type: string forceDeleteMissing: - description: >- - If set to `true`, deletes entry tags related to a tag template not - listed in the tags source from an entry. If set to `false`, unlisted - tags are retained. type: boolean tags: description: >- @@ -2462,8 +2456,8 @@ components: type: string jobId: description: >- - Optional. (Optional) Dataplex task job id, if specified will be used - as part of ImportEntries LRO ID + Optional. (Optional) Dataplex Universal Catalog task job id, if + specified will be used as part of ImportEntries LRO ID type: string GoogleCloudDatacatalogV1SetConfigRequest: id: GoogleCloudDatacatalogV1SetConfigRequest @@ -2471,28 +2465,39 @@ components: type: object properties: tagTemplateMigration: - description: Opt-in status for the migration of Tag Templates to Dataplex. + description: >- + Opt-in status for the migration of Tag Templates to Dataplex + Universal Catalog. type: string enumDescriptions: - >- Default value. Migration of Tag Templates from Data Catalog to - Dataplex is not performed. + Dataplex Universal Catalog is not performed. For projects that are + under an organization, the project inherits the organization's + configuration when you set the project-level configuration to + unspecified (`TAG_TEMPLATE_MIGRATION_UNSPECIFIED`). This means + that when migration is enabled at the organization level, and the + project-level configuration is unspecified, the project is + migrated. To explicitly opt-in or opt-out individual projects, set + the project-level configuration to enabled + (`TAG_TEMPLATE_MIGRATION_ENABLED`) or disabled + (`TAG_TEMPLATE_MIGRATION_DISABLED`). - >- - Migration of Tag Templates from Data Catalog to Dataplex is - enabled. + Migration of Tag Templates from Data Catalog to Dataplex Universal + Catalog is enabled. - >- - Migration of Tag Templates from Data Catalog to Dataplex is - disabled. + Migration of Tag Templates from Data Catalog to Dataplex Universal + Catalog is disabled. enum: - TAG_TEMPLATE_MIGRATION_UNSPECIFIED - TAG_TEMPLATE_MIGRATION_ENABLED - TAG_TEMPLATE_MIGRATION_DISABLED catalogUiExperience: - description: Opt-in status for the UI switch to Dataplex. + description: Opt-in status for the UI switch to Dataplex Universal Catalog. type: string enumDescriptions: - - Default value. The default UI is Dataplex. - - The UI is Dataplex. + - Default value. The default UI is Dataplex Universal Catalog. + - The UI is Dataplex Universal Catalog. - The UI is Data Catalog. enum: - CATALOG_UI_EXPERIENCE_UNSPECIFIED @@ -2501,45 +2506,62 @@ components: GoogleCloudDatacatalogV1MigrationConfig: id: GoogleCloudDatacatalogV1MigrationConfig description: >- - The configuration related to the migration to Dataplex applied to an - organization or project. It is the response message for SetConfig and - RetrieveEffectiveConfig. + The configuration related to the migration to Dataplex Universal Catalog + applied to an organization or project. It is the response message for + SetConfig and RetrieveEffectiveConfig. type: object properties: tagTemplateMigration: - description: Opt-in status for the migration of Tag Templates to Dataplex. + description: >- + Opt-in status for the migration of Tag Templates to Dataplex + Universal Catalog. type: string enumDescriptions: - >- Default value. Migration of Tag Templates from Data Catalog to - Dataplex is not performed. + Dataplex Universal Catalog is not performed. For projects that are + under an organization, the project inherits the organization's + configuration when you set the project-level configuration to + unspecified (`TAG_TEMPLATE_MIGRATION_UNSPECIFIED`). This means + that when migration is enabled at the organization level, and the + project-level configuration is unspecified, the project is + migrated. To explicitly opt-in or opt-out individual projects, set + the project-level configuration to enabled + (`TAG_TEMPLATE_MIGRATION_ENABLED`) or disabled + (`TAG_TEMPLATE_MIGRATION_DISABLED`). - >- - Migration of Tag Templates from Data Catalog to Dataplex is - enabled. + Migration of Tag Templates from Data Catalog to Dataplex Universal + Catalog is enabled. - >- - Migration of Tag Templates from Data Catalog to Dataplex is - disabled. + Migration of Tag Templates from Data Catalog to Dataplex Universal + Catalog is disabled. enum: - TAG_TEMPLATE_MIGRATION_UNSPECIFIED - TAG_TEMPLATE_MIGRATION_ENABLED - TAG_TEMPLATE_MIGRATION_DISABLED catalogUiExperience: - description: Opt-in status for the UI switch to Dataplex. + description: Opt-in status for the UI switch to Dataplex Universal Catalog. type: string enumDescriptions: - - Default value. The default UI is Dataplex. - - The UI is Dataplex. + - Default value. The default UI is Dataplex Universal Catalog. + - The UI is Dataplex Universal Catalog. - The UI is Data Catalog. enum: - CATALOG_UI_EXPERIENCE_UNSPECIFIED - CATALOG_UI_EXPERIENCE_ENABLED - CATALOG_UI_EXPERIENCE_DISABLED + templateMigrationEnabledTime: + description: >- + The time when the Tag Template migration was enabled. If the Tag + Template migration is not enabled, this field is not set. + type: string + format: google-datetime GoogleCloudDatacatalogV1OrganizationConfig: id: GoogleCloudDatacatalogV1OrganizationConfig description: >- The configuration related to the migration from Data Catalog to Dataplex - that has been applied to an organization and any projects under it. It - is the response message for RetrieveConfig. + Universal Catalog that has been applied to an organization and any + projects under it. It is the response message for RetrieveConfig. type: object properties: config: @@ -2622,7 +2644,7 @@ components: type: string enumDescriptions: - Default value - - Dataplex. + - Dataplex Universal Catalog. - Other enum: - MANAGING_SYSTEM_UNSPECIFIED @@ -3852,8 +3874,8 @@ paths: - $ref: '#/components/parameters/_.xgafv' post: description: >- - Sets the configuration related to the migration to Dataplex for an - organization or project. + Sets the configuration related to the migration to Dataplex Universal + Catalog for an organization or project. operationId: datacatalog.projects.locations.setConfig requestBody: content: @@ -3888,10 +3910,10 @@ paths: get: description: >- Retrieves the effective configuration related to the migration from Data - Catalog to Dataplex for a specific organization or project. If there is - no specific configuration set for the resource, the setting is checked - hierarchicahlly through the ancestors of the resource, starting from the - resource itself. + Catalog to Dataplex Universal Catalog for a specific organization or + project. If there is no specific configuration set for the resource, the + setting is checked hierarchicahlly through the ancestors of the + resource, starting from the resource itself. operationId: datacatalog.projects.locations.retrieveEffectiveConfig security: - Oauth2: @@ -4042,7 +4064,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: datacatalog.projects.locations.operations.cancel security: - Oauth2: @@ -5188,7 +5210,9 @@ paths: operation deletes tags not included in the input tag list. `ReconcileTags` returns a long-running operation resource that can be queried with Operations.GetOperation to return ReconcileTagsMetadata and - a ReconcileTagsResponse message. + a ReconcileTagsResponse message. Note: SearchCatalog might return stale + search results for up to 24 hours after the `ReconcileTags` operation + completes. operationId: datacatalog.projects.locations.entryGroups.entries.tags.reconcile requestBody: content: @@ -6787,8 +6811,8 @@ paths: parameters: *ref_1 post: description: >- - Sets the configuration related to the migration to Dataplex for an - organization or project. + Sets the configuration related to the migration to Dataplex Universal + Catalog for an organization or project. operationId: datacatalog.organizations.locations.setConfig requestBody: content: @@ -6823,8 +6847,8 @@ paths: get: description: >- Retrieves the configuration related to the migration from Data Catalog - to Dataplex for a specific organization, including all the projects - under it which have a separate configuration set. + to Dataplex Universal Catalog for a specific organization, including all + the projects under it which have a separate configuration set. operationId: datacatalog.organizations.locations.retrieveConfig security: - Oauth2: @@ -6855,10 +6879,10 @@ paths: get: description: >- Retrieves the effective configuration related to the migration from Data - Catalog to Dataplex for a specific organization or project. If there is - no specific configuration set for the resource, the setting is checked - hierarchicahlly through the ancestors of the resource, starting from the - resource itself. + Catalog to Dataplex Universal Catalog for a specific organization or + project. If there is no specific configuration set for the resource, the + setting is checked hierarchicahlly through the ancestors of the + resource, starting from the resource itself. operationId: datacatalog.organizations.locations.retrieveEffectiveConfig security: - Oauth2: diff --git a/providers/src/googleapis.com/v00.00.00000/services/dataflow.yaml b/providers/src/googleapis.com/v00.00.00000/services/dataflow.yaml index 305d450f..b1c9e00f 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/dataflow.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/dataflow.yaml @@ -7,8 +7,8 @@ info: title: Dataflow API description: Manages Google Cloud Dataflow projects on Google Cloud Platform. version: v1b3 - x-discovery-doc-revision: '20241028' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250825' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/dataflow servers: @@ -105,6 +105,64 @@ components: description: Response to a send capture request. nothing type: object properties: {} + GetWorkerStacktracesRequest: + id: GetWorkerStacktracesRequest + description: Request to get worker stacktraces from debug capture. + type: object + properties: + workerId: + description: >- + The worker for which to get stacktraces. The returned stacktraces + will be for the SDK harness running on this worker. + type: string + GetWorkerStacktracesResponse: + id: GetWorkerStacktracesResponse + description: Response to get worker stacktraces from debug capture. + type: object + properties: + sdks: + description: Repeated as unified worker may have multiple SDK processes. + type: array + items: + $ref: '#/components/schemas/Sdk' + Sdk: + id: Sdk + description: A structured representation of an SDK. + type: object + properties: + sdkId: + description: The SDK harness id. + type: string + stacks: + description: The stacktraces for the processes running on the SDK harness. + type: array + items: + $ref: '#/components/schemas/Stack' + Stack: + id: Stack + description: A structuredstacktrace for a process running on the worker. + type: object + properties: + timestamp: + description: Timestamp at which the stack was captured. + type: string + format: google-datetime + threadName: + description: Thread name. For example, "CommitThread-0,10,main" + type: string + stackContent: + description: The raw stack trace. + type: string + threadState: + description: The state of the thread. For example, "WAITING". + type: string + threadCount: + description: >- + With java thread dumps we may get collapsed stacks e.g., N threads + in stack "". Instead of having to copy over the same stack trace N + times, this int field captures this. + type: integer + format: int32 Snapshot: id: Snapshot description: Represents a snapshot of a job. @@ -317,6 +375,8 @@ components: associated resources are currently being cleaned up after a successful run. Currently, this is an opt-in feature, please reach out to Cloud support team if you are interested. + - '`JOB_STATE_PAUSING` is not implemented yet.' + - '`JOB_STATE_PAUSED` is not implemented yet.' enum: - JOB_STATE_UNKNOWN - JOB_STATE_STOPPED @@ -331,6 +391,8 @@ components: - JOB_STATE_CANCELLING - JOB_STATE_QUEUED - JOB_STATE_RESOURCE_CLEANING_UP + - JOB_STATE_PAUSING + - JOB_STATE_PAUSED currentStateTime: description: The timestamp associated with the current state. type: string @@ -407,6 +469,8 @@ components: associated resources are currently being cleaned up after a successful run. Currently, this is an opt-in feature, please reach out to Cloud support team if you are interested. + - '`JOB_STATE_PAUSING` is not implemented yet.' + - '`JOB_STATE_PAUSED` is not implemented yet.' enum: - JOB_STATE_UNKNOWN - JOB_STATE_STOPPED @@ -421,6 +485,8 @@ components: - JOB_STATE_CANCELLING - JOB_STATE_QUEUED - JOB_STATE_RESOURCE_CLEANING_UP + - JOB_STATE_PAUSING + - JOB_STATE_PAUSED executionInfo: description: Deprecated. $ref: '#/components/schemas/JobExecutionInfo' @@ -714,6 +780,9 @@ components: - STREAMING_MODE_UNSPECIFIED - STREAMING_MODE_EXACTLY_ONCE - STREAMING_MODE_AT_LEAST_ONCE + usePublicIps: + description: Optional. True when any worker pool that uses public IPs is present. + type: boolean WorkerPool: id: WorkerPool description: >- @@ -1553,6 +1622,8 @@ components: associated resources are currently being cleaned up after a successful run. Currently, this is an opt-in feature, please reach out to Cloud support team if you are interested. + - '`JOB_STATE_PAUSING` is not implemented yet.' + - '`JOB_STATE_PAUSED` is not implemented yet.' enum: - JOB_STATE_UNKNOWN - JOB_STATE_STOPPED @@ -1567,6 +1638,8 @@ components: - JOB_STATE_CANCELLING - JOB_STATE_QUEUED - JOB_STATE_RESOURCE_CLEANING_UP + - JOB_STATE_PAUSING + - JOB_STATE_PAUSED currentStateTime: description: The time at which the stage transitioned to this state. type: string @@ -2044,6 +2117,11 @@ components: - STREAMING_MODE_UNSPECIFIED - STREAMING_MODE_EXACTLY_ONCE - STREAMING_MODE_AT_LEAST_ONCE + additionalPipelineOptions: + description: Optional. Additional pipeline option flags for the job. + type: array + items: + type: string LaunchTemplateParameters: id: LaunchTemplateParameters description: >- @@ -2188,6 +2266,9 @@ components: supports_exactly_once are true. Possible values: UNSPECIFIED, EXACTLY_ONCE and AT_LEAST_ONCE type: string + yamlDefinition: + description: Optional. For future use. + type: string ParameterMetadata: id: ParameterMetadata description: Metadata for a specific parameter. @@ -2377,11 +2458,13 @@ components: - Java. - Python. - Go. + - YAML. enum: - UNKNOWN - JAVA - PYTHON - GO + - YAML version: description: Optional. The SDK version. type: string @@ -2665,6 +2748,11 @@ components: - STREAMING_MODE_UNSPECIFIED - STREAMING_MODE_EXACTLY_ONCE - STREAMING_MODE_AT_LEAST_ONCE + additionalPipelineOptions: + description: Optional. Additional pipeline option flags for the job. + type: array + items: + type: string LaunchFlexTemplateResponse: id: LaunchFlexTemplateResponse description: Response to the request to launch a job from Flex Template. @@ -2905,8 +2993,20 @@ components: description: >- Worker-computed aggregate value for the "Set" aggregation kind. The only possible value type is a list of Values whose type can be Long, - Double, or String, according to the metric's type. All Values in the - list must be of the same type. + Double, String, or BoundedTrie according to the metric's type. All + Values in the list must be of the same type. + type: any + trie: + description: >- + Worker-computed aggregate value for the "Trie" aggregation kind. The + only possible value type is a BoundedTrieNode. + type: any + boundedTrie: + description: >- + Worker-computed aggregate value for the "Trie" aggregation kind. The + only possible value type is a BoundedTrieNode. Introduced this field + to avoid breaking older SDKs when Dataflow service starts to + populate the `bounded_trie` field. type: any distribution: description: >- @@ -3388,7 +3488,7 @@ components: $ref: '#/components/schemas/ApproximateProgress' CounterUpdate: id: CounterUpdate - description: An update to a Counter sent from a worker. + description: 'An update to a Counter sent from a worker. Next ID: 17' type: object properties: nameAndKind: @@ -3445,6 +3545,9 @@ components: integerGauge: description: Gauge data $ref: '#/components/schemas/IntegerGauge' + boundedTrie: + description: Bounded trie data + $ref: '#/components/schemas/BoundedTrie' NameAndKind: id: NameAndKind description: Basic metadata about a counter. @@ -3766,6 +3869,40 @@ components: epoch. type: string format: google-datetime + BoundedTrie: + id: BoundedTrie + description: The message type used for encoding metrics of type bounded trie. + type: object + properties: + bound: + description: The maximum number of elements to store before truncation. + type: integer + format: int32 + root: + description: A compact representation of all the elements in this trie. + $ref: '#/components/schemas/BoundedTrieNode' + singleton: + description: >- + A more efficient representation for metrics consisting of a single + value. + type: array + items: + type: string + BoundedTrieNode: + id: BoundedTrieNode + description: A single node in a BoundedTrie. + type: object + properties: + truncated: + description: >- + Whether this node has been truncated. A truncated leaf represents + possibly many children with the same prefix. + type: boolean + children: + description: Children of this node. Must be empty if truncated is true. + type: object + additionalProperties: + $ref: '#/components/schemas/BoundedTrieNode' ApproximateReportedProgress: id: ApproximateReportedProgress description: A progress measurement of a WorkItem by a worker. @@ -5704,6 +5841,9 @@ components: valueHistogram: description: Histogram value of this metric. $ref: '#/components/schemas/DataflowHistogramValue' + valueGauge64: + description: Non-cumulative int64 value of this metric. + $ref: '#/components/schemas/DataflowGaugeValue' DataflowHistogramValue: id: DataflowHistogramValue description: >- @@ -5810,6 +5950,19 @@ components: description: Mean of values in the overflow bucket. type: number format: double + DataflowGaugeValue: + id: DataflowGaugeValue + description: The gauge value of a metric. + type: object + properties: + value: + description: The value of the gauge. + type: string + format: int64 + measuredTime: + description: The timestamp when the gauge was recorded. + type: string + format: google-datetime SendWorkerMessagesResponse: id: SendWorkerMessagesResponse description: The response to the worker messages. @@ -6401,6 +6554,26 @@ components: update: [] replace: [] delete: [] + debug_worker_stacktraces: + id: google.dataflow.debug_worker_stacktraces + name: debug_worker_stacktraces + title: Debug_worker_stacktraces + methods: + projects_locations_jobs_debug_get_worker_stacktraces: + operation: + $ref: >- + #/paths/~1v1b3~1projects~1{projectId}~1locations~1{location}~1jobs~1{jobId}~1debug~1getWorkerStacktraces/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/debug_worker_stacktraces/methods/projects_locations_jobs_debug_get_worker_stacktraces + insert: [] + update: [] + replace: [] + delete: [] stages_execution_details: id: google.dataflow.stages_execution_details name: stages_execution_details @@ -6592,7 +6765,7 @@ paths: parameters: *ref_1 post: description: >- - Creates a Cloud Dataflow job. To create a job, we recommend using + Creates a Dataflow job. To create a job, we recommend using `projects.locations.jobs.create` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.create` is not recommended, as your job will always @@ -7433,7 +7606,7 @@ paths: parameters: *ref_1 post: description: >- - Creates a Cloud Dataflow job. To create a job, we recommend using + Creates a Dataflow job. To create a job, we recommend using `projects.locations.jobs.create` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.create` is not recommended, as your job will always @@ -7860,6 +8033,48 @@ paths: required: true schema: type: string + /v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/getWorkerStacktraces: + parameters: *ref_1 + post: + description: Get worker stacktraces from debug capture. + operationId: dataflow.projects.locations.jobs.debug.getWorkerStacktraces + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetWorkerStacktracesRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GetWorkerStacktracesResponse' + parameters: + - in: path + name: projectId + required: true + schema: + type: string + - in: path + name: location + required: true + schema: + type: string + - in: path + name: jobId + required: true + schema: + type: string /v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/snapshots: parameters: *ref_1 get: diff --git a/providers/src/googleapis.com/v00.00.00000/services/dataform.yaml b/providers/src/googleapis.com/v00.00.00000/services/dataform.yaml index 6f4c5e69..cec31727 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/dataform.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/dataform.yaml @@ -9,8 +9,8 @@ info: Service to develop, version control, and operationalize SQL pipelines in BigQuery. version: v1beta1 - x-discovery-doc-revision: '20241028' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250817' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/dataform/docs servers: @@ -24,6 +24,9 @@ components: implicit: authorizationUrl: https://accounts.google.com/o/oauth2/auth scopes: &ref_0 + https://www.googleapis.com/auth/bigquery: >- + View and manage your data in Google BigQuery and see the email + address for your Google Account https://www.googleapis.com/auth/cloud-platform: >- See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. @@ -36,6 +39,373 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: + SetIamPolicyRequest: + id: SetIamPolicyRequest + description: Request message for `SetIamPolicy` method. + type: object + properties: + policy: + description: >- + REQUIRED: The complete policy to be applied to the `resource`. The + size of the policy is limited to a few 10s of KB. An empty policy is + a valid policy but certain Google Cloud services (such as Projects) + might reject them. + $ref: '#/components/schemas/Policy' + Policy: + id: Policy + description: >- + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. A `Policy` is a collection of + `bindings`. A `binding` binds one or more `members`, or principals, to a + single `role`. Principals can be user accounts, service accounts, Google + groups, and domains (such as G Suite). A `role` is a named list of + permissions; each `role` can be an IAM predefined role or a user-created + custom role. For some types of Google Cloud resources, a `binding` can + also specify a `condition`, which is a logical expression that allows + access to a resource only if the expression evaluates to `true`. A + condition can add constraints based on attributes of the request, the + resource, or both. To learn which resources support conditions in their + IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + **JSON example:** ``` { "bindings": [ { "role": + "roles/resourcemanager.organizationAdmin", "members": [ + "user:mike@example.com", "group:admins@example.com", + "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { + "role": "roles/resourcemanager.organizationViewer", "members": [ + "user:eve@example.com" ], "condition": { "title": "expirable access", + "description": "Does not grant access after Sep 2020", "expression": + "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": + "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - + members: - user:mike@example.com - group:admins@example.com - + domain:google.com - + serviceAccount:my-project-id@appspot.gserviceaccount.com role: + roles/resourcemanager.organizationAdmin - members: - + user:eve@example.com role: roles/resourcemanager.organizationViewer + condition: title: expirable access description: Does not grant access + after Sep 2020 expression: request.time < + timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` + For a description of IAM and its features, see the [IAM + documentation](https://cloud.google.com/iam/docs/). + type: object + properties: + 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). + type: integer + format: int32 + bindings: + description: >- + Associates a list of `members`, or principals, with a `role`. + Optionally, may specify a `condition` that determines how and when + the `bindings` are applied. Each of the `bindings` must contain at + least one principal. The `bindings` in a `Policy` can refer to up to + 1,500 principals; up to 250 of these principals can be Google + groups. Each occurrence of a principal counts towards these limits. + For example, if the `bindings` grant 50 different roles to + `user:alice@example.com`, and not to any other principal, then you + can add another 1,450 principals to the `bindings` in the `Policy`. + type: array + items: + $ref: '#/components/schemas/Binding' + 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. + type: string + format: byte + Binding: + id: Binding + description: Associates `members`, or principals, with a `role`. + type: object + properties: + role: + description: >- + Role that is assigned to the list of `members`, or principals. For + example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an + overview of the IAM roles and permissions, see the [IAM + documentation](https://cloud.google.com/iam/docs/roles-overview). + For a list of the available pre-defined roles, see + [here](https://cloud.google.com/iam/docs/understanding-roles). + type: string + members: + description: >- + Specifies the principals requesting access for a Google Cloud + 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. Does not include identities + that come from external identity providers (IdPs) through identity + federation. * `user:{emailid}`: An email address that represents a + specific Google account. For example, `alice@example.com` . * + `serviceAccount:{emailid}`: An email address that represents a + Google service account. For example, + `my-other-app@appspot.gserviceaccount.com`. * + `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: + An identifier for a [Kubernetes service + account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). + For example, + `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * + `group:{emailid}`: An email address that represents a Google group. + For example, `admins@example.com`. * `domain:{domain}`: The G Suite + domain (primary) that represents all the users of that domain. For + example, `google.com` or `example.com`. * + `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workforce identity pool. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: + All workforce identities in a group. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All workforce identities with a specific attribute value. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: + All identities in a workforce identity pool. * + `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workload identity pool. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: + A workload identity pool group. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All identities in a workload identity pool with a certain attribute. + * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: + All identities in a workload identity pool. * + `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. * + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + Deleted single identity in a workforce identity pool. For example, + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + type: array + items: + type: string + condition: + description: >- + The condition that is associated with this binding. If the condition + evaluates to `true`, then this binding applies to the current + request. If the condition evaluates to `false`, then this binding + does not apply to the current request. However, a different role + binding might grant the same role to one or more of the principals + in this binding. To learn which resources support conditions in + their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + $ref: '#/components/schemas/Expr' + Expr: + id: 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. + type: object + properties: + expression: + description: >- + Textual representation of an expression in Common Expression + Language syntax. + 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 + 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 + 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 + TestIamPermissionsRequest: + id: TestIamPermissionsRequest + description: Request message for `TestIamPermissions` method. + type: object + properties: + permissions: + description: >- + The set of permissions to check for the `resource`. Permissions with + wildcards (such as `*` or `storage.*`) are not allowed. For more + information see [IAM + Overview](https://cloud.google.com/iam/docs/overview#permissions). + type: array + items: + type: string + TestIamPermissionsResponse: + id: TestIamPermissionsResponse + description: Response message for `TestIamPermissions` method. + type: object + properties: + permissions: + description: >- + A subset of `TestPermissionsRequest.permissions` that the caller is + allowed. + type: array + items: + type: string + ListOperationsResponse: + id: ListOperationsResponse + description: The response message for Operations.ListOperations. + type: object + properties: + operations: + description: >- + A list of operations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/Operation' + nextPageToken: + description: The standard List next-page token. + type: string + Operation: + id: Operation + description: >- + This resource represents a long-running operation that is the result of + a network API call. + type: object + properties: + name: + description: >- + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. + type: string + metadata: + description: >- + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + done: + description: >- + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + type: boolean + error: + description: >- + The error result of the operation in case of failure or + cancellation. + $ref: '#/components/schemas/Status' + response: + description: >- + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + Status: + id: Status + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + type: object + properties: + code: + description: The status code, which should be an enum value of google.rpc.Code. + type: integer + format: int32 + message: + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + type: string + details: + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + type: array + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + Empty: + id: Empty + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + type: object + properties: {} + CancelOperationRequest: + id: CancelOperationRequest + description: The request message for Operations.CancelOperation. + type: object + properties: {} ListRepositoriesResponse: id: ListRepositoriesResponse description: '`ListRepositories` response message.' @@ -123,6 +493,13 @@ components: Repository is protected by a KMS key. readOnly: true $ref: '#/components/schemas/DataEncryptionState' + internalMetadata: + description: >- + Output only. All the metadata information that is used internally to + serve the resource. For example: timestamps, flags, status fields, + etc. The format of this field is a JSON string. + readOnly: true + type: string GitRemoteSettings: id: GitRemoteSettings description: Controls Git remote configuration for a repository. @@ -213,17 +590,10 @@ components: type: object properties: kmsKeyVersionName: - description: The KMS key version name with which data of a resource is encrypted. + description: >- + Required. The KMS key version name with which data of a resource is + encrypted. type: string - Empty: - id: Empty - description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } - type: object - properties: {} CommitRepositoryChangesRequest: id: CommitRepositoryChangesRequest description: '`CommitRepositoryChanges` request message.' @@ -240,8 +610,8 @@ components: type: string fileOperations: description: >- - A map to the path of the file to the operation. The path is the full - file path including filename, from repository root. + Optional. A map to the path of the file to the operation. The path + is the full file path including filename, from repository root. type: object additionalProperties: $ref: '#/components/schemas/FileOperation' @@ -441,6 +811,13 @@ components: Workspace is protected by a KMS key. readOnly: true $ref: '#/components/schemas/DataEncryptionState' + internalMetadata: + description: >- + Output only. All the metadata information that is used internally to + serve the resource. For example: timestamps, flags, status fields, + etc. The format of this field is a JSON string. + readOnly: true + type: string InstallNpmPackagesRequest: id: InstallNpmPackagesRequest description: '`InstallNpmPackages` request message.' @@ -467,6 +844,11 @@ components: Required. The author of any merge commit which may be created as a result of merging fetched Git commits into this workspace. $ref: '#/components/schemas/CommitAuthor' + PullGitCommitsResponse: + id: PullGitCommitsResponse + description: '`PullGitCommits` response message.' + type: object + properties: {} PushGitCommitsRequest: id: PushGitCommitsRequest description: '`PushGitCommits` request message.' @@ -478,6 +860,11 @@ components: should be pushed. If left unset, the repository's default branch name will be used. type: string + PushGitCommitsResponse: + id: PushGitCommitsResponse + description: '`PushGitCommits` response message.' + type: object + properties: {} FetchFileGitStatusesResponse: id: FetchFileGitStatusesResponse description: '`FetchFileGitStatuses` response message.' @@ -501,7 +888,8 @@ components: root. type: string state: - description: Indicates the status of the file. + description: Output only. Indicates the status of the file. + readOnly: true type: string enumDescriptions: - Default value. This value is unused. @@ -550,6 +938,11 @@ components: type: array items: type: string + CommitWorkspaceChangesResponse: + id: CommitWorkspaceChangesResponse + description: '`CommitWorkspaceChanges` response message.' + type: object + properties: {} ResetWorkspaceChangesRequest: id: ResetWorkspaceChangesRequest description: '`ResetWorkspaceChanges` request message.' @@ -566,6 +959,11 @@ components: clean: description: Optional. If set to true, untracked files will be deleted. type: boolean + ResetWorkspaceChangesResponse: + id: ResetWorkspaceChangesResponse + description: '`ResetWorkspaceChanges` response message.' + type: object + properties: {} FetchFileDiffResponse: id: FetchFileDiffResponse description: '`FetchFileDiff` response message.' @@ -656,6 +1054,11 @@ components: Required. The directory's full path including directory name, relative to the workspace root. type: string + RemoveDirectoryResponse: + id: RemoveDirectoryResponse + description: '`RemoveDirectory` response message.' + type: object + properties: {} MoveDirectoryRequest: id: MoveDirectoryRequest description: '`MoveDirectory` request message.' @@ -695,6 +1098,11 @@ components: Required. The file's full path including filename, relative to the workspace root. type: string + RemoveFileResponse: + id: RemoveFileResponse + description: '`RemoveFile` response message.' + type: object + properties: {} MoveFileRequest: id: MoveFileRequest description: '`MoveFile` request message.' @@ -806,6 +1214,13 @@ components: disabled: description: Optional. Disables automatic creation of compilation results. type: boolean + internalMetadata: + description: >- + Output only. All the metadata information that is used internally to + serve the resource. For example: timestamps, flags, status fields, + etc. The format of this field is a JSON string. + readOnly: true + type: string CodeCompilationConfig: id: CodeCompilationConfig description: Configures various aspects of Dataform code compilation. @@ -846,16 +1261,28 @@ components: tablePrefix: description: Optional. The prefix that should be prepended to all table names. type: string + builtinAssertionNamePrefix: + description: Optional. The prefix to prepend to built-in assertion names. + type: string defaultNotebookRuntimeOptions: + description: Optional. The default notebook runtime options. $ref: '#/components/schemas/NotebookRuntimeOptions' NotebookRuntimeOptions: id: NotebookRuntimeOptions + description: Configures various aspects of Dataform notebook runtime. type: object properties: gcsOutputBucket: description: >- - Optional. The GCS location to upload the result to. Format: - `gs://bucket-name`. + Optional. The Google Cloud Storage location to upload the result to. + Format: `gs://bucket-name`. + type: string + aiPlatformNotebookRuntimeTemplate: + description: >- + Optional. The resource name of the [Colab runtime template] + (https://cloud.google.com/colab/docs/runtimes), from which a runtime + is created for notebook executions. If not specified, a runtime is + created with Colab's default specifications. type: string ScheduledReleaseRecord: id: ScheduledReleaseRecord @@ -864,53 +1291,22 @@ components: config. type: object properties: - compilationResult: - description: >- - The name of the created compilation result, if one was successfully - created. Must be in the format - `projects/*/locations/*/repositories/*/compilationResults/*`. - type: string - errorStatus: - description: >- - The error status encountered upon this attempt to create the - compilation result, if the attempt was unsuccessful. - $ref: '#/components/schemas/Status' - releaseTime: - description: The timestamp of this release attempt. - type: string - format: google-datetime - Status: - id: Status - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - type: object - properties: - code: - description: The status code, which should be an enum value of google.rpc.Code. - type: integer - format: int32 - message: + compilationResult: description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. + The name of the created compilation result, if one was successfully + created. Must be in the format + `projects/*/locations/*/repositories/*/compilationResults/*`. type: string - details: + errorStatus: description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - type: array - items: - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. + The error status encountered upon this attempt to create the + compilation result, if the attempt was unsuccessful. + $ref: '#/components/schemas/Status' + releaseTime: + description: Output only. The timestamp of this release attempt. + readOnly: true + type: string + format: google-datetime ListCompilationResultsResponse: id: ListCompilationResultsResponse description: '`ListCompilationResults` response message.' @@ -991,6 +1387,13 @@ components: readOnly: true type: string format: google-datetime + internalMetadata: + description: >- + Output only. All the metadata information that is used internally to + serve the resource. For example: timestamps, flags, status fields, + etc. The format of this field is a JSON string. + readOnly: true + type: string CompilationError: id: CompilationError description: An error encountered when attempting to compile a Dataform project. @@ -1024,13 +1427,15 @@ components: type: object properties: database: - description: The action's database (Google Cloud project ID) . + description: Optional. The action's database (Google Cloud project ID) . type: string schema: - description: The action's schema (BigQuery dataset ID), within `database`. + description: >- + Optional. The action's schema (BigQuery dataset ID), within + `database`. type: string name: - description: The action's name, within `database` and `schema`. + description: Optional. The action's name, within `database` and `schema`. type: string QueryCompilationResultActionsResponse: id: QueryCompilationResultActionsResponse @@ -1067,6 +1472,9 @@ components: notebook: description: The notebook executed by this action. $ref: '#/components/schemas/Notebook' + dataPreparation: + description: The data preparation executed by this action. + $ref: '#/components/schemas/DataPreparation' target: description: This action's identifier. Unique within the compilation result. $ref: '#/components/schemas/Target' @@ -1080,6 +1488,13 @@ components: The full path including filename in which this action is located, relative to the workspace root. type: string + internalMetadata: + description: >- + Output only. All the metadata information that is used internally to + serve the resource. For example: timestamps, flags, status fields, + etc. The format of this field is a JSON string. + readOnly: true + type: string Relation: id: Relation description: Represents a database relation. @@ -1325,6 +1740,7 @@ components: $ref: '#/components/schemas/RelationDescriptor' Notebook: id: Notebook + description: Represents a notebook. type: object properties: dependencyTargets: @@ -1343,6 +1759,96 @@ components: type: array items: type: string + DataPreparation: + id: DataPreparation + description: Defines a compiled Data Preparation entity + type: object + properties: + contentsYaml: + description: The data preparation definition, stored as a YAML string. + type: string + contentsSql: + description: >- + SQL definition for a Data Preparation. Contains a SQL query and + additional context information. + $ref: '#/components/schemas/SqlDefinition' + dependencyTargets: + description: A list of actions that this action depends on. + type: array + items: + $ref: '#/components/schemas/Target' + disabled: + description: Whether this action is disabled (i.e. should not be run). + type: boolean + tags: + description: Arbitrary, user-defined tags on this action. + type: array + items: + type: string + SqlDefinition: + id: SqlDefinition + description: Definition of a SQL Data Preparation + type: object + properties: + query: + description: >- + The SQL query representing the data preparation steps. Formatted as + a Pipe SQL query statement. + type: string + errorTable: + description: Error table configuration, + $ref: '#/components/schemas/ErrorTable' + load: + description: Load configuration. + $ref: '#/components/schemas/LoadConfig' + ErrorTable: + id: ErrorTable + description: Error table information, used to write error data into a BigQuery table. + type: object + properties: + target: + description: Error Table target. + $ref: '#/components/schemas/Target' + retentionDays: + description: >- + Error table partition expiration in days. Only positive values are + allowed. + type: integer + format: int32 + LoadConfig: + id: LoadConfig + description: Simplified load configuration for actions + type: object + properties: + replace: + description: Replace destination table + $ref: '#/components/schemas/SimpleLoadMode' + append: + description: Append into destination table + $ref: '#/components/schemas/SimpleLoadMode' + maximum: + description: >- + Insert records where the value exceeds the previous maximum value + for a column in the destination table + $ref: '#/components/schemas/IncrementalLoadMode' + unique: + description: >- + Insert records where the value of a column is not already present in + the destination table + $ref: '#/components/schemas/IncrementalLoadMode' + SimpleLoadMode: + id: SimpleLoadMode + description: Simple load definition + type: object + properties: {} + IncrementalLoadMode: + id: IncrementalLoadMode + description: Load definition for incremental load modes + type: object + properties: + column: + description: Column name for incremental load modes + type: string ListWorkflowConfigsResponse: id: ListWorkflowConfigsResponse description: '`ListWorkflowConfigs` response message.' @@ -1402,6 +1908,9 @@ components: type: array items: $ref: '#/components/schemas/ScheduledExecutionRecord' + disabled: + description: Optional. Disables automatic creation of workflow invocations. + type: boolean createTime: description: Output only. The timestamp of when the WorkflowConfig was created. readOnly: true @@ -1414,6 +1923,13 @@ components: readOnly: true type: string format: google-datetime + internalMetadata: + description: >- + Output only. All the metadata information that is used internally to + serve the resource. For example: timestamps, flags, status fields, + etc. The format of this field is a JSON string. + readOnly: true + type: string InvocationConfig: id: InvocationConfig description: >- @@ -1469,7 +1985,8 @@ components: workflow invocation, if the attempt was unsuccessful. $ref: '#/components/schemas/Status' executionTime: - description: The timestamp of this execution attempt. + description: Output only. The timestamp of this execution attempt. + readOnly: true type: string format: google-datetime ListWorkflowInvocationsResponse: @@ -1550,6 +2067,13 @@ components: description: Output only. Only set if the repository has a KMS Key. readOnly: true $ref: '#/components/schemas/DataEncryptionState' + internalMetadata: + description: >- + Output only. All the metadata information that is used internally to + serve the resource. For example: timestamps, flags, status fields, + etc. The format of this field is a JSON string. + readOnly: true + type: string Interval: id: Interval description: >- @@ -1577,6 +2101,11 @@ components: description: '`CancelWorkflowInvocation` request message.' type: object properties: {} + CancelWorkflowInvocationResponse: + id: CancelWorkflowInvocationResponse + description: '`CancelWorkflowInvocation` response message.' + type: object + properties: {} QueryWorkflowInvocationActionsResponse: id: QueryWorkflowInvocationActionsResponse description: '`QueryWorkflowInvocationActions` response message.' @@ -1605,6 +2134,10 @@ components: description: Output only. The workflow action's notebook action details. readOnly: true $ref: '#/components/schemas/NotebookAction' + dataPreparationAction: + description: Output only. The workflow action's data preparation action details. + readOnly: true + $ref: '#/components/schemas/DataPreparationAction' target: description: >- Output only. This action's identifier. Unique within the workflow @@ -1656,6 +2189,13 @@ components: FAILED] state. readOnly: true $ref: '#/components/schemas/Interval' + internalMetadata: + description: >- + Output only. All the metadata information that is used internally to + serve the resource. For example: timestamps, flags, status fields, + etc. The format of this field is a JSON string. + readOnly: true + type: string BigQueryAction: id: BigQueryAction description: Represents a workflow action that will run against BigQuery. @@ -1685,328 +2225,165 @@ components: jobId: description: >- Output only. The ID of the Vertex job that executed the notebook in - contents and also the ID used for the outputs created in GCS - buckets. Only set once the job has started to run. + contents and also the ID used for the outputs created in Google + Cloud Storage buckets. Only set once the job has started to run. readOnly: true - type: string - Config: - id: Config - description: Config for all repositories in a given project and location. - type: object - properties: - name: - description: Identifier. The config name. - type: string - defaultKmsKeyName: - description: >- - Optional. The default KMS key that is used if no encryption key is - provided when a repository is created. - type: string - ListLocationsResponse: - id: ListLocationsResponse - description: The response message for Locations.ListLocations. - type: object - properties: - locations: - description: >- - A list of locations that matches the specified filter in the - request. - type: array - items: - $ref: '#/components/schemas/Location' - nextPageToken: - description: The standard List next-page token. - type: string - Location: - id: Location - description: A resource that represents a Google Cloud location. - type: object - properties: - name: - description: >- - Resource name for the location, which may vary between - implementations. For example: - `"projects/example-project/locations/us-east1"` - type: string - locationId: - description: 'The canonical id for this location. For example: `"us-east1"`.' - type: string - displayName: - description: >- - The friendly name for this location, typically a nearby city name. - For example, "Tokyo". - type: string - labels: - description: >- - Cross-service attributes for the location. For example - {"cloud.googleapis.com/region": "us-east1"} - type: object - additionalProperties: - type: string - metadata: - description: >- - Service-specific metadata. For example the available capacity at the - given location. - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - SetIamPolicyRequest: - id: SetIamPolicyRequest - description: Request message for `SetIamPolicy` method. - type: object - properties: - policy: - description: >- - REQUIRED: The complete policy to be applied to the `resource`. The - size of the policy is limited to a few 10s of KB. An empty policy is - a valid policy but certain Google Cloud services (such as Projects) - might reject them. - $ref: '#/components/schemas/Policy' - Policy: - id: Policy - description: >- - An Identity and Access Management (IAM) policy, which specifies access - controls for Google Cloud resources. A `Policy` is a collection of - `bindings`. A `binding` binds one or more `members`, or principals, to a - single `role`. Principals can be user accounts, service accounts, Google - groups, and domains (such as G Suite). A `role` is a named list of - permissions; each `role` can be an IAM predefined role or a user-created - custom role. For some types of Google Cloud resources, a `binding` can - also specify a `condition`, which is a logical expression that allows - access to a resource only if the expression evaluates to `true`. A - condition can add constraints based on attributes of the request, the - resource, or both. To learn which resources support conditions in their - IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - **JSON example:** ``` { "bindings": [ { "role": - "roles/resourcemanager.organizationAdmin", "members": [ - "user:mike@example.com", "group:admins@example.com", - "domain:google.com", - "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { - "role": "roles/resourcemanager.organizationViewer", "members": [ - "user:eve@example.com" ], "condition": { "title": "expirable access", - "description": "Does not grant access after Sep 2020", "expression": - "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": - "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - - members: - user:mike@example.com - group:admins@example.com - - domain:google.com - - serviceAccount:my-project-id@appspot.gserviceaccount.com role: - roles/resourcemanager.organizationAdmin - members: - - user:eve@example.com role: roles/resourcemanager.organizationViewer - condition: title: expirable access description: Does not grant access - after Sep 2020 expression: request.time < - timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` - For a description of IAM and its features, see the [IAM - documentation](https://cloud.google.com/iam/docs/). - type: object - properties: - 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). - type: integer - format: int32 - bindings: - description: >- - Associates a list of `members`, or principals, with a `role`. - Optionally, may specify a `condition` that determines how and when - the `bindings` are applied. Each of the `bindings` must contain at - least one principal. The `bindings` in a `Policy` can refer to up to - 1,500 principals; up to 250 of these principals can be Google - groups. Each occurrence of a principal counts towards these limits. - For example, if the `bindings` grant 50 different roles to - `user:alice@example.com`, and not to any other principal, then you - can add another 1,450 principals to the `bindings` in the `Policy`. - type: array - items: - $ref: '#/components/schemas/Binding' - 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. - type: string - format: byte - Binding: - id: Binding - description: Associates `members`, or principals, with a `role`. + type: string + DataPreparationAction: + id: DataPreparationAction + description: Represents a workflow action that will run a Data Preparation. type: object properties: - role: + contentsYaml: description: >- - Role that is assigned to the list of `members`, or principals. For - example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an - overview of the IAM roles and permissions, see the [IAM - documentation](https://cloud.google.com/iam/docs/roles-overview). - For a list of the available pre-defined roles, see - [here](https://cloud.google.com/iam/docs/understanding-roles). + Output only. YAML representing the contents of the data preparation. + Can be used to show the customer what the input was to their + workflow. + readOnly: true type: string - members: + contentsSql: description: >- - Specifies the principals requesting access for a Google Cloud - 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. Does not include identities - that come from external identity providers (IdPs) through identity - federation. * `user:{emailid}`: An email address that represents a - specific Google account. For example, `alice@example.com` . * - `serviceAccount:{emailid}`: An email address that represents a - Google service account. For example, - `my-other-app@appspot.gserviceaccount.com`. * - `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: - An identifier for a [Kubernetes service - account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). - For example, - `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * - `group:{emailid}`: An email address that represents a Google group. - For example, `admins@example.com`. * `domain:{domain}`: The G Suite - domain (primary) that represents all the users of that domain. For - example, `google.com` or `example.com`. * - `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workforce identity pool. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: - All workforce identities in a group. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All workforce identities with a specific attribute value. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: - All identities in a workforce identity pool. * - `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workload identity pool. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: - A workload identity pool group. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All identities in a workload identity pool with a certain attribute. - * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: - All identities in a workload identity pool. * - `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. * - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - Deleted single identity in a workforce identity pool. For example, - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. - type: array - items: - type: string - condition: + SQL definition for a Data Preparation. Contains a SQL query and + additional context information. + $ref: '#/components/schemas/ActionSqlDefinition' + generatedSql: description: >- - The condition that is associated with this binding. If the condition - evaluates to `true`, then this binding applies to the current - request. If the condition evaluates to `false`, then this binding - does not apply to the current request. However, a different role - binding might grant the same role to one or more of the principals - in this binding. To learn which resources support conditions in - their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - $ref: '#/components/schemas/Expr' - Expr: - id: 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. + Output only. The generated BigQuery SQL script that will be + executed. For reference only. + readOnly: true + type: string + jobId: + description: >- + Output only. The ID of the BigQuery job that executed the SQL in + sql_script. Only set once the job has started to run. + readOnly: true + type: string + ActionSqlDefinition: + id: ActionSqlDefinition + description: Definition of a SQL Data Preparation type: object properties: - expression: + query: description: >- - Textual representation of an expression in Common Expression - Language syntax. - type: string - title: + The SQL query representing the data preparation steps. Formatted as + a Pipe SQL query statement. + type: string + errorTable: + description: Error table configuration, + $ref: '#/components/schemas/ActionErrorTable' + loadConfig: + description: Load configuration. + $ref: '#/components/schemas/ActionLoadConfig' + ActionErrorTable: + id: ActionErrorTable + description: Error table information, used to write error data into a BigQuery table. + type: object + properties: + target: + description: Error Table target. + $ref: '#/components/schemas/Target' + retentionDays: 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 - description: + Error table partition expiration in days. Only positive values are + allowed. + type: integer + format: int32 + ActionLoadConfig: + id: ActionLoadConfig + description: Simplified load configuration for actions + type: object + properties: + replace: + description: Replace destination table + $ref: '#/components/schemas/ActionSimpleLoadMode' + append: + description: Append into destination table + $ref: '#/components/schemas/ActionSimpleLoadMode' + maximum: description: >- - Optional. Description of the expression. This is a longer text which - describes the expression, e.g. when hovered over it in a UI. + Insert records where the value exceeds the previous maximum value + for a column in the destination table + $ref: '#/components/schemas/ActionIncrementalLoadMode' + unique: + description: >- + Insert records where the value of a column is not already present in + the destination table + $ref: '#/components/schemas/ActionIncrementalLoadMode' + ActionSimpleLoadMode: + id: ActionSimpleLoadMode + description: Simple load definition + type: object + properties: {} + ActionIncrementalLoadMode: + id: ActionIncrementalLoadMode + description: Load definition for incremental load modes + type: object + properties: + column: + description: Column name for incremental load modes type: string - location: + Config: + id: Config + description: Config for all repositories in a given project and location. + type: object + properties: + name: + description: Identifier. The config name. + type: string + defaultKmsKeyName: description: >- - Optional. String indicating the location of the expression for error - reporting, e.g. a file name and a position in the file. + Optional. The default KMS key that is used if no encryption key is + provided when a repository is created. type: string - TestIamPermissionsRequest: - id: TestIamPermissionsRequest - description: Request message for `TestIamPermissions` method. + ListLocationsResponse: + id: ListLocationsResponse + description: The response message for Locations.ListLocations. type: object properties: - permissions: + locations: description: >- - The set of permissions to check for the `resource`. Permissions with - wildcards (such as `*` or `storage.*`) are not allowed. For more - information see [IAM - Overview](https://cloud.google.com/iam/docs/overview#permissions). + A list of locations that matches the specified filter in the + request. type: array items: - type: string - TestIamPermissionsResponse: - id: TestIamPermissionsResponse - description: Response message for `TestIamPermissions` method. + $ref: '#/components/schemas/Location' + nextPageToken: + description: The standard List next-page token. + type: string + Location: + id: Location + description: A resource that represents a Google Cloud location. type: object properties: - permissions: + name: description: >- - A subset of `TestPermissionsRequest.permissions` that the caller is - allowed. - type: array - items: + Resource name for the location, which may vary between + implementations. For example: + `"projects/example-project/locations/us-east1"` + type: string + locationId: + description: 'The canonical id for this location. For example: `"us-east1"`.' + type: string + displayName: + description: >- + The friendly name for this location, typically a nearby city name. + For example, "Tokyo". + type: string + labels: + description: >- + Cross-service attributes for the location. For example + {"cloud.googleapis.com/region": "us-east1"} + type: object + additionalProperties: type: string + metadata: + description: >- + Service-specific metadata. For example the available capacity at the + given location. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. OperationMetadata: id: OperationMetadata description: Represents the metadata of the long-running operation. @@ -2040,14 +2417,59 @@ components: description: >- Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully - have Operation.error value with a google.rpc.Status.code of 1, - corresponding to `Code.CANCELLED`. + have google.longrunning.Operation.error value with a + google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. readOnly: true type: boolean apiVersion: description: Output only. API version used to start the operation. readOnly: true type: string + IamPolicyOverrideView: + id: IamPolicyOverrideView + description: >- + Contains metadata about the IAM policy override for a given Dataform + resource. If is_active is true, this the policy encoded in + iam_policy_name is the source of truth for this resource. Will be + provided in internal ESV2 views for: Workspaces, Repositories, Folders, + TeamFolders. + type: object + properties: + iamPolicyName: + description: The IAM policy name for the resource. + $ref: '#/components/schemas/PolicyName' + isActive: + description: Whether the IAM policy encoded in this view is active. + type: boolean + PolicyName: + id: PolicyName + description: >- + An internal name for an IAM policy, based on the resource to which the + policy applies. Not to be confused with a resource's external full + resource name. For more information on this distinction, see + go/iam-full-resource-names. + type: object + properties: + type: + description: >- + Resource type. Types are defined in IAM's .service files. Valid + values for type might be 'storage_buckets', 'compute_instances', + 'resourcemanager_customers', 'billing_accounts', etc. + type: string + id: + description: >- + Identifies an instance of the type. ID format varies by type. The ID + format is defined in the IAM .service file that defines the type, + either in path_mapping or in a comment. + type: string + region: + description: >- + For Cloud IAM: The location of the Policy. Must be empty or "global" + for Policies owned by global IAM. Must name a region from + prodspec/cloud-iam-cloudspec for Regional IAM Policies, see + go/iam-faq#where-is-iam-currently-deployed. For Local IAM: This + field should be set to "local". + type: string parameters: access_token: description: OAuth access token. @@ -2183,6 +2605,43 @@ components: update: [] replace: [] delete: [] + repositories_iam_policies: + id: google.dataform.repositories_iam_policies + name: repositories_iam_policies + title: Repositories_iam_policies + methods: + set_iam_policy: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}:setIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + get_iam_policy: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}:getIamPolicy/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.bindings + test_iam_permissions: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}:testIamPermissions/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/repositories_iam_policies/methods/get_iam_policy + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/repositories_iam_policies/methods/set_iam_policy + delete: [] repositories: id: google.dataform.repositories name: repositories @@ -2305,22 +2764,22 @@ components: update: [] replace: [] delete: [] - repositories_iam_policies: - id: google.dataform.repositories_iam_policies - name: repositories_iam_policies - title: Repositories_iam_policies + workspaces_iam_policies: + id: google.dataform.workspaces_iam_policies + name: workspaces_iam_policies + title: Workspaces_iam_policies methods: set_iam_policy: operation: $ref: >- - #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}:setIamPolicy/post + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1workspaces~1{workspacesId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' get_iam_policy: operation: $ref: >- - #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}:getIamPolicy/get + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1workspaces~1{workspacesId}:getIamPolicy/get response: mediaType: application/json openAPIDocKey: '200' @@ -2328,19 +2787,19 @@ components: test_iam_permissions: operation: $ref: >- - #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}:testIamPermissions/post + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1workspaces~1{workspacesId}:testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/repositories_iam_policies/methods/get_iam_policy + #/components/x-stackQL-resources/workspaces_iam_policies/methods/get_iam_policy insert: [] update: [] replace: - $ref: >- - #/components/x-stackQL-resources/repositories_iam_policies/methods/set_iam_policy + #/components/x-stackQL-resources/workspaces_iam_policies/methods/set_iam_policy delete: [] workspaces: id: google.dataform.workspaces @@ -2432,6 +2891,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + remove_directory: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1workspaces~1{workspacesId}:removeDirectory/post + response: + mediaType: application/json + openAPIDocKey: '200' move_directory: operation: $ref: >- @@ -2446,6 +2912,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + remove_file: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1workspaces~1{workspacesId}:removeFile/post + response: + mediaType: application/json + openAPIDocKey: '200' move_file: operation: $ref: >- @@ -2532,83 +3005,6 @@ components: update: [] replace: [] delete: [] - workspaces_directory: - id: google.dataform.workspaces_directory - name: workspaces_directory - title: Workspaces_directory - methods: - remove_directory: - operation: - $ref: >- - #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1workspaces~1{workspacesId}:removeDirectory/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/workspaces_directory/methods/remove_directory - workspaces_file: - id: google.dataform.workspaces_file - name: workspaces_file - title: Workspaces_file - methods: - remove_file: - operation: - $ref: >- - #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1workspaces~1{workspacesId}:removeFile/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/workspaces_file/methods/remove_file - workspaces_iam_policies: - id: google.dataform.workspaces_iam_policies - name: workspaces_iam_policies - title: Workspaces_iam_policies - methods: - set_iam_policy: - operation: - $ref: >- - #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1workspaces~1{workspacesId}:setIamPolicy/post - response: - mediaType: application/json - openAPIDocKey: '200' - get_iam_policy: - operation: - $ref: >- - #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1workspaces~1{workspacesId}:getIamPolicy/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.bindings - test_iam_permissions: - operation: - $ref: >- - #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1workspaces~1{workspacesId}:testIamPermissions/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/workspaces_iam_policies/methods/get_iam_policy - insert: [] - update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/workspaces_iam_policies/methods/set_iam_policy - delete: [] release_configs: id: google.dataform.release_configs name: release_configs @@ -2820,103 +3216,123 @@ components: delete: - $ref: >- #/components/x-stackQL-resources/workflow_invocations/methods/delete - comment_threads_iam_policies: - id: google.dataform.comment_threads_iam_policies - name: comment_threads_iam_policies - title: Comment_threads_iam_policies + folders_iam_policies: + id: google.dataform.folders_iam_policies + name: folders_iam_policies + title: Folders_iam_policies methods: set_iam_policy: operation: $ref: >- - #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1commentThreads~1{commentThreadsId}:setIamPolicy/post + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1folders~1{foldersId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' get_iam_policy: operation: $ref: >- - #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1commentThreads~1{commentThreadsId}:getIamPolicy/get + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1folders~1{foldersId}:getIamPolicy/get response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings + test_iam_permissions: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1folders~1{foldersId}:testIamPermissions/post + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/comment_threads_iam_policies/methods/get_iam_policy + #/components/x-stackQL-resources/folders_iam_policies/methods/get_iam_policy insert: [] update: [] replace: - $ref: >- - #/components/x-stackQL-resources/comment_threads_iam_policies/methods/set_iam_policy + #/components/x-stackQL-resources/folders_iam_policies/methods/set_iam_policy delete: [] - comments_iam_policies: - id: google.dataform.comments_iam_policies - name: comments_iam_policies - title: Comments_iam_policies + team_folders_iam_policies: + id: google.dataform.team_folders_iam_policies + name: team_folders_iam_policies + title: Team_folders_iam_policies methods: set_iam_policy: operation: $ref: >- - #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1commentThreads~1{commentThreadsId}~1comments~1{commentsId}:setIamPolicy/post + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1teamFolders~1{teamFoldersId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' get_iam_policy: operation: $ref: >- - #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1commentThreads~1{commentThreadsId}~1comments~1{commentsId}:getIamPolicy/get + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1teamFolders~1{teamFoldersId}:getIamPolicy/get response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings + test_iam_permissions: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1teamFolders~1{teamFoldersId}:testIamPermissions/post + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/comments_iam_policies/methods/get_iam_policy + #/components/x-stackQL-resources/team_folders_iam_policies/methods/get_iam_policy insert: [] update: [] replace: - $ref: >- - #/components/x-stackQL-resources/comments_iam_policies/methods/set_iam_policy + #/components/x-stackQL-resources/team_folders_iam_policies/methods/set_iam_policy delete: [] - collections_iam_policies: - id: google.dataform.collections_iam_policies - name: collections_iam_policies - title: Collections_iam_policies + operations: + id: google.dataform.operations + name: operations + title: Operations methods: - set_iam_policy: + list: operation: $ref: >- - #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}:setIamPolicy/post + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get response: mediaType: application/json openAPIDocKey: '200' - get_iam_policy: + objectKey: $.operations + get: operation: $ref: >- - #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}:getIamPolicy/get + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.bindings - test_iam_permissions: + delete: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + cancel: operation: $ref: >- - #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}:testIamPermissions/post + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/collections_iam_policies/methods/get_iam_policy + - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/collections_iam_policies/methods/set_iam_policy - delete: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/operations/methods/delete' paths: /v1beta1/projects/{projectsId}/locations/{locationsId}/config: parameters: &ref_1 @@ -2935,6 +3351,10 @@ paths: description: Get default config for a given project and location. operationId: dataform.projects.locations.getConfig security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -2958,7 +3378,12 @@ paths: schema: type: string patch: - description: Update default config for a given project and location. + description: >- + Update default config for a given project and location. **Note:** *This + method does not fully implement [AIP/134](https://google.aip.dev/134). + The wildcard entry (\*) is treated as a bad request, and when the + `field_mask` is omitted, the request is treated as a full update on all + modifiable fields.* operationId: dataform.projects.locations.updateConfig requestBody: content: @@ -2966,6 +3391,10 @@ paths: schema: $ref: '#/components/schemas/Config' security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -2999,6 +3428,10 @@ paths: description: Lists information about the supported locations for this service. operationId: dataform.projects.locations.list security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -3029,12 +3462,151 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v1beta1/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: description: Gets information about a location. operationId: dataform.projects.locations.get security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Location' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:setIamPolicy: + parameters: *ref_1 + post: + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and + `PERMISSION_DENIED` errors. + operationId: dataform.projects.locations.repositories.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetIamPolicyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: repositoriesId + required: true + schema: + type: string + /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:getIamPolicy: + parameters: *ref_1 + get: + description: >- + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: dataform.projects.locations.repositories.getIamPolicy + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: repositoriesId + required: true + schema: + type: string + - in: query + name: options.requestedPolicyVersion + schema: + type: integer + format: int32 + /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:testIamPermissions: + parameters: *ref_1 + post: + description: >- + Returns permissions that a caller has on the specified resource. If the + resource does not exist, this will return an empty set of permissions, + not a `NOT_FOUND` error. Note: This operation is designed to be used for + building permission-aware UIs and command-line tools, not for + authorization checking. This operation may "fail open" without warning. + operationId: dataform.projects.locations.repositories.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -3045,7 +3617,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Location' + $ref: '#/components/schemas/TestIamPermissionsResponse' parameters: - in: path name: projectsId @@ -3057,12 +3629,24 @@ paths: required: true schema: type: string + - in: path + name: repositoriesId + required: true + schema: + type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories: parameters: *ref_1 get: - description: Lists Repositories in a given project and location. + description: >- + Lists Repositories in a given project and location. **Note:** *This + method can return repositories not shown in the [Dataform + UI](https://console.cloud.google.com/bigquery/dataform)*. operationId: dataform.projects.locations.repositories.list security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -3111,6 +3695,10 @@ paths: schema: $ref: '#/components/schemas/Repository' security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -3143,6 +3731,10 @@ paths: description: Fetches a single Repository. operationId: dataform.projects.locations.repositories.get security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -3171,7 +3763,11 @@ paths: schema: type: string patch: - description: Updates a single Repository. + description: >- + Updates a single Repository. **Note:** *This method does not fully + implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\*) + is treated as a bad request, and when the `field_mask` is omitted, the + request is treated as a full update on all modifiable fields.* operationId: dataform.projects.locations.repositories.patch requestBody: content: @@ -3179,6 +3775,10 @@ paths: schema: $ref: '#/components/schemas/Repository' security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -3215,6 +3815,10 @@ paths: description: Deletes a single Repository. operationId: dataform.projects.locations.repositories.delete security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -3259,6 +3863,10 @@ paths: schema: $ref: '#/components/schemas/CommitRepositoryChangesRequest' security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -3294,6 +3902,10 @@ paths: must not have a value for `git_remote_settings.url`. operationId: dataform.projects.locations.repositories.readFile security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -3337,6 +3949,10 @@ paths: must not have a value for `git_remote_settings.url`. operationId: dataform.projects.locations.repositories.queryDirectoryContents security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -3389,6 +4005,10 @@ paths: a value for `git_remote_settings.url`. operationId: dataform.projects.locations.repositories.fetchHistory security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -3431,6 +4051,10 @@ paths: description: Computes a Repository's Git access token status. operationId: dataform.projects.locations.repositories.computeAccessTokenStatus security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -3465,6 +4089,10 @@ paths: description: Fetches a Repository's remote branches. operationId: dataform.projects.locations.repositories.fetchRemoteBranches security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -3492,20 +4120,24 @@ paths: required: true schema: type: string - /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:setIamPolicy: + /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:setIamPolicy: parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. - operationId: dataform.projects.locations.repositories.setIamPolicy + operationId: dataform.projects.locations.repositories.workspaces.setIamPolicy requestBody: content: application/json: schema: $ref: '#/components/schemas/SetIamPolicyRequest' security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -3533,14 +4165,23 @@ paths: required: true schema: type: string - /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:getIamPolicy: + - in: path + name: workspacesId + required: true + schema: + type: string + /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:getIamPolicy: parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - operationId: dataform.projects.locations.repositories.getIamPolicy + operationId: dataform.projects.locations.repositories.workspaces.getIamPolicy security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -3568,12 +4209,17 @@ paths: required: true schema: type: string + - in: path + name: workspacesId + required: true + schema: + type: string - in: query name: options.requestedPolicyVersion schema: type: integer format: int32 - /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:testIamPermissions: + /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:testIamPermissions: parameters: *ref_1 post: description: >- @@ -3582,13 +4228,17 @@ paths: not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. - operationId: dataform.projects.locations.repositories.testIamPermissions + operationId: dataform.projects.locations.repositories.workspaces.testIamPermissions requestBody: content: application/json: schema: $ref: '#/components/schemas/TestIamPermissionsRequest' security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -3616,12 +4266,21 @@ paths: required: true schema: type: string + - in: path + name: workspacesId + required: true + schema: + type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces: parameters: *ref_1 get: description: Lists Workspaces in a given Repository. operationId: dataform.projects.locations.repositories.workspaces.list security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -3675,6 +4334,10 @@ paths: schema: $ref: '#/components/schemas/Workspace' security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -3712,6 +4375,10 @@ paths: description: Fetches a single Workspace. operationId: dataform.projects.locations.repositories.workspaces.get security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -3748,6 +4415,10 @@ paths: description: Deletes a single Workspace. operationId: dataform.projects.locations.repositories.workspaces.delete security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -3791,6 +4462,10 @@ paths: schema: $ref: '#/components/schemas/InstallNpmPackagesRequest' security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -3834,6 +4509,10 @@ paths: schema: $ref: '#/components/schemas/PullGitCommitsRequest' security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -3844,7 +4523,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/PullGitCommitsResponse' parameters: - in: path name: projectsId @@ -3877,6 +4556,10 @@ paths: schema: $ref: '#/components/schemas/PushGitCommitsRequest' security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -3887,7 +4570,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/PushGitCommitsResponse' parameters: - in: path name: projectsId @@ -3915,6 +4598,10 @@ paths: description: Fetches Git statuses for the files in a Workspace. operationId: dataform.projects.locations.repositories.workspaces.fetchFileGitStatuses security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -3953,6 +4640,10 @@ paths: description: Fetches Git ahead/behind against a remote branch. operationId: dataform.projects.locations.repositories.workspaces.fetchGitAheadBehind security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -4000,6 +4691,10 @@ paths: schema: $ref: '#/components/schemas/CommitWorkspaceChangesRequest' security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -4010,7 +4705,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/CommitWorkspaceChangesResponse' parameters: - in: path name: projectsId @@ -4043,6 +4738,10 @@ paths: schema: $ref: '#/components/schemas/ResetWorkspaceChangesRequest' security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -4053,7 +4752,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/ResetWorkspaceChangesResponse' parameters: - in: path name: projectsId @@ -4081,6 +4780,10 @@ paths: description: Fetches Git diff for an uncommitted file in a Workspace. operationId: dataform.projects.locations.repositories.workspaces.fetchFileDiff security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -4124,6 +4827,10 @@ paths: operationId: >- dataform.projects.locations.repositories.workspaces.queryDirectoryContents security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -4175,6 +4882,10 @@ paths: description: Finds the contents of a given Workspace directory by filter. operationId: dataform.projects.locations.repositories.workspaces.searchFiles security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -4231,6 +4942,10 @@ paths: schema: $ref: '#/components/schemas/MakeDirectoryRequest' security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -4274,6 +4989,10 @@ paths: schema: $ref: '#/components/schemas/RemoveDirectoryRequest' security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -4284,7 +5003,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/RemoveDirectoryResponse' parameters: - in: path name: projectsId @@ -4319,6 +5038,10 @@ paths: schema: $ref: '#/components/schemas/MoveDirectoryRequest' security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -4357,6 +5080,10 @@ paths: description: Returns the contents of a file (inside a Workspace). operationId: dataform.projects.locations.repositories.workspaces.readFile security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -4409,137 +5136,9 @@ paths: $ref: '#/components/schemas/RemoveFileRequest' security: - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Empty' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: repositoriesId - required: true - schema: - type: string - - in: path - name: workspacesId - required: true - schema: - type: string - /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:moveFile: - parameters: *ref_1 - post: - description: Moves a file (inside a Workspace) to a new location. - operationId: dataform.projects.locations.repositories.workspaces.moveFile - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MoveFileRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/MoveFileResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: repositoriesId - required: true - schema: - type: string - - in: path - name: workspacesId - required: true - schema: - type: string - /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:writeFile: - parameters: *ref_1 - post: - description: Writes to a file (inside a Workspace). - operationId: dataform.projects.locations.repositories.workspaces.writeFile - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/WriteFileRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform + - https://www.googleapis.com/auth/bigquery Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/WriteFileResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: repositoriesId - required: true - schema: - type: string - - in: path - name: workspacesId - required: true - schema: - type: string - /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:setIamPolicy: - parameters: *ref_1 - post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - `PERMISSION_DENIED` errors. - operationId: dataform.projects.locations.repositories.workspaces.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SetIamPolicyRequest' - security: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -4550,7 +5149,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/RemoveFileResponse' parameters: - in: path name: projectsId @@ -4570,16 +5169,23 @@ paths: - in: path name: workspacesId required: true - schema: - type: string - /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:getIamPolicy: - parameters: *ref_1 - get: - description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: dataform.projects.locations.repositories.workspaces.getIamPolicy + schema: + type: string + /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:moveFile: + parameters: *ref_1 + post: + description: Moves a file (inside a Workspace) to a new location. + operationId: dataform.projects.locations.repositories.workspaces.moveFile + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MoveFileRequest' security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -4590,7 +5196,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/MoveFileResponse' parameters: - in: path name: projectsId @@ -4612,27 +5218,21 @@ paths: required: true schema: type: string - - in: query - name: options.requestedPolicyVersion - schema: - type: integer - format: int32 - /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:testIamPermissions: + /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:writeFile: parameters: *ref_1 post: - description: >- - Returns permissions that a caller has on the specified resource. If the - resource does not exist, this will return an empty set of permissions, - not a `NOT_FOUND` error. Note: This operation is designed to be used for - building permission-aware UIs and command-line tools, not for - authorization checking. This operation may "fail open" without warning. - operationId: dataform.projects.locations.repositories.workspaces.testIamPermissions + description: Writes to a file (inside a Workspace). + operationId: dataform.projects.locations.repositories.workspaces.writeFile requestBody: content: application/json: schema: - $ref: '#/components/schemas/TestIamPermissionsRequest' + $ref: '#/components/schemas/WriteFileRequest' security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -4643,7 +5243,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TestIamPermissionsResponse' + $ref: '#/components/schemas/WriteFileResponse' parameters: - in: path name: projectsId @@ -4671,6 +5271,10 @@ paths: description: Lists ReleaseConfigs in a given Repository. operationId: dataform.projects.locations.repositories.releaseConfigs.list security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -4716,6 +5320,10 @@ paths: schema: $ref: '#/components/schemas/ReleaseConfig' security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -4753,6 +5361,10 @@ paths: description: Fetches a single ReleaseConfig. operationId: dataform.projects.locations.repositories.releaseConfigs.get security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -4786,7 +5398,11 @@ paths: schema: type: string patch: - description: Updates a single ReleaseConfig. + description: >- + Updates a single ReleaseConfig. **Note:** *This method does not fully + implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\*) + is treated as a bad request, and when the `field_mask` is omitted, the + request is treated as a full update on all modifiable fields.* operationId: dataform.projects.locations.repositories.releaseConfigs.patch requestBody: content: @@ -4794,6 +5410,10 @@ paths: schema: $ref: '#/components/schemas/ReleaseConfig' security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -4835,6 +5455,10 @@ paths: description: Deletes a single ReleaseConfig. operationId: dataform.projects.locations.repositories.releaseConfigs.delete security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -4873,6 +5497,10 @@ paths: description: Lists CompilationResults in a given Repository. operationId: dataform.projects.locations.repositories.compilationResults.list security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -4926,6 +5554,10 @@ paths: schema: $ref: '#/components/schemas/CompilationResult' security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -4959,6 +5591,10 @@ paths: description: Fetches a single CompilationResult. operationId: dataform.projects.locations.repositories.compilationResults.get security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -4997,6 +5633,10 @@ paths: description: Returns CompilationResultActions in a given CompilationResult. operationId: dataform.projects.locations.repositories.compilationResults.query security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -5048,6 +5688,10 @@ paths: description: Lists WorkflowConfigs in a given Repository. operationId: dataform.projects.locations.repositories.workflowConfigs.list security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -5093,6 +5737,10 @@ paths: schema: $ref: '#/components/schemas/WorkflowConfig' security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -5130,6 +5778,10 @@ paths: description: Fetches a single WorkflowConfig. operationId: dataform.projects.locations.repositories.workflowConfigs.get security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -5163,7 +5815,11 @@ paths: schema: type: string patch: - description: Updates a single WorkflowConfig. + description: >- + Updates a single WorkflowConfig. **Note:** *This method does not fully + implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\*) + is treated as a bad request, and when the `field_mask` is omitted, the + request is treated as a full update on all modifiable fields.* operationId: dataform.projects.locations.repositories.workflowConfigs.patch requestBody: content: @@ -5171,6 +5827,10 @@ paths: schema: $ref: '#/components/schemas/WorkflowConfig' security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -5212,6 +5872,10 @@ paths: description: Deletes a single WorkflowConfig. operationId: dataform.projects.locations.repositories.workflowConfigs.delete security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -5250,6 +5914,10 @@ paths: description: Lists WorkflowInvocations in a given Repository. operationId: dataform.projects.locations.repositories.workflowInvocations.list security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -5303,6 +5971,10 @@ paths: schema: $ref: '#/components/schemas/WorkflowInvocation' security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -5336,6 +6008,10 @@ paths: description: Fetches a single WorkflowInvocation. operationId: dataform.projects.locations.repositories.workflowInvocations.get security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -5372,6 +6048,10 @@ paths: description: Deletes a single WorkflowInvocation. operationId: dataform.projects.locations.repositories.workflowInvocations.delete security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -5415,6 +6095,10 @@ paths: schema: $ref: '#/components/schemas/CancelWorkflowInvocationRequest' security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -5425,7 +6109,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/CancelWorkflowInvocationResponse' parameters: - in: path name: projectsId @@ -5453,6 +6137,10 @@ paths: description: Returns WorkflowInvocationActions in a given WorkflowInvocation. operationId: dataform.projects.locations.repositories.workflowInvocations.query security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -5494,20 +6182,24 @@ paths: name: pageToken schema: type: string - /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/commentThreads/{commentThreadsId}:setIamPolicy: + /v1beta1/projects/{projectsId}/locations/{locationsId}/folders/{foldersId}:setIamPolicy: parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. - operationId: dataform.projects.locations.repositories.commentThreads.setIamPolicy + operationId: dataform.projects.locations.folders.setIamPolicy requestBody: content: application/json: schema: $ref: '#/components/schemas/SetIamPolicyRequest' security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -5531,23 +6223,22 @@ paths: schema: type: string - in: path - name: repositoriesId - required: true - schema: - type: string - - in: path - name: commentThreadsId + name: foldersId required: true schema: type: string - /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/commentThreads/{commentThreadsId}:getIamPolicy: + /v1beta1/projects/{projectsId}/locations/{locationsId}/folders/{foldersId}:getIamPolicy: parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - operationId: dataform.projects.locations.repositories.commentThreads.getIamPolicy + operationId: dataform.projects.locations.folders.getIamPolicy security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -5571,12 +6262,7 @@ paths: schema: type: string - in: path - name: repositoriesId - required: true - schema: - type: string - - in: path - name: commentThreadsId + name: foldersId required: true schema: type: string @@ -5585,21 +6271,26 @@ paths: schema: type: integer format: int32 - /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/commentThreads/{commentThreadsId}/comments/{commentsId}:setIamPolicy: + /v1beta1/projects/{projectsId}/locations/{locationsId}/folders/{foldersId}:testIamPermissions: parameters: *ref_1 post: description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - `PERMISSION_DENIED` errors. - operationId: >- - dataform.projects.locations.repositories.commentThreads.comments.setIamPolicy + Returns permissions that a caller has on the specified resource. If the + resource does not exist, this will return an empty set of permissions, + not a `NOT_FOUND` error. Note: This operation is designed to be used for + building permission-aware UIs and command-line tools, not for + authorization checking. This operation may "fail open" without warning. + operationId: dataform.projects.locations.folders.testIamPermissions requestBody: content: application/json: schema: - $ref: '#/components/schemas/SetIamPolicyRequest' + $ref: '#/components/schemas/TestIamPermissionsRequest' security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -5610,7 +6301,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/TestIamPermissionsResponse' parameters: - in: path name: projectsId @@ -5623,29 +6314,67 @@ paths: schema: type: string - in: path - name: repositoriesId + name: foldersId + required: true + schema: + type: string + /v1beta1/projects/{projectsId}/locations/{locationsId}/teamFolders/{teamFoldersId}:setIamPolicy: + parameters: *ref_1 + post: + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and + `PERMISSION_DENIED` errors. + operationId: dataform.projects.locations.teamFolders.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetIamPolicyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: projectsId required: true schema: type: string - in: path - name: commentThreadsId + name: locationsId required: true schema: type: string - in: path - name: commentsId + name: teamFoldersId required: true schema: type: string - /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/commentThreads/{commentThreadsId}/comments/{commentsId}:getIamPolicy: + /v1beta1/projects/{projectsId}/locations/{locationsId}/teamFolders/{teamFoldersId}:getIamPolicy: parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - operationId: >- - dataform.projects.locations.repositories.commentThreads.comments.getIamPolicy + operationId: dataform.projects.locations.teamFolders.getIamPolicy security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -5669,17 +6398,7 @@ paths: schema: type: string - in: path - name: repositoriesId - required: true - schema: - type: string - - in: path - name: commentThreadsId - required: true - schema: - type: string - - in: path - name: commentsId + name: teamFoldersId required: true schema: type: string @@ -5688,20 +6407,26 @@ paths: schema: type: integer format: int32 - /v1beta1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}:setIamPolicy: + /v1beta1/projects/{projectsId}/locations/{locationsId}/teamFolders/{teamFoldersId}:testIamPermissions: parameters: *ref_1 post: description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - `PERMISSION_DENIED` errors. - operationId: dataform.projects.locations.collections.setIamPolicy + Returns permissions that a caller has on the specified resource. If the + resource does not exist, this will return an empty set of permissions, + not a `NOT_FOUND` error. Note: This operation is designed to be used for + building permission-aware UIs and command-line tools, not for + authorization checking. This operation may "fail open" without warning. + operationId: dataform.projects.locations.teamFolders.testIamPermissions requestBody: content: application/json: schema: - $ref: '#/components/schemas/SetIamPolicyRequest' + $ref: '#/components/schemas/TestIamPermissionsRequest' security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -5712,7 +6437,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/TestIamPermissionsResponse' parameters: - in: path name: projectsId @@ -5725,18 +6450,22 @@ paths: schema: type: string - in: path - name: collectionsId + name: teamFoldersId required: true schema: type: string - /v1beta1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}:getIamPolicy: + /v1beta1/projects/{projectsId}/locations/{locationsId}/operations: parameters: *ref_1 get: description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: dataform.projects.locations.collections.getIamPolicy + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: dataform.projects.locations.operations.list security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -5747,7 +6476,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/ListOperationsResponse' parameters: - in: path name: projectsId @@ -5759,32 +6488,122 @@ paths: required: true schema: type: string - - in: path - name: collectionsId - required: true + - in: query + name: filter schema: type: string - in: query - name: options.requestedPolicyVersion + name: pageSize schema: type: integer format: int32 - /v1beta1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}:testIamPermissions: + - in: query + name: pageToken + schema: + type: string + /v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: dataform.projects.locations.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + delete: + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: dataform.projects.locations.operations.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- - Returns permissions that a caller has on the specified resource. If the - resource does not exist, this will return an empty set of permissions, - not a `NOT_FOUND` error. Note: This operation is designed to be used for - building permission-aware UIs and command-line tools, not for - authorization checking. This operation may "fail open" without warning. - operationId: dataform.projects.locations.collections.testIamPermissions + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + `1`, corresponding to `Code.CANCELLED`. + operationId: dataform.projects.locations.operations.cancel requestBody: content: application/json: schema: - $ref: '#/components/schemas/TestIamPermissionsRequest' + $ref: '#/components/schemas/CancelOperationRequest' security: + - Oauth2: + - https://www.googleapis.com/auth/bigquery + Oauth2c: + - https://www.googleapis.com/auth/bigquery - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: @@ -5795,7 +6614,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TestIamPermissionsResponse' + $ref: '#/components/schemas/Empty' parameters: - in: path name: projectsId @@ -5808,7 +6627,7 @@ paths: schema: type: string - in: path - name: collectionsId + name: operationsId required: true schema: type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/datafusion.yaml b/providers/src/googleapis.com/v00.00.00000/services/datafusion.yaml index 19246c22..eb481f17 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/datafusion.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/datafusion.yaml @@ -14,8 +14,8 @@ info: prepare, blend, transfer and transform data without having to wrestle with infrastructure. version: v1 - x-discovery-doc-revision: '20240703' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250702' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/data-fusion/docs servers: @@ -158,7 +158,10 @@ components: type: object properties: availableVersions: - description: Represents a list of versions that are supported. + description: >- + Represents a list of versions that are supported. Deprecated: Use + versions field instead. + deprecated: true type: array items: $ref: '#/components/schemas/Version' @@ -167,6 +170,11 @@ components: Token to retrieve the next page of results or empty if there are no more results in the list. type: string + versions: + description: Represents a list of all versions. + type: array + items: + $ref: '#/components/schemas/Version' Version: id: Version description: >- @@ -193,10 +201,12 @@ components: - Version does not have availability yet - Version is under development and not considered stable - Version is available for public use + - Version is no longer supported. enum: - TYPE_UNSPECIFIED - TYPE_PREVIEW - TYPE_GENERAL_AVAILABILITY + - TYPE_DEPRECATED ListInstancesResponse: id: ListInstancesResponse description: Response message for the list instance request. @@ -229,7 +239,7 @@ components: readOnly: true type: string description: - description: A description of this instance. + description: Optional. A description of this instance. type: string type: description: Required. Instance type. @@ -256,21 +266,21 @@ components: - ENTERPRISE - DEVELOPER enableStackdriverLogging: - description: Option to enable Stackdriver Logging. + description: Optional. Option to enable Dataproc Stackdriver Logging. type: boolean enableStackdriverMonitoring: - description: Option to enable Stackdriver Monitoring. + description: Optional. Option to enable Stackdriver Monitoring. type: boolean privateInstance: description: >- - Specifies whether the Data Fusion instance should be private. If set - to true, all Data Fusion nodes will have private IP addresses and - will not be able to access the public internet. + Optional. Specifies whether the Data Fusion instance should be + private. If set to true, all Data Fusion nodes will have private IP + addresses and will not be able to access the public internet. type: boolean networkConfig: description: >- - Network configuration options. These are required when a private - Data Fusion instance is to be created. + Optional. Network configuration options. These are required when a + private Data Fusion instance is to be created. $ref: '#/components/schemas/NetworkConfig' labels: description: >- @@ -282,8 +292,8 @@ components: type: string options: description: >- - Map of additional options used to configure the behavior of Data - Fusion instance. + Optional. Map of additional options used to configure the behavior + of Data Fusion instance. type: object additionalProperties: type: string @@ -339,11 +349,13 @@ components: type: string zone: description: >- - Name of the zone in which the Data Fusion instance will be created. - Only DEVELOPER instances use this field. + Optional. Name of the zone in which the Data Fusion instance will be + created. Only DEVELOPER instances use this field. type: string version: - description: Current version of the Data Fusion. Only specifiable in Update. + description: >- + Optional. Current version of the Data Fusion. Only specifiable in + Update. type: string serviceAccount: description: >- @@ -353,7 +365,7 @@ components: deprecated: true type: string displayName: - description: Display name for an instance. + description: Optional. Display name for an instance. type: string availableVersion: description: >- @@ -389,17 +401,17 @@ components: type: string dataprocServiceAccount: description: >- - User-managed service account to set on Dataproc when Cloud Data - Fusion creates Dataproc to run data processing pipelines. This + Optional. User-managed service account to set on Dataproc when Cloud + Data Fusion creates Dataproc to run data processing pipelines. This allows users to have fine-grained access control on Dataproc's accesses to cloud resources. type: string enableRbac: - description: Option to enable granular role-based access control. + description: Optional. Option to enable granular role-based access control. type: boolean cryptoKeyConfig: description: >- - The crypto key configuration. This field is used by the + Optional. The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature. $ref: '#/components/schemas/CryptoKeyConfig' disabledReason: @@ -419,10 +431,11 @@ components: - DISABLED_REASON_UNSPECIFIED - KMS_KEY_ISSUE eventPublishConfig: - description: Option to enable and pass metadata for event publishing. + description: Optional. Option to enable and pass metadata for event publishing. $ref: '#/components/schemas/EventPublishConfig' enableZoneSeparation: - description: Option to enable granular zone separation. + description: Output only. Option to enable granular zone separation. + readOnly: true type: boolean satisfiesPzs: description: Output only. Reserved for future use. @@ -443,6 +456,29 @@ components: maintenancePolicy: description: Optional. Configure the maintenance policy for this instance. $ref: '#/components/schemas/MaintenancePolicy' + tags: + description: >- + Optional. Input only. Immutable. Tag keys/values directly bound to + this resource. For example: "123/environment": "production", + "123/costCenter": "marketing" + type: object + additionalProperties: + type: string + maintenanceEvents: + description: Output only. The maintenance events for this instance. + readOnly: true + type: array + items: + $ref: '#/components/schemas/MaintenanceEvent' + loggingConfig: + description: >- + Optional. The logging configuration for this instance. This field is + supported only in CDF versions 6.11.0 and above. + $ref: '#/components/schemas/LoggingConfig' + satisfiesPzi: + description: Output only. Reserved for future use. + readOnly: true + type: boolean NetworkConfig: id: NetworkConfig description: >- @@ -584,9 +620,9 @@ components: properties: keyReference: description: >- - The name of the key which is used to encrypt/decrypt customer data. - For key in Cloud KMS, the key should be in the format of - `projects/*/locations/*/keyRings/*/cryptoKeys/*`. + Optional. The name of the key which is used to encrypt/decrypt + customer data. For key in Cloud KMS, the key should be in the format + of `projects/*/locations/*/keyRings/*/cryptoKeys/*`. type: string EventPublishConfig: id: EventPublishConfig @@ -665,6 +701,53 @@ components: "2024-01-02T12:04:06-06:00" type: string format: google-datetime + MaintenanceEvent: + id: MaintenanceEvent + description: Represents a maintenance event. + type: object + properties: + startTime: + description: >- + Output only. The start time of the maintenance event provided in + [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. Example: + "2024-01-01T12:04:06-04:00" + readOnly: true + type: string + format: google-datetime + endTime: + description: >- + Output only. The end time of the maintenance event provided in [RFC + 3339](https://www.ietf.org/rfc/rfc3339.txt) format. Example: + "2024-01-02T12:04:06-06:00" This field will be empty if the + maintenance event is not yet complete. + readOnly: true + type: string + format: google-datetime + state: + description: Output only. The state of the maintenance event. + readOnly: true + type: string + enumDescriptions: + - The state of the maintenance event is unspecified. + - The maintenance is scheduled but has not started. + - The maintenance has been started. + - The maintenance has been completed. + enum: + - STATE_UNSPECIFIED + - SCHEDULED + - STARTED + - COMPLETED + LoggingConfig: + id: LoggingConfig + description: Logging configuration for a Data Fusion instance. + type: object + properties: + instanceCloudLoggingDisabled: + description: >- + Optional. Option to determine whether instance logs should be + written to Cloud Logging. By default, instance logs are written to + Cloud Logging. + type: boolean RestartInstanceRequest: id: RestartInstanceRequest description: Request message for restarting a Data Fusion instance. @@ -679,7 +762,7 @@ components: properties: name: description: >- - Required. The resource name of the dns peering zone. Format: + Identifier. The resource name of the dns peering zone. Format: projects/{project}/locations/{location}/instances/{instance}/dnsPeerings/{dns_peering} type: string domain: @@ -1120,8 +1203,8 @@ components: description: >- Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have - Operation.error value with a google.rpc.Status.code of 1, - corresponding to `Code.CANCELLED`. + google.longrunning.Operation.error value with a + google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. type: boolean apiVersion: description: API version used to start the operation. @@ -1135,287 +1218,6 @@ components: type: object additionalProperties: type: string - AssetLocation: - id: AssetLocation - description: >- - Provides the mapping of a cloud asset to a direct physical location or - to a proxy that defines the location on its behalf. - type: object - properties: - expected: - description: >- - Defines the customer expectation around ZI/ZS for this asset and - ZI/ZS state of the region at the time of asset creation. - $ref: '#/components/schemas/IsolationExpectations' - locationData: - description: Contains all kinds of physical location definitions for this asset. - type: array - items: - $ref: '#/components/schemas/LocationData' - parentAsset: - description: >- - Defines parents assets if any in order to allow later generation of - child_asset_location data via child assets. - type: array - items: - $ref: '#/components/schemas/CloudAsset' - extraParameters: - description: Defines extra parameters required for specific asset types. - type: array - items: - $ref: '#/components/schemas/ExtraParameter' - IsolationExpectations: - id: IsolationExpectations - type: object - properties: - zoneIsolation: - description: >- - Deprecated: use zi_org_policy, zi_region_policy and zi_region_state - instead for setting ZI expectations as per - go/zicy-publish-physical-location. - deprecated: true - type: string - enumDescriptions: - - '' - - To be used if tracking is not available - - '' - - '' - - '' - enum: - - ZI_UNSPECIFIED - - ZI_UNKNOWN - - ZI_NOT_REQUIRED - - ZI_PREFERRED - - ZI_REQUIRED - zoneSeparation: - description: >- - Deprecated: use zs_org_policy, and zs_region_stateinstead for - setting Zs expectations as per go/zicy-publish-physical-location. - deprecated: true - type: string - enumDescriptions: - - '' - - To be used if tracking is not available - - '' - - '' - enum: - - ZS_UNSPECIFIED - - ZS_UNKNOWN - - ZS_NOT_REQUIRED - - ZS_REQUIRED - zsOrgPolicy: - type: string - enumDescriptions: - - '' - - To be used if tracking is not available - - '' - - '' - enum: - - ZS_UNSPECIFIED - - ZS_UNKNOWN - - ZS_NOT_REQUIRED - - ZS_REQUIRED - zsRegionState: - type: string - enumDescriptions: - - '' - - To be used if tracking of the asset ZS-bit is not available - - '' - - '' - enum: - - ZS_REGION_UNSPECIFIED - - ZS_REGION_UNKNOWN - - ZS_REGION_NOT_ENABLED - - ZS_REGION_ENABLED - ziOrgPolicy: - type: string - enumDescriptions: - - '' - - To be used if tracking is not available - - '' - - '' - - '' - enum: - - ZI_UNSPECIFIED - - ZI_UNKNOWN - - ZI_NOT_REQUIRED - - ZI_PREFERRED - - ZI_REQUIRED - ziRegionPolicy: - type: string - enumDescriptions: - - '' - - To be used if tracking is not available - - '' - - '' - - '' - enum: - - ZI_REGION_POLICY_UNSPECIFIED - - ZI_REGION_POLICY_UNKNOWN - - ZI_REGION_POLICY_NOT_SET - - ZI_REGION_POLICY_FAIL_OPEN - - ZI_REGION_POLICY_FAIL_CLOSED - ziRegionState: - type: string - enumDescriptions: - - '' - - To be used if tracking is not available - - '' - - '' - enum: - - ZI_REGION_UNSPECIFIED - - ZI_REGION_UNKNOWN - - ZI_REGION_NOT_ENABLED - - ZI_REGION_ENABLED - LocationData: - id: LocationData - type: object - properties: - directLocation: - $ref: '#/components/schemas/DirectLocationAssignment' - spannerLocation: - $ref: '#/components/schemas/SpannerLocation' - childAssetLocation: - $ref: '#/components/schemas/CloudAssetComposition' - gcpProjectProxy: - $ref: '#/components/schemas/TenantProjectProxy' - blobstoreLocation: - $ref: '#/components/schemas/BlobstoreLocation' - placerLocation: - $ref: '#/components/schemas/PlacerLocation' - DirectLocationAssignment: - id: DirectLocationAssignment - type: object - properties: - location: - type: array - items: - $ref: '#/components/schemas/LocationAssignment' - LocationAssignment: - id: LocationAssignment - type: object - properties: - location: - type: string - locationType: - type: string - enumDescriptions: - - '' - - '1-10: Physical failure domains.' - - '' - - '11-20: Logical failure domains.' - - '' - - '' - - '' - - '' - - '' - enum: - - UNSPECIFIED - - CLUSTER - - POP - - CLOUD_ZONE - - CLOUD_REGION - - MULTI_REGION_GEO - - MULTI_REGION_JURISDICTION - - GLOBAL - - OTHER - SpannerLocation: - id: SpannerLocation - type: object - properties: - dbName: - description: Set of databases used by the resource in format /span// - type: array - items: - type: string - backupName: - description: >- - Set of backups used by the resource with name in the same format as - what is available at http://table/spanner_automon.backup_metadata - type: array - items: - type: string - CloudAssetComposition: - id: CloudAssetComposition - type: object - properties: - childAsset: - type: array - items: - $ref: '#/components/schemas/CloudAsset' - CloudAsset: - id: CloudAsset - type: object - properties: - assetType: - type: string - assetName: - type: string - TenantProjectProxy: - id: TenantProjectProxy - type: object - properties: - projectNumbers: - type: array - items: - type: string - BlobstoreLocation: - id: BlobstoreLocation - description: >- - Policy ID that identified data placement in Blobstore as per - go/blobstore-user-guide#data-metadata-placement-and-failure-domains - type: object - properties: - policyId: - type: array - items: - type: string - PlacerLocation: - id: PlacerLocation - description: >- - Message describing that the location of the customer resource is tied to - placer allocations - type: object - properties: - placerConfig: - description: >- - Directory with a config related to it in placer (e.g. - "/placer/prod/home/my-root/my-dir") - type: string - ExtraParameter: - id: ExtraParameter - description: Defines parameters that should only be used for specific asset types. - type: object - properties: - regionalMigDistributionPolicy: - description: >- - Details about zones used by regional - compute.googleapis.com/InstanceGroupManager to create instances. - $ref: '#/components/schemas/RegionalMigDistributionPolicy' - RegionalMigDistributionPolicy: - id: RegionalMigDistributionPolicy - description: >- - To be used for specifying the intended distribution of regional - compute.googleapis.com/InstanceGroupManager instances - type: object - properties: - zones: - description: Cloud zones used by regional MIG to create instances. - type: array - items: - $ref: '#/components/schemas/ZoneConfiguration' - targetShape: - description: >- - The shape in which the group converges around distribution of - resources. Instance of proto2 enum - type: integer - format: int32 - ZoneConfiguration: - id: ZoneConfiguration - type: object - properties: - zone: - type: string parameters: access_token: description: OAuth access token. @@ -1766,6 +1568,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: @@ -1920,7 +1726,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: datafusion.projects.locations.operations.cancel requestBody: content: @@ -2144,6 +1950,10 @@ paths: required: true schema: type: string + - in: query + name: force + schema: + type: boolean patch: description: Updates a single Data Fusion instance. operationId: datafusion.projects.locations.instances.patch diff --git a/providers/src/googleapis.com/v00.00.00000/services/datalabeling.yaml b/providers/src/googleapis.com/v00.00.00000/services/datalabeling.yaml index f0dff6bf..72245104 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/datalabeling.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/datalabeling.yaml @@ -7,8 +7,8 @@ info: title: Data Labeling API description: Public API for Google Cloud AI Data Labeling Service. version: v1beta1 - x-discovery-doc-revision: '20241018' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250723' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/data-labeling/docs/ servers: @@ -964,7 +964,7 @@ components: type: string GoogleCloudDatalabelingV1beta1LabelImageRequest: id: GoogleCloudDatalabelingV1beta1LabelImageRequest - description: Request message for starting an image labeling task. + description: ' Request message for starting an image labeling task.' type: object properties: imageClassificationConfig: @@ -1029,7 +1029,7 @@ components: - SEGMENTATION GoogleCloudDatalabelingV1beta1LabelVideoRequest: id: GoogleCloudDatalabelingV1beta1LabelVideoRequest - description: Request message for LabelVideo. + description: ' Request message for LabelVideo.' type: object properties: videoClassificationConfig: @@ -2041,7 +2041,7 @@ components: $ref: '#/components/schemas/GoogleCloudDatalabelingV1beta1Example' GoogleCloudDatalabelingV1beta1CreateEvaluationJobRequest: id: GoogleCloudDatalabelingV1beta1CreateEvaluationJobRequest - description: Request message for CreateEvaluationJob. + description: ' Request message for CreateEvaluationJob.' type: object properties: job: @@ -4178,6 +4178,27 @@ components: response: mediaType: application/json openAPIDocKey: '200' + projects_datasets_image_label: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1datasets~1{datasetsId}~1image:label/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_datasets_video_label: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1datasets~1{datasetsId}~1video:label/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_datasets_text_label: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1datasets~1{datasetsId}~1text:label/post + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - $ref: >- @@ -4397,60 +4418,6 @@ components: delete: - $ref: >- #/components/x-stackQL-resources/feedback_messages/methods/projects_datasets_annotated_datasets_feedback_threads_feedback_messages_delete - image: - id: google.datalabeling.image - name: image - title: Image - methods: - projects_datasets_image_label: - operation: - $ref: >- - #/paths/~1v1beta1~1projects~1{projectsId}~1datasets~1{datasetsId}~1image:label/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: [] - video: - id: google.datalabeling.video - name: video - title: Video - methods: - projects_datasets_video_label: - operation: - $ref: >- - #/paths/~1v1beta1~1projects~1{projectsId}~1datasets~1{datasetsId}~1video:label/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: [] - text: - id: google.datalabeling.text - name: text - title: Text - methods: - projects_datasets_text_label: - operation: - $ref: >- - #/paths/~1v1beta1~1projects~1{projectsId}~1datasets~1{datasetsId}~1text:label/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: [] evaluations: id: google.datalabeling.evaluations name: evaluations @@ -4463,6 +4430,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + projects_datasets_evaluations_example_comparisons_search: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1datasets~1{datasetsId}~1evaluations~1{evaluationsId}~1exampleComparisons:search/post + response: + mediaType: application/json + openAPIDocKey: '200' projects_evaluations_search: operation: $ref: '#/paths/~1v1beta1~1projects~1{projectsId}~1evaluations:search/get' @@ -4477,24 +4451,6 @@ components: update: [] replace: [] delete: [] - example_comparisons: - id: google.datalabeling.example_comparisons - name: example_comparisons - title: Example_comparisons - methods: - projects_datasets_evaluations_example_comparisons_search: - operation: - $ref: >- - #/paths/~1v1beta1~1projects~1{projectsId}~1datasets~1{datasetsId}~1evaluations~1{evaluationsId}~1exampleComparisons:search/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: [] annotation_spec_sets: id: google.datalabeling.annotation_spec_sets name: annotation_spec_sets @@ -4779,7 +4735,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: datalabeling.projects.operations.cancel security: - Oauth2: @@ -4807,7 +4763,7 @@ paths: /v1beta1/projects/{projectsId}/datasets: parameters: *ref_1 post: - description: Creates dataset. If success return a Dataset resource. + description: ' Creates dataset. If success return a Dataset resource.' operationId: datalabeling.projects.datasets.create requestBody: content: @@ -5362,7 +5318,7 @@ paths: /v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/feedbackThreads/{feedbackThreadsId}: parameters: *ref_1 get: - description: Get a FeedbackThread object. + description: ' Get a FeedbackThread object.' operationId: datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.get security: - Oauth2: @@ -5659,9 +5615,7 @@ paths: /v1beta1/projects/{projectsId}/datasets/{datasetsId}/image:label: parameters: *ref_1 post: - description: >- - Starts a labeling task for image. The type of image labeling task is - configured by feature in the request. + description: ' Starts a labeling task for image. The type of image labeling task is configured by feature in the request.' operationId: datalabeling.projects.datasets.image.label requestBody: content: @@ -5767,9 +5721,7 @@ paths: /v1beta1/projects/{projectsId}/datasets/{datasetsId}/evaluations/{evaluationsId}: parameters: *ref_1 get: - description: >- - Gets an evaluation by resource name (to search, use - projects.evaluations.search). + description: ' Gets an evaluation by resource name (to search, use projects.evaluations.search).' operationId: datalabeling.projects.datasets.evaluations.get security: - Oauth2: @@ -6120,7 +6072,7 @@ paths: /v1beta1/projects/{projectsId}/evaluationJobs: parameters: *ref_1 post: - description: Creates an evaluation job. + description: ' Creates an evaluation job.' operationId: datalabeling.projects.evaluationJobs.create requestBody: content: diff --git a/providers/src/googleapis.com/v00.00.00000/services/datalineage.yaml b/providers/src/googleapis.com/v00.00.00000/services/datalineage.yaml index 8c5ef0a6..20ca46ae 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/datalineage.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/datalineage.yaml @@ -7,8 +7,8 @@ info: title: Data Lineage API description: '' version: v1 - x-discovery-doc-revision: '20241018' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250801' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/data-catalog servers: @@ -34,145 +34,265 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudDatacatalogLineageV1ProcessOpenLineageRunEventResponse: + GoogleLongrunningListOperationsResponse: + id: GoogleLongrunningListOperationsResponse + description: The response message for Operations.ListOperations. + type: object properties: - lineageEvents: - type: array + operations: description: >- - Created lineage event names. Format: - `projects/{project}/locations/{location}/processes/{process}/runs/{run}/lineageEvents/{lineage_event}`. + A list of operations that matches the specified filter in the + request. + type: array items: - type: string - run: + $ref: '#/components/schemas/GoogleLongrunningOperation' + nextPageToken: + description: The standard List next-page token. + type: string + GoogleLongrunningOperation: + id: GoogleLongrunningOperation + description: >- + This resource represents a long-running operation that is the result of + a network API call. + type: object + properties: + name: + description: >- + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. type: string + metadata: description: >- - Created run name. Format: - `projects/{project}/locations/{location}/processes/{process}/runs/{run}`. - process: + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + done: description: >- - Created process name. Format: - `projects/{project}/locations/{location}/processes/{process}`. + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + type: boolean + error: + description: >- + The error result of the operation in case of failure or + cancellation. + $ref: '#/components/schemas/GoogleRpcStatus' + response: + description: >- + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + GoogleRpcStatus: + id: GoogleRpcStatus + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + type: object + properties: + code: + description: The status code, which should be an enum value of google.rpc.Code. + type: integer + format: int32 + message: + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. type: string - id: GoogleCloudDatacatalogLineageV1ProcessOpenLineageRunEventResponse + details: + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + type: array + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + GoogleProtobufEmpty: + id: GoogleProtobufEmpty + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } type: object - description: Response message for ProcessOpenLineageRunEvent. - GoogleLongrunningCancelOperationRequest: properties: {} - type: object + GoogleLongrunningCancelOperationRequest: id: GoogleLongrunningCancelOperationRequest description: The request message for Operations.CancelOperation. - GoogleCloudDatacatalogLineageV1OperationMetadata: + type: object + properties: {} + GoogleCloudDatacatalogLineageV1ProcessOpenLineageRunEventResponse: + id: GoogleCloudDatacatalogLineageV1ProcessOpenLineageRunEventResponse + description: Response message for ProcessOpenLineageRunEvent. + type: object properties: - endTime: - type: string - readOnly: true - format: google-datetime + process: description: >- - Output only. The timestamp of the operation termination, regardless - of its success. This field is unset if the operation is still - ongoing. - resourceUuid: - type: string - readOnly: true - description: Output only. The UUID of the resource being operated on. - state: - readOnly: true + Created process name. Format: + `projects/{project}/locations/{location}/processes/{process}`. type: string - enum: - - STATE_UNSPECIFIED - - PENDING - - RUNNING - - SUCCEEDED - - FAILED - enumDescriptions: - - Unused. - - The operation has been created but is not yet started. - - The operation is underway. - - The operation completed successfully. - - The operation is no longer running and did not succeed. - description: Output only. The current operation state. - operationType: - enumDescriptions: - - Unused. - - The resource deletion operation. - - The resource creation operation. - enum: - - TYPE_UNSPECIFIED - - DELETE - - CREATE + run: + description: >- + Created run name. Format: + `projects/{project}/locations/{location}/processes/{process}/runs/{run}`. type: string - readOnly: true - description: Output only. The type of the operation being performed. - createTime: - format: google-datetime - readOnly: true + lineageEvents: + description: >- + Created lineage event names. Format: + `projects/{project}/locations/{location}/processes/{process}/runs/{run}/lineageEvents/{lineage_event}`. + type: array + items: + type: string + GoogleCloudDatacatalogLineageV1Process: + id: GoogleCloudDatacatalogLineageV1Process + description: A process is the definition of a data transformation operation. + type: object + properties: + name: + description: >- + Immutable. The resource name of the lineage process. Format: + `projects/{project}/locations/{location}/processes/{process}`. Can + be specified or auto-assigned. {process} must be not longer than 200 + characters and only contain characters in a set: `a-zA-Z0-9_-:.` type: string + displayName: description: >- - Output only. The timestamp of the operation submission to the - server. - resource: + Optional. A human-readable name you can set to display in a user + interface. Must be not longer than 200 characters and only contain + UTF-8 letters or numbers, spaces or characters like `_-:&.` type: string + attributes: description: >- - Output only. The [relative name] - (https://cloud.google.com//apis/design/resource_names#relative_resource_name) - of the resource being operated on. - readOnly: true - id: GoogleCloudDatacatalogLineageV1OperationMetadata - description: Metadata describing the operation. - type: object - GoogleLongrunningListOperationsResponse: - description: The response message for Operations.ListOperations. + Optional. The attributes of the process. Should only be used for the + purpose of non-semantic management (classifying, describing or + labeling the process). Up to 100 attributes are allowed. + type: object + additionalProperties: + type: any + origin: + description: >- + Optional. The origin of this process and its runs and lineage + events. + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Origin' + GoogleCloudDatacatalogLineageV1Origin: + id: GoogleCloudDatacatalogLineageV1Origin + description: Origin of a process. type: object properties: - nextPageToken: - description: The standard List next-page token. + sourceType: + description: >- + Type of the source. Use of a source_type other than `CUSTOM` for + process creation or updating is highly discouraged. It might be + restricted in the future without notice. There will be increase in + cost if you use any of the source types other than `CUSTOM`. type: string - operations: - items: - $ref: '#/components/schemas/GoogleLongrunningOperation' - type: array + enumDescriptions: + - Source is Unspecified + - A custom source + - BigQuery + - Data Fusion + - Composer + - Looker Studio + - Dataproc + - Vertex AI + enum: + - SOURCE_TYPE_UNSPECIFIED + - CUSTOM + - BIGQUERY + - DATA_FUSION + - COMPOSER + - LOOKER_STUDIO + - DATAPROC + - VERTEX_AI + name: description: >- - A list of operations that matches the specified filter in the - request. - id: GoogleLongrunningListOperationsResponse - GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesResponse: + If the source_type isn't CUSTOM, the value of this field should be a + Google Cloud resource name of the system, which reports lineage. The + project and location parts of the resource name must match the + project and location of the lineage resource being created. + Examples: - `{source_type: COMPOSER, name: + "projects/foo/locations/us/environments/bar"}` - `{source_type: + BIGQUERY, name: "projects/foo/locations/eu"}` - `{source_type: + CUSTOM, name: "myCustomIntegration"}` + type: string + GoogleCloudDatacatalogLineageV1ListProcessesResponse: + id: GoogleCloudDatacatalogLineageV1ListProcessesResponse + description: Response message for ListProcesses. + type: object properties: + processes: + description: The processes from the specified project and location. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Process' nextPageToken: description: >- - The token to specify as `page_token` in the subsequent call to get - the next page. Omitted if there are no more pages in the response. + The token to specify as `page_token` in the next call to get the + next page. If this field is omitted, there are no subsequent pages. type: string - processLinks: - description: An array of processes associated with the specified links. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1ProcessLinks' - description: Response message for BatchSearchLinkProcesses. - id: GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesResponse + GoogleCloudDatacatalogLineageV1Run: + id: GoogleCloudDatacatalogLineageV1Run + description: >- + A lineage run represents an execution of a process that creates lineage + events. type: object - GoogleCloudDatacatalogLineageV1EntityReference: properties: - fullyQualifiedName: + name: + description: >- + Immutable. The resource name of the run. Format: + `projects/{project}/locations/{location}/processes/{process}/runs/{run}`. + Can be specified or auto-assigned. {run} must be not longer than 200 + characters and only contain characters in a set: `a-zA-Z0-9_-:.` type: string + displayName: description: >- - Required. [Fully Qualified Name - (FQN)](https://cloud.google.com/data-catalog/docs/fully-qualified-names) - of the entity. - description: The soft reference to everything you can attach a lineage event to. - id: GoogleCloudDatacatalogLineageV1EntityReference - type: object - GoogleCloudDatacatalogLineageV1Run: - id: GoogleCloudDatacatalogLineageV1Run - properties: + Optional. A human-readable name you can set to display in a user + interface. Must be not longer than 1024 characters and only contain + UTF-8 letters or numbers, spaces or characters like `_-:&.` + type: string attributes: - type: object description: >- Optional. The attributes of the run. Should only be used for the purpose of non-semantic management (classifying, describing or labeling the run). Up to 100 attributes are allowed. + type: object additionalProperties: type: any + startTime: + description: Required. The timestamp of the start of the run. + type: string + format: google-datetime + endTime: + description: Optional. The timestamp of the end of the run. + type: string + format: google-datetime state: + description: Required. The state of the run. + type: string enumDescriptions: - >- The state is unknown. The true state may be any of the below or a @@ -181,82 +301,89 @@ components: - The run completed. - The run failed. - The run aborted. - type: string - description: Required. The state of the run. enum: - UNKNOWN - STARTED - COMPLETED - FAILED - ABORTED - name: + GoogleCloudDatacatalogLineageV1ListRunsResponse: + id: GoogleCloudDatacatalogLineageV1ListRunsResponse + description: Response message for ListRuns. + type: object + properties: + runs: + description: The runs from the specified project and location. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Run' + nextPageToken: description: >- - Immutable. The resource name of the run. Format: - `projects/{project}/locations/{location}/processes/{process}/runs/{run}`. - Can be specified or auto-assigned. {run} must be not longer than 200 - characters and only contain characters in a set: `a-zA-Z0-9_-:.` + The token to specify as `page_token` in the next call to get the + next page. If this field is omitted, there are no subsequent pages. type: string - displayName: + GoogleCloudDatacatalogLineageV1LineageEvent: + id: GoogleCloudDatacatalogLineageV1LineageEvent + description: >- + A lineage event represents an operation on assets. Within the operation, + the data flows from the source to the target defined in the links field. + type: object + properties: + name: + description: >- + Immutable. The resource name of the lineage event. Format: + `projects/{project}/locations/{location}/processes/{process}/runs/{run}/lineageEvents/{lineage_event}`. + Can be specified or auto-assigned. {lineage_event} must be not + longer than 200 characters and only contain characters in a set: + `a-zA-Z0-9_-:.` type: string + links: description: >- - Optional. A human-readable name you can set to display in a user - interface. Must be not longer than 1024 characters and only contain - UTF-8 letters or numbers, spaces or characters like `_-:&.` + Optional. List of source-target pairs. Can't contain more than 100 + tuples. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EventLink' startTime: - format: google-datetime + description: >- + Required. The beginning of the transformation which resulted in this + lineage event. For streaming scenarios, it should be the beginning + of the period from which the lineage is being reported. type: string - description: Required. The timestamp of the start of the run. - endTime: format: google-datetime + endTime: + description: >- + Optional. The end of the transformation which resulted in this + lineage event. For streaming scenarios, it should be the end of the + period from which the lineage is being reported. type: string - description: Optional. The timestamp of the end of the run. - type: object - description: >- - A lineage run represents an execution of a process that creates lineage - events. + format: google-datetime GoogleCloudDatacatalogLineageV1EventLink: + id: GoogleCloudDatacatalogLineageV1EventLink description: A lineage between source and target entities. type: object - id: GoogleCloudDatacatalogLineageV1EventLink properties: - target: + source: + description: Required. Reference to the source entity $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' + target: description: Required. Reference to the target entity - source: $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' - description: Required. Reference to the source entity - GoogleCloudDatacatalogLineageV1Process: - properties: - displayName: - type: string - description: >- - Optional. A human-readable name you can set to display in a user - interface. Must be not longer than 200 characters and only contain - UTF-8 letters or numbers, spaces or characters like `_-:&.` - attributes: - type: object - description: >- - Optional. The attributes of the process. Should only be used for the - purpose of non-semantic management (classifying, describing or - labeling the process). Up to 100 attributes are allowed. - additionalProperties: - type: any - name: - description: >- - Immutable. The resource name of the lineage process. Format: - `projects/{project}/locations/{location}/processes/{process}`. Can - be specified or auto-assigned. {process} must be not longer than 200 - characters and only contain characters in a set: `a-zA-Z0-9_-:.` - type: string - origin: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Origin' - description: >- - Optional. The origin of this process and its runs and lineage - events. - id: GoogleCloudDatacatalogLineageV1Process + GoogleCloudDatacatalogLineageV1EntityReference: + id: GoogleCloudDatacatalogLineageV1EntityReference + description: The soft reference to everything you can attach a lineage event to. type: object - description: A process is the definition of a data transformation operation. + properties: + fullyQualifiedName: + description: >- + Required. [Fully Qualified Name + (FQN)](https://cloud.google.com/dataplex/docs/fully-qualified-names) + of the entity. + type: string GoogleCloudDatacatalogLineageV1ListLineageEventsResponse: + id: GoogleCloudDatacatalogLineageV1ListLineageEventsResponse + description: Response message for ListLineageEvents. + type: object properties: lineageEvents: description: Lineage events from the specified project and location. @@ -264,104 +391,93 @@ components: items: $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1LineageEvent' nextPageToken: - type: string description: >- The token to specify as `page_token` in the next call to get the next page. If this field is omitted, there are no subsequent pages. - description: Response message for ListLineageEvents. - id: GoogleCloudDatacatalogLineageV1ListLineageEventsResponse - type: object - GoogleCloudDatacatalogLineageV1ProcessLinkInfo: - properties: - link: - type: string - description: >- - The name of the link in the format of - `projects/{project}/locations/{location}/links/{link}`. - startTime: - format: google-datetime - type: string - description: The start of the first event establishing this link-process tuple. - endTime: - format: google-datetime - description: The end of the last event establishing this link-process tuple. type: string + GoogleCloudDatacatalogLineageV1SearchLinksRequest: + id: GoogleCloudDatacatalogLineageV1SearchLinksRequest + description: Request message for SearchLinks. type: object - id: GoogleCloudDatacatalogLineageV1ProcessLinkInfo - description: Link details. - GoogleLongrunningOperation: properties: - name: - type: string - description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. - response: + source: description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: object - done: - type: boolean + Optional. Send asset information in the **source** field to retrieve + all links that lead from the specified asset to downstream assets. + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' + target: description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - error: - $ref: '#/components/schemas/GoogleRpcStatus' + Optional. Send asset information in the **target** field to retrieve + all links that lead from upstream assets to the specified asset. + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' + pageSize: description: >- - The error result of the operation in case of failure or - cancellation. - metadata: + Optional. The maximum number of links to return in a single page of + the response. A page may contain fewer links than this value. If + unspecified, at most 10 links are returned. Maximum value is 100; + values greater than 100 are reduced to 100. + type: integer + format: int32 + pageToken: description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - id: GoogleLongrunningOperation - type: object - description: >- - This resource represents a long-running operation that is the result of - a network API call. + Optional. The page token received from a previous + `SearchLinksRequest` call. Use it to get the next page. When + requesting subsequent pages of a response, remember that all + parameters must match the values you provided in the original + request. + type: string GoogleCloudDatacatalogLineageV1SearchLinksResponse: + id: GoogleCloudDatacatalogLineageV1SearchLinksResponse + description: Response message for SearchLinks. + type: object properties: links: description: >- The list of links for a given asset. Can be empty if the asset has no relations of requested type (source or target). + type: array items: $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Link' - type: array nextPageToken: description: >- The token to specify as `page_token` in the subsequent call to get the next page. Omitted if there are no more pages in the response. type: string + GoogleCloudDatacatalogLineageV1Link: + id: GoogleCloudDatacatalogLineageV1Link + description: >- + Links represent the data flow between **source** (upstream) and + **target** (downstream) assets in transformation pipelines. Links are + created when LineageEvents record data transformation between related + assets. type: object - id: GoogleCloudDatacatalogLineageV1SearchLinksResponse - description: Response message for SearchLinks. + properties: + name: + description: >- + Output only. Immutable. The name of the link. Format: + `projects/{project}/locations/{location}/links/{link}`. + readOnly: true + type: string + source: + description: The pointer to the entity that is the **source** of this link. + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' + target: + description: The pointer to the entity that is the **target** of this link. + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' + startTime: + description: The start of the first event establishing this link. + type: string + format: google-datetime + endTime: + description: The end of the last event establishing this link. + type: string + format: google-datetime GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesRequest: + id: GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesRequest description: Request message for BatchSearchLinkProcesses. + type: object properties: links: - items: - type: string description: >- Required. An array of links to check for their associated LineageProcesses. The maximum number of items in this array is 100. @@ -369,265 +485,156 @@ components: `INVALID_ARGUMENT` error. Format: `projects/{project}/locations/{location}/links/{link}`. type: array + items: + type: string pageSize: - format: int32 description: >- The maximum number of processes to return in a single page of the response. A page may contain fewer results than this value. type: integer - pageToken: - type: string - description: >- - The page token received from a previous `BatchSearchLinkProcesses` - call. Use it to get the next page. When requesting subsequent pages - of a response, remember that all parameters must match the values - you provided in the original request. - type: object - id: GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesRequest - GoogleCloudDatacatalogLineageV1ListRunsResponse: - description: Response message for ListRuns. - type: object - properties: - runs: - type: array - description: The runs from the specified project and location. - items: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Run' - nextPageToken: - description: >- - The token to specify as `page_token` in the next call to get the - next page. If this field is omitted, there are no subsequent pages. - type: string - id: GoogleCloudDatacatalogLineageV1ListRunsResponse - GoogleRpcStatus: - id: GoogleRpcStatus - type: object - properties: - details: - items: - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - type: array - code: - description: The status code, which should be an enum value of google.rpc.Code. - type: integer format: int32 - message: - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - type: string - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - GoogleCloudDatacatalogLineageV1ListProcessesResponse: - description: Response message for ListProcesses. - id: GoogleCloudDatacatalogLineageV1ListProcessesResponse - properties: - processes: - items: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Process' - description: The processes from the specified project and location. - type: array - nextPageToken: - description: >- - The token to specify as `page_token` in the next call to get the - next page. If this field is omitted, there are no subsequent pages. - type: string - type: object - GoogleCloudDatacatalogLineageV1Link: - type: object - id: GoogleCloudDatacatalogLineageV1Link - properties: - startTime: - format: google-datetime - description: The start of the first event establishing this link. - type: string - endTime: - description: The end of the last event establishing this link. - format: google-datetime - type: string - target: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' - description: The pointer to the entity that is the **target** of this link. - name: - type: string - readOnly: true - description: >- - Output only. Immutable. The name of the link. Format: - `projects/{project}/locations/{location}/links/{link}`. - source: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' - description: The pointer to the entity that is the **source** of this link. - description: >- - Links represent the data flow between **source** (upstream) and - **target** (downstream) assets in transformation pipelines. Links are - created when LineageEvents record data transformation between related - assets. - GoogleProtobufEmpty: - properties: {} - description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } - id: GoogleProtobufEmpty - type: object - GoogleCloudDatacatalogLineageV1Origin: - type: object - id: GoogleCloudDatacatalogLineageV1Origin - properties: - name: + pageToken: description: >- - If the source_type isn't CUSTOM, the value of this field should be a - GCP resource name of the system, which reports lineage. The project - and location parts of the resource name must match the project and - location of the lineage resource being created. Examples: - - `{source_type: COMPOSER, name: - "projects/foo/locations/us/environments/bar"}` - `{source_type: - BIGQUERY, name: "projects/foo/locations/eu"}` - `{source_type: - CUSTOM, name: "myCustomIntegration"}` + The page token received from a previous `BatchSearchLinkProcesses` + call. Use it to get the next page. When requesting subsequent pages + of a response, remember that all parameters must match the values + you provided in the original request. type: string - sourceType: + GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesResponse: + id: GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesResponse + description: Response message for BatchSearchLinkProcesses. + type: object + properties: + processLinks: + description: An array of processes associated with the specified links. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1ProcessLinks' + nextPageToken: description: >- - Type of the source. Use of a source_type other than `CUSTOM` for - process creation or updating is highly discouraged. It may cause - additional billing costs and be restricted in the future without - notice. + The token to specify as `page_token` in the subsequent call to get + the next page. Omitted if there are no more pages in the response. type: string - enum: - - SOURCE_TYPE_UNSPECIFIED - - CUSTOM - - BIGQUERY - - DATA_FUSION - - COMPOSER - - LOOKER_STUDIO - - DATAPROC - - VERTEX_AI - enumDescriptions: - - Source is Unspecified - - A custom source - - BigQuery - - Data Fusion - - Composer - - Looker Studio - - Dataproc - - Vertex AI - description: Origin of a process. GoogleCloudDatacatalogLineageV1ProcessLinks: - type: object - description: Links associated with a specific process. id: GoogleCloudDatacatalogLineageV1ProcessLinks + description: Links associated with a specific process. + type: object properties: process: - type: string description: >- The process name in the format of `projects/{project}/locations/{location}/processes/{process}`. + type: string links: - items: - $ref: >- - #/components/schemas/GoogleCloudDatacatalogLineageV1ProcessLinkInfo description: >- An array containing link details objects of the links provided in the original request. A single process can result in creating multiple links. If any of the links you provide in the request are created by the same process, they all are included in this array. type: array - GoogleCloudDatacatalogLineageV1LineageEvent: + items: + $ref: >- + #/components/schemas/GoogleCloudDatacatalogLineageV1ProcessLinkInfo + GoogleCloudDatacatalogLineageV1ProcessLinkInfo: + id: GoogleCloudDatacatalogLineageV1ProcessLinkInfo + description: Link details. type: object properties: + link: + description: >- + The name of the link in the format of + `projects/{project}/locations/{location}/links/{link}`. + type: string startTime: - format: google-datetime + description: The start of the first event establishing this link-process tuple. type: string - description: >- - Required. The beginning of the transformation which resulted in this - lineage event. For streaming scenarios, it should be the beginning - of the period from which the lineage is being reported. - links: - type: array - items: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EventLink' - description: >- - Optional. List of source-target pairs. Can't contain more than 100 - tuples. + format: google-datetime endTime: + description: The end of the last event establishing this link-process tuple. + type: string format: google-datetime - description: >- - Optional. The end of the transformation which resulted in this - lineage event. For streaming scenarios, it should be the end of the - period from which the lineage is being reported. + GoogleCloudDatacatalogLineageV1OperationMetadata: + id: GoogleCloudDatacatalogLineageV1OperationMetadata + description: Metadata describing the operation. + type: object + properties: + state: + description: Output only. The current operation state. + readOnly: true type: string - name: - description: >- - Immutable. The resource name of the lineage event. Format: - `projects/{project}/locations/{location}/processes/{process}/runs/{run}/lineageEvents/{lineage_event}`. - Can be specified or auto-assigned. {lineage_event} must be not - longer than 200 characters and only contain characters in a set: - `a-zA-Z0-9_-:.` + enumDescriptions: + - Unused. + - The operation has been created but is not yet started. + - The operation is underway. + - The operation completed successfully. + - The operation is no longer running and did not succeed. + enum: + - STATE_UNSPECIFIED + - PENDING + - RUNNING + - SUCCEEDED + - FAILED + operationType: + description: Output only. The type of the operation being performed. + readOnly: true type: string - description: >- - A lineage event represents an operation on assets. Within the operation, - the data flows from the source to the target defined in the links field. - id: GoogleCloudDatacatalogLineageV1LineageEvent - GoogleCloudDatacatalogLineageV1SearchLinksRequest: - description: Request message for SearchLinks. - properties: - target: - description: >- - Optional. Send asset information in the **target** field to retrieve - all links that lead from upstream assets to the specified asset. - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' - pageToken: + enumDescriptions: + - Unused. + - The resource deletion operation. + - The resource creation operation. + enum: + - TYPE_UNSPECIFIED + - DELETE + - CREATE + resource: description: >- - Optional. The page token received from a previous - `SearchLinksRequest` call. Use it to get the next page. When - requesting subsequent pages of a response, remember that all - parameters must match the values you provided in the original - request. + Output only. The [relative name] + (https://cloud.google.com//apis/design/resource_names#relative_resource_name) + of the resource being operated on. + readOnly: true type: string - source: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' + resourceUuid: + description: Output only. The UUID of the resource being operated on. + readOnly: true + type: string + createTime: description: >- - Optional. Send asset information in the **source** field to retrieve - all links that lead from the specified asset to downstream assets. - pageSize: + Output only. The timestamp of the operation submission to the + server. + readOnly: true + type: string + format: google-datetime + endTime: description: >- - Optional. The maximum number of links to return in a single page of - the response. A page may contain fewer links than this value. If - unspecified, at most 10 links are returned. Maximum value is 100; - values greater than 100 are reduced to 100. - type: integer - format: int32 - id: GoogleCloudDatacatalogLineageV1SearchLinksRequest - type: object + Output only. The timestamp of the operation termination, regardless + of its success. This field is unset if the operation is still + ongoing. + readOnly: true + type: string + format: google-datetime parameters: - _.xgafv: - description: V1 error format. + access_token: + description: OAuth access token. in: query - name: $.xgafv + name: access_token + schema: + type: string + alt: + description: Data format for response. + in: query + name: alt schema: type: string enum: - - '1' - - '2' - prettyPrint: - description: Returns response with indentations and line breaks. + - json + - media + - proto + callback: + description: JSONP in: query - name: prettyPrint + name: callback schema: - type: boolean + type: string fields: description: Selector specifying which fields to include in a partial response. in: query @@ -649,12 +656,12 @@ components: name: oauth_token schema: type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + prettyPrint: + description: Returns response with indentations and line breaks. in: query - name: uploadType + name: prettyPrint schema: - type: string + type: boolean quotaUser: description: >- Available to use for quota purposes for server-side applications. Can be @@ -670,38 +677,31 @@ components: name: upload_protocol schema: type: string - alt: - description: Data format for response. - in: query - name: alt - schema: - type: string - enum: - - json - - media - - proto - callback: - description: JSONP + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: callback + name: uploadType schema: type: string - access_token: - description: OAuth access token. + _.xgafv: + description: V1 error format. in: query - name: access_token + name: $.xgafv schema: type: string + enum: + - '1' + - '2' x-stackQL-resources: locations: id: google.datalineage.locations name: locations title: Locations methods: - batch_search_link_processes: + process_open_lineage_run_event: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:batchSearchLinkProcesses/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:processOpenLineageRunEvent/post response: mediaType: application/json openAPIDocKey: '200' @@ -712,10 +712,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' - process_open_lineage_run_event: + batch_search_link_processes: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:processOpenLineageRunEvent/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:batchSearchLinkProcesses/post response: mediaType: application/json openAPIDocKey: '200' @@ -730,6 +730,14 @@ components: name: operations title: Operations methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.operations get: operation: $ref: >- @@ -751,14 +759,6 @@ components: response: mediaType: application/json openAPIDocKey: '200' - list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.operations sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/operations/methods/get' @@ -768,50 +768,58 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - lineage_events: - id: google.datalineage.lineage_events - name: lineage_events - title: Lineage_events + processes: + id: google.datalineage.processes + name: processes + title: Processes methods: - get: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}~1runs~1{runsId}~1lineageEvents~1{lineageEventsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes/post response: mediaType: application/json openAPIDocKey: '200' - delete: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}~1runs~1{runsId}~1lineageEvents~1{lineageEventsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes/get response: mediaType: application/json openAPIDocKey: '200' - list: + objectKey: $.processes + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}~1runs~1{runsId}~1lineageEvents/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}/patch response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.lineageEvents - create: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}~1runs~1{runsId}~1lineageEvents/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/lineage_events/methods/get' - - $ref: '#/components/x-stackQL-resources/lineage_events/methods/list' + - $ref: '#/components/x-stackQL-resources/processes/methods/get' + - $ref: '#/components/x-stackQL-resources/processes/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/lineage_events/methods/create' - update: [] + - $ref: '#/components/x-stackQL-resources/processes/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/processes/methods/patch' replace: [] delete: - - $ref: '#/components/x-stackQL-resources/lineage_events/methods/delete' + - $ref: '#/components/x-stackQL-resources/processes/methods/delete' runs: id: google.datalineage.runs name: runs @@ -832,10 +840,10 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.runs - delete: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}~1runs~1{runsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}~1runs~1{runsId}/patch response: mediaType: application/json openAPIDocKey: '200' @@ -846,10 +854,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' - patch: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}~1runs~1{runsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}~1runs~1{runsId}/delete response: mediaType: application/json openAPIDocKey: '200' @@ -864,90 +872,71 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/runs/methods/delete' - processes: - id: google.datalineage.processes - name: processes - title: Processes + lineage_events: + id: google.datalineage.lineage_events + name: lineage_events + title: Lineage_events methods: - get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - delete: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}~1runs~1{runsId}~1lineageEvents/post response: mediaType: application/json openAPIDocKey: '200' - patch: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}~1runs~1{runsId}~1lineageEvents/get response: mediaType: application/json openAPIDocKey: '200' - list: + objectKey: $.lineageEvents + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}~1runs~1{runsId}~1lineageEvents~1{lineageEventsId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.processes - create: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}~1runs~1{runsId}~1lineageEvents~1{lineageEventsId}/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/processes/methods/get' - - $ref: '#/components/x-stackQL-resources/processes/methods/list' + - $ref: '#/components/x-stackQL-resources/lineage_events/methods/get' + - $ref: '#/components/x-stackQL-resources/lineage_events/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/processes/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/processes/methods/patch' + - $ref: '#/components/x-stackQL-resources/lineage_events/methods/create' + update: [] replace: [] delete: - - $ref: '#/components/x-stackQL-resources/processes/methods/delete' + - $ref: '#/components/x-stackQL-resources/lineage_events/methods/delete' paths: - /v1/projects/{projectsId}/locations/{locationsId}:batchSearchLinkProcesses: + /v1/projects/{projectsId}/locations/{locationsId}:processOpenLineageRunEvent: parameters: &ref_1 - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' post: description: >- - Retrieve information about LineageProcesses associated with specific - links. LineageProcesses are transformation pipelines that result in data - flowing from **source** to **target** assets. Links between assets - represent this operation. If you have specific link names, you can use - this method to verify which LineageProcesses contribute to creating - those links. See the SearchLinks method for more information on how to - retrieve link name. You can retrieve the LineageProcess information in - every project where you have the `datalineage.events.get` permission. - The project provided in the URL is used for Billing and Quota. - operationId: datalineage.projects.locations.batchSearchLinkProcesses - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesRequest + Creates new lineage events together with their parents: process and run. + Updates the process and run if they already exist. Mapped from Open + Lineage specification: + https://github.com/OpenLineage/OpenLineage/blob/main/spec/OpenLineage.json. + operationId: datalineage.projects.locations.processOpenLineageRunEvent security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -960,7 +949,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesResponse + #/components/schemas/GoogleCloudDatacatalogLineageV1ProcessOpenLineageRunEventResponse parameters: - in: path name: projectsId @@ -972,6 +961,10 @@ paths: required: true schema: type: string + - in: query + name: requestId + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}:searchLinks: parameters: *ref_1 post: @@ -1013,15 +1006,26 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}:processOpenLineageRunEvent: + /v1/projects/{projectsId}/locations/{locationsId}:batchSearchLinkProcesses: parameters: *ref_1 post: description: >- - Creates new lineage events together with their parents: process and run. - Updates the process and run if they already exist. Mapped from Open - Lineage specification: - https://github.com/OpenLineage/OpenLineage/blob/main/spec/OpenLineage.json. - operationId: datalineage.projects.locations.processOpenLineageRunEvent + Retrieve information about LineageProcesses associated with specific + links. LineageProcesses are transformation pipelines that result in data + flowing from **source** to **target** assets. Links between assets + represent this operation. If you have specific link names, you can use + this method to verify which LineageProcesses contribute to creating + those links. See the SearchLinks method for more information on how to + retrieve link name. You can retrieve the LineageProcess information in + every project where you have the `datalineage.events.get` permission. + The project provided in the URL is used for Billing and Quota. + operationId: datalineage.projects.locations.batchSearchLinkProcesses + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1034,7 +1038,37 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDatacatalogLineageV1ProcessOpenLineageRunEventResponse + #/components/schemas/GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: datalineage.projects.locations.operations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -1047,7 +1081,16 @@ paths: schema: type: string - in: query - name: requestId + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: @@ -1133,7 +1176,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: datalineage.projects.locations.operations.cancel requestBody: content: @@ -1168,13 +1211,16 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/processes: parameters: *ref_1 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: datalineage.projects.locations.operations.list + post: + description: Creates a new process. + operationId: datalineage.projects.locations.processes.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Process' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1186,7 +1232,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Process' parameters: - in: path name: projectsId @@ -1199,23 +1245,14 @@ paths: schema: type: string - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + name: requestId schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs/{runsId}/lineageEvents/{lineageEventsId}: - parameters: *ref_1 get: - description: Gets details of a specified lineage event. - operationId: datalineage.projects.locations.processes.runs.lineageEvents.get + description: >- + List processes in the given project and location. List order is + descending by insertion time. + operationId: datalineage.projects.locations.processes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1228,7 +1265,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDatacatalogLineageV1LineageEvent + #/components/schemas/GoogleCloudDatacatalogLineageV1ListProcessesResponse parameters: - in: path name: projectsId @@ -1236,28 +1273,29 @@ paths: schema: type: string - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: processesId - required: true - schema: - type: string - - in: path - name: runsId - required: true - schema: - type: string - - in: path - name: lineageEventsId + name: locationsId required: true schema: type: string - delete: - description: Deletes the lineage event with the specified name. - operationId: datalineage.projects.locations.processes.runs.lineageEvents.delete + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}: + parameters: *ref_1 + patch: + description: Updates a process. + operationId: datalineage.projects.locations.processes.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Process' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1269,7 +1307,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Process' parameters: - in: path name: projectsId @@ -1286,27 +1324,22 @@ paths: required: true schema: type: string - - in: path - name: runsId - required: true - schema: - type: string - - in: path - name: lineageEventsId - required: true + - in: query + name: updateMask schema: type: string + format: google-fieldmask - in: query name: allowMissing schema: type: boolean - /v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs/{runsId}/lineageEvents: - parameters: *ref_1 + - in: query + name: requestId + schema: + type: string get: - description: >- - Lists lineage events in the given project and location. The list order - is not defined. - operationId: datalineage.projects.locations.processes.runs.lineageEvents.list + description: Gets the details of the specified process. + operationId: datalineage.projects.locations.processes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1318,8 +1351,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDatacatalogLineageV1ListLineageEventsResponse + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Process' parameters: - in: path name: projectsId @@ -1336,28 +1368,9 @@ paths: required: true schema: type: string - - in: path - name: runsId - required: true - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - post: - description: Creates a new lineage event. - operationId: datalineage.projects.locations.processes.runs.lineageEvents.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1LineageEvent' + delete: + description: Deletes the process with the specified name. + operationId: datalineage.projects.locations.processes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1369,8 +1382,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDatacatalogLineageV1LineageEvent + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -1387,15 +1399,10 @@ paths: required: true schema: type: string - - in: path - name: runsId - required: true - schema: - type: string - in: query - name: requestId + name: allowMissing schema: - type: string + type: boolean /v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs: parameters: *ref_1 post: @@ -1483,9 +1490,14 @@ paths: type: string /v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs/{runsId}: parameters: *ref_1 - delete: - description: Deletes the run with the specified name. - operationId: datalineage.projects.locations.processes.runs.delete + patch: + description: Updates a run. + operationId: datalineage.projects.locations.processes.runs.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Run' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1497,7 +1509,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Run' parameters: - in: path name: projectsId @@ -1519,6 +1531,11 @@ paths: required: true schema: type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask - in: query name: allowMissing schema: @@ -1559,14 +1576,9 @@ paths: required: true schema: type: string - patch: - description: Updates a run. - operationId: datalineage.projects.locations.processes.runs.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Run' + delete: + description: Deletes the run with the specified name. + operationId: datalineage.projects.locations.processes.runs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1578,7 +1590,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Run' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -1604,16 +1616,16 @@ paths: name: allowMissing schema: type: boolean - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}: + /v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs/{runsId}/lineageEvents: parameters: *ref_1 - get: - description: Gets the details of the specified process. - operationId: datalineage.projects.locations.processes.get + post: + description: Creates a new lineage event. + operationId: datalineage.projects.locations.processes.runs.lineageEvents.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1LineageEvent' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1625,7 +1637,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Process' + $ref: >- + #/components/schemas/GoogleCloudDatacatalogLineageV1LineageEvent parameters: - in: path name: projectsId @@ -1642,9 +1655,20 @@ paths: required: true schema: type: string - delete: - description: Deletes the process with the specified name. - operationId: datalineage.projects.locations.processes.delete + - in: path + name: runsId + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + get: + description: >- + Lists lineage events in the given project and location. The list order + is not defined. + operationId: datalineage.projects.locations.processes.runs.lineageEvents.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1656,7 +1680,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudDatacatalogLineageV1ListLineageEventsResponse parameters: - in: path name: projectsId @@ -1673,18 +1698,25 @@ paths: required: true schema: type: string + - in: path + name: runsId + required: true + schema: + type: string - in: query - name: allowMissing + name: pageSize schema: - type: boolean - patch: - description: Updates a process. - operationId: datalineage.projects.locations.processes.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Process' + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs/{runsId}/lineageEvents/{lineageEventsId}: + parameters: *ref_1 + get: + description: Gets details of a specified lineage event. + operationId: datalineage.projects.locations.processes.runs.lineageEvents.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1696,7 +1728,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Process' + $ref: >- + #/components/schemas/GoogleCloudDatacatalogLineageV1LineageEvent parameters: - in: path name: projectsId @@ -1713,22 +1746,19 @@ paths: required: true schema: type: string - - in: query - name: allowMissing + - in: path + name: runsId + required: true schema: - type: boolean - - in: query - name: updateMask + type: string + - in: path + name: lineageEventsId + required: true schema: type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/processes: - parameters: *ref_1 - get: - description: >- - List processes in the given project and location. List order is - descending by insertion time. - operationId: datalineage.projects.locations.processes.list + delete: + description: Deletes the lineage event with the specified name. + operationId: datalineage.projects.locations.processes.runs.lineageEvents.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1740,8 +1770,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDatacatalogLineageV1ListProcessesResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -1753,47 +1782,22 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: processesId + required: true schema: type: string - post: - description: Creates a new process. - operationId: datalineage.projects.locations.processes.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Process' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Process' - parameters: - in: path - name: projectsId + name: runsId required: true schema: type: string - in: path - name: locationsId + name: lineageEventsId required: true schema: type: string - in: query - name: requestId + name: allowMissing schema: - type: string + type: boolean diff --git a/providers/src/googleapis.com/v00.00.00000/services/datamigration.yaml b/providers/src/googleapis.com/v00.00.00000/services/datamigration.yaml index 39ba6471..c414c349 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/datamigration.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/datamigration.yaml @@ -7,8 +7,8 @@ info: title: Database Migration API description: Manage Cloud Database Migration Service resources on Google Cloud Platform. version: v1 - x-discovery-doc-revision: '20241026' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250815' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/database-migration/ servers: @@ -379,6 +379,22 @@ components: Configuration for heterogeneous **Oracle to Cloud SQL for PostgreSQL** and **Oracle to AlloyDB for PostgreSQL** migrations. $ref: '#/components/schemas/OracleToPostgresConfig' + sqlserverToPostgresConfig: + description: >- + Configuration for heterogeneous **SQL Server to Cloud SQL for + PostgreSQL** migrations. + $ref: '#/components/schemas/SqlServerToPostgresConfig' + objectsConfig: + description: Optional. The objects that need to be migrated. + $ref: '#/components/schemas/MigrationJobObjectsConfig' + satisfiesPzs: + description: Output only. Reserved for future use. + readOnly: true + type: boolean + satisfiesPzi: + description: Output only. Reserved for future use. + readOnly: true + type: boolean DumpFlags: id: DumpFlags description: Dump flags definition. @@ -469,12 +485,14 @@ components: - Amazon RDS is the source instance provider. - Amazon Aurora is the source instance provider. - AlloyDB for PostgreSQL is the source instance provider. + - Microsoft Azure Database for MySQL/PostgreSQL. enum: - DATABASE_PROVIDER_UNSPECIFIED - CLOUDSQL - RDS - AURORA - ALLOYDB + - AZURE_DATABASE engine: description: The database engine. type: string @@ -573,13 +591,19 @@ components: type: object properties: certPath: - description: Required. Path to certificate. + description: >- + Required. Path to the Certificate (.cer) in Cloud Storage, in the + form `gs://bucketName/fileName`. The instance must have write + permissions to the bucket and read access to the file. type: string pvkPath: - description: Required. Path to certificate private key. + description: >- + Required. Path to the Certificate Private Key (.pvk) in Cloud + Storage, in the form `gs://bucketName/fileName`. The instance must + have write permissions to the bucket and read access to the file. type: string pvkPassword: - description: Required. Input only. Private key password. + description: Required. Input only. Password that encrypts the private key. type: string OracleToPostgresConfig: id: OracleToPostgresConfig @@ -673,6 +697,116 @@ components: description: Optional. Timeout for data migration transactions. type: string format: google-duration + SqlServerToPostgresConfig: + id: SqlServerToPostgresConfig + description: >- + Configuration for heterogeneous **SQL Server to Cloud SQL for + PostgreSQL** migrations. + type: object + properties: + sqlserverSourceConfig: + description: Optional. Configuration for SQL Server source. + $ref: '#/components/schemas/SqlServerSourceConfig' + postgresDestinationConfig: + description: Optional. Configuration for Postgres destination. + $ref: '#/components/schemas/PostgresDestinationConfig' + SqlServerSourceConfig: + id: SqlServerSourceConfig + description: Configuration for SQL Server as a source in a migration. + type: object + properties: + maxConcurrentFullDumpConnections: + description: >- + Optional. Maximum number of connections Database Migration Service + will open to the source for full dump phase. + type: integer + format: int32 + maxConcurrentCdcConnections: + description: >- + Optional. Maximum number of connections Database Migration Service + will open to the source for CDC phase. + type: integer + format: int32 + skipFullDump: + description: Optional. Whether to skip full dump or not. + type: boolean + cdcStartPosition: + description: >- + Optional. The log sequence number (LSN) to start CDC data migration + from. + type: string + MigrationJobObjectsConfig: + id: MigrationJobObjectsConfig + description: Configuration for the objects to be migrated. + type: object + properties: + sourceObjectsConfig: + description: The list of the migration job objects. + $ref: '#/components/schemas/SourceObjectsConfig' + SourceObjectsConfig: + id: SourceObjectsConfig + description: List of configurations for the source objects to be migrated. + type: object + properties: + objectConfigs: + description: Optional. The list of the objects to be migrated. + type: array + items: + $ref: '#/components/schemas/SourceObjectConfig' + objectsSelectionType: + description: Optional. The objects selection type of the migration job. + type: string + enumDescriptions: + - >- + The type of the objects selection is unknown, indicating that the + migration job is at instance level. + - Migrate all of the objects. + - Migrate specific objects. + enum: + - OBJECTS_SELECTION_TYPE_UNSPECIFIED + - ALL_OBJECTS + - SPECIFIED_OBJECTS + SourceObjectConfig: + id: SourceObjectConfig + description: Config for a single migration job object. + type: object + properties: + objectIdentifier: + description: Optional. The object identifier. + $ref: '#/components/schemas/SourceObjectIdentifier' + SourceObjectIdentifier: + id: SourceObjectIdentifier + description: An identifier for the Migration Job Object. + type: object + properties: + database: + description: >- + Optional. The database name. This will be required only if the + object uses a database name as part of its unique identifier. + type: string + schema: + description: >- + Optional. The schema name. This will be required only if the object + uses a schema name as part of its unique identifier. + type: string + table: + description: >- + Optional. The table name. This will be required only if the object + is a level below database or schema. + type: string + type: + description: Required. The type of the migration job object. + type: string + enumDescriptions: + - The type of the migration job object is unknown. + - The migration job object is a database. + - The migration job object is a schema. + - The migration job object is a table. + enum: + - MIGRATION_JOB_OBJECT_TYPE_UNSPECIFIED + - DATABASE + - SCHEMA + - TABLE StartMigrationJobRequest: id: StartMigrationJobRequest description: Request message for 'StartMigrationJob' request. @@ -702,7 +836,10 @@ components: id: PromoteMigrationJobRequest description: Request message for 'PromoteMigrationJob' request. type: object - properties: {} + properties: + objectsFilter: + description: Optional. The object filter to apply to the migration job. + $ref: '#/components/schemas/MigrationJobObjectsConfig' DemoteDestinationRequest: id: DemoteDestinationRequest description: Request message for 'DemoteDestination' request. @@ -734,6 +871,12 @@ components: Optional. Restart the migration job without running prior configuration verification. Defaults to `false`. type: boolean + objectsFilter: + description: Optional. The object filter to apply to the migration job. + $ref: '#/components/schemas/MigrationJobObjectsConfig' + restartFailedObjects: + description: Optional. If true, only failed objects will be restarted. + type: boolean GenerateSshScriptRequest: id: GenerateSshScriptRequest description: Request message for 'GenerateSshScript' request. @@ -938,12 +1081,22 @@ components: - Amazon RDS is the source instance provider. - Amazon Aurora is the source instance provider. - AlloyDB for PostgreSQL is the source instance provider. + - Microsoft Azure Database for MySQL/PostgreSQL. enum: - DATABASE_PROVIDER_UNSPECIFIED - CLOUDSQL - RDS - AURORA - ALLOYDB + - AZURE_DATABASE + satisfiesPzs: + description: Output only. Reserved for future use. + readOnly: true + type: boolean + satisfiesPzi: + description: Output only. Reserved for future use. + readOnly: true + type: boolean MySqlConnectionProfile: id: MySqlConnectionProfile description: >- @@ -1032,6 +1185,15 @@ components: will use this certificate to verify it's connecting to the right host. type: string + sslFlags: + description: >- + Optional. SSL flags used for establishing SSL connection to the + source database. Only source specific flags are supported. An object + containing a list of "key": "value" pairs. Example: { + "server_certificate_hostname": "server.com"}. + type: object + additionalProperties: + type: string PostgreSqlConnectionProfile: id: PostgreSqlConnectionProfile description: >- @@ -1059,6 +1221,9 @@ components: field is not returned on request, and the value is encrypted when stored in Database Migration Service. type: string + database: + description: Optional. The name of the specific database within the host. + type: string passwordSet: description: >- Output only. Indicates If this connection profile password is @@ -1161,6 +1326,9 @@ components: The backup details in Cloud Storage for homogeneous migration to Cloud SQL for SQL Server. $ref: '#/components/schemas/SqlServerBackups' + database: + description: Required. The name of the specific database within the host. + type: string staticIpConnectivity: description: Static IP connectivity data (default, no additional details needed). $ref: '#/components/schemas/StaticIpConnectivity' @@ -1492,16 +1660,20 @@ components: additionalProperties: type: string dataDiskType: - description: 'The type of storage: `PD_SSD` (default) or `PD_HDD`.' + description: >- + The type of storage: `PD_SSD` (default) or `PD_HDD` or + `HYPERDISK_BALANCED`. type: string enumDescriptions: - Unspecified. - SSD disk. - HDD disk. + - A Hyperdisk Balanced data disk. enum: - SQL_DATA_DISK_TYPE_UNSPECIFIED - PD_SSD - PD_HDD + - HYPERDISK_BALANCED dataDiskSizeGb: description: >- The storage capacity available to the database, in GB. The minimum @@ -1575,6 +1747,20 @@ components: overview](https://cloud.google.com/sql/help/mysql-data-cache) in Cloud SQL documentation. $ref: '#/components/schemas/DataCacheConfig' + dataDiskProvisionedIops: + description: >- + Optional. Provisioned number of I/O operations per second for the + data disk. This field is only used for hyperdisk-balanced disk + types. + type: string + format: int64 + dataDiskProvisionedThroughput: + description: >- + Optional. Provisioned throughput measured in MiB per second for the + data disk. This field is only used for hyperdisk-balanced disk + types. + type: string + format: int64 SqlIpConfig: id: SqlIpConfig description: IP Management configuration. @@ -1689,6 +1875,7 @@ components: additionalProperties: type: string primaryInstanceSettings: + description: Settings for the cluster's primary instance $ref: '#/components/schemas/PrimaryInstanceSettings' encryptionConfig: description: >- @@ -1709,11 +1896,13 @@ components: - The database version is Postgres 14. - The database version is Postgres 15. - The database version is Postgres 16. + - The database version is Postgres 17. enum: - DATABASE_VERSION_UNSPECIFIED - POSTGRES_14 - POSTGRES_15 - POSTGRES_16 + - POSTGRES_17 UserPassword: id: UserPassword description: >- @@ -1789,6 +1978,12 @@ components: description: The number of CPU's in the VM instance. type: integer format: int32 + machineType: + description: >- + Optional. Machine type of the VM instance. E.g. "n2-highmem-4", + "n2-highmem-8", "c4a-highmem-4-lssd". cpu_count must match the + number of vCPUs in the machine type. + type: string InstanceNetworkConfig: id: InstanceNetworkConfig description: Metadata related to instance level network configuration. @@ -1886,9 +2081,20 @@ components: description: Output only. The error details in case of state FAILED. readOnly: true $ref: '#/components/schemas/Status' + satisfiesPzs: + description: Output only. Reserved for future use. + readOnly: true + type: boolean + satisfiesPzi: + description: Output only. Reserved for future use. + readOnly: true + type: boolean vpcPeeringConfig: description: VPC peering configuration. $ref: '#/components/schemas/VpcPeeringConfig' + pscInterfaceConfig: + description: PSC Interface configuration. + $ref: '#/components/schemas/PscInterfaceConfig' VpcPeeringConfig: id: VpcPeeringConfig description: >- @@ -1904,6 +2110,19 @@ components: subnet: description: Required. A free subnet for peering. (CIDR of /29) type: string + PscInterfaceConfig: + id: PscInterfaceConfig + description: >- + The PSC Interface configuration is used to create PSC Interface between + DMS's internal VPC and the consumer's PSC. + type: object + properties: + networkAttachment: + description: >- + Required. Fully qualified name of the Network Attachment that DMS + will connect to. Format: + `projects/{{project}}/regions/{{region}}/networkAttachments/{{name}}` + type: string ListPrivateConnectionsResponse: id: ListPrivateConnectionsResponse description: Response message for 'ListPrivateConnections' request. @@ -1980,6 +2199,44 @@ components: displayName: description: Optional. The display name for the workspace. type: string + destinationProvider: + description: Optional. The provider for the destination database. + type: string + enumDescriptions: + - >- + Use this value for on-premise source database instances and + ORACLE. + - Cloud SQL is the source instance provider. + - Amazon RDS is the source instance provider. + - Amazon Aurora is the source instance provider. + - AlloyDB for PostgreSQL is the source instance provider. + - Microsoft Azure Database for MySQL/PostgreSQL. + enum: + - DATABASE_PROVIDER_UNSPECIFIED + - CLOUDSQL + - RDS + - AURORA + - ALLOYDB + - AZURE_DATABASE + sourceProvider: + description: Optional. The provider for the source database. + type: string + enumDescriptions: + - >- + Use this value for on-premise source database instances and + ORACLE. + - Cloud SQL is the source instance provider. + - Amazon RDS is the source instance provider. + - Amazon Aurora is the source instance provider. + - AlloyDB for PostgreSQL is the source instance provider. + - Microsoft Azure Database for MySQL/PostgreSQL. + enum: + - DATABASE_PROVIDER_UNSPECIFIED + - CLOUDSQL + - RDS + - AURORA + - ALLOYDB + - AZURE_DATABASE DatabaseEngineInfo: id: DatabaseEngineInfo description: The type and version of a source or destination database. @@ -3162,6 +3419,41 @@ components: - DATABASE_ENTITY_TYPE_UDT - DATABASE_ENTITY_TYPE_MATERIALIZED_VIEW - DATABASE_ENTITY_TYPE_DATABASE + ddlKind: + description: >- + The DDL Kind selected for apply, or UNSPECIFIED if the entity wasn't + converted yet. + type: string + enumDescriptions: + - The kind of the DDL is unknown. + - DDL of the source entity + - Deterministic converted DDL + - Gemini AI converted DDL + - User edited DDL + enum: + - DDL_KIND_UNSPECIFIED + - SOURCE + - DETERMINISTIC + - AI + - USER_EDIT + editedDdlKind: + description: >- + If ddl_kind is USER_EDIT, this holds the DDL kind of the original + content - DETERMINISTIC or AI. Otherwise, this is + DDL_KIND_UNSPECIFIED. + type: string + enumDescriptions: + - The kind of the DDL is unknown. + - DDL of the source entity + - Deterministic converted DDL + - Gemini AI converted DDL + - User edited DDL + enum: + - DDL_KIND_UNSPECIFIED + - SOURCE + - DETERMINISTIC + - AI + - USER_EDIT issueId: description: EntityIssues found for this ddl. type: array @@ -3408,6 +3700,9 @@ components: defaultValue: description: Default value of the column. type: string + computed: + description: Is the column a computed column. + type: boolean ConstraintEntity: id: ConstraintEntity description: >- @@ -3715,6 +4010,11 @@ components: sqlCode: description: The SQL code which creates the view. type: string + indices: + description: View indices. + type: array + items: + $ref: '#/components/schemas/IndexEntity' customFeatures: description: Custom engine specific features. type: object @@ -3896,6 +4196,116 @@ components: A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. type: string + MigrationJobObject: + id: MigrationJobObject + description: A specific Migration Job Object (e.g. a specifc DB Table) + type: object + properties: + name: + description: The object's name. + type: string + sourceObject: + description: The object identifier in the data source. + $ref: '#/components/schemas/SourceObjectIdentifier' + error: + description: Output only. The error details in case of failure. + readOnly: true + $ref: '#/components/schemas/Status' + state: + description: The state of the migration job object. + type: string + enumDescriptions: + - The state of the migration job object is unknown. + - The migration job object is not started. + - The migration job object is running. + - The migration job object is being stopped. + - The migration job object is currently stopped. + - The migration job object is restarting. + - The migration job object failed. + - The migration job object is deleting. + - The migration job object is not selected for migration. + - The migration job object is completed. + enum: + - STATE_UNSPECIFIED + - NOT_STARTED + - RUNNING + - STOPPING + - STOPPED + - RESTARTING + - FAILED + - REMOVING + - NOT_SELECTED + - COMPLETED + phase: + description: Output only. The phase of the migration job object. + readOnly: true + type: string + enumDescriptions: + - The phase of the migration job is unknown. + - The migration job object is in the full dump phase. + - The migration job object is in CDC phase. + - The migration job object is ready to be promoted. + - The migration job object is in running the promote phase. + - The migration job is promoted. + - The migration job object is in the differential backup phase. + enum: + - PHASE_UNSPECIFIED + - FULL_DUMP + - CDC + - READY_FOR_PROMOTE + - PROMOTE_IN_PROGRESS + - PROMOTED + - DIFF_BACKUP + createTime: + description: Output only. The creation time of the migration job object. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. The last update time of the migration job object. + readOnly: true + type: string + format: google-datetime + heterogeneousMetadata: + description: Output only. Metadata for heterogeneous migration jobs objects. + readOnly: true + $ref: '#/components/schemas/HeterogeneousMetadata' + HeterogeneousMetadata: + id: HeterogeneousMetadata + description: Metadata for heterogeneous migration jobs objects. + type: object + properties: + unsupportedEventsCount: + description: The number of unsupported events. + type: string + format: int64 + LookupMigrationJobObjectRequest: + id: LookupMigrationJobObjectRequest + description: >- + Request for looking up a specific migration job object by its source + object identifier. + type: object + properties: + sourceObjectIdentifier: + description: >- + Required. The source object identifier which maps to the migration + job object. + $ref: '#/components/schemas/SourceObjectIdentifier' + ListMigrationJobObjectsResponse: + id: ListMigrationJobObjectsResponse + description: Response containing the objects for a migration job. + type: object + properties: + migrationJobObjects: + description: List of migration job objects. + type: array + items: + $ref: '#/components/schemas/MigrationJobObject' + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. + type: string ListLocationsResponse: id: ListLocationsResponse description: The response message for Locations.ListLocations. @@ -4310,14 +4720,22 @@ components: description: >- Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled - have Operation.error value with a google.rpc.Status.code of 1, - corresponding to `Code.CANCELLED`. + have google.longrunning.Operation.error value with a + google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. readOnly: true type: boolean apiVersion: description: Output only. API version used to start the operation. readOnly: true type: string + metadata: + description: >- + Output only. Additional metadata that is returned by the backend for + the operation. + readOnly: true + type: object + additionalProperties: + type: string MigrationJobVerificationError: id: MigrationJobVerificationError description: Error message of a verification Migration job. @@ -4702,6 +5120,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + fetch_source_objects: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1migrationJobs~1{migrationJobsId}:fetchSourceObjects/get + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/migration_jobs/methods/get' @@ -4750,6 +5175,41 @@ components: - $ref: >- #/components/x-stackQL-resources/migration_jobs_iam_policies/methods/set_iam_policy delete: [] + objects: + id: google.datamigration.objects + name: objects + title: Objects + methods: + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1migrationJobs~1{migrationJobsId}~1objects~1{objectsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + lookup: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1migrationJobs~1{migrationJobsId}~1objects:lookup/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1migrationJobs~1{migrationJobsId}~1objects/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.migrationJobObjects + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/objects/methods/get' + - $ref: '#/components/x-stackQL-resources/objects/methods/list' + insert: [] + update: [] + replace: [] + delete: [] objects_iam_policies: id: google.datamigration.objects_iam_policies name: objects_iam_policies @@ -5248,6 +5708,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: @@ -5402,7 +5866,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: datamigration.projects.locations.operations.cancel requestBody: content: @@ -5997,6 +6461,43 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}:fetchSourceObjects: + parameters: *ref_1 + get: + description: >- + Retrieves objects from the source database that can be selected for data + migration. This is applicable for the following migrations: 1. + PostgreSQL to Cloud SQL for PostgreSQL 2. PostgreSQL to AlloyDB for + PostgreSQL. + operationId: datamigration.projects.locations.migrationJobs.fetchSourceObjects + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: migrationJobsId + required: true + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}:setIamPolicy: parameters: *ref_1 post: @@ -6121,6 +6622,126 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}/objects/{objectsId}: + parameters: *ref_1 + get: + description: Use this method to get details about a migration job object. + operationId: datamigration.projects.locations.migrationJobs.objects.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/MigrationJobObject' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: migrationJobsId + required: true + schema: + type: string + - in: path + name: objectsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}/objects:lookup: + parameters: *ref_1 + post: + description: >- + Use this method to look up a migration job object by its source object + identifier. + operationId: datamigration.projects.locations.migrationJobs.objects.lookup + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LookupMigrationJobObjectRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/MigrationJobObject' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: migrationJobsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}/objects: + parameters: *ref_1 + get: + description: Use this method to list the objects of a specific migration job. + operationId: datamigration.projects.locations.migrationJobs.objects.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListMigrationJobObjectsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: migrationJobsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}/objects/{objectsId}:setIamPolicy: parameters: *ref_1 post: @@ -6652,6 +7273,10 @@ paths: name: skipValidation schema: type: boolean + - in: query + name: validateOnly + schema: + type: boolean get: description: Retrieves a list of private connections in a given project and location. operationId: datamigration.projects.locations.privateConnections.list diff --git a/providers/src/googleapis.com/v00.00.00000/services/datapipelines.yaml b/providers/src/googleapis.com/v00.00.00000/services/datapipelines.yaml index 77cdd927..b38986ab 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/datapipelines.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/datapipelines.yaml @@ -9,8 +9,8 @@ info: Data Pipelines provides an interface for creating, updating, and managing recurring Data Analytics jobs. version: v1 - x-discovery-doc-revision: '20241027' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250810' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/dataflow/docs/guides/data-pipelines servers: @@ -36,235 +36,57 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudDatapipelinesV1Workload: - id: GoogleCloudDatapipelinesV1Workload - type: object - properties: - dataflowLaunchTemplateRequest: - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1LaunchTemplateRequest' - description: >- - Template information and additional parameters needed to launch a - Dataflow job using the standard launch API. - dataflowFlexTemplateRequest: - $ref: >- - #/components/schemas/GoogleCloudDatapipelinesV1LaunchFlexTemplateRequest - description: >- - Template information and additional parameters needed to launch a - Dataflow job using the flex launch API. - description: Workload details for creating the pipeline jobs. - GoogleCloudDatapipelinesV1LaunchFlexTemplateRequest: - id: GoogleCloudDatapipelinesV1LaunchFlexTemplateRequest + GoogleCloudDatapipelinesV1Pipeline: + id: GoogleCloudDatapipelinesV1Pipeline + description: >- + The main pipeline entity and all the necessary metadata for launching + and managing linked jobs. type: object - description: A request to launch a Dataflow job from a Flex Template. - properties: - validateOnly: - type: boolean - description: >- - If true, the request is validated but not actually executed. - Defaults to false. - location: - description: >- - Required. The [regional endpoint] - (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) - to which to direct the request. For example, `us-central1`, - `us-west1`. - type: string - launchParameter: - $ref: >- - #/components/schemas/GoogleCloudDatapipelinesV1LaunchFlexTemplateParameter - description: Required. Parameter to launch a job from a Flex Template. - projectId: - type: string - description: >- - Required. The ID of the Cloud Platform project that the job belongs - to. - GoogleCloudDatapipelinesV1LaunchTemplateRequest: properties: - projectId: - description: >- - Required. The ID of the Cloud Platform project that the job belongs - to. - type: string - location: + name: description: >- - The [regional endpoint] - (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) - to which to direct the request. - type: string - gcsPath: + The pipeline name. For example: + `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. * + `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), + hyphens (-), colons (:), and periods (.). For more information, see + [Identifying + projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects). + * `LOCATION_ID` is the canonical ID for the pipeline's location. The + list of available locations can be obtained by calling + `google.cloud.location.Locations.ListLocations`. Note that the Data + Pipelines service is not available in all regions. It depends on + Cloud Scheduler, an App Engine application, so it's only available + in [App Engine + regions](https://cloud.google.com/about/locations#region). * + `PIPELINE_ID` is the ID of the pipeline. Must be unique for the + selected project and location. type: string + displayName: description: >- - A Cloud Storage path to the template from which to create the job. - Must be a valid Cloud Storage URL, beginning with 'gs://'. - validateOnly: - type: boolean - description: >- - If true, the request is validated but not actually executed. - Defaults to false. - launchParameters: - $ref: >- - #/components/schemas/GoogleCloudDatapipelinesV1LaunchTemplateParameters - description: >- - The parameters of the template to launch. This should be part of the - body of the POST request. - type: object - description: A request to launch a template. - id: GoogleCloudDatapipelinesV1LaunchTemplateRequest - GoogleCloudDatapipelinesV1Job: - type: object - properties: - createTime: - type: string - description: Output only. The time of job creation. - readOnly: true - format: google-datetime - id: - description: Output only. The internal ID for the job. + Required. The display name of the pipeline. It can contain only + letters ([A-Za-z]), numbers ([0-9]), hyphens (-), and underscores + (_). type: string - readOnly: true - status: - $ref: '#/components/schemas/GoogleRpcStatus' + type: description: >- - Status capturing any error code or message related to job creation - or execution. - dataflowJobDetails: - description: All the details that are specific to a Dataflow job. - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1DataflowJobDetails' - name: - type: string - description: Required. The fully qualified resource name for the job. - endTime: - format: google-datetime - readOnly: true + Required. The type of the pipeline. This field affects the + scheduling of the pipeline and the type of metrics to show for the + pipeline. type: string - description: >- - Output only. The time of job termination. This is absent if the job - is still running. - state: enumDescriptions: - - The job state isn't specified. - - The job is waiting to start execution. - - The job is executing. - - The job has finished execution successfully. - - The job has finished execution with a failure. - - The job has been terminated upon user request. + - The pipeline type isn't specified. + - >- + A batch pipeline. It runs jobs on a specific schedule, and each + job will automatically terminate once execution is finished. + - >- + A streaming pipeline. The underlying job is continuously running + until it is manually terminated by the user. This type of pipeline + doesn't have a schedule to run on, and the linked job gets created + when the pipeline is created. enum: - - STATE_UNSPECIFIED - - STATE_PENDING - - STATE_RUNNING - - STATE_DONE - - STATE_FAILED - - STATE_CANCELLED - type: string - description: The current state of the job. - description: >- - Definition of the job information maintained by the pipeline. Fields in - this entity are retrieved from the executor API (e.g. Dataflow API). - id: GoogleCloudDatapipelinesV1Job - GoogleCloudDatapipelinesV1DataflowJobDetails: - properties: - resourceInfo: - description: >- - Cached version of all the metrics of interest for the job. This - value gets stored here when the job is terminated. As long as the - job is running, this field is populated from the Dataflow API. - type: object - additionalProperties: - format: double - type: number - sdkVersion: - description: Output only. The SDK version used to run the job. - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1SdkVersion' - readOnly: true - currentWorkers: - type: integer - description: >- - Output only. The current number of workers used to run the jobs. - Only set to a value if the job is still running. - readOnly: true - format: int32 - id: GoogleCloudDatapipelinesV1DataflowJobDetails - type: object - description: >- - Pipeline job details specific to the Dataflow API. This is encapsulated - here to allow for more executors to store their specific details - separately. - GoogleCloudDatapipelinesV1LaunchFlexTemplateParameter: - properties: - transformNameMappings: - description: >- - Use this to pass transform name mappings for streaming update jobs. - Example: `{"oldTransformName":"newTransformName",...}` - additionalProperties: - type: string - type: object - jobName: - description: >- - Required. The job name to use for the created job. For an update job - request, the job name should be the same as the existing running - job. - type: string - update: - type: boolean - description: >- - Set this to true if you are sending a request to update a running - streaming job. When set, the job name should be the same as the - running job. - launchOptions: - additionalProperties: - type: string - description: >- - Launch options for this Flex Template job. This is a common set of - options across languages and templates. This should not be used to - pass job parameters. - type: object - parameters: - description: 'The parameters for the Flex Template. Example: `{"num_workers":"5"}`' - type: object - additionalProperties: - type: string - environment: - $ref: >- - #/components/schemas/GoogleCloudDatapipelinesV1FlexTemplateRuntimeEnvironment - description: The runtime environment for the Flex Template job. - containerSpecGcsPath: - description: >- - Cloud Storage path to a file with a JSON-serialized ContainerSpec as - content. - type: string - type: object - description: Launch Flex Template parameter. - id: GoogleCloudDatapipelinesV1LaunchFlexTemplateParameter - GoogleCloudDatapipelinesV1ListJobsResponse: - type: object - description: Response message for ListJobs - properties: - nextPageToken: - description: >- - A token, which can be sent as `page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. - type: string - jobs: - items: - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Job' - description: >- - Results that were accessible to the caller. Results are always in - descending order of job creation date. - type: array - id: GoogleCloudDatapipelinesV1ListJobsResponse - GoogleCloudDatapipelinesV1Pipeline: - description: >- - The main pipeline entity and all the necessary metadata for launching - and managing linked jobs. - id: GoogleCloudDatapipelinesV1Pipeline - type: object - properties: - scheduleInfo: - description: >- - Internal scheduling information for a pipeline. If this information - is provided, periodic jobs will be created per the schedule. If not, - users are responsible for creating jobs externally. - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1ScheduleSpec' + - PIPELINE_TYPE_UNSPECIFIED + - PIPELINE_TYPE_BATCH + - PIPELINE_TYPE_STREAMING state: description: >- Required. The state of the pipeline. When the pipeline is created, @@ -298,130 +120,140 @@ components: - STATE_STOPPING - STATE_ARCHIVED - STATE_PAUSED + createTime: + description: >- + Output only. Immutable. The timestamp when the pipeline was + initially created. Set by the Data Pipelines service. + readOnly: true + type: string + format: google-datetime + lastUpdateTime: + description: >- + Output only. Immutable. The timestamp when the pipeline was last + modified. Set by the Data Pipelines service. + readOnly: true + type: string + format: google-datetime + workload: + description: Workload information for creating new jobs. + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Workload' + scheduleInfo: + description: >- + Internal scheduling information for a pipeline. If this information + is provided, periodic jobs will be created per the schedule. If not, + users are responsible for creating jobs externally. + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1ScheduleSpec' jobCount: description: Output only. Number of jobs. readOnly: true type: integer format: int32 + schedulerServiceAccountEmail: + description: >- + Optional. A service account email to be used with the Cloud + Scheduler job. If not specified, the default compute engine service + account will be used. + type: string pipelineSources: description: >- Immutable. The sources of the pipeline (for example, Dataplex). The keys and values are set by the corresponding sources during pipeline creation. + type: object additionalProperties: type: string - type: object - createTime: - format: google-datetime - readOnly: true - type: string - description: >- - Output only. Immutable. The timestamp when the pipeline was - initially created. Set by the Data Pipelines service. - schedulerServiceAccountEmail: - type: string - description: >- - Optional. A service account email to be used with the Cloud - Scheduler job. If not specified, the default compute engine service - account will be used. - name: + GoogleCloudDatapipelinesV1Workload: + id: GoogleCloudDatapipelinesV1Workload + description: Workload details for creating the pipeline jobs. + type: object + properties: + dataflowLaunchTemplateRequest: description: >- - The pipeline name. For example: - `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. * - `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), - hyphens (-), colons (:), and periods (.). For more information, see - [Identifying - projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects). - * `LOCATION_ID` is the canonical ID for the pipeline's location. The - list of available locations can be obtained by calling - `google.cloud.location.Locations.ListLocations`. Note that the Data - Pipelines service is not available in all regions. It depends on - Cloud Scheduler, an App Engine application, so it's only available - in [App Engine - regions](https://cloud.google.com/about/locations#region). * - `PIPELINE_ID` is the ID of the pipeline. Must be unique for the - selected project and location. - type: string - workload: - description: Workload information for creating new jobs. - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Workload' - type: + Template information and additional parameters needed to launch a + Dataflow job using the standard launch API. + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1LaunchTemplateRequest' + dataflowFlexTemplateRequest: description: >- - Required. The type of the pipeline. This field affects the - scheduling of the pipeline and the type of metrics to show for the - pipeline. - type: string - enum: - - PIPELINE_TYPE_UNSPECIFIED - - PIPELINE_TYPE_BATCH - - PIPELINE_TYPE_STREAMING - enumDescriptions: - - The pipeline type isn't specified. - - >- - A batch pipeline. It runs jobs on a specific schedule, and each - job will automatically terminate once execution is finished. - - >- - A streaming pipeline. The underlying job is continuously running - until it is manually terminated by the user. This type of pipeline - doesn't have a schedule to run on, and the linked job gets created - when the pipeline is created. - lastUpdateTime: - readOnly: true + Template information and additional parameters needed to launch a + Dataflow job using the flex launch API. + $ref: >- + #/components/schemas/GoogleCloudDatapipelinesV1LaunchFlexTemplateRequest + GoogleCloudDatapipelinesV1LaunchTemplateRequest: + id: GoogleCloudDatapipelinesV1LaunchTemplateRequest + description: A request to launch a template. + type: object + properties: + projectId: description: >- - Output only. Immutable. The timestamp when the pipeline was last - modified. Set by the Data Pipelines service. + Required. The ID of the Cloud Platform project that the job belongs + to. type: string - format: google-datetime - displayName: + validateOnly: description: >- - Required. The display name of the pipeline. It can contain only - letters ([A-Za-z]), numbers ([0-9]), hyphens (-), and underscores - (_). + If true, the request is validated but not actually executed. + Defaults to false. + type: boolean + gcsPath: + description: >- + A Cloud Storage path to the template from which to create the job. + Must be a valid Cloud Storage URL, beginning with 'gs://'. type: string - GoogleRpcStatus: - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - type: object - id: GoogleRpcStatus - properties: - details: + launchParameters: description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - items: - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: object - type: array - code: - description: The status code, which should be an enum value of google.rpc.Code. - type: integer - format: int32 - message: + The parameters of the template to launch. This should be part of the + body of the POST request. + $ref: >- + #/components/schemas/GoogleCloudDatapipelinesV1LaunchTemplateParameters + location: description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. + The [regional endpoint] + (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) + to which to direct the request. type: string - GoogleCloudDatapipelinesV1RunPipelineResponse: - id: GoogleCloudDatapipelinesV1RunPipelineResponse - properties: - job: - description: Job that was created as part of RunPipeline operation. - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Job' - description: Response message for RunPipeline + GoogleCloudDatapipelinesV1LaunchTemplateParameters: + id: GoogleCloudDatapipelinesV1LaunchTemplateParameters + description: Parameters to provide to the template being launched. type: object + properties: + jobName: + description: Required. The job name to use for the created job. + type: string + parameters: + description: The runtime parameters to pass to the job. + type: object + additionalProperties: + type: string + environment: + description: The runtime environment for the job. + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1RuntimeEnvironment' + update: + description: >- + If set, replace the existing pipeline with the name specified by + jobName with this pipeline, preserving state. + type: boolean + transformNameMapping: + description: >- + Map of transform name prefixes of the job to be replaced to the + corresponding name prefixes of the new job. Only applicable when + updating a pipeline. + type: object + additionalProperties: + type: string GoogleCloudDatapipelinesV1RuntimeEnvironment: + id: GoogleCloudDatapipelinesV1RuntimeEnvironment description: The environment values to set at runtime. type: object properties: + numWorkers: + description: The initial number of Compute Engine instances for the job. + type: integer + format: int32 + maxWorkers: + description: >- + The maximum number of Compute Engine instances to be made available + to your pipeline during execution, from 1 to 1000. + type: integer + format: int32 zone: description: >- The Compute Engine [availability @@ -429,21 +261,76 @@ components: for launching worker instances to run your pipeline. In the future, worker_zone will take precedence. type: string - ipConfiguration: + serviceAccountEmail: + description: The email address of the service account to run the job as. + type: string + tempLocation: + description: >- + The Cloud Storage path to use for temporary files. Must be a valid + Cloud Storage URL, beginning with `gs://`. + type: string + bypassTempDirValidation: + description: >- + Whether to bypass the safety checks for the job's temporary + directory. Use with caution. + type: boolean + machineType: + description: >- + The machine type to use for the job. Defaults to the value from the + template if not specified. + type: string + additionalExperiments: + description: Additional experiment flags for the job. + type: array + items: + type: string + network: + description: >- + Network to which VMs will be assigned. If empty or unspecified, the + service will use the network "default". + type: string + subnetwork: + description: >- + Subnetwork to which VMs will be assigned, if desired. You can + specify a subnetwork using either a complete URL or an abbreviated + path. Expected to be of the form + "https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNETWORK" + or "regions/REGION/subnetworks/SUBNETWORK". If the subnetwork is + located in a Shared VPC network, you must use the complete URL. + type: string + additionalUserLabels: + description: >- + Additional user labels to be specified for the job. Keys and values + should follow the restrictions specified in the [labeling + restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) + page. An object containing a list of key/value pairs. Example: { + "name": "wrench", "mass": "1kg", "count": "3" }. + type: object + additionalProperties: + type: string + kmsKeyName: + description: >- + Name for the Cloud KMS key for the job. The key format is: + projects//locations//keyRings//cryptoKeys/ type: string + ipConfiguration: description: Configuration for VM IPs. - enum: - - WORKER_IP_UNSPECIFIED - - WORKER_IP_PUBLIC - - WORKER_IP_PRIVATE + type: string enumDescriptions: - The configuration is unknown, or unspecified. - Workers should have public IP addresses. - Workers should have private IP addresses. - machineType: + enum: + - WORKER_IP_UNSPECIFIED + - WORKER_IP_PUBLIC + - WORKER_IP_PRIVATE + workerRegion: description: >- - The machine type to use for the job. Defaults to the value from the - template if not specified. + The Compute Engine region + (https://cloud.google.com/compute/docs/regions-zones/regions-zones) + in which worker processing should occur, e.g. "us-west1". Mutually + exclusive with worker_zone. If neither worker_region nor worker_zone + is specified, default to the control plane's region. type: string workerZone: description: >- @@ -455,67 +342,127 @@ components: chosen based on available capacity. If both `worker_zone` and `zone` are set, `worker_zone` takes precedence. type: string - kmsKeyName: + enableStreamingEngine: + description: Whether to enable Streaming Engine for the job. + type: boolean + GoogleCloudDatapipelinesV1LaunchFlexTemplateRequest: + id: GoogleCloudDatapipelinesV1LaunchFlexTemplateRequest + description: A request to launch a Dataflow job from a Flex Template. + type: object + properties: + projectId: description: >- - Name for the Cloud KMS key for the job. The key format is: - projects//locations//keyRings//cryptoKeys/ + Required. The ID of the Cloud Platform project that the job belongs + to. type: string - maxWorkers: + launchParameter: + description: Required. Parameter to launch a job from a Flex Template. + $ref: >- + #/components/schemas/GoogleCloudDatapipelinesV1LaunchFlexTemplateParameter + location: + description: >- + Required. The [regional endpoint] + (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) + to which to direct the request. For example, `us-central1`, + `us-west1`. + type: string + validateOnly: + description: >- + If true, the request is validated but not actually executed. + Defaults to false. + type: boolean + GoogleCloudDatapipelinesV1LaunchFlexTemplateParameter: + id: GoogleCloudDatapipelinesV1LaunchFlexTemplateParameter + description: Launch Flex Template parameter. + type: object + properties: + jobName: + description: >- + Required. The job name to use for the created job. For an update job + request, the job name should be the same as the existing running + job. + type: string + containerSpecGcsPath: + description: >- + Cloud Storage path to a file with a JSON-serialized ContainerSpec as + content. + type: string + parameters: + description: 'The parameters for the Flex Template. Example: `{"num_workers":"5"}`' + type: object + additionalProperties: + type: string + launchOptions: + description: >- + Launch options for this Flex Template job. This is a common set of + options across languages and templates. This should not be used to + pass job parameters. + type: object + additionalProperties: + type: string + environment: + description: The runtime environment for the Flex Template job. + $ref: >- + #/components/schemas/GoogleCloudDatapipelinesV1FlexTemplateRuntimeEnvironment + update: + description: >- + Set this to true if you are sending a request to update a running + streaming job. When set, the job name should be the same as the + running job. + type: boolean + transformNameMappings: + description: >- + Use this to pass transform name mappings for streaming update jobs. + Example: `{"oldTransformName":"newTransformName",...}` + type: object + additionalProperties: + type: string + GoogleCloudDatapipelinesV1FlexTemplateRuntimeEnvironment: + id: GoogleCloudDatapipelinesV1FlexTemplateRuntimeEnvironment + description: The environment values to be set at runtime for a Flex Template. + type: object + properties: + numWorkers: + description: The initial number of Compute Engine instances for the job. + type: integer format: int32 + maxWorkers: description: >- The maximum number of Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000. type: integer + format: int32 + zone: + description: >- + The Compute Engine [availability + zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones) + for launching worker instances to run your pipeline. In the future, + worker_zone will take precedence. + type: string serviceAccountEmail: description: The email address of the service account to run the job as. type: string - enableStreamingEngine: - description: Whether to enable Streaming Engine for the job. - type: boolean - numWorkers: - description: The initial number of Compute Engine instances for the job. - format: int32 - type: integer - bypassTempDirValidation: + tempLocation: description: >- - Whether to bypass the safety checks for the job's temporary - directory. Use with caution. - type: boolean - network: + The Cloud Storage path to use for temporary files. Must be a valid + Cloud Storage URL, beginning with `gs://`. type: string + machineType: description: >- - Network to which VMs will be assigned. If empty or unspecified, the - service will use the network "default". - additionalUserLabels: - type: object - additionalProperties: - type: string - description: >- - Additional user labels to be specified for the job. Keys and values - should follow the restrictions specified in the [labeling - restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) - page. An object containing a list of key/value pairs. Example: { - "name": "wrench", "mass": "1kg", "count": "3" }. + The machine type to use for the job. Defaults to the value from the + template if not specified. + type: string additionalExperiments: + description: Additional experiment flags for the job. type: array items: type: string - description: Additional experiment flags for the job. - workerRegion: - type: string + network: description: >- - The Compute Engine region - (https://cloud.google.com/compute/docs/regions-zones/regions-zones) - in which worker processing should occur, e.g. "us-west1". Mutually - exclusive with worker_zone. If neither worker_region nor worker_zone - is specified, default to the control plane's region. - tempLocation: + Network to which VMs will be assigned. If empty or unspecified, the + service will use the network "default". type: string - description: >- - The Cloud Storage path to use for temporary files. Must be a valid - Cloud Storage URL, beginning with `gs://`. subnetwork: - type: string description: >- Subnetwork to which VMs will be assigned, if desired. You can specify a subnetwork using either a complete URL or an abbreviated @@ -523,163 +470,256 @@ components: "https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNETWORK" or "regions/REGION/subnetworks/SUBNETWORK". If the subnetwork is located in a Shared VPC network, you must use the complete URL. - id: GoogleCloudDatapipelinesV1RuntimeEnvironment - GoogleCloudDatapipelinesV1LaunchTemplateParameters: - type: object - properties: - update: - type: boolean - description: >- - If set, replace the existing pipeline with the name specified by - jobName with this pipeline, preserving state. - jobName: - description: Required. The job name to use for the created job. type: string - parameters: - additionalProperties: - type: string - description: The runtime parameters to pass to the job. + additionalUserLabels: + description: >- + Additional user labels to be specified for the job. Keys and values + must follow the restrictions specified in the [labeling + restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions). + An object containing a list of key/value pairs. Example: `{ "name": + "wrench", "mass": "1kg", "count": "3" }`. type: object - environment: - description: The runtime environment for the job. - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1RuntimeEnvironment' - transformNameMapping: additionalProperties: type: string + kmsKeyName: description: >- - Map of transform name prefixes of the job to be replaced to the - corresponding name prefixes of the new job. Only applicable when - updating a pipeline. - type: object - id: GoogleCloudDatapipelinesV1LaunchTemplateParameters - description: Parameters to provide to the template being launched. - GoogleProtobufEmpty: - properties: {} - type: object - id: GoogleProtobufEmpty - description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } - GoogleCloudDatapipelinesV1FlexTemplateRuntimeEnvironment: - type: object - description: The environment values to be set at runtime for a Flex Template. - properties: - serviceAccountEmail: + Name for the Cloud KMS key for the job. Key format is: + projects//locations//keyRings//cryptoKeys/ type: string - description: The email address of the service account to run the job as. - workerRegion: + ipConfiguration: + description: Configuration for VM IPs. type: string + enumDescriptions: + - The configuration is unknown, or unspecified. + - Workers should have public IP addresses. + - Workers should have private IP addresses. + enum: + - WORKER_IP_UNSPECIFIED + - WORKER_IP_PUBLIC + - WORKER_IP_PRIVATE + workerRegion: description: >- The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1". Mutually exclusive with worker_zone. If neither worker_region nor worker_zone is specified, defaults to the control plane region. - maxWorkers: + type: string + workerZone: description: >- - The maximum number of Compute Engine instances to be made available - to your pipeline during execution, from 1 to 1000. - format: int32 - type: integer - network: + The Compute Engine zone + (https://cloud.google.com/compute/docs/regions-zones/regions-zones) + in which worker processing should occur, e.g. "us-west1-a". Mutually + exclusive with worker_region. If neither worker_region nor + worker_zone is specified, a zone in the control plane region is + chosen based on available capacity. If both `worker_zone` and `zone` + are set, `worker_zone` takes precedence. type: string + enableStreamingEngine: + description: Whether to enable Streaming Engine for the job. + type: boolean + flexrsGoal: description: >- - Network to which VMs will be assigned. If empty or unspecified, the - service will use the network "default". - ipConfiguration: - enum: - - WORKER_IP_UNSPECIFIED - - WORKER_IP_PUBLIC - - WORKER_IP_PRIVATE - description: Configuration for VM IPs. + Set FlexRS goal for the job. + https://cloud.google.com/dataflow/docs/guides/flexrs type: string enumDescriptions: - - The configuration is unknown, or unspecified. - - Workers should have public IP addresses. - - Workers should have private IP addresses. - additionalExperiments: + - Run in the default mode. + - Optimize for lower execution time. + - Optimize for lower cost. + enum: + - FLEXRS_UNSPECIFIED + - FLEXRS_SPEED_OPTIMIZED + - FLEXRS_COST_OPTIMIZED + GoogleCloudDatapipelinesV1ScheduleSpec: + id: GoogleCloudDatapipelinesV1ScheduleSpec + description: Details of the schedule the pipeline runs on. + type: object + properties: + schedule: + description: >- + Unix-cron format of the schedule. This information is retrieved from + the linked Cloud Scheduler. + type: string + timeZone: + description: >- + Timezone ID. This matches the timezone IDs used by the Cloud + Scheduler API. If empty, UTC time is assumed. + type: string + nextJobTime: + description: Output only. When the next Scheduler job is going to run. + readOnly: true + type: string + format: google-datetime + GoogleProtobufEmpty: + id: GoogleProtobufEmpty + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + type: object + properties: {} + GoogleCloudDatapipelinesV1ListPipelinesResponse: + id: GoogleCloudDatapipelinesV1ListPipelinesResponse + description: Response message for ListPipelines. + type: object + properties: + pipelines: + description: >- + Results that matched the filter criteria and were accessible to the + caller. Results are always in descending order of pipeline creation + date. type: array - description: Additional experiment flags for the job. items: - type: string - zone: - type: string + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Pipeline' + nextPageToken: description: >- - The Compute Engine [availability - zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones) - for launching worker instances to run your pipeline. In the future, - worker_zone will take precedence. - enableStreamingEngine: - description: Whether to enable Streaming Engine for the job. - type: boolean - numWorkers: - type: integer - format: int32 - description: The initial number of Compute Engine instances for the job. - flexrsGoal: + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + GoogleCloudDatapipelinesV1StopPipelineRequest: + id: GoogleCloudDatapipelinesV1StopPipelineRequest + description: Request message for StopPipeline. + type: object + properties: {} + GoogleCloudDatapipelinesV1RunPipelineRequest: + id: GoogleCloudDatapipelinesV1RunPipelineRequest + description: Request message for RunPipeline + type: object + properties: {} + GoogleCloudDatapipelinesV1RunPipelineResponse: + id: GoogleCloudDatapipelinesV1RunPipelineResponse + description: Response message for RunPipeline + type: object + properties: + job: + description: Job that was created as part of RunPipeline operation. + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Job' + GoogleCloudDatapipelinesV1Job: + id: GoogleCloudDatapipelinesV1Job + description: >- + Definition of the job information maintained by the pipeline. Fields in + this entity are retrieved from the executor API (e.g. Dataflow API). + type: object + properties: + name: + description: Required. The fully qualified resource name for the job. + type: string + id: + description: Output only. The internal ID for the job. + readOnly: true + type: string + createTime: + description: Output only. The time of job creation. + readOnly: true + type: string + format: google-datetime + endTime: description: >- - Set FlexRS goal for the job. - https://cloud.google.com/dataflow/docs/guides/flexrs + Output only. The time of job termination. This is absent if the job + is still running. + readOnly: true + type: string + format: google-datetime + state: + description: The current state of the job. type: string enumDescriptions: - - Run in the default mode. - - Optimize for lower execution time. - - Optimize for lower cost. + - The job state isn't specified. + - The job is waiting to start execution. + - The job is executing. + - The job has finished execution successfully. + - The job has finished execution with a failure. + - The job has been terminated upon user request. enum: - - FLEXRS_UNSPECIFIED - - FLEXRS_SPEED_OPTIMIZED - - FLEXRS_COST_OPTIMIZED - machineType: - description: >- - The machine type to use for the job. Defaults to the value from the - template if not specified. - type: string - kmsKeyName: + - STATE_UNSPECIFIED + - STATE_PENDING + - STATE_RUNNING + - STATE_DONE + - STATE_FAILED + - STATE_CANCELLED + status: description: >- - Name for the Cloud KMS key for the job. Key format is: - projects//locations//keyRings//cryptoKeys/ - type: string - workerZone: + Status capturing any error code or message related to job creation + or execution. + $ref: '#/components/schemas/GoogleRpcStatus' + dataflowJobDetails: + description: All the details that are specific to a Dataflow job. + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1DataflowJobDetails' + GoogleRpcStatus: + id: GoogleRpcStatus + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + type: object + properties: + code: + description: The status code, which should be an enum value of google.rpc.Code. + type: integer + format: int32 + message: description: >- - The Compute Engine zone - (https://cloud.google.com/compute/docs/regions-zones/regions-zones) - in which worker processing should occur, e.g. "us-west1-a". Mutually - exclusive with worker_region. If neither worker_region nor - worker_zone is specified, a zone in the control plane region is - chosen based on available capacity. If both `worker_zone` and `zone` - are set, `worker_zone` takes precedence. - type: string - subnetwork: + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. type: string + details: description: >- - Subnetwork to which VMs will be assigned, if desired. You can - specify a subnetwork using either a complete URL or an abbreviated - path. Expected to be of the form - "https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNETWORK" - or "regions/REGION/subnetworks/SUBNETWORK". If the subnetwork is - located in a Shared VPC network, you must use the complete URL. - additionalUserLabels: - additionalProperties: - type: string - type: object + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + type: array + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + GoogleCloudDatapipelinesV1DataflowJobDetails: + id: GoogleCloudDatapipelinesV1DataflowJobDetails + description: >- + Pipeline job details specific to the Dataflow API. This is encapsulated + here to allow for more executors to store their specific details + separately. + type: object + properties: + sdkVersion: + description: Output only. The SDK version used to run the job. + readOnly: true + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1SdkVersion' + currentWorkers: description: >- - Additional user labels to be specified for the job. Keys and values - must follow the restrictions specified in the [labeling - restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions). - An object containing a list of key/value pairs. Example: `{ "name": - "wrench", "mass": "1kg", "count": "3" }`. - tempLocation: - type: string + Output only. The current number of workers used to run the jobs. + Only set to a value if the job is still running. + readOnly: true + type: integer + format: int32 + resourceInfo: description: >- - The Cloud Storage path to use for temporary files. Must be a valid - Cloud Storage URL, beginning with `gs://`. - id: GoogleCloudDatapipelinesV1FlexTemplateRuntimeEnvironment + Cached version of all the metrics of interest for the job. This + value gets stored here when the job is terminated. As long as the + job is running, this field is populated from the Dataflow API. + type: object + additionalProperties: + type: number + format: double GoogleCloudDatapipelinesV1SdkVersion: + id: GoogleCloudDatapipelinesV1SdkVersion description: The version of the SDK used to run the job. + type: object properties: + version: + description: The version of the SDK used to run the job. + type: string + versionDisplayName: + description: A readable string describing the version of the SDK. + type: string sdkSupportStatus: + description: The support status for this SDK version. type: string enumDescriptions: - Dataflow is unaware of this version. @@ -691,83 +731,34 @@ components: - >- Support for this SDK version has ended and it should no longer be used. - description: The support status for this SDK version. enum: - UNKNOWN - SUPPORTED - STALE - DEPRECATED - UNSUPPORTED - version: - description: The version of the SDK used to run the job. - type: string - versionDisplayName: - description: A readable string describing the version of the SDK. - type: string - id: GoogleCloudDatapipelinesV1SdkVersion - type: object - GoogleCloudDatapipelinesV1StopPipelineRequest: - properties: {} - description: Request message for StopPipeline. - type: object - id: GoogleCloudDatapipelinesV1StopPipelineRequest - GoogleCloudDatapipelinesV1RunPipelineRequest: - id: GoogleCloudDatapipelinesV1RunPipelineRequest + GoogleCloudDatapipelinesV1ListJobsResponse: + id: GoogleCloudDatapipelinesV1ListJobsResponse + description: Response message for ListJobs type: object - properties: {} - description: Request message for RunPipeline - GoogleCloudDatapipelinesV1ScheduleSpec: properties: - schedule: - type: string - description: >- - Unix-cron format of the schedule. This information is retrieved from - the linked Cloud Scheduler. - nextJobTime: - format: google-datetime - readOnly: true - description: Output only. When the next Scheduler job is going to run. - type: string - timeZone: + jobs: description: >- - Timezone ID. This matches the timezone IDs used by the Cloud - Scheduler API. If empty, UTC time is assumed. - type: string - type: object - id: GoogleCloudDatapipelinesV1ScheduleSpec - description: Details of the schedule the pipeline runs on. - GoogleCloudDatapipelinesV1ListPipelinesResponse: - id: GoogleCloudDatapipelinesV1ListPipelinesResponse - type: object - properties: - pipelines: + Results that were accessible to the caller. Results are always in + descending order of job creation date. type: array items: - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Pipeline' - description: >- - Results that matched the filter criteria and were accessible to the - caller. Results are always in descending order of pipeline creation - date. + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Job' nextPageToken: - type: string description: >- A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. - description: Response message for ListPipelines. + type: string parameters: - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string - 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. + access_token: + description: OAuth access token. in: query - name: quotaUser + name: access_token schema: type: string alt: @@ -780,24 +771,18 @@ components: - json - media - proto - fields: - description: Selector specifying which fields to include in a partial response. + callback: + description: JSONP in: query - name: fields + name: callback schema: type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: uploadType + name: fields schema: type: string - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean key: description: >- API key. Your API key identifies your project and provides you with API @@ -813,16 +798,31 @@ components: name: oauth_token schema: type: string - access_token: - description: OAuth access token. + prettyPrint: + description: Returns response with indentations and line breaks. in: query - name: access_token + 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 - callback: - description: JSONP + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: callback + name: uploadType schema: type: string _.xgafv: @@ -835,35 +835,15 @@ components: - '1' - '2' x-stackQL-resources: - jobs: - id: google.datapipelines.jobs - name: jobs - title: Jobs - methods: - list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines~1{pipelinesId}~1jobs/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.jobs - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/jobs/methods/list' - insert: [] - update: [] - replace: [] - delete: [] pipelines: id: google.datapipelines.pipelines name: pipelines title: Pipelines methods: - stop: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines~1{pipelinesId}:stop/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines/post response: mediaType: application/json openAPIDocKey: '200' @@ -875,10 +855,10 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.pipelines - create: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines~1{pipelinesId}/patch response: mediaType: application/json openAPIDocKey: '200' @@ -889,17 +869,17 @@ components: response: mediaType: application/json openAPIDocKey: '200' - patch: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines~1{pipelinesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines~1{pipelinesId}/get response: mediaType: application/json openAPIDocKey: '200' - get: + stop: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines~1{pipelinesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines~1{pipelinesId}:stop/post response: mediaType: application/json openAPIDocKey: '200' @@ -921,77 +901,52 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/pipelines/methods/delete' + jobs: + id: google.datapipelines.jobs + name: jobs + title: Jobs + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines~1{pipelinesId}~1jobs/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.jobs + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/jobs/methods/list' + insert: [] + update: [] + replace: [] + delete: [] paths: - /v1/projects/{projectsId}/locations/{locationsId}/pipelines/{pipelinesId}/jobs: + /v1/projects/{projectsId}/locations/{locationsId}/pipelines: parameters: &ref_1 - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/_.xgafv' - get: - description: >- - Lists jobs for a given pipeline. Throws a "FORBIDDEN" error if the - caller doesn't have permission to access it. - operationId: datapipelines.projects.locations.pipelines.jobs.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDatapipelinesV1ListJobsResponse - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: pipelinesId - required: true - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/pipelines/{pipelinesId}:stop: - parameters: *ref_1 post: description: >- - Freezes pipeline execution permanently. If there's a corresponding - scheduler entry, it's deleted, and the pipeline state is changed to - "ARCHIVED". However, pipeline metadata is retained. - operationId: datapipelines.projects.locations.pipelines.stop + Creates a pipeline. For a batch pipeline, you can pass scheduler + information. Data Pipelines uses the scheduler information to create an + internal scheduler that runs jobs periodically. If the internal + scheduler is not configured, you can use RunPipeline to run jobs. + operationId: datapipelines.projects.locations.pipelines.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDatapipelinesV1StopPipelineRequest + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Pipeline' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1015,13 +970,6 @@ paths: required: true schema: type: string - - in: path - name: pipelinesId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/pipelines: - parameters: *ref_1 get: description: >- Lists pipelines. Returns a "FORBIDDEN" error if the caller doesn't have @@ -1055,22 +1003,24 @@ paths: name: filter schema: type: string - - in: query - name: pageToken - schema: - type: string - in: query name: pageSize schema: type: integer format: int32 - post: + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/pipelines/{pipelinesId}: + parameters: *ref_1 + patch: description: >- - Creates a pipeline. For a batch pipeline, you can pass scheduler - information. Data Pipelines uses the scheduler information to create an - internal scheduler that runs jobs periodically. If the internal - scheduler is not configured, you can use RunPipeline to run jobs. - operationId: datapipelines.projects.locations.pipelines.create + Updates a pipeline. If successful, the updated Pipeline is returned. + Returns `NOT_FOUND` if the pipeline doesn't exist. If UpdatePipeline + does not return successfully, you can retry the UpdatePipeline request + until you receive a successful response. + operationId: datapipelines.projects.locations.pipelines.patch requestBody: content: application/json: @@ -1099,8 +1049,16 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/pipelines/{pipelinesId}: - parameters: *ref_1 + - in: path + name: pipelinesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask delete: description: >- Deletes a pipeline. If a scheduler job is attached to the pipeline, it @@ -1134,18 +1092,12 @@ paths: required: true schema: type: string - patch: + get: description: >- - Updates a pipeline. If successful, the updated Pipeline is returned. - Returns `NOT_FOUND` if the pipeline doesn't exist. If UpdatePipeline - does not return successfully, you can retry the UpdatePipeline request - until you receive a successful response. - operationId: datapipelines.projects.locations.pipelines.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Pipeline' + Looks up a single pipeline. Returns a "NOT_FOUND" error if no such + pipeline exists. Returns a "FORBIDDEN" error if the caller doesn't have + permission to access it. + operationId: datapipelines.projects.locations.pipelines.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1174,17 +1126,20 @@ paths: required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - get: + /v1/projects/{projectsId}/locations/{locationsId}/pipelines/{pipelinesId}:stop: + parameters: *ref_1 + post: description: >- - Looks up a single pipeline. Returns a "NOT_FOUND" error if no such - pipeline exists. Returns a "FORBIDDEN" error if the caller doesn't have - permission to access it. - operationId: datapipelines.projects.locations.pipelines.get + Freezes pipeline execution permanently. If there's a corresponding + scheduler entry, it's deleted, and the pipeline state is changed to + "ARCHIVED". However, pipeline metadata is retained. + operationId: datapipelines.projects.locations.pipelines.stop + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDatapipelinesV1StopPipelineRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1259,3 +1214,48 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/pipelines/{pipelinesId}/jobs: + parameters: *ref_1 + get: + description: >- + Lists jobs for a given pipeline. Throws a "FORBIDDEN" error if the + caller doesn't have permission to access it. + operationId: datapipelines.projects.locations.pipelines.jobs.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDatapipelinesV1ListJobsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: pipelinesId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/dataplex.yaml b/providers/src/googleapis.com/v00.00.00000/services/dataplex.yaml index dfb078d2..b139f0e9 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/dataplex.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/dataplex.yaml @@ -5,10 +5,10 @@ info: url: https://github.com/stackql/google-discovery-to-openapi email: info@stackql.io title: Cloud Dataplex API - description: Dataplex API is used to manage the lifecycle of data lakes. + description: A unified, intelligent governance solution for data and AI assets. version: v1 - x-discovery-doc-revision: '20241027' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250820' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/dataplex/docs servers: @@ -228,8 +228,9 @@ components: alternateUsePermission: description: >- Immutable. The IAM permission grantable on the Entry Group to allow - access to instantiate Entries of Dataplex owned Entry Types, only - settable for Dataplex owned Types. + access to instantiate Entries of Dataplex Universal Catalog owned + Entry Types, only settable for Dataplex Universal Catalog owned + Types. type: string GoogleCloudDataplexV1ListEntryTypesResponse: id: GoogleCloudDataplexV1ListEntryTypesResponse @@ -328,14 +329,15 @@ components: - TRANSFER_STATUS_TRANSFERRED GoogleCloudDataplexV1AspectTypeAuthorization: id: GoogleCloudDataplexV1AspectTypeAuthorization - description: Autorization for an AspectType. + description: Authorization for an AspectType. type: object properties: alternateUsePermission: description: >- Immutable. The IAM permission grantable on the EntryGroup to allow - access to instantiate Aspects of Dataplex owned AspectTypes, only - settable for Dataplex owned Types. + access to instantiate Aspects of Dataplex Universal Catalog owned + AspectTypes, only settable for Dataplex Universal Catalog owned + Types. type: string GoogleCloudDataplexV1AspectTypeMetadataTemplate: id: GoogleCloudDataplexV1AspectTypeMetadataTemplate @@ -359,10 +361,10 @@ components: type: description: >- Required. The datatype of this field. The following values are - supported:Primitive types: string integer boolean double datetime. - Must be of the format RFC3339 UTC "Zulu" (Examples: - "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z").Complex - types: enum array map record + supported:Primitive types: string int bool double datetime. Must be + of the format RFC3339 UTC "Zulu" (Examples: "2014-10-02T15:01:23Z" + and "2014-10-02T15:01:23.045123456Z").Complex types: enum array map + record type: string recordFields: description: >- @@ -607,12 +609,16 @@ components: projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}. type: string createTime: - description: Output only. The time when the entry was created in Dataplex. + description: >- + Output only. The time when the entry was created in Dataplex + Universal Catalog. readOnly: true type: string format: google-datetime updateTime: - description: Output only. The time when the entry was last updated in Dataplex. + description: >- + Output only. The time when the entry was last updated in Dataplex + Universal Catalog. readOnly: true type: string format: google-datetime @@ -628,7 +634,10 @@ components: additionalProperties: $ref: '#/components/schemas/GoogleCloudDataplexV1Aspect' parentEntry: - description: Optional. Immutable. The resource name of the parent entry. + description: >- + Optional. Immutable. The resource name of the parent entry, in the + format + projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. type: string fullyQualifiedName: description: >- @@ -886,23 +895,39 @@ components: enumDescriptions: - Unspecified. - Import job. + - Export job. enum: - TYPE_UNSPECIFIED - IMPORT + - EXPORT importSpec: description: Import job specification. $ref: '#/components/schemas/GoogleCloudDataplexV1MetadataJobImportJobSpec' + exportSpec: + description: Export job specification. + $ref: '#/components/schemas/GoogleCloudDataplexV1MetadataJobExportJobSpec' importResult: description: Output only. Import job result. readOnly: true $ref: '#/components/schemas/GoogleCloudDataplexV1MetadataJobImportJobResult' + exportResult: + description: Output only. Export job result. + readOnly: true + $ref: '#/components/schemas/GoogleCloudDataplexV1MetadataJobExportJobResult' status: description: Output only. Metadata job status. readOnly: true $ref: '#/components/schemas/GoogleCloudDataplexV1MetadataJobStatus' GoogleCloudDataplexV1MetadataJobImportJobSpec: id: GoogleCloudDataplexV1MetadataJobImportJobSpec - description: Job specification for a metadata import job + description: >- + Job specification for a metadata import job.You can run the following + kinds of metadata import jobs: Full sync of entries with incremental + import of their aspects. Supported for custom entries. Incremental + import of aspects only. Supported for aspects that belong to custom + entries and system entries. For custom entries, you can modify both + optional aspects and required aspects. For system entries, you can + modify optional aspects. type: object properties: sourceStorageUri: @@ -910,9 +935,9 @@ components: Optional. The URI of a Cloud Storage bucket or folder (beginning with gs:// and ending with /) that contains the metadata import files for this job.A metadata import file defines the values to set - for each of the entries and aspects in a metadata job. For more - information about how to create a metadata import file and the file - requirements, see Metadata import file + for each of the entries and aspects in a metadata import job. For + more information about how to create a metadata import file and the + file requirements, see Metadata import file (https://cloud.google.com/dataplex/docs/import-metadata#metadata-import-file).You can provide multiple metadata import files in the same metadata job. The bucket or folder must contain at least one metadata import file, @@ -935,53 +960,57 @@ components: $ref: >- #/components/schemas/GoogleCloudDataplexV1MetadataJobImportJobSpecImportJobScope entrySyncMode: - description: >- - Required. The sync mode for entries. Only FULL mode is supported for - entries. All entries in the job's scope are modified. If an entry - exists in Dataplex but isn't included in the metadata import file, - the entry is deleted when you run the metadata job. + description: Required. The sync mode for entries. type: string enumDescriptions: - Sync mode unspecified. - >- All resources in the job's scope are modified. If a resource - exists in Dataplex but isn't included in the metadata import file, - the resource is deleted when you run the metadata job. Use this - mode to perform a full sync of the set of entries in the job - scope. + exists in Dataplex Universal Catalog but isn't included in the + metadata import file, the resource is deleted when you run the + metadata job. Use this mode to perform a full sync of the set of + entries in the job scope.This sync mode is supported for entries. - >- - Only the entries and aspects that are explicitly included in the - metadata import file are modified. Use this mode to modify a - subset of resources while leaving unreferenced resources - unchanged. + Only the resources that are explicitly included in the metadata + import file are modified. Use this mode to modify a subset of + resources while leaving unreferenced resources unchanged.This sync + mode is supported for aspects. + - >- + If entry sync mode is NONE, then aspects are modified according to + the aspect sync mode. Other metadata that belongs to entries in + the job's scope isn't modified.This sync mode is supported for + entries. enum: - SYNC_MODE_UNSPECIFIED - FULL - INCREMENTAL + - NONE aspectSyncMode: - description: >- - Required. The sync mode for aspects. Only INCREMENTAL mode is - supported for aspects. An aspect is modified only if the metadata - import file includes a reference to the aspect in the update_mask - field and the aspect_keys field. + description: Required. The sync mode for aspects. type: string enumDescriptions: - Sync mode unspecified. - >- All resources in the job's scope are modified. If a resource - exists in Dataplex but isn't included in the metadata import file, - the resource is deleted when you run the metadata job. Use this - mode to perform a full sync of the set of entries in the job - scope. + exists in Dataplex Universal Catalog but isn't included in the + metadata import file, the resource is deleted when you run the + metadata job. Use this mode to perform a full sync of the set of + entries in the job scope.This sync mode is supported for entries. + - >- + Only the resources that are explicitly included in the metadata + import file are modified. Use this mode to modify a subset of + resources while leaving unreferenced resources unchanged.This sync + mode is supported for aspects. - >- - Only the entries and aspects that are explicitly included in the - metadata import file are modified. Use this mode to modify a - subset of resources while leaving unreferenced resources - unchanged. + If entry sync mode is NONE, then aspects are modified according to + the aspect sync mode. Other metadata that belongs to entries in + the job's scope isn't modified.This sync mode is supported for + entries. enum: - SYNC_MODE_UNSPECIFIED - FULL - INCREMENTAL + - NONE logLevel: description: >- Optional. The level of logs to write to Cloud Logging for this @@ -1020,9 +1049,9 @@ components: Required. The entry group that is in scope for the import job, specified as a relative resource name in the format projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id}. - Only entries that belong to the specified entry group are affected - by the job.Must contain exactly one element. The entry group and the - job must be in the same location. + Only entries and aspects that belong to the specified entry group + are affected by the job.Must contain exactly one element. The entry + group and the job must be in the same location. type: array items: type: string @@ -1031,12 +1060,12 @@ components: Required. The entry types that are in scope for the import job, specified as relative resource names in the format projects/{project_number_or_id}/locations/{location_id}/entryTypes/{entry_type_id}. - The job modifies only the entries that belong to these entry - types.If the metadata import file attempts to modify an entry whose - type isn't included in this list, the import job is halted before - modifying any entries or aspects.The location of an entry type must - either match the location of the job, or the entry type must be - global. + The job modifies only the entries and aspects that belong to these + entry types.If the metadata import file attempts to modify an entry + whose type isn't included in this list, the import job is halted + before modifying any entries or aspects.The location of an entry + type must either match the location of the job, or the entry type + must be global. type: array items: type: string @@ -1046,7 +1075,8 @@ components: specified as relative resource names in the format projects/{project_number_or_id}/locations/{location_id}/aspectTypes/{aspect_type_id}. The job modifies only the aspects that belong to these aspect - types.If the metadata import file attempts to modify an aspect whose + types.This field is required when creating an aspect-only import + job.If the metadata import file attempts to modify an aspect whose type isn't included in this list, the import job is halted before modifying any entries or aspects.The location of an aspect type must either match the location of the job, or the aspect type must be @@ -1054,6 +1084,122 @@ components: type: array items: type: string + glossaries: + description: >- + Optional. The glossaries that are in scope for the import job, + specified as relative resource names in the format + projects/{project_number_or_id}/locations/{location_id}/glossaries/{glossary_id}.While + importing Business Glossary entries, the user must provide + glossaries. While importing entries, the user does not have to + provide glossaries. If the metadata import file attempts to modify + Business Glossary entries whose glossary isn't included in this + list, the import job will skip those entries.The location of a + glossary must either match the location of the job, or the glossary + must be global. + type: array + items: + type: string + entryLinkTypes: + description: >- + Optional. The entry link types that are in scope for the import job, + specified as relative resource names in the format + projects/{project_number_or_id}/locations/{location_id}/entryLinkTypes/{entry_link_type_id}. + The job modifies only the entryLinks that belong to these entry link + types.If the metadata import file attempts to create or delete an + entry link whose entry link type isn't included in this list, the + import job will skip those entry links. + type: array + items: + type: string + referencedEntryScopes: + description: >- + Optional. Defines the scope of entries that can be referenced in the + entry links.Currently, projects are supported as valid scopes. + Format: projects/{project_number_or_id}If the metadata import file + attempts to create an entry link which references an entry that is + not in the scope, the import job will skip that entry link. + type: array + items: + type: string + GoogleCloudDataplexV1MetadataJobExportJobSpec: + id: GoogleCloudDataplexV1MetadataJobExportJobSpec + description: Job specification for a metadata export job. + type: object + properties: + scope: + description: Required. The scope of the export job. + $ref: >- + #/components/schemas/GoogleCloudDataplexV1MetadataJobExportJobSpecExportJobScope + outputPath: + description: >- + Required. The root path of the Cloud Storage bucket to export the + metadata to, in the format gs://{bucket}/. You can optionally + specify a custom prefix after the bucket name, in the format + gs://{bucket}/{prefix}/. The maximum length of the custom prefix is + 128 characters. Dataplex Universal Catalog constructs the object + path for the exported files by using the bucket name and prefix that + you provide, followed by a system-generated path.The bucket must be + in the same VPC Service Controls perimeter as the job. + type: string + GoogleCloudDataplexV1MetadataJobExportJobSpecExportJobScope: + id: GoogleCloudDataplexV1MetadataJobExportJobSpecExportJobScope + description: The scope of the export job. + type: object + properties: + organizationLevel: + description: >- + Whether the metadata export job is an organization-level export job. + If true, the job exports the entries from the same organization and + VPC Service Controls perimeter as the job. The project that the job + belongs to determines the VPC Service Controls perimeter. If you set + the job scope to be at the organization level, then don't provide a + list of projects or entry groups. If false, you must specify a list + of projects or a list of entry groups whose entries you want to + export.The default is false. + type: boolean + projects: + description: >- + The projects whose metadata you want to export, in the format + projects/{project_id_or_number}. Only the entries from the specified + projects are exported.The projects must be in the same organization + and VPC Service Controls perimeter as the job.If you set the job + scope to be a list of projects, then set the organization-level + export flag to false and don't provide a list of entry groups. + type: array + items: + type: string + entryGroups: + description: >- + The entry groups whose metadata you want to export, in the format + projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}. + Only the entries in the specified entry groups are exported.The + entry groups must be in the same location and the same VPC Service + Controls perimeter as the job.If you set the job scope to be a list + of entry groups, then set the organization-level export flag to + false and don't provide a list of projects. + type: array + items: + type: string + entryTypes: + description: >- + The entry types that are in scope for the export job, specified as + relative resource names in the format + projects/{project_id_or_number}/locations/{location}/entryTypes/{entry_type_id}. + Only entries that belong to the specified entry types are affected + by the job. + type: array + items: + type: string + aspectTypes: + description: >- + The aspect types that are in scope for the export job, specified as + relative resource names in the format + projects/{project_id_or_number}/locations/{location}/aspectTypes/{aspect_type_id}. + Only aspects that belong to the specified aspect types are affected + by the job. + type: array + items: + type: string GoogleCloudDataplexV1MetadataJobImportJobResult: id: GoogleCloudDataplexV1MetadataJobImportJobResult description: Results from a metadata import job. @@ -1089,6 +1235,44 @@ components: readOnly: true type: string format: google-datetime + deletedEntryLinks: + description: >- + Output only. The total number of entry links that were successfully + deleted. + readOnly: true + type: string + format: int64 + createdEntryLinks: + description: >- + Output only. The total number of entry links that were successfully + created. + readOnly: true + type: string + format: int64 + unchangedEntryLinks: + description: >- + Output only. The total number of entry links that were left + unchanged. + readOnly: true + type: string + format: int64 + GoogleCloudDataplexV1MetadataJobExportJobResult: + id: GoogleCloudDataplexV1MetadataJobExportJobResult + description: >- + Summary results from a metadata export job. The results are a snapshot + of the metadata at the time when the job was created. The exported + entries are saved to a Cloud Storage bucket. + type: object + properties: + exportedEntries: + description: Output only. The number of entries that were exported. + readOnly: true + type: string + format: int64 + errorMessage: + description: Output only. The error message if the metadata export job failed. + readOnly: true + type: string GoogleCloudDataplexV1MetadataJobStatus: id: GoogleCloudDataplexV1MetadataJobStatus description: Metadata job status. @@ -1155,496 +1339,409 @@ components: description: Cancel metadata job request. type: object properties: {} - GoogleIamV1SetIamPolicyRequest: - id: GoogleIamV1SetIamPolicyRequest - description: Request message for SetIamPolicy method. + GoogleCloudDataplexV1EntryLink: + id: GoogleCloudDataplexV1EntryLink + description: EntryLink represents a link between two Entries. type: object properties: - policy: + name: description: >- - REQUIRED: The complete policy to be applied to the resource. The - size of the policy is limited to a few 10s of KB. An empty policy is - a valid policy but certain Google Cloud services (such as Projects) - might reject them. - $ref: '#/components/schemas/GoogleIamV1Policy' - updateMask: + Output only. Immutable. Identifier. The relative resource name of + the Entry Link, of the form: + projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id} + readOnly: true + type: string + entryLinkType: description: >- - OPTIONAL: A FieldMask specifying which fields of the policy to - modify. Only the fields in the mask will be modified. If no mask is - provided, the following default mask is used:paths: "bindings, etag" + Required. Immutable. Relative resource name of the Entry Link Type + used to create this Entry Link. For example: Entry link between + synonym terms in a glossary: + projects/dataplex-types/locations/global/entryLinkTypes/synonym + Entry link between related terms in a glossary: + projects/dataplex-types/locations/global/entryLinkTypes/related + Entry link between glossary terms and data assets: + projects/dataplex-types/locations/global/entryLinkTypes/definition type: string - format: google-fieldmask - GoogleIamV1Policy: - id: GoogleIamV1Policy + createTime: + description: Output only. The time when the Entry Link was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. The time when the Entry Link was last updated. + readOnly: true + type: string + format: google-datetime + entryReferences: + description: >- + Required. Specifies the Entries referenced in the Entry Link. There + should be exactly two entry references. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDataplexV1EntryLinkEntryReference' + GoogleCloudDataplexV1EntryLinkEntryReference: + id: GoogleCloudDataplexV1EntryLinkEntryReference + description: Reference to the Entry that is linked through the Entry Link. + type: object + properties: + name: + description: >- + Required. Immutable. The relative resource name of the referenced + Entry, of the form: + projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + type: string + path: + description: >- + Immutable. The path in the Entry that is referenced in the Entry + Link. Empty path denotes that the Entry itself is referenced in the + Entry Link. + type: string + type: + description: Required. Immutable. The reference type of the Entry. + type: string + enumDescriptions: + - >- + Unspecified reference type. Implies that the Entry is referenced + in a non-directional Entry Link. + - >- + The Entry is referenced as the source of the directional Entry + Link. + - >- + The Entry is referenced as the target of the directional Entry + Link. + enum: + - UNSPECIFIED + - SOURCE + - TARGET + GoogleCloudDataplexV1Glossary: + id: GoogleCloudDataplexV1Glossary description: >- - An Identity and Access Management (IAM) policy, which specifies access - controls for Google Cloud resources.A Policy is a collection of - bindings. A binding binds one or more members, or principals, to a - single role. Principals can be user accounts, service accounts, Google - groups, and domains (such as G Suite). A role is a named list of - permissions; each role can be an IAM predefined role or a user-created - custom role.For some types of Google Cloud resources, a binding can also - specify a condition, which is a logical expression that allows access to - a resource only if the expression evaluates to true. A condition can add - constraints based on attributes of the request, the resource, or both. - To learn which resources support conditions in their IAM policies, see - the IAM documentation - (https://cloud.google.com/iam/help/conditions/resource-policies).JSON - example: { "bindings": [ { "role": - "roles/resourcemanager.organizationAdmin", "members": [ - "user:mike@example.com", "group:admins@example.com", - "domain:google.com", - "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { - "role": "roles/resourcemanager.organizationViewer", "members": [ - "user:eve@example.com" ], "condition": { "title": "expirable access", - "description": "Does not grant access after Sep 2020", "expression": - "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": - "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - - user:mike@example.com - group:admins@example.com - domain:google.com - - serviceAccount:my-project-id@appspot.gserviceaccount.com role: - roles/resourcemanager.organizationAdmin - members: - - user:eve@example.com role: roles/resourcemanager.organizationViewer - condition: title: expirable access description: Does not grant access - after Sep 2020 expression: request.time < - timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For - a description of IAM and its features, see the IAM documentation - (https://cloud.google.com/iam/docs/). + A Glossary represents a collection of GlossaryCategories and + GlossaryTerms defined by the user. Glossary is a top level resource and + is the Google Cloud parent resource of all the GlossaryCategories and + GlossaryTerms within it. type: object properties: - version: + name: 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 conditionsImportant: 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). + Output only. Identifier. The resource name of the Glossary. Format: + projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} + readOnly: true + type: string + uid: + description: >- + Output only. System generated unique id for the Glossary. This ID + will be different if the Glossary is deleted and re-created with the + same name. + readOnly: true + type: string + displayName: + description: >- + Optional. User friendly display name of the Glossary. This is + user-mutable. This will be same as the GlossaryId, if not specified. + type: string + description: + description: Optional. The user-mutable description of the Glossary. + type: string + createTime: + description: Output only. The time at which the Glossary was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. The time at which the Glossary was last updated. + readOnly: true + type: string + format: google-datetime + labels: + description: Optional. User-defined labels for the Glossary. + type: object + additionalProperties: + type: string + termCount: + description: Output only. The number of GlossaryTerms in the Glossary. + readOnly: true type: integer format: int32 - bindings: + categoryCount: + description: Output only. The number of GlossaryCategories in the Glossary. + readOnly: true + type: integer + format: int32 + etag: description: >- - Associates a list of members, or principals, with a role. - Optionally, may specify a condition that determines how and when the - bindings are applied. Each of the bindings must contain at least one - principal.The bindings in a Policy can refer to up to 1,500 - principals; up to 250 of these principals can be Google groups. Each - occurrence of a principal counts towards these limits. For example, - if the bindings grant 50 different roles to user:alice@example.com, - and not to any other principal, then you can add another 1,450 - principals to the bindings in the Policy. - type: array - items: - $ref: '#/components/schemas/GoogleIamV1Binding' - auditConfigs: - description: Specifies cloud audit logging configuration for this policy. + Optional. Needed for resource freshness validation. This checksum is + computed by the server based on the value of other fields, and may + be sent on update and delete requests to ensure the client has an + up-to-date value before proceeding. + type: string + GoogleCloudDataplexV1ListGlossariesResponse: + id: GoogleCloudDataplexV1ListGlossariesResponse + description: List Glossaries Response + type: object + properties: + glossaries: + description: Lists the Glossaries in the specified parent. type: array items: - $ref: '#/components/schemas/GoogleIamV1AuditConfig' - etag: + $ref: '#/components/schemas/GoogleCloudDataplexV1Glossary' + nextPageToken: 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. + A token, which can be sent as page_token to retrieve the next page. + If this field is omitted, there are no subsequent pages. type: string - format: byte - GoogleIamV1Binding: - id: GoogleIamV1Binding - description: Associates members, or principals, with a role. + unreachableLocations: + description: Locations that the service couldn't reach. + type: array + items: + type: string + GoogleCloudDataplexV1GlossaryCategory: + id: GoogleCloudDataplexV1GlossaryCategory + description: >- + A GlossaryCategory represents a collection of GlossaryCategories and + GlossaryTerms within a Glossary that are related to each other. type: object properties: - role: + name: description: >- - Role that is assigned to the list of members, or principals. For - example, roles/viewer, roles/editor, or roles/owner.For an overview - of the IAM roles and permissions, see the IAM documentation - (https://cloud.google.com/iam/docs/roles-overview). For a list of - the available pre-defined roles, see here - (https://cloud.google.com/iam/docs/understanding-roles). + Output only. Identifier. The resource name of the GlossaryCategory. + Format: + projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id} + readOnly: true type: string - members: + uid: description: >- - Specifies the principals requesting access for a Google Cloud - 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. Does not include identities that come - from external identity providers (IdPs) through identity federation. - user:{emailid}: An email address that represents a specific Google - account. For example, alice@example.com . serviceAccount:{emailid}: - An email address that represents a Google service account. For - example, my-other-app@appspot.gserviceaccount.com. - serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: - An identifier for a Kubernetes service account - (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). - For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. - group:{emailid}: An email address that represents a Google group. - For example, admins@example.com. domain:{domain}: The G Suite domain - (primary) that represents all the users of that domain. For example, - google.com or example.com. - principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: - A single identity in a workforce identity pool. - principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}: - All workforce identities in a group. - principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}: - All workforce identities with a specific attribute value. - principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*: - All identities in a workforce identity pool. - principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}: - A single identity in a workload identity pool. - principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}: - A workload identity pool group. - principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}: - All identities in a workload identity pool with a certain attribute. - principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*: - All identities in a workload identity pool. - 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. - deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: - Deleted single identity in a workforce identity pool. For example, - deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value. - type: array - items: - type: string - condition: - description: >- - The condition that is associated with this binding.If the condition - evaluates to true, then this binding applies to the current - request.If the condition evaluates to false, then this binding does - not apply to the current request. However, a different role binding - might grant the same role to one or more of the principals in this - binding.To learn which resources support conditions in their IAM - policies, see the IAM documentation - (https://cloud.google.com/iam/help/conditions/resource-policies). - $ref: '#/components/schemas/GoogleTypeExpr' - GoogleTypeExpr: - id: GoogleTypeExpr - 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. - type: object - properties: - expression: - description: >- - Textual representation of an expression in Common Expression - Language syntax. + Output only. System generated unique id for the GlossaryCategory. + This ID will be different if the GlossaryCategory is deleted and + re-created with the same name. + readOnly: true type: string - title: + displayName: 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. + Optional. User friendly display name of the GlossaryCategory. This + is user-mutable. This will be same as the GlossaryCategoryId, if not + specified. type: string 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. + description: Optional. The user-mutable description of the GlossaryCategory. 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. + createTime: + description: Output only. The time at which the GlossaryCategory was created. + readOnly: true type: string - GoogleIamV1AuditConfig: - id: GoogleIamV1AuditConfig - 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. - type: object - properties: - service: + format: google-datetime + updateTime: 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 - auditLogConfigs: - description: The configuration for logging of each type of permission. - type: array - items: - $ref: '#/components/schemas/GoogleIamV1AuditLogConfig' - GoogleIamV1AuditLogConfig: - id: GoogleIamV1AuditLogConfig - 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. - type: object - properties: - logType: - description: The log type that this config enables. + Output only. The time at which the GlossaryCategory was last + updated. + readOnly: true type: string - enumDescriptions: - - Default case. Should never be this. - - 'Admin reads. Example: CloudIAM getIamPolicy' - - 'Data writes. Example: CloudSQL Users create' - - 'Data reads. Example: CloudSQL Users list' - enum: - - LOG_TYPE_UNSPECIFIED - - ADMIN_READ - - DATA_WRITE - - DATA_READ - exemptedMembers: - description: >- - Specifies the identities that do not cause logging for this type of - permission. Follows the same format of Binding.members. - type: array - items: + format: google-datetime + labels: + description: Optional. User-defined labels for the GlossaryCategory. + type: object + additionalProperties: type: string - GoogleIamV1TestIamPermissionsRequest: - id: GoogleIamV1TestIamPermissionsRequest - description: Request message for TestIamPermissions method. + parent: + description: >- + Required. The immediate parent of the GlossaryCategory in the + resource-hierarchy. It can either be a Glossary or a + GlossaryCategory. Format: + projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} + OR + projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id} + type: string + GoogleCloudDataplexV1ListGlossaryCategoriesResponse: + id: GoogleCloudDataplexV1ListGlossaryCategoriesResponse + description: List GlossaryCategories Response type: object properties: - permissions: - description: >- - The set of permissions to check for the resource. Permissions with - wildcards (such as * or storage.*) are not allowed. For more - information see IAM Overview - (https://cloud.google.com/iam/docs/overview#permissions). + categories: + description: Lists the GlossaryCategories in the specified parent. type: array items: - type: string - GoogleIamV1TestIamPermissionsResponse: - id: GoogleIamV1TestIamPermissionsResponse - description: Response message for TestIamPermissions method. - type: object - properties: - permissions: + $ref: '#/components/schemas/GoogleCloudDataplexV1GlossaryCategory' + nextPageToken: description: >- - A subset of TestPermissionsRequest.permissions that the caller is - allowed. + A token, which can be sent as page_token to retrieve the next page. + If this field is omitted, there are no subsequent pages. + type: string + unreachableLocations: + description: Locations that the service couldn't reach. type: array items: type: string - GoogleCloudDataplexV1Content: - id: GoogleCloudDataplexV1Content - description: Content represents a user-visible notebook or a sql script + GoogleCloudDataplexV1GlossaryTerm: + id: GoogleCloudDataplexV1GlossaryTerm + description: >- + GlossaryTerms are the core of Glossary. A GlossaryTerm holds a rich text + description that can be attached to Entries or specific columns to + enrich them. type: object properties: name: description: >- - Output only. The relative resource name of the content, of the form: - projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id} + Output only. Identifier. The resource name of the GlossaryTerm. + Format: + projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id} readOnly: true type: string uid: description: >- - Output only. System generated globally unique ID for the content. - This ID will be different if the content is deleted and re-created + Output only. System generated unique id for the GlossaryTerm. This + ID will be different if the GlossaryTerm is deleted and re-created with the same name. readOnly: true type: string - path: + displayName: description: >- - Required. The path for the Content file, represented as directory - structure. Unique within a lake. Limited to alphanumerics, hyphens, - underscores, dots and slashes. + Optional. User friendly display name of the GlossaryTerm. This is + user-mutable. This will be same as the GlossaryTermId, if not + specified. + type: string + description: + description: Optional. The user-mutable description of the GlossaryTerm. type: string createTime: - description: Output only. Content creation time. + description: Output only. The time at which the GlossaryTerm was created. readOnly: true type: string format: google-datetime updateTime: - description: Output only. The time when the content was last updated. + description: Output only. The time at which the GlossaryTerm was last updated. readOnly: true type: string format: google-datetime labels: - description: Optional. User defined labels for the content. + description: Optional. User-defined labels for the GlossaryTerm. type: object additionalProperties: type: string - description: - description: Optional. Description of the content. - type: string - dataText: - description: Required. Content data in string format. + parent: + description: >- + Required. The immediate parent of the GlossaryTerm in the + resource-hierarchy. It can either be a Glossary or a + GlossaryCategory. Format: + projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} + OR + projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id} type: string - sqlScript: - description: Sql Script related configurations. - $ref: '#/components/schemas/GoogleCloudDataplexV1ContentSqlScript' - notebook: - description: Notebook related configurations. - $ref: '#/components/schemas/GoogleCloudDataplexV1ContentNotebook' - GoogleCloudDataplexV1ContentSqlScript: - id: GoogleCloudDataplexV1ContentSqlScript - description: Configuration for the Sql Script content. + GoogleCloudDataplexV1ListGlossaryTermsResponse: + id: GoogleCloudDataplexV1ListGlossaryTermsResponse + description: List GlossaryTerms Response type: object properties: - engine: - description: Required. Query Engine to be used for the Sql Query. + terms: + description: Lists the GlossaryTerms in the specified parent. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDataplexV1GlossaryTerm' + nextPageToken: + description: >- + A token, which can be sent as page_token to retrieve the next page. + If this field is omitted, there are no subsequent pages. type: string - enumDescriptions: - - Value was unspecified. - - Spark SQL Query. - enum: - - QUERY_ENGINE_UNSPECIFIED - - SPARK - GoogleCloudDataplexV1ContentNotebook: - id: GoogleCloudDataplexV1ContentNotebook - description: Configuration for Notebook content. - type: object - properties: - kernelType: - description: Required. Kernel Type of the notebook. - type: string - enumDescriptions: - - Kernel Type unspecified. - - Python 3 Kernel. - enum: - - KERNEL_TYPE_UNSPECIFIED - - PYTHON3 - GoogleCloudDataplexV1ListContentResponse: - id: GoogleCloudDataplexV1ListContentResponse - description: List content response. - type: object - properties: - content: - description: Content under the given parent lake. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDataplexV1Content' - nextPageToken: - description: >- - Token to retrieve the next page of results, or empty if there are no - more results in the list. - type: string - GoogleCloudDataplexV1DataTaxonomy: - id: GoogleCloudDataplexV1DataTaxonomy - description: >- - DataTaxonomy represents a set of hierarchical DataAttributes resources, - grouped with a common theme Eg: 'SensitiveDataTaxonomy' can have - attributes to manage PII data. It is defined at project level. + unreachableLocations: + description: Locations that the service couldn't reach. + type: array + items: + type: string + GoogleCloudDataplexV1EncryptionConfig: + id: GoogleCloudDataplexV1EncryptionConfig + description: >- + A Resource designed to manage encryption configurations for customers to + support Customer Managed Encryption Keys (CMEK). type: object properties: name: description: >- - Output only. The relative resource name of the DataTaxonomy, of the - form: - projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}. - readOnly: true + Identifier. The resource name of the EncryptionConfig. Format: + organizations/{organization}/locations/{location}/encryptionConfigs/{encryption_config} + Global location is not supported. type: string - uid: + key: description: >- - Output only. System generated globally unique ID for the - dataTaxonomy. This ID will be different if the DataTaxonomy is - deleted and re-created with the same name. - readOnly: true + Optional. If a key is chosen, it means that the customer is using + CMEK. If a key is not chosen, it means that the customer is using + Google managed encryption. type: string createTime: - description: Output only. The time when the DataTaxonomy was created. + description: Output only. The time when the Encryption configuration was created. readOnly: true type: string format: google-datetime updateTime: - description: Output only. The time when the DataTaxonomy was last updated. + description: >- + Output only. The time when the Encryption configuration was last + updated. readOnly: true type: string format: google-datetime - description: - description: Optional. Description of the DataTaxonomy. - type: string - displayName: - description: Optional. User friendly display name. - type: string - labels: - description: Optional. User-defined labels for the DataTaxonomy. - type: object - additionalProperties: - type: string - attributeCount: - description: Output only. The number of attributes in the DataTaxonomy. + encryptionState: + description: Output only. The state of encryption of the databases. readOnly: true - type: integer - format: int32 + type: string + enumDescriptions: + - State is not specified. + - >- + The encryption state of the database when the EncryptionConfig is + created or updated. If the encryption fails, it is retried + indefinitely and the state is shown as ENCRYPTING. + - The encryption of data has completed successfully. + - >- + The encryption of data has failed. The state is set to FAILED when + the encryption fails due to reasons like permission issues, + invalid key etc. + enum: + - ENCRYPTION_STATE_UNSPECIFIED + - ENCRYPTING + - COMPLETED + - FAILED etag: + description: Etag of the EncryptionConfig. This is a strong etag. + type: string + failureDetails: description: >- - This checksum is computed by the server based on the value of other - fields, and may be sent on update and delete requests to ensure the - client has an up-to-date value before proceeding. + Output only. Details of the failure if anything related to Cmek db + fails. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudDataplexV1EncryptionConfigFailureDetails + GoogleCloudDataplexV1EncryptionConfigFailureDetails: + id: GoogleCloudDataplexV1EncryptionConfigFailureDetails + description: Details of the failure if anything related to Cmek db fails. + type: object + properties: + errorCode: + description: Output only. The error code for the failure. + readOnly: true type: string - classCount: - description: Output only. The number of classes in the DataTaxonomy. + enumDescriptions: + - The error code is not specified + - >- + Error because of internal server error, will be retried + automatically. + - User action is required to resolve the error. + enum: + - UNKNOWN + - INTERNAL_ERROR + - REQUIRE_USER_ACTION + errorMessage: + description: >- + Output only. The error message will be shown to the user. Set only + if the error code is REQUIRE_USER_ACTION. readOnly: true - type: integer - format: int32 - GoogleCloudDataplexV1ListDataTaxonomiesResponse: - id: GoogleCloudDataplexV1ListDataTaxonomiesResponse - description: List DataTaxonomies response. + type: string + GoogleCloudDataplexV1ListEncryptionConfigsResponse: + id: GoogleCloudDataplexV1ListEncryptionConfigsResponse + description: List EncryptionConfigs Response type: object properties: - dataTaxonomies: - description: DataTaxonomies under the given parent location. + encryptionConfigs: + description: The list of EncryptionConfigs under the given parent location. type: array items: - $ref: '#/components/schemas/GoogleCloudDataplexV1DataTaxonomy' + $ref: '#/components/schemas/GoogleCloudDataplexV1EncryptionConfig' nextPageToken: description: >- Token to retrieve the next page of results, or empty if there are no @@ -1655,2836 +1752,2933 @@ components: type: array items: type: string - GoogleCloudDataplexV1DataAttributeBinding: - id: GoogleCloudDataplexV1DataAttributeBinding - description: >- - DataAttributeBinding represents binding of attributes to resources. Eg: - Bind 'CustomerInfo' entity with 'PII' attribute. + GoogleIamV1SetIamPolicyRequest: + id: GoogleIamV1SetIamPolicyRequest + description: Request message for SetIamPolicy method. type: object properties: - name: - description: >- - Output only. The relative resource name of the Data Attribute - Binding, of the form: - projects/{project_number}/locations/{location}/dataAttributeBindings/{data_attribute_binding_id} - readOnly: true - type: string - uid: - description: >- - Output only. System generated globally unique ID for the - DataAttributeBinding. This ID will be different if the - DataAttributeBinding is deleted and re-created with the same name. - readOnly: true - type: string - createTime: - description: Output only. The time when the DataAttributeBinding was created. - readOnly: true - type: string - format: google-datetime - updateTime: - description: >- - Output only. The time when the DataAttributeBinding was last - updated. - readOnly: true - type: string - format: google-datetime - description: - description: Optional. Description of the DataAttributeBinding. - type: string - displayName: - description: Optional. User friendly display name. - type: string - labels: - description: Optional. User-defined labels for the DataAttributeBinding. - type: object - additionalProperties: - type: string - etag: + policy: description: >- - This checksum is computed by the server based on the value of other - fields, and may be sent on update and delete requests to ensure the - client has an up-to-date value before proceeding. Etags must be used - when calling the DeleteDataAttributeBinding and the - UpdateDataAttributeBinding method. - type: string - resource: + REQUIRED: The complete policy to be applied to the resource. The + size of the policy is limited to a few 10s of KB. An empty policy is + a valid policy but certain Google Cloud services (such as Projects) + might reject them. + $ref: '#/components/schemas/GoogleIamV1Policy' + updateMask: description: >- - Optional. Immutable. The resource name of the resource that is - associated to attributes. Presently, only entity resource is - supported in the form: - projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/entities/{entity_id} - Must belong in the same project and region as the attribute binding, - and there can only exist one active binding for a resource. + OPTIONAL: A FieldMask specifying which fields of the policy to + modify. Only the fields in the mask will be modified. If no mask is + provided, the following default mask is used:paths: "bindings, etag" type: string - attributes: - description: >- - Optional. List of attributes to be associated with the resource, - provided in the form: - projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id} - type: array - items: - type: string - paths: - description: >- - Optional. The list of paths for items within the associated resource - (eg. columns and partitions within a table) along with attribute - bindings. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDataplexV1DataAttributeBindingPath' - GoogleCloudDataplexV1DataAttributeBindingPath: - id: GoogleCloudDataplexV1DataAttributeBindingPath + format: google-fieldmask + GoogleIamV1Policy: + id: GoogleIamV1Policy description: >- - Represents a subresource of the given resource, and associated bindings - with it. Currently supported subresources are column and partition - schema fields within a table. + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources.A Policy is a collection of + bindings. A binding binds one or more members, or principals, to a + single role. Principals can be user accounts, service accounts, Google + groups, and domains (such as G Suite). A role is a named list of + permissions; each role can be an IAM predefined role or a user-created + custom role.For some types of Google Cloud resources, a binding can also + specify a condition, which is a logical expression that allows access to + a resource only if the expression evaluates to true. A condition can add + constraints based on attributes of the request, the resource, or both. + To learn which resources support conditions in their IAM policies, see + the IAM documentation + (https://cloud.google.com/iam/help/conditions/resource-policies).JSON + example: { "bindings": [ { "role": + "roles/resourcemanager.organizationAdmin", "members": [ + "user:mike@example.com", "group:admins@example.com", + "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { + "role": "roles/resourcemanager.organizationViewer", "members": [ + "user:eve@example.com" ], "condition": { "title": "expirable access", + "description": "Does not grant access after Sep 2020", "expression": + "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": + "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - + user:mike@example.com - group:admins@example.com - domain:google.com - + serviceAccount:my-project-id@appspot.gserviceaccount.com role: + roles/resourcemanager.organizationAdmin - members: - + user:eve@example.com role: roles/resourcemanager.organizationViewer + condition: title: expirable access description: Does not grant access + after Sep 2020 expression: request.time < + timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For + a description of IAM and its features, see the IAM documentation + (https://cloud.google.com/iam/docs/). type: object properties: - name: + version: description: >- - Required. The name identifier of the path. Nested columns should be - of the form: 'address.city'. - type: string - attributes: + 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 conditionsImportant: 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). + type: integer + format: int32 + bindings: description: >- - Optional. List of attributes to be associated with the path of the - resource, provided in the form: - projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id} + Associates a list of members, or principals, with a role. + Optionally, may specify a condition that determines how and when the + bindings are applied. Each of the bindings must contain at least one + principal.The bindings in a Policy can refer to up to 1,500 + principals; up to 250 of these principals can be Google groups. Each + occurrence of a principal counts towards these limits. For example, + if the bindings grant 50 different roles to user:alice@example.com, + and not to any other principal, then you can add another 1,450 + principals to the bindings in the Policy. type: array items: - type: string - GoogleCloudDataplexV1ListDataAttributeBindingsResponse: - id: GoogleCloudDataplexV1ListDataAttributeBindingsResponse - description: List DataAttributeBindings response. - type: object - properties: - dataAttributeBindings: - description: DataAttributeBindings under the given parent Location. + $ref: '#/components/schemas/GoogleIamV1Binding' + auditConfigs: + description: Specifies cloud audit logging configuration for this policy. type: array items: - $ref: '#/components/schemas/GoogleCloudDataplexV1DataAttributeBinding' - nextPageToken: + $ref: '#/components/schemas/GoogleIamV1AuditConfig' + etag: description: >- - Token to retrieve the next page of results, or empty if there are no - more results in the list. + 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. type: string - unreachableLocations: - description: Locations that could not be reached. + format: byte + GoogleIamV1Binding: + id: GoogleIamV1Binding + description: Associates members, or principals, with a role. + type: object + properties: + role: + description: >- + Role that is assigned to the list of members, or principals. For + example, roles/viewer, roles/editor, or roles/owner.For an overview + of the IAM roles and permissions, see the IAM documentation + (https://cloud.google.com/iam/docs/roles-overview). For a list of + the available pre-defined roles, see here + (https://cloud.google.com/iam/docs/understanding-roles). + type: string + members: + description: >- + Specifies the principals requesting access for a Google Cloud + 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. Does not include identities that come + from external identity providers (IdPs) through identity federation. + user:{emailid}: An email address that represents a specific Google + account. For example, alice@example.com . serviceAccount:{emailid}: + An email address that represents a Google service account. For + example, my-other-app@appspot.gserviceaccount.com. + serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: + An identifier for a Kubernetes service account + (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). + For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. + group:{emailid}: An email address that represents a Google group. + For example, admins@example.com. domain:{domain}: The G Suite domain + (primary) that represents all the users of that domain. For example, + google.com or example.com. + principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: + A single identity in a workforce identity pool. + principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}: + All workforce identities in a group. + principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}: + All workforce identities with a specific attribute value. + principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*: + All identities in a workforce identity pool. + principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}: + A single identity in a workload identity pool. + principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}: + A workload identity pool group. + principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}: + All identities in a workload identity pool with a certain attribute. + principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*: + All identities in a workload identity pool. + 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. + deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: + Deleted single identity in a workforce identity pool. For example, + deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value. type: array items: type: string - GoogleCloudDataplexV1DataAttribute: - id: GoogleCloudDataplexV1DataAttribute + condition: + description: >- + The condition that is associated with this binding.If the condition + evaluates to true, then this binding applies to the current + request.If the condition evaluates to false, then this binding does + not apply to the current request. However, a different role binding + might grant the same role to one or more of the principals in this + binding.To learn which resources support conditions in their IAM + policies, see the IAM documentation + (https://cloud.google.com/iam/help/conditions/resource-policies). + $ref: '#/components/schemas/GoogleTypeExpr' + GoogleTypeExpr: + id: GoogleTypeExpr description: >- - Denotes one dataAttribute in a dataTaxonomy, for example, PII. - DataAttribute resources can be defined in a hierarchy. A single - dataAttribute resource can contain specs of multiple types PII - - ResourceAccessSpec : - readers :foo@bar.com - DataAccessSpec : - readers - :bar@foo.com + 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. type: object properties: - name: + expression: description: >- - Output only. The relative resource name of the dataAttribute, of the - form: - projects/{project_number}/locations/{location_id}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}. - readOnly: true + Textual representation of an expression in Common Expression + Language syntax. type: string - uid: + title: description: >- - Output only. System generated globally unique ID for the - DataAttribute. This ID will be different if the DataAttribute is - deleted and re-created with the same name. - readOnly: true - type: string - createTime: - description: Output only. The time when the DataAttribute was created. - readOnly: true - type: string - format: google-datetime - updateTime: - description: Output only. The time when the DataAttribute was last updated. - readOnly: true + 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 - format: google-datetime description: - description: Optional. Description of the DataAttribute. - type: string - displayName: - description: Optional. User friendly display name. - type: string - labels: - description: Optional. User-defined labels for the DataAttribute. - type: object - additionalProperties: - type: string - parentId: description: >- - Optional. The ID of the parent DataAttribute resource, should belong - to the same data taxonomy. Circular dependency in parent chain is - not valid. Maximum depth of the hierarchy allowed is 4. a -> b -> c - -> d -> e, depth = 4 + 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 - attributeCount: - description: >- - Output only. The number of child attributes present for this - attribute. - readOnly: true - type: integer - format: int32 - etag: + location: description: >- - This checksum is computed by the server based on the value of other - fields, and may be sent on update and delete requests to ensure the - client has an up-to-date value before proceeding. + Optional. String indicating the location of the expression for error + reporting, e.g. a file name and a position in the file. type: string - resourceAccessSpec: - description: >- - Optional. Specified when applied to a resource (eg: Cloud Storage - bucket, BigQuery dataset, BigQuery table). - $ref: '#/components/schemas/GoogleCloudDataplexV1ResourceAccessSpec' - dataAccessSpec: - description: >- - Optional. Specified when applied to data stored on the resource (eg: - rows, columns in BigQuery Tables). - $ref: '#/components/schemas/GoogleCloudDataplexV1DataAccessSpec' - GoogleCloudDataplexV1ResourceAccessSpec: - id: GoogleCloudDataplexV1ResourceAccessSpec + GoogleIamV1AuditConfig: + id: GoogleIamV1AuditConfig description: >- - ResourceAccessSpec holds the access control configuration to be enforced - on the resources, for example, Cloud Storage bucket, BigQuery dataset, - BigQuery table. + 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. type: object properties: - readers: - description: >- - Optional. The format of strings follows the pattern followed by IAM - in the bindings. user:{email}, serviceAccount:{email} group:{email}. - The set of principals to be granted reader role on the resource. - type: array - items: - type: string - writers: - description: >- - Optional. The set of principals to be granted writer role on the - resource. - type: array - items: - type: string - owners: + service: description: >- - Optional. The set of principals to be granted owner role on the - resource. + 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 + auditLogConfigs: + description: The configuration for logging of each type of permission. type: array items: - type: string - GoogleCloudDataplexV1DataAccessSpec: - id: GoogleCloudDataplexV1DataAccessSpec + $ref: '#/components/schemas/GoogleIamV1AuditLogConfig' + GoogleIamV1AuditLogConfig: + id: GoogleIamV1AuditLogConfig description: >- - DataAccessSpec holds the access control configuration to be enforced on - data stored within resources (eg: rows, columns in BigQuery Tables). - When associated with data, the data is only accessible to principals - explicitly granted access through the DataAccessSpec. Principals with - access to the containing resource are not implicitly granted access. + 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. type: object properties: - readers: + logType: + description: The log type that this config enables. + type: string + enumDescriptions: + - Default case. Should never be this. + - 'Admin reads. Example: CloudIAM getIamPolicy' + - 'Data writes. Example: CloudSQL Users create' + - 'Data reads. Example: CloudSQL Users list' + enum: + - LOG_TYPE_UNSPECIFIED + - ADMIN_READ + - DATA_WRITE + - DATA_READ + exemptedMembers: description: >- - Optional. The format of strings follows the pattern followed by IAM - in the bindings. user:{email}, serviceAccount:{email} group:{email}. - The set of principals to be granted reader role on data stored - within resources. + Specifies the identities that do not cause logging for this type of + permission. Follows the same format of Binding.members. type: array items: type: string - GoogleCloudDataplexV1ListDataAttributesResponse: - id: GoogleCloudDataplexV1ListDataAttributesResponse - description: List DataAttributes response. + GoogleIamV1TestIamPermissionsRequest: + id: GoogleIamV1TestIamPermissionsRequest + description: Request message for TestIamPermissions method. type: object properties: - dataAttributes: - description: DataAttributes under the given parent DataTaxonomy. + permissions: + description: >- + The set of permissions to check for the resource. Permissions with + wildcards (such as * or storage.*) are not allowed. For more + information see IAM Overview + (https://cloud.google.com/iam/docs/overview#permissions). type: array items: - $ref: '#/components/schemas/GoogleCloudDataplexV1DataAttribute' - nextPageToken: + type: string + GoogleIamV1TestIamPermissionsResponse: + id: GoogleIamV1TestIamPermissionsResponse + description: Response message for TestIamPermissions method. + type: object + properties: + permissions: description: >- - Token to retrieve the next page of results, or empty if there are no - more results in the list. - type: string - unreachableLocations: - description: Locations that could not be reached. + A subset of TestPermissionsRequest.permissions that the caller is + allowed. type: array items: type: string - GoogleCloudDataplexV1DataScan: - id: GoogleCloudDataplexV1DataScan - description: >- - Represents a user-visible job which provides the insights for the - related data source.For example: Data Quality: generates queries based - on the rules and runs against the data to get data quality check - results. Data Profile: analyzes the data in table(s) and generates - insights about the structure, content and relationships (such as null - percent, cardinality, min/max/mean, etc). + GoogleCloudDataplexV1Content: + id: GoogleCloudDataplexV1Content + description: Content represents a user-visible notebook or a sql script type: object properties: name: description: >- - Output only. The relative resource name of the scan, of the form: - projects/{project}/locations/{location_id}/dataScans/{datascan_id}, - where project refers to a project_id or project_number and - location_id refers to a GCP region. + Output only. The relative resource name of the content, of the form: + projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id} readOnly: true type: string uid: description: >- - Output only. System generated globally unique ID for the scan. This - ID will be different if the scan is deleted and re-created with the - same name. + Output only. System generated globally unique ID for the content. + This ID will be different if the content is deleted and re-created + with the same name. readOnly: true type: string - description: - description: >- - Optional. Description of the scan. Must be between 1-1024 - characters. - type: string - displayName: + path: description: >- - Optional. User friendly display name. Must be between 1-256 - characters. - type: string - labels: - description: Optional. User-defined labels for the scan. - type: object - additionalProperties: - type: string - state: - description: Output only. Current state of the DataScan. - readOnly: true + Required. The path for the Content file, represented as directory + structure. Unique within a lake. Limited to alphanumerics, hyphens, + underscores, dots and slashes. type: string - enumDescriptions: - - State is not specified. - - Resource is active, i.e., ready to use. - - Resource is under creation. - - Resource is under deletion. - - Resource is active but has unresolved actions. - enum: - - STATE_UNSPECIFIED - - ACTIVE - - CREATING - - DELETING - - ACTION_REQUIRED createTime: - description: Output only. The time when the scan was created. + description: Output only. Content creation time. readOnly: true type: string format: google-datetime updateTime: - description: Output only. The time when the scan was last updated. + description: Output only. The time when the content was last updated. readOnly: true type: string format: google-datetime - data: - description: Required. The data source for DataScan. - $ref: '#/components/schemas/GoogleCloudDataplexV1DataSource' - executionSpec: - description: >- - Optional. DataScan execution settings.If not specified, the fields - in it will use their default values. - $ref: '#/components/schemas/GoogleCloudDataplexV1DataScanExecutionSpec' - executionStatus: - description: Output only. Status of the data scan execution. - readOnly: true - $ref: '#/components/schemas/GoogleCloudDataplexV1DataScanExecutionStatus' - type: - description: Output only. The type of DataScan. - readOnly: true + labels: + description: Optional. User defined labels for the content. + type: object + additionalProperties: + type: string + description: + description: Optional. Description of the content. + type: string + dataText: + description: Required. Content data in string format. + type: string + sqlScript: + description: Sql Script related configurations. + $ref: '#/components/schemas/GoogleCloudDataplexV1ContentSqlScript' + notebook: + description: Notebook related configurations. + $ref: '#/components/schemas/GoogleCloudDataplexV1ContentNotebook' + GoogleCloudDataplexV1ContentSqlScript: + id: GoogleCloudDataplexV1ContentSqlScript + description: Configuration for the Sql Script content. + type: object + properties: + engine: + description: Required. Query Engine to be used for the Sql Query. type: string enumDescriptions: - - The data scan type is unspecified. - - Data quality scan. - - Data profile scan. - - Data discovery scan. + - Value was unspecified. + - Spark SQL Query. enum: - - DATA_SCAN_TYPE_UNSPECIFIED - - DATA_QUALITY - - DATA_PROFILE - - DATA_DISCOVERY - dataQualitySpec: - description: Settings for a data quality scan. - $ref: '#/components/schemas/GoogleCloudDataplexV1DataQualitySpec' - dataProfileSpec: - description: Settings for a data profile scan. - $ref: '#/components/schemas/GoogleCloudDataplexV1DataProfileSpec' - dataDiscoverySpec: - description: Settings for a data discovery scan. - $ref: '#/components/schemas/GoogleCloudDataplexV1DataDiscoverySpec' - dataQualityResult: - description: Output only. The result of a data quality scan. - readOnly: true - $ref: '#/components/schemas/GoogleCloudDataplexV1DataQualityResult' - dataProfileResult: - description: Output only. The result of a data profile scan. - readOnly: true - $ref: '#/components/schemas/GoogleCloudDataplexV1DataProfileResult' - dataDiscoveryResult: - description: Output only. The result of a data discovery scan. - readOnly: true - $ref: '#/components/schemas/GoogleCloudDataplexV1DataDiscoveryResult' - GoogleCloudDataplexV1DataSource: - id: GoogleCloudDataplexV1DataSource - description: The data source for DataScan. + - QUERY_ENGINE_UNSPECIFIED + - SPARK + GoogleCloudDataplexV1ContentNotebook: + id: GoogleCloudDataplexV1ContentNotebook + description: Configuration for Notebook content. type: object properties: - entity: - description: >- - Immutable. The Dataplex entity that represents the data source (e.g. - BigQuery table) for DataScan, of the form: - projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}. + kernelType: + description: Required. Kernel Type of the notebook. type: string - resource: + enumDescriptions: + - Kernel Type unspecified. + - Python 3 Kernel. + enum: + - KERNEL_TYPE_UNSPECIFIED + - PYTHON3 + GoogleCloudDataplexV1ListContentResponse: + id: GoogleCloudDataplexV1ListContentResponse + description: List content response. + type: object + properties: + content: + description: Content under the given parent lake. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDataplexV1Content' + nextPageToken: description: >- - Immutable. The service-qualified full resource name of the cloud - resource for a DataScan job to scan against. The field could be: - BigQuery table of type "TABLE" for DataProfileScan/DataQualityScan - Format: - //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID + Token to retrieve the next page of results, or empty if there are no + more results in the list. type: string - GoogleCloudDataplexV1DataScanExecutionSpec: - id: GoogleCloudDataplexV1DataScanExecutionSpec - description: DataScan execution settings. + GoogleCloudDataplexV1DataTaxonomy: + id: GoogleCloudDataplexV1DataTaxonomy + deprecated: true + description: >- + DataTaxonomy represents a set of hierarchical DataAttributes resources, + grouped with a common theme Eg: 'SensitiveDataTaxonomy' can have + attributes to manage PII data. It is defined at project level. type: object properties: - trigger: + name: description: >- - Optional. Spec related to how often and when a scan should be - triggered.If not specified, the default is OnDemand, which means the - scan will not run until the user calls RunDataScan API. - $ref: '#/components/schemas/GoogleCloudDataplexV1Trigger' - field: + Output only. The relative resource name of the DataTaxonomy, of the + form: + projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}. + readOnly: true + type: string + uid: description: >- - Immutable. The unnested field (of type Date or Timestamp) that - contains values which monotonically increase over time.If not - specified, a data scan will run for all data in the table. + Output only. System generated globally unique ID for the + dataTaxonomy. This ID will be different if the DataTaxonomy is + deleted and re-created with the same name. + readOnly: true type: string - GoogleCloudDataplexV1Trigger: - id: GoogleCloudDataplexV1Trigger - description: DataScan scheduling and trigger settings. - type: object - properties: - onDemand: - description: The scan runs once via RunDataScan API. - $ref: '#/components/schemas/GoogleCloudDataplexV1TriggerOnDemand' - schedule: - description: The scan is scheduled to run periodically. - $ref: '#/components/schemas/GoogleCloudDataplexV1TriggerSchedule' - GoogleCloudDataplexV1TriggerOnDemand: - id: GoogleCloudDataplexV1TriggerOnDemand - description: The scan runs once via RunDataScan API. - type: object - properties: {} - GoogleCloudDataplexV1TriggerSchedule: - id: GoogleCloudDataplexV1TriggerSchedule - description: The scan is scheduled to run periodically. - type: object - properties: - cron: - description: >- - Required. Cron (https://en.wikipedia.org/wiki/Cron) schedule for - running scans periodically.To explicitly set a timezone in the cron - tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or - "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid - string from IANA time zone database (wikipedia - (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List)). - For example, CRON_TZ=America/New_York 1 * * * *, or - TZ=America/New_York 1 * * * *.This field is required for Schedule - scans. - type: string - GoogleCloudDataplexV1DataScanExecutionStatus: - id: GoogleCloudDataplexV1DataScanExecutionStatus - description: Status of the data scan execution. - type: object - properties: - latestJobStartTime: - description: The time when the latest DataScanJob started. + createTime: + description: Output only. The time when the DataTaxonomy was created. + readOnly: true type: string format: google-datetime - latestJobEndTime: - description: The time when the latest DataScanJob ended. + updateTime: + description: Output only. The time when the DataTaxonomy was last updated. + readOnly: true type: string format: google-datetime - latestJobCreateTime: - description: Optional. The time when the DataScanJob execution was created. + description: + description: Optional. Description of the DataTaxonomy. type: string - format: google-datetime - GoogleCloudDataplexV1DataQualitySpec: - id: GoogleCloudDataplexV1DataQualitySpec - description: DataQualityScan related setting. + displayName: + description: Optional. User friendly display name. + type: string + labels: + description: Optional. User-defined labels for the DataTaxonomy. + type: object + additionalProperties: + type: string + attributeCount: + description: Output only. The number of attributes in the DataTaxonomy. + readOnly: true + type: integer + format: int32 + etag: + description: >- + This checksum is computed by the server based on the value of other + fields, and may be sent on update and delete requests to ensure the + client has an up-to-date value before proceeding. + type: string + classCount: + description: Output only. The number of classes in the DataTaxonomy. + readOnly: true + type: integer + format: int32 + GoogleCloudDataplexV1ListDataTaxonomiesResponse: + id: GoogleCloudDataplexV1ListDataTaxonomiesResponse + description: List DataTaxonomies response. type: object properties: - rules: - description: >- - Required. The list of rules to evaluate against a data source. At - least one rule is required. + dataTaxonomies: + description: DataTaxonomies under the given parent location. type: array items: - $ref: '#/components/schemas/GoogleCloudDataplexV1DataQualityRule' - samplingPercent: - description: >- - Optional. The percentage of the records to be selected from the - dataset for DataScan. Value can range between 0.0 and 100.0 with up - to 3 significant decimal digits. Sampling is not applied if - sampling_percent is not specified, 0 or 100. - type: number - format: float - rowFilter: + $ref: '#/components/schemas/GoogleCloudDataplexV1DataTaxonomy' + nextPageToken: description: >- - Optional. A filter applied to all rows in a single DataScan job. The - filter needs to be a valid SQL expression for a WHERE clause in - BigQuery standard SQL syntax. Example: col1 >= 0 AND col2 < 10 + Token to retrieve the next page of results, or empty if there are no + more results in the list. type: string - postScanActions: - description: Optional. Actions to take upon job completion. - $ref: >- - #/components/schemas/GoogleCloudDataplexV1DataQualitySpecPostScanActions - GoogleCloudDataplexV1DataQualityRule: - id: GoogleCloudDataplexV1DataQualityRule - description: A rule captures data quality intent about a data source. + unreachableLocations: + description: Locations that could not be reached. + type: array + items: + type: string + GoogleCloudDataplexV1DataAttributeBinding: + id: GoogleCloudDataplexV1DataAttributeBinding + deprecated: true + description: >- + DataAttributeBinding represents binding of attributes to resources. Eg: + Bind 'CustomerInfo' entity with 'PII' attribute. type: object properties: - rangeExpectation: - description: >- - Row-level rule which evaluates whether each column value lies - between a specified range. - $ref: >- - #/components/schemas/GoogleCloudDataplexV1DataQualityRuleRangeExpectation - nonNullExpectation: - description: Row-level rule which evaluates whether each column value is null. - $ref: >- - #/components/schemas/GoogleCloudDataplexV1DataQualityRuleNonNullExpectation - setExpectation: - description: >- - Row-level rule which evaluates whether each column value is - contained by a specified set. - $ref: >- - #/components/schemas/GoogleCloudDataplexV1DataQualityRuleSetExpectation - regexExpectation: - description: >- - Row-level rule which evaluates whether each column value matches a - specified regex. - $ref: >- - #/components/schemas/GoogleCloudDataplexV1DataQualityRuleRegexExpectation - uniquenessExpectation: - description: Row-level rule which evaluates whether each column value is unique. - $ref: >- - #/components/schemas/GoogleCloudDataplexV1DataQualityRuleUniquenessExpectation - statisticRangeExpectation: - description: >- - Aggregate rule which evaluates whether the column aggregate - statistic lies between a specified range. - $ref: >- - #/components/schemas/GoogleCloudDataplexV1DataQualityRuleStatisticRangeExpectation - rowConditionExpectation: - description: >- - Row-level rule which evaluates whether each row in a table passes - the specified condition. - $ref: >- - #/components/schemas/GoogleCloudDataplexV1DataQualityRuleRowConditionExpectation - tableConditionExpectation: - description: >- - Aggregate rule which evaluates whether the provided expression is - true for a table. - $ref: >- - #/components/schemas/GoogleCloudDataplexV1DataQualityRuleTableConditionExpectation - sqlAssertion: + name: description: >- - Aggregate rule which evaluates the number of rows returned for the - provided statement. If any rows are returned, this rule fails. - $ref: >- - #/components/schemas/GoogleCloudDataplexV1DataQualityRuleSqlAssertion - column: - description: Optional. The unnested column which this rule is evaluated against. + Output only. The relative resource name of the Data Attribute + Binding, of the form: + projects/{project_number}/locations/{location}/dataAttributeBindings/{data_attribute_binding_id} + readOnly: true type: string - ignoreNull: - description: >- - Optional. Rows with null values will automatically fail a rule, - unless ignore_null is true. In that case, such null rows are - trivially considered passing.This field is only valid for the - following type of rules: RangeExpectation RegexExpectation - SetExpectation UniquenessExpectation - type: boolean - dimension: + uid: description: >- - Required. The dimension a rule belongs to. Results are also - aggregated at the dimension level. Supported dimensions are - "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", - "FRESHNESS", "VOLUME" + Output only. System generated globally unique ID for the + DataAttributeBinding. This ID will be different if the + DataAttributeBinding is deleted and re-created with the same name. + readOnly: true type: string - threshold: - description: >- - Optional. The minimum ratio of passing_rows / total_rows required to - pass this rule, with a range of 0.0, 1.0.0 indicates default value - (i.e. 1.0).This field is only valid for row-level type rules. - type: number - format: double - name: + createTime: + description: Output only. The time when the DataAttributeBinding was created. + readOnly: true + type: string + format: google-datetime + updateTime: description: >- - Optional. A mutable name for the rule. The name must contain only - letters (a-z, A-Z), numbers (0-9), or hyphens (-). The maximum - length is 63 characters. Must start with a letter. Must end with a - number or a letter. + Output only. The time when the DataAttributeBinding was last + updated. + readOnly: true type: string + format: google-datetime description: - description: >- - Optional. Description of the rule. The maximum length is 1,024 - characters. + description: Optional. Description of the DataAttributeBinding. type: string - suspended: - description: Optional. Whether the Rule is active or suspended. Default is false. - type: boolean - GoogleCloudDataplexV1DataQualityRuleRangeExpectation: - id: GoogleCloudDataplexV1DataQualityRuleRangeExpectation - description: Evaluates whether each column value lies between a specified range. - type: object - properties: - minValue: - description: >- - Optional. The minimum column value allowed for a row to pass this - validation. At least one of min_value and max_value need to be - provided. + displayName: + description: Optional. User friendly display name. type: string - maxValue: + labels: + description: Optional. User-defined labels for the DataAttributeBinding. + type: object + additionalProperties: + type: string + etag: description: >- - Optional. The maximum column value allowed for a row to pass this - validation. At least one of min_value and max_value need to be - provided. + This checksum is computed by the server based on the value of other + fields, and may be sent on update and delete requests to ensure the + client has an up-to-date value before proceeding. Etags must be used + when calling the DeleteDataAttributeBinding and the + UpdateDataAttributeBinding method. type: string - strictMinEnabled: + resource: description: >- - Optional. Whether each value needs to be strictly greater than ('>') - the minimum, or if equality is allowed.Only relevant if a min_value - has been defined. Default = false. - type: boolean - strictMaxEnabled: + Optional. Immutable. The resource name of the resource that is + associated to attributes. Presently, only entity resource is + supported in the form: + projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/entities/{entity_id} + Must belong in the same project and region as the attribute binding, + and there can only exist one active binding for a resource. + type: string + attributes: description: >- - Optional. Whether each value needs to be strictly lesser than ('<') - the maximum, or if equality is allowed.Only relevant if a max_value - has been defined. Default = false. - type: boolean - GoogleCloudDataplexV1DataQualityRuleNonNullExpectation: - id: GoogleCloudDataplexV1DataQualityRuleNonNullExpectation - description: Evaluates whether each column value is null. - type: object - properties: {} - GoogleCloudDataplexV1DataQualityRuleSetExpectation: - id: GoogleCloudDataplexV1DataQualityRuleSetExpectation - description: Evaluates whether each column value is contained by a specified set. + Optional. List of attributes to be associated with the resource, + provided in the form: + projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id} + type: array + items: + type: string + paths: + description: >- + Optional. The list of paths for items within the associated resource + (eg. columns and partitions within a table) along with attribute + bindings. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDataplexV1DataAttributeBindingPath' + GoogleCloudDataplexV1DataAttributeBindingPath: + id: GoogleCloudDataplexV1DataAttributeBindingPath + description: >- + Represents a subresource of the given resource, and associated bindings + with it. Currently supported subresources are column and partition + schema fields within a table. type: object properties: - values: - description: Optional. Expected values for the column value. + name: + description: >- + Required. The name identifier of the path. Nested columns should be + of the form: 'address.city'. + type: string + attributes: + description: >- + Optional. List of attributes to be associated with the path of the + resource, provided in the form: + projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id} type: array items: type: string - GoogleCloudDataplexV1DataQualityRuleRegexExpectation: - id: GoogleCloudDataplexV1DataQualityRuleRegexExpectation - description: Evaluates whether each column value matches a specified regex. + GoogleCloudDataplexV1ListDataAttributeBindingsResponse: + id: GoogleCloudDataplexV1ListDataAttributeBindingsResponse + description: List DataAttributeBindings response. type: object properties: - regex: + dataAttributeBindings: + description: DataAttributeBindings under the given parent Location. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDataplexV1DataAttributeBinding' + nextPageToken: description: >- - Optional. A regular expression the column value is expected to - match. + Token to retrieve the next page of results, or empty if there are no + more results in the list. type: string - GoogleCloudDataplexV1DataQualityRuleUniquenessExpectation: - id: GoogleCloudDataplexV1DataQualityRuleUniquenessExpectation - description: Evaluates whether the column has duplicates. - type: object - properties: {} - GoogleCloudDataplexV1DataQualityRuleStatisticRangeExpectation: - id: GoogleCloudDataplexV1DataQualityRuleStatisticRangeExpectation + unreachableLocations: + description: Locations that could not be reached. + type: array + items: + type: string + GoogleCloudDataplexV1DataAttribute: + id: GoogleCloudDataplexV1DataAttribute + deprecated: true description: >- - Evaluates whether the column aggregate statistic lies between a - specified range. + Denotes one dataAttribute in a dataTaxonomy, for example, PII. + DataAttribute resources can be defined in a hierarchy. A single + dataAttribute resource can contain specs of multiple types PII - + ResourceAccessSpec : - readers :foo@bar.com - DataAccessSpec : - readers + :bar@foo.com type: object properties: - statistic: - description: Optional. The aggregate metric to evaluate. + name: + description: >- + Output only. The relative resource name of the dataAttribute, of the + form: + projects/{project_number}/locations/{location_id}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}. + readOnly: true type: string - enumDescriptions: - - Unspecified statistic type - - Evaluate the column mean - - Evaluate the column min - - Evaluate the column max - enum: - - STATISTIC_UNDEFINED - - MEAN - - MIN - - MAX - minValue: + uid: description: >- - Optional. The minimum column statistic value allowed for a row to - pass this validation.At least one of min_value and max_value need to - be provided. + Output only. System generated globally unique ID for the + DataAttribute. This ID will be different if the DataAttribute is + deleted and re-created with the same name. + readOnly: true type: string - maxValue: + createTime: + description: Output only. The time when the DataAttribute was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. The time when the DataAttribute was last updated. + readOnly: true + type: string + format: google-datetime + description: + description: Optional. Description of the DataAttribute. + type: string + displayName: + description: Optional. User friendly display name. + type: string + labels: + description: Optional. User-defined labels for the DataAttribute. + type: object + additionalProperties: + type: string + parentId: description: >- - Optional. The maximum column statistic value allowed for a row to - pass this validation.At least one of min_value and max_value need to - be provided. + Optional. The ID of the parent DataAttribute resource, should belong + to the same data taxonomy. Circular dependency in parent chain is + not valid. Maximum depth of the hierarchy allowed is 4. a -> b -> c + -> d -> e, depth = 4 type: string - strictMinEnabled: + attributeCount: description: >- - Optional. Whether column statistic needs to be strictly greater than - ('>') the minimum, or if equality is allowed.Only relevant if a - min_value has been defined. Default = false. - type: boolean - strictMaxEnabled: + Output only. The number of child attributes present for this + attribute. + readOnly: true + type: integer + format: int32 + etag: description: >- - Optional. Whether column statistic needs to be strictly lesser than - ('<') the maximum, or if equality is allowed.Only relevant if a - max_value has been defined. Default = false. - type: boolean - GoogleCloudDataplexV1DataQualityRuleRowConditionExpectation: - id: GoogleCloudDataplexV1DataQualityRuleRowConditionExpectation - description: >- - Evaluates whether each row passes the specified condition.The SQL - expression needs to use BigQuery standard SQL syntax and should produce - a boolean value per row as the result.Example: col1 >= 0 AND col2 < 10 - type: object - properties: - sqlExpression: - description: Optional. The SQL expression. + This checksum is computed by the server based on the value of other + fields, and may be sent on update and delete requests to ensure the + client has an up-to-date value before proceeding. type: string - GoogleCloudDataplexV1DataQualityRuleTableConditionExpectation: - id: GoogleCloudDataplexV1DataQualityRuleTableConditionExpectation + resourceAccessSpec: + description: >- + Optional. Specified when applied to a resource (eg: Cloud Storage + bucket, BigQuery dataset, BigQuery table). + $ref: '#/components/schemas/GoogleCloudDataplexV1ResourceAccessSpec' + dataAccessSpec: + description: >- + Optional. Specified when applied to data stored on the resource (eg: + rows, columns in BigQuery Tables). + $ref: '#/components/schemas/GoogleCloudDataplexV1DataAccessSpec' + GoogleCloudDataplexV1ResourceAccessSpec: + id: GoogleCloudDataplexV1ResourceAccessSpec description: >- - Evaluates whether the provided expression is true.The SQL expression - needs to use BigQuery standard SQL syntax and should produce a scalar - boolean result.Example: MIN(col1) >= 0 + ResourceAccessSpec holds the access control configuration to be enforced + on the resources, for example, Cloud Storage bucket, BigQuery dataset, + BigQuery table. type: object properties: - sqlExpression: - description: Optional. The SQL expression. - type: string - GoogleCloudDataplexV1DataQualityRuleSqlAssertion: - id: GoogleCloudDataplexV1DataQualityRuleSqlAssertion + readers: + description: >- + Optional. The format of strings follows the pattern followed by IAM + in the bindings. user:{email}, serviceAccount:{email} group:{email}. + The set of principals to be granted reader role on the resource. + type: array + items: + type: string + writers: + description: >- + Optional. The set of principals to be granted writer role on the + resource. + type: array + items: + type: string + owners: + description: >- + Optional. The set of principals to be granted owner role on the + resource. + type: array + items: + type: string + GoogleCloudDataplexV1DataAccessSpec: + id: GoogleCloudDataplexV1DataAccessSpec description: >- - A SQL statement that is evaluated to return rows that match an invalid - state. If any rows are are returned, this rule fails.The SQL statement - must use BigQuery standard SQL syntax, and must not contain any - semicolons.You can use the data reference parameter ${data()} to - reference the source table with all of its precondition filters applied. - Examples of precondition filters include row filters, incremental data - filters, and sampling. For more information, see Data reference - parameter - (https://cloud.google.com/dataplex/docs/auto-data-quality-overview#data-reference-parameter).Example: - SELECT * FROM ${data()} WHERE price < 0 + DataAccessSpec holds the access control configuration to be enforced on + data stored within resources (eg: rows, columns in BigQuery Tables). + When associated with data, the data is only accessible to principals + explicitly granted access through the DataAccessSpec. Principals with + access to the containing resource are not implicitly granted access. type: object properties: - sqlStatement: - description: Optional. The SQL statement. - type: string - GoogleCloudDataplexV1DataQualitySpecPostScanActions: - id: GoogleCloudDataplexV1DataQualitySpecPostScanActions - description: The configuration of post scan actions of DataQualityScan. + readers: + description: >- + Optional. The format of strings follows the pattern followed by IAM + in the bindings. user:{email}, serviceAccount:{email} group:{email}. + The set of principals to be granted reader role on data stored + within resources. + type: array + items: + type: string + GoogleCloudDataplexV1ListDataAttributesResponse: + id: GoogleCloudDataplexV1ListDataAttributesResponse + description: List DataAttributes response. type: object properties: - bigqueryExport: - description: >- - Optional. If set, results will be exported to the provided BigQuery - table. - $ref: >- - #/components/schemas/GoogleCloudDataplexV1DataQualitySpecPostScanActionsBigQueryExport - notificationReport: - description: >- - Optional. If set, results will be sent to the provided notification - receipts upon triggers. - $ref: >- - #/components/schemas/GoogleCloudDataplexV1DataQualitySpecPostScanActionsNotificationReport - GoogleCloudDataplexV1DataQualitySpecPostScanActionsBigQueryExport: - id: GoogleCloudDataplexV1DataQualitySpecPostScanActionsBigQueryExport - description: The configuration of BigQuery export post scan action. - type: object - properties: - resultsTable: + dataAttributes: + description: DataAttributes under the given parent DataTaxonomy. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDataplexV1DataAttribute' + nextPageToken: description: >- - Optional. The BigQuery table to export DataQualityScan results to. - Format: - //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID + Token to retrieve the next page of results, or empty if there are no + more results in the list. type: string - GoogleCloudDataplexV1DataQualitySpecPostScanActionsNotificationReport: - id: GoogleCloudDataplexV1DataQualitySpecPostScanActionsNotificationReport - description: The configuration of notification report post scan action. - type: object - properties: - recipients: - description: Required. The recipients who will receive the notification report. - $ref: >- - #/components/schemas/GoogleCloudDataplexV1DataQualitySpecPostScanActionsRecipients - scoreThresholdTrigger: - description: Optional. If set, report will be sent when score threshold is met. - $ref: >- - #/components/schemas/GoogleCloudDataplexV1DataQualitySpecPostScanActionsScoreThresholdTrigger - jobFailureTrigger: - description: Optional. If set, report will be sent when a scan job fails. - $ref: >- - #/components/schemas/GoogleCloudDataplexV1DataQualitySpecPostScanActionsJobFailureTrigger - jobEndTrigger: - description: Optional. If set, report will be sent when a scan job ends. - $ref: >- - #/components/schemas/GoogleCloudDataplexV1DataQualitySpecPostScanActionsJobEndTrigger - GoogleCloudDataplexV1DataQualitySpecPostScanActionsRecipients: - id: GoogleCloudDataplexV1DataQualitySpecPostScanActionsRecipients - description: >- - The individuals or groups who are designated to receive notifications - upon triggers. - type: object - properties: - emails: - description: >- - Optional. The email recipients who will receive the DataQualityScan - results report. + unreachableLocations: + description: Locations that could not be reached. type: array items: type: string - GoogleCloudDataplexV1DataQualitySpecPostScanActionsScoreThresholdTrigger: - id: GoogleCloudDataplexV1DataQualitySpecPostScanActionsScoreThresholdTrigger - description: >- - This trigger is triggered when the DQ score in the job result is less - than a specified input score. - type: object - properties: - scoreThreshold: - description: Optional. The score range is in 0,100. - type: number - format: float - GoogleCloudDataplexV1DataQualitySpecPostScanActionsJobFailureTrigger: - id: GoogleCloudDataplexV1DataQualitySpecPostScanActionsJobFailureTrigger - description: >- - This trigger is triggered when the scan job itself fails, regardless of - the result. - type: object - properties: {} - GoogleCloudDataplexV1DataQualitySpecPostScanActionsJobEndTrigger: - id: GoogleCloudDataplexV1DataQualitySpecPostScanActionsJobEndTrigger + GoogleCloudDataplexV1DataScan: + id: GoogleCloudDataplexV1DataScan description: >- - This trigger is triggered whenever a scan job run ends, regardless of - the result. - type: object - properties: {} - GoogleCloudDataplexV1DataProfileSpec: - id: GoogleCloudDataplexV1DataProfileSpec - description: DataProfileScan related setting. + Represents a user-visible job which provides the insights for the + related data source.For example: Data quality: generates queries based + on the rules and runs against the data to get data quality check + results. For more information, see Auto data quality overview + (https://cloud.google.com/dataplex/docs/auto-data-quality-overview). + Data profile: analyzes the data in tables and generates insights about + the structure, content and relationships (such as null percent, + cardinality, min/max/mean, etc). For more information, see About data + profiling + (https://cloud.google.com/dataplex/docs/data-profiling-overview). Data + discovery: scans data in Cloud Storage buckets to extract and then + catalog metadata. For more information, see Discover and catalog Cloud + Storage data + (https://cloud.google.com/bigquery/docs/automatic-discovery). type: object properties: - samplingPercent: + name: description: >- - Optional. The percentage of the records to be selected from the - dataset for DataScan. Value can range between 0.0 and 100.0 with up - to 3 significant decimal digits. Sampling is not applied if - sampling_percent is not specified, 0 or 100. - type: number - format: float - rowFilter: + Output only. Identifier. The relative resource name of the scan, of + the form: + projects/{project}/locations/{location_id}/dataScans/{datascan_id}, + where project refers to a project_id or project_number and + location_id refers to a Google Cloud region. + readOnly: true + type: string + uid: description: >- - Optional. A filter applied to all rows in a single DataScan job. The - filter needs to be a valid SQL expression for a WHERE clause in - BigQuery standard SQL syntax. Example: col1 >= 0 AND col2 < 10 + Output only. System generated globally unique ID for the scan. This + ID will be different if the scan is deleted and re-created with the + same name. + readOnly: true type: string - postScanActions: - description: Optional. Actions to take upon job completion.. - $ref: >- - #/components/schemas/GoogleCloudDataplexV1DataProfileSpecPostScanActions - includeFields: + description: description: >- - Optional. The fields to include in data profile.If not specified, - all fields at the time of profile scan job execution are included, - except for ones listed in exclude_fields. - $ref: >- - #/components/schemas/GoogleCloudDataplexV1DataProfileSpecSelectedFields - excludeFields: + Optional. Description of the scan. Must be between 1-1024 + characters. + type: string + displayName: description: >- - Optional. The fields to exclude from data profile.If specified, the - fields will be excluded from data profile, regardless of - include_fields value. - $ref: >- - #/components/schemas/GoogleCloudDataplexV1DataProfileSpecSelectedFields - GoogleCloudDataplexV1DataProfileSpecPostScanActions: - id: GoogleCloudDataplexV1DataProfileSpecPostScanActions - description: The configuration of post scan actions of DataProfileScan job. - type: object - properties: - bigqueryExport: + Optional. User friendly display name. Must be between 1-256 + characters. + type: string + labels: + description: Optional. User-defined labels for the scan. + type: object + additionalProperties: + type: string + state: + description: Output only. Current state of the DataScan. + readOnly: true + type: string + enumDescriptions: + - State is not specified. + - Resource is active, i.e., ready to use. + - Resource is under creation. + - Resource is under deletion. + - Resource is active but has unresolved actions. + enum: + - STATE_UNSPECIFIED + - ACTIVE + - CREATING + - DELETING + - ACTION_REQUIRED + createTime: + description: Output only. The time when the scan was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. The time when the scan was last updated. + readOnly: true + type: string + format: google-datetime + data: + description: Required. The data source for DataScan. + $ref: '#/components/schemas/GoogleCloudDataplexV1DataSource' + executionSpec: description: >- - Optional. If set, results will be exported to the provided BigQuery - table. - $ref: >- - #/components/schemas/GoogleCloudDataplexV1DataProfileSpecPostScanActionsBigQueryExport - GoogleCloudDataplexV1DataProfileSpecPostScanActionsBigQueryExport: - id: GoogleCloudDataplexV1DataProfileSpecPostScanActionsBigQueryExport - description: The configuration of BigQuery export post scan action. + Optional. DataScan execution settings.If not specified, the fields + in it will use their default values. + $ref: '#/components/schemas/GoogleCloudDataplexV1DataScanExecutionSpec' + executionStatus: + description: Output only. Status of the data scan execution. + readOnly: true + $ref: '#/components/schemas/GoogleCloudDataplexV1DataScanExecutionStatus' + type: + description: Output only. The type of DataScan. + readOnly: true + type: string + enumDescriptions: + - The data scan type is unspecified. + - Data quality scan. + - Data profile scan. + - Data discovery scan. + enum: + - DATA_SCAN_TYPE_UNSPECIFIED + - DATA_QUALITY + - DATA_PROFILE + - DATA_DISCOVERY + dataQualitySpec: + description: Settings for a data quality scan. + $ref: '#/components/schemas/GoogleCloudDataplexV1DataQualitySpec' + dataProfileSpec: + description: Settings for a data profile scan. + $ref: '#/components/schemas/GoogleCloudDataplexV1DataProfileSpec' + dataDiscoverySpec: + description: Settings for a data discovery scan. + $ref: '#/components/schemas/GoogleCloudDataplexV1DataDiscoverySpec' + dataQualityResult: + description: Output only. The result of a data quality scan. + readOnly: true + $ref: '#/components/schemas/GoogleCloudDataplexV1DataQualityResult' + dataProfileResult: + description: Output only. The result of a data profile scan. + readOnly: true + $ref: '#/components/schemas/GoogleCloudDataplexV1DataProfileResult' + dataDiscoveryResult: + description: Output only. The result of a data discovery scan. + readOnly: true + $ref: '#/components/schemas/GoogleCloudDataplexV1DataDiscoveryResult' + GoogleCloudDataplexV1DataSource: + id: GoogleCloudDataplexV1DataSource + description: The data source for DataScan. type: object properties: - resultsTable: + entity: description: >- - Optional. The BigQuery table to export DataProfileScan results to. + Immutable. The Dataplex Universal Catalog entity that represents the + data source (e.g. BigQuery table) for DataScan, of the form: + projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}. + type: string + resource: + description: >- + Immutable. The service-qualified full resource name of the cloud + resource for a DataScan job to scan against. The field could either + be: Cloud Storage bucket for DataDiscoveryScan Format: + //storage.googleapis.com/projects/PROJECT_ID/buckets/BUCKET_ID or + BigQuery table of type "TABLE" for DataProfileScan/DataQualityScan Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID type: string - GoogleCloudDataplexV1DataProfileSpecSelectedFields: - id: GoogleCloudDataplexV1DataProfileSpecSelectedFields - description: The specification for fields to include or exclude in data profile scan. + GoogleCloudDataplexV1DataScanExecutionSpec: + id: GoogleCloudDataplexV1DataScanExecutionSpec + description: DataScan execution settings. type: object properties: - fieldNames: + trigger: description: >- - Optional. Expected input is a list of fully qualified names of - fields as in the schema.Only top-level field names for nested fields - are supported. For instance, if 'x' is of nested field type, listing - 'x' is supported but 'x.y.z' is not supported. Here 'y' and 'y.z' - are nested fields of 'x'. - type: array - items: - type: string - GoogleCloudDataplexV1DataDiscoverySpec: - id: GoogleCloudDataplexV1DataDiscoverySpec - description: Spec for a data discovery scan. - type: object - properties: - bigqueryPublishingConfig: - description: Optional. Configuration for metadata publishing. - $ref: >- - #/components/schemas/GoogleCloudDataplexV1DataDiscoverySpecBigQueryPublishingConfig - storageConfig: - description: Cloud Storage related configurations. - $ref: >- - #/components/schemas/GoogleCloudDataplexV1DataDiscoverySpecStorageConfig - GoogleCloudDataplexV1DataDiscoverySpecBigQueryPublishingConfig: - id: GoogleCloudDataplexV1DataDiscoverySpecBigQueryPublishingConfig - description: Describes BigQuery publishing configurations. + Optional. Spec related to how often and when a scan should be + triggered.If not specified, the default is OnDemand, which means the + scan will not run until the user calls RunDataScan API. + $ref: '#/components/schemas/GoogleCloudDataplexV1Trigger' + field: + description: >- + Immutable. The unnested field (of type Date or Timestamp) that + contains values which monotonically increase over time.If not + specified, a data scan will run for all data in the table. + type: string + GoogleCloudDataplexV1Trigger: + id: GoogleCloudDataplexV1Trigger + description: DataScan scheduling and trigger settings. type: object properties: - tableType: + onDemand: + description: The scan runs once via RunDataScan API. + $ref: '#/components/schemas/GoogleCloudDataplexV1TriggerOnDemand' + schedule: + description: The scan is scheduled to run periodically. + $ref: '#/components/schemas/GoogleCloudDataplexV1TriggerSchedule' + GoogleCloudDataplexV1TriggerOnDemand: + id: GoogleCloudDataplexV1TriggerOnDemand + description: The scan runs once via RunDataScan API. + type: object + properties: {} + GoogleCloudDataplexV1TriggerSchedule: + id: GoogleCloudDataplexV1TriggerSchedule + description: The scan is scheduled to run periodically. + type: object + properties: + cron: description: >- - Optional. Determines whether to publish discovered tables as BigLake - external tables or non-BigLake external tables. + Required. Cron (https://en.wikipedia.org/wiki/Cron) schedule for + running scans periodically.To explicitly set a timezone in the cron + tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or + "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid + string from IANA time zone database (wikipedia + (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List)). + For example, CRON_TZ=America/New_York 1 * * * *, or + TZ=America/New_York 1 * * * *.This field is required for Schedule + scans. type: string - enumDescriptions: - - Table type unspecified. - - >- - Default. Discovered tables are published as BigQuery external - tables whose data is accessed using the credentials of the user - querying the table. - - >- - Discovered tables are published as BigLake external tables whose - data is accessed using the credentials of the associated BigQuery - connection. - enum: - - TABLE_TYPE_UNSPECIFIED - - EXTERNAL - - BIGLAKE - connection: - description: >- - Optional. The BigQuery connection used to create BigLake tables. - Must be in the form - projects/{project_id}/locations/{location_id}/connections/{connection_id} + GoogleCloudDataplexV1DataScanExecutionStatus: + id: GoogleCloudDataplexV1DataScanExecutionStatus + description: Status of the data scan execution. + type: object + properties: + latestJobStartTime: + description: Optional. The time when the latest DataScanJob started. type: string - GoogleCloudDataplexV1DataDiscoverySpecStorageConfig: - id: GoogleCloudDataplexV1DataDiscoverySpecStorageConfig - description: Configurations related to Cloud Storage as the data source. + format: google-datetime + latestJobEndTime: + description: Optional. The time when the latest DataScanJob ended. + type: string + format: google-datetime + latestJobCreateTime: + description: Optional. The time when the DataScanJob execution was created. + type: string + format: google-datetime + GoogleCloudDataplexV1DataQualitySpec: + id: GoogleCloudDataplexV1DataQualitySpec + description: DataQualityScan related setting. type: object properties: - includePatterns: + rules: description: >- - Optional. Defines the data to include during discovery when only a - subset of the data should be considered. Provide a list of patterns - that identify the data to include. For Cloud Storage bucket assets, - these patterns are interpreted as glob patterns used to match object - names. For BigQuery dataset assets, these patterns are interpreted - as patterns to match table names. + Required. The list of rules to evaluate against a data source. At + least one rule is required. type: array items: - type: string - excludePatterns: + $ref: '#/components/schemas/GoogleCloudDataplexV1DataQualityRule' + samplingPercent: description: >- - Optional. Defines the data to exclude during discovery. Provide a - list of patterns that identify the data to exclude. For Cloud - Storage bucket assets, these patterns are interpreted as glob - patterns used to match object names. For BigQuery dataset assets, - these patterns are interpreted as patterns to match table names. - type: array - items: - type: string - csvOptions: - description: Optional. Configuration for CSV data. - $ref: >- - #/components/schemas/GoogleCloudDataplexV1DataDiscoverySpecStorageConfigCsvOptions - jsonOptions: - description: Optional. Configuration for JSON data. + Optional. The percentage of the records to be selected from the + dataset for DataScan. Value can range between 0.0 and 100.0 with up + to 3 significant decimal digits. Sampling is not applied if + sampling_percent is not specified, 0 or 100. + type: number + format: float + rowFilter: + description: >- + Optional. A filter applied to all rows in a single DataScan job. The + filter needs to be a valid SQL expression for a WHERE clause in + GoogleSQL syntax + (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#where_clause).Example: + col1 >= 0 AND col2 < 10 + type: string + postScanActions: + description: Optional. Actions to take upon job completion. $ref: >- - #/components/schemas/GoogleCloudDataplexV1DataDiscoverySpecStorageConfigJsonOptions - GoogleCloudDataplexV1DataDiscoverySpecStorageConfigCsvOptions: - id: GoogleCloudDataplexV1DataDiscoverySpecStorageConfigCsvOptions - description: Describes CSV and similar semi-structured data formats. + #/components/schemas/GoogleCloudDataplexV1DataQualitySpecPostScanActions + catalogPublishingEnabled: + description: >- + Optional. If set, the latest DataScan job result will be published + as Dataplex Universal Catalog metadata. + type: boolean + GoogleCloudDataplexV1DataQualityRule: + id: GoogleCloudDataplexV1DataQualityRule + description: A rule captures data quality intent about a data source. type: object properties: - headerRows: + rangeExpectation: description: >- - Optional. The number of rows to interpret as header rows that should - be skipped when reading data rows. - type: integer - format: int32 - delimiter: + Row-level rule which evaluates whether each column value lies + between a specified range. + $ref: >- + #/components/schemas/GoogleCloudDataplexV1DataQualityRuleRangeExpectation + nonNullExpectation: + description: Row-level rule which evaluates whether each column value is null. + $ref: >- + #/components/schemas/GoogleCloudDataplexV1DataQualityRuleNonNullExpectation + setExpectation: description: >- - Optional. The delimiter that is used to separate values. The default - is , (comma). - type: string - encoding: - description: Optional. The character encoding of the data. The default is UTF-8. + Row-level rule which evaluates whether each column value is + contained by a specified set. + $ref: >- + #/components/schemas/GoogleCloudDataplexV1DataQualityRuleSetExpectation + regexExpectation: + description: >- + Row-level rule which evaluates whether each column value matches a + specified regex. + $ref: >- + #/components/schemas/GoogleCloudDataplexV1DataQualityRuleRegexExpectation + uniquenessExpectation: + description: Row-level rule which evaluates whether each column value is unique. + $ref: >- + #/components/schemas/GoogleCloudDataplexV1DataQualityRuleUniquenessExpectation + statisticRangeExpectation: + description: >- + Aggregate rule which evaluates whether the column aggregate + statistic lies between a specified range. + $ref: >- + #/components/schemas/GoogleCloudDataplexV1DataQualityRuleStatisticRangeExpectation + rowConditionExpectation: + description: >- + Row-level rule which evaluates whether each row in a table passes + the specified condition. + $ref: >- + #/components/schemas/GoogleCloudDataplexV1DataQualityRuleRowConditionExpectation + tableConditionExpectation: + description: >- + Aggregate rule which evaluates whether the provided expression is + true for a table. + $ref: >- + #/components/schemas/GoogleCloudDataplexV1DataQualityRuleTableConditionExpectation + sqlAssertion: + description: >- + Aggregate rule which evaluates the number of rows returned for the + provided statement. If any rows are returned, this rule fails. + $ref: >- + #/components/schemas/GoogleCloudDataplexV1DataQualityRuleSqlAssertion + column: + description: Optional. The unnested column which this rule is evaluated against. type: string - typeInferenceDisabled: + ignoreNull: description: >- - Optional. Whether to disable the inference of data types for CSV - data. If true, all columns are registered as strings. + Optional. Rows with null values will automatically fail a rule, + unless ignore_null is true. In that case, such null rows are + trivially considered passing.This field is only valid for the + following type of rules: RangeExpectation RegexExpectation + SetExpectation UniquenessExpectation type: boolean - quote: + dimension: description: >- - Optional. The character used to quote column values. Accepts " - (double quotation mark) or ' (single quotation mark). If - unspecified, defaults to " (double quotation mark). + Required. The dimension a rule belongs to. Results are also + aggregated at the dimension level. Custom dimension name is + supported with all uppercase letters and maximum length of 30 + characters. type: string - GoogleCloudDataplexV1DataDiscoverySpecStorageConfigJsonOptions: - id: GoogleCloudDataplexV1DataDiscoverySpecStorageConfigJsonOptions - description: Describes JSON data format. - type: object - properties: - encoding: - description: Optional. The character encoding of the data. The default is UTF-8. + threshold: + description: >- + Optional. The minimum ratio of passing_rows / total_rows required to + pass this rule, with a range of 0.0, 1.0.0 indicates default value + (i.e. 1.0).This field is only valid for row-level type rules. + type: number + format: double + name: + description: >- + Optional. A mutable name for the rule. The name must contain only + letters (a-z, A-Z), numbers (0-9), or hyphens (-). The maximum + length is 63 characters. Must start with a letter. Must end with a + number or a letter. type: string - typeInferenceDisabled: + description: description: >- - Optional. Whether to disable the inference of data types for JSON - data. If true, all columns are registered as their primitive types - (strings, number, or boolean). + Optional. Description of the rule. The maximum length is 1,024 + characters. + type: string + suspended: + description: Optional. Whether the Rule is active or suspended. Default is false. type: boolean - GoogleCloudDataplexV1DataQualityResult: - id: GoogleCloudDataplexV1DataQualityResult - description: The output of a DataQualityScan. + GoogleCloudDataplexV1DataQualityRuleRangeExpectation: + id: GoogleCloudDataplexV1DataQualityRuleRangeExpectation + description: Evaluates whether each column value lies between a specified range. type: object properties: - passed: - description: Overall data quality result -- true if all rules passed. - type: boolean - score: + minValue: description: >- - Output only. The overall data quality score.The score ranges between - 0, 100 (up to two decimal points). - readOnly: true - type: number - format: float - dimensions: + Optional. The minimum column value allowed for a row to pass this + validation. At least one of min_value and max_value need to be + provided. + type: string + maxValue: description: >- - A list of results at the dimension level.A dimension will have a - corresponding DataQualityDimensionResult if and only if there is at - least one rule with the 'dimension' field set to it. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDataplexV1DataQualityDimensionResult - columns: + Optional. The maximum column value allowed for a row to pass this + validation. At least one of min_value and max_value need to be + provided. + type: string + strictMinEnabled: description: >- - Output only. A list of results at the column level.A column will - have a corresponding DataQualityColumnResult if and only if there is - at least one rule with the 'column' field set to it. - readOnly: true - type: array - items: - $ref: '#/components/schemas/GoogleCloudDataplexV1DataQualityColumnResult' - rules: - description: A list of all the rules in a job, and their results. + Optional. Whether each value needs to be strictly greater than ('>') + the minimum, or if equality is allowed.Only relevant if a min_value + has been defined. Default = false. + type: boolean + strictMaxEnabled: + description: >- + Optional. Whether each value needs to be strictly lesser than ('<') + the maximum, or if equality is allowed.Only relevant if a max_value + has been defined. Default = false. + type: boolean + GoogleCloudDataplexV1DataQualityRuleNonNullExpectation: + id: GoogleCloudDataplexV1DataQualityRuleNonNullExpectation + description: Evaluates whether each column value is null. + type: object + properties: {} + GoogleCloudDataplexV1DataQualityRuleSetExpectation: + id: GoogleCloudDataplexV1DataQualityRuleSetExpectation + description: Evaluates whether each column value is contained by a specified set. + type: object + properties: + values: + description: Optional. Expected values for the column value. type: array items: - $ref: '#/components/schemas/GoogleCloudDataplexV1DataQualityRuleResult' - rowCount: - description: The count of rows processed. + type: string + GoogleCloudDataplexV1DataQualityRuleRegexExpectation: + id: GoogleCloudDataplexV1DataQualityRuleRegexExpectation + description: Evaluates whether each column value matches a specified regex. + type: object + properties: + regex: + description: >- + Optional. A regular expression the column value is expected to + match. type: string - format: int64 - scannedData: - description: The data scanned for this result. - $ref: '#/components/schemas/GoogleCloudDataplexV1ScannedData' - postScanActionsResult: - description: Output only. The result of post scan actions. - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudDataplexV1DataQualityResultPostScanActionsResult - GoogleCloudDataplexV1DataQualityDimensionResult: - id: GoogleCloudDataplexV1DataQualityDimensionResult + GoogleCloudDataplexV1DataQualityRuleUniquenessExpectation: + id: GoogleCloudDataplexV1DataQualityRuleUniquenessExpectation + description: Evaluates whether the column has duplicates. + type: object + properties: {} + GoogleCloudDataplexV1DataQualityRuleStatisticRangeExpectation: + id: GoogleCloudDataplexV1DataQualityRuleStatisticRangeExpectation description: >- - DataQualityDimensionResult provides a more detailed, per-dimension view - of the results. + Evaluates whether the column aggregate statistic lies between a + specified range. type: object properties: - dimension: + statistic: + description: Optional. The aggregate metric to evaluate. + type: string + enumDescriptions: + - Unspecified statistic type + - Evaluate the column mean + - Evaluate the column min + - Evaluate the column max + enum: + - STATISTIC_UNDEFINED + - MEAN + - MIN + - MAX + minValue: description: >- - Output only. The dimension config specified in the DataQualitySpec, - as is. - readOnly: true - $ref: '#/components/schemas/GoogleCloudDataplexV1DataQualityDimension' - passed: - description: Whether the dimension passed or failed. + Optional. The minimum column statistic value allowed for a row to + pass this validation.At least one of min_value and max_value need to + be provided. + type: string + maxValue: + description: >- + Optional. The maximum column statistic value allowed for a row to + pass this validation.At least one of min_value and max_value need to + be provided. + type: string + strictMinEnabled: + description: >- + Optional. Whether column statistic needs to be strictly greater than + ('>') the minimum, or if equality is allowed.Only relevant if a + min_value has been defined. Default = false. type: boolean - score: + strictMaxEnabled: description: >- - Output only. The dimension-level data quality score for this data - scan job if and only if the 'dimension' field is set.The score - ranges between 0, 100 (up to two decimal points). - readOnly: true - type: number - format: float - GoogleCloudDataplexV1DataQualityDimension: - id: GoogleCloudDataplexV1DataQualityDimension + Optional. Whether column statistic needs to be strictly lesser than + ('<') the maximum, or if equality is allowed.Only relevant if a + max_value has been defined. Default = false. + type: boolean + GoogleCloudDataplexV1DataQualityRuleRowConditionExpectation: + id: GoogleCloudDataplexV1DataQualityRuleRowConditionExpectation description: >- - A dimension captures data quality intent about a defined subset of the - rules specified. + Evaluates whether each row passes the specified condition.The SQL + expression needs to use GoogleSQL syntax + (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax) + and should produce a boolean value per row as the result.Example: col1 + >= 0 AND col2 < 10 type: object properties: - name: - description: >- - The dimension name a rule belongs to. Supported dimensions are - "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", - "FRESHNESS", "VOLUME" + sqlExpression: + description: Optional. The SQL expression. type: string - GoogleCloudDataplexV1DataQualityColumnResult: - id: GoogleCloudDataplexV1DataQualityColumnResult + GoogleCloudDataplexV1DataQualityRuleTableConditionExpectation: + id: GoogleCloudDataplexV1DataQualityRuleTableConditionExpectation description: >- - DataQualityColumnResult provides a more detailed, per-column view of the - results. + Evaluates whether the provided expression is true.The SQL expression + needs to use GoogleSQL syntax + (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax) + and should produce a scalar boolean result.Example: MIN(col1) >= 0 type: object properties: - column: - description: Output only. The column specified in the DataQualityRule. - readOnly: true + sqlExpression: + description: Optional. The SQL expression. type: string - score: - description: >- - Output only. The column-level data quality score for this data scan - job if and only if the 'column' field is set.The score ranges - between between 0, 100 (up to two decimal points). - readOnly: true - type: number - format: float - GoogleCloudDataplexV1DataQualityRuleResult: - id: GoogleCloudDataplexV1DataQualityRuleResult + GoogleCloudDataplexV1DataQualityRuleSqlAssertion: + id: GoogleCloudDataplexV1DataQualityRuleSqlAssertion description: >- - DataQualityRuleResult provides a more detailed, per-rule view of the - results. + A SQL statement that is evaluated to return rows that match an invalid + state. If any rows are are returned, this rule fails.The SQL statement + must use GoogleSQL syntax + (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax), + and must not contain any semicolons.You can use the data reference + parameter ${data()} to reference the source table with all of its + precondition filters applied. Examples of precondition filters include + row filters, incremental data filters, and sampling. For more + information, see Data reference parameter + (https://cloud.google.com/dataplex/docs/auto-data-quality-overview#data-reference-parameter).Example: + SELECT * FROM ${data()} WHERE price < 0 type: object properties: - rule: - description: The rule specified in the DataQualitySpec, as is. - $ref: '#/components/schemas/GoogleCloudDataplexV1DataQualityRule' - passed: - description: Whether the rule passed or failed. - type: boolean - evaluatedCount: - description: >- - The number of rows a rule was evaluated against.This field is only - valid for row-level type rules.Evaluated count can be configured to - either include all rows (default) - with null rows automatically - failing rule evaluation, or exclude null rows from the - evaluated_count, by setting ignore_nulls = true. - type: string - format: int64 - passedCount: - description: >- - The number of rows which passed a rule evaluation.This field is only - valid for row-level type rules. - type: string - format: int64 - nullCount: - description: The number of rows with null values in the specified column. - type: string - format: int64 - passRatio: - description: >- - The ratio of passed_count / evaluated_count.This field is only valid - for row-level type rules. - type: number - format: double - failingRowsQuery: - description: >- - The query to find rows that did not pass this rule.This field is - only valid for row-level type rules. - type: string - assertionRowCount: - description: >- - Output only. The number of rows returned by the SQL statement in a - SQL assertion rule.This field is only valid for SQL assertion rules. - readOnly: true + sqlStatement: + description: Optional. The SQL statement. type: string - format: int64 - GoogleCloudDataplexV1ScannedData: - id: GoogleCloudDataplexV1ScannedData - description: The data scanned during processing (e.g. in incremental DataScan) + GoogleCloudDataplexV1DataQualitySpecPostScanActions: + id: GoogleCloudDataplexV1DataQualitySpecPostScanActions + description: The configuration of post scan actions of DataQualityScan. type: object properties: - incrementalField: - description: The range denoted by values of an incremental field + bigqueryExport: + description: >- + Optional. If set, results will be exported to the provided BigQuery + table. $ref: >- - #/components/schemas/GoogleCloudDataplexV1ScannedDataIncrementalField - GoogleCloudDataplexV1ScannedDataIncrementalField: - id: GoogleCloudDataplexV1ScannedDataIncrementalField - description: A data range denoted by a pair of start/end values of a field. + #/components/schemas/GoogleCloudDataplexV1DataQualitySpecPostScanActionsBigQueryExport + notificationReport: + description: >- + Optional. If set, results will be sent to the provided notification + receipts upon triggers. + $ref: >- + #/components/schemas/GoogleCloudDataplexV1DataQualitySpecPostScanActionsNotificationReport + GoogleCloudDataplexV1DataQualitySpecPostScanActionsBigQueryExport: + id: GoogleCloudDataplexV1DataQualitySpecPostScanActionsBigQueryExport + description: The configuration of BigQuery export post scan action. type: object properties: - field: + resultsTable: description: >- - The field that contains values which monotonically increases over - time (e.g. a timestamp column). - type: string - start: - description: Value that marks the start of the range. - type: string - end: - description: Value that marks the end of the range. + Optional. The BigQuery table to export DataQualityScan results to. + Format: + //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID + or projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID type: string - GoogleCloudDataplexV1DataQualityResultPostScanActionsResult: - id: GoogleCloudDataplexV1DataQualityResultPostScanActionsResult - description: The result of post scan actions of DataQualityScan job. + GoogleCloudDataplexV1DataQualitySpecPostScanActionsNotificationReport: + id: GoogleCloudDataplexV1DataQualitySpecPostScanActionsNotificationReport + description: The configuration of notification report post scan action. type: object properties: - bigqueryExportResult: - description: Output only. The result of BigQuery export post scan action. - readOnly: true + recipients: + description: Required. The recipients who will receive the notification report. $ref: >- - #/components/schemas/GoogleCloudDataplexV1DataQualityResultPostScanActionsResultBigQueryExportResult - GoogleCloudDataplexV1DataQualityResultPostScanActionsResultBigQueryExportResult: - id: >- - GoogleCloudDataplexV1DataQualityResultPostScanActionsResultBigQueryExportResult - description: The result of BigQuery export post scan action. - type: object - properties: - state: - description: Output only. Execution state for the BigQuery exporting. - readOnly: true - type: string - enumDescriptions: - - The exporting state is unspecified. - - The exporting completed successfully. - - The exporting is no longer running due to an error. - - >- - The exporting is skipped due to no valid scan result to export - (usually caused by scan failed). - enum: - - STATE_UNSPECIFIED - - SUCCEEDED - - FAILED - - SKIPPED - message: - description: Output only. Additional information about the BigQuery exporting. - readOnly: true - type: string - GoogleCloudDataplexV1DataProfileResult: - id: GoogleCloudDataplexV1DataProfileResult - description: >- - DataProfileResult defines the output of DataProfileScan. Each field of - the table will have field type specific profile result. - type: object - properties: - rowCount: - description: The count of rows scanned. - type: string - format: int64 - profile: - description: The profile information per field. - $ref: '#/components/schemas/GoogleCloudDataplexV1DataProfileResultProfile' - scannedData: - description: The data scanned for this result. - $ref: '#/components/schemas/GoogleCloudDataplexV1ScannedData' - postScanActionsResult: - description: Output only. The result of post scan actions. - readOnly: true + #/components/schemas/GoogleCloudDataplexV1DataQualitySpecPostScanActionsRecipients + scoreThresholdTrigger: + description: Optional. If set, report will be sent when score threshold is met. $ref: >- - #/components/schemas/GoogleCloudDataplexV1DataProfileResultPostScanActionsResult - GoogleCloudDataplexV1DataProfileResultProfile: - id: GoogleCloudDataplexV1DataProfileResultProfile - description: Contains name, type, mode and field type specific profile information. + #/components/schemas/GoogleCloudDataplexV1DataQualitySpecPostScanActionsScoreThresholdTrigger + jobFailureTrigger: + description: Optional. If set, report will be sent when a scan job fails. + $ref: >- + #/components/schemas/GoogleCloudDataplexV1DataQualitySpecPostScanActionsJobFailureTrigger + jobEndTrigger: + description: Optional. If set, report will be sent when a scan job ends. + $ref: >- + #/components/schemas/GoogleCloudDataplexV1DataQualitySpecPostScanActionsJobEndTrigger + GoogleCloudDataplexV1DataQualitySpecPostScanActionsRecipients: + id: GoogleCloudDataplexV1DataQualitySpecPostScanActionsRecipients + description: >- + The individuals or groups who are designated to receive notifications + upon triggers. type: object properties: - fields: + emails: description: >- - List of fields with structural and profile information for each - field. + Optional. The email recipients who will receive the DataQualityScan + results report. type: array items: - $ref: >- - #/components/schemas/GoogleCloudDataplexV1DataProfileResultProfileField - GoogleCloudDataplexV1DataProfileResultProfileField: - id: GoogleCloudDataplexV1DataProfileResultProfileField - description: A field within a table. + type: string + GoogleCloudDataplexV1DataQualitySpecPostScanActionsScoreThresholdTrigger: + id: GoogleCloudDataplexV1DataQualitySpecPostScanActionsScoreThresholdTrigger + description: >- + This trigger is triggered when the DQ score in the job result is less + than a specified input score. type: object properties: - name: - description: The name of the field. - type: string - type: - description: >- - The data type retrieved from the schema of the data source. For - instance, for a BigQuery native table, it is the BigQuery Table - Schema - (https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#tablefieldschema). - For a Dataplex Entity, it is the Entity Schema - (https://cloud.google.com/dataplex/docs/reference/rpc/google.cloud.dataplex.v1#type_3). - type: string - mode: - description: >- - The mode of the field. Possible values include: REQUIRED, if it is a - required field. NULLABLE, if it is an optional field. REPEATED, if - it is a repeated field. - type: string - profile: - description: Profile information for the corresponding field. - $ref: >- - #/components/schemas/GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfo - GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfo: - id: GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfo - description: The profile information for each field type. + scoreThreshold: + description: Optional. The score range is in 0,100. + type: number + format: float + GoogleCloudDataplexV1DataQualitySpecPostScanActionsJobFailureTrigger: + id: GoogleCloudDataplexV1DataQualitySpecPostScanActionsJobFailureTrigger + description: >- + This trigger is triggered when the scan job itself fails, regardless of + the result. + type: object + properties: {} + GoogleCloudDataplexV1DataQualitySpecPostScanActionsJobEndTrigger: + id: GoogleCloudDataplexV1DataQualitySpecPostScanActionsJobEndTrigger + description: >- + This trigger is triggered whenever a scan job run ends, regardless of + the result. + type: object + properties: {} + GoogleCloudDataplexV1DataProfileSpec: + id: GoogleCloudDataplexV1DataProfileSpec + description: DataProfileScan related setting. type: object properties: - nullRatio: - description: Ratio of rows with null value against total scanned rows. - type: number - format: double - distinctRatio: + samplingPercent: description: >- - Ratio of rows with distinct values against total scanned rows. Not - available for complex non-groupable field type, including RECORD, - ARRAY, GEOGRAPHY, and JSON, as well as fields with REPEATABLE mode. + Optional. The percentage of the records to be selected from the + dataset for DataScan. Value can range between 0.0 and 100.0 with up + to 3 significant decimal digits. Sampling is not applied if + sampling_percent is not specified, 0 or 100. type: number - format: double - topNValues: + format: float + rowFilter: description: >- - The list of top N non-null values, frequency and ratio with which - they occur in the scanned data. N is 10 or equal to the number of - distinct values in the field, whichever is smaller. Not available - for complex non-groupable field type, including RECORD, ARRAY, - GEOGRAPHY, and JSON, as well as fields with REPEATABLE mode. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoTopNValue - stringProfile: - description: String type field information. + Optional. A filter applied to all rows in a single DataScan job. The + filter needs to be a valid SQL expression for a WHERE clause in + BigQuery standard SQL syntax. Example: col1 >= 0 AND col2 < 10 + type: string + postScanActions: + description: Optional. Actions to take upon job completion.. $ref: >- - #/components/schemas/GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoStringFieldInfo - integerProfile: - description: Integer type field information. + #/components/schemas/GoogleCloudDataplexV1DataProfileSpecPostScanActions + includeFields: + description: >- + Optional. The fields to include in data profile.If not specified, + all fields at the time of profile scan job execution are included, + except for ones listed in exclude_fields. $ref: >- - #/components/schemas/GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoIntegerFieldInfo - doubleProfile: - description: Double type field information. + #/components/schemas/GoogleCloudDataplexV1DataProfileSpecSelectedFields + excludeFields: + description: >- + Optional. The fields to exclude from data profile.If specified, the + fields will be excluded from data profile, regardless of + include_fields value. $ref: >- - #/components/schemas/GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoDoubleFieldInfo - GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoTopNValue: - id: GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoTopNValue - description: Top N non-null values in the scanned data. + #/components/schemas/GoogleCloudDataplexV1DataProfileSpecSelectedFields + GoogleCloudDataplexV1DataProfileSpecPostScanActions: + id: GoogleCloudDataplexV1DataProfileSpecPostScanActions + description: The configuration of post scan actions of DataProfileScan job. type: object properties: - value: - description: String value of a top N non-null value. - type: string - count: - description: Count of the corresponding value in the scanned data. - type: string - format: int64 - ratio: + bigqueryExport: description: >- - Ratio of the corresponding value in the field against the total - number of rows in the scanned data. - type: number - format: double - GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoStringFieldInfo: - id: >- - GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoStringFieldInfo - description: The profile information for a string type field. + Optional. If set, results will be exported to the provided BigQuery + table. + $ref: >- + #/components/schemas/GoogleCloudDataplexV1DataProfileSpecPostScanActionsBigQueryExport + GoogleCloudDataplexV1DataProfileSpecPostScanActionsBigQueryExport: + id: GoogleCloudDataplexV1DataProfileSpecPostScanActionsBigQueryExport + description: The configuration of BigQuery export post scan action. type: object properties: - minLength: - description: Minimum length of non-null values in the scanned data. - type: string - format: int64 - maxLength: - description: Maximum length of non-null values in the scanned data. + resultsTable: + description: >- + Optional. The BigQuery table to export DataProfileScan results to. + Format: + //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID type: string - format: int64 - averageLength: - description: Average length of non-null values in the scanned data. - type: number - format: double - GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoIntegerFieldInfo: - id: >- - GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoIntegerFieldInfo - description: The profile information for an integer type field. + GoogleCloudDataplexV1DataProfileSpecSelectedFields: + id: GoogleCloudDataplexV1DataProfileSpecSelectedFields + description: The specification for fields to include or exclude in data profile scan. type: object properties: - average: - description: >- - Average of non-null values in the scanned data. NaN, if the field - has a NaN. - type: number - format: double - standardDeviation: - description: >- - Standard deviation of non-null values in the scanned data. NaN, if - the field has a NaN. - type: number - format: double - min: - description: >- - Minimum of non-null values in the scanned data. NaN, if the field - has a NaN. - type: string - format: int64 - quartiles: + fieldNames: description: >- - A quartile divides the number of data points into four parts, or - quarters, of more-or-less equal size. Three main quartiles used are: - The first quartile (Q1) splits off the lowest 25% of data from the - highest 75%. It is also known as the lower or 25th empirical - quartile, as 25% of the data is below this point. The second - quartile (Q2) is the median of a data set. So, 50% of the data lies - below this point. The third quartile (Q3) splits off the highest 25% - of data from the lowest 75%. It is known as the upper or 75th - empirical quartile, as 75% of the data lies below this point. Here, - the quartiles is provided as an ordered list of approximate quartile - values for the scanned data, occurring in order Q1, median, Q3. + Optional. Expected input is a list of fully qualified names of + fields as in the schema.Only top-level field names for nested fields + are supported. For instance, if 'x' is of nested field type, listing + 'x' is supported but 'x.y.z' is not supported. Here 'y' and 'y.z' + are nested fields of 'x'. type: array items: type: string - format: int64 - max: - description: >- - Maximum of non-null values in the scanned data. NaN, if the field - has a NaN. - type: string - format: int64 - GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoDoubleFieldInfo: - id: >- - GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoDoubleFieldInfo - description: The profile information for a double type field. + GoogleCloudDataplexV1DataDiscoverySpec: + id: GoogleCloudDataplexV1DataDiscoverySpec + description: Spec for a data discovery scan. type: object properties: - average: + bigqueryPublishingConfig: + description: Optional. Configuration for metadata publishing. + $ref: >- + #/components/schemas/GoogleCloudDataplexV1DataDiscoverySpecBigQueryPublishingConfig + storageConfig: + description: Cloud Storage related configurations. + $ref: >- + #/components/schemas/GoogleCloudDataplexV1DataDiscoverySpecStorageConfig + GoogleCloudDataplexV1DataDiscoverySpecBigQueryPublishingConfig: + id: GoogleCloudDataplexV1DataDiscoverySpecBigQueryPublishingConfig + description: Describes BigQuery publishing configurations. + type: object + properties: + tableType: description: >- - Average of non-null values in the scanned data. NaN, if the field - has a NaN. - type: number - format: double - standardDeviation: - description: >- - Standard deviation of non-null values in the scanned data. NaN, if - the field has a NaN. - type: number - format: double - min: - description: >- - Minimum of non-null values in the scanned data. NaN, if the field - has a NaN. - type: number - format: double - quartiles: - description: >- - A quartile divides the number of data points into four parts, or - quarters, of more-or-less equal size. Three main quartiles used are: - The first quartile (Q1) splits off the lowest 25% of data from the - highest 75%. It is also known as the lower or 25th empirical - quartile, as 25% of the data is below this point. The second - quartile (Q2) is the median of a data set. So, 50% of the data lies - below this point. The third quartile (Q3) splits off the highest 25% - of data from the lowest 75%. It is known as the upper or 75th - empirical quartile, as 75% of the data lies below this point. Here, - the quartiles is provided as an ordered list of quartile values for - the scanned data, occurring in order Q1, median, Q3. - type: array - items: - type: number - format: double - max: - description: >- - Maximum of non-null values in the scanned data. NaN, if the field - has a NaN. - type: number - format: double - GoogleCloudDataplexV1DataProfileResultPostScanActionsResult: - id: GoogleCloudDataplexV1DataProfileResultPostScanActionsResult - description: The result of post scan actions of DataProfileScan job. - type: object - properties: - bigqueryExportResult: - description: Output only. The result of BigQuery export post scan action. - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudDataplexV1DataProfileResultPostScanActionsResultBigQueryExportResult - GoogleCloudDataplexV1DataProfileResultPostScanActionsResultBigQueryExportResult: - id: >- - GoogleCloudDataplexV1DataProfileResultPostScanActionsResultBigQueryExportResult - description: The result of BigQuery export post scan action. - type: object - properties: - state: - description: Output only. Execution state for the BigQuery exporting. - readOnly: true + Optional. Determines whether to publish discovered tables as BigLake + external tables or non-BigLake external tables. type: string enumDescriptions: - - The exporting state is unspecified. - - The exporting completed successfully. - - The exporting is no longer running due to an error. + - Table type unspecified. - >- - The exporting is skipped due to no valid scan result to export - (usually caused by scan failed). + Default. Discovered tables are published as BigQuery external + tables whose data is accessed using the credentials of the user + querying the table. + - >- + Discovered tables are published as BigLake external tables whose + data is accessed using the credentials of the associated BigQuery + connection. enum: - - STATE_UNSPECIFIED - - SUCCEEDED - - FAILED - - SKIPPED - message: - description: Output only. Additional information about the BigQuery exporting. - readOnly: true + - TABLE_TYPE_UNSPECIFIED + - EXTERNAL + - BIGLAKE + connection: + description: >- + Optional. The BigQuery connection used to create BigLake tables. + Must be in the form + projects/{project_id}/locations/{location_id}/connections/{connection_id} type: string - GoogleCloudDataplexV1DataDiscoveryResult: - id: GoogleCloudDataplexV1DataDiscoveryResult - description: The output of a data discovery scan. - type: object - properties: - bigqueryPublishing: - description: Output only. Configuration for metadata publishing. - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudDataplexV1DataDiscoveryResultBigQueryPublishing - GoogleCloudDataplexV1DataDiscoveryResultBigQueryPublishing: - id: GoogleCloudDataplexV1DataDiscoveryResultBigQueryPublishing - description: Describes BigQuery publishing configurations. - type: object - properties: - dataset: + location: description: >- - Output only. The BigQuery dataset to publish to. It takes the form - projects/{project_id}/datasets/{dataset_id}. If not set, the service - creates a default publishing dataset. - readOnly: true + Optional. The location of the BigQuery dataset to publish BigLake + external or non-BigLake external tables to. 1. If the Cloud Storage + bucket is located in a multi-region bucket, then BigQuery dataset + can be in the same multi-region bucket or any single region that is + included in the same multi-region bucket. The datascan can be + created in any single region that is included in the same + multi-region bucket 2. If the Cloud Storage bucket is located in a + dual-region bucket, then BigQuery dataset can be located in regions + that are included in the dual-region bucket, or in a multi-region + that includes the dual-region. The datascan can be created in any + single region that is included in the same dual-region bucket. 3. If + the Cloud Storage bucket is located in a single region, then + BigQuery dataset can be in the same single region or any + multi-region bucket that includes the same single region. The + datascan will be created in the same single region as the bucket. 4. + If the BigQuery dataset is in single region, it must be in the same + single region as the datascan.For supported values, refer to + https://cloud.google.com/bigquery/docs/locations#supported_locations. type: string - GoogleCloudDataplexV1ListDataScansResponse: - id: GoogleCloudDataplexV1ListDataScansResponse - description: List dataScans response. + project: + description: >- + Optional. The project of the BigQuery dataset to publish BigLake + external or non-BigLake external tables to. If not specified, the + project of the Cloud Storage bucket will be used. The format is + "projects/{project_id_or_number}". + type: string + GoogleCloudDataplexV1DataDiscoverySpecStorageConfig: + id: GoogleCloudDataplexV1DataDiscoverySpecStorageConfig + description: Configurations related to Cloud Storage as the data source. type: object properties: - dataScans: - description: DataScans (BASIC view only) under the given parent location. + includePatterns: + description: >- + Optional. Defines the data to include during discovery when only a + subset of the data should be considered. Provide a list of patterns + that identify the data to include. For Cloud Storage bucket assets, + these patterns are interpreted as glob patterns used to match object + names. For BigQuery dataset assets, these patterns are interpreted + as patterns to match table names. type: array items: - $ref: '#/components/schemas/GoogleCloudDataplexV1DataScan' - nextPageToken: + type: string + excludePatterns: description: >- - Token to retrieve the next page of results, or empty if there are no - more results in the list. - type: string - unreachable: - description: Locations that could not be reached. + Optional. Defines the data to exclude during discovery. Provide a + list of patterns that identify the data to exclude. For Cloud + Storage bucket assets, these patterns are interpreted as glob + patterns used to match object names. For BigQuery dataset assets, + these patterns are interpreted as patterns to match table names. type: array items: type: string - GoogleCloudDataplexV1RunDataScanRequest: - id: GoogleCloudDataplexV1RunDataScanRequest - description: Run DataScan Request + csvOptions: + description: Optional. Configuration for CSV data. + $ref: >- + #/components/schemas/GoogleCloudDataplexV1DataDiscoverySpecStorageConfigCsvOptions + jsonOptions: + description: Optional. Configuration for JSON data. + $ref: >- + #/components/schemas/GoogleCloudDataplexV1DataDiscoverySpecStorageConfigJsonOptions + GoogleCloudDataplexV1DataDiscoverySpecStorageConfigCsvOptions: + id: GoogleCloudDataplexV1DataDiscoverySpecStorageConfigCsvOptions + description: Describes CSV and similar semi-structured data formats. type: object - properties: {} - GoogleCloudDataplexV1RunDataScanResponse: - id: GoogleCloudDataplexV1RunDataScanResponse - description: Run DataScan Response. + properties: + headerRows: + description: >- + Optional. The number of rows to interpret as header rows that should + be skipped when reading data rows. + type: integer + format: int32 + delimiter: + description: >- + Optional. The delimiter that is used to separate values. The default + is , (comma). + type: string + encoding: + description: Optional. The character encoding of the data. The default is UTF-8. + type: string + typeInferenceDisabled: + description: >- + Optional. Whether to disable the inference of data types for CSV + data. If true, all columns are registered as strings. + type: boolean + quote: + description: >- + Optional. The character used to quote column values. Accepts " + (double quotation mark) or ' (single quotation mark). If + unspecified, defaults to " (double quotation mark). + type: string + GoogleCloudDataplexV1DataDiscoverySpecStorageConfigJsonOptions: + id: GoogleCloudDataplexV1DataDiscoverySpecStorageConfigJsonOptions + description: Describes JSON data format. type: object properties: - job: - description: DataScanJob created by RunDataScan request. - $ref: '#/components/schemas/GoogleCloudDataplexV1DataScanJob' - GoogleCloudDataplexV1DataScanJob: - id: GoogleCloudDataplexV1DataScanJob - description: A DataScanJob represents an instance of DataScan execution. + encoding: + description: Optional. The character encoding of the data. The default is UTF-8. + type: string + typeInferenceDisabled: + description: >- + Optional. Whether to disable the inference of data types for JSON + data. If true, all columns are registered as their primitive types + (strings, number, or boolean). + type: boolean + GoogleCloudDataplexV1DataQualityResult: + id: GoogleCloudDataplexV1DataQualityResult + description: The output of a DataQualityScan. type: object properties: - name: + passed: description: >- - Output only. The relative resource name of the DataScanJob, of the - form: - projects/{project}/locations/{location_id}/dataScans/{datascan_id}/jobs/{job_id}, - where project refers to a project_id or project_number and - location_id refers to a GCP region. + Output only. Overall data quality result -- true if all rules + passed. readOnly: true - type: string - uid: + type: boolean + score: description: >- - Output only. System generated globally unique ID for the - DataScanJob. + Output only. The overall data quality score.The score ranges between + 0, 100 (up to two decimal points). readOnly: true - type: string - createTime: - description: Output only. The time when the DataScanJob was created. + type: number + format: float + dimensions: + description: >- + Output only. A list of results at the dimension level.A dimension + will have a corresponding DataQualityDimensionResult if and only if + there is at least one rule with the 'dimension' field set to it. readOnly: true - type: string - format: google-datetime - startTime: - description: Output only. The time when the DataScanJob was started. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDataplexV1DataQualityDimensionResult + columns: + description: >- + Output only. A list of results at the column level.A column will + have a corresponding DataQualityColumnResult if and only if there is + at least one rule with the 'column' field set to it. readOnly: true - type: string - format: google-datetime - endTime: - description: Output only. The time when the DataScanJob ended. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDataplexV1DataQualityColumnResult' + rules: + description: Output only. A list of all the rules in a job, and their results. readOnly: true - type: string - format: google-datetime - state: - description: Output only. Execution state for the DataScanJob. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDataplexV1DataQualityRuleResult' + rowCount: + description: Output only. The count of rows processed. readOnly: true type: string - enumDescriptions: - - The DataScanJob state is unspecified. - - The DataScanJob is running. - - The DataScanJob is canceling. - - The DataScanJob cancellation was successful. - - The DataScanJob completed successfully. - - The DataScanJob is no longer running due to an error. - - The DataScanJob has been created but not started to run yet. - enum: - - STATE_UNSPECIFIED - - RUNNING - - CANCELING - - CANCELLED - - SUCCEEDED - - FAILED - - PENDING - message: - description: Output only. Additional information about the current state. + format: int64 + scannedData: + description: Output only. The data scanned for this result. readOnly: true - type: string - type: - description: Output only. The type of the parent DataScan. - readOnly: true - type: string - enumDescriptions: - - The data scan type is unspecified. - - Data quality scan. - - Data profile scan. - - Data discovery scan. - enum: - - DATA_SCAN_TYPE_UNSPECIFIED - - DATA_QUALITY - - DATA_PROFILE - - DATA_DISCOVERY - dataQualitySpec: - description: Output only. Settings for a data quality scan. - readOnly: true - $ref: '#/components/schemas/GoogleCloudDataplexV1DataQualitySpec' - dataProfileSpec: - description: Output only. Settings for a data profile scan. + $ref: '#/components/schemas/GoogleCloudDataplexV1ScannedData' + postScanActionsResult: + description: Output only. The result of post scan actions. readOnly: true - $ref: '#/components/schemas/GoogleCloudDataplexV1DataProfileSpec' - dataDiscoverySpec: - description: Output only. Settings for a data discovery scan. + $ref: >- + #/components/schemas/GoogleCloudDataplexV1DataQualityResultPostScanActionsResult + catalogPublishingStatus: + description: >- + Output only. The status of publishing the data scan as Dataplex + Universal Catalog metadata. readOnly: true - $ref: '#/components/schemas/GoogleCloudDataplexV1DataDiscoverySpec' - dataQualityResult: - description: Output only. The result of a data quality scan. + $ref: >- + #/components/schemas/GoogleCloudDataplexV1DataScanCatalogPublishingStatus + GoogleCloudDataplexV1DataQualityDimensionResult: + id: GoogleCloudDataplexV1DataQualityDimensionResult + description: >- + DataQualityDimensionResult provides a more detailed, per-dimension view + of the results. + type: object + properties: + dimension: + description: >- + Output only. The dimension config specified in the DataQualitySpec, + as is. readOnly: true - $ref: '#/components/schemas/GoogleCloudDataplexV1DataQualityResult' - dataProfileResult: - description: Output only. The result of a data profile scan. + $ref: '#/components/schemas/GoogleCloudDataplexV1DataQualityDimension' + passed: + description: Output only. Whether the dimension passed or failed. readOnly: true - $ref: '#/components/schemas/GoogleCloudDataplexV1DataProfileResult' - dataDiscoveryResult: - description: Output only. The result of a data discovery scan. + type: boolean + score: + description: >- + Output only. The dimension-level data quality score for this data + scan job if and only if the 'dimension' field is set.The score + ranges between 0, 100 (up to two decimal points). readOnly: true - $ref: '#/components/schemas/GoogleCloudDataplexV1DataDiscoveryResult' - GoogleCloudDataplexV1ListDataScanJobsResponse: - id: GoogleCloudDataplexV1ListDataScanJobsResponse - description: List DataScanJobs response. + type: number + format: float + GoogleCloudDataplexV1DataQualityDimension: + id: GoogleCloudDataplexV1DataQualityDimension + description: >- + A dimension captures data quality intent about a defined subset of the + rules specified. type: object properties: - dataScanJobs: - description: DataScanJobs (BASIC view only) under a given dataScan. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDataplexV1DataScanJob' - nextPageToken: + name: description: >- - Token to retrieve the next page of results, or empty if there are no - more results in the list. + Output only. The dimension name a rule belongs to. Custom dimension + name is supported with all uppercase letters and maximum length of + 30 characters. + readOnly: true type: string - GoogleCloudDataplexV1GenerateDataQualityRulesRequest: - id: GoogleCloudDataplexV1GenerateDataQualityRulesRequest - description: Request details for generating data quality rule recommendations. - type: object - properties: {} - GoogleCloudDataplexV1GenerateDataQualityRulesResponse: - id: GoogleCloudDataplexV1GenerateDataQualityRulesResponse - description: Response details for data quality rule recommendations. + GoogleCloudDataplexV1DataQualityColumnResult: + id: GoogleCloudDataplexV1DataQualityColumnResult + description: >- + DataQualityColumnResult provides a more detailed, per-column view of the + results. type: object properties: - rule: + column: + description: Output only. The column specified in the DataQualityRule. + readOnly: true + type: string + score: description: >- - The data quality rules that Dataplex generates based on the results - of a data profiling scan. + Output only. The column-level data quality score for this data scan + job if and only if the 'column' field is set.The score ranges + between between 0, 100 (up to two decimal points). + readOnly: true + type: number + format: float + passed: + description: Output only. Whether the column passed or failed. + readOnly: true + type: boolean + dimensions: + description: Output only. The dimension-level results for this column. + readOnly: true type: array items: - $ref: '#/components/schemas/GoogleCloudDataplexV1DataQualityRule' - GoogleCloudDataplexV1Entity: - id: GoogleCloudDataplexV1Entity - description: Represents tables and fileset metadata contained within a zone. + $ref: >- + #/components/schemas/GoogleCloudDataplexV1DataQualityDimensionResult + GoogleCloudDataplexV1DataQualityRuleResult: + id: GoogleCloudDataplexV1DataQualityRuleResult + description: >- + DataQualityRuleResult provides a more detailed, per-rule view of the + results. type: object properties: - name: - description: >- - Output only. The resource name of the entity, of the form: - projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{id}. + rule: + description: Output only. The rule specified in the DataQualitySpec, as is. readOnly: true - type: string - displayName: + $ref: '#/components/schemas/GoogleCloudDataplexV1DataQualityRule' + passed: + description: Output only. Whether the rule passed or failed. + readOnly: true + type: boolean + evaluatedCount: description: >- - Optional. Display name must be shorter than or equal to 256 - characters. + Output only. The number of rows a rule was evaluated against.This + field is only valid for row-level type rules.Evaluated count can be + configured to either include all rows (default) - with null rows + automatically failing rule evaluation, or exclude null rows from the + evaluated_count, by setting ignore_nulls = true.This field is not + set for rule SqlAssertion. + readOnly: true type: string - description: + format: int64 + passedCount: description: >- - Optional. User friendly longer description text. Must be shorter - than or equal to 1024 characters. - type: string - createTime: - description: Output only. The time when the entity was created. + Output only. The number of rows which passed a rule evaluation.This + field is only valid for row-level type rules.This field is not set + for rule SqlAssertion. readOnly: true type: string - format: google-datetime - updateTime: - description: Output only. The time when the entity was last updated. + format: int64 + nullCount: + description: >- + Output only. The number of rows with null values in the specified + column. readOnly: true type: string - format: google-datetime - id: + format: int64 + passRatio: description: >- - Required. A user-provided entity ID. It is mutable, and will be used - as the published table name. Specifying a new ID in an update entity - request will override the existing value. The ID must contain only - letters (a-z, A-Z), numbers (0-9), and underscores, and consist of - 256 or fewer characters. - type: string - etag: + Output only. The ratio of passed_count / evaluated_count.This field + is only valid for row-level type rules. + readOnly: true + type: number + format: double + failingRowsQuery: description: >- - Optional. The etag associated with the entity, which can be - retrieved with a GetEntity request. Required for update and delete - requests. - type: string - type: - description: Required. Immutable. The type of entity. + Output only. The query to find rows that did not pass this rule.This + field is only valid for row-level type rules. + readOnly: true type: string - enumDescriptions: - - Type unspecified. - - Structured and semi-structured data. - - Unstructured data. - enum: - - TYPE_UNSPECIFIED - - TABLE - - FILESET - asset: + assertionRowCount: description: >- - Required. Immutable. The ID of the asset associated with the storage - location containing the entity data. The entity must be with in the - same zone with the asset. + Output only. The number of rows returned by the SQL statement in a + SQL assertion rule.This field is only valid for SQL assertion rules. + readOnly: true type: string - dataPath: + format: int64 + GoogleCloudDataplexV1ScannedData: + id: GoogleCloudDataplexV1ScannedData + description: The data scanned during processing (e.g. in incremental DataScan) + type: object + properties: + incrementalField: + description: The range denoted by values of an incremental field + $ref: >- + #/components/schemas/GoogleCloudDataplexV1ScannedDataIncrementalField + GoogleCloudDataplexV1ScannedDataIncrementalField: + id: GoogleCloudDataplexV1ScannedDataIncrementalField + description: A data range denoted by a pair of start/end values of a field. + type: object + properties: + field: description: >- - Required. Immutable. The storage path of the entity data. For Cloud - Storage data, this is the fully-qualified path to the entity, such - as gs://bucket/path/to/data. For BigQuery data, this is the name of - the table resource, such as - projects/project_id/datasets/dataset_id/tables/table_id. + Output only. The field that contains values which monotonically + increases over time (e.g. a timestamp column). + readOnly: true type: string - dataPathPattern: - description: >- - Optional. The set of items within the data path constituting the - data in the entity, represented as a glob path. Example: - gs://bucket/path/to/data/**/*.csv. + start: + description: Output only. Value that marks the start of the range. + readOnly: true type: string - catalogEntry: - description: Output only. The name of the associated Data Catalog entry. + end: + description: Output only. Value that marks the end of the range. readOnly: true type: string - system: - description: >- - Required. Immutable. Identifies the storage system of the entity - data. + GoogleCloudDataplexV1DataQualityResultPostScanActionsResult: + id: GoogleCloudDataplexV1DataQualityResultPostScanActionsResult + description: The result of post scan actions of DataQualityScan job. + type: object + properties: + bigqueryExportResult: + description: Output only. The result of BigQuery export post scan action. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudDataplexV1DataQualityResultPostScanActionsResultBigQueryExportResult + GoogleCloudDataplexV1DataQualityResultPostScanActionsResultBigQueryExportResult: + id: >- + GoogleCloudDataplexV1DataQualityResultPostScanActionsResultBigQueryExportResult + description: The result of BigQuery export post scan action. + type: object + properties: + state: + description: Output only. Execution state for the BigQuery exporting. + readOnly: true type: string enumDescriptions: - - Storage system unspecified. - - The entity data is contained within a Cloud Storage bucket. - - The entity data is contained within a BigQuery dataset. + - The exporting state is unspecified. + - The exporting completed successfully. + - The exporting is no longer running due to an error. + - >- + The exporting is skipped due to no valid scan result to export + (usually caused by scan failed). enum: - - STORAGE_SYSTEM_UNSPECIFIED - - CLOUD_STORAGE - - BIGQUERY - format: - description: >- - Required. Identifies the storage format of the entity data. It does - not apply to entities with data stored in BigQuery. - $ref: '#/components/schemas/GoogleCloudDataplexV1StorageFormat' - compatibility: - description: Output only. Metadata stores that the entity is compatible with. - readOnly: true - $ref: '#/components/schemas/GoogleCloudDataplexV1EntityCompatibilityStatus' - access: - description: >- - Output only. Identifies the access mechanism to the entity. Not user - settable. - readOnly: true - $ref: '#/components/schemas/GoogleCloudDataplexV1StorageAccess' - uid: - description: >- - Output only. System generated unique ID for the Entity. This ID will - be different if the Entity is deleted and re-created with the same - name. + - STATE_UNSPECIFIED + - SUCCEEDED + - FAILED + - SKIPPED + message: + description: Output only. Additional information about the BigQuery exporting. readOnly: true type: string - schema: - description: >- - Required. The description of the data structure and layout. The - schema is not included in list responses. It is only included in - SCHEMA and FULL entity views of a GetEntity response. - $ref: '#/components/schemas/GoogleCloudDataplexV1Schema' - GoogleCloudDataplexV1StorageFormat: - id: GoogleCloudDataplexV1StorageFormat - description: Describes the format of the data within its storage location. + GoogleCloudDataplexV1DataScanCatalogPublishingStatus: + id: GoogleCloudDataplexV1DataScanCatalogPublishingStatus + description: >- + The status of publishing the data scan result as Dataplex Universal + Catalog metadata. type: object properties: - format: - description: >- - Output only. The data format associated with the stored data, which - represents content type values. The value is inferred from mime - type. + state: + description: Output only. Execution state for catalog publishing. readOnly: true type: string enumDescriptions: - - Format unspecified. - - Parquet-formatted structured data. - - Avro-formatted structured data. - - Orc-formatted structured data. - - Csv-formatted semi-structured data. - - Json-formatted semi-structured data. - - Image data formats (such as jpg and png). - - Audio data formats (such as mp3, and wav). - - Video data formats (such as mp4 and mpg). - - Textual data formats (such as txt and xml). - - TensorFlow record format. - - Data that doesn't match a specific format. - - Data of an unknown format. - enum: - - FORMAT_UNSPECIFIED - - PARQUET - - AVRO - - ORC - - CSV - - JSON - - IMAGE - - AUDIO - - VIDEO - - TEXT - - TFRECORD - - OTHER - - UNKNOWN - compressionFormat: - description: >- - Optional. The compression type associated with the stored data. If - unspecified, the data is uncompressed. - type: string - enumDescriptions: - - CompressionFormat unspecified. Implies uncompressed data. - - GZip compressed set of files. - - BZip2 compressed set of files. + - The publishing state is unspecified. + - Publish to catalog completed successfully. + - Publish to catalog failed. enum: - - COMPRESSION_FORMAT_UNSPECIFIED - - GZIP - - BZIP2 - mimeType: - description: >- - Required. The mime type descriptor for the data. Must match the - pattern {type}/{subtype}. Supported values: application/x-parquet - application/x-avro application/x-orc application/x-tfrecord - application/x-parquet+iceberg application/x-avro+iceberg - application/x-orc+iceberg application/json application/{subtypes} - text/csv text/ image/{image subtype} video/{video subtype} - audio/{audio subtype} + - STATE_UNSPECIFIED + - SUCCEEDED + - FAILED + GoogleCloudDataplexV1DataProfileResult: + id: GoogleCloudDataplexV1DataProfileResult + description: >- + DataProfileResult defines the output of DataProfileScan. Each field of + the table will have field type specific profile result. + type: object + properties: + rowCount: + description: Output only. The count of rows scanned. + readOnly: true type: string - csv: - description: Optional. Additional information about CSV formatted data. - $ref: '#/components/schemas/GoogleCloudDataplexV1StorageFormatCsvOptions' - json: - description: Optional. Additional information about CSV formatted data. - $ref: '#/components/schemas/GoogleCloudDataplexV1StorageFormatJsonOptions' - iceberg: - description: Optional. Additional information about iceberg tables. + format: int64 + profile: + description: Output only. The profile information per field. + readOnly: true + $ref: '#/components/schemas/GoogleCloudDataplexV1DataProfileResultProfile' + scannedData: + description: Output only. The data scanned for this result. + readOnly: true + $ref: '#/components/schemas/GoogleCloudDataplexV1ScannedData' + postScanActionsResult: + description: Output only. The result of post scan actions. + readOnly: true $ref: >- - #/components/schemas/GoogleCloudDataplexV1StorageFormatIcebergOptions - GoogleCloudDataplexV1StorageFormatCsvOptions: - id: GoogleCloudDataplexV1StorageFormatCsvOptions - description: Describes CSV and similar semi-structured data formats. + #/components/schemas/GoogleCloudDataplexV1DataProfileResultPostScanActionsResult + GoogleCloudDataplexV1DataProfileResultProfile: + id: GoogleCloudDataplexV1DataProfileResultProfile + description: Contains name, type, mode and field type specific profile information. type: object properties: - encoding: + fields: description: >- - Optional. The character encoding of the data. Accepts "US-ASCII", - "UTF-8", and "ISO-8859-1". Defaults to UTF-8 if unspecified. + Output only. List of fields with structural and profile information + for each field. + readOnly: true + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDataplexV1DataProfileResultProfileField + GoogleCloudDataplexV1DataProfileResultProfileField: + id: GoogleCloudDataplexV1DataProfileResultProfileField + description: A field within a table. + type: object + properties: + name: + description: Output only. The name of the field. + readOnly: true type: string - headerRows: + type: description: >- - Optional. The number of rows to interpret as header rows that should - be skipped when reading data rows. Defaults to 0. - type: integer - format: int32 - delimiter: - description: Optional. The delimiter used to separate values. Defaults to ','. + Output only. The data type retrieved from the schema of the data + source. For instance, for a BigQuery native table, it is the + BigQuery Table Schema + (https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#tablefieldschema). + For a Dataplex Universal Catalog Entity, it is the Entity Schema + (https://cloud.google.com/dataplex/docs/reference/rpc/google.cloud.dataplex.v1#type_3). + readOnly: true type: string - quote: + mode: description: >- - Optional. The character used to quote column values. Accepts '"' - (double quotation mark) or ''' (single quotation mark). Defaults to - '"' (double quotation mark) if unspecified. + Output only. The mode of the field. Possible values include: + REQUIRED, if it is a required field. NULLABLE, if it is an optional + field. REPEATED, if it is a repeated field. + readOnly: true type: string - GoogleCloudDataplexV1StorageFormatJsonOptions: - id: GoogleCloudDataplexV1StorageFormatJsonOptions - description: Describes JSON data format. + profile: + description: Output only. Profile information for the corresponding field. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfo + GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfo: + id: GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfo + description: The profile information for each field type. type: object properties: - encoding: + nullRatio: description: >- - Optional. The character encoding of the data. Accepts "US-ASCII", - "UTF-8" and "ISO-8859-1". Defaults to UTF-8 if not specified. - type: string - GoogleCloudDataplexV1StorageFormatIcebergOptions: - id: GoogleCloudDataplexV1StorageFormatIcebergOptions - description: Describes Iceberg data format. - type: object - properties: - metadataLocation: + Output only. Ratio of rows with null value against total scanned + rows. + readOnly: true + type: number + format: double + distinctRatio: description: >- - Optional. The location of where the iceberg metadata is present, - must be within the table path - type: string - GoogleCloudDataplexV1EntityCompatibilityStatus: - id: GoogleCloudDataplexV1EntityCompatibilityStatus - description: Provides compatibility information for various metadata stores. - type: object - properties: - hiveMetastore: - description: Output only. Whether this entity is compatible with Hive Metastore. + Output only. Ratio of rows with distinct values against total + scanned rows. Not available for complex non-groupable field type, + including RECORD, ARRAY, GEOGRAPHY, and JSON, as well as fields with + REPEATABLE mode. readOnly: true - $ref: >- - #/components/schemas/GoogleCloudDataplexV1EntityCompatibilityStatusCompatibility - bigquery: - description: Output only. Whether this entity is compatible with BigQuery. + type: number + format: double + topNValues: + description: >- + Output only. The list of top N non-null values, frequency and ratio + with which they occur in the scanned data. N is 10 or equal to the + number of distinct values in the field, whichever is smaller. Not + available for complex non-groupable field type, including RECORD, + ARRAY, GEOGRAPHY, and JSON, as well as fields with REPEATABLE mode. readOnly: true + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoTopNValue + stringProfile: + description: String type field information. $ref: >- - #/components/schemas/GoogleCloudDataplexV1EntityCompatibilityStatusCompatibility - GoogleCloudDataplexV1EntityCompatibilityStatusCompatibility: - id: GoogleCloudDataplexV1EntityCompatibilityStatusCompatibility - description: Provides compatibility information for a specific metadata store. + #/components/schemas/GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoStringFieldInfo + integerProfile: + description: Integer type field information. + $ref: >- + #/components/schemas/GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoIntegerFieldInfo + doubleProfile: + description: Double type field information. + $ref: >- + #/components/schemas/GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoDoubleFieldInfo + GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoTopNValue: + id: GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoTopNValue + description: Top N non-null values in the scanned data. type: object properties: - compatible: - description: >- - Output only. Whether the entity is compatible and can be represented - in the metadata store. + value: + description: Output only. String value of a top N non-null value. readOnly: true - type: boolean - reason: - description: >- - Output only. Provides additional detail if the entity is - incompatible with the metadata store. + type: string + count: + description: Output only. Count of the corresponding value in the scanned data. readOnly: true type: string - GoogleCloudDataplexV1StorageAccess: - id: GoogleCloudDataplexV1StorageAccess - description: Describes the access mechanism of the data within its storage location. + format: int64 + ratio: + description: >- + Output only. Ratio of the corresponding value in the field against + the total number of rows in the scanned data. + readOnly: true + type: number + format: double + GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoStringFieldInfo: + id: >- + GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoStringFieldInfo + description: The profile information for a string type field. type: object properties: - read: - description: >- - Output only. Describes the read access mechanism of the data. Not - user settable. + minLength: + description: Output only. Minimum length of non-null values in the scanned data. readOnly: true type: string - enumDescriptions: - - Access mode unspecified. - - Default. Data is accessed directly using storage APIs. - - Data is accessed through a managed interface using BigQuery APIs. - enum: - - ACCESS_MODE_UNSPECIFIED - - DIRECT - - MANAGED - GoogleCloudDataplexV1Schema: - id: GoogleCloudDataplexV1Schema - description: Schema information describing the structure and layout of the data. + format: int64 + maxLength: + description: Output only. Maximum length of non-null values in the scanned data. + readOnly: true + type: string + format: int64 + averageLength: + description: Output only. Average length of non-null values in the scanned data. + readOnly: true + type: number + format: double + GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoIntegerFieldInfo: + id: >- + GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoIntegerFieldInfo + description: The profile information for an integer type field. type: object properties: - userManaged: + average: description: >- - Required. Set to true if user-managed or false if managed by - Dataplex. The default is false (managed by Dataplex). Set to falseto - enable Dataplex discovery to update the schema. including new data - discovery, schema inference, and schema evolution. Users retain the - ability to input and edit the schema. Dataplex treats schema input - by the user as though produced by a previous Dataplex discovery - operation, and it will evolve the schema and take action based on - that treatment. Set to true to fully manage the entity schema. This - setting guarantees that Dataplex will not change schema fields. - type: boolean - fields: + Output only. Average of non-null values in the scanned data. NaN, if + the field has a NaN. + readOnly: true + type: number + format: double + standardDeviation: description: >- - Optional. The sequence of fields describing data in table entities. - Note: BigQuery SchemaFields are immutable. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDataplexV1SchemaSchemaField' - partitionFields: + Output only. Standard deviation of non-null values in the scanned + data. NaN, if the field has a NaN. + readOnly: true + type: number + format: double + min: description: >- - Optional. The sequence of fields describing the partition structure - in entities. If this field is empty, there are no partitions within - the data. + Output only. Minimum of non-null values in the scanned data. NaN, if + the field has a NaN. + readOnly: true + type: string + format: int64 + quartiles: + description: >- + Output only. A quartile divides the number of data points into four + parts, or quarters, of more-or-less equal size. Three main quartiles + used are: The first quartile (Q1) splits off the lowest 25% of data + from the highest 75%. It is also known as the lower or 25th + empirical quartile, as 25% of the data is below this point. The + second quartile (Q2) is the median of a data set. So, 50% of the + data lies below this point. The third quartile (Q3) splits off the + highest 25% of data from the lowest 75%. It is known as the upper or + 75th empirical quartile, as 75% of the data lies below this point. + Here, the quartiles is provided as an ordered list of approximate + quartile values for the scanned data, occurring in order Q1, median, + Q3. + readOnly: true type: array items: - $ref: '#/components/schemas/GoogleCloudDataplexV1SchemaPartitionField' - partitionStyle: + type: string + format: int64 + max: description: >- - Optional. The structure of paths containing partition data within - the entity. + Output only. Maximum of non-null values in the scanned data. NaN, if + the field has a NaN. + readOnly: true type: string - enumDescriptions: - - PartitionStyle unspecified - - >- - Partitions are hive-compatible. Examples: - gs://bucket/path/to/table/dt=2019-10-31/lang=en, - gs://bucket/path/to/table/dt=2019-10-31/lang=en/late. - enum: - - PARTITION_STYLE_UNSPECIFIED - - HIVE_COMPATIBLE - GoogleCloudDataplexV1SchemaSchemaField: - id: GoogleCloudDataplexV1SchemaSchemaField - description: Represents a column field within a table schema. + format: int64 + GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoDoubleFieldInfo: + id: >- + GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoDoubleFieldInfo + description: The profile information for a double type field. type: object properties: - name: + average: description: >- - Required. The name of the field. Must contain only letters, numbers - and underscores, with a maximum length of 767 characters, and must - begin with a letter or underscore. - type: string - description: + Output only. Average of non-null values in the scanned data. NaN, if + the field has a NaN. + readOnly: true + type: number + format: double + standardDeviation: description: >- - Optional. User friendly field description. Must be less than or - equal to 1024 characters. - type: string - type: - description: Required. The type of field. + Output only. Standard deviation of non-null values in the scanned + data. NaN, if the field has a NaN. + readOnly: true + type: number + format: double + min: + description: >- + Output only. Minimum of non-null values in the scanned data. NaN, if + the field has a NaN. + readOnly: true + type: number + format: double + quartiles: + description: >- + Output only. A quartile divides the number of data points into four + parts, or quarters, of more-or-less equal size. Three main quartiles + used are: The first quartile (Q1) splits off the lowest 25% of data + from the highest 75%. It is also known as the lower or 25th + empirical quartile, as 25% of the data is below this point. The + second quartile (Q2) is the median of a data set. So, 50% of the + data lies below this point. The third quartile (Q3) splits off the + highest 25% of data from the lowest 75%. It is known as the upper or + 75th empirical quartile, as 75% of the data lies below this point. + Here, the quartiles is provided as an ordered list of quartile + values for the scanned data, occurring in order Q1, median, Q3. + readOnly: true + type: array + items: + type: number + format: double + max: + description: >- + Output only. Maximum of non-null values in the scanned data. NaN, if + the field has a NaN. + readOnly: true + type: number + format: double + GoogleCloudDataplexV1DataProfileResultPostScanActionsResult: + id: GoogleCloudDataplexV1DataProfileResultPostScanActionsResult + description: The result of post scan actions of DataProfileScan job. + type: object + properties: + bigqueryExportResult: + description: Output only. The result of BigQuery export post scan action. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudDataplexV1DataProfileResultPostScanActionsResultBigQueryExportResult + GoogleCloudDataplexV1DataProfileResultPostScanActionsResultBigQueryExportResult: + id: >- + GoogleCloudDataplexV1DataProfileResultPostScanActionsResultBigQueryExportResult + description: The result of BigQuery export post scan action. + type: object + properties: + state: + description: Output only. Execution state for the BigQuery exporting. + readOnly: true type: string enumDescriptions: - - SchemaType unspecified. - - Boolean field. - - Single byte numeric field. - - 16-bit numeric field. - - 32-bit numeric field. - - 64-bit numeric field. - - Floating point numeric field. - - Double precision numeric field. - - Real value numeric field. - - Sequence of characters field. - - Sequence of bytes field. - - Date and time field. - - Date field. - - Time field. + - The exporting state is unspecified. + - The exporting completed successfully. + - The exporting is no longer running due to an error. - >- - Structured field. Nested fields that define the structure of the - map. If all nested fields are nullable, this field represents a - union. - - Null field that does not have values. + The exporting is skipped due to no valid scan result to export + (usually caused by scan failed). enum: - - TYPE_UNSPECIFIED - - BOOLEAN - - BYTE - - INT16 - - INT32 - - INT64 - - FLOAT - - DOUBLE - - DECIMAL - - STRING - - BINARY - - TIMESTAMP - - DATE - - TIME - - RECORD - - 'NULL' - mode: - description: Required. Additional field semantics. + - STATE_UNSPECIFIED + - SUCCEEDED + - FAILED + - SKIPPED + message: + description: Output only. Additional information about the BigQuery exporting. + readOnly: true type: string - enumDescriptions: - - Mode unspecified. - - The field has required semantics. - - The field has optional semantics, and may be null. - - >- - The field has repeated (0 or more) semantics, and is a list of - values. - enum: - - MODE_UNSPECIFIED - - REQUIRED - - NULLABLE - - REPEATED - fields: - description: Optional. Any nested field for complex types. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDataplexV1SchemaSchemaField' - GoogleCloudDataplexV1SchemaPartitionField: - id: GoogleCloudDataplexV1SchemaPartitionField - description: >- - Represents a key field within the entity's partition structure. You - could have up to 20 partition fields, but only the first 10 partitions - have the filtering ability due to performance consideration. Note: - Partition fields are immutable. + GoogleCloudDataplexV1DataDiscoveryResult: + id: GoogleCloudDataplexV1DataDiscoveryResult + description: The output of a data discovery scan. type: object properties: - name: + bigqueryPublishing: + description: Output only. Configuration for metadata publishing. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudDataplexV1DataDiscoveryResultBigQueryPublishing + scanStatistics: description: >- - Required. Partition field name must consist of letters, numbers, and - underscores only, with a maximum of length of 256 characters, and - must begin with a letter or underscore.. + Output only. Describes result statistics of a data scan discovery + job. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudDataplexV1DataDiscoveryResultScanStatistics + GoogleCloudDataplexV1DataDiscoveryResultBigQueryPublishing: + id: GoogleCloudDataplexV1DataDiscoveryResultBigQueryPublishing + description: Describes BigQuery publishing configurations. + type: object + properties: + dataset: + description: >- + Output only. The BigQuery dataset the discovered tables are + published to. + readOnly: true type: string - type: - description: Required. Immutable. The type of field. + location: + description: Output only. The location of the BigQuery publishing dataset. + readOnly: true type: string - enumDescriptions: - - SchemaType unspecified. - - Boolean field. - - Single byte numeric field. - - 16-bit numeric field. - - 32-bit numeric field. - - 64-bit numeric field. - - Floating point numeric field. - - Double precision numeric field. - - Real value numeric field. - - Sequence of characters field. - - Sequence of bytes field. - - Date and time field. - - Date field. - - Time field. - - >- - Structured field. Nested fields that define the structure of the - map. If all nested fields are nullable, this field represents a - union. - - Null field that does not have values. - enum: - - TYPE_UNSPECIFIED - - BOOLEAN - - BYTE - - INT16 - - INT32 - - INT64 - - FLOAT - - DOUBLE - - DECIMAL - - STRING - - BINARY - - TIMESTAMP - - DATE - - TIME - - RECORD - - 'NULL' - GoogleCloudDataplexV1ListEntitiesResponse: - id: GoogleCloudDataplexV1ListEntitiesResponse - description: List metadata entities response. + GoogleCloudDataplexV1DataDiscoveryResultScanStatistics: + id: GoogleCloudDataplexV1DataDiscoveryResultScanStatistics + description: Describes result statistics of a data scan discovery job. type: object properties: - entities: - description: Entities in the specified parent zone. + scannedFileCount: + description: The number of files scanned. + type: integer + format: int32 + dataProcessedBytes: + description: The data processed in bytes. + type: string + format: int64 + filesExcluded: + description: The number of files excluded. + type: integer + format: int32 + tablesCreated: + description: The number of tables created. + type: integer + format: int32 + tablesDeleted: + description: The number of tables deleted. + type: integer + format: int32 + tablesUpdated: + description: The number of tables updated. + type: integer + format: int32 + filesetsCreated: + description: The number of filesets created. + type: integer + format: int32 + filesetsDeleted: + description: The number of filesets deleted. + type: integer + format: int32 + filesetsUpdated: + description: The number of filesets updated. + type: integer + format: int32 + GoogleCloudDataplexV1ListDataScansResponse: + id: GoogleCloudDataplexV1ListDataScansResponse + description: List dataScans response. + type: object + properties: + dataScans: + description: DataScans (BASIC view only) under the given parent location. type: array items: - $ref: '#/components/schemas/GoogleCloudDataplexV1Entity' + $ref: '#/components/schemas/GoogleCloudDataplexV1DataScan' nextPageToken: description: >- Token to retrieve the next page of results, or empty if there are no - remaining results in the list. - type: string - GoogleCloudDataplexV1Partition: - id: GoogleCloudDataplexV1Partition - description: Represents partition metadata contained within entity instances. - type: object - properties: - name: - description: >- - Output only. Partition values used in the HTTP URL must be double - encoded. For example, url_encode(url_encode(value)) can be used to - encode "US:CA/CA#Sunnyvale so that the request URL ends with - "/partitions/US%253ACA/CA%2523Sunnyvale". The name field in the - response retains the encoded format. - readOnly: true + more results in the list. type: string - values: - description: >- - Required. Immutable. The set of values representing the partition, - which correspond to the partition schema defined in the parent - entity. + unreachable: + description: Locations that could not be reached. type: array items: type: string - location: - description: >- - Required. Immutable. The location of the entity data within the - partition, for example, - gs://bucket/path/to/entity/key1=value1/key2=value2. Or - projects//datasets//tables/ - type: string - etag: - description: Optional. The etag for this partition. - deprecated: true - type: string - GoogleCloudDataplexV1ListPartitionsResponse: - id: GoogleCloudDataplexV1ListPartitionsResponse - description: List metadata partitions response. + GoogleCloudDataplexV1RunDataScanRequest: + id: GoogleCloudDataplexV1RunDataScanRequest + description: Run DataScan Request + type: object + properties: {} + GoogleCloudDataplexV1RunDataScanResponse: + id: GoogleCloudDataplexV1RunDataScanResponse + description: Run DataScan Response. type: object properties: - partitions: - description: Partitions under the specified parent entity. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDataplexV1Partition' - nextPageToken: - description: >- - Token to retrieve the next page of results, or empty if there are no - remaining results in the list. - type: string - GoogleCloudDataplexV1Lake: - id: GoogleCloudDataplexV1Lake - description: >- - A lake is a centralized repository for managing enterprise data across - the organization distributed across many cloud projects, and stored in a - variety of storage services such as Google Cloud Storage and BigQuery. - The resources attached to a lake are referred to as managed resources. - Data within these managed resources can be structured or unstructured. A - lake provides data admins with tools to organize, secure and manage - their data at scale, and provides data scientists and data engineers an - integrated experience to easily search, discover, analyze and transform - data and associated metadata. + job: + description: DataScanJob created by RunDataScan request. + $ref: '#/components/schemas/GoogleCloudDataplexV1DataScanJob' + GoogleCloudDataplexV1DataScanJob: + id: GoogleCloudDataplexV1DataScanJob + description: A DataScanJob represents an instance of DataScan execution. type: object properties: name: description: >- - Output only. The relative resource name of the lake, of the form: - projects/{project_number}/locations/{location_id}/lakes/{lake_id}. + Output only. Identifier. The relative resource name of the + DataScanJob, of the form: + projects/{project}/locations/{location_id}/dataScans/{datascan_id}/jobs/{job_id}, + where project refers to a project_id or project_number and + location_id refers to a Google Cloud region. readOnly: true type: string - displayName: - description: Optional. User friendly display name. - type: string uid: description: >- - Output only. System generated globally unique ID for the lake. This - ID will be different if the lake is deleted and re-created with the - same name. + Output only. System generated globally unique ID for the + DataScanJob. readOnly: true type: string createTime: - description: Output only. The time when the lake was created. + description: Output only. The time when the DataScanJob was created. readOnly: true type: string format: google-datetime - updateTime: - description: Output only. The time when the lake was last updated. + startTime: + description: Output only. The time when the DataScanJob was started. readOnly: true type: string format: google-datetime - labels: - description: Optional. User-defined labels for the lake. - type: object - additionalProperties: - type: string - description: - description: Optional. Description of the lake. + endTime: + description: Output only. The time when the DataScanJob ended. + readOnly: true type: string + format: google-datetime state: - description: Output only. Current state of the lake. + description: Output only. Execution state for the DataScanJob. readOnly: true type: string enumDescriptions: - - State is not specified. - - Resource is active, i.e., ready to use. - - Resource is under creation. - - Resource is under deletion. - - Resource is active but has unresolved actions. + - The DataScanJob state is unspecified. + - The DataScanJob is running. + - The DataScanJob is canceling. + - The DataScanJob cancellation was successful. + - The DataScanJob completed successfully. + - The DataScanJob is no longer running due to an error. + - The DataScanJob has been created but not started to run yet. enum: - STATE_UNSPECIFIED - - ACTIVE - - CREATING - - DELETING - - ACTION_REQUIRED - serviceAccount: - description: >- - Output only. Service account associated with this lake. This service - account must be authorized to access or operate on resources managed - by the lake. + - RUNNING + - CANCELING + - CANCELLED + - SUCCEEDED + - FAILED + - PENDING + message: + description: Output only. Additional information about the current state. readOnly: true type: string - metastore: - description: >- - Optional. Settings to manage lake and Dataproc Metastore service - instance association. - $ref: '#/components/schemas/GoogleCloudDataplexV1LakeMetastore' - assetStatus: - description: Output only. Aggregated status of the underlying assets of the lake. + type: + description: Output only. The type of the parent DataScan. readOnly: true - $ref: '#/components/schemas/GoogleCloudDataplexV1AssetStatus' - metastoreStatus: - description: Output only. Metastore status of the lake. + type: string + enumDescriptions: + - The data scan type is unspecified. + - Data quality scan. + - Data profile scan. + - Data discovery scan. + enum: + - DATA_SCAN_TYPE_UNSPECIFIED + - DATA_QUALITY + - DATA_PROFILE + - DATA_DISCOVERY + dataQualitySpec: + description: Output only. Settings for a data quality scan. readOnly: true - $ref: '#/components/schemas/GoogleCloudDataplexV1LakeMetastoreStatus' - GoogleCloudDataplexV1LakeMetastore: - id: GoogleCloudDataplexV1LakeMetastore - description: Settings to manage association of Dataproc Metastore with a lake. + $ref: '#/components/schemas/GoogleCloudDataplexV1DataQualitySpec' + dataProfileSpec: + description: Output only. Settings for a data profile scan. + readOnly: true + $ref: '#/components/schemas/GoogleCloudDataplexV1DataProfileSpec' + dataDiscoverySpec: + description: Output only. Settings for a data discovery scan. + readOnly: true + $ref: '#/components/schemas/GoogleCloudDataplexV1DataDiscoverySpec' + dataQualityResult: + description: Output only. The result of a data quality scan. + readOnly: true + $ref: '#/components/schemas/GoogleCloudDataplexV1DataQualityResult' + dataProfileResult: + description: Output only. The result of a data profile scan. + readOnly: true + $ref: '#/components/schemas/GoogleCloudDataplexV1DataProfileResult' + dataDiscoveryResult: + description: Output only. The result of a data discovery scan. + readOnly: true + $ref: '#/components/schemas/GoogleCloudDataplexV1DataDiscoveryResult' + GoogleCloudDataplexV1ListDataScanJobsResponse: + id: GoogleCloudDataplexV1ListDataScanJobsResponse + description: List DataScanJobs response. type: object properties: - service: + dataScanJobs: + description: DataScanJobs (BASIC view only) under a given dataScan. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDataplexV1DataScanJob' + nextPageToken: description: >- - Optional. A relative reference to the Dataproc Metastore - (https://cloud.google.com/dataproc-metastore/docs) service - associated with the lake: - projects/{project_id}/locations/{location_id}/services/{service_id} + Token to retrieve the next page of results, or empty if there are no + more results in the list. type: string - GoogleCloudDataplexV1AssetStatus: - id: GoogleCloudDataplexV1AssetStatus - description: Aggregated status of the underlying assets of a lake or zone. - type: object + GoogleCloudDataplexV1GenerateDataQualityRulesRequest: + id: GoogleCloudDataplexV1GenerateDataQualityRulesRequest + description: Request details for generating data quality rule recommendations. + type: object + properties: {} + GoogleCloudDataplexV1GenerateDataQualityRulesResponse: + id: GoogleCloudDataplexV1GenerateDataQualityRulesResponse + description: Response details for data quality rule recommendations. + type: object properties: - updateTime: - description: Last update time of the status. - type: string - format: google-datetime - activeAssets: - description: Number of active assets. - type: integer - format: int32 - securityPolicyApplyingAssets: + rule: description: >- - Number of assets that are in process of updating the security policy - on attached resources. - type: integer - format: int32 - GoogleCloudDataplexV1LakeMetastoreStatus: - id: GoogleCloudDataplexV1LakeMetastoreStatus - description: Status of Lake and Dataproc Metastore service instance association. + The data quality rules that Dataplex Universal Catalog generates + based on the results of a data profiling scan. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDataplexV1DataQualityRule' + GoogleCloudDataplexV1Entity: + id: GoogleCloudDataplexV1Entity + description: Represents tables and fileset metadata contained within a zone. type: object properties: - state: - description: Current state of association. + name: + description: >- + Output only. The resource name of the entity, of the form: + projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{id}. + readOnly: true type: string - enumDescriptions: - - Unspecified. - - A Metastore service instance is not associated with the lake. - - A Metastore service instance is attached to the lake. - - Attach/detach is in progress. - - Attach/detach could not be done due to errors. - enum: - - STATE_UNSPECIFIED - - NONE - - READY - - UPDATING - - ERROR - message: - description: Additional information about the current status. + displayName: + description: >- + Optional. Display name must be shorter than or equal to 256 + characters. type: string - updateTime: - description: Last update time of the metastore status of the lake. + description: + description: >- + Optional. User friendly longer description text. Must be shorter + than or equal to 1024 characters. + type: string + createTime: + description: Output only. The time when the entity was created. + readOnly: true type: string format: google-datetime - endpoint: - description: The URI of the endpoint used to access the Metastore service. + updateTime: + description: Output only. The time when the entity was last updated. + readOnly: true type: string - GoogleCloudDataplexV1ListLakesResponse: - id: GoogleCloudDataplexV1ListLakesResponse - description: List lakes response. - type: object - properties: - lakes: - description: Lakes under the given parent location. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDataplexV1Lake' - nextPageToken: + format: google-datetime + id: description: >- - Token to retrieve the next page of results, or empty if there are no - more results in the list. + Required. A user-provided entity ID. It is mutable, and will be used + as the published table name. Specifying a new ID in an update entity + request will override the existing value. The ID must contain only + letters (a-z, A-Z), numbers (0-9), and underscores, and consist of + 256 or fewer characters. type: string - unreachableLocations: - description: Locations that could not be reached. - type: array - items: - type: string - GoogleCloudDataplexV1ListActionsResponse: - id: GoogleCloudDataplexV1ListActionsResponse - description: List actions response. - type: object - properties: - actions: - description: Actions under the given parent lake/zone/asset. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDataplexV1Action' - nextPageToken: + etag: description: >- - Token to retrieve the next page of results, or empty if there are no - more results in the list. + Optional. The etag associated with the entity, which can be + retrieved with a GetEntity request. Required for update and delete + requests. type: string - GoogleCloudDataplexV1Action: - id: GoogleCloudDataplexV1Action - description: >- - Action represents an issue requiring administrator action for - resolution. - type: object - properties: - category: - description: The category of issue associated with the action. + type: + description: Required. Immutable. The type of entity. type: string enumDescriptions: - - Unspecified category. - - Resource management related issues. - - Security policy related issues. - - Data and discovery related issues. + - Type unspecified. + - Structured and semi-structured data. + - Unstructured data. enum: - - CATEGORY_UNSPECIFIED - - RESOURCE_MANAGEMENT - - SECURITY_POLICY - - DATA_DISCOVERY - issue: - description: Detailed description of the issue requiring action. - type: string - detectTime: - description: The time that the issue was detected. - type: string - format: google-datetime - name: + - TYPE_UNSPECIFIED + - TABLE + - FILESET + asset: description: >- - Output only. The relative resource name of the action, of the form: - projects/{project}/locations/{location}/lakes/{lake}/actions/{action} - projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/actions/{action} - projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/assets/{asset}/actions/{action}. - readOnly: true + Required. Immutable. The ID of the asset associated with the storage + location containing the entity data. The entity must be with in the + same zone with the asset. type: string - lake: + dataPath: description: >- - Output only. The relative resource name of the lake, of the form: - projects/{project_number}/locations/{location_id}/lakes/{lake_id}. - readOnly: true + Required. Immutable. The storage path of the entity data. For Cloud + Storage data, this is the fully-qualified path to the entity, such + as gs://bucket/path/to/data. For BigQuery data, this is the name of + the table resource, such as + projects/project_id/datasets/dataset_id/tables/table_id. type: string - zone: + dataPathPattern: description: >- - Output only. The relative resource name of the zone, of the form: - projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}. + Optional. The set of items within the data path constituting the + data in the entity, represented as a glob path. Example: + gs://bucket/path/to/data/**/*.csv. + type: string + catalogEntry: + description: Output only. The name of the associated Data Catalog entry. readOnly: true type: string - asset: + system: description: >- - Output only. The relative resource name of the asset, of the form: - projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}. - readOnly: true + Required. Immutable. Identifies the storage system of the entity + data. type: string - dataLocations: + enumDescriptions: + - Storage system unspecified. + - The entity data is contained within a Cloud Storage bucket. + - The entity data is contained within a BigQuery dataset. + enum: + - STORAGE_SYSTEM_UNSPECIFIED + - CLOUD_STORAGE + - BIGQUERY + format: description: >- - The list of data locations associated with this action. Cloud - Storage locations are represented as URI paths(E.g. - gs://bucket/table1/year=2020/month=Jan/). BigQuery locations refer - to resource names(E.g. - bigquery.googleapis.com/projects/project-id/datasets/dataset-id). - type: array - items: - type: string - invalidDataFormat: - description: Details for issues related to invalid or unsupported data formats. - $ref: '#/components/schemas/GoogleCloudDataplexV1ActionInvalidDataFormat' - incompatibleDataSchema: + Required. Identifies the storage format of the entity data. It does + not apply to entities with data stored in BigQuery. + $ref: '#/components/schemas/GoogleCloudDataplexV1StorageFormat' + compatibility: + description: Output only. Metadata stores that the entity is compatible with. + readOnly: true + $ref: '#/components/schemas/GoogleCloudDataplexV1EntityCompatibilityStatus' + access: description: >- - Details for issues related to incompatible schemas detected within - data. - $ref: >- - #/components/schemas/GoogleCloudDataplexV1ActionIncompatibleDataSchema - invalidDataPartition: + Output only. Identifies the access mechanism to the entity. Not user + settable. + readOnly: true + $ref: '#/components/schemas/GoogleCloudDataplexV1StorageAccess' + uid: description: >- - Details for issues related to invalid or unsupported data partition - structure. - $ref: '#/components/schemas/GoogleCloudDataplexV1ActionInvalidDataPartition' - missingData: + Output only. System generated unique ID for the Entity. This ID will + be different if the Entity is deleted and re-created with the same + name. + readOnly: true + type: string + schema: description: >- - Details for issues related to absence of data within managed - resources. - $ref: '#/components/schemas/GoogleCloudDataplexV1ActionMissingData' - missingResource: - description: Details for issues related to absence of a managed resource. - $ref: '#/components/schemas/GoogleCloudDataplexV1ActionMissingResource' - unauthorizedResource: + Required. The description of the data structure and layout. The + schema is not included in list responses. It is only included in + SCHEMA and FULL entity views of a GetEntity response. + $ref: '#/components/schemas/GoogleCloudDataplexV1Schema' + GoogleCloudDataplexV1StorageFormat: + id: GoogleCloudDataplexV1StorageFormat + description: Describes the format of the data within its storage location. + type: object + properties: + format: description: >- - Details for issues related to lack of permissions to access data - resources. - $ref: '#/components/schemas/GoogleCloudDataplexV1ActionUnauthorizedResource' - failedSecurityPolicyApply: - description: Details for issues related to applying security policy. - $ref: >- - #/components/schemas/GoogleCloudDataplexV1ActionFailedSecurityPolicyApply - invalidDataOrganization: - description: Details for issues related to invalid data arrangement. - $ref: >- - #/components/schemas/GoogleCloudDataplexV1ActionInvalidDataOrganization - GoogleCloudDataplexV1ActionInvalidDataFormat: - id: GoogleCloudDataplexV1ActionInvalidDataFormat - description: >- - Action details for invalid or unsupported data files detected by - discovery. - type: object - properties: - sampledDataLocations: + Output only. The data format associated with the stored data, which + represents content type values. The value is inferred from mime + type. + readOnly: true + type: string + enumDescriptions: + - Format unspecified. + - Parquet-formatted structured data. + - Avro-formatted structured data. + - Orc-formatted structured data. + - Csv-formatted semi-structured data. + - Json-formatted semi-structured data. + - Image data formats (such as jpg and png). + - Audio data formats (such as mp3, and wav). + - Video data formats (such as mp4 and mpg). + - Textual data formats (such as txt and xml). + - TensorFlow record format. + - Data that doesn't match a specific format. + - Data of an unknown format. + enum: + - FORMAT_UNSPECIFIED + - PARQUET + - AVRO + - ORC + - CSV + - JSON + - IMAGE + - AUDIO + - VIDEO + - TEXT + - TFRECORD + - OTHER + - UNKNOWN + compressionFormat: description: >- - The list of data locations sampled and used for format/schema - inference. - type: array - items: - type: string - expectedFormat: - description: The expected data format of the entity. + Optional. The compression type associated with the stored data. If + unspecified, the data is uncompressed. type: string - newFormat: - description: The new unexpected data format within the entity. + enumDescriptions: + - CompressionFormat unspecified. Implies uncompressed data. + - GZip compressed set of files. + - BZip2 compressed set of files. + enum: + - COMPRESSION_FORMAT_UNSPECIFIED + - GZIP + - BZIP2 + mimeType: + description: >- + Required. The mime type descriptor for the data. Must match the + pattern {type}/{subtype}. Supported values: application/x-parquet + application/x-avro application/x-orc application/x-tfrecord + application/x-parquet+iceberg application/x-avro+iceberg + application/x-orc+iceberg application/json application/{subtypes} + text/csv text/ image/{image subtype} video/{video subtype} + audio/{audio subtype} type: string - GoogleCloudDataplexV1ActionIncompatibleDataSchema: - id: GoogleCloudDataplexV1ActionIncompatibleDataSchema - description: Action details for incompatible schemas detected by discovery. + csv: + description: Optional. Additional information about CSV formatted data. + $ref: '#/components/schemas/GoogleCloudDataplexV1StorageFormatCsvOptions' + json: + description: Optional. Additional information about CSV formatted data. + $ref: '#/components/schemas/GoogleCloudDataplexV1StorageFormatJsonOptions' + iceberg: + description: Optional. Additional information about iceberg tables. + $ref: >- + #/components/schemas/GoogleCloudDataplexV1StorageFormatIcebergOptions + GoogleCloudDataplexV1StorageFormatCsvOptions: + id: GoogleCloudDataplexV1StorageFormatCsvOptions + description: Describes CSV and similar semi-structured data formats. type: object properties: - table: - description: The name of the table containing invalid data. - type: string - existingSchema: + encoding: description: >- - The existing and expected schema of the table. The schema is - provided as a JSON formatted structure listing columns and data - types. + Optional. The character encoding of the data. Accepts "US-ASCII", + "UTF-8", and "ISO-8859-1". Defaults to UTF-8 if unspecified. type: string - newSchema: + headerRows: description: >- - The new and incompatible schema within the table. The schema is - provided as a JSON formatted structured listing columns and data - types. + Optional. The number of rows to interpret as header rows that should + be skipped when reading data rows. Defaults to 0. + type: integer + format: int32 + delimiter: + description: Optional. The delimiter used to separate values. Defaults to ','. type: string - sampledDataLocations: - description: >- - The list of data locations sampled and used for format/schema - inference. - type: array - items: - type: string - schemaChange: + quote: description: >- - Whether the action relates to a schema that is incompatible or - modified. + Optional. The character used to quote column values. Accepts '"' + (double quotation mark) or ''' (single quotation mark). Defaults to + '"' (double quotation mark) if unspecified. type: string - enumDescriptions: - - Schema change unspecified. - - Newly discovered schema is incompatible with existing schema. - - >- - Newly discovered schema has changed from existing schema for data - in a curated zone. - enum: - - SCHEMA_CHANGE_UNSPECIFIED - - INCOMPATIBLE - - MODIFIED - GoogleCloudDataplexV1ActionInvalidDataPartition: - id: GoogleCloudDataplexV1ActionInvalidDataPartition - description: >- - Action details for invalid or unsupported partitions detected by - discovery. + GoogleCloudDataplexV1StorageFormatJsonOptions: + id: GoogleCloudDataplexV1StorageFormatJsonOptions + description: Describes JSON data format. type: object properties: - expectedStructure: - description: The issue type of InvalidDataPartition. + encoding: + description: >- + Optional. The character encoding of the data. Accepts "US-ASCII", + "UTF-8" and "ISO-8859-1". Defaults to UTF-8 if not specified. type: string - enumDescriptions: - - PartitionStructure unspecified. - - >- - Consistent hive-style partition definition (both raw and curated - zone). - - Hive style partition definition (curated zone only). - enum: - - PARTITION_STRUCTURE_UNSPECIFIED - - CONSISTENT_KEYS - - HIVE_STYLE_KEYS - GoogleCloudDataplexV1ActionMissingData: - id: GoogleCloudDataplexV1ActionMissingData - description: Action details for absence of data detected by discovery. - type: object - properties: {} - GoogleCloudDataplexV1ActionMissingResource: - id: GoogleCloudDataplexV1ActionMissingResource - description: Action details for resource references in assets that cannot be located. - type: object - properties: {} - GoogleCloudDataplexV1ActionUnauthorizedResource: - id: GoogleCloudDataplexV1ActionUnauthorizedResource - description: >- - Action details for unauthorized resource issues raised to indicate that - the service account associated with the lake instance is not authorized - to access or manage the resource associated with an asset. - type: object - properties: {} - GoogleCloudDataplexV1ActionFailedSecurityPolicyApply: - id: GoogleCloudDataplexV1ActionFailedSecurityPolicyApply - description: >- - Failed to apply security policy to the managed resource(s) under a lake, - zone or an asset. For a lake or zone resource, one or more underlying - assets has a failure applying security policy to the associated managed - resource. + GoogleCloudDataplexV1StorageFormatIcebergOptions: + id: GoogleCloudDataplexV1StorageFormatIcebergOptions + description: Describes Iceberg data format. type: object properties: - asset: + metadataLocation: description: >- - Resource name of one of the assets with failing security policy - application. Populated for a lake or zone resource only. + Optional. The location of where the iceberg metadata is present, + must be within the table path type: string - GoogleCloudDataplexV1ActionInvalidDataOrganization: - id: GoogleCloudDataplexV1ActionInvalidDataOrganization - description: Action details for invalid data arrangement. + GoogleCloudDataplexV1EntityCompatibilityStatus: + id: GoogleCloudDataplexV1EntityCompatibilityStatus + description: Provides compatibility information for various metadata stores. type: object - properties: {} - GoogleCloudDataplexV1Zone: - id: GoogleCloudDataplexV1Zone - description: >- - A zone represents a logical group of related assets within a lake. A - zone can be used to map to organizational structure or represent stages - of data readiness from raw to curated. It provides managing behavior - that is shared or inherited by all contained assets. + properties: + hiveMetastore: + description: Output only. Whether this entity is compatible with Hive Metastore. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudDataplexV1EntityCompatibilityStatusCompatibility + bigquery: + description: Output only. Whether this entity is compatible with BigQuery. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudDataplexV1EntityCompatibilityStatusCompatibility + GoogleCloudDataplexV1EntityCompatibilityStatusCompatibility: + id: GoogleCloudDataplexV1EntityCompatibilityStatusCompatibility + description: Provides compatibility information for a specific metadata store. type: object properties: - name: + compatible: description: >- - Output only. The relative resource name of the zone, of the form: - projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}. + Output only. Whether the entity is compatible and can be represented + in the metadata store. readOnly: true - type: string - displayName: - description: Optional. User friendly display name. - type: string - uid: + type: boolean + reason: description: >- - Output only. System generated globally unique ID for the zone. This - ID will be different if the zone is deleted and re-created with the - same name. - readOnly: true - type: string - createTime: - description: Output only. The time when the zone was created. + Output only. Provides additional detail if the entity is + incompatible with the metadata store. readOnly: true type: string - format: google-datetime - updateTime: - description: Output only. The time when the zone was last updated. + GoogleCloudDataplexV1StorageAccess: + id: GoogleCloudDataplexV1StorageAccess + description: Describes the access mechanism of the data within its storage location. + type: object + properties: + read: + description: >- + Output only. Describes the read access mechanism of the data. Not + user settable. readOnly: true type: string - format: google-datetime - labels: - description: Optional. User defined labels for the zone. - type: object - additionalProperties: - type: string - description: - description: Optional. Description of the zone. - type: string - state: - description: Output only. Current state of the zone. - readOnly: true - type: string - enumDescriptions: - - State is not specified. - - Resource is active, i.e., ready to use. - - Resource is under creation. - - Resource is under deletion. - - Resource is active but has unresolved actions. - enum: - - STATE_UNSPECIFIED - - ACTIVE - - CREATING - - DELETING - - ACTION_REQUIRED - type: - description: Required. Immutable. The type of the zone. - type: string enumDescriptions: - - Zone type not specified. - - >- - A zone that contains data that needs further processing before it - is considered generally ready for consumption and analytics - workloads. - - >- - A zone that contains data that is considered to be ready for - broader consumption and analytics workloads. Curated structured - data stored in Cloud Storage must conform to certain file formats - (parquet, avro and orc) and organized in a hive-compatible - directory layout. + - Access mode unspecified. + - Default. Data is accessed directly using storage APIs. + - Data is accessed through a managed interface using BigQuery APIs. enum: - - TYPE_UNSPECIFIED - - RAW - - CURATED - discoverySpec: - description: >- - Optional. Specification of the discovery feature applied to data in - this zone. - $ref: '#/components/schemas/GoogleCloudDataplexV1ZoneDiscoverySpec' - resourceSpec: - description: >- - Required. Specification of the resources that are referenced by the - assets within this zone. - $ref: '#/components/schemas/GoogleCloudDataplexV1ZoneResourceSpec' - assetStatus: - description: Output only. Aggregated status of the underlying assets of the zone. - readOnly: true - $ref: '#/components/schemas/GoogleCloudDataplexV1AssetStatus' - GoogleCloudDataplexV1ZoneDiscoverySpec: - id: GoogleCloudDataplexV1ZoneDiscoverySpec - description: Settings to manage the metadata discovery and publishing in a zone. + - ACCESS_MODE_UNSPECIFIED + - DIRECT + - MANAGED + GoogleCloudDataplexV1Schema: + id: GoogleCloudDataplexV1Schema + description: Schema information describing the structure and layout of the data. type: object properties: - enabled: - description: Required. Whether discovery is enabled. + userManaged: + description: >- + Required. Set to true if user-managed or false if managed by + Dataplex Universal Catalog. The default is false (managed by + Dataplex Universal Catalog). Set to falseto enable Dataplex + Universal Catalog discovery to update the schema. including new data + discovery, schema inference, and schema evolution. Users retain the + ability to input and edit the schema. Dataplex Universal Catalog + treats schema input by the user as though produced by a previous + Dataplex Universal Catalog discovery operation, and it will evolve + the schema and take action based on that treatment. Set to true to + fully manage the entity schema. This setting guarantees that + Dataplex Universal Catalog will not change schema fields. type: boolean - includePatterns: + fields: description: >- - Optional. The list of patterns to apply for selecting data to - include during discovery if only a subset of the data should - considered. For Cloud Storage bucket assets, these are interpreted - as glob patterns used to match object names. For BigQuery dataset - assets, these are interpreted as patterns to match table names. + Optional. The sequence of fields describing data in table entities. + Note: BigQuery SchemaFields are immutable. type: array items: - type: string - excludePatterns: + $ref: '#/components/schemas/GoogleCloudDataplexV1SchemaSchemaField' + partitionFields: description: >- - Optional. The list of patterns to apply for selecting data to - exclude during discovery. For Cloud Storage bucket assets, these are - interpreted as glob patterns used to match object names. For - BigQuery dataset assets, these are interpreted as patterns to match - table names. + Optional. The sequence of fields describing the partition structure + in entities. If this field is empty, there are no partitions within + the data. type: array items: - type: string - csvOptions: - description: Optional. Configuration for CSV data. - $ref: >- - #/components/schemas/GoogleCloudDataplexV1ZoneDiscoverySpecCsvOptions - jsonOptions: - description: Optional. Configuration for Json data. - $ref: >- - #/components/schemas/GoogleCloudDataplexV1ZoneDiscoverySpecJsonOptions - schedule: + $ref: '#/components/schemas/GoogleCloudDataplexV1SchemaPartitionField' + partitionStyle: description: >- - Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for - running discovery periodically. Successive discovery runs must be - scheduled at least 60 minutes apart. The default value is to run - discovery every 60 minutes. To explicitly set a timezone to the cron - tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or - TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid - string from IANA time zone database. For example, - CRON_TZ=America/New_York 1 * * * *, or TZ=America/New_York 1 * * * - *. + Optional. The structure of paths containing partition data within + the entity. type: string - GoogleCloudDataplexV1ZoneDiscoverySpecCsvOptions: - id: GoogleCloudDataplexV1ZoneDiscoverySpecCsvOptions - description: Describe CSV and similar semi-structured data formats. + enumDescriptions: + - PartitionStyle unspecified + - >- + Partitions are hive-compatible. Examples: + gs://bucket/path/to/table/dt=2019-10-31/lang=en, + gs://bucket/path/to/table/dt=2019-10-31/lang=en/late. + enum: + - PARTITION_STYLE_UNSPECIFIED + - HIVE_COMPATIBLE + GoogleCloudDataplexV1SchemaSchemaField: + id: GoogleCloudDataplexV1SchemaSchemaField + description: Represents a column field within a table schema. type: object properties: - headerRows: - description: >- - Optional. The number of rows to interpret as header rows that should - be skipped when reading data rows. - type: integer - format: int32 - delimiter: + name: description: >- - Optional. The delimiter being used to separate values. This defaults - to ','. - type: string - encoding: - description: Optional. The character encoding of the data. The default is UTF-8. + Required. The name of the field. Must contain only letters, numbers + and underscores, with a maximum length of 767 characters, and must + begin with a letter or underscore. type: string - disableTypeInference: + description: description: >- - Optional. Whether to disable the inference of data type for CSV - data. If true, all columns will be registered as strings. - type: boolean - GoogleCloudDataplexV1ZoneDiscoverySpecJsonOptions: - id: GoogleCloudDataplexV1ZoneDiscoverySpecJsonOptions - description: Describe JSON data format. - type: object - properties: - encoding: - description: Optional. The character encoding of the data. The default is UTF-8. + Optional. User friendly field description. Must be less than or + equal to 1024 characters. type: string - disableTypeInference: - description: >- - Optional. Whether to disable the inference of data type for Json - data. If true, all columns will be registered as their primitive - types (strings, number or boolean). - type: boolean - GoogleCloudDataplexV1ZoneResourceSpec: - id: GoogleCloudDataplexV1ZoneResourceSpec - description: Settings for resources attached as assets within a zone. - type: object - properties: - locationType: - description: >- - Required. Immutable. The location type of the resources that are - allowed to be attached to the assets within this zone. + type: + description: Required. The type of field. type: string enumDescriptions: - - Unspecified location type. - - Resources that are associated with a single region. - - Resources that are associated with a multi-region location. + - SchemaType unspecified. + - Boolean field. + - Single byte numeric field. + - 16-bit numeric field. + - 32-bit numeric field. + - 64-bit numeric field. + - Floating point numeric field. + - Double precision numeric field. + - Real value numeric field. + - Sequence of characters field. + - Sequence of bytes field. + - Date and time field. + - Date field. + - Time field. + - >- + Structured field. Nested fields that define the structure of the + map. If all nested fields are nullable, this field represents a + union. + - Null field that does not have values. enum: - - LOCATION_TYPE_UNSPECIFIED - - SINGLE_REGION - - MULTI_REGION - GoogleCloudDataplexV1ListZonesResponse: - id: GoogleCloudDataplexV1ListZonesResponse - description: List zones response. - type: object - properties: - zones: - description: Zones under the given parent lake. + - TYPE_UNSPECIFIED + - BOOLEAN + - BYTE + - INT16 + - INT32 + - INT64 + - FLOAT + - DOUBLE + - DECIMAL + - STRING + - BINARY + - TIMESTAMP + - DATE + - TIME + - RECORD + - 'NULL' + mode: + description: Required. Additional field semantics. + type: string + enumDescriptions: + - Mode unspecified. + - The field has required semantics. + - The field has optional semantics, and may be null. + - >- + The field has repeated (0 or more) semantics, and is a list of + values. + enum: + - MODE_UNSPECIFIED + - REQUIRED + - NULLABLE + - REPEATED + fields: + description: Optional. Any nested field for complex types. type: array items: - $ref: '#/components/schemas/GoogleCloudDataplexV1Zone' - nextPageToken: - description: >- - Token to retrieve the next page of results, or empty if there are no - more results in the list. - type: string - GoogleCloudDataplexV1Asset: - id: GoogleCloudDataplexV1Asset + $ref: '#/components/schemas/GoogleCloudDataplexV1SchemaSchemaField' + GoogleCloudDataplexV1SchemaPartitionField: + id: GoogleCloudDataplexV1SchemaPartitionField description: >- - An asset represents a cloud resource that is being managed within a lake - as a member of a zone. + Represents a key field within the entity's partition structure. You + could have up to 20 partition fields, but only the first 10 partitions + have the filtering ability due to performance consideration. Note: + Partition fields are immutable. type: object properties: name: description: >- - Output only. The relative resource name of the asset, of the form: - projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}. + Required. Partition field name must consist of letters, numbers, and + underscores only, with a maximum of length of 256 characters, and + must begin with a letter or underscore.. + type: string + type: + description: Required. Immutable. The type of field. + type: string + enumDescriptions: + - SchemaType unspecified. + - Boolean field. + - Single byte numeric field. + - 16-bit numeric field. + - 32-bit numeric field. + - 64-bit numeric field. + - Floating point numeric field. + - Double precision numeric field. + - Real value numeric field. + - Sequence of characters field. + - Sequence of bytes field. + - Date and time field. + - Date field. + - Time field. + - >- + Structured field. Nested fields that define the structure of the + map. If all nested fields are nullable, this field represents a + union. + - Null field that does not have values. + enum: + - TYPE_UNSPECIFIED + - BOOLEAN + - BYTE + - INT16 + - INT32 + - INT64 + - FLOAT + - DOUBLE + - DECIMAL + - STRING + - BINARY + - TIMESTAMP + - DATE + - TIME + - RECORD + - 'NULL' + GoogleCloudDataplexV1ListEntitiesResponse: + id: GoogleCloudDataplexV1ListEntitiesResponse + description: List metadata entities response. + type: object + properties: + entities: + description: Entities in the specified parent zone. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDataplexV1Entity' + nextPageToken: + description: >- + Token to retrieve the next page of results, or empty if there are no + remaining results in the list. + type: string + GoogleCloudDataplexV1Partition: + id: GoogleCloudDataplexV1Partition + description: Represents partition metadata contained within entity instances. + type: object + properties: + name: + description: >- + Output only. Partition values used in the HTTP URL must be double + encoded. For example, url_encode(url_encode(value)) can be used to + encode "US:CA/CA#Sunnyvale so that the request URL ends with + "/partitions/US%253ACA/CA%2523Sunnyvale". The name field in the + response retains the encoded format. + readOnly: true + type: string + values: + description: >- + Required. Immutable. The set of values representing the partition, + which correspond to the partition schema defined in the parent + entity. + type: array + items: + type: string + location: + description: >- + Required. Immutable. The location of the entity data within the + partition, for example, + gs://bucket/path/to/entity/key1=value1/key2=value2. Or + projects//datasets//tables/ + type: string + etag: + description: Optional. The etag for this partition. + deprecated: true + type: string + GoogleCloudDataplexV1ListPartitionsResponse: + id: GoogleCloudDataplexV1ListPartitionsResponse + description: List metadata partitions response. + type: object + properties: + partitions: + description: Partitions under the specified parent entity. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDataplexV1Partition' + nextPageToken: + description: >- + Token to retrieve the next page of results, or empty if there are no + remaining results in the list. + type: string + GoogleCloudDataplexV1Lake: + id: GoogleCloudDataplexV1Lake + description: >- + A lake is a centralized repository for managing enterprise data across + the organization distributed across many cloud projects, and stored in a + variety of storage services such as Google Cloud Storage and BigQuery. + The resources attached to a lake are referred to as managed resources. + Data within these managed resources can be structured or unstructured. A + lake provides data admins with tools to organize, secure and manage + their data at scale, and provides data scientists and data engineers an + integrated experience to easily search, discover, analyze and transform + data and associated metadata. + type: object + properties: + name: + description: >- + Output only. The relative resource name of the lake, of the form: + projects/{project_number}/locations/{location_id}/lakes/{lake_id}. readOnly: true type: string displayName: @@ -4492,31 +4686,31 @@ components: type: string uid: description: >- - Output only. System generated globally unique ID for the asset. This - ID will be different if the asset is deleted and re-created with the + Output only. System generated globally unique ID for the lake. This + ID will be different if the lake is deleted and re-created with the same name. readOnly: true type: string createTime: - description: Output only. The time when the asset was created. + description: Output only. The time when the lake was created. readOnly: true type: string format: google-datetime updateTime: - description: Output only. The time when the asset was last updated. + description: Output only. The time when the lake was last updated. readOnly: true type: string format: google-datetime labels: - description: Optional. User defined labels for the asset. + description: Optional. User-defined labels for the lake. type: object additionalProperties: type: string description: - description: Optional. Description of the asset. + description: Optional. Description of the lake. type: string state: - description: Output only. Current state of the asset. + description: Output only. Current state of the lake. readOnly: true type: string enumDescriptions: @@ -4531,334 +4725,384 @@ components: - CREATING - DELETING - ACTION_REQUIRED - resourceSpec: + serviceAccount: description: >- - Required. Specification of the resource that is referenced by this - asset. - $ref: '#/components/schemas/GoogleCloudDataplexV1AssetResourceSpec' - resourceStatus: - description: Output only. Status of the resource referenced by this asset. + Output only. Service account associated with this lake. This service + account must be authorized to access or operate on resources managed + by the lake. readOnly: true - $ref: '#/components/schemas/GoogleCloudDataplexV1AssetResourceStatus' - securityStatus: + type: string + metastore: description: >- - Output only. Status of the security policy applied to resource - referenced by this asset. + Optional. Settings to manage lake and Dataproc Metastore service + instance association. + $ref: '#/components/schemas/GoogleCloudDataplexV1LakeMetastore' + assetStatus: + description: Output only. Aggregated status of the underlying assets of the lake. readOnly: true - $ref: '#/components/schemas/GoogleCloudDataplexV1AssetSecurityStatus' - discoverySpec: - description: >- - Optional. Specification of the discovery feature applied to data - referenced by this asset. When this spec is left unset, the asset - will use the spec set on the parent zone. - $ref: '#/components/schemas/GoogleCloudDataplexV1AssetDiscoverySpec' - discoveryStatus: - description: >- - Output only. Status of the discovery feature applied to data - referenced by this asset. + $ref: '#/components/schemas/GoogleCloudDataplexV1AssetStatus' + metastoreStatus: + description: Output only. Metastore status of the lake. readOnly: true - $ref: '#/components/schemas/GoogleCloudDataplexV1AssetDiscoveryStatus' - GoogleCloudDataplexV1AssetResourceSpec: - id: GoogleCloudDataplexV1AssetResourceSpec - description: Identifies the cloud resource that is referenced by this asset. + $ref: '#/components/schemas/GoogleCloudDataplexV1LakeMetastoreStatus' + GoogleCloudDataplexV1LakeMetastore: + id: GoogleCloudDataplexV1LakeMetastore + description: Settings to manage association of Dataproc Metastore with a lake. type: object properties: - name: + service: description: >- - Immutable. Relative name of the cloud resource that contains the - data that is being managed within a lake. For example: - projects/{project_number}/buckets/{bucket_id} - projects/{project_number}/datasets/{dataset_id} + Optional. A relative reference to the Dataproc Metastore + (https://cloud.google.com/dataproc-metastore/docs) service + associated with the lake: + projects/{project_id}/locations/{location_id}/services/{service_id} type: string - type: - description: Required. Immutable. Type of resource. + GoogleCloudDataplexV1AssetStatus: + id: GoogleCloudDataplexV1AssetStatus + description: Aggregated status of the underlying assets of a lake or zone. + type: object + properties: + updateTime: + description: Last update time of the status. type: string - enumDescriptions: - - Type not specified. - - Cloud Storage bucket. - - BigQuery dataset. - enum: - - TYPE_UNSPECIFIED - - STORAGE_BUCKET - - BIGQUERY_DATASET - readAccessMode: + format: google-datetime + activeAssets: + description: Number of active assets. + type: integer + format: int32 + securityPolicyApplyingAssets: description: >- - Optional. Determines how read permissions are handled for each asset - and their associated tables. Only available to storage buckets - assets. - type: string - enumDescriptions: - - Access mode unspecified. - - Default. Data is accessed directly using storage APIs. - - Data is accessed through a managed interface using BigQuery APIs. - enum: - - ACCESS_MODE_UNSPECIFIED - - DIRECT - - MANAGED - GoogleCloudDataplexV1AssetResourceStatus: - id: GoogleCloudDataplexV1AssetResourceStatus - description: Status of the resource referenced by an asset. + Number of assets that are in process of updating the security policy + on attached resources. + type: integer + format: int32 + GoogleCloudDataplexV1LakeMetastoreStatus: + id: GoogleCloudDataplexV1LakeMetastoreStatus + description: Status of Lake and Dataproc Metastore service instance association. type: object properties: state: - description: The current state of the managed resource. + description: Current state of association. type: string enumDescriptions: - - State unspecified. - - Resource does not have any errors. - - Resource has errors. + - Unspecified. + - A Metastore service instance is not associated with the lake. + - A Metastore service instance is attached to the lake. + - Attach/detach is in progress. + - Attach/detach could not be done due to errors. enum: - STATE_UNSPECIFIED + - NONE - READY + - UPDATING - ERROR message: - description: Additional information about the current state. + description: Additional information about the current status. type: string updateTime: - description: Last update time of the status. + description: Last update time of the metastore status of the lake. type: string format: google-datetime - managedAccessIdentity: - description: >- - Output only. Service account associated with the BigQuery - Connection. - readOnly: true - type: string - GoogleCloudDataplexV1AssetSecurityStatus: - id: GoogleCloudDataplexV1AssetSecurityStatus - description: >- - Security policy status of the asset. Data security policy, i.e., - readers, writers & owners, should be specified in the lake/zone/asset - IAM policy. - type: object - properties: - state: - description: >- - The current state of the security policy applied to the attached - resource. - type: string - enumDescriptions: - - State unspecified. - - >- - Security policy has been successfully applied to the attached - resource. - - >- - Security policy is in the process of being applied to the attached - resource. - - >- - Security policy could not be applied to the attached resource due - to errors. - enum: - - STATE_UNSPECIFIED - - READY - - APPLYING - - ERROR - message: - description: Additional information about the current state. - type: string - updateTime: - description: Last update time of the status. + endpoint: + description: The URI of the endpoint used to access the Metastore service. type: string - format: google-datetime - GoogleCloudDataplexV1AssetDiscoverySpec: - id: GoogleCloudDataplexV1AssetDiscoverySpec - description: Settings to manage the metadata discovery and publishing for an asset. + GoogleCloudDataplexV1ListLakesResponse: + id: GoogleCloudDataplexV1ListLakesResponse + description: List lakes response. type: object properties: - enabled: - description: Optional. Whether discovery is enabled. - type: boolean - includePatterns: - description: >- - Optional. The list of patterns to apply for selecting data to - include during discovery if only a subset of the data should - considered. For Cloud Storage bucket assets, these are interpreted - as glob patterns used to match object names. For BigQuery dataset - assets, these are interpreted as patterns to match table names. + lakes: + description: Lakes under the given parent location. type: array items: - type: string - excludePatterns: + $ref: '#/components/schemas/GoogleCloudDataplexV1Lake' + nextPageToken: description: >- - Optional. The list of patterns to apply for selecting data to - exclude during discovery. For Cloud Storage bucket assets, these are - interpreted as glob patterns used to match object names. For - BigQuery dataset assets, these are interpreted as patterns to match - table names. + Token to retrieve the next page of results, or empty if there are no + more results in the list. + type: string + unreachableLocations: + description: Locations that could not be reached. type: array items: type: string - csvOptions: - description: Optional. Configuration for CSV data. - $ref: >- - #/components/schemas/GoogleCloudDataplexV1AssetDiscoverySpecCsvOptions - jsonOptions: - description: Optional. Configuration for Json data. - $ref: >- - #/components/schemas/GoogleCloudDataplexV1AssetDiscoverySpecJsonOptions - schedule: - description: >- - Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for - running discovery periodically. Successive discovery runs must be - scheduled at least 60 minutes apart. The default value is to run - discovery every 60 minutes. To explicitly set a timezone to the cron - tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or - TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid - string from IANA time zone database. For example, - CRON_TZ=America/New_York 1 * * * *, or TZ=America/New_York 1 * * * - *. - type: string - GoogleCloudDataplexV1AssetDiscoverySpecCsvOptions: - id: GoogleCloudDataplexV1AssetDiscoverySpecCsvOptions - description: Describe CSV and similar semi-structured data formats. + GoogleCloudDataplexV1ListActionsResponse: + id: GoogleCloudDataplexV1ListActionsResponse + description: List actions response. type: object properties: - headerRows: - description: >- - Optional. The number of rows to interpret as header rows that should - be skipped when reading data rows. - type: integer - format: int32 - delimiter: - description: >- - Optional. The delimiter being used to separate values. This defaults - to ','. - type: string - encoding: - description: Optional. The character encoding of the data. The default is UTF-8. - type: string - disableTypeInference: + actions: + description: Actions under the given parent lake/zone/asset. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDataplexV1Action' + nextPageToken: description: >- - Optional. Whether to disable the inference of data type for CSV - data. If true, all columns will be registered as strings. - type: boolean - GoogleCloudDataplexV1AssetDiscoverySpecJsonOptions: - id: GoogleCloudDataplexV1AssetDiscoverySpecJsonOptions - description: Describe JSON data format. - type: object - properties: - encoding: - description: Optional. The character encoding of the data. The default is UTF-8. + Token to retrieve the next page of results, or empty if there are no + more results in the list. type: string - disableTypeInference: - description: >- - Optional. Whether to disable the inference of data type for Json - data. If true, all columns will be registered as their primitive - types (strings, number or boolean). - type: boolean - GoogleCloudDataplexV1AssetDiscoveryStatus: - id: GoogleCloudDataplexV1AssetDiscoveryStatus - description: Status of discovery for an asset. + GoogleCloudDataplexV1Action: + id: GoogleCloudDataplexV1Action + description: >- + Action represents an issue requiring administrator action for + resolution. type: object properties: - state: - description: The current status of the discovery feature. + category: + description: The category of issue associated with the action. type: string enumDescriptions: - - State is unspecified. - - Discovery for the asset is scheduled. - - Discovery for the asset is running. - - >- - Discovery for the asset is currently paused (e.g. due to a lack of - available resources). It will be automatically resumed. - - Discovery for the asset is disabled. + - Unspecified category. + - Resource management related issues. + - Security policy related issues. + - Data and discovery related issues. enum: - - STATE_UNSPECIFIED - - SCHEDULED - - IN_PROGRESS - - PAUSED - - DISABLED - message: - description: Additional information about the current state. - type: string - updateTime: - description: Last update time of the status. + - CATEGORY_UNSPECIFIED + - RESOURCE_MANAGEMENT + - SECURITY_POLICY + - DATA_DISCOVERY + issue: + description: Detailed description of the issue requiring action. type: string - format: google-datetime - lastRunTime: - description: The start time of the last discovery run. + detectTime: + description: The time that the issue was detected. type: string format: google-datetime - stats: - description: Data Stats of the asset reported by discovery. - $ref: '#/components/schemas/GoogleCloudDataplexV1AssetDiscoveryStatusStats' - lastRunDuration: - description: The duration of the last discovery run. - type: string - format: google-duration - GoogleCloudDataplexV1AssetDiscoveryStatusStats: - id: GoogleCloudDataplexV1AssetDiscoveryStatusStats - description: The aggregated data statistics for the asset reported by discovery. - type: object - properties: - dataItems: - description: The count of data items within the referenced resource. - type: string - format: int64 - dataSize: - description: The number of stored data bytes within the referenced resource. - type: string - format: int64 - tables: - description: The count of table entities within the referenced resource. - type: string - format: int64 - filesets: - description: The count of fileset entities within the referenced resource. - type: string - format: int64 - GoogleCloudDataplexV1ListAssetsResponse: - id: GoogleCloudDataplexV1ListAssetsResponse - description: List assets response. - type: object - properties: - assets: - description: Asset under the given parent zone. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDataplexV1Asset' - nextPageToken: - description: >- - Token to retrieve the next page of results, or empty if there are no - more results in the list. - type: string - GoogleCloudDataplexV1Task: - id: GoogleCloudDataplexV1Task - description: A task represents a user-visible job. - type: object - properties: name: description: >- - Output only. The relative resource name of the task, of the form: - projects/{project_number}/locations/{location_id}/lakes/{lake_id}/ - tasks/{task_id}. + Output only. The relative resource name of the action, of the form: + projects/{project}/locations/{location}/lakes/{lake}/actions/{action} + projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/actions/{action} + projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/assets/{asset}/actions/{action}. readOnly: true type: string - uid: + lake: description: >- - Output only. System generated globally unique ID for the task. This - ID will be different if the task is deleted and re-created with the - same name. + Output only. The relative resource name of the lake, of the form: + projects/{project_number}/locations/{location_id}/lakes/{lake_id}. readOnly: true type: string - createTime: - description: Output only. The time when the task was created. + zone: + description: >- + Output only. The relative resource name of the zone, of the form: + projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}. + readOnly: true + type: string + asset: + description: >- + Output only. The relative resource name of the asset, of the form: + projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}. + readOnly: true + type: string + dataLocations: + description: >- + The list of data locations associated with this action. Cloud + Storage locations are represented as URI paths(E.g. + gs://bucket/table1/year=2020/month=Jan/). BigQuery locations refer + to resource names(E.g. + bigquery.googleapis.com/projects/project-id/datasets/dataset-id). + type: array + items: + type: string + invalidDataFormat: + description: Details for issues related to invalid or unsupported data formats. + $ref: '#/components/schemas/GoogleCloudDataplexV1ActionInvalidDataFormat' + incompatibleDataSchema: + description: >- + Details for issues related to incompatible schemas detected within + data. + $ref: >- + #/components/schemas/GoogleCloudDataplexV1ActionIncompatibleDataSchema + invalidDataPartition: + description: >- + Details for issues related to invalid or unsupported data partition + structure. + $ref: '#/components/schemas/GoogleCloudDataplexV1ActionInvalidDataPartition' + missingData: + description: >- + Details for issues related to absence of data within managed + resources. + $ref: '#/components/schemas/GoogleCloudDataplexV1ActionMissingData' + missingResource: + description: Details for issues related to absence of a managed resource. + $ref: '#/components/schemas/GoogleCloudDataplexV1ActionMissingResource' + unauthorizedResource: + description: >- + Details for issues related to lack of permissions to access data + resources. + $ref: '#/components/schemas/GoogleCloudDataplexV1ActionUnauthorizedResource' + failedSecurityPolicyApply: + description: Details for issues related to applying security policy. + $ref: >- + #/components/schemas/GoogleCloudDataplexV1ActionFailedSecurityPolicyApply + invalidDataOrganization: + description: Details for issues related to invalid data arrangement. + $ref: >- + #/components/schemas/GoogleCloudDataplexV1ActionInvalidDataOrganization + GoogleCloudDataplexV1ActionInvalidDataFormat: + id: GoogleCloudDataplexV1ActionInvalidDataFormat + description: >- + Action details for invalid or unsupported data files detected by + discovery. + type: object + properties: + sampledDataLocations: + description: >- + The list of data locations sampled and used for format/schema + inference. + type: array + items: + type: string + expectedFormat: + description: The expected data format of the entity. + type: string + newFormat: + description: The new unexpected data format within the entity. + type: string + GoogleCloudDataplexV1ActionIncompatibleDataSchema: + id: GoogleCloudDataplexV1ActionIncompatibleDataSchema + description: Action details for incompatible schemas detected by discovery. + type: object + properties: + table: + description: The name of the table containing invalid data. + type: string + existingSchema: + description: >- + The existing and expected schema of the table. The schema is + provided as a JSON formatted structure listing columns and data + types. + type: string + newSchema: + description: >- + The new and incompatible schema within the table. The schema is + provided as a JSON formatted structured listing columns and data + types. + type: string + sampledDataLocations: + description: >- + The list of data locations sampled and used for format/schema + inference. + type: array + items: + type: string + schemaChange: + description: >- + Whether the action relates to a schema that is incompatible or + modified. + type: string + enumDescriptions: + - Schema change unspecified. + - Newly discovered schema is incompatible with existing schema. + - >- + Newly discovered schema has changed from existing schema for data + in a curated zone. + enum: + - SCHEMA_CHANGE_UNSPECIFIED + - INCOMPATIBLE + - MODIFIED + GoogleCloudDataplexV1ActionInvalidDataPartition: + id: GoogleCloudDataplexV1ActionInvalidDataPartition + description: >- + Action details for invalid or unsupported partitions detected by + discovery. + type: object + properties: + expectedStructure: + description: The issue type of InvalidDataPartition. + type: string + enumDescriptions: + - PartitionStructure unspecified. + - >- + Consistent hive-style partition definition (both raw and curated + zone). + - Hive style partition definition (curated zone only). + enum: + - PARTITION_STRUCTURE_UNSPECIFIED + - CONSISTENT_KEYS + - HIVE_STYLE_KEYS + GoogleCloudDataplexV1ActionMissingData: + id: GoogleCloudDataplexV1ActionMissingData + description: Action details for absence of data detected by discovery. + type: object + properties: {} + GoogleCloudDataplexV1ActionMissingResource: + id: GoogleCloudDataplexV1ActionMissingResource + description: Action details for resource references in assets that cannot be located. + type: object + properties: {} + GoogleCloudDataplexV1ActionUnauthorizedResource: + id: GoogleCloudDataplexV1ActionUnauthorizedResource + description: >- + Action details for unauthorized resource issues raised to indicate that + the service account associated with the lake instance is not authorized + to access or manage the resource associated with an asset. + type: object + properties: {} + GoogleCloudDataplexV1ActionFailedSecurityPolicyApply: + id: GoogleCloudDataplexV1ActionFailedSecurityPolicyApply + description: >- + Failed to apply security policy to the managed resource(s) under a lake, + zone or an asset. For a lake or zone resource, one or more underlying + assets has a failure applying security policy to the associated managed + resource. + type: object + properties: + asset: + description: >- + Resource name of one of the assets with failing security policy + application. Populated for a lake or zone resource only. + type: string + GoogleCloudDataplexV1ActionInvalidDataOrganization: + id: GoogleCloudDataplexV1ActionInvalidDataOrganization + description: Action details for invalid data arrangement. + type: object + properties: {} + GoogleCloudDataplexV1Zone: + id: GoogleCloudDataplexV1Zone + description: >- + A zone represents a logical group of related assets within a lake. A + zone can be used to map to organizational structure or represent stages + of data readiness from raw to curated. It provides managing behavior + that is shared or inherited by all contained assets. + type: object + properties: + name: + description: >- + Output only. The relative resource name of the zone, of the form: + projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}. + readOnly: true + type: string + displayName: + description: Optional. User friendly display name. + type: string + uid: + description: >- + Output only. System generated globally unique ID for the zone. This + ID will be different if the zone is deleted and re-created with the + same name. + readOnly: true + type: string + createTime: + description: Output only. The time when the zone was created. readOnly: true type: string format: google-datetime updateTime: - description: Output only. The time when the task was last updated. + description: Output only. The time when the zone was last updated. readOnly: true type: string format: google-datetime + labels: + description: Optional. User defined labels for the zone. + type: object + additionalProperties: + type: string description: - description: Optional. Description of the task. - type: string - displayName: - description: Optional. User friendly display name. + description: Optional. Description of the zone. type: string state: - description: Output only. Current state of the task. + description: Output only. Current state of the zone. readOnly: true type: string enumDescriptions: @@ -4873,518 +5117,543 @@ components: - CREATING - DELETING - ACTION_REQUIRED - labels: - description: Optional. User-defined labels for the task. - type: object - additionalProperties: - type: string - triggerSpec: - description: >- - Required. Spec related to how often and when a task should be - triggered. - $ref: '#/components/schemas/GoogleCloudDataplexV1TaskTriggerSpec' - executionSpec: - description: Required. Spec related to how a task is executed. - $ref: '#/components/schemas/GoogleCloudDataplexV1TaskExecutionSpec' - executionStatus: - description: Output only. Status of the latest task executions. - readOnly: true - $ref: '#/components/schemas/GoogleCloudDataplexV1TaskExecutionStatus' - spark: - description: Config related to running custom Spark tasks. - $ref: '#/components/schemas/GoogleCloudDataplexV1TaskSparkTaskConfig' - notebook: - description: Config related to running scheduled Notebooks. - $ref: '#/components/schemas/GoogleCloudDataplexV1TaskNotebookTaskConfig' - GoogleCloudDataplexV1TaskTriggerSpec: - id: GoogleCloudDataplexV1TaskTriggerSpec - description: Task scheduling and trigger settings. - type: object - properties: type: - description: Required. Immutable. Trigger type of the user-specified Task. + description: Required. Immutable. The type of the zone. type: string enumDescriptions: - - Unspecified trigger type. - - The task runs one-time shortly after Task Creation. - - The task is scheduled to run periodically. - enum: - - TYPE_UNSPECIFIED - - ON_DEMAND - - RECURRING - startTime: - description: >- - Optional. The first run of the task will be after this time. If not - specified, the task will run shortly after being submitted if - ON_DEMAND and based on the schedule if RECURRING. - type: string - format: google-datetime - disabled: + - Zone type not specified. + - >- + A zone that contains data that needs further processing before it + is considered generally ready for consumption and analytics + workloads. + - >- + A zone that contains data that is considered to be ready for + broader consumption and analytics workloads. Curated structured + data stored in Cloud Storage must conform to certain file formats + (parquet, avro and orc) and organized in a hive-compatible + directory layout. + enum: + - TYPE_UNSPECIFIED + - RAW + - CURATED + discoverySpec: description: >- - Optional. Prevent the task from executing. This does not cancel - already running tasks. It is intended to temporarily disable - RECURRING tasks. + Optional. Specification of the discovery feature applied to data in + this zone. + $ref: '#/components/schemas/GoogleCloudDataplexV1ZoneDiscoverySpec' + resourceSpec: + description: >- + Required. Specification of the resources that are referenced by the + assets within this zone. + $ref: '#/components/schemas/GoogleCloudDataplexV1ZoneResourceSpec' + assetStatus: + description: Output only. Aggregated status of the underlying assets of the zone. + readOnly: true + $ref: '#/components/schemas/GoogleCloudDataplexV1AssetStatus' + GoogleCloudDataplexV1ZoneDiscoverySpec: + id: GoogleCloudDataplexV1ZoneDiscoverySpec + description: Settings to manage the metadata discovery and publishing in a zone. + type: object + properties: + enabled: + description: Required. Whether discovery is enabled. type: boolean - maxRetries: + includePatterns: description: >- - Optional. Number of retry attempts before aborting. Set to zero to - never attempt to retry a failed task. - type: integer - format: int32 + Optional. The list of patterns to apply for selecting data to + include during discovery if only a subset of the data should + considered. For Cloud Storage bucket assets, these are interpreted + as glob patterns used to match object names. For BigQuery dataset + assets, these are interpreted as patterns to match table names. + type: array + items: + type: string + excludePatterns: + description: >- + Optional. The list of patterns to apply for selecting data to + exclude during discovery. For Cloud Storage bucket assets, these are + interpreted as glob patterns used to match object names. For + BigQuery dataset assets, these are interpreted as patterns to match + table names. + type: array + items: + type: string + csvOptions: + description: Optional. Configuration for CSV data. + $ref: >- + #/components/schemas/GoogleCloudDataplexV1ZoneDiscoverySpecCsvOptions + jsonOptions: + description: Optional. Configuration for Json data. + $ref: >- + #/components/schemas/GoogleCloudDataplexV1ZoneDiscoverySpecJsonOptions schedule: description: >- Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for - running tasks periodically. To explicitly set a timezone to the cron + running discovery periodically. Successive discovery runs must be + scheduled at least 60 minutes apart. The default value is to run + discovery every 60 minutes.To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or - "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid + TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, CRON_TZ=America/New_York 1 * * * *, or TZ=America/New_York 1 * * * - *. This field is required for RECURRING tasks. + *. type: string - GoogleCloudDataplexV1TaskExecutionSpec: - id: GoogleCloudDataplexV1TaskExecutionSpec - description: Execution related settings, like retry and service_account. + GoogleCloudDataplexV1ZoneDiscoverySpecCsvOptions: + id: GoogleCloudDataplexV1ZoneDiscoverySpecCsvOptions + description: Describe CSV and similar semi-structured data formats. type: object properties: - args: + headerRows: description: >- - Optional. The arguments to pass to the task. The args can use - placeholders of the format ${placeholder} as part of key/value - string. These will be interpolated before passing the args to the - driver. Currently supported placeholders: - ${task_id} - ${job_time} - To pass positional args, set the key as TASK_ARGS. The value should - be a comma-separated string of all the positional arguments. To use - a delimiter other than comma, refer to - https://cloud.google.com/sdk/gcloud/reference/topic/escaping. In - case of other keys being present in the args, then TASK_ARGS will be - passed as the last argument. - type: object - additionalProperties: - type: string - serviceAccount: + Optional. The number of rows to interpret as header rows that should + be skipped when reading data rows. + type: integer + format: int32 + delimiter: description: >- - Required. Service account to use to execute a task. If not provided, - the default Compute service account for the project is used. + Optional. The delimiter being used to separate values. This defaults + to ','. type: string - project: - description: >- - Optional. The project in which jobs are run. By default, the project - containing the Lake is used. If a project is provided, the - ExecutionSpec.service_account must belong to this project. + encoding: + description: Optional. The character encoding of the data. The default is UTF-8. type: string - maxJobExecutionLifetime: + disableTypeInference: description: >- - Optional. The maximum duration after which the job execution is - expired. + Optional. Whether to disable the inference of data type for CSV + data. If true, all columns will be registered as strings. + type: boolean + GoogleCloudDataplexV1ZoneDiscoverySpecJsonOptions: + id: GoogleCloudDataplexV1ZoneDiscoverySpecJsonOptions + description: Describe JSON data format. + type: object + properties: + encoding: + description: Optional. The character encoding of the data. The default is UTF-8. type: string - format: google-duration - kmsKey: + disableTypeInference: description: >- - Optional. The Cloud KMS key to use for encryption, of the form: - projects/{project_number}/locations/{location_id}/keyRings/{key-ring-name}/cryptoKeys/{key-name}. + Optional. Whether to disable the inference of data type for Json + data. If true, all columns will be registered as their primitive + types (strings, number or boolean). + type: boolean + GoogleCloudDataplexV1ZoneResourceSpec: + id: GoogleCloudDataplexV1ZoneResourceSpec + description: Settings for resources attached as assets within a zone. + type: object + properties: + locationType: + description: >- + Required. Immutable. The location type of the resources that are + allowed to be attached to the assets within this zone. type: string - GoogleCloudDataplexV1TaskExecutionStatus: - id: GoogleCloudDataplexV1TaskExecutionStatus - description: Status of the task execution (e.g. Jobs). + enumDescriptions: + - Unspecified location type. + - Resources that are associated with a single region. + - Resources that are associated with a multi-region location. + enum: + - LOCATION_TYPE_UNSPECIFIED + - SINGLE_REGION + - MULTI_REGION + GoogleCloudDataplexV1ListZonesResponse: + id: GoogleCloudDataplexV1ListZonesResponse + description: List zones response. type: object properties: - updateTime: - description: Output only. Last update time of the status. - readOnly: true + zones: + description: Zones under the given parent lake. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDataplexV1Zone' + nextPageToken: + description: >- + Token to retrieve the next page of results, or empty if there are no + more results in the list. type: string - format: google-datetime - latestJob: - description: Output only. latest job execution - readOnly: true - $ref: '#/components/schemas/GoogleCloudDataplexV1Job' - GoogleCloudDataplexV1Job: - id: GoogleCloudDataplexV1Job - description: A job represents an instance of a task. + GoogleCloudDataplexV1Asset: + id: GoogleCloudDataplexV1Asset + description: >- + An asset represents a cloud resource that is being managed within a lake + as a member of a zone. type: object properties: name: description: >- - Output only. The relative resource name of the job, of the form: - projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}/jobs/{job_id}. + Output only. The relative resource name of the asset, of the form: + projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}. readOnly: true type: string + displayName: + description: Optional. User friendly display name. + type: string uid: - description: Output only. System generated globally unique ID for the job. + description: >- + Output only. System generated globally unique ID for the asset. This + ID will be different if the asset is deleted and re-created with the + same name. readOnly: true type: string - startTime: - description: Output only. The time when the job was started. + createTime: + description: Output only. The time when the asset was created. readOnly: true type: string format: google-datetime - endTime: - description: Output only. The time when the job ended. + updateTime: + description: Output only. The time when the asset was last updated. readOnly: true type: string format: google-datetime + labels: + description: Optional. User defined labels for the asset. + type: object + additionalProperties: + type: string + description: + description: Optional. Description of the asset. + type: string state: - description: Output only. Execution state for the job. + description: Output only. Current state of the asset. readOnly: true type: string enumDescriptions: - - The job state is unknown. - - The job is running. - - The job is cancelling. - - The job cancellation was successful. - - The job completed successfully. - - The job is no longer running due to an error. - - The job was cancelled outside of Dataplex. + - State is not specified. + - Resource is active, i.e., ready to use. + - Resource is under creation. + - Resource is under deletion. + - Resource is active but has unresolved actions. enum: - STATE_UNSPECIFIED - - RUNNING - - CANCELLING - - CANCELLED - - SUCCEEDED - - FAILED - - ABORTED - retryCount: + - ACTIVE + - CREATING + - DELETING + - ACTION_REQUIRED + resourceSpec: description: >- - Output only. The number of times the job has been retried (excluding - the initial attempt). - readOnly: true - type: integer - format: uint32 - service: - description: Output only. The underlying service running a job. + Required. Specification of the resource that is referenced by this + asset. + $ref: '#/components/schemas/GoogleCloudDataplexV1AssetResourceSpec' + resourceStatus: + description: Output only. Status of the resource referenced by this asset. readOnly: true - type: string - enumDescriptions: - - Service used to run the job is unspecified. - - Dataproc service is used to run this job. - enum: - - SERVICE_UNSPECIFIED - - DATAPROC - serviceJob: + $ref: '#/components/schemas/GoogleCloudDataplexV1AssetResourceStatus' + securityStatus: description: >- - Output only. The full resource name for the job run under a - particular service. + Output only. Status of the security policy applied to resource + referenced by this asset. readOnly: true - type: string - message: - description: Output only. Additional information about the current state. + $ref: '#/components/schemas/GoogleCloudDataplexV1AssetSecurityStatus' + discoverySpec: + description: >- + Optional. Specification of the discovery feature applied to data + referenced by this asset. When this spec is left unset, the asset + will use the spec set on the parent zone. + $ref: '#/components/schemas/GoogleCloudDataplexV1AssetDiscoverySpec' + discoveryStatus: + description: >- + Output only. Status of the discovery feature applied to data + referenced by this asset. readOnly: true + $ref: '#/components/schemas/GoogleCloudDataplexV1AssetDiscoveryStatus' + GoogleCloudDataplexV1AssetResourceSpec: + id: GoogleCloudDataplexV1AssetResourceSpec + description: Identifies the cloud resource that is referenced by this asset. + type: object + properties: + name: + description: >- + Immutable. Relative name of the cloud resource that contains the + data that is being managed within a lake. For example: + projects/{project_number}/buckets/{bucket_id} + projects/{project_number}/datasets/{dataset_id} type: string - labels: - description: Output only. User-defined labels for the task. - readOnly: true - type: object - additionalProperties: - type: string - trigger: - description: Output only. Job execution trigger. - readOnly: true + type: + description: Required. Immutable. Type of resource. type: string enumDescriptions: - - The trigger is unspecified. - - >- - The job was triggered by Dataplex based on trigger spec from task - definition. - - The job was triggered by the explicit call of Task API. + - Type not specified. + - Cloud Storage bucket. + - BigQuery dataset. enum: - - TRIGGER_UNSPECIFIED - - TASK_CONFIG - - RUN_REQUEST - executionSpec: - description: Output only. Spec related to how a task is executed. - readOnly: true - $ref: '#/components/schemas/GoogleCloudDataplexV1TaskExecutionSpec' - GoogleCloudDataplexV1TaskSparkTaskConfig: - id: GoogleCloudDataplexV1TaskSparkTaskConfig - description: User-specified config for running a Spark task. + - TYPE_UNSPECIFIED + - STORAGE_BUCKET + - BIGQUERY_DATASET + readAccessMode: + description: >- + Optional. Determines how read permissions are handled for each asset + and their associated tables. Only available to storage buckets + assets. + type: string + enumDescriptions: + - Access mode unspecified. + - Default. Data is accessed directly using storage APIs. + - Data is accessed through a managed interface using BigQuery APIs. + enum: + - ACCESS_MODE_UNSPECIFIED + - DIRECT + - MANAGED + GoogleCloudDataplexV1AssetResourceStatus: + id: GoogleCloudDataplexV1AssetResourceStatus + description: Status of the resource referenced by an asset. type: object properties: - mainJarFileUri: - description: >- - The Cloud Storage URI of the jar file that contains the main class. - The execution args are passed in as a sequence of named process - arguments (--key=value). + state: + description: The current state of the managed resource. type: string - mainClass: - description: >- - The name of the driver's main class. The jar file that contains the - class must be in the default CLASSPATH or specified in - jar_file_uris. The execution args are passed in as a sequence of - named process arguments (--key=value). + enumDescriptions: + - State unspecified. + - Resource does not have any errors. + - Resource has errors. + enum: + - STATE_UNSPECIFIED + - READY + - ERROR + message: + description: Additional information about the current state. type: string - pythonScriptFile: - description: >- - The Gcloud Storage URI of the main Python file to use as the driver. - Must be a .py file. The execution args are passed in as a sequence - of named process arguments (--key=value). + updateTime: + description: Last update time of the status. type: string - sqlScriptFile: + format: google-datetime + managedAccessIdentity: description: >- - A reference to a query file. This should be the Cloud Storage URI of - the query file. The execution args are used to declare a set of - script variables (set key="value";). + Output only. Service account associated with the BigQuery + Connection. + readOnly: true type: string - sqlScript: + GoogleCloudDataplexV1AssetSecurityStatus: + id: GoogleCloudDataplexV1AssetSecurityStatus + description: >- + Security policy status of the asset. Data security policy, i.e., + readers, writers & owners, should be specified in the lake/zone/asset + IAM policy. + type: object + properties: + state: description: >- - The query text. The execution args are used to declare a set of - script variables (set key="value";). + The current state of the security policy applied to the attached + resource. type: string - fileUris: + enumDescriptions: + - State unspecified. + - >- + Security policy has been successfully applied to the attached + resource. + - >- + Security policy is in the process of being applied to the attached + resource. + - >- + Security policy could not be applied to the attached resource due + to errors. + enum: + - STATE_UNSPECIFIED + - READY + - APPLYING + - ERROR + message: + description: Additional information about the current state. + type: string + updateTime: + description: Last update time of the status. + type: string + format: google-datetime + GoogleCloudDataplexV1AssetDiscoverySpec: + id: GoogleCloudDataplexV1AssetDiscoverySpec + description: Settings to manage the metadata discovery and publishing for an asset. + type: object + properties: + enabled: + description: Optional. Whether discovery is enabled. + type: boolean + includePatterns: description: >- - Optional. Cloud Storage URIs of files to be placed in the working - directory of each executor. + Optional. The list of patterns to apply for selecting data to + include during discovery if only a subset of the data should + considered. For Cloud Storage bucket assets, these are interpreted + as glob patterns used to match object names. For BigQuery dataset + assets, these are interpreted as patterns to match table names. type: array items: type: string - archiveUris: + excludePatterns: description: >- - Optional. Cloud Storage URIs of archives to be extracted into the - working directory of each executor. Supported file types: .jar, - .tar, .tar.gz, .tgz, and .zip. + Optional. The list of patterns to apply for selecting data to + exclude during discovery. For Cloud Storage bucket assets, these are + interpreted as glob patterns used to match object names. For + BigQuery dataset assets, these are interpreted as patterns to match + table names. type: array items: type: string - infrastructureSpec: - description: Optional. Infrastructure specification for the execution. - $ref: '#/components/schemas/GoogleCloudDataplexV1TaskInfrastructureSpec' - GoogleCloudDataplexV1TaskInfrastructureSpec: - id: GoogleCloudDataplexV1TaskInfrastructureSpec - description: Configuration for the underlying infrastructure used to run workloads. - type: object - properties: - batch: - description: Compute resources needed for a Task when using Dataproc Serverless. - $ref: >- - #/components/schemas/GoogleCloudDataplexV1TaskInfrastructureSpecBatchComputeResources - containerImage: - description: Container Image Runtime Configuration. + csvOptions: + description: Optional. Configuration for CSV data. $ref: >- - #/components/schemas/GoogleCloudDataplexV1TaskInfrastructureSpecContainerImageRuntime - vpcNetwork: - description: Vpc network. + #/components/schemas/GoogleCloudDataplexV1AssetDiscoverySpecCsvOptions + jsonOptions: + description: Optional. Configuration for Json data. $ref: >- - #/components/schemas/GoogleCloudDataplexV1TaskInfrastructureSpecVpcNetwork - GoogleCloudDataplexV1TaskInfrastructureSpecBatchComputeResources: - id: GoogleCloudDataplexV1TaskInfrastructureSpecBatchComputeResources - description: Batch compute resources associated with the task. + #/components/schemas/GoogleCloudDataplexV1AssetDiscoverySpecJsonOptions + schedule: + description: >- + Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for + running discovery periodically. Successive discovery runs must be + scheduled at least 60 minutes apart. The default value is to run + discovery every 60 minutes.To explicitly set a timezone to the cron + tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or + TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid + string from IANA time zone database. For example, + CRON_TZ=America/New_York 1 * * * *, or TZ=America/New_York 1 * * * + *. + type: string + GoogleCloudDataplexV1AssetDiscoverySpecCsvOptions: + id: GoogleCloudDataplexV1AssetDiscoverySpecCsvOptions + description: Describe CSV and similar semi-structured data formats. type: object properties: - executorsCount: + headerRows: description: >- - Optional. Total number of job executors. Executor Count should be - between 2 and 100. Default=2 + Optional. The number of rows to interpret as header rows that should + be skipped when reading data rows. type: integer format: int32 - maxExecutorsCount: + delimiter: description: >- - Optional. Max configurable executors. If max_executors_count > - executors_count, then auto-scaling is enabled. Max Executor Count - should be between 2 and 1000. Default=1000 - type: integer - format: int32 - GoogleCloudDataplexV1TaskInfrastructureSpecContainerImageRuntime: - id: GoogleCloudDataplexV1TaskInfrastructureSpecContainerImageRuntime - description: Container Image Runtime Configuration used with Batch execution. - type: object - properties: - image: - description: Optional. Container image to use. + Optional. The delimiter being used to separate values. This defaults + to ','. type: string - javaJars: + encoding: + description: Optional. The character encoding of the data. The default is UTF-8. + type: string + disableTypeInference: description: >- - Optional. A list of Java JARS to add to the classpath. Valid input - includes Cloud Storage URIs to Jar binaries. For example, - gs://bucket-name/my/path/to/file.jar - type: array - items: - type: string - pythonPackages: - description: >- - Optional. A list of python packages to be installed. Valid formats - include Cloud Storage URI to a PIP installable library. For example, - gs://bucket-name/my/path/to/lib.tar.gz - type: array - items: - type: string - properties: - description: >- - Optional. Override to common configuration of open source components - installed on the Dataproc cluster. The properties to set on daemon - config files. Property keys are specified in prefix:property format, - for example core:hadoop.tmp.dir. For more information, see Cluster - properties - (https://cloud.google.com/dataproc/docs/concepts/cluster-properties). - type: object - additionalProperties: - type: string - GoogleCloudDataplexV1TaskInfrastructureSpecVpcNetwork: - id: GoogleCloudDataplexV1TaskInfrastructureSpecVpcNetwork - description: Cloud VPC Network used to run the infrastructure. + Optional. Whether to disable the inference of data type for CSV + data. If true, all columns will be registered as strings. + type: boolean + GoogleCloudDataplexV1AssetDiscoverySpecJsonOptions: + id: GoogleCloudDataplexV1AssetDiscoverySpecJsonOptions + description: Describe JSON data format. type: object properties: - network: - description: >- - Optional. The Cloud VPC network in which the job is run. By default, - the Cloud VPC network named Default within the project is used. - type: string - subNetwork: - description: Optional. The Cloud VPC sub-network in which the job is run. + encoding: + description: Optional. The character encoding of the data. The default is UTF-8. type: string - networkTags: - description: Optional. List of network tags to apply to the job. - type: array - items: - type: string - GoogleCloudDataplexV1TaskNotebookTaskConfig: - id: GoogleCloudDataplexV1TaskNotebookTaskConfig - description: Config for running scheduled notebooks. + disableTypeInference: + description: >- + Optional. Whether to disable the inference of data type for Json + data. If true, all columns will be registered as their primitive + types (strings, number or boolean). + type: boolean + GoogleCloudDataplexV1AssetDiscoveryStatus: + id: GoogleCloudDataplexV1AssetDiscoveryStatus + description: Status of discovery for an asset. type: object properties: - notebook: - description: >- - Required. Path to input notebook. This can be the Cloud Storage URI - of the notebook file or the path to a Notebook Content. The - execution args are accessible as environment variables - (TASK_key=value). + state: + description: The current status of the discovery feature. type: string - infrastructureSpec: - description: Optional. Infrastructure specification for the execution. - $ref: '#/components/schemas/GoogleCloudDataplexV1TaskInfrastructureSpec' - fileUris: - description: >- - Optional. Cloud Storage URIs of files to be placed in the working - directory of each executor. - type: array - items: - type: string - archiveUris: - description: >- - Optional. Cloud Storage URIs of archives to be extracted into the - working directory of each executor. Supported file types: .jar, - .tar, .tar.gz, .tgz, and .zip. - type: array - items: - type: string - GoogleCloudDataplexV1ListTasksResponse: - id: GoogleCloudDataplexV1ListTasksResponse - description: List tasks response. + enumDescriptions: + - State is unspecified. + - Discovery for the asset is scheduled. + - Discovery for the asset is running. + - >- + Discovery for the asset is currently paused (e.g. due to a lack of + available resources). It will be automatically resumed. + - Discovery for the asset is disabled. + enum: + - STATE_UNSPECIFIED + - SCHEDULED + - IN_PROGRESS + - PAUSED + - DISABLED + message: + description: Additional information about the current state. + type: string + updateTime: + description: Last update time of the status. + type: string + format: google-datetime + lastRunTime: + description: The start time of the last discovery run. + type: string + format: google-datetime + stats: + description: Data Stats of the asset reported by discovery. + $ref: '#/components/schemas/GoogleCloudDataplexV1AssetDiscoveryStatusStats' + lastRunDuration: + description: The duration of the last discovery run. + type: string + format: google-duration + GoogleCloudDataplexV1AssetDiscoveryStatusStats: + id: GoogleCloudDataplexV1AssetDiscoveryStatusStats + description: The aggregated data statistics for the asset reported by discovery. type: object properties: - tasks: - description: Tasks under the given parent lake. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDataplexV1Task' - nextPageToken: - description: >- - Token to retrieve the next page of results, or empty if there are no - more results in the list. + dataItems: + description: The count of data items within the referenced resource. type: string - unreachableLocations: - description: Locations that could not be reached. - type: array - items: - type: string - GoogleCloudDataplexV1ListJobsResponse: - id: GoogleCloudDataplexV1ListJobsResponse - description: List jobs response. + format: int64 + dataSize: + description: The number of stored data bytes within the referenced resource. + type: string + format: int64 + tables: + description: The count of table entities within the referenced resource. + type: string + format: int64 + filesets: + description: The count of fileset entities within the referenced resource. + type: string + format: int64 + GoogleCloudDataplexV1ListAssetsResponse: + id: GoogleCloudDataplexV1ListAssetsResponse + description: List assets response. type: object properties: - jobs: - description: Jobs under a given task. + assets: + description: Asset under the given parent zone. type: array items: - $ref: '#/components/schemas/GoogleCloudDataplexV1Job' + $ref: '#/components/schemas/GoogleCloudDataplexV1Asset' nextPageToken: description: >- Token to retrieve the next page of results, or empty if there are no more results in the list. type: string - GoogleCloudDataplexV1RunTaskRequest: - id: GoogleCloudDataplexV1RunTaskRequest - type: object - properties: - labels: - description: >- - Optional. User-defined labels for the task. If the map is left - empty, the task will run with existing labels from task definition. - If the map contains an entry with a new key, the same will be added - to existing set of labels. If the map contains an entry with an - existing label key in task definition, the task will run with new - label value for that entry. Clearing an existing label will require - label value to be explicitly set to a hyphen "-". The label value - cannot be empty. - type: object - additionalProperties: - type: string - args: - description: >- - Optional. Execution spec arguments. If the map is left empty, the - task will run with existing execution spec args from task - definition. If the map contains an entry with a new key, the same - will be added to existing set of args. If the map contains an entry - with an existing arg key in task definition, the task will run with - new arg value for that entry. Clearing an existing arg will require - arg value to be explicitly set to a hyphen "-". The arg value cannot - be empty. - type: object - additionalProperties: - type: string - GoogleCloudDataplexV1RunTaskResponse: - id: GoogleCloudDataplexV1RunTaskResponse - type: object - properties: - job: - description: Jobs created by RunTask API. - $ref: '#/components/schemas/GoogleCloudDataplexV1Job' - GoogleCloudDataplexV1CancelJobRequest: - id: GoogleCloudDataplexV1CancelJobRequest - description: Cancel task jobs. - type: object - properties: {} - GoogleCloudDataplexV1Environment: - id: GoogleCloudDataplexV1Environment - description: >- - Environment represents a user-visible compute infrastructure for - analytics within a lake. + GoogleCloudDataplexV1Task: + id: GoogleCloudDataplexV1Task + description: A task represents a user-visible job. type: object properties: name: description: >- - Output only. The relative resource name of the environment, of the - form: - projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id} + Output only. The relative resource name of the task, of the form: + projects/{project_number}/locations/{location_id}/lakes/{lake_id}/ + tasks/{task_id}. readOnly: true type: string - displayName: - description: Optional. User friendly display name. - type: string uid: description: >- - Output only. System generated globally unique ID for the - environment. This ID will be different if the environment is deleted - and re-created with the same name. + Output only. System generated globally unique ID for the task. This + ID will be different if the task is deleted and re-created with the + same name. readOnly: true type: string createTime: - description: Output only. Environment creation time. + description: Output only. The time when the task was created. readOnly: true type: string format: google-datetime updateTime: - description: Output only. The time when the environment was last updated. + description: Output only. The time when the task was last updated. readOnly: true type: string format: google-datetime - labels: - description: Optional. User defined labels for the environment. - type: object - additionalProperties: - type: string description: - description: Optional. Description of the environment. + description: Optional. Description of the task. + type: string + displayName: + description: Optional. User friendly display name. type: string state: - description: Output only. Current state of the environment. + description: Output only. Current state of the task. readOnly: true type: string enumDescriptions: @@ -5399,1653 +5668,2581 @@ components: - CREATING - DELETING - ACTION_REQUIRED - infrastructureSpec: - description: Required. Infrastructure specification for the Environment. - $ref: >- - #/components/schemas/GoogleCloudDataplexV1EnvironmentInfrastructureSpec - sessionSpec: - description: Optional. Configuration for sessions created for this environment. - $ref: '#/components/schemas/GoogleCloudDataplexV1EnvironmentSessionSpec' - sessionStatus: - description: Output only. Status of sessions created for this environment. - readOnly: true - $ref: '#/components/schemas/GoogleCloudDataplexV1EnvironmentSessionStatus' - endpoints: + labels: + description: Optional. User-defined labels for the task. + type: object + additionalProperties: + type: string + triggerSpec: description: >- - Output only. URI Endpoints to access sessions associated with the - Environment. + Required. Spec related to how often and when a task should be + triggered. + $ref: '#/components/schemas/GoogleCloudDataplexV1TaskTriggerSpec' + executionSpec: + description: Required. Spec related to how a task is executed. + $ref: '#/components/schemas/GoogleCloudDataplexV1TaskExecutionSpec' + executionStatus: + description: Output only. Status of the latest task executions. readOnly: true - $ref: '#/components/schemas/GoogleCloudDataplexV1EnvironmentEndpoints' - GoogleCloudDataplexV1EnvironmentInfrastructureSpec: - id: GoogleCloudDataplexV1EnvironmentInfrastructureSpec - description: Configuration for the underlying infrastructure used to run workloads. + $ref: '#/components/schemas/GoogleCloudDataplexV1TaskExecutionStatus' + spark: + description: Config related to running custom Spark tasks. + $ref: '#/components/schemas/GoogleCloudDataplexV1TaskSparkTaskConfig' + notebook: + description: Config related to running scheduled Notebooks. + $ref: '#/components/schemas/GoogleCloudDataplexV1TaskNotebookTaskConfig' + GoogleCloudDataplexV1TaskTriggerSpec: + id: GoogleCloudDataplexV1TaskTriggerSpec + description: Task scheduling and trigger settings. type: object properties: - compute: + type: + description: Required. Immutable. Trigger type of the user-specified Task. + type: string + enumDescriptions: + - Unspecified trigger type. + - The task runs one-time shortly after Task Creation. + - The task is scheduled to run periodically. + enum: + - TYPE_UNSPECIFIED + - ON_DEMAND + - RECURRING + startTime: description: >- - Optional. Compute resources needed for analyze interactive - workloads. - $ref: >- - #/components/schemas/GoogleCloudDataplexV1EnvironmentInfrastructureSpecComputeResources - osImage: + Optional. The first run of the task will be after this time. If not + specified, the task will run shortly after being submitted if + ON_DEMAND and based on the schedule if RECURRING. + type: string + format: google-datetime + disabled: description: >- - Required. Software Runtime Configuration for analyze interactive - workloads. - $ref: >- - #/components/schemas/GoogleCloudDataplexV1EnvironmentInfrastructureSpecOsImageRuntime - GoogleCloudDataplexV1EnvironmentInfrastructureSpecComputeResources: - id: GoogleCloudDataplexV1EnvironmentInfrastructureSpecComputeResources - description: Compute resources associated with the analyze interactive workloads. - type: object - properties: - diskSizeGb: - description: Optional. Size in GB of the disk. Default is 100 GB. - type: integer - format: int32 - nodeCount: + Optional. Prevent the task from executing. This does not cancel + already running tasks. It is intended to temporarily disable + RECURRING tasks. + type: boolean + maxRetries: description: >- - Optional. Total number of nodes in the sessions created for this - environment. + Optional. Number of retry attempts before aborting. Set to zero to + never attempt to retry a failed task. type: integer format: int32 - maxNodeCount: + schedule: description: >- - Optional. Max configurable nodes. If max_node_count > node_count, - then auto-scaling is enabled. - type: integer - format: int32 - GoogleCloudDataplexV1EnvironmentInfrastructureSpecOsImageRuntime: - id: GoogleCloudDataplexV1EnvironmentInfrastructureSpecOsImageRuntime - description: Software Runtime Configuration to run Analyze. + Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for + running tasks periodically. To explicitly set a timezone to the cron + tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or + "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid + string from IANA time zone database. For example, + CRON_TZ=America/New_York 1 * * * *, or TZ=America/New_York 1 * * * + *. This field is required for RECURRING tasks. + type: string + GoogleCloudDataplexV1TaskExecutionSpec: + id: GoogleCloudDataplexV1TaskExecutionSpec + description: Execution related settings, like retry and service_account. type: object properties: - imageVersion: - description: Required. Dataplex Image version. - type: string - javaLibraries: - description: >- - Optional. List of Java jars to be included in the runtime - environment. Valid input includes Cloud Storage URIs to Jar - binaries. For example, gs://bucket-name/my/path/to/file.jar - type: array - items: - type: string - pythonPackages: - description: >- - Optional. A list of python packages to be installed. Valid formats - include Cloud Storage URI to a PIP installable library. For example, - gs://bucket-name/my/path/to/lib.tar.gz - type: array - items: - type: string - properties: + args: description: >- - Optional. Spark properties to provide configuration for use in - sessions created for this environment. The properties to set on - daemon config files. Property keys are specified in prefix:property - format. The prefix must be "spark". + Optional. The arguments to pass to the task. The args can use + placeholders of the format ${placeholder} as part of key/value + string. These will be interpolated before passing the args to the + driver. Currently supported placeholders: - ${task_id} - ${job_time} + To pass positional args, set the key as TASK_ARGS. The value should + be a comma-separated string of all the positional arguments. To use + a delimiter other than comma, refer to + https://cloud.google.com/sdk/gcloud/reference/topic/escaping. In + case of other keys being present in the args, then TASK_ARGS will be + passed as the last argument. type: object additionalProperties: type: string - GoogleCloudDataplexV1EnvironmentSessionSpec: - id: GoogleCloudDataplexV1EnvironmentSessionSpec - description: Configuration for sessions created for this environment. - type: object - properties: - maxIdleDuration: + serviceAccount: description: >- - Optional. The idle time configuration of the session. The session - will be auto-terminated at the end of this period. + Required. Service account to use to execute a task. If not provided, + the default Compute service account for the project is used. type: string - format: google-duration - enableFastStartup: - description: >- - Optional. If True, this causes sessions to be pre-created and - available for faster startup to enable interactive exploration - use-cases. This defaults to False to avoid additional billed - charges. These can only be set to True for the environment with name - set to "default", and with default configuration. - type: boolean - GoogleCloudDataplexV1EnvironmentSessionStatus: - id: GoogleCloudDataplexV1EnvironmentSessionStatus - description: Status of sessions created for this environment. - type: object - properties: - active: + project: description: >- - Output only. Queries over sessions to mark whether the environment - is currently active or not - readOnly: true - type: boolean - GoogleCloudDataplexV1EnvironmentEndpoints: - id: GoogleCloudDataplexV1EnvironmentEndpoints - description: URI Endpoints to access sessions associated with the Environment. - type: object - properties: - notebooks: - description: Output only. URI to serve notebook APIs - readOnly: true + Optional. The project in which jobs are run. By default, the project + containing the Lake is used. If a project is provided, the + ExecutionSpec.service_account must belong to this project. type: string - sql: - description: Output only. URI to serve SQL APIs - readOnly: true + maxJobExecutionLifetime: + description: >- + Optional. The maximum duration after which the job execution is + expired. type: string - GoogleCloudDataplexV1ListEnvironmentsResponse: - id: GoogleCloudDataplexV1ListEnvironmentsResponse - description: List environments response. - type: object - properties: - environments: - description: Environments under the given parent lake. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDataplexV1Environment' - nextPageToken: + format: google-duration + kmsKey: description: >- - Token to retrieve the next page of results, or empty if there are no - more results in the list. + Optional. The Cloud KMS key to use for encryption, of the form: + projects/{project_number}/locations/{location_id}/keyRings/{key-ring-name}/cryptoKeys/{key-name}. type: string - GoogleCloudDataplexV1ListSessionsResponse: - id: GoogleCloudDataplexV1ListSessionsResponse - description: List sessions response. + GoogleCloudDataplexV1TaskExecutionStatus: + id: GoogleCloudDataplexV1TaskExecutionStatus + description: Status of the task execution (e.g. Jobs). type: object properties: - sessions: - description: Sessions under a given environment. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDataplexV1Session' - nextPageToken: - description: >- - Token to retrieve the next page of results, or empty if there are no - more results in the list. + updateTime: + description: Output only. Last update time of the status. + readOnly: true type: string - GoogleCloudDataplexV1Session: - id: GoogleCloudDataplexV1Session - description: Represents an active analyze session running for a user. + format: google-datetime + latestJob: + description: Output only. latest job execution + readOnly: true + $ref: '#/components/schemas/GoogleCloudDataplexV1Job' + GoogleCloudDataplexV1Job: + id: GoogleCloudDataplexV1Job + description: A job represents an instance of a task. type: object properties: name: description: >- - Output only. The relative resource name of the content, of the form: - projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}/sessions/{session_id} + Output only. The relative resource name of the job, of the form: + projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}/jobs/{job_id}. readOnly: true type: string - userId: - description: Output only. Email of user running the session. + uid: + description: Output only. System generated globally unique ID for the job. readOnly: true type: string - createTime: - description: Output only. Session start time. + startTime: + description: Output only. The time when the job was started. + readOnly: true + type: string + format: google-datetime + endTime: + description: Output only. The time when the job ended. readOnly: true type: string format: google-datetime state: - description: Output only. State of Session + description: Output only. Execution state for the job. readOnly: true type: string enumDescriptions: - - State is not specified. - - Resource is active, i.e., ready to use. - - Resource is under creation. - - Resource is under deletion. - - Resource is active but has unresolved actions. - enum: - - STATE_UNSPECIFIED - - ACTIVE - - CREATING - - DELETING - - ACTION_REQUIRED - GoogleCloudLocationListLocationsResponse: - id: GoogleCloudLocationListLocationsResponse - description: The response message for Locations.ListLocations. - type: object - properties: - locations: + - The job state is unknown. + - The job is running. + - The job is cancelling. + - The job cancellation was successful. + - The job completed successfully. + - The job is no longer running due to an error. + - The job was cancelled outside of Dataplex Universal Catalog. + enum: + - STATE_UNSPECIFIED + - RUNNING + - CANCELLING + - CANCELLED + - SUCCEEDED + - FAILED + - ABORTED + retryCount: description: >- - A list of locations that matches the specified filter in the - request. - type: array - items: - $ref: '#/components/schemas/GoogleCloudLocationLocation' - nextPageToken: - description: The standard List next-page token. + Output only. The number of times the job has been retried (excluding + the initial attempt). + readOnly: true + type: integer + format: uint32 + service: + description: Output only. The underlying service running a job. + readOnly: true type: string - GoogleCloudLocationLocation: - id: GoogleCloudLocationLocation - description: A resource that represents a Google Cloud location. - type: object - properties: - name: + enumDescriptions: + - Service used to run the job is unspecified. + - Dataproc service is used to run this job. + enum: + - SERVICE_UNSPECIFIED + - DATAPROC + serviceJob: description: >- - Resource name for the location, which may vary between - implementations. For example: - "projects/example-project/locations/us-east1" - type: string - locationId: - description: 'The canonical id for this location. For example: "us-east1".' + Output only. The full resource name for the job run under a + particular service. + readOnly: true type: string - displayName: - description: >- - The friendly name for this location, typically a nearby city name. - For example, "Tokyo". + message: + description: Output only. Additional information about the current state. + readOnly: true type: string labels: - description: >- - Cross-service attributes for the location. For example - {"cloud.googleapis.com/region": "us-east1"} + description: Output only. User-defined labels for the task. + readOnly: true type: object additionalProperties: type: string - metadata: - description: >- - Service-specific metadata. For example the available capacity at the - given location. - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - GoogleCloudDataplexV1OperationMetadata: - id: GoogleCloudDataplexV1OperationMetadata - description: Represents the metadata of a long-running operation. - type: object - properties: - createTime: - description: Output only. The time the operation was created. + trigger: + description: Output only. Job execution trigger. readOnly: true type: string - format: google-datetime - endTime: - description: Output only. The time the operation finished running. + enumDescriptions: + - The trigger is unspecified. + - >- + The job was triggered by Dataplex Universal Catalog based on + trigger spec from task definition. + - The job was triggered by the explicit call of Task API. + enum: + - TRIGGER_UNSPECIFIED + - TASK_CONFIG + - RUN_REQUEST + executionSpec: + description: Output only. Spec related to how a task is executed. readOnly: true + $ref: '#/components/schemas/GoogleCloudDataplexV1TaskExecutionSpec' + GoogleCloudDataplexV1TaskSparkTaskConfig: + id: GoogleCloudDataplexV1TaskSparkTaskConfig + description: User-specified config for running a Spark task. + type: object + properties: + mainJarFileUri: + description: >- + The Cloud Storage URI of the jar file that contains the main class. + The execution args are passed in as a sequence of named process + arguments (--key=value). type: string - format: google-datetime - target: + mainClass: description: >- - Output only. Server-defined resource path for the target of the - operation. - readOnly: true + The name of the driver's main class. The jar file that contains the + class must be in the default CLASSPATH or specified in + jar_file_uris. The execution args are passed in as a sequence of + named process arguments (--key=value). type: string - verb: - description: Output only. Name of the verb executed by the operation. - readOnly: true + pythonScriptFile: + description: >- + The Gcloud Storage URI of the main Python file to use as the driver. + Must be a .py file. The execution args are passed in as a sequence + of named process arguments (--key=value). type: string - statusMessage: - description: Output only. Human-readable status of the operation, if any. - readOnly: true + sqlScriptFile: + description: >- + A reference to a query file. This should be the Cloud Storage URI of + the query file. The execution args are used to declare a set of + script variables (set key="value";). type: string - requestedCancellation: + sqlScript: description: >- - Output only. Identifies whether the user has requested cancellation - of the operation. Operations that have successfully been cancelled - have Operation.error value with a google.rpc.Status.code of 1, - corresponding to Code.CANCELLED. - readOnly: true - type: boolean - apiVersion: - description: Output only. API version used to start the operation. - readOnly: true + The query text. The execution args are used to declare a set of + script variables (set key="value";). type: string - GoogleCloudDataplexV1DiscoveryEvent: - id: GoogleCloudDataplexV1DiscoveryEvent - description: The payload associated with Discovery data processing. + fileUris: + description: >- + Optional. Cloud Storage URIs of files to be placed in the working + directory of each executor. + type: array + items: + type: string + archiveUris: + description: >- + Optional. Cloud Storage URIs of archives to be extracted into the + working directory of each executor. Supported file types: .jar, + .tar, .tar.gz, .tgz, and .zip. + type: array + items: + type: string + infrastructureSpec: + description: Optional. Infrastructure specification for the execution. + $ref: '#/components/schemas/GoogleCloudDataplexV1TaskInfrastructureSpec' + GoogleCloudDataplexV1TaskInfrastructureSpec: + id: GoogleCloudDataplexV1TaskInfrastructureSpec + description: Configuration for the underlying infrastructure used to run workloads. type: object properties: - message: - description: The log message. - type: string - lakeId: - description: The id of the associated lake. - type: string - zoneId: - description: The id of the associated zone. - type: string - assetId: - description: The id of the associated asset. - type: string - dataLocation: - description: The data location associated with the event. - type: string - datascanId: - description: The id of the associated datascan for standalone discovery. - type: string - type: - description: The type of the event being logged. - type: string - enumDescriptions: - - An unspecified event type. - - An event representing discovery configuration in effect. - - An event representing a metadata entity being created. - - An event representing a metadata entity being updated. - - An event representing a metadata entity being deleted. - - An event representing a partition being created. - - An event representing a partition being updated. - - An event representing a partition being deleted. - - An event representing a table being published. - - An event representing a table being updated. - - An event representing a table being skipped in publishing. - - An event representing a table being deleted. - enum: - - EVENT_TYPE_UNSPECIFIED - - CONFIG - - ENTITY_CREATED - - ENTITY_UPDATED - - ENTITY_DELETED - - PARTITION_CREATED - - PARTITION_UPDATED - - PARTITION_DELETED - - TABLE_PUBLISHED - - TABLE_UPDATED - - TABLE_IGNORED - - TABLE_DELETED - config: - description: Details about discovery configuration in effect. - $ref: >- - #/components/schemas/GoogleCloudDataplexV1DiscoveryEventConfigDetails - entity: - description: Details about the entity associated with the event. + batch: + description: Compute resources needed for a Task when using Dataproc Serverless. $ref: >- - #/components/schemas/GoogleCloudDataplexV1DiscoveryEventEntityDetails - partition: - description: Details about the partition associated with the event. + #/components/schemas/GoogleCloudDataplexV1TaskInfrastructureSpecBatchComputeResources + containerImage: + description: Container Image Runtime Configuration. $ref: >- - #/components/schemas/GoogleCloudDataplexV1DiscoveryEventPartitionDetails - action: - description: Details about the action associated with the event. + #/components/schemas/GoogleCloudDataplexV1TaskInfrastructureSpecContainerImageRuntime + vpcNetwork: + description: Vpc network. $ref: >- - #/components/schemas/GoogleCloudDataplexV1DiscoveryEventActionDetails - table: - description: >- - Details about the BigQuery table publishing associated with the - event. - $ref: '#/components/schemas/GoogleCloudDataplexV1DiscoveryEventTableDetails' - GoogleCloudDataplexV1DiscoveryEventConfigDetails: - id: GoogleCloudDataplexV1DiscoveryEventConfigDetails - description: Details about configuration events. + #/components/schemas/GoogleCloudDataplexV1TaskInfrastructureSpecVpcNetwork + GoogleCloudDataplexV1TaskInfrastructureSpecBatchComputeResources: + id: GoogleCloudDataplexV1TaskInfrastructureSpecBatchComputeResources + description: Batch compute resources associated with the task. type: object properties: - parameters: + executorsCount: description: >- - A list of discovery configuration parameters in effect. The keys are - the field paths within DiscoverySpec. Eg. includePatterns, - excludePatterns, csvOptions.disableTypeInference, etc. + Optional. Total number of job executors. Executor Count should be + between 2 and 100. Default=2 + type: integer + format: int32 + maxExecutorsCount: + description: >- + Optional. Max configurable executors. If max_executors_count > + executors_count, then auto-scaling is enabled. Max Executor Count + should be between 2 and 1000. Default=1000 + type: integer + format: int32 + GoogleCloudDataplexV1TaskInfrastructureSpecContainerImageRuntime: + id: GoogleCloudDataplexV1TaskInfrastructureSpecContainerImageRuntime + description: Container Image Runtime Configuration used with Batch execution. + type: object + properties: + image: + description: Optional. Container image to use. + type: string + javaJars: + description: >- + Optional. A list of Java JARS to add to the classpath. Valid input + includes Cloud Storage URIs to Jar binaries. For example, + gs://bucket-name/my/path/to/file.jar + type: array + items: + type: string + pythonPackages: + description: >- + Optional. A list of python packages to be installed. Valid formats + include Cloud Storage URI to a PIP installable library. For example, + gs://bucket-name/my/path/to/lib.tar.gz + type: array + items: + type: string + properties: + description: >- + Optional. Override to common configuration of open source components + installed on the Dataproc cluster. The properties to set on daemon + config files. Property keys are specified in prefix:property format, + for example core:hadoop.tmp.dir. For more information, see Cluster + properties + (https://cloud.google.com/dataproc/docs/concepts/cluster-properties). type: object additionalProperties: type: string - GoogleCloudDataplexV1DiscoveryEventEntityDetails: - id: GoogleCloudDataplexV1DiscoveryEventEntityDetails - description: Details about the entity. + GoogleCloudDataplexV1TaskInfrastructureSpecVpcNetwork: + id: GoogleCloudDataplexV1TaskInfrastructureSpecVpcNetwork + description: Cloud VPC Network used to run the infrastructure. type: object properties: - entity: + network: description: >- - The name of the entity resource. The name is the fully-qualified - resource name. + Optional. The Cloud VPC network in which the job is run. By default, + the Cloud VPC network named Default within the project is used. type: string - type: - description: The type of the entity resource. + subNetwork: + description: Optional. The Cloud VPC sub-network in which the job is run. type: string - enumDescriptions: - - An unspecified event type. - - Entities representing structured data. - - Entities representing unstructured data. - enum: - - ENTITY_TYPE_UNSPECIFIED - - TABLE - - FILESET - GoogleCloudDataplexV1DiscoveryEventPartitionDetails: - id: GoogleCloudDataplexV1DiscoveryEventPartitionDetails - description: Details about the partition. + networkTags: + description: Optional. List of network tags to apply to the job. + type: array + items: + type: string + GoogleCloudDataplexV1TaskNotebookTaskConfig: + id: GoogleCloudDataplexV1TaskNotebookTaskConfig + description: Config for running scheduled notebooks. type: object properties: - partition: + notebook: description: >- - The name to the partition resource. The name is the fully-qualified - resource name. + Required. Path to input notebook. This can be the Cloud Storage URI + of the notebook file or the path to a Notebook Content. The + execution args are accessible as environment variables + (TASK_key=value). type: string - entity: + infrastructureSpec: + description: Optional. Infrastructure specification for the execution. + $ref: '#/components/schemas/GoogleCloudDataplexV1TaskInfrastructureSpec' + fileUris: description: >- - The name to the containing entity resource. The name is the - fully-qualified resource name. - type: string - type: - description: The type of the containing entity resource. - type: string - enumDescriptions: - - An unspecified event type. - - Entities representing structured data. - - Entities representing unstructured data. - enum: - - ENTITY_TYPE_UNSPECIFIED - - TABLE - - FILESET - sampledDataLocations: + Optional. Cloud Storage URIs of files to be placed in the working + directory of each executor. + type: array + items: + type: string + archiveUris: description: >- - The locations of the data items (e.g., a Cloud Storage objects) - sampled for metadata inference. + Optional. Cloud Storage URIs of archives to be extracted into the + working directory of each executor. Supported file types: .jar, + .tar, .tar.gz, .tgz, and .zip. type: array items: type: string - GoogleCloudDataplexV1DiscoveryEventActionDetails: - id: GoogleCloudDataplexV1DiscoveryEventActionDetails - description: Details about the action. + GoogleCloudDataplexV1ListTasksResponse: + id: GoogleCloudDataplexV1ListTasksResponse + description: List tasks response. type: object properties: - type: - description: The type of action. Eg. IncompatibleDataSchema, InvalidDataFormat - type: string - issue: - description: The human readable issue associated with the action. + tasks: + description: Tasks under the given parent lake. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDataplexV1Task' + nextPageToken: + description: >- + Token to retrieve the next page of results, or empty if there are no + more results in the list. type: string - GoogleCloudDataplexV1DiscoveryEventTableDetails: - id: GoogleCloudDataplexV1DiscoveryEventTableDetails - description: Details about the published table. + unreachableLocations: + description: Locations that could not be reached. + type: array + items: + type: string + GoogleCloudDataplexV1ListJobsResponse: + id: GoogleCloudDataplexV1ListJobsResponse + description: List jobs response. type: object properties: - table: - description: The fully-qualified resource name of the table resource. - type: string - type: - description: The type of the table resource. + jobs: + description: Jobs under a given task. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDataplexV1Job' + nextPageToken: + description: >- + Token to retrieve the next page of results, or empty if there are no + more results in the list. type: string - enumDescriptions: - - An unspecified table type. - - External table type. - - BigLake table type. - - Object table type for unstructured data. - enum: - - TABLE_TYPE_UNSPECIFIED - - EXTERNAL_TABLE - - BIGLAKE_TABLE - - OBJECT_TABLE - GoogleCloudDataplexV1JobEvent: - id: GoogleCloudDataplexV1JobEvent + GoogleCloudDataplexV1RunTaskRequest: + id: GoogleCloudDataplexV1RunTaskRequest + type: object + properties: + labels: + description: >- + Optional. User-defined labels for the task. If the map is left + empty, the task will run with existing labels from task definition. + If the map contains an entry with a new key, the same will be added + to existing set of labels. If the map contains an entry with an + existing label key in task definition, the task will run with new + label value for that entry. Clearing an existing label will require + label value to be explicitly set to a hyphen "-". The label value + cannot be empty. + type: object + additionalProperties: + type: string + args: + description: >- + Optional. Execution spec arguments. If the map is left empty, the + task will run with existing execution spec args from task + definition. If the map contains an entry with a new key, the same + will be added to existing set of args. If the map contains an entry + with an existing arg key in task definition, the task will run with + new arg value for that entry. Clearing an existing arg will require + arg value to be explicitly set to a hyphen "-". The arg value cannot + be empty. + type: object + additionalProperties: + type: string + GoogleCloudDataplexV1RunTaskResponse: + id: GoogleCloudDataplexV1RunTaskResponse + type: object + properties: + job: + description: Jobs created by RunTask API. + $ref: '#/components/schemas/GoogleCloudDataplexV1Job' + GoogleCloudDataplexV1CancelJobRequest: + id: GoogleCloudDataplexV1CancelJobRequest + description: Cancel task jobs. + type: object + properties: {} + GoogleCloudDataplexV1Environment: + id: GoogleCloudDataplexV1Environment description: >- - The payload associated with Job logs that contains events describing - jobs that have run within a Lake. + Environment represents a user-visible compute infrastructure for + analytics within a lake. type: object properties: - message: - description: The log message. + name: + description: >- + Output only. The relative resource name of the environment, of the + form: + projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id} + readOnly: true type: string - jobId: - description: The unique id identifying the job. + displayName: + description: Optional. User friendly display name. type: string - startTime: - description: The time when the job started running. + uid: + description: >- + Output only. System generated globally unique ID for the + environment. This ID will be different if the environment is deleted + and re-created with the same name. + readOnly: true + type: string + createTime: + description: Output only. Environment creation time. + readOnly: true type: string format: google-datetime - endTime: - description: The time when the job ended running. + updateTime: + description: Output only. The time when the environment was last updated. + readOnly: true type: string format: google-datetime - state: - description: The job state on completion. + labels: + description: Optional. User defined labels for the environment. + type: object + additionalProperties: + type: string + description: + description: Optional. Description of the environment. + type: string + state: + description: Output only. Current state of the environment. + readOnly: true type: string enumDescriptions: - - Unspecified job state. - - Job successfully completed. - - Job was unsuccessful. - - Job was cancelled by the user. - - Job was cancelled or aborted via the service executing the job. + - State is not specified. + - Resource is active, i.e., ready to use. + - Resource is under creation. + - Resource is under deletion. + - Resource is active but has unresolved actions. enum: - STATE_UNSPECIFIED - - SUCCEEDED - - FAILED - - CANCELLED - - ABORTED - retries: - description: The number of retries. + - ACTIVE + - CREATING + - DELETING + - ACTION_REQUIRED + infrastructureSpec: + description: Required. Infrastructure specification for the Environment. + $ref: >- + #/components/schemas/GoogleCloudDataplexV1EnvironmentInfrastructureSpec + sessionSpec: + description: Optional. Configuration for sessions created for this environment. + $ref: '#/components/schemas/GoogleCloudDataplexV1EnvironmentSessionSpec' + sessionStatus: + description: Output only. Status of sessions created for this environment. + readOnly: true + $ref: '#/components/schemas/GoogleCloudDataplexV1EnvironmentSessionStatus' + endpoints: + description: >- + Output only. URI Endpoints to access sessions associated with the + Environment. + readOnly: true + $ref: '#/components/schemas/GoogleCloudDataplexV1EnvironmentEndpoints' + GoogleCloudDataplexV1EnvironmentInfrastructureSpec: + id: GoogleCloudDataplexV1EnvironmentInfrastructureSpec + description: Configuration for the underlying infrastructure used to run workloads. + type: object + properties: + compute: + description: >- + Optional. Compute resources needed for analyze interactive + workloads. + $ref: >- + #/components/schemas/GoogleCloudDataplexV1EnvironmentInfrastructureSpecComputeResources + osImage: + description: >- + Required. Software Runtime Configuration for analyze interactive + workloads. + $ref: >- + #/components/schemas/GoogleCloudDataplexV1EnvironmentInfrastructureSpecOsImageRuntime + GoogleCloudDataplexV1EnvironmentInfrastructureSpecComputeResources: + id: GoogleCloudDataplexV1EnvironmentInfrastructureSpecComputeResources + description: Compute resources associated with the analyze interactive workloads. + type: object + properties: + diskSizeGb: + description: Optional. Size in GB of the disk. Default is 100 GB. type: integer format: int32 - type: - description: The type of the job. - type: string - enumDescriptions: - - Unspecified job type. - - Spark jobs. - - Notebook jobs. - enum: - - TYPE_UNSPECIFIED - - SPARK - - NOTEBOOK - service: - description: The service used to execute the job. - type: string - enumDescriptions: - - Unspecified service. - - Cloud Dataproc. - enum: - - SERVICE_UNSPECIFIED - - DATAPROC - serviceJob: - description: The reference to the job within the service. - type: string - executionTrigger: - description: Job execution trigger. - type: string - enumDescriptions: - - The job execution trigger is unspecified. - - >- - The job was triggered by Dataplex based on trigger spec from task - definition. - - The job was triggered by the explicit call of Task API. - enum: - - EXECUTION_TRIGGER_UNSPECIFIED - - TASK_CONFIG - - RUN_REQUEST - GoogleCloudDataplexV1SessionEvent: - id: GoogleCloudDataplexV1SessionEvent - description: >- - These messages contain information about sessions within an environment. - The monitored resource is 'Environment'. + nodeCount: + description: >- + Optional. Total number of nodes in the sessions created for this + environment. + type: integer + format: int32 + maxNodeCount: + description: >- + Optional. Max configurable nodes. If max_node_count > node_count, + then auto-scaling is enabled. + type: integer + format: int32 + GoogleCloudDataplexV1EnvironmentInfrastructureSpecOsImageRuntime: + id: GoogleCloudDataplexV1EnvironmentInfrastructureSpecOsImageRuntime + description: Software Runtime Configuration to run Analyze. type: object properties: - message: - description: The log message. + imageVersion: + description: Required. Dataplex Universal Catalog Image version. type: string - userId: + javaLibraries: description: >- - The information about the user that created the session. It will be - the email address of the user. - type: string - sessionId: - description: Unique identifier for the session. - type: string - type: - description: The type of the event. - type: string - enumDescriptions: - - An unspecified event type. - - Event when the session is assigned to a user. - - Event for stop of a session. - - Query events in the session. - - >- - Event for creation of a cluster. It is not yet assigned to a user. - This comes before START in the sequence - enum: - - EVENT_TYPE_UNSPECIFIED - - START - - STOP - - QUERY - - CREATE - query: - description: The execution details of the query. - $ref: '#/components/schemas/GoogleCloudDataplexV1SessionEventQueryDetail' - eventSucceeded: - description: The status of the event. - type: boolean - fastStartupEnabled: + Optional. List of Java jars to be included in the runtime + environment. Valid input includes Cloud Storage URIs to Jar + binaries. For example, gs://bucket-name/my/path/to/file.jar + type: array + items: + type: string + pythonPackages: description: >- - If the session is associated with an environment with fast startup - enabled, and was created before being assigned to a user. - type: boolean - unassignedDuration: + Optional. A list of python packages to be installed. Valid formats + include Cloud Storage URI to a PIP installable library. For example, + gs://bucket-name/my/path/to/lib.tar.gz + type: array + items: + type: string + properties: description: >- - The idle duration of a warm pooled session before it is assigned to - user. - type: string - format: google-duration - GoogleCloudDataplexV1SessionEventQueryDetail: - id: GoogleCloudDataplexV1SessionEventQueryDetail - description: Execution details of the query. + Optional. Spark properties to provide configuration for use in + sessions created for this environment. The properties to set on + daemon config files. Property keys are specified in prefix:property + format. The prefix must be "spark". + type: object + additionalProperties: + type: string + GoogleCloudDataplexV1EnvironmentSessionSpec: + id: GoogleCloudDataplexV1EnvironmentSessionSpec + description: Configuration for sessions created for this environment. type: object properties: - queryId: - description: The unique Query id identifying the query. - type: string - queryText: - description: The query text executed. - type: string - engine: - description: Query Execution engine. - type: string - enumDescriptions: - - An unspecified Engine type. - - Spark-sql engine is specified in Query. - - BigQuery engine is specified in Query. - enum: - - ENGINE_UNSPECIFIED - - SPARK_SQL - - BIGQUERY - duration: - description: Time taken for execution of the query. + maxIdleDuration: + description: >- + Optional. The idle time configuration of the session. The session + will be auto-terminated at the end of this period. type: string format: google-duration - resultSizeBytes: - description: The size of results the query produced. - type: string - format: int64 - dataProcessedBytes: - description: The data processed by the query. - type: string - format: int64 - GoogleCloudDataplexV1ImportItem: - id: GoogleCloudDataplexV1ImportItem - description: >- - An object that describes the values that you want to set for an entry - and its attached aspects when you import metadata. Used when you run a - metadata import job. See CreateMetadataJob.You provide a collection of - import items in a metadata import file. For more information about how - to create a metadata import file, see Metadata import file - (https://cloud.google.com/dataplex/docs/import-metadata#metadata-import-file). + enableFastStartup: + description: >- + Optional. If True, this causes sessions to be pre-created and + available for faster startup to enable interactive exploration + use-cases. This defaults to False to avoid additional billed + charges. These can only be set to True for the environment with name + set to "default", and with default configuration. + type: boolean + GoogleCloudDataplexV1EnvironmentSessionStatus: + id: GoogleCloudDataplexV1EnvironmentSessionStatus + description: Status of sessions created for this environment. type: object properties: - entry: - description: Information about an entry and its attached aspects. - $ref: '#/components/schemas/GoogleCloudDataplexV1Entry' - updateMask: + active: description: >- - The fields to update, in paths that are relative to the Entry - resource. Separate each field with a comma.In FULL entry sync mode, - Dataplex includes the paths of all of the fields for an entry that - can be modified, including aspects. This means that Dataplex - replaces the existing entry with the entry in the metadata import - file. All modifiable fields are updated, regardless of the fields - that are listed in the update mask, and regardless of whether a - field is present in the entry object.The update_mask field is - ignored when an entry is created or re-created.Dataplex also - determines which entries and aspects to modify by comparing the - values and timestamps that you provide in the metadata import file - with the values and timestamps that exist in your project. For more - information, see Comparison logic - (https://cloud.google.com/dataplex/docs/import-metadata#data-modification-logic). + Output only. Queries over sessions to mark whether the environment + is currently active or not + readOnly: true + type: boolean + GoogleCloudDataplexV1EnvironmentEndpoints: + id: GoogleCloudDataplexV1EnvironmentEndpoints + description: URI Endpoints to access sessions associated with the Environment. + type: object + properties: + notebooks: + description: Output only. URI to serve notebook APIs + readOnly: true type: string - format: google-fieldmask - aspectKeys: + sql: + description: Output only. URI to serve SQL APIs + readOnly: true + type: string + GoogleCloudDataplexV1ListEnvironmentsResponse: + id: GoogleCloudDataplexV1ListEnvironmentsResponse + description: List environments response. + type: object + properties: + environments: + description: Environments under the given parent lake. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDataplexV1Environment' + nextPageToken: description: >- - The aspects to modify. Supports the following syntaxes: - {aspect_type_reference}: matches aspects that belong to the - specified aspect type and are attached directly to the entry. - {aspect_type_reference}@{path}: matches aspects that belong to the - specified aspect type and path. {aspect_type_reference}@*: matches - aspects that belong to the specified aspect type for all - paths.Replace {aspect_type_reference} with a reference to the aspect - type, in the format - {project_id_or_number}.{location_id}.{aspect_type_id}.If you leave - this field empty, it is treated as specifying exactly those aspects - that are present within the specified entry.In FULL entry sync mode, - Dataplex implicitly adds the keys for all of the required aspects of - an entry. + Token to retrieve the next page of results, or empty if there are no + more results in the list. + type: string + GoogleCloudDataplexV1ListSessionsResponse: + id: GoogleCloudDataplexV1ListSessionsResponse + description: List sessions response. + type: object + properties: + sessions: + description: Sessions under a given environment. type: array items: - type: string - GoogleCloudDataplexV1DataScanEvent: - id: GoogleCloudDataplexV1DataScanEvent - description: >- - These messages contain information about the execution of a datascan. - The monitored resource is 'DataScan' + $ref: '#/components/schemas/GoogleCloudDataplexV1Session' + nextPageToken: + description: >- + Token to retrieve the next page of results, or empty if there are no + more results in the list. + type: string + GoogleCloudDataplexV1Session: + id: GoogleCloudDataplexV1Session + description: Represents an active analyze session running for a user. type: object properties: - dataSource: - description: The data source of the data scan + name: + description: >- + Output only. The relative resource name of the content, of the form: + projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}/sessions/{session_id} + readOnly: true type: string - jobId: - description: The identifier of the specific data scan job this log entry is for. + userId: + description: Output only. Email of user running the session. + readOnly: true type: string createTime: - description: The time when the data scan job was created. - type: string - format: google-datetime - startTime: - description: The time when the data scan job started to run. - type: string - format: google-datetime - endTime: - description: The time when the data scan job finished. + description: Output only. Session start time. + readOnly: true type: string format: google-datetime - type: - description: The type of the data scan. - type: string - enumDescriptions: - - An unspecified data scan type. - - Data scan for data profile. - - Data scan for data quality. - - Data scan for data discovery. - enum: - - SCAN_TYPE_UNSPECIFIED - - DATA_PROFILE - - DATA_QUALITY - - DATA_DISCOVERY state: - description: The status of the data scan job. + description: Output only. State of Session + readOnly: true type: string enumDescriptions: - - Unspecified job state. - - Data scan job started. - - Data scan job successfully completed. - - Data scan job was unsuccessful. - - Data scan job was cancelled. - - Data scan job was createed. + - State is not specified. + - Resource is active, i.e., ready to use. + - Resource is under creation. + - Resource is under deletion. + - Resource is active but has unresolved actions. enum: - STATE_UNSPECIFIED - - STARTED - - SUCCEEDED - - FAILED - - CANCELLED - - CREATED - message: - description: The message describing the data scan job event. - type: string - specVersion: - description: A version identifier of the spec which was used to execute this job. - type: string - trigger: - description: The trigger type of the data scan job. - type: string - enumDescriptions: - - An unspecified trigger type. - - Data scan triggers on demand. - - Data scan triggers as per schedule. - enum: - - TRIGGER_UNSPECIFIED - - ON_DEMAND - - SCHEDULE - scope: - description: The scope of the data scan (e.g. full, incremental). - type: string - enumDescriptions: - - An unspecified scope type. - - Data scan runs on all of the data. - - Data scan runs on incremental data. - enum: - - SCOPE_UNSPECIFIED - - FULL - - INCREMENTAL - dataProfile: - description: Data profile result for data profile type data scan. - $ref: >- - #/components/schemas/GoogleCloudDataplexV1DataScanEventDataProfileResult - dataQuality: - description: Data quality result for data quality type data scan. - $ref: >- - #/components/schemas/GoogleCloudDataplexV1DataScanEventDataQualityResult - dataProfileConfigs: - description: Applied configs for data profile type data scan. - $ref: >- - #/components/schemas/GoogleCloudDataplexV1DataScanEventDataProfileAppliedConfigs - dataQualityConfigs: - description: Applied configs for data quality type data scan. - $ref: >- - #/components/schemas/GoogleCloudDataplexV1DataScanEventDataQualityAppliedConfigs - postScanActionsResult: - description: The result of post scan actions. - $ref: >- - #/components/schemas/GoogleCloudDataplexV1DataScanEventPostScanActionsResult - GoogleCloudDataplexV1DataScanEventDataProfileResult: - id: GoogleCloudDataplexV1DataScanEventDataProfileResult - description: Data profile result for data scan job. + - ACTIVE + - CREATING + - DELETING + - ACTION_REQUIRED + GoogleCloudLocationListLocationsResponse: + id: GoogleCloudLocationListLocationsResponse + description: The response message for Locations.ListLocations. type: object properties: - rowCount: - description: The count of rows processed in the data scan job. + locations: + description: >- + A list of locations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/GoogleCloudLocationLocation' + nextPageToken: + description: The standard List next-page token. type: string - format: int64 - GoogleCloudDataplexV1DataScanEventDataQualityResult: - id: GoogleCloudDataplexV1DataScanEventDataQualityResult - description: Data quality result for data scan job. + GoogleCloudLocationLocation: + id: GoogleCloudLocationLocation + description: A resource that represents a Google Cloud location. type: object properties: - rowCount: - description: The count of rows processed in the data scan job. - type: string - format: int64 - passed: - description: Whether the data quality result was pass or not. - type: boolean - dimensionPassed: + name: description: >- - The result of each dimension for data quality result. The key of the - map is the name of the dimension. The value is the bool value - depicting whether the dimension result was pass or not. - type: object - additionalProperties: - type: boolean - score: + Resource name for the location, which may vary between + implementations. For example: + "projects/example-project/locations/us-east1" + type: string + locationId: + description: 'The canonical id for this location. For example: "us-east1".' + type: string + displayName: description: >- - The table-level data quality score for the data scan job.The data - quality score ranges between 0, 100 (up to two decimal points). - type: number - format: float - dimensionScore: + The friendly name for this location, typically a nearby city name. + For example, "Tokyo". + type: string + labels: description: >- - The score of each dimension for data quality result. The key of the - map is the name of the dimension. The value is the data quality - score for the dimension.The score ranges between 0, 100 (up to two - decimal points). + Cross-service attributes for the location. For example + {"cloud.googleapis.com/region": "us-east1"} type: object additionalProperties: - type: number - format: float - columnScore: + type: string + metadata: description: >- - The score of each column scanned in the data scan job. The key of - the map is the name of the column. The value is the data quality - score for the column.The score ranges between 0, 100 (up to two - decimal points). + Service-specific metadata. For example the available capacity at the + given location. type: object additionalProperties: - type: number - format: float - GoogleCloudDataplexV1DataScanEventDataProfileAppliedConfigs: - id: GoogleCloudDataplexV1DataScanEventDataProfileAppliedConfigs - description: Applied configs for data profile type data scan job. + type: any + description: Properties of the object. Contains field @type with type URL. + GoogleCloudDataplexV1OperationMetadata: + id: GoogleCloudDataplexV1OperationMetadata + description: Represents the metadata of a long-running operation. type: object properties: - samplingPercent: - description: >- - The percentage of the records selected from the dataset for - DataScan. Value ranges between 0.0 and 100.0. Value 0.0 or 100.0 - imply that sampling was not applied. - type: number - format: float - rowFilterApplied: - description: >- - Boolean indicating whether a row filter was applied in the DataScan - job. - type: boolean - columnFilterApplied: - description: >- - Boolean indicating whether a column filter was applied in the - DataScan job. - type: boolean - GoogleCloudDataplexV1DataScanEventDataQualityAppliedConfigs: - id: GoogleCloudDataplexV1DataScanEventDataQualityAppliedConfigs - description: Applied configs for data quality type data scan job. - type: object - properties: - samplingPercent: + createTime: + description: Output only. The time the operation was created. + readOnly: true + type: string + format: google-datetime + endTime: + description: Output only. The time the operation finished running. + readOnly: true + type: string + format: google-datetime + target: description: >- - The percentage of the records selected from the dataset for - DataScan. Value ranges between 0.0 and 100.0. Value 0.0 or 100.0 - imply that sampling was not applied. - type: number - format: float - rowFilterApplied: + Output only. Server-defined resource path for the target of the + operation. + readOnly: true + type: string + verb: + description: Output only. Name of the verb executed by the operation. + readOnly: true + type: string + statusMessage: + description: Output only. Human-readable status of the operation, if any. + readOnly: true + type: string + requestedCancellation: description: >- - Boolean indicating whether a row filter was applied in the DataScan - job. + Output only. Identifies whether the user has requested cancellation + of the operation. Operations that have successfully been cancelled + have Operation.error value with a google.rpc.Status.code of 1, + corresponding to Code.CANCELLED. + readOnly: true type: boolean - GoogleCloudDataplexV1DataScanEventPostScanActionsResult: - id: GoogleCloudDataplexV1DataScanEventPostScanActionsResult - description: Post scan actions result for data scan job. - type: object - properties: - bigqueryExportResult: - description: The result of BigQuery export post scan action. - $ref: >- - #/components/schemas/GoogleCloudDataplexV1DataScanEventPostScanActionsResultBigQueryExportResult - GoogleCloudDataplexV1DataScanEventPostScanActionsResultBigQueryExportResult: - id: >- - GoogleCloudDataplexV1DataScanEventPostScanActionsResultBigQueryExportResult - description: The result of BigQuery export post scan action. + apiVersion: + description: Output only. API version used to start the operation. + readOnly: true + type: string + GoogleCloudDataplexV1DiscoveryEvent: + id: GoogleCloudDataplexV1DiscoveryEvent + description: The payload associated with Discovery data processing. type: object properties: - state: - description: Execution state for the BigQuery exporting. - type: string - enumDescriptions: - - The exporting state is unspecified. - - The exporting completed successfully. - - The exporting is no longer running due to an error. - - >- - The exporting is skipped due to no valid scan result to export - (usually caused by scan failed). - enum: - - STATE_UNSPECIFIED - - SUCCEEDED - - FAILED - - SKIPPED message: - description: Additional information about the BigQuery exporting. + description: The log message. type: string - GoogleCloudDataplexV1DataQualityScanRuleResult: - id: GoogleCloudDataplexV1DataQualityScanRuleResult - description: >- - Information about the result of a data quality rule for data quality - scan. The monitored resource is 'DataScan'. - type: object - properties: - jobId: - description: Identifier of the specific data scan job this log entry is for. + lakeId: + description: The id of the associated lake. type: string - dataSource: - description: The data source of the data scan (e.g. BigQuery table name). + zoneId: + description: The id of the associated zone. type: string - column: - description: The column which this rule is evaluated against. + assetId: + description: The id of the associated asset. type: string - ruleName: - description: The name of the data quality rule. + dataLocation: + description: The data location associated with the event. type: string - ruleType: - description: The type of the data quality rule. + datascanId: + description: The id of the associated datascan for standalone discovery. type: string - enumDescriptions: - - An unspecified rule type. - - See DataQualityRule.NonNullExpectation. - - See DataQualityRule.RangeExpectation. - - See DataQualityRule.RegexExpectation. - - See DataQualityRule.RowConditionExpectation. - - See DataQualityRule.SetExpectation. - - See DataQualityRule.StatisticRangeExpectation. - - See DataQualityRule.TableConditionExpectation. - - See DataQualityRule.UniquenessExpectation. - - See DataQualityRule.SqlAssertion. - enum: - - RULE_TYPE_UNSPECIFIED - - NON_NULL_EXPECTATION - - RANGE_EXPECTATION - - REGEX_EXPECTATION - - ROW_CONDITION_EXPECTATION - - SET_EXPECTATION - - STATISTIC_RANGE_EXPECTATION - - TABLE_CONDITION_EXPECTATION - - UNIQUENESS_EXPECTATION - - SQL_ASSERTION - evalutionType: - description: The evaluation type of the data quality rule. + type: + description: The type of the event being logged. type: string enumDescriptions: - - An unspecified evaluation type. - - The rule evaluation is done at per row level. - - The rule evaluation is done for an aggregate of rows. + - An unspecified event type. + - An event representing discovery configuration in effect. + - An event representing a metadata entity being created. + - An event representing a metadata entity being updated. + - An event representing a metadata entity being deleted. + - An event representing a partition being created. + - An event representing a partition being updated. + - An event representing a partition being deleted. + - An event representing a table being published. + - An event representing a table being updated. + - An event representing a table being skipped in publishing. + - An event representing a table being deleted. enum: - - EVALUATION_TYPE_UNSPECIFIED - - PER_ROW - - AGGREGATE - ruleDimension: - description: The dimension of the data quality rule. + - EVENT_TYPE_UNSPECIFIED + - CONFIG + - ENTITY_CREATED + - ENTITY_UPDATED + - ENTITY_DELETED + - PARTITION_CREATED + - PARTITION_UPDATED + - PARTITION_DELETED + - TABLE_PUBLISHED + - TABLE_UPDATED + - TABLE_IGNORED + - TABLE_DELETED + config: + description: Details about discovery configuration in effect. + $ref: >- + #/components/schemas/GoogleCloudDataplexV1DiscoveryEventConfigDetails + entity: + description: Details about the entity associated with the event. + $ref: >- + #/components/schemas/GoogleCloudDataplexV1DiscoveryEventEntityDetails + partition: + description: Details about the partition associated with the event. + $ref: >- + #/components/schemas/GoogleCloudDataplexV1DiscoveryEventPartitionDetails + action: + description: Details about the action associated with the event. + $ref: >- + #/components/schemas/GoogleCloudDataplexV1DiscoveryEventActionDetails + table: + description: >- + Details about the BigQuery table publishing associated with the + event. + $ref: '#/components/schemas/GoogleCloudDataplexV1DiscoveryEventTableDetails' + GoogleCloudDataplexV1DiscoveryEventConfigDetails: + id: GoogleCloudDataplexV1DiscoveryEventConfigDetails + description: Details about configuration events. + type: object + properties: + parameters: + description: >- + A list of discovery configuration parameters in effect. The keys are + the field paths within DiscoverySpec. Eg. includePatterns, + excludePatterns, csvOptions.disableTypeInference, etc. + type: object + additionalProperties: + type: string + GoogleCloudDataplexV1DiscoveryEventEntityDetails: + id: GoogleCloudDataplexV1DiscoveryEventEntityDetails + description: Details about the entity. + type: object + properties: + entity: + description: >- + The name of the entity resource. The name is the fully-qualified + resource name. type: string - thresholdPercent: - description: The passing threshold (0.0, 100.0) of the data quality rule. - type: number - format: double - result: - description: The result of the data quality rule. + type: + description: The type of the entity resource. type: string enumDescriptions: - - An unspecified result. - - The data quality rule passed. - - The data quality rule failed. + - An unspecified event type. + - Entities representing structured data. + - Entities representing unstructured data. enum: - - RESULT_UNSPECIFIED - - PASSED - - FAILED - evaluatedRowCount: + - ENTITY_TYPE_UNSPECIFIED + - TABLE + - FILESET + GoogleCloudDataplexV1DiscoveryEventPartitionDetails: + id: GoogleCloudDataplexV1DiscoveryEventPartitionDetails + description: Details about the partition. + type: object + properties: + partition: description: >- - The number of rows evaluated against the data quality rule. This - field is only valid for rules of PER_ROW evaluation type. + The name to the partition resource. The name is the fully-qualified + resource name. type: string - format: int64 - passedRowCount: + entity: description: >- - The number of rows which passed a rule evaluation. This field is - only valid for rules of PER_ROW evaluation type. + The name to the containing entity resource. The name is the + fully-qualified resource name. type: string - format: int64 - nullRowCount: - description: The number of rows with null values in the specified column. + type: + description: The type of the containing entity resource. type: string - format: int64 - assertionRowCount: + enumDescriptions: + - An unspecified event type. + - Entities representing structured data. + - Entities representing unstructured data. + enum: + - ENTITY_TYPE_UNSPECIFIED + - TABLE + - FILESET + sampledDataLocations: description: >- - The number of rows returned by the SQL statement in a SQL assertion - rule. This field is only valid for SQL assertion rules. + The locations of the data items (e.g., a Cloud Storage objects) + sampled for metadata inference. + type: array + items: + type: string + GoogleCloudDataplexV1DiscoveryEventActionDetails: + id: GoogleCloudDataplexV1DiscoveryEventActionDetails + description: Details about the action. + type: object + properties: + type: + description: The type of action. Eg. IncompatibleDataSchema, InvalidDataFormat type: string - format: int64 - GoogleCloudDataplexV1GovernanceEvent: - id: GoogleCloudDataplexV1GovernanceEvent - description: Payload associated with Governance related log events. + issue: + description: The human readable issue associated with the action. + type: string + GoogleCloudDataplexV1DiscoveryEventTableDetails: + id: GoogleCloudDataplexV1DiscoveryEventTableDetails + description: Details about the published table. + type: object + properties: + table: + description: The fully-qualified resource name of the table resource. + type: string + type: + description: The type of the table resource. + type: string + enumDescriptions: + - An unspecified table type. + - External table type. + - BigLake table type. + - Object table type for unstructured data. + enum: + - TABLE_TYPE_UNSPECIFIED + - EXTERNAL_TABLE + - BIGLAKE_TABLE + - OBJECT_TABLE + GoogleCloudDataplexV1JobEvent: + id: GoogleCloudDataplexV1JobEvent + description: >- + The payload associated with Job logs that contains events describing + jobs that have run within a Lake. type: object properties: message: description: The log message. type: string - eventType: + jobId: + description: The unique id identifying the job. + type: string + startTime: + description: The time when the job started running. + type: string + format: google-datetime + endTime: + description: The time when the job ended running. + type: string + format: google-datetime + state: + description: The job state on completion. + type: string + enumDescriptions: + - Unspecified job state. + - Job successfully completed. + - Job was unsuccessful. + - Job was cancelled by the user. + - Job was cancelled or aborted via the service executing the job. + enum: + - STATE_UNSPECIFIED + - SUCCEEDED + - FAILED + - CANCELLED + - ABORTED + retries: + description: The number of retries. + type: integer + format: int32 + type: + description: The type of the job. + type: string + enumDescriptions: + - Unspecified job type. + - Spark jobs. + - Notebook jobs. + enum: + - TYPE_UNSPECIFIED + - SPARK + - NOTEBOOK + service: + description: The service used to execute the job. + type: string + enumDescriptions: + - Unspecified service. + - Cloud Dataproc. + enum: + - SERVICE_UNSPECIFIED + - DATAPROC + serviceJob: + description: The reference to the job within the service. + type: string + executionTrigger: + description: Job execution trigger. + type: string + enumDescriptions: + - The job execution trigger is unspecified. + - >- + The job was triggered by Dataplex Universal Catalog based on + trigger spec from task definition. + - The job was triggered by the explicit call of Task API. + enum: + - EXECUTION_TRIGGER_UNSPECIFIED + - TASK_CONFIG + - RUN_REQUEST + GoogleCloudDataplexV1SessionEvent: + id: GoogleCloudDataplexV1SessionEvent + description: >- + These messages contain information about sessions within an environment. + The monitored resource is 'Environment'. + type: object + properties: + message: + description: The log message. + type: string + userId: + description: >- + The information about the user that created the session. It will be + the email address of the user. + type: string + sessionId: + description: Unique identifier for the session. + type: string + type: description: The type of the event. type: string enumDescriptions: - An unspecified event type. - - Resource IAM policy update event. - - BigQuery table create event. - - BigQuery table update event. - - BigQuery table delete event. - - BigQuery connection create event. - - BigQuery connection update event. - - BigQuery connection delete event. - - BigQuery taxonomy created. - - BigQuery policy tag created. - - BigQuery policy tag deleted. - - BigQuery set iam policy for policy tag. - - Access policy update event. - - Number of resources matched with particular Query. - - Rule processing exceeds the allowed limit. - - Rule processing errors. - - Governance rule processing Event. + - Event when the session is assigned to a user. + - Event for stop of a session. + - Query events in the session. + - >- + Event for creation of a cluster. It is not yet assigned to a user. + This comes before START in the sequence enum: - EVENT_TYPE_UNSPECIFIED - - RESOURCE_IAM_POLICY_UPDATE - - BIGQUERY_TABLE_CREATE - - BIGQUERY_TABLE_UPDATE - - BIGQUERY_TABLE_DELETE - - BIGQUERY_CONNECTION_CREATE - - BIGQUERY_CONNECTION_UPDATE - - BIGQUERY_CONNECTION_DELETE - - BIGQUERY_TAXONOMY_CREATE - - BIGQUERY_POLICY_TAG_CREATE - - BIGQUERY_POLICY_TAG_DELETE - - BIGQUERY_POLICY_TAG_SET_IAM_POLICY - - ACCESS_POLICY_UPDATE - - GOVERNANCE_RULE_MATCHED_RESOURCES - - GOVERNANCE_RULE_SEARCH_LIMIT_EXCEEDS - - GOVERNANCE_RULE_ERRORS - - GOVERNANCE_RULE_PROCESSING - entity: + - START + - STOP + - QUERY + - CREATE + query: + description: The execution details of the query. + $ref: '#/components/schemas/GoogleCloudDataplexV1SessionEventQueryDetail' + eventSucceeded: + description: The status of the event. + type: boolean + fastStartupEnabled: description: >- - Entity resource information if the log event is associated with a - specific entity. - $ref: '#/components/schemas/GoogleCloudDataplexV1GovernanceEventEntity' - GoogleCloudDataplexV1GovernanceEventEntity: - id: GoogleCloudDataplexV1GovernanceEventEntity - description: Information about Entity resource that the log event is associated with. + If the session is associated with an environment with fast startup + enabled, and was created before being assigned to a user. + type: boolean + unassignedDuration: + description: >- + The idle duration of a warm pooled session before it is assigned to + user. + type: string + format: google-duration + GoogleCloudDataplexV1SessionEventQueryDetail: + id: GoogleCloudDataplexV1SessionEventQueryDetail + description: Execution details of the query. type: object properties: - entity: - description: >- - The Entity resource the log event is associated with. Format: - projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id} + queryId: + description: The unique Query id identifying the query. type: string - entityType: - description: Type of entity. + queryText: + description: The query text executed. + type: string + engine: + description: Query Execution engine. type: string enumDescriptions: - - An unspecified Entity type. - - Table entity type. - - Fileset entity type. + - An unspecified Engine type. + - Spark-sql engine is specified in Query. + - BigQuery engine is specified in Query. enum: - - ENTITY_TYPE_UNSPECIFIED - - TABLE - - FILESET - parameters: - 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: - type: string - enum: - - json - - media - - proto - 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: + - ENGINE_UNSPECIFIED + - SPARK_SQL + - BIGQUERY + duration: + description: Time taken for execution of the query. + type: string + format: google-duration + resultSizeBytes: + description: The size of results the query produced. + type: string + format: int64 + dataProcessedBytes: + description: The data processed by the query. + type: string + format: int64 + GoogleCloudDataplexV1ImportItem: + id: GoogleCloudDataplexV1ImportItem 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: + An object that describes the values that you want to set for an entry + and its attached aspects when you import metadata. Used when you run a + metadata import job. See CreateMetadataJob.You provide a collection of + import items in a metadata import file. For more information about how + to create a metadata import file, see Metadata import file + (https://cloud.google.com/dataplex/docs/import-metadata#metadata-import-file). + type: object + properties: + entry: + description: Information about an entry and its attached aspects. + $ref: '#/components/schemas/GoogleCloudDataplexV1Entry' + entryLink: + description: >- + Information about the entry link. User should provide either one of + the entry or entry_link. While providing entry_link, user should not + provide update_mask and aspect_keys. + $ref: '#/components/schemas/GoogleCloudDataplexV1EntryLink' + updateMask: + description: >- + The fields to update, in paths that are relative to the Entry + resource. Separate each field with a comma.In FULL entry sync mode, + Dataplex Universal Catalog includes the paths of all of the fields + for an entry that can be modified, including aspects. This means + that Dataplex Universal Catalog replaces the existing entry with the + entry in the metadata import file. All modifiable fields are + updated, regardless of the fields that are listed in the update + mask, and regardless of whether a field is present in the entry + object.The update_mask field is ignored when an entry is created or + re-created.In an aspect-only metadata job (when entry sync mode is + NONE), set this value to aspects.Dataplex Universal Catalog also + determines which entries and aspects to modify by comparing the + values and timestamps that you provide in the metadata import file + with the values and timestamps that exist in your project. For more + information, see Comparison logic + (https://cloud.google.com/dataplex/docs/import-metadata#data-modification-logic). + type: string + format: google-fieldmask + aspectKeys: + description: >- + The aspects to modify. Supports the following syntaxes: + {aspect_type_reference}: matches aspects that belong to the + specified aspect type and are attached directly to the entry. + {aspect_type_reference}@{path}: matches aspects that belong to the + specified aspect type and path. {aspect_type_reference}@* : matches + aspects of the given type for all paths. *@path : matches aspects of + all types on the given path.Replace {aspect_type_reference} with a + reference to the aspect type, in the format + {project_id_or_number}.{location_id}.{aspect_type_id}.In FULL entry + sync mode, if you leave this field empty, it is treated as + specifying exactly those aspects that are present within the + specified entry. Dataplex Universal Catalog implicitly adds the keys + for all of the required aspects of an entry. + type: array + items: + type: string + GoogleCloudDataplexV1DataScanEvent: + id: GoogleCloudDataplexV1DataScanEvent 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 - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string - _.xgafv: - description: V1 error format. - in: query - name: $.xgafv - schema: - type: string - enum: - - '1' - - '2' - x-stackQL-resources: - locations: - id: google.dataplex.locations - name: locations - title: Locations - methods: - projects_locations_lookup_entry: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:lookupEntry/get - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_search_entries: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:searchEntries/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_list: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.locations - projects_locations_get: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/locations/methods/projects_locations_get - - $ref: >- - #/components/x-stackQL-resources/locations/methods/projects_locations_list - insert: [] - update: [] - replace: [] - delete: [] - operations: - id: google.dataplex.operations - name: operations - title: Operations - methods: - projects_locations_operations_list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.operations - projects_locations_operations_get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_operations_delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_operations_cancel: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_locations_operations_get: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1operations~1{operationsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_locations_operations_delete: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1operations~1{operationsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_locations_operations_cancel: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_operations_get - - $ref: >- - #/components/x-stackQL-resources/operations/methods/organizations_locations_operations_get - - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_operations_list - insert: [] - update: [] - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_operations_delete - - $ref: >- - #/components/x-stackQL-resources/operations/methods/organizations_locations_operations_delete - entry_types: - id: google.dataplex.entry_types - name: entry_types - title: Entry_types - methods: - projects_locations_entry_types_create: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryTypes/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_entry_types_list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryTypes/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.entryTypes - projects_locations_entry_types_patch: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryTypes~1{entryTypesId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_entry_types_delete: - operation: + These messages contain information about the execution of a datascan. + The monitored resource is 'DataScan' + type: object + properties: + dataSource: + description: The data source of the data scan + type: string + jobId: + description: The identifier of the specific data scan job this log entry is for. + type: string + createTime: + description: The time when the data scan job was created. + type: string + format: google-datetime + startTime: + description: The time when the data scan job started to run. + type: string + format: google-datetime + endTime: + description: The time when the data scan job finished. + type: string + format: google-datetime + type: + description: The type of the data scan. + type: string + enumDescriptions: + - An unspecified data scan type. + - Data scan for data profile. + - Data scan for data quality. + - Data scan for data discovery. + enum: + - SCAN_TYPE_UNSPECIFIED + - DATA_PROFILE + - DATA_QUALITY + - DATA_DISCOVERY + state: + description: The status of the data scan job. + type: string + enumDescriptions: + - Unspecified job state. + - Data scan job started. + - Data scan job successfully completed. + - Data scan job was unsuccessful. + - Data scan job was cancelled. + - Data scan job was created. + enum: + - STATE_UNSPECIFIED + - STARTED + - SUCCEEDED + - FAILED + - CANCELLED + - CREATED + message: + description: The message describing the data scan job event. + type: string + specVersion: + description: A version identifier of the spec which was used to execute this job. + type: string + trigger: + description: The trigger type of the data scan job. + type: string + enumDescriptions: + - An unspecified trigger type. + - Data scan triggers on demand. + - Data scan triggers as per schedule. + enum: + - TRIGGER_UNSPECIFIED + - ON_DEMAND + - SCHEDULE + scope: + description: The scope of the data scan (e.g. full, incremental). + type: string + enumDescriptions: + - An unspecified scope type. + - Data scan runs on all of the data. + - Data scan runs on incremental data. + enum: + - SCOPE_UNSPECIFIED + - FULL + - INCREMENTAL + dataProfile: + description: Data profile result for data profile type data scan. + $ref: >- + #/components/schemas/GoogleCloudDataplexV1DataScanEventDataProfileResult + dataQuality: + description: Data quality result for data quality type data scan. + $ref: >- + #/components/schemas/GoogleCloudDataplexV1DataScanEventDataQualityResult + dataProfileConfigs: + description: Applied configs for data profile type data scan. + $ref: >- + #/components/schemas/GoogleCloudDataplexV1DataScanEventDataProfileAppliedConfigs + dataQualityConfigs: + description: Applied configs for data quality type data scan. + $ref: >- + #/components/schemas/GoogleCloudDataplexV1DataScanEventDataQualityAppliedConfigs + postScanActionsResult: + description: The result of post scan actions. + $ref: >- + #/components/schemas/GoogleCloudDataplexV1DataScanEventPostScanActionsResult + catalogPublishingStatus: + description: >- + The status of publishing the data scan as Dataplex Universal Catalog + metadata. + $ref: >- + #/components/schemas/GoogleCloudDataplexV1DataScanCatalogPublishingStatus + GoogleCloudDataplexV1DataScanEventDataProfileResult: + id: GoogleCloudDataplexV1DataScanEventDataProfileResult + description: Data profile result for data scan job. + type: object + properties: + rowCount: + description: The count of rows processed in the data scan job. + type: string + format: int64 + GoogleCloudDataplexV1DataScanEventDataQualityResult: + id: GoogleCloudDataplexV1DataScanEventDataQualityResult + description: Data quality result for data scan job. + type: object + properties: + rowCount: + description: The count of rows processed in the data scan job. + type: string + format: int64 + passed: + description: Whether the data quality result was pass or not. + type: boolean + dimensionPassed: + description: >- + The result of each dimension for data quality result. The key of the + map is the name of the dimension. The value is the bool value + depicting whether the dimension result was pass or not. + type: object + additionalProperties: + type: boolean + score: + description: >- + The table-level data quality score for the data scan job.The data + quality score ranges between 0, 100 (up to two decimal points). + type: number + format: float + dimensionScore: + description: >- + The score of each dimension for data quality result. The key of the + map is the name of the dimension. The value is the data quality + score for the dimension.The score ranges between 0, 100 (up to two + decimal points). + type: object + additionalProperties: + type: number + format: float + columnScore: + description: >- + The score of each column scanned in the data scan job. The key of + the map is the name of the column. The value is the data quality + score for the column.The score ranges between 0, 100 (up to two + decimal points). + type: object + additionalProperties: + type: number + format: float + GoogleCloudDataplexV1DataScanEventDataProfileAppliedConfigs: + id: GoogleCloudDataplexV1DataScanEventDataProfileAppliedConfigs + description: Applied configs for data profile type data scan job. + type: object + properties: + samplingPercent: + description: >- + The percentage of the records selected from the dataset for + DataScan. Value ranges between 0.0 and 100.0. Value 0.0 or 100.0 + imply that sampling was not applied. + type: number + format: float + rowFilterApplied: + description: >- + Boolean indicating whether a row filter was applied in the DataScan + job. + type: boolean + columnFilterApplied: + description: >- + Boolean indicating whether a column filter was applied in the + DataScan job. + type: boolean + GoogleCloudDataplexV1DataScanEventDataQualityAppliedConfigs: + id: GoogleCloudDataplexV1DataScanEventDataQualityAppliedConfigs + description: Applied configs for data quality type data scan job. + type: object + properties: + samplingPercent: + description: >- + The percentage of the records selected from the dataset for + DataScan. Value ranges between 0.0 and 100.0. Value 0.0 or 100.0 + imply that sampling was not applied. + type: number + format: float + rowFilterApplied: + description: >- + Boolean indicating whether a row filter was applied in the DataScan + job. + type: boolean + GoogleCloudDataplexV1DataScanEventPostScanActionsResult: + id: GoogleCloudDataplexV1DataScanEventPostScanActionsResult + description: Post scan actions result for data scan job. + type: object + properties: + bigqueryExportResult: + description: The result of BigQuery export post scan action. + $ref: >- + #/components/schemas/GoogleCloudDataplexV1DataScanEventPostScanActionsResultBigQueryExportResult + GoogleCloudDataplexV1DataScanEventPostScanActionsResultBigQueryExportResult: + id: >- + GoogleCloudDataplexV1DataScanEventPostScanActionsResultBigQueryExportResult + description: The result of BigQuery export post scan action. + type: object + properties: + state: + description: Execution state for the BigQuery exporting. + type: string + enumDescriptions: + - The exporting state is unspecified. + - The exporting completed successfully. + - The exporting is no longer running due to an error. + - >- + The exporting is skipped due to no valid scan result to export + (usually caused by scan failed). + enum: + - STATE_UNSPECIFIED + - SUCCEEDED + - FAILED + - SKIPPED + message: + description: Additional information about the BigQuery exporting. + type: string + GoogleCloudDataplexV1DataQualityScanRuleResult: + id: GoogleCloudDataplexV1DataQualityScanRuleResult + description: >- + Information about the result of a data quality rule for data quality + scan. The monitored resource is 'DataScan'. + type: object + properties: + jobId: + description: Identifier of the specific data scan job this log entry is for. + type: string + dataSource: + description: The data source of the data scan (e.g. BigQuery table name). + type: string + column: + description: The column which this rule is evaluated against. + type: string + ruleName: + description: The name of the data quality rule. + type: string + ruleType: + description: The type of the data quality rule. + type: string + enumDescriptions: + - An unspecified rule type. + - See DataQualityRule.NonNullExpectation. + - See DataQualityRule.RangeExpectation. + - See DataQualityRule.RegexExpectation. + - See DataQualityRule.RowConditionExpectation. + - See DataQualityRule.SetExpectation. + - See DataQualityRule.StatisticRangeExpectation. + - See DataQualityRule.TableConditionExpectation. + - See DataQualityRule.UniquenessExpectation. + - See DataQualityRule.SqlAssertion. + enum: + - RULE_TYPE_UNSPECIFIED + - NON_NULL_EXPECTATION + - RANGE_EXPECTATION + - REGEX_EXPECTATION + - ROW_CONDITION_EXPECTATION + - SET_EXPECTATION + - STATISTIC_RANGE_EXPECTATION + - TABLE_CONDITION_EXPECTATION + - UNIQUENESS_EXPECTATION + - SQL_ASSERTION + evalutionType: + description: The evaluation type of the data quality rule. + type: string + enumDescriptions: + - An unspecified evaluation type. + - The rule evaluation is done at per row level. + - The rule evaluation is done for an aggregate of rows. + enum: + - EVALUATION_TYPE_UNSPECIFIED + - PER_ROW + - AGGREGATE + ruleDimension: + description: The dimension of the data quality rule. + type: string + thresholdPercent: + description: The passing threshold (0.0, 100.0) of the data quality rule. + type: number + format: double + result: + description: The result of the data quality rule. + type: string + enumDescriptions: + - An unspecified result. + - The data quality rule passed. + - The data quality rule failed. + enum: + - RESULT_UNSPECIFIED + - PASSED + - FAILED + evaluatedRowCount: + description: >- + The number of rows evaluated against the data quality rule. This + field is only valid for rules of PER_ROW evaluation type. + type: string + format: int64 + passedRowCount: + description: >- + The number of rows which passed a rule evaluation. This field is + only valid for rules of PER_ROW evaluation type. + type: string + format: int64 + nullRowCount: + description: The number of rows with null values in the specified column. + type: string + format: int64 + assertionRowCount: + description: >- + The number of rows returned by the SQL statement in a SQL assertion + rule. This field is only valid for SQL assertion rules. + type: string + format: int64 + GoogleCloudDataplexV1GovernanceEvent: + id: GoogleCloudDataplexV1GovernanceEvent + description: Payload associated with Governance related log events. + type: object + properties: + message: + description: The log message. + type: string + eventType: + description: The type of the event. + type: string + enumDescriptions: + - An unspecified event type. + - Resource IAM policy update event. + - BigQuery table create event. + - BigQuery table update event. + - BigQuery table delete event. + - BigQuery connection create event. + - BigQuery connection update event. + - BigQuery connection delete event. + - BigQuery taxonomy created. + - BigQuery policy tag created. + - BigQuery policy tag deleted. + - BigQuery set iam policy for policy tag. + - Access policy update event. + - Number of resources matched with particular Query. + - Rule processing exceeds the allowed limit. + - Rule processing errors. + - Governance rule processing Event. + enum: + - EVENT_TYPE_UNSPECIFIED + - RESOURCE_IAM_POLICY_UPDATE + - BIGQUERY_TABLE_CREATE + - BIGQUERY_TABLE_UPDATE + - BIGQUERY_TABLE_DELETE + - BIGQUERY_CONNECTION_CREATE + - BIGQUERY_CONNECTION_UPDATE + - BIGQUERY_CONNECTION_DELETE + - BIGQUERY_TAXONOMY_CREATE + - BIGQUERY_POLICY_TAG_CREATE + - BIGQUERY_POLICY_TAG_DELETE + - BIGQUERY_POLICY_TAG_SET_IAM_POLICY + - ACCESS_POLICY_UPDATE + - GOVERNANCE_RULE_MATCHED_RESOURCES + - GOVERNANCE_RULE_SEARCH_LIMIT_EXCEEDS + - GOVERNANCE_RULE_ERRORS + - GOVERNANCE_RULE_PROCESSING + entity: + description: >- + Entity resource information if the log event is associated with a + specific entity. + $ref: '#/components/schemas/GoogleCloudDataplexV1GovernanceEventEntity' + GoogleCloudDataplexV1GovernanceEventEntity: + id: GoogleCloudDataplexV1GovernanceEventEntity + description: Information about Entity resource that the log event is associated with. + type: object + properties: + entity: + description: >- + The Entity resource the log event is associated with. Format: + projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id} + type: string + entityType: + description: Type of entity. + type: string + enumDescriptions: + - An unspecified Entity type. + - Table entity type. + - Fileset entity type. + enum: + - ENTITY_TYPE_UNSPECIFIED + - TABLE + - FILESET + GoogleCloudDataplexV1BusinessGlossaryEvent: + id: GoogleCloudDataplexV1BusinessGlossaryEvent + description: Payload associated with Business Glossary related log events. + type: object + properties: + message: + description: The log message. + type: string + eventType: + description: The type of the event. + type: string + enumDescriptions: + - An unspecified event type. + - Glossary create event. + - Glossary update event. + - Glossary delete event. + - Glossary category create event. + - Glossary category update event. + - Glossary category delete event. + - Glossary term create event. + - Glossary term update event. + - Glossary term delete event. + enum: + - EVENT_TYPE_UNSPECIFIED + - GLOSSARY_CREATE + - GLOSSARY_UPDATE + - GLOSSARY_DELETE + - GLOSSARY_CATEGORY_CREATE + - GLOSSARY_CATEGORY_UPDATE + - GLOSSARY_CATEGORY_DELETE + - GLOSSARY_TERM_CREATE + - GLOSSARY_TERM_UPDATE + - GLOSSARY_TERM_DELETE + resource: + description: Name of the resource. + type: string + GoogleCloudDataplexV1EntryLinkEvent: + id: GoogleCloudDataplexV1EntryLinkEvent + description: Payload associated with Entry related log events. + type: object + properties: + message: + description: The log message. + type: string + eventType: + description: The type of the event. + type: string + enumDescriptions: + - An unspecified event type. + - EntryLink create event. + - EntryLink delete event. + enum: + - EVENT_TYPE_UNSPECIFIED + - ENTRY_LINK_CREATE + - ENTRY_LINK_DELETE + resource: + description: Name of the resource. + type: string + parameters: + 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: + type: string + enum: + - json + - media + - proto + 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 + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + x-stackQL-resources: + locations: + id: google.dataplex.locations + name: locations + title: Locations + methods: + projects_locations_lookup_entry: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:lookupEntry/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_search_entries: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:searchEntries/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_list: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.locations + projects_locations_get: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/locations/methods/projects_locations_get + - $ref: >- + #/components/x-stackQL-resources/locations/methods/projects_locations_list + insert: [] + update: [] + replace: [] + delete: [] + operations: + id: google.dataplex.operations + name: operations + title: Operations + methods: + projects_locations_operations_list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.operations + projects_locations_operations_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_operations_delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_operations_cancel: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_operations_list: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1operations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.operations + organizations_locations_operations_get: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_operations_delete: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1operations~1{operationsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_operations_cancel: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_locations_operations_get + - $ref: >- + #/components/x-stackQL-resources/operations/methods/organizations_locations_operations_get + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_locations_operations_list + - $ref: >- + #/components/x-stackQL-resources/operations/methods/organizations_locations_operations_list + insert: [] + update: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_locations_operations_delete + - $ref: >- + #/components/x-stackQL-resources/operations/methods/organizations_locations_operations_delete + entry_types: + id: google.dataplex.entry_types + name: entry_types + title: Entry_types + methods: + projects_locations_entry_types_create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryTypes/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_entry_types_list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryTypes/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.entryTypes + projects_locations_entry_types_patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryTypes~1{entryTypesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_entry_types_delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryTypes~1{entryTypesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_entry_types_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryTypes~1{entryTypesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/entry_types/methods/projects_locations_entry_types_get + - $ref: >- + #/components/x-stackQL-resources/entry_types/methods/projects_locations_entry_types_list + insert: + - $ref: >- + #/components/x-stackQL-resources/entry_types/methods/projects_locations_entry_types_create + update: + - $ref: >- + #/components/x-stackQL-resources/entry_types/methods/projects_locations_entry_types_patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/entry_types/methods/projects_locations_entry_types_delete + entry_types_iam_policies: + id: google.dataplex.entry_types_iam_policies + name: entry_types_iam_policies + title: Entry_types_iam_policies + methods: + projects_locations_entry_types_set_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryTypes~1{entryTypesId}:setIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_entry_types_get_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryTypes~1{entryTypesId}:getIamPolicy/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.bindings + projects_locations_entry_types_test_iam_permissions: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryTypes~1{entryTypesId}:testIamPermissions/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/entry_types_iam_policies/methods/projects_locations_entry_types_get_iam_policy + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/entry_types_iam_policies/methods/projects_locations_entry_types_set_iam_policy + delete: [] + aspect_types: + id: google.dataplex.aspect_types + name: aspect_types + title: Aspect_types + methods: + projects_locations_aspect_types_create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1aspectTypes/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_aspect_types_list: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryTypes~1{entryTypesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1aspectTypes/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_entry_types_get: + objectKey: $.aspectTypes + projects_locations_aspect_types_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryTypes~1{entryTypesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1aspectTypes~1{aspectTypesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_aspect_types_delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1aspectTypes~1{aspectTypesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_aspect_types_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1aspectTypes~1{aspectTypesId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/entry_types/methods/projects_locations_entry_types_get + #/components/x-stackQL-resources/aspect_types/methods/projects_locations_aspect_types_get - $ref: >- - #/components/x-stackQL-resources/entry_types/methods/projects_locations_entry_types_list + #/components/x-stackQL-resources/aspect_types/methods/projects_locations_aspect_types_list insert: - $ref: >- - #/components/x-stackQL-resources/entry_types/methods/projects_locations_entry_types_create + #/components/x-stackQL-resources/aspect_types/methods/projects_locations_aspect_types_create update: - $ref: >- - #/components/x-stackQL-resources/entry_types/methods/projects_locations_entry_types_patch + #/components/x-stackQL-resources/aspect_types/methods/projects_locations_aspect_types_patch replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/entry_types/methods/projects_locations_entry_types_delete - entry_types_iam_policies: - id: google.dataplex.entry_types_iam_policies - name: entry_types_iam_policies - title: Entry_types_iam_policies + #/components/x-stackQL-resources/aspect_types/methods/projects_locations_aspect_types_delete + aspect_types_iam_policies: + id: google.dataplex.aspect_types_iam_policies + name: aspect_types_iam_policies + title: Aspect_types_iam_policies methods: - projects_locations_entry_types_set_iam_policy: + projects_locations_aspect_types_set_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1aspectTypes~1{aspectTypesId}:setIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_aspect_types_get_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1aspectTypes~1{aspectTypesId}:getIamPolicy/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.bindings + projects_locations_aspect_types_test_iam_permissions: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1aspectTypes~1{aspectTypesId}:testIamPermissions/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/aspect_types_iam_policies/methods/projects_locations_aspect_types_get_iam_policy + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/aspect_types_iam_policies/methods/projects_locations_aspect_types_set_iam_policy + delete: [] + entry_groups: + id: google.dataplex.entry_groups + name: entry_groups + title: Entry_groups + methods: + projects_locations_entry_groups_create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryGroups/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_entry_groups_list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryGroups/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.entryGroups + projects_locations_entry_groups_patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryGroups~1{entryGroupsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_entry_groups_delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryGroups~1{entryGroupsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_entry_groups_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryGroups~1{entryGroupsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/entry_groups/methods/projects_locations_entry_groups_get + - $ref: >- + #/components/x-stackQL-resources/entry_groups/methods/projects_locations_entry_groups_list + insert: + - $ref: >- + #/components/x-stackQL-resources/entry_groups/methods/projects_locations_entry_groups_create + update: + - $ref: >- + #/components/x-stackQL-resources/entry_groups/methods/projects_locations_entry_groups_patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/entry_groups/methods/projects_locations_entry_groups_delete + entry_groups_iam_policies: + id: google.dataplex.entry_groups_iam_policies + name: entry_groups_iam_policies + title: Entry_groups_iam_policies + methods: + projects_locations_entry_groups_set_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryGroups~1{entryGroupsId}:setIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_entry_groups_get_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryGroups~1{entryGroupsId}:getIamPolicy/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.bindings + projects_locations_entry_groups_test_iam_permissions: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryGroups~1{entryGroupsId}:testIamPermissions/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/entry_groups_iam_policies/methods/projects_locations_entry_groups_get_iam_policy + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/entry_groups_iam_policies/methods/projects_locations_entry_groups_set_iam_policy + delete: [] + entries: + id: google.dataplex.entries + name: entries + title: Entries + methods: + projects_locations_entry_groups_entries_create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryGroups~1{entryGroupsId}~1entries/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_entry_groups_entries_list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryGroups~1{entryGroupsId}~1entries/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.entries + projects_locations_entry_groups_entries_patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryGroups~1{entryGroupsId}~1entries~1{entriesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_entry_groups_entries_delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryGroups~1{entryGroupsId}~1entries~1{entriesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_entry_groups_entries_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryGroups~1{entryGroupsId}~1entries~1{entriesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/entries/methods/projects_locations_entry_groups_entries_get + - $ref: >- + #/components/x-stackQL-resources/entries/methods/projects_locations_entry_groups_entries_list + insert: + - $ref: >- + #/components/x-stackQL-resources/entries/methods/projects_locations_entry_groups_entries_create + update: + - $ref: >- + #/components/x-stackQL-resources/entries/methods/projects_locations_entry_groups_entries_patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/entries/methods/projects_locations_entry_groups_entries_delete + entry_links: + id: google.dataplex.entry_links + name: entry_links + title: Entry_links + methods: + projects_locations_entry_groups_entry_links_create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryGroups~1{entryGroupsId}~1entryLinks/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_entry_groups_entry_links_delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryGroups~1{entryGroupsId}~1entryLinks~1{entryLinksId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_entry_groups_entry_links_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryGroups~1{entryGroupsId}~1entryLinks~1{entryLinksId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/entry_links/methods/projects_locations_entry_groups_entry_links_get + insert: + - $ref: >- + #/components/x-stackQL-resources/entry_links/methods/projects_locations_entry_groups_entry_links_create + update: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/entry_links/methods/projects_locations_entry_groups_entry_links_delete + metadata_jobs: + id: google.dataplex.metadata_jobs + name: metadata_jobs + title: Metadata_jobs + methods: + projects_locations_metadata_jobs_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryTypes~1{entryTypesId}:setIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataJobs/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_entry_types_get_iam_policy: + projects_locations_metadata_jobs_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryTypes~1{entryTypesId}:getIamPolicy/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataJobs/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.bindings - projects_locations_entry_types_test_iam_permissions: + objectKey: $.metadataJobs + projects_locations_metadata_jobs_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryTypes~1{entryTypesId}:testIamPermissions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataJobs~1{metadataJobsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_metadata_jobs_cancel: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataJobs~1{metadataJobsId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/entry_types_iam_policies/methods/projects_locations_entry_types_get_iam_policy - insert: [] - update: [] - replace: + #/components/x-stackQL-resources/metadata_jobs/methods/projects_locations_metadata_jobs_get - $ref: >- - #/components/x-stackQL-resources/entry_types_iam_policies/methods/projects_locations_entry_types_set_iam_policy + #/components/x-stackQL-resources/metadata_jobs/methods/projects_locations_metadata_jobs_list + insert: + - $ref: >- + #/components/x-stackQL-resources/metadata_jobs/methods/projects_locations_metadata_jobs_create + update: [] + replace: [] delete: [] - aspect_types: - id: google.dataplex.aspect_types - name: aspect_types - title: Aspect_types + glossaries: + id: google.dataplex.glossaries + name: glossaries + title: Glossaries methods: - projects_locations_aspect_types_create: + projects_locations_glossaries_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1aspectTypes/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1glossaries/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_aspect_types_list: + projects_locations_glossaries_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1aspectTypes/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1glossaries/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.aspectTypes - projects_locations_aspect_types_patch: + objectKey: $.glossaries + projects_locations_glossaries_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1aspectTypes~1{aspectTypesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1glossaries~1{glossariesId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_aspect_types_delete: + projects_locations_glossaries_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1aspectTypes~1{aspectTypesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1glossaries~1{glossariesId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_aspect_types_get: + projects_locations_glossaries_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1aspectTypes~1{aspectTypesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1glossaries~1{glossariesId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/aspect_types/methods/projects_locations_aspect_types_get + #/components/x-stackQL-resources/glossaries/methods/projects_locations_glossaries_get - $ref: >- - #/components/x-stackQL-resources/aspect_types/methods/projects_locations_aspect_types_list + #/components/x-stackQL-resources/glossaries/methods/projects_locations_glossaries_list insert: - $ref: >- - #/components/x-stackQL-resources/aspect_types/methods/projects_locations_aspect_types_create + #/components/x-stackQL-resources/glossaries/methods/projects_locations_glossaries_create update: - $ref: >- - #/components/x-stackQL-resources/aspect_types/methods/projects_locations_aspect_types_patch + #/components/x-stackQL-resources/glossaries/methods/projects_locations_glossaries_patch replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/aspect_types/methods/projects_locations_aspect_types_delete - aspect_types_iam_policies: - id: google.dataplex.aspect_types_iam_policies - name: aspect_types_iam_policies - title: Aspect_types_iam_policies + #/components/x-stackQL-resources/glossaries/methods/projects_locations_glossaries_delete + glossaries_iam_policies: + id: google.dataplex.glossaries_iam_policies + name: glossaries_iam_policies + title: Glossaries_iam_policies methods: - projects_locations_aspect_types_set_iam_policy: + projects_locations_glossaries_set_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1aspectTypes~1{aspectTypesId}:setIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1glossaries~1{glossariesId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_aspect_types_get_iam_policy: + projects_locations_glossaries_get_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1aspectTypes~1{aspectTypesId}:getIamPolicy/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1glossaries~1{glossariesId}:getIamPolicy/get response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_aspect_types_test_iam_permissions: + projects_locations_glossaries_test_iam_permissions: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1aspectTypes~1{aspectTypesId}:testIamPermissions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1glossaries~1{glossariesId}:testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/aspect_types_iam_policies/methods/projects_locations_aspect_types_get_iam_policy + #/components/x-stackQL-resources/glossaries_iam_policies/methods/projects_locations_glossaries_get_iam_policy insert: [] update: [] replace: - $ref: >- - #/components/x-stackQL-resources/aspect_types_iam_policies/methods/projects_locations_aspect_types_set_iam_policy + #/components/x-stackQL-resources/glossaries_iam_policies/methods/projects_locations_glossaries_set_iam_policy delete: [] - entry_groups: - id: google.dataplex.entry_groups - name: entry_groups - title: Entry_groups + categories: + id: google.dataplex.categories + name: categories + title: Categories methods: - projects_locations_entry_groups_create: + projects_locations_glossaries_categories_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryGroups/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1glossaries~1{glossariesId}~1categories/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_entry_groups_list: + projects_locations_glossaries_categories_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryGroups/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1glossaries~1{glossariesId}~1categories/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.entryGroups - projects_locations_entry_groups_patch: + objectKey: $.categories + projects_locations_glossaries_categories_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryGroups~1{entryGroupsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1glossaries~1{glossariesId}~1categories~1{categoriesId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_entry_groups_delete: + projects_locations_glossaries_categories_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryGroups~1{entryGroupsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1glossaries~1{glossariesId}~1categories~1{categoriesId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_entry_groups_get: + projects_locations_glossaries_categories_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryGroups~1{entryGroupsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1glossaries~1{glossariesId}~1categories~1{categoriesId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/entry_groups/methods/projects_locations_entry_groups_get + #/components/x-stackQL-resources/categories/methods/projects_locations_glossaries_categories_get - $ref: >- - #/components/x-stackQL-resources/entry_groups/methods/projects_locations_entry_groups_list + #/components/x-stackQL-resources/categories/methods/projects_locations_glossaries_categories_list insert: - $ref: >- - #/components/x-stackQL-resources/entry_groups/methods/projects_locations_entry_groups_create + #/components/x-stackQL-resources/categories/methods/projects_locations_glossaries_categories_create update: - $ref: >- - #/components/x-stackQL-resources/entry_groups/methods/projects_locations_entry_groups_patch + #/components/x-stackQL-resources/categories/methods/projects_locations_glossaries_categories_patch replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/entry_groups/methods/projects_locations_entry_groups_delete - entry_groups_iam_policies: - id: google.dataplex.entry_groups_iam_policies - name: entry_groups_iam_policies - title: Entry_groups_iam_policies + #/components/x-stackQL-resources/categories/methods/projects_locations_glossaries_categories_delete + categories_iam_policies: + id: google.dataplex.categories_iam_policies + name: categories_iam_policies + title: Categories_iam_policies methods: - projects_locations_entry_groups_set_iam_policy: + projects_locations_glossaries_categories_set_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryGroups~1{entryGroupsId}:setIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1glossaries~1{glossariesId}~1categories~1{categoriesId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_entry_groups_get_iam_policy: + projects_locations_glossaries_categories_get_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryGroups~1{entryGroupsId}:getIamPolicy/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1glossaries~1{glossariesId}~1categories~1{categoriesId}:getIamPolicy/get response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_entry_groups_test_iam_permissions: + projects_locations_glossaries_categories_test_iam_permissions: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryGroups~1{entryGroupsId}:testIamPermissions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1glossaries~1{glossariesId}~1categories~1{categoriesId}:testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/entry_groups_iam_policies/methods/projects_locations_entry_groups_get_iam_policy + #/components/x-stackQL-resources/categories_iam_policies/methods/projects_locations_glossaries_categories_get_iam_policy insert: [] update: [] replace: - $ref: >- - #/components/x-stackQL-resources/entry_groups_iam_policies/methods/projects_locations_entry_groups_set_iam_policy + #/components/x-stackQL-resources/categories_iam_policies/methods/projects_locations_glossaries_categories_set_iam_policy delete: [] - entries: - id: google.dataplex.entries - name: entries - title: Entries + terms: + id: google.dataplex.terms + name: terms + title: Terms methods: - projects_locations_entry_groups_entries_create: + projects_locations_glossaries_terms_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryGroups~1{entryGroupsId}~1entries/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1glossaries~1{glossariesId}~1terms/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_entry_groups_entries_list: + projects_locations_glossaries_terms_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryGroups~1{entryGroupsId}~1entries/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1glossaries~1{glossariesId}~1terms/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.entries - projects_locations_entry_groups_entries_patch: + objectKey: $.terms + projects_locations_glossaries_terms_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryGroups~1{entryGroupsId}~1entries~1{entriesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1glossaries~1{glossariesId}~1terms~1{termsId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_entry_groups_entries_delete: + projects_locations_glossaries_terms_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryGroups~1{entryGroupsId}~1entries~1{entriesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1glossaries~1{glossariesId}~1terms~1{termsId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_entry_groups_entries_get: + projects_locations_glossaries_terms_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryGroups~1{entryGroupsId}~1entries~1{entriesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1glossaries~1{glossariesId}~1terms~1{termsId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/entries/methods/projects_locations_entry_groups_entries_get + #/components/x-stackQL-resources/terms/methods/projects_locations_glossaries_terms_get - $ref: >- - #/components/x-stackQL-resources/entries/methods/projects_locations_entry_groups_entries_list + #/components/x-stackQL-resources/terms/methods/projects_locations_glossaries_terms_list insert: - $ref: >- - #/components/x-stackQL-resources/entries/methods/projects_locations_entry_groups_entries_create + #/components/x-stackQL-resources/terms/methods/projects_locations_glossaries_terms_create update: - $ref: >- - #/components/x-stackQL-resources/entries/methods/projects_locations_entry_groups_entries_patch + #/components/x-stackQL-resources/terms/methods/projects_locations_glossaries_terms_patch replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/entries/methods/projects_locations_entry_groups_entries_delete - metadata_jobs: - id: google.dataplex.metadata_jobs - name: metadata_jobs - title: Metadata_jobs + #/components/x-stackQL-resources/terms/methods/projects_locations_glossaries_terms_delete + terms_iam_policies: + id: google.dataplex.terms_iam_policies + name: terms_iam_policies + title: Terms_iam_policies methods: - projects_locations_metadata_jobs_create: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataJobs/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_metadata_jobs_list: + projects_locations_glossaries_terms_set_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataJobs/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1glossaries~1{glossariesId}~1terms~1{termsId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.metadataJobs - projects_locations_metadata_jobs_get: + projects_locations_glossaries_terms_get_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataJobs~1{metadataJobsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1glossaries~1{glossariesId}~1terms~1{termsId}:getIamPolicy/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_metadata_jobs_cancel: + objectKey: $.bindings + projects_locations_glossaries_terms_test_iam_permissions: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataJobs~1{metadataJobsId}:cancel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1glossaries~1{glossariesId}~1terms~1{termsId}:testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/metadata_jobs/methods/projects_locations_metadata_jobs_get - - $ref: >- - #/components/x-stackQL-resources/metadata_jobs/methods/projects_locations_metadata_jobs_list - insert: - - $ref: >- - #/components/x-stackQL-resources/metadata_jobs/methods/projects_locations_metadata_jobs_create + #/components/x-stackQL-resources/terms_iam_policies/methods/projects_locations_glossaries_terms_get_iam_policy + insert: [] update: [] - replace: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/terms_iam_policies/methods/projects_locations_glossaries_terms_set_iam_policy delete: [] lakes_iam_policies: id: google.dataplex.lakes_iam_policies @@ -8406,117 +9603,137 @@ components: - $ref: >- #/components/x-stackQL-resources/governance_rules_iam_policies/methods/projects_locations_governance_rules_set_iam_policy delete: [] - glossaries_iam_policies: - id: google.dataplex.glossaries_iam_policies - name: glossaries_iam_policies - title: Glossaries_iam_policies + data_products_iam_policies: + id: google.dataplex.data_products_iam_policies + name: data_products_iam_policies + title: Data_products_iam_policies methods: - projects_locations_glossaries_set_iam_policy: + projects_locations_data_products_set_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1glossaries~1{glossariesId}:setIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataProducts~1{dataProductsId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_glossaries_get_iam_policy: + projects_locations_data_products_get_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1glossaries~1{glossariesId}:getIamPolicy/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataProducts~1{dataProductsId}:getIamPolicy/get response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_glossaries_test_iam_permissions: + projects_locations_data_products_test_iam_permissions: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1glossaries~1{glossariesId}:testIamPermissions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataProducts~1{dataProductsId}:testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/glossaries_iam_policies/methods/projects_locations_glossaries_get_iam_policy + #/components/x-stackQL-resources/data_products_iam_policies/methods/projects_locations_data_products_get_iam_policy insert: [] update: [] replace: - $ref: >- - #/components/x-stackQL-resources/glossaries_iam_policies/methods/projects_locations_glossaries_set_iam_policy + #/components/x-stackQL-resources/data_products_iam_policies/methods/projects_locations_data_products_set_iam_policy delete: [] - categories_iam_policies: - id: google.dataplex.categories_iam_policies - name: categories_iam_policies - title: Categories_iam_policies + data_assets_iam_policies: + id: google.dataplex.data_assets_iam_policies + name: data_assets_iam_policies + title: Data_assets_iam_policies methods: - projects_locations_glossaries_categories_set_iam_policy: + projects_locations_data_products_data_assets_set_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1glossaries~1{glossariesId}~1categories~1{categoriesId}:setIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataProducts~1{dataProductsId}~1dataAssets~1{dataAssetsId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_glossaries_categories_get_iam_policy: + projects_locations_data_products_data_assets_get_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1glossaries~1{glossariesId}~1categories~1{categoriesId}:getIamPolicy/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataProducts~1{dataProductsId}~1dataAssets~1{dataAssetsId}:getIamPolicy/get response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_glossaries_categories_test_iam_permissions: + projects_locations_data_products_data_assets_test_iam_permissions: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1glossaries~1{glossariesId}~1categories~1{categoriesId}:testIamPermissions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataProducts~1{dataProductsId}~1dataAssets~1{dataAssetsId}:testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/categories_iam_policies/methods/projects_locations_glossaries_categories_get_iam_policy + #/components/x-stackQL-resources/data_assets_iam_policies/methods/projects_locations_data_products_data_assets_get_iam_policy insert: [] update: [] replace: - $ref: >- - #/components/x-stackQL-resources/categories_iam_policies/methods/projects_locations_glossaries_categories_set_iam_policy + #/components/x-stackQL-resources/data_assets_iam_policies/methods/projects_locations_data_products_data_assets_set_iam_policy delete: [] - terms_iam_policies: - id: google.dataplex.terms_iam_policies - name: terms_iam_policies - title: Terms_iam_policies + encryption_configs: + id: google.dataplex.encryption_configs + name: encryption_configs + title: Encryption_configs methods: - projects_locations_glossaries_terms_set_iam_policy: + organizations_locations_encryption_configs_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1glossaries~1{glossariesId}~1terms~1{termsId}:setIamPolicy/post + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1encryptionConfigs/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_glossaries_terms_get_iam_policy: + organizations_locations_encryption_configs_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1glossaries~1{glossariesId}~1terms~1{termsId}:getIamPolicy/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1encryptionConfigs/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.bindings - projects_locations_glossaries_terms_test_iam_permissions: + objectKey: $.encryptionConfigs + organizations_locations_encryption_configs_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1glossaries~1{glossariesId}~1terms~1{termsId}:testIamPermissions/post + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1encryptionConfigs~1{encryptionConfigsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_encryption_configs_delete: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1encryptionConfigs~1{encryptionConfigsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_encryption_configs_get: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1encryptionConfigs~1{encryptionConfigsId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/terms_iam_policies/methods/projects_locations_glossaries_terms_get_iam_policy - insert: [] - update: [] - replace: + #/components/x-stackQL-resources/encryption_configs/methods/organizations_locations_encryption_configs_get - $ref: >- - #/components/x-stackQL-resources/terms_iam_policies/methods/projects_locations_glossaries_terms_set_iam_policy - delete: [] + #/components/x-stackQL-resources/encryption_configs/methods/organizations_locations_encryption_configs_list + insert: + - $ref: >- + #/components/x-stackQL-resources/encryption_configs/methods/organizations_locations_encryption_configs_create + update: + - $ref: >- + #/components/x-stackQL-resources/encryption_configs/methods/organizations_locations_encryption_configs_patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/encryption_configs/methods/organizations_locations_encryption_configs_delete encryption_configs_iam_policies: id: google.dataplex.encryption_configs_iam_policies name: encryption_configs_iam_policies @@ -8569,13 +9786,1069 @@ paths: - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/_.xgafv' get: + description: Looks up an entry by name using the permission on the source system. + operationId: dataplex.projects.locations.lookupEntry + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDataplexV1Entry' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: view + schema: + type: string + - in: query + name: aspectTypes + schema: + type: string + - in: query + name: paths + schema: + type: string + - in: query + name: entry + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}:searchEntries: + parameters: *ref_1 + post: + description: Searches for Entries matching the given query and scope. + operationId: dataplex.projects.locations.searchEntries + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDataplexV1SearchEntriesResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: query + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: orderBy + schema: + type: string + - in: query + name: scope + schema: + type: string + - in: query + name: semanticSearch + schema: + type: boolean + /v1/projects/{projectsId}/locations: + parameters: *ref_1 + get: + description: Lists information about the supported locations for this service. + operationId: dataplex.projects.locations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudLocationListLocationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: extraLocationTypes + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}: + parameters: *ref_1 + get: + description: Gets information about a location. + operationId: dataplex.projects.locations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudLocationLocation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns UNIMPLEMENTED. + operationId: dataplex.projects.locations.operations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: dataplex.projects.locations.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + delete: + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + google.rpc.Code.UNIMPLEMENTED. + operationId: dataplex.projects.locations.operations.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + 1, corresponding to Code.CANCELLED. + operationId: dataplex.projects.locations.operations.cancel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningCancelOperationRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/entryTypes: + parameters: *ref_1 + post: + description: Creates an EntryType. + operationId: dataplex.projects.locations.entryTypes.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDataplexV1EntryType' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: entryTypeId + schema: + type: string + - in: query + name: validateOnly + schema: + type: boolean + get: + description: Lists EntryType resources in a project and location. + operationId: dataplex.projects.locations.entryTypes.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDataplexV1ListEntryTypesResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/entryTypes/{entryTypesId}: + parameters: *ref_1 + patch: + description: Updates an EntryType. + operationId: dataplex.projects.locations.entryTypes.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDataplexV1EntryType' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: entryTypesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: validateOnly + schema: + type: boolean + delete: + description: Deletes an EntryType. + operationId: dataplex.projects.locations.entryTypes.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: entryTypesId + required: true + schema: + type: string + - in: query + name: etag + schema: + type: string + get: + description: Gets an EntryType. + operationId: dataplex.projects.locations.entryTypes.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDataplexV1EntryType' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: entryTypesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/entryTypes/{entryTypesId}:setIamPolicy: + parameters: *ref_1 + post: + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and + PERMISSION_DENIED errors. + operationId: dataplex.projects.locations.entryTypes.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: entryTypesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/entryTypes/{entryTypesId}:getIamPolicy: + parameters: *ref_1 + get: + description: >- + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: dataplex.projects.locations.entryTypes.getIamPolicy + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: entryTypesId + required: true + schema: + type: string + - in: query + name: options.requestedPolicyVersion + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/entryTypes/{entryTypesId}:testIamPermissions: + parameters: *ref_1 + post: + description: >- + Returns permissions that a caller has on the specified resource. If the + resource does not exist, this will return an empty set of permissions, + not a NOT_FOUND error.Note: This operation is designed to be used for + building permission-aware UIs and command-line tools, not for + authorization checking. This operation may "fail open" without warning. + operationId: dataplex.projects.locations.entryTypes.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: entryTypesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/aspectTypes: + parameters: *ref_1 + post: + description: Creates an AspectType. + operationId: dataplex.projects.locations.aspectTypes.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDataplexV1AspectType' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: aspectTypeId + schema: + type: string + - in: query + name: validateOnly + schema: + type: boolean + get: + description: Lists AspectType resources in a project and location. + operationId: dataplex.projects.locations.aspectTypes.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDataplexV1ListAspectTypesResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/aspectTypes/{aspectTypesId}: + parameters: *ref_1 + patch: + description: Updates an AspectType. + operationId: dataplex.projects.locations.aspectTypes.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDataplexV1AspectType' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: aspectTypesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: validateOnly + schema: + type: boolean + delete: + description: Deletes an AspectType. + operationId: dataplex.projects.locations.aspectTypes.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: aspectTypesId + required: true + schema: + type: string + - in: query + name: etag + schema: + type: string + get: + description: Gets an AspectType. + operationId: dataplex.projects.locations.aspectTypes.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDataplexV1AspectType' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: aspectTypesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/aspectTypes/{aspectTypesId}:setIamPolicy: + parameters: *ref_1 + post: description: >- - Looks up a single Entry by name using the permission on the source - system.Caution: The BigQuery metadata that is stored in Dataplex Catalog - is changing. For more information, see Changes to BigQuery metadata - stored in Dataplex Catalog - (https://cloud.google.com/dataplex/docs/biqquery-metadata-changes). - operationId: dataplex.projects.locations.lookupEntry + Sets the access control policy on the specified resource. Replaces any + existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and + PERMISSION_DENIED errors. + operationId: dataplex.projects.locations.aspectTypes.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: aspectTypesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/aspectTypes/{aspectTypesId}:getIamPolicy: + parameters: *ref_1 + get: + description: >- + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: dataplex.projects.locations.aspectTypes.getIamPolicy + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: aspectTypesId + required: true + schema: + type: string + - in: query + name: options.requestedPolicyVersion + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/aspectTypes/{aspectTypesId}:testIamPermissions: + parameters: *ref_1 + post: + description: >- + Returns permissions that a caller has on the specified resource. If the + resource does not exist, this will return an empty set of permissions, + not a NOT_FOUND error.Note: This operation is designed to be used for + building permission-aware UIs and command-line tools, not for + authorization checking. This operation may "fail open" without warning. + operationId: dataplex.projects.locations.aspectTypes.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: aspectTypesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/entryGroups: + parameters: *ref_1 + post: + description: Creates an EntryGroup. + operationId: dataplex.projects.locations.entryGroups.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDataplexV1EntryGroup' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: entryGroupId + schema: + type: string + - in: query + name: validateOnly + schema: + type: boolean + get: + description: Lists EntryGroup resources in a project and location. + operationId: dataplex.projects.locations.entryGroups.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDataplexV1ListEntryGroupsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}: + parameters: *ref_1 + patch: + description: Updates an EntryGroup. + operationId: dataplex.projects.locations.entryGroups.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDataplexV1EntryGroup' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8587,7 +10860,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDataplexV1Entry' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -8599,27 +10872,23 @@ paths: required: true schema: type: string - - in: query - name: view - schema: - type: string - - in: query - name: aspectTypes + - in: path + name: entryGroupsId + required: true schema: type: string - in: query - name: paths + name: updateMask schema: type: string + format: google-fieldmask - in: query - name: entry + name: validateOnly schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}:searchEntries: - parameters: *ref_1 - post: - description: Searches for Entries matching the given query and scope. - operationId: dataplex.projects.locations.searchEntries + type: boolean + delete: + description: Deletes an EntryGroup. + operationId: dataplex.projects.locations.entryGroups.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8631,8 +10900,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDataplexV1SearchEntriesResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -8644,32 +10912,18 @@ paths: required: true schema: type: string - - in: query - name: query - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: orderBy + - in: path + name: entryGroupsId + required: true schema: type: string - in: query - name: scope + name: etag schema: type: string - /v1/projects/{projectsId}/locations: - parameters: *ref_1 get: - description: Lists information about the supported locations for this service. - operationId: dataplex.projects.locations.list + description: Gets an EntryGroup. + operationId: dataplex.projects.locations.entryGroups.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8681,31 +10935,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudLocationListLocationsResponse' + $ref: '#/components/schemas/GoogleCloudDataplexV1EntryGroup' parameters: - in: path name: projectsId required: true schema: type: string - - in: query - name: filter + - in: path + name: locationsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: entryGroupsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}:setIamPolicy: parameters: *ref_1 - get: - description: Gets information about a location. - operationId: dataplex.projects.locations.get + post: + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and + PERMISSION_DENIED errors. + operationId: dataplex.projects.locations.entryGroups.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8717,7 +10976,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudLocationLocation' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -8729,13 +10988,18 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations: + - in: path + name: entryGroupsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}:getIamPolicy: parameters: *ref_1 get: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns UNIMPLEMENTED. - operationId: dataplex.projects.locations.operations.list + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: dataplex.projects.locations.entryGroups.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8747,7 +11011,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -8759,27 +11023,69 @@ paths: required: true schema: type: string - - in: query - name: filter + - in: path + name: entryGroupsId + required: true schema: type: string - in: query - name: pageSize + name: options.requestedPolicyVersion schema: type: integer format: int32 - - in: query - name: pageToken + /v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}:testIamPermissions: + parameters: *ref_1 + post: + description: >- + Returns permissions that a caller has on the specified resource. If the + resource does not exist, this will return an empty set of permissions, + not a NOT_FOUND error.Note: This operation is designed to be used for + building permission-aware UIs and command-line tools, not for + authorization checking. This operation may "fail open" without warning. + operationId: dataplex.projects.locations.entryGroups.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + parameters: + - in: path + name: projectsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: entryGroupsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries: parameters: *ref_1 - get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: dataplex.projects.locations.operations.get + post: + description: Creates an Entry. + operationId: dataplex.projects.locations.entryGroups.entries.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDataplexV1Entry' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8791,7 +11097,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudDataplexV1Entry' parameters: - in: path name: projectsId @@ -8804,17 +11110,17 @@ paths: schema: type: string - in: path - name: operationsId + name: entryGroupsId required: true schema: type: string - delete: - description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - google.rpc.Code.UNIMPLEMENTED. - operationId: dataplex.projects.locations.operations.delete + - in: query + name: entryId + schema: + type: string + get: + description: Lists Entries within an EntryGroup. + operationId: dataplex.projects.locations.entryGroups.entries.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8826,7 +11132,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/GoogleCloudDataplexV1ListEntriesResponse' parameters: - in: path name: projectsId @@ -8839,29 +11145,33 @@ paths: schema: type: string - in: path - name: operationsId + name: entryGroupsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}: parameters: *ref_1 - post: - description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to Code.CANCELLED. - operationId: dataplex.projects.locations.operations.cancel + patch: + description: Updates an Entry. + operationId: dataplex.projects.locations.entryGroups.entries.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningCancelOperationRequest' + $ref: '#/components/schemas/GoogleCloudDataplexV1Entry' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8873,7 +11183,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/GoogleCloudDataplexV1Entry' parameters: - in: path name: projectsId @@ -8881,25 +11191,40 @@ paths: schema: type: string - in: path - name: locationsId + name: locationsId + required: true + schema: + type: string + - in: path + name: entryGroupsId + required: true + schema: + type: string + - in: path + name: entriesId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/entryTypes: - parameters: *ref_1 - post: - description: Creates an EntryType. - operationId: dataplex.projects.locations.entryTypes.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDataplexV1EntryType' + format: google-fieldmask + - in: query + name: allowMissing + schema: + type: boolean + - in: query + name: deleteMissingAspects + schema: + type: boolean + - in: query + name: aspectKeys + schema: + type: string + delete: + description: Deletes an Entry. + operationId: dataplex.projects.locations.entryGroups.entries.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8911,7 +11236,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudDataplexV1Entry' parameters: - in: path name: projectsId @@ -8923,17 +11248,19 @@ paths: required: true schema: type: string - - in: query - name: entryTypeId + - in: path + name: entryGroupsId + required: true schema: type: string - - in: query - name: validateOnly + - in: path + name: entriesId + required: true schema: - type: boolean + type: string get: - description: Lists EntryType resources in a project and location. - operationId: dataplex.projects.locations.entryTypes.list + description: Gets an Entry. + operationId: dataplex.projects.locations.entryGroups.entries.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8945,8 +11272,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDataplexV1ListEntryTypesResponse + $ref: '#/components/schemas/GoogleCloudDataplexV1Entry' parameters: - in: path name: projectsId @@ -8958,33 +11284,38 @@ paths: required: true schema: type: string - - in: query - name: pageSize + - in: path + name: entryGroupsId + required: true schema: - type: integer - format: int32 + type: string + - in: path + name: entriesId + required: true + schema: + type: string - in: query - name: pageToken + name: view schema: type: string - in: query - name: filter + name: aspectTypes schema: type: string - in: query - name: orderBy + name: paths schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/entryTypes/{entryTypesId}: + /v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entryLinks: parameters: *ref_1 - patch: - description: Updates an EntryType. - operationId: dataplex.projects.locations.entryTypes.patch + post: + description: Creates an Entry Link. + operationId: dataplex.projects.locations.entryGroups.entryLinks.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDataplexV1EntryType' + $ref: '#/components/schemas/GoogleCloudDataplexV1EntryLink' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8996,7 +11327,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudDataplexV1EntryLink' parameters: - in: path name: projectsId @@ -9009,22 +11340,19 @@ paths: schema: type: string - in: path - name: entryTypesId + name: entryGroupsId required: true schema: type: string - in: query - name: updateMask + name: entryLinkId schema: type: string - format: google-fieldmask - - in: query - name: validateOnly - schema: - type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entryLinks/{entryLinksId}: + parameters: *ref_1 delete: - description: Deletes an EntryType. - operationId: dataplex.projects.locations.entryTypes.delete + description: Deletes an Entry Link. + operationId: dataplex.projects.locations.entryGroups.entryLinks.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9036,7 +11364,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudDataplexV1EntryLink' parameters: - in: path name: projectsId @@ -9049,17 +11377,18 @@ paths: schema: type: string - in: path - name: entryTypesId + name: entryGroupsId required: true schema: type: string - - in: query - name: etag + - in: path + name: entryLinksId + required: true schema: type: string get: - description: Gets an EntryType. - operationId: dataplex.projects.locations.entryTypes.get + description: Gets an Entry Link. + operationId: dataplex.projects.locations.entryGroups.entryLinks.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9071,7 +11400,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDataplexV1EntryType' + $ref: '#/components/schemas/GoogleCloudDataplexV1EntryLink' parameters: - in: path name: projectsId @@ -9084,23 +11413,27 @@ paths: schema: type: string - in: path - name: entryTypesId + name: entryGroupsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/entryTypes/{entryTypesId}:setIamPolicy: + - in: path + name: entryLinksId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataJobs: parameters: *ref_1 post: description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and - PERMISSION_DENIED errors. - operationId: dataplex.projects.locations.entryTypes.setIamPolicy + Creates a metadata job. For example, use a metadata job to import + metadata from a third-party system into Dataplex Universal Catalog. + operationId: dataplex.projects.locations.metadataJobs.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' + $ref: '#/components/schemas/GoogleCloudDataplexV1MetadataJob' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9112,7 +11445,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -9124,18 +11457,63 @@ paths: required: true schema: type: string + - in: query + name: metadataJobId + schema: + type: string + - in: query + name: validateOnly + schema: + type: boolean + get: + description: Lists metadata jobs. + operationId: dataplex.projects.locations.metadataJobs.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDataplexV1ListMetadataJobsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string - in: path - name: entryTypesId + name: locationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/entryTypes/{entryTypesId}:getIamPolicy: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataJobs/{metadataJobsId}: parameters: *ref_1 get: - description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: dataplex.projects.locations.entryTypes.getIamPolicy + description: Gets a metadata job. + operationId: dataplex.projects.locations.metadataJobs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9147,7 +11525,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleCloudDataplexV1MetadataJob' parameters: - in: path name: projectsId @@ -9160,30 +11538,26 @@ paths: schema: type: string - in: path - name: entryTypesId + name: metadataJobsId required: true schema: type: string - - in: query - name: options.requestedPolicyVersion - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/entryTypes/{entryTypesId}:testIamPermissions: + /v1/projects/{projectsId}/locations/{locationsId}/metadataJobs/{metadataJobsId}:cancel: parameters: *ref_1 post: description: >- - Returns permissions that a caller has on the specified resource. If the - resource does not exist, this will return an empty set of permissions, - not a NOT_FOUND error.Note: This operation is designed to be used for - building permission-aware UIs and command-line tools, not for - authorization checking. This operation may "fail open" without warning. - operationId: dataplex.projects.locations.entryTypes.testIamPermissions + Cancels a metadata job.If you cancel a metadata import job that is in + progress, the changes in the job might be partially applied. We + recommend that you reset the state of the entry groups in your project + by running another metadata job that reverts the changes from the + canceled job. + operationId: dataplex.projects.locations.metadataJobs.cancel requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsRequest' + $ref: >- + #/components/schemas/GoogleCloudDataplexV1CancelMetadataJobRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9195,7 +11569,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + $ref: '#/components/schemas/Empty' parameters: - in: path name: projectsId @@ -9208,20 +11582,20 @@ paths: schema: type: string - in: path - name: entryTypesId + name: metadataJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/aspectTypes: + /v1/projects/{projectsId}/locations/{locationsId}/glossaries: parameters: *ref_1 post: - description: Creates an AspectType. - operationId: dataplex.projects.locations.aspectTypes.create + description: Creates a new Glossary resource. + operationId: dataplex.projects.locations.glossaries.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDataplexV1AspectType' + $ref: '#/components/schemas/GoogleCloudDataplexV1Glossary' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9246,7 +11620,7 @@ paths: schema: type: string - in: query - name: aspectTypeId + name: glossaryId schema: type: string - in: query @@ -9254,8 +11628,8 @@ paths: schema: type: boolean get: - description: Lists AspectType resources in a project and location. - operationId: dataplex.projects.locations.aspectTypes.list + description: Lists Glossary resources in a project and location. + operationId: dataplex.projects.locations.glossaries.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9268,7 +11642,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDataplexV1ListAspectTypesResponse + #/components/schemas/GoogleCloudDataplexV1ListGlossariesResponse parameters: - in: path name: projectsId @@ -9297,16 +11671,16 @@ paths: name: orderBy schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/aspectTypes/{aspectTypesId}: + /v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}: parameters: *ref_1 patch: - description: Updates an AspectType. - operationId: dataplex.projects.locations.aspectTypes.patch + description: Updates a Glossary resource. + operationId: dataplex.projects.locations.glossaries.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDataplexV1AspectType' + $ref: '#/components/schemas/GoogleCloudDataplexV1Glossary' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9331,7 +11705,7 @@ paths: schema: type: string - in: path - name: aspectTypesId + name: glossariesId required: true schema: type: string @@ -9345,8 +11719,10 @@ paths: schema: type: boolean delete: - description: Deletes an AspectType. - operationId: dataplex.projects.locations.aspectTypes.delete + description: >- + Deletes a Glossary resource. All the categories and terms within the + Glossary must be deleted before the Glossary can be deleted. + operationId: dataplex.projects.locations.glossaries.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9371,7 +11747,7 @@ paths: schema: type: string - in: path - name: aspectTypesId + name: glossariesId required: true schema: type: string @@ -9380,8 +11756,8 @@ paths: schema: type: string get: - description: Gets an AspectType. - operationId: dataplex.projects.locations.aspectTypes.get + description: Gets a Glossary resource. + operationId: dataplex.projects.locations.glossaries.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9393,7 +11769,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDataplexV1AspectType' + $ref: '#/components/schemas/GoogleCloudDataplexV1Glossary' parameters: - in: path name: projectsId @@ -9406,18 +11782,18 @@ paths: schema: type: string - in: path - name: aspectTypesId + name: glossariesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/aspectTypes/{aspectTypesId}:setIamPolicy: + /v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}:setIamPolicy: parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. - operationId: dataplex.projects.locations.aspectTypes.setIamPolicy + operationId: dataplex.projects.locations.glossaries.setIamPolicy requestBody: content: application/json: @@ -9447,17 +11823,17 @@ paths: schema: type: string - in: path - name: aspectTypesId + name: glossariesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/aspectTypes/{aspectTypesId}:getIamPolicy: + /v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}:getIamPolicy: parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - operationId: dataplex.projects.locations.aspectTypes.getIamPolicy + operationId: dataplex.projects.locations.glossaries.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9482,7 +11858,7 @@ paths: schema: type: string - in: path - name: aspectTypesId + name: glossariesId required: true schema: type: string @@ -9491,7 +11867,7 @@ paths: schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/aspectTypes/{aspectTypesId}:testIamPermissions: + /v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}:testIamPermissions: parameters: *ref_1 post: description: >- @@ -9500,7 +11876,7 @@ paths: not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. - operationId: dataplex.projects.locations.aspectTypes.testIamPermissions + operationId: dataplex.projects.locations.glossaries.testIamPermissions requestBody: content: application/json: @@ -9530,20 +11906,20 @@ paths: schema: type: string - in: path - name: aspectTypesId + name: glossariesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/entryGroups: + /v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/categories: parameters: *ref_1 post: - description: Creates an EntryGroup. - operationId: dataplex.projects.locations.entryGroups.create + description: Creates a new GlossaryCategory resource. + operationId: dataplex.projects.locations.glossaries.categories.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDataplexV1EntryGroup' + $ref: '#/components/schemas/GoogleCloudDataplexV1GlossaryCategory' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9555,7 +11931,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudDataplexV1GlossaryCategory' parameters: - in: path name: projectsId @@ -9567,17 +11943,18 @@ paths: required: true schema: type: string + - in: path + name: glossariesId + required: true + schema: + type: string - in: query - name: entryGroupId + name: categoryId schema: type: string - - in: query - name: validateOnly - schema: - type: boolean get: - description: Lists EntryGroup resources in a project and location. - operationId: dataplex.projects.locations.entryGroups.list + description: Lists GlossaryCategory resources in a Glossary. + operationId: dataplex.projects.locations.glossaries.categories.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9590,7 +11967,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDataplexV1ListEntryGroupsResponse + #/components/schemas/GoogleCloudDataplexV1ListGlossaryCategoriesResponse parameters: - in: path name: projectsId @@ -9602,6 +11979,11 @@ paths: required: true schema: type: string + - in: path + name: glossariesId + required: true + schema: + type: string - in: query name: pageSize schema: @@ -9619,16 +12001,16 @@ paths: name: orderBy schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}: + /v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/categories/{categoriesId}: parameters: *ref_1 patch: - description: Updates an EntryGroup. - operationId: dataplex.projects.locations.entryGroups.patch + description: Updates a GlossaryCategory resource. + operationId: dataplex.projects.locations.glossaries.categories.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDataplexV1EntryGroup' + $ref: '#/components/schemas/GoogleCloudDataplexV1GlossaryCategory' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9640,7 +12022,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudDataplexV1GlossaryCategory' parameters: - in: path name: projectsId @@ -9653,7 +12035,12 @@ paths: schema: type: string - in: path - name: entryGroupsId + name: glossariesId + required: true + schema: + type: string + - in: path + name: categoriesId required: true schema: type: string @@ -9662,13 +12049,12 @@ paths: schema: type: string format: google-fieldmask - - in: query - name: validateOnly - schema: - type: boolean delete: - description: Deletes an EntryGroup. - operationId: dataplex.projects.locations.entryGroups.delete + description: >- + Deletes a GlossaryCategory resource. All the GlossaryCategories and + GlossaryTerms nested directly under the specified GlossaryCategory will + be moved one level up to the parent in the hierarchy. + operationId: dataplex.projects.locations.glossaries.categories.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9680,7 +12066,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/Empty' parameters: - in: path name: projectsId @@ -9693,17 +12079,18 @@ paths: schema: type: string - in: path - name: entryGroupsId + name: glossariesId required: true schema: type: string - - in: query - name: etag + - in: path + name: categoriesId + required: true schema: type: string get: - description: Gets an EntryGroup. - operationId: dataplex.projects.locations.entryGroups.get + description: Gets a GlossaryCategory resource. + operationId: dataplex.projects.locations.glossaries.categories.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9715,7 +12102,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDataplexV1EntryGroup' + $ref: '#/components/schemas/GoogleCloudDataplexV1GlossaryCategory' parameters: - in: path name: projectsId @@ -9728,18 +12115,23 @@ paths: schema: type: string - in: path - name: entryGroupsId + name: glossariesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}:setIamPolicy: + - in: path + name: categoriesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/categories/{categoriesId}:setIamPolicy: parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. - operationId: dataplex.projects.locations.entryGroups.setIamPolicy + operationId: dataplex.projects.locations.glossaries.categories.setIamPolicy requestBody: content: application/json: @@ -9769,17 +12161,22 @@ paths: schema: type: string - in: path - name: entryGroupsId + name: glossariesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}:getIamPolicy: + - in: path + name: categoriesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/categories/{categoriesId}:getIamPolicy: parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - operationId: dataplex.projects.locations.entryGroups.getIamPolicy + operationId: dataplex.projects.locations.glossaries.categories.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9804,7 +12201,12 @@ paths: schema: type: string - in: path - name: entryGroupsId + name: glossariesId + required: true + schema: + type: string + - in: path + name: categoriesId required: true schema: type: string @@ -9813,7 +12215,7 @@ paths: schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}:testIamPermissions: + /v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/categories/{categoriesId}:testIamPermissions: parameters: *ref_1 post: description: >- @@ -9822,7 +12224,7 @@ paths: not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. - operationId: dataplex.projects.locations.entryGroups.testIamPermissions + operationId: dataplex.projects.locations.glossaries.categories.testIamPermissions requestBody: content: application/json: @@ -9852,20 +12254,25 @@ paths: schema: type: string - in: path - name: entryGroupsId + name: glossariesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries: + - in: path + name: categoriesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/terms: parameters: *ref_1 post: - description: Creates an Entry. - operationId: dataplex.projects.locations.entryGroups.entries.create + description: Creates a new GlossaryTerm resource. + operationId: dataplex.projects.locations.glossaries.terms.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDataplexV1Entry' + $ref: '#/components/schemas/GoogleCloudDataplexV1GlossaryTerm' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9877,7 +12284,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDataplexV1Entry' + $ref: '#/components/schemas/GoogleCloudDataplexV1GlossaryTerm' parameters: - in: path name: projectsId @@ -9890,17 +12297,17 @@ paths: schema: type: string - in: path - name: entryGroupsId + name: glossariesId required: true schema: type: string - in: query - name: entryId + name: termId schema: type: string get: - description: Lists Entries within an EntryGroup. - operationId: dataplex.projects.locations.entryGroups.entries.list + description: Lists GlossaryTerm resources in a Glossary. + operationId: dataplex.projects.locations.glossaries.terms.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9912,7 +12319,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDataplexV1ListEntriesResponse' + $ref: >- + #/components/schemas/GoogleCloudDataplexV1ListGlossaryTermsResponse parameters: - in: path name: projectsId @@ -9925,7 +12333,7 @@ paths: schema: type: string - in: path - name: entryGroupsId + name: glossariesId required: true schema: type: string @@ -9942,16 +12350,20 @@ paths: name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}: + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/terms/{termsId}: parameters: *ref_1 patch: - description: Updates an Entry. - operationId: dataplex.projects.locations.entryGroups.entries.patch + description: Updates a GlossaryTerm resource. + operationId: dataplex.projects.locations.glossaries.terms.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDataplexV1Entry' + $ref: '#/components/schemas/GoogleCloudDataplexV1GlossaryTerm' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9963,7 +12375,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDataplexV1Entry' + $ref: '#/components/schemas/GoogleCloudDataplexV1GlossaryTerm' parameters: - in: path name: projectsId @@ -9976,12 +12388,12 @@ paths: schema: type: string - in: path - name: entryGroupsId + name: glossariesId required: true schema: type: string - in: path - name: entriesId + name: termsId required: true schema: type: string @@ -9990,21 +12402,9 @@ paths: schema: type: string format: google-fieldmask - - in: query - name: allowMissing - schema: - type: boolean - - in: query - name: deleteMissingAspects - schema: - type: boolean - - in: query - name: aspectKeys - schema: - type: string delete: - description: Deletes an Entry. - operationId: dataplex.projects.locations.entryGroups.entries.delete + description: Deletes a GlossaryTerm resource. + operationId: dataplex.projects.locations.glossaries.terms.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10016,7 +12416,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDataplexV1Entry' + $ref: '#/components/schemas/Empty' parameters: - in: path name: projectsId @@ -10029,22 +12429,18 @@ paths: schema: type: string - in: path - name: entryGroupsId + name: glossariesId required: true schema: type: string - in: path - name: entriesId + name: termsId required: true schema: type: string get: - description: >- - Gets an Entry.Caution: The BigQuery metadata that is stored in Dataplex - Catalog is changing. For more information, see Changes to BigQuery - metadata stored in Dataplex Catalog - (https://cloud.google.com/dataplex/docs/biqquery-metadata-changes). - operationId: dataplex.projects.locations.entryGroups.entries.get + description: Gets a GlossaryTerm resource. + operationId: dataplex.projects.locations.glossaries.terms.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10056,7 +12452,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDataplexV1Entry' + $ref: '#/components/schemas/GoogleCloudDataplexV1GlossaryTerm' parameters: - in: path name: projectsId @@ -10069,40 +12465,28 @@ paths: schema: type: string - in: path - name: entryGroupsId + name: glossariesId required: true schema: type: string - in: path - name: entriesId + name: termsId required: true schema: type: string - - in: query - name: view - schema: - type: string - - in: query - name: aspectTypes - schema: - type: string - - in: query - name: paths - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataJobs: + /v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/terms/{termsId}:setIamPolicy: parameters: *ref_1 post: description: >- - Creates a metadata job. For example, use a metadata job to import - Dataplex Catalog entries and aspects from a third-party system into - Dataplex. - operationId: dataplex.projects.locations.metadataJobs.create + Sets the access control policy on the specified resource. Replaces any + existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and + PERMISSION_DENIED errors. + operationId: dataplex.projects.locations.glossaries.terms.setIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDataplexV1MetadataJob' + $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10114,7 +12498,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -10126,59 +12510,23 @@ paths: required: true schema: type: string - - in: query - name: metadataJobId - schema: - type: string - get: - description: Lists metadata jobs. - operationId: dataplex.projects.locations.metadataJobs.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDataplexV1ListMetadataJobsResponse - parameters: - in: path - name: projectsId + name: glossariesId required: true schema: type: string - in: path - name: locationsId + name: termsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: orderBy - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataJobs/{metadataJobsId}: + /v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/terms/{termsId}:getIamPolicy: parameters: *ref_1 get: - description: Gets a metadata job. - operationId: dataplex.projects.locations.metadataJobs.get + description: >- + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: dataplex.projects.locations.glossaries.terms.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10190,7 +12538,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDataplexV1MetadataJob' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -10203,26 +12551,35 @@ paths: schema: type: string - in: path - name: metadataJobsId + name: glossariesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataJobs/{metadataJobsId}:cancel: + - in: path + name: termsId + required: true + schema: + type: string + - in: query + name: options.requestedPolicyVersion + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/terms/{termsId}:testIamPermissions: parameters: *ref_1 post: description: >- - Cancels a metadata job.If you cancel a metadata import job that is in - progress, the changes in the job might be partially applied. We - recommend that you reset the state of the entry groups in your project - by running another metadata job that reverts the changes from the - canceled job. - operationId: dataplex.projects.locations.metadataJobs.cancel + Returns permissions that a caller has on the specified resource. If the + resource does not exist, this will return an empty set of permissions, + not a NOT_FOUND error.Note: This operation is designed to be used for + building permission-aware UIs and command-line tools, not for + authorization checking. This operation may "fail open" without warning. + operationId: dataplex.projects.locations.glossaries.terms.testIamPermissions requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDataplexV1CancelMetadataJobRequest + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10234,7 +12591,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' parameters: - in: path name: projectsId @@ -10247,7 +12604,12 @@ paths: schema: type: string - in: path - name: metadataJobsId + name: glossariesId + required: true + schema: + type: string + - in: path + name: termsId required: true schema: type: string @@ -13865,7 +16227,11 @@ paths: name: dataScansId required: true schema: - type: string + type: string + - in: query + name: force + schema: + type: boolean get: description: Gets a DataScan resource. operationId: dataplex.projects.locations.dataScans.get @@ -15378,14 +17744,14 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}:setIamPolicy: + /v1/projects/{projectsId}/locations/{locationsId}/dataProducts/{dataProductsId}:setIamPolicy: parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. - operationId: dataplex.projects.locations.glossaries.setIamPolicy + operationId: dataplex.projects.locations.dataProducts.setIamPolicy requestBody: content: application/json: @@ -15415,17 +17781,17 @@ paths: schema: type: string - in: path - name: glossariesId + name: dataProductsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}:getIamPolicy: + /v1/projects/{projectsId}/locations/{locationsId}/dataProducts/{dataProductsId}:getIamPolicy: parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - operationId: dataplex.projects.locations.glossaries.getIamPolicy + operationId: dataplex.projects.locations.dataProducts.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15450,7 +17816,7 @@ paths: schema: type: string - in: path - name: glossariesId + name: dataProductsId required: true schema: type: string @@ -15459,7 +17825,7 @@ paths: schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}:testIamPermissions: + /v1/projects/{projectsId}/locations/{locationsId}/dataProducts/{dataProductsId}:testIamPermissions: parameters: *ref_1 post: description: >- @@ -15468,7 +17834,7 @@ paths: not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. - operationId: dataplex.projects.locations.glossaries.testIamPermissions + operationId: dataplex.projects.locations.dataProducts.testIamPermissions requestBody: content: application/json: @@ -15498,18 +17864,18 @@ paths: schema: type: string - in: path - name: glossariesId + name: dataProductsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/categories/{categoriesId}:setIamPolicy: + /v1/projects/{projectsId}/locations/{locationsId}/dataProducts/{dataProductsId}/dataAssets/{dataAssetsId}:setIamPolicy: parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. - operationId: dataplex.projects.locations.glossaries.categories.setIamPolicy + operationId: dataplex.projects.locations.dataProducts.dataAssets.setIamPolicy requestBody: content: application/json: @@ -15539,22 +17905,22 @@ paths: schema: type: string - in: path - name: glossariesId + name: dataProductsId required: true schema: type: string - in: path - name: categoriesId + name: dataAssetsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/categories/{categoriesId}:getIamPolicy: + /v1/projects/{projectsId}/locations/{locationsId}/dataProducts/{dataProductsId}/dataAssets/{dataAssetsId}:getIamPolicy: parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - operationId: dataplex.projects.locations.glossaries.categories.getIamPolicy + operationId: dataplex.projects.locations.dataProducts.dataAssets.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15579,12 +17945,12 @@ paths: schema: type: string - in: path - name: glossariesId + name: dataProductsId required: true schema: type: string - in: path - name: categoriesId + name: dataAssetsId required: true schema: type: string @@ -15593,7 +17959,7 @@ paths: schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/categories/{categoriesId}:testIamPermissions: + /v1/projects/{projectsId}/locations/{locationsId}/dataProducts/{dataProductsId}/dataAssets/{dataAssetsId}:testIamPermissions: parameters: *ref_1 post: description: >- @@ -15602,7 +17968,7 @@ paths: not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. - operationId: dataplex.projects.locations.glossaries.categories.testIamPermissions + operationId: dataplex.projects.locations.dataProducts.dataAssets.testIamPermissions requestBody: content: application/json: @@ -15632,28 +17998,22 @@ paths: schema: type: string - in: path - name: glossariesId + name: dataProductsId required: true schema: type: string - in: path - name: categoriesId + name: dataAssetsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/terms/{termsId}:setIamPolicy: + /v1/organizations/{organizationsId}/locations/{locationsId}/operations: parameters: *ref_1 - post: + get: description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and - PERMISSION_DENIED errors. - operationId: dataplex.projects.locations.glossaries.terms.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns UNIMPLEMENTED. + operationId: dataplex.organizations.locations.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15665,10 +18025,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -15677,23 +18037,62 @@ paths: required: true schema: type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: dataplex.organizations.locations.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string - in: path - name: glossariesId + name: locationsId required: true schema: type: string - in: path - name: termsId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/terms/{termsId}:getIamPolicy: - parameters: *ref_1 - get: + delete: description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: dataplex.projects.locations.glossaries.terms.getIamPolicy + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + google.rpc.Code.UNIMPLEMENTED. + operationId: dataplex.organizations.locations.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15705,10 +18104,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/Empty' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -15718,35 +18117,67 @@ paths: schema: type: string - in: path - name: glossariesId + name: operationsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + 1, corresponding to Code.CANCELLED. + operationId: dataplex.organizations.locations.operations.cancel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningCancelOperationRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: organizationsId required: true schema: type: string - in: path - name: termsId + name: locationsId required: true schema: type: string - - in: query - name: options.requestedPolicyVersion + - in: path + name: operationsId + required: true schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/terms/{termsId}:testIamPermissions: + type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/encryptionConfigs: parameters: *ref_1 post: - description: >- - Returns permissions that a caller has on the specified resource. If the - resource does not exist, this will return an empty set of permissions, - not a NOT_FOUND error.Note: This operation is designed to be used for - building permission-aware UIs and command-line tools, not for - authorization checking. This operation may "fail open" without warning. - operationId: dataplex.projects.locations.glossaries.terms.testIamPermissions + description: Create an EncryptionConfig. + operationId: dataplex.organizations.locations.encryptionConfigs.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsRequest' + $ref: '#/components/schemas/GoogleCloudDataplexV1EncryptionConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15758,10 +18189,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -15770,24 +18201,64 @@ paths: required: true schema: type: string + - in: query + name: encryptionConfigId + schema: + type: string + get: + description: List EncryptionConfigs. + operationId: dataplex.organizations.locations.encryptionConfigs.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDataplexV1ListEncryptionConfigsResponse + parameters: - in: path - name: glossariesId + name: organizationsId required: true schema: type: string - in: path - name: termsId + name: locationsId required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/encryptionConfigs/{encryptionConfigsId}: parameters: *ref_1 - get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: dataplex.organizations.locations.operations.get + patch: + description: Update an EncryptionConfig. + operationId: dataplex.organizations.locations.encryptionConfigs.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDataplexV1EncryptionConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15812,17 +18283,18 @@ paths: schema: type: string - in: path - name: operationsId + name: encryptionConfigsId required: true schema: type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask delete: - description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - google.rpc.Code.UNIMPLEMENTED. - operationId: dataplex.organizations.locations.operations.delete + description: Delete an EncryptionConfig. + operationId: dataplex.organizations.locations.encryptionConfigs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15834,7 +18306,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -15847,29 +18319,17 @@ paths: schema: type: string - in: path - name: operationsId + name: encryptionConfigsId required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_1 - post: - description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to Code.CANCELLED. - operationId: dataplex.organizations.locations.operations.cancel - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningCancelOperationRequest' + - in: query + name: etag + schema: + type: string + get: + description: Get an EncryptionConfig. + operationId: dataplex.organizations.locations.encryptionConfigs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15881,7 +18341,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/GoogleCloudDataplexV1EncryptionConfig' parameters: - in: path name: organizationsId @@ -15894,7 +18354,7 @@ paths: schema: type: string - in: path - name: operationsId + name: encryptionConfigsId required: true schema: type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/dataproc.yaml b/providers/src/googleapis.com/v00.00.00000/services/dataproc.yaml index b7680966..289ccb26 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/dataproc.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/dataproc.yaml @@ -7,8 +7,8 @@ info: title: Cloud Dataproc API description: Manages Hadoop-based clusters and jobs on Google Cloud Platform. version: v1 - x-discovery-doc-revision: '20241025' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250813' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/dataproc/ servers: @@ -157,6 +157,11 @@ components: underscores (_), and hyphens (-). The maximum length is 40 characters. type: string + requestorId: + description: >- + Optional. The requestor ID is used to identify if the request comes + from a GCA investigation or the old Ask Gemini Experience. + type: string AutoscalingPolicy: id: AutoscalingPolicy description: Describes an autoscaling policy for Dataproc cluster autoscaler. @@ -204,6 +209,21 @@ components: type: object additionalProperties: type: string + clusterType: + description: >- + Optional. The type of the clusters for which this autoscaling policy + is to be configured. + type: string + enumDescriptions: + - Not set. + - Standard dataproc cluster with a minimum of two primary workers. + - >- + Clusters that can use only secondary workers and be scaled down to + zero secondary worker nodes. + enum: + - CLUSTER_TYPE_UNSPECIFIED + - STANDARD + - ZERO_SCALE BasicAutoscalingAlgorithm: id: BasicAutoscalingAlgorithm description: Basic algorithm for autoscaling. @@ -691,6 +711,9 @@ components: description: Output only. Snapshot of current workload resource usage. readOnly: true $ref: '#/components/schemas/UsageSnapshot' + propertiesInfo: + description: Optional. Properties of the workload organized by origin. + $ref: '#/components/schemas/PropertiesInfo' UsageMetrics: id: UsageMetrics description: >- @@ -722,6 +745,14 @@ components: acceleratorType: description: Optional. Accelerator type being used, if any type: string + milliSlotSeconds: + description: Optional. Slot usage in (milliSlot x seconds). + type: string + format: int64 + updateTime: + description: Optional. The timestamp of the usage metrics. + type: string + format: google-datetime UsageSnapshot: id: UsageSnapshot description: >- @@ -771,6 +802,35 @@ components: description: Optional. The timestamp of the usage snapshot. type: string format: google-datetime + milliSlot: + description: Optional. Milli (one-thousandth) Slot usage of the workload. + type: string + format: int64 + PropertiesInfo: + id: PropertiesInfo + description: Properties of the workload organized by origin. + type: object + properties: + autotuningProperties: + description: Output only. Properties set by autotuning engine. + readOnly: true + type: object + additionalProperties: + $ref: '#/components/schemas/ValueInfo' + ValueInfo: + id: ValueInfo + description: Annotatated property value. + type: object + properties: + value: + description: Property value. + type: string + annotation: + description: Annotation, comment or explanation why the property was set. + type: string + overriddenValue: + description: Optional. Value which was replaced by the corresponding component. + type: string RuntimeConfig: id: RuntimeConfig description: Runtime configuration for a workload. @@ -834,11 +894,15 @@ components: - Scaling recommendations such as initialExecutors. - Adding hints for potential relation broadcasts. - Memory management for workloads. + - No autotuning. + - Automatic selection of scenarios. enum: - SCENARIO_UNSPECIFIED - SCALING - BROADCAST_HASH_JOIN - MEMORY + - NONE + - AUTO EnvironmentConfig: id: EnvironmentConfig description: Environment configuration for a workload. @@ -915,6 +979,42 @@ components: temporary buckets. This field requires a Cloud Storage bucket name, not a gs://... URI to a Cloud Storage bucket. type: string + authenticationConfig: + description: >- + Optional. Authentication configuration used to set the default + identity for the workload execution. The config specifies the type + of identity (service account or user) that will be used by workloads + to access resources on the project(s). + $ref: '#/components/schemas/AuthenticationConfig' + AuthenticationConfig: + id: AuthenticationConfig + description: >- + Authentication configuration for a workload is used to set the default + identity for the workload execution. The config specifies the type of + identity (service account or user) that will be used by workloads to + access resources on the project(s). + type: object + properties: + userWorkloadAuthenticationType: + description: >- + Optional. Authentication type for the user workload running in + containers. + type: string + enumDescriptions: + - >- + If AuthenticationType is unspecified then END_USER_CREDENTIALS is + used for 3.0 and newer runtimes, and SERVICE_ACCOUNT is used for + older runtimes. + - >- + Use service account credentials for authenticating to other + services. + - >- + Use OAuth credentials associated with the workload creator/user + for authenticating to other services. + enum: + - AUTHENTICATION_TYPE_UNSPECIFIED + - SERVICE_ACCOUNT + - END_USER_CREDENTIALS PeripheralsConfig: id: PeripheralsConfig description: Auxiliary services configuration for a workload. @@ -1063,6 +1163,12 @@ components: $ref: '#/components/schemas/StreamingQueryData' streamingQueryProgress: $ref: '#/components/schemas/StreamingQueryProgress' + nativeBuildInfoUiData: + description: Native Build Info + $ref: '#/components/schemas/NativeBuildInfoUiData' + nativeSqlExecutionUiData: + description: Native SQL Execution Info + $ref: '#/components/schemas/NativeSqlExecutionUiData' ApplicationInfo: id: ApplicationInfo description: High level information corresponding to an application. @@ -2740,6 +2846,68 @@ components: type: object additionalProperties: type: string + NativeBuildInfoUiData: + id: NativeBuildInfoUiData + type: object + properties: + buildInfo: + description: Optional. Build related details. + type: array + items: + $ref: '#/components/schemas/BuildInfo' + buildClass: + description: Optional. Build class of Native. + type: string + BuildInfo: + id: BuildInfo + description: Native Build Info + type: object + properties: + buildKey: + description: Optional. Build key. + type: string + buildValue: + description: Optional. Build value. + type: string + NativeSqlExecutionUiData: + id: NativeSqlExecutionUiData + description: Native SQL Execution Data + type: object + properties: + executionId: + description: Required. Execution ID of the Native SQL Execution. + type: string + format: int64 + description: + description: Optional. Description of the execution. + type: string + numNativeNodes: + description: Optional. Number of nodes in Native. + type: integer + format: int32 + numFallbackNodes: + description: Optional. Number of nodes fallen back to Spark. + type: integer + format: int32 + fallbackDescription: + description: Optional. Description of the fallback. + type: string + fallbackNodeToReason: + description: Optional. Fallback node to reason. + type: array + items: + $ref: '#/components/schemas/FallbackReason' + FallbackReason: + id: FallbackReason + description: Native SQL Execution Data + type: object + properties: + fallbackNode: + description: Optional. Fallback node information. + type: string + fallbackReason: + description: Optional. Fallback to Spark reason. + type: string WriteSparkApplicationContextResponse: id: WriteSparkApplicationContextResponse description: Response returned as an acknowledgement of receipt of data. @@ -3210,6 +3378,33 @@ components: description: The cluster config. type: object properties: + clusterType: + description: Optional. The type of the cluster. + type: string + enumDescriptions: + - Not set. + - Standard dataproc cluster with a minimum of two primary workers. + - >- + https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/single-node-clusters + - >- + Clusters that can use only secondary workers and be scaled down to + zero secondary worker nodes. + enum: + - CLUSTER_TYPE_UNSPECIFIED + - STANDARD + - SINGLE_NODE + - ZERO_SCALE + clusterTier: + description: Optional. The cluster tier. + type: string + enumDescriptions: + - Not set. Works the same as CLUSTER_TIER_STANDARD. + - Standard Dataproc cluster. + - Premium Dataproc cluster. + enum: + - CLUSTER_TIER_UNSPECIFIED + - CLUSTER_TIER_STANDARD + - CLUSTER_TIER_PREMIUM configBucket: description: >- Optional. A Cloud Storage bucket used to stage job dependencies, @@ -3445,6 +3640,15 @@ components: Confidential VMs (https://cloud.google.com/compute/confidential-vm/docs). $ref: '#/components/schemas/ConfidentialInstanceConfig' + resourceManagerTags: + description: >- + Optional. Resource manager tags + (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing) + to add to all instances (see Use secure tags in Dataproc + (https://cloud.google.com/dataproc/docs/guides/attach-secure-tags)). + type: object + additionalProperties: + type: string ReservationAffinity: id: ReservationAffinity description: Reservation Affinity for consuming Zonal reservation. @@ -3680,7 +3884,9 @@ components: type: string DiskConfig: id: DiskConfig - description: Specifies the config of disk options for a group of VM instances. + description: >- + Specifies the config of boot disk and attached disk options for a group + of VM instances. type: object properties: bootDiskType: @@ -3718,7 +3924,7 @@ components: description: >- Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can - handle. Note: This field is only supported if boot_disk_type is + handle. This field is supported only if boot_disk_type is hyperdisk-balanced. type: string format: int64 @@ -3726,8 +3932,8 @@ components: description: >- Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can - handle. Values must be greater than or equal to 1. Note: This field - is only supported if boot_disk_type is hyperdisk-balanced. + handle. Values must be greater than or equal to 1. This field is + supported only if boot_disk_type is hyperdisk-balanced. type: string format: int64 ManagedGroupConfig: @@ -3932,6 +4138,7 @@ components: (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-version-clusters#supported-dataproc-image-versions). It cannot be activated on clusters created with supported Dataproc on Compute Engine image versions. + - Delta Lake. - Docker - The Druid query engine. (alpha) - Flink @@ -3940,15 +4147,18 @@ components: - Hudi. - Iceberg. - The Jupyter Notebook. + - The Pig component. - The Presto query engine. - The Trino query engine. - The Ranger service. - The Solr service. - The Zeppelin notebook. - The Zookeeper service. + - The Jupyter Kernel Gateway. enum: - COMPONENT_UNSPECIFIED - ANACONDA + - DELTA - DOCKER - DRUID - FLINK @@ -3957,12 +4167,14 @@ components: - HUDI - ICEBERG - JUPYTER + - PIG - PRESTO - TRINO - RANGER - SOLR - ZEPPELIN - ZOOKEEPER + - JUPYTER_KERNEL_GATEWAY NodeInitializationAction: id: NodeInitializationAction description: >- @@ -4178,6 +4390,32 @@ components: (https://developers.google.com/protocol-buffers/docs/proto3#json)). type: string format: google-duration + idleStopTtl: + description: >- + Optional. The duration to keep the cluster started while idling + (when no jobs are running). Passing this threshold will cause the + cluster to be stopped. Minimum value is 5 minutes; maximum value is + 14 days (see JSON representation of Duration + (https://developers.google.com/protocol-buffers/docs/proto3#json)). + type: string + format: google-duration + autoStopTime: + description: >- + Optional. The time when cluster will be auto-stopped (see JSON + representation of Timestamp + (https://developers.google.com/protocol-buffers/docs/proto3#json)). + type: string + format: google-datetime + autoStopTtl: + description: >- + Optional. The lifetime duration of the cluster. The cluster will be + auto-stopped at the end of this period, calculated from the time of + submission of the create or update cluster request. Minimum value is + 10 minutes; maximum value is 14 days (see JSON representation of + Duration + (https://developers.google.com/protocol-buffers/docs/proto3#json)). + type: string + format: google-duration idleStartTime: description: >- Output only. The time when cluster became idle (most recent job @@ -4502,7 +4740,7 @@ components: For example, if one or more spark:executive metrics are listed as metric overrides, other SPARK metrics are not collected. The collection of the metrics for other enabled custom metric sources is - unaffected. For example, if both SPARK andd YARN metric sources are + unaffected. For example, if both SPARK and YARN metric sources are enabled, and overrides are provided for Spark metrics only, all YARN metrics are collected. type: array @@ -4676,6 +4914,10 @@ components: - The cluster is currently stopped. It is not ready for use. - The cluster is being started. It is not ready for use. - The cluster is being repaired. It is not ready for use. + - >- + Cluster creation is currently waiting for resources to be + available. Once all resources are available, it will transition to + CREATING and then RUNNING. enum: - UNKNOWN - CREATING @@ -4688,6 +4930,7 @@ components: - STOPPED - STARTING - REPAIRING + - SCHEDULED detail: description: Optional. Output only. Details of cluster's state. readOnly: true @@ -5903,7 +6146,7 @@ components: type: object properties: name: - description: Required. The resource name of the session. + description: Identifier. The resource name of the session. type: string uuid: description: >- @@ -6357,7 +6600,7 @@ components: type: object properties: name: - description: Required. The resource name of the session template. + description: Required. Identifier. The resource name of the session template. type: string description: description: Optional. Brief description of the template. @@ -7470,6 +7713,12 @@ components: - Update node group label operation type. - Start node group operation type. - Stop node group operation type. + - >- + This operation type is used to update the metadata config of a + node group. We update the metadata of the VMs in the node group + and await for intended config change to be completed at the node + group level. Currently, only the identity config update is + supported. enum: - NODE_GROUP_OPERATION_TYPE_UNSPECIFIED - CREATE @@ -7480,6 +7729,7 @@ components: - UPDATE_LABELS - START - STOP + - UPDATE_METADATA_CONFIG description: description: Output only. Short description of operation. readOnly: true @@ -13175,6 +13425,11 @@ paths: name: pageToken schema: type: string + - in: query + name: jobIds + schema: + type: string + format: int64 /v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:accessJob: parameters: *ref_1 get: @@ -13283,6 +13538,11 @@ paths: schema: type: string format: google-fieldmask + - in: query + name: stageIds + schema: + type: string + format: int64 /v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:searchStageAttempts: parameters: *ref_1 get: @@ -13661,6 +13921,10 @@ paths: name: pageToken schema: type: string + - in: query + name: operationIds + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:accessSqlQuery: parameters: *ref_1 get: @@ -13907,6 +14171,11 @@ paths: name: parent schema: type: string + - in: query + name: jobIds + schema: + type: string + format: int64 /v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:summarizeStages: parameters: *ref_1 get: @@ -13950,6 +14219,11 @@ paths: name: parent schema: type: string + - in: query + name: stageIds + schema: + type: string + format: int64 /v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:summarizeStageAttemptTasks: parameters: *ref_1 get: diff --git a/providers/src/googleapis.com/v00.00.00000/services/datastore.yaml b/providers/src/googleapis.com/v00.00.00000/services/datastore.yaml index ebb1bef4..1675f080 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/datastore.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/datastore.yaml @@ -9,8 +9,8 @@ info: Accesses the schemaless NoSQL database to provide fully managed, robust, scalable storage for your application. version: v1 - x-discovery-doc-revision: '20241018' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250824' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/datastore/ servers: @@ -1141,7 +1141,10 @@ components: type: object properties: batch: - description: A batch of query results (always present). + description: >- + A batch of query results. This is always present unless running a + query under explain-only mode: RunQueryRequest.explain_options was + provided and ExplainOptions.analyze was set to false. $ref: '#/components/schemas/QueryResultBatch' query: description: The parsed form of the `GqlQuery` from the request, if it was set. @@ -2330,7 +2333,7 @@ components: type: object properties: concurrencyMode: - description: Ths concurrency mode for this database. + description: The concurrency mode for this database. type: string enumDescriptions: - Unspecified. @@ -3071,7 +3074,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: datastore.projects.operations.cancel security: - Oauth2: diff --git a/providers/src/googleapis.com/v00.00.00000/services/datastream.yaml b/providers/src/googleapis.com/v00.00.00000/services/datastream.yaml index 142469cc..d80bf12c 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/datastream.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/datastream.yaml @@ -7,8 +7,8 @@ info: title: Datastream API description: '' version: v1 - x-discovery-doc-revision: '20241028' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250820' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/datastream/ servers: @@ -173,7 +173,7 @@ components: type: object properties: name: - description: Output only. The resource's name. + description: Output only. Identifier. The resource's name. readOnly: true type: string createTime: @@ -194,6 +194,14 @@ components: displayName: description: Required. Display name. type: string + satisfiesPzs: + description: Output only. Reserved for future use. + readOnly: true + type: boolean + satisfiesPzi: + description: Output only. Reserved for future use. + readOnly: true + type: boolean oracleProfile: description: Oracle ConnectionProfile configuration. $ref: '#/components/schemas/OracleProfile' @@ -212,6 +220,12 @@ components: sqlServerProfile: description: SQLServer Connection Profile configuration. $ref: '#/components/schemas/SqlServerProfile' + salesforceProfile: + description: Salesforce Connection Profile configuration. + $ref: '#/components/schemas/SalesforceProfile' + mongodbProfile: + description: MongoDB Connection Profile configuration. + $ref: '#/components/schemas/MongodbProfile' staticServiceIpConnectivity: description: Static Service IP connectivity. $ref: '#/components/schemas/StaticServiceIpConnectivity' @@ -223,7 +237,7 @@ components: $ref: '#/components/schemas/PrivateConnectivity' OracleProfile: id: OracleProfile - description: 'Oracle database profile. Next ID: 10.' + description: Oracle database profile. type: object properties: hostname: @@ -277,6 +291,14 @@ components: for this Connection-Profile. readOnly: true type: boolean + serverCertificateDistinguishedName: + description: >- + Optional. The distinguished name (DN) mentioned in the server + certificate. This corresponds to SSL_SERVER_CERT_DN sqlnet + parameter. Refer + https://docs.oracle.com/en/database/oracle/oracle-database/19/netrf/local-naming-parameters-in-tns-ora-file.html#GUID-70AB0695-A9AA-4A94-B141-4C605236EEB7 + If this field is not provided, the DN matching is not enforced. + type: string OracleAsmConfig: id: OracleAsmConfig description: Configuration for Oracle Automatic Storage Management (ASM) connection. @@ -293,7 +315,9 @@ components: description: Required. Username for the Oracle ASM connection. type: string password: - description: Required. Password for the Oracle ASM connection. + description: >- + Optional. Password for the Oracle ASM connection. Mutually exclusive + with the `secret_manager_stored_password` field. type: string asmService: description: Required. ASM service name for the Oracle ASM connection. @@ -306,6 +330,12 @@ components: oracleSslConfig: description: Optional. SSL configuration for the Oracle connection. $ref: '#/components/schemas/OracleSslConfig' + secretManagerStoredPassword: + description: >- + Optional. A reference to a Secret Manager resource name storing the + Oracle ASM connection password. Mutually exclusive with the + `password` field. + type: string GcsProfile: id: GcsProfile description: Cloud Storage bucket profile. @@ -319,7 +349,7 @@ components: type: string MysqlProfile: id: MysqlProfile - description: 'MySQL database profile. Next ID: 7.' + description: MySQL database profile. type: object properties: hostname: @@ -340,6 +370,12 @@ components: sslConfig: description: SSL configuration for the MySQL connection. $ref: '#/components/schemas/MysqlSslConfig' + secretManagerStoredPassword: + description: >- + Optional. A reference to a Secret Manager resource name storing the + MySQL connection password. Mutually exclusive with the `password` + field. + type: string MysqlSslConfig: id: MysqlSslConfig description: MySQL SSL configuration information. @@ -347,9 +383,9 @@ components: properties: clientKey: description: >- - Input only. PEM-encoded private key associated with the Client - Certificate. If this field is used then the 'client_certificate' and - the 'ca_certificate' fields are mandatory. + Optional. Input only. PEM-encoded private key associated with the + Client Certificate. If this field is used then the + 'client_certificate' and the 'ca_certificate' fields are mandatory. type: string clientKeySet: description: Output only. Indicates whether the client_key field is set. @@ -357,10 +393,10 @@ components: type: boolean clientCertificate: description: >- - Input only. PEM-encoded certificate that will be used by the replica - to authenticate against the source database server. If this field is - used then the 'client_key' and the 'ca_certificate' fields are - mandatory. + Optional. Input only. PEM-encoded certificate that will be used by + the replica to authenticate against the source database server. If + this field is used then the 'client_key' and the 'ca_certificate' + fields are mandatory. type: string clientCertificateSet: description: Output only. Indicates whether the client_certificate field is set. @@ -403,9 +439,88 @@ components: database: description: Required. Database for the PostgreSQL connection. type: string + secretManagerStoredPassword: + description: >- + Optional. A reference to a Secret Manager resource name storing the + PostgreSQL connection password. Mutually exclusive with the + `password` field. + type: string + sslConfig: + description: >- + Optional. SSL configuration for the PostgreSQL connection. In case + PostgresqlSslConfig is not set, the connection will use the default + SSL mode, which is `prefer` (i.e. this mode will only use encryption + if enabled from database side, otherwise will use unencrypted + communication) + $ref: '#/components/schemas/PostgresqlSslConfig' + PostgresqlSslConfig: + id: PostgresqlSslConfig + description: PostgreSQL SSL configuration information. + type: object + properties: + serverVerification: + description: ' If this field is set, the communication will be encrypted with TLS encryption and the server identity will be authenticated.' + $ref: '#/components/schemas/ServerVerification' + serverAndClientVerification: + description: >- + If this field is set, the communication will be encrypted with TLS + encryption and both the server identity and the client identity will + be authenticated. + $ref: '#/components/schemas/ServerAndClientVerification' + ServerVerification: + id: ServerVerification + description: >- + Message represents the option where Datastream will enforce the + encryption and authenticate the server identity. ca_certificate must be + set if user selects this option. + type: object + properties: + caCertificate: + description: Required. Input only. PEM-encoded server root CA certificate. + type: string + serverCertificateHostname: + description: >- + Optional. The hostname mentioned in the Subject or SAN extension of + the server certificate. If this field is not provided, the hostname + in the server certificate is not validated. + type: string + ServerAndClientVerification: + id: ServerAndClientVerification + description: >- + Message represents the option where Datastream will enforce the + encryption and authenticate the server identity as well as the client + identity. ca_certificate, client_certificate and client_key must be set + if user selects this option. + type: object + properties: + clientCertificate: + description: >- + Required. Input only. PEM-encoded certificate used by the source + database to authenticate the client identity (i.e., the Datastream's + identity). This certificate is signed by either a root certificate + trusted by the server or one or more intermediate certificates + (which is stored with the leaf certificate) to link the this + certificate to the trusted root certificate. + type: string + clientKey: + description: >- + Optional. Input only. PEM-encoded private key associated with the + client certificate. This value will be used during the SSL/TLS + handshake, allowing the PostgreSQL server to authenticate the + client's identity, i.e. identity of the Datastream. + type: string + caCertificate: + description: Required. Input only. PEM-encoded server root CA certificate. + type: string + serverCertificateHostname: + description: >- + Optional. The hostname mentioned in the Subject or SAN extension of + the server certificate. If this field is not provided, the hostname + in the server certificate is not validated. + type: string SqlServerProfile: id: SqlServerProfile - description: 'SQLServer database profile. Next ID: 8.' + description: SQLServer database profile. type: object properties: hostname: @@ -426,6 +541,256 @@ components: database: description: Required. Database for the SQLServer connection. type: string + sslConfig: + description: Optional. SSL configuration for the SQLServer connection. + $ref: '#/components/schemas/SqlServerSslConfig' + secretManagerStoredPassword: + description: >- + Optional. A reference to a Secret Manager resource name storing the + SQLServer connection password. Mutually exclusive with the + `password` field. + type: string + SqlServerSslConfig: + id: SqlServerSslConfig + description: SQL Server SSL configuration information. + type: object + properties: + encryptionNotEnforced: + description: >- + If set, Datastream will not enforce encryption. If the DB server + mandates encryption, then connection will be encrypted but server + identity will not be authenticated. + $ref: '#/components/schemas/EncryptionNotEnforced' + basicEncryption: + description: >- + If set, Datastream will enforce encryption without authenticating + server identity. Server certificates will be trusted by default. + $ref: '#/components/schemas/BasicEncryption' + encryptionAndServerValidation: + description: >- + If set, Datastream will enforce encryption and authenticate server + identity. + $ref: '#/components/schemas/EncryptionAndServerValidation' + EncryptionNotEnforced: + id: EncryptionNotEnforced + description: >- + Message to represent the option where encryption is not enforced. An + empty message right now to allow future extensibility. + type: object + properties: {} + BasicEncryption: + id: BasicEncryption + description: >- + Message to represent the option where Datastream will enforce encryption + without authenticating server identity. Server certificates will be + trusted by default. + type: object + properties: {} + EncryptionAndServerValidation: + id: EncryptionAndServerValidation + description: >- + Message to represent the option where Datastream will enforce encryption + and authenticate server identity. ca_certificate must be set if user + selects this option. + type: object + properties: + caCertificate: + description: >- + Optional. Input only. PEM-encoded certificate of the CA that signed + the source database server's certificate. + type: string + serverCertificateHostname: + description: >- + Optional. The hostname mentioned in the Subject or SAN extension of + the server certificate. This field is used for bypassing the + hostname validation while verifying server certificate. This is + required for scenarios where the host name that datastream connects + to is different from the certificate's subject. This specifically + happens for private connectivity. It could also happen when the + customer provides a public IP in connection profile but the same is + not present in the server certificate. + type: string + SalesforceProfile: + id: SalesforceProfile + description: Salesforce profile + type: object + properties: + domain: + description: Required. Domain endpoint for the Salesforce connection. + type: string + userCredentials: + description: User-password authentication. + $ref: '#/components/schemas/UserCredentials' + oauth2ClientCredentials: + description: Connected app authentication. + $ref: '#/components/schemas/Oauth2ClientCredentials' + UserCredentials: + id: UserCredentials + description: Username-password credentials. + type: object + properties: + username: + description: Required. Username for the Salesforce connection. + type: string + password: + description: >- + Optional. Password for the Salesforce connection. Mutually exclusive + with the `secret_manager_stored_password` field. + type: string + securityToken: + description: >- + Optional. Security token for the Salesforce connection. Mutually + exclusive with the `secret_manager_stored_security_token` field. + type: string + secretManagerStoredPassword: + description: >- + Optional. A reference to a Secret Manager resource name storing the + Salesforce connection's password. Mutually exclusive with the + `password` field. + type: string + secretManagerStoredSecurityToken: + description: >- + Optional. A reference to a Secret Manager resource name storing the + Salesforce connection's security token. Mutually exclusive with the + `security_token` field. + type: string + Oauth2ClientCredentials: + id: Oauth2ClientCredentials + description: OAuth2 Client Credentials. + type: object + properties: + clientId: + description: Required. Client ID for Salesforce OAuth2 Client Credentials. + type: string + clientSecret: + description: >- + Optional. Client secret for Salesforce OAuth2 Client Credentials. + Mutually exclusive with the `secret_manager_stored_client_secret` + field. + type: string + secretManagerStoredClientSecret: + description: >- + Optional. A reference to a Secret Manager resource name storing the + Salesforce OAuth2 client_secret. Mutually exclusive with the + `client_secret` field. + type: string + MongodbProfile: + id: MongodbProfile + description: MongoDB profile. + type: object + properties: + hostAddresses: + description: >- + Required. List of host addresses for a MongoDB cluster. For SRV + connection format, this list must contain exactly one DNS host + without a port. For Standard connection format, this list must + contain all the required hosts in the cluster with their respective + ports. + type: array + items: + $ref: '#/components/schemas/HostAddress' + replicaSet: + description: >- + Optional. Name of the replica set. Only needed for self hosted + replica set type MongoDB cluster. For SRV connection format, this + field must be empty. For Standard connection format, this field must + be specified. + type: string + username: + description: Required. Username for the MongoDB connection. + type: string + password: + description: >- + Optional. Password for the MongoDB connection. Mutually exclusive + with the `secret_manager_stored_password` field. + type: string + secretManagerStoredPassword: + description: >- + Optional. A reference to a Secret Manager resource name storing the + SQLServer connection password. Mutually exclusive with the + `password` field. + type: string + sslConfig: + description: Optional. SSL configuration for the MongoDB connection. + $ref: '#/components/schemas/MongodbSslConfig' + srvConnectionFormat: + description: Srv connection format. + $ref: '#/components/schemas/SrvConnectionFormat' + standardConnectionFormat: + description: Standard connection format. + $ref: '#/components/schemas/StandardConnectionFormat' + HostAddress: + id: HostAddress + description: >- + A HostAddress represents a transport end point, which is the combination + of an IP address or hostname and a port number. + type: object + properties: + hostname: + description: Required. Hostname for the connection. + type: string + port: + description: Optional. Port for the connection. + type: integer + format: int32 + MongodbSslConfig: + id: MongodbSslConfig + description: MongoDB SSL configuration information. + type: object + properties: + clientKey: + description: >- + Optional. Input only. PEM-encoded private key associated with the + Client Certificate. If this field is used then the + 'client_certificate' and the 'ca_certificate' fields are mandatory. + type: string + clientKeySet: + description: Output only. Indicates whether the client_key field is set. + readOnly: true + type: boolean + clientCertificate: + description: >- + Optional. Input only. PEM-encoded certificate that will be used by + the replica to authenticate against the source database server. If + this field is used then the 'client_key' and the 'ca_certificate' + fields are mandatory. + type: string + clientCertificateSet: + description: Output only. Indicates whether the client_certificate field is set. + readOnly: true + type: boolean + caCertificate: + description: >- + Optional. Input only. PEM-encoded certificate of the CA that signed + the source database server's certificate. + type: string + caCertificateSet: + description: Output only. Indicates whether the ca_certificate field is set. + readOnly: true + type: boolean + secretManagerStoredClientKey: + description: >- + Optional. Input only. A reference to a Secret Manager resource name + storing the PEM-encoded private key associated with the Client + Certificate. If this field is used then the 'client_certificate' and + the 'ca_certificate' fields are mandatory. Mutually exclusive with + the `client_key` field. + type: string + SrvConnectionFormat: + id: SrvConnectionFormat + description: Srv connection format. + type: object + properties: {} + StandardConnectionFormat: + id: StandardConnectionFormat + description: Standard connection format. + type: object + properties: + directConnection: + description: >- + Optional. Specifies whether the client connects directly to the + host[:port] in the connection URI. + type: boolean StaticServiceIpConnectivity: id: StaticServiceIpConnectivity description: >- @@ -499,6 +864,14 @@ components: sqlServerRdbms: description: SQLServer RDBMS to enrich with child data objects and metadata. $ref: '#/components/schemas/SqlServerRdbms' + salesforceOrg: + description: >- + Salesforce organization to enrich with child data objects and + metadata. + $ref: '#/components/schemas/SalesforceOrg' + mongodbCluster: + description: MongoDB cluster to enrich with child data objects and metadata. + $ref: '#/components/schemas/MongodbCluster' OracleRdbms: id: OracleRdbms description: Oracle database structure. @@ -791,6 +1164,90 @@ components: description: The ordinal position of the column in the table. type: integer format: int32 + SalesforceOrg: + id: SalesforceOrg + description: Salesforce organization structure. + type: object + properties: + objects: + description: Salesforce objects in the database server. + type: array + items: + $ref: '#/components/schemas/SalesforceObject' + SalesforceObject: + id: SalesforceObject + description: Salesforce object. + type: object + properties: + objectName: + description: Object name. + type: string + fields: + description: >- + Salesforce fields. When unspecified as part of include objects, + includes everything, when unspecified as part of exclude objects, + excludes nothing. + type: array + items: + $ref: '#/components/schemas/SalesforceField' + SalesforceField: + id: SalesforceField + description: Salesforce field. + type: object + properties: + name: + description: Field name. + type: string + dataType: + description: The data type. + type: string + nillable: + description: Indicates whether the field can accept nil values. + type: boolean + MongodbCluster: + id: MongodbCluster + description: MongoDB Cluster structure. + type: object + properties: + databases: + description: MongoDB databases in the cluster. + type: array + items: + $ref: '#/components/schemas/MongodbDatabase' + MongodbDatabase: + id: MongodbDatabase + description: MongoDB Database. + type: object + properties: + database: + description: Database name. + type: string + collections: + description: Collections in the database. + type: array + items: + $ref: '#/components/schemas/MongodbCollection' + MongodbCollection: + id: MongodbCollection + description: MongoDB Collection. + type: object + properties: + collection: + description: Collection name. + type: string + fields: + description: Fields in the collection. + type: array + items: + $ref: '#/components/schemas/MongodbField' + MongodbField: + id: MongodbField + description: MongoDB Field. + type: object + properties: + field: + description: Field name. + type: string DiscoverConnectionProfileResponse: id: DiscoverConnectionProfileResponse description: Response from a discover request. @@ -808,6 +1265,12 @@ components: sqlServerRdbms: description: Enriched SQLServer RDBMS object. $ref: '#/components/schemas/SqlServerRdbms' + salesforceOrg: + description: Enriched Salesforce organization. + $ref: '#/components/schemas/SalesforceOrg' + mongodbCluster: + description: Enriched MongoDB cluster. + $ref: '#/components/schemas/MongodbCluster' ListStreamsResponse: id: ListStreamsResponse description: Response message for listing streams. @@ -834,7 +1297,7 @@ components: type: object properties: name: - description: Output only. The stream's name. + description: Output only. Identifier. The stream's name. readOnly: true type: string createTime: @@ -920,6 +1383,14 @@ components: readOnly: true type: string format: google-datetime + satisfiesPzs: + description: Output only. Reserved for future use. + readOnly: true + type: boolean + satisfiesPzi: + description: Output only. Reserved for future use. + readOnly: true + type: boolean SourceConfig: id: SourceConfig description: The configuration of the stream source. @@ -927,7 +1398,7 @@ components: properties: sourceConnectionProfile: description: >- - Required. Source connection profile resoource. Format: + Required. Source connection profile resource. Format: `projects/{project}/locations/{location}/connectionProfiles/{name}` type: string oracleSourceConfig: @@ -942,6 +1413,12 @@ components: sqlServerSourceConfig: description: SQLServer data source configuration. $ref: '#/components/schemas/SqlServerSourceConfig' + salesforceSourceConfig: + description: Salesforce data source configuration. + $ref: '#/components/schemas/SalesforceSourceConfig' + mongodbSourceConfig: + description: MongoDB data source configuration. + $ref: '#/components/schemas/MongodbSourceConfig' OracleSourceConfig: id: OracleSourceConfig description: Oracle data source configuration @@ -1125,6 +1602,42 @@ components: description: Configuration to use Change Tables CDC read method. type: object properties: {} + SalesforceSourceConfig: + id: SalesforceSourceConfig + description: Salesforce source configuration + type: object + properties: + includeObjects: + description: Salesforce objects to retrieve from the source. + $ref: '#/components/schemas/SalesforceOrg' + excludeObjects: + description: Salesforce objects to exclude from the stream. + $ref: '#/components/schemas/SalesforceOrg' + pollingInterval: + description: >- + Required. Salesforce objects polling interval. The interval at which + new changes will be polled for each object. The duration must be + between 5 minutes and 24 hours. + type: string + format: google-duration + MongodbSourceConfig: + id: MongodbSourceConfig + description: MongoDB source configuration. + type: object + properties: + includeObjects: + description: MongoDB collections to include in the stream. + $ref: '#/components/schemas/MongodbCluster' + excludeObjects: + description: MongoDB collections to exclude from the stream. + $ref: '#/components/schemas/MongodbCluster' + maxConcurrentBackfillTasks: + description: >- + Optional. Maximum number of concurrent backfill tasks. The number + should be non-negative and less than or equal to 50. If not set (or + set to 0), the system's default value is used + type: integer + format: int32 DestinationConfig: id: DestinationConfig description: The configuration of the stream destination. @@ -1218,6 +1731,9 @@ components: but may result in higher cost. type: string format: google-duration + blmtConfig: + description: Optional. Big Lake Managed Tables (BLMT) configuration. + $ref: '#/components/schemas/BlmtConfig' merge: description: The standard mode $ref: '#/components/schemas/Merge' @@ -1244,6 +1760,11 @@ components: datasetTemplate: description: The dataset template to use for dynamic dataset creation. $ref: '#/components/schemas/DatasetTemplate' + projectId: + description: >- + Optional. The project id of the BigQuery dataset. If not specified, + the project will be inferred from the stream resource. + type: string DatasetTemplate: id: DatasetTemplate description: Dataset template used for dynamic dataset creation. @@ -1271,6 +1792,40 @@ components: https://cloud.google.com/bigquery/docs/customer-managed-encryption for more information. type: string + BlmtConfig: + id: BlmtConfig + description: The configuration for BLMT. + type: object + properties: + bucket: + description: Required. The Cloud Storage bucket name. + type: string + rootPath: + description: The root path inside the Cloud Storage bucket. + type: string + connectionName: + description: >- + Required. The bigquery connection. Format: + `{project}.{location}.{name}` + type: string + fileFormat: + description: Required. The file format. + type: string + enumDescriptions: + - Default value. + - Parquet file format. + enum: + - FILE_FORMAT_UNSPECIFIED + - PARQUET + tableFormat: + description: Required. The table format. + type: string + enumDescriptions: + - Default value. + - Iceberg table format. + enum: + - TABLE_FORMAT_UNSPECIFIED + - ICEBERG Merge: id: Merge description: >- @@ -1304,6 +1859,12 @@ components: sqlServerExcludedObjects: description: SQLServer data source objects to avoid backfilling $ref: '#/components/schemas/SqlServerRdbms' + salesforceExcludedObjects: + description: Salesforce data source objects to avoid backfilling + $ref: '#/components/schemas/SalesforceOrg' + mongodbExcludedObjects: + description: MongoDB data source objects to avoid backfilling + $ref: '#/components/schemas/MongodbCluster' BackfillNoneStrategy: id: BackfillNoneStrategy description: >- @@ -1394,6 +1955,12 @@ components: oracleScnPosition: description: Oracle SCN to start replicating from. $ref: '#/components/schemas/OracleScnPosition' + sqlServerLsnPosition: + description: SqlServer LSN to start replicating from. + $ref: '#/components/schemas/SqlServerLsnPosition' + mysqlGtidPosition: + description: MySQL GTID set to start replicating from. + $ref: '#/components/schemas/MysqlGtidPosition' MysqlLogPosition: id: MysqlLogPosition description: MySQL log position @@ -1417,13 +1984,29 @@ components: description: Required. SCN number from where Logs will be read type: string format: int64 + SqlServerLsnPosition: + id: SqlServerLsnPosition + description: SQL Server LSN position + type: object + properties: + lsn: + description: Required. Log sequence number (LSN) from where Logs will be read + type: string + MysqlGtidPosition: + id: MysqlGtidPosition + description: MySQL GTID position + type: object + properties: + gtidSet: + description: Required. The gtid set to start replication from. + type: string StreamObject: id: StreamObject description: A specific stream object (e.g a specific DB table). type: object properties: name: - description: Output only. The object resource's name. + description: Output only. Identifier. The object resource's name. readOnly: true type: string createTime: @@ -1531,6 +2114,12 @@ components: sqlServerIdentifier: description: SQLServer data source object identifier. $ref: '#/components/schemas/SqlServerObjectIdentifier' + salesforceIdentifier: + description: Salesforce data source object identifier. + $ref: '#/components/schemas/SalesforceObjectIdentifier' + mongodbIdentifier: + description: MongoDB data source object identifier. + $ref: '#/components/schemas/MongodbObjectIdentifier' OracleObjectIdentifier: id: OracleObjectIdentifier description: Oracle data source object identifier. @@ -1575,6 +2164,25 @@ components: table: description: Required. The table name. type: string + SalesforceObjectIdentifier: + id: SalesforceObjectIdentifier + description: Salesforce data source object identifier. + type: object + properties: + objectName: + description: Required. The object name. + type: string + MongodbObjectIdentifier: + id: MongodbObjectIdentifier + description: MongoDB data source object identifier. + type: object + properties: + database: + description: Required. The database name. + type: string + collection: + description: Required. The collection name. + type: string LookupStreamObjectRequest: id: LookupStreamObjectRequest description: >- @@ -1657,7 +2265,7 @@ components: type: object properties: name: - description: Output only. The resource's name. + description: Output only. Identifier. The resource's name. readOnly: true type: string createTime: @@ -1702,9 +2310,20 @@ components: user-friendly format. readOnly: true $ref: '#/components/schemas/Error' + satisfiesPzs: + description: Output only. Reserved for future use. + readOnly: true + type: boolean + satisfiesPzi: + description: Output only. Reserved for future use. + readOnly: true + type: boolean vpcPeeringConfig: description: VPC Peering Config. $ref: '#/components/schemas/VpcPeeringConfig' + pscInterfaceConfig: + description: PSC Interface Config. + $ref: '#/components/schemas/PscInterfaceConfig' VpcPeeringConfig: id: VpcPeeringConfig description: >- @@ -1720,6 +2339,19 @@ components: subnet: description: Required. A free subnet for peering. (CIDR of /29) type: string + PscInterfaceConfig: + id: PscInterfaceConfig + description: >- + The PSC Interface configuration is used to create PSC Interface between + Datastream and the consumer's PSC. + type: object + properties: + networkAttachment: + description: >- + Required. Fully qualified name of the Network Attachment that + Datastream will connect to. Format: + `projects/{project}/regions/{region}/networkAttachments/{name}` + type: string ListPrivateConnectionsResponse: id: ListPrivateConnectionsResponse description: Response containing a list of private connection configurations. @@ -1748,7 +2380,7 @@ components: type: object properties: name: - description: Output only. The resource's name. + description: Output only. Identifier. The resource's name. readOnly: true type: string createTime: @@ -1878,8 +2510,8 @@ components: description: >- Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled - have Operation.error value with a google.rpc.Status.code of 1, - corresponding to `Code.CANCELLED`. + have google.longrunning.Operation.error value with a + google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. readOnly: true type: boolean apiVersion: @@ -2477,6 +3109,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: @@ -2631,7 +3267,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: datastream.projects.locations.operations.cancel requestBody: content: @@ -3424,6 +4060,10 @@ paths: name: force schema: type: boolean + - in: query + name: validateOnly + schema: + type: boolean get: description: >- Use this method to list private connectivity configurations in a project diff --git a/providers/src/googleapis.com/v00.00.00000/services/deploymentmanager.yaml b/providers/src/googleapis.com/v00.00.00000/services/deploymentmanager.yaml index 131fe8e1..1c7b6324 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/deploymentmanager.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/deploymentmanager.yaml @@ -10,8 +10,8 @@ info: configuring, deploying, and viewing Google Cloud services and APIs via templates which specify deployments of Cloud resources. version: v2 - x-discovery-doc-revision: '20241031' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250822' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/deployment-manager servers: @@ -386,6 +386,7 @@ components: Indicates that a VM is using global DNS. Can also be used to indicate that a resource has attributes that could result in the creation of a VM that uses global DNS. + - Resource can't be retrieved due to api quota exceeded. - >- Reserved entries for quickly adding new warnings without breaking dependent clients. @@ -433,6 +434,7 @@ components: - false - false - false + - false enum: - DEPRECATED_RESOURCE_USED - NO_RESULTS_ON_PAGE @@ -468,11 +470,12 @@ components: - LIST_OVERHEAD_QUOTA_EXCEED - QUOTA_INFO_UNAVAILABLE - RESOURCE_USES_GLOBAL_DNS - - RESERVED_ENTRY_134 + - RATE_LIMIT_EXCEEDED - RESERVED_ENTRY_135 - RESERVED_ENTRY_136 - RESERVED_ENTRY_139 - RESERVED_ENTRY_141 + - RESERVED_ENTRY_142 message: description: >- [Output Only] A human-readable description of the warning @@ -547,6 +550,11 @@ components: $ref: '#/components/schemas/SetCommonInstanceMetadataOperationMetadata' instancesBulkInsertOperationMetadata: $ref: '#/components/schemas/InstancesBulkInsertOperationMetadata' + setAutoscalerLinkOperationMetadata: + description: >- + This field is used internally by the Autoscaler team and should not + be promoted to "alpha/beta/v1". + $ref: '#/components/schemas/SetAutoscalerLinkOperationMetadata' DebugInfo: id: DebugInfo description: Describes additional debugging info. @@ -592,16 +600,16 @@ components: a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". type: string - metadata: + metadatas: description: >- - Additional structured details about this error. Keys must match - /a-z+/ but should ideally be lowerCamelCase. Also they must be - limited to 64 characters in length. When identifying the current - value of an exceeded limit, the units should be contained in the - key, not the value. For example, rather than {"instanceLimit": - "100/request"}, should be returned as, {"instanceLimitPerRequest": - "100"}, if the client exceeds the number of instances that can be - created in a single (batch) request. + Additional structured details about this error. Keys must match a + regular expression of `a-z+` but should ideally be lowerCamelCase. + Also, they must be limited to 64 characters in length. When + identifying the current value of an exceeded limit, the units should + be contained in the key, not the value. For example, rather than + `{"instanceLimit": "100/request"}`, should be returned as, + `{"instanceLimitPerRequest": "100"}`, if the client exceeds the + number of instances that can be created in a single (batch) request. type: object additionalProperties: type: string @@ -781,6 +789,11 @@ components: type: object additionalProperties: $ref: '#/components/schemas/BulkInsertOperationStatus' + machineType: + description: >- + [Output Only] The machine type of the VMs that were created used + internally only by KCP flex bulk insert. + type: string BulkInsertOperationStatus: id: BulkInsertOperationStatus type: object @@ -818,6 +831,22 @@ components: description: '[Output Only] Count of VMs that got deleted during rollback.' type: integer format: int32 + SetAutoscalerLinkOperationMetadata: + id: SetAutoscalerLinkOperationMetadata + type: object + properties: + zonalIgmIds: + description: List of zonal IGM IDs part of the RMIG. + type: array + items: + type: string + format: int64 + zoneToIgmIds: + description: Map of zone to an ID of the zonal IGM belonging to the RMIG. + type: object + additionalProperties: + type: string + format: int64 DeploymentUpdate: id: DeploymentUpdate type: object @@ -1500,6 +1529,7 @@ components: Indicates that a VM is using global DNS. Can also be used to indicate that a resource has attributes that could result in the creation of a VM that uses global DNS. + - Resource can't be retrieved due to api quota exceeded. - >- Reserved entries for quickly adding new warnings without breaking dependent clients. @@ -1547,6 +1577,7 @@ components: - false - false - false + - false enum: - DEPRECATED_RESOURCE_USED - NO_RESULTS_ON_PAGE @@ -1582,11 +1613,12 @@ components: - LIST_OVERHEAD_QUOTA_EXCEED - QUOTA_INFO_UNAVAILABLE - RESOURCE_USES_GLOBAL_DNS - - RESERVED_ENTRY_134 + - RATE_LIMIT_EXCEEDED - RESERVED_ENTRY_135 - RESERVED_ENTRY_136 - RESERVED_ENTRY_139 - RESERVED_ENTRY_141 + - RESERVED_ENTRY_142 message: description: >- [Output Only] A human-readable description of the warning @@ -1789,6 +1821,7 @@ components: Indicates that a VM is using global DNS. Can also be used to indicate that a resource has attributes that could result in the creation of a VM that uses global DNS. + - Resource can't be retrieved due to api quota exceeded. - >- Reserved entries for quickly adding new warnings without breaking dependent clients. @@ -1836,6 +1869,7 @@ components: - false - false - false + - false enum: - DEPRECATED_RESOURCE_USED - NO_RESULTS_ON_PAGE @@ -1871,11 +1905,12 @@ components: - LIST_OVERHEAD_QUOTA_EXCEED - QUOTA_INFO_UNAVAILABLE - RESOURCE_USES_GLOBAL_DNS - - RESERVED_ENTRY_134 + - RATE_LIMIT_EXCEEDED - RESERVED_ENTRY_135 - RESERVED_ENTRY_136 - RESERVED_ENTRY_139 - RESERVED_ENTRY_141 + - RESERVED_ENTRY_142 message: description: >- [Output Only] A human-readable description of the warning diff --git a/providers/src/googleapis.com/v00.00.00000/services/developerconnect.yaml b/providers/src/googleapis.com/v00.00.00000/services/developerconnect.yaml index 7dad9b58..e324b9d6 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/developerconnect.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/developerconnect.yaml @@ -7,8 +7,8 @@ info: title: Developer Connect API description: Connect third-party source code management to Google version: v1 - x-discovery-doc-revision: '20241023' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250731' + x-generated-date: '2025-08-28' externalDocs: url: http://cloud.google.com/developer-connect/docs/overview servers: @@ -180,6 +180,14 @@ components: gitlabEnterpriseConfig: description: Configuration for connections to an instance of GitLab Enterprise. $ref: '#/components/schemas/GitLabEnterpriseConfig' + bitbucketDataCenterConfig: + description: >- + Configuration for connections to an instance of Bitbucket Data + Center. + $ref: '#/components/schemas/BitbucketDataCenterConfig' + bitbucketCloudConfig: + description: Configuration for connections to an instance of Bitbucket Clouds. + $ref: '#/components/schemas/BitbucketCloudConfig' name: description: >- Identifier. The resource name of the connection, in the format @@ -233,9 +241,7 @@ components: ensure the client has an up-to-date value before proceeding. type: string uid: - description: >- - Output only. A system-assigned unique identifier for a the - GitRepositoryLink. + description: Output only. A system-assigned unique identifier for the Connection. readOnly: true type: string cryptoKeyConfig: @@ -243,6 +249,12 @@ components: Optional. The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature. $ref: '#/components/schemas/CryptoKeyConfig' + gitProxyConfig: + description: >- + Optional. Configuration for the git proxy feature. Enabling the git + proxy allows clients to perform git operations on the repositories + linked in the connection. + $ref: '#/components/schemas/GitProxyConfig' GitHubConfig: id: GitHubConfig description: Configuration for connections to github.com. @@ -453,6 +465,85 @@ components: `host_uri`. readOnly: true type: string + BitbucketDataCenterConfig: + id: BitbucketDataCenterConfig + description: Configuration for connections to an instance of Bitbucket Data Center. + type: object + properties: + hostUri: + description: >- + Required. The URI of the Bitbucket Data Center host this connection + is for. + type: string + webhookSecretSecretVersion: + description: >- + Required. Immutable. SecretManager resource containing the webhook + secret used to verify webhook events, formatted as + `projects/*/secrets/*/versions/*`. This is used to validate + webhooks. + type: string + readAuthorizerCredential: + description: >- + Required. An http access token with the minimum `Repository read` + access. It's recommended to use a system account to generate the + credentials. + $ref: '#/components/schemas/UserCredential' + authorizerCredential: + description: >- + Required. An http access token with the minimum `Repository admin` + scope access. This is needed to create webhooks. It's recommended to + use a system account to generate these credentials. + $ref: '#/components/schemas/UserCredential' + serviceDirectoryConfig: + description: >- + Optional. Configuration for using Service Directory to privately + connect to a Bitbucket Data Center instance. This should only be set + if the Bitbucket Data Center is hosted on-premises and not reachable + by public internet. If this field is left empty, calls to the + Bitbucket Data Center will be made over the public internet. + $ref: '#/components/schemas/ServiceDirectoryConfig' + sslCaCertificate: + description: >- + Optional. SSL certificate authority to trust when making requests to + Bitbucket Data Center. + type: string + serverVersion: + description: >- + Output only. Version of the Bitbucket Data Center server running on + the `host_uri`. + readOnly: true + type: string + BitbucketCloudConfig: + id: BitbucketCloudConfig + description: Configuration for connections to an instance of Bitbucket Cloud. + type: object + properties: + workspace: + description: >- + Required. The Bitbucket Cloud Workspace ID to be connected to Google + Cloud Platform. + type: string + webhookSecretSecretVersion: + description: >- + Required. Immutable. SecretManager resource containing the webhook + secret used to verify webhook events, formatted as + `projects/*/secrets/*/versions/*`. This is used to validate and + create webhooks. + type: string + readAuthorizerCredential: + description: >- + Required. An access token with the minimum `repository` access. It + can either be a workspace, project or repository access token. It's + recommended to use a system account to generate the credentials. + $ref: '#/components/schemas/UserCredential' + authorizerCredential: + description: >- + Required. An access token with the minimum `repository`, + `pullrequest` and `webhook` scope access. It can either be a + workspace, project or repository access token. This is needed to + create webhooks. It's recommended to use a system account to + generate these credentials. + $ref: '#/components/schemas/UserCredential' InstallationState: id: InstallationState description: >- @@ -507,6 +598,17 @@ components: customer data. For key in Cloud KMS, the key should be in the format of `projects/*/locations/*/keyRings/*/cryptoKeys/*`. type: string + GitProxyConfig: + id: GitProxyConfig + description: The git proxy configuration. + type: object + properties: + enabled: + description: >- + Optional. Setting this to true allows the git proxy to be used for + performing git operations on the repositories linked in the + connection. + type: boolean GitRepositoryLink: id: GitRepositoryLink description: Message describing the GitRepositoryLink object @@ -559,7 +661,7 @@ components: type: string uid: description: >- - Output only. A system-assigned unique identifier for a the + Output only. A system-assigned unique identifier for the GitRepositoryLink. readOnly: true type: string @@ -567,6 +669,13 @@ components: description: Output only. External ID of the webhook created for the repository. readOnly: true type: string + gitProxyUri: + description: >- + Output only. URI to access the linked repository through the Git + Proxy. This field is only populated if the git proxy is enabled for + the connection. + readOnly: true + type: string ListGitRepositoryLinksResponse: id: ListGitRepositoryLinksResponse description: Message for response to listing GitRepositoryLinks @@ -694,160 +803,592 @@ components: nextPageToken: description: A token identifying a page of results the server should return. type: string - ProcessGitHubEnterpriseWebhookRequest: - id: ProcessGitHubEnterpriseWebhookRequest - description: >- - RPC request object accepted by the ProcessGitHubEnterpriseWebhook RPC - method. + ListAccountConnectorsResponse: + id: ListAccountConnectorsResponse + description: Message for response to listing AccountConnectors type: object properties: - body: - description: Required. HTTP request body. - $ref: '#/components/schemas/HttpBody' - HttpBody: - id: HttpBody + accountConnectors: + description: The list of AccountConnectors + type: array + items: + $ref: '#/components/schemas/AccountConnector' + nextPageToken: + description: A token identifying a page of results the server should return. + type: string + unreachable: + description: Locations that could not be reached. + type: array + items: + type: string + AccountConnector: + id: AccountConnector description: >- - Message that represents an arbitrary HTTP body. It should only be used - for payload formats that can't be represented as JSON, such as raw - binary or an HTML page. This message can be used both in streaming and - non-streaming API methods in the request as well as the response. It can - be used as a top-level request field, which is convenient if one wants - to extract parameters from either the URL or HTTP template into the - request fields and also want access to the raw HTTP body. Example: - message GetResourceRequest { // A unique request id. string request_id = - 1; // The raw HTTP body is bound to this field. google.api.HttpBody - http_body = 2; } service ResourceService { rpc - GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc - UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } - Example with streaming methods: service CaldavService { rpc - GetCalendar(stream google.api.HttpBody) returns (stream - google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) - returns (stream google.api.HttpBody); } Use of this type only changes - how the request and response bodies are handled, all other features will - continue to work unchanged. + AccountConnector encapsulates what a platform administrator needs to + configure for users to connect to the service providers, which includes, + among other fields, the OAuth client ID, client secret, and + authorization and token endpoints. type: object properties: - contentType: + providerOauthConfig: + description: Provider OAuth config. + $ref: '#/components/schemas/ProviderOAuthConfig' + name: description: >- - The HTTP Content-Type header value specifying the content type of - the body. + Identifier. The resource name of the accountConnector, in the format + `projects/{project}/locations/{location}/accountConnectors/{account_connector_id}`. type: string - data: - description: The HTTP request/response body as raw binary. + createTime: + description: Output only. The timestamp when the accountConnector was created. + readOnly: true type: string - format: byte - extensions: + format: google-datetime + updateTime: + description: Output only. The timestamp when the accountConnector was updated. + readOnly: true + type: string + format: google-datetime + annotations: + description: Optional. Allows users to store small amounts of arbitrary data. + type: object + additionalProperties: + type: string + etag: description: >- - Application specific response metadata. Must be set in the first - response for streaming APIs. + Optional. This checksum is computed by the server based on the value + of other fields, and may be sent on update and delete requests to + ensure the client has an up-to-date value before proceeding. + type: string + labels: + description: Optional. Labels as key value pairs + type: object + additionalProperties: + type: string + oauthStartUri: + description: Output only. Start OAuth flow by clicking on this URL. + readOnly: true + type: string + ProviderOAuthConfig: + id: ProviderOAuthConfig + description: ProviderOAuthConfig is the OAuth config for a provider. + type: object + properties: + systemProviderId: + description: Immutable. Developer Connect provided OAuth. + type: string + enumDescriptions: + - No system provider specified. + - >- + GitHub provider. Scopes can be found at + https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps#available-scopes + - >- + GitLab provider. Scopes can be found at + https://docs.gitlab.com/user/profile/personal_access_tokens/#personal-access-token-scopes + - >- + Google provider. Recommended scopes: + "https://www.googleapis.com/auth/drive.readonly", + "https://www.googleapis.com/auth/documents.readonly" + - >- + Sentry provider. Scopes can be found at + https://docs.sentry.io/api/permissions/ + - Rovo provider. Must select the "rovo" scope. + - New Relic provider. No scopes are allowed. + - Datastax provider. No scopes are allowed. + - Dynatrace provider. + enum: + - SYSTEM_PROVIDER_UNSPECIFIED + - GITHUB + - GITLAB + - GOOGLE + - SENTRY + - ROVO + - NEW_RELIC + - DATASTAX + - DYNATRACE + scopes: + description: >- + Required. User selected scopes to apply to the Oauth config In the + event of changing scopes, user records under AccountConnector will + be deleted and users will re-auth again. type: array items: - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - ProcessGitLabEnterpriseWebhookRequest: - id: ProcessGitLabEnterpriseWebhookRequest - description: >- - RPC request object accepted by the ProcessGitLabEnterpriseWebhook RPC - method. + type: string + FetchAccessTokenRequest: + id: FetchAccessTokenRequest + description: Message for fetching an OAuth access token. type: object - properties: - body: - description: Required. HTTP request body. - $ref: '#/components/schemas/HttpBody' - ProcessGitLabWebhookRequest: - id: ProcessGitLabWebhookRequest - description: RPC request object accepted by the ProcessGitLabWebhook RPC method. + properties: {} + FetchAccessTokenResponse: + id: FetchAccessTokenResponse + description: Message for responding to getting an OAuth access token. type: object properties: - body: - description: Required. HTTP request body. - $ref: '#/components/schemas/HttpBody' - ListLocationsResponse: - id: ListLocationsResponse - description: The response message for Locations.ListLocations. + token: + description: The token content. + type: string + expirationTime: + description: Expiration timestamp. Can be empty if unknown or non-expiring. + type: string + format: google-datetime + scopes: + description: The scopes of the access token. + type: array + items: + type: string + exchangeError: + description: >- + The error resulted from exchanging OAuth tokens from the service + provider. + $ref: '#/components/schemas/ExchangeError' + ExchangeError: + id: ExchangeError + description: Message for representing an error from exchanging OAuth tokens. type: object properties: - locations: + code: + description: https://datatracker.ietf.org/doc/html/rfc6749#section-5.2 - error + type: string + description: description: >- - A list of locations that matches the specified filter in the - request. + https://datatracker.ietf.org/doc/html/rfc6749#section-5.2 - + error_description + type: string + ListUsersResponse: + id: ListUsersResponse + description: Message for response to listing Users + type: object + properties: + users: + description: The list of Users type: array items: - $ref: '#/components/schemas/Location' + $ref: '#/components/schemas/User' nextPageToken: - description: The standard List next-page token. + description: A token identifying a page of results the server should return. type: string - Location: - id: Location - description: A resource that represents a Google Cloud location. + unreachable: + description: Locations that could not be reached. + type: array + items: + type: string + User: + id: User + description: >- + User represents a user connected to the service providers through a + AccountConnector. type: object properties: name: description: >- - Resource name for the location, which may vary between - implementations. For example: - `"projects/example-project/locations/us-east1"` - type: string - locationId: - description: 'The canonical id for this location. For example: `"us-east1"`.' + Identifier. Resource name of the user, in the format + `projects/*/locations/*/accountConnectors/*/users/*`. type: string displayName: description: >- - The friendly name for this location, typically a nearby city name. - For example, "Tokyo". + Output only. Developer Connect automatically converts user identity + to some human readable description, e.g., email address. + readOnly: true type: string - labels: - description: >- - Cross-service attributes for the location. For example - {"cloud.googleapis.com/region": "us-east1"} - type: object - additionalProperties: - type: string - metadata: - description: >- - Service-specific metadata. For example the available capacity at the - given location. - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - OperationMetadata: - id: OperationMetadata - description: Represents the metadata of the long-running operation. - type: object - properties: createTime: - description: Output only. The time the operation was created. + description: Output only. The timestamp when the user was created. readOnly: true type: string format: google-datetime - endTime: - description: Output only. The time the operation finished running. + lastTokenRequestTime: + description: Output only. The timestamp when the token was last requested. readOnly: true type: string format: google-datetime - target: + ListInsightsConfigsResponse: + id: ListInsightsConfigsResponse + description: Request for response to listing InsightsConfigs. + type: object + properties: + insightsConfigs: + description: The list of InsightsConfigs. + type: array + items: + $ref: '#/components/schemas/InsightsConfig' + nextPageToken: + description: A token identifying a page of results the server should return. + type: string + unreachable: + description: Locations that could not be reached. + type: array + items: + type: string + InsightsConfig: + id: InsightsConfig + description: >- + The InsightsConfig resource is the core configuration object to capture + events from your Software Development Lifecycle. It acts as the central + hub for managing how Developer connect understands your application, its + runtime environments, and the artifacts deployed within them. + type: object + properties: + appHubApplication: description: >- - Output only. Server-defined resource path for the target of the - operation. - readOnly: true + Optional. The name of the App Hub Application. Format: + projects/{project}/locations/{location}/applications/{application} type: string - verb: - description: Output only. Name of the verb executed by the operation. + name: + description: >- + Identifier. The name of the InsightsConfig. Format: + projects/{project}/locations/{location}/insightsConfigs/{insightsConfig} + type: string + createTime: + description: Output only. [Output only] Create timestamp readOnly: true type: string - statusMessage: - description: Output only. Human-readable status of the operation, if any. + format: google-datetime + updateTime: + description: Output only. [Output only] Update timestamp readOnly: true type: string - requestedCancellation: + format: google-datetime + runtimeConfigs: description: >- - Output only. Identifies whether the user has requested cancellation - of the operation. Operations that have been cancelled successfully - have Operation.error value with a google.rpc.Status.code of 1, - corresponding to `Code.CANCELLED`. + Output only. The runtime configurations where the application is + deployed. + readOnly: true + type: array + items: + $ref: '#/components/schemas/RuntimeConfig' + artifactConfigs: + description: >- + Optional. The artifact configurations of the artifacts that are + deployed. + type: array + items: + $ref: '#/components/schemas/ArtifactConfig' + state: + description: Optional. Output only. The state of the InsightsConfig. + type: string + enumDescriptions: + - No state specified. + - >- + The InsightsConfig is pending application discovery/runtime + discovery. + - The initial discovery process is complete. + - The InsightsConfig is in an error state. + enum: + - STATE_UNSPECIFIED + - PENDING + - COMPLETE + - ERROR + annotations: + description: >- + Optional. User specified annotations. See + https://google.aip.dev/148#annotations for more details such as + format and size limitations. + type: object + additionalProperties: + type: string + labels: + description: Optional. Set of labels associated with an InsightsConfig. + type: object + additionalProperties: + type: string + reconciling: + description: >- + Output only. Reconciling + (https://google.aip.dev/128#reconciliation). Set to true if the + current state of InsightsConfig does not match the user's intended + state, and the service is actively updating the resource to + reconcile them. This can happen due to user-triggered updates or + system actions like failover or maintenance. + readOnly: true + type: boolean + errors: + description: >- + Output only. Any errors that occurred while setting up the + InsightsConfig. Each error will be in the format: `field_name: + error_message`, e.g. GetAppHubApplication: Permission denied while + getting App Hub application. Please grant permissions to the P4SA. + readOnly: true + type: array + items: + $ref: '#/components/schemas/Status' + RuntimeConfig: + id: RuntimeConfig + description: RuntimeConfig represents the runtimes where the application is deployed. + type: object + properties: + gkeWorkload: + description: Output only. Google Kubernetes Engine runtime. + readOnly: true + $ref: '#/components/schemas/GKEWorkload' + appHubWorkload: + description: Output only. App Hub Workload. + readOnly: true + $ref: '#/components/schemas/AppHubWorkload' + uri: + description: >- + Required. Immutable. The URI of the runtime configuration. For GKE, + this is the cluster name. For Cloud Run, this is the service name. + type: string + state: + description: Output only. The state of the Runtime. + readOnly: true + type: string + enumDescriptions: + - No state specified. + - The runtime configuration has been linked to the InsightsConfig. + - The runtime configuration has been unlinked to the InsightsConfig. + enum: + - STATE_UNSPECIFIED + - LINKED + - UNLINKED + GKEWorkload: + id: GKEWorkload + description: GKEWorkload represents the Google Kubernetes Engine runtime. + type: object + properties: + cluster: + description: >- + Required. Immutable. The name of the GKE cluster. Format: + `projects/{project}/locations/{location}/clusters/{cluster}`. + type: string + deployment: + description: >- + Output only. The name of the GKE deployment. Format: + `projects/{project}/locations/{location}/clusters/{cluster}/namespaces/{namespace}/deployments/{deployment}`. + readOnly: true + type: string + AppHubWorkload: + id: AppHubWorkload + description: AppHubWorkload represents the App Hub Workload. + type: object + properties: + workload: + description: >- + Required. Output only. Immutable. The name of the App Hub Workload. + Format: + `projects/{project}/locations/{location}/applications/{application}/workloads/{workload}`. + readOnly: true + type: string + criticality: + description: Output only. The criticality of the App Hub Workload. + readOnly: true + type: string + environment: + description: Output only. The environment of the App Hub Workload. + readOnly: true + type: string + ArtifactConfig: + id: ArtifactConfig + description: The artifact config of the artifact that is deployed. + type: object + properties: + googleArtifactRegistry: + description: Optional. Set if the artifact is stored in Artifact registry. + $ref: '#/components/schemas/GoogleArtifactRegistry' + googleArtifactAnalysis: + description: >- + Optional. Set if the artifact metadata is stored in Artifact + analysis. + $ref: '#/components/schemas/GoogleArtifactAnalysis' + uri: + description: >- + Required. Immutable. The URI of the artifact that is deployed. e.g. + `us-docker.pkg.dev/my-project/my-repo/image`. The URI does not + include the tag / digest because it captures a lineage of artifacts. + type: string + GoogleArtifactRegistry: + id: GoogleArtifactRegistry + description: Google Artifact Registry configurations. + type: object + properties: + projectId: + description: Required. The host project of Artifact Registry. + type: string + artifactRegistryPackage: + description: Required. Immutable. The name of the artifact registry package. + type: string + GoogleArtifactAnalysis: + id: GoogleArtifactAnalysis + description: Google Artifact Analysis configurations. + type: object + properties: + projectId: + description: >- + Required. The project id of the project where the provenance is + stored. + type: string + ProcessGitHubEnterpriseWebhookRequest: + id: ProcessGitHubEnterpriseWebhookRequest + description: >- + RPC request object accepted by the ProcessGitHubEnterpriseWebhook RPC + method. + type: object + properties: + body: + description: Required. HTTP request body. + $ref: '#/components/schemas/HttpBody' + HttpBody: + id: HttpBody + description: >- + Message that represents an arbitrary HTTP body. It should only be used + for payload formats that can't be represented as JSON, such as raw + binary or an HTML page. This message can be used both in streaming and + non-streaming API methods in the request as well as the response. It can + be used as a top-level request field, which is convenient if one wants + to extract parameters from either the URL or HTTP template into the + request fields and also want access to the raw HTTP body. Example: + message GetResourceRequest { // A unique request id. string request_id = + 1; // The raw HTTP body is bound to this field. google.api.HttpBody + http_body = 2; } service ResourceService { rpc + GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc + UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } + Example with streaming methods: service CaldavService { rpc + GetCalendar(stream google.api.HttpBody) returns (stream + google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) + returns (stream google.api.HttpBody); } Use of this type only changes + how the request and response bodies are handled, all other features will + continue to work unchanged. + type: object + properties: + contentType: + description: >- + The HTTP Content-Type header value specifying the content type of + the body. + type: string + data: + description: The HTTP request/response body as raw binary. + type: string + format: byte + extensions: + description: >- + Application specific response metadata. Must be set in the first + response for streaming APIs. + type: array + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + ProcessGitLabEnterpriseWebhookRequest: + id: ProcessGitLabEnterpriseWebhookRequest + description: >- + RPC request object accepted by the ProcessGitLabEnterpriseWebhook RPC + method. + type: object + properties: + body: + description: Required. HTTP request body. + $ref: '#/components/schemas/HttpBody' + ProcessGitLabWebhookRequest: + id: ProcessGitLabWebhookRequest + description: RPC request object accepted by the ProcessGitLabWebhook RPC method. + type: object + properties: + body: + description: Required. HTTP request body. + $ref: '#/components/schemas/HttpBody' + ProcessBitbucketDataCenterWebhookRequest: + id: ProcessBitbucketDataCenterWebhookRequest + description: >- + RPC request object accepted by the ProcessBitbucketDataCenterWebhook RPC + method. + type: object + properties: + body: + description: Required. HTTP request body. + $ref: '#/components/schemas/HttpBody' + ProcessBitbucketCloudWebhookRequest: + id: ProcessBitbucketCloudWebhookRequest + description: >- + RPC request object accepted by the ProcessBitbucketCloudWebhook RPC + method. + type: object + properties: + body: + description: Required. HTTP request body. + $ref: '#/components/schemas/HttpBody' + ListLocationsResponse: + id: ListLocationsResponse + description: The response message for Locations.ListLocations. + type: object + properties: + locations: + description: >- + A list of locations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/Location' + nextPageToken: + description: The standard List next-page token. + type: string + Location: + id: Location + description: A resource that represents a Google Cloud location. + type: object + properties: + name: + description: >- + Resource name for the location, which may vary between + implementations. For example: + `"projects/example-project/locations/us-east1"` + type: string + locationId: + description: 'The canonical id for this location. For example: `"us-east1"`.' + type: string + displayName: + description: >- + The friendly name for this location, typically a nearby city name. + For example, "Tokyo". + type: string + labels: + description: >- + Cross-service attributes for the location. For example + {"cloud.googleapis.com/region": "us-east1"} + type: object + additionalProperties: + type: string + metadata: + description: >- + Service-specific metadata. For example the available capacity at the + given location. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + OperationMetadata: + id: OperationMetadata + description: Represents the metadata of the long-running operation. + type: object + properties: + createTime: + description: Output only. The time the operation was created. + readOnly: true + type: string + format: google-datetime + endTime: + description: Output only. The time the operation finished running. + readOnly: true + type: string + format: google-datetime + target: + description: >- + Output only. Server-defined resource path for the target of the + operation. + readOnly: true + type: string + verb: + description: Output only. Name of the verb executed by the operation. + readOnly: true + type: string + statusMessage: + description: Output only. Human-readable status of the operation, if any. + readOnly: true + type: string + requestedCancellation: + description: >- + Output only. Identifies whether the user has requested cancellation + of the operation. Operations that have been cancelled successfully + have google.longrunning.Operation.error value with a + google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. readOnly: true type: boolean apiVersion: @@ -1063,10 +1604,10 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/connections/methods/delete' - connections_linkable_git_repositories: - id: google.developerconnect.connections_linkable_git_repositories - name: connections_linkable_git_repositories - title: Connections_linkable_git_repositories + linkable_git_repositories: + id: google.developerconnect.linkable_git_repositories + name: linkable_git_repositories + title: Linkable_git_repositories methods: fetch_linkable_git_repositories: operation: @@ -1078,15 +1619,15 @@ components: sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/connections_linkable_git_repositories/methods/fetch_linkable_git_repositories + #/components/x-stackQL-resources/linkable_git_repositories/methods/fetch_linkable_git_repositories insert: [] update: [] replace: [] delete: [] - connections_github_installations: - id: google.developerconnect.connections_github_installations - name: connections_github_installations - title: Connections_github_installations + github_installations: + id: google.developerconnect.github_installations + name: github_installations + title: Github_installations methods: fetchgithub_installations: operation: @@ -1098,7 +1639,7 @@ components: sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/connections_github_installations/methods/fetchgithub_installations + #/components/x-stackQL-resources/github_installations/methods/fetchgithub_installations insert: [] update: [] replace: [] @@ -1151,6 +1692,20 @@ components: response: mediaType: application/json openAPIDocKey: '200' + process_bitbucket_data_center_webhook: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1gitRepositoryLinks~1{gitRepositoryLinksId}:processBitbucketDataCenterWebhook/post + response: + mediaType: application/json + openAPIDocKey: '200' + process_bitbucket_cloud_webhook: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1gitRepositoryLinks~1{gitRepositoryLinksId}:processBitbucketCloudWebhook/post + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/git_repository_links/methods/get' @@ -1223,19 +1778,198 @@ components: update: [] replace: [] delete: [] -paths: - /v1/projects/{projectsId}/locations: - parameters: &ref_1 - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/uploadType' + account_connectors: + id: google.developerconnect.account_connectors + name: account_connectors + title: Account_connectors + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1accountConnectors/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.accountConnectors + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1accountConnectors/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1accountConnectors~1{accountConnectorsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1accountConnectors~1{accountConnectorsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1accountConnectors~1{accountConnectorsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/account_connectors/methods/get' + - $ref: '#/components/x-stackQL-resources/account_connectors/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/account_connectors/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/account_connectors/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/account_connectors/methods/delete' + users_access_token: + id: google.developerconnect.users_access_token + name: users_access_token + title: Users_access_token + methods: + fetch_access_token: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1accountConnectors~1{accountConnectorsId}~1users:fetchAccessToken/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/users_access_token/methods/fetch_access_token + insert: [] + update: [] + replace: [] + delete: [] + users: + id: google.developerconnect.users + name: users + title: Users + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1accountConnectors~1{accountConnectorsId}~1users/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.users + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1accountConnectors~1{accountConnectorsId}~1users~1{usersId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/users/methods/list' + insert: [] + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/users/methods/delete' + users_self: + id: google.developerconnect.users_self + name: users_self + title: Users_self + methods: + fetch_self: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1accountConnectors~1{accountConnectorsId}~1users:fetchSelf/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete_self: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1accountConnectors~1{accountConnectorsId}~1users:deleteSelf/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/users_self/methods/fetch_self' + insert: [] + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/users_self/methods/delete_self' + insights_configs: + id: google.developerconnect.insights_configs + name: insights_configs + title: Insights_configs + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1insightsConfigs/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.insightsConfigs + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1insightsConfigs/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1insightsConfigs~1{insightsConfigsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1insightsConfigs~1{insightsConfigsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1insightsConfigs~1{insightsConfigsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/insights_configs/methods/get' + - $ref: '#/components/x-stackQL-resources/insights_configs/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/insights_configs/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/insights_configs/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/insights_configs/methods/delete' +paths: + /v1/projects/{projectsId}/locations: + parameters: &ref_1 + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/_.xgafv' get: description: Lists information about the supported locations for this service. @@ -1271,6 +2005,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: @@ -1425,7 +2163,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: developerconnect.projects.locations.operations.cancel requestBody: content: @@ -2204,3 +2942,721 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/gitRepositoryLinks/{gitRepositoryLinksId}:processBitbucketDataCenterWebhook: + parameters: *ref_1 + post: + description: >- + ProcessBitbucketDataCenterWebhook is called by the external Bitbucket + Data Center instances for notifying events. + operationId: >- + developerconnect.projects.locations.connections.gitRepositoryLinks.processBitbucketDataCenterWebhook + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ProcessBitbucketDataCenterWebhookRequest' + security: [] + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: connectionsId + required: true + schema: + type: string + - in: path + name: gitRepositoryLinksId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/gitRepositoryLinks/{gitRepositoryLinksId}:processBitbucketCloudWebhook: + parameters: *ref_1 + post: + description: >- + ProcessBitbucketCloudWebhook is called by the external Bitbucket Cloud + instances for notifying events. + operationId: >- + developerconnect.projects.locations.connections.gitRepositoryLinks.processBitbucketCloudWebhook + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ProcessBitbucketCloudWebhookRequest' + security: [] + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: connectionsId + required: true + schema: + type: string + - in: path + name: gitRepositoryLinksId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/accountConnectors: + parameters: *ref_1 + get: + description: Lists AccountConnectors in a given project and location. + operationId: developerconnect.projects.locations.accountConnectors.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListAccountConnectorsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + post: + description: Creates a new AccountConnector in a given project and location. + operationId: developerconnect.projects.locations.accountConnectors.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AccountConnector' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: accountConnectorId + schema: + type: string + - in: query + name: requestId + schema: + type: string + - in: query + name: validateOnly + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/accountConnectors/{accountConnectorsId}: + parameters: *ref_1 + get: + description: Gets details of a single AccountConnector. + operationId: developerconnect.projects.locations.accountConnectors.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/AccountConnector' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: accountConnectorsId + required: true + schema: + type: string + patch: + description: Updates the parameters of a single AccountConnector. + operationId: developerconnect.projects.locations.accountConnectors.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AccountConnector' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: accountConnectorsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: requestId + schema: + type: string + - in: query + name: allowMissing + schema: + type: boolean + - in: query + name: validateOnly + schema: + type: boolean + delete: + description: Deletes a single AccountConnector. + operationId: developerconnect.projects.locations.accountConnectors.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: accountConnectorsId + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + - in: query + name: validateOnly + schema: + type: boolean + - in: query + name: etag + schema: + type: string + - in: query + name: force + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/accountConnectors/{accountConnectorsId}/users:fetchAccessToken: + parameters: *ref_1 + post: + description: Fetches OAuth access token based on end user credentials. + operationId: >- + developerconnect.projects.locations.accountConnectors.users.fetchAccessToken + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FetchAccessTokenRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/FetchAccessTokenResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: accountConnectorsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/accountConnectors/{accountConnectorsId}/users: + parameters: *ref_1 + get: + description: Lists Users in a given project, location, and account_connector. + operationId: developerconnect.projects.locations.accountConnectors.users.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListUsersResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: accountConnectorsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/accountConnectors/{accountConnectorsId}/users/{usersId}: + parameters: *ref_1 + delete: + description: Deletes a single User. + operationId: developerconnect.projects.locations.accountConnectors.users.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: accountConnectorsId + required: true + schema: + type: string + - in: path + name: usersId + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + - in: query + name: validateOnly + schema: + type: boolean + - in: query + name: etag + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/accountConnectors/{accountConnectorsId}/users:fetchSelf: + parameters: *ref_1 + get: + description: Fetch the User based on the user credentials. + operationId: developerconnect.projects.locations.accountConnectors.users.fetchSelf + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/User' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: accountConnectorsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/accountConnectors/{accountConnectorsId}/users:deleteSelf: + parameters: *ref_1 + delete: + description: Delete the User based on the user credentials. + operationId: developerconnect.projects.locations.accountConnectors.users.deleteSelf + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: accountConnectorsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/insightsConfigs: + parameters: *ref_1 + get: + description: Lists InsightsConfigs in a given project and location. + operationId: developerconnect.projects.locations.insightsConfigs.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListInsightsConfigsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + post: + description: Creates a new InsightsConfig in a given project and location. + operationId: developerconnect.projects.locations.insightsConfigs.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InsightsConfig' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: insightsConfigId + schema: + type: string + - in: query + name: validateOnly + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/insightsConfigs/{insightsConfigsId}: + parameters: *ref_1 + get: + description: Gets details of a single Insight. + operationId: developerconnect.projects.locations.insightsConfigs.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/InsightsConfig' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: insightsConfigsId + required: true + schema: + type: string + patch: + description: Updates the parameters of a single InsightsConfig. + operationId: developerconnect.projects.locations.insightsConfigs.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InsightsConfig' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: insightsConfigsId + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + - in: query + name: allowMissing + schema: + type: boolean + - in: query + name: validateOnly + schema: + type: boolean + delete: + description: Delete a single Insight. + operationId: developerconnect.projects.locations.insightsConfigs.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: insightsConfigsId + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + - in: query + name: validateOnly + schema: + type: boolean + - in: query + name: etag + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/dialogflow.yaml b/providers/src/googleapis.com/v00.00.00000/services/dialogflow.yaml index 18b2b5c9..cd663af5 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/dialogflow.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/dialogflow.yaml @@ -9,8 +9,8 @@ info: Builds conversational interfaces (for example, chatbots, and voice-powered apps and devices). version: v3 - x-discovery-doc-revision: '20241025' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250820' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/dialogflow/ servers: @@ -37,112 +37,6 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleLongrunningListOperationsResponse: - id: GoogleLongrunningListOperationsResponse - description: The response message for Operations.ListOperations. - type: object - properties: - operations: - description: >- - A list of operations that matches the specified filter in the - request. - type: array - items: - $ref: '#/components/schemas/GoogleLongrunningOperation' - nextPageToken: - description: The standard List next-page token. - type: string - GoogleLongrunningOperation: - id: GoogleLongrunningOperation - description: >- - This resource represents a long-running operation that is the result of - a network API call. - type: object - properties: - name: - description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. - type: string - metadata: - description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - done: - description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - type: boolean - error: - description: >- - The error result of the operation in case of failure or - cancellation. - $ref: '#/components/schemas/GoogleRpcStatus' - response: - description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - GoogleRpcStatus: - id: GoogleRpcStatus - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - type: object - properties: - code: - description: The status code, which should be an enum value of google.rpc.Code. - type: integer - format: int32 - message: - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - type: string - details: - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - type: array - items: - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - GoogleProtobufEmpty: - id: GoogleProtobufEmpty - description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } - type: object - properties: {} GoogleCloudDialogflowCxV3ListPagesResponse: id: GoogleCloudDialogflowCxV3ListPagesResponse description: The response message for Pages.ListPages. @@ -223,7 +117,7 @@ components: A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are - evalauted in the following order: * TransitionRoutes defined in the + evaluated in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in @@ -318,6 +212,12 @@ components: fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers. type: boolean + generators: + description: A list of Generators to be called during this fulfillment. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3FulfillmentGeneratorSettings GoogleCloudDialogflowCxV3ResponseMessage: id: GoogleCloudDialogflowCxV3ResponseMessage description: >- @@ -399,6 +299,11 @@ components: Dialogflow Messenger. $ref: >- #/components/schemas/GoogleCloudDialogflowCxV3ResponseMessageKnowledgeInfoCard + toolCall: + description: >- + Returns the definition of a tool call that should be executed by the + client. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3ToolCall' responseType: description: Response type. type: string @@ -591,6 +496,25 @@ components: skipped. type: object properties: {} + GoogleCloudDialogflowCxV3ToolCall: + id: GoogleCloudDialogflowCxV3ToolCall + description: Represents a call of a specific tool's action with the specified inputs. + type: object + properties: + tool: + description: >- + Required. The tool associated with this call. Format: + `projects//locations//agents//tools/`. + type: string + action: + description: Required. The name of the tool's action associated with this call. + type: string + inputParameters: + description: Optional. The action's input parameters. + type: object + additionalProperties: + type: any + description: Properties of the object. GoogleCloudDialogflowCxV3FulfillmentSetParameterAction: id: GoogleCloudDialogflowCxV3FulfillmentSetParameterAction description: Setting a parameter value. @@ -719,8 +643,8 @@ components: format: google-duration useTimeoutBasedEndpointing: description: >- - Use timeout based endpointing, interpreting endpointer sensitivy as - seconds of timeout value. + Use timeout based endpointing, interpreting endpointer sensitivity + as seconds of timeout value. type: boolean models: description: >- @@ -778,6 +702,34 @@ components: `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. type: boolean + GoogleCloudDialogflowCxV3FulfillmentGeneratorSettings: + id: GoogleCloudDialogflowCxV3FulfillmentGeneratorSettings + description: Generator settings used by the LLM to generate a text response. + type: object + properties: + generator: + description: >- + Required. The generator to call. Format: + `projects//locations//agents//generators/`. + type: string + inputParameters: + description: >- + Map from placeholder parameter in the Generator to corresponding + session parameters. By default, Dialogflow uses the session + parameter with the same name to fill in the generator template. e.g. + If there is a placeholder parameter `city` in the Generator, + Dialogflow default to fill in the `$city` with + `$session.params.city`. However, you may choose to fill `$city` with + `$session.params.desination-city`. - Map key: parameter ID - Map + value: session parameter name + type: object + additionalProperties: + type: string + outputParameter: + description: >- + Required. Output parameter which should contain the generator + response. + type: string GoogleCloudDialogflowCxV3Form: id: GoogleCloudDialogflowCxV3Form description: >- @@ -1042,6 +994,129 @@ components: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}` type: string + documentProcessingMode: + description: >- + The document processing mode for the data store connection. Should + only be set for PUBLIC_WEB and UNSTRUCTURED data stores. If not set + it is considered as DOCUMENTS, as this is the legacy mode. + type: string + enumDescriptions: + - >- + Not specified. This should be set for STRUCTURED type data stores. + Due to legacy reasons this is considered as DOCUMENTS for + STRUCTURED and PUBLIC_WEB data stores. + - Documents are processed as documents. + - Documents are converted to chunks. + enum: + - DOCUMENT_PROCESSING_MODE_UNSPECIFIED + - DOCUMENTS + - CHUNKS + GoogleProtobufEmpty: + id: GoogleProtobufEmpty + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + type: object + properties: {} + GoogleLongrunningListOperationsResponse: + id: GoogleLongrunningListOperationsResponse + description: The response message for Operations.ListOperations. + type: object + properties: + operations: + description: >- + A list of operations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/GoogleLongrunningOperation' + nextPageToken: + description: The standard List next-page token. + type: string + GoogleLongrunningOperation: + id: GoogleLongrunningOperation + description: >- + This resource represents a long-running operation that is the result of + a network API call. + type: object + properties: + name: + description: >- + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. + type: string + metadata: + description: >- + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + done: + description: >- + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + type: boolean + error: + description: >- + The error result of the operation in case of failure or + cancellation. + $ref: '#/components/schemas/GoogleRpcStatus' + response: + description: >- + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + GoogleRpcStatus: + id: GoogleRpcStatus + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + type: object + properties: + code: + description: The status code, which should be an enum value of google.rpc.Code. + type: integer + format: int32 + message: + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + type: string + details: + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + type: array + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. GoogleCloudDialogflowCxV3Flow: id: GoogleCloudDialogflowCxV3Flow description: >- @@ -1081,7 +1156,7 @@ components: human?", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow. TransitionRoutes are - evalauted in the following order: * TransitionRoutes with intent + evaluated in the following order: * TransitionRoutes with intent specified. * TransitionRoutes with only condition specified. TransitionRoutes with intent specified are inherited by pages in the flow. @@ -1127,8 +1202,18 @@ components: description: Optional. Knowledge connector configuration. $ref: >- #/components/schemas/GoogleCloudDialogflowCxV3KnowledgeConnectorSettings - multiLanguageSettings: - description: Optional. Multi-lingual agent settings for this flow. + inputParameterDefinitions: + description: Optional. Defined structured input parameters for this flow. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3ParameterDefinition' + outputParameterDefinitions: + description: Optional. Defined structured output parameters for this flow. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3ParameterDefinition' + multiLanguageSettings: + description: Optional. Multi-lingual agent settings for this flow. $ref: >- #/components/schemas/GoogleCloudDialogflowCxV3FlowMultiLanguageSettings locked: @@ -1180,6 +1265,94 @@ components: - MODEL_TRAINING_MODE_UNSPECIFIED - MODEL_TRAINING_MODE_AUTOMATIC - MODEL_TRAINING_MODE_MANUAL + GoogleCloudDialogflowCxV3ParameterDefinition: + id: GoogleCloudDialogflowCxV3ParameterDefinition + description: >- + Defines the properties of a parameter. Used to define parameters used in + the agent and the input / output parameters for each fulfillment. + type: object + properties: + name: + description: Required. Name of parameter. + type: string + type: + description: Type of parameter. + deprecated: true + type: string + enumDescriptions: + - Not specified. No validation will be performed. + - Represents any string value. + - Represents any number value. + - Represents a boolean value. + - Represents a null value. + - Represents any object value. + - Represents a repeated value. + enum: + - PARAMETER_TYPE_UNSPECIFIED + - STRING + - NUMBER + - BOOLEAN + - 'NULL' + - OBJECT + - LIST + typeSchema: + description: Optional. Type schema of parameter. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3TypeSchema' + description: + description: >- + Human-readable description of the parameter. Limited to 300 + characters. + type: string + GoogleCloudDialogflowCxV3TypeSchema: + id: GoogleCloudDialogflowCxV3TypeSchema + description: >- + Encapsulates different type schema variations: either a reference to an + a schema that's already defined by a tool, or an inline definition. + type: object + properties: + inlineSchema: + description: Set if this is an inline schema definition. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3InlineSchema' + schemaReference: + description: Set if this is a schema reference. + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3TypeSchemaSchemaReference + GoogleCloudDialogflowCxV3InlineSchema: + id: GoogleCloudDialogflowCxV3InlineSchema + description: A type schema object that's specified inline. + type: object + properties: + type: + description: Data type of the schema. + type: string + enumDescriptions: + - Not specified. + - Represents any string value. + - Represents any number value. + - Represents a boolean value. + - Represents a repeated value. + enum: + - DATA_TYPE_UNSPECIFIED + - STRING + - NUMBER + - BOOLEAN + - ARRAY + items: + description: Schema of the elements if this is an ARRAY type. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3TypeSchema' + GoogleCloudDialogflowCxV3TypeSchemaSchemaReference: + id: GoogleCloudDialogflowCxV3TypeSchemaSchemaReference + description: A reference to the schema of an existing tool. + type: object + properties: + tool: + description: >- + The tool that contains this schema definition. Format: + `projects//locations//agents//tools/`. + type: string + schema: + description: The name of the schema. + type: string GoogleCloudDialogflowCxV3FlowMultiLanguageSettings: id: GoogleCloudDialogflowCxV3FlowMultiLanguageSettings description: Settings for multi-lingual agents. @@ -1574,7 +1747,11 @@ components: have the permission of storage.buckets.setIamPolicy. type: string audioExportPattern: - description: Filename pattern for exported audio. + description: >- + Filename pattern for exported audio. {conversation} and {timestamp} + are placeholders that will be replaced with the conversation ID and + epoch micros of the conversation. For example, + "{conversation}/recording_{timestamp}.mulaw". type: string enableAudioRedaction: description: >- @@ -1706,10 +1883,21 @@ components: $ref: '#/components/schemas/GoogleCloudDialogflowCxV3SpeechToTextSettings' startFlow: description: >- - Immutable. Name of the start flow in this agent. A start flow will - be automatically created when the agent is created, and can only be + Name of the start flow in this agent. A start flow will be + automatically created when the agent is created, and can only be deleted by deleting the agent. Format: - `projects//locations//agents//flows/`. + `projects//locations//agents//flows/`. Currently only the default + start flow with id "00000000-0000-0000-0000-000000000000" is + allowed. + type: string + startPlaybook: + description: >- + Name of the start playbook in this agent. A start playbook will be + automatically created when the agent is created, and can only be + deleted by deleting the agent. Format: + `projects//locations//agents//playbooks/`. Currently only the + default playbook with id "00000000-0000-0000-0000-000000000000" is + allowed. type: string securitySettings: description: >- @@ -1769,6 +1957,18 @@ components: description: Optional. Settings for custom client certificates. $ref: >- #/components/schemas/GoogleCloudDialogflowCxV3AgentClientCertificateSettings + satisfiesPzs: + description: >- + Optional. Output only. A read only boolean field reflecting Zone + Separation status of the agent. + readOnly: true + type: boolean + satisfiesPzi: + description: >- + Optional. Output only. A read only boolean field reflecting Zone + Isolation status of the agent. + readOnly: true + type: boolean GoogleCloudDialogflowCxV3SpeechToTextSettings: id: GoogleCloudDialogflowCxV3SpeechToTextSettings description: Settings related to speech recognition. @@ -2116,6 +2316,9 @@ components: languageCode: description: Language for this settings. type: string + llmModelSettings: + description: LLM model settings. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3LlmModelSettings' GoogleCloudDialogflowCxV3GenerativeSettingsFallbackSettings: id: GoogleCloudDialogflowCxV3GenerativeSettingsFallbackSettings description: Settings for Generative Fallback. @@ -2157,11 +2360,31 @@ components: description: Settings for Generative Safety. type: object properties: + defaultBannedPhraseMatchStrategy: + description: Optional. Default phrase match strategy for banned phrases. + type: string + enumDescriptions: + - Unspecified, defaults to PARTIAL_MATCH. + - >- + Text that contains the phrase as a substring will be matched, e.g. + "foo" will match "afoobar". + - >- + Text that contains the tokenized words of the phrase will be + matched, e.g. "foo" will match "a foo bar" and "foo bar", but not + "foobar". + enum: + - PHRASE_MATCH_STRATEGY_UNSPECIFIED + - PARTIAL_MATCH + - WORD_MATCH bannedPhrases: description: Banned phrases for generated text. type: array items: $ref: '#/components/schemas/GoogleCloudDialogflowCxV3SafetySettingsPhrase' + promptSecuritySettings: + description: Optional. Settings for prompt security checks. + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3SafetySettingsPromptSecuritySettings GoogleCloudDialogflowCxV3SafetySettingsPhrase: id: GoogleCloudDialogflowCxV3SafetySettingsPhrase description: Text input which can be used for prompt or banned phrases. @@ -2173,6 +2396,14 @@ components: languageCode: description: Required. Language code of the phrase. type: string + GoogleCloudDialogflowCxV3SafetySettingsPromptSecuritySettings: + id: GoogleCloudDialogflowCxV3SafetySettingsPromptSecuritySettings + description: Settings for prompt security checks. + type: object + properties: + enablePromptSecurity: + description: Optional. Enable prompt security checks. + type: boolean GoogleCloudDialogflowCxV3GenerativeSettingsKnowledgeConnectorSettings: id: GoogleCloudDialogflowCxV3GenerativeSettingsKnowledgeConnectorSettings description: >- @@ -2209,6 +2440,17 @@ components: the LLM couldn't pick a proper answer). Per default the feature is enabled. type: boolean + GoogleCloudDialogflowCxV3LlmModelSettings: + id: GoogleCloudDialogflowCxV3LlmModelSettings + description: Settings for LLM models. + type: object + properties: + model: + description: The selected LLM model. + type: string + promptText: + description: The custom prompt to use. + type: string GoogleCloudDialogflowCxV3ListChangelogsResponse: id: GoogleCloudDialogflowCxV3ListChangelogsResponse description: The response message for Changelogs.ListChangelogs. @@ -2690,6 +2932,7 @@ components: properties: id: description: Output only. The unique identifier of the training phrase. + readOnly: true type: string parts: description: >- @@ -2996,6 +3239,14 @@ components: additionalProperties: type: any description: Properties of the object. + parameterScope: + description: >- + Scope for the parameters. If not specified, parameters will be + treated as session parameters. Parameters with custom scope will not + be put into session parameters. You can reference the parameters + with custom scope in the agent with the following format: + $parameter-scope.params.parameter-id. + type: string currentPage: description: >- The unique identifier of the page to override the current page in @@ -3039,6 +3290,18 @@ components: type: array items: type: string + currentPlaybook: + description: >- + Optional. The unique identifier of the playbook to start or continue + the session with. If `current_playbook` is specified, the previous + state of the session will be ignored by Dialogflow. Format: + `projects//locations//agents//playbooks/`. + type: string + llmModelSettings: + description: >- + Optional. Use the specified LLM model settings for processing the + request. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3LlmModelSettings' channel: description: >- The channel which this query is for. If specified, only the @@ -3077,6 +3340,7 @@ components: request then DetectIntentResponse.query_result.data_store_connection_signals will be filled with data that can help evaluations. + deprecated: true type: boolean GoogleTypeLatLng: id: GoogleTypeLatLng @@ -3101,12 +3365,21 @@ components: type: object properties: boostSpecs: - description: Optional. Boosting configuration for the datastores. + description: >- + Optional. Boosting configuration for the datastores. Maps from + datastore name to their boost configuration. Do not specify more + than one BoostSpecs for each datastore name. If multiple BoostSpecs + are provided for the same datastore name, the behavior is undefined. type: array items: $ref: '#/components/schemas/GoogleCloudDialogflowCxV3BoostSpecs' filterSpecs: - description: Optional. Filter configuration for the datastores. + description: >- + Optional. Filter configuration for the datastores. Maps from + datastore name to the filter expression for that datastore. Do not + specify more than one FilterSpecs for each datastore name. If + multiple FilterSpecs are provided for the same datastore name, the + behavior is undefined. type: array items: $ref: '#/components/schemas/GoogleCloudDialogflowCxV3FilterSpecs' @@ -3141,7 +3414,7 @@ components: conditionBoostSpecs: description: >- Optional. Condition boost specifications. If a document matches - multiple conditions in the specifictions, boost scores from these + multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. type: array @@ -3313,6 +3586,9 @@ components: dtmf: description: The DTMF event to be handled. $ref: '#/components/schemas/GoogleCloudDialogflowCxV3DtmfInput' + toolCallResult: + description: The results of a tool executed by the client. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3ToolCallResult' languageCode: description: >- Required. The language of the input. See [Language @@ -3372,7 +3648,9 @@ components: type: string enumDescriptions: - Not specified. - - Uncompressed 16-bit signed little-endian samples (Linear PCM). + - >- + Uncompressed 16-bit signed little-endian samples (Linear PCM). + LINT: LEGACY_NAMES - >- [`FLAC`](https://xiph.org/flac/documentation.html) (Free Lossless Audio Codec) is the recommended encoding because it is lossless @@ -3517,8 +3795,8 @@ components: been detected. Note that no-speech event is not expected in this phase. The client provides this configuration in terms of the durations of those two phases. The durations are measured in terms of the audio - length from the the start of the input audio. No-speech event is a - response with END_OF_UTTERANCE without any transcript following up. + length from the start of the input audio. No-speech event is a response + with END_OF_UTTERANCE without any transcript following up. type: object properties: noBargeInDuration: @@ -3550,6 +3828,38 @@ components: finishDigit: description: The finish digit (if any). type: string + GoogleCloudDialogflowCxV3ToolCallResult: + id: GoogleCloudDialogflowCxV3ToolCallResult + description: >- + The result of calling a tool's action that has been executed by the + client. + type: object + properties: + tool: + description: >- + Required. The tool associated with this call. Format: + `projects//locations//agents//tools/`. + type: string + action: + description: Required. The name of the tool's action associated with this call. + type: string + error: + description: The tool call's error. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3ToolCallResultError' + outputParameters: + description: The tool call's output parameters. + type: object + additionalProperties: + type: any + description: Properties of the object. + GoogleCloudDialogflowCxV3ToolCallResultError: + id: GoogleCloudDialogflowCxV3ToolCallResultError + description: An error produced by the tool call. + type: object + properties: + message: + description: Optional. The error message of the function. + type: string GoogleCloudDialogflowCxV3OutputAudioConfig: id: GoogleCloudDialogflowCxV3OutputAudioConfig description: >- @@ -3565,8 +3875,9 @@ components: - >- Uncompressed 16-bit signed little-endian samples (Linear PCM). Audio content returned as LINEAR16 also contains a WAV header. + LINT: LEGACY_NAMES - MP3 audio at 32kbps. - - MP3 audio at 64kbps. + - 'MP3 audio at 64kbps. LINT: LEGACY_NAMES' - >- Opus encoded audio wrapped in an ogg container. The result will be a file which can be played natively on Android, and in browsers @@ -3802,9 +4113,7 @@ components: dataStoreConnectionSignals: description: >- Optional. Data store connection feature output signals. Filled only - when data stores are involved in serving the query and - DetectIntentRequest.populate_data_store_connection_signals is set to - true in the request. + when data stores are involved in serving the query. $ref: >- #/components/schemas/GoogleCloudDialogflowCxV3DataStoreConnectionSignals GoogleCloudDialogflowCxV3Match: @@ -3986,6 +4295,12 @@ components: text: description: Text included in the prompt. type: string + metadata: + description: Metadata associated with the document. + type: object + additionalProperties: + type: any + description: Properties of the object. GoogleCloudDialogflowCxV3DataStoreConnectionSignalsAnswerGenerationModelCallSignals: id: >- GoogleCloudDialogflowCxV3DataStoreConnectionSignalsAnswerGenerationModelCallSignals @@ -4904,11 +5219,28 @@ components: description: The password for HTTP Basic authentication. deprecated: true type: string + secretVersionForUsernamePassword: + description: >- + Optional. The SecretManager secret version resource storing the + username:password pair for HTTP Basic authentication. Format: + `projects/{project}/secrets/{secret}/versions/{version}` + type: string requestHeaders: description: The HTTP request headers to send together with webhook requests. type: object additionalProperties: type: string + secretVersionsForRequestHeaders: + description: >- + Optional. The HTTP request headers to send together with webhook + requests. Header values are stored in SecretManager secret versions. + When the same header name is specified in both `request_headers` and + `secret_versions_for_request_headers`, the value in + `secret_versions_for_request_headers` will be used. + type: object + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3WebhookGenericWebServiceSecretVersionHeaderValue allowedCaCerts: description: >- Optional. Specifies a list of allowed custom CA certificates (in DER @@ -5006,6 +5338,20 @@ components: type: object additionalProperties: type: string + GoogleCloudDialogflowCxV3WebhookGenericWebServiceSecretVersionHeaderValue: + id: >- + GoogleCloudDialogflowCxV3WebhookGenericWebServiceSecretVersionHeaderValue + description: >- + Represents the value of an HTTP header stored in a SecretManager secret + version. + type: object + properties: + secretVersion: + description: >- + Required. The SecretManager secret version resource storing the + header value. Format: + `projects/{project}/secrets/{secret}/versions/{version}` + type: string GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig: id: GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig description: >- @@ -5017,7 +5363,14 @@ components: description: Required. The client ID provided by the 3rd party platform. type: string clientSecret: - description: Required. The client secret provided by the 3rd party platform. + description: Optional. The client secret provided by the 3rd party platform. + type: string + secretVersionForClientSecret: + description: >- + Optional. The name of the SecretManager secret version resource + storing the client secret. If this field is set, the `client_secret` + field will be ignored. Format: + `projects/{project}/secrets/{secret}/versions/{version}` type: string tokenEndpoint: description: >- @@ -5124,10 +5477,11 @@ components: properties: version: description: >- - Required. Both flow and playbook versions are supported. Format for + Required. Flow, playbook and tool versions are supported. Format for flow version: projects//locations//agents//flows//versions/. Format for playbook version: - projects//locations//agents//playbooks//versions/. + projects//locations//agents//playbooks//versions/. Format for tool + version: projects//locations//agents//tools//versions/. type: string GoogleCloudDialogflowCxV3EnvironmentTestCasesConfig: id: GoogleCloudDialogflowCxV3EnvironmentTestCasesConfig @@ -5246,142 +5600,437 @@ components: Required. The flow version to deploy. Format: `projects//locations//agents//flows//versions/`. type: string - GoogleCloudDialogflowCxV3ListExperimentsResponse: - id: GoogleCloudDialogflowCxV3ListExperimentsResponse - description: The response message for Experiments.ListExperiments. - type: object - properties: - experiments: - description: >- - The list of experiments. There will be a maximum number of items - returned based on the page_size field in the request. The list may - in some cases be empty or contain fewer entries than page_size even - if this isn't the last page. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Experiment' - nextPageToken: - description: >- - Token to retrieve the next page of results, or empty if there are no - more results in the list. - type: string - GoogleCloudDialogflowCxV3Experiment: - id: GoogleCloudDialogflowCxV3Experiment - description: Represents an experiment in an environment. + GoogleCloudDialogflowCxV3Example: + id: GoogleCloudDialogflowCxV3Example + description: >- + Example represents a sample execution of the playbook in the + conversation. An example consists of a list of ordered actions performed + by end user or Dialogflow agent according the playbook instructions to + fulfill the task. type: object properties: name: description: >- - The name of the experiment. Format: - projects//locations//agents//environments//experiments/. + The unique identifier of the playbook example. Format: + `projects//locations//agents//playbooks//examples/`. type: string - displayName: + playbookInput: + description: Optional. The input to the playbook in the example. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3PlaybookInput' + playbookOutput: + description: Optional. The output of the playbook in the example. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3PlaybookOutput' + actions: description: >- - Required. The human-readable name of the experiment (unique in an - environment). Limit of 64 characters. + Required. The ordered list of actions performed by the end user and + the Dialogflow agent. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Action' + displayName: + description: Required. The display name of the example. type: string description: - description: The human-readable description of the experiment. - type: string - state: description: >- - The current state of the experiment. Transition triggered by - Experiments.StartExperiment: DRAFT->RUNNING. Transition triggered by - Experiments.CancelExperiment: DRAFT->DONE or RUNNING->DONE. + Optional. The high level concise description of the example. The max + number of characters is 200. type: string - enumDescriptions: - - State unspecified. - - The experiment is created but not started yet. - - The experiment is running. - - The experiment is done. - - The experiment with auto-rollout enabled has failed. - enum: - - STATE_UNSPECIFIED - - DRAFT - - RUNNING - - DONE - - ROLLOUT_FAILED - definition: - description: The definition of the experiment. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3ExperimentDefinition' - rolloutConfig: - description: >- - The configuration for auto rollout. If set, there should be exactly - two variants in the experiment (control variant being the default - version of the flow), the traffic allocation for the non-control - variant will gradually increase to 100% when conditions are met, and - eventually replace the control variant to become the default version - of the flow. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3RolloutConfig' - rolloutState: - description: State of the auto rollout process. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3RolloutState' - rolloutFailureReason: + tokenCount: description: >- - The reason why rollout has failed. Should only be set when state is - ROLLOUT_FAILED. + Output only. Estimated number of tokes current example takes when + sent to the LLM. + readOnly: true type: string - result: - description: Inference result of the experiment. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3ExperimentResult' + format: int64 createTime: - description: Creation time of this experiment. - type: string - format: google-datetime - startTime: - description: Start time of this experiment. + description: Output only. The timestamp of initial example creation. + readOnly: true type: string format: google-datetime - endTime: - description: End time of this experiment. + updateTime: + description: Output only. Last time the example was updated. + readOnly: true type: string format: google-datetime - lastUpdateTime: - description: Last update time of this experiment. + conversationState: + description: Required. Example's output state. type: string - format: google-datetime - experimentLength: + enumDescriptions: + - Unspecified output. + - Succeeded. + - Cancelled. + - Failed. + - Escalated. + - Pending. + enum: + - OUTPUT_STATE_UNSPECIFIED + - OUTPUT_STATE_OK + - OUTPUT_STATE_CANCELLED + - OUTPUT_STATE_FAILED + - OUTPUT_STATE_ESCALATED + - OUTPUT_STATE_PENDING + languageCode: description: >- - Maximum number of days to run the experiment/rollout. If - auto-rollout is not enabled, default value and maximum will be 30 - days. If auto-rollout is enabled, default value and maximum will be - 6 days. + Optional. The language code of the example. If not specified, the + agent's default language is used. Note: languages must be enabled in + the agent before they can be used. Note: example's language code is + not currently used in dialogflow agents. type: string - format: google-duration - variantsHistory: - description: The history of updates to the experiment variants. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3VariantsHistory' - GoogleCloudDialogflowCxV3ExperimentDefinition: - id: GoogleCloudDialogflowCxV3ExperimentDefinition - description: Definition of the experiment. + GoogleCloudDialogflowCxV3PlaybookInput: + id: GoogleCloudDialogflowCxV3PlaybookInput + description: Input of the playbook. type: object properties: - condition: + precedingConversationSummary: description: >- - The condition defines which subset of sessions are selected for this - experiment. If not specified, all sessions are eligible. E.g. - "query_input.language_code=en" See the [conditions - reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). + Optional. Summary string of the preceding conversation for the child + playbook invocation. type: string - versionVariants: - description: The flow versions as the variants of this experiment. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3VersionVariants' - GoogleCloudDialogflowCxV3VersionVariants: - id: GoogleCloudDialogflowCxV3VersionVariants - description: A list of flow version variants. + GoogleCloudDialogflowCxV3PlaybookOutput: + id: GoogleCloudDialogflowCxV3PlaybookOutput + description: Output of the playbook. type: object properties: - variants: - description: A list of flow version variants. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3VersionVariantsVariant - GoogleCloudDialogflowCxV3VersionVariantsVariant: - id: GoogleCloudDialogflowCxV3VersionVariantsVariant - description: A single flow version with specified traffic allocation. + executionSummary: + description: >- + Optional. Summary string of the execution result of the child + playbook. + type: string + GoogleCloudDialogflowCxV3Action: + id: GoogleCloudDialogflowCxV3Action + description: Action performed by end user or Dialogflow agent in the conversation. + type: object + properties: + userUtterance: + description: Optional. Agent obtained a message from the customer. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3UserUtterance' + agentUtterance: + description: Optional. Action performed by the agent as a message. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3AgentUtterance' + toolUse: + description: >- + Optional. Action performed on behalf of the agent by calling a + plugin tool. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3ToolUse' + playbookInvocation: + description: >- + Optional. Action performed on behalf of the agent by invoking a + child playbook. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3PlaybookInvocation' + flowInvocation: + description: >- + Optional. Action performed on behalf of the agent by invoking a CX + flow. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3FlowInvocation' + playbookTransition: + description: >- + Optional. Action performed on behalf of the agent by transitioning + to a target playbook. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3PlaybookTransition' + flowTransition: + description: >- + Optional. Action performed on behalf of the agent by transitioning + to a target CX flow. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3FlowTransition' + GoogleCloudDialogflowCxV3UserUtterance: + id: GoogleCloudDialogflowCxV3UserUtterance + description: UserUtterance represents one message sent by the customer. + type: object + properties: + text: + description: Required. Message content in text. + type: string + GoogleCloudDialogflowCxV3AgentUtterance: + id: GoogleCloudDialogflowCxV3AgentUtterance + description: AgentUtterance represents one message sent by the agent. + type: object + properties: + text: + description: Required. Message content in text. + type: string + GoogleCloudDialogflowCxV3ToolUse: + id: GoogleCloudDialogflowCxV3ToolUse + description: Stores metadata of the invocation of an action supported by a tool. + type: object + properties: + tool: + description: >- + Required. The tool that should be used. Format: + `projects//locations//agents//tools/`. + type: string + displayName: + description: Output only. The display name of the tool. + readOnly: true + type: string + action: + description: Optional. Name of the action to be called during the tool use. + type: string + inputActionParameters: + description: Optional. A list of input parameters for the action. + type: object + additionalProperties: + type: any + description: Properties of the object. + outputActionParameters: + description: Optional. A list of output parameters generated by the action. + type: object + additionalProperties: + type: any + description: Properties of the object. + GoogleCloudDialogflowCxV3PlaybookInvocation: + id: GoogleCloudDialogflowCxV3PlaybookInvocation + description: Stores metadata of the invocation of a child playbook. + type: object + properties: + playbook: + description: >- + Required. The unique identifier of the playbook. Format: + `projects//locations//agents//playbooks/`. + type: string + displayName: + description: Output only. The display name of the playbook. + readOnly: true + type: string + playbookInput: + description: Optional. Input of the child playbook invocation. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3PlaybookInput' + playbookOutput: + description: Optional. Output of the child playbook invocation. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3PlaybookOutput' + playbookState: + description: Required. Playbook invocation's output state. + type: string + enumDescriptions: + - Unspecified output. + - Succeeded. + - Cancelled. + - Failed. + - Escalated. + - Pending. + enum: + - OUTPUT_STATE_UNSPECIFIED + - OUTPUT_STATE_OK + - OUTPUT_STATE_CANCELLED + - OUTPUT_STATE_FAILED + - OUTPUT_STATE_ESCALATED + - OUTPUT_STATE_PENDING + GoogleCloudDialogflowCxV3FlowInvocation: + id: GoogleCloudDialogflowCxV3FlowInvocation + description: Stores metadata of the invocation of a CX flow. + type: object + properties: + flow: + description: >- + Required. The unique identifier of the flow. Format: + `projects//locations//agents//flows/`. + type: string + displayName: + description: Output only. The display name of the flow. + readOnly: true + type: string + flowState: + description: Required. Flow invocation's output state. + type: string + enumDescriptions: + - Unspecified output. + - Succeeded. + - Cancelled. + - Failed. + - Escalated. + - Pending. + enum: + - OUTPUT_STATE_UNSPECIFIED + - OUTPUT_STATE_OK + - OUTPUT_STATE_CANCELLED + - OUTPUT_STATE_FAILED + - OUTPUT_STATE_ESCALATED + - OUTPUT_STATE_PENDING + GoogleCloudDialogflowCxV3PlaybookTransition: + id: GoogleCloudDialogflowCxV3PlaybookTransition + description: >- + Stores metadata of the transition to another target playbook. Playbook + transition actions exit the caller playbook and enter the target + playbook. + type: object + properties: + playbook: + description: >- + Required. The unique identifier of the playbook. Format: + `projects//locations//agents//playbooks/`. + type: string + displayName: + description: Output only. The display name of the playbook. + readOnly: true + type: string + GoogleCloudDialogflowCxV3FlowTransition: + id: GoogleCloudDialogflowCxV3FlowTransition + description: >- + Stores metadata of the transition to a target CX flow. Flow transition + actions exit the caller playbook and enter the child flow. + type: object + properties: + flow: + description: >- + Required. The unique identifier of the flow. Format: + `projects//locations//agents/`. + type: string + displayName: + description: Output only. The display name of the flow. + readOnly: true + type: string + GoogleCloudDialogflowCxV3ListExamplesResponse: + id: GoogleCloudDialogflowCxV3ListExamplesResponse + description: The response message for Examples.ListExamples. + type: object + properties: + examples: + description: >- + The list of examples. There will be a maximum number of items + returned based on the page_size field in the request. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Example' + nextPageToken: + description: >- + Token to retrieve the next page of results, or empty if there are no + more results in the list. + type: string + GoogleCloudDialogflowCxV3ListExperimentsResponse: + id: GoogleCloudDialogflowCxV3ListExperimentsResponse + description: The response message for Experiments.ListExperiments. + type: object + properties: + experiments: + description: >- + The list of experiments. There will be a maximum number of items + returned based on the page_size field in the request. The list may + in some cases be empty or contain fewer entries than page_size even + if this isn't the last page. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Experiment' + nextPageToken: + description: >- + Token to retrieve the next page of results, or empty if there are no + more results in the list. + type: string + GoogleCloudDialogflowCxV3Experiment: + id: GoogleCloudDialogflowCxV3Experiment + description: Represents an experiment in an environment. + type: object + properties: + name: + description: >- + The name of the experiment. Format: + projects//locations//agents//environments//experiments/. + type: string + displayName: + description: >- + Required. The human-readable name of the experiment (unique in an + environment). Limit of 64 characters. + type: string + description: + description: The human-readable description of the experiment. + type: string + state: + description: >- + The current state of the experiment. Transition triggered by + Experiments.StartExperiment: DRAFT->RUNNING. Transition triggered by + Experiments.CancelExperiment: DRAFT->DONE or RUNNING->DONE. + type: string + enumDescriptions: + - State unspecified. + - The experiment is created but not started yet. + - The experiment is running. + - The experiment is done. + - The experiment with auto-rollout enabled has failed. + enum: + - STATE_UNSPECIFIED + - DRAFT + - RUNNING + - DONE + - ROLLOUT_FAILED + definition: + description: The definition of the experiment. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3ExperimentDefinition' + rolloutConfig: + description: >- + The configuration for auto rollout. If set, there should be exactly + two variants in the experiment (control variant being the default + version of the flow), the traffic allocation for the non-control + variant will gradually increase to 100% when conditions are met, and + eventually replace the control variant to become the default version + of the flow. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3RolloutConfig' + rolloutState: + description: State of the auto rollout process. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3RolloutState' + rolloutFailureReason: + description: >- + The reason why rollout has failed. Should only be set when state is + ROLLOUT_FAILED. + type: string + result: + description: Inference result of the experiment. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3ExperimentResult' + createTime: + description: Creation time of this experiment. + type: string + format: google-datetime + startTime: + description: Start time of this experiment. + type: string + format: google-datetime + endTime: + description: End time of this experiment. + type: string + format: google-datetime + lastUpdateTime: + description: Last update time of this experiment. + type: string + format: google-datetime + experimentLength: + description: >- + Maximum number of days to run the experiment/rollout. If + auto-rollout is not enabled, default value and maximum will be 30 + days. If auto-rollout is enabled, default value and maximum will be + 6 days. + type: string + format: google-duration + variantsHistory: + description: The history of updates to the experiment variants. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3VariantsHistory' + GoogleCloudDialogflowCxV3ExperimentDefinition: + id: GoogleCloudDialogflowCxV3ExperimentDefinition + description: Definition of the experiment. + type: object + properties: + condition: + description: >- + The condition defines which subset of sessions are selected for this + experiment. If not specified, all sessions are eligible. E.g. + "query_input.language_code=en" See the [conditions + reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). + type: string + versionVariants: + description: The flow versions as the variants of this experiment. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3VersionVariants' + GoogleCloudDialogflowCxV3VersionVariants: + id: GoogleCloudDialogflowCxV3VersionVariants + description: A list of flow version variants. + type: object + properties: + variants: + description: A list of flow version variants. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3VersionVariantsVariant + GoogleCloudDialogflowCxV3VersionVariantsVariant: + id: GoogleCloudDialogflowCxV3VersionVariantsVariant + description: A single flow version with specified traffic allocation. type: object properties: version: @@ -5660,6 +6309,9 @@ components: type: array items: $ref: '#/components/schemas/GoogleCloudDialogflowCxV3GeneratorPlaceholder' + llmModelSettings: + description: The LLM model settings. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3LlmModelSettings' modelParameter: description: Parameters passed to the LLM to configure its behavior. $ref: >- @@ -5718,940 +6370,965 @@ components: Small topK = less random. Large topK = more random. type: integer format: int32 - GoogleCloudDialogflowCxV3ListVersionsResponse: - id: GoogleCloudDialogflowCxV3ListVersionsResponse - description: The response message for Versions.ListVersions. - type: object - properties: - versions: - description: >- - A list of versions. There will be a maximum number of items returned - based on the page_size field in the request. The list may in some - cases be empty or contain fewer entries than page_size even if this - isn't the last page. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Version' - nextPageToken: - description: >- - Token to retrieve the next page of results, or empty if there are no - more results in the list. - type: string - GoogleCloudDialogflowCxV3Version: - id: GoogleCloudDialogflowCxV3Version - description: Represents a version of a flow. + GoogleCloudDialogflowCxV3Playbook: + id: GoogleCloudDialogflowCxV3Playbook + description: >- + Playbook is the basic building block to instruct the LLM how to execute + a certain task. A playbook consists of a goal to accomplish, an optional + list of step by step instructions (the step instruction may refers to + name of the custom or default plugin tools to use) to perform the task, + a list of contextual input data to be passed in at the beginning of the + invoked, and a list of output parameters to store the playbook result. type: object properties: name: description: >- - Format: projects//locations//agents//flows//versions/. Version ID is - a self-increasing number generated by Dialogflow upon version - creation. + The unique identifier of the playbook. Format: + `projects//locations//agents//playbooks/`. type: string displayName: description: >- - Required. The human-readable name of the version. Limit of 64 - characters. + Required. The human-readable name of the playbook, unique within an + agent. type: string - description: + goal: description: >- - The description of the version. The maximum length is 500 - characters. If exceeded, the request is rejected. + Required. High level description of the goal the playbook intend to + accomplish. A goal should be concise since it's visible to other + playbooks that may reference this playbook. type: string - nluSettings: - description: Output only. The NLU settings of the flow at version creation. + inputParameterDefinitions: + description: Optional. Defined structured input parameters for this playbook. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3ParameterDefinition' + outputParameterDefinitions: + description: Optional. Defined structured output parameters for this playbook. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3ParameterDefinition' + instruction: + description: Instruction to accomplish target goal. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3PlaybookInstruction' + tokenCount: + description: >- + Output only. Estimated number of tokes current playbook takes when + sent to the LLM. readOnly: true - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3NluSettings' + type: string + format: int64 createTime: - description: Output only. Create time of the version. + description: Output only. The timestamp of initial playbook creation. readOnly: true type: string format: google-datetime - state: + updateTime: + description: Output only. Last time the playbook version was updated. + readOnly: true + type: string + format: google-datetime + referencedPlaybooks: description: >- - Output only. The state of this version. This field is read-only and - cannot be set by create and update methods. + Output only. The resource name of other playbooks referenced by the + current playbook in the instructions. + readOnly: true + type: array + items: + type: string + referencedFlows: + description: >- + Output only. The resource name of flows referenced by the current + playbook in the instructions. readOnly: true + type: array + items: + type: string + referencedTools: + description: >- + Optional. The resource name of tools referenced by the current + playbook in the instructions. If not provided explicitly, they are + will be implied using the tool being referenced in goal and steps. + type: array + items: + type: string + llmModelSettings: + description: Optional. Llm model settings for the playbook. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3LlmModelSettings' + handlers: + description: >- + Optional. A list of registered handlers to execuate based on the + specified triggers. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Handler' + playbookType: + description: Optional. Type of the playbook. type: string enumDescriptions: - - Not specified. This value is not used. - - Version is not ready to serve (e.g. training is running). - - Training has succeeded and this version is ready to serve. - - Version training failed. + - Unspecified type. Default to TASK. + - Task playbook. + - Routine playbook. enum: - - STATE_UNSPECIFIED - - RUNNING - - SUCCEEDED - - FAILED - GoogleCloudDialogflowCxV3LoadVersionRequest: - id: GoogleCloudDialogflowCxV3LoadVersionRequest - description: The request message for Versions.LoadVersion. - type: object - properties: - allowOverrideAgentResources: - description: >- - This field is used to prevent accidental overwrite of other agent - resources, which can potentially impact other flow's behavior. If - `allow_override_agent_resources` is false, conflicted agent-level - resources will not be overridden (i.e. intents, entities, webhooks). - type: boolean - GoogleCloudDialogflowCxV3CompareVersionsRequest: - id: GoogleCloudDialogflowCxV3CompareVersionsRequest - description: The request message for Versions.CompareVersions. + - PLAYBOOK_TYPE_UNSPECIFIED + - TASK + - ROUTINE + GoogleCloudDialogflowCxV3PlaybookInstruction: + id: GoogleCloudDialogflowCxV3PlaybookInstruction + description: Message of the Instruction of the playbook. type: object properties: - targetVersion: + guidelines: description: >- - Required. Name of the target flow version to compare with the base - version. Use version ID `0` to indicate the draft version of the - specified flow. Format: - `projects//locations//agents//flows//versions/`. + General guidelines for the playbook. These are unstructured + instructions that are not directly part of the goal, e.g. "Always be + polite". It's valid for this text to be long and used instead of + steps altogether. type: string - languageCode: + steps: description: >- - The language to compare the flow versions for. If not specified, the - agent's default language is used. [Many - languages](https://cloud.google.com/dialogflow/docs/reference/language) - are supported. Note: languages must be enabled in the agent before - they can be used. - type: string - GoogleCloudDialogflowCxV3CompareVersionsResponse: - id: GoogleCloudDialogflowCxV3CompareVersionsResponse - description: The response message for Versions.CompareVersions. + Ordered list of step by step execution instructions to accomplish + target goal. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3PlaybookStep' + GoogleCloudDialogflowCxV3PlaybookStep: + id: GoogleCloudDialogflowCxV3PlaybookStep + description: Message of single step execution. type: object properties: - baseVersionContentJson: - description: JSON representation of the base version content. - type: string - targetVersionContentJson: - description: JSON representation of the target version content. - type: string - compareTime: - description: The timestamp when the two version compares. + text: + description: Step instruction in text format. type: string - format: google-datetime - GoogleCloudLocationListLocationsResponse: - id: GoogleCloudLocationListLocationsResponse - description: The response message for Locations.ListLocations. - type: object - properties: - locations: - description: >- - A list of locations that matches the specified filter in the - request. + steps: + description: Sub-processing needed to execute the current step. type: array items: - $ref: '#/components/schemas/GoogleCloudLocationLocation' - nextPageToken: - description: The standard List next-page token. - type: string - GoogleCloudLocationLocation: - id: GoogleCloudLocationLocation - description: A resource that represents a Google Cloud location. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3PlaybookStep' + GoogleCloudDialogflowCxV3Handler: + id: GoogleCloudDialogflowCxV3Handler + description: >- + Handler can be used to define custom logic to be executed based on the + user-specified triggers. type: object properties: - name: + eventHandler: + description: A handler triggered by event. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3HandlerEventHandler' + lifecycleHandler: description: >- - Resource name for the location, which may vary between - implementations. For example: - `"projects/example-project/locations/us-east1"` - type: string - locationId: - description: 'The canonical id for this location. For example: `"us-east1"`.' + A handler triggered during specific lifecycle of the playbook + execution. + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3HandlerLifecycleHandler + GoogleCloudDialogflowCxV3HandlerEventHandler: + id: GoogleCloudDialogflowCxV3HandlerEventHandler + description: A handler that is triggered by the specified event. + type: object + properties: + event: + description: Required. The name of the event that triggers this handler. type: string - displayName: + condition: description: >- - The friendly name for this location, typically a nearby city name. - For example, "Tokyo". + Optional. The condition that must be satisfied to trigger this + handler. type: string - labels: - description: >- - Cross-service attributes for the location. For example - {"cloud.googleapis.com/region": "us-east1"} - type: object - additionalProperties: - type: string - metadata: - description: >- - Service-specific metadata. For example the available capacity at the - given location. - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - GoogleCloudDialogflowCxV3CreateVersionOperationMetadata: - id: GoogleCloudDialogflowCxV3CreateVersionOperationMetadata + fulfillment: + description: Required. The fulfillment to call when the event occurs. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Fulfillment' + GoogleCloudDialogflowCxV3HandlerLifecycleHandler: + id: GoogleCloudDialogflowCxV3HandlerLifecycleHandler description: >- - Metadata associated with the long running operation for - Versions.CreateVersion. + A handler that is triggered on the specific lifecycle_stage of the + playbook execution. type: object properties: - version: + lifecycleStage: description: >- - Name of the created version. Format: - `projects//locations//agents//flows//versions/`. + Required. The name of the lifecycle stage that triggers this + handler. Supported values: * `playbook-start` * + `pre-action-selection` * `pre-action-execution` type: string - GoogleCloudDialogflowCxV3ExportAgentResponse: - id: GoogleCloudDialogflowCxV3ExportAgentResponse - description: The response message for Agents.ExportAgent. - type: object - properties: - agentUri: + condition: description: >- - The URI to a file containing the exported agent. This field is - populated if `agent_uri` is specified in ExportAgentRequest. + Optional. The condition that must be satisfied to trigger this + handler. type: string - agentContent: + fulfillment: + description: Required. The fulfillment to call when this handler is triggered. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Fulfillment' + GoogleCloudDialogflowCxV3ListPlaybooksResponse: + id: GoogleCloudDialogflowCxV3ListPlaybooksResponse + description: The response message for Playbooks.ListPlaybooks. + type: object + properties: + playbooks: description: >- - Uncompressed raw byte content for agent. This field is populated if - none of `agent_uri` and `git_destination` are specified in - ExportAgentRequest. - type: string - format: byte - commitSha: + The list of playbooks. There will be a maximum number of items + returned based on the page_size field in the request. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Playbook' + nextPageToken: description: >- - Commit SHA of the git push. This field is populated if - `git_destination` is specified in ExportAgentRequest. + Token to retrieve the next page of results, or empty if there are no + more results in the list. type: string - GoogleCloudDialogflowCxV3ExportFlowResponse: - id: GoogleCloudDialogflowCxV3ExportFlowResponse - description: The response message for Flows.ExportFlow. + GoogleCloudDialogflowCxV3ExportPlaybookRequest: + id: GoogleCloudDialogflowCxV3ExportPlaybookRequest + description: The request message for Playbooks.ExportPlaybook. type: object properties: - flowUri: + playbookUri: description: >- - The URI to a file containing the exported flow. This field is - populated only if `flow_uri` is specified in ExportFlowRequest. + Optional. The [Google Cloud + Storage](https://cloud.google.com/storage/docs/) URI to export the + playbook to. The format of this URI must be `gs:///`. If left + unspecified, the serialized playbook is returned inline. Dialogflow + performs a write operation for the Cloud Storage object on the + caller's behalf, so your request authentication must have write + permissions for the object. For more information, see [Dialogflow + access + control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage). type: string - flowContent: - description: Uncompressed raw byte content for flow. + dataFormat: + description: >- + Optional. The data format of the exported agent. If not specified, + `BLOB` is assumed. type: string - format: byte - GoogleCloudDialogflowCxV3ExportIntentsMetadata: - id: GoogleCloudDialogflowCxV3ExportIntentsMetadata - description: Metadata returned for the Intents.ExportIntents long running operation. - type: object - properties: {} - GoogleCloudDialogflowCxV3ExportIntentsResponse: - id: GoogleCloudDialogflowCxV3ExportIntentsResponse - description: The response message for Intents.ExportIntents. + enumDescriptions: + - Unspecified format. + - Flow content will be exported as raw bytes. + - Flow content will be exported in JSON format. + enum: + - DATA_FORMAT_UNSPECIFIED + - BLOB + - JSON + GoogleCloudDialogflowCxV3ImportPlaybookRequest: + id: GoogleCloudDialogflowCxV3ImportPlaybookRequest + description: The request message for Playbooks.ImportPlaybook. type: object properties: - intentsUri: + playbookUri: description: >- - The URI to a file containing the exported intents. This field is - populated only if `intents_uri` is specified in - ExportIntentsRequest. + [Dialogflow access control] + (https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage). type: string - intentsContent: + playbookContent: + description: Uncompressed raw byte content for playbook. + type: string + format: byte + importStrategy: description: >- - Uncompressed byte content for intents. This field is populated only - if `intents_content_inline` is set to true in ExportIntentsRequest. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3InlineDestination' - GoogleCloudDialogflowCxV3InlineDestination: - id: GoogleCloudDialogflowCxV3InlineDestination + Optional. Specifies the import strategy used when resolving resource + conflicts. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3PlaybookImportStrategy' + GoogleCloudDialogflowCxV3PlaybookImportStrategy: + id: GoogleCloudDialogflowCxV3PlaybookImportStrategy description: >- - Inline destination for a Dialogflow operation that writes or exports - objects (e.g. intents) outside of Dialogflow. + The playbook import strategy used for resource conflict resolution + associated with an ImportPlaybookRequest. type: object properties: - content: + mainPlaybookImportStrategy: description: >- - Output only. The uncompressed byte content for the objects. Only - populated in responses. - readOnly: true + Optional. Specifies the import strategy used when resolving + conflicts with the main playbook. If not specified, 'CREATE_NEW' is + assumed. type: string - format: byte - GoogleCloudDialogflowCxV3ImportFlowResponse: - id: GoogleCloudDialogflowCxV3ImportFlowResponse - description: The response message for Flows.ImportFlow. - type: object - properties: - flow: + enumDescriptions: + - Unspecified. Treated as 'CREATE_NEW'. + - >- + Create a new resource with a numeric suffix appended to the end of + the existing display name. + - >- + Replace existing resource with incoming resource in the content to + be imported. + - >- + Keep existing resource and discard incoming resource in the + content to be imported. + - >- + Combine existing and incoming resources when a conflict is + encountered. + - Throw error if a conflict is encountered. + enum: + - IMPORT_STRATEGY_UNSPECIFIED + - IMPORT_STRATEGY_CREATE_NEW + - IMPORT_STRATEGY_REPLACE + - IMPORT_STRATEGY_KEEP + - IMPORT_STRATEGY_MERGE + - IMPORT_STRATEGY_THROW_ERROR + nestedResourceImportStrategy: description: >- - The unique identifier of the new flow. Format: - `projects//locations//agents//flows/`. + Optional. Specifies the import strategy used when resolving + referenced playbook/flow conflicts. If not specified, 'CREATE_NEW' + is assumed. type: string - GoogleCloudDialogflowCxV3ImportEntityTypesMetadata: - id: GoogleCloudDialogflowCxV3ImportEntityTypesMetadata - description: >- - Metadata returned for the EntityTypes.ImportEntityTypes long running - operation. - type: object - properties: {} - GoogleCloudDialogflowCxV3ImportEntityTypesResponse: - id: GoogleCloudDialogflowCxV3ImportEntityTypesResponse - description: The response message for EntityTypes.ImportEntityTypes. + enumDescriptions: + - Unspecified. Treated as 'CREATE_NEW'. + - >- + Create a new resource with a numeric suffix appended to the end of + the existing display name. + - >- + Replace existing resource with incoming resource in the content to + be imported. + - >- + Keep existing resource and discard incoming resource in the + content to be imported. + - >- + Combine existing and incoming resources when a conflict is + encountered. + - Throw error if a conflict is encountered. + enum: + - IMPORT_STRATEGY_UNSPECIFIED + - IMPORT_STRATEGY_CREATE_NEW + - IMPORT_STRATEGY_REPLACE + - IMPORT_STRATEGY_KEEP + - IMPORT_STRATEGY_MERGE + - IMPORT_STRATEGY_THROW_ERROR + toolImportStrategy: + description: >- + Optional. Specifies the import strategy used when resolving tool + conflicts. If not specified, 'CREATE_NEW' is assumed. This will be + applied after the main playbook and nested resource import + strategies, meaning if the playbook that references the tool is + skipped, the tool will also be skipped. + type: string + enumDescriptions: + - Unspecified. Treated as 'CREATE_NEW'. + - >- + Create a new resource with a numeric suffix appended to the end of + the existing display name. + - >- + Replace existing resource with incoming resource in the content to + be imported. + - >- + Keep existing resource and discard incoming resource in the + content to be imported. + - >- + Combine existing and incoming resources when a conflict is + encountered. + - Throw error if a conflict is encountered. + enum: + - IMPORT_STRATEGY_UNSPECIFIED + - IMPORT_STRATEGY_CREATE_NEW + - IMPORT_STRATEGY_REPLACE + - IMPORT_STRATEGY_KEEP + - IMPORT_STRATEGY_MERGE + - IMPORT_STRATEGY_THROW_ERROR + GoogleCloudDialogflowCxV3PlaybookVersion: + id: GoogleCloudDialogflowCxV3PlaybookVersion + description: Playbook version is a snapshot of the playbook at certain timestamp. type: object properties: - entityTypes: + name: description: >- - The unique identifier of the imported entity types. Format: - `projects//locations//agents//entity_types/`. - type: array - items: - type: string - conflictingResources: + The unique identifier of the playbook version. Format: + `projects//locations//agents//playbooks//versions/`. + type: string + description: + description: Optional. The description of the playbook version. + type: string + playbook: description: >- - Info which resources have conflicts when REPORT_CONFLICT - merge_option is set in ImportEntityTypesRequest. - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3ImportEntityTypesResponseConflictingResources - GoogleCloudDialogflowCxV3ImportEntityTypesResponseConflictingResources: - id: GoogleCloudDialogflowCxV3ImportEntityTypesResponseConflictingResources - description: >- - Conflicting resources detected during the import process. Only filled - when REPORT_CONFLICT is set in the request and there are conflicts in - the display names. - type: object - properties: - entityTypeDisplayNames: - description: Display names of conflicting entity types. - type: array - items: - type: string - entityDisplayNames: - description: Display names of conflicting entities. + Output only. Snapshot of the playbook when the playbook version is + created. + readOnly: true + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Playbook' + examples: + description: >- + Output only. Snapshot of the examples belonging to the playbook when + the playbook version is created. + readOnly: true type: array items: - type: string - GoogleCloudDialogflowCxV3ExportEntityTypesMetadata: - id: GoogleCloudDialogflowCxV3ExportEntityTypesMetadata - description: >- - Metadata returned for the EntityTypes.ExportEntityTypes long running - operation. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Example' + updateTime: + description: Output only. Last time the playbook version was created or modified. + readOnly: true + type: string + format: google-datetime + GoogleCloudDialogflowCxV3RestorePlaybookVersionRequest: + id: GoogleCloudDialogflowCxV3RestorePlaybookVersionRequest + description: The request message for Playbooks.RestorePlaybookVersion. type: object properties: {} - GoogleCloudDialogflowCxV3ExportEntityTypesResponse: - id: GoogleCloudDialogflowCxV3ExportEntityTypesResponse - description: The response message for EntityTypes.ExportEntityTypes. + GoogleCloudDialogflowCxV3RestorePlaybookVersionResponse: + id: GoogleCloudDialogflowCxV3RestorePlaybookVersionResponse + description: The response message for Playbooks.RestorePlaybookVersion. type: object properties: - entityTypesUri: - description: >- - The URI to a file containing the exported entity types. This field - is populated only if `entity_types_uri` is specified in - ExportEntityTypesRequest. - type: string - entityTypesContent: - description: >- - Uncompressed byte content for entity types. This field is populated - only if `entity_types_content_inline` is set to true in - ExportEntityTypesRequest. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3InlineDestination' - GoogleCloudDialogflowCxV3ImportIntentsMetadata: - id: GoogleCloudDialogflowCxV3ImportIntentsMetadata - description: Metadata returned for the Intents.ImportIntents long running operation. - type: object - properties: {} - GoogleCloudDialogflowCxV3ImportIntentsResponse: - id: GoogleCloudDialogflowCxV3ImportIntentsResponse - description: The response message for Intents.ImportIntents. + playbook: + description: The updated playbook. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Playbook' + GoogleCloudDialogflowCxV3ListPlaybookVersionsResponse: + id: GoogleCloudDialogflowCxV3ListPlaybookVersionsResponse + description: The response message for Playbooks.ListPlaybookVersions. type: object properties: - intents: + playbookVersions: description: >- - The unique identifier of the imported intents. Format: - `projects//locations//agents//intents/`. + The list of playbook version. There will be a maximum number of + items returned based on the page_size field in the request. type: array items: - type: string - conflictingResources: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3PlaybookVersion' + nextPageToken: description: >- - Info which resources have conflicts when REPORT_CONFLICT - merge_option is set in ImportIntentsRequest. - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources - GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources: - id: GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources + Token to retrieve the next page of results, or empty if there are no + more results in the list. + type: string + GoogleCloudDialogflowCxV3Tool: + id: GoogleCloudDialogflowCxV3Tool description: >- - Conflicting resources detected during the import process. Only filled - when REPORT_CONFLICT is set in the request and there are conflicts in - the display names. + A tool provides a list of actions which are available to the Playbook to + attain its goal. A Tool consists of a description of the tool's usage + and a specification of the tool which contains the schema and + authentication information. type: object properties: - intentDisplayNames: - description: Display names of conflicting intents. - type: array - items: - type: string - entityDisplayNames: - description: Display names of conflicting entities. - type: array - items: - type: string - GoogleCloudDialogflowCxV3WebhookRequest: - id: GoogleCloudDialogflowCxV3WebhookRequest + name: + description: >- + The unique identifier of the Tool. Format: + `projects//locations//agents//tools/`. + type: string + displayName: + description: >- + Required. The human-readable name of the Tool, unique within an + agent. + type: string + description: + description: Required. High level description of the Tool and its usage. + type: string + openApiSpec: + description: OpenAPI specification of the Tool. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3ToolOpenApiTool' + dataStoreSpec: + description: Data store search tool specification. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3ToolDataStoreTool' + functionSpec: + description: Client side executed function specification. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3ToolFunctionTool' + toolType: + description: Output only. The tool type. + readOnly: true + type: string + enumDescriptions: + - Default value. This value is unused. + - Customer provided tool. + - >- + First party built-in tool created by Dialogflow which cannot be + modified. + enum: + - TOOL_TYPE_UNSPECIFIED + - CUSTOMIZED_TOOL + - BUILTIN_TOOL + GoogleCloudDialogflowCxV3ToolOpenApiTool: + id: GoogleCloudDialogflowCxV3ToolOpenApiTool description: >- - The request message for a webhook call. The request is sent as a JSON - object and the field names will be presented in camel cases. You may see - undocumented fields in an actual request. These fields are used - internally by Dialogflow and should be ignored. + An OpenAPI tool is a way to provide the Tool specifications in the Open + API schema format. type: object properties: - detectIntentResponseId: - description: >- - Always present. The unique identifier of the DetectIntentResponse - that will be returned to the API caller. + textSchema: + description: Required. The OpenAPI schema specified as a text. type: string - text: + authentication: + description: Optional. Authentication information required by the API. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3ToolAuthentication' + tlsConfig: + description: Optional. TLS configuration for the HTTPS verification. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3ToolTLSConfig' + serviceDirectoryConfig: + description: Optional. Service Directory configuration. + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3ToolServiceDirectoryConfig + GoogleCloudDialogflowCxV3ToolAuthentication: + id: GoogleCloudDialogflowCxV3ToolAuthentication + description: Authentication information required for API calls + type: object + properties: + apiKeyConfig: + description: Config for API key auth. + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3ToolAuthenticationApiKeyConfig + oauthConfig: + description: Config for OAuth. + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3ToolAuthenticationOAuthConfig + serviceAgentAuthConfig: description: >- - If natural language text was provided as input, this field will - contain a copy of the text. - type: string - triggerIntent: + Config for [Diglogflow service + agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent) + auth. + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3ToolAuthenticationServiceAgentAuthConfig + bearerTokenConfig: + description: Config for bearer token auth. + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3ToolAuthenticationBearerTokenConfig + GoogleCloudDialogflowCxV3ToolAuthenticationApiKeyConfig: + id: GoogleCloudDialogflowCxV3ToolAuthenticationApiKeyConfig + description: Config for authentication with API key. + type: object + properties: + keyName: description: >- - If an intent was provided as input, this field will contain a copy - of the intent identifier. Format: - `projects//locations//agents//intents/`. + Required. The parameter name or the header name of the API key. + E.g., If the API request is "https://example.com/act?X-Api-Key=", + "X-Api-Key" would be the parameter name. type: string - transcript: + apiKey: description: >- - If natural language speech audio was provided as input, this field - will contain the transcript for the audio. + Optional. The API key. If the `secret_version_for_api_key` field is + set, this field will be ignored. type: string - triggerEvent: + secretVersionForApiKey: description: >- - If an event was provided as input, this field will contain the name - of the event. + Optional. The name of the SecretManager secret version resource + storing the API key. If this field is set, the `api_key` field will + be ignored. Format: + `projects/{project}/secrets/{secret}/versions/{version}` type: string - dtmfDigits: - description: >- - If DTMF was provided as input, this field will contain the DTMF - digits. + requestLocation: + description: Required. Key location in the request. type: string - languageCode: - description: The language code specified in the original request. + enumDescriptions: + - Default value. This value is unused. + - Represents the key in http header. + - Represents the key in query string. + enum: + - REQUEST_LOCATION_UNSPECIFIED + - HEADER + - QUERY_STRING + GoogleCloudDialogflowCxV3ToolAuthenticationOAuthConfig: + id: GoogleCloudDialogflowCxV3ToolAuthenticationOAuthConfig + description: Config for authentication with OAuth. + type: object + properties: + oauthGrantType: + description: Required. OAuth grant types. type: string - fulfillmentInfo: + enumDescriptions: + - Default value. This value is unused. + - >- + Represents the [client credential + flow](https://oauth.net/2/grant-types/client-credentials). + enum: + - OAUTH_GRANT_TYPE_UNSPECIFIED + - CLIENT_CREDENTIAL + clientId: + description: Required. The client ID from the OAuth provider. + type: string + clientSecret: description: >- - Always present. Information about the fulfillment that triggered - this webhook call. - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3WebhookRequestFulfillmentInfo - intentInfo: - description: Information about the last matched intent. - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3WebhookRequestIntentInfo - pageInfo: - description: Information about page status. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3PageInfo' - sessionInfo: - description: Information about session status. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3SessionInfo' - messages: + Optional. The client secret from the OAuth provider. If the + `secret_version_for_client_secret` field is set, this field will be + ignored. + type: string + secretVersionForClientSecret: description: >- - The list of rich message responses to present to the user. Webhook - can choose to append or replace this list in - WebhookResponse.fulfillment_response; + Optional. The name of the SecretManager secret version resource + storing the client secret. If this field is set, the `client_secret` + field will be ignored. Format: + `projects/{project}/secrets/{secret}/versions/{version}` + type: string + tokenEndpoint: + description: >- + Required. The token endpoint in the OAuth provider to exchange for + an access token. + type: string + scopes: + description: Optional. The OAuth scopes to grant. type: array items: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3ResponseMessage' - payload: - description: Custom data set in QueryParameters.payload. - type: object - additionalProperties: - type: any - description: Properties of the object. - sentimentAnalysisResult: - description: >- - The sentiment analysis result of the current user request. The field - is filled when sentiment analysis is configured to be enabled for - the request. - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3WebhookRequestSentimentAnalysisResult - languageInfo: - description: Information about the language of the request. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3LanguageInfo' - GoogleCloudDialogflowCxV3WebhookRequestFulfillmentInfo: - id: GoogleCloudDialogflowCxV3WebhookRequestFulfillmentInfo - description: Represents fulfillment information communicated to the webhook. + type: string + GoogleCloudDialogflowCxV3ToolAuthenticationServiceAgentAuthConfig: + id: GoogleCloudDialogflowCxV3ToolAuthenticationServiceAgentAuthConfig + description: >- + Config for auth using [Diglogflow service + agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). type: object properties: - tag: + serviceAgentAuth: description: >- - Always present. The value of the Fulfillment.tag field will be - populated in this field by Dialogflow when the associated webhook is - called. The tag is typically used by the webhook service to identify - which fulfillment is being called, but it could be used for other - purposes. + Optional. Indicate the auth token type generated from the + [Diglogflow service + agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). + The generated token is sent in the Authorization header. type: string - GoogleCloudDialogflowCxV3WebhookRequestIntentInfo: - id: GoogleCloudDialogflowCxV3WebhookRequestIntentInfo - description: Represents intent information communicated to the webhook. + enumDescriptions: + - Service agent auth type unspecified. Default to ID_TOKEN. + - >- + Use [ID + token](https://cloud.google.com/docs/authentication/token-types#id) + generated from service agent. This can be used to access Cloud + Function and Cloud Run after you grant Invoker role to + `service-@gcp-sa-dialogflow.iam.gserviceaccount.com`. + - >- + Use [access + token](https://cloud.google.com/docs/authentication/token-types#access) + generated from service agent. This can be used to access other + Google Cloud APIs after you grant required roles to + `service-@gcp-sa-dialogflow.iam.gserviceaccount.com`. + enum: + - SERVICE_AGENT_AUTH_UNSPECIFIED + - ID_TOKEN + - ACCESS_TOKEN + GoogleCloudDialogflowCxV3ToolAuthenticationBearerTokenConfig: + id: GoogleCloudDialogflowCxV3ToolAuthenticationBearerTokenConfig + description: Config for authentication using bearer token. type: object properties: - lastMatchedIntent: + token: description: >- - Always present. The unique identifier of the last matched intent. - Format: `projects//locations//agents//intents/`. - type: string - displayName: - description: Always present. The display name of the last matched intent. + Optional. The text token appended to the text `Bearer` to the + request Authorization header. [Session parameters + reference](https://cloud.google.com/dialogflow/cx/docs/concept/parameter#session-ref) + can be used to pass the token dynamically, e.g. + `$session.params.parameter-id`. type: string - parameters: - description: >- - Parameters identified as a result of intent matching. This is a map - of the name of the identified parameter to the value of the - parameter identified from the user's utterance. All parameters - defined in the matched intent that are identified will be surfaced - here. - type: object - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3WebhookRequestIntentInfoIntentParameterValue - confidence: + secretVersionForToken: description: >- - The confidence of the matched intent. Values range from 0.0 - (completely uncertain) to 1.0 (completely certain). - type: number - format: float - GoogleCloudDialogflowCxV3WebhookRequestIntentInfoIntentParameterValue: - id: GoogleCloudDialogflowCxV3WebhookRequestIntentInfoIntentParameterValue - description: Represents a value for an intent parameter. + Optional. The name of the SecretManager secret version resource + storing the Bearer token. If this field is set, the `token` field + will be ignored. Format: + `projects/{project}/secrets/{secret}/versions/{version}` + type: string + GoogleCloudDialogflowCxV3ToolTLSConfig: + id: GoogleCloudDialogflowCxV3ToolTLSConfig + description: The TLS configuration. type: object properties: - originalValue: - description: Always present. Original text value extracted from user utterance. - type: string - resolvedValue: + caCerts: description: >- - Always present. Structured value for the parameter extracted from - user utterance. - type: any - GoogleCloudDialogflowCxV3PageInfo: - id: GoogleCloudDialogflowCxV3PageInfo - description: Represents page information communicated to and from the webhook. + Required. Specifies a list of allowed custom CA certificates for + HTTPS verification. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3ToolTLSConfigCACert' + GoogleCloudDialogflowCxV3ToolTLSConfigCACert: + id: GoogleCloudDialogflowCxV3ToolTLSConfigCACert + description: The CA certificate. type: object properties: - currentPage: - description: >- - Always present for WebhookRequest. Ignored for WebhookResponse. The - unique identifier of the current page. Format: - `projects//locations//agents//flows//pages/`. - type: string displayName: description: >- - Always present for WebhookRequest. Ignored for WebhookResponse. The - display name of the current page. + Required. The name of the allowed custom CA certificates. This can + be used to disambiguate the custom CA certificates. type: string - formInfo: + cert: description: >- - Optional for both WebhookRequest and WebhookResponse. Information - about the form. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3PageInfoFormInfo' - GoogleCloudDialogflowCxV3PageInfoFormInfo: - id: GoogleCloudDialogflowCxV3PageInfoFormInfo - description: Represents form information. + Required. The allowed custom CA certificates (in DER format) for + HTTPS verification. This overrides the default SSL trust store. If + this is empty or unspecified, Dialogflow will use Google's default + trust store to verify certificates. N.B. Make sure the HTTPS server + certificates are signed with "subject alt name". For instance a + certificate can be self-signed using the following command: ``` + openssl x509 -req -days 200 -in example.com.csr \ -signkey + example.com.key \ -out example.com.crt \ -extfile <(printf + "\nsubjectAltName='DNS:www.example.com'") ``` + type: string + format: byte + GoogleCloudDialogflowCxV3ToolServiceDirectoryConfig: + id: GoogleCloudDialogflowCxV3ToolServiceDirectoryConfig + description: Configuration for tools using Service Directory. type: object properties: - parameterInfo: + service: description: >- - Optional for both WebhookRequest and WebhookResponse. The parameters - contained in the form. Note that the webhook cannot add or remove - any form parameter. + Required. The name of [Service + Directory](https://cloud.google.com/service-directory) service. + Format: `projects//locations//namespaces//services/`. `LocationID` + of the service directory must be the same as the location of the + agent. + type: string + GoogleCloudDialogflowCxV3ToolDataStoreTool: + id: GoogleCloudDialogflowCxV3ToolDataStoreTool + description: >- + A DataStoreTool is a way to provide specifications needed to search a + list of data stores. + type: object + properties: + dataStoreConnections: + description: Required. List of data stores to search. type: array items: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3PageInfoFormInfoParameterInfo - GoogleCloudDialogflowCxV3PageInfoFormInfoParameterInfo: - id: GoogleCloudDialogflowCxV3PageInfoFormInfoParameterInfo - description: Represents parameter information. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3DataStoreConnection' + fallbackPrompt: + description: Required. Fallback prompt configurations to use. + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3ToolDataStoreToolFallbackPrompt + GoogleCloudDialogflowCxV3ToolDataStoreToolFallbackPrompt: + id: GoogleCloudDialogflowCxV3ToolDataStoreToolFallbackPrompt + description: >- + A FallbackPrompt is a way to provide specifications for the Data Store + fallback prompt when generating responses. type: object - properties: - displayName: - description: >- - Always present for WebhookRequest. Required for WebhookResponse. The - human-readable name of the parameter, unique within the form. This - field cannot be modified by the webhook. - type: string - required: - description: >- - Optional for both WebhookRequest and WebhookResponse. Indicates - whether the parameter is required. Optional parameters will not - trigger prompts; however, they are filled if the user specifies - them. Required parameters must be filled before form filling - concludes. - type: boolean - state: - description: >- - Always present for WebhookRequest. Required for WebhookResponse. The - state of the parameter. This field can be set to INVALID by the - webhook to invalidate the parameter; other values set by the webhook - will be ignored. - type: string - enumDescriptions: - - Not specified. This value should be never used. - - Indicates that the parameter does not have a value. - - >- - Indicates that the parameter value is invalid. This field can be - used by the webhook to invalidate the parameter and ask the server - to collect it from the user again. - - Indicates that the parameter has a value. - enum: - - PARAMETER_STATE_UNSPECIFIED - - EMPTY - - INVALID - - FILLED - value: - description: >- - Optional for both WebhookRequest and WebhookResponse. The value of - the parameter. This field can be set by the webhook to change the - parameter value. - type: any - justCollected: - description: >- - Optional for WebhookRequest. Ignored for WebhookResponse. Indicates - if the parameter value was just collected on the last conversation - turn. - type: boolean - GoogleCloudDialogflowCxV3SessionInfo: - id: GoogleCloudDialogflowCxV3SessionInfo - description: Represents session information communicated to and from the webhook. + properties: {} + GoogleCloudDialogflowCxV3ToolFunctionTool: + id: GoogleCloudDialogflowCxV3ToolFunctionTool + description: >- + A Function tool describes the functions to be invoked on the client + side. type: object properties: - session: + inputSchema: description: >- - Always present for WebhookRequest. Ignored for WebhookResponse. The - unique identifier of the session. This field can be used by the - webhook to identify a session. Format: - `projects//locations//agents//sessions/` or - `projects//locations//agents//environments//sessions/` if - environment is specified. - type: string - parameters: + Optional. The JSON schema is encapsulated in a + google.protobuf.Struct to describe the input of the function. This + input is a JSON object that contains the function's parameters as + properties of the object. + type: object + additionalProperties: + type: any + description: Properties of the object. + outputSchema: description: >- - Optional for WebhookRequest. Optional for WebhookResponse. All - parameters collected from forms and intents during the session. - Parameters can be created, updated, or removed by the webhook. To - remove a parameter from the session, the webhook should explicitly - set the parameter value to null in WebhookResponse. The map is keyed - by parameters' display names. + Optional. The JSON schema is encapsulated in a + google.protobuf.Struct to describe the output of the function. This + output is a JSON object that contains the function's parameters as + properties of the object. type: object additionalProperties: type: any - GoogleCloudDialogflowCxV3WebhookRequestSentimentAnalysisResult: - id: GoogleCloudDialogflowCxV3WebhookRequestSentimentAnalysisResult - description: Represents the result of sentiment analysis. + description: Properties of the object. + GoogleCloudDialogflowCxV3ListToolsResponse: + id: GoogleCloudDialogflowCxV3ListToolsResponse + description: The response message for Tools.ListTools. type: object properties: - score: + tools: description: >- - Sentiment score between -1.0 (negative sentiment) and 1.0 (positive - sentiment). - type: number - format: float - magnitude: + The list of Tools. There will be a maximum number of items returned + based on the page_size field in the request. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Tool' + nextPageToken: description: >- - A non-negative number in the [0, +inf) range, which represents the - absolute magnitude of sentiment, regardless of score (positive or - negative). - type: number - format: float - GoogleCloudDialogflowCxV3LanguageInfo: - id: GoogleCloudDialogflowCxV3LanguageInfo - description: Represents the language information of the request. + Token to retrieve the next page of results, or empty if there are no + more results in the list. + type: string + GoogleCloudDialogflowCxV3ListToolVersionsResponse: + id: GoogleCloudDialogflowCxV3ListToolVersionsResponse + description: The response message for Tools.ListToolVersions. type: object properties: - inputLanguageCode: - description: The language code specified in the original request. - type: string - resolvedLanguageCode: + toolVersions: description: >- - The language code detected for this request based on the user - conversation. + The list of tool versions. There will be a maximum number of items + returned based on the page_size field in the request. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3ToolVersion' + nextPageToken: + description: >- + Token to retrieve the next page of results, or empty if there are no + more results in the list. type: string - confidenceScore: - description: The confidence score of the detected language between 0 and 1. - type: number - format: float - GoogleCloudDialogflowCxV3WebhookResponse: - id: GoogleCloudDialogflowCxV3WebhookResponse - description: The response message for a webhook call. + GoogleCloudDialogflowCxV3ToolVersion: + id: GoogleCloudDialogflowCxV3ToolVersion + description: Tool version is a snapshot of the tool at certain timestamp. type: object properties: - fulfillmentResponse: - description: >- - The fulfillment response to send to the user. This field can be - omitted by the webhook if it does not intend to send any response to - the user. - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3WebhookResponseFulfillmentResponse - pageInfo: - description: >- - Information about page status. This field can be omitted by the - webhook if it does not intend to modify page status. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3PageInfo' - sessionInfo: + name: description: >- - Information about session status. This field can be omitted by the - webhook if it does not intend to modify session status. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3SessionInfo' - payload: - description: Value to append directly to QueryResult.webhook_payloads. - type: object - additionalProperties: - type: any - description: Properties of the object. - targetPage: - description: >- - The target page to transition to. Format: - `projects//locations//agents//flows//pages/`. + Identifier. The unique identifier of the tool version. Format: + `projects//locations//agents//tools//versions/`. type: string - targetFlow: - description: >- - The target flow to transition to. Format: - `projects//locations//agents//flows/`. + displayName: + description: Required. The display name of the tool version. type: string - GoogleCloudDialogflowCxV3WebhookResponseFulfillmentResponse: - id: GoogleCloudDialogflowCxV3WebhookResponseFulfillmentResponse - description: Represents a fulfillment response to the user. + tool: + description: Required. Snapshot of the tool to be associated with this version. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Tool' + createTime: + description: Output only. Last time the tool version was created or modified. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. Last time the tool version was created or modified. + readOnly: true + type: string + format: google-datetime + GoogleCloudDialogflowCxV3RestoreToolVersionRequest: + id: GoogleCloudDialogflowCxV3RestoreToolVersionRequest + description: The request message for Tools.RestoreToolVersion. + type: object + properties: {} + GoogleCloudDialogflowCxV3RestoreToolVersionResponse: + id: GoogleCloudDialogflowCxV3RestoreToolVersionResponse + description: The response message for Tools.RestoreToolVersion. type: object properties: - messages: - description: The list of rich message responses to present to the user. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3ResponseMessage' - mergeBehavior: - description: Merge behavior for `messages`. - type: string - enumDescriptions: - - Not specified. `APPEND` will be used. - - >- - `messages` will be appended to the list of messages waiting to be - sent to the user. - - >- - `messages` will replace the list of messages waiting to be sent to - the user. - enum: - - MERGE_BEHAVIOR_UNSPECIFIED - - APPEND - - REPLACE - GoogleCloudDialogflowCxV3BatchRunTestCasesMetadata: - id: GoogleCloudDialogflowCxV3BatchRunTestCasesMetadata - description: >- - Metadata returned for the TestCases.BatchRunTestCases long running - operation. + tool: + description: The updated tool. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Tool' + GoogleCloudDialogflowCxV3ListVersionsResponse: + id: GoogleCloudDialogflowCxV3ListVersionsResponse + description: The response message for Versions.ListVersions. type: object properties: - errors: - description: The test errors. + versions: + description: >- + A list of versions. There will be a maximum number of items returned + based on the page_size field in the request. The list may in some + cases be empty or contain fewer entries than page_size even if this + isn't the last page. type: array items: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3TestError' - GoogleCloudDialogflowCxV3TestError: - id: GoogleCloudDialogflowCxV3TestError - description: Error info for running a test. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Version' + nextPageToken: + description: >- + Token to retrieve the next page of results, or empty if there are no + more results in the list. + type: string + GoogleCloudDialogflowCxV3Version: + id: GoogleCloudDialogflowCxV3Version + description: Represents a version of a flow. type: object properties: - testCase: - description: The test case resource name. + name: + description: >- + Format: projects//locations//agents//flows//versions/. Version ID is + a self-increasing number generated by Dialogflow upon version + creation. type: string - status: - description: The status associated with the test. - $ref: '#/components/schemas/GoogleRpcStatus' - testTime: - description: The timestamp when the test was completed. + displayName: + description: >- + Required. The human-readable name of the version. Limit of 64 + characters. + type: string + description: + description: >- + The description of the version. The maximum length is 500 + characters. If exceeded, the request is rejected. + type: string + nluSettings: + description: Output only. The NLU settings of the flow at version creation. + readOnly: true + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3NluSettings' + createTime: + description: Output only. Create time of the version. + readOnly: true type: string format: google-datetime - GoogleCloudDialogflowCxV3BatchRunTestCasesResponse: - id: GoogleCloudDialogflowCxV3BatchRunTestCasesResponse - description: The response message for TestCases.BatchRunTestCases. - type: object - properties: - results: + state: description: >- - The test case results. The detailed conversation turns are empty in - this response. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3TestCaseResult' - GoogleCloudDialogflowCxV3RunTestCaseMetadata: - id: GoogleCloudDialogflowCxV3RunTestCaseMetadata - description: >- - Metadata returned for the TestCases.RunTestCase long running operation. - This message currently has no fields. - type: object - properties: {} - GoogleCloudDialogflowCxV3RunTestCaseResponse: - id: GoogleCloudDialogflowCxV3RunTestCaseResponse - description: The response message for TestCases.RunTestCase. + Output only. The state of this version. This field is read-only and + cannot be set by create and update methods. + readOnly: true + type: string + enumDescriptions: + - Not specified. This value is not used. + - Version is not ready to serve (e.g. training is running). + - Training has succeeded and this version is ready to serve. + - Version training failed. + enum: + - STATE_UNSPECIFIED + - RUNNING + - SUCCEEDED + - FAILED + GoogleCloudDialogflowCxV3LoadVersionRequest: + id: GoogleCloudDialogflowCxV3LoadVersionRequest + description: The request message for Versions.LoadVersion. type: object properties: - result: - description: The result. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3TestCaseResult' - GoogleCloudDialogflowCxV3ExportTestCasesMetadata: - id: GoogleCloudDialogflowCxV3ExportTestCasesMetadata - description: >- - Metadata returned for the TestCases.ExportTestCases long running - operation. This message currently has no fields. - type: object - properties: {} - GoogleCloudDialogflowCxV3ExportTestCasesResponse: - id: GoogleCloudDialogflowCxV3ExportTestCasesResponse - description: The response message for TestCases.ExportTestCases. + allowOverrideAgentResources: + description: >- + This field is used to prevent accidental overwrite of other agent + resources, which can potentially impact other flow's behavior. If + `allow_override_agent_resources` is false, conflicted agent-level + resources will not be overridden (i.e. intents, entities, webhooks). + type: boolean + GoogleCloudDialogflowCxV3CompareVersionsRequest: + id: GoogleCloudDialogflowCxV3CompareVersionsRequest + description: The request message for Versions.CompareVersions. type: object properties: - gcsUri: + targetVersion: description: >- - The URI to a file containing the exported test cases. This field is - populated only if `gcs_uri` is specified in ExportTestCasesRequest. + Required. Name of the target flow version to compare with the base + version. Use version ID `0` to indicate the draft version of the + specified flow. Format: + `projects//locations//agents//flows//versions/`. type: string - content: - description: Uncompressed raw byte content for test cases. + languageCode: + description: >- + The language to compare the flow versions for. If not specified, the + agent's default language is used. [Many + languages](https://cloud.google.com/dialogflow/docs/reference/language) + are supported. Note: languages must be enabled in the agent before + they can be used. type: string - format: byte - GoogleCloudDialogflowCxV3ImportTestCasesMetadata: - id: GoogleCloudDialogflowCxV3ImportTestCasesMetadata - description: >- - Metadata returned for the TestCases.ImportTestCases long running - operation. - type: object - properties: - errors: - description: Errors for failed test cases. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3TestCaseError' - GoogleCloudDialogflowCxV3TestCaseError: - id: GoogleCloudDialogflowCxV3TestCaseError - description: Error info for importing a test. + GoogleCloudDialogflowCxV3CompareVersionsResponse: + id: GoogleCloudDialogflowCxV3CompareVersionsResponse + description: The response message for Versions.CompareVersions. type: object properties: - testCase: - description: The test case. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3TestCase' - status: - description: The status associated with the test case. - $ref: '#/components/schemas/GoogleRpcStatus' - GoogleCloudDialogflowCxV3ImportTestCasesResponse: - id: GoogleCloudDialogflowCxV3ImportTestCasesResponse - description: The response message for TestCases.ImportTestCases. + baseVersionContentJson: + description: JSON representation of the base version content. + type: string + targetVersionContentJson: + description: JSON representation of the target version content. + type: string + compareTime: + description: The timestamp when the two version compares. + type: string + format: google-datetime + GoogleCloudLocationListLocationsResponse: + id: GoogleCloudLocationListLocationsResponse + description: The response message for Locations.ListLocations. type: object properties: - names: + locations: description: >- - The unique identifiers of the new test cases. Format: - `projects//locations//agents//testCases/`. + A list of locations that matches the specified filter in the + request. type: array items: - type: string - GoogleCloudDialogflowCxV3RunContinuousTestMetadata: - id: GoogleCloudDialogflowCxV3RunContinuousTestMetadata - description: >- - Metadata returned for the Environments.RunContinuousTest long running - operation. + $ref: '#/components/schemas/GoogleCloudLocationLocation' + nextPageToken: + description: The standard List next-page token. + type: string + GoogleCloudLocationLocation: + id: GoogleCloudLocationLocation + description: A resource that represents a Google Cloud location. type: object properties: - errors: - description: The test errors. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3TestError' - GoogleCloudDialogflowCxV3RunContinuousTestResponse: - id: GoogleCloudDialogflowCxV3RunContinuousTestResponse - description: The response message for Environments.RunContinuousTest. - type: object - properties: - continuousTestResult: - description: The result for a continuous test run. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3ContinuousTestResult' - GoogleCloudDialogflowCxV3DeployFlowMetadata: - id: GoogleCloudDialogflowCxV3DeployFlowMetadata - description: >- - Metadata returned for the Environments.DeployFlow long running - operation. - type: object - properties: - testErrors: - description: Errors of running deployment tests. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3TestError' - GoogleCloudDialogflowCxV3DeployFlowResponse: - id: GoogleCloudDialogflowCxV3DeployFlowResponse - description: The response message for Environments.DeployFlow. - type: object - properties: - environment: - description: The updated environment where the flow is deployed. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Environment' - deployment: + name: description: >- - The name of the flow version Deployment. Format: - `projects//locations//agents//environments//deployments/`. + Resource name for the location, which may vary between + implementations. For example: + `"projects/example-project/locations/us-east1"` type: string - GoogleCloudDialogflowCxV3ConversationSignals: - id: GoogleCloudDialogflowCxV3ConversationSignals - description: >- - This message is used to hold all the Conversation Signals data, which - will be converted to JSON and exported to BigQuery. - type: object - properties: - turnSignals: - description: Required. Turn signals for the current turn. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3TurnSignals' - GoogleCloudDialogflowCxV3TurnSignals: - id: GoogleCloudDialogflowCxV3TurnSignals - description: >- - Collection of all signals that were extracted for a single turn of the - conversation. - type: object - properties: - noMatch: - description: Whether NLU predicted NO_MATCH. - type: boolean - noUserInput: - description: Whether user provided no input. - type: boolean - dtmfUsed: - description: Whether user was using DTMF input. - type: boolean - userEscalated: - description: Whether user was specifically asking for a live agent. - type: boolean - agentEscalated: - description: Whether agent responded with LiveAgentHandoff fulfillment. - type: boolean - reachedEndPage: - description: Whether turn resulted in End Session page. - type: boolean - webhookStatuses: - description: Human-readable statuses of the webhooks triggered during this turn. - type: array - items: - type: string - failureReasons: - description: Failure reasons of the turn. - type: array - items: - type: string - enumDescriptions: - - Failure reason is not assigned. - - Whether NLU failed to recognize user intent. - - Whether webhook failed during the turn. - enum: - - FAILURE_REASON_UNSPECIFIED - - FAILED_INTENT - - FAILED_WEBHOOK - sentimentScore: + locationId: + description: 'The canonical id for this location. For example: `"us-east1"`.' + type: string + displayName: description: >- - Sentiment score of the user utterance if - [sentiment](https://cloud.google.com/dialogflow/cx/docs/concept/sentiment) - was enabled. - type: number - format: float - sentimentMagnitude: + The friendly name for this location, typically a nearby city name. + For example, "Tokyo". + type: string + labels: description: >- - Sentiment magnitude of the user utterance if - [sentiment](https://cloud.google.com/dialogflow/cx/docs/concept/sentiment) - was enabled. - type: number - format: float - GoogleCloudDialogflowCxV3beta1CreateVersionOperationMetadata: - id: GoogleCloudDialogflowCxV3beta1CreateVersionOperationMetadata + Cross-service attributes for the location. For example + {"cloud.googleapis.com/region": "us-east1"} + type: object + additionalProperties: + type: string + metadata: + description: >- + Service-specific metadata. For example the available capacity at the + given location. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + GoogleCloudDialogflowCxV3CreateVersionOperationMetadata: + id: GoogleCloudDialogflowCxV3CreateVersionOperationMetadata description: >- Metadata associated with the long running operation for Versions.CreateVersion. @@ -6662,8 +7339,8 @@ components: Name of the created version. Format: `projects//locations//agents//flows//versions/`. type: string - GoogleCloudDialogflowCxV3beta1ExportAgentResponse: - id: GoogleCloudDialogflowCxV3beta1ExportAgentResponse + GoogleCloudDialogflowCxV3ExportAgentResponse: + id: GoogleCloudDialogflowCxV3ExportAgentResponse description: The response message for Agents.ExportAgent. type: object properties: @@ -6684,8 +7361,8 @@ components: Commit SHA of the git push. This field is populated if `git_destination` is specified in ExportAgentRequest. type: string - GoogleCloudDialogflowCxV3beta1ExportFlowResponse: - id: GoogleCloudDialogflowCxV3beta1ExportFlowResponse + GoogleCloudDialogflowCxV3ExportFlowResponse: + id: GoogleCloudDialogflowCxV3ExportFlowResponse description: The response message for Flows.ExportFlow. type: object properties: @@ -6698,13 +7375,13 @@ components: description: Uncompressed raw byte content for flow. type: string format: byte - GoogleCloudDialogflowCxV3beta1ExportIntentsMetadata: - id: GoogleCloudDialogflowCxV3beta1ExportIntentsMetadata + GoogleCloudDialogflowCxV3ExportIntentsMetadata: + id: GoogleCloudDialogflowCxV3ExportIntentsMetadata description: Metadata returned for the Intents.ExportIntents long running operation. type: object properties: {} - GoogleCloudDialogflowCxV3beta1ExportIntentsResponse: - id: GoogleCloudDialogflowCxV3beta1ExportIntentsResponse + GoogleCloudDialogflowCxV3ExportIntentsResponse: + id: GoogleCloudDialogflowCxV3ExportIntentsResponse description: The response message for Intents.ExportIntents. type: object properties: @@ -6718,9 +7395,9 @@ components: description: >- Uncompressed byte content for intents. This field is populated only if `intents_content_inline` is set to true in ExportIntentsRequest. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1InlineDestination' - GoogleCloudDialogflowCxV3beta1InlineDestination: - id: GoogleCloudDialogflowCxV3beta1InlineDestination + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3InlineDestination' + GoogleCloudDialogflowCxV3InlineDestination: + id: GoogleCloudDialogflowCxV3InlineDestination description: >- Inline destination for a Dialogflow operation that writes or exports objects (e.g. intents) outside of Dialogflow. @@ -6733,8 +7410,8 @@ components: readOnly: true type: string format: byte - GoogleCloudDialogflowCxV3beta1ImportFlowResponse: - id: GoogleCloudDialogflowCxV3beta1ImportFlowResponse + GoogleCloudDialogflowCxV3ImportFlowResponse: + id: GoogleCloudDialogflowCxV3ImportFlowResponse description: The response message for Flows.ImportFlow. type: object properties: @@ -6743,15 +7420,15 @@ components: The unique identifier of the new flow. Format: `projects//locations//agents//flows/`. type: string - GoogleCloudDialogflowCxV3beta1ImportEntityTypesMetadata: - id: GoogleCloudDialogflowCxV3beta1ImportEntityTypesMetadata + GoogleCloudDialogflowCxV3ImportEntityTypesMetadata: + id: GoogleCloudDialogflowCxV3ImportEntityTypesMetadata description: >- Metadata returned for the EntityTypes.ImportEntityTypes long running operation. type: object properties: {} - GoogleCloudDialogflowCxV3beta1ImportEntityTypesResponse: - id: GoogleCloudDialogflowCxV3beta1ImportEntityTypesResponse + GoogleCloudDialogflowCxV3ImportEntityTypesResponse: + id: GoogleCloudDialogflowCxV3ImportEntityTypesResponse description: The response message for EntityTypes.ImportEntityTypes. type: object properties: @@ -6767,10 +7444,9 @@ components: Info which resources have conflicts when REPORT_CONFLICT merge_option is set in ImportEntityTypesRequest. $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1ImportEntityTypesResponseConflictingResources - GoogleCloudDialogflowCxV3beta1ImportEntityTypesResponseConflictingResources: - id: >- - GoogleCloudDialogflowCxV3beta1ImportEntityTypesResponseConflictingResources + #/components/schemas/GoogleCloudDialogflowCxV3ImportEntityTypesResponseConflictingResources + GoogleCloudDialogflowCxV3ImportEntityTypesResponseConflictingResources: + id: GoogleCloudDialogflowCxV3ImportEntityTypesResponseConflictingResources description: >- Conflicting resources detected during the import process. Only filled when REPORT_CONFLICT is set in the request and there are conflicts in @@ -6787,15 +7463,15 @@ components: type: array items: type: string - GoogleCloudDialogflowCxV3beta1ExportEntityTypesMetadata: - id: GoogleCloudDialogflowCxV3beta1ExportEntityTypesMetadata + GoogleCloudDialogflowCxV3ExportEntityTypesMetadata: + id: GoogleCloudDialogflowCxV3ExportEntityTypesMetadata description: >- Metadata returned for the EntityTypes.ExportEntityTypes long running operation. type: object properties: {} - GoogleCloudDialogflowCxV3beta1ExportEntityTypesResponse: - id: GoogleCloudDialogflowCxV3beta1ExportEntityTypesResponse + GoogleCloudDialogflowCxV3ExportEntityTypesResponse: + id: GoogleCloudDialogflowCxV3ExportEntityTypesResponse description: The response message for EntityTypes.ExportEntityTypes. type: object properties: @@ -6810,14 +7486,14 @@ components: Uncompressed byte content for entity types. This field is populated only if `entity_types_content_inline` is set to true in ExportEntityTypesRequest. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1InlineDestination' - GoogleCloudDialogflowCxV3beta1ImportIntentsMetadata: - id: GoogleCloudDialogflowCxV3beta1ImportIntentsMetadata + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3InlineDestination' + GoogleCloudDialogflowCxV3ImportIntentsMetadata: + id: GoogleCloudDialogflowCxV3ImportIntentsMetadata description: Metadata returned for the Intents.ImportIntents long running operation. type: object properties: {} - GoogleCloudDialogflowCxV3beta1ImportIntentsResponse: - id: GoogleCloudDialogflowCxV3beta1ImportIntentsResponse + GoogleCloudDialogflowCxV3ImportIntentsResponse: + id: GoogleCloudDialogflowCxV3ImportIntentsResponse description: The response message for Intents.ImportIntents. type: object properties: @@ -6833,9 +7509,9 @@ components: Info which resources have conflicts when REPORT_CONFLICT merge_option is set in ImportIntentsRequest. $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources - GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources: - id: GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources + #/components/schemas/GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources + GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources: + id: GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources description: >- Conflicting resources detected during the import process. Only filled when REPORT_CONFLICT is set in the request and there are conflicts in @@ -6852,8 +7528,8 @@ components: type: array items: type: string - GoogleCloudDialogflowCxV3beta1WebhookRequest: - id: GoogleCloudDialogflowCxV3beta1WebhookRequest + GoogleCloudDialogflowCxV3WebhookRequest: + id: GoogleCloudDialogflowCxV3WebhookRequest description: >- The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see @@ -6900,17 +7576,17 @@ components: Always present. Information about the fulfillment that triggered this webhook call. $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo + #/components/schemas/GoogleCloudDialogflowCxV3WebhookRequestFulfillmentInfo intentInfo: description: Information about the last matched intent. $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo + #/components/schemas/GoogleCloudDialogflowCxV3WebhookRequestIntentInfo pageInfo: description: Information about page status. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1PageInfo' + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3PageInfo' sessionInfo: description: Information about session status. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1SessionInfo' + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3SessionInfo' messages: description: >- The list of rich message responses to present to the user. Webhook @@ -6918,7 +7594,7 @@ components: WebhookResponse.fulfillment_response; type: array items: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1ResponseMessage' + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3ResponseMessage' payload: description: Custom data set in QueryParameters.payload. type: object @@ -6931,12 +7607,12 @@ components: is filled when sentiment analysis is configured to be enabled for the request. $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1WebhookRequestSentimentAnalysisResult + #/components/schemas/GoogleCloudDialogflowCxV3WebhookRequestSentimentAnalysisResult languageInfo: description: Information about the language of the request. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1LanguageInfo' - GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo: - id: GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3LanguageInfo' + GoogleCloudDialogflowCxV3WebhookRequestFulfillmentInfo: + id: GoogleCloudDialogflowCxV3WebhookRequestFulfillmentInfo description: Represents fulfillment information communicated to the webhook. type: object properties: @@ -6948,8 +7624,8 @@ components: which fulfillment is being called, but it could be used for other purposes. type: string - GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo: - id: GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo + GoogleCloudDialogflowCxV3WebhookRequestIntentInfo: + id: GoogleCloudDialogflowCxV3WebhookRequestIntentInfo description: Represents intent information communicated to the webhook. type: object properties: @@ -6971,16 +7647,15 @@ components: type: object additionalProperties: $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfoIntentParameterValue + #/components/schemas/GoogleCloudDialogflowCxV3WebhookRequestIntentInfoIntentParameterValue confidence: description: >- The confidence of the matched intent. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). type: number format: float - GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfoIntentParameterValue: - id: >- - GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfoIntentParameterValue + GoogleCloudDialogflowCxV3WebhookRequestIntentInfoIntentParameterValue: + id: GoogleCloudDialogflowCxV3WebhookRequestIntentInfoIntentParameterValue description: Represents a value for an intent parameter. type: object properties: @@ -6992,8 +7667,8 @@ components: Always present. Structured value for the parameter extracted from user utterance. type: any - GoogleCloudDialogflowCxV3beta1PageInfo: - id: GoogleCloudDialogflowCxV3beta1PageInfo + GoogleCloudDialogflowCxV3PageInfo: + id: GoogleCloudDialogflowCxV3PageInfo description: Represents page information communicated to and from the webhook. type: object properties: @@ -7012,9 +7687,9 @@ components: description: >- Optional for both WebhookRequest and WebhookResponse. Information about the form. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1PageInfoFormInfo' - GoogleCloudDialogflowCxV3beta1PageInfoFormInfo: - id: GoogleCloudDialogflowCxV3beta1PageInfoFormInfo + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3PageInfoFormInfo' + GoogleCloudDialogflowCxV3PageInfoFormInfo: + id: GoogleCloudDialogflowCxV3PageInfoFormInfo description: Represents form information. type: object properties: @@ -7026,9 +7701,9 @@ components: type: array items: $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo - GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo: - id: GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo + #/components/schemas/GoogleCloudDialogflowCxV3PageInfoFormInfoParameterInfo + GoogleCloudDialogflowCxV3PageInfoFormInfoParameterInfo: + id: GoogleCloudDialogflowCxV3PageInfoFormInfoParameterInfo description: Represents parameter information. type: object properties: @@ -7078,8 +7753,8 @@ components: if the parameter value was just collected on the last conversation turn. type: boolean - GoogleCloudDialogflowCxV3beta1SessionInfo: - id: GoogleCloudDialogflowCxV3beta1SessionInfo + GoogleCloudDialogflowCxV3SessionInfo: + id: GoogleCloudDialogflowCxV3SessionInfo description: Represents session information communicated to and from the webhook. type: object properties: @@ -7103,1129 +7778,1138 @@ components: type: object additionalProperties: type: any - GoogleCloudDialogflowCxV3beta1ResponseMessage: - id: GoogleCloudDialogflowCxV3beta1ResponseMessage - description: >- - Represents a response message that can be returned by a conversational - agent. Response messages are also used for output audio synthesis. The - approach is as follows: * If at least one OutputAudioText response is - present, then all OutputAudioText responses are linearly concatenated, - and the result is used for output audio synthesis. * If the - OutputAudioText responses are a mixture of text and SSML, then the - concatenated result is treated as SSML; otherwise, the result is treated - as either text or SSML as appropriate. The agent designer should ideally - use either text or SSML consistently throughout the bot design. * - Otherwise, all Text responses are linearly concatenated, and the result - is used for output audio synthesis. This approach allows for more - sophisticated user experience scenarios, where the text displayed to the - user may differ from what is heard. + GoogleCloudDialogflowCxV3WebhookRequestSentimentAnalysisResult: + id: GoogleCloudDialogflowCxV3WebhookRequestSentimentAnalysisResult + description: Represents the result of sentiment analysis. type: object properties: - text: - description: Returns a text response. - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1ResponseMessageText - payload: - description: Returns a response containing a custom, platform-specific payload. - type: object - additionalProperties: - type: any - description: Properties of the object. - conversationSuccess: - description: Indicates that the conversation succeeded. - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess - outputAudioText: + score: description: >- - A text or ssml response that is preferentially used for TTS output - audio synthesis, as described in the comment on the ResponseMessage - message. - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText - liveAgentHandoff: - description: Hands off conversation to a human agent. - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff - endInteraction: + Sentiment score between -1.0 (negative sentiment) and 1.0 (positive + sentiment). + type: number + format: float + magnitude: description: >- - Output only. A signal that indicates the interaction with the - Dialogflow agent has ended. This message is generated by Dialogflow - only when the conversation reaches `END_SESSION` page. It is not - supposed to be defined by the user. It's guaranteed that there is at - most one such message in each response. - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction - playAudio: + A non-negative number in the [0, +inf) range, which represents the + absolute magnitude of sentiment, regardless of score (positive or + negative). + type: number + format: float + GoogleCloudDialogflowCxV3LanguageInfo: + id: GoogleCloudDialogflowCxV3LanguageInfo + description: Represents the language information of the request. + type: object + properties: + inputLanguageCode: + description: The language code specified in the original request. + type: string + resolvedLanguageCode: description: >- - Signal that the client should play an audio clip hosted at a - client-specific URI. Dialogflow uses this to construct mixed_audio. - However, Dialogflow itself does not try to read or process the URI - in any way. - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio - mixedAudio: + The language code detected for this request based on the user + conversation. + type: string + confidenceScore: + description: The confidence score of the detected language between 0 and 1. + type: number + format: float + GoogleCloudDialogflowCxV3WebhookResponse: + id: GoogleCloudDialogflowCxV3WebhookResponse + description: The response message for a webhook call. + type: object + properties: + fulfillmentResponse: description: >- - Output only. An audio response message composed of both the - synthesized Dialogflow agent responses and responses defined via - play_audio. This message is generated by Dialogflow only and not - supposed to be defined by the user. - readOnly: true + The fulfillment response to send to the user. This field can be + omitted by the webhook if it does not intend to send any response to + the user. $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio - telephonyTransferCall: + #/components/schemas/GoogleCloudDialogflowCxV3WebhookResponseFulfillmentResponse + pageInfo: description: >- - A signal that the client should transfer the phone call connected to - this agent to a third-party endpoint. - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1ResponseMessageTelephonyTransferCall - knowledgeInfoCard: + Information about page status. This field can be omitted by the + webhook if it does not intend to modify page status. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3PageInfo' + sessionInfo: description: >- - Represents info card for knowledge answers, to be better rendered in - Dialogflow Messenger. - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1ResponseMessageKnowledgeInfoCard - toolCall: + Information about session status. This field can be omitted by the + webhook if it does not intend to modify session status. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3SessionInfo' + payload: + description: Value to append directly to QueryResult.webhook_payloads. + type: object + additionalProperties: + type: any + description: Properties of the object. + targetPage: description: >- - Returns the definition of a tool call that should be executed by the - client. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1ToolCall' - channel: + The target page to transition to. Format: + `projects//locations//agents//flows//pages/`. + type: string + targetFlow: description: >- - The channel which the response is associated with. Clients can - specify the channel via QueryParameters.channel, and only associated - channel response will be returned. + The target flow to transition to. Format: + `projects//locations//agents//flows/`. type: string - GoogleCloudDialogflowCxV3beta1ResponseMessageText: - id: GoogleCloudDialogflowCxV3beta1ResponseMessageText - description: The text response message. + GoogleCloudDialogflowCxV3WebhookResponseFulfillmentResponse: + id: GoogleCloudDialogflowCxV3WebhookResponseFulfillmentResponse + description: Represents a fulfillment response to the user. type: object properties: - text: - description: >- - Required. A collection of text response variants. If multiple - variants are defined, only one text response variant is returned at - runtime. + messages: + description: The list of rich message responses to present to the user. type: array items: - type: string - allowPlaybackInterruption: - description: >- - Output only. Whether the playback of this message can be interrupted - by the end user's speech and the client can then starts the next - Dialogflow request. - readOnly: true - type: boolean - GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess: - id: GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3ResponseMessage' + mergeBehavior: + description: Merge behavior for `messages`. + type: string + enumDescriptions: + - Not specified. `APPEND` will be used. + - >- + `messages` will be appended to the list of messages waiting to be + sent to the user. + - >- + `messages` will replace the list of messages waiting to be sent to + the user. + enum: + - MERGE_BEHAVIOR_UNSPECIFIED + - APPEND + - REPLACE + GoogleCloudDialogflowCxV3BatchRunTestCasesMetadata: + id: GoogleCloudDialogflowCxV3BatchRunTestCasesMetadata description: >- - Indicates that the conversation succeeded, i.e., the bot handled the - issue that the customer talked to it about. Dialogflow only uses this to - determine which conversations should be counted as successful and - doesn't process the metadata in this message in any way. Note that - Dialogflow also considers conversations that get to the conversation end - page as successful even if they don't return ConversationSuccess. You - may set this, for example: * In the entry_fulfillment of a Page if - entering the page indicates that the conversation succeeded. * In a - webhook response when you determine that you handled the customer issue. + Metadata returned for the TestCases.BatchRunTestCases long running + operation. type: object properties: - metadata: - description: Custom metadata. Dialogflow doesn't impose any structure on this. - type: object - additionalProperties: - type: any - description: Properties of the object. - GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText: - id: GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText - description: >- - A text or ssml response that is preferentially used for TTS output audio - synthesis, as described in the comment on the ResponseMessage message. + errors: + description: The test errors. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3TestError' + GoogleCloudDialogflowCxV3TestError: + id: GoogleCloudDialogflowCxV3TestError + description: Error info for running a test. type: object properties: - text: - description: The raw text to be synthesized. + testCase: + description: The test case resource name. type: string - ssml: - description: >- - The SSML text to be synthesized. For more information, see - [SSML](/speech/text-to-speech/docs/ssml). + status: + description: The status associated with the test. + $ref: '#/components/schemas/GoogleRpcStatus' + testTime: + description: The timestamp when the test was completed. type: string - allowPlaybackInterruption: - description: >- - Output only. Whether the playback of this message can be interrupted - by the end user's speech and the client can then starts the next - Dialogflow request. - readOnly: true - type: boolean - GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff: - id: GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff - description: >- - Indicates that the conversation should be handed off to a live agent. - Dialogflow only uses this to determine which conversations were handed - off to a human agent for measurement purposes. What else to do with this - signal is up to you and your handoff procedures. You may set this, for - example: * In the entry_fulfillment of a Page if entering the page - indicates something went extremely wrong in the conversation. * In a - webhook response when you determine that the customer issue can only be - handled by a human. + format: google-datetime + GoogleCloudDialogflowCxV3BatchRunTestCasesResponse: + id: GoogleCloudDialogflowCxV3BatchRunTestCasesResponse + description: The response message for TestCases.BatchRunTestCases. type: object properties: - metadata: + results: description: >- - Custom metadata for your handoff procedure. Dialogflow doesn't - impose any structure on this. - type: object - additionalProperties: - type: any - description: Properties of the object. - GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction: - id: GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction + The test case results. The detailed conversation turns are empty in + this response. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3TestCaseResult' + GoogleCloudDialogflowCxV3RunTestCaseMetadata: + id: GoogleCloudDialogflowCxV3RunTestCaseMetadata description: >- - Indicates that interaction with the Dialogflow agent has ended. This - message is generated by Dialogflow only and not supposed to be defined - by the user. + Metadata returned for the TestCases.RunTestCase long running operation. + This message currently has no fields. type: object properties: {} - GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio: - id: GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio + GoogleCloudDialogflowCxV3RunTestCaseResponse: + id: GoogleCloudDialogflowCxV3RunTestCaseResponse + description: The response message for TestCases.RunTestCase. + type: object + properties: + result: + description: The result. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3TestCaseResult' + GoogleCloudDialogflowCxV3ExportTestCasesMetadata: + id: GoogleCloudDialogflowCxV3ExportTestCasesMetadata description: >- - Specifies an audio clip to be played by the client as part of the - response. + Metadata returned for the TestCases.ExportTestCases long running + operation. This message currently has no fields. + type: object + properties: {} + GoogleCloudDialogflowCxV3ExportTestCasesResponse: + id: GoogleCloudDialogflowCxV3ExportTestCasesResponse + description: The response message for TestCases.ExportTestCases. type: object properties: - audioUri: + gcsUri: description: >- - Required. URI of the audio clip. Dialogflow does not impose any - validation on this value. It is specific to the client that reads - it. + The URI to a file containing the exported test cases. This field is + populated only if `gcs_uri` is specified in ExportTestCasesRequest. type: string - allowPlaybackInterruption: - description: >- - Output only. Whether the playback of this message can be interrupted - by the end user's speech and the client can then starts the next - Dialogflow request. - readOnly: true - type: boolean - GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio: - id: GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio + content: + description: Uncompressed raw byte content for test cases. + type: string + format: byte + GoogleCloudDialogflowCxV3ImportTestCasesMetadata: + id: GoogleCloudDialogflowCxV3ImportTestCasesMetadata description: >- - Represents an audio message that is composed of both segments - synthesized from the Dialogflow agent prompts and ones hosted externally - at the specified URIs. The external URIs are specified via play_audio. - This message is generated by Dialogflow only and not supposed to be - defined by the user. + Metadata returned for the TestCases.ImportTestCases long running + operation. type: object properties: - segments: - description: Segments this audio response is composed of. + errors: + description: Errors for failed test cases. type: array items: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment - GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment: - id: GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment - description: Represents one segment of audio. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3TestCaseError' + GoogleCloudDialogflowCxV3TestCaseError: + id: GoogleCloudDialogflowCxV3TestCaseError + description: Error info for importing a test. type: object properties: - audio: - description: >- - Raw audio synthesized from the Dialogflow agent's response using the - output config specified in the request. - type: string - format: byte - uri: - description: >- - Client-specific URI that points to an audio clip accessible to the - client. Dialogflow does not impose any validation on it. - type: string - allowPlaybackInterruption: + testCase: + description: The test case. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3TestCase' + status: + description: The status associated with the test case. + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudDialogflowCxV3ImportTestCasesResponse: + id: GoogleCloudDialogflowCxV3ImportTestCasesResponse + description: The response message for TestCases.ImportTestCases. + type: object + properties: + names: description: >- - Output only. Whether the playback of this segment can be interrupted - by the end user's speech and the client should then start the next - Dialogflow request. - readOnly: true - type: boolean - GoogleCloudDialogflowCxV3beta1ResponseMessageTelephonyTransferCall: - id: GoogleCloudDialogflowCxV3beta1ResponseMessageTelephonyTransferCall + The unique identifiers of the new test cases. Format: + `projects//locations//agents//testCases/`. + type: array + items: + type: string + GoogleCloudDialogflowCxV3RunContinuousTestMetadata: + id: GoogleCloudDialogflowCxV3RunContinuousTestMetadata description: >- - Represents the signal that telles the client to transfer the phone call - connected to the agent to a third-party endpoint. + Metadata returned for the Environments.RunContinuousTest long running + operation. type: object properties: - phoneNumber: - description: >- - Transfer the call to a phone number in [E.164 - format](https://en.wikipedia.org/wiki/E.164). - type: string - GoogleCloudDialogflowCxV3beta1ResponseMessageKnowledgeInfoCard: - id: GoogleCloudDialogflowCxV3beta1ResponseMessageKnowledgeInfoCard + errors: + description: The test errors. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3TestError' + GoogleCloudDialogflowCxV3RunContinuousTestResponse: + id: GoogleCloudDialogflowCxV3RunContinuousTestResponse + description: The response message for Environments.RunContinuousTest. + type: object + properties: + continuousTestResult: + description: The result for a continuous test run. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3ContinuousTestResult' + GoogleCloudDialogflowCxV3DeployFlowMetadata: + id: GoogleCloudDialogflowCxV3DeployFlowMetadata description: >- - Represents info card response. If the response contains generative - knowledge prediction, Dialogflow will return a payload with Infobot - Messenger compatible info card. Otherwise, the info card response is - skipped. + Metadata returned for the Environments.DeployFlow long running + operation. type: object - properties: {} - GoogleCloudDialogflowCxV3beta1ToolCall: - id: GoogleCloudDialogflowCxV3beta1ToolCall - description: Represents a call of a specific tool's action with the specified inputs. + properties: + testErrors: + description: Errors of running deployment tests. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3TestError' + GoogleCloudDialogflowCxV3DeployFlowResponse: + id: GoogleCloudDialogflowCxV3DeployFlowResponse + description: The response message for Environments.DeployFlow. type: object properties: - tool: + environment: + description: The updated environment where the flow is deployed. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Environment' + deployment: description: >- - Required. The tool associated with this call. Format: - `projects//locations//agents//tools/`. - type: string - action: - description: Required. The name of the tool's action associated with this call. + The name of the flow version Deployment. Format: + `projects//locations//agents//environments//deployments/`. type: string - inputParameters: - description: Optional. The action's input parameters. - type: object - additionalProperties: - type: any - description: Properties of the object. - GoogleCloudDialogflowCxV3beta1WebhookRequestSentimentAnalysisResult: - id: GoogleCloudDialogflowCxV3beta1WebhookRequestSentimentAnalysisResult - description: Represents the result of sentiment analysis. + GoogleCloudDialogflowCxV3ConversationSignals: + id: GoogleCloudDialogflowCxV3ConversationSignals + description: >- + This message is used to hold all the Conversation Signals data, which + will be converted to JSON and exported to BigQuery. type: object properties: - score: + turnSignals: + description: Required. Turn signals for the current turn. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3TurnSignals' + GoogleCloudDialogflowCxV3TurnSignals: + id: GoogleCloudDialogflowCxV3TurnSignals + description: >- + Collection of all signals that were extracted for a single turn of the + conversation. + type: object + properties: + noMatch: + description: Whether NLU predicted NO_MATCH. + type: boolean + noUserInput: + description: Whether user provided no input. + type: boolean + dtmfUsed: + description: Whether user was using DTMF input. + type: boolean + userEscalated: + description: Whether user was specifically asking for a live agent. + type: boolean + agentEscalated: + description: Whether agent responded with LiveAgentHandoff fulfillment. + type: boolean + reachedEndPage: + description: Whether turn resulted in End Session page. + type: boolean + webhookStatuses: + description: Human-readable statuses of the webhooks triggered during this turn. + type: array + items: + type: string + failureReasons: + description: Failure reasons of the turn. + type: array + items: + type: string + enumDescriptions: + - Failure reason is not assigned. + - Whether NLU failed to recognize user intent. + - Whether webhook failed during the turn. + enum: + - FAILURE_REASON_UNSPECIFIED + - FAILED_INTENT + - FAILED_WEBHOOK + sentimentScore: description: >- - Sentiment score between -1.0 (negative sentiment) and 1.0 (positive - sentiment). + Sentiment score of the user utterance if + [sentiment](https://cloud.google.com/dialogflow/cx/docs/concept/sentiment) + was enabled. type: number format: float - magnitude: + sentimentMagnitude: description: >- - A non-negative number in the [0, +inf) range, which represents the - absolute magnitude of sentiment, regardless of score (positive or - negative). + Sentiment magnitude of the user utterance if + [sentiment](https://cloud.google.com/dialogflow/cx/docs/concept/sentiment) + was enabled. type: number format: float - GoogleCloudDialogflowCxV3beta1LanguageInfo: - id: GoogleCloudDialogflowCxV3beta1LanguageInfo - description: Represents the language information of the request. + GoogleCloudDialogflowCxV3beta1CreateVersionOperationMetadata: + id: GoogleCloudDialogflowCxV3beta1CreateVersionOperationMetadata + description: >- + Metadata associated with the long running operation for + Versions.CreateVersion. type: object properties: - inputLanguageCode: - description: The language code specified in the original request. - type: string - resolvedLanguageCode: + version: description: >- - The language code detected for this request based on the user - conversation. + Name of the created version. Format: + `projects//locations//agents//flows//versions/`. type: string - confidenceScore: - description: The confidence score of the detected language between 0 and 1. - type: number - format: float - GoogleCloudDialogflowCxV3beta1WebhookResponse: - id: GoogleCloudDialogflowCxV3beta1WebhookResponse - description: The response message for a webhook call. + GoogleCloudDialogflowCxV3beta1ExportAgentResponse: + id: GoogleCloudDialogflowCxV3beta1ExportAgentResponse + description: The response message for Agents.ExportAgent. type: object properties: - fulfillmentResponse: - description: >- - The fulfillment response to send to the user. This field can be - omitted by the webhook if it does not intend to send any response to - the user. - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse - pageInfo: + agentUri: description: >- - Information about page status. This field can be omitted by the - webhook if it does not intend to modify page status. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1PageInfo' - sessionInfo: + The URI to a file containing the exported agent. This field is + populated if `agent_uri` is specified in ExportAgentRequest. + type: string + agentContent: description: >- - Information about session status. This field can be omitted by the - webhook if it does not intend to modify session status. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1SessionInfo' - payload: - description: Value to append directly to QueryResult.webhook_payloads. - type: object - additionalProperties: - type: any - description: Properties of the object. - targetPage: + Uncompressed raw byte content for agent. This field is populated if + none of `agent_uri` and `git_destination` are specified in + ExportAgentRequest. + type: string + format: byte + commitSha: description: >- - The target page to transition to. Format: - `projects//locations//agents//flows//pages/`. + Commit SHA of the git push. This field is populated if + `git_destination` is specified in ExportAgentRequest. type: string - targetFlow: + GoogleCloudDialogflowCxV3beta1ExportFlowResponse: + id: GoogleCloudDialogflowCxV3beta1ExportFlowResponse + description: The response message for Flows.ExportFlow. + type: object + properties: + flowUri: description: >- - The target flow to transition to. Format: - `projects//locations//agents//flows/`. + The URI to a file containing the exported flow. This field is + populated only if `flow_uri` is specified in ExportFlowRequest. type: string - GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse: - id: GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse - description: Represents a fulfillment response to the user. + flowContent: + description: Uncompressed raw byte content for flow. + type: string + format: byte + GoogleCloudDialogflowCxV3beta1ExportIntentsMetadata: + id: GoogleCloudDialogflowCxV3beta1ExportIntentsMetadata + description: Metadata returned for the Intents.ExportIntents long running operation. + type: object + properties: {} + GoogleCloudDialogflowCxV3beta1ExportIntentsResponse: + id: GoogleCloudDialogflowCxV3beta1ExportIntentsResponse + description: The response message for Intents.ExportIntents. type: object properties: - messages: - description: The list of rich message responses to present to the user. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1ResponseMessage' - mergeBehavior: - description: Merge behavior for `messages`. + intentsUri: + description: >- + The URI to a file containing the exported intents. This field is + populated only if `intents_uri` is specified in + ExportIntentsRequest. type: string - enumDescriptions: - - Not specified. `APPEND` will be used. - - >- - `messages` will be appended to the list of messages waiting to be - sent to the user. - - >- - `messages` will replace the list of messages waiting to be sent to - the user. - enum: - - MERGE_BEHAVIOR_UNSPECIFIED - - APPEND - - REPLACE - GoogleCloudDialogflowCxV3beta1BatchRunTestCasesMetadata: - id: GoogleCloudDialogflowCxV3beta1BatchRunTestCasesMetadata + intentsContent: + description: >- + Uncompressed byte content for intents. This field is populated only + if `intents_content_inline` is set to true in ExportIntentsRequest. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1InlineDestination' + GoogleCloudDialogflowCxV3beta1InlineDestination: + id: GoogleCloudDialogflowCxV3beta1InlineDestination description: >- - Metadata returned for the TestCases.BatchRunTestCases long running - operation. + Inline destination for a Dialogflow operation that writes or exports + objects (e.g. intents) outside of Dialogflow. type: object properties: - errors: - description: The test errors. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1TestError' - GoogleCloudDialogflowCxV3beta1TestError: - id: GoogleCloudDialogflowCxV3beta1TestError - description: Error info for running a test. + content: + description: >- + Output only. The uncompressed byte content for the objects. Only + populated in responses. + readOnly: true + type: string + format: byte + GoogleCloudDialogflowCxV3beta1ImportFlowResponse: + id: GoogleCloudDialogflowCxV3beta1ImportFlowResponse + description: The response message for Flows.ImportFlow. type: object properties: - testCase: - description: The test case resource name. - type: string - status: - description: The status associated with the test. - $ref: '#/components/schemas/GoogleRpcStatus' - testTime: - description: The timestamp when the test was completed. + flow: + description: >- + The unique identifier of the new flow. Format: + `projects//locations//agents//flows/`. type: string - format: google-datetime - GoogleCloudDialogflowCxV3beta1BatchRunTestCasesResponse: - id: GoogleCloudDialogflowCxV3beta1BatchRunTestCasesResponse - description: The response message for TestCases.BatchRunTestCases. + GoogleCloudDialogflowCxV3beta1ImportEntityTypesMetadata: + id: GoogleCloudDialogflowCxV3beta1ImportEntityTypesMetadata + description: >- + Metadata returned for the EntityTypes.ImportEntityTypes long running + operation. + type: object + properties: {} + GoogleCloudDialogflowCxV3beta1ImportEntityTypesResponse: + id: GoogleCloudDialogflowCxV3beta1ImportEntityTypesResponse + description: The response message for EntityTypes.ImportEntityTypes. type: object properties: - results: + entityTypes: description: >- - The test case results. The detailed conversation turns are empty in - this response. + The unique identifier of the imported entity types. Format: + `projects//locations//agents//entity_types/`. type: array items: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1TestCaseResult' - GoogleCloudDialogflowCxV3beta1TestCaseResult: - id: GoogleCloudDialogflowCxV3beta1TestCaseResult - description: Represents a result from running a test case in an agent environment. + type: string + conflictingResources: + description: >- + Info which resources have conflicts when REPORT_CONFLICT + merge_option is set in ImportEntityTypesRequest. + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3beta1ImportEntityTypesResponseConflictingResources + GoogleCloudDialogflowCxV3beta1ImportEntityTypesResponseConflictingResources: + id: >- + GoogleCloudDialogflowCxV3beta1ImportEntityTypesResponseConflictingResources + description: >- + Conflicting resources detected during the import process. Only filled + when REPORT_CONFLICT is set in the request and there are conflicts in + the display names. type: object properties: - name: - description: >- - The resource name for the test case result. Format: - `projects//locations//agents//testCases//results/`. - type: string - environment: - description: >- - Environment where the test was run. If not set, it indicates the - draft environment. - type: string - conversationTurns: - description: >- - The conversation turns uttered during the test case replay in - chronological order. + entityTypeDisplayNames: + description: Display names of conflicting entity types. type: array items: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1ConversationTurn - testResult: - description: Whether the test case passed in the agent environment. - type: string - enumDescriptions: - - Not specified. Should never be used. - - The test passed. - - The test did not pass. - enum: - - TEST_RESULT_UNSPECIFIED - - PASSED - - FAILED - testTime: - description: The time that the test was run. - type: string - format: google-datetime - GoogleCloudDialogflowCxV3beta1ConversationTurn: - id: GoogleCloudDialogflowCxV3beta1ConversationTurn + type: string + entityDisplayNames: + description: Display names of conflicting entities. + type: array + items: + type: string + GoogleCloudDialogflowCxV3beta1ExportEntityTypesMetadata: + id: GoogleCloudDialogflowCxV3beta1ExportEntityTypesMetadata description: >- - One interaction between a human and virtual agent. The human provides - some input and the virtual agent provides a response. + Metadata returned for the EntityTypes.ExportEntityTypes long running + operation. type: object - properties: - userInput: - description: The user input. - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1ConversationTurnUserInput - virtualAgentOutput: - description: The virtual agent output. - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1ConversationTurnVirtualAgentOutput - GoogleCloudDialogflowCxV3beta1ConversationTurnUserInput: - id: GoogleCloudDialogflowCxV3beta1ConversationTurnUserInput - description: The input from the human user. + properties: {} + GoogleCloudDialogflowCxV3beta1ExportEntityTypesResponse: + id: GoogleCloudDialogflowCxV3beta1ExportEntityTypesResponse + description: The response message for EntityTypes.ExportEntityTypes. type: object properties: - input: - description: Supports text input, event input, dtmf input in the test case. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1QueryInput' - injectedParameters: + entityTypesUri: description: >- - Parameters that need to be injected into the conversation during - intent detection. - type: object - additionalProperties: - type: any - description: Properties of the object. - isWebhookEnabled: + The URI to a file containing the exported entity types. This field + is populated only if `entity_types_uri` is specified in + ExportEntityTypesRequest. + type: string + entityTypesContent: description: >- - If webhooks should be allowed to trigger in response to the user - utterance. Often if parameters are injected, webhooks should not be - enabled. - type: boolean - enableSentimentAnalysis: - description: Whether sentiment analysis is enabled. - type: boolean - GoogleCloudDialogflowCxV3beta1QueryInput: - id: GoogleCloudDialogflowCxV3beta1QueryInput - description: >- - Represents the query input. It can contain one of: 1. A conversational - query in the form of text. 2. An intent query that specifies which - intent to trigger. 3. Natural language speech audio to be processed. 4. - An event to be triggered. 5. DTMF digits to invoke an intent and fill in - parameter value. 6. The results of a tool executed by the client. + Uncompressed byte content for entity types. This field is populated + only if `entity_types_content_inline` is set to true in + ExportEntityTypesRequest. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1InlineDestination' + GoogleCloudDialogflowCxV3beta1ImportIntentsMetadata: + id: GoogleCloudDialogflowCxV3beta1ImportIntentsMetadata + description: Metadata returned for the Intents.ImportIntents long running operation. + type: object + properties: {} + GoogleCloudDialogflowCxV3beta1ImportIntentsResponse: + id: GoogleCloudDialogflowCxV3beta1ImportIntentsResponse + description: The response message for Intents.ImportIntents. type: object properties: - text: - description: The natural language text to be processed. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1TextInput' - intent: - description: The intent to be triggered. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1IntentInput' - audio: - description: The natural language speech audio to be processed. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1AudioInput' - event: - description: The event to be triggered. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1EventInput' - dtmf: - description: The DTMF event to be handled. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1DtmfInput' - toolCallResult: - description: The results of a tool executed by the client. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1ToolCallResult' - languageCode: + intents: description: >- - Required. The language of the input. See [Language - Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) - for a list of the currently supported language codes. Note that - queries in the same session do not necessarily need to specify the - same language. - type: string - GoogleCloudDialogflowCxV3beta1TextInput: - id: GoogleCloudDialogflowCxV3beta1TextInput - description: Represents the natural language text to be processed. + The unique identifier of the imported intents. Format: + `projects//locations//agents//intents/`. + type: array + items: + type: string + conflictingResources: + description: >- + Info which resources have conflicts when REPORT_CONFLICT + merge_option is set in ImportIntentsRequest. + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources + GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources: + id: GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources + description: >- + Conflicting resources detected during the import process. Only filled + when REPORT_CONFLICT is set in the request and there are conflicts in + the display names. type: object properties: - text: - description: Required. The UTF-8 encoded natural language text to be processed. - type: string - GoogleCloudDialogflowCxV3beta1IntentInput: - id: GoogleCloudDialogflowCxV3beta1IntentInput + intentDisplayNames: + description: Display names of conflicting intents. + type: array + items: + type: string + entityDisplayNames: + description: Display names of conflicting entities. + type: array + items: + type: string + GoogleCloudDialogflowCxV3beta1WebhookRequest: + id: GoogleCloudDialogflowCxV3beta1WebhookRequest description: >- - Represents the intent to trigger programmatically rather than as a - result of natural language processing. + The request message for a webhook call. The request is sent as a JSON + object and the field names will be presented in camel cases. You may see + undocumented fields in an actual request. These fields are used + internally by Dialogflow and should be ignored. type: object properties: - intent: + detectIntentResponseId: description: >- - Required. The unique identifier of the intent. Format: - `projects//locations//agents//intents/`. + Always present. The unique identifier of the DetectIntentResponse + that will be returned to the API caller. type: string - GoogleCloudDialogflowCxV3beta1AudioInput: - id: GoogleCloudDialogflowCxV3beta1AudioInput - description: Represents the natural speech audio to be processed. - type: object - properties: - config: + text: description: >- - Required. Instructs the speech recognizer how to process the speech - audio. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1InputAudioConfig' - audio: + If natural language text was provided as input, this field will + contain a copy of the text. + type: string + triggerIntent: description: >- - The natural language speech audio to be processed. A single request - can contain up to 2 minutes of speech audio data. The transcribed - text cannot contain more than 256 bytes. For non-streaming audio - detect intent, both `config` and `audio` must be provided. For - streaming audio detect intent, `config` must be provided in the - first request and `audio` must be provided in all following - requests. + If an intent was provided as input, this field will contain a copy + of the intent identifier. Format: + `projects//locations//agents//intents/`. type: string - format: byte - GoogleCloudDialogflowCxV3beta1InputAudioConfig: - id: GoogleCloudDialogflowCxV3beta1InputAudioConfig - description: Instructs the speech recognizer on how to process the audio content. - type: object - properties: - audioEncoding: - description: Required. Audio encoding of the audio content to process. + transcript: + description: >- + If natural language speech audio was provided as input, this field + will contain the transcript for the audio. type: string - enumDescriptions: - - Not specified. - - Uncompressed 16-bit signed little-endian samples (Linear PCM). - - >- - [`FLAC`](https://xiph.org/flac/documentation.html) (Free Lossless - Audio Codec) is the recommended encoding because it is lossless - (therefore recognition is not compromised) and requires only about - half the bandwidth of `LINEAR16`. `FLAC` stream encoding supports - 16-bit and 24-bit samples, however, not all fields in `STREAMINFO` - are supported. - - >- - 8-bit samples that compand 14-bit audio samples using G.711 - PCMU/mu-law. - - >- - Adaptive Multi-Rate Narrowband codec. `sample_rate_hertz` must be - 8000. - - >- - Adaptive Multi-Rate Wideband codec. `sample_rate_hertz` must be - 16000. - - >- - Opus encoded audio frames in Ogg container - ([OggOpus](https://wiki.xiph.org/OggOpus)). `sample_rate_hertz` - must be 16000. - - >- - Although the use of lossy encodings is not recommended, if a very - low bitrate encoding is required, `OGG_OPUS` is highly preferred - over Speex encoding. The [Speex](https://speex.org/) encoding - supported by Dialogflow API has a header byte in each block, as in - MIME type `audio/x-speex-with-header-byte`. It is a variant of the - RTP Speex encoding defined in [RFC - 5574](https://tools.ietf.org/html/rfc5574). The stream is a - sequence of blocks, one block per RTP packet. Each block starts - with a byte containing the length of the block, in bytes, followed - by one or more frames of Speex data, padded to an integral number - of bytes (octets) as specified in RFC 5574. In other words, each - RTP header is replaced with a single byte containing the block - length. Only Speex wideband is supported. `sample_rate_hertz` must - be 16000. - - >- - 8-bit samples that compand 13-bit audio samples using G.711 - PCMU/a-law. - enum: - - AUDIO_ENCODING_UNSPECIFIED - - AUDIO_ENCODING_LINEAR_16 - - AUDIO_ENCODING_FLAC - - AUDIO_ENCODING_MULAW - - AUDIO_ENCODING_AMR - - AUDIO_ENCODING_AMR_WB - - AUDIO_ENCODING_OGG_OPUS - - AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE - - AUDIO_ENCODING_ALAW - sampleRateHertz: + triggerEvent: description: >- - Sample rate (in Hertz) of the audio content sent in the query. Refer - to [Cloud Speech API - documentation](https://cloud.google.com/speech-to-text/docs/basics) - for more details. - type: integer - format: int32 - enableWordInfo: + If an event was provided as input, this field will contain the name + of the event. + type: string + dtmfDigits: description: >- - Optional. If `true`, Dialogflow returns SpeechWordInfo in - StreamingRecognitionResult with information about the recognized - speech words, e.g. start and end time offsets. If false or - unspecified, Speech doesn't return any word-level information. - type: boolean - phraseHints: + If DTMF was provided as input, this field will contain the DTMF + digits. + type: string + languageCode: + description: The language code specified in the original request. + type: string + fulfillmentInfo: description: >- - Optional. A list of strings containing words and phrases that the - speech recognizer should recognize with higher likelihood. See [the - Cloud Speech - documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) - for more details. + Always present. Information about the fulfillment that triggered + this webhook call. + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo + intentInfo: + description: Information about the last matched intent. + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo + pageInfo: + description: Information about page status. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1PageInfo' + sessionInfo: + description: Information about session status. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1SessionInfo' + messages: + description: >- + The list of rich message responses to present to the user. Webhook + can choose to append or replace this list in + WebhookResponse.fulfillment_response; type: array items: - type: string - model: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1ResponseMessage' + payload: + description: Custom data set in QueryParameters.payload. + type: object + additionalProperties: + type: any + description: Properties of the object. + sentimentAnalysisResult: description: >- - Optional. Which Speech model to select for the given request. For - more information, see [Speech - models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). - type: string - modelVariant: - description: Optional. Which variant of the Speech model to use. - type: string - enumDescriptions: - - >- - No model variant specified. In this case Dialogflow defaults to - USE_BEST_AVAILABLE. - - >- - Use the best available variant of the Speech model that the caller - is eligible for. - - >- - Use standard model variant even if an enhanced model is available. - See the [Cloud Speech - documentation](https://cloud.google.com/speech-to-text/docs/enhanced-models) - for details about enhanced models. - - >- - Use an enhanced model variant: * If an enhanced variant does not - exist for the given model and request language, Dialogflow falls - back to the standard variant. The [Cloud Speech - documentation](https://cloud.google.com/speech-to-text/docs/enhanced-models) - describes which models have enhanced variants. - enum: - - SPEECH_MODEL_VARIANT_UNSPECIFIED - - USE_BEST_AVAILABLE - - USE_STANDARD - - USE_ENHANCED - singleUtterance: - description: >- - Optional. If `false` (default), recognition does not cease until the - client closes the stream. If `true`, the recognizer will detect a - single spoken utterance in input audio. Recognition ceases when it - detects the audio's voice has stopped or paused. In this case, once - a detected intent is received, the client should close the stream - and start a new request with a new stream as needed. Note: This - setting is relevant only for streaming methods. - type: boolean - bargeInConfig: - description: >- - Configuration of barge-in behavior during the streaming of input - audio. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1BargeInConfig' - optOutConformerModelMigration: - description: >- - If `true`, the request will opt out for STT conformer model - migration. This field will be deprecated once force migration takes - place in June 2024. Please refer to [Dialogflow CX Speech model - migration](https://cloud.google.com/dialogflow/cx/docs/concept/speech-model-migration). - type: boolean - GoogleCloudDialogflowCxV3beta1BargeInConfig: - id: GoogleCloudDialogflowCxV3beta1BargeInConfig - description: >- - Configuration of the barge-in behavior. Barge-in instructs the API to - return a detected utterance at a proper time while the client is playing - back the response audio from a previous request. When the client sees - the utterance, it should stop the playback and immediately get ready for - receiving the responses for the current request. The barge-in handling - requires the client to start streaming audio input as soon as it starts - playing back the audio from the previous response. The playback is - modeled into two phases: * No barge-in phase: which goes first and - during which speech detection should not be carried out. * Barge-in - phase: which follows the no barge-in phase and during which the API - starts speech detection and may inform the client that an utterance has - been detected. Note that no-speech event is not expected in this phase. - The client provides this configuration in terms of the durations of - those two phases. The durations are measured in terms of the audio - length from the the start of the input audio. No-speech event is a - response with END_OF_UTTERANCE without any transcript following up. + The sentiment analysis result of the current user request. The field + is filled when sentiment analysis is configured to be enabled for + the request. + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3beta1WebhookRequestSentimentAnalysisResult + languageInfo: + description: Information about the language of the request. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1LanguageInfo' + GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo: + id: GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo + description: Represents fulfillment information communicated to the webhook. type: object properties: - noBargeInDuration: + tag: description: >- - Duration that is not eligible for barge-in at the beginning of the - input audio. - type: string - format: google-duration - totalDuration: - description: Total duration for the playback at the beginning of the input audio. - type: string - format: google-duration - GoogleCloudDialogflowCxV3beta1EventInput: - id: GoogleCloudDialogflowCxV3beta1EventInput - description: Represents the event to trigger. - type: object - properties: - event: - description: Name of the event. - type: string - GoogleCloudDialogflowCxV3beta1DtmfInput: - id: GoogleCloudDialogflowCxV3beta1DtmfInput - description: Represents the input for dtmf event. - type: object - properties: - digits: - description: The dtmf digits. - type: string - finishDigit: - description: The finish digit (if any). + Always present. The value of the Fulfillment.tag field will be + populated in this field by Dialogflow when the associated webhook is + called. The tag is typically used by the webhook service to identify + which fulfillment is being called, but it could be used for other + purposes. type: string - GoogleCloudDialogflowCxV3beta1ToolCallResult: - id: GoogleCloudDialogflowCxV3beta1ToolCallResult - description: >- - The result of calling a tool's action that has been executed by the - client. + GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo: + id: GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo + description: Represents intent information communicated to the webhook. type: object properties: - tool: + lastMatchedIntent: description: >- - Required. The tool associated with this call. Format: - `projects//locations//agents//tools/`. + Always present. The unique identifier of the last matched intent. + Format: `projects//locations//agents//intents/`. type: string - action: - description: Required. The name of the tool's action associated with this call. + displayName: + description: Always present. The display name of the last matched intent. type: string - error: - description: The tool call's error. - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1ToolCallResultError - outputParameters: - description: The tool call's output parameters. + parameters: + description: >- + Parameters identified as a result of intent matching. This is a map + of the name of the identified parameter to the value of the + parameter identified from the user's utterance. All parameters + defined in the matched intent that are identified will be surfaced + here. type: object additionalProperties: - type: any - description: Properties of the object. - GoogleCloudDialogflowCxV3beta1ToolCallResultError: - id: GoogleCloudDialogflowCxV3beta1ToolCallResultError - description: An error produced by the tool call. + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfoIntentParameterValue + confidence: + description: >- + The confidence of the matched intent. Values range from 0.0 + (completely uncertain) to 1.0 (completely certain). + type: number + format: float + GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfoIntentParameterValue: + id: >- + GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfoIntentParameterValue + description: Represents a value for an intent parameter. type: object properties: - message: - description: Optional. The error message of the function. + originalValue: + description: Always present. Original text value extracted from user utterance. type: string - GoogleCloudDialogflowCxV3beta1ConversationTurnVirtualAgentOutput: - id: GoogleCloudDialogflowCxV3beta1ConversationTurnVirtualAgentOutput - description: The output from the virtual agent. + resolvedValue: + description: >- + Always present. Structured value for the parameter extracted from + user utterance. + type: any + GoogleCloudDialogflowCxV3beta1PageInfo: + id: GoogleCloudDialogflowCxV3beta1PageInfo + description: Represents page information communicated to and from the webhook. type: object properties: - sessionParameters: - description: The session parameters available to the bot at this point. - type: object - additionalProperties: - type: any - description: Properties of the object. - differences: + currentPage: description: >- - Output only. If this is part of a result conversation turn, the list - of differences between the original run and the replay for this - output, if any. - readOnly: true - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1TestRunDifference - diagnosticInfo: + Always present for WebhookRequest. Ignored for WebhookResponse. The + unique identifier of the current page. Format: + `projects//locations//agents//flows//pages/`. + type: string + displayName: description: >- - Required. Input only. The diagnostic info output for the turn. - Required to calculate the testing coverage. - type: object - additionalProperties: - type: any - description: Properties of the object. - triggeredIntent: + Always present for WebhookRequest. Ignored for WebhookResponse. The + display name of the current page. + type: string + formInfo: description: >- - The Intent that triggered the response. Only name and displayName - will be set. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1Intent' - currentPage: + Optional for both WebhookRequest and WebhookResponse. Information + about the form. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1PageInfoFormInfo' + GoogleCloudDialogflowCxV3beta1PageInfoFormInfo: + id: GoogleCloudDialogflowCxV3beta1PageInfoFormInfo + description: Represents form information. + type: object + properties: + parameterInfo: description: >- - The Page on which the utterance was spoken. Only name and - displayName will be set. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1Page' - textResponses: - description: The text responses from the agent for the turn. + Optional for both WebhookRequest and WebhookResponse. The parameters + contained in the form. Note that the webhook cannot add or remove + any form parameter. type: array items: $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1ResponseMessageText - status: - description: >- - Response error from the agent in the test result. If set, other - output is empty. - $ref: '#/components/schemas/GoogleRpcStatus' - GoogleCloudDialogflowCxV3beta1TestRunDifference: - id: GoogleCloudDialogflowCxV3beta1TestRunDifference - description: >- - The description of differences between original and replayed agent - output. + #/components/schemas/GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo + GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo: + id: GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo + description: Represents parameter information. type: object properties: - type: - description: The type of diff. + displayName: + description: >- + Always present for WebhookRequest. Required for WebhookResponse. The + human-readable name of the parameter, unique within the form. This + field cannot be modified by the webhook. type: string - enumDescriptions: - - Should never be used. - - The intent. - - The page. - - The parameters. - - The message utterance. - - The flow. - enum: - - DIFF_TYPE_UNSPECIFIED - - INTENT - - PAGE - - PARAMETERS - - UTTERANCE - - FLOW - description: + required: description: >- - A human readable description of the diff, showing the actual output - vs expected output. + Optional for both WebhookRequest and WebhookResponse. Indicates + whether the parameter is required. Optional parameters will not + trigger prompts; however, they are filled if the user specifies + them. Required parameters must be filled before form filling + concludes. + type: boolean + state: + description: >- + Always present for WebhookRequest. Required for WebhookResponse. The + state of the parameter. This field can be set to INVALID by the + webhook to invalidate the parameter; other values set by the webhook + will be ignored. type: string - GoogleCloudDialogflowCxV3beta1Intent: - id: GoogleCloudDialogflowCxV3beta1Intent - description: >- - An intent represents a user's intent to interact with a conversational - agent. You can provide information for the Dialogflow API to use to - match user input to an intent by adding training phrases (i.e., examples - of user input) to your intent. + enumDescriptions: + - Not specified. This value should be never used. + - Indicates that the parameter does not have a value. + - >- + Indicates that the parameter value is invalid. This field can be + used by the webhook to invalidate the parameter and ask the server + to collect it from the user again. + - Indicates that the parameter has a value. + enum: + - PARAMETER_STATE_UNSPECIFIED + - EMPTY + - INVALID + - FILLED + value: + description: >- + Optional for both WebhookRequest and WebhookResponse. The value of + the parameter. This field can be set by the webhook to change the + parameter value. + type: any + justCollected: + description: >- + Optional for WebhookRequest. Ignored for WebhookResponse. Indicates + if the parameter value was just collected on the last conversation + turn. + type: boolean + GoogleCloudDialogflowCxV3beta1SessionInfo: + id: GoogleCloudDialogflowCxV3beta1SessionInfo + description: Represents session information communicated to and from the webhook. type: object properties: - name: + session: description: >- - The unique identifier of the intent. Required for the - Intents.UpdateIntent method. Intents.CreateIntent populates the name - automatically. Format: `projects//locations//agents//intents/`. + Always present for WebhookRequest. Ignored for WebhookResponse. The + unique identifier of the session. This field can be used by the + webhook to identify a session. Format: + `projects//locations//agents//sessions/` or + `projects//locations//agents//environments//sessions/` if + environment is specified. type: string - displayName: + parameters: description: >- - Required. The human-readable name of the intent, unique within the - agent. + Optional for WebhookRequest. Optional for WebhookResponse. All + parameters collected from forms and intents during the session. + Parameters can be created, updated, or removed by the webhook. To + remove a parameter from the session, the webhook should explicitly + set the parameter value to null in WebhookResponse. The map is keyed + by parameters' display names. + type: object + additionalProperties: + type: any + GoogleCloudDialogflowCxV3beta1ResponseMessage: + id: GoogleCloudDialogflowCxV3beta1ResponseMessage + description: >- + Represents a response message that can be returned by a conversational + agent. Response messages are also used for output audio synthesis. The + approach is as follows: * If at least one OutputAudioText response is + present, then all OutputAudioText responses are linearly concatenated, + and the result is used for output audio synthesis. * If the + OutputAudioText responses are a mixture of text and SSML, then the + concatenated result is treated as SSML; otherwise, the result is treated + as either text or SSML as appropriate. The agent designer should ideally + use either text or SSML consistently throughout the bot design. * + Otherwise, all Text responses are linearly concatenated, and the result + is used for output audio synthesis. This approach allows for more + sophisticated user experience scenarios, where the text displayed to the + user may differ from what is heard. + type: object + properties: + text: + description: Returns a text response. + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3beta1ResponseMessageText + payload: + description: Returns a response containing a custom, platform-specific payload. + type: object + additionalProperties: + type: any + description: Properties of the object. + conversationSuccess: + description: Indicates that the conversation succeeded. + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess + outputAudioText: + description: >- + A text or ssml response that is preferentially used for TTS output + audio synthesis, as described in the comment on the ResponseMessage + message. + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText + liveAgentHandoff: + description: Hands off conversation to a human agent. + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff + endInteraction: + description: >- + Output only. A signal that indicates the interaction with the + Dialogflow agent has ended. This message is generated by Dialogflow + only when the conversation reaches `END_SESSION` page. It is not + supposed to be defined by the user. It's guaranteed that there is at + most one such message in each response. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction + playAudio: + description: >- + Signal that the client should play an audio clip hosted at a + client-specific URI. Dialogflow uses this to construct mixed_audio. + However, Dialogflow itself does not try to read or process the URI + in any way. + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio + mixedAudio: + description: >- + Output only. An audio response message composed of both the + synthesized Dialogflow agent responses and responses defined via + play_audio. This message is generated by Dialogflow only and not + supposed to be defined by the user. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio + telephonyTransferCall: + description: >- + A signal that the client should transfer the phone call connected to + this agent to a third-party endpoint. + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3beta1ResponseMessageTelephonyTransferCall + knowledgeInfoCard: + description: >- + Represents info card for knowledge answers, to be better rendered in + Dialogflow Messenger. + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3beta1ResponseMessageKnowledgeInfoCard + toolCall: + description: >- + Returns the definition of a tool call that should be executed by the + client. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1ToolCall' + channel: + description: >- + The channel which the response is associated with. Clients can + specify the channel via QueryParameters.channel, and only associated + channel response will be returned. type: string - trainingPhrases: + GoogleCloudDialogflowCxV3beta1ResponseMessageText: + id: GoogleCloudDialogflowCxV3beta1ResponseMessageText + description: The text response message. + type: object + properties: + text: description: >- - The collection of training phrases the agent is trained on to - identify the intent. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1IntentTrainingPhrase - parameters: - description: The collection of parameters associated with the intent. + Required. A collection of text response variants. If multiple + variants are defined, only one text response variant is returned at + runtime. type: array items: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1IntentParameter' - priority: - description: >- - The priority of this intent. Higher numbers represent higher - priorities. - If the supplied value is unspecified or 0, the service - translates the value to 500,000, which corresponds to the `Normal` - priority in the console. - If the supplied value is negative, the - intent is ignored in runtime detect intent requests. - type: integer - format: int32 - isFallback: + type: string + allowPlaybackInterruption: description: >- - Indicates whether this is a fallback intent. Currently only default - fallback intent is allowed in the agent, which is added upon agent - creation. Adding training phrases to fallback intent is useful in - the case of requests that are mistakenly matched, since training - phrases assigned to fallback intents act as negative examples that - triggers no-match event. + Output only. Whether the playback of this message can be interrupted + by the end user's speech and the client can then starts the next + Dialogflow request. + readOnly: true type: boolean - labels: - description: >- - The key/value metadata to label an intent. Labels can contain - lowercase letters, digits and the symbols '-' and '_'. International - characters are allowed, including letters from unicase alphabets. - Keys must start with a letter. Keys and values can be no longer than - 63 characters and no more than 128 bytes. Prefix "sys-" is reserved - for Dialogflow defined labels. Currently allowed Dialogflow defined - labels include: * sys-head * sys-contextual The above labels do not - require value. "sys-head" means the intent is a head intent. - "sys-contextual" means the intent is a contextual intent. + GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess: + id: GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess + description: >- + Indicates that the conversation succeeded, i.e., the bot handled the + issue that the customer talked to it about. Dialogflow only uses this to + determine which conversations should be counted as successful and + doesn't process the metadata in this message in any way. Note that + Dialogflow also considers conversations that get to the conversation end + page as successful even if they don't return ConversationSuccess. You + may set this, for example: * In the entry_fulfillment of a Page if + entering the page indicates that the conversation succeeded. * In a + webhook response when you determine that you handled the customer issue. + type: object + properties: + metadata: + description: Custom metadata. Dialogflow doesn't impose any structure on this. type: object additionalProperties: - type: string - description: - description: >- - Human readable description for better understanding an intent like - its scope, content, result etc. Maximum character limit: 140 - characters. - type: string - GoogleCloudDialogflowCxV3beta1IntentTrainingPhrase: - id: GoogleCloudDialogflowCxV3beta1IntentTrainingPhrase + type: any + description: Properties of the object. + GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText: + id: GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText description: >- - Represents an example that the agent is trained on to identify the - intent. + A text or ssml response that is preferentially used for TTS output audio + synthesis, as described in the comment on the ResponseMessage message. type: object properties: - id: - description: Output only. The unique identifier of the training phrase. + text: + description: The raw text to be synthesized. type: string - parts: + ssml: description: >- - Required. The ordered list of training phrase parts. The parts are - concatenated in order to form the training phrase. Note: The API - does not automatically annotate training phrases like the Dialogflow - Console does. Note: Do not forget to include whitespace at part - boundaries, so the training phrase is well formatted when the parts - are concatenated. If the training phrase does not need to be - annotated with parameters, you just need a single part with only the - Part.text field set. If you want to annotate the training phrase, - you must create multiple parts, where the fields of each part are - populated in one of two ways: - `Part.text` is set to a part of the - phrase that has no parameters. - `Part.text` is set to a part of the - phrase that you want to annotate, and the `parameter_id` field is - set. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1IntentTrainingPhrasePart - repeatCount: - description: Indicates how many times this example was added to the intent. - type: integer - format: int32 - GoogleCloudDialogflowCxV3beta1IntentTrainingPhrasePart: - id: GoogleCloudDialogflowCxV3beta1IntentTrainingPhrasePart - description: Represents a part of a training phrase. + The SSML text to be synthesized. For more information, see + [SSML](/speech/text-to-speech/docs/ssml). + type: string + allowPlaybackInterruption: + description: >- + Output only. Whether the playback of this message can be interrupted + by the end user's speech and the client can then starts the next + Dialogflow request. + readOnly: true + type: boolean + GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff: + id: GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff + description: >- + Indicates that the conversation should be handed off to a live agent. + Dialogflow only uses this to determine which conversations were handed + off to a human agent for measurement purposes. What else to do with this + signal is up to you and your handoff procedures. You may set this, for + example: * In the entry_fulfillment of a Page if entering the page + indicates something went extremely wrong in the conversation. * In a + webhook response when you determine that the customer issue can only be + handled by a human. type: object properties: - text: - description: Required. The text for this part. - type: string - parameterId: + metadata: description: >- - The parameter used to annotate this part of the training phrase. - This field is required for annotated parts of the training phrase. + Custom metadata for your handoff procedure. Dialogflow doesn't + impose any structure on this. + type: object + additionalProperties: + type: any + description: Properties of the object. + GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction: + id: GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction + description: >- + Indicates that interaction with the Dialogflow agent has ended. This + message is generated by Dialogflow only and not supposed to be defined + by the user. + type: object + properties: {} + GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio: + id: GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio + description: >- + Specifies an audio clip to be played by the client as part of the + response. + type: object + properties: + audioUri: + description: >- + Required. URI of the audio clip. Dialogflow does not impose any + validation on this value. It is specific to the client that reads + it. type: string - GoogleCloudDialogflowCxV3beta1IntentParameter: - id: GoogleCloudDialogflowCxV3beta1IntentParameter - description: Represents an intent parameter. + allowPlaybackInterruption: + description: >- + Output only. Whether the playback of this message can be interrupted + by the end user's speech and the client can then starts the next + Dialogflow request. + readOnly: true + type: boolean + GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio: + id: GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio + description: >- + Represents an audio message that is composed of both segments + synthesized from the Dialogflow agent prompts and ones hosted externally + at the specified URIs. The external URIs are specified via play_audio. + This message is generated by Dialogflow only and not supposed to be + defined by the user. type: object properties: - id: + segments: + description: Segments this audio response is composed of. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment + GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment: + id: GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment + description: Represents one segment of audio. + type: object + properties: + audio: description: >- - Required. The unique identifier of the parameter. This field is used - by training phrases to annotate their parts. + Raw audio synthesized from the Dialogflow agent's response using the + output config specified in the request. type: string - entityType: + format: byte + uri: description: >- - Required. The entity type of the parameter. Format: - `projects/-/locations/-/agents/-/entityTypes/` for system entity - types (for example, - `projects/-/locations/-/agents/-/entityTypes/sys.date`), or - `projects//locations//agents//entityTypes/` for developer entity - types. + Client-specific URI that points to an audio clip accessible to the + client. Dialogflow does not impose any validation on it. type: string - isList: - description: Indicates whether the parameter represents a list of values. - type: boolean - redact: + allowPlaybackInterruption: description: >- - Indicates whether the parameter content should be redacted in log. - If redaction is enabled, the parameter content will be replaced by - parameter name during logging. Note: the parameter content is - subject to redaction if either parameter level redaction or entity - type level redaction is enabled. + Output only. Whether the playback of this segment can be interrupted + by the end user's speech and the client should then start the next + Dialogflow request. + readOnly: true type: boolean - GoogleCloudDialogflowCxV3beta1Page: - id: GoogleCloudDialogflowCxV3beta1Page + GoogleCloudDialogflowCxV3beta1ResponseMessageTelephonyTransferCall: + id: GoogleCloudDialogflowCxV3beta1ResponseMessageTelephonyTransferCall description: >- - A Dialogflow CX conversation (session) can be described and visualized - as a state machine. The states of a CX session are represented by pages. - For each flow, you define many pages, where your combined pages can - handle a complete conversation on the topics the flow is designed for. - At any given moment, exactly one page is the current page, the current - page is considered active, and the flow associated with that page is - considered active. Every flow has a special start page. When a flow - initially becomes active, the start page page becomes the current page. - For each conversational turn, the current page will either stay the same - or transition to another page. You configure each page to collect - information from the end-user that is relevant for the conversational - state represented by the page. For more information, see the [Page - guide](https://cloud.google.com/dialogflow/cx/docs/concept/page). + Represents the signal that telles the client to transfer the phone call + connected to the agent to a third-party endpoint. type: object properties: - name: + phoneNumber: description: >- - The unique identifier of the page. Required for the Pages.UpdatePage - method. Pages.CreatePage populates the name automatically. Format: - `projects//locations//agents//flows//pages/`. + Transfer the call to a phone number in [E.164 + format](https://en.wikipedia.org/wiki/E.164). type: string - displayName: + GoogleCloudDialogflowCxV3beta1ResponseMessageKnowledgeInfoCard: + id: GoogleCloudDialogflowCxV3beta1ResponseMessageKnowledgeInfoCard + description: >- + Represents info card response. If the response contains generative + knowledge prediction, Dialogflow will return a payload with Infobot + Messenger compatible info card. Otherwise, the info card response is + skipped. + type: object + properties: {} + GoogleCloudDialogflowCxV3beta1ToolCall: + id: GoogleCloudDialogflowCxV3beta1ToolCall + description: Represents a call of a specific tool's action with the specified inputs. + type: object + properties: + tool: description: >- - Required. The human-readable name of the page, unique within the - flow. + Required. The tool associated with this call. Format: + `projects//locations//agents//tools/`. type: string - description: - description: The description of the page. The maximum length is 500 characters. + action: + description: Required. The name of the tool's action associated with this call. type: string - entryFulfillment: - description: The fulfillment to call when the session is entering the page. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1Fulfillment' - form: + inputParameters: + description: Optional. The action's input parameters. + type: object + additionalProperties: + type: any + description: Properties of the object. + GoogleCloudDialogflowCxV3beta1WebhookRequestSentimentAnalysisResult: + id: GoogleCloudDialogflowCxV3beta1WebhookRequestSentimentAnalysisResult + description: Represents the result of sentiment analysis. + type: object + properties: + score: description: >- - The form associated with the page, used for collecting parameters - relevant to the page. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1Form' - transitionRouteGroups: + Sentiment score between -1.0 (negative sentiment) and 1.0 (positive + sentiment). + type: number + format: float + magnitude: description: >- - Ordered list of `TransitionRouteGroups` added to the page. - Transition route groups must be unique within a page. If the page - links both flow-level transition route groups and agent-level - transition route groups, the flow-level ones will have higher - priority and will be put before the agent-level ones. * If multiple - transition routes within a page scope refer to the same intent, then - the precedence order is: page's transition route -> page's - transition route group -> flow's transition routes. * If multiple - transition route groups within a page contain the same intent, then - the first group in the ordered list takes precedence. - Format:`projects//locations//agents//flows//transitionRouteGroups/` - or `projects//locations//agents//transitionRouteGroups/` for - agent-level groups. - type: array - items: - type: string - transitionRoutes: + A non-negative number in the [0, +inf) range, which represents the + absolute magnitude of sentiment, regardless of score (positive or + negative). + type: number + format: float + GoogleCloudDialogflowCxV3beta1LanguageInfo: + id: GoogleCloudDialogflowCxV3beta1LanguageInfo + description: Represents the language information of the request. + type: object + properties: + inputLanguageCode: + description: The language code specified in the original request. + type: string + resolvedLanguageCode: description: >- - A list of transitions for the transition rules of this page. They - route the conversation to another page in the same flow, or another - flow. When we are in a certain page, the TransitionRoutes are - evalauted in the following order: * TransitionRoutes defined in the - page with intent specified. * TransitionRoutes defined in the - transition route groups with intent specified. * TransitionRoutes - defined in flow with intent specified. * TransitionRoutes defined in - the transition route groups with intent specified. * - TransitionRoutes defined in the page with only condition specified. - * TransitionRoutes defined in the transition route groups with only - condition specified. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1TransitionRoute' - eventHandlers: - description: >- - Handlers associated with the page to handle events such as webhook - errors, no match or no input. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1EventHandler' - advancedSettings: + The language code detected for this request based on the user + conversation. + type: string + confidenceScore: + description: The confidence score of the detected language between 0 and 1. + type: number + format: float + GoogleCloudDialogflowCxV3beta1WebhookResponse: + id: GoogleCloudDialogflowCxV3beta1WebhookResponse + description: The response message for a webhook call. + type: object + properties: + fulfillmentResponse: description: >- - Hierarchical advanced settings for this page. The settings exposed - at the lower level overrides the settings exposed at the higher - level. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1AdvancedSettings' - knowledgeConnectorSettings: - description: Optional. Knowledge connector configuration. + The fulfillment response to send to the user. This field can be + omitted by the webhook if it does not intend to send any response to + the user. $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1KnowledgeConnectorSettings - GoogleCloudDialogflowCxV3beta1Fulfillment: - id: GoogleCloudDialogflowCxV3beta1Fulfillment - description: >- - A fulfillment can do one or more of the following actions at the same - time: * Generate rich message responses. * Set parameter values. * Call - the webhook. Fulfillments can be called at various stages in the Page or - Form lifecycle. For example, when a DetectIntentRequest drives a session - to enter a new page, the page's entry fulfillment can add a static - response to the QueryResult in the returning DetectIntentResponse, call - the webhook (for example, to load user data from a database), or both. + #/components/schemas/GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse + pageInfo: + description: >- + Information about page status. This field can be omitted by the + webhook if it does not intend to modify page status. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1PageInfo' + sessionInfo: + description: >- + Information about session status. This field can be omitted by the + webhook if it does not intend to modify session status. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1SessionInfo' + payload: + description: Value to append directly to QueryResult.webhook_payloads. + type: object + additionalProperties: + type: any + description: Properties of the object. + targetPage: + description: >- + The target page to transition to. Format: + `projects//locations//agents//flows//pages/`. + type: string + targetFlow: + description: >- + The target flow to transition to. Format: + `projects//locations//agents//flows/`. + type: string + GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse: + id: GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse + description: Represents a fulfillment response to the user. type: object properties: messages: @@ -8233,6561 +8917,8111 @@ components: type: array items: $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1ResponseMessage' - webhook: - description: >- - The webhook to call. Format: - `projects//locations//agents//webhooks/`. - type: string - returnPartialResponses: - description: >- - Whether Dialogflow should return currently queued fulfillment - response messages in streaming APIs. If a webhook is specified, it - happens before Dialogflow invokes webhook. Warning: 1) This flag - only affects streaming API. Responses are still queued and returned - once in non-streaming API. 2) The flag can be enabled in any - fulfillment but only the first 3 partial responses will be returned. - You may only want to apply it to fulfillments that have slow - webhooks. - type: boolean - tag: - description: >- - The value of this field will be populated in the WebhookRequest - `fulfillmentInfo.tag` field by Dialogflow when the associated - webhook is called. The tag is typically used by the webhook service - to identify which fulfillment is being called, but it could be used - for other purposes. This field is required if `webhook` is - specified. + mergeBehavior: + description: Merge behavior for `messages`. type: string - setParameterActions: - description: Set parameter values before executing the webhook. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1FulfillmentSetParameterAction - conditionalCases: - description: Conditional cases for this fulfillment. + enumDescriptions: + - Not specified. `APPEND` will be used. + - >- + `messages` will be appended to the list of messages waiting to be + sent to the user. + - >- + `messages` will replace the list of messages waiting to be sent to + the user. + enum: + - MERGE_BEHAVIOR_UNSPECIFIED + - APPEND + - REPLACE + GoogleCloudDialogflowCxV3beta1BatchRunTestCasesMetadata: + id: GoogleCloudDialogflowCxV3beta1BatchRunTestCasesMetadata + description: >- + Metadata returned for the TestCases.BatchRunTestCases long running + operation. + type: object + properties: + errors: + description: The test errors. type: array items: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases - advancedSettings: - description: >- - Hierarchical advanced settings for this fulfillment. The settings - exposed at the lower level overrides the settings exposed at the - higher level. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1AdvancedSettings' - enableGenerativeFallback: - description: >- - If the flag is true, the agent will utilize LLM to generate a text - response. If LLM generation fails, the defined responses in the - fulfillment will be respected. This flag is only useful for - fulfillments associated with no-match event handlers. - type: boolean - GoogleCloudDialogflowCxV3beta1FulfillmentSetParameterAction: - id: GoogleCloudDialogflowCxV3beta1FulfillmentSetParameterAction - description: Setting a parameter value. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1TestError' + GoogleCloudDialogflowCxV3beta1TestError: + id: GoogleCloudDialogflowCxV3beta1TestError + description: Error info for running a test. type: object properties: - parameter: - description: Display name of the parameter. + testCase: + description: The test case resource name. type: string - value: - description: The new value of the parameter. A null value clears the parameter. - type: any - GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases: - id: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases - description: >- - A list of cascading if-else conditions. Cases are mutually exclusive. - The first one with a matching condition is selected, all the rest - ignored. + status: + description: The status associated with the test. + $ref: '#/components/schemas/GoogleRpcStatus' + testTime: + description: The timestamp when the test was completed. + type: string + format: google-datetime + GoogleCloudDialogflowCxV3beta1BatchRunTestCasesResponse: + id: GoogleCloudDialogflowCxV3beta1BatchRunTestCasesResponse + description: The response message for TestCases.BatchRunTestCases. type: object properties: - cases: - description: A list of cascading if-else conditions. + results: + description: >- + The test case results. The detailed conversation turns are empty in + this response. type: array items: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesCase - GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesCase: - id: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesCase - description: >- - Each case has a Boolean condition. When it is evaluated to be True, the - corresponding messages will be selected and evaluated recursively. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1TestCaseResult' + GoogleCloudDialogflowCxV3beta1TestCaseResult: + id: GoogleCloudDialogflowCxV3beta1TestCaseResult + description: Represents a result from running a test case in an agent environment. type: object properties: - condition: + name: description: >- - The condition to activate and select this case. Empty means the - condition is always true. The condition is evaluated against form - parameters or session parameters. See the [conditions - reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). + The resource name for the test case result. Format: + `projects//locations//agents//testCases//results/`. type: string - caseContent: - description: A list of case content. + environment: + description: >- + Environment where the test was run. If not set, it indicates the + draft environment. + type: string + conversationTurns: + description: >- + The conversation turns uttered during the test case replay in + chronological order. type: array items: $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesCaseCaseContent - GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesCaseCaseContent: - id: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesCaseCaseContent - description: The list of messages or conditional cases to activate for this case. - type: object - properties: - message: - description: Returned message. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1ResponseMessage' - additionalCases: - description: Additional cases to be evaluated. - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases - GoogleCloudDialogflowCxV3beta1AdvancedSettings: - id: GoogleCloudDialogflowCxV3beta1AdvancedSettings + #/components/schemas/GoogleCloudDialogflowCxV3beta1ConversationTurn + testResult: + description: Whether the test case passed in the agent environment. + type: string + enumDescriptions: + - Not specified. Should never be used. + - The test passed. + - The test did not pass. + enum: + - TEST_RESULT_UNSPECIFIED + - PASSED + - FAILED + testTime: + description: The time that the test was run. + type: string + format: google-datetime + GoogleCloudDialogflowCxV3beta1ConversationTurn: + id: GoogleCloudDialogflowCxV3beta1ConversationTurn description: >- - Hierarchical advanced settings for - agent/flow/page/fulfillment/parameter. Settings exposed at lower level - overrides the settings exposed at higher level. Overriding occurs at the - sub-setting level. For example, the playback_interruption_settings at - fulfillment level only overrides the playback_interruption_settings at - the agent level, leaving other settings at the agent level unchanged. - DTMF settings does not override each other. DTMF settings set at - different levels define DTMF detections running in parallel. Hierarchy: - Agent->Flow->Page->Fulfillment/Parameter. + One interaction between a human and virtual agent. The human provides + some input and the virtual agent provides a response. type: object properties: - audioExportGcsDestination: - description: >- - If present, incoming audio is exported by Dialogflow to the - configured Google Cloud Storage destination. Exposed at the - following levels: - Agent level - Flow level - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1GcsDestination' - speechSettings: - description: >- - Settings for speech to text detection. Exposed at the following - levels: - Agent level - Flow level - Page level - Parameter level - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings - dtmfSettings: - description: >- - Settings for DTMF. Exposed at the following levels: - Agent level - - Flow level - Page level - Parameter level. + userInput: + description: The user input. $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1AdvancedSettingsDtmfSettings - loggingSettings: - description: >- - Settings for logging. Settings for Dialogflow History, Contact - Center messages, StackDriver logs, and speech logging. Exposed at - the following levels: - Agent level. + #/components/schemas/GoogleCloudDialogflowCxV3beta1ConversationTurnUserInput + virtualAgentOutput: + description: The virtual agent output. $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings - GoogleCloudDialogflowCxV3beta1GcsDestination: - id: GoogleCloudDialogflowCxV3beta1GcsDestination - description: >- - Google Cloud Storage location for a Dialogflow operation that writes or - exports objects (e.g. exported agent or transcripts) outside of - Dialogflow. - type: object - properties: - uri: - description: >- - Required. The Google Cloud Storage URI for the exported objects. A - URI is of the form: `gs://bucket/object-name-or-prefix` Whether a - full object name, or just a prefix, its usage depends on the - Dialogflow operation. - type: string - GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings: - id: GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings - description: Define behaviors of speech to text detection. + #/components/schemas/GoogleCloudDialogflowCxV3beta1ConversationTurnVirtualAgentOutput + GoogleCloudDialogflowCxV3beta1ConversationTurnUserInput: + id: GoogleCloudDialogflowCxV3beta1ConversationTurnUserInput + description: The input from the human user. type: object properties: - endpointerSensitivity: - description: >- - Sensitivity of the speech model that detects the end of speech. - Scale from 0 to 100. - type: integer - format: int32 - noSpeechTimeout: - description: Timeout before detecting no speech. - type: string - format: google-duration - useTimeoutBasedEndpointing: - description: >- - Use timeout based endpointing, interpreting endpointer sensitivy as - seconds of timeout value. - type: boolean - models: + input: + description: Supports text input, event input, dtmf input in the test case. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1QueryInput' + injectedParameters: description: >- - Mapping from language to Speech-to-Text model. The mapped - Speech-to-Text model will be selected for requests from its - corresponding language. For more information, see [Speech - models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + Parameters that need to be injected into the conversation during + intent detection. type: object additionalProperties: - type: string - GoogleCloudDialogflowCxV3beta1AdvancedSettingsDtmfSettings: - id: GoogleCloudDialogflowCxV3beta1AdvancedSettingsDtmfSettings - description: Define behaviors for DTMF (dual tone multi frequency). - type: object - properties: - enabled: + type: any + description: Properties of the object. + isWebhookEnabled: description: >- - If true, incoming audio is processed for DTMF (dual tone multi - frequency) events. For example, if the caller presses a button on - their telephone keypad and DTMF processing is enabled, Dialogflow - will detect the event (e.g. a "3" was pressed) in the incoming audio - and pass the event to the bot to drive business logic (e.g. when 3 - is pressed, return the account balance). + If webhooks should be allowed to trigger in response to the user + utterance. Often if parameters are injected, webhooks should not be + enabled. type: boolean - maxDigits: - description: Max length of DTMF digits. - type: integer - format: int32 - finishDigit: - description: The digit that terminates a DTMF digit sequence. - type: string - interdigitTimeoutDuration: - description: Interdigit timeout setting for matching dtmf input to regex. - type: string - format: google-duration - endpointingTimeoutDuration: - description: Endpoint timeout setting for matching dtmf input to regex. - type: string - format: google-duration - GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings: - id: GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings - description: Define behaviors on logging. + enableSentimentAnalysis: + description: Whether sentiment analysis is enabled. + type: boolean + GoogleCloudDialogflowCxV3beta1QueryInput: + id: GoogleCloudDialogflowCxV3beta1QueryInput + description: >- + Represents the query input. It can contain one of: 1. A conversational + query in the form of text. 2. An intent query that specifies which + intent to trigger. 3. Natural language speech audio to be processed. 4. + An event to be triggered. 5. DTMF digits to invoke an intent and fill in + parameter value. 6. The results of a tool executed by the client. type: object properties: - enableStackdriverLogging: - description: Enables Google Cloud Logging. - type: boolean - enableInteractionLogging: - description: Enables DF Interaction logging. - type: boolean - enableConsentBasedRedaction: + text: + description: The natural language text to be processed. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1TextInput' + intent: + description: The intent to be triggered. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1IntentInput' + audio: + description: The natural language speech audio to be processed. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1AudioInput' + event: + description: The event to be triggered. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1EventInput' + dtmf: + description: The DTMF event to be handled. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1DtmfInput' + toolCallResult: + description: The results of a tool executed by the client. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1ToolCallResult' + languageCode: description: >- - Enables consent-based end-user input redaction, if true, a - pre-defined session parameter - `$session.params.conversation-redaction` will be used to determine - if the utterance should be redacted. - type: boolean - GoogleCloudDialogflowCxV3beta1Form: - id: GoogleCloudDialogflowCxV3beta1Form - description: >- - A form is a data model that groups related parameters that can be - collected from the user. The process in which the agent prompts the user - and collects parameter values from the user is called form filling. A - form can be added to a page. When form filling is done, the filled - parameters will be written to the session. + Required. The language of the input. See [Language + Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) + for a list of the currently supported language codes. Note that + queries in the same session do not necessarily need to specify the + same language. + type: string + GoogleCloudDialogflowCxV3beta1TextInput: + id: GoogleCloudDialogflowCxV3beta1TextInput + description: Represents the natural language text to be processed. type: object properties: - parameters: - description: Parameters to collect from the user. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1FormParameter' - GoogleCloudDialogflowCxV3beta1FormParameter: - id: GoogleCloudDialogflowCxV3beta1FormParameter - description: Represents a form parameter. + text: + description: Required. The UTF-8 encoded natural language text to be processed. + type: string + GoogleCloudDialogflowCxV3beta1IntentInput: + id: GoogleCloudDialogflowCxV3beta1IntentInput + description: >- + Represents the intent to trigger programmatically rather than as a + result of natural language processing. type: object properties: - displayName: + intent: description: >- - Required. The human-readable name of the parameter, unique within - the form. + Required. The unique identifier of the intent. Format: + `projects//locations//agents//intents/`. type: string - required: + GoogleCloudDialogflowCxV3beta1AudioInput: + id: GoogleCloudDialogflowCxV3beta1AudioInput + description: Represents the natural speech audio to be processed. + type: object + properties: + config: description: >- - Indicates whether the parameter is required. Optional parameters - will not trigger prompts; however, they are filled if the user - specifies them. Required parameters must be filled before form - filling concludes. - type: boolean - entityType: + Required. Instructs the speech recognizer how to process the speech + audio. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1InputAudioConfig' + audio: description: >- - Required. The entity type of the parameter. Format: - `projects/-/locations/-/agents/-/entityTypes/` for system entity - types (for example, - `projects/-/locations/-/agents/-/entityTypes/sys.date`), or - `projects//locations//agents//entityTypes/` for developer entity - types. + The natural language speech audio to be processed. A single request + can contain up to 2 minutes of speech audio data. The transcribed + text cannot contain more than 256 bytes. For non-streaming audio + detect intent, both `config` and `audio` must be provided. For + streaming audio detect intent, `config` must be provided in the + first request and `audio` must be provided in all following + requests. type: string - isList: - description: Indicates whether the parameter represents a list of values. - type: boolean - fillBehavior: - description: Required. Defines fill behavior for the parameter. - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1FormParameterFillBehavior - defaultValue: - description: >- - The default value of an optional parameter. If the parameter is - required, the default value will be ignored. - type: any - redact: - description: >- - Indicates whether the parameter content should be redacted in log. - If redaction is enabled, the parameter content will be replaced by - parameter name during logging. Note: the parameter content is - subject to redaction if either parameter level redaction or entity - type level redaction is enabled. - type: boolean - advancedSettings: - description: >- - Hierarchical advanced settings for this parameter. The settings - exposed at the lower level overrides the settings exposed at the - higher level. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1AdvancedSettings' - GoogleCloudDialogflowCxV3beta1FormParameterFillBehavior: - id: GoogleCloudDialogflowCxV3beta1FormParameterFillBehavior - description: Configuration for how the filling of a parameter should be handled. + format: byte + GoogleCloudDialogflowCxV3beta1InputAudioConfig: + id: GoogleCloudDialogflowCxV3beta1InputAudioConfig + description: Instructs the speech recognizer on how to process the audio content. type: object properties: - initialPromptFulfillment: - description: >- - Required. The fulfillment to provide the initial prompt that the - agent can present to the user in order to fill the parameter. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1Fulfillment' - repromptEventHandlers: + audioEncoding: + description: Required. Audio encoding of the audio content to process. + type: string + enumDescriptions: + - Not specified. + - >- + Uncompressed 16-bit signed little-endian samples (Linear PCM). + LINT: LEGACY_NAMES + - >- + [`FLAC`](https://xiph.org/flac/documentation.html) (Free Lossless + Audio Codec) is the recommended encoding because it is lossless + (therefore recognition is not compromised) and requires only about + half the bandwidth of `LINEAR16`. `FLAC` stream encoding supports + 16-bit and 24-bit samples, however, not all fields in `STREAMINFO` + are supported. + - >- + 8-bit samples that compand 14-bit audio samples using G.711 + PCMU/mu-law. + - >- + Adaptive Multi-Rate Narrowband codec. `sample_rate_hertz` must be + 8000. + - >- + Adaptive Multi-Rate Wideband codec. `sample_rate_hertz` must be + 16000. + - >- + Opus encoded audio frames in Ogg container + ([OggOpus](https://wiki.xiph.org/OggOpus)). `sample_rate_hertz` + must be 16000. + - >- + Although the use of lossy encodings is not recommended, if a very + low bitrate encoding is required, `OGG_OPUS` is highly preferred + over Speex encoding. The [Speex](https://speex.org/) encoding + supported by Dialogflow API has a header byte in each block, as in + MIME type `audio/x-speex-with-header-byte`. It is a variant of the + RTP Speex encoding defined in [RFC + 5574](https://tools.ietf.org/html/rfc5574). The stream is a + sequence of blocks, one block per RTP packet. Each block starts + with a byte containing the length of the block, in bytes, followed + by one or more frames of Speex data, padded to an integral number + of bytes (octets) as specified in RFC 5574. In other words, each + RTP header is replaced with a single byte containing the block + length. Only Speex wideband is supported. `sample_rate_hertz` must + be 16000. + - >- + 8-bit samples that compand 13-bit audio samples using G.711 + PCMU/a-law. + enum: + - AUDIO_ENCODING_UNSPECIFIED + - AUDIO_ENCODING_LINEAR_16 + - AUDIO_ENCODING_FLAC + - AUDIO_ENCODING_MULAW + - AUDIO_ENCODING_AMR + - AUDIO_ENCODING_AMR_WB + - AUDIO_ENCODING_OGG_OPUS + - AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE + - AUDIO_ENCODING_ALAW + sampleRateHertz: description: >- - The handlers for parameter-level events, used to provide reprompt - for the parameter or transition to a different page/flow. The - supported events are: * `sys.no-match-`, where N can be from 1 to 6 - * `sys.no-match-default` * `sys.no-input-`, where N can be from 1 to - 6 * `sys.no-input-default` * `sys.invalid-parameter` - `initial_prompt_fulfillment` provides the first prompt for the - parameter. If the user's response does not fill the parameter, a - no-match/no-input event will be triggered, and the fulfillment - associated with the `sys.no-match-1`/`sys.no-input-1` handler (if - defined) will be called to provide a prompt. The - `sys.no-match-2`/`sys.no-input-2` handler (if defined) will respond - to the next no-match/no-input event, and so on. A - `sys.no-match-default` or `sys.no-input-default` handler will be - used to handle all following no-match/no-input events after all - numbered no-match/no-input handlers for the parameter are consumed. - A `sys.invalid-parameter` handler can be defined to handle the case - where the parameter values have been `invalidated` by webhook. For - example, if the user's response fill the parameter, however the - parameter was invalidated by webhook, the fulfillment associated - with the `sys.invalid-parameter` handler (if defined) will be called - to provide a prompt. If the event handler for the corresponding - event can't be found on the parameter, `initial_prompt_fulfillment` - will be re-prompted. + Sample rate (in Hertz) of the audio content sent in the query. Refer + to [Cloud Speech API + documentation](https://cloud.google.com/speech-to-text/docs/basics) + for more details. + type: integer + format: int32 + enableWordInfo: + description: >- + Optional. If `true`, Dialogflow returns SpeechWordInfo in + StreamingRecognitionResult with information about the recognized + speech words, e.g. start and end time offsets. If false or + unspecified, Speech doesn't return any word-level information. + type: boolean + phraseHints: + description: >- + Optional. A list of strings containing words and phrases that the + speech recognizer should recognize with higher likelihood. See [the + Cloud Speech + documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) + for more details. type: array items: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1EventHandler' - GoogleCloudDialogflowCxV3beta1EventHandler: - id: GoogleCloudDialogflowCxV3beta1EventHandler + type: string + model: + description: >- + Optional. Which Speech model to select for the given request. For + more information, see [Speech + models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + type: string + modelVariant: + description: Optional. Which variant of the Speech model to use. + type: string + enumDescriptions: + - >- + No model variant specified. In this case Dialogflow defaults to + USE_BEST_AVAILABLE. + - >- + Use the best available variant of the Speech model that the caller + is eligible for. + - >- + Use standard model variant even if an enhanced model is available. + See the [Cloud Speech + documentation](https://cloud.google.com/speech-to-text/docs/enhanced-models) + for details about enhanced models. + - >- + Use an enhanced model variant: * If an enhanced variant does not + exist for the given model and request language, Dialogflow falls + back to the standard variant. The [Cloud Speech + documentation](https://cloud.google.com/speech-to-text/docs/enhanced-models) + describes which models have enhanced variants. + enum: + - SPEECH_MODEL_VARIANT_UNSPECIFIED + - USE_BEST_AVAILABLE + - USE_STANDARD + - USE_ENHANCED + singleUtterance: + description: >- + Optional. If `false` (default), recognition does not cease until the + client closes the stream. If `true`, the recognizer will detect a + single spoken utterance in input audio. Recognition ceases when it + detects the audio's voice has stopped or paused. In this case, once + a detected intent is received, the client should close the stream + and start a new request with a new stream as needed. Note: This + setting is relevant only for streaming methods. + type: boolean + bargeInConfig: + description: >- + Configuration of barge-in behavior during the streaming of input + audio. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1BargeInConfig' + optOutConformerModelMigration: + description: >- + If `true`, the request will opt out for STT conformer model + migration. This field will be deprecated once force migration takes + place in June 2024. Please refer to [Dialogflow CX Speech model + migration](https://cloud.google.com/dialogflow/cx/docs/concept/speech-model-migration). + type: boolean + GoogleCloudDialogflowCxV3beta1BargeInConfig: + id: GoogleCloudDialogflowCxV3beta1BargeInConfig description: >- - An event handler specifies an event that can be handled during a - session. When the specified event happens, the following actions are - taken in order: * If there is a `trigger_fulfillment` associated with - the event, it will be called. * If there is a `target_page` associated - with the event, the session will transition into the specified page. * - If there is a `target_flow` associated with the event, the session will - transition into the specified flow. + Configuration of the barge-in behavior. Barge-in instructs the API to + return a detected utterance at a proper time while the client is playing + back the response audio from a previous request. When the client sees + the utterance, it should stop the playback and immediately get ready for + receiving the responses for the current request. The barge-in handling + requires the client to start streaming audio input as soon as it starts + playing back the audio from the previous response. The playback is + modeled into two phases: * No barge-in phase: which goes first and + during which speech detection should not be carried out. * Barge-in + phase: which follows the no barge-in phase and during which the API + starts speech detection and may inform the client that an utterance has + been detected. Note that no-speech event is not expected in this phase. + The client provides this configuration in terms of the durations of + those two phases. The durations are measured in terms of the audio + length from the start of the input audio. No-speech event is a response + with END_OF_UTTERANCE without any transcript following up. type: object properties: - name: - description: Output only. The unique identifier of this event handler. - readOnly: true + noBargeInDuration: + description: >- + Duration that is not eligible for barge-in at the beginning of the + input audio. type: string - event: - description: Required. The name of the event to handle. + format: google-duration + totalDuration: + description: Total duration for the playback at the beginning of the input audio. type: string - triggerFulfillment: - description: >- - The fulfillment to call when the event occurs. Handling webhook - errors with a fulfillment enabled with webhook could cause infinite - loop. It is invalid to specify such fulfillment for a handler - handling webhooks. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1Fulfillment' - targetPage: - description: >- - The target page to transition to. Format: - `projects//locations//agents//flows//pages/`. + format: google-duration + GoogleCloudDialogflowCxV3beta1EventInput: + id: GoogleCloudDialogflowCxV3beta1EventInput + description: Represents the event to trigger. + type: object + properties: + event: + description: Name of the event. type: string - targetFlow: - description: >- - The target flow to transition to. Format: - `projects//locations//agents//flows/`. + GoogleCloudDialogflowCxV3beta1DtmfInput: + id: GoogleCloudDialogflowCxV3beta1DtmfInput + description: Represents the input for dtmf event. + type: object + properties: + digits: + description: The dtmf digits. type: string - targetPlaybook: - description: >- - The target playbook to transition to. Format: - `projects//locations//agents//playbooks/`. + finishDigit: + description: The finish digit (if any). type: string - GoogleCloudDialogflowCxV3beta1TransitionRoute: - id: GoogleCloudDialogflowCxV3beta1TransitionRoute + GoogleCloudDialogflowCxV3beta1ToolCallResult: + id: GoogleCloudDialogflowCxV3beta1ToolCallResult description: >- - A transition route specifies a intent that can be matched and/or a data - condition that can be evaluated during a session. When a specified - transition is matched, the following actions are taken in order: * If - there is a `trigger_fulfillment` associated with the transition, it will - be called. * If there is a `target_page` associated with the transition, - the session will transition into the specified page. * If there is a - `target_flow` associated with the transition, the session will - transition into the specified flow. + The result of calling a tool's action that has been executed by the + client. type: object properties: - name: - description: Output only. The unique identifier of this transition route. - readOnly: true - type: string - description: + tool: description: >- - Optional. The description of the transition route. The maximum - length is 500 characters. + Required. The tool associated with this call. Format: + `projects//locations//agents//tools/`. type: string - intent: - description: >- - The unique identifier of an Intent. Format: - `projects//locations//agents//intents/`. Indicates that the - transition can only happen when the given intent is matched. At - least one of `intent` or `condition` must be specified. When both - `intent` and `condition` are specified, the transition can only - happen when both are fulfilled. - type: string - condition: - description: >- - The condition to evaluate against form parameters or session - parameters. See the [conditions - reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). - At least one of `intent` or `condition` must be specified. When both - `intent` and `condition` are specified, the transition can only - happen when both are fulfilled. - type: string - triggerFulfillment: - description: >- - The fulfillment to call when the condition is satisfied. At least - one of `trigger_fulfillment` and `target` must be specified. When - both are defined, `trigger_fulfillment` is executed first. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1Fulfillment' - targetPage: - description: >- - The target page to transition to. Format: - `projects//locations//agents//flows//pages/`. + action: + description: Required. The name of the tool's action associated with this call. type: string - targetFlow: - description: >- - The target flow to transition to. Format: - `projects//locations//agents//flows/`. + error: + description: The tool call's error. + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3beta1ToolCallResultError + outputParameters: + description: The tool call's output parameters. + type: object + additionalProperties: + type: any + description: Properties of the object. + GoogleCloudDialogflowCxV3beta1ToolCallResultError: + id: GoogleCloudDialogflowCxV3beta1ToolCallResultError + description: An error produced by the tool call. + type: object + properties: + message: + description: Optional. The error message of the function. type: string - GoogleCloudDialogflowCxV3beta1KnowledgeConnectorSettings: - id: GoogleCloudDialogflowCxV3beta1KnowledgeConnectorSettings - description: >- - The Knowledge Connector settings for this page or flow. This includes - information such as the attached Knowledge Bases, and the way to execute - fulfillment. + GoogleCloudDialogflowCxV3beta1ConversationTurnVirtualAgentOutput: + id: GoogleCloudDialogflowCxV3beta1ConversationTurnVirtualAgentOutput + description: The output from the virtual agent. type: object properties: - enabled: - description: Whether Knowledge Connector is enabled or not. - type: boolean - triggerFulfillment: + sessionParameters: + description: The session parameters available to the bot at this point. + type: object + additionalProperties: + type: any + description: Properties of the object. + differences: description: >- - The fulfillment to be triggered. When the answers from the Knowledge - Connector are selected by Dialogflow, you can utitlize the request - scoped parameter `$request.knowledge.answers` (contains up to the 5 - highest confidence answers) and `$request.knowledge.questions` - (contains the corresponding questions) to construct the fulfillment. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1Fulfillment' - targetPage: + Output only. If this is part of a result conversation turn, the list + of differences between the original run and the replay for this + output, if any. + readOnly: true + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3beta1TestRunDifference + diagnosticInfo: description: >- - The target page to transition to. Format: - `projects//locations//agents//flows//pages/`. - type: string - targetFlow: + Required. Input only. The diagnostic info output for the turn. + Required to calculate the testing coverage. + type: object + additionalProperties: + type: any + description: Properties of the object. + triggeredIntent: description: >- - The target flow to transition to. Format: - `projects//locations//agents//flows/`. - type: string - dataStoreConnections: - description: Optional. List of related data store connections. + The Intent that triggered the response. Only name and displayName + will be set. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1Intent' + currentPage: + description: >- + The Page on which the utterance was spoken. Only name and + displayName will be set. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1Page' + textResponses: + description: The text responses from the agent for the turn. type: array items: $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1DataStoreConnection - GoogleCloudDialogflowCxV3beta1DataStoreConnection: - id: GoogleCloudDialogflowCxV3beta1DataStoreConnection + #/components/schemas/GoogleCloudDialogflowCxV3beta1ResponseMessageText + status: + description: >- + Response error from the agent in the test result. If set, other + output is empty. + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudDialogflowCxV3beta1TestRunDifference: + id: GoogleCloudDialogflowCxV3beta1TestRunDifference description: >- - A data store connection. It represents a data store in Discovery Engine - and the type of the contents it contains. + The description of differences between original and replayed agent + output. type: object properties: - dataStoreType: - description: The type of the connected data store. + type: + description: The type of diff. type: string enumDescriptions: - - >- - Not specified. This value indicates that the data store type is - not specified, so it will not be used during search. - - A data store that contains public web content. - - A data store that contains unstructured private data. - - A data store that contains structured data (for example FAQ). + - Should never be used. + - The intent. + - The page. + - The parameters. + - The message utterance. + - The flow. enum: - - DATA_STORE_TYPE_UNSPECIFIED - - PUBLIC_WEB - - UNSTRUCTURED - - STRUCTURED - dataStore: + - DIFF_TYPE_UNSPECIFIED + - INTENT + - PAGE + - PARAMETERS + - UTTERANCE + - FLOW + description: description: >- - The full name of the referenced data store. Formats: - `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` - `projects/{project}/locations/{location}/dataStores/{data_store}` + A human readable description of the diff, showing the actual output + vs expected output. type: string - GoogleCloudDialogflowCxV3beta1RunTestCaseMetadata: - id: GoogleCloudDialogflowCxV3beta1RunTestCaseMetadata - description: >- - Metadata returned for the TestCases.RunTestCase long running operation. - This message currently has no fields. - type: object - properties: {} - GoogleCloudDialogflowCxV3beta1RunTestCaseResponse: - id: GoogleCloudDialogflowCxV3beta1RunTestCaseResponse - description: The response message for TestCases.RunTestCase. - type: object - properties: - result: - description: The result. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1TestCaseResult' - GoogleCloudDialogflowCxV3beta1ExportTestCasesMetadata: - id: GoogleCloudDialogflowCxV3beta1ExportTestCasesMetadata + GoogleCloudDialogflowCxV3beta1Intent: + id: GoogleCloudDialogflowCxV3beta1Intent description: >- - Metadata returned for the TestCases.ExportTestCases long running - operation. This message currently has no fields. - type: object - properties: {} - GoogleCloudDialogflowCxV3beta1ExportTestCasesResponse: - id: GoogleCloudDialogflowCxV3beta1ExportTestCasesResponse - description: The response message for TestCases.ExportTestCases. + An intent represents a user's intent to interact with a conversational + agent. You can provide information for the Dialogflow API to use to + match user input to an intent by adding training phrases (i.e., examples + of user input) to your intent. type: object properties: - gcsUri: + name: description: >- - The URI to a file containing the exported test cases. This field is - populated only if `gcs_uri` is specified in ExportTestCasesRequest. - type: string - content: - description: Uncompressed raw byte content for test cases. + The unique identifier of the intent. Required for the + Intents.UpdateIntent method. Intents.CreateIntent populates the name + automatically. Format: `projects//locations//agents//intents/`. type: string - format: byte - GoogleCloudDialogflowCxV3beta1ImportTestCasesMetadata: - id: GoogleCloudDialogflowCxV3beta1ImportTestCasesMetadata - description: >- - Metadata returned for the TestCases.ImportTestCases long running - operation. - type: object - properties: - errors: - description: Errors for failed test cases. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1TestCaseError' - GoogleCloudDialogflowCxV3beta1TestCaseError: - id: GoogleCloudDialogflowCxV3beta1TestCaseError - description: Error info for importing a test. - type: object - properties: - testCase: - description: The test case. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1TestCase' - status: - description: The status associated with the test case. - $ref: '#/components/schemas/GoogleRpcStatus' - GoogleCloudDialogflowCxV3beta1TestCase: - id: GoogleCloudDialogflowCxV3beta1TestCase - description: Represents a test case. - type: object - properties: - name: + displayName: description: >- - The unique identifier of the test case. TestCases.CreateTestCase - will populate the name automatically. Otherwise use format: - `projects//locations//agents//testCases/`. + Required. The human-readable name of the intent, unique within the + agent. type: string - tags: + trainingPhrases: description: >- - Tags are short descriptions that users may apply to test cases for - organizational and filtering purposes. Each tag should start with - "#" and has a limit of 30 characters. + The collection of training phrases the agent is trained on to + identify the intent. type: array items: - type: string - displayName: - description: >- - Required. The human-readable name of the test case, unique within - the agent. Limit of 200 characters. - type: string - notes: + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3beta1IntentTrainingPhrase + parameters: + description: The collection of parameters associated with the intent. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1IntentParameter' + priority: description: >- - Additional freeform notes about the test case. Limit of 400 - characters. - type: string - testConfig: - description: Config for the test case. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1TestConfig' - testCaseConversationTurns: + The priority of this intent. Higher numbers represent higher + priorities. - If the supplied value is unspecified or 0, the service + translates the value to 500,000, which corresponds to the `Normal` + priority in the console. - If the supplied value is negative, the + intent is ignored in runtime detect intent requests. + type: integer + format: int32 + isFallback: description: >- - The conversation turns uttered when the test case was created, in - chronological order. These include the canonical set of agent - utterances that should occur when the agent is working properly. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1ConversationTurn - creationTime: - description: Output only. When the test was created. - readOnly: true - type: string - format: google-datetime - lastTestResult: - description: The latest test result. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1TestCaseResult' - GoogleCloudDialogflowCxV3beta1TestConfig: - id: GoogleCloudDialogflowCxV3beta1TestConfig - description: Represents configurations for a test case. - type: object - properties: - trackingParameters: - description: Session parameters to be compared when calculating differences. - type: array - items: - type: string - flow: + Indicates whether this is a fallback intent. Currently only default + fallback intent is allowed in the agent, which is added upon agent + creation. Adding training phrases to fallback intent is useful in + the case of requests that are mistakenly matched, since training + phrases assigned to fallback intents act as negative examples that + triggers no-match event. + type: boolean + labels: description: >- - Flow name to start the test case with. Format: - `projects//locations//agents//flows/`. Only one of `flow` and `page` - should be set to indicate the starting point of the test case. If - neither is set, the test case will start with start page on the - default start flow. - type: string - page: + The key/value metadata to label an intent. Labels can contain + lowercase letters, digits and the symbols '-' and '_'. International + characters are allowed, including letters from unicase alphabets. + Keys must start with a letter. Keys and values can be no longer than + 63 characters and no more than 128 bytes. Prefix "sys-" is reserved + for Dialogflow defined labels. Currently allowed Dialogflow defined + labels include: * sys-head * sys-contextual The above labels do not + require value. "sys-head" means the intent is a head intent. + "sys-contextual" means the intent is a contextual intent. + type: object + additionalProperties: + type: string + description: description: >- - The page to start the test case with. Format: - `projects//locations//agents//flows//pages/`. Only one of `flow` and - `page` should be set to indicate the starting point of the test - case. If neither is set, the test case will start with start page on - the default start flow. + Human readable description for better understanding an intent like + its scope, content, result etc. Maximum character limit: 140 + characters. type: string - GoogleCloudDialogflowCxV3beta1ImportTestCasesResponse: - id: GoogleCloudDialogflowCxV3beta1ImportTestCasesResponse - description: The response message for TestCases.ImportTestCases. - type: object - properties: - names: - description: >- - The unique identifiers of the new test cases. Format: - `projects//locations//agents//testCases/`. - type: array - items: - type: string - GoogleCloudDialogflowCxV3beta1RunContinuousTestMetadata: - id: GoogleCloudDialogflowCxV3beta1RunContinuousTestMetadata + GoogleCloudDialogflowCxV3beta1IntentTrainingPhrase: + id: GoogleCloudDialogflowCxV3beta1IntentTrainingPhrase description: >- - Metadata returned for the Environments.RunContinuousTest long running - operation. + Represents an example that the agent is trained on to identify the + intent. type: object properties: - errors: - description: The test errors. + id: + description: Output only. The unique identifier of the training phrase. + readOnly: true + type: string + parts: + description: >- + Required. The ordered list of training phrase parts. The parts are + concatenated in order to form the training phrase. Note: The API + does not automatically annotate training phrases like the Dialogflow + Console does. Note: Do not forget to include whitespace at part + boundaries, so the training phrase is well formatted when the parts + are concatenated. If the training phrase does not need to be + annotated with parameters, you just need a single part with only the + Part.text field set. If you want to annotate the training phrase, + you must create multiple parts, where the fields of each part are + populated in one of two ways: - `Part.text` is set to a part of the + phrase that has no parameters. - `Part.text` is set to a part of the + phrase that you want to annotate, and the `parameter_id` field is + set. type: array items: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1TestError' - GoogleCloudDialogflowCxV3beta1RunContinuousTestResponse: - id: GoogleCloudDialogflowCxV3beta1RunContinuousTestResponse - description: The response message for Environments.RunContinuousTest. - type: object - properties: - continuousTestResult: - description: The result for a continuous test run. - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1ContinuousTestResult - GoogleCloudDialogflowCxV3beta1ContinuousTestResult: - id: GoogleCloudDialogflowCxV3beta1ContinuousTestResult - description: Represents a result from running a test case in an agent environment. + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3beta1IntentTrainingPhrasePart + repeatCount: + description: Indicates how many times this example was added to the intent. + type: integer + format: int32 + GoogleCloudDialogflowCxV3beta1IntentTrainingPhrasePart: + id: GoogleCloudDialogflowCxV3beta1IntentTrainingPhrasePart + description: Represents a part of a training phrase. type: object properties: - name: - description: >- - The resource name for the continuous test result. Format: - `projects//locations//agents//environments//continuousTestResults/`. - type: string - result: - description: >- - The result of this continuous test run, i.e. whether all the tests - in this continuous test run pass or not. + text: + description: Required. The text for this part. type: string - enumDescriptions: - - Not specified. Should never be used. - - All the tests passed. - - At least one test did not pass. - enum: - - AGGREGATED_TEST_RESULT_UNSPECIFIED - - PASSED - - FAILED - testCaseResults: + parameterId: description: >- - A list of individual test case results names in this continuous test - run. - type: array - items: - type: string - runTime: - description: Time when the continuous testing run starts. + The parameter used to annotate this part of the training phrase. + This field is required for annotated parts of the training phrase. type: string - format: google-datetime - GoogleCloudDialogflowCxV3beta1DeployFlowMetadata: - id: GoogleCloudDialogflowCxV3beta1DeployFlowMetadata - description: >- - Metadata returned for the Environments.DeployFlow long running - operation. - type: object - properties: - testErrors: - description: Errors of running deployment tests. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1TestError' - GoogleCloudDialogflowCxV3beta1DeployFlowResponse: - id: GoogleCloudDialogflowCxV3beta1DeployFlowResponse - description: The response message for Environments.DeployFlow. + GoogleCloudDialogflowCxV3beta1IntentParameter: + id: GoogleCloudDialogflowCxV3beta1IntentParameter + description: Represents an intent parameter. type: object properties: - environment: - description: The updated environment where the flow is deployed. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1Environment' - deployment: + id: description: >- - The name of the flow version deployment. Format: - `projects//locations//agents//environments//deployments/`. + Required. The unique identifier of the parameter. This field is used + by training phrases to annotate their parts. type: string - GoogleCloudDialogflowCxV3beta1Environment: - id: GoogleCloudDialogflowCxV3beta1Environment + entityType: + description: >- + Required. The entity type of the parameter. Format: + `projects/-/locations/-/agents/-/entityTypes/` for system entity + types (for example, + `projects/-/locations/-/agents/-/entityTypes/sys.date`), or + `projects//locations//agents//entityTypes/` for developer entity + types. + type: string + isList: + description: Indicates whether the parameter represents a list of values. + type: boolean + redact: + description: >- + Indicates whether the parameter content should be redacted in log. + If redaction is enabled, the parameter content will be replaced by + parameter name during logging. Note: the parameter content is + subject to redaction if either parameter level redaction or entity + type level redaction is enabled. + type: boolean + GoogleCloudDialogflowCxV3beta1Page: + id: GoogleCloudDialogflowCxV3beta1Page description: >- - Represents an environment for an agent. You can create multiple versions - of your agent and publish them to separate environments. When you edit - an agent, you are editing the draft agent. At any point, you can save - the draft agent as an agent version, which is an immutable snapshot of - your agent. When you save the draft agent, it is published to the - default environment. When you create agent versions, you can publish - them to custom environments. You can create a variety of custom - environments for testing, development, production, etc. + A Dialogflow CX conversation (session) can be described and visualized + as a state machine. The states of a CX session are represented by pages. + For each flow, you define many pages, where your combined pages can + handle a complete conversation on the topics the flow is designed for. + At any given moment, exactly one page is the current page, the current + page is considered active, and the flow associated with that page is + considered active. Every flow has a special start page. When a flow + initially becomes active, the start page page becomes the current page. + For each conversational turn, the current page will either stay the same + or transition to another page. You configure each page to collect + information from the end-user that is relevant for the conversational + state represented by the page. For more information, see the [Page + guide](https://cloud.google.com/dialogflow/cx/docs/concept/page). type: object properties: name: description: >- - The name of the environment. Format: - `projects//locations//agents//environments/`. + The unique identifier of the page. Required for the Pages.UpdatePage + method. Pages.CreatePage populates the name automatically. Format: + `projects//locations//agents//flows//pages/`. type: string displayName: description: >- - Required. The human-readable name of the environment (unique in an - agent). Limit of 64 characters. + Required. The human-readable name of the page, unique within the + flow. type: string description: - description: >- - The human-readable description of the environment. The maximum - length is 500 characters. If exceeded, the request is rejected. + description: The description of the page. The maximum length is 500 characters. type: string - versionConfigs: - description: >- - A list of configurations for flow versions. You should include - version configs for all flows that are reachable from `Start Flow` - in the agent. Otherwise, an error will be returned. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1EnvironmentVersionConfig - updateTime: - description: Output only. Update time of this environment. - readOnly: true - type: string - format: google-datetime - testCasesConfig: - description: The test cases config for continuous tests of this environment. - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1EnvironmentTestCasesConfig - webhookConfig: - description: The webhook configuration for this environment. - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1EnvironmentWebhookConfig - GoogleCloudDialogflowCxV3beta1EnvironmentVersionConfig: - id: GoogleCloudDialogflowCxV3beta1EnvironmentVersionConfig - description: Configuration for the version. - type: object - properties: - version: + entryFulfillment: + description: The fulfillment to call when the session is entering the page. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1Fulfillment' + form: description: >- - Required. Both flow and playbook versions are supported. Format for - flow version: projects//locations//agents//flows//versions/. Format - for playbook version: - projects//locations//agents//playbooks//versions/. - type: string - GoogleCloudDialogflowCxV3beta1EnvironmentTestCasesConfig: - id: GoogleCloudDialogflowCxV3beta1EnvironmentTestCasesConfig - description: The configuration for continuous tests. - type: object - properties: - testCases: + The form associated with the page, used for collecting parameters + relevant to the page. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1Form' + transitionRouteGroups: description: >- - A list of test case names to run. They should be under the same - agent. Format of each test case name: - `projects//locations//agents//testCases/` + Ordered list of `TransitionRouteGroups` added to the page. + Transition route groups must be unique within a page. If the page + links both flow-level transition route groups and agent-level + transition route groups, the flow-level ones will have higher + priority and will be put before the agent-level ones. * If multiple + transition routes within a page scope refer to the same intent, then + the precedence order is: page's transition route -> page's + transition route group -> flow's transition routes. * If multiple + transition route groups within a page contain the same intent, then + the first group in the ordered list takes precedence. + Format:`projects//locations//agents//flows//transitionRouteGroups/` + or `projects//locations//agents//transitionRouteGroups/` for + agent-level groups. type: array items: type: string - enableContinuousRun: - description: >- - Whether to run test cases in TestCasesConfig.test_cases - periodically. Default false. If set to true, run once a day. - type: boolean - enablePredeploymentRun: + transitionRoutes: description: >- - Whether to run test cases in TestCasesConfig.test_cases before - deploying a flow version to the environment. Default false. - type: boolean - GoogleCloudDialogflowCxV3beta1EnvironmentWebhookConfig: - id: GoogleCloudDialogflowCxV3beta1EnvironmentWebhookConfig - description: Configuration for webhooks. - type: object - properties: - webhookOverrides: + A list of transitions for the transition rules of this page. They + route the conversation to another page in the same flow, or another + flow. When we are in a certain page, the TransitionRoutes are + evaluated in the following order: * TransitionRoutes defined in the + page with intent specified. * TransitionRoutes defined in the + transition route groups with intent specified. * TransitionRoutes + defined in flow with intent specified. * TransitionRoutes defined in + the transition route groups with intent specified. * + TransitionRoutes defined in the page with only condition specified. + * TransitionRoutes defined in the transition route groups with only + condition specified. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1TransitionRoute' + eventHandlers: description: >- - The list of webhooks to override for the agent environment. The - webhook must exist in the agent. You can override fields in - `generic_web_service` and `service_directory`. + Handlers associated with the page to handle events such as webhook + errors, no match or no input. type: array items: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1Webhook' - GoogleCloudDialogflowCxV3beta1Webhook: - id: GoogleCloudDialogflowCxV3beta1Webhook + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1EventHandler' + advancedSettings: + description: >- + Hierarchical advanced settings for this page. The settings exposed + at the lower level overrides the settings exposed at the higher + level. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1AdvancedSettings' + knowledgeConnectorSettings: + description: Optional. Knowledge connector configuration. + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3beta1KnowledgeConnectorSettings + GoogleCloudDialogflowCxV3beta1Fulfillment: + id: GoogleCloudDialogflowCxV3beta1Fulfillment description: >- - Webhooks host the developer's business logic. During a session, webhooks - allow the developer to use the data extracted by Dialogflow's natural - language processing to generate dynamic responses, validate collected - data, or trigger actions on the backend. + A fulfillment can do one or more of the following actions at the same + time: * Generate rich message responses. * Set parameter values. * Call + the webhook. Fulfillments can be called at various stages in the Page or + Form lifecycle. For example, when a DetectIntentRequest drives a session + to enter a new page, the page's entry fulfillment can add a static + response to the QueryResult in the returning DetectIntentResponse, call + the webhook (for example, to load user data from a database), or both. type: object properties: - name: + messages: + description: The list of rich message responses to present to the user. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1ResponseMessage' + webhook: description: >- - The unique identifier of the webhook. Required for the - Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the - name automatically. Format: + The webhook to call. Format: `projects//locations//agents//webhooks/`. type: string - displayName: + returnPartialResponses: description: >- - Required. The human-readable name of the webhook, unique within the - agent. + Whether Dialogflow should return currently queued fulfillment + response messages in streaming APIs. If a webhook is specified, it + happens before Dialogflow invokes webhook. Warning: 1) This flag + only affects streaming API. Responses are still queued and returned + once in non-streaming API. 2) The flag can be enabled in any + fulfillment but only the first 3 partial responses will be returned. + You may only want to apply it to fulfillments that have slow + webhooks. + type: boolean + tag: + description: >- + The value of this field will be populated in the WebhookRequest + `fulfillmentInfo.tag` field by Dialogflow when the associated + webhook is called. The tag is typically used by the webhook service + to identify which fulfillment is being called, but it could be used + for other purposes. This field is required if `webhook` is + specified. type: string - genericWebService: - description: Configuration for a generic web service. - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1WebhookGenericWebService - serviceDirectory: + setParameterActions: + description: Set parameter values before executing the webhook. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3beta1FulfillmentSetParameterAction + conditionalCases: + description: Conditional cases for this fulfillment. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases + advancedSettings: description: >- - Configuration for a [Service - Directory](https://cloud.google.com/service-directory) service. - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1WebhookServiceDirectoryConfig - timeout: + Hierarchical advanced settings for this fulfillment. The settings + exposed at the lower level overrides the settings exposed at the + higher level. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1AdvancedSettings' + enableGenerativeFallback: description: >- - Webhook execution timeout. Execution is considered failed if - Dialogflow doesn't receive a response from webhook at the end of the - timeout period. Defaults to 5 seconds, maximum allowed timeout is 30 - seconds. - type: string - format: google-duration - disabled: - description: Indicates whether the webhook is disabled. + If the flag is true, the agent will utilize LLM to generate a text + response. If LLM generation fails, the defined responses in the + fulfillment will be respected. This flag is only useful for + fulfillments associated with no-match event handlers. type: boolean - GoogleCloudDialogflowCxV3beta1WebhookGenericWebService: - id: GoogleCloudDialogflowCxV3beta1WebhookGenericWebService - description: Represents configuration for a generic web service. + generators: + description: A list of Generators to be called during this fulfillment. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3beta1FulfillmentGeneratorSettings + GoogleCloudDialogflowCxV3beta1FulfillmentSetParameterAction: + id: GoogleCloudDialogflowCxV3beta1FulfillmentSetParameterAction + description: Setting a parameter value. type: object properties: - uri: - description: >- - Required. The webhook URI for receiving POST requests. It must use - https protocol. - type: string - username: - description: The user name for HTTP Basic authentication. - deprecated: true - type: string - password: - description: The password for HTTP Basic authentication. - deprecated: true + parameter: + description: Display name of the parameter. type: string - requestHeaders: - description: The HTTP request headers to send together with webhook requests. - type: object - additionalProperties: - type: string - allowedCaCerts: - description: >- - Optional. Specifies a list of allowed custom CA certificates (in DER - format) for HTTPS verification. This overrides the default SSL trust - store. If this is empty or unspecified, Dialogflow will use Google's - default trust store to verify certificates. N.B. Make sure the HTTPS - server certificates are signed with "subject alt name". For instance - a certificate can be self-signed using the following command, ``` - openssl x509 -req -days 200 -in example.com.csr \ -signkey - example.com.key \ -out example.com.crt \ -extfile <(printf - "\nsubjectAltName='DNS:www.example.com'") ``` + value: + description: The new value of the parameter. A null value clears the parameter. + type: any + GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases: + id: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases + description: >- + A list of cascading if-else conditions. Cases are mutually exclusive. + The first one with a matching condition is selected, all the rest + ignored. + type: object + properties: + cases: + description: A list of cascading if-else conditions. type: array items: - type: string - format: byte - oauthConfig: - description: >- - Optional. The OAuth configuration of the webhook. If specified, - Dialogflow will initiate the OAuth client credential flow to - exchange an access token from the 3rd party platform and put it in - the auth header. - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig - serviceAgentAuth: - description: >- - Optional. Indicate the auth token type generated from the - [Diglogflow service - agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). - The generated token is sent in the Authorization header. - type: string - enumDescriptions: - - Service agent auth type unspecified. Default to ID_TOKEN. - - No token used. - - >- - Use [ID - token](https://cloud.google.com/docs/authentication/token-types#id) - generated from service agent. This can be used to access Cloud - Function and Cloud Run after you grant Invoker role to - `service-@gcp-sa-dialogflow.iam.gserviceaccount.com`. - - >- - Use [access - token](https://cloud.google.com/docs/authentication/token-types#access) - generated from service agent. This can be used to access other - Google Cloud APIs after you grant required roles to - `service-@gcp-sa-dialogflow.iam.gserviceaccount.com`. - enum: - - SERVICE_AGENT_AUTH_UNSPECIFIED - - NONE - - ID_TOKEN - - ACCESS_TOKEN - webhookType: - description: Optional. Type of the webhook. - type: string - enumDescriptions: - - Default value. This value is unused. - - Represents a standard webhook. - - Represents a flexible webhook. - enum: - - WEBHOOK_TYPE_UNSPECIFIED - - STANDARD - - FLEXIBLE - httpMethod: - description: >- - Optional. HTTP method for the flexible webhook calls. Standard - webhook always uses POST. - type: string - enumDescriptions: - - HTTP method not specified. - - HTTP POST Method. - - HTTP GET Method. - - HTTP HEAD Method. - - HTTP PUT Method. - - HTTP DELETE Method. - - HTTP PATCH Method. - - HTTP OPTIONS Method. - enum: - - HTTP_METHOD_UNSPECIFIED - - POST - - GET - - HEAD - - PUT - - DELETE - - PATCH - - OPTIONS - requestBody: - description: >- - Optional. Defines a custom JSON object as request body to send to - flexible webhook. - type: string - parameterMapping: - description: >- - Optional. Maps the values extracted from specific fields of the - flexible webhook response into session parameters. - Key: session - parameter name - Value: field path in the webhook response - type: object - additionalProperties: - type: string - GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig: - id: GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesCase + GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesCase: + id: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesCase description: >- - Represents configuration of OAuth client credential flow for 3rd party - API authentication. + Each case has a Boolean condition. When it is evaluated to be True, the + corresponding messages will be selected and evaluated recursively. type: object properties: - clientId: - description: Required. The client ID provided by the 3rd party platform. - type: string - clientSecret: - description: Required. The client secret provided by the 3rd party platform. - type: string - tokenEndpoint: + condition: description: >- - Required. The token endpoint provided by the 3rd party platform to - exchange an access token. + The condition to activate and select this case. Empty means the + condition is always true. The condition is evaluated against form + parameters or session parameters. See the [conditions + reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). type: string - scopes: - description: Optional. The OAuth scopes to grant. + caseContent: + description: A list of case content. type: array items: - type: string - GoogleCloudDialogflowCxV3beta1WebhookServiceDirectoryConfig: - id: GoogleCloudDialogflowCxV3beta1WebhookServiceDirectoryConfig + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesCaseCaseContent + GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesCaseCaseContent: + id: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesCaseCaseContent + description: The list of messages or conditional cases to activate for this case. + type: object + properties: + message: + description: Returned message. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1ResponseMessage' + additionalCases: + description: Additional cases to be evaluated. + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases + GoogleCloudDialogflowCxV3beta1AdvancedSettings: + id: GoogleCloudDialogflowCxV3beta1AdvancedSettings description: >- - Represents configuration for a [Service - Directory](https://cloud.google.com/service-directory) service. + Hierarchical advanced settings for + agent/flow/page/fulfillment/parameter. Settings exposed at lower level + overrides the settings exposed at higher level. Overriding occurs at the + sub-setting level. For example, the playback_interruption_settings at + fulfillment level only overrides the playback_interruption_settings at + the agent level, leaving other settings at the agent level unchanged. + DTMF settings does not override each other. DTMF settings set at + different levels define DTMF detections running in parallel. Hierarchy: + Agent->Flow->Page->Fulfillment/Parameter. type: object properties: - service: + audioExportGcsDestination: description: >- - Required. The name of [Service - Directory](https://cloud.google.com/service-directory) service. - Format: `projects//locations//namespaces//services/`. `Location ID` - of the service directory must be the same as the location of the - agent. - type: string - genericWebService: - description: Generic Service configuration of this webhook. + If present, incoming audio is exported by Dialogflow to the + configured Google Cloud Storage destination. Exposed at the + following levels: - Agent level - Flow level + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1GcsDestination' + speechSettings: + description: >- + Settings for speech to text detection. Exposed at the following + levels: - Agent level - Flow level - Page level - Parameter level $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1WebhookGenericWebService - GoogleCloudDialogflowCxV3beta1ConversationSignals: - id: GoogleCloudDialogflowCxV3beta1ConversationSignals + #/components/schemas/GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings + dtmfSettings: + description: >- + Settings for DTMF. Exposed at the following levels: - Agent level - + Flow level - Page level - Parameter level. + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3beta1AdvancedSettingsDtmfSettings + loggingSettings: + description: >- + Settings for logging. Settings for Dialogflow History, Contact + Center messages, StackDriver logs, and speech logging. Exposed at + the following levels: - Agent level. + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings + GoogleCloudDialogflowCxV3beta1GcsDestination: + id: GoogleCloudDialogflowCxV3beta1GcsDestination description: >- - This message is used to hold all the Conversation Signals data, which - will be converted to JSON and exported to BigQuery. + Google Cloud Storage location for a Dialogflow operation that writes or + exports objects (e.g. exported agent or transcripts) outside of + Dialogflow. type: object properties: - turnSignals: - description: Required. Turn signals for the current turn. - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1TurnSignals' - GoogleCloudDialogflowCxV3beta1TurnSignals: - id: GoogleCloudDialogflowCxV3beta1TurnSignals - description: >- - Collection of all signals that were extracted for a single turn of the - conversation. + uri: + description: >- + Required. The Google Cloud Storage URI for the exported objects. A + URI is of the form: `gs://bucket/object-name-or-prefix` Whether a + full object name, or just a prefix, its usage depends on the + Dialogflow operation. + type: string + GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings: + id: GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings + description: Define behaviors of speech to text detection. type: object properties: - noMatch: - description: Whether NLU predicted NO_MATCH. - type: boolean - noUserInput: - description: Whether user provided no input. - type: boolean - dtmfUsed: - description: Whether user was using DTMF input. - type: boolean - userEscalated: - description: Whether user was specifically asking for a live agent. - type: boolean - agentEscalated: - description: Whether agent responded with LiveAgentHandoff fulfillment. - type: boolean - reachedEndPage: - description: Whether turn resulted in End Session page. + endpointerSensitivity: + description: >- + Sensitivity of the speech model that detects the end of speech. + Scale from 0 to 100. + type: integer + format: int32 + noSpeechTimeout: + description: Timeout before detecting no speech. + type: string + format: google-duration + useTimeoutBasedEndpointing: + description: >- + Use timeout based endpointing, interpreting endpointer sensitivity + as seconds of timeout value. type: boolean - webhookStatuses: - description: Human-readable statuses of the webhooks triggered during this turn. - type: array - items: - type: string - failureReasons: - description: Failure reasons of the turn. - type: array - items: + models: + description: >- + Mapping from language to Speech-to-Text model. The mapped + Speech-to-Text model will be selected for requests from its + corresponding language. For more information, see [Speech + models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models). + type: object + additionalProperties: type: string - enumDescriptions: - - Failure reason is not assigned. - - Whether NLU failed to recognize user intent. - - Whether webhook failed during the turn. - enum: - - FAILURE_REASON_UNSPECIFIED - - FAILED_INTENT - - FAILED_WEBHOOK - sentimentScore: + GoogleCloudDialogflowCxV3beta1AdvancedSettingsDtmfSettings: + id: GoogleCloudDialogflowCxV3beta1AdvancedSettingsDtmfSettings + description: Define behaviors for DTMF (dual tone multi frequency). + type: object + properties: + enabled: description: >- - Sentiment score of the user utterance if - [sentiment](https://cloud.google.com/dialogflow/cx/docs/concept/sentiment) - was enabled. - type: number - format: float - sentimentMagnitude: - description: >- - Sentiment magnitude of the user utterance if - [sentiment](https://cloud.google.com/dialogflow/cx/docs/concept/sentiment) - was enabled. - type: number - format: float - GoogleCloudDialogflowV2BatchUpdateEntityTypesResponse: - id: GoogleCloudDialogflowV2BatchUpdateEntityTypesResponse - description: The response message for EntityTypes.BatchUpdateEntityTypes. - type: object - properties: - entityTypes: - description: The collection of updated or created entity types. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDialogflowV2EntityType' - GoogleCloudDialogflowV2EntityType: - id: GoogleCloudDialogflowV2EntityType - description: >- - Each intent parameter has a type, called the entity type, which dictates - exactly how data from an end-user expression is extracted. Dialogflow - provides predefined system entities that can match many common types of - data. For example, there are system entities for matching dates, times, - colors, email addresses, and so on. You can also create your own custom - entities for matching custom data. For example, you could define a - vegetable entity that can match the types of vegetables available for - purchase with a grocery store agent. For more information, see the - [Entity - guide](https://cloud.google.com/dialogflow/docs/entities-overview). - type: object - properties: - name: - description: >- - The unique identifier of the entity type. Required for - EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes - methods. Format: `projects//agent/entityTypes/`. - type: string - displayName: - description: Required. The name of the entity type. + If true, incoming audio is processed for DTMF (dual tone multi + frequency) events. For example, if the caller presses a button on + their telephone keypad and DTMF processing is enabled, Dialogflow + will detect the event (e.g. a "3" was pressed) in the incoming audio + and pass the event to the bot to drive business logic (e.g. when 3 + is pressed, return the account balance). + type: boolean + maxDigits: + description: Max length of DTMF digits. + type: integer + format: int32 + finishDigit: + description: The digit that terminates a DTMF digit sequence. type: string - kind: - description: Required. Indicates the kind of entity type. + interdigitTimeoutDuration: + description: Interdigit timeout setting for matching dtmf input to regex. type: string - enumDescriptions: - - Not specified. This value should be never used. - - >- - Map entity types allow mapping of a group of synonyms to a - reference value. - - >- - List entity types contain a set of entries that do not map to - reference values. However, list entity types can contain - references to other entity types (with or without aliases). - - >- - Regexp entity types allow to specify regular expressions in - entries values. - enum: - - KIND_UNSPECIFIED - - KIND_MAP - - KIND_LIST - - KIND_REGEXP - autoExpansionMode: - description: >- - Optional. Indicates whether the entity type can be automatically - expanded. + format: google-duration + endpointingTimeoutDuration: + description: Endpoint timeout setting for matching dtmf input to regex. type: string - enumDescriptions: - - Auto expansion disabled for the entity. - - >- - Allows an agent to recognize values that have not been explicitly - listed in the entity. - enum: - - AUTO_EXPANSION_MODE_UNSPECIFIED - - AUTO_EXPANSION_MODE_DEFAULT - entities: + format: google-duration + GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings: + id: GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings + description: Define behaviors on logging. + type: object + properties: + enableStackdriverLogging: + description: Enables Google Cloud Logging. + type: boolean + enableInteractionLogging: + description: Enables DF Interaction logging. + type: boolean + enableConsentBasedRedaction: description: >- - Optional. The collection of entity entries associated with the - entity type. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDialogflowV2EntityTypeEntity' - enableFuzzyExtraction: - description: Optional. Enables fuzzy entity extraction during classification. + Enables consent-based end-user input redaction, if true, a + pre-defined session parameter + `$session.params.conversation-redaction` will be used to determine + if the utterance should be redacted. type: boolean - GoogleCloudDialogflowV2EntityTypeEntity: - id: GoogleCloudDialogflowV2EntityTypeEntity - description: An **entity entry** for an associated entity type. + GoogleCloudDialogflowCxV3beta1FulfillmentGeneratorSettings: + id: GoogleCloudDialogflowCxV3beta1FulfillmentGeneratorSettings + description: Generator settings used by the LLM to generate a text response. type: object properties: - value: + generator: description: >- - Required. The primary value associated with this entity entry. For - example, if the entity type is *vegetable*, the value could be - *scallions*. For `KIND_MAP` entity types: * A reference value to be - used in place of synonyms. For `KIND_LIST` entity types: * A string - that can contain references to other entity types (with or without - aliases). + Required. The generator to call. Format: + `projects//locations//agents//generators/`. type: string - synonyms: + inputParameters: description: >- - Required. A collection of value synonyms. For example, if the entity - type is *vegetable*, and `value` is *scallions*, a synonym could be - *green onions*. For `KIND_LIST` entity types: * This collection must - contain exactly one synonym equal to `value`. - type: array - items: + Map from placeholder parameter in the Generator to corresponding + session parameters. By default, Dialogflow uses the session + parameter with the same name to fill in the generator template. e.g. + If there is a placeholder parameter `city` in the Generator, + Dialogflow default to fill in the `$city` with + `$session.params.city`. However, you may choose to fill `$city` with + `$session.params.desination-city`. - Map key: parameter ID - Map + value: session parameter name + type: object + additionalProperties: type: string - GoogleCloudDialogflowV2BatchUpdateIntentsResponse: - id: GoogleCloudDialogflowV2BatchUpdateIntentsResponse - description: The response message for Intents.BatchUpdateIntents. + outputParameter: + description: >- + Required. Output parameter which should contain the generator + response. + type: string + GoogleCloudDialogflowCxV3beta1Form: + id: GoogleCloudDialogflowCxV3beta1Form + description: >- + A form is a data model that groups related parameters that can be + collected from the user. The process in which the agent prompts the user + and collects parameter values from the user is called form filling. A + form can be added to a page. When form filling is done, the filled + parameters will be written to the session. type: object properties: - intents: - description: The collection of updated or created intents. + parameters: + description: Parameters to collect from the user. type: array items: - $ref: '#/components/schemas/GoogleCloudDialogflowV2Intent' - GoogleCloudDialogflowV2Intent: - id: GoogleCloudDialogflowV2Intent - description: >- - An intent categorizes an end-user's intention for one conversation turn. - For each agent, you define many intents, where your combined intents can - handle a complete conversation. When an end-user writes or says - something, referred to as an end-user expression or end-user input, - Dialogflow matches the end-user input to the best intent in your agent. - Matching an intent is also known as intent classification. For more - information, see the [intent - guide](https://cloud.google.com/dialogflow/docs/intents-overview). + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1FormParameter' + GoogleCloudDialogflowCxV3beta1FormParameter: + id: GoogleCloudDialogflowCxV3beta1FormParameter + description: Represents a form parameter. type: object properties: - name: - description: >- - Optional. The unique identifier of this intent. Required for - Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Format: - `projects//agent/intents/`. - type: string displayName: - description: Required. The name of this intent. - type: string - webhookState: - description: Optional. Indicates whether webhooks are enabled for the intent. + description: >- + Required. The human-readable name of the parameter, unique within + the form. type: string - enumDescriptions: - - Webhook is disabled in the agent and in the intent. - - Webhook is enabled in the agent and in the intent. - - >- - Webhook is enabled in the agent and in the intent. Also, each slot - filling prompt is forwarded to the webhook. - enum: - - WEBHOOK_STATE_UNSPECIFIED - - WEBHOOK_STATE_ENABLED - - WEBHOOK_STATE_ENABLED_FOR_SLOT_FILLING - priority: + required: description: >- - Optional. The priority of this intent. Higher numbers represent - higher priorities. - If the supplied value is unspecified or 0, the - service translates the value to 500,000, which corresponds to the - `Normal` priority in the console. - If the supplied value is - negative, the intent is ignored in runtime detect intent requests. - type: integer - format: int32 - isFallback: - description: Optional. Indicates whether this is a fallback intent. + Indicates whether the parameter is required. Optional parameters + will not trigger prompts; however, they are filled if the user + specifies them. Required parameters must be filled before form + filling concludes. type: boolean - mlDisabled: + entityType: description: >- - Optional. Indicates whether Machine Learning is disabled for the - intent. Note: If `ml_disabled` setting is set to true, then this - intent is not taken into account during inference in `ML ONLY` match - mode. Also, auto-markup in the UI is turned off. + Required. The entity type of the parameter. Format: + `projects/-/locations/-/agents/-/entityTypes/` for system entity + types (for example, + `projects/-/locations/-/agents/-/entityTypes/sys.date`), or + `projects//locations//agents//entityTypes/` for developer entity + types. + type: string + isList: + description: Indicates whether the parameter represents a list of values. type: boolean - liveAgentHandoff: + fillBehavior: + description: Required. Defines fill behavior for the parameter. + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3beta1FormParameterFillBehavior + defaultValue: description: >- - Optional. Indicates that a live agent should be brought in to handle - the interaction with the user. In most cases, when you set this flag - to true, you would also want to set end_interaction to true as well. - Default is false. - type: boolean - endInteraction: + The default value of an optional parameter. If the parameter is + required, the default value will be ignored. + type: any + redact: description: >- - Optional. Indicates that this intent ends an interaction. Some - integrations (e.g., Actions on Google or Dialogflow phone gateway) - use this information to close interaction with an end user. Default - is false. + Indicates whether the parameter content should be redacted in log. + If redaction is enabled, the parameter content will be replaced by + parameter name during logging. Note: the parameter content is + subject to redaction if either parameter level redaction or entity + type level redaction is enabled. type: boolean - inputContextNames: + advancedSettings: description: >- - Optional. The list of context names required for this intent to be - triggered. Format: `projects//agent/sessions/-/contexts/`. - type: array - items: - type: string - events: - description: >- - Optional. The collection of event names that trigger the intent. If - the collection of input contexts is not empty, all of the contexts - must be present in the active user session for an event to trigger - this intent. Event names are limited to 150 characters. - type: array - items: - type: string - trainingPhrases: - description: Optional. The collection of examples that the agent is trained on. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDialogflowV2IntentTrainingPhrase' - action: - description: >- - Optional. The name of the action associated with the intent. Note: - The action name must not contain whitespaces. - type: string - outputContexts: - description: >- - Optional. The collection of contexts that are activated when the - intent is matched. Context messages in this collection should not - set the parameters field. Setting the `lifespan_count` to 0 will - reset the context when the intent is matched. Format: - `projects//agent/sessions/-/contexts/`. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDialogflowV2Context' - resetContexts: + Hierarchical advanced settings for this parameter. The settings + exposed at the lower level overrides the settings exposed at the + higher level. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1AdvancedSettings' + GoogleCloudDialogflowCxV3beta1FormParameterFillBehavior: + id: GoogleCloudDialogflowCxV3beta1FormParameterFillBehavior + description: Configuration for how the filling of a parameter should be handled. + type: object + properties: + initialPromptFulfillment: description: >- - Optional. Indicates whether to delete all contexts in the current - session when this intent is matched. - type: boolean - parameters: - description: Optional. The collection of parameters associated with the intent. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDialogflowV2IntentParameter' - messages: + Required. The fulfillment to provide the initial prompt that the + agent can present to the user in order to fill the parameter. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1Fulfillment' + repromptEventHandlers: description: >- - Optional. The collection of rich messages corresponding to the - `Response` field in the Dialogflow console. + The handlers for parameter-level events, used to provide reprompt + for the parameter or transition to a different page/flow. The + supported events are: * `sys.no-match-`, where N can be from 1 to 6 + * `sys.no-match-default` * `sys.no-input-`, where N can be from 1 to + 6 * `sys.no-input-default` * `sys.invalid-parameter` + `initial_prompt_fulfillment` provides the first prompt for the + parameter. If the user's response does not fill the parameter, a + no-match/no-input event will be triggered, and the fulfillment + associated with the `sys.no-match-1`/`sys.no-input-1` handler (if + defined) will be called to provide a prompt. The + `sys.no-match-2`/`sys.no-input-2` handler (if defined) will respond + to the next no-match/no-input event, and so on. A + `sys.no-match-default` or `sys.no-input-default` handler will be + used to handle all following no-match/no-input events after all + numbered no-match/no-input handlers for the parameter are consumed. + A `sys.invalid-parameter` handler can be defined to handle the case + where the parameter values have been `invalidated` by webhook. For + example, if the user's response fill the parameter, however the + parameter was invalidated by webhook, the fulfillment associated + with the `sys.invalid-parameter` handler (if defined) will be called + to provide a prompt. If the event handler for the corresponding + event can't be found on the parameter, `initial_prompt_fulfillment` + will be re-prompted. type: array items: - $ref: '#/components/schemas/GoogleCloudDialogflowV2IntentMessage' - defaultResponsePlatforms: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1EventHandler' + GoogleCloudDialogflowCxV3beta1EventHandler: + id: GoogleCloudDialogflowCxV3beta1EventHandler + description: >- + An event handler specifies an event that can be handled during a + session. When the specified event happens, the following actions are + taken in order: * If there is a `trigger_fulfillment` associated with + the event, it will be called. * If there is a `target_page` associated + with the event, the session will transition into the specified page. * + If there is a `target_flow` associated with the event, the session will + transition into the specified flow. + type: object + properties: + name: + description: Output only. The unique identifier of this event handler. + readOnly: true + type: string + event: + description: Required. The name of the event to handle. + type: string + triggerFulfillment: description: >- - Optional. The list of platforms for which the first responses will - be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default - platform). - type: array - items: - type: string - enumDescriptions: - - Default platform. - - Facebook. - - Slack. - - Telegram. - - Kik. - - Skype. - - Line. - - Viber. - - >- - Google Assistant See [Dialogflow webhook - format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json) - - Google Hangouts. - enum: - - PLATFORM_UNSPECIFIED - - FACEBOOK - - SLACK - - TELEGRAM - - KIK - - SKYPE - - LINE - - VIBER - - ACTIONS_ON_GOOGLE - - GOOGLE_HANGOUTS - rootFollowupIntentName: + The fulfillment to call when the event occurs. Handling webhook + errors with a fulfillment enabled with webhook could cause infinite + loop. It is invalid to specify such fulfillment for a handler + handling webhooks. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1Fulfillment' + targetPage: description: >- - Output only. Read-only. The unique identifier of the root intent in - the chain of followup intents. It identifies the correct followup - intents chain for this intent. We populate this field only in the - output. Format: `projects//agent/intents/`. - readOnly: true + The target page to transition to. Format: + `projects//locations//agents//flows//pages/`. type: string - parentFollowupIntentName: + targetFlow: description: >- - Read-only after creation. The unique identifier of the parent intent - in the chain of followup intents. You can set this field when - creating an intent, for example with CreateIntent or - BatchUpdateIntents, in order to make this intent a followup intent. - It identifies the parent followup intent. Format: - `projects//agent/intents/`. + The target flow to transition to. Format: + `projects//locations//agents//flows/`. type: string - followupIntentInfo: + targetPlaybook: description: >- - Output only. Read-only. Information about all followup intents that - have this intent as a direct or indirect parent. We populate this - field only in the output. - readOnly: true - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2IntentFollowupIntentInfo - GoogleCloudDialogflowV2IntentTrainingPhrase: - id: GoogleCloudDialogflowV2IntentTrainingPhrase - description: Represents an example that the agent is trained on. + The target playbook to transition to. Format: + `projects//locations//agents//playbooks/`. + type: string + GoogleCloudDialogflowCxV3beta1TransitionRoute: + id: GoogleCloudDialogflowCxV3beta1TransitionRoute + description: >- + A transition route specifies a intent that can be matched and/or a data + condition that can be evaluated during a session. When a specified + transition is matched, the following actions are taken in order: * If + there is a `trigger_fulfillment` associated with the transition, it will + be called. * If there is a `target_page` associated with the transition, + the session will transition into the specified page. * If there is a + `target_flow` associated with the transition, the session will + transition into the specified flow. type: object properties: name: - description: Output only. The unique identifier of this training phrase. - type: string - type: - description: Required. The type of the training phrase. + description: Output only. The unique identifier of this transition route. + readOnly: true type: string - enumDescriptions: - - Not specified. This value should never be used. - - >- - Examples do not contain @-prefixed entity type names, but example - parts can be annotated with entity types. - - >- - Templates are not annotated with entity types, but they can - contain @-prefixed entity type names as substrings. Template mode - has been deprecated. Example mode is the only supported way to - create new training phrases. If you have existing training phrases - that you've created in template mode, those will continue to work. - enumDeprecated: - - false - - false - - true - enum: - - TYPE_UNSPECIFIED - - EXAMPLE - - TEMPLATE - parts: - description: >- - Required. The ordered list of training phrase parts. The parts are - concatenated in order to form the training phrase. Note: The API - does not automatically annotate training phrases like the Dialogflow - Console does. Note: Do not forget to include whitespace at part - boundaries, so the training phrase is well formatted when the parts - are concatenated. If the training phrase does not need to be - annotated with parameters, you just need a single part with only the - Part.text field set. If you want to annotate the training phrase, - you must create multiple parts, where the fields of each part are - populated in one of two ways: - `Part.text` is set to a part of the - phrase that has no parameters. - `Part.text` is set to a part of the - phrase that you want to annotate, and the `entity_type`, `alias`, - and `user_defined` fields are all set. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2IntentTrainingPhrasePart - timesAddedCount: + description: description: >- - Optional. Indicates how many times this example was added to the - intent. Each time a developer adds an existing sample by editing an - intent or training, this counter is increased. - type: integer - format: int32 - GoogleCloudDialogflowV2IntentTrainingPhrasePart: - id: GoogleCloudDialogflowV2IntentTrainingPhrasePart - description: Represents a part of a training phrase. - type: object - properties: - text: - description: Required. The text for this part. + Optional. The description of the transition route. The maximum + length is 500 characters. type: string - entityType: + intent: description: >- - Optional. The entity type name prefixed with `@`. This field is - required for annotated parts of the training phrase. + The unique identifier of an Intent. Format: + `projects//locations//agents//intents/`. Indicates that the + transition can only happen when the given intent is matched. At + least one of `intent` or `condition` must be specified. When both + `intent` and `condition` are specified, the transition can only + happen when both are fulfilled. type: string - alias: + condition: description: >- - Optional. The parameter name for the value extracted from the - annotated part of the example. This field is required for annotated - parts of the training phrase. + The condition to evaluate against form parameters or session + parameters. See the [conditions + reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). + At least one of `intent` or `condition` must be specified. When both + `intent` and `condition` are specified, the transition can only + happen when both are fulfilled. type: string - userDefined: + triggerFulfillment: description: >- - Optional. Indicates whether the text was manually annotated. This - field is set to true when the Dialogflow Console is used to manually - annotate the part. When creating an annotated part with the API, you - must set this to true. - type: boolean - GoogleCloudDialogflowV2Context: - id: GoogleCloudDialogflowV2Context + The fulfillment to call when the condition is satisfied. At least + one of `trigger_fulfillment` and `target` must be specified. When + both are defined, `trigger_fulfillment` is executed first. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1Fulfillment' + targetPage: + description: >- + The target page to transition to. Format: + `projects//locations//agents//flows//pages/`. + type: string + targetFlow: + description: >- + The target flow to transition to. Format: + `projects//locations//agents//flows/`. + type: string + GoogleCloudDialogflowCxV3beta1KnowledgeConnectorSettings: + id: GoogleCloudDialogflowCxV3beta1KnowledgeConnectorSettings description: >- - Dialogflow contexts are similar to natural language context. If a person - says to you "they are orange", you need context in order to understand - what "they" is referring to. Similarly, for Dialogflow to handle an - end-user expression like that, it needs to be provided with context in - order to correctly match an intent. Using contexts, you can control the - flow of a conversation. You can configure contexts for an intent by - setting input and output contexts, which are identified by string names. - When an intent is matched, any configured output contexts for that - intent become active. While any contexts are active, Dialogflow is more - likely to match intents that are configured with input contexts that - correspond to the currently active contexts. For more information about - context, see the [Contexts - guide](https://cloud.google.com/dialogflow/docs/contexts-overview). + The Knowledge Connector settings for this page or flow. This includes + information such as the attached Knowledge Bases, and the way to execute + fulfillment. type: object properties: - name: + enabled: + description: Whether Knowledge Connector is enabled or not. + type: boolean + triggerFulfillment: description: >- - Required. The unique identifier of the context. Format: - `projects//agent/sessions//contexts/`, or - `projects//agent/environments//users//sessions//contexts/`. The - `Context ID` is always converted to lowercase, may only contain - characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long. If - `Environment ID` is not specified, we assume default 'draft' - environment. If `User ID` is not specified, we assume default '-' - user. The following context names are reserved for internal use by - Dialogflow. You should not use these contexts or create contexts - with these names: * `__system_counters__` * `*_id_dialog_context` * - `*_dialog_params_size` - type: string - lifespanCount: + The fulfillment to be triggered. When the answers from the Knowledge + Connector are selected by Dialogflow, you can utitlize the request + scoped parameter `$request.knowledge.answers` (contains up to the 5 + highest confidence answers) and `$request.knowledge.questions` + (contains the corresponding questions) to construct the fulfillment. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1Fulfillment' + targetPage: description: >- - Optional. The number of conversational query requests after which - the context expires. The default is `0`. If set to `0`, the context - expires immediately. Contexts expire automatically after 20 minutes - if there are no matching queries. - type: integer - format: int32 - parameters: + The target page to transition to. Format: + `projects//locations//agents//flows//pages/`. + type: string + targetFlow: description: >- - Optional. The collection of parameters associated with this context. - Depending on your protocol or client library language, this is a - map, associative array, symbol table, dictionary, or JSON object - composed of a collection of (MapKey, MapValue) pairs: * MapKey type: - string * MapKey value: parameter name * MapValue type: If - parameter's entity type is a composite entity then use map, - otherwise, depending on the parameter value type, it could be one of - string, number, boolean, null, list or map. * MapValue value: If - parameter's entity type is a composite entity then use map from - composite entity property names to property values, otherwise, use - parameter value. - type: object - additionalProperties: - type: any - description: Properties of the object. - GoogleCloudDialogflowV2IntentParameter: - id: GoogleCloudDialogflowV2IntentParameter - description: Represents intent parameters. + The target flow to transition to. Format: + `projects//locations//agents//flows/`. + type: string + dataStoreConnections: + description: Optional. List of related data store connections. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3beta1DataStoreConnection + GoogleCloudDialogflowCxV3beta1DataStoreConnection: + id: GoogleCloudDialogflowCxV3beta1DataStoreConnection + description: >- + A data store connection. It represents a data store in Discovery Engine + and the type of the contents it contains. type: object properties: - name: - description: The unique identifier of this parameter. - type: string - displayName: - description: Required. The name of the parameter. + dataStoreType: + description: The type of the connected data store. type: string - value: + enumDescriptions: + - >- + Not specified. This value indicates that the data store type is + not specified, so it will not be used during search. + - A data store that contains public web content. + - A data store that contains unstructured private data. + - A data store that contains structured data (for example FAQ). + enum: + - DATA_STORE_TYPE_UNSPECIFIED + - PUBLIC_WEB + - UNSTRUCTURED + - STRUCTURED + dataStore: description: >- - Optional. The definition of the parameter value. It can be: - a - constant string, - a parameter value defined as `$parameter_name`, - - an original parameter value defined as `$parameter_name.original`, - - a parameter value from some context defined as - `#context_name.parameter_name`. + The full name of the referenced data store. Formats: + `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` + `projects/{project}/locations/{location}/dataStores/{data_store}` type: string - defaultValue: + documentProcessingMode: description: >- - Optional. The default value to use when the `value` yields an empty - result. Default values can be extracted from contexts by using the - following syntax: `#context_name.parameter_name`. + The document processing mode for the data store connection. Should + only be set for PUBLIC_WEB and UNSTRUCTURED data stores. If not set + it is considered as DOCUMENTS, as this is the legacy mode. type: string - entityTypeDisplayName: + enumDescriptions: + - >- + Not specified. This should be set for STRUCTURED type data stores. + Due to legacy reasons this is considered as DOCUMENTS for + STRUCTURED and PUBLIC_WEB data stores. + - Documents are processed as documents. + - Documents are converted to chunks. + enum: + - DOCUMENT_PROCESSING_MODE_UNSPECIFIED + - DOCUMENTS + - CHUNKS + GoogleCloudDialogflowCxV3beta1RunTestCaseMetadata: + id: GoogleCloudDialogflowCxV3beta1RunTestCaseMetadata + description: >- + Metadata returned for the TestCases.RunTestCase long running operation. + This message currently has no fields. + type: object + properties: {} + GoogleCloudDialogflowCxV3beta1RunTestCaseResponse: + id: GoogleCloudDialogflowCxV3beta1RunTestCaseResponse + description: The response message for TestCases.RunTestCase. + type: object + properties: + result: + description: The result. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1TestCaseResult' + GoogleCloudDialogflowCxV3beta1ExportTestCasesMetadata: + id: GoogleCloudDialogflowCxV3beta1ExportTestCasesMetadata + description: >- + Metadata returned for the TestCases.ExportTestCases long running + operation. This message currently has no fields. + type: object + properties: {} + GoogleCloudDialogflowCxV3beta1ExportTestCasesResponse: + id: GoogleCloudDialogflowCxV3beta1ExportTestCasesResponse + description: The response message for TestCases.ExportTestCases. + type: object + properties: + gcsUri: description: >- - Optional. The name of the entity type, prefixed with `@`, that - describes values of the parameter. If the parameter is required, - this must be provided. + The URI to a file containing the exported test cases. This field is + populated only if `gcs_uri` is specified in ExportTestCasesRequest. type: string - mandatory: + content: + description: Uncompressed raw byte content for test cases. + type: string + format: byte + GoogleCloudDialogflowCxV3beta1ImportTestCasesMetadata: + id: GoogleCloudDialogflowCxV3beta1ImportTestCasesMetadata + description: >- + Metadata returned for the TestCases.ImportTestCases long running + operation. + type: object + properties: + errors: + description: Errors for failed test cases. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1TestCaseError' + GoogleCloudDialogflowCxV3beta1TestCaseError: + id: GoogleCloudDialogflowCxV3beta1TestCaseError + description: Error info for importing a test. + type: object + properties: + testCase: + description: The test case. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1TestCase' + status: + description: The status associated with the test case. + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudDialogflowCxV3beta1TestCase: + id: GoogleCloudDialogflowCxV3beta1TestCase + description: Represents a test case. + type: object + properties: + name: description: >- - Optional. Indicates whether the parameter is required. That is, - whether the intent cannot be completed without collecting the - parameter value. - type: boolean - prompts: + The unique identifier of the test case. TestCases.CreateTestCase + will populate the name automatically. Otherwise use format: + `projects//locations//agents//testCases/`. + type: string + tags: description: >- - Optional. The collection of prompts that the agent can present to - the user in order to collect a value for the parameter. + Tags are short descriptions that users may apply to test cases for + organizational and filtering purposes. Each tag should start with + "#" and has a limit of 30 characters. type: array items: type: string - isList: + displayName: description: >- - Optional. Indicates whether the parameter represents a list of - values. - type: boolean - GoogleCloudDialogflowV2IntentMessage: - id: GoogleCloudDialogflowV2IntentMessage - description: >- - A rich response message. Corresponds to the intent `Response` field in - the Dialogflow console. For more information, see [Rich response - messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages). - type: object - properties: - text: - description: The text response. - $ref: '#/components/schemas/GoogleCloudDialogflowV2IntentMessageText' - image: - description: The image response. - $ref: '#/components/schemas/GoogleCloudDialogflowV2IntentMessageImage' - quickReplies: - description: The quick replies response. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2IntentMessageQuickReplies - card: - description: The card response. - $ref: '#/components/schemas/GoogleCloudDialogflowV2IntentMessageCard' - payload: - description: A custom platform-specific response. - type: object - additionalProperties: - type: any - description: Properties of the object. - simpleResponses: - description: The voice and text-only responses for Actions on Google. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2IntentMessageSimpleResponses - basicCard: - description: The basic card response for Actions on Google. - $ref: '#/components/schemas/GoogleCloudDialogflowV2IntentMessageBasicCard' - suggestions: - description: The suggestion chips for Actions on Google. - $ref: '#/components/schemas/GoogleCloudDialogflowV2IntentMessageSuggestions' - linkOutSuggestion: - description: The link out suggestion chip for Actions on Google. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2IntentMessageLinkOutSuggestion - listSelect: - description: The list card response for Actions on Google. - $ref: '#/components/schemas/GoogleCloudDialogflowV2IntentMessageListSelect' - carouselSelect: - description: The carousel card response for Actions on Google. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2IntentMessageCarouselSelect - browseCarouselCard: - description: Browse carousel card for Actions on Google. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2IntentMessageBrowseCarouselCard - tableCard: - description: Table card for Actions on Google. - $ref: '#/components/schemas/GoogleCloudDialogflowV2IntentMessageTableCard' - mediaContent: - description: The media content card for Actions on Google. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2IntentMessageMediaContent - platform: - description: Optional. The platform that this message is intended for. + Required. The human-readable name of the test case, unique within + the agent. Limit of 200 characters. type: string - enumDescriptions: - - Default platform. - - Facebook. - - Slack. - - Telegram. - - Kik. - - Skype. - - Line. - - Viber. - - >- - Google Assistant See [Dialogflow webhook - format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json) - - Google Hangouts. - enum: - - PLATFORM_UNSPECIFIED - - FACEBOOK - - SLACK - - TELEGRAM - - KIK - - SKYPE - - LINE - - VIBER - - ACTIONS_ON_GOOGLE - - GOOGLE_HANGOUTS - GoogleCloudDialogflowV2IntentMessageText: - id: GoogleCloudDialogflowV2IntentMessageText - description: The text response message. + notes: + description: >- + Additional freeform notes about the test case. Limit of 400 + characters. + type: string + testConfig: + description: Config for the test case. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1TestConfig' + testCaseConversationTurns: + description: >- + The conversation turns uttered when the test case was created, in + chronological order. These include the canonical set of agent + utterances that should occur when the agent is working properly. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3beta1ConversationTurn + creationTime: + description: Output only. When the test was created. + readOnly: true + type: string + format: google-datetime + lastTestResult: + description: The latest test result. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1TestCaseResult' + GoogleCloudDialogflowCxV3beta1TestConfig: + id: GoogleCloudDialogflowCxV3beta1TestConfig + description: Represents configurations for a test case. type: object properties: - text: - description: Optional. The collection of the agent's responses. + trackingParameters: + description: Session parameters to be compared when calculating differences. type: array items: type: string - GoogleCloudDialogflowV2IntentMessageImage: - id: GoogleCloudDialogflowV2IntentMessageImage - description: The image response message. - type: object - properties: - imageUri: - description: Optional. The public URI to an image file. + flow: + description: >- + Flow name to start the test case with. Format: + `projects//locations//agents//flows/`. Only one of `flow` and `page` + should be set to indicate the starting point of the test case. If + neither is set, the test case will start with start page on the + default start flow. type: string - accessibilityText: + page: description: >- - Optional. A text description of the image to be used for - accessibility, e.g., screen readers. + The page to start the test case with. Format: + `projects//locations//agents//flows//pages/`. Only one of `flow` and + `page` should be set to indicate the starting point of the test + case. If neither is set, the test case will start with start page on + the default start flow. type: string - GoogleCloudDialogflowV2IntentMessageQuickReplies: - id: GoogleCloudDialogflowV2IntentMessageQuickReplies - description: The quick replies response message. + GoogleCloudDialogflowCxV3beta1ImportTestCasesResponse: + id: GoogleCloudDialogflowCxV3beta1ImportTestCasesResponse + description: The response message for TestCases.ImportTestCases. type: object properties: - title: - description: Optional. The title of the collection of quick replies. - type: string - quickReplies: - description: Optional. The collection of quick replies. + names: + description: >- + The unique identifiers of the new test cases. Format: + `projects//locations//agents//testCases/`. type: array items: type: string - GoogleCloudDialogflowV2IntentMessageCard: - id: GoogleCloudDialogflowV2IntentMessageCard - description: The card response message. + GoogleCloudDialogflowCxV3beta1RunContinuousTestMetadata: + id: GoogleCloudDialogflowCxV3beta1RunContinuousTestMetadata + description: >- + Metadata returned for the Environments.RunContinuousTest long running + operation. type: object properties: - title: - description: Optional. The title of the card. - type: string - subtitle: - description: Optional. The subtitle of the card. - type: string - imageUri: - description: Optional. The public URI to an image file for the card. - type: string - buttons: - description: Optional. The collection of card buttons. + errors: + description: The test errors. type: array items: - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2IntentMessageCardButton - GoogleCloudDialogflowV2IntentMessageCardButton: - id: GoogleCloudDialogflowV2IntentMessageCardButton - description: Contains information about a button. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1TestError' + GoogleCloudDialogflowCxV3beta1RunContinuousTestResponse: + id: GoogleCloudDialogflowCxV3beta1RunContinuousTestResponse + description: The response message for Environments.RunContinuousTest. type: object properties: - text: - description: Optional. The text to show on the button. + continuousTestResult: + description: The result for a continuous test run. + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3beta1ContinuousTestResult + GoogleCloudDialogflowCxV3beta1ContinuousTestResult: + id: GoogleCloudDialogflowCxV3beta1ContinuousTestResult + description: Represents a result from running a test case in an agent environment. + type: object + properties: + name: + description: >- + The resource name for the continuous test result. Format: + `projects//locations//agents//environments//continuousTestResults/`. type: string - postback: + result: description: >- - Optional. The text to send back to the Dialogflow API or a URI to - open. + The result of this continuous test run, i.e. whether all the tests + in this continuous test run pass or not. type: string - GoogleCloudDialogflowV2IntentMessageSimpleResponses: - id: GoogleCloudDialogflowV2IntentMessageSimpleResponses + enumDescriptions: + - Not specified. Should never be used. + - All the tests passed. + - At least one test did not pass. + enum: + - AGGREGATED_TEST_RESULT_UNSPECIFIED + - PASSED + - FAILED + testCaseResults: + description: >- + A list of individual test case results names in this continuous test + run. + type: array + items: + type: string + runTime: + description: Time when the continuous testing run starts. + type: string + format: google-datetime + GoogleCloudDialogflowCxV3beta1DeployFlowMetadata: + id: GoogleCloudDialogflowCxV3beta1DeployFlowMetadata description: >- - The collection of simple response candidates. This message in - `QueryResult.fulfillment_messages` and - `WebhookResponse.fulfillment_messages` should contain only one - `SimpleResponse`. + Metadata returned for the Environments.DeployFlow long running + operation. type: object properties: - simpleResponses: - description: Required. The list of simple responses. + testErrors: + description: Errors of running deployment tests. type: array items: - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2IntentMessageSimpleResponse - GoogleCloudDialogflowV2IntentMessageSimpleResponse: - id: GoogleCloudDialogflowV2IntentMessageSimpleResponse - description: The simple response message containing speech or text. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1TestError' + GoogleCloudDialogflowCxV3beta1DeployFlowResponse: + id: GoogleCloudDialogflowCxV3beta1DeployFlowResponse + description: The response message for Environments.DeployFlow. type: object properties: - textToSpeech: - description: >- - One of text_to_speech or ssml must be provided. The plain text of - the speech output. Mutually exclusive with ssml. - type: string - ssml: + environment: + description: The updated environment where the flow is deployed. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1Environment' + deployment: description: >- - One of text_to_speech or ssml must be provided. Structured spoken - response to the user in the SSML format. Mutually exclusive with - text_to_speech. - type: string - displayText: - description: Optional. The text to display. + The name of the flow version deployment. Format: + `projects//locations//agents//environments//deployments/`. type: string - GoogleCloudDialogflowV2IntentMessageBasicCard: - id: GoogleCloudDialogflowV2IntentMessageBasicCard - description: The basic card message. Useful for displaying information. + GoogleCloudDialogflowCxV3beta1Environment: + id: GoogleCloudDialogflowCxV3beta1Environment + description: >- + Represents an environment for an agent. You can create multiple versions + of your agent and publish them to separate environments. When you edit + an agent, you are editing the draft agent. At any point, you can save + the draft agent as an agent version, which is an immutable snapshot of + your agent. When you save the draft agent, it is published to the + default environment. When you create agent versions, you can publish + them to custom environments. You can create a variety of custom + environments for testing, development, production, etc. type: object properties: - title: - description: Optional. The title of the card. + name: + description: >- + The name of the environment. Format: + `projects//locations//agents//environments/`. type: string - subtitle: - description: Optional. The subtitle of the card. + displayName: + description: >- + Required. The human-readable name of the environment (unique in an + agent). Limit of 64 characters. type: string - formattedText: - description: Required, unless image is present. The body text of the card. + description: + description: >- + The human-readable description of the environment. The maximum + length is 500 characters. If exceeded, the request is rejected. type: string - image: - description: Optional. The image for the card. - $ref: '#/components/schemas/GoogleCloudDialogflowV2IntentMessageImage' - buttons: - description: Optional. The collection of card buttons. + versionConfigs: + description: >- + A list of configurations for flow versions. You should include + version configs for all flows that are reachable from `Start Flow` + in the agent. Otherwise, an error will be returned. type: array items: $ref: >- - #/components/schemas/GoogleCloudDialogflowV2IntentMessageBasicCardButton - GoogleCloudDialogflowV2IntentMessageBasicCardButton: - id: GoogleCloudDialogflowV2IntentMessageBasicCardButton - description: The button object that appears at the bottom of a card. - type: object - properties: - title: - description: Required. The title of the button. + #/components/schemas/GoogleCloudDialogflowCxV3beta1EnvironmentVersionConfig + updateTime: + description: Output only. Update time of this environment. + readOnly: true type: string - openUriAction: - description: Required. Action to take when a user taps on the button. + format: google-datetime + testCasesConfig: + description: The test cases config for continuous tests of this environment. $ref: >- - #/components/schemas/GoogleCloudDialogflowV2IntentMessageBasicCardButtonOpenUriAction - GoogleCloudDialogflowV2IntentMessageBasicCardButtonOpenUriAction: - id: GoogleCloudDialogflowV2IntentMessageBasicCardButtonOpenUriAction - description: Opens the given URI. + #/components/schemas/GoogleCloudDialogflowCxV3beta1EnvironmentTestCasesConfig + webhookConfig: + description: The webhook configuration for this environment. + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3beta1EnvironmentWebhookConfig + GoogleCloudDialogflowCxV3beta1EnvironmentVersionConfig: + id: GoogleCloudDialogflowCxV3beta1EnvironmentVersionConfig + description: Configuration for the version. type: object properties: - uri: - description: Required. The HTTP or HTTPS scheme URI. + version: + description: >- + Required. Flow, playbook and tool versions are supported. Format for + flow version: projects//locations//agents//flows//versions/. Format + for playbook version: + projects//locations//agents//playbooks//versions/. Format for tool + version: projects//locations//agents//tools//versions/. type: string - GoogleCloudDialogflowV2IntentMessageSuggestions: - id: GoogleCloudDialogflowV2IntentMessageSuggestions - description: The collection of suggestions. + GoogleCloudDialogflowCxV3beta1EnvironmentTestCasesConfig: + id: GoogleCloudDialogflowCxV3beta1EnvironmentTestCasesConfig + description: The configuration for continuous tests. type: object properties: - suggestions: - description: Required. The list of suggested replies. + testCases: + description: >- + A list of test case names to run. They should be under the same + agent. Format of each test case name: + `projects//locations//agents//testCases/` type: array items: - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2IntentMessageSuggestion - GoogleCloudDialogflowV2IntentMessageSuggestion: - id: GoogleCloudDialogflowV2IntentMessageSuggestion - description: >- - The suggestion chip message that the user can tap to quickly post a - reply to the conversation. + type: string + enableContinuousRun: + description: >- + Whether to run test cases in TestCasesConfig.test_cases + periodically. Default false. If set to true, run once a day. + type: boolean + enablePredeploymentRun: + description: >- + Whether to run test cases in TestCasesConfig.test_cases before + deploying a flow version to the environment. Default false. + type: boolean + GoogleCloudDialogflowCxV3beta1EnvironmentWebhookConfig: + id: GoogleCloudDialogflowCxV3beta1EnvironmentWebhookConfig + description: Configuration for webhooks. type: object properties: - title: - description: Required. The text shown the in the suggestion chip. - type: string - GoogleCloudDialogflowV2IntentMessageLinkOutSuggestion: - id: GoogleCloudDialogflowV2IntentMessageLinkOutSuggestion + webhookOverrides: + description: >- + The list of webhooks to override for the agent environment. The + webhook must exist in the agent. You can override fields in + `generic_web_service` and `service_directory`. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1Webhook' + GoogleCloudDialogflowCxV3beta1Webhook: + id: GoogleCloudDialogflowCxV3beta1Webhook description: >- - The suggestion chip message that allows the user to jump out to the app - or website associated with this agent. + Webhooks host the developer's business logic. During a session, webhooks + allow the developer to use the data extracted by Dialogflow's natural + language processing to generate dynamic responses, validate collected + data, or trigger actions on the backend. type: object properties: - destinationName: - description: Required. The name of the app or site this chip is linking to. - type: string - uri: + name: description: >- - Required. The URI of the app or site to open when the user taps the - suggestion chip. + The unique identifier of the webhook. Required for the + Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the + name automatically. Format: + `projects//locations//agents//webhooks/`. type: string - GoogleCloudDialogflowV2IntentMessageListSelect: - id: GoogleCloudDialogflowV2IntentMessageListSelect - description: The card for presenting a list of options to select from. - type: object - properties: - title: - description: Optional. The overall title of the list. + displayName: + description: >- + Required. The human-readable name of the webhook, unique within the + agent. type: string - items: - description: Required. List items. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2IntentMessageListSelectItem - subtitle: - description: Optional. Subtitle of the list. + genericWebService: + description: Configuration for a generic web service. + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3beta1WebhookGenericWebService + serviceDirectory: + description: >- + Configuration for a [Service + Directory](https://cloud.google.com/service-directory) service. + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3beta1WebhookServiceDirectoryConfig + timeout: + description: >- + Webhook execution timeout. Execution is considered failed if + Dialogflow doesn't receive a response from webhook at the end of the + timeout period. Defaults to 5 seconds, maximum allowed timeout is 30 + seconds. type: string - GoogleCloudDialogflowV2IntentMessageListSelectItem: - id: GoogleCloudDialogflowV2IntentMessageListSelectItem - description: An item in the list. + format: google-duration + disabled: + description: Indicates whether the webhook is disabled. + type: boolean + GoogleCloudDialogflowCxV3beta1WebhookGenericWebService: + id: GoogleCloudDialogflowCxV3beta1WebhookGenericWebService + description: Represents configuration for a generic web service. type: object properties: - info: - description: Required. Additional information about this option. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2IntentMessageSelectItemInfo - title: - description: Required. The title of the list item. + uri: + description: >- + Required. The webhook URI for receiving POST requests. It must use + https protocol. type: string - description: - description: Optional. The main text describing the item. + username: + description: The user name for HTTP Basic authentication. + deprecated: true type: string - image: - description: Optional. The image to display. - $ref: '#/components/schemas/GoogleCloudDialogflowV2IntentMessageImage' - GoogleCloudDialogflowV2IntentMessageSelectItemInfo: - id: GoogleCloudDialogflowV2IntentMessageSelectItemInfo - description: >- - Additional info about the select item for when it is triggered in a - dialog. - type: object - properties: - key: + password: + description: The password for HTTP Basic authentication. + deprecated: true + type: string + secretVersionForUsernamePassword: description: >- - Required. A unique key that will be sent back to the agent if this - response is given. + Optional. The SecretManager secret version resource storing the + username:password pair for HTTP Basic authentication. Format: + `projects/{project}/secrets/{secret}/versions/{version}` type: string - synonyms: + requestHeaders: + description: The HTTP request headers to send together with webhook requests. + type: object + additionalProperties: + type: string + secretVersionsForRequestHeaders: description: >- - Optional. A list of synonyms that can also be used to trigger this - item in dialog. + Optional. The HTTP request headers to send together with webhook + requests. Header values are stored in SecretManager secret versions. + When the same header name is specified in both `request_headers` and + `secret_versions_for_request_headers`, the value in + `secret_versions_for_request_headers` will be used. + type: object + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceSecretVersionHeaderValue + allowedCaCerts: + description: >- + Optional. Specifies a list of allowed custom CA certificates (in DER + format) for HTTPS verification. This overrides the default SSL trust + store. If this is empty or unspecified, Dialogflow will use Google's + default trust store to verify certificates. N.B. Make sure the HTTPS + server certificates are signed with "subject alt name". For instance + a certificate can be self-signed using the following command, ``` + openssl x509 -req -days 200 -in example.com.csr \ -signkey + example.com.key \ -out example.com.crt \ -extfile <(printf + "\nsubjectAltName='DNS:www.example.com'") ``` type: array items: type: string - GoogleCloudDialogflowV2IntentMessageCarouselSelect: - id: GoogleCloudDialogflowV2IntentMessageCarouselSelect - description: The card for presenting a carousel of options to select from. - type: object - properties: - items: - description: Required. Carousel items. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2IntentMessageCarouselSelectItem - GoogleCloudDialogflowV2IntentMessageCarouselSelectItem: - id: GoogleCloudDialogflowV2IntentMessageCarouselSelectItem - description: An item in the carousel. - type: object - properties: - info: - description: Required. Additional info about the option item. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2IntentMessageSelectItemInfo - title: - description: Required. Title of the carousel item. - type: string - description: - description: Optional. The body text of the card. - type: string - image: - description: Optional. The image to display. - $ref: '#/components/schemas/GoogleCloudDialogflowV2IntentMessageImage' - GoogleCloudDialogflowV2IntentMessageBrowseCarouselCard: - id: GoogleCloudDialogflowV2IntentMessageBrowseCarouselCard - description: >- - Browse Carousel Card for Actions on Google. - https://developers.google.com/actions/assistant/responses#browsing_carousel - type: object - properties: - items: + format: byte + oauthConfig: description: >- - Required. List of items in the Browse Carousel Card. Minimum of two - items, maximum of ten. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItem - imageDisplayOptions: + Optional. The OAuth configuration of the webhook. If specified, + Dialogflow will initiate the OAuth client credential flow to + exchange an access token from the 3rd party platform and put it in + the auth header. + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig + serviceAgentAuth: description: >- - Optional. Settings for displaying the image. Applies to every image - in items. + Optional. Indicate the auth token type generated from the + [Diglogflow service + agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). + The generated token is sent in the Authorization header. type: string enumDescriptions: + - Service agent auth type unspecified. Default to ID_TOKEN. + - No token used. - >- - Fill the gaps between the image and the image container with gray - bars. - - >- - Fill the gaps between the image and the image container with gray - bars. - - >- - Fill the gaps between the image and the image container with white - bars. - - >- - Image is scaled such that the image width and height match or - exceed the container dimensions. This may crop the top and bottom - of the image if the scaled image height is greater than the - container height, or crop the left and right of the image if the - scaled image width is greater than the container width. This is - similar to "Zoom Mode" on a widescreen TV when playing a 4:3 - video. + Use [ID + token](https://cloud.google.com/docs/authentication/token-types#id) + generated from service agent. This can be used to access Cloud + Function and Cloud Run after you grant Invoker role to + `service-@gcp-sa-dialogflow.iam.gserviceaccount.com`. - >- - Pad the gaps between image and image frame with a blurred copy of - the same image. + Use [access + token](https://cloud.google.com/docs/authentication/token-types#access) + generated from service agent. This can be used to access other + Google Cloud APIs after you grant required roles to + `service-@gcp-sa-dialogflow.iam.gserviceaccount.com`. enum: - - IMAGE_DISPLAY_OPTIONS_UNSPECIFIED - - GRAY - - WHITE - - CROPPED - - BLURRED_BACKGROUND - GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItem: - id: >- - GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItem - description: Browsing carousel tile - type: object - properties: - openUriAction: - description: Required. Action to present to the user. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction - title: - description: Required. Title of the carousel item. Maximum of two lines of text. + - SERVICE_AGENT_AUTH_UNSPECIFIED + - NONE + - ID_TOKEN + - ACCESS_TOKEN + webhookType: + description: Optional. Type of the webhook. type: string - description: + enumDescriptions: + - Default value. This value is unused. + - Represents a standard webhook. + - Represents a flexible webhook. + enum: + - WEBHOOK_TYPE_UNSPECIFIED + - STANDARD + - FLEXIBLE + httpMethod: description: >- - Optional. Description of the carousel item. Maximum of four lines of - text. + Optional. HTTP method for the flexible webhook calls. Standard + webhook always uses POST. type: string - image: - description: Optional. Hero image for the carousel item. - $ref: '#/components/schemas/GoogleCloudDialogflowV2IntentMessageImage' - footer: + enumDescriptions: + - HTTP method not specified. + - HTTP POST Method. + - HTTP GET Method. + - HTTP HEAD Method. + - HTTP PUT Method. + - HTTP DELETE Method. + - HTTP PATCH Method. + - HTTP OPTIONS Method. + enum: + - HTTP_METHOD_UNSPECIFIED + - POST + - GET + - HEAD + - PUT + - DELETE + - PATCH + - OPTIONS + requestBody: description: >- - Optional. Text that appears at the bottom of the Browse Carousel - Card. Maximum of one line of text. + Optional. Defines a custom JSON object as request body to send to + flexible webhook. type: string - GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction: + parameterMapping: + description: >- + Optional. Maps the values extracted from specific fields of the + flexible webhook response into session parameters. - Key: session + parameter name - Value: field path in the webhook response + type: object + additionalProperties: + type: string + GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceSecretVersionHeaderValue: id: >- - GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction - description: Actions on Google action to open a given url. + GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceSecretVersionHeaderValue + description: >- + Represents the value of an HTTP header stored in a SecretManager secret + version. type: object properties: - url: - description: Required. URL - type: string - urlTypeHint: + secretVersion: description: >- - Optional. Specifies the type of viewer that is used when opening the - URL. Defaults to opening via web browser. + Required. The SecretManager secret version resource storing the + header value. Format: + `projects/{project}/secrets/{secret}/versions/{version}` type: string - enumDescriptions: - - Unspecified - - Url would be an amp action - - >- - URL that points directly to AMP content, or to a canonical URL - which refers to AMP content via . - enum: - - URL_TYPE_HINT_UNSPECIFIED - - AMP_ACTION - - AMP_CONTENT - GoogleCloudDialogflowV2IntentMessageTableCard: - id: GoogleCloudDialogflowV2IntentMessageTableCard - description: Table card for Actions on Google. + GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig: + id: GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig + description: >- + Represents configuration of OAuth client credential flow for 3rd party + API authentication. type: object properties: - title: - description: Required. Title of the card. + clientId: + description: Required. The client ID provided by the 3rd party platform. type: string - subtitle: - description: Optional. Subtitle to the title. + clientSecret: + description: Optional. The client secret provided by the 3rd party platform. type: string - image: - description: Optional. Image which should be displayed on the card. - $ref: '#/components/schemas/GoogleCloudDialogflowV2IntentMessageImage' - columnProperties: - description: Optional. Display properties for the columns in this table. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2IntentMessageColumnProperties - rows: - description: Optional. Rows in this table of data. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2IntentMessageTableCardRow - buttons: - description: Optional. List of buttons for the card. + secretVersionForClientSecret: + description: >- + Optional. The name of the SecretManager secret version resource + storing the client secret. If this field is set, the `client_secret` + field will be ignored. Format: + `projects/{project}/secrets/{secret}/versions/{version}` + type: string + tokenEndpoint: + description: >- + Required. The token endpoint provided by the 3rd party platform to + exchange an access token. + type: string + scopes: + description: Optional. The OAuth scopes to grant. type: array items: - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2IntentMessageBasicCardButton - GoogleCloudDialogflowV2IntentMessageColumnProperties: - id: GoogleCloudDialogflowV2IntentMessageColumnProperties - description: Column properties for TableCard. + type: string + GoogleCloudDialogflowCxV3beta1WebhookServiceDirectoryConfig: + id: GoogleCloudDialogflowCxV3beta1WebhookServiceDirectoryConfig + description: >- + Represents configuration for a [Service + Directory](https://cloud.google.com/service-directory) service. type: object properties: - header: - description: Required. Column heading. - type: string - horizontalAlignment: - description: Optional. Defines text alignment for all cells in this column. + service: + description: >- + Required. The name of [Service + Directory](https://cloud.google.com/service-directory) service. + Format: `projects//locations//namespaces//services/`. `Location ID` + of the service directory must be the same as the location of the + agent. type: string - enumDescriptions: - - Text is aligned to the leading edge of the column. - - Text is aligned to the leading edge of the column. - - Text is centered in the column. - - Text is aligned to the trailing edge of the column. - enum: - - HORIZONTAL_ALIGNMENT_UNSPECIFIED - - LEADING - - CENTER - - TRAILING - GoogleCloudDialogflowV2IntentMessageTableCardRow: - id: GoogleCloudDialogflowV2IntentMessageTableCardRow - description: Row of TableCard. + genericWebService: + description: Generic Service configuration of this webhook. + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3beta1WebhookGenericWebService + GoogleCloudDialogflowCxV3beta1ConversationSignals: + id: GoogleCloudDialogflowCxV3beta1ConversationSignals + description: >- + This message is used to hold all the Conversation Signals data, which + will be converted to JSON and exported to BigQuery. type: object properties: - cells: - description: Optional. List of cells that make up this row. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2IntentMessageTableCardCell - dividerAfter: - description: Optional. Whether to add a visual divider after this row. - type: boolean - GoogleCloudDialogflowV2IntentMessageTableCardCell: - id: GoogleCloudDialogflowV2IntentMessageTableCardCell - description: Cell of TableCardRow. + turnSignals: + description: Required. Turn signals for the current turn. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1TurnSignals' + GoogleCloudDialogflowCxV3beta1TurnSignals: + id: GoogleCloudDialogflowCxV3beta1TurnSignals + description: >- + Collection of all signals that were extracted for a single turn of the + conversation. type: object properties: - text: - description: Required. Text in this cell. - type: string - GoogleCloudDialogflowV2IntentMessageMediaContent: - id: GoogleCloudDialogflowV2IntentMessageMediaContent - description: The media content card for Actions on Google. + noMatch: + description: Whether NLU predicted NO_MATCH. + type: boolean + noUserInput: + description: Whether user provided no input. + type: boolean + dtmfUsed: + description: Whether user was using DTMF input. + type: boolean + userEscalated: + description: Whether user was specifically asking for a live agent. + type: boolean + agentEscalated: + description: Whether agent responded with LiveAgentHandoff fulfillment. + type: boolean + reachedEndPage: + description: Whether turn resulted in End Session page. + type: boolean + webhookStatuses: + description: Human-readable statuses of the webhooks triggered during this turn. + type: array + items: + type: string + failureReasons: + description: Failure reasons of the turn. + type: array + items: + type: string + enumDescriptions: + - Failure reason is not assigned. + - Whether NLU failed to recognize user intent. + - Whether webhook failed during the turn. + enum: + - FAILURE_REASON_UNSPECIFIED + - FAILED_INTENT + - FAILED_WEBHOOK + sentimentScore: + description: >- + Sentiment score of the user utterance if + [sentiment](https://cloud.google.com/dialogflow/cx/docs/concept/sentiment) + was enabled. + type: number + format: float + sentimentMagnitude: + description: >- + Sentiment magnitude of the user utterance if + [sentiment](https://cloud.google.com/dialogflow/cx/docs/concept/sentiment) + was enabled. + type: number + format: float + GoogleCloudDialogflowV2BatchUpdateEntityTypesResponse: + id: GoogleCloudDialogflowV2BatchUpdateEntityTypesResponse + description: The response message for EntityTypes.BatchUpdateEntityTypes. type: object properties: - mediaType: - description: Optional. What type of media is the content (ie "audio"). - type: string - enumDescriptions: - - Unspecified. - - Response media type is audio. - enum: - - RESPONSE_MEDIA_TYPE_UNSPECIFIED - - AUDIO - mediaObjects: - description: Required. List of media objects. + entityTypes: + description: The collection of updated or created entity types. type: array items: - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2IntentMessageMediaContentResponseMediaObject - GoogleCloudDialogflowV2IntentMessageMediaContentResponseMediaObject: - id: GoogleCloudDialogflowV2IntentMessageMediaContentResponseMediaObject - description: Response media object for media content card. + $ref: '#/components/schemas/GoogleCloudDialogflowV2EntityType' + GoogleCloudDialogflowV2EntityType: + id: GoogleCloudDialogflowV2EntityType + description: >- + Each intent parameter has a type, called the entity type, which dictates + exactly how data from an end-user expression is extracted. Dialogflow + provides predefined system entities that can match many common types of + data. For example, there are system entities for matching dates, times, + colors, email addresses, and so on. You can also create your own custom + entities for matching custom data. For example, you could define a + vegetable entity that can match the types of vegetables available for + purchase with a grocery store agent. For more information, see the + [Entity + guide](https://cloud.google.com/dialogflow/docs/entities-overview). type: object properties: name: - description: Required. Name of media card. + description: >- + The unique identifier of the entity type. Required for + EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes + methods. Format: `projects//agent/entityTypes/`. type: string - description: - description: Optional. Description of media card. + displayName: + description: Required. The name of the entity type. type: string - largeImage: - description: Optional. Image to display above media content. - $ref: '#/components/schemas/GoogleCloudDialogflowV2IntentMessageImage' - icon: - description: Optional. Icon to display above media content. - $ref: '#/components/schemas/GoogleCloudDialogflowV2IntentMessageImage' - contentUrl: - description: Required. Url where the media is stored. + kind: + description: Required. Indicates the kind of entity type. type: string - GoogleCloudDialogflowV2IntentFollowupIntentInfo: - id: GoogleCloudDialogflowV2IntentFollowupIntentInfo - description: Represents a single followup intent in the chain. + enumDescriptions: + - Not specified. This value should be never used. + - >- + Map entity types allow mapping of a group of synonyms to a + reference value. + - >- + List entity types contain a set of entries that do not map to + reference values. However, list entity types can contain + references to other entity types (with or without aliases). + - >- + Regexp entity types allow to specify regular expressions in + entries values. + enum: + - KIND_UNSPECIFIED + - KIND_MAP + - KIND_LIST + - KIND_REGEXP + autoExpansionMode: + description: >- + Optional. Indicates whether the entity type can be automatically + expanded. + type: string + enumDescriptions: + - Auto expansion disabled for the entity. + - >- + Allows an agent to recognize values that have not been explicitly + listed in the entity. + enum: + - AUTO_EXPANSION_MODE_UNSPECIFIED + - AUTO_EXPANSION_MODE_DEFAULT + entities: + description: >- + Optional. The collection of entity entries associated with the + entity type. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowV2EntityTypeEntity' + enableFuzzyExtraction: + description: Optional. Enables fuzzy entity extraction during classification. + type: boolean + GoogleCloudDialogflowV2EntityTypeEntity: + id: GoogleCloudDialogflowV2EntityTypeEntity + description: An **entity entry** for an associated entity type. type: object properties: - followupIntentName: + value: description: >- - The unique identifier of the followup intent. Format: - `projects//agent/intents/`. + Required. The primary value associated with this entity entry. For + example, if the entity type is *vegetable*, the value could be + *scallions*. For `KIND_MAP` entity types: * A reference value to be + used in place of synonyms. For `KIND_LIST` entity types: * A string + that can contain references to other entity types (with or without + aliases). type: string - parentFollowupIntentName: + synonyms: description: >- - The unique identifier of the followup intent's parent. Format: - `projects//agent/intents/`. - type: string - GoogleCloudDialogflowV2ClearSuggestionFeatureConfigOperationMetadata: - id: GoogleCloudDialogflowV2ClearSuggestionFeatureConfigOperationMetadata + Required. A collection of value synonyms. For example, if the entity + type is *vegetable*, and `value` is *scallions*, a synonym could be + *green onions*. For `KIND_LIST` entity types: * This collection must + contain exactly one synonym equal to `value`. + type: array + items: + type: string + GoogleCloudDialogflowV2BatchUpdateIntentsResponse: + id: GoogleCloudDialogflowV2BatchUpdateIntentsResponse + description: The response message for Intents.BatchUpdateIntents. + type: object + properties: + intents: + description: The collection of updated or created intents. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowV2Intent' + GoogleCloudDialogflowV2Intent: + id: GoogleCloudDialogflowV2Intent description: >- - Metadata for a ConversationProfile.ClearSuggestionFeatureConfig - operation. + An intent categorizes an end-user's intention for one conversation turn. + For each agent, you define many intents, where your combined intents can + handle a complete conversation. When an end-user writes or says + something, referred to as an end-user expression or end-user input, + Dialogflow matches the end-user input to the best intent in your agent. + Matching an intent is also known as intent classification. For more + information, see the [intent + guide](https://cloud.google.com/dialogflow/docs/intents-overview). type: object properties: - conversationProfile: + name: description: >- - The resource name of the conversation profile. Format: - `projects//locations//conversationProfiles/` + Optional. The unique identifier of this intent. Required for + Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Format: + `projects//agent/intents/`. type: string - participantRole: - description: >- - Required. The participant role to remove the suggestion feature - config. Only HUMAN_AGENT or END_USER can be used. + displayName: + description: Required. The name of this intent. + type: string + webhookState: + description: Optional. Indicates whether webhooks are enabled for the intent. type: string enumDescriptions: - - Participant role not set. - - Participant is a human agent. - - Participant is an automated agent, such as a Dialogflow agent. + - Webhook is disabled in the agent and in the intent. + - Webhook is enabled in the agent and in the intent. - >- - Participant is an end user that has called or chatted with - Dialogflow services. + Webhook is enabled in the agent and in the intent. Also, each slot + filling prompt is forwarded to the webhook. enum: - - ROLE_UNSPECIFIED - - HUMAN_AGENT - - AUTOMATED_AGENT - - END_USER - suggestionFeatureType: - description: Required. The type of the suggestion feature to remove. - type: string - enumDescriptions: - - Unspecified feature type. - - Run article suggestion model for chat. - - Run FAQ model for chat. - - Run smart reply model for chat. - - >- - Run knowledge search with text input from agent or text generated - query. - - Run knowledge assist with automatic query generation. - enum: - - TYPE_UNSPECIFIED - - ARTICLE_SUGGESTION - - FAQ - - SMART_REPLY - - KNOWLEDGE_SEARCH - - KNOWLEDGE_ASSIST - createTime: + - WEBHOOK_STATE_UNSPECIFIED + - WEBHOOK_STATE_ENABLED + - WEBHOOK_STATE_ENABLED_FOR_SLOT_FILLING + priority: description: >- - Timestamp whe the request was created. The time is measured on - server side. + Optional. The priority of this intent. Higher numbers represent + higher priorities. - If the supplied value is unspecified or 0, the + service translates the value to 500,000, which corresponds to the + `Normal` priority in the console. - If the supplied value is + negative, the intent is ignored in runtime detect intent requests. + type: integer + format: int32 + isFallback: + description: Optional. Indicates whether this is a fallback intent. + type: boolean + mlDisabled: + description: >- + Optional. Indicates whether Machine Learning is disabled for the + intent. Note: If `ml_disabled` setting is set to true, then this + intent is not taken into account during inference in `ML ONLY` match + mode. Also, auto-markup in the UI is turned off. + type: boolean + liveAgentHandoff: + description: >- + Optional. Indicates that a live agent should be brought in to handle + the interaction with the user. In most cases, when you set this flag + to true, you would also want to set end_interaction to true as well. + Default is false. + type: boolean + endInteraction: + description: >- + Optional. Indicates that this intent ends an interaction. Some + integrations (e.g., Actions on Google or Dialogflow phone gateway) + use this information to close interaction with an end user. Default + is false. + type: boolean + inputContextNames: + description: >- + Optional. The list of context names required for this intent to be + triggered. Format: `projects//agent/sessions/-/contexts/`. + type: array + items: + type: string + events: + description: >- + Optional. The collection of event names that trigger the intent. If + the collection of input contexts is not empty, all of the contexts + must be present in the active user session for an event to trigger + this intent. Event names are limited to 150 characters. + type: array + items: + type: string + trainingPhrases: + description: Optional. The collection of examples that the agent is trained on. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowV2IntentTrainingPhrase' + action: + description: >- + Optional. The name of the action associated with the intent. Note: + The action name must not contain whitespaces. type: string - format: google-datetime - GoogleCloudDialogflowV2ConversationEvent: - id: GoogleCloudDialogflowV2ConversationEvent - description: >- - Represents a notification sent to Pub/Sub subscribers for conversation - lifecycle events. - type: object - properties: - conversation: + outputContexts: description: >- - The unique identifier of the conversation this notification refers - to. Format: `projects//conversations/`. + Optional. The collection of contexts that are activated when the + intent is matched. Context messages in this collection should not + set the parameters field. Setting the `lifespan_count` to 0 will + reset the context when the intent is matched. Format: + `projects//agent/sessions/-/contexts/`. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowV2Context' + resetContexts: + description: >- + Optional. Indicates whether to delete all contexts in the current + session when this intent is matched. + type: boolean + parameters: + description: Optional. The collection of parameters associated with the intent. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowV2IntentParameter' + messages: + description: >- + Optional. The collection of rich messages corresponding to the + `Response` field in the Dialogflow console. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowV2IntentMessage' + defaultResponsePlatforms: + description: >- + Optional. The list of platforms for which the first responses will + be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default + platform). + type: array + items: + type: string + enumDescriptions: + - Default platform. + - Facebook. + - Slack. + - Telegram. + - Kik. + - Skype. + - Line. + - Viber. + - >- + Google Assistant See [Dialogflow webhook + format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json) + - Google Hangouts. + enum: + - PLATFORM_UNSPECIFIED + - FACEBOOK + - SLACK + - TELEGRAM + - KIK + - SKYPE + - LINE + - VIBER + - ACTIONS_ON_GOOGLE + - GOOGLE_HANGOUTS + rootFollowupIntentName: + description: >- + Output only. Read-only. The unique identifier of the root intent in + the chain of followup intents. It identifies the correct followup + intents chain for this intent. We populate this field only in the + output. Format: `projects//agent/intents/`. + readOnly: true type: string - type: - description: The type of the event that this notification refers to. + parentFollowupIntentName: + description: >- + Read-only after creation. The unique identifier of the parent intent + in the chain of followup intents. You can set this field when + creating an intent, for example with CreateIntent or + BatchUpdateIntents, in order to make this intent a followup intent. + It identifies the parent followup intent. Format: + `projects//agent/intents/`. type: string - enumDescriptions: - - Type not set. - - >- - A new conversation has been opened. This is fired when a telephone - call is answered, or a conversation is created via the API. - - >- - An existing conversation has closed. This is fired when a - telephone call is terminated, or a conversation is closed via the - API. - - >- - An existing conversation has received notification from Dialogflow - that human intervention is required. - - >- - An existing conversation has received a new message, either from - API or telephony. It is configured in - ConversationProfile.new_message_event_notification_config - - >- - Unrecoverable error during a telephone call. In general - non-recoverable errors only occur if something was misconfigured - in the ConversationProfile corresponding to the call. After a - non-recoverable error, Dialogflow may stop responding. We don't - fire this event: * in an API call because we can directly return - the error, or, * when we can recover from an error. - enum: - - TYPE_UNSPECIFIED - - CONVERSATION_STARTED - - CONVERSATION_FINISHED - - HUMAN_INTERVENTION_NEEDED - - NEW_MESSAGE - - UNRECOVERABLE_ERROR - errorStatus: + followupIntentInfo: description: >- - More detailed information about an error. Only set for type - UNRECOVERABLE_ERROR_IN_PHONE_CALL. - $ref: '#/components/schemas/GoogleRpcStatus' - newMessagePayload: - description: Payload of NEW_MESSAGE event. - $ref: '#/components/schemas/GoogleCloudDialogflowV2Message' - GoogleCloudDialogflowV2Message: - id: GoogleCloudDialogflowV2Message - description: Represents a message posted into a conversation. + Output only. Read-only. Information about all followup intents that + have this intent as a direct or indirect parent. We populate this + field only in the output. + readOnly: true + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2IntentFollowupIntentInfo + GoogleCloudDialogflowV2IntentTrainingPhrase: + id: GoogleCloudDialogflowV2IntentTrainingPhrase + description: Represents an example that the agent is trained on. type: object properties: name: - description: >- - Optional. The unique identifier of the message. Format: - `projects//locations//conversations//messages/`. - type: string - content: - description: Required. The message content. - type: string - languageCode: - description: >- - Optional. The message language. This should be a - [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. - Example: "en-US". - type: string - participant: - description: Output only. The participant that sends this message. + description: Output only. The unique identifier of this training phrase. readOnly: true type: string - participantRole: - description: Output only. The role of the participant. - readOnly: true + type: + description: Required. The type of the training phrase. type: string enumDescriptions: - - Participant role not set. - - Participant is a human agent. - - Participant is an automated agent, such as a Dialogflow agent. + - Not specified. This value should never be used. - >- - Participant is an end user that has called or chatted with - Dialogflow services. + Examples do not contain @-prefixed entity type names, but example + parts can be annotated with entity types. + - >- + Templates are not annotated with entity types, but they can + contain @-prefixed entity type names as substrings. Template mode + has been deprecated. Example mode is the only supported way to + create new training phrases. If you have existing training phrases + that you've created in template mode, those will continue to work. + enumDeprecated: + - false + - false + - true enum: - - ROLE_UNSPECIFIED - - HUMAN_AGENT - - AUTOMATED_AGENT - - END_USER - createTime: - description: >- - Output only. The time when the message was created in Contact Center - AI. - readOnly: true - type: string - format: google-datetime - sendTime: - description: Optional. The time when the message was sent. - type: string - format: google-datetime - messageAnnotation: - description: Output only. The annotation for the message. - readOnly: true - $ref: '#/components/schemas/GoogleCloudDialogflowV2MessageAnnotation' - sentimentAnalysis: - description: Output only. The sentiment analysis result for the message. - readOnly: true - $ref: '#/components/schemas/GoogleCloudDialogflowV2SentimentAnalysisResult' - GoogleCloudDialogflowV2MessageAnnotation: - id: GoogleCloudDialogflowV2MessageAnnotation - description: Represents the result of annotation for the message. - type: object - properties: + - TYPE_UNSPECIFIED + - EXAMPLE + - TEMPLATE parts: description: >- - The collection of annotated message parts ordered by their position - in the message. You can recover the annotated message by - concatenating [AnnotatedMessagePart.text]. + Required. The ordered list of training phrase parts. The parts are + concatenated in order to form the training phrase. Note: The API + does not automatically annotate training phrases like the Dialogflow + Console does. Note: Do not forget to include whitespace at part + boundaries, so the training phrase is well formatted when the parts + are concatenated. If the training phrase does not need to be + annotated with parameters, you just need a single part with only the + Part.text field set. If you want to annotate the training phrase, + you must create multiple parts, where the fields of each part are + populated in one of two ways: - `Part.text` is set to a part of the + phrase that has no parameters. - `Part.text` is set to a part of the + phrase that you want to annotate, and the `entity_type`, `alias`, + and `user_defined` fields are all set. type: array items: - $ref: '#/components/schemas/GoogleCloudDialogflowV2AnnotatedMessagePart' - containEntities: - description: Indicates whether the text message contains entities. - type: boolean - GoogleCloudDialogflowV2AnnotatedMessagePart: - id: GoogleCloudDialogflowV2AnnotatedMessagePart - description: >- - Represents a part of a message possibly annotated with an entity. The - part can be an entity or purely a part of the message between two - entities or message start/end. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2IntentTrainingPhrasePart + timesAddedCount: + description: >- + Optional. Indicates how many times this example was added to the + intent. Each time a developer adds an existing sample by editing an + intent or training, this counter is increased. + type: integer + format: int32 + GoogleCloudDialogflowV2IntentTrainingPhrasePart: + id: GoogleCloudDialogflowV2IntentTrainingPhrasePart + description: Represents a part of a training phrase. type: object properties: text: - description: A part of a message possibly annotated with an entity. + description: Required. The text for this part. type: string entityType: description: >- - The [Dialogflow system entity - type](https://cloud.google.com/dialogflow/docs/reference/system-entities) - of this message part. If this is empty, Dialogflow could not - annotate the phrase part with a system entity. + Optional. The entity type name prefixed with `@`. This field is + required for annotated parts of the training phrase. type: string - formattedValue: + alias: description: >- - The [Dialogflow system entity formatted value - ](https://cloud.google.com/dialogflow/docs/reference/system-entities) - of this message part. For example for a system entity of type - `@sys.unit-currency`, this may contain: { "amount": 5, "currency": - "USD" } - type: any - GoogleCloudDialogflowV2SentimentAnalysisResult: - id: GoogleCloudDialogflowV2SentimentAnalysisResult - description: >- - The result of sentiment analysis. Sentiment analysis inspects user input - and identifies the prevailing subjective opinion, especially to - determine a user's attitude as positive, negative, or neutral. For - Participants.DetectIntent, it needs to be configured in - DetectIntentRequest.query_params. For - Participants.StreamingDetectIntent, it needs to be configured in - StreamingDetectIntentRequest.query_params. And for - Participants.AnalyzeContent and Participants.StreamingAnalyzeContent, it - needs to be configured in - ConversationProfile.human_agent_assistant_config - type: object - properties: - queryTextSentiment: - description: The sentiment analysis result for `query_text`. - $ref: '#/components/schemas/GoogleCloudDialogflowV2Sentiment' - GoogleCloudDialogflowV2Sentiment: - id: GoogleCloudDialogflowV2Sentiment + Optional. The parameter name for the value extracted from the + annotated part of the example. This field is required for annotated + parts of the training phrase. + type: string + userDefined: + description: >- + Optional. Indicates whether the text was manually annotated. This + field is set to true when the Dialogflow Console is used to manually + annotate the part. When creating an annotated part with the API, you + must set this to true. + type: boolean + GoogleCloudDialogflowV2Context: + id: GoogleCloudDialogflowV2Context description: >- - The sentiment, such as positive/negative feeling or association, for a - unit of analysis, such as the query text. See: - https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values - for how to interpret the result. + Dialogflow contexts are similar to natural language context. If a person + says to you "they are orange", you need context in order to understand + what "they" is referring to. Similarly, for Dialogflow to handle an + end-user expression like that, it needs to be provided with context in + order to correctly match an intent. Using contexts, you can control the + flow of a conversation. You can configure contexts for an intent by + setting input and output contexts, which are identified by string names. + When an intent is matched, any configured output contexts for that + intent become active. While any contexts are active, Dialogflow is more + likely to match intents that are configured with input contexts that + correspond to the currently active contexts. For more information about + context, see the [Contexts + guide](https://cloud.google.com/dialogflow/docs/contexts-overview). type: object properties: - score: + name: description: >- - Sentiment score between -1.0 (negative sentiment) and 1.0 (positive - sentiment). - type: number - format: float - magnitude: + Required. The unique identifier of the context. Format: + `projects//agent/sessions//contexts/`, or + `projects//agent/environments//users//sessions//contexts/`. The + `Context ID` is always converted to lowercase, may only contain + characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long. If + `Environment ID` is not specified, we assume default 'draft' + environment. If `User ID` is not specified, we assume default '-' + user. The following context names are reserved for internal use by + Dialogflow. You should not use these contexts or create contexts + with these names: * `__system_counters__` * `*_id_dialog_context` * + `*_dialog_params_size` + type: string + lifespanCount: description: >- - A non-negative number in the [0, +inf) range, which represents the - absolute magnitude of sentiment, regardless of score (positive or - negative). - type: number - format: float - GoogleCloudDialogflowV2ExportAgentResponse: - id: GoogleCloudDialogflowV2ExportAgentResponse - description: The response message for Agents.ExportAgent. + Optional. The number of conversational query requests after which + the context expires. The default is `0`. If set to `0`, the context + expires immediately. Contexts expire automatically after 20 minutes + if there are no matching queries. + type: integer + format: int32 + parameters: + description: >- + Optional. The collection of parameters associated with this context. + Depending on your protocol or client library language, this is a + map, associative array, symbol table, dictionary, or JSON object + composed of a collection of (MapKey, MapValue) pairs: * MapKey type: + string * MapKey value: parameter name * MapValue type: If + parameter's entity type is a composite entity then use map, + otherwise, depending on the parameter value type, it could be one of + string, number, boolean, null, list or map. * MapValue value: If + parameter's entity type is a composite entity then use map from + composite entity property names to property values, otherwise, use + parameter value. + type: object + additionalProperties: + type: any + description: Properties of the object. + GoogleCloudDialogflowV2IntentParameter: + id: GoogleCloudDialogflowV2IntentParameter + description: Represents intent parameters. type: object properties: - agentUri: - description: >- - The URI to a file containing the exported agent. This field is - populated only if `agent_uri` is specified in `ExportAgentRequest`. + name: + description: The unique identifier of this parameter. type: string - agentContent: - description: Zip compressed raw byte content for agent. + displayName: + description: Required. The name of the parameter. type: string - format: byte - GoogleCloudDialogflowV2HumanAgentAssistantEvent: - id: GoogleCloudDialogflowV2HumanAgentAssistantEvent - description: >- - Represents a notification sent to Cloud Pub/Sub subscribers for human - agent assistant events in a specific conversation. - type: object - properties: - conversation: + value: description: >- - The conversation this notification refers to. Format: - `projects//conversations/`. + Optional. The definition of the parameter value. It can be: - a + constant string, - a parameter value defined as `$parameter_name`, - + an original parameter value defined as `$parameter_name.original`, - + a parameter value from some context defined as + `#context_name.parameter_name`. type: string - participant: + defaultValue: description: >- - The participant that the suggestion is compiled for. Format: - `projects//conversations//participants/`. It will not be set in - legacy workflow. + Optional. The default value to use when the `value` yields an empty + result. Default values can be extracted from contexts by using the + following syntax: `#context_name.parameter_name`. type: string - suggestionResults: - description: The suggestion results payload that this notification refers to. + entityTypeDisplayName: + description: >- + Optional. The name of the entity type, prefixed with `@`, that + describes values of the parameter. If the parameter is required, + this must be provided. + type: string + mandatory: + description: >- + Optional. Indicates whether the parameter is required. That is, + whether the intent cannot be completed without collecting the + parameter value. + type: boolean + prompts: + description: >- + Optional. The collection of prompts that the agent can present to + the user in order to collect a value for the parameter. type: array items: - $ref: '#/components/schemas/GoogleCloudDialogflowV2SuggestionResult' - GoogleCloudDialogflowV2SuggestionResult: - id: GoogleCloudDialogflowV2SuggestionResult + type: string + isList: + description: >- + Optional. Indicates whether the parameter represents a list of + values. + type: boolean + GoogleCloudDialogflowV2IntentMessage: + id: GoogleCloudDialogflowV2IntentMessage description: >- - One response of different type of suggestion response which is used in - the response of Participants.AnalyzeContent and - Participants.AnalyzeContent, as well as HumanAgentAssistantEvent. + A rich response message. Corresponds to the intent `Response` field in + the Dialogflow console. For more information, see [Rich response + messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages). type: object properties: - error: - description: Error status if the request failed. - $ref: '#/components/schemas/GoogleRpcStatus' - suggestArticlesResponse: - description: SuggestArticlesResponse if request is for ARTICLE_SUGGESTION. - $ref: '#/components/schemas/GoogleCloudDialogflowV2SuggestArticlesResponse' - suggestKnowledgeAssistResponse: - description: SuggestKnowledgeAssistResponse if request is for KNOWLEDGE_ASSIST. + text: + description: The text response. + $ref: '#/components/schemas/GoogleCloudDialogflowV2IntentMessageText' + image: + description: The image response. + $ref: '#/components/schemas/GoogleCloudDialogflowV2IntentMessageImage' + quickReplies: + description: The quick replies response. $ref: >- - #/components/schemas/GoogleCloudDialogflowV2SuggestKnowledgeAssistResponse - suggestFaqAnswersResponse: - description: SuggestFaqAnswersResponse if request is for FAQ_ANSWER. + #/components/schemas/GoogleCloudDialogflowV2IntentMessageQuickReplies + card: + description: The card response. + $ref: '#/components/schemas/GoogleCloudDialogflowV2IntentMessageCard' + payload: + description: A custom platform-specific response. + type: object + additionalProperties: + type: any + description: Properties of the object. + simpleResponses: + description: The voice and text-only responses for Actions on Google. $ref: >- - #/components/schemas/GoogleCloudDialogflowV2SuggestFaqAnswersResponse - suggestSmartRepliesResponse: - description: SuggestSmartRepliesResponse if request is for SMART_REPLY. + #/components/schemas/GoogleCloudDialogflowV2IntentMessageSimpleResponses + basicCard: + description: The basic card response for Actions on Google. + $ref: '#/components/schemas/GoogleCloudDialogflowV2IntentMessageBasicCard' + suggestions: + description: The suggestion chips for Actions on Google. + $ref: '#/components/schemas/GoogleCloudDialogflowV2IntentMessageSuggestions' + linkOutSuggestion: + description: The link out suggestion chip for Actions on Google. $ref: >- - #/components/schemas/GoogleCloudDialogflowV2SuggestSmartRepliesResponse - GoogleCloudDialogflowV2SuggestArticlesResponse: - id: GoogleCloudDialogflowV2SuggestArticlesResponse - description: The response message for Participants.SuggestArticles. + #/components/schemas/GoogleCloudDialogflowV2IntentMessageLinkOutSuggestion + listSelect: + description: The list card response for Actions on Google. + $ref: '#/components/schemas/GoogleCloudDialogflowV2IntentMessageListSelect' + carouselSelect: + description: The carousel card response for Actions on Google. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2IntentMessageCarouselSelect + browseCarouselCard: + description: Browse carousel card for Actions on Google. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2IntentMessageBrowseCarouselCard + tableCard: + description: Table card for Actions on Google. + $ref: '#/components/schemas/GoogleCloudDialogflowV2IntentMessageTableCard' + mediaContent: + description: The media content card for Actions on Google. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2IntentMessageMediaContent + platform: + description: Optional. The platform that this message is intended for. + type: string + enumDescriptions: + - Default platform. + - Facebook. + - Slack. + - Telegram. + - Kik. + - Skype. + - Line. + - Viber. + - >- + Google Assistant See [Dialogflow webhook + format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json) + - Google Hangouts. + enum: + - PLATFORM_UNSPECIFIED + - FACEBOOK + - SLACK + - TELEGRAM + - KIK + - SKYPE + - LINE + - VIBER + - ACTIONS_ON_GOOGLE + - GOOGLE_HANGOUTS + GoogleCloudDialogflowV2IntentMessageText: + id: GoogleCloudDialogflowV2IntentMessageText + description: The text response message. type: object properties: - articleAnswers: - description: Articles ordered by score in descending order. + text: + description: Optional. The collection of the agent's responses. type: array items: - $ref: '#/components/schemas/GoogleCloudDialogflowV2ArticleAnswer' - latestMessage: - description: >- - The name of the latest conversation message used to compile - suggestion for. Format: - `projects//locations//conversations//messages/`. + type: string + GoogleCloudDialogflowV2IntentMessageImage: + id: GoogleCloudDialogflowV2IntentMessageImage + description: The image response message. + type: object + properties: + imageUri: + description: Optional. The public URI to an image file. type: string - contextSize: + accessibilityText: description: >- - Number of messages prior to and including latest_message to compile - the suggestion. It may be smaller than the - SuggestArticlesRequest.context_size field in the request if there - aren't that many messages in the conversation. - type: integer - format: int32 - GoogleCloudDialogflowV2ArticleAnswer: - id: GoogleCloudDialogflowV2ArticleAnswer - description: Represents article answer. + Optional. A text description of the image to be used for + accessibility, e.g., screen readers. + type: string + GoogleCloudDialogflowV2IntentMessageQuickReplies: + id: GoogleCloudDialogflowV2IntentMessageQuickReplies + description: The quick replies response message. type: object properties: title: - description: The article title. - type: string - uri: - description: The article URI. + description: Optional. The title of the collection of quick replies. type: string - snippets: - description: Article snippets. + quickReplies: + description: Optional. The collection of quick replies. type: array items: type: string - confidence: - description: >- - Article match confidence. The system's confidence score that this - article is a good match for this conversation, as a value from 0.0 - (completely uncertain) to 1.0 (completely certain). - type: number - format: float - metadata: - description: >- - A map that contains metadata about the answer and the document from - which it originates. - type: object - additionalProperties: - type: string - answerRecord: - description: >- - The name of answer record, in the format of - "projects//locations//answerRecords/" - type: string - GoogleCloudDialogflowV2SuggestKnowledgeAssistResponse: - id: GoogleCloudDialogflowV2SuggestKnowledgeAssistResponse - description: The response message for Participants.SuggestKnowledgeAssist. + GoogleCloudDialogflowV2IntentMessageCard: + id: GoogleCloudDialogflowV2IntentMessageCard + description: The card response message. type: object properties: - knowledgeAssistAnswer: - description: Output only. Knowledge Assist suggestion. - readOnly: true - $ref: '#/components/schemas/GoogleCloudDialogflowV2KnowledgeAssistAnswer' - latestMessage: - description: >- - The name of the latest conversation message used to compile - suggestion for. Format: - `projects//locations//conversations//messages/`. + title: + description: Optional. The title of the card. type: string - contextSize: - description: >- - Number of messages prior to and including latest_message to compile - the suggestion. It may be smaller than the - SuggestKnowledgeAssistRequest.context_size field in the request if - there are fewer messages in the conversation. - type: integer - format: int32 - GoogleCloudDialogflowV2KnowledgeAssistAnswer: - id: GoogleCloudDialogflowV2KnowledgeAssistAnswer - description: Represents a Knowledge Assist answer. + subtitle: + description: Optional. The subtitle of the card. + type: string + imageUri: + description: Optional. The public URI to an image file for the card. + type: string + buttons: + description: Optional. The collection of card buttons. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2IntentMessageCardButton + GoogleCloudDialogflowV2IntentMessageCardButton: + id: GoogleCloudDialogflowV2IntentMessageCardButton + description: Contains information about a button. type: object properties: - suggestedQuery: - description: >- - The query suggested based on the context. Suggestion is made only if - it is different from the previous suggestion. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2KnowledgeAssistAnswerSuggestedQuery - suggestedQueryAnswer: - description: >- - The answer generated for the suggested query. Whether or not an - answer is generated depends on how confident we are about the - generated query. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswer - answerRecord: + text: + description: Optional. The text to show on the button. + type: string + postback: description: >- - The name of the answer record. Format: `projects//locations//answer - Records/`. + Optional. The text to send back to the Dialogflow API or a URI to + open. type: string - GoogleCloudDialogflowV2KnowledgeAssistAnswerSuggestedQuery: - id: GoogleCloudDialogflowV2KnowledgeAssistAnswerSuggestedQuery - description: Represents a suggested query. + GoogleCloudDialogflowV2IntentMessageSimpleResponses: + id: GoogleCloudDialogflowV2IntentMessageSimpleResponses + description: >- + The collection of simple response candidates. This message in + `QueryResult.fulfillment_messages` and + `WebhookResponse.fulfillment_messages` should contain only one + `SimpleResponse`. type: object properties: - queryText: - description: Suggested query text. - type: string - GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswer: - id: GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswer - description: >- - Represents an answer from Knowledge. Currently supports FAQ and - Generative answers. + simpleResponses: + description: Required. The list of simple responses. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2IntentMessageSimpleResponse + GoogleCloudDialogflowV2IntentMessageSimpleResponse: + id: GoogleCloudDialogflowV2IntentMessageSimpleResponse + description: The simple response message containing speech or text. type: object properties: - answerText: + textToSpeech: description: >- - The piece of text from the `source` that answers this suggested - query. - type: string - faqSource: - description: Populated if the prediction came from FAQ. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerFaqSource - generativeSource: - description: Populated if the prediction was Generative. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource - GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerFaqSource: - id: GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerFaqSource - description: Details about source of FAQ answer. - type: object - properties: - question: - description: The corresponding FAQ question. + One of text_to_speech or ssml must be provided. The plain text of + the speech output. Mutually exclusive with ssml. type: string - GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource: - id: >- - GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource - description: Details about source of Generative answer. + ssml: + description: >- + One of text_to_speech or ssml must be provided. Structured spoken + response to the user in the SSML format. Mutually exclusive with + text_to_speech. + type: string + displayText: + description: Optional. The text to display. + type: string + GoogleCloudDialogflowV2IntentMessageBasicCard: + id: GoogleCloudDialogflowV2IntentMessageBasicCard + description: The basic card message. Useful for displaying information. type: object properties: - snippets: - description: >- - All snippets used for this Generative Prediction, with their source - URI and data. + title: + description: Optional. The title of the card. + type: string + subtitle: + description: Optional. The subtitle of the card. + type: string + formattedText: + description: Required, unless image is present. The body text of the card. + type: string + image: + description: Optional. The image for the card. + $ref: '#/components/schemas/GoogleCloudDialogflowV2IntentMessageImage' + buttons: + description: Optional. The collection of card buttons. type: array items: $ref: >- - #/components/schemas/GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet - GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet: - id: >- - GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet - description: Snippet Source for a Generative Prediction. + #/components/schemas/GoogleCloudDialogflowV2IntentMessageBasicCardButton + GoogleCloudDialogflowV2IntentMessageBasicCardButton: + id: GoogleCloudDialogflowV2IntentMessageBasicCardButton + description: The button object that appears at the bottom of a card. type: object properties: - uri: - description: URI the data is sourced from. - type: string - text: - description: Text taken from that URI. - type: string title: - description: Title of the document. + description: Required. The title of the button. type: string - metadata: - description: Metadata of the document. - type: object - additionalProperties: - type: any - description: Properties of the object. - GoogleCloudDialogflowV2SuggestFaqAnswersResponse: - id: GoogleCloudDialogflowV2SuggestFaqAnswersResponse - description: The request message for Participants.SuggestFaqAnswers. + openUriAction: + description: Required. Action to take when a user taps on the button. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2IntentMessageBasicCardButtonOpenUriAction + GoogleCloudDialogflowV2IntentMessageBasicCardButtonOpenUriAction: + id: GoogleCloudDialogflowV2IntentMessageBasicCardButtonOpenUriAction + description: Opens the given URI. type: object properties: - faqAnswers: - description: Answers extracted from FAQ documents. + uri: + description: Required. The HTTP or HTTPS scheme URI. + type: string + GoogleCloudDialogflowV2IntentMessageSuggestions: + id: GoogleCloudDialogflowV2IntentMessageSuggestions + description: The collection of suggestions. + type: object + properties: + suggestions: + description: Required. The list of suggested replies. type: array items: - $ref: '#/components/schemas/GoogleCloudDialogflowV2FaqAnswer' - latestMessage: - description: >- - The name of the latest conversation message used to compile - suggestion for. Format: - `projects//locations//conversations//messages/`. - type: string - contextSize: - description: >- - Number of messages prior to and including latest_message to compile - the suggestion. It may be smaller than the - SuggestFaqAnswersRequest.context_size field in the request if there - aren't that many messages in the conversation. - type: integer - format: int32 - GoogleCloudDialogflowV2FaqAnswer: - id: GoogleCloudDialogflowV2FaqAnswer - description: Represents answer from "frequently asked questions". + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2IntentMessageSuggestion + GoogleCloudDialogflowV2IntentMessageSuggestion: + id: GoogleCloudDialogflowV2IntentMessageSuggestion + description: >- + The suggestion chip message that the user can tap to quickly post a + reply to the conversation. type: object properties: - answer: - description: The piece of text from the `source` knowledge base document. - type: string - confidence: - description: >- - The system's confidence score that this Knowledge answer is a good - match for this conversational query, range from 0.0 (completely - uncertain) to 1.0 (completely certain). - type: number - format: float - question: - description: The corresponding FAQ question. + title: + description: Required. The text shown the in the suggestion chip. type: string - source: - description: >- - Indicates which Knowledge Document this answer was extracted from. - Format: `projects//locations//agent/knowledgeBases//documents/`. + GoogleCloudDialogflowV2IntentMessageLinkOutSuggestion: + id: GoogleCloudDialogflowV2IntentMessageLinkOutSuggestion + description: >- + The suggestion chip message that allows the user to jump out to the app + or website associated with this agent. + type: object + properties: + destinationName: + description: Required. The name of the app or site this chip is linking to. type: string - metadata: - description: >- - A map that contains metadata about the answer and the document from - which it originates. - type: object - additionalProperties: - type: string - answerRecord: + uri: description: >- - The name of answer record, in the format of - "projects//locations//answerRecords/" + Required. The URI of the app or site to open when the user taps the + suggestion chip. type: string - GoogleCloudDialogflowV2SuggestSmartRepliesResponse: - id: GoogleCloudDialogflowV2SuggestSmartRepliesResponse - description: The response message for Participants.SuggestSmartReplies. + GoogleCloudDialogflowV2IntentMessageListSelect: + id: GoogleCloudDialogflowV2IntentMessageListSelect + description: The card for presenting a list of options to select from. type: object properties: - smartReplyAnswers: - description: >- - Output only. Multiple reply options provided by smart reply service. - The order is based on the rank of the model prediction. The maximum - number of the returned replies is set in SmartReplyConfig. - readOnly: true + title: + description: Optional. The overall title of the list. + type: string + items: + description: Required. List items. type: array items: - $ref: '#/components/schemas/GoogleCloudDialogflowV2SmartReplyAnswer' - latestMessage: - description: >- - The name of the latest conversation message used to compile - suggestion for. Format: - `projects//locations//conversations//messages/`. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2IntentMessageListSelectItem + subtitle: + description: Optional. Subtitle of the list. type: string - contextSize: - description: >- - Number of messages prior to and including latest_message to compile - the suggestion. It may be smaller than the - SuggestSmartRepliesRequest.context_size field in the request if - there aren't that many messages in the conversation. - type: integer - format: int32 - GoogleCloudDialogflowV2SmartReplyAnswer: - id: GoogleCloudDialogflowV2SmartReplyAnswer - description: Represents a smart reply answer. + GoogleCloudDialogflowV2IntentMessageListSelectItem: + id: GoogleCloudDialogflowV2IntentMessageListSelectItem + description: An item in the list. type: object properties: - reply: - description: The content of the reply. + info: + description: Required. Additional information about this option. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2IntentMessageSelectItemInfo + title: + description: Required. The title of the list item. type: string - confidence: - description: >- - Smart reply confidence. The system's confidence score that this - reply is a good match for this conversation, as a value from 0.0 - (completely uncertain) to 1.0 (completely certain). - type: number - format: float - answerRecord: - description: >- - The name of answer record, in the format of - "projects//locations//answerRecords/" + description: + description: Optional. The main text describing the item. type: string - GoogleCloudDialogflowV2ImportDocumentsResponse: - id: GoogleCloudDialogflowV2ImportDocumentsResponse - description: Response message for Documents.ImportDocuments. + image: + description: Optional. The image to display. + $ref: '#/components/schemas/GoogleCloudDialogflowV2IntentMessageImage' + GoogleCloudDialogflowV2IntentMessageSelectItemInfo: + id: GoogleCloudDialogflowV2IntentMessageSelectItemInfo + description: >- + Additional info about the select item for when it is triggered in a + dialog. type: object properties: - warnings: - description: Includes details about skipped documents or any other warnings. + key: + description: >- + Required. A unique key that will be sent back to the agent if this + response is given. + type: string + synonyms: + description: >- + Optional. A list of synonyms that can also be used to trigger this + item in dialog. type: array items: - $ref: '#/components/schemas/GoogleRpcStatus' - GoogleCloudDialogflowV2KnowledgeOperationMetadata: - id: GoogleCloudDialogflowV2KnowledgeOperationMetadata - description: Metadata in google::longrunning::Operation for Knowledge operations. + type: string + GoogleCloudDialogflowV2IntentMessageCarouselSelect: + id: GoogleCloudDialogflowV2IntentMessageCarouselSelect + description: The card for presenting a carousel of options to select from. type: object properties: - state: - description: Output only. The current state of this operation. - readOnly: true - type: string - enumDescriptions: - - State unspecified. - - The operation has been created. - - The operation is currently running. - - The operation is done, either cancelled or completed. - enum: - - STATE_UNSPECIFIED - - PENDING - - RUNNING - - DONE - knowledgeBase: - description: The name of the knowledge base interacted with during the operation. - type: string - exportOperationMetadata: - description: >- - Metadata for the Export Data Operation such as the destination of - export. - $ref: '#/components/schemas/GoogleCloudDialogflowV2ExportOperationMetadata' - GoogleCloudDialogflowV2ExportOperationMetadata: - id: GoogleCloudDialogflowV2ExportOperationMetadata - description: Metadata related to the Export Data Operations (e.g. ExportDocument). + items: + description: Required. Carousel items. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2IntentMessageCarouselSelectItem + GoogleCloudDialogflowV2IntentMessageCarouselSelectItem: + id: GoogleCloudDialogflowV2IntentMessageCarouselSelectItem + description: An item in the carousel. type: object properties: - exportedGcsDestination: - description: Cloud Storage file path of the exported data. - $ref: '#/components/schemas/GoogleCloudDialogflowV2GcsDestination' - GoogleCloudDialogflowV2GcsDestination: - id: GoogleCloudDialogflowV2GcsDestination - description: Google Cloud Storage location for the output. + info: + description: Required. Additional info about the option item. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2IntentMessageSelectItemInfo + title: + description: Required. Title of the carousel item. + type: string + description: + description: Optional. The body text of the card. + type: string + image: + description: Optional. The image to display. + $ref: '#/components/schemas/GoogleCloudDialogflowV2IntentMessageImage' + GoogleCloudDialogflowV2IntentMessageBrowseCarouselCard: + id: GoogleCloudDialogflowV2IntentMessageBrowseCarouselCard + description: >- + Browse Carousel Card for Actions on Google. + https://developers.google.com/actions/assistant/responses#browsing_carousel type: object properties: - uri: + items: description: >- - The Google Cloud Storage URIs for the output. A URI is of the form: - `gs://bucket/object-prefix-or-name` Whether a prefix or name is used - depends on the use case. The requesting user must have - "write-permission" to the bucket. + Required. List of items in the Browse Carousel Card. Minimum of two + items, maximum of ten. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItem + imageDisplayOptions: + description: >- + Optional. Settings for displaying the image. Applies to every image + in items. type: string - GoogleCloudDialogflowV2OriginalDetectIntentRequest: - id: GoogleCloudDialogflowV2OriginalDetectIntentRequest - description: >- - Represents the contents of the original request that was passed to the - `[Streaming]DetectIntent` call. + enumDescriptions: + - >- + Fill the gaps between the image and the image container with gray + bars. + - >- + Fill the gaps between the image and the image container with gray + bars. + - >- + Fill the gaps between the image and the image container with white + bars. + - >- + Image is scaled such that the image width and height match or + exceed the container dimensions. This may crop the top and bottom + of the image if the scaled image height is greater than the + container height, or crop the left and right of the image if the + scaled image width is greater than the container width. This is + similar to "Zoom Mode" on a widescreen TV when playing a 4:3 + video. + - >- + Pad the gaps between image and image frame with a blurred copy of + the same image. + enum: + - IMAGE_DISPLAY_OPTIONS_UNSPECIFIED + - GRAY + - WHITE + - CROPPED + - BLURRED_BACKGROUND + GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItem: + id: >- + GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItem + description: Browsing carousel tile type: object properties: - source: - description: >- - The source of this request, e.g., `google`, `facebook`, `slack`. It - is set by Dialogflow-owned servers. + openUriAction: + description: Required. Action to present to the user. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction + title: + description: Required. Title of the carousel item. Maximum of two lines of text. type: string - version: + description: description: >- - Optional. The version of the protocol used for this request. This - field is AoG-specific. + Optional. Description of the carousel item. Maximum of four lines of + text. type: string - payload: + image: + description: Optional. Hero image for the carousel item. + $ref: '#/components/schemas/GoogleCloudDialogflowV2IntentMessageImage' + footer: description: >- - Optional. This field is set to the value of the - `QueryParameters.payload` field passed in the request. Some - integrations that query a Dialogflow agent may provide additional - information in the payload. In particular, for the Dialogflow Phone - Gateway integration, this field has the form: { "telephony": { - "caller_id": "+18558363987" } } Note: The caller ID field - (`caller_id`) will be redacted for Trial Edition agents and - populated with the caller ID in [E.164 - format](https://en.wikipedia.org/wiki/E.164) for Essentials Edition - agents. - type: object - additionalProperties: - type: any - description: Properties of the object. - GoogleCloudDialogflowV2SetSuggestionFeatureConfigOperationMetadata: - id: GoogleCloudDialogflowV2SetSuggestionFeatureConfigOperationMetadata - description: Metadata for a ConversationProfile.SetSuggestionFeatureConfig operation. + Optional. Text that appears at the bottom of the Browse Carousel + Card. Maximum of one line of text. + type: string + GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction: + id: >- + GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction + description: Actions on Google action to open a given url. type: object properties: - conversationProfile: - description: >- - The resource name of the conversation profile. Format: - `projects//locations//conversationProfiles/` + url: + description: Required. URL type: string - participantRole: + urlTypeHint: description: >- - Required. The participant role to add or update the suggestion - feature config. Only HUMAN_AGENT or END_USER can be used. + Optional. Specifies the type of viewer that is used when opening the + URL. Defaults to opening via web browser. type: string enumDescriptions: - - Participant role not set. - - Participant is a human agent. - - Participant is an automated agent, such as a Dialogflow agent. + - Unspecified + - Url would be an amp action - >- - Participant is an end user that has called or chatted with - Dialogflow services. + URL that points directly to AMP content, or to a canonical URL + which refers to AMP content via . enum: - - ROLE_UNSPECIFIED - - HUMAN_AGENT - - AUTOMATED_AGENT - - END_USER - suggestionFeatureType: - description: Required. The type of the suggestion feature to add or update. + - URL_TYPE_HINT_UNSPECIFIED + - AMP_ACTION + - AMP_CONTENT + GoogleCloudDialogflowV2IntentMessageTableCard: + id: GoogleCloudDialogflowV2IntentMessageTableCard + description: Table card for Actions on Google. + type: object + properties: + title: + description: Required. Title of the card. type: string - enumDescriptions: - - Unspecified feature type. - - Run article suggestion model for chat. - - Run FAQ model for chat. - - Run smart reply model for chat. - - >- - Run knowledge search with text input from agent or text generated - query. - - Run knowledge assist with automatic query generation. - enum: - - TYPE_UNSPECIFIED - - ARTICLE_SUGGESTION - - FAQ - - SMART_REPLY - - KNOWLEDGE_SEARCH - - KNOWLEDGE_ASSIST - createTime: - description: >- - Timestamp whe the request was created. The time is measured on - server side. + subtitle: + description: Optional. Subtitle to the title. type: string - format: google-datetime - GoogleCloudDialogflowV2WebhookRequest: - id: GoogleCloudDialogflowV2WebhookRequest - description: The request message for a webhook call. + image: + description: Optional. Image which should be displayed on the card. + $ref: '#/components/schemas/GoogleCloudDialogflowV2IntentMessageImage' + columnProperties: + description: Optional. Display properties for the columns in this table. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2IntentMessageColumnProperties + rows: + description: Optional. Rows in this table of data. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2IntentMessageTableCardRow + buttons: + description: Optional. List of buttons for the card. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2IntentMessageBasicCardButton + GoogleCloudDialogflowV2IntentMessageColumnProperties: + id: GoogleCloudDialogflowV2IntentMessageColumnProperties + description: Column properties for TableCard. type: object properties: - session: - description: >- - The unique identifier of detectIntent request session. Can be used - to identify end-user inside webhook implementation. Format: - `projects//agent/sessions/`, or - `projects//agent/environments//users//sessions/`. + header: + description: Required. Column heading. type: string - responseId: - description: >- - The unique identifier of the response. Contains the same value as - `[Streaming]DetectIntentResponse.response_id`. + horizontalAlignment: + description: Optional. Defines text alignment for all cells in this column. type: string - queryResult: - description: >- - The result of the conversational query or event processing. Contains - the same value as `[Streaming]DetectIntentResponse.query_result`. - $ref: '#/components/schemas/GoogleCloudDialogflowV2QueryResult' - originalDetectIntentRequest: - description: >- - Optional. The contents of the original request that was passed to - `[Streaming]DetectIntent` call. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2OriginalDetectIntentRequest - GoogleCloudDialogflowV2QueryResult: - id: GoogleCloudDialogflowV2QueryResult - description: Represents the result of conversational query or event processing. + enumDescriptions: + - Text is aligned to the leading edge of the column. + - Text is aligned to the leading edge of the column. + - Text is centered in the column. + - Text is aligned to the trailing edge of the column. + enum: + - HORIZONTAL_ALIGNMENT_UNSPECIFIED + - LEADING + - CENTER + - TRAILING + GoogleCloudDialogflowV2IntentMessageTableCardRow: + id: GoogleCloudDialogflowV2IntentMessageTableCardRow + description: Row of TableCard. type: object properties: - queryText: - description: >- - The original conversational query text: - If natural language text - was provided as input, `query_text` contains a copy of the input. - - If natural language speech audio was provided as input, `query_text` - contains the speech recognition result. If speech recognizer - produced multiple alternatives, a particular one is picked. - If - automatic spell correction is enabled, `query_text` will contain the - corrected user input. - type: string - languageCode: - description: >- - The language that was triggered during intent detection. See - [Language - Support](https://cloud.google.com/dialogflow/docs/reference/language) - for a list of the currently supported language codes. - type: string - speechRecognitionConfidence: - description: >- - The Speech recognition confidence between 0.0 and 1.0. A higher - number indicates an estimated greater likelihood that the recognized - words are correct. The default of 0.0 is a sentinel value indicating - that confidence was not set. This field is not guaranteed to be - accurate or set. In particular this field isn't set for - StreamingDetectIntent since the streaming endpoint has separate - confidence estimates per portion of the audio in - StreamingRecognitionResult. - type: number - format: float - action: - description: The action name from the matched intent. - type: string - parameters: - description: >- - The collection of extracted parameters. Depending on your protocol - or client library language, this is a map, associative array, symbol - table, dictionary, or JSON object composed of a collection of - (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: - parameter name * MapValue type: If parameter's entity type is a - composite entity then use map, otherwise, depending on the parameter - value type, it could be one of string, number, boolean, null, list - or map. * MapValue value: If parameter's entity type is a composite - entity then use map from composite entity property names to property - values, otherwise, use parameter value. - type: object - additionalProperties: - type: any - description: Properties of the object. - allRequiredParamsPresent: - description: >- - This field is set to: - `false` if the matched intent has required - parameters and not all of the required parameter values have been - collected. - `true` if all required parameter values have been - collected, or if the matched intent doesn't contain any required - parameters. - type: boolean - cancelsSlotFilling: - description: >- - Indicates whether the conversational query triggers a cancellation - for slot filling. For more information, see the [cancel slot filling - documentation](https://cloud.google.com/dialogflow/es/docs/intents-actions-parameters#cancel). - type: boolean - fulfillmentText: - description: >- - The text to be pronounced to the user or shown on the screen. Note: - This is a legacy field, `fulfillment_messages` should be preferred. - type: string - fulfillmentMessages: - description: The collection of rich messages to present to the user. + cells: + description: Optional. List of cells that make up this row. type: array items: - $ref: '#/components/schemas/GoogleCloudDialogflowV2IntentMessage' - webhookSource: - description: >- - If the query was fulfilled by a webhook call, this field is set to - the value of the `source` field returned in the webhook response. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2IntentMessageTableCardCell + dividerAfter: + description: Optional. Whether to add a visual divider after this row. + type: boolean + GoogleCloudDialogflowV2IntentMessageTableCardCell: + id: GoogleCloudDialogflowV2IntentMessageTableCardCell + description: Cell of TableCardRow. + type: object + properties: + text: + description: Required. Text in this cell. type: string - webhookPayload: - description: >- - If the query was fulfilled by a webhook call, this field is set to - the value of the `payload` field returned in the webhook response. - type: object - additionalProperties: - type: any - description: Properties of the object. - outputContexts: - description: >- - The collection of output contexts. If applicable, - `output_contexts.parameters` contains entries with name `.original` - containing the original parameter values before the query. + GoogleCloudDialogflowV2IntentMessageMediaContent: + id: GoogleCloudDialogflowV2IntentMessageMediaContent + description: The media content card for Actions on Google. + type: object + properties: + mediaType: + description: Optional. What type of media is the content (ie "audio"). + type: string + enumDescriptions: + - Unspecified. + - Response media type is audio. + enum: + - RESPONSE_MEDIA_TYPE_UNSPECIFIED + - AUDIO + mediaObjects: + description: Required. List of media objects. type: array items: - $ref: '#/components/schemas/GoogleCloudDialogflowV2Context' - intent: - description: >- - The intent that matched the conversational query. Some, not all - fields are filled in this message, including but not limited to: - `name`, `display_name`, `end_interaction` and `is_fallback`. - $ref: '#/components/schemas/GoogleCloudDialogflowV2Intent' - intentDetectionConfidence: - description: >- - The intent detection confidence. Values range from 0.0 (completely - uncertain) to 1.0 (completely certain). This value is for - informational purpose only and is only used to help match the best - intent within the classification threshold. This value may change - for the same end-user expression at any time due to a model - retraining or change in implementation. If there are `multiple - knowledge_answers` messages, this value is set to the greatest - `knowledgeAnswers.match_confidence` value in the list. - type: number - format: float - diagnosticInfo: + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2IntentMessageMediaContentResponseMediaObject + GoogleCloudDialogflowV2IntentMessageMediaContentResponseMediaObject: + id: GoogleCloudDialogflowV2IntentMessageMediaContentResponseMediaObject + description: Response media object for media content card. + type: object + properties: + name: + description: Required. Name of media card. + type: string + description: + description: Optional. Description of media card. + type: string + largeImage: + description: Optional. Image to display above media content. + $ref: '#/components/schemas/GoogleCloudDialogflowV2IntentMessageImage' + icon: + description: Optional. Icon to display above media content. + $ref: '#/components/schemas/GoogleCloudDialogflowV2IntentMessageImage' + contentUrl: + description: Required. Url where the media is stored. + type: string + GoogleCloudDialogflowV2IntentFollowupIntentInfo: + id: GoogleCloudDialogflowV2IntentFollowupIntentInfo + description: Represents a single followup intent in the chain. + type: object + properties: + followupIntentName: description: >- - Free-form diagnostic information for the associated detect intent - request. The fields of this data can change without notice, so you - should not write code that depends on its structure. The data may - contain: - webhook call latency - webhook errors - type: object - additionalProperties: - type: any - description: Properties of the object. - sentimentAnalysisResult: + The unique identifier of the followup intent. Format: + `projects//agent/intents/`. + type: string + parentFollowupIntentName: description: >- - The sentiment analysis result, which depends on the - `sentiment_analysis_request_config` specified in the request. - $ref: '#/components/schemas/GoogleCloudDialogflowV2SentimentAnalysisResult' - GoogleCloudDialogflowV2WebhookResponse: - id: GoogleCloudDialogflowV2WebhookResponse + The unique identifier of the followup intent's parent. Format: + `projects//agent/intents/`. + type: string + GoogleCloudDialogflowV2ClearSuggestionFeatureConfigOperationMetadata: + id: GoogleCloudDialogflowV2ClearSuggestionFeatureConfigOperationMetadata description: >- - The response message for a webhook call. This response is validated by - the Dialogflow server. If validation fails, an error will be returned in - the QueryResult.diagnostic_info field. Setting JSON fields to an empty - value with the wrong type is a common error. To avoid this error: - Use - `""` for empty strings - Use `{}` or `null` for empty objects - Use `[]` - or `null` for empty arrays For more information, see the [Protocol - Buffers Language - Guide](https://developers.google.com/protocol-buffers/docs/proto3#json). + Metadata for a ConversationProfiles.ClearSuggestionFeatureConfig + operation. type: object properties: - fulfillmentText: + conversationProfile: description: >- - Optional. The text response message intended for the end-user. It is - recommended to use `fulfillment_messages.text.text[0]` instead. When - provided, Dialogflow uses this field to populate - QueryResult.fulfillment_text sent to the integration or API caller. + The resource name of the conversation profile. Format: + `projects//locations//conversationProfiles/` type: string - fulfillmentMessages: - description: >- - Optional. The rich response messages intended for the end-user. When - provided, Dialogflow uses this field to populate - QueryResult.fulfillment_messages sent to the integration or API - caller. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDialogflowV2IntentMessage' - source: + participantRole: description: >- - Optional. A custom field used to identify the webhook source. - Arbitrary strings are supported. When provided, Dialogflow uses this - field to populate QueryResult.webhook_source sent to the integration - or API caller. + Required. The participant role to remove the suggestion feature + config. Only HUMAN_AGENT or END_USER can be used. type: string - payload: - description: >- - Optional. This field can be used to pass custom data from your - webhook to the integration or API caller. Arbitrary JSON objects are - supported. When provided, Dialogflow uses this field to populate - QueryResult.webhook_payload sent to the integration or API caller. - This field is also used by the [Google Assistant - integration](https://cloud.google.com/dialogflow/docs/integrations/aog) - for rich response messages. See the format definition at [Google - Assistant Dialogflow webhook - format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json) - type: object - additionalProperties: - type: any - description: Properties of the object. - outputContexts: - description: >- - Optional. The collection of output contexts that will overwrite - currently active contexts for the session and reset their lifespans. - When provided, Dialogflow uses this field to populate - QueryResult.output_contexts sent to the integration or API caller. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDialogflowV2Context' - followupEventInput: - description: >- - Optional. Invokes the supplied events. When this field is set, - Dialogflow ignores the `fulfillment_text`, `fulfillment_messages`, - and `payload` fields. - $ref: '#/components/schemas/GoogleCloudDialogflowV2EventInput' - sessionEntityTypes: - description: >- - Optional. Additional session entity types to replace or extend - developer entity types with. The entity synonyms apply to all - languages and persist for the session. Setting this data from a - webhook overwrites the session entity types that have been set using - `detectIntent`, `streamingDetectIntent` or SessionEntityType - management methods. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDialogflowV2SessionEntityType' - GoogleCloudDialogflowV2EventInput: - id: GoogleCloudDialogflowV2EventInput - description: >- - Events allow for matching intents by event name instead of the natural - language input. For instance, input `` can trigger a personalized - welcome response. The parameter `name` may be used by the agent in the - response: `"Hello #welcome_event.name! What can I do for you today?"`. - type: object - properties: - name: - description: Required. The unique identifier of the event. + enumDescriptions: + - Participant role not set. + - Participant is a human agent. + - Participant is an automated agent, such as a Dialogflow agent. + - >- + Participant is an end user that has called or chatted with + Dialogflow services. + enum: + - ROLE_UNSPECIFIED + - HUMAN_AGENT + - AUTOMATED_AGENT + - END_USER + suggestionFeatureType: + description: Required. The type of the suggestion feature to remove. type: string - parameters: - description: >- - The collection of parameters associated with the event. Depending on - your protocol or client library language, this is a map, associative - array, symbol table, dictionary, or JSON object composed of a - collection of (MapKey, MapValue) pairs: * MapKey type: string * - MapKey value: parameter name * MapValue type: If parameter's entity - type is a composite entity then use map, otherwise, depending on the - parameter value type, it could be one of string, number, boolean, - null, list or map. * MapValue value: If parameter's entity type is a - composite entity then use map from composite entity property names - to property values, otherwise, use parameter value. - type: object - additionalProperties: - type: any - description: Properties of the object. - languageCode: + enumDescriptions: + - Unspecified feature type. + - Run article suggestion model for chat. + - Run FAQ model for chat. + - Run smart reply model for chat. + - Run conversation summarization model for chat. + - >- + Run knowledge search with text input from agent or text generated + query. + - Run knowledge assist with automatic query generation. + enum: + - TYPE_UNSPECIFIED + - ARTICLE_SUGGESTION + - FAQ + - SMART_REPLY + - CONVERSATION_SUMMARIZATION + - KNOWLEDGE_SEARCH + - KNOWLEDGE_ASSIST + createTime: description: >- - Required. The language of this query. See [Language - Support](https://cloud.google.com/dialogflow/docs/reference/language) - for a list of the currently supported language codes. Note that - queries in the same session do not necessarily need to specify the - same language. This field is ignored when used in the context of a - WebhookResponse.followup_event_input field, because the language was - already defined in the originating detect intent request. + Timestamp whe the request was created. The time is measured on + server side. type: string - GoogleCloudDialogflowV2SessionEntityType: - id: GoogleCloudDialogflowV2SessionEntityType + format: google-datetime + GoogleCloudDialogflowV2ConversationEvent: + id: GoogleCloudDialogflowV2ConversationEvent description: >- - A session represents a conversation between a Dialogflow agent and an - end-user. You can create special entities, called session entities, - during a session. Session entities can extend or replace custom entity - types and only exist during the session that they were created for. All - session data, including session entities, is stored by Dialogflow for 20 - minutes. For more information, see the [session entity - guide](https://cloud.google.com/dialogflow/docs/entities-session). + Represents a notification sent to Pub/Sub subscribers for conversation + lifecycle events. type: object properties: - name: + conversation: description: >- - Required. The unique identifier of this session entity type. Format: - `projects//agent/sessions//entityTypes/`, or - `projects//agent/environments//users//sessions//entityTypes/`. If - `Environment ID` is not specified, we assume default 'draft' - environment. If `User ID` is not specified, we assume default '-' - user. `` must be the display name of an existing entity type in the - same agent that will be overridden or supplemented. + The unique identifier of the conversation this notification refers + to. Format: `projects//conversations/`. type: string - entityOverrideMode: - description: >- - Required. Indicates whether the additional data should override or - supplement the custom entity type definition. + type: + description: The type of the event that this notification refers to. type: string enumDescriptions: - - Not specified. This value should be never used. + - Type not set. - >- - The collection of session entities overrides the collection of - entities in the corresponding custom entity type. + A new conversation has been opened. This is fired when a telephone + call is answered, or a conversation is created via the API. - >- - The collection of session entities extends the collection of - entities in the corresponding custom entity type. Note: Even in - this override mode calls to `ListSessionEntityTypes`, - `GetSessionEntityType`, `CreateSessionEntityType` and - `UpdateSessionEntityType` only return the additional entities - added in this session entity type. If you want to get the - supplemented list, please call EntityTypes.GetEntityType on the - custom entity type and merge. + An existing conversation has closed. This is fired when a + telephone call is terminated, or a conversation is closed via the + API. + - >- + An existing conversation has received notification from Dialogflow + that human intervention is required. + - >- + An existing conversation has received a new message, either from + API or telephony. It is configured in + ConversationProfile.new_message_event_notification_config + - >- + An existing conversation has received a new speech recognition + result. This is mainly for delivering intermediate transcripts. + The notification is configured in + ConversationProfile.new_recognition_event_notification_config. + - >- + Unrecoverable error during a telephone call. In general + non-recoverable errors only occur if something was misconfigured + in the ConversationProfile corresponding to the call. After a + non-recoverable error, Dialogflow may stop responding. We don't + fire this event: * in an API call because we can directly return + the error, or, * when we can recover from an error. enum: - - ENTITY_OVERRIDE_MODE_UNSPECIFIED - - ENTITY_OVERRIDE_MODE_OVERRIDE - - ENTITY_OVERRIDE_MODE_SUPPLEMENT - entities: + - TYPE_UNSPECIFIED + - CONVERSATION_STARTED + - CONVERSATION_FINISHED + - HUMAN_INTERVENTION_NEEDED + - NEW_MESSAGE + - NEW_RECOGNITION_RESULT + - UNRECOVERABLE_ERROR + errorStatus: description: >- - Required. The collection of entities associated with this session - entity type. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDialogflowV2EntityTypeEntity' - GoogleCloudDialogflowV2DeleteConversationDatasetOperationMetadata: - id: GoogleCloudDialogflowV2DeleteConversationDatasetOperationMetadata - description: Metadata for ConversationDatasets. - type: object - properties: {} - GoogleCloudDialogflowV2ImportConversationDataOperationResponse: - id: GoogleCloudDialogflowV2ImportConversationDataOperationResponse - description: >- - Response used for ConversationDatasets.ImportConversationData long - running operation. + More detailed information about an error. Only set for type + UNRECOVERABLE_ERROR_IN_PHONE_CALL. + $ref: '#/components/schemas/GoogleRpcStatus' + newMessagePayload: + description: Payload of NEW_MESSAGE event. + $ref: '#/components/schemas/GoogleCloudDialogflowV2Message' + newRecognitionResultPayload: + description: Payload of NEW_RECOGNITION_RESULT event. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2StreamingRecognitionResult + GoogleCloudDialogflowV2Message: + id: GoogleCloudDialogflowV2Message + description: Represents a message posted into a conversation. type: object properties: - conversationDataset: + name: description: >- - The resource name of the imported conversation dataset. Format: - `projects//locations//conversationDatasets/` + Optional. The unique identifier of the message. Format: + `projects//locations//conversations//messages/`. type: string - importCount: - description: Number of conversations imported successfully. - type: integer - format: int32 - GoogleCloudDialogflowV2ImportConversationDataOperationMetadata: - id: GoogleCloudDialogflowV2ImportConversationDataOperationMetadata - description: Metadata for a ConversationDatasets.ImportConversationData operation. - type: object - properties: - conversationDataset: - description: >- - The resource name of the imported conversation dataset. Format: - `projects//locations//conversationDatasets/` + content: + description: Required. The message content. type: string - partialFailures: + languageCode: description: >- - Partial failures are failures that don't fail the whole long running - operation, e.g. single files that couldn't be read. - type: array - items: - $ref: '#/components/schemas/GoogleRpcStatus' + Optional. The message language. This should be a + [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. + Example: "en-US". + type: string + participant: + description: Output only. The participant that sends this message. + readOnly: true + type: string + participantRole: + description: Output only. The role of the participant. + readOnly: true + type: string + enumDescriptions: + - Participant role not set. + - Participant is a human agent. + - Participant is an automated agent, such as a Dialogflow agent. + - >- + Participant is an end user that has called or chatted with + Dialogflow services. + enum: + - ROLE_UNSPECIFIED + - HUMAN_AGENT + - AUTOMATED_AGENT + - END_USER createTime: description: >- - Timestamp when import conversation data request was created. The - time is measured on server side. + Output only. The time when the message was created in Contact Center + AI. + readOnly: true type: string format: google-datetime - GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata: - id: GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata - description: Metadata for initializing a location-level encryption specification. - type: object - properties: - request: - description: Output only. The original request for initialization. + sendTime: + description: >- + Optional. The time when the message was sent. For voice messages, + this is the time when an utterance started. + type: string + format: google-datetime + messageAnnotation: + description: Output only. The annotation for the message. readOnly: true - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2InitializeEncryptionSpecRequest - GoogleCloudDialogflowV2InitializeEncryptionSpecRequest: - id: GoogleCloudDialogflowV2InitializeEncryptionSpecRequest - description: The request to initialize a location-level encryption specification. + $ref: '#/components/schemas/GoogleCloudDialogflowV2MessageAnnotation' + sentimentAnalysis: + description: Output only. The sentiment analysis result for the message. + readOnly: true + $ref: '#/components/schemas/GoogleCloudDialogflowV2SentimentAnalysisResult' + GoogleCloudDialogflowV2MessageAnnotation: + id: GoogleCloudDialogflowV2MessageAnnotation + description: Represents the result of annotation for the message. type: object properties: - encryptionSpec: + parts: description: >- - Required. The encryption spec used for CMEK encryption. It is - required that the kms key is in the same region as the endpoint. The - same key will be used for all provisioned resources, if encryption - is available. If the kms_key_name is left empty, no encryption will - be enforced. - $ref: '#/components/schemas/GoogleCloudDialogflowV2EncryptionSpec' - GoogleCloudDialogflowV2EncryptionSpec: - id: GoogleCloudDialogflowV2EncryptionSpec + The collection of annotated message parts ordered by their position + in the message. You can recover the annotated message by + concatenating [AnnotatedMessagePart.text]. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowV2AnnotatedMessagePart' + containEntities: + description: Indicates whether the text message contains entities. + type: boolean + GoogleCloudDialogflowV2AnnotatedMessagePart: + id: GoogleCloudDialogflowV2AnnotatedMessagePart description: >- - A customer-managed encryption key specification that can be applied to - all created resources (e.g. Conversation). + Represents a part of a message possibly annotated with an entity. The + part can be an entity or purely a part of the message between two + entities or message start/end. type: object properties: - name: - description: >- - Immutable. The resource name of the encryption key specification - resource. Format: - projects/{project}/locations/{location}/encryptionSpec + text: + description: A part of a message possibly annotated with an entity. type: string - kmsKey: + entityType: description: >- - Required. The name of customer-managed encryption key that is used - to secure a resource and its sub-resources. If empty, the resource - is secured by the default Google encryption key. Only the key in the - same location as this resource is allowed to be used for encryption. - Format: - `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}` + The [Dialogflow system entity + type](https://cloud.google.com/dialogflow/docs/reference/system-entities) + of this message part. If this is empty, Dialogflow could not + annotate the phrase part with a system entity. type: string - GoogleCloudDialogflowV2CreateConversationDatasetOperationMetadata: - id: GoogleCloudDialogflowV2CreateConversationDatasetOperationMetadata - description: Metadata for ConversationDatasets. + formattedValue: + description: >- + The [Dialogflow system entity formatted value + ](https://cloud.google.com/dialogflow/docs/reference/system-entities) + of this message part. For example for a system entity of type + `@sys.unit-currency`, this may contain: { "amount": 5, "currency": + "USD" } + type: any + GoogleCloudDialogflowV2SentimentAnalysisResult: + id: GoogleCloudDialogflowV2SentimentAnalysisResult + description: >- + The result of sentiment analysis. Sentiment analysis inspects user input + and identifies the prevailing subjective opinion, especially to + determine a user's attitude as positive, negative, or neutral. For + DetectIntent, it needs to be configured in + DetectIntentRequest.query_params. For StreamingDetectIntent, it needs to + be configured in StreamingDetectIntentRequest.query_params. And for + Participants.AnalyzeContent and Participants.StreamingAnalyzeContent, it + needs to be configured in + ConversationProfile.human_agent_assistant_config type: object properties: - conversationDataset: - description: >- - The resource name of the conversation dataset that will be created. - Format: `projects//locations//conversationDatasets/` - type: string - GoogleCloudDialogflowV2ConversationModel: - id: GoogleCloudDialogflowV2ConversationModel - description: Represents a conversation model. + queryTextSentiment: + description: The sentiment analysis result for `query_text`. + $ref: '#/components/schemas/GoogleCloudDialogflowV2Sentiment' + GoogleCloudDialogflowV2Sentiment: + id: GoogleCloudDialogflowV2Sentiment + description: >- + The sentiment, such as positive/negative feeling or association, for a + unit of analysis, such as the query text. See: + https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values + for how to interpret the result. type: object properties: - name: + score: description: >- - ConversationModel resource name. Format: - `projects//conversationModels/` - type: string - displayName: - description: Required. The display name of the model. At most 64 bytes long. - type: string - createTime: - description: Output only. Creation time of this model. - readOnly: true - type: string - format: google-datetime - datasets: - description: Required. Datasets used to create model. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDialogflowV2InputDataset' - state: + Sentiment score between -1.0 (negative sentiment) and 1.0 (positive + sentiment). + type: number + format: float + magnitude: description: >- - Output only. State of the model. A model can only serve prediction - requests after it gets deployed. - readOnly: true + A non-negative number in the [0, +inf) range, which represents the + absolute magnitude of sentiment, regardless of score (positive or + negative). + type: number + format: float + GoogleCloudDialogflowV2StreamingRecognitionResult: + id: GoogleCloudDialogflowV2StreamingRecognitionResult + description: >- + Contains a speech recognition result corresponding to a portion of the + audio that is currently being processed or an indication that this is + the end of the single requested utterance. While end-user audio is being + processed, Dialogflow sends a series of results. Each result may contain + a `transcript` value. A transcript represents a portion of the + utterance. While the recognizer is processing audio, transcript values + may be interim values or finalized values. Once a transcript is + finalized, the `is_final` value is set to true and processing continues + for the next transcript. If + `StreamingDetectIntentRequest.query_input.audio_config.single_utterance` + was true, and the recognizer has completed processing audio, the + `message_type` value is set to `END_OF_SINGLE_UTTERANCE and the + following (last) result contains the last finalized transcript. The + complete end-user utterance is determined by concatenating the finalized + transcript values received for the series of results. In the following + example, single utterance is enabled. In the case where single utterance + is not enabled, result 7 would not occur. ``` Num | transcript | + message_type | is_final --- | ----------------------- | + ----------------------- | -------- 1 | "tube" | TRANSCRIPT | false 2 | + "to be a" | TRANSCRIPT | false 3 | "to be" | TRANSCRIPT | false 4 | "to + be or not to be" | TRANSCRIPT | true 5 | "that's" | TRANSCRIPT | false 6 + | "that is | TRANSCRIPT | false 7 | unset | END_OF_SINGLE_UTTERANCE | + unset 8 | " that is the question" | TRANSCRIPT | true ``` Concatenating + the finalized transcripts with `is_final` set to true, the complete + utterance becomes "to be or not to be that is the question". + type: object + properties: + messageType: + description: Type of the result message. type: string enumDescriptions: - - Should not be used, an un-set enum has this value by default. - - Model being created. - - Model is not deployed but ready to deploy. - - Model is deploying. - - Model is deployed and ready to use. - - Model is undeploying. - - Model is deleting. - - Model is in error state. Not ready to deploy and use. + - Not specified. Should never be used. + - Message contains a (possibly partial) transcript. - >- - Model is being created but the training has not started, The model - may remain in this state until there is enough capacity to start - training. + This event indicates that the server has detected the end of the + user's speech utterance and expects no additional inputs. + Therefore, the server will not process additional audio (although + it may subsequently return additional results). The client should + stop sending additional audio data, half-close the gRPC + connection, and wait for any additional results until the server + closes the gRPC connection. This message is only sent if + `single_utterance` was set to `true`, and is not used otherwise. enum: - - STATE_UNSPECIFIED - - CREATING - - UNDEPLOYED - - DEPLOYING - - DEPLOYED - - UNDEPLOYING - - DELETING - - FAILED - - PENDING - languageCode: + - MESSAGE_TYPE_UNSPECIFIED + - TRANSCRIPT + - END_OF_SINGLE_UTTERANCE + transcript: description: >- - Language code for the conversation model. If not specified, the - language is en-US. Language at ConversationModel should be set for - all non en-us languages. This should be a - [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. - Example: "en-US". + Transcript text representing the words that the user spoke. + Populated if and only if `message_type` = `TRANSCRIPT`. type: string - articleSuggestionModelMetadata: - description: Metadata for article suggestion models. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2ArticleSuggestionModelMetadata - smartReplyModelMetadata: - description: Metadata for smart reply models. - $ref: '#/components/schemas/GoogleCloudDialogflowV2SmartReplyModelMetadata' - satisfiesPzs: + isFinal: description: >- - Output only. A read only boolean field reflecting Zone Separation - status of the model. - readOnly: true + If `false`, the `StreamingRecognitionResult` represents an interim + result that may change. If `true`, the recognizer will not return + any further hypotheses about this piece of the audio. May only be + populated for `message_type` = `TRANSCRIPT`. type: boolean - satisfiesPzi: + confidence: description: >- - Output only. A read only boolean field reflecting Zone Isolation - status of the model. - readOnly: true - type: boolean - GoogleCloudDialogflowV2InputDataset: - id: GoogleCloudDialogflowV2InputDataset - description: InputDataset used to create model or do evaluation. NextID:5 - type: object - properties: - dataset: + The Speech confidence between 0.0 and 1.0 for the current portion of + audio. A higher number indicates an estimated greater likelihood + that the recognized words are correct. The default of 0.0 is a + sentinel value indicating that confidence was not set. This field is + typically only provided if `is_final` is true and you should not + rely on it being accurate or even set. + type: number + format: float + speechWordInfo: description: >- - Required. ConversationDataset resource name. Format: - `projects//locations//conversationDatasets/` + Word-specific information for the words recognized by Speech in + transcript. Populated if and only if `message_type` = `TRANSCRIPT` + and [InputAudioConfig.enable_word_info] is set. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowV2SpeechWordInfo' + speechEndOffset: + description: >- + Time offset of the end of this Speech recognition result relative to + the beginning of the audio. Only populated for `message_type` = + `TRANSCRIPT`. type: string - GoogleCloudDialogflowV2ArticleSuggestionModelMetadata: - id: GoogleCloudDialogflowV2ArticleSuggestionModelMetadata - description: Metadata for article suggestion models. + format: google-duration + languageCode: + description: Detected language code for the transcript. + type: string + GoogleCloudDialogflowV2SpeechWordInfo: + id: GoogleCloudDialogflowV2SpeechWordInfo + description: Information for a word recognized by the speech recognizer. type: object properties: - trainingModelType: + word: + description: The word this info is for. + type: string + startOffset: description: >- - Optional. Type of the article suggestion model. If not provided, - model_type is used. + Time offset relative to the beginning of the audio that corresponds + to the start of the spoken word. This is an experimental feature and + the accuracy of the time offset can vary. type: string - enumDescriptions: - - ModelType unspecified. - - ModelType smart reply dual encoder model. - - ModelType smart reply bert model. - enum: - - MODEL_TYPE_UNSPECIFIED - - SMART_REPLY_DUAL_ENCODER_MODEL - - SMART_REPLY_BERT_MODEL - GoogleCloudDialogflowV2SmartReplyModelMetadata: - id: GoogleCloudDialogflowV2SmartReplyModelMetadata - description: Metadata for smart reply models. - type: object - properties: - trainingModelType: + format: google-duration + endOffset: description: >- - Optional. Type of the smart reply model. If not provided, model_type - is used. + Time offset relative to the beginning of the audio that corresponds + to the end of the spoken word. This is an experimental feature and + the accuracy of the time offset can vary. type: string - enumDescriptions: - - ModelType unspecified. - - ModelType smart reply dual encoder model. - - ModelType smart reply bert model. - enum: - - MODEL_TYPE_UNSPECIFIED - - SMART_REPLY_DUAL_ENCODER_MODEL - - SMART_REPLY_BERT_MODEL - GoogleCloudDialogflowV2CreateConversationModelOperationMetadata: - id: GoogleCloudDialogflowV2CreateConversationModelOperationMetadata - description: Metadata for a ConversationModels.CreateConversationModel operation. + format: google-duration + confidence: + description: >- + The Speech confidence between 0.0 and 1.0 for this word. A higher + number indicates an estimated greater likelihood that the recognized + word is correct. The default of 0.0 is a sentinel value indicating + that confidence was not set. This field is not guaranteed to be + fully stable over time for the same audio input. Users should also + not rely on it to always be provided. + type: number + format: float + GoogleCloudDialogflowV2ExportAgentResponse: + id: GoogleCloudDialogflowV2ExportAgentResponse + description: The response message for Agents.ExportAgent. type: object properties: - conversationModel: + agentUri: description: >- - The resource name of the conversation model. Format: - `projects//conversationModels/` - type: string - state: - description: State of CreateConversationModel operation. + The URI to a file containing the exported agent. This field is + populated only if `agent_uri` is specified in `ExportAgentRequest`. type: string - enumDescriptions: - - Invalid. - - >- - Request is submitted, but training has not started yet. The model - may remain in this state until there is enough capacity to start - training. - - The training has succeeded. - - The training has succeeded. - - The training has been cancelled. - - The training is in cancelling state. - - Custom model is training. - enum: - - STATE_UNSPECIFIED - - PENDING - - SUCCEEDED - - FAILED - - CANCELLED - - CANCELLING - - TRAINING - createTime: - description: >- - Timestamp when the request to create conversation model is - submitted. The time is measured on server side. + agentContent: + description: Zip compressed raw byte content for agent. type: string - format: google-datetime - GoogleCloudDialogflowV2DeleteConversationModelOperationMetadata: - id: GoogleCloudDialogflowV2DeleteConversationModelOperationMetadata - description: Metadata for a ConversationModels.DeleteConversationModel operation. + format: byte + GoogleCloudDialogflowV2HumanAgentAssistantEvent: + id: GoogleCloudDialogflowV2HumanAgentAssistantEvent + description: >- + Represents a notification sent to Cloud Pub/Sub subscribers for human + agent assistant events in a specific conversation. type: object properties: - conversationModel: + conversation: description: >- - The resource name of the conversation model. Format: - `projects//conversationModels/` + The conversation this notification refers to. Format: + `projects//conversations/`. type: string - createTime: + participant: description: >- - Timestamp when delete conversation model request was created. The - time is measured on server side. + The participant that the suggestion is compiled for. Format: + `projects//conversations//participants/`. It will not be set in + legacy workflow. type: string - format: google-datetime - GoogleCloudDialogflowV2DeployConversationModelOperationMetadata: - id: GoogleCloudDialogflowV2DeployConversationModelOperationMetadata - description: Metadata for a ConversationModels.DeployConversationModel operation. + suggestionResults: + description: The suggestion results payload that this notification refers to. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowV2SuggestionResult' + GoogleCloudDialogflowV2SuggestionResult: + id: GoogleCloudDialogflowV2SuggestionResult + description: >- + One response of different type of suggestion response which is used in + the response of Participants.AnalyzeContent and + Participants.AnalyzeContent, as well as HumanAgentAssistantEvent. type: object properties: - conversationModel: + error: + description: Error status if the request failed. + $ref: '#/components/schemas/GoogleRpcStatus' + suggestArticlesResponse: + description: SuggestArticlesResponse if request is for ARTICLE_SUGGESTION. + $ref: '#/components/schemas/GoogleCloudDialogflowV2SuggestArticlesResponse' + suggestKnowledgeAssistResponse: + description: SuggestKnowledgeAssistResponse if request is for KNOWLEDGE_ASSIST. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2SuggestKnowledgeAssistResponse + suggestFaqAnswersResponse: + description: SuggestFaqAnswersResponse if request is for FAQ_ANSWER. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2SuggestFaqAnswersResponse + suggestSmartRepliesResponse: + description: SuggestSmartRepliesResponse if request is for SMART_REPLY. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2SuggestSmartRepliesResponse + generateSuggestionsResponse: description: >- - The resource name of the conversation model. Format: - `projects//conversationModels/` - type: string - createTime: + Suggestions generated using generators triggered by customer or + agent messages. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2GenerateSuggestionsResponse + GoogleCloudDialogflowV2SuggestArticlesResponse: + id: GoogleCloudDialogflowV2SuggestArticlesResponse + description: The response message for Participants.SuggestArticles. + type: object + properties: + articleAnswers: + description: Articles ordered by score in descending order. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowV2ArticleAnswer' + latestMessage: description: >- - Timestamp when request to deploy conversation model was submitted. - The time is measured on server side. + The name of the latest conversation message used to compile + suggestion for. Format: + `projects//locations//conversations//messages/`. type: string - format: google-datetime - GoogleCloudDialogflowV2UndeployConversationModelOperationMetadata: - id: GoogleCloudDialogflowV2UndeployConversationModelOperationMetadata - description: Metadata for a ConversationModels.UndeployConversationModel operation. + contextSize: + description: >- + Number of messages prior to and including latest_message to compile + the suggestion. It may be smaller than the + SuggestArticlesRequest.context_size field in the request if there + aren't that many messages in the conversation. + type: integer + format: int32 + GoogleCloudDialogflowV2ArticleAnswer: + id: GoogleCloudDialogflowV2ArticleAnswer + description: Represents article answer. type: object properties: - conversationModel: - description: >- - The resource name of the conversation model. Format: - `projects//conversationModels/` + title: + description: The article title. type: string - createTime: + uri: + description: The article URI. + type: string + snippets: + description: Article snippets. + type: array + items: + type: string + confidence: description: >- - Timestamp when the request to undeploy conversation model was - submitted. The time is measured on server side. + Article match confidence. The system's confidence score that this + article is a good match for this conversation, as a value from 0.0 + (completely uncertain) to 1.0 (completely certain). + type: number + format: float + metadata: + description: >- + A map that contains metadata about the answer and the document from + which it originates. + type: object + additionalProperties: + type: string + answerRecord: + description: >- + The name of answer record, in the format of + "projects//locations//answerRecords/" type: string - format: google-datetime - GoogleCloudDialogflowV2CreateConversationModelEvaluationOperationMetadata: - id: >- - GoogleCloudDialogflowV2CreateConversationModelEvaluationOperationMetadata - description: >- - Metadata for a ConversationModels.CreateConversationModelEvaluation - operation. + GoogleCloudDialogflowV2SuggestKnowledgeAssistResponse: + id: GoogleCloudDialogflowV2SuggestKnowledgeAssistResponse + description: The response message for Participants.SuggestKnowledgeAssist. type: object properties: - conversationModelEvaluation: + knowledgeAssistAnswer: + description: Output only. Knowledge Assist suggestion. + readOnly: true + $ref: '#/components/schemas/GoogleCloudDialogflowV2KnowledgeAssistAnswer' + latestMessage: description: >- - The resource name of the conversation model. Format: - `projects//locations//conversationModels//evaluations/` + The name of the latest conversation message used to compile + suggestion for. Format: + `projects//locations//conversations//messages/`. type: string - conversationModel: + contextSize: description: >- - The resource name of the conversation model. Format: - `projects//locations//conversationModels/` - type: string - state: - description: State of CreateConversationModel operation. - type: string - enumDescriptions: - - Operation status not specified. - - The operation is being prepared. - - The operation is running. - - The operation is cancelled. - - The operation has succeeded. - - The operation has failed. - enum: - - STATE_UNSPECIFIED - - INITIALIZING - - RUNNING - - CANCELLED - - SUCCEEDED - - FAILED - createTime: + Number of messages prior to and including latest_message to compile + the suggestion. It may be smaller than the + SuggestKnowledgeAssistRequest.context_size field in the request if + there are fewer messages in the conversation. + type: integer + format: int32 + GoogleCloudDialogflowV2KnowledgeAssistAnswer: + id: GoogleCloudDialogflowV2KnowledgeAssistAnswer + description: Represents a Knowledge Assist answer. + type: object + properties: + suggestedQuery: description: >- - Timestamp when the request to create conversation model was - submitted. The time is measured on server side. + The query suggested based on the context. Suggestion is made only if + it is different from the previous suggestion. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2KnowledgeAssistAnswerSuggestedQuery + suggestedQueryAnswer: + description: >- + The answer generated for the suggested query. Whether or not an + answer is generated depends on how confident we are about the + generated query. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswer + answerRecord: + description: >- + The name of the answer record. Format: `projects//locations//answer + Records/`. type: string - format: google-datetime - GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesResponse: - id: GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesResponse - description: The response message for EntityTypes.BatchUpdateEntityTypes. + GoogleCloudDialogflowV2KnowledgeAssistAnswerSuggestedQuery: + id: GoogleCloudDialogflowV2KnowledgeAssistAnswerSuggestedQuery + description: Represents a suggested query. type: object properties: - entityTypes: - description: The collection of updated or created entity types. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1EntityType' - GoogleCloudDialogflowV2beta1EntityType: - id: GoogleCloudDialogflowV2beta1EntityType + queryText: + description: Suggested query text. + type: string + GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswer: + id: GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswer description: >- - Each intent parameter has a type, called the entity type, which dictates - exactly how data from an end-user expression is extracted. Dialogflow - provides predefined system entities that can match many common types of - data. For example, there are system entities for matching dates, times, - colors, email addresses, and so on. You can also create your own custom - entities for matching custom data. For example, you could define a - vegetable entity that can match the types of vegetables available for - purchase with a grocery store agent. For more information, see the - [Entity - guide](https://cloud.google.com/dialogflow/docs/entities-overview). + Represents an answer from Knowledge. Currently supports FAQ and + Generative answers. type: object properties: - name: + answerText: description: >- - The unique identifier of the entity type. Required for - EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes - methods. Supported formats: - `projects//agent/entityTypes/` - - `projects//locations//agent/entityTypes/` - type: string - displayName: - description: Required. The name of the entity type. - type: string - kind: - description: Required. Indicates the kind of entity type. + The piece of text from the `source` that answers this suggested + query. type: string - enumDescriptions: - - Not specified. This value should be never used. - - >- - Map entity types allow mapping of a group of synonyms to a - reference value. - - >- - List entity types contain a set of entries that do not map to - reference values. However, list entity types can contain - references to other entity types (with or without aliases). - - >- - Regexp entity types allow to specify regular expressions in - entries values. - enum: - - KIND_UNSPECIFIED - - KIND_MAP - - KIND_LIST - - KIND_REGEXP - autoExpansionMode: - description: >- - Optional. Indicates whether the entity type can be automatically - expanded. + faqSource: + description: Populated if the prediction came from FAQ. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerFaqSource + generativeSource: + description: Populated if the prediction was Generative. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource + GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerFaqSource: + id: GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerFaqSource + description: Details about source of FAQ answer. + type: object + properties: + question: + description: The corresponding FAQ question. type: string - enumDescriptions: - - Auto expansion disabled for the entity. - - >- - Allows an agent to recognize values that have not been explicitly - listed in the entity. - enum: - - AUTO_EXPANSION_MODE_UNSPECIFIED - - AUTO_EXPANSION_MODE_DEFAULT - entities: + GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource: + id: >- + GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource + description: Details about source of Generative answer. + type: object + properties: + snippets: description: >- - Optional. The collection of entity entries associated with the - entity type. + All snippets used for this Generative Prediction, with their source + URI and data. type: array items: - $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1EntityTypeEntity' - enableFuzzyExtraction: - description: Optional. Enables fuzzy entity extraction during classification. - type: boolean - GoogleCloudDialogflowV2beta1EntityTypeEntity: - id: GoogleCloudDialogflowV2beta1EntityTypeEntity - description: An **entity entry** for an associated entity type. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet + GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet: + id: >- + GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet + description: Snippet Source for a Generative Prediction. type: object properties: - value: - description: >- - Required. The primary value associated with this entity entry. For - example, if the entity type is *vegetable*, the value could be - *scallions*. For `KIND_MAP` entity types: * A reference value to be - used in place of synonyms. For `KIND_LIST` entity types: * A string - that can contain references to other entity types (with or without - aliases). + uri: + description: URI the data is sourced from. type: string - synonyms: - description: >- - Required. A collection of value synonyms. For example, if the entity - type is *vegetable*, and `value` is *scallions*, a synonym could be - *green onions*. For `KIND_LIST` entity types: * This collection must - contain exactly one synonym equal to `value`. - type: array - items: - type: string - GoogleCloudDialogflowV2beta1BatchUpdateIntentsResponse: - id: GoogleCloudDialogflowV2beta1BatchUpdateIntentsResponse - description: The response message for Intents.BatchUpdateIntents. + text: + description: Text taken from that URI. + type: string + title: + description: Title of the document. + type: string + metadata: + description: Metadata of the document. + type: object + additionalProperties: + type: any + description: Properties of the object. + GoogleCloudDialogflowV2SuggestFaqAnswersResponse: + id: GoogleCloudDialogflowV2SuggestFaqAnswersResponse + description: The request message for Participants.SuggestFaqAnswers. type: object properties: - intents: - description: The collection of updated or created intents. + faqAnswers: + description: Answers extracted from FAQ documents. type: array items: - $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1Intent' - GoogleCloudDialogflowV2beta1Intent: - id: GoogleCloudDialogflowV2beta1Intent - description: >- - An intent categorizes an end-user's intention for one conversation turn. - For each agent, you define many intents, where your combined intents can - handle a complete conversation. When an end-user writes or says - something, referred to as an end-user expression or end-user input, - Dialogflow matches the end-user input to the best intent in your agent. - Matching an intent is also known as intent classification. For more - information, see the [intent - guide](https://cloud.google.com/dialogflow/docs/intents-overview). - type: object - properties: - name: + $ref: '#/components/schemas/GoogleCloudDialogflowV2FaqAnswer' + latestMessage: description: >- - Optional. The unique identifier of this intent. Required for - Intents.UpdateIntent and Intents.BatchUpdateIntents methods. - Supported formats: - `projects//agent/intents/` - - `projects//locations//agent/intents/` - type: string - displayName: - description: Required. The name of this intent. - type: string - webhookState: - description: Optional. Indicates whether webhooks are enabled for the intent. + The name of the latest conversation message used to compile + suggestion for. Format: + `projects//locations//conversations//messages/`. type: string - enumDescriptions: - - Webhook is disabled in the agent and in the intent. - - Webhook is enabled in the agent and in the intent. - - >- - Webhook is enabled in the agent and in the intent. Also, each slot - filling prompt is forwarded to the webhook. - enum: - - WEBHOOK_STATE_UNSPECIFIED - - WEBHOOK_STATE_ENABLED - - WEBHOOK_STATE_ENABLED_FOR_SLOT_FILLING - priority: + contextSize: description: >- - Optional. The priority of this intent. Higher numbers represent - higher priorities. - If the supplied value is unspecified or 0, the - service translates the value to 500,000, which corresponds to the - `Normal` priority in the console. - If the supplied value is - negative, the intent is ignored in runtime detect intent requests. + Number of messages prior to and including latest_message to compile + the suggestion. It may be smaller than the + SuggestFaqAnswersRequest.context_size field in the request if there + aren't that many messages in the conversation. type: integer format: int32 - isFallback: - description: Optional. Indicates whether this is a fallback intent. - type: boolean - mlEnabled: + GoogleCloudDialogflowV2FaqAnswer: + id: GoogleCloudDialogflowV2FaqAnswer + description: Represents answer from "frequently asked questions". + type: object + properties: + answer: + description: The piece of text from the `source` knowledge base document. + type: string + confidence: description: >- - Optional. Indicates whether Machine Learning is enabled for the - intent. Note: If `ml_enabled` setting is set to false, then this - intent is not taken into account during inference in `ML ONLY` match - mode. Also, auto-markup in the UI is turned off. DEPRECATED! Please - use `ml_disabled` field instead. NOTE: If both `ml_enabled` and - `ml_disabled` are either not set or false, then the default value is - determined as follows: - Before April 15th, 2018 the default is: - ml_enabled = false / ml_disabled = true. - After April 15th, 2018 - the default is: ml_enabled = true / ml_disabled = false. - deprecated: true - type: boolean - mlDisabled: + The system's confidence score that this Knowledge answer is a good + match for this conversational query, range from 0.0 (completely + uncertain) to 1.0 (completely certain). + type: number + format: float + question: + description: The corresponding FAQ question. + type: string + source: description: >- - Optional. Indicates whether Machine Learning is disabled for the - intent. Note: If `ml_disabled` setting is set to true, then this - intent is not taken into account during inference in `ML ONLY` match - mode. Also, auto-markup in the UI is turned off. - type: boolean - liveAgentHandoff: + Indicates which Knowledge Document this answer was extracted from. + Format: `projects//locations//agent/knowledgeBases//documents/`. + type: string + metadata: description: >- - Optional. Indicates that a live agent should be brought in to handle - the interaction with the user. In most cases, when you set this flag - to true, you would also want to set end_interaction to true as well. - Default is false. - type: boolean - endInteraction: + A map that contains metadata about the answer and the document from + which it originates. + type: object + additionalProperties: + type: string + answerRecord: description: >- - Optional. Indicates that this intent ends an interaction. Some - integrations (e.g., Actions on Google or Dialogflow phone gateway) - use this information to close interaction with an end user. Default - is false. - type: boolean - inputContextNames: + The name of answer record, in the format of + "projects//locations//answerRecords/" + type: string + GoogleCloudDialogflowV2SuggestSmartRepliesResponse: + id: GoogleCloudDialogflowV2SuggestSmartRepliesResponse + description: The response message for Participants.SuggestSmartReplies. + type: object + properties: + smartReplyAnswers: description: >- - Optional. The list of context names required for this intent to be - triggered. Formats: - `projects//agent/sessions/-/contexts/` - - `projects//locations//agent/sessions/-/contexts/` + Output only. Multiple reply options provided by smart reply service. + The order is based on the rank of the model prediction. The maximum + number of the returned replies is set in SmartReplyConfig. + readOnly: true type: array items: - type: string - events: - description: >- - Optional. The collection of event names that trigger the intent. If - the collection of input contexts is not empty, all of the contexts - must be present in the active user session for an event to trigger - this intent. Event names are limited to 150 characters. - type: array - items: - type: string - trainingPhrases: - description: Optional. The collection of examples that the agent is trained on. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1IntentTrainingPhrase - action: + $ref: '#/components/schemas/GoogleCloudDialogflowV2SmartReplyAnswer' + latestMessage: description: >- - Optional. The name of the action associated with the intent. Note: - The action name must not contain whitespaces. + The name of the latest conversation message used to compile + suggestion for. Format: + `projects//locations//conversations//messages/`. type: string - outputContexts: - description: >- - Optional. The collection of contexts that are activated when the - intent is matched. Context messages in this collection should not - set the parameters field. Setting the `lifespan_count` to 0 will - reset the context when the intent is matched. Format: - `projects//agent/sessions/-/contexts/`. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1Context' - resetContexts: + contextSize: description: >- - Optional. Indicates whether to delete all contexts in the current - session when this intent is matched. - type: boolean - parameters: - description: Optional. The collection of parameters associated with the intent. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1IntentParameter' - messages: + Number of messages prior to and including latest_message to compile + the suggestion. It may be smaller than the + SuggestSmartRepliesRequest.context_size field in the request if + there aren't that many messages in the conversation. + type: integer + format: int32 + GoogleCloudDialogflowV2SmartReplyAnswer: + id: GoogleCloudDialogflowV2SmartReplyAnswer + description: Represents a smart reply answer. + type: object + properties: + reply: + description: The content of the reply. + type: string + confidence: description: >- - Optional. The collection of rich messages corresponding to the - `Response` field in the Dialogflow console. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1IntentMessage' - defaultResponsePlatforms: + Smart reply confidence. The system's confidence score that this + reply is a good match for this conversation, as a value from 0.0 + (completely uncertain) to 1.0 (completely certain). + type: number + format: float + answerRecord: description: >- - Optional. The list of platforms for which the first responses will - be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default - platform). + The name of answer record, in the format of + "projects//locations//answerRecords/" + type: string + GoogleCloudDialogflowV2GenerateSuggestionsResponse: + id: GoogleCloudDialogflowV2GenerateSuggestionsResponse + description: The response message for Conversations.GenerateSuggestions. + type: object + properties: + generatorSuggestionAnswers: + description: The answers generated for the conversation based on context. type: array items: - type: string - enumDescriptions: - - Not specified. - - Facebook. - - Slack. - - Telegram. - - Kik. - - Skype. - - Line. - - Viber. - - >- - Google Assistant See [Dialogflow webhook - format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json) - - Telephony Gateway. - - Google Hangouts. - enum: - - PLATFORM_UNSPECIFIED - - FACEBOOK - - SLACK - - TELEGRAM - - KIK - - SKYPE - - LINE - - VIBER - - ACTIONS_ON_GOOGLE - - TELEPHONY - - GOOGLE_HANGOUTS - rootFollowupIntentName: + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer + latestMessage: description: >- - Output only. The unique identifier of the root intent in the chain - of followup intents. It identifies the correct followup intents - chain for this intent. Format: `projects//agent/intents/`. - readOnly: true + The name of the latest conversation message used as context for + compiling suggestion. Format: + `projects//locations//conversations//messages/`. type: string - parentFollowupIntentName: + GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer: + id: >- + GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer + description: A GeneratorSuggestion answer. + type: object + properties: + generatorSuggestion: + description: Suggestion details. + $ref: '#/components/schemas/GoogleCloudDialogflowV2GeneratorSuggestion' + sourceGenerator: description: >- - Optional. The unique identifier of the parent intent in the chain of - followup intents. You can set this field when creating an intent, - for example with CreateIntent or BatchUpdateIntents, in order to - make this intent a followup intent. It identifies the parent - followup intent. Format: `projects//agent/intents/`. + The name of the generator used to generate this suggestion. Format: + `projects//locations//generators/`. type: string - followupIntentInfo: + answerRecord: description: >- - Output only. Information about all followup intents that have this - intent as a direct or indirect parent. We populate this field only - in the output. - readOnly: true + Answer record that uniquely identifies the suggestion. This can be + used to provide suggestion feedback. + type: string + GoogleCloudDialogflowV2GeneratorSuggestion: + id: GoogleCloudDialogflowV2GeneratorSuggestion + description: Suggestion generated using a Generator. + type: object + properties: + freeFormSuggestion: + description: Optional. Free form suggestion. + $ref: '#/components/schemas/GoogleCloudDialogflowV2FreeFormSuggestion' + summarySuggestion: + description: Optional. Suggested summary. + $ref: '#/components/schemas/GoogleCloudDialogflowV2SummarySuggestion' + toolCallInfo: + description: Optional. List of request and response for tool calls executed. type: array items: $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1IntentFollowupIntentInfo - GoogleCloudDialogflowV2beta1IntentTrainingPhrase: - id: GoogleCloudDialogflowV2beta1IntentTrainingPhrase - description: Represents an example that the agent is trained on. + #/components/schemas/GoogleCloudDialogflowV2GeneratorSuggestionToolCallInfo + GoogleCloudDialogflowV2FreeFormSuggestion: + id: GoogleCloudDialogflowV2FreeFormSuggestion + description: Suggestion generated using free form generator. type: object properties: - name: - description: Output only. The unique identifier of this training phrase. - type: string - type: - description: Required. The type of the training phrase. + response: + description: Required. Free form suggestion. type: string - enumDescriptions: - - Not specified. This value should never be used. - - >- - Examples do not contain @-prefixed entity type names, but example - parts can be annotated with entity types. - - >- - Templates are not annotated with entity types, but they can - contain @-prefixed entity type names as substrings. Note: Template - mode has been deprecated. Example mode is the only supported way - to create new training phrases. If you have existing training - phrases in template mode, they will be removed during training and - it can cause a drop in agent performance. - enumDeprecated: - - false - - false - - true - enum: - - TYPE_UNSPECIFIED - - EXAMPLE - - TEMPLATE - parts: - description: >- - Required. The ordered list of training phrase parts. The parts are - concatenated in order to form the training phrase. Note: The API - does not automatically annotate training phrases like the Dialogflow - Console does. Note: Do not forget to include whitespace at part - boundaries, so the training phrase is well formatted when the parts - are concatenated. If the training phrase does not need to be - annotated with parameters, you just need a single part with only the - Part.text field set. If you want to annotate the training phrase, - you must create multiple parts, where the fields of each part are - populated in one of two ways: - `Part.text` is set to a part of the - phrase that has no parameters. - `Part.text` is set to a part of the - phrase that you want to annotate, and the `entity_type`, `alias`, - and `user_defined` fields are all set. + GoogleCloudDialogflowV2SummarySuggestion: + id: GoogleCloudDialogflowV2SummarySuggestion + description: Suggested summary of the conversation. + type: object + properties: + summarySections: + description: Required. All the parts of generated summary. type: array items: $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1IntentTrainingPhrasePart - timesAddedCount: - description: >- - Optional. Indicates how many times this example was added to the - intent. Each time a developer adds an existing sample by editing an - intent or training, this counter is increased. - type: integer - format: int32 - GoogleCloudDialogflowV2beta1IntentTrainingPhrasePart: - id: GoogleCloudDialogflowV2beta1IntentTrainingPhrasePart - description: Represents a part of a training phrase. + #/components/schemas/GoogleCloudDialogflowV2SummarySuggestionSummarySection + GoogleCloudDialogflowV2SummarySuggestionSummarySection: + id: GoogleCloudDialogflowV2SummarySuggestionSummarySection + description: A component of the generated summary. type: object properties: - text: - description: Required. The text for this part. + section: + description: Required. Name of the section. type: string - entityType: - description: >- - Optional. The entity type name prefixed with `@`. This field is - required for annotated parts of the training phrase. + summary: + description: Required. Summary text for the section. type: string - alias: + GoogleCloudDialogflowV2GeneratorSuggestionToolCallInfo: + id: GoogleCloudDialogflowV2GeneratorSuggestionToolCallInfo + description: Request and response for a tool call. + type: object + properties: + toolCall: + description: Required. Request for a tool call. + $ref: '#/components/schemas/GoogleCloudDialogflowV2ToolCall' + toolCallResult: + description: Required. Response for a tool call. + $ref: '#/components/schemas/GoogleCloudDialogflowV2ToolCallResult' + GoogleCloudDialogflowV2ToolCall: + id: GoogleCloudDialogflowV2ToolCall + description: Represents a call of a specific tool's action with the specified inputs. + type: object + properties: + tool: description: >- - Optional. The parameter name for the value extracted from the - annotated part of the example. This field is required for annotated - parts of the training phrase. + Optional. The tool associated with this call. Format: + `projects//locations//tools/`. type: string - userDefined: - description: >- - Optional. Indicates whether the text was manually annotated. This - field is set to true when the Dialogflow Console is used to manually - annotate the part. When creating an annotated part with the API, you - must set this to true. - type: boolean - GoogleCloudDialogflowV2beta1Context: - id: GoogleCloudDialogflowV2beta1Context - description: >- - Dialogflow contexts are similar to natural language context. If a person - says to you "they are orange", you need context in order to understand - what "they" is referring to. Similarly, for Dialogflow to handle an - end-user expression like that, it needs to be provided with context in - order to correctly match an intent. Using contexts, you can control the - flow of a conversation. You can configure contexts for an intent by - setting input and output contexts, which are identified by string names. - When an intent is matched, any configured output contexts for that - intent become active. While any contexts are active, Dialogflow is more - likely to match intents that are configured with input contexts that - correspond to the currently active contexts. For more information about - context, see the [Contexts - guide](https://cloud.google.com/dialogflow/docs/contexts-overview). + action: + description: Optional. The name of the tool's action associated with this call. + type: string + inputParameters: + description: Optional. The action's input parameters. + type: object + additionalProperties: + type: any + description: Properties of the object. + createTime: + description: Output only. Create time of the tool call. + readOnly: true + type: string + format: google-datetime + GoogleCloudDialogflowV2ToolCallResult: + id: GoogleCloudDialogflowV2ToolCallResult + description: The result of calling a tool's action. type: object properties: - name: + tool: description: >- - Required. The unique identifier of the context. Supported formats: - - `projects//agent/sessions//contexts/`, - - `projects//locations//agent/sessions//contexts/`, - - `projects//agent/environments//users//sessions//contexts/`, - - `projects//locations//agent/environments//users//sessions//contexts/`, - The `Context ID` is always converted to lowercase, may only contain - characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long. If - `Environment ID` is not specified, we assume default 'draft' - environment. If `User ID` is not specified, we assume default '-' - user. The following context names are reserved for internal use by - Dialogflow. You should not use these contexts or create contexts - with these names: * `__system_counters__` * `*_id_dialog_context` * - `*_dialog_params_size` + Optional. The tool associated with this call. Format: + `projects//locations//tools/`. type: string - lifespanCount: - description: >- - Optional. The number of conversational query requests after which - the context expires. The default is `0`. If set to `0`, the context - expires immediately. Contexts expire automatically after 20 minutes - if there are no matching queries. - type: integer - format: int32 - parameters: + action: + description: Optional. The name of the tool's action associated with this call. + type: string + error: + description: The tool call's error. + $ref: '#/components/schemas/GoogleCloudDialogflowV2ToolCallResultError' + rawContent: description: >- - Optional. The collection of parameters associated with this context. - Depending on your protocol or client library language, this is a - map, associative array, symbol table, dictionary, or JSON object - composed of a collection of (MapKey, MapValue) pairs: * MapKey type: - string * MapKey value: parameter name * MapValue type: If - parameter's entity type is a composite entity then use map, - otherwise, depending on the parameter value type, it could be one of - string, number, boolean, null, list or map. * MapValue value: If - parameter's entity type is a composite entity then use map from - composite entity property names to property values, otherwise, use - parameter value. - type: object - additionalProperties: - type: any - description: Properties of the object. - GoogleCloudDialogflowV2beta1IntentParameter: - id: GoogleCloudDialogflowV2beta1IntentParameter - description: Represents intent parameters. + Only populated if the response content is not utf-8 encoded. (by + definition byte fields are base64 encoded). + type: string + format: byte + content: + description: Only populated if the response content is utf-8 encoded. + type: string + createTime: + description: Output only. Create time of the tool call result. + readOnly: true + type: string + format: google-datetime + GoogleCloudDialogflowV2ToolCallResultError: + id: GoogleCloudDialogflowV2ToolCallResultError + description: An error produced by the tool call. type: object properties: - name: - description: The unique identifier of this parameter. + message: + description: Optional. The error message of the function. type: string - displayName: - description: Required. The name of the parameter. + GoogleCloudDialogflowV2ImportDocumentsResponse: + id: GoogleCloudDialogflowV2ImportDocumentsResponse + description: Response message for Documents.ImportDocuments. + type: object + properties: + warnings: + description: Includes details about skipped documents or any other warnings. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudDialogflowV2KnowledgeOperationMetadata: + id: GoogleCloudDialogflowV2KnowledgeOperationMetadata + description: Metadata in google::longrunning::Operation for Knowledge operations. + type: object + properties: + state: + description: Output only. The current state of this operation. + readOnly: true type: string - value: - description: >- - Optional. The definition of the parameter value. It can be: - a - constant string, - a parameter value defined as `$parameter_name`, - - an original parameter value defined as `$parameter_name.original`, - - a parameter value from some context defined as - `#context_name.parameter_name`. + enumDescriptions: + - State unspecified. + - The operation has been created. + - The operation is currently running. + - The operation is done, either cancelled or completed. + enum: + - STATE_UNSPECIFIED + - PENDING + - RUNNING + - DONE + knowledgeBase: + description: The name of the knowledge base interacted with during the operation. type: string - defaultValue: + exportOperationMetadata: description: >- - Optional. The default value to use when the `value` yields an empty - result. Default values can be extracted from contexts by using the - following syntax: `#context_name.parameter_name`. + Metadata for the Export Data Operation such as the destination of + export. + $ref: '#/components/schemas/GoogleCloudDialogflowV2ExportOperationMetadata' + doneTime: + description: The time when the operation finished. type: string - entityTypeDisplayName: + format: google-datetime + GoogleCloudDialogflowV2ExportOperationMetadata: + id: GoogleCloudDialogflowV2ExportOperationMetadata + description: Metadata related to the Export Data Operations (e.g. ExportDocument). + type: object + properties: + exportedGcsDestination: + description: Cloud Storage file path of the exported data. + $ref: '#/components/schemas/GoogleCloudDialogflowV2GcsDestination' + GoogleCloudDialogflowV2GcsDestination: + id: GoogleCloudDialogflowV2GcsDestination + description: Google Cloud Storage location for the output. + type: object + properties: + uri: description: >- - Optional. The name of the entity type, prefixed with `@`, that - describes values of the parameter. If the parameter is required, - this must be provided. + The Google Cloud Storage URIs for the output. A URI is of the form: + `gs://bucket/object-prefix-or-name` Whether a prefix or name is used + depends on the use case. The requesting user must have + "write-permission" to the bucket. type: string - mandatory: - description: >- - Optional. Indicates whether the parameter is required. That is, - whether the intent cannot be completed without collecting the - parameter value. - type: boolean - prompts: - description: >- - Optional. The collection of prompts that the agent can present to - the user in order to collect a value for the parameter. - type: array - items: - type: string - isList: - description: >- - Optional. Indicates whether the parameter represents a list of - values. - type: boolean - GoogleCloudDialogflowV2beta1IntentMessage: - id: GoogleCloudDialogflowV2beta1IntentMessage - description: Corresponds to the `Response` field in the Dialogflow console. + GoogleCloudDialogflowV2OriginalDetectIntentRequest: + id: GoogleCloudDialogflowV2OriginalDetectIntentRequest + description: >- + Represents the contents of the original request that was passed to the + `[Streaming]DetectIntent` call. type: object properties: - text: - description: Returns a text response. - $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageText' - image: - description: Displays an image. - $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageImage' - quickReplies: - description: Displays quick replies. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageQuickReplies - card: - description: Displays a card. - $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageCard' + source: + description: >- + The source of this request, e.g., `google`, `facebook`, `slack`. It + is set by Dialogflow-owned servers. + type: string + version: + description: >- + Optional. The version of the protocol used for this request. This + field is AoG-specific. + type: string payload: - description: A custom platform-specific response. + description: >- + Optional. This field is set to the value of the + `QueryParameters.payload` field passed in the request. Some + integrations that query a Dialogflow agent may provide additional + information in the payload. In particular, for the Dialogflow Phone + Gateway integration, this field has the form: { "telephony": { + "caller_id": "+18558363987" } } Note: The caller ID field + (`caller_id`) will be redacted for Trial Edition agents and + populated with the caller ID in [E.164 + format](https://en.wikipedia.org/wiki/E.164) for Essentials Edition + agents. type: object additionalProperties: type: any description: Properties of the object. - simpleResponses: - description: Returns a voice or text-only response for Actions on Google. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageSimpleResponses - basicCard: - description: Displays a basic card for Actions on Google. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageBasicCard - suggestions: - description: Displays suggestion chips for Actions on Google. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageSuggestions - linkOutSuggestion: - description: Displays a link out suggestion chip for Actions on Google. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageLinkOutSuggestion - listSelect: - description: Displays a list card for Actions on Google. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageListSelect - carouselSelect: - description: Displays a carousel card for Actions on Google. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageCarouselSelect - telephonyPlayAudio: - description: Plays audio from a file in Telephony Gateway. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageTelephonyPlayAudio - telephonySynthesizeSpeech: - description: Synthesizes speech in Telephony Gateway. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageTelephonySynthesizeSpeech - telephonyTransferCall: - description: Transfers the call in Telephony Gateway. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageTelephonyTransferCall - rbmText: + GoogleCloudDialogflowV2SetSuggestionFeatureConfigOperationMetadata: + id: GoogleCloudDialogflowV2SetSuggestionFeatureConfigOperationMetadata + description: >- + Metadata for a ConversationProfiles.SetSuggestionFeatureConfig + operation. + type: object + properties: + conversationProfile: description: >- - Rich Business Messaging (RBM) text response. RBM allows businesses - to send enriched and branded versions of SMS. See - https://jibe.google.com/business-messaging. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageRbmText - rbmStandaloneRichCard: - description: Standalone Rich Business Messaging (RBM) rich card response. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard - rbmCarouselRichCard: - description: Rich Business Messaging (RBM) carousel rich card response. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard - browseCarouselCard: - description: Browse carousel card for Actions on Google. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCard - tableCard: - description: Table card for Actions on Google. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageTableCard - mediaContent: - description: The media content card for Actions on Google. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageMediaContent - platform: - description: Optional. The platform that this message is intended for. + The resource name of the conversation profile. Format: + `projects//locations//conversationProfiles/` + type: string + participantRole: + description: >- + Required. The participant role to add or update the suggestion + feature config. Only HUMAN_AGENT or END_USER can be used. type: string enumDescriptions: - - Not specified. - - Facebook. - - Slack. - - Telegram. - - Kik. - - Skype. - - Line. - - Viber. + - Participant role not set. + - Participant is a human agent. + - Participant is an automated agent, such as a Dialogflow agent. - >- - Google Assistant See [Dialogflow webhook - format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json) - - Telephony Gateway. - - Google Hangouts. + Participant is an end user that has called or chatted with + Dialogflow services. enum: - - PLATFORM_UNSPECIFIED - - FACEBOOK - - SLACK - - TELEGRAM - - KIK - - SKYPE - - LINE - - VIBER - - ACTIONS_ON_GOOGLE - - TELEPHONY - - GOOGLE_HANGOUTS - GoogleCloudDialogflowV2beta1IntentMessageText: - id: GoogleCloudDialogflowV2beta1IntentMessageText - description: The text response message. - type: object - properties: - text: - description: Optional. The collection of the agent's responses. - type: array - items: - type: string - GoogleCloudDialogflowV2beta1IntentMessageImage: - id: GoogleCloudDialogflowV2beta1IntentMessageImage - description: The image response message. - type: object - properties: - imageUri: - description: Optional. The public URI to an image file. + - ROLE_UNSPECIFIED + - HUMAN_AGENT + - AUTOMATED_AGENT + - END_USER + suggestionFeatureType: + description: Required. The type of the suggestion feature to add or update. type: string - accessibilityText: + enumDescriptions: + - Unspecified feature type. + - Run article suggestion model for chat. + - Run FAQ model for chat. + - Run smart reply model for chat. + - Run conversation summarization model for chat. + - >- + Run knowledge search with text input from agent or text generated + query. + - Run knowledge assist with automatic query generation. + enum: + - TYPE_UNSPECIFIED + - ARTICLE_SUGGESTION + - FAQ + - SMART_REPLY + - CONVERSATION_SUMMARIZATION + - KNOWLEDGE_SEARCH + - KNOWLEDGE_ASSIST + createTime: description: >- - A text description of the image to be used for accessibility, e.g., - screen readers. Required if image_uri is set for CarouselSelect. + Timestamp whe the request was created. The time is measured on + server side. type: string - GoogleCloudDialogflowV2beta1IntentMessageQuickReplies: - id: GoogleCloudDialogflowV2beta1IntentMessageQuickReplies - description: The quick replies response message. + format: google-datetime + GoogleCloudDialogflowV2WebhookRequest: + id: GoogleCloudDialogflowV2WebhookRequest + description: The request message for a webhook call. type: object properties: - title: - description: Optional. The title of the collection of quick replies. + session: + description: >- + The unique identifier of detectIntent request session. Can be used + to identify end-user inside webhook implementation. Format: + `projects//agent/sessions/`, or + `projects//agent/environments//users//sessions/`. type: string - quickReplies: - description: Optional. The collection of quick replies. - type: array - items: - type: string - GoogleCloudDialogflowV2beta1IntentMessageCard: - id: GoogleCloudDialogflowV2beta1IntentMessageCard - description: The card response message. + responseId: + description: >- + The unique identifier of the response. Contains the same value as + `[Streaming]DetectIntentResponse.response_id`. + type: string + queryResult: + description: >- + The result of the conversational query or event processing. Contains + the same value as `[Streaming]DetectIntentResponse.query_result`. + $ref: '#/components/schemas/GoogleCloudDialogflowV2QueryResult' + originalDetectIntentRequest: + description: >- + Optional. The contents of the original request that was passed to + `[Streaming]DetectIntent` call. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2OriginalDetectIntentRequest + GoogleCloudDialogflowV2QueryResult: + id: GoogleCloudDialogflowV2QueryResult + description: Represents the result of conversational query or event processing. type: object properties: - title: - description: Optional. The title of the card. + queryText: + description: >- + The original conversational query text: - If natural language text + was provided as input, `query_text` contains a copy of the input. - + If natural language speech audio was provided as input, `query_text` + contains the speech recognition result. If speech recognizer + produced multiple alternatives, a particular one is picked. - If + automatic spell correction is enabled, `query_text` will contain the + corrected user input. type: string - subtitle: - description: Optional. The subtitle of the card. + languageCode: + description: >- + The language that was triggered during intent detection. See + [Language + Support](https://cloud.google.com/dialogflow/docs/reference/language) + for a list of the currently supported language codes. type: string - imageUri: - description: Optional. The public URI to an image file for the card. + speechRecognitionConfidence: + description: >- + The Speech recognition confidence between 0.0 and 1.0. A higher + number indicates an estimated greater likelihood that the recognized + words are correct. The default of 0.0 is a sentinel value indicating + that confidence was not set. This field is not guaranteed to be + accurate or set. In particular this field isn't set for + StreamingDetectIntent since the streaming endpoint has separate + confidence estimates per portion of the audio in + StreamingRecognitionResult. + type: number + format: float + action: + description: The action name from the matched intent. type: string - buttons: - description: Optional. The collection of card buttons. + parameters: + description: >- + The collection of extracted parameters. Depending on your protocol + or client library language, this is a map, associative array, symbol + table, dictionary, or JSON object composed of a collection of + (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: + parameter name * MapValue type: If parameter's entity type is a + composite entity then use map, otherwise, depending on the parameter + value type, it could be one of string, number, boolean, null, list + or map. * MapValue value: If parameter's entity type is a composite + entity then use map from composite entity property names to property + values, otherwise, use parameter value. + type: object + additionalProperties: + type: any + description: Properties of the object. + allRequiredParamsPresent: + description: >- + This field is set to: - `false` if the matched intent has required + parameters and not all of the required parameter values have been + collected. - `true` if all required parameter values have been + collected, or if the matched intent doesn't contain any required + parameters. + type: boolean + cancelsSlotFilling: + description: >- + Indicates whether the conversational query triggers a cancellation + for slot filling. For more information, see the [cancel slot filling + documentation](https://cloud.google.com/dialogflow/es/docs/intents-actions-parameters#cancel). + type: boolean + fulfillmentText: + description: >- + The text to be pronounced to the user or shown on the screen. Note: + This is a legacy field, `fulfillment_messages` should be preferred. + type: string + fulfillmentMessages: + description: The collection of rich messages to present to the user. type: array items: - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageCardButton - GoogleCloudDialogflowV2beta1IntentMessageCardButton: - id: GoogleCloudDialogflowV2beta1IntentMessageCardButton - description: Optional. Contains information about a button. - type: object - properties: - text: - description: Optional. The text to show on the button. - type: string - postback: + $ref: '#/components/schemas/GoogleCloudDialogflowV2IntentMessage' + webhookSource: description: >- - Optional. The text to send back to the Dialogflow API or a URI to - open. + If the query was fulfilled by a webhook call, this field is set to + the value of the `source` field returned in the webhook response. type: string - GoogleCloudDialogflowV2beta1IntentMessageSimpleResponses: - id: GoogleCloudDialogflowV2beta1IntentMessageSimpleResponses - description: >- - The collection of simple response candidates. This message in - `QueryResult.fulfillment_messages` and - `WebhookResponse.fulfillment_messages` should contain only one - `SimpleResponse`. - type: object - properties: - simpleResponses: - description: Required. The list of simple responses. + webhookPayload: + description: >- + If the query was fulfilled by a webhook call, this field is set to + the value of the `payload` field returned in the webhook response. + type: object + additionalProperties: + type: any + description: Properties of the object. + outputContexts: + description: >- + The collection of output contexts. If applicable, + `output_contexts.parameters` contains entries with name `.original` + containing the original parameter values before the query. type: array items: - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageSimpleResponse - GoogleCloudDialogflowV2beta1IntentMessageSimpleResponse: - id: GoogleCloudDialogflowV2beta1IntentMessageSimpleResponse - description: The simple response message containing speech or text. - type: object - properties: - textToSpeech: + $ref: '#/components/schemas/GoogleCloudDialogflowV2Context' + intent: description: >- - One of text_to_speech or ssml must be provided. The plain text of - the speech output. Mutually exclusive with ssml. - type: string - ssml: + The intent that matched the conversational query. Some, not all + fields are filled in this message, including but not limited to: + `name`, `display_name`, `end_interaction` and `is_fallback`. + $ref: '#/components/schemas/GoogleCloudDialogflowV2Intent' + intentDetectionConfidence: description: >- - One of text_to_speech or ssml must be provided. Structured spoken - response to the user in the SSML format. Mutually exclusive with - text_to_speech. - type: string - displayText: - description: Optional. The text to display. - type: string - GoogleCloudDialogflowV2beta1IntentMessageBasicCard: - id: GoogleCloudDialogflowV2beta1IntentMessageBasicCard - description: The basic card message. Useful for displaying information. + The intent detection confidence. Values range from 0.0 (completely + uncertain) to 1.0 (completely certain). This value is for + informational purpose only and is only used to help match the best + intent within the classification threshold. This value may change + for the same end-user expression at any time due to a model + retraining or change in implementation. If there are `multiple + knowledge_answers` messages, this value is set to the greatest + `knowledgeAnswers.match_confidence` value in the list. + type: number + format: float + diagnosticInfo: + description: >- + Free-form diagnostic information for the associated detect intent + request. The fields of this data can change without notice, so you + should not write code that depends on its structure. The data may + contain: - webhook call latency - webhook errors + type: object + additionalProperties: + type: any + description: Properties of the object. + sentimentAnalysisResult: + description: >- + The sentiment analysis result, which depends on the + `sentiment_analysis_request_config` specified in the request. + $ref: '#/components/schemas/GoogleCloudDialogflowV2SentimentAnalysisResult' + GoogleCloudDialogflowV2WebhookResponse: + id: GoogleCloudDialogflowV2WebhookResponse + description: >- + The response message for a webhook call. This response is validated by + the Dialogflow server. If validation fails, an error will be returned in + the QueryResult.diagnostic_info field. Setting JSON fields to an empty + value with the wrong type is a common error. To avoid this error: - Use + `""` for empty strings - Use `{}` or `null` for empty objects - Use `[]` + or `null` for empty arrays For more information, see the [Protocol + Buffers Language + Guide](https://developers.google.com/protocol-buffers/docs/proto3#json). type: object properties: - title: - description: Optional. The title of the card. - type: string - subtitle: - description: Optional. The subtitle of the card. + fulfillmentText: + description: >- + Optional. The text response message intended for the end-user. It is + recommended to use `fulfillment_messages.text.text[0]` instead. When + provided, Dialogflow uses this field to populate + QueryResult.fulfillment_text sent to the integration or API caller. type: string - formattedText: - description: Required, unless image is present. The body text of the card. + fulfillmentMessages: + description: >- + Optional. The rich response messages intended for the end-user. When + provided, Dialogflow uses this field to populate + QueryResult.fulfillment_messages sent to the integration or API + caller. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowV2IntentMessage' + source: + description: >- + Optional. A custom field used to identify the webhook source. + Arbitrary strings are supported. When provided, Dialogflow uses this + field to populate QueryResult.webhook_source sent to the integration + or API caller. type: string - image: - description: Optional. The image for the card. - $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageImage' - buttons: - description: Optional. The collection of card buttons. + payload: + description: >- + Optional. This field can be used to pass custom data from your + webhook to the integration or API caller. Arbitrary JSON objects are + supported. When provided, Dialogflow uses this field to populate + QueryResult.webhook_payload sent to the integration or API caller. + This field is also used by the [Google Assistant + integration](https://cloud.google.com/dialogflow/docs/integrations/aog) + for rich response messages. See the format definition at [Google + Assistant Dialogflow webhook + format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json) + type: object + additionalProperties: + type: any + description: Properties of the object. + outputContexts: + description: >- + Optional. The collection of output contexts that will overwrite + currently active contexts for the session and reset their lifespans. + When provided, Dialogflow uses this field to populate + QueryResult.output_contexts sent to the integration or API caller. type: array items: - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageBasicCardButton - GoogleCloudDialogflowV2beta1IntentMessageBasicCardButton: - id: GoogleCloudDialogflowV2beta1IntentMessageBasicCardButton - description: The button object that appears at the bottom of a card. + $ref: '#/components/schemas/GoogleCloudDialogflowV2Context' + followupEventInput: + description: >- + Optional. Invokes the supplied events. When this field is set, + Dialogflow ignores the `fulfillment_text`, `fulfillment_messages`, + and `payload` fields. + $ref: '#/components/schemas/GoogleCloudDialogflowV2EventInput' + sessionEntityTypes: + description: >- + Optional. Additional session entity types to replace or extend + developer entity types with. The entity synonyms apply to all + languages and persist for the session. Setting this data from a + webhook overwrites the session entity types that have been set using + `detectIntent`, `streamingDetectIntent` or SessionEntityType + management methods. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowV2SessionEntityType' + GoogleCloudDialogflowV2EventInput: + id: GoogleCloudDialogflowV2EventInput + description: >- + Events allow for matching intents by event name instead of the natural + language input. For instance, input `` can trigger a personalized + welcome response. The parameter `name` may be used by the agent in the + response: `"Hello #welcome_event.name! What can I do for you today?"`. type: object properties: - title: - description: Required. The title of the button. + name: + description: Required. The unique identifier of the event. type: string - openUriAction: - description: Required. Action to take when a user taps on the button. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageBasicCardButtonOpenUriAction - GoogleCloudDialogflowV2beta1IntentMessageBasicCardButtonOpenUriAction: - id: GoogleCloudDialogflowV2beta1IntentMessageBasicCardButtonOpenUriAction - description: Opens the given URI. - type: object - properties: - uri: - description: Required. The HTTP or HTTPS scheme URI. + parameters: + description: >- + The collection of parameters associated with the event. Depending on + your protocol or client library language, this is a map, associative + array, symbol table, dictionary, or JSON object composed of a + collection of (MapKey, MapValue) pairs: * MapKey type: string * + MapKey value: parameter name * MapValue type: If parameter's entity + type is a composite entity then use map, otherwise, depending on the + parameter value type, it could be one of string, number, boolean, + null, list or map. * MapValue value: If parameter's entity type is a + composite entity then use map from composite entity property names + to property values, otherwise, use parameter value. + type: object + additionalProperties: + type: any + description: Properties of the object. + languageCode: + description: >- + Required. The language of this query. See [Language + Support](https://cloud.google.com/dialogflow/docs/reference/language) + for a list of the currently supported language codes. Note that + queries in the same session do not necessarily need to specify the + same language. This field is ignored when used in the context of a + WebhookResponse.followup_event_input field, because the language was + already defined in the originating detect intent request. type: string - GoogleCloudDialogflowV2beta1IntentMessageSuggestions: - id: GoogleCloudDialogflowV2beta1IntentMessageSuggestions - description: The collection of suggestions. + GoogleCloudDialogflowV2SessionEntityType: + id: GoogleCloudDialogflowV2SessionEntityType + description: >- + A session represents a conversation between a Dialogflow agent and an + end-user. You can create special entities, called session entities, + during a session. Session entities can extend or replace custom entity + types and only exist during the session that they were created for. All + session data, including session entities, is stored by Dialogflow for 20 + minutes. For more information, see the [session entity + guide](https://cloud.google.com/dialogflow/docs/entities-session). type: object properties: - suggestions: - description: Required. The list of suggested replies. + name: + description: >- + Required. The unique identifier of this session entity type. Format: + `projects//agent/sessions//entityTypes/`, or + `projects//agent/environments//users//sessions//entityTypes/`. If + `Environment ID` is not specified, we assume default 'draft' + environment. If `User ID` is not specified, we assume default '-' + user. `` must be the display name of an existing entity type in the + same agent that will be overridden or supplemented. + type: string + entityOverrideMode: + description: >- + Required. Indicates whether the additional data should override or + supplement the custom entity type definition. + type: string + enumDescriptions: + - Not specified. This value should be never used. + - >- + The collection of session entities overrides the collection of + entities in the corresponding custom entity type. + - >- + The collection of session entities extends the collection of + entities in the corresponding custom entity type. Note: Even in + this override mode calls to `ListSessionEntityTypes`, + `GetSessionEntityType`, `CreateSessionEntityType` and + `UpdateSessionEntityType` only return the additional entities + added in this session entity type. If you want to get the + supplemented list, please call EntityTypes.GetEntityType on the + custom entity type and merge. + enum: + - ENTITY_OVERRIDE_MODE_UNSPECIFIED + - ENTITY_OVERRIDE_MODE_OVERRIDE + - ENTITY_OVERRIDE_MODE_SUPPLEMENT + entities: + description: >- + Required. The collection of entities associated with this session + entity type. type: array items: - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageSuggestion - GoogleCloudDialogflowV2beta1IntentMessageSuggestion: - id: GoogleCloudDialogflowV2beta1IntentMessageSuggestion - description: >- - The suggestion chip message that the user can tap to quickly post a - reply to the conversation. + $ref: '#/components/schemas/GoogleCloudDialogflowV2EntityTypeEntity' + GoogleCloudDialogflowV2DeleteConversationDatasetOperationMetadata: + id: GoogleCloudDialogflowV2DeleteConversationDatasetOperationMetadata + description: Metadata for DeleteConversationDataset. type: object - properties: - title: - description: Required. The text shown the in the suggestion chip. - type: string - GoogleCloudDialogflowV2beta1IntentMessageLinkOutSuggestion: - id: GoogleCloudDialogflowV2beta1IntentMessageLinkOutSuggestion + properties: {} + GoogleCloudDialogflowV2ImportConversationDataOperationResponse: + id: GoogleCloudDialogflowV2ImportConversationDataOperationResponse description: >- - The suggestion chip message that allows the user to jump out to the app - or website associated with this agent. + Response used for ConversationDatasets.ImportConversationData long + running operation. type: object properties: - destinationName: - description: Required. The name of the app or site this chip is linking to. - type: string - uri: + conversationDataset: description: >- - Required. The URI of the app or site to open when the user taps the - suggestion chip. + The resource name of the imported conversation dataset. Format: + `projects//locations//conversationDatasets/` type: string - GoogleCloudDialogflowV2beta1IntentMessageListSelect: - id: GoogleCloudDialogflowV2beta1IntentMessageListSelect - description: The card for presenting a list of options to select from. + importCount: + description: Number of conversations imported successfully. + type: integer + format: int32 + GoogleCloudDialogflowV2ImportConversationDataOperationMetadata: + id: GoogleCloudDialogflowV2ImportConversationDataOperationMetadata + description: Metadata for a ConversationDatasets.ImportConversationData operation. type: object properties: - title: - description: Optional. The overall title of the list. + conversationDataset: + description: >- + The resource name of the imported conversation dataset. Format: + `projects//locations//conversationDatasets/` type: string - items: - description: Required. List items. + partialFailures: + description: >- + Partial failures are failures that don't fail the whole long running + operation, e.g. single files that couldn't be read. type: array items: - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageListSelectItem - subtitle: - description: Optional. Subtitle of the list. + $ref: '#/components/schemas/GoogleRpcStatus' + createTime: + description: >- + Timestamp when import conversation data request was created. The + time is measured on server side. type: string - GoogleCloudDialogflowV2beta1IntentMessageListSelectItem: - id: GoogleCloudDialogflowV2beta1IntentMessageListSelectItem - description: An item in the list. + format: google-datetime + GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata: + id: GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata + description: Metadata for initializing a location-level encryption specification. type: object properties: - info: - description: Required. Additional information about this option. + request: + description: Output only. The original request for initialization. + readOnly: true $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo - title: - description: Required. The title of the list item. - type: string - description: - description: Optional. The main text describing the item. - type: string - image: - description: Optional. The image to display. - $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageImage' - GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo: - id: GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo + #/components/schemas/GoogleCloudDialogflowV2InitializeEncryptionSpecRequest + GoogleCloudDialogflowV2InitializeEncryptionSpecRequest: + id: GoogleCloudDialogflowV2InitializeEncryptionSpecRequest + description: The request to initialize a location-level encryption specification. + type: object + properties: + encryptionSpec: + description: >- + Required. The encryption spec used for CMEK encryption. It is + required that the kms key is in the same region as the endpoint. The + same key will be used for all provisioned resources, if encryption + is available. If the kms_key_name is left empty, no encryption will + be enforced. + $ref: '#/components/schemas/GoogleCloudDialogflowV2EncryptionSpec' + GoogleCloudDialogflowV2EncryptionSpec: + id: GoogleCloudDialogflowV2EncryptionSpec description: >- - Additional info about the select item for when it is triggered in a - dialog. + A customer-managed encryption key specification that can be applied to + all created resources (e.g. Conversation). type: object properties: - key: + name: description: >- - Required. A unique key that will be sent back to the agent if this - response is given. + Immutable. The resource name of the encryption key specification + resource. Format: + projects/{project}/locations/{location}/encryptionSpec type: string - synonyms: + kmsKey: description: >- - Optional. A list of synonyms that can also be used to trigger this - item in dialog. - type: array - items: - type: string - GoogleCloudDialogflowV2beta1IntentMessageCarouselSelect: - id: GoogleCloudDialogflowV2beta1IntentMessageCarouselSelect - description: The card for presenting a carousel of options to select from. + Required. The name of customer-managed encryption key that is used + to secure a resource and its sub-resources. If empty, the resource + is secured by the default Google encryption key. Only the key in the + same location as this resource is allowed to be used for encryption. + Format: + `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}` + type: string + GoogleCloudDialogflowV2CreateConversationDatasetOperationMetadata: + id: GoogleCloudDialogflowV2CreateConversationDatasetOperationMetadata + description: Metadata for CreateConversationDataset. type: object properties: - items: - description: Required. Carousel items. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageCarouselSelectItem - GoogleCloudDialogflowV2beta1IntentMessageCarouselSelectItem: - id: GoogleCloudDialogflowV2beta1IntentMessageCarouselSelectItem - description: An item in the carousel. + conversationDataset: + description: >- + The resource name of the conversation dataset that will be created. + Format: `projects//locations//conversationDatasets/` + type: string + GoogleCloudDialogflowV2ConversationModel: + id: GoogleCloudDialogflowV2ConversationModel + description: Represents a conversation model. type: object properties: - info: - description: Required. Additional info about the option item. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo - title: - description: Required. Title of the carousel item. + name: + description: >- + ConversationModel resource name. Format: + `projects//conversationModels/` type: string - description: - description: Optional. The body text of the card. + displayName: + description: Required. The display name of the model. At most 64 bytes long. type: string - image: - description: Optional. The image to display. - $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageImage' - GoogleCloudDialogflowV2beta1IntentMessageTelephonyPlayAudio: - id: GoogleCloudDialogflowV2beta1IntentMessageTelephonyPlayAudio - description: Plays audio from a file in Telephony Gateway. - type: object - properties: - audioUri: + createTime: + description: Output only. Creation time of this model. + readOnly: true + type: string + format: google-datetime + datasets: + description: Required. Datasets used to create model. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowV2InputDataset' + state: description: >- - Required. URI to a Google Cloud Storage object containing the audio - to play, e.g., "gs://bucket/object". The object must contain a - single channel (mono) of linear PCM audio (2 bytes / sample) at - 8kHz. This object must be readable by the - `service-@gcp-sa-dialogflow.iam.gserviceaccount.com` service account - where is the number of the Telephony Gateway project (usually the - same as the Dialogflow agent project). If the Google Cloud Storage - bucket is in the Telephony Gateway project, this permission is added - by default when enabling the Dialogflow V2 API. For audio from other - sources, consider using the `TelephonySynthesizeSpeech` message with - SSML. + Output only. State of the model. A model can only serve prediction + requests after it gets deployed. + readOnly: true type: string - GoogleCloudDialogflowV2beta1IntentMessageTelephonySynthesizeSpeech: - id: GoogleCloudDialogflowV2beta1IntentMessageTelephonySynthesizeSpeech - description: >- - Synthesizes speech and plays back the synthesized audio to the caller in - Telephony Gateway. Telephony Gateway takes the synthesizer settings from - `DetectIntentResponse.output_audio_config` which can either be set at - request-level or can come from the agent-level synthesizer config. + enumDescriptions: + - Should not be used, an un-set enum has this value by default. + - Model being created. + - Model is not deployed but ready to deploy. + - Model is deploying. + - Model is deployed and ready to use. + - Model is undeploying. + - Model is deleting. + - Model is in error state. Not ready to deploy and use. + - >- + Model is being created but the training has not started, The model + may remain in this state until there is enough capacity to start + training. + enum: + - STATE_UNSPECIFIED + - CREATING + - UNDEPLOYED + - DEPLOYING + - DEPLOYED + - UNDEPLOYING + - DELETING + - FAILED + - PENDING + languageCode: + description: >- + Language code for the conversation model. If not specified, the + language is en-US. Language at ConversationModel should be set for + all non en-us languages. This should be a + [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. + Example: "en-US". + type: string + articleSuggestionModelMetadata: + description: Metadata for article suggestion models. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2ArticleSuggestionModelMetadata + smartReplyModelMetadata: + description: Metadata for smart reply models. + $ref: '#/components/schemas/GoogleCloudDialogflowV2SmartReplyModelMetadata' + satisfiesPzs: + description: >- + Output only. A read only boolean field reflecting Zone Separation + status of the model. + readOnly: true + type: boolean + satisfiesPzi: + description: >- + Output only. A read only boolean field reflecting Zone Isolation + status of the model. + readOnly: true + type: boolean + GoogleCloudDialogflowV2InputDataset: + id: GoogleCloudDialogflowV2InputDataset + description: InputDataset used to create model or do evaluation. NextID:5 type: object properties: - text: - description: The raw text to be synthesized. - type: string - ssml: + dataset: description: >- - The SSML to be synthesized. For more information, see - [SSML](https://developers.google.com/actions/reference/ssml). + Required. ConversationDataset resource name. Format: + `projects//locations//conversationDatasets/` type: string - GoogleCloudDialogflowV2beta1IntentMessageTelephonyTransferCall: - id: GoogleCloudDialogflowV2beta1IntentMessageTelephonyTransferCall - description: Transfers the call in Telephony Gateway. + GoogleCloudDialogflowV2ArticleSuggestionModelMetadata: + id: GoogleCloudDialogflowV2ArticleSuggestionModelMetadata + description: Metadata for article suggestion models. type: object properties: - phoneNumber: + trainingModelType: description: >- - Required. The phone number to transfer the call to in [E.164 - format](https://en.wikipedia.org/wiki/E.164). We currently only - allow transferring to US numbers (+1xxxyyyzzzz). + Optional. Type of the article suggestion model. If not provided, + model_type is used. type: string - GoogleCloudDialogflowV2beta1IntentMessageRbmText: - id: GoogleCloudDialogflowV2beta1IntentMessageRbmText - description: Rich Business Messaging (RBM) text response with suggestions. + enumDescriptions: + - ModelType unspecified. + - ModelType smart reply dual encoder model. + - ModelType smart reply bert model. + enum: + - MODEL_TYPE_UNSPECIFIED + - SMART_REPLY_DUAL_ENCODER_MODEL + - SMART_REPLY_BERT_MODEL + GoogleCloudDialogflowV2SmartReplyModelMetadata: + id: GoogleCloudDialogflowV2SmartReplyModelMetadata + description: Metadata for smart reply models. type: object properties: - text: - description: Required. Text sent and displayed to the user. - type: string - rbmSuggestion: - description: Optional. One or more suggestions to show to the user. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestion - GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestion: - id: GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestion - description: >- - Rich Business Messaging (RBM) suggestion. Suggestions allow user to - easily select/click a predefined response or perform an action (like - opening a web uri). - type: object - properties: - reply: - description: Predefined replies for user to select instead of typing - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedReply - action: - description: Predefined client side actions that user can choose - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedAction - GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedReply: - id: GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedReply - description: >- - Rich Business Messaging (RBM) suggested reply that the user can click - instead of typing in their own response. - type: object - properties: - text: - description: Suggested reply text. - type: string - postbackData: + trainingModelType: description: >- - Opaque payload that the Dialogflow receives in a user event when the - user taps the suggested reply. This data will be also forwarded to - webhook to allow performing custom business logic. + Optional. Type of the smart reply model. If not provided, model_type + is used. type: string - GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedAction: - id: GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedAction - description: >- - Rich Business Messaging (RBM) suggested client-side action that the user - can choose from the card. + enumDescriptions: + - ModelType unspecified. + - ModelType smart reply dual encoder model. + - ModelType smart reply bert model. + enum: + - MODEL_TYPE_UNSPECIFIED + - SMART_REPLY_DUAL_ENCODER_MODEL + - SMART_REPLY_BERT_MODEL + GoogleCloudDialogflowV2CreateConversationModelOperationMetadata: + id: GoogleCloudDialogflowV2CreateConversationModelOperationMetadata + description: Metadata for a ConversationModels.CreateConversationModel operation. type: object properties: - text: - description: Text to display alongside the action. + conversationModel: + description: >- + The resource name of the conversation model. Format: + `projects//conversationModels/` type: string - postbackData: + state: + description: State of CreateConversationModel operation. + type: string + enumDescriptions: + - Invalid. + - >- + Request is submitted, but training has not started yet. The model + may remain in this state until there is enough capacity to start + training. + - The training has succeeded. + - The training has succeeded. + - The training has been cancelled. + - The training is in cancelling state. + - Custom model is training. + enum: + - STATE_UNSPECIFIED + - PENDING + - SUCCEEDED + - FAILED + - CANCELLED + - CANCELLING + - TRAINING + createTime: description: >- - Opaque payload that the Dialogflow receives in a user event when the - user taps the suggested action. This data will be also forwarded to - webhook to allow performing custom business logic. + Timestamp when the request to create conversation model is + submitted. The time is measured on server side. type: string - dial: - description: 'Suggested client side action: Dial a phone number' - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionDial - openUrl: - description: 'Suggested client side action: Open a URI on device' - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionOpenUri - shareLocation: - description: 'Suggested client side action: Share user location' - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionShareLocation - GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionDial: - id: >- - GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionDial - description: >- - Opens the user's default dialer app with the specified phone number but - does not dial automatically. + format: google-datetime + doneTime: + description: The time when the operation finished. + type: string + format: google-datetime + GoogleCloudDialogflowV2DeleteConversationModelOperationMetadata: + id: GoogleCloudDialogflowV2DeleteConversationModelOperationMetadata + description: Metadata for a ConversationModels.DeleteConversationModel operation. type: object properties: - phoneNumber: + conversationModel: description: >- - Required. The phone number to fill in the default dialer app. This - field should be in [E.164](https://en.wikipedia.org/wiki/E.164) - format. An example of a correctly formatted phone number: - +15556767888. + The resource name of the conversation model. Format: + `projects//conversationModels/` type: string - GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionOpenUri: - id: >- - GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionOpenUri - description: >- - Opens the user's default web browser app to the specified uri If the - user has an app installed that is registered as the default handler for - the URL, then this app will be opened instead, and its icon will be used - in the suggested action UI. - type: object - properties: - uri: - description: Required. The uri to open on the user device + createTime: + description: >- + Timestamp when delete conversation model request was created. The + time is measured on server side. type: string - GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionShareLocation: - id: >- - GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionShareLocation - description: >- - Opens the device's location chooser so the user can pick a location to - send back to the agent. - type: object - properties: {} - GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard: - id: GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard - description: >- - Standalone Rich Business Messaging (RBM) rich card. Rich cards allow you - to respond to users with more vivid content, e.g. with media and - suggestions. You can group multiple rich cards into one using - RbmCarouselCard but carousel cards will give you less control over the - card layout. + format: google-datetime + doneTime: + description: The time when the operation finished. + type: string + format: google-datetime + GoogleCloudDialogflowV2DeployConversationModelOperationMetadata: + id: GoogleCloudDialogflowV2DeployConversationModelOperationMetadata + description: Metadata for a ConversationModels.DeployConversationModel operation. type: object properties: - cardOrientation: - description: Required. Orientation of the card. + conversationModel: + description: >- + The resource name of the conversation model. Format: + `projects//conversationModels/` type: string - enumDescriptions: - - Not specified. - - Horizontal layout. - - Vertical layout. - enum: - - CARD_ORIENTATION_UNSPECIFIED - - HORIZONTAL - - VERTICAL - thumbnailImageAlignment: + createTime: description: >- - Required if orientation is horizontal. Image preview alignment for - standalone cards with horizontal layout. + Timestamp when request to deploy conversation model was submitted. + The time is measured on server side. type: string - enumDescriptions: - - Not specified. - - Thumbnail preview is left-aligned. - - Thumbnail preview is right-aligned. - enum: - - THUMBNAIL_IMAGE_ALIGNMENT_UNSPECIFIED - - LEFT - - RIGHT - cardContent: - description: Required. Card content. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageRbmCardContent - GoogleCloudDialogflowV2beta1IntentMessageRbmCardContent: - id: GoogleCloudDialogflowV2beta1IntentMessageRbmCardContent - description: Rich Business Messaging (RBM) Card content + format: google-datetime + doneTime: + description: The time when the operation finished. + type: string + format: google-datetime + GoogleCloudDialogflowV2UndeployConversationModelOperationMetadata: + id: GoogleCloudDialogflowV2UndeployConversationModelOperationMetadata + description: Metadata for a ConversationModels.UndeployConversationModel operation. type: object properties: - title: + conversationModel: description: >- - Optional. Title of the card (at most 200 bytes). At least one of the - title, description or media must be set. + The resource name of the conversation model. Format: + `projects//conversationModels/` type: string - description: + createTime: description: >- - Optional. Description of the card (at most 2000 bytes). At least one - of the title, description or media must be set. + Timestamp when the request to undeploy conversation model was + submitted. The time is measured on server side. type: string - media: - description: >- - Optional. However at least one of the title, description or media - must be set. Media (image, GIF or a video) to include in the card. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageRbmCardContentRbmMedia - suggestions: - description: Optional. List of suggestions to include in the card. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestion - GoogleCloudDialogflowV2beta1IntentMessageRbmCardContentRbmMedia: - id: GoogleCloudDialogflowV2beta1IntentMessageRbmCardContentRbmMedia + format: google-datetime + doneTime: + description: The time when the operation finished. + type: string + format: google-datetime + GoogleCloudDialogflowV2CreateConversationModelEvaluationOperationMetadata: + id: >- + GoogleCloudDialogflowV2CreateConversationModelEvaluationOperationMetadata description: >- - Rich Business Messaging (RBM) Media displayed in Cards The following - media-types are currently supported: Image Types * image/jpeg * - image/jpg' * image/gif * image/png Video Types * video/h263 * video/m4v - * video/mp4 * video/mpeg * video/mpeg4 * video/webm + Metadata for a ConversationModels.CreateConversationModelEvaluation + operation. type: object properties: - fileUri: + conversationModelEvaluation: description: >- - Required. Publicly reachable URI of the file. The RBM platform - determines the MIME type of the file from the content-type field in - the HTTP headers when the platform fetches the file. The - content-type field must be present and accurate in the HTTP response - from the URL. + The resource name of the conversation model. Format: + `projects//locations//conversationModels//evaluations/` type: string - thumbnailUri: + conversationModel: description: >- - Optional. Publicly reachable URI of the thumbnail.If you don't - provide a thumbnail URI, the RBM platform displays a blank - placeholder thumbnail until the user's device downloads the file. - Depending on the user's setting, the file may not download - automatically and may require the user to tap a download button. + The resource name of the conversation model. Format: + `projects//locations//conversationModels/` type: string - height: - description: >- - Required for cards with vertical orientation. The height of the - media within a rich card with a vertical layout. For a standalone - card with horizontal layout, height is not customizable, and this - field is ignored. + state: + description: State of CreateConversationModel operation. type: string enumDescriptions: - - Not specified. - - 112 DP. - - 168 DP. - - >- - 264 DP. Not available for rich card carousels when the card width - is set to small. + - Operation status not specified. + - The operation is being prepared. + - The operation is running. + - The operation is cancelled. + - The operation has succeeded. + - The operation has failed. enum: - - HEIGHT_UNSPECIFIED - - SHORT - - MEDIUM - - TALL - GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard: - id: GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard - description: >- - Carousel Rich Business Messaging (RBM) rich card. Rich cards allow you - to respond to users with more vivid content, e.g. with media and - suggestions. If you want to show a single card with more control over - the layout, please use RbmStandaloneCard instead. + - STATE_UNSPECIFIED + - INITIALIZING + - RUNNING + - CANCELLED + - SUCCEEDED + - FAILED + createTime: + description: >- + Timestamp when the request to create conversation model was + submitted. The time is measured on server side. + type: string + format: google-datetime + GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesResponse: + id: GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesResponse + description: The response message for EntityTypes.BatchUpdateEntityTypes. type: object properties: - cardWidth: - description: Required. The width of the cards in the carousel. - type: string - enumDescriptions: - - Not specified. - - 120 DP. Note that tall media cannot be used. - - 232 DP. - enum: - - CARD_WIDTH_UNSPECIFIED - - SMALL - - MEDIUM - cardContents: - description: >- - Required. The cards in the carousel. A carousel must have at least 2 - cards and at most 10. + entityTypes: + description: The collection of updated or created entity types. type: array items: - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageRbmCardContent - GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCard: - id: GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCard + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1EntityType' + GoogleCloudDialogflowV2beta1EntityType: + id: GoogleCloudDialogflowV2beta1EntityType description: >- - Browse Carousel Card for Actions on Google. - https://developers.google.com/actions/assistant/responses#browsing_carousel + Each intent parameter has a type, called the entity type, which dictates + exactly how data from an end-user expression is extracted. Dialogflow + provides predefined system entities that can match many common types of + data. For example, there are system entities for matching dates, times, + colors, email addresses, and so on. You can also create your own custom + entities for matching custom data. For example, you could define a + vegetable entity that can match the types of vegetables available for + purchase with a grocery store agent. For more information, see the + [Entity + guide](https://cloud.google.com/dialogflow/docs/entities-overview). type: object properties: - items: - description: >- - Required. List of items in the Browse Carousel Card. Minimum of two - items, maximum of ten. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItem - imageDisplayOptions: + name: description: >- - Optional. Settings for displaying the image. Applies to every image - in items. + The unique identifier of the entity type. Required for + EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes + methods. Supported formats: - `projects//agent/entityTypes/` - + `projects//locations//agent/entityTypes/` + type: string + displayName: + description: Required. The name of the entity type. + type: string + kind: + description: Required. Indicates the kind of entity type. type: string enumDescriptions: + - Not specified. This value should be never used. - >- - Fill the gaps between the image and the image container with gray - bars. - - >- - Fill the gaps between the image and the image container with gray - bars. + Map entity types allow mapping of a group of synonyms to a + reference value. - >- - Fill the gaps between the image and the image container with white - bars. + List entity types contain a set of entries that do not map to + reference values. However, list entity types can contain + references to other entity types (with or without aliases). - >- - Image is scaled such that the image width and height match or - exceed the container dimensions. This may crop the top and bottom - of the image if the scaled image height is greater than the - container height, or crop the left and right of the image if the - scaled image width is greater than the container width. This is - similar to "Zoom Mode" on a widescreen TV when playing a 4:3 - video. + Regexp entity types allow to specify regular expressions in + entries values. + enum: + - KIND_UNSPECIFIED + - KIND_MAP + - KIND_LIST + - KIND_REGEXP + autoExpansionMode: + description: >- + Optional. Indicates whether the entity type can be automatically + expanded. + type: string + enumDescriptions: + - Auto expansion disabled for the entity. - >- - Pad the gaps between image and image frame with a blurred copy of - the same image. + Allows an agent to recognize values that have not been explicitly + listed in the entity. enum: - - IMAGE_DISPLAY_OPTIONS_UNSPECIFIED - - GRAY - - WHITE - - CROPPED - - BLURRED_BACKGROUND - GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItem: - id: >- - GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItem - description: Browsing carousel tile + - AUTO_EXPANSION_MODE_UNSPECIFIED + - AUTO_EXPANSION_MODE_DEFAULT + entities: + description: >- + Optional. The collection of entity entries associated with the + entity type. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1EntityTypeEntity' + enableFuzzyExtraction: + description: Optional. Enables fuzzy entity extraction during classification. + type: boolean + GoogleCloudDialogflowV2beta1EntityTypeEntity: + id: GoogleCloudDialogflowV2beta1EntityTypeEntity + description: An **entity entry** for an associated entity type. type: object properties: - openUriAction: - description: Required. Action to present to the user. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction - title: - description: Required. Title of the carousel item. Maximum of two lines of text. - type: string - description: + value: description: >- - Optional. Description of the carousel item. Maximum of four lines of - text. + Required. The primary value associated with this entity entry. For + example, if the entity type is *vegetable*, the value could be + *scallions*. For `KIND_MAP` entity types: * A reference value to be + used in place of synonyms. For `KIND_LIST` entity types: * A string + that can contain references to other entity types (with or without + aliases). type: string - image: - description: Optional. Hero image for the carousel item. - $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageImage' - footer: + synonyms: description: >- - Optional. Text that appears at the bottom of the Browse Carousel - Card. Maximum of one line of text. - type: string - GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction: - id: >- - GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction - description: Actions on Google action to open a given url. + Required. A collection of value synonyms. For example, if the entity + type is *vegetable*, and `value` is *scallions*, a synonym could be + *green onions*. For `KIND_LIST` entity types: * This collection must + contain exactly one synonym equal to `value`. + type: array + items: + type: string + GoogleCloudDialogflowV2beta1BatchUpdateIntentsResponse: + id: GoogleCloudDialogflowV2beta1BatchUpdateIntentsResponse + description: The response message for Intents.BatchUpdateIntents. type: object properties: - url: - description: Required. URL - type: string - urlTypeHint: + intents: + description: The collection of updated or created intents. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1Intent' + GoogleCloudDialogflowV2beta1Intent: + id: GoogleCloudDialogflowV2beta1Intent + description: >- + An intent categorizes an end-user's intention for one conversation turn. + For each agent, you define many intents, where your combined intents can + handle a complete conversation. When an end-user writes or says + something, referred to as an end-user expression or end-user input, + Dialogflow matches the end-user input to the best intent in your agent. + Matching an intent is also known as intent classification. For more + information, see the [intent + guide](https://cloud.google.com/dialogflow/docs/intents-overview). + type: object + properties: + name: description: >- - Optional. Specifies the type of viewer that is used when opening the - URL. Defaults to opening via web browser. + Optional. The unique identifier of this intent. Required for + Intents.UpdateIntent and Intents.BatchUpdateIntents methods. + Supported formats: - `projects//agent/intents/` - + `projects//locations//agent/intents/` + type: string + displayName: + description: Required. The name of this intent. + type: string + webhookState: + description: Optional. Indicates whether webhooks are enabled for the intent. type: string enumDescriptions: - - Unspecified - - Url would be an amp action + - Webhook is disabled in the agent and in the intent. + - Webhook is enabled in the agent and in the intent. - >- - URL that points directly to AMP content, or to a canonical URL - which refers to AMP content via . + Webhook is enabled in the agent and in the intent. Also, each slot + filling prompt is forwarded to the webhook. enum: - - URL_TYPE_HINT_UNSPECIFIED - - AMP_ACTION - - AMP_CONTENT - GoogleCloudDialogflowV2beta1IntentMessageTableCard: - id: GoogleCloudDialogflowV2beta1IntentMessageTableCard - description: Table card for Actions on Google. - type: object - properties: - title: - description: Required. Title of the card. - type: string - subtitle: - description: Optional. Subtitle to the title. - type: string - image: - description: Optional. Image which should be displayed on the card. - $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageImage' - columnProperties: - description: Optional. Display properties for the columns in this table. + - WEBHOOK_STATE_UNSPECIFIED + - WEBHOOK_STATE_ENABLED + - WEBHOOK_STATE_ENABLED_FOR_SLOT_FILLING + priority: + description: >- + Optional. The priority of this intent. Higher numbers represent + higher priorities. - If the supplied value is unspecified or 0, the + service translates the value to 500,000, which corresponds to the + `Normal` priority in the console. - If the supplied value is + negative, the intent is ignored in runtime detect intent requests. + type: integer + format: int32 + isFallback: + description: Optional. Indicates whether this is a fallback intent. + type: boolean + mlEnabled: + description: >- + Optional. Indicates whether Machine Learning is enabled for the + intent. Note: If `ml_enabled` setting is set to false, then this + intent is not taken into account during inference in `ML ONLY` match + mode. Also, auto-markup in the UI is turned off. DEPRECATED! Please + use `ml_disabled` field instead. NOTE: If both `ml_enabled` and + `ml_disabled` are either not set or false, then the default value is + determined as follows: - Before April 15th, 2018 the default is: + ml_enabled = false / ml_disabled = true. - After April 15th, 2018 + the default is: ml_enabled = true / ml_disabled = false. + deprecated: true + type: boolean + mlDisabled: + description: >- + Optional. Indicates whether Machine Learning is disabled for the + intent. Note: If `ml_disabled` setting is set to true, then this + intent is not taken into account during inference in `ML ONLY` match + mode. Also, auto-markup in the UI is turned off. + type: boolean + liveAgentHandoff: + description: >- + Optional. Indicates that a live agent should be brought in to handle + the interaction with the user. In most cases, when you set this flag + to true, you would also want to set end_interaction to true as well. + Default is false. + type: boolean + endInteraction: + description: >- + Optional. Indicates that this intent ends an interaction. Some + integrations (e.g., Actions on Google or Dialogflow phone gateway) + use this information to close interaction with an end user. Default + is false. + type: boolean + inputContextNames: + description: >- + Optional. The list of context names required for this intent to be + triggered. Formats: - `projects//agent/sessions/-/contexts/` - + `projects//locations//agent/sessions/-/contexts/` type: array items: - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageColumnProperties - rows: - description: Optional. Rows in this table of data. + type: string + events: + description: >- + Optional. The collection of event names that trigger the intent. If + the collection of input contexts is not empty, all of the contexts + must be present in the active user session for an event to trigger + this intent. Event names are limited to 150 characters. type: array items: - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageTableCardRow - buttons: - description: Optional. List of buttons for the card. + type: string + trainingPhrases: + description: Optional. The collection of examples that the agent is trained on. type: array items: $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageBasicCardButton - GoogleCloudDialogflowV2beta1IntentMessageColumnProperties: - id: GoogleCloudDialogflowV2beta1IntentMessageColumnProperties - description: Column properties for TableCard. - type: object - properties: - header: - description: Required. Column heading. - type: string - horizontalAlignment: - description: Optional. Defines text alignment for all cells in this column. + #/components/schemas/GoogleCloudDialogflowV2beta1IntentTrainingPhrase + action: + description: >- + Optional. The name of the action associated with the intent. Note: + The action name must not contain whitespaces. type: string - enumDescriptions: - - Text is aligned to the leading edge of the column. - - Text is aligned to the leading edge of the column. - - Text is centered in the column. - - Text is aligned to the trailing edge of the column. - enum: - - HORIZONTAL_ALIGNMENT_UNSPECIFIED - - LEADING - - CENTER - - TRAILING - GoogleCloudDialogflowV2beta1IntentMessageTableCardRow: - id: GoogleCloudDialogflowV2beta1IntentMessageTableCardRow - description: Row of TableCard. - type: object - properties: - cells: - description: Optional. List of cells that make up this row. + outputContexts: + description: >- + Optional. The collection of contexts that are activated when the + intent is matched. Context messages in this collection should not + set the parameters field. Setting the `lifespan_count` to 0 will + reset the context when the intent is matched. Format: + `projects//agent/sessions/-/contexts/`. type: array items: - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageTableCardCell - dividerAfter: - description: Optional. Whether to add a visual divider after this row. + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1Context' + resetContexts: + description: >- + Optional. Indicates whether to delete all contexts in the current + session when this intent is matched. type: boolean - GoogleCloudDialogflowV2beta1IntentMessageTableCardCell: - id: GoogleCloudDialogflowV2beta1IntentMessageTableCardCell - description: Cell of TableCardRow. - type: object - properties: - text: - description: Required. Text in this cell. + parameters: + description: Optional. The collection of parameters associated with the intent. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1IntentParameter' + messages: + description: >- + Optional. The collection of rich messages corresponding to the + `Response` field in the Dialogflow console. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1IntentMessage' + defaultResponsePlatforms: + description: >- + Optional. The list of platforms for which the first responses will + be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default + platform). + type: array + items: + type: string + enumDescriptions: + - Not specified. + - Facebook. + - Slack. + - Telegram. + - Kik. + - Skype. + - Line. + - Viber. + - >- + Google Assistant See [Dialogflow webhook + format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json) + - Telephony Gateway. + - Google Hangouts. + enum: + - PLATFORM_UNSPECIFIED + - FACEBOOK + - SLACK + - TELEGRAM + - KIK + - SKYPE + - LINE + - VIBER + - ACTIONS_ON_GOOGLE + - TELEPHONY + - GOOGLE_HANGOUTS + rootFollowupIntentName: + description: >- + Output only. The unique identifier of the root intent in the chain + of followup intents. It identifies the correct followup intents + chain for this intent. Format: `projects//agent/intents/`. + readOnly: true type: string - GoogleCloudDialogflowV2beta1IntentMessageMediaContent: - id: GoogleCloudDialogflowV2beta1IntentMessageMediaContent - description: The media content card for Actions on Google. - type: object - properties: - mediaType: - description: Optional. What type of media is the content (ie "audio"). + parentFollowupIntentName: + description: >- + Optional. The unique identifier of the parent intent in the chain of + followup intents. You can set this field when creating an intent, + for example with CreateIntent or BatchUpdateIntents, in order to + make this intent a followup intent. It identifies the parent + followup intent. Format: `projects//agent/intents/`. type: string - enumDescriptions: - - Unspecified. - - Response media type is audio. - enum: - - RESPONSE_MEDIA_TYPE_UNSPECIFIED - - AUDIO - mediaObjects: - description: Required. List of media objects. + followupIntentInfo: + description: >- + Output only. Information about all followup intents that have this + intent as a direct or indirect parent. We populate this field only + in the output. + readOnly: true type: array items: $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageMediaContentResponseMediaObject - GoogleCloudDialogflowV2beta1IntentMessageMediaContentResponseMediaObject: - id: GoogleCloudDialogflowV2beta1IntentMessageMediaContentResponseMediaObject - description: Response media object for media content card. + #/components/schemas/GoogleCloudDialogflowV2beta1IntentFollowupIntentInfo + GoogleCloudDialogflowV2beta1IntentTrainingPhrase: + id: GoogleCloudDialogflowV2beta1IntentTrainingPhrase + description: Represents an example that the agent is trained on. type: object properties: name: - description: Required. Name of media card. - type: string - description: - description: Optional. Description of media card. - type: string - largeImage: - description: Optional. Image to display above media content. - $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageImage' - icon: - description: Optional. Icon to display above media content. - $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageImage' - contentUrl: - description: Required. Url where the media is stored. + description: Output only. The unique identifier of this training phrase. + readOnly: true type: string - GoogleCloudDialogflowV2beta1IntentFollowupIntentInfo: - id: GoogleCloudDialogflowV2beta1IntentFollowupIntentInfo - description: Represents a single followup intent in the chain. - type: object - properties: - followupIntentName: - description: >- - The unique identifier of the followup intent. Format: - `projects//agent/intents/`. - type: string - parentFollowupIntentName: - description: >- - The unique identifier of the followup intent's parent. Format: - `projects//agent/intents/`. - type: string - GoogleCloudDialogflowV2beta1ClearSuggestionFeatureConfigOperationMetadata: - id: >- - GoogleCloudDialogflowV2beta1ClearSuggestionFeatureConfigOperationMetadata - description: >- - Metadata for a ConversationProfile.ClearSuggestionFeatureConfig - operation. - type: object - properties: - conversationProfile: - description: >- - The resource name of the conversation profile. Format: - `projects//locations//conversationProfiles/` - type: string - participantRole: - description: >- - Required. The participant role to remove the suggestion feature - config. Only HUMAN_AGENT or END_USER can be used. - type: string - enumDescriptions: - - Participant role not set. - - Participant is a human agent. - - Participant is an automated agent, such as a Dialogflow agent. - - >- - Participant is an end user that has called or chatted with - Dialogflow services. - enum: - - ROLE_UNSPECIFIED - - HUMAN_AGENT - - AUTOMATED_AGENT - - END_USER - suggestionFeatureType: - description: Required. The type of the suggestion feature to remove. + type: + description: Required. The type of the training phrase. type: string enumDescriptions: - - Unspecified feature type. - - Run article suggestion model for chat. - - Run FAQ model. - - Run smart reply model for chat. + - Not specified. This value should never be used. - >- - Run Dialogflow assist model for chat, which will return automated - agent response as suggestion. - - Run conversation summarization model for chat. + Examples do not contain @-prefixed entity type names, but example + parts can be annotated with entity types. - >- - Run knowledge search with text input from agent or text generated - query. - - Run knowledge assist with automatic query generation. + Templates are not annotated with entity types, but they can + contain @-prefixed entity type names as substrings. Note: Template + mode has been deprecated. Example mode is the only supported way + to create new training phrases. If you have existing training + phrases in template mode, they will be removed during training and + it can cause a drop in agent performance. + enumDeprecated: + - false + - false + - true enum: - TYPE_UNSPECIFIED - - ARTICLE_SUGGESTION - - FAQ - - SMART_REPLY - - DIALOGFLOW_ASSIST - - CONVERSATION_SUMMARIZATION - - KNOWLEDGE_SEARCH - - KNOWLEDGE_ASSIST - createTime: + - EXAMPLE + - TEMPLATE + parts: description: >- - Timestamp whe the request was created. The time is measured on - server side. - type: string - format: google-datetime - GoogleCloudDialogflowV2beta1ConversationEvent: - id: GoogleCloudDialogflowV2beta1ConversationEvent - description: >- - Represents a notification sent to Pub/Sub subscribers for conversation - lifecycle events. + Required. The ordered list of training phrase parts. The parts are + concatenated in order to form the training phrase. Note: The API + does not automatically annotate training phrases like the Dialogflow + Console does. Note: Do not forget to include whitespace at part + boundaries, so the training phrase is well formatted when the parts + are concatenated. If the training phrase does not need to be + annotated with parameters, you just need a single part with only the + Part.text field set. If you want to annotate the training phrase, + you must create multiple parts, where the fields of each part are + populated in one of two ways: - `Part.text` is set to a part of the + phrase that has no parameters. - `Part.text` is set to a part of the + phrase that you want to annotate, and the `entity_type`, `alias`, + and `user_defined` fields are all set. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1IntentTrainingPhrasePart + timesAddedCount: + description: >- + Optional. Indicates how many times this example was added to the + intent. Each time a developer adds an existing sample by editing an + intent or training, this counter is increased. + type: integer + format: int32 + GoogleCloudDialogflowV2beta1IntentTrainingPhrasePart: + id: GoogleCloudDialogflowV2beta1IntentTrainingPhrasePart + description: Represents a part of a training phrase. type: object properties: - conversation: + text: + description: Required. The text for this part. + type: string + entityType: description: >- - Required. The unique identifier of the conversation this - notification refers to. Format: `projects//conversations/`. + Optional. The entity type name prefixed with `@`. This field is + required for annotated parts of the training phrase. type: string - type: - description: Required. The type of the event that this notification refers to. + alias: + description: >- + Optional. The parameter name for the value extracted from the + annotated part of the example. This field is required for annotated + parts of the training phrase. type: string - enumDescriptions: - - Type not set. - - >- - A new conversation has been opened. This is fired when a telephone - call is answered, or a conversation is created via the API. - - >- - An existing conversation has closed. This is fired when a - telephone call is terminated, or a conversation is closed via the - API. - - >- - An existing conversation has received notification from Dialogflow - that human intervention is required. - - >- - An existing conversation has received a new message, either from - API or telephony. It is configured in - ConversationProfile.new_message_event_notification_config - - >- - Unrecoverable error during a telephone call. In general - non-recoverable errors only occur if something was misconfigured - in the ConversationProfile corresponding to the call. After a - non-recoverable error, Dialogflow may stop responding. We don't - fire this event: * in an API call because we can directly return - the error, or, * when we can recover from an error. - enum: - - TYPE_UNSPECIFIED - - CONVERSATION_STARTED - - CONVERSATION_FINISHED - - HUMAN_INTERVENTION_NEEDED - - NEW_MESSAGE - - UNRECOVERABLE_ERROR - errorStatus: + userDefined: description: >- - Optional. More detailed information about an error. Only set for - type UNRECOVERABLE_ERROR_IN_PHONE_CALL. - $ref: '#/components/schemas/GoogleRpcStatus' - newMessagePayload: - description: Payload of NEW_MESSAGE event. - $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1Message' - GoogleCloudDialogflowV2beta1Message: - id: GoogleCloudDialogflowV2beta1Message - description: Represents a message posted into a conversation. + Optional. Indicates whether the text was manually annotated. This + field is set to true when the Dialogflow Console is used to manually + annotate the part. When creating an annotated part with the API, you + must set this to true. + type: boolean + GoogleCloudDialogflowV2beta1Context: + id: GoogleCloudDialogflowV2beta1Context + description: >- + Dialogflow contexts are similar to natural language context. If a person + says to you "they are orange", you need context in order to understand + what "they" is referring to. Similarly, for Dialogflow to handle an + end-user expression like that, it needs to be provided with context in + order to correctly match an intent. Using contexts, you can control the + flow of a conversation. You can configure contexts for an intent by + setting input and output contexts, which are identified by string names. + When an intent is matched, any configured output contexts for that + intent become active. While any contexts are active, Dialogflow is more + likely to match intents that are configured with input contexts that + correspond to the currently active contexts. For more information about + context, see the [Contexts + guide](https://cloud.google.com/dialogflow/docs/contexts-overview). type: object properties: name: description: >- - Optional. The unique identifier of the message. Format: - `projects//locations//conversations//messages/`. - type: string - content: - description: Required. The message content. + Required. The unique identifier of the context. Supported formats: - + `projects//agent/sessions//contexts/`, - + `projects//locations//agent/sessions//contexts/`, - + `projects//agent/environments//users//sessions//contexts/`, - + `projects//locations//agent/environments//users//sessions//contexts/`, + The `Context ID` is always converted to lowercase, may only contain + characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long. If + `Environment ID` is not specified, we assume default 'draft' + environment. If `User ID` is not specified, we assume default '-' + user. The following context names are reserved for internal use by + Dialogflow. You should not use these contexts or create contexts + with these names: * `__system_counters__` * `*_id_dialog_context` * + `*_dialog_params_size` type: string - responseMessages: - description: Optional. Automated agent responses. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1ResponseMessage' - languageCode: + lifespanCount: description: >- - Optional. The message language. This should be a - [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. - Example: "en-US". + Optional. The number of conversational query requests after which + the context expires. The default is `0`. If set to `0`, the context + expires immediately. Contexts expire automatically after 20 minutes + if there are no matching queries. + type: integer + format: int32 + parameters: + description: >- + Optional. The collection of parameters associated with this context. + Depending on your protocol or client library language, this is a + map, associative array, symbol table, dictionary, or JSON object + composed of a collection of (MapKey, MapValue) pairs: * MapKey type: + string * MapKey value: parameter name * MapValue type: If + parameter's entity type is a composite entity then use map, + otherwise, depending on the parameter value type, it could be one of + string, number, boolean, null, list or map. * MapValue value: If + parameter's entity type is a composite entity then use map from + composite entity property names to property values, otherwise, use + parameter value. + type: object + additionalProperties: + type: any + description: Properties of the object. + GoogleCloudDialogflowV2beta1IntentParameter: + id: GoogleCloudDialogflowV2beta1IntentParameter + description: Represents intent parameters. + type: object + properties: + name: + description: The unique identifier of this parameter. type: string - participant: - description: Output only. The participant that sends this message. - readOnly: true + displayName: + description: Required. The name of the parameter. type: string - participantRole: - description: Output only. The role of the participant. - readOnly: true + value: + description: >- + Optional. The definition of the parameter value. It can be: - a + constant string, - a parameter value defined as `$parameter_name`, - + an original parameter value defined as `$parameter_name.original`, - + a parameter value from some context defined as + `#context_name.parameter_name`. type: string - enumDescriptions: - - Participant role not set. - - Participant is a human agent. - - Participant is an automated agent, such as a Dialogflow agent. - - >- - Participant is an end user that has called or chatted with - Dialogflow services. - enum: - - ROLE_UNSPECIFIED - - HUMAN_AGENT - - AUTOMATED_AGENT - - END_USER - createTime: + defaultValue: description: >- - Output only. The time when the message was created in Contact Center - AI. - readOnly: true + Optional. The default value to use when the `value` yields an empty + result. Default values can be extracted from contexts by using the + following syntax: `#context_name.parameter_name`. type: string - format: google-datetime - sendTime: - description: Optional. The time when the message was sent. + entityTypeDisplayName: + description: >- + Optional. The name of the entity type, prefixed with `@`, that + describes values of the parameter. If the parameter is required, + this must be provided. type: string - format: google-datetime - messageAnnotation: - description: Output only. The annotation for the message. - readOnly: true - $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1MessageAnnotation' - sentimentAnalysis: - description: Output only. The sentiment analysis result for the message. - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1SentimentAnalysisResult - GoogleCloudDialogflowV2beta1ResponseMessage: - id: GoogleCloudDialogflowV2beta1ResponseMessage - description: Response messages from an automated agent. + mandatory: + description: >- + Optional. Indicates whether the parameter is required. That is, + whether the intent cannot be completed without collecting the + parameter value. + type: boolean + prompts: + description: >- + Optional. The collection of prompts that the agent can present to + the user in order to collect a value for the parameter. + type: array + items: + type: string + isList: + description: >- + Optional. Indicates whether the parameter represents a list of + values. + type: boolean + GoogleCloudDialogflowV2beta1IntentMessage: + id: GoogleCloudDialogflowV2beta1IntentMessage + description: Corresponds to the `Response` field in the Dialogflow console. type: object properties: text: description: Returns a text response. - $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1ResponseMessageText' + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageText' + image: + description: Displays an image. + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageImage' + quickReplies: + description: Displays quick replies. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageQuickReplies + card: + description: Displays a card. + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageCard' payload: - description: Returns a response containing a custom, platform-specific payload. + description: A custom platform-specific response. type: object additionalProperties: type: any description: Properties of the object. - liveAgentHandoff: - description: Hands off conversation to a live agent. + simpleResponses: + description: Returns a voice or text-only response for Actions on Google. $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff - endInteraction: - description: >- - A signal that indicates the interaction with the Dialogflow agent - has ended. + #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageSimpleResponses + basicCard: + description: Displays a basic card for Actions on Google. $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction - mixedAudio: - description: >- - An audio response message composed of both the synthesized - Dialogflow agent responses and the audios hosted in places known to - the client. + #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageBasicCard + suggestions: + description: Displays suggestion chips for Actions on Google. $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio + #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageSuggestions + linkOutSuggestion: + description: Displays a link out suggestion chip for Actions on Google. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageLinkOutSuggestion + listSelect: + description: Displays a list card for Actions on Google. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageListSelect + carouselSelect: + description: Displays a carousel card for Actions on Google. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageCarouselSelect + telephonyPlayAudio: + description: Plays audio from a file in Telephony Gateway. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageTelephonyPlayAudio + telephonySynthesizeSpeech: + description: Synthesizes speech in Telephony Gateway. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageTelephonySynthesizeSpeech telephonyTransferCall: + description: Transfers the call in Telephony Gateway. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageTelephonyTransferCall + rbmText: description: >- - A signal that the client should transfer the phone call connected to - this agent to a third-party endpoint. + Rich Business Messaging (RBM) text response. RBM allows businesses + to send enriched and branded versions of SMS. See + https://jibe.google.com/business-messaging. $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall - GoogleCloudDialogflowV2beta1ResponseMessageText: - id: GoogleCloudDialogflowV2beta1ResponseMessageText + #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageRbmText + rbmStandaloneRichCard: + description: Standalone Rich Business Messaging (RBM) rich card response. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard + rbmCarouselRichCard: + description: Rich Business Messaging (RBM) carousel rich card response. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard + browseCarouselCard: + description: Browse carousel card for Actions on Google. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCard + tableCard: + description: Table card for Actions on Google. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageTableCard + mediaContent: + description: The media content card for Actions on Google. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageMediaContent + platform: + description: Optional. The platform that this message is intended for. + type: string + enumDescriptions: + - Not specified. + - Facebook. + - Slack. + - Telegram. + - Kik. + - Skype. + - Line. + - Viber. + - >- + Google Assistant See [Dialogflow webhook + format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json) + - Telephony Gateway. + - Google Hangouts. + enum: + - PLATFORM_UNSPECIFIED + - FACEBOOK + - SLACK + - TELEGRAM + - KIK + - SKYPE + - LINE + - VIBER + - ACTIONS_ON_GOOGLE + - TELEPHONY + - GOOGLE_HANGOUTS + GoogleCloudDialogflowV2beta1IntentMessageText: + id: GoogleCloudDialogflowV2beta1IntentMessageText description: The text response message. type: object properties: text: - description: >- - A collection of text response variants. If multiple variants are - defined, only one text response variant is returned at runtime. + description: Optional. The collection of the agent's responses. type: array items: type: string - GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff: - id: GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff - description: >- - Indicates that the conversation should be handed off to a human agent. - Dialogflow only uses this to determine which conversations were handed - off to a human agent for measurement purposes. What else to do with this - signal is up to you and your handoff procedures. You may set this, for - example: * In the entry fulfillment of a CX Page if entering the page - indicates something went extremely wrong in the conversation. * In a - webhook response when you determine that the customer issue can only be - handled by a human. + GoogleCloudDialogflowV2beta1IntentMessageImage: + id: GoogleCloudDialogflowV2beta1IntentMessageImage + description: The image response message. type: object properties: - metadata: + imageUri: + description: Optional. The public URI to an image file. + type: string + accessibilityText: description: >- - Custom metadata for your handoff procedure. Dialogflow doesn't - impose any structure on this. - type: object - additionalProperties: - type: any - description: Properties of the object. - GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction: - id: GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction - description: Indicates that interaction with the Dialogflow agent has ended. - type: object - properties: {} - GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio: - id: GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio - description: >- - Represents an audio message that is composed of both segments - synthesized from the Dialogflow agent prompts and ones hosted externally - at the specified URIs. + A text description of the image to be used for accessibility, e.g., + screen readers. Required if image_uri is set for CarouselSelect. + type: string + GoogleCloudDialogflowV2beta1IntentMessageQuickReplies: + id: GoogleCloudDialogflowV2beta1IntentMessageQuickReplies + description: The quick replies response message. type: object properties: - segments: - description: Segments this audio response is composed of. + title: + description: Optional. The title of the collection of quick replies. + type: string + quickReplies: + description: Optional. The collection of quick replies. type: array items: - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment - GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment: - id: GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment - description: Represents one segment of audio. + type: string + GoogleCloudDialogflowV2beta1IntentMessageCard: + id: GoogleCloudDialogflowV2beta1IntentMessageCard + description: The card response message. type: object properties: - audio: - description: >- - Raw audio synthesized from the Dialogflow agent's response using the - output config specified in the request. + title: + description: Optional. The title of the card. type: string - format: byte - uri: - description: >- - Client-specific URI that points to an audio clip accessible to the - client. + subtitle: + description: Optional. The subtitle of the card. type: string - allowPlaybackInterruption: - description: >- - Whether the playback of this segment can be interrupted by the end - user's speech and the client should then start the next Dialogflow - request. - type: boolean - GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall: - id: GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall - description: >- - Represents the signal that telles the client to transfer the phone call - connected to the agent to a third-party endpoint. - type: object - properties: - phoneNumber: - description: >- - Transfer the call to a phone number in [E.164 - format](https://en.wikipedia.org/wiki/E.164). - type: string - sipUri: - description: Transfer the call to a SIP endpoint. + imageUri: + description: Optional. The public URI to an image file for the card. type: string - GoogleCloudDialogflowV2beta1MessageAnnotation: - id: GoogleCloudDialogflowV2beta1MessageAnnotation - description: Represents the result of annotation for the message. - type: object - properties: - parts: - description: >- - Optional. The collection of annotated message parts ordered by their - position in the message. You can recover the annotated message by - concatenating [AnnotatedMessagePart.text]. + buttons: + description: Optional. The collection of card buttons. type: array items: $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1AnnotatedMessagePart - containEntities: - description: Required. Indicates whether the text message contains entities. - type: boolean - GoogleCloudDialogflowV2beta1AnnotatedMessagePart: - id: GoogleCloudDialogflowV2beta1AnnotatedMessagePart - description: >- - Represents a part of a message possibly annotated with an entity. The - part can be an entity or purely a part of the message between two - entities or message start/end. + #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageCardButton + GoogleCloudDialogflowV2beta1IntentMessageCardButton: + id: GoogleCloudDialogflowV2beta1IntentMessageCardButton + description: Optional. Contains information about a button. type: object properties: text: - description: Required. A part of a message possibly annotated with an entity. + description: Optional. The text to show on the button. type: string - entityType: + postback: description: >- - Optional. The [Dialogflow system entity - type](https://cloud.google.com/dialogflow/docs/reference/system-entities) - of this message part. If this is empty, Dialogflow could not - annotate the phrase part with a system entity. + Optional. The text to send back to the Dialogflow API or a URI to + open. type: string - formattedValue: - description: >- - Optional. The [Dialogflow system entity formatted value - ](https://cloud.google.com/dialogflow/docs/reference/system-entities) - of this message part. For example for a system entity of type - `@sys.unit-currency`, this may contain: { "amount": 5, "currency": - "USD" } - type: any - GoogleCloudDialogflowV2beta1SentimentAnalysisResult: - id: GoogleCloudDialogflowV2beta1SentimentAnalysisResult + GoogleCloudDialogflowV2beta1IntentMessageSimpleResponses: + id: GoogleCloudDialogflowV2beta1IntentMessageSimpleResponses description: >- - The result of sentiment analysis. Sentiment analysis inspects user input - and identifies the prevailing subjective opinion, especially to - determine a user's attitude as positive, negative, or neutral. For - Participants.DetectIntent, it needs to be configured in - DetectIntentRequest.query_params. For - Participants.StreamingDetectIntent, it needs to be configured in - StreamingDetectIntentRequest.query_params. And for - Participants.AnalyzeContent and Participants.StreamingAnalyzeContent, it - needs to be configured in - ConversationProfile.human_agent_assistant_config + The collection of simple response candidates. This message in + `QueryResult.fulfillment_messages` and + `WebhookResponse.fulfillment_messages` should contain only one + `SimpleResponse`. type: object properties: - queryTextSentiment: - description: The sentiment analysis result for `query_text`. - $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1Sentiment' - GoogleCloudDialogflowV2beta1Sentiment: - id: GoogleCloudDialogflowV2beta1Sentiment - description: >- - The sentiment, such as positive/negative feeling or association, for a - unit of analysis, such as the query text. See: - https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values - for how to interpret the result. + simpleResponses: + description: Required. The list of simple responses. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageSimpleResponse + GoogleCloudDialogflowV2beta1IntentMessageSimpleResponse: + id: GoogleCloudDialogflowV2beta1IntentMessageSimpleResponse + description: The simple response message containing speech or text. type: object properties: - score: - description: >- - Sentiment score between -1.0 (negative sentiment) and 1.0 (positive - sentiment). - type: number - format: float - magnitude: + textToSpeech: description: >- - A non-negative number in the [0, +inf) range, which represents the - absolute magnitude of sentiment, regardless of score (positive or - negative). - type: number - format: float - GoogleCloudDialogflowV2beta1ExportAgentResponse: - id: GoogleCloudDialogflowV2beta1ExportAgentResponse - description: The response message for Agents.ExportAgent. - type: object - properties: - agentUri: + One of text_to_speech or ssml must be provided. The plain text of + the speech output. Mutually exclusive with ssml. + type: string + ssml: description: >- - The URI to a file containing the exported agent. This field is - populated only if `agent_uri` is specified in `ExportAgentRequest`. + One of text_to_speech or ssml must be provided. Structured spoken + response to the user in the SSML format. Mutually exclusive with + text_to_speech. type: string - agentContent: - description: Zip compressed raw byte content for agent. + displayText: + description: Optional. The text to display. type: string - format: byte - GoogleCloudDialogflowV2beta1HumanAgentAssistantEvent: - id: GoogleCloudDialogflowV2beta1HumanAgentAssistantEvent - description: >- - Output only. Represents a notification sent to Pub/Sub subscribers for - agent assistant events in a specific conversation. + GoogleCloudDialogflowV2beta1IntentMessageBasicCard: + id: GoogleCloudDialogflowV2beta1IntentMessageBasicCard + description: The basic card message. Useful for displaying information. type: object properties: - conversation: - description: >- - The conversation this notification refers to. Format: - `projects//conversations/`. + title: + description: Optional. The title of the card. type: string - participant: - description: >- - The participant that the suggestion is compiled for. And This field - is used to call Participants.ListSuggestions API. Format: - `projects//conversations//participants/`. It will not be set in - legacy workflow. HumanAgentAssistantConfig.name for more - information. + subtitle: + description: Optional. The subtitle of the card. type: string - suggestionResults: - description: >- - The suggestion results payload that this notification refers to. It - will only be set when - HumanAgentAssistantConfig.SuggestionConfig.group_suggestion_responses - sets to true. + formattedText: + description: Required, unless image is present. The body text of the card. + type: string + image: + description: Optional. The image for the card. + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageImage' + buttons: + description: Optional. The collection of card buttons. type: array items: - $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1SuggestionResult' - GoogleCloudDialogflowV2beta1SuggestionResult: - id: GoogleCloudDialogflowV2beta1SuggestionResult - description: >- - One response of different type of suggestion response which is used in - the response of Participants.AnalyzeContent and - Participants.AnalyzeContent, as well as HumanAgentAssistantEvent. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageBasicCardButton + GoogleCloudDialogflowV2beta1IntentMessageBasicCardButton: + id: GoogleCloudDialogflowV2beta1IntentMessageBasicCardButton + description: The button object that appears at the bottom of a card. type: object properties: - error: - description: Error status if the request failed. - $ref: '#/components/schemas/GoogleRpcStatus' - suggestArticlesResponse: - description: SuggestArticlesResponse if request is for ARTICLE_SUGGESTION. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1SuggestArticlesResponse - suggestKnowledgeAssistResponse: - description: SuggestKnowledgeAssistResponse if request is for KNOWLEDGE_ASSIST. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1SuggestKnowledgeAssistResponse - suggestFaqAnswersResponse: - description: SuggestFaqAnswersResponse if request is for FAQ_ANSWER. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse - suggestSmartRepliesResponse: - description: SuggestSmartRepliesResponse if request is for SMART_REPLY. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1SuggestSmartRepliesResponse - suggestDialogflowAssistsResponse: - description: >- - SuggestDialogflowAssistsResponse if request is for - DIALOGFLOW_ASSIST. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1SuggestDialogflowAssistsResponse - suggestEntityExtractionResponse: - description: >- - SuggestDialogflowAssistsResponse if request is for - ENTITY_EXTRACTION. + title: + description: Required. The title of the button. + type: string + openUriAction: + description: Required. Action to take when a user taps on the button. $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1SuggestDialogflowAssistsResponse - GoogleCloudDialogflowV2beta1SuggestArticlesResponse: - id: GoogleCloudDialogflowV2beta1SuggestArticlesResponse - description: The response message for Participants.SuggestArticles. + #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageBasicCardButtonOpenUriAction + GoogleCloudDialogflowV2beta1IntentMessageBasicCardButtonOpenUriAction: + id: GoogleCloudDialogflowV2beta1IntentMessageBasicCardButtonOpenUriAction + description: Opens the given URI. type: object properties: - articleAnswers: - description: Output only. Articles ordered by score in descending order. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1ArticleAnswer' - latestMessage: - description: >- - The name of the latest conversation message used to compile - suggestion for. Format: - `projects//locations//conversations//messages/`. + uri: + description: Required. The HTTP or HTTPS scheme URI. type: string - contextSize: - description: >- - Number of messages prior to and including latest_message to compile - the suggestion. It may be smaller than the - SuggestArticlesResponse.context_size field in the request if there - aren't that many messages in the conversation. - type: integer - format: int32 - GoogleCloudDialogflowV2beta1ArticleAnswer: - id: GoogleCloudDialogflowV2beta1ArticleAnswer - description: Represents article answer. + GoogleCloudDialogflowV2beta1IntentMessageSuggestions: + id: GoogleCloudDialogflowV2beta1IntentMessageSuggestions + description: The collection of suggestions. type: object properties: - title: - description: The article title. - type: string - uri: - description: The article URI. - type: string - snippets: - description: Output only. Article snippets. + suggestions: + description: Required. The list of suggested replies. type: array items: - type: string - metadata: - description: >- - A map that contains metadata about the answer and the document from - which it originates. - type: object - additionalProperties: - type: string - answerRecord: - description: >- - The name of answer record, in the format of - "projects//locations//answerRecords/" - type: string - GoogleCloudDialogflowV2beta1SuggestKnowledgeAssistResponse: - id: GoogleCloudDialogflowV2beta1SuggestKnowledgeAssistResponse - description: The response message for Participants.SuggestKnowledgeAssist. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageSuggestion + GoogleCloudDialogflowV2beta1IntentMessageSuggestion: + id: GoogleCloudDialogflowV2beta1IntentMessageSuggestion + description: >- + The suggestion chip message that the user can tap to quickly post a + reply to the conversation. type: object properties: - knowledgeAssistAnswer: - description: Output only. Knowledge Assist suggestion. - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1KnowledgeAssistAnswer - latestMessage: - description: >- - The name of the latest conversation message used to compile - suggestion for. Format: - `projects//locations//conversations//messages/`. + title: + description: Required. The text shown the in the suggestion chip. type: string - contextSize: - description: >- - Number of messages prior to and including latest_message to compile - the suggestion. It may be smaller than the - SuggestKnowledgeAssistRequest.context_size field in the request if - there are fewer messages in the conversation. - type: integer - format: int32 - GoogleCloudDialogflowV2beta1KnowledgeAssistAnswer: - id: GoogleCloudDialogflowV2beta1KnowledgeAssistAnswer - description: Represents a Knowledge Assist answer. + GoogleCloudDialogflowV2beta1IntentMessageLinkOutSuggestion: + id: GoogleCloudDialogflowV2beta1IntentMessageLinkOutSuggestion + description: >- + The suggestion chip message that allows the user to jump out to the app + or website associated with this agent. type: object properties: - suggestedQuery: - description: >- - The query suggested based on the context. Suggestion is made only if - it is different from the previous suggestion. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerSuggestedQuery - suggestedQueryAnswer: - description: >- - The answer generated for the suggested query. Whether or not an - answer is generated depends on how confident we are about the - generated query. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswer - answerRecord: + destinationName: + description: Required. The name of the app or site this chip is linking to. + type: string + uri: description: >- - The name of the answer record. Format: `projects//locations//answer - Records/`. + Required. The URI of the app or site to open when the user taps the + suggestion chip. type: string - GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerSuggestedQuery: - id: GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerSuggestedQuery - description: Represents a suggested query. + GoogleCloudDialogflowV2beta1IntentMessageListSelect: + id: GoogleCloudDialogflowV2beta1IntentMessageListSelect + description: The card for presenting a list of options to select from. type: object properties: - queryText: - description: Suggested query text. + title: + description: Optional. The overall title of the list. type: string - GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswer: - id: GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswer - description: >- - Represents an answer from Knowledge. Currently supports FAQ and - Generative answers. + items: + description: Required. List items. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageListSelectItem + subtitle: + description: Optional. Subtitle of the list. + type: string + GoogleCloudDialogflowV2beta1IntentMessageListSelectItem: + id: GoogleCloudDialogflowV2beta1IntentMessageListSelectItem + description: An item in the list. type: object properties: - answerText: - description: >- - The piece of text from the `source` that answers this suggested - query. - type: string - faqSource: - description: Populated if the prediction came from FAQ. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerFaqSource - generativeSource: - description: Populated if the prediction was Generative. + info: + description: Required. Additional information about this option. $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource - GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerFaqSource: - id: >- - GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerFaqSource - description: Details about source of FAQ answer. + #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo + title: + description: Required. The title of the list item. + type: string + description: + description: Optional. The main text describing the item. + type: string + image: + description: Optional. The image to display. + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageImage' + GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo: + id: GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo + description: >- + Additional info about the select item for when it is triggered in a + dialog. type: object properties: - question: - description: The corresponding FAQ question. + key: + description: >- + Required. A unique key that will be sent back to the agent if this + response is given. type: string - GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource: - id: >- - GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource - description: Details about source of Generative answer. + synonyms: + description: >- + Optional. A list of synonyms that can also be used to trigger this + item in dialog. + type: array + items: + type: string + GoogleCloudDialogflowV2beta1IntentMessageCarouselSelect: + id: GoogleCloudDialogflowV2beta1IntentMessageCarouselSelect + description: The card for presenting a carousel of options to select from. type: object properties: - snippets: - description: >- - All snippets used for this Generative Prediction, with their source - URI and data. + items: + description: Required. Carousel items. type: array items: $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet - GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet: - id: >- - GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet - description: Snippet Source for a Generative Prediction. + #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageCarouselSelectItem + GoogleCloudDialogflowV2beta1IntentMessageCarouselSelectItem: + id: GoogleCloudDialogflowV2beta1IntentMessageCarouselSelectItem + description: An item in the carousel. type: object properties: - uri: - description: URI the data is sourced from. - type: string - text: - description: Text taken from that URI. - type: string + info: + description: Required. Additional info about the option item. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo title: - description: Title of the document. + description: Required. Title of the carousel item. type: string - metadata: - description: Metadata of the document. - type: object - additionalProperties: - type: any - description: Properties of the object. - GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse: - id: GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse - description: The request message for Participants.SuggestFaqAnswers. + description: + description: Optional. The body text of the card. + type: string + image: + description: Optional. The image to display. + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageImage' + GoogleCloudDialogflowV2beta1IntentMessageTelephonyPlayAudio: + id: GoogleCloudDialogflowV2beta1IntentMessageTelephonyPlayAudio + description: Plays audio from a file in Telephony Gateway. type: object properties: - faqAnswers: - description: Output only. Answers extracted from FAQ documents. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1FaqAnswer' - latestMessage: + audioUri: description: >- - The name of the latest conversation message used to compile - suggestion for. Format: - `projects//locations//conversations//messages/`. + Required. URI to a Google Cloud Storage object containing the audio + to play, e.g., "gs://bucket/object". The object must contain a + single channel (mono) of linear PCM audio (2 bytes / sample) at + 8kHz. This object must be readable by the + `service-@gcp-sa-dialogflow.iam.gserviceaccount.com` service account + where is the number of the Telephony Gateway project (usually the + same as the Dialogflow agent project). If the Google Cloud Storage + bucket is in the Telephony Gateway project, this permission is added + by default when enabling the Dialogflow V2 API. For audio from other + sources, consider using the `TelephonySynthesizeSpeech` message with + SSML. type: string - contextSize: - description: >- - Number of messages prior to and including latest_message to compile - the suggestion. It may be smaller than the - SuggestFaqAnswersRequest.context_size field in the request if there - aren't that many messages in the conversation. - type: integer - format: int32 - GoogleCloudDialogflowV2beta1FaqAnswer: - id: GoogleCloudDialogflowV2beta1FaqAnswer - description: Represents answer from "frequently asked questions". + GoogleCloudDialogflowV2beta1IntentMessageTelephonySynthesizeSpeech: + id: GoogleCloudDialogflowV2beta1IntentMessageTelephonySynthesizeSpeech + description: >- + Synthesizes speech and plays back the synthesized audio to the caller in + Telephony Gateway. Telephony Gateway takes the synthesizer settings from + `DetectIntentResponse.output_audio_config` which can either be set at + request-level or can come from the agent-level synthesizer config. type: object properties: - answer: - description: The piece of text from the `source` knowledge base document. + text: + description: The raw text to be synthesized. type: string - confidence: + ssml: description: >- - The system's confidence score that this Knowledge answer is a good - match for this conversational query, range from 0.0 (completely - uncertain) to 1.0 (completely certain). - type: number - format: float - question: - description: The corresponding FAQ question. - type: string - source: - description: >- - Indicates which Knowledge Document this answer was extracted from. - Format: `projects//locations//agent/knowledgeBases//documents/`. + The SSML to be synthesized. For more information, see + [SSML](https://developers.google.com/actions/reference/ssml). type: string - metadata: - description: >- - A map that contains metadata about the answer and the document from - which it originates. - type: object - additionalProperties: - type: string - answerRecord: + GoogleCloudDialogflowV2beta1IntentMessageTelephonyTransferCall: + id: GoogleCloudDialogflowV2beta1IntentMessageTelephonyTransferCall + description: Transfers the call in Telephony Gateway. + type: object + properties: + phoneNumber: description: >- - The name of answer record, in the format of - "projects//locations//answerRecords/" + Required. The phone number to transfer the call to in [E.164 + format](https://en.wikipedia.org/wiki/E.164). We currently only + allow transferring to US numbers (+1xxxyyyzzzz). type: string - GoogleCloudDialogflowV2beta1SuggestSmartRepliesResponse: - id: GoogleCloudDialogflowV2beta1SuggestSmartRepliesResponse - description: The response message for Participants.SuggestSmartReplies. + GoogleCloudDialogflowV2beta1IntentMessageRbmText: + id: GoogleCloudDialogflowV2beta1IntentMessageRbmText + description: Rich Business Messaging (RBM) text response with suggestions. type: object properties: - smartReplyAnswers: - description: >- - Output only. Multiple reply options provided by smart reply service. - The order is based on the rank of the model prediction. The maximum - number of the returned replies is set in SmartReplyConfig. + text: + description: Required. Text sent and displayed to the user. + type: string + rbmSuggestion: + description: Optional. One or more suggestions to show to the user. type: array items: - $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1SmartReplyAnswer' - latestMessage: - description: >- - The name of the latest conversation message used to compile - suggestion for. Format: - `projects//locations//conversations//messages/`. - type: string - contextSize: - description: >- - Number of messages prior to and including latest_message to compile - the suggestion. It may be smaller than the - SuggestSmartRepliesRequest.context_size field in the request if - there aren't that many messages in the conversation. - type: integer - format: int32 - GoogleCloudDialogflowV2beta1SmartReplyAnswer: - id: GoogleCloudDialogflowV2beta1SmartReplyAnswer - description: Represents a smart reply answer. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestion + GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestion: + id: GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestion + description: >- + Rich Business Messaging (RBM) suggestion. Suggestions allow user to + easily select/click a predefined response or perform an action (like + opening a web uri). type: object properties: reply: - description: The content of the reply. + description: Predefined replies for user to select instead of typing + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedReply + action: + description: Predefined client side actions that user can choose + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedAction + GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedReply: + id: GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedReply + description: >- + Rich Business Messaging (RBM) suggested reply that the user can click + instead of typing in their own response. + type: object + properties: + text: + description: Suggested reply text. type: string - confidence: - description: >- - Smart reply confidence. The system's confidence score that this - reply is a good match for this conversation, as a value from 0.0 - (completely uncertain) to 1.0 (completely certain). - type: number - format: float - answerRecord: + postbackData: description: >- - The name of answer record, in the format of - "projects//locations//answerRecords/" + Opaque payload that the Dialogflow receives in a user event when the + user taps the suggested reply. This data will be also forwarded to + webhook to allow performing custom business logic. type: string - GoogleCloudDialogflowV2beta1SuggestDialogflowAssistsResponse: - id: GoogleCloudDialogflowV2beta1SuggestDialogflowAssistsResponse - description: The response message for Participants.SuggestDialogflowAssists. + GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedAction: + id: GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedAction + description: >- + Rich Business Messaging (RBM) suggested client-side action that the user + can choose from the card. type: object properties: - dialogflowAssistAnswers: - description: >- - Output only. Multiple reply options provided by Dialogflow assist - service. The order is based on the rank of the model prediction. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1DialogflowAssistAnswer - latestMessage: + text: + description: Text to display alongside the action. + type: string + postbackData: description: >- - The name of the latest conversation message used to suggest answer. - Format: `projects//locations//conversations//messages/`. + Opaque payload that the Dialogflow receives in a user event when the + user taps the suggested action. This data will be also forwarded to + webhook to allow performing custom business logic. type: string - contextSize: + dial: + description: 'Suggested client side action: Dial a phone number' + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionDial + openUrl: + description: 'Suggested client side action: Open a URI on device' + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionOpenUri + shareLocation: + description: 'Suggested client side action: Share user location' + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionShareLocation + GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionDial: + id: >- + GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionDial + description: >- + Opens the user's default dialer app with the specified phone number but + does not dial automatically. + type: object + properties: + phoneNumber: description: >- - Number of messages prior to and including latest_message to compile - the suggestion. It may be smaller than the - SuggestDialogflowAssistsRequest.context_size field in the request if - there aren't that many messages in the conversation. - type: integer - format: int32 - GoogleCloudDialogflowV2beta1DialogflowAssistAnswer: - id: GoogleCloudDialogflowV2beta1DialogflowAssistAnswer - description: Represents a Dialogflow assist answer. + Required. The phone number to fill in the default dialer app. This + field should be in [E.164](https://en.wikipedia.org/wiki/E.164) + format. An example of a correctly formatted phone number: + +15556767888. + type: string + GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionOpenUri: + id: >- + GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionOpenUri + description: >- + Opens the user's default web browser app to the specified uri If the + user has an app installed that is registered as the default handler for + the URL, then this app will be opened instead, and its icon will be used + in the suggested action UI. type: object properties: - queryResult: - description: Result from v2 agent. - $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1QueryResult' - intentSuggestion: - description: An intent suggestion generated from conversation. - $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1IntentSuggestion' - answerRecord: + uri: + description: Required. The uri to open on the user device + type: string + GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionShareLocation: + id: >- + GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionShareLocation + description: >- + Opens the device's location chooser so the user can pick a location to + send back to the agent. + type: object + properties: {} + GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard: + id: GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard + description: >- + Standalone Rich Business Messaging (RBM) rich card. Rich cards allow you + to respond to users with more vivid content, e.g. with media and + suggestions. You can group multiple rich cards into one using + RbmCarouselCard but carousel cards will give you less control over the + card layout. + type: object + properties: + cardOrientation: + description: Required. Orientation of the card. + type: string + enumDescriptions: + - Not specified. + - Horizontal layout. + - Vertical layout. + enum: + - CARD_ORIENTATION_UNSPECIFIED + - HORIZONTAL + - VERTICAL + thumbnailImageAlignment: description: >- - The name of answer record, in the format of - "projects//locations//answerRecords/" + Required if orientation is horizontal. Image preview alignment for + standalone cards with horizontal layout. type: string - GoogleCloudDialogflowV2beta1QueryResult: - id: GoogleCloudDialogflowV2beta1QueryResult - description: Represents the result of conversational query or event processing. + enumDescriptions: + - Not specified. + - Thumbnail preview is left-aligned. + - Thumbnail preview is right-aligned. + enum: + - THUMBNAIL_IMAGE_ALIGNMENT_UNSPECIFIED + - LEFT + - RIGHT + cardContent: + description: Required. Card content. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageRbmCardContent + GoogleCloudDialogflowV2beta1IntentMessageRbmCardContent: + id: GoogleCloudDialogflowV2beta1IntentMessageRbmCardContent + description: Rich Business Messaging (RBM) Card content type: object properties: - queryText: + title: description: >- - The original conversational query text: - If natural language text - was provided as input, `query_text` contains a copy of the input. - - If natural language speech audio was provided as input, `query_text` - contains the speech recognition result. If speech recognizer - produced multiple alternatives, a particular one is picked. - If - automatic spell correction is enabled, `query_text` will contain the - corrected user input. + Optional. Title of the card (at most 200 bytes). At least one of the + title, description or media must be set. type: string - languageCode: + description: description: >- - The language that was triggered during intent detection. See - [Language - Support](https://cloud.google.com/dialogflow/docs/reference/language) - for a list of the currently supported language codes. + Optional. Description of the card (at most 2000 bytes). At least one + of the title, description or media must be set. type: string - speechRecognitionConfidence: + media: description: >- - The Speech recognition confidence between 0.0 and 1.0. A higher - number indicates an estimated greater likelihood that the recognized - words are correct. The default of 0.0 is a sentinel value indicating - that confidence was not set. This field is not guaranteed to be - accurate or set. In particular this field isn't set for - StreamingDetectIntent since the streaming endpoint has separate - confidence estimates per portion of the audio in - StreamingRecognitionResult. - type: number - format: float - action: - description: The action name from the matched intent. - type: string - parameters: - description: >- - The collection of extracted parameters. Depending on your protocol - or client library language, this is a map, associative array, symbol - table, dictionary, or JSON object composed of a collection of - (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: - parameter name * MapValue type: If parameter's entity type is a - composite entity then use map, otherwise, depending on the parameter - value type, it could be one of string, number, boolean, null, list - or map. * MapValue value: If parameter's entity type is a composite - entity then use map from composite entity property names to property - values, otherwise, use parameter value. - type: object - additionalProperties: - type: any - description: Properties of the object. - allRequiredParamsPresent: - description: >- - This field is set to: - `false` if the matched intent has required - parameters and not all of the required parameter values have been - collected. - `true` if all required parameter values have been - collected, or if the matched intent doesn't contain any required - parameters. - type: boolean - cancelsSlotFilling: - description: >- - Indicates whether the conversational query triggers a cancellation - for slot filling. For more information, see the [cancel slot filling - documentation](https://cloud.google.com/dialogflow/es/docs/intents-actions-parameters#cancel). - type: boolean - fulfillmentText: - description: >- - The text to be pronounced to the user or shown on the screen. Note: - This is a legacy field, `fulfillment_messages` should be preferred. - type: string - fulfillmentMessages: - description: The collection of rich messages to present to the user. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1IntentMessage' - webhookSource: - description: >- - If the query was fulfilled by a webhook call, this field is set to - the value of the `source` field returned in the webhook response. - type: string - webhookPayload: - description: >- - If the query was fulfilled by a webhook call, this field is set to - the value of the `payload` field returned in the webhook response. - type: object - additionalProperties: - type: any - description: Properties of the object. - outputContexts: - description: >- - The collection of output contexts. If applicable, - `output_contexts.parameters` contains entries with name `.original` - containing the original parameter values before the query. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1Context' - intent: - description: >- - The intent that matched the conversational query. Some, not all - fields are filled in this message, including but not limited to: - `name`, `display_name`, `end_interaction` and `is_fallback`. - $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1Intent' - intentDetectionConfidence: - description: >- - The intent detection confidence. Values range from 0.0 (completely - uncertain) to 1.0 (completely certain). This value is for - informational purpose only and is only used to help match the best - intent within the classification threshold. This value may change - for the same end-user expression at any time due to a model - retraining or change in implementation. If there are `multiple - knowledge_answers` messages, this value is set to the greatest - `knowledgeAnswers.match_confidence` value in the list. - type: number - format: float - diagnosticInfo: - description: >- - Free-form diagnostic information for the associated detect intent - request. The fields of this data can change without notice, so you - should not write code that depends on its structure. The data may - contain: - webhook call latency - webhook errors - type: object - additionalProperties: - type: any - description: Properties of the object. - sentimentAnalysisResult: - description: >- - The sentiment analysis result, which depends on the - `sentiment_analysis_request_config` specified in the request. + Optional. However at least one of the title, description or media + must be set. Media (image, GIF or a video) to include in the card. $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1SentimentAnalysisResult - knowledgeAnswers: - description: >- - The result from Knowledge Connector (if any), ordered by decreasing - `KnowledgeAnswers.match_confidence`. - $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1KnowledgeAnswers' - GoogleCloudDialogflowV2beta1KnowledgeAnswers: - id: GoogleCloudDialogflowV2beta1KnowledgeAnswers - description: Represents the result of querying a Knowledge base. - type: object - properties: - answers: - description: A list of answers from Knowledge Connector. + #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageRbmCardContentRbmMedia + suggestions: + description: Optional. List of suggestions to include in the card. type: array items: $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer - GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer: - id: GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer - description: An answer from Knowledge Connector. + #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestion + GoogleCloudDialogflowV2beta1IntentMessageRbmCardContentRbmMedia: + id: GoogleCloudDialogflowV2beta1IntentMessageRbmCardContentRbmMedia + description: >- + Rich Business Messaging (RBM) Media displayed in Cards The following + media-types are currently supported: Image Types * image/jpeg * + image/jpg' * image/gif * image/png Video Types * video/h263 * video/m4v + * video/mp4 * video/mpeg * video/mpeg4 * video/webm type: object properties: - source: - description: >- - Indicates which Knowledge Document this answer was extracted from. - Format: `projects//knowledgeBases//documents/`. - type: string - faqQuestion: + fileUri: description: >- - The corresponding FAQ question if the answer was extracted from a - FAQ Document, empty otherwise. + Required. Publicly reachable URI of the file. The RBM platform + determines the MIME type of the file from the content-type field in + the HTTP headers when the platform fetches the file. The + content-type field must be present and accurate in the HTTP response + from the URL. type: string - answer: + thumbnailUri: description: >- - The piece of text from the `source` knowledge base document that - answers this conversational query. + Optional. Publicly reachable URI of the thumbnail.If you don't + provide a thumbnail URI, the RBM platform displays a blank + placeholder thumbnail until the user's device downloads the file. + Depending on the user's setting, the file may not download + automatically and may require the user to tap a download button. type: string - matchConfidenceLevel: + height: description: >- - The system's confidence level that this knowledge answer is a good - match for this conversational query. NOTE: The confidence level for - a given `` pair may change without notice, as it depends on models - that are constantly being improved. However, it will change less - frequently than the confidence score below, and should be preferred - for referencing the quality of an answer. + Required for cards with vertical orientation. The height of the + media within a rich card with a vertical layout. For a standalone + card with horizontal layout, height is not customizable, and this + field is ignored. type: string enumDescriptions: - Not specified. - - Indicates that the confidence is low. - - Indicates our confidence is medium. - - Indicates our confidence is high. + - 112 DP. + - 168 DP. + - >- + 264 DP. Not available for rich card carousels when the card width + is set to small. enum: - - MATCH_CONFIDENCE_LEVEL_UNSPECIFIED - - LOW + - HEIGHT_UNSPECIFIED + - SHORT - MEDIUM - - HIGH - matchConfidence: - description: >- - The system's confidence score that this Knowledge answer is a good - match for this conversational query. The range is from 0.0 - (completely uncertain) to 1.0 (completely certain). Note: The - confidence score is likely to vary somewhat (possibly even for - identical requests), as the underlying model is under constant - improvement. It may be deprecated in the future. We recommend using - `match_confidence_level` which should be generally more stable. - type: number - format: float - GoogleCloudDialogflowV2beta1IntentSuggestion: - id: GoogleCloudDialogflowV2beta1IntentSuggestion - description: Represents an intent suggestion. + - TALL + GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard: + id: GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard + description: >- + Carousel Rich Business Messaging (RBM) rich card. Rich cards allow you + to respond to users with more vivid content, e.g. with media and + suggestions. If you want to show a single card with more control over + the layout, please use RbmStandaloneCard instead. type: object properties: - displayName: - description: The display name of the intent. - type: string - intentV2: - description: >- - The unique identifier of this intent. Format: - `projects//locations//agent/intents/`. + cardWidth: + description: Required. The width of the cards in the carousel. type: string - description: + enumDescriptions: + - Not specified. + - 120 DP. Note that tall media cannot be used. + - 232 DP. + enum: + - CARD_WIDTH_UNSPECIFIED + - SMALL + - MEDIUM + cardContents: description: >- - Human readable description for better understanding an intent like - its scope, content, result etc. Maximum character limit: 140 - characters. - type: string - GoogleCloudDialogflowV2beta1ImportDocumentsResponse: - id: GoogleCloudDialogflowV2beta1ImportDocumentsResponse - description: Response message for Documents.ImportDocuments. - type: object - properties: - warnings: - description: Includes details about skipped documents or any other warnings. + Required. The cards in the carousel. A carousel must have at least 2 + cards and at most 10. type: array items: - $ref: '#/components/schemas/GoogleRpcStatus' - GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata: - id: GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata - description: Metadata for initializing a location-level encryption specification. - type: object - properties: - request: - description: Output only. The original request for initialization. - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest - GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest: - id: GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest - description: The request to initialize a location-level encryption specification. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageRbmCardContent + GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCard: + id: GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCard + description: >- + Browse Carousel Card for Actions on Google. + https://developers.google.com/actions/assistant/responses#browsing_carousel type: object properties: - encryptionSpec: - description: >- - Required. The encryption spec used for CMEK encryption. It is - required that the kms key is in the same region as the endpoint. The - same key will be used for all provisioned resources, if encryption - is available. If the kms_key_name is left empty, no encryption will - be enforced. - $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1EncryptionSpec' - GoogleCloudDialogflowV2beta1EncryptionSpec: - id: GoogleCloudDialogflowV2beta1EncryptionSpec - description: >- - A customer-managed encryption key specification that can be applied to - all created resources (e.g. Conversation). - type: object - properties: - name: + items: description: >- - Immutable. The resource name of the encryption key specification - resource. Format: - projects/{project}/locations/{location}/encryptionSpec - type: string - kmsKey: + Required. List of items in the Browse Carousel Card. Minimum of two + items, maximum of ten. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItem + imageDisplayOptions: description: >- - Required. The name of customer-managed encryption key that is used - to secure a resource and its sub-resources. If empty, the resource - is secured by the default Google encryption key. Only the key in the - same location as this resource is allowed to be used for encryption. - Format: - `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}` - type: string - GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata: - id: GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata - description: Metadata in google::longrunning::Operation for Knowledge operations. - type: object - properties: - state: - description: Required. Output only. The current state of this operation. - readOnly: true + Optional. Settings for displaying the image. Applies to every image + in items. type: string enumDescriptions: - - State unspecified. - - The operation has been created. - - The operation is currently running. - - The operation is done, either cancelled or completed. + - >- + Fill the gaps between the image and the image container with gray + bars. + - >- + Fill the gaps between the image and the image container with gray + bars. + - >- + Fill the gaps between the image and the image container with white + bars. + - >- + Image is scaled such that the image width and height match or + exceed the container dimensions. This may crop the top and bottom + of the image if the scaled image height is greater than the + container height, or crop the left and right of the image if the + scaled image width is greater than the container width. This is + similar to "Zoom Mode" on a widescreen TV when playing a 4:3 + video. + - >- + Pad the gaps between image and image frame with a blurred copy of + the same image. enum: - - STATE_UNSPECIFIED - - PENDING - - RUNNING - - DONE - knowledgeBase: - description: The name of the knowledge base interacted with during the operation. - type: string - exportOperationMetadata: - description: >- - Metadata for the Export Data Operation such as the destination of - export. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1ExportOperationMetadata - GoogleCloudDialogflowV2beta1ExportOperationMetadata: - id: GoogleCloudDialogflowV2beta1ExportOperationMetadata - description: Metadata related to the Export Data Operations (e.g. ExportDocument). - type: object - properties: - exportedGcsDestination: - description: Cloud Storage file path of the exported data. - $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1GcsDestination' - GoogleCloudDialogflowV2beta1GcsDestination: - id: GoogleCloudDialogflowV2beta1GcsDestination - description: Google Cloud Storage location for the output. + - IMAGE_DISPLAY_OPTIONS_UNSPECIFIED + - GRAY + - WHITE + - CROPPED + - BLURRED_BACKGROUND + GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItem: + id: >- + GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItem + description: Browsing carousel tile type: object properties: - uri: - description: >- - Required. The Google Cloud Storage URIs for the output. A URI is of - the form: `gs://bucket/object-prefix-or-name` Whether a prefix or - name is used depends on the use case. The requesting user must have - "write-permission" to the bucket. + openUriAction: + description: Required. Action to present to the user. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction + title: + description: Required. Title of the carousel item. Maximum of two lines of text. type: string - GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest: - id: GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest - description: >- - Represents the contents of the original request that was passed to the - `[Streaming]DetectIntent` call. - type: object - properties: - source: + description: description: >- - The source of this request, e.g., `google`, `facebook`, `slack`. It - is set by Dialogflow-owned servers. + Optional. Description of the carousel item. Maximum of four lines of + text. type: string - version: + image: + description: Optional. Hero image for the carousel item. + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageImage' + footer: description: >- - Optional. The version of the protocol used for this request. This - field is AoG-specific. + Optional. Text that appears at the bottom of the Browse Carousel + Card. Maximum of one line of text. type: string - payload: - description: >- - Optional. This field is set to the value of the - `QueryParameters.payload` field passed in the request. Some - integrations that query a Dialogflow agent may provide additional - information in the payload. In particular, for the Dialogflow Phone - Gateway integration, this field has the form: { "telephony": { - "caller_id": "+18558363987" } } Note: The caller ID field - (`caller_id`) will be redacted for Trial Edition agents and - populated with the caller ID in [E.164 - format](https://en.wikipedia.org/wiki/E.164) for Essentials Edition - agents. - type: object - additionalProperties: - type: any - description: Properties of the object. - GoogleCloudDialogflowV2beta1SetSuggestionFeatureConfigOperationMetadata: - id: GoogleCloudDialogflowV2beta1SetSuggestionFeatureConfigOperationMetadata - description: Metadata for a ConversationProfile.SetSuggestionFeatureConfig operation. + GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction: + id: >- + GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction + description: Actions on Google action to open a given url. type: object properties: - conversationProfile: - description: >- - The resource name of the conversation profile. Format: - `projects//locations//conversationProfiles/` + url: + description: Required. URL type: string - participantRole: + urlTypeHint: description: >- - Required. The participant role to add or update the suggestion - feature config. Only HUMAN_AGENT or END_USER can be used. - type: string - enumDescriptions: - - Participant role not set. - - Participant is a human agent. - - Participant is an automated agent, such as a Dialogflow agent. - - >- - Participant is an end user that has called or chatted with - Dialogflow services. - enum: - - ROLE_UNSPECIFIED - - HUMAN_AGENT - - AUTOMATED_AGENT - - END_USER - suggestionFeatureType: - description: Required. The type of the suggestion feature to add or update. + Optional. Specifies the type of viewer that is used when opening the + URL. Defaults to opening via web browser. type: string enumDescriptions: - - Unspecified feature type. - - Run article suggestion model for chat. - - Run FAQ model. - - Run smart reply model for chat. - - >- - Run Dialogflow assist model for chat, which will return automated - agent response as suggestion. - - Run conversation summarization model for chat. + - Unspecified + - Url would be an amp action - >- - Run knowledge search with text input from agent or text generated - query. - - Run knowledge assist with automatic query generation. + URL that points directly to AMP content, or to a canonical URL + which refers to AMP content via . enum: - - TYPE_UNSPECIFIED - - ARTICLE_SUGGESTION - - FAQ - - SMART_REPLY - - DIALOGFLOW_ASSIST - - CONVERSATION_SUMMARIZATION - - KNOWLEDGE_SEARCH - - KNOWLEDGE_ASSIST - createTime: - description: >- - Timestamp whe the request was created. The time is measured on - server side. - type: string - format: google-datetime - GoogleCloudDialogflowV2beta1WebhookRequest: - id: GoogleCloudDialogflowV2beta1WebhookRequest - description: The request message for a webhook call. + - URL_TYPE_HINT_UNSPECIFIED + - AMP_ACTION + - AMP_CONTENT + GoogleCloudDialogflowV2beta1IntentMessageTableCard: + id: GoogleCloudDialogflowV2beta1IntentMessageTableCard + description: Table card for Actions on Google. type: object properties: - session: - description: >- - The unique identifier of detectIntent request session. Can be used - to identify end-user inside webhook implementation. Supported - formats: - `projects//agent/sessions/, - - `projects//locations//agent/sessions/`, - - `projects//agent/environments//users//sessions/`, - - `projects//locations//agent/environments//users//sessions/`, + title: + description: Required. Title of the card. type: string - responseId: - description: >- - The unique identifier of the response. Contains the same value as - `[Streaming]DetectIntentResponse.response_id`. + subtitle: + description: Optional. Subtitle to the title. type: string - queryResult: - description: >- - The result of the conversational query or event processing. Contains - the same value as `[Streaming]DetectIntentResponse.query_result`. - $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1QueryResult' - alternativeQueryResults: - description: Alternative query results from KnowledgeService. + image: + description: Optional. Image which should be displayed on the card. + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageImage' + columnProperties: + description: Optional. Display properties for the columns in this table. type: array items: - $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1QueryResult' - originalDetectIntentRequest: - description: >- - Optional. The contents of the original request that was passed to - `[Streaming]DetectIntent` call. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest - GoogleCloudDialogflowV2beta1WebhookResponse: - id: GoogleCloudDialogflowV2beta1WebhookResponse - description: >- - The response message for a webhook call. This response is validated by - the Dialogflow server. If validation fails, an error will be returned in - the QueryResult.diagnostic_info field. Setting JSON fields to an empty - value with the wrong type is a common error. To avoid this error: - Use - `""` for empty strings - Use `{}` or `null` for empty objects - Use `[]` - or `null` for empty arrays For more information, see the [Protocol - Buffers Language - Guide](https://developers.google.com/protocol-buffers/docs/proto3#json). + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageColumnProperties + rows: + description: Optional. Rows in this table of data. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageTableCardRow + buttons: + description: Optional. List of buttons for the card. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageBasicCardButton + GoogleCloudDialogflowV2beta1IntentMessageColumnProperties: + id: GoogleCloudDialogflowV2beta1IntentMessageColumnProperties + description: Column properties for TableCard. type: object properties: - fulfillmentText: - description: >- - Optional. The text response message intended for the end-user. It is - recommended to use `fulfillment_messages.text.text[0]` instead. When - provided, Dialogflow uses this field to populate - QueryResult.fulfillment_text sent to the integration or API caller. + header: + description: Required. Column heading. type: string - fulfillmentMessages: - description: >- - Optional. The rich response messages intended for the end-user. When - provided, Dialogflow uses this field to populate - QueryResult.fulfillment_messages sent to the integration or API - caller. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1IntentMessage' - source: - description: >- - Optional. A custom field used to identify the webhook source. - Arbitrary strings are supported. When provided, Dialogflow uses this - field to populate QueryResult.webhook_source sent to the integration - or API caller. + horizontalAlignment: + description: Optional. Defines text alignment for all cells in this column. type: string - payload: - description: >- - Optional. This field can be used to pass custom data from your - webhook to the integration or API caller. Arbitrary JSON objects are - supported. When provided, Dialogflow uses this field to populate - QueryResult.webhook_payload sent to the integration or API caller. - This field is also used by the [Google Assistant - integration](https://cloud.google.com/dialogflow/docs/integrations/aog) - for rich response messages. See the format definition at [Google - Assistant Dialogflow webhook - format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json) - type: object - additionalProperties: - type: any - description: Properties of the object. - outputContexts: - description: >- - Optional. The collection of output contexts that will overwrite - currently active contexts for the session and reset their lifespans. - When provided, Dialogflow uses this field to populate - QueryResult.output_contexts sent to the integration or API caller. + enumDescriptions: + - Text is aligned to the leading edge of the column. + - Text is aligned to the leading edge of the column. + - Text is centered in the column. + - Text is aligned to the trailing edge of the column. + enum: + - HORIZONTAL_ALIGNMENT_UNSPECIFIED + - LEADING + - CENTER + - TRAILING + GoogleCloudDialogflowV2beta1IntentMessageTableCardRow: + id: GoogleCloudDialogflowV2beta1IntentMessageTableCardRow + description: Row of TableCard. + type: object + properties: + cells: + description: Optional. List of cells that make up this row. type: array items: - $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1Context' - followupEventInput: - description: >- - Optional. Invokes the supplied events. When this field is set, - Dialogflow ignores the `fulfillment_text`, `fulfillment_messages`, - and `payload` fields. - $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1EventInput' - liveAgentHandoff: - description: >- - Indicates that a live agent should be brought in to handle the - interaction with the user. In most cases, when you set this flag to - true, you would also want to set end_interaction to true as well. - Default is false. - type: boolean - endInteraction: - description: >- - Optional. Indicates that this intent ends an interaction. Some - integrations (e.g., Actions on Google or Dialogflow phone gateway) - use this information to close interaction with an end user. Default - is false. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageTableCardCell + dividerAfter: + description: Optional. Whether to add a visual divider after this row. type: boolean - sessionEntityTypes: - description: >- - Optional. Additional session entity types to replace or extend - developer entity types with. The entity synonyms apply to all - languages and persist for the session. Setting this data from a - webhook overwrites the session entity types that have been set using - `detectIntent`, `streamingDetectIntent` or SessionEntityType - management methods. + GoogleCloudDialogflowV2beta1IntentMessageTableCardCell: + id: GoogleCloudDialogflowV2beta1IntentMessageTableCardCell + description: Cell of TableCardRow. + type: object + properties: + text: + description: Required. Text in this cell. + type: string + GoogleCloudDialogflowV2beta1IntentMessageMediaContent: + id: GoogleCloudDialogflowV2beta1IntentMessageMediaContent + description: The media content card for Actions on Google. + type: object + properties: + mediaType: + description: Optional. What type of media is the content (ie "audio"). + type: string + enumDescriptions: + - Unspecified. + - Response media type is audio. + enum: + - RESPONSE_MEDIA_TYPE_UNSPECIFIED + - AUDIO + mediaObjects: + description: Required. List of media objects. type: array items: - $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1SessionEntityType' - GoogleCloudDialogflowV2beta1EventInput: - id: GoogleCloudDialogflowV2beta1EventInput - description: >- - Events allow for matching intents by event name instead of the natural - language input. For instance, input `` can trigger a personalized - welcome response. The parameter `name` may be used by the agent in the - response: `"Hello #welcome_event.name! What can I do for you today?"`. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageMediaContentResponseMediaObject + GoogleCloudDialogflowV2beta1IntentMessageMediaContentResponseMediaObject: + id: GoogleCloudDialogflowV2beta1IntentMessageMediaContentResponseMediaObject + description: Response media object for media content card. type: object properties: name: - description: Required. The unique identifier of the event. + description: Required. Name of media card. type: string - parameters: + description: + description: Optional. Description of media card. + type: string + largeImage: + description: Optional. Image to display above media content. + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageImage' + icon: + description: Optional. Icon to display above media content. + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1IntentMessageImage' + contentUrl: + description: Required. Url where the media is stored. + type: string + GoogleCloudDialogflowV2beta1IntentFollowupIntentInfo: + id: GoogleCloudDialogflowV2beta1IntentFollowupIntentInfo + description: Represents a single followup intent in the chain. + type: object + properties: + followupIntentName: description: >- - The collection of parameters associated with the event. Depending on - your protocol or client library language, this is a map, associative - array, symbol table, dictionary, or JSON object composed of a - collection of (MapKey, MapValue) pairs: * MapKey type: string * - MapKey value: parameter name * MapValue type: If parameter's entity - type is a composite entity then use map, otherwise, depending on the - parameter value type, it could be one of string, number, boolean, - null, list or map. * MapValue value: If parameter's entity type is a - composite entity then use map from composite entity property names - to property values, otherwise, use parameter value. - type: object - additionalProperties: - type: any - description: Properties of the object. - languageCode: + The unique identifier of the followup intent. Format: + `projects//agent/intents/`. + type: string + parentFollowupIntentName: description: >- - Required. The language of this query. See [Language - Support](https://cloud.google.com/dialogflow/docs/reference/language) - for a list of the currently supported language codes. Note that - queries in the same session do not necessarily need to specify the - same language. This field is ignored when used in the context of a - WebhookResponse.followup_event_input field, because the language was - already defined in the originating detect intent request. + The unique identifier of the followup intent's parent. Format: + `projects//agent/intents/`. type: string - GoogleCloudDialogflowV2beta1SessionEntityType: - id: GoogleCloudDialogflowV2beta1SessionEntityType + GoogleCloudDialogflowV2beta1ClearSuggestionFeatureConfigOperationMetadata: + id: >- + GoogleCloudDialogflowV2beta1ClearSuggestionFeatureConfigOperationMetadata description: >- - A session represents a conversation between a Dialogflow agent and an - end-user. You can create special entities, called session entities, - during a session. Session entities can extend or replace custom entity - types and only exist during the session that they were created for. All - session data, including session entities, is stored by Dialogflow for 20 - minutes. For more information, see the [session entity - guide](https://cloud.google.com/dialogflow/docs/entities-session). + Metadata for a ConversationProfile.ClearSuggestionFeatureConfig + operation. type: object properties: - name: + conversationProfile: description: >- - Required. The unique identifier of this session entity type. - Supported formats: - `projects//agent/sessions//entityTypes/` - - `projects//locations//agent/sessions//entityTypes/` - - `projects//agent/environments//users//sessions//entityTypes/` - - `projects//locations//agent/environments/ - /users//sessions//entityTypes/` If `Location ID` is not specified we - assume default 'us' location. If `Environment ID` is not specified, - we assume default 'draft' environment. If `User ID` is not - specified, we assume default '-' user. `` must be the display name - of an existing entity type in the same agent that will be overridden - or supplemented. + The resource name of the conversation profile. Format: + `projects//locations//conversationProfiles/` type: string - entityOverrideMode: + participantRole: description: >- - Required. Indicates whether the additional data should override or - supplement the custom entity type definition. + Required. The participant role to remove the suggestion feature + config. Only HUMAN_AGENT or END_USER can be used. type: string enumDescriptions: - - Not specified. This value should be never used. - - >- - The collection of session entities overrides the collection of - entities in the corresponding custom entity type. + - Participant role not set. + - Participant is a human agent. + - Participant is an automated agent, such as a Dialogflow agent. - >- - The collection of session entities extends the collection of - entities in the corresponding custom entity type. Note: Even in - this override mode calls to `ListSessionEntityTypes`, - `GetSessionEntityType`, `CreateSessionEntityType` and - `UpdateSessionEntityType` only return the additional entities - added in this session entity type. If you want to get the - supplemented list, please call EntityTypes.GetEntityType on the - custom entity type and merge. + Participant is an end user that has called or chatted with + Dialogflow services. enum: - - ENTITY_OVERRIDE_MODE_UNSPECIFIED - - ENTITY_OVERRIDE_MODE_OVERRIDE - - ENTITY_OVERRIDE_MODE_SUPPLEMENT - entities: + - ROLE_UNSPECIFIED + - HUMAN_AGENT + - AUTOMATED_AGENT + - END_USER + suggestionFeatureType: + description: Required. The type of the suggestion feature to remove. + type: string + enumDescriptions: + - Unspecified feature type. + - Run article suggestion model for chat. + - Run FAQ model. + - Run smart reply model for chat. + - >- + Run Dialogflow assist model for chat, which will return automated + agent response as suggestion. + - Run conversation summarization model for chat. + - >- + Run knowledge search with text input from agent or text generated + query. + - Run knowledge assist with automatic query generation. + enum: + - TYPE_UNSPECIFIED + - ARTICLE_SUGGESTION + - FAQ + - SMART_REPLY + - DIALOGFLOW_ASSIST + - CONVERSATION_SUMMARIZATION + - KNOWLEDGE_SEARCH + - KNOWLEDGE_ASSIST + createTime: description: >- - Required. The collection of entities associated with this session - entity type. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1EntityTypeEntity' - GoogleCloudDialogflowV3alpha1ConversationSignals: - id: GoogleCloudDialogflowV3alpha1ConversationSignals + Timestamp whe the request was created. The time is measured on + server side. + type: string + format: google-datetime + GoogleCloudDialogflowV2beta1ConversationEvent: + id: GoogleCloudDialogflowV2beta1ConversationEvent description: >- - This message is used to hold all the Conversation Signals data, which - will be converted to JSON and exported to BigQuery. + Represents a notification sent to Pub/Sub subscribers for conversation + lifecycle events. type: object properties: - turnSignals: - description: Required. Turn signals for the current turn. - $ref: '#/components/schemas/GoogleCloudDialogflowV3alpha1TurnSignals' - GoogleCloudDialogflowV3alpha1TurnSignals: - id: GoogleCloudDialogflowV3alpha1TurnSignals - description: >- - Collection of all signals that were extracted for a single turn of the - conversation. + conversation: + description: >- + Required. The unique identifier of the conversation this + notification refers to. Format: `projects//conversations/`. + type: string + type: + description: Required. The type of the event that this notification refers to. + type: string + enumDescriptions: + - Type not set. + - >- + A new conversation has been opened. This is fired when a telephone + call is answered, or a conversation is created via the API. + - >- + An existing conversation has closed. This is fired when a + telephone call is terminated, or a conversation is closed via the + API. + - >- + An existing conversation has received notification from Dialogflow + that human intervention is required. + - >- + An existing conversation has received a new message, either from + API or telephony. It is configured in + ConversationProfile.new_message_event_notification_config + - >- + An existing conversation has received a new speech recognition + result. This is mainly for delivering intermediate transcripts. + The notification is configured in + ConversationProfile.new_recognition_event_notification_config. + - >- + Unrecoverable error during a telephone call. In general + non-recoverable errors only occur if something was misconfigured + in the ConversationProfile corresponding to the call. After a + non-recoverable error, Dialogflow may stop responding. We don't + fire this event: * in an API call because we can directly return + the error, or, * when we can recover from an error. + enum: + - TYPE_UNSPECIFIED + - CONVERSATION_STARTED + - CONVERSATION_FINISHED + - HUMAN_INTERVENTION_NEEDED + - NEW_MESSAGE + - NEW_RECOGNITION_RESULT + - UNRECOVERABLE_ERROR + errorStatus: + description: >- + Optional. More detailed information about an error. Only set for + type UNRECOVERABLE_ERROR_IN_PHONE_CALL. + $ref: '#/components/schemas/GoogleRpcStatus' + newMessagePayload: + description: Payload of NEW_MESSAGE event. + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1Message' + newRecognitionResultPayload: + description: Payload of NEW_RECOGNITION_RESULT event. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1StreamingRecognitionResult + GoogleCloudDialogflowV2beta1Message: + id: GoogleCloudDialogflowV2beta1Message + description: Represents a message posted into a conversation. type: object properties: - noMatch: - description: Whether NLU predicted NO_MATCH. - type: boolean - noUserInput: - description: Whether user provided no input. - type: boolean - dtmfUsed: - description: Whether user was using DTMF input. - type: boolean - userEscalated: - description: Whether user was specifically asking for a live agent. - type: boolean - agentEscalated: - description: Whether agent responded with LiveAgentHandoff fulfillment. - type: boolean - triggeredAbandonmentEvent: + name: description: >- - Whether agent has triggered the event corresponding to user - abandoning the conversation. - type: boolean - reachedEndPage: - description: Whether turn resulted in End Session page. - type: boolean - webhookStatuses: - description: Human-readable statuses of the webhooks triggered during this turn. + Optional. The unique identifier of the message. Format: + `projects//locations//conversations//messages/`. + type: string + content: + description: Required. The message content. + type: string + responseMessages: + description: Optional. Automated agent responses. type: array items: - type: string - failureReasons: - description: Failure reasons of the turn. + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1ResponseMessage' + languageCode: + description: >- + Optional. The message language. This should be a + [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. + Example: "en-US". + type: string + participant: + description: Output only. The participant that sends this message. + readOnly: true + type: string + participantRole: + description: Output only. The role of the participant. + readOnly: true + type: string + enumDescriptions: + - Participant role not set. + - Participant is a human agent. + - Participant is an automated agent, such as a Dialogflow agent. + - >- + Participant is an end user that has called or chatted with + Dialogflow services. + enum: + - ROLE_UNSPECIFIED + - HUMAN_AGENT + - AUTOMATED_AGENT + - END_USER + createTime: + description: >- + Output only. The time when the message was created in Contact Center + AI. + readOnly: true + type: string + format: google-datetime + sendTime: + description: >- + Optional. The time when the message was sent. For voice messages, + this is the time when an utterance started. + type: string + format: google-datetime + messageAnnotation: + description: Output only. The annotation for the message. + readOnly: true + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1MessageAnnotation' + sentimentAnalysis: + description: Output only. The sentiment analysis result for the message. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1SentimentAnalysisResult + GoogleCloudDialogflowV2beta1ResponseMessage: + id: GoogleCloudDialogflowV2beta1ResponseMessage + description: Response messages from an automated agent. + type: object + properties: + text: + description: Returns a text response. + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1ResponseMessageText' + payload: + description: Returns a response containing a custom, platform-specific payload. + type: object + additionalProperties: + type: any + description: Properties of the object. + liveAgentHandoff: + description: Hands off conversation to a live agent. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff + endInteraction: + description: >- + A signal that indicates the interaction with the Dialogflow agent + has ended. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction + mixedAudio: + description: >- + An audio response message composed of both the synthesized + Dialogflow agent responses and the audios hosted in places known to + the client. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio + telephonyTransferCall: + description: >- + A signal that the client should transfer the phone call connected to + this agent to a third-party endpoint. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall + GoogleCloudDialogflowV2beta1ResponseMessageText: + id: GoogleCloudDialogflowV2beta1ResponseMessageText + description: The text response message. + type: object + properties: + text: + description: >- + A collection of text response variants. If multiple variants are + defined, only one text response variant is returned at runtime. type: array items: type: string - enumDescriptions: - - Failure reason is not assigned. - - Whether NLU failed to recognize user intent. - - Whether webhook failed during the turn. - enum: - - FAILURE_REASON_UNSPECIFIED - - FAILED_INTENT - - FAILED_WEBHOOK - sentimentScore: + GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff: + id: GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff + description: >- + Indicates that the conversation should be handed off to a human agent. + Dialogflow only uses this to determine which conversations were handed + off to a human agent for measurement purposes. What else to do with this + signal is up to you and your handoff procedures. You may set this, for + example: * In the entry fulfillment of a Dialogflow CX Page if entering + the page indicates something went extremely wrong in the conversation. * + In a webhook response when you determine that the customer issue can + only be handled by a human. + type: object + properties: + metadata: description: >- - Sentiment score of the user utterance if - [sentiment](https://cloud.google.com/dialogflow/cx/docs/concept/sentiment) - was enabled. + Custom metadata for your handoff procedure. Dialogflow doesn't + impose any structure on this. + type: object + additionalProperties: + type: any + description: Properties of the object. + GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction: + id: GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction + description: Indicates that interaction with the Dialogflow agent has ended. + type: object + properties: {} + GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio: + id: GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio + description: >- + Represents an audio message that is composed of both segments + synthesized from the Dialogflow agent prompts and ones hosted externally + at the specified URIs. + type: object + properties: + segments: + description: Segments this audio response is composed of. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment + GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment: + id: GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment + description: Represents one segment of audio. + type: object + properties: + audio: + description: >- + Raw audio synthesized from the Dialogflow agent's response using the + output config specified in the request. + type: string + format: byte + uri: + description: >- + Client-specific URI that points to an audio clip accessible to the + client. + type: string + allowPlaybackInterruption: + description: >- + Whether the playback of this segment can be interrupted by the end + user's speech and the client should then start the next Dialogflow + request. + type: boolean + GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall: + id: GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall + description: >- + Represents the signal that telles the client to transfer the phone call + connected to the agent to a third-party endpoint. + type: object + properties: + phoneNumber: + description: >- + Transfer the call to a phone number in [E.164 + format](https://en.wikipedia.org/wiki/E.164). + type: string + sipUri: + description: Transfer the call to a SIP endpoint. + type: string + GoogleCloudDialogflowV2beta1MessageAnnotation: + id: GoogleCloudDialogflowV2beta1MessageAnnotation + description: Represents the result of annotation for the message. + type: object + properties: + parts: + description: >- + Optional. The collection of annotated message parts ordered by their + position in the message. You can recover the annotated message by + concatenating [AnnotatedMessagePart.text]. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1AnnotatedMessagePart + containEntities: + description: Required. Indicates whether the text message contains entities. + type: boolean + GoogleCloudDialogflowV2beta1AnnotatedMessagePart: + id: GoogleCloudDialogflowV2beta1AnnotatedMessagePart + description: >- + Represents a part of a message possibly annotated with an entity. The + part can be an entity or purely a part of the message between two + entities or message start/end. + type: object + properties: + text: + description: Required. A part of a message possibly annotated with an entity. + type: string + entityType: + description: >- + Optional. The [Dialogflow system entity + type](https://cloud.google.com/dialogflow/docs/reference/system-entities) + of this message part. If this is empty, Dialogflow could not + annotate the phrase part with a system entity. + type: string + formattedValue: + description: >- + Optional. The [Dialogflow system entity formatted value + ](https://cloud.google.com/dialogflow/docs/reference/system-entities) + of this message part. For example for a system entity of type + `@sys.unit-currency`, this may contain: { "amount": 5, "currency": + "USD" } + type: any + GoogleCloudDialogflowV2beta1SentimentAnalysisResult: + id: GoogleCloudDialogflowV2beta1SentimentAnalysisResult + description: >- + The result of sentiment analysis. Sentiment analysis inspects user input + and identifies the prevailing subjective opinion, especially to + determine a user's attitude as positive, negative, or neutral. For + Participants.DetectIntent, it needs to be configured in + DetectIntentRequest.query_params. For + Participants.StreamingDetectIntent, it needs to be configured in + StreamingDetectIntentRequest.query_params. And for + Participants.AnalyzeContent and Participants.StreamingAnalyzeContent, it + needs to be configured in + ConversationProfile.human_agent_assistant_config + type: object + properties: + queryTextSentiment: + description: The sentiment analysis result for `query_text`. + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1Sentiment' + GoogleCloudDialogflowV2beta1Sentiment: + id: GoogleCloudDialogflowV2beta1Sentiment + description: >- + The sentiment, such as positive/negative feeling or association, for a + unit of analysis, such as the query text. See: + https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values + for how to interpret the result. + type: object + properties: + score: + description: >- + Sentiment score between -1.0 (negative sentiment) and 1.0 (positive + sentiment). type: number format: float - sentimentMagnitude: + magnitude: description: >- - Sentiment magnitude of the user utterance if - [sentiment](https://cloud.google.com/dialogflow/cx/docs/concept/sentiment) - was enabled. + A non-negative number in the [0, +inf) range, which represents the + absolute magnitude of sentiment, regardless of score (positive or + negative). type: number format: float - parameters: - 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: - type: string - enum: - - json - - media - - proto - 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: + GoogleCloudDialogflowV2beta1StreamingRecognitionResult: + id: GoogleCloudDialogflowV2beta1StreamingRecognitionResult 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 - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string - _.xgafv: - description: V1 error format. - in: query - name: $.xgafv - schema: - type: string - enum: - - '1' - - '2' - x-stackQL-resources: - operations: - id: google.dialogflow.operations - name: operations - title: Operations - methods: - projects_operations_list: - operation: - $ref: '#/paths/~1v3~1projects~1{projectsId}~1operations/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.operations - projects_operations_get: - operation: - $ref: >- - #/paths/~1v3~1projects~1{projectsId}~1operations~1{operationsId}/get - response: - mediaType: application/json + Contains a speech recognition result corresponding to a portion of the + audio that is currently being processed or an indication that this is + the end of the single requested utterance. While end-user audio is being + processed, Dialogflow sends a series of results. Each result may contain + a `transcript` value. A transcript represents a portion of the + utterance. While the recognizer is processing audio, transcript values + may be interim values or finalized values. Once a transcript is + finalized, the `is_final` value is set to true and processing continues + for the next transcript. If + `StreamingDetectIntentRequest.query_input.audio_config.single_utterance` + was true, and the recognizer has completed processing audio, the + `message_type` value is set to `END_OF_SINGLE_UTTERANCE and the + following (last) result contains the last finalized transcript. The + complete end-user utterance is determined by concatenating the finalized + transcript values received for the series of results. In the following + example, single utterance is enabled. In the case where single utterance + is not enabled, result 7 would not occur. ``` Num | transcript | + message_type | is_final --- | ----------------------- | + ----------------------- | -------- 1 | "tube" | TRANSCRIPT | false 2 | + "to be a" | TRANSCRIPT | false 3 | "to be" | TRANSCRIPT | false 4 | "to + be or not to be" | TRANSCRIPT | true 5 | "that's" | TRANSCRIPT | false 6 + | "that is | TRANSCRIPT | false 7 | unset | END_OF_SINGLE_UTTERANCE | + unset 8 | " that is the question" | TRANSCRIPT | true ``` Concatenating + the finalized transcripts with `is_final` set to true, the complete + utterance becomes "to be or not to be that is the question". + type: object + properties: + messageType: + description: Type of the result message. + type: string + enumDescriptions: + - Not specified. Should never be used. + - Message contains a (possibly partial) transcript. + - >- + This event indicates that the server has detected the end of the + user's speech utterance and expects no additional speech. + Therefore, the server will not process additional audio (although + it may subsequently return additional results). The client should + stop sending additional audio data, half-close the gRPC + connection, and wait for any additional results until the server + closes the gRPC connection. This message is only sent if + `single_utterance` was set to `true`, and is not used otherwise. + - Message contains DTMF digits. + - >- + Message contains DTMF digits. Before a message with DTMF_DIGITS is + sent, a message with PARTIAL_DTMF_DIGITS may be sent with DTMF + digits collected up to the time of sending, which represents an + intermediate result. + enum: + - MESSAGE_TYPE_UNSPECIFIED + - TRANSCRIPT + - END_OF_SINGLE_UTTERANCE + - DTMF_DIGITS + - PARTIAL_DTMF_DIGITS + transcript: + description: >- + Transcript text representing the words that the user spoke. + Populated if and only if `message_type` = `TRANSCRIPT`. + type: string + isFinal: + description: >- + If `false`, the `StreamingRecognitionResult` represents an interim + result that may change. If `true`, the recognizer will not return + any further hypotheses about this piece of the audio. May only be + populated for `message_type` = `TRANSCRIPT`. + type: boolean + confidence: + description: >- + The Speech confidence between 0.0 and 1.0 for the current portion of + audio. A higher number indicates an estimated greater likelihood + that the recognized words are correct. The default of 0.0 is a + sentinel value indicating that confidence was not set. This field is + typically only provided if `is_final` is true and you should not + rely on it being accurate or even set. + type: number + format: float + stability: + description: >- + An estimate of the likelihood that the speech recognizer will not + change its guess about this interim recognition result: * If the + value is unspecified or 0.0, Dialogflow didn't compute the + stability. In particular, Dialogflow will only provide stability for + `TRANSCRIPT` results with `is_final = false`. * Otherwise, the value + is in (0.0, 1.0] where 0.0 means completely unstable and 1.0 means + completely stable. + type: number + format: float + speechWordInfo: + description: >- + Word-specific information for the words recognized by Speech in + transcript. Populated if and only if `message_type` = `TRANSCRIPT` + and [InputAudioConfig.enable_word_info] is set. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1SpeechWordInfo' + speechEndOffset: + description: >- + Time offset of the end of this Speech recognition result relative to + the beginning of the audio. Only populated for `message_type` = + `TRANSCRIPT`. + type: string + format: google-duration + languageCode: + description: Detected language code for the transcript. + type: string + dtmfDigits: + description: >- + DTMF digits. Populated if and only if `message_type` = + `DTMF_DIGITS`. + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1TelephonyDtmfEvents' + GoogleCloudDialogflowV2beta1SpeechWordInfo: + id: GoogleCloudDialogflowV2beta1SpeechWordInfo + description: Information for a word recognized by the speech recognizer. + type: object + properties: + word: + description: The word this info is for. + type: string + startOffset: + description: >- + Time offset relative to the beginning of the audio that corresponds + to the start of the spoken word. This is an experimental feature and + the accuracy of the time offset can vary. + type: string + format: google-duration + endOffset: + description: >- + Time offset relative to the beginning of the audio that corresponds + to the end of the spoken word. This is an experimental feature and + the accuracy of the time offset can vary. + type: string + format: google-duration + confidence: + description: >- + The Speech confidence between 0.0 and 1.0 for this word. A higher + number indicates an estimated greater likelihood that the recognized + word is correct. The default of 0.0 is a sentinel value indicating + that confidence was not set. This field is not guaranteed to be + fully stable over time for the same audio input. Users should also + not rely on it to always be provided. + type: number + format: float + GoogleCloudDialogflowV2beta1TelephonyDtmfEvents: + id: GoogleCloudDialogflowV2beta1TelephonyDtmfEvents + description: A wrapper of repeated TelephonyDtmf digits. + type: object + properties: + dtmfEvents: + description: A sequence of TelephonyDtmf digits. + type: array + items: + type: string + enumDescriptions: + - >- + Not specified. This value may be used to indicate an absent + digit. + - 'Number: ''1''.' + - 'Number: ''2''.' + - 'Number: ''3''.' + - 'Number: ''4''.' + - 'Number: ''5''.' + - 'Number: ''6''.' + - 'Number: ''7''.' + - 'Number: ''8''.' + - 'Number: ''9''.' + - 'Number: ''0''.' + - 'Letter: ''A''.' + - 'Letter: ''B''.' + - 'Letter: ''C''.' + - 'Letter: ''D''.' + - 'Asterisk/star: ''*''.' + - 'Pound/diamond/hash/square/gate/octothorpe: ''#''.' + enum: + - TELEPHONY_DTMF_UNSPECIFIED + - DTMF_ONE + - DTMF_TWO + - DTMF_THREE + - DTMF_FOUR + - DTMF_FIVE + - DTMF_SIX + - DTMF_SEVEN + - DTMF_EIGHT + - DTMF_NINE + - DTMF_ZERO + - DTMF_A + - DTMF_B + - DTMF_C + - DTMF_D + - DTMF_STAR + - DTMF_POUND + GoogleCloudDialogflowV2beta1ExportAgentResponse: + id: GoogleCloudDialogflowV2beta1ExportAgentResponse + description: The response message for Agents.ExportAgent. + type: object + properties: + agentUri: + description: >- + The URI to a file containing the exported agent. This field is + populated only if `agent_uri` is specified in `ExportAgentRequest`. + type: string + agentContent: + description: Zip compressed raw byte content for agent. + type: string + format: byte + GoogleCloudDialogflowV2beta1HumanAgentAssistantEvent: + id: GoogleCloudDialogflowV2beta1HumanAgentAssistantEvent + description: >- + Output only. Represents a notification sent to Pub/Sub subscribers for + agent assistant events in a specific conversation. + type: object + properties: + conversation: + description: >- + The conversation this notification refers to. Format: + `projects//conversations/`. + type: string + participant: + description: >- + The participant that the suggestion is compiled for. And This field + is used to call Participants.ListSuggestions API. Format: + `projects//conversations//participants/`. It will not be set in + legacy workflow. HumanAgentAssistantConfig.name for more + information. + type: string + suggestionResults: + description: >- + The suggestion results payload that this notification refers to. It + will only be set when + HumanAgentAssistantConfig.SuggestionConfig.group_suggestion_responses + sets to true. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1SuggestionResult' + GoogleCloudDialogflowV2beta1SuggestionResult: + id: GoogleCloudDialogflowV2beta1SuggestionResult + description: >- + One response of different type of suggestion response which is used in + the response of Participants.AnalyzeContent and + Participants.AnalyzeContent, as well as HumanAgentAssistantEvent. + type: object + properties: + error: + description: Error status if the request failed. + $ref: '#/components/schemas/GoogleRpcStatus' + suggestArticlesResponse: + description: SuggestArticlesResponse if request is for ARTICLE_SUGGESTION. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1SuggestArticlesResponse + suggestKnowledgeAssistResponse: + description: SuggestKnowledgeAssistResponse if request is for KNOWLEDGE_ASSIST. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1SuggestKnowledgeAssistResponse + suggestFaqAnswersResponse: + description: SuggestFaqAnswersResponse if request is for FAQ_ANSWER. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse + suggestSmartRepliesResponse: + description: SuggestSmartRepliesResponse if request is for SMART_REPLY. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1SuggestSmartRepliesResponse + suggestDialogflowAssistsResponse: + description: >- + SuggestDialogflowAssistsResponse if request is for + DIALOGFLOW_ASSIST. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1SuggestDialogflowAssistsResponse + suggestEntityExtractionResponse: + description: >- + SuggestDialogflowAssistsResponse if request is for + ENTITY_EXTRACTION. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1SuggestDialogflowAssistsResponse + generateSuggestionsResponse: + description: >- + Suggestions generated using generators triggered by customer or + agent messages. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse + GoogleCloudDialogflowV2beta1SuggestArticlesResponse: + id: GoogleCloudDialogflowV2beta1SuggestArticlesResponse + description: The response message for Participants.SuggestArticles. + type: object + properties: + articleAnswers: + description: Output only. Articles ordered by score in descending order. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1ArticleAnswer' + latestMessage: + description: >- + The name of the latest conversation message used to compile + suggestion for. Format: + `projects//locations//conversations//messages/`. + type: string + contextSize: + description: >- + Number of messages prior to and including latest_message to compile + the suggestion. It may be smaller than the + SuggestArticlesResponse.context_size field in the request if there + aren't that many messages in the conversation. + type: integer + format: int32 + GoogleCloudDialogflowV2beta1ArticleAnswer: + id: GoogleCloudDialogflowV2beta1ArticleAnswer + description: Represents article answer. + type: object + properties: + title: + description: The article title. + type: string + uri: + description: The article URI. + type: string + snippets: + description: Output only. Article snippets. + type: array + items: + type: string + metadata: + description: >- + A map that contains metadata about the answer and the document from + which it originates. + type: object + additionalProperties: + type: string + answerRecord: + description: >- + The name of answer record, in the format of + "projects//locations//answerRecords/" + type: string + GoogleCloudDialogflowV2beta1SuggestKnowledgeAssistResponse: + id: GoogleCloudDialogflowV2beta1SuggestKnowledgeAssistResponse + description: The response message for Participants.SuggestKnowledgeAssist. + type: object + properties: + knowledgeAssistAnswer: + description: Output only. Knowledge Assist suggestion. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1KnowledgeAssistAnswer + latestMessage: + description: >- + The name of the latest conversation message used to compile + suggestion for. Format: + `projects//locations//conversations//messages/`. + type: string + contextSize: + description: >- + Number of messages prior to and including latest_message to compile + the suggestion. It may be smaller than the + SuggestKnowledgeAssistRequest.context_size field in the request if + there are fewer messages in the conversation. + type: integer + format: int32 + GoogleCloudDialogflowV2beta1KnowledgeAssistAnswer: + id: GoogleCloudDialogflowV2beta1KnowledgeAssistAnswer + description: Represents a Knowledge Assist answer. + type: object + properties: + suggestedQuery: + description: >- + The query suggested based on the context. Suggestion is made only if + it is different from the previous suggestion. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerSuggestedQuery + suggestedQueryAnswer: + description: >- + The answer generated for the suggested query. Whether or not an + answer is generated depends on how confident we are about the + generated query. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswer + answerRecord: + description: >- + The name of the answer record. Format: `projects//locations//answer + Records/`. + type: string + GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerSuggestedQuery: + id: GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerSuggestedQuery + description: Represents a suggested query. + type: object + properties: + queryText: + description: Suggested query text. + type: string + GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswer: + id: GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswer + description: >- + Represents an answer from Knowledge. Currently supports FAQ and + Generative answers. + type: object + properties: + answerText: + description: >- + The piece of text from the `source` that answers this suggested + query. + type: string + faqSource: + description: Populated if the prediction came from FAQ. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerFaqSource + generativeSource: + description: Populated if the prediction was Generative. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource + GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerFaqSource: + id: >- + GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerFaqSource + description: Details about source of FAQ answer. + type: object + properties: + question: + description: The corresponding FAQ question. + type: string + GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource: + id: >- + GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource + description: Details about source of Generative answer. + type: object + properties: + snippets: + description: >- + All snippets used for this Generative Prediction, with their source + URI and data. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet + GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet: + id: >- + GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet + description: Snippet Source for a Generative Prediction. + type: object + properties: + uri: + description: URI the data is sourced from. + type: string + text: + description: Text taken from that URI. + type: string + title: + description: Title of the document. + type: string + metadata: + description: Metadata of the document. + type: object + additionalProperties: + type: any + description: Properties of the object. + GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse: + id: GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse + description: The request message for Participants.SuggestFaqAnswers. + type: object + properties: + faqAnswers: + description: Output only. Answers extracted from FAQ documents. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1FaqAnswer' + latestMessage: + description: >- + The name of the latest conversation message used to compile + suggestion for. Format: + `projects//locations//conversations//messages/`. + type: string + contextSize: + description: >- + Number of messages prior to and including latest_message to compile + the suggestion. It may be smaller than the + SuggestFaqAnswersRequest.context_size field in the request if there + aren't that many messages in the conversation. + type: integer + format: int32 + GoogleCloudDialogflowV2beta1FaqAnswer: + id: GoogleCloudDialogflowV2beta1FaqAnswer + description: Represents answer from "frequently asked questions". + type: object + properties: + answer: + description: The piece of text from the `source` knowledge base document. + type: string + confidence: + description: >- + The system's confidence score that this Knowledge answer is a good + match for this conversational query, range from 0.0 (completely + uncertain) to 1.0 (completely certain). + type: number + format: float + question: + description: The corresponding FAQ question. + type: string + source: + description: >- + Indicates which Knowledge Document this answer was extracted from. + Format: `projects//locations//agent/knowledgeBases//documents/`. + type: string + metadata: + description: >- + A map that contains metadata about the answer and the document from + which it originates. + type: object + additionalProperties: + type: string + answerRecord: + description: >- + The name of answer record, in the format of + "projects//locations//answerRecords/" + type: string + GoogleCloudDialogflowV2beta1SuggestSmartRepliesResponse: + id: GoogleCloudDialogflowV2beta1SuggestSmartRepliesResponse + description: The response message for Participants.SuggestSmartReplies. + type: object + properties: + smartReplyAnswers: + description: >- + Output only. Multiple reply options provided by smart reply service. + The order is based on the rank of the model prediction. The maximum + number of the returned replies is set in SmartReplyConfig. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1SmartReplyAnswer' + latestMessage: + description: >- + The name of the latest conversation message used to compile + suggestion for. Format: + `projects//locations//conversations//messages/`. + type: string + contextSize: + description: >- + Number of messages prior to and including latest_message to compile + the suggestion. It may be smaller than the + SuggestSmartRepliesRequest.context_size field in the request if + there aren't that many messages in the conversation. + type: integer + format: int32 + GoogleCloudDialogflowV2beta1SmartReplyAnswer: + id: GoogleCloudDialogflowV2beta1SmartReplyAnswer + description: Represents a smart reply answer. + type: object + properties: + reply: + description: The content of the reply. + type: string + confidence: + description: >- + Smart reply confidence. The system's confidence score that this + reply is a good match for this conversation, as a value from 0.0 + (completely uncertain) to 1.0 (completely certain). + type: number + format: float + answerRecord: + description: >- + The name of answer record, in the format of + "projects//locations//answerRecords/" + type: string + GoogleCloudDialogflowV2beta1SuggestDialogflowAssistsResponse: + id: GoogleCloudDialogflowV2beta1SuggestDialogflowAssistsResponse + description: The response message for Participants.SuggestDialogflowAssists. + type: object + properties: + dialogflowAssistAnswers: + description: >- + Output only. Multiple reply options provided by Dialogflow assist + service. The order is based on the rank of the model prediction. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1DialogflowAssistAnswer + latestMessage: + description: >- + The name of the latest conversation message used to suggest answer. + Format: `projects//locations//conversations//messages/`. + type: string + contextSize: + description: >- + Number of messages prior to and including latest_message to compile + the suggestion. It may be smaller than the + SuggestDialogflowAssistsRequest.context_size field in the request if + there aren't that many messages in the conversation. + type: integer + format: int32 + GoogleCloudDialogflowV2beta1DialogflowAssistAnswer: + id: GoogleCloudDialogflowV2beta1DialogflowAssistAnswer + description: Represents a Dialogflow assist answer. + type: object + properties: + queryResult: + description: Result from v2 agent. + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1QueryResult' + intentSuggestion: + description: An intent suggestion generated from conversation. + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1IntentSuggestion' + answerRecord: + description: >- + The name of answer record, in the format of + "projects//locations//answerRecords/" + type: string + GoogleCloudDialogflowV2beta1QueryResult: + id: GoogleCloudDialogflowV2beta1QueryResult + description: Represents the result of conversational query or event processing. + type: object + properties: + queryText: + description: >- + The original conversational query text: - If natural language text + was provided as input, `query_text` contains a copy of the input. - + If natural language speech audio was provided as input, `query_text` + contains the speech recognition result. If speech recognizer + produced multiple alternatives, a particular one is picked. - If + automatic spell correction is enabled, `query_text` will contain the + corrected user input. + type: string + languageCode: + description: >- + The language that was triggered during intent detection. See + [Language + Support](https://cloud.google.com/dialogflow/docs/reference/language) + for a list of the currently supported language codes. + type: string + speechRecognitionConfidence: + description: >- + The Speech recognition confidence between 0.0 and 1.0. A higher + number indicates an estimated greater likelihood that the recognized + words are correct. The default of 0.0 is a sentinel value indicating + that confidence was not set. This field is not guaranteed to be + accurate or set. In particular this field isn't set for + StreamingDetectIntent since the streaming endpoint has separate + confidence estimates per portion of the audio in + StreamingRecognitionResult. + type: number + format: float + action: + description: The action name from the matched intent. + type: string + parameters: + description: >- + The collection of extracted parameters. Depending on your protocol + or client library language, this is a map, associative array, symbol + table, dictionary, or JSON object composed of a collection of + (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: + parameter name * MapValue type: If parameter's entity type is a + composite entity then use map, otherwise, depending on the parameter + value type, it could be one of string, number, boolean, null, list + or map. * MapValue value: If parameter's entity type is a composite + entity then use map from composite entity property names to property + values, otherwise, use parameter value. + type: object + additionalProperties: + type: any + description: Properties of the object. + allRequiredParamsPresent: + description: >- + This field is set to: - `false` if the matched intent has required + parameters and not all of the required parameter values have been + collected. - `true` if all required parameter values have been + collected, or if the matched intent doesn't contain any required + parameters. + type: boolean + cancelsSlotFilling: + description: >- + Indicates whether the conversational query triggers a cancellation + for slot filling. For more information, see the [cancel slot filling + documentation](https://cloud.google.com/dialogflow/es/docs/intents-actions-parameters#cancel). + type: boolean + fulfillmentText: + description: >- + The text to be pronounced to the user or shown on the screen. Note: + This is a legacy field, `fulfillment_messages` should be preferred. + type: string + fulfillmentMessages: + description: The collection of rich messages to present to the user. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1IntentMessage' + webhookSource: + description: >- + If the query was fulfilled by a webhook call, this field is set to + the value of the `source` field returned in the webhook response. + type: string + webhookPayload: + description: >- + If the query was fulfilled by a webhook call, this field is set to + the value of the `payload` field returned in the webhook response. + type: object + additionalProperties: + type: any + description: Properties of the object. + outputContexts: + description: >- + The collection of output contexts. If applicable, + `output_contexts.parameters` contains entries with name `.original` + containing the original parameter values before the query. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1Context' + intent: + description: >- + The intent that matched the conversational query. Some, not all + fields are filled in this message, including but not limited to: + `name`, `display_name`, `end_interaction` and `is_fallback`. + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1Intent' + intentDetectionConfidence: + description: >- + The intent detection confidence. Values range from 0.0 (completely + uncertain) to 1.0 (completely certain). This value is for + informational purpose only and is only used to help match the best + intent within the classification threshold. This value may change + for the same end-user expression at any time due to a model + retraining or change in implementation. If there are `multiple + knowledge_answers` messages, this value is set to the greatest + `knowledgeAnswers.match_confidence` value in the list. + type: number + format: float + diagnosticInfo: + description: >- + Free-form diagnostic information for the associated detect intent + request. The fields of this data can change without notice, so you + should not write code that depends on its structure. The data may + contain: - webhook call latency - webhook errors + type: object + additionalProperties: + type: any + description: Properties of the object. + sentimentAnalysisResult: + description: >- + The sentiment analysis result, which depends on the + `sentiment_analysis_request_config` specified in the request. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1SentimentAnalysisResult + knowledgeAnswers: + description: >- + The result from Knowledge Connector (if any), ordered by decreasing + `KnowledgeAnswers.match_confidence`. + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1KnowledgeAnswers' + GoogleCloudDialogflowV2beta1KnowledgeAnswers: + id: GoogleCloudDialogflowV2beta1KnowledgeAnswers + description: Represents the result of querying a Knowledge base. + type: object + properties: + answers: + description: A list of answers from Knowledge Connector. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer + GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer: + id: GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer + description: An answer from Knowledge Connector. + type: object + properties: + source: + description: >- + Indicates which Knowledge Document this answer was extracted from. + Format: `projects//knowledgeBases//documents/`. + type: string + faqQuestion: + description: >- + The corresponding FAQ question if the answer was extracted from a + FAQ Document, empty otherwise. + type: string + answer: + description: >- + The piece of text from the `source` knowledge base document that + answers this conversational query. + type: string + matchConfidenceLevel: + description: >- + The system's confidence level that this knowledge answer is a good + match for this conversational query. NOTE: The confidence level for + a given `` pair may change without notice, as it depends on models + that are constantly being improved. However, it will change less + frequently than the confidence score below, and should be preferred + for referencing the quality of an answer. + type: string + enumDescriptions: + - Not specified. + - Indicates that the confidence is low. + - Indicates our confidence is medium. + - Indicates our confidence is high. + enum: + - MATCH_CONFIDENCE_LEVEL_UNSPECIFIED + - LOW + - MEDIUM + - HIGH + matchConfidence: + description: >- + The system's confidence score that this Knowledge answer is a good + match for this conversational query. The range is from 0.0 + (completely uncertain) to 1.0 (completely certain). Note: The + confidence score is likely to vary somewhat (possibly even for + identical requests), as the underlying model is under constant + improvement. It may be deprecated in the future. We recommend using + `match_confidence_level` which should be generally more stable. + type: number + format: float + GoogleCloudDialogflowV2beta1IntentSuggestion: + id: GoogleCloudDialogflowV2beta1IntentSuggestion + description: Represents an intent suggestion. + type: object + properties: + displayName: + description: The display name of the intent. + type: string + intentV2: + description: >- + The unique identifier of this intent. Format: + `projects//locations//agent/intents/`. + type: string + description: + description: >- + Human readable description for better understanding an intent like + its scope, content, result etc. Maximum character limit: 140 + characters. + type: string + GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse: + id: GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse + description: The response message for Conversations.GenerateSuggestions. + type: object + properties: + generatorSuggestionAnswers: + description: The answers generated for the conversation based on context. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer + latestMessage: + description: >- + The name of the latest conversation message used as context for + compiling suggestion. Format: + `projects//locations//conversations//messages/`. + type: string + GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer: + id: >- + GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer + description: A GeneratorSuggestion answer. + type: object + properties: + generatorSuggestion: + description: Suggestion details. + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1GeneratorSuggestion' + sourceGenerator: + description: >- + The name of the generator used to generate this suggestion. Format: + `projects//locations//generators/`. + type: string + answerRecord: + description: >- + Answer record that uniquely identifies the suggestion. This can be + used to provide suggestion feedback. + type: string + GoogleCloudDialogflowV2beta1GeneratorSuggestion: + id: GoogleCloudDialogflowV2beta1GeneratorSuggestion + description: Suggestion generated using a Generator. + type: object + properties: + freeFormSuggestion: + description: Optional. Free form suggestion. + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1FreeFormSuggestion' + summarySuggestion: + description: Optional. Suggested summary. + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1SummarySuggestion' + toolCallInfo: + description: Optional. List of request and response for tool calls executed. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1GeneratorSuggestionToolCallInfo + GoogleCloudDialogflowV2beta1FreeFormSuggestion: + id: GoogleCloudDialogflowV2beta1FreeFormSuggestion + description: Suggestion generated using free form generator. + type: object + properties: + response: + description: Required. Free form suggestion. + type: string + GoogleCloudDialogflowV2beta1SummarySuggestion: + id: GoogleCloudDialogflowV2beta1SummarySuggestion + description: Suggested summary of the conversation. + type: object + properties: + summarySections: + description: Required. All the parts of generated summary. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1SummarySuggestionSummarySection + GoogleCloudDialogflowV2beta1SummarySuggestionSummarySection: + id: GoogleCloudDialogflowV2beta1SummarySuggestionSummarySection + description: A component of the generated summary. + type: object + properties: + section: + description: Required. Name of the section. + type: string + summary: + description: Required. Summary text for the section. + type: string + GoogleCloudDialogflowV2beta1GeneratorSuggestionToolCallInfo: + id: GoogleCloudDialogflowV2beta1GeneratorSuggestionToolCallInfo + description: Request and response for a tool call. + type: object + properties: + toolCall: + description: Required. Request for a tool call. + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1ToolCall' + toolCallResult: + description: Required. Response for a tool call. + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1ToolCallResult' + GoogleCloudDialogflowV2beta1ToolCall: + id: GoogleCloudDialogflowV2beta1ToolCall + description: Represents a call of a specific tool's action with the specified inputs. + type: object + properties: + tool: + description: >- + Optional. The tool associated with this call. Format: + `projects//locations//tools/`. + type: string + action: + description: Optional. The name of the tool's action associated with this call. + type: string + inputParameters: + description: Optional. The action's input parameters. + type: object + additionalProperties: + type: any + description: Properties of the object. + createTime: + description: Output only. Create time of the tool call. + readOnly: true + type: string + format: google-datetime + GoogleCloudDialogflowV2beta1ToolCallResult: + id: GoogleCloudDialogflowV2beta1ToolCallResult + description: The result of calling a tool's action. + type: object + properties: + tool: + description: >- + Optional. The tool associated with this call. Format: + `projects//locations//tools/`. + type: string + action: + description: Optional. The name of the tool's action associated with this call. + type: string + error: + description: The tool call's error. + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1ToolCallResultError' + rawContent: + description: >- + Only populated if the response content is not utf-8 encoded. (by + definition byte fields are base64 encoded). + type: string + format: byte + content: + description: Only populated if the response content is utf-8 encoded. + type: string + createTime: + description: Output only. Create time of the tool call result. + readOnly: true + type: string + format: google-datetime + GoogleCloudDialogflowV2beta1ToolCallResultError: + id: GoogleCloudDialogflowV2beta1ToolCallResultError + description: An error produced by the tool call. + type: object + properties: + message: + description: Optional. The error message of the function. + type: string + GoogleCloudDialogflowV2beta1ImportDocumentsResponse: + id: GoogleCloudDialogflowV2beta1ImportDocumentsResponse + description: Response message for Documents.ImportDocuments. + type: object + properties: + warnings: + description: Includes details about skipped documents or any other warnings. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata: + id: GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata + description: Metadata for initializing a location-level encryption specification. + type: object + properties: + request: + description: Output only. The original request for initialization. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest + GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest: + id: GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest + description: The request to initialize a location-level encryption specification. + type: object + properties: + encryptionSpec: + description: >- + Required. The encryption spec used for CMEK encryption. It is + required that the kms key is in the same region as the endpoint. The + same key will be used for all provisioned resources, if encryption + is available. If the kms_key_name is left empty, no encryption will + be enforced. + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1EncryptionSpec' + GoogleCloudDialogflowV2beta1EncryptionSpec: + id: GoogleCloudDialogflowV2beta1EncryptionSpec + description: >- + A customer-managed encryption key specification that can be applied to + all created resources (e.g. Conversation). + type: object + properties: + name: + description: >- + Immutable. The resource name of the encryption key specification + resource. Format: + projects/{project}/locations/{location}/encryptionSpec + type: string + kmsKey: + description: >- + Required. The name of customer-managed encryption key that is used + to secure a resource and its sub-resources. If empty, the resource + is secured by the default Google encryption key. Only the key in the + same location as this resource is allowed to be used for encryption. + Format: + `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}` + type: string + GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata: + id: GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata + description: Metadata in google::longrunning::Operation for Knowledge operations. + type: object + properties: + state: + description: Required. Output only. The current state of this operation. + readOnly: true + type: string + enumDescriptions: + - State unspecified. + - The operation has been created. + - The operation is currently running. + - The operation is done, either cancelled or completed. + enum: + - STATE_UNSPECIFIED + - PENDING + - RUNNING + - DONE + knowledgeBase: + description: The name of the knowledge base interacted with during the operation. + type: string + exportOperationMetadata: + description: >- + Metadata for the Export Data Operation such as the destination of + export. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1ExportOperationMetadata + doneTime: + description: The time when the operation finished. + type: string + format: google-datetime + GoogleCloudDialogflowV2beta1ExportOperationMetadata: + id: GoogleCloudDialogflowV2beta1ExportOperationMetadata + description: Metadata related to the Export Data Operations (e.g. ExportDocument). + type: object + properties: + exportedGcsDestination: + description: Cloud Storage file path of the exported data. + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1GcsDestination' + GoogleCloudDialogflowV2beta1GcsDestination: + id: GoogleCloudDialogflowV2beta1GcsDestination + description: Google Cloud Storage location for the output. + type: object + properties: + uri: + description: >- + Required. The Google Cloud Storage URIs for the output. A URI is of + the form: `gs://bucket/object-prefix-or-name` Whether a prefix or + name is used depends on the use case. The requesting user must have + "write-permission" to the bucket. + type: string + GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest: + id: GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest + description: >- + Represents the contents of the original request that was passed to the + `[Streaming]DetectIntent` call. + type: object + properties: + source: + description: >- + The source of this request, e.g., `google`, `facebook`, `slack`. It + is set by Dialogflow-owned servers. + type: string + version: + description: >- + Optional. The version of the protocol used for this request. This + field is AoG-specific. + type: string + payload: + description: >- + Optional. This field is set to the value of the + `QueryParameters.payload` field passed in the request. Some + integrations that query a Dialogflow agent may provide additional + information in the payload. In particular, for the Dialogflow Phone + Gateway integration, this field has the form: { "telephony": { + "caller_id": "+18558363987" } } Note: The caller ID field + (`caller_id`) will be redacted for Trial Edition agents and + populated with the caller ID in [E.164 + format](https://en.wikipedia.org/wiki/E.164) for Essentials Edition + agents. + type: object + additionalProperties: + type: any + description: Properties of the object. + GoogleCloudDialogflowV2beta1SetSuggestionFeatureConfigOperationMetadata: + id: GoogleCloudDialogflowV2beta1SetSuggestionFeatureConfigOperationMetadata + description: Metadata for a ConversationProfile.SetSuggestionFeatureConfig operation. + type: object + properties: + conversationProfile: + description: >- + The resource name of the conversation profile. Format: + `projects//locations//conversationProfiles/` + type: string + participantRole: + description: >- + Required. The participant role to add or update the suggestion + feature config. Only HUMAN_AGENT or END_USER can be used. + type: string + enumDescriptions: + - Participant role not set. + - Participant is a human agent. + - Participant is an automated agent, such as a Dialogflow agent. + - >- + Participant is an end user that has called or chatted with + Dialogflow services. + enum: + - ROLE_UNSPECIFIED + - HUMAN_AGENT + - AUTOMATED_AGENT + - END_USER + suggestionFeatureType: + description: Required. The type of the suggestion feature to add or update. + type: string + enumDescriptions: + - Unspecified feature type. + - Run article suggestion model for chat. + - Run FAQ model. + - Run smart reply model for chat. + - >- + Run Dialogflow assist model for chat, which will return automated + agent response as suggestion. + - Run conversation summarization model for chat. + - >- + Run knowledge search with text input from agent or text generated + query. + - Run knowledge assist with automatic query generation. + enum: + - TYPE_UNSPECIFIED + - ARTICLE_SUGGESTION + - FAQ + - SMART_REPLY + - DIALOGFLOW_ASSIST + - CONVERSATION_SUMMARIZATION + - KNOWLEDGE_SEARCH + - KNOWLEDGE_ASSIST + createTime: + description: >- + Timestamp whe the request was created. The time is measured on + server side. + type: string + format: google-datetime + GoogleCloudDialogflowV2beta1WebhookRequest: + id: GoogleCloudDialogflowV2beta1WebhookRequest + description: The request message for a webhook call. + type: object + properties: + session: + description: >- + The unique identifier of detectIntent request session. Can be used + to identify end-user inside webhook implementation. Supported + formats: - `projects//agent/sessions/, - + `projects//locations//agent/sessions/`, - + `projects//agent/environments//users//sessions/`, - + `projects//locations//agent/environments//users//sessions/`, + type: string + responseId: + description: >- + The unique identifier of the response. Contains the same value as + `[Streaming]DetectIntentResponse.response_id`. + type: string + queryResult: + description: >- + The result of the conversational query or event processing. Contains + the same value as `[Streaming]DetectIntentResponse.query_result`. + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1QueryResult' + alternativeQueryResults: + description: Alternative query results from KnowledgeService. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1QueryResult' + originalDetectIntentRequest: + description: >- + Optional. The contents of the original request that was passed to + `[Streaming]DetectIntent` call. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest + GoogleCloudDialogflowV2beta1WebhookResponse: + id: GoogleCloudDialogflowV2beta1WebhookResponse + description: >- + The response message for a webhook call. This response is validated by + the Dialogflow server. If validation fails, an error will be returned in + the QueryResult.diagnostic_info field. Setting JSON fields to an empty + value with the wrong type is a common error. To avoid this error: - Use + `""` for empty strings - Use `{}` or `null` for empty objects - Use `[]` + or `null` for empty arrays For more information, see the [Protocol + Buffers Language + Guide](https://developers.google.com/protocol-buffers/docs/proto3#json). + type: object + properties: + fulfillmentText: + description: >- + Optional. The text response message intended for the end-user. It is + recommended to use `fulfillment_messages.text.text[0]` instead. When + provided, Dialogflow uses this field to populate + QueryResult.fulfillment_text sent to the integration or API caller. + type: string + fulfillmentMessages: + description: >- + Optional. The rich response messages intended for the end-user. When + provided, Dialogflow uses this field to populate + QueryResult.fulfillment_messages sent to the integration or API + caller. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1IntentMessage' + source: + description: >- + Optional. A custom field used to identify the webhook source. + Arbitrary strings are supported. When provided, Dialogflow uses this + field to populate QueryResult.webhook_source sent to the integration + or API caller. + type: string + payload: + description: >- + Optional. This field can be used to pass custom data from your + webhook to the integration or API caller. Arbitrary JSON objects are + supported. When provided, Dialogflow uses this field to populate + QueryResult.webhook_payload sent to the integration or API caller. + This field is also used by the [Google Assistant + integration](https://cloud.google.com/dialogflow/docs/integrations/aog) + for rich response messages. See the format definition at [Google + Assistant Dialogflow webhook + format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json) + type: object + additionalProperties: + type: any + description: Properties of the object. + outputContexts: + description: >- + Optional. The collection of output contexts that will overwrite + currently active contexts for the session and reset their lifespans. + When provided, Dialogflow uses this field to populate + QueryResult.output_contexts sent to the integration or API caller. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1Context' + followupEventInput: + description: >- + Optional. Invokes the supplied events. When this field is set, + Dialogflow ignores the `fulfillment_text`, `fulfillment_messages`, + and `payload` fields. + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1EventInput' + liveAgentHandoff: + description: >- + Indicates that a live agent should be brought in to handle the + interaction with the user. In most cases, when you set this flag to + true, you would also want to set end_interaction to true as well. + Default is false. + type: boolean + endInteraction: + description: >- + Optional. Indicates that this intent ends an interaction. Some + integrations (e.g., Actions on Google or Dialogflow phone gateway) + use this information to close interaction with an end user. Default + is false. + type: boolean + sessionEntityTypes: + description: >- + Optional. Additional session entity types to replace or extend + developer entity types with. The entity synonyms apply to all + languages and persist for the session. Setting this data from a + webhook overwrites the session entity types that have been set using + `detectIntent`, `streamingDetectIntent` or SessionEntityType + management methods. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1SessionEntityType' + GoogleCloudDialogflowV2beta1EventInput: + id: GoogleCloudDialogflowV2beta1EventInput + description: >- + Events allow for matching intents by event name instead of the natural + language input. For instance, input `` can trigger a personalized + welcome response. The parameter `name` may be used by the agent in the + response: `"Hello #welcome_event.name! What can I do for you today?"`. + type: object + properties: + name: + description: Required. The unique identifier of the event. + type: string + parameters: + description: >- + The collection of parameters associated with the event. Depending on + your protocol or client library language, this is a map, associative + array, symbol table, dictionary, or JSON object composed of a + collection of (MapKey, MapValue) pairs: * MapKey type: string * + MapKey value: parameter name * MapValue type: If parameter's entity + type is a composite entity then use map, otherwise, depending on the + parameter value type, it could be one of string, number, boolean, + null, list or map. * MapValue value: If parameter's entity type is a + composite entity then use map from composite entity property names + to property values, otherwise, use parameter value. + type: object + additionalProperties: + type: any + description: Properties of the object. + languageCode: + description: >- + Required. The language of this query. See [Language + Support](https://cloud.google.com/dialogflow/docs/reference/language) + for a list of the currently supported language codes. Note that + queries in the same session do not necessarily need to specify the + same language. This field is ignored when used in the context of a + WebhookResponse.followup_event_input field, because the language was + already defined in the originating detect intent request. + type: string + GoogleCloudDialogflowV2beta1SessionEntityType: + id: GoogleCloudDialogflowV2beta1SessionEntityType + description: >- + A session represents a conversation between a Dialogflow agent and an + end-user. You can create special entities, called session entities, + during a session. Session entities can extend or replace custom entity + types and only exist during the session that they were created for. All + session data, including session entities, is stored by Dialogflow for 20 + minutes. For more information, see the [session entity + guide](https://cloud.google.com/dialogflow/docs/entities-session). + type: object + properties: + name: + description: >- + Required. The unique identifier of this session entity type. + Supported formats: - `projects//agent/sessions//entityTypes/` - + `projects//locations//agent/sessions//entityTypes/` - + `projects//agent/environments//users//sessions//entityTypes/` - + `projects//locations//agent/environments/ + /users//sessions//entityTypes/` If `Location ID` is not specified we + assume default 'us' location. If `Environment ID` is not specified, + we assume default 'draft' environment. If `User ID` is not + specified, we assume default '-' user. `` must be the display name + of an existing entity type in the same agent that will be overridden + or supplemented. + type: string + entityOverrideMode: + description: >- + Required. Indicates whether the additional data should override or + supplement the custom entity type definition. + type: string + enumDescriptions: + - Not specified. This value should be never used. + - >- + The collection of session entities overrides the collection of + entities in the corresponding custom entity type. + - >- + The collection of session entities extends the collection of + entities in the corresponding custom entity type. Note: Even in + this override mode calls to `ListSessionEntityTypes`, + `GetSessionEntityType`, `CreateSessionEntityType` and + `UpdateSessionEntityType` only return the additional entities + added in this session entity type. If you want to get the + supplemented list, please call EntityTypes.GetEntityType on the + custom entity type and merge. + enum: + - ENTITY_OVERRIDE_MODE_UNSPECIFIED + - ENTITY_OVERRIDE_MODE_OVERRIDE + - ENTITY_OVERRIDE_MODE_SUPPLEMENT + entities: + description: >- + Required. The collection of entities associated with this session + entity type. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1EntityTypeEntity' + GoogleCloudDialogflowV3alpha1ConversationSignals: + id: GoogleCloudDialogflowV3alpha1ConversationSignals + description: >- + This message is used to hold all the Conversation Signals data, which + will be converted to JSON and exported to BigQuery. + type: object + properties: + turnSignals: + description: Required. Turn signals for the current turn. + $ref: '#/components/schemas/GoogleCloudDialogflowV3alpha1TurnSignals' + GoogleCloudDialogflowV3alpha1TurnSignals: + id: GoogleCloudDialogflowV3alpha1TurnSignals + description: >- + Collection of all signals that were extracted for a single turn of the + conversation. + type: object + properties: + noMatch: + description: Whether NLU predicted NO_MATCH. + type: boolean + noUserInput: + description: Whether user provided no input. + type: boolean + dtmfUsed: + description: Whether user was using DTMF input. + type: boolean + userEscalated: + description: Whether user was specifically asking for a live agent. + type: boolean + agentEscalated: + description: Whether agent responded with LiveAgentHandoff fulfillment. + type: boolean + triggeredAbandonmentEvent: + description: >- + Whether agent has triggered the event corresponding to user + abandoning the conversation. + type: boolean + reachedEndPage: + description: Whether turn resulted in End Session page. + type: boolean + webhookStatuses: + description: Human-readable statuses of the webhooks triggered during this turn. + type: array + items: + type: string + failureReasons: + description: Failure reasons of the turn. + type: array + items: + type: string + enumDescriptions: + - Failure reason is not assigned. + - Whether NLU failed to recognize user intent. + - Whether webhook failed during the turn. + enum: + - FAILURE_REASON_UNSPECIFIED + - FAILED_INTENT + - FAILED_WEBHOOK + sentimentScore: + description: >- + Sentiment score of the user utterance if + [sentiment](https://cloud.google.com/dialogflow/cx/docs/concept/sentiment) + was enabled. + type: number + format: float + sentimentMagnitude: + description: >- + Sentiment magnitude of the user utterance if + [sentiment](https://cloud.google.com/dialogflow/cx/docs/concept/sentiment) + was enabled. + type: number + format: float + parameters: + 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: + type: string + enum: + - json + - media + - proto + 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 + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + x-stackQL-resources: + operations: + id: google.dialogflow.operations + name: operations + title: Operations + methods: + projects_operations_list: + operation: + $ref: '#/paths/~1v3~1projects~1{projectsId}~1operations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.operations + projects_operations_get: + operation: + $ref: >- + #/paths/~1v3~1projects~1{projectsId}~1operations~1{operationsId}/get + response: + mediaType: application/json openAPIDocKey: '200' projects_operations_cancel: operation: @@ -15364,15 +17598,99 @@ components: response: mediaType: application/json openAPIDocKey: '200' + projects_locations_agents_playbooks_versions_create: + operation: + $ref: >- + #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1agents~1{agentsId}~1playbooks~1{playbooksId}~1versions/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_agents_playbooks_versions_list: + operation: + $ref: >- + #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1agents~1{agentsId}~1playbooks~1{playbooksId}~1versions/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.playbookVersions + projects_locations_agents_playbooks_versions_get: + operation: + $ref: >- + #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1agents~1{agentsId}~1playbooks~1{playbooksId}~1versions~1{versionsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_agents_playbooks_versions_delete: + operation: + $ref: >- + #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1agents~1{agentsId}~1playbooks~1{playbooksId}~1versions~1{versionsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_agents_playbooks_versions_restore: + operation: + $ref: >- + #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1agents~1{agentsId}~1playbooks~1{playbooksId}~1versions~1{versionsId}:restore/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_agents_tools_versions_list: + operation: + $ref: >- + #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1agents~1{agentsId}~1tools~1{toolsId}~1versions/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.toolVersions + projects_locations_agents_tools_versions_create: + operation: + $ref: >- + #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1agents~1{agentsId}~1tools~1{toolsId}~1versions/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_agents_tools_versions_get: + operation: + $ref: >- + #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1agents~1{agentsId}~1tools~1{toolsId}~1versions~1{versionsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_agents_tools_versions_delete: + operation: + $ref: >- + #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1agents~1{agentsId}~1tools~1{toolsId}~1versions~1{versionsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_agents_tools_versions_restore: + operation: + $ref: >- + #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1agents~1{agentsId}~1tools~1{toolsId}~1versions~1{versionsId}:restore/post + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/versions/methods/projects_locations_agents_flows_versions_get + - $ref: >- + #/components/x-stackQL-resources/versions/methods/projects_locations_agents_playbooks_versions_get + - $ref: >- + #/components/x-stackQL-resources/versions/methods/projects_locations_agents_tools_versions_get - $ref: >- #/components/x-stackQL-resources/versions/methods/projects_locations_agents_flows_versions_list + - $ref: >- + #/components/x-stackQL-resources/versions/methods/projects_locations_agents_playbooks_versions_list + - $ref: >- + #/components/x-stackQL-resources/versions/methods/projects_locations_agents_tools_versions_list insert: - $ref: >- #/components/x-stackQL-resources/versions/methods/projects_locations_agents_flows_versions_create + - $ref: >- + #/components/x-stackQL-resources/versions/methods/projects_locations_agents_playbooks_versions_create + - $ref: >- + #/components/x-stackQL-resources/versions/methods/projects_locations_agents_tools_versions_create update: - $ref: >- #/components/x-stackQL-resources/versions/methods/projects_locations_agents_flows_versions_patch @@ -15380,6 +17698,10 @@ components: delete: - $ref: >- #/components/x-stackQL-resources/versions/methods/projects_locations_agents_flows_versions_delete + - $ref: >- + #/components/x-stackQL-resources/versions/methods/projects_locations_agents_playbooks_versions_delete + - $ref: >- + #/components/x-stackQL-resources/versions/methods/projects_locations_agents_tools_versions_delete changelogs: id: google.dialogflow.changelogs name: changelogs @@ -16154,6 +18476,191 @@ components: delete: - $ref: >- #/components/x-stackQL-resources/generators/methods/projects_locations_agents_generators_delete + playbooks: + id: google.dialogflow.playbooks + name: playbooks + title: Playbooks + methods: + projects_locations_agents_playbooks_create: + operation: + $ref: >- + #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1agents~1{agentsId}~1playbooks/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_agents_playbooks_list: + operation: + $ref: >- + #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1agents~1{agentsId}~1playbooks/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.playbooks + projects_locations_agents_playbooks_delete: + operation: + $ref: >- + #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1agents~1{agentsId}~1playbooks~1{playbooksId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_agents_playbooks_get: + operation: + $ref: >- + #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1agents~1{agentsId}~1playbooks~1{playbooksId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_agents_playbooks_patch: + operation: + $ref: >- + #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1agents~1{agentsId}~1playbooks~1{playbooksId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_agents_playbooks_export: + operation: + $ref: >- + #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1agents~1{agentsId}~1playbooks~1{playbooksId}:export/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_agents_playbooks_import: + operation: + $ref: >- + #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1agents~1{agentsId}~1playbooks:import/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/playbooks/methods/projects_locations_agents_playbooks_get + - $ref: >- + #/components/x-stackQL-resources/playbooks/methods/projects_locations_agents_playbooks_list + insert: + - $ref: >- + #/components/x-stackQL-resources/playbooks/methods/projects_locations_agents_playbooks_create + update: + - $ref: >- + #/components/x-stackQL-resources/playbooks/methods/projects_locations_agents_playbooks_patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/playbooks/methods/projects_locations_agents_playbooks_delete + examples: + id: google.dialogflow.examples + name: examples + title: Examples + methods: + projects_locations_agents_playbooks_examples_create: + operation: + $ref: >- + #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1agents~1{agentsId}~1playbooks~1{playbooksId}~1examples/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_agents_playbooks_examples_list: + operation: + $ref: >- + #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1agents~1{agentsId}~1playbooks~1{playbooksId}~1examples/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.examples + projects_locations_agents_playbooks_examples_delete: + operation: + $ref: >- + #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1agents~1{agentsId}~1playbooks~1{playbooksId}~1examples~1{examplesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_agents_playbooks_examples_get: + operation: + $ref: >- + #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1agents~1{agentsId}~1playbooks~1{playbooksId}~1examples~1{examplesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_agents_playbooks_examples_patch: + operation: + $ref: >- + #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1agents~1{agentsId}~1playbooks~1{playbooksId}~1examples~1{examplesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/examples/methods/projects_locations_agents_playbooks_examples_get + - $ref: >- + #/components/x-stackQL-resources/examples/methods/projects_locations_agents_playbooks_examples_list + insert: + - $ref: >- + #/components/x-stackQL-resources/examples/methods/projects_locations_agents_playbooks_examples_create + update: + - $ref: >- + #/components/x-stackQL-resources/examples/methods/projects_locations_agents_playbooks_examples_patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/examples/methods/projects_locations_agents_playbooks_examples_delete + tools: + id: google.dialogflow.tools + name: tools + title: Tools + methods: + projects_locations_agents_tools_create: + operation: + $ref: >- + #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1agents~1{agentsId}~1tools/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_agents_tools_list: + operation: + $ref: >- + #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1agents~1{agentsId}~1tools/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.tools + projects_locations_agents_tools_get: + operation: + $ref: >- + #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1agents~1{agentsId}~1tools~1{toolsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_agents_tools_patch: + operation: + $ref: >- + #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1agents~1{agentsId}~1tools~1{toolsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_agents_tools_delete: + operation: + $ref: >- + #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1agents~1{agentsId}~1tools~1{toolsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/tools/methods/projects_locations_agents_tools_get + - $ref: >- + #/components/x-stackQL-resources/tools/methods/projects_locations_agents_tools_list + insert: + - $ref: >- + #/components/x-stackQL-resources/tools/methods/projects_locations_agents_tools_create + update: + - $ref: >- + #/components/x-stackQL-resources/tools/methods/projects_locations_agents_tools_patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/tools/methods/projects_locations_agents_tools_delete paths: /v3/projects/{projectsId}/operations: parameters: &ref_1 @@ -16170,9 +18677,1022 @@ paths: - $ref: '#/components/parameters/_.xgafv' get: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: dialogflow.projects.operations.list + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: dialogflow.projects.operations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/dialogflow + Oauth2c: + - https://www.googleapis.com/auth/dialogflow + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v3/projects/{projectsId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: dialogflow.projects.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/dialogflow + Oauth2c: + - https://www.googleapis.com/auth/dialogflow + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v3/projects/{projectsId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + `1`, corresponding to `Code.CANCELLED`. + operationId: dialogflow.projects.operations.cancel + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/dialogflow + Oauth2c: + - https://www.googleapis.com/auth/dialogflow + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v3/projects/{projectsId}/locations: + parameters: *ref_1 + get: + description: Lists information about the supported locations for this service. + operationId: dialogflow.projects.locations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/dialogflow + Oauth2c: + - https://www.googleapis.com/auth/dialogflow + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudLocationListLocationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: extraLocationTypes + schema: + type: string + /v3/projects/{projectsId}/locations/{locationsId}: + parameters: *ref_1 + get: + description: Gets information about a location. + operationId: dialogflow.projects.locations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/dialogflow + Oauth2c: + - https://www.googleapis.com/auth/dialogflow + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudLocationLocation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v3/projects/{projectsId}/locations/{locationsId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: dialogflow.projects.locations.operations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/dialogflow + Oauth2c: + - https://www.googleapis.com/auth/dialogflow + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v3/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: dialogflow.projects.locations.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/dialogflow + Oauth2c: + - https://www.googleapis.com/auth/dialogflow + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v3/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + `1`, corresponding to `Code.CANCELLED`. + operationId: dialogflow.projects.locations.operations.cancel + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/dialogflow + Oauth2c: + - https://www.googleapis.com/auth/dialogflow + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v3/projects/{projectsId}/locations/{locationsId}/securitySettings: + parameters: *ref_1 + post: + description: Create security settings in the specified location. + operationId: dialogflow.projects.locations.securitySettings.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3SecuritySettings' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/dialogflow + Oauth2c: + - https://www.googleapis.com/auth/dialogflow + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3SecuritySettings' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + get: + description: Returns the list of all security settings in the specified location. + operationId: dialogflow.projects.locations.securitySettings.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/dialogflow + Oauth2c: + - https://www.googleapis.com/auth/dialogflow + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3ListSecuritySettingsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v3/projects/{projectsId}/locations/{locationsId}/securitySettings/{securitySettingsId}: + parameters: *ref_1 + get: + description: >- + Retrieves the specified SecuritySettings. The returned settings may be + stale by up to 1 minute. + operationId: dialogflow.projects.locations.securitySettings.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/dialogflow + Oauth2c: + - https://www.googleapis.com/auth/dialogflow + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3SecuritySettings' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: securitySettingsId + required: true + schema: + type: string + patch: + description: Updates the specified SecuritySettings. + operationId: dialogflow.projects.locations.securitySettings.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3SecuritySettings' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/dialogflow + Oauth2c: + - https://www.googleapis.com/auth/dialogflow + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3SecuritySettings' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: securitySettingsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes the specified SecuritySettings. + operationId: dialogflow.projects.locations.securitySettings.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/dialogflow + Oauth2c: + - https://www.googleapis.com/auth/dialogflow + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: securitySettingsId + required: true + schema: + type: string + /v3/projects/{projectsId}/locations/{locationsId}/agents: + parameters: *ref_1 + get: + description: Returns the list of all agents in the specified location. + operationId: dialogflow.projects.locations.agents.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/dialogflow + Oauth2c: + - https://www.googleapis.com/auth/dialogflow + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3ListAgentsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + post: + description: >- + Creates an agent in the specified location. Note: You should always + train flows prior to sending them queries. See the [training + documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). + operationId: dialogflow.projects.locations.agents.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Agent' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/dialogflow + Oauth2c: + - https://www.googleapis.com/auth/dialogflow + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Agent' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}: + parameters: *ref_1 + get: + description: Retrieves the specified agent. + operationId: dialogflow.projects.locations.agents.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/dialogflow + Oauth2c: + - https://www.googleapis.com/auth/dialogflow + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Agent' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: agentsId + required: true + schema: + type: string + patch: + description: >- + Updates the specified agent. Note: You should always train flows prior + to sending them queries. See the [training + documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). + operationId: dialogflow.projects.locations.agents.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Agent' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/dialogflow + Oauth2c: + - https://www.googleapis.com/auth/dialogflow + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Agent' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: agentsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes the specified agent. + operationId: dialogflow.projects.locations.agents.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/dialogflow + Oauth2c: + - https://www.googleapis.com/auth/dialogflow + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: agentsId + required: true + schema: + type: string + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}:export: + parameters: *ref_1 + post: + description: >- + Exports the specified agent to a binary file. This method is a + [long-running + operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). + The returned `Operation` type has the following method-specific fields: + - `metadata`: An empty [Struct + message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) + - `response`: ExportAgentResponse + operationId: dialogflow.projects.locations.agents.export + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3ExportAgentRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/dialogflow + Oauth2c: + - https://www.googleapis.com/auth/dialogflow + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: agentsId + required: true + schema: + type: string + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}:restore: + parameters: *ref_1 + post: + description: >- + Restores the specified agent from a binary file. Replaces the current + agent with a new one. Note that all existing resources in agent (e.g. + intents, entity types, flows) will be removed. This method is a + [long-running + operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). + The returned `Operation` type has the following method-specific fields: + - `metadata`: An empty [Struct + message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) + - `response`: An [Empty + message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty) + Note: You should always train flows prior to sending them queries. See + the [training + documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). + operationId: dialogflow.projects.locations.agents.restore + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3RestoreAgentRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/dialogflow + Oauth2c: + - https://www.googleapis.com/auth/dialogflow + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: agentsId + required: true + schema: + type: string + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}:validate: + parameters: *ref_1 + post: + description: >- + Validates the specified agent and creates or updates validation results. + The agent in draft version is validated. Please call this API after the + training is completed to get the complete validation results. + operationId: dialogflow.projects.locations.agents.validate + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3ValidateAgentRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/dialogflow + Oauth2c: + - https://www.googleapis.com/auth/dialogflow + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3AgentValidationResult + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: agentsId + required: true + schema: + type: string + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/validationResult: + parameters: *ref_1 + get: + description: >- + Gets the latest agent validation result. Agent validation is performed + when ValidateAgent is called. + operationId: dialogflow.projects.locations.agents.getValidationResult + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/dialogflow + Oauth2c: + - https://www.googleapis.com/auth/dialogflow + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3AgentValidationResult + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: agentsId + required: true + schema: + type: string + - in: query + name: languageCode + schema: + type: string + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/generativeSettings: + parameters: *ref_1 + get: + description: Gets the generative settings for the agent. + operationId: dialogflow.projects.locations.agents.getGenerativeSettings + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/dialogflow + Oauth2c: + - https://www.googleapis.com/auth/dialogflow + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3GenerativeSettings + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: agentsId + required: true + schema: + type: string + - in: query + name: languageCode + schema: + type: string + patch: + description: Updates the generative settings for the agent. + operationId: dialogflow.projects.locations.agents.updateGenerativeSettings + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3GenerativeSettings' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/dialogflow + Oauth2c: + - https://www.googleapis.com/auth/dialogflow + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3GenerativeSettings + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: agentsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows: + parameters: *ref_1 + post: + description: >- + Creates a flow in the specified agent. Note: You should always train a + flow prior to sending it queries. See the [training + documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). + operationId: dialogflow.projects.locations.agents.flows.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Flow' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16188,15 +19708,61 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Flow' parameters: - in: path name: projectsId required: true schema: type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: agentsId + required: true + schema: + type: string - in: query - name: filter + name: languageCode + schema: + type: string + get: + description: Returns the list of all flows in the specified agent. + operationId: dialogflow.projects.locations.agents.flows.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/dialogflow + Oauth2c: + - https://www.googleapis.com/auth/dialogflow + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3ListFlowsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: agentsId + required: true schema: type: string - in: query @@ -16205,17 +19771,114 @@ paths: type: integer format: int32 - in: query - name: pageToken + name: pageToken + schema: + type: string + - in: query + name: languageCode + schema: + type: string + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}: + parameters: *ref_1 + delete: + description: Deletes a specified flow. + operationId: dialogflow.projects.locations.agents.flows.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/dialogflow + Oauth2c: + - https://www.googleapis.com/auth/dialogflow + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: agentsId + required: true + schema: + type: string + - in: path + name: flowsId + required: true + schema: + type: string + - in: query + name: force + schema: + type: boolean + get: + description: Retrieves the specified flow. + operationId: dialogflow.projects.locations.agents.flows.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/dialogflow + Oauth2c: + - https://www.googleapis.com/auth/dialogflow + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Flow' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: agentsId + required: true + schema: + type: string + - in: path + name: flowsId + required: true + schema: + type: string + - in: query + name: languageCode schema: type: string - /v3/projects/{projectsId}/operations/{operationsId}: - parameters: *ref_1 - get: + patch: description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: dialogflow.projects.operations.get + Updates the specified flow. Note: You should always train a flow prior + to sending it queries. See the [training + documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). + operationId: dialogflow.projects.locations.agents.flows.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Flow' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16231,7 +19894,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Flow' parameters: - in: path name: projectsId @@ -16239,24 +19902,50 @@ paths: schema: type: string - in: path - name: operationsId + name: locationsId required: true schema: type: string - /v3/projects/{projectsId}/operations/{operationsId}:cancel: + - in: path + name: agentsId + required: true + schema: + type: string + - in: path + name: flowsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: languageCode + schema: + type: string + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}:train: parameters: *ref_1 post: description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: dialogflow.projects.operations.cancel + Trains the specified flow. Note that only the flow in 'draft' + environment is trained. This method is a [long-running + operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). + The returned `Operation` type has the following method-specific fields: + - `metadata`: An empty [Struct + message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) + - `response`: An [Empty + message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty) + Note: You should always train a flow prior to sending it queries. See + the [training + documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). + operationId: dialogflow.projects.locations.agents.flows.train + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3TrainFlowRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16272,7 +19961,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -16280,15 +19969,34 @@ paths: schema: type: string - in: path - name: operationsId + name: locationsId required: true schema: type: string - /v3/projects/{projectsId}/locations: + - in: path + name: agentsId + required: true + schema: + type: string + - in: path + name: flowsId + required: true + schema: + type: string + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}:validate: parameters: *ref_1 - get: - description: Lists information about the supported locations for this service. - operationId: dialogflow.projects.locations.list + post: + description: >- + Validates the specified flow and creates or updates validation results. + Please call this API after the training is completed to get the complete + validation results. + operationId: dialogflow.projects.locations.agents.flows.validate + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3ValidateFlowRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16304,31 +20012,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudLocationListLocationsResponse' + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3FlowValidationResult parameters: - in: path name: projectsId required: true schema: type: string - - in: query - name: filter + - in: path + name: locationsId + required: true schema: type: string - - in: query - name: pageSize + - in: path + name: agentsId + required: true schema: - type: integer - format: int32 - - in: query - name: pageToken + type: string + - in: path + name: flowsId + required: true schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}: + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/validationResult: parameters: *ref_1 get: - description: Gets information about a location. - operationId: dialogflow.projects.locations.get + description: >- + Gets the latest flow validation result. Flow validation is performed + when ValidateFlow is called. + operationId: dialogflow.projects.locations.agents.flows.getValidationResult security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16344,7 +20057,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudLocationLocation' + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3FlowValidationResult parameters: - in: path name: projectsId @@ -16356,13 +20070,39 @@ paths: required: true schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/operations: + - in: path + name: agentsId + required: true + schema: + type: string + - in: path + name: flowsId + required: true + schema: + type: string + - in: query + name: languageCode + schema: + type: string + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows:import: parameters: *ref_1 - get: + post: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: dialogflow.projects.locations.operations.list + Imports the specified flow to the specified agent from a binary file. + This method is a [long-running + operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). + The returned `Operation` type has the following method-specific fields: + - `metadata`: An empty [Struct + message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) + - `response`: ImportFlowResponse Note: You should always train a flow + prior to sending it queries. See the [training + documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). + operationId: dialogflow.projects.locations.agents.flows.import + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3ImportFlowRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16378,7 +20118,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -16390,27 +20130,29 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: agentsId + required: true schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}:export: parameters: *ref_1 - get: + post: description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: dialogflow.projects.locations.operations.get + Exports the specified flow to a binary file. This method is a + [long-running + operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). + The returned `Operation` type has the following method-specific fields: + - `metadata`: An empty [Struct + message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) + - `response`: ExportFlowResponse Note that resources (e.g. intents, + entities, webhooks) that the flow references will also be exported. + operationId: dialogflow.projects.locations.agents.flows.export + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3ExportFlowRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16439,24 +20181,20 @@ paths: schema: type: string - in: path - name: operationsId + name: agentsId required: true schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: + - in: path + name: flowsId + required: true + schema: + type: string + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/pages: parameters: *ref_1 - post: - description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: dialogflow.projects.locations.operations.cancel + get: + description: Returns the list of all pages in the specified flow. + operationId: dialogflow.projects.locations.agents.flows.pages.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16472,7 +20210,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3ListPagesResponse parameters: - in: path name: projectsId @@ -16485,20 +20224,39 @@ paths: schema: type: string - in: path - name: operationsId + name: agentsId required: true schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/securitySettings: - parameters: *ref_1 + - in: path + name: flowsId + required: true + schema: + type: string + - in: query + name: languageCode + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string post: - description: Create security settings in the specified location. - operationId: dialogflow.projects.locations.securitySettings.create + description: >- + Creates a page in the specified flow. Note: You should always train a + flow prior to sending it queries. See the [training + documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). + operationId: dialogflow.projects.locations.agents.flows.pages.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3SecuritySettings' + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Page' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16514,7 +20272,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3SecuritySettings' + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Page' parameters: - in: path name: projectsId @@ -16526,53 +20284,25 @@ paths: required: true schema: type: string - get: - description: Returns the list of all security settings in the specified location. - operationId: dialogflow.projects.locations.securitySettings.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/dialogflow - Oauth2c: - - https://www.googleapis.com/auth/dialogflow - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3ListSecuritySettingsResponse - parameters: - in: path - name: projectsId + name: agentsId required: true schema: type: string - in: path - name: locationsId + name: flowsId required: true schema: type: string - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + name: languageCode schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/securitySettings/{securitySettingsId}: + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/pages/{pagesId}: parameters: *ref_1 get: - description: >- - Retrieves the specified SecuritySettings. The returned settings may be - stale by up to 1 minute. - operationId: dialogflow.projects.locations.securitySettings.get + description: Retrieves the specified page. + operationId: dialogflow.projects.locations.agents.flows.pages.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16588,7 +20318,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3SecuritySettings' + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Page' parameters: - in: path name: projectsId @@ -16601,18 +20331,35 @@ paths: schema: type: string - in: path - name: securitySettingsId + name: agentsId + required: true + schema: + type: string + - in: path + name: flowsId + required: true + schema: + type: string + - in: path + name: pagesId required: true schema: type: string + - in: query + name: languageCode + schema: + type: string patch: - description: Updates the specified SecuritySettings. - operationId: dialogflow.projects.locations.securitySettings.patch + description: >- + Updates the specified page. Note: You should always train a flow prior + to sending it queries. See the [training + documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). + operationId: dialogflow.projects.locations.agents.flows.pages.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3SecuritySettings' + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Page' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16628,7 +20375,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3SecuritySettings' + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Page' parameters: - in: path name: projectsId @@ -16641,18 +20388,35 @@ paths: schema: type: string - in: path - name: securitySettingsId + name: agentsId + required: true + schema: + type: string + - in: path + name: flowsId + required: true + schema: + type: string + - in: path + name: pagesId required: true schema: type: string + - in: query + name: languageCode + schema: + type: string - in: query name: updateMask schema: type: string format: google-fieldmask delete: - description: Deletes the specified SecuritySettings. - operationId: dialogflow.projects.locations.securitySettings.delete + description: >- + Deletes the specified page. Note: You should always train a flow prior + to sending it queries. See the [training + documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). + operationId: dialogflow.projects.locations.agents.flows.pages.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16681,15 +20445,29 @@ paths: schema: type: string - in: path - name: securitySettingsId + name: agentsId required: true schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents: + - in: path + name: flowsId + required: true + schema: + type: string + - in: path + name: pagesId + required: true + schema: + type: string + - in: query + name: force + schema: + type: boolean + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/transitionRouteGroups: parameters: *ref_1 get: - description: Returns the list of all agents in the specified location. - operationId: dialogflow.projects.locations.agents.list + description: Returns the list of all transition route groups in the specified flow. + operationId: dialogflow.projects.locations.agents.flows.transitionRouteGroups.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16706,7 +20484,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3ListAgentsResponse + #/components/schemas/GoogleCloudDialogflowCxV3ListTransitionRouteGroupsResponse parameters: - in: path name: projectsId @@ -16718,6 +20496,16 @@ paths: required: true schema: type: string + - in: path + name: agentsId + required: true + schema: + type: string + - in: path + name: flowsId + required: true + schema: + type: string - in: query name: pageSize schema: @@ -16727,17 +20515,22 @@ paths: name: pageToken schema: type: string + - in: query + name: languageCode + schema: + type: string post: description: >- - Creates an agent in the specified location. Note: You should always - train flows prior to sending them queries. See the [training + Creates an TransitionRouteGroup in the specified flow. Note: You should + always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). - operationId: dialogflow.projects.locations.agents.create + operationId: dialogflow.projects.locations.agents.flows.transitionRouteGroups.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Agent' + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3TransitionRouteGroup security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16753,7 +20546,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Agent' + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3TransitionRouteGroup parameters: - in: path name: projectsId @@ -16765,11 +20559,25 @@ paths: required: true schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}: + - in: path + name: agentsId + required: true + schema: + type: string + - in: path + name: flowsId + required: true + schema: + type: string + - in: query + name: languageCode + schema: + type: string + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/transitionRouteGroups/{transitionRouteGroupsId}: parameters: *ref_1 get: - description: Retrieves the specified agent. - operationId: dialogflow.projects.locations.agents.get + description: Retrieves the specified TransitionRouteGroup. + operationId: dialogflow.projects.locations.agents.flows.transitionRouteGroups.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16785,7 +20593,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Agent' + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3TransitionRouteGroup parameters: - in: path name: projectsId @@ -16802,17 +20611,32 @@ paths: required: true schema: type: string + - in: path + name: flowsId + required: true + schema: + type: string + - in: path + name: transitionRouteGroupsId + required: true + schema: + type: string + - in: query + name: languageCode + schema: + type: string patch: description: >- - Updates the specified agent. Note: You should always train flows prior - to sending them queries. See the [training + Updates the specified TransitionRouteGroup. Note: You should always + train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). - operationId: dialogflow.projects.locations.agents.patch + operationId: dialogflow.projects.locations.agents.flows.transitionRouteGroups.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Agent' + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3TransitionRouteGroup security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16828,7 +20652,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Agent' + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3TransitionRouteGroup parameters: - in: path name: projectsId @@ -16845,14 +20670,31 @@ paths: required: true schema: type: string + - in: path + name: flowsId + required: true + schema: + type: string + - in: path + name: transitionRouteGroupsId + required: true + schema: + type: string - in: query name: updateMask schema: type: string format: google-fieldmask + - in: query + name: languageCode + schema: + type: string delete: - description: Deletes the specified agent. - operationId: dialogflow.projects.locations.agents.delete + description: >- + Deletes the specified TransitionRouteGroup. Note: You should always + train a flow prior to sending it queries. See the [training + documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). + operationId: dialogflow.projects.locations.agents.flows.transitionRouteGroups.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16885,23 +20727,25 @@ paths: required: true schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}:export: + - in: path + name: flowsId + required: true + schema: + type: string + - in: path + name: transitionRouteGroupsId + required: true + schema: + type: string + - in: query + name: force + schema: + type: boolean + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/versions: parameters: *ref_1 - post: - description: >- - Exports the specified agent to a binary file. This method is a - [long-running - operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). - The returned `Operation` type has the following method-specific fields: - - `metadata`: An empty [Struct - message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - - `response`: ExportAgentResponse - operationId: dialogflow.projects.locations.agents.export - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3ExportAgentRequest' + get: + description: Returns the list of all versions in the specified Flow. + operationId: dialogflow.projects.locations.agents.flows.versions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16917,7 +20761,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3ListVersionsResponse parameters: - in: path name: projectsId @@ -16934,30 +20779,32 @@ paths: required: true schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}:restore: - parameters: *ref_1 + - in: path + name: flowsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string post: description: >- - Restores the specified agent from a binary file. Replaces the current - agent with a new one. Note that all existing resources in agent (e.g. - intents, entity types, flows) will be removed. This method is a - [long-running + Creates a Version in the specified Flow. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - - `metadata`: An empty [Struct - message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - - `response`: An [Empty - message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty) - Note: You should always train flows prior to sending them queries. See - the [training - documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). - operationId: dialogflow.projects.locations.agents.restore + - `metadata`: CreateVersionOperationMetadata - `response`: Version + operationId: dialogflow.projects.locations.agents.flows.versions.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3RestoreAgentRequest + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Version' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16990,20 +20837,16 @@ paths: required: true schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}:validate: + - in: path + name: flowsId + required: true + schema: + type: string + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/versions/{versionsId}: parameters: *ref_1 - post: - description: >- - Validates the specified agent and creates or updates validation results. - The agent in draft version is validated. Please call this API after the - training is completed to get the complete validation results. - operationId: dialogflow.projects.locations.agents.validate - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3ValidateAgentRequest + get: + description: Retrieves the specified Version. + operationId: dialogflow.projects.locations.agents.flows.versions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17019,8 +20862,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3AgentValidationResult + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Version' parameters: - in: path name: projectsId @@ -17037,13 +20879,24 @@ paths: required: true schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/validationResult: - parameters: *ref_1 - get: - description: >- - Gets the latest agent validation result. Agent validation is performed - when ValidateAgent is called. - operationId: dialogflow.projects.locations.agents.getValidationResult + - in: path + name: flowsId + required: true + schema: + type: string + - in: path + name: versionsId + required: true + schema: + type: string + patch: + description: Updates the specified Version. + operationId: dialogflow.projects.locations.agents.flows.versions.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Version' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17059,8 +20912,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3AgentValidationResult + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Version' parameters: - in: path name: projectsId @@ -17077,15 +20929,24 @@ paths: required: true schema: type: string + - in: path + name: flowsId + required: true + schema: + type: string + - in: path + name: versionsId + required: true + schema: + type: string - in: query - name: languageCode + name: updateMask schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/generativeSettings: - parameters: *ref_1 - get: - description: Gets the generative settings for the agent. - operationId: dialogflow.projects.locations.agents.getGenerativeSettings + format: google-fieldmask + delete: + description: Deletes the specified Version. + operationId: dialogflow.projects.locations.agents.flows.versions.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17101,8 +20962,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3GenerativeSettings + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -17119,18 +20979,34 @@ paths: required: true schema: type: string - - in: query - name: languageCode + - in: path + name: flowsId + required: true schema: type: string - patch: - description: Updates the generative settings for the agent. - operationId: dialogflow.projects.locations.agents.updateGenerativeSettings + - in: path + name: versionsId + required: true + schema: + type: string + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/versions/{versionsId}:load: + parameters: *ref_1 + post: + description: >- + Loads resources in the specified version to the draft flow. This method + is a [long-running + operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). + The returned `Operation` type has the following method-specific fields: + - `metadata`: An empty [Struct + message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) + - `response`: An [Empty + message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty) + operationId: dialogflow.projects.locations.agents.flows.versions.load requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3GenerativeSettings' + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3LoadVersionRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17146,8 +21022,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3GenerativeSettings + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -17164,24 +21039,27 @@ paths: required: true schema: type: string - - in: query - name: updateMask + - in: path + name: flowsId + required: true schema: type: string - format: google-fieldmask - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows: + - in: path + name: versionsId + required: true + schema: + type: string + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/versions/{versionsId}:compareVersions: parameters: *ref_1 post: - description: >- - Creates a flow in the specified agent. Note: You should always train a - flow prior to sending it queries. See the [training - documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). - operationId: dialogflow.projects.locations.agents.flows.create + description: Compares the specified base version with target version. + operationId: dialogflow.projects.locations.agents.flows.versions.compareVersions requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Flow' + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3CompareVersionsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17197,7 +21075,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Flow' + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3CompareVersionsResponse parameters: - in: path name: projectsId @@ -17214,13 +21093,21 @@ paths: required: true schema: type: string - - in: query - name: languageCode + - in: path + name: flowsId + required: true + schema: + type: string + - in: path + name: versionsId + required: true schema: type: string + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/changelogs: + parameters: *ref_1 get: - description: Returns the list of all flows in the specified agent. - operationId: dialogflow.projects.locations.agents.flows.list + description: Returns the list of Changelogs. + operationId: dialogflow.projects.locations.agents.changelogs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17237,7 +21124,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3ListFlowsResponse + #/components/schemas/GoogleCloudDialogflowCxV3ListChangelogsResponse parameters: - in: path name: projectsId @@ -17254,6 +21141,10 @@ paths: required: true schema: type: string + - in: query + name: filter + schema: + type: string - in: query name: pageSize schema: @@ -17263,15 +21154,11 @@ paths: name: pageToken schema: type: string - - in: query - name: languageCode - schema: - type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}: + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/changelogs/{changelogsId}: parameters: *ref_1 - delete: - description: Deletes a specified flow. - operationId: dialogflow.projects.locations.agents.flows.delete + get: + description: Retrieves the specified Changelog. + operationId: dialogflow.projects.locations.agents.changelogs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17287,7 +21174,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Changelog' parameters: - in: path name: projectsId @@ -17305,17 +21192,15 @@ paths: schema: type: string - in: path - name: flowsId + name: changelogsId required: true schema: type: string - - in: query - name: force - schema: - type: boolean + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/entityTypes/{entityTypesId}: + parameters: *ref_1 get: - description: Retrieves the specified flow. - operationId: dialogflow.projects.locations.agents.flows.get + description: Retrieves the specified entity type. + operationId: dialogflow.projects.locations.agents.entityTypes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17331,7 +21216,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Flow' + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3EntityType' parameters: - in: path name: projectsId @@ -17349,7 +21234,7 @@ paths: schema: type: string - in: path - name: flowsId + name: entityTypesId required: true schema: type: string @@ -17359,15 +21244,15 @@ paths: type: string patch: description: >- - Updates the specified flow. Note: You should always train a flow prior - to sending it queries. See the [training + Updates the specified entity type. Note: You should always train a flow + prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). - operationId: dialogflow.projects.locations.agents.flows.patch + operationId: dialogflow.projects.locations.agents.entityTypes.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Flow' + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3EntityType' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17383,7 +21268,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Flow' + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3EntityType' parameters: - in: path name: projectsId @@ -17401,40 +21286,25 @@ paths: schema: type: string - in: path - name: flowsId + name: entityTypesId required: true schema: type: string - in: query - name: updateMask + name: languageCode schema: type: string - format: google-fieldmask - in: query - name: languageCode + name: updateMask schema: - type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}:train: - parameters: *ref_1 - post: - description: >- - Trains the specified flow. Note that only the flow in 'draft' - environment is trained. This method is a [long-running - operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). - The returned `Operation` type has the following method-specific fields: - - `metadata`: An empty [Struct - message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - - `response`: An [Empty - message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty) - Note: You should always train a flow prior to sending it queries. See - the [training + type: string + format: google-fieldmask + delete: + description: >- + Deletes the specified entity type. Note: You should always train a flow + prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). - operationId: dialogflow.projects.locations.agents.flows.train - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3TrainFlowRequest' + operationId: dialogflow.projects.locations.agents.entityTypes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17450,7 +21320,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -17468,24 +21338,27 @@ paths: schema: type: string - in: path - name: flowsId + name: entityTypesId required: true schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}:validate: + - in: query + name: force + schema: + type: boolean + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/entityTypes: parameters: *ref_1 post: description: >- - Validates the specified flow and creates or updates validation results. - Please call this API after the training is completed to get the complete - validation results. - operationId: dialogflow.projects.locations.agents.flows.validate + Creates an entity type in the specified agent. Note: You should always + train a flow prior to sending it queries. See the [training + documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). + operationId: dialogflow.projects.locations.agents.entityTypes.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3ValidateFlowRequest + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3EntityType' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17501,8 +21374,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3FlowValidationResult + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3EntityType' parameters: - in: path name: projectsId @@ -17519,18 +21391,13 @@ paths: required: true schema: type: string - - in: path - name: flowsId - required: true + - in: query + name: languageCode schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/validationResult: - parameters: *ref_1 get: - description: >- - Gets the latest flow validation result. Flow validation is performed - when ValidateFlow is called. - operationId: dialogflow.projects.locations.agents.flows.getValidationResult + description: Returns the list of all entity types in the specified agent. + operationId: dialogflow.projects.locations.agents.entityTypes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17547,7 +21414,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3FlowValidationResult + #/components/schemas/GoogleCloudDialogflowCxV3ListEntityTypesResponse parameters: - in: path name: projectsId @@ -17564,34 +21431,30 @@ paths: required: true schema: type: string - - in: path - name: flowsId - required: true + - in: query + name: languageCode schema: type: string - in: query - name: languageCode + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows:import: + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/entityTypes:export: parameters: *ref_1 post: - description: >- - Imports the specified flow to the specified agent from a binary file. - This method is a [long-running - operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). - The returned `Operation` type has the following method-specific fields: - - `metadata`: An empty [Struct - message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - - `response`: ImportFlowResponse Note: You should always train a flow - prior to sending it queries. See the [training - documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). - operationId: dialogflow.projects.locations.agents.flows.import + description: Exports the selected entity types. + operationId: dialogflow.projects.locations.agents.entityTypes.export requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3ImportFlowRequest' + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3ExportEntityTypesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17624,24 +21487,17 @@ paths: required: true schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}:export: + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/entityTypes:import: parameters: *ref_1 post: - description: >- - Exports the specified flow to a binary file. This method is a - [long-running - operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). - The returned `Operation` type has the following method-specific fields: - - `metadata`: An empty [Struct - message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - - `response`: ExportFlowResponse Note that resources (e.g. intents, - entities, webhooks) that the flow references will also be exported. - operationId: dialogflow.projects.locations.agents.flows.export + description: Imports the specified entitytypes into the agent. + operationId: dialogflow.projects.locations.agents.entityTypes.import requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3ExportFlowRequest' + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3ImportEntityTypesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17674,16 +21530,11 @@ paths: required: true schema: type: string - - in: path - name: flowsId - required: true - schema: - type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/pages: + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/intents: parameters: *ref_1 get: - description: Returns the list of all pages in the specified flow. - operationId: dialogflow.projects.locations.agents.flows.pages.list + description: Returns the list of all intents in the specified agent. + operationId: dialogflow.projects.locations.agents.intents.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17700,7 +21551,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3ListPagesResponse + #/components/schemas/GoogleCloudDialogflowCxV3ListIntentsResponse parameters: - in: path name: projectsId @@ -17717,13 +21568,12 @@ paths: required: true schema: type: string - - in: path - name: flowsId - required: true + - in: query + name: languageCode schema: type: string - in: query - name: languageCode + name: intentView schema: type: string - in: query @@ -17737,15 +21587,15 @@ paths: type: string post: description: >- - Creates a page in the specified flow. Note: You should always train a - flow prior to sending it queries. See the [training + Creates an intent in the specified agent. Note: You should always train + a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). - operationId: dialogflow.projects.locations.agents.flows.pages.create + operationId: dialogflow.projects.locations.agents.intents.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Page' + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Intent' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17761,7 +21611,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Page' + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Intent' parameters: - in: path name: projectsId @@ -17778,20 +21628,15 @@ paths: required: true schema: type: string - - in: path - name: flowsId - required: true - schema: - type: string - in: query name: languageCode schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/pages/{pagesId}: + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/intents/{intentsId}: parameters: *ref_1 get: - description: Retrieves the specified page. - operationId: dialogflow.projects.locations.agents.flows.pages.get + description: Retrieves the specified intent. + operationId: dialogflow.projects.locations.agents.intents.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17807,7 +21652,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Page' + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Intent' parameters: - in: path name: projectsId @@ -17825,12 +21670,7 @@ paths: schema: type: string - in: path - name: flowsId - required: true - schema: - type: string - - in: path - name: pagesId + name: intentsId required: true schema: type: string @@ -17840,15 +21680,15 @@ paths: type: string patch: description: >- - Updates the specified page. Note: You should always train a flow prior + Updates the specified intent. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). - operationId: dialogflow.projects.locations.agents.flows.pages.patch + operationId: dialogflow.projects.locations.agents.intents.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Page' + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Intent' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17864,7 +21704,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Page' + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Intent' parameters: - in: path name: projectsId @@ -17882,12 +21722,7 @@ paths: schema: type: string - in: path - name: flowsId - required: true - schema: - type: string - - in: path - name: pagesId + name: intentsId required: true schema: type: string @@ -17902,10 +21737,10 @@ paths: format: google-fieldmask delete: description: >- - Deletes the specified page. Note: You should always train a flow prior + Deletes the specified intent. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). - operationId: dialogflow.projects.locations.agents.flows.pages.delete + operationId: dialogflow.projects.locations.agents.intents.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17939,24 +21774,26 @@ paths: schema: type: string - in: path - name: flowsId - required: true - schema: - type: string - - in: path - name: pagesId + name: intentsId required: true schema: type: string - - in: query - name: force - schema: - type: boolean - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/transitionRouteGroups: + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/intents:import: parameters: *ref_1 - get: - description: Returns the list of all transition route groups in the specified flow. - operationId: dialogflow.projects.locations.agents.flows.transitionRouteGroups.list + post: + description: >- + Imports the specified intents into the agent. This method is a + [long-running + operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). + The returned `Operation` type has the following method-specific fields: + - `metadata`: ImportIntentsMetadata - `response`: ImportIntentsResponse + operationId: dialogflow.projects.locations.agents.intents.import + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3ImportIntentsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17972,8 +21809,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3ListTransitionRouteGroupsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -17990,36 +21826,21 @@ paths: required: true schema: type: string - - in: path - name: flowsId - required: true - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: languageCode - schema: - type: string + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/intents:export: + parameters: *ref_1 post: description: >- - Creates an TransitionRouteGroup in the specified flow. Note: You should - always train a flow prior to sending it queries. See the [training - documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). - operationId: dialogflow.projects.locations.agents.flows.transitionRouteGroups.create + Exports the selected intents. This method is a [long-running + operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). + The returned `Operation` type has the following method-specific fields: + - `metadata`: ExportIntentsMetadata - `response`: ExportIntentsResponse + operationId: dialogflow.projects.locations.agents.intents.export requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3TransitionRouteGroup + #/components/schemas/GoogleCloudDialogflowCxV3ExportIntentsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18035,8 +21856,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3TransitionRouteGroup + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -18053,20 +21873,23 @@ paths: required: true schema: type: string - - in: path - name: flowsId - required: true - schema: - type: string - - in: query - name: languageCode - schema: - type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/transitionRouteGroups/{transitionRouteGroupsId}: + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}:detectIntent: parameters: *ref_1 - get: - description: Retrieves the specified TransitionRouteGroup. - operationId: dialogflow.projects.locations.agents.flows.transitionRouteGroups.get + post: + description: >- + Processes a natural language query and returns structured, actionable + data as a result. This method is not idempotent, because it may cause + session entity types to be updated, which in turn might affect results + of future queries. Note: Always use agent versions for production + traffic. See [Versions and + environments](https://cloud.google.com/dialogflow/cx/docs/concept/version). + operationId: dialogflow.projects.locations.agents.sessions.detectIntent + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3DetectIntentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18083,7 +21906,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3TransitionRouteGroup + #/components/schemas/GoogleCloudDialogflowCxV3DetectIntentResponse parameters: - in: path name: projectsId @@ -18101,31 +21924,27 @@ paths: schema: type: string - in: path - name: flowsId - required: true - schema: - type: string - - in: path - name: transitionRouteGroupsId + name: sessionsId required: true schema: type: string - - in: query - name: languageCode - schema: - type: string - patch: + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}:serverStreamingDetectIntent: + parameters: *ref_1 + post: description: >- - Updates the specified TransitionRouteGroup. Note: You should always - train a flow prior to sending it queries. See the [training - documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). - operationId: dialogflow.projects.locations.agents.flows.transitionRouteGroups.patch + Processes a natural language query and returns structured, actionable + data as a result through server-side streaming. Server-side streaming + allows Dialogflow to send [partial + responses](https://cloud.google.com/dialogflow/cx/docs/concept/fulfillment#partial-response) + earlier in a single request. + operationId: >- + dialogflow.projects.locations.agents.sessions.serverStreamingDetectIntent requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3TransitionRouteGroup + #/components/schemas/GoogleCloudDialogflowCxV3DetectIntentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18142,7 +21961,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3TransitionRouteGroup + #/components/schemas/GoogleCloudDialogflowCxV3DetectIntentResponse parameters: - in: path name: projectsId @@ -18160,30 +21979,22 @@ paths: schema: type: string - in: path - name: flowsId - required: true - schema: - type: string - - in: path - name: transitionRouteGroupsId + name: sessionsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - - in: query - name: languageCode - schema: - type: string - delete: + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}:matchIntent: + parameters: *ref_1 + post: description: >- - Deletes the specified TransitionRouteGroup. Note: You should always - train a flow prior to sending it queries. See the [training - documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). - operationId: dialogflow.projects.locations.agents.flows.transitionRouteGroups.delete + Returns preliminary intent match results, doesn't change the session + status. + operationId: dialogflow.projects.locations.agents.sessions.matchIntent + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3MatchIntentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18199,7 +22010,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3MatchIntentResponse parameters: - in: path name: projectsId @@ -18217,24 +22029,24 @@ paths: schema: type: string - in: path - name: flowsId - required: true - schema: - type: string - - in: path - name: transitionRouteGroupsId + name: sessionsId required: true schema: type: string - - in: query - name: force - schema: - type: boolean - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/versions: + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}:fulfillIntent: parameters: *ref_1 - get: - description: Returns the list of all versions in the specified Flow. - operationId: dialogflow.projects.locations.agents.flows.versions.list + post: + description: >- + Fulfills a matched intent returned by MatchIntent. Must be called after + MatchIntent, with input from MatchIntentResponse. Otherwise, the + behavior is undefined. + operationId: dialogflow.projects.locations.agents.sessions.fulfillIntent + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3FulfillIntentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18251,7 +22063,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3ListVersionsResponse + #/components/schemas/GoogleCloudDialogflowCxV3FulfillIntentResponse parameters: - in: path name: projectsId @@ -18269,31 +22081,23 @@ paths: schema: type: string - in: path - name: flowsId + name: sessionsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}:submitAnswerFeedback: + parameters: *ref_1 post: description: >- - Creates a Version in the specified Flow. This method is a [long-running - operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). - The returned `Operation` type has the following method-specific fields: - - `metadata`: CreateVersionOperationMetadata - `response`: Version - operationId: dialogflow.projects.locations.agents.flows.versions.create + Updates the feedback received from the user for a single turn of the bot + response. + operationId: dialogflow.projects.locations.agents.sessions.submitAnswerFeedback requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Version' + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3SubmitAnswerFeedbackRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18309,7 +22113,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3AnswerFeedback' parameters: - in: path name: projectsId @@ -18327,15 +22131,15 @@ paths: schema: type: string - in: path - name: flowsId + name: sessionsId required: true schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/versions/{versionsId}: + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}/entityTypes: parameters: *ref_1 get: - description: Retrieves the specified Version. - operationId: dialogflow.projects.locations.agents.flows.versions.get + description: Returns the list of all session entity types in the specified session. + operationId: dialogflow.projects.locations.agents.sessions.entityTypes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18351,7 +22155,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Version' + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3ListSessionEntityTypesResponse parameters: - in: path name: projectsId @@ -18369,23 +22174,27 @@ paths: schema: type: string - in: path - name: flowsId + name: sessionsId required: true schema: type: string - - in: path - name: versionsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - patch: - description: Updates the specified Version. - operationId: dialogflow.projects.locations.agents.flows.versions.patch + post: + description: Creates a session entity type. + operationId: dialogflow.projects.locations.agents.sessions.entityTypes.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Version' + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3SessionEntityType' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18401,7 +22210,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Version' + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3SessionEntityType parameters: - in: path name: projectsId @@ -18419,23 +22229,15 @@ paths: schema: type: string - in: path - name: flowsId - required: true - schema: - type: string - - in: path - name: versionsId + name: sessionsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: - description: Deletes the specified Version. - operationId: dialogflow.projects.locations.agents.flows.versions.delete + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}/entityTypes/{entityTypesId}: + parameters: *ref_1 + get: + description: Retrieves the specified session entity type. + operationId: dialogflow.projects.locations.agents.sessions.entityTypes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18451,7 +22253,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3SessionEntityType parameters: - in: path name: projectsId @@ -18469,33 +22272,23 @@ paths: schema: type: string - in: path - name: flowsId + name: sessionsId required: true schema: type: string - in: path - name: versionsId + name: entityTypesId required: true schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/versions/{versionsId}:load: - parameters: *ref_1 - post: - description: >- - Loads resources in the specified version to the draft flow. This method - is a [long-running - operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). - The returned `Operation` type has the following method-specific fields: - - `metadata`: An empty [Struct - message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - - `response`: An [Empty - message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty) - operationId: dialogflow.projects.locations.agents.flows.versions.load + patch: + description: Updates the specified session entity type. + operationId: dialogflow.projects.locations.agents.sessions.entityTypes.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3LoadVersionRequest' + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3SessionEntityType' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18511,7 +22304,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3SessionEntityType parameters: - in: path name: projectsId @@ -18529,26 +22323,23 @@ paths: schema: type: string - in: path - name: flowsId + name: sessionsId required: true schema: type: string - in: path - name: versionsId + name: entityTypesId required: true schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/versions/{versionsId}:compareVersions: - parameters: *ref_1 - post: - description: Compares the specified base version with target version. - operationId: dialogflow.projects.locations.agents.flows.versions.compareVersions - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3CompareVersionsRequest + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes the specified session entity type. + operationId: dialogflow.projects.locations.agents.sessions.entityTypes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18564,8 +22355,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3CompareVersionsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -18583,20 +22373,20 @@ paths: schema: type: string - in: path - name: flowsId + name: sessionsId required: true schema: type: string - in: path - name: versionsId + name: entityTypesId required: true schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/changelogs: + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/transitionRouteGroups: parameters: *ref_1 get: - description: Returns the list of Changelogs. - operationId: dialogflow.projects.locations.agents.changelogs.list + description: Returns the list of all transition route groups in the specified flow. + operationId: dialogflow.projects.locations.agents.transitionRouteGroups.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18613,7 +22403,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3ListChangelogsResponse + #/components/schemas/GoogleCloudDialogflowCxV3ListTransitionRouteGroupsResponse parameters: - in: path name: projectsId @@ -18627,11 +22417,7 @@ paths: type: string - in: path name: agentsId - required: true - schema: - type: string - - in: query - name: filter + required: true schema: type: string - in: query @@ -18643,11 +22429,22 @@ paths: name: pageToken schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/changelogs/{changelogsId}: - parameters: *ref_1 - get: - description: Retrieves the specified Changelog. - operationId: dialogflow.projects.locations.agents.changelogs.get + - in: query + name: languageCode + schema: + type: string + post: + description: >- + Creates an TransitionRouteGroup in the specified flow. Note: You should + always train a flow prior to sending it queries. See the [training + documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). + operationId: dialogflow.projects.locations.agents.transitionRouteGroups.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3TransitionRouteGroup security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18663,7 +22460,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Changelog' + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3TransitionRouteGroup parameters: - in: path name: projectsId @@ -18680,16 +22478,15 @@ paths: required: true schema: type: string - - in: path - name: changelogsId - required: true + - in: query + name: languageCode schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/entityTypes/{entityTypesId}: + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/transitionRouteGroups/{transitionRouteGroupsId}: parameters: *ref_1 get: - description: Retrieves the specified entity type. - operationId: dialogflow.projects.locations.agents.entityTypes.get + description: Retrieves the specified TransitionRouteGroup. + operationId: dialogflow.projects.locations.agents.transitionRouteGroups.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18705,7 +22502,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3EntityType' + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3TransitionRouteGroup parameters: - in: path name: projectsId @@ -18723,7 +22521,7 @@ paths: schema: type: string - in: path - name: entityTypesId + name: transitionRouteGroupsId required: true schema: type: string @@ -18733,15 +22531,16 @@ paths: type: string patch: description: >- - Updates the specified entity type. Note: You should always train a flow - prior to sending it queries. See the [training + Updates the specified TransitionRouteGroup. Note: You should always + train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). - operationId: dialogflow.projects.locations.agents.entityTypes.patch + operationId: dialogflow.projects.locations.agents.transitionRouteGroups.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3EntityType' + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3TransitionRouteGroup security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18757,7 +22556,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3EntityType' + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3TransitionRouteGroup parameters: - in: path name: projectsId @@ -18775,25 +22575,25 @@ paths: schema: type: string - in: path - name: entityTypesId + name: transitionRouteGroupsId required: true schema: type: string - in: query - name: languageCode + name: updateMask schema: type: string + format: google-fieldmask - in: query - name: updateMask + name: languageCode schema: type: string - format: google-fieldmask delete: description: >- - Deletes the specified entity type. Note: You should always train a flow - prior to sending it queries. See the [training + Deletes the specified TransitionRouteGroup. Note: You should always + train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). - operationId: dialogflow.projects.locations.agents.entityTypes.delete + operationId: dialogflow.projects.locations.agents.transitionRouteGroups.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18827,7 +22627,7 @@ paths: schema: type: string - in: path - name: entityTypesId + name: transitionRouteGroupsId required: true schema: type: string @@ -18835,19 +22635,11 @@ paths: name: force schema: type: boolean - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/entityTypes: + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases: parameters: *ref_1 - post: - description: >- - Creates an entity type in the specified agent. Note: You should always - train a flow prior to sending it queries. See the [training - documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). - operationId: dialogflow.projects.locations.agents.entityTypes.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3EntityType' + get: + description: Fetches a list of test cases for a given agent. + operationId: dialogflow.projects.locations.agents.testCases.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18863,7 +22655,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3EntityType' + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3ListTestCasesResponse parameters: - in: path name: projectsId @@ -18881,12 +22674,26 @@ paths: schema: type: string - in: query - name: languageCode + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - get: - description: Returns the list of all entity types in the specified agent. - operationId: dialogflow.projects.locations.agents.entityTypes.list + - in: query + name: view + schema: + type: string + post: + description: Creates a test case for the given agent. + operationId: dialogflow.projects.locations.agents.testCases.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3TestCase' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18902,8 +22709,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3ListEntityTypesResponse + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3TestCase' parameters: - in: path name: projectsId @@ -18920,30 +22726,17 @@ paths: required: true schema: type: string - - in: query - name: languageCode - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/entityTypes:export: + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases:batchDelete: parameters: *ref_1 post: - description: Exports the selected entity types. - operationId: dialogflow.projects.locations.agents.entityTypes.export + description: Batch deletes test cases. + operationId: dialogflow.projects.locations.agents.testCases.batchDelete requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3ExportEntityTypesRequest + #/components/schemas/GoogleCloudDialogflowCxV3BatchDeleteTestCasesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18959,7 +22752,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -18976,17 +22769,11 @@ paths: required: true schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/entityTypes:import: + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases/{testCasesId}: parameters: *ref_1 - post: - description: Imports the specified entitytypes into the agent. - operationId: dialogflow.projects.locations.agents.entityTypes.import - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3ImportEntityTypesRequest + get: + description: Gets a test case. + operationId: dialogflow.projects.locations.agents.testCases.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19002,7 +22789,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3TestCase' parameters: - in: path name: projectsId @@ -19019,11 +22806,19 @@ paths: required: true schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/intents: - parameters: *ref_1 - get: - description: Returns the list of all intents in the specified agent. - operationId: dialogflow.projects.locations.agents.intents.list + - in: path + name: testCasesId + required: true + schema: + type: string + patch: + description: Updates the specified test case. + operationId: dialogflow.projects.locations.agents.testCases.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3TestCase' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19039,8 +22834,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3ListIntentsResponse + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3TestCase' parameters: - in: path name: projectsId @@ -19057,34 +22851,30 @@ paths: required: true schema: type: string - - in: query - name: languageCode - schema: - type: string - - in: query - name: intentView + - in: path + name: testCasesId + required: true schema: type: string - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + name: updateMask schema: type: string + format: google-fieldmask + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases/{testCasesId}:run: + parameters: *ref_1 post: description: >- - Creates an intent in the specified agent. Note: You should always train - a flow prior to sending it queries. See the [training - documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). - operationId: dialogflow.projects.locations.agents.intents.create + Kicks off a test case run. This method is a [long-running + operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). + The returned `Operation` type has the following method-specific fields: + - `metadata`: RunTestCaseMetadata - `response`: RunTestCaseResponse + operationId: dialogflow.projects.locations.agents.testCases.run requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Intent' + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3RunTestCaseRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19100,7 +22890,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Intent' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -19117,15 +22907,27 @@ paths: required: true schema: type: string - - in: query - name: languageCode + - in: path + name: testCasesId + required: true schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/intents/{intentsId}: + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases:batchRun: parameters: *ref_1 - get: - description: Retrieves the specified intent. - operationId: dialogflow.projects.locations.agents.intents.get + post: + description: >- + Kicks off a batch run of test cases. This method is a [long-running + operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). + The returned `Operation` type has the following method-specific fields: + - `metadata`: BatchRunTestCasesMetadata - `response`: + BatchRunTestCasesResponse + operationId: dialogflow.projects.locations.agents.testCases.batchRun + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3BatchRunTestCasesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19141,7 +22943,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Intent' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -19158,26 +22960,11 @@ paths: required: true schema: type: string - - in: path - name: intentsId - required: true - schema: - type: string - - in: query - name: languageCode - schema: - type: string - patch: - description: >- - Updates the specified intent. Note: You should always train a flow prior - to sending it queries. See the [training - documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). - operationId: dialogflow.projects.locations.agents.intents.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Intent' + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases:calculateCoverage: + parameters: *ref_1 + get: + description: Calculates the test coverage for an agent. + operationId: dialogflow.projects.locations.agents.testCases.calculateCoverage security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19193,7 +22980,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Intent' + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3CalculateCoverageResponse parameters: - in: path name: projectsId @@ -19210,26 +22998,29 @@ paths: required: true schema: type: string - - in: path - name: intentsId - required: true - schema: - type: string - in: query - name: languageCode - schema: - type: string - - in: query - name: updateMask + name: type schema: type: string - format: google-fieldmask - delete: + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases:import: + parameters: *ref_1 + post: description: >- - Deletes the specified intent. Note: You should always train a flow prior - to sending it queries. See the [training - documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). - operationId: dialogflow.projects.locations.agents.intents.delete + Imports the test cases from a Cloud Storage bucket or a local file. It + always creates new test cases and won't overwrite any existing ones. The + provided ID in the imported test case is neglected. This method is a + [long-running + operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). + The returned `Operation` type has the following method-specific fields: + - `metadata`: ImportTestCasesMetadata - `response`: + ImportTestCasesResponse + operationId: dialogflow.projects.locations.agents.testCases.import + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3ImportTestCasesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19245,7 +23036,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -19262,27 +23053,24 @@ paths: required: true schema: type: string - - in: path - name: intentsId - required: true - schema: - type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/intents:import: + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases:export: parameters: *ref_1 post: description: >- - Imports the specified intents into the agent. This method is a - [long-running + Exports the test cases under the agent to a Cloud Storage bucket or a + local file. Filter can be applied to export a subset of test cases. This + method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - - `metadata`: ImportIntentsMetadata - `response`: ImportIntentsResponse - operationId: dialogflow.projects.locations.agents.intents.import + - `metadata`: ExportTestCasesMetadata - `response`: + ExportTestCasesResponse + operationId: dialogflow.projects.locations.agents.testCases.export requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3ImportIntentsRequest + #/components/schemas/GoogleCloudDialogflowCxV3ExportTestCasesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19315,21 +23103,13 @@ paths: required: true schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/intents:export: + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases/{testCasesId}/results: parameters: *ref_1 - post: + get: description: >- - Exports the selected intents. This method is a [long-running - operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). - The returned `Operation` type has the following method-specific fields: - - `metadata`: ExportIntentsMetadata - `response`: ExportIntentsResponse - operationId: dialogflow.projects.locations.agents.intents.export - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3ExportIntentsRequest + Fetches the list of run results for the given test case. A maximum of + 100 results are kept for each test case. + operationId: dialogflow.projects.locations.agents.testCases.results.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19345,7 +23125,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3ListTestCaseResultsResponse parameters: - in: path name: projectsId @@ -19362,23 +23143,29 @@ paths: required: true schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}:detectIntent: + - in: path + name: testCasesId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases/{testCasesId}/results/{resultsId}: parameters: *ref_1 - post: - description: >- - Processes a natural language query and returns structured, actionable - data as a result. This method is not idempotent, because it may cause - session entity types to be updated, which in turn might affect results - of future queries. Note: Always use agent versions for production - traffic. See [Versions and - environments](https://cloud.google.com/dialogflow/cx/docs/concept/version). - operationId: dialogflow.projects.locations.agents.sessions.detectIntent - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3DetectIntentRequest + get: + description: Gets a test case result. + operationId: dialogflow.projects.locations.agents.testCases.results.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19394,8 +23181,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3DetectIntentResponse + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3TestCaseResult' parameters: - in: path name: projectsId @@ -19413,27 +23199,20 @@ paths: schema: type: string - in: path - name: sessionsId + name: testCasesId required: true schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}:serverStreamingDetectIntent: + - in: path + name: resultsId + required: true + schema: + type: string + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/webhooks: parameters: *ref_1 - post: - description: >- - Processes a natural language query and returns structured, actionable - data as a result through server-side streaming. Server-side streaming - allows Dialogflow to send [partial - responses](https://cloud.google.com/dialogflow/cx/docs/concept/fulfillment#partial-response) - earlier in a single request. - operationId: >- - dialogflow.projects.locations.agents.sessions.serverStreamingDetectIntent - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3DetectIntentRequest + get: + description: Returns the list of all webhooks in the specified agent. + operationId: dialogflow.projects.locations.agents.webhooks.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19450,7 +23229,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3DetectIntentResponse + #/components/schemas/GoogleCloudDialogflowCxV3ListWebhooksResponse parameters: - in: path name: projectsId @@ -19467,23 +23246,23 @@ paths: required: true schema: type: string - - in: path - name: sessionsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}:matchIntent: - parameters: *ref_1 post: - description: >- - Returns preliminary intent match results, doesn't change the session - status. - operationId: dialogflow.projects.locations.agents.sessions.matchIntent + description: Creates a webhook in the specified agent. + operationId: dialogflow.projects.locations.agents.webhooks.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3MatchIntentRequest' + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Webhook' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19499,8 +23278,44 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3MatchIntentResponse + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Webhook' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: agentsId + required: true + schema: + type: string + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/webhooks/{webhooksId}: + parameters: *ref_1 + get: + description: Retrieves the specified webhook. + operationId: dialogflow.projects.locations.agents.webhooks.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/dialogflow + Oauth2c: + - https://www.googleapis.com/auth/dialogflow + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Webhook' parameters: - in: path name: projectsId @@ -19518,24 +23333,18 @@ paths: schema: type: string - in: path - name: sessionsId + name: webhooksId required: true schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}:fulfillIntent: - parameters: *ref_1 - post: - description: >- - Fulfills a matched intent returned by MatchIntent. Must be called after - MatchIntent, with input from MatchIntentResponse. Otherwise, the - behavior is undefined. - operationId: dialogflow.projects.locations.agents.sessions.fulfillIntent + patch: + description: Updates the specified webhook. + operationId: dialogflow.projects.locations.agents.webhooks.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3FulfillIntentRequest + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Webhook' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19551,8 +23360,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3FulfillIntentResponse + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Webhook' parameters: - in: path name: projectsId @@ -19570,23 +23378,18 @@ paths: schema: type: string - in: path - name: sessionsId + name: webhooksId required: true schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}:submitAnswerFeedback: - parameters: *ref_1 - post: - description: >- - Updates the feedback received from the user for a single turn of the bot - response. - operationId: dialogflow.projects.locations.agents.sessions.submitAnswerFeedback - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3SubmitAnswerFeedbackRequest + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes the specified webhook. + operationId: dialogflow.projects.locations.agents.webhooks.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19602,7 +23405,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3AnswerFeedback' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -19620,15 +23423,19 @@ paths: schema: type: string - in: path - name: sessionsId + name: webhooksId required: true schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}/entityTypes: + - in: query + name: force + schema: + type: boolean + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments: parameters: *ref_1 get: - description: Returns the list of all session entity types in the specified session. - operationId: dialogflow.projects.locations.agents.sessions.entityTypes.list + description: Returns the list of all environments in the specified Agent. + operationId: dialogflow.projects.locations.agents.environments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19645,7 +23452,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3ListSessionEntityTypesResponse + #/components/schemas/GoogleCloudDialogflowCxV3ListEnvironmentsResponse parameters: - in: path name: projectsId @@ -19662,11 +23469,6 @@ paths: required: true schema: type: string - - in: path - name: sessionsId - required: true - schema: - type: string - in: query name: pageSize schema: @@ -19677,13 +23479,20 @@ paths: schema: type: string post: - description: Creates a session entity type. - operationId: dialogflow.projects.locations.agents.sessions.entityTypes.create + description: >- + Creates an Environment in the specified Agent. This method is a + [long-running + operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). + The returned `Operation` type has the following method-specific fields: + - `metadata`: An empty [Struct + message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) + - `response`: Environment + operationId: dialogflow.projects.locations.agents.environments.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3SessionEntityType' + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Environment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19699,8 +23508,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3SessionEntityType + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -19717,16 +23525,11 @@ paths: required: true schema: type: string - - in: path - name: sessionsId - required: true - schema: - type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}/entityTypes/{entityTypesId}: + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}: parameters: *ref_1 get: - description: Retrieves the specified session entity type. - operationId: dialogflow.projects.locations.agents.sessions.entityTypes.get + description: Retrieves the specified Environment. + operationId: dialogflow.projects.locations.agents.environments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19742,8 +23545,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3SessionEntityType + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Environment' parameters: - in: path name: projectsId @@ -19761,23 +23563,24 @@ paths: schema: type: string - in: path - name: sessionsId - required: true - schema: - type: string - - in: path - name: entityTypesId + name: environmentsId required: true schema: type: string patch: - description: Updates the specified session entity type. - operationId: dialogflow.projects.locations.agents.sessions.entityTypes.patch + description: >- + Updates the specified Environment. This method is a [long-running + operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). + The returned `Operation` type has the following method-specific fields: + - `metadata`: An empty [Struct + message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) + - `response`: Environment + operationId: dialogflow.projects.locations.agents.environments.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3SessionEntityType' + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Environment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19793,8 +23596,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3SessionEntityType + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -19812,12 +23614,7 @@ paths: schema: type: string - in: path - name: sessionsId - required: true - schema: - type: string - - in: path - name: entityTypesId + name: environmentsId required: true schema: type: string @@ -19827,8 +23624,8 @@ paths: type: string format: google-fieldmask delete: - description: Deletes the specified session entity type. - operationId: dialogflow.projects.locations.agents.sessions.entityTypes.delete + description: Deletes the specified Environment. + operationId: dialogflow.projects.locations.agents.environments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19862,20 +23659,16 @@ paths: schema: type: string - in: path - name: sessionsId - required: true - schema: - type: string - - in: path - name: entityTypesId + name: environmentsId required: true schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/transitionRouteGroups: + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}:lookupEnvironmentHistory: parameters: *ref_1 get: - description: Returns the list of all transition route groups in the specified flow. - operationId: dialogflow.projects.locations.agents.transitionRouteGroups.list + description: Looks up the history of the specified Environment. + operationId: >- + dialogflow.projects.locations.agents.environments.lookupEnvironmentHistory security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19892,7 +23685,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3ListTransitionRouteGroupsResponse + #/components/schemas/GoogleCloudDialogflowCxV3LookupEnvironmentHistoryResponse parameters: - in: path name: projectsId @@ -19909,6 +23702,11 @@ paths: required: true schema: type: string + - in: path + name: environmentsId + required: true + schema: + type: string - in: query name: pageSize schema: @@ -19918,64 +23716,23 @@ paths: name: pageToken schema: type: string - - in: query - name: languageCode - schema: - type: string + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}:runContinuousTest: + parameters: *ref_1 post: description: >- - Creates an TransitionRouteGroup in the specified flow. Note: You should - always train a flow prior to sending it queries. See the [training - documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). - operationId: dialogflow.projects.locations.agents.transitionRouteGroups.create + Kicks off a continuous test under the specified Environment. This method + is a [long-running + operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). + The returned `Operation` type has the following method-specific fields: + - `metadata`: RunContinuousTestMetadata - `response`: + RunContinuousTestResponse + operationId: dialogflow.projects.locations.agents.environments.runContinuousTest requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3TransitionRouteGroup - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/dialogflow - Oauth2c: - - https://www.googleapis.com/auth/dialogflow - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3TransitionRouteGroup - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: agentsId - required: true - schema: - type: string - - in: query - name: languageCode - schema: - type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/transitionRouteGroups/{transitionRouteGroupsId}: - parameters: *ref_1 - get: - description: Retrieves the specified TransitionRouteGroup. - operationId: dialogflow.projects.locations.agents.transitionRouteGroups.get + #/components/schemas/GoogleCloudDialogflowCxV3RunContinuousTestRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19991,8 +23748,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3TransitionRouteGroup + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -20010,26 +23766,25 @@ paths: schema: type: string - in: path - name: transitionRouteGroupsId + name: environmentsId required: true schema: type: string - - in: query - name: languageCode - schema: - type: string - patch: + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}:deployFlow: + parameters: *ref_1 + post: description: >- - Updates the specified TransitionRouteGroup. Note: You should always - train a flow prior to sending it queries. See the [training - documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). - operationId: dialogflow.projects.locations.agents.transitionRouteGroups.patch + Deploys a flow to the specified Environment. This method is a + [long-running + operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). + The returned `Operation` type has the following method-specific fields: + - `metadata`: DeployFlowMetadata - `response`: DeployFlowResponse + operationId: dialogflow.projects.locations.agents.environments.deployFlow requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3TransitionRouteGroup + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3DeployFlowRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20045,8 +23800,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3TransitionRouteGroup + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -20064,25 +23818,15 @@ paths: schema: type: string - in: path - name: transitionRouteGroupsId + name: environmentsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - - in: query - name: languageCode - schema: - type: string - delete: - description: >- - Deletes the specified TransitionRouteGroup. Note: You should always - train a flow prior to sending it queries. See the [training - documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). - operationId: dialogflow.projects.locations.agents.transitionRouteGroups.delete + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/deployments: + parameters: *ref_1 + get: + description: Returns the list of all deployments in the specified Environment. + operationId: dialogflow.projects.locations.agents.environments.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20098,7 +23842,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3ListDeploymentsResponse parameters: - in: path name: projectsId @@ -20116,19 +23861,24 @@ paths: schema: type: string - in: path - name: transitionRouteGroupsId + name: environmentsId required: true schema: type: string - in: query - name: force + name: pageSize schema: - type: boolean - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/deployments/{deploymentsId}: parameters: *ref_1 get: - description: Fetches a list of test cases for a given agent. - operationId: dialogflow.projects.locations.agents.testCases.list + description: Retrieves the specified Deployment. + operationId: dialogflow.projects.locations.agents.environments.deployments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20144,8 +23894,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3ListTestCasesResponse + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Deployment' parameters: - in: path name: projectsId @@ -20162,27 +23911,33 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: environmentsId + required: true schema: type: string - - in: query - name: view + - in: path + name: deploymentsId + required: true schema: type: string + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/sessions/{sessionsId}:detectIntent: + parameters: *ref_1 post: - description: Creates a test case for the given agent. - operationId: dialogflow.projects.locations.agents.testCases.create + description: >- + Processes a natural language query and returns structured, actionable + data as a result. This method is not idempotent, because it may cause + session entity types to be updated, which in turn might affect results + of future queries. Note: Always use agent versions for production + traffic. See [Versions and + environments](https://cloud.google.com/dialogflow/cx/docs/concept/version). + operationId: dialogflow.projects.locations.agents.environments.sessions.detectIntent requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3TestCase' + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3DetectIntentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20198,7 +23953,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3TestCase' + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3DetectIntentResponse parameters: - in: path name: projectsId @@ -20215,17 +23971,33 @@ paths: required: true schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases:batchDelete: + - in: path + name: environmentsId + required: true + schema: + type: string + - in: path + name: sessionsId + required: true + schema: + type: string + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/sessions/{sessionsId}:serverStreamingDetectIntent: parameters: *ref_1 post: - description: Batch deletes test cases. - operationId: dialogflow.projects.locations.agents.testCases.batchDelete + description: >- + Processes a natural language query and returns structured, actionable + data as a result through server-side streaming. Server-side streaming + allows Dialogflow to send [partial + responses](https://cloud.google.com/dialogflow/cx/docs/concept/fulfillment#partial-response) + earlier in a single request. + operationId: >- + dialogflow.projects.locations.agents.environments.sessions.serverStreamingDetectIntent requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3BatchDeleteTestCasesRequest + #/components/schemas/GoogleCloudDialogflowCxV3DetectIntentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20241,7 +24013,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3DetectIntentResponse parameters: - in: path name: projectsId @@ -20258,11 +24031,28 @@ paths: required: true schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases/{testCasesId}: + - in: path + name: environmentsId + required: true + schema: + type: string + - in: path + name: sessionsId + required: true + schema: + type: string + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/sessions/{sessionsId}:matchIntent: parameters: *ref_1 - get: - description: Gets a test case. - operationId: dialogflow.projects.locations.agents.testCases.get + post: + description: >- + Returns preliminary intent match results, doesn't change the session + status. + operationId: dialogflow.projects.locations.agents.environments.sessions.matchIntent + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3MatchIntentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20278,7 +24068,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3TestCase' + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3MatchIntentResponse parameters: - in: path name: projectsId @@ -20296,18 +24087,29 @@ paths: schema: type: string - in: path - name: testCasesId + name: environmentsId required: true schema: type: string - patch: - description: Updates the specified test case. - operationId: dialogflow.projects.locations.agents.testCases.patch + - in: path + name: sessionsId + required: true + schema: + type: string + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/sessions/{sessionsId}:fulfillIntent: + parameters: *ref_1 + post: + description: >- + Fulfills a matched intent returned by MatchIntent. Must be called after + MatchIntent, with input from MatchIntentResponse. Otherwise, the + behavior is undefined. + operationId: dialogflow.projects.locations.agents.environments.sessions.fulfillIntent requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3TestCase' + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3FulfillIntentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20323,7 +24125,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3TestCase' + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3FulfillIntentResponse parameters: - in: path name: projectsId @@ -20341,29 +24144,21 @@ paths: schema: type: string - in: path - name: testCasesId + name: environmentsId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: sessionsId + required: true schema: type: string - format: google-fieldmask - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases/{testCasesId}:run: + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/sessions/{sessionsId}/entityTypes: parameters: *ref_1 - post: - description: >- - Kicks off a test case run. This method is a [long-running - operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). - The returned `Operation` type has the following method-specific fields: - - `metadata`: RunTestCaseMetadata - `response`: RunTestCaseResponse - operationId: dialogflow.projects.locations.agents.testCases.run - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3RunTestCaseRequest' + get: + description: Returns the list of all session entity types in the specified session. + operationId: >- + dialogflow.projects.locations.agents.environments.sessions.entityTypes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20379,7 +24174,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3ListSessionEntityTypesResponse parameters: - in: path name: projectsId @@ -20397,26 +24193,33 @@ paths: schema: type: string - in: path - name: testCasesId + name: environmentsId required: true schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases:batchRun: - parameters: *ref_1 + - in: path + name: sessionsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string post: - description: >- - Kicks off a batch run of test cases. This method is a [long-running - operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). - The returned `Operation` type has the following method-specific fields: - - `metadata`: BatchRunTestCasesMetadata - `response`: - BatchRunTestCasesResponse - operationId: dialogflow.projects.locations.agents.testCases.batchRun + description: Creates a session entity type. + operationId: >- + dialogflow.projects.locations.agents.environments.sessions.entityTypes.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3BatchRunTestCasesRequest + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3SessionEntityType' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20432,7 +24235,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3SessionEntityType parameters: - in: path name: projectsId @@ -20449,11 +24253,22 @@ paths: required: true schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases:calculateCoverage: + - in: path + name: environmentsId + required: true + schema: + type: string + - in: path + name: sessionsId + required: true + schema: + type: string + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/sessions/{sessionsId}/entityTypes/{entityTypesId}: parameters: *ref_1 get: - description: Calculates the test coverage for an agent. - operationId: dialogflow.projects.locations.agents.testCases.calculateCoverage + description: Retrieves the specified session entity type. + operationId: >- + dialogflow.projects.locations.agents.environments.sessions.entityTypes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20470,7 +24285,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3CalculateCoverageResponse + #/components/schemas/GoogleCloudDialogflowCxV3SessionEntityType parameters: - in: path name: projectsId @@ -20487,29 +24302,30 @@ paths: required: true schema: type: string - - in: query - name: type + - in: path + name: environmentsId + required: true schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases:import: - parameters: *ref_1 - post: - description: >- - Imports the test cases from a Cloud Storage bucket or a local file. It - always creates new test cases and won't overwrite any existing ones. The - provided ID in the imported test case is neglected. This method is a - [long-running - operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). - The returned `Operation` type has the following method-specific fields: - - `metadata`: ImportTestCasesMetadata - `response`: - ImportTestCasesResponse - operationId: dialogflow.projects.locations.agents.testCases.import + - in: path + name: sessionsId + required: true + schema: + type: string + - in: path + name: entityTypesId + required: true + schema: + type: string + patch: + description: Updates the specified session entity type. + operationId: >- + dialogflow.projects.locations.agents.environments.sessions.entityTypes.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3ImportTestCasesRequest + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3SessionEntityType' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20525,7 +24341,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3SessionEntityType parameters: - in: path name: projectsId @@ -20542,63 +24359,30 @@ paths: required: true schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases:export: - parameters: *ref_1 - post: - description: >- - Exports the test cases under the agent to a Cloud Storage bucket or a - local file. Filter can be applied to export a subset of test cases. This - method is a [long-running - operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). - The returned `Operation` type has the following method-specific fields: - - `metadata`: ExportTestCasesMetadata - `response`: - ExportTestCasesResponse - operationId: dialogflow.projects.locations.agents.testCases.export - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3ExportTestCasesRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/dialogflow - Oauth2c: - - https://www.googleapis.com/auth/dialogflow - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - in: path - name: projectsId + name: environmentsId required: true schema: type: string - in: path - name: locationsId + name: sessionsId required: true schema: type: string - in: path - name: agentsId + name: entityTypesId required: true schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases/{testCasesId}/results: - parameters: *ref_1 - get: - description: >- - Fetches the list of run results for the given test case. A maximum of - 100 results are kept for each test case. - operationId: dialogflow.projects.locations.agents.testCases.results.list + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes the specified session entity type. + operationId: >- + dialogflow.projects.locations.agents.environments.sessions.entityTypes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20614,8 +24398,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3ListTestCaseResultsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -20633,28 +24416,26 @@ paths: schema: type: string - in: path - name: testCasesId + name: environmentsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: sessionsId + required: true schema: type: string - - in: query - name: filter + - in: path + name: entityTypesId + required: true schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases/{testCasesId}/results/{resultsId}: + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/continuousTestResults: parameters: *ref_1 get: - description: Gets a test case result. - operationId: dialogflow.projects.locations.agents.testCases.results.get + description: Fetches a list of continuous test results for a given environment. + operationId: >- + dialogflow.projects.locations.agents.environments.continuousTestResults.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20670,7 +24451,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3TestCaseResult' + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3ListContinuousTestResultsResponse parameters: - in: path name: projectsId @@ -20688,20 +24470,24 @@ paths: schema: type: string - in: path - name: testCasesId + name: environmentsId required: true schema: type: string - - in: path - name: resultsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/webhooks: + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/experiments: parameters: *ref_1 get: - description: Returns the list of all webhooks in the specified agent. - operationId: dialogflow.projects.locations.agents.webhooks.list + description: Returns the list of all experiments in the specified Environment. + operationId: dialogflow.projects.locations.agents.environments.experiments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20718,7 +24504,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3ListWebhooksResponse + #/components/schemas/GoogleCloudDialogflowCxV3ListExperimentsResponse parameters: - in: path name: projectsId @@ -20735,6 +24521,11 @@ paths: required: true schema: type: string + - in: path + name: environmentsId + required: true + schema: + type: string - in: query name: pageSize schema: @@ -20745,13 +24536,13 @@ paths: schema: type: string post: - description: Creates a webhook in the specified agent. - operationId: dialogflow.projects.locations.agents.webhooks.create + description: Creates an Experiment in the specified Environment. + operationId: dialogflow.projects.locations.agents.environments.experiments.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Webhook' + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Experiment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20767,7 +24558,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Webhook' + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Experiment' parameters: - in: path name: projectsId @@ -20784,11 +24575,16 @@ paths: required: true schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/webhooks/{webhooksId}: + - in: path + name: environmentsId + required: true + schema: + type: string + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/experiments/{experimentsId}: parameters: *ref_1 get: - description: Retrieves the specified webhook. - operationId: dialogflow.projects.locations.agents.webhooks.get + description: Retrieves the specified Experiment. + operationId: dialogflow.projects.locations.agents.environments.experiments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20804,7 +24600,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Webhook' + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Experiment' parameters: - in: path name: projectsId @@ -20822,18 +24618,23 @@ paths: schema: type: string - in: path - name: webhooksId + name: environmentsId + required: true + schema: + type: string + - in: path + name: experimentsId required: true schema: type: string patch: - description: Updates the specified webhook. - operationId: dialogflow.projects.locations.agents.webhooks.patch + description: Updates the specified Experiment. + operationId: dialogflow.projects.locations.agents.environments.experiments.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Webhook' + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Experiment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20849,7 +24650,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Webhook' + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Experiment' parameters: - in: path name: projectsId @@ -20867,7 +24668,12 @@ paths: schema: type: string - in: path - name: webhooksId + name: environmentsId + required: true + schema: + type: string + - in: path + name: experimentsId required: true schema: type: string @@ -20877,8 +24683,8 @@ paths: type: string format: google-fieldmask delete: - description: Deletes the specified webhook. - operationId: dialogflow.projects.locations.agents.webhooks.delete + description: Deletes the specified Experiment. + operationId: dialogflow.projects.locations.agents.environments.experiments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20912,19 +24718,28 @@ paths: schema: type: string - in: path - name: webhooksId + name: environmentsId required: true schema: type: string - - in: query - name: force + - in: path + name: experimentsId + required: true schema: - type: boolean - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments: + type: string + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/experiments/{experimentsId}:start: parameters: *ref_1 - get: - description: Returns the list of all environments in the specified Agent. - operationId: dialogflow.projects.locations.agents.environments.list + post: + description: >- + Starts the specified Experiment. This rpc only changes the state of + experiment from PENDING to RUNNING. + operationId: dialogflow.projects.locations.agents.environments.experiments.start + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3StartExperimentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20940,8 +24755,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3ListEnvironmentsResponse + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Experiment' parameters: - in: path name: projectsId @@ -20958,30 +24772,29 @@ paths: required: true schema: type: string - - in: query - name: pageSize + - in: path + name: environmentsId + required: true schema: - type: integer - format: int32 - - in: query - name: pageToken + type: string + - in: path + name: experimentsId + required: true schema: type: string + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/experiments/{experimentsId}:stop: + parameters: *ref_1 post: description: >- - Creates an Environment in the specified Agent. This method is a - [long-running - operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). - The returned `Operation` type has the following method-specific fields: - - `metadata`: An empty [Struct - message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - - `response`: Environment - operationId: dialogflow.projects.locations.agents.environments.create + Stops the specified Experiment. This rpc only changes the state of + experiment from RUNNING to DONE. + operationId: dialogflow.projects.locations.agents.environments.experiments.stop requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Environment' + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3StopExperimentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20997,7 +24810,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Experiment' parameters: - in: path name: projectsId @@ -21014,11 +24827,21 @@ paths: required: true schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}: + - in: path + name: environmentsId + required: true + schema: + type: string + - in: path + name: experimentsId + required: true + schema: + type: string + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/generators: parameters: *ref_1 get: - description: Retrieves the specified Environment. - operationId: dialogflow.projects.locations.agents.environments.get + description: Returns the list of all generators in the specified agent. + operationId: dialogflow.projects.locations.agents.generators.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21034,7 +24857,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Environment' + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3ListGeneratorsResponse parameters: - in: path name: projectsId @@ -21051,25 +24875,68 @@ paths: required: true schema: type: string - - in: path - name: environmentsId - required: true + - in: query + name: languageCode schema: type: string - patch: - description: >- - Updates the specified Environment. This method is a [long-running - operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). - The returned `Operation` type has the following method-specific fields: - - `metadata`: An empty [Struct - message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - - `response`: Environment - operationId: dialogflow.projects.locations.agents.environments.patch + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + post: + description: Creates a generator in the specified agent. + operationId: dialogflow.projects.locations.agents.generators.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Environment' + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Generator' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/dialogflow + Oauth2c: + - https://www.googleapis.com/auth/dialogflow + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Generator' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: agentsId + required: true + schema: + type: string + - in: query + name: languageCode + schema: + type: string + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/generators/{generatorsId}: + parameters: *ref_1 + get: + description: Retrieves the specified generator. + operationId: dialogflow.projects.locations.agents.generators.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21085,7 +24952,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Generator' parameters: - in: path name: projectsId @@ -21103,18 +24970,22 @@ paths: schema: type: string - in: path - name: environmentsId + name: generatorsId required: true schema: type: string - in: query - name: updateMask + name: languageCode schema: type: string - format: google-fieldmask - delete: - description: Deletes the specified Environment. - operationId: dialogflow.projects.locations.agents.environments.delete + patch: + description: Update the specified generator. + operationId: dialogflow.projects.locations.agents.generators.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Generator' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21130,7 +25001,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Generator' parameters: - in: path name: projectsId @@ -21148,16 +25019,22 @@ paths: schema: type: string - in: path - name: environmentsId + name: generatorsId required: true schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}:lookupEnvironmentHistory: - parameters: *ref_1 - get: - description: Looks up the history of the specified Environment. - operationId: >- - dialogflow.projects.locations.agents.environments.lookupEnvironmentHistory + - in: query + name: languageCode + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes the specified generators. + operationId: dialogflow.projects.locations.agents.generators.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21173,8 +25050,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3LookupEnvironmentHistoryResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -21192,36 +25068,24 @@ paths: schema: type: string - in: path - name: environmentsId + name: generatorsId required: true schema: type: string - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + name: force schema: - type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}:runContinuousTest: + type: boolean + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks: parameters: *ref_1 post: - description: >- - Kicks off a continuous test under the specified Environment. This method - is a [long-running - operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). - The returned `Operation` type has the following method-specific fields: - - `metadata`: RunContinuousTestMetadata - `response`: - RunContinuousTestResponse - operationId: dialogflow.projects.locations.agents.environments.runContinuousTest + description: Creates a playbook in a specified agent. + operationId: dialogflow.projects.locations.agents.playbooks.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3RunContinuousTestRequest + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Playbook' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21237,7 +25101,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Playbook' parameters: - in: path name: projectsId @@ -21254,26 +25118,9 @@ paths: required: true schema: type: string - - in: path - name: environmentsId - required: true - schema: - type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}:deployFlow: - parameters: *ref_1 - post: - description: >- - Deploys a flow to the specified Environment. This method is a - [long-running - operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). - The returned `Operation` type has the following method-specific fields: - - `metadata`: DeployFlowMetadata - `response`: DeployFlowResponse - operationId: dialogflow.projects.locations.agents.environments.deployFlow - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3DeployFlowRequest' + get: + description: Returns a list of playbooks in the specified agent. + operationId: dialogflow.projects.locations.agents.playbooks.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21289,7 +25136,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3ListPlaybooksResponse parameters: - in: path name: projectsId @@ -21306,16 +25154,20 @@ paths: required: true schema: type: string - - in: path - name: environmentsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/deployments: + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}: parameters: *ref_1 - get: - description: Returns the list of all deployments in the specified Environment. - operationId: dialogflow.projects.locations.agents.environments.deployments.list + delete: + description: Deletes a specified playbook. + operationId: dialogflow.projects.locations.agents.playbooks.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21331,8 +25183,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3ListDeploymentsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -21350,24 +25201,13 @@ paths: schema: type: string - in: path - name: environmentsId + name: playbooksId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/deployments/{deploymentsId}: - parameters: *ref_1 get: - description: Retrieves the specified Deployment. - operationId: dialogflow.projects.locations.agents.environments.deployments.get + description: Retrieves the specified Playbook. + operationId: dialogflow.projects.locations.agents.playbooks.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21383,7 +25223,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Deployment' + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Playbook' parameters: - in: path name: projectsId @@ -21401,32 +25241,18 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: deploymentsId + name: playbooksId required: true schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/sessions/{sessionsId}:detectIntent: - parameters: *ref_1 - post: - description: >- - Processes a natural language query and returns structured, actionable - data as a result. This method is not idempotent, because it may cause - session entity types to be updated, which in turn might affect results - of future queries. Note: Always use agent versions for production - traffic. See [Versions and - environments](https://cloud.google.com/dialogflow/cx/docs/concept/version). - operationId: dialogflow.projects.locations.agents.environments.sessions.detectIntent + patch: + description: Updates the specified Playbook. + operationId: dialogflow.projects.locations.agents.playbooks.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3DetectIntentRequest + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Playbook' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21442,8 +25268,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3DetectIntentResponse + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Playbook' parameters: - in: path name: projectsId @@ -21461,32 +25286,29 @@ paths: schema: type: string - in: path - name: environmentsId + name: playbooksId required: true schema: type: string - - in: path - name: sessionsId - required: true + - in: query + name: updateMask schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/sessions/{sessionsId}:serverStreamingDetectIntent: + format: google-fieldmask + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}:export: parameters: *ref_1 post: description: >- - Processes a natural language query and returns structured, actionable - data as a result through server-side streaming. Server-side streaming - allows Dialogflow to send [partial - responses](https://cloud.google.com/dialogflow/cx/docs/concept/fulfillment#partial-response) - earlier in a single request. - operationId: >- - dialogflow.projects.locations.agents.environments.sessions.serverStreamingDetectIntent + Exports the specified playbook to a binary file. Note that resources + (e.g. examples, tools) that the playbook references will also be + exported. + operationId: dialogflow.projects.locations.agents.playbooks.export requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3DetectIntentRequest + #/components/schemas/GoogleCloudDialogflowCxV3ExportPlaybookRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21502,8 +25324,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3DetectIntentResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -21521,27 +25342,23 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: sessionsId + name: playbooksId required: true schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/sessions/{sessionsId}:matchIntent: + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks:import: parameters: *ref_1 post: description: >- - Returns preliminary intent match results, doesn't change the session - status. - operationId: dialogflow.projects.locations.agents.environments.sessions.matchIntent + Imports the specified playbook to the specified agent from a binary + file. + operationId: dialogflow.projects.locations.agents.playbooks.import requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3MatchIntentRequest' + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3ImportPlaybookRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21557,8 +25374,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3MatchIntentResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -21575,30 +25391,16 @@ paths: required: true schema: type: string - - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: sessionsId - required: true - schema: - type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/sessions/{sessionsId}:fulfillIntent: + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}/examples: parameters: *ref_1 post: - description: >- - Fulfills a matched intent returned by MatchIntent. Must be called after - MatchIntent, with input from MatchIntentResponse. Otherwise, the - behavior is undefined. - operationId: dialogflow.projects.locations.agents.environments.sessions.fulfillIntent + description: Creates an example in the specified playbook. + operationId: dialogflow.projects.locations.agents.playbooks.examples.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3FulfillIntentRequest + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Example' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21614,8 +25416,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3FulfillIntentResponse + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Example' parameters: - in: path name: projectsId @@ -21633,21 +25434,13 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: sessionsId + name: playbooksId required: true schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/sessions/{sessionsId}/entityTypes: - parameters: *ref_1 get: - description: Returns the list of all session entity types in the specified session. - operationId: >- - dialogflow.projects.locations.agents.environments.sessions.entityTypes.list + description: Returns a list of examples in the specified playbook. + operationId: dialogflow.projects.locations.agents.playbooks.examples.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21664,7 +25457,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3ListSessionEntityTypesResponse + #/components/schemas/GoogleCloudDialogflowCxV3ListExamplesResponse parameters: - in: path name: projectsId @@ -21682,12 +25475,7 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: sessionsId + name: playbooksId required: true schema: type: string @@ -21700,15 +25488,15 @@ paths: name: pageToken schema: type: string - post: - description: Creates a session entity type. - operationId: >- - dialogflow.projects.locations.agents.environments.sessions.entityTypes.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3SessionEntityType' + - in: query + name: languageCode + schema: + type: string + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}/examples/{examplesId}: + parameters: *ref_1 + delete: + description: Deletes the specified example. + operationId: dialogflow.projects.locations.agents.playbooks.examples.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21724,8 +25512,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3SessionEntityType + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -21743,21 +25530,18 @@ paths: schema: type: string - in: path - name: environmentsId + name: playbooksId required: true schema: type: string - in: path - name: sessionsId + name: examplesId required: true schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/sessions/{sessionsId}/entityTypes/{entityTypesId}: - parameters: *ref_1 get: - description: Retrieves the specified session entity type. - operationId: >- - dialogflow.projects.locations.agents.environments.sessions.entityTypes.get + description: Retrieves the specified example. + operationId: dialogflow.projects.locations.agents.playbooks.examples.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21773,8 +25557,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3SessionEntityType + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Example' parameters: - in: path name: projectsId @@ -21792,29 +25575,23 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: sessionsId + name: playbooksId required: true schema: type: string - in: path - name: entityTypesId + name: examplesId required: true schema: type: string patch: - description: Updates the specified session entity type. - operationId: >- - dialogflow.projects.locations.agents.environments.sessions.entityTypes.patch + description: Update the specified example. + operationId: dialogflow.projects.locations.agents.playbooks.examples.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3SessionEntityType' + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Example' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21830,8 +25607,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3SessionEntityType + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Example' parameters: - in: path name: projectsId @@ -21849,17 +25625,12 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: sessionsId + name: playbooksId required: true schema: type: string - in: path - name: entityTypesId + name: examplesId required: true schema: type: string @@ -21868,10 +25639,16 @@ paths: schema: type: string format: google-fieldmask - delete: - description: Deletes the specified session entity type. - operationId: >- - dialogflow.projects.locations.agents.environments.sessions.entityTypes.delete + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}/versions: + parameters: *ref_1 + post: + description: Creates a version for the specified Playbook. + operationId: dialogflow.projects.locations.agents.playbooks.versions.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3PlaybookVersion' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21887,7 +25664,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3PlaybookVersion' parameters: - in: path name: projectsId @@ -21905,26 +25682,13 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: sessionsId - required: true - schema: - type: string - - in: path - name: entityTypesId + name: playbooksId required: true schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/continuousTestResults: - parameters: *ref_1 get: - description: Fetches a list of continuous test results for a given environment. - operationId: >- - dialogflow.projects.locations.agents.environments.continuousTestResults.list + description: Lists versions for the specified Playbook. + operationId: dialogflow.projects.locations.agents.playbooks.versions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21941,7 +25705,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3ListContinuousTestResultsResponse + #/components/schemas/GoogleCloudDialogflowCxV3ListPlaybookVersionsResponse parameters: - in: path name: projectsId @@ -21959,7 +25723,7 @@ paths: schema: type: string - in: path - name: environmentsId + name: playbooksId required: true schema: type: string @@ -21972,11 +25736,11 @@ paths: name: pageToken schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/experiments: + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}/versions/{versionsId}: parameters: *ref_1 get: - description: Returns the list of all experiments in the specified Environment. - operationId: dialogflow.projects.locations.agents.environments.experiments.list + description: Retrieves the specified version of the Playbook. + operationId: dialogflow.projects.locations.agents.playbooks.versions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21992,8 +25756,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3ListExperimentsResponse + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3PlaybookVersion' parameters: - in: path name: projectsId @@ -22011,27 +25774,18 @@ paths: schema: type: string - in: path - name: environmentsId + name: playbooksId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: versionsId + required: true schema: type: string - post: - description: Creates an Experiment in the specified Environment. - operationId: dialogflow.projects.locations.agents.environments.experiments.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Experiment' + delete: + description: Deletes the specified version of the Playbook. + operationId: dialogflow.projects.locations.agents.playbooks.versions.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22047,7 +25801,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Experiment' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -22065,15 +25819,28 @@ paths: schema: type: string - in: path - name: environmentsId + name: playbooksId required: true schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/experiments/{experimentsId}: + - in: path + name: versionsId + required: true + schema: + type: string + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}/versions/{versionsId}:restore: parameters: *ref_1 - get: - description: Retrieves the specified Experiment. - operationId: dialogflow.projects.locations.agents.environments.experiments.get + post: + description: >- + Retrieves the specified version of the Playbook and stores it as the + current playbook draft, returning the playbook with resources updated. + operationId: dialogflow.projects.locations.agents.playbooks.versions.restore + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3RestorePlaybookVersionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22089,7 +25856,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Experiment' + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3RestorePlaybookVersionResponse parameters: - in: path name: projectsId @@ -22107,23 +25875,25 @@ paths: schema: type: string - in: path - name: environmentsId + name: playbooksId required: true schema: type: string - in: path - name: experimentsId + name: versionsId required: true schema: type: string - patch: - description: Updates the specified Experiment. - operationId: dialogflow.projects.locations.agents.environments.experiments.patch + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tools: + parameters: *ref_1 + post: + description: Creates a Tool in the specified agent. + operationId: dialogflow.projects.locations.agents.tools.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Experiment' + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Tool' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22139,7 +25909,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Experiment' + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Tool' parameters: - in: path name: projectsId @@ -22156,24 +25926,56 @@ paths: required: true schema: type: string + get: + description: Returns a list of Tools in the specified agent. + operationId: dialogflow.projects.locations.agents.tools.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/dialogflow + Oauth2c: + - https://www.googleapis.com/auth/dialogflow + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3ListToolsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string - in: path - name: environmentsId + name: locationsId required: true schema: type: string - in: path - name: experimentsId + name: agentsId required: true schema: type: string - in: query - name: updateMask + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - format: google-fieldmask - delete: - description: Deletes the specified Experiment. - operationId: dialogflow.projects.locations.agents.environments.experiments.delete + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tools/{toolsId}: + parameters: *ref_1 + get: + description: Retrieves the specified Tool. + operationId: dialogflow.projects.locations.agents.tools.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22189,7 +25991,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Tool' parameters: - in: path name: projectsId @@ -22207,28 +26009,18 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: experimentsId + name: toolsId required: true schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/experiments/{experimentsId}:start: - parameters: *ref_1 - post: - description: >- - Starts the specified Experiment. This rpc only changes the state of - experiment from PENDING to RUNNING. - operationId: dialogflow.projects.locations.agents.environments.experiments.start + patch: + description: Update the specified Tool. + operationId: dialogflow.projects.locations.agents.tools.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3StartExperimentRequest + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Tool' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22244,7 +26036,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Experiment' + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Tool' parameters: - in: path name: projectsId @@ -22262,28 +26054,18 @@ paths: schema: type: string - in: path - name: environmentsId + name: toolsId required: true schema: type: string - - in: path - name: experimentsId - required: true + - in: query + name: updateMask schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/experiments/{experimentsId}:stop: - parameters: *ref_1 - post: - description: >- - Stops the specified Experiment. This rpc only changes the state of - experiment from RUNNING to DONE. - operationId: dialogflow.projects.locations.agents.environments.experiments.stop - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3StopExperimentRequest + format: google-fieldmask + delete: + description: Deletes a specified Tool. + operationId: dialogflow.projects.locations.agents.tools.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22299,7 +26081,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Experiment' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -22317,20 +26099,19 @@ paths: schema: type: string - in: path - name: environmentsId + name: toolsId required: true schema: type: string - - in: path - name: experimentsId - required: true + - in: query + name: force schema: - type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/generators: + type: boolean + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tools/{toolsId}/versions: parameters: *ref_1 get: - description: Returns the list of all generators in the specified agent. - operationId: dialogflow.projects.locations.agents.generators.list + description: List versions of the specified Tool. + operationId: dialogflow.projects.locations.agents.tools.versions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22347,7 +26128,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3ListGeneratorsResponse + #/components/schemas/GoogleCloudDialogflowCxV3ListToolVersionsResponse parameters: - in: path name: projectsId @@ -22364,8 +26145,9 @@ paths: required: true schema: type: string - - in: query - name: languageCode + - in: path + name: toolsId + required: true schema: type: string - in: query @@ -22378,13 +26160,13 @@ paths: schema: type: string post: - description: Creates a generator in the specified agent. - operationId: dialogflow.projects.locations.agents.generators.create + description: Creates a version for the specified Tool. + operationId: dialogflow.projects.locations.agents.tools.versions.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Generator' + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3ToolVersion' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22400,7 +26182,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Generator' + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3ToolVersion' parameters: - in: path name: projectsId @@ -22417,15 +26199,16 @@ paths: required: true schema: type: string - - in: query - name: languageCode + - in: path + name: toolsId + required: true schema: type: string - /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/generators/{generatorsId}: + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tools/{toolsId}/versions/{versionsId}: parameters: *ref_1 get: - description: Retrieves the specified generator. - operationId: dialogflow.projects.locations.agents.generators.get + description: Retrieves the specified version of the Tool. + operationId: dialogflow.projects.locations.agents.tools.versions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22441,7 +26224,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Generator' + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3ToolVersion' parameters: - in: path name: projectsId @@ -22459,22 +26242,18 @@ paths: schema: type: string - in: path - name: generatorsId + name: toolsId required: true schema: type: string - - in: query - name: languageCode + - in: path + name: versionsId + required: true schema: type: string - patch: - description: Update the specified generator. - operationId: dialogflow.projects.locations.agents.generators.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Generator' + delete: + description: Deletes the specified version of the Tool. + operationId: dialogflow.projects.locations.agents.tools.versions.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22490,7 +26269,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Generator' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -22508,22 +26287,32 @@ paths: schema: type: string - in: path - name: generatorsId + name: toolsId required: true schema: type: string - - in: query - name: languageCode + - in: path + name: versionsId + required: true schema: type: string - in: query - name: updateMask + name: force schema: - type: string - format: google-fieldmask - delete: - description: Deletes the specified generators. - operationId: dialogflow.projects.locations.agents.generators.delete + type: boolean + /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tools/{toolsId}/versions/{versionsId}:restore: + parameters: *ref_1 + post: + description: >- + Retrieves the specified version of the Tool and stores it as the current + tool draft, returning the tool with resources updated. + operationId: dialogflow.projects.locations.agents.tools.versions.restore + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3RestoreToolVersionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22539,7 +26328,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3RestoreToolVersionResponse parameters: - in: path name: projectsId @@ -22557,11 +26347,12 @@ paths: schema: type: string - in: path - name: generatorsId + name: toolsId required: true schema: type: string - - in: query - name: force + - in: path + name: versionsId + required: true schema: - type: boolean + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/discoveryengine.yaml b/providers/src/googleapis.com/v00.00.00000/services/discoveryengine.yaml index c742fa7d..df48a8a2 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/discoveryengine.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/discoveryengine.yaml @@ -7,8 +7,8 @@ info: title: Discovery Engine API description: Discovery Engine API. version: v1 - x-discovery-doc-revision: '20241030' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250816' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/generative-ai-app-builder/docs/ servers: @@ -25,6 +25,7 @@ components: https://www.googleapis.com/auth/cloud-platform: >- See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. + https://www.googleapis.com/auth/cloud_search.query: Search your organization's data in the Cloud Search index Oauth2c: type: oauth2 description: Oauth 2.0 authorization code authentication @@ -145,8413 +146,9274 @@ components: { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } type: object properties: {} - GoogleCloudDiscoveryengineV1CompleteQueryResponse: - id: GoogleCloudDiscoveryengineV1CompleteQueryResponse - description: Response message for CompletionService.CompleteQuery method. + GoogleCloudDiscoveryengineV1SearchRequest: + id: GoogleCloudDiscoveryengineV1SearchRequest + description: Request message for SearchService.Search method. type: object properties: - querySuggestions: + branch: description: >- - Results of the matched query suggestions. The result list is ordered - and the first result is a top suggestion. + The branch resource name, such as + `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. + Use `default_branch` as the branch ID or leave this field empty, to + search documents under the default branch. + type: string + query: + description: Raw search query. + type: string + imageQuery: + description: Raw image query. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestImageQuery + pageSize: + description: >- + Maximum number of Documents to return. The maximum allowed value + depends on the data type. Values above the maximum value are coerced + to the maximum value. * Websites with basic indexing: Default `10`, + Maximum `25`. * Websites with advanced indexing: Default `25`, + Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is + negative, an `INVALID_ARGUMENT` is returned. + type: integer + format: int32 + pageToken: + description: >- + A page token received from a previous SearchService.Search call. + Provide this to retrieve the subsequent page. When paginating, all + other parameters provided to SearchService.Search must match the + call that provided the page token. Otherwise, an `INVALID_ARGUMENT` + error is returned. + type: string + offset: + description: >- + A 0-indexed integer that specifies the current offset (that is, + starting result location, amongst the Documents deemed by the API as + relevant) in search results. This field is only considered if + page_token is unset. If this field is negative, an + `INVALID_ARGUMENT` is returned. + type: integer + format: int32 + oneBoxPageSize: + description: >- + The maximum number of results to return for OneBox. This applies to + each OneBox type individually. Default number is 10. + type: integer + format: int32 + dataStoreSpecs: + description: >- + Specifications that define the specific DataStores to be searched, + along with configurations for those data stores. This is only + considered for Engines with multiple data stores. For engines with a + single data store, the specs directly under SearchRequest should be + used. type: array items: $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1CompleteQueryResponseQuerySuggestion - tailMatchTriggered: + #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec + filter: description: >- - True if the returned suggestions are all tail suggestions. For tail - matching to be triggered, include_tail_suggestions in the request - must be true and there must be no suggestions that match the full - query. - type: boolean - GoogleCloudDiscoveryengineV1CompleteQueryResponseQuerySuggestion: - id: GoogleCloudDiscoveryengineV1CompleteQueryResponseQuerySuggestion - description: Suggestions as search queries. - type: object - properties: - suggestion: - description: The suggestion for the query. + The filter syntax consists of an expression language for + constructing a predicate from one or more fields of the documents + being filtered. Filter expression is case-sensitive. If this field + is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in + Vertex AI Search is done by mapping the LHS filter key to a key + property defined in the Vertex AI Search backend -- this mapping is + defined by the customer in their schema. For example a media + customer might have a field 'name' in their schema. In this case the + filter would look like this: filter --> name:'ANY("king kong")' For + more information about filtering including syntax and filter + operators, see + [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) type: string - completableFieldPaths: + canonicalFilter: description: >- - The unique document field paths that serve as the source of this - suggestion if it was generated from completable fields. This field - is only populated for the document-completable model. - type: array - items: - type: string - GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesRequest: - id: GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesRequest - description: >- - Request message for CompletionService.ImportSuggestionDenyListEntries - method. - type: object - properties: - inlineSource: + The default filter that is applied when a user performs a search + without checking any filters on the search page. The filter applied + to every search request when quality improvement such as query + expansion is needed. In the case a query does not have a sufficient + amount of results this filter will be used to determine whether or + not to enable the query expansion flow. The original filter will + still be used for the query expanded search. This field is strongly + recommended to achieve high search quality. For more information + about filter syntax, see SearchRequest.filter. + type: string + orderBy: description: >- - The Inline source for the input content for suggestion deny list - entries. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesRequestInlineSource - gcsSource: + The order in which documents are returned. Documents can be ordered + by a field in an Document object. Leave it unset if ordered by + relevance. `order_by` expression is case-sensitive. For more + information on ordering the website search results, see [Order web + search + results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). + For more information on ordering the healthcare search results, see + [Order healthcare search + results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). + If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. + type: string + userInfo: description: >- - Cloud Storage location for the input content. Only 1 file can be - specified that contains all entries to import. Supported values - `gcs_source.schema` for autocomplete suggestion deny list entry - imports: * `suggestion_deny_list` (default): One JSON - [SuggestionDenyListEntry] per line. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1GcsSource' - GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesRequestInlineSource: - id: >- - GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesRequestInlineSource - description: The inline source for SuggestionDenyListEntry. - type: object - properties: - entries: + Information about the end user. Highly recommended for analytics and + personalization. UserInfo.user_agent is used to deduce `device_type` + for analytics. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1UserInfo' + languageCode: description: >- - Required. A list of all denylist entries to import. Max of 1000 - items. + The BCP-47 language code, such as "en-US" or "sr-Latn". For more + information, see [Standard + fields](https://cloud.google.com/apis/design/standard_fields). This + field helps to better interpret the query. If a value isn't + specified, the query language code is automatically detected, which + may not be accurate. + type: string + facetSpecs: + description: >- + Facet specifications for faceted search. If empty, no facets are + returned. A maximum of 100 values are allowed. Otherwise, an + `INVALID_ARGUMENT` error is returned. type: array items: $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SuggestionDenyListEntry - GoogleCloudDiscoveryengineV1SuggestionDenyListEntry: - id: GoogleCloudDiscoveryengineV1SuggestionDenyListEntry - description: >- - Suggestion deny list entry identifying the phrase to block from - suggestions and the applied operation for the phrase. - type: object - properties: - blockPhrase: + #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestFacetSpec + boostSpec: description: >- - Required. Phrase to block from suggestions served. Can be maximum - 125 characters. + Boost specification to boost certain documents. For more information + on boosting, see + [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestBoostSpec + params: + description: >- + Additional search parameters. For public website search only, + supported values are: * `user_country_code`: string. Default empty. + If set to non-empty, results are restricted or boosted based on the + location provided. For example, `user_country_code: "au"` For + available codes see [Country + Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) + * `search_type`: double. Default empty. Enables non-webpage + searching depending on the value. The only valid non-default value + is 1, which enables image searching. For example, `search_type: 1` + type: object + additionalProperties: + type: any + queryExpansionSpec: + description: >- + The query expansion specification that specifies the conditions + under which query expansion occurs. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec + spellCorrectionSpec: + description: >- + The spell correction specification that specifies the mode under + which spell correction takes effect. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestSpellCorrectionSpec + userPseudoId: + description: >- + A unique identifier for tracking visitors. For example, this could + be implemented with an HTTP cookie, which should be able to uniquely + identify a visitor on a single device. This unique identifier should + not change if the visitor logs in or out of the website. This field + should NOT have a fixed value such as `unknown_visitor`. This should + be the same identifier as UserEvent.user_pseudo_id and + CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 + encoded string with a length limit of 128 characters. Otherwise, an + `INVALID_ARGUMENT` error is returned. type: string - matchOperator: + contentSearchSpec: + description: A specification for configuring the behavior of content search. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec + rankingExpression: description: >- - Required. The match operator to apply for this phrase. Whether to - block the exact phrase, or block any suggestions containing this - phrase. + Optional. The ranking expression controls the customized ranking on + retrieval documents. This overrides + ServingConfig.ranking_expression. The syntax and supported features + depend on the `ranking_expression_backend` value. If + `ranking_expression_backend` is not provided, it defaults to + `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided + or set to `RANK_BY_EMBEDDING`, it should be a single function or + multiple functions that are joined by "+". * ranking_expression = + function, { " + ", function }; Supported functions: * double * + relevance_score * double * dotProduct(embedding_field_path) Function + variables: * `relevance_score`: pre-defined keywords, used for + measure relevance between query and document. * + `embedding_field_path`: the document embedding field used with query + embedding vector. * `dotProduct`: embedding function between + `embedding_field_path` and query embedding vector. Example ranking + expression: If document has an embedding field doc_embedding, the + ranking expression could be `0.5 * relevance_score + 0.3 * + dotProduct(doc_embedding)`. If ranking_expression_backend is set to + `RANK_BY_FORMULA`, the following expression types (and combinations + of those chained using + or * operators) are supported: * `double` * + `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` + -- reciprocal rank transformation with second argument being a + denominator constant. * `is_nan(signal)` -- returns 0 if signal is + NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if + signal1 is NaN, returns signal2 | double, else returns signal1. Here + are a few examples of ranking formulas that use the supported + ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * + log(keyword_similarity_score)` -- mostly rank by the logarithm of + `keyword_similarity_score` with slight `semantic_smilarity_score` + adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of + `semantic_similarity_score` filling the value with 0 if it's NaN, + also add constant 0.3 adjustment to the final score if + `semantic_similarity_score` is NaN. - `0.2 * + rr(semantic_similarity_score, 16) + 0.8 * + rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal + rank of `keyword_similarity_score` with slight adjustment of + reciprocal rank of `semantic_smilarity_score`. The following signals + are supported: * `semantic_similarity_score`: semantic similarity + adjustment that is calculated using the embeddings generated by a + proprietary Google model. This score determines how semantically + similar a search query is to a document. * + `keyword_similarity_score`: keyword match adjustment uses the Best + Match 25 (BM25) ranking function. This score is calculated using a + probabilistic model to estimate the probability that a document is + relevant to a given query. * `relevance_score`: semantic relevance + adjustment that uses a proprietary Google model to determine the + meaning and intent behind a user's query in context with the content + in the documents. * `pctr_rank`: predicted conversion rate + adjustment as a rank use predicted Click-through rate (pCTR) to + gauge the relevance and attractiveness of a search result from a + user's perspective. A higher pCTR suggests that the result is more + likely to satisfy the user's query and intent, making it a valuable + signal for ranking. * `freshness_rank`: freshness adjustment as a + rank * `document_age`: The time in hours elapsed since the document + was last updated, a floating-point number (e.g., 0.25 means 15 + minutes). * `topicality_rank`: topicality adjustment as a rank. Uses + proprietary Google model to determine the keyword-based overlap + between the query and the document. * `base_rank`: the default rank + of the result + type: string + rankingExpressionBackend: + description: Optional. The backend to use for the ranking expression evaluation. type: string enumDescriptions: - - Default value. Should not be used + - Default option for unspecified/unknown values. - >- - If the suggestion is an exact match to the block_phrase, then - block it. - - If the suggestion contains the block_phrase, then block it. + Deprecated: Use `RANK_BY_EMBEDDING` instead. Ranking by custom + embedding model, the default way to evaluate the ranking + expression. Legacy enum option, `RANK_BY_EMBEDDING` should be used + instead. + - >- + Deprecated: Use `RANK_BY_FORMULA` instead. Ranking by custom + formula. Legacy enum option, `RANK_BY_FORMULA` should be used + instead. + - >- + Ranking by custom embedding model, the default way to evaluate the + ranking expression. + - Ranking by custom formula. + enumDeprecated: + - false + - true + - true + - false + - false enum: - - MATCH_OPERATOR_UNSPECIFIED - - EXACT_MATCH - - CONTAINS - GoogleCloudDiscoveryengineV1GcsSource: - id: GoogleCloudDiscoveryengineV1GcsSource - description: Cloud Storage location for input content. - type: object - properties: - inputUris: + - RANKING_EXPRESSION_BACKEND_UNSPECIFIED + - BYOE + - CLEARBOX + - RANK_BY_EMBEDDING + - RANK_BY_FORMULA + safeSearch: description: >- - Required. Cloud Storage URIs to input files. Each URI can be up to - 2000 characters long. URIs can match the full object path (for - example, `gs://bucket/directory/object.json`) or a pattern matching - one or more files, such as `gs://bucket/directory/*.json`. A request - can contain at most 100 files (or 100,000 files if `data_schema` is - `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` - is `content`). - type: array - items: - type: string - dataSchema: + Whether to turn on safe search. This is only supported for website + search. + type: boolean + userLabels: description: >- - The schema to use when parsing the data from the source. Supported - values for document imports: * `document` (default): One JSON - Document per line. Each document must have a valid Document.id. * - `content`: Unstructured data (e.g. PDF, HTML). Each file matched by - `input_uris` becomes a document, with the ID set to the first 128 - bits of SHA256(URI) encoded as a hex string. * `custom`: One custom - data JSON per row in arbitrary format that conforms to the defined - Schema of the data store. This can only be used by the GENERIC Data - Store vertical. * `csv`: A CSV file with header conforming to the - defined Schema of the data store. Each entry after the header is - imported as a Document. This can only be used by the GENERIC Data - Store vertical. Supported values for user event imports: * - `user_event` (default): One JSON UserEvent per line. + The user labels applied to a resource must meet the following + requirements: * Each resource can have multiple labels, up to a + maximum of 64. * Each label must be a key-value pair. * Keys have a + minimum length of 1 character and a maximum length of 63 characters + and cannot be empty. Values can be empty and have a maximum length + of 63 characters. * Keys and values can contain only lowercase + letters, numeric characters, underscores, and dashes. All characters + must use UTF-8 encoding, and international characters are allowed. * + The key portion of a label must be unique. However, you can use the + same key with multiple resources. * Keys must start with a lowercase + letter or international character. See [Google Cloud + Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) + for more details. + type: object + additionalProperties: + type: string + searchAsYouTypeSpec: + description: >- + Search as you type configuration. Only supported for the + IndustryVertical.MEDIA vertical. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec + displaySpec: + description: >- + Optional. Config for display feature, like match highlighting on + search results. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestDisplaySpec + session: + description: >- + The session resource name. Optional. Session allows users to do + multi-turn /search API calls or coordination between /search API + calls and /answer API calls. Example #1 (multi-turn /search API + calls): Call /search API with the session ID generated in the first + call. Here, the previous search query gets considered in query + standing. I.e., if the first query is "How did Alphabet do in 2022?" + and the current query is "How about 2023?", the current query will + be interpreted as "How did Alphabet do in 2023?". Example #2 + (coordination between /search API calls and /answer API calls): Call + /answer API with the session ID generated in the first call. Here, + the answer generation happens in the context of the search results + from the first search call. Multi-turn Search feature is currently + at private GA stage. Please use v1alpha or v1beta version instead + before we launch this feature to public GA. Or ask for allowlisting + through Google Support team. type: string - GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesRequest: - id: GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesRequest - description: >- - Request message for CompletionService.PurgeSuggestionDenyListEntries - method. + sessionSpec: + description: Session specification. Can be used only when `session` is set. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestSessionSpec + relevanceThreshold: + description: >- + The relevance threshold of the search results. Default to Google + defined threshold, leveraging a balance of precision and recall to + deliver both highly accurate results and comprehensive coverage of + relevant information. This feature is not supported for healthcare + search. + type: string + enumDescriptions: + - >- + Default value. In this case, server behavior defaults to Google + defined threshold. + - Lowest relevance threshold. + - Low relevance threshold. + - Medium relevance threshold. + - High relevance threshold. + enum: + - RELEVANCE_THRESHOLD_UNSPECIFIED + - LOWEST + - LOW + - MEDIUM + - HIGH + relevanceScoreSpec: + description: Optional. The specification for returning the relevance score. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestRelevanceScoreSpec + GoogleCloudDiscoveryengineV1SearchRequestImageQuery: + id: GoogleCloudDiscoveryengineV1SearchRequestImageQuery + description: Specifies the image query input. type: object - properties: {} - GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequest: - id: GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequest + properties: + imageBytes: + description: >- + Base64 encoded image bytes. Supported image formats: JPEG, PNG, and + BMP. + type: string + GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec: + id: GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec description: >- - Request message for CompletionService.ImportCompletionSuggestions - method. + A struct to define data stores to filter on in a search call and + configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` + error is returned. type: object properties: - inlineSource: - description: The Inline source for suggestion entries. + dataStore: + description: >- + Required. Full resource name of DataStore, such as + `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. + The path must include the project number, project id is not + supported for this field. + type: string + filter: + description: >- + Optional. Filter specification to filter documents in the data store + specified by data_store field. For more information on filtering, + see + [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + type: string + boostSpec: + description: >- + Optional. Boost specification to boost certain documents. For more + information on boosting, see + [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequestInlineSource - gcsSource: - description: Cloud Storage location for the input content. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1GcsSource' - bigquerySource: - description: BigQuery input source. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1BigQuerySource' - errorConfig: - description: The desired location of errors incurred during the Import. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1ImportErrorConfig' - GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequestInlineSource: - id: >- - GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequestInlineSource - description: The inline source for CompletionSuggestions. + #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestBoostSpec + customSearchOperators: + description: >- + Optional. Custom search operators which if specified will be used to + filter results from workspace data stores. For more information on + custom search operators, see + [SearchOperators](https://support.google.com/cloudsearch/answer/6172299). + type: string + GoogleCloudDiscoveryengineV1SearchRequestBoostSpec: + id: GoogleCloudDiscoveryengineV1SearchRequestBoostSpec + description: Boost specification to boost certain documents. type: object properties: - suggestions: + conditionBoostSpecs: description: >- - Required. A list of all denylist entries to import. Max of 1000 - items. + Condition boost specifications. If a document matches multiple + conditions in the specifications, boost scores from these + specifications are all applied and combined in a non-linear way. + Maximum number of specifications is 20. type: array items: $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1CompletionSuggestion - GoogleCloudDiscoveryengineV1CompletionSuggestion: - id: GoogleCloudDiscoveryengineV1CompletionSuggestion - description: Autocomplete suggestions that are imported from Customer. + #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpec + GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpec: + id: GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpec + description: Boost applies to documents which match a condition. type: object properties: - globalScore: - description: >- - Global score of this suggestion. Control how this suggestion would - be scored / ranked. - type: number - format: double - frequency: + condition: description: >- - Frequency of this suggestion. Will be used to rank suggestions when - score is not available. - type: string - format: int64 - suggestion: - description: Required. The suggestion text. - type: string - languageCode: - description: BCP-47 language code of this suggestion. + An expression which specifies a boost condition. The syntax and + supported fields are the same as a filter expression. See + SearchRequest.filter for detail syntax and limitations. Examples: * + To boost documents with document ID "doc_1" or "doc_2", and color + "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: + ANY("Red", "Blue"))` type: string - groupId: + boost: description: >- - If two suggestions have the same groupId, they will not be returned - together. Instead the one ranked higher will be returned. This can - be used to deduplicate semantically identical suggestions. - type: string - groupScore: - description: The score of this suggestion within its group. + Strength of the condition boost, which should be in [-1, 1]. + Negative boost means demotion. Default is 0.0. Setting to 1.0 gives + the document a big promotion. However, it does not necessarily mean + that the boosted document will be the top result at all times, nor + that other documents will be excluded. Results could still be shown + even when none of them matches the condition. And results that are + significantly more relevant to the search query can still trump your + heavily favored but irrelevant documents. Setting to -1.0 gives the + document a big demotion. However, results that are deeply relevant + might still be shown. The document will have an upstream battle to + get a fairly high ranking, but it is not blocked out completely. + Setting to 0.0 means no boost applied. The boosting condition is + ignored. Only one of the (condition, boost) combination or the + boost_control_spec below are set. If both are set then the global + boost is ignored and the more fine-grained boost_control_spec is + applied. type: number - format: double - alternativePhrases: - description: Alternative matching phrases for this suggestion. - type: array - items: - type: string - GoogleCloudDiscoveryengineV1BigQuerySource: - id: GoogleCloudDiscoveryengineV1BigQuerySource - description: BigQuery source import data from. + format: float + boostControlSpec: + description: >- + Complex specification for custom ranking based on customer defined + attribute value. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpec + GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpec: + id: >- + GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpec + description: >- + Specification for custom ranking based on customer specified attribute + value. It provides more controls for customized ranking than the simple + (condition, boost) combination above. type: object properties: - partitionDate: - description: >- - BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD - format. - $ref: '#/components/schemas/GoogleTypeDate' - projectId: + fieldName: description: >- - The project ID or the project number that contains the BigQuery - source. Has a length limit of 128 characters. If not specified, - inherits the project ID from the parent request. + The name of the field whose value will be used to determine the + boost amount. type: string - datasetId: + attributeType: description: >- - Required. The BigQuery data set to copy the data from with a length - limit of 1,024 characters. + The attribute type to be used to determine the boost amount. The + attribute value can be derived from the field value of the specified + field_name. In the case of numerical it is straightforward i.e. + attribute_value = numerical_field_value. In the case of freshness + however, attribute_value = (time.now() - datetime_field_value). type: string - tableId: + enumDescriptions: + - Unspecified AttributeType. + - >- + The value of the numerical field will be used to dynamically + update the boost amount. In this case, the attribute_value (the x + value) of the control point will be the actual value of the + numerical field for which the boost_amount is specified. + - >- + For the freshness use case the attribute value will be the + duration between the current time and the date in the datetime + field specified. The value must be formatted as an XSD + `dayTimeDuration` value (a restricted subset of an ISO 8601 + duration value). The pattern for this is: `nDnM]`. For example, + `5D`, `3DT12H30M`, `T24H`. + enum: + - ATTRIBUTE_TYPE_UNSPECIFIED + - NUMERICAL + - FRESHNESS + interpolationType: description: >- - Required. The BigQuery table to copy the data from with a length - limit of 1,024 characters. - type: string - gcsStagingDir: - description: >- - Intermediate Cloud Storage directory used for the import with a - length limit of 2,000 characters. Can be specified if one wants to - have the BigQuery export to a specific Cloud Storage directory. + The interpolation type to be applied to connect the control points + listed below. type: string - dataSchema: + enumDescriptions: + - >- + Interpolation type is unspecified. In this case, it defaults to + Linear. + - Piecewise linear interpolation will be applied. + enum: + - INTERPOLATION_TYPE_UNSPECIFIED + - LINEAR + controlPoints: description: >- - The schema to use when parsing the data from the source. Supported - values for user event imports: * `user_event` (default): One - UserEvent per row. Supported values for document imports: * - `document` (default): One Document format per row. Each document - must have a valid Document.id and one of Document.json_data or - Document.struct_data. * `custom`: One custom data per row in - arbitrary format that conforms to the defined Schema of the data - store. This can only be used by the GENERIC Data Store vertical. - type: string - GoogleTypeDate: - id: GoogleTypeDate + The control points used to define the curve. The monotonic function + (defined through the interpolation_type above) passes through the + control points listed here. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint + GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint: + id: >- + GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint description: >- - Represents a whole or partial calendar date, such as a birthday. The - time of day and time zone are either specified elsewhere or are - insignificant. The date is relative to the Gregorian Calendar. This can - represent one of the following: * A full date, with non-zero year, - month, and day values. * A month and day, with a zero year (for example, - an anniversary). * A year on its own, with a zero month and a zero day. - * A year and month, with a zero day (for example, a credit card - expiration date). Related types: * google.type.TimeOfDay * - google.type.DateTime * google.protobuf.Timestamp + The control points used to define the curve. The curve defined through + these control points can only be monotonically increasing or + decreasing(constant values are acceptable). type: object properties: - year: - description: >- - Year of the date. Must be from 1 to 9999, or 0 to specify a date - without a year. - type: integer - format: int32 - month: + attributeValue: description: >- - Month of a year. Must be from 1 to 12, or 0 to specify a year - without a month and day. - type: integer - format: int32 - day: + Can be one of: 1. The numerical field value. 2. The duration spec + for freshness: The value must be formatted as an XSD + `dayTimeDuration` value (a restricted subset of an ISO 8601 duration + value). The pattern for this is: `nDnM]`. + type: string + boostAmount: description: >- - Day of a month. Must be from 1 to 31 and valid for the year and - month, or 0 to specify a year by itself or a year and month where - the day isn't significant. - type: integer - format: int32 - GoogleCloudDiscoveryengineV1ImportErrorConfig: - id: GoogleCloudDiscoveryengineV1ImportErrorConfig - description: Configuration of destination for Import related errors. + The value between -1 to 1 by which to boost the score if the + attribute_value evaluates to the value specified above. + type: number + format: float + GoogleCloudDiscoveryengineV1UserInfo: + id: GoogleCloudDiscoveryengineV1UserInfo + description: Information of an end user. type: object properties: - gcsPrefix: + userId: description: >- - Cloud Storage prefix for import errors. This must be an empty, - existing Cloud Storage directory. Import errors are written to - sharded files in this directory, one per line, as a JSON-encoded - `google.rpc.Status` message. + Highly recommended for logged-in users. Unique identifier for + logged-in user, such as a user name. Don't set for anonymous users. + Always use a hashed value for this ID. Don't set the field to the + same fixed ID for different users. This mixes the event history of + those users together, which results in degraded model quality. The + field must be a UTF-8 encoded string with a length limit of 128 + characters. Otherwise, an `INVALID_ARGUMENT` error is returned. type: string - GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsRequest: - id: GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsRequest - description: Request message for CompletionService.PurgeCompletionSuggestions method. - type: object - properties: {} - GoogleCloudDiscoveryengineV1Control: - id: GoogleCloudDiscoveryengineV1Control - description: >- - Defines a conditioned behavior to employ during serving. Must be - attached to a ServingConfig to be considered at serving time. Permitted - actions dependent on `SolutionType`. + userAgent: + description: >- + User agent as included in the HTTP header. The field must be a UTF-8 + encoded string with a length limit of 1,000 characters. Otherwise, + an `INVALID_ARGUMENT` error is returned. This should not be set when + using the client side event reporting with GTM or JavaScript tag in + UserEventService.CollectUserEvent or if + UserEvent.direct_user_request is set. + type: string + timeZone: + description: Optional. IANA time zone, e.g. Europe/Budapest. + type: string + GoogleCloudDiscoveryengineV1SearchRequestFacetSpec: + id: GoogleCloudDiscoveryengineV1SearchRequestFacetSpec + description: A facet specification to perform faceted search. type: object properties: - boostAction: - description: Defines a boost-type control - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1ControlBoostAction' - filterAction: - description: >- - Defines a filter-type control Currently not supported by - Recommendation - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1ControlFilterAction' - redirectAction: - description: Defines a redirect-type control. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ControlRedirectAction - synonymsAction: - description: Treats a group of terms as synonyms of one another. + facetKey: + description: Required. The facet key specification. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ControlSynonymsAction - name: - description: >- - Immutable. Fully qualified name - `projects/*/locations/global/dataStore/*/controls/*` - type: string - displayName: + #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestFacetSpecFacetKey + limit: description: >- - Required. Human readable name. The identifier used in UI views. Must - be UTF-8 encoded string. Length limit is 128 characters. Otherwise - an INVALID ARGUMENT error is thrown. - type: string - associatedServingConfigIds: + Maximum facet values that are returned for this facet. If + unspecified, defaults to 20. The maximum allowed value is 300. + Values above 300 are coerced to 300. For aggregation in healthcare + search, when the [FacetKey.key] is "healthcare_aggregation_key", the + limit will be overridden to 10,000 internally, regardless of the + value set here. If this field is negative, an `INVALID_ARGUMENT` is + returned. + type: integer + format: int32 + excludedFilterKeys: description: >- - Output only. List of all ServingConfig IDs this control is attached - to. May take up to 10 minutes to update after changes. - readOnly: true + List of keys to exclude when faceting. By default, FacetKey.key is + not excluded from the filter unless it is listed in this field. + Listing a facet key in this field allows its values to appear as + facet results, even when they are filtered out of search results. + Using this field does not affect what search results are returned. + For example, suppose there are 100 documents with the color facet + "Red" and 200 documents with the color facet "Blue". A query + containing the filter "color:ANY("Red")" and having "color" as + FacetKey.key would by default return only "Red" documents in the + search results, and also return "Red" with count 100 as the only + color facet. Although there are also blue documents available, + "Blue" would not be shown as an available facet value. If "color" is + listed in "excludedFilterKeys", then the query returns the facet + values "Red" with count 100 and "Blue" with count 200, because the + "color" key is now excluded from the filter. Because this field + doesn't affect search results, the search results are still + correctly filtered to return only "Red" documents. A maximum of 100 + values are allowed. Otherwise, an `INVALID_ARGUMENT` error is + returned. type: array items: type: string - solutionType: + enableDynamicPosition: description: >- - Required. Immutable. What solution the control belongs to. Must be - compatible with vertical of resource. Otherwise an INVALID ARGUMENT - error is thrown. + Enables dynamic position for this facet. If set to true, the + position of this facet among all facets in the response is + determined automatically. If dynamic facets are enabled, it is + ordered together. If set to false, the position of this facet in the + response is the same as in the request, and it is ranked before the + facets with dynamic position enable and all dynamic facets. For + example, you may always want to have rating facet returned in the + response, but it's not necessarily to always display the rating + facet at the top. In that case, you can set enable_dynamic_position + to true so that the position of rating facet in response is + determined automatically. Another example, assuming you have the + following facets in the request: * "rating", enable_dynamic_position + = true * "price", enable_dynamic_position = false * "brands", + enable_dynamic_position = false And also you have a dynamic facets + enabled, which generates a facet `gender`. Then the final order of + the facets in the response can be ("price", "brands", "rating", + "gender") or ("price", "brands", "gender", "rating") depends on how + API orders "gender" and "rating" facets. However, notice that + "price" and "brands" are always ranked at first and second position + because their enable_dynamic_position is false. + type: boolean + GoogleCloudDiscoveryengineV1SearchRequestFacetSpecFacetKey: + id: GoogleCloudDiscoveryengineV1SearchRequestFacetSpecFacetKey + description: Specifies how a facet is computed. + type: object + properties: + key: + description: >- + Required. Supported textual and numerical facet keys in Document + object, over which the facet values are computed. Facet key is + case-sensitive. type: string - enumDescriptions: - - Default value. - - Used for Recommendations AI. - - Used for Discovery Search. - - Used for use cases related to the Generative AI agent. - - >- - Used for use cases related to the Generative Chat agent. It's used - for Generative chat engine only, the associated data stores must - enrolled with `SOLUTION_TYPE_CHAT` solution. - enum: - - SOLUTION_TYPE_UNSPECIFIED - - SOLUTION_TYPE_RECOMMENDATION - - SOLUTION_TYPE_SEARCH - - SOLUTION_TYPE_CHAT - - SOLUTION_TYPE_GENERATIVE_CHAT - useCases: + intervals: description: >- - Specifies the use case for the control. Affects what condition - fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently - only allow one use case per control. Must be set when solution_type - is SolutionType.SOLUTION_TYPE_SEARCH. + Set only if values should be bucketed into intervals. Must be set + for facets with numerical values. Must not be set for facet with + text values. Maximum number of intervals is 30. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Interval' + restrictedValues: + description: >- + Only get facet for the given restricted values. Only supported on + textual fields. For example, suppose "category" has three values + "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set + "restricted_values" to "Action > 2022", the "category" facet only + contains "Action > 2022". Only supported on textual fields. Maximum + is 10. type: array items: type: string - enumDescriptions: - - Value used when unset. Will not occur in CSS. - - Search use case. Expects the traffic has a non-empty query. - - Browse use case. Expects the traffic has an empty query. - enum: - - SEARCH_USE_CASE_UNSPECIFIED - - SEARCH_USE_CASE_SEARCH - - SEARCH_USE_CASE_BROWSE - conditions: + prefixes: description: >- - Determines when the associated action will trigger. Omit to always - apply the action. Currently only a single condition may be - specified. Otherwise an INVALID ARGUMENT error is thrown. + Only get facet values that start with the given string prefix. For + example, suppose "category" has three values "Action > 2022", + "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", + the "category" facet only contains "Action > 2022" and "Action > + 2021". Only supported on textual fields. Maximum is 10. type: array items: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Condition' - GoogleCloudDiscoveryengineV1ControlBoostAction: - id: GoogleCloudDiscoveryengineV1ControlBoostAction - description: Adjusts order of products in returned list. - type: object - properties: - boost: + type: string + contains: description: >- - Required. Strength of the boost, which should be in [-1, 1]. - Negative boost means demotion. Default is 0.0 (No-op). - type: number - format: float - filter: + Only get facet values that contain the given strings. For example, + suppose "category" has three values "Action > 2022", "Action > 2021" + and "Sci-Fi > 2022". If set "contains" to "2022", the "category" + facet only contains "Action > 2022" and "Sci-Fi > 2022". Only + supported on textual fields. Maximum is 10. + type: array + items: + type: string + caseInsensitive: description: >- - Required. Specifies which products to apply the boost to. If no - filter is provided all products will be boosted (No-op). Syntax - documentation: https://cloud.google.com/retail/docs/filter-and-order - Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT - error is thrown. - type: string - dataStore: + True to make facet keys case insensitive when getting faceting + values with prefixes or contains; false otherwise. + type: boolean + orderBy: description: >- - Required. Specifies which data store's documents can be boosted by - this control. Full data store name e.g. - projects/123/locations/global/collections/default_collection/dataStores/default_data_store + The order in which documents are returned. Allowed values are: * + "count desc", which means order by SearchResponse.Facet.values.count + descending. * "value desc", which means order by + SearchResponse.Facet.values.value descending. Only applies to + textual facets. If not set, textual values are sorted in [natural + order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical + intervals are sorted in the order given by + FacetSpec.FacetKey.intervals. type: string - GoogleCloudDiscoveryengineV1ControlFilterAction: - id: GoogleCloudDiscoveryengineV1ControlFilterAction + GoogleCloudDiscoveryengineV1Interval: + id: GoogleCloudDiscoveryengineV1Interval + description: A floating point interval. + type: object + properties: + minimum: + description: Inclusive lower bound. + type: number + format: double + exclusiveMinimum: + description: Exclusive lower bound. + type: number + format: double + maximum: + description: Inclusive upper bound. + type: number + format: double + exclusiveMaximum: + description: Exclusive upper bound. + type: number + format: double + GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec: + id: GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec description: >- - Specified which products may be included in results. Uses same filter as - boost. + Specification to determine under which conditions query expansion should + occur. type: object properties: - filter: + condition: description: >- - Required. A filter to apply on the matching condition results. - Required Syntax documentation: - https://cloud.google.com/retail/docs/filter-and-order Maximum length - is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. + The condition under which query expansion should occur. Default to + Condition.DISABLED. type: string - dataStore: + enumDescriptions: + - >- + Unspecified query expansion condition. In this case, server + behavior defaults to Condition.DISABLED. + - >- + Disabled query expansion. Only the exact search query is used, + even if SearchResponse.total_size is zero. + - Automatic query expansion built by the Search API. + enum: + - CONDITION_UNSPECIFIED + - DISABLED + - AUTO + pinUnexpandedResults: description: >- - Required. Specifies which data store's documents can be filtered by - this control. Full data store name e.g. - projects/123/locations/global/collections/default_collection/dataStores/default_data_store - type: string - GoogleCloudDiscoveryengineV1ControlRedirectAction: - id: GoogleCloudDiscoveryengineV1ControlRedirectAction - description: Redirects a shopper to the provided URI. + Whether to pin unexpanded results. If this field is set to true, + unexpanded products are always at the top of the search results, + followed by the expanded results. + type: boolean + GoogleCloudDiscoveryengineV1SearchRequestSpellCorrectionSpec: + id: GoogleCloudDiscoveryengineV1SearchRequestSpellCorrectionSpec + description: The specification for query spell correction. type: object properties: - redirectUri: + mode: description: >- - Required. The URI to which the shopper will be redirected. Required. - URI must have length equal or less than 2000 characters. Otherwise - an INVALID ARGUMENT error is thrown. + The mode under which spell correction replaces the original search + query. Defaults to Mode.AUTO. type: string - GoogleCloudDiscoveryengineV1ControlSynonymsAction: - id: GoogleCloudDiscoveryengineV1ControlSynonymsAction - description: >- - Creates a set of terms that will act as synonyms of one another. - Example: "happy" will also be considered as "glad", "glad" will also be - considered as "happy". + enumDescriptions: + - >- + Unspecified spell correction mode. In this case, server behavior + defaults to Mode.AUTO. + - >- + Search API tries to find a spelling suggestion. If a suggestion is + found, it is put in the SearchResponse.corrected_query. The + spelling suggestion won't be used as the search query. + - >- + Automatic spell correction built by the Search API. Search will be + based on the corrected query if found. + enum: + - MODE_UNSPECIFIED + - SUGGESTION_ONLY + - AUTO + GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec: + id: GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec + description: A specification for configuring the behavior of content search. type: object properties: - synonyms: + snippetSpec: description: >- - Defines a set of synonyms. Can specify up to 100 synonyms. Must - specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is - thrown. - type: array - items: - type: string - GoogleCloudDiscoveryengineV1Condition: - id: GoogleCloudDiscoveryengineV1Condition - description: Defines circumstances to be checked before allowing a behavior - type: object - properties: - queryTerms: + If `snippetSpec` is not specified, snippets are not included in the + search response. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec + summarySpec: description: >- - Search only A list of terms to match the query on. Cannot be set - when Condition.query_regex is set. Maximum of 10 query terms. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ConditionQueryTerm - activeTimeRange: + If `summarySpec` is not specified, summaries are not included in the + search response. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec + extractiveContentSpec: description: >- - Range of time(s) specifying when condition is active. Maximum of 10 - time ranges. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ConditionTimeRange - queryRegex: + If there is no extractive_content_spec provided, there will be no + extractive answer in the search response. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec + searchResultMode: description: >- - Optional. Query regex to match the whole search query. Cannot be set - when Condition.query_terms is set. This is currently supporting - promotion use case. + Specifies the search result mode. If unspecified, the search result + mode defaults to `DOCUMENTS`. type: string - GoogleCloudDiscoveryengineV1ConditionQueryTerm: - id: GoogleCloudDiscoveryengineV1ConditionQueryTerm - description: Matcher for search request query + enumDescriptions: + - Default value. + - Returns documents in the search result. + - >- + Returns chunks in the search result. Only available if the + DocumentProcessingConfig.chunking_config is specified. + enum: + - SEARCH_RESULT_MODE_UNSPECIFIED + - DOCUMENTS + - CHUNKS + chunkSpec: + description: >- + Specifies the chunk spec to be returned from the search response. + Only available if the + SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecChunkSpec + GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec: + id: GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec + description: A specification for configuring snippets in a search response. type: object properties: - value: + maxSnippetCount: description: >- - The specific query value to match against Must be lowercase, must be - UTF-8. Can have at most 3 space separated terms if full_match is - true. Cannot be an empty string. Maximum length of 5000 characters. - type: string - fullMatch: - description: Whether the search query needs to exactly match the query term. + [DEPRECATED] This field is deprecated. To control snippet return, + use `return_snippet` field. For backwards compatibility, we will + return snippet if max_snippet_count > 0. + deprecated: true + type: integer + format: int32 + referenceOnly: + description: >- + [DEPRECATED] This field is deprecated and will have no affect on the + snippet. + deprecated: true type: boolean - GoogleCloudDiscoveryengineV1ConditionTimeRange: - id: GoogleCloudDiscoveryengineV1ConditionTimeRange - description: Used for time-dependent conditions. - type: object - properties: - startTime: - description: Start of time range. Range is inclusive. - type: string - format: google-datetime - endTime: - description: End of time range. Range is inclusive. Must be in the future. - type: string - format: google-datetime - GoogleCloudDiscoveryengineV1ListControlsResponse: - id: GoogleCloudDiscoveryengineV1ListControlsResponse - description: Response for ListControls method. + returnSnippet: + description: >- + If `true`, then return snippet. If no snippet can be generated, we + return "No snippet is available for this page." A `snippet_status` + with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned. + type: boolean + GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec: + id: GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec + description: A specification for configuring a summary returned in a search response. type: object properties: - controls: - description: All the Controls for a given data store. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' - nextPageToken: - description: Pagination token, if not returned indicates the last page. + summaryResultCount: + description: >- + The number of top results to generate the summary from. If the + number of results returned is less than `summaryResultCount`, the + summary is generated from all of the results. At most 10 results for + documents mode, or 50 for chunks mode, can be used to generate a + summary. The chunks mode is used when + SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS. + type: integer + format: int32 + includeCitations: + description: >- + Specifies whether to include citations in the summary. The default + value is `false`. When this field is set to `true`, summaries + include in-line citation numbers. Example summary including + citations: BigQuery is Google Cloud's fully managed and completely + serverless enterprise data warehouse [1]. BigQuery supports all data + types, works across clouds, and has built-in machine learning and + business intelligence, all within a unified platform [2, 3]. The + citation numbers refer to the returned search results and are + 1-indexed. For example, [1] means that the sentence is attributed to + the first search result. [2, 3] means that the sentence is + attributed to both the second and third search results. + type: boolean + ignoreAdversarialQuery: + description: >- + Specifies whether to filter out adversarial queries. The default + value is `false`. Google employs search-query classification to + detect adversarial queries. No summary is returned if the search + query is classified as an adversarial query. For example, a user + might ask a question regarding negative comments about the company + or submit a query designed to generate unsafe, policy-violating + output. If this field is set to `true`, we skip generating summaries + for adversarial queries and return fallback messages instead. + type: boolean + ignoreNonSummarySeekingQuery: + description: >- + Specifies whether to filter out queries that are not + summary-seeking. The default value is `false`. Google employs + search-query classification to detect summary-seeking queries. No + summary is returned if the search query is classified as a + non-summary seeking query. For example, `why is the sky blue` and + `Who is the best soccer player in the world?` are summary-seeking + queries, but `SFO airport` and `world cup 2026` are not. They are + most likely navigational queries. If this field is set to `true`, we + skip generating summaries for non-summary seeking queries and return + fallback messages instead. + type: boolean + ignoreLowRelevantContent: + description: >- + Specifies whether to filter out queries that have low relevance. The + default value is `false`. If this field is set to `false`, all + search results are used regardless of relevance to generate answers. + If set to `true`, only queries with high relevance search results + will generate answers. + type: boolean + ignoreJailBreakingQuery: + description: >- + Optional. Specifies whether to filter out jail-breaking queries. The + default value is `false`. Google employs search-query classification + to detect jail-breaking queries. No summary is returned if the + search query is classified as a jail-breaking query. A user might + add instructions to the query to change the tone, style, language, + content of the answer, or ask the model to act as a different + entity, e.g. "Reply in the tone of a competing company's CEO". If + this field is set to `true`, we skip generating summaries for + jail-breaking queries and return fallback messages instead. + type: boolean + modelPromptSpec: + description: >- + If specified, the spec will be used to modify the prompt provided to + the LLM. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelPromptSpec + languageCode: + description: >- + Language code for Summary. Use language tags defined by + [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is + an experimental feature. type: string - GoogleCloudDiscoveryengineV1SearchRequest: - id: GoogleCloudDiscoveryengineV1SearchRequest - description: Request message for SearchService.Search method. + modelSpec: + description: >- + If specified, the spec will be used to modify the model + specification provided to the LLM. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelSpec + useSemanticChunks: + description: >- + If true, answer will be generated from most relevant chunks from top + search results. This feature will improve summary quality. Note that + with this feature enabled, not all top search results will be + referenced and included in the reference list, so the citation + source index only points to the search results listed in the + reference list. + type: boolean + GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelPromptSpec: + id: >- + GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelPromptSpec + description: Specification of the prompt to use with the model. type: object properties: - branch: + preamble: description: >- - The branch resource name, such as - `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. - Use `default_branch` as the branch ID or leave this field empty, to - search documents under the default branch. + Text at the beginning of the prompt that instructs the assistant. + Examples are available in the user guide. type: string - query: - description: Raw search query. + GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelSpec: + id: >- + GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelSpec + description: Specification of the model. + type: object + properties: + version: + description: >- + The model version used to generate the summary. Supported values + are: * `stable`: string. Default value when no value is specified. + Uses a generally available, fine-tuned model. For more information, + see [Answer generation model versions and + lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). + * `preview`: string. (Public preview) Uses a preview model. For more + information, see [Answer generation model versions and + lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). type: string - imageQuery: - description: Raw image query. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestImageQuery - pageSize: + GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec: + id: >- + GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec + description: >- + A specification for configuring the extractive content in a search + response. + type: object + properties: + maxExtractiveAnswerCount: description: >- - Maximum number of Documents to return. The maximum allowed value - depends on the data type. Values above the maximum value are coerced - to the maximum value. * Websites with basic indexing: Default `10`, - Maximum `25`. * Websites with advanced indexing: Default `25`, - Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is - negative, an `INVALID_ARGUMENT` is returned. + The maximum number of extractive answers returned in each search + result. An extractive answer is a verbatim answer extracted from the + original document, which provides a precise and contextually + relevant answer to the search query. If the number of matching + answers is less than the `max_extractive_answer_count`, return all + of the answers. Otherwise, return the `max_extractive_answer_count`. + At most five answers are returned for each SearchResult. type: integer format: int32 - pageToken: + maxExtractiveSegmentCount: description: >- - A page token received from a previous SearchService.Search call. - Provide this to retrieve the subsequent page. When paginating, all - other parameters provided to SearchService.Search must match the - call that provided the page token. Otherwise, an `INVALID_ARGUMENT` - error is returned. - type: string - offset: + The max number of extractive segments returned in each search + result. Only applied if the DataStore is set to + DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types + is SOLUTION_TYPE_CHAT. An extractive segment is a text segment + extracted from the original document that is relevant to the search + query, and, in general, more verbose than an extractive answer. The + segment could then be used as input for LLMs to generate summaries + and answers. If the number of matching segments is less than + `max_extractive_segment_count`, return all of the segments. + Otherwise, return the `max_extractive_segment_count`. + type: integer + format: int32 + returnExtractiveSegmentScore: description: >- - A 0-indexed integer that specifies the current offset (that is, - starting result location, amongst the Documents deemed by the API as - relevant) in search results. This field is only considered if - page_token is unset. If this field is negative, an - `INVALID_ARGUMENT` is returned. + Specifies whether to return the confidence score from the extractive + segments in each search result. This feature is available only for + new or allowlisted data stores. To allowlist your data store, + contact your Customer Engineer. The default value is `false`. + type: boolean + numPreviousSegments: + description: >- + Specifies whether to also include the adjacent from each selected + segments. Return at most `num_previous_segments` segments before + each selected segments. type: integer format: int32 - oneBoxPageSize: + numNextSegments: description: >- - The maximum number of results to return for OneBox. This applies to - each OneBox type individually. Default number is 10. + Return at most `num_next_segments` segments after each selected + segments. type: integer format: int32 - dataStoreSpecs: + GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecChunkSpec: + id: GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecChunkSpec + description: >- + Specifies the chunk spec to be returned from the search response. Only + available if the SearchRequest.ContentSearchSpec.search_result_mode is + set to CHUNKS + type: object + properties: + numPreviousChunks: description: >- - Specs defining dataStores to filter on in a search call and - configurations for those dataStores. This is only considered for - engines with multiple dataStores use case. For single dataStore - within an engine, they should use the specs at the top level. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec - filter: + The number of previous chunks to be returned of the current chunk. + The maximum allowed value is 3. If not specified, no previous chunks + will be returned. + type: integer + format: int32 + numNextChunks: description: >- - The filter syntax consists of an expression language for - constructing a predicate from one or more fields of the documents - being filtered. Filter expression is case-sensitive. If this field - is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in - Vertex AI Search is done by mapping the LHS filter key to a key - property defined in the Vertex AI Search backend -- this mapping is - defined by the customer in their schema. For example a media - customer might have a field 'name' in their schema. In this case the - filter would look like this: filter --> name:'ANY("king kong")' For - more information about filtering including syntax and filter - operators, see - [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) - type: string - canonicalFilter: + The number of next chunks to be returned of the current chunk. The + maximum allowed value is 3. If not specified, no next chunks will be + returned. + type: integer + format: int32 + GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec: + id: GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec + description: Specification for search as you type in search requests. + type: object + properties: + condition: description: >- - The default filter that is applied when a user performs a search - without checking any filters on the search page. The filter applied - to every search request when quality improvement such as query - expansion is needed. In the case a query does not have a sufficient - amount of results this filter will be used to determine whether or - not to enable the query expansion flow. The original filter will - still be used for the query expanded search. This field is strongly - recommended to achieve high search quality. For more information - about filter syntax, see SearchRequest.filter. + The condition under which search as you type should occur. Default + to Condition.DISABLED. type: string - orderBy: - description: >- - The order in which documents are returned. Documents can be ordered - by a field in an Document object. Leave it unset if ordered by - relevance. `order_by` expression is case-sensitive. For more - information on ordering the website search results, see [Order web - search - results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). - For more information on ordering the healthcare search results, see - [Order healthcare search - results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). - If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. + enumDescriptions: + - Server behavior defaults to Condition.DISABLED. + - Disables Search As You Type. + - Enables Search As You Type. + - >- + Automatic switching between search-as-you-type and standard search + modes, ideal for single-API implementations (e.g., debouncing). + enum: + - CONDITION_UNSPECIFIED + - DISABLED + - ENABLED + - AUTO + GoogleCloudDiscoveryengineV1SearchRequestDisplaySpec: + id: GoogleCloudDiscoveryengineV1SearchRequestDisplaySpec + description: Specifies features for display, like match highlighting. + type: object + properties: + matchHighlightingCondition: + description: The condition under which match highlighting should occur. type: string - userInfo: - description: >- - Information about the end user. Highly recommended for analytics. - UserInfo.user_agent is used to deduce `device_type` for analytics. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1UserInfo' - languageCode: + enumDescriptions: + - Server behavior is the same as `MATCH_HIGHLIGHTING_DISABLED`. + - Disables match highlighting on all documents. + - Enables match highlighting on all documents. + enum: + - MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED + - MATCH_HIGHLIGHTING_DISABLED + - MATCH_HIGHLIGHTING_ENABLED + GoogleCloudDiscoveryengineV1SearchRequestSessionSpec: + id: GoogleCloudDiscoveryengineV1SearchRequestSessionSpec + description: >- + Session specification. Multi-turn Search feature is currently at private + GA stage. Please use v1alpha or v1beta version instead before we launch + this feature to public GA. Or ask for allowlisting through Google + Support team. + type: object + properties: + queryId: description: >- - The BCP-47 language code, such as "en-US" or "sr-Latn". For more - information, see [Standard - fields](https://cloud.google.com/apis/design/standard_fields). This - field helps to better interpret the query. If a value isn't - specified, the query language code is automatically detected, which - may not be accurate. + If set, the search result gets stored to the "turn" specified by + this query ID. Example: Let's say the session looks like this: + session { name: ".../sessions/xxx" turns { query { text: "What is + foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { + query { text: "How about bar then?" query_id: ".../questions/zzz" } + } } The user can call /search API with a request like this: session: + ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } + Then, the API stores the search result, associated with the last + turn. The stored search result can be used by a subsequent /answer + API call (with the session ID and the query ID specified). Also, it + is possible to call /search and /answer in parallel with the same + session ID & query ID. type: string - facetSpecs: + searchResultPersistenceCount: description: >- - Facet specifications for faceted search. If empty, no facets are - returned. A maximum of 100 values are allowed. Otherwise, an - `INVALID_ARGUMENT` error is returned. + The number of top search results to persist. The persisted search + results can be used for the subsequent /answer api call. This field + is similar to the `summary_result_count` field in + SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At + most 10 results for documents mode, or 50 for chunks mode. + type: integer + format: int32 + GoogleCloudDiscoveryengineV1SearchRequestRelevanceScoreSpec: + id: GoogleCloudDiscoveryengineV1SearchRequestRelevanceScoreSpec + description: The specification for returning the document relevance score. + type: object + properties: + returnRelevanceScore: + description: >- + Optional. Whether to return the relevance score for search results. + The higher the score, the more relevant the document is to the + query. + type: boolean + GoogleCloudDiscoveryengineV1SearchResponse: + id: GoogleCloudDiscoveryengineV1SearchResponse + description: Response message for SearchService.Search method. + type: object + properties: + results: + description: A list of matched documents. The order represents the ranking. type: array items: $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestFacetSpec - boostSpec: - description: >- - Boost specification to boost certain documents. For more information - on boosting, see - [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestBoostSpec - params: - description: >- - Additional search parameters. For public website search only, - supported values are: * `user_country_code`: string. Default empty. - If set to non-empty, results are restricted or boosted based on the - location provided. For example, `user_country_code: "au"` For - available codes see [Country - Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) - * `search_type`: double. Default empty. Enables non-webpage - searching depending on the value. The only valid non-default value - is 1, which enables image searching. For example, `search_type: 1` - type: object - additionalProperties: - type: any - queryExpansionSpec: + #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponseSearchResult + facets: + description: Results of facets requested by user. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponseFacet + totalSize: description: >- - The query expansion specification that specifies the conditions - under which query expansion occurs. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec - spellCorrectionSpec: + The estimated total count of matched items irrespective of + pagination. The count of results returned by pagination may be less + than the total_size that matches. + type: integer + format: int32 + attributionToken: description: >- - The spell correction specification that specifies the mode under - which spell correction takes effect. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestSpellCorrectionSpec - userPseudoId: + A unique search token. This should be included in the UserEvent logs + resulting from this search, which enables accurate attribution of + search model performance. This also helps to identify a request + during the customer support scenarios. + type: string + redirectUri: description: >- - A unique identifier for tracking visitors. For example, this could - be implemented with an HTTP cookie, which should be able to uniquely - identify a visitor on a single device. This unique identifier should - not change if the visitor logs in or out of the website. This field - should NOT have a fixed value such as `unknown_visitor`. This should - be the same identifier as UserEvent.user_pseudo_id and - CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 - encoded string with a length limit of 128 characters. Otherwise, an - `INVALID_ARGUMENT` error is returned. + The URI of a customer-defined redirect page. If redirect action is + triggered, no search is performed, and only redirect_uri and + attribution_token are set in the response. type: string - contentSearchSpec: - description: A specification for configuring the behavior of content search. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec - safeSearch: + nextPageToken: description: >- - Whether to turn on safe search. This is only supported for website - search. - type: boolean - userLabels: + A token that can be sent as SearchRequest.page_token to retrieve the + next page. If this field is omitted, there are no subsequent pages. + type: string + correctedQuery: description: >- - The user labels applied to a resource must meet the following - requirements: * Each resource can have multiple labels, up to a - maximum of 64. * Each label must be a key-value pair. * Keys have a - minimum length of 1 character and a maximum length of 63 characters - and cannot be empty. Values can be empty and have a maximum length - of 63 characters. * Keys and values can contain only lowercase - letters, numeric characters, underscores, and dashes. All characters - must use UTF-8 encoding, and international characters are allowed. * - The key portion of a label must be unique. However, you can use the - same key with multiple resources. * Keys must start with a lowercase - letter or international character. See [Google Cloud - Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) - for more details. - type: object - additionalProperties: - type: string - searchAsYouTypeSpec: + Contains the spell corrected query, if found. If the spell + correction type is AUTOMATIC, then the search results are based on + corrected_query. Otherwise the original query is used for search. + type: string + summary: description: >- - Search as you type configuration. Only supported for the - IndustryVertical.MEDIA vertical. + A summary as part of the search results. This field is only returned + if SearchRequest.ContentSearchSpec.summary_spec is set. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec - session: + #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponseSummary + queryExpansionInfo: + description: Query expansion information for the returned results. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponseQueryExpansionInfo + sessionInfo: description: >- - The session resource name. Optional. Session allows users to do - multi-turn /search API calls or coordination between /search API - calls and /answer API calls. Example #1 (multi-turn /search API - calls): 1. Call /search API with the auto-session mode (see below). - 2. Call /search API with the session ID generated in the first call. - Here, the previous search query gets considered in query standing. - I.e., if the first query is "How did Alphabet do in 2022?" and the - current query is "How about 2023?", the current query will be - interpreted as "How did Alphabet do in 2023?". Example #2 - (coordination between /search API calls and /answer API calls): 1. - Call /search API with the auto-session mode (see below). 2. Call - /answer API with the session ID generated in the first call. Here, - the answer generation happens in the context of the search results - from the first search call. Auto-session mode: when - `projects/.../sessions/-` is used, a new session gets automatically - created. Otherwise, users can use the create-session API to create a - session manually. Multi-turn Search feature is currently at private - GA stage. Please use v1alpha or v1beta version instead before we - launch this feature to public GA. Or ask for allowlisting through - Google Support team. - type: string - sessionSpec: - description: Session specification. Can be used only when `session` is set. + Session information. Only set if SearchRequest.session is provided. + See its description for more details. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestSessionSpec - GoogleCloudDiscoveryengineV1SearchRequestImageQuery: - id: GoogleCloudDiscoveryengineV1SearchRequestImageQuery - description: Specifies the image query input. + #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponseSessionInfo + searchLinkPromotions: + description: Promotions for site search. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SearchLinkPromotion + GoogleCloudDiscoveryengineV1SearchResponseSearchResult: + id: GoogleCloudDiscoveryengineV1SearchResponseSearchResult + description: Represents the search results. type: object properties: - imageBytes: - description: >- - Base64 encoded image bytes. Supported image formats: JPEG, PNG, and - BMP. + id: + description: Document.id of the searched Document. type: string - GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec: - id: GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec - description: >- - A struct to define data stores to filter on in a search call and - configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` - error is returned. - type: object - properties: - dataStore: + document: description: >- - Required. Full resource name of DataStore, such as - `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. - type: string - filter: + The document data snippet in the search response. Only fields that + are marked as `retrievable` are populated. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' + chunk: description: >- - Optional. Filter specification to filter documents in the data store - specified by data_store field. For more information on filtering, - see - [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) - type: string - GoogleCloudDiscoveryengineV1UserInfo: - id: GoogleCloudDiscoveryengineV1UserInfo - description: Information of an end user. + The chunk data in the search response if the + SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Chunk' + modelScores: + description: Output only. Google provided available scores. + readOnly: true + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1DoubleList' + rankSignals: + description: Optional. A set of ranking signals associated with the result. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals + GoogleCloudDiscoveryengineV1Document: + id: GoogleCloudDiscoveryengineV1Document + description: >- + Document captures all raw metadata information of items to be + recommended or searched. type: object properties: - userId: + structData: description: >- - Highly recommended for logged-in users. Unique identifier for - logged-in user, such as a user name. Don't set for anonymous users. - Always use a hashed value for this ID. Don't set the field to the - same fixed ID for different users. This mixes the event history of - those users together, which results in degraded model quality. The - field must be a UTF-8 encoded string with a length limit of 128 - characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + The structured JSON data for the document. It should conform to the + registered Schema or an `INVALID_ARGUMENT` error is thrown. + type: object + additionalProperties: + type: any + description: Properties of the object. + jsonData: + description: >- + The JSON string representation of the document. It should conform to + the registered Schema or an `INVALID_ARGUMENT` error is thrown. type: string - userAgent: + name: description: >- - User agent as included in the HTTP header. The field must be a UTF-8 - encoded string with a length limit of 1,000 characters. Otherwise, - an `INVALID_ARGUMENT` error is returned. This should not be set when - using the client side event reporting with GTM or JavaScript tag in - UserEventService.CollectUserEvent or if - UserEvent.direct_user_request is set. + Immutable. The full resource name of the document. Format: + `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. + This field must be a UTF-8 encoded string with a length limit of + 1024 characters. type: string - GoogleCloudDiscoveryengineV1SearchRequestFacetSpec: - id: GoogleCloudDiscoveryengineV1SearchRequestFacetSpec - description: A facet specification to perform faceted search. - type: object - properties: - facetKey: - description: Required. The facet key specification. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestFacetSpecFacetKey - limit: + id: description: >- - Maximum facet values that are returned for this facet. If - unspecified, defaults to 20. The maximum allowed value is 300. - Values above 300 are coerced to 300. For aggregation in healthcare - search, when the [FacetKey.key] is "healthcare_aggregation_key", the - limit will be overridden to 10,000 internally, regardless of the - value set here. If this field is negative, an `INVALID_ARGUMENT` is - returned. - type: integer - format: int32 - excludedFilterKeys: + Immutable. The identifier of the document. Id should conform to + [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a + length limit of 128 characters. + type: string + schemaId: + description: The identifier of the schema located in the same data store. + type: string + content: description: >- - List of keys to exclude when faceting. By default, FacetKey.key is - not excluded from the filter unless it is listed in this field. - Listing a facet key in this field allows its values to appear as - facet results, even when they are filtered out of search results. - Using this field does not affect what search results are returned. - For example, suppose there are 100 documents with the color facet - "Red" and 200 documents with the color facet "Blue". A query - containing the filter "color:ANY("Red")" and having "color" as - FacetKey.key would by default return only "Red" documents in the - search results, and also return "Red" with count 100 as the only - color facet. Although there are also blue documents available, - "Blue" would not be shown as an available facet value. If "color" is - listed in "excludedFilterKeys", then the query returns the facet - values "Red" with count 100 and "Blue" with count 200, because the - "color" key is now excluded from the filter. Because this field - doesn't affect search results, the search results are still - correctly filtered to return only "Red" documents. A maximum of 100 - values are allowed. Otherwise, an `INVALID_ARGUMENT` error is - returned. - type: array - items: - type: string - enableDynamicPosition: + The unstructured data linked to this document. Content can only be + set and must be set if this document is under a `CONTENT_REQUIRED` + data store. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1DocumentContent' + parentDocumentId: description: >- - Enables dynamic position for this facet. If set to true, the - position of this facet among all facets in the response is - determined automatically. If dynamic facets are enabled, it is - ordered together. If set to false, the position of this facet in the - response is the same as in the request, and it is ranked before the - facets with dynamic position enable and all dynamic facets. For - example, you may always want to have rating facet returned in the - response, but it's not necessarily to always display the rating - facet at the top. In that case, you can set enable_dynamic_position - to true so that the position of rating facet in response is - determined automatically. Another example, assuming you have the - following facets in the request: * "rating", enable_dynamic_position - = true * "price", enable_dynamic_position = false * "brands", - enable_dynamic_position = false And also you have a dynamic facets - enabled, which generates a facet `gender`. Then the final order of - the facets in the response can be ("price", "brands", "rating", - "gender") or ("price", "brands", "gender", "rating") depends on how - API orders "gender" and "rating" facets. However, notice that - "price" and "brands" are always ranked at first and second position - because their enable_dynamic_position is false. - type: boolean - GoogleCloudDiscoveryengineV1SearchRequestFacetSpecFacetKey: - id: GoogleCloudDiscoveryengineV1SearchRequestFacetSpecFacetKey - description: Specifies how a facet is computed. + The identifier of the parent document. Currently supports at most + two level document hierarchy. Id should conform to + [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a + length limit of 63 characters. + type: string + derivedStructData: + description: >- + Output only. This field is OUTPUT_ONLY. It contains derived data + that are not in the original input document. + readOnly: true + type: object + additionalProperties: + type: any + description: Properties of the object. + aclInfo: + description: Access control information for the document. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1DocumentAclInfo' + indexTime: + description: >- + Output only. The last time the document was indexed. If this field + is set, the document could be returned in search results. This field + is OUTPUT_ONLY. If this field is not populated, it means the + document has never been indexed. + readOnly: true + type: string + format: google-datetime + indexStatus: + description: >- + Output only. The index status of the document. * If document is + indexed successfully, the index_time field is populated. * + Otherwise, if document is not indexed due to errors, the + error_samples field is populated. * Otherwise, if document's index + is in progress, the pending_message field is populated. + readOnly: true + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1DocumentIndexStatus' + GoogleCloudDiscoveryengineV1DocumentContent: + id: GoogleCloudDiscoveryengineV1DocumentContent + description: Unstructured data linked to this document. type: object properties: - key: + rawBytes: description: >- - Required. Supported textual and numerical facet keys in Document - object, over which the facet values are computed. Facet key is - case-sensitive. + The content represented as a stream of bytes. The maximum length is + 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` + fields, this field is represented as pure binary in Protocol Buffers + and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` + should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See + https://developers.google.com/protocol-buffers/docs/proto3#json. type: string - intervals: + format: byte + uri: description: >- - Set only if values should be bucketed into intervals. Must be set - for facets with numerical values. Must not be set for facet with - text values. Maximum number of intervals is 30. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Interval' - restrictedValues: + The URI of the content. Only Cloud Storage URIs (e.g. + `gs://bucket-name/path/to/file`) are supported. The maximum file + size is 2.5 MB for text-based formats, 200 MB for other formats. + type: string + mimeType: description: >- - Only get facet for the given restricted values. Only supported on - textual fields. For example, suppose "category" has three values - "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set - "restricted_values" to "Action > 2022", the "category" facet only - contains "Action > 2022". Only supported on textual fields. Maximum - is 10. + The MIME type of the content. Supported types: * `application/pdf` + (PDF, only native PDFs are supported for now) * `text/html` (HTML) * + `text/plain` (TXT) * `application/xml` or `text/xml` (XML) * + `application/json` (JSON) * + `application/vnd.openxmlformats-officedocument.wordprocessingml.document` + (DOCX) * + `application/vnd.openxmlformats-officedocument.presentationml.presentation` + (PPTX) * + `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` + (XLSX) * `application/vnd.ms-excel.sheet.macroenabled.12` (XLSM) The + following types are supported only if layout parser is enabled in + the data store: * `image/bmp` (BMP) * `image/gif` (GIF) * + `image/jpeg` (JPEG) * `image/png` (PNG) * `image/tiff` (TIFF) See + https://www.iana.org/assignments/media-types/media-types.xhtml. + type: string + GoogleCloudDiscoveryengineV1DocumentAclInfo: + id: GoogleCloudDiscoveryengineV1DocumentAclInfo + description: ACL Information of the Document. + type: object + properties: + readers: + description: Readers of the document. type: array items: - type: string - prefixes: - description: >- - Only get facet values that start with the given string prefix. For - example, suppose "category" has three values "Action > 2022", - "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", - the "category" facet only contains "Action > 2022" and "Action > - 2021". Only supported on textual fields. Maximum is 10. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1DocumentAclInfoAccessRestriction + GoogleCloudDiscoveryengineV1DocumentAclInfoAccessRestriction: + id: GoogleCloudDiscoveryengineV1DocumentAclInfoAccessRestriction + description: >- + AclRestriction to model complex inheritance restrictions. Example: + Modeling a "Both Permit" inheritance, where to access a child document, + user needs to have access to parent document. Document Hierarchy - + Space_S --> Page_P. Readers: Space_S: group_1, user_1 Page_P: group_2, + group_3, user_2 Space_S ACL Restriction - { "acl_info": { "readers": [ { + "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ] } ] + } } Page_P ACL Restriction. { "acl_info": { "readers": [ { "principals": + [ { "group_id": "group_2" }, { "group_id": "group_3" }, { "user_id": + "user_2" } ], }, { "principals": [ { "group_id": "group_1" }, { + "user_id": "user_1" } ], } ] } } + type: object + properties: + principals: + description: List of principals. type: array items: - type: string - contains: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Principal' + idpWide: + description: All users within the Identity Provider. + type: boolean + GoogleCloudDiscoveryengineV1Principal: + id: GoogleCloudDiscoveryengineV1Principal + description: Principal identifier of a user or a group. + type: object + properties: + userId: description: >- - Only get facet values that contain the given strings. For example, - suppose "category" has three values "Action > 2022", "Action > 2021" - and "Sci-Fi > 2022". If set "contains" to "2022", the "category" - facet only contains "Action > 2022" and "Sci-Fi > 2022". Only - supported on textual fields. Maximum is 10. - type: array - items: - type: string - caseInsensitive: + User identifier. For Google Workspace user account, user_id should + be the google workspace user email. For non-google identity provider + user account, user_id is the mapped user identifier configured + during the workforcepool config. + type: string + groupId: description: >- - True to make facet keys case insensitive when getting faceting - values with prefixes or contains; false otherwise. - type: boolean - orderBy: + Group identifier. For Google Workspace user account, group_id should + be the google workspace group email. For non-google identity + provider user account, group_id is the mapped group identifier + configured during the workforcepool config. + type: string + externalEntityId: description: >- - The order in which documents are returned. Allowed values are: * - "count desc", which means order by SearchResponse.Facet.values.count - descending. * "value desc", which means order by - SearchResponse.Facet.values.value descending. Only applies to - textual facets. If not set, textual values are sorted in [natural - order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical - intervals are sorted in the order given by - FacetSpec.FacetKey.intervals. + For 3P application identities which are not present in the customer + identity provider. type: string - GoogleCloudDiscoveryengineV1Interval: - id: GoogleCloudDiscoveryengineV1Interval - description: A floating point interval. + GoogleCloudDiscoveryengineV1DocumentIndexStatus: + id: GoogleCloudDiscoveryengineV1DocumentIndexStatus + description: Index status of the document. type: object properties: - minimum: - description: Inclusive lower bound. - type: number - format: double - exclusiveMinimum: - description: Exclusive lower bound. - type: number - format: double - maximum: - description: Inclusive upper bound. - type: number - format: double - exclusiveMaximum: - description: Exclusive upper bound. - type: number - format: double - GoogleCloudDiscoveryengineV1SearchRequestBoostSpec: - id: GoogleCloudDiscoveryengineV1SearchRequestBoostSpec - description: Boost specification to boost certain documents. - type: object - properties: - conditionBoostSpecs: + indexTime: description: >- - Condition boost specifications. If a document matches multiple - conditions in the specifictions, boost scores from these - specifications are all applied and combined in a non-linear way. - Maximum number of specifications is 20. + The time when the document was indexed. If this field is populated, + it means the document has been indexed. + type: string + format: google-datetime + errorSamples: + description: >- + A sample of errors encountered while indexing the document. If this + field is populated, the document is not indexed due to errors. type: array items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpec - GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpec: - id: GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpec - description: Boost applies to documents which match a condition. + $ref: '#/components/schemas/GoogleRpcStatus' + pendingMessage: + description: >- + Immutable. The message indicates the document index is in progress. + If this field is populated, the document index is pending. + type: string + GoogleCloudDiscoveryengineV1Chunk: + id: GoogleCloudDiscoveryengineV1Chunk + description: >- + Chunk captures all raw metadata information of items to be recommended + or searched in the chunk mode. type: object properties: - condition: + name: description: >- - An expression which specifies a boost condition. The syntax and - supported fields are the same as a filter expression. See - SearchRequest.filter for detail syntax and limitations. Examples: * - To boost documents with document ID "doc_1" or "doc_2", and color - "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: - ANY("Red", "Blue"))` + The full resource name of the chunk. Format: + `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`. + This field must be a UTF-8 encoded string with a length limit of + 1024 characters. type: string - boost: + id: + description: Unique chunk ID of the current chunk. + type: string + content: + description: Content is a string from a document (parsed content). + type: string + relevanceScore: description: >- - Strength of the condition boost, which should be in [-1, 1]. - Negative boost means demotion. Default is 0.0. Setting to 1.0 gives - the document a big promotion. However, it does not necessarily mean - that the boosted document will be the top result at all times, nor - that other documents will be excluded. Results could still be shown - even when none of them matches the condition. And results that are - significantly more relevant to the search query can still trump your - heavily favored but irrelevant documents. Setting to -1.0 gives the - document a big demotion. However, results that are deeply relevant - might still be shown. The document will have an upstream battle to - get a fairly high ranking, but it is not blocked out completely. - Setting to 0.0 means no boost applied. The boosting condition is - ignored. Only one of the (condition, boost) combination or the - boost_control_spec below are set. If both are set then the global - boost is ignored and the more fine-grained boost_control_spec is - applied. + Output only. Represents the relevance score based on similarity. + Higher score indicates higher chunk relevance. The score is in range + [-1.0, 1.0]. Only populated on SearchResponse. + readOnly: true type: number - format: float - boostControlSpec: - description: >- - Complex specification for custom ranking based on customer defined - attribute value. + format: double + documentMetadata: + description: Metadata of the document from the current chunk. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpec - GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpec: - id: >- - GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpec - description: >- - Specification for custom ranking based on customer specified attribute - value. It provides more controls for customized ranking than the simple - (condition, boost) combination above. - type: object - properties: - fieldName: + #/components/schemas/GoogleCloudDiscoveryengineV1ChunkDocumentMetadata + derivedStructData: description: >- - The name of the field whose value will be used to determine the - boost amount. - type: string - attributeType: + Output only. This field is OUTPUT_ONLY. It contains derived data + that are not in the original input document. + readOnly: true + type: object + additionalProperties: + type: any + description: Properties of the object. + pageSpan: + description: Page span of the chunk. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1ChunkPageSpan' + chunkMetadata: + description: Output only. Metadata of the current chunk. + readOnly: true + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1ChunkChunkMetadata' + dataUrls: description: >- - The attribute type to be used to determine the boost amount. The - attribute value can be derived from the field value of the specified - field_name. In the case of numerical it is straightforward i.e. - attribute_value = numerical_field_value. In the case of freshness - however, attribute_value = (time.now() - datetime_field_value). - type: string - enumDescriptions: - - Unspecified AttributeType. - - >- - The value of the numerical field will be used to dynamically - update the boost amount. In this case, the attribute_value (the x - value) of the control point will be the actual value of the - numerical field for which the boost_amount is specified. - - >- - For the freshness use case the attribute value will be the - duration between the current time and the date in the datetime - field specified. The value must be formatted as an XSD - `dayTimeDuration` value (a restricted subset of an ISO 8601 - duration value). The pattern for this is: `nDnM]`. For example, - `5D`, `3DT12H30M`, `T24H`. - enum: - - ATTRIBUTE_TYPE_UNSPECIFIED - - NUMERICAL - - FRESHNESS - interpolationType: + Output only. Image Data URLs if the current chunk contains images. + Data URLs are composed of four parts: a prefix (data:), a MIME type + indicating the type of data, an optional base64 token if + non-textual, and the data itself: data:, + readOnly: true + type: array + items: + type: string + annotationContents: description: >- - The interpolation type to be applied to connect the control points - listed below. - type: string - enumDescriptions: - - >- - Interpolation type is unspecified. In this case, it defaults to - Linear. - - Piecewise linear interpolation will be applied. - enum: - - INTERPOLATION_TYPE_UNSPECIFIED - - LINEAR - controlPoints: + Output only. Annotation contents if the current chunk contains + annotations. + readOnly: true + type: array + items: + type: string + annotationMetadata: description: >- - The control points used to define the curve. The monotonic function - (defined through the interpolation_type above) passes through the - control points listed here. + Output only. The annotation metadata includes structured content in + the current chunk. + readOnly: true type: array items: $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint - GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint: - id: >- - GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint + #/components/schemas/GoogleCloudDiscoveryengineV1ChunkAnnotationMetadata + GoogleCloudDiscoveryengineV1ChunkDocumentMetadata: + id: GoogleCloudDiscoveryengineV1ChunkDocumentMetadata description: >- - The control points used to define the curve. The curve defined through - these control points can only be monotonically increasing or - decreasing(constant values are acceptable). + Document metadata contains the information of the document of the + current chunk. type: object properties: - attributeValue: + uri: + description: Uri of the document. + type: string + title: + description: Title of the document. + type: string + mimeType: description: >- - Can be one of: 1. The numerical field value. 2. The duration spec - for freshness: The value must be formatted as an XSD - `dayTimeDuration` value (a restricted subset of an ISO 8601 duration - value). The pattern for this is: `nDnM]`. + The mime type of the document. + https://www.iana.org/assignments/media-types/media-types.xhtml. type: string - boostAmount: + structData: description: >- - The value between -1 to 1 by which to boost the score if the - attribute_value evaluates to the value specified above. - type: number - format: float - GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec: - id: GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec + Data representation. The structured JSON data for the document. It + should conform to the registered Schema or an `INVALID_ARGUMENT` + error is thrown. + type: object + additionalProperties: + type: any + description: Properties of the object. + GoogleCloudDiscoveryengineV1ChunkPageSpan: + id: GoogleCloudDiscoveryengineV1ChunkPageSpan + description: Page span of the chunk. + type: object + properties: + pageStart: + description: The start page of the chunk. + type: integer + format: int32 + pageEnd: + description: The end page of the chunk. + type: integer + format: int32 + GoogleCloudDiscoveryengineV1ChunkChunkMetadata: + id: GoogleCloudDiscoveryengineV1ChunkChunkMetadata description: >- - Specification to determine under which conditions query expansion should - occur. + Metadata of the current chunk. This field is only populated on + SearchService.Search API. type: object properties: - condition: + previousChunks: description: >- - The condition under which query expansion should occur. Default to - Condition.DISABLED. - type: string - enumDescriptions: - - >- - Unspecified query expansion condition. In this case, server - behavior defaults to Condition.DISABLED. - - >- - Disabled query expansion. Only the exact search query is used, - even if SearchResponse.total_size is zero. - - Automatic query expansion built by the Search API. - enum: - - CONDITION_UNSPECIFIED - - DISABLED - - AUTO - pinUnexpandedResults: + The previous chunks of the current chunk. The number is controlled + by SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks. + This field is only populated on SearchService.Search API. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Chunk' + nextChunks: description: >- - Whether to pin unexpanded results. If this field is set to true, - unexpanded products are always at the top of the search results, - followed by the expanded results. - type: boolean - GoogleCloudDiscoveryengineV1SearchRequestSpellCorrectionSpec: - id: GoogleCloudDiscoveryengineV1SearchRequestSpellCorrectionSpec - description: The specification for query spell correction. + The next chunks of the current chunk. The number is controlled by + SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks. This + field is only populated on SearchService.Search API. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Chunk' + GoogleCloudDiscoveryengineV1ChunkAnnotationMetadata: + id: GoogleCloudDiscoveryengineV1ChunkAnnotationMetadata + description: >- + The annotation metadata includes structured content in the current + chunk. type: object properties: - mode: + structuredContent: + description: Output only. The structured content information. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ChunkStructuredContent + imageId: description: >- - The mode under which spell correction replaces the original search - query. Defaults to Mode.AUTO. + Output only. Image id is provided if the structured content is based + on an image. + readOnly: true type: string - enumDescriptions: - - >- - Unspecified spell correction mode. In this case, server behavior - defaults to Mode.AUTO. - - >- - Search API tries to find a spelling suggestion. If a suggestion is - found, it is put in the SearchResponse.corrected_query. The - spelling suggestion won't be used as the search query. - - >- - Automatic spell correction built by the Search API. Search will be - based on the corrected query if found. - enum: - - MODE_UNSPECIFIED - - SUGGESTION_ONLY - - AUTO - GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec: - id: GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec - description: A specification for configuring the behavior of content search. + GoogleCloudDiscoveryengineV1ChunkStructuredContent: + id: GoogleCloudDiscoveryengineV1ChunkStructuredContent + description: The structured content information. type: object properties: - snippetSpec: - description: >- - If `snippetSpec` is not specified, snippets are not included in the - search response. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec - summarySpec: - description: >- - If `summarySpec` is not specified, summaries are not included in the - search response. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec - extractiveContentSpec: - description: >- - If there is no extractive_content_spec provided, there will be no - extractive answer in the search response. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec - searchResultMode: - description: >- - Specifies the search result mode. If unspecified, the search result - mode defaults to `DOCUMENTS`. + structureType: + description: Output only. The structure type of the structured content. + readOnly: true type: string enumDescriptions: - Default value. - - Returns documents in the search result. - - >- - Returns chunks in the search result. Only available if the - DataStore.DocumentProcessingConfig.chunking_config is specified. + - Shareholder structure. + - Signature structure. + - Checkbox structure. enum: - - SEARCH_RESULT_MODE_UNSPECIFIED - - DOCUMENTS - - CHUNKS - chunkSpec: - description: >- - Specifies the chunk spec to be returned from the search response. - Only available if the - SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecChunkSpec - GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec: - id: GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec - description: A specification for configuring snippets in a search response. + - STRUCTURE_TYPE_UNSPECIFIED + - SHAREHOLDER_STRUCTURE + - SIGNATURE_STRUCTURE + - CHECKBOX_STRUCTURE + content: + description: Output only. The content of the structured content. + readOnly: true + type: string + GoogleCloudDiscoveryengineV1DoubleList: + id: GoogleCloudDiscoveryengineV1DoubleList + description: Double list. type: object properties: - maxSnippetCount: - description: >- - [DEPRECATED] This field is deprecated. To control snippet return, - use `return_snippet` field. For backwards compatibility, we will - return snippet if max_snippet_count > 0. - deprecated: true - type: integer - format: int32 - referenceOnly: - description: >- - [DEPRECATED] This field is deprecated and will have no affect on the - snippet. - deprecated: true - type: boolean - returnSnippet: - description: >- - If `true`, then return snippet. If no snippet can be generated, we - return "No snippet is available for this page." A `snippet_status` - with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned. - type: boolean - GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec: - id: GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec - description: A specification for configuring a summary returned in a search response. + values: + description: Double values. + type: array + items: + type: number + format: double + GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals: + id: GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals + description: A set of ranking signals. type: object properties: - summaryResultCount: - description: >- - The number of top results to generate the summary from. If the - number of results returned is less than `summaryResultCount`, the - summary is generated from all of the results. At most 10 results for - documents mode, or 50 for chunks mode, can be used to generate a - summary. The chunks mode is used when - SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS. - type: integer - format: int32 - includeCitations: - description: >- - Specifies whether to include citations in the summary. The default - value is `false`. When this field is set to `true`, summaries - include in-line citation numbers. Example summary including - citations: BigQuery is Google Cloud's fully managed and completely - serverless enterprise data warehouse [1]. BigQuery supports all data - types, works across clouds, and has built-in machine learning and - business intelligence, all within a unified platform [2, 3]. The - citation numbers refer to the returned search results and are - 1-indexed. For example, [1] means that the sentence is attributed to - the first search result. [2, 3] means that the sentence is - attributed to both the second and third search results. - type: boolean - ignoreAdversarialQuery: - description: >- - Specifies whether to filter out adversarial queries. The default - value is `false`. Google employs search-query classification to - detect adversarial queries. No summary is returned if the search - query is classified as an adversarial query. For example, a user - might ask a question regarding negative comments about the company - or submit a query designed to generate unsafe, policy-violating - output. If this field is set to `true`, we skip generating summaries - for adversarial queries and return fallback messages instead. - type: boolean - ignoreNonSummarySeekingQuery: - description: >- - Specifies whether to filter out queries that are not - summary-seeking. The default value is `false`. Google employs - search-query classification to detect summary-seeking queries. No - summary is returned if the search query is classified as a - non-summary seeking query. For example, `why is the sky blue` and - `Who is the best soccer player in the world?` are summary-seeking - queries, but `SFO airport` and `world cup 2026` are not. They are - most likely navigational queries. If this field is set to `true`, we - skip generating summaries for non-summary seeking queries and return - fallback messages instead. - type: boolean - ignoreLowRelevantContent: - description: >- - Specifies whether to filter out queries that have low relevance. The - default value is `false`. If this field is set to `false`, all - search results are used regardless of relevance to generate answers. - If set to `true`, only queries with high relevance search results - will generate answers. - type: boolean - ignoreJailBreakingQuery: - description: >- - Optional. Specifies whether to filter out jail-breaking queries. The - default value is `false`. Google employs search-query classification - to detect jail-breaking queries. No summary is returned if the - search query is classified as a jail-breaking query. A user might - add instructions to the query to change the tone, style, language, - content of the answer, or ask the model to act as a different - entity, e.g. "Reply in the tone of a competing company's CEO". If - this field is set to `true`, we skip generating summaries for - jail-breaking queries and return fallback messages instead. - type: boolean - modelPromptSpec: - description: >- - If specified, the spec will be used to modify the prompt provided to - the LLM. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelPromptSpec - languageCode: - description: >- - Language code for Summary. Use language tags defined by - [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is - an experimental feature. - type: string - modelSpec: - description: >- - If specified, the spec will be used to modify the model - specification provided to the LLM. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelSpec - useSemanticChunks: - description: >- - If true, answer will be generated from most relevant chunks from top - search results. This feature will improve summary quality. Note that - with this feature enabled, not all top search results will be - referenced and included in the reference list, so the citation - source index only points to the search results listed in the - reference list. - type: boolean - GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelPromptSpec: + keywordSimilarityScore: + description: Optional. Keyword matching adjustment. + type: number + format: float + relevanceScore: + description: Optional. Semantic relevance adjustment. + type: number + format: float + semanticSimilarityScore: + description: Optional. Semantic similarity adjustment. + type: number + format: float + pctrRank: + description: Optional. Predicted conversion rate adjustment as a rank. + type: number + format: float + topicalityRank: + description: Optional. Topicality adjustment as a rank. + type: number + format: float + documentAge: + description: Optional. Age of the document in hours. + type: number + format: float + boostingFactor: + description: Optional. Combined custom boosts for a doc. + type: number + format: float + defaultRank: + description: Optional. The default rank of the result. + type: number + format: float + customSignals: + description: Optional. A list of custom clearbox signals. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignalsCustomSignal + GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignalsCustomSignal: id: >- - GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelPromptSpec - description: Specification of the prompt to use with the model. + GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignalsCustomSignal + description: Custom clearbox signal represented by name and value pair. type: object properties: - preamble: - description: >- - Text at the beginning of the prompt that instructs the assistant. - Examples are available in the user guide. + name: + description: Optional. Name of the signal. type: string - GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelSpec: - id: >- - GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelSpec - description: Specification of the model. + value: + description: >- + Optional. Float value representing the ranking signal (e.g. 1.25 for + BM25). + type: number + format: float + GoogleCloudDiscoveryengineV1SearchResponseFacet: + id: GoogleCloudDiscoveryengineV1SearchResponseFacet + description: A facet result. type: object properties: - version: + key: description: >- - The model version used to generate the summary. Supported values - are: * `stable`: string. Default value when no value is specified. - Uses a generally available, fine-tuned model. For more information, - see [Answer generation model versions and - lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). - * `preview`: string. (Public preview) Uses a preview model. For more - information, see [Answer generation model versions and - lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). + The key for this facet. For example, `"colors"` or `"price"`. It + matches SearchRequest.FacetSpec.FacetKey.key. type: string - GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec: - id: >- - GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec - description: >- - A specification for configuring the extractive content in a search - response. - type: object - properties: - maxExtractiveAnswerCount: - description: >- - The maximum number of extractive answers returned in each search - result. An extractive answer is a verbatim answer extracted from the - original document, which provides a precise and contextually - relevant answer to the search query. If the number of matching - answers is less than the `max_extractive_answer_count`, return all - of the answers. Otherwise, return the `max_extractive_answer_count`. - At most five answers are returned for each SearchResult. - type: integer - format: int32 - maxExtractiveSegmentCount: - description: >- - The max number of extractive segments returned in each search - result. Only applied if the DataStore is set to - DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types - is SOLUTION_TYPE_CHAT. An extractive segment is a text segment - extracted from the original document that is relevant to the search - query, and, in general, more verbose than an extractive answer. The - segment could then be used as input for LLMs to generate summaries - and answers. If the number of matching segments is less than - `max_extractive_segment_count`, return all of the segments. - Otherwise, return the `max_extractive_segment_count`. - type: integer - format: int32 - returnExtractiveSegmentScore: - description: >- - Specifies whether to return the confidence score from the extractive - segments in each search result. This feature is available only for - new or allowlisted data stores. To allowlist your data store, - contact your Customer Engineer. The default value is `false`. + values: + description: The facet values for this field. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponseFacetFacetValue + dynamicFacet: + description: Whether the facet is dynamically generated. type: boolean - numPreviousSegments: - description: >- - Specifies whether to also include the adjacent from each selected - segments. Return at most `num_previous_segments` segments before - each selected segments. - type: integer - format: int32 - numNextSegments: - description: >- - Return at most `num_next_segments` segments after each selected - segments. - type: integer - format: int32 - GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecChunkSpec: - id: GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecChunkSpec - description: >- - Specifies the chunk spec to be returned from the search response. Only - available if the SearchRequest.ContentSearchSpec.search_result_mode is - set to CHUNKS + GoogleCloudDiscoveryengineV1SearchResponseFacetFacetValue: + id: GoogleCloudDiscoveryengineV1SearchResponseFacetFacetValue + description: A facet value which contains value names and their count. type: object properties: - numPreviousChunks: - description: >- - The number of previous chunks to be returned of the current chunk. - The maximum allowed value is 3. If not specified, no previous chunks - will be returned. - type: integer - format: int32 - numNextChunks: + value: + description: Text value of a facet, such as "Black" for facet "colors". + type: string + interval: description: >- - The number of next chunks to be returned of the current chunk. The - maximum allowed value is 3. If not specified, no next chunks will be - returned. - type: integer - format: int32 - GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec: - id: GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec - description: Specification for search as you type in search requests. + Interval value for a facet, such as 10, 20) for facet "price". It + matches [SearchRequest.FacetSpec.FacetKey.intervals. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Interval' + count: + description: Number of items that have this facet value. + type: string + format: int64 + GoogleCloudDiscoveryengineV1SearchResponseSummary: + id: GoogleCloudDiscoveryengineV1SearchResponseSummary + description: Summary of the top N search results specified by the summary spec. type: object properties: - condition: - description: >- - The condition under which search as you type should occur. Default - to Condition.DISABLED. + summaryText: + description: The summary content. type: string - enumDescriptions: - - Server behavior defaults to Condition.DISABLED. - - Disables Search As You Type. - - Enables Search As You Type. - enum: - - CONDITION_UNSPECIFIED - - DISABLED - - ENABLED - GoogleCloudDiscoveryengineV1SearchRequestSessionSpec: - id: GoogleCloudDiscoveryengineV1SearchRequestSessionSpec - description: >- - Session specification. Multi-turn Search feature is currently at private - GA stage. Please use v1alpha or v1beta version instead before we launch - this feature to public GA. Or ask for allowlisting through Google - Support team. + summarySkippedReasons: + description: >- + Additional summary-skipped reasons. This provides the reason for + ignored cases. If nothing is skipped, this field is not set. + type: array + items: + type: string + enumDescriptions: + - Default value. The summary skipped reason is not specified. + - >- + The adversarial query ignored case. Only used when + SummarySpec.ignore_adversarial_query is set to `true`. + - >- + The non-summary seeking query ignored case. Google skips the + summary if the query is chit chat. Only used when + SummarySpec.ignore_non_summary_seeking_query is set to `true`. + - >- + The out-of-domain query ignored case. Google skips the summary + if there are no high-relevance search results. For example, the + data store contains facts about company A but the user query is + asking questions about company B. + - >- + The potential policy violation case. Google skips the summary if + there is a potential policy violation detected. This includes + content that may be violent or toxic. + - >- + The LLM addon not enabled case. Google skips the summary if the + LLM addon is not enabled. + - >- + The no relevant content case. Google skips the summary if there + is no relevant content in the retrieved search results. + - >- + The jail-breaking query ignored case. For example, "Reply in the + tone of a competing company's CEO". Only used when + [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] + is set to `true`. + - >- + The customer policy violation case. Google skips the summary if + there is a customer policy violation detected. The policy is + defined by the customer. + - >- + The non-answer seeking query ignored case. Google skips the + summary if the query doesn't have clear intent. Only used when + [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query] + is set to `true`. + - The time out case. Google skips the summary if the time out. + enum: + - SUMMARY_SKIPPED_REASON_UNSPECIFIED + - ADVERSARIAL_QUERY_IGNORED + - NON_SUMMARY_SEEKING_QUERY_IGNORED + - OUT_OF_DOMAIN_QUERY_IGNORED + - POTENTIAL_POLICY_VIOLATION + - LLM_ADDON_NOT_ENABLED + - NO_RELEVANT_CONTENT + - JAIL_BREAKING_QUERY_IGNORED + - CUSTOMER_POLICY_VIOLATION + - NON_SUMMARY_SEEKING_QUERY_IGNORED_V2 + - TIME_OUT + safetyAttributes: + description: >- + A collection of Safety Attribute categories and their associated + confidence scores. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponseSummarySafetyAttributes + summaryWithMetadata: + description: Summary with metadata information. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponseSummarySummaryWithMetadata + GoogleCloudDiscoveryengineV1SearchResponseSummarySafetyAttributes: + id: GoogleCloudDiscoveryengineV1SearchResponseSummarySafetyAttributes + description: Safety Attribute categories and their associated confidence scores. type: object properties: - queryId: + categories: description: >- - If set, the search result gets stored to the "turn" specified by - this query ID. Example: Let's say the session looks like this: - session { name: ".../sessions/xxx" turns { query { text: "What is - foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { - query { text: "How about bar then?" query_id: ".../questions/zzz" } - } } The user can call /search API with a request like this: session: - ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } - Then, the API stores the search result, associated with the last - turn. The stored search result can be used by a subsequent /answer - API call (with the session ID and the query ID specified). Also, it - is possible to call /search and /answer in parallel with the same - session ID & query ID. - type: string - searchResultPersistenceCount: + The display names of Safety Attribute categories associated with the + generated content. Order matches the Scores. + type: array + items: + type: string + scores: description: >- - The number of top search results to persist. The persisted search - results can be used for the subsequent /answer api call. This field - is simliar to the `summary_result_count` field in - SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At - most 10 results for documents mode, or 50 for chunks mode. - type: integer - format: int32 - GoogleCloudDiscoveryengineV1SearchResponse: - id: GoogleCloudDiscoveryengineV1SearchResponse - description: Response message for SearchService.Search method. + The confidence scores of the each category, higher value means + higher confidence. Order matches the Categories. + type: array + items: + type: number + format: float + GoogleCloudDiscoveryengineV1SearchResponseSummarySummaryWithMetadata: + id: GoogleCloudDiscoveryengineV1SearchResponseSummarySummaryWithMetadata + description: Summary with metadata information. type: object properties: - results: - description: A list of matched documents. The order represents the ranking. + summary: + description: Summary text with no citation information. + type: string + citationMetadata: + description: Citation metadata for given summary. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponseSummaryCitationMetadata + references: + description: Document References. type: array items: $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponseSearchResult - facets: - description: Results of facets requested by user. + #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponseSummaryReference + GoogleCloudDiscoveryengineV1SearchResponseSummaryCitationMetadata: + id: GoogleCloudDiscoveryengineV1SearchResponseSummaryCitationMetadata + description: Citation metadata. + type: object + properties: + citations: + description: Citations for segments. type: array items: $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponseFacet - totalSize: - description: >- - The estimated total count of matched items irrespective of - pagination. The count of results returned by pagination may be less - than the total_size that matches. - type: integer - format: int32 - attributionToken: - description: >- - A unique search token. This should be included in the UserEvent logs - resulting from this search, which enables accurate attribution of - search model performance. This also helps to identify a request - during the customer support scenarios. - type: string - redirectUri: - description: >- - The URI of a customer-defined redirect page. If redirect action is - triggered, no search is performed, and only redirect_uri and - attribution_token are set in the response. + #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponseSummaryCitation + GoogleCloudDiscoveryengineV1SearchResponseSummaryCitation: + id: GoogleCloudDiscoveryengineV1SearchResponseSummaryCitation + description: Citation info for a segment. + type: object + properties: + startIndex: + description: Index indicates the start of the segment, measured in bytes/unicode. type: string - nextPageToken: - description: >- - A token that can be sent as SearchRequest.page_token to retrieve the - next page. If this field is omitted, there are no subsequent pages. + format: int64 + endIndex: + description: End of the attributed segment, exclusive. type: string - correctedQuery: + format: int64 + sources: + description: Citation sources for the attributed segment. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponseSummaryCitationSource + GoogleCloudDiscoveryengineV1SearchResponseSummaryCitationSource: + id: GoogleCloudDiscoveryengineV1SearchResponseSummaryCitationSource + description: Citation source. + type: object + properties: + referenceIndex: description: >- - Contains the spell corrected query, if found. If the spell - correction type is AUTOMATIC, then the search results are based on - corrected_query. Otherwise the original query is used for search. + Document reference index from SummaryWithMetadata.references. It is + 0-indexed and the value will be zero if the reference_index is not + set explicitly. type: string - summary: - description: >- - A summary as part of the search results. This field is only returned - if SearchRequest.ContentSearchSpec.summary_spec is set. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponseSummary - queryExpansionInfo: - description: Query expansion information for the returned results. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponseQueryExpansionInfo - sessionInfo: - description: >- - Session information. Only set if SearchRequest.session is provided. - See its description for more details. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponseSessionInfo - GoogleCloudDiscoveryengineV1SearchResponseSearchResult: - id: GoogleCloudDiscoveryengineV1SearchResponseSearchResult - description: Represents the search results. + format: int64 + GoogleCloudDiscoveryengineV1SearchResponseSummaryReference: + id: GoogleCloudDiscoveryengineV1SearchResponseSummaryReference + description: Document reference. type: object properties: - id: - description: Document.id of the searched Document. + title: + description: Title of the document. type: string document: description: >- - The document data snippet in the search response. Only fields that - are marked as `retrievable` are populated. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' - chunk: - description: >- - The chunk data in the search response if the - SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Chunk' - GoogleCloudDiscoveryengineV1Document: - id: GoogleCloudDiscoveryengineV1Document + Required. Document.name of the document. Full resource name of the + referenced document, in the format + `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`. + type: string + uri: + description: Cloud Storage or HTTP uri for the document. + type: string + chunkContents: + description: List of cited chunk contents derived from document content. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponseSummaryReferenceChunkContent + GoogleCloudDiscoveryengineV1SearchResponseSummaryReferenceChunkContent: + id: GoogleCloudDiscoveryengineV1SearchResponseSummaryReferenceChunkContent + description: Chunk content. + type: object + properties: + content: + description: Chunk textual content. + type: string + pageIdentifier: + description: Page identifier. + type: string + GoogleCloudDiscoveryengineV1SearchResponseQueryExpansionInfo: + id: GoogleCloudDiscoveryengineV1SearchResponseQueryExpansionInfo description: >- - Document captures all raw metadata information of items to be - recommended or searched. + Information describing query expansion including whether expansion has + occurred. type: object properties: - structData: - description: >- - The structured JSON data for the document. It should conform to the - registered Schema or an `INVALID_ARGUMENT` error is thrown. - type: object - additionalProperties: - type: any - description: Properties of the object. - jsonData: + expandedQuery: + description: Bool describing whether query expansion has occurred. + type: boolean + pinnedResultCount: description: >- - The JSON string representation of the document. It should conform to - the registered Schema or an `INVALID_ARGUMENT` error is thrown. + Number of pinned results. This field will only be set when expansion + happens and SearchRequest.QueryExpansionSpec.pin_unexpanded_results + is set to true. type: string + format: int64 + GoogleCloudDiscoveryengineV1SearchResponseSessionInfo: + id: GoogleCloudDiscoveryengineV1SearchResponseSessionInfo + description: Information about the session. + type: object + properties: name: description: >- - Immutable. The full resource name of the document. Format: - `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. - This field must be a UTF-8 encoded string with a length limit of - 1024 characters. + Name of the session. If the auto-session mode is used (when + SearchRequest.session ends with "-"), this field holds the newly + generated session name. type: string - id: + queryId: description: >- - Immutable. The identifier of the document. Id should conform to - [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a - length limit of 63 characters. - type: string - schemaId: - description: The identifier of the schema located in the same data store. + Query ID that corresponds to this search API call. One session can + have multiple turns, each with a unique query ID. By specifying the + session name and this query ID in the Answer API call, the answer + generation happens in the context of the search results from this + search call. type: string - content: - description: >- - The unstructured data linked to this document. Content must be set - if this document is under a `CONTENT_REQUIRED` data store. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1DocumentContent' - parentDocumentId: + GoogleCloudDiscoveryengineV1SearchLinkPromotion: + id: GoogleCloudDiscoveryengineV1SearchLinkPromotion + description: >- + Promotion proto includes uri and other helping information to display + the promotion. + type: object + properties: + title: description: >- - The identifier of the parent document. Currently supports at most - two level document hierarchy. Id should conform to - [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a - length limit of 63 characters. + Required. The title of the promotion. Maximum length: 160 + characters. type: string - derivedStructData: + uri: description: >- - Output only. This field is OUTPUT_ONLY. It contains derived data - that are not in the original input document. - readOnly: true - type: object - additionalProperties: - type: any - description: Properties of the object. - indexTime: + Optional. The URL for the page the user wants to promote. Must be + set for site search. For other verticals, this is optional. + type: string + document: description: >- - Output only. The last time the document was indexed. If this field - is set, the document could be returned in search results. This field - is OUTPUT_ONLY. If this field is not populated, it means the - document has never been indexed. - readOnly: true + Optional. The Document the user wants to promote. For site search, + leave unset and only populate uri. Can be set along with uri. type: string - format: google-datetime - indexStatus: + imageUri: + description: Optional. The promotion thumbnail image url. + type: string + description: + description: 'Optional. The Promotion description. Maximum length: 200 characters.' + type: string + enabled: description: >- - Output only. The index status of the document. * If document is - indexed successfully, the index_time field is populated. * - Otherwise, if document is not indexed due to errors, the - error_samples field is populated. * Otherwise, index_status is - unset. - readOnly: true - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1DocumentIndexStatus' - GoogleCloudDiscoveryengineV1DocumentContent: - id: GoogleCloudDiscoveryengineV1DocumentContent - description: Unstructured data linked to this document. + Optional. The enabled promotion will be returned for any serving + configs associated with the parent of the control this promotion is + attached to. This flag is used for basic site search only. + type: boolean + GoogleCloudDiscoveryengineV1StreamAssistRequest: + id: GoogleCloudDiscoveryengineV1StreamAssistRequest + description: Request for the AssistantService.StreamAssist method. type: object properties: - rawBytes: + query: description: >- - The content represented as a stream of bytes. The maximum length is - 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` - fields, this field is represented as pure binary in Protocol Buffers - and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` - should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See - https://developers.google.com/protocol-buffers/docs/proto3#json. - type: string - format: byte - uri: + Optional. Current user query. Empty query is only supported if + `file_ids` are provided. In this case, the answer will be generated + based on those context files. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Query' + session: description: >- - The URI of the content. Only Cloud Storage URIs (e.g. - `gs://bucket-name/path/to/file`) are supported. The maximum file - size is 2.5 MB for text-based formats, 200 MB for other formats. - type: string - mimeType: + Optional. The session to use for the request. If specified, the + assistant has access to the session history, and the query and the + answer are stored there. If `-` is specified as the session ID, or + it is left empty, then a new session is created with an + automatically generated ID. Format: + `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}` + type: string + userMetadata: + description: Optional. Information about the user initiating the query. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1AssistUserMetadata' + toolsSpec: + description: Optional. Specification of tools that are used to serve the request. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpec + generationSpec: description: >- - The MIME type of the content. Supported types: * `application/pdf` - (PDF, only native PDFs are supported for now) * `text/html` (HTML) * - `application/vnd.openxmlformats-officedocument.wordprocessingml.document` - (DOCX) * - `application/vnd.openxmlformats-officedocument.presentationml.presentation` - (PPTX) * `text/plain` (TXT) See - https://www.iana.org/assignments/media-types/media-types.xhtml. + Optional. Specification of the generation configuration for the + request. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1StreamAssistRequestGenerationSpec + GoogleCloudDiscoveryengineV1Query: + id: GoogleCloudDiscoveryengineV1Query + description: Defines a user inputed query. + type: object + properties: + text: + description: Plain text. type: string - GoogleCloudDiscoveryengineV1DocumentIndexStatus: - id: GoogleCloudDiscoveryengineV1DocumentIndexStatus - description: Index status of the document. + queryId: + description: Output only. Unique Id for the query. + readOnly: true + type: string + GoogleCloudDiscoveryengineV1AssistUserMetadata: + id: GoogleCloudDiscoveryengineV1AssistUserMetadata + description: User metadata of the request. type: object properties: - indexTime: + timeZone: + description: Optional. IANA time zone, e.g. Europe/Budapest. + type: string + preferredLanguageCode: description: >- - The time when the document was indexed. If this field is populated, - it means the document has been indexed. + Optional. Preferred language to be used for answering if language + detection fails. Also used as the language of error messages created + by actions, regardless of language detection results. type: string - format: google-datetime - errorSamples: + GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpec: + id: GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpec + description: Specification of tools that are used to serve the request. + type: object + properties: + vertexAiSearchSpec: + description: Optional. Specification of the Vertex AI Search tool. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecVertexAiSearchSpec + webGroundingSpec: description: >- - A sample of errors encountered while indexing the document. If this - field is populated, the document is not indexed due to errors. - type: array + Optional. Specification of the web grounding tool. If field is + present, enables grounding with web search. Works only if + Assistant.web_grounding_type is WEB_GROUNDING_TYPE_GOOGLE_SEARCH or + WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecWebGroundingSpec + imageGenerationSpec: + description: Optional. Specification of the image generation tool. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecImageGenerationSpec + videoGenerationSpec: + description: Optional. Specification of the video generation tool. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecVideoGenerationSpec + GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecVertexAiSearchSpec: + id: >- + GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecVertexAiSearchSpec + description: Specification of the Vertex AI Search tool. + type: object + properties: + dataStoreSpecs: + description: >- + Optional. Specs defining DataStores to filter on in a search call + and configurations for those data stores. This is only considered + for Engines with multiple data stores. + type: array items: - $ref: '#/components/schemas/GoogleRpcStatus' - GoogleCloudDiscoveryengineV1Chunk: - id: GoogleCloudDiscoveryengineV1Chunk + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec + filter: + description: >- + Optional. The filter syntax consists of an expression language for + constructing a predicate from one or more fields of the documents + being filtered. Filter expression is case-sensitive. If this field + is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in + Vertex AI Search is done by mapping the LHS filter key to a key + property defined in the Vertex AI Search backend -- this mapping is + defined by the customer in their schema. For example a media + customer might have a field 'name' in their schema. In this case the + filter would look like this: filter --> name:'ANY("king kong")' For + more information about filtering including syntax and filter + operators, see + [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + type: string + GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecWebGroundingSpec: + id: GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecWebGroundingSpec + description: Specification of the web grounding tool. + type: object + properties: {} + GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecImageGenerationSpec: + id: >- + GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecImageGenerationSpec + description: Specification of the image generation tool. + type: object + properties: {} + GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecVideoGenerationSpec: + id: >- + GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecVideoGenerationSpec + description: Specification of the video generation tool. + type: object + properties: {} + GoogleCloudDiscoveryengineV1StreamAssistRequestGenerationSpec: + id: GoogleCloudDiscoveryengineV1StreamAssistRequestGenerationSpec description: >- - Chunk captures all raw metadata information of items to be recommended - or searched in the chunk mode. + Assistant generation specification for the request. This allows to + override the default generation configuration at the engine level. type: object properties: - name: + modelId: description: >- - The full resource name of the chunk. Format: - `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`. - This field must be a UTF-8 encoded string with a length limit of - 1024 characters. - type: string - id: - description: Unique chunk ID of the current chunk. - type: string - content: - description: Content is a string from a document (parsed content). + Optional. The Vertex AI model_id used for the generative model. If + not set, the default Assistant model will be used. type: string - relevanceScore: + GoogleCloudDiscoveryengineV1StreamAssistResponse: + id: GoogleCloudDiscoveryengineV1StreamAssistResponse + description: Response for the AssistantService.StreamAssist method. + type: object + properties: + answer: description: >- - Output only. Represents the relevance score based on similarity. - Higher score indicates higher chunk relevance. The score is in range - [-1.0, 1.0]. Only populated on SearchService.SearchResponse. - readOnly: true - type: number - format: double - documentMetadata: - description: Metadata of the document from the current chunk. + Assist answer resource object containing parts of the assistant's + final answer for the user's query. Not present if the current + response doesn't add anything to previously sent + AssistAnswer.replies. Observe AssistAnswer.state to see if more + parts are to be expected. While the state is `IN_PROGRESS`, the + AssistAnswer.replies field in each response will contain replies + (reply fragments) to be appended to the ones received in previous + responses. AssistAnswer.name won't be filled. If the state is + `SUCCEEDED`, `FAILED` or `SKIPPED`, the response is the last + response and AssistAnswer.name will have a value. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1AssistAnswer' + sessionInfo: + description: Session information. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ChunkDocumentMetadata - derivedStructData: + #/components/schemas/GoogleCloudDiscoveryengineV1StreamAssistResponseSessionInfo + assistToken: description: >- - Output only. This field is OUTPUT_ONLY. It contains derived data - that are not in the original input document. - readOnly: true - type: object - additionalProperties: - type: any - description: Properties of the object. - pageSpan: - description: Page span of the chunk. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1ChunkPageSpan' - chunkMetadata: - description: Output only. Metadata of the current chunk. - readOnly: true - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1ChunkChunkMetadata' - GoogleCloudDiscoveryengineV1ChunkDocumentMetadata: - id: GoogleCloudDiscoveryengineV1ChunkDocumentMetadata - description: >- - Document metadata contains the information of the document of the - current chunk. + A global unique ID that identifies the current pair of request and + stream of responses. Used for feedback and support. + type: string + GoogleCloudDiscoveryengineV1AssistAnswer: + id: GoogleCloudDiscoveryengineV1AssistAnswer + description: AssistAnswer resource, main part of AssistResponse. type: object properties: - uri: - description: Uri of the document. + name: + description: >- + Immutable. Identifier. Resource name of the `AssistAnswer`. Format: + `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` + This field must be a UTF-8 encoded string with a length limit of + 1024 characters. type: string - title: - description: Title of the document. + state: + description: State of the answer generation. type: string - structData: - description: >- - Data representation. The structured JSON data for the document. It - should conform to the registered Schema or an `INVALID_ARGUMENT` - error is thrown. - type: object - additionalProperties: - type: any - description: Properties of the object. - GoogleCloudDiscoveryengineV1ChunkPageSpan: - id: GoogleCloudDiscoveryengineV1ChunkPageSpan - description: Page span of the chunk. + enumDescriptions: + - Unknown. + - Assist operation is currently in progress. + - Assist operation has failed. + - Assist operation has succeeded. + - Assist operation has been skipped. + enum: + - STATE_UNSPECIFIED + - IN_PROGRESS + - FAILED + - SUCCEEDED + - SKIPPED + replies: + description: Replies of the assistant. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1AssistAnswerReply' + assistSkippedReasons: + description: Reasons for not answering the assist call. + type: array + items: + type: string + enumDescriptions: + - Default value. Skip reason is not specified. + - >- + The assistant ignored the query, because it did not appear to be + answer-seeking. + - >- + The assistant ignored the query or refused to answer because of + a customer policy violation (e.g., the query or the answer + contained a banned phrase). + enum: + - ASSIST_SKIPPED_REASON_UNSPECIFIED + - NON_ASSIST_SEEKING_QUERY_IGNORED + - CUSTOMER_POLICY_VIOLATION + GoogleCloudDiscoveryengineV1AssistAnswerReply: + id: GoogleCloudDiscoveryengineV1AssistAnswerReply + description: One part of the multi-part response of the assist call. type: object properties: - pageStart: - description: The start page of the chunk. - type: integer - format: int32 - pageEnd: - description: The end page of the chunk. - type: integer - format: int32 - GoogleCloudDiscoveryengineV1ChunkChunkMetadata: - id: GoogleCloudDiscoveryengineV1ChunkChunkMetadata + groundedContent: + description: Possibly grounded response text or media from the assistant. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AssistantGroundedContent + GoogleCloudDiscoveryengineV1AssistantGroundedContent: + id: GoogleCloudDiscoveryengineV1AssistantGroundedContent description: >- - Metadata of the current chunk. This field is only populated on - SearchService.Search API. + A piece of content and possibly its grounding information. Not all + content needs grounding. Phrases like "Of course, I will gladly search + it for you." do not need grounding. type: object properties: - previousChunks: - description: >- - The previous chunks of the current chunk. The number is controlled - by SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks. - This field is only populated on SearchService.Search API. + textGroundingMetadata: + description: Metadata for grounding based on text sources. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadata + content: + description: The content. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1AssistantContent' + GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadata: + id: >- + GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadata + description: Grounding details for text sources. + type: object + properties: + segments: + description: Grounding information for parts of the text. type: array items: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Chunk' - nextChunks: - description: >- - The next chunks of the current chunk. The number is controlled by - SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks. This - field is only populated on SearchService.Search API. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataSegment + references: + description: References for the grounded text. type: array items: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Chunk' - GoogleCloudDiscoveryengineV1SearchResponseFacet: - id: GoogleCloudDiscoveryengineV1SearchResponseFacet - description: A facet result. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataReference + GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataSegment: + id: >- + GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataSegment + description: Grounding information for a segment of the text. type: object properties: - key: + startIndex: description: >- - The key for this facet. For example, `"colors"` or `"price"`. It - matches SearchRequest.FacetSpec.FacetKey.key. + Zero-based index indicating the start of the segment, measured in + bytes of a UTF-8 string (i.e. characters encoded on multiple bytes + have a length of more than one). type: string - values: - description: The facet values for this field. + format: int64 + endIndex: + description: End of the segment, exclusive. + type: string + format: int64 + referenceIndices: + description: References for the segment. type: array items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponseFacetFacetValue - dynamicFacet: - description: Whether the facet is dynamically generated. - type: boolean - GoogleCloudDiscoveryengineV1SearchResponseFacetFacetValue: - id: GoogleCloudDiscoveryengineV1SearchResponseFacetFacetValue - description: A facet value which contains value names and their count. + type: integer + format: int32 + groundingScore: + description: Score for the segment. + type: number + format: float + text: + description: The text segment itself. + type: string + GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataReference: + id: >- + GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataReference + description: Referenced content and related document metadata. type: object properties: - value: - description: Text value of a facet, such as "Black" for facet "colors". + content: + description: Referenced text content. type: string - interval: + documentMetadata: + description: Document metadata. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata + GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata: + id: >- + GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata + description: Document metadata. + type: object + properties: + document: + description: Document resource name. + type: string + uri: description: >- - Interval value for a facet, such as 10, 20) for facet "price". It - matches [SearchRequest.FacetSpec.FacetKey.intervals. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Interval' - count: - description: Number of items that have this facet value. + URI for the document. It may contain a URL that redirects to the + actual website. type: string - format: int64 - GoogleCloudDiscoveryengineV1SearchResponseSummary: - id: GoogleCloudDiscoveryengineV1SearchResponseSummary - description: Summary of the top N search results specified by the summary spec. + title: + description: Title. + type: string + pageIdentifier: + description: Page identifier. + type: string + domain: + description: >- + Domain name from the document URI. Note that the `uri` field may + contain a URL that redirects to the actual website, in which case + this will contain the domain name of the target site. + type: string + GoogleCloudDiscoveryengineV1AssistantContent: + id: GoogleCloudDiscoveryengineV1AssistantContent + description: Multi-modal content. type: object properties: - summaryText: - description: The summary content. + text: + description: Inline text. type: string - summarySkippedReasons: + inlineData: + description: Inline binary data. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AssistantContentBlob + file: + description: A file, e.g., an audio summary. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AssistantContentFile + executableCode: + description: Code generated by the model that is meant to be executed. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AssistantContentExecutableCode + codeExecutionResult: + description: Result of executing an ExecutableCode. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AssistantContentCodeExecutionResult + role: + description: The producer of the content. Can be "model" or "user". + type: string + thought: + description: Optional. Indicates if the part is thought from the model. + type: boolean + GoogleCloudDiscoveryengineV1AssistantContentBlob: + id: GoogleCloudDiscoveryengineV1AssistantContentBlob + description: Inline blob. + type: object + properties: + mimeType: + description: Required. The media type (MIME type) of the generated data. + type: string + data: + description: Required. Raw bytes. + type: string + format: byte + GoogleCloudDiscoveryengineV1AssistantContentFile: + id: GoogleCloudDiscoveryengineV1AssistantContentFile + description: A file, e.g., an audio summary. + type: object + properties: + mimeType: + description: Required. The media type (MIME type) of the file. + type: string + fileId: + description: Required. The file ID. + type: string + GoogleCloudDiscoveryengineV1AssistantContentExecutableCode: + id: GoogleCloudDiscoveryengineV1AssistantContentExecutableCode + description: Code generated by the model that is meant to be executed by the model. + type: object + properties: + code: + description: Required. The code content. Currently only supports Python. + type: string + GoogleCloudDiscoveryengineV1AssistantContentCodeExecutionResult: + id: GoogleCloudDiscoveryengineV1AssistantContentCodeExecutionResult + description: Result of executing ExecutableCode. + type: object + properties: + outcome: + description: Required. Outcome of the code execution. + type: string + enumDescriptions: + - Unspecified status. This value should not be used. + - Code execution completed successfully. + - >- + Code execution finished but with a failure. `stderr` should + contain the reason. + - >- + Code execution ran for too long, and was cancelled. There may or + may not be a partial output present. + enum: + - OUTCOME_UNSPECIFIED + - OUTCOME_OK + - OUTCOME_FAILED + - OUTCOME_DEADLINE_EXCEEDED + output: description: >- - Additional summary-skipped reasons. This provides the reason for - ignored cases. If nothing is skipped, this field is not set. - type: array - items: - type: string - enumDescriptions: - - Default value. The summary skipped reason is not specified. - - >- - The adversarial query ignored case. Only used when - SummarySpec.ignore_adversarial_query is set to `true`. - - >- - The non-summary seeking query ignored case. Google skips the - summary if the query is chit chat. Only used when - SummarySpec.ignore_non_summary_seeking_query is set to `true`. - - >- - The out-of-domain query ignored case. Google skips the summary - if there are no high-relevance search results. For example, the - data store contains facts about company A but the user query is - asking questions about company B. - - >- - The potential policy violation case. Google skips the summary if - there is a potential policy violation detected. This includes - content that may be violent or toxic. - - >- - The LLM addon not enabled case. Google skips the summary if the - LLM addon is not enabled. - - >- - The no relevant content case. Google skips the summary if there - is no relevant content in the retrieved search results. - - >- - The jail-breaking query ignored case. For example, "Reply in the - tone of a competing company's CEO". Only used when - [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] - is set to `true`. - - >- - The customer policy violation case. Google skips the summary if - there is a customer policy violation detected. The policy is - defined by the customer. - - >- - The non-answer seeking query ignored case. Google skips the - summary if the query doesn't have clear intent. Only used when - [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query] - is set to `true`. - enum: - - SUMMARY_SKIPPED_REASON_UNSPECIFIED - - ADVERSARIAL_QUERY_IGNORED - - NON_SUMMARY_SEEKING_QUERY_IGNORED - - OUT_OF_DOMAIN_QUERY_IGNORED - - POTENTIAL_POLICY_VIOLATION - - LLM_ADDON_NOT_ENABLED - - NO_RELEVANT_CONTENT - - JAIL_BREAKING_QUERY_IGNORED - - CUSTOMER_POLICY_VIOLATION - - NON_SUMMARY_SEEKING_QUERY_IGNORED_V2 - safetyAttributes: - description: >- - A collection of Safety Attribute categories and their associated - confidence scores. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponseSummarySafetyAttributes - summaryWithMetadata: - description: Summary with metadata information. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponseSummarySummaryWithMetadata - GoogleCloudDiscoveryengineV1SearchResponseSummarySafetyAttributes: - id: GoogleCloudDiscoveryengineV1SearchResponseSummarySafetyAttributes - description: Safety Attribute categories and their associated confidence scores. + Optional. Contains stdout when code execution is successful, stderr + or other description otherwise. + type: string + GoogleCloudDiscoveryengineV1StreamAssistResponseSessionInfo: + id: GoogleCloudDiscoveryengineV1StreamAssistResponseSessionInfo + description: Information about the session. type: object properties: - categories: - description: >- - The display names of Safety Attribute categories associated with the - generated content. Order matches the Scores. - type: array - items: - type: string - scores: + session: description: >- - The confidence scores of the each category, higher value means - higher confidence. Order matches the Categories. - type: array - items: - type: number - format: float - GoogleCloudDiscoveryengineV1SearchResponseSummarySummaryWithMetadata: - id: GoogleCloudDiscoveryengineV1SearchResponseSummarySummaryWithMetadata - description: Summary with metadata information. - type: object - properties: - summary: - description: Summary text with no citation information. + Name of the newly generated or continued session. Format: + `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`. type: string - citationMetadata: - description: Citation metadata for given summary. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponseSummaryCitationMetadata - references: - description: Document References. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponseSummaryReference - GoogleCloudDiscoveryengineV1SearchResponseSummaryCitationMetadata: - id: GoogleCloudDiscoveryengineV1SearchResponseSummaryCitationMetadata - description: Citation metadata. + GdataMedia: + id: GdataMedia + description: A reference to data stored on the filesystem, on GFS or in blobstore. type: object properties: - citations: - description: Citations for segments. + contentType: + description: MIME type of the data + type: string + timestamp: + description: >- + Time at which the media data was last updated, in milliseconds since + UNIX epoch + type: string + format: uint64 + token: + description: A unique fingerprint/version id for the media data + type: string + length: + description: Size of the data, in bytes + type: string + format: int64 + filename: + description: Original file name + type: string + referenceType: + description: Describes what the field reference contains. + type: string + enumDescriptions: + - Reference contains a GFS path or a local path. + - >- + Reference points to a blobstore object. This could be either a v1 + blob_ref or a v2 blobstore2_info. Clients should check + blobstore2_info first, since v1 is being deprecated. + - Data is included into this proto buffer + - >- + Data should be accessed from the current service using the + operation GetMedia. + - >- + The content for this media object is stored across multiple + partial media objects under the composite_media field. + - Reference points to a bigstore object + - Indicates the data is stored in diff_version_response. + - Indicates the data is stored in diff_checksums_response. + - Indicates the data is stored in diff_download_response. + - Indicates the data is stored in diff_upload_request. + - Indicates the data is stored in diff_upload_response. + - Indicates the data is stored in cosmo_binary_reference. + - >- + Informs Scotty to generate a response payload with the size + specified in the length field. The contents of the payload are + generated by Scotty and are undefined. This is useful for testing + download speeds between the user and Scotty without involving a + real payload source. Note: range is not supported when using + arbitrary_bytes. + enum: + - PATH + - BLOB_REF + - INLINE + - GET_MEDIA + - COMPOSITE_MEDIA + - BIGSTORE_REF + - DIFF_VERSION_RESPONSE + - DIFF_CHECKSUMS_RESPONSE + - DIFF_DOWNLOAD_RESPONSE + - DIFF_UPLOAD_REQUEST + - DIFF_UPLOAD_RESPONSE + - COSMO_BINARY_REFERENCE + - ARBITRARY_BYTES + path: + description: Path to the data, set if reference_type is PATH + type: string + blobRef: + description: >- + Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This + should be the byte representation of a blobstore.BlobRef. Since + Blobstore is deprecating v1, use blobstore2_info instead. For now, + any v2 blob will also be represented in this field as v1 BlobRef. + deprecated: true + type: string + format: byte + inline: + description: Media data, set if reference_type is INLINE + type: string + format: byte + mediaId: + description: >- + Media id to forward to the operation GetMedia. Can be set if + reference_type is GET_MEDIA. + type: string + format: byte + hash: + description: >- + Deprecated, use one of explicit hash type fields instead. These two + hash related fields will only be populated on Scotty based media + uploads and will contain the content of the hash group in the + NotificationRequest: + http://cs/#google3/blobstore2/api/scotty/service/proto/upload_listener.proto&q=class:Hash + Hex encoded hash value of the uploaded media. + deprecated: true + type: string + algorithm: + description: >- + Deprecated, use one of explicit hash type fields instead. Algorithm + used for calculating the hash. As of 2011/01/21, "MD5" is the only + possible value for this field. New values may be added at any time. + deprecated: true + type: string + compositeMedia: + description: >- + A composite media composed of one or more media objects, set if + reference_type is COMPOSITE_MEDIA. The media length field must be + set to the sum of the lengths of all composite media objects. Note: + All composite media must have length specified. type: array items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponseSummaryCitation - GoogleCloudDiscoveryengineV1SearchResponseSummaryCitation: - id: GoogleCloudDiscoveryengineV1SearchResponseSummaryCitation - description: Citation info for a segment. + $ref: '#/components/schemas/GdataCompositeMedia' + bigstoreObjectRef: + description: Use object_id instead. + deprecated: true + type: string + format: byte + objectId: + description: Reference to a TI Blob, set if reference_type is BIGSTORE_REF. + $ref: '#/components/schemas/GdataObjectId' + blobstore2Info: + description: >- + Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it + refers to a v2 blob. + $ref: '#/components/schemas/GdataBlobstore2Info' + diffVersionResponse: + description: Set if reference_type is DIFF_VERSION_RESPONSE. + $ref: '#/components/schemas/GdataDiffVersionResponse' + diffChecksumsResponse: + description: Set if reference_type is DIFF_CHECKSUMS_RESPONSE. + $ref: '#/components/schemas/GdataDiffChecksumsResponse' + diffDownloadResponse: + description: Set if reference_type is DIFF_DOWNLOAD_RESPONSE. + $ref: '#/components/schemas/GdataDiffDownloadResponse' + diffUploadRequest: + description: Set if reference_type is DIFF_UPLOAD_REQUEST. + $ref: '#/components/schemas/GdataDiffUploadRequest' + diffUploadResponse: + description: Set if reference_type is DIFF_UPLOAD_RESPONSE. + $ref: '#/components/schemas/GdataDiffUploadResponse' + contentTypeInfo: + description: Extended content type information provided for Scotty uploads. + $ref: '#/components/schemas/GdataContentTypeInfo' + downloadParameters: + description: Parameters for a media download. + $ref: '#/components/schemas/GdataDownloadParameters' + crc32cHash: + description: >- + For Scotty Uploads: Scotty-provided hashes for uploads For Scotty + Downloads: (WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY + TEAM.) A Hash provided by the agent to be used to verify the data + being downloaded. Currently only supported for inline payloads. + Further, only crc32c_hash is currently supported. + type: integer + format: uint32 + md5Hash: + description: Scotty-provided MD5 hash for an upload. + type: string + format: byte + sha1Hash: + description: Scotty-provided SHA1 hash for an upload. + type: string + format: byte + sha256Hash: + description: Scotty-provided SHA256 hash for an upload. + type: string + format: byte + isPotentialRetry: + description: >- + |is_potential_retry| is set false only when Scotty is certain that + it has not sent the request before. When a client resumes an upload, + this field must be set true in agent calls, because Scotty cannot be + certain that it has never sent the request before due to potential + failure in the session state persistence. + type: boolean + cosmoBinaryReference: + description: >- + A binary data reference for a media download. Serves as a + technology-agnostic binary reference in some Google infrastructure. + This value is a serialized storage_cosmo.BinaryReference proto. + Storing it as bytes is a hack to get around the fact that the cosmo + proto (as well as others it includes) doesn't support JavaScript. + This prevents us from including the actual type of this field. + type: string + format: byte + hashVerified: + description: >- + For Scotty uploads only. If a user sends a hash code and the backend + has requested that Scotty verify the upload against the client hash, + Scotty will perform the check on behalf of the backend and will + reject it if the hashes don't match. This is set to true if Scotty + performed this verification. + type: boolean + GdataCompositeMedia: + id: GdataCompositeMedia + description: >- + A sequence of media data references representing composite data. + Introduced to support Bigstore composite objects. For details, visit + http://go/bigstore-composites. type: object properties: - startIndex: - description: Index indicates the start of the segment, measured in bytes/unicode. + length: + description: Size of the data, in bytes type: string format: int64 - endIndex: - description: End of the attributed segment, exclusive. + referenceType: + description: Describes what the field reference contains. type: string - format: int64 - sources: - description: Citation sources for the attributed segment. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponseSummaryCitationSource - GoogleCloudDiscoveryengineV1SearchResponseSummaryCitationSource: - id: GoogleCloudDiscoveryengineV1SearchResponseSummaryCitationSource - description: Citation source. + enumDescriptions: + - Reference contains a GFS path or a local path. + - >- + Reference points to a blobstore object. This could be either a v1 + blob_ref or a v2 blobstore2_info. Clients should check + blobstore2_info first, since v1 is being deprecated. + - Data is included into this proto buffer + - Reference points to a bigstore object + - Indicates the data is stored in cosmo_binary_reference. + enum: + - PATH + - BLOB_REF + - INLINE + - BIGSTORE_REF + - COSMO_BINARY_REFERENCE + path: + description: Path to the data, set if reference_type is PATH + type: string + blobRef: + description: >- + Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This + should be the byte representation of a blobstore.BlobRef. Since + Blobstore is deprecating v1, use blobstore2_info instead. For now, + any v2 blob will also be represented in this field as v1 BlobRef. + deprecated: true + type: string + format: byte + inline: + description: Media data, set if reference_type is INLINE + type: string + format: byte + objectId: + description: Reference to a TI Blob, set if reference_type is BIGSTORE_REF. + $ref: '#/components/schemas/GdataObjectId' + blobstore2Info: + description: >- + Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it + refers to a v2 blob. + $ref: '#/components/schemas/GdataBlobstore2Info' + cosmoBinaryReference: + description: >- + A binary data reference for a media download. Serves as a + technology-agnostic binary reference in some Google infrastructure. + This value is a serialized storage_cosmo.BinaryReference proto. + Storing it as bytes is a hack to get around the fact that the cosmo + proto (as well as others it includes) doesn't support JavaScript. + This prevents us from including the actual type of this field. + type: string + format: byte + crc32cHash: + description: crc32.c hash for the payload. + type: integer + format: uint32 + md5Hash: + description: MD5 hash for the payload. + type: string + format: byte + sha1Hash: + description: SHA-1 hash for the payload. + type: string + format: byte + GdataObjectId: + id: GdataObjectId + description: >- + This is a copy of the tech.blob.ObjectId proto, which could not be used + directly here due to transitive closure issues with JavaScript support; + see http://b/8801763. type: object properties: - referenceIndex: + bucketName: + description: The name of the bucket to which this object belongs. + type: string + objectName: + description: The name of the object. + type: string + generation: description: >- - Document reference index from SummaryWithMetadata.references. It is - 0-indexed and the value will be zero if the reference_index is not - set explicitly. + Generation of the object. Generations are monotonically increasing + across writes, allowing them to be be compared to determine which + generation is newer. If this is omitted in a request, then you are + requesting the live object. See http://go/bigstore-versions type: string format: int64 - GoogleCloudDiscoveryengineV1SearchResponseSummaryReference: - id: GoogleCloudDiscoveryengineV1SearchResponseSummaryReference - description: Document reference. + GdataBlobstore2Info: + id: GdataBlobstore2Info + description: Information to read/write to blobstore2. type: object properties: - title: - description: Title of the document. + blobId: + description: The blob id, e.g., /blobstore/prod/playground/scotty type: string - document: + blobGeneration: + description: The blob generation id. + type: string + format: int64 + readToken: description: >- - Required. Document.name of the document. Full resource name of the - referenced document, in the format - `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`. + The blob read token. Needed to read blobs that have not been + replicated. Might not be available until the final call. type: string - uri: - description: Cloud Storage or HTTP uri for the document. + uploadMetadataContainer: + description: >- + Metadata passed from Blobstore -> Scotty for a new GCS upload. This + is a signed, serialized blobstore2.BlobMetadataContainer proto which + must never be consumed outside of Bigstore, and is not applicable to + non-GCS media uploads. type: string - chunkContents: - description: List of cited chunk contents derived from document content. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponseSummaryReferenceChunkContent - GoogleCloudDiscoveryengineV1SearchResponseSummaryReferenceChunkContent: - id: GoogleCloudDiscoveryengineV1SearchResponseSummaryReferenceChunkContent - description: Chunk content. + format: byte + downloadReadHandle: + description: >- + Read handle passed from Bigstore -> Scotty for a GCS download. This + is a signed, serialized blobstore2.ReadHandle proto which must never + be set outside of Bigstore, and is not applicable to non-GCS media + downloads. + type: string + format: byte + GdataDiffVersionResponse: + id: GdataDiffVersionResponse + description: >- + Backend response for a Diff get version response. For details on the + Scotty Diff protocol, visit http://go/scotty-diff-protocol. type: object properties: - content: - description: Chunk textual content. + objectVersion: + description: The version of the object stored at the server. type: string - pageIdentifier: - description: Page identifier. + objectSizeBytes: + description: The total size of the server object. type: string - GoogleCloudDiscoveryengineV1SearchResponseQueryExpansionInfo: - id: GoogleCloudDiscoveryengineV1SearchResponseQueryExpansionInfo + format: int64 + GdataDiffChecksumsResponse: + id: GdataDiffChecksumsResponse description: >- - Information describing query expansion including whether expansion has - occurred. + Backend response for a Diff get checksums response. For details on the + Scotty Diff protocol, visit http://go/scotty-diff-protocol. type: object properties: - expandedQuery: - description: Bool describing whether query expansion has occurred. - type: boolean - pinnedResultCount: + objectVersion: description: >- - Number of pinned results. This field will only be set when expansion - happens and SearchRequest.QueryExpansionSpec.pin_unexpanded_results - is set to true. + The object version of the object the checksums are being returned + for. + type: string + objectSizeBytes: + description: The total size of the server object. type: string format: int64 - GoogleCloudDiscoveryengineV1SearchResponseSessionInfo: - id: GoogleCloudDiscoveryengineV1SearchResponseSessionInfo - description: Information about the session. + chunkSizeBytes: + description: The chunk size of checksums. Must be a multiple of 256KB. + type: string + format: int64 + checksumsLocation: + description: >- + Exactly one of these fields must be populated. If checksums_location + is filled, the server will return the corresponding contents to the + user. If object_location is filled, the server will calculate the + checksums based on the content there and return that to the user. + For details on the format of the checksums, see + http://go/scotty-diff-protocol. + $ref: '#/components/schemas/GdataCompositeMedia' + objectLocation: + description: >- + If set, calculate the checksums based on the contents and return + them to the caller. + $ref: '#/components/schemas/GdataCompositeMedia' + GdataDiffDownloadResponse: + id: GdataDiffDownloadResponse + description: >- + Backend response for a Diff download response. For details on the Scotty + Diff protocol, visit http://go/scotty-diff-protocol. type: object properties: - name: + objectLocation: + description: The original object location. + $ref: '#/components/schemas/GdataCompositeMedia' + GdataDiffUploadRequest: + id: GdataDiffUploadRequest + description: >- + A Diff upload request. For details on the Scotty Diff protocol, visit + http://go/scotty-diff-protocol. + type: object + properties: + objectVersion: description: >- - Name of the session. If the auto-session mode is used (when - SearchRequest.session ends with "-"), this field holds the newly - generated session name. + The object version of the object that is the base version the + incoming diff script will be applied to. This field will always be + filled in. type: string - queryId: + objectInfo: description: >- - Query ID that corresponds to this search API call. One session can - have multiple turns, each with a unique query ID. By specifying the - session name and this query ID in the Answer API call, the answer - generation happens in the context of the search results from this - search call. - type: string - GoogleCloudDiscoveryengineV1ConverseConversationRequest: - id: GoogleCloudDiscoveryengineV1ConverseConversationRequest + The location of the new object. Agents must clone the object located + here, as the upload server will delete the contents once a response + is received. + $ref: '#/components/schemas/GdataCompositeMedia' + checksumsInfo: + description: >- + The location of the checksums for the new object. Agents must clone + the object located here, as the upload server will delete the + contents once a response is received. For details on the format of + the checksums, see http://go/scotty-diff-protocol. + $ref: '#/components/schemas/GdataCompositeMedia' + GdataDiffUploadResponse: + id: GdataDiffUploadResponse description: >- - Request message for ConversationalSearchService.ConverseConversation - method. + Backend response for a Diff upload request. For details on the Scotty + Diff protocol, visit http://go/scotty-diff-protocol. type: object properties: - query: - description: Required. Current user input. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1TextInput' - servingConfig: + objectVersion: description: >- - The resource name of the Serving Config to use. Format: - `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` - If this is not set, the default serving config will be used. + The object version of the object at the server. Must be included in + the end notification response. The version in the end notification + response must correspond to the new version of the object that is + now stored at the server, after the upload. type: string - conversation: + originalObject: description: >- - The conversation to be used by auto session only. The name field - will be ignored as we automatically assign new name for the - conversation in auto session. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' - safeSearch: - description: Whether to turn on safe search. + The location of the original file for a diff upload request. Must be + filled in if responding to an upload start notification. + $ref: '#/components/schemas/GdataCompositeMedia' + GdataContentTypeInfo: + id: GdataContentTypeInfo + description: >- + Detailed Content-Type information from Scotty. The Content-Type of the + media will typically be filled in by the header or Scotty's best_guess, + but this extended information provides the backend with more information + so that it can make a better decision if needed. This is only used on + media upload requests from Scotty. + type: object + properties: + bestGuess: + description: Scotty's best guess of what the content type of the file is. + type: string + fromHeader: + description: >- + The content type of the file as specified in the request headers, + multipart headers, or RUPIO start request. + type: string + fromFileName: + description: >- + The content type of the file derived from the file extension of the + original file name used by the client. + type: string + fromUrlPath: + description: >- + The content type of the file derived from the file extension of the + URL path. The URL path is assumed to represent a file name (which is + typically only true for agents that are providing a REST API). + type: string + fromBytes: + description: >- + The content type of the file derived by looking at specific bytes + (i.e. "magic bytes") of the actual file. + type: string + GdataDownloadParameters: + id: GdataDownloadParameters + description: Parameters specific to media downloads. + type: object + properties: + allowGzipCompression: + description: >- + A boolean to be returned in the response to Scotty. Allows/disallows + gzip encoding of the payload content when the server thinks it's + advantageous (hence, does not guarantee compression) which allows + Scotty to GZip the response to the client. type: boolean - userLabels: + ignoreRange: description: >- - The user labels applied to a resource must meet the following - requirements: * Each resource can have multiple labels, up to a - maximum of 64. * Each label must be a key-value pair. * Keys have a - minimum length of 1 character and a maximum length of 63 characters - and cannot be empty. Values can be empty and have a maximum length - of 63 characters. * Keys and values can contain only lowercase - letters, numeric characters, underscores, and dashes. All characters - must use UTF-8 encoding, and international characters are allowed. * - The key portion of a label must be unique. However, you can use the - same key with multiple resources. * Keys must start with a lowercase - letter or international character. See [Google Cloud - Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) - for more details. - type: object - additionalProperties: - type: string - summarySpec: + Determining whether or not Apiary should skip the inclusion of any + Content-Range header on its response to Scotty. + type: boolean + GoogleCloudDiscoveryengineV1Assistant: + id: GoogleCloudDiscoveryengineV1Assistant + description: Discovery Engine Assistant resource. + type: object + properties: + name: description: >- - A specification for configuring the summary returned in the + Immutable. Resource name of the assistant. Format: + `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` + It must be a UTF-8 encoded string with a length limit of 1024 + characters. + type: string + generationConfig: + description: >- + Optional. Configuration for the generation of the assistant response. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec - filter: - description: >- - The filter syntax consists of an expression language for - constructing a predicate from one or more fields of the documents - being filtered. Filter expression is case-sensitive. This will be - used to filter search results which may affect the summary response. - If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. - Filtering in Vertex AI Search is done by mapping the LHS filter key - to a key property defined in the Vertex AI Search backend -- this - mapping is defined by the customer in their schema. For example a - media customer might have a field 'name' in their schema. In this - case the filter would look like this: filter --> name:'ANY("king - kong")' For more information about filtering including syntax and - filter operators, see - [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + #/components/schemas/GoogleCloudDiscoveryengineV1AssistantGenerationConfig + webGroundingType: + description: Optional. The type of web grounding to use. type: string - boostSpec: - description: >- - Boost specification to boost certain documents in search results - which may affect the converse response. For more information on - boosting, see - [Boosting](https://cloud.google.com/retail/docs/boosting#boost) + enumDescriptions: + - Default, unspecified setting. This is the same as disabled. + - Web grounding is disabled. + - Grounding with Google Search is enabled. + - Grounding with Enterprise Web Search is enabled. + enum: + - WEB_GROUNDING_TYPE_UNSPECIFIED + - WEB_GROUNDING_TYPE_DISABLED + - WEB_GROUNDING_TYPE_GOOGLE_SEARCH + - WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH + enabledTools: + description: >- + Optional. Note: not implemented yet. Use enabled_actions instead. + The enabled tools on this assistant. The keys are connector name, + for example + "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector + The values consist of admin enabled tools towards the connector + instance. Admin can selectively enable multiple tools on any of the + connector instances that they created in the project. For example + {"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2, + "transferTicket")], "gmail1ConnectorName": [(toolId3, + "sendEmail"),..] } + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1AssistantToolList' + customerPolicy: + description: Optional. Customer policy for the assistant. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestBoostSpec - GoogleCloudDiscoveryengineV1TextInput: - id: GoogleCloudDiscoveryengineV1TextInput - description: Defines text input. + #/components/schemas/GoogleCloudDiscoveryengineV1AssistantCustomerPolicy + GoogleCloudDiscoveryengineV1AssistantGenerationConfig: + id: GoogleCloudDiscoveryengineV1AssistantGenerationConfig + description: Configuration for the generation of the assistant response. type: object properties: - input: - description: Text input. + systemInstruction: + description: >- + System instruction, also known as the prompt preamble for LLM calls. + See also + https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AssistantGenerationConfigSystemInstruction + defaultLanguage: + description: >- + The default language to use for the generation of the assistant + response. Use an ISO 639-1 language code such as `en`. If not + specified, the language will be automatically detected. type: string - context: - description: Conversation context of the input. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1ConversationContext' - GoogleCloudDiscoveryengineV1ConversationContext: - id: GoogleCloudDiscoveryengineV1ConversationContext - description: Defines context of the conversation + GoogleCloudDiscoveryengineV1AssistantGenerationConfigSystemInstruction: + id: GoogleCloudDiscoveryengineV1AssistantGenerationConfigSystemInstruction + description: System instruction, also known as the prompt preamble for LLM calls. type: object properties: - contextDocuments: + additionalSystemInstruction: description: >- - The current list of documents the user is seeing. It contains the - document resource references. + Optional. Additional system instruction that will be added to the + default system instruction. + type: string + GoogleCloudDiscoveryengineV1AssistantToolList: + id: GoogleCloudDiscoveryengineV1AssistantToolList + description: The enabled tools on a connector + type: object + properties: + toolInfo: + description: The list of tools with corresponding tool information. type: array items: - type: string - activeDocument: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1AssistantToolInfo' + GoogleCloudDiscoveryengineV1AssistantToolInfo: + id: GoogleCloudDiscoveryengineV1AssistantToolInfo + description: Information to identify a tool. + type: object + properties: + toolName: description: >- - The current active document the user opened. It contains the - document resource reference. + The name of the tool as defined by + DataConnectorService.QueryAvailableActions. Note: it's using + `action` in the DataConnectorService apis, but they are the same as + the `tool` here. type: string - GoogleCloudDiscoveryengineV1Conversation: - id: GoogleCloudDiscoveryengineV1Conversation - description: External conversation proto definition. + toolDisplayName: + description: The display name of the tool. + type: string + GoogleCloudDiscoveryengineV1AssistantCustomerPolicy: + id: GoogleCloudDiscoveryengineV1AssistantCustomerPolicy + description: Customer-defined policy for the assistant. + type: object + properties: + bannedPhrases: + description: Optional. List of banned phrases. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AssistantCustomerPolicyBannedPhrase + GoogleCloudDiscoveryengineV1AssistantCustomerPolicyBannedPhrase: + id: GoogleCloudDiscoveryengineV1AssistantCustomerPolicyBannedPhrase + description: >- + Definition of a customer-defined banned phrase. A banned phrase is not + allowed to appear in the user query or the LLM response, or else the + answer will be refused. + type: object + properties: + phrase: + description: Required. The raw string content to be banned. + type: string + matchType: + description: Optional. Match type for the banned phrase. + type: string + enumDescriptions: + - Defaults to SIMPLE_STRING_MATCH. + - >- + The banned phrase matches if it is found anywhere in the text as + an exact substring. + - >- + Banned phrase only matches if the pattern found in the text is + surrounded by word delimiters. The phrase itself may still contain + word delimiters. + enum: + - BANNED_PHRASE_MATCH_TYPE_UNSPECIFIED + - SIMPLE_STRING_MATCH + - WORD_BOUNDARY_STRING_MATCH + ignoreDiacritics: + description: >- + Optional. If true, diacritical marks (e.g., accents, umlauts) are + ignored when matching banned phrases. For example, "cafe" would + match "café". + type: boolean + GoogleCloudDiscoveryengineV1CmekConfig: + id: GoogleCloudDiscoveryengineV1CmekConfig + description: Configurations used to enable CMEK data encryption with Cloud KMS keys. type: object properties: name: description: >- - Immutable. Fully qualified name - `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*` - or - `projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*`. + Required. The name of the CmekConfig of the form + `projects/{project}/locations/{location}/cmekConfig` or + `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`. + type: string + kmsKey: + description: >- + Required. KMS key resource name which will be used to encrypt + resources + `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. + type: string + kmsKeyVersion: + description: >- + Output only. KMS key version resource name which will be used to + encrypt resources `/cryptoKeyVersions/{keyVersion}`. + readOnly: true type: string state: - description: The state of the Conversation. + description: Output only. The states of the CmekConfig. + readOnly: true type: string enumDescriptions: - - Unknown. - - Conversation is currently open. - - Conversation has been completed. + - The CmekConfig state is unknown. + - The CmekConfig is creating. + - The CmekConfig can be used with DataStores. + - >- + The CmekConfig is unavailable, most likely due to the KMS Key + being revoked. + - The CmekConfig is deleting. + - The CmekConfig deletion process failed. + - >- + The CmekConfig is not usable, most likely due to some internal + issue. + - The KMS key version is being rotated. + - >- + The KMS key is soft deleted. Some cleanup policy will eventually + be applied. enum: - STATE_UNSPECIFIED - - IN_PROGRESS - - COMPLETED - userPseudoId: - description: A unique identifier for tracking users. + - CREATING + - ACTIVE + - KEY_ISSUE + - DELETING + - DELETE_FAILED + - UNUSABLE + - ACTIVE_ROTATING + - DELETED + isDefault: + description: Output only. The default CmekConfig for the Customer. + readOnly: true + type: boolean + lastRotationTimestampMicros: + description: Output only. The timestamp of the last key rotation. + readOnly: true type: string - messages: - description: Conversation messages. + format: int64 + singleRegionKeys: + description: >- + Optional. Single-regional CMEKs that are required for some VAIS + features. type: array items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ConversationMessage - startTime: - description: Output only. The time the conversation started. - readOnly: true - type: string - format: google-datetime - endTime: - description: Output only. The time the conversation finished. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1SingleRegionKey' + notebooklmState: + description: Output only. Whether the NotebookLM Corpus is ready to be used. readOnly: true type: string - format: google-datetime - GoogleCloudDiscoveryengineV1ConversationMessage: - id: GoogleCloudDiscoveryengineV1ConversationMessage - description: Defines a conversation message. + enumDescriptions: + - The NotebookLM state is unknown. + - The NotebookLM is not ready. + - The NotebookLM is ready to be used. + - The NotebookLM is not enabled. + enum: + - NOTEBOOK_LM_STATE_UNSPECIFIED + - NOTEBOOK_LM_NOT_READY + - NOTEBOOK_LM_READY + - NOTEBOOK_LM_NOT_ENABLED + GoogleCloudDiscoveryengineV1SingleRegionKey: + id: GoogleCloudDiscoveryengineV1SingleRegionKey + description: Metadata for single-regional CMEKs. type: object properties: - userInput: - description: User text input. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1TextInput' - reply: - description: Search reply. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Reply' - createTime: - description: Output only. Message creation timestamp. - readOnly: true + kmsKey: + description: >- + Required. Single-regional kms key resource name which will be used + to encrypt resources + `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. type: string - format: google-datetime - GoogleCloudDiscoveryengineV1Reply: - id: GoogleCloudDiscoveryengineV1Reply - description: Defines a reply message to user. - type: object - properties: - summary: - description: Summary based on search results. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponseSummary - GoogleCloudDiscoveryengineV1ConverseConversationResponse: - id: GoogleCloudDiscoveryengineV1ConverseConversationResponse - description: >- - Response message for ConversationalSearchService.ConverseConversation - method. + GoogleCloudDiscoveryengineV1ListCmekConfigsResponse: + id: GoogleCloudDiscoveryengineV1ListCmekConfigsResponse + description: Response message for CmekConfigService.ListCmekConfigs method. type: object properties: - reply: - description: Answer to the current query. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Reply' - conversation: - description: Updated conversation including the answer. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' - searchResults: - description: Search Results. + cmekConfigs: + description: All the customer's CmekConfigs. type: array items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponseSearchResult - GoogleCloudDiscoveryengineV1ListConversationsResponse: - id: GoogleCloudDiscoveryengineV1ListConversationsResponse - description: Response for ListConversations method. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1CmekConfig' + GoogleCloudDiscoveryengineV1CompleteQueryResponse: + id: GoogleCloudDiscoveryengineV1CompleteQueryResponse + description: Response message for CompletionService.CompleteQuery method. type: object properties: - conversations: - description: All the Conversations for a given data store. + querySuggestions: + description: >- + Results of the matched query suggestions. The result list is ordered + and the first result is a top suggestion. type: array items: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' - nextPageToken: - description: Pagination token, if not returned indicates the last page. - type: string - GoogleCloudDiscoveryengineV1AnswerQueryRequest: - id: GoogleCloudDiscoveryengineV1AnswerQueryRequest - description: Request message for ConversationalSearchService.AnswerQuery method. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1CompleteQueryResponseQuerySuggestion + tailMatchTriggered: + description: >- + True if the returned suggestions are all tail suggestions. For tail + matching to be triggered, include_tail_suggestions in the request + must be true and there must be no suggestions that match the full + query. + type: boolean + GoogleCloudDiscoveryengineV1CompleteQueryResponseQuerySuggestion: + id: GoogleCloudDiscoveryengineV1CompleteQueryResponseQuerySuggestion + description: Suggestions as search queries. + type: object + properties: + suggestion: + description: The suggestion for the query. + type: string + completableFieldPaths: + description: >- + The unique document field paths that serve as the source of this + suggestion if it was generated from completable fields. This field + is only populated for the document-completable model. + type: array + items: + type: string + GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest: + id: GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest + description: Request message for CompletionService.AdvancedCompleteQuery method. . type: object properties: query: - description: Required. Current user query. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Query' - session: description: >- - The session resource name. Not required. When session field is not - set, the API is in sessionless mode. We support auto session mode: - users can use the wildcard symbol `-` as session ID. A new ID will - be automatically generated and assigned. + Required. The typeahead input used to fetch suggestions. Maximum + length is 128 characters. The query can not be empty for most of the + suggestion types. If it is empty, an `INVALID_ARGUMENT` error is + returned. The exception is when the suggestion_types contains only + the type `RECENT_SEARCH`, the query can be an empty string. The is + called "zero prefix" feature, which returns user's recently searched + queries given the empty query. + type: string + queryModel: + description: >- + Specifies the autocomplete query model, which only applies to the + QUERY SuggestionType. This overrides any model specified in the + Configuration > Autocomplete section of the Cloud console. Currently + supported values: * `document` - Using suggestions generated from + user-imported documents. * `search-history` - Using suggestions + generated from the past history of SearchService.Search API calls. + Do not use it when there is no traffic for Search API. * + `user-event` - Using suggestions generated from user-imported search + events. * `document-completable` - Using suggestions taken directly + from user-imported document fields marked as completable. Default + values: * `document` is the default model for regular dataStores. * + `search-history` is the default model for site search dataStores. type: string - safetySpec: - description: Model specification. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpec - relatedQuestionsSpec: - description: Related questions specification. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequestRelatedQuestionsSpec - groundingSpec: - description: Optional. Grounding specification. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequestGroundingSpec - answerGenerationSpec: - description: Answer generation specification. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec - searchSpec: - description: Search specification. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpec - queryUnderstandingSpec: - description: Query understanding specification. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpec - asynchronousMode: - description: >- - Deprecated: This field is deprecated. Streaming Answer API will be - supported. Asynchronous mode control. If enabled, the response will - be returned with answer/session resource name without final answer. - The API users need to do the polling to get the latest status of - answer/session by calling ConversationalSearchService.GetAnswer or - ConversationalSearchService.GetSession method. - deprecated: true - type: boolean userPseudoId: description: >- A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field - should NOT have a fixed value such as `unknown_visitor`. The field - must be a UTF-8 encoded string with a length limit of 128 - characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + should NOT have a fixed value such as `unknown_visitor`. This should + be the same identifier as UserEvent.user_pseudo_id and + SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded + string with a length limit of 128 type: string - userLabels: + userInfo: description: >- - The user labels applied to a resource must meet the following - requirements: * Each resource can have multiple labels, up to a - maximum of 64. * Each label must be a key-value pair. * Keys have a - minimum length of 1 character and a maximum length of 63 characters - and cannot be empty. Values can be empty and have a maximum length - of 63 characters. * Keys and values can contain only lowercase - letters, numeric characters, underscores, and dashes. All characters - must use UTF-8 encoding, and international characters are allowed. * - The key portion of a label must be unique. However, you can use the - same key with multiple resources. * Keys must start with a lowercase - letter or international character. See [Google Cloud - Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) - for more details. - type: object - additionalProperties: + Optional. Information about the end user. This should be the same + identifier information as UserEvent.user_info and + SearchRequest.user_info. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1UserInfo' + includeTailSuggestions: + description: >- + Indicates if tail suggestions should be returned if there are no + suggestions that match the full query. Even if set to true, if there + are suggestions that match the full query, those are returned and no + tail suggestions are returned. + type: boolean + boostSpec: + description: Optional. Specification to boost suggestions matching the condition. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpec + suggestionTypes: + description: >- + Optional. Suggestion types to return. If empty or unspecified, query + suggestions are returned. Only one suggestion type is supported at + the moment. + type: array + items: type: string - GoogleCloudDiscoveryengineV1Query: - id: GoogleCloudDiscoveryengineV1Query - description: Defines a user inputed query. - type: object - properties: - text: - description: Plain text. - type: string - queryId: - description: Unique Id for the query. - type: string - GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpec: - id: GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpec - description: Safety specification. + enumDescriptions: + - Default value. + - Returns query suggestions. + - Returns people suggestions. + - Returns content suggestions. + - Returns recent search suggestions. + - Returns Google Workspace suggestions. + enum: + - SUGGESTION_TYPE_UNSPECIFIED + - QUERY + - PEOPLE + - CONTENT + - RECENT_SEARCH + - GOOGLE_WORKSPACE + suggestionTypeSpecs: + description: Optional. Specification of each suggestion type. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestSuggestionTypeSpec + experimentIds: + description: Optional. Experiment ids for this request. + type: array + items: + type: string + GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpec: + id: GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpec + description: >- + Specification to boost suggestions based on the condtion of the + suggestion. type: object properties: - enable: + conditionBoostSpecs: description: >- - Enable the safety filtering on the answer response. It is false by - default. - type: boolean - GoogleCloudDiscoveryengineV1AnswerQueryRequestRelatedQuestionsSpec: - id: GoogleCloudDiscoveryengineV1AnswerQueryRequestRelatedQuestionsSpec - description: Related questions specification. + Condition boost specifications. If a suggestion matches multiple + conditions in the specifications, boost values from these + specifications are all applied and combined in a non-linear way. + Maximum number of specifications is 20. Note: Currently only support + language condition boost. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpecConditionBoostSpec + GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpecConditionBoostSpec: + id: >- + GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpecConditionBoostSpec + description: Boost applies to suggestions which match a condition. type: object properties: - enable: - description: Enable related questions feature if true. - type: boolean - GoogleCloudDiscoveryengineV1AnswerQueryRequestGroundingSpec: - id: GoogleCloudDiscoveryengineV1AnswerQueryRequestGroundingSpec - description: Grounding specification. + condition: + description: >- + An expression which specifies a boost condition. The syntax is the + same as [filter expression + syntax](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax). + Currently, the only supported condition is a list of BCP-47 lang + codes. Example: * To boost suggestions in languages `en` or `fr`: + `(lang_code: ANY("en", "fr"))` + type: string + boost: + description: >- + Strength of the boost, which should be in [-1, 1]. Negative boost + means demotion. Default is 0.0. Setting to 1.0 gives the suggestions + a big promotion. However, it does not necessarily mean that the top + result will be a boosted suggestion. Setting to -1.0 gives the + suggestions a big demotion. However, other suggestions that are + relevant might still be shown. Setting to 0.0 means no boost + applied. The boosting condition is ignored. + type: number + format: float + GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestSuggestionTypeSpec: + id: >- + GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestSuggestionTypeSpec + description: Specification of each suggestion type. type: object properties: - includeGroundingSupports: + suggestionType: + description: Optional. Suggestion type. + type: string + enumDescriptions: + - Default value. + - Returns query suggestions. + - Returns people suggestions. + - Returns content suggestions. + - Returns recent search suggestions. + - Returns Google Workspace suggestions. + enum: + - SUGGESTION_TYPE_UNSPECIFIED + - QUERY + - PEOPLE + - CONTENT + - RECENT_SEARCH + - GOOGLE_WORKSPACE + maxSuggestions: description: >- - Optional. Specifies whether to include grounding_supports in the - answer. The default value is `false`. When this field is set to - `true`, returned answer will have `grounding_score` and will contain - GroundingSupports for each claim. - type: boolean - GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec: - id: GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec - description: Answer generation specification. + Optional. Maximum number of suggestions to return for each + suggestion type. + type: integer + format: int32 + GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponse: + id: GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponse + description: Response message for CompletionService.AdvancedCompleteQuery method. type: object properties: - modelSpec: - description: Answer generation model specification. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecModelSpec - promptSpec: - description: Answer generation prompt specification. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecPromptSpec - includeCitations: - description: >- - Specifies whether to include citation metadata in the answer. The - default value is `false`. - type: boolean - answerLanguageCode: - description: >- - Language code for Answer. Use language tags defined by - [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is - an experimental feature. - type: string - ignoreAdversarialQuery: + querySuggestions: description: >- - Specifies whether to filter out adversarial queries. The default - value is `false`. Google employs search-query classification to - detect adversarial queries. No answer is returned if the search - query is classified as an adversarial query. For example, a user - might ask a question regarding negative comments about the company - or submit a query designed to generate unsafe, policy-violating - output. If this field is set to `true`, we skip generating answers - for adversarial queries and return fallback messages instead. - type: boolean - ignoreNonAnswerSeekingQuery: + Results of the matched query suggestions. The result list is ordered + and the first result is a top suggestion. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseQuerySuggestion + tailMatchTriggered: description: >- - Specifies whether to filter out queries that are not answer-seeking. - The default value is `false`. Google employs search-query - classification to detect answer-seeking queries. No answer is - returned if the search query is classified as a non-answer seeking - query. If this field is set to `true`, we skip generating answers - for non-answer seeking queries and return fallback messages instead. + True if the returned suggestions are all tail suggestions. For tail + matching to be triggered, include_tail_suggestions in the request + must be true and there must be no suggestions that match the full + query. type: boolean - ignoreLowRelevantContent: + peopleSuggestions: description: >- - Specifies whether to filter out queries that have low relevance. If - this field is set to `false`, all search results are used regardless - of relevance to generate answers. If set to `true` or unset, the - behavior will be determined automatically by the service. - type: boolean - ignoreJailBreakingQuery: + Results of the matched people suggestions. The result list is + ordered and the first result is the top suggestion. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponsePersonSuggestion + contentSuggestions: description: >- - Optional. Specifies whether to filter out jail-breaking queries. The - default value is `false`. Google employs search-query classification - to detect jail-breaking queries. No summary is returned if the - search query is classified as a jail-breaking query. A user might - add instructions to the query to change the tone, style, language, - content of the answer, or ask the model to act as a different - entity, e.g. "Reply in the tone of a competing company's CEO". If - this field is set to `true`, we skip generating summaries for - jail-breaking queries and return fallback messages instead. - type: boolean - GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecModelSpec: - id: >- - GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecModelSpec - description: Answer Generation Model specification. - type: object - properties: - modelVersion: + Results of the matched content suggestions. The result list is + ordered and the first result is the top suggestion. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseContentSuggestion + recentSearchSuggestions: description: >- - Model version. If not set, it will use the default stable model. - Allowed values are: stable, preview. - type: string - GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecPromptSpec: - id: >- - GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecPromptSpec - description: Answer generation prompt specification. + Results of the matched "recent search" suggestions. The result list + is ordered and the first result is the top suggestion. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseRecentSearchSuggestion + GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseQuerySuggestion: + id: GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseQuerySuggestion + description: Suggestions as search queries. type: object properties: - preamble: - description: Customized preamble. + suggestion: + description: The suggestion for the query. type: string - GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpec: - id: GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpec - description: Search specification. - type: object - properties: - searchParams: - description: Search parameters. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams - searchResultList: - description: Search result list. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultList - GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams: - id: GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams - description: Search parameters. - type: object - properties: - maxReturnResults: - description: Number of search results to return. The default value is 10. - type: integer - format: int32 - filter: - description: >- - The filter syntax consists of an expression language for - constructing a predicate from one or more fields of the documents - being filtered. Filter expression is case-sensitive. This will be - used to filter search results which may affect the Answer response. - If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. - Filtering in Vertex AI Search is done by mapping the LHS filter key - to a key property defined in the Vertex AI Search backend -- this - mapping is defined by the customer in their schema. For example a - media customers might have a field 'name' in their schema. In this - case the filter would look like this: filter --> name:'ANY("king - kong")' For more information about filtering including syntax and - filter operators, see - [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) - type: string - boostSpec: - description: >- - Boost specification to boost certain documents in search results - which may affect the answer query response. For more information on - boosting, see - [Boosting](https://cloud.google.com/retail/docs/boosting#boost) - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestBoostSpec - orderBy: - description: >- - The order in which documents are returned. Documents can be ordered - by a field in an Document object. Leave it unset if ordered by - relevance. `order_by` expression is case-sensitive. For more - information on ordering, see - [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) - If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. - type: string - searchResultMode: - description: >- - Specifies the search result mode. If unspecified, the search result - mode defaults to `DOCUMENTS`. See [parse and chunk - documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) - type: string - enumDescriptions: - - Default value. - - Returns documents in the search result. - - >- - Returns chunks in the search result. Only available if the - DataStore.DocumentProcessingConfig.chunking_config is specified. - enum: - - SEARCH_RESULT_MODE_UNSPECIFIED - - DOCUMENTS - - CHUNKS - dataStoreSpecs: + completableFieldPaths: description: >- - Specs defining dataStores to filter on in a search call and - configurations for those dataStores. This is only considered for - engines with multiple dataStores use case. For single dataStore - within an engine, they should use the specs at the top level. + The unique document field paths that serve as the source of this + suggestion if it was generated from completable fields. This field + is only populated for the document-completable model. type: array items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec - GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultList: - id: GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultList - description: Search result list. - type: object - properties: - searchResults: - description: Search results. + type: string + dataStore: + description: The name of the dataStore that this suggestion belongs to. type: array items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResult - GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResult: - id: >- - GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResult - description: Search result. - type: object - properties: - unstructuredDocumentInfo: - description: Unstructured document information. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo - chunkInfo: - description: Chunk information. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo - GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo: + type: string + score: + description: The score of each suggestion. The score is in the range of [0, 1]. + type: number + format: double + GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponsePersonSuggestion: id: >- - GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo - description: Unstructured document information. + GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponsePersonSuggestion + description: Suggestions as people. type: object properties: - document: - description: Document resource name. - type: string - uri: - description: URI for the document. + suggestion: + description: The suggestion for the query. type: string - title: - description: Title. + personType: + description: The type of the person. type: string - documentContexts: - description: >- - List of document contexts. The content will be used for Answer - Generation. This is supposed to be the main content of the document - that can be long and comprehensive. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext - extractiveSegments: - description: List of extractive segments. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment - extractiveAnswers: + enumDescriptions: + - Default value. + - The suggestion is from a GOOGLE_IDENTITY source. + - The suggestion is from a THIRD_PARTY_IDENTITY source. + enum: + - PERSON_TYPE_UNSPECIFIED + - CLOUD_IDENTITY + - THIRD_PARTY_IDENTITY + document: description: >- - Deprecated: This field is deprecated and will have no effect on the - Answer generation. Please use document_contexts and - extractive_segments fields. List of extractive answers. - deprecated: true - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer - GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext: - id: >- - GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext - description: Document context. - type: object - properties: - pageIdentifier: - description: Page identifier. + The document data snippet in the suggestion. Only a subset of fields + is populated. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' + dataStore: + description: The name of the dataStore that this suggestion belongs to. type: string - content: - description: Document content to be used for answer generation. + score: + description: The score of each suggestion. The score is in the range of [0, 1]. + type: number + format: double + displayPhotoUri: + description: The photo uri of the person suggestion. type: string - GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment: + destinationUri: + description: The destination uri of the person suggestion. + type: string + GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseContentSuggestion: id: >- - GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment - description: >- - Extractive segment. - [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments) - Answer generation will only use it if document_contexts is empty. This - is supposed to be shorter snippets. + GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseContentSuggestion + description: Suggestions as content. type: object properties: - pageIdentifier: - description: Page identifier. + suggestion: + description: The suggestion for the query. type: string - content: - description: Extractive segment content. + contentType: + description: The type of the content suggestion. type: string - GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer: - id: >- - GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer - description: >- - Extractive answer. - [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#get-answers) - type: object - properties: - pageIdentifier: - description: Page identifier. + enumDescriptions: + - Default value. + - The suggestion is from a Google Workspace source. + - The suggestion is from a third party source. + enum: + - CONTENT_TYPE_UNSPECIFIED + - GOOGLE_WORKSPACE + - THIRD_PARTY + document: + description: >- + The document data snippet in the suggestion. Only a subset of fields + will be populated. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' + dataStore: + description: The name of the dataStore that this suggestion belongs to. type: string - content: - description: Extractive answer content. + score: + description: The score of each suggestion. The score is in the range of [0, 1]. + type: number + format: double + iconUri: + description: The icon uri of the content suggestion. type: string - GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo: + destinationUri: + description: The destination uri of the content suggestion. + type: string + GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseRecentSearchSuggestion: id: >- - GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo - description: Chunk information. + GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseRecentSearchSuggestion + description: Suggestions from recent search history. type: object properties: - chunk: - description: Chunk resource name. + suggestion: + description: The suggestion for the query. type: string - content: - description: Chunk textual content. + recentSearchTime: + description: The time when this recent rearch happened. type: string - documentMetadata: - description: Metadata of the document from the current chunk. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfoDocumentMetadata - GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfoDocumentMetadata: - id: >- - GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfoDocumentMetadata + format: google-datetime + score: + description: The score of each suggestion. The score is in the range of [0, 1]. + type: number + format: double + GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesRequest: + id: GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesRequest description: >- - Document metadata contains the information of the document of the - current chunk. + Request message for CompletionService.ImportSuggestionDenyListEntries + method. type: object properties: - uri: - description: Uri of the document. - type: string - title: - description: Title of the document. - type: string - GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpec: - id: GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpec - description: Query understanding specification. + inlineSource: + description: >- + The Inline source for the input content for suggestion deny list + entries. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesRequestInlineSource + gcsSource: + description: >- + Cloud Storage location for the input content. Only 1 file can be + specified that contains all entries to import. Supported values + `gcs_source.schema` for autocomplete suggestion deny list entry + imports: * `suggestion_deny_list` (default): One JSON + [SuggestionDenyListEntry] per line. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1GcsSource' + GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesRequestInlineSource: + id: >- + GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesRequestInlineSource + description: The inline source for SuggestionDenyListEntry. type: object properties: - queryClassificationSpec: - description: Query classification specification. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec - queryRephraserSpec: - description: Query rephraser specification. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec - GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec: - id: >- - GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec - description: Query classification specification. + entries: + description: >- + Required. A list of all denylist entries to import. Max of 1000 + items. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SuggestionDenyListEntry + GoogleCloudDiscoveryengineV1SuggestionDenyListEntry: + id: GoogleCloudDiscoveryengineV1SuggestionDenyListEntry + description: >- + Suggestion deny list entry identifying the phrase to block from + suggestions and the applied operation for the phrase. type: object properties: - types: - description: Enabled query classification types. + blockPhrase: + description: >- + Required. Phrase to block from suggestions served. Can be maximum + 125 characters. + type: string + matchOperator: + description: >- + Required. The match operator to apply for this phrase. Whether to + block the exact phrase, or block any suggestions containing this + phrase. + type: string + enumDescriptions: + - Default value. Should not be used + - >- + If the suggestion is an exact match to the block_phrase, then + block it. + - If the suggestion contains the block_phrase, then block it. + enum: + - MATCH_OPERATOR_UNSPECIFIED + - EXACT_MATCH + - CONTAINS + GoogleCloudDiscoveryengineV1GcsSource: + id: GoogleCloudDiscoveryengineV1GcsSource + description: Cloud Storage location for input content. + type: object + properties: + inputUris: + description: >- + Required. Cloud Storage URIs to input files. Each URI can be up to + 2000 characters long. URIs can match the full object path (for + example, `gs://bucket/directory/object.json`) or a pattern matching + one or more files, such as `gs://bucket/directory/*.json`. A request + can contain at most 100 files (or 100,000 files if `data_schema` is + `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` + is `content`). type: array items: type: string - enumDescriptions: - - Unspecified query classification type. - - Adversarial query classification type. - - Non-answer-seeking query classification type, for chit chat. - - Jail-breaking query classification type. - - >- - Non-answer-seeking query classification type, for no clear - intent. - enum: - - TYPE_UNSPECIFIED - - ADVERSARIAL_QUERY - - NON_ANSWER_SEEKING_QUERY - - JAIL_BREAKING_QUERY - - NON_ANSWER_SEEKING_QUERY_V2 - GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec: + dataSchema: + description: >- + The schema to use when parsing the data from the source. Supported + values for document imports: * `document` (default): One JSON + Document per line. Each document must have a valid Document.id. * + `content`: Unstructured data (e.g. PDF, HTML). Each file matched by + `input_uris` becomes a document, with the ID set to the first 128 + bits of SHA256(URI) encoded as a hex string. * `custom`: One custom + data JSON per row in arbitrary format that conforms to the defined + Schema of the data store. This can only be used by the GENERIC Data + Store vertical. * `csv`: A CSV file with header conforming to the + defined Schema of the data store. Each entry after the header is + imported as a Document. This can only be used by the GENERIC Data + Store vertical. Supported values for user event imports: * + `user_event` (default): One JSON UserEvent per line. + type: string + GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesRequest: + id: GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesRequest + description: >- + Request message for CompletionService.PurgeSuggestionDenyListEntries + method. + type: object + properties: {} + GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequest: + id: GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequest + description: >- + Request message for CompletionService.ImportCompletionSuggestions + method. + type: object + properties: + inlineSource: + description: The Inline source for suggestion entries. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequestInlineSource + gcsSource: + description: Cloud Storage location for the input content. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1GcsSource' + bigquerySource: + description: BigQuery input source. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1BigQuerySource' + errorConfig: + description: The desired location of errors incurred during the Import. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1ImportErrorConfig' + GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequestInlineSource: id: >- - GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec - description: Query rephraser specification. + GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequestInlineSource + description: The inline source for CompletionSuggestions. type: object properties: - disable: - description: Disable query rephraser. - type: boolean - maxRephraseSteps: + suggestions: description: >- - Max rephrase steps. The max number is 5 steps. If not set or set to - < 1, it will be set to 1 by default. - type: integer - format: int32 - GoogleCloudDiscoveryengineV1AnswerQueryResponse: - id: GoogleCloudDiscoveryengineV1AnswerQueryResponse - description: Response message for ConversationalSearchService.AnswerQuery method. + Required. A list of all denylist entries to import. Max of 1000 + items. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1CompletionSuggestion + GoogleCloudDiscoveryengineV1CompletionSuggestion: + id: GoogleCloudDiscoveryengineV1CompletionSuggestion + description: Autocomplete suggestions that are imported from Customer. type: object properties: - answer: + globalScore: description: >- - Answer resource object. If - AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps - is greater than 1, use Answer.name to fetch answer information using - ConversationalSearchService.GetAnswer API. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Answer' - session: + Global score of this suggestion. Control how this suggestion would + be scored / ranked. + type: number + format: double + frequency: description: >- - Session resource object. It will be only available when session - field is set and valid in the AnswerQueryRequest request. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Session' - answerQueryToken: - description: A global unique ID used for logging. + Frequency of this suggestion. Will be used to rank suggestions when + score is not available. type: string - GoogleCloudDiscoveryengineV1Answer: - id: GoogleCloudDiscoveryengineV1Answer - description: Defines an answer. - type: object - properties: - name: - description: >- - Immutable. Fully qualified name - `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*` + format: int64 + suggestion: + description: Required. The suggestion text. type: string - state: - description: The state of the answer generation. + languageCode: + description: BCP-47 language code of this suggestion. type: string - enumDescriptions: - - Unknown. - - Answer generation is currently in progress. - - Answer generation currently failed. - - Answer generation has succeeded. - enum: - - STATE_UNSPECIFIED - - IN_PROGRESS - - FAILED - - SUCCEEDED - answerText: - description: The textual answer. + groupId: + description: >- + If two suggestions have the same groupId, they will not be returned + together. Instead the one ranked higher will be returned. This can + be used to deduplicate semantically identical suggestions. type: string - citations: - description: Citations. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1AnswerCitation' - references: - description: References. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1AnswerReference' - relatedQuestions: - description: Suggested related questions. + groupScore: + description: The score of this suggestion within its group. + type: number + format: double + alternativePhrases: + description: Alternative matching phrases for this suggestion. type: array items: type: string - steps: - description: Answer generation steps. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1AnswerStep' - queryUnderstandingInfo: - description: Query understanding information. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfo - answerSkippedReasons: + GoogleCloudDiscoveryengineV1BigQuerySource: + id: GoogleCloudDiscoveryengineV1BigQuerySource + description: BigQuery source import data from. + type: object + properties: + partitionDate: description: >- - Additional answer-skipped reasons. This provides the reason for - ignored cases. If nothing is skipped, this field is not set. - type: array - items: - type: string - enumDescriptions: - - Default value. The answer skipped reason is not specified. - - The adversarial query ignored case. - - >- - The non-answer seeking query ignored case Google skips the - answer if the query is chit chat. - - >- - The out-of-domain query ignored case. Google skips the answer if - there are no high-relevance search results. - - >- - The potential policy violation case. Google skips the answer if - there is a potential policy violation detected. This includes - content that may be violent or toxic. - - >- - The no relevant content case. Google skips the answer if there - is no relevant content in the retrieved search results. - - >- - The jail-breaking query ignored case. For example, "Reply in the - tone of a competing company's CEO". Google skips the answer if - the query is classified as a jail-breaking query. - - >- - The customer policy violation case. Google skips the summary if - there is a customer policy violation detected. The policy is - defined by the customer. - - >- - The non-answer seeking query ignored case. Google skips the - answer if the query doesn't have clear intent. - - >- - The low-grounded answer case. Google skips the answer if a well - grounded answer was unable to be generated. - enum: - - ANSWER_SKIPPED_REASON_UNSPECIFIED - - ADVERSARIAL_QUERY_IGNORED - - NON_ANSWER_SEEKING_QUERY_IGNORED - - OUT_OF_DOMAIN_QUERY_IGNORED - - POTENTIAL_POLICY_VIOLATION - - NO_RELEVANT_CONTENT - - JAIL_BREAKING_QUERY_IGNORED - - CUSTOMER_POLICY_VIOLATION - - NON_ANSWER_SEEKING_QUERY_IGNORED_V2 - - LOW_GROUNDED_ANSWER - createTime: - description: Output only. Answer creation timestamp. - readOnly: true + BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD + format. + $ref: '#/components/schemas/GoogleTypeDate' + projectId: + description: >- + The project ID or the project number that contains the BigQuery + source. Has a length limit of 128 characters. If not specified, + inherits the project ID from the parent request. type: string - format: google-datetime - completeTime: - description: Output only. Answer completed timestamp. - readOnly: true + datasetId: + description: >- + Required. The BigQuery data set to copy the data from with a length + limit of 1,024 characters. type: string - format: google-datetime - GoogleCloudDiscoveryengineV1AnswerCitation: - id: GoogleCloudDiscoveryengineV1AnswerCitation - description: Citation info for a segment. - type: object - properties: - startIndex: + tableId: description: >- - Index indicates the start of the segment, measured in bytes (UTF-8 - unicode). + Required. The BigQuery table to copy the data from with a length + limit of 1,024 characters. type: string - format: int64 - endIndex: - description: End of the attributed segment, exclusive. + gcsStagingDir: + description: >- + Intermediate Cloud Storage directory used for the import with a + length limit of 2,000 characters. Can be specified if one wants to + have the BigQuery export to a specific Cloud Storage directory. type: string - format: int64 - sources: - description: Citation sources for the attributed segment. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1AnswerCitationSource - GoogleCloudDiscoveryengineV1AnswerCitationSource: - id: GoogleCloudDiscoveryengineV1AnswerCitationSource - description: Citation source. + dataSchema: + description: >- + The schema to use when parsing the data from the source. Supported + values for user event imports: * `user_event` (default): One + UserEvent per row. Supported values for document imports: * + `document` (default): One Document format per row. Each document + must have a valid Document.id and one of Document.json_data or + Document.struct_data. * `custom`: One custom data per row in + arbitrary format that conforms to the defined Schema of the data + store. This can only be used by the GENERIC Data Store vertical. + type: string + GoogleTypeDate: + id: GoogleTypeDate + description: >- + Represents a whole or partial calendar date, such as a birthday. The + time of day and time zone are either specified elsewhere or are + insignificant. The date is relative to the Gregorian Calendar. This can + represent one of the following: * A full date, with non-zero year, + month, and day values. * A month and day, with a zero year (for example, + an anniversary). * A year on its own, with a zero month and a zero day. + * A year and month, with a zero day (for example, a credit card + expiration date). Related types: * google.type.TimeOfDay * + google.type.DateTime * google.protobuf.Timestamp type: object properties: - referenceId: - description: ID of the citation source. + year: + description: >- + Year of the date. Must be from 1 to 9999, or 0 to specify a date + without a year. + type: integer + format: int32 + month: + description: >- + Month of a year. Must be from 1 to 12, or 0 to specify a year + without a month and day. + type: integer + format: int32 + day: + description: >- + Day of a month. Must be from 1 to 31 and valid for the year and + month, or 0 to specify a year by itself or a year and month where + the day isn't significant. + type: integer + format: int32 + GoogleCloudDiscoveryengineV1ImportErrorConfig: + id: GoogleCloudDiscoveryengineV1ImportErrorConfig + description: Configuration of destination for Import related errors. + type: object + properties: + gcsPrefix: + description: >- + Cloud Storage prefix for import errors. This must be an empty, + existing Cloud Storage directory. Import errors are written to + sharded files in this directory, one per line, as a JSON-encoded + `google.rpc.Status` message. type: string - GoogleCloudDiscoveryengineV1AnswerReference: - id: GoogleCloudDiscoveryengineV1AnswerReference - description: Reference. + GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsRequest: + id: GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsRequest + description: Request message for CompletionService.PurgeCompletionSuggestions method. + type: object + properties: {} + GoogleCloudDiscoveryengineV1Control: + id: GoogleCloudDiscoveryengineV1Control + description: >- + Defines a conditioned behavior to employ during serving. Must be + attached to a ServingConfig to be considered at serving time. Permitted + actions dependent on `SolutionType`. type: object properties: - unstructuredDocumentInfo: - description: Unstructured document information. + boostAction: + description: Defines a boost-type control + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1ControlBoostAction' + filterAction: + description: >- + Defines a filter-type control Currently not supported by + Recommendation + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1ControlFilterAction' + redirectAction: + description: Defines a redirect-type control. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfo - chunkInfo: - description: Chunk information. + #/components/schemas/GoogleCloudDiscoveryengineV1ControlRedirectAction + synonymsAction: + description: Treats a group of terms as synonyms of one another. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfo - structuredDocumentInfo: - description: Structured document information. + #/components/schemas/GoogleCloudDiscoveryengineV1ControlSynonymsAction + promoteAction: + description: Promote certain links based on predefined trigger queries. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1AnswerReferenceStructuredDocumentInfo - GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfo: - id: GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfo - description: Unstructured document information. - type: object - properties: - document: - description: Document resource name. + #/components/schemas/GoogleCloudDiscoveryengineV1ControlPromoteAction + name: + description: >- + Immutable. Fully qualified name + `projects/*/locations/global/dataStore/*/controls/*` type: string - uri: - description: URI for the document. + displayName: + description: >- + Required. Human readable name. The identifier used in UI views. Must + be UTF-8 encoded string. Length limit is 128 characters. Otherwise + an INVALID ARGUMENT error is thrown. type: string - title: - description: Title. + associatedServingConfigIds: + description: >- + Output only. List of all ServingConfig IDs this control is attached + to. May take up to 10 minutes to update after changes. + readOnly: true + type: array + items: + type: string + solutionType: + description: >- + Required. Immutable. What solution the control belongs to. Must be + compatible with vertical of resource. Otherwise an INVALID ARGUMENT + error is thrown. type: string - chunkContents: - description: List of cited chunk contents derived from document content. + enumDescriptions: + - Default value. + - Used for Recommendations AI. + - Used for Discovery Search. + - Used for use cases related to the Generative AI agent. + - >- + Used for use cases related to the Generative Chat agent. It's used + for Generative chat engine only, the associated data stores must + enrolled with `SOLUTION_TYPE_CHAT` solution. + enum: + - SOLUTION_TYPE_UNSPECIFIED + - SOLUTION_TYPE_RECOMMENDATION + - SOLUTION_TYPE_SEARCH + - SOLUTION_TYPE_CHAT + - SOLUTION_TYPE_GENERATIVE_CHAT + useCases: + description: >- + Specifies the use case for the control. Affects what condition + fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently + only allow one use case per control. Must be set when solution_type + is SolutionType.SOLUTION_TYPE_SEARCH. type: array items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfoChunkContent - structData: + type: string + enumDescriptions: + - Value used when unset. Will not occur in CSS. + - Search use case. Expects the traffic has a non-empty query. + - Browse use case. Expects the traffic has an empty query. + enum: + - SEARCH_USE_CASE_UNSPECIFIED + - SEARCH_USE_CASE_SEARCH + - SEARCH_USE_CASE_BROWSE + conditions: description: >- - The structured JSON metadata for the document. It is populated from - the struct data from the Chunk in search result. - type: object - additionalProperties: - type: any - description: Properties of the object. - GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfoChunkContent: - id: >- - GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfoChunkContent - description: Chunk content. + Determines when the associated action will trigger. Omit to always + apply the action. Currently only a single condition may be + specified. Otherwise an INVALID ARGUMENT error is thrown. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Condition' + GoogleCloudDiscoveryengineV1ControlBoostAction: + id: GoogleCloudDiscoveryengineV1ControlBoostAction + description: Adjusts order of products in returned list. type: object properties: - content: - description: Chunk textual content. - type: string - pageIdentifier: - description: Page identifier. - type: string - relevanceScore: + fixedBoost: description: >- - The relevance of the chunk for a given query. Values range from 0.0 - (completely irrelevant) to 1.0 (completely relevant). This value is - for informational purpose only. It may change for the same query and - chunk at any time due to a model retraining or change in - implementation. + Optional. Strength of the boost, which should be in [-1, 1]. + Negative boost means demotion. Default is 0.0 (No-op). type: number format: float - GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfo: - id: GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfo - description: Chunk information. - type: object - properties: - chunk: - description: Chunk resource name. - type: string - content: - description: Chunk textual content. - type: string - relevanceScore: + interpolationBoostSpec: description: >- - The relevance of the chunk for a given query. Values range from 0.0 - (completely irrelevant) to 1.0 (completely relevant). This value is - for informational purpose only. It may change for the same query and - chunk at any time due to a model retraining or change in - implementation. + Optional. Complex specification for custom ranking based on customer + defined attribute value. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec + boost: + description: >- + Strength of the boost, which should be in [-1, 1]. Negative boost + means demotion. Default is 0.0 (No-op). + deprecated: true type: number format: float - documentMetadata: - description: Document metadata. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfoDocumentMetadata - GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfoDocumentMetadata: - id: GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfoDocumentMetadata - description: Document metadata. - type: object - properties: - document: - description: Document resource name. - type: string - uri: - description: URI for the document. - type: string - title: - description: Title. - type: string - pageIdentifier: - description: Page identifier. + filter: + description: >- + Required. Specifies which products to apply the boost to. If no + filter is provided all products will be boosted (No-op). Syntax + documentation: https://cloud.google.com/retail/docs/filter-and-order + Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT + error is thrown. type: string - structData: + dataStore: description: >- - The structured JSON metadata for the document. It is populated from - the struct data from the Chunk in search result. - type: object - additionalProperties: - type: any - description: Properties of the object. - GoogleCloudDiscoveryengineV1AnswerReferenceStructuredDocumentInfo: - id: GoogleCloudDiscoveryengineV1AnswerReferenceStructuredDocumentInfo - description: Structured search information. - type: object - properties: - document: - description: Document resource name. + Required. Specifies which data store's documents can be boosted by + this control. Full data store name e.g. + projects/123/locations/global/collections/default_collection/dataStores/default_data_store type: string - structData: - description: Structured search data. - type: object - additionalProperties: - type: any - description: Properties of the object. - GoogleCloudDiscoveryengineV1AnswerStep: - id: GoogleCloudDiscoveryengineV1AnswerStep - description: Step information. + GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec: + id: GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec + description: >- + Specification for custom ranking based on customer specified attribute + value. It provides more controls for customized ranking than the simple + (condition, boost) combination above. type: object properties: - state: - description: The state of the step. + fieldName: + description: >- + Optional. The name of the field whose value will be used to + determine the boost amount. + type: string + attributeType: + description: >- + Optional. The attribute type to be used to determine the boost + amount. The attribute value can be derived from the field value of + the specified field_name. In the case of numerical it is + straightforward i.e. attribute_value = numerical_field_value. In the + case of freshness however, attribute_value = (time.now() - + datetime_field_value). type: string enumDescriptions: - - Unknown. - - Step is currently in progress. - - Step currently failed. - - Step has succeeded. + - Unspecified AttributeType. + - >- + The value of the numerical field will be used to dynamically + update the boost amount. In this case, the attribute_value (the x + value) of the control point will be the actual value of the + numerical field for which the boost_amount is specified. + - >- + For the freshness use case the attribute value will be the + duration between the current time and the date in the datetime + field specified. The value must be formatted as an XSD + `dayTimeDuration` value (a restricted subset of an ISO 8601 + duration value). The pattern for this is: `nDnM]`. For example, + `5D`, `3DT12H30M`, `T24H`. enum: - - STATE_UNSPECIFIED - - IN_PROGRESS - - FAILED - - SUCCEEDED - description: - description: The description of the step. - type: string - thought: - description: The thought of the step. + - ATTRIBUTE_TYPE_UNSPECIFIED + - NUMERICAL + - FRESHNESS + interpolationType: + description: >- + Optional. The interpolation type to be applied to connect the + control points listed below. type: string - actions: - description: Actions. + enumDescriptions: + - >- + Interpolation type is unspecified. In this case, it defaults to + Linear. + - Piecewise linear interpolation will be applied. + enum: + - INTERPOLATION_TYPE_UNSPECIFIED + - LINEAR + controlPoints: + description: >- + Optional. The control points used to define the curve. The monotonic + function (defined through the interpolation_type above) passes + through the control points listed here. type: array items: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1AnswerStepAction' - GoogleCloudDiscoveryengineV1AnswerStepAction: - id: GoogleCloudDiscoveryengineV1AnswerStepAction - description: Action. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint + GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint: + id: >- + GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint + description: >- + The control points used to define the curve. The curve defined through + these control points can only be monotonically increasing or + decreasing(constant values are acceptable). type: object properties: - searchAction: - description: Search action. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1AnswerStepActionSearchAction - observation: - description: Observation. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1AnswerStepActionObservation - GoogleCloudDiscoveryengineV1AnswerStepActionSearchAction: - id: GoogleCloudDiscoveryengineV1AnswerStepActionSearchAction - description: Search action. + attributeValue: + description: >- + Optional. Can be one of: 1. The numerical field value. 2. The + duration spec for freshness: The value must be formatted as an XSD + `dayTimeDuration` value (a restricted subset of an ISO 8601 duration + value). The pattern for this is: `nDnM]`. + type: string + boostAmount: + description: >- + Optional. The value between -1 to 1 by which to boost the score if + the attribute_value evaluates to the value specified above. + type: number + format: float + GoogleCloudDiscoveryengineV1ControlFilterAction: + id: GoogleCloudDiscoveryengineV1ControlFilterAction + description: >- + Specified which products may be included in results. Uses same filter as + boost. type: object properties: - query: - description: The query to search. + filter: + description: >- + Required. A filter to apply on the matching condition results. + Required Syntax documentation: + https://cloud.google.com/retail/docs/filter-and-order Maximum length + is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. type: string - GoogleCloudDiscoveryengineV1AnswerStepActionObservation: - id: GoogleCloudDiscoveryengineV1AnswerStepActionObservation - description: Observation. + dataStore: + description: >- + Required. Specifies which data store's documents can be filtered by + this control. Full data store name e.g. + projects/123/locations/global/collections/default_collection/dataStores/default_data_store + type: string + GoogleCloudDiscoveryengineV1ControlRedirectAction: + id: GoogleCloudDiscoveryengineV1ControlRedirectAction + description: Redirects a shopper to the provided URI. type: object properties: - searchResults: + redirectUri: description: >- - Search results observed by the search action, it can be snippets - info or chunk info, depending on the citation type set by the user. + Required. The URI to which the shopper will be redirected. Required. + URI must have length equal or less than 2000 characters. Otherwise + an INVALID ARGUMENT error is thrown. + type: string + GoogleCloudDiscoveryengineV1ControlSynonymsAction: + id: GoogleCloudDiscoveryengineV1ControlSynonymsAction + description: >- + Creates a set of terms that will act as synonyms of one another. + Example: "happy" will also be considered as "glad", "glad" will also be + considered as "happy". + type: object + properties: + synonyms: + description: >- + Defines a set of synonyms. Can specify up to 100 synonyms. Must + specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is + thrown. type: array items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResult - GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResult: - id: GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResult + type: string + GoogleCloudDiscoveryengineV1ControlPromoteAction: + id: GoogleCloudDiscoveryengineV1ControlPromoteAction + description: >- + Promote certain links based on some trigger queries. Example: Promote + shoe store link when searching for `shoe` keyword. The link can be + outside of associated data store. type: object properties: - document: - description: Document resource name. - type: string - uri: - description: URI for the document. - type: string - title: - description: Title. + dataStore: + description: Required. Data store with which this promotion is attached to. type: string - snippetInfo: + searchLinkPromotion: + description: Required. Promotion attached to this action. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1SearchLinkPromotion' + GoogleCloudDiscoveryengineV1Condition: + id: GoogleCloudDiscoveryengineV1Condition + description: Defines circumstances to be checked before allowing a behavior + type: object + properties: + queryTerms: description: >- - If citation_type is DOCUMENT_LEVEL_CITATION, populate document level - snippets. + Search only A list of terms to match the query on. Cannot be set + when Condition.query_regex is set. Maximum of 10 query terms. type: array items: $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo - chunkInfo: + #/components/schemas/GoogleCloudDiscoveryengineV1ConditionQueryTerm + activeTimeRange: description: >- - If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, - populate chunk info. + Range of time(s) specifying when condition is active. Maximum of 10 + time ranges. type: array items: $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultChunkInfo - structData: + #/components/schemas/GoogleCloudDiscoveryengineV1ConditionTimeRange + queryRegex: description: >- - Data representation. The structured JSON data for the document. It's - populated from the struct data from the Document, or the Chunk in - search result. - type: object - additionalProperties: - type: any - description: Properties of the object. - GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo: - id: >- - GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo - description: Snippet information. + Optional. Query regex to match the whole search query. Cannot be set + when Condition.query_terms is set. Only supported for Basic Site + Search promotion serving controls. + type: string + GoogleCloudDiscoveryengineV1ConditionQueryTerm: + id: GoogleCloudDiscoveryengineV1ConditionQueryTerm + description: Matcher for search request query type: object properties: - snippet: - description: Snippet content. - type: string - snippetStatus: - description: Status of the snippet defined by the search team. + value: + description: >- + The specific query value to match against Must be lowercase, must be + UTF-8. Can have at most 3 space separated terms if full_match is + true. Cannot be an empty string. Maximum length of 5000 characters. type: string - GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultChunkInfo: - id: >- - GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultChunkInfo - description: Chunk information. + fullMatch: + description: Whether the search query needs to exactly match the query term. + type: boolean + GoogleCloudDiscoveryengineV1ConditionTimeRange: + id: GoogleCloudDiscoveryengineV1ConditionTimeRange + description: Used for time-dependent conditions. type: object properties: - chunk: - description: Chunk resource name. + startTime: + description: Start of time range. Range is inclusive. type: string - content: - description: Chunk textual content. + format: google-datetime + endTime: + description: End of time range. Range is inclusive. Must be in the future. type: string - relevanceScore: - description: >- - The relevance of the chunk for a given query. Values range from 0.0 - (completely irrelevant) to 1.0 (completely relevant). This value is - for informational purpose only. It may change for the same query and - chunk at any time due to a model retraining or change in - implementation. - type: number - format: float - GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfo: - id: GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfo - description: Query understanding information. + format: google-datetime + GoogleCloudDiscoveryengineV1ListControlsResponse: + id: GoogleCloudDiscoveryengineV1ListControlsResponse + description: Response for ListControls method. type: object properties: - queryClassificationInfo: - description: Query classification information. + controls: + description: All the Controls for a given data store. type: array items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfoQueryClassificationInfo - GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfoQueryClassificationInfo: - id: >- - GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfoQueryClassificationInfo - description: Query classification information. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' + nextPageToken: + description: Pagination token, if not returned indicates the last page. + type: string + GoogleCloudDiscoveryengineV1ConverseConversationRequest: + id: GoogleCloudDiscoveryengineV1ConverseConversationRequest + description: >- + Request message for ConversationalSearchService.ConverseConversation + method. type: object properties: - type: - description: Query classification type. + query: + description: Required. Current user input. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1TextInput' + servingConfig: + description: >- + The resource name of the Serving Config to use. Format: + `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` + If this is not set, the default serving config will be used. type: string - enumDescriptions: - - Unspecified query classification type. - - Adversarial query classification type. - - Non-answer-seeking query classification type, for chit chat. - - Jail-breaking query classification type. - - Non-answer-seeking query classification type, for no clear intent. - enum: - - TYPE_UNSPECIFIED - - ADVERSARIAL_QUERY - - NON_ANSWER_SEEKING_QUERY - - JAIL_BREAKING_QUERY - - NON_ANSWER_SEEKING_QUERY_V2 - positive: - description: Classification output. + conversation: + description: >- + The conversation to be used by auto session only. The name field + will be ignored as we automatically assign new name for the + conversation in auto session. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' + safeSearch: + description: Whether to turn on safe search. type: boolean - GoogleCloudDiscoveryengineV1Session: - id: GoogleCloudDiscoveryengineV1Session - description: External session proto definition. + userLabels: + description: >- + The user labels applied to a resource must meet the following + requirements: * Each resource can have multiple labels, up to a + maximum of 64. * Each label must be a key-value pair. * Keys have a + minimum length of 1 character and a maximum length of 63 characters + and cannot be empty. Values can be empty and have a maximum length + of 63 characters. * Keys and values can contain only lowercase + letters, numeric characters, underscores, and dashes. All characters + must use UTF-8 encoding, and international characters are allowed. * + The key portion of a label must be unique. However, you can use the + same key with multiple resources. * Keys must start with a lowercase + letter or international character. See [Google Cloud + Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) + for more details. + type: object + additionalProperties: + type: string + summarySpec: + description: >- + A specification for configuring the summary returned in the + response. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec + filter: + description: >- + The filter syntax consists of an expression language for + constructing a predicate from one or more fields of the documents + being filtered. Filter expression is case-sensitive. This will be + used to filter search results which may affect the summary response. + If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. + Filtering in Vertex AI Search is done by mapping the LHS filter key + to a key property defined in the Vertex AI Search backend -- this + mapping is defined by the customer in their schema. For example a + media customer might have a field 'name' in their schema. In this + case the filter would look like this: filter --> name:'ANY("king + kong")' For more information about filtering including syntax and + filter operators, see + [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + type: string + boostSpec: + description: >- + Boost specification to boost certain documents in search results + which may affect the converse response. For more information on + boosting, see + [Boosting](https://cloud.google.com/retail/docs/boosting#boost) + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestBoostSpec + GoogleCloudDiscoveryengineV1TextInput: + id: GoogleCloudDiscoveryengineV1TextInput + description: Defines text input. + type: object + properties: + input: + description: Text input. + type: string + context: + description: Conversation context of the input. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1ConversationContext' + GoogleCloudDiscoveryengineV1ConversationContext: + id: GoogleCloudDiscoveryengineV1ConversationContext + description: Defines context of the conversation + type: object + properties: + contextDocuments: + description: >- + The current list of documents the user is seeing. It contains the + document resource references. + type: array + items: + type: string + activeDocument: + description: >- + The current active document the user opened. It contains the + document resource reference. + type: string + GoogleCloudDiscoveryengineV1Conversation: + id: GoogleCloudDiscoveryengineV1Conversation + description: External conversation proto definition. type: object properties: name: description: >- Immutable. Fully qualified name - `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` + `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*` + or + `projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*`. type: string state: - description: The state of the session. + description: The state of the Conversation. type: string enumDescriptions: - - State is unspecified. - - The session is currently open. + - Unknown. + - Conversation is currently open. + - Conversation has been completed. enum: - STATE_UNSPECIFIED - IN_PROGRESS + - COMPLETED userPseudoId: description: A unique identifier for tracking users. type: string - turns: - description: Turns. + messages: + description: Conversation messages. type: array items: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1SessionTurn' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ConversationMessage startTime: - description: Output only. The time the session started. + description: Output only. The time the conversation started. readOnly: true type: string format: google-datetime endTime: - description: Output only. The time the session finished. + description: Output only. The time the conversation finished. readOnly: true type: string format: google-datetime - GoogleCloudDiscoveryengineV1SessionTurn: - id: GoogleCloudDiscoveryengineV1SessionTurn - description: >- - Represents a turn, including a query from the user and a answer from - service. - type: object - properties: - query: - description: The user query. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Query' - answer: - description: >- - The resource name of the answer to the user query. Only set if the - answer generation (/answer API call) happened in this turn. - type: string - GoogleCloudDiscoveryengineV1ListSessionsResponse: - id: GoogleCloudDiscoveryengineV1ListSessionsResponse - description: Response for ListSessions method. + GoogleCloudDiscoveryengineV1ConversationMessage: + id: GoogleCloudDiscoveryengineV1ConversationMessage + description: Defines a conversation message. type: object properties: - sessions: - description: All the Sessions for a given data store. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Session' - nextPageToken: - description: Pagination token, if not returned indicates the last page. + userInput: + description: User text input. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1TextInput' + reply: + description: Search reply. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Reply' + createTime: + description: Output only. Message creation timestamp. + readOnly: true type: string - GoogleCloudDiscoveryengineV1DataStore: - id: GoogleCloudDiscoveryengineV1DataStore - description: DataStore captures global settings and configs at the DataStore level. + format: google-datetime + GoogleCloudDiscoveryengineV1Reply: + id: GoogleCloudDiscoveryengineV1Reply + description: Defines a reply message to user. type: object properties: - name: - description: >- - Immutable. The full resource name of the data store. Format: - `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. - This field must be a UTF-8 encoded string with a length limit of - 1024 characters. - type: string - displayName: - description: >- - Required. The data store display name. This field must be a UTF-8 - encoded string with a length limit of 128 characters. Otherwise, an - INVALID_ARGUMENT error is returned. - type: string - industryVertical: - description: Immutable. The industry vertical that the data store registers. - type: string - enumDescriptions: - - Value used when unset. - - >- - The generic vertical for documents that are not specific to any - industry vertical. - - The media industry vertical. - - The healthcare FHIR vertical. - enum: - - INDUSTRY_VERTICAL_UNSPECIFIED - - GENERIC - - MEDIA - - HEALTHCARE_FHIR - solutionTypes: - description: >- - The solutions that the data store enrolls. Available solutions for - each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` - and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` - is automatically enrolled. Other solutions cannot be enrolled. + summary: + description: Summary based on search results. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponseSummary + GoogleCloudDiscoveryengineV1ConverseConversationResponse: + id: GoogleCloudDiscoveryengineV1ConverseConversationResponse + description: >- + Response message for ConversationalSearchService.ConverseConversation + method. + type: object + properties: + reply: + description: Answer to the current query. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Reply' + conversation: + description: Updated conversation including the answer. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' + searchResults: + description: Search Results. type: array items: - type: string - enumDescriptions: - - Default value. - - Used for Recommendations AI. - - Used for Discovery Search. - - Used for use cases related to the Generative AI agent. - - >- - Used for use cases related to the Generative Chat agent. It's - used for Generative chat engine only, the associated data stores - must enrolled with `SOLUTION_TYPE_CHAT` solution. - enum: - - SOLUTION_TYPE_UNSPECIFIED - - SOLUTION_TYPE_RECOMMENDATION - - SOLUTION_TYPE_SEARCH - - SOLUTION_TYPE_CHAT - - SOLUTION_TYPE_GENERATIVE_CHAT - defaultSchemaId: - description: >- - Output only. The id of the default Schema asscociated to this data - store. - readOnly: true + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponseSearchResult + GoogleCloudDiscoveryengineV1ListConversationsResponse: + id: GoogleCloudDiscoveryengineV1ListConversationsResponse + description: Response for ListConversations method. + type: object + properties: + conversations: + description: All the Conversations for a given data store. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' + nextPageToken: + description: Pagination token, if not returned indicates the last page. type: string - contentConfig: + GoogleCloudDiscoveryengineV1AnswerQueryRequest: + id: GoogleCloudDiscoveryengineV1AnswerQueryRequest + description: Request message for ConversationalSearchService.AnswerQuery method. + type: object + properties: + query: + description: Required. Current user query. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Query' + session: description: >- - Immutable. The content config of the data store. If this field is - unset, the server behavior defaults to ContentConfig.NO_CONTENT. - type: string - enumDescriptions: - - Default value. - - Only contains documents without any Document.content. - - Only contains documents with Document.content. - - The data store is used for public website search. - - >- - The data store is used for workspace search. Details of workspace - data store are specified in the WorkspaceConfig. - enum: - - CONTENT_CONFIG_UNSPECIFIED - - NO_CONTENT - - CONTENT_REQUIRED - - PUBLIC_WEBSITE - - GOOGLE_WORKSPACE - createTime: - description: Output only. Timestamp the DataStore was created at. - readOnly: true + The session resource name. Not required. When session field is not + set, the API is in sessionless mode. We support auto session mode: + users can use the wildcard symbol `-` as session ID. A new ID will + be automatically generated and assigned. type: string - format: google-datetime - advancedSiteSearchConfig: - description: Optional. Configuration for advanced site search. + safetySpec: + description: Model specification. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig - kmsKeyName: - description: >- - Input only. The KMS key to be used to protect this DataStore at - creation time. Must be set for requests that need to comply with - CMEK Org Policy protections. If this field is set and processed - successfully, the DataStore will be protected by the KMS key, as - indicated in the cmek_config field. - type: string - cmekConfig: - description: Output only. CMEK-related information for the DataStore. - readOnly: true - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1CmekConfig' - billingEstimation: - description: Output only. Data size estimation for billing. - readOnly: true + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpec + relatedQuestionsSpec: + description: Related questions specification. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1DataStoreBillingEstimation - workspaceConfig: - description: >- - Config to store data store type configuration for workspace data. - This must be set when DataStore.content_config is set as - DataStore.ContentConfig.GOOGLE_WORKSPACE. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1WorkspaceConfig' - documentProcessingConfig: - description: Configuration for Document understanding and enrichment. + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequestRelatedQuestionsSpec + groundingSpec: + description: Optional. Grounding specification. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1DocumentProcessingConfig - startingSchema: + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequestGroundingSpec + answerGenerationSpec: + description: Answer generation specification. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec + searchSpec: + description: Search specification. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpec + queryUnderstandingSpec: + description: Query understanding specification. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpec + asynchronousMode: description: >- - The start schema to use for this DataStore when provisioning it. If - unset, a default vertical specialized schema will be used. This - field is only used by CreateDataStore API, and will be ignored if - used in other APIs. This field will be omitted from all API - responses including CreateDataStore API. To retrieve a schema of a - DataStore, use SchemaService.GetSchema API instead. The provided - schema will be validated against certain rules on schema. Learn more - from [this - doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Schema' - servingConfigDataStore: - description: Optional. Stores serving config at DataStore level. + Deprecated: This field is deprecated. Streaming Answer API will be + supported. Asynchronous mode control. If enabled, the response will + be returned with answer/session resource name without final answer. + The API users need to do the polling to get the latest status of + answer/session by calling ConversationalSearchService.GetAnswer or + ConversationalSearchService.GetSession method. + deprecated: true + type: boolean + userPseudoId: + description: >- + A unique identifier for tracking visitors. For example, this could + be implemented with an HTTP cookie, which should be able to uniquely + identify a visitor on a single device. This unique identifier should + not change if the visitor logs in or out of the website. This field + should NOT have a fixed value such as `unknown_visitor`. The field + must be a UTF-8 encoded string with a length limit of 128 + characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + type: string + userLabels: + description: >- + The user labels applied to a resource must meet the following + requirements: * Each resource can have multiple labels, up to a + maximum of 64. * Each label must be a key-value pair. * Keys have a + minimum length of 1 character and a maximum length of 63 characters + and cannot be empty. Values can be empty and have a maximum length + of 63 characters. * Keys and values can contain only lowercase + letters, numeric characters, underscores, and dashes. All characters + must use UTF-8 encoding, and international characters are allowed. * + The key portion of a label must be unique. However, you can use the + same key with multiple resources. * Keys must start with a lowercase + letter or international character. See [Google Cloud + Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) + for more details. + type: object + additionalProperties: + type: string + endUserSpec: + description: Optional. End user specification. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore - GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig: - id: GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig - description: Configuration data for advance site search. - type: object - properties: {} - GoogleCloudDiscoveryengineV1CmekConfig: - id: GoogleCloudDiscoveryengineV1CmekConfig - description: Configurations used to enable CMEK data encryption with Cloud KMS keys. + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpec + GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpec: + id: GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpec + description: >- + Safety specification. There are two use cases: 1. when only + safety_spec.enable is set, the BLOCK_LOW_AND_ABOVE threshold will be + applied for all categories. 2. when safety_spec.enable is set and some + safety_settings are set, only specified safety_settings are applied. type: object properties: - name: - description: >- - Required. Name of the CmekConfig, of the form - `projects/{project}/locations/{location}/cmekConfig` or - `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`. - type: string - kmsKey: + enable: description: >- - Kms key resource name which will be used to encrypt resources - `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. - type: string - kmsKeyVersion: + Enable the safety filtering on the answer response. It is false by + default. + type: boolean + safetySettings: description: >- - Kms key version resource name which will be used to encrypt - resources `/cryptoKeyVersions/{keyVersion}`. + Optional. Safety settings. This settings are effective only when the + safety_spec.enable is true. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpecSafetySetting + GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpecSafetySetting: + id: GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpecSafetySetting + description: Safety settings. + type: object + properties: + category: + description: Required. Harm category. type: string - state: - description: Output only. State of the CmekConfig. - readOnly: true + enumDescriptions: + - The harm category is unspecified. + - The harm category is hate speech. + - The harm category is dangerous content. + - The harm category is harassment. + - The harm category is sexually explicit content. + - The harm category is civic integrity. + enum: + - HARM_CATEGORY_UNSPECIFIED + - HARM_CATEGORY_HATE_SPEECH + - HARM_CATEGORY_DANGEROUS_CONTENT + - HARM_CATEGORY_HARASSMENT + - HARM_CATEGORY_SEXUALLY_EXPLICIT + - HARM_CATEGORY_CIVIC_INTEGRITY + threshold: + description: Required. The harm block threshold. type: string enumDescriptions: - - The CmekConfig state is unknown. - - The CmekConfig is creating. - - The CmekConfig can be used with DataStores. - - >- - The CmekConfig is unavailable, most likely due to the KMS Key - being revoked. - - The CmekConfig is deleting. - - >- - The CmekConfig is not usable, most likely due to some internal - issue. - - The KMS key version is being rotated. + - Unspecified harm block threshold. + - Block low threshold and above (i.e. block more). + - Block medium threshold and above. + - Block only high threshold (i.e. block less). + - Block none. + - Turn off the safety filter. enum: - - STATE_UNSPECIFIED - - CREATING - - ACTIVE - - KEY_ISSUE - - DELETING - - UNUSABLE - - ACTIVE_ROTATING - isDefault: - description: Output only. The default CmekConfig for the Customer. - readOnly: true - type: boolean - lastRotationTimestampMicros: - description: Output only. The timestamp of the last key rotation. - readOnly: true - type: string - format: int64 - GoogleCloudDiscoveryengineV1DataStoreBillingEstimation: - id: GoogleCloudDiscoveryengineV1DataStoreBillingEstimation - description: Estimation of data size per data store. + - HARM_BLOCK_THRESHOLD_UNSPECIFIED + - BLOCK_LOW_AND_ABOVE + - BLOCK_MEDIUM_AND_ABOVE + - BLOCK_ONLY_HIGH + - BLOCK_NONE + - 'OFF' + GoogleCloudDiscoveryengineV1AnswerQueryRequestRelatedQuestionsSpec: + id: GoogleCloudDiscoveryengineV1AnswerQueryRequestRelatedQuestionsSpec + description: Related questions specification. type: object properties: - structuredDataSize: - description: Data size for structured data in terms of bytes. - type: string - format: int64 - unstructuredDataSize: - description: Data size for unstructured data in terms of bytes. - type: string - format: int64 - websiteDataSize: - description: Data size for websites in terms of bytes. - type: string - format: int64 - structuredDataUpdateTime: - description: Last updated timestamp for structured data. - type: string - format: google-datetime - unstructuredDataUpdateTime: - description: Last updated timestamp for unstructured data. - type: string - format: google-datetime - websiteDataUpdateTime: - description: Last updated timestamp for websites. - type: string - format: google-datetime - GoogleCloudDiscoveryengineV1WorkspaceConfig: - id: GoogleCloudDiscoveryengineV1WorkspaceConfig - description: Config to store data store type configuration for workspace data + enable: + description: Enable related questions feature if true. + type: boolean + GoogleCloudDiscoveryengineV1AnswerQueryRequestGroundingSpec: + id: GoogleCloudDiscoveryengineV1AnswerQueryRequestGroundingSpec + description: Grounding specification. type: object properties: - type: - description: The Google Workspace data source. - type: string - enumDescriptions: - - Defaults to an unspecified Workspace type. - - Workspace Data Store contains Drive data - - Workspace Data Store contains Mail data - - Workspace Data Store contains Sites data - - Workspace Data Store contains Calendar data - - Workspace Data Store contains Chat data - - Workspace Data Store contains Groups data - - Workspace Data Store contains Keep data - enum: - - TYPE_UNSPECIFIED - - GOOGLE_DRIVE - - GOOGLE_MAIL - - GOOGLE_SITES - - GOOGLE_CALENDAR - - GOOGLE_CHAT - - GOOGLE_GROUPS - - GOOGLE_KEEP - dasherCustomerId: - description: Obfuscated Dasher customer ID. - type: string - superAdminServiceAccount: + includeGroundingSupports: description: >- - Optional. The super admin service account for the workspace that - will be used for access token generation. For now we only use it for - Native Google Drive connector data ingestion. - type: string - superAdminEmailAddress: + Optional. Specifies whether to include grounding_supports in the + answer. The default value is `false`. When this field is set to + `true`, returned answer will have `grounding_score` and will contain + GroundingSupports for each claim. + type: boolean + filteringLevel: description: >- - Optional. The super admin email address for the workspace that will - be used for access token generation. For now we only use it for - Native Google Drive connector data ingestion. + Optional. Specifies whether to enable the filtering based on + grounding score and at what level. type: string - GoogleCloudDiscoveryengineV1DocumentProcessingConfig: - id: GoogleCloudDiscoveryengineV1DocumentProcessingConfig - description: >- - A singleton resource of DataStore. If it's empty when DataStore is - created and DataStore is set to - DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will - default to digital parser. + enumDescriptions: + - Default is no filter + - Filter answers based on a low threshold. + - Filter answers based on a high threshold. + enum: + - FILTERING_LEVEL_UNSPECIFIED + - FILTERING_LEVEL_LOW + - FILTERING_LEVEL_HIGH + GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec: + id: GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec + description: Answer generation specification. type: object properties: - name: + modelSpec: + description: Answer generation model specification. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecModelSpec + promptSpec: + description: Answer generation prompt specification. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecPromptSpec + includeCitations: description: >- - The full resource name of the Document Processing Config. Format: - `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. + Specifies whether to include citation metadata in the answer. The + default value is `false`. + type: boolean + answerLanguageCode: + description: >- + Language code for Answer. Use language tags defined by + [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is + an experimental feature. type: string - chunkingConfig: - description: Whether chunking mode is enabled. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig - defaultParsingConfig: + ignoreAdversarialQuery: description: >- - Configurations for default Document parser. If not specified, we - will configure it as default DigitalParsingConfig, and the default - parsing config will be applied to all file types for Document - parsing. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig - parsingConfigOverrides: + Specifies whether to filter out adversarial queries. The default + value is `false`. Google employs search-query classification to + detect adversarial queries. No answer is returned if the search + query is classified as an adversarial query. For example, a user + might ask a question regarding negative comments about the company + or submit a query designed to generate unsafe, policy-violating + output. If this field is set to `true`, we skip generating answers + for adversarial queries and return fallback messages instead. + type: boolean + ignoreNonAnswerSeekingQuery: description: >- - Map from file type to override the default parsing configuration - based on the file type. Supported keys: * `pdf`: Override parsing - config for PDF files, either digital parsing, ocr parsing or layout - parsing is supported. * `html`: Override parsing config for HTML - files, only digital parsing and layout parsing are supported. * - `docx`: Override parsing config for DOCX files, only digital parsing - and layout parsing are supported. * `pptx`: Override parsing config - for PPTX files, only digital parsing and layout parsing are - supported. * `xlsm`: Override parsing config for XLSM files, only - digital parsing and layout parsing are supported. * `xlsx`: Override - parsing config for XLSX files, only digital parsing and layout - parsing are supported. - type: object - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig - GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig: - id: GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig - description: Configuration for chunking config. - type: object - properties: - layoutBasedChunkingConfig: - description: Configuration for the layout based chunking. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig - GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig: - id: >- - GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig - description: Configuration for the layout based chunking. - type: object - properties: - chunkSize: + Specifies whether to filter out queries that are not answer-seeking. + The default value is `false`. Google employs search-query + classification to detect answer-seeking queries. No answer is + returned if the search query is classified as a non-answer seeking + query. If this field is set to `true`, we skip generating answers + for non-answer seeking queries and return fallback messages instead. + type: boolean + ignoreLowRelevantContent: description: >- - The token size limit for each chunk. Supported values: 100-500 - (inclusive). Default value: 500. - type: integer - format: int32 - includeAncestorHeadings: + Specifies whether to filter out queries that have low relevance. If + this field is set to `false`, all search results are used regardless + of relevance to generate answers. If set to `true` or unset, the + behavior will be determined automatically by the service. + type: boolean + ignoreJailBreakingQuery: description: >- - Whether to include appending different levels of headings to chunks - from the middle of the document to prevent context loss. Default - value: False. + Optional. Specifies whether to filter out jail-breaking queries. The + default value is `false`. Google employs search-query classification + to detect jail-breaking queries. No summary is returned if the + search query is classified as a jail-breaking query. A user might + add instructions to the query to change the tone, style, language, + content of the answer, or ask the model to act as a different + entity, e.g. "Reply in the tone of a competing company's CEO". If + this field is set to `true`, we skip generating summaries for + jail-breaking queries and return fallback messages instead. type: boolean - GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig: - id: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig - description: Related configurations applied to a specific type of document parser. + GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecModelSpec: + id: >- + GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecModelSpec + description: Answer Generation Model specification. type: object properties: - digitalParsingConfig: - description: Configurations applied to digital parser. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig - ocrParsingConfig: + modelVersion: description: >- - Configurations applied to OCR parser. Currently it only applies to - PDFs. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig - layoutParsingConfig: - description: Configurations applied to layout parser. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig - GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig: - id: >- - GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig - description: The digital parsing configurations for documents. - type: object - properties: {} - GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig: + Model version. If not set, it will use the default stable model. + Allowed values are: stable, preview. + type: string + GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecPromptSpec: id: >- - GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig - description: The OCR parsing configurations for documents. + GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecPromptSpec + description: Answer generation prompt specification. type: object properties: - enhancedDocumentElements: - description: >- - [DEPRECATED] This field is deprecated. To use the additional - enhanced document elements processing, please switch to - `layout_parsing_config`. - deprecated: true - type: array - items: - type: string - useNativeText: - description: >- - If true, will use native text instead of OCR text on pages - containing native text. - type: boolean - GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig: - id: >- - GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig - description: The layout parsing configurations for documents. - type: object - properties: {} - GoogleCloudDiscoveryengineV1Schema: - id: GoogleCloudDiscoveryengineV1Schema - description: Defines the structure and layout of a type of document data. - type: object - properties: - structSchema: - description: The structured representation of the schema. - type: object - additionalProperties: - type: any - description: Properties of the object. - jsonSchema: - description: The JSON representation of the schema. - type: string - name: - description: >- - Immutable. The full resource name of the schema, in the format of - `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. - This field must be a UTF-8 encoded string with a length limit of - 1024 characters. + preamble: + description: Customized preamble. type: string - GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore: - id: GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore - description: >- - Stores information regarding the serving configurations at DataStore - level. + GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpec: + id: GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpec + description: Search specification. type: object properties: - disabledForServing: - description: >- - If set true, the DataStore will not be available for serving search - requests. - type: boolean - GoogleCloudDiscoveryengineV1ListDataStoresResponse: - id: GoogleCloudDiscoveryengineV1ListDataStoresResponse - description: Response message for DataStoreService.ListDataStores method. + searchParams: + description: Search parameters. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams + searchResultList: + description: Search result list. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultList + GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams: + id: GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams + description: Search parameters. type: object properties: - dataStores: - description: All the customer's DataStores. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1DataStore' - nextPageToken: + maxReturnResults: + description: Number of search results to return. The default value is 10. + type: integer + format: int32 + filter: description: >- - A token that can be sent as ListDataStoresRequest.page_token to - retrieve the next page. If this field is omitted, there are no - subsequent pages. + The filter syntax consists of an expression language for + constructing a predicate from one or more fields of the documents + being filtered. Filter expression is case-sensitive. This will be + used to filter search results which may affect the Answer response. + If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. + Filtering in Vertex AI Search is done by mapping the LHS filter key + to a key property defined in the Vertex AI Search backend -- this + mapping is defined by the customer in their schema. For example a + media customers might have a field 'name' in their schema. In this + case the filter would look like this: filter --> name:'ANY("king + kong")' For more information about filtering including syntax and + filter operators, see + [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) type: string - GoogleCloudDiscoveryengineV1ListDocumentsResponse: - id: GoogleCloudDiscoveryengineV1ListDocumentsResponse - description: Response message for DocumentService.ListDocuments method. - type: object - properties: - documents: - description: The Documents. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' - nextPageToken: + boostSpec: description: >- - A token that can be sent as ListDocumentsRequest.page_token to - retrieve the next page. If this field is omitted, there are no - subsequent pages. - type: string - GoogleCloudDiscoveryengineV1ImportDocumentsRequest: - id: GoogleCloudDiscoveryengineV1ImportDocumentsRequest - description: Request message for Import methods. - type: object - properties: - inlineSource: - description: The Inline source for the input content for documents. + Boost specification to boost certain documents in search results + which may affect the answer query response. For more information on + boosting, see + [Boosting](https://cloud.google.com/retail/docs/boosting#boost) $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ImportDocumentsRequestInlineSource - gcsSource: - description: Cloud Storage location for the input content. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1GcsSource' - bigquerySource: - description: BigQuery input source. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1BigQuerySource' - fhirStoreSource: - description: FhirStore input source. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1FhirStoreSource' - spannerSource: - description: Spanner input source. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1SpannerSource' - cloudSqlSource: - description: Cloud SQL input source. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1CloudSqlSource' - firestoreSource: - description: Firestore input source. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1FirestoreSource' - alloyDbSource: - description: AlloyDB input source. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1AlloyDbSource' - bigtableSource: - description: Cloud Bigtable input source. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1BigtableSource' - errorConfig: - description: The desired location of errors incurred during the Import. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1ImportErrorConfig' - reconciliationMode: + #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestBoostSpec + orderBy: description: >- - The mode of reconciliation between existing documents and the - documents to be imported. Defaults to - ReconciliationMode.INCREMENTAL. + The order in which documents are returned. Documents can be ordered + by a field in an Document object. Leave it unset if ordered by + relevance. `order_by` expression is case-sensitive. For more + information on ordering, see + [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) + If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. + type: string + searchResultMode: + description: >- + Specifies the search result mode. If unspecified, the search result + mode defaults to `DOCUMENTS`. See [parse and chunk + documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) type: string enumDescriptions: - - Defaults to `INCREMENTAL`. - - Inserts new documents or updates existing documents. + - Default value. + - Returns documents in the search result. - >- - Calculates diff and replaces the entire document dataset. Existing - documents may be deleted if they are not present in the source - location. + Returns chunks in the search result. Only available if the + DocumentProcessingConfig.chunking_config is specified. enum: - - RECONCILIATION_MODE_UNSPECIFIED - - INCREMENTAL - - FULL - updateMask: - description: >- - Indicates which fields in the provided imported documents to update. - If not set, the default is to update all fields. - type: string - format: google-fieldmask - autoGenerateIds: - description: >- - Whether to automatically generate IDs for the documents if absent. - If set to `true`, Document.ids are automatically generated based on - the hash of the payload, where IDs may not be consistent during - multiple imports. In which case ReconciliationMode.FULL is highly - recommended to avoid duplicate contents. If unset or set to `false`, - Document.ids have to be specified using id_field, otherwise, - documents without IDs fail to be imported. Supported data sources: * - GcsSource. GcsSource.data_schema must be `custom` or `csv`. - Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. - BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an - INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. - * FirestoreSource. * BigtableSource. - type: boolean - idField: + - SEARCH_RESULT_MODE_UNSPECIFIED + - DOCUMENTS + - CHUNKS + dataStoreSpecs: description: >- - The field indicates the ID field or column to be used as unique IDs - of the documents. For GcsSource it is the key of the JSON field. For - instance, `my_id` for JSON `{"my_id": "some_uuid"}`. For others, it - may be the column name of the table where the unique ids are stored. - The values of the JSON field or the table column are used as the - Document.ids. The JSON field or the table column must be of string - type, and the values must be set as valid strings conform to - [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 - characters. Otherwise, documents without valid IDs fail to be - imported. Only set this field when auto_generate_ids is unset or set - as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is - unset, a default value `_id` is used when importing from the allowed - data sources. Supported data sources: * GcsSource. - GcsSource.data_schema must be `custom` or `csv`. Otherwise, an - INVALID_ARGUMENT error is thrown. * BigQuerySource. - BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an - INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. - * FirestoreSource. * BigtableSource. - type: string - GoogleCloudDiscoveryengineV1ImportDocumentsRequestInlineSource: - id: GoogleCloudDiscoveryengineV1ImportDocumentsRequestInlineSource - description: The inline source for the input config for ImportDocuments method. + Specs defining dataStores to filter on in a search call and + configurations for those dataStores. This is only considered for + engines with multiple dataStores use case. For single dataStore + within an engine, they should use the specs at the top level. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec + GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultList: + id: GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultList + description: Search result list. type: object properties: - documents: - description: >- - Required. A list of documents to update/create. Each document must - have a valid Document.id. Recommended max of 100 items. + searchResults: + description: Search results. type: array items: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' - GoogleCloudDiscoveryengineV1FhirStoreSource: - id: GoogleCloudDiscoveryengineV1FhirStoreSource - description: Cloud FhirStore source import data from. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResult + GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResult: + id: >- + GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResult + description: Search result. type: object properties: - fhirStore: - description: >- - Required. The full resource name of the FHIR store to import data - from, in the format of - `projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}`. - type: string - gcsStagingDir: - description: >- - Intermediate Cloud Storage directory used for the import with a - length limit of 2,000 characters. Can be specified if one wants to - have the FhirStore export to a specific Cloud Storage directory. - type: string - resourceTypes: - description: >- - The FHIR resource types to import. The resource types should be a - subset of all [supported FHIR resource - types](https://cloud.google.com/generative-ai-app-builder/docs/fhir-schema-reference#resource-level-specification). - Default to all supported FHIR resource types if empty. - type: array - items: - type: string - GoogleCloudDiscoveryengineV1SpannerSource: - id: GoogleCloudDiscoveryengineV1SpannerSource - description: The Spanner source for importing data + unstructuredDocumentInfo: + description: Unstructured document information. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo + chunkInfo: + description: Chunk information. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo + GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo: + id: >- + GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo + description: Unstructured document information. type: object properties: - projectId: - description: >- - The project ID that contains the Spanner source. Has a length limit - of 128 characters. If not specified, inherits the project ID from - the parent request. + document: + description: Document resource name. type: string - instanceId: - description: Required. The instance ID of the source Spanner table. + uri: + description: URI for the document. type: string - databaseId: - description: Required. The database ID of the source Spanner table. + title: + description: Title. type: string - tableId: + documentContexts: description: >- - Required. The table name of the Spanner database that needs to be - imported. - type: string - enableDataBoost: + List of document contexts. The content will be used for Answer + Generation. This is supposed to be the main content of the document + that can be long and comprehensive. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext + extractiveSegments: + description: List of extractive segments. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment + extractiveAnswers: description: >- - Whether to apply data boost on Spanner export. Enabling this option - will incur additional cost. More info can be found - [here](https://cloud.google.com/spanner/docs/databoost/databoost-overview#billing_and_quotas). - type: boolean - GoogleCloudDiscoveryengineV1CloudSqlSource: - id: GoogleCloudDiscoveryengineV1CloudSqlSource - description: Cloud SQL source import data from. + Deprecated: This field is deprecated and will have no effect on the + Answer generation. Please use document_contexts and + extractive_segments fields. List of extractive answers. + deprecated: true + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer + GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext: + id: >- + GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext + description: Document context. type: object properties: - projectId: - description: >- - The project ID that contains the Cloud SQL source. Has a length - limit of 128 characters. If not specified, inherits the project ID - from the parent request. - type: string - instanceId: - description: >- - Required. The Cloud SQL instance to copy the data from with a length - limit of 256 characters. - type: string - databaseId: - description: >- - Required. The Cloud SQL database to copy the data from with a length - limit of 256 characters. - type: string - tableId: - description: >- - Required. The Cloud SQL table to copy the data from with a length - limit of 256 characters. + pageIdentifier: + description: Page identifier. type: string - gcsStagingDir: - description: >- - Intermediate Cloud Storage directory used for the import with a - length limit of 2,000 characters. Can be specified if one wants to - have the Cloud SQL export to a specific Cloud Storage directory. - Ensure that the Cloud SQL service account has the necessary Cloud - Storage Admin permissions to access the specified Cloud Storage - directory. + content: + description: Document content to be used for answer generation. type: string - offload: - description: >- - Option for serverless export. Enabling this option will incur - additional cost. More info can be found - [here](https://cloud.google.com/sql/pricing#serverless). - type: boolean - GoogleCloudDiscoveryengineV1FirestoreSource: - id: GoogleCloudDiscoveryengineV1FirestoreSource - description: Firestore source import data from. + GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment: + id: >- + GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment + description: >- + Extractive segment. + [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments) + Answer generation will only use it if document_contexts is empty. This + is supposed to be shorter snippets. type: object properties: - projectId: - description: >- - The project ID that the Cloud SQL source is in with a length limit - of 128 characters. If not specified, inherits the project ID from - the parent request. - type: string - databaseId: - description: >- - Required. The Firestore database to copy the data from with a length - limit of 256 characters. - type: string - collectionId: - description: >- - Required. The Firestore collection (or entity) to copy the data from - with a length limit of 1,500 characters. + pageIdentifier: + description: Page identifier. type: string - gcsStagingDir: - description: >- - Intermediate Cloud Storage directory used for the import with a - length limit of 2,000 characters. Can be specified if one wants to - have the Firestore export to a specific Cloud Storage directory. - Ensure that the Firestore service account has the necessary Cloud - Storage Admin permissions to access the specified Cloud Storage - directory. + content: + description: Extractive segment content. type: string - GoogleCloudDiscoveryengineV1AlloyDbSource: - id: GoogleCloudDiscoveryengineV1AlloyDbSource - description: AlloyDB source import data from. + GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer: + id: >- + GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer + description: >- + Extractive answer. + [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#get-answers) type: object properties: - projectId: - description: >- - The project ID that contains the AlloyDB source. Has a length limit - of 128 characters. If not specified, inherits the project ID from - the parent request. - type: string - locationId: - description: >- - Required. The AlloyDB location to copy the data from with a length - limit of 256 characters. - type: string - clusterId: - description: >- - Required. The AlloyDB cluster to copy the data from with a length - limit of 256 characters. - type: string - databaseId: - description: >- - Required. The AlloyDB database to copy the data from with a length - limit of 256 characters. - type: string - tableId: - description: >- - Required. The AlloyDB table to copy the data from with a length - limit of 256 characters. + pageIdentifier: + description: Page identifier. type: string - gcsStagingDir: - description: >- - Intermediate Cloud Storage directory used for the import with a - length limit of 2,000 characters. Can be specified if one wants to - have the AlloyDB export to a specific Cloud Storage directory. - Ensure that the AlloyDB service account has the necessary Cloud - Storage Admin permissions to access the specified Cloud Storage - directory. + content: + description: Extractive answer content. type: string - GoogleCloudDiscoveryengineV1BigtableSource: - id: GoogleCloudDiscoveryengineV1BigtableSource - description: The Cloud Bigtable source for importing data. + GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo: + id: >- + GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo + description: Chunk information. type: object properties: - projectId: - description: >- - The project ID that contains the Bigtable source. Has a length limit - of 128 characters. If not specified, inherits the project ID from - the parent request. - type: string - instanceId: - description: >- - Required. The instance ID of the Cloud Bigtable that needs to be - imported. + chunk: + description: Chunk resource name. type: string - tableId: - description: >- - Required. The table ID of the Cloud Bigtable that needs to be - imported. + content: + description: Chunk textual content. type: string - bigtableOptions: - description: >- - Required. Bigtable options that contains information needed when - parsing data into typed structures. For example, column type - annotations. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1BigtableOptions' - GoogleCloudDiscoveryengineV1BigtableOptions: - id: GoogleCloudDiscoveryengineV1BigtableOptions + documentMetadata: + description: Metadata of the document from the current chunk. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfoDocumentMetadata + GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfoDocumentMetadata: + id: >- + GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfoDocumentMetadata description: >- - The Bigtable Options object that contains information to support the - import. + Document metadata contains the information of the document of the + current chunk. type: object properties: - keyFieldName: - description: >- - The field name used for saving row key value in the document. The - name has to match the pattern `a-zA-Z0-9*`. + uri: + description: Uri of the document. type: string - families: - description: >- - The mapping from family names to an object that contains column - families level information for the given column family. If a family - is not present in this map it will be ignored. - type: object - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumnFamily - GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumnFamily: - id: GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumnFamily - description: The column family of the Bigtable. - type: object - properties: - fieldName: - description: >- - The field name to use for this column family in the document. The - name has to match the pattern `a-zA-Z0-9*`. If not set, it is parsed - from the family name with best effort. However, due to different - naming patterns, field name collisions could happen, where parsing - behavior is undefined. - type: string - encoding: - description: >- - The encoding mode of the values when the type is not STRING. - Acceptable encoding values are: * `TEXT`: indicates values are - alphanumeric text strings. * `BINARY`: indicates values are encoded - using `HBase Bytes.toBytes` family of functions. This can be - overridden for a specific column by listing that column in `columns` - and specifying an encoding for it. - type: string - enumDescriptions: - - The encoding is unspecified. - - Text encoding. - - Binary encoding. - enum: - - ENCODING_UNSPECIFIED - - TEXT - - BINARY - type: - description: >- - The type of values in this column family. The values are expected to - be encoded using `HBase Bytes.toBytes` function when the encoding - value is set to `BINARY`. - type: string - enumDescriptions: - - The type is unspecified. - - String type. - - Numerical type. - - Integer type. - - Variable length integer type. - - BigDecimal type. - - Boolean type. - - JSON type. - enum: - - TYPE_UNSPECIFIED - - STRING - - NUMBER - - INTEGER - - VAR_INTEGER - - BIG_NUMERIC - - BOOLEAN - - JSON - columns: - description: >- - The list of objects that contains column level information for each - column. If a column is not present in this list it will be ignored. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumn - GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumn: - id: GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumn - description: The column of the Bigtable. - type: object - properties: - qualifier: - description: >- - Required. Qualifier of the column. If it cannot be decoded with - utf-8, use a base-64 encoded string instead. - type: string - format: byte - fieldName: - description: >- - The field name to use for this column in the document. The name has - to match the pattern `a-zA-Z0-9*`. If not set, it is parsed from the - qualifier bytes with best effort. However, due to different naming - patterns, field name collisions could happen, where parsing behavior - is undefined. - type: string - encoding: - description: >- - The encoding mode of the values when the type is not `STRING`. - Acceptable encoding values are: * `TEXT`: indicates values are - alphanumeric text strings. * `BINARY`: indicates values are encoded - using `HBase Bytes.toBytes` family of functions. This can be - overridden for a specific column by listing that column in `columns` - and specifying an encoding for it. - type: string - enumDescriptions: - - The encoding is unspecified. - - Text encoding. - - Binary encoding. - enum: - - ENCODING_UNSPECIFIED - - TEXT - - BINARY - type: - description: >- - The type of values in this column family. The values are expected to - be encoded using `HBase Bytes.toBytes` function when the encoding - value is set to `BINARY`. + title: + description: Title of the document. type: string - enumDescriptions: - - The type is unspecified. - - String type. - - Numerical type. - - Integer type. - - Variable length integer type. - - BigDecimal type. - - Boolean type. - - JSON type. - enum: - - TYPE_UNSPECIFIED - - STRING - - NUMBER - - INTEGER - - VAR_INTEGER - - BIG_NUMERIC - - BOOLEAN - - JSON - GoogleCloudDiscoveryengineV1PurgeDocumentsRequest: - id: GoogleCloudDiscoveryengineV1PurgeDocumentsRequest - description: Request message for DocumentService.PurgeDocuments method. + GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpec: + id: GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpec + description: Query understanding specification. type: object properties: - gcsSource: - description: >- - Cloud Storage location for the input content. Supported - `data_schema`: * `document_id`: One valid Document.id per line. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1GcsSource' - inlineSource: - description: Inline source for the input content for purge. + queryClassificationSpec: + description: Query classification specification. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1PurgeDocumentsRequestInlineSource - filter: - description: >- - Required. Filter matching documents to purge. Only currently - supported value is `*` (all items). - type: string - errorConfig: - description: The desired location of errors incurred during the purge. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1PurgeErrorConfig' - force: + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec + queryRephraserSpec: + description: Query rephraser specification. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec + disableSpellCorrection: description: >- - Actually performs the purge. If `force` is set to false, return the - expected purge count without deleting any documents. + Optional. Whether to disable spell correction. The default value is + `false`. type: boolean - GoogleCloudDiscoveryengineV1PurgeDocumentsRequestInlineSource: - id: GoogleCloudDiscoveryengineV1PurgeDocumentsRequestInlineSource - description: >- - The inline source for the input config for - DocumentService.PurgeDocuments method. + GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec: + id: >- + GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec + description: Query classification specification. type: object properties: - documents: - description: >- - Required. A list of full resource name of documents to purge. In the - format - `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`. - Recommended max of 100 items. + types: + description: Enabled query classification types. type: array items: type: string - GoogleCloudDiscoveryengineV1PurgeErrorConfig: - id: GoogleCloudDiscoveryengineV1PurgeErrorConfig - description: Configuration of destination for Purge related errors. + enumDescriptions: + - Unspecified query classification type. + - Adversarial query classification type. + - Non-answer-seeking query classification type, for chit chat. + - Jail-breaking query classification type. + - >- + Non-answer-seeking query classification type, for no clear + intent. + - User defined query classification type. + enum: + - TYPE_UNSPECIFIED + - ADVERSARIAL_QUERY + - NON_ANSWER_SEEKING_QUERY + - JAIL_BREAKING_QUERY + - NON_ANSWER_SEEKING_QUERY_V2 + - USER_DEFINED_CLASSIFICATION_QUERY + GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec: + id: >- + GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec + description: Query rephraser specification. type: object properties: - gcsPrefix: + disable: + description: Disable query rephraser. + type: boolean + maxRephraseSteps: description: >- - Cloud Storage prefix for purge errors. This must be an empty, - existing Cloud Storage directory. Purge errors are written to - sharded files in this directory, one per line, as a JSON-encoded - `google.rpc.Status` message. + Max rephrase steps. The max number is 5 steps. If not set or set to + < 1, it will be set to 1 by default. + type: integer + format: int32 + modelSpec: + description: Optional. Query Rephraser Model specification. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpecModelSpec + GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpecModelSpec: + id: >- + GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpecModelSpec + description: Query Rephraser Model specification. + type: object + properties: + modelType: + description: >- + Optional. Enabled query rephraser model type. If not set, it will + use LARGE by default. type: string - GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse: - id: GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse - description: Response message for DocumentService.BatchGetDocumentsMetadata method. + enumDescriptions: + - Unspecified model type. + - Small query rephraser model. Gemini 1.0 XS model. + - Large query rephraser model. Gemini 1.0 Pro model. + enum: + - MODEL_TYPE_UNSPECIFIED + - SMALL + - LARGE + GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpec: + id: GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpec + description: End user specification. type: object properties: - documentsMetadata: - description: The metadata of the Documents. + endUserMetadata: + description: Optional. End user metadata. type: array items: $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadata - GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadata: + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaData + GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaData: + id: GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaData + description: End user metadata. + type: object + properties: + chunkInfo: + description: Chunk information. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo + GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo: id: >- - GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadata - description: The metadata of a Document. + GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo + description: Chunk information. type: object properties: - matcherValue: - description: The value of the matcher that was used to match the Document. + content: + description: Chunk textual content. It is limited to 8000 characters. + type: string + documentMetadata: + description: Metadata of the document from the current chunk. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue - state: - description: The state of the document. + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata + GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata: + id: >- + GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata + description: >- + Document metadata contains the information of the document of the + current chunk. + type: object + properties: + title: + description: Title of the document. type: string - enumDescriptions: - - Should never be set. - - The Document is indexed. - - >- - The Document is not indexed because its URI is not in the - TargetSite. - - The Document is not indexed. - enum: - - STATE_UNSPECIFIED - - INDEXED - - NOT_IN_TARGET_SITE - - NOT_IN_INDEX - lastRefreshedTime: - description: The timestamp of the last time the Document was last indexed. - type: string - format: google-datetime - dataIngestionSource: - description: >- - The data ingestion source of the Document. Allowed values are: * - `batch`: Data ingested via Batch API, e.g., ImportDocuments. * - `streaming` Data ingested via Streaming API, e.g., FHIR streaming. - type: string - GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue: - id: >- - GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue - description: The value of the matcher that was used to match the Document. + GoogleCloudDiscoveryengineV1AnswerQueryResponse: + id: GoogleCloudDiscoveryengineV1AnswerQueryResponse + description: Response message for ConversationalSearchService.AnswerQuery method. type: object properties: - uri: - description: If match by URI, the URI of the Document. - type: string - fhirResource: + answer: description: >- - Format: - projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} + Answer resource object. If + AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps + is greater than 1, use Answer.name to fetch answer information using + ConversationalSearchService.GetAnswer API. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Answer' + session: + description: >- + Session resource object. It will be only available when session + field is set and valid in the AnswerQueryRequest request. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Session' + answerQueryToken: + description: A global unique ID used for logging. type: string - GoogleCloudDiscoveryengineV1Engine: - id: GoogleCloudDiscoveryengineV1Engine - description: >- - Metadata that describes the training and serving parameters of an - Engine. + GoogleCloudDiscoveryengineV1Answer: + id: GoogleCloudDiscoveryengineV1Answer + description: Defines an answer. type: object properties: - chatEngineConfig: - description: >- - Configurations for the Chat Engine. Only applicable if solution_type - is SOLUTION_TYPE_CHAT. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1EngineChatEngineConfig - searchEngineConfig: - description: >- - Configurations for the Search Engine. Only applicable if - solution_type is SOLUTION_TYPE_SEARCH. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1EngineSearchEngineConfig - chatEngineMetadata: - description: >- - Output only. Additional information of the Chat Engine. Only - applicable if solution_type is SOLUTION_TYPE_CHAT. - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1EngineChatEngineMetadata name: description: >- - Immutable. The fully qualified resource name of the engine. This - field must be a UTF-8 encoded string with a length limit of 1024 - characters. Format: - `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` - engine should be 1-63 characters, and valid characters are - /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned. + Immutable. Fully qualified name + `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*` type: string - displayName: - description: >- - Required. The display name of the engine. Should be human readable. - UTF-8 encoded string with limit of 1024 characters. + state: + description: The state of the answer generation. + type: string + enumDescriptions: + - Unknown. + - Answer generation is currently in progress. + - Answer generation currently failed. + - Answer generation has succeeded. + - Answer generation is currently in progress. + enum: + - STATE_UNSPECIFIED + - IN_PROGRESS + - FAILED + - SUCCEEDED + - STREAMING + answerText: + description: The textual answer. type: string + groundingScore: + description: >- + A score in the range of [0, 1] describing how grounded the answer is + by the reference chunks. + type: number + format: double + citations: + description: Citations. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1AnswerCitation' + groundingSupports: + description: Optional. Grounding supports. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerGroundingSupport + references: + description: References. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1AnswerReference' + relatedQuestions: + description: Suggested related questions. + type: array + items: + type: string + steps: + description: Answer generation steps. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1AnswerStep' + queryUnderstandingInfo: + description: Query understanding information. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfo + answerSkippedReasons: + description: >- + Additional answer-skipped reasons. This provides the reason for + ignored cases. If nothing is skipped, this field is not set. + type: array + items: + type: string + enumDescriptions: + - Default value. The answer skipped reason is not specified. + - The adversarial query ignored case. + - >- + The non-answer seeking query ignored case Google skips the + answer if the query is chit chat. + - >- + The out-of-domain query ignored case. Google skips the answer if + there are no high-relevance search results. + - >- + The potential policy violation case. Google skips the answer if + there is a potential policy violation detected. This includes + content that may be violent or toxic. + - >- + The no relevant content case. Google skips the answer if there + is no relevant content in the retrieved search results. + - >- + The jail-breaking query ignored case. For example, "Reply in the + tone of a competing company's CEO". Google skips the answer if + the query is classified as a jail-breaking query. + - >- + The customer policy violation case. Google skips the summary if + there is a customer policy violation detected. The policy is + defined by the customer. + - >- + The non-answer seeking query ignored case. Google skips the + answer if the query doesn't have clear intent. + - >- + The low-grounded answer case. Google skips the answer if a well + grounded answer was unable to be generated. + - >- + The user defined query classification ignored case. Google skips + the answer if the query is classified as a user defined query + classification. + - >- + The unhelpful answer case. Google skips the answer if the answer + is not helpful. This can be due to a variety of factors, + including but not limited to: the query is not answerable, the + answer is not relevant to the query, or the answer is not + well-formatted. + enum: + - ANSWER_SKIPPED_REASON_UNSPECIFIED + - ADVERSARIAL_QUERY_IGNORED + - NON_ANSWER_SEEKING_QUERY_IGNORED + - OUT_OF_DOMAIN_QUERY_IGNORED + - POTENTIAL_POLICY_VIOLATION + - NO_RELEVANT_CONTENT + - JAIL_BREAKING_QUERY_IGNORED + - CUSTOMER_POLICY_VIOLATION + - NON_ANSWER_SEEKING_QUERY_IGNORED_V2 + - LOW_GROUNDED_ANSWER + - USER_DEFINED_CLASSIFICATION_QUERY_IGNORED + - UNHELPFUL_ANSWER createTime: - description: Output only. Timestamp the Recommendation Engine was created at. + description: Output only. Answer creation timestamp. readOnly: true type: string format: google-datetime - updateTime: - description: Output only. Timestamp the Recommendation Engine was last updated. + completeTime: + description: Output only. Answer completed timestamp. readOnly: true type: string format: google-datetime - dataStoreIds: - description: >- - The data stores associated with this engine. For - SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of - engines, they can only associate with at most one data store. If - solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same - Collection can be associated here. Note that when used in - CreateEngineRequest, one DataStore id must be provided as the system - will use it for necessary initializations. + safetyRatings: + description: Optional. Safety ratings. type: array items: - type: string - solutionType: - description: Required. The solutions of the engine. - type: string - enumDescriptions: - - Default value. - - Used for Recommendations AI. - - Used for Discovery Search. - - Used for use cases related to the Generative AI agent. - - >- - Used for use cases related to the Generative Chat agent. It's used - for Generative chat engine only, the associated data stores must - enrolled with `SOLUTION_TYPE_CHAT` solution. - enum: - - SOLUTION_TYPE_UNSPECIFIED - - SOLUTION_TYPE_RECOMMENDATION - - SOLUTION_TYPE_SEARCH - - SOLUTION_TYPE_CHAT - - SOLUTION_TYPE_GENERATIVE_CHAT - industryVertical: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1SafetyRating' + GoogleCloudDiscoveryengineV1AnswerCitation: + id: GoogleCloudDiscoveryengineV1AnswerCitation + description: Citation info for a segment. + type: object + properties: + startIndex: description: >- - The industry vertical that the engine registers. The restriction of - the Engine industry vertical is based on DataStore: If unspecified, - default to `GENERIC`. Vertical on Engine has to match vertical of - the DataStore linked to the engine. + Index indicates the start of the segment, measured in bytes (UTF-8 + unicode). If there are multi-byte characters,such as non-ASCII + characters, the index measurement is longer than the string length. type: string - enumDescriptions: - - Value used when unset. - - >- - The generic vertical for documents that are not specific to any - industry vertical. - - The media industry vertical. - - The healthcare FHIR vertical. - enum: - - INDUSTRY_VERTICAL_UNSPECIFIED - - GENERIC - - MEDIA - - HEALTHCARE_FHIR - commonConfig: - description: Common config spec that specifies the metadata of the engine. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1EngineCommonConfig' - disableAnalytics: + format: int64 + endIndex: description: >- - Optional. Whether to disable analytics for searches performed on - this engine. - type: boolean - GoogleCloudDiscoveryengineV1EngineChatEngineConfig: - id: GoogleCloudDiscoveryengineV1EngineChatEngineConfig - description: Configurations for a Chat Engine. + End of the attributed segment, exclusive. Measured in bytes (UTF-8 + unicode). If there are multi-byte characters,such as non-ASCII + characters, the index measurement is longer than the string length. + type: string + format: int64 + sources: + description: Citation sources for the attributed segment. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerCitationSource + GoogleCloudDiscoveryengineV1AnswerCitationSource: + id: GoogleCloudDiscoveryengineV1AnswerCitationSource + description: Citation source. type: object properties: - agentCreationConfig: - description: >- - The configurationt generate the Dialogflow agent that is associated - to this Engine. Note that these configurations are one-time consumed - by and passed to Dialogflow service. It means they cannot be - retrieved using EngineService.GetEngine or EngineService.ListEngines - API after engine creation. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig - dialogflowAgentToLink: - description: >- - The resource name of an exist Dialogflow agent to link to this Chat - Engine. Customers can either provide `agent_creation_config` to - create agent or provide an agent name that links the agent with the - Chat engine. Format: `projects//locations//agents/`. Note that the - `dialogflow_agent_to_link` are one-time consumed by and passed to - Dialogflow service. It means they cannot be retrieved using - EngineService.GetEngine or EngineService.ListEngines API after - engine creation. Use ChatEngineMetadata.dialogflow_agent for actual - agent association after Engine is created. + referenceId: + description: ID of the citation source. type: string - GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig: - id: GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig - description: >- - Configurations for generating a Dialogflow agent. Note that these - configurations are one-time consumed by and passed to Dialogflow - service. It means they cannot be retrieved using EngineService.GetEngine - or EngineService.ListEngines API after engine creation. + GoogleCloudDiscoveryengineV1AnswerGroundingSupport: + id: GoogleCloudDiscoveryengineV1AnswerGroundingSupport + description: Grounding support for a claim in `answer_text`. type: object properties: - business: - description: >- - Name of the company, organization or other entity that the agent - represents. Used for knowledge connector LLM prompt and for - knowledge search. - type: string - defaultLanguageCode: + startIndex: description: >- - Required. The default language of the agent as a language tag. See - [Language - Support](https://cloud.google.com/dialogflow/docs/reference/language) - for a list of the currently supported language codes. + Required. Index indicates the start of the claim, measured in bytes + (UTF-8 unicode). type: string - timeZone: - description: >- - Required. The time zone of the agent from the [time zone - database](https://www.iana.org/time-zones), e.g., America/New_York, - Europe/Paris. + format: int64 + endIndex: + description: Required. End of the claim, exclusive. type: string - location: + format: int64 + groundingScore: description: >- - Agent location for Agent creation, supported values: global/us/eu. - If not provided, us Engine will create Agent using us-central-1 by - default; eu Engine will create Agent using eu-west-1 by default. - type: string - GoogleCloudDiscoveryengineV1EngineSearchEngineConfig: - id: GoogleCloudDiscoveryengineV1EngineSearchEngineConfig - description: Configurations for a Search Engine. - type: object - properties: - searchTier: + A score in the range of [0, 1] describing how grounded is a specific + claim by the references. Higher value means that the claim is better + supported by the reference chunks. + type: number + format: double + groundingCheckRequired: description: >- - The search feature tier of this engine. Different tiers might have - different pricing. To learn more, check the pricing documentation. - Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. - type: string - enumDescriptions: - - >- - Default value when the enum is unspecified. This is invalid to - use. - - Standard tier. - - Enterprise tier. - enum: - - SEARCH_TIER_UNSPECIFIED - - SEARCH_TIER_STANDARD - - SEARCH_TIER_ENTERPRISE - searchAddOns: - description: The add-on that this search engine enables. + Indicates that this claim required grounding check. When the system + decided this claim didn't require attribution/grounding check, this + field is set to false. In that case, no grounding check was done for + the claim and therefore `grounding_score`, `sources` is not + returned. + type: boolean + sources: + description: Optional. Citation sources for the claim. type: array items: - type: string - enumDescriptions: - - >- - Default value when the enum is unspecified. This is invalid to - use. - - Large language model add-on. - enum: - - SEARCH_ADD_ON_UNSPECIFIED - - SEARCH_ADD_ON_LLM - GoogleCloudDiscoveryengineV1EngineChatEngineMetadata: - id: GoogleCloudDiscoveryengineV1EngineChatEngineMetadata - description: >- - Additional information of a Chat Engine. Fields in this message are - output only. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerCitationSource + GoogleCloudDiscoveryengineV1AnswerReference: + id: GoogleCloudDiscoveryengineV1AnswerReference + description: Reference. type: object properties: - dialogflowAgent: - description: >- - The resource name of a Dialogflow agent, that this Chat Engine - refers to. Format: `projects//locations//agents/`. - type: string - GoogleCloudDiscoveryengineV1EngineCommonConfig: - id: GoogleCloudDiscoveryengineV1EngineCommonConfig - description: Common configurations for an Engine. + unstructuredDocumentInfo: + description: Unstructured document information. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfo + chunkInfo: + description: Chunk information. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfo + structuredDocumentInfo: + description: Structured document information. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerReferenceStructuredDocumentInfo + GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfo: + id: GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfo + description: Unstructured document information. type: object properties: - companyName: - description: >- - The name of the company, business or entity that is associated with - the engine. Setting this may help improve LLM related features. + document: + description: Document resource name. type: string - GoogleCloudDiscoveryengineV1ListEnginesResponse: - id: GoogleCloudDiscoveryengineV1ListEnginesResponse - description: Response message for EngineService.ListEngines method. - type: object - properties: - engines: - description: All the customer's Engines. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Engine' - nextPageToken: - description: Not supported. + uri: + description: URI for the document. type: string - GoogleCloudDiscoveryengineV1CheckGroundingRequest: - id: GoogleCloudDiscoveryengineV1CheckGroundingRequest - description: Request message for GroundedGenerationService.CheckGrounding method. - type: object - properties: - answerCandidate: - description: >- - Answer candidate to check. It can have a maximum length of 4096 - tokens. + title: + description: Title. type: string - facts: - description: List of facts for the grounding check. We support up to 200 facts. + chunkContents: + description: List of cited chunk contents derived from document content. type: array items: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1GroundingFact' - groundingSpec: - description: Configuration of the grounding check. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1CheckGroundingSpec' - userLabels: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfoChunkContent + structData: description: >- - The user labels applied to a resource must meet the following - requirements: * Each resource can have multiple labels, up to a - maximum of 64. * Each label must be a key-value pair. * Keys have a - minimum length of 1 character and a maximum length of 63 characters - and cannot be empty. Values can be empty and have a maximum length - of 63 characters. * Keys and values can contain only lowercase - letters, numeric characters, underscores, and dashes. All characters - must use UTF-8 encoding, and international characters are allowed. * - The key portion of a label must be unique. However, you can use the - same key with multiple resources. * Keys must start with a lowercase - letter or international character. See [Google Cloud - Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) - for more details. + The structured JSON metadata for the document. It is populated from + the struct data from the Chunk in search result. type: object additionalProperties: - type: string - GoogleCloudDiscoveryengineV1GroundingFact: - id: GoogleCloudDiscoveryengineV1GroundingFact - description: Grounding Fact. + type: any + description: Properties of the object. + GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfoChunkContent: + id: >- + GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfoChunkContent + description: Chunk content. type: object properties: - factText: - description: Text content of the fact. Can be at most 10K characters long. + content: + description: Chunk textual content. type: string - attributes: - description: >- - Attributes associated with the fact. Common attributes include - `source` (indicating where the fact was sourced from), `author` - (indicating the author of the fact), and so on. - type: object - additionalProperties: - type: string - GoogleCloudDiscoveryengineV1CheckGroundingSpec: - id: GoogleCloudDiscoveryengineV1CheckGroundingSpec - description: Specification for the grounding check. - type: object - properties: - citationThreshold: + pageIdentifier: + description: Page identifier. + type: string + relevanceScore: description: >- - The threshold (in [0,1]) used for determining whether a fact must be - cited for a claim in the answer candidate. Choosing a higher - threshold will lead to fewer but very strong citations, while - choosing a lower threshold may lead to more but somewhat weaker - citations. If unset, the threshold will default to 0.6. + The relevance of the chunk for a given query. Values range from 0.0 + (completely irrelevant) to 1.0 (completely relevant). This value is + for informational purpose only. It may change for the same query and + chunk at any time due to a model retraining or change in + implementation. type: number - format: double - GoogleCloudDiscoveryengineV1CheckGroundingResponse: - id: GoogleCloudDiscoveryengineV1CheckGroundingResponse - description: >- - Response message for the GroundedGenerationService.CheckGrounding - method. + format: float + GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfo: + id: GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfo + description: Chunk information. type: object properties: - supportScore: + chunk: + description: Chunk resource name. + type: string + content: + description: Chunk textual content. + type: string + relevanceScore: description: >- - The support score for the input answer candidate. Higher the score, - higher is the fraction of claims that are supported by the provided - facts. This is always set when a response is returned. + The relevance of the chunk for a given query. Values range from 0.0 + (completely irrelevant) to 1.0 (completely relevant). This value is + for informational purpose only. It may change for the same query and + chunk at any time due to a model retraining or change in + implementation. type: number format: float - citedChunks: - description: >- - List of facts cited across all claims in the answer candidate. These - are derived from the facts supplied in the request. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1CheckGroundingResponseFactChunk - claims: - description: >- - Claim texts and citation info across all claims in the answer - candidate. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim - GoogleCloudDiscoveryengineV1CheckGroundingResponseFactChunk: - id: GoogleCloudDiscoveryengineV1CheckGroundingResponseFactChunk - description: Fact chunk for grounding check. + documentMetadata: + description: Document metadata. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfoDocumentMetadata + GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfoDocumentMetadata: + id: GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfoDocumentMetadata + description: Document metadata. type: object properties: - chunkText: - description: Text content of the fact chunk. Can be at most 10K characters long. + document: + description: Document resource name. type: string - source: + uri: + description: URI for the document. + type: string + title: + description: Title. + type: string + pageIdentifier: + description: Page identifier. + type: string + structData: description: >- - Source from which this fact chunk was retrieved. For a fact chunk - retrieved from inline facts, this field will contain the index of - the specific fact from which this chunk was retrieved. + The structured JSON metadata for the document. It is populated from + the struct data from the Chunk in search result. + type: object + additionalProperties: + type: any + description: Properties of the object. + GoogleCloudDiscoveryengineV1AnswerReferenceStructuredDocumentInfo: + id: GoogleCloudDiscoveryengineV1AnswerReferenceStructuredDocumentInfo + description: Structured search information. + type: object + properties: + document: + description: Document resource name. type: string - GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim: - id: GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim - description: Text and citation info for a claim in the answer candidate. + structData: + description: Structured search data. + type: object + additionalProperties: + type: any + description: Properties of the object. + title: + description: Output only. The title of the document. + readOnly: true + type: string + uri: + description: Output only. The URI of the document. + readOnly: true + type: string + GoogleCloudDiscoveryengineV1AnswerStep: + id: GoogleCloudDiscoveryengineV1AnswerStep + description: Step information. type: object properties: - startPos: - description: >- - Position indicating the start of the claim in the answer candidate, - measured in bytes. - type: integer - format: int32 - endPos: - description: >- - Position indicating the end of the claim in the answer candidate, - exclusive. - type: integer - format: int32 - claimText: - description: >- - Text for the claim in the answer candidate. Always provided - regardless of whether citations or anti-citations are found. + state: + description: The state of the step. type: string - citationIndices: - description: >- - A list of indices (into 'cited_chunks') specifying the citations - associated with the claim. For instance [1,3,4] means that - cited_chunks[1], cited_chunks[3], cited_chunks[4] are the facts - cited supporting for the claim. A citation to a fact indicates that - the claim is supported by the fact. + enumDescriptions: + - Unknown. + - Step is currently in progress. + - Step currently failed. + - Step has succeeded. + enum: + - STATE_UNSPECIFIED + - IN_PROGRESS + - FAILED + - SUCCEEDED + description: + description: The description of the step. + type: string + thought: + description: The thought of the step. + type: string + actions: + description: Actions. type: array items: - type: integer - format: int32 - groundingCheckRequired: - description: >- - Indicates that this claim required grounding check. When the system - decided this claim doesn't require attribution/grounding check, this - field will be set to false. In that case, no grounding check was - done for the claim and therefore citation_indices, - anti_citation_indices, and score should not be returned. - type: boolean - GoogleCloudDiscoveryengineV1ProvisionProjectRequest: - id: GoogleCloudDiscoveryengineV1ProvisionProjectRequest - description: Request for ProjectService.ProvisionProject method. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1AnswerStepAction' + GoogleCloudDiscoveryengineV1AnswerStepAction: + id: GoogleCloudDiscoveryengineV1AnswerStepAction + description: Action. type: object properties: - acceptDataUseTerms: - description: >- - Required. Set to `true` to specify that caller has read and would - like to give consent to the [Terms for data - use](https://cloud.google.com/retail/data-use-terms). - type: boolean - dataUseTermsVersion: - description: >- - Required. The version of the [Terms for data - use](https://cloud.google.com/retail/data-use-terms) that caller has - read and would like to give consent to. Acceptable version is - `2022-11-23`, and this may change over time. + searchAction: + description: Search action. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerStepActionSearchAction + observation: + description: Observation. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerStepActionObservation + GoogleCloudDiscoveryengineV1AnswerStepActionSearchAction: + id: GoogleCloudDiscoveryengineV1AnswerStepActionSearchAction + description: Search action. + type: object + properties: + query: + description: The query to search. type: string - GoogleCloudDiscoveryengineV1RankRequest: - id: GoogleCloudDiscoveryengineV1RankRequest - description: Request message for RankService.Rank method. + GoogleCloudDiscoveryengineV1AnswerStepActionObservation: + id: GoogleCloudDiscoveryengineV1AnswerStepActionObservation + description: Observation. type: object properties: - model: + searchResults: description: >- - The identifier of the model to use. It is one of: * - `semantic-ranker-512@latest`: Semantic ranking model with maxiumn - input token size 512. It is set to `semantic-ranker-512@latest` by - default if unspecified. + Search results observed by the search action, it can be snippets + info or chunk info, depending on the citation type set by the user. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResult + GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResult: + id: GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResult + type: object + properties: + document: + description: Document resource name. type: string - topN: - description: >- - The number of results to return. If this is unset or no bigger than - zero, returns all results. - type: integer - format: int32 - query: - description: The query to use. + uri: + description: URI for the document. type: string - records: - description: Required. A list of records to rank. At most 200 records to rank. + title: + description: Title. + type: string + snippetInfo: + description: >- + If citation_type is DOCUMENT_LEVEL_CITATION, populate document level + snippets. type: array items: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1RankingRecord' - ignoreRecordDetailsInResponse: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo + chunkInfo: description: >- - If true, the response will contain only record ID and score. By - default, it is false, the response will contain record details. - type: boolean - userLabels: + If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, + populate chunk info. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultChunkInfo + structData: description: >- - The user labels applied to a resource must meet the following - requirements: * Each resource can have multiple labels, up to a - maximum of 64. * Each label must be a key-value pair. * Keys have a - minimum length of 1 character and a maximum length of 63 characters - and cannot be empty. Values can be empty and have a maximum length - of 63 characters. * Keys and values can contain only lowercase - letters, numeric characters, underscores, and dashes. All characters - must use UTF-8 encoding, and international characters are allowed. * - The key portion of a label must be unique. However, you can use the - same key with multiple resources. * Keys must start with a lowercase - letter or international character. See [Google Cloud - Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) - for more details. + Data representation. The structured JSON data for the document. It's + populated from the struct data from the Document, or the Chunk in + search result. type: object additionalProperties: - type: string - GoogleCloudDiscoveryengineV1RankingRecord: - id: GoogleCloudDiscoveryengineV1RankingRecord - description: Record message for RankService.Rank method. + type: any + description: Properties of the object. + GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo: + id: >- + GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo + description: Snippet information. type: object properties: - id: - description: The unique ID to represent the record. + snippet: + description: Snippet content. type: string - title: - description: >- - The title of the record. Empty by default. At least one of title or - content should be set otherwise an INVALID_ARGUMENT error is thrown. + snippetStatus: + description: Status of the snippet defined by the search team. + type: string + GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultChunkInfo: + id: >- + GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultChunkInfo + description: Chunk information. + type: object + properties: + chunk: + description: Chunk resource name. type: string content: - description: >- - The content of the record. Empty by default. At least one of title - or content should be set otherwise an INVALID_ARGUMENT error is - thrown. + description: Chunk textual content. type: string - score: + relevanceScore: description: >- - The score of this record based on the given query and selected - model. - type: number + The relevance of the chunk for a given query. Values range from 0.0 + (completely irrelevant) to 1.0 (completely relevant). This value is + for informational purpose only. It may change for the same query and + chunk at any time due to a model retraining or change in + implementation. + type: number format: float - GoogleCloudDiscoveryengineV1RankResponse: - id: GoogleCloudDiscoveryengineV1RankResponse - description: Response message for RankService.Rank method. + GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfo: + id: GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfo + description: Query understanding information. type: object properties: - records: - description: A list of records sorted by descending score. + queryClassificationInfo: + description: Query classification information. type: array items: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1RankingRecord' - GoogleCloudDiscoveryengineV1RecommendRequest: - id: GoogleCloudDiscoveryengineV1RecommendRequest - description: Request message for Recommend method. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfoQueryClassificationInfo + GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfoQueryClassificationInfo: + id: >- + GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfoQueryClassificationInfo + description: Query classification information. type: object properties: - userEvent: + type: + description: Query classification type. + type: string + enumDescriptions: + - Unspecified query classification type. + - Adversarial query classification type. + - Non-answer-seeking query classification type, for chit chat. + - Jail-breaking query classification type. + - Non-answer-seeking query classification type, for no clear intent. + - User defined query classification type. + enum: + - TYPE_UNSPECIFIED + - ADVERSARIAL_QUERY + - NON_ANSWER_SEEKING_QUERY + - JAIL_BREAKING_QUERY + - NON_ANSWER_SEEKING_QUERY_V2 + - USER_DEFINED_CLASSIFICATION_QUERY + positive: + description: Classification output. + type: boolean + GoogleCloudDiscoveryengineV1SafetyRating: + id: GoogleCloudDiscoveryengineV1SafetyRating + description: Safety rating corresponding to the generated content. + type: object + properties: + category: + description: Output only. Harm category. + readOnly: true + type: string + enumDescriptions: + - The harm category is unspecified. + - The harm category is hate speech. + - The harm category is dangerous content. + - The harm category is harassment. + - The harm category is sexually explicit content. + - The harm category is civic integrity. + enum: + - HARM_CATEGORY_UNSPECIFIED + - HARM_CATEGORY_HATE_SPEECH + - HARM_CATEGORY_DANGEROUS_CONTENT + - HARM_CATEGORY_HARASSMENT + - HARM_CATEGORY_SEXUALLY_EXPLICIT + - HARM_CATEGORY_CIVIC_INTEGRITY + probability: + description: Output only. Harm probability levels in the content. + readOnly: true + type: string + enumDescriptions: + - Harm probability unspecified. + - Negligible level of harm. + - Low level of harm. + - Medium level of harm. + - High level of harm. + enum: + - HARM_PROBABILITY_UNSPECIFIED + - NEGLIGIBLE + - LOW + - MEDIUM + - HIGH + probabilityScore: + description: Output only. Harm probability score. + readOnly: true + type: number + format: float + severity: + description: Output only. Harm severity levels in the content. + readOnly: true + type: string + enumDescriptions: + - Harm severity unspecified. + - Negligible level of harm severity. + - Low level of harm severity. + - Medium level of harm severity. + - High level of harm severity. + enum: + - HARM_SEVERITY_UNSPECIFIED + - HARM_SEVERITY_NEGLIGIBLE + - HARM_SEVERITY_LOW + - HARM_SEVERITY_MEDIUM + - HARM_SEVERITY_HIGH + severityScore: + description: Output only. Harm severity score. + readOnly: true + type: number + format: float + blocked: description: >- - Required. Context about the user, what they are looking at and what - action they took to trigger the Recommend request. Note that this - user event detail won't be ingested to userEvent logs. Thus, a - separate userEvent write request is required for event logging. - Don't set UserEvent.user_pseudo_id or UserEvent.user_info.user_id to - the same fixed ID for different users. If you are trying to receive - non-personalized recommendations (not recommended; this can - negatively impact model performance), instead set - UserEvent.user_pseudo_id to a random unique ID and leave - UserEvent.user_info.user_id unset. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1UserEvent' - pageSize: + Output only. Indicates whether the content was filtered out because + of this rating. + readOnly: true + type: boolean + GoogleCloudDiscoveryengineV1Session: + id: GoogleCloudDiscoveryengineV1Session + description: External session proto definition. + type: object + properties: + name: description: >- - Maximum number of results to return. Set this property to the number - of recommendation results needed. If zero, the service chooses a - reasonable default. The maximum allowed value is 100. Values above - 100 are set to 100. - type: integer - format: int32 - filter: + Immutable. Fully qualified name + `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` + type: string + displayName: description: >- - Filter for restricting recommendation results with a length limit of - 5,000 characters. Currently, only filter expressions on the - `filter_tags` attribute is supported. Examples: * `(filter_tags: - ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))` * - `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: - ANY("Green"))` If `attributeFilteringSyntax` is set to true under - the `params` field, then attribute-based expressions are expected - instead of the above described tag-based syntax. Examples: * - (launguage: ANY("en", "es")) AND NOT (categories: ANY("Movie")) * - (available: true) AND (launguage: ANY("en", "es")) OR (categories: - ANY("Movie")) If your filter blocks all results, the API returns - generic (unfiltered) popular Documents. If you only want results - strictly matching the filters, set `strictFiltering` to `true` in - RecommendRequest.params to receive empty results instead. Note that - the API never returns Documents with `storageStatus` as `EXPIRED` or - `DELETED` regardless of filter choices. + Optional. The display name of the session. This field is used to + identify the session in the UI. By default, the display name is the + first turn query text in the session. type: string - validateOnly: + state: + description: The state of the session. + type: string + enumDescriptions: + - State is unspecified. + - The session is currently open. + enum: + - STATE_UNSPECIFIED + - IN_PROGRESS + userPseudoId: + description: A unique identifier for tracking users. + type: string + turns: + description: Turns. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1SessionTurn' + startTime: + description: Output only. The time the session started. + readOnly: true + type: string + format: google-datetime + endTime: + description: Output only. The time the session finished. + readOnly: true + type: string + format: google-datetime + isPinned: description: >- - Use validate only mode for this recommendation query. If set to - `true`, a fake model is used that returns arbitrary Document IDs. - Note that the validate only mode should only be used for testing the - API, or if the model is not ready. + Optional. Whether the session is pinned, pinned session will be + displayed on the top of the session list. type: boolean - params: + GoogleCloudDiscoveryengineV1SessionTurn: + id: GoogleCloudDiscoveryengineV1SessionTurn + description: >- + Represents a turn, including a query from the user and a answer from + service. + type: object + properties: + query: description: >- - Additional domain specific parameters for the recommendations. - Allowed values: * `returnDocument`: Boolean. If set to `true`, the - associated Document object is returned in - RecommendResponse.RecommendationResult.document. * `returnScore`: - Boolean. If set to true, the recommendation score corresponding to - each returned Document is set in - RecommendResponse.RecommendationResult.metadata. The given score - indicates the probability of a Document conversion given the user's - context and history. * `strictFiltering`: Boolean. True by default. - If set to `false`, the service returns generic (unfiltered) popular - Documents instead of empty if your filter blocks all recommendation - results. * `diversityLevel`: String. Default empty. If set to be - non-empty, then it needs to be one of: * `no-diversity` * - `low-diversity` * `medium-diversity` * `high-diversity` * - `auto-diversity` This gives request-level control and adjusts - recommendation results based on Document category. * - `attributeFilteringSyntax`: Boolean. False by default. If set to - true, the `filter` field is interpreted according to the new, - attribute-based syntax. - type: object - additionalProperties: - type: any - userLabels: + Optional. The user query. May not be set if this turn is merely + regenerating an answer to a different turn + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Query' + answer: description: >- - The user labels applied to a resource must meet the following - requirements: * Each resource can have multiple labels, up to a - maximum of 64. * Each label must be a key-value pair. * Keys have a - minimum length of 1 character and a maximum length of 63 characters - and cannot be empty. Values can be empty and have a maximum length - of 63 characters. * Keys and values can contain only lowercase - letters, numeric characters, underscores, and dashes. All characters - must use UTF-8 encoding, and international characters are allowed. * - The key portion of a label must be unique. However, you can use the - same key with multiple resources. * Keys must start with a lowercase - letter or international character. See [Requirements for - labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) - for more details. + Optional. The resource name of the answer to the user query. Only + set if the answer generation (/answer API call) happened in this + turn. + type: string + detailedAnswer: + description: >- + Output only. In ConversationalSearchService.GetSession API, if + GetSessionRequest.include_answer_details is set to true, this field + will be populated when getting answer query session. + readOnly: true + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Answer' + queryConfig: + description: >- + Optional. Represents metadata related to the query config, for + example LLM model and version used, model parameters (temperature, + grounding parameters, etc.). The prefix "google." is reserved for + Google-developed functionality. type: object additionalProperties: type: string - GoogleCloudDiscoveryengineV1UserEvent: - id: GoogleCloudDiscoveryengineV1UserEvent - description: >- - UserEvent captures all metadata information Discovery Engine API needs - to know about how end users interact with your website. + GoogleCloudDiscoveryengineV1DataStore: + id: GoogleCloudDiscoveryengineV1DataStore + description: DataStore captures global settings and configs at the DataStore level. type: object properties: - eventType: - description: >- - Required. User event type. Allowed values are: Generic values: * - `search`: Search for Documents. * `view-item`: Detailed page view of - a Document. * `view-item-list`: View of a panel or ordered list of - Documents. * `view-home-page`: View of the home page. * - `view-category-page`: View of a category page, e.g. Home > Men > - Jeans * `add-feedback`: Add a user feedback. Retail-related values: - * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online - shopping * `purchase`: Purchase an item(s) Media-related values: * - `media-play`: Start/resume watching a video, playing a song, etc. * - `media-complete`: Finished or stopped midway through a video, song, - etc. - type: string - userPseudoId: + name: description: >- - Required. A unique identifier for tracking visitors. For example, - this could be implemented with an HTTP cookie, which should be able - to uniquely identify a visitor on a single device. This unique - identifier should not change if the visitor log in/out of the - website. Do not set the field to the same fixed ID for different - users. This mixes the event history of those users together, which - results in degraded model quality. The field must be a UTF-8 encoded - string with a length limit of 128 characters. Otherwise, an - `INVALID_ARGUMENT` error is returned. The field should not contain - PII or user-data. We recommend to use Google Analytics [Client - ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) - for this field. + Immutable. Identifier. The full resource name of the data store. + Format: + `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. + This field must be a UTF-8 encoded string with a length limit of + 1024 characters. type: string - engine: + displayName: description: >- - The Engine resource name, in the form of - `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. - Optional. Only required for Engine produced user events. For - example, user events from blended search. + Required. The data store display name. This field must be a UTF-8 + encoded string with a length limit of 128 characters. Otherwise, an + INVALID_ARGUMENT error is returned. type: string - dataStore: - description: >- - The DataStore resource full name, of the form - `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. - Optional. Only required for user events whose data store can't by - determined by UserEvent.engine or UserEvent.documents. If data store - is set in the parent of write/import/collect user event requests, - this field can be omitted. + industryVertical: + description: Immutable. The industry vertical that the data store registers. type: string - eventTime: - description: >- - Only required for UserEventService.ImportUserEvents method. - Timestamp of when the user event happened. - type: string - format: google-datetime - userInfo: - description: Information about the end user. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1UserInfo' - directUserRequest: + enumDescriptions: + - Value used when unset. + - >- + The generic vertical for documents that are not specific to any + industry vertical. + - The media industry vertical. + - The healthcare FHIR vertical. + enum: + - INDUSTRY_VERTICAL_UNSPECIFIED + - GENERIC + - MEDIA + - HEALTHCARE_FHIR + solutionTypes: description: >- - Should set to true if the request is made directly from the end - user, in which case the UserEvent.user_info.user_agent can be - populated from the HTTP request. This flag should be set only if the - API request is made directly from the end user such as a mobile app - (and not if a gateway or a server is processing and pushing the user - events). This should not be set when using the JavaScript tag in - UserEventService.CollectUserEvent. - type: boolean - sessionId: + The solutions that the data store enrolls. Available solutions for + each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` + and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` + is automatically enrolled. Other solutions cannot be enrolled. + type: array + items: + type: string + enumDescriptions: + - Default value. + - Used for Recommendations AI. + - Used for Discovery Search. + - Used for use cases related to the Generative AI agent. + - >- + Used for use cases related to the Generative Chat agent. It's + used for Generative chat engine only, the associated data stores + must enrolled with `SOLUTION_TYPE_CHAT` solution. + enum: + - SOLUTION_TYPE_UNSPECIFIED + - SOLUTION_TYPE_RECOMMENDATION + - SOLUTION_TYPE_SEARCH + - SOLUTION_TYPE_CHAT + - SOLUTION_TYPE_GENERATIVE_CHAT + defaultSchemaId: description: >- - A unique identifier for tracking a visitor session with a length - limit of 128 bytes. A session is an aggregation of an end user - behavior in a time span. A general guideline to populate the - session_id: 1. If user has no activity for 30 min, a new session_id - should be assigned. 2. The session_id should be unique across users, - suggest use uuid or add UserEvent.user_pseudo_id as prefix. + Output only. The id of the default Schema associated to this data + store. + readOnly: true type: string - pageInfo: - description: >- - Page metadata such as categories and other critical information for - certain event types such as `view-category-page`. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1PageInfo' - attributionToken: + contentConfig: description: >- - Token to attribute an API response to user action(s) to trigger the - event. Highly recommended for user events that are the result of - RecommendationService.Recommend. This field enables accurate - attribution of recommendation model performance. The value must be - one of: * RecommendResponse.attribution_token for events that are - the result of RecommendationService.Recommend. * - SearchResponse.attribution_token for events that are the result of - SearchService.Search. This token enables us to accurately attribute - page view or conversion completion back to the event and the - particular predict response containing this clicked/purchased - product. If user clicks on product K in the recommendation results, - pass RecommendResponse.attribution_token as a URL parameter to - product K's page. When recording events on product K's page, log the - RecommendResponse.attribution_token to this field. + Immutable. The content config of the data store. If this field is + unset, the server behavior defaults to ContentConfig.NO_CONTENT. type: string - filter: - description: >- - The filter syntax consists of an expression language for - constructing a predicate from one or more fields of the documents - being filtered. One example is for `search` events, the associated - SearchRequest may contain a filter expression in - SearchRequest.filter conforming to - https://google.aip.dev/160#filtering. Similarly, for - `view-item-list` events that are generated from a RecommendRequest, - this field may be populated directly from RecommendRequest.filter - conforming to https://google.aip.dev/160#filtering. The value must - be a UTF-8 encoded string with a length limit of 1,000 characters. - Otherwise, an `INVALID_ARGUMENT` error is returned. + enumDescriptions: + - Default value. + - Only contains documents without any Document.content. + - Only contains documents with Document.content. + - The data store is used for public website search. + - >- + The data store is used for workspace search. Details of workspace + data store are specified in the WorkspaceConfig. + enum: + - CONTENT_CONFIG_UNSPECIFIED + - NO_CONTENT + - CONTENT_REQUIRED + - PUBLIC_WEBSITE + - GOOGLE_WORKSPACE + createTime: + description: Output only. Timestamp the DataStore was created at. + readOnly: true type: string - documents: - description: >- - List of Documents associated with this user event. This field is - optional except for the following event types: * `view-item` * - `add-to-cart` * `purchase` * `media-play` * `media-complete` In a - `search` event, this field represents the documents returned to the - end user on the current page (the end user may have not finished - browsing the whole page yet). When a new page is returned to the end - user, after pagination/filtering/ordering even for the same query, a - new `search` event with different UserEvent.documents is desired. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1DocumentInfo' - panel: - description: Panel metadata associated with this user event. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1PanelInfo' - searchInfo: + format: google-datetime + advancedSiteSearchConfig: + description: Optional. Configuration for advanced site search. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig + kmsKeyName: description: >- - SearchService.Search details related to the event. This field should - be set for `search` event. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1SearchInfo' - completionInfo: + Input only. The KMS key to be used to protect this DataStore at + creation time. Must be set for requests that need to comply with + CMEK Org Policy protections. If this field is set and processed + successfully, the DataStore will be protected by the KMS key, as + indicated in the cmek_config field. + type: string + cmekConfig: + description: Output only. CMEK-related information for the DataStore. + readOnly: true + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1CmekConfig' + billingEstimation: + description: Output only. Data size estimation for billing. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1DataStoreBillingEstimation + aclEnabled: description: >- - CompletionService.CompleteQuery details related to the event. This - field should be set for `search` event when autocomplete function is - enabled and the user clicks a suggestion for search. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1CompletionInfo' - transactionInfo: - description: The transaction metadata (if any) associated with this user event. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1TransactionInfo' - tagIds: + Immutable. Whether data in the DataStore has ACL information. If set + to `true`, the source data must have ACL. ACL will be ingested when + data is ingested by DocumentService.ImportDocuments methods. When + ACL is enabled for the DataStore, Document can't be accessed by + calling DocumentService.GetDocument or + DocumentService.ListDocuments. Currently ACL is only supported in + `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content + config. + type: boolean + workspaceConfig: description: >- - A list of identifiers for the independent experiment groups this - user event belongs to. This is used to distinguish between user - events associated with different experiment setups. - type: array - items: - type: string - promotionIds: + Config to store data store type configuration for workspace data. + This must be set when DataStore.content_config is set as + DataStore.ContentConfig.GOOGLE_WORKSPACE. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1WorkspaceConfig' + documentProcessingConfig: + description: Configuration for Document understanding and enrichment. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1DocumentProcessingConfig + startingSchema: description: >- - The promotion IDs if this is an event associated with promotions. - Currently, this field is restricted to at most one ID. - type: array - items: - type: string - attributes: + The start schema to use for this DataStore when provisioning it. If + unset, a default vertical specialized schema will be used. This + field is only used by CreateDataStore API, and will be ignored if + used in other APIs. This field will be omitted from all API + responses including CreateDataStore API. To retrieve a schema of a + DataStore, use SchemaService.GetSchema API instead. The provided + schema will be validated against certain rules on schema. Learn more + from [this + doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Schema' + healthcareFhirConfig: + description: Optional. Configuration for `HEALTHCARE_FHIR` vertical. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1HealthcareFhirConfig + servingConfigDataStore: + description: Optional. Stores serving config at DataStore level. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore + identityMappingStore: description: >- - Extra user event features to include in the recommendation model. - These attributes must NOT contain data that needs to be parsed or - processed further, e.g. JSON or other encodings. If you provide - custom attributes for ingested user events, also include them in the - user events that you associate with prediction requests. Custom - attribute formatting must be consistent between imported events and - events provided with prediction requests. This lets the Discovery - Engine API use those custom attributes when training models and - serving predictions, which helps improve recommendation quality. - This field needs to pass all below criteria, otherwise an - `INVALID_ARGUMENT` error is returned: * The key must be a UTF-8 - encoded string with a length limit of 5,000 characters. * For text - attributes, at most 400 values are allowed. Empty values are not - allowed. Each value must be a UTF-8 encoded string with a length - limit of 256 characters. * For number attributes, at most 400 values - are allowed. For product recommendations, an example of extra user - information is `traffic_channel`, which is how a user arrives at the - site. Users can arrive at the site by coming to the site directly, - coming through Google search, or in other ways. - type: object - additionalProperties: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1CustomAttribute' - mediaInfo: - description: Media-specific info. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1MediaInfo' - GoogleCloudDiscoveryengineV1PageInfo: - id: GoogleCloudDiscoveryengineV1PageInfo - description: Detailed page information. + Immutable. The fully qualified resource name of the associated + IdentityMappingStore. This field can only be set for acl_enabled + DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: + `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. + type: string + isInfobotFaqDataStore: + description: Optional. If set, this DataStore is an Infobot FAQ DataStore. + type: boolean + GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig: + id: GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig + description: Configuration data for advance site search. type: object properties: - pageviewId: - description: >- - A unique ID of a web page view. This should be kept the same for all - user events triggered from the same pageview. For example, an item - detail page view could trigger multiple events as the user is - browsing the page. The `pageview_id` property should be kept the - same for all these events so that they can be grouped together - properly. When using the client side event reporting with JavaScript - pixel and Google Tag Manager, this value is filled in automatically. - type: string - pageCategory: - description: >- - The most specific category associated with a category page. To - represent full path of category, use '>' sign to separate different - hierarchies. If '>' is part of the category name, replace it with - other character(s). Category pages include special pages such as - sales or promotions. For instance, a special sale page may have the - category hierarchy: `"pageCategory" : "Sales > 2017 Black Friday - Deals"`. Required for `view-category-page` events. Other event types - should not set this field. Otherwise, an `INVALID_ARGUMENT` error is - returned. + disableInitialIndex: + description: If set true, initial indexing is disabled for the DataStore. + type: boolean + disableAutomaticRefresh: + description: If set true, automatic refresh is disabled for the DataStore. + type: boolean + GoogleCloudDiscoveryengineV1DataStoreBillingEstimation: + id: GoogleCloudDiscoveryengineV1DataStoreBillingEstimation + description: Estimation of data size per data store. + type: object + properties: + structuredDataSize: + description: Data size for structured data in terms of bytes. type: string - uri: - description: >- - Complete URL (window.location.href) of the user's current page. When - using the client side event reporting with JavaScript pixel and - Google Tag Manager, this value is filled in automatically. Maximum - length 5,000 characters. + format: int64 + unstructuredDataSize: + description: Data size for unstructured data in terms of bytes. type: string - referrerUri: - description: >- - The referrer URL of the current page. When using the client side - event reporting with JavaScript pixel and Google Tag Manager, this - value is filled in automatically. However, some browser privacy - restrictions may cause this field to be empty. + format: int64 + websiteDataSize: + description: Data size for websites in terms of bytes. type: string - GoogleCloudDiscoveryengineV1DocumentInfo: - id: GoogleCloudDiscoveryengineV1DocumentInfo - description: Detailed document information associated with a user event. - type: object - properties: - id: - description: The Document resource ID. + format: int64 + structuredDataUpdateTime: + description: Last updated timestamp for structured data. type: string - name: - description: >- - The Document resource full name, of the form: - `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}` + format: google-datetime + unstructuredDataUpdateTime: + description: Last updated timestamp for unstructured data. type: string - uri: - description: The Document URI - only allowed for website data stores. + format: google-datetime + websiteDataUpdateTime: + description: Last updated timestamp for websites. type: string - quantity: - description: >- - Quantity of the Document associated with the user event. Defaults to - 1. For example, this field is 2 if two quantities of the same - Document are involved in a `add-to-cart` event. Required for events - of the following event types: * `add-to-cart` * `purchase` - type: integer - format: int32 - promotionIds: - description: >- - The promotion IDs associated with this Document. Currently, this - field is restricted to at most one ID. - type: array - items: - type: string - joined: - description: >- - Output only. Whether the referenced Document can be found in the - data store. - readOnly: true - type: boolean - GoogleCloudDiscoveryengineV1PanelInfo: - id: GoogleCloudDiscoveryengineV1PanelInfo - description: Detailed panel information associated with a user event. + format: google-datetime + GoogleCloudDiscoveryengineV1WorkspaceConfig: + id: GoogleCloudDiscoveryengineV1WorkspaceConfig + description: Config to store data store type configuration for workspace data type: object properties: - panelId: - description: Required. The panel ID. + type: + description: The Google Workspace data source. type: string - displayName: - description: The display name of the panel. + enumDescriptions: + - Defaults to an unspecified Workspace type. + - Workspace Data Store contains Drive data + - Workspace Data Store contains Mail data + - Workspace Data Store contains Sites data + - Workspace Data Store contains Calendar data + - Workspace Data Store contains Chat data + - Workspace Data Store contains Groups data + - Workspace Data Store contains Keep data + - Workspace Data Store contains People data + enum: + - TYPE_UNSPECIFIED + - GOOGLE_DRIVE + - GOOGLE_MAIL + - GOOGLE_SITES + - GOOGLE_CALENDAR + - GOOGLE_CHAT + - GOOGLE_GROUPS + - GOOGLE_KEEP + - GOOGLE_PEOPLE + dasherCustomerId: + description: Obfuscated Dasher customer ID. type: string - panelPosition: + superAdminServiceAccount: description: >- - The ordered position of the panel, if shown to the user with other - panels. If set, then total_panels must also be set. - type: integer - format: int32 - totalPanels: + Optional. The super admin service account for the workspace that + will be used for access token generation. For now we only use it for + Native Google Drive connector data ingestion. + type: string + superAdminEmailAddress: description: >- - The total number of panels, including this one, shown to the user. - Must be set if panel_position is set. - type: integer - format: int32 - GoogleCloudDiscoveryengineV1SearchInfo: - id: GoogleCloudDiscoveryengineV1SearchInfo - description: Detailed search information. + Optional. The super admin email address for the workspace that will + be used for access token generation. For now we only use it for + Native Google Drive connector data ingestion. + type: string + GoogleCloudDiscoveryengineV1DocumentProcessingConfig: + id: GoogleCloudDiscoveryengineV1DocumentProcessingConfig + description: >- + A singleton resource of DataStore. If it's empty when DataStore is + created and DataStore is set to + DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will + default to digital parser. type: object properties: - searchQuery: + name: description: >- - The user's search query. See SearchRequest.query for definition. The - value must be a UTF-8 encoded string with a length limit of 5,000 - characters. Otherwise, an `INVALID_ARGUMENT` error is returned. At - least one of search_query or PageInfo.page_category is required for - `search` events. Other event types should not set this field. - Otherwise, an `INVALID_ARGUMENT` error is returned. + The full resource name of the Document Processing Config. Format: + `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. type: string - orderBy: + chunkingConfig: + description: Whether chunking mode is enabled. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig + defaultParsingConfig: description: >- - The order in which products are returned, if applicable. See - SearchRequest.order_by for definition and syntax. The value must be - a UTF-8 encoded string with a length limit of 1,000 characters. - Otherwise, an `INVALID_ARGUMENT` error is returned. This can only be - set for `search` events. Other event types should not set this - field. Otherwise, an `INVALID_ARGUMENT` error is returned. - type: string - offset: + Configurations for default Document parser. If not specified, we + will configure it as default DigitalParsingConfig, and the default + parsing config will be applied to all file types for Document + parsing. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig + parsingConfigOverrides: description: >- - An integer that specifies the current offset for pagination (the - 0-indexed starting location, amongst the products deemed by the API - as relevant). See SearchRequest.offset for definition. If this field - is negative, an `INVALID_ARGUMENT` is returned. This can only be set - for `search` events. Other event types should not set this field. - Otherwise, an `INVALID_ARGUMENT` error is returned. - type: integer - format: int32 - GoogleCloudDiscoveryengineV1CompletionInfo: - id: GoogleCloudDiscoveryengineV1CompletionInfo - description: >- - Detailed completion information including completion attribution token - and clicked completion info. + Map from file type to override the default parsing configuration + based on the file type. Supported keys: * `pdf`: Override parsing + config for PDF files, either digital parsing, ocr parsing or layout + parsing is supported. * `html`: Override parsing config for HTML + files, only digital parsing and layout parsing are supported. * + `docx`: Override parsing config for DOCX files, only digital parsing + and layout parsing are supported. * `pptx`: Override parsing config + for PPTX files, only digital parsing and layout parsing are + supported. * `xlsm`: Override parsing config for XLSM files, only + digital parsing and layout parsing are supported. * `xlsx`: Override + parsing config for XLSX files, only digital parsing and layout + parsing are supported. + type: object + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig + GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig: + id: GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig + description: Configuration for chunking config. type: object properties: - selectedSuggestion: - description: End user selected CompleteQueryResponse.QuerySuggestion.suggestion. - type: string - selectedPosition: + layoutBasedChunkingConfig: + description: Configuration for the layout based chunking. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig + GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig: + id: >- + GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig + description: Configuration for the layout based chunking. + type: object + properties: + chunkSize: description: >- - End user selected CompleteQueryResponse.QuerySuggestion.suggestion - position, starting from 0. + The token size limit for each chunk. Supported values: 100-500 + (inclusive). Default value: 500. type: integer format: int32 - GoogleCloudDiscoveryengineV1TransactionInfo: - id: GoogleCloudDiscoveryengineV1TransactionInfo - description: A transaction represents the entire purchase transaction. + includeAncestorHeadings: + description: >- + Whether to include appending different levels of headings to chunks + from the middle of the document to prevent context loss. Default + value: False. + type: boolean + GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig: + id: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig + description: Related configurations applied to a specific type of document parser. type: object properties: - value: + digitalParsingConfig: + description: Configurations applied to digital parser. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig + ocrParsingConfig: description: >- - Required. Total non-zero value associated with the transaction. This - value may include shipping, tax, or other adjustments to the total - value that you want to include. - type: number - format: float - currency: - description: Required. Currency code. Use three-character ISO-4217 code. - type: string - transactionId: - description: The transaction ID with a length limit of 128 characters. - type: string - tax: - description: All the taxes associated with the transaction. - type: number - format: float - cost: - description: >- - All the costs associated with the products. These can be - manufacturing costs, shipping expenses not borne by the end user, or - any other costs, such that: * Profit = value - tax - cost - type: number - format: float - discountValue: - description: >- - The total discount(s) value applied to this transaction. This figure - should be excluded from TransactionInfo.value For example, if a user - paid TransactionInfo.value amount, then nominal (pre-discount) value - of the transaction is the sum of TransactionInfo.value and - TransactionInfo.discount_value This means that profit is calculated - the same way, regardless of the discount value, and that - TransactionInfo.discount_value can be larger than - TransactionInfo.value: * Profit = value - tax - cost - type: number - format: float - GoogleCloudDiscoveryengineV1CustomAttribute: - id: GoogleCloudDiscoveryengineV1CustomAttribute - description: >- - A custom attribute that is not explicitly modeled in a resource, e.g. - UserEvent. + Configurations applied to OCR parser. Currently it only applies to + PDFs. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig + layoutParsingConfig: + description: Configurations applied to layout parser. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig + GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig: + id: >- + GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig + description: The digital parsing configurations for documents. + type: object + properties: {} + GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig: + id: >- + GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig + description: The OCR parsing configurations for documents. type: object properties: - text: + enhancedDocumentElements: description: >- - The textual values of this custom attribute. For example, - `["yellow", "green"]` when the key is "color". Empty string is not - allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. Exactly - one of CustomAttribute.text or CustomAttribute.numbers should be - set. Otherwise, an `INVALID_ARGUMENT` error is returned. + [DEPRECATED] This field is deprecated. To use the additional + enhanced document elements processing, please switch to + `layout_parsing_config`. + deprecated: true type: array items: type: string - numbers: + useNativeText: description: >- - The numerical values of this custom attribute. For example, `[2.3, - 15.4]` when the key is "lengths_cm". Exactly one of - CustomAttribute.text or CustomAttribute.numbers should be set. - Otherwise, an `INVALID_ARGUMENT` error is returned. - type: array - items: - type: number - format: double - GoogleCloudDiscoveryengineV1MediaInfo: - id: GoogleCloudDiscoveryengineV1MediaInfo - description: Media-specific user event information. + If true, will use native text instead of OCR text on pages + containing native text. + type: boolean + GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig: + id: >- + GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig + description: The layout parsing configurations for documents. type: object properties: - mediaProgressDuration: + enableTableAnnotation: description: >- - The media progress time in seconds, if applicable. For example, if - the end user has finished 90 seconds of a playback video, then - MediaInfo.media_progress_duration.seconds should be set to 90. - type: string - format: google-duration - mediaProgressPercentage: + Optional. If true, the LLM based annotation is added to the table + during parsing. + type: boolean + enableImageAnnotation: description: >- - Media progress should be computed using only the - media_progress_duration relative to the media total length. This - value must be between `[0, 1.0]` inclusive. If this is not a - playback or the progress cannot be computed (e.g. ongoing - livestream), this field should be unset. - type: number - format: float - GoogleCloudDiscoveryengineV1RecommendResponse: - id: GoogleCloudDiscoveryengineV1RecommendResponse - description: Response message for Recommend method. - type: object - properties: - results: + Optional. If true, the LLM based annotation is added to the image + during parsing. + type: boolean + structuredContentTypes: description: >- - A list of recommended Documents. The order represents the ranking - (from the most relevant Document to the least). + Optional. Contains the required structure types to extract from the + document. Supported values: * `shareholder-structure` type: array items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1RecommendResponseRecommendationResult - attributionToken: - description: >- - A unique attribution token. This should be included in the UserEvent - logs resulting from this recommendation, which enables accurate - attribution of recommendation model performance. - type: string - missingIds: - description: >- - IDs of documents in the request that were missing from the default - Branch associated with the requested ServingConfig. + type: string + excludeHtmlElements: + description: Optional. List of HTML elements to exclude from the parsed content. type: array items: type: string - validateOnly: - description: True if RecommendRequest.validate_only was set. + excludeHtmlClasses: + description: Optional. List of HTML classes to exclude from the parsed content. + type: array + items: + type: string + excludeHtmlIds: + description: Optional. List of HTML ids to exclude from the parsed content. + type: array + items: + type: string + enableGetProcessedDocument: + description: >- + Optional. If true, the processed document will be made available for + the GetProcessedDocument API. type: boolean - GoogleCloudDiscoveryengineV1RecommendResponseRecommendationResult: - id: GoogleCloudDiscoveryengineV1RecommendResponseRecommendationResult - description: >- - RecommendationResult represents a generic recommendation result with - associated metadata. + GoogleCloudDiscoveryengineV1Schema: + id: GoogleCloudDiscoveryengineV1Schema + description: Defines the structure and layout of a type of document data. type: object properties: - id: - description: Resource ID of the recommended Document. - type: string - document: - description: Set if `returnDocument` is set to true in RecommendRequest.params. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' - metadata: - description: >- - Additional Document metadata or annotations. Possible values: * - `score`: Recommendation score in double value. Is set if - `returnScore` is set to true in RecommendRequest.params. + structSchema: + description: The structured representation of the schema. type: object additionalProperties: type: any - GoogleCloudDiscoveryengineV1ListSchemasResponse: - id: GoogleCloudDiscoveryengineV1ListSchemasResponse - description: Response message for SchemaService.ListSchemas method. + description: Properties of the object. + jsonSchema: + description: The JSON representation of the schema. + type: string + name: + description: >- + Immutable. The full resource name of the schema, in the format of + `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. + This field must be a UTF-8 encoded string with a length limit of + 1024 characters. + type: string + GoogleCloudDiscoveryengineV1HealthcareFhirConfig: + id: GoogleCloudDiscoveryengineV1HealthcareFhirConfig + description: Config to data store for `HEALTHCARE_FHIR` vertical. type: object properties: - schemas: - description: The Schemas. + enableConfigurableSchema: + description: >- + Whether to enable configurable schema for `HEALTHCARE_FHIR` + vertical. If set to `true`, the predefined healthcare fhir schema + can be extended for more customized searching and filtering. + type: boolean + enableStaticIndexingForBatchIngestion: + description: >- + Whether to enable static indexing for `HEALTHCARE_FHIR` batch + ingestion. If set to `true`, the batch ingestion will be processed + in a static indexing mode which is slower but more capable of + handling larger volume. + type: boolean + GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore: + id: GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore + description: >- + Stores information regarding the serving configurations at DataStore + level. + type: object + properties: + disabledForServing: + description: >- + Optional. If set true, the DataStore will not be available for + serving search requests. + type: boolean + GoogleCloudDiscoveryengineV1ListDataStoresResponse: + id: GoogleCloudDiscoveryengineV1ListDataStoresResponse + description: Response message for DataStoreService.ListDataStores method. + type: object + properties: + dataStores: + description: All the customer's DataStores. type: array items: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Schema' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1DataStore' nextPageToken: description: >- - A token that can be sent as ListSchemasRequest.page_token to + A token that can be sent as ListDataStoresRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. type: string - GoogleCloudDiscoveryengineV1TrainCustomModelRequest: - id: GoogleCloudDiscoveryengineV1TrainCustomModelRequest - description: Request message for SearchTuningService.TrainCustomModel method. + GoogleCloudDiscoveryengineV1ListDocumentsResponse: + id: GoogleCloudDiscoveryengineV1ListDocumentsResponse + description: Response message for DocumentService.ListDocuments method. type: object properties: - gcsTrainingInput: - description: Cloud Storage training input. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1TrainCustomModelRequestGcsTrainingInput - modelType: + documents: + description: The Documents. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' + nextPageToken: description: >- - Model to be trained. Supported values are: * **search-tuning**: Fine - tuning the search system based on data provided. + A token that can be sent as ListDocumentsRequest.page_token to + retrieve the next page. If this field is omitted, there are no + subsequent pages. type: string + GoogleCloudDiscoveryengineV1ImportDocumentsRequest: + id: GoogleCloudDiscoveryengineV1ImportDocumentsRequest + description: Request message for Import methods. + type: object + properties: + inlineSource: + description: The Inline source for the input content for documents. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ImportDocumentsRequestInlineSource + gcsSource: + description: Cloud Storage location for the input content. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1GcsSource' + bigquerySource: + description: BigQuery input source. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1BigQuerySource' + fhirStoreSource: + description: FhirStore input source. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1FhirStoreSource' + spannerSource: + description: Spanner input source. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1SpannerSource' + cloudSqlSource: + description: Cloud SQL input source. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1CloudSqlSource' + firestoreSource: + description: Firestore input source. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1FirestoreSource' + alloyDbSource: + description: AlloyDB input source. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1AlloyDbSource' + bigtableSource: + description: Cloud Bigtable input source. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1BigtableSource' errorConfig: - description: >- - The desired location of errors incurred during the data ingestion - and training. + description: The desired location of errors incurred during the Import. $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1ImportErrorConfig' - modelId: - description: If not provided, a UUID will be generated. + reconciliationMode: + description: >- + The mode of reconciliation between existing documents and the + documents to be imported. Defaults to + ReconciliationMode.INCREMENTAL. type: string - GoogleCloudDiscoveryengineV1TrainCustomModelRequestGcsTrainingInput: - id: GoogleCloudDiscoveryengineV1TrainCustomModelRequestGcsTrainingInput - description: Cloud Storage training data input. - type: object - properties: - corpusDataPath: + enumDescriptions: + - Defaults to `INCREMENTAL`. + - Inserts new documents or updates existing documents. + - >- + Calculates diff and replaces the entire document dataset. Existing + documents may be deleted if they are not present in the source + location. When using this mode, there won't be any downtime on the + dataset targeted. Any document that should remain unchanged or + that should be updated will continue serving while the operation + is running. + enum: + - RECONCILIATION_MODE_UNSPECIFIED + - INCREMENTAL + - FULL + updateMask: description: >- - The Cloud Storage corpus data which could be associated in train - data. The data path format is `gs:///`. A newline delimited - jsonl/ndjson file. For search-tuning model, each line should have - the _id, title and text. Example: `{"_id": "doc1", title: "relevant - doc", "text": "relevant text"}` + Indicates which fields in the provided imported documents to update. + If not set, the default is to update all fields. type: string - queryDataPath: + format: google-fieldmask + autoGenerateIds: description: >- - The gcs query data which could be associated in train data. The data - path format is `gs:///`. A newline delimited jsonl/ndjson file. For - search-tuning model, each line should have the _id and text. - Example: {"_id": "query1", "text": "example query"} - type: string - trainDataPath: + Whether to automatically generate IDs for the documents if absent. + If set to `true`, Document.ids are automatically generated based on + the hash of the payload, where IDs may not be consistent during + multiple imports. In which case ReconciliationMode.FULL is highly + recommended to avoid duplicate contents. If unset or set to `false`, + Document.ids have to be specified using id_field, otherwise, + documents without IDs fail to be imported. Supported data sources: * + GcsSource. GcsSource.data_schema must be `custom` or `csv`. + Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. + BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an + INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. + * FirestoreSource. * BigtableSource. + type: boolean + idField: description: >- - Cloud Storage training data path whose format should be `gs:///`. - The file should be in tsv format. Each line should have the doc_id - and query_id and score (number). For search-tuning model, it should - have the query-id corpus-id score as tsv file header. The score - should be a number in `[0, inf+)`. The larger the number is, the - more relevant the pair is. Example: * `query-id\tcorpus-id\tscore` * - `query1\tdoc1\t1` + The field indicates the ID field or column to be used as unique IDs + of the documents. For GcsSource it is the key of the JSON field. For + instance, `my_id` for JSON `{"my_id": "some_uuid"}`. For others, it + may be the column name of the table where the unique ids are stored. + The values of the JSON field or the table column are used as the + Document.ids. The JSON field or the table column must be of string + type, and the values must be set as valid strings conform to + [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 + characters. Otherwise, documents without valid IDs fail to be + imported. Only set this field when auto_generate_ids is unset or set + as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is + unset, a default value `_id` is used when importing from the allowed + data sources. Supported data sources: * GcsSource. + GcsSource.data_schema must be `custom` or `csv`. Otherwise, an + INVALID_ARGUMENT error is thrown. * BigQuerySource. + BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an + INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. + * BigtableSource. type: string - testDataPath: + forceRefreshContent: description: >- - Cloud Storage test data. Same format as train_data_path. If not - provided, a random 80/20 train/test split will be performed on - train_data_path. - type: string - GoogleCloudDiscoveryengineV1ListCustomModelsResponse: - id: GoogleCloudDiscoveryengineV1ListCustomModelsResponse - description: Response message for SearchTuningService.ListCustomModels method. + Optional. Whether to force refresh the unstructured content of the + documents. If set to `true`, the content part of the documents will + be refreshed regardless of the update status of the referencing + content. + type: boolean + GoogleCloudDiscoveryengineV1ImportDocumentsRequestInlineSource: + id: GoogleCloudDiscoveryengineV1ImportDocumentsRequestInlineSource + description: The inline source for the input config for ImportDocuments method. type: object properties: - models: - description: List of custom tuning models. + documents: + description: >- + Required. A list of documents to update/create. Each document must + have a valid Document.id. Recommended max of 100 items. type: array items: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1CustomTuningModel' - GoogleCloudDiscoveryengineV1CustomTuningModel: - id: GoogleCloudDiscoveryengineV1CustomTuningModel - description: Metadata that describes a custom tuned model. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' + GoogleCloudDiscoveryengineV1FhirStoreSource: + id: GoogleCloudDiscoveryengineV1FhirStoreSource + description: Cloud FhirStore source import data from. type: object properties: - name: + fhirStore: description: >- - Required. The fully qualified resource name of the model. Format: - `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`. - Model must be an alpha-numerical string with limit of 40 characters. - type: string - displayName: - description: The display name of the model. + Required. The full resource name of the FHIR store to import data + from, in the format of + `projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}`. type: string - modelVersion: - description: The version of the model. + gcsStagingDir: + description: >- + Intermediate Cloud Storage directory used for the import with a + length limit of 2,000 characters. Can be specified if one wants to + have the FhirStore export to a specific Cloud Storage directory. type: string - format: int64 - modelState: + resourceTypes: description: >- - The state that the model is in (e.g.`TRAINING` or - `TRAINING_FAILED`). + The FHIR resource types to import. The resource types should be a + subset of all [supported FHIR resource + types](https://cloud.google.com/generative-ai-app-builder/docs/fhir-schema-reference#resource-level-specification). + Default to all supported FHIR resource types if empty. + type: array + items: + type: string + updateFromLatestPredefinedSchema: + description: >- + Optional. Whether to update the DataStore schema to the latest + predefined schema. If true, the DataStore schema will be updated to + include any FHIR fields or resource types that have been added since + the last import and corresponding FHIR resources will be imported + from the FHIR store. Note this field cannot be used in conjunction + with `resource_types`. It should be used after initial import. + type: boolean + GoogleCloudDiscoveryengineV1SpannerSource: + id: GoogleCloudDiscoveryengineV1SpannerSource + description: The Spanner source for importing data + type: object + properties: + projectId: + description: >- + The project ID that contains the Spanner source. Has a length limit + of 128 characters. If not specified, inherits the project ID from + the parent request. type: string - enumDescriptions: - - Default value. - - The model is in a paused training state. - - The model is currently training. - - The model has successfully completed training. - - The model is ready for serving. - - The model training failed. - - >- - The model training finished successfully but metrics did not - improve. - - Input data validation failed. Model training didn't start. - enum: - - MODEL_STATE_UNSPECIFIED - - TRAINING_PAUSED - - TRAINING - - TRAINING_COMPLETE - - READY_FOR_SERVING - - TRAINING_FAILED - - NO_IMPROVEMENT - - INPUT_VALIDATION_FAILED - createTime: - description: 'Deprecated: Timestamp the Model was created at.' - deprecated: true + instanceId: + description: Required. The instance ID of the source Spanner table. type: string - format: google-datetime - trainingStartTime: - description: Timestamp the model training was initiated. + databaseId: + description: Required. The database ID of the source Spanner table. type: string - format: google-datetime - metrics: - description: The metrics of the trained model. - type: object - additionalProperties: - type: number - format: double - errorMessage: + tableId: description: >- - Currently this is only populated if the model state is - `INPUT_VALIDATION_FAILED`. + Required. The table name of the Spanner database that needs to be + imported. type: string - GoogleCloudDiscoveryengineV1SiteSearchEngine: - id: GoogleCloudDiscoveryengineV1SiteSearchEngine - description: >- - SiteSearchEngine captures DataStore level site search persisting - configurations. It is a singleton value per data store. - type: object - properties: - name: + enableDataBoost: description: >- - The fully qualified resource name of the site search engine. Format: - `projects/*/locations/*/dataStores/*/siteSearchEngine` - type: string - GoogleCloudDiscoveryengineV1TargetSite: - id: GoogleCloudDiscoveryengineV1TargetSite - description: A target site for the SiteSearchEngine. + Whether to apply data boost on Spanner export. Enabling this option + will incur additional cost. More info can be found + [here](https://cloud.google.com/spanner/docs/databoost/databoost-overview#billing_and_quotas). + type: boolean + GoogleCloudDiscoveryengineV1CloudSqlSource: + id: GoogleCloudDiscoveryengineV1CloudSqlSource + description: Cloud SQL source import data from. type: object properties: - name: + projectId: description: >- - Output only. The fully qualified resource name of the target site. - `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` - The `target_site_id` is system-generated. - readOnly: true + The project ID that contains the Cloud SQL source. Has a length + limit of 128 characters. If not specified, inherits the project ID + from the parent request. type: string - providedUriPattern: + instanceId: description: >- - Required. Input only. The user provided URI pattern from which the - `generated_uri_pattern` is generated. + Required. The Cloud SQL instance to copy the data from with a length + limit of 256 characters. type: string - type: + databaseId: description: >- - The type of the target site, e.g., whether the site is to be - included or excluded. + Required. The Cloud SQL database to copy the data from with a length + limit of 256 characters. type: string - enumDescriptions: - - >- - This value is unused. In this case, server behavior defaults to - Type.INCLUDE. - - Include the target site. - - Exclude the target site. - enum: - - TYPE_UNSPECIFIED - - INCLUDE - - EXCLUDE - exactMatch: + tableId: description: >- - Input only. If set to false, a uri_pattern is generated to include - all pages whose address contains the provided_uri_pattern. If set to - true, an uri_pattern is generated to try to be an exact match of the - provided_uri_pattern or just the specific page if the - provided_uri_pattern is a specific one. provided_uri_pattern is - always normalized to generate the URI pattern to be used by the - search engine. - type: boolean - generatedUriPattern: + Required. The Cloud SQL table to copy the data from with a length + limit of 256 characters. + type: string + gcsStagingDir: description: >- - Output only. This is system-generated based on the - provided_uri_pattern. - readOnly: true + Intermediate Cloud Storage directory used for the import with a + length limit of 2,000 characters. Can be specified if one wants to + have the Cloud SQL export to a specific Cloud Storage directory. + Ensure that the Cloud SQL service account has the necessary Cloud + Storage Admin permissions to access the specified Cloud Storage + directory. type: string - rootDomainUri: - description: Output only. Root domain of the provided_uri_pattern. - readOnly: true - type: string - siteVerificationInfo: - description: Output only. Site ownership and validity verification status. - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SiteVerificationInfo - indexingStatus: - description: Output only. Indexing status. - readOnly: true - type: string - enumDescriptions: - - Defaults to SUCCEEDED. - - >- - The target site is in the update queue and will be picked up by - indexing pipeline. - - The target site fails to be indexed. - - The target site has been indexed. - - >- - The previously indexed target site has been marked to be deleted. - This is a transitioning state which will resulted in either: 1. - target site deleted if unindexing is successful; 2. state reverts - to SUCCEEDED if the unindexing fails. - enum: - - INDEXING_STATUS_UNSPECIFIED - - PENDING - - FAILED - - SUCCEEDED - - DELETING - updateTime: - description: Output only. The target site's last updated time. - readOnly: true - type: string - format: google-datetime - failureReason: - description: Output only. Failure reason. - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1TargetSiteFailureReason - GoogleCloudDiscoveryengineV1SiteVerificationInfo: - id: GoogleCloudDiscoveryengineV1SiteVerificationInfo - description: Verification information for target sites in advanced site search. + offload: + description: >- + Option for serverless export. Enabling this option will incur + additional cost. More info can be found + [here](https://cloud.google.com/sql/pricing#serverless). + type: boolean + GoogleCloudDiscoveryengineV1FirestoreSource: + id: GoogleCloudDiscoveryengineV1FirestoreSource + description: Firestore source import data from. type: object properties: - siteVerificationState: - description: Site verification state indicating the ownership and validity. + projectId: + description: >- + The project ID that the Cloud SQL source is in with a length limit + of 128 characters. If not specified, inherits the project ID from + the parent request. type: string - enumDescriptions: - - Defaults to VERIFIED. - - Site ownership verified. - - Site ownership pending verification or verification failed. - - >- - Site exempt from verification, e.g., a public website that opens - to all. - enum: - - SITE_VERIFICATION_STATE_UNSPECIFIED - - VERIFIED - - UNVERIFIED - - EXEMPTED - verifyTime: - description: Latest site verification time. + databaseId: + description: >- + Required. The Firestore database to copy the data from with a length + limit of 256 characters. type: string - format: google-datetime - GoogleCloudDiscoveryengineV1TargetSiteFailureReason: - id: GoogleCloudDiscoveryengineV1TargetSiteFailureReason - description: Site search indexing failure reasons. - type: object - properties: - quotaFailure: - description: Failed due to insufficient quota. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure - GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure: - id: GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure - description: Failed due to insufficient quota. - type: object - properties: - totalRequiredQuota: + collectionId: description: >- - This number is an estimation on how much total quota this project - needs to successfully complete indexing. + Required. The Firestore collection (or entity) to copy the data from + with a length limit of 1,500 characters. type: string - format: int64 - GoogleCloudDiscoveryengineV1BatchCreateTargetSitesRequest: - id: GoogleCloudDiscoveryengineV1BatchCreateTargetSitesRequest - description: >- - Request message for SiteSearchEngineService.BatchCreateTargetSites - method. - type: object - properties: - requests: + gcsStagingDir: description: >- - Required. The request message specifying the resources to create. A - maximum of 20 TargetSites can be created in a batch. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1CreateTargetSiteRequest - GoogleCloudDiscoveryengineV1CreateTargetSiteRequest: - id: GoogleCloudDiscoveryengineV1CreateTargetSiteRequest - description: Request message for SiteSearchEngineService.CreateTargetSite method. + Intermediate Cloud Storage directory used for the import with a + length limit of 2,000 characters. Can be specified if one wants to + have the Firestore export to a specific Cloud Storage directory. + Ensure that the Firestore service account has the necessary Cloud + Storage Admin permissions to access the specified Cloud Storage + directory. + type: string + GoogleCloudDiscoveryengineV1AlloyDbSource: + id: GoogleCloudDiscoveryengineV1AlloyDbSource + description: AlloyDB source import data from. type: object properties: - parent: + projectId: description: >- - Required. Parent resource name of TargetSite, such as - `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. + The project ID that contains the AlloyDB source. Has a length limit + of 128 characters. If not specified, inherits the project ID from + the parent request. type: string - targetSite: - description: Required. The TargetSite to create. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1TargetSite' - GoogleCloudDiscoveryengineV1ListTargetSitesResponse: - id: GoogleCloudDiscoveryengineV1ListTargetSitesResponse - description: Response message for SiteSearchEngineService.ListTargetSites method. - type: object - properties: - targetSites: - description: List of TargetSites. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1TargetSite' - nextPageToken: + locationId: description: >- - A token that can be sent as `page_token` to retrieve the next page. - If this field is omitted, there are no subsequent pages. + Required. The AlloyDB location to copy the data from with a length + limit of 256 characters. type: string - totalSize: + clusterId: description: >- - The total number of items matching the request. This will always be - populated in the response. - type: integer - format: int32 - GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchRequest: - id: GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchRequest - description: >- - Request message for SiteSearchEngineService.EnableAdvancedSiteSearch - method. - type: object - properties: {} - GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchRequest: - id: GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchRequest - description: >- - Request message for SiteSearchEngineService.DisableAdvancedSiteSearch - method. - type: object - properties: {} - GoogleCloudDiscoveryengineV1RecrawlUrisRequest: - id: GoogleCloudDiscoveryengineV1RecrawlUrisRequest - description: Request message for SiteSearchEngineService.RecrawlUris method. + Required. The AlloyDB cluster to copy the data from with a length + limit of 256 characters. + type: string + databaseId: + description: >- + Required. The AlloyDB database to copy the data from with a length + limit of 256 characters. + type: string + tableId: + description: >- + Required. The AlloyDB table to copy the data from with a length + limit of 256 characters. + type: string + gcsStagingDir: + description: >- + Intermediate Cloud Storage directory used for the import with a + length limit of 2,000 characters. Can be specified if one wants to + have the AlloyDB export to a specific Cloud Storage directory. + Ensure that the AlloyDB service account has the necessary Cloud + Storage Admin permissions to access the specified Cloud Storage + directory. + type: string + GoogleCloudDiscoveryengineV1BigtableSource: + id: GoogleCloudDiscoveryengineV1BigtableSource + description: The Cloud Bigtable source for importing data. type: object properties: - uris: + projectId: description: >- - Required. List of URIs to crawl. At most 10K URIs are supported, - otherwise an INVALID_ARGUMENT error is thrown. Each URI should match - at least one TargetSite in `site_search_engine`. - type: array - items: - type: string - siteCredential: + The project ID that contains the Bigtable source. Has a length limit + of 128 characters. If not specified, inherits the project ID from + the parent request. + type: string + instanceId: description: >- - Optional. Full resource name of the SiteCredential, such as - `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/siteCredentials/*`. - Only set to crawl private URIs. + Required. The instance ID of the Cloud Bigtable that needs to be + imported. type: string - GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest: - id: GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest - description: >- - Request message for SiteSearchEngineService.BatchVerifyTargetSites - method. - type: object - properties: {} - GoogleCloudDiscoveryengineV1FetchDomainVerificationStatusResponse: - id: GoogleCloudDiscoveryengineV1FetchDomainVerificationStatusResponse + tableId: + description: >- + Required. The table ID of the Cloud Bigtable that needs to be + imported. + type: string + bigtableOptions: + description: >- + Required. Bigtable options that contains information needed when + parsing data into typed structures. For example, column type + annotations. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1BigtableOptions' + GoogleCloudDiscoveryengineV1BigtableOptions: + id: GoogleCloudDiscoveryengineV1BigtableOptions description: >- - Response message for - SiteSearchEngineService.FetchDomainVerificationStatus method. + The Bigtable Options object that contains information to support the + import. type: object properties: - targetSites: - description: List of TargetSites containing the site verification status. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1TargetSite' - nextPageToken: + keyFieldName: description: >- - A token that can be sent as `page_token` to retrieve the next page. - If this field is omitted, there are no subsequent pages. + The field name used for saving row key value in the document. The + name has to match the pattern `a-zA-Z0-9*`. type: string - totalSize: + families: description: >- - The total number of items matching the request. This will always be - populated in the response. - type: integer - format: int32 - GoogleApiHttpBody: - id: GoogleApiHttpBody - description: >- - Message that represents an arbitrary HTTP body. It should only be used - for payload formats that can't be represented as JSON, such as raw - binary or an HTML page. This message can be used both in streaming and - non-streaming API methods in the request as well as the response. It can - be used as a top-level request field, which is convenient if one wants - to extract parameters from either the URL or HTTP template into the - request fields and also want access to the raw HTTP body. Example: - message GetResourceRequest { // A unique request id. string request_id = - 1; // The raw HTTP body is bound to this field. google.api.HttpBody - http_body = 2; } service ResourceService { rpc - GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc - UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } - Example with streaming methods: service CaldavService { rpc - GetCalendar(stream google.api.HttpBody) returns (stream - google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) - returns (stream google.api.HttpBody); } Use of this type only changes - how the request and response bodies are handled, all other features will - continue to work unchanged. + The mapping from family names to an object that contains column + families level information for the given column family. If a family + is not present in this map it will be ignored. + type: object + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumnFamily + GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumnFamily: + id: GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumnFamily + description: The column family of the Bigtable. type: object properties: - contentType: + fieldName: description: >- - The HTTP Content-Type header value specifying the content type of - the body. + The field name to use for this column family in the document. The + name has to match the pattern `a-zA-Z0-9*`. If not set, it is parsed + from the family name with best effort. However, due to different + naming patterns, field name collisions could happen, where parsing + behavior is undefined. type: string - data: - description: The HTTP request/response body as raw binary. + encoding: + description: >- + The encoding mode of the values when the type is not STRING. + Acceptable encoding values are: * `TEXT`: indicates values are + alphanumeric text strings. * `BINARY`: indicates values are encoded + using `HBase Bytes.toBytes` family of functions. This can be + overridden for a specific column by listing that column in `columns` + and specifying an encoding for it. type: string - format: byte - extensions: + enumDescriptions: + - The encoding is unspecified. + - Text encoding. + - Binary encoding. + enum: + - ENCODING_UNSPECIFIED + - TEXT + - BINARY + type: description: >- - Application specific response metadata. Must be set in the first - response for streaming APIs. + The type of values in this column family. The values are expected to + be encoded using `HBase Bytes.toBytes` function when the encoding + value is set to `BINARY`. + type: string + enumDescriptions: + - The type is unspecified. + - String type. + - Numerical type. + - Integer type. + - Variable length integer type. + - BigDecimal type. + - Boolean type. + - JSON type. + enum: + - TYPE_UNSPECIFIED + - STRING + - NUMBER + - INTEGER + - VAR_INTEGER + - BIG_NUMERIC + - BOOLEAN + - JSON + columns: + description: >- + The list of objects that contains column level information for each + column. If a column is not present in this list it will be ignored. type: array items: - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - GoogleCloudDiscoveryengineV1PurgeUserEventsRequest: - id: GoogleCloudDiscoveryengineV1PurgeUserEventsRequest - description: Request message for PurgeUserEvents method. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumn + GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumn: + id: GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumn + description: The column of the Bigtable. type: object properties: - filter: + qualifier: description: >- - Required. The filter string to specify the events to be deleted with - a length limit of 5,000 characters. The eligible fields for - filtering are: * `eventType`: Double quoted UserEvent.event_type - string. * `eventTime`: in ISO 8601 "zulu" format. * `userPseudoId`: - Double quoted string. Specifying this will delete all events - associated with a visitor. * `userId`: Double quoted string. - Specifying this will delete all events associated with a user. - Examples: * Deleting all events in a time range: `eventTime > - "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"` * - Deleting specific eventType: `eventType = "search"` * Deleting all - events for a specific visitor: `userPseudoId = "visitor1024"` * - Deleting all events inside a DataStore: `*` The filtering fields are - assumed to have an implicit AND. + Required. Qualifier of the column. If it cannot be decoded with + utf-8, use a base-64 encoded string instead. type: string - force: + format: byte + fieldName: description: >- - The `force` field is currently not supported. Purge user event - requests will permanently delete all purgeable events. Once the - development is complete: If `force` is set to false, the method will - return the expected purge count without deleting any user events. - This field will default to false if not included in the request. - type: boolean - GoogleCloudDiscoveryengineV1ImportUserEventsRequest: - id: GoogleCloudDiscoveryengineV1ImportUserEventsRequest - description: Request message for the ImportUserEvents request. + The field name to use for this column in the document. The name has + to match the pattern `a-zA-Z0-9*`. If not set, it is parsed from the + qualifier bytes with best effort. However, due to different naming + patterns, field name collisions could happen, where parsing behavior + is undefined. + type: string + encoding: + description: >- + The encoding mode of the values when the type is not `STRING`. + Acceptable encoding values are: * `TEXT`: indicates values are + alphanumeric text strings. * `BINARY`: indicates values are encoded + using `HBase Bytes.toBytes` family of functions. This can be + overridden for a specific column by listing that column in `columns` + and specifying an encoding for it. + type: string + enumDescriptions: + - The encoding is unspecified. + - Text encoding. + - Binary encoding. + enum: + - ENCODING_UNSPECIFIED + - TEXT + - BINARY + type: + description: >- + The type of values in this column family. The values are expected to + be encoded using `HBase Bytes.toBytes` function when the encoding + value is set to `BINARY`. + type: string + enumDescriptions: + - The type is unspecified. + - String type. + - Numerical type. + - Integer type. + - Variable length integer type. + - BigDecimal type. + - Boolean type. + - JSON type. + enum: + - TYPE_UNSPECIFIED + - STRING + - NUMBER + - INTEGER + - VAR_INTEGER + - BIG_NUMERIC + - BOOLEAN + - JSON + GoogleCloudDiscoveryengineV1PurgeDocumentsRequest: + id: GoogleCloudDiscoveryengineV1PurgeDocumentsRequest + description: Request message for DocumentService.PurgeDocuments method. type: object properties: - inlineSource: - description: The Inline source for the input content for UserEvents. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ImportUserEventsRequestInlineSource gcsSource: - description: Cloud Storage location for the input content. + description: >- + Cloud Storage location for the input content. Supported + `data_schema`: * `document_id`: One valid Document.id per line. $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1GcsSource' - bigquerySource: - description: BigQuery input source. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1BigQuerySource' + inlineSource: + description: Inline source for the input content for purge. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1PurgeDocumentsRequestInlineSource + filter: + description: >- + Required. Filter matching documents to purge. Only currently + supported value is `*` (all items). + type: string errorConfig: + description: The desired location of errors incurred during the purge. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1PurgeErrorConfig' + force: description: >- - The desired location of errors incurred during the Import. Cannot be - set for inline user event imports. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1ImportErrorConfig' - GoogleCloudDiscoveryengineV1ImportUserEventsRequestInlineSource: - id: GoogleCloudDiscoveryengineV1ImportUserEventsRequestInlineSource - description: The inline source for the input config for ImportUserEvents method. + Actually performs the purge. If `force` is set to false, return the + expected purge count without deleting any documents. + type: boolean + GoogleCloudDiscoveryengineV1PurgeDocumentsRequestInlineSource: + id: GoogleCloudDiscoveryengineV1PurgeDocumentsRequestInlineSource + description: >- + The inline source for the input config for + DocumentService.PurgeDocuments method. type: object properties: - userEvents: + documents: description: >- - Required. A list of user events to import. Recommended max of 10k - items. + Required. A list of full resource name of documents to purge. In the + format + `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`. + Recommended max of 100 items. type: array items: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1UserEvent' - GoogleCloudDiscoveryengineLoggingErrorLog: - id: GoogleCloudDiscoveryengineLoggingErrorLog - description: An error log which is reported to the Error Reporting system. + type: string + GoogleCloudDiscoveryengineV1PurgeErrorConfig: + id: GoogleCloudDiscoveryengineV1PurgeErrorConfig + description: Configuration of destination for Purge related errors. type: object properties: - serviceContext: - description: The service context in which this error has occurred. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineLoggingServiceContext' - context: - description: A description of the context in which the error occurred. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineLoggingErrorContext' - message: - description: A message describing the error. - type: string - status: - description: The RPC status associated with the error log. - $ref: '#/components/schemas/GoogleRpcStatus' - requestPayload: + gcsPrefix: description: >- - The API request payload, represented as a protocol buffer. Most API - request types are supported—for example: * - `type.googleapis.com/google.cloud.discoveryengine.v1alpha.DocumentService.CreateDocumentRequest` - * - `type.googleapis.com/google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEventRequest` - type: object - additionalProperties: - type: any - description: Properties of the object. - responsePayload: - description: >- - The API response payload, represented as a protocol buffer. This is - used to log some "soft errors", where the response is valid but we - consider there are some quality issues like unjoined events. The - following API responses are supported, and no PII is included: * - `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend` - * - `google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEvent` - * - `google.cloud.discoveryengine.v1alpha.UserEventService.CollectUserEvent` - type: object - additionalProperties: - type: any - description: Properties of the object. - importPayload: - description: The error payload that is populated on LRO import APIs. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineLoggingImportErrorContext - GoogleCloudDiscoveryengineLoggingServiceContext: - id: GoogleCloudDiscoveryengineLoggingServiceContext - description: Describes a running service that sends errors. + Cloud Storage prefix for purge errors. This must be an empty, + existing Cloud Storage directory. Purge errors are written to + sharded files in this directory, one per line, as a JSON-encoded + `google.rpc.Status` message. + type: string + GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse: + id: GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse + description: Response message for DocumentService.BatchGetDocumentsMetadata method. type: object properties: - service: - description: >- - An identifier of the service—for example, - `discoveryengine.googleapis.com`. - type: string - GoogleCloudDiscoveryengineLoggingErrorContext: - id: GoogleCloudDiscoveryengineLoggingErrorContext - description: A description of the context in which an error occurred. + documentsMetadata: + description: The metadata of the Documents. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadata + GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadata: + id: >- + GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadata + description: The metadata of a Document. type: object properties: - httpRequest: - description: The HTTP request which was processed when the error was triggered. + matcherValue: + description: The value of the matcher that was used to match the Document. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineLoggingHttpRequestContext - reportLocation: + #/components/schemas/GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue + state: + description: The state of the document. + type: string + enumDescriptions: + - Should never be set. + - The Document is indexed. + - >- + The Document is not indexed because its URI is not in the + TargetSite. + - The Document is not indexed. + enum: + - STATE_UNSPECIFIED + - INDEXED + - NOT_IN_TARGET_SITE + - NOT_IN_INDEX + lastRefreshedTime: + description: The timestamp of the last time the Document was last indexed. + type: string + format: google-datetime + dataIngestionSource: description: >- - The location in the source code where the decision was made to - report the error, usually the place where it was logged. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineLoggingSourceLocation' - GoogleCloudDiscoveryengineLoggingHttpRequestContext: - id: GoogleCloudDiscoveryengineLoggingHttpRequestContext - description: HTTP request data that is related to a reported error. - type: object - properties: - responseStatusCode: - description: The HTTP response status code for the request. - type: integer - format: int32 - GoogleCloudDiscoveryengineLoggingSourceLocation: - id: GoogleCloudDiscoveryengineLoggingSourceLocation - description: >- - Indicates a location in the source code of the service for which errors - are reported. + The data ingestion source of the Document. Allowed values are: * + `batch`: Data ingested via Batch API, e.g., ImportDocuments. * + `streaming` Data ingested via Streaming API, e.g., FHIR streaming. + type: string + GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue: + id: >- + GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue + description: The value of the matcher that was used to match the Document. type: object properties: - functionName: + uri: + description: If match by URI, the URI of the Document. + type: string + fhirResource: description: >- - Human-readable name of a function or method—for example, - `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`. + Format: + projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} type: string - GoogleCloudDiscoveryengineLoggingImportErrorContext: - id: GoogleCloudDiscoveryengineLoggingImportErrorContext + GoogleCloudDiscoveryengineV1Engine: + id: GoogleCloudDiscoveryengineV1Engine description: >- - The error payload that is populated on LRO import APIs, including the - following: * - `google.cloud.discoveryengine.v1alpha.DocumentService.ImportDocuments` * - `google.cloud.discoveryengine.v1alpha.UserEventService.ImportUserEvents` + Metadata that describes the training and serving parameters of an + Engine. type: object properties: - operation: - description: The operation resource name of the LRO. - type: string - gcsPath: + chatEngineConfig: description: >- - Google Cloud Storage file path of the import source. Can be set for - batch operation error. - type: string - lineNumber: + Configurations for the Chat Engine. Only applicable if solution_type + is SOLUTION_TYPE_CHAT. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1EngineChatEngineConfig + searchEngineConfig: description: >- - Line number of the content in file. Should be empty for permission - or batch operation error. - type: string - document: - description: The detailed content which caused the error on importing a document. + Configurations for the Search Engine. Only applicable if + solution_type is SOLUTION_TYPE_SEARCH. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1EngineSearchEngineConfig + mediaRecommendationEngineConfig: + description: >- + Configurations for the Media Engine. Only applicable on the data + stores with solution_type SOLUTION_TYPE_RECOMMENDATION and + IndustryVertical.MEDIA vertical. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig + chatEngineMetadata: + description: >- + Output only. Additional information of the Chat Engine. Only + applicable if solution_type is SOLUTION_TYPE_CHAT. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1EngineChatEngineMetadata + name: + description: >- + Immutable. Identifier. The fully qualified resource name of the + engine. This field must be a UTF-8 encoded string with a length + limit of 1024 characters. Format: + `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + engine should be 1-63 characters, and valid characters are + /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned. type: string - userEvent: + displayName: description: >- - The detailed content which caused the error on importing a user - event. + Required. The display name of the engine. Should be human readable. + UTF-8 encoded string with limit of 1024 characters. type: string - GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata: - id: GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata - description: >- - Metadata related to the progress of the - SiteSearchEngineService.BatchCreateTargetSites operation. This will be - returned by the google.longrunning.Operation.metadata field. - type: object - properties: createTime: - description: Operation create time. + description: Output only. Timestamp the Recommendation Engine was created at. + readOnly: true type: string format: google-datetime updateTime: - description: >- - Operation last update time. If the operation is done, this is also - the finish time. + description: Output only. Timestamp the Recommendation Engine was last updated. + readOnly: true type: string format: google-datetime - GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse: - id: GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse - description: >- - Response message for SiteSearchEngineService.BatchCreateTargetSites - method. - type: object - properties: - targetSites: - description: TargetSites created. + dataStoreIds: + description: >- + Optional. The data stores associated with this engine. For + SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of + engines, they can only associate with at most one data store. If + solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same + Collection can be associated here. Note that when used in + CreateEngineRequest, one DataStore id must be provided as the system + will use it for necessary initializations. type: array items: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1TargetSite' - GoogleCloudDiscoveryengineV1CreateDataStoreMetadata: - id: GoogleCloudDiscoveryengineV1CreateDataStoreMetadata - description: >- - Metadata related to the progress of the DataStoreService.CreateDataStore - operation. This will be returned by the - google.longrunning.Operation.metadata field. - type: object - properties: - createTime: - description: Operation create time. - type: string - format: google-datetime - updateTime: - description: >- - Operation last update time. If the operation is done, this is also - the finish time. - type: string - format: google-datetime - GoogleCloudDiscoveryengineV1CreateEngineMetadata: - id: GoogleCloudDiscoveryengineV1CreateEngineMetadata - description: >- - Metadata related to the progress of the EngineService.CreateEngine - operation. This will be returned by the - google.longrunning.Operation.metadata field. - type: object - properties: - createTime: - description: Operation create time. + type: string + solutionType: + description: Required. The solutions of the engine. type: string - format: google-datetime - updateTime: + enumDescriptions: + - Default value. + - Used for Recommendations AI. + - Used for Discovery Search. + - Used for use cases related to the Generative AI agent. + - >- + Used for use cases related to the Generative Chat agent. It's used + for Generative chat engine only, the associated data stores must + enrolled with `SOLUTION_TYPE_CHAT` solution. + enum: + - SOLUTION_TYPE_UNSPECIFIED + - SOLUTION_TYPE_RECOMMENDATION + - SOLUTION_TYPE_SEARCH + - SOLUTION_TYPE_CHAT + - SOLUTION_TYPE_GENERATIVE_CHAT + industryVertical: description: >- - Operation last update time. If the operation is done, this is also - the finish time. + Optional. The industry vertical that the engine registers. The + restriction of the Engine industry vertical is based on DataStore: + Vertical on Engine has to match vertical of the DataStore linked to + the engine. type: string - format: google-datetime - GoogleCloudDiscoveryengineV1CreateSchemaMetadata: - id: GoogleCloudDiscoveryengineV1CreateSchemaMetadata - description: Metadata for Create Schema LRO. - type: object - properties: - createTime: - description: Operation create time. - type: string - format: google-datetime - updateTime: + enumDescriptions: + - Value used when unset. + - >- + The generic vertical for documents that are not specific to any + industry vertical. + - The media industry vertical. + - The healthcare FHIR vertical. + enum: + - INDUSTRY_VERTICAL_UNSPECIFIED + - GENERIC + - MEDIA + - HEALTHCARE_FHIR + commonConfig: + description: Common config spec that specifies the metadata of the engine. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1EngineCommonConfig' + disableAnalytics: description: >- - Operation last update time. If the operation is done, this is also - the finish time. + Optional. Whether to disable analytics for searches performed on + this engine. + type: boolean + features: + description: >- + Optional. Feature config for the engine to opt in or opt out of + features. Supported keys: * `*`: all features, if it's present, all + other feature state settings are ignored. * `agent-gallery` * + `no-code-agent-builder` * `prompt-gallery` * `model-selector` * + `notebook-lm` * `people-search` * `people-search-org-chart` * + `bi-directional-audio` * `feedback` * `session-sharing` * + `personalization-memory` - Enables personalization based on user + preferences. + type: object + additionalProperties: + type: string + enumDescriptions: + - The feature state is unspecified. + - The feature is turned on to be accessible. + - The feature is turned off to be inaccessible. + enum: + - FEATURE_STATE_UNSPECIFIED + - FEATURE_STATE_ON + - FEATURE_STATE_OFF + GoogleCloudDiscoveryengineV1EngineChatEngineConfig: + id: GoogleCloudDiscoveryengineV1EngineChatEngineConfig + description: Configurations for a Chat Engine. + type: object + properties: + agentCreationConfig: + description: >- + The configurationt generate the Dialogflow agent that is associated + to this Engine. Note that these configurations are one-time consumed + by and passed to Dialogflow service. It means they cannot be + retrieved using EngineService.GetEngine or EngineService.ListEngines + API after engine creation. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig + dialogflowAgentToLink: + description: >- + The resource name of an exist Dialogflow agent to link to this Chat + Engine. Customers can either provide `agent_creation_config` to + create agent or provide an agent name that links the agent with the + Chat engine. Format: `projects//locations//agents/`. Note that the + `dialogflow_agent_to_link` are one-time consumed by and passed to + Dialogflow service. It means they cannot be retrieved using + EngineService.GetEngine or EngineService.ListEngines API after + engine creation. Use ChatEngineMetadata.dialogflow_agent for actual + agent association after Engine is created. type: string - format: google-datetime - GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata: - id: GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata + allowCrossRegion: + description: >- + Optional. If the flag set to true, we allow the agent and engine are + in different locations, otherwise the agent and engine are required + to be in the same location. The flag is set to false by default. + Note that the `allow_cross_region` are one-time consumed by and + passed to EngineService.CreateEngine. It means they cannot be + retrieved using EngineService.GetEngine or EngineService.ListEngines + API after engine creation. + type: boolean + GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig: + id: GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig description: >- - Metadata related to the progress of the - SiteSearchEngineService.CreateTargetSite operation. This will be - returned by the google.longrunning.Operation.metadata field. + Configurations for generating a Dialogflow agent. Note that these + configurations are one-time consumed by and passed to Dialogflow + service. It means they cannot be retrieved using EngineService.GetEngine + or EngineService.ListEngines API after engine creation. type: object properties: - createTime: - description: Operation create time. + business: + description: >- + Name of the company, organization or other entity that the agent + represents. Used for knowledge connector LLM prompt and for + knowledge search. type: string - format: google-datetime - updateTime: + defaultLanguageCode: description: >- - Operation last update time. If the operation is done, this is also - the finish time. + Required. The default language of the agent as a language tag. See + [Language + Support](https://cloud.google.com/dialogflow/docs/reference/language) + for a list of the currently supported language codes. type: string - format: google-datetime - GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata: - id: GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata - description: >- - Metadata related to the progress of the DataStoreService.DeleteDataStore - operation. This will be returned by the - google.longrunning.Operation.metadata field. + timeZone: + description: >- + Required. The time zone of the agent from the [time zone + database](https://www.iana.org/time-zones), e.g., America/New_York, + Europe/Paris. + type: string + location: + description: >- + Agent location for Agent creation, supported values: global/us/eu. + If not provided, us Engine will create Agent using us-central-1 by + default; eu Engine will create Agent using eu-west-1 by default. + type: string + GoogleCloudDiscoveryengineV1EngineSearchEngineConfig: + id: GoogleCloudDiscoveryengineV1EngineSearchEngineConfig + description: Configurations for a Search Engine. type: object properties: - createTime: - description: Operation create time. - type: string - format: google-datetime - updateTime: + searchTier: description: >- - Operation last update time. If the operation is done, this is also - the finish time. + The search feature tier of this engine. Different tiers might have + different pricing. To learn more, check the pricing documentation. + Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. type: string - format: google-datetime - GoogleCloudDiscoveryengineV1DeleteEngineMetadata: - id: GoogleCloudDiscoveryengineV1DeleteEngineMetadata - description: >- - Metadata related to the progress of the EngineService.DeleteEngine - operation. This will be returned by the - google.longrunning.Operation.metadata field. + enumDescriptions: + - >- + Default value when the enum is unspecified. This is invalid to + use. + - Standard tier. + - Enterprise tier. + enum: + - SEARCH_TIER_UNSPECIFIED + - SEARCH_TIER_STANDARD + - SEARCH_TIER_ENTERPRISE + searchAddOns: + description: The add-on that this search engine enables. + type: array + items: + type: string + enumDescriptions: + - >- + Default value when the enum is unspecified. This is invalid to + use. + - Large language model add-on. + enum: + - SEARCH_ADD_ON_UNSPECIFIED + - SEARCH_ADD_ON_LLM + GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig: + id: GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig + description: Additional config specs for a Media Recommendation engine. type: object properties: - createTime: - description: Operation create time. + type: + description: >- + Required. The type of engine. e.g., `recommended-for-you`. This + field together with optimization_objective describe engine metadata + to use to control engine training and serving. Currently supported + values: `recommended-for-you`, `others-you-may-like`, + `more-like-this`, `most-popular-items`. type: string - format: google-datetime - updateTime: + optimizationObjective: description: >- - Operation last update time. If the operation is done, this is also - the finish time. + The optimization objective. e.g., `cvr`. This field together with + optimization_objective describe engine metadata to use to control + engine training and serving. Currently supported values: `ctr`, + `cvr`. If not specified, we choose default based on engine type. + Default depends on type of recommendation: `recommended-for-you` => + `ctr` `others-you-may-like` => `ctr` type: string - format: google-datetime - GoogleCloudDiscoveryengineV1DeleteSchemaMetadata: - id: GoogleCloudDiscoveryengineV1DeleteSchemaMetadata - description: Metadata for DeleteSchema LRO. + optimizationObjectiveConfig: + description: >- + Name and value of the custom threshold for cvr + optimization_objective. For target_field `watch-time`, + target_field_value must be an integer value indicating the media + progress time in seconds between (0, 86400] (excludes 0, includes + 86400) (e.g., 90). For target_field `watch-percentage`, the + target_field_value must be a valid float value between (0, 1.0] + (excludes 0, includes 1.0) (e.g., 0.5). + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigOptimizationObjectiveConfig + trainingState: + description: >- + The training state that the engine is in (e.g. `TRAINING` or + `PAUSED`). Since part of the cost of running the service is + frequency of training - this can be used to determine when to train + engine in order to control cost. If not specified: the default value + for `CreateEngine` method is `TRAINING`. The default value for + `UpdateEngine` method is to keep the state the same as before. + type: string + enumDescriptions: + - Unspecified training state. + - The engine training is paused. + - The engine is training. + enum: + - TRAINING_STATE_UNSPECIFIED + - PAUSED + - TRAINING + engineFeaturesConfig: + description: Optional. Additional engine features config. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigEngineFeaturesConfig + GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigOptimizationObjectiveConfig: + id: >- + GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigOptimizationObjectiveConfig + description: Custom threshold for `cvr` optimization_objective. type: object properties: - createTime: - description: Operation create time. - type: string - format: google-datetime - updateTime: + targetField: description: >- - Operation last update time. If the operation is done, this is also - the finish time. + Required. The name of the field to target. Currently supported + values: `watch-percentage`, `watch-time`. type: string - format: google-datetime - GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata: - id: GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata + targetFieldValueFloat: + description: Required. The threshold to be applied to the target (e.g., 0.5). + type: number + format: float + GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigEngineFeaturesConfig: + id: >- + GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigEngineFeaturesConfig + description: More feature configs of the selected engine type. + type: object + properties: + recommendedForYouConfig: + description: Recommended for you engine feature config. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig + mostPopularConfig: + description: Most popular engine feature config. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigMostPopularFeatureConfig + GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig: + id: >- + GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig description: >- - Metadata related to the progress of the - SiteSearchEngineService.DeleteTargetSite operation. This will be - returned by the google.longrunning.Operation.metadata field. + Additional feature configurations for creating a `recommended-for-you` + engine. type: object properties: - createTime: - description: Operation create time. - type: string - format: google-datetime - updateTime: + contextEventType: description: >- - Operation last update time. If the operation is done, this is also - the finish time. + The type of event with which the engine is queried at prediction + time. If set to `generic`, only `view-item`, `media-play`,and + `media-complete` will be used as `context-event` in engine training. + If set to `view-home-page`, `view-home-page` will also be used as + `context-events` in addition to `view-item`, `media-play`, and + `media-complete`. Currently supported for the `recommended-for-you` + engine. Currently supported values: `view-home-page`, `generic`. type: string - format: google-datetime - GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata: - id: GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata + GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigMostPopularFeatureConfig: + id: >- + GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigMostPopularFeatureConfig description: >- - Metadata related to the progress of the - SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will - be returned by the google.longrunning.Operation.metadata field. + Feature configurations that are required for creating a Most Popular + engine. type: object properties: - createTime: - description: Operation create time. - type: string - format: google-datetime - updateTime: + timeWindowDays: description: >- - Operation last update time. If the operation is done, this is also - the finish time. + The time window of which the engine is queried at training and + prediction time. Positive integers only. The value translates to the + last X days of events. Currently required for the + `most-popular-items` engine. type: string - format: google-datetime - GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse: - id: GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse - description: >- - Response message for SiteSearchEngineService.DisableAdvancedSiteSearch - method. - type: object - properties: {} - GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata: - id: GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata + format: int64 + GoogleCloudDiscoveryengineV1EngineChatEngineMetadata: + id: GoogleCloudDiscoveryengineV1EngineChatEngineMetadata description: >- - Metadata related to the progress of the - SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be - returned by the google.longrunning.Operation.metadata field. + Additional information of a Chat Engine. Fields in this message are + output only. type: object properties: - createTime: - description: Operation create time. - type: string - format: google-datetime - updateTime: + dialogflowAgent: description: >- - Operation last update time. If the operation is done, this is also - the finish time. + The resource name of a Dialogflow agent, that this Chat Engine + refers to. Format: `projects//locations//agents/`. type: string - format: google-datetime - GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse: - id: GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse - description: >- - Response message for SiteSearchEngineService.EnableAdvancedSiteSearch - method. - type: object - properties: {} - GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata: - id: GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata - description: >- - Metadata related to the progress of the ImportCompletionSuggestions - operation. This will be returned by the - google.longrunning.Operation.metadata field. + GoogleCloudDiscoveryengineV1EngineCommonConfig: + id: GoogleCloudDiscoveryengineV1EngineCommonConfig + description: Common configurations for an Engine. type: object properties: - createTime: - description: Operation create time. - type: string - format: google-datetime - updateTime: + companyName: description: >- - Operation last update time. If the operation is done, this is also - the finish time. - type: string - format: google-datetime - successCount: - description: Count of CompletionSuggestions successfully imported. - type: string - format: int64 - failureCount: - description: Count of CompletionSuggestions that failed to be imported. + The name of the company, business or entity that is associated with + the engine. Setting this may help improve LLM related features. type: string - format: int64 - GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsResponse: - id: GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsResponse - description: >- - Response of the CompletionService.ImportCompletionSuggestions method. If - the long running operation is done, this message is returned by the - google.longrunning.Operations.response field if the operation is - successful. + GoogleCloudDiscoveryengineV1ListEnginesResponse: + id: GoogleCloudDiscoveryengineV1ListEnginesResponse + description: Response message for EngineService.ListEngines method. type: object properties: - errorSamples: - description: A sample of errors encountered while processing the request. + engines: + description: All the customer's Engines. type: array items: - $ref: '#/components/schemas/GoogleRpcStatus' - errorConfig: - description: The desired location of errors incurred during the Import. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1ImportErrorConfig' - GoogleCloudDiscoveryengineV1ImportDocumentsMetadata: - id: GoogleCloudDiscoveryengineV1ImportDocumentsMetadata - description: >- - Metadata related to the progress of the ImportDocuments operation. This - is returned by the google.longrunning.Operation.metadata field. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Engine' + nextPageToken: + description: Not supported. + type: string + GoogleCloudDiscoveryengineV1CheckGroundingRequest: + id: GoogleCloudDiscoveryengineV1CheckGroundingRequest + description: Request message for GroundedGenerationService.CheckGrounding method. type: object properties: - createTime: - description: Operation create time. - type: string - format: google-datetime - updateTime: + answerCandidate: description: >- - Operation last update time. If the operation is done, this is also - the finish time. - type: string - format: google-datetime - successCount: - description: Count of entries that were processed successfully. - type: string - format: int64 - failureCount: - description: Count of entries that encountered errors while processing. - type: string - format: int64 - totalCount: - description: Total count of entries that were processed. + Answer candidate to check. It can have a maximum length of 4096 + tokens. type: string - format: int64 - GoogleCloudDiscoveryengineV1ImportDocumentsResponse: - id: GoogleCloudDiscoveryengineV1ImportDocumentsResponse - description: >- - Response of the ImportDocumentsRequest. If the long running operation is - done, then this message is returned by the - google.longrunning.Operations.response field if the operation was - successful. - type: object - properties: - errorSamples: - description: A sample of errors encountered while processing the request. + facts: + description: List of facts for the grounding check. We support up to 200 facts. type: array items: - $ref: '#/components/schemas/GoogleRpcStatus' - errorConfig: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1GroundingFact' + groundingSpec: + description: Configuration of the grounding check. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1CheckGroundingSpec' + userLabels: description: >- - Echoes the destination for the complete errors in the request if - set. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1ImportErrorConfig' - GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata: - id: GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata - description: >- - Metadata related to the progress of the ImportSuggestionDenyListEntries - operation. This is returned by the google.longrunning.Operation.metadata - field. + The user labels applied to a resource must meet the following + requirements: * Each resource can have multiple labels, up to a + maximum of 64. * Each label must be a key-value pair. * Keys have a + minimum length of 1 character and a maximum length of 63 characters + and cannot be empty. Values can be empty and have a maximum length + of 63 characters. * Keys and values can contain only lowercase + letters, numeric characters, underscores, and dashes. All characters + must use UTF-8 encoding, and international characters are allowed. * + The key portion of a label must be unique. However, you can use the + same key with multiple resources. * Keys must start with a lowercase + letter or international character. See [Google Cloud + Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) + for more details. + type: object + additionalProperties: + type: string + GoogleCloudDiscoveryengineV1GroundingFact: + id: GoogleCloudDiscoveryengineV1GroundingFact + description: Grounding Fact. type: object properties: - createTime: - description: Operation create time. + factText: + description: Text content of the fact. Can be at most 10K characters long. type: string - format: google-datetime - updateTime: + attributes: description: >- - Operation last update time. If the operation is done, this is also - the finish time. - type: string - format: google-datetime - GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse: - id: GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse + Attributes associated with the fact. Common attributes include + `source` (indicating where the fact was sourced from), `author` + (indicating the author of the fact), and so on. + type: object + additionalProperties: + type: string + GoogleCloudDiscoveryengineV1CheckGroundingSpec: + id: GoogleCloudDiscoveryengineV1CheckGroundingSpec + description: Specification for the grounding check. + type: object + properties: + citationThreshold: + description: >- + The threshold (in [0,1]) used for determining whether a fact must be + cited for a claim in the answer candidate. Choosing a higher + threshold will lead to fewer but very strong citations, while + choosing a lower threshold may lead to more but somewhat weaker + citations. If unset, the threshold will default to 0.6. + type: number + format: double + enableClaimLevelScore: + description: >- + The control flag that enables claim-level grounding score in the + response. + type: boolean + GoogleCloudDiscoveryengineV1CheckGroundingResponse: + id: GoogleCloudDiscoveryengineV1CheckGroundingResponse description: >- - Response message for CompletionService.ImportSuggestionDenyListEntries + Response message for the GroundedGenerationService.CheckGrounding method. type: object properties: - errorSamples: - description: A sample of errors encountered while processing the request. + supportScore: + description: >- + The support score for the input answer candidate. Higher the score, + higher is the fraction of claims that are supported by the provided + facts. This is always set when a response is returned. + type: number + format: float + citedChunks: + description: >- + List of facts cited across all claims in the answer candidate. These + are derived from the facts supplied in the request. type: array items: - $ref: '#/components/schemas/GoogleRpcStatus' - importedEntriesCount: - description: Count of deny list entries successfully imported. - type: string - format: int64 - failedEntriesCount: - description: Count of deny list entries that failed to be imported. - type: string - format: int64 - GoogleCloudDiscoveryengineV1ImportUserEventsMetadata: - id: GoogleCloudDiscoveryengineV1ImportUserEventsMetadata - description: >- - Metadata related to the progress of the Import operation. This is - returned by the google.longrunning.Operation.metadata field. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1FactChunk' + citedFacts: + description: >- + List of facts cited across all claims in the answer candidate. These + are derived from the facts supplied in the request. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1CheckGroundingResponseCheckGroundingFactChunk + claims: + description: >- + Claim texts and citation info across all claims in the answer + candidate. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim + GoogleCloudDiscoveryengineV1FactChunk: + id: GoogleCloudDiscoveryengineV1FactChunk + description: Fact Chunk. type: object properties: - createTime: - description: Operation create time. + chunkText: + description: Text content of the fact chunk. Can be at most 10K characters long. type: string - format: google-datetime - updateTime: + source: description: >- - Operation last update time. If the operation is done, this is also - the finish time. - type: string - format: google-datetime - successCount: - description: Count of entries that were processed successfully. + Source from which this fact chunk was retrieved. If it was retrieved + from the GroundingFacts provided in the request then this field will + contain the index of the specific fact from which this chunk was + retrieved. type: string - format: int64 - failureCount: - description: Count of entries that encountered errors while processing. + index: + description: >- + The index of this chunk. Currently, only used for the streaming + mode. + type: integer + format: int32 + sourceMetadata: + description: More fine-grained information for the source reference. + type: object + additionalProperties: + type: string + uri: + description: The URI of the source. type: string - format: int64 - GoogleCloudDiscoveryengineV1ImportUserEventsResponse: - id: GoogleCloudDiscoveryengineV1ImportUserEventsResponse - description: >- - Response of the ImportUserEventsRequest. If the long running operation - was successful, then this message is returned by the - google.longrunning.Operations.response field if the operation was - successful. + title: + description: The title of the source. + type: string + domain: + description: The domain of the source. + type: string + GoogleCloudDiscoveryengineV1CheckGroundingResponseCheckGroundingFactChunk: + id: >- + GoogleCloudDiscoveryengineV1CheckGroundingResponseCheckGroundingFactChunk + description: Fact chunk for grounding check. type: object properties: - errorSamples: - description: A sample of errors encountered while processing the request. + chunkText: + description: Text content of the fact chunk. Can be at most 10K characters long. + type: string + GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim: + id: GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim + description: Text and citation info for a claim in the answer candidate. + type: object + properties: + startPos: + description: >- + Position indicating the start of the claim in the answer candidate, + measured in bytes. Note that this is not measured in characters and, + therefore, must be rendered in the user interface keeping in mind + that some characters may take more than one byte. For example, if + the claim text contains non-ASCII characters, the start and end + positions vary when measured in characters + (programming-language-dependent) and when measured in bytes + (programming-language-independent). + type: integer + format: int32 + endPos: + description: >- + Position indicating the end of the claim in the answer candidate, + exclusive, in bytes. Note that this is not measured in characters + and, therefore, must be rendered as such. For example, if the claim + text contains non-ASCII characters, the start and end positions vary + when measured in characters (programming-language-dependent) and + when measured in bytes (programming-language-independent). + type: integer + format: int32 + claimText: + description: >- + Text for the claim in the answer candidate. Always provided + regardless of whether citations or anti-citations are found. + type: string + citationIndices: + description: >- + A list of indices (into 'cited_chunks') specifying the citations + associated with the claim. For instance [1,3,4] means that + cited_chunks[1], cited_chunks[3], cited_chunks[4] are the facts + cited supporting for the claim. A citation to a fact indicates that + the claim is supported by the fact. type: array items: - $ref: '#/components/schemas/GoogleRpcStatus' - errorConfig: + type: integer + format: int32 + groundingCheckRequired: description: >- - Echoes the destination for the complete errors if this field was set - in the request. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1ImportErrorConfig' - joinedEventsCount: - description: Count of user events imported with complete existing Documents. - type: string - format: int64 - unjoinedEventsCount: + Indicates that this claim required grounding check. When the system + decided this claim doesn't require attribution/grounding check, this + field will be set to false. In that case, no grounding check was + done for the claim and therefore citation_indices should not be + returned. + type: boolean + score: description: >- - Count of user events imported, but with Document information not - found in the existing Branch. - type: string - format: int64 - GoogleCloudDiscoveryengineV1Project: - id: GoogleCloudDiscoveryengineV1Project - description: Metadata and configurations for a Google Cloud project in the service. + Confidence score for the claim in the answer candidate, in the range + of [0, 1]. This is set only when + `CheckGroundingRequest.grounding_spec.enable_claim_level_score` is + true. + type: number + format: double + GoogleCloudDiscoveryengineV1IdentityMappingStore: + id: GoogleCloudDiscoveryengineV1IdentityMappingStore + description: Identity Mapping Store which contains Identity Mapping Entries. type: object properties: name: description: >- - Output only. Full resource name of the project, for example - `projects/{project}`. Note that when making requests, project number - and project id are both acceptable, but the server will always - respond in project number. - readOnly: true - type: string - createTime: - description: Output only. The timestamp when this project is created. - readOnly: true + Immutable. The full resource name of the identity mapping store. + Format: + `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. + This field must be a UTF-8 encoded string with a length limit of + 1024 characters. type: string - format: google-datetime - provisionCompletionTime: + kmsKeyName: description: >- - Output only. The timestamp when this project is successfully - provisioned. Empty value means this project is still provisioning - and is not ready for use. - readOnly: true + Input only. The KMS key to be used to protect this Identity Mapping + Store at creation time. Must be set for requests that need to comply + with CMEK Org Policy protections. If this field is set and processed + successfully, the Identity Mapping Store will be protected by the + KMS key, as indicated in the cmek_config field. type: string - format: google-datetime - serviceTermsMap: + cmekConfig: description: >- - Output only. A map of terms of services. The key is the `id` of - ServiceTerms. + Output only. CMEK-related information for the Identity Mapping + Store. readOnly: true - type: object - additionalProperties: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1CmekConfig' + GoogleCloudDiscoveryengineV1ImportIdentityMappingsRequest: + id: GoogleCloudDiscoveryengineV1ImportIdentityMappingsRequest + description: Request message for IdentityMappingStoreService.ImportIdentityMappings + type: object + properties: + inlineSource: + description: The inline source to import identity mapping entries from. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ImportIdentityMappingsRequestInlineSource + GoogleCloudDiscoveryengineV1ImportIdentityMappingsRequestInlineSource: + id: GoogleCloudDiscoveryengineV1ImportIdentityMappingsRequestInlineSource + description: The inline source to import identity mapping entries from. + type: object + properties: + identityMappingEntries: + description: A maximum of 10000 entries can be imported at one time + type: array + items: $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ProjectServiceTerms - GoogleCloudDiscoveryengineV1ProjectServiceTerms: - id: GoogleCloudDiscoveryengineV1ProjectServiceTerms - description: Metadata about the terms of service. + #/components/schemas/GoogleCloudDiscoveryengineV1IdentityMappingEntry + GoogleCloudDiscoveryengineV1IdentityMappingEntry: + id: GoogleCloudDiscoveryengineV1IdentityMappingEntry + description: >- + Identity Mapping Entry that maps an external identity to an internal + identity. type: object properties: - id: + userId: description: >- - The unique identifier of this terms of service. Available terms: * - `GA_DATA_USE_TERMS`: [Terms for data - use](https://cloud.google.com/retail/data-use-terms). When using - this as `id`, the acceptable version to provide is `2022-11-23`. + User identifier. For Google Workspace user account, user_id should + be the google workspace user email. For non-google identity + provider, user_id is the mapped user identifier configured during + the workforcepool config. type: string - version: + groupId: description: >- - The version string of the terms of service. For acceptable values, - see the comments for id above. + Group identifier. For Google Workspace user account, group_id should + be the google workspace group email. For non-google identity + provider, group_id is the mapped group identifier configured during + the workforcepool config. type: string - state: + externalIdentity: description: >- - Whether the project has accepted/rejected the service terms or it is - still pending. - type: string - enumDescriptions: - - The default value of the enum. This value is not actually used. - - The project has given consent to the terms of service. - - The project is pending to review and accept the terms of service. - - >- - The project has declined or revoked the agreement to terms of - service. - enum: - - STATE_UNSPECIFIED - - TERMS_ACCEPTED - - TERMS_PENDING - - TERMS_DECLINED - acceptTime: - description: The last time when the project agreed to the terms of service. + Required. Identity outside the customer identity provider. The + length limit of external identity will be of 100 characters. type: string - format: google-datetime - declineTime: + GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequest: + id: GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequest + description: Request message for IdentityMappingStoreService.PurgeIdentityMappings + type: object + properties: + inlineSource: + description: The inline source to purge identity mapping entries from. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequestInlineSource + filter: description: >- - The last time when the project declined or revoked the agreement to - terms of service. + Filter matching identity mappings to purge. The eligible field for + filtering is: * `update_time`: in ISO 8601 "zulu" format. * + `external_id` Examples: * Deleting all identity mappings updated in + a time range: `update_time > "2012-04-23T18:25:43.511Z" AND + update_time < "2012-04-23T18:30:43.511Z"` * Deleting all identity + mappings for a given external_id: `external_id = "id1"` * Deleting + all identity mappings inside an identity mapping store: `*` The + filtering fields are assumed to have an implicit AND. Should not be + used with source. An error will be thrown, if both are provided. type: string - format: google-datetime - GoogleCloudDiscoveryengineV1ProvisionProjectMetadata: - id: GoogleCloudDiscoveryengineV1ProvisionProjectMetadata - description: Metadata associated with a project provision operation. + force: + description: >- + Actually performs the purge. If `force` is set to false, return the + expected purge count without deleting any identity mappings. This + field is only supported for purge with filter. For input source this + field is ignored and data will be purged regardless of the value of + this field. + type: boolean + GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequestInlineSource: + id: GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequestInlineSource + description: The inline source to purge identity mapping entries from. type: object - properties: {} - GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata: - id: GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata - description: >- - Metadata related to the progress of the PurgeCompletionSuggestions - operation. This is returned by the google.longrunning.Operation.metadata - field. + properties: + identityMappingEntries: + description: A maximum of 10000 entries can be purged at one time + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1IdentityMappingEntry + GoogleCloudDiscoveryengineV1ListIdentityMappingsResponse: + id: GoogleCloudDiscoveryengineV1ListIdentityMappingsResponse + description: Response message for IdentityMappingStoreService.ListIdentityMappings type: object properties: - createTime: - description: Operation create time. - type: string - format: google-datetime - updateTime: + identityMappingEntries: + description: The Identity Mapping Entries. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1IdentityMappingEntry + nextPageToken: description: >- - Operation last update time. If the operation is done, this is also - the finish time. + A token that can be sent as `page_token` to retrieve the next page. + If this field is omitted, there are no subsequent pages. type: string - format: google-datetime - GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse: - id: GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse + GoogleCloudDiscoveryengineV1ListIdentityMappingStoresResponse: + id: GoogleCloudDiscoveryengineV1ListIdentityMappingStoresResponse description: >- - Response message for CompletionService.PurgeCompletionSuggestions - method. + Response message for + IdentityMappingStoreService.ListIdentityMappingStores type: object properties: - purgeSucceeded: - description: Whether the completion suggestions were successfully purged. - type: boolean - errorSamples: - description: A sample of errors encountered while processing the request. + identityMappingStores: + description: The Identity Mapping Stores. type: array items: - $ref: '#/components/schemas/GoogleRpcStatus' - GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata: - id: GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata - description: >- - Metadata related to the progress of the PurgeDocuments operation. This - will be returned by the google.longrunning.Operation.metadata field. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1IdentityMappingStore + nextPageToken: + description: >- + A token that can be sent as `page_token` to retrieve the next page. + If this field is omitted, there are no subsequent pages. + type: string + GoogleCloudDiscoveryengineV1ProvisionProjectRequest: + id: GoogleCloudDiscoveryengineV1ProvisionProjectRequest + description: Request for ProjectService.ProvisionProject method. type: object properties: - createTime: - description: Operation create time. - type: string - format: google-datetime - updateTime: + acceptDataUseTerms: description: >- - Operation last update time. If the operation is done, this is also - the finish time. - type: string - format: google-datetime - successCount: - description: Count of entries that were deleted successfully. - type: string - format: int64 - failureCount: - description: Count of entries that encountered errors while processing. - type: string - format: int64 - ignoredCount: - description: Count of entries that were ignored as entries were not found. + Required. Set to `true` to specify that caller has read and would + like to give consent to the [Terms for data + use](https://cloud.google.com/retail/data-use-terms). + type: boolean + dataUseTermsVersion: + description: >- + Required. The version of the [Terms for data + use](https://cloud.google.com/retail/data-use-terms) that caller has + read and would like to give consent to. Acceptable version is + `2022-11-23`, and this may change over time. type: string - format: int64 - GoogleCloudDiscoveryengineV1PurgeDocumentsResponse: - id: GoogleCloudDiscoveryengineV1PurgeDocumentsResponse - description: >- - Response message for DocumentService.PurgeDocuments method. If the long - running operation is successfully done, then this message is returned by - the google.longrunning.Operations.response field. + saasParams: + description: Optional. Parameters for Agentspace. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ProvisionProjectRequestSaasParams + GoogleCloudDiscoveryengineV1ProvisionProjectRequestSaasParams: + id: GoogleCloudDiscoveryengineV1ProvisionProjectRequestSaasParams + description: Parameters for Agentspace. type: object properties: - purgeCount: - description: The total count of documents purged as a result of the operation. - type: string - format: int64 - purgeSample: + acceptBizQos: description: >- - A sample of document names that will be deleted. Only populated if - `force` is set to false. A max of 100 names will be returned and the - names are chosen at random. - type: array - items: - type: string - GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata: - id: GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata - description: >- - Metadata related to the progress of the PurgeSuggestionDenyListEntries - operation. This is returned by the google.longrunning.Operation.metadata - field. + Optional. Set to `true` to specify that caller has read and would + like to give consent to the [Terms for Agent Space quality of + service]. + type: boolean + GoogleCloudDiscoveryengineV1RankRequest: + id: GoogleCloudDiscoveryengineV1RankRequest + description: Request message for RankService.Rank method. type: object properties: - createTime: - description: Operation create time. - type: string - format: google-datetime - updateTime: + model: description: >- - Operation last update time. If the operation is done, this is also - the finish time. - type: string - format: google-datetime - GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse: - id: GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse - description: >- - Response message for CompletionService.PurgeSuggestionDenyListEntries - method. - type: object - properties: - purgeCount: - description: Number of suggestion deny list entries purged. - type: string - format: int64 - errorSamples: - description: A sample of errors encountered while processing the request. - type: array - items: - $ref: '#/components/schemas/GoogleRpcStatus' - GoogleCloudDiscoveryengineV1TrainCustomModelMetadata: - id: GoogleCloudDiscoveryengineV1TrainCustomModelMetadata - description: >- - Metadata related to the progress of the TrainCustomModel operation. This - is returned by the google.longrunning.Operation.metadata field. - type: object - properties: - createTime: - description: Operation create time. + The identifier of the model to use. It is one of: * + `semantic-ranker-512@latest`: Semantic ranking model with maximum + input token size 512. It is set to `semantic-ranker-512@latest` by + default if unspecified. type: string - format: google-datetime - updateTime: + topN: description: >- - Operation last update time. If the operation is done, this is also - the finish time. + The number of results to return. If this is unset or no bigger than + zero, returns all results. + type: integer + format: int32 + query: + description: The query to use. type: string - format: google-datetime - GoogleCloudDiscoveryengineV1TrainCustomModelResponse: - id: GoogleCloudDiscoveryengineV1TrainCustomModelResponse - description: >- - Response of the TrainCustomModelRequest. This message is returned by the - google.longrunning.Operations.response field. - type: object - properties: - errorSamples: - description: A sample of errors encountered while processing the data. + records: + description: Required. A list of records to rank. type: array items: - $ref: '#/components/schemas/GoogleRpcStatus' - errorConfig: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1RankingRecord' + ignoreRecordDetailsInResponse: description: >- - Echoes the destination for the complete errors in the request if - set. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1ImportErrorConfig' - modelStatus: + If true, the response will contain only record ID and score. By + default, it is false, the response will contain record details. + type: boolean + userLabels: description: >- - The trained model status. Possible values are: * **bad-data**: The - training data quality is bad. * **no-improvement**: Tuning didn't - improve performance. Won't deploy. * **in-progress**: Model training - job creation is in progress. * **training**: Model is actively - training. * **evaluating**: The model is evaluating trained metrics. - * **indexing**: The model trained metrics are indexing. * **ready**: - The model is ready for serving. - type: string - metrics: - description: The metrics of the trained model. + The user labels applied to a resource must meet the following + requirements: * Each resource can have multiple labels, up to a + maximum of 64. * Each label must be a key-value pair. * Keys have a + minimum length of 1 character and a maximum length of 63 characters + and cannot be empty. Values can be empty and have a maximum length + of 63 characters. * Keys and values can contain only lowercase + letters, numeric characters, underscores, and dashes. All characters + must use UTF-8 encoding, and international characters are allowed. * + The key portion of a label must be unique. However, you can use the + same key with multiple resources. * Keys must start with a lowercase + letter or international character. See [Google Cloud + Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) + for more details. type: object additionalProperties: - type: number - format: double - modelName: - description: Fully qualified name of the CustomTuningModel. - type: string - GoogleCloudDiscoveryengineV1UpdateCmekConfigMetadata: - id: GoogleCloudDiscoveryengineV1UpdateCmekConfigMetadata - description: >- - Metadata related to the progress of the - CmekConfigService.UpdateCmekConfig operation. This will be returned by - the google.longrunning.Operation.metadata field. - type: object - properties: - createTime: - description: Operation create time. - type: string - format: google-datetime - updateTime: - description: >- - Operation last update time. If the operation is done, this is also - the finish time. - type: string - format: google-datetime - GoogleCloudDiscoveryengineV1UpdateSchemaMetadata: - id: GoogleCloudDiscoveryengineV1UpdateSchemaMetadata - description: Metadata for UpdateSchema LRO. + type: string + GoogleCloudDiscoveryengineV1RankingRecord: + id: GoogleCloudDiscoveryengineV1RankingRecord + description: Record message for RankService.Rank method. type: object properties: - createTime: - description: Operation create time. + id: + description: The unique ID to represent the record. type: string - format: google-datetime - updateTime: + title: description: >- - Operation last update time. If the operation is done, this is also - the finish time. - type: string - format: google-datetime - GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata: - id: GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata - description: >- - Metadata related to the progress of the - SiteSearchEngineService.UpdateTargetSite operation. This will be - returned by the google.longrunning.Operation.metadata field. - type: object - properties: - createTime: - description: Operation create time. + The title of the record. Empty by default. At least one of title or + content should be set otherwise an INVALID_ARGUMENT error is thrown. type: string - format: google-datetime - updateTime: + content: description: >- - Operation last update time. If the operation is done, this is also - the finish time. + The content of the record. Empty by default. At least one of title + or content should be set otherwise an INVALID_ARGUMENT error is + thrown. type: string - format: google-datetime - GoogleCloudDiscoveryengineV1alphaAclConfig: - id: GoogleCloudDiscoveryengineV1alphaAclConfig - description: Access Control Configuration. - type: object - properties: - name: + score: description: >- - Immutable. The full resource name of the acl configuration. Format: - `projects/{project}/locations/{location}/aclConfig`. This field must - be a UTF-8 encoded string with a length limit of 1024 characters. - type: string - idpConfig: - description: Identity provider config. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaIdpConfig' - GoogleCloudDiscoveryengineV1alphaIdpConfig: - id: GoogleCloudDiscoveryengineV1alphaIdpConfig - description: Identity Provider Config. + The score of this record based on the given query and selected + model. The score will be rounded to 2 decimal places. If the score + is close to 0, it will be rounded to 0.0001 to avoid returning + unset. + type: number + format: float + GoogleCloudDiscoveryengineV1RankResponse: + id: GoogleCloudDiscoveryengineV1RankResponse + description: Response message for RankService.Rank method. type: object properties: - idpType: - description: Identity provider type configured. - type: string - enumDescriptions: - - Default value. ACL search not enabled. - - Google 1P provider. - - Third party provider. - enum: - - IDP_TYPE_UNSPECIFIED - - GSUITE - - THIRD_PARTY - externalIdpConfig: - description: External Identity provider config. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig - GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig: - id: GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig - description: Third party IDP Config. + records: + description: A list of records sorted by descending score. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1RankingRecord' + GoogleCloudDiscoveryengineV1RecommendRequest: + id: GoogleCloudDiscoveryengineV1RecommendRequest + description: Request message for Recommend method. type: object properties: - workforcePoolName: + userEvent: description: >- - Workforce pool name. Example: - "locations/global/workforcePools/pool_id" - type: string - GoogleCloudDiscoveryengineV1alphaAnswer: - id: GoogleCloudDiscoveryengineV1alphaAnswer - description: Defines an answer. - type: object - properties: - name: + Required. Context about the user, what they are looking at and what + action they took to trigger the Recommend request. Note that this + user event detail won't be ingested to userEvent logs. Thus, a + separate userEvent write request is required for event logging. + Don't set UserEvent.user_pseudo_id or UserEvent.user_info.user_id to + the same fixed ID for different users. If you are trying to receive + non-personalized recommendations (not recommended; this can + negatively impact model performance), instead set + UserEvent.user_pseudo_id to a random unique ID and leave + UserEvent.user_info.user_id unset. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1UserEvent' + pageSize: description: >- - Immutable. Fully qualified name - `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*` - type: string - state: - description: The state of the answer generation. - type: string - enumDescriptions: - - Unknown. - - Answer generation is currently in progress. - - Answer generation currently failed. - - Answer generation has succeeded. - enum: - - STATE_UNSPECIFIED - - IN_PROGRESS - - FAILED - - SUCCEEDED - answerText: - description: The textual answer. - type: string - citations: - description: Citations. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaAnswerCitation - references: - description: References. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaAnswerReference - relatedQuestions: - description: Suggested related questions. - type: array - items: - type: string - steps: - description: Answer generation steps. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaAnswerStep' - queryUnderstandingInfo: - description: Query understanding information. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo - answerSkippedReasons: + Maximum number of results to return. Set this property to the number + of recommendation results needed. If zero, the service chooses a + reasonable default. The maximum allowed value is 100. Values above + 100 are set to 100. + type: integer + format: int32 + filter: description: >- - Additional answer-skipped reasons. This provides the reason for - ignored cases. If nothing is skipped, this field is not set. - type: array - items: - type: string - enumDescriptions: - - Default value. The answer skipped reason is not specified. - - The adversarial query ignored case. - - >- - The non-answer seeking query ignored case Google skips the - answer if the query is chit chat. - - >- - The out-of-domain query ignored case. Google skips the answer if - there are no high-relevance search results. - - >- - The potential policy violation case. Google skips the answer if - there is a potential policy violation detected. This includes - content that may be violent or toxic. - - >- - The no relevant content case. Google skips the answer if there - is no relevant content in the retrieved search results. - - >- - The jail-breaking query ignored case. For example, "Reply in the - tone of a competing company's CEO". Google skips the answer if - the query is classified as a jail-breaking query. - - >- - The customer policy violation case. Google skips the summary if - there is a customer policy violation detected. The policy is - defined by the customer. - - >- - The non-answer seeking query ignored case. Google skips the - answer if the query doesn't have clear intent. - - >- - The low-grounded answer case. Google skips the answer if a well - grounded answer was unable to be generated. - enum: - - ANSWER_SKIPPED_REASON_UNSPECIFIED - - ADVERSARIAL_QUERY_IGNORED - - NON_ANSWER_SEEKING_QUERY_IGNORED - - OUT_OF_DOMAIN_QUERY_IGNORED - - POTENTIAL_POLICY_VIOLATION - - NO_RELEVANT_CONTENT - - JAIL_BREAKING_QUERY_IGNORED - - CUSTOMER_POLICY_VIOLATION - - NON_ANSWER_SEEKING_QUERY_IGNORED_V2 - - LOW_GROUNDED_ANSWER - createTime: - description: Output only. Answer creation timestamp. - readOnly: true - type: string - format: google-datetime - completeTime: - description: Output only. Answer completed timestamp. - readOnly: true + Filter for restricting recommendation results with a length limit of + 5,000 characters. Currently, only filter expressions on the + `filter_tags` attribute is supported. Examples: * `(filter_tags: + ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))` * + `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: + ANY("Green"))` If `attributeFilteringSyntax` is set to true under + the `params` field, then attribute-based expressions are expected + instead of the above described tag-based syntax. Examples: * + (language: ANY("en", "es")) AND NOT (categories: ANY("Movie")) * + (available: true) AND (language: ANY("en", "es")) OR (categories: + ANY("Movie")) If your filter blocks all results, the API returns + generic (unfiltered) popular Documents. If you only want results + strictly matching the filters, set `strictFiltering` to `true` in + RecommendRequest.params to receive empty results instead. Note that + the API never returns Documents with `storageStatus` as `EXPIRED` or + `DELETED` regardless of filter choices. type: string - format: google-datetime - GoogleCloudDiscoveryengineV1alphaAnswerCitation: - id: GoogleCloudDiscoveryengineV1alphaAnswerCitation - description: Citation info for a segment. - type: object - properties: - startIndex: + validateOnly: description: >- - Index indicates the start of the segment, measured in bytes (UTF-8 - unicode). - type: string - format: int64 - endIndex: - description: End of the attributed segment, exclusive. - type: string - format: int64 - sources: - description: Citation sources for the attributed segment. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaAnswerCitationSource - GoogleCloudDiscoveryengineV1alphaAnswerCitationSource: - id: GoogleCloudDiscoveryengineV1alphaAnswerCitationSource - description: Citation source. - type: object - properties: - referenceId: - description: ID of the citation source. - type: string - GoogleCloudDiscoveryengineV1alphaAnswerReference: - id: GoogleCloudDiscoveryengineV1alphaAnswerReference - description: Reference. - type: object - properties: - unstructuredDocumentInfo: - description: Unstructured document information. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo - chunkInfo: - description: Chunk information. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo - structuredDocumentInfo: - description: Structured document information. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo - GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo: - id: GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo - description: Unstructured document information. - type: object - properties: - document: - description: Document resource name. - type: string - uri: - description: URI for the document. - type: string - title: - description: Title. - type: string - chunkContents: - description: List of cited chunk contents derived from document content. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent - structData: + Use validate only mode for this recommendation query. If set to + `true`, a fake model is used that returns arbitrary Document IDs. + Note that the validate only mode should only be used for testing the + API, or if the model is not ready. + type: boolean + params: description: >- - The structured JSON metadata for the document. It is populated from - the struct data from the Chunk in search result. + Additional domain specific parameters for the recommendations. + Allowed values: * `returnDocument`: Boolean. If set to `true`, the + associated Document object is returned in + RecommendResponse.RecommendationResult.document. * `returnScore`: + Boolean. If set to true, the recommendation score corresponding to + each returned Document is set in + RecommendResponse.RecommendationResult.metadata. The given score + indicates the probability of a Document conversion given the user's + context and history. * `strictFiltering`: Boolean. True by default. + If set to `false`, the service returns generic (unfiltered) popular + Documents instead of empty if your filter blocks all recommendation + results. * `diversityLevel`: String. Default empty. If set to be + non-empty, then it needs to be one of: * `no-diversity` * + `low-diversity` * `medium-diversity` * `high-diversity` * + `auto-diversity` This gives request-level control and adjusts + recommendation results based on Document category. * + `attributeFilteringSyntax`: Boolean. False by default. If set to + true, the `filter` field is interpreted according to the new, + attribute-based syntax. type: object additionalProperties: type: any - description: Properties of the object. - GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent: - id: >- - GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent - description: Chunk content. + userLabels: + description: >- + The user labels applied to a resource must meet the following + requirements: * Each resource can have multiple labels, up to a + maximum of 64. * Each label must be a key-value pair. * Keys have a + minimum length of 1 character and a maximum length of 63 characters + and cannot be empty. Values can be empty and have a maximum length + of 63 characters. * Keys and values can contain only lowercase + letters, numeric characters, underscores, and dashes. All characters + must use UTF-8 encoding, and international characters are allowed. * + The key portion of a label must be unique. However, you can use the + same key with multiple resources. * Keys must start with a lowercase + letter or international character. See [Requirements for + labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) + for more details. + type: object + additionalProperties: + type: string + GoogleCloudDiscoveryengineV1UserEvent: + id: GoogleCloudDiscoveryengineV1UserEvent + description: >- + UserEvent captures all metadata information Discovery Engine API needs + to know about how end users interact with your website. type: object properties: - content: - description: Chunk textual content. - type: string - pageIdentifier: - description: Page identifier. + eventType: + description: >- + Required. User event type. Allowed values are: Generic values: * + `search`: Search for Documents. * `view-item`: Detailed page view of + a Document. * `view-item-list`: View of a panel or ordered list of + Documents. * `view-home-page`: View of the home page. * + `view-category-page`: View of a category page, e.g. Home > Men > + Jeans * `add-feedback`: Add a user feedback. Retail-related values: + * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online + shopping * `purchase`: Purchase an item(s) Media-related values: * + `media-play`: Start/resume watching a video, playing a song, etc. * + `media-complete`: Finished or stopped midway through a video, song, + etc. Custom conversion value: * `conversion`: Customer defined + conversion event. type: string - relevanceScore: + conversionType: description: >- - The relevance of the chunk for a given query. Values range from 0.0 - (completely irrelevant) to 1.0 (completely relevant). This value is - for informational purpose only. It may change for the same query and - chunk at any time due to a model retraining or change in - implementation. - type: number - format: float - GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo: - id: GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo - description: Chunk information. - type: object - properties: - chunk: - description: Chunk resource name. - type: string - content: - description: Chunk textual content. + Optional. Conversion type. Required if UserEvent.event_type is + `conversion`. This is a customer-defined conversion name in + lowercase letters or numbers separated by "-", such as "watch", + "good-visit" etc. Do not set the field if UserEvent.event_type is + not `conversion`. This mixes the custom conversion event with + predefined events like `search`, `view-item` etc. type: string - relevanceScore: + userPseudoId: description: >- - The relevance of the chunk for a given query. Values range from 0.0 - (completely irrelevant) to 1.0 (completely relevant). This value is - for informational purpose only. It may change for the same query and - chunk at any time due to a model retraining or change in - implementation. - type: number - format: float - documentMetadata: - description: Document metadata. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata - GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata: - id: >- - GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata - description: Document metadata. - type: object - properties: - document: - description: Document resource name. - type: string - uri: - description: URI for the document. - type: string - title: - description: Title. - type: string - pageIdentifier: - description: Page identifier. + Required. A unique identifier for tracking visitors. For example, + this could be implemented with an HTTP cookie, which should be able + to uniquely identify a visitor on a single device. This unique + identifier should not change if the visitor log in/out of the + website. Do not set the field to the same fixed ID for different + users. This mixes the event history of those users together, which + results in degraded model quality. The field must be a UTF-8 encoded + string with a length limit of 128 characters. Otherwise, an + `INVALID_ARGUMENT` error is returned. The field should not contain + PII or user-data. We recommend to use Google Analytics [Client + ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) + for this field. type: string - structData: + engine: description: >- - The structured JSON metadata for the document. It is populated from - the struct data from the Chunk in search result. - type: object - additionalProperties: - type: any - description: Properties of the object. - GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo: - id: GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo - description: Structured search information. - type: object - properties: - document: - description: Document resource name. - type: string - structData: - description: Structured search data. - type: object - additionalProperties: - type: any - description: Properties of the object. - GoogleCloudDiscoveryengineV1alphaAnswerStep: - id: GoogleCloudDiscoveryengineV1alphaAnswerStep - description: Step information. - type: object - properties: - state: - description: The state of the step. - type: string - enumDescriptions: - - Unknown. - - Step is currently in progress. - - Step currently failed. - - Step has succeeded. - enum: - - STATE_UNSPECIFIED - - IN_PROGRESS - - FAILED - - SUCCEEDED - description: - description: The description of the step. + The Engine resource name, in the form of + `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. + Optional. Only required for Engine produced user events. For + example, user events from blended search. type: string - thought: - description: The thought of the step. + dataStore: + description: >- + The DataStore resource full name, of the form + `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. + Optional. Only required for user events whose data store can't by + determined by UserEvent.engine or UserEvent.documents. If data store + is set in the parent of write/import/collect user event requests, + this field can be omitted. type: string - actions: - description: Actions. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaAnswerStepAction - GoogleCloudDiscoveryengineV1alphaAnswerStepAction: - id: GoogleCloudDiscoveryengineV1alphaAnswerStepAction - description: Action. - type: object - properties: - searchAction: - description: Search action. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction - observation: - description: Observation. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation - GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction: - id: GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction - description: Search action. - type: object - properties: - query: - description: The query to search. + eventTime: + description: >- + Only required for UserEventService.ImportUserEvents method. + Timestamp of when the user event happened. type: string - GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation: - id: GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation - description: Observation. - type: object - properties: - searchResults: + format: google-datetime + userInfo: + description: Information about the end user. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1UserInfo' + directUserRequest: description: >- - Search results observed by the search action, it can be snippets - info or chunk info, depending on the citation type set by the user. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult - GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult: - id: GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult - type: object - properties: - document: - description: Document resource name. + Should set to true if the request is made directly from the end + user, in which case the UserEvent.user_info.user_agent can be + populated from the HTTP request. This flag should be set only if the + API request is made directly from the end user such as a mobile app + (and not if a gateway or a server is processing and pushing the user + events). This should not be set when using the JavaScript tag in + UserEventService.CollectUserEvent. + type: boolean + sessionId: + description: >- + A unique identifier for tracking a visitor session with a length + limit of 128 bytes. A session is an aggregation of an end user + behavior in a time span. A general guideline to populate the + session_id: 1. If user has no activity for 30 min, a new session_id + should be assigned. 2. The session_id should be unique across users, + suggest use uuid or add UserEvent.user_pseudo_id as prefix. type: string - uri: - description: URI for the document. + pageInfo: + description: >- + Page metadata such as categories and other critical information for + certain event types such as `view-category-page`. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1PageInfo' + attributionToken: + description: >- + Token to attribute an API response to user action(s) to trigger the + event. Highly recommended for user events that are the result of + RecommendationService.Recommend. This field enables accurate + attribution of recommendation model performance. The value must be + one of: * RecommendResponse.attribution_token for events that are + the result of RecommendationService.Recommend. * + SearchResponse.attribution_token for events that are the result of + SearchService.Search. This token enables us to accurately attribute + page view or conversion completion back to the event and the + particular predict response containing this clicked/purchased + product. If user clicks on product K in the recommendation results, + pass RecommendResponse.attribution_token as a URL parameter to + product K's page. When recording events on product K's page, log the + RecommendResponse.attribution_token to this field. type: string - title: - description: Title. + filter: + description: >- + The filter syntax consists of an expression language for + constructing a predicate from one or more fields of the documents + being filtered. One example is for `search` events, the associated + SearchRequest may contain a filter expression in + SearchRequest.filter conforming to + https://google.aip.dev/160#filtering. Similarly, for + `view-item-list` events that are generated from a RecommendRequest, + this field may be populated directly from RecommendRequest.filter + conforming to https://google.aip.dev/160#filtering. The value must + be a UTF-8 encoded string with a length limit of 1,000 characters. + Otherwise, an `INVALID_ARGUMENT` error is returned. type: string - snippetInfo: + documents: description: >- - If citation_type is DOCUMENT_LEVEL_CITATION, populate document level - snippets. + List of Documents associated with this user event. This field is + optional except for the following event types: * `view-item` * + `add-to-cart` * `purchase` * `media-play` * `media-complete` In a + `search` event, this field represents the documents returned to the + end user on the current page (the end user may have not finished + browsing the whole page yet). When a new page is returned to the end + user, after pagination/filtering/ordering even for the same query, a + new `search` event with different UserEvent.documents is desired. type: array items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo - chunkInfo: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1DocumentInfo' + panel: + description: Panel metadata associated with this user event. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1PanelInfo' + searchInfo: description: >- - If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, - populate chunk info. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo - structData: + SearchService.Search details related to the event. This field should + be set for `search` event. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1SearchInfo' + completionInfo: description: >- - Data representation. The structured JSON data for the document. It's - populated from the struct data from the Document, or the Chunk in - search result. + CompletionService.CompleteQuery details related to the event. This + field should be set for `search` event when autocomplete function is + enabled and the user clicks a suggestion for search. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1CompletionInfo' + transactionInfo: + description: The transaction metadata (if any) associated with this user event. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1TransactionInfo' + tagIds: + description: >- + A list of identifiers for the independent experiment groups this + user event belongs to. This is used to distinguish between user + events associated with different experiment setups. + type: array + items: + type: string + promotionIds: + description: >- + The promotion IDs if this is an event associated with promotions. + Currently, this field is restricted to at most one ID. + type: array + items: + type: string + attributes: + description: >- + Extra user event features to include in the recommendation model. + These attributes must NOT contain data that needs to be parsed or + processed further, e.g. JSON or other encodings. If you provide + custom attributes for ingested user events, also include them in the + user events that you associate with prediction requests. Custom + attribute formatting must be consistent between imported events and + events provided with prediction requests. This lets the Discovery + Engine API use those custom attributes when training models and + serving predictions, which helps improve recommendation quality. + This field needs to pass all below criteria, otherwise an + `INVALID_ARGUMENT` error is returned: * The key must be a UTF-8 + encoded string with a length limit of 5,000 characters. * For text + attributes, at most 400 values are allowed. Empty values are not + allowed. Each value must be a UTF-8 encoded string with a length + limit of 256 characters. * For number attributes, at most 400 values + are allowed. For product recommendations, an example of extra user + information is `traffic_channel`, which is how a user arrives at the + site. Users can arrive at the site by coming to the site directly, + coming through Google search, or in other ways. type: object additionalProperties: - type: any - description: Properties of the object. - GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo: - id: >- - GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo - description: Snippet information. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1CustomAttribute' + mediaInfo: + description: Media-specific info. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1MediaInfo' + panels: + description: >- + Optional. List of panels associated with this event. Used for + page-level impression data. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1PanelInfo' + GoogleCloudDiscoveryengineV1PageInfo: + id: GoogleCloudDiscoveryengineV1PageInfo + description: Detailed page information. type: object properties: - snippet: - description: Snippet content. + pageviewId: + description: >- + A unique ID of a web page view. This should be kept the same for all + user events triggered from the same pageview. For example, an item + detail page view could trigger multiple events as the user is + browsing the page. The `pageview_id` property should be kept the + same for all these events so that they can be grouped together + properly. When using the client side event reporting with JavaScript + pixel and Google Tag Manager, this value is filled in automatically. type: string - snippetStatus: - description: Status of the snippet defined by the search team. + pageCategory: + description: >- + The most specific category associated with a category page. To + represent full path of category, use '>' sign to separate different + hierarchies. If '>' is part of the category name, replace it with + other character(s). Category pages include special pages such as + sales or promotions. For instance, a special sale page may have the + category hierarchy: `"pageCategory" : "Sales > 2017 Black Friday + Deals"`. Required for `view-category-page` events. Other event types + should not set this field. Otherwise, an `INVALID_ARGUMENT` error is + returned. type: string - GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo: - id: >- - GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo - description: Chunk information. + uri: + description: >- + Complete URL (window.location.href) of the user's current page. When + using the client side event reporting with JavaScript pixel and + Google Tag Manager, this value is filled in automatically. Maximum + length 5,000 characters. + type: string + referrerUri: + description: >- + The referrer URL of the current page. When using the client side + event reporting with JavaScript pixel and Google Tag Manager, this + value is filled in automatically. However, some browser privacy + restrictions may cause this field to be empty. + type: string + GoogleCloudDiscoveryengineV1DocumentInfo: + id: GoogleCloudDiscoveryengineV1DocumentInfo + description: Detailed document information associated with a user event. type: object properties: - chunk: - description: Chunk resource name. + id: + description: The Document resource ID. type: string - content: - description: Chunk textual content. + name: + description: >- + The Document resource full name, of the form: + `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}` type: string - relevanceScore: + uri: + description: The Document URI - only allowed for website data stores. + type: string + quantity: description: >- - The relevance of the chunk for a given query. Values range from 0.0 - (completely irrelevant) to 1.0 (completely relevant). This value is - for informational purpose only. It may change for the same query and - chunk at any time due to a model retraining or change in - implementation. - type: number - format: float - GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo: - id: GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo - description: Query understanding information. - type: object - properties: - queryClassificationInfo: - description: Query classification information. + Quantity of the Document associated with the user event. Defaults to + 1. For example, this field is 2 if two quantities of the same + Document are involved in a `add-to-cart` event. Required for events + of the following event types: * `add-to-cart` * `purchase` + type: integer + format: int32 + promotionIds: + description: >- + The promotion IDs associated with this Document. Currently, this + field is restricted to at most one ID. type: array items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo - GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo: - id: >- - GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo - description: Query classification information. - type: object - properties: - type: - description: Query classification type. - type: string - enumDescriptions: - - Unspecified query classification type. - - Adversarial query classification type. - - Non-answer-seeking query classification type, for chit chat. - - Jail-breaking query classification type. - - Non-answer-seeking query classification type, for no clear intent. - enum: - - TYPE_UNSPECIFIED - - ADVERSARIAL_QUERY - - NON_ANSWER_SEEKING_QUERY - - JAIL_BREAKING_QUERY - - NON_ANSWER_SEEKING_QUERY_V2 - positive: - description: Classification output. + type: string + joined: + description: >- + Output only. Whether the referenced Document can be found in the + data store. + readOnly: true type: boolean - GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata: - id: GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata - description: >- - Metadata related to the progress of the - SiteSearchEngineService.BatchCreateTargetSites operation. This will be - returned by the google.longrunning.Operation.metadata field. + conversionValue: + description: >- + Optional. The conversion value associated with this Document. Must + be set if UserEvent.event_type is "conversion". For example, a value + of 1000 signifies that 1000 seconds were spent viewing a Document + for the `watch` conversion type. + type: number + format: float + GoogleCloudDiscoveryengineV1PanelInfo: + id: GoogleCloudDiscoveryengineV1PanelInfo + description: Detailed panel information associated with a user event. type: object properties: - createTime: - description: Operation create time. + panelId: + description: Required. The panel ID. type: string - format: google-datetime - updateTime: - description: >- - Operation last update time. If the operation is done, this is also - the finish time. + displayName: + description: The display name of the panel. type: string - format: google-datetime - GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse: - id: GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse - description: >- - Response message for SiteSearchEngineService.BatchCreateTargetSites - method. - type: object - properties: - targetSites: - description: TargetSites created. + panelPosition: + description: >- + The ordered position of the panel, if shown to the user with other + panels. If set, then total_panels must also be set. + type: integer + format: int32 + totalPanels: + description: >- + The total number of panels, including this one, shown to the user. + Must be set if panel_position is set. + type: integer + format: int32 + documents: + description: Optional. The document IDs associated with this panel. type: array items: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaTargetSite' - GoogleCloudDiscoveryengineV1alphaTargetSite: - id: GoogleCloudDiscoveryengineV1alphaTargetSite - description: A target site for the SiteSearchEngine. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1DocumentInfo' + GoogleCloudDiscoveryengineV1SearchInfo: + id: GoogleCloudDiscoveryengineV1SearchInfo + description: Detailed search information. type: object properties: - name: + searchQuery: description: >- - Output only. The fully qualified resource name of the target site. - `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` - The `target_site_id` is system-generated. - readOnly: true + The user's search query. See SearchRequest.query for definition. The + value must be a UTF-8 encoded string with a length limit of 5,000 + characters. Otherwise, an `INVALID_ARGUMENT` error is returned. At + least one of search_query or PageInfo.page_category is required for + `search` events. Other event types should not set this field. + Otherwise, an `INVALID_ARGUMENT` error is returned. type: string - providedUriPattern: + orderBy: description: >- - Required. Input only. The user provided URI pattern from which the - `generated_uri_pattern` is generated. + The order in which products are returned, if applicable. See + SearchRequest.order_by for definition and syntax. The value must be + a UTF-8 encoded string with a length limit of 1,000 characters. + Otherwise, an `INVALID_ARGUMENT` error is returned. This can only be + set for `search` events. Other event types should not set this + field. Otherwise, an `INVALID_ARGUMENT` error is returned. type: string - type: + offset: description: >- - The type of the target site, e.g., whether the site is to be - included or excluded. - type: string - enumDescriptions: - - >- - This value is unused. In this case, server behavior defaults to - Type.INCLUDE. - - Include the target site. - - Exclude the target site. - enum: - - TYPE_UNSPECIFIED - - INCLUDE - - EXCLUDE - exactMatch: - description: >- - Input only. If set to false, a uri_pattern is generated to include - all pages whose address contains the provided_uri_pattern. If set to - true, an uri_pattern is generated to try to be an exact match of the - provided_uri_pattern or just the specific page if the - provided_uri_pattern is a specific one. provided_uri_pattern is - always normalized to generate the URI pattern to be used by the - search engine. - type: boolean - generatedUriPattern: - description: >- - Output only. This is system-generated based on the - provided_uri_pattern. - readOnly: true - type: string - rootDomainUri: - description: Output only. Root domain of the provided_uri_pattern. - readOnly: true - type: string - siteVerificationInfo: - description: Output only. Site ownership and validity verification status. - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo - indexingStatus: - description: Output only. Indexing status. - readOnly: true - type: string - enumDescriptions: - - Defaults to SUCCEEDED. - - >- - The target site is in the update queue and will be picked up by - indexing pipeline. - - The target site fails to be indexed. - - The target site has been indexed. - - >- - The previously indexed target site has been marked to be deleted. - This is a transitioning state which will resulted in either: 1. - target site deleted if unindexing is successful; 2. state reverts - to SUCCEEDED if the unindexing fails. - enum: - - INDEXING_STATUS_UNSPECIFIED - - PENDING - - FAILED - - SUCCEEDED - - DELETING - updateTime: - description: Output only. The target site's last updated time. - readOnly: true - type: string - format: google-datetime - failureReason: - description: Output only. Failure reason. - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason - GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo: - id: GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo - description: Verification information for target sites in advanced site search. + An integer that specifies the current offset for pagination (the + 0-indexed starting location, amongst the products deemed by the API + as relevant). See SearchRequest.offset for definition. If this field + is negative, an `INVALID_ARGUMENT` is returned. This can only be set + for `search` events. Other event types should not set this field. + Otherwise, an `INVALID_ARGUMENT` error is returned. + type: integer + format: int32 + GoogleCloudDiscoveryengineV1CompletionInfo: + id: GoogleCloudDiscoveryengineV1CompletionInfo + description: >- + Detailed completion information including completion attribution token + and clicked completion info. type: object properties: - siteVerificationState: - description: Site verification state indicating the ownership and validity. - type: string - enumDescriptions: - - Defaults to VERIFIED. - - Site ownership verified. - - Site ownership pending verification or verification failed. - - >- - Site exempt from verification, e.g., a public website that opens - to all. - enum: - - SITE_VERIFICATION_STATE_UNSPECIFIED - - VERIFIED - - UNVERIFIED - - EXEMPTED - verifyTime: - description: Latest site verification time. + selectedSuggestion: + description: End user selected CompleteQueryResponse.QuerySuggestion.suggestion. type: string - format: google-datetime - GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason: - id: GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason - description: Site search indexing failure reasons. - type: object - properties: - quotaFailure: - description: Failed due to insufficient quota. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure - GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure: - id: GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure - description: Failed due to insufficient quota. - type: object - properties: - totalRequiredQuota: + selectedPosition: description: >- - This number is an estimation on how much total quota this project - needs to successfully complete indexing. - type: string - format: int64 - GoogleCloudDiscoveryengineV1alphaCmekConfig: - id: GoogleCloudDiscoveryengineV1alphaCmekConfig - description: Configurations used to enable CMEK data encryption with Cloud KMS keys. + End user selected CompleteQueryResponse.QuerySuggestion.suggestion + position, starting from 0. + type: integer + format: int32 + GoogleCloudDiscoveryengineV1TransactionInfo: + id: GoogleCloudDiscoveryengineV1TransactionInfo + description: A transaction represents the entire purchase transaction. type: object properties: - name: + value: description: >- - Required. Name of the CmekConfig, of the form - `projects/{project}/locations/{location}/cmekConfig` or - `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`. + Required. Total non-zero value associated with the transaction. This + value may include shipping, tax, or other adjustments to the total + value that you want to include. + type: number + format: float + currency: + description: Required. Currency code. Use three-character ISO-4217 code. type: string - kmsKey: - description: >- - Kms key resource name which will be used to encrypt resources - `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. + transactionId: + description: The transaction ID with a length limit of 128 characters. type: string - kmsKeyVersion: + tax: + description: All the taxes associated with the transaction. + type: number + format: float + cost: description: >- - Kms key version resource name which will be used to encrypt - resources `/cryptoKeyVersions/{keyVersion}`. - type: string - state: - description: Output only. State of the CmekConfig. - readOnly: true - type: string - enumDescriptions: - - The CmekConfig state is unknown. - - The CmekConfig is creating. - - The CmekConfig can be used with DataStores. - - >- - The CmekConfig is unavailable, most likely due to the KMS Key - being revoked. - - The CmekConfig is deleting. - - >- - The CmekConfig is not usable, most likely due to some internal - issue. - - The KMS key version is being rotated. - enum: - - STATE_UNSPECIFIED - - CREATING - - ACTIVE - - KEY_ISSUE - - DELETING - - UNUSABLE - - ACTIVE_ROTATING - isDefault: - description: Output only. The default CmekConfig for the Customer. - readOnly: true - type: boolean - lastRotationTimestampMicros: - description: Output only. The timestamp of the last key rotation. - readOnly: true - type: string - format: int64 - GoogleCloudDiscoveryengineV1alphaControl: - id: GoogleCloudDiscoveryengineV1alphaControl + All the costs associated with the products. These can be + manufacturing costs, shipping expenses not borne by the end user, or + any other costs, such that: * Profit = value - tax - cost + type: number + format: float + discountValue: + description: >- + The total discount(s) value applied to this transaction. This figure + should be excluded from TransactionInfo.value For example, if a user + paid TransactionInfo.value amount, then nominal (pre-discount) value + of the transaction is the sum of TransactionInfo.value and + TransactionInfo.discount_value This means that profit is calculated + the same way, regardless of the discount value, and that + TransactionInfo.discount_value can be larger than + TransactionInfo.value: * Profit = value - tax - cost + type: number + format: float + GoogleCloudDiscoveryengineV1CustomAttribute: + id: GoogleCloudDiscoveryengineV1CustomAttribute description: >- - Defines a conditioned behavior to employ during serving. Must be - attached to a ServingConfig to be considered at serving time. Permitted - actions dependent on `SolutionType`. + A custom attribute that is not explicitly modeled in a resource, e.g. + UserEvent. type: object properties: - boostAction: - description: Defines a boost-type control - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaControlBoostAction - filterAction: - description: >- - Defines a filter-type control Currently not supported by - Recommendation - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaControlFilterAction - redirectAction: - description: Defines a redirect-type control. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaControlRedirectAction - synonymsAction: - description: Treats a group of terms as synonyms of one another. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaControlSynonymsAction - name: - description: >- - Immutable. Fully qualified name - `projects/*/locations/global/dataStore/*/controls/*` - type: string - displayName: - description: >- - Required. Human readable name. The identifier used in UI views. Must - be UTF-8 encoded string. Length limit is 128 characters. Otherwise - an INVALID ARGUMENT error is thrown. - type: string - associatedServingConfigIds: + text: description: >- - Output only. List of all ServingConfig IDs this control is attached - to. May take up to 10 minutes to update after changes. - readOnly: true + The textual values of this custom attribute. For example, + `["yellow", "green"]` when the key is "color". Empty string is not + allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. Exactly + one of CustomAttribute.text or CustomAttribute.numbers should be + set. Otherwise, an `INVALID_ARGUMENT` error is returned. type: array items: type: string - solutionType: + numbers: description: >- - Required. Immutable. What solution the control belongs to. Must be - compatible with vertical of resource. Otherwise an INVALID ARGUMENT - error is thrown. - type: string - enumDescriptions: - - Default value. - - Used for Recommendations AI. - - Used for Discovery Search. - - Used for use cases related to the Generative AI agent. - - >- - Used for use cases related to the Generative Chat agent. It's used - for Generative chat engine only, the associated data stores must - enrolled with `SOLUTION_TYPE_CHAT` solution. - enum: - - SOLUTION_TYPE_UNSPECIFIED - - SOLUTION_TYPE_RECOMMENDATION - - SOLUTION_TYPE_SEARCH - - SOLUTION_TYPE_CHAT - - SOLUTION_TYPE_GENERATIVE_CHAT - useCases: - description: >- - Specifies the use case for the control. Affects what condition - fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently - only allow one use case per control. Must be set when solution_type - is SolutionType.SOLUTION_TYPE_SEARCH. - type: array - items: - type: string - enumDescriptions: - - Value used when unset. Will not occur in CSS. - - Search use case. Expects the traffic has a non-empty query. - - Browse use case. Expects the traffic has an empty query. - enum: - - SEARCH_USE_CASE_UNSPECIFIED - - SEARCH_USE_CASE_SEARCH - - SEARCH_USE_CASE_BROWSE - conditions: - description: >- - Determines when the associated action will trigger. Omit to always - apply the action. Currently only a single condition may be - specified. Otherwise an INVALID ARGUMENT error is thrown. + The numerical values of this custom attribute. For example, `[2.3, + 15.4]` when the key is "lengths_cm". Exactly one of + CustomAttribute.text or CustomAttribute.numbers should be set. + Otherwise, an `INVALID_ARGUMENT` error is returned. type: array items: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaCondition' - GoogleCloudDiscoveryengineV1alphaControlBoostAction: - id: GoogleCloudDiscoveryengineV1alphaControlBoostAction - description: Adjusts order of products in returned list. + type: number + format: double + GoogleCloudDiscoveryengineV1MediaInfo: + id: GoogleCloudDiscoveryengineV1MediaInfo + description: Media-specific user event information. type: object properties: - boost: - description: >- - Required. Strength of the boost, which should be in [-1, 1]. - Negative boost means demotion. Default is 0.0 (No-op). - type: number - format: float - filter: + mediaProgressDuration: description: >- - Required. Specifies which products to apply the boost to. If no - filter is provided all products will be boosted (No-op). Syntax - documentation: https://cloud.google.com/retail/docs/filter-and-order - Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT - error is thrown. + The media progress time in seconds, if applicable. For example, if + the end user has finished 90 seconds of a playback video, then + MediaInfo.media_progress_duration.seconds should be set to 90. type: string - dataStore: + format: google-duration + mediaProgressPercentage: description: >- - Required. Specifies which data store's documents can be boosted by - this control. Full data store name e.g. - projects/123/locations/global/collections/default_collection/dataStores/default_data_store - type: string - GoogleCloudDiscoveryengineV1alphaControlFilterAction: - id: GoogleCloudDiscoveryengineV1alphaControlFilterAction - description: >- - Specified which products may be included in results. Uses same filter as - boost. + Media progress should be computed using only the + media_progress_duration relative to the media total length. This + value must be between `[0, 1.0]` inclusive. If this is not a + playback or the progress cannot be computed (e.g. ongoing + livestream), this field should be unset. + type: number + format: float + GoogleCloudDiscoveryengineV1RecommendResponse: + id: GoogleCloudDiscoveryengineV1RecommendResponse + description: Response message for Recommend method. type: object properties: - filter: - description: >- - Required. A filter to apply on the matching condition results. - Required Syntax documentation: - https://cloud.google.com/retail/docs/filter-and-order Maximum length - is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. - type: string - dataStore: + results: description: >- - Required. Specifies which data store's documents can be filtered by - this control. Full data store name e.g. - projects/123/locations/global/collections/default_collection/dataStores/default_data_store - type: string - GoogleCloudDiscoveryengineV1alphaControlRedirectAction: - id: GoogleCloudDiscoveryengineV1alphaControlRedirectAction - description: Redirects a shopper to the provided URI. - type: object - properties: - redirectUri: + A list of recommended Documents. The order represents the ranking + (from the most relevant Document to the least). + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1RecommendResponseRecommendationResult + attributionToken: description: >- - Required. The URI to which the shopper will be redirected. Required. - URI must have length equal or less than 2000 characters. Otherwise - an INVALID ARGUMENT error is thrown. + A unique attribution token. This should be included in the UserEvent + logs resulting from this recommendation, which enables accurate + attribution of recommendation model performance. type: string - GoogleCloudDiscoveryengineV1alphaControlSynonymsAction: - id: GoogleCloudDiscoveryengineV1alphaControlSynonymsAction - description: >- - Creates a set of terms that will act as synonyms of one another. - Example: "happy" will also be considered as "glad", "glad" will also be - considered as "happy". - type: object - properties: - synonyms: + missingIds: description: >- - Defines a set of synonyms. Can specify up to 100 synonyms. Must - specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is - thrown. + IDs of documents in the request that were missing from the default + Branch associated with the requested ServingConfig. type: array items: type: string - GoogleCloudDiscoveryengineV1alphaCondition: - id: GoogleCloudDiscoveryengineV1alphaCondition - description: Defines circumstances to be checked before allowing a behavior + validateOnly: + description: True if RecommendRequest.validate_only was set. + type: boolean + GoogleCloudDiscoveryengineV1RecommendResponseRecommendationResult: + id: GoogleCloudDiscoveryengineV1RecommendResponseRecommendationResult + description: >- + RecommendationResult represents a generic recommendation result with + associated metadata. type: object properties: - queryTerms: - description: >- - Search only A list of terms to match the query on. Cannot be set - when Condition.query_regex is set. Maximum of 10 query terms. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaConditionQueryTerm - activeTimeRange: + id: + description: Resource ID of the recommended Document. + type: string + document: + description: Set if `returnDocument` is set to true in RecommendRequest.params. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' + metadata: description: >- - Range of time(s) specifying when condition is active. Maximum of 10 - time ranges. + Additional Document metadata or annotations. Possible values: * + `score`: Recommendation score in double value. Is set if + `returnScore` is set to true in RecommendRequest.params. + type: object + additionalProperties: + type: any + GoogleCloudDiscoveryengineV1ListSchemasResponse: + id: GoogleCloudDiscoveryengineV1ListSchemasResponse + description: Response message for SchemaService.ListSchemas method. + type: object + properties: + schemas: + description: The Schemas. type: array items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaConditionTimeRange - queryRegex: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Schema' + nextPageToken: description: >- - Optional. Query regex to match the whole search query. Cannot be set - when Condition.query_terms is set. This is currently supporting - promotion use case. + A token that can be sent as ListSchemasRequest.page_token to + retrieve the next page. If this field is omitted, there are no + subsequent pages. type: string - GoogleCloudDiscoveryengineV1alphaConditionQueryTerm: - id: GoogleCloudDiscoveryengineV1alphaConditionQueryTerm - description: Matcher for search request query + GoogleCloudDiscoveryengineV1TrainCustomModelRequest: + id: GoogleCloudDiscoveryengineV1TrainCustomModelRequest + description: Request message for SearchTuningService.TrainCustomModel method. type: object properties: - value: + gcsTrainingInput: + description: Cloud Storage training input. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1TrainCustomModelRequestGcsTrainingInput + modelType: description: >- - The specific query value to match against Must be lowercase, must be - UTF-8. Can have at most 3 space separated terms if full_match is - true. Cannot be an empty string. Maximum length of 5000 characters. - type: string - fullMatch: - description: Whether the search query needs to exactly match the query term. - type: boolean - GoogleCloudDiscoveryengineV1alphaConditionTimeRange: - id: GoogleCloudDiscoveryengineV1alphaConditionTimeRange - description: Used for time-dependent conditions. - type: object - properties: - startTime: - description: Start of time range. Range is inclusive. + Model to be trained. Supported values are: * **search-tuning**: Fine + tuning the search system based on data provided. type: string - format: google-datetime - endTime: - description: End of time range. Range is inclusive. Must be in the future. + errorConfig: + description: >- + The desired location of errors incurred during the data ingestion + and training. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1ImportErrorConfig' + modelId: + description: If not provided, a UUID will be generated. type: string - format: google-datetime - GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata: - id: GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata - description: >- - Metadata related to the progress of the DataStoreService.CreateDataStore - operation. This will be returned by the - google.longrunning.Operation.metadata field. + GoogleCloudDiscoveryengineV1TrainCustomModelRequestGcsTrainingInput: + id: GoogleCloudDiscoveryengineV1TrainCustomModelRequestGcsTrainingInput + description: Cloud Storage training data input. type: object properties: - createTime: - description: Operation create time. + corpusDataPath: + description: >- + The Cloud Storage corpus data which could be associated in train + data. The data path format is `gs:///`. A newline delimited + jsonl/ndjson file. For search-tuning model, each line should have + the _id, title and text. Example: `{"_id": "doc1", title: "relevant + doc", "text": "relevant text"}` type: string - format: google-datetime - updateTime: + queryDataPath: description: >- - Operation last update time. If the operation is done, this is also - the finish time. + The gcs query data which could be associated in train data. The data + path format is `gs:///`. A newline delimited jsonl/ndjson file. For + search-tuning model, each line should have the _id and text. + Example: {"_id": "query1", "text": "example query"} type: string - format: google-datetime - GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata: - id: GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata - description: >- - Metadata related to the progress of the EngineService.CreateEngine - operation. This will be returned by the - google.longrunning.Operation.metadata field. - type: object - properties: - createTime: - description: Operation create time. + trainDataPath: + description: >- + Cloud Storage training data path whose format should be `gs:///`. + The file should be in tsv format. Each line should have the doc_id + and query_id and score (number). For search-tuning model, it should + have the query-id corpus-id score as tsv file header. The score + should be a number in `[0, inf+)`. The larger the number is, the + more relevant the pair is. Example: * `query-id\tcorpus-id\tscore` * + `query1\tdoc1\t1` type: string - format: google-datetime - updateTime: + testDataPath: description: >- - Operation last update time. If the operation is done, this is also - the finish time. + Cloud Storage test data. Same format as train_data_path. If not + provided, a random 80/20 train/test split will be performed on + train_data_path. type: string - format: google-datetime - GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata: - id: GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata - description: Metadata for EvaluationService.CreateEvaluation method. + GoogleCloudDiscoveryengineV1ListCustomModelsResponse: + id: GoogleCloudDiscoveryengineV1ListCustomModelsResponse + description: Response message for SearchTuningService.ListCustomModels method. type: object - properties: {} - GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata: - id: GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata - description: Metadata for Create Schema LRO. + properties: + models: + description: List of custom tuning models. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1CustomTuningModel' + GoogleCloudDiscoveryengineV1CustomTuningModel: + id: GoogleCloudDiscoveryengineV1CustomTuningModel + description: Metadata that describes a custom tuned model. type: object properties: - createTime: - description: Operation create time. - type: string - format: google-datetime - updateTime: + name: description: >- - Operation last update time. If the operation is done, this is also - the finish time. + Required. The fully qualified resource name of the model. Format: + `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`. + Model must be an alpha-numerical string with limit of 40 characters. type: string - format: google-datetime - GoogleCloudDiscoveryengineV1alphaCreateSitemapMetadata: - id: GoogleCloudDiscoveryengineV1alphaCreateSitemapMetadata - description: >- - Metadata related to the progress of the - SiteSearchEngineService.CreateSitemap operation. This will be returned - by the google.longrunning.Operation.metadata field. - type: object - properties: - createTime: - description: Operation create time. + displayName: + description: The display name of the model. type: string - format: google-datetime - updateTime: + modelVersion: + description: The version of the model. + type: string + format: int64 + modelState: description: >- - Operation last update time. If the operation is done, this is also - the finish time. + The state that the model is in (e.g.`TRAINING` or + `TRAINING_FAILED`). type: string - format: google-datetime - GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata: - id: GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata - description: >- - Metadata related to the progress of the - SiteSearchEngineService.CreateTargetSite operation. This will be - returned by the google.longrunning.Operation.metadata field. - type: object - properties: + enumDescriptions: + - Default value. + - The model is in a paused training state. + - The model is currently training. + - The model has successfully completed training. + - The model is ready for serving. + - The model training failed. + - >- + The model training finished successfully but metrics did not + improve. + - Input data validation failed. Model training didn't start. + enum: + - MODEL_STATE_UNSPECIFIED + - TRAINING_PAUSED + - TRAINING + - TRAINING_COMPLETE + - READY_FOR_SERVING + - TRAINING_FAILED + - NO_IMPROVEMENT + - INPUT_VALIDATION_FAILED createTime: - description: Operation create time. + description: 'Deprecated: Timestamp the Model was created at.' + deprecated: true type: string format: google-datetime - updateTime: - description: >- - Operation last update time. If the operation is done, this is also - the finish time. + trainingStartTime: + description: Timestamp the model training was initiated. type: string format: google-datetime - GoogleCloudDiscoveryengineV1alphaDataStore: - id: GoogleCloudDiscoveryengineV1alphaDataStore - description: DataStore captures global settings and configs at the DataStore level. + metrics: + description: The metrics of the trained model. + type: object + additionalProperties: + type: number + format: double + errorMessage: + description: >- + Currently this is only populated if the model state is + `INPUT_VALIDATION_FAILED`. + type: string + GoogleCloudDiscoveryengineV1ServingConfig: + id: GoogleCloudDiscoveryengineV1ServingConfig + description: >- + Configures metadata that is used to generate serving time results (e.g. + search results or recommendation predictions). The ServingConfig is + passed in the search and predict request and generates results. type: object properties: + mediaConfig: + description: The MediaConfig of the serving configuration. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ServingConfigMediaConfig + genericConfig: + description: The GenericConfig of the serving configuration. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ServingConfigGenericConfig name: description: >- - Immutable. The full resource name of the data store. Format: - `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. - This field must be a UTF-8 encoded string with a length limit of - 1024 characters. + Immutable. Fully qualified name + `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` type: string displayName: description: >- - Required. The data store display name. This field must be a UTF-8 - encoded string with a length limit of 128 characters. Otherwise, an - INVALID_ARGUMENT error is returned. + Required. The human readable serving config display name. Used in + Discovery UI. This field must be a UTF-8 encoded string with a + length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error + is returned. type: string - industryVertical: - description: Immutable. The industry vertical that the data store registers. + solutionType: + description: >- + Required. Immutable. Specifies the solution type that a serving + config can be associated with. type: string enumDescriptions: - - Value used when unset. + - Default value. + - Used for Recommendations AI. + - Used for Discovery Search. + - Used for use cases related to the Generative AI agent. - >- - The generic vertical for documents that are not specific to any - industry vertical. - - The media industry vertical. - - The healthcare FHIR vertical. + Used for use cases related to the Generative Chat agent. It's used + for Generative chat engine only, the associated data stores must + enrolled with `SOLUTION_TYPE_CHAT` solution. enum: - - INDUSTRY_VERTICAL_UNSPECIFIED - - GENERIC - - MEDIA - - HEALTHCARE_FHIR - solutionTypes: + - SOLUTION_TYPE_UNSPECIFIED + - SOLUTION_TYPE_RECOMMENDATION + - SOLUTION_TYPE_SEARCH + - SOLUTION_TYPE_CHAT + - SOLUTION_TYPE_GENERATIVE_CHAT + modelId: description: >- - The solutions that the data store enrolls. Available solutions for - each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` - and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` - is automatically enrolled. Other solutions cannot be enrolled. - type: array - items: - type: string - enumDescriptions: - - Default value. - - Used for Recommendations AI. - - Used for Discovery Search. - - Used for use cases related to the Generative AI agent. - - >- - Used for use cases related to the Generative Chat agent. It's - used for Generative chat engine only, the associated data stores - must enrolled with `SOLUTION_TYPE_CHAT` solution. - enum: - - SOLUTION_TYPE_UNSPECIFIED - - SOLUTION_TYPE_RECOMMENDATION - - SOLUTION_TYPE_SEARCH - - SOLUTION_TYPE_CHAT - - SOLUTION_TYPE_GENERATIVE_CHAT - defaultSchemaId: + The id of the model to use at serving time. Currently only + RecommendationModels are supported. Can be changed but only to a + compatible model (e.g. others-you-may-like CTR to + others-you-may-like CVR). Required when SolutionType is + SOLUTION_TYPE_RECOMMENDATION. + type: string + diversityLevel: description: >- - Output only. The id of the default Schema asscociated to this data - store. - readOnly: true + How much diversity to use in recommendation model results e.g. + `medium-diversity` or `high-diversity`. Currently supported values: + * `no-diversity` * `low-diversity` * `medium-diversity` * + `high-diversity` * `auto-diversity` If not specified, we choose + default based on recommendation model type. Default value: + `no-diversity`. Can only be set if SolutionType is + SOLUTION_TYPE_RECOMMENDATION. type: string - contentConfig: + rankingExpression: description: >- - Immutable. The content config of the data store. If this field is - unset, the server behavior defaults to ContentConfig.NO_CONTENT. + The ranking expression controls the customized ranking on retrieval + documents. To leverage this, document embedding is required. The + ranking expression setting in ServingConfig applies to all search + requests served by the serving config. However, if + `SearchRequest.ranking_expression` is specified, it overrides the + ServingConfig ranking expression. The ranking expression is a single + function or multiple functions that are joined by "+". * + ranking_expression = function, { " + ", function }; Supported + functions: * double * relevance_score * double * + dotProduct(embedding_field_path) Function variables: * + `relevance_score`: pre-defined keywords, used for measure relevance + between query and document. * `embedding_field_path`: the document + embedding field used with query embedding vector. * `dotProduct`: + embedding function between embedding_field_path and query embedding + vector. Example ranking expression: If document has an embedding + field doc_embedding, the ranking expression could be `0.5 * + relevance_score + 0.3 * dotProduct(doc_embedding)`. type: string - enumDescriptions: - - Default value. - - Only contains documents without any Document.content. - - Only contains documents with Document.content. - - The data store is used for public website search. - - >- - The data store is used for workspace search. Details of workspace - data store are specified in the WorkspaceConfig. - enum: - - CONTENT_CONFIG_UNSPECIFIED - - NO_CONTENT - - CONTENT_REQUIRED - - PUBLIC_WEBSITE - - GOOGLE_WORKSPACE createTime: - description: Output only. Timestamp the DataStore was created at. + description: Output only. ServingConfig created timestamp. readOnly: true type: string format: google-datetime - advancedSiteSearchConfig: - description: Optional. Configuration for advanced site search. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig - languageInfo: - description: Language info for DataStore. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaLanguageInfo' - naturalLanguageQueryUnderstandingConfig: - description: Optional. Configuration for Natural Language Query Understanding. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig - kmsKeyName: - description: >- - Input only. The KMS key to be used to protect this DataStore at - creation time. Must be set for requests that need to comply with - CMEK Org Policy protections. If this field is set and processed - successfully, the DataStore will be protected by the KMS key, as - indicated in the cmek_config field. - type: string - cmekConfig: - description: Output only. CMEK-related information for the DataStore. - readOnly: true - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaCmekConfig' - idpConfig: - description: Output only. Data store level identity provider config. - readOnly: true - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaIdpConfig' - billingEstimation: - description: Output only. Data size estimation for billing. + updateTime: + description: Output only. ServingConfig updated timestamp. readOnly: true - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation - aclEnabled: + type: string + format: google-datetime + filterControlIds: description: >- - Immutable. Whether data in the DataStore has ACL information. If set - to `true`, the source data must have ACL. ACL will be ingested when - data is ingested by DocumentService.ImportDocuments methods. When - ACL is enabled for the DataStore, Document can't be accessed by - calling DocumentService.GetDocument or - DocumentService.ListDocuments. Currently ACL is only supported in - `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content - config. - type: boolean - workspaceConfig: + Filter controls to use in serving path. All triggered filter + controls will be applied. Filter controls must be in the same data + store as the serving config. Maximum of 20 filter controls. + type: array + items: + type: string + boostControlIds: description: >- - Config to store data store type configuration for workspace data. - This must be set when DataStore.content_config is set as - DataStore.ContentConfig.GOOGLE_WORKSPACE. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaWorkspaceConfig - documentProcessingConfig: - description: Configuration for Document understanding and enrichment. + Boost controls to use in serving path. All triggered boost controls + will be applied. Boost controls must be in the same data store as + the serving config. Maximum of 20 boost controls. + type: array + items: + type: string + redirectControlIds: + description: >- + IDs of the redirect controls. Only the first triggered redirect + action is applied, even if multiple apply. Maximum number of + specifications is 100. Can only be set if SolutionType is + SOLUTION_TYPE_SEARCH. + type: array + items: + type: string + synonymsControlIds: + description: >- + Condition synonyms specifications. If multiple synonyms conditions + match, all matching synonyms controls in the list will execute. + Maximum number of specifications is 100. Can only be set if + SolutionType is SOLUTION_TYPE_SEARCH. + type: array + items: + type: string + onewaySynonymsControlIds: + description: >- + Condition oneway synonyms specifications. If multiple oneway + synonyms conditions match, all matching oneway synonyms controls in + the list will execute. Maximum number of specifications is 100. Can + only be set if SolutionType is SOLUTION_TYPE_SEARCH. + type: array + items: + type: string + dissociateControlIds: + description: >- + Condition do not associate specifications. If multiple do not + associate conditions match, all matching do not associate controls + in the list will execute. Order does not matter. Maximum number of + specifications is 100. Can only be set if SolutionType is + SOLUTION_TYPE_SEARCH. + type: array + items: + type: string + replacementControlIds: + description: >- + Condition replacement specifications. Applied according to the order + in the list. A previously replaced term can not be re-replaced. + Maximum number of specifications is 100. Can only be set if + SolutionType is SOLUTION_TYPE_SEARCH. + type: array + items: + type: string + ignoreControlIds: + description: >- + Condition ignore specifications. If multiple ignore conditions + match, all matching ignore controls in the list will execute. Order + does not matter. Maximum number of specifications is 100. + type: array + items: + type: string + promoteControlIds: + description: >- + Condition promote specifications. Maximum number of specifications + is 100. + type: array + items: + type: string + answerGenerationSpec: + description: Optional. The specification for answer generation. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig - startingSchema: + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerGenerationSpec + GoogleCloudDiscoveryengineV1ServingConfigMediaConfig: + id: GoogleCloudDiscoveryengineV1ServingConfigMediaConfig + description: >- + Specifies the configurations needed for Media Discovery. Currently we + support: * `demote_content_watched`: Threshold for watched content + demotion. Customers can specify if using watched content demotion or use + viewed detail page. Using the content watched demotion, customers need + to specify the watched minutes or percentage exceeds the threshold, the + content will be demoted in the recommendation result. * + `promote_fresh_content`: cutoff days for fresh content promotion. + Customers can specify if using content freshness promotion. If the + content was published within the cutoff days, the content will be + promoted in the recommendation result. Can only be set if SolutionType + is SOLUTION_TYPE_RECOMMENDATION. + type: object + properties: + contentWatchedPercentageThreshold: + description: >- + Specifies the content watched percentage threshold for demotion. + Threshold value must be between [0, 1.0] inclusive. + type: number + format: float + contentWatchedSecondsThreshold: + description: Specifies the content watched minutes threshold for demotion. + type: number + format: float + demotionEventType: description: >- - The start schema to use for this DataStore when provisioning it. If - unset, a default vertical specialized schema will be used. This - field is only used by CreateDataStore API, and will be ignored if - used in other APIs. This field will be omitted from all API - responses including CreateDataStore API. To retrieve a schema of a - DataStore, use SchemaService.GetSchema API instead. The provided - schema will be validated against certain rules on schema. Learn more - from [this - doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaSchema' - servingConfigDataStore: - description: Optional. Stores serving config at DataStore level. + Specifies the event type used for demoting recommendation result. + Currently supported values: * `view-item`: Item viewed. * + `media-play`: Start/resume watching a video, playing a song, etc. * + `media-complete`: Finished or stopped midway through a video, song, + etc. If unset, watch history demotion will not be applied. Content + freshness demotion will still be applied. + type: string + demoteContentWatchedPastDays: + description: >- + Optional. Specifies the number of days to look back for demoting + watched content. If set to zero or unset, defaults to the maximum of + 365 days. + type: integer + format: int32 + contentFreshnessCutoffDays: + description: >- + Specifies the content freshness used for recommendation result. + Contents will be demoted if contents were published for more than + content freshness cutoff days. + type: integer + format: int32 + GoogleCloudDiscoveryengineV1ServingConfigGenericConfig: + id: GoogleCloudDiscoveryengineV1ServingConfigGenericConfig + description: >- + Specifies the configurations needed for Generic Discovery.Currently we + support: * `content_search_spec`: configuration for generic content + search. + type: object + properties: + contentSearchSpec: + description: >- + Specifies the expected behavior of content search. Only valid for + content-search enabled data store. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore - GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig: - id: GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig - description: Configuration data for advance site search. + #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec + GoogleCloudDiscoveryengineV1AnswerGenerationSpec: + id: GoogleCloudDiscoveryengineV1AnswerGenerationSpec + description: The specification for answer generation. type: object properties: - disableInitialIndex: - description: If set true, initial indexing is disabled for the DataStore. - type: boolean - disableAutomaticRefresh: - description: If set true, automatic refresh is disabled for the DataStore. - type: boolean - GoogleCloudDiscoveryengineV1alphaLanguageInfo: - id: GoogleCloudDiscoveryengineV1alphaLanguageInfo - description: Language info for DataStore. + userDefinedClassifierSpec: + description: Optional. The specification for user specified classifier spec. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSpec + GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSpec: + id: >- + GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSpec + description: The specification for user defined classifier. type: object properties: - languageCode: - description: The language code for the DataStore. + enableUserDefinedClassifier: + description: >- + Optional. Whether or not to enable and include user defined + classifier. + type: boolean + preamble: + description: Optional. The preamble to be used for the user defined classifier. type: string - normalizedLanguageCode: + modelId: + description: Optional. The model id to be used for the user defined classifier. + type: string + taskMarker: description: >- - Output only. This is the normalized form of language_code. E.g.: - language_code of `en-GB`, `en_GB`, `en-UK` or `en-gb` will have - normalized_language_code of `en-GB`. - readOnly: true + Optional. The task marker to be used for the user defined + classifier. type: string - language: + topP: description: >- - Output only. Language part of normalized_language_code. E.g.: - `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`. - readOnly: true + Optional. The top-p value to be used for the user defined + classifier. + type: number + format: double + topK: + description: >- + Optional. The top-k value to be used for the user defined + classifier. type: string - region: + format: int64 + temperature: description: >- - Output only. Region part of normalized_language_code, if present. - E.g.: `en-US` -> `US`, `zh-Hans-HK` -> `HK`, `en` -> ``. - readOnly: true + Optional. The temperature value to be used for the user defined + classifier. + type: number + format: double + seed: + description: Optional. The seed value to be used for the user defined classifier. + type: integer + format: int32 + GoogleCloudDiscoveryengineV1ListSessionsResponse: + id: GoogleCloudDiscoveryengineV1ListSessionsResponse + description: Response for ListSessions method. + type: object + properties: + sessions: + description: All the Sessions for a given data store. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Session' + nextPageToken: + description: Pagination token, if not returned indicates the last page. type: string - GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig: - id: GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig - description: Configuration for Natural Language Query Understanding. + GoogleCloudDiscoveryengineV1SiteSearchEngine: + id: GoogleCloudDiscoveryengineV1SiteSearchEngine + description: >- + SiteSearchEngine captures DataStore level site search persisting + configurations. It is a singleton value per data store. type: object properties: - mode: + name: description: >- - Mode of Natural Language Query Understanding. If this field is - unset, the behavior defaults to - NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED. + The fully qualified resource name of the site search engine. Format: + `projects/*/locations/*/dataStores/*/siteSearchEngine` type: string - enumDescriptions: - - Default value. - - Natural Language Query Understanding is disabled. - - Natural Language Query Understanding is enabled. - enum: - - MODE_UNSPECIFIED - - DISABLED - - ENABLED - GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation: - id: GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation - description: Estimation of data size per data store. + GoogleCloudDiscoveryengineV1TargetSite: + id: GoogleCloudDiscoveryengineV1TargetSite + description: A target site for the SiteSearchEngine. type: object properties: - structuredDataSize: - description: Data size for structured data in terms of bytes. - type: string - format: int64 - unstructuredDataSize: - description: Data size for unstructured data in terms of bytes. - type: string - format: int64 - websiteDataSize: - description: Data size for websites in terms of bytes. - type: string - format: int64 - structuredDataUpdateTime: - description: Last updated timestamp for structured data. - type: string - format: google-datetime - unstructuredDataUpdateTime: - description: Last updated timestamp for unstructured data. + name: + description: >- + Output only. The fully qualified resource name of the target site. + `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` + The `target_site_id` is system-generated. + readOnly: true type: string - format: google-datetime - websiteDataUpdateTime: - description: Last updated timestamp for websites. + providedUriPattern: + description: >- + Required. Input only. The user provided URI pattern from which the + `generated_uri_pattern` is generated. type: string - format: google-datetime - GoogleCloudDiscoveryengineV1alphaWorkspaceConfig: - id: GoogleCloudDiscoveryengineV1alphaWorkspaceConfig - description: Config to store data store type configuration for workspace data - type: object - properties: type: - description: The Google Workspace data source. + description: >- + The type of the target site, e.g., whether the site is to be + included or excluded. type: string enumDescriptions: - - Defaults to an unspecified Workspace type. - - Workspace Data Store contains Drive data - - Workspace Data Store contains Mail data - - Workspace Data Store contains Sites data - - Workspace Data Store contains Calendar data - - Workspace Data Store contains Chat data - - Workspace Data Store contains Groups data - - Workspace Data Store contains Keep data + - >- + This value is unused. In this case, server behavior defaults to + Type.INCLUDE. + - Include the target site. + - Exclude the target site. enum: - TYPE_UNSPECIFIED - - GOOGLE_DRIVE - - GOOGLE_MAIL - - GOOGLE_SITES - - GOOGLE_CALENDAR - - GOOGLE_CHAT - - GOOGLE_GROUPS - - GOOGLE_KEEP - dasherCustomerId: - description: Obfuscated Dasher customer ID. - type: string - superAdminServiceAccount: + - INCLUDE + - EXCLUDE + exactMatch: description: >- - Optional. The super admin service account for the workspace that - will be used for access token generation. For now we only use it for - Native Google Drive connector data ingestion. - type: string - superAdminEmailAddress: + Immutable. If set to false, a uri_pattern is generated to include + all pages whose address contains the provided_uri_pattern. If set to + true, an uri_pattern is generated to try to be an exact match of the + provided_uri_pattern or just the specific page if the + provided_uri_pattern is a specific one. provided_uri_pattern is + always normalized to generate the URI pattern to be used by the + search engine. + type: boolean + generatedUriPattern: description: >- - Optional. The super admin email address for the workspace that will - be used for access token generation. For now we only use it for - Native Google Drive connector data ingestion. + Output only. This is system-generated based on the + provided_uri_pattern. + readOnly: true type: string - GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig: - id: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig - description: >- - A singleton resource of DataStore. If it's empty when DataStore is - created and DataStore is set to - DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will - default to digital parser. - type: object - properties: - name: - description: >- - The full resource name of the Document Processing Config. Format: - `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. + rootDomainUri: + description: Output only. Root domain of the provided_uri_pattern. + readOnly: true type: string - chunkingConfig: - description: Whether chunking mode is enabled. + siteVerificationInfo: + description: Output only. Site ownership and validity verification status. + readOnly: true $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig - defaultParsingConfig: - description: >- - Configurations for default Document parser. If not specified, we - will configure it as default DigitalParsingConfig, and the default - parsing config will be applied to all file types for Document - parsing. + #/components/schemas/GoogleCloudDiscoveryengineV1SiteVerificationInfo + indexingStatus: + description: Output only. Indexing status. + readOnly: true + type: string + enumDescriptions: + - Defaults to SUCCEEDED. + - >- + The target site is in the update queue and will be picked up by + indexing pipeline. + - The target site fails to be indexed. + - The target site has been indexed. + - >- + The previously indexed target site has been marked to be deleted. + This is a transitioning state which will resulted in either: 1. + target site deleted if unindexing is successful; 2. state reverts + to SUCCEEDED if the unindexing fails. + - The target site change is pending but cancellable. + - The target site change is cancelled. + enum: + - INDEXING_STATUS_UNSPECIFIED + - PENDING + - FAILED + - SUCCEEDED + - DELETING + - CANCELLABLE + - CANCELLED + updateTime: + description: Output only. The target site's last updated time. + readOnly: true + type: string + format: google-datetime + failureReason: + description: Output only. Failure reason. + readOnly: true $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig - parsingConfigOverrides: - description: >- - Map from file type to override the default parsing configuration - based on the file type. Supported keys: * `pdf`: Override parsing - config for PDF files, either digital parsing, ocr parsing or layout - parsing is supported. * `html`: Override parsing config for HTML - files, only digital parsing and layout parsing are supported. * - `docx`: Override parsing config for DOCX files, only digital parsing - and layout parsing are supported. * `pptx`: Override parsing config - for PPTX files, only digital parsing and layout parsing are - supported. * `xlsm`: Override parsing config for XLSM files, only - digital parsing and layout parsing are supported. * `xlsx`: Override - parsing config for XLSX files, only digital parsing and layout - parsing are supported. - type: object - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig - GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig: - id: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig - description: Configuration for chunking config. + #/components/schemas/GoogleCloudDiscoveryengineV1TargetSiteFailureReason + GoogleCloudDiscoveryengineV1SiteVerificationInfo: + id: GoogleCloudDiscoveryengineV1SiteVerificationInfo + description: Verification information for target sites in advanced site search. type: object properties: - layoutBasedChunkingConfig: - description: Configuration for the layout based chunking. + siteVerificationState: + description: Site verification state indicating the ownership and validity. + type: string + enumDescriptions: + - Defaults to VERIFIED. + - Site ownership verified. + - Site ownership pending verification or verification failed. + - >- + Site exempt from verification, e.g., a public website that opens + to all. + enum: + - SITE_VERIFICATION_STATE_UNSPECIFIED + - VERIFIED + - UNVERIFIED + - EXEMPTED + verifyTime: + description: Latest site verification time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1TargetSiteFailureReason: + id: GoogleCloudDiscoveryengineV1TargetSiteFailureReason + description: Site search indexing failure reasons. + type: object + properties: + quotaFailure: + description: Failed due to insufficient quota. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig - GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig: - id: >- - GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig - description: Configuration for the layout based chunking. + #/components/schemas/GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure + GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure: + id: GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure + description: Failed due to insufficient quota. type: object properties: - chunkSize: - description: >- - The token size limit for each chunk. Supported values: 100-500 - (inclusive). Default value: 500. - type: integer - format: int32 - includeAncestorHeadings: + totalRequiredQuota: description: >- - Whether to include appending different levels of headings to chunks - from the middle of the document to prevent context loss. Default - value: False. - type: boolean - GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig: - id: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig - description: Related configurations applied to a specific type of document parser. + This number is an estimation on how much total quota this project + needs to successfully complete indexing. + type: string + format: int64 + GoogleCloudDiscoveryengineV1BatchCreateTargetSitesRequest: + id: GoogleCloudDiscoveryengineV1BatchCreateTargetSitesRequest + description: >- + Request message for SiteSearchEngineService.BatchCreateTargetSites + method. type: object properties: - digitalParsingConfig: - description: Configurations applied to digital parser. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig - ocrParsingConfig: + requests: description: >- - Configurations applied to OCR parser. Currently it only applies to - PDFs. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig - layoutParsingConfig: - description: Configurations applied to layout parser. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig - GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig: - id: >- - GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig - description: The digital parsing configurations for documents. - type: object - properties: {} - GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig: - id: >- - GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig - description: The OCR parsing configurations for documents. + Required. The request message specifying the resources to create. A + maximum of 20 TargetSites can be created in a batch. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1CreateTargetSiteRequest + GoogleCloudDiscoveryengineV1CreateTargetSiteRequest: + id: GoogleCloudDiscoveryengineV1CreateTargetSiteRequest + description: Request message for SiteSearchEngineService.CreateTargetSite method. type: object properties: - enhancedDocumentElements: + parent: description: >- - [DEPRECATED] This field is deprecated. To use the additional - enhanced document elements processing, please switch to - `layout_parsing_config`. - deprecated: true + Required. Parent resource name of TargetSite, such as + `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. + type: string + targetSite: + description: Required. The TargetSite to create. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1TargetSite' + GoogleCloudDiscoveryengineV1ListTargetSitesResponse: + id: GoogleCloudDiscoveryengineV1ListTargetSitesResponse + description: Response message for SiteSearchEngineService.ListTargetSites method. + type: object + properties: + targetSites: + description: List of TargetSites. type: array items: - type: string - useNativeText: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1TargetSite' + nextPageToken: description: >- - If true, will use native text instead of OCR text on pages - containing native text. - type: boolean - GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig: - id: >- - GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig - description: The layout parsing configurations for documents. - type: object - properties: {} - GoogleCloudDiscoveryengineV1alphaSchema: - id: GoogleCloudDiscoveryengineV1alphaSchema - description: Defines the structure and layout of a type of document data. + A token that can be sent as `page_token` to retrieve the next page. + If this field is omitted, there are no subsequent pages. + type: string + totalSize: + description: >- + The total number of items matching the request. This will always be + populated in the response. + type: integer + format: int32 + GoogleCloudDiscoveryengineV1Sitemap: + id: GoogleCloudDiscoveryengineV1Sitemap + description: A sitemap for the SiteSearchEngine. type: object properties: - structSchema: - description: The structured representation of the schema. - type: object - additionalProperties: - type: any - description: Properties of the object. - jsonSchema: - description: The JSON representation of the schema. + uri: + description: Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`. type: string name: description: >- - Immutable. The full resource name of the schema, in the format of - `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. - This field must be a UTF-8 encoded string with a length limit of - 1024 characters. + Output only. The fully qualified resource name of the sitemap. + `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/*` + The `sitemap_id` suffix is system-generated. + readOnly: true type: string - fieldConfigs: - description: Output only. Configurations for fields of the schema. + createTime: + description: Output only. The sitemap's creation time. readOnly: true - type: array - items: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaFieldConfig' - GoogleCloudDiscoveryengineV1alphaFieldConfig: - id: GoogleCloudDiscoveryengineV1alphaFieldConfig - description: >- - Configurations for fields of a schema. For example, configuring a field - is indexable, or searchable. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1FetchSitemapsResponse: + id: GoogleCloudDiscoveryengineV1FetchSitemapsResponse + description: Response message for SiteSearchEngineService.FetchSitemaps method. type: object properties: - fieldPath: + sitemapsMetadata: + description: List of Sitemaps fetched. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1FetchSitemapsResponseSitemapMetadata + GoogleCloudDiscoveryengineV1FetchSitemapsResponseSitemapMetadata: + id: GoogleCloudDiscoveryengineV1FetchSitemapsResponseSitemapMetadata + description: Contains a Sitemap and its metadata. + type: object + properties: + sitemap: + description: The Sitemap. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Sitemap' + GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchRequest: + id: GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchRequest + description: >- + Request message for SiteSearchEngineService.EnableAdvancedSiteSearch + method. + type: object + properties: {} + GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchRequest: + id: GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchRequest + description: >- + Request message for SiteSearchEngineService.DisableAdvancedSiteSearch + method. + type: object + properties: {} + GoogleCloudDiscoveryengineV1RecrawlUrisRequest: + id: GoogleCloudDiscoveryengineV1RecrawlUrisRequest + description: Request message for SiteSearchEngineService.RecrawlUris method. + type: object + properties: + uris: description: >- - Required. Field path of the schema field. For example: `title`, - `description`, `release_info.release_year`. + Required. List of URIs to crawl. At most 10K URIs are supported, + otherwise an INVALID_ARGUMENT error is thrown. Each URI should match + at least one TargetSite in `site_search_engine`. + type: array + items: + type: string + siteCredential: + description: Optional. Credential id to use for crawling. type: string - fieldType: - description: Output only. Raw type of the field. + GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest: + id: GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest + description: >- + Request message for SiteSearchEngineService.BatchVerifyTargetSites + method. + type: object + properties: {} + GoogleCloudDiscoveryengineV1FetchDomainVerificationStatusResponse: + id: GoogleCloudDiscoveryengineV1FetchDomainVerificationStatusResponse + description: >- + Response message for + SiteSearchEngineService.FetchDomainVerificationStatus method. + type: object + properties: + targetSites: + description: List of TargetSites containing the site verification status. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1TargetSite' + nextPageToken: + description: >- + A token that can be sent as `page_token` to retrieve the next page. + If this field is omitted, there are no subsequent pages. + type: string + totalSize: + description: >- + The total number of items matching the request. This will always be + populated in the response. + type: integer + format: int32 + GoogleApiHttpBody: + id: GoogleApiHttpBody + description: >- + Message that represents an arbitrary HTTP body. It should only be used + for payload formats that can't be represented as JSON, such as raw + binary or an HTML page. This message can be used both in streaming and + non-streaming API methods in the request as well as the response. It can + be used as a top-level request field, which is convenient if one wants + to extract parameters from either the URL or HTTP template into the + request fields and also want access to the raw HTTP body. Example: + message GetResourceRequest { // A unique request id. string request_id = + 1; // The raw HTTP body is bound to this field. google.api.HttpBody + http_body = 2; } service ResourceService { rpc + GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc + UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } + Example with streaming methods: service CaldavService { rpc + GetCalendar(stream google.api.HttpBody) returns (stream + google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) + returns (stream google.api.HttpBody); } Use of this type only changes + how the request and response bodies are handled, all other features will + continue to work unchanged. + type: object + properties: + contentType: + description: >- + The HTTP Content-Type header value specifying the content type of + the body. + type: string + data: + description: The HTTP request/response body as raw binary. + type: string + format: byte + extensions: + description: >- + Application specific response metadata. Must be set in the first + response for streaming APIs. + type: array + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + GoogleCloudDiscoveryengineV1PurgeUserEventsRequest: + id: GoogleCloudDiscoveryengineV1PurgeUserEventsRequest + description: Request message for PurgeUserEvents method. + type: object + properties: + filter: + description: >- + Required. The filter string to specify the events to be deleted with + a length limit of 5,000 characters. The eligible fields for + filtering are: * `eventType`: Double quoted UserEvent.event_type + string. * `eventTime`: in ISO 8601 "zulu" format. * `userPseudoId`: + Double quoted string. Specifying this will delete all events + associated with a visitor. * `userId`: Double quoted string. + Specifying this will delete all events associated with a user. Note: + This API only supports purging a max range of 30 days. Examples: * + Deleting all events in a time range: `eventTime > + "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"` * + Deleting specific eventType in a time range: `eventTime > + "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" + eventType = "search"` * Deleting all events for a specific visitor + in a time range: `eventTime > "2012-04-23T18:25:43.511Z" eventTime < + "2012-04-23T18:30:43.511Z" userPseudoId = "visitor1024"` * Deleting + the past 30 days of events inside a DataStore: `*` The filtering + fields are assumed to have an implicit AND. + type: string + force: + description: >- + The `force` field is currently not supported. Purge user event + requests will permanently delete all purgeable events. Once the + development is complete: If `force` is set to false, the method will + return the expected purge count without deleting any user events. + This field will default to false if not included in the request. + type: boolean + GoogleCloudDiscoveryengineV1ImportUserEventsRequest: + id: GoogleCloudDiscoveryengineV1ImportUserEventsRequest + description: Request message for the ImportUserEvents request. + type: object + properties: + inlineSource: + description: The Inline source for the input content for UserEvents. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ImportUserEventsRequestInlineSource + gcsSource: + description: Cloud Storage location for the input content. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1GcsSource' + bigquerySource: + description: BigQuery input source. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1BigQuerySource' + errorConfig: + description: >- + The desired location of errors incurred during the Import. Cannot be + set for inline user event imports. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1ImportErrorConfig' + GoogleCloudDiscoveryengineV1ImportUserEventsRequestInlineSource: + id: GoogleCloudDiscoveryengineV1ImportUserEventsRequestInlineSource + description: The inline source for the input config for ImportUserEvents method. + type: object + properties: + userEvents: + description: >- + Required. A list of user events to import. Recommended max of 10k + items. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1UserEvent' + GoogleCloudDiscoveryengineV1ListUserLicensesResponse: + id: GoogleCloudDiscoveryengineV1ListUserLicensesResponse + description: Response message for UserLicenseService.ListUserLicenses. + type: object + properties: + userLicenses: + description: All the customer's UserLicenses. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1UserLicense' + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + GoogleCloudDiscoveryengineV1UserLicense: + id: GoogleCloudDiscoveryengineV1UserLicense + description: User License information assigned by the admin. + type: object + properties: + userPrincipal: + description: >- + Required. Immutable. The user principal of the User, could be email + address or other prinical identifier. This field is immutable. Admin + assign licenses based on the user principal. + type: string + userProfile: + description: >- + Optional. The user profile. We user user full name(First name + Last + name) as user profile. + type: string + licenseAssignmentState: + description: >- + Output only. License assignment state of the user. If the user is + assigned with a license config, the user login will be assigned with + the license; If the user's license assignment state is unassigned or + unspecified, no license config will be associated to the user; readOnly: true type: string enumDescriptions: - - Field type is unspecified. - - Field value type is Object. - - Field value type is String. - - Field value type is Number. - - Field value type is Integer. - - Field value type is Boolean. + - Default value. + - License assigned to the user. - >- - Field value type is Geolocation. Geolocation is expressed as an - object with the following keys: * `id`: a string representing the - location id * `longitude`: a number representing the longitude - coordinate of the location * `latitude`: a number repesenting the - latitude coordinate of the location * `address`: a string - representing the full address of the location `latitude` and - `longitude` must always be provided together. At least one of a) - `address` or b) `latitude`-`longitude` pair must be provided. + No license assigned to the user. Deprecated, translated to + NO_LICENSE. + - No license assigned to the user. - >- - Field value type is Datetime. Datetime can be expressed as either: - * a number representing milliseconds-since-the-epoch * a string - representing milliseconds-since-the-epoch. e.g. `"1420070400001"` - * a string representing the [ISO - 8601](https://en.wikipedia.org/wiki/ISO_8601) date or date and - time. e.g. `"2015-01-01"` or `"2015-01-01T12:10:30Z"` + User attempted to login but no license assigned to the user. This + state is only used for no user first time login attempt but cannot + get license assigned. Users already logged in but cannot get + license assigned will be assigned NO_LICENSE state(License could + be unassigned by admin). + - User is blocked from assigning a license. enum: - - FIELD_TYPE_UNSPECIFIED - - OBJECT - - STRING - - NUMBER - - INTEGER - - BOOLEAN - - GEOLOCATION - - DATETIME - indexableOption: + - LICENSE_ASSIGNMENT_STATE_UNSPECIFIED + - ASSIGNED + - UNASSIGNED + - NO_LICENSE + - NO_LICENSE_ATTEMPTED_LOGIN + - BLOCKED + licenseConfig: description: >- - If indexable_option is INDEXABLE_ENABLED, field values are indexed - so that it can be filtered or faceted in SearchService.Search. If - indexable_option is unset, the server behavior defaults to - INDEXABLE_DISABLED for fields that support setting indexable - options. For those fields that do not support setting indexable - options, such as `object` and `boolean` and key properties, the - server will skip indexable_option setting, and setting - indexable_option for those fields will throw `INVALID_ARGUMENT` - error. + Optional. The full resource name of the Subscription(LicenseConfig) + assigned to the user. type: string - enumDescriptions: - - Value used when unset. - - Indexable option enabled for a schema field. - - Indexable option disabled for a schema field. - enum: - - INDEXABLE_OPTION_UNSPECIFIED - - INDEXABLE_ENABLED - - INDEXABLE_DISABLED - dynamicFacetableOption: + createTime: + description: Output only. User created timestamp. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. User update timestamp. + readOnly: true + type: string + format: google-datetime + lastLoginTime: description: >- - If dynamic_facetable_option is DYNAMIC_FACETABLE_ENABLED, field - values are available for dynamic facet. Could only be - DYNAMIC_FACETABLE_DISABLED if FieldConfig.indexable_option is - INDEXABLE_DISABLED. Otherwise, an `INVALID_ARGUMENT` error will be - returned. If dynamic_facetable_option is unset, the server behavior - defaults to DYNAMIC_FACETABLE_DISABLED for fields that support - setting dynamic facetable options. For those fields that do not - support setting dynamic facetable options, such as `object` and - `boolean`, the server will skip dynamic facetable option setting, - and setting dynamic_facetable_option for those fields will throw - `INVALID_ARGUMENT` error. + Output only. User last logged in time. If the user has not logged in + yet, this field will be empty. + readOnly: true type: string - enumDescriptions: - - Value used when unset. - - Dynamic facetable option enabled for a schema field. - - Dynamic facetable option disabled for a schema field. - enum: - - DYNAMIC_FACETABLE_OPTION_UNSPECIFIED - - DYNAMIC_FACETABLE_ENABLED - - DYNAMIC_FACETABLE_DISABLED - searchableOption: - description: >- - If searchable_option is SEARCHABLE_ENABLED, field values are - searchable by text queries in SearchService.Search. If - SEARCHABLE_ENABLED but field type is numerical, field values will - not be searchable by text queries in SearchService.Search, as there - are no text values associated to numerical fields. If - searchable_option is unset, the server behavior defaults to - SEARCHABLE_DISABLED for fields that support setting searchable - options. Only `string` fields that have no key property mapping - support setting searchable_option. For those fields that do not - support setting searchable options, the server will skip searchable - option setting, and setting searchable_option for those fields will - throw `INVALID_ARGUMENT` error. - type: string - enumDescriptions: - - Value used when unset. - - Searchable option enabled for a schema field. - - Searchable option disabled for a schema field. - enum: - - SEARCHABLE_OPTION_UNSPECIFIED - - SEARCHABLE_ENABLED - - SEARCHABLE_DISABLED - retrievableOption: - description: >- - If retrievable_option is RETRIEVABLE_ENABLED, field values are - included in the search results. If retrievable_option is unset, the - server behavior defaults to RETRIEVABLE_DISABLED for fields that - support setting retrievable options. For those fields that do not - support setting retrievable options, such as `object` and `boolean`, - the server will skip retrievable option setting, and setting - retrievable_option for those fields will throw `INVALID_ARGUMENT` - error. - type: string - enumDescriptions: - - Value used when unset. - - Retrievable option enabled for a schema field. - - Retrievable option disabled for a schema field. - enum: - - RETRIEVABLE_OPTION_UNSPECIFIED - - RETRIEVABLE_ENABLED - - RETRIEVABLE_DISABLED - completableOption: - description: >- - If completable_option is COMPLETABLE_ENABLED, field values are - directly used and returned as suggestions for Autocomplete in - CompletionService.CompleteQuery. If completable_option is unset, the - server behavior defaults to COMPLETABLE_DISABLED for fields that - support setting completable options, which are just `string` fields. - For those fields that do not support setting completable options, - the server will skip completable option setting, and setting - completable_option for those fields will throw `INVALID_ARGUMENT` - error. - type: string - enumDescriptions: - - Value used when unset. - - Completable option enabled for a schema field. - - Completable option disabled for a schema field. - enum: - - COMPLETABLE_OPTION_UNSPECIFIED - - COMPLETABLE_ENABLED - - COMPLETABLE_DISABLED - recsFilterableOption: - description: >- - If recs_filterable_option is FILTERABLE_ENABLED, field values are - filterable by filter expression in RecommendationService.Recommend. - If FILTERABLE_ENABLED but the field type is numerical, field values - are not filterable by text queries in - RecommendationService.Recommend. Only textual fields are supported. - If recs_filterable_option is unset, the default setting is - FILTERABLE_DISABLED for fields that support setting filterable - options. When a field set to [FILTERABLE_DISABLED] is filtered, a - warning is generated and an empty result is returned. - type: string - enumDescriptions: - - Value used when unset. - - Filterable option enabled for a schema field. - - Filterable option disabled for a schema field. - enum: - - FILTERABLE_OPTION_UNSPECIFIED - - FILTERABLE_ENABLED - - FILTERABLE_DISABLED - keyPropertyType: - description: >- - Output only. Type of the key property that this field is mapped to. - Empty string if this is not annotated as mapped to a key property. - Example types are `title`, `description`. Full list is defined by - `keyPropertyMapping` in the schema field annotation. If the schema - field has a `KeyPropertyMapping` annotation, `indexable_option` and - `searchable_option` of this field cannot be modified. - readOnly: true - type: string - advancedSiteSearchDataSources: - description: >- - If this field is set, only the corresponding source will be indexed - for this field. Otherwise, the values from different sources are - merged. Assuming a page with `` in meta tag, and `` in page map: if - this enum is set to METATAGS, we will only index ``; if this enum is - not set, we will merge them and index ``. - type: array - items: - type: string - enumDescriptions: - - Value used when unset. - - Retrieve value from meta tag. - - Retrieve value from page map. - - >- - Retrieve value from the attributes set by - SiteSearchEngineService.SetUriPatternDocumentData API. - - Retrieve value from schema.org data. - enum: - - ADVANCED_SITE_SEARCH_DATA_SOURCE_UNSPECIFIED - - METATAGS - - PAGEMAP - - URI_PATTERN_MAPPING - - SCHEMA_ORG - schemaOrgPaths: - description: >- - Field paths for indexing custom attribute from schema.org data. More - details of schema.org and its defined types can be found at - [schema.org](https://schema.org). It is only used on advanced site - search schema. Currently only support full path from root. The full - path to a field is constructed by concatenating field names, - starting from `_root`, with a period `.` as the delimiter. Examples: - * Publish date of the root: _root.datePublished * Publish date of - the reviews: _root.review.datePublished - type: array - items: - type: string - metatagName: - description: >- - Optional. The metatag name found in the HTML page. If user defines - this field, the value of this metatag name will be used to extract - metatag. If the user does not define this field, the - FieldConfig.field_path will be used to extract metatag. - type: string - GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore: - id: GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore - description: >- - Stores information regarding the serving configurations at DataStore - level. + format: google-datetime + GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequest: + id: GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequest + description: Request message for UserLicenseService.BatchUpdateUserLicenses method. type: object properties: - disabledForServing: + inlineSource: + description: The inline source for the input content for document embeddings. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequestInlineSource + deleteUnassignedUserLicenses: description: >- - If set true, the DataStore will not be available for serving search - requests. + Optional. If true, if user licenses removed associated license + config, the user license will be deleted. By default which is false, + the user license will be updated to unassigned state. type: boolean - GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata: - id: GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata + GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequestInlineSource: + id: GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequestInlineSource description: >- - Metadata related to the progress of the DataStoreService.DeleteDataStore - operation. This will be returned by the - google.longrunning.Operation.metadata field. + The inline source for the input config for BatchUpdateUserLicenses + method. type: object properties: - createTime: - description: Operation create time. - type: string - format: google-datetime - updateTime: + userLicenses: description: >- - Operation last update time. If the operation is done, this is also - the finish time. + Required. A list of user licenses to update. Each user license must + have a valid UserLicense.user_principal. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1UserLicense' + updateMask: + description: Optional. The list of fields to update. type: string - format: google-datetime - GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata: - id: GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata - description: >- - Metadata related to the progress of the EngineService.DeleteEngine - operation. This will be returned by the - google.longrunning.Operation.metadata field. + format: google-fieldmask + GoogleCloudDiscoveryengineLoggingErrorLog: + id: GoogleCloudDiscoveryengineLoggingErrorLog + description: An error log which is reported to the Error Reporting system. type: object properties: - createTime: - description: Operation create time. + serviceContext: + description: The service context in which this error has occurred. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineLoggingServiceContext' + context: + description: A description of the context in which the error occurred. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineLoggingErrorContext' + message: + description: A message describing the error. type: string - format: google-datetime - updateTime: + status: + description: The RPC status associated with the error log. + $ref: '#/components/schemas/GoogleRpcStatus' + requestPayload: description: >- - Operation last update time. If the operation is done, this is also - the finish time. - type: string - format: google-datetime - GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata: - id: GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata - description: Metadata for DeleteSchema LRO. + The API request payload, represented as a protocol buffer. Most API + request types are supported—for example: * + `type.googleapis.com/google.cloud.discoveryengine.v1alpha.DocumentService.CreateDocumentRequest` + * + `type.googleapis.com/google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEventRequest` + type: object + additionalProperties: + type: any + description: Properties of the object. + responsePayload: + description: >- + The API response payload, represented as a protocol buffer. This is + used to log some "soft errors", where the response is valid but we + consider there are some quality issues like unjoined events. The + following API responses are supported, and no PII is included: * + `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend` + * + `google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEvent` + * + `google.cloud.discoveryengine.v1alpha.UserEventService.CollectUserEvent` + type: object + additionalProperties: + type: any + description: Properties of the object. + importPayload: + description: The error payload that is populated on LRO import APIs. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineLoggingImportErrorContext + connectorRunPayload: + description: The error payload that is populated on LRO connector sync APIs. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext + GoogleCloudDiscoveryengineLoggingServiceContext: + id: GoogleCloudDiscoveryengineLoggingServiceContext + description: Describes a running service that sends errors. type: object properties: - createTime: - description: Operation create time. - type: string - format: google-datetime - updateTime: + service: description: >- - Operation last update time. If the operation is done, this is also - the finish time. + An identifier of the service—for example, + `discoveryengine.googleapis.com`. type: string - format: google-datetime - GoogleCloudDiscoveryengineV1alphaDeleteSitemapMetadata: - id: GoogleCloudDiscoveryengineV1alphaDeleteSitemapMetadata - description: >- - Metadata related to the progress of the - SiteSearchEngineService.DeleteSitemap operation. This will be returned - by the google.longrunning.Operation.metadata field. + GoogleCloudDiscoveryengineLoggingErrorContext: + id: GoogleCloudDiscoveryengineLoggingErrorContext + description: A description of the context in which an error occurred. type: object properties: - createTime: - description: Operation create time. - type: string - format: google-datetime - updateTime: - description: >- - Operation last update time. If the operation is done, this is also - the finish time. + httpRequest: + description: The HTTP request which was processed when the error was triggered. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineLoggingHttpRequestContext + reportLocation: + description: >- + The location in the source code where the decision was made to + report the error, usually the place where it was logged. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineLoggingSourceLocation' + GoogleCloudDiscoveryengineLoggingHttpRequestContext: + id: GoogleCloudDiscoveryengineLoggingHttpRequestContext + description: HTTP request data that is related to a reported error. + type: object + properties: + responseStatusCode: + description: The HTTP response status code for the request. + type: integer + format: int32 + GoogleCloudDiscoveryengineLoggingSourceLocation: + id: GoogleCloudDiscoveryengineLoggingSourceLocation + description: >- + Indicates a location in the source code of the service for which errors + are reported. + type: object + properties: + functionName: + description: >- + Human-readable name of a function or method—for example, + `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`. + type: string + GoogleCloudDiscoveryengineLoggingImportErrorContext: + id: GoogleCloudDiscoveryengineLoggingImportErrorContext + description: >- + The error payload that is populated on LRO import APIs, including the + following: * + `google.cloud.discoveryengine.v1alpha.DocumentService.ImportDocuments` * + `google.cloud.discoveryengine.v1alpha.UserEventService.ImportUserEvents` + type: object + properties: + operation: + description: The operation resource name of the LRO. + type: string + gcsPath: + description: >- + Google Cloud Storage file path of the import source. Can be set for + batch operation error. + type: string + lineNumber: + description: >- + Line number of the content in file. Should be empty for permission + or batch operation error. + type: string + document: + description: The detailed content which caused the error on importing a document. + type: string + userEvent: + description: >- + The detailed content which caused the error on importing a user + event. + type: string + GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext: + id: GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext + description: >- + The error payload that is populated on LRO sync APIs, including the + following: * + `google.cloud.discoveryengine.v1main.DataConnectorService.SetUpDataConnector` + * + `google.cloud.discoveryengine.v1main.DataConnectorService.StartConnectorRun` + type: object + properties: + operation: + description: The operation resource name of the LRO to sync the connector. + type: string + dataConnector: + description: >- + The full resource name of the DataConnector. Format: + `projects/*/locations/*/collections/*/dataConnector`. + type: string + connectorRun: + description: >- + The full resource name of the Connector Run. Format: + `projects/*/locations/*/collections/*/dataConnector/connectorRuns/*`. + The `connector_run_id` is system-generated. + type: string + entity: + description: The entity to sync for the connector run. + type: string + syncType: + description: >- + The type of sync run. Can be one of the following: * `FULL` * + `INCREMENTAL` + type: string + startTime: + description: The time when the connector run started. type: string format: google-datetime - GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata: - id: GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata + endTime: + description: The time when the connector run ended. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata: + id: GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata description: >- Metadata related to the progress of the - SiteSearchEngineService.DeleteTargetSite operation. This will be + SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field. type: object properties: @@ -8565,12 +9427,24 @@ components: the finish time. type: string format: google-datetime - GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata: - id: GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata + GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse: + id: GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse + description: >- + Response message for SiteSearchEngineService.BatchCreateTargetSites + method. + type: object + properties: + targetSites: + description: TargetSites created. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1TargetSite' + GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesMetadata: + id: GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesMetadata description: >- Metadata related to the progress of the - SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will - be returned by the google.longrunning.Operation.metadata field. + UserLicenseService.BatchUpdateUserLicenses operation. This will be + returned by the google.longrunning.Operation.metadata field. type: object properties: createTime: @@ -8583,19 +9457,35 @@ components: the finish time. type: string format: google-datetime - GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse: - id: GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse - description: >- - Response message for SiteSearchEngineService.DisableAdvancedSiteSearch - method. + successCount: + description: Count of user licenses successfully updated. + type: string + format: int64 + failureCount: + description: Count of user licenses that failed to be updated. + type: string + format: int64 + GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesResponse: + id: GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesResponse + description: Response message for UserLicenseService.BatchUpdateUserLicenses method. type: object - properties: {} - GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata: - id: GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata + properties: + userLicenses: + description: UserLicenses successfully updated. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1UserLicense' + errorSamples: + description: A sample of errors encountered while processing the request. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudDiscoveryengineV1CreateDataStoreMetadata: + id: GoogleCloudDiscoveryengineV1CreateDataStoreMetadata description: >- - Metadata related to the progress of the - SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be - returned by the google.longrunning.Operation.metadata field. + Metadata related to the progress of the DataStoreService.CreateDataStore + operation. This will be returned by the + google.longrunning.Operation.metadata field. type: object properties: createTime: @@ -8608,1782 +9498,1470 @@ components: the finish time. type: string format: google-datetime - GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse: - id: GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse - description: >- - Response message for SiteSearchEngineService.EnableAdvancedSiteSearch - method. - type: object - properties: {} - GoogleCloudDiscoveryengineV1alphaEngine: - id: GoogleCloudDiscoveryengineV1alphaEngine + GoogleCloudDiscoveryengineV1CreateEngineMetadata: + id: GoogleCloudDiscoveryengineV1CreateEngineMetadata description: >- - Metadata that describes the training and serving parameters of an - Engine. + Metadata related to the progress of the EngineService.CreateEngine + operation. This will be returned by the + google.longrunning.Operation.metadata field. type: object properties: - similarDocumentsConfig: - description: Additional config specs for a `similar-items` engine. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig - chatEngineConfig: - description: >- - Configurations for the Chat Engine. Only applicable if solution_type - is SOLUTION_TYPE_CHAT. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig - searchEngineConfig: - description: >- - Configurations for the Search Engine. Only applicable if - solution_type is SOLUTION_TYPE_SEARCH. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig - mediaRecommendationEngineConfig: - description: >- - Configurations for the Media Engine. Only applicable on the data - stores with solution_type SOLUTION_TYPE_RECOMMENDATION and - IndustryVertical.MEDIA vertical. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig - recommendationMetadata: - description: >- - Output only. Additional information of a recommendation engine. Only - applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION. - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata - chatEngineMetadata: - description: >- - Output only. Additional information of the Chat Engine. Only - applicable if solution_type is SOLUTION_TYPE_CHAT. - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata - name: - description: >- - Immutable. The fully qualified resource name of the engine. This - field must be a UTF-8 encoded string with a length limit of 1024 - characters. Format: - `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` - engine should be 1-63 characters, and valid characters are - /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned. + createTime: + description: Operation create time. type: string - displayName: + format: google-datetime + updateTime: description: >- - Required. The display name of the engine. Should be human readable. - UTF-8 encoded string with limit of 1024 characters. + Operation last update time. If the operation is done, this is also + the finish time. type: string + format: google-datetime + GoogleCloudDiscoveryengineV1CreateSchemaMetadata: + id: GoogleCloudDiscoveryengineV1CreateSchemaMetadata + description: Metadata for Create Schema LRO. + type: object + properties: createTime: - description: Output only. Timestamp the Recommendation Engine was created at. - readOnly: true + description: Operation create time. type: string format: google-datetime updateTime: - description: Output only. Timestamp the Recommendation Engine was last updated. - readOnly: true + description: >- + Operation last update time. If the operation is done, this is also + the finish time. type: string format: google-datetime - dataStoreIds: - description: >- - The data stores associated with this engine. For - SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of - engines, they can only associate with at most one data store. If - solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same - Collection can be associated here. Note that when used in - CreateEngineRequest, one DataStore id must be provided as the system - will use it for necessary initializations. - type: array - items: - type: string - solutionType: - description: Required. The solutions of the engine. + GoogleCloudDiscoveryengineV1CreateSitemapMetadata: + id: GoogleCloudDiscoveryengineV1CreateSitemapMetadata + description: >- + Metadata related to the progress of the + SiteSearchEngineService.CreateSitemap operation. This will be returned + by the google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. type: string - enumDescriptions: - - Default value. - - Used for Recommendations AI. - - Used for Discovery Search. - - Used for use cases related to the Generative AI agent. - - >- - Used for use cases related to the Generative Chat agent. It's used - for Generative chat engine only, the associated data stores must - enrolled with `SOLUTION_TYPE_CHAT` solution. - enum: - - SOLUTION_TYPE_UNSPECIFIED - - SOLUTION_TYPE_RECOMMENDATION - - SOLUTION_TYPE_SEARCH - - SOLUTION_TYPE_CHAT - - SOLUTION_TYPE_GENERATIVE_CHAT - industryVertical: + format: google-datetime + updateTime: description: >- - The industry vertical that the engine registers. The restriction of - the Engine industry vertical is based on DataStore: If unspecified, - default to `GENERIC`. Vertical on Engine has to match vertical of - the DataStore linked to the engine. + Operation last update time. If the operation is done, this is also + the finish time. type: string - enumDescriptions: - - Value used when unset. - - >- - The generic vertical for documents that are not specific to any - industry vertical. - - The media industry vertical. - - The healthcare FHIR vertical. - enum: - - INDUSTRY_VERTICAL_UNSPECIFIED - - GENERIC - - MEDIA - - HEALTHCARE_FHIR - commonConfig: - description: Common config spec that specifies the metadata of the engine. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaEngineCommonConfig - disableAnalytics: - description: >- - Optional. Whether to disable analytics for searches performed on - this engine. - type: boolean - GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig: - id: GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig - description: Additional config specs for a `similar-items` engine. - type: object - properties: {} - GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig: - id: GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig - description: Configurations for a Chat Engine. + format: google-datetime + GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata: + id: GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata + description: >- + Metadata related to the progress of the + SiteSearchEngineService.CreateTargetSite operation. This will be + returned by the google.longrunning.Operation.metadata field. type: object properties: - agentCreationConfig: - description: >- - The configurationt generate the Dialogflow agent that is associated - to this Engine. Note that these configurations are one-time consumed - by and passed to Dialogflow service. It means they cannot be - retrieved using EngineService.GetEngine or EngineService.ListEngines - API after engine creation. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig - dialogflowAgentToLink: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: description: >- - The resource name of an exist Dialogflow agent to link to this Chat - Engine. Customers can either provide `agent_creation_config` to - create agent or provide an agent name that links the agent with the - Chat engine. Format: `projects//locations//agents/`. Note that the - `dialogflow_agent_to_link` are one-time consumed by and passed to - Dialogflow service. It means they cannot be retrieved using - EngineService.GetEngine or EngineService.ListEngines API after - engine creation. Use ChatEngineMetadata.dialogflow_agent for actual - agent association after Engine is created. + Operation last update time. If the operation is done, this is also + the finish time. type: string - GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig: - id: >- - GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig + format: google-datetime + GoogleCloudDiscoveryengineV1DeleteCmekConfigMetadata: + id: GoogleCloudDiscoveryengineV1DeleteCmekConfigMetadata description: >- - Configurations for generating a Dialogflow agent. Note that these - configurations are one-time consumed by and passed to Dialogflow - service. It means they cannot be retrieved using EngineService.GetEngine - or EngineService.ListEngines API after engine creation. + Metadata related to the progress of the + CmekConfigService.DeleteCmekConfig operation. This will be returned by + the google.longrunning.Operation.metadata field. type: object properties: - business: - description: >- - Name of the company, organization or other entity that the agent - represents. Used for knowledge connector LLM prompt and for - knowledge search. + createTime: + description: Operation create time. type: string - defaultLanguageCode: + format: google-datetime + updateTime: description: >- - Required. The default language of the agent as a language tag. See - [Language - Support](https://cloud.google.com/dialogflow/docs/reference/language) - for a list of the currently supported language codes. + Operation last update time. If the operation is done, this is also + the finish time. type: string - timeZone: - description: >- - Required. The time zone of the agent from the [time zone - database](https://www.iana.org/time-zones), e.g., America/New_York, - Europe/Paris. + format: google-datetime + GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata: + id: GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata + description: >- + Metadata related to the progress of the DataStoreService.DeleteDataStore + operation. This will be returned by the + google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. type: string - location: + format: google-datetime + updateTime: description: >- - Agent location for Agent creation, supported values: global/us/eu. - If not provided, us Engine will create Agent using us-central-1 by - default; eu Engine will create Agent using eu-west-1 by default. + Operation last update time. If the operation is done, this is also + the finish time. type: string - GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig: - id: GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig - description: Configurations for a Search Engine. + format: google-datetime + GoogleCloudDiscoveryengineV1DeleteEngineMetadata: + id: GoogleCloudDiscoveryengineV1DeleteEngineMetadata + description: >- + Metadata related to the progress of the EngineService.DeleteEngine + operation. This will be returned by the + google.longrunning.Operation.metadata field. type: object properties: - searchTier: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: description: >- - The search feature tier of this engine. Different tiers might have - different pricing. To learn more, check the pricing documentation. - Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. + Operation last update time. If the operation is done, this is also + the finish time. type: string - enumDescriptions: - - >- - Default value when the enum is unspecified. This is invalid to - use. - - Standard tier. - - Enterprise tier. - enum: - - SEARCH_TIER_UNSPECIFIED - - SEARCH_TIER_STANDARD - - SEARCH_TIER_ENTERPRISE - searchAddOns: - description: The add-on that this search engine enables. - type: array - items: - type: string - enumDescriptions: - - >- - Default value when the enum is unspecified. This is invalid to - use. - - Large language model add-on. - enum: - - SEARCH_ADD_ON_UNSPECIFIED - - SEARCH_ADD_ON_LLM - GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig: - id: GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig - description: Additional config specs for a Media Recommendation engine. + format: google-datetime + GoogleCloudDiscoveryengineV1DeleteIdentityMappingStoreMetadata: + id: GoogleCloudDiscoveryengineV1DeleteIdentityMappingStoreMetadata + description: >- + Metadata related to the progress of the + IdentityMappingStoreService.DeleteIdentityMappingStore operation. This + will be returned by the google.longrunning.Operation.metadata field. type: object properties: - type: - description: >- - Required. The type of engine. e.g., `recommended-for-you`. This - field together with optimization_objective describe engine metadata - to use to control engine training and serving. Currently supported - values: `recommended-for-you`, `others-you-may-like`, - `more-like-this`, `most-popular-items`. - type: string - optimizationObjective: - description: >- - The optimization objective. e.g., `cvr`. This field together with - optimization_objective describe engine metadata to use to control - engine training and serving. Currently supported values: `ctr`, - `cvr`. If not specified, we choose default based on engine type. - Default depends on type of recommendation: `recommended-for-you` => - `ctr` `others-you-may-like` => `ctr` + createTime: + description: Operation create time. type: string - optimizationObjectiveConfig: - description: >- - Name and value of the custom threshold for cvr - optimization_objective. For target_field `watch-time`, - target_field_value must be an integer value indicating the media - progress time in seconds between (0, 86400] (excludes 0, includes - 86400) (e.g., 90). For target_field `watch-percentage`, the - target_field_value must be a valid float value between (0, 1.0] - (excludes 0, includes 1.0) (e.g., 0.5). - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig - trainingState: + format: google-datetime + updateTime: description: >- - The training state that the engine is in (e.g. `TRAINING` or - `PAUSED`). Since part of the cost of running the service is - frequency of training - this can be used to determine when to train - engine in order to control cost. If not specified: the default value - for `CreateEngine` method is `TRAINING`. The default value for - `UpdateEngine` method is to keep the state the same as before. + Operation last update time. If the operation is done, this is also + the finish time. type: string - enumDescriptions: - - Unspecified training state. - - The engine training is paused. - - The engine is training. - enum: - - TRAINING_STATE_UNSPECIFIED - - PAUSED - - TRAINING - GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig: - id: >- - GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig - description: Custom threshold for `cvr` optimization_objective. + format: google-datetime + GoogleCloudDiscoveryengineV1DeleteSchemaMetadata: + id: GoogleCloudDiscoveryengineV1DeleteSchemaMetadata + description: Metadata for DeleteSchema LRO. type: object properties: - targetField: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: description: >- - Required. The name of the field to target. Currently supported - values: `watch-percentage`, `watch-time`. + Operation last update time. If the operation is done, this is also + the finish time. type: string - targetFieldValueFloat: - description: Required. The threshold to be applied to the target (e.g., 0.5). - type: number - format: float - GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata: - id: GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata - description: Additional information of a recommendation engine. + format: google-datetime + GoogleCloudDiscoveryengineV1DeleteSitemapMetadata: + id: GoogleCloudDiscoveryengineV1DeleteSitemapMetadata + description: >- + Metadata related to the progress of the + SiteSearchEngineService.DeleteSitemap operation. This will be returned + by the google.longrunning.Operation.metadata field. type: object properties: - servingState: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: description: >- - Output only. The serving state of the engine: `ACTIVE`, - `NOT_ACTIVE`. - readOnly: true - type: string - enumDescriptions: - - Unspecified serving state. - - The engine is not serving. - - The engine is serving and can be queried. - - The engine is trained on tuned hyperparameters and can be queried. - enum: - - SERVING_STATE_UNSPECIFIED - - INACTIVE - - ACTIVE - - TUNED - dataState: - description: >- - Output only. The state of data requirements for this engine: - `DATA_OK` and `DATA_ERROR`. Engine cannot be trained if the data is - in `DATA_ERROR` state. Engine can have `DATA_ERROR` state even if - serving state is `ACTIVE`: engines were trained successfully before, - but cannot be refreshed because the underlying engine no longer has - sufficient data for training. - readOnly: true - type: string - enumDescriptions: - - Unspecified default value, should never be explicitly set. - - The engine has sufficient training data. - - >- - The engine does not have sufficient training data. Error messages - can be queried via Stackdriver. - enum: - - DATA_STATE_UNSPECIFIED - - DATA_OK - - DATA_ERROR - lastTuneTime: - description: >- - Output only. The timestamp when the latest successful tune finished. - Only applicable on Media Recommendation engines. - readOnly: true + Operation last update time. If the operation is done, this is also + the finish time. type: string format: google-datetime - tuningOperation: - description: >- - Output only. The latest tune operation id associated with the - engine. Only applicable on Media Recommendation engines. If present, - this operation id can be used to determine if there is an ongoing - tune for this engine. To check the operation status, send the - GetOperation request with this operation id in the engine resource - format. If no tuning has happened for this engine, the string is - empty. - readOnly: true - type: string - GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata: - id: GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata + GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata: + id: GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata description: >- - Additional information of a Chat Engine. Fields in this message are - output only. + Metadata related to the progress of the + SiteSearchEngineService.DeleteTargetSite operation. This will be + returned by the google.longrunning.Operation.metadata field. type: object properties: - dialogflowAgent: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: description: >- - The resource name of a Dialogflow agent, that this Chat Engine - refers to. Format: `projects//locations//agents/`. + Operation last update time. If the operation is done, this is also + the finish time. type: string - GoogleCloudDiscoveryengineV1alphaEngineCommonConfig: - id: GoogleCloudDiscoveryengineV1alphaEngineCommonConfig - description: Common configurations for an Engine. + format: google-datetime + GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata: + id: GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata + description: >- + Metadata related to the progress of the + SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will + be returned by the google.longrunning.Operation.metadata field. type: object properties: - companyName: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: description: >- - The name of the company, business or entity that is associated with - the engine. Setting this may help improve LLM related features. + Operation last update time. If the operation is done, this is also + the finish time. type: string - GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata: - id: GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata + format: google-datetime + GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse: + id: GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse description: >- - Metadata related to the progress of the EstimateDataSize operation. This - is returned by the google.longrunning.Operation.metadata field. + Response message for SiteSearchEngineService.DisableAdvancedSiteSearch + method. + type: object + properties: {} + GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata: + id: GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata + description: >- + Metadata related to the progress of the + SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be + returned by the google.longrunning.Operation.metadata field. type: object properties: createTime: description: Operation create time. type: string format: google-datetime - GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse: - id: GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse: + id: GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse description: >- - Response of the EstimateDataSize request. If the long running operation - was successful, then this message is returned by the - google.longrunning.Operations.response field if the operation was - successful. + Response message for SiteSearchEngineService.EnableAdvancedSiteSearch + method. + type: object + properties: {} + GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata: + id: GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata + description: >- + IdentityMappingEntry LongRunningOperation metadata for + IdentityMappingStoreService.ImportIdentityMappings and + IdentityMappingStoreService.PurgeIdentityMappings type: object properties: - dataSizeBytes: - description: Data size in terms of bytes. + successCount: + description: >- + The number of IdentityMappingEntries that were successfully + processed. type: string format: int64 - documentCount: - description: Total number of documents. + failureCount: + description: The number of IdentityMappingEntries that failed to be processed. type: string format: int64 - GoogleCloudDiscoveryengineV1alphaEvaluation: - id: GoogleCloudDiscoveryengineV1alphaEvaluation + totalCount: + description: The total number of IdentityMappingEntries that were processed. + type: string + format: int64 + GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata: + id: GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata description: >- - An evaluation is a single execution (or run) of an evaluation process. - It encapsulates the state of the evaluation and the resulting data. + Metadata related to the progress of the ImportCompletionSuggestions + operation. This will be returned by the + google.longrunning.Operation.metadata field. type: object properties: - name: - description: >- - Identifier. The full resource name of the Evaluation, in the format - of - `projects/{project}/locations/{location}/evaluations/{evaluation}`. - This field must be a UTF-8 encoded string with a length limit of - 1024 characters. - type: string - evaluationSpec: - description: Required. The specification of the evaluation. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec - qualityMetrics: - description: >- - Output only. The metrics produced by the evaluation, averaged across - all SampleQuerys in the SampleQuerySet. Only populated when the - evaluation's state is SUCCEEDED. - readOnly: true - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaQualityMetrics' - state: - description: Output only. The state of the evaluation. - readOnly: true - type: string - enumDescriptions: - - The evaluation is unspecified. - - The service is preparing to run the evaluation. - - The evaluation is in progress. - - The evaluation completed successfully. - - The evaluation failed. - enum: - - STATE_UNSPECIFIED - - PENDING - - RUNNING - - SUCCEEDED - - FAILED - error: - description: >- - Output only. The error that occurred during evaluation. Only - populated when the evaluation's state is FAILED. - readOnly: true - $ref: '#/components/schemas/GoogleRpcStatus' createTime: - description: Output only. Timestamp the Evaluation was created at. - readOnly: true + description: Operation create time. type: string format: google-datetime - endTime: - description: Output only. Timestamp the Evaluation was completed at. - readOnly: true + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. type: string format: google-datetime + successCount: + description: Count of CompletionSuggestions successfully imported. + type: string + format: int64 + failureCount: + description: Count of CompletionSuggestions that failed to be imported. + type: string + format: int64 + GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsResponse: + id: GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsResponse + description: >- + Response of the CompletionService.ImportCompletionSuggestions method. If + the long running operation is done, this message is returned by the + google.longrunning.Operations.response field if the operation is + successful. + type: object + properties: errorSamples: - description: >- - Output only. A sample of errors encountered while processing the - request. - readOnly: true + description: A sample of errors encountered while processing the request. type: array items: $ref: '#/components/schemas/GoogleRpcStatus' - GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec: - id: GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec - description: Describes the specification of the evaluation. - type: object - properties: - searchRequest: - description: >- - Required. The search request that is used to perform the evaluation. - Only the following fields within SearchRequest are supported; if any - other fields are provided, an UNSUPPORTED error will be returned: * - SearchRequest.serving_config * SearchRequest.branch * - SearchRequest.canonical_filter * SearchRequest.query_expansion_spec - * SearchRequest.spell_correction_spec * - SearchRequest.content_search_spec * SearchRequest.user_pseudo_id - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequest' - querySetSpec: - description: Required. The specification of the query set. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec - GoogleCloudDiscoveryengineV1alphaSearchRequest: - id: GoogleCloudDiscoveryengineV1alphaSearchRequest - description: Request message for SearchService.Search method. + errorConfig: + description: The desired location of errors incurred during the Import. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1ImportErrorConfig' + GoogleCloudDiscoveryengineV1ImportDocumentsMetadata: + id: GoogleCloudDiscoveryengineV1ImportDocumentsMetadata + description: >- + Metadata related to the progress of the ImportDocuments operation. This + is returned by the google.longrunning.Operation.metadata field. type: object properties: - servingConfig: - description: >- - Required. The resource name of the Search serving config, such as - `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, - or - `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. - This field is used to identify the serving configuration name, set - of models used to make the search. + createTime: + description: Operation create time. type: string - branch: + format: google-datetime + updateTime: description: >- - The branch resource name, such as - `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. - Use `default_branch` as the branch ID or leave this field empty, to - search documents under the default branch. + Operation last update time. If the operation is done, this is also + the finish time. type: string - query: - description: Raw search query. + format: google-datetime + successCount: + description: Count of entries that were processed successfully. type: string - imageQuery: - description: Raw image query. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery - pageSize: - description: >- - Maximum number of Documents to return. The maximum allowed value - depends on the data type. Values above the maximum value are coerced - to the maximum value. * Websites with basic indexing: Default `10`, - Maximum `25`. * Websites with advanced indexing: Default `25`, - Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is - negative, an `INVALID_ARGUMENT` is returned. - type: integer - format: int32 - pageToken: - description: >- - A page token received from a previous SearchService.Search call. - Provide this to retrieve the subsequent page. When paginating, all - other parameters provided to SearchService.Search must match the - call that provided the page token. Otherwise, an `INVALID_ARGUMENT` - error is returned. + format: int64 + failureCount: + description: Count of entries that encountered errors while processing. type: string - offset: - description: >- - A 0-indexed integer that specifies the current offset (that is, - starting result location, amongst the Documents deemed by the API as - relevant) in search results. This field is only considered if - page_token is unset. If this field is negative, an - `INVALID_ARGUMENT` is returned. - type: integer - format: int32 - oneBoxPageSize: - description: >- - The maximum number of results to return for OneBox. This applies to - each OneBox type individually. Default number is 10. - type: integer - format: int32 - dataStoreSpecs: + format: int64 + totalCount: + description: Total count of entries that were processed. + type: string + format: int64 + GoogleCloudDiscoveryengineV1ImportDocumentsResponse: + id: GoogleCloudDiscoveryengineV1ImportDocumentsResponse + description: >- + Response of the ImportDocumentsRequest. If the long running operation is + done, then this message is returned by the + google.longrunning.Operations.response field if the operation was + successful. + type: object + properties: + errorSamples: + description: A sample of errors encountered while processing the request. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + errorConfig: description: >- - Specs defining dataStores to filter on in a search call and - configurations for those dataStores. This is only considered for - engines with multiple dataStores use case. For single dataStore - within an engine, they should use the specs at the top level. + Echoes the destination for the complete errors in the request if + set. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1ImportErrorConfig' + GoogleCloudDiscoveryengineV1ImportIdentityMappingsResponse: + id: GoogleCloudDiscoveryengineV1ImportIdentityMappingsResponse + description: Response message for IdentityMappingStoreService.ImportIdentityMappings + type: object + properties: + errorSamples: + description: A sample of errors encountered while processing the request. type: array items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec - filter: + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata: + id: GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata + description: >- + Metadata related to the progress of the ImportSuggestionDenyListEntries + operation. This is returned by the google.longrunning.Operation.metadata + field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: description: >- - The filter syntax consists of an expression language for - constructing a predicate from one or more fields of the documents - being filtered. Filter expression is case-sensitive. If this field - is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in - Vertex AI Search is done by mapping the LHS filter key to a key - property defined in the Vertex AI Search backend -- this mapping is - defined by the customer in their schema. For example a media - customer might have a field 'name' in their schema. In this case the - filter would look like this: filter --> name:'ANY("king kong")' For - more information about filtering including syntax and filter - operators, see - [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + Operation last update time. If the operation is done, this is also + the finish time. type: string - canonicalFilter: + format: google-datetime + GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse: + id: GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse + description: >- + Response message for CompletionService.ImportSuggestionDenyListEntries + method. + type: object + properties: + errorSamples: + description: A sample of errors encountered while processing the request. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + importedEntriesCount: + description: Count of deny list entries successfully imported. + type: string + format: int64 + failedEntriesCount: + description: Count of deny list entries that failed to be imported. + type: string + format: int64 + GoogleCloudDiscoveryengineV1ImportUserEventsMetadata: + id: GoogleCloudDiscoveryengineV1ImportUserEventsMetadata + description: >- + Metadata related to the progress of the Import operation. This is + returned by the google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: description: >- - The default filter that is applied when a user performs a search - without checking any filters on the search page. The filter applied - to every search request when quality improvement such as query - expansion is needed. In the case a query does not have a sufficient - amount of results this filter will be used to determine whether or - not to enable the query expansion flow. The original filter will - still be used for the query expanded search. This field is strongly - recommended to achieve high search quality. For more information - about filter syntax, see SearchRequest.filter. + Operation last update time. If the operation is done, this is also + the finish time. type: string - orderBy: + format: google-datetime + successCount: + description: Count of entries that were processed successfully. + type: string + format: int64 + failureCount: + description: Count of entries that encountered errors while processing. + type: string + format: int64 + GoogleCloudDiscoveryengineV1ImportUserEventsResponse: + id: GoogleCloudDiscoveryengineV1ImportUserEventsResponse + description: >- + Response of the ImportUserEventsRequest. If the long running operation + was successful, then this message is returned by the + google.longrunning.Operations.response field if the operation was + successful. + type: object + properties: + errorSamples: + description: A sample of errors encountered while processing the request. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + errorConfig: description: >- - The order in which documents are returned. Documents can be ordered - by a field in an Document object. Leave it unset if ordered by - relevance. `order_by` expression is case-sensitive. For more - information on ordering the website search results, see [Order web - search - results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). - For more information on ordering the healthcare search results, see - [Order healthcare search - results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). - If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. + Echoes the destination for the complete errors if this field was set + in the request. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1ImportErrorConfig' + joinedEventsCount: + description: Count of user events imported with complete existing Documents. type: string - userInfo: + format: int64 + unjoinedEventsCount: description: >- - Information about the end user. Highly recommended for analytics. - UserInfo.user_agent is used to deduce `device_type` for analytics. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaUserInfo' - languageCode: + Count of user events imported, but with Document information not + found in the existing Branch. + type: string + format: int64 + GoogleCloudDiscoveryengineV1Project: + id: GoogleCloudDiscoveryengineV1Project + description: Metadata and configurations for a Google Cloud project in the service. + type: object + properties: + name: description: >- - The BCP-47 language code, such as "en-US" or "sr-Latn". For more - information, see [Standard - fields](https://cloud.google.com/apis/design/standard_fields). This - field helps to better interpret the query. If a value isn't - specified, the query language code is automatically detected, which - may not be accurate. + Output only. Full resource name of the project, for example + `projects/{project}`. Note that when making requests, project number + and project id are both acceptable, but the server will always + respond in project number. + readOnly: true type: string - regionCode: + createTime: + description: Output only. The timestamp when this project is created. + readOnly: true + type: string + format: google-datetime + provisionCompletionTime: description: >- - The Unicode country/region code (CLDR) of a location, such as "US" - and "419". For more information, see [Standard - fields](https://cloud.google.com/apis/design/standard_fields). If - set, then results will be boosted based on the region_code provided. + Output only. The timestamp when this project is successfully + provisioned. Empty value means this project is still provisioning + and is not ready for use. + readOnly: true type: string - facetSpecs: + format: google-datetime + serviceTermsMap: description: >- - Facet specifications for faceted search. If empty, no facets are - returned. A maximum of 100 values are allowed. Otherwise, an - `INVALID_ARGUMENT` error is returned. - type: array - items: + Output only. A map of terms of services. The key is the `id` of + ServiceTerms. + readOnly: true + type: object + additionalProperties: $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec - boostSpec: + #/components/schemas/GoogleCloudDiscoveryengineV1ProjectServiceTerms + GoogleCloudDiscoveryengineV1ProjectServiceTerms: + id: GoogleCloudDiscoveryengineV1ProjectServiceTerms + description: Metadata about the terms of service. + type: object + properties: + id: description: >- - Boost specification to boost certain documents. For more information - on boosting, see - [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec - params: - description: >- - Additional search parameters. For public website search only, - supported values are: * `user_country_code`: string. Default empty. - If set to non-empty, results are restricted or boosted based on the - location provided. For example, `user_country_code: "au"` For - available codes see [Country - Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) - * `search_type`: double. Default empty. Enables non-webpage - searching depending on the value. The only valid non-default value - is 1, which enables image searching. For example, `search_type: 1` - type: object - additionalProperties: - type: any - queryExpansionSpec: - description: >- - The query expansion specification that specifies the conditions - under which query expansion occurs. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec - spellCorrectionSpec: - description: >- - The spell correction specification that specifies the mode under - which spell correction takes effect. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec - userPseudoId: - description: >- - A unique identifier for tracking visitors. For example, this could - be implemented with an HTTP cookie, which should be able to uniquely - identify a visitor on a single device. This unique identifier should - not change if the visitor logs in or out of the website. This field - should NOT have a fixed value such as `unknown_visitor`. This should - be the same identifier as UserEvent.user_pseudo_id and - CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 - encoded string with a length limit of 128 characters. Otherwise, an - `INVALID_ARGUMENT` error is returned. - type: string - contentSearchSpec: - description: A specification for configuring the behavior of content search. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec - embeddingSpec: - description: >- - Uses the provided embedding to do additional semantic document - retrieval. The retrieval is based on the dot product of - SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document - embedding that is provided in - SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If - SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not - provided, it will use ServingConfig.EmbeddingConfig.field_path. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec - rankingExpression: - description: >- - The ranking expression controls the customized ranking on retrieval - documents. This overrides ServingConfig.ranking_expression. The - ranking expression is a single function or multiple functions that - are joined by "+". * ranking_expression = function, { " + ", - function }; Supported functions: * double * relevance_score * double - * dotProduct(embedding_field_path) Function variables: * - `relevance_score`: pre-defined keywords, used for measure relevance - between query and document. * `embedding_field_path`: the document - embedding field used with query embedding vector. * `dotProduct`: - embedding function between embedding_field_path and query embedding - vector. Example ranking expression: If document has an embedding - field doc_embedding, the ranking expression could be `0.5 * - relevance_score + 0.3 * dotProduct(doc_embedding)`. + The unique identifier of this terms of service. Available terms: * + `GA_DATA_USE_TERMS`: [Terms for data + use](https://cloud.google.com/retail/data-use-terms). When using + this as `id`, the acceptable version to provide is `2022-11-23`. type: string - safeSearch: - description: >- - Whether to turn on safe search. This is only supported for website - search. - type: boolean - userLabels: - description: >- - The user labels applied to a resource must meet the following - requirements: * Each resource can have multiple labels, up to a - maximum of 64. * Each label must be a key-value pair. * Keys have a - minimum length of 1 character and a maximum length of 63 characters - and cannot be empty. Values can be empty and have a maximum length - of 63 characters. * Keys and values can contain only lowercase - letters, numeric characters, underscores, and dashes. All characters - must use UTF-8 encoding, and international characters are allowed. * - The key portion of a label must be unique. However, you can use the - same key with multiple resources. * Keys must start with a lowercase - letter or international character. See [Google Cloud - Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) - for more details. - type: object - additionalProperties: - type: string - naturalLanguageQueryUnderstandingSpec: - description: >- - If `naturalLanguageQueryUnderstandingSpec` is not specified, no - additional natural language query understanding will be done. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec - searchAsYouTypeSpec: - description: >- - Search as you type configuration. Only supported for the - IndustryVertical.MEDIA vertical. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec - customFineTuningSpec: - description: >- - Custom fine tuning configs. If set, it has higher priority than the - configs set in ServingConfig.custom_fine_tuning_spec. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec - session: + version: description: >- - The session resource name. Optional. Session allows users to do - multi-turn /search API calls or coordination between /search API - calls and /answer API calls. Example #1 (multi-turn /search API - calls): 1. Call /search API with the auto-session mode (see below). - 2. Call /search API with the session ID generated in the first call. - Here, the previous search query gets considered in query standing. - I.e., if the first query is "How did Alphabet do in 2022?" and the - current query is "How about 2023?", the current query will be - interpreted as "How did Alphabet do in 2023?". Example #2 - (coordination between /search API calls and /answer API calls): 1. - Call /search API with the auto-session mode (see below). 2. Call - /answer API with the session ID generated in the first call. Here, - the answer generation happens in the context of the search results - from the first search call. Auto-session mode: when - `projects/.../sessions/-` is used, a new session gets automatically - created. Otherwise, users can use the create-session API to create a - session manually. Multi-turn Search feature is currently at private - GA stage. Please use v1alpha or v1beta version instead before we - launch this feature to public GA. Or ask for allowlisting through - Google Support team. + The version string of the terms of service. For acceptable values, + see the comments for id above. type: string - sessionSpec: - description: Session specification. Can be used only when `session` is set. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec - relevanceThreshold: + state: description: >- - The relevance threshold of the search results. Default to Google - defined threshold, leveraging a balance of precision and recall to - deliver both highly accurate results and comprehensive coverage of - relevant information. + Whether the project has accepted/rejected the service terms or it is + still pending. type: string enumDescriptions: + - The default value of the enum. This value is not actually used. + - The project has given consent to the terms of service. + - The project is pending to review and accept the terms of service. - >- - Default value. In this case, server behavior defaults to Google - defined threshold. - - Lowest relevance threshold. - - Low relevance threshold. - - Medium relevance threshold. - - High relevance threshold. + The project has declined or revoked the agreement to terms of + service. enum: - - RELEVANCE_THRESHOLD_UNSPECIFIED - - LOWEST - - LOW - - MEDIUM - - HIGH - personalizationSpec: - description: >- - The specification for personalization. Notice that if both - ServingConfig.personalization_spec and - SearchRequest.personalization_spec are set, - SearchRequest.personalization_spec overrides - ServingConfig.personalization_spec. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec - GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery: - id: GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery - description: Specifies the image query input. - type: object - properties: - imageBytes: + - STATE_UNSPECIFIED + - TERMS_ACCEPTED + - TERMS_PENDING + - TERMS_DECLINED + acceptTime: + description: The last time when the project agreed to the terms of service. + type: string + format: google-datetime + declineTime: description: >- - Base64 encoded image bytes. Supported image formats: JPEG, PNG, and - BMP. + The last time when the project declined or revoked the agreement to + terms of service. type: string - GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec: - id: GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec + format: google-datetime + GoogleCloudDiscoveryengineV1ProvisionProjectMetadata: + id: GoogleCloudDiscoveryengineV1ProvisionProjectMetadata + description: Metadata associated with a project provision operation. + type: object + properties: {} + GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata: + id: GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata description: >- - A struct to define data stores to filter on in a search call and - configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` - error is returned. + Metadata related to the progress of the PurgeCompletionSuggestions + operation. This is returned by the google.longrunning.Operation.metadata + field. type: object properties: - dataStore: - description: >- - Required. Full resource name of DataStore, such as - `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. + createTime: + description: Operation create time. type: string - filter: + format: google-datetime + updateTime: description: >- - Optional. Filter specification to filter documents in the data store - specified by data_store field. For more information on filtering, - see - [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + Operation last update time. If the operation is done, this is also + the finish time. type: string - GoogleCloudDiscoveryengineV1alphaUserInfo: - id: GoogleCloudDiscoveryengineV1alphaUserInfo - description: Information of an end user. + format: google-datetime + GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse: + id: GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse + description: >- + Response message for CompletionService.PurgeCompletionSuggestions + method. type: object properties: - userId: - description: >- - Highly recommended for logged-in users. Unique identifier for - logged-in user, such as a user name. Don't set for anonymous users. - Always use a hashed value for this ID. Don't set the field to the - same fixed ID for different users. This mixes the event history of - those users together, which results in degraded model quality. The - field must be a UTF-8 encoded string with a length limit of 128 - characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + purgeSucceeded: + description: Whether the completion suggestions were successfully purged. + type: boolean + errorSamples: + description: A sample of errors encountered while processing the request. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata: + id: GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata + description: >- + Metadata related to the progress of the PurgeDocuments operation. This + will be returned by the google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. type: string - userAgent: + format: google-datetime + updateTime: description: >- - User agent as included in the HTTP header. The field must be a UTF-8 - encoded string with a length limit of 1,000 characters. Otherwise, - an `INVALID_ARGUMENT` error is returned. This should not be set when - using the client side event reporting with GTM or JavaScript tag in - UserEventService.CollectUserEvent or if - UserEvent.direct_user_request is set. + Operation last update time. If the operation is done, this is also + the finish time. type: string - GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec: - id: GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec - description: A facet specification to perform faceted search. - type: object - properties: - facetKey: - description: Required. The facet key specification. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey - limit: - description: >- - Maximum facet values that are returned for this facet. If - unspecified, defaults to 20. The maximum allowed value is 300. - Values above 300 are coerced to 300. For aggregation in healthcare - search, when the [FacetKey.key] is "healthcare_aggregation_key", the - limit will be overridden to 10,000 internally, regardless of the - value set here. If this field is negative, an `INVALID_ARGUMENT` is - returned. - type: integer - format: int32 - excludedFilterKeys: + format: google-datetime + successCount: + description: Count of entries that were deleted successfully. + type: string + format: int64 + failureCount: + description: Count of entries that encountered errors while processing. + type: string + format: int64 + ignoredCount: + description: Count of entries that were ignored as entries were not found. + type: string + format: int64 + GoogleCloudDiscoveryengineV1PurgeDocumentsResponse: + id: GoogleCloudDiscoveryengineV1PurgeDocumentsResponse + description: >- + Response message for DocumentService.PurgeDocuments method. If the long + running operation is successfully done, then this message is returned by + the google.longrunning.Operations.response field. + type: object + properties: + purgeCount: + description: The total count of documents purged as a result of the operation. + type: string + format: int64 + purgeSample: description: >- - List of keys to exclude when faceting. By default, FacetKey.key is - not excluded from the filter unless it is listed in this field. - Listing a facet key in this field allows its values to appear as - facet results, even when they are filtered out of search results. - Using this field does not affect what search results are returned. - For example, suppose there are 100 documents with the color facet - "Red" and 200 documents with the color facet "Blue". A query - containing the filter "color:ANY("Red")" and having "color" as - FacetKey.key would by default return only "Red" documents in the - search results, and also return "Red" with count 100 as the only - color facet. Although there are also blue documents available, - "Blue" would not be shown as an available facet value. If "color" is - listed in "excludedFilterKeys", then the query returns the facet - values "Red" with count 100 and "Blue" with count 200, because the - "color" key is now excluded from the filter. Because this field - doesn't affect search results, the search results are still - correctly filtered to return only "Red" documents. A maximum of 100 - values are allowed. Otherwise, an `INVALID_ARGUMENT` error is - returned. + A sample of document names that will be deleted. Only populated if + `force` is set to false. A max of 100 names will be returned and the + names are chosen at random. type: array items: type: string - enableDynamicPosition: - description: >- - Enables dynamic position for this facet. If set to true, the - position of this facet among all facets in the response is - determined automatically. If dynamic facets are enabled, it is - ordered together. If set to false, the position of this facet in the - response is the same as in the request, and it is ranked before the - facets with dynamic position enable and all dynamic facets. For - example, you may always want to have rating facet returned in the - response, but it's not necessarily to always display the rating - facet at the top. In that case, you can set enable_dynamic_position - to true so that the position of rating facet in response is - determined automatically. Another example, assuming you have the - following facets in the request: * "rating", enable_dynamic_position - = true * "price", enable_dynamic_position = false * "brands", - enable_dynamic_position = false And also you have a dynamic facets - enabled, which generates a facet `gender`. Then the final order of - the facets in the response can be ("price", "brands", "rating", - "gender") or ("price", "brands", "gender", "rating") depends on how - API orders "gender" and "rating" facets. However, notice that - "price" and "brands" are always ranked at first and second position - because their enable_dynamic_position is false. - type: boolean - GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey: - id: GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey - description: Specifies how a facet is computed. + GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata: + id: GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata + description: >- + Metadata related to the progress of the PurgeSuggestionDenyListEntries + operation. This is returned by the google.longrunning.Operation.metadata + field. type: object properties: - key: - description: >- - Required. Supported textual and numerical facet keys in Document - object, over which the facet values are computed. Facet key is - case-sensitive. + createTime: + description: Operation create time. type: string - intervals: + format: google-datetime + updateTime: description: >- - Set only if values should be bucketed into intervals. Must be set - for facets with numerical values. Must not be set for facet with - text values. Maximum number of intervals is 30. + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse: + id: GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse + description: >- + Response message for CompletionService.PurgeSuggestionDenyListEntries + method. + type: object + properties: + purgeCount: + description: Number of suggestion deny list entries purged. + type: string + format: int64 + errorSamples: + description: A sample of errors encountered while processing the request. type: array items: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaInterval' - restrictedValues: + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudDiscoveryengineV1TrainCustomModelMetadata: + id: GoogleCloudDiscoveryengineV1TrainCustomModelMetadata + description: >- + Metadata related to the progress of the TrainCustomModel operation. This + is returned by the google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: description: >- - Only get facet for the given restricted values. Only supported on - textual fields. For example, suppose "category" has three values - "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set - "restricted_values" to "Action > 2022", the "category" facet only - contains "Action > 2022". Only supported on textual fields. Maximum - is 10. + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1TrainCustomModelResponse: + id: GoogleCloudDiscoveryengineV1TrainCustomModelResponse + description: >- + Response of the TrainCustomModelRequest. This message is returned by the + google.longrunning.Operations.response field. + type: object + properties: + errorSamples: + description: A sample of errors encountered while processing the data. type: array items: - type: string - prefixes: + $ref: '#/components/schemas/GoogleRpcStatus' + errorConfig: description: >- - Only get facet values that start with the given string prefix. For - example, suppose "category" has three values "Action > 2022", - "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", - the "category" facet only contains "Action > 2022" and "Action > - 2021". Only supported on textual fields. Maximum is 10. - type: array - items: - type: string - contains: + Echoes the destination for the complete errors in the request if + set. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1ImportErrorConfig' + modelStatus: description: >- - Only get facet values that contain the given strings. For example, - suppose "category" has three values "Action > 2022", "Action > 2021" - and "Sci-Fi > 2022". If set "contains" to "2022", the "category" - facet only contains "Action > 2022" and "Sci-Fi > 2022". Only - supported on textual fields. Maximum is 10. - type: array - items: - type: string - caseInsensitive: + The trained model status. Possible values are: * **bad-data**: The + training data quality is bad. * **no-improvement**: Tuning didn't + improve performance. Won't deploy. * **in-progress**: Model training + job creation is in progress. * **training**: Model is actively + training. * **evaluating**: The model is evaluating trained metrics. + * **indexing**: The model trained metrics are indexing. * **ready**: + The model is ready for serving. + type: string + metrics: + description: The metrics of the trained model. + type: object + additionalProperties: + type: number + format: double + modelName: + description: Fully qualified name of the CustomTuningModel. + type: string + GoogleCloudDiscoveryengineV1UpdateCmekConfigMetadata: + id: GoogleCloudDiscoveryengineV1UpdateCmekConfigMetadata + description: >- + Metadata related to the progress of the + CmekConfigService.UpdateCmekConfig operation. This will be returned by + the google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: description: >- - True to make facet keys case insensitive when getting faceting - values with prefixes or contains; false otherwise. - type: boolean - orderBy: + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1UpdateSchemaMetadata: + id: GoogleCloudDiscoveryengineV1UpdateSchemaMetadata + description: Metadata for UpdateSchema LRO. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: description: >- - The order in which documents are returned. Allowed values are: * - "count desc", which means order by SearchResponse.Facet.values.count - descending. * "value desc", which means order by - SearchResponse.Facet.values.value descending. Only applies to - textual facets. If not set, textual values are sorted in [natural - order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical - intervals are sorted in the order given by - FacetSpec.FacetKey.intervals. + Operation last update time. If the operation is done, this is also + the finish time. type: string - GoogleCloudDiscoveryengineV1alphaInterval: - id: GoogleCloudDiscoveryengineV1alphaInterval - description: A floating point interval. + format: google-datetime + GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata: + id: GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata + description: >- + Metadata related to the progress of the + SiteSearchEngineService.UpdateTargetSite operation. This will be + returned by the google.longrunning.Operation.metadata field. type: object properties: - minimum: - description: Inclusive lower bound. - type: number - format: double - exclusiveMinimum: - description: Exclusive lower bound. - type: number - format: double - maximum: - description: Inclusive upper bound. - type: number - format: double - exclusiveMaximum: - description: Exclusive upper bound. - type: number - format: double - GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec: - id: GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec - description: Boost specification to boost certain documents. - type: object - properties: - conditionBoostSpecs: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: description: >- - Condition boost specifications. If a document matches multiple - conditions in the specifictions, boost scores from these - specifications are all applied and combined in a non-linear way. - Maximum number of specifications is 20. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec - GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec: - id: >- - GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec - description: Boost applies to documents which match a condition. + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1alphaAclConfig: + id: GoogleCloudDiscoveryengineV1alphaAclConfig + description: Access Control Configuration. type: object properties: - condition: + name: description: >- - An expression which specifies a boost condition. The syntax and - supported fields are the same as a filter expression. See - SearchRequest.filter for detail syntax and limitations. Examples: * - To boost documents with document ID "doc_1" or "doc_2", and color - "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: - ANY("Red", "Blue"))` + Immutable. The full resource name of the acl configuration. Format: + `projects/{project}/locations/{location}/aclConfig`. This field must + be a UTF-8 encoded string with a length limit of 1024 characters. type: string - boost: - description: >- - Strength of the condition boost, which should be in [-1, 1]. - Negative boost means demotion. Default is 0.0. Setting to 1.0 gives - the document a big promotion. However, it does not necessarily mean - that the boosted document will be the top result at all times, nor - that other documents will be excluded. Results could still be shown - even when none of them matches the condition. And results that are - significantly more relevant to the search query can still trump your - heavily favored but irrelevant documents. Setting to -1.0 gives the - document a big demotion. However, results that are deeply relevant - might still be shown. The document will have an upstream battle to - get a fairly high ranking, but it is not blocked out completely. - Setting to 0.0 means no boost applied. The boosting condition is - ignored. Only one of the (condition, boost) combination or the - boost_control_spec below are set. If both are set then the global - boost is ignored and the more fine-grained boost_control_spec is - applied. - type: number - format: float - boostControlSpec: - description: >- - Complex specification for custom ranking based on customer defined - attribute value. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec - GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec: - id: >- - GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec - description: >- - Specification for custom ranking based on customer specified attribute - value. It provides more controls for customized ranking than the simple - (condition, boost) combination above. + idpConfig: + description: Identity provider config. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaIdpConfig' + GoogleCloudDiscoveryengineV1alphaIdpConfig: + id: GoogleCloudDiscoveryengineV1alphaIdpConfig + description: Identity Provider Config. type: object properties: - fieldName: - description: >- - The name of the field whose value will be used to determine the - boost amount. - type: string - attributeType: - description: >- - The attribute type to be used to determine the boost amount. The - attribute value can be derived from the field value of the specified - field_name. In the case of numerical it is straightforward i.e. - attribute_value = numerical_field_value. In the case of freshness - however, attribute_value = (time.now() - datetime_field_value). - type: string - enumDescriptions: - - Unspecified AttributeType. - - >- - The value of the numerical field will be used to dynamically - update the boost amount. In this case, the attribute_value (the x - value) of the control point will be the actual value of the - numerical field for which the boost_amount is specified. - - >- - For the freshness use case the attribute value will be the - duration between the current time and the date in the datetime - field specified. The value must be formatted as an XSD - `dayTimeDuration` value (a restricted subset of an ISO 8601 - duration value). The pattern for this is: `nDnM]`. For example, - `5D`, `3DT12H30M`, `T24H`. - enum: - - ATTRIBUTE_TYPE_UNSPECIFIED - - NUMERICAL - - FRESHNESS - interpolationType: - description: >- - The interpolation type to be applied to connect the control points - listed below. + idpType: + description: Identity provider type configured. type: string enumDescriptions: - - >- - Interpolation type is unspecified. In this case, it defaults to - Linear. - - Piecewise linear interpolation will be applied. + - Default value. ACL search not enabled. + - Google 1P provider. + - Third party provider. enum: - - INTERPOLATION_TYPE_UNSPECIFIED - - LINEAR - controlPoints: - description: >- - The control points used to define the curve. The monotonic function - (defined through the interpolation_type above) passes through the - control points listed here. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint - GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint: - id: >- - GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint - description: >- - The control points used to define the curve. The curve defined through - these control points can only be monotonically increasing or - decreasing(constant values are acceptable). + - IDP_TYPE_UNSPECIFIED + - GSUITE + - THIRD_PARTY + externalIdpConfig: + description: External Identity provider config. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig + GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig: + id: GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig + description: Third party IDP Config. type: object properties: - attributeValue: + workforcePoolName: description: >- - Can be one of: 1. The numerical field value. 2. The duration spec - for freshness: The value must be formatted as an XSD - `dayTimeDuration` value (a restricted subset of an ISO 8601 duration - value). The pattern for this is: `nDnM]`. + Workforce pool name. Example: + "locations/global/workforcePools/pool_id" type: string - boostAmount: - description: >- - The value between -1 to 1 by which to boost the score if the - attribute_value evaluates to the value specified above. - type: number - format: float - GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec: - id: GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec - description: >- - Specification to determine under which conditions query expansion should - occur. + GoogleCloudDiscoveryengineV1alphaAnswer: + id: GoogleCloudDiscoveryengineV1alphaAnswer + description: Defines an answer. type: object properties: - condition: + name: description: >- - The condition under which query expansion should occur. Default to - Condition.DISABLED. + Immutable. Fully qualified name + `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*` type: string - enumDescriptions: - - >- - Unspecified query expansion condition. In this case, server - behavior defaults to Condition.DISABLED. - - >- - Disabled query expansion. Only the exact search query is used, - even if SearchResponse.total_size is zero. - - Automatic query expansion built by the Search API. - enum: - - CONDITION_UNSPECIFIED - - DISABLED - - AUTO - pinUnexpandedResults: - description: >- - Whether to pin unexpanded results. If this field is set to true, - unexpanded products are always at the top of the search results, - followed by the expanded results. - type: boolean - GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec: - id: GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec - description: The specification for query spell correction. - type: object - properties: - mode: - description: >- - The mode under which spell correction replaces the original search - query. Defaults to Mode.AUTO. + state: + description: The state of the answer generation. type: string enumDescriptions: - - >- - Unspecified spell correction mode. In this case, server behavior - defaults to Mode.AUTO. - - >- - Search API tries to find a spelling suggestion. If a suggestion is - found, it is put in the SearchResponse.corrected_query. The - spelling suggestion won't be used as the search query. - - >- - Automatic spell correction built by the Search API. Search will be - based on the corrected query if found. + - Unknown. + - Answer generation is currently in progress. + - Answer generation currently failed. + - Answer generation has succeeded. + - Answer generation is currently in progress. enum: - - MODE_UNSPECIFIED - - SUGGESTION_ONLY - - AUTO - GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec: - id: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec - description: A specification for configuring the behavior of content search. - type: object - properties: - snippetSpec: + - STATE_UNSPECIFIED + - IN_PROGRESS + - FAILED + - SUCCEEDED + - STREAMING + answerText: + description: The textual answer. + type: string + groundingScore: description: >- - If `snippetSpec` is not specified, snippets are not included in the - search response. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec - summarySpec: - description: >- - If `summarySpec` is not specified, summaries are not included in the - search response. + A score in the range of [0, 1] describing how grounded the answer is + by the reference chunks. + type: number + format: double + citations: + description: Citations. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaAnswerCitation + groundingSupports: + description: Optional. Grounding supports. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport + references: + description: References. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaAnswerReference + blobAttachments: + description: List of blob attachments in the answer. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachment + relatedQuestions: + description: Suggested related questions. + type: array + items: + type: string + steps: + description: Answer generation steps. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaAnswerStep' + queryUnderstandingInfo: + description: Query understanding information. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec - extractiveContentSpec: + #/components/schemas/GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo + answerSkippedReasons: description: >- - If there is no extractive_content_spec provided, there will be no - extractive answer in the search response. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec - searchResultMode: + Additional answer-skipped reasons. This provides the reason for + ignored cases. If nothing is skipped, this field is not set. + type: array + items: + type: string + enumDescriptions: + - Default value. The answer skipped reason is not specified. + - The adversarial query ignored case. + - >- + The non-answer seeking query ignored case Google skips the + answer if the query is chit chat. + - >- + The out-of-domain query ignored case. Google skips the answer if + there are no high-relevance search results. + - >- + The potential policy violation case. Google skips the answer if + there is a potential policy violation detected. This includes + content that may be violent or toxic. + - >- + The no relevant content case. Google skips the answer if there + is no relevant content in the retrieved search results. + - >- + The jail-breaking query ignored case. For example, "Reply in the + tone of a competing company's CEO". Google skips the answer if + the query is classified as a jail-breaking query. + - >- + The customer policy violation case. Google skips the summary if + there is a customer policy violation detected. The policy is + defined by the customer. + - >- + The non-answer seeking query ignored case. Google skips the + answer if the query doesn't have clear intent. + - >- + The low-grounded answer case. Google skips the answer if a well + grounded answer was unable to be generated. + - >- + The user defined query classification ignored case. Google skips + the answer if the query is classified as a user defined query + classification. + - >- + The unhelpful answer case. Google skips the answer if the answer + is not helpful. This can be due to a variety of factors, + including but not limited to: the query is not answerable, the + answer is not relevant to the query, or the answer is not + well-formatted. + enum: + - ANSWER_SKIPPED_REASON_UNSPECIFIED + - ADVERSARIAL_QUERY_IGNORED + - NON_ANSWER_SEEKING_QUERY_IGNORED + - OUT_OF_DOMAIN_QUERY_IGNORED + - POTENTIAL_POLICY_VIOLATION + - NO_RELEVANT_CONTENT + - JAIL_BREAKING_QUERY_IGNORED + - CUSTOMER_POLICY_VIOLATION + - NON_ANSWER_SEEKING_QUERY_IGNORED_V2 + - LOW_GROUNDED_ANSWER + - USER_DEFINED_CLASSIFICATION_QUERY_IGNORED + - UNHELPFUL_ANSWER + createTime: + description: Output only. Answer creation timestamp. + readOnly: true + type: string + format: google-datetime + completeTime: + description: Output only. Answer completed timestamp. + readOnly: true + type: string + format: google-datetime + safetyRatings: + description: Optional. Safety ratings. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaSafetyRating' + GoogleCloudDiscoveryengineV1alphaAnswerCitation: + id: GoogleCloudDiscoveryengineV1alphaAnswerCitation + description: Citation info for a segment. + type: object + properties: + startIndex: description: >- - Specifies the search result mode. If unspecified, the search result - mode defaults to `DOCUMENTS`. + Index indicates the start of the segment, measured in bytes (UTF-8 + unicode). If there are multi-byte characters,such as non-ASCII + characters, the index measurement is longer than the string length. type: string - enumDescriptions: - - Default value. - - Returns documents in the search result. - - >- - Returns chunks in the search result. Only available if the - DataStore.DocumentProcessingConfig.chunking_config is specified. - enum: - - SEARCH_RESULT_MODE_UNSPECIFIED - - DOCUMENTS - - CHUNKS - chunkSpec: + format: int64 + endIndex: description: >- - Specifies the chunk spec to be returned from the search response. - Only available if the - SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec - GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec: - id: >- - GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec - description: A specification for configuring snippets in a search response. + End of the attributed segment, exclusive. Measured in bytes (UTF-8 + unicode). If there are multi-byte characters,such as non-ASCII + characters, the index measurement is longer than the string length. + type: string + format: int64 + sources: + description: Citation sources for the attributed segment. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaAnswerCitationSource + GoogleCloudDiscoveryengineV1alphaAnswerCitationSource: + id: GoogleCloudDiscoveryengineV1alphaAnswerCitationSource + description: Citation source. type: object properties: - maxSnippetCount: + referenceId: + description: ID of the citation source. + type: string + GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport: + id: GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport + description: Grounding support for a claim in `answer_text`. + type: object + properties: + startIndex: description: >- - [DEPRECATED] This field is deprecated. To control snippet return, - use `return_snippet` field. For backwards compatibility, we will - return snippet if max_snippet_count > 0. - deprecated: true - type: integer - format: int32 - referenceOnly: + Required. Index indicates the start of the claim, measured in bytes + (UTF-8 unicode). + type: string + format: int64 + endIndex: + description: Required. End of the claim, exclusive. + type: string + format: int64 + groundingScore: description: >- - [DEPRECATED] This field is deprecated and will have no affect on the - snippet. - deprecated: true - type: boolean - returnSnippet: + A score in the range of [0, 1] describing how grounded is a specific + claim by the references. Higher value means that the claim is better + supported by the reference chunks. + type: number + format: double + groundingCheckRequired: description: >- - If `true`, then return snippet. If no snippet can be generated, we - return "No snippet is available for this page." A `snippet_status` - with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned. + Indicates that this claim required grounding check. When the system + decided this claim didn't require attribution/grounding check, this + field is set to false. In that case, no grounding check was done for + the claim and therefore `grounding_score`, `sources` is not + returned. type: boolean - GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec: - id: >- - GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec - description: A specification for configuring a summary returned in a search response. + sources: + description: Optional. Citation sources for the claim. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaAnswerCitationSource + GoogleCloudDiscoveryengineV1alphaAnswerReference: + id: GoogleCloudDiscoveryengineV1alphaAnswerReference + description: Reference. type: object properties: - summaryResultCount: + unstructuredDocumentInfo: + description: Unstructured document information. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo + chunkInfo: + description: Chunk information. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo + structuredDocumentInfo: + description: Structured document information. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo + GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo: + id: GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo + description: Unstructured document information. + type: object + properties: + document: + description: Document resource name. + type: string + uri: + description: URI for the document. + type: string + title: + description: Title. + type: string + chunkContents: + description: List of cited chunk contents derived from document content. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent + structData: description: >- - The number of top results to generate the summary from. If the - number of results returned is less than `summaryResultCount`, the - summary is generated from all of the results. At most 10 results for - documents mode, or 50 for chunks mode, can be used to generate a - summary. The chunks mode is used when - SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS. - type: integer - format: int32 - includeCitations: + The structured JSON metadata for the document. It is populated from + the struct data from the Chunk in search result. + type: object + additionalProperties: + type: any + description: Properties of the object. + GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent: + id: >- + GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent + description: Chunk content. + type: object + properties: + content: + description: Chunk textual content. + type: string + pageIdentifier: + description: Page identifier. + type: string + relevanceScore: description: >- - Specifies whether to include citations in the summary. The default - value is `false`. When this field is set to `true`, summaries - include in-line citation numbers. Example summary including - citations: BigQuery is Google Cloud's fully managed and completely - serverless enterprise data warehouse [1]. BigQuery supports all data - types, works across clouds, and has built-in machine learning and - business intelligence, all within a unified platform [2, 3]. The - citation numbers refer to the returned search results and are - 1-indexed. For example, [1] means that the sentence is attributed to - the first search result. [2, 3] means that the sentence is - attributed to both the second and third search results. - type: boolean - ignoreAdversarialQuery: - description: >- - Specifies whether to filter out adversarial queries. The default - value is `false`. Google employs search-query classification to - detect adversarial queries. No summary is returned if the search - query is classified as an adversarial query. For example, a user - might ask a question regarding negative comments about the company - or submit a query designed to generate unsafe, policy-violating - output. If this field is set to `true`, we skip generating summaries - for adversarial queries and return fallback messages instead. - type: boolean - ignoreNonSummarySeekingQuery: - description: >- - Specifies whether to filter out queries that are not - summary-seeking. The default value is `false`. Google employs - search-query classification to detect summary-seeking queries. No - summary is returned if the search query is classified as a - non-summary seeking query. For example, `why is the sky blue` and - `Who is the best soccer player in the world?` are summary-seeking - queries, but `SFO airport` and `world cup 2026` are not. They are - most likely navigational queries. If this field is set to `true`, we - skip generating summaries for non-summary seeking queries and return - fallback messages instead. - type: boolean - ignoreLowRelevantContent: - description: >- - Specifies whether to filter out queries that have low relevance. The - default value is `false`. If this field is set to `false`, all - search results are used regardless of relevance to generate answers. - If set to `true`, only queries with high relevance search results - will generate answers. - type: boolean - ignoreJailBreakingQuery: - description: >- - Optional. Specifies whether to filter out jail-breaking queries. The - default value is `false`. Google employs search-query classification - to detect jail-breaking queries. No summary is returned if the - search query is classified as a jail-breaking query. A user might - add instructions to the query to change the tone, style, language, - content of the answer, or ask the model to act as a different - entity, e.g. "Reply in the tone of a competing company's CEO". If - this field is set to `true`, we skip generating summaries for - jail-breaking queries and return fallback messages instead. - type: boolean - modelPromptSpec: - description: >- - If specified, the spec will be used to modify the prompt provided to - the LLM. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec - languageCode: - description: >- - Language code for Summary. Use language tags defined by - [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is - an experimental feature. + The relevance of the chunk for a given query. Values range from 0.0 + (completely irrelevant) to 1.0 (completely relevant). This value is + for informational purpose only. It may change for the same query and + chunk at any time due to a model retraining or change in + implementation. + type: number + format: float + blobAttachmentIndexes: + description: Output only. Stores indexes of blobattachments linked to this chunk. + readOnly: true + type: array + items: + type: string + format: int64 + GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo: + id: GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo + description: Chunk information. + type: object + properties: + chunk: + description: Chunk resource name. type: string - modelSpec: + content: + description: Chunk textual content. + type: string + relevanceScore: description: >- - If specified, the spec will be used to modify the model - specification provided to the LLM. + The relevance of the chunk for a given query. Values range from 0.0 + (completely irrelevant) to 1.0 (completely relevant). This value is + for informational purpose only. It may change for the same query and + chunk at any time due to a model retraining or change in + implementation. + type: number + format: float + documentMetadata: + description: Document metadata. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec - useSemanticChunks: - description: >- - If true, answer will be generated from most relevant chunks from top - search results. This feature will improve summary quality. Note that - with this feature enabled, not all top search results will be - referenced and included in the reference list, so the citation - source index only points to the search results listed in the - reference list. - type: boolean - GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec: + #/components/schemas/GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata + blobAttachmentIndexes: + description: Output only. Stores indexes of blobattachments linked to this chunk. + readOnly: true + type: array + items: + type: string + format: int64 + GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata: id: >- - GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec - description: Specification of the prompt to use with the model. + GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata + description: Document metadata. type: object properties: - preamble: - description: >- - Text at the beginning of the prompt that instructs the assistant. - Examples are available in the user guide. + document: + description: Document resource name. type: string - GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec: - id: >- - GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec - description: Specification of the model. + uri: + description: URI for the document. + type: string + title: + description: Title. + type: string + pageIdentifier: + description: Page identifier. + type: string + structData: + description: >- + The structured JSON metadata for the document. It is populated from + the struct data from the Chunk in search result. + type: object + additionalProperties: + type: any + description: Properties of the object. + GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo: + id: GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo + description: Structured search information. type: object properties: - version: - description: >- - The model version used to generate the summary. Supported values - are: * `stable`: string. Default value when no value is specified. - Uses a generally available, fine-tuned model. For more information, - see [Answer generation model versions and - lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). - * `preview`: string. (Public preview) Uses a preview model. For more - information, see [Answer generation model versions and - lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). + document: + description: Document resource name. type: string - GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec: - id: >- - GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec + structData: + description: Structured search data. + type: object + additionalProperties: + type: any + description: Properties of the object. + title: + description: Output only. The title of the document. + readOnly: true + type: string + uri: + description: Output only. The URI of the document. + readOnly: true + type: string + GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachment: + id: GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachment description: >- - A specification for configuring the extractive content in a search - response. + Stores binarydata attached to text answer, e.g. image, video, audio, + etc. type: object properties: - maxExtractiveAnswerCount: - description: >- - The maximum number of extractive answers returned in each search - result. An extractive answer is a verbatim answer extracted from the - original document, which provides a precise and contextually - relevant answer to the search query. If the number of matching - answers is less than the `max_extractive_answer_count`, return all - of the answers. Otherwise, return the `max_extractive_answer_count`. - At most five answers are returned for each SearchResult. - type: integer - format: int32 - maxExtractiveSegmentCount: - description: >- - The max number of extractive segments returned in each search - result. Only applied if the DataStore is set to - DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types - is SOLUTION_TYPE_CHAT. An extractive segment is a text segment - extracted from the original document that is relevant to the search - query, and, in general, more verbose than an extractive answer. The - segment could then be used as input for LLMs to generate summaries - and answers. If the number of matching segments is less than - `max_extractive_segment_count`, return all of the segments. - Otherwise, return the `max_extractive_segment_count`. - type: integer - format: int32 - returnExtractiveSegmentScore: - description: >- - Specifies whether to return the confidence score from the extractive - segments in each search result. This feature is available only for - new or allowlisted data stores. To allowlist your data store, - contact your Customer Engineer. The default value is `false`. - type: boolean - numPreviousSegments: - description: >- - Specifies whether to also include the adjacent from each selected - segments. Return at most `num_previous_segments` segments before - each selected segments. - type: integer - format: int32 - numNextSegments: - description: >- - Return at most `num_next_segments` segments after each selected - segments. - type: integer - format: int32 - GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec: - id: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec - description: >- - Specifies the chunk spec to be returned from the search response. Only - available if the SearchRequest.ContentSearchSpec.search_result_mode is - set to CHUNKS + data: + description: Output only. The mime type and data of the blob. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachmentBlob + attributionType: + description: Output only. The attribution type of the blob. + readOnly: true + type: string + enumDescriptions: + - Unspecified attribution type. + - The attachment data is from the corpus. + - >- + The attachment data is generated by the model through code + generation. + enum: + - ATTRIBUTION_TYPE_UNSPECIFIED + - CORPUS + - GENERATED + GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachmentBlob: + id: GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachmentBlob + description: The media type and data of the blob. type: object properties: - numPreviousChunks: - description: >- - The number of previous chunks to be returned of the current chunk. - The maximum allowed value is 3. If not specified, no previous chunks - will be returned. - type: integer - format: int32 - numNextChunks: + mimeType: description: >- - The number of next chunks to be returned of the current chunk. The - maximum allowed value is 3. If not specified, no next chunks will be - returned. - type: integer - format: int32 - GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec: - id: GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec - description: >- - The specification that uses customized query embedding vector to do - semantic document retrieval. + Output only. The media type (MIME type) of the generated or + retrieved data. + readOnly: true + type: string + data: + description: Output only. Raw bytes. + readOnly: true + type: string + format: byte + GoogleCloudDiscoveryengineV1alphaAnswerStep: + id: GoogleCloudDiscoveryengineV1alphaAnswerStep + description: Step information. type: object properties: - embeddingVectors: - description: The embedding vector used for retrieval. Limit to 1. + state: + description: The state of the step. + type: string + enumDescriptions: + - Unknown. + - Step is currently in progress. + - Step currently failed. + - Step has succeeded. + enum: + - STATE_UNSPECIFIED + - IN_PROGRESS + - FAILED + - SUCCEEDED + description: + description: The description of the step. + type: string + thought: + description: The thought of the step. + type: string + actions: + description: Actions. type: array items: $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector - GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector: - id: >- - GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector - description: Embedding vector. + #/components/schemas/GoogleCloudDiscoveryengineV1alphaAnswerStepAction + GoogleCloudDiscoveryengineV1alphaAnswerStepAction: + id: GoogleCloudDiscoveryengineV1alphaAnswerStepAction + description: Action. type: object properties: - fieldPath: - description: Embedding field path in schema. + searchAction: + description: Search action. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction + observation: + description: Observation. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation + GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction: + id: GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction + description: Search action. + type: object + properties: + query: + description: The query to search. type: string - vector: - description: Query embedding vector. + GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation: + id: GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation + description: Observation. + type: object + properties: + searchResults: + description: >- + Search results observed by the search action, it can be snippets + info or chunk info, depending on the citation type set by the user. type: array items: - type: number - format: float - GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec: - id: >- - GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec - description: >- - Specification to enable natural language understanding capabilities for - search requests. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult + GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult: + id: GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult type: object properties: - filterExtractionCondition: - description: >- - The condition under which filter extraction should occur. Default to - Condition.DISABLED. + document: + description: Document resource name. type: string - enumDescriptions: - - Server behavior defaults to Condition.DISABLED. - - Disables NL filter extraction. - - Enables NL filter extraction. - enum: - - CONDITION_UNSPECIFIED - - DISABLED - - ENABLED - geoSearchQueryDetectionFieldNames: + uri: + description: URI for the document. + type: string + title: + description: Title. + type: string + snippetInfo: description: >- - Field names used for location-based filtering, where geolocation - filters are detected in natural language search queries. Only valid - when the FilterExtractionCondition is set to `ENABLED`. If this - field is set, it overrides the field names set in - ServingConfig.geo_search_query_detection_field_names. + If citation_type is DOCUMENT_LEVEL_CITATION, populate document level + snippets. type: array items: - type: string - GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec: - id: GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec - description: Specification for search as you type in search requests. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo + chunkInfo: + description: >- + If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, + populate chunk info. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo + structData: + description: >- + Data representation. The structured JSON data for the document. It's + populated from the struct data from the Document, or the Chunk in + search result. + type: object + additionalProperties: + type: any + description: Properties of the object. + GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo: + id: >- + GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo + description: Snippet information. type: object properties: - condition: - description: >- - The condition under which search as you type should occur. Default - to Condition.DISABLED. + snippet: + description: Snippet content. type: string - enumDescriptions: - - Server behavior defaults to Condition.DISABLED. - - Disables Search As You Type. - - Enables Search As You Type. - enum: - - CONDITION_UNSPECIFIED - - DISABLED - - ENABLED - GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec: - id: GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec - description: Defines custom fine tuning spec. + snippetStatus: + description: Status of the snippet defined by the search team. + type: string + GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo: + id: >- + GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo + description: Chunk information. type: object properties: - enableSearchAdaptor: + chunk: + description: Chunk resource name. + type: string + content: + description: Chunk textual content. + type: string + relevanceScore: description: >- - Whether or not to enable and include custom fine tuned search - adaptor model. - type: boolean - GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec: - id: GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec - description: >- - Session specification. Multi-turn Search feature is currently at private - GA stage. Please use v1alpha or v1beta version instead before we launch - this feature to public GA. Or ask for allowlisting through Google - Support team. + The relevance of the chunk for a given query. Values range from 0.0 + (completely irrelevant) to 1.0 (completely relevant). This value is + for informational purpose only. It may change for the same query and + chunk at any time due to a model retraining or change in + implementation. + type: number + format: float + GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo: + id: GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo + description: Query understanding information. type: object properties: - queryId: - description: >- - If set, the search result gets stored to the "turn" specified by - this query ID. Example: Let's say the session looks like this: - session { name: ".../sessions/xxx" turns { query { text: "What is - foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { - query { text: "How about bar then?" query_id: ".../questions/zzz" } - } } The user can call /search API with a request like this: session: - ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } - Then, the API stores the search result, associated with the last - turn. The stored search result can be used by a subsequent /answer - API call (with the session ID and the query ID specified). Also, it - is possible to call /search and /answer in parallel with the same - session ID & query ID. - type: string - searchResultPersistenceCount: - description: >- - The number of top search results to persist. The persisted search - results can be used for the subsequent /answer api call. This field - is simliar to the `summary_result_count` field in - SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At - most 10 results for documents mode, or 50 for chunks mode. - type: integer - format: int32 - GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec: - id: GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec - description: The specification for personalization. + queryClassificationInfo: + description: Query classification information. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo + GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo: + id: >- + GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo + description: Query classification information. type: object properties: - mode: - description: >- - The personalization mode of the search request. Defaults to - Mode.AUTO. + type: + description: Query classification type. type: string enumDescriptions: - - >- - Default value. In this case, server behavior defaults to - Mode.AUTO. - - Personalization is enabled if data quality requirements are met. - - Disable personalization. + - Unspecified query classification type. + - Adversarial query classification type. + - Non-answer-seeking query classification type, for chit chat. + - Jail-breaking query classification type. + - Non-answer-seeking query classification type, for no clear intent. + - User defined query classification type. enum: - - MODE_UNSPECIFIED - - AUTO - - DISABLED - GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec: - id: GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec - description: Describes the specification of the query set. + - TYPE_UNSPECIFIED + - ADVERSARIAL_QUERY + - NON_ANSWER_SEEKING_QUERY + - JAIL_BREAKING_QUERY + - NON_ANSWER_SEEKING_QUERY_V2 + - USER_DEFINED_CLASSIFICATION_QUERY + positive: + description: Classification output. + type: boolean + GoogleCloudDiscoveryengineV1alphaSafetyRating: + id: GoogleCloudDiscoveryengineV1alphaSafetyRating + description: Safety rating corresponding to the generated content. type: object properties: - sampleQuerySet: - description: >- - Required. The full resource name of the SampleQuerySet used for the - evaluation, in the format of - `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. - type: string - GoogleCloudDiscoveryengineV1alphaQualityMetrics: - id: GoogleCloudDiscoveryengineV1alphaQualityMetrics - description: Describes the metrics produced by the evaluation. - type: object - properties: - docRecall: - description: >- - Recall per document, at various top-k cutoff levels. Recall is the - fraction of relevant documents retrieved out of all relevant - documents. Example (top-5): * For a single SampleQuery, If 3 out of - 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = - 0.6 - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics - docPrecision: - description: >- - Precision per document, at various top-k cutoff levels. Precision is - the fraction of retrieved documents that are relevant. Example - (top-5): * For a single SampleQuery, If 4 out of 5 retrieved - documents in the top-5 are relevant, precision@5 = 4/5 = 0.8 - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics - docNdcg: - description: >- - Normalized discounted cumulative gain (NDCG) per document, at - various top-k cutoff levels. NDCG measures the ranking quality, - giving higher relevance to top results. Example (top-3): Suppose - SampleQuery with three retrieved documents (D1, D2, D3) and binary - relevance judgements (1 for relevant, 0 for not relevant): - Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] - Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + - 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + - 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693 - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics - pageRecall: - description: >- - Recall per page, at various top-k cutoff levels. Recall is the - fraction of relevant pages retrieved out of all relevant pages. - Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant - pages are retrieved in the top-5, recall@5 = 3/5 = 0.6 - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics - pageNdcg: - description: >- - Normalized discounted cumulative gain (NDCG) per page, at various - top-k cutoff levels. NDCG measures the ranking quality, giving - higher relevance to top results. Example (top-3): Suppose - SampleQuery with three retrieved pages (P1, P2, P3) and binary - relevance judgements (1 for relevant, 0 for not relevant): - Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] - Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) - + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + - 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693 - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics - GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics: - id: GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics - description: Stores the metric values at specific top-k levels. - type: object - properties: - top1: - description: The top-1 value. - type: number - format: double - top3: - description: The top-3 value. - type: number - format: double - top5: - description: The top-5 value. - type: number - format: double - top10: - description: The top-10 value. - type: number - format: double - GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse: - id: GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse - description: Response message for SiteSearchEngineService.FetchSitemaps method. - type: object - properties: - sitemapsMetadata: - description: List of Sitemaps fetched. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata - GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata: - id: GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata - description: Contains a Sitemap and its metadata. - type: object - properties: - sitemap: - description: The Sitemap. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaSitemap' - GoogleCloudDiscoveryengineV1alphaSitemap: - id: GoogleCloudDiscoveryengineV1alphaSitemap - description: A sitemap for the SiteSearchEngine. - type: object - properties: - uri: - description: Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`. + category: + description: Output only. Harm category. + readOnly: true type: string - name: - description: >- - Output only. The fully qualified resource name of the sitemap. - `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/*` - The `sitemap_id` suffix is system-generated. + enumDescriptions: + - The harm category is unspecified. + - The harm category is hate speech. + - The harm category is dangerous content. + - The harm category is harassment. + - The harm category is sexually explicit content. + - The harm category is civic integrity. + enum: + - HARM_CATEGORY_UNSPECIFIED + - HARM_CATEGORY_HATE_SPEECH + - HARM_CATEGORY_DANGEROUS_CONTENT + - HARM_CATEGORY_HARASSMENT + - HARM_CATEGORY_SEXUALLY_EXPLICIT + - HARM_CATEGORY_CIVIC_INTEGRITY + probability: + description: Output only. Harm probability levels in the content. readOnly: true type: string - createTime: - description: Output only. The sitemap's creation time. + enumDescriptions: + - Harm probability unspecified. + - Negligible level of harm. + - Low level of harm. + - Medium level of harm. + - High level of harm. + enum: + - HARM_PROBABILITY_UNSPECIFIED + - NEGLIGIBLE + - LOW + - MEDIUM + - HIGH + probabilityScore: + description: Output only. Harm probability score. + readOnly: true + type: number + format: float + severity: + description: Output only. Harm severity levels in the content. readOnly: true type: string - format: google-datetime - GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse: - id: GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse - description: >- - Response message for SiteSearchEngineService.GetUriPatternDocumentData - method. - type: object - properties: - documentDataMap: + enumDescriptions: + - Harm severity unspecified. + - Negligible level of harm severity. + - Low level of harm severity. + - Medium level of harm severity. + - High level of harm severity. + enum: + - HARM_SEVERITY_UNSPECIFIED + - HARM_SEVERITY_NEGLIGIBLE + - HARM_SEVERITY_LOW + - HARM_SEVERITY_MEDIUM + - HARM_SEVERITY_HIGH + severityScore: + description: Output only. Harm severity score. + readOnly: true + type: number + format: float + blocked: description: >- - Document data keyed by URI pattern. For example: document_data_map = - { "www.url1.com/*": { "Categories": ["category1", "category2"] }, - "www.url2.com/*": { "Categories": ["category3"] } } - type: object - additionalProperties: - type: object - additionalProperties: - type: any - description: Properties of the object. - GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata: - id: GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata + Output only. Indicates whether the content was filtered out because + of this rating. + readOnly: true + type: boolean + GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata: + id: GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata description: >- - Metadata related to the progress of the ImportCompletionSuggestions - operation. This will be returned by the - google.longrunning.Operation.metadata field. + Metadata related to the progress of the + SiteSearchEngineService.BatchCreateTargetSites operation. This will be + returned by the google.longrunning.Operation.metadata field. type: object properties: createTime: @@ -10396,183 +10974,160 @@ components: the finish time. type: string format: google-datetime - successCount: - description: Count of CompletionSuggestions successfully imported. - type: string - format: int64 - failureCount: - description: Count of CompletionSuggestions that failed to be imported. - type: string - format: int64 - GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse: - id: GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse + GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse: + id: GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse description: >- - Response of the CompletionService.ImportCompletionSuggestions method. If - the long running operation is done, this message is returned by the - google.longrunning.Operations.response field if the operation is - successful. + Response message for SiteSearchEngineService.BatchCreateTargetSites + method. type: object properties: - errorSamples: - description: A sample of errors encountered while processing the request. + targetSites: + description: TargetSites created. type: array items: - $ref: '#/components/schemas/GoogleRpcStatus' - errorConfig: - description: The desired location of errors incurred during the Import. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaImportErrorConfig - GoogleCloudDiscoveryengineV1alphaImportErrorConfig: - id: GoogleCloudDiscoveryengineV1alphaImportErrorConfig - description: Configuration of destination for Import related errors. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaTargetSite' + GoogleCloudDiscoveryengineV1alphaTargetSite: + id: GoogleCloudDiscoveryengineV1alphaTargetSite + description: A target site for the SiteSearchEngine. type: object properties: - gcsPrefix: + name: description: >- - Cloud Storage prefix for import errors. This must be an empty, - existing Cloud Storage directory. Import errors are written to - sharded files in this directory, one per line, as a JSON-encoded - `google.rpc.Status` message. - type: string - GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata: - id: GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata - description: >- - Metadata related to the progress of the ImportDocuments operation. This - is returned by the google.longrunning.Operation.metadata field. - type: object - properties: - createTime: - description: Operation create time. + Output only. The fully qualified resource name of the target site. + `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` + The `target_site_id` is system-generated. + readOnly: true type: string - format: google-datetime - updateTime: + providedUriPattern: description: >- - Operation last update time. If the operation is done, this is also - the finish time. + Required. Input only. The user provided URI pattern from which the + `generated_uri_pattern` is generated. type: string - format: google-datetime - successCount: - description: Count of entries that were processed successfully. + type: + description: >- + The type of the target site, e.g., whether the site is to be + included or excluded. type: string - format: int64 - failureCount: - description: Count of entries that encountered errors while processing. + enumDescriptions: + - >- + This value is unused. In this case, server behavior defaults to + Type.INCLUDE. + - Include the target site. + - Exclude the target site. + enum: + - TYPE_UNSPECIFIED + - INCLUDE + - EXCLUDE + exactMatch: + description: >- + Immutable. If set to false, a uri_pattern is generated to include + all pages whose address contains the provided_uri_pattern. If set to + true, an uri_pattern is generated to try to be an exact match of the + provided_uri_pattern or just the specific page if the + provided_uri_pattern is a specific one. provided_uri_pattern is + always normalized to generate the URI pattern to be used by the + search engine. + type: boolean + generatedUriPattern: + description: >- + Output only. This is system-generated based on the + provided_uri_pattern. + readOnly: true type: string - format: int64 - totalCount: - description: Total count of entries that were processed. + rootDomainUri: + description: Output only. Root domain of the provided_uri_pattern. + readOnly: true type: string - format: int64 - GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse: - id: GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse - description: >- - Response of the ImportDocumentsRequest. If the long running operation is - done, then this message is returned by the - google.longrunning.Operations.response field if the operation was - successful. - type: object - properties: - errorSamples: - description: A sample of errors encountered while processing the request. - type: array - items: - $ref: '#/components/schemas/GoogleRpcStatus' - errorConfig: - description: >- - Echoes the destination for the complete errors in the request if - set. + siteVerificationInfo: + description: Output only. Site ownership and validity verification status. + readOnly: true $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaImportErrorConfig - GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata: - id: GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata - description: >- - Metadata related to the progress of the ImportSampleQueries operation. - This will be returned by the google.longrunning.Operation.metadata - field. - type: object - properties: - createTime: - description: ImportSampleQueries operation create time. + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo + indexingStatus: + description: Output only. Indexing status. + readOnly: true type: string - format: google-datetime + enumDescriptions: + - Defaults to SUCCEEDED. + - >- + The target site is in the update queue and will be picked up by + indexing pipeline. + - The target site fails to be indexed. + - The target site has been indexed. + - >- + The previously indexed target site has been marked to be deleted. + This is a transitioning state which will resulted in either: 1. + target site deleted if unindexing is successful; 2. state reverts + to SUCCEEDED if the unindexing fails. + - The target site change is pending but cancellable. + - The target site change is cancelled. + enum: + - INDEXING_STATUS_UNSPECIFIED + - PENDING + - FAILED + - SUCCEEDED + - DELETING + - CANCELLABLE + - CANCELLED updateTime: - description: >- - ImportSampleQueries operation last update time. If the operation is - done, this is also the finish time. + description: Output only. The target site's last updated time. + readOnly: true type: string format: google-datetime - successCount: - description: Count of SampleQuerys successfully imported. - type: string - format: int64 - failureCount: - description: Count of SampleQuerys that failed to be imported. - type: string - format: int64 - totalCount: - description: Total count of SampleQuerys that were processed. - type: string - format: int64 - GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse: - id: GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse - description: >- - Response of the SampleQueryService.ImportSampleQueries method. If the - long running operation is done, this message is returned by the - google.longrunning.Operations.response field if the operation is - successful. - type: object - properties: - errorSamples: - description: A sample of errors encountered while processing the request. - type: array - items: - $ref: '#/components/schemas/GoogleRpcStatus' - errorConfig: - description: The desired location of errors incurred during the Import. + failureReason: + description: Output only. Failure reason. + readOnly: true $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaImportErrorConfig - GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata: - id: GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata - description: >- - Metadata related to the progress of the ImportSuggestionDenyListEntries - operation. This is returned by the google.longrunning.Operation.metadata - field. + #/components/schemas/GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason + GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo: + id: GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo + description: Verification information for target sites in advanced site search. type: object properties: - createTime: - description: Operation create time. + siteVerificationState: + description: Site verification state indicating the ownership and validity. type: string - format: google-datetime - updateTime: - description: >- - Operation last update time. If the operation is done, this is also - the finish time. + enumDescriptions: + - Defaults to VERIFIED. + - Site ownership verified. + - Site ownership pending verification or verification failed. + - >- + Site exempt from verification, e.g., a public website that opens + to all. + enum: + - SITE_VERIFICATION_STATE_UNSPECIFIED + - VERIFIED + - UNVERIFIED + - EXEMPTED + verifyTime: + description: Latest site verification time. type: string format: google-datetime - GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse: - id: GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse - description: >- - Response message for CompletionService.ImportSuggestionDenyListEntries - method. + GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason: + id: GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason + description: Site search indexing failure reasons. type: object properties: - errorSamples: - description: A sample of errors encountered while processing the request. - type: array - items: - $ref: '#/components/schemas/GoogleRpcStatus' - importedEntriesCount: - description: Count of deny list entries successfully imported. - type: string - format: int64 - failedEntriesCount: - description: Count of deny list entries that failed to be imported. + quotaFailure: + description: Failed due to insufficient quota. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure + GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure: + id: GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure + description: Failed due to insufficient quota. + type: object + properties: + totalRequiredQuota: + description: >- + This number is an estimation on how much total quota this project + needs to successfully complete indexing. type: string format: int64 - GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata: - id: GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata + GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesMetadata: + id: GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesMetadata description: >- - Metadata related to the progress of the Import operation. This is + Metadata related to the progress of the + UserLicenseService.BatchUpdateUserLicenses operation. This will be returned by the google.longrunning.Operation.metadata field. type: object properties: @@ -10587,1192 +11142,1898 @@ components: type: string format: google-datetime successCount: - description: Count of entries that were processed successfully. + description: Count of user licenses successfully updated. type: string format: int64 failureCount: - description: Count of entries that encountered errors while processing. + description: Count of user licenses that failed to be updated. type: string format: int64 - GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse: - id: GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse - description: >- - Response of the ImportUserEventsRequest. If the long running operation - was successful, then this message is returned by the - google.longrunning.Operations.response field if the operation was - successful. + GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesResponse: + id: GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesResponse + description: Response message for UserLicenseService.BatchUpdateUserLicenses method. type: object properties: + userLicenses: + description: UserLicenses successfully updated. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaUserLicense' errorSamples: description: A sample of errors encountered while processing the request. type: array items: $ref: '#/components/schemas/GoogleRpcStatus' - errorConfig: - description: >- - Echoes the destination for the complete errors if this field was set - in the request. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaImportErrorConfig - joinedEventsCount: - description: Count of user events imported with complete existing Documents. - type: string - format: int64 - unjoinedEventsCount: - description: >- - Count of user events imported, but with Document information not - found in the existing Branch. - type: string - format: int64 - GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse: - id: GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse - description: Response message for SearchTuningService.ListCustomModels method. - type: object - properties: - models: - description: List of custom tuning models. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaCustomTuningModel - GoogleCloudDiscoveryengineV1alphaCustomTuningModel: - id: GoogleCloudDiscoveryengineV1alphaCustomTuningModel - description: Metadata that describes a custom tuned model. + GoogleCloudDiscoveryengineV1alphaUserLicense: + id: GoogleCloudDiscoveryengineV1alphaUserLicense + description: User License information assigned by the admin. type: object properties: - name: + userPrincipal: description: >- - Required. The fully qualified resource name of the model. Format: - `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`. - Model must be an alpha-numerical string with limit of 40 characters. - type: string - displayName: - description: The display name of the model. + Required. Immutable. The user principal of the User, could be email + address or other prinical identifier. This field is immutable. Admin + assign licenses based on the user principal. type: string - modelVersion: - description: The version of the model. + userProfile: + description: >- + Optional. The user profile. We user user full name(First name + Last + name) as user profile. type: string - format: int64 - modelState: + licenseAssignmentState: description: >- - The state that the model is in (e.g.`TRAINING` or - `TRAINING_FAILED`). + Output only. License assignment state of the user. If the user is + assigned with a license config, the user login will be assigned with + the license; If the user's license assignment state is unassigned or + unspecified, no license config will be associated to the user; + readOnly: true type: string enumDescriptions: - Default value. - - The model is in a paused training state. - - The model is currently training. - - The model has successfully completed training. - - The model is ready for serving. - - The model training failed. + - License assigned to the user. - >- - The model training finished successfully but metrics did not - improve. - - Input data validation failed. Model training didn't start. + No license assigned to the user. Deprecated, translated to + NO_LICENSE. + - No license assigned to the user. + - >- + User attempted to login but no license assigned to the user. This + state is only used for no user first time login attempt but cannot + get license assigned. Users already logged in but cannot get + license assigned will be assigned NO_LICENSE state(License could + be unassigned by admin). + - User is blocked from assigning a license. enum: - - MODEL_STATE_UNSPECIFIED - - TRAINING_PAUSED - - TRAINING - - TRAINING_COMPLETE - - READY_FOR_SERVING - - TRAINING_FAILED - - NO_IMPROVEMENT - - INPUT_VALIDATION_FAILED + - LICENSE_ASSIGNMENT_STATE_UNSPECIFIED + - ASSIGNED + - UNASSIGNED + - NO_LICENSE + - NO_LICENSE_ATTEMPTED_LOGIN + - BLOCKED + licenseConfig: + description: >- + Optional. The full resource name of the Subscription(LicenseConfig) + assigned to the user. + type: string createTime: - description: 'Deprecated: Timestamp the Model was created at.' - deprecated: true + description: Output only. User created timestamp. + readOnly: true type: string format: google-datetime - trainingStartTime: - description: Timestamp the model training was initiated. + updateTime: + description: Output only. User update timestamp. + readOnly: true type: string format: google-datetime - metrics: - description: The metrics of the trained model. - type: object - additionalProperties: - type: number - format: double - errorMessage: + lastLoginTime: description: >- - Currently this is only populated if the model state is - `INPUT_VALIDATION_FAILED`. + Output only. User last logged in time. If the user has not logged in + yet, this field will be empty. + readOnly: true type: string - GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse: - id: GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse - description: >- - Response message for CrawlRateManagementService.ObtainCrawlRate method. - The response contains organcic or dedicated crawl rate time series data - for monitoring, depending on whether dedicated crawl rate is set. - type: object + format: google-datetime + GoogleCloudDiscoveryengineV1alphaCmekConfig: + id: GoogleCloudDiscoveryengineV1alphaCmekConfig + description: Configurations used to enable CMEK data encryption with Cloud KMS keys. + type: object properties: - organicCrawlRateTimeSeries: + name: description: >- - The historical organic crawl rate timeseries data, used for - monitoring. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaOrganicCrawlRateTimeSeries - dedicatedCrawlRateTimeSeries: + Required. The name of the CmekConfig of the form + `projects/{project}/locations/{location}/cmekConfig` or + `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`. + type: string + kmsKey: description: >- - The historical dedicated crawl rate timeseries data, used for - monitoring. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries + Required. KMS key resource name which will be used to encrypt + resources + `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. + type: string + kmsKeyVersion: + description: >- + Output only. KMS key version resource name which will be used to + encrypt resources `/cryptoKeyVersions/{keyVersion}`. + readOnly: true + type: string state: - description: Output only. The state of the response. + description: Output only. The states of the CmekConfig. readOnly: true type: string enumDescriptions: - - The state is unspecified. - - The state is successful. - - The state is failed. + - The CmekConfig state is unknown. + - The CmekConfig is creating. + - The CmekConfig can be used with DataStores. + - >- + The CmekConfig is unavailable, most likely due to the KMS Key + being revoked. + - The CmekConfig is deleting. + - The CmekConfig deletion process failed. + - >- + The CmekConfig is not usable, most likely due to some internal + issue. + - The KMS key version is being rotated. + - >- + The KMS key is soft deleted. Some cleanup policy will eventually + be applied. enum: - STATE_UNSPECIFIED - - SUCCEEDED - - FAILED - error: - description: Errors from service when handling the request. - $ref: '#/components/schemas/GoogleRpcStatus' - GoogleCloudDiscoveryengineV1alphaOrganicCrawlRateTimeSeries: - id: GoogleCloudDiscoveryengineV1alphaOrganicCrawlRateTimeSeries - description: >- - The historical organic crawl rate timeseries data, used for monitoring. - Organic crawl is auto-determined by Google to crawl the user's website - when dedicate crawl is not set. Crawl rate is the QPS of crawl request - Google sends to the user's website. + - CREATING + - ACTIVE + - KEY_ISSUE + - DELETING + - DELETE_FAILED + - UNUSABLE + - ACTIVE_ROTATING + - DELETED + isDefault: + description: Output only. The default CmekConfig for the Customer. + readOnly: true + type: boolean + lastRotationTimestampMicros: + description: Output only. The timestamp of the last key rotation. + readOnly: true + type: string + format: int64 + singleRegionKeys: + description: >- + Optional. Single-regional CMEKs that are required for some VAIS + features. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSingleRegionKey + notebooklmState: + description: Output only. Whether the NotebookLM Corpus is ready to be used. + readOnly: true + type: string + enumDescriptions: + - The NotebookLM state is unknown. + - The NotebookLM is not ready. + - The NotebookLM is ready to be used. + - The NotebookLM is not enabled. + enum: + - NOTEBOOK_LM_STATE_UNSPECIFIED + - NOTEBOOK_LM_NOT_READY + - NOTEBOOK_LM_READY + - NOTEBOOK_LM_NOT_ENABLED + GoogleCloudDiscoveryengineV1alphaSingleRegionKey: + id: GoogleCloudDiscoveryengineV1alphaSingleRegionKey + description: Metadata for single-regional CMEKs. type: object properties: - googleOrganicCrawlRate: - description: >- - Google's organic crawl rate time series, which is the sum of all - googlebots' crawl rate. Please refer to - https://developers.google.com/search/docs/crawling-indexing/overview-google-crawlers - for more details about googlebots. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries - vertexAiOrganicCrawlRate: + kmsKey: description: >- - Vertex AI's organic crawl rate time series, which is the crawl rate - of Google-CloudVertexBot when dedicate crawl is not set. Please - refer to - https://developers.google.com/search/docs/crawling-indexing/google-common-crawlers#google-cloudvertexbot - for more details about Google-CloudVertexBot. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries - GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries: - id: GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries - description: The historical crawl rate timeseries data, used for monitoring. + Required. Single-regional kms key resource name which will be used + to encrypt resources + `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. + type: string + GoogleCloudDiscoveryengineV1alphaCollection: + id: GoogleCloudDiscoveryengineV1alphaCollection + description: >- + Collection is a container for configuring resources and access to a set + of DataStores. type: object properties: - qpsTimeSeries: - description: The QPS of the crawl rate. - $ref: '#/components/schemas/GoogleMonitoringV3TimeSeries' - GoogleMonitoringV3TimeSeries: - id: GoogleMonitoringV3TimeSeries + name: + description: >- + Immutable. The full resource name of the Collection. Format: + `projects/{project}/locations/{location}/collections/{collection_id}`. + This field must be a UTF-8 encoded string with a length limit of + 1024 characters. + type: string + displayName: + description: >- + Required. The Collection display name. This field must be a UTF-8 + encoded string with a length limit of 128 characters. Otherwise, an + INVALID_ARGUMENT error is returned. + type: string + dataConnector: + description: >- + Output only. The data connector, if present, manages the connection + for data stores in the Collection. To set up the connector, use + DataConnectorService.SetUpDataConnector method, which creates a new + Collection while setting up the DataConnector singleton resource. + Setting up connector on an existing Collection is not supported. + This output only field contains a subset of the DataConnector + fields, including `name`, `data_source`, `entities.entity_name` and + `entities.data_store`. To get more details about a data connector, + use the DataConnectorService.GetDataConnector method. + readOnly: true + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaDataConnector' + createTime: + description: Output only. Timestamp the Collection was created at. + readOnly: true + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1alphaDataConnector: + id: GoogleCloudDiscoveryengineV1alphaDataConnector description: >- - A collection of data points that describes the time-varying values of a - metric. A time series is identified by a combination of a - fully-specified monitored resource and a fully-specified metric. This - type is used for both listing and creating time series. + Manages the connection to external data sources for all data stores + grouped under a Collection. It's a singleton resource of Collection. The + initialization is only supported through + DataConnectorService.SetUpDataConnector method, which will create a new + Collection and initialize its DataConnector. type: object properties: - metric: + name: description: >- - The associated metric. A fully-specified metric used to identify the - time series. - $ref: '#/components/schemas/GoogleApiMetric' - resource: + Output only. The full resource name of the Data Connector. Format: + `projects/*/locations/*/collections/*/dataConnector`. + readOnly: true + type: string + state: + description: Output only. State of the connector. + readOnly: true + type: string + enumDescriptions: + - Default value. + - The connector is being set up. + - The connector is successfully set up and awaiting next sync run. + - >- + The connector is in error. The error details can be found in + DataConnector.errors. If the error is unfixable, the DataConnector + can be deleted by [CollectionService.DeleteCollection] API. + - The connector is actively syncing records from the data source. + - >- + The connector has completed a sync run, but encountered non-fatal + errors. + - >- + Connector initialization failed. Potential causes include runtime + errors or issues in the asynchronous pipeline, preventing the + request from reaching downstream services (except for some + connector types). + - Connector is in the process of an update. + enum: + - STATE_UNSPECIFIED + - CREATING + - ACTIVE + - FAILED + - RUNNING + - WARNING + - INITIALIZATION_FAILED + - UPDATING + dataSource: description: >- - The associated monitored resource. Custom metrics can use only - certain monitored resource types in their time series data. For more - information, see [Monitored resources for custom - metrics](https://cloud.google.com/monitoring/custom-metrics/creating-metrics#custom-metric-resources). - $ref: '#/components/schemas/GoogleApiMonitoredResource' - metadata: + Required. The name of the data source. Supported values: + `salesforce`, `jira`, `confluence`, `bigquery`. + type: string + params: description: >- - Output only. The associated monitored resource metadata. When - reading a time series, this field will include metadata labels that - are explicitly named in the reduction. When creating a time series, - this field is ignored. - $ref: '#/components/schemas/GoogleApiMonitoredResourceMetadata' - metricKind: + Required. Params needed to access the source in the format of (Key, + Value) pairs. Required parameters for all data sources: * Key: + `instance_uri` * Value: type STRING. The uri to access the data + source. Required parameters for sources that support OAUTH, i.e. + `salesforce`: * Key: `client_id` * Value: type STRING. The client ID + for the third party service provider to identify your application. * + Key: `client_secret` * Value:type STRING. The client secret + generated by the third party authorization server. * Key: + `access_token` * Value: type STRING. OAuth token for UCS to access + to the protected resource. * Key: `refresh_token` * Value: type + STRING. OAuth refresh token for UCS to obtain a new access token + without user interaction. Required parameters for sources that + support basic API token auth, i.e. `jira`, `confluence`: * Key: + `user_account` * Value: type STRING. The username or email with the + source. * Key: `api_token` * Value: type STRING. The API token + generated for the source account, that is used for authenticating + anywhere where you would have used a password. Example: ```json { + "instance_uri": "https://xxx.atlassian.net", "user_account": + "xxxx.xxx@xxx.com", "api_token": "test-token" } ``` Optional + parameter to specify the authorization type to use for multiple + authorization types support: * Key: `auth_type` * Value: type + STRING. The authorization type for the data source. Supported + values: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, + `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, + `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`. + type: object + additionalProperties: + type: any + description: Properties of the object. + refreshInterval: description: >- - The metric kind of the time series. When listing time series, this - metric kind might be different from the metric kind of the - associated metric if this time series is an alignment or reduction - of other time series. When creating a time series, this field is - optional. If present, it must be the same as the metric kind of the - associated metric. If the associated metric's descriptor must be - auto-created, then this field specifies the metric kind of the new - descriptor and must be either `GAUGE` (the default) or `CUMULATIVE`. + Required. The refresh interval for data sync. If duration is set to + 0, the data will be synced in real time. The streaming feature is + not supported yet. The minimum is 30 minutes and maximum is 7 days. + When the refresh interval is set to the same value as the + incremental refresh interval, incremental sync will be disabled. + type: string + format: google-duration + nextSyncTime: + description: >- + Defines the scheduled time for the next data synchronization. This + field requires hour , minute, and time_zone from the [IANA Time Zone + Database](https://www.iana.org/time-zones). This is utilized when + the data connector has a refresh interval greater than 1 day. When + the hours or minutes are not specified, we will assume a sync time + of 0:00. The user must provide a time zone to avoid ambiguity. + $ref: '#/components/schemas/GoogleTypeDateTime' + entities: + description: List of entities from the connected data source to ingest. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity + createTime: + description: Output only. Timestamp the DataConnector was created at. + readOnly: true + type: string + format: google-datetime + latestPauseTime: + description: >- + Output only. The most recent timestamp when this DataConnector was + paused, affecting all functionalities such as data synchronization. + Pausing a connector has the following effects: - All + functionalities, including data synchronization, are halted. - Any + ongoing data synchronization job will be canceled. - No future data + synchronization runs will be scheduled nor can be triggered. + readOnly: true + type: string + format: google-datetime + lastSyncTime: + description: >- + Output only. For periodic connectors only, the last time a data sync + was completed. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. Timestamp the DataConnector was last updated. + readOnly: true + type: string + format: google-datetime + errors: + description: >- + Output only. The errors from initialization or from the latest + connector run. + readOnly: true + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + syncMode: + description: The data synchronization mode supported by the data connector. type: string enumDescriptions: - - Do not use this default value. - - An instantaneous measurement of a value. - - The change in a value during a time interval. - >- - A value accumulated over a time interval. Cumulative measurements - in a time series should have the same start time and increasing - end times, until an event resets the cumulative value to zero and - sets a new start time for the following points. + The connector will sync data periodically based on the + refresh_interval. Use it with auto_run_disabled to pause the + periodic sync, or indicate a one-time sync. + - The data will be synced in real time. + - Connector that doesn't ingest data will have this value enum: - - METRIC_KIND_UNSPECIFIED - - GAUGE - - DELTA - - CUMULATIVE - valueType: + - PERIODIC + - STREAMING + - UNSPECIFIED + kmsKeyName: description: >- - The value type of the time series. When listing time series, this - value type might be different from the value type of the associated - metric if this time series is an alignment or reduction of other - time series. When creating a time series, this field is optional. If - present, it must be the same as the type of the data in the `points` - field. + Input only. The KMS key to be used to protect the DataStores managed + by this connector. Must be set for requests that need to comply with + CMEK Org Policy protections. If this field is set and processed + successfully, the DataStores created by this connector will be + protected by the KMS key. + type: string + destinationConfigs: + description: >- + Optional. Any target destinations used to connect to third-party + services. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaDestinationConfig + actionState: + description: >- + Output only. State of the action connector. This reflects whether + the action connector is initializing, active or has encountered + errors. + readOnly: true type: string enumDescriptions: - - Do not use this default value. + - Default value. + - The connector is being set up. + - The connector is successfully set up and awaiting next sync run. - >- - The value is a boolean. This value type can be used only if the - metric kind is `GAUGE`. - - The value is a signed 64-bit integer. - - The value is a double precision floating point number. + The connector is in error. The error details can be found in + DataConnector.errors. If the error is unfixable, the DataConnector + can be deleted by [CollectionService.DeleteCollection] API. + - The connector is actively syncing records from the data source. - >- - The value is a text string. This value type can be used only if - the metric kind is `GAUGE`. - - The value is a `Distribution`. - - The value is money. + The connector has completed a sync run, but encountered non-fatal + errors. + - >- + Connector initialization failed. Potential causes include runtime + errors or issues in the asynchronous pipeline, preventing the + request from reaching downstream services (except for some + connector types). + - Connector is in the process of an update. enum: - - VALUE_TYPE_UNSPECIFIED - - BOOL - - INT64 - - DOUBLE - - STRING - - DISTRIBUTION - - MONEY - points: + - STATE_UNSPECIFIED + - CREATING + - ACTIVE + - FAILED + - RUNNING + - WARNING + - INITIALIZATION_FAILED + - UPDATING + actionConfig: + description: >- + Optional. Action configurations to make the connector support + actions. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaActionConfig' + endUserConfig: + description: >- + Optional. Any params and credentials used specifically for EUA + connectors. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig + connectorModes: description: >- - The data points of this time series. When listing time series, - points are returned in reverse time order. When creating a time - series, this field must contain exactly one point and the point's - type must be the same as the value type of the associated metric. If - the associated metric's descriptor must be auto-created, then the - value type of the descriptor is determined by the point's type, - which must be `BOOL`, `INT64`, `DOUBLE`, or `DISTRIBUTION`. + Optional. The modes enabled for this connector. Default state is + CONNECTOR_MODE_UNSPECIFIED. type: array items: - $ref: '#/components/schemas/GoogleMonitoringV3Point' - unit: + type: string + enumDescriptions: + - Connector mode unspecified. + - Connector utilized for data ingestion. + - Connector utilized for actions. + - Connector utilized for federated search. + - Connector utilized for End User Authentication. + - >- + Hybrid connector utilized for federated search and End User + Authentication. + enum: + - CONNECTOR_MODE_UNSPECIFIED + - DATA_INGESTION + - ACTIONS + - FEDERATED + - EUA + - FEDERATED_AND_EUA + staticIpEnabled: + description: >- + Optional. Whether customer has enabled static IP addresses for this + connector. + type: boolean + staticIpAddresses: + description: Output only. The static IP addresses used by this connector. + readOnly: true + type: array + items: + type: string + blockingReasons: description: >- - The units in which the metric value is reported. It is only - applicable if the `value_type` is `INT64`, `DOUBLE`, or - `DISTRIBUTION`. The `unit` defines the representation of the stored - metric values. This field can only be changed through - CreateTimeSeries when it is empty. + Output only. User actions that must be completed before the + connector can start syncing data. + readOnly: true + type: array + items: + type: string + enumDescriptions: + - Default value. + - Connector requires customer to allowlist static IPs. + - >- + Connector requires customer to allowlist our project in their + service attachment. + enum: + - BLOCKING_REASON_UNSPECIFIED + - ALLOWLIST_STATIC_IP + - ALLOWLIST_IN_SERVICE_ATTACHMENT + identityRefreshInterval: + description: >- + The refresh interval to sync the Access Control List information for + the documents ingested by this connector. If not set, the access + control list will be refreshed at the default interval of 30 + minutes. The identity refresh interval can be at least 30 minutes + and at most 7 days. + deprecated: true type: string - description: + format: google-duration + identityScheduleConfig: description: >- - Input only. A detailed description of the time series that will be - associated with the google.api.MetricDescriptor for the metric. Once - set, this field cannot be changed through CreateTimeSeries. + The configuration for the identity data synchronization runs. This + contains the refresh interval to sync the Access Control List + information for the documents ingested by this connector. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig + privateConnectivityProjectId: + description: >- + Output only. The tenant project ID associated with private + connectivity connectors. This project must be allowlisted by in + order for the connector to function. + readOnly: true type: string - GoogleApiMetric: - id: GoogleApiMetric - description: >- - A specific metric, identified by specifying values for all of the labels - of a `MetricDescriptor`. + bapConfig: + description: Optional. The configuration for establishing a BAP connection. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaBAPConfig' + connectorType: + description: >- + Output only. The type of connector. Each source can only map to one + type. For example, salesforce, confluence and jira have THIRD_PARTY + connector type. It is not mutable once set by system. + readOnly: true + type: string + enumDescriptions: + - Default value. + - Third party connector to connector to third party application. + - Data connector connects between FHIR store and VAIS datastore. + - Big query connector. + - Google Cloud Storage connector. + - Gmail connector. + - Google Calendar connector. + - Google Drive connector. + - >- + Native Cloud Identity connector for people search powered by + People API. + - >- + Federated connector, it is a third party connector that doesn't + ingestion data, and search is powered by third party application's + API. + - Connector utilized for End User Authentication features. + - Google Cloud NetApp Volumes connector. + enum: + - CONNECTOR_TYPE_UNSPECIFIED + - THIRD_PARTY + - GCP_FHIR + - BIG_QUERY + - GCS + - GOOGLE_MAIL + - GOOGLE_CALENDAR + - GOOGLE_DRIVE + - NATIVE_CLOUD_IDENTITY + - THIRD_PARTY_FEDERATED + - THIRD_PARTY_EUA + - GCNV + realtimeState: + description: Output only. real-time sync state + readOnly: true + type: string + enumDescriptions: + - Default value. + - The connector is being set up. + - The connector is successfully set up and awaiting next sync run. + - >- + The connector is in error. The error details can be found in + DataConnector.errors. If the error is unfixable, the DataConnector + can be deleted by [CollectionService.DeleteCollection] API. + - The connector is actively syncing records from the data source. + - >- + The connector has completed a sync run, but encountered non-fatal + errors. + - >- + Connector initialization failed. Potential causes include runtime + errors or issues in the asynchronous pipeline, preventing the + request from reaching downstream services (except for some + connector types). + - Connector is in the process of an update. + enum: + - STATE_UNSPECIFIED + - CREATING + - ACTIVE + - FAILED + - RUNNING + - WARNING + - INITIALIZATION_FAILED + - UPDATING + alertPolicyConfigs: + description: Optional. The connector level alert config. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig + realtimeSyncConfig: + description: Optional. The configuration for realtime sync. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig + aclEnabled: + description: >- + Optional. Whether the connector will be created with an ACL config. + Currently this field only affects Cloud Storage and BigQuery + connectors. + type: boolean + createEuaSaas: + description: >- + Optional. Whether the END USER AUTHENTICATION connector is created + in SaaS. + type: boolean + autoRunDisabled: + description: >- + Optional. Indicates whether the connector is disabled for auto run. + It can be used to pause periodical and real time sync. Update: with + the introduction of incremental_sync_disabled, auto_run_disabled is + used to pause/disable only full syncs + type: boolean + incrementalSyncDisabled: + description: >- + Optional. Indicates whether incremental syncs are paused for this + connector. This is independent of auto_run_disabled. Applicable to + only 3P connectors. When the refresh interval is set to the same + value as the incremental refresh interval, incremental sync will be + disabled, i.e. set to true. + type: boolean + incrementalRefreshInterval: + description: >- + Optional. The refresh interval specifically for incremental data + syncs. If unset, incremental syncs will use the default from env, + set to 3hrs. The minimum is 30 minutes and maximum is 7 days. + Applicable to only 3P connectors. When the refresh interval is set + to the same value as the incremental refresh interval, incremental + sync will be disabled. + type: string + format: google-duration + hybridIngestionDisabled: + description: >- + Optional. If the connector is a hybrid connector, determines whether + ingestion is enabled and appropriate resources are provisioned + during connector creation. If the connector is not a hybrid + connector, this field is ignored. + type: boolean + GoogleTypeDateTime: + id: GoogleTypeDateTime + description: >- + Represents civil time (or occasionally physical time). This type can + represent a civil time in one of a few possible ways: * When utc_offset + is set and time_zone is unset: a civil time on a calendar day with a + particular offset from UTC. * When time_zone is set and utc_offset is + unset: a civil time on a calendar day in a particular time zone. * When + neither time_zone nor utc_offset is set: a civil time on a calendar day + in local time. The date is relative to the Proleptic Gregorian Calendar. + If year, month, or day are 0, the DateTime is considered not to have a + specific year, month, or day respectively. This type may also be used to + represent a physical time if all the date and time fields are set and + either case of the `time_offset` oneof is set. Consider using + `Timestamp` message for physical time instead. If your use case also + would like to store the user's timezone, that can be done in another + field. This type is more flexible than some applications may want. Make + sure to document and validate your application's limitations. type: object properties: - type: + year: description: >- - An existing metric type, see google.api.MetricDescriptor. For - example, `custom.googleapis.com/invoice/paid/amount`. + Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a + datetime without a year. + type: integer + format: int32 + month: + description: >- + Optional. Month of year. Must be from 1 to 12, or 0 if specifying a + datetime without a month. + type: integer + format: int32 + day: + description: >- + Optional. Day of month. Must be from 1 to 31 and valid for the year + and month, or 0 if specifying a datetime without a day. + type: integer + format: int32 + hours: + description: >- + Optional. Hours of day in 24 hour format. Should be from 0 to 23, + defaults to 0 (midnight). An API may choose to allow the value + "24:00:00" for scenarios like business closing time. + type: integer + format: int32 + minutes: + description: >- + Optional. Minutes of hour of day. Must be from 0 to 59, defaults to + 0. + type: integer + format: int32 + seconds: + description: >- + Optional. Seconds of minutes of the time. Must normally be from 0 to + 59, defaults to 0. An API may allow the value 60 if it allows + leap-seconds. + type: integer + format: int32 + nanos: + description: >- + Optional. Fractions of seconds in nanoseconds. Must be from 0 to + 999,999,999, defaults to 0. + type: integer + format: int32 + utcOffset: + description: >- + UTC offset. Must be whole seconds, between -18 hours and +18 hours. + For example, a UTC offset of -4:00 would be represented as { + seconds: -14400 }. type: string - labels: + format: google-duration + timeZone: + description: Time zone. + $ref: '#/components/schemas/GoogleTypeTimeZone' + GoogleTypeTimeZone: + id: GoogleTypeTimeZone + description: >- + Represents a time zone from the [IANA Time Zone + Database](https://www.iana.org/time-zones). + type: object + properties: + id: + description: IANA Time Zone Database time zone. For example "America/New_York". + type: string + version: description: >- - The set of label values that uniquely identify this metric. All - labels listed in the `MetricDescriptor` must be assigned values. - type: object - additionalProperties: - type: string - GoogleApiMonitoredResource: - id: GoogleApiMonitoredResource + Optional. IANA Time Zone Database version number. For example + "2019a". + type: string + GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity: + id: GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity description: >- - An object representing a resource that can be used for monitoring, - logging, billing, or other purposes. Examples include virtual machine - instances, databases, and storage devices such as disks. The `type` - field identifies a MonitoredResourceDescriptor object that describes the - resource's schema. Information in the `labels` field identifies the - actual resource and its attributes according to the schema. For example, - a particular Compute Engine VM instance could be represented by the - following object, because the MonitoredResourceDescriptor for - `"gce_instance"` has labels `"project_id"`, `"instance_id"` and - `"zone"`: { "type": "gce_instance", "labels": { "project_id": - "my-project", "instance_id": "12345678901234", "zone": "us-central1-a" - }} + Represents an entity in the data source. For example, the `Account` + object in Salesforce. type: object properties: - type: + entityName: description: >- - Required. The monitored resource type. This field must match the - `type` field of a MonitoredResourceDescriptor object. For example, - the type of a Compute Engine VM instance is `gce_instance`. Some - descriptors include the service name in the type; for example, the - type of a Datastream stream is `datastream.googleapis.com/Stream`. + The name of the entity. Supported values by data source: * + Salesforce: `Lead`, `Opportunity`, `Contact`, `Account`, `Case`, + `Contract`, `Campaign` * Jira: `Issue` * Confluence: `Content`, + `Space` type: string - labels: + keyPropertyMappings: description: >- - Required. Values for all of the labels listed in the associated - monitored resource descriptor. For example, Compute Engine VM - instances use the labels `"project_id"`, `"instance_id"`, and - `"zone"`. + Attributes for indexing. Key: Field name. Value: The key property to + map a field to, such as `title`, and `description`. Supported key + properties: * `title`: The title for data record. This would be + displayed on search results. * `description`: The description for + data record. This would be displayed on search results. type: object additionalProperties: type: string - GoogleApiMonitoredResourceMetadata: - id: GoogleApiMonitoredResourceMetadata - description: >- - Auxiliary metadata for a MonitoredResource object. MonitoredResource - objects contain the minimum set of information to uniquely identify a - monitored resource instance. There is some other useful auxiliary - metadata. Monitoring and Logging use an ingestion pipeline to extract - metadata for cloud resources of all types, and store the metadata in - this message. - type: object - properties: - systemLabels: + dataStore: description: >- - Output only. Values for predefined system metadata labels. System - labels are a kind of metadata extracted by Google, including - "machine_image", "vpc", "subnet_id", "security_group", "name", etc. - System label values can be only strings, Boolean values, or a list - of strings. For example: { "name": "my-test-instance", - "security_group": ["a", "b", "c"], "spot_instance": false } + Output only. The full resource name of the associated data store for + the source entity. Format: + `projects/*/locations/*/collections/*/dataStores/*`. When the + connector is initialized by the + DataConnectorService.SetUpDataConnector method, a DataStore is + automatically created for each source entity. + readOnly: true + type: string + params: + description: >- + The parameters for the entity to facilitate data ingestion. E.g. for + BigQuery connectors: * Key: `document_id_column` * Value: type + STRING. The value of the column ID. type: object additionalProperties: type: any description: Properties of the object. - userLabels: - description: Output only. A map of user-defined metadata labels. - type: object - additionalProperties: - type: string - GoogleMonitoringV3Point: - id: GoogleMonitoringV3Point - description: A single data point in a time series. - type: object - properties: - interval: + startingSchema: description: >- - The time interval to which the data point applies. For `GAUGE` - metrics, the start time is optional, but if it is supplied, it must - equal the end time. For `DELTA` metrics, the start and end time - should specify a non-zero interval, with subsequent points - specifying contiguous and non-overlapping intervals. For - `CUMULATIVE` metrics, the start and end time should specify a - non-zero interval, with subsequent points specifying the same start - time and increasing end times, until an event resets the cumulative - value to zero and sets a new start time for the following points. - $ref: '#/components/schemas/GoogleMonitoringV3TimeInterval' - value: - description: The value of the data point. - $ref: '#/components/schemas/GoogleMonitoringV3TypedValue' - GoogleMonitoringV3TimeInterval: - id: GoogleMonitoringV3TimeInterval - description: >- - A time interval extending just after a start time through an end time. - If the start time is the same as the end time, then the interval - represents a single point in time. + Optional. The start schema to use for the DataStore created from + this SourceEntity. If unset, a default vertical specialized schema + will be used. This field is only used by SetUpDataConnector API, and + will be ignored if used in other APIs. This field will be omitted + from all API responses including GetDataConnector API. To retrieve a + schema of a DataStore, use SchemaService.GetSchema API instead. The + provided schema will be validated against certain rules on schema. + Learn more from [this + doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaSchema' + healthcareFhirConfig: + description: Optional. Configuration for `HEALTHCARE_FHIR` vertical. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig + GoogleCloudDiscoveryengineV1alphaSchema: + id: GoogleCloudDiscoveryengineV1alphaSchema + description: Defines the structure and layout of a type of document data. type: object properties: - endTime: - description: Required. The end of the time interval. + structSchema: + description: The structured representation of the schema. + type: object + additionalProperties: + type: any + description: Properties of the object. + jsonSchema: + description: The JSON representation of the schema. type: string - format: google-datetime - startTime: + name: description: >- - Optional. The beginning of the time interval. The default value for - the start time is the end time. The start time must not be later - than the end time. + Immutable. The full resource name of the schema, in the format of + `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. + This field must be a UTF-8 encoded string with a length limit of + 1024 characters. type: string - format: google-datetime - GoogleMonitoringV3TypedValue: - id: GoogleMonitoringV3TypedValue - description: A single strongly-typed value. + fieldConfigs: + description: Output only. Configurations for fields of the schema. + readOnly: true + type: array + items: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaFieldConfig' + GoogleCloudDiscoveryengineV1alphaFieldConfig: + id: GoogleCloudDiscoveryengineV1alphaFieldConfig + description: >- + Configurations for fields of a schema. For example, configuring a field + is indexable, or searchable. type: object properties: - boolValue: - description: 'A Boolean value: `true` or `false`.' - type: boolean - int64Value: - description: A 64-bit integer. Its range is approximately ±9.2x1018. - type: string - format: int64 - doubleValue: + fieldPath: description: >- - A 64-bit double-precision floating-point number. Its magnitude is - approximately ±10±300 and it has 16 significant digits of precision. - type: number - format: double - stringValue: - description: A variable-length string value. + Required. Field path of the schema field. For example: `title`, + `description`, `release_info.release_year`. type: string - distributionValue: - description: A distribution value. - $ref: '#/components/schemas/GoogleApiDistribution' - GoogleApiDistribution: - id: GoogleApiDistribution - description: >- - `Distribution` contains summary statistics for a population of values. - It optionally contains a histogram representing the distribution of - those values across a set of buckets. The summary statistics are the - count, mean, sum of the squared deviation from the mean, the minimum, - and the maximum of the set of population of values. The histogram is - based on a sequence of buckets and gives a count of values that fall - into each bucket. The boundaries of the buckets are given either - explicitly or by formulas for buckets of fixed or exponentially - increasing widths. Although it is not forbidden, it is generally a bad - idea to include non-finite values (infinities or NaNs) in the population - of values, as this will render the `mean` and `sum_of_squared_deviation` - fields meaningless. - type: object - properties: - count: + fieldType: + description: Output only. Raw type of the field. + readOnly: true + type: string + enumDescriptions: + - Field type is unspecified. + - Field value type is Object. + - Field value type is String. + - Field value type is Number. + - Field value type is Integer. + - Field value type is Boolean. + - >- + Field value type is Geolocation. Geolocation is expressed as an + object with the following keys: * `id`: a string representing the + location id * `longitude`: a number representing the longitude + coordinate of the location * `latitude`: a number repesenting the + latitude coordinate of the location * `address`: a string + representing the full address of the location `latitude` and + `longitude` must always be provided together. At least one of a) + `address` or b) `latitude`-`longitude` pair must be provided. + - >- + Field value type is Datetime. Datetime can be expressed as either: + * a number representing milliseconds-since-the-epoch * a string + representing milliseconds-since-the-epoch. e.g. `"1420070400001"` + * a string representing the [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) date or date and + time. e.g. `"2015-01-01"` or `"2015-01-01T12:10:30Z"` + enum: + - FIELD_TYPE_UNSPECIFIED + - OBJECT + - STRING + - NUMBER + - INTEGER + - BOOLEAN + - GEOLOCATION + - DATETIME + indexableOption: description: >- - The number of values in the population. Must be non-negative. This - value must equal the sum of the values in `bucket_counts` if a - histogram is provided. + If indexable_option is INDEXABLE_ENABLED, field values are indexed + so that it can be filtered or faceted in SearchService.Search. If + indexable_option is unset, the server behavior defaults to + INDEXABLE_DISABLED for fields that support setting indexable + options. For those fields that do not support setting indexable + options, such as `object` and `boolean` and key properties, the + server will skip indexable_option setting, and setting + indexable_option for those fields will throw `INVALID_ARGUMENT` + error. type: string - format: int64 - mean: + enumDescriptions: + - Value used when unset. + - Indexable option enabled for a schema field. + - Indexable option disabled for a schema field. + enum: + - INDEXABLE_OPTION_UNSPECIFIED + - INDEXABLE_ENABLED + - INDEXABLE_DISABLED + dynamicFacetableOption: description: >- - The arithmetic mean of the values in the population. If `count` is - zero then this field must be zero. - type: number - format: double - sumOfSquaredDeviation: + If dynamic_facetable_option is DYNAMIC_FACETABLE_ENABLED, field + values are available for dynamic facet. Could only be + DYNAMIC_FACETABLE_DISABLED if FieldConfig.indexable_option is + INDEXABLE_DISABLED. Otherwise, an `INVALID_ARGUMENT` error will be + returned. If dynamic_facetable_option is unset, the server behavior + defaults to DYNAMIC_FACETABLE_DISABLED for fields that support + setting dynamic facetable options. For those fields that do not + support setting dynamic facetable options, such as `object` and + `boolean`, the server will skip dynamic facetable option setting, + and setting dynamic_facetable_option for those fields will throw + `INVALID_ARGUMENT` error. + type: string + enumDescriptions: + - Value used when unset. + - Dynamic facetable option enabled for a schema field. + - Dynamic facetable option disabled for a schema field. + enum: + - DYNAMIC_FACETABLE_OPTION_UNSPECIFIED + - DYNAMIC_FACETABLE_ENABLED + - DYNAMIC_FACETABLE_DISABLED + searchableOption: description: >- - The sum of squared deviations from the mean of the values in the - population. For values x_i this is: Sum[i=1..n]((x_i - mean)^2) - Knuth, "The Art of Computer Programming", Vol. 2, page 232, 3rd - edition describes Welford's method for accumulating this sum in one - pass. If `count` is zero then this field must be zero. - type: number - format: double - range: + If searchable_option is SEARCHABLE_ENABLED, field values are + searchable by text queries in SearchService.Search. If + SEARCHABLE_ENABLED but field type is numerical, field values will + not be searchable by text queries in SearchService.Search, as there + are no text values associated to numerical fields. If + searchable_option is unset, the server behavior defaults to + SEARCHABLE_DISABLED for fields that support setting searchable + options. Only `string` fields that have no key property mapping + support setting searchable_option. For those fields that do not + support setting searchable options, the server will skip searchable + option setting, and setting searchable_option for those fields will + throw `INVALID_ARGUMENT` error. + type: string + enumDescriptions: + - Value used when unset. + - Searchable option enabled for a schema field. + - Searchable option disabled for a schema field. + enum: + - SEARCHABLE_OPTION_UNSPECIFIED + - SEARCHABLE_ENABLED + - SEARCHABLE_DISABLED + retrievableOption: description: >- - If specified, contains the range of the population values. The field - must not be present if the `count` is zero. - $ref: '#/components/schemas/GoogleApiDistributionRange' - bucketOptions: + If retrievable_option is RETRIEVABLE_ENABLED, field values are + included in the search results. If retrievable_option is unset, the + server behavior defaults to RETRIEVABLE_DISABLED for fields that + support setting retrievable options. For those fields that do not + support setting retrievable options, such as `object` and `boolean`, + the server will skip retrievable option setting, and setting + retrievable_option for those fields will throw `INVALID_ARGUMENT` + error. + type: string + enumDescriptions: + - Value used when unset. + - Retrievable option enabled for a schema field. + - Retrievable option disabled for a schema field. + enum: + - RETRIEVABLE_OPTION_UNSPECIFIED + - RETRIEVABLE_ENABLED + - RETRIEVABLE_DISABLED + completableOption: description: >- - Defines the histogram bucket boundaries. If the distribution does - not contain a histogram, then omit this field. - $ref: '#/components/schemas/GoogleApiDistributionBucketOptions' - bucketCounts: + If completable_option is COMPLETABLE_ENABLED, field values are + directly used and returned as suggestions for Autocomplete in + CompletionService.CompleteQuery. If completable_option is unset, the + server behavior defaults to COMPLETABLE_DISABLED for fields that + support setting completable options, which are just `string` fields. + For those fields that do not support setting completable options, + the server will skip completable option setting, and setting + completable_option for those fields will throw `INVALID_ARGUMENT` + error. + type: string + enumDescriptions: + - Value used when unset. + - Completable option enabled for a schema field. + - Completable option disabled for a schema field. + enum: + - COMPLETABLE_OPTION_UNSPECIFIED + - COMPLETABLE_ENABLED + - COMPLETABLE_DISABLED + recsFilterableOption: description: >- - The number of values in each bucket of the histogram, as described - in `bucket_options`. If the distribution does not have a histogram, - then omit this field. If there is a histogram, then the sum of the - values in `bucket_counts` must equal the value in the `count` field - of the distribution. If present, `bucket_counts` should contain N - values, where N is the number of buckets specified in - `bucket_options`. If you supply fewer than N values, the remaining - values are assumed to be 0. The order of the values in - `bucket_counts` follows the bucket numbering schemes described for - the three bucket types. The first value must be the count for the - underflow bucket (number 0). The next N-2 values are the counts for - the finite buckets (number 1 through N-2). The N'th value in - `bucket_counts` is the count for the overflow bucket (number N-1). + If recs_filterable_option is FILTERABLE_ENABLED, field values are + filterable by filter expression in RecommendationService.Recommend. + If FILTERABLE_ENABLED but the field type is numerical, field values + are not filterable by text queries in + RecommendationService.Recommend. Only textual fields are supported. + If recs_filterable_option is unset, the default setting is + FILTERABLE_DISABLED for fields that support setting filterable + options. When a field set to [FILTERABLE_DISABLED] is filtered, a + warning is generated and an empty result is returned. + type: string + enumDescriptions: + - Value used when unset. + - Filterable option enabled for a schema field. + - Filterable option disabled for a schema field. + enum: + - FILTERABLE_OPTION_UNSPECIFIED + - FILTERABLE_ENABLED + - FILTERABLE_DISABLED + keyPropertyType: + description: >- + Output only. Type of the key property that this field is mapped to. + Empty string if this is not annotated as mapped to a key property. + Example types are `title`, `description`. Full list is defined by + `keyPropertyMapping` in the schema field annotation. If the schema + field has a `KeyPropertyMapping` annotation, `indexable_option` and + `searchable_option` of this field cannot be modified. + readOnly: true + type: string + advancedSiteSearchDataSources: + description: >- + If this field is set, only the corresponding source will be indexed + for this field. Otherwise, the values from different sources are + merged. Assuming a page with `` in meta tag, and `` in page map: if + this enum is set to METATAGS, we will only index ``; if this enum is + not set, we will merge them and index ``. type: array items: type: string - format: int64 - exemplars: - description: Must be in increasing order of `value` field. - type: array - items: - $ref: '#/components/schemas/GoogleApiDistributionExemplar' - GoogleApiDistributionRange: - id: GoogleApiDistributionRange - description: The range of the population values. - type: object - properties: - min: - description: The minimum of the population values. - type: number - format: double - max: - description: The maximum of the population values. - type: number - format: double - GoogleApiDistributionBucketOptions: - id: GoogleApiDistributionBucketOptions - description: >- - `BucketOptions` describes the bucket boundaries used to create a - histogram for the distribution. The buckets can be in a linear sequence, - an exponential sequence, or each bucket can be specified explicitly. - `BucketOptions` does not include the number of values in each bucket. A - bucket has an inclusive lower bound and exclusive upper bound for the - values that are counted for that bucket. The upper bound of a bucket - must be strictly greater than the lower bound. The sequence of N buckets - for a distribution consists of an underflow bucket (number 0), zero or - more finite buckets (number 1 through N - 2) and an overflow bucket - (number N - 1). The buckets are contiguous: the lower bound of bucket i - (i > 0) is the same as the upper bound of bucket i - 1. The buckets span - the whole range of finite values: lower bound of the underflow bucket is - -infinity and the upper bound of the overflow bucket is +infinity. The - finite buckets are so-called because both bounds are finite. + enumDescriptions: + - Value used when unset. + - Retrieve value from meta tag. + - Retrieve value from page map. + - >- + Retrieve value from the attributes set by + SiteSearchEngineService.SetUriPatternDocumentData API. + - Retrieve value from schema.org data. + enum: + - ADVANCED_SITE_SEARCH_DATA_SOURCE_UNSPECIFIED + - METATAGS + - PAGEMAP + - URI_PATTERN_MAPPING + - SCHEMA_ORG + schemaOrgPaths: + description: >- + Field paths for indexing custom attribute from schema.org data. More + details of schema.org and its defined types can be found at + [schema.org](https://schema.org). It is only used on advanced site + search schema. Currently only support full path from root. The full + path to a field is constructed by concatenating field names, + starting from `_root`, with a period `.` as the delimiter. Examples: + * Publish date of the root: _root.datePublished * Publish date of + the reviews: _root.review.datePublished + type: array + items: + type: string + metatagName: + description: >- + Optional. The metatag name found in the HTML page. If user defines + this field, the value of this metatag name will be used to extract + metatag. If the user does not define this field, the + FieldConfig.field_path will be used to extract metatag. + type: string + GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig: + id: GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig + description: Config to data store for `HEALTHCARE_FHIR` vertical. type: object properties: - linearBuckets: - description: The linear bucket. - $ref: '#/components/schemas/GoogleApiDistributionBucketOptionsLinear' - exponentialBuckets: - description: The exponential buckets. - $ref: '#/components/schemas/GoogleApiDistributionBucketOptionsExponential' - explicitBuckets: - description: The explicit buckets. - $ref: '#/components/schemas/GoogleApiDistributionBucketOptionsExplicit' - GoogleApiDistributionBucketOptionsLinear: - id: GoogleApiDistributionBucketOptionsLinear - description: >- - Specifies a linear sequence of buckets that all have the same width - (except overflow and underflow). Each bucket represents a constant - absolute uncertainty on the specific value in the bucket. There are - `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the following - boundaries: Upper bound (0 <= i < N-1): offset + (width * i). Lower - bound (1 <= i < N): offset + (width * (i - 1)). + enableConfigurableSchema: + description: >- + Whether to enable configurable schema for `HEALTHCARE_FHIR` + vertical. If set to `true`, the predefined healthcare fhir schema + can be extended for more customized searching and filtering. + type: boolean + enableStaticIndexingForBatchIngestion: + description: >- + Whether to enable static indexing for `HEALTHCARE_FHIR` batch + ingestion. If set to `true`, the batch ingestion will be processed + in a static indexing mode which is slower but more capable of + handling larger volume. + type: boolean + GoogleCloudDiscoveryengineV1alphaDestinationConfig: + id: GoogleCloudDiscoveryengineV1alphaDestinationConfig + description: Defines target endpoints used to connect to third-party sources. type: object properties: - numFiniteBuckets: - description: Must be greater than 0. - type: integer - format: int32 - width: - description: Must be greater than 0. - type: number - format: double - offset: - description: Lower bound of the first bucket. - type: number - format: double - GoogleApiDistributionBucketOptionsExponential: - id: GoogleApiDistributionBucketOptionsExponential - description: >- - Specifies an exponential sequence of buckets that have a width that is - proportional to the value of the lower bound. Each bucket represents a - constant relative uncertainty on a specific value in the bucket. There - are `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the following - boundaries: Upper bound (0 <= i < N-1): scale * (growth_factor ^ i). - Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)). + key: + description: >- + Optional. Unique destination identifier that is supported by the + connector. + type: string + destinations: + description: Optional. The destinations for the corresponding key. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaDestinationConfigDestination + params: + description: Optional. Additional parameters for this destination config. + type: object + additionalProperties: + type: any + description: Properties of the object. + GoogleCloudDiscoveryengineV1alphaDestinationConfigDestination: + id: GoogleCloudDiscoveryengineV1alphaDestinationConfigDestination + description: Defines a target endpoint type: object properties: - numFiniteBuckets: - description: Must be greater than 0. + host: + description: Publicly routable host. + type: string + port: + description: Optional. Target port number accepted by the destination. type: integer format: int32 - growthFactor: - description: Must be greater than 1. - type: number - format: double - scale: - description: Must be greater than 0. - type: number - format: double - GoogleApiDistributionBucketOptionsExplicit: - id: GoogleApiDistributionBucketOptionsExplicit - description: >- - Specifies a set of buckets with arbitrary widths. There are - `size(bounds) + 1` (= N) buckets. Bucket `i` has the following - boundaries: Upper bound (0 <= i < N-1): bounds[i] Lower bound (1 <= i < - N); bounds[i - 1] The `bounds` field must contain at least one element. - If `bounds` has only one element, then there are no finite buckets, and - that single element is the common boundary of the overflow and underflow - buckets. + GoogleCloudDiscoveryengineV1alphaActionConfig: + id: GoogleCloudDiscoveryengineV1alphaActionConfig + description: Informations to support actions on the connector. type: object properties: - bounds: - description: The values must be monotonically increasing. - type: array - items: - type: number - format: double - GoogleApiDistributionExemplar: - id: GoogleApiDistributionExemplar + isActionConfigured: + description: >- + Output only. The connector contains the necessary parameters and is + configured to support actions. + readOnly: true + type: boolean + actionParams: + description: >- + Required. Params needed to support actions in the format of (Key, + Value) pairs. Required parameters for sources that support OAUTH, + i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, + `confluence`: * Key: `client_id` * Value: type STRING. The client ID + for the service provider to identify your application. * Key: + `client_secret` * Value:type STRING. The client secret generated by + the application's authorization server. + type: object + additionalProperties: + type: any + description: Properties of the object. + serviceName: + description: >- + Optional. The Service Directory resource name + (projects/*/locations/*/namespaces/*/services/*) representing a VPC + network endpoint used to connect to the data source's + `instance_uri`, defined in DataConnector.params. Required when VPC + Service Controls are enabled. + type: string + useStaticSecrets: + description: >- + Optional. Whether to use static secrets for the connector. If true, + the secrets provided in the action_params will be ignored. + type: boolean + GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig: + id: GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig + description: Any params and credentials used specifically for EUA connectors. + type: object + properties: + authParams: + description: Optional. Any authentication parameters specific to EUA connectors. + type: object + additionalProperties: + type: any + description: Properties of the object. + additionalParams: + description: Optional. Any additional parameters needed for EUA. + type: object + additionalProperties: + type: any + description: Properties of the object. + tenant: + description: Optional. The tenant project the connector is connected to. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaTenant' + GoogleCloudDiscoveryengineV1alphaTenant: + id: GoogleCloudDiscoveryengineV1alphaTenant description: >- - Exemplars are example points that may be used to annotate aggregated - distribution values. They are metadata that gives information about a - particular value added to a Distribution bucket, such as a trace ID that - was active when a value was added. They may contain further information, - such as a example values and timestamps, origin, etc. + Tenant information for a connector source. This includes some of the + same information stored in the Credential message, but is limited to + only what is needed to provide a list of accessible tenants to the user. type: object properties: - value: + id: description: >- - Value of the exemplar point. This value determines to which bucket - the exemplar belongs. - type: number - format: double - timestamp: - description: The observation (sampling) time of the above value. + The tenant's instance ID. Examples: Jira + ("8594f221-9797-5f78-1fa4-485e198d7cd0"), Slack ("T123456"). type: string - format: google-datetime - attachments: + uri: description: >- - Contextual information about the example value. Examples are: Trace: - type.googleapis.com/google.monitoring.v3.SpanContext Literal string: - type.googleapis.com/google.protobuf.StringValue Labels dropped - during aggregation: - type.googleapis.com/google.monitoring.v3.DroppedLabels There may be - only a single attachment of any given message type in a single - exemplar, and this is enforced by the system. + The URI of the tenant, if applicable. For example, the URI of a Jira + instance is https://my-jira-instance.atlassian.net, and a Slack + tenant does not have a URI. + type: string + displayName: + description: Optional display name for the tenant, e.g. "My Slack Team". + type: string + GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig: + id: GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig + description: The configuration for the identity data synchronization runs. + type: object + properties: + refreshInterval: + description: >- + Optional. The refresh interval to sync the Access Control List + information for the documents ingested by this connector. If not + set, the access control list will be refreshed at the default + interval of 30 minutes. The identity refresh interval can be at + least 30 minutes and at most 7 days. + type: string + format: google-duration + nextSyncTime: + description: >- + Optional. The UTC time when the next data sync is expected to start + for the Data Connector. Customers are only able to specify the hour + and minute to schedule the data sync. This is utilized when the data + connector has a refresh interval greater than 1 day. + $ref: '#/components/schemas/GoogleTypeDateTime' + GoogleCloudDiscoveryengineV1alphaBAPConfig: + id: GoogleCloudDiscoveryengineV1alphaBAPConfig + description: The configuration for the BAP connector. + type: object + properties: + supportedConnectorModes: + description: >- + Required. The supported connector modes for the associated BAP + connection. type: array items: - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries: - id: GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries + type: string + enumDescriptions: + - Connector mode unspecified. + - Connector utilized for data ingestion. + - Connector utilized for Actions + - Connector utilized for End User Authentication. + enum: + - CONNECTOR_MODE_UNSPECIFIED + - DATA_INGESTION + - ACTIONS + - END_USER_AUTHENTICATION + GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig: + id: GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig + description: The connector level alert config. + type: object + properties: + alertPolicyName: + description: Immutable. The fully qualified resource name of the AlertPolicy. + type: string + alertEnrollments: + description: Optional. The enrollment states of each alert. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment + GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment: + id: GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment + description: The alert enrollment status. + type: object + properties: + alertId: + description: Immutable. The id of an alert. + type: string + enrollState: + description: Required. The enrollment status of a customer. + type: string + enumDescriptions: + - >- + Default value. Used for customers who have not responded to the + alert policy. + - Customer is enrolled in this policy. + - Customer declined this policy. + enum: + - ENROLL_STATES_UNSPECIFIED + - ENROLLED + - DECLINED + GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig: + id: GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig description: >- - The historical dedicated crawl rate timeseries data, used for - monitoring. Dedicated crawl is used by Vertex AI to crawl the user's - website when dedicate crawl is set. + The configuration for realtime sync to store additional params for + realtime sync. type: object properties: - userTriggeredCrawlRate: + webhookUri: description: >- - Vertex AI's dedicated crawl rate time series of user triggered - crawl, which is the crawl rate of Google-CloudVertexBot when - dedicate crawl is set, and user triggered crawl rate is for - deterministic use cases like crawling urls or sitemaps specified by - users. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries - autoRefreshCrawlRate: + Optional. Webhook url for the connector to specify additional params + for realtime sync. + type: string + realtimeSyncSecret: description: >- - Vertex AI's dedicated crawl rate time series of auto-refresh, which - is the crawl rate of Google-CloudVertexBot when dedicate crawl is - set, and the crawl rate is for best effort use cases like refreshing - urls periodically. + Optional. The ID of the Secret Manager secret used for webhook + secret. + type: string + streamingError: + description: Optional. Streaming error details. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries - GoogleCloudDiscoveryengineV1alphaProject: - id: GoogleCloudDiscoveryengineV1alphaProject - description: Metadata and configurations for a Google Cloud project in the service. + #/components/schemas/GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfigStreamingError + GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfigStreamingError: + id: >- + GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfigStreamingError + description: Streaming error details. + type: object + properties: + streamingErrorReason: + description: Optional. Streaming error. + type: string + enumDescriptions: + - Streaming error reason unspecified. + - Some error occurred while setting up resources for realtime sync. + - >- + Some error was encountered while running realtime sync for the + connector. + - >- + Ingress endpoint is required when setting up realtime sync in + private connectivity. + enum: + - STREAMING_ERROR_REASON_UNSPECIFIED + - STREAMING_SETUP_ERROR + - STREAMING_SYNC_ERROR + - INGRESS_ENDPOINT_REQUIRED + error: + description: Optional. Error details. + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudDiscoveryengineV1alphaConnectorRun: + id: GoogleCloudDiscoveryengineV1alphaConnectorRun + description: >- + A data sync run of DataConnector. After DataConnector is successfully + initialized, data syncs are scheduled at DataConnector.refresh_interval. + A ConnectorRun represents a data sync either in the past or onging that + the moment. // type: object properties: name: description: >- - Output only. Full resource name of the project, for example - `projects/{project}`. Note that when making requests, project number - and project id are both acceptable, but the server will always - respond in project number. + Output only. The full resource name of the Connector Run. Format: + `projects/*/locations/*/collections/*/dataConnector/connectorRuns/*`. + The `connector_run_id` is system-generated. readOnly: true type: string - createTime: - description: Output only. The timestamp when this project is created. + startTime: + description: Output only. The time when the connector run started. readOnly: true type: string format: google-datetime - provisionCompletionTime: - description: >- - Output only. The timestamp when this project is successfully - provisioned. Empty value means this project is still provisioning - and is not ready for use. + endTime: + description: Output only. The time when the connector run ended. readOnly: true type: string format: google-datetime - serviceTermsMap: - description: >- - Output only. A map of terms of services. The key is the `id` of - ServiceTerms. - readOnly: true - type: object - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaProjectServiceTerms - GoogleCloudDiscoveryengineV1alphaProjectServiceTerms: - id: GoogleCloudDiscoveryengineV1alphaProjectServiceTerms - description: Metadata about the terms of service. - type: object - properties: - id: - description: >- - The unique identifier of this terms of service. Available terms: * - `GA_DATA_USE_TERMS`: [Terms for data - use](https://cloud.google.com/retail/data-use-terms). When using - this as `id`, the acceptable version to provide is `2022-11-23`. - type: string - version: - description: >- - The version string of the terms of service. For acceptable values, - see the comments for id above. - type: string state: - description: >- - Whether the project has accepted/rejected the service terms or it is - still pending. + description: Output only. The state of the sync run. + readOnly: true type: string enumDescriptions: - - The default value of the enum. This value is not actually used. - - The project has given consent to the terms of service. - - The project is pending to review and accept the terms of service. + - Default value. + - The data sync is ongoing. + - The data sync is finished. + - The data sync is failed. - >- - The project has declined or revoked the agreement to terms of - service. + Data sync has been running longer than expected and is still + running at the time the next run is supposed to start. + - Data sync was scheduled but has been cancelled. + - Data sync is about to start. + - The data sync completed with non-fatal errors. + - >- + An ongoing connector run has been running longer than expected, + causing this run to be skipped. enum: - STATE_UNSPECIFIED - - TERMS_ACCEPTED - - TERMS_PENDING - - TERMS_DECLINED - acceptTime: - description: The last time when the project agreed to the terms of service. - type: string - format: google-datetime - declineTime: + - RUNNING + - SUCCEEDED + - FAILED + - OVERRUN + - CANCELLED + - PENDING + - WARNING + - SKIPPED + errors: description: >- - The last time when the project declined or revoked the agreement to - terms of service. + Contains info about errors incurred during the sync. Only exist if + running into an error state. Contains error code and error message. + Use with the `state` field. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + stateUpdateTime: + description: Timestamp at which the connector run sync state was last updated. type: string format: google-datetime - GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata: - id: GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata - description: Metadata associated with a project provision operation. - type: object - properties: {} - GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsMetadata: - id: GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsMetadata - description: >- - Metadata related to the progress of the PurgeCompletionSuggestions - operation. This is returned by the google.longrunning.Operation.metadata - field. - type: object - properties: - createTime: - description: Operation create time. + latestPauseTime: + description: >- + Output only. The time when the connector run was most recently + paused. + readOnly: true type: string format: google-datetime - updateTime: + entityRuns: description: >- - Operation last update time. If the operation is done, this is also - the finish time. + Output only. The details of the entities synced at the ConnectorRun. + Each ConnectorRun consists of syncing one or more entities. + readOnly: true + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun + trigger: + description: Output only. The trigger for this ConnectorRun. + readOnly: true type: string - format: google-datetime - GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse: - id: GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse - description: >- - Response message for CompletionService.PurgeCompletionSuggestions - method. + enumDescriptions: + - Default value. + - >- + ConnectorRun triggered by scheduler if connector has PERIODIC sync + mode. + - ConnectorRun auto triggered by connector initialization. + - ConnectorRun auto triggered by resuming connector. + - ConnectorRun triggered by user manually. + enum: + - TRIGGER_UNSPECIFIED + - SCHEDULER + - INITIALIZATION + - RESUME + - MANUAL + GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun: + id: GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun + description: Represents an entity that was synced in this ConnectorRun. type: object properties: - purgeSucceeded: - description: Whether the completion suggestions were successfully purged. - type: boolean - errorSamples: - description: A sample of errors encountered while processing the request. + entityName: + description: The name of the source entity. + type: string + state: + description: The state of the entity's sync run. + type: string + enumDescriptions: + - Default value. + - The data sync is ongoing. + - The data sync is finished. + - The data sync is failed. + - >- + Data sync has been running longer than expected and is still + running at the time the next run is supposed to start. + - Data sync was scheduled but has been cancelled. + - Data sync is about to start. + - The data sync completed with non-fatal errors. + - >- + An ongoing connector run has been running longer than expected, + causing this run to be skipped. + enum: + - STATE_UNSPECIFIED + - RUNNING + - SUCCEEDED + - FAILED + - OVERRUN + - CANCELLED + - PENDING + - WARNING + - SKIPPED + errors: + description: >- + The errors from the entity's sync run. Only exist if running into an + error state. Contains error code and error message. type: array items: $ref: '#/components/schemas/GoogleRpcStatus' - GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata: - id: GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata - description: >- - Metadata related to the progress of the PurgeDocuments operation. This - will be returned by the google.longrunning.Operation.metadata field. - type: object - properties: - createTime: - description: Operation create time. + stateUpdateTime: + description: Timestamp at which the entity sync state was last updated. type: string format: google-datetime - updateTime: + scheduledRecordCount: description: >- - Operation last update time. If the operation is done, this is also - the finish time. + Optional. The number of documents scheduled to be crawled/extracted + from connector source. This only applies to third party connectors. type: string - format: google-datetime - successCount: - description: Count of entries that were deleted successfully. + format: int64 + extractedRecordCount: + description: >- + Optional. The number of documents extracted from connector source, + ready to be ingested to VAIS. type: string format: int64 - failureCount: - description: Count of entries that encountered errors while processing. + indexedRecordCount: + description: Optional. The number of documents indexed. type: string format: int64 - ignoredCount: - description: Count of entries that were ignored as entries were not found. + errorRecordCount: + description: >- + Optional. The total number of documents failed at sync at indexing + stage. type: string format: int64 - GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse: - id: GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse - description: >- - Response message for DocumentService.PurgeDocuments method. If the long - running operation is successfully done, then this message is returned by - the google.longrunning.Operations.response field. - type: object - properties: - purgeCount: - description: The total count of documents purged as a result of the operation. + sourceApiRequestCount: + description: Optional. The number of requests sent to 3p API. type: string format: int64 - purgeSample: - description: >- - A sample of document names that will be deleted. Only populated if - `force` is set to false. A max of 100 names will be returned and the - names are chosen at random. - type: array - items: - type: string - GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata: - id: GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata - description: >- - Metadata related to the progress of the PurgeSuggestionDenyListEntries - operation. This is returned by the google.longrunning.Operation.metadata - field. - type: object - properties: - createTime: - description: Operation create time. + deletedRecordCount: + description: Optional. The number of documents deleted. type: string - format: google-datetime - updateTime: + format: int64 + progress: + description: Metadata to generate the progress bar. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress + statsUpdateTime: description: >- - Operation last update time. If the operation is done, this is also - the finish time. + The timestamp for either extracted_documents_count, + indexed_documents_count and error_documents_count was last updated. type: string format: google-datetime - GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse: - id: GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse - description: >- - Response message for CompletionService.PurgeSuggestionDenyListEntries - method. - type: object - properties: - purgeCount: - description: Number of suggestion deny list entries purged. + syncType: + description: Sync type of this run. type: string - format: int64 - errorSamples: - description: A sample of errors encountered while processing the request. - type: array - items: - $ref: '#/components/schemas/GoogleRpcStatus' - GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata: - id: GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata - description: >- - Metadata related to the progress of the PurgeUserEvents operation. This - will be returned by the google.longrunning.Operation.metadata field. + enumDescriptions: + - Sync type unspecified. + - Sync triggers full sync of all documents. + - Incremental sync of updated documents. + - Realtime sync. + - Scala sync. + enum: + - SYNC_TYPE_UNSPECIFIED + - FULL + - INCREMENTAL + - REALTIME + - SCALA_SYNC + GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress: + id: GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress + description: Represents the progress of a sync run. type: object properties: - createTime: - description: Operation create time. - type: string - format: google-datetime - updateTime: - description: >- - Operation last update time. If the operation is done, this is also - the finish time. - type: string - format: google-datetime - successCount: - description: Count of entries that were deleted successfully. - type: string - format: int64 - failureCount: - description: Count of entries that encountered errors while processing. + currentCount: + description: The current progress. type: string format: int64 - GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse: - id: GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse - description: >- - Response of the PurgeUserEventsRequest. If the long running operation is - successfully done, then this message is returned by the - google.longrunning.Operations.response field. - type: object - properties: - purgeCount: - description: The total count of events purged as a result of the operation. + totalCount: + description: The total. type: string format: int64 - GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata: - id: GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata + percentile: + description: >- + Derived. The percentile of the progress.current_count / total_count. + The value is between [0, 1.0] inclusive. + type: number + format: float + GoogleCloudDiscoveryengineV1alphaControl: + id: GoogleCloudDiscoveryengineV1alphaControl description: >- - Metadata related to the progress of the - SiteSearchEngineService.RecrawlUris operation. This will be returned by - the google.longrunning.Operation.metadata field. + Defines a conditioned behavior to employ during serving. Must be + attached to a ServingConfig to be considered at serving time. Permitted + actions dependent on `SolutionType`. type: object properties: - createTime: - description: Operation create time. - type: string - format: google-datetime - updateTime: + boostAction: + description: Defines a boost-type control + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaControlBoostAction + filterAction: description: >- - Operation last update time. If the operation is done, this is also - the finish time. - type: string - format: google-datetime - invalidUris: + Defines a filter-type control Currently not supported by + Recommendation + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaControlFilterAction + redirectAction: + description: Defines a redirect-type control. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaControlRedirectAction + synonymsAction: + description: Treats a group of terms as synonyms of one another. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaControlSynonymsAction + promoteAction: + description: Promote certain links based on predefined trigger queries. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaControlPromoteAction + name: description: >- - Unique URIs in the request that have invalid format. Sample limited - to 1000. - type: array - items: - type: string - invalidUrisCount: - description: Total number of unique URIs in the request that have invalid format. - type: integer - format: int32 - urisNotMatchingTargetSites: + Immutable. Fully qualified name + `projects/*/locations/global/dataStore/*/controls/*` + type: string + displayName: description: >- - Unique URIs in the request that don't match any TargetSite in the - DataStore, only match TargetSites that haven't been fully indexed, - or match a TargetSite with type EXCLUDE. Sample limited to 1000. + Required. Human readable name. The identifier used in UI views. Must + be UTF-8 encoded string. Length limit is 128 characters. Otherwise + an INVALID ARGUMENT error is thrown. + type: string + associatedServingConfigIds: + description: >- + Output only. List of all ServingConfig IDs this control is attached + to. May take up to 10 minutes to update after changes. + readOnly: true type: array items: type: string - urisNotMatchingTargetSitesCount: - description: Total number of URIs that don't match any TargetSites. - type: integer - format: int32 - validUrisCount: + solutionType: description: >- - Total number of unique URIs in the request that are not in - invalid_uris. - type: integer - format: int32 - successCount: - description: Total number of URIs that have been crawled so far. - type: integer - format: int32 - pendingCount: - description: Total number of URIs that have yet to be crawled. - type: integer - format: int32 - quotaExceededCount: + Required. Immutable. What solution the control belongs to. Must be + compatible with vertical of resource. Otherwise an INVALID ARGUMENT + error is thrown. + type: string + enumDescriptions: + - Default value. + - Used for Recommendations AI. + - Used for Discovery Search. + - Used for use cases related to the Generative AI agent. + - >- + Used for use cases related to the Generative Chat agent. It's used + for Generative chat engine only, the associated data stores must + enrolled with `SOLUTION_TYPE_CHAT` solution. + enum: + - SOLUTION_TYPE_UNSPECIFIED + - SOLUTION_TYPE_RECOMMENDATION + - SOLUTION_TYPE_SEARCH + - SOLUTION_TYPE_CHAT + - SOLUTION_TYPE_GENERATIVE_CHAT + useCases: description: >- - Total number of URIs that were rejected due to insufficient indexing - resources. - type: integer - format: int32 - GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse: - id: GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse - description: Response message for SiteSearchEngineService.RecrawlUris method. - type: object - properties: - failureSamples: - description: Details for a sample of up to 10 `failed_uris`. + Specifies the use case for the control. Affects what condition + fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently + only allow one use case per control. Must be set when solution_type + is SolutionType.SOLUTION_TYPE_SEARCH. type: array items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo - failedUris: - description: URIs that were not crawled before the LRO terminated. + type: string + enumDescriptions: + - Value used when unset. Will not occur in CSS. + - Search use case. Expects the traffic has a non-empty query. + - Browse use case. Expects the traffic has an empty query. + enum: + - SEARCH_USE_CASE_UNSPECIFIED + - SEARCH_USE_CASE_SEARCH + - SEARCH_USE_CASE_BROWSE + conditions: + description: >- + Determines when the associated action will trigger. Omit to always + apply the action. Currently only a single condition may be + specified. Otherwise an INVALID ARGUMENT error is thrown. type: array items: - type: string - GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo: - id: GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo - description: >- - Details about why a particular URI failed to be crawled. Each - FailureInfo contains one FailureReason per CorpusType. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaCondition' + GoogleCloudDiscoveryengineV1alphaControlBoostAction: + id: GoogleCloudDiscoveryengineV1alphaControlBoostAction + description: Adjusts order of products in returned list. type: object properties: - uri: - description: URI that failed to be crawled. + fixedBoost: + description: >- + Optional. Strength of the boost, which should be in [-1, 1]. + Negative boost means demotion. Default is 0.0 (No-op). + type: number + format: float + interpolationBoostSpec: + description: >- + Optional. Complex specification for custom ranking based on customer + defined attribute value. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec + boost: + description: >- + Strength of the boost, which should be in [-1, 1]. Negative boost + means demotion. Default is 0.0 (No-op). + deprecated: true + type: number + format: float + filter: + description: >- + Required. Specifies which products to apply the boost to. If no + filter is provided all products will be boosted (No-op). Syntax + documentation: https://cloud.google.com/retail/docs/filter-and-order + Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT + error is thrown. type: string - failureReasons: - description: List of failure reasons by corpus type (e.g. desktop, mobile). - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason - GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason: + dataStore: + description: >- + Required. Specifies which data store's documents can be boosted by + this control. Full data store name e.g. + projects/123/locations/global/collections/default_collection/dataStores/default_data_store + type: string + GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec: id: >- - GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason + GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec description: >- - Details about why crawling failed for a particular CorpusType, e.g., - DESKTOP and MOBILE crawling may fail for different reasons. + Specification for custom ranking based on customer specified attribute + value. It provides more controls for customized ranking than the simple + (condition, boost) combination above. type: object properties: - corpusType: - description: DESKTOP, MOBILE, or CORPUS_TYPE_UNSPECIFIED. + fieldName: + description: >- + Optional. The name of the field whose value will be used to + determine the boost amount. + type: string + attributeType: + description: >- + Optional. The attribute type to be used to determine the boost + amount. The attribute value can be derived from the field value of + the specified field_name. In the case of numerical it is + straightforward i.e. attribute_value = numerical_field_value. In the + case of freshness however, attribute_value = (time.now() - + datetime_field_value). type: string enumDescriptions: - - Default value. - - Denotes a crawling attempt for the desktop version of a page. - - Denotes a crawling attempt for the mobile version of a page. + - Unspecified AttributeType. + - >- + The value of the numerical field will be used to dynamically + update the boost amount. In this case, the attribute_value (the x + value) of the control point will be the actual value of the + numerical field for which the boost_amount is specified. + - >- + For the freshness use case the attribute value will be the + duration between the current time and the date in the datetime + field specified. The value must be formatted as an XSD + `dayTimeDuration` value (a restricted subset of an ISO 8601 + duration value). The pattern for this is: `nDnM]`. For example, + `5D`, `3DT12H30M`, `T24H`. enum: - - CORPUS_TYPE_UNSPECIFIED - - DESKTOP - - MOBILE - errorMessage: - description: Reason why the URI was not crawled. - type: string - GoogleCloudDiscoveryengineV1alphaSession: - id: GoogleCloudDiscoveryengineV1alphaSession - description: External session proto definition. - type: object - properties: - name: + - ATTRIBUTE_TYPE_UNSPECIFIED + - NUMERICAL + - FRESHNESS + interpolationType: description: >- - Immutable. Fully qualified name - `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` - type: string - state: - description: The state of the session. + Optional. The interpolation type to be applied to connect the + control points listed below. type: string enumDescriptions: - - State is unspecified. - - The session is currently open. + - >- + Interpolation type is unspecified. In this case, it defaults to + Linear. + - Piecewise linear interpolation will be applied. enum: - - STATE_UNSPECIFIED - - IN_PROGRESS - userPseudoId: - description: A unique identifier for tracking users. - type: string - turns: - description: Turns. + - INTERPOLATION_TYPE_UNSPECIFIED + - LINEAR + controlPoints: + description: >- + Optional. The control points used to define the curve. The monotonic + function (defined through the interpolation_type above) passes + through the control points listed here. type: array items: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaSessionTurn' - startTime: - description: Output only. The time the session started. - readOnly: true - type: string - format: google-datetime - endTime: - description: Output only. The time the session finished. - readOnly: true - type: string - format: google-datetime - GoogleCloudDiscoveryengineV1alphaSessionTurn: - id: GoogleCloudDiscoveryengineV1alphaSessionTurn + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint + GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint: + id: >- + GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint description: >- - Represents a turn, including a query from the user and a answer from - service. + The control points used to define the curve. The curve defined through + these control points can only be monotonically increasing or + decreasing(constant values are acceptable). type: object properties: - query: - description: The user query. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaQuery' - answer: + attributeValue: description: >- - The resource name of the answer to the user query. Only set if the - answer generation (/answer API call) happened in this turn. - type: string - GoogleCloudDiscoveryengineV1alphaQuery: - id: GoogleCloudDiscoveryengineV1alphaQuery - description: Defines a user inputed query. - type: object - properties: - text: - description: Plain text. - type: string - queryId: - description: Unique Id for the query. + Optional. Can be one of: 1. The numerical field value. 2. The + duration spec for freshness: The value must be formatted as an XSD + `dayTimeDuration` value (a restricted subset of an ISO 8601 duration + value). The pattern for this is: `nDnM]`. type: string - GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata: - id: GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata + boostAmount: + description: >- + Optional. The value between -1 to 1 by which to boost the score if + the attribute_value evaluates to the value specified above. + type: number + format: float + GoogleCloudDiscoveryengineV1alphaControlFilterAction: + id: GoogleCloudDiscoveryengineV1alphaControlFilterAction description: >- - Metadata related to the progress of the - SiteSearchEngineService.SetUriPatternDocumentData operation. This will - be returned by the google.longrunning.Operation.metadata field. + Specified which products may be included in results. Uses same filter as + boost. type: object properties: - createTime: - description: Operation create time. + filter: + description: >- + Required. A filter to apply on the matching condition results. + Required Syntax documentation: + https://cloud.google.com/retail/docs/filter-and-order Maximum length + is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. type: string - format: google-datetime - updateTime: + dataStore: description: >- - Operation last update time. If the operation is done, this is also - the finish time. + Required. Specifies which data store's documents can be filtered by + this control. Full data store name e.g. + projects/123/locations/global/collections/default_collection/dataStores/default_data_store type: string - format: google-datetime - GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse: - id: GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse + GoogleCloudDiscoveryengineV1alphaControlRedirectAction: + id: GoogleCloudDiscoveryengineV1alphaControlRedirectAction + description: Redirects a shopper to the provided URI. + type: object + properties: + redirectUri: + description: >- + Required. The URI to which the shopper will be redirected. Required. + URI must have length equal or less than 2000 characters. Otherwise + an INVALID ARGUMENT error is thrown. + type: string + GoogleCloudDiscoveryengineV1alphaControlSynonymsAction: + id: GoogleCloudDiscoveryengineV1alphaControlSynonymsAction description: >- - Response message for SiteSearchEngineService.SetUriPatternDocumentData - method. + Creates a set of terms that will act as synonyms of one another. + Example: "happy" will also be considered as "glad", "glad" will also be + considered as "happy". type: object - properties: {} - GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata: - id: GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata + properties: + synonyms: + description: >- + Defines a set of synonyms. Can specify up to 100 synonyms. Must + specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is + thrown. + type: array + items: + type: string + GoogleCloudDiscoveryengineV1alphaControlPromoteAction: + id: GoogleCloudDiscoveryengineV1alphaControlPromoteAction description: >- - Metadata related to the progress of the TrainCustomModel operation. This - is returned by the google.longrunning.Operation.metadata field. + Promote certain links based on some trigger queries. Example: Promote + shoe store link when searching for `shoe` keyword. The link can be + outside of associated data store. type: object properties: - createTime: - description: Operation create time. + dataStore: + description: Required. Data store with which this promotion is attached to. type: string - format: google-datetime - updateTime: + searchLinkPromotion: + description: Required. Promotion attached to this action. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion + GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion: + id: GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion + description: >- + Promotion proto includes uri and other helping information to display + the promotion. + type: object + properties: + title: description: >- - Operation last update time. If the operation is done, this is also - the finish time. + Required. The title of the promotion. Maximum length: 160 + characters. type: string - format: google-datetime - GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse: - id: GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse - description: >- - Response of the TrainCustomModelRequest. This message is returned by the - google.longrunning.Operations.response field. + uri: + description: >- + Optional. The URL for the page the user wants to promote. Must be + set for site search. For other verticals, this is optional. + type: string + document: + description: >- + Optional. The Document the user wants to promote. For site search, + leave unset and only populate uri. Can be set along with uri. + type: string + imageUri: + description: Optional. The promotion thumbnail image url. + type: string + description: + description: 'Optional. The Promotion description. Maximum length: 200 characters.' + type: string + enabled: + description: >- + Optional. The enabled promotion will be returned for any serving + configs associated with the parent of the control this promotion is + attached to. This flag is used for basic site search only. + type: boolean + GoogleCloudDiscoveryengineV1alphaCondition: + id: GoogleCloudDiscoveryengineV1alphaCondition + description: Defines circumstances to be checked before allowing a behavior type: object properties: - errorSamples: - description: A sample of errors encountered while processing the data. + queryTerms: + description: >- + Search only A list of terms to match the query on. Cannot be set + when Condition.query_regex is set. Maximum of 10 query terms. type: array items: - $ref: '#/components/schemas/GoogleRpcStatus' - errorConfig: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaConditionQueryTerm + activeTimeRange: description: >- - Echoes the destination for the complete errors in the request if - set. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaImportErrorConfig - modelStatus: + Range of time(s) specifying when condition is active. Maximum of 10 + time ranges. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaConditionTimeRange + queryRegex: description: >- - The trained model status. Possible values are: * **bad-data**: The - training data quality is bad. * **no-improvement**: Tuning didn't - improve performance. Won't deploy. * **in-progress**: Model training - job creation is in progress. * **training**: Model is actively - training. * **evaluating**: The model is evaluating trained metrics. - * **indexing**: The model trained metrics are indexing. * **ready**: - The model is ready for serving. - type: string - metrics: - description: The metrics of the trained model. - type: object - additionalProperties: - type: number - format: double - modelName: - description: Fully qualified name of the CustomTuningModel. + Optional. Query regex to match the whole search query. Cannot be set + when Condition.query_terms is set. Only supported for Basic Site + Search promotion serving controls. type: string - GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata: - id: GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata - description: Metadata associated with a tune operation. + GoogleCloudDiscoveryengineV1alphaConditionQueryTerm: + id: GoogleCloudDiscoveryengineV1alphaConditionQueryTerm + description: Matcher for search request query type: object properties: - engine: + value: description: >- - Required. The resource name of the engine that this tune applies to. - Format: - `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}` + The specific query value to match against Must be lowercase, must be + UTF-8. Can have at most 3 space separated terms if full_match is + true. Cannot be an empty string. Maximum length of 5000 characters. type: string - GoogleCloudDiscoveryengineV1alphaTuneEngineResponse: - id: GoogleCloudDiscoveryengineV1alphaTuneEngineResponse - description: Response associated with a tune operation. + fullMatch: + description: Whether the search query needs to exactly match the query term. + type: boolean + GoogleCloudDiscoveryengineV1alphaConditionTimeRange: + id: GoogleCloudDiscoveryengineV1alphaConditionTimeRange + description: Used for time-dependent conditions. type: object - properties: {} - GoogleCloudDiscoveryengineV1alphaUpdateCmekConfigMetadata: - id: GoogleCloudDiscoveryengineV1alphaUpdateCmekConfigMetadata + properties: + startTime: + description: Start of time range. Range is inclusive. + type: string + format: google-datetime + endTime: + description: End of time range. Range is inclusive. Must be in the future. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata: + id: GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata description: >- - Metadata related to the progress of the - CmekConfigService.UpdateCmekConfig operation. This will be returned by - the google.longrunning.Operation.metadata field. + Metadata related to the progress of the DataStoreService.CreateDataStore + operation. This will be returned by the + google.longrunning.Operation.metadata field. type: object properties: createTime: @@ -11785,9 +13046,12 @@ components: the finish time. type: string format: google-datetime - GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata: - id: GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata - description: Metadata for UpdateSchema LRO. + GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata: + id: GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata + description: >- + Metadata related to the progress of the EngineService.CreateEngine + operation. This will be returned by the + google.longrunning.Operation.metadata field. type: object properties: createTime: @@ -11800,12 +13064,14 @@ components: the finish time. type: string format: google-datetime - GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata: - id: GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata - description: >- - Metadata related to the progress of the - SiteSearchEngineService.UpdateTargetSite operation. This will be - returned by the google.longrunning.Operation.metadata field. + GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata: + id: GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata + description: Metadata for EvaluationService.CreateEvaluation method. + type: object + properties: {} + GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata: + id: GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata + description: Metadata for Create Schema LRO. type: object properties: createTime: @@ -11818,12 +13084,12 @@ components: the finish time. type: string format: google-datetime - GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata: - id: GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata + GoogleCloudDiscoveryengineV1alphaCreateSitemapMetadata: + id: GoogleCloudDiscoveryengineV1alphaCreateSitemapMetadata description: >- Metadata related to the progress of the - SiteSearchEngineService.BatchCreateTargetSites operation. This will be - returned by the google.longrunning.Operation.metadata field. + SiteSearchEngineService.CreateSitemap operation. This will be returned + by the google.longrunning.Operation.metadata field. type: object properties: createTime: @@ -11836,395 +13102,505 @@ components: the finish time. type: string format: google-datetime - GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse: - id: GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse + GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata: + id: GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata description: >- - Response message for SiteSearchEngineService.BatchCreateTargetSites - method. + Metadata related to the progress of the + SiteSearchEngineService.CreateTargetSite operation. This will be + returned by the google.longrunning.Operation.metadata field. type: object properties: - targetSites: - description: TargetSites created. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1betaTargetSite' - GoogleCloudDiscoveryengineV1betaTargetSite: - id: GoogleCloudDiscoveryengineV1betaTargetSite - description: A target site for the SiteSearchEngine. + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1alphaDataStore: + id: GoogleCloudDiscoveryengineV1alphaDataStore + description: DataStore captures global settings and configs at the DataStore level. type: object properties: name: description: >- - Output only. The fully qualified resource name of the target site. - `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` - The `target_site_id` is system-generated. - readOnly: true + Immutable. Identifier. The full resource name of the data store. + Format: + `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. + This field must be a UTF-8 encoded string with a length limit of + 1024 characters. type: string - providedUriPattern: + displayName: description: >- - Required. Input only. The user provided URI pattern from which the - `generated_uri_pattern` is generated. + Required. The data store display name. This field must be a UTF-8 + encoded string with a length limit of 128 characters. Otherwise, an + INVALID_ARGUMENT error is returned. type: string - type: - description: >- - The type of the target site, e.g., whether the site is to be - included or excluded. + industryVertical: + description: Immutable. The industry vertical that the data store registers. type: string enumDescriptions: + - Value used when unset. - >- - This value is unused. In this case, server behavior defaults to - Type.INCLUDE. - - Include the target site. - - Exclude the target site. - enum: - - TYPE_UNSPECIFIED - - INCLUDE - - EXCLUDE - exactMatch: + The generic vertical for documents that are not specific to any + industry vertical. + - The media industry vertical. + - The healthcare FHIR vertical. + enum: + - INDUSTRY_VERTICAL_UNSPECIFIED + - GENERIC + - MEDIA + - HEALTHCARE_FHIR + solutionTypes: description: >- - Input only. If set to false, a uri_pattern is generated to include - all pages whose address contains the provided_uri_pattern. If set to - true, an uri_pattern is generated to try to be an exact match of the - provided_uri_pattern or just the specific page if the - provided_uri_pattern is a specific one. provided_uri_pattern is - always normalized to generate the URI pattern to be used by the - search engine. - type: boolean - generatedUriPattern: + The solutions that the data store enrolls. Available solutions for + each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` + and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` + is automatically enrolled. Other solutions cannot be enrolled. + type: array + items: + type: string + enumDescriptions: + - Default value. + - Used for Recommendations AI. + - Used for Discovery Search. + - Used for use cases related to the Generative AI agent. + - >- + Used for use cases related to the Generative Chat agent. It's + used for Generative chat engine only, the associated data stores + must enrolled with `SOLUTION_TYPE_CHAT` solution. + enum: + - SOLUTION_TYPE_UNSPECIFIED + - SOLUTION_TYPE_RECOMMENDATION + - SOLUTION_TYPE_SEARCH + - SOLUTION_TYPE_CHAT + - SOLUTION_TYPE_GENERATIVE_CHAT + defaultSchemaId: description: >- - Output only. This is system-generated based on the - provided_uri_pattern. - readOnly: true - type: string - rootDomainUri: - description: Output only. Root domain of the provided_uri_pattern. + Output only. The id of the default Schema associated to this data + store. readOnly: true type: string - siteVerificationInfo: - description: Output only. Site ownership and validity verification status. - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaSiteVerificationInfo - indexingStatus: - description: Output only. Indexing status. - readOnly: true + contentConfig: + description: >- + Immutable. The content config of the data store. If this field is + unset, the server behavior defaults to ContentConfig.NO_CONTENT. type: string enumDescriptions: - - Defaults to SUCCEEDED. - - >- - The target site is in the update queue and will be picked up by - indexing pipeline. - - The target site fails to be indexed. - - The target site has been indexed. + - Default value. + - Only contains documents without any Document.content. + - Only contains documents with Document.content. + - The data store is used for public website search. - >- - The previously indexed target site has been marked to be deleted. - This is a transitioning state which will resulted in either: 1. - target site deleted if unindexing is successful; 2. state reverts - to SUCCEEDED if the unindexing fails. + The data store is used for workspace search. Details of workspace + data store are specified in the WorkspaceConfig. enum: - - INDEXING_STATUS_UNSPECIFIED - - PENDING - - FAILED - - SUCCEEDED - - DELETING - updateTime: - description: Output only. The target site's last updated time. + - CONTENT_CONFIG_UNSPECIFIED + - NO_CONTENT + - CONTENT_REQUIRED + - PUBLIC_WEBSITE + - GOOGLE_WORKSPACE + createTime: + description: Output only. Timestamp the DataStore was created at. readOnly: true type: string format: google-datetime - failureReason: - description: Output only. Failure reason. - readOnly: true + advancedSiteSearchConfig: + description: Optional. Configuration for advanced site search. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason - GoogleCloudDiscoveryengineV1betaSiteVerificationInfo: - id: GoogleCloudDiscoveryengineV1betaSiteVerificationInfo - description: Verification information for target sites in advanced site search. - type: object - properties: - siteVerificationState: - description: Site verification state indicating the ownership and validity. - type: string - enumDescriptions: - - Defaults to VERIFIED. - - Site ownership verified. - - Site ownership pending verification or verification failed. - - >- - Site exempt from verification, e.g., a public website that opens - to all. - enum: - - SITE_VERIFICATION_STATE_UNSPECIFIED - - VERIFIED - - UNVERIFIED - - EXEMPTED - verifyTime: - description: Latest site verification time. - type: string - format: google-datetime - GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason: - id: GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason - description: Site search indexing failure reasons. - type: object - properties: - quotaFailure: - description: Failed due to insufficient quota. + #/components/schemas/GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig + languageInfo: + description: Language info for DataStore. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaLanguageInfo' + naturalLanguageQueryUnderstandingConfig: + description: Optional. Configuration for Natural Language Query Understanding. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure - GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure: - id: GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure - description: Failed due to insufficient quota. - type: object - properties: - totalRequiredQuota: + #/components/schemas/GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig + kmsKeyName: description: >- - This number is an estimation on how much total quota this project - needs to successfully complete indexing. + Input only. The KMS key to be used to protect this DataStore at + creation time. Must be set for requests that need to comply with + CMEK Org Policy protections. If this field is set and processed + successfully, the DataStore will be protected by the KMS key, as + indicated in the cmek_config field. type: string - format: int64 - GoogleCloudDiscoveryengineV1betaControl: - id: GoogleCloudDiscoveryengineV1betaControl - description: >- - Defines a conditioned behavior to employ during serving. Must be - attached to a ServingConfig to be considered at serving time. Permitted - actions dependent on `SolutionType`. - type: object - properties: - boostAction: - description: Defines a boost-type control + cmekConfig: + description: Output only. CMEK-related information for the DataStore. + readOnly: true + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaCmekConfig' + idpConfig: + description: Output only. Data store level identity provider config. + readOnly: true + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaIdpConfig' + billingEstimation: + description: Output only. Data size estimation for billing. + readOnly: true $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaControlBoostAction - filterAction: + #/components/schemas/GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation + aclEnabled: description: >- - Defines a filter-type control Currently not supported by - Recommendation + Immutable. Whether data in the DataStore has ACL information. If set + to `true`, the source data must have ACL. ACL will be ingested when + data is ingested by DocumentService.ImportDocuments methods. When + ACL is enabled for the DataStore, Document can't be accessed by + calling DocumentService.GetDocument or + DocumentService.ListDocuments. Currently ACL is only supported in + `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content + config. + type: boolean + workspaceConfig: + description: >- + Config to store data store type configuration for workspace data. + This must be set when DataStore.content_config is set as + DataStore.ContentConfig.GOOGLE_WORKSPACE. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaControlFilterAction - redirectAction: - description: Defines a redirect-type control. + #/components/schemas/GoogleCloudDiscoveryengineV1alphaWorkspaceConfig + documentProcessingConfig: + description: Configuration for Document understanding and enrichment. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaControlRedirectAction - synonymsAction: - description: Treats a group of terms as synonyms of one another. + #/components/schemas/GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig + startingSchema: + description: >- + The start schema to use for this DataStore when provisioning it. If + unset, a default vertical specialized schema will be used. This + field is only used by CreateDataStore API, and will be ignored if + used in other APIs. This field will be omitted from all API + responses including CreateDataStore API. To retrieve a schema of a + DataStore, use SchemaService.GetSchema API instead. The provided + schema will be validated against certain rules on schema. Learn more + from [this + doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaSchema' + healthcareFhirConfig: + description: Optional. Configuration for `HEALTHCARE_FHIR` vertical. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaControlSynonymsAction - name: + #/components/schemas/GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig + servingConfigDataStore: + description: Optional. Stores serving config at DataStore level. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore + identityMappingStore: description: >- - Immutable. Fully qualified name - `projects/*/locations/global/dataStore/*/controls/*` + Immutable. The fully qualified resource name of the associated + IdentityMappingStore. This field can only be set for acl_enabled + DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: + `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. type: string - displayName: - description: >- - Required. Human readable name. The identifier used in UI views. Must - be UTF-8 encoded string. Length limit is 128 characters. Otherwise - an INVALID ARGUMENT error is thrown. + isInfobotFaqDataStore: + description: Optional. If set, this DataStore is an Infobot FAQ DataStore. + type: boolean + GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig: + id: GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig + description: Configuration data for advance site search. + type: object + properties: + disableInitialIndex: + description: If set true, initial indexing is disabled for the DataStore. + type: boolean + disableAutomaticRefresh: + description: If set true, automatic refresh is disabled for the DataStore. + type: boolean + GoogleCloudDiscoveryengineV1alphaLanguageInfo: + id: GoogleCloudDiscoveryengineV1alphaLanguageInfo + description: Language info for DataStore. + type: object + properties: + languageCode: + description: The language code for the DataStore. type: string - associatedServingConfigIds: + normalizedLanguageCode: description: >- - Output only. List of all ServingConfig IDs this control is attached - to. May take up to 10 minutes to update after changes. + Output only. This is the normalized form of language_code. E.g.: + language_code of `en-GB`, `en_GB`, `en-UK` or `en-gb` will have + normalized_language_code of `en-GB`. readOnly: true - type: array - items: - type: string - solutionType: - description: >- - Required. Immutable. What solution the control belongs to. Must be - compatible with vertical of resource. Otherwise an INVALID ARGUMENT - error is thrown. type: string - enumDescriptions: - - Default value. - - Used for Recommendations AI. - - Used for Discovery Search. - - Used for use cases related to the Generative AI agent. - - >- - Used for use cases related to the Generative Chat agent. It's used - for Generative chat engine only, the associated data stores must - enrolled with `SOLUTION_TYPE_CHAT` solution. - enum: - - SOLUTION_TYPE_UNSPECIFIED - - SOLUTION_TYPE_RECOMMENDATION - - SOLUTION_TYPE_SEARCH - - SOLUTION_TYPE_CHAT - - SOLUTION_TYPE_GENERATIVE_CHAT - useCases: - description: >- - Specifies the use case for the control. Affects what condition - fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently - only allow one use case per control. Must be set when solution_type - is SolutionType.SOLUTION_TYPE_SEARCH. - type: array - items: - type: string - enumDescriptions: - - Value used when unset. Will not occur in CSS. - - Search use case. Expects the traffic has a non-empty query. - - Browse use case. Expects the traffic has an empty query. - enum: - - SEARCH_USE_CASE_UNSPECIFIED - - SEARCH_USE_CASE_SEARCH - - SEARCH_USE_CASE_BROWSE - conditions: - description: >- - Determines when the associated action will trigger. Omit to always - apply the action. Currently only a single condition may be - specified. Otherwise an INVALID ARGUMENT error is thrown. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1betaCondition' - GoogleCloudDiscoveryengineV1betaControlBoostAction: - id: GoogleCloudDiscoveryengineV1betaControlBoostAction - description: Adjusts order of products in returned list. - type: object - properties: - boost: - description: >- - Required. Strength of the boost, which should be in [-1, 1]. - Negative boost means demotion. Default is 0.0 (No-op). - type: number - format: float - filter: + language: description: >- - Required. Specifies which products to apply the boost to. If no - filter is provided all products will be boosted (No-op). Syntax - documentation: https://cloud.google.com/retail/docs/filter-and-order - Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT - error is thrown. + Output only. Language part of normalized_language_code. E.g.: + `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`. + readOnly: true type: string - dataStore: + region: description: >- - Required. Specifies which data store's documents can be boosted by - this control. Full data store name e.g. - projects/123/locations/global/collections/default_collection/dataStores/default_data_store + Output only. Region part of normalized_language_code, if present. + E.g.: `en-US` -> `US`, `zh-Hans-HK` -> `HK`, `en` -> ``. + readOnly: true type: string - GoogleCloudDiscoveryengineV1betaControlFilterAction: - id: GoogleCloudDiscoveryengineV1betaControlFilterAction - description: >- - Specified which products may be included in results. Uses same filter as - boost. + GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig: + id: GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig + description: Configuration for Natural Language Query Understanding. type: object properties: - filter: - description: >- - Required. A filter to apply on the matching condition results. - Required Syntax documentation: - https://cloud.google.com/retail/docs/filter-and-order Maximum length - is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. - type: string - dataStore: + mode: description: >- - Required. Specifies which data store's documents can be filtered by - this control. Full data store name e.g. - projects/123/locations/global/collections/default_collection/dataStores/default_data_store + Mode of Natural Language Query Understanding. If this field is + unset, the behavior defaults to + NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED. type: string - GoogleCloudDiscoveryengineV1betaControlRedirectAction: - id: GoogleCloudDiscoveryengineV1betaControlRedirectAction - description: Redirects a shopper to the provided URI. + enumDescriptions: + - Default value. + - Natural Language Query Understanding is disabled. + - Natural Language Query Understanding is enabled. + enum: + - MODE_UNSPECIFIED + - DISABLED + - ENABLED + GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation: + id: GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation + description: Estimation of data size per data store. type: object properties: - redirectUri: - description: >- - Required. The URI to which the shopper will be redirected. Required. - URI must have length equal or less than 2000 characters. Otherwise - an INVALID ARGUMENT error is thrown. + structuredDataSize: + description: Data size for structured data in terms of bytes. type: string - GoogleCloudDiscoveryengineV1betaControlSynonymsAction: - id: GoogleCloudDiscoveryengineV1betaControlSynonymsAction - description: >- - Creates a set of terms that will act as synonyms of one another. - Example: "happy" will also be considered as "glad", "glad" will also be - considered as "happy". - type: object - properties: - synonyms: - description: >- - Defines a set of synonyms. Can specify up to 100 synonyms. Must - specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is - thrown. - type: array - items: - type: string - GoogleCloudDiscoveryengineV1betaCondition: - id: GoogleCloudDiscoveryengineV1betaCondition - description: Defines circumstances to be checked before allowing a behavior - type: object - properties: - queryTerms: - description: >- - Search only A list of terms to match the query on. Cannot be set - when Condition.query_regex is set. Maximum of 10 query terms. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaConditionQueryTerm - activeTimeRange: - description: >- - Range of time(s) specifying when condition is active. Maximum of 10 - time ranges. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaConditionTimeRange - queryRegex: - description: >- - Optional. Query regex to match the whole search query. Cannot be set - when Condition.query_terms is set. This is currently supporting - promotion use case. + format: int64 + unstructuredDataSize: + description: Data size for unstructured data in terms of bytes. type: string - GoogleCloudDiscoveryengineV1betaConditionQueryTerm: - id: GoogleCloudDiscoveryengineV1betaConditionQueryTerm - description: Matcher for search request query - type: object - properties: - value: - description: >- - The specific query value to match against Must be lowercase, must be - UTF-8. Can have at most 3 space separated terms if full_match is - true. Cannot be an empty string. Maximum length of 5000 characters. + format: int64 + websiteDataSize: + description: Data size for websites in terms of bytes. type: string - fullMatch: - description: Whether the search query needs to exactly match the query term. - type: boolean - GoogleCloudDiscoveryengineV1betaConditionTimeRange: - id: GoogleCloudDiscoveryengineV1betaConditionTimeRange - description: Used for time-dependent conditions. - type: object - properties: - startTime: - description: Start of time range. Range is inclusive. + format: int64 + structuredDataUpdateTime: + description: Last updated timestamp for structured data. type: string format: google-datetime - endTime: - description: End of time range. Range is inclusive. Must be in the future. + unstructuredDataUpdateTime: + description: Last updated timestamp for unstructured data. type: string format: google-datetime - GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata: - id: GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata - description: >- - Metadata related to the progress of the DataStoreService.CreateDataStore - operation. This will be returned by the - google.longrunning.Operation.metadata field. + websiteDataUpdateTime: + description: Last updated timestamp for websites. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1alphaWorkspaceConfig: + id: GoogleCloudDiscoveryengineV1alphaWorkspaceConfig + description: Config to store data store type configuration for workspace data type: object properties: - createTime: - description: Operation create time. + type: + description: The Google Workspace data source. type: string - format: google-datetime - updateTime: + enumDescriptions: + - Defaults to an unspecified Workspace type. + - Workspace Data Store contains Drive data + - Workspace Data Store contains Mail data + - Workspace Data Store contains Sites data + - Workspace Data Store contains Calendar data + - Workspace Data Store contains Chat data + - Workspace Data Store contains Groups data + - Workspace Data Store contains Keep data + - Workspace Data Store contains People data + enum: + - TYPE_UNSPECIFIED + - GOOGLE_DRIVE + - GOOGLE_MAIL + - GOOGLE_SITES + - GOOGLE_CALENDAR + - GOOGLE_CHAT + - GOOGLE_GROUPS + - GOOGLE_KEEP + - GOOGLE_PEOPLE + dasherCustomerId: + description: Obfuscated Dasher customer ID. + type: string + superAdminServiceAccount: description: >- - Operation last update time. If the operation is done, this is also - the finish time. + Optional. The super admin service account for the workspace that + will be used for access token generation. For now we only use it for + Native Google Drive connector data ingestion. type: string - format: google-datetime - GoogleCloudDiscoveryengineV1betaCreateEngineMetadata: - id: GoogleCloudDiscoveryengineV1betaCreateEngineMetadata + superAdminEmailAddress: + description: >- + Optional. The super admin email address for the workspace that will + be used for access token generation. For now we only use it for + Native Google Drive connector data ingestion. + type: string + GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig: + id: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig description: >- - Metadata related to the progress of the EngineService.CreateEngine - operation. This will be returned by the - google.longrunning.Operation.metadata field. + A singleton resource of DataStore. If it's empty when DataStore is + created and DataStore is set to + DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will + default to digital parser. type: object properties: - createTime: + name: + description: >- + The full resource name of the Document Processing Config. Format: + `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. + type: string + chunkingConfig: + description: Whether chunking mode is enabled. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig + defaultParsingConfig: + description: >- + Configurations for default Document parser. If not specified, we + will configure it as default DigitalParsingConfig, and the default + parsing config will be applied to all file types for Document + parsing. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig + parsingConfigOverrides: + description: >- + Map from file type to override the default parsing configuration + based on the file type. Supported keys: * `pdf`: Override parsing + config for PDF files, either digital parsing, ocr parsing or layout + parsing is supported. * `html`: Override parsing config for HTML + files, only digital parsing and layout parsing are supported. * + `docx`: Override parsing config for DOCX files, only digital parsing + and layout parsing are supported. * `pptx`: Override parsing config + for PPTX files, only digital parsing and layout parsing are + supported. * `xlsm`: Override parsing config for XLSM files, only + digital parsing and layout parsing are supported. * `xlsx`: Override + parsing config for XLSX files, only digital parsing and layout + parsing are supported. + type: object + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig + GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig: + id: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig + description: Configuration for chunking config. + type: object + properties: + layoutBasedChunkingConfig: + description: Configuration for the layout based chunking. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig + GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig: + id: >- + GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig + description: Configuration for the layout based chunking. + type: object + properties: + chunkSize: + description: >- + The token size limit for each chunk. Supported values: 100-500 + (inclusive). Default value: 500. + type: integer + format: int32 + includeAncestorHeadings: + description: >- + Whether to include appending different levels of headings to chunks + from the middle of the document to prevent context loss. Default + value: False. + type: boolean + GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig: + id: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig + description: Related configurations applied to a specific type of document parser. + type: object + properties: + digitalParsingConfig: + description: Configurations applied to digital parser. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig + ocrParsingConfig: + description: >- + Configurations applied to OCR parser. Currently it only applies to + PDFs. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig + layoutParsingConfig: + description: Configurations applied to layout parser. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig + GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig: + id: >- + GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig + description: The digital parsing configurations for documents. + type: object + properties: {} + GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig: + id: >- + GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig + description: The OCR parsing configurations for documents. + type: object + properties: + enhancedDocumentElements: + description: >- + [DEPRECATED] This field is deprecated. To use the additional + enhanced document elements processing, please switch to + `layout_parsing_config`. + deprecated: true + type: array + items: + type: string + useNativeText: + description: >- + If true, will use native text instead of OCR text on pages + containing native text. + type: boolean + GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig: + id: >- + GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig + description: The layout parsing configurations for documents. + type: object + properties: + enableTableAnnotation: + description: >- + Optional. If true, the LLM based annotation is added to the table + during parsing. + type: boolean + enableImageAnnotation: + description: >- + Optional. If true, the LLM based annotation is added to the image + during parsing. + type: boolean + structuredContentTypes: + description: >- + Optional. Contains the required structure types to extract from the + document. Supported values: * `shareholder-structure` + type: array + items: + type: string + excludeHtmlElements: + description: Optional. List of HTML elements to exclude from the parsed content. + type: array + items: + type: string + excludeHtmlClasses: + description: Optional. List of HTML classes to exclude from the parsed content. + type: array + items: + type: string + excludeHtmlIds: + description: Optional. List of HTML ids to exclude from the parsed content. + type: array + items: + type: string + enableGetProcessedDocument: + description: >- + Optional. If true, the processed document will be made available for + the GetProcessedDocument API. + type: boolean + GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore: + id: GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore + description: >- + Stores information regarding the serving configurations at DataStore + level. + type: object + properties: + disabledForServing: + description: >- + Optional. If set true, the DataStore will not be available for + serving search requests. + type: boolean + GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata: + id: GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata + description: >- + Metadata related to the progress of the + CmekConfigService.DeleteCmekConfig operation. This will be returned by + the google.longrunning.Operation.metadata field. + type: object + properties: + createTime: description: Operation create time. type: string format: google-datetime @@ -12234,14 +13610,30 @@ components: the finish time. type: string format: google-datetime - GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata: - id: GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata - description: Metadata for EvaluationService.CreateEvaluation method. + GoogleCloudDiscoveryengineV1alphaDeleteCollectionMetadata: + id: GoogleCloudDiscoveryengineV1alphaDeleteCollectionMetadata + description: >- + Metadata related to the progress of the + CollectionService.UpdateCollection operation. This will be returned by + the google.longrunning.Operation.metadata field. type: object - properties: {} - GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata: - id: GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata - description: Metadata for Create Schema LRO. + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata: + id: GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata + description: >- + Metadata related to the progress of the DataStoreService.DeleteDataStore + operation. This will be returned by the + google.longrunning.Operation.metadata field. type: object properties: createTime: @@ -12254,12 +13646,12 @@ components: the finish time. type: string format: google-datetime - GoogleCloudDiscoveryengineV1betaCreateSitemapMetadata: - id: GoogleCloudDiscoveryengineV1betaCreateSitemapMetadata + GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata: + id: GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata description: >- - Metadata related to the progress of the - SiteSearchEngineService.CreateSitemap operation. This will be returned - by the google.longrunning.Operation.metadata field. + Metadata related to the progress of the EngineService.DeleteEngine + operation. This will be returned by the + google.longrunning.Operation.metadata field. type: object properties: createTime: @@ -12272,12 +13664,12 @@ components: the finish time. type: string format: google-datetime - GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata: - id: GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata + GoogleCloudDiscoveryengineV1alphaDeleteIdentityMappingStoreMetadata: + id: GoogleCloudDiscoveryengineV1alphaDeleteIdentityMappingStoreMetadata description: >- Metadata related to the progress of the - SiteSearchEngineService.CreateTargetSite operation. This will be - returned by the google.longrunning.Operation.metadata field. + IdentityMappingStoreService.DeleteIdentityMappingStore operation. This + will be returned by the google.longrunning.Operation.metadata field. type: object properties: createTime: @@ -12290,930 +13682,698 @@ components: the finish time. type: string format: google-datetime - GoogleCloudDiscoveryengineV1betaDataStore: - id: GoogleCloudDiscoveryengineV1betaDataStore - description: DataStore captures global settings and configs at the DataStore level. + GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata: + id: GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata + description: Metadata for DeleteSchema LRO. type: object properties: - name: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: description: >- - Immutable. The full resource name of the data store. Format: - `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. - This field must be a UTF-8 encoded string with a length limit of - 1024 characters. + Operation last update time. If the operation is done, this is also + the finish time. type: string - displayName: + format: google-datetime + GoogleCloudDiscoveryengineV1alphaDeleteSessionRequest: + id: GoogleCloudDiscoveryengineV1alphaDeleteSessionRequest + description: Request for DeleteSession method. + type: object + properties: + name: description: >- - Required. The data store display name. This field must be a UTF-8 - encoded string with a length limit of 128 characters. Otherwise, an - INVALID_ARGUMENT error is returned. + Required. The resource name of the Session to delete. Format: + `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` type: string - industryVertical: - description: Immutable. The industry vertical that the data store registers. + GoogleCloudDiscoveryengineV1alphaDeleteSitemapMetadata: + id: GoogleCloudDiscoveryengineV1alphaDeleteSitemapMetadata + description: >- + Metadata related to the progress of the + SiteSearchEngineService.DeleteSitemap operation. This will be returned + by the google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. type: string - enumDescriptions: - - Value used when unset. - - >- - The generic vertical for documents that are not specific to any - industry vertical. - - The media industry vertical. - - The healthcare FHIR vertical. - enum: - - INDUSTRY_VERTICAL_UNSPECIFIED - - GENERIC - - MEDIA - - HEALTHCARE_FHIR - solutionTypes: + format: google-datetime + updateTime: description: >- - The solutions that the data store enrolls. Available solutions for - each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` - and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` - is automatically enrolled. Other solutions cannot be enrolled. - type: array - items: - type: string - enumDescriptions: - - Default value. - - Used for Recommendations AI. - - Used for Discovery Search. - - Used for use cases related to the Generative AI agent. - - >- - Used for use cases related to the Generative Chat agent. It's - used for Generative chat engine only, the associated data stores - must enrolled with `SOLUTION_TYPE_CHAT` solution. - enum: - - SOLUTION_TYPE_UNSPECIFIED - - SOLUTION_TYPE_RECOMMENDATION - - SOLUTION_TYPE_SEARCH - - SOLUTION_TYPE_CHAT - - SOLUTION_TYPE_GENERATIVE_CHAT - defaultSchemaId: + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata: + id: GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata + description: >- + Metadata related to the progress of the + SiteSearchEngineService.DeleteTargetSite operation. This will be + returned by the google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: description: >- - Output only. The id of the default Schema asscociated to this data - store. - readOnly: true + Operation last update time. If the operation is done, this is also + the finish time. type: string - contentConfig: + format: google-datetime + GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata: + id: GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata + description: >- + Metadata related to the progress of the + SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will + be returned by the google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: description: >- - Immutable. The content config of the data store. If this field is - unset, the server behavior defaults to ContentConfig.NO_CONTENT. + Operation last update time. If the operation is done, this is also + the finish time. type: string - enumDescriptions: - - Default value. - - Only contains documents without any Document.content. - - Only contains documents with Document.content. - - The data store is used for public website search. - - >- - The data store is used for workspace search. Details of workspace - data store are specified in the WorkspaceConfig. - enum: - - CONTENT_CONFIG_UNSPECIFIED - - NO_CONTENT - - CONTENT_REQUIRED - - PUBLIC_WEBSITE - - GOOGLE_WORKSPACE + format: google-datetime + GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse: + id: GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse + description: >- + Response message for SiteSearchEngineService.DisableAdvancedSiteSearch + method. + type: object + properties: {} + GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata: + id: GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata + description: >- + Metadata related to the progress of the + SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be + returned by the google.longrunning.Operation.metadata field. + type: object + properties: createTime: - description: Output only. Timestamp the DataStore was created at. - readOnly: true + description: Operation create time. type: string format: google-datetime - advancedSiteSearchConfig: - description: Optional. Configuration for advanced site search. + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse: + id: GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse + description: >- + Response message for SiteSearchEngineService.EnableAdvancedSiteSearch + method. + type: object + properties: {} + GoogleCloudDiscoveryengineV1alphaEngine: + id: GoogleCloudDiscoveryengineV1alphaEngine + description: >- + Metadata that describes the training and serving parameters of an + Engine. + type: object + properties: + similarDocumentsConfig: + description: Additional config specs for a `similar-items` engine. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig - languageInfo: - description: Language info for DataStore. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1betaLanguageInfo' - naturalLanguageQueryUnderstandingConfig: - description: Optional. Configuration for Natural Language Query Understanding. + #/components/schemas/GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig + chatEngineConfig: + description: >- + Configurations for the Chat Engine. Only applicable if solution_type + is SOLUTION_TYPE_CHAT. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig - kmsKeyName: + #/components/schemas/GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig + searchEngineConfig: description: >- - Input only. The KMS key to be used to protect this DataStore at - creation time. Must be set for requests that need to comply with - CMEK Org Policy protections. If this field is set and processed - successfully, the DataStore will be protected by the KMS key, as - indicated in the cmek_config field. - type: string - cmekConfig: - description: Output only. CMEK-related information for the DataStore. - readOnly: true - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1betaCmekConfig' - billingEstimation: - description: Output only. Data size estimation for billing. - readOnly: true + Configurations for the Search Engine. Only applicable if + solution_type is SOLUTION_TYPE_SEARCH. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation - workspaceConfig: + #/components/schemas/GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig + mediaRecommendationEngineConfig: description: >- - Config to store data store type configuration for workspace data. - This must be set when DataStore.content_config is set as - DataStore.ContentConfig.GOOGLE_WORKSPACE. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1betaWorkspaceConfig' - documentProcessingConfig: - description: Configuration for Document understanding and enrichment. + Configurations for the Media Engine. Only applicable on the data + stores with solution_type SOLUTION_TYPE_RECOMMENDATION and + IndustryVertical.MEDIA vertical. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig - startingSchema: + #/components/schemas/GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig + recommendationMetadata: description: >- - The start schema to use for this DataStore when provisioning it. If - unset, a default vertical specialized schema will be used. This - field is only used by CreateDataStore API, and will be ignored if - used in other APIs. This field will be omitted from all API - responses including CreateDataStore API. To retrieve a schema of a - DataStore, use SchemaService.GetSchema API instead. The provided - schema will be validated against certain rules on schema. Learn more - from [this - doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1betaSchema' - servingConfigDataStore: - description: Optional. Stores serving config at DataStore level. + Output only. Additional information of a recommendation engine. Only + applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION. + readOnly: true $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore - GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig: - id: GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig - description: Configuration data for advance site search. - type: object - properties: {} - GoogleCloudDiscoveryengineV1betaLanguageInfo: - id: GoogleCloudDiscoveryengineV1betaLanguageInfo - description: Language info for DataStore. - type: object - properties: - languageCode: - description: The language code for the DataStore. - type: string - normalizedLanguageCode: + #/components/schemas/GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata + chatEngineMetadata: description: >- - Output only. This is the normalized form of language_code. E.g.: - language_code of `en-GB`, `en_GB`, `en-UK` or `en-gb` will have - normalized_language_code of `en-GB`. + Output only. Additional information of the Chat Engine. Only + applicable if solution_type is SOLUTION_TYPE_CHAT. readOnly: true + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata + name: + description: >- + Immutable. Identifier. The fully qualified resource name of the + engine. This field must be a UTF-8 encoded string with a length + limit of 1024 characters. Format: + `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + engine should be 1-63 characters, and valid characters are + /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned. type: string - language: + displayName: description: >- - Output only. Language part of normalized_language_code. E.g.: - `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`. + Required. The display name of the engine. Should be human readable. + UTF-8 encoded string with limit of 1024 characters. + type: string + createTime: + description: Output only. Timestamp the Recommendation Engine was created at. readOnly: true type: string - region: - description: >- - Output only. Region part of normalized_language_code, if present. - E.g.: `en-US` -> `US`, `zh-Hans-HK` -> `HK`, `en` -> ``. + format: google-datetime + updateTime: + description: Output only. Timestamp the Recommendation Engine was last updated. readOnly: true type: string - GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig: - id: GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig - description: Configuration for Natural Language Query Understanding. - type: object - properties: - mode: + format: google-datetime + dataStoreIds: description: >- - Mode of Natural Language Query Understanding. If this field is - unset, the behavior defaults to - NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED. + Optional. The data stores associated with this engine. For + SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of + engines, they can only associate with at most one data store. If + solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same + Collection can be associated here. Note that when used in + CreateEngineRequest, one DataStore id must be provided as the system + will use it for necessary initializations. + type: array + items: + type: string + solutionType: + description: Required. The solutions of the engine. type: string enumDescriptions: - Default value. - - Natural Language Query Understanding is disabled. - - Natural Language Query Understanding is enabled. + - Used for Recommendations AI. + - Used for Discovery Search. + - Used for use cases related to the Generative AI agent. + - >- + Used for use cases related to the Generative Chat agent. It's used + for Generative chat engine only, the associated data stores must + enrolled with `SOLUTION_TYPE_CHAT` solution. enum: - - MODE_UNSPECIFIED - - DISABLED - - ENABLED - GoogleCloudDiscoveryengineV1betaCmekConfig: - id: GoogleCloudDiscoveryengineV1betaCmekConfig - description: Configurations used to enable CMEK data encryption with Cloud KMS keys. - type: object - properties: - name: - description: >- - Required. Name of the CmekConfig, of the form - `projects/{project}/locations/{location}/cmekConfig` or - `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`. - type: string - kmsKey: - description: >- - Kms key resource name which will be used to encrypt resources - `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. - type: string - kmsKeyVersion: + - SOLUTION_TYPE_UNSPECIFIED + - SOLUTION_TYPE_RECOMMENDATION + - SOLUTION_TYPE_SEARCH + - SOLUTION_TYPE_CHAT + - SOLUTION_TYPE_GENERATIVE_CHAT + industryVertical: description: >- - Kms key version resource name which will be used to encrypt - resources `/cryptoKeyVersions/{keyVersion}`. - type: string - state: - description: Output only. State of the CmekConfig. - readOnly: true + Optional. The industry vertical that the engine registers. The + restriction of the Engine industry vertical is based on DataStore: + Vertical on Engine has to match vertical of the DataStore linked to + the engine. type: string enumDescriptions: - - The CmekConfig state is unknown. - - The CmekConfig is creating. - - The CmekConfig can be used with DataStores. - - >- - The CmekConfig is unavailable, most likely due to the KMS Key - being revoked. - - The CmekConfig is deleting. + - Value used when unset. - >- - The CmekConfig is not usable, most likely due to some internal - issue. - - The KMS key version is being rotated. + The generic vertical for documents that are not specific to any + industry vertical. + - The media industry vertical. + - The healthcare FHIR vertical. enum: - - STATE_UNSPECIFIED - - CREATING - - ACTIVE - - KEY_ISSUE - - DELETING - - UNUSABLE - - ACTIVE_ROTATING - isDefault: - description: Output only. The default CmekConfig for the Customer. - readOnly: true + - INDUSTRY_VERTICAL_UNSPECIFIED + - GENERIC + - MEDIA + - HEALTHCARE_FHIR + commonConfig: + description: Common config spec that specifies the metadata of the engine. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaEngineCommonConfig + disableAnalytics: + description: >- + Optional. Whether to disable analytics for searches performed on + this engine. type: boolean - lastRotationTimestampMicros: - description: Output only. The timestamp of the last key rotation. - readOnly: true - type: string - format: int64 - GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation: - id: GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation - description: Estimation of data size per data store. + features: + description: >- + Optional. Feature config for the engine to opt in or opt out of + features. Supported keys: * `*`: all features, if it's present, all + other feature state settings are ignored. * `agent-gallery` * + `no-code-agent-builder` * `prompt-gallery` * `model-selector` * + `notebook-lm` * `people-search` * `people-search-org-chart` * + `bi-directional-audio` * `feedback` * `session-sharing` * + `personalization-memory` - Enables personalization based on user + preferences. + type: object + additionalProperties: + type: string + enumDescriptions: + - The feature state is unspecified. + - The feature is turned on to be accessible. + - The feature is turned off to be inaccessible. + enum: + - FEATURE_STATE_UNSPECIFIED + - FEATURE_STATE_ON + - FEATURE_STATE_OFF + GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig: + id: GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig + description: Additional config specs for a `similar-items` engine. + type: object + properties: {} + GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig: + id: GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig + description: Configurations for a Chat Engine. type: object properties: - structuredDataSize: - description: Data size for structured data in terms of bytes. - type: string - format: int64 - unstructuredDataSize: - description: Data size for unstructured data in terms of bytes. + agentCreationConfig: + description: >- + The configurationt generate the Dialogflow agent that is associated + to this Engine. Note that these configurations are one-time consumed + by and passed to Dialogflow service. It means they cannot be + retrieved using EngineService.GetEngine or EngineService.ListEngines + API after engine creation. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig + dialogflowAgentToLink: + description: >- + The resource name of an exist Dialogflow agent to link to this Chat + Engine. Customers can either provide `agent_creation_config` to + create agent or provide an agent name that links the agent with the + Chat engine. Format: `projects//locations//agents/`. Note that the + `dialogflow_agent_to_link` are one-time consumed by and passed to + Dialogflow service. It means they cannot be retrieved using + EngineService.GetEngine or EngineService.ListEngines API after + engine creation. Use ChatEngineMetadata.dialogflow_agent for actual + agent association after Engine is created. type: string - format: int64 - websiteDataSize: - description: Data size for websites in terms of bytes. + allowCrossRegion: + description: >- + Optional. If the flag set to true, we allow the agent and engine are + in different locations, otherwise the agent and engine are required + to be in the same location. The flag is set to false by default. + Note that the `allow_cross_region` are one-time consumed by and + passed to EngineService.CreateEngine. It means they cannot be + retrieved using EngineService.GetEngine or EngineService.ListEngines + API after engine creation. + type: boolean + GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig: + id: >- + GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig + description: >- + Configurations for generating a Dialogflow agent. Note that these + configurations are one-time consumed by and passed to Dialogflow + service. It means they cannot be retrieved using EngineService.GetEngine + or EngineService.ListEngines API after engine creation. + type: object + properties: + business: + description: >- + Name of the company, organization or other entity that the agent + represents. Used for knowledge connector LLM prompt and for + knowledge search. type: string - format: int64 - structuredDataUpdateTime: - description: Last updated timestamp for structured data. + defaultLanguageCode: + description: >- + Required. The default language of the agent as a language tag. See + [Language + Support](https://cloud.google.com/dialogflow/docs/reference/language) + for a list of the currently supported language codes. type: string - format: google-datetime - unstructuredDataUpdateTime: - description: Last updated timestamp for unstructured data. + timeZone: + description: >- + Required. The time zone of the agent from the [time zone + database](https://www.iana.org/time-zones), e.g., America/New_York, + Europe/Paris. type: string - format: google-datetime - websiteDataUpdateTime: - description: Last updated timestamp for websites. + location: + description: >- + Agent location for Agent creation, supported values: global/us/eu. + If not provided, us Engine will create Agent using us-central-1 by + default; eu Engine will create Agent using eu-west-1 by default. type: string - format: google-datetime - GoogleCloudDiscoveryengineV1betaWorkspaceConfig: - id: GoogleCloudDiscoveryengineV1betaWorkspaceConfig - description: Config to store data store type configuration for workspace data + GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig: + id: GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig + description: Configurations for a Search Engine. type: object properties: - type: - description: The Google Workspace data source. + searchTier: + description: >- + The search feature tier of this engine. Different tiers might have + different pricing. To learn more, check the pricing documentation. + Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. type: string enumDescriptions: - - Defaults to an unspecified Workspace type. - - Workspace Data Store contains Drive data - - Workspace Data Store contains Mail data - - Workspace Data Store contains Sites data - - Workspace Data Store contains Calendar data - - Workspace Data Store contains Chat data - - Workspace Data Store contains Groups data - - Workspace Data Store contains Keep data + - >- + Default value when the enum is unspecified. This is invalid to + use. + - Standard tier. + - Enterprise tier. enum: - - TYPE_UNSPECIFIED - - GOOGLE_DRIVE - - GOOGLE_MAIL - - GOOGLE_SITES - - GOOGLE_CALENDAR - - GOOGLE_CHAT - - GOOGLE_GROUPS - - GOOGLE_KEEP - dasherCustomerId: - description: Obfuscated Dasher customer ID. - type: string - superAdminServiceAccount: + - SEARCH_TIER_UNSPECIFIED + - SEARCH_TIER_STANDARD + - SEARCH_TIER_ENTERPRISE + searchAddOns: + description: The add-on that this search engine enables. + type: array + items: + type: string + enumDescriptions: + - >- + Default value when the enum is unspecified. This is invalid to + use. + - Large language model add-on. + enum: + - SEARCH_ADD_ON_UNSPECIFIED + - SEARCH_ADD_ON_LLM + GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig: + id: GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig + description: Additional config specs for a Media Recommendation engine. + type: object + properties: + type: description: >- - Optional. The super admin service account for the workspace that - will be used for access token generation. For now we only use it for - Native Google Drive connector data ingestion. + Required. The type of engine. e.g., `recommended-for-you`. This + field together with optimization_objective describe engine metadata + to use to control engine training and serving. Currently supported + values: `recommended-for-you`, `others-you-may-like`, + `more-like-this`, `most-popular-items`. type: string - superAdminEmailAddress: + optimizationObjective: description: >- - Optional. The super admin email address for the workspace that will - be used for access token generation. For now we only use it for - Native Google Drive connector data ingestion. + The optimization objective. e.g., `cvr`. This field together with + optimization_objective describe engine metadata to use to control + engine training and serving. Currently supported values: `ctr`, + `cvr`. If not specified, we choose default based on engine type. + Default depends on type of recommendation: `recommended-for-you` => + `ctr` `others-you-may-like` => `ctr` type: string - GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig: - id: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig - description: >- - A singleton resource of DataStore. If it's empty when DataStore is - created and DataStore is set to - DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will - default to digital parser. - type: object - properties: - name: + optimizationObjectiveConfig: description: >- - The full resource name of the Document Processing Config. Format: - `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. - type: string - chunkingConfig: - description: Whether chunking mode is enabled. + Name and value of the custom threshold for cvr + optimization_objective. For target_field `watch-time`, + target_field_value must be an integer value indicating the media + progress time in seconds between (0, 86400] (excludes 0, includes + 86400) (e.g., 90). For target_field `watch-percentage`, the + target_field_value must be a valid float value between (0, 1.0] + (excludes 0, includes 1.0) (e.g., 0.5). $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig - defaultParsingConfig: + #/components/schemas/GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig + trainingState: description: >- - Configurations for default Document parser. If not specified, we - will configure it as default DigitalParsingConfig, and the default - parsing config will be applied to all file types for Document - parsing. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig - parsingConfigOverrides: - description: >- - Map from file type to override the default parsing configuration - based on the file type. Supported keys: * `pdf`: Override parsing - config for PDF files, either digital parsing, ocr parsing or layout - parsing is supported. * `html`: Override parsing config for HTML - files, only digital parsing and layout parsing are supported. * - `docx`: Override parsing config for DOCX files, only digital parsing - and layout parsing are supported. * `pptx`: Override parsing config - for PPTX files, only digital parsing and layout parsing are - supported. * `xlsm`: Override parsing config for XLSM files, only - digital parsing and layout parsing are supported. * `xlsx`: Override - parsing config for XLSX files, only digital parsing and layout - parsing are supported. - type: object - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig - GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig: - id: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig - description: Configuration for chunking config. - type: object - properties: - layoutBasedChunkingConfig: - description: Configuration for the layout based chunking. + The training state that the engine is in (e.g. `TRAINING` or + `PAUSED`). Since part of the cost of running the service is + frequency of training - this can be used to determine when to train + engine in order to control cost. If not specified: the default value + for `CreateEngine` method is `TRAINING`. The default value for + `UpdateEngine` method is to keep the state the same as before. + type: string + enumDescriptions: + - Unspecified training state. + - The engine training is paused. + - The engine is training. + enum: + - TRAINING_STATE_UNSPECIFIED + - PAUSED + - TRAINING + engineFeaturesConfig: + description: Optional. Additional engine features config. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig - GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig: + #/components/schemas/GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigEngineFeaturesConfig + GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig: id: >- - GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig - description: Configuration for the layout based chunking. + GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig + description: Custom threshold for `cvr` optimization_objective. type: object properties: - chunkSize: - description: >- - The token size limit for each chunk. Supported values: 100-500 - (inclusive). Default value: 500. - type: integer - format: int32 - includeAncestorHeadings: + targetField: description: >- - Whether to include appending different levels of headings to chunks - from the middle of the document to prevent context loss. Default - value: False. - type: boolean - GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig: - id: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig - description: Related configurations applied to a specific type of document parser. + Required. The name of the field to target. Currently supported + values: `watch-percentage`, `watch-time`. + type: string + targetFieldValueFloat: + description: Required. The threshold to be applied to the target (e.g., 0.5). + type: number + format: float + GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigEngineFeaturesConfig: + id: >- + GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigEngineFeaturesConfig + description: More feature configs of the selected engine type. type: object properties: - digitalParsingConfig: - description: Configurations applied to digital parser. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig - ocrParsingConfig: - description: >- - Configurations applied to OCR parser. Currently it only applies to - PDFs. + recommendedForYouConfig: + description: Recommended for you engine feature config. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig - layoutParsingConfig: - description: Configurations applied to layout parser. + #/components/schemas/GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig + mostPopularConfig: + description: Most popular engine feature config. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig - GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig: - id: >- - GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig - description: The digital parsing configurations for documents. - type: object - properties: {} - GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig: + #/components/schemas/GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig + GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig: id: >- - GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig - description: The OCR parsing configurations for documents. + GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig + description: >- + Additional feature configurations for creating a `recommended-for-you` + engine. type: object properties: - enhancedDocumentElements: - description: >- - [DEPRECATED] This field is deprecated. To use the additional - enhanced document elements processing, please switch to - `layout_parsing_config`. - deprecated: true - type: array - items: - type: string - useNativeText: + contextEventType: description: >- - If true, will use native text instead of OCR text on pages - containing native text. - type: boolean - GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig: + The type of event with which the engine is queried at prediction + time. If set to `generic`, only `view-item`, `media-play`,and + `media-complete` will be used as `context-event` in engine training. + If set to `view-home-page`, `view-home-page` will also be used as + `context-events` in addition to `view-item`, `media-play`, and + `media-complete`. Currently supported for the `recommended-for-you` + engine. Currently supported values: `view-home-page`, `generic`. + type: string + GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig: id: >- - GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig - description: The layout parsing configurations for documents. - type: object - properties: {} - GoogleCloudDiscoveryengineV1betaSchema: - id: GoogleCloudDiscoveryengineV1betaSchema - description: Defines the structure and layout of a type of document data. + GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig + description: >- + Feature configurations that are required for creating a Most Popular + engine. type: object properties: - structSchema: - description: The structured representation of the schema. - type: object - additionalProperties: - type: any - description: Properties of the object. - jsonSchema: - description: The JSON representation of the schema. - type: string - name: + timeWindowDays: description: >- - Immutable. The full resource name of the schema, in the format of - `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. - This field must be a UTF-8 encoded string with a length limit of - 1024 characters. + The time window of which the engine is queried at training and + prediction time. Positive integers only. The value translates to the + last X days of events. Currently required for the + `most-popular-items` engine. type: string - GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore: - id: GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore - description: >- - Stores information regarding the serving configurations at DataStore - level. + format: int64 + GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata: + id: GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata + description: Additional information of a recommendation engine. type: object properties: - disabledForServing: + servingState: description: >- - If set true, the DataStore will not be available for serving search - requests. - type: boolean - GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata: - id: GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata - description: >- - Metadata related to the progress of the DataStoreService.DeleteDataStore - operation. This will be returned by the - google.longrunning.Operation.metadata field. - type: object - properties: - createTime: - description: Operation create time. + Output only. The serving state of the engine: `ACTIVE`, + `NOT_ACTIVE`. + readOnly: true + type: string + enumDescriptions: + - Unspecified serving state. + - The engine is not serving. + - The engine is serving and can be queried. + - The engine is trained on tuned hyperparameters and can be queried. + enum: + - SERVING_STATE_UNSPECIFIED + - INACTIVE + - ACTIVE + - TUNED + dataState: + description: >- + Output only. The state of data requirements for this engine: + `DATA_OK` and `DATA_ERROR`. Engine cannot be trained if the data is + in `DATA_ERROR` state. Engine can have `DATA_ERROR` state even if + serving state is `ACTIVE`: engines were trained successfully before, + but cannot be refreshed because the underlying engine no longer has + sufficient data for training. + readOnly: true + type: string + enumDescriptions: + - Unspecified default value, should never be explicitly set. + - The engine has sufficient training data. + - >- + The engine does not have sufficient training data. Error messages + can be queried via Stackdriver. + enum: + - DATA_STATE_UNSPECIFIED + - DATA_OK + - DATA_ERROR + lastTuneTime: + description: >- + Output only. The timestamp when the latest successful tune finished. + Only applicable on Media Recommendation engines. + readOnly: true type: string format: google-datetime - updateTime: + lastTrainTime: description: >- - Operation last update time. If the operation is done, this is also - the finish time. + Output only. The timestamp when the latest successful training + finished. Only applicable on Media Recommendation engines. + readOnly: true type: string format: google-datetime - GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata: - id: GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata + tuningOperation: + description: >- + Output only. The latest tune operation id associated with the + engine. Only applicable on Media Recommendation engines. If present, + this operation id can be used to determine if there is an ongoing + tune for this engine. To check the operation status, send the + GetOperation request with this operation id in the engine resource + format. If no tuning has happened for this engine, the string is + empty. + readOnly: true + type: string + GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata: + id: GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata description: >- - Metadata related to the progress of the EngineService.DeleteEngine - operation. This will be returned by the - google.longrunning.Operation.metadata field. + Additional information of a Chat Engine. Fields in this message are + output only. type: object properties: - createTime: - description: Operation create time. - type: string - format: google-datetime - updateTime: + dialogflowAgent: description: >- - Operation last update time. If the operation is done, this is also - the finish time. + The resource name of a Dialogflow agent, that this Chat Engine + refers to. Format: `projects//locations//agents/`. type: string - format: google-datetime - GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata: - id: GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata - description: Metadata for DeleteSchema LRO. + GoogleCloudDiscoveryengineV1alphaEngineCommonConfig: + id: GoogleCloudDiscoveryengineV1alphaEngineCommonConfig + description: Common configurations for an Engine. type: object properties: - createTime: - description: Operation create time. - type: string - format: google-datetime - updateTime: + companyName: description: >- - Operation last update time. If the operation is done, this is also - the finish time. + The name of the company, business or entity that is associated with + the engine. Setting this may help improve LLM related features. type: string - format: google-datetime - GoogleCloudDiscoveryengineV1betaDeleteSitemapMetadata: - id: GoogleCloudDiscoveryengineV1betaDeleteSitemapMetadata + GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata: + id: GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata description: >- - Metadata related to the progress of the - SiteSearchEngineService.DeleteSitemap operation. This will be returned - by the google.longrunning.Operation.metadata field. + Metadata related to the progress of the EstimateDataSize operation. This + is returned by the google.longrunning.Operation.metadata field. type: object properties: createTime: description: Operation create time. type: string format: google-datetime - updateTime: - description: >- - Operation last update time. If the operation is done, this is also - the finish time. - type: string - format: google-datetime - GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata: - id: GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata - description: >- - Metadata related to the progress of the - SiteSearchEngineService.DeleteTargetSite operation. This will be - returned by the google.longrunning.Operation.metadata field. - type: object - properties: - createTime: - description: Operation create time. - type: string - format: google-datetime - updateTime: - description: >- - Operation last update time. If the operation is done, this is also - the finish time. - type: string - format: google-datetime - GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata: - id: GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata + GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse: + id: GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse description: >- - Metadata related to the progress of the - SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will - be returned by the google.longrunning.Operation.metadata field. + Response of the EstimateDataSize request. If the long running operation + was successful, then this message is returned by the + google.longrunning.Operations.response field if the operation was + successful. type: object properties: - createTime: - description: Operation create time. + dataSizeBytes: + description: Data size in terms of bytes. type: string - format: google-datetime - updateTime: - description: >- - Operation last update time. If the operation is done, this is also - the finish time. + format: int64 + documentCount: + description: Total number of documents. type: string - format: google-datetime - GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse: - id: GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse - description: >- - Response message for SiteSearchEngineService.DisableAdvancedSiteSearch - method. - type: object - properties: {} - GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata: - id: GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata + format: int64 + GoogleCloudDiscoveryengineV1alphaEvaluation: + id: GoogleCloudDiscoveryengineV1alphaEvaluation description: >- - Metadata related to the progress of the - SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be - returned by the google.longrunning.Operation.metadata field. + An evaluation is a single execution (or run) of an evaluation process. + It encapsulates the state of the evaluation and the resulting data. type: object properties: - createTime: - description: Operation create time. - type: string - format: google-datetime - updateTime: + name: description: >- - Operation last update time. If the operation is done, this is also - the finish time. + Identifier. The full resource name of the Evaluation, in the format + of + `projects/{project}/locations/{location}/evaluations/{evaluation}`. + This field must be a UTF-8 encoded string with a length limit of + 1024 characters. type: string - format: google-datetime - GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse: - id: GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse - description: >- - Response message for SiteSearchEngineService.EnableAdvancedSiteSearch - method. - type: object - properties: {} - GoogleCloudDiscoveryengineV1betaEngine: - id: GoogleCloudDiscoveryengineV1betaEngine - description: >- - Metadata that describes the training and serving parameters of an - Engine. - type: object - properties: - chatEngineConfig: - description: >- - Configurations for the Chat Engine. Only applicable if solution_type - is SOLUTION_TYPE_CHAT. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig - searchEngineConfig: - description: >- - Configurations for the Search Engine. Only applicable if - solution_type is SOLUTION_TYPE_SEARCH. + evaluationSpec: + description: Required. The specification of the evaluation. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig - chatEngineMetadata: + #/components/schemas/GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec + qualityMetrics: description: >- - Output only. Additional information of the Chat Engine. Only - applicable if solution_type is SOLUTION_TYPE_CHAT. + Output only. The metrics produced by the evaluation, averaged across + all SampleQuerys in the SampleQuerySet. Only populated when the + evaluation's state is SUCCEEDED. + readOnly: true + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaQualityMetrics' + state: + description: Output only. The state of the evaluation. readOnly: true - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata - name: - description: >- - Immutable. The fully qualified resource name of the engine. This - field must be a UTF-8 encoded string with a length limit of 1024 - characters. Format: - `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` - engine should be 1-63 characters, and valid characters are - /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned. type: string - displayName: + enumDescriptions: + - The evaluation is unspecified. + - The service is preparing to run the evaluation. + - The evaluation is in progress. + - The evaluation completed successfully. + - The evaluation failed. + enum: + - STATE_UNSPECIFIED + - PENDING + - RUNNING + - SUCCEEDED + - FAILED + error: description: >- - Required. The display name of the engine. Should be human readable. - UTF-8 encoded string with limit of 1024 characters. - type: string + Output only. The error that occurred during evaluation. Only + populated when the evaluation's state is FAILED. + readOnly: true + $ref: '#/components/schemas/GoogleRpcStatus' createTime: - description: Output only. Timestamp the Recommendation Engine was created at. + description: Output only. Timestamp the Evaluation was created at. readOnly: true type: string format: google-datetime - updateTime: - description: Output only. Timestamp the Recommendation Engine was last updated. + endTime: + description: Output only. Timestamp the Evaluation was completed at. readOnly: true type: string format: google-datetime - dataStoreIds: + errorSamples: description: >- - The data stores associated with this engine. For - SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of - engines, they can only associate with at most one data store. If - solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same - Collection can be associated here. Note that when used in - CreateEngineRequest, one DataStore id must be provided as the system - will use it for necessary initializations. + Output only. A sample of errors encountered while processing the + request. + readOnly: true type: array items: - type: string - solutionType: - description: Required. The solutions of the engine. - type: string - enumDescriptions: - - Default value. - - Used for Recommendations AI. - - Used for Discovery Search. - - Used for use cases related to the Generative AI agent. - - >- - Used for use cases related to the Generative Chat agent. It's used - for Generative chat engine only, the associated data stores must - enrolled with `SOLUTION_TYPE_CHAT` solution. - enum: - - SOLUTION_TYPE_UNSPECIFIED - - SOLUTION_TYPE_RECOMMENDATION - - SOLUTION_TYPE_SEARCH - - SOLUTION_TYPE_CHAT - - SOLUTION_TYPE_GENERATIVE_CHAT - industryVertical: - description: >- - The industry vertical that the engine registers. The restriction of - the Engine industry vertical is based on DataStore: If unspecified, - default to `GENERIC`. Vertical on Engine has to match vertical of - the DataStore linked to the engine. - type: string - enumDescriptions: - - Value used when unset. - - >- - The generic vertical for documents that are not specific to any - industry vertical. - - The media industry vertical. - - The healthcare FHIR vertical. - enum: - - INDUSTRY_VERTICAL_UNSPECIFIED - - GENERIC - - MEDIA - - HEALTHCARE_FHIR - commonConfig: - description: Common config spec that specifies the metadata of the engine. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaEngineCommonConfig - disableAnalytics: - description: >- - Optional. Whether to disable analytics for searches performed on - this engine. - type: boolean - GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig: - id: GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig - description: Configurations for a Chat Engine. + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec: + id: GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec + description: Describes the specification of the evaluation. type: object properties: - agentCreationConfig: + searchRequest: description: >- - The configurationt generate the Dialogflow agent that is associated - to this Engine. Note that these configurations are one-time consumed - by and passed to Dialogflow service. It means they cannot be - retrieved using EngineService.GetEngine or EngineService.ListEngines - API after engine creation. + Required. The search request that is used to perform the evaluation. + Only the following fields within SearchRequest are supported; if any + other fields are provided, an UNSUPPORTED error will be returned: * + SearchRequest.serving_config * SearchRequest.branch * + SearchRequest.canonical_filter * SearchRequest.query_expansion_spec + * SearchRequest.spell_correction_spec * + SearchRequest.content_search_spec * SearchRequest.user_pseudo_id + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequest' + querySetSpec: + description: Optional. The specification of the query set. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig - dialogflowAgentToLink: - description: >- - The resource name of an exist Dialogflow agent to link to this Chat - Engine. Customers can either provide `agent_creation_config` to - create agent or provide an agent name that links the agent with the - Chat engine. Format: `projects//locations//agents/`. Note that the - `dialogflow_agent_to_link` are one-time consumed by and passed to - Dialogflow service. It means they cannot be retrieved using - EngineService.GetEngine or EngineService.ListEngines API after - engine creation. Use ChatEngineMetadata.dialogflow_agent for actual - agent association after Engine is created. - type: string - GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig: - id: >- - GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig - description: >- - Configurations for generating a Dialogflow agent. Note that these - configurations are one-time consumed by and passed to Dialogflow - service. It means they cannot be retrieved using EngineService.GetEngine - or EngineService.ListEngines API after engine creation. + #/components/schemas/GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec + GoogleCloudDiscoveryengineV1alphaSearchRequest: + id: GoogleCloudDiscoveryengineV1alphaSearchRequest + description: Request message for SearchService.Search method. type: object properties: - business: - description: >- - Name of the company, organization or other entity that the agent - represents. Used for knowledge connector LLM prompt and for - knowledge search. - type: string - defaultLanguageCode: - description: >- - Required. The default language of the agent as a language tag. See - [Language - Support](https://cloud.google.com/dialogflow/docs/reference/language) - for a list of the currently supported language codes. - type: string - timeZone: - description: >- - Required. The time zone of the agent from the [time zone - database](https://www.iana.org/time-zones), e.g., America/New_York, - Europe/Paris. - type: string - location: - description: >- - Agent location for Agent creation, supported values: global/us/eu. - If not provided, us Engine will create Agent using us-central-1 by - default; eu Engine will create Agent using eu-west-1 by default. - type: string - GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig: - id: GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig - description: Configurations for a Search Engine. - type: object - properties: - searchTier: - description: >- - The search feature tier of this engine. Different tiers might have - different pricing. To learn more, check the pricing documentation. - Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. - type: string - enumDescriptions: - - >- - Default value when the enum is unspecified. This is invalid to - use. - - Standard tier. - - Enterprise tier. - enum: - - SEARCH_TIER_UNSPECIFIED - - SEARCH_TIER_STANDARD - - SEARCH_TIER_ENTERPRISE - searchAddOns: - description: The add-on that this search engine enables. - type: array - items: - type: string - enumDescriptions: - - >- - Default value when the enum is unspecified. This is invalid to - use. - - Large language model add-on. - enum: - - SEARCH_ADD_ON_UNSPECIFIED - - SEARCH_ADD_ON_LLM - GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata: - id: GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata - description: >- - Additional information of a Chat Engine. Fields in this message are - output only. - type: object - properties: - dialogflowAgent: - description: >- - The resource name of a Dialogflow agent, that this Chat Engine - refers to. Format: `projects//locations//agents/`. - type: string - GoogleCloudDiscoveryengineV1betaEngineCommonConfig: - id: GoogleCloudDiscoveryengineV1betaEngineCommonConfig - description: Common configurations for an Engine. - type: object - properties: - companyName: - description: >- - The name of the company, business or entity that is associated with - the engine. Setting this may help improve LLM related features. - type: string - GoogleCloudDiscoveryengineV1betaEvaluation: - id: GoogleCloudDiscoveryengineV1betaEvaluation - description: >- - An evaluation is a single execution (or run) of an evaluation process. - It encapsulates the state of the evaluation and the resulting data. - type: object - properties: - name: - description: >- - Identifier. The full resource name of the Evaluation, in the format - of - `projects/{project}/locations/{location}/evaluations/{evaluation}`. - This field must be a UTF-8 encoded string with a length limit of - 1024 characters. - type: string - evaluationSpec: - description: Required. The specification of the evaluation. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec - qualityMetrics: - description: >- - Output only. The metrics produced by the evaluation, averaged across - all SampleQuerys in the SampleQuerySet. Only populated when the - evaluation's state is SUCCEEDED. - readOnly: true - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1betaQualityMetrics' - state: - description: Output only. The state of the evaluation. - readOnly: true - type: string - enumDescriptions: - - The evaluation is unspecified. - - The service is preparing to run the evaluation. - - The evaluation is in progress. - - The evaluation completed successfully. - - The evaluation failed. - enum: - - STATE_UNSPECIFIED - - PENDING - - RUNNING - - SUCCEEDED - - FAILED - error: - description: >- - Output only. The error that occurred during evaluation. Only - populated when the evaluation's state is FAILED. - readOnly: true - $ref: '#/components/schemas/GoogleRpcStatus' - createTime: - description: Output only. Timestamp the Evaluation was created at. - readOnly: true - type: string - format: google-datetime - endTime: - description: Output only. Timestamp the Evaluation was completed at. - readOnly: true - type: string - format: google-datetime - errorSamples: - description: >- - Output only. A sample of errors encountered while processing the - request. - readOnly: true - type: array - items: - $ref: '#/components/schemas/GoogleRpcStatus' - GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec: - id: GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec - description: Describes the specification of the evaluation. - type: object - properties: - searchRequest: - description: >- - Required. The search request that is used to perform the evaluation. - Only the following fields within SearchRequest are supported; if any - other fields are provided, an UNSUPPORTED error will be returned: * - SearchRequest.serving_config * SearchRequest.branch * - SearchRequest.canonical_filter * SearchRequest.query_expansion_spec - * SearchRequest.spell_correction_spec * - SearchRequest.content_search_spec * SearchRequest.user_pseudo_id - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequest' - querySetSpec: - description: Required. The specification of the query set. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec - GoogleCloudDiscoveryengineV1betaSearchRequest: - id: GoogleCloudDiscoveryengineV1betaSearchRequest - description: Request message for SearchService.Search method. - type: object - properties: - servingConfig: + servingConfig: description: >- Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, @@ -13235,7 +14395,7 @@ components: imageQuery: description: Raw image query. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery pageSize: description: >- Maximum number of Documents to return. The maximum allowed value @@ -13271,14 +14431,15 @@ components: format: int32 dataStoreSpecs: description: >- - Specs defining dataStores to filter on in a search call and - configurations for those dataStores. This is only considered for - engines with multiple dataStores use case. For single dataStore - within an engine, they should use the specs at the top level. + Specifications that define the specific DataStores to be searched, + along with configurations for those data stores. This is only + considered for Engines with multiple data stores. For engines with a + single data store, the specs directly under SearchRequest should be + used. type: array items: $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec filter: description: >- The filter syntax consists of an expression language for @@ -13321,9 +14482,10 @@ components: type: string userInfo: description: >- - Information about the end user. Highly recommended for analytics. - UserInfo.user_agent is used to deduce `device_type` for analytics. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1betaUserInfo' + Information about the end user. Highly recommended for analytics and + personalization. UserInfo.user_agent is used to deduce `device_type` + for analytics. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaUserInfo' languageCode: description: >- The BCP-47 language code, such as "en-US" or "sr-Latn". For more @@ -13348,14 +14510,14 @@ components: type: array items: $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec boostSpec: description: >- Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec params: description: >- Additional search parameters. For public website search only, @@ -13375,13 +14537,13 @@ components: The query expansion specification that specifies the conditions under which query expansion occurs. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec spellCorrectionSpec: description: >- The spell correction specification that specifies the mode under which spell correction takes effect. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec userPseudoId: description: >- A unique identifier for tracking visitors. For example, this could @@ -13394,10 +14556,17 @@ components: encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. type: string + useLatestData: + description: >- + Uses the Engine, ServingConfig and Control freshly read from the + database. Note: this skips config cache and introduces dependency on + databases, which could significantly increase the API latency. It + should only be used for testing, but not serving end users. + type: boolean contentSearchSpec: description: A specification for configuring the behavior of content search. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec embeddingSpec: description: >- Uses the provided embedding to do additional semantic document @@ -13408,23 +14577,100 @@ components: SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec rankingExpression: description: >- - The ranking expression controls the customized ranking on retrieval - documents. This overrides ServingConfig.ranking_expression. The - ranking expression is a single function or multiple functions that - are joined by "+". * ranking_expression = function, { " + ", - function }; Supported functions: * double * relevance_score * double - * dotProduct(embedding_field_path) Function variables: * - `relevance_score`: pre-defined keywords, used for measure relevance - between query and document. * `embedding_field_path`: the document - embedding field used with query embedding vector. * `dotProduct`: - embedding function between embedding_field_path and query embedding - vector. Example ranking expression: If document has an embedding - field doc_embedding, the ranking expression could be `0.5 * - relevance_score + 0.3 * dotProduct(doc_embedding)`. + Optional. The ranking expression controls the customized ranking on + retrieval documents. This overrides + ServingConfig.ranking_expression. The syntax and supported features + depend on the `ranking_expression_backend` value. If + `ranking_expression_backend` is not provided, it defaults to + `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided + or set to `RANK_BY_EMBEDDING`, it should be a single function or + multiple functions that are joined by "+". * ranking_expression = + function, { " + ", function }; Supported functions: * double * + relevance_score * double * dotProduct(embedding_field_path) Function + variables: * `relevance_score`: pre-defined keywords, used for + measure relevance between query and document. * + `embedding_field_path`: the document embedding field used with query + embedding vector. * `dotProduct`: embedding function between + `embedding_field_path` and query embedding vector. Example ranking + expression: If document has an embedding field doc_embedding, the + ranking expression could be `0.5 * relevance_score + 0.3 * + dotProduct(doc_embedding)`. If ranking_expression_backend is set to + `RANK_BY_FORMULA`, the following expression types (and combinations + of those chained using + or * operators) are supported: * `double` * + `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` + -- reciprocal rank transformation with second argument being a + denominator constant. * `is_nan(signal)` -- returns 0 if signal is + NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if + signal1 is NaN, returns signal2 | double, else returns signal1. Here + are a few examples of ranking formulas that use the supported + ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * + log(keyword_similarity_score)` -- mostly rank by the logarithm of + `keyword_similarity_score` with slight `semantic_smilarity_score` + adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of + `semantic_similarity_score` filling the value with 0 if it's NaN, + also add constant 0.3 adjustment to the final score if + `semantic_similarity_score` is NaN. - `0.2 * + rr(semantic_similarity_score, 16) + 0.8 * + rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal + rank of `keyword_similarity_score` with slight adjustment of + reciprocal rank of `semantic_smilarity_score`. The following signals + are supported: * `semantic_similarity_score`: semantic similarity + adjustment that is calculated using the embeddings generated by a + proprietary Google model. This score determines how semantically + similar a search query is to a document. * + `keyword_similarity_score`: keyword match adjustment uses the Best + Match 25 (BM25) ranking function. This score is calculated using a + probabilistic model to estimate the probability that a document is + relevant to a given query. * `relevance_score`: semantic relevance + adjustment that uses a proprietary Google model to determine the + meaning and intent behind a user's query in context with the content + in the documents. * `pctr_rank`: predicted conversion rate + adjustment as a rank use predicted Click-through rate (pCTR) to + gauge the relevance and attractiveness of a search result from a + user's perspective. A higher pCTR suggests that the result is more + likely to satisfy the user's query and intent, making it a valuable + signal for ranking. * `freshness_rank`: freshness adjustment as a + rank * `document_age`: The time in hours elapsed since the document + was last updated, a floating-point number (e.g., 0.25 means 15 + minutes). * `topicality_rank`: topicality adjustment as a rank. Uses + proprietary Google model to determine the keyword-based overlap + between the query and the document. * `base_rank`: the default rank + of the result + type: string + rankingExpressionBackend: + description: Optional. The backend to use for the ranking expression evaluation. type: string + enumDescriptions: + - Default option for unspecified/unknown values. + - >- + Deprecated: Use `RANK_BY_EMBEDDING` instead. Ranking by custom + embedding model, the default way to evaluate the ranking + expression. Legacy enum option, `RANK_BY_EMBEDDING` should be used + instead. + - >- + Deprecated: Use `RANK_BY_FORMULA` instead. Ranking by custom + formula. Legacy enum option, `RANK_BY_FORMULA` should be used + instead. + - >- + Ranking by custom embedding model, the default way to evaluate the + ranking expression. + - Ranking by custom formula. + enumDeprecated: + - false + - true + - true + - false + - false + enum: + - RANKING_EXPRESSION_BACKEND_UNSPECIFIED + - BYOE + - CLEARBOX + - RANK_BY_EMBEDDING + - RANK_BY_FORMULA safeSearch: description: >- Whether to turn on safe search. This is only supported for website @@ -13450,49 +14696,62 @@ components: type: string naturalLanguageQueryUnderstandingSpec: description: >- - If `naturalLanguageQueryUnderstandingSpec` is not specified, no - additional natural language query understanding will be done. + Config for natural language query understanding capabilities, such + as extracting structured field filters from the query. Refer to + [this + documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) + for more information. If `naturalLanguageQueryUnderstandingSpec` is + not specified, no additional natural language query understanding + will be done. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec searchAsYouTypeSpec: description: >- Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec + customFineTuningSpec: + description: >- + Custom fine tuning configs. If set, it has higher priority than the + configs set in ServingConfig.custom_fine_tuning_spec. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec + displaySpec: + description: >- + Optional. Config for display feature, like match highlighting on + search results. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec session: description: >- The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API - calls): 1. Call /search API with the auto-session mode (see below). - 2. Call /search API with the session ID generated in the first call. - Here, the previous search query gets considered in query standing. - I.e., if the first query is "How did Alphabet do in 2022?" and the - current query is "How about 2023?", the current query will be - interpreted as "How did Alphabet do in 2023?". Example #2 - (coordination between /search API calls and /answer API calls): 1. - Call /search API with the auto-session mode (see below). 2. Call + calls): Call /search API with the session ID generated in the first + call. Here, the previous search query gets considered in query + standing. I.e., if the first query is "How did Alphabet do in 2022?" + and the current query is "How about 2023?", the current query will + be interpreted as "How did Alphabet do in 2023?". Example #2 + (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results - from the first search call. Auto-session mode: when - `projects/.../sessions/-` is used, a new session gets automatically - created. Otherwise, users can use the create-session API to create a - session manually. Multi-turn Search feature is currently at private - GA stage. Please use v1alpha or v1beta version instead before we - launch this feature to public GA. Or ask for allowlisting through - Google Support team. + from the first search call. Multi-turn Search feature is currently + at private GA stage. Please use v1alpha or v1beta version instead + before we launch this feature to public GA. Or ask for allowlisting + through Google Support team. type: string sessionSpec: description: Session specification. Can be used only when `session` is set. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec relevanceThreshold: description: >- The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of - relevant information. + relevant information. This feature is not supported for healthcare + search. type: string enumDescriptions: - >- @@ -13516,9 +14775,13 @@ components: SearchRequest.personalization_spec overrides ServingConfig.personalization_spec. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec - GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery: - id: GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec + relevanceScoreSpec: + description: Optional. The specification for returning the relevance score. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec + GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery: + id: GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery description: Specifies the image query input. type: object properties: @@ -13527,8 +14790,8 @@ components: Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP. type: string - GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec: - id: GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec + GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec: + id: GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec description: >- A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` @@ -13539,6 +14802,8 @@ components: description: >- Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. + The path must include the project number, project id is not + supported for this field. type: string filter: description: >- @@ -13547,39 +14812,196 @@ components: see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) type: string - GoogleCloudDiscoveryengineV1betaUserInfo: - id: GoogleCloudDiscoveryengineV1betaUserInfo - description: Information of an end user. - type: object - properties: - userId: + boostSpec: description: >- - Highly recommended for logged-in users. Unique identifier for - logged-in user, such as a user name. Don't set for anonymous users. - Always use a hashed value for this ID. Don't set the field to the - same fixed ID for different users. This mixes the event history of - those users together, which results in degraded model quality. The - field must be a UTF-8 encoded string with a length limit of 128 - characters. Otherwise, an `INVALID_ARGUMENT` error is returned. - type: string - userAgent: + Optional. Boost specification to boost certain documents. For more + information on boosting, see + [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec + customSearchOperators: description: >- - User agent as included in the HTTP header. The field must be a UTF-8 - encoded string with a length limit of 1,000 characters. Otherwise, - an `INVALID_ARGUMENT` error is returned. This should not be set when - using the client side event reporting with GTM or JavaScript tag in - UserEventService.CollectUserEvent or if - UserEvent.direct_user_request is set. + Optional. Custom search operators which if specified will be used to + filter results from workspace data stores. For more information on + custom search operators, see + [SearchOperators](https://support.google.com/cloudsearch/answer/6172299). type: string - GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec: - id: GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec + GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec: + id: GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec + description: Boost specification to boost certain documents. + type: object + properties: + conditionBoostSpecs: + description: >- + Condition boost specifications. If a document matches multiple + conditions in the specifications, boost scores from these + specifications are all applied and combined in a non-linear way. + Maximum number of specifications is 20. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec + GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec: + id: >- + GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec + description: Boost applies to documents which match a condition. + type: object + properties: + condition: + description: >- + An expression which specifies a boost condition. The syntax and + supported fields are the same as a filter expression. See + SearchRequest.filter for detail syntax and limitations. Examples: * + To boost documents with document ID "doc_1" or "doc_2", and color + "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: + ANY("Red", "Blue"))` + type: string + boost: + description: >- + Strength of the condition boost, which should be in [-1, 1]. + Negative boost means demotion. Default is 0.0. Setting to 1.0 gives + the document a big promotion. However, it does not necessarily mean + that the boosted document will be the top result at all times, nor + that other documents will be excluded. Results could still be shown + even when none of them matches the condition. And results that are + significantly more relevant to the search query can still trump your + heavily favored but irrelevant documents. Setting to -1.0 gives the + document a big demotion. However, results that are deeply relevant + might still be shown. The document will have an upstream battle to + get a fairly high ranking, but it is not blocked out completely. + Setting to 0.0 means no boost applied. The boosting condition is + ignored. Only one of the (condition, boost) combination or the + boost_control_spec below are set. If both are set then the global + boost is ignored and the more fine-grained boost_control_spec is + applied. + type: number + format: float + boostControlSpec: + description: >- + Complex specification for custom ranking based on customer defined + attribute value. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec + GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec: + id: >- + GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec + description: >- + Specification for custom ranking based on customer specified attribute + value. It provides more controls for customized ranking than the simple + (condition, boost) combination above. + type: object + properties: + fieldName: + description: >- + The name of the field whose value will be used to determine the + boost amount. + type: string + attributeType: + description: >- + The attribute type to be used to determine the boost amount. The + attribute value can be derived from the field value of the specified + field_name. In the case of numerical it is straightforward i.e. + attribute_value = numerical_field_value. In the case of freshness + however, attribute_value = (time.now() - datetime_field_value). + type: string + enumDescriptions: + - Unspecified AttributeType. + - >- + The value of the numerical field will be used to dynamically + update the boost amount. In this case, the attribute_value (the x + value) of the control point will be the actual value of the + numerical field for which the boost_amount is specified. + - >- + For the freshness use case the attribute value will be the + duration between the current time and the date in the datetime + field specified. The value must be formatted as an XSD + `dayTimeDuration` value (a restricted subset of an ISO 8601 + duration value). The pattern for this is: `nDnM]`. For example, + `5D`, `3DT12H30M`, `T24H`. + enum: + - ATTRIBUTE_TYPE_UNSPECIFIED + - NUMERICAL + - FRESHNESS + interpolationType: + description: >- + The interpolation type to be applied to connect the control points + listed below. + type: string + enumDescriptions: + - >- + Interpolation type is unspecified. In this case, it defaults to + Linear. + - Piecewise linear interpolation will be applied. + enum: + - INTERPOLATION_TYPE_UNSPECIFIED + - LINEAR + controlPoints: + description: >- + The control points used to define the curve. The monotonic function + (defined through the interpolation_type above) passes through the + control points listed here. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint + GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint: + id: >- + GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint + description: >- + The control points used to define the curve. The curve defined through + these control points can only be monotonically increasing or + decreasing(constant values are acceptable). + type: object + properties: + attributeValue: + description: >- + Can be one of: 1. The numerical field value. 2. The duration spec + for freshness: The value must be formatted as an XSD + `dayTimeDuration` value (a restricted subset of an ISO 8601 duration + value). The pattern for this is: `nDnM]`. + type: string + boostAmount: + description: >- + The value between -1 to 1 by which to boost the score if the + attribute_value evaluates to the value specified above. + type: number + format: float + GoogleCloudDiscoveryengineV1alphaUserInfo: + id: GoogleCloudDiscoveryengineV1alphaUserInfo + description: Information of an end user. + type: object + properties: + userId: + description: >- + Highly recommended for logged-in users. Unique identifier for + logged-in user, such as a user name. Don't set for anonymous users. + Always use a hashed value for this ID. Don't set the field to the + same fixed ID for different users. This mixes the event history of + those users together, which results in degraded model quality. The + field must be a UTF-8 encoded string with a length limit of 128 + characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + type: string + userAgent: + description: >- + User agent as included in the HTTP header. The field must be a UTF-8 + encoded string with a length limit of 1,000 characters. Otherwise, + an `INVALID_ARGUMENT` error is returned. This should not be set when + using the client side event reporting with GTM or JavaScript tag in + UserEventService.CollectUserEvent or if + UserEvent.direct_user_request is set. + type: string + timeZone: + description: Optional. IANA time zone, e.g. Europe/Budapest. + type: string + GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec: + id: GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec description: A facet specification to perform faceted search. type: object properties: facetKey: description: Required. The facet key specification. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey limit: description: >- Maximum facet values that are returned for this facet. If @@ -13638,8 +15060,8 @@ components: "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false. type: boolean - GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey: - id: GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey + GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey: + id: GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey description: Specifies how a facet is computed. type: object properties: @@ -13656,7 +15078,7 @@ components: text values. Maximum number of intervals is 30. type: array items: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1betaInterval' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaInterval' restrictedValues: description: >- Only get facet for the given restricted values. Only supported on @@ -13704,8 +15126,8 @@ components: intervals are sorted in the order given by FacetSpec.FacetKey.intervals. type: string - GoogleCloudDiscoveryengineV1betaInterval: - id: GoogleCloudDiscoveryengineV1betaInterval + GoogleCloudDiscoveryengineV1alphaInterval: + id: GoogleCloudDiscoveryengineV1alphaInterval description: A floating point interval. type: object properties: @@ -13725,223 +15147,84 @@ components: description: Exclusive upper bound. type: number format: double - GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec: - id: GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec - description: Boost specification to boost certain documents. + GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec: + id: GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec + description: >- + Specification to determine under which conditions query expansion should + occur. type: object properties: - conditionBoostSpecs: + condition: description: >- - Condition boost specifications. If a document matches multiple - conditions in the specifictions, boost scores from these - specifications are all applied and combined in a non-linear way. - Maximum number of specifications is 20. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec - GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec: - id: GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec - description: Boost applies to documents which match a condition. + The condition under which query expansion should occur. Default to + Condition.DISABLED. + type: string + enumDescriptions: + - >- + Unspecified query expansion condition. In this case, server + behavior defaults to Condition.DISABLED. + - >- + Disabled query expansion. Only the exact search query is used, + even if SearchResponse.total_size is zero. + - Automatic query expansion built by the Search API. + enum: + - CONDITION_UNSPECIFIED + - DISABLED + - AUTO + pinUnexpandedResults: + description: >- + Whether to pin unexpanded results. If this field is set to true, + unexpanded products are always at the top of the search results, + followed by the expanded results. + type: boolean + GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec: + id: GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec + description: The specification for query spell correction. type: object properties: - condition: + mode: description: >- - An expression which specifies a boost condition. The syntax and - supported fields are the same as a filter expression. See - SearchRequest.filter for detail syntax and limitations. Examples: * - To boost documents with document ID "doc_1" or "doc_2", and color - "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: - ANY("Red", "Blue"))` + The mode under which spell correction replaces the original search + query. Defaults to Mode.AUTO. type: string - boost: - description: >- - Strength of the condition boost, which should be in [-1, 1]. - Negative boost means demotion. Default is 0.0. Setting to 1.0 gives - the document a big promotion. However, it does not necessarily mean - that the boosted document will be the top result at all times, nor - that other documents will be excluded. Results could still be shown - even when none of them matches the condition. And results that are - significantly more relevant to the search query can still trump your - heavily favored but irrelevant documents. Setting to -1.0 gives the - document a big demotion. However, results that are deeply relevant - might still be shown. The document will have an upstream battle to - get a fairly high ranking, but it is not blocked out completely. - Setting to 0.0 means no boost applied. The boosting condition is - ignored. Only one of the (condition, boost) combination or the - boost_control_spec below are set. If both are set then the global - boost is ignored and the more fine-grained boost_control_spec is - applied. - type: number - format: float - boostControlSpec: - description: >- - Complex specification for custom ranking based on customer defined - attribute value. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec - GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec: - id: >- - GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec - description: >- - Specification for custom ranking based on customer specified attribute - value. It provides more controls for customized ranking than the simple - (condition, boost) combination above. - type: object - properties: - fieldName: - description: >- - The name of the field whose value will be used to determine the - boost amount. - type: string - attributeType: - description: >- - The attribute type to be used to determine the boost amount. The - attribute value can be derived from the field value of the specified - field_name. In the case of numerical it is straightforward i.e. - attribute_value = numerical_field_value. In the case of freshness - however, attribute_value = (time.now() - datetime_field_value). - type: string - enumDescriptions: - - Unspecified AttributeType. - - >- - The value of the numerical field will be used to dynamically - update the boost amount. In this case, the attribute_value (the x - value) of the control point will be the actual value of the - numerical field for which the boost_amount is specified. - - >- - For the freshness use case the attribute value will be the - duration between the current time and the date in the datetime - field specified. The value must be formatted as an XSD - `dayTimeDuration` value (a restricted subset of an ISO 8601 - duration value). The pattern for this is: `nDnM]`. For example, - `5D`, `3DT12H30M`, `T24H`. - enum: - - ATTRIBUTE_TYPE_UNSPECIFIED - - NUMERICAL - - FRESHNESS - interpolationType: - description: >- - The interpolation type to be applied to connect the control points - listed below. - type: string - enumDescriptions: - - >- - Interpolation type is unspecified. In this case, it defaults to - Linear. - - Piecewise linear interpolation will be applied. - enum: - - INTERPOLATION_TYPE_UNSPECIFIED - - LINEAR - controlPoints: - description: >- - The control points used to define the curve. The monotonic function - (defined through the interpolation_type above) passes through the - control points listed here. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint - GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint: - id: >- - GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint - description: >- - The control points used to define the curve. The curve defined through - these control points can only be monotonically increasing or - decreasing(constant values are acceptable). - type: object - properties: - attributeValue: - description: >- - Can be one of: 1. The numerical field value. 2. The duration spec - for freshness: The value must be formatted as an XSD - `dayTimeDuration` value (a restricted subset of an ISO 8601 duration - value). The pattern for this is: `nDnM]`. - type: string - boostAmount: - description: >- - The value between -1 to 1 by which to boost the score if the - attribute_value evaluates to the value specified above. - type: number - format: float - GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec: - id: GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec - description: >- - Specification to determine under which conditions query expansion should - occur. - type: object - properties: - condition: - description: >- - The condition under which query expansion should occur. Default to - Condition.DISABLED. - type: string - enumDescriptions: - - >- - Unspecified query expansion condition. In this case, server - behavior defaults to Condition.DISABLED. - - >- - Disabled query expansion. Only the exact search query is used, - even if SearchResponse.total_size is zero. - - Automatic query expansion built by the Search API. - enum: - - CONDITION_UNSPECIFIED - - DISABLED - - AUTO - pinUnexpandedResults: - description: >- - Whether to pin unexpanded results. If this field is set to true, - unexpanded products are always at the top of the search results, - followed by the expanded results. - type: boolean - GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec: - id: GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec - description: The specification for query spell correction. - type: object - properties: - mode: - description: >- - The mode under which spell correction replaces the original search - query. Defaults to Mode.AUTO. - type: string - enumDescriptions: - - >- - Unspecified spell correction mode. In this case, server behavior - defaults to Mode.AUTO. - - >- - Search API tries to find a spelling suggestion. If a suggestion is - found, it is put in the SearchResponse.corrected_query. The - spelling suggestion won't be used as the search query. - - >- - Automatic spell correction built by the Search API. Search will be - based on the corrected query if found. - enum: - - MODE_UNSPECIFIED - - SUGGESTION_ONLY - - AUTO - GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec: - id: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec - description: A specification for configuring the behavior of content search. - type: object - properties: - snippetSpec: + enumDescriptions: + - >- + Unspecified spell correction mode. In this case, server behavior + defaults to Mode.AUTO. + - >- + Search API tries to find a spelling suggestion. If a suggestion is + found, it is put in the SearchResponse.corrected_query. The + spelling suggestion won't be used as the search query. + - >- + Automatic spell correction built by the Search API. Search will be + based on the corrected query if found. + enum: + - MODE_UNSPECIFIED + - SUGGESTION_ONLY + - AUTO + GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec: + id: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec + description: A specification for configuring the behavior of content search. + type: object + properties: + snippetSpec: description: >- If `snippetSpec` is not specified, snippets are not included in the search response. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec summarySpec: description: >- If `summarySpec` is not specified, summaries are not included in the search response. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec extractiveContentSpec: description: >- If there is no extractive_content_spec provided, there will be no extractive answer in the search response. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec searchResultMode: description: >- Specifies the search result mode. If unspecified, the search result @@ -13952,7 +15235,7 @@ components: - Returns documents in the search result. - >- Returns chunks in the search result. Only available if the - DataStore.DocumentProcessingConfig.chunking_config is specified. + DocumentProcessingConfig.chunking_config is specified. enum: - SEARCH_RESULT_MODE_UNSPECIFIED - DOCUMENTS @@ -13963,10 +15246,10 @@ components: Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec - GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec: + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec + GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec: id: >- - GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec + GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec description: A specification for configuring snippets in a search response. type: object properties: @@ -13990,9 +15273,9 @@ components: return "No snippet is available for this page." A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned. type: boolean - GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec: + GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec: id: >- - GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec + GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec description: A specification for configuring a summary returned in a search response. type: object properties: @@ -14064,12 +15347,16 @@ components: this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead. type: boolean + multimodalSpec: + description: Optional. Multimodal specification. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecMultiModalSpec modelPromptSpec: description: >- If specified, the spec will be used to modify the prompt provided to the LLM. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec languageCode: description: >- Language code for Summary. Use language tags defined by @@ -14081,7 +15368,7 @@ components: If specified, the spec will be used to modify the model specification provided to the LLM. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec useSemanticChunks: description: >- If true, answer will be generated from most relevant chunks from top @@ -14091,9 +15378,34 @@ components: source index only points to the search results listed in the reference list. type: boolean - GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec: + GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecMultiModalSpec: id: >- - GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec + GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecMultiModalSpec + description: >- + Multimodal specification: Will return an image from specified source. If + multiple sources are specified, the pick is a quality based decision. + type: object + properties: + imageSource: + description: Optional. Source of image returned in the answer. + type: string + enumDescriptions: + - >- + Unspecified image source (multimodal feature is disabled by + default). + - >- + Behavior when service determines the pick from all available + sources. + - Includes image from corpus in the answer. + - Triggers figure generation in the answer. + enum: + - IMAGE_SOURCE_UNSPECIFIED + - ALL_AVAILABLE_SOURCES + - CORPUS_IMAGE_ONLY + - FIGURE_GENERATION_ONLY + GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec: + id: >- + GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec description: Specification of the prompt to use with the model. type: object properties: @@ -14102,9 +15414,9 @@ components: Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide. type: string - GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec: + GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec: id: >- - GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec + GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec description: Specification of the model. type: object properties: @@ -14119,9 +15431,9 @@ components: information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). type: string - GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec: + GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec: id: >- - GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec + GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec description: >- A specification for configuring the extractive content in a search response. @@ -14172,8 +15484,8 @@ components: segments. type: integer format: int32 - GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec: - id: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec + GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec: + id: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec description: >- Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is @@ -14194,8 +15506,8 @@ components: returned. type: integer format: int32 - GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec: - id: GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec + GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec: + id: GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec description: >- The specification that uses customized query embedding vector to do semantic document retrieval. @@ -14206,10 +15518,10 @@ components: type: array items: $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector - GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector: + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector + GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector: id: >- - GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector + GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector description: Embedding vector. type: object properties: @@ -14222,9 +15534,9 @@ components: items: type: number format: float - GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec: + GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec: id: >- - GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec + GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec description: >- Specification to enable natural language understanding capabilities for search requests. @@ -14232,11 +15544,11 @@ components: properties: filterExtractionCondition: description: >- - The condition under which filter extraction should occur. Default to - Condition.DISABLED. + The condition under which filter extraction should occur. Server + behavior defaults to `DISABLED`. type: string enumDescriptions: - - Server behavior defaults to Condition.DISABLED. + - Server behavior defaults to `DISABLED`. - Disables NL filter extraction. - Enables NL filter extraction. enum: @@ -14253,8 +15565,37 @@ components: type: array items: type: string - GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec: - id: GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec + extractedFilterBehavior: + description: >- + Optional. Controls behavior of how extracted filters are applied to + the search. The default behavior depends on the request. For single + datastore structured search, the default is `HARD_FILTER`. For + multi-datastore search, the default behavior is `SOFT_BOOST`. + Location-based filters are always applied as hard filters, and the + `SOFT_BOOST` setting will not affect them. This field is only used + if + SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition + is set to FilterExtractionCondition.ENABLED. + type: string + enumDescriptions: + - >- + `EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED` will use the default + behavior for extracted filters. For single datastore search, the + default is to apply as hard filters. For multi-datastore search, + the default is to apply as soft boosts. + - >- + Applies all extracted filters as hard filters on the results. + Results that do not pass the extracted filters will not be + returned in the result set. + - >- + Applies all extracted filters as soft boosts. Results that pass + the filters will be boosted up to higher ranks in the result set. + enum: + - EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED + - HARD_FILTER + - SOFT_BOOST + GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec: + id: GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec description: Specification for search as you type in search requests. type: object properties: @@ -14267,20 +15608,50 @@ components: - Server behavior defaults to Condition.DISABLED. - Disables Search As You Type. - Enables Search As You Type. + - >- + Automatic switching between search-as-you-type and standard search + modes, ideal for single-API implementations (e.g., debouncing). enum: - CONDITION_UNSPECIFIED - DISABLED - ENABLED - GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec: - id: GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec - description: >- - Session specification. Multi-turn Search feature is currently at private - GA stage. Please use v1alpha or v1beta version instead before we launch - this feature to public GA. Or ask for allowlisting through Google - Support team. + - AUTO + GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec: + id: GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec + description: Defines custom fine tuning spec. type: object properties: - queryId: + enableSearchAdaptor: + description: >- + Whether or not to enable and include custom fine tuned search + adaptor model. + type: boolean + GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec: + id: GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec + description: Specifies features for display, like match highlighting. + type: object + properties: + matchHighlightingCondition: + description: The condition under which match highlighting should occur. + type: string + enumDescriptions: + - Server behavior is the same as `MATCH_HIGHLIGHTING_DISABLED`. + - Disables match highlighting on all documents. + - Enables match highlighting on all documents. + enum: + - MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED + - MATCH_HIGHLIGHTING_DISABLED + - MATCH_HIGHLIGHTING_ENABLED + GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec: + id: GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec + description: >- + Session specification. Multi-turn Search feature is currently at private + GA stage. Please use v1alpha or v1beta version instead before we launch + this feature to public GA. Or ask for allowlisting through Google + Support team. + type: object + properties: + queryId: description: >- If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: @@ -14299,13 +15670,13 @@ components: description: >- The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field - is simliar to the `summary_result_count` field in + is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. type: integer format: int32 - GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec: - id: GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec + GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec: + id: GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec description: The specification for personalization. type: object properties: @@ -14324,19 +15695,30 @@ components: - MODE_UNSPECIFIED - AUTO - DISABLED - GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec: - id: GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec + GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec: + id: GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec + description: The specification for returning the document relevance score. + type: object + properties: + returnRelevanceScore: + description: >- + Optional. Whether to return the relevance score for search results. + The higher the score, the more relevant the document is to the + query. + type: boolean + GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec: + id: GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec description: Describes the specification of the query set. type: object properties: sampleQuerySet: description: >- - Required. The full resource name of the SampleQuerySet used for the + Optional. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. type: string - GoogleCloudDiscoveryengineV1betaQualityMetrics: - id: GoogleCloudDiscoveryengineV1betaQualityMetrics + GoogleCloudDiscoveryengineV1alphaQualityMetrics: + id: GoogleCloudDiscoveryengineV1alphaQualityMetrics description: Describes the metrics produced by the evaluation. type: object properties: @@ -14348,7 +15730,7 @@ components: 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6 $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics + #/components/schemas/GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics docPrecision: description: >- Precision per document, at various top-k cutoff levels. Precision is @@ -14356,7 +15738,7 @@ components: (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8 $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics + #/components/schemas/GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics docNdcg: description: >- Normalized discounted cumulative gain (NDCG) per document, at @@ -14369,7 +15751,7 @@ components: 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693 $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics + #/components/schemas/GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics pageRecall: description: >- Recall per page, at various top-k cutoff levels. Recall is the @@ -14377,7 +15759,7 @@ components: Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6 $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics + #/components/schemas/GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics pageNdcg: description: >- Normalized discounted cumulative gain (NDCG) per page, at various @@ -14390,9 +15772,9 @@ components: + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693 $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics - GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics: - id: GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics + #/components/schemas/GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics + GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics: + id: GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics description: Stores the metric values at specific top-k levels. type: object properties: @@ -14412,47 +15794,88 @@ components: description: The top-10 value. type: number format: double - GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse: - id: GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse - description: Response message for SiteSearchEngineService.FetchSitemaps method. + GoogleCloudDiscoveryengineV1alphaExportMetricsMetadata: + id: GoogleCloudDiscoveryengineV1alphaExportMetricsMetadata + description: >- + Metadata related to the progress of the Export operation. This is + returned by the google.longrunning.Operation.metadata field. type: object properties: - sitemapsMetadata: - description: List of Sitemaps fetched. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaFetchSitemapsResponseSitemapMetadata - GoogleCloudDiscoveryengineV1betaFetchSitemapsResponseSitemapMetadata: - id: GoogleCloudDiscoveryengineV1betaFetchSitemapsResponseSitemapMetadata - description: Contains a Sitemap and its metadata. + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1alphaExportMetricsResponse: + id: GoogleCloudDiscoveryengineV1alphaExportMetricsResponse + description: >- + Response of the ExportMetricsRequest. If the long running operation was + successful, then this message is returned by the + google.longrunning.Operations.response field. type: object - properties: - sitemap: - description: The Sitemap. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1betaSitemap' - GoogleCloudDiscoveryengineV1betaSitemap: - id: GoogleCloudDiscoveryengineV1betaSitemap - description: A sitemap for the SiteSearchEngine. + properties: {} + GoogleCloudDiscoveryengineV1alphaGetSessionRequest: + id: GoogleCloudDiscoveryengineV1alphaGetSessionRequest + description: Request for GetSession method. type: object properties: - uri: - description: Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`. - type: string name: description: >- - Output only. The fully qualified resource name of the sitemap. - `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/*` - The `sitemap_id` suffix is system-generated. - readOnly: true + Required. The resource name of the Session to get. Format: + `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` type: string - createTime: - description: Output only. The sitemap's creation time. - readOnly: true + includeAnswerDetails: + description: >- + Optional. If set to true, the full session including all answer + details will be returned. + type: boolean + GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse: + id: GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse + description: >- + Response message for SiteSearchEngineService.GetUriPatternDocumentData + method. + type: object + properties: + documentDataMap: + description: >- + Document data keyed by URI pattern. For example: document_data_map = + { "www.url1.com/*": { "Categories": ["category1", "category2"] }, + "www.url2.com/*": { "Categories": ["category3"] } } + type: object + additionalProperties: + type: object + additionalProperties: + type: any + description: Properties of the object. + GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata: + id: GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata + description: >- + IdentityMappingEntry LongRunningOperation metadata for + IdentityMappingStoreService.ImportIdentityMappings and + IdentityMappingStoreService.PurgeIdentityMappings + type: object + properties: + successCount: + description: >- + The number of IdentityMappingEntries that were successfully + processed. type: string - format: google-datetime - GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata: - id: GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata + format: int64 + failureCount: + description: The number of IdentityMappingEntries that failed to be processed. + type: string + format: int64 + totalCount: + description: The total number of IdentityMappingEntries that were processed. + type: string + format: int64 + GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata: + id: GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata description: >- Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the @@ -14477,8 +15900,8 @@ components: description: Count of CompletionSuggestions that failed to be imported. type: string format: int64 - GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsResponse: - id: GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsResponse + GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse: + id: GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse description: >- Response of the CompletionService.ImportCompletionSuggestions method. If the long running operation is done, this message is returned by the @@ -14494,9 +15917,9 @@ components: errorConfig: description: The desired location of errors incurred during the Import. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaImportErrorConfig - GoogleCloudDiscoveryengineV1betaImportErrorConfig: - id: GoogleCloudDiscoveryengineV1betaImportErrorConfig + #/components/schemas/GoogleCloudDiscoveryengineV1alphaImportErrorConfig + GoogleCloudDiscoveryengineV1alphaImportErrorConfig: + id: GoogleCloudDiscoveryengineV1alphaImportErrorConfig description: Configuration of destination for Import related errors. type: object properties: @@ -14507,8 +15930,8 @@ components: sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message. type: string - GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata: - id: GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata + GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata: + id: GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata description: >- Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field. @@ -14536,8 +15959,8 @@ components: description: Total count of entries that were processed. type: string format: int64 - GoogleCloudDiscoveryengineV1betaImportDocumentsResponse: - id: GoogleCloudDiscoveryengineV1betaImportDocumentsResponse + GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse: + id: GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse description: >- Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the @@ -14555,9 +15978,19 @@ components: Echoes the destination for the complete errors in the request if set. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaImportErrorConfig - GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata: - id: GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata + #/components/schemas/GoogleCloudDiscoveryengineV1alphaImportErrorConfig + GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsResponse: + id: GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsResponse + description: Response message for IdentityMappingStoreService.ImportIdentityMappings + type: object + properties: + errorSamples: + description: A sample of errors encountered while processing the request. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata: + id: GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata description: >- Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata @@ -14586,8 +16019,8 @@ components: description: Total count of SampleQuerys that were processed. type: string format: int64 - GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse: - id: GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse + GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse: + id: GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse description: >- Response of the SampleQueryService.ImportSampleQueries method. If the long running operation is done, this message is returned by the @@ -14603,9 +16036,9 @@ components: errorConfig: description: The desired location of errors incurred during the Import. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaImportErrorConfig - GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata: - id: GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata + #/components/schemas/GoogleCloudDiscoveryengineV1alphaImportErrorConfig + GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata: + id: GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata description: >- Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata @@ -14622,8 +16055,8 @@ components: the finish time. type: string format: google-datetime - GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse: - id: GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse + GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse: + id: GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse description: >- Response message for CompletionService.ImportSuggestionDenyListEntries method. @@ -14642,8 +16075,8 @@ components: description: Count of deny list entries that failed to be imported. type: string format: int64 - GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata: - id: GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata + GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata: + id: GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata description: >- Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field. @@ -14667,8 +16100,8 @@ components: description: Count of entries that encountered errors while processing. type: string format: int64 - GoogleCloudDiscoveryengineV1betaImportUserEventsResponse: - id: GoogleCloudDiscoveryengineV1betaImportUserEventsResponse + GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse: + id: GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse description: >- Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the @@ -14686,7 +16119,7 @@ components: Echoes the destination for the complete errors if this field was set in the request. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaImportErrorConfig + #/components/schemas/GoogleCloudDiscoveryengineV1alphaImportErrorConfig joinedEventsCount: description: Count of user events imported with complete existing Documents. type: string @@ -14697,591 +16130,5730 @@ components: found in the existing Branch. type: string format: int64 - GoogleCloudDiscoveryengineV1betaListCustomModelsResponse: - id: GoogleCloudDiscoveryengineV1betaListCustomModelsResponse - description: Response message for SearchTuningService.ListCustomModels method. + GoogleCloudDiscoveryengineV1alphaListSessionsRequest: + id: GoogleCloudDiscoveryengineV1alphaListSessionsRequest + description: Request for ListSessions method. type: object properties: - models: - description: List of custom tuning models. + parent: + description: >- + Required. The data store resource name. Format: + `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` + type: string + pageSize: + description: >- + Maximum number of results to return. If unspecified, defaults to 50. + Max allowed value is 1000. + type: integer + format: int32 + pageToken: + description: >- + A page token, received from a previous `ListSessions` call. Provide + this to retrieve the subsequent page. + type: string + filter: + description: >- + A comma-separated list of fields to filter by, in EBNF grammar. The + supported fields are: * `user_pseudo_id` * `state` * `display_name` + * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` + Examples: * `user_pseudo_id = some_id` * `display_name = + "some_name"` * `starred = true` * `is_pinned=true AND (NOT + labels:hidden)` * `create_time > "1970-01-01T12:00:00Z"` + type: string + orderBy: + description: >- + A comma-separated list of fields to order by, sorted in ascending + order. Use "desc" after a field name for descending. Supported + fields: * `update_time` * `create_time` * `session_name` * + `is_pinned` Example: * `update_time desc` * `create_time` * + `is_pinned desc,update_time desc`: list sessions by is_pinned first, + then by update_time. + type: string + GoogleCloudDiscoveryengineV1alphaListSessionsResponse: + id: GoogleCloudDiscoveryengineV1alphaListSessionsResponse + description: Response for ListSessions method. + type: object + properties: + sessions: + description: All the Sessions for a given data store. type: array items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaCustomTuningModel - GoogleCloudDiscoveryengineV1betaCustomTuningModel: - id: GoogleCloudDiscoveryengineV1betaCustomTuningModel - description: Metadata that describes a custom tuned model. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaSession' + nextPageToken: + description: Pagination token, if not returned indicates the last page. + type: string + GoogleCloudDiscoveryengineV1alphaSession: + id: GoogleCloudDiscoveryengineV1alphaSession + description: External session proto definition. type: object properties: name: description: >- - Required. The fully qualified resource name of the model. Format: - `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`. - Model must be an alpha-numerical string with limit of 40 characters. + Immutable. Fully qualified name + `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` type: string displayName: - description: The display name of the model. - type: string - modelVersion: - description: The version of the model. - type: string - format: int64 - modelState: description: >- - The state that the model is in (e.g.`TRAINING` or - `TRAINING_FAILED`). + Optional. The display name of the session. This field is used to + identify the session in the UI. By default, the display name is the + first turn query text in the session. + type: string + state: + description: The state of the session. type: string enumDescriptions: - - Default value. - - The model is in a paused training state. - - The model is currently training. - - The model has successfully completed training. - - The model is ready for serving. - - The model training failed. - - >- - The model training finished successfully but metrics did not - improve. - - Input data validation failed. Model training didn't start. + - State is unspecified. + - The session is currently open. enum: - - MODEL_STATE_UNSPECIFIED - - TRAINING_PAUSED - - TRAINING - - TRAINING_COMPLETE - - READY_FOR_SERVING - - TRAINING_FAILED - - NO_IMPROVEMENT - - INPUT_VALIDATION_FAILED - createTime: - description: 'Deprecated: Timestamp the Model was created at.' - deprecated: true - type: string - format: google-datetime - trainingStartTime: - description: Timestamp the model training was initiated. - type: string - format: google-datetime - metrics: - description: The metrics of the trained model. - type: object - additionalProperties: - type: number - format: double - errorMessage: - description: >- - Currently this is only populated if the model state is - `INPUT_VALIDATION_FAILED`. - type: string - GoogleCloudDiscoveryengineV1betaProject: - id: GoogleCloudDiscoveryengineV1betaProject - description: Metadata and configurations for a Google Cloud project in the service. - type: object - properties: - name: - description: >- - Output only. Full resource name of the project, for example - `projects/{project}`. Note that when making requests, project number - and project id are both acceptable, but the server will always - respond in project number. - readOnly: true + - STATE_UNSPECIFIED + - IN_PROGRESS + userPseudoId: + description: A unique identifier for tracking users. type: string - createTime: - description: Output only. The timestamp when this project is created. + turns: + description: Turns. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaSessionTurn' + startTime: + description: Output only. The time the session started. readOnly: true type: string format: google-datetime - provisionCompletionTime: - description: >- - Output only. The timestamp when this project is successfully - provisioned. Empty value means this project is still provisioning - and is not ready for use. + endTime: + description: Output only. The time the session finished. readOnly: true type: string format: google-datetime - serviceTermsMap: + isPinned: description: >- - Output only. A map of terms of services. The key is the `id` of - ServiceTerms. - readOnly: true - type: object - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaProjectServiceTerms - GoogleCloudDiscoveryengineV1betaProjectServiceTerms: - id: GoogleCloudDiscoveryengineV1betaProjectServiceTerms - description: Metadata about the terms of service. + Optional. Whether the session is pinned, pinned session will be + displayed on the top of the session list. + type: boolean + GoogleCloudDiscoveryengineV1alphaSessionTurn: + id: GoogleCloudDiscoveryengineV1alphaSessionTurn + description: >- + Represents a turn, including a query from the user and a answer from + service. type: object properties: - id: + query: description: >- - The unique identifier of this terms of service. Available terms: * - `GA_DATA_USE_TERMS`: [Terms for data - use](https://cloud.google.com/retail/data-use-terms). When using - this as `id`, the acceptable version to provide is `2022-11-23`. - type: string - version: + Optional. The user query. May not be set if this turn is merely + regenerating an answer to a different turn + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaQuery' + answer: description: >- - The version string of the terms of service. For acceptable values, - see the comments for id above. + Optional. The resource name of the answer to the user query. Only + set if the answer generation (/answer API call) happened in this + turn. type: string - state: + detailedAnswer: description: >- - Whether the project has accepted/rejected the service terms or it is - still pending. - type: string - enumDescriptions: - - The default value of the enum. This value is not actually used. - - The project has given consent to the terms of service. - - The project is pending to review and accept the terms of service. - - >- - The project has declined or revoked the agreement to terms of - service. - enum: - - STATE_UNSPECIFIED - - TERMS_ACCEPTED - - TERMS_PENDING - - TERMS_DECLINED - acceptTime: - description: The last time when the project agreed to the terms of service. - type: string - format: google-datetime - declineTime: + Output only. In ConversationalSearchService.GetSession API, if + GetSessionRequest.include_answer_details is set to true, this field + will be populated when getting answer query session. + readOnly: true + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaAnswer' + queryConfig: description: >- - The last time when the project declined or revoked the agreement to - terms of service. - type: string - format: google-datetime - GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata: - id: GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata - description: Metadata associated with a project provision operation. - type: object - properties: {} - GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata: - id: GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata - description: >- - Metadata related to the progress of the PurgeDocuments operation. This - will be returned by the google.longrunning.Operation.metadata field. + Optional. Represents metadata related to the query config, for + example LLM model and version used, model parameters (temperature, + grounding parameters, etc.). The prefix "google." is reserved for + Google-developed functionality. + type: object + additionalProperties: + type: string + GoogleCloudDiscoveryengineV1alphaQuery: + id: GoogleCloudDiscoveryengineV1alphaQuery + description: Defines a user inputed query. type: object properties: - createTime: - description: Operation create time. - type: string - format: google-datetime - updateTime: - description: >- - Operation last update time. If the operation is done, this is also - the finish time. - type: string - format: google-datetime - successCount: - description: Count of entries that were deleted successfully. - type: string - format: int64 - failureCount: - description: Count of entries that encountered errors while processing. + text: + description: Plain text. type: string - format: int64 - ignoredCount: - description: Count of entries that were ignored as entries were not found. + queryId: + description: Output only. Unique Id for the query. + readOnly: true type: string - format: int64 - GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse: - id: GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse + GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse: + id: GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse description: >- - Response message for DocumentService.PurgeDocuments method. If the long - running operation is successfully done, then this message is returned by - the google.longrunning.Operations.response field. + Response message for CrawlRateManagementService.ObtainCrawlRate method. + The response contains organcic or dedicated crawl rate time series data + for monitoring, depending on whether dedicated crawl rate is set. type: object properties: - purgeCount: - description: The total count of documents purged as a result of the operation. - type: string - format: int64 - purgeSample: + organicCrawlRateTimeSeries: description: >- - A sample of document names that will be deleted. Only populated if - `force` is set to false. A max of 100 names will be returned and the - names are chosen at random. - type: array - items: - type: string - GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata: - id: GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata + The historical organic crawl rate timeseries data, used for + monitoring. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaOrganicCrawlRateTimeSeries + dedicatedCrawlRateTimeSeries: + description: >- + The historical dedicated crawl rate timeseries data, used for + monitoring. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries + state: + description: Output only. The state of the response. + readOnly: true + type: string + enumDescriptions: + - The state is unspecified. + - The state is successful. + - The state is failed. + enum: + - STATE_UNSPECIFIED + - SUCCEEDED + - FAILED + error: + description: Errors from service when handling the request. + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudDiscoveryengineV1alphaOrganicCrawlRateTimeSeries: + id: GoogleCloudDiscoveryengineV1alphaOrganicCrawlRateTimeSeries description: >- - Metadata related to the progress of the PurgeSuggestionDenyListEntries - operation. This is returned by the google.longrunning.Operation.metadata - field. + The historical organic crawl rate timeseries data, used for monitoring. + Organic crawl is auto-determined by Google to crawl the user's website + when dedicate crawl is not set. Crawl rate is the QPS of crawl request + Google sends to the user's website. type: object properties: - createTime: - description: Operation create time. - type: string - format: google-datetime - updateTime: + googleOrganicCrawlRate: description: >- - Operation last update time. If the operation is done, this is also - the finish time. - type: string - format: google-datetime - GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse: - id: GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse - description: >- - Response message for CompletionService.PurgeSuggestionDenyListEntries - method. + Google's organic crawl rate time series, which is the sum of all + googlebots' crawl rate. Please refer to + https://developers.google.com/search/docs/crawling-indexing/overview-google-crawlers + for more details about googlebots. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries + vertexAiOrganicCrawlRate: + description: >- + Vertex AI's organic crawl rate time series, which is the crawl rate + of Google-CloudVertexBot when dedicate crawl is not set. Please + refer to + https://developers.google.com/search/docs/crawling-indexing/google-common-crawlers#google-cloudvertexbot + for more details about Google-CloudVertexBot. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries + GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries: + id: GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries + description: The historical crawl rate timeseries data, used for monitoring. type: object properties: - purgeCount: - description: Number of suggestion deny list entries purged. - type: string - format: int64 - errorSamples: - description: A sample of errors encountered while processing the request. - type: array - items: - $ref: '#/components/schemas/GoogleRpcStatus' - GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata: - id: GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata + qpsTimeSeries: + description: The QPS of the crawl rate. + $ref: '#/components/schemas/GoogleMonitoringV3TimeSeries' + GoogleMonitoringV3TimeSeries: + id: GoogleMonitoringV3TimeSeries description: >- - Metadata related to the progress of the TrainCustomModel operation. This - is returned by the google.longrunning.Operation.metadata field. + A collection of data points that describes the time-varying values of a + metric. A time series is identified by a combination of a + fully-specified monitored resource and a fully-specified metric. This + type is used for both listing and creating time series. type: object properties: - createTime: - description: Operation create time. + metric: + description: >- + The associated metric. A fully-specified metric used to identify the + time series. + $ref: '#/components/schemas/GoogleApiMetric' + resource: + description: >- + The associated monitored resource. Custom metrics can use only + certain monitored resource types in their time series data. For more + information, see [Monitored resources for custom + metrics](https://cloud.google.com/monitoring/custom-metrics/creating-metrics#custom-metric-resources). + $ref: '#/components/schemas/GoogleApiMonitoredResource' + metadata: + description: >- + Output only. The associated monitored resource metadata. When + reading a time series, this field will include metadata labels that + are explicitly named in the reduction. When creating a time series, + this field is ignored. + $ref: '#/components/schemas/GoogleApiMonitoredResourceMetadata' + metricKind: + description: >- + The metric kind of the time series. When listing time series, this + metric kind might be different from the metric kind of the + associated metric if this time series is an alignment or reduction + of other time series. When creating a time series, this field is + optional. If present, it must be the same as the metric kind of the + associated metric. If the associated metric's descriptor must be + auto-created, then this field specifies the metric kind of the new + descriptor and must be either `GAUGE` (the default) or `CUMULATIVE`. type: string - format: google-datetime - updateTime: + enumDescriptions: + - Do not use this default value. + - An instantaneous measurement of a value. + - The change in a value during a time interval. + - >- + A value accumulated over a time interval. Cumulative measurements + in a time series should have the same start time and increasing + end times, until an event resets the cumulative value to zero and + sets a new start time for the following points. + enum: + - METRIC_KIND_UNSPECIFIED + - GAUGE + - DELTA + - CUMULATIVE + valueType: description: >- - Operation last update time. If the operation is done, this is also - the finish time. + The value type of the time series. When listing time series, this + value type might be different from the value type of the associated + metric if this time series is an alignment or reduction of other + time series. When creating a time series, this field is optional. If + present, it must be the same as the type of the data in the `points` + field. type: string - format: google-datetime - GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse: - id: GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse - description: >- - Response of the TrainCustomModelRequest. This message is returned by the - google.longrunning.Operations.response field. - type: object - properties: - errorSamples: - description: A sample of errors encountered while processing the data. + enumDescriptions: + - Do not use this default value. + - >- + The value is a boolean. This value type can be used only if the + metric kind is `GAUGE`. + - The value is a signed 64-bit integer. + - The value is a double precision floating point number. + - >- + The value is a text string. This value type can be used only if + the metric kind is `GAUGE`. + - The value is a `Distribution`. + - The value is money. + enum: + - VALUE_TYPE_UNSPECIFIED + - BOOL + - INT64 + - DOUBLE + - STRING + - DISTRIBUTION + - MONEY + points: + description: >- + The data points of this time series. When listing time series, + points are returned in reverse time order. When creating a time + series, this field must contain exactly one point and the point's + type must be the same as the value type of the associated metric. If + the associated metric's descriptor must be auto-created, then the + value type of the descriptor is determined by the point's type, + which must be `BOOL`, `INT64`, `DOUBLE`, or `DISTRIBUTION`. type: array items: - $ref: '#/components/schemas/GoogleRpcStatus' - errorConfig: + $ref: '#/components/schemas/GoogleMonitoringV3Point' + unit: description: >- - Echoes the destination for the complete errors in the request if - set. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaImportErrorConfig - modelStatus: + The units in which the metric value is reported. It is only + applicable if the `value_type` is `INT64`, `DOUBLE`, or + `DISTRIBUTION`. The `unit` defines the representation of the stored + metric values. This field can only be changed through + CreateTimeSeries when it is empty. + type: string + description: description: >- - The trained model status. Possible values are: * **bad-data**: The - training data quality is bad. * **no-improvement**: Tuning didn't - improve performance. Won't deploy. * **in-progress**: Model training - job creation is in progress. * **training**: Model is actively - training. * **evaluating**: The model is evaluating trained metrics. - * **indexing**: The model trained metrics are indexing. * **ready**: - The model is ready for serving. + Input only. A detailed description of the time series that will be + associated with the google.api.MetricDescriptor for the metric. Once + set, this field cannot be changed through CreateTimeSeries. type: string - metrics: - description: The metrics of the trained model. + GoogleApiMetric: + id: GoogleApiMetric + description: >- + A specific metric, identified by specifying values for all of the labels + of a `MetricDescriptor`. + type: object + properties: + type: + description: >- + An existing metric type, see google.api.MetricDescriptor. For + example, `custom.googleapis.com/invoice/paid/amount`. + type: string + labels: + description: >- + The set of label values that uniquely identify this metric. All + labels listed in the `MetricDescriptor` must be assigned values. type: object additionalProperties: - type: number - format: double - modelName: - description: Fully qualified name of the CustomTuningModel. - type: string - GoogleCloudDiscoveryengineV1betaTuneEngineMetadata: - id: GoogleCloudDiscoveryengineV1betaTuneEngineMetadata - description: Metadata associated with a tune operation. + type: string + GoogleApiMonitoredResource: + id: GoogleApiMonitoredResource + description: >- + An object representing a resource that can be used for monitoring, + logging, billing, or other purposes. Examples include virtual machine + instances, databases, and storage devices such as disks. The `type` + field identifies a MonitoredResourceDescriptor object that describes the + resource's schema. Information in the `labels` field identifies the + actual resource and its attributes according to the schema. For example, + a particular Compute Engine VM instance could be represented by the + following object, because the MonitoredResourceDescriptor for + `"gce_instance"` has labels `"project_id"`, `"instance_id"` and + `"zone"`: { "type": "gce_instance", "labels": { "project_id": + "my-project", "instance_id": "12345678901234", "zone": "us-central1-a" + }} type: object properties: - engine: + type: description: >- - Required. The resource name of the engine that this tune applies to. - Format: - `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}` + Required. The monitored resource type. This field must match the + `type` field of a MonitoredResourceDescriptor object. For example, + the type of a Compute Engine VM instance is `gce_instance`. Some + descriptors include the service name in the type; for example, the + type of a Datastream stream is `datastream.googleapis.com/Stream`. type: string - GoogleCloudDiscoveryengineV1betaTuneEngineResponse: - id: GoogleCloudDiscoveryengineV1betaTuneEngineResponse - description: Response associated with a tune operation. + labels: + description: >- + Required. Values for all of the labels listed in the associated + monitored resource descriptor. For example, Compute Engine VM + instances use the labels `"project_id"`, `"instance_id"`, and + `"zone"`. + type: object + additionalProperties: + type: string + GoogleApiMonitoredResourceMetadata: + id: GoogleApiMonitoredResourceMetadata + description: >- + Auxiliary metadata for a MonitoredResource object. MonitoredResource + objects contain the minimum set of information to uniquely identify a + monitored resource instance. There is some other useful auxiliary + metadata. Monitoring and Logging use an ingestion pipeline to extract + metadata for cloud resources of all types, and store the metadata in + this message. type: object - properties: {} - GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata: - id: GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata - description: Metadata for UpdateSchema LRO. + properties: + systemLabels: + description: >- + Output only. Values for predefined system metadata labels. System + labels are a kind of metadata extracted by Google, including + "machine_image", "vpc", "subnet_id", "security_group", "name", etc. + System label values can be only strings, Boolean values, or a list + of strings. For example: { "name": "my-test-instance", + "security_group": ["a", "b", "c"], "spot_instance": false } + type: object + additionalProperties: + type: any + description: Properties of the object. + userLabels: + description: Output only. A map of user-defined metadata labels. + type: object + additionalProperties: + type: string + GoogleMonitoringV3Point: + id: GoogleMonitoringV3Point + description: A single data point in a time series. type: object properties: - createTime: - description: Operation create time. - type: string - format: google-datetime - updateTime: + interval: description: >- - Operation last update time. If the operation is done, this is also - the finish time. - type: string - format: google-datetime - GoogleCloudDiscoveryengineV1betaUpdateTargetSiteMetadata: - id: GoogleCloudDiscoveryengineV1betaUpdateTargetSiteMetadata + The time interval to which the data point applies. For `GAUGE` + metrics, the start time is optional, but if it is supplied, it must + equal the end time. For `DELTA` metrics, the start and end time + should specify a non-zero interval, with subsequent points + specifying contiguous and non-overlapping intervals. For + `CUMULATIVE` metrics, the start and end time should specify a + non-zero interval, with subsequent points specifying the same start + time and increasing end times, until an event resets the cumulative + value to zero and sets a new start time for the following points. + $ref: '#/components/schemas/GoogleMonitoringV3TimeInterval' + value: + description: The value of the data point. + $ref: '#/components/schemas/GoogleMonitoringV3TypedValue' + GoogleMonitoringV3TimeInterval: + id: GoogleMonitoringV3TimeInterval description: >- - Metadata related to the progress of the - SiteSearchEngineService.UpdateTargetSite operation. This will be - returned by the google.longrunning.Operation.metadata field. + A time interval extending just after a start time through an end time. + If the start time is the same as the end time, then the interval + represents a single point in time. type: object properties: - createTime: - description: Operation create time. + endTime: + description: Required. The end of the time interval. type: string format: google-datetime - updateTime: + startTime: description: >- - Operation last update time. If the operation is done, this is also - the finish time. + Optional. The beginning of the time interval. The default value for + the start time is the end time. The start time must not be later + than the end time. type: string format: google-datetime - parameters: - 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: - type: string - enum: - - json - - media - - proto - 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: + GoogleMonitoringV3TypedValue: + id: GoogleMonitoringV3TypedValue + description: A single strongly-typed value. + type: object + properties: + boolValue: + description: 'A Boolean value: `true` or `false`.' + type: boolean + int64Value: + description: A 64-bit integer. Its range is approximately ±9.2x1018. + type: string + format: int64 + doubleValue: + description: >- + A 64-bit double-precision floating-point number. Its magnitude is + approximately ±10±300 and it has 16 significant digits of precision. + type: number + format: double + stringValue: + description: A variable-length string value. + type: string + distributionValue: + description: A distribution value. + $ref: '#/components/schemas/GoogleApiDistribution' + GoogleApiDistribution: + id: GoogleApiDistribution 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: + `Distribution` contains summary statistics for a population of values. + It optionally contains a histogram representing the distribution of + those values across a set of buckets. The summary statistics are the + count, mean, sum of the squared deviation from the mean, the minimum, + and the maximum of the set of population of values. The histogram is + based on a sequence of buckets and gives a count of values that fall + into each bucket. The boundaries of the buckets are given either + explicitly or by formulas for buckets of fixed or exponentially + increasing widths. Although it is not forbidden, it is generally a bad + idea to include non-finite values (infinities or NaNs) in the population + of values, as this will render the `mean` and `sum_of_squared_deviation` + fields meaningless. + type: object + properties: + count: + description: >- + The number of values in the population. Must be non-negative. This + value must equal the sum of the values in `bucket_counts` if a + histogram is provided. + type: string + format: int64 + mean: + description: >- + The arithmetic mean of the values in the population. If `count` is + zero then this field must be zero. + type: number + format: double + sumOfSquaredDeviation: + description: >- + The sum of squared deviations from the mean of the values in the + population. For values x_i this is: Sum[i=1..n]((x_i - mean)^2) + Knuth, "The Art of Computer Programming", Vol. 2, page 232, 3rd + edition describes Welford's method for accumulating this sum in one + pass. If `count` is zero then this field must be zero. + type: number + format: double + range: + description: >- + If specified, contains the range of the population values. The field + must not be present if the `count` is zero. + $ref: '#/components/schemas/GoogleApiDistributionRange' + bucketOptions: + description: >- + Defines the histogram bucket boundaries. If the distribution does + not contain a histogram, then omit this field. + $ref: '#/components/schemas/GoogleApiDistributionBucketOptions' + bucketCounts: + description: >- + The number of values in each bucket of the histogram, as described + in `bucket_options`. If the distribution does not have a histogram, + then omit this field. If there is a histogram, then the sum of the + values in `bucket_counts` must equal the value in the `count` field + of the distribution. If present, `bucket_counts` should contain N + values, where N is the number of buckets specified in + `bucket_options`. If you supply fewer than N values, the remaining + values are assumed to be 0. The order of the values in + `bucket_counts` follows the bucket numbering schemes described for + the three bucket types. The first value must be the count for the + underflow bucket (number 0). The next N-2 values are the counts for + the finite buckets (number 1 through N-2). The N'th value in + `bucket_counts` is the count for the overflow bucket (number N-1). + type: array + items: + type: string + format: int64 + exemplars: + description: Must be in increasing order of `value` field. + type: array + items: + $ref: '#/components/schemas/GoogleApiDistributionExemplar' + GoogleApiDistributionRange: + id: GoogleApiDistributionRange + description: The range of the population values. + type: object + properties: + min: + description: The minimum of the population values. + type: number + format: double + max: + description: The maximum of the population values. + type: number + format: double + GoogleApiDistributionBucketOptions: + id: GoogleApiDistributionBucketOptions 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 - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string - _.xgafv: - description: V1 error format. - in: query - name: $.xgafv - schema: - type: string - enum: - - '1' - - '2' - x-stackQL-resources: - projects: - id: google.discoveryengine.projects - name: projects - title: Projects - methods: - projects_provision: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}:provision/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: [] - operations: - id: google.discoveryengine.operations - name: operations - title: Operations - methods: - projects_operations_list: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1operations/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.operations - projects_operations_get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1operations~1{operationsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - projects_operations_cancel: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1operations~1{operationsId}:cancel/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_collections_data_connector_operations_list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataConnector~1operations/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.operations - projects_locations_collections_data_connector_operations_get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataConnector~1operations~1{operationsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_collections_operations_list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1operations/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.operations - projects_locations_collections_operations_get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1operations~1{operationsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_collections_data_stores_models_operations_list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1models~1{modelsId}~1operations/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.operations - projects_locations_collections_data_stores_models_operations_get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1models~1{modelsId}~1operations~1{operationsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_collections_data_stores_operations_list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1operations/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.operations - projects_locations_collections_data_stores_branches_operations_list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1branches~1{branchesId}~1operations/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.operations - projects_locations_collections_data_stores_branches_operations_get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1branches~1{branchesId}~1operations~1{operationsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_collections_data_stores_branches_operations_cancel: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1branches~1{branchesId}~1operations~1{operationsId}:cancel/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_collections_data_stores_schemas_operations_list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1schemas~1{schemasId}~1operations/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.operations - projects_locations_collections_data_stores_schemas_operations_get: - operation: + `BucketOptions` describes the bucket boundaries used to create a + histogram for the distribution. The buckets can be in a linear sequence, + an exponential sequence, or each bucket can be specified explicitly. + `BucketOptions` does not include the number of values in each bucket. A + bucket has an inclusive lower bound and exclusive upper bound for the + values that are counted for that bucket. The upper bound of a bucket + must be strictly greater than the lower bound. The sequence of N buckets + for a distribution consists of an underflow bucket (number 0), zero or + more finite buckets (number 1 through N - 2) and an overflow bucket + (number N - 1). The buckets are contiguous: the lower bound of bucket i + (i > 0) is the same as the upper bound of bucket i - 1. The buckets span + the whole range of finite values: lower bound of the underflow bucket is + -infinity and the upper bound of the overflow bucket is +infinity. The + finite buckets are so-called because both bounds are finite. + type: object + properties: + linearBuckets: + description: The linear bucket. + $ref: '#/components/schemas/GoogleApiDistributionBucketOptionsLinear' + exponentialBuckets: + description: The exponential buckets. + $ref: '#/components/schemas/GoogleApiDistributionBucketOptionsExponential' + explicitBuckets: + description: The explicit buckets. + $ref: '#/components/schemas/GoogleApiDistributionBucketOptionsExplicit' + GoogleApiDistributionBucketOptionsLinear: + id: GoogleApiDistributionBucketOptionsLinear + description: >- + Specifies a linear sequence of buckets that all have the same width + (except overflow and underflow). Each bucket represents a constant + absolute uncertainty on the specific value in the bucket. There are + `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the following + boundaries: Upper bound (0 <= i < N-1): offset + (width * i). Lower + bound (1 <= i < N): offset + (width * (i - 1)). + type: object + properties: + numFiniteBuckets: + description: Must be greater than 0. + type: integer + format: int32 + width: + description: Must be greater than 0. + type: number + format: double + offset: + description: Lower bound of the first bucket. + type: number + format: double + GoogleApiDistributionBucketOptionsExponential: + id: GoogleApiDistributionBucketOptionsExponential + description: >- + Specifies an exponential sequence of buckets that have a width that is + proportional to the value of the lower bound. Each bucket represents a + constant relative uncertainty on a specific value in the bucket. There + are `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the following + boundaries: Upper bound (0 <= i < N-1): scale * (growth_factor ^ i). + Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)). + type: object + properties: + numFiniteBuckets: + description: Must be greater than 0. + type: integer + format: int32 + growthFactor: + description: Must be greater than 1. + type: number + format: double + scale: + description: Must be greater than 0. + type: number + format: double + GoogleApiDistributionBucketOptionsExplicit: + id: GoogleApiDistributionBucketOptionsExplicit + description: >- + Specifies a set of buckets with arbitrary widths. There are + `size(bounds) + 1` (= N) buckets. Bucket `i` has the following + boundaries: Upper bound (0 <= i < N-1): bounds[i] Lower bound (1 <= i < + N); bounds[i - 1] The `bounds` field must contain at least one element. + If `bounds` has only one element, then there are no finite buckets, and + that single element is the common boundary of the overflow and underflow + buckets. + type: object + properties: + bounds: + description: The values must be monotonically increasing. + type: array + items: + type: number + format: double + GoogleApiDistributionExemplar: + id: GoogleApiDistributionExemplar + description: >- + Exemplars are example points that may be used to annotate aggregated + distribution values. They are metadata that gives information about a + particular value added to a Distribution bucket, such as a trace ID that + was active when a value was added. They may contain further information, + such as a example values and timestamps, origin, etc. + type: object + properties: + value: + description: >- + Value of the exemplar point. This value determines to which bucket + the exemplar belongs. + type: number + format: double + timestamp: + description: The observation (sampling) time of the above value. + type: string + format: google-datetime + attachments: + description: >- + Contextual information about the example value. Examples are: Trace: + type.googleapis.com/google.monitoring.v3.SpanContext Literal string: + type.googleapis.com/google.protobuf.StringValue Labels dropped + during aggregation: + type.googleapis.com/google.monitoring.v3.DroppedLabels There may be + only a single attachment of any given message type in a single + exemplar, and this is enforced by the system. + type: array + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries: + id: GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries + description: >- + The historical dedicated crawl rate timeseries data, used for + monitoring. Dedicated crawl is used by Vertex AI to crawl the user's + website when dedicate crawl is set. + type: object + properties: + userTriggeredCrawlRate: + description: >- + Vertex AI's dedicated crawl rate time series of user triggered + crawl, which is the crawl rate of Google-CloudVertexBot when + dedicate crawl is set, and user triggered crawl rate is for + deterministic use cases like crawling urls or sitemaps specified by + users. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries + autoRefreshCrawlRate: + description: >- + Vertex AI's dedicated crawl rate time series of auto-refresh, which + is the crawl rate of Google-CloudVertexBot when dedicate crawl is + set, and the crawl rate is for best effort use cases like refreshing + urls periodically. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries + userTriggeredCrawlErrorRate: + description: >- + Vertex AI's error rate time series of user triggered dedicated + crawl. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries + autoRefreshCrawlErrorRate: + description: Vertex AI's error rate time series of auto-refresh dedicated crawl. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries + GoogleCloudDiscoveryengineV1alphaProject: + id: GoogleCloudDiscoveryengineV1alphaProject + description: Metadata and configurations for a Google Cloud project in the service. + type: object + properties: + name: + description: >- + Output only. Full resource name of the project, for example + `projects/{project}`. Note that when making requests, project number + and project id are both acceptable, but the server will always + respond in project number. + readOnly: true + type: string + createTime: + description: Output only. The timestamp when this project is created. + readOnly: true + type: string + format: google-datetime + provisionCompletionTime: + description: >- + Output only. The timestamp when this project is successfully + provisioned. Empty value means this project is still provisioning + and is not ready for use. + readOnly: true + type: string + format: google-datetime + serviceTermsMap: + description: >- + Output only. A map of terms of services. The key is the `id` of + ServiceTerms. + readOnly: true + type: object + additionalProperties: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1schemas~1{schemasId}~1operations~1{operationsId}/get - response: + #/components/schemas/GoogleCloudDiscoveryengineV1alphaProjectServiceTerms + GoogleCloudDiscoveryengineV1alphaProjectServiceTerms: + id: GoogleCloudDiscoveryengineV1alphaProjectServiceTerms + description: Metadata about the terms of service. + type: object + properties: + id: + description: >- + The unique identifier of this terms of service. Available terms: * + `GA_DATA_USE_TERMS`: [Terms for data + use](https://cloud.google.com/retail/data-use-terms). When using + this as `id`, the acceptable version to provide is `2022-11-23`. + type: string + version: + description: >- + The version string of the terms of service. For acceptable values, + see the comments for id above. + type: string + state: + description: >- + Whether the project has accepted/rejected the service terms or it is + still pending. + type: string + enumDescriptions: + - The default value of the enum. This value is not actually used. + - The project has given consent to the terms of service. + - The project is pending to review and accept the terms of service. + - >- + The project has declined or revoked the agreement to terms of + service. + enum: + - STATE_UNSPECIFIED + - TERMS_ACCEPTED + - TERMS_PENDING + - TERMS_DECLINED + acceptTime: + description: The last time when the project agreed to the terms of service. + type: string + format: google-datetime + declineTime: + description: >- + The last time when the project declined or revoked the agreement to + terms of service. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata: + id: GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata + description: Metadata associated with a project provision operation. + type: object + properties: {} + GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsMetadata: + id: GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsMetadata + description: >- + Metadata related to the progress of the PurgeCompletionSuggestions + operation. This is returned by the google.longrunning.Operation.metadata + field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse: + id: GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse + description: >- + Response message for CompletionService.PurgeCompletionSuggestions + method. + type: object + properties: + purgeSucceeded: + description: Whether the completion suggestions were successfully purged. + type: boolean + errorSamples: + description: A sample of errors encountered while processing the request. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata: + id: GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata + description: >- + Metadata related to the progress of the PurgeDocuments operation. This + will be returned by the google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + successCount: + description: Count of entries that were deleted successfully. + type: string + format: int64 + failureCount: + description: Count of entries that encountered errors while processing. + type: string + format: int64 + ignoredCount: + description: Count of entries that were ignored as entries were not found. + type: string + format: int64 + GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse: + id: GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse + description: >- + Response message for DocumentService.PurgeDocuments method. If the long + running operation is successfully done, then this message is returned by + the google.longrunning.Operations.response field. + type: object + properties: + purgeCount: + description: The total count of documents purged as a result of the operation. + type: string + format: int64 + purgeSample: + description: >- + A sample of document names that will be deleted. Only populated if + `force` is set to false. A max of 100 names will be returned and the + names are chosen at random. + type: array + items: + type: string + GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata: + id: GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata + description: >- + Metadata related to the progress of the PurgeSuggestionDenyListEntries + operation. This is returned by the google.longrunning.Operation.metadata + field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse: + id: GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse + description: >- + Response message for CompletionService.PurgeSuggestionDenyListEntries + method. + type: object + properties: + purgeCount: + description: Number of suggestion deny list entries purged. + type: string + format: int64 + errorSamples: + description: A sample of errors encountered while processing the request. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata: + id: GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata + description: >- + Metadata related to the progress of the PurgeUserEvents operation. This + will be returned by the google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + successCount: + description: Count of entries that were deleted successfully. + type: string + format: int64 + failureCount: + description: Count of entries that encountered errors while processing. + type: string + format: int64 + GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse: + id: GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse + description: >- + Response of the PurgeUserEventsRequest. If the long running operation is + successfully done, then this message is returned by the + google.longrunning.Operations.response field. + type: object + properties: + purgeCount: + description: The total count of events purged as a result of the operation. + type: string + format: int64 + GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata: + id: GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata + description: >- + Metadata related to the progress of the + SiteSearchEngineService.RecrawlUris operation. This will be returned by + the google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + invalidUris: + description: >- + Unique URIs in the request that have invalid format. Sample limited + to 1000. + type: array + items: + type: string + invalidUrisCount: + description: Total number of unique URIs in the request that have invalid format. + type: integer + format: int32 + noindexUris: + description: URIs that have no index meta tag. Sample limited to 1000. + type: array + items: + type: string + noindexUrisCount: + description: Total number of URIs that have no index meta tag. + type: integer + format: int32 + urisNotMatchingTargetSites: + description: >- + Unique URIs in the request that don't match any TargetSite in the + DataStore, only match TargetSites that haven't been fully indexed, + or match a TargetSite with type EXCLUDE. Sample limited to 1000. + type: array + items: + type: string + urisNotMatchingTargetSitesCount: + description: Total number of URIs that don't match any TargetSites. + type: integer + format: int32 + validUrisCount: + description: >- + Total number of unique URIs in the request that are not in + invalid_uris. + type: integer + format: int32 + successCount: + description: Total number of URIs that have been crawled so far. + type: integer + format: int32 + pendingCount: + description: Total number of URIs that have yet to be crawled. + type: integer + format: int32 + quotaExceededCount: + description: >- + Total number of URIs that were rejected due to insufficient indexing + resources. + type: integer + format: int32 + GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse: + id: GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse + description: Response message for SiteSearchEngineService.RecrawlUris method. + type: object + properties: + failureSamples: + description: Details for a sample of up to 10 `failed_uris`. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo + failedUris: + description: URIs that were not crawled before the LRO terminated. + type: array + items: + type: string + GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo: + id: GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo + description: >- + Details about why a particular URI failed to be crawled. Each + FailureInfo contains one FailureReason per CorpusType. + type: object + properties: + uri: + description: URI that failed to be crawled. + type: string + failureReasons: + description: List of failure reasons by corpus type (e.g. desktop, mobile). + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason + GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason: + id: >- + GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason + description: >- + Details about why crawling failed for a particular CorpusType, e.g., + DESKTOP and MOBILE crawling may fail for different reasons. + type: object + properties: + corpusType: + description: DESKTOP, MOBILE, or CORPUS_TYPE_UNSPECIFIED. + type: string + enumDescriptions: + - Default value. + - Denotes a crawling attempt for the desktop version of a page. + - Denotes a crawling attempt for the mobile version of a page. + enum: + - CORPUS_TYPE_UNSPECIFIED + - DESKTOP + - MOBILE + errorMessage: + description: Reason why the URI was not crawled. + type: string + GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateMetadata: + id: GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateMetadata + description: >- + Metadata related to the progress of the + CrawlRateManagementService.RemoveDedicatedCrawlRate operation. This will + be returned by the google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateResponse: + id: GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateResponse + description: >- + Response message for CrawlRateManagementService.RemoveDedicatedCrawlRate + method. It simply returns the state of the response, and an error + message if the state is FAILED. + type: object + properties: + state: + description: Output only. The state of the response. + readOnly: true + type: string + enumDescriptions: + - The state is unspecified. + - The state is successful. + - The state is failed. + enum: + - STATE_UNSPECIFIED + - SUCCEEDED + - FAILED + error: + description: Errors from service when handling the request. + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateMetadata: + id: GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateMetadata + description: >- + Metadata related to the progress of the + CrawlRateManagementService.SetDedicatedCrawlRate operation. This will be + returned by the google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateResponse: + id: GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateResponse + description: >- + Response message for CrawlRateManagementService.SetDedicatedCrawlRate + method. It simply returns the state of the response, and an error + message if the state is FAILED. + type: object + properties: + state: + description: Output only. The state of the response. + readOnly: true + type: string + enumDescriptions: + - The state is unspecified. + - The state is successful. + - The state is failed. + enum: + - STATE_UNSPECIFIED + - SUCCEEDED + - FAILED + error: + description: Errors from service when handling the request. + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudDiscoveryengineV1alphaSetUpDataConnectorMetadata: + id: GoogleCloudDiscoveryengineV1alphaSetUpDataConnectorMetadata + description: Metadata for DataConnectorService.SetUpDataConnector method. + type: object + properties: {} + GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata: + id: GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata + description: >- + Metadata related to the progress of the + SiteSearchEngineService.SetUriPatternDocumentData operation. This will + be returned by the google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse: + id: GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse + description: >- + Response message for SiteSearchEngineService.SetUriPatternDocumentData + method. + type: object + properties: {} + GoogleCloudDiscoveryengineV1alphaSitemap: + id: GoogleCloudDiscoveryengineV1alphaSitemap + description: A sitemap for the SiteSearchEngine. + type: object + properties: + uri: + description: Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`. + type: string + name: + description: >- + Output only. The fully qualified resource name of the sitemap. + `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/*` + The `sitemap_id` suffix is system-generated. + readOnly: true + type: string + createTime: + description: Output only. The sitemap's creation time. + readOnly: true + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata: + id: GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata + description: >- + Metadata related to the progress of the TrainCustomModel operation. This + is returned by the google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse: + id: GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse + description: >- + Response of the TrainCustomModelRequest. This message is returned by the + google.longrunning.Operations.response field. + type: object + properties: + errorSamples: + description: A sample of errors encountered while processing the data. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + errorConfig: + description: >- + Echoes the destination for the complete errors in the request if + set. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaImportErrorConfig + modelStatus: + description: >- + The trained model status. Possible values are: * **bad-data**: The + training data quality is bad. * **no-improvement**: Tuning didn't + improve performance. Won't deploy. * **in-progress**: Model training + job creation is in progress. * **training**: Model is actively + training. * **evaluating**: The model is evaluating trained metrics. + * **indexing**: The model trained metrics are indexing. * **ready**: + The model is ready for serving. + type: string + metrics: + description: The metrics of the trained model. + type: object + additionalProperties: + type: number + format: double + modelName: + description: Fully qualified name of the CustomTuningModel. + type: string + GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata: + id: GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata + description: Metadata associated with a tune operation. + type: object + properties: + engine: + description: >- + Required. The resource name of the engine that this tune applies to. + Format: + `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}` + type: string + GoogleCloudDiscoveryengineV1alphaTuneEngineResponse: + id: GoogleCloudDiscoveryengineV1alphaTuneEngineResponse + description: Response associated with a tune operation. + type: object + properties: {} + GoogleCloudDiscoveryengineV1alphaUpdateCmekConfigMetadata: + id: GoogleCloudDiscoveryengineV1alphaUpdateCmekConfigMetadata + description: >- + Metadata related to the progress of the + CmekConfigService.UpdateCmekConfig operation. This will be returned by + the google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1alphaUpdateCollectionMetadata: + id: GoogleCloudDiscoveryengineV1alphaUpdateCollectionMetadata + description: >- + Metadata related to the progress of the + CollectionService.UpdateCollection operation. This will be returned by + the google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata: + id: GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata + description: Metadata for UpdateSchema LRO. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1alphaUpdateSessionRequest: + id: GoogleCloudDiscoveryengineV1alphaUpdateSessionRequest + description: Request for UpdateSession method. + type: object + properties: + session: + description: Required. The Session to update. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaSession' + updateMask: + description: >- + Indicates which fields in the provided Session to update. The + following are NOT supported: * Session.name If not set or empty, all + supported fields are updated. + type: string + format: google-fieldmask + GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata: + id: GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata + description: >- + Metadata related to the progress of the + SiteSearchEngineService.UpdateTargetSite operation. This will be + returned by the google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata: + id: GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata + description: >- + Metadata related to the progress of the + SiteSearchEngineService.BatchCreateTargetSites operation. This will be + returned by the google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse: + id: GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse + description: >- + Response message for SiteSearchEngineService.BatchCreateTargetSites + method. + type: object + properties: + targetSites: + description: TargetSites created. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1betaTargetSite' + GoogleCloudDiscoveryengineV1betaTargetSite: + id: GoogleCloudDiscoveryengineV1betaTargetSite + description: A target site for the SiteSearchEngine. + type: object + properties: + name: + description: >- + Output only. The fully qualified resource name of the target site. + `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` + The `target_site_id` is system-generated. + readOnly: true + type: string + providedUriPattern: + description: >- + Required. Input only. The user provided URI pattern from which the + `generated_uri_pattern` is generated. + type: string + type: + description: >- + The type of the target site, e.g., whether the site is to be + included or excluded. + type: string + enumDescriptions: + - >- + This value is unused. In this case, server behavior defaults to + Type.INCLUDE. + - Include the target site. + - Exclude the target site. + enum: + - TYPE_UNSPECIFIED + - INCLUDE + - EXCLUDE + exactMatch: + description: >- + Immutable. If set to false, a uri_pattern is generated to include + all pages whose address contains the provided_uri_pattern. If set to + true, an uri_pattern is generated to try to be an exact match of the + provided_uri_pattern or just the specific page if the + provided_uri_pattern is a specific one. provided_uri_pattern is + always normalized to generate the URI pattern to be used by the + search engine. + type: boolean + generatedUriPattern: + description: >- + Output only. This is system-generated based on the + provided_uri_pattern. + readOnly: true + type: string + rootDomainUri: + description: Output only. Root domain of the provided_uri_pattern. + readOnly: true + type: string + siteVerificationInfo: + description: Output only. Site ownership and validity verification status. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaSiteVerificationInfo + indexingStatus: + description: Output only. Indexing status. + readOnly: true + type: string + enumDescriptions: + - Defaults to SUCCEEDED. + - >- + The target site is in the update queue and will be picked up by + indexing pipeline. + - The target site fails to be indexed. + - The target site has been indexed. + - >- + The previously indexed target site has been marked to be deleted. + This is a transitioning state which will resulted in either: 1. + target site deleted if unindexing is successful; 2. state reverts + to SUCCEEDED if the unindexing fails. + - The target site change is pending but cancellable. + - The target site change is cancelled. + enum: + - INDEXING_STATUS_UNSPECIFIED + - PENDING + - FAILED + - SUCCEEDED + - DELETING + - CANCELLABLE + - CANCELLED + updateTime: + description: Output only. The target site's last updated time. + readOnly: true + type: string + format: google-datetime + failureReason: + description: Output only. Failure reason. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason + GoogleCloudDiscoveryengineV1betaSiteVerificationInfo: + id: GoogleCloudDiscoveryengineV1betaSiteVerificationInfo + description: Verification information for target sites in advanced site search. + type: object + properties: + siteVerificationState: + description: Site verification state indicating the ownership and validity. + type: string + enumDescriptions: + - Defaults to VERIFIED. + - Site ownership verified. + - Site ownership pending verification or verification failed. + - >- + Site exempt from verification, e.g., a public website that opens + to all. + enum: + - SITE_VERIFICATION_STATE_UNSPECIFIED + - VERIFIED + - UNVERIFIED + - EXEMPTED + verifyTime: + description: Latest site verification time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason: + id: GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason + description: Site search indexing failure reasons. + type: object + properties: + quotaFailure: + description: Failed due to insufficient quota. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure + GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure: + id: GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure + description: Failed due to insufficient quota. + type: object + properties: + totalRequiredQuota: + description: >- + This number is an estimation on how much total quota this project + needs to successfully complete indexing. + type: string + format: int64 + GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesMetadata: + id: GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesMetadata + description: >- + Metadata related to the progress of the + UserLicenseService.BatchUpdateUserLicenses operation. This will be + returned by the google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + successCount: + description: Count of user licenses successfully updated. + type: string + format: int64 + failureCount: + description: Count of user licenses that failed to be updated. + type: string + format: int64 + GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesResponse: + id: GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesResponse + description: Response message for UserLicenseService.BatchUpdateUserLicenses method. + type: object + properties: + userLicenses: + description: UserLicenses successfully updated. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1betaUserLicense' + errorSamples: + description: A sample of errors encountered while processing the request. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudDiscoveryengineV1betaUserLicense: + id: GoogleCloudDiscoveryengineV1betaUserLicense + description: User License information assigned by the admin. + type: object + properties: + userPrincipal: + description: >- + Required. Immutable. The user principal of the User, could be email + address or other prinical identifier. This field is immutable. Admin + assign licenses based on the user principal. + type: string + userProfile: + description: >- + Optional. The user profile. We user user full name(First name + Last + name) as user profile. + type: string + licenseAssignmentState: + description: >- + Output only. License assignment state of the user. If the user is + assigned with a license config, the user login will be assigned with + the license; If the user's license assignment state is unassigned or + unspecified, no license config will be associated to the user; + readOnly: true + type: string + enumDescriptions: + - Default value. + - License assigned to the user. + - >- + No license assigned to the user. Deprecated, translated to + NO_LICENSE. + - No license assigned to the user. + - >- + User attempted to login but no license assigned to the user. This + state is only used for no user first time login attempt but cannot + get license assigned. Users already logged in but cannot get + license assigned will be assigned NO_LICENSE state(License could + be unassigned by admin). + - User is blocked from assigning a license. + enum: + - LICENSE_ASSIGNMENT_STATE_UNSPECIFIED + - ASSIGNED + - UNASSIGNED + - NO_LICENSE + - NO_LICENSE_ATTEMPTED_LOGIN + - BLOCKED + licenseConfig: + description: >- + Optional. The full resource name of the Subscription(LicenseConfig) + assigned to the user. + type: string + createTime: + description: Output only. User created timestamp. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. User update timestamp. + readOnly: true + type: string + format: google-datetime + lastLoginTime: + description: >- + Output only. User last logged in time. If the user has not logged in + yet, this field will be empty. + readOnly: true + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1betaControl: + id: GoogleCloudDiscoveryengineV1betaControl + description: >- + Defines a conditioned behavior to employ during serving. Must be + attached to a ServingConfig to be considered at serving time. Permitted + actions dependent on `SolutionType`. + type: object + properties: + boostAction: + description: Defines a boost-type control + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaControlBoostAction + filterAction: + description: >- + Defines a filter-type control Currently not supported by + Recommendation + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaControlFilterAction + redirectAction: + description: Defines a redirect-type control. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaControlRedirectAction + synonymsAction: + description: Treats a group of terms as synonyms of one another. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaControlSynonymsAction + promoteAction: + description: Promote certain links based on predefined trigger queries. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaControlPromoteAction + name: + description: >- + Immutable. Fully qualified name + `projects/*/locations/global/dataStore/*/controls/*` + type: string + displayName: + description: >- + Required. Human readable name. The identifier used in UI views. Must + be UTF-8 encoded string. Length limit is 128 characters. Otherwise + an INVALID ARGUMENT error is thrown. + type: string + associatedServingConfigIds: + description: >- + Output only. List of all ServingConfig IDs this control is attached + to. May take up to 10 minutes to update after changes. + readOnly: true + type: array + items: + type: string + solutionType: + description: >- + Required. Immutable. What solution the control belongs to. Must be + compatible with vertical of resource. Otherwise an INVALID ARGUMENT + error is thrown. + type: string + enumDescriptions: + - Default value. + - Used for Recommendations AI. + - Used for Discovery Search. + - Used for use cases related to the Generative AI agent. + - >- + Used for use cases related to the Generative Chat agent. It's used + for Generative chat engine only, the associated data stores must + enrolled with `SOLUTION_TYPE_CHAT` solution. + enum: + - SOLUTION_TYPE_UNSPECIFIED + - SOLUTION_TYPE_RECOMMENDATION + - SOLUTION_TYPE_SEARCH + - SOLUTION_TYPE_CHAT + - SOLUTION_TYPE_GENERATIVE_CHAT + useCases: + description: >- + Specifies the use case for the control. Affects what condition + fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently + only allow one use case per control. Must be set when solution_type + is SolutionType.SOLUTION_TYPE_SEARCH. + type: array + items: + type: string + enumDescriptions: + - Value used when unset. Will not occur in CSS. + - Search use case. Expects the traffic has a non-empty query. + - Browse use case. Expects the traffic has an empty query. + enum: + - SEARCH_USE_CASE_UNSPECIFIED + - SEARCH_USE_CASE_SEARCH + - SEARCH_USE_CASE_BROWSE + conditions: + description: >- + Determines when the associated action will trigger. Omit to always + apply the action. Currently only a single condition may be + specified. Otherwise an INVALID ARGUMENT error is thrown. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1betaCondition' + GoogleCloudDiscoveryengineV1betaControlBoostAction: + id: GoogleCloudDiscoveryengineV1betaControlBoostAction + description: Adjusts order of products in returned list. + type: object + properties: + fixedBoost: + description: >- + Optional. Strength of the boost, which should be in [-1, 1]. + Negative boost means demotion. Default is 0.0 (No-op). + type: number + format: float + interpolationBoostSpec: + description: >- + Optional. Complex specification for custom ranking based on customer + defined attribute value. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec + boost: + description: >- + Strength of the boost, which should be in [-1, 1]. Negative boost + means demotion. Default is 0.0 (No-op). + deprecated: true + type: number + format: float + filter: + description: >- + Required. Specifies which products to apply the boost to. If no + filter is provided all products will be boosted (No-op). Syntax + documentation: https://cloud.google.com/retail/docs/filter-and-order + Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT + error is thrown. + type: string + dataStore: + description: >- + Required. Specifies which data store's documents can be boosted by + this control. Full data store name e.g. + projects/123/locations/global/collections/default_collection/dataStores/default_data_store + type: string + GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec: + id: GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec + description: >- + Specification for custom ranking based on customer specified attribute + value. It provides more controls for customized ranking than the simple + (condition, boost) combination above. + type: object + properties: + fieldName: + description: >- + Optional. The name of the field whose value will be used to + determine the boost amount. + type: string + attributeType: + description: >- + Optional. The attribute type to be used to determine the boost + amount. The attribute value can be derived from the field value of + the specified field_name. In the case of numerical it is + straightforward i.e. attribute_value = numerical_field_value. In the + case of freshness however, attribute_value = (time.now() - + datetime_field_value). + type: string + enumDescriptions: + - Unspecified AttributeType. + - >- + The value of the numerical field will be used to dynamically + update the boost amount. In this case, the attribute_value (the x + value) of the control point will be the actual value of the + numerical field for which the boost_amount is specified. + - >- + For the freshness use case the attribute value will be the + duration between the current time and the date in the datetime + field specified. The value must be formatted as an XSD + `dayTimeDuration` value (a restricted subset of an ISO 8601 + duration value). The pattern for this is: `nDnM]`. For example, + `5D`, `3DT12H30M`, `T24H`. + enum: + - ATTRIBUTE_TYPE_UNSPECIFIED + - NUMERICAL + - FRESHNESS + interpolationType: + description: >- + Optional. The interpolation type to be applied to connect the + control points listed below. + type: string + enumDescriptions: + - >- + Interpolation type is unspecified. In this case, it defaults to + Linear. + - Piecewise linear interpolation will be applied. + enum: + - INTERPOLATION_TYPE_UNSPECIFIED + - LINEAR + controlPoints: + description: >- + Optional. The control points used to define the curve. The monotonic + function (defined through the interpolation_type above) passes + through the control points listed here. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint + GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint: + id: >- + GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint + description: >- + The control points used to define the curve. The curve defined through + these control points can only be monotonically increasing or + decreasing(constant values are acceptable). + type: object + properties: + attributeValue: + description: >- + Optional. Can be one of: 1. The numerical field value. 2. The + duration spec for freshness: The value must be formatted as an XSD + `dayTimeDuration` value (a restricted subset of an ISO 8601 duration + value). The pattern for this is: `nDnM]`. + type: string + boostAmount: + description: >- + Optional. The value between -1 to 1 by which to boost the score if + the attribute_value evaluates to the value specified above. + type: number + format: float + GoogleCloudDiscoveryengineV1betaControlFilterAction: + id: GoogleCloudDiscoveryengineV1betaControlFilterAction + description: >- + Specified which products may be included in results. Uses same filter as + boost. + type: object + properties: + filter: + description: >- + Required. A filter to apply on the matching condition results. + Required Syntax documentation: + https://cloud.google.com/retail/docs/filter-and-order Maximum length + is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. + type: string + dataStore: + description: >- + Required. Specifies which data store's documents can be filtered by + this control. Full data store name e.g. + projects/123/locations/global/collections/default_collection/dataStores/default_data_store + type: string + GoogleCloudDiscoveryengineV1betaControlRedirectAction: + id: GoogleCloudDiscoveryengineV1betaControlRedirectAction + description: Redirects a shopper to the provided URI. + type: object + properties: + redirectUri: + description: >- + Required. The URI to which the shopper will be redirected. Required. + URI must have length equal or less than 2000 characters. Otherwise + an INVALID ARGUMENT error is thrown. + type: string + GoogleCloudDiscoveryengineV1betaControlSynonymsAction: + id: GoogleCloudDiscoveryengineV1betaControlSynonymsAction + description: >- + Creates a set of terms that will act as synonyms of one another. + Example: "happy" will also be considered as "glad", "glad" will also be + considered as "happy". + type: object + properties: + synonyms: + description: >- + Defines a set of synonyms. Can specify up to 100 synonyms. Must + specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is + thrown. + type: array + items: + type: string + GoogleCloudDiscoveryengineV1betaControlPromoteAction: + id: GoogleCloudDiscoveryengineV1betaControlPromoteAction + description: >- + Promote certain links based on some trigger queries. Example: Promote + shoe store link when searching for `shoe` keyword. The link can be + outside of associated data store. + type: object + properties: + dataStore: + description: Required. Data store with which this promotion is attached to. + type: string + searchLinkPromotion: + description: Required. Promotion attached to this action. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchLinkPromotion + GoogleCloudDiscoveryengineV1betaSearchLinkPromotion: + id: GoogleCloudDiscoveryengineV1betaSearchLinkPromotion + description: >- + Promotion proto includes uri and other helping information to display + the promotion. + type: object + properties: + title: + description: >- + Required. The title of the promotion. Maximum length: 160 + characters. + type: string + uri: + description: >- + Optional. The URL for the page the user wants to promote. Must be + set for site search. For other verticals, this is optional. + type: string + document: + description: >- + Optional. The Document the user wants to promote. For site search, + leave unset and only populate uri. Can be set along with uri. + type: string + imageUri: + description: Optional. The promotion thumbnail image url. + type: string + description: + description: 'Optional. The Promotion description. Maximum length: 200 characters.' + type: string + enabled: + description: >- + Optional. The enabled promotion will be returned for any serving + configs associated with the parent of the control this promotion is + attached to. This flag is used for basic site search only. + type: boolean + GoogleCloudDiscoveryengineV1betaCondition: + id: GoogleCloudDiscoveryengineV1betaCondition + description: Defines circumstances to be checked before allowing a behavior + type: object + properties: + queryTerms: + description: >- + Search only A list of terms to match the query on. Cannot be set + when Condition.query_regex is set. Maximum of 10 query terms. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaConditionQueryTerm + activeTimeRange: + description: >- + Range of time(s) specifying when condition is active. Maximum of 10 + time ranges. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaConditionTimeRange + queryRegex: + description: >- + Optional. Query regex to match the whole search query. Cannot be set + when Condition.query_terms is set. Only supported for Basic Site + Search promotion serving controls. + type: string + GoogleCloudDiscoveryengineV1betaConditionQueryTerm: + id: GoogleCloudDiscoveryengineV1betaConditionQueryTerm + description: Matcher for search request query + type: object + properties: + value: + description: >- + The specific query value to match against Must be lowercase, must be + UTF-8. Can have at most 3 space separated terms if full_match is + true. Cannot be an empty string. Maximum length of 5000 characters. + type: string + fullMatch: + description: Whether the search query needs to exactly match the query term. + type: boolean + GoogleCloudDiscoveryengineV1betaConditionTimeRange: + id: GoogleCloudDiscoveryengineV1betaConditionTimeRange + description: Used for time-dependent conditions. + type: object + properties: + startTime: + description: Start of time range. Range is inclusive. + type: string + format: google-datetime + endTime: + description: End of time range. Range is inclusive. Must be in the future. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata: + id: GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata + description: >- + Metadata related to the progress of the DataStoreService.CreateDataStore + operation. This will be returned by the + google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1betaCreateEngineMetadata: + id: GoogleCloudDiscoveryengineV1betaCreateEngineMetadata + description: >- + Metadata related to the progress of the EngineService.CreateEngine + operation. This will be returned by the + google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata: + id: GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata + description: Metadata for EvaluationService.CreateEvaluation method. + type: object + properties: {} + GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata: + id: GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata + description: Metadata for Create Schema LRO. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1betaCreateSitemapMetadata: + id: GoogleCloudDiscoveryengineV1betaCreateSitemapMetadata + description: >- + Metadata related to the progress of the + SiteSearchEngineService.CreateSitemap operation. This will be returned + by the google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata: + id: GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata + description: >- + Metadata related to the progress of the + SiteSearchEngineService.CreateTargetSite operation. This will be + returned by the google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1betaDataStore: + id: GoogleCloudDiscoveryengineV1betaDataStore + description: DataStore captures global settings and configs at the DataStore level. + type: object + properties: + name: + description: >- + Immutable. Identifier. The full resource name of the data store. + Format: + `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. + This field must be a UTF-8 encoded string with a length limit of + 1024 characters. + type: string + displayName: + description: >- + Required. The data store display name. This field must be a UTF-8 + encoded string with a length limit of 128 characters. Otherwise, an + INVALID_ARGUMENT error is returned. + type: string + industryVertical: + description: Immutable. The industry vertical that the data store registers. + type: string + enumDescriptions: + - Value used when unset. + - >- + The generic vertical for documents that are not specific to any + industry vertical. + - The media industry vertical. + - The healthcare FHIR vertical. + enum: + - INDUSTRY_VERTICAL_UNSPECIFIED + - GENERIC + - MEDIA + - HEALTHCARE_FHIR + solutionTypes: + description: >- + The solutions that the data store enrolls. Available solutions for + each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` + and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` + is automatically enrolled. Other solutions cannot be enrolled. + type: array + items: + type: string + enumDescriptions: + - Default value. + - Used for Recommendations AI. + - Used for Discovery Search. + - Used for use cases related to the Generative AI agent. + - >- + Used for use cases related to the Generative Chat agent. It's + used for Generative chat engine only, the associated data stores + must enrolled with `SOLUTION_TYPE_CHAT` solution. + enum: + - SOLUTION_TYPE_UNSPECIFIED + - SOLUTION_TYPE_RECOMMENDATION + - SOLUTION_TYPE_SEARCH + - SOLUTION_TYPE_CHAT + - SOLUTION_TYPE_GENERATIVE_CHAT + defaultSchemaId: + description: >- + Output only. The id of the default Schema associated to this data + store. + readOnly: true + type: string + contentConfig: + description: >- + Immutable. The content config of the data store. If this field is + unset, the server behavior defaults to ContentConfig.NO_CONTENT. + type: string + enumDescriptions: + - Default value. + - Only contains documents without any Document.content. + - Only contains documents with Document.content. + - The data store is used for public website search. + - >- + The data store is used for workspace search. Details of workspace + data store are specified in the WorkspaceConfig. + enum: + - CONTENT_CONFIG_UNSPECIFIED + - NO_CONTENT + - CONTENT_REQUIRED + - PUBLIC_WEBSITE + - GOOGLE_WORKSPACE + createTime: + description: Output only. Timestamp the DataStore was created at. + readOnly: true + type: string + format: google-datetime + advancedSiteSearchConfig: + description: Optional. Configuration for advanced site search. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig + languageInfo: + description: Language info for DataStore. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1betaLanguageInfo' + naturalLanguageQueryUnderstandingConfig: + description: Optional. Configuration for Natural Language Query Understanding. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig + kmsKeyName: + description: >- + Input only. The KMS key to be used to protect this DataStore at + creation time. Must be set for requests that need to comply with + CMEK Org Policy protections. If this field is set and processed + successfully, the DataStore will be protected by the KMS key, as + indicated in the cmek_config field. + type: string + cmekConfig: + description: Output only. CMEK-related information for the DataStore. + readOnly: true + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1betaCmekConfig' + billingEstimation: + description: Output only. Data size estimation for billing. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation + aclEnabled: + description: >- + Immutable. Whether data in the DataStore has ACL information. If set + to `true`, the source data must have ACL. ACL will be ingested when + data is ingested by DocumentService.ImportDocuments methods. When + ACL is enabled for the DataStore, Document can't be accessed by + calling DocumentService.GetDocument or + DocumentService.ListDocuments. Currently ACL is only supported in + `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content + config. + type: boolean + workspaceConfig: + description: >- + Config to store data store type configuration for workspace data. + This must be set when DataStore.content_config is set as + DataStore.ContentConfig.GOOGLE_WORKSPACE. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1betaWorkspaceConfig' + documentProcessingConfig: + description: Configuration for Document understanding and enrichment. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig + startingSchema: + description: >- + The start schema to use for this DataStore when provisioning it. If + unset, a default vertical specialized schema will be used. This + field is only used by CreateDataStore API, and will be ignored if + used in other APIs. This field will be omitted from all API + responses including CreateDataStore API. To retrieve a schema of a + DataStore, use SchemaService.GetSchema API instead. The provided + schema will be validated against certain rules on schema. Learn more + from [this + doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1betaSchema' + healthcareFhirConfig: + description: Optional. Configuration for `HEALTHCARE_FHIR` vertical. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig + servingConfigDataStore: + description: Optional. Stores serving config at DataStore level. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore + identityMappingStore: + description: >- + Immutable. The fully qualified resource name of the associated + IdentityMappingStore. This field can only be set for acl_enabled + DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: + `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. + type: string + isInfobotFaqDataStore: + description: Optional. If set, this DataStore is an Infobot FAQ DataStore. + type: boolean + GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig: + id: GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig + description: Configuration data for advance site search. + type: object + properties: + disableInitialIndex: + description: If set true, initial indexing is disabled for the DataStore. + type: boolean + disableAutomaticRefresh: + description: If set true, automatic refresh is disabled for the DataStore. + type: boolean + GoogleCloudDiscoveryengineV1betaLanguageInfo: + id: GoogleCloudDiscoveryengineV1betaLanguageInfo + description: Language info for DataStore. + type: object + properties: + languageCode: + description: The language code for the DataStore. + type: string + normalizedLanguageCode: + description: >- + Output only. This is the normalized form of language_code. E.g.: + language_code of `en-GB`, `en_GB`, `en-UK` or `en-gb` will have + normalized_language_code of `en-GB`. + readOnly: true + type: string + language: + description: >- + Output only. Language part of normalized_language_code. E.g.: + `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`. + readOnly: true + type: string + region: + description: >- + Output only. Region part of normalized_language_code, if present. + E.g.: `en-US` -> `US`, `zh-Hans-HK` -> `HK`, `en` -> ``. + readOnly: true + type: string + GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig: + id: GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig + description: Configuration for Natural Language Query Understanding. + type: object + properties: + mode: + description: >- + Mode of Natural Language Query Understanding. If this field is + unset, the behavior defaults to + NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED. + type: string + enumDescriptions: + - Default value. + - Natural Language Query Understanding is disabled. + - Natural Language Query Understanding is enabled. + enum: + - MODE_UNSPECIFIED + - DISABLED + - ENABLED + GoogleCloudDiscoveryengineV1betaCmekConfig: + id: GoogleCloudDiscoveryengineV1betaCmekConfig + description: Configurations used to enable CMEK data encryption with Cloud KMS keys. + type: object + properties: + name: + description: >- + Required. The name of the CmekConfig of the form + `projects/{project}/locations/{location}/cmekConfig` or + `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`. + type: string + kmsKey: + description: >- + Required. KMS key resource name which will be used to encrypt + resources + `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. + type: string + kmsKeyVersion: + description: >- + Output only. KMS key version resource name which will be used to + encrypt resources `/cryptoKeyVersions/{keyVersion}`. + readOnly: true + type: string + state: + description: Output only. The states of the CmekConfig. + readOnly: true + type: string + enumDescriptions: + - The CmekConfig state is unknown. + - The CmekConfig is creating. + - The CmekConfig can be used with DataStores. + - >- + The CmekConfig is unavailable, most likely due to the KMS Key + being revoked. + - The CmekConfig is deleting. + - The CmekConfig deletion process failed. + - >- + The CmekConfig is not usable, most likely due to some internal + issue. + - The KMS key version is being rotated. + - >- + The KMS key is soft deleted. Some cleanup policy will eventually + be applied. + enum: + - STATE_UNSPECIFIED + - CREATING + - ACTIVE + - KEY_ISSUE + - DELETING + - DELETE_FAILED + - UNUSABLE + - ACTIVE_ROTATING + - DELETED + isDefault: + description: Output only. The default CmekConfig for the Customer. + readOnly: true + type: boolean + lastRotationTimestampMicros: + description: Output only. The timestamp of the last key rotation. + readOnly: true + type: string + format: int64 + singleRegionKeys: + description: >- + Optional. Single-regional CMEKs that are required for some VAIS + features. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaSingleRegionKey + notebooklmState: + description: Output only. Whether the NotebookLM Corpus is ready to be used. + readOnly: true + type: string + enumDescriptions: + - The NotebookLM state is unknown. + - The NotebookLM is not ready. + - The NotebookLM is ready to be used. + - The NotebookLM is not enabled. + enum: + - NOTEBOOK_LM_STATE_UNSPECIFIED + - NOTEBOOK_LM_NOT_READY + - NOTEBOOK_LM_READY + - NOTEBOOK_LM_NOT_ENABLED + GoogleCloudDiscoveryengineV1betaSingleRegionKey: + id: GoogleCloudDiscoveryengineV1betaSingleRegionKey + description: Metadata for single-regional CMEKs. + type: object + properties: + kmsKey: + description: >- + Required. Single-regional kms key resource name which will be used + to encrypt resources + `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. + type: string + GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation: + id: GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation + description: Estimation of data size per data store. + type: object + properties: + structuredDataSize: + description: Data size for structured data in terms of bytes. + type: string + format: int64 + unstructuredDataSize: + description: Data size for unstructured data in terms of bytes. + type: string + format: int64 + websiteDataSize: + description: Data size for websites in terms of bytes. + type: string + format: int64 + structuredDataUpdateTime: + description: Last updated timestamp for structured data. + type: string + format: google-datetime + unstructuredDataUpdateTime: + description: Last updated timestamp for unstructured data. + type: string + format: google-datetime + websiteDataUpdateTime: + description: Last updated timestamp for websites. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1betaWorkspaceConfig: + id: GoogleCloudDiscoveryengineV1betaWorkspaceConfig + description: Config to store data store type configuration for workspace data + type: object + properties: + type: + description: The Google Workspace data source. + type: string + enumDescriptions: + - Defaults to an unspecified Workspace type. + - Workspace Data Store contains Drive data + - Workspace Data Store contains Mail data + - Workspace Data Store contains Sites data + - Workspace Data Store contains Calendar data + - Workspace Data Store contains Chat data + - Workspace Data Store contains Groups data + - Workspace Data Store contains Keep data + - Workspace Data Store contains People data + enum: + - TYPE_UNSPECIFIED + - GOOGLE_DRIVE + - GOOGLE_MAIL + - GOOGLE_SITES + - GOOGLE_CALENDAR + - GOOGLE_CHAT + - GOOGLE_GROUPS + - GOOGLE_KEEP + - GOOGLE_PEOPLE + dasherCustomerId: + description: Obfuscated Dasher customer ID. + type: string + superAdminServiceAccount: + description: >- + Optional. The super admin service account for the workspace that + will be used for access token generation. For now we only use it for + Native Google Drive connector data ingestion. + type: string + superAdminEmailAddress: + description: >- + Optional. The super admin email address for the workspace that will + be used for access token generation. For now we only use it for + Native Google Drive connector data ingestion. + type: string + GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig: + id: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig + description: >- + A singleton resource of DataStore. If it's empty when DataStore is + created and DataStore is set to + DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will + default to digital parser. + type: object + properties: + name: + description: >- + The full resource name of the Document Processing Config. Format: + `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. + type: string + chunkingConfig: + description: Whether chunking mode is enabled. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig + defaultParsingConfig: + description: >- + Configurations for default Document parser. If not specified, we + will configure it as default DigitalParsingConfig, and the default + parsing config will be applied to all file types for Document + parsing. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig + parsingConfigOverrides: + description: >- + Map from file type to override the default parsing configuration + based on the file type. Supported keys: * `pdf`: Override parsing + config for PDF files, either digital parsing, ocr parsing or layout + parsing is supported. * `html`: Override parsing config for HTML + files, only digital parsing and layout parsing are supported. * + `docx`: Override parsing config for DOCX files, only digital parsing + and layout parsing are supported. * `pptx`: Override parsing config + for PPTX files, only digital parsing and layout parsing are + supported. * `xlsm`: Override parsing config for XLSM files, only + digital parsing and layout parsing are supported. * `xlsx`: Override + parsing config for XLSX files, only digital parsing and layout + parsing are supported. + type: object + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig + GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig: + id: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig + description: Configuration for chunking config. + type: object + properties: + layoutBasedChunkingConfig: + description: Configuration for the layout based chunking. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig + GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig: + id: >- + GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig + description: Configuration for the layout based chunking. + type: object + properties: + chunkSize: + description: >- + The token size limit for each chunk. Supported values: 100-500 + (inclusive). Default value: 500. + type: integer + format: int32 + includeAncestorHeadings: + description: >- + Whether to include appending different levels of headings to chunks + from the middle of the document to prevent context loss. Default + value: False. + type: boolean + GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig: + id: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig + description: Related configurations applied to a specific type of document parser. + type: object + properties: + digitalParsingConfig: + description: Configurations applied to digital parser. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig + ocrParsingConfig: + description: >- + Configurations applied to OCR parser. Currently it only applies to + PDFs. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig + layoutParsingConfig: + description: Configurations applied to layout parser. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig + GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig: + id: >- + GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig + description: The digital parsing configurations for documents. + type: object + properties: {} + GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig: + id: >- + GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig + description: The OCR parsing configurations for documents. + type: object + properties: + enhancedDocumentElements: + description: >- + [DEPRECATED] This field is deprecated. To use the additional + enhanced document elements processing, please switch to + `layout_parsing_config`. + deprecated: true + type: array + items: + type: string + useNativeText: + description: >- + If true, will use native text instead of OCR text on pages + containing native text. + type: boolean + GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig: + id: >- + GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig + description: The layout parsing configurations for documents. + type: object + properties: + enableTableAnnotation: + description: >- + Optional. If true, the LLM based annotation is added to the table + during parsing. + type: boolean + enableImageAnnotation: + description: >- + Optional. If true, the LLM based annotation is added to the image + during parsing. + type: boolean + structuredContentTypes: + description: >- + Optional. Contains the required structure types to extract from the + document. Supported values: * `shareholder-structure` + type: array + items: + type: string + excludeHtmlElements: + description: Optional. List of HTML elements to exclude from the parsed content. + type: array + items: + type: string + excludeHtmlClasses: + description: Optional. List of HTML classes to exclude from the parsed content. + type: array + items: + type: string + excludeHtmlIds: + description: Optional. List of HTML ids to exclude from the parsed content. + type: array + items: + type: string + enableGetProcessedDocument: + description: >- + Optional. If true, the processed document will be made available for + the GetProcessedDocument API. + type: boolean + GoogleCloudDiscoveryengineV1betaSchema: + id: GoogleCloudDiscoveryengineV1betaSchema + description: Defines the structure and layout of a type of document data. + type: object + properties: + structSchema: + description: The structured representation of the schema. + type: object + additionalProperties: + type: any + description: Properties of the object. + jsonSchema: + description: The JSON representation of the schema. + type: string + name: + description: >- + Immutable. The full resource name of the schema, in the format of + `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. + This field must be a UTF-8 encoded string with a length limit of + 1024 characters. + type: string + GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig: + id: GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig + description: Config to data store for `HEALTHCARE_FHIR` vertical. + type: object + properties: + enableConfigurableSchema: + description: >- + Whether to enable configurable schema for `HEALTHCARE_FHIR` + vertical. If set to `true`, the predefined healthcare fhir schema + can be extended for more customized searching and filtering. + type: boolean + enableStaticIndexingForBatchIngestion: + description: >- + Whether to enable static indexing for `HEALTHCARE_FHIR` batch + ingestion. If set to `true`, the batch ingestion will be processed + in a static indexing mode which is slower but more capable of + handling larger volume. + type: boolean + GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore: + id: GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore + description: >- + Stores information regarding the serving configurations at DataStore + level. + type: object + properties: + disabledForServing: + description: >- + Optional. If set true, the DataStore will not be available for + serving search requests. + type: boolean + GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata: + id: GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata + description: >- + Metadata related to the progress of the DataStoreService.DeleteDataStore + operation. This will be returned by the + google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata: + id: GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata + description: >- + Metadata related to the progress of the EngineService.DeleteEngine + operation. This will be returned by the + google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1betaDeleteIdentityMappingStoreMetadata: + id: GoogleCloudDiscoveryengineV1betaDeleteIdentityMappingStoreMetadata + description: >- + Metadata related to the progress of the + IdentityMappingStoreService.DeleteIdentityMappingStore operation. This + will be returned by the google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata: + id: GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata + description: Metadata for DeleteSchema LRO. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1betaDeleteSitemapMetadata: + id: GoogleCloudDiscoveryengineV1betaDeleteSitemapMetadata + description: >- + Metadata related to the progress of the + SiteSearchEngineService.DeleteSitemap operation. This will be returned + by the google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata: + id: GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata + description: >- + Metadata related to the progress of the + SiteSearchEngineService.DeleteTargetSite operation. This will be + returned by the google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata: + id: GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata + description: >- + Metadata related to the progress of the + SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will + be returned by the google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse: + id: GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse + description: >- + Response message for SiteSearchEngineService.DisableAdvancedSiteSearch + method. + type: object + properties: {} + GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata: + id: GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata + description: >- + Metadata related to the progress of the + SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be + returned by the google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse: + id: GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse + description: >- + Response message for SiteSearchEngineService.EnableAdvancedSiteSearch + method. + type: object + properties: {} + GoogleCloudDiscoveryengineV1betaEngine: + id: GoogleCloudDiscoveryengineV1betaEngine + description: >- + Metadata that describes the training and serving parameters of an + Engine. + type: object + properties: + chatEngineConfig: + description: >- + Configurations for the Chat Engine. Only applicable if solution_type + is SOLUTION_TYPE_CHAT. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig + searchEngineConfig: + description: >- + Configurations for the Search Engine. Only applicable if + solution_type is SOLUTION_TYPE_SEARCH. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig + mediaRecommendationEngineConfig: + description: >- + Configurations for the Media Engine. Only applicable on the data + stores with solution_type SOLUTION_TYPE_RECOMMENDATION and + IndustryVertical.MEDIA vertical. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig + chatEngineMetadata: + description: >- + Output only. Additional information of the Chat Engine. Only + applicable if solution_type is SOLUTION_TYPE_CHAT. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata + name: + description: >- + Immutable. Identifier. The fully qualified resource name of the + engine. This field must be a UTF-8 encoded string with a length + limit of 1024 characters. Format: + `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + engine should be 1-63 characters, and valid characters are + /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned. + type: string + displayName: + description: >- + Required. The display name of the engine. Should be human readable. + UTF-8 encoded string with limit of 1024 characters. + type: string + createTime: + description: Output only. Timestamp the Recommendation Engine was created at. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. Timestamp the Recommendation Engine was last updated. + readOnly: true + type: string + format: google-datetime + dataStoreIds: + description: >- + Optional. The data stores associated with this engine. For + SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of + engines, they can only associate with at most one data store. If + solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same + Collection can be associated here. Note that when used in + CreateEngineRequest, one DataStore id must be provided as the system + will use it for necessary initializations. + type: array + items: + type: string + solutionType: + description: Required. The solutions of the engine. + type: string + enumDescriptions: + - Default value. + - Used for Recommendations AI. + - Used for Discovery Search. + - Used for use cases related to the Generative AI agent. + - >- + Used for use cases related to the Generative Chat agent. It's used + for Generative chat engine only, the associated data stores must + enrolled with `SOLUTION_TYPE_CHAT` solution. + enum: + - SOLUTION_TYPE_UNSPECIFIED + - SOLUTION_TYPE_RECOMMENDATION + - SOLUTION_TYPE_SEARCH + - SOLUTION_TYPE_CHAT + - SOLUTION_TYPE_GENERATIVE_CHAT + industryVertical: + description: >- + Optional. The industry vertical that the engine registers. The + restriction of the Engine industry vertical is based on DataStore: + Vertical on Engine has to match vertical of the DataStore linked to + the engine. + type: string + enumDescriptions: + - Value used when unset. + - >- + The generic vertical for documents that are not specific to any + industry vertical. + - The media industry vertical. + - The healthcare FHIR vertical. + enum: + - INDUSTRY_VERTICAL_UNSPECIFIED + - GENERIC + - MEDIA + - HEALTHCARE_FHIR + commonConfig: + description: Common config spec that specifies the metadata of the engine. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaEngineCommonConfig + disableAnalytics: + description: >- + Optional. Whether to disable analytics for searches performed on + this engine. + type: boolean + features: + description: >- + Optional. Feature config for the engine to opt in or opt out of + features. Supported keys: * `*`: all features, if it's present, all + other feature state settings are ignored. * `agent-gallery` * + `no-code-agent-builder` * `prompt-gallery` * `model-selector` * + `notebook-lm` * `people-search` * `people-search-org-chart` * + `bi-directional-audio` * `feedback` * `session-sharing` * + `personalization-memory` - Enables personalization based on user + preferences. + type: object + additionalProperties: + type: string + enumDescriptions: + - The feature state is unspecified. + - The feature is turned on to be accessible. + - The feature is turned off to be inaccessible. + enum: + - FEATURE_STATE_UNSPECIFIED + - FEATURE_STATE_ON + - FEATURE_STATE_OFF + GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig: + id: GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig + description: Configurations for a Chat Engine. + type: object + properties: + agentCreationConfig: + description: >- + The configurationt generate the Dialogflow agent that is associated + to this Engine. Note that these configurations are one-time consumed + by and passed to Dialogflow service. It means they cannot be + retrieved using EngineService.GetEngine or EngineService.ListEngines + API after engine creation. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig + dialogflowAgentToLink: + description: >- + The resource name of an exist Dialogflow agent to link to this Chat + Engine. Customers can either provide `agent_creation_config` to + create agent or provide an agent name that links the agent with the + Chat engine. Format: `projects//locations//agents/`. Note that the + `dialogflow_agent_to_link` are one-time consumed by and passed to + Dialogflow service. It means they cannot be retrieved using + EngineService.GetEngine or EngineService.ListEngines API after + engine creation. Use ChatEngineMetadata.dialogflow_agent for actual + agent association after Engine is created. + type: string + allowCrossRegion: + description: >- + Optional. If the flag set to true, we allow the agent and engine are + in different locations, otherwise the agent and engine are required + to be in the same location. The flag is set to false by default. + Note that the `allow_cross_region` are one-time consumed by and + passed to EngineService.CreateEngine. It means they cannot be + retrieved using EngineService.GetEngine or EngineService.ListEngines + API after engine creation. + type: boolean + GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig: + id: >- + GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig + description: >- + Configurations for generating a Dialogflow agent. Note that these + configurations are one-time consumed by and passed to Dialogflow + service. It means they cannot be retrieved using EngineService.GetEngine + or EngineService.ListEngines API after engine creation. + type: object + properties: + business: + description: >- + Name of the company, organization or other entity that the agent + represents. Used for knowledge connector LLM prompt and for + knowledge search. + type: string + defaultLanguageCode: + description: >- + Required. The default language of the agent as a language tag. See + [Language + Support](https://cloud.google.com/dialogflow/docs/reference/language) + for a list of the currently supported language codes. + type: string + timeZone: + description: >- + Required. The time zone of the agent from the [time zone + database](https://www.iana.org/time-zones), e.g., America/New_York, + Europe/Paris. + type: string + location: + description: >- + Agent location for Agent creation, supported values: global/us/eu. + If not provided, us Engine will create Agent using us-central-1 by + default; eu Engine will create Agent using eu-west-1 by default. + type: string + GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig: + id: GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig + description: Configurations for a Search Engine. + type: object + properties: + searchTier: + description: >- + The search feature tier of this engine. Different tiers might have + different pricing. To learn more, check the pricing documentation. + Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. + type: string + enumDescriptions: + - >- + Default value when the enum is unspecified. This is invalid to + use. + - Standard tier. + - Enterprise tier. + enum: + - SEARCH_TIER_UNSPECIFIED + - SEARCH_TIER_STANDARD + - SEARCH_TIER_ENTERPRISE + searchAddOns: + description: The add-on that this search engine enables. + type: array + items: + type: string + enumDescriptions: + - >- + Default value when the enum is unspecified. This is invalid to + use. + - Large language model add-on. + enum: + - SEARCH_ADD_ON_UNSPECIFIED + - SEARCH_ADD_ON_LLM + GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig: + id: GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig + description: Additional config specs for a Media Recommendation engine. + type: object + properties: + type: + description: >- + Required. The type of engine. e.g., `recommended-for-you`. This + field together with optimization_objective describe engine metadata + to use to control engine training and serving. Currently supported + values: `recommended-for-you`, `others-you-may-like`, + `more-like-this`, `most-popular-items`. + type: string + optimizationObjective: + description: >- + The optimization objective. e.g., `cvr`. This field together with + optimization_objective describe engine metadata to use to control + engine training and serving. Currently supported values: `ctr`, + `cvr`. If not specified, we choose default based on engine type. + Default depends on type of recommendation: `recommended-for-you` => + `ctr` `others-you-may-like` => `ctr` + type: string + optimizationObjectiveConfig: + description: >- + Name and value of the custom threshold for cvr + optimization_objective. For target_field `watch-time`, + target_field_value must be an integer value indicating the media + progress time in seconds between (0, 86400] (excludes 0, includes + 86400) (e.g., 90). For target_field `watch-percentage`, the + target_field_value must be a valid float value between (0, 1.0] + (excludes 0, includes 1.0) (e.g., 0.5). + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig + trainingState: + description: >- + The training state that the engine is in (e.g. `TRAINING` or + `PAUSED`). Since part of the cost of running the service is + frequency of training - this can be used to determine when to train + engine in order to control cost. If not specified: the default value + for `CreateEngine` method is `TRAINING`. The default value for + `UpdateEngine` method is to keep the state the same as before. + type: string + enumDescriptions: + - Unspecified training state. + - The engine training is paused. + - The engine is training. + enum: + - TRAINING_STATE_UNSPECIFIED + - PAUSED + - TRAINING + engineFeaturesConfig: + description: Optional. Additional engine features config. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigEngineFeaturesConfig + GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig: + id: >- + GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig + description: Custom threshold for `cvr` optimization_objective. + type: object + properties: + targetField: + description: >- + Required. The name of the field to target. Currently supported + values: `watch-percentage`, `watch-time`. + type: string + targetFieldValueFloat: + description: Required. The threshold to be applied to the target (e.g., 0.5). + type: number + format: float + GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigEngineFeaturesConfig: + id: >- + GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigEngineFeaturesConfig + description: More feature configs of the selected engine type. + type: object + properties: + recommendedForYouConfig: + description: Recommended for you engine feature config. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig + mostPopularConfig: + description: Most popular engine feature config. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig + GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig: + id: >- + GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig + description: >- + Additional feature configurations for creating a `recommended-for-you` + engine. + type: object + properties: + contextEventType: + description: >- + The type of event with which the engine is queried at prediction + time. If set to `generic`, only `view-item`, `media-play`,and + `media-complete` will be used as `context-event` in engine training. + If set to `view-home-page`, `view-home-page` will also be used as + `context-events` in addition to `view-item`, `media-play`, and + `media-complete`. Currently supported for the `recommended-for-you` + engine. Currently supported values: `view-home-page`, `generic`. + type: string + GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig: + id: >- + GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig + description: >- + Feature configurations that are required for creating a Most Popular + engine. + type: object + properties: + timeWindowDays: + description: >- + The time window of which the engine is queried at training and + prediction time. Positive integers only. The value translates to the + last X days of events. Currently required for the + `most-popular-items` engine. + type: string + format: int64 + GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata: + id: GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata + description: >- + Additional information of a Chat Engine. Fields in this message are + output only. + type: object + properties: + dialogflowAgent: + description: >- + The resource name of a Dialogflow agent, that this Chat Engine + refers to. Format: `projects//locations//agents/`. + type: string + GoogleCloudDiscoveryengineV1betaEngineCommonConfig: + id: GoogleCloudDiscoveryengineV1betaEngineCommonConfig + description: Common configurations for an Engine. + type: object + properties: + companyName: + description: >- + The name of the company, business or entity that is associated with + the engine. Setting this may help improve LLM related features. + type: string + GoogleCloudDiscoveryengineV1betaEvaluation: + id: GoogleCloudDiscoveryengineV1betaEvaluation + description: >- + An evaluation is a single execution (or run) of an evaluation process. + It encapsulates the state of the evaluation and the resulting data. + type: object + properties: + name: + description: >- + Identifier. The full resource name of the Evaluation, in the format + of + `projects/{project}/locations/{location}/evaluations/{evaluation}`. + This field must be a UTF-8 encoded string with a length limit of + 1024 characters. + type: string + evaluationSpec: + description: Required. The specification of the evaluation. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec + qualityMetrics: + description: >- + Output only. The metrics produced by the evaluation, averaged across + all SampleQuerys in the SampleQuerySet. Only populated when the + evaluation's state is SUCCEEDED. + readOnly: true + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1betaQualityMetrics' + state: + description: Output only. The state of the evaluation. + readOnly: true + type: string + enumDescriptions: + - The evaluation is unspecified. + - The service is preparing to run the evaluation. + - The evaluation is in progress. + - The evaluation completed successfully. + - The evaluation failed. + enum: + - STATE_UNSPECIFIED + - PENDING + - RUNNING + - SUCCEEDED + - FAILED + error: + description: >- + Output only. The error that occurred during evaluation. Only + populated when the evaluation's state is FAILED. + readOnly: true + $ref: '#/components/schemas/GoogleRpcStatus' + createTime: + description: Output only. Timestamp the Evaluation was created at. + readOnly: true + type: string + format: google-datetime + endTime: + description: Output only. Timestamp the Evaluation was completed at. + readOnly: true + type: string + format: google-datetime + errorSamples: + description: >- + Output only. A sample of errors encountered while processing the + request. + readOnly: true + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec: + id: GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec + description: Describes the specification of the evaluation. + type: object + properties: + searchRequest: + description: >- + Required. The search request that is used to perform the evaluation. + Only the following fields within SearchRequest are supported; if any + other fields are provided, an UNSUPPORTED error will be returned: * + SearchRequest.serving_config * SearchRequest.branch * + SearchRequest.canonical_filter * SearchRequest.query_expansion_spec + * SearchRequest.spell_correction_spec * + SearchRequest.content_search_spec * SearchRequest.user_pseudo_id + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequest' + querySetSpec: + description: Optional. The specification of the query set. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec + GoogleCloudDiscoveryengineV1betaSearchRequest: + id: GoogleCloudDiscoveryengineV1betaSearchRequest + description: Request message for SearchService.Search method. + type: object + properties: + servingConfig: + description: >- + Required. The resource name of the Search serving config, such as + `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, + or + `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. + This field is used to identify the serving configuration name, set + of models used to make the search. + type: string + branch: + description: >- + The branch resource name, such as + `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. + Use `default_branch` as the branch ID or leave this field empty, to + search documents under the default branch. + type: string + query: + description: Raw search query. + type: string + imageQuery: + description: Raw image query. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery + pageSize: + description: >- + Maximum number of Documents to return. The maximum allowed value + depends on the data type. Values above the maximum value are coerced + to the maximum value. * Websites with basic indexing: Default `10`, + Maximum `25`. * Websites with advanced indexing: Default `25`, + Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is + negative, an `INVALID_ARGUMENT` is returned. + type: integer + format: int32 + pageToken: + description: >- + A page token received from a previous SearchService.Search call. + Provide this to retrieve the subsequent page. When paginating, all + other parameters provided to SearchService.Search must match the + call that provided the page token. Otherwise, an `INVALID_ARGUMENT` + error is returned. + type: string + offset: + description: >- + A 0-indexed integer that specifies the current offset (that is, + starting result location, amongst the Documents deemed by the API as + relevant) in search results. This field is only considered if + page_token is unset. If this field is negative, an + `INVALID_ARGUMENT` is returned. + type: integer + format: int32 + oneBoxPageSize: + description: >- + The maximum number of results to return for OneBox. This applies to + each OneBox type individually. Default number is 10. + type: integer + format: int32 + dataStoreSpecs: + description: >- + Specifications that define the specific DataStores to be searched, + along with configurations for those data stores. This is only + considered for Engines with multiple data stores. For engines with a + single data store, the specs directly under SearchRequest should be + used. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec + filter: + description: >- + The filter syntax consists of an expression language for + constructing a predicate from one or more fields of the documents + being filtered. Filter expression is case-sensitive. If this field + is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in + Vertex AI Search is done by mapping the LHS filter key to a key + property defined in the Vertex AI Search backend -- this mapping is + defined by the customer in their schema. For example a media + customer might have a field 'name' in their schema. In this case the + filter would look like this: filter --> name:'ANY("king kong")' For + more information about filtering including syntax and filter + operators, see + [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + type: string + canonicalFilter: + description: >- + The default filter that is applied when a user performs a search + without checking any filters on the search page. The filter applied + to every search request when quality improvement such as query + expansion is needed. In the case a query does not have a sufficient + amount of results this filter will be used to determine whether or + not to enable the query expansion flow. The original filter will + still be used for the query expanded search. This field is strongly + recommended to achieve high search quality. For more information + about filter syntax, see SearchRequest.filter. + type: string + orderBy: + description: >- + The order in which documents are returned. Documents can be ordered + by a field in an Document object. Leave it unset if ordered by + relevance. `order_by` expression is case-sensitive. For more + information on ordering the website search results, see [Order web + search + results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). + For more information on ordering the healthcare search results, see + [Order healthcare search + results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). + If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. + type: string + userInfo: + description: >- + Information about the end user. Highly recommended for analytics and + personalization. UserInfo.user_agent is used to deduce `device_type` + for analytics. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1betaUserInfo' + languageCode: + description: >- + The BCP-47 language code, such as "en-US" or "sr-Latn". For more + information, see [Standard + fields](https://cloud.google.com/apis/design/standard_fields). This + field helps to better interpret the query. If a value isn't + specified, the query language code is automatically detected, which + may not be accurate. + type: string + regionCode: + description: >- + The Unicode country/region code (CLDR) of a location, such as "US" + and "419". For more information, see [Standard + fields](https://cloud.google.com/apis/design/standard_fields). If + set, then results will be boosted based on the region_code provided. + type: string + facetSpecs: + description: >- + Facet specifications for faceted search. If empty, no facets are + returned. A maximum of 100 values are allowed. Otherwise, an + `INVALID_ARGUMENT` error is returned. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec + boostSpec: + description: >- + Boost specification to boost certain documents. For more information + on boosting, see + [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec + params: + description: >- + Additional search parameters. For public website search only, + supported values are: * `user_country_code`: string. Default empty. + If set to non-empty, results are restricted or boosted based on the + location provided. For example, `user_country_code: "au"` For + available codes see [Country + Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) + * `search_type`: double. Default empty. Enables non-webpage + searching depending on the value. The only valid non-default value + is 1, which enables image searching. For example, `search_type: 1` + type: object + additionalProperties: + type: any + queryExpansionSpec: + description: >- + The query expansion specification that specifies the conditions + under which query expansion occurs. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec + spellCorrectionSpec: + description: >- + The spell correction specification that specifies the mode under + which spell correction takes effect. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec + userPseudoId: + description: >- + A unique identifier for tracking visitors. For example, this could + be implemented with an HTTP cookie, which should be able to uniquely + identify a visitor on a single device. This unique identifier should + not change if the visitor logs in or out of the website. This field + should NOT have a fixed value such as `unknown_visitor`. This should + be the same identifier as UserEvent.user_pseudo_id and + CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 + encoded string with a length limit of 128 characters. Otherwise, an + `INVALID_ARGUMENT` error is returned. + type: string + contentSearchSpec: + description: A specification for configuring the behavior of content search. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec + embeddingSpec: + description: >- + Uses the provided embedding to do additional semantic document + retrieval. The retrieval is based on the dot product of + SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document + embedding that is provided in + SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If + SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not + provided, it will use ServingConfig.EmbeddingConfig.field_path. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec + rankingExpression: + description: >- + Optional. The ranking expression controls the customized ranking on + retrieval documents. This overrides + ServingConfig.ranking_expression. The syntax and supported features + depend on the `ranking_expression_backend` value. If + `ranking_expression_backend` is not provided, it defaults to + `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided + or set to `RANK_BY_EMBEDDING`, it should be a single function or + multiple functions that are joined by "+". * ranking_expression = + function, { " + ", function }; Supported functions: * double * + relevance_score * double * dotProduct(embedding_field_path) Function + variables: * `relevance_score`: pre-defined keywords, used for + measure relevance between query and document. * + `embedding_field_path`: the document embedding field used with query + embedding vector. * `dotProduct`: embedding function between + `embedding_field_path` and query embedding vector. Example ranking + expression: If document has an embedding field doc_embedding, the + ranking expression could be `0.5 * relevance_score + 0.3 * + dotProduct(doc_embedding)`. If ranking_expression_backend is set to + `RANK_BY_FORMULA`, the following expression types (and combinations + of those chained using + or * operators) are supported: * `double` * + `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` + -- reciprocal rank transformation with second argument being a + denominator constant. * `is_nan(signal)` -- returns 0 if signal is + NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if + signal1 is NaN, returns signal2 | double, else returns signal1. Here + are a few examples of ranking formulas that use the supported + ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * + log(keyword_similarity_score)` -- mostly rank by the logarithm of + `keyword_similarity_score` with slight `semantic_smilarity_score` + adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of + `semantic_similarity_score` filling the value with 0 if it's NaN, + also add constant 0.3 adjustment to the final score if + `semantic_similarity_score` is NaN. - `0.2 * + rr(semantic_similarity_score, 16) + 0.8 * + rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal + rank of `keyword_similarity_score` with slight adjustment of + reciprocal rank of `semantic_smilarity_score`. The following signals + are supported: * `semantic_similarity_score`: semantic similarity + adjustment that is calculated using the embeddings generated by a + proprietary Google model. This score determines how semantically + similar a search query is to a document. * + `keyword_similarity_score`: keyword match adjustment uses the Best + Match 25 (BM25) ranking function. This score is calculated using a + probabilistic model to estimate the probability that a document is + relevant to a given query. * `relevance_score`: semantic relevance + adjustment that uses a proprietary Google model to determine the + meaning and intent behind a user's query in context with the content + in the documents. * `pctr_rank`: predicted conversion rate + adjustment as a rank use predicted Click-through rate (pCTR) to + gauge the relevance and attractiveness of a search result from a + user's perspective. A higher pCTR suggests that the result is more + likely to satisfy the user's query and intent, making it a valuable + signal for ranking. * `freshness_rank`: freshness adjustment as a + rank * `document_age`: The time in hours elapsed since the document + was last updated, a floating-point number (e.g., 0.25 means 15 + minutes). * `topicality_rank`: topicality adjustment as a rank. Uses + proprietary Google model to determine the keyword-based overlap + between the query and the document. * `base_rank`: the default rank + of the result + type: string + rankingExpressionBackend: + description: Optional. The backend to use for the ranking expression evaluation. + type: string + enumDescriptions: + - Default option for unspecified/unknown values. + - >- + Deprecated: Use `RANK_BY_EMBEDDING` instead. Ranking by custom + embedding model, the default way to evaluate the ranking + expression. Legacy enum option, `RANK_BY_EMBEDDING` should be used + instead. + - >- + Deprecated: Use `RANK_BY_FORMULA` instead. Ranking by custom + formula. Legacy enum option, `RANK_BY_FORMULA` should be used + instead. + - >- + Ranking by custom embedding model, the default way to evaluate the + ranking expression. + - Ranking by custom formula. + enumDeprecated: + - false + - true + - true + - false + - false + enum: + - RANKING_EXPRESSION_BACKEND_UNSPECIFIED + - BYOE + - CLEARBOX + - RANK_BY_EMBEDDING + - RANK_BY_FORMULA + safeSearch: + description: >- + Whether to turn on safe search. This is only supported for website + search. + type: boolean + userLabels: + description: >- + The user labels applied to a resource must meet the following + requirements: * Each resource can have multiple labels, up to a + maximum of 64. * Each label must be a key-value pair. * Keys have a + minimum length of 1 character and a maximum length of 63 characters + and cannot be empty. Values can be empty and have a maximum length + of 63 characters. * Keys and values can contain only lowercase + letters, numeric characters, underscores, and dashes. All characters + must use UTF-8 encoding, and international characters are allowed. * + The key portion of a label must be unique. However, you can use the + same key with multiple resources. * Keys must start with a lowercase + letter or international character. See [Google Cloud + Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) + for more details. + type: object + additionalProperties: + type: string + naturalLanguageQueryUnderstandingSpec: + description: >- + Config for natural language query understanding capabilities, such + as extracting structured field filters from the query. Refer to + [this + documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) + for more information. If `naturalLanguageQueryUnderstandingSpec` is + not specified, no additional natural language query understanding + will be done. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec + searchAsYouTypeSpec: + description: >- + Search as you type configuration. Only supported for the + IndustryVertical.MEDIA vertical. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec + displaySpec: + description: >- + Optional. Config for display feature, like match highlighting on + search results. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec + session: + description: >- + The session resource name. Optional. Session allows users to do + multi-turn /search API calls or coordination between /search API + calls and /answer API calls. Example #1 (multi-turn /search API + calls): Call /search API with the session ID generated in the first + call. Here, the previous search query gets considered in query + standing. I.e., if the first query is "How did Alphabet do in 2022?" + and the current query is "How about 2023?", the current query will + be interpreted as "How did Alphabet do in 2023?". Example #2 + (coordination between /search API calls and /answer API calls): Call + /answer API with the session ID generated in the first call. Here, + the answer generation happens in the context of the search results + from the first search call. Multi-turn Search feature is currently + at private GA stage. Please use v1alpha or v1beta version instead + before we launch this feature to public GA. Or ask for allowlisting + through Google Support team. + type: string + sessionSpec: + description: Session specification. Can be used only when `session` is set. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec + relevanceThreshold: + description: >- + The relevance threshold of the search results. Default to Google + defined threshold, leveraging a balance of precision and recall to + deliver both highly accurate results and comprehensive coverage of + relevant information. This feature is not supported for healthcare + search. + type: string + enumDescriptions: + - >- + Default value. In this case, server behavior defaults to Google + defined threshold. + - Lowest relevance threshold. + - Low relevance threshold. + - Medium relevance threshold. + - High relevance threshold. + enum: + - RELEVANCE_THRESHOLD_UNSPECIFIED + - LOWEST + - LOW + - MEDIUM + - HIGH + personalizationSpec: + description: >- + The specification for personalization. Notice that if both + ServingConfig.personalization_spec and + SearchRequest.personalization_spec are set, + SearchRequest.personalization_spec overrides + ServingConfig.personalization_spec. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec + relevanceScoreSpec: + description: Optional. The specification for returning the relevance score. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec + GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery: + id: GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery + description: Specifies the image query input. + type: object + properties: + imageBytes: + description: >- + Base64 encoded image bytes. Supported image formats: JPEG, PNG, and + BMP. + type: string + GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec: + id: GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec + description: >- + A struct to define data stores to filter on in a search call and + configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` + error is returned. + type: object + properties: + dataStore: + description: >- + Required. Full resource name of DataStore, such as + `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. + The path must include the project number, project id is not + supported for this field. + type: string + filter: + description: >- + Optional. Filter specification to filter documents in the data store + specified by data_store field. For more information on filtering, + see + [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + type: string + boostSpec: + description: >- + Optional. Boost specification to boost certain documents. For more + information on boosting, see + [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec + customSearchOperators: + description: >- + Optional. Custom search operators which if specified will be used to + filter results from workspace data stores. For more information on + custom search operators, see + [SearchOperators](https://support.google.com/cloudsearch/answer/6172299). + type: string + GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec: + id: GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec + description: Boost specification to boost certain documents. + type: object + properties: + conditionBoostSpecs: + description: >- + Condition boost specifications. If a document matches multiple + conditions in the specifications, boost scores from these + specifications are all applied and combined in a non-linear way. + Maximum number of specifications is 20. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec + GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec: + id: GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec + description: Boost applies to documents which match a condition. + type: object + properties: + condition: + description: >- + An expression which specifies a boost condition. The syntax and + supported fields are the same as a filter expression. See + SearchRequest.filter for detail syntax and limitations. Examples: * + To boost documents with document ID "doc_1" or "doc_2", and color + "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: + ANY("Red", "Blue"))` + type: string + boost: + description: >- + Strength of the condition boost, which should be in [-1, 1]. + Negative boost means demotion. Default is 0.0. Setting to 1.0 gives + the document a big promotion. However, it does not necessarily mean + that the boosted document will be the top result at all times, nor + that other documents will be excluded. Results could still be shown + even when none of them matches the condition. And results that are + significantly more relevant to the search query can still trump your + heavily favored but irrelevant documents. Setting to -1.0 gives the + document a big demotion. However, results that are deeply relevant + might still be shown. The document will have an upstream battle to + get a fairly high ranking, but it is not blocked out completely. + Setting to 0.0 means no boost applied. The boosting condition is + ignored. Only one of the (condition, boost) combination or the + boost_control_spec below are set. If both are set then the global + boost is ignored and the more fine-grained boost_control_spec is + applied. + type: number + format: float + boostControlSpec: + description: >- + Complex specification for custom ranking based on customer defined + attribute value. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec + GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec: + id: >- + GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec + description: >- + Specification for custom ranking based on customer specified attribute + value. It provides more controls for customized ranking than the simple + (condition, boost) combination above. + type: object + properties: + fieldName: + description: >- + The name of the field whose value will be used to determine the + boost amount. + type: string + attributeType: + description: >- + The attribute type to be used to determine the boost amount. The + attribute value can be derived from the field value of the specified + field_name. In the case of numerical it is straightforward i.e. + attribute_value = numerical_field_value. In the case of freshness + however, attribute_value = (time.now() - datetime_field_value). + type: string + enumDescriptions: + - Unspecified AttributeType. + - >- + The value of the numerical field will be used to dynamically + update the boost amount. In this case, the attribute_value (the x + value) of the control point will be the actual value of the + numerical field for which the boost_amount is specified. + - >- + For the freshness use case the attribute value will be the + duration between the current time and the date in the datetime + field specified. The value must be formatted as an XSD + `dayTimeDuration` value (a restricted subset of an ISO 8601 + duration value). The pattern for this is: `nDnM]`. For example, + `5D`, `3DT12H30M`, `T24H`. + enum: + - ATTRIBUTE_TYPE_UNSPECIFIED + - NUMERICAL + - FRESHNESS + interpolationType: + description: >- + The interpolation type to be applied to connect the control points + listed below. + type: string + enumDescriptions: + - >- + Interpolation type is unspecified. In this case, it defaults to + Linear. + - Piecewise linear interpolation will be applied. + enum: + - INTERPOLATION_TYPE_UNSPECIFIED + - LINEAR + controlPoints: + description: >- + The control points used to define the curve. The monotonic function + (defined through the interpolation_type above) passes through the + control points listed here. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint + GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint: + id: >- + GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint + description: >- + The control points used to define the curve. The curve defined through + these control points can only be monotonically increasing or + decreasing(constant values are acceptable). + type: object + properties: + attributeValue: + description: >- + Can be one of: 1. The numerical field value. 2. The duration spec + for freshness: The value must be formatted as an XSD + `dayTimeDuration` value (a restricted subset of an ISO 8601 duration + value). The pattern for this is: `nDnM]`. + type: string + boostAmount: + description: >- + The value between -1 to 1 by which to boost the score if the + attribute_value evaluates to the value specified above. + type: number + format: float + GoogleCloudDiscoveryengineV1betaUserInfo: + id: GoogleCloudDiscoveryengineV1betaUserInfo + description: Information of an end user. + type: object + properties: + userId: + description: >- + Highly recommended for logged-in users. Unique identifier for + logged-in user, such as a user name. Don't set for anonymous users. + Always use a hashed value for this ID. Don't set the field to the + same fixed ID for different users. This mixes the event history of + those users together, which results in degraded model quality. The + field must be a UTF-8 encoded string with a length limit of 128 + characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + type: string + userAgent: + description: >- + User agent as included in the HTTP header. The field must be a UTF-8 + encoded string with a length limit of 1,000 characters. Otherwise, + an `INVALID_ARGUMENT` error is returned. This should not be set when + using the client side event reporting with GTM or JavaScript tag in + UserEventService.CollectUserEvent or if + UserEvent.direct_user_request is set. + type: string + timeZone: + description: Optional. IANA time zone, e.g. Europe/Budapest. + type: string + GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec: + id: GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec + description: A facet specification to perform faceted search. + type: object + properties: + facetKey: + description: Required. The facet key specification. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey + limit: + description: >- + Maximum facet values that are returned for this facet. If + unspecified, defaults to 20. The maximum allowed value is 300. + Values above 300 are coerced to 300. For aggregation in healthcare + search, when the [FacetKey.key] is "healthcare_aggregation_key", the + limit will be overridden to 10,000 internally, regardless of the + value set here. If this field is negative, an `INVALID_ARGUMENT` is + returned. + type: integer + format: int32 + excludedFilterKeys: + description: >- + List of keys to exclude when faceting. By default, FacetKey.key is + not excluded from the filter unless it is listed in this field. + Listing a facet key in this field allows its values to appear as + facet results, even when they are filtered out of search results. + Using this field does not affect what search results are returned. + For example, suppose there are 100 documents with the color facet + "Red" and 200 documents with the color facet "Blue". A query + containing the filter "color:ANY("Red")" and having "color" as + FacetKey.key would by default return only "Red" documents in the + search results, and also return "Red" with count 100 as the only + color facet. Although there are also blue documents available, + "Blue" would not be shown as an available facet value. If "color" is + listed in "excludedFilterKeys", then the query returns the facet + values "Red" with count 100 and "Blue" with count 200, because the + "color" key is now excluded from the filter. Because this field + doesn't affect search results, the search results are still + correctly filtered to return only "Red" documents. A maximum of 100 + values are allowed. Otherwise, an `INVALID_ARGUMENT` error is + returned. + type: array + items: + type: string + enableDynamicPosition: + description: >- + Enables dynamic position for this facet. If set to true, the + position of this facet among all facets in the response is + determined automatically. If dynamic facets are enabled, it is + ordered together. If set to false, the position of this facet in the + response is the same as in the request, and it is ranked before the + facets with dynamic position enable and all dynamic facets. For + example, you may always want to have rating facet returned in the + response, but it's not necessarily to always display the rating + facet at the top. In that case, you can set enable_dynamic_position + to true so that the position of rating facet in response is + determined automatically. Another example, assuming you have the + following facets in the request: * "rating", enable_dynamic_position + = true * "price", enable_dynamic_position = false * "brands", + enable_dynamic_position = false And also you have a dynamic facets + enabled, which generates a facet `gender`. Then the final order of + the facets in the response can be ("price", "brands", "rating", + "gender") or ("price", "brands", "gender", "rating") depends on how + API orders "gender" and "rating" facets. However, notice that + "price" and "brands" are always ranked at first and second position + because their enable_dynamic_position is false. + type: boolean + GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey: + id: GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey + description: Specifies how a facet is computed. + type: object + properties: + key: + description: >- + Required. Supported textual and numerical facet keys in Document + object, over which the facet values are computed. Facet key is + case-sensitive. + type: string + intervals: + description: >- + Set only if values should be bucketed into intervals. Must be set + for facets with numerical values. Must not be set for facet with + text values. Maximum number of intervals is 30. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1betaInterval' + restrictedValues: + description: >- + Only get facet for the given restricted values. Only supported on + textual fields. For example, suppose "category" has three values + "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set + "restricted_values" to "Action > 2022", the "category" facet only + contains "Action > 2022". Only supported on textual fields. Maximum + is 10. + type: array + items: + type: string + prefixes: + description: >- + Only get facet values that start with the given string prefix. For + example, suppose "category" has three values "Action > 2022", + "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", + the "category" facet only contains "Action > 2022" and "Action > + 2021". Only supported on textual fields. Maximum is 10. + type: array + items: + type: string + contains: + description: >- + Only get facet values that contain the given strings. For example, + suppose "category" has three values "Action > 2022", "Action > 2021" + and "Sci-Fi > 2022". If set "contains" to "2022", the "category" + facet only contains "Action > 2022" and "Sci-Fi > 2022". Only + supported on textual fields. Maximum is 10. + type: array + items: + type: string + caseInsensitive: + description: >- + True to make facet keys case insensitive when getting faceting + values with prefixes or contains; false otherwise. + type: boolean + orderBy: + description: >- + The order in which documents are returned. Allowed values are: * + "count desc", which means order by SearchResponse.Facet.values.count + descending. * "value desc", which means order by + SearchResponse.Facet.values.value descending. Only applies to + textual facets. If not set, textual values are sorted in [natural + order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical + intervals are sorted in the order given by + FacetSpec.FacetKey.intervals. + type: string + GoogleCloudDiscoveryengineV1betaInterval: + id: GoogleCloudDiscoveryengineV1betaInterval + description: A floating point interval. + type: object + properties: + minimum: + description: Inclusive lower bound. + type: number + format: double + exclusiveMinimum: + description: Exclusive lower bound. + type: number + format: double + maximum: + description: Inclusive upper bound. + type: number + format: double + exclusiveMaximum: + description: Exclusive upper bound. + type: number + format: double + GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec: + id: GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec + description: >- + Specification to determine under which conditions query expansion should + occur. + type: object + properties: + condition: + description: >- + The condition under which query expansion should occur. Default to + Condition.DISABLED. + type: string + enumDescriptions: + - >- + Unspecified query expansion condition. In this case, server + behavior defaults to Condition.DISABLED. + - >- + Disabled query expansion. Only the exact search query is used, + even if SearchResponse.total_size is zero. + - Automatic query expansion built by the Search API. + enum: + - CONDITION_UNSPECIFIED + - DISABLED + - AUTO + pinUnexpandedResults: + description: >- + Whether to pin unexpanded results. If this field is set to true, + unexpanded products are always at the top of the search results, + followed by the expanded results. + type: boolean + GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec: + id: GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec + description: The specification for query spell correction. + type: object + properties: + mode: + description: >- + The mode under which spell correction replaces the original search + query. Defaults to Mode.AUTO. + type: string + enumDescriptions: + - >- + Unspecified spell correction mode. In this case, server behavior + defaults to Mode.AUTO. + - >- + Search API tries to find a spelling suggestion. If a suggestion is + found, it is put in the SearchResponse.corrected_query. The + spelling suggestion won't be used as the search query. + - >- + Automatic spell correction built by the Search API. Search will be + based on the corrected query if found. + enum: + - MODE_UNSPECIFIED + - SUGGESTION_ONLY + - AUTO + GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec: + id: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec + description: A specification for configuring the behavior of content search. + type: object + properties: + snippetSpec: + description: >- + If `snippetSpec` is not specified, snippets are not included in the + search response. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec + summarySpec: + description: >- + If `summarySpec` is not specified, summaries are not included in the + search response. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec + extractiveContentSpec: + description: >- + If there is no extractive_content_spec provided, there will be no + extractive answer in the search response. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec + searchResultMode: + description: >- + Specifies the search result mode. If unspecified, the search result + mode defaults to `DOCUMENTS`. + type: string + enumDescriptions: + - Default value. + - Returns documents in the search result. + - >- + Returns chunks in the search result. Only available if the + DocumentProcessingConfig.chunking_config is specified. + enum: + - SEARCH_RESULT_MODE_UNSPECIFIED + - DOCUMENTS + - CHUNKS + chunkSpec: + description: >- + Specifies the chunk spec to be returned from the search response. + Only available if the + SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec + GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec: + id: >- + GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec + description: A specification for configuring snippets in a search response. + type: object + properties: + maxSnippetCount: + description: >- + [DEPRECATED] This field is deprecated. To control snippet return, + use `return_snippet` field. For backwards compatibility, we will + return snippet if max_snippet_count > 0. + deprecated: true + type: integer + format: int32 + referenceOnly: + description: >- + [DEPRECATED] This field is deprecated and will have no affect on the + snippet. + deprecated: true + type: boolean + returnSnippet: + description: >- + If `true`, then return snippet. If no snippet can be generated, we + return "No snippet is available for this page." A `snippet_status` + with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned. + type: boolean + GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec: + id: >- + GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec + description: A specification for configuring a summary returned in a search response. + type: object + properties: + summaryResultCount: + description: >- + The number of top results to generate the summary from. If the + number of results returned is less than `summaryResultCount`, the + summary is generated from all of the results. At most 10 results for + documents mode, or 50 for chunks mode, can be used to generate a + summary. The chunks mode is used when + SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS. + type: integer + format: int32 + includeCitations: + description: >- + Specifies whether to include citations in the summary. The default + value is `false`. When this field is set to `true`, summaries + include in-line citation numbers. Example summary including + citations: BigQuery is Google Cloud's fully managed and completely + serverless enterprise data warehouse [1]. BigQuery supports all data + types, works across clouds, and has built-in machine learning and + business intelligence, all within a unified platform [2, 3]. The + citation numbers refer to the returned search results and are + 1-indexed. For example, [1] means that the sentence is attributed to + the first search result. [2, 3] means that the sentence is + attributed to both the second and third search results. + type: boolean + ignoreAdversarialQuery: + description: >- + Specifies whether to filter out adversarial queries. The default + value is `false`. Google employs search-query classification to + detect adversarial queries. No summary is returned if the search + query is classified as an adversarial query. For example, a user + might ask a question regarding negative comments about the company + or submit a query designed to generate unsafe, policy-violating + output. If this field is set to `true`, we skip generating summaries + for adversarial queries and return fallback messages instead. + type: boolean + ignoreNonSummarySeekingQuery: + description: >- + Specifies whether to filter out queries that are not + summary-seeking. The default value is `false`. Google employs + search-query classification to detect summary-seeking queries. No + summary is returned if the search query is classified as a + non-summary seeking query. For example, `why is the sky blue` and + `Who is the best soccer player in the world?` are summary-seeking + queries, but `SFO airport` and `world cup 2026` are not. They are + most likely navigational queries. If this field is set to `true`, we + skip generating summaries for non-summary seeking queries and return + fallback messages instead. + type: boolean + ignoreLowRelevantContent: + description: >- + Specifies whether to filter out queries that have low relevance. The + default value is `false`. If this field is set to `false`, all + search results are used regardless of relevance to generate answers. + If set to `true`, only queries with high relevance search results + will generate answers. + type: boolean + ignoreJailBreakingQuery: + description: >- + Optional. Specifies whether to filter out jail-breaking queries. The + default value is `false`. Google employs search-query classification + to detect jail-breaking queries. No summary is returned if the + search query is classified as a jail-breaking query. A user might + add instructions to the query to change the tone, style, language, + content of the answer, or ask the model to act as a different + entity, e.g. "Reply in the tone of a competing company's CEO". If + this field is set to `true`, we skip generating summaries for + jail-breaking queries and return fallback messages instead. + type: boolean + multimodalSpec: + description: Optional. Multimodal specification. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecMultiModalSpec + modelPromptSpec: + description: >- + If specified, the spec will be used to modify the prompt provided to + the LLM. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec + languageCode: + description: >- + Language code for Summary. Use language tags defined by + [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is + an experimental feature. + type: string + modelSpec: + description: >- + If specified, the spec will be used to modify the model + specification provided to the LLM. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec + useSemanticChunks: + description: >- + If true, answer will be generated from most relevant chunks from top + search results. This feature will improve summary quality. Note that + with this feature enabled, not all top search results will be + referenced and included in the reference list, so the citation + source index only points to the search results listed in the + reference list. + type: boolean + GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecMultiModalSpec: + id: >- + GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecMultiModalSpec + description: >- + Multimodal specification: Will return an image from specified source. If + multiple sources are specified, the pick is a quality based decision. + type: object + properties: + imageSource: + description: Optional. Source of image returned in the answer. + type: string + enumDescriptions: + - >- + Unspecified image source (multimodal feature is disabled by + default). + - >- + Behavior when service determines the pick from all available + sources. + - Includes image from corpus in the answer. + - Triggers figure generation in the answer. + enum: + - IMAGE_SOURCE_UNSPECIFIED + - ALL_AVAILABLE_SOURCES + - CORPUS_IMAGE_ONLY + - FIGURE_GENERATION_ONLY + GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec: + id: >- + GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec + description: Specification of the prompt to use with the model. + type: object + properties: + preamble: + description: >- + Text at the beginning of the prompt that instructs the assistant. + Examples are available in the user guide. + type: string + GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec: + id: >- + GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec + description: Specification of the model. + type: object + properties: + version: + description: >- + The model version used to generate the summary. Supported values + are: * `stable`: string. Default value when no value is specified. + Uses a generally available, fine-tuned model. For more information, + see [Answer generation model versions and + lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). + * `preview`: string. (Public preview) Uses a preview model. For more + information, see [Answer generation model versions and + lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). + type: string + GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec: + id: >- + GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec + description: >- + A specification for configuring the extractive content in a search + response. + type: object + properties: + maxExtractiveAnswerCount: + description: >- + The maximum number of extractive answers returned in each search + result. An extractive answer is a verbatim answer extracted from the + original document, which provides a precise and contextually + relevant answer to the search query. If the number of matching + answers is less than the `max_extractive_answer_count`, return all + of the answers. Otherwise, return the `max_extractive_answer_count`. + At most five answers are returned for each SearchResult. + type: integer + format: int32 + maxExtractiveSegmentCount: + description: >- + The max number of extractive segments returned in each search + result. Only applied if the DataStore is set to + DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types + is SOLUTION_TYPE_CHAT. An extractive segment is a text segment + extracted from the original document that is relevant to the search + query, and, in general, more verbose than an extractive answer. The + segment could then be used as input for LLMs to generate summaries + and answers. If the number of matching segments is less than + `max_extractive_segment_count`, return all of the segments. + Otherwise, return the `max_extractive_segment_count`. + type: integer + format: int32 + returnExtractiveSegmentScore: + description: >- + Specifies whether to return the confidence score from the extractive + segments in each search result. This feature is available only for + new or allowlisted data stores. To allowlist your data store, + contact your Customer Engineer. The default value is `false`. + type: boolean + numPreviousSegments: + description: >- + Specifies whether to also include the adjacent from each selected + segments. Return at most `num_previous_segments` segments before + each selected segments. + type: integer + format: int32 + numNextSegments: + description: >- + Return at most `num_next_segments` segments after each selected + segments. + type: integer + format: int32 + GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec: + id: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec + description: >- + Specifies the chunk spec to be returned from the search response. Only + available if the SearchRequest.ContentSearchSpec.search_result_mode is + set to CHUNKS + type: object + properties: + numPreviousChunks: + description: >- + The number of previous chunks to be returned of the current chunk. + The maximum allowed value is 3. If not specified, no previous chunks + will be returned. + type: integer + format: int32 + numNextChunks: + description: >- + The number of next chunks to be returned of the current chunk. The + maximum allowed value is 3. If not specified, no next chunks will be + returned. + type: integer + format: int32 + GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec: + id: GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec + description: >- + The specification that uses customized query embedding vector to do + semantic document retrieval. + type: object + properties: + embeddingVectors: + description: The embedding vector used for retrieval. Limit to 1. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector + GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector: + id: >- + GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector + description: Embedding vector. + type: object + properties: + fieldPath: + description: Embedding field path in schema. + type: string + vector: + description: Query embedding vector. + type: array + items: + type: number + format: float + GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec: + id: >- + GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec + description: >- + Specification to enable natural language understanding capabilities for + search requests. + type: object + properties: + filterExtractionCondition: + description: >- + The condition under which filter extraction should occur. Server + behavior defaults to `DISABLED`. + type: string + enumDescriptions: + - Server behavior defaults to `DISABLED`. + - Disables NL filter extraction. + - Enables NL filter extraction. + enum: + - CONDITION_UNSPECIFIED + - DISABLED + - ENABLED + geoSearchQueryDetectionFieldNames: + description: >- + Field names used for location-based filtering, where geolocation + filters are detected in natural language search queries. Only valid + when the FilterExtractionCondition is set to `ENABLED`. If this + field is set, it overrides the field names set in + ServingConfig.geo_search_query_detection_field_names. + type: array + items: + type: string + extractedFilterBehavior: + description: >- + Optional. Controls behavior of how extracted filters are applied to + the search. The default behavior depends on the request. For single + datastore structured search, the default is `HARD_FILTER`. For + multi-datastore search, the default behavior is `SOFT_BOOST`. + Location-based filters are always applied as hard filters, and the + `SOFT_BOOST` setting will not affect them. This field is only used + if + SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition + is set to FilterExtractionCondition.ENABLED. + type: string + enumDescriptions: + - >- + `EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED` will use the default + behavior for extracted filters. For single datastore search, the + default is to apply as hard filters. For multi-datastore search, + the default is to apply as soft boosts. + - >- + Applies all extracted filters as hard filters on the results. + Results that do not pass the extracted filters will not be + returned in the result set. + - >- + Applies all extracted filters as soft boosts. Results that pass + the filters will be boosted up to higher ranks in the result set. + enum: + - EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED + - HARD_FILTER + - SOFT_BOOST + GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec: + id: GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec + description: Specification for search as you type in search requests. + type: object + properties: + condition: + description: >- + The condition under which search as you type should occur. Default + to Condition.DISABLED. + type: string + enumDescriptions: + - Server behavior defaults to Condition.DISABLED. + - Disables Search As You Type. + - Enables Search As You Type. + - >- + Automatic switching between search-as-you-type and standard search + modes, ideal for single-API implementations (e.g., debouncing). + enum: + - CONDITION_UNSPECIFIED + - DISABLED + - ENABLED + - AUTO + GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec: + id: GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec + description: Specifies features for display, like match highlighting. + type: object + properties: + matchHighlightingCondition: + description: The condition under which match highlighting should occur. + type: string + enumDescriptions: + - Server behavior is the same as `MATCH_HIGHLIGHTING_DISABLED`. + - Disables match highlighting on all documents. + - Enables match highlighting on all documents. + enum: + - MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED + - MATCH_HIGHLIGHTING_DISABLED + - MATCH_HIGHLIGHTING_ENABLED + GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec: + id: GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec + description: >- + Session specification. Multi-turn Search feature is currently at private + GA stage. Please use v1alpha or v1beta version instead before we launch + this feature to public GA. Or ask for allowlisting through Google + Support team. + type: object + properties: + queryId: + description: >- + If set, the search result gets stored to the "turn" specified by + this query ID. Example: Let's say the session looks like this: + session { name: ".../sessions/xxx" turns { query { text: "What is + foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { + query { text: "How about bar then?" query_id: ".../questions/zzz" } + } } The user can call /search API with a request like this: session: + ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } + Then, the API stores the search result, associated with the last + turn. The stored search result can be used by a subsequent /answer + API call (with the session ID and the query ID specified). Also, it + is possible to call /search and /answer in parallel with the same + session ID & query ID. + type: string + searchResultPersistenceCount: + description: >- + The number of top search results to persist. The persisted search + results can be used for the subsequent /answer api call. This field + is similar to the `summary_result_count` field in + SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At + most 10 results for documents mode, or 50 for chunks mode. + type: integer + format: int32 + GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec: + id: GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec + description: The specification for personalization. + type: object + properties: + mode: + description: >- + The personalization mode of the search request. Defaults to + Mode.AUTO. + type: string + enumDescriptions: + - >- + Default value. In this case, server behavior defaults to + Mode.AUTO. + - Personalization is enabled if data quality requirements are met. + - Disable personalization. + enum: + - MODE_UNSPECIFIED + - AUTO + - DISABLED + GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec: + id: GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec + description: The specification for returning the document relevance score. + type: object + properties: + returnRelevanceScore: + description: >- + Optional. Whether to return the relevance score for search results. + The higher the score, the more relevant the document is to the + query. + type: boolean + GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec: + id: GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec + description: Describes the specification of the query set. + type: object + properties: + sampleQuerySet: + description: >- + Optional. The full resource name of the SampleQuerySet used for the + evaluation, in the format of + `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. + type: string + GoogleCloudDiscoveryengineV1betaQualityMetrics: + id: GoogleCloudDiscoveryengineV1betaQualityMetrics + description: Describes the metrics produced by the evaluation. + type: object + properties: + docRecall: + description: >- + Recall per document, at various top-k cutoff levels. Recall is the + fraction of relevant documents retrieved out of all relevant + documents. Example (top-5): * For a single SampleQuery, If 3 out of + 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = + 0.6 + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics + docPrecision: + description: >- + Precision per document, at various top-k cutoff levels. Precision is + the fraction of retrieved documents that are relevant. Example + (top-5): * For a single SampleQuery, If 4 out of 5 retrieved + documents in the top-5 are relevant, precision@5 = 4/5 = 0.8 + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics + docNdcg: + description: >- + Normalized discounted cumulative gain (NDCG) per document, at + various top-k cutoff levels. NDCG measures the ranking quality, + giving higher relevance to top results. Example (top-3): Suppose + SampleQuery with three retrieved documents (D1, D2, D3) and binary + relevance judgements (1 for relevant, 0 for not relevant): + Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] + Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693 + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics + pageRecall: + description: >- + Recall per page, at various top-k cutoff levels. Recall is the + fraction of relevant pages retrieved out of all relevant pages. + Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant + pages are retrieved in the top-5, recall@5 = 3/5 = 0.6 + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics + pageNdcg: + description: >- + Normalized discounted cumulative gain (NDCG) per page, at various + top-k cutoff levels. NDCG measures the ranking quality, giving + higher relevance to top results. Example (top-3): Suppose + SampleQuery with three retrieved pages (P1, P2, P3) and binary + relevance judgements (1 for relevant, 0 for not relevant): + Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] + Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693 + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics + GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics: + id: GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics + description: Stores the metric values at specific top-k levels. + type: object + properties: + top1: + description: The top-1 value. + type: number + format: double + top3: + description: The top-3 value. + type: number + format: double + top5: + description: The top-5 value. + type: number + format: double + top10: + description: The top-10 value. + type: number + format: double + GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata: + id: GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata + description: >- + IdentityMappingEntry LongRunningOperation metadata for + IdentityMappingStoreService.ImportIdentityMappings and + IdentityMappingStoreService.PurgeIdentityMappings + type: object + properties: + successCount: + description: >- + The number of IdentityMappingEntries that were successfully + processed. + type: string + format: int64 + failureCount: + description: The number of IdentityMappingEntries that failed to be processed. + type: string + format: int64 + totalCount: + description: The total number of IdentityMappingEntries that were processed. + type: string + format: int64 + GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata: + id: GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata + description: >- + Metadata related to the progress of the ImportCompletionSuggestions + operation. This will be returned by the + google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + successCount: + description: Count of CompletionSuggestions successfully imported. + type: string + format: int64 + failureCount: + description: Count of CompletionSuggestions that failed to be imported. + type: string + format: int64 + GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsResponse: + id: GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsResponse + description: >- + Response of the CompletionService.ImportCompletionSuggestions method. If + the long running operation is done, this message is returned by the + google.longrunning.Operations.response field if the operation is + successful. + type: object + properties: + errorSamples: + description: A sample of errors encountered while processing the request. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + errorConfig: + description: The desired location of errors incurred during the Import. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaImportErrorConfig + GoogleCloudDiscoveryengineV1betaImportErrorConfig: + id: GoogleCloudDiscoveryengineV1betaImportErrorConfig + description: Configuration of destination for Import related errors. + type: object + properties: + gcsPrefix: + description: >- + Cloud Storage prefix for import errors. This must be an empty, + existing Cloud Storage directory. Import errors are written to + sharded files in this directory, one per line, as a JSON-encoded + `google.rpc.Status` message. + type: string + GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata: + id: GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata + description: >- + Metadata related to the progress of the ImportDocuments operation. This + is returned by the google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + successCount: + description: Count of entries that were processed successfully. + type: string + format: int64 + failureCount: + description: Count of entries that encountered errors while processing. + type: string + format: int64 + totalCount: + description: Total count of entries that were processed. + type: string + format: int64 + GoogleCloudDiscoveryengineV1betaImportDocumentsResponse: + id: GoogleCloudDiscoveryengineV1betaImportDocumentsResponse + description: >- + Response of the ImportDocumentsRequest. If the long running operation is + done, then this message is returned by the + google.longrunning.Operations.response field if the operation was + successful. + type: object + properties: + errorSamples: + description: A sample of errors encountered while processing the request. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + errorConfig: + description: >- + Echoes the destination for the complete errors in the request if + set. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaImportErrorConfig + GoogleCloudDiscoveryengineV1betaImportIdentityMappingsResponse: + id: GoogleCloudDiscoveryengineV1betaImportIdentityMappingsResponse + description: Response message for IdentityMappingStoreService.ImportIdentityMappings + type: object + properties: + errorSamples: + description: A sample of errors encountered while processing the request. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata: + id: GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata + description: >- + Metadata related to the progress of the ImportSampleQueries operation. + This will be returned by the google.longrunning.Operation.metadata + field. + type: object + properties: + createTime: + description: ImportSampleQueries operation create time. + type: string + format: google-datetime + updateTime: + description: >- + ImportSampleQueries operation last update time. If the operation is + done, this is also the finish time. + type: string + format: google-datetime + successCount: + description: Count of SampleQuerys successfully imported. + type: string + format: int64 + failureCount: + description: Count of SampleQuerys that failed to be imported. + type: string + format: int64 + totalCount: + description: Total count of SampleQuerys that were processed. + type: string + format: int64 + GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse: + id: GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse + description: >- + Response of the SampleQueryService.ImportSampleQueries method. If the + long running operation is done, this message is returned by the + google.longrunning.Operations.response field if the operation is + successful. + type: object + properties: + errorSamples: + description: A sample of errors encountered while processing the request. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + errorConfig: + description: The desired location of errors incurred during the Import. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaImportErrorConfig + GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata: + id: GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata + description: >- + Metadata related to the progress of the ImportSuggestionDenyListEntries + operation. This is returned by the google.longrunning.Operation.metadata + field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse: + id: GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse + description: >- + Response message for CompletionService.ImportSuggestionDenyListEntries + method. + type: object + properties: + errorSamples: + description: A sample of errors encountered while processing the request. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + importedEntriesCount: + description: Count of deny list entries successfully imported. + type: string + format: int64 + failedEntriesCount: + description: Count of deny list entries that failed to be imported. + type: string + format: int64 + GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata: + id: GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata + description: >- + Metadata related to the progress of the Import operation. This is + returned by the google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + successCount: + description: Count of entries that were processed successfully. + type: string + format: int64 + failureCount: + description: Count of entries that encountered errors while processing. + type: string + format: int64 + GoogleCloudDiscoveryengineV1betaImportUserEventsResponse: + id: GoogleCloudDiscoveryengineV1betaImportUserEventsResponse + description: >- + Response of the ImportUserEventsRequest. If the long running operation + was successful, then this message is returned by the + google.longrunning.Operations.response field if the operation was + successful. + type: object + properties: + errorSamples: + description: A sample of errors encountered while processing the request. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + errorConfig: + description: >- + Echoes the destination for the complete errors if this field was set + in the request. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaImportErrorConfig + joinedEventsCount: + description: Count of user events imported with complete existing Documents. + type: string + format: int64 + unjoinedEventsCount: + description: >- + Count of user events imported, but with Document information not + found in the existing Branch. + type: string + format: int64 + GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse: + id: GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse + description: >- + Response message for CrawlRateManagementService.ObtainCrawlRate method. + The response contains organcic or dedicated crawl rate time series data + for monitoring, depending on whether dedicated crawl rate is set. + type: object + properties: + organicCrawlRateTimeSeries: + description: >- + The historical organic crawl rate timeseries data, used for + monitoring. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries + dedicatedCrawlRateTimeSeries: + description: >- + The historical dedicated crawl rate timeseries data, used for + monitoring. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries + state: + description: Output only. The state of the response. + readOnly: true + type: string + enumDescriptions: + - The state is unspecified. + - The state is successful. + - The state is failed. + enum: + - STATE_UNSPECIFIED + - SUCCEEDED + - FAILED + error: + description: Errors from service when handling the request. + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries: + id: GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries + description: >- + The historical organic crawl rate timeseries data, used for monitoring. + Organic crawl is auto-determined by Google to crawl the user's website + when dedicate crawl is not set. Crawl rate is the QPS of crawl request + Google sends to the user's website. + type: object + properties: + googleOrganicCrawlRate: + description: >- + Google's organic crawl rate time series, which is the sum of all + googlebots' crawl rate. Please refer to + https://developers.google.com/search/docs/crawling-indexing/overview-google-crawlers + for more details about googlebots. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries + vertexAiOrganicCrawlRate: + description: >- + Vertex AI's organic crawl rate time series, which is the crawl rate + of Google-CloudVertexBot when dedicate crawl is not set. Please + refer to + https://developers.google.com/search/docs/crawling-indexing/google-common-crawlers#google-cloudvertexbot + for more details about Google-CloudVertexBot. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries + GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries: + id: GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries + description: The historical crawl rate timeseries data, used for monitoring. + type: object + properties: + qpsTimeSeries: + description: The QPS of the crawl rate. + $ref: '#/components/schemas/GoogleMonitoringV3TimeSeries' + GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries: + id: GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries + description: >- + The historical dedicated crawl rate timeseries data, used for + monitoring. Dedicated crawl is used by Vertex AI to crawl the user's + website when dedicate crawl is set. + type: object + properties: + userTriggeredCrawlRate: + description: >- + Vertex AI's dedicated crawl rate time series of user triggered + crawl, which is the crawl rate of Google-CloudVertexBot when + dedicate crawl is set, and user triggered crawl rate is for + deterministic use cases like crawling urls or sitemaps specified by + users. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries + autoRefreshCrawlRate: + description: >- + Vertex AI's dedicated crawl rate time series of auto-refresh, which + is the crawl rate of Google-CloudVertexBot when dedicate crawl is + set, and the crawl rate is for best effort use cases like refreshing + urls periodically. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries + userTriggeredCrawlErrorRate: + description: >- + Vertex AI's error rate time series of user triggered dedicated + crawl. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries + autoRefreshCrawlErrorRate: + description: Vertex AI's error rate time series of auto-refresh dedicated crawl. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries + GoogleCloudDiscoveryengineV1betaProject: + id: GoogleCloudDiscoveryengineV1betaProject + description: Metadata and configurations for a Google Cloud project in the service. + type: object + properties: + name: + description: >- + Output only. Full resource name of the project, for example + `projects/{project}`. Note that when making requests, project number + and project id are both acceptable, but the server will always + respond in project number. + readOnly: true + type: string + createTime: + description: Output only. The timestamp when this project is created. + readOnly: true + type: string + format: google-datetime + provisionCompletionTime: + description: >- + Output only. The timestamp when this project is successfully + provisioned. Empty value means this project is still provisioning + and is not ready for use. + readOnly: true + type: string + format: google-datetime + serviceTermsMap: + description: >- + Output only. A map of terms of services. The key is the `id` of + ServiceTerms. + readOnly: true + type: object + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaProjectServiceTerms + GoogleCloudDiscoveryengineV1betaProjectServiceTerms: + id: GoogleCloudDiscoveryengineV1betaProjectServiceTerms + description: Metadata about the terms of service. + type: object + properties: + id: + description: >- + The unique identifier of this terms of service. Available terms: * + `GA_DATA_USE_TERMS`: [Terms for data + use](https://cloud.google.com/retail/data-use-terms). When using + this as `id`, the acceptable version to provide is `2022-11-23`. + type: string + version: + description: >- + The version string of the terms of service. For acceptable values, + see the comments for id above. + type: string + state: + description: >- + Whether the project has accepted/rejected the service terms or it is + still pending. + type: string + enumDescriptions: + - The default value of the enum. This value is not actually used. + - The project has given consent to the terms of service. + - The project is pending to review and accept the terms of service. + - >- + The project has declined or revoked the agreement to terms of + service. + enum: + - STATE_UNSPECIFIED + - TERMS_ACCEPTED + - TERMS_PENDING + - TERMS_DECLINED + acceptTime: + description: The last time when the project agreed to the terms of service. + type: string + format: google-datetime + declineTime: + description: >- + The last time when the project declined or revoked the agreement to + terms of service. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata: + id: GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata + description: Metadata associated with a project provision operation. + type: object + properties: {} + GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata: + id: GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata + description: >- + Metadata related to the progress of the PurgeDocuments operation. This + will be returned by the google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + successCount: + description: Count of entries that were deleted successfully. + type: string + format: int64 + failureCount: + description: Count of entries that encountered errors while processing. + type: string + format: int64 + ignoredCount: + description: Count of entries that were ignored as entries were not found. + type: string + format: int64 + GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse: + id: GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse + description: >- + Response message for DocumentService.PurgeDocuments method. If the long + running operation is successfully done, then this message is returned by + the google.longrunning.Operations.response field. + type: object + properties: + purgeCount: + description: The total count of documents purged as a result of the operation. + type: string + format: int64 + purgeSample: + description: >- + A sample of document names that will be deleted. Only populated if + `force` is set to false. A max of 100 names will be returned and the + names are chosen at random. + type: array + items: + type: string + GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata: + id: GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata + description: >- + Metadata related to the progress of the PurgeSuggestionDenyListEntries + operation. This is returned by the google.longrunning.Operation.metadata + field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse: + id: GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse + description: >- + Response message for CompletionService.PurgeSuggestionDenyListEntries + method. + type: object + properties: + purgeCount: + description: Number of suggestion deny list entries purged. + type: string + format: int64 + errorSamples: + description: A sample of errors encountered while processing the request. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata: + id: GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata + description: >- + Metadata related to the progress of the + CrawlRateManagementService.RemoveDedicatedCrawlRate operation. This will + be returned by the google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse: + id: GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse + description: >- + Response message for CrawlRateManagementService.RemoveDedicatedCrawlRate + method. It simply returns the state of the response, and an error + message if the state is FAILED. + type: object + properties: + state: + description: Output only. The state of the response. + readOnly: true + type: string + enumDescriptions: + - The state is unspecified. + - The state is successful. + - The state is failed. + enum: + - STATE_UNSPECIFIED + - SUCCEEDED + - FAILED + error: + description: Errors from service when handling the request. + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata: + id: GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata + description: >- + Metadata related to the progress of the + CrawlRateManagementService.SetDedicatedCrawlRate operation. This will be + returned by the google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse: + id: GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse + description: >- + Response message for CrawlRateManagementService.SetDedicatedCrawlRate + method. It simply returns the state of the response, and an error + message if the state is FAILED. + type: object + properties: + state: + description: Output only. The state of the response. + readOnly: true + type: string + enumDescriptions: + - The state is unspecified. + - The state is successful. + - The state is failed. + enum: + - STATE_UNSPECIFIED + - SUCCEEDED + - FAILED + error: + description: Errors from service when handling the request. + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudDiscoveryengineV1betaSitemap: + id: GoogleCloudDiscoveryengineV1betaSitemap + description: A sitemap for the SiteSearchEngine. + type: object + properties: + uri: + description: Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`. + type: string + name: + description: >- + Output only. The fully qualified resource name of the sitemap. + `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/*` + The `sitemap_id` suffix is system-generated. + readOnly: true + type: string + createTime: + description: Output only. The sitemap's creation time. + readOnly: true + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata: + id: GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata + description: >- + Metadata related to the progress of the TrainCustomModel operation. This + is returned by the google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse: + id: GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse + description: >- + Response of the TrainCustomModelRequest. This message is returned by the + google.longrunning.Operations.response field. + type: object + properties: + errorSamples: + description: A sample of errors encountered while processing the data. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + errorConfig: + description: >- + Echoes the destination for the complete errors in the request if + set. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaImportErrorConfig + modelStatus: + description: >- + The trained model status. Possible values are: * **bad-data**: The + training data quality is bad. * **no-improvement**: Tuning didn't + improve performance. Won't deploy. * **in-progress**: Model training + job creation is in progress. * **training**: Model is actively + training. * **evaluating**: The model is evaluating trained metrics. + * **indexing**: The model trained metrics are indexing. * **ready**: + The model is ready for serving. + type: string + metrics: + description: The metrics of the trained model. + type: object + additionalProperties: + type: number + format: double + modelName: + description: Fully qualified name of the CustomTuningModel. + type: string + GoogleCloudDiscoveryengineV1betaTuneEngineMetadata: + id: GoogleCloudDiscoveryengineV1betaTuneEngineMetadata + description: Metadata associated with a tune operation. + type: object + properties: + engine: + description: >- + Required. The resource name of the engine that this tune applies to. + Format: + `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}` + type: string + GoogleCloudDiscoveryengineV1betaTuneEngineResponse: + id: GoogleCloudDiscoveryengineV1betaTuneEngineResponse + description: Response associated with a tune operation. + type: object + properties: {} + GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata: + id: GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata + description: Metadata for UpdateSchema LRO. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1betaUpdateTargetSiteMetadata: + id: GoogleCloudDiscoveryengineV1betaUpdateTargetSiteMetadata + description: >- + Metadata related to the progress of the + SiteSearchEngineService.UpdateTargetSite operation. This will be + returned by the google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + parameters: + 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: + type: string + enum: + - json + - media + - proto + 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 + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + x-stackQL-resources: + media: + id: google.discoveryengine.media + name: media + title: Media + methods: + media_download: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1engines~1{enginesId}~1sessions~1{sessionsId}:downloadFile/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + projects: + id: google.discoveryengine.projects + name: projects + title: Projects + methods: + projects_provision: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}:provision/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + operations: + id: google.discoveryengine.operations + name: operations + title: Operations + methods: + projects_operations_list: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1operations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.operations + projects_operations_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_operations_cancel: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1operations~1{operationsId}:cancel/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_collections_data_connector_operations_list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataConnector~1operations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.operations + projects_locations_collections_data_connector_operations_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataConnector~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_collections_operations_list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1operations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.operations + projects_locations_collections_operations_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_collections_data_stores_models_operations_list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1models~1{modelsId}~1operations/get + response: mediaType: application/json openAPIDocKey: '200' - projects_locations_collections_engines_operations_list: + objectKey: $.operations + projects_locations_collections_data_stores_models_operations_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1engines~1{enginesId}~1operations/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1models~1{modelsId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_collections_data_stores_operations_list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1operations/get response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_locations_collections_engines_operations_get: + projects_locations_collections_data_stores_branches_operations_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1engines~1{enginesId}~1operations~1{operationsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1branches~1{branchesId}~1operations/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_identity_mapping_stores_operations_list: + objectKey: $.operations + projects_locations_collections_data_stores_branches_operations_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1identityMappingStores~1{identityMappingStoresId}~1operations/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1branches~1{branchesId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_collections_data_stores_branches_operations_cancel: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1branches~1{branchesId}~1operations~1{operationsId}:cancel/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_collections_data_stores_schemas_operations_list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1schemas~1{schemasId}~1operations/get response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_locations_identity_mapping_stores_operations_get: + projects_locations_collections_data_stores_schemas_operations_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1identityMappingStores~1{identityMappingStoresId}~1operations~1{operationsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1schemas~1{schemasId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_collections_engines_operations_list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1engines~1{enginesId}~1operations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.operations + projects_locations_collections_engines_operations_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1engines~1{enginesId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_collections_engines_operations_cancel: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1engines~1{enginesId}~1operations~1{operationsId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' @@ -15300,6 +21872,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + projects_locations_podcasts_operations_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1podcasts~1{podcastsId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' projects_locations_data_stores_models_operations_list: operation: $ref: >- @@ -15352,6 +21931,21 @@ components: response: mediaType: application/json openAPIDocKey: '200' + projects_locations_identity_mapping_stores_operations_list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1identityMappingStores~1{identityMappingStoresId}~1operations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.operations + projects_locations_identity_mapping_stores_operations_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1identityMappingStores~1{identityMappingStoresId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - $ref: >- @@ -15381,23 +21975,25 @@ components: - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_collections_engines_operations_list - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_identity_mapping_stores_operations_get + #/components/x-stackQL-resources/operations/methods/projects_locations_podcasts_operations_get - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_data_stores_models_operations_list - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_data_stores_operations_get - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_data_stores_branches_operations_list + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_locations_identity_mapping_stores_operations_get - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_collections_data_connector_operations_list - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_collections_operations_list - - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_identity_mapping_stores_operations_list - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_operations_get - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_data_stores_operations_list + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_locations_identity_mapping_stores_operations_list - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_operations_get - $ref: >- @@ -15408,6 +22004,35 @@ components: update: [] replace: [] delete: [] + cmek_config: + id: google.discoveryengine.cmek_config + name: cmek_config + title: Cmek_config + methods: + projects_locations_update_cmek_config: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1cmekConfig/patch + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_get_cmek_config: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1cmekConfig/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/cmek_config/methods/projects_locations_get_cmek_config + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/cmek_config/methods/projects_locations_update_cmek_config + replace: [] + delete: [] data_stores: id: google.discoveryengine.data_stores name: data_stores @@ -15569,14 +22194,189 @@ components: projects_locations_collections_data_stores_operations_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1operations~1{operationsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/data_store_operations/methods/projects_locations_collections_data_stores_operations_get + insert: [] + update: [] + replace: [] + delete: [] + serving_configs: + id: google.discoveryengine.serving_configs + name: serving_configs + title: Serving_configs + methods: + projects_locations_collections_data_stores_serving_configs_search: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1servingConfigs~1{servingConfigsId}:search/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_collections_data_stores_serving_configs_search_lite: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1servingConfigs~1{servingConfigsId}:searchLite/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_collections_data_stores_serving_configs_answer: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1servingConfigs~1{servingConfigsId}:answer/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_collections_data_stores_serving_configs_stream_answer: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1servingConfigs~1{servingConfigsId}:streamAnswer/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_collections_data_stores_serving_configs_recommend: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1servingConfigs~1{servingConfigsId}:recommend/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_collections_data_stores_serving_configs_patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1servingConfigs~1{servingConfigsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_collections_engines_serving_configs_search: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1engines~1{enginesId}~1servingConfigs~1{servingConfigsId}:search/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_collections_engines_serving_configs_search_lite: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1engines~1{enginesId}~1servingConfigs~1{servingConfigsId}:searchLite/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_collections_engines_serving_configs_answer: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1engines~1{enginesId}~1servingConfigs~1{servingConfigsId}:answer/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_collections_engines_serving_configs_stream_answer: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1engines~1{enginesId}~1servingConfigs~1{servingConfigsId}:streamAnswer/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_collections_engines_serving_configs_recommend: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1engines~1{enginesId}~1servingConfigs~1{servingConfigsId}:recommend/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_collections_engines_serving_configs_patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1engines~1{enginesId}~1servingConfigs~1{servingConfigsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_data_stores_serving_configs_search: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1servingConfigs~1{servingConfigsId}:search/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_data_stores_serving_configs_search_lite: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1servingConfigs~1{servingConfigsId}:searchLite/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_data_stores_serving_configs_answer: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1servingConfigs~1{servingConfigsId}:answer/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_data_stores_serving_configs_stream_answer: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1servingConfigs~1{servingConfigsId}:streamAnswer/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_data_stores_serving_configs_recommend: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1servingConfigs~1{servingConfigsId}:recommend/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_data_stores_serving_configs_patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1servingConfigs~1{servingConfigsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/serving_configs/methods/projects_locations_collections_data_stores_serving_configs_patch + - $ref: >- + #/components/x-stackQL-resources/serving_configs/methods/projects_locations_collections_engines_serving_configs_patch + - $ref: >- + #/components/x-stackQL-resources/serving_configs/methods/projects_locations_data_stores_serving_configs_patch + replace: [] + delete: [] + completion_config: + id: google.discoveryengine.completion_config + name: completion_config + title: Completion_config + methods: + projects_locations_collections_data_stores_completion_config_complete_query: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1completionConfig:completeQuery/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_collections_engines_completion_config_complete_query: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1engines~1{enginesId}~1completionConfig:completeQuery/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_data_stores_completion_config_complete_query: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1completionConfig:completeQuery/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/data_store_operations/methods/projects_locations_collections_data_stores_operations_get + select: [] insert: [] update: [] replace: [] @@ -15808,101 +22608,6 @@ components: #/components/x-stackQL-resources/controls/methods/projects_locations_collections_engines_controls_delete - $ref: >- #/components/x-stackQL-resources/controls/methods/projects_locations_data_stores_controls_delete - serving_configs: - id: google.discoveryengine.serving_configs - name: serving_configs - title: Serving_configs - methods: - projects_locations_collections_data_stores_serving_configs_search: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1servingConfigs~1{servingConfigsId}:search/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_collections_data_stores_serving_configs_search_lite: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1servingConfigs~1{servingConfigsId}:searchLite/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_collections_data_stores_serving_configs_answer: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1servingConfigs~1{servingConfigsId}:answer/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_collections_data_stores_serving_configs_recommend: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1servingConfigs~1{servingConfigsId}:recommend/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_collections_engines_serving_configs_search: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1engines~1{enginesId}~1servingConfigs~1{servingConfigsId}:search/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_collections_engines_serving_configs_search_lite: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1engines~1{enginesId}~1servingConfigs~1{servingConfigsId}:searchLite/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_collections_engines_serving_configs_answer: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1engines~1{enginesId}~1servingConfigs~1{servingConfigsId}:answer/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_collections_engines_serving_configs_recommend: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1engines~1{enginesId}~1servingConfigs~1{servingConfigsId}:recommend/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_data_stores_serving_configs_search: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1servingConfigs~1{servingConfigsId}:search/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_data_stores_serving_configs_search_lite: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1servingConfigs~1{servingConfigsId}:searchLite/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_data_stores_serving_configs_answer: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1servingConfigs~1{servingConfigsId}:answer/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_data_stores_serving_configs_recommend: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1servingConfigs~1{servingConfigsId}:recommend/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: [] conversations: id: google.discoveryengine.conversations name: conversations @@ -16001,265 +22706,78 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_locations_data_stores_conversations_create: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1conversations/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_data_stores_conversations_list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1conversations/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.conversations - projects_locations_data_stores_conversations_delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1conversations~1{conversationsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_data_stores_conversations_patch: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1conversations~1{conversationsId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_data_stores_conversations_get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1conversations~1{conversationsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/conversations/methods/projects_locations_collections_data_stores_conversations_get - - $ref: >- - #/components/x-stackQL-resources/conversations/methods/projects_locations_collections_engines_conversations_get - - $ref: >- - #/components/x-stackQL-resources/conversations/methods/projects_locations_collections_data_stores_conversations_list - - $ref: >- - #/components/x-stackQL-resources/conversations/methods/projects_locations_collections_engines_conversations_list - - $ref: >- - #/components/x-stackQL-resources/conversations/methods/projects_locations_data_stores_conversations_get - - $ref: >- - #/components/x-stackQL-resources/conversations/methods/projects_locations_data_stores_conversations_list - insert: - - $ref: >- - #/components/x-stackQL-resources/conversations/methods/projects_locations_collections_data_stores_conversations_create - - $ref: >- - #/components/x-stackQL-resources/conversations/methods/projects_locations_collections_engines_conversations_create - - $ref: >- - #/components/x-stackQL-resources/conversations/methods/projects_locations_data_stores_conversations_create - update: - - $ref: >- - #/components/x-stackQL-resources/conversations/methods/projects_locations_collections_data_stores_conversations_patch - - $ref: >- - #/components/x-stackQL-resources/conversations/methods/projects_locations_collections_engines_conversations_patch - - $ref: >- - #/components/x-stackQL-resources/conversations/methods/projects_locations_data_stores_conversations_patch - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/conversations/methods/projects_locations_collections_data_stores_conversations_delete - - $ref: >- - #/components/x-stackQL-resources/conversations/methods/projects_locations_collections_engines_conversations_delete - - $ref: >- - #/components/x-stackQL-resources/conversations/methods/projects_locations_data_stores_conversations_delete - sessions: - id: google.discoveryengine.sessions - name: sessions - title: Sessions - methods: - projects_locations_collections_data_stores_sessions_create: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1sessions/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_collections_data_stores_sessions_list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1sessions/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.sessions - projects_locations_collections_data_stores_sessions_delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1sessions~1{sessionsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_collections_data_stores_sessions_patch: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1sessions~1{sessionsId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_collections_data_stores_sessions_get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1sessions~1{sessionsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_collections_engines_sessions_create: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1engines~1{enginesId}~1sessions/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_collections_engines_sessions_list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1engines~1{enginesId}~1sessions/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.sessions - projects_locations_collections_engines_sessions_delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1engines~1{enginesId}~1sessions~1{sessionsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_collections_engines_sessions_patch: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1engines~1{enginesId}~1sessions~1{sessionsId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_collections_engines_sessions_get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1engines~1{enginesId}~1sessions~1{sessionsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_data_stores_sessions_create: + projects_locations_data_stores_conversations_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1sessions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1conversations/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_data_stores_sessions_list: + projects_locations_data_stores_conversations_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1sessions/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1conversations/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.sessions - projects_locations_data_stores_sessions_delete: + objectKey: $.conversations + projects_locations_data_stores_conversations_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1sessions~1{sessionsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1conversations~1{conversationsId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_data_stores_sessions_patch: + projects_locations_data_stores_conversations_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1sessions~1{sessionsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1conversations~1{conversationsId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_data_stores_sessions_get: + projects_locations_data_stores_conversations_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1sessions~1{sessionsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1conversations~1{conversationsId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_data_stores_sessions_get + #/components/x-stackQL-resources/conversations/methods/projects_locations_collections_data_stores_conversations_get - $ref: >- - #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_engines_sessions_get + #/components/x-stackQL-resources/conversations/methods/projects_locations_collections_engines_conversations_get - $ref: >- - #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_data_stores_sessions_list + #/components/x-stackQL-resources/conversations/methods/projects_locations_collections_data_stores_conversations_list - $ref: >- - #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_engines_sessions_list + #/components/x-stackQL-resources/conversations/methods/projects_locations_collections_engines_conversations_list - $ref: >- - #/components/x-stackQL-resources/sessions/methods/projects_locations_data_stores_sessions_get + #/components/x-stackQL-resources/conversations/methods/projects_locations_data_stores_conversations_get - $ref: >- - #/components/x-stackQL-resources/sessions/methods/projects_locations_data_stores_sessions_list + #/components/x-stackQL-resources/conversations/methods/projects_locations_data_stores_conversations_list insert: - $ref: >- - #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_data_stores_sessions_create + #/components/x-stackQL-resources/conversations/methods/projects_locations_collections_data_stores_conversations_create - $ref: >- - #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_engines_sessions_create + #/components/x-stackQL-resources/conversations/methods/projects_locations_collections_engines_conversations_create - $ref: >- - #/components/x-stackQL-resources/sessions/methods/projects_locations_data_stores_sessions_create + #/components/x-stackQL-resources/conversations/methods/projects_locations_data_stores_conversations_create update: - $ref: >- - #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_data_stores_sessions_patch + #/components/x-stackQL-resources/conversations/methods/projects_locations_collections_data_stores_conversations_patch - $ref: >- - #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_engines_sessions_patch + #/components/x-stackQL-resources/conversations/methods/projects_locations_collections_engines_conversations_patch - $ref: >- - #/components/x-stackQL-resources/sessions/methods/projects_locations_data_stores_sessions_patch + #/components/x-stackQL-resources/conversations/methods/projects_locations_data_stores_conversations_patch replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_data_stores_sessions_delete - - $ref: >- - #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_engines_sessions_delete - - $ref: >- - #/components/x-stackQL-resources/sessions/methods/projects_locations_data_stores_sessions_delete - answers: - id: google.discoveryengine.answers - name: answers - title: Answers - methods: - projects_locations_collections_data_stores_sessions_answers_get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1sessions~1{sessionsId}~1answers~1{answersId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_collections_engines_sessions_answers_get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1engines~1{enginesId}~1sessions~1{sessionsId}~1answers~1{answersId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_data_stores_sessions_answers_get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1sessions~1{sessionsId}~1answers~1{answersId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/answers/methods/projects_locations_collections_data_stores_sessions_answers_get + #/components/x-stackQL-resources/conversations/methods/projects_locations_collections_data_stores_conversations_delete - $ref: >- - #/components/x-stackQL-resources/answers/methods/projects_locations_collections_engines_sessions_answers_get + #/components/x-stackQL-resources/conversations/methods/projects_locations_collections_engines_conversations_delete - $ref: >- - #/components/x-stackQL-resources/answers/methods/projects_locations_data_stores_sessions_answers_get - insert: [] - update: [] - replace: [] - delete: [] + #/components/x-stackQL-resources/conversations/methods/projects_locations_data_stores_conversations_delete branches_documents_metadata: id: google.discoveryengine.branches_documents_metadata name: branches_documents_metadata @@ -16520,25 +23038,212 @@ components: replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/schemas/methods/projects_locations_collections_data_stores_schemas_delete + #/components/x-stackQL-resources/schemas/methods/projects_locations_collections_data_stores_schemas_delete + - $ref: >- + #/components/x-stackQL-resources/schemas/methods/projects_locations_data_stores_schemas_delete + custom_models: + id: google.discoveryengine.custom_models + name: custom_models + title: Custom_models + methods: + projects_locations_collections_data_stores_custom_models_list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1customModels/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/custom_models/methods/projects_locations_collections_data_stores_custom_models_list + insert: [] + update: [] + replace: [] + delete: [] + sessions: + id: google.discoveryengine.sessions + name: sessions + title: Sessions + methods: + projects_locations_collections_data_stores_sessions_create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1sessions/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_collections_data_stores_sessions_list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1sessions/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.sessions + projects_locations_collections_data_stores_sessions_delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1sessions~1{sessionsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_collections_data_stores_sessions_patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1sessions~1{sessionsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_collections_data_stores_sessions_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1sessions~1{sessionsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_collections_engines_sessions_create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1engines~1{enginesId}~1sessions/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_collections_engines_sessions_list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1engines~1{enginesId}~1sessions/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.sessions + projects_locations_collections_engines_sessions_delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1engines~1{enginesId}~1sessions~1{sessionsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_collections_engines_sessions_patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1engines~1{enginesId}~1sessions~1{sessionsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_collections_engines_sessions_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1engines~1{enginesId}~1sessions~1{sessionsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_data_stores_sessions_create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1sessions/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_data_stores_sessions_list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1sessions/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.sessions + projects_locations_data_stores_sessions_delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1sessions~1{sessionsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_data_stores_sessions_patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1sessions~1{sessionsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_data_stores_sessions_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1sessions~1{sessionsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_data_stores_sessions_get + - $ref: >- + #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_engines_sessions_get + - $ref: >- + #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_data_stores_sessions_list + - $ref: >- + #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_engines_sessions_list + - $ref: >- + #/components/x-stackQL-resources/sessions/methods/projects_locations_data_stores_sessions_get + - $ref: >- + #/components/x-stackQL-resources/sessions/methods/projects_locations_data_stores_sessions_list + insert: + - $ref: >- + #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_data_stores_sessions_create + - $ref: >- + #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_engines_sessions_create + - $ref: >- + #/components/x-stackQL-resources/sessions/methods/projects_locations_data_stores_sessions_create + update: + - $ref: >- + #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_data_stores_sessions_patch + - $ref: >- + #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_engines_sessions_patch + - $ref: >- + #/components/x-stackQL-resources/sessions/methods/projects_locations_data_stores_sessions_patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_data_stores_sessions_delete - $ref: >- - #/components/x-stackQL-resources/schemas/methods/projects_locations_data_stores_schemas_delete - custom_models: - id: google.discoveryengine.custom_models - name: custom_models - title: Custom_models + #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_engines_sessions_delete + - $ref: >- + #/components/x-stackQL-resources/sessions/methods/projects_locations_data_stores_sessions_delete + answers: + id: google.discoveryengine.answers + name: answers + title: Answers methods: - projects_locations_collections_data_stores_custom_models_list: + projects_locations_collections_data_stores_sessions_answers_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1customModels/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1sessions~1{sessionsId}~1answers~1{answersId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_collections_engines_sessions_answers_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1engines~1{enginesId}~1sessions~1{sessionsId}~1answers~1{answersId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_data_stores_sessions_answers_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1sessions~1{sessionsId}~1answers~1{answersId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/custom_models/methods/projects_locations_collections_data_stores_custom_models_list + #/components/x-stackQL-resources/answers/methods/projects_locations_collections_data_stores_sessions_answers_get + - $ref: >- + #/components/x-stackQL-resources/answers/methods/projects_locations_collections_engines_sessions_answers_get + - $ref: >- + #/components/x-stackQL-resources/answers/methods/projects_locations_data_stores_sessions_answers_get insert: [] update: [] replace: [] @@ -16804,6 +23509,71 @@ components: update: [] replace: [] delete: [] + sitemaps: + id: google.discoveryengine.sitemaps + name: sitemaps + title: Sitemaps + methods: + projects_locations_collections_data_stores_site_search_engine_sitemaps_create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1siteSearchEngine~1sitemaps/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_collections_data_stores_site_search_engine_sitemaps_delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1siteSearchEngine~1sitemaps~1{sitemapsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_collections_data_stores_site_search_engine_sitemaps_fetch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1siteSearchEngine~1sitemaps:fetch/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_data_stores_site_search_engine_sitemaps_create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1siteSearchEngine~1sitemaps/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_data_stores_site_search_engine_sitemaps_delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1siteSearchEngine~1sitemaps~1{sitemapsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_data_stores_site_search_engine_sitemaps_fetch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1siteSearchEngine~1sitemaps:fetch/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/sitemaps/methods/projects_locations_collections_data_stores_site_search_engine_sitemaps_fetch + - $ref: >- + #/components/x-stackQL-resources/sitemaps/methods/projects_locations_data_stores_site_search_engine_sitemaps_fetch + insert: + - $ref: >- + #/components/x-stackQL-resources/sitemaps/methods/projects_locations_collections_data_stores_site_search_engine_sitemaps_create + - $ref: >- + #/components/x-stackQL-resources/sitemaps/methods/projects_locations_data_stores_site_search_engine_sitemaps_create + update: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/sitemaps/methods/projects_locations_collections_data_stores_site_search_engine_sitemaps_delete + - $ref: >- + #/components/x-stackQL-resources/sitemaps/methods/projects_locations_data_stores_site_search_engine_sitemaps_delete user_events: id: google.discoveryengine.user_events name: user_events @@ -16879,6 +23649,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + projects_locations_user_events_import: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1userEvents:import/post + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: [] insert: [] @@ -16942,6 +23719,89 @@ components: delete: - $ref: >- #/components/x-stackQL-resources/engines/methods/projects_locations_collections_engines_delete + assistants: + id: google.discoveryengine.assistants + name: assistants + title: Assistants + methods: + projects_locations_collections_engines_assistants_stream_assist: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1engines~1{enginesId}~1assistants~1{assistantsId}:streamAssist/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_collections_engines_assistants_patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1engines~1{enginesId}~1assistants~1{assistantsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_collections_engines_assistants_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1engines~1{enginesId}~1assistants~1{assistantsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/assistants/methods/projects_locations_collections_engines_assistants_get + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/assistants/methods/projects_locations_collections_engines_assistants_patch + replace: [] + delete: [] + cmek_configs: + id: google.discoveryengine.cmek_configs + name: cmek_configs + title: Cmek_configs + methods: + projects_locations_cmek_configs_patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1cmekConfigs~1{cmekConfigsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_cmek_configs_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1cmekConfigs~1{cmekConfigsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_cmek_configs_delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1cmekConfigs~1{cmekConfigsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_cmek_configs_list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1cmekConfigs/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/cmek_configs/methods/projects_locations_cmek_configs_get + - $ref: >- + #/components/x-stackQL-resources/cmek_configs/methods/projects_locations_cmek_configs_list + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/cmek_configs/methods/projects_locations_cmek_configs_patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/cmek_configs/methods/projects_locations_cmek_configs_delete grounding_configs: id: google.discoveryengine.grounding_configs name: grounding_configs @@ -16960,6 +23820,89 @@ components: update: [] replace: [] delete: [] + identity_mapping_stores: + id: google.discoveryengine.identity_mapping_stores + name: identity_mapping_stores + title: Identity_mapping_stores + methods: + projects_locations_identity_mapping_stores_create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1identityMappingStores/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_identity_mapping_stores_list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1identityMappingStores/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.identityMappingStores + projects_locations_identity_mapping_stores_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1identityMappingStores~1{identityMappingStoresId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_identity_mapping_stores_delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1identityMappingStores~1{identityMappingStoresId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_identity_mapping_stores_import_identity_mappings: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1identityMappingStores~1{identityMappingStoresId}:importIdentityMappings/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_identity_mapping_stores_purge_identity_mappings: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1identityMappingStores~1{identityMappingStoresId}:purgeIdentityMappings/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/identity_mapping_stores/methods/projects_locations_identity_mapping_stores_get + - $ref: >- + #/components/x-stackQL-resources/identity_mapping_stores/methods/projects_locations_identity_mapping_stores_list + insert: + - $ref: >- + #/components/x-stackQL-resources/identity_mapping_stores/methods/projects_locations_identity_mapping_stores_create + update: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/identity_mapping_stores/methods/projects_locations_identity_mapping_stores_delete + identity_mapping_stores_identity_mappings: + id: google.discoveryengine.identity_mapping_stores_identity_mappings + name: identity_mapping_stores_identity_mappings + title: Identity_mapping_stores_identity_mappings + methods: + projects_locations_identity_mapping_stores_list_identity_mappings: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1identityMappingStores~1{identityMappingStoresId}:listIdentityMappings/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.identityMappingEntries + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/identity_mapping_stores_identity_mappings/methods/projects_locations_identity_mapping_stores_list_identity_mappings + insert: [] + update: [] + replace: [] + delete: [] ranking_configs: id: google.discoveryengine.ranking_configs name: ranking_configs @@ -16978,8 +23921,49 @@ components: update: [] replace: [] delete: [] + user_stores: + id: google.discoveryengine.user_stores + name: user_stores + title: User_stores + methods: + projects_locations_user_stores_batch_update_user_licenses: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1userStores~1{userStoresId}:batchUpdateUserLicenses/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/user_stores/methods/projects_locations_user_stores_batch_update_user_licenses + replace: [] + delete: [] + user_licenses: + id: google.discoveryengine.user_licenses + name: user_licenses + title: User_licenses + methods: + projects_locations_user_stores_user_licenses_list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1userStores~1{userStoresId}~1userLicenses/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.userLicenses + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/user_licenses/methods/projects_locations_user_stores_user_licenses_list + insert: [] + update: [] + replace: [] + delete: [] paths: - /v1/projects/{projectsId}:provision: + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}:downloadFile: parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' @@ -16992,44 +23976,1405 @@ paths: - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/_.xgafv' + get: + description: Downloads a file from the session. + operationId: discoveryengine.media.download + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GdataMedia' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: collectionsId + required: true + schema: + type: string + - in: path + name: enginesId + required: true + schema: + type: string + - in: path + name: sessionsId + required: true + schema: + type: string + - in: query + name: fileId + schema: + type: string + - in: query + name: viewId + schema: + type: string + /v1/projects/{projectsId}:provision: + parameters: *ref_1 + post: + description: >- + Provisions the project resource. During the process, related systems + will get prepared and initialized. Caller must read the [Terms for data + use](https://cloud.google.com/retail/data-use-terms), and optionally + specify in request to provide consent to that service terms. + operationId: discoveryengine.projects.provision + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ProvisionProjectRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + /v1/projects/{projectsId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: discoveryengine.projects.operations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: discoveryengine.projects.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + `1`, corresponding to `Code.CANCELLED`. + operationId: discoveryengine.projects.operations.cancel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningCancelOperationRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/cmekConfig: + parameters: *ref_1 + patch: + description: >- + Provisions a CMEK key for use in a location of a customer's project. + This method will also conduct location validation on the provided + cmekConfig to make sure the key is valid and can be used in the selected + location. + operationId: discoveryengine.projects.locations.updateCmekConfig + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1CmekConfig' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: setDefault + schema: + type: boolean + get: + description: Gets the CmekConfig. + operationId: discoveryengine.projects.locations.getCmekConfig + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1CmekConfig' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: >- + discoveryengine.projects.locations.collections.dataConnector.operations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: collectionsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: >- + discoveryengine.projects.locations.collections.dataConnector.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: collectionsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: discoveryengine.projects.locations.collections.operations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: collectionsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: discoveryengine.projects.locations.collections.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: collectionsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}:completeQuery: + parameters: *ref_1 + get: + description: Completes the specified user input with keyword suggestions. + operationId: discoveryengine.projects.locations.collections.dataStores.completeQuery + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1CompleteQueryResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: collectionsId + required: true + schema: + type: string + - in: path + name: dataStoresId + required: true + schema: + type: string + - in: query + name: query + schema: + type: string + - in: query + name: queryModel + schema: + type: string + - in: query + name: userPseudoId + schema: + type: string + - in: query + name: includeTailSuggestions + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores: + parameters: *ref_1 + post: + description: >- + Creates a DataStore. DataStore is for storing Documents. To serve these + documents for Search, or Recommendation use case, an Engine needs to be + created separately. + operationId: discoveryengine.projects.locations.collections.dataStores.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1DataStore' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: collectionsId + required: true + schema: + type: string + - in: query + name: cmekConfigName + schema: + type: string + - in: query + name: disableCmek + schema: + type: boolean + - in: query + name: dataStoreId + schema: + type: string + - in: query + name: createAdvancedSiteSearch + schema: + type: boolean + - in: query + name: skipDefaultSchemaCreation + schema: + type: boolean + get: + description: Lists all the DataStores associated with the project. + operationId: discoveryengine.projects.locations.collections.dataStores.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ListDataStoresResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: collectionsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}: + parameters: *ref_1 + get: + description: Gets a DataStore. + operationId: discoveryengine.projects.locations.collections.dataStores.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1DataStore' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: collectionsId + required: true + schema: + type: string + - in: path + name: dataStoresId + required: true + schema: + type: string + delete: + description: Deletes a DataStore. + operationId: discoveryengine.projects.locations.collections.dataStores.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: collectionsId + required: true + schema: + type: string + - in: path + name: dataStoresId + required: true + schema: + type: string + patch: + description: Updates a DataStore + operationId: discoveryengine.projects.locations.collections.dataStores.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1DataStore' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1DataStore' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: collectionsId + required: true + schema: + type: string + - in: path + name: dataStoresId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}:trainCustomModel: + parameters: *ref_1 + post: + description: Trains a custom model. + operationId: >- + discoveryengine.projects.locations.collections.dataStores.trainCustomModel + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1TrainCustomModelRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: collectionsId + required: true + schema: + type: string + - in: path + name: dataStoresId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine: + parameters: *ref_1 + get: + description: Gets the SiteSearchEngine. + operationId: >- + discoveryengine.projects.locations.collections.dataStores.getSiteSearchEngine + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SiteSearchEngine + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: collectionsId + required: true + schema: + type: string + - in: path + name: dataStoresId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/models/{modelsId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: >- + discoveryengine.projects.locations.collections.dataStores.models.operations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: collectionsId + required: true + schema: + type: string + - in: path + name: dataStoresId + required: true + schema: + type: string + - in: path + name: modelsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/models/{modelsId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: >- + discoveryengine.projects.locations.collections.dataStores.models.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: collectionsId + required: true + schema: + type: string + - in: path + name: dataStoresId + required: true + schema: + type: string + - in: path + name: modelsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: >- + discoveryengine.projects.locations.collections.dataStores.operations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: collectionsId + required: true + schema: + type: string + - in: path + name: dataStoresId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: discoveryengine.projects.locations.collections.dataStores.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: collectionsId + required: true + schema: + type: string + - in: path + name: dataStoresId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:search: + parameters: *ref_1 + post: + description: Performs a search. + operationId: >- + discoveryengine.projects.locations.collections.dataStores.servingConfigs.search + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1SearchRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: collectionsId + required: true + schema: + type: string + - in: path + name: dataStoresId + required: true + schema: + type: string + - in: path + name: servingConfigsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:searchLite: + parameters: *ref_1 + post: + description: >- + Performs a search. Similar to the SearchService.Search method, but a + lite version that allows API key for authentication, where OAuth and IAM + checks are not required. Only public website search is supported by this + method. If data stores and engines not associated with public website + search are specified, a `FAILED_PRECONDITION` error is returned. This + method can be used for easy onboarding without having to implement an + authentication backend. However, it is strongly recommended to use + SearchService.Search instead with required OAuth and IAM checks to + provide better data security. + operationId: >- + discoveryengine.projects.locations.collections.dataStores.servingConfigs.searchLite + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1SearchRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: collectionsId + required: true + schema: + type: string + - in: path + name: dataStoresId + required: true + schema: + type: string + - in: path + name: servingConfigsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:answer: + parameters: *ref_1 + post: + description: Answer query method. + operationId: >- + discoveryengine.projects.locations.collections.dataStores.servingConfigs.answer + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: collectionsId + required: true + schema: + type: string + - in: path + name: dataStoresId + required: true + schema: + type: string + - in: path + name: servingConfigsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:streamAnswer: + parameters: *ref_1 post: description: >- - Provisions the project resource. During the process, related systems - will get prepared and initialized. Caller must read the [Terms for data - use](https://cloud.google.com/retail/data-use-terms), and optionally - specify in request to provide consent to that service terms. - operationId: discoveryengine.projects.provision + Answer query method (streaming). It takes one AnswerQueryRequest and + returns multiple AnswerQueryResponse messages in a stream. + operationId: >- + discoveryengine.projects.locations.collections.dataStores.servingConfigs.streamAnswer + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: collectionsId + required: true + schema: + type: string + - in: path + name: dataStoresId + required: true + schema: + type: string + - in: path + name: servingConfigsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:recommend: + parameters: *ref_1 + post: + description: Makes a recommendation, which requires a contextual user event. + operationId: >- + discoveryengine.projects.locations.collections.dataStores.servingConfigs.recommend + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1RecommendRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1RecommendResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: collectionsId + required: true + schema: + type: string + - in: path + name: dataStoresId + required: true + schema: + type: string + - in: path + name: servingConfigsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}: + parameters: *ref_1 + patch: + description: >- + Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig + does not exist. + operationId: >- + discoveryengine.projects.locations.collections.dataStores.servingConfigs.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1ServingConfig' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1ServingConfig' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: collectionsId + required: true + schema: + type: string + - in: path + name: dataStoresId + required: true + schema: + type: string + - in: path + name: servingConfigsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/completionConfig:completeQuery: + parameters: *ref_1 + post: + description: Completes the user input with advanced keyword suggestions. + operationId: >- + discoveryengine.projects.locations.collections.dataStores.completionConfig.completeQuery requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ProvisionProjectRequest + #/components/schemas/GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud_search.query + Oauth2c: + - https://www.googleapis.com/auth/cloud_search.query responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponse parameters: - in: path name: projectsId required: true schema: type: string - /v1/projects/{projectsId}/operations: + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: collectionsId + required: true + schema: + type: string + - in: path + name: dataStoresId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/suggestionDenyListEntries:import: parameters: *ref_1 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: discoveryengine.projects.operations.list + post: + description: Imports all SuggestionDenyListEntry for a DataStore. + operationId: >- + discoveryengine.projects.locations.collections.dataStores.suggestionDenyListEntries.import + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17041,34 +25386,40 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId required: true schema: type: string - - in: query - name: filter + - in: path + name: locationsId + required: true schema: type: string - - in: query - name: pageSize + - in: path + name: collectionsId + required: true schema: - type: integer - format: int32 - - in: query - name: pageToken + type: string + - in: path + name: dataStoresId + required: true schema: type: string - /v1/projects/{projectsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/suggestionDenyListEntries:purge: parameters: *ref_1 - get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: discoveryengine.projects.operations.get + post: + description: Permanently deletes all SuggestionDenyListEntry for a DataStore. + operationId: >- + discoveryengine.projects.locations.collections.dataStores.suggestionDenyListEntries.purge + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17088,29 +25439,32 @@ paths: schema: type: string - in: path - name: operationsId + name: locationsId required: true schema: type: string - /v1/projects/{projectsId}/operations/{operationsId}:cancel: + - in: path + name: collectionsId + required: true + schema: + type: string + - in: path + name: dataStoresId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/completionSuggestions:import: parameters: *ref_1 post: - description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: discoveryengine.projects.operations.cancel + description: Imports CompletionSuggestions for a DataStore. + operationId: >- + discoveryengine.projects.locations.collections.dataStores.completionSuggestions.import requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningCancelOperationRequest' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17122,7 +25476,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -17130,18 +25484,32 @@ paths: schema: type: string - in: path - name: operationsId + name: locationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector/operations: + - in: path + name: collectionsId + required: true + schema: + type: string + - in: path + name: dataStoresId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/completionSuggestions:purge: parameters: *ref_1 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. + post: + description: Permanently deletes all CompletionSuggestions for a DataStore. operationId: >- - discoveryengine.projects.locations.collections.dataConnector.operations.list + discoveryengine.projects.locations.collections.dataStores.completionSuggestions.purge + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17153,7 +25521,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -17170,28 +25538,25 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: dataStoresId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/controls: parameters: *ref_1 - get: + post: description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. + Creates a Control. By default 1000 controls are allowed for a data + store. A request can be submitted to adjust this limit. If the Control + to create already exists, an ALREADY_EXISTS error is returned. operationId: >- - discoveryengine.projects.locations.collections.dataConnector.operations.get + discoveryengine.projects.locations.collections.dataStores.controls.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17203,7 +25568,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' parameters: - in: path name: projectsId @@ -17221,17 +25586,17 @@ paths: schema: type: string - in: path - name: operationsId + name: dataStoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/operations: - parameters: *ref_1 + - in: query + name: controlId + schema: + type: string get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: discoveryengine.projects.locations.collections.operations.list + description: Lists all Controls by their parent DataStore. + operationId: discoveryengine.projects.locations.collections.dataStores.controls.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17243,7 +25608,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ListControlsResponse parameters: - in: path name: projectsId @@ -17260,8 +25626,9 @@ paths: required: true schema: type: string - - in: query - name: filter + - in: path + name: dataStoresId + required: true schema: type: string - in: query @@ -17273,14 +25640,66 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/operations/{operationsId}: + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/controls/{controlsId}: parameters: *ref_1 - get: + delete: description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: discoveryengine.projects.locations.collections.operations.get + Deletes a Control. If the Control to delete does not exist, a NOT_FOUND + error is returned. + operationId: >- + discoveryengine.projects.locations.collections.dataStores.controls.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: collectionsId + required: true + schema: + type: string + - in: path + name: dataStoresId + required: true + schema: + type: string + - in: path + name: controlsId + required: true + schema: + type: string + patch: + description: >- + Updates a Control. Control action type cannot be changed. If the Control + to update does not exist, a NOT_FOUND error is returned. + operationId: discoveryengine.projects.locations.collections.dataStores.controls.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17292,7 +25711,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' parameters: - in: path name: projectsId @@ -17310,15 +25729,23 @@ paths: schema: type: string - in: path - name: operationsId + name: dataStoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}:completeQuery: - parameters: *ref_1 + - in: path + name: controlsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask get: - description: Completes the specified user input with keyword suggestions. - operationId: discoveryengine.projects.locations.collections.dataStores.completeQuery + description: Gets a Control. + operationId: discoveryengine.projects.locations.collections.dataStores.controls.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17330,8 +25757,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1CompleteQueryResponse + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' parameters: - in: path name: projectsId @@ -17353,35 +25779,23 @@ paths: required: true schema: type: string - - in: query - name: query - schema: - type: string - - in: query - name: queryModel - schema: - type: string - - in: query - name: userPseudoId + - in: path + name: controlsId + required: true schema: type: string - - in: query - name: includeTailSuggestions - schema: - type: boolean - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores: + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/conversations/{conversationsId}:converse: parameters: *ref_1 post: - description: >- - Creates a DataStore. DataStore is for storing Documents. To serve these - documents for Search, or Recommendation use case, an Engine needs to be - created separately. - operationId: discoveryengine.projects.locations.collections.dataStores.create + description: Converses a conversation. + operationId: >- + discoveryengine.projects.locations.collections.dataStores.conversations.converse requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1DataStore' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ConverseConversationRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17393,7 +25807,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ConverseConversationResponse parameters: - in: path name: projectsId @@ -17410,29 +25825,29 @@ paths: required: true schema: type: string - - in: query - name: cmekConfigName + - in: path + name: dataStoresId + required: true schema: type: string - - in: query - name: disableCmek - schema: - type: boolean - - in: query - name: dataStoreId + - in: path + name: conversationsId + required: true schema: type: string - - in: query - name: createAdvancedSiteSearch - schema: - type: boolean - - in: query - name: skipDefaultSchemaCreation - schema: - type: boolean - get: - description: Lists all the DataStores associated with the project. - operationId: discoveryengine.projects.locations.collections.dataStores.list + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/conversations: + parameters: *ref_1 + post: + description: >- + Creates a Conversation. If the Conversation to create already exists, an + ALREADY_EXISTS error is returned. + operationId: >- + discoveryengine.projects.locations.collections.dataStores.conversations.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17444,8 +25859,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ListDataStoresResponse + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' parameters: - in: path name: projectsId @@ -17462,24 +25876,15 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + - in: path + name: dataStoresId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}: - parameters: *ref_1 get: - description: Gets a DataStore. - operationId: discoveryengine.projects.locations.collections.dataStores.get + description: Lists all Conversations by their parent DataStore. + operationId: >- + discoveryengine.projects.locations.collections.dataStores.conversations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17491,7 +25896,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1DataStore' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ListConversationsResponse parameters: - in: path name: projectsId @@ -17513,9 +25919,31 @@ paths: required: true schema: type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/conversations/{conversationsId}: + parameters: *ref_1 delete: - description: Deletes a DataStore. - operationId: discoveryengine.projects.locations.collections.dataStores.delete + description: >- + Deletes a Conversation. If the Conversation to delete does not exist, a + NOT_FOUND error is returned. + operationId: >- + discoveryengine.projects.locations.collections.dataStores.conversations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17527,7 +25955,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -17549,14 +25977,23 @@ paths: required: true schema: type: string + - in: path + name: conversationsId + required: true + schema: + type: string patch: - description: Updates a DataStore - operationId: discoveryengine.projects.locations.collections.dataStores.patch + description: >- + Updates a Conversation. Conversation action type cannot be changed. If + the Conversation to update does not exist, a NOT_FOUND error is + returned. + operationId: >- + discoveryengine.projects.locations.collections.dataStores.conversations.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1DataStore' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17568,7 +26005,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1DataStore' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' parameters: - in: path name: projectsId @@ -17590,23 +26027,20 @@ paths: required: true schema: type: string + - in: path + name: conversationsId + required: true + schema: + type: string - in: query name: updateMask schema: type: string format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}:trainCustomModel: - parameters: *ref_1 - post: - description: Trains a custom model. + get: + description: Gets a Conversation. operationId: >- - discoveryengine.projects.locations.collections.dataStores.trainCustomModel - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1TrainCustomModelRequest + discoveryengine.projects.locations.collections.dataStores.conversations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17618,7 +26052,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' parameters: - in: path name: projectsId @@ -17640,12 +26074,19 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine: + - in: path + name: conversationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/batchGetDocumentsMetadata: parameters: *ref_1 get: - description: Gets the SiteSearchEngine. + description: >- + Gets index freshness metadata for Documents. Supported for website + search only. operationId: >- - discoveryengine.projects.locations.collections.dataStores.getSiteSearchEngine + discoveryengine.projects.locations.collections.dataStores.branches.batchGetDocumentsMetadata security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17658,7 +26099,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SiteSearchEngine + #/components/schemas/GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse parameters: - in: path name: projectsId @@ -17680,14 +26121,27 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/models/{modelsId}/operations: + - in: path + name: branchesId + required: true + schema: + type: string + - in: query + name: matcher.urisMatcher.uris + schema: + type: string + - in: query + name: matcher.fhirMatcher.fhirResources + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. operationId: >- - discoveryengine.projects.locations.collections.dataStores.models.operations.list + discoveryengine.projects.locations.collections.dataStores.branches.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17722,7 +26176,7 @@ paths: schema: type: string - in: path - name: modelsId + name: branchesId required: true schema: type: string @@ -17739,7 +26193,7 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/models/{modelsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}: parameters: *ref_1 get: description: >- @@ -17747,7 +26201,7 @@ paths: method to poll the operation result at intervals as recommended by the API service. operationId: >- - discoveryengine.projects.locations.collections.dataStores.models.operations.get + discoveryengine.projects.locations.collections.dataStores.branches.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17782,7 +26236,7 @@ paths: schema: type: string - in: path - name: modelsId + name: branchesId required: true schema: type: string @@ -17791,14 +26245,26 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}:cancel: parameters: *ref_1 - get: + post: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + `1`, corresponding to `Code.CANCELLED`. operationId: >- - discoveryengine.projects.locations.collections.dataStores.operations.list + discoveryengine.projects.locations.collections.dataStores.branches.operations.cancel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningCancelOperationRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17810,7 +26276,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -17832,27 +26298,22 @@ paths: required: true schema: type: string - - in: query - name: filter + - in: path + name: branchesId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: operationsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}: parameters: *ref_1 get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: discoveryengine.projects.locations.collections.dataStores.operations.get + description: Gets a Document. + operationId: >- + discoveryengine.projects.locations.collections.dataStores.branches.documents.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17864,7 +26325,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' parameters: - in: path name: projectsId @@ -17887,22 +26348,24 @@ paths: schema: type: string - in: path - name: operationsId + name: branchesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/suggestionDenyListEntries:import: - parameters: *ref_1 - post: - description: Imports all SuggestionDenyListEntry for a DataStore. + - in: path + name: documentsId + required: true + schema: + type: string + patch: + description: Updates a Document. operationId: >- - discoveryengine.projects.locations.collections.dataStores.suggestionDenyListEntries.import + discoveryengine.projects.locations.collections.dataStores.branches.documents.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesRequest + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17914,7 +26377,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' parameters: - in: path name: projectsId @@ -17936,18 +26399,29 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/suggestionDenyListEntries:purge: - parameters: *ref_1 - post: - description: Permanently deletes all SuggestionDenyListEntry for a DataStore. + - in: path + name: branchesId + required: true + schema: + type: string + - in: path + name: documentsId + required: true + schema: + type: string + - in: query + name: allowMissing + schema: + type: boolean + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a Document. operationId: >- - discoveryengine.projects.locations.collections.dataStores.suggestionDenyListEntries.purge - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesRequest + discoveryengine.projects.locations.collections.dataStores.branches.documents.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17959,7 +26433,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -17981,18 +26455,22 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/completionSuggestions:import: + - in: path + name: branchesId + required: true + schema: + type: string + - in: path + name: documentsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents: parameters: *ref_1 - post: - description: Imports CompletionSuggestions for a DataStore. + get: + description: Gets a list of Documents. operationId: >- - discoveryengine.projects.locations.collections.dataStores.completionSuggestions.import - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequest + discoveryengine.projects.locations.collections.dataStores.branches.documents.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18004,7 +26482,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ListDocumentsResponse parameters: - in: path name: projectsId @@ -18026,18 +26505,29 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/completionSuggestions:purge: - parameters: *ref_1 + - in: path + name: branchesId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string post: - description: Permanently deletes all CompletionSuggestions for a DataStore. + description: Creates a Document. operationId: >- - discoveryengine.projects.locations.collections.dataStores.completionSuggestions.purge + discoveryengine.projects.locations.collections.dataStores.branches.documents.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsRequest + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18049,7 +26539,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' parameters: - in: path name: projectsId @@ -18071,20 +26561,30 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/controls: + - in: path + name: branchesId + required: true + schema: + type: string + - in: query + name: documentId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:import: parameters: *ref_1 post: description: >- - Creates a Control. By default 1000 controls are allowed for a data - store. A request can be submitted to adjust this limit. If the Control - to create already exists, an ALREADY_EXISTS error is returned. + Bulk import of multiple Documents. Request processing may be + synchronous. Non-existing items are created. Note: It is possible for a + subset of the Documents to be successfully updated. operationId: >- - discoveryengine.projects.locations.collections.dataStores.controls.create + discoveryengine.projects.locations.collections.dataStores.branches.documents.import requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ImportDocumentsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18096,7 +26596,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -18118,13 +26618,30 @@ paths: required: true schema: type: string - - in: query - name: controlId + - in: path + name: branchesId + required: true schema: type: string - get: - description: Lists all Controls by their parent DataStore. - operationId: discoveryengine.projects.locations.collections.dataStores.controls.list + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:purge: + parameters: *ref_1 + post: + description: >- + Permanently deletes all selected Documents in a branch. This process is + asynchronous. Depending on the number of Documents to be deleted, this + operation can take hours to complete. Before the delete operation + completes, some Documents might still be returned by + DocumentService.GetDocument or DocumentService.ListDocuments. To get a + list of the Documents to be deleted, set PurgeDocumentsRequest.force to + false. + operationId: >- + discoveryengine.projects.locations.collections.dataStores.branches.documents.purge + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1PurgeDocumentsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18136,8 +26653,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ListControlsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -18159,27 +26675,16 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + - in: path + name: branchesId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/controls/{controlsId}: + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas/{schemasId}: parameters: *ref_1 - delete: - description: >- - Deletes a Control. If the Control to delete does not exist, a NOT_FOUND - error is returned. - operationId: >- - discoveryengine.projects.locations.collections.dataStores.controls.delete + get: + description: Gets a Schema. + operationId: discoveryengine.projects.locations.collections.dataStores.schemas.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18191,7 +26696,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Schema' parameters: - in: path name: projectsId @@ -18214,20 +26719,18 @@ paths: schema: type: string - in: path - name: controlsId + name: schemasId required: true schema: type: string patch: - description: >- - Updates a Control. Control action type cannot be changed. If the Control - to update does not exist, a NOT_FOUND error is returned. - operationId: discoveryengine.projects.locations.collections.dataStores.controls.patch + description: Updates a Schema. + operationId: discoveryengine.projects.locations.collections.dataStores.schemas.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Schema' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18239,7 +26742,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -18262,18 +26765,17 @@ paths: schema: type: string - in: path - name: controlsId + name: schemasId required: true schema: type: string - in: query - name: updateMask + name: allowMissing schema: - type: string - format: google-fieldmask - get: - description: Gets a Control. - operationId: discoveryengine.projects.locations.collections.dataStores.controls.get + type: boolean + delete: + description: Deletes a Schema. + operationId: discoveryengine.projects.locations.collections.dataStores.schemas.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18285,7 +26787,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -18308,21 +26810,15 @@ paths: schema: type: string - in: path - name: controlsId + name: schemasId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:search: + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas: parameters: *ref_1 - post: - description: Performs a search. - operationId: >- - discoveryengine.projects.locations.collections.dataStores.servingConfigs.search - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1SearchRequest' + get: + description: Gets a list of Schemas. + operationId: discoveryengine.projects.locations.collections.dataStores.schemas.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18335,7 +26831,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponse + #/components/schemas/GoogleCloudDiscoveryengineV1ListSchemasResponse parameters: - in: path name: projectsId @@ -18357,31 +26853,23 @@ paths: required: true schema: type: string - - in: path - name: servingConfigsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:searchLite: - parameters: *ref_1 post: - description: >- - Performs a search. Similar to the SearchService.Search method, but a - lite version that allows API key for authentication, where OAuth and IAM - checks are not required. Only public website search is supported by this - method. If data stores and engines not associated with public website - search are specified, a `FAILED_PRECONDITION` error is returned. This - method can be used for easy onboarding without having to implement an - authentication backend. However, it is strongly recommended to use - SearchService.Search instead with required OAuth and IAM checks to - provide better data security. - operationId: >- - discoveryengine.projects.locations.collections.dataStores.servingConfigs.searchLite + description: Creates a Schema. + operationId: discoveryengine.projects.locations.collections.dataStores.schemas.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1SearchRequest' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Schema' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18393,8 +26881,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -18416,23 +26903,18 @@ paths: required: true schema: type: string - - in: path - name: servingConfigsId - required: true + - in: query + name: schemaId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:answer: + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas/{schemasId}/operations: parameters: *ref_1 - post: - description: Answer query method. + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. operationId: >- - discoveryengine.projects.locations.collections.dataStores.servingConfigs.answer - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequest + discoveryengine.projects.locations.collections.dataStores.schemas.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18444,8 +26926,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -18468,22 +26949,32 @@ paths: schema: type: string - in: path - name: servingConfigsId + name: schemasId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:recommend: + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas/{schemasId}/operations/{operationsId}: parameters: *ref_1 - post: - description: Makes a recommendation, which requires a contextual user event. + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. operationId: >- - discoveryengine.projects.locations.collections.dataStores.servingConfigs.recommend - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1RecommendRequest + discoveryengine.projects.locations.collections.dataStores.schemas.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18495,8 +26986,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1RecommendResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -18519,22 +27009,21 @@ paths: schema: type: string - in: path - name: servingConfigsId + name: schemasId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/conversations/{conversationsId}:converse: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/customModels: parameters: *ref_1 - post: - description: Converses a conversation. + get: + description: Gets a list of all the custom models. operationId: >- - discoveryengine.projects.locations.collections.dataStores.conversations.converse - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ConverseConversationRequest + discoveryengine.projects.locations.collections.dataStores.customModels.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18547,7 +27036,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ConverseConversationResponse + #/components/schemas/GoogleCloudDiscoveryengineV1ListCustomModelsResponse parameters: - in: path name: projectsId @@ -18569,24 +27058,19 @@ paths: required: true schema: type: string - - in: path - name: conversationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/conversations: + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions: parameters: *ref_1 post: description: >- - Creates a Conversation. If the Conversation to create already exists, an + Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned. operationId: >- - discoveryengine.projects.locations.collections.dataStores.conversations.create + discoveryengine.projects.locations.collections.dataStores.sessions.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Session' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18598,7 +27082,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Session' parameters: - in: path name: projectsId @@ -18621,9 +27105,8 @@ paths: schema: type: string get: - description: Lists all Conversations by their parent DataStore. - operationId: >- - discoveryengine.projects.locations.collections.dataStores.conversations.list + description: Lists all Sessions by their parent DataStore. + operationId: discoveryengine.projects.locations.collections.dataStores.sessions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18636,7 +27119,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ListConversationsResponse + #/components/schemas/GoogleCloudDiscoveryengineV1ListSessionsResponse parameters: - in: path name: projectsId @@ -18675,14 +27158,14 @@ paths: name: orderBy schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/conversations/{conversationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions/{sessionsId}: parameters: *ref_1 delete: description: >- - Deletes a Conversation. If the Conversation to delete does not exist, a - NOT_FOUND error is returned. + Deletes a Session. If the Session to delete does not exist, a NOT_FOUND + error is returned. operationId: >- - discoveryengine.projects.locations.collections.dataStores.conversations.delete + discoveryengine.projects.locations.collections.dataStores.sessions.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18717,22 +27200,20 @@ paths: schema: type: string - in: path - name: conversationsId + name: sessionsId required: true schema: type: string patch: description: >- - Updates a Conversation. Conversation action type cannot be changed. If - the Conversation to update does not exist, a NOT_FOUND error is - returned. - operationId: >- - discoveryengine.projects.locations.collections.dataStores.conversations.patch + Updates a Session. Session action type cannot be changed. If the Session + to update does not exist, a NOT_FOUND error is returned. + operationId: discoveryengine.projects.locations.collections.dataStores.sessions.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Session' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18744,7 +27225,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Session' parameters: - in: path name: projectsId @@ -18767,7 +27248,7 @@ paths: schema: type: string - in: path - name: conversationsId + name: sessionsId required: true schema: type: string @@ -18777,9 +27258,8 @@ paths: type: string format: google-fieldmask get: - description: Gets a Conversation. - operationId: >- - discoveryengine.projects.locations.collections.dataStores.conversations.get + description: Gets a Session. + operationId: discoveryengine.projects.locations.collections.dataStores.sessions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18791,7 +27271,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Session' parameters: - in: path name: projectsId @@ -18814,23 +27294,20 @@ paths: schema: type: string - in: path - name: conversationsId + name: sessionsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions: + - in: query + name: includeAnswerDetails + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions/{sessionsId}/answers/{answersId}: parameters: *ref_1 - post: - description: >- - Creates a Session. If the Session to create already exists, an - ALREADY_EXISTS error is returned. + get: + description: Gets a Answer. operationId: >- - discoveryengine.projects.locations.collections.dataStores.sessions.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Session' + discoveryengine.projects.locations.collections.dataStores.sessions.answers.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18842,7 +27319,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Session' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Answer' parameters: - in: path name: projectsId @@ -18864,9 +27341,28 @@ paths: required: true schema: type: string - get: - description: Lists all Sessions by their parent DataStore. - operationId: discoveryengine.projects.locations.collections.dataStores.sessions.list + - in: path + name: sessionsId + required: true + schema: + type: string + - in: path + name: answersId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:enableAdvancedSiteSearch: + parameters: *ref_1 + post: + description: Upgrade from basic site search to advanced site search. + operationId: >- + discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.enableAdvancedSiteSearch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18878,8 +27374,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ListSessionsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -18901,31 +27396,63 @@ paths: required: true schema: type: string - - in: query - name: pageSize + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:disableAdvancedSiteSearch: + parameters: *ref_1 + post: + description: Downgrade from advanced site search to basic site search. + operationId: >- + discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.disableAdvancedSiteSearch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true schema: - type: integer - format: int32 - - in: query - name: pageToken + type: string + - in: path + name: locationsId + required: true schema: type: string - - in: query - name: filter + - in: path + name: collectionsId + required: true schema: type: string - - in: query - name: orderBy + - in: path + name: dataStoresId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions/{sessionsId}: + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:recrawlUris: parameters: *ref_1 - delete: - description: >- - Deletes a Session. If the Session to delete does not exist, a NOT_FOUND - error is returned. + post: + description: Request on-demand recrawl for a list of URIs. operationId: >- - discoveryengine.projects.locations.collections.dataStores.sessions.delete + discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.recrawlUris + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1RecrawlUrisRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18937,7 +27464,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -18959,21 +27486,20 @@ paths: required: true schema: type: string - - in: path - name: sessionsId - required: true - schema: - type: string - patch: + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:batchVerifyTargetSites: + parameters: *ref_1 + post: description: >- - Updates a Session. Session action type cannot be changed. If the Session - to update does not exist, a NOT_FOUND error is returned. - operationId: discoveryengine.projects.locations.collections.dataStores.sessions.patch + Verify target sites' ownership and validity. This API sends all the + target sites under site search engine for verification. + operationId: >- + discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.batchVerifyTargetSites requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Session' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18985,7 +27511,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Session' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -19007,19 +27533,15 @@ paths: required: true schema: type: string - - in: path - name: sessionsId - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:fetchDomainVerificationStatus: + parameters: *ref_1 get: - description: Gets a Session. - operationId: discoveryengine.projects.locations.collections.dataStores.sessions.get + description: >- + Returns list of target sites with its domain verification status. This + method can only be called under data store with BASIC_SITE_SEARCH state + at the moment. + operationId: >- + discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.fetchDomainVerificationStatus security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19031,7 +27553,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Session' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1FetchDomainVerificationStatusResponse parameters: - in: path name: projectsId @@ -19053,17 +27576,23 @@ paths: required: true schema: type: string - - in: path - name: sessionsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions/{sessionsId}/answers/{answersId}: + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/operations: parameters: *ref_1 get: - description: Gets a Answer. + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. operationId: >- - discoveryengine.projects.locations.collections.dataStores.sessions.answers.get + discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19075,7 +27604,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Answer' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -19097,24 +27626,28 @@ paths: required: true schema: type: string - - in: path - name: sessionsId - required: true + - in: query + name: filter schema: type: string - - in: path - name: answersId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/batchGetDocumentsMetadata: + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/operations/{operationsId}: parameters: *ref_1 get: description: >- - Gets index freshness metadata for Documents. Supported for website - search only. + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. operationId: >- - discoveryengine.projects.locations.collections.dataStores.branches.batchGetDocumentsMetadata + discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19126,8 +27659,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -19150,26 +27682,21 @@ paths: schema: type: string - in: path - name: branchesId + name: operationsId required: true schema: type: string - - in: query - name: matcher.urisMatcher.uris - schema: - type: string - - in: query - name: matcher.fhirMatcher.fhirResources - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites: parameters: *ref_1 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. + post: + description: Creates a TargetSite. operationId: >- - discoveryengine.projects.locations.collections.dataStores.branches.operations.list + discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1TargetSite' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19181,7 +27708,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -19203,33 +27730,10 @@ paths: required: true schema: type: string - - in: path - name: branchesId - required: true - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}: - parameters: *ref_1 get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. + description: Gets a list of TargetSites. operationId: >- - discoveryengine.projects.locations.collections.dataStores.branches.operations.get + discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19241,7 +27745,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ListTargetSitesResponse parameters: - in: path name: projectsId @@ -19263,36 +27768,27 @@ paths: required: true schema: type: string - - in: path - name: branchesId - required: true + - in: query + name: pageSize schema: - type: string - - in: path - name: operationsId - required: true + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites:batchCreate: parameters: *ref_1 post: - description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + description: Creates TargetSite in a batch. operationId: >- - discoveryengine.projects.locations.collections.dataStores.branches.operations.cancel + discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.batchCreate requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningCancelOperationRequest' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1BatchCreateTargetSitesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19304,7 +27800,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -19326,22 +27822,12 @@ paths: required: true schema: type: string - - in: path - name: branchesId - required: true - schema: - type: string - - in: path - name: operationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}: + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites/{targetSitesId}: parameters: *ref_1 get: - description: Gets a Document. + description: Gets a TargetSite. operationId: >- - discoveryengine.projects.locations.collections.dataStores.branches.documents.get + discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19353,7 +27839,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1TargetSite' parameters: - in: path name: projectsId @@ -19376,24 +27862,19 @@ paths: schema: type: string - in: path - name: branchesId - required: true - schema: - type: string - - in: path - name: documentsId + name: targetSitesId required: true schema: type: string patch: - description: Updates a Document. + description: Updates a TargetSite. operationId: >- - discoveryengine.projects.locations.collections.dataStores.branches.documents.patch + discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1TargetSite' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19405,7 +27886,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -19428,28 +27909,14 @@ paths: schema: type: string - in: path - name: branchesId - required: true - schema: - type: string - - in: path - name: documentsId + name: targetSitesId required: true schema: type: string - - in: query - name: allowMissing - schema: - type: boolean - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask delete: - description: Deletes a Document. + description: Deletes a TargetSite. operationId: >- - discoveryengine.projects.locations.collections.dataStores.branches.documents.delete + discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19461,7 +27928,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -19484,21 +27951,18 @@ paths: schema: type: string - in: path - name: branchesId - required: true - schema: - type: string - - in: path - name: documentsId + name: targetSitesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents: + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites/operations: parameters: *ref_1 get: - description: Gets a list of Documents. + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. operationId: >- - discoveryengine.projects.locations.collections.dataStores.branches.documents.list + discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19510,8 +27974,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ListDocumentsResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -19533,9 +27996,8 @@ paths: required: true schema: type: string - - in: path - name: branchesId - required: true + - in: query + name: filter schema: type: string - in: query @@ -19547,15 +28009,15 @@ paths: name: pageToken schema: type: string - post: - description: Creates a Document. + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. operationId: >- - discoveryengine.projects.locations.collections.dataStores.branches.documents.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' + discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19567,7 +28029,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -19590,29 +28052,21 @@ paths: schema: type: string - in: path - name: branchesId + name: operationsId required: true schema: type: string - - in: query - name: documentId - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:import: + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps: parameters: *ref_1 post: - description: >- - Bulk import of multiple Documents. Request processing may be - synchronous. Non-existing items are created. Note: It is possible for a - subset of the Documents to be successfully updated. + description: Creates a Sitemap. operationId: >- - discoveryengine.projects.locations.collections.dataStores.branches.documents.import + discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.sitemaps.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ImportDocumentsRequest + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Sitemap' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19646,30 +28100,12 @@ paths: required: true schema: type: string - - in: path - name: branchesId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:purge: + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps/{sitemapsId}: parameters: *ref_1 - post: - description: >- - Permanently deletes all selected Documents in a branch. This process is - asynchronous. Depending on the number of Documents to be deleted, this - operation can take hours to complete. Before the delete operation - completes, some Documents might still be returned by - DocumentService.GetDocument or DocumentService.ListDocuments. To get a - list of the Documents to be deleted, set PurgeDocumentsRequest.force to - false. + delete: + description: Deletes a Sitemap. operationId: >- - discoveryengine.projects.locations.collections.dataStores.branches.documents.purge - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1PurgeDocumentsRequest + discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.sitemaps.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19704,15 +28140,16 @@ paths: schema: type: string - in: path - name: branchesId + name: sitemapsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas/{schemasId}: + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps:fetch: parameters: *ref_1 get: - description: Gets a Schema. - operationId: discoveryengine.projects.locations.collections.dataStores.schemas.get + description: Fetch Sitemaps in a DataStore. + operationId: >- + discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.sitemaps.fetch security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19724,7 +28161,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Schema' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1FetchSitemapsResponse parameters: - in: path name: projectsId @@ -19746,19 +28184,21 @@ paths: required: true schema: type: string - - in: path - name: schemasId - required: true + - in: query + name: matcher.urisMatcher.uris schema: type: string - patch: - description: Updates a Schema. - operationId: discoveryengine.projects.locations.collections.dataStores.schemas.patch + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/userEvents:write: + parameters: *ref_1 + post: + description: Writes a single user event. + operationId: >- + discoveryengine.projects.locations.collections.dataStores.userEvents.write requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Schema' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1UserEvent' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19770,7 +28210,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1UserEvent' parameters: - in: path name: projectsId @@ -19792,18 +28232,20 @@ paths: required: true schema: type: string - - in: path - name: schemasId - required: true - schema: - type: string - in: query - name: allowMissing + name: writeAsync schema: type: boolean - delete: - description: Deletes a Schema. - operationId: discoveryengine.projects.locations.collections.dataStores.schemas.delete + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/userEvents:collect: + parameters: *ref_1 + get: + description: >- + Writes a single user event from the browser. This uses a GET request to + due to browser restriction of POST-ing to a third-party domain. This + method is used only by the Discovery Engine API JavaScript pixel and + Google Tag Manager. Users should not call this method directly. + operationId: >- + discoveryengine.projects.locations.collections.dataStores.userEvents.collect security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19815,7 +28257,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: projectsId @@ -19837,16 +28279,35 @@ paths: required: true schema: type: string - - in: path - name: schemasId - required: true + - in: query + name: userEvent schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas: + - in: query + name: uri + schema: + type: string + - in: query + name: ets + schema: + type: string + format: int64 + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/userEvents:purge: parameters: *ref_1 - get: - description: Gets a list of Schemas. - operationId: discoveryengine.projects.locations.collections.dataStores.schemas.list + post: + description: >- + Deletes permanently all user events specified by the filter provided. + Depending on the number of events specified by the filter, this + operation could take hours or days to complete. To test a filter, use + the list command first. + operationId: >- + discoveryengine.projects.locations.collections.dataStores.userEvents.purge + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1PurgeUserEventsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19858,8 +28319,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ListSchemasResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -19881,23 +28341,23 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/userEvents:import: + parameters: *ref_1 post: - description: Creates a Schema. - operationId: discoveryengine.projects.locations.collections.dataStores.schemas.create + description: >- + Bulk import of user events. Request processing might be synchronous. + Events that already exist are skipped. Use this method for backfilling + historical user events. Operation.response is of type ImportResponse. + Note that it is possible for a subset of the items to be successfully + inserted. Operation.metadata is of type ImportMetadata. + operationId: >- + discoveryengine.projects.locations.collections.dataStores.userEvents.import requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Schema' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ImportUserEventsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19931,18 +28391,16 @@ paths: required: true schema: type: string - - in: query - name: schemaId - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas/{schemasId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines: parameters: *ref_1 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: >- - discoveryengine.projects.locations.collections.dataStores.schemas.operations.list + post: + description: Creates a Engine. + operationId: discoveryengine.projects.locations.collections.engines.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Engine' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19954,7 +28412,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -19971,18 +28429,40 @@ paths: required: true schema: type: string + - in: query + name: engineId + schema: + type: string + get: + description: Lists all the Engines associated with the project. + operationId: discoveryengine.projects.locations.collections.engines.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ListEnginesResponse + parameters: - in: path - name: dataStoresId + name: projectsId required: true schema: type: string - in: path - name: schemasId + name: locationsId required: true schema: type: string - - in: query - name: filter + - in: path + name: collectionsId + required: true schema: type: string - in: query @@ -19994,15 +28474,15 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas/{schemasId}/operations/{operationsId}: + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}: parameters: *ref_1 - get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: >- - discoveryengine.projects.locations.collections.dataStores.schemas.operations.get + delete: + description: Deletes a Engine. + operationId: discoveryengine.projects.locations.collections.engines.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20032,26 +28512,59 @@ paths: schema: type: string - in: path - name: dataStoresId + name: enginesId required: true schema: type: string + patch: + description: Updates an Engine + operationId: discoveryengine.projects.locations.collections.engines.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Engine' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Engine' + parameters: - in: path - name: schemasId + name: projectsId required: true schema: type: string - in: path - name: operationsId + name: locationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/customModels: - parameters: *ref_1 + - in: path + name: collectionsId + required: true + schema: + type: string + - in: path + name: enginesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask get: - description: Gets a list of all the custom models. - operationId: >- - discoveryengine.projects.locations.collections.dataStores.customModels.list + description: Gets a Engine. + operationId: discoveryengine.projects.locations.collections.engines.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20063,8 +28576,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ListCustomModelsResponse + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Engine' parameters: - in: path name: projectsId @@ -20082,22 +28594,17 @@ paths: schema: type: string - in: path - name: dataStoresId + name: enginesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:enableAdvancedSiteSearch: + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/operations: parameters: *ref_1 - post: - description: Upgrade from basic site search to advanced site search. - operationId: >- - discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.enableAdvancedSiteSearch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchRequest + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: discoveryengine.projects.locations.collections.engines.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20109,7 +28616,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -20127,22 +28634,31 @@ paths: schema: type: string - in: path - name: dataStoresId + name: enginesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:disableAdvancedSiteSearch: + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/operations/{operationsId}: parameters: *ref_1 - post: - description: Downgrade from advanced site search to basic site search. - operationId: >- - discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.disableAdvancedSiteSearch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchRequest + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: discoveryengine.projects.locations.collections.engines.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20172,22 +28688,34 @@ paths: schema: type: string - in: path - name: dataStoresId + name: enginesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:recrawlUris: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/operations/{operationsId}:cancel: parameters: *ref_1 post: - description: Request on-demand recrawl for a list of URIs. - operationId: >- - discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.recrawlUris + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + `1`, corresponding to `Code.CANCELLED`. + operationId: discoveryengine.projects.locations.collections.engines.operations.cancel requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1RecrawlUrisRequest + $ref: '#/components/schemas/GoogleLongrunningCancelOperationRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20199,7 +28727,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -20217,24 +28745,26 @@ paths: schema: type: string - in: path - name: dataStoresId + name: enginesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:batchVerifyTargetSites: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}:search: parameters: *ref_1 post: - description: >- - Verify target sites' ownership and validity. This API sends all the - target sites under site search engine for verification. + description: Performs a search. operationId: >- - discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.batchVerifyTargetSites + discoveryengine.projects.locations.collections.engines.servingConfigs.search requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1SearchRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20246,7 +28776,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponse parameters: - in: path name: projectsId @@ -20264,19 +28795,35 @@ paths: schema: type: string - in: path - name: dataStoresId + name: enginesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:fetchDomainVerificationStatus: + - in: path + name: servingConfigsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}:searchLite: parameters: *ref_1 - get: + post: description: >- - Returns list of target sites with its domain verification status. This - method can only be called under data store with BASIC_SITE_SEARCH state - at the moment. + Performs a search. Similar to the SearchService.Search method, but a + lite version that allows API key for authentication, where OAuth and IAM + checks are not required. Only public website search is supported by this + method. If data stores and engines not associated with public website + search are specified, a `FAILED_PRECONDITION` error is returned. This + method can be used for easy onboarding without having to implement an + authentication backend. However, it is strongly recommended to use + SearchService.Search instead with required OAuth and IAM checks to + provide better data security. operationId: >- - discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.fetchDomainVerificationStatus + discoveryengine.projects.locations.collections.engines.servingConfigs.searchLite + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1SearchRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20289,7 +28836,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1FetchDomainVerificationStatusResponse + #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponse parameters: - in: path name: projectsId @@ -20307,27 +28854,27 @@ paths: schema: type: string - in: path - name: dataStoresId + name: enginesId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: servingConfigsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/operations: + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}:answer: parameters: *ref_1 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. + post: + description: Answer query method. operationId: >- - discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.operations.list + discoveryengine.projects.locations.collections.engines.servingConfigs.answer + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20339,7 +28886,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryResponse parameters: - in: path name: projectsId @@ -20357,32 +28905,29 @@ paths: schema: type: string - in: path - name: dataStoresId + name: enginesId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: servingConfigsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}:streamAnswer: parameters: *ref_1 - get: + post: description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. + Answer query method (streaming). It takes one AnswerQueryRequest and + returns multiple AnswerQueryResponse messages in a stream. operationId: >- - discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.operations.get + discoveryengine.projects.locations.collections.engines.servingConfigs.streamAnswer + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20394,7 +28939,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryResponse parameters: - in: path name: projectsId @@ -20412,26 +28958,27 @@ paths: schema: type: string - in: path - name: dataStoresId + name: enginesId required: true schema: type: string - in: path - name: operationsId + name: servingConfigsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites: + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}:recommend: parameters: *ref_1 post: - description: Creates a TargetSite. + description: Makes a recommendation, which requires a contextual user event. operationId: >- - discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.create + discoveryengine.projects.locations.collections.engines.servingConfigs.recommend requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1TargetSite' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1RecommendRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20443,7 +28990,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1RecommendResponse parameters: - in: path name: projectsId @@ -20461,14 +29009,28 @@ paths: schema: type: string - in: path - name: dataStoresId + name: enginesId required: true schema: type: string - get: - description: Gets a list of TargetSites. + - in: path + name: servingConfigsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}: + parameters: *ref_1 + patch: + description: >- + Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig + does not exist. operationId: >- - discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.list + discoveryengine.projects.locations.collections.engines.servingConfigs.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1ServingConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20480,8 +29042,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ListTargetSitesResponse + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1ServingConfig' parameters: - in: path name: projectsId @@ -20499,31 +29060,32 @@ paths: schema: type: string - in: path - name: dataStoresId + name: enginesId required: true schema: type: string - - in: query - name: pageSize + - in: path + name: servingConfigsId + required: true schema: - type: integer - format: int32 + type: string - in: query - name: pageToken + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites:batchCreate: + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}:streamAssist: parameters: *ref_1 post: - description: Creates TargetSite in a batch. + description: Assists the user with a query in a streaming fashion. operationId: >- - discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.batchCreate + discoveryengine.projects.locations.collections.engines.assistants.streamAssist requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1BatchCreateTargetSitesRequest + #/components/schemas/GoogleCloudDiscoveryengineV1StreamAssistRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20535,7 +29097,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1StreamAssistResponse parameters: - in: path name: projectsId @@ -20553,16 +29116,25 @@ paths: schema: type: string - in: path - name: dataStoresId + name: enginesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites/{targetSitesId}: + - in: path + name: assistantsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}: parameters: *ref_1 - get: - description: Gets a TargetSite. - operationId: >- - discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.get + patch: + description: Updates an Assistant + operationId: discoveryengine.projects.locations.collections.engines.assistants.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Assistant' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20574,7 +29146,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1TargetSite' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Assistant' parameters: - in: path name: projectsId @@ -20592,24 +29164,23 @@ paths: schema: type: string - in: path - name: dataStoresId + name: enginesId required: true schema: type: string - in: path - name: targetSitesId + name: assistantsId required: true schema: type: string - patch: - description: Updates a TargetSite. - operationId: >- - discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1TargetSite' + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + get: + description: Gets an Assistant. + operationId: discoveryengine.projects.locations.collections.engines.assistants.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20621,7 +29192,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Assistant' parameters: - in: path name: projectsId @@ -20639,31 +29210,44 @@ paths: schema: type: string - in: path - name: dataStoresId + name: enginesId required: true schema: type: string - in: path - name: targetSitesId + name: assistantsId required: true schema: type: string - delete: - description: Deletes a TargetSite. + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/completionConfig:completeQuery: + parameters: *ref_1 + post: + description: Completes the user input with advanced keyword suggestions. operationId: >- - discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.delete + discoveryengine.projects.locations.collections.engines.completionConfig.completeQuery + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud_search.query + Oauth2c: + - https://www.googleapis.com/auth/cloud_search.query responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponse parameters: - in: path name: projectsId @@ -20681,23 +29265,23 @@ paths: schema: type: string - in: path - name: dataStoresId - required: true - schema: - type: string - - in: path - name: targetSitesId + name: enginesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites/operations: + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/controls: parameters: *ref_1 - get: + post: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: >- - discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.operations.list + Creates a Control. By default 1000 controls are allowed for a data + store. A request can be submitted to adjust this limit. If the Control + to create already exists, an ALREADY_EXISTS error is returned. + operationId: discoveryengine.projects.locations.collections.engines.controls.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20709,7 +29293,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' parameters: - in: path name: projectsId @@ -20727,32 +29311,17 @@ paths: schema: type: string - in: path - name: dataStoresId + name: enginesId required: true schema: type: string - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + name: controlId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites/operations/{operationsId}: - parameters: *ref_1 get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: >- - discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.operations.get + description: Lists all Controls by their parent DataStore. + operationId: discoveryengine.projects.locations.collections.engines.controls.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20764,7 +29333,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ListControlsResponse parameters: - in: path name: projectsId @@ -20782,26 +29352,30 @@ paths: schema: type: string - in: path - name: dataStoresId + name: enginesId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/userEvents:write: + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/controls/{controlsId}: parameters: *ref_1 - post: - description: Writes a single user event. - operationId: >- - discoveryengine.projects.locations.collections.dataStores.userEvents.write - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1UserEvent' + delete: + description: >- + Deletes a Control. If the Control to delete does not exist, a NOT_FOUND + error is returned. + operationId: discoveryengine.projects.locations.collections.engines.controls.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20813,7 +29387,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1UserEvent' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -20831,24 +29405,25 @@ paths: schema: type: string - in: path - name: dataStoresId + name: enginesId required: true schema: type: string - - in: query - name: writeAsync + - in: path + name: controlsId + required: true schema: - type: boolean - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/userEvents:collect: - parameters: *ref_1 - get: + type: string + patch: description: >- - Writes a single user event from the browser. This uses a GET request to - due to browser restriction of POST-ing to a third-party domain. This - method is used only by the Discovery Engine API JavaScript pixel and - Google Tag Manager. Users should not call this method directly. - operationId: >- - discoveryengine.projects.locations.collections.dataStores.userEvents.collect + Updates a Control. Control action type cannot be changed. If the Control + to update does not exist, a NOT_FOUND error is returned. + operationId: discoveryengine.projects.locations.collections.engines.controls.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20860,7 +29435,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' parameters: - in: path name: projectsId @@ -20878,39 +29453,23 @@ paths: schema: type: string - in: path - name: dataStoresId + name: enginesId required: true schema: type: string - - in: query - name: userEvent - schema: - type: string - - in: query - name: uri + - in: path + name: controlsId + required: true schema: type: string - in: query - name: ets + name: updateMask schema: type: string - format: int64 - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/userEvents:purge: - parameters: *ref_1 - post: - description: >- - Deletes permanently all user events specified by the filter provided. - Depending on the number of events specified by the filter, this - operation could take hours or days to complete. To test a filter, use - the list command first. - operationId: >- - discoveryengine.projects.locations.collections.dataStores.userEvents.purge - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1PurgeUserEventsRequest + format: google-fieldmask + get: + description: Gets a Control. + operationId: discoveryengine.projects.locations.collections.engines.controls.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20922,7 +29481,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' parameters: - in: path name: projectsId @@ -20940,27 +29499,27 @@ paths: schema: type: string - in: path - name: dataStoresId + name: enginesId + required: true + schema: + type: string + - in: path + name: controlsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/userEvents:import: + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations/{conversationsId}:converse: parameters: *ref_1 post: - description: >- - Bulk import of user events. Request processing might be synchronous. - Events that already exist are skipped. Use this method for backfilling - historical user events. Operation.response is of type ImportResponse. - Note that it is possible for a subset of the items to be successfully - inserted. Operation.metadata is of type ImportMetadata. + description: Converses a conversation. operationId: >- - discoveryengine.projects.locations.collections.dataStores.userEvents.import + discoveryengine.projects.locations.collections.engines.conversations.converse requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ImportUserEventsRequest + #/components/schemas/GoogleCloudDiscoveryengineV1ConverseConversationRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20972,7 +29531,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ConverseConversationResponse parameters: - in: path name: projectsId @@ -20990,20 +29550,28 @@ paths: schema: type: string - in: path - name: dataStoresId + name: enginesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines: + - in: path + name: conversationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations: parameters: *ref_1 post: - description: Creates a Engine. - operationId: discoveryengine.projects.locations.collections.engines.create + description: >- + Creates a Conversation. If the Conversation to create already exists, an + ALREADY_EXISTS error is returned. + operationId: >- + discoveryengine.projects.locations.collections.engines.conversations.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Engine' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21015,7 +29583,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' parameters: - in: path name: projectsId @@ -21032,13 +29600,15 @@ paths: required: true schema: type: string - - in: query - name: engineId + - in: path + name: enginesId + required: true schema: type: string get: - description: Lists all the Engines associated with the project. - operationId: discoveryengine.projects.locations.collections.engines.list + description: Lists all Conversations by their parent DataStore. + operationId: >- + discoveryengine.projects.locations.collections.engines.conversations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21051,7 +29621,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ListEnginesResponse + #/components/schemas/GoogleCloudDiscoveryengineV1ListConversationsResponse parameters: - in: path name: projectsId @@ -21068,6 +29638,11 @@ paths: required: true schema: type: string + - in: path + name: enginesId + required: true + schema: + type: string - in: query name: pageSize schema: @@ -21081,11 +29656,18 @@ paths: name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}: + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations/{conversationsId}: parameters: *ref_1 delete: - description: Deletes a Engine. - operationId: discoveryengine.projects.locations.collections.engines.delete + description: >- + Deletes a Conversation. If the Conversation to delete does not exist, a + NOT_FOUND error is returned. + operationId: >- + discoveryengine.projects.locations.collections.engines.conversations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21097,7 +29679,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -21119,14 +29701,23 @@ paths: required: true schema: type: string + - in: path + name: conversationsId + required: true + schema: + type: string patch: - description: Updates an Engine - operationId: discoveryengine.projects.locations.collections.engines.patch + description: >- + Updates a Conversation. Conversation action type cannot be changed. If + the Conversation to update does not exist, a NOT_FOUND error is + returned. + operationId: >- + discoveryengine.projects.locations.collections.engines.conversations.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Engine' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21138,7 +29729,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Engine' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' parameters: - in: path name: projectsId @@ -21160,14 +29751,19 @@ paths: required: true schema: type: string + - in: path + name: conversationsId + required: true + schema: + type: string - in: query name: updateMask schema: type: string format: google-fieldmask get: - description: Gets a Engine. - operationId: discoveryengine.projects.locations.collections.engines.get + description: Gets a Conversation. + operationId: discoveryengine.projects.locations.collections.engines.conversations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21179,7 +29775,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Engine' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' parameters: - in: path name: projectsId @@ -21201,13 +29797,23 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/operations: + - in: path + name: conversationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions: parameters: *ref_1 - get: + post: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: discoveryengine.projects.locations.collections.engines.operations.list + Creates a Session. If the Session to create already exists, an + ALREADY_EXISTS error is returned. + operationId: discoveryengine.projects.locations.collections.engines.sessions.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Session' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21219,7 +29825,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Session' parameters: - in: path name: projectsId @@ -21241,8 +29847,41 @@ paths: required: true schema: type: string - - in: query - name: filter + get: + description: Lists all Sessions by their parent DataStore. + operationId: discoveryengine.projects.locations.collections.engines.sessions.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ListSessionsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: collectionsId + required: true + schema: + type: string + - in: path + name: enginesId + required: true schema: type: string - in: query @@ -21254,14 +29893,21 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/operations/{operationsId}: + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}: parameters: *ref_1 - get: + delete: description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: discoveryengine.projects.locations.collections.engines.operations.get + Deletes a Session. If the Session to delete does not exist, a NOT_FOUND + error is returned. + operationId: discoveryengine.projects.locations.collections.engines.sessions.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21273,7 +29919,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -21296,23 +29942,20 @@ paths: schema: type: string - in: path - name: operationsId + name: sessionsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/controls: - parameters: *ref_1 - post: + patch: description: >- - Creates a Control. By default 1000 controls are allowed for a data - store. A request can be submitted to adjust this limit. If the Control - to create already exists, an ALREADY_EXISTS error is returned. - operationId: discoveryengine.projects.locations.collections.engines.controls.create + Updates a Session. Session action type cannot be changed. If the Session + to update does not exist, a NOT_FOUND error is returned. + operationId: discoveryengine.projects.locations.collections.engines.sessions.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Session' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21324,7 +29967,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Session' parameters: - in: path name: projectsId @@ -21346,13 +29989,19 @@ paths: required: true schema: type: string + - in: path + name: sessionsId + required: true + schema: + type: string - in: query - name: controlId + name: updateMask schema: type: string + format: google-fieldmask get: - description: Lists all Controls by their parent DataStore. - operationId: discoveryengine.projects.locations.collections.engines.controls.list + description: Gets a Session. + operationId: discoveryengine.projects.locations.collections.engines.sessions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21364,8 +30013,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ListControlsResponse + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Session' parameters: - in: path name: projectsId @@ -21387,26 +30035,21 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: sessionsId + required: true schema: type: string - in: query - name: filter + name: includeAnswerDetails schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/controls/{controlsId}: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}/answers/{answersId}: parameters: *ref_1 - delete: - description: >- - Deletes a Control. If the Control to delete does not exist, a NOT_FOUND - error is returned. - operationId: discoveryengine.projects.locations.collections.engines.controls.delete + get: + description: Gets a Answer. + operationId: >- + discoveryengine.projects.locations.collections.engines.sessions.answers.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21418,7 +30061,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Answer' parameters: - in: path name: projectsId @@ -21441,20 +30084,22 @@ paths: schema: type: string - in: path - name: controlsId + name: sessionsId required: true schema: type: string - patch: + - in: path + name: answersId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations: + parameters: *ref_1 + get: description: >- - Updates a Control. Control action type cannot be changed. If the Control - to update does not exist, a NOT_FOUND error is returned. - operationId: discoveryengine.projects.locations.collections.engines.controls.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: discoveryengine.projects.locations.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21466,7 +30111,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -21478,29 +30123,27 @@ paths: required: true schema: type: string - - in: path - name: collectionsId - required: true - schema: - type: string - - in: path - name: enginesId - required: true + - in: query + name: filter schema: type: string - - in: path - name: controlsId - required: true + - in: query + name: pageSize schema: - type: string + type: integer + format: int32 - in: query - name: updateMask + name: pageToken schema: type: string - format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: + parameters: *ref_1 get: - description: Gets a Control. - operationId: discoveryengine.projects.locations.collections.engines.controls.get + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: discoveryengine.projects.locations.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21512,7 +30155,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -21525,31 +30168,18 @@ paths: schema: type: string - in: path - name: collectionsId - required: true - schema: - type: string - - in: path - name: enginesId - required: true - schema: - type: string - - in: path - name: controlsId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}:search: + /v1/projects/{projectsId}/locations/{locationsId}/podcasts/{podcastsId}/operations/{operationsId}: parameters: *ref_1 - post: - description: Performs a search. - operationId: >- - discoveryengine.projects.locations.collections.engines.servingConfigs.search - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1SearchRequest' + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: discoveryengine.projects.locations.podcasts.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21561,8 +30191,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -21575,40 +30204,29 @@ paths: schema: type: string - in: path - name: collectionsId - required: true - schema: - type: string - - in: path - name: enginesId + name: podcastsId required: true schema: type: string - in: path - name: servingConfigsId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}:searchLite: + /v1/projects/{projectsId}/locations/{locationsId}/cmekConfigs/{cmekConfigsId}: parameters: *ref_1 - post: + patch: description: >- - Performs a search. Similar to the SearchService.Search method, but a - lite version that allows API key for authentication, where OAuth and IAM - checks are not required. Only public website search is supported by this - method. If data stores and engines not associated with public website - search are specified, a `FAILED_PRECONDITION` error is returned. This - method can be used for easy onboarding without having to implement an - authentication backend. However, it is strongly recommended to use - SearchService.Search instead with required OAuth and IAM checks to - provide better data security. - operationId: >- - discoveryengine.projects.locations.collections.engines.servingConfigs.searchLite + Provisions a CMEK key for use in a location of a customer's project. + This method will also conduct location validation on the provided + cmekConfig to make sure the key is valid and can be used in the selected + location. + operationId: discoveryengine.projects.locations.cmekConfigs.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1SearchRequest' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1CmekConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21620,8 +30238,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -21634,32 +30251,17 @@ paths: schema: type: string - in: path - name: collectionsId - required: true - schema: - type: string - - in: path - name: enginesId + name: cmekConfigsId required: true schema: type: string - - in: path - name: servingConfigsId - required: true + - in: query + name: setDefault schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}:answer: - parameters: *ref_1 - post: - description: Answer query method. - operationId: >- - discoveryengine.projects.locations.collections.engines.servingConfigs.answer - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequest + type: boolean + get: + description: Gets the CmekConfig. + operationId: discoveryengine.projects.locations.cmekConfigs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21671,8 +30273,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryResponse + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1CmekConfig' parameters: - in: path name: projectsId @@ -21685,32 +30286,13 @@ paths: schema: type: string - in: path - name: collectionsId - required: true - schema: - type: string - - in: path - name: enginesId - required: true - schema: - type: string - - in: path - name: servingConfigsId + name: cmekConfigsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}:recommend: - parameters: *ref_1 - post: - description: Makes a recommendation, which requires a contextual user event. - operationId: >- - discoveryengine.projects.locations.collections.engines.servingConfigs.recommend - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1RecommendRequest + delete: + description: De-provisions a CmekConfig. + operationId: discoveryengine.projects.locations.cmekConfigs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21722,8 +30304,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1RecommendResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -21736,32 +30317,44 @@ paths: schema: type: string - in: path - name: collectionsId + name: cmekConfigsId required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/cmekConfigs: + parameters: *ref_1 + get: + description: Lists all the CmekConfigs with the project. + operationId: discoveryengine.projects.locations.cmekConfigs.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ListCmekConfigsResponse + parameters: - in: path - name: enginesId + name: projectsId required: true schema: type: string - in: path - name: servingConfigsId + name: locationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations/{conversationsId}:converse: + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}:completeQuery: parameters: *ref_1 - post: - description: Converses a conversation. - operationId: >- - discoveryengine.projects.locations.collections.engines.conversations.converse - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ConverseConversationRequest + get: + description: Completes the specified user input with keyword suggestions. + operationId: discoveryengine.projects.locations.dataStores.completeQuery security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21774,7 +30367,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ConverseConversationResponse + #/components/schemas/GoogleCloudDiscoveryengineV1CompleteQueryResponse parameters: - in: path name: projectsId @@ -21787,33 +30380,39 @@ paths: schema: type: string - in: path - name: collectionsId + name: dataStoresId required: true schema: type: string - - in: path - name: enginesId - required: true + - in: query + name: query schema: type: string - - in: path - name: conversationsId - required: true + - in: query + name: queryModel schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations: + - in: query + name: userPseudoId + schema: + type: string + - in: query + name: includeTailSuggestions + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/dataStores: parameters: *ref_1 post: description: >- - Creates a Conversation. If the Conversation to create already exists, an - ALREADY_EXISTS error is returned. - operationId: >- - discoveryengine.projects.locations.collections.engines.conversations.create + Creates a DataStore. DataStore is for storing Documents. To serve these + documents for Search, or Recommendation use case, an Engine needs to be + created separately. + operationId: discoveryengine.projects.locations.dataStores.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1DataStore' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21825,7 +30424,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -21837,20 +30436,29 @@ paths: required: true schema: type: string - - in: path - name: collectionsId - required: true + - in: query + name: cmekConfigName schema: type: string - - in: path - name: enginesId - required: true + - in: query + name: disableCmek + schema: + type: boolean + - in: query + name: dataStoreId schema: type: string + - in: query + name: createAdvancedSiteSearch + schema: + type: boolean + - in: query + name: skipDefaultSchemaCreation + schema: + type: boolean get: - description: Lists all Conversations by their parent DataStore. - operationId: >- - discoveryengine.projects.locations.collections.engines.conversations.list + description: Lists all the DataStores associated with the project. + operationId: discoveryengine.projects.locations.dataStores.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21863,25 +30471,15 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ListConversationsResponse + #/components/schemas/GoogleCloudDiscoveryengineV1ListDataStoresResponse parameters: - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: collectionsId + name: projectsId required: true schema: type: string - in: path - name: enginesId + name: locationsId required: true schema: type: string @@ -21898,18 +30496,11 @@ paths: name: filter schema: type: string - - in: query - name: orderBy - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations/{conversationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}: parameters: *ref_1 - delete: - description: >- - Deletes a Conversation. If the Conversation to delete does not exist, a - NOT_FOUND error is returned. - operationId: >- - discoveryengine.projects.locations.collections.engines.conversations.delete + get: + description: Gets a DataStore. + operationId: discoveryengine.projects.locations.dataStores.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21921,7 +30512,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1DataStore' parameters: - in: path name: projectsId @@ -21934,32 +30525,49 @@ paths: schema: type: string - in: path - name: collectionsId + name: dataStoresId + required: true + schema: + type: string + delete: + description: Deletes a DataStore. + operationId: discoveryengine.projects.locations.dataStores.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId required: true schema: type: string - in: path - name: enginesId + name: locationsId required: true schema: type: string - in: path - name: conversationsId + name: dataStoresId required: true schema: type: string patch: - description: >- - Updates a Conversation. Conversation action type cannot be changed. If - the Conversation to update does not exist, a NOT_FOUND error is - returned. - operationId: >- - discoveryengine.projects.locations.collections.engines.conversations.patch + description: Updates a DataStore + operationId: discoveryengine.projects.locations.dataStores.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1DataStore' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21971,7 +30579,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1DataStore' parameters: - in: path name: projectsId @@ -21984,17 +30592,7 @@ paths: schema: type: string - in: path - name: collectionsId - required: true - schema: - type: string - - in: path - name: enginesId - required: true - schema: - type: string - - in: path - name: conversationsId + name: dataStoresId required: true schema: type: string @@ -22003,9 +30601,11 @@ paths: schema: type: string format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine: + parameters: *ref_1 get: - description: Gets a Conversation. - operationId: discoveryengine.projects.locations.collections.engines.conversations.get + description: Gets the SiteSearchEngine. + operationId: discoveryengine.projects.locations.dataStores.getSiteSearchEngine security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22017,7 +30617,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SiteSearchEngine parameters: - in: path name: projectsId @@ -22030,32 +30631,17 @@ paths: schema: type: string - in: path - name: collectionsId - required: true - schema: - type: string - - in: path - name: enginesId - required: true - schema: - type: string - - in: path - name: conversationsId + name: dataStoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions: + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/models/{modelsId}/operations: parameters: *ref_1 - post: + get: description: >- - Creates a Session. If the Session to create already exists, an - ALREADY_EXISTS error is returned. - operationId: discoveryengine.projects.locations.collections.engines.sessions.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Session' + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: discoveryengine.projects.locations.dataStores.models.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22067,7 +30653,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Session' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -22080,18 +30666,36 @@ paths: schema: type: string - in: path - name: collectionsId + name: dataStoresId required: true schema: type: string - in: path - name: enginesId + name: modelsId required: true schema: type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/models/{modelsId}/operations/{operationsId}: + parameters: *ref_1 get: - description: Lists all Sessions by their parent DataStore. - operationId: discoveryengine.projects.locations.collections.engines.sessions.list + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: discoveryengine.projects.locations.dataStores.models.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22103,8 +30707,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ListSessionsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -22117,39 +30720,27 @@ paths: schema: type: string - in: path - name: collectionsId + name: dataStoresId required: true schema: type: string - in: path - name: enginesId + name: modelsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: orderBy + - in: path + name: operationsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}: + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/operations: parameters: *ref_1 - delete: + get: description: >- - Deletes a Session. If the Session to delete does not exist, a NOT_FOUND - error is returned. - operationId: discoveryengine.projects.locations.collections.engines.sessions.delete + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: discoveryengine.projects.locations.dataStores.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22161,7 +30752,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -22174,30 +30765,31 @@ paths: schema: type: string - in: path - name: collectionsId + name: dataStoresId required: true schema: type: string - - in: path - name: enginesId - required: true + - in: query + name: filter schema: type: string - - in: path - name: sessionsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - patch: + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/operations/{operationsId}: + parameters: *ref_1 + get: description: >- - Updates a Session. Session action type cannot be changed. If the Session - to update does not exist, a NOT_FOUND error is returned. - operationId: discoveryengine.projects.locations.collections.engines.sessions.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Session' + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: discoveryengine.projects.locations.dataStores.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22209,7 +30801,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Session' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -22222,28 +30814,25 @@ paths: schema: type: string - in: path - name: collectionsId - required: true - schema: - type: string - - in: path - name: enginesId + name: dataStoresId required: true schema: type: string - in: path - name: sessionsId + name: operationsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - get: - description: Gets a Session. - operationId: discoveryengine.projects.locations.collections.engines.sessions.get + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:search: + parameters: *ref_1 + post: + description: Performs a search. + operationId: discoveryengine.projects.locations.dataStores.servingConfigs.search + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1SearchRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22255,7 +30844,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Session' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponse parameters: - in: path name: projectsId @@ -22268,26 +30858,34 @@ paths: schema: type: string - in: path - name: collectionsId - required: true - schema: - type: string - - in: path - name: enginesId + name: dataStoresId required: true schema: type: string - in: path - name: sessionsId + name: servingConfigsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}/answers/{answersId}: + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:searchLite: parameters: *ref_1 - get: - description: Gets a Answer. - operationId: >- - discoveryengine.projects.locations.collections.engines.sessions.answers.get + post: + description: >- + Performs a search. Similar to the SearchService.Search method, but a + lite version that allows API key for authentication, where OAuth and IAM + checks are not required. Only public website search is supported by this + method. If data stores and engines not associated with public website + search are specified, a `FAILED_PRECONDITION` error is returned. This + method can be used for easy onboarding without having to implement an + authentication backend. However, it is strongly recommended to use + SearchService.Search instead with required OAuth and IAM checks to + provide better data security. + operationId: discoveryengine.projects.locations.dataStores.servingConfigs.searchLite + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1SearchRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22299,7 +30897,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Answer' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponse parameters: - in: path name: projectsId @@ -22312,32 +30911,26 @@ paths: schema: type: string - in: path - name: collectionsId - required: true - schema: - type: string - - in: path - name: enginesId - required: true - schema: - type: string - - in: path - name: sessionsId + name: dataStoresId required: true schema: type: string - in: path - name: answersId + name: servingConfigsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:answer: parameters: *ref_1 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: discoveryengine.projects.locations.identityMappingStores.operations.list + post: + description: Answer query method. + operationId: discoveryengine.projects.locations.dataStores.servingConfigs.answer + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22349,7 +30942,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryResponse parameters: - in: path name: projectsId @@ -22362,31 +30956,29 @@ paths: schema: type: string - in: path - name: identityMappingStoresId + name: dataStoresId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: servingConfigsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:streamAnswer: parameters: *ref_1 - get: + post: description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: discoveryengine.projects.locations.identityMappingStores.operations.get + Answer query method (streaming). It takes one AnswerQueryRequest and + returns multiple AnswerQueryResponse messages in a stream. + operationId: >- + discoveryengine.projects.locations.dataStores.servingConfigs.streamAnswer + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22398,7 +30990,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryResponse parameters: - in: path name: projectsId @@ -22411,22 +31004,26 @@ paths: schema: type: string - in: path - name: identityMappingStoresId + name: dataStoresId required: true schema: type: string - in: path - name: operationsId + name: servingConfigsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:recommend: parameters: *ref_1 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: discoveryengine.projects.locations.operations.list + post: + description: Makes a recommendation, which requires a contextual user event. + operationId: discoveryengine.projects.locations.dataStores.servingConfigs.recommend + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1RecommendRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22438,7 +31035,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1RecommendResponse parameters: - in: path name: projectsId @@ -22450,27 +31048,28 @@ paths: required: true schema: type: string - - in: query - name: filter + - in: path + name: dataStoresId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: servingConfigsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}: parameters: *ref_1 - get: + patch: description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: discoveryengine.projects.locations.operations.get + Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig + does not exist. + operationId: discoveryengine.projects.locations.dataStores.servingConfigs.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1ServingConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22482,7 +31081,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1ServingConfig' parameters: - in: path name: projectsId @@ -22495,20 +31094,41 @@ paths: schema: type: string - in: path - name: operationsId + name: dataStoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}:completeQuery: + - in: path + name: servingConfigsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/completionConfig:completeQuery: parameters: *ref_1 - get: - description: Completes the specified user input with keyword suggestions. - operationId: discoveryengine.projects.locations.dataStores.completeQuery + post: + description: Completes the user input with advanced keyword suggestions. + operationId: >- + discoveryengine.projects.locations.dataStores.completionConfig.completeQuery + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud_search.query + Oauth2c: + - https://www.googleapis.com/auth/cloud_search.query responses: '200': description: Successful response @@ -22516,7 +31136,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1CompleteQueryResponse + #/components/schemas/GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponse parameters: - in: path name: projectsId @@ -22533,35 +31153,18 @@ paths: required: true schema: type: string - - in: query - name: query - schema: - type: string - - in: query - name: queryModel - schema: - type: string - - in: query - name: userPseudoId - schema: - type: string - - in: query - name: includeTailSuggestions - schema: - type: boolean - /v1/projects/{projectsId}/locations/{locationsId}/dataStores: + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/suggestionDenyListEntries:import: parameters: *ref_1 post: - description: >- - Creates a DataStore. DataStore is for storing Documents. To serve these - documents for Search, or Recommendation use case, an Engine needs to be - created separately. - operationId: discoveryengine.projects.locations.dataStores.create + description: Imports all SuggestionDenyListEntry for a DataStore. + operationId: >- + discoveryengine.projects.locations.dataStores.suggestionDenyListEntries.import requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1DataStore' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22585,29 +31188,23 @@ paths: required: true schema: type: string - - in: query - name: cmekConfigName - schema: - type: string - - in: query - name: disableCmek - schema: - type: boolean - - in: query - name: dataStoreId + - in: path + name: dataStoresId + required: true schema: type: string - - in: query - name: createAdvancedSiteSearch - schema: - type: boolean - - in: query - name: skipDefaultSchemaCreation - schema: - type: boolean - get: - description: Lists all the DataStores associated with the project. - operationId: discoveryengine.projects.locations.dataStores.list + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/suggestionDenyListEntries:purge: + parameters: *ref_1 + post: + description: Permanently deletes all SuggestionDenyListEntry for a DataStore. + operationId: >- + discoveryengine.projects.locations.dataStores.suggestionDenyListEntries.purge + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22619,8 +31216,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ListDataStoresResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -22632,24 +31228,23 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + - in: path + name: dataStoresId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}: + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/completionSuggestions:import: parameters: *ref_1 - get: - description: Gets a DataStore. - operationId: discoveryengine.projects.locations.dataStores.get + post: + description: Imports CompletionSuggestions for a DataStore. + operationId: >- + discoveryengine.projects.locations.dataStores.completionSuggestions.import + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22661,7 +31256,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1DataStore' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -22678,9 +31273,18 @@ paths: required: true schema: type: string - delete: - description: Deletes a DataStore. - operationId: discoveryengine.projects.locations.dataStores.delete + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/completionSuggestions:purge: + parameters: *ref_1 + post: + description: Permanently deletes all CompletionSuggestions for a DataStore. + operationId: >- + discoveryengine.projects.locations.dataStores.completionSuggestions.purge + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22709,14 +31313,19 @@ paths: required: true schema: type: string - patch: - description: Updates a DataStore - operationId: discoveryengine.projects.locations.dataStores.patch + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/controls: + parameters: *ref_1 + post: + description: >- + Creates a Control. By default 1000 controls are allowed for a data + store. A request can be submitted to adjust this limit. If the Control + to create already exists, an ALREADY_EXISTS error is returned. + operationId: discoveryengine.projects.locations.dataStores.controls.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1DataStore' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22728,7 +31337,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1DataStore' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' parameters: - in: path name: projectsId @@ -22746,15 +31355,12 @@ paths: schema: type: string - in: query - name: updateMask + name: controlId schema: type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine: - parameters: *ref_1 get: - description: Gets the SiteSearchEngine. - operationId: discoveryengine.projects.locations.dataStores.getSiteSearchEngine + description: Lists all Controls by their parent DataStore. + operationId: discoveryengine.projects.locations.dataStores.controls.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22767,7 +31373,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SiteSearchEngine + #/components/schemas/GoogleCloudDiscoveryengineV1ListControlsResponse parameters: - in: path name: projectsId @@ -22784,13 +31390,26 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/models/{modelsId}/operations: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/controls/{controlsId}: parameters: *ref_1 - get: + delete: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: discoveryengine.projects.locations.dataStores.models.operations.list + Deletes a Control. If the Control to delete does not exist, a NOT_FOUND + error is returned. + operationId: discoveryengine.projects.locations.dataStores.controls.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22802,7 +31421,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -22820,31 +31439,20 @@ paths: schema: type: string - in: path - name: modelsId + name: controlsId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/models/{modelsId}/operations/{operationsId}: - parameters: *ref_1 - get: + patch: description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: discoveryengine.projects.locations.dataStores.models.operations.get + Updates a Control. Control action type cannot be changed. If the Control + to update does not exist, a NOT_FOUND error is returned. + operationId: discoveryengine.projects.locations.dataStores.controls.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22856,7 +31464,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' parameters: - in: path name: projectsId @@ -22874,22 +31482,18 @@ paths: schema: type: string - in: path - name: modelsId + name: controlsId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/operations: - parameters: *ref_1 + format: google-fieldmask get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: discoveryengine.projects.locations.dataStores.operations.list + description: Gets a Control. + operationId: discoveryengine.projects.locations.dataStores.controls.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22901,7 +31505,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' parameters: - in: path name: projectsId @@ -22918,27 +31522,22 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: controlsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/conversations/{conversationsId}:converse: parameters: *ref_1 - get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: discoveryengine.projects.locations.dataStores.operations.get + post: + description: Converses a conversation. + operationId: discoveryengine.projects.locations.dataStores.conversations.converse + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ConverseConversationRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22950,7 +31549,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ConverseConversationResponse parameters: - in: path name: projectsId @@ -22968,22 +31568,22 @@ paths: schema: type: string - in: path - name: operationsId + name: conversationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/suggestionDenyListEntries:import: + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/conversations: parameters: *ref_1 post: - description: Imports all SuggestionDenyListEntry for a DataStore. - operationId: >- - discoveryengine.projects.locations.dataStores.suggestionDenyListEntries.import + description: >- + Creates a Conversation. If the Conversation to create already exists, an + ALREADY_EXISTS error is returned. + operationId: discoveryengine.projects.locations.dataStores.conversations.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesRequest + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22995,7 +31595,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' parameters: - in: path name: projectsId @@ -23012,18 +31612,9 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/suggestionDenyListEntries:purge: - parameters: *ref_1 - post: - description: Permanently deletes all SuggestionDenyListEntry for a DataStore. - operationId: >- - discoveryengine.projects.locations.dataStores.suggestionDenyListEntries.purge - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesRequest + get: + description: Lists all Conversations by their parent DataStore. + operationId: discoveryengine.projects.locations.dataStores.conversations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23035,7 +31626,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ListConversationsResponse parameters: - in: path name: projectsId @@ -23052,18 +31644,74 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/completionSuggestions:import: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/conversations/{conversationsId}: parameters: *ref_1 - post: - description: Imports CompletionSuggestions for a DataStore. - operationId: >- - discoveryengine.projects.locations.dataStores.completionSuggestions.import + delete: + description: >- + Deletes a Conversation. If the Conversation to delete does not exist, a + NOT_FOUND error is returned. + operationId: discoveryengine.projects.locations.dataStores.conversations.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: dataStoresId + required: true + schema: + type: string + - in: path + name: conversationsId + required: true + schema: + type: string + patch: + description: >- + Updates a Conversation. Conversation action type cannot be changed. If + the Conversation to update does not exist, a NOT_FOUND error is + returned. + operationId: discoveryengine.projects.locations.dataStores.conversations.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequest + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23075,7 +31723,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' parameters: - in: path name: projectsId @@ -23092,18 +31740,19 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/completionSuggestions:purge: - parameters: *ref_1 - post: - description: Permanently deletes all CompletionSuggestions for a DataStore. - operationId: >- - discoveryengine.projects.locations.dataStores.completionSuggestions.purge - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsRequest + - in: path + name: conversationsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + get: + description: Gets a Conversation. + operationId: discoveryengine.projects.locations.dataStores.conversations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23115,7 +31764,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' parameters: - in: path name: projectsId @@ -23132,19 +31781,19 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/controls: + - in: path + name: conversationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/batchGetDocumentsMetadata: parameters: *ref_1 - post: + get: description: >- - Creates a Control. By default 1000 controls are allowed for a data - store. A request can be submitted to adjust this limit. If the Control - to create already exists, an ALREADY_EXISTS error is returned. - operationId: discoveryengine.projects.locations.dataStores.controls.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' + Gets index freshness metadata for Documents. Supported for website + search only. + operationId: >- + discoveryengine.projects.locations.dataStores.branches.batchGetDocumentsMetadata security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23156,7 +31805,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse parameters: - in: path name: projectsId @@ -23173,13 +31823,26 @@ paths: required: true schema: type: string + - in: path + name: branchesId + required: true + schema: + type: string - in: query - name: controlId + name: matcher.urisMatcher.uris + schema: + type: string + - in: query + name: matcher.fhirMatcher.fhirResources schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations: + parameters: *ref_1 get: - description: Lists all Controls by their parent DataStore. - operationId: discoveryengine.projects.locations.dataStores.controls.list + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: discoveryengine.projects.locations.dataStores.branches.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23191,8 +31854,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ListControlsResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -23209,6 +31871,15 @@ paths: required: true schema: type: string + - in: path + name: branchesId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string - in: query name: pageSize schema: @@ -23218,17 +31889,14 @@ paths: name: pageToken schema: type: string - - in: query - name: filter - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/controls/{controlsId}: + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}: parameters: *ref_1 - delete: + get: description: >- - Deletes a Control. If the Control to delete does not exist, a NOT_FOUND - error is returned. - operationId: discoveryengine.projects.locations.dataStores.controls.delete + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: discoveryengine.projects.locations.dataStores.branches.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23240,7 +31908,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -23258,20 +31926,34 @@ paths: schema: type: string - in: path - name: controlsId + name: branchesId required: true schema: type: string - patch: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: description: >- - Updates a Control. Control action type cannot be changed. If the Control - to update does not exist, a NOT_FOUND error is returned. - operationId: discoveryengine.projects.locations.dataStores.controls.patch + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + `1`, corresponding to `Code.CANCELLED`. + operationId: discoveryengine.projects.locations.dataStores.branches.operations.cancel requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' + $ref: '#/components/schemas/GoogleLongrunningCancelOperationRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23283,7 +31965,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -23301,18 +31983,20 @@ paths: schema: type: string - in: path - name: controlsId + name: branchesId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: operationsId + required: true schema: type: string - format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}: + parameters: *ref_1 get: - description: Gets a Control. - operationId: discoveryengine.projects.locations.dataStores.controls.get + description: Gets a Document. + operationId: discoveryengine.projects.locations.dataStores.branches.documents.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23324,7 +32008,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' parameters: - in: path name: projectsId @@ -23342,20 +32026,23 @@ paths: schema: type: string - in: path - name: controlsId + name: branchesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:search: - parameters: *ref_1 - post: - description: Performs a search. - operationId: discoveryengine.projects.locations.dataStores.servingConfigs.search + - in: path + name: documentsId + required: true + schema: + type: string + patch: + description: Updates a Document. + operationId: discoveryengine.projects.locations.dataStores.branches.documents.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1SearchRequest' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23367,8 +32054,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponse + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' parameters: - in: path name: projectsId @@ -23386,29 +32072,70 @@ paths: schema: type: string - in: path - name: servingConfigsId + name: branchesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:searchLite: + - in: path + name: documentsId + required: true + schema: + type: string + - in: query + name: allowMissing + schema: + type: boolean + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a Document. + operationId: discoveryengine.projects.locations.dataStores.branches.documents.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: dataStoresId + required: true + schema: + type: string + - in: path + name: branchesId + required: true + schema: + type: string + - in: path + name: documentsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents: parameters: *ref_1 - post: - description: >- - Performs a search. Similar to the SearchService.Search method, but a - lite version that allows API key for authentication, where OAuth and IAM - checks are not required. Only public website search is supported by this - method. If data stores and engines not associated with public website - search are specified, a `FAILED_PRECONDITION` error is returned. This - method can be used for easy onboarding without having to implement an - authentication backend. However, it is strongly recommended to use - SearchService.Search instead with required OAuth and IAM checks to - provide better data security. - operationId: discoveryengine.projects.locations.dataStores.servingConfigs.searchLite - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1SearchRequest' + get: + description: Gets a list of Documents. + operationId: discoveryengine.projects.locations.dataStores.branches.documents.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23421,7 +32148,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponse + #/components/schemas/GoogleCloudDiscoveryengineV1ListDocumentsResponse parameters: - in: path name: projectsId @@ -23439,21 +32166,27 @@ paths: schema: type: string - in: path - name: servingConfigsId + name: branchesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:answer: - parameters: *ref_1 + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string post: - description: Answer query method. - operationId: discoveryengine.projects.locations.dataStores.servingConfigs.answer + description: Creates a Document. + operationId: discoveryengine.projects.locations.dataStores.branches.documents.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequest + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23465,8 +32198,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryResponse + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' parameters: - in: path name: projectsId @@ -23484,21 +32216,28 @@ paths: schema: type: string - in: path - name: servingConfigsId + name: branchesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:recommend: + - in: query + name: documentId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:import: parameters: *ref_1 post: - description: Makes a recommendation, which requires a contextual user event. - operationId: discoveryengine.projects.locations.dataStores.servingConfigs.recommend + description: >- + Bulk import of multiple Documents. Request processing may be + synchronous. Non-existing items are created. Note: It is possible for a + subset of the Documents to be successfully updated. + operationId: discoveryengine.projects.locations.dataStores.branches.documents.import requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1RecommendRequest + #/components/schemas/GoogleCloudDiscoveryengineV1ImportDocumentsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23510,8 +32249,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1RecommendResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -23529,21 +32267,28 @@ paths: schema: type: string - in: path - name: servingConfigsId + name: branchesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/conversations/{conversationsId}:converse: + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:purge: parameters: *ref_1 post: - description: Converses a conversation. - operationId: discoveryengine.projects.locations.dataStores.conversations.converse + description: >- + Permanently deletes all selected Documents in a branch. This process is + asynchronous. Depending on the number of Documents to be deleted, this + operation can take hours to complete. Before the delete operation + completes, some Documents might still be returned by + DocumentService.GetDocument or DocumentService.ListDocuments. To get a + list of the Documents to be deleted, set PurgeDocumentsRequest.force to + false. + operationId: discoveryengine.projects.locations.dataStores.branches.documents.purge requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ConverseConversationRequest + #/components/schemas/GoogleCloudDiscoveryengineV1PurgeDocumentsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23555,8 +32300,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ConverseConversationResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -23574,22 +32318,15 @@ paths: schema: type: string - in: path - name: conversationsId + name: branchesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/conversations: + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/schemas/{schemasId}: parameters: *ref_1 - post: - description: >- - Creates a Conversation. If the Conversation to create already exists, an - ALREADY_EXISTS error is returned. - operationId: discoveryengine.projects.locations.dataStores.conversations.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' + get: + description: Gets a Schema. + operationId: discoveryengine.projects.locations.dataStores.schemas.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23601,7 +32338,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Schema' parameters: - in: path name: projectsId @@ -23618,9 +32355,19 @@ paths: required: true schema: type: string - get: - description: Lists all Conversations by their parent DataStore. - operationId: discoveryengine.projects.locations.dataStores.conversations.list + - in: path + name: schemasId + required: true + schema: + type: string + patch: + description: Updates a Schema. + operationId: discoveryengine.projects.locations.dataStores.schemas.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Schema' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23632,8 +32379,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ListConversationsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -23650,30 +32396,18 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + - in: path + name: schemasId + required: true schema: type: string - in: query - name: orderBy + name: allowMissing schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/conversations/{conversationsId}: - parameters: *ref_1 + type: boolean delete: - description: >- - Deletes a Conversation. If the Conversation to delete does not exist, a - NOT_FOUND error is returned. - operationId: discoveryengine.projects.locations.dataStores.conversations.delete + description: Deletes a Schema. + operationId: discoveryengine.projects.locations.dataStores.schemas.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23685,7 +32419,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -23703,21 +32437,15 @@ paths: schema: type: string - in: path - name: conversationsId + name: schemasId required: true schema: type: string - patch: - description: >- - Updates a Conversation. Conversation action type cannot be changed. If - the Conversation to update does not exist, a NOT_FOUND error is - returned. - operationId: discoveryengine.projects.locations.dataStores.conversations.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/schemas: + parameters: *ref_1 + get: + description: Gets a list of Schemas. + operationId: discoveryengine.projects.locations.dataStores.schemas.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23729,7 +32457,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ListSchemasResponse parameters: - in: path name: projectsId @@ -23746,19 +32475,23 @@ paths: required: true schema: type: string - - in: path - name: conversationsId - required: true + - in: query + name: pageSize schema: - type: string + type: integer + format: int32 - in: query - name: updateMask + name: pageToken schema: type: string - format: google-fieldmask - get: - description: Gets a Conversation. - operationId: discoveryengine.projects.locations.dataStores.conversations.get + post: + description: Creates a Schema. + operationId: discoveryengine.projects.locations.dataStores.schemas.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Schema' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23770,7 +32503,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -23787,9 +32520,8 @@ paths: required: true schema: type: string - - in: path - name: conversationsId - required: true + - in: query + name: schemaId schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions: @@ -23886,92 +32618,8 @@ paths: delete: description: >- Deletes a Session. If the Session to delete does not exist, a NOT_FOUND - error is returned. - operationId: discoveryengine.projects.locations.dataStores.sessions.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: dataStoresId - required: true - schema: - type: string - - in: path - name: sessionsId - required: true - schema: - type: string - patch: - description: >- - Updates a Session. Session action type cannot be changed. If the Session - to update does not exist, a NOT_FOUND error is returned. - operationId: discoveryengine.projects.locations.dataStores.sessions.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Session' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Session' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: dataStoresId - required: true - schema: - type: string - - in: path - name: sessionsId - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - get: - description: Gets a Session. - operationId: discoveryengine.projects.locations.dataStores.sessions.get + error is returned. + operationId: discoveryengine.projects.locations.dataStores.sessions.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23983,7 +32631,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Session' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -24005,11 +32653,16 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions/{sessionsId}/answers/{answersId}: - parameters: *ref_1 - get: - description: Gets a Answer. - operationId: discoveryengine.projects.locations.dataStores.sessions.answers.get + patch: + description: >- + Updates a Session. Session action type cannot be changed. If the Session + to update does not exist, a NOT_FOUND error is returned. + operationId: discoveryengine.projects.locations.dataStores.sessions.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Session' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24021,7 +32674,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Answer' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Session' parameters: - in: path name: projectsId @@ -24043,19 +32696,14 @@ paths: required: true schema: type: string - - in: path - name: answersId - required: true + - in: query + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/batchGetDocumentsMetadata: - parameters: *ref_1 + format: google-fieldmask get: - description: >- - Gets index freshness metadata for Documents. Supported for website - search only. - operationId: >- - discoveryengine.projects.locations.dataStores.branches.batchGetDocumentsMetadata + description: Gets a Session. + operationId: discoveryengine.projects.locations.dataStores.sessions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24067,8 +32715,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Session' parameters: - in: path name: projectsId @@ -24086,25 +32733,19 @@ paths: schema: type: string - in: path - name: branchesId + name: sessionsId required: true schema: type: string - in: query - name: matcher.urisMatcher.uris - schema: - type: string - - in: query - name: matcher.fhirMatcher.fhirResources + name: includeAnswerDetails schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions/{sessionsId}/answers/{answersId}: parameters: *ref_1 get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: discoveryengine.projects.locations.dataStores.branches.operations.list + description: Gets a Answer. + operationId: discoveryengine.projects.locations.dataStores.sessions.answers.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24116,7 +32757,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Answer' parameters: - in: path name: projectsId @@ -24134,31 +32775,27 @@ paths: schema: type: string - in: path - name: branchesId + name: sessionsId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: answersId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine:enableAdvancedSiteSearch: parameters: *ref_1 - get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: discoveryengine.projects.locations.dataStores.branches.operations.get + post: + description: Upgrade from basic site search to advanced site search. + operationId: >- + discoveryengine.projects.locations.dataStores.siteSearchEngine.enableAdvancedSiteSearch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24187,35 +32824,18 @@ paths: required: true schema: type: string - - in: path - name: branchesId - required: true - schema: - type: string - - in: path - name: operationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine:disableAdvancedSiteSearch: parameters: *ref_1 post: - description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: discoveryengine.projects.locations.dataStores.branches.operations.cancel + description: Downgrade from advanced site search to basic site search. + operationId: >- + discoveryengine.projects.locations.dataStores.siteSearchEngine.disableAdvancedSiteSearch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningCancelOperationRequest' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24227,7 +32847,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -24244,21 +32864,18 @@ paths: required: true schema: type: string - - in: path - name: branchesId - required: true - schema: - type: string - - in: path - name: operationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}: + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine:recrawlUris: parameters: *ref_1 - get: - description: Gets a Document. - operationId: discoveryengine.projects.locations.dataStores.branches.documents.get + post: + description: Request on-demand recrawl for a list of URIs. + operationId: >- + discoveryengine.projects.locations.dataStores.siteSearchEngine.recrawlUris + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1RecrawlUrisRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24270,7 +32887,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -24287,24 +32904,17 @@ paths: required: true schema: type: string - - in: path - name: branchesId - required: true - schema: - type: string - - in: path - name: documentsId - required: true - schema: - type: string - patch: - description: Updates a Document. - operationId: discoveryengine.projects.locations.dataStores.branches.documents.patch + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites: + parameters: *ref_1 + post: + description: Creates a TargetSite. + operationId: >- + discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1TargetSite' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24316,7 +32926,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -24333,28 +32943,10 @@ paths: required: true schema: type: string - - in: path - name: branchesId - required: true - schema: - type: string - - in: path - name: documentsId - required: true - schema: - type: string - - in: query - name: allowMissing - schema: - type: boolean - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: - description: Deletes a Document. - operationId: discoveryengine.projects.locations.dataStores.branches.documents.delete + get: + description: Gets a list of TargetSites. + operationId: >- + discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24366,7 +32958,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ListTargetSitesResponse parameters: - in: path name: projectsId @@ -24383,21 +32976,27 @@ paths: required: true schema: type: string - - in: path - name: branchesId - required: true + - in: query + name: pageSize schema: - type: string - - in: path - name: documentsId - required: true + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents: + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites:batchCreate: parameters: *ref_1 - get: - description: Gets a list of Documents. - operationId: discoveryengine.projects.locations.dataStores.branches.documents.list + post: + description: Creates TargetSite in a batch. + operationId: >- + discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.batchCreate + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1BatchCreateTargetSitesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24409,8 +33008,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ListDocumentsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -24427,28 +33025,12 @@ paths: required: true schema: type: string - - in: path - name: branchesId - required: true - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - post: - description: Creates a Document. - operationId: discoveryengine.projects.locations.dataStores.branches.documents.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites/{targetSitesId}: + parameters: *ref_1 + get: + description: Gets a TargetSite. + operationId: >- + discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24460,7 +33042,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1TargetSite' parameters: - in: path name: projectsId @@ -24478,28 +33060,19 @@ paths: schema: type: string - in: path - name: branchesId + name: targetSitesId required: true schema: type: string - - in: query - name: documentId - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:import: - parameters: *ref_1 - post: - description: >- - Bulk import of multiple Documents. Request processing may be - synchronous. Non-existing items are created. Note: It is possible for a - subset of the Documents to be successfully updated. - operationId: discoveryengine.projects.locations.dataStores.branches.documents.import + patch: + description: Updates a TargetSite. + operationId: >- + discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ImportDocumentsRequest + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1TargetSite' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24529,28 +33102,14 @@ paths: schema: type: string - in: path - name: branchesId + name: targetSitesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:purge: - parameters: *ref_1 - post: - description: >- - Permanently deletes all selected Documents in a branch. This process is - asynchronous. Depending on the number of Documents to be deleted, this - operation can take hours to complete. Before the delete operation - completes, some Documents might still be returned by - DocumentService.GetDocument or DocumentService.ListDocuments. To get a - list of the Documents to be deleted, set PurgeDocumentsRequest.force to - false. - operationId: discoveryengine.projects.locations.dataStores.branches.documents.purge - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1PurgeDocumentsRequest + delete: + description: Deletes a TargetSite. + operationId: >- + discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24580,15 +33139,21 @@ paths: schema: type: string - in: path - name: branchesId + name: targetSitesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/schemas/{schemasId}: + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps: parameters: *ref_1 - get: - description: Gets a Schema. - operationId: discoveryengine.projects.locations.dataStores.schemas.get + post: + description: Creates a Sitemap. + operationId: >- + discoveryengine.projects.locations.dataStores.siteSearchEngine.sitemaps.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Sitemap' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24600,7 +33165,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Schema' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -24617,19 +33182,12 @@ paths: required: true schema: type: string - - in: path - name: schemasId - required: true - schema: - type: string - patch: - description: Updates a Schema. - operationId: discoveryengine.projects.locations.dataStores.schemas.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Schema' + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps/{sitemapsId}: + parameters: *ref_1 + delete: + description: Deletes a Sitemap. + operationId: >- + discoveryengine.projects.locations.dataStores.siteSearchEngine.sitemaps.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24659,17 +33217,16 @@ paths: schema: type: string - in: path - name: schemasId + name: sitemapsId required: true schema: type: string - - in: query - name: allowMissing - schema: - type: boolean - delete: - description: Deletes a Schema. - operationId: discoveryengine.projects.locations.dataStores.schemas.delete + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps:fetch: + parameters: *ref_1 + get: + description: Fetch Sitemaps in a DataStore. + operationId: >- + discoveryengine.projects.locations.dataStores.siteSearchEngine.sitemaps.fetch security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24681,7 +33238,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1FetchSitemapsResponse parameters: - in: path name: projectsId @@ -24698,16 +33256,20 @@ paths: required: true schema: type: string - - in: path - name: schemasId - required: true + - in: query + name: matcher.urisMatcher.uris schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/schemas: + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:write: parameters: *ref_1 - get: - description: Gets a list of Schemas. - operationId: discoveryengine.projects.locations.dataStores.schemas.list + post: + description: Writes a single user event. + operationId: discoveryengine.projects.locations.dataStores.userEvents.write + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1UserEvent' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24719,8 +33281,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ListSchemasResponse + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1UserEvent' parameters: - in: path name: projectsId @@ -24738,22 +33299,18 @@ paths: schema: type: string - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + name: writeAsync schema: - type: string - post: - description: Creates a Schema. - operationId: discoveryengine.projects.locations.dataStores.schemas.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Schema' + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:collect: + parameters: *ref_1 + get: + description: >- + Writes a single user event from the browser. This uses a GET request to + due to browser restriction of POST-ing to a third-party domain. This + method is used only by the Discovery Engine API JavaScript pixel and + Google Tag Manager. Users should not call this method directly. + operationId: discoveryengine.projects.locations.dataStores.userEvents.collect security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24765,7 +33322,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: projectsId @@ -24783,21 +33340,33 @@ paths: schema: type: string - in: query - name: schemaId + name: userEvent schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine:enableAdvancedSiteSearch: + - in: query + name: uri + schema: + type: string + - in: query + name: ets + schema: + type: string + format: int64 + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:purge: parameters: *ref_1 post: - description: Upgrade from basic site search to advanced site search. - operationId: >- - discoveryengine.projects.locations.dataStores.siteSearchEngine.enableAdvancedSiteSearch + description: >- + Deletes permanently all user events specified by the filter provided. + Depending on the number of events specified by the filter, this + operation could take hours or days to complete. To test a filter, use + the list command first. + operationId: discoveryengine.projects.locations.dataStores.userEvents.purge requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchRequest + #/components/schemas/GoogleCloudDiscoveryengineV1PurgeUserEventsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24826,18 +33395,22 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine:disableAdvancedSiteSearch: + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:import: parameters: *ref_1 post: - description: Downgrade from advanced site search to basic site search. - operationId: >- - discoveryengine.projects.locations.dataStores.siteSearchEngine.disableAdvancedSiteSearch + description: >- + Bulk import of user events. Request processing might be synchronous. + Events that already exist are skipped. Use this method for backfilling + historical user events. Operation.response is of type ImportResponse. + Note that it is possible for a subset of the items to be successfully + inserted. Operation.metadata is of type ImportMetadata. + operationId: discoveryengine.projects.locations.dataStores.userEvents.import requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchRequest + #/components/schemas/GoogleCloudDiscoveryengineV1ImportUserEventsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24866,18 +33439,17 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine:recrawlUris: + /v1/projects/{projectsId}/locations/{locationsId}/groundingConfigs/{groundingConfigsId}:check: parameters: *ref_1 post: - description: Request on-demand recrawl for a list of URIs. - operationId: >- - discoveryengine.projects.locations.dataStores.siteSearchEngine.recrawlUris + description: Performs a grounding check. + operationId: discoveryengine.projects.locations.groundingConfigs.check requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1RecrawlUrisRequest + #/components/schemas/GoogleCloudDiscoveryengineV1CheckGroundingRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24889,7 +33461,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1CheckGroundingResponse parameters: - in: path name: projectsId @@ -24902,21 +33475,21 @@ paths: schema: type: string - in: path - name: dataStoresId + name: groundingConfigsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites: + /v1/projects/{projectsId}/locations/{locationsId}/identityMappingStores: parameters: *ref_1 post: - description: Creates a TargetSite. - operationId: >- - discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.create + description: Creates a new Identity Mapping Store. + operationId: discoveryengine.projects.locations.identityMappingStores.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1TargetSite' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1IdentityMappingStore security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24928,7 +33501,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1IdentityMappingStore parameters: - in: path name: projectsId @@ -24940,15 +33514,21 @@ paths: required: true schema: type: string - - in: path - name: dataStoresId - required: true + - in: query + name: cmekConfigName + schema: + type: string + - in: query + name: disableCmek + schema: + type: boolean + - in: query + name: identityMappingStoreId schema: type: string get: - description: Gets a list of TargetSites. - operationId: >- - discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.list + description: Lists all Identity Mapping Stores. + operationId: discoveryengine.projects.locations.identityMappingStores.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24961,7 +33541,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ListTargetSitesResponse + #/components/schemas/GoogleCloudDiscoveryengineV1ListIdentityMappingStoresResponse parameters: - in: path name: projectsId @@ -24973,11 +33553,6 @@ paths: required: true schema: type: string - - in: path - name: dataStoresId - required: true - schema: - type: string - in: query name: pageSize schema: @@ -24987,18 +33562,43 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites:batchCreate: + /v1/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}: parameters: *ref_1 - post: - description: Creates TargetSite in a batch. - operationId: >- - discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.batchCreate - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1BatchCreateTargetSitesRequest + get: + description: Gets the Identity Mapping Store. + operationId: discoveryengine.projects.locations.identityMappingStores.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1IdentityMappingStore + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: identityMappingStoresId + required: true + schema: + type: string + delete: + description: Deletes the Identity Mapping Store. + operationId: discoveryengine.projects.locations.identityMappingStores.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -25023,16 +33623,22 @@ paths: schema: type: string - in: path - name: dataStoresId + name: identityMappingStoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites/{targetSitesId}: + /v1/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}:importIdentityMappings: parameters: *ref_1 - get: - description: Gets a TargetSite. + post: + description: Imports a list of Identity Mapping Entries to an Identity Mapping Store. operationId: >- - discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.get + discoveryengine.projects.locations.identityMappingStores.importIdentityMappings + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ImportIdentityMappingsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -25044,7 +33650,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1TargetSite' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -25057,24 +33663,24 @@ paths: schema: type: string - in: path - name: dataStoresId - required: true - schema: - type: string - - in: path - name: targetSitesId + name: identityMappingStoresId required: true schema: type: string - patch: - description: Updates a TargetSite. + /v1/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}:purgeIdentityMappings: + parameters: *ref_1 + post: + description: >- + Purges specified or all Identity Mapping Entries from an Identity + Mapping Store. operationId: >- - discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.patch + discoveryengine.projects.locations.identityMappingStores.purgeIdentityMappings requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1TargetSite' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -25099,19 +33705,16 @@ paths: schema: type: string - in: path - name: dataStoresId - required: true - schema: - type: string - - in: path - name: targetSitesId + name: identityMappingStoresId required: true schema: type: string - delete: - description: Deletes a TargetSite. + /v1/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}:listIdentityMappings: + parameters: *ref_1 + get: + description: Lists Identity Mappings in an Identity Mapping Store. operationId: >- - discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.delete + discoveryengine.projects.locations.identityMappingStores.listIdentityMappings security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -25123,7 +33726,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ListIdentityMappingsResponse parameters: - in: path name: projectsId @@ -25136,25 +33740,26 @@ paths: schema: type: string - in: path - name: dataStoresId + name: identityMappingStoresId required: true schema: type: string - - in: path - name: targetSitesId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:write: + /v1/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}/operations: parameters: *ref_1 - post: - description: Writes a single user event. - operationId: discoveryengine.projects.locations.dataStores.userEvents.write - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1UserEvent' + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: discoveryengine.projects.locations.identityMappingStores.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -25166,7 +33771,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1UserEvent' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -25179,23 +33784,31 @@ paths: schema: type: string - in: path - name: dataStoresId + name: identityMappingStoresId required: true schema: type: string - in: query - name: writeAsync + name: filter schema: - type: boolean - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:collect: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}/operations/{operationsId}: parameters: *ref_1 get: description: >- - Writes a single user event from the browser. This uses a GET request to - due to browser restriction of POST-ing to a third-party domain. This - method is used only by the Discovery Engine API JavaScript pixel and - Google Tag Manager. Users should not call this method directly. - operationId: discoveryengine.projects.locations.dataStores.userEvents.collect + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: discoveryengine.projects.locations.identityMappingStores.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -25207,7 +33820,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -25220,38 +33833,25 @@ paths: schema: type: string - in: path - name: dataStoresId + name: identityMappingStoresId required: true schema: type: string - - in: query - name: userEvent - schema: - type: string - - in: query - name: uri - schema: - type: string - - in: query - name: ets + - in: path + name: operationsId + required: true schema: type: string - format: int64 - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:purge: + /v1/projects/{projectsId}/locations/{locationsId}/rankingConfigs/{rankingConfigsId}:rank: parameters: *ref_1 post: - description: >- - Deletes permanently all user events specified by the filter provided. - Depending on the number of events specified by the filter, this - operation could take hours or days to complete. To test a filter, use - the list command first. - operationId: discoveryengine.projects.locations.dataStores.userEvents.purge + description: Ranks a list of text records based on the given input query. + operationId: discoveryengine.projects.locations.rankingConfigs.rank requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1PurgeUserEventsRequest + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1RankRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -25263,7 +33863,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1RankResponse' parameters: - in: path name: projectsId @@ -25276,26 +33876,20 @@ paths: schema: type: string - in: path - name: dataStoresId + name: rankingConfigsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:import: + /v1/projects/{projectsId}/locations/{locationsId}/userEvents:write: parameters: *ref_1 post: - description: >- - Bulk import of user events. Request processing might be synchronous. - Events that already exist are skipped. Use this method for backfilling - historical user events. Operation.response is of type ImportResponse. - Note that it is possible for a subset of the items to be successfully - inserted. Operation.metadata is of type ImportMetadata. - operationId: discoveryengine.projects.locations.dataStores.userEvents.import + description: Writes a single user event. + operationId: discoveryengine.projects.locations.userEvents.write requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ImportUserEventsRequest + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1UserEvent' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -25307,7 +33901,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1UserEvent' parameters: - in: path name: projectsId @@ -25319,22 +33913,19 @@ paths: required: true schema: type: string - - in: path - name: dataStoresId - required: true + - in: query + name: writeAsync schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/groundingConfigs/{groundingConfigsId}:check: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/userEvents:collect: parameters: *ref_1 - post: - description: Performs a grounding check. - operationId: discoveryengine.projects.locations.groundingConfigs.check - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1CheckGroundingRequest + get: + description: >- + Writes a single user event from the browser. This uses a GET request to + due to browser restriction of POST-ing to a third-party domain. This + method is used only by the Discovery Engine API JavaScript pixel and + Google Tag Manager. Users should not call this method directly. + operationId: discoveryengine.projects.locations.userEvents.collect security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -25346,8 +33937,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1CheckGroundingResponse + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: projectsId @@ -25359,21 +33949,35 @@ paths: required: true schema: type: string - - in: path - name: groundingConfigsId - required: true + - in: query + name: userEvent schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/rankingConfigs/{rankingConfigsId}:rank: + - in: query + name: uri + schema: + type: string + - in: query + name: ets + schema: + type: string + format: int64 + /v1/projects/{projectsId}/locations/{locationsId}/userEvents:import: parameters: *ref_1 post: - description: Ranks a list of text records based on the given input query. - operationId: discoveryengine.projects.locations.rankingConfigs.rank + description: >- + Bulk import of user events. Request processing might be synchronous. + Events that already exist are skipped. Use this method for backfilling + historical user events. Operation.response is of type ImportResponse. + Note that it is possible for a subset of the items to be successfully + inserted. Operation.metadata is of type ImportMetadata. + operationId: discoveryengine.projects.locations.userEvents.import requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1RankRequest' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ImportUserEventsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -25385,7 +33989,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1RankResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -25397,21 +34001,19 @@ paths: required: true schema: type: string - - in: path - name: rankingConfigsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/userEvents:write: + /v1/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}:batchUpdateUserLicenses: parameters: *ref_1 post: - description: Writes a single user event. - operationId: discoveryengine.projects.locations.userEvents.write + description: >- + Updates the User License. This method is used for batch assign/unassign + licenses to users. + operationId: discoveryengine.projects.locations.userStores.batchUpdateUserLicenses requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1UserEvent' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -25423,7 +34025,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1UserEvent' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -25435,19 +34037,16 @@ paths: required: true schema: type: string - - in: query - name: writeAsync + - in: path + name: userStoresId + required: true schema: - type: boolean - /v1/projects/{projectsId}/locations/{locationsId}/userEvents:collect: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}/userLicenses: parameters: *ref_1 get: - description: >- - Writes a single user event from the browser. This uses a GET request to - due to browser restriction of POST-ing to a third-party domain. This - method is used only by the Discovery Engine API JavaScript pixel and - Google Tag Manager. Users should not call this method directly. - operationId: discoveryengine.projects.locations.userEvents.collect + description: Lists the User Licenses. + operationId: discoveryengine.projects.locations.userStores.userLicenses.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -25459,7 +34058,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ListUserLicensesResponse parameters: - in: path name: projectsId @@ -25471,16 +34071,21 @@ paths: required: true schema: type: string - - in: query - name: userEvent + - in: path + name: userStoresId + required: true schema: type: string - in: query - name: uri + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - in: query - name: ets + name: filter schema: type: string - format: int64 diff --git a/providers/src/googleapis.com/v00.00.00000/services/dlp.yaml b/providers/src/googleapis.com/v00.00.00000/services/dlp.yaml index 6d871498..0395b098 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/dlp.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/dlp.yaml @@ -10,8 +10,8 @@ info: to help you discover, classify, and protect your valuable data assets with ease. version: v2 - x-discovery-doc-revision: '20241027' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250824' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/sensitive-data-protection/docs/ servers: @@ -37,393 +37,304 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GooglePrivacyDlpV2AwsAccountRegex: - description: AWS account regex. - id: GooglePrivacyDlpV2AwsAccountRegex + GooglePrivacyDlpV2InspectContentRequest: + id: GooglePrivacyDlpV2InspectContentRequest + description: Request to search for potentially sensitive info in a ContentItem. type: object properties: - accountIdRegex: - type: string - description: >- - Optional. Regex to test the AWS account ID against. If empty, all - accounts match. - GooglePrivacyDlpV2ContentLocation: - properties: - recordLocation: - $ref: '#/components/schemas/GooglePrivacyDlpV2RecordLocation' - description: Location within a row or record of a database table. - imageLocation: - $ref: '#/components/schemas/GooglePrivacyDlpV2ImageLocation' - description: Location within an image's pixels. - metadataLocation: - $ref: '#/components/schemas/GooglePrivacyDlpV2MetadataLocation' - description: Location within the metadata for inspected content. - documentLocation: - description: Location data for document files. - $ref: '#/components/schemas/GooglePrivacyDlpV2DocumentLocation' - containerVersion: - type: string + inspectConfig: description: >- - Finding container version, if available ("generation" for Cloud - Storage). - containerName: + Configuration for the inspector. What specified here will override + the template referenced by the inspect_template_name argument. + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' + item: + description: The item to inspect. + $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' + inspectTemplateName: description: >- - Name of the container where the finding is located. The top level - name is the source file name or table name. Names of some common - storage containers are formatted as follows: * BigQuery tables: - `{project_id}:{dataset_id}.{table_id}` * Cloud Storage files: - `gs://{bucket}/{path}` * Datastore namespace: {namespace} Nested - names could be absent if the embedded object has no string - identifier (for example, an image contained within a document). + Template to use. Any configuration directly specified in + inspect_config will override those set in the template. Singular + fields that are set in this request will replace their corresponding + fields in the template. Repeated fields are appended. Singular + sub-messages and groups are recursively merged. type: string - containerTimestamp: + locationId: + description: Deprecated. This field has no effect. type: string - description: >- - Finding container modification timestamp, if applicable. For Cloud - Storage, this field contains the last file modification timestamp. - For a BigQuery table, this field contains the last_modified_time - property. For Datastore, this field isn't populated. - format: google-datetime + GooglePrivacyDlpV2InspectConfig: + id: GooglePrivacyDlpV2InspectConfig description: >- - Precise location of the finding within a document, record, image, or - metadata container. - id: GooglePrivacyDlpV2ContentLocation + Configuration description of the scanning process. When used with + redactContent only info_types and min_likelihood are currently used. type: object - GooglePrivacyDlpV2FileStoreDataProfile: properties: - locationType: - type: string + infoTypes: description: >- - The location type of the bucket (region, dual-region, multi-region, - etc). If dual-region, expect data_storage_locations to be populated. - fullResource: + Restricts what info_types to look for. The values must correspond to + InfoType values returned by ListInfoTypes or listed at + https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference. + When no InfoTypes or CustomInfoTypes are specified in a request, the + system may automatically choose a default list of detectors to run, + which may change over time. If you need precise control and + predictability as to what detectors are run you should specify + specific InfoTypes listed in the reference, otherwise a default list + will be used, which may change over time. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + minLikelihood: description: >- - The resource name of the resource profiled. - https://cloud.google.com/apis/design/resource_names#full_resource_name - Example format of an S3 bucket full resource name: - `//cloudasset.googleapis.com/organizations/{org_id}/otherCloudConnections/aws/arn:aws:s3:::{bucket_name}` - type: string - fileStorePath: + Only returns findings equal to or above this threshold. The default + is POSSIBLE. In general, the highest likelihood setting yields the + fewest findings in results and the lowest chance of a false + positive. For more information, see [Match + likelihood](https://cloud.google.com/sensitive-data-protection/docs/likelihood). type: string - description: >- - The file store path. * Cloud Storage: `gs://{bucket}` * Amazon S3: - `s3://{bucket}` - dataSourceType: - $ref: '#/components/schemas/GooglePrivacyDlpV2DataSourceType' - description: The resource type that was profiled. - fileStoreIsEmpty: - description: The file store does not have any files. - type: boolean - state: enumDescriptions: - - Unused. - - >- - The profile is currently running. Once a profile has finished it - will transition to DONE. - - >- - The profile is no longer generating. If profile_status.status.code - is 0, the profile succeeded, otherwise, it failed. + - Default value; same as POSSIBLE. + - Highest chance of a false positive. + - High chance of a false positive. + - Some matching signals. The default value. + - Low chance of a false positive. + - Confidence level is high. Lowest chance of a false positive. enum: - - STATE_UNSPECIFIED - - RUNNING - - DONE - description: State of a profile. - type: string - fileClusterSummaries: - description: FileClusterSummary per each cluster. + - LIKELIHOOD_UNSPECIFIED + - VERY_UNLIKELY + - UNLIKELY + - POSSIBLE + - LIKELY + - VERY_LIKELY + minLikelihoodPerInfoType: + description: >- + Minimum likelihood per infotype. For each infotype, a user can + specify a minimum likelihood. The system only returns a finding if + its likelihood is above this threshold. If this field is not set, + the system uses the InspectConfig min_likelihood. type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FileClusterSummary' - resourceAttributes: - type: object + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeLikelihood' + limits: description: >- - Attributes of the resource being profiled. Currently used - attributes: * customer_managed_encryption: boolean - true: the - resource is encrypted with a customer-managed key. - false: the - resource is encrypted with a provider-managed key. - additionalProperties: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - name: - type: string - description: The name of the profile. - resourceVisibility: - enum: - - RESOURCE_VISIBILITY_UNSPECIFIED - - RESOURCE_VISIBILITY_PUBLIC - - RESOURCE_VISIBILITY_INCONCLUSIVE - - RESOURCE_VISIBILITY_RESTRICTED - description: How broadly a resource has been shared. - enumDescriptions: - - Unused. - - Visible to any user. - - >- - May contain public items. For example, if a Cloud Storage bucket - has uniform bucket level access disabled, some objects inside it - may be public, but none are known yet. - - Visible only to specific users. - type: string - dataRiskLevel: - $ref: '#/components/schemas/GooglePrivacyDlpV2DataRiskLevel' - description: The data risk level of this resource. - fileStoreLocation: + Configuration to control the number of findings returned. This is + not used for data profiling. When redacting sensitive data from + images, finding limits don't apply. They can cause unexpected or + inconsistent results, where only some data is redacted. Don't + include finding limits in RedactImage requests. Otherwise, Cloud DLP + returns an error. When set within an InspectJobConfig, the specified + maximum values aren't hard limits. If an inspection job reaches + these limits, the job ends gradually, not abruptly. Therefore, the + actual number of findings that Cloud DLP returns can be multiple + times higher than these maximum values. + $ref: '#/components/schemas/GooglePrivacyDlpV2FindingLimits' + includeQuote: description: >- - The location of the file store. * Cloud Storage: - https://cloud.google.com/storage/docs/locations#available-locations - * Amazon S3: - https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints - type: string - dataStorageLocations: + When true, a contextual quote from the data that triggered a finding + is included in the response; see Finding.quote. This is not used for + data profiling. + type: boolean + excludeInfoTypes: description: >- - For resources that have multiple storage locations, these are those - regions. For Cloud Storage this is the list of regions chosen for - dual-region storage. `file_store_location` will normally be the - corresponding multi-region for the list of individual locations. The - first region is always picked as the processing and storage location - for the data profile. + When true, excludes type information of the findings. This is not + used for data profiling. + type: boolean + customInfoTypes: + description: >- + CustomInfoTypes provided by the user. See + https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes + to learn more. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2CustomInfoType' + contentOptions: + description: Deprecated and unused. + type: array items: type: string + enumDescriptions: + - Includes entire content of a file or a data stream. + - Text content within the data, excluding any metadata. + - Images found in the data. + enum: + - CONTENT_UNSPECIFIED + - CONTENT_TEXT + - CONTENT_IMAGE + ruleSet: + description: >- + Set of rules to apply to the findings for this InspectConfig. + Exclusion rules, contained in the set are executed in the end, other + rules are executed in the order they are specified for each info + type. type: array - lastModifiedTime: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectionRuleSet' + GooglePrivacyDlpV2InfoType: + id: GooglePrivacyDlpV2InfoType + description: Type of information detected by the API. + type: object + properties: + name: + description: >- + Name of the information type. Either a name of your choosing when + creating a CustomInfoType, or one of the names listed at + https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference + when specifying a built-in type. When sending Cloud DLP results to + Data Catalog, infoType names should conform to the pattern + `[A-Za-z0-9$_-]{1,64}`. type: string - format: google-datetime - description: The time the file store was last modified. - profileLastGenerated: + version: + description: Optional version name for this InfoType. type: string - description: The last time the profile was generated. - format: google-datetime - fileStoreInfoTypeSummaries: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreInfoTypeSummary' - type: array - description: InfoTypes detected in this file store. sensitivityScore: - description: The sensitivity score of this resource. - $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' - resourceLabels: - type: object - description: >- - The labels applied to the resource at the time the profile was - generated. - additionalProperties: - type: string - projectId: - description: >- - The Google Cloud project ID that owns the resource. For Amazon S3 - buckets, this is the AWS Account Id. - type: string - configSnapshot: - description: The snapshot of the configurations used to generate the profile. - $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileConfigSnapshot' - profileStatus: - $ref: '#/components/schemas/GooglePrivacyDlpV2ProfileStatus' description: >- - Success or error status from the most recent profile generation - attempt. May be empty if the profile is still being generated. - projectDataProfile: - type: string - description: The resource name of the project data profile for this file store. - createTime: - description: The time the file store was first created. - type: string - format: google-datetime - id: GooglePrivacyDlpV2FileStoreDataProfile + Optional custom sensitivity for this InfoType. This only applies to + data profiling. + $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' + GooglePrivacyDlpV2SensitivityScore: + id: GooglePrivacyDlpV2SensitivityScore description: >- - The profile for a file store. * Cloud Storage: maps 1:1 with a bucket. * - Amazon S3: maps 1:1 with a bucket. + Score is calculated from of all elements in the data profile. A higher + level means the data is more sensitive. type: object - GooglePrivacyDlpV2ExcludeByHotword: - id: GooglePrivacyDlpV2ExcludeByHotword properties: - proximity: - description: >- - Range of characters within which the entire hotword must reside. The - total length of the window cannot exceed 1000 characters. The - windowBefore property in proximity should be set to 1 if the hotword - needs to be included in a column header. - $ref: '#/components/schemas/GooglePrivacyDlpV2Proximity' - hotwordRegex: - $ref: '#/components/schemas/GooglePrivacyDlpV2Regex' - description: Regular expression pattern defining what qualifies as a hotword. - type: object + score: + description: The sensitivity score applied to the resource. + type: string + enumDescriptions: + - Unused. + - >- + No sensitive information detected. The resource isn't publicly + accessible. + - Unable to determine sensitivity. + - >- + Medium risk. Contains personally identifiable information (PII), + potentially sensitive data, or fields with free-text data that are + at a higher risk of having intermittent sensitive data. Consider + limiting access. + - >- + High risk. Sensitive personally identifiable information (SPII) + can be present. Exfiltration of data can lead to user data loss. + Re-identification of users might be possible. Consider limiting + usage and or removing SPII. + enum: + - SENSITIVITY_SCORE_UNSPECIFIED + - SENSITIVITY_LOW + - SENSITIVITY_UNKNOWN + - SENSITIVITY_MODERATE + - SENSITIVITY_HIGH + GooglePrivacyDlpV2InfoTypeLikelihood: + id: GooglePrivacyDlpV2InfoTypeLikelihood description: >- - The rule to exclude findings based on a hotword. For record inspection - of tables, column names are considered hotwords. An example of this is - to exclude a finding if it belongs to a BigQuery column that matches a - specific pattern. - GooglePrivacyDlpV2Condition: - id: GooglePrivacyDlpV2Condition + Configuration for setting a minimum likelihood per infotype. Used to + customize the minimum likelihood level for specific infotypes in the + request. For example, use this if you want to lower the precision for + PERSON_NAME without lowering the precision for the other infotypes in + the request. type: object - description: >- - The field type of `value` and `field` do not need to match to be - considered equal, but not all comparisons are possible. EQUAL_TO and - NOT_EQUAL_TO attempt to compare even with incompatible types, but all - other comparisons are invalid with incompatible types. A `value` of - type: - `string` can be compared against all other types - `boolean` can - only be compared against other booleans - `integer` can be compared - against doubles or a string if the string value can be parsed as an - integer. - `double` can be compared against integers or a string if the - string can be parsed as a double. - `Timestamp` can be compared against - strings in RFC 3339 date string format. - `TimeOfDay` can be compared - against timestamps and strings in the format of 'HH:mm:ss'. If we fail - to compare do to type mismatch, a warning will be given and the - condition will evaluate to false. properties: - value: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - description: Value to compare against. [Mandatory, except for `EXISTS` tests.] - operator: - enum: - - RELATIONAL_OPERATOR_UNSPECIFIED - - EQUAL_TO - - NOT_EQUAL_TO - - GREATER_THAN - - LESS_THAN - - GREATER_THAN_OR_EQUALS - - LESS_THAN_OR_EQUALS - - EXISTS - type: string - enumDescriptions: - - Unused - - Equal. Attempts to match even with incompatible types. - - Not equal to. Attempts to match even with incompatible types. - - Greater than. - - Less than. - - Greater than or equals. - - Less than or equals. - - Exists + infoType: description: >- - Required. Operator used to compare the field or infoType to the - value. - field: + Type of information the likelihood threshold applies to. Only one + likelihood per info_type should be provided. If InfoTypeLikelihood + does not have an info_type, the configuration fails. + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + minLikelihood: description: >- - Required. Field within the record this condition is evaluated - against. - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - GooglePrivacyDlpV2TimePartConfig: - properties: - partToExtract: + Only returns findings equal to or above this threshold. This field + is required or else the configuration fails. type: string enumDescriptions: - - Unused - - '[0-9999]' - - '[1-12]' - - '[1-31]' - - '[1-7]' - - '[1-53]' - - '[0-23]' - description: The part of the time to keep. + - Default value; same as POSSIBLE. + - Highest chance of a false positive. + - High chance of a false positive. + - Some matching signals. The default value. + - Low chance of a false positive. + - Confidence level is high. Lowest chance of a false positive. enum: - - TIME_PART_UNSPECIFIED - - YEAR - - MONTH - - DAY_OF_MONTH - - DAY_OF_WEEK - - WEEK_OF_YEAR - - HOUR_OF_DAY - type: object - id: GooglePrivacyDlpV2TimePartConfig + - LIKELIHOOD_UNSPECIFIED + - VERY_UNLIKELY + - UNLIKELY + - POSSIBLE + - LIKELY + - VERY_LIKELY + GooglePrivacyDlpV2FindingLimits: + id: GooglePrivacyDlpV2FindingLimits description: >- - For use with `Date`, `Timestamp`, and `TimeOfDay`, extract or preserve a - portion of the value. - GooglePrivacyDlpV2ReplaceWithInfoTypeConfig: - id: GooglePrivacyDlpV2ReplaceWithInfoTypeConfig - type: object - properties: {} - description: Replace each matching finding with the name of the info_type. - GooglePrivacyDlpV2Bucket: + Configuration to control the number of findings returned for inspection. + This is not used for de-identification or data profiling. When redacting + sensitive data from images, finding limits don't apply. They can cause + unexpected or inconsistent results, where only some data is redacted. + Don't include finding limits in RedactImage requests. Otherwise, Cloud + DLP returns an error. type: object - id: GooglePrivacyDlpV2Bucket - description: Bucket is represented as a range, along with replacement values. properties: - replacementValue: - description: Required. Replacement value for this bucket. - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - max: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - description: Upper bound of the range, exclusive; type must match min. - min: + maxFindingsPerItem: description: >- - Lower bound of the range, inclusive. Type should be the same as max - if used. - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - GooglePrivacyDlpV2DetectionRule: + Max number of findings that are returned for each item scanned. When + set within an InspectContentRequest, this field is ignored. This + value isn't a hard limit. If the number of findings for an item + reaches this limit, the inspection of that item ends gradually, not + abruptly. Therefore, the actual number of findings that Cloud DLP + returns for the item can be multiple times higher than this value. + type: integer + format: int32 + maxFindingsPerRequest: + description: >- + Max number of findings that are returned per request or job. If you + set this field in an InspectContentRequest, the resulting maximum + value is the value that you set or 3,000, whichever is lower. This + value isn't a hard limit. If an inspection reaches this limit, the + inspection ends gradually, not abruptly. Therefore, the actual + number of findings that Cloud DLP returns can be multiple times + higher than this value. + type: integer + format: int32 + maxFindingsPerInfoType: + description: Configuration of findings limit given for specified infoTypes. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeLimit' + GooglePrivacyDlpV2InfoTypeLimit: + id: GooglePrivacyDlpV2InfoTypeLimit description: >- - Deprecated; use `InspectionRuleSet` instead. Rule for modifying a - `CustomInfoType` to alter behavior under certain circumstances, - depending on the specific details of the rule. Not supported for the - `surrogate_type` custom infoType. + Max findings configuration per infoType, per content item or long + running DlpJob. type: object - id: GooglePrivacyDlpV2DetectionRule properties: - hotwordRule: - description: Hotword-based detection rule. - $ref: '#/components/schemas/GooglePrivacyDlpV2HotwordRule' - GooglePrivacyDlpV2Finding: - id: GooglePrivacyDlpV2Finding - description: Represents a piece of potentially sensitive content. + infoType: + description: >- + Type of information the findings limit applies to. Only one limit + per info_type should be provided. If InfoTypeLimit does not have an + info_type, the DLP API applies the limit against all info_types that + are found but not specified in another InfoTypeLimit. + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + maxFindings: + description: Max findings limit for the given infoType. + type: integer + format: int32 + GooglePrivacyDlpV2CustomInfoType: + id: GooglePrivacyDlpV2CustomInfoType + description: >- + Custom information type provided by the user. Used to find + domain-specific sensitive information configurable to the data in + question. type: object properties: - jobCreateTime: - type: string - description: Time the job started that produced this finding. - format: google-datetime - location: - description: Where the content was found. - $ref: '#/components/schemas/GooglePrivacyDlpV2Location' - triggerName: - type: string - description: Job trigger name, if applicable, for this finding. - labels: - type: object - description: >- - The labels associated with this `Finding`. Label keys must be - between 1 and 63 characters long and must conform to the following - regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. Label values must - be between 0 and 63 characters long and must conform to the regular - expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. No more than 10 labels - can be associated with a given finding. Examples: * `"environment" : - "production"` * `"pipeline" : "etl"` - additionalProperties: - type: string - quote: - description: >- - The content that was found. Even if the content is not textual, it - may be converted to a textual representation here. Provided if - `include_quote` is true and the finding is less than or equal to - 4096 bytes long. If the finding exceeds 4096 bytes in length, the - quote may be omitted. - type: string - resourceName: - type: string - description: The job that stored the finding. - createTime: - type: string - format: google-datetime - description: Timestamp when finding was detected. - findingId: - type: string - description: The unique finding id. - jobName: - type: string - description: The job that stored the finding. - name: - type: string - description: >- - Resource name in format - projects/{project}/locations/{location}/findings/{finding} Populated - only when viewing persisted findings. - quoteInfo: - $ref: '#/components/schemas/GooglePrivacyDlpV2QuoteInfo' - description: >- - Contains data parsed from quotes. Only populated if include_quote - was set to true and a supported infoType was requested. Currently - supported infoTypes: DATE, DATE_OF_BIRTH and TIME. infoType: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' description: >- - The type of content that might have been found. Provided if - `excluded_types` is false. + CustomInfoType can either be a new infoType, or an extension of + built-in infoType, when the name matches one of existing infoTypes + and that infoType is specified in `InspectContent.info_types` field. + Specifying the latter adds findings to the one detected by the + system. If built-in info type is not specified in + `InspectContent.info_types` list then the name is treated as a + custom info type. + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' likelihood: + description: >- + Likelihood to return for this CustomInfoType. This base value can be + altered by a detection rule if the finding meets the criteria + specified by the rule. Defaults to `VERY_LIKELY` if not specified. + type: string enumDescriptions: - Default value; same as POSSIBLE. - Highest chance of a false positive. @@ -431,7 +342,6 @@ components: - Some matching signals. The default value. - Low chance of a false positive. - Confidence level is high. Lowest chance of a false positive. - description: Confidence of how likely it is that the `info_type` is correct. enum: - LIKELIHOOD_UNSPECIFIED - VERY_UNLIKELY @@ -439,250 +349,244 @@ components: - POSSIBLE - LIKELY - VERY_LIKELY - type: string - GooglePrivacyDlpV2ListDlpJobsResponse: - properties: - jobs: + dictionary: + description: A list of phrases to detect as a CustomInfoType. + $ref: '#/components/schemas/GooglePrivacyDlpV2Dictionary' + regex: + description: Regular expression based CustomInfoType. + $ref: '#/components/schemas/GooglePrivacyDlpV2Regex' + surrogateType: + description: >- + Message for detecting output from deidentification transformations + that support reversing. + $ref: '#/components/schemas/GooglePrivacyDlpV2SurrogateType' + storedType: + description: >- + Load an existing `StoredInfoType` resource for use in + `InspectDataSource`. Not currently supported in `InspectContent`. + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredType' + detectionRules: + description: >- + Set of detection rules to apply to all findings of this + CustomInfoType. Rules are applied in order that they are specified. + Not supported for the `surrogate_type` CustomInfoType. type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' - description: A list of DlpJobs that matches the specified filter in the request. - nextPageToken: + $ref: '#/components/schemas/GooglePrivacyDlpV2DetectionRule' + exclusionType: + description: >- + If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a + finding to be returned. It still can be used for rules matching. type: string - description: The standard List next-page token. - description: The response message for listing DLP jobs. - id: GooglePrivacyDlpV2ListDlpJobsResponse - type: object - GoogleRpcStatus: + enumDescriptions: + - >- + A finding of this custom info type will not be excluded from + results. + - >- + A finding of this custom info type will be excluded from final + results, but can still affect rule execution. + enum: + - EXCLUSION_TYPE_UNSPECIFIED + - EXCLUSION_TYPE_EXCLUDE + sensitivityScore: + description: >- + Sensitivity for this CustomInfoType. If this CustomInfoType extends + an existing InfoType, the sensitivity here will take precedence over + that of the original InfoType. If unset for a CustomInfoType, it + will default to HIGH. This only applies to data profiling. + $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' + GooglePrivacyDlpV2Dictionary: + id: GooglePrivacyDlpV2Dictionary description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). + Custom information type based on a dictionary of words or phrases. This + can be used to match sensitive information specific to the data, such as + a list of employee IDs or job titles. Dictionary words are + case-insensitive and all characters other than letters and digits in the + unicode [Basic Multilingual + Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) + will be replaced with whitespace when scanning for matches, so the + dictionary phrase "Sam Johnson" will match all three phrases "sam + johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the + characters surrounding any match must be of a different type than the + adjacent characters within the word, so letters must be next to + non-letters and digits next to non-digits. For example, the dictionary + word "jen" will match the first three letters of the text "jen123" but + will return no matches for "jennifer". Dictionary words containing a + large number of characters that are not letters or digits may result in + unexpected findings because such characters are treated as whitespace. + The [limits](https://cloud.google.com/sensitive-data-protection/limits) + page contains details about the size limits of dictionaries. For + dictionaries that do not fit within these constraints, consider using + `LargeCustomDictionaryConfig` in the `StoredInfoType` API. type: object - id: GoogleRpcStatus properties: - details: - items: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any + wordList: + description: List of words or phrases to search for. + $ref: '#/components/schemas/GooglePrivacyDlpV2WordList' + cloudStoragePath: description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. + Newline-delimited file of words in Cloud Storage. Only a single file + is accepted. + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStoragePath' + GooglePrivacyDlpV2WordList: + id: GooglePrivacyDlpV2WordList + description: Message defining a list of words or phrases to search for in the data. + type: object + properties: + words: + description: >- + Words or phrases defining the dictionary. The dictionary must + contain at least one phrase and every phrase must contain at least 2 + characters that are letters or digits. [required] type: array - message: - type: string + items: + type: string + GooglePrivacyDlpV2CloudStoragePath: + id: GooglePrivacyDlpV2CloudStoragePath + description: Message representing a single file or path in Cloud Storage. + type: object + properties: + path: description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - code: - format: int32 - description: The status code, which should be an enum value of google.rpc.Code. - type: integer - GooglePrivacyDlpV2Container: + A URL representing a file or path (no wildcards) in Cloud Storage. + Example: `gs://[BUCKET_NAME]/dictionary.txt` + type: string + GooglePrivacyDlpV2Regex: + id: GooglePrivacyDlpV2Regex + description: Message defining a custom regular expression. type: object - id: GooglePrivacyDlpV2Container - description: >- - Represents a container that may contain DLP findings. Examples of a - container include a file, table, or database record. properties: - projectId: + pattern: description: >- - Project where the finding was found. Can be different from the - project that owns the finding. + Pattern defining the regular expression. Its syntax + (https://github.com/google/re2/wiki/Syntax) can be found under the + google/re2 repository on GitHub. type: string - updateTime: + groupIndexes: description: >- - Findings container modification timestamp, if applicable. For Cloud - Storage, this field contains the last file modification timestamp. - For a BigQuery table, this field contains the last_modified_time - property. For Datastore, this field isn't populated. - format: google-datetime + The index of the submatch to extract as findings. When not + specified, the entire match is returned. No more than 3 may be + included. + type: array + items: + type: integer + format: int32 + GooglePrivacyDlpV2SurrogateType: + id: GooglePrivacyDlpV2SurrogateType + description: >- + Message for detecting output from deidentification transformations such + as + [`CryptoReplaceFfxFpeConfig`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig). + These types of transformations are those that perform pseudonymization, + thereby producing a "surrogate" as output. This should be used in + conjunction with a field on the transformation such as + `surrogate_info_type`. This CustomInfoType does not support the use of + `detection_rules`. + type: object + properties: {} + GooglePrivacyDlpV2StoredType: + id: GooglePrivacyDlpV2StoredType + description: A reference to a StoredInfoType to use with scanning. + type: object + properties: + name: + description: >- + Resource name of the requested `StoredInfoType`, for example + `organizations/433245324/storedInfoTypes/432452342` or + `projects/project-id/storedInfoTypes/432452342`. type: string - version: + createTime: description: >- - Findings container version, if available ("generation" for Cloud - Storage). - type: string - type: - type: string - description: Container type, for example BigQuery or Cloud Storage. - relativePath: - description: >- - The rest of the path after the root. Examples: - For BigQuery table - `project_id:dataset_id.table_id`, the relative path is `table_id` - - For Cloud Storage file `gs://bucket/folder/filename.txt`, the - relative path is `folder/filename.txt` - type: string - fullPath: - description: >- - A string representation of the full container name. Examples: - - BigQuery: 'Project:DataSetId.TableId' - Cloud Storage: - 'gs://Bucket/folders/filename.txt' - type: string - rootPath: - type: string - description: >- - The root of the container. Examples: - For BigQuery table - `project_id:dataset_id.table_id`, the root is `dataset_id` - For - Cloud Storage file `gs://bucket/folder/filename.txt`, the root is - `gs://bucket` - GooglePrivacyDlpV2QuoteInfo: - description: Message for infoType-dependent details parsed from quote. - properties: - dateTime: - $ref: '#/components/schemas/GooglePrivacyDlpV2DateTime' - description: The date time indicated by the quote. - type: object - id: GooglePrivacyDlpV2QuoteInfo - GooglePrivacyDlpV2ImageLocation: - description: Location of the finding within an image. - properties: - boundingBoxes: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2BoundingBox' - description: >- - Bounding boxes locating the pixels within the image containing the - finding. - type: array - id: GooglePrivacyDlpV2ImageLocation - type: object - GooglePrivacyDlpV2Regex: - id: GooglePrivacyDlpV2Regex - description: Message defining a custom regular expression. - properties: - groupIndexes: - items: - type: integer - format: int32 - description: >- - The index of the submatch to extract as findings. When not - specified, the entire match is returned. No more than 3 may be - included. - type: array - pattern: + Timestamp indicating when the version of the `StoredInfoType` used + for inspection was created. Output-only field, populated by the + system. type: string - description: >- - Pattern defining the regular expression. Its syntax - (https://github.com/google/re2/wiki/Syntax) can be found under the - google/re2 repository on GitHub. - type: object - GooglePrivacyDlpV2Table: - properties: - headers: - type: array - description: Headers of the table. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - rows: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Row' - type: array - description: Rows of the table. - id: GooglePrivacyDlpV2Table - description: >- - Structured content to inspect. Up to 50,000 `Value`s per request - allowed. See - https://cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table - to learn more. - type: object - GooglePrivacyDlpV2JobNotificationEmails: + format: google-datetime + GooglePrivacyDlpV2DetectionRule: + id: GooglePrivacyDlpV2DetectionRule description: >- - Sends an email when the job completes. The email goes to IAM project - owners and technical [Essential - Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). - id: GooglePrivacyDlpV2JobNotificationEmails - type: object - properties: {} - GooglePrivacyDlpV2ImageTransformations: - description: A type of transformation that is applied over images. - properties: - transforms: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2ImageTransformation' - type: array - description: List of transforms to make. - id: GooglePrivacyDlpV2ImageTransformations + Deprecated; use `InspectionRuleSet` instead. Rule for modifying a + `CustomInfoType` to alter behavior under certain circumstances, + depending on the specific details of the rule. Not supported for the + `surrogate_type` custom infoType. type: object - GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest: - description: Request message for UpdateDeidentifyTemplate. properties: - updateMask: - format: google-fieldmask - description: Mask to control which fields get updated. - type: string - deidentifyTemplate: - description: New DeidentifyTemplate value. - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' - type: object - id: GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest - GooglePrivacyDlpV2DataProfileAction: - id: GooglePrivacyDlpV2DataProfileAction - description: A task to execute when a data profile has been generated. + hotwordRule: + description: Hotword-based detection rule. + $ref: '#/components/schemas/GooglePrivacyDlpV2HotwordRule' + GooglePrivacyDlpV2HotwordRule: + id: GooglePrivacyDlpV2HotwordRule + description: >- + The rule that adjusts the likelihood of findings within a certain + proximity of hotwords. type: object properties: - pubSubNotification: - $ref: '#/components/schemas/GooglePrivacyDlpV2PubSubNotification' - description: Publish a message into the Pub/Sub topic. - publishToChronicle: + hotwordRegex: + description: Regular expression pattern defining what qualifies as a hotword. + $ref: '#/components/schemas/GooglePrivacyDlpV2Regex' + proximity: description: >- - Publishes generated data profiles to Google Security Operations. For - more information, see [Use Sensitive Data Protection data in - context-aware - analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). - $ref: '#/components/schemas/GooglePrivacyDlpV2PublishToChronicle' - exportData: - $ref: '#/components/schemas/GooglePrivacyDlpV2Export' - description: Export data profiles into a provided location. - publishToScc: - description: Publishes findings to Security Command Center for each data profile. - $ref: >- - #/components/schemas/GooglePrivacyDlpV2PublishToSecurityCommandCenter - tagResources: - description: Tags the profiled resources with the specified tag values. - $ref: '#/components/schemas/GooglePrivacyDlpV2TagResources' - GooglePrivacyDlpV2SaveFindings: + Range of characters within which the entire hotword must reside. The + total length of the window cannot exceed 1000 characters. The + finding itself will be included in the window, so that hotwords can + be used to match substrings of the finding itself. Suppose you want + Cloud DLP to promote the likelihood of the phone number regex + "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area + code of a company's office. In this case, use the hotword regex + "\(xxx\)", where "xxx" is the area code in question. For tabular + data, if you want to modify the likelihood of an entire column of + findngs, see [Hotword example: Set the match likelihood of a table + column] + (https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + $ref: '#/components/schemas/GooglePrivacyDlpV2Proximity' + likelihoodAdjustment: + description: Likelihood adjustment to apply to all matching findings. + $ref: '#/components/schemas/GooglePrivacyDlpV2LikelihoodAdjustment' + GooglePrivacyDlpV2Proximity: + id: GooglePrivacyDlpV2Proximity description: >- - If set, the detailed findings will be persisted to the specified - OutputStorageConfig. Only a single instance of this action can be - specified. Compatible with: Inspect, Risk - type: object - properties: - outputConfig: - description: Location to store findings outside of DLP. - $ref: '#/components/schemas/GooglePrivacyDlpV2OutputStorageConfig' - id: GooglePrivacyDlpV2SaveFindings - GooglePrivacyDlpV2RecordTransformations: + Message for specifying a window around a finding to apply a detection + rule. type: object - description: >- - A type of transformation that is applied over structured data such as a - table. - id: GooglePrivacyDlpV2RecordTransformations properties: - fieldTransformations: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldTransformation' - description: Transform the record by applying various field transformations. - type: array - recordSuppressions: + windowBefore: description: >- - Configuration defining which records get suppressed entirely. - Records that match any suppression rule are omitted from the output. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2RecordSuppression' - type: array + Number of characters before the finding to consider. For tabular + data, if you want to modify the likelihood of an entire column of + findngs, set this to 1. For more information, see [Hotword example: + Set the match likelihood of a table column] + (https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + type: integer + format: int32 + windowAfter: + description: Number of characters after the finding to consider. + type: integer + format: int32 GooglePrivacyDlpV2LikelihoodAdjustment: + id: GooglePrivacyDlpV2LikelihoodAdjustment + description: >- + Message for specifying an adjustment to the likelihood of a finding as + part of a detection rule. type: object properties: + fixedLikelihood: + description: Set the likelihood of a finding to a fixed value. + type: string + enumDescriptions: + - Default value; same as POSSIBLE. + - Highest chance of a false positive. + - High chance of a false positive. + - Some matching signals. The default value. + - Low chance of a false positive. + - Confidence level is high. Lowest chance of a false positive. + enum: + - LIKELIHOOD_UNSPECIFIED + - VERY_UNLIKELY + - UNLIKELY + - POSSIBLE + - LIKELY + - VERY_LIKELY relativeLikelihood: - type: integer - format: int32 description: >- Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the @@ -692,751 +596,700 @@ components: `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. - fixedLikelihood: - type: string - description: Set the likelihood of a finding to a fixed value. - enum: - - LIKELIHOOD_UNSPECIFIED - - VERY_UNLIKELY - - UNLIKELY - - POSSIBLE - - LIKELY - - VERY_LIKELY - enumDescriptions: - - Default value; same as POSSIBLE. - - Highest chance of a false positive. - - High chance of a false positive. - - Some matching signals. The default value. - - Low chance of a false positive. - - Confidence level is high. Lowest chance of a false positive. - id: GooglePrivacyDlpV2LikelihoodAdjustment - description: >- - Message for specifying an adjustment to the likelihood of a finding as - part of a detection rule. - GoogleTypeTimeOfDay: - id: GoogleTypeTimeOfDay - type: object - properties: - minutes: - format: int32 - type: integer - description: >- - Minutes of an hour. Must be greater than or equal to 0 and less than - or equal to 59. - hours: - type: integer - format: int32 - description: >- - Hours of a day in 24 hour format. Must be greater than or equal to 0 - and typically must be less than or equal to 23. An API may choose to - allow the value "24:00:00" for scenarios like business closing time. - nanos: type: integer format: int32 - description: >- - Fractions of seconds, in nanoseconds. Must be greater than or equal - to 0 and less than or equal to 999,999,999. - seconds: - format: int32 - description: >- - Seconds of a minute. Must be greater than or equal to 0 and - typically must be less than or equal to 59. An API may allow the - value 60 if it allows leap-seconds. - type: integer + GooglePrivacyDlpV2InspectionRuleSet: + id: GooglePrivacyDlpV2InspectionRuleSet description: >- - Represents a time of day. The date and time zone are either not - significant or are specified elsewhere. An API may choose to allow leap - seconds. Related types are google.type.Date and - `google.protobuf.Timestamp`. - GooglePrivacyDlpV2CloudStorageResourceReference: + Rule set for modifying a set of infoTypes to alter behavior under + certain circumstances, depending on the specific details of the rules + within the set. type: object - description: Identifies a single Cloud Storage bucket. properties: - bucketName: - description: Required. The bucket to scan. - type: string - projectId: - type: string + infoTypes: + description: List of infoTypes this rule set is applied to. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + rules: description: >- - Required. If within a project-level config, then this must match the - config's project id. - id: GooglePrivacyDlpV2CloudStorageResourceReference - GooglePrivacyDlpV2CloudStorageFileSet: + Set of rules to be applied to infoTypes. The rules are applied in + order. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectionRule' + GooglePrivacyDlpV2InspectionRule: + id: GooglePrivacyDlpV2InspectionRule + description: >- + A single inspection rule to be applied to infoTypes, specified in + `InspectionRuleSet`. + type: object properties: - url: + hotwordRule: + description: Hotword-based detection rule. + $ref: '#/components/schemas/GooglePrivacyDlpV2HotwordRule' + exclusionRule: + description: Exclusion rule. + $ref: '#/components/schemas/GooglePrivacyDlpV2ExclusionRule' + GooglePrivacyDlpV2ExclusionRule: + id: GooglePrivacyDlpV2ExclusionRule + description: >- + The rule that specifies conditions when findings of infoTypes specified + in `InspectionRuleSet` are removed from results. + type: object + properties: + dictionary: + description: Dictionary which defines the rule. + $ref: '#/components/schemas/GooglePrivacyDlpV2Dictionary' + regex: + description: Regular expression which defines the rule. + $ref: '#/components/schemas/GooglePrivacyDlpV2Regex' + excludeInfoTypes: + description: Set of infoTypes for which findings would affect this rule. + $ref: '#/components/schemas/GooglePrivacyDlpV2ExcludeInfoTypes' + excludeByHotword: description: >- - The url, in the format `gs:///`. Trailing wildcard in the path is - allowed. + Drop if the hotword rule is contained in the proximate context. For + tabular data, the context includes the column name. + $ref: '#/components/schemas/GooglePrivacyDlpV2ExcludeByHotword' + matchingType: + description: How the rule is applied, see MatchingType documentation for details. type: string - id: GooglePrivacyDlpV2CloudStorageFileSet - description: Message representing a set of files in Cloud Storage. + enumDescriptions: + - Invalid. + - >- + Full match. - Dictionary: join of Dictionary results matched + complete finding quote - Regex: all regex matches fill a finding + quote start to end - Exclude info type: completely inside + affecting info types findings + - >- + Partial match. - Dictionary: at least one of the tokens in the + finding matches - Regex: substring of the finding matches - + Exclude info type: intersects with affecting info types findings + - >- + Inverse match. - Dictionary: no tokens in the finding match the + dictionary - Regex: finding doesn't match the regex - Exclude info + type: no intersection with affecting info types findings + enum: + - MATCHING_TYPE_UNSPECIFIED + - MATCHING_TYPE_FULL_MATCH + - MATCHING_TYPE_PARTIAL_MATCH + - MATCHING_TYPE_INVERSE_MATCH + GooglePrivacyDlpV2ExcludeInfoTypes: + id: GooglePrivacyDlpV2ExcludeInfoTypes + description: List of excluded infoTypes. type: object - GooglePrivacyDlpV2InfoTypeSummary: - id: GooglePrivacyDlpV2InfoTypeSummary properties: - estimatedPrevalence: - type: integer - description: Not populated for predicted infotypes. - deprecated: true - format: int32 - infoType: - description: The infoType. - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + infoTypes: + description: >- + InfoType list in ExclusionRule rule drops a finding when it overlaps + or contained within with a finding of an infoType from this list. + For example, for `InspectionRuleSet.info_types` containing + "PHONE_NUMBER"` and `exclusion_rule` containing + `exclude_info_types.info_types` with "EMAIL_ADDRESS" the phone + number findings are dropped if they overlap with EMAIL_ADDRESS + finding. That leads to "555-222-2222@example.org" to generate only a + single finding, namely email address. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + GooglePrivacyDlpV2ExcludeByHotword: + id: GooglePrivacyDlpV2ExcludeByHotword + description: >- + The rule to exclude findings based on a hotword. For record inspection + of tables, column names are considered hotwords. An example of this is + to exclude a finding if it belongs to a BigQuery column that matches a + specific pattern. type: object - description: The infoType details for this column. - GooglePrivacyDlpV2BigQueryTableCollection: - description: Specifies a collection of BigQuery tables. Used for Discovery. properties: - includeRegexes: - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryRegexes' + hotwordRegex: + description: Regular expression pattern defining what qualifies as a hotword. + $ref: '#/components/schemas/GooglePrivacyDlpV2Regex' + proximity: description: >- - A collection of regular expressions to match a BigQuery table - against. + Range of characters within which the entire hotword must reside. The + total length of the window cannot exceed 1000 characters. The + windowBefore property in proximity should be set to 1 if the hotword + needs to be included in a column header. + $ref: '#/components/schemas/GooglePrivacyDlpV2Proximity' + GooglePrivacyDlpV2ContentItem: + id: GooglePrivacyDlpV2ContentItem + description: Type of content to inspect. type: object - id: GooglePrivacyDlpV2BigQueryTableCollection - GooglePrivacyDlpV2BoundingBox: properties: - top: - type: integer - description: Top coordinate of the bounding box. (0,0) is upper left. - format: int32 - height: - type: integer - format: int32 - description: Height of the bounding box in pixels. - width: - type: integer - description: Width of the bounding box in pixels. - format: int32 - left: - format: int32 - type: integer - description: Left coordinate of the bounding box. (0,0) is upper left. - description: Bounding box encompassing detected text within an image. - id: GooglePrivacyDlpV2BoundingBox + value: + description: String data to inspect or redact. + type: string + table: + description: >- + Structured content for inspection. See + https://cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table + to learn more. + $ref: '#/components/schemas/GooglePrivacyDlpV2Table' + byteItem: + description: Content data to inspect or redact. Replaces `type` and `data`. + $ref: '#/components/schemas/GooglePrivacyDlpV2ByteContentItem' + GooglePrivacyDlpV2Table: + id: GooglePrivacyDlpV2Table + description: >- + Structured content to inspect. Up to 50,000 `Value`s per request + allowed. See + https://cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table + to learn more. type: object - GooglePrivacyDlpV2PubSubExpressions: properties: - logicalOperator: - type: string - enum: - - LOGICAL_OPERATOR_UNSPECIFIED - - OR - - AND - description: The operator to apply to the collection of conditions. - enumDescriptions: - - Unused. - - Conditional OR. - - Conditional AND. - conditions: + headers: + description: Headers of the table. type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2PubSubCondition' - description: Conditions to apply to the expression. - description: An expression, consisting of an operator and conditions. - id: GooglePrivacyDlpV2PubSubExpressions - type: object - GooglePrivacyDlpV2DatabaseResourceRegexes: - id: GooglePrivacyDlpV2DatabaseResourceRegexes - type: object - description: >- - A collection of regular expressions to determine what database resources - to match against. - properties: - patterns: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + rows: + description: Rows of the table. type: array - description: >- - A group of regular expression patterns to match against one or more - database resources. Maximum of 100 entries. The sum of all regular - expression's length can't exceed 10 KiB. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2DatabaseResourceRegex' - GooglePrivacyDlpV2KmsWrappedCryptoKey: + $ref: '#/components/schemas/GooglePrivacyDlpV2Row' + GooglePrivacyDlpV2FieldId: + id: GooglePrivacyDlpV2FieldId + description: General identifier of a data field in a storage service. + type: object properties: - cryptoKeyName: + name: + description: Name describing the field. type: string - description: >- - Required. The resource name of the KMS CryptoKey to use for - unwrapping. - wrappedKey: - type: string - format: byte - description: Required. The wrapped data crypto key. - description: >- - Include to use an existing data crypto key wrapped by KMS. The wrapped - key must be a 128-, 192-, or 256-bit key. Authorization requires the - following IAM permissions when sending a request to perform a crypto - transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more - information, see [Creating a wrapped key] - (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). - Note: When you use Cloud KMS for cryptographic operations, [charges - apply](https://cloud.google.com/kms/pricing). - type: object - id: GooglePrivacyDlpV2KmsWrappedCryptoKey - GooglePrivacyDlpV2OtherCloudDiscoveryStartingLocation: - type: object - id: GooglePrivacyDlpV2OtherCloudDiscoveryStartingLocation - properties: - awsLocation: - $ref: '#/components/schemas/GooglePrivacyDlpV2AwsDiscoveryStartingLocation' - description: The AWS starting location for discovery. - description: The other cloud starting location for discovery. - GooglePrivacyDlpV2Disabled: - type: object - id: GooglePrivacyDlpV2Disabled - properties: {} - description: Do not profile the tables. GooglePrivacyDlpV2Row: - type: object id: GooglePrivacyDlpV2Row description: Values of the row. + type: object properties: values: description: Individual cells. + type: array items: $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - type: array - GooglePrivacyDlpV2ListTableDataProfilesResponse: - description: List of profiles generated for a given organization or project. + GooglePrivacyDlpV2Value: + id: GooglePrivacyDlpV2Value + description: >- + Set of primitive values supported by the system. Note that for the + purposes of inspection or transformation, the number of bytes considered + to comprise a 'Value' is based on its representation as a UTF-8 encoded + string. For example, if 'integer_value' is set to 123456789, the number + of bytes would be counted as 9, even though an int64 only holds up to 8 + bytes of data. type: object properties: - nextPageToken: + integerValue: + description: integer type: string - description: The next page token. - tableDataProfiles: - description: List of data profiles. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2TableDataProfile' - type: array - id: GooglePrivacyDlpV2ListTableDataProfilesResponse - GooglePrivacyDlpV2RedactImageRequest: - type: object - properties: - inspectConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' - description: Configuration for the inspector. - includeFindings: - description: >- - Whether the response should include findings along with the redacted - image. + format: int64 + floatValue: + description: float + type: number + format: double + stringValue: + description: string + type: string + booleanValue: + description: boolean type: boolean - imageRedactionConfigs: - type: array - description: The configuration for specifying what content to redact from images. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2ImageRedactionConfig' - byteItem: - description: The content must be PNG, JPEG, SVG or BMP. - $ref: '#/components/schemas/GooglePrivacyDlpV2ByteContentItem' - locationId: - description: Deprecated. This field has no effect. + timestampValue: + description: timestamp + type: string + format: google-datetime + timeValue: + description: time of day + $ref: '#/components/schemas/GoogleTypeTimeOfDay' + dateValue: + description: date + $ref: '#/components/schemas/GoogleTypeDate' + dayOfWeekValue: + description: day of week type: string + enumDescriptions: + - The day of the week is unspecified. + - Monday + - Tuesday + - Wednesday + - Thursday + - Friday + - Saturday + - Sunday + enum: + - DAY_OF_WEEK_UNSPECIFIED + - MONDAY + - TUESDAY + - WEDNESDAY + - THURSDAY + - FRIDAY + - SATURDAY + - SUNDAY + GoogleTypeTimeOfDay: + id: GoogleTypeTimeOfDay description: >- - Request to search for potentially sensitive info in an image and redact - it by covering it with a colored rectangle. - id: GooglePrivacyDlpV2RedactImageRequest - GooglePrivacyDlpV2OtherCloudResourceCollection: - description: Match resources using regex filters. - type: object - id: GooglePrivacyDlpV2OtherCloudResourceCollection - properties: - includeRegexes: - $ref: '#/components/schemas/GooglePrivacyDlpV2OtherCloudResourceRegexes' - description: A collection of regular expressions to match a resource against. - GooglePrivacyDlpV2InfoTypeDescription: + Represents a time of day. The date and time zone are either not + significant or are specified elsewhere. An API may choose to allow leap + seconds. Related types are google.type.Date and + `google.protobuf.Timestamp`. type: object - description: InfoType description. - id: GooglePrivacyDlpV2InfoTypeDescription properties: - name: - description: Internal name of the infoType. - type: string - versions: - description: A list of available versions for the infotype. - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2VersionDescription' - description: - type: string + hours: description: >- - Description of the infotype. Translated when language is provided in - the request. - categories: - type: array - description: The category of the infoType. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeCategory' - supportedBy: - description: Which parts of the API supports this InfoType. - items: - enum: - - ENUM_TYPE_UNSPECIFIED - - INSPECT - - RISK_ANALYSIS - enumDescriptions: - - Unused. - - Supported by the inspect operations. - - Supported by the risk analysis operations. - type: string - type: array - sensitivityScore: - $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' - description: The default sensitivity of the infoType. - displayName: - type: string - description: Human readable form of the infoType name. - GooglePrivacyDlpV2FieldTransformation: - properties: - infoTypeTransformations: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeTransformations' + Hours of a day in 24 hour format. Must be greater than or equal to 0 + and typically must be less than or equal to 23. An API may choose to + allow the value "24:00:00" for scenarios like business closing time. + type: integer + format: int32 + minutes: description: >- - Treat the contents of the field as free text, and selectively - transform content that matches an `InfoType`. - fields: - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + Minutes of an hour. Must be greater than or equal to 0 and less than + or equal to 59. + type: integer + format: int32 + seconds: description: >- - Required. Input field(s) to apply the transformation to. When you - have columns that reference their position within a list, omit the - index from the FieldId. FieldId name matching ignores the index. For - example, instead of "contact.nums[0].type", use "contact.nums.type". - primitiveTransformation: - $ref: '#/components/schemas/GooglePrivacyDlpV2PrimitiveTransformation' - description: Apply the transformation to the entire field. - condition: - $ref: '#/components/schemas/GooglePrivacyDlpV2RecordCondition' + Seconds of a minute. Must be greater than or equal to 0 and + typically must be less than or equal to 59. An API may allow the + value 60 if it allows leap-seconds. + type: integer + format: int32 + nanos: description: >- - Only apply the transformation if the condition evaluates to true for - the given `RecordCondition`. The conditions are allowed to reference - fields that are not used in the actual transformation. Example Use - Cases: - Apply a different bucket transformation to an age column if - the zip code column for the same record is within a specific range. - - Redact a field if the date of birth field is greater than 85. - description: The transformation to apply to the field. - type: object - id: GooglePrivacyDlpV2FieldTransformation - GooglePrivacyDlpV2RecordKey: - description: Message for a unique key indicating a record that contains a finding. - id: GooglePrivacyDlpV2RecordKey + Fractions of seconds, in nanoseconds. Must be greater than or equal + to 0 and less than or equal to 999,999,999. + type: integer + format: int32 + GoogleTypeDate: + id: GoogleTypeDate + description: >- + Represents a whole or partial calendar date, such as a birthday. The + time of day and time zone are either specified elsewhere or are + insignificant. The date is relative to the Gregorian Calendar. This can + represent one of the following: * A full date, with non-zero year, + month, and day values. * A month and day, with a zero year (for example, + an anniversary). * A year on its own, with a zero month and a zero day. + * A year and month, with a zero day (for example, a credit card + expiration date). Related types: * google.type.TimeOfDay * + google.type.DateTime * google.protobuf.Timestamp type: object properties: - bigQueryKey: - description: Datastore key - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryKey' - idValues: - description: >- - Values of identifying columns in the given row. Order of values - matches the order of `identifying_fields` specified in the scanning - request. - type: array - items: - type: string - datastoreKey: - $ref: '#/components/schemas/GooglePrivacyDlpV2DatastoreKey' - description: BigQuery key - GooglePrivacyDlpV2OtherInfoTypeSummary: - id: GooglePrivacyDlpV2OtherInfoTypeSummary - properties: - excludedFromAnalysis: - type: boolean + year: description: >- - Whether this infoType was excluded from sensitivity and risk - analysis due to factors such as low prevalence (subject to change). - estimatedPrevalence: + Year of the date. Must be from 1 to 9999, or 0 to specify a date + without a year. type: integer format: int32 + month: description: >- - Approximate percentage of non-null rows that contained data detected - by this infotype. - infoType: - description: The other infoType. - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - description: Infotype details for other infoTypes found within a column. + Month of a year. Must be from 1 to 12, or 0 to specify a year + without a month and day. + type: integer + format: int32 + day: + description: >- + Day of a month. Must be from 1 to 31 and valid for the year and + month, or 0 to specify a year by itself or a year and month where + the day isn't significant. + type: integer + format: int32 + GooglePrivacyDlpV2ByteContentItem: + id: GooglePrivacyDlpV2ByteContentItem + description: Container for bytes to inspect or redact. type: object - GooglePrivacyDlpV2InspectionRule: properties: - hotwordRule: - $ref: '#/components/schemas/GooglePrivacyDlpV2HotwordRule' - description: Hotword-based detection rule. - exclusionRule: - $ref: '#/components/schemas/GooglePrivacyDlpV2ExclusionRule' - description: Exclusion rule. - type: object - id: GooglePrivacyDlpV2InspectionRule - description: >- - A single inspection rule to be applied to infoTypes, specified in - `InspectionRuleSet`. - GooglePrivacyDlpV2CryptoDeterministicConfig: - id: GooglePrivacyDlpV2CryptoDeterministicConfig - description: >- - Pseudonymization method that generates deterministic encryption for the - given input. Outputs a base64 encoded representation of the encrypted - output. Uses AES-SIV based on the RFC - https://tools.ietf.org/html/rfc5297. + type: + description: >- + The type of data stored in the bytes string. Default will be + TEXT_UTF8. + type: string + enumDescriptions: + - Unused + - Any image type. + - jpeg + - bmp + - png + - svg + - plain text + - docx, docm, dotx, dotm + - pdf + - pptx, pptm, potx, potm, pot + - xlsx, xlsm, xltx, xltm + - avro + - csv + - tsv + - Audio file types. Only used for profiling. + - Video file types. Only used for profiling. + - Executable file types. Only used for profiling. + - AI model file types. Only used for profiling. + enum: + - BYTES_TYPE_UNSPECIFIED + - IMAGE + - IMAGE_JPEG + - IMAGE_BMP + - IMAGE_PNG + - IMAGE_SVG + - TEXT_UTF8 + - WORD_DOCUMENT + - PDF + - POWERPOINT_DOCUMENT + - EXCEL_DOCUMENT + - AVRO + - CSV + - TSV + - AUDIO + - VIDEO + - EXECUTABLE + - AI_MODEL + data: + description: Content data to inspect or redact. + type: string + format: byte + GooglePrivacyDlpV2InspectContentResponse: + id: GooglePrivacyDlpV2InspectContentResponse + description: Results of inspecting an item. type: object properties: - context: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - description: >- - A context may be used for higher security and maintaining - referential integrity such that the same identifier in two different - contexts will be given a distinct surrogate. The context is appended - to plaintext value being encrypted. On decryption the provided - context is validated against the value used during encryption. If a - context was provided during encryption, same context must be - provided during decryption as well. If the context is not set, - plaintext would be used as is for encryption. If the context is set - but: 1. there is no record present when transforming a given value - or 2. the field is not present when transforming a given value, - plaintext would be used as is for encryption. Note that case (1) is - expected when an `InfoTypeTransformation` is applied to both - structured and unstructured `ContentItem`s. - cryptoKey: - $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoKey' - description: >- - The key used by the encryption function. For deterministic - encryption using AES-SIV, the provided key is internally expanded to - 64 bytes prior to use. - surrogateInfoType: - description: >- - The custom info type to annotate the surrogate with. This annotation - will be applied to the surrogate by prefixing it with the name of - the custom info type followed by the number of characters comprising - the surrogate. The following scheme defines the format: {info type - name}({surrogate character count}):{surrogate} For example, if the - name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate - is 'abc', the full replacement value will be: - 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate - when inspecting content using the custom info type 'Surrogate'. This - facilitates reversal of the surrogate when it occurs in free text. - Note: For record transformations where the entire cell in a table is - being transformed, surrogates are not mandatory. Surrogates are used - to denote the location of the token and are necessary for - re-identification in free form text. In order for inspection to work - properly, the name of this info type must not occur naturally - anywhere in your data; otherwise, inspection may either - reverse a - surrogate that does not correspond to an actual identifier - be - unable to parse the surrogate and result in an error Therefore, - choose your custom info type name carefully after considering what - your data looks like. One way to select a name that has a high - chance of yielding reliable detection is to include one or more - unicode characters that are highly improbable to exist in your data. - For example, assuming your data is entered from a regular ASCII - keyboard, the symbol with the hex code point 29DD might be used like - so: ⧝MY_TOKEN_TYPE. - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - GooglePrivacyDlpV2DiscoveryCloudStorageConditions: + result: + description: The findings. + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectResult' + GooglePrivacyDlpV2InspectResult: + id: GooglePrivacyDlpV2InspectResult + description: All the findings for a single scanned item. type: object - id: GooglePrivacyDlpV2DiscoveryCloudStorageConditions properties: - includedBucketAttributes: - items: - enumDescriptions: - - Unused. - - Scan buckets regardless of the attribute. - - >- - Buckets with autoclass disabled - (https://cloud.google.com/storage/docs/autoclass). Only one of - AUTOCLASS_DISABLED or AUTOCLASS_ENABLED should be set. - - >- - Buckets with autoclass enabled - (https://cloud.google.com/storage/docs/autoclass). Only one of - AUTOCLASS_DISABLED or AUTOCLASS_ENABLED should be set. Scanning - Autoclass-enabled buckets can affect object storage classes. - enum: - - CLOUD_STORAGE_BUCKET_ATTRIBUTE_UNSPECIFIED - - ALL_SUPPORTED_BUCKETS - - AUTOCLASS_DISABLED - - AUTOCLASS_ENABLED - type: string - description: >- - Required. Only objects with the specified attributes will be - scanned. Defaults to [ALL_SUPPORTED_BUCKETS] if unset. - type: array - includedObjectAttributes: + findings: + description: List of findings for an item. type: array items: - enum: - - CLOUD_STORAGE_OBJECT_ATTRIBUTE_UNSPECIFIED - - ALL_SUPPORTED_OBJECTS - - STANDARD - - NEARLINE - - COLDLINE - - ARCHIVE - - REGIONAL - - MULTI_REGIONAL - - DURABLE_REDUCED_AVAILABILITY - type: string - enumDescriptions: - - Unused. - - Scan objects regardless of the attribute. - - Scan objects with the standard storage class. - - >- - Scan objects with the nearline storage class. This will incur - retrieval fees. - - >- - Scan objects with the coldline storage class. This will incur - retrieval fees. - - >- - Scan objects with the archive storage class. This will incur - retrieval fees. - - Scan objects with the regional storage class. - - Scan objects with the multi-regional storage class. - - >- - Scan objects with the dual-regional storage class. This will - incur retrieval fees. + $ref: '#/components/schemas/GooglePrivacyDlpV2Finding' + findingsTruncated: description: >- - Required. Only objects with the specified attributes will be - scanned. If an object has one of the specified attributes but is - inside an excluded bucket, it will not be scanned. Defaults to - [ALL_SUPPORTED_OBJECTS]. A profile will be created even if no - objects match the included_object_attributes. - description: >- - Requirements that must be true before a Cloud Storage bucket or object - is scanned in discovery for the first time. There is an AND relationship - between the top-level attributes. - GooglePrivacyDlpV2Schedule: + If true, then this item might have more findings than were returned, + and the findings returned are an arbitrary subset of all findings. + The findings list might be truncated because the input items were + too large, or because the server reached the maximum amount of + resources allowed for a single API call. For best results, divide + the input into smaller batches. + type: boolean + GooglePrivacyDlpV2Finding: + id: GooglePrivacyDlpV2Finding + description: Represents a piece of potentially sensitive content. + type: object properties: - recurrencePeriodDuration: + name: + description: >- + Resource name in format + projects/{project}/locations/{location}/findings/{finding} Populated + only when viewing persisted findings. type: string + quote: description: >- - With this option a job is started on a regular periodic basis. For - example: every day (86400 seconds). A scheduled start time will be - skipped if the previous execution has not ended when its scheduled - time occurs. This value must be set to a time duration greater than - or equal to 1 day and can be no longer than 60 days. - format: google-duration - id: GooglePrivacyDlpV2Schedule - description: Schedule for inspect job triggers. - type: object - GooglePrivacyDlpV2AmazonS3BucketConditions: - id: GooglePrivacyDlpV2AmazonS3BucketConditions - type: object - properties: - objectStorageClasses: + The content that was found. Even if the content is not textual, it + may be converted to a textual representation here. Provided if + `include_quote` is true and the finding is less than or equal to + 4096 bytes long. If the finding exceeds 4096 bytes in length, the + quote may be omitted. + type: string + infoType: description: >- - Optional. Object classes that should be profiled. Optional. Defaults - to ALL_SUPPORTED_CLASSES if unspecified. - items: - enum: - - UNSPECIFIED - - ALL_SUPPORTED_CLASSES - - STANDARD - - STANDARD_INFREQUENT_ACCESS - - GLACIER_INSTANT_RETRIEVAL - - INTELLIGENT_TIERING - type: string - enumDescriptions: - - Unused. - - All supported classes. - - Standard object class. - - Standard - infrequent access object class. - - Glacier - instant retrieval object class. - - Objects in the S3 Intelligent-Tiering access tiers. - type: array - bucketTypes: + The type of content that might have been found. Provided if + `excluded_types` is false. + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + likelihood: + description: Confidence of how likely it is that the `info_type` is correct. + type: string + enumDescriptions: + - Default value; same as POSSIBLE. + - Highest chance of a false positive. + - High chance of a false positive. + - Some matching signals. The default value. + - Low chance of a false positive. + - Confidence level is high. Lowest chance of a false positive. + enum: + - LIKELIHOOD_UNSPECIFIED + - VERY_UNLIKELY + - UNLIKELY + - POSSIBLE + - LIKELY + - VERY_LIKELY + location: + description: Where the content was found. + $ref: '#/components/schemas/GooglePrivacyDlpV2Location' + createTime: + description: Timestamp when finding was detected. + type: string + format: google-datetime + quoteInfo: description: >- - Optional. Bucket types that should be profiled. Optional. Defaults - to TYPE_ALL_SUPPORTED if unspecified. - type: array - items: - enumDescriptions: - - Unused. - - All supported classes. - - A general purpose Amazon S3 bucket. - enum: - - TYPE_UNSPECIFIED - - TYPE_ALL_SUPPORTED - - TYPE_GENERAL_PURPOSE + Contains data parsed from quotes. Only populated if include_quote + was set to true and a supported infoType was requested. Currently + supported infoTypes: DATE, DATE_OF_BIRTH and TIME. + $ref: '#/components/schemas/GooglePrivacyDlpV2QuoteInfo' + resourceName: + description: The job that stored the finding. + type: string + triggerName: + description: Job trigger name, if applicable, for this finding. + type: string + labels: + description: >- + The labels associated with this `Finding`. Label keys must be + between 1 and 63 characters long and must conform to the following + regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. Label values must + be between 0 and 63 characters long and must conform to the regular + expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. No more than 10 labels + can be associated with a given finding. Examples: * `"environment" : + "production"` * `"pipeline" : "etl"` + type: object + additionalProperties: type: string - description: Amazon S3 bucket conditions. - GooglePrivacyDlpV2TransformationSummary: + jobCreateTime: + description: Time the job started that produced this finding. + type: string + format: google-datetime + jobName: + description: The job that stored the finding. + type: string + findingId: + description: The unique finding id. + type: string + GooglePrivacyDlpV2Location: + id: GooglePrivacyDlpV2Location + description: Specifies the location of the finding. + type: object properties: - field: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - description: Set if the transformation was limited to a specific FieldId. - transformation: - description: The specific transformation these stats apply to. - $ref: '#/components/schemas/GooglePrivacyDlpV2PrimitiveTransformation' - results: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2SummaryResult' - type: array - description: Collection of all transformations that took place or had an error. - fieldTransformations: + byteRange: + description: >- + Zero-based byte offsets delimiting the finding. These are relative + to the finding's containing element. Note that when the content is + not textual, this references the UTF-8 encoded textual + representation of the content. Omitted if content is an image. + $ref: '#/components/schemas/GooglePrivacyDlpV2Range' + codepointRange: + description: >- + Unicode character offsets delimiting the finding. These are relative + to the finding's containing element. Provided when the content is + text. + $ref: '#/components/schemas/GooglePrivacyDlpV2Range' + contentLocations: + description: >- + List of nested objects pointing to the precise location of the + finding within the file or record. type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldTransformation' + $ref: '#/components/schemas/GooglePrivacyDlpV2ContentLocation' + container: description: >- - The field transformation that was applied. If multiple field - transformations are requested for a single field, this list will - contain all of them; otherwise, only one is supplied. - infoType: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - description: Set if the transformation was limited to a specific InfoType. - recordSuppress: - $ref: '#/components/schemas/GooglePrivacyDlpV2RecordSuppression' - description: The specific suppression option these stats apply to. - transformedBytes: - description: Total size in bytes that were transformed in some way. + Information about the container where this finding occurred, if + available. + $ref: '#/components/schemas/GooglePrivacyDlpV2Container' + GooglePrivacyDlpV2Range: + id: GooglePrivacyDlpV2Range + description: Generic half-open interval [start, end) + type: object + properties: + start: + description: Index of the first character of the range (inclusive). + type: string format: int64 + end: + description: Index of the last character of the range (exclusive). type: string + format: int64 + GooglePrivacyDlpV2ContentLocation: + id: GooglePrivacyDlpV2ContentLocation description: >- - Summary of a single transformation. Only one of 'transformation', - 'field_transformation', or 'record_suppress' will be set. - type: object - id: GooglePrivacyDlpV2TransformationSummary - GooglePrivacyDlpV2CloudStorageRegexFileSet: + Precise location of the finding within a document, record, image, or + metadata container. type: object properties: - excludeRegex: - type: array - items: - type: string + containerName: description: >- - A list of regular expressions matching file paths to exclude. All - files in the bucket that match at least one of these regular - expressions will be excluded from the scan. Regular expressions use - RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can - be found under the google/re2 repository on GitHub. - bucketName: - description: The name of a Cloud Storage bucket. Required. + Name of the container where the finding is located. The top level + name is the source file name or table name. Names of some common + storage containers are formatted as follows: * BigQuery tables: + `{project_id}:{dataset_id}.{table_id}` * Cloud Storage files: + `gs://{bucket}/{path}` * Datastore namespace: {namespace} Nested + names could be absent if the embedded object has no string + identifier (for example, an image contained within a document). type: string - includeRegex: - items: - type: string - type: array + recordLocation: + description: Location within a row or record of a database table. + $ref: '#/components/schemas/GooglePrivacyDlpV2RecordLocation' + imageLocation: + description: Location within an image's pixels. + $ref: '#/components/schemas/GooglePrivacyDlpV2ImageLocation' + documentLocation: + description: Location data for document files. + $ref: '#/components/schemas/GooglePrivacyDlpV2DocumentLocation' + metadataLocation: + description: Location within the metadata for inspected content. + $ref: '#/components/schemas/GooglePrivacyDlpV2MetadataLocation' + containerTimestamp: description: >- - A list of regular expressions matching file paths to include. All - files in the bucket that match at least one of these regular - expressions will be included in the set of files, except for those - that also match an item in `exclude_regex`. Leaving this field empty - will match all files by default (this is equivalent to including - `.*` in the list). Regular expressions use RE2 - [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be - found under the google/re2 repository on GitHub. - id: GooglePrivacyDlpV2CloudStorageRegexFileSet - description: >- - Message representing a set of files in a Cloud Storage bucket. Regular - expressions are used to allow fine-grained control over which files in - the bucket to include. Included files are those that match at least one - item in `include_regex` and do not match any items in `exclude_regex`. - Note that a file that matches items from both lists will _not_ be - included. For a match to occur, the entire file path (i.e., everything - in the url after the bucket name) must match the regular expression. For - example, given the input `{bucket_name: "mybucket", include_regex: - ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]}`: * - `gs://mybucket/directory1/myfile` will be included * - `gs://mybucket/directory1/directory2/myfile` will be included (`.*` - matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will - _not_ be included (the full path doesn't match any items in - `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be - included (the path matches an item in `exclude_regex`) If - `include_regex` is left empty, it will match all files by default (this - is equivalent to setting `include_regex: [".*"]`). Some other common use - cases: * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will - include all files in `mybucket` except for .pdf files * `{bucket_name: - "mybucket", include_regex: ["directory/[^/]+"]}` will include all files - directly under `gs://mybucket/directory/`, without matching across `/` - GooglePrivacyDlpV2TaggedField: - id: GooglePrivacyDlpV2TaggedField - description: A column with a semantic tag attached. + Finding container modification timestamp, if applicable. For Cloud + Storage, this field contains the last file modification timestamp. + For a BigQuery table, this field contains the last_modified_time + property. For Datastore, this field isn't populated. + type: string + format: google-datetime + containerVersion: + description: >- + Finding container version, if available ("generation" for Cloud + Storage). + type: string + GooglePrivacyDlpV2RecordLocation: + id: GooglePrivacyDlpV2RecordLocation + description: Location of a finding within a row or record. type: object properties: - infoType: - description: >- - A column can be tagged with a InfoType to use the relevant public - dataset as a statistical model of population, if available. We - currently support US ZIP codes, region codes, ages and genders. To - programmatically obtain the list of supported InfoTypes, use - ListInfoTypes with the supported_by=RISK_ANALYSIS filter. - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - field: + recordKey: + description: Key of the finding. + $ref: '#/components/schemas/GooglePrivacyDlpV2RecordKey' + fieldId: + description: Field id of the field containing the finding. $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - description: Required. Identifies the column. - customTag: - type: string + tableLocation: + description: Location within a `ContentItem.Table`. + $ref: '#/components/schemas/GooglePrivacyDlpV2TableLocation' + GooglePrivacyDlpV2RecordKey: + id: GooglePrivacyDlpV2RecordKey + description: Message for a unique key indicating a record that contains a finding. + type: object + properties: + datastoreKey: + description: BigQuery key + $ref: '#/components/schemas/GooglePrivacyDlpV2DatastoreKey' + bigQueryKey: + description: Datastore key + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryKey' + idValues: description: >- - A column can be tagged with a custom tag. In this case, the user - must indicate an auxiliary table that contains statistical - information on the possible values of this column (below). - inferred: - $ref: '#/components/schemas/GoogleProtobufEmpty' + Values of identifying columns in the given row. Order of values + matches the order of `identifying_fields` specified in the scanning + request. + type: array + items: + type: string + GooglePrivacyDlpV2DatastoreKey: + id: GooglePrivacyDlpV2DatastoreKey + description: Record key for a finding in Cloud Datastore. + type: object + properties: + entityKey: + description: Datastore entity key. + $ref: '#/components/schemas/GooglePrivacyDlpV2Key' + GooglePrivacyDlpV2Key: + id: GooglePrivacyDlpV2Key + description: >- + A unique identifier for a Datastore entity. If a key's partition ID or + any of its path kinds or names are reserved/read-only, the key is + reserved/read-only. A reserved/read-only key is forbidden in certain + documented contexts. + type: object + properties: + partitionId: description: >- - If no semantic tag is indicated, we infer the statistical model from - the distribution of values in the input data - GooglePrivacyDlpV2DataProfilePubSubCondition: - description: A condition for determining whether a Pub/Sub should be triggered. - id: GooglePrivacyDlpV2DataProfilePubSubCondition + Entities are partitioned into subsets, currently identified by a + project ID and namespace ID. Queries are scoped to a single + partition. + $ref: '#/components/schemas/GooglePrivacyDlpV2PartitionId' + path: + description: >- + The entity path. An entity path consists of one or more elements + composed of a kind and a string or numerical identifier, which + identify entities. The first element identifies a _root entity_, the + second element identifies a _child_ of the root entity, the third + element identifies a child of the second entity, and so forth. The + entities identified by all prefixes of the path are called the + element's _ancestors_. A path can never be empty, and a path can + have at most 100 elements. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2PathElement' + GooglePrivacyDlpV2PartitionId: + id: GooglePrivacyDlpV2PartitionId + description: >- + Datastore partition ID. A partition ID identifies a grouping of + entities. The grouping is always by project and namespace, however the + namespace ID may be empty. A partition ID contains several dimensions: + project ID and namespace ID. type: object properties: - expressions: - description: An expression. - $ref: '#/components/schemas/GooglePrivacyDlpV2PubSubExpressions' - GooglePrivacyDlpV2OrConditions: + projectId: + description: The ID of the project to which the entities belong. + type: string + namespaceId: + description: If not empty, the ID of the namespace to which the entities belong. + type: string + GooglePrivacyDlpV2PathElement: + id: GooglePrivacyDlpV2PathElement + description: >- + A (kind, ID/name) pair used to construct a key path. If either name or + ID is set, the element is complete. If neither is set, the element is + incomplete. + type: object properties: - minAge: + kind: description: >- - Minimum age a table must have before Cloud DLP can profile it. Value - must be 1 hour or greater. + The kind of the entity. A kind matching regex `__.*__` is + reserved/read-only. A kind must not contain more than 1500 bytes + when UTF-8 encoded. Cannot be `""`. type: string - format: google-duration - minRowCount: + id: description: >- - Minimum number of rows that should be present before Cloud DLP - profiles a table - type: integer - format: int32 - id: GooglePrivacyDlpV2OrConditions + The auto-allocated ID of the entity. Never equal to zero. Values + less than zero are discouraged and may not be supported in the + future. + type: string + format: int64 + name: + description: >- + The name of the entity. A name matching regex `__.*__` is + reserved/read-only. A name must not be more than 1500 bytes when + UTF-8 encoded. Cannot be `""`. + type: string + GooglePrivacyDlpV2BigQueryKey: + id: GooglePrivacyDlpV2BigQueryKey + description: Row key for identifying a record in BigQuery table. type: object + properties: + tableReference: + description: Complete BigQuery table reference. + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + rowNumber: + description: >- + Row number inferred at the time the table was scanned. This value is + nondeterministic, cannot be queried, and may be null for inspection + jobs. To locate findings within a table, specify + `inspect_job.storage_config.big_query_options.identifying_fields` in + `CreateDlpJobRequest`. + type: string + format: int64 + GooglePrivacyDlpV2BigQueryTable: + id: GooglePrivacyDlpV2BigQueryTable description: >- - There is an OR relationship between these attributes. They are used to - determine if a table should be scanned or not in Discovery. - GooglePrivacyDlpV2DataProfilePubSubMessage: + Message defining the location of a BigQuery table. A table is uniquely + identified by its project_id, dataset_id, and table_name. Within a query + a table is often referenced with a string in the format of: `:.` or + `..`. type: object - id: GooglePrivacyDlpV2DataProfilePubSubMessage - description: >- - Pub/Sub topic message for a DataProfileAction.PubSubNotification event. - To receive a message of protocol buffer schema type, convert the message - data to an object of this proto class. properties: - profile: - $ref: '#/components/schemas/GooglePrivacyDlpV2TableDataProfile' + projectId: description: >- - If `DetailLevel` is `TABLE_PROFILE` this will be fully populated. - Otherwise, if `DetailLevel` is `RESOURCE_NAME`, then only `name` and - `full_resource` will be populated. - event: - enum: - - EVENT_TYPE_UNSPECIFIED - - NEW_PROFILE - - CHANGED_PROFILE - - SCORE_INCREASED - - ERROR_CHANGED - description: The event that caused the Pub/Sub message to be sent. - enumDescriptions: - - Unused. - - New profile (not a re-profile). - - >- - One of the following profile metrics changed: Data risk score, - Sensitivity score, Resource visibility, Encryption type, Predicted - infoTypes, Other infoTypes - - Table data risk score or sensitivity score increased. - - A user (non-internal) error occurred. + The Google Cloud project ID of the project containing the table. If + omitted, project ID is inferred from the API call. + type: string + datasetId: + description: Dataset ID of the table. + type: string + tableId: + description: Name of the table. type: string - fileStoreProfile: - description: >- - If `DetailLevel` is `FILE_STORE_PROFILE` this will be fully - populated. Otherwise, if `DetailLevel` is `RESOURCE_NAME`, then only - `name` and `file_store_path` will be populated. - $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreDataProfile' GooglePrivacyDlpV2TableLocation: + id: GooglePrivacyDlpV2TableLocation description: Location of a finding within a table. + type: object properties: rowIndex: - format: int64 - type: string description: >- The zero-based index of the row where the finding is located. Only populated for resources that have a natural ordering, not BigQuery. @@ -1444,2207 +1297,2223 @@ components: BigQueryOptions.identifying_fields with your primary key column names and when you store the findings the value of those columns will be stored inside of Finding. + type: string + format: int64 + GooglePrivacyDlpV2ImageLocation: + id: GooglePrivacyDlpV2ImageLocation + description: Location of the finding within an image. type: object - id: GooglePrivacyDlpV2TableLocation + properties: + boundingBoxes: + description: >- + Bounding boxes locating the pixels within the image containing the + finding. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2BoundingBox' + GooglePrivacyDlpV2BoundingBox: + id: GooglePrivacyDlpV2BoundingBox + description: Bounding box encompassing detected text within an image. + type: object + properties: + top: + description: Top coordinate of the bounding box. (0,0) is upper left. + type: integer + format: int32 + left: + description: Left coordinate of the bounding box. (0,0) is upper left. + type: integer + format: int32 + width: + description: Width of the bounding box in pixels. + type: integer + format: int32 + height: + description: Height of the bounding box in pixels. + type: integer + format: int32 + GooglePrivacyDlpV2DocumentLocation: + id: GooglePrivacyDlpV2DocumentLocation + description: Location of a finding within a document. + type: object + properties: + fileOffset: + description: >- + Offset of the line, from the beginning of the file, where the + finding is located. + type: string + format: int64 GooglePrivacyDlpV2MetadataLocation: + id: GooglePrivacyDlpV2MetadataLocation + description: Metadata Location + type: object properties: type: + description: Type of metadata containing the finding. type: string - enum: - - METADATATYPE_UNSPECIFIED - - STORAGE_METADATA enumDescriptions: - Unused - General file metadata provided by Cloud Storage. - description: Type of metadata containing the finding. + enum: + - METADATATYPE_UNSPECIFIED + - STORAGE_METADATA storageLabel: description: Storage metadata. $ref: '#/components/schemas/GooglePrivacyDlpV2StorageMetadataLabel' - type: object - id: GooglePrivacyDlpV2MetadataLocation - description: Metadata Location - GooglePrivacyDlpV2SensitivityScore: + GooglePrivacyDlpV2StorageMetadataLabel: + id: GooglePrivacyDlpV2StorageMetadataLabel + description: >- + Storage metadata label to indicate which metadata entry contains + findings. type: object properties: - score: - description: The sensitivity score applied to the resource. - enum: - - SENSITIVITY_SCORE_UNSPECIFIED - - SENSITIVITY_LOW - - SENSITIVITY_UNKNOWN - - SENSITIVITY_MODERATE - - SENSITIVITY_HIGH - enumDescriptions: - - Unused. - - >- - No sensitive information detected. The resource isn't publicly - accessible. - - Unable to determine sensitivity. - - >- - Medium risk. Contains personally identifiable information (PII), - potentially sensitive data, or fields with free-text data that are - at a higher risk of having intermittent sensitive data. Consider - limiting access. - - >- - High risk. Sensitive personally identifiable information (SPII) - can be present. Exfiltration of data can lead to user data loss. - Re-identification of users might be possible. Consider limiting - usage and or removing SPII. + key: + description: Label name. type: string - id: GooglePrivacyDlpV2SensitivityScore - description: >- - Score is calculated from of all elements in the data profile. A higher - level means the data is more sensitive. - GooglePrivacyDlpV2KMapEstimationHistogramBucket: + GooglePrivacyDlpV2Container: + id: GooglePrivacyDlpV2Container description: >- - A KMapEstimationHistogramBucket message with the following values: - min_anonymity: 3 max_anonymity: 5 frequency: 42 means that there are 42 - records whose quasi-identifier values correspond to 3, 4 or 5 people in - the overlying population. An important particular case is when - min_anonymity = max_anonymity = 1: the frequency field then corresponds - to the number of uniquely identifiable records. + Represents a container that may contain DLP findings. Examples of a + container include a file, table, or database record. + type: object properties: - bucketValueCount: - format: int64 + type: + description: Container type, for example BigQuery or Cloud Storage. type: string + projectId: description: >- - Total number of distinct quasi-identifier tuple values in this - bucket. - bucketSize: + Project where the finding was found. Can be different from the + project that owns the finding. type: string - description: Number of records within these anonymity bounds. - format: int64 - minAnonymity: + fullPath: + description: >- + A string representation of the full container name. Examples: - + BigQuery: 'Project:DataSetId.TableId' - Cloud Storage: + 'gs://Bucket/folders/filename.txt' type: string - description: Always positive. - format: int64 - maxAnonymity: - format: int64 - description: Always greater than or equal to min_anonymity. + rootPath: + description: >- + The root of the container. Examples: - For BigQuery table + `project_id:dataset_id.table_id`, the root is `dataset_id` - For + Cloud Storage file `gs://bucket/folder/filename.txt`, the root is + `gs://bucket` type: string - bucketValues: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2KMapEstimationQuasiIdValues' - type: array + relativePath: description: >- - Sample of quasi-identifier tuple values in this bucket. The total - number of classes returned per bucket is capped at 20. - type: object - id: GooglePrivacyDlpV2KMapEstimationHistogramBucket - GooglePrivacyDlpV2CreateDlpJobRequest: - properties: - riskJob: - $ref: '#/components/schemas/GooglePrivacyDlpV2RiskAnalysisJobConfig' + The rest of the path after the root. Examples: - For BigQuery table + `project_id:dataset_id.table_id`, the relative path is `table_id` - + For Cloud Storage file `gs://bucket/folder/filename.txt`, the + relative path is `folder/filename.txt` + type: string + updateTime: description: >- - A risk analysis job calculates re-identification risk metrics for a - BigQuery table. - jobId: + Findings container modification timestamp, if applicable. For Cloud + Storage, this field contains the last file modification timestamp. + For a BigQuery table, this field contains the last_modified_time + property. For Datastore, this field isn't populated. + type: string + format: google-datetime + version: description: >- - The job id can contain uppercase and lowercase letters, numbers, and - hyphens; that is, it must match the regular expression: - `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty - to allow the system to generate one. + Findings container version, if available ("generation" for Cloud + Storage). type: string - inspectJob: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectJobConfig' - description: An inspection job scans a storage repository for InfoTypes. - locationId: + GooglePrivacyDlpV2QuoteInfo: + id: GooglePrivacyDlpV2QuoteInfo + description: Message for infoType-dependent details parsed from quote. + type: object + properties: + dateTime: + description: The date time indicated by the quote. + $ref: '#/components/schemas/GooglePrivacyDlpV2DateTime' + GooglePrivacyDlpV2DateTime: + id: GooglePrivacyDlpV2DateTime + description: Message for a date time object. e.g. 2018-01-01, 5th August. + type: object + properties: + date: + description: >- + One or more of the following must be set. Must be a valid date or + time value. + $ref: '#/components/schemas/GoogleTypeDate' + dayOfWeek: + description: Day of week type: string - description: Deprecated. This field has no effect. + enumDescriptions: + - The day of the week is unspecified. + - Monday + - Tuesday + - Wednesday + - Thursday + - Friday + - Saturday + - Sunday + enum: + - DAY_OF_WEEK_UNSPECIFIED + - MONDAY + - TUESDAY + - WEDNESDAY + - THURSDAY + - FRIDAY + - SATURDAY + - SUNDAY + time: + description: Time of day + $ref: '#/components/schemas/GoogleTypeTimeOfDay' + timeZone: + description: Time zone + $ref: '#/components/schemas/GooglePrivacyDlpV2TimeZone' + GooglePrivacyDlpV2TimeZone: + id: GooglePrivacyDlpV2TimeZone + description: Time zone of the date time object. type: object - description: >- - Request message for CreateDlpJobRequest. Used to initiate long running - jobs such as calculating risk metrics or inspecting Google Cloud - Storage. - id: GooglePrivacyDlpV2CreateDlpJobRequest - GooglePrivacyDlpV2DeltaPresenceEstimationQuasiIdValues: - description: A tuple of values for the quasi-identifier columns. - id: GooglePrivacyDlpV2DeltaPresenceEstimationQuasiIdValues properties: - estimatedProbability: - format: double + offsetMinutes: description: >- - The estimated probability that a given individual sharing these - quasi-identifier values is in the dataset. This value, typically - called δ, is the ratio between the number of records in the dataset - with these quasi-identifier values, and the total number of - individuals (inside *and* outside the dataset) with these - quasi-identifier values. For example, if there are 15 individuals in - the dataset who share the same quasi-identifier values, and an - estimated 100 people in the entire population with these values, - then δ is 0.15. - type: number - quasiIdsValues: - description: The quasi-identifier values. + Set only if the offset can be determined. Positive for time ahead of + UTC. E.g. For "UTC-9", this value is -540. + type: integer + format: int32 + GooglePrivacyDlpV2RedactImageRequest: + id: GooglePrivacyDlpV2RedactImageRequest + description: >- + Request to search for potentially sensitive info in an image and redact + it by covering it with a colored rectangle. + type: object + properties: + locationId: + description: Deprecated. This field has no effect. + type: string + inspectConfig: + description: Configuration for the inspector. + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' + imageRedactionConfigs: + description: The configuration for specifying what content to redact from images. type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - type: object - GooglePrivacyDlpV2OutputStorageConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2ImageRedactionConfig' + includeFindings: + description: >- + Whether the response should include findings along with the redacted + image. + type: boolean + byteItem: + description: The content must be PNG, JPEG, SVG or BMP. + $ref: '#/components/schemas/GooglePrivacyDlpV2ByteContentItem' + GooglePrivacyDlpV2ImageRedactionConfig: + id: GooglePrivacyDlpV2ImageRedactionConfig + description: Configuration for determining how redaction of images should occur. type: object - description: Cloud repository for storing output. properties: - outputSchema: - enum: - - OUTPUT_SCHEMA_UNSPECIFIED - - BASIC_COLUMNS - - GCS_COLUMNS - - DATASTORE_COLUMNS - - BIG_QUERY_COLUMNS - - ALL_COLUMNS - enumDescriptions: - - Unused. - - >- - Basic schema including only `info_type`, `quote`, `certainty`, and - `timestamp`. - - Schema tailored to findings from scanning Cloud Storage. - - Schema tailored to findings from scanning Google Datastore. - - Schema tailored to findings from scanning Google BigQuery. - - Schema containing all columns. - type: string + infoType: description: >- - Schema used for writing the findings for Inspect jobs. This field is - only used for Inspect and must be unspecified for Risk jobs. Columns - are derived from the `Finding` object. If appending to an existing - table, any columns from the predefined schema that are missing will - be added. No columns in the existing table will be deleted. If - unspecified, then all available columns will be used for a new table - or an (existing) table with no schema, and no changes will be made - to an existing table that has a schema. Only for use with external - storage. - table: + Only one per info_type should be provided per request. If not + specified, and redact_all_text is false, the DLP API will redact all + text that it matches against all info_types that are found, but not + specified in another ImageRedactionConfig. + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + redactAllText: description: >- - Store findings in an existing table or a new table in an existing - dataset. If table_id is not set a new one will be generated for you - with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. - Pacific time zone will be used for generating the date details. For - Inspect, each column in an existing output table must have the same - name, type, and mode of a field in the `Finding` object. For Risk, - an existing output table should be the output of a previous Risk - analysis job run on the same source table, with the same privacy - metric and quasi-identifiers. Risk jobs that analyze the same table - but compute a different privacy metric, or use different sets of - quasi-identifiers, cannot store their results in the same table. - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' - id: GooglePrivacyDlpV2OutputStorageConfig - GooglePrivacyDlpV2ContentItem: - description: Type of content to inspect. - properties: - table: - $ref: '#/components/schemas/GooglePrivacyDlpV2Table' + If true, all text found in the image, regardless whether it matches + an info_type, is redacted. Only one should be provided. + type: boolean + redactionColor: description: >- - Structured content for inspection. See - https://cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table - to learn more. - value: - description: String data to inspect or redact. - type: string - byteItem: - $ref: '#/components/schemas/GooglePrivacyDlpV2ByteContentItem' - description: Content data to inspect or redact. Replaces `type` and `data`. - id: GooglePrivacyDlpV2ContentItem - type: object - GooglePrivacyDlpV2ReidentifyContentResponse: - id: GooglePrivacyDlpV2ReidentifyContentResponse - description: Results of re-identifying an item. + The color to use when redacting content from an image. If not + specified, the default is black. + $ref: '#/components/schemas/GooglePrivacyDlpV2Color' + GooglePrivacyDlpV2Color: + id: GooglePrivacyDlpV2Color + description: Represents a color in the RGB color space. type: object properties: - overview: - description: An overview of the changes that were made to the `item`. - $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationOverview' - item: - $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' - description: The re-identified item. - GooglePrivacyDlpV2FileStoreRegex: - description: A pattern to match against one or more file stores. + red: + description: The amount of red in the color as a value in the interval [0, 1]. + type: number + format: float + green: + description: The amount of green in the color as a value in the interval [0, 1]. + type: number + format: float + blue: + description: The amount of blue in the color as a value in the interval [0, 1]. + type: number + format: float + GooglePrivacyDlpV2RedactImageResponse: + id: GooglePrivacyDlpV2RedactImageResponse + description: Results of redacting an image. type: object properties: - cloudStorageRegex: - $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStorageRegex' - description: Optional. Regex for Cloud Storage. - id: GooglePrivacyDlpV2FileStoreRegex - GooglePrivacyDlpV2DatastoreOptions: - id: GooglePrivacyDlpV2DatastoreOptions + redactedImage: + description: The redacted image. The type will be the same as the original image. + type: string + format: byte + extractedText: + description: >- + If an image was being inspected and the InspectConfig's + include_quote was set to true, then this field will include all + text, if any, that was found in the image. + type: string + inspectResult: + description: >- + The findings. Populated when include_findings in the request is + true. + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectResult' + GooglePrivacyDlpV2DeidentifyContentRequest: + id: GooglePrivacyDlpV2DeidentifyContentRequest + description: Request to de-identify a ContentItem. type: object - description: Options defining a data set within Google Cloud Datastore. properties: - partitionId: + deidentifyConfig: description: >- - A partition ID identifies a grouping of entities. The grouping is - always by project and namespace, however the namespace ID may be - empty. - $ref: '#/components/schemas/GooglePrivacyDlpV2PartitionId' - kind: - description: The kind to process. - $ref: '#/components/schemas/GooglePrivacyDlpV2KindExpression' - GooglePrivacyDlpV2StorageMetadataLabel: - description: >- - Storage metadata label to indicate which metadata entry contains - findings. - properties: - key: + Configuration for the de-identification of the content item. Items + specified here will override the template referenced by the + deidentify_template_name argument. + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyConfig' + inspectConfig: + description: >- + Configuration for the inspector. Items specified here will override + the template referenced by the inspect_template_name argument. + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' + item: + description: >- + The item to de-identify. Will be treated as text. This value must be + of type Table if your deidentify_config is a RecordTransformations + object. + $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' + inspectTemplateName: + description: >- + Template to use. Any configuration directly specified in + inspect_config will override those set in the template. Singular + fields that are set in this request will replace their corresponding + fields in the template. Repeated fields are appended. Singular + sub-messages and groups are recursively merged. type: string - description: Label name. + deidentifyTemplateName: + description: >- + Template to use. Any configuration directly specified in + deidentify_config will override those set in the template. Singular + fields that are set in this request will replace their corresponding + fields in the template. Repeated fields are appended. Singular + sub-messages and groups are recursively merged. + type: string + locationId: + description: Deprecated. This field has no effect. + type: string + GooglePrivacyDlpV2DeidentifyConfig: + id: GooglePrivacyDlpV2DeidentifyConfig + description: The configuration that controls how the data will change. type: object - id: GooglePrivacyDlpV2StorageMetadataLabel - GooglePrivacyDlpV2TagCondition: - id: GooglePrivacyDlpV2TagCondition properties: - sensitivityScore: - $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' + infoTypeTransformations: description: >- - Conditions attaching the tag to a resource on its profile having - this sensitivity score. - tag: - $ref: '#/components/schemas/GooglePrivacyDlpV2TagValue' - description: The tag value to attach to resources. - type: object + Treat the dataset as free-form text and apply the same free text + transformation everywhere. + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeTransformations' + recordTransformations: + description: >- + Treat the dataset as structured. Transformations can be applied to + specific locations within structured datasets, such as transforming + a column within a table. + $ref: '#/components/schemas/GooglePrivacyDlpV2RecordTransformations' + imageTransformations: + description: Treat the dataset as an image and redact. + $ref: '#/components/schemas/GooglePrivacyDlpV2ImageTransformations' + transformationErrorHandling: + description: >- + Mode for handling transformation errors. If left unspecified, the + default mode is `TransformationErrorHandling.ThrowError`. + $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationErrorHandling' + GooglePrivacyDlpV2InfoTypeTransformations: + id: GooglePrivacyDlpV2InfoTypeTransformations description: >- - The tag to attach to profiles matching the condition. At most one - `TagCondition` can be specified per sensitivity level. - GooglePrivacyDlpV2BucketingConfig: + A type of transformation that will scan unstructured text and apply + various `PrimitiveTransformation`s to each finding, where the + transformation is applied to only values that were identified as a + specific info_type. type: object - id: GooglePrivacyDlpV2BucketingConfig - description: >- - Generalization function that buckets values based on ranges. The ranges - and replacement values are dynamically provided by the user for custom - behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can - be used on data of type: number, long, string, timestamp. If the bound - `Value` type differs from the type of data being transformed, we will - first attempt converting the type of the data to be transformed to match - the type of the bound before comparing. See - https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing - to learn more. properties: - buckets: - description: Set of buckets. Ranges must be non-overlapping. + transformations: + description: >- + Required. Transformation for each infoType. Cannot specify more than + one for a given infoType. type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Bucket' - GooglePrivacyDlpV2PublishToStackdriver: - id: GooglePrivacyDlpV2PublishToStackdriver - type: object - description: >- - Enable Stackdriver metric dlp.googleapis.com/finding_count. This will - publish a metric to stack driver on each infotype requested and how many - findings were found for it. CustomDetectors will be bucketed as 'Custom' - under the Stackdriver label 'info_type'. - properties: {} - GooglePrivacyDlpV2DiscoveryGenerationCadence: - id: GooglePrivacyDlpV2DiscoveryGenerationCadence + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeTransformation' + GooglePrivacyDlpV2InfoTypeTransformation: + id: GooglePrivacyDlpV2InfoTypeTransformation description: >- - What must take place for a profile to be updated and how frequently it - should occur. New tables are scanned as quickly as possible depending on - system capacity. + A transformation to apply to text that is identified as a specific + info_type. + type: object properties: - refreshFrequency: - type: string - enumDescriptions: - - Unspecified. - - After the data profile is created, it will never be updated. - - The data profile can be updated up to once every 24 hours. - - The data profile can be updated up to once every 30 days. Default. - enum: - - UPDATE_FREQUENCY_UNSPECIFIED - - UPDATE_FREQUENCY_NEVER - - UPDATE_FREQUENCY_DAILY - - UPDATE_FREQUENCY_MONTHLY - description: >- - Frequency at which profiles should be updated, regardless of whether - the underlying resource has changed. Defaults to never. - tableModifiedCadence: - description: Governs when to update data profiles when a table is modified. - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryTableModifiedCadence' - inspectTemplateModifiedCadence: + infoTypes: description: >- - Governs when to update data profiles when the inspection rules - defined by the `InspectTemplate` change. If not set, changing the - template will not cause a data profile to update. - $ref: >- - #/components/schemas/GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence - schemaModifiedCadence: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2DiscoverySchemaModifiedCadence - description: Governs when to update data profiles when a schema is modified. - type: object - GooglePrivacyDlpV2InspectDataSourceDetails: + InfoTypes to apply the transformation to. An empty list will cause + this transformation to apply to all findings that correspond to + infoTypes that were requested in `InspectConfig`. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + primitiveTransformation: + description: Required. Primitive transformation to apply to the infoType. + $ref: '#/components/schemas/GooglePrivacyDlpV2PrimitiveTransformation' + GooglePrivacyDlpV2PrimitiveTransformation: + id: GooglePrivacyDlpV2PrimitiveTransformation + description: A rule for transforming a value. type: object - description: The results of an inspect DataSource job. properties: - result: - $ref: '#/components/schemas/GooglePrivacyDlpV2Result' - description: A summary of the outcome of this inspection job. - requestedOptions: - description: The configuration used for this job. - $ref: '#/components/schemas/GooglePrivacyDlpV2RequestedOptions' - id: GooglePrivacyDlpV2InspectDataSourceDetails - GooglePrivacyDlpV2CryptoKey: + replaceConfig: + description: Replace with a specified value. + $ref: '#/components/schemas/GooglePrivacyDlpV2ReplaceValueConfig' + redactConfig: + description: Redact + $ref: '#/components/schemas/GooglePrivacyDlpV2RedactConfig' + characterMaskConfig: + description: Mask + $ref: '#/components/schemas/GooglePrivacyDlpV2CharacterMaskConfig' + cryptoReplaceFfxFpeConfig: + description: >- + Ffx-Fpe. Strongly discouraged, consider using + CryptoDeterministicConfig instead. Fpe is computationally expensive + incurring latency costs. + $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig' + fixedSizeBucketingConfig: + description: Fixed size bucketing + $ref: '#/components/schemas/GooglePrivacyDlpV2FixedSizeBucketingConfig' + bucketingConfig: + description: Bucketing + $ref: '#/components/schemas/GooglePrivacyDlpV2BucketingConfig' + replaceWithInfoTypeConfig: + description: Replace with infotype + $ref: '#/components/schemas/GooglePrivacyDlpV2ReplaceWithInfoTypeConfig' + timePartConfig: + description: Time extraction + $ref: '#/components/schemas/GooglePrivacyDlpV2TimePartConfig' + cryptoHashConfig: + description: Crypto + $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoHashConfig' + dateShiftConfig: + description: Date Shift + $ref: '#/components/schemas/GooglePrivacyDlpV2DateShiftConfig' + cryptoDeterministicConfig: + description: Deterministic Crypto + $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoDeterministicConfig' + replaceDictionaryConfig: + description: >- + Replace with a value randomly drawn (with replacement) from a + dictionary. + $ref: '#/components/schemas/GooglePrivacyDlpV2ReplaceDictionaryConfig' + GooglePrivacyDlpV2ReplaceValueConfig: + id: GooglePrivacyDlpV2ReplaceValueConfig + description: Replace each input value with a given `Value`. + type: object properties: - kmsWrapped: - description: Key wrapped using Cloud KMS - $ref: '#/components/schemas/GooglePrivacyDlpV2KmsWrappedCryptoKey' - transient: - $ref: '#/components/schemas/GooglePrivacyDlpV2TransientCryptoKey' - description: Transient crypto key - unwrapped: - $ref: '#/components/schemas/GooglePrivacyDlpV2UnwrappedCryptoKey' - description: Unwrapped crypto key - id: GooglePrivacyDlpV2CryptoKey + newValue: + description: Value to replace it with. + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + GooglePrivacyDlpV2RedactConfig: + id: GooglePrivacyDlpV2RedactConfig description: >- - This is a data encryption key (DEK) (as opposed to a key encryption key - (KEK) stored by Cloud Key Management Service (Cloud KMS). When using - Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM - policy on the KEK to ensure an attacker cannot unwrap the DEK. + Redact a given value. For example, if used with an + `InfoTypeTransformation` transforming PHONE_NUMBER, and input 'My phone + number is 206-555-0123', the output would be 'My phone number is '. type: object - GooglePrivacyDlpV2PublishToSecurityCommandCenter: properties: {} - id: GooglePrivacyDlpV2PublishToSecurityCommandCenter - type: object + GooglePrivacyDlpV2CharacterMaskConfig: + id: GooglePrivacyDlpV2CharacterMaskConfig description: >- - If set, a summary finding will be created or updated in Security Command - Center for each profile. - GooglePrivacyDlpV2AnalyzeDataSourceRiskDetails: - id: GooglePrivacyDlpV2AnalyzeDataSourceRiskDetails - description: Result of a risk analysis operation request. - properties: - deltaPresenceEstimationResult: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeltaPresenceEstimationResult' - description: Delta-presence result - kMapEstimationResult: - description: K-map result - $ref: '#/components/schemas/GooglePrivacyDlpV2KMapEstimationResult' - categoricalStatsResult: - $ref: '#/components/schemas/GooglePrivacyDlpV2CategoricalStatsResult' - description: Categorical stats result - requestedOptions: - $ref: '#/components/schemas/GooglePrivacyDlpV2RequestedRiskAnalysisOptions' - description: The configuration used for this job. - requestedPrivacyMetric: - $ref: '#/components/schemas/GooglePrivacyDlpV2PrivacyMetric' - description: Privacy metric to compute. - numericalStatsResult: - description: Numerical stats result - $ref: '#/components/schemas/GooglePrivacyDlpV2NumericalStatsResult' - kAnonymityResult: - $ref: '#/components/schemas/GooglePrivacyDlpV2KAnonymityResult' - description: K-anonymity result - lDiversityResult: - description: L-divesity result - $ref: '#/components/schemas/GooglePrivacyDlpV2LDiversityResult' - requestedSourceTable: - description: Input dataset to compute metrics over. - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' - type: object - GooglePrivacyDlpV2DiscoveryTarget: - id: GooglePrivacyDlpV2DiscoveryTarget + Partially mask a string by replacing a given number of characters with a + fixed character. Masking can start from the beginning or end of the + string. This can be used on data of any type (numbers, longs, and so on) + and when de-identifying structured data we'll attempt to preserve the + original data's type. (This allows you to take a long like 123 and + modify it to a string like **3. type: object - description: Target used to match against for Discovery. properties: - cloudStorageTarget: - $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStorageDiscoveryTarget' - description: >- - Cloud Storage target for Discovery. The first target to match a - table will be the one applied. - secretsTarget: - $ref: '#/components/schemas/GooglePrivacyDlpV2SecretsDiscoveryTarget' - description: >- - Discovery target that looks for credentials and secrets stored in - cloud resource metadata and reports them as vulnerabilities to - Security Command Center. Only one target of this type is allowed. - cloudSqlTarget: - $ref: '#/components/schemas/GooglePrivacyDlpV2CloudSqlDiscoveryTarget' + maskingCharacter: description: >- - Cloud SQL target for Discovery. The first target to match a table - will be the one applied. - bigQueryTarget: - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryDiscoveryTarget' + Character to use to mask the sensitive values—for example, `*` for + an alphabetic string such as a name, or `0` for a numeric string + such as ZIP code or credit card number. This string must have a + length of 1. If not supplied, this value defaults to `*` for + strings, and `0` for digits. + type: string + numberToMask: description: >- - BigQuery target for Discovery. The first target to match a table - will be the one applied. - otherCloudTarget: - $ref: '#/components/schemas/GooglePrivacyDlpV2OtherCloudDiscoveryTarget' + Number of characters to mask. If not set, all matching chars will be + masked. Skipped characters do not count towards this tally. If + `number_to_mask` is negative, this denotes inverse masking. Cloud + DLP masks all but a number of characters. For example, suppose you + have the following values: - `masking_character` is `*` - + `number_to_mask` is `-4` - `reverse_order` is `false` - + `CharsToIgnore` includes `-` - Input string is `1234-5678-9012-3456` + The resulting de-identified string is `****-****-****-3456`. Cloud + DLP masks all but the last four characters. If `reverse_order` is + `true`, all but the first four characters are masked as + `1234-****-****-****`. + type: integer + format: int32 + reverseOrder: description: >- - Other clouds target for discovery. The first target to match a - resource will be the one applied. - GooglePrivacyDlpV2DataSourceType: - properties: - dataSource: - readOnly: true - type: string + Mask characters in reverse order. For example, if + `masking_character` is `0`, `number_to_mask` is `14`, and + `reverse_order` is `false`, then the input string + `1234-5678-9012-3456` is masked as `00000000000000-3456`. If + `masking_character` is `*`, `number_to_mask` is `3`, and + `reverse_order` is `true`, then the string `12345` is masked as + `12***`. + type: boolean + charactersToIgnore: description: >- - Output only. An identifying string to the type of resource being - profiled. Current values: * google/bigquery/table * google/project * - google/sql/table * google/gcs/bucket - id: GooglePrivacyDlpV2DataSourceType - description: Message used to identify the type of resource being profiled. - type: object - GooglePrivacyDlpV2SecretManagerCredential: - type: object + When masking a string, items in this list will be skipped when + replacing characters. For example, if the input string is + `555-555-5555` and you instruct Cloud DLP to skip `-` and mask 5 + characters with `*`, Cloud DLP returns `***-**5-5555`. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2CharsToIgnore' + GooglePrivacyDlpV2CharsToIgnore: + id: GooglePrivacyDlpV2CharsToIgnore description: >- - A credential consisting of a username and password, where the password - is stored in a Secret Manager resource. Note: Secret Manager [charges - apply](https://cloud.google.com/secret-manager/pricing). + Characters to skip when doing deidentification of a value. These will be + left alone and skipped. + type: object properties: - passwordSecretVersionName: + charactersToSkip: + description: Characters to not transform when masking. type: string + commonCharactersToIgnore: description: >- - Required. The name of the Secret Manager resource that stores the - password, in the form - `projects/project-id/secrets/secret-name/versions/version`. - username: - description: Required. The username. - type: string - id: GooglePrivacyDlpV2SecretManagerCredential - GooglePrivacyDlpV2LargeCustomDictionaryStats: - properties: - approxNumPhrases: - description: Approximate number of distinct phrases in the dictionary. + Common characters to not transform when masking. Useful to avoid + removing punctuation. type: string - format: int64 - id: GooglePrivacyDlpV2LargeCustomDictionaryStats - description: Summary statistics of a custom dictionary. - type: object - GooglePrivacyDlpV2SecretsDiscoveryTarget: + enumDescriptions: + - Unused. + - 0-9 + - A-Z + - a-z + - US Punctuation, one of !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~ + - Whitespace character, one of [ \t\n\x0B\f\r] + enum: + - COMMON_CHARS_TO_IGNORE_UNSPECIFIED + - NUMERIC + - ALPHA_UPPER_CASE + - ALPHA_LOWER_CASE + - PUNCTUATION + - WHITESPACE + GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig: + id: GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig description: >- - Discovery target for credentials and secrets in cloud resource metadata. - This target does not include any filtering or frequency controls. Cloud - DLP will scan cloud resource metadata for secrets daily. No inspect - template should be included in the discovery config for a security - benchmarks scan. Instead, the built-in list of secrets and credentials - infoTypes will be used (see - https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). - Credentials and secrets discovered will be reported as vulnerabilities - to Security Command Center. - properties: {} - type: object - id: GooglePrivacyDlpV2SecretsDiscoveryTarget - GooglePrivacyDlpV2ActivateJobTriggerRequest: - description: Request message for ActivateJobTrigger. - type: object - id: GooglePrivacyDlpV2ActivateJobTriggerRequest - properties: {} - GooglePrivacyDlpV2KindExpression: + Replaces an identifier with a surrogate using Format Preserving + Encryption (FPE) with the FFX mode of operation; however when used in + the `ReidentifyContent` API method, it serves the opposite function by + reversing the surrogate back into the original identifier. The + identifier must be encoded as ASCII. For a given crypto key and context, + the same identifier will be replaced with the same surrogate. + Identifiers must be at least two characters long. In the case that the + identifier is the empty string, it will be skipped. See + https://cloud.google.com/sensitive-data-protection/docs/pseudonymization + to learn more. Note: We recommend using CryptoDeterministicConfig for + all use cases which do not require preserving the input alphabet space + and size, plus warrant referential integrity. FPE incurs significant + latency costs. type: object - id: GooglePrivacyDlpV2KindExpression - description: A representation of a Datastore kind. properties: - name: + cryptoKey: + description: Required. The key used by the encryption algorithm. + $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoKey' + context: + description: >- + The 'tweak', a context may be used for higher security since the + same identifier in two different contexts won't be given the same + surrogate. If the context is not set, a default tweak will be used. + If the context is set but: 1. there is no record present when + transforming a given value or 1. the field is not present when + transforming a given value, a default tweak will be used. Note that + case (1) is expected when an `InfoTypeTransformation` is applied to + both structured and unstructured `ContentItem`s. Currently, the + referenced field may be of value type integer or string. The tweak + is constructed as a sequence of bytes in big endian byte order such + that: - a 64 bit integer is encoded followed by a single byte of + value 1 - a string is encoded in UTF-8 format followed by a single + byte of value 2 + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + commonAlphabet: + description: Common alphabets. type: string - description: The name of the kind. - GooglePrivacyDlpV2SelectedInfoTypes: - properties: - infoTypes: + enumDescriptions: + - Unused. + - '`[0-9]` (radix of 10)' + - '`[0-9A-F]` (radix of 16)' + - '`[0-9A-Z]` (radix of 36)' + - '`[0-9A-Za-z]` (radix of 62)' + enum: + - FFX_COMMON_NATIVE_ALPHABET_UNSPECIFIED + - NUMERIC + - HEXADECIMAL + - UPPER_CASE_ALPHA_NUMERIC + - ALPHA_NUMERIC + customAlphabet: description: >- - Required. InfoTypes to apply the transformation to. Required. - Provided InfoType must be unique within the ImageTransformations - message. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - type: array - description: Apply transformation to the selected info_types. + This is supported by mapping these to the alphanumeric characters + that the FFX mode natively supports. This happens before/after + encryption/decryption. Each character listed must appear only once. + Number of characters must be in the range [2, 95]. This must be + encoded as ASCII. The order of characters does not matter. The full + list of allowed characters is: + ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` + type: string + radix: + description: The native way to select the alphabet. Must be in the range [2, 95]. + type: integer + format: int32 + surrogateInfoType: + description: >- + The custom infoType to annotate the surrogate with. This annotation + will be applied to the surrogate by prefixing it with the name of + the custom infoType followed by the number of characters comprising + the surrogate. The following scheme defines the format: + info_type_name(surrogate_character_count):surrogate For example, if + the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the + surrogate is 'abc', the full replacement value will be: + 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate + when inspecting content using the custom infoType + [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). + This facilitates reversal of the surrogate when it occurs in free + text. In order for inspection to work properly, the name of this + infoType must not occur naturally anywhere in your data; otherwise, + inspection may find a surrogate that does not correspond to an + actual identifier. Therefore, choose your custom infoType name + carefully after considering what your data looks like. One way to + select a name that has a high chance of yielding reliable detection + is to include one or more unicode characters that are highly + improbable to exist in your data. For example, assuming your data is + entered from a regular ASCII keyboard, the symbol with the hex code + point 29DD might be used like so: ⧝MY_TOKEN_TYPE + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + GooglePrivacyDlpV2CryptoKey: + id: GooglePrivacyDlpV2CryptoKey + description: >- + This is a data encryption key (DEK) (as opposed to a key encryption key + (KEK) stored by Cloud Key Management Service (Cloud KMS). When using + Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM + policy on the KEK to ensure an attacker cannot unwrap the DEK. type: object - id: GooglePrivacyDlpV2SelectedInfoTypes - GooglePrivacyDlpV2KMapEstimationResult: + properties: + transient: + description: Transient crypto key + $ref: '#/components/schemas/GooglePrivacyDlpV2TransientCryptoKey' + unwrapped: + description: Unwrapped crypto key + $ref: '#/components/schemas/GooglePrivacyDlpV2UnwrappedCryptoKey' + kmsWrapped: + description: Key wrapped using Cloud KMS + $ref: '#/components/schemas/GooglePrivacyDlpV2KmsWrappedCryptoKey' + GooglePrivacyDlpV2TransientCryptoKey: + id: GooglePrivacyDlpV2TransientCryptoKey + description: >- + Use this to have a random data crypto key generated. It will be + discarded after the request finishes. type: object - id: GooglePrivacyDlpV2KMapEstimationResult properties: - kMapEstimationHistogram: - type: array + name: description: >- - The intervals [min_anonymity, max_anonymity] do not overlap. If a - value doesn't correspond to any such interval, the associated - frequency is zero. For example, the following records: - {min_anonymity: 1, max_anonymity: 1, frequency: 17} {min_anonymity: - 2, max_anonymity: 3, frequency: 42} {min_anonymity: 5, - max_anonymity: 10, frequency: 99} mean that there are no record with - an estimated anonymity of 4, 5, or larger than 10. - items: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2KMapEstimationHistogramBucket + Required. Name of the key. This is an arbitrary string used to + differentiate different keys. A unique key is generated per name: + two separate `TransientCryptoKey` protos share the same generated + key if their names are the same. When the data crypto key is + generated, this name is not used in any way (repeating the api call + will result in a different key being generated). + type: string + GooglePrivacyDlpV2UnwrappedCryptoKey: + id: GooglePrivacyDlpV2UnwrappedCryptoKey description: >- - Result of the reidentifiability analysis. Note that these results are an - estimation, not exact values. - GooglePrivacyDlpV2RecordTransformation: - description: The field in a record to transform. + Using raw keys is prone to security risks due to accidentally leaking + the key. Choose another type of key if possible. type: object - id: GooglePrivacyDlpV2RecordTransformation properties: - containerTimestamp: - type: string - format: google-datetime - description: Findings container modification timestamp, if applicable. - containerVersion: - description: Container version, if available ("generation" for Cloud Storage). + key: + description: Required. A 128/192/256 bit key. type: string - fieldId: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - description: For record transformations, provide a field. - GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence: - type: object + format: byte + GooglePrivacyDlpV2KmsWrappedCryptoKey: + id: GooglePrivacyDlpV2KmsWrappedCryptoKey description: >- - The cadence at which to update data profiles when the inspection rules - defined by the `InspectTemplate` change. + Include to use an existing data crypto key wrapped by KMS. The wrapped + key must be a 128-, 192-, or 256-bit key. Authorization requires the + following IAM permissions when sending a request to perform a crypto + transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more + information, see [Creating a wrapped key] + (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). + Note: When you use Cloud KMS for cryptographic operations, [charges + apply](https://cloud.google.com/kms/pricing). + type: object properties: - frequency: - enumDescriptions: - - Unspecified. - - After the data profile is created, it will never be updated. - - The data profile can be updated up to once every 24 hours. - - The data profile can be updated up to once every 30 days. Default. + wrappedKey: + description: Required. The wrapped data crypto key. + type: string + format: byte + cryptoKeyName: description: >- - How frequently data profiles can be updated when the template is - modified. Defaults to never. - enum: - - UPDATE_FREQUENCY_UNSPECIFIED - - UPDATE_FREQUENCY_NEVER - - UPDATE_FREQUENCY_DAILY - - UPDATE_FREQUENCY_MONTHLY + Required. The resource name of the KMS CryptoKey to use for + unwrapping. type: string - id: GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence - GooglePrivacyDlpV2PublishFindingsToCloudDataCatalog: - id: GooglePrivacyDlpV2PublishFindingsToCloudDataCatalog + GooglePrivacyDlpV2FixedSizeBucketingConfig: + id: GooglePrivacyDlpV2FixedSizeBucketingConfig description: >- - Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag - templates are applied to the resource that Cloud DLP scanned. Data - Catalog tag templates are stored in the same project and region where - the BigQuery table exists. For Cloud DLP to create and apply the tag - template, the Cloud DLP service agent must have the - `roles/datacatalog.tagTemplateOwner` permission on the project. The tag - template contains fields summarizing the results of the DlpJob. Any - field values previously written by another DlpJob are deleted. InfoType - naming patterns are strictly enforced when using this feature. Findings - are persisted in Data Catalog storage and are governed by - service-specific policies for Data Catalog. For more information, see - [Service Specific Terms](https://cloud.google.com/terms/service-terms). - Only a single instance of this action can be specified. This action is - allowed only if all resources being scanned are BigQuery tables. - Compatible with: Inspect - type: object - properties: {} - GooglePrivacyDlpV2CloudStorageOptions: + Buckets values based on fixed size ranges. The Bucketing transformation + can provide all of this functionality, but requires more configuration. + This message is provided as a convenience to the user for simple + bucketing strategies. The transformed value will be a hyphenated string + of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and + upper_bound = 20, all values that are within this bucket will be + replaced with "10-20". This can be used on data of type: double, long. + If the bound Value type differs from the type of data being transformed, + we will first attempt converting the type of the data to be transformed + to match the type of the bound before comparing. See + https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing + to learn more. type: object - id: GooglePrivacyDlpV2CloudStorageOptions - description: Options defining a file or a set of files within a Cloud Storage bucket. properties: - bytesLimitPerFile: - type: string - format: int64 + lowerBound: description: >- - Max number of bytes to scan from a file. If a scanned file's size is - bigger than this value then the rest of the bytes are omitted. Only - one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can - be specified. This field can't be set if de-identification is - requested. For certain file types, setting this field has no effect. - For more information, see [Limits on bytes scanned per - file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). - filesLimitPercent: - type: integer + Required. Lower bound value of buckets. All values less than + `lower_bound` are grouped together into a single bucket; for example + if `lower_bound` = 10, then all values less than 10 are replaced + with the value "-10". + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + upperBound: description: >- - Limits the number of files to scan to this percentage of the input - FileSet. Number of files scanned is rounded down. Must be between 0 - and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. - format: int32 - sampleMethod: - enum: - - SAMPLE_METHOD_UNSPECIFIED - - TOP - - RANDOM_START - description: How to sample the data. - type: string - enumDescriptions: - - No sampling. - - Scan from the top (default). - - >- - For each file larger than bytes_limit_per_file, randomly pick the - offset to start scanning. The scanned bytes are contiguous. - bytesLimitPerFilePercent: - description: >- - Max percentage of bytes to scan from a file. The rest are omitted. - The number of bytes scanned is rounded down. Must be between 0 and - 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only - one of bytes_limit_per_file and bytes_limit_per_file_percent can be - specified. This field can't be set if de-identification is - requested. For certain file types, setting this field has no effect. - For more information, see [Limits on bytes scanned per - file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). - type: integer - format: int32 - fileSet: - description: The set of one or more files to scan. - $ref: '#/components/schemas/GooglePrivacyDlpV2FileSet' - fileTypes: + Required. Upper bound value of buckets. All values greater than + upper_bound are grouped together into a single bucket; for example + if `upper_bound` = 89, then all values greater than 89 are replaced + with the value "89+". + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + bucketSize: description: >- - List of file type groups to include in the scan. If empty, all files - are scanned and available data format processors are applied. In - addition, the binary content of the selected files is always scanned - as well. Images are scanned only as binary if the specified region - does not support image inspection and no file_types were specified. - Image inspection is restricted to 'global', 'us', 'asia', and - 'europe'. - items: - enumDescriptions: - - Includes all files. - - >- - Includes all file extensions not covered by another entry. - Binary scanning attempts to convert the content of the file to - utf_8 to scan the file. If you wish to avoid this fall back, - specify one or more of the other file types in your storage - scan. - - >- - Included file extensions: asc,asp, aspx, brf, c, cc,cfm, cgi, - cpp, csv, cxx, c++, cs, css, dart, dat, dot, eml,, epbub, ged, - go, h, hh, hpp, hxx, h++, hs, html, htm, mkd, markdown, m, ml, - mli, perl, pl, plist, pm, php, phtml, pht, properties, py, pyw, - rb, rbw, rs, rss, rc, scala, sh, sql, swift, tex, shtml, shtm, - xhtml, lhs, ics, ini, java, js, json, jsonl, kix, kml, ocaml, - md, txt, text, tsv, vb, vcard, vcs, wml, xcodeproj, xml, xsl, - xsd, yml, yaml. - - >- - Included file extensions: bmp, gif, jpg, jpeg, jpe, png. Setting - bytes_limit_per_file or bytes_limit_per_file_percent has no - effect on image files. Image inspection is restricted to the - `global`, `us`, `asia`, and `europe` regions. - - >- - Microsoft Word files larger than 30 MB will be scanned as binary - files. Included file extensions: docx, dotx, docm, dotm. Setting - `bytes_limit_per_file` or `bytes_limit_per_file_percent` has no - effect on Word files. - - >- - PDF files larger than 30 MB will be scanned as binary files. - Included file extensions: pdf. Setting `bytes_limit_per_file` or - `bytes_limit_per_file_percent` has no effect on PDF files. - - 'Included file extensions: avro' - - 'Included file extensions: csv' - - 'Included file extensions: tsv' - - >- - Microsoft PowerPoint files larger than 30 MB will be scanned as - binary files. Included file extensions: pptx, pptm, potx, potm, - pot. Setting `bytes_limit_per_file` or - `bytes_limit_per_file_percent` has no effect on PowerPoint - files. - - >- - Microsoft Excel files larger than 30 MB will be scanned as - binary files. Included file extensions: xlsx, xlsm, xltx, xltm. - Setting `bytes_limit_per_file` or `bytes_limit_per_file_percent` - has no effect on Excel files. - type: string - enum: - - FILE_TYPE_UNSPECIFIED - - BINARY_FILE - - TEXT_FILE - - IMAGE - - WORD - - PDF - - AVRO - - CSV - - TSV - - POWERPOINT - - EXCEL + Required. Size of each bucket (except for minimum and maximum + buckets). So if `lower_bound` = 10, `upper_bound` = 89, and + `bucket_size` = 10, then the following buckets would be used: -10, + 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. + Precision up to 2 decimals works. + type: number + format: double + GooglePrivacyDlpV2BucketingConfig: + id: GooglePrivacyDlpV2BucketingConfig + description: >- + Generalization function that buckets values based on ranges. The ranges + and replacement values are dynamically provided by the user for custom + behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can + be used on data of type: number, long, string, timestamp. If the bound + `Value` type differs from the type of data being transformed, we will + first attempt converting the type of the data to be transformed to match + the type of the bound before comparing. See + https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing + to learn more. + type: object + properties: + buckets: + description: Set of buckets. Ranges must be non-overlapping. type: array - GooglePrivacyDlpV2ThrowError: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Bucket' + GooglePrivacyDlpV2Bucket: + id: GooglePrivacyDlpV2Bucket + description: Bucket is represented as a range, along with replacement values. + type: object + properties: + min: + description: >- + Lower bound of the range, inclusive. Type should be the same as max + if used. + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + max: + description: Upper bound of the range, exclusive; type must match min. + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + replacementValue: + description: Required. Replacement value for this bucket. + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + GooglePrivacyDlpV2ReplaceWithInfoTypeConfig: + id: GooglePrivacyDlpV2ReplaceWithInfoTypeConfig + description: Replace each matching finding with the name of the info_type. type: object - description: Throw an error and fail the request when a transformation error occurs. - id: GooglePrivacyDlpV2ThrowError properties: {} - GooglePrivacyDlpV2DiscoveryOtherCloudGenerationCadence: + GooglePrivacyDlpV2TimePartConfig: + id: GooglePrivacyDlpV2TimePartConfig description: >- - How often existing resources should have their profiles refreshed. New - resources are scanned as quickly as possible depending on system - capacity. + For use with `Date`, `Timestamp`, and `TimeOfDay`, extract or preserve a + portion of the value. + type: object properties: - refreshFrequency: + partToExtract: + description: The part of the time to keep. type: string enumDescriptions: - - Unspecified. - - After the data profile is created, it will never be updated. - - The data profile can be updated up to once every 24 hours. - - The data profile can be updated up to once every 30 days. Default. - description: >- - Optional. Frequency to update profiles regardless of whether the - underlying resource has changes. Defaults to never. + - Unused + - '[0-9999]' + - '[1-12]' + - '[1-31]' + - '[1-7]' + - '[1-53]' + - '[0-23]' enum: - - UPDATE_FREQUENCY_UNSPECIFIED - - UPDATE_FREQUENCY_NEVER - - UPDATE_FREQUENCY_DAILY - - UPDATE_FREQUENCY_MONTHLY - inspectTemplateModifiedCadence: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence - description: >- - Optional. Governs when to update data profiles when the inspection - rules defined by the `InspectTemplate` change. If not set, changing - the template will not cause a data profile to update. + - TIME_PART_UNSPECIFIED + - YEAR + - MONTH + - DAY_OF_MONTH + - DAY_OF_WEEK + - WEEK_OF_YEAR + - HOUR_OF_DAY + GooglePrivacyDlpV2CryptoHashConfig: + id: GooglePrivacyDlpV2CryptoHashConfig + description: >- + Pseudonymization method that generates surrogates via cryptographic + hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. + Outputs a base64 encoded representation of the hashed output (for + example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only + string and integer values can be hashed. See + https://cloud.google.com/sensitive-data-protection/docs/pseudonymization + to learn more. type: object - id: GooglePrivacyDlpV2DiscoveryOtherCloudGenerationCadence - GooglePrivacyDlpV2OtherCloudSingleResourceReference: - description: Identifies a single resource, like a single Amazon S3 bucket. properties: - amazonS3Bucket: - description: Amazon S3 bucket. - $ref: '#/components/schemas/GooglePrivacyDlpV2AmazonS3Bucket' + cryptoKey: + description: The key used by the hash function. + $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoKey' + GooglePrivacyDlpV2DateShiftConfig: + id: GooglePrivacyDlpV2DateShiftConfig + description: >- + Shifts dates by random number of days, with option to be consistent for + the same context. See + https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting + to learn more. type: object - id: GooglePrivacyDlpV2OtherCloudSingleResourceReference - GooglePrivacyDlpV2ByteContentItem: - id: GooglePrivacyDlpV2ByteContentItem properties: - type: + upperBoundDays: description: >- - The type of data stored in the bytes string. Default will be - TEXT_UTF8. - enumDescriptions: - - Unused - - Any image type. - - jpeg - - bmp - - png - - svg - - plain text - - docx, docm, dotx, dotm - - pdf - - pptx, pptm, potx, potm, pot - - xlsx, xlsm, xltx, xltm - - avro - - csv - - tsv - - Audio file types. Only used for profiling. - - Video file types. Only used for profiling. - - Executable file types. Only used for profiling. - type: string - enum: - - BYTES_TYPE_UNSPECIFIED - - IMAGE - - IMAGE_JPEG - - IMAGE_BMP - - IMAGE_PNG - - IMAGE_SVG - - TEXT_UTF8 - - WORD_DOCUMENT - - PDF - - POWERPOINT_DOCUMENT - - EXCEL_DOCUMENT - - AVRO - - CSV - - TSV - - AUDIO - - VIDEO - - EXECUTABLE - data: - description: Content data to inspect or redact. - type: string - format: byte - type: object - description: Container for bytes to inspect or redact. - GooglePrivacyDlpV2CloudSqlDiscoveryTarget: - id: GooglePrivacyDlpV2CloudSqlDiscoveryTarget - description: Target used to match against for discovery with Cloud SQL tables. + Required. Range of shift in days. Actual shift will be selected at + random within this range (inclusive ends). Negative means shift to + earlier in time. Must not be more than 365250 days (1000 years) each + direction. For example, 3 means shift date to at most 3 days into + the future. + type: integer + format: int32 + lowerBoundDays: + description: >- + Required. For example, -5 means shift date to at most 5 days back in + the past. + type: integer + format: int32 + context: + description: >- + Points to the field that contains the context, for example, an + entity id. If set, must also set cryptoKey. If set, shift will be + consistent for the given context. + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + cryptoKey: + description: >- + Causes the shift to be computed based on this key and the context. + This results in the same shift for the same context and crypto_key. + If set, must also set context. Can only be applied to table items. + $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoKey' + GooglePrivacyDlpV2CryptoDeterministicConfig: + id: GooglePrivacyDlpV2CryptoDeterministicConfig + description: >- + Pseudonymization method that generates deterministic encryption for the + given input. Outputs a base64 encoded representation of the encrypted + output. Uses AES-SIV based on the RFC + https://tools.ietf.org/html/rfc5297. type: object properties: - conditions: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryCloudSqlConditions' + cryptoKey: description: >- - In addition to matching the filter, these conditions must be true - before a profile is generated. - disabled: - $ref: '#/components/schemas/GooglePrivacyDlpV2Disabled' - description: Disable profiling for database resources that match this filter. - filter: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryCloudSqlFilter' + The key used by the encryption function. For deterministic + encryption using AES-SIV, the provided key is internally expanded to + 64 bytes prior to use. + $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoKey' + surrogateInfoType: description: >- - Required. The tables the discovery cadence applies to. The first - target with a matching filter will be the one to apply to a table. - generationCadence: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2DiscoveryCloudSqlGenerationCadence + The custom info type to annotate the surrogate with. This annotation + will be applied to the surrogate by prefixing it with the name of + the custom info type followed by the number of characters comprising + the surrogate. The following scheme defines the format: {info type + name}({surrogate character count}):{surrogate} For example, if the + name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate + is 'abc', the full replacement value will be: + 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate + when inspecting content using the custom info type 'Surrogate'. This + facilitates reversal of the surrogate when it occurs in free text. + Note: For record transformations where the entire cell in a table is + being transformed, surrogates are not mandatory. Surrogates are used + to denote the location of the token and are necessary for + re-identification in free form text. In order for inspection to work + properly, the name of this info type must not occur naturally + anywhere in your data; otherwise, inspection may either - reverse a + surrogate that does not correspond to an actual identifier - be + unable to parse the surrogate and result in an error Therefore, + choose your custom info type name carefully after considering what + your data looks like. One way to select a name that has a high + chance of yielding reliable detection is to include one or more + unicode characters that are highly improbable to exist in your data. + For example, assuming your data is entered from a regular ASCII + keyboard, the symbol with the hex code point 29DD might be used like + so: ⧝MY_TOKEN_TYPE. + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + context: description: >- - How often and when to update profiles. New tables that match both - the filter and conditions are scanned as quickly as possible - depending on system capacity. - GooglePrivacyDlpV2InspectResult: - description: All the findings for a single scanned item. - id: GooglePrivacyDlpV2InspectResult + A context may be used for higher security and maintaining + referential integrity such that the same identifier in two different + contexts will be given a distinct surrogate. The context is appended + to plaintext value being encrypted. On decryption the provided + context is validated against the value used during encryption. If a + context was provided during encryption, same context must be + provided during decryption as well. If the context is not set, + plaintext would be used as is for encryption. If the context is set + but: 1. there is no record present when transforming a given value + or 2. the field is not present when transforming a given value, + plaintext would be used as is for encryption. Note that case (1) is + expected when an `InfoTypeTransformation` is applied to both + structured and unstructured `ContentItem`s. + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + GooglePrivacyDlpV2ReplaceDictionaryConfig: + id: GooglePrivacyDlpV2ReplaceDictionaryConfig + description: >- + Replace each input value with a value randomly selected from the + dictionary. type: object properties: - findingsTruncated: - type: boolean + wordList: description: >- - If true, then this item might have more findings than were returned, - and the findings returned are an arbitrary subset of all findings. - The findings list might be truncated because the input items were - too large, or because the server reached the maximum amount of - resources allowed for a single API call. For best results, divide - the input into smaller batches. - findings: + A list of words to select from for random replacement. The + [limits](https://cloud.google.com/sensitive-data-protection/limits) + page contains details about the size limits of dictionaries. + $ref: '#/components/schemas/GooglePrivacyDlpV2WordList' + GooglePrivacyDlpV2RecordTransformations: + id: GooglePrivacyDlpV2RecordTransformations + description: >- + A type of transformation that is applied over structured data such as a + table. + type: object + properties: + fieldTransformations: + description: Transform the record by applying various field transformations. + type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Finding' + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldTransformation' + recordSuppressions: + description: >- + Configuration defining which records get suppressed entirely. + Records that match any suppression rule are omitted from the output. type: array - description: List of findings for an item. - GooglePrivacyDlpV2RecordLocation: - properties: - tableLocation: - $ref: '#/components/schemas/GooglePrivacyDlpV2TableLocation' - description: Location within a `ContentItem.Table`. - recordKey: - $ref: '#/components/schemas/GooglePrivacyDlpV2RecordKey' - description: Key of the finding. - fieldId: - description: Field id of the field containing the finding. - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2RecordSuppression' + GooglePrivacyDlpV2FieldTransformation: + id: GooglePrivacyDlpV2FieldTransformation + description: The transformation to apply to the field. type: object - description: Location of a finding within a row or record. - id: GooglePrivacyDlpV2RecordLocation - GooglePrivacyDlpV2FileStoreInfoTypeSummary: - id: GooglePrivacyDlpV2FileStoreInfoTypeSummary properties: - infoType: - description: The InfoType seen. - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - description: Information regarding the discovered InfoType. + fields: + description: >- + Required. Input field(s) to apply the transformation to. When you + have columns that reference their position within a list, omit the + index from the FieldId. FieldId name matching ignores the index. For + example, instead of "contact.nums[0].type", use "contact.nums.type". + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + condition: + description: >- + Only apply the transformation if the condition evaluates to true for + the given `RecordCondition`. The conditions are allowed to reference + fields that are not used in the actual transformation. Example Use + Cases: - Apply a different bucket transformation to an age column if + the zip code column for the same record is within a specific range. + - Redact a field if the date of birth field is greater than 85. + $ref: '#/components/schemas/GooglePrivacyDlpV2RecordCondition' + primitiveTransformation: + description: Apply the transformation to the entire field. + $ref: '#/components/schemas/GooglePrivacyDlpV2PrimitiveTransformation' + infoTypeTransformations: + description: >- + Treat the contents of the field as free text, and selectively + transform content that matches an `InfoType`. + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeTransformations' + GooglePrivacyDlpV2RecordCondition: + id: GooglePrivacyDlpV2RecordCondition + description: >- + A condition for determining whether a transformation should be applied + to a field. type: object - GooglePrivacyDlpV2DiscoveryOtherCloudConditions: - id: GooglePrivacyDlpV2DiscoveryOtherCloudConditions + properties: + expressions: + description: An expression. + $ref: '#/components/schemas/GooglePrivacyDlpV2Expressions' + GooglePrivacyDlpV2Expressions: + id: GooglePrivacyDlpV2Expressions + description: An expression, consisting of an operator and conditions. type: object properties: - minAge: + logicalOperator: description: >- - Minimum age a resource must be before Cloud DLP can profile it. - Value must be 1 hour or greater. + The operator to apply to the result of conditions. Default and + currently only supported value is `AND`. type: string - format: google-duration - amazonS3BucketConditions: - $ref: '#/components/schemas/GooglePrivacyDlpV2AmazonS3BucketConditions' - description: Amazon S3 bucket conditions. - description: >- - Requirements that must be true before a resource is profiled for the - first time. - GooglePrivacyDlpV2CreateInspectTemplateRequest: + enumDescriptions: + - Unused + - Conditional AND + enum: + - LOGICAL_OPERATOR_UNSPECIFIED + - AND + conditions: + description: Conditions to apply to the expression. + $ref: '#/components/schemas/GooglePrivacyDlpV2Conditions' + GooglePrivacyDlpV2Conditions: + id: GooglePrivacyDlpV2Conditions + description: A collection of conditions. + type: object properties: - inspectTemplate: - description: Required. The InspectTemplate to create. - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' - templateId: - type: string - description: >- - The template id can contain uppercase and lowercase letters, - numbers, and hyphens; that is, it must match the regular expression: - `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty - to allow the system to generate one. - locationId: - type: string - description: Deprecated. This field has no effect. - description: Request message for CreateInspectTemplate. - type: object - id: GooglePrivacyDlpV2CreateInspectTemplateRequest - GooglePrivacyDlpV2CancelDlpJobRequest: - description: The request message for canceling a DLP job. - type: object - properties: {} - id: GooglePrivacyDlpV2CancelDlpJobRequest - GooglePrivacyDlpV2UpdateJobTriggerRequest: + conditions: + description: A collection of conditions. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Condition' + GooglePrivacyDlpV2Condition: + id: GooglePrivacyDlpV2Condition + description: >- + The field type of `value` and `field` do not need to match to be + considered equal, but not all comparisons are possible. EQUAL_TO and + NOT_EQUAL_TO attempt to compare even with incompatible types, but all + other comparisons are invalid with incompatible types. A `value` of + type: - `string` can be compared against all other types - `boolean` can + only be compared against other booleans - `integer` can be compared + against doubles or a string if the string value can be parsed as an + integer. - `double` can be compared against integers or a string if the + string can be parsed as a double. - `Timestamp` can be compared against + strings in RFC 3339 date string format. - `TimeOfDay` can be compared + against timestamps and strings in the format of 'HH:mm:ss'. If we fail + to compare do to type mismatch, a warning will be given and the + condition will evaluate to false. type: object - description: Request message for UpdateJobTrigger. - id: GooglePrivacyDlpV2UpdateJobTriggerRequest properties: - updateMask: - format: google-fieldmask + field: + description: >- + Required. Field within the record this condition is evaluated + against. + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + operator: + description: >- + Required. Operator used to compare the field or infoType to the + value. type: string - description: Mask to control which fields get updated. - jobTrigger: - $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' - description: New JobTrigger value. - GooglePrivacyDlpV2DateTime: - properties: - timeZone: - $ref: '#/components/schemas/GooglePrivacyDlpV2TimeZone' - description: Time zone - dayOfWeek: enumDescriptions: - - The day of the week is unspecified. - - Monday - - Tuesday - - Wednesday - - Thursday - - Friday - - Saturday - - Sunday - enum: - - DAY_OF_WEEK_UNSPECIFIED - - MONDAY - - TUESDAY - - WEDNESDAY - - THURSDAY - - FRIDAY - - SATURDAY - - SUNDAY - description: Day of week - type: string - date: - description: >- - One or more of the following must be set. Must be a valid date or - time value. - $ref: '#/components/schemas/GoogleTypeDate' - time: - description: Time of day - $ref: '#/components/schemas/GoogleTypeTimeOfDay' - id: GooglePrivacyDlpV2DateTime - description: Message for a date time object. e.g. 2018-01-01, 5th August. - type: object - GooglePrivacyDlpV2FileClusterType: - type: object - description: Message used to identify file cluster type being profiled. - properties: - cluster: - description: Cluster type. + - Unused + - Equal. Attempts to match even with incompatible types. + - Not equal to. Attempts to match even with incompatible types. + - Greater than. + - Less than. + - Greater than or equals. + - Less than or equals. + - Exists enum: - - CLUSTER_UNSPECIFIED - - CLUSTER_UNKNOWN - - CLUSTER_TEXT - - CLUSTER_STRUCTURED_DATA - - CLUSTER_SOURCE_CODE - - CLUSTER_RICH_DOCUMENT - - CLUSTER_IMAGE - - CLUSTER_ARCHIVE - - CLUSTER_MULTIMEDIA - - CLUSTER_EXECUTABLE - enumDescriptions: - - Unused. - - Unsupported files. - - Plain text. - - Structured data like CSV, TSV etc. - - Source code. - - Rich document like docx, xlsx etc. - - Images like jpeg, bmp. - - Archives and containers like .zip, .tar etc. - - Multimedia like .mp4, .avi etc. - - Executable files like .exe, .class, .apk etc. - type: string - id: GooglePrivacyDlpV2FileClusterType - GooglePrivacyDlpV2DiscoveryCloudStorageGenerationCadence: + - RELATIONAL_OPERATOR_UNSPECIFIED + - EQUAL_TO + - NOT_EQUAL_TO + - GREATER_THAN + - LESS_THAN + - GREATER_THAN_OR_EQUALS + - LESS_THAN_OR_EQUALS + - EXISTS + value: + description: Value to compare against. [Mandatory, except for `EXISTS` tests.] + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + GooglePrivacyDlpV2RecordSuppression: + id: GooglePrivacyDlpV2RecordSuppression + description: >- + Configuration to suppress records whose suppression conditions evaluate + to true. type: object - id: GooglePrivacyDlpV2DiscoveryCloudStorageGenerationCadence properties: - refreshFrequency: - enumDescriptions: - - Unspecified. - - After the data profile is created, it will never be updated. - - The data profile can be updated up to once every 24 hours. - - The data profile can be updated up to once every 30 days. Default. - description: >- - Optional. Data changes in Cloud Storage can't trigger reprofiling. - If you set this field, profiles are refreshed at this frequency - regardless of whether the underlying buckets have changed. Defaults - to never. - type: string - enum: - - UPDATE_FREQUENCY_UNSPECIFIED - - UPDATE_FREQUENCY_NEVER - - UPDATE_FREQUENCY_DAILY - - UPDATE_FREQUENCY_MONTHLY - inspectTemplateModifiedCadence: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence + condition: description: >- - Optional. Governs when to update data profiles when the inspection - rules defined by the `InspectTemplate` change. If not set, changing - the template will not cause a data profile to update. - description: >- - How often existing buckets should have their profiles refreshed. New - buckets are scanned as quickly as possible depending on system capacity. - GooglePrivacyDlpV2ListStoredInfoTypesResponse: - description: Response message for ListStoredInfoTypes. - id: GooglePrivacyDlpV2ListStoredInfoTypesResponse + A condition that when it evaluates to true will result in the record + being evaluated to be suppressed from the transformed content. + $ref: '#/components/schemas/GooglePrivacyDlpV2RecordCondition' + GooglePrivacyDlpV2ImageTransformations: + id: GooglePrivacyDlpV2ImageTransformations + description: A type of transformation that is applied over images. type: object properties: - storedInfoTypes: + transforms: + description: List of transforms to make. type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: '#/components/schemas/GooglePrivacyDlpV2ImageTransformation' + GooglePrivacyDlpV2ImageTransformation: + id: GooglePrivacyDlpV2ImageTransformation + description: Configuration for determining how redaction of images should occur. + type: object + properties: + selectedInfoTypes: + description: Apply transformation to the selected info_types. + $ref: '#/components/schemas/GooglePrivacyDlpV2SelectedInfoTypes' + allInfoTypes: description: >- - List of storedInfoTypes, up to page_size in - ListStoredInfoTypesRequest. - nextPageToken: + Apply transformation to all findings not specified in other + ImageTransformation's selected_info_types. Only one instance is + allowed within the ImageTransformations message. + $ref: '#/components/schemas/GooglePrivacyDlpV2AllInfoTypes' + allText: description: >- - If the next page is available then the next page token to be used in - the following ListStoredInfoTypes request. - type: string - GooglePrivacyDlpV2ListDeidentifyTemplatesResponse: - properties: - nextPageToken: - type: string + Apply transformation to all text that doesn't match an infoType. + Only one instance is allowed within the ImageTransformations + message. + $ref: '#/components/schemas/GooglePrivacyDlpV2AllText' + redactionColor: description: >- - If the next page is available then the next page token to be used in - the following ListDeidentifyTemplates request. - deidentifyTemplates: + The color to use when redacting content from an image. If not + specified, the default is black. + $ref: '#/components/schemas/GooglePrivacyDlpV2Color' + GooglePrivacyDlpV2SelectedInfoTypes: + id: GooglePrivacyDlpV2SelectedInfoTypes + description: Apply transformation to the selected info_types. + type: object + properties: + infoTypes: description: >- - List of deidentify templates, up to page_size in - ListDeidentifyTemplatesRequest. + Required. InfoTypes to apply the transformation to. Required. + Provided InfoType must be unique within the ImageTransformations + message. type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + GooglePrivacyDlpV2AllInfoTypes: + id: GooglePrivacyDlpV2AllInfoTypes + description: Apply transformation to all findings. type: object - id: GooglePrivacyDlpV2ListDeidentifyTemplatesResponse - description: Response message for ListDeidentifyTemplates. - GooglePrivacyDlpV2DiscoveryCloudStorageFilter: + properties: {} + GooglePrivacyDlpV2AllText: + id: GooglePrivacyDlpV2AllText + description: Apply to all text. + type: object + properties: {} + GooglePrivacyDlpV2TransformationErrorHandling: + id: GooglePrivacyDlpV2TransformationErrorHandling description: >- - Determines which buckets will have profiles generated within an - organization or project. Includes the ability to filter by regular - expression patterns on project ID and bucket name. + How to handle transformation errors during de-identification. A + transformation error occurs when the requested transformation is + incompatible with the data. For example, trying to de-identify an IP + address using a `DateShift` transformation would result in a + transformation error, since date info cannot be extracted from an IP + address. Information about any incompatible transformations, and how + they were handled, is returned in the response as part of the + `TransformationOverviews`. type: object properties: - others: - $ref: '#/components/schemas/GooglePrivacyDlpV2AllOtherResources' - description: >- - Optional. Catch-all. This should always be the last target in the - list because anything above it will apply first. Should only appear - once in a configuration. If none is specified, a default one will be - added automatically. - cloudStorageResourceReference: - $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStorageResourceReference' - description: >- - Optional. The bucket to scan. Targets including this can only - include one target (the target with this bucket). This enables - profiling the contents of a single bucket, while the other options - allow for easy profiling of many bucets within a project or an - organization. - collection: - $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreCollection' - description: Optional. A specific set of buckets for this filter to apply to. - id: GooglePrivacyDlpV2DiscoveryCloudStorageFilter - GooglePrivacyDlpV2DataRiskLevel: + throwError: + description: Throw an error + $ref: '#/components/schemas/GooglePrivacyDlpV2ThrowError' + leaveUntransformed: + description: Ignore errors + $ref: '#/components/schemas/GooglePrivacyDlpV2LeaveUntransformed' + GooglePrivacyDlpV2ThrowError: + id: GooglePrivacyDlpV2ThrowError + description: Throw an error and fail the request when a transformation error occurs. + type: object + properties: {} + GooglePrivacyDlpV2LeaveUntransformed: + id: GooglePrivacyDlpV2LeaveUntransformed description: >- - Score is a summary of all elements in the data profile. A higher number - means more risk. - id: GooglePrivacyDlpV2DataRiskLevel + Skips the data without modifying it if the requested transformation + would cause an error. For example, if a `DateShift` transformation were + applied an an IP address, this mode would leave the IP address unchanged + in the response. type: object - properties: - score: - type: string - enumDescriptions: - - Unused. - - >- - Low risk - Lower indication of sensitive data that appears to have - additional access restrictions in place or no indication of - sensitive data found. - - Unable to determine risk. - - >- - Medium risk - Sensitive data may be present but additional access - or fine grain access restrictions appear to be present. Consider - limiting access even further or transform data to mask. - - >- - High risk – SPII may be present. Access controls may include - public ACLs. Exfiltration of data may lead to user data loss. - Re-identification of users may be possible. Consider limiting - usage and or removing SPII. - description: The score applied to the resource. - enum: - - RISK_SCORE_UNSPECIFIED - - RISK_LOW - - RISK_UNKNOWN - - RISK_MODERATE - - RISK_HIGH - GooglePrivacyDlpV2PrivacyMetric: - description: Privacy metric to compute for reidentification risk analysis. - properties: - kMapEstimationConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2KMapEstimationConfig' - description: k-map - numericalStatsConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2NumericalStatsConfig' - description: Numerical stats - categoricalStatsConfig: - description: Categorical stats - $ref: '#/components/schemas/GooglePrivacyDlpV2CategoricalStatsConfig' - kAnonymityConfig: - description: K-anonymity - $ref: '#/components/schemas/GooglePrivacyDlpV2KAnonymityConfig' - lDiversityConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2LDiversityConfig' - description: l-diversity - deltaPresenceEstimationConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeltaPresenceEstimationConfig' - description: delta-presence + properties: {} + GooglePrivacyDlpV2DeidentifyContentResponse: + id: GooglePrivacyDlpV2DeidentifyContentResponse + description: Results of de-identifying a ContentItem. type: object - id: GooglePrivacyDlpV2PrivacyMetric - GooglePrivacyDlpV2UpdateConnectionRequest: properties: - connection: - $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' - description: Required. The connection with new values for the relevant fields. - updateMask: - type: string - format: google-fieldmask - description: Optional. Mask to control which fields get updated. - id: GooglePrivacyDlpV2UpdateConnectionRequest - type: object - description: Request message for UpdateConnection. - GooglePrivacyDlpV2HybridInspectDlpJobRequest: - id: GooglePrivacyDlpV2HybridInspectDlpJobRequest - description: Request to search for potentially sensitive info in a custom location. + item: + description: The de-identified item. + $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' + overview: + description: An overview of the changes that were made on the `item`. + $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationOverview' + GooglePrivacyDlpV2TransformationOverview: + id: GooglePrivacyDlpV2TransformationOverview + description: Overview of the modifications that occurred. type: object properties: - hybridItem: - $ref: '#/components/schemas/GooglePrivacyDlpV2HybridContentItem' - description: The item to inspect. - GooglePrivacyDlpV2ListDiscoveryConfigsResponse: - id: GooglePrivacyDlpV2ListDiscoveryConfigsResponse - description: Response message for ListDiscoveryConfigs. - properties: - nextPageToken: + transformedBytes: + description: Total size in bytes that were transformed in some way. type: string - description: >- - If the next page is available then this value is the next page token - to be used in the following ListDiscoveryConfigs request. - discoveryConfigs: + format: int64 + transformationSummaries: + description: Transformations applied to the dataset. type: array - description: List of configs, up to page_size in ListDiscoveryConfigsRequest. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' - type: object - GooglePrivacyDlpV2CategoricalStatsResult: - description: Result of the categorical stats computation. + $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationSummary' + GooglePrivacyDlpV2TransformationSummary: + id: GooglePrivacyDlpV2TransformationSummary + description: >- + Summary of a single transformation. Only one of 'transformation', + 'field_transformation', or 'record_suppress' will be set. type: object - id: GooglePrivacyDlpV2CategoricalStatsResult properties: - valueFrequencyHistogramBuckets: - items: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2CategoricalStatsHistogramBucket + infoType: + description: Set if the transformation was limited to a specific InfoType. + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + field: + description: Set if the transformation was limited to a specific FieldId. + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + transformation: + description: The specific transformation these stats apply to. + $ref: '#/components/schemas/GooglePrivacyDlpV2PrimitiveTransformation' + fieldTransformations: + description: >- + The field transformation that was applied. If multiple field + transformations are requested for a single field, this list will + contain all of them; otherwise, only one is supplied. type: array - description: Histogram of value frequencies in the column. - GooglePrivacyDlpV2KAnonymityResult: - type: object - id: GooglePrivacyDlpV2KAnonymityResult - properties: - equivalenceClassHistogramBuckets: items: - $ref: '#/components/schemas/GooglePrivacyDlpV2KAnonymityHistogramBucket' - description: Histogram of k-anonymity equivalence classes. + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldTransformation' + recordSuppress: + description: The specific suppression option these stats apply to. + $ref: '#/components/schemas/GooglePrivacyDlpV2RecordSuppression' + results: + description: Collection of all transformations that took place or had an error. type: array - description: Result of the k-anonymity computation. - GooglePrivacyDlpV2FileStoreRegexes: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2SummaryResult' + transformedBytes: + description: Total size in bytes that were transformed in some way. + type: string + format: int64 + GooglePrivacyDlpV2SummaryResult: + id: GooglePrivacyDlpV2SummaryResult description: >- - A collection of regular expressions to determine what file store to - match against. + A collection that informs the user the number of times a particular + `TransformationResultCode` and error details occurred. + type: object properties: - patterns: - type: array + count: + description: Number of transformations counted by this result. + type: string + format: int64 + code: + description: Outcome of the transformation. + type: string + enumDescriptions: + - Unused + - Transformation completed without an error. + - Transformation had an error. + enum: + - TRANSFORMATION_RESULT_CODE_UNSPECIFIED + - SUCCESS + - ERROR + details: description: >- - Required. The group of regular expression patterns to match against - one or more file stores. Maximum of 100 entries. The sum of all - regular expression's length can't exceed 10 KiB. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreRegex' - id: GooglePrivacyDlpV2FileStoreRegexes - type: object - GooglePrivacyDlpV2RequestedDeidentifyOptions: + A place for warnings or errors to show up if a transformation didn't + work as expected. + type: string + GooglePrivacyDlpV2ReidentifyContentRequest: + id: GooglePrivacyDlpV2ReidentifyContentRequest + description: Request to re-identify an item. type: object - id: GooglePrivacyDlpV2RequestedDeidentifyOptions - description: De-identification options. properties: - snapshotDeidentifyTemplate: + reidentifyConfig: description: >- - Snapshot of the state of the `DeidentifyTemplate` from the - Deidentify action at the time this job was run. - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' - snapshotStructuredDeidentifyTemplate: + Configuration for the re-identification of the content item. This + field shares the same proto message type that is used for + de-identification, however its usage here is for the reversal of the + previous de-identification. Re-identification is performed by + examining the transformations used to de-identify the items and + executing the reverse. This requires that only reversible + transformations be provided here. The reversible transformations + are: - `CryptoDeterministicConfig` - `CryptoReplaceFfxFpeConfig` + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyConfig' + inspectConfig: + description: Configuration for the inspector. + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' + item: + description: The item to re-identify. Will be treated as text. + $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' + inspectTemplateName: description: >- - Snapshot of the state of the structured `DeidentifyTemplate` from - the `Deidentify` action at the time this job was run. - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' - snapshotImageRedactTemplate: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + Template to use. Any configuration directly specified in + `inspect_config` will override those set in the template. Singular + fields that are set in this request will replace their corresponding + fields in the template. Repeated fields are appended. Singular + sub-messages and groups are recursively merged. + type: string + reidentifyTemplateName: description: >- - Snapshot of the state of the image transformation - `DeidentifyTemplate` from the `Deidentify` action at the time this - job was run. - GooglePrivacyDlpV2CreateConnectionRequest: - description: Request message for CreateConnection. - properties: - connection: - $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' - description: Required. The connection resource. - id: GooglePrivacyDlpV2CreateConnectionRequest + Template to use. References an instance of `DeidentifyTemplate`. Any + configuration directly specified in `reidentify_config` or + `inspect_config` will override those set in the template. The + `DeidentifyTemplate` used must include only reversible + transformations. Singular fields that are set in this request will + replace their corresponding fields in the template. Repeated fields + are appended. Singular sub-messages and groups are recursively + merged. + type: string + locationId: + description: Deprecated. This field has no effect. + type: string + GooglePrivacyDlpV2ReidentifyContentResponse: + id: GooglePrivacyDlpV2ReidentifyContentResponse + description: Results of re-identifying an item. type: object - GooglePrivacyDlpV2NumericalStatsConfig: properties: - field: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - description: >- - Field to compute numerical stats on. Supported types are integer, - float, date, datetime, timestamp, time. + item: + description: The re-identified item. + $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' + overview: + description: An overview of the changes that were made to the `item`. + $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationOverview' + GooglePrivacyDlpV2ListInfoTypesResponse: + id: GooglePrivacyDlpV2ListInfoTypesResponse + description: Response to the ListInfoTypes request. type: object - id: GooglePrivacyDlpV2NumericalStatsConfig - description: >- - Compute numerical stats over an individual column, including min, max, - and quantiles. - GooglePrivacyDlpV2OtherCloudResourceRegexes: properties: - patterns: + infoTypes: + description: Set of sensitive infoTypes. type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2OtherCloudResourceRegex' - description: >- - A group of regular expression patterns to match against one or more - resources. Maximum of 100 entries. The sum of all regular - expression's length can't exceed 10 KiB. - description: >- - A collection of regular expressions to determine what resources to match - against. - id: GooglePrivacyDlpV2OtherCloudResourceRegexes - type: object - GooglePrivacyDlpV2PrimitiveTransformation: - type: object - id: GooglePrivacyDlpV2PrimitiveTransformation - properties: - characterMaskConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2CharacterMaskConfig' - description: Mask - cryptoDeterministicConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoDeterministicConfig' - description: Deterministic Crypto - replaceWithInfoTypeConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2ReplaceWithInfoTypeConfig' - description: Replace with infotype - cryptoHashConfig: - description: Crypto - $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoHashConfig' - cryptoReplaceFfxFpeConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig' - description: Ffx-Fpe - dateShiftConfig: - description: Date Shift - $ref: '#/components/schemas/GooglePrivacyDlpV2DateShiftConfig' - fixedSizeBucketingConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2FixedSizeBucketingConfig' - description: Fixed size bucketing - timePartConfig: - description: Time extraction - $ref: '#/components/schemas/GooglePrivacyDlpV2TimePartConfig' - replaceDictionaryConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2ReplaceDictionaryConfig' - description: >- - Replace with a value randomly drawn (with replacement) from a - dictionary. - bucketingConfig: - description: Bucketing - $ref: '#/components/schemas/GooglePrivacyDlpV2BucketingConfig' - replaceConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2ReplaceValueConfig' - description: Replace with a specified value. - redactConfig: - description: Redact - $ref: '#/components/schemas/GooglePrivacyDlpV2RedactConfig' - description: A rule for transforming a value. - GooglePrivacyDlpV2StoredInfoTypeStats: - description: Statistics for a StoredInfoType. - properties: - largeCustomDictionary: - $ref: '#/components/schemas/GooglePrivacyDlpV2LargeCustomDictionaryStats' - description: >- - StoredInfoType where findings are defined by a dictionary of - phrases. + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeDescription' + GooglePrivacyDlpV2InfoTypeDescription: + id: GooglePrivacyDlpV2InfoTypeDescription + description: InfoType description. type: object - id: GooglePrivacyDlpV2StoredInfoTypeStats - GooglePrivacyDlpV2LDiversityConfig: - id: GooglePrivacyDlpV2LDiversityConfig - description: l-diversity metric, used for analysis of reidentification risk. properties: - quasiIds: + name: + description: Internal name of the infoType. + type: string + displayName: + description: Human readable form of the infoType name. + type: string + supportedBy: + description: Which parts of the API supports this InfoType. type: array - description: >- - Set of quasi-identifiers indicating how equivalence classes are - defined for the l-diversity computation. When multiple fields are - specified, they are considered a single composite key. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - sensitiveAttribute: - description: Sensitive field for computing the l-value. - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - type: object - GooglePrivacyDlpV2FileStoreCollection: - description: Match file stores (e.g. buckets) using regex filters. - id: GooglePrivacyDlpV2FileStoreCollection - properties: - includeRegexes: + type: string + enumDescriptions: + - Unused. + - Supported by the inspect operations. + - Supported by the risk analysis operations. + enum: + - ENUM_TYPE_UNSPECIFIED + - INSPECT + - RISK_ANALYSIS + description: description: >- - Optional. A collection of regular expressions to match a file store - against. - $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreRegexes' - type: object - GooglePrivacyDlpV2LeaveUntransformed: - properties: {} - description: >- - Skips the data without modifying it if the requested transformation - would cause an error. For example, if a `DateShift` transformation were - applied an an IP address, this mode would leave the IP address unchanged - in the response. - id: GooglePrivacyDlpV2LeaveUntransformed - type: object - GooglePrivacyDlpV2CustomInfoType: - type: object - description: >- - Custom information type provided by the user. Used to find - domain-specific sensitive information configurable to the data in - question. - properties: - likelihood: + Description of the infotype. Translated when language is provided in + the request. type: string - enum: - - LIKELIHOOD_UNSPECIFIED - - VERY_UNLIKELY - - UNLIKELY - - POSSIBLE - - LIKELY - - VERY_LIKELY - enumDescriptions: - - Default value; same as POSSIBLE. - - Highest chance of a false positive. - - High chance of a false positive. - - Some matching signals. The default value. - - Low chance of a false positive. - - Confidence level is high. Lowest chance of a false positive. - description: >- - Likelihood to return for this CustomInfoType. This base value can be - altered by a detection rule if the finding meets the criteria - specified by the rule. Defaults to `VERY_LIKELY` if not specified. - regex: - description: Regular expression based CustomInfoType. - $ref: '#/components/schemas/GooglePrivacyDlpV2Regex' - detectionRules: + locationSupport: + description: Locations at which this feature can be used. May change over time. + $ref: '#/components/schemas/GooglePrivacyDlpV2LocationSupport' + example: + description: A sample that is a true positive for this infoType. + type: string + versions: + description: A list of available versions for the infotype. type: array - description: >- - Set of detection rules to apply to all findings of this - CustomInfoType. Rules are applied in order that they are specified. - Not supported for the `surrogate_type` CustomInfoType. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2DetectionRule' - dictionary: - $ref: '#/components/schemas/GooglePrivacyDlpV2Dictionary' - description: A list of phrases to detect as a CustomInfoType. - surrogateType: - description: >- - Message for detecting output from deidentification transformations - that support reversing. - $ref: '#/components/schemas/GooglePrivacyDlpV2SurrogateType' + $ref: '#/components/schemas/GooglePrivacyDlpV2VersionDescription' + categories: + description: The category of the infoType. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeCategory' sensitivityScore: + description: The default sensitivity of the infoType. $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' + specificInfoTypes: description: >- - Sensitivity for this CustomInfoType. If this CustomInfoType extends - an existing InfoType, the sensitivity here will take precedence over - that of the original InfoType. If unset for a CustomInfoType, it - will default to HIGH. This only applies to data profiling. - infoType: - description: >- - CustomInfoType can either be a new infoType, or an extension of - built-in infoType, when the name matches one of existing infoTypes - and that infoType is specified in `InspectContent.info_types` field. - Specifying the latter adds findings to the one detected by the - system. If built-in info type is not specified in - `InspectContent.info_types` list then the name is treated as a - custom info type. - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - exclusionType: + If this field is set, this infoType is a general infoType and these + specific infoTypes are contained within it. General infoTypes are + infoTypes that encompass multiple specific infoTypes. For example, + the "GEOGRAPHIC_DATA" general infoType would have set for this field + "LOCATION", "LOCATION_COORDINATES", and "STREET_ADDRESS". + type: array + items: + type: string + GooglePrivacyDlpV2LocationSupport: + id: GooglePrivacyDlpV2LocationSupport + description: Locations at which a feature can be used. + type: object + properties: + regionalizationScope: description: >- - If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a - finding to be returned. It still can be used for rules matching. + The current scope for location on this feature. This may expand over + time. + type: string enumDescriptions: + - Invalid. - >- - A finding of this custom info type will not be excluded from - results. - - >- - A finding of this custom info type will be excluded from final - results, but can still affect rule execution. - type: string + Feature may be used with one or more regions. See locations for + details. + - Feature may be used anywhere. Default value. enum: - - EXCLUSION_TYPE_UNSPECIFIED - - EXCLUSION_TYPE_EXCLUDE - storedType: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredType' + - REGIONALIZATION_SCOPE_UNSPECIFIED + - REGIONAL + - ANY_LOCATION + locations: description: >- - Load an existing `StoredInfoType` resource for use in - `InspectDataSource`. Not currently supported in `InspectContent`. - id: GooglePrivacyDlpV2CustomInfoType - GooglePrivacyDlpV2AmazonS3BucketRegex: - id: GooglePrivacyDlpV2AmazonS3BucketRegex - description: Amazon S3 bucket regex. - properties: - bucketNameRegex: - type: string - description: >- - Optional. Regex to test the bucket name against. If empty, all - buckets match. - awsAccountRegex: - $ref: '#/components/schemas/GooglePrivacyDlpV2AwsAccountRegex' - description: The AWS account regex. - type: object - GooglePrivacyDlpV2AuxiliaryTable: - properties: - relativeFrequency: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - description: >- - Required. The relative frequency column must contain a - floating-point number between 0 and 1 (inclusive). Null values are - assumed to be zero. - quasiIds: - description: Required. Quasi-identifier columns. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2QuasiIdField' + Specific locations where the feature may be used. Examples: + us-central1, us, asia, global If scope is ANY_LOCATION, no regions + will be listed. type: array - table: - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' - description: Required. Auxiliary table location. - id: GooglePrivacyDlpV2AuxiliaryTable + items: + type: string + GooglePrivacyDlpV2VersionDescription: + id: GooglePrivacyDlpV2VersionDescription + description: Details about each available version for an infotype. type: object - description: >- - An auxiliary table contains statistical information on the relative - frequency of different quasi-identifiers values. It has one or several - quasi-identifiers columns, and one column that indicates the relative - frequency of each quasi-identifier tuple. If a tuple is present in the - data but not in the auxiliary table, the corresponding relative - frequency is assumed to be zero (and thus, the tuple is highly - reidentifiable). - GooglePrivacyDlpV2LDiversityHistogramBucket: properties: - bucketValueCount: - description: Total number of distinct equivalence classes in this bucket. - type: string - format: int64 - bucketSize: - format: int64 - type: string - description: Total number of equivalence classes in this bucket. - sensitiveValueFrequencyUpperBound: - description: >- - Upper bound on the sensitive value frequencies of the equivalence - classes in this bucket. - format: int64 + version: + description: Name of the version type: string - bucketValues: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2LDiversityEquivalenceClass' - type: array - description: >- - Sample of equivalence classes in this bucket. The total number of - classes returned per bucket is capped at 20. - sensitiveValueFrequencyLowerBound: + description: + description: Description of the version. type: string - description: >- - Lower bound on the sensitive value frequencies of the equivalence - classes in this bucket. - format: int64 - id: GooglePrivacyDlpV2LDiversityHistogramBucket - type: object - description: Histogram of l-diversity equivalence class sensitive value frequencies. - GooglePrivacyDlpV2TableDataProfile: - id: GooglePrivacyDlpV2TableDataProfile + GooglePrivacyDlpV2InfoTypeCategory: + id: GooglePrivacyDlpV2InfoTypeCategory + description: >- + Classification of infoTypes to organize them according to geographic + location, industry, and data type. type: object - description: The profile for a scanned table. properties: - resourceLabels: - type: object + locationCategory: description: >- - The labels applied to the resource at the time the profile was - generated. - additionalProperties: - type: string - name: - type: string - description: The name of the profile. - dataSourceType: - $ref: '#/components/schemas/GooglePrivacyDlpV2DataSourceType' - description: The resource type that was profiled. - lastModifiedTime: - description: The time when this table was last modified - format: google-datetime + The region or country that issued the ID or document represented by + the infoType. type: string - predictedInfoTypes: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeSummary' - type: array - description: The infoTypes predicted from this table's data. - rowCount: + enumDescriptions: + - Unused location + - >- + The infoType is not issued by or tied to a specific region, but is + used almost everywhere. + - The infoType is typically used in Argentina. + - The infoType is typically used in Armenia. + - The infoType is typically used in Australia. + - The infoType is typically used in Austria. + - The infoType is typically used in Azerbaijan. + - The infoType is typically used in Belarus. + - The infoType is typically used in Belgium. + - The infoType is typically used in Brazil. + - The infoType is typically used in Canada. + - The infoType is typically used in Chile. + - The infoType is typically used in China. + - The infoType is typically used in Colombia. + - The infoType is typically used in Croatia. + - The infoType is typically used in Czechia. + - The infoType is typically used in Denmark. + - The infoType is typically used in France. + - The infoType is typically used in Finland. + - The infoType is typically used in Germany. + - The infoType is typically used in Hong Kong. + - The infoType is typically used in India. + - The infoType is typically used in Indonesia. + - The infoType is typically used in Ireland. + - The infoType is typically used in Israel. + - The infoType is typically used in Italy. + - The infoType is typically used in Japan. + - The infoType is typically used in Kazakhstan. + - The infoType is typically used in Korea. + - The infoType is typically used in Mexico. + - The infoType is typically used in the Netherlands. + - The infoType is typically used in New Zealand. + - The infoType is typically used in Norway. + - The infoType is typically used in Paraguay. + - The infoType is typically used in Peru. + - The infoType is typically used in Poland. + - The infoType is typically used in Portugal. + - The infoType is typically used in Russia. + - The infoType is typically used in Singapore. + - The infoType is typically used in South Africa. + - The infoType is typically used in Spain. + - The infoType is typically used in Sweden. + - The infoType is typically used in Switzerland. + - The infoType is typically used in Taiwan. + - The infoType is typically used in Thailand. + - The infoType is typically used in Turkey. + - The infoType is typically used in Ukraine. + - The infoType is typically used in the United Kingdom. + - The infoType is typically used in the United States. + - The infoType is typically used in Uruguay. + - The infoType is typically used in Uzbekistan. + - The infoType is typically used in Venezuela. + - The infoType is typically used in Google internally. + enum: + - LOCATION_UNSPECIFIED + - GLOBAL + - ARGENTINA + - ARMENIA + - AUSTRALIA + - AUSTRIA + - AZERBAIJAN + - BELARUS + - BELGIUM + - BRAZIL + - CANADA + - CHILE + - CHINA + - COLOMBIA + - CROATIA + - CZECHIA + - DENMARK + - FRANCE + - FINLAND + - GERMANY + - HONG_KONG + - INDIA + - INDONESIA + - IRELAND + - ISRAEL + - ITALY + - JAPAN + - KAZAKHSTAN + - KOREA + - MEXICO + - THE_NETHERLANDS + - NEW_ZEALAND + - NORWAY + - PARAGUAY + - PERU + - POLAND + - PORTUGAL + - RUSSIA + - SINGAPORE + - SOUTH_AFRICA + - SPAIN + - SWEDEN + - SWITZERLAND + - TAIWAN + - THAILAND + - TURKEY + - UKRAINE + - UNITED_KINGDOM + - UNITED_STATES + - URUGUAY + - UZBEKISTAN + - VENEZUELA + - INTERNAL + industryCategory: description: >- - Number of rows in the table when the profile was generated. This - will not be populated for BigLake tables. + The group of relevant businesses where this infoType is commonly + used type: string - format: int64 - resourceVisibility: + enumDescriptions: + - Unused industry + - The infoType is typically used in the finance industry. + - The infoType is typically used in the health industry. + - The infoType is typically used in the telecommunications industry. enum: - - RESOURCE_VISIBILITY_UNSPECIFIED - - RESOURCE_VISIBILITY_PUBLIC - - RESOURCE_VISIBILITY_INCONCLUSIVE - - RESOURCE_VISIBILITY_RESTRICTED - description: How broadly a resource has been shared. + - INDUSTRY_UNSPECIFIED + - FINANCE + - HEALTH + - TELECOMMUNICATIONS + typeCategory: + description: The class of identifiers where this infoType belongs type: string enumDescriptions: - - Unused. - - Visible to any user. + - Unused type - >- - May contain public items. For example, if a Cloud Storage bucket - has uniform bucket level access disabled, some objects inside it - may be public, but none are known yet. - - Visible only to specific users. - sensitivityScore: - $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' - description: The sensitivity score of this table. - datasetProjectId: - type: string - description: The Google Cloud project ID that owns the resource. - tableSizeBytes: - description: The size of the table when the profile was generated. - type: string - format: int64 - profileStatus: - $ref: '#/components/schemas/GooglePrivacyDlpV2ProfileStatus' - description: >- - Success or error status from the most recent profile generation - attempt. May be empty if the profile is still being generated. - encryptionStatus: - enumDescriptions: - - Unused. - - Google manages server-side encryption keys on your behalf. - - Customer provides the key. + Personally identifiable information, for example, a name or phone + number + - >- + Personally identifiable information that is especially sensitive, + for example, a passport number. + - >- + Attributes that can partially identify someone, especially in + combination with other attributes, like age, height, and gender. + - Confidential or secret information, for example, a password. + - An identification document issued by a government. + - A document, for example, a resume or source code. + - >- + Information that is not sensitive on its own, but provides details + about the circumstances surrounding an entity or an event. + - Category for `CustomInfoType` types. enum: - - ENCRYPTION_STATUS_UNSPECIFIED - - ENCRYPTION_GOOGLE_MANAGED - - ENCRYPTION_CUSTOMER_MANAGED - description: How the table is encrypted. - type: string - createTime: - format: google-datetime + - TYPE_UNSPECIFIED + - PII + - SPII + - DEMOGRAPHIC + - CREDENTIAL + - GOVERNMENT_ID + - DOCUMENT + - CONTEXTUAL_INFORMATION + - CUSTOM + GooglePrivacyDlpV2CreateInspectTemplateRequest: + id: GooglePrivacyDlpV2CreateInspectTemplateRequest + description: Request message for CreateInspectTemplate. + type: object + properties: + inspectTemplate: + description: Required. The InspectTemplate to create. + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + templateId: + description: >- + The template id can contain uppercase and lowercase letters, + numbers, and hyphens; that is, it must match the regular expression: + `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty + to allow the system to generate one. type: string - description: The time at which the table was created. - datasetLocation: + locationId: + description: Deprecated. This field has no effect. type: string + GooglePrivacyDlpV2InspectTemplate: + id: GooglePrivacyDlpV2InspectTemplate + description: >- + The inspectTemplate contains a configuration (set of types of sensitive + data to be detected) to be used anywhere you otherwise would normally + specify InspectConfig. See + https://cloud.google.com/sensitive-data-protection/docs/concepts-templates + to learn more. + type: object + properties: + name: description: >- - If supported, the location where the dataset's data is stored. See - https://cloud.google.com/bigquery/docs/locations for supported - locations. - configSnapshot: - $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileConfigSnapshot' - description: The snapshot of the configurations used to generate the profile. - profileLastGenerated: + Output only. The template name. The template will have one of the + following formats: + `projects/PROJECT_ID/inspectTemplates/TEMPLATE_ID` OR + `organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID`; + readOnly: true type: string - format: google-datetime - description: The last time the profile was generated. - tableId: + displayName: + description: Display name (max 256 chars). type: string - description: The table ID. - failedColumnCount: - format: int64 + description: + description: Short description (max 256 chars). type: string - description: The number of columns skipped in the table because of an error. - dataRiskLevel: - $ref: '#/components/schemas/GooglePrivacyDlpV2DataRiskLevel' - description: The data risk level of this table. - expirationTime: - description: Optional. The time when this table expires. - format: google-datetime + createTime: + description: Output only. The creation timestamp of an inspectTemplate. + readOnly: true type: string - fullResource: + format: google-datetime + updateTime: + description: Output only. The last update timestamp of an inspectTemplate. + readOnly: true type: string + format: google-datetime + inspectConfig: description: >- - The Cloud Asset Inventory resource that was profiled in order to - generate this TableDataProfile. - https://cloud.google.com/apis/design/resource_names#full_resource_name - otherInfoTypes: - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2OtherInfoTypeSummary' - description: Other infoTypes found in this table's data. - projectDataProfile: - type: string - description: The resource name of the project data profile for this table. - state: - enum: - - STATE_UNSPECIFIED - - RUNNING - - DONE - type: string - enumDescriptions: - - Unused. - - >- - The profile is currently running. Once a profile has finished it - will transition to DONE. - - >- - The profile is no longer generating. If profile_status.status.code - is 0, the profile succeeded, otherwise, it failed. - description: State of a profile. - datasetId: - description: If the resource is BigQuery, the dataset ID. - type: string - scannedColumnCount: - type: string - format: int64 - description: The number of columns profiled in the table. - GooglePrivacyDlpV2DatabaseResourceCollection: + The core content of the template. Configuration of the scanning + process. + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' + GooglePrivacyDlpV2UpdateInspectTemplateRequest: + id: GooglePrivacyDlpV2UpdateInspectTemplateRequest + description: Request message for UpdateInspectTemplate. + type: object properties: - includeRegexes: - $ref: '#/components/schemas/GooglePrivacyDlpV2DatabaseResourceRegexes' - description: >- - A collection of regular expressions to match a database resource - against. - id: GooglePrivacyDlpV2DatabaseResourceCollection + inspectTemplate: + description: New InspectTemplate value. + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + updateMask: + description: Mask to control which fields get updated. + type: string + format: google-fieldmask + GooglePrivacyDlpV2ListInspectTemplatesResponse: + id: GooglePrivacyDlpV2ListInspectTemplatesResponse + description: Response message for ListInspectTemplates. type: object - description: >- - Match database resources using regex filters. Examples of database - resources are tables, views, and stored procedures. - GooglePrivacyDlpV2DateShiftConfig: - id: GooglePrivacyDlpV2DateShiftConfig properties: - context: - description: >- - Points to the field that contains the context, for example, an - entity id. If set, must also set cryptoKey. If set, shift will be - consistent for the given context. - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - upperBoundDays: - description: >- - Required. Range of shift in days. Actual shift will be selected at - random within this range (inclusive ends). Negative means shift to - earlier in time. Must not be more than 365250 days (1000 years) each - direction. For example, 3 means shift date to at most 3 days into - the future. - type: integer - format: int32 - cryptoKey: - $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoKey' + inspectTemplates: description: >- - Causes the shift to be computed based on this key and the context. - This results in the same shift for the same context and crypto_key. - If set, must also set context. Can only be applied to table items. - lowerBoundDays: - format: int32 + List of inspectTemplates, up to page_size in + ListInspectTemplatesRequest. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + nextPageToken: description: >- - Required. For example, -5 means shift date to at most 5 days back in - the past. - type: integer - type: object + If the next page is available then the next page token to be used in + the following ListInspectTemplates request. + type: string + GoogleProtobufEmpty: + id: GoogleProtobufEmpty description: >- - Shifts dates by random number of days, with option to be consistent for - the same context. See - https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting - to learn more. - GooglePrivacyDlpV2RiskAnalysisJobConfig: - id: GooglePrivacyDlpV2RiskAnalysisJobConfig + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } type: object - description: >- - Configuration for a risk analysis job. See - https://cloud.google.com/sensitive-data-protection/docs/concepts-risk-analysis - to learn more. - properties: - sourceTable: - description: Input dataset to compute metrics over. - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' - actions: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Action' - description: >- - Actions to execute at the completion of the job. Are executed in the - order provided. - type: array - privacyMetric: - description: Privacy metric to compute. - $ref: '#/components/schemas/GooglePrivacyDlpV2PrivacyMetric' - GooglePrivacyDlpV2CreateJobTriggerRequest: + properties: {} + GooglePrivacyDlpV2CreateDeidentifyTemplateRequest: + id: GooglePrivacyDlpV2CreateDeidentifyTemplateRequest + description: Request message for CreateDeidentifyTemplate. type: object - id: GooglePrivacyDlpV2CreateJobTriggerRequest - description: Request message for CreateJobTrigger. properties: - triggerId: - type: string + deidentifyTemplate: + description: Required. The DeidentifyTemplate to create. + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + templateId: description: >- - The trigger id can contain uppercase and lowercase letters, numbers, - and hyphens; that is, it must match the regular expression: + The template id can contain uppercase and lowercase letters, + numbers, and hyphens; that is, it must match the regular expression: `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty to allow the system to generate one. - locationId: type: string + locationId: description: Deprecated. This field has no effect. - jobTrigger: - description: Required. The JobTrigger to create. - $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' - GooglePrivacyDlpV2KAnonymityHistogramBucket: - properties: - bucketValueCount: - description: Total number of distinct equivalence classes in this bucket. - format: int64 type: string - bucketValues: + GooglePrivacyDlpV2DeidentifyTemplate: + id: GooglePrivacyDlpV2DeidentifyTemplate + description: >- + DeidentifyTemplates contains instructions on how to de-identify content. + See + https://cloud.google.com/sensitive-data-protection/docs/concepts-templates + to learn more. + type: object + properties: + name: description: >- - Sample of equivalence classes in this bucket. The total number of - classes returned per bucket is capped at 20. - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2KAnonymityEquivalenceClass' - equivalenceClassSizeUpperBound: - description: Upper bound on the size of the equivalence classes in this bucket. - format: int64 + Output only. The template name. The template will have one of the + following formats: + `projects/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID` OR + `organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID` + readOnly: true type: string - bucketSize: + displayName: + description: Display name (max 256 chars). type: string - description: Total number of equivalence classes in this bucket. - format: int64 - equivalenceClassSizeLowerBound: - description: Lower bound on the size of the equivalence classes in this bucket. + description: + description: Short description (max 256 chars). type: string - format: int64 - description: Histogram of k-anonymity equivalence classes. - id: GooglePrivacyDlpV2KAnonymityHistogramBucket - type: object - GooglePrivacyDlpV2TimeZone: - id: GooglePrivacyDlpV2TimeZone - description: Time zone of the date time object. + createTime: + description: Output only. The creation timestamp of an inspectTemplate. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. The last update timestamp of an inspectTemplate. + readOnly: true + type: string + format: google-datetime + deidentifyConfig: + description: The core content of the template. + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyConfig' + GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest: + id: GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest + description: Request message for UpdateDeidentifyTemplate. type: object properties: - offsetMinutes: - description: >- - Set only if the offset can be determined. Positive for time ahead of - UTC. E.g. For "UTC-9", this value is -540. - format: int32 - type: integer - GooglePrivacyDlpV2DiscoveryCloudSqlGenerationCadence: + deidentifyTemplate: + description: New DeidentifyTemplate value. + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + updateMask: + description: Mask to control which fields get updated. + type: string + format: google-fieldmask + GooglePrivacyDlpV2ListDeidentifyTemplatesResponse: + id: GooglePrivacyDlpV2ListDeidentifyTemplatesResponse + description: Response message for ListDeidentifyTemplates. type: object - description: >- - How often existing tables should have their profiles refreshed. New - tables are scanned as quickly as possible depending on system capacity. properties: - inspectTemplateModifiedCadence: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence + deidentifyTemplates: description: >- - Governs when to update data profiles when the inspection rules - defined by the `InspectTemplate` change. If not set, changing the - template will not cause a data profile to update. - refreshFrequency: - enum: - - UPDATE_FREQUENCY_UNSPECIFIED - - UPDATE_FREQUENCY_NEVER - - UPDATE_FREQUENCY_DAILY - - UPDATE_FREQUENCY_MONTHLY - enumDescriptions: - - Unspecified. - - After the data profile is created, it will never be updated. - - The data profile can be updated up to once every 24 hours. - - The data profile can be updated up to once every 30 days. Default. + List of deidentify templates, up to page_size in + ListDeidentifyTemplatesRequest. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + nextPageToken: description: >- - Data changes (non-schema changes) in Cloud SQL tables can't trigger - reprofiling. If you set this field, profiles are refreshed at this - frequency regardless of whether the underlying tables have changed. - Defaults to never. + If the next page is available then the next page token to be used in + the following ListDeidentifyTemplates request. type: string - schemaModifiedCadence: - $ref: '#/components/schemas/GooglePrivacyDlpV2SchemaModifiedCadence' - description: When to reprofile if the schema has changed. - id: GooglePrivacyDlpV2DiscoveryCloudSqlGenerationCadence - GooglePrivacyDlpV2Dictionary: - description: >- - Custom information type based on a dictionary of words or phrases. This - can be used to match sensitive information specific to the data, such as - a list of employee IDs or job titles. Dictionary words are - case-insensitive and all characters other than letters and digits in the - unicode [Basic Multilingual - Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) - will be replaced with whitespace when scanning for matches, so the - dictionary phrase "Sam Johnson" will match all three phrases "sam - johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the - characters surrounding any match must be of a different type than the - adjacent characters within the word, so letters must be next to - non-letters and digits next to non-digits. For example, the dictionary - word "jen" will match the first three letters of the text "jen123" but - will return no matches for "jennifer". Dictionary words containing a - large number of characters that are not letters or digits may result in - unexpected findings because such characters are treated as whitespace. - The [limits](https://cloud.google.com/sensitive-data-protection/limits) - page contains details about the size limits of dictionaries. For - dictionaries that do not fit within these constraints, consider using - `LargeCustomDictionaryConfig` in the `StoredInfoType` API. + GooglePrivacyDlpV2CreateJobTriggerRequest: + id: GooglePrivacyDlpV2CreateJobTriggerRequest + description: Request message for CreateJobTrigger. type: object properties: - cloudStoragePath: + jobTrigger: + description: Required. The JobTrigger to create. + $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' + triggerId: description: >- - Newline-delimited file of words in Cloud Storage. Only a single file - is accepted. - $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStoragePath' - wordList: - $ref: '#/components/schemas/GooglePrivacyDlpV2WordList' - description: List of words or phrases to search for. - id: GooglePrivacyDlpV2Dictionary - GooglePrivacyDlpV2DeidentifyDataSourceDetails: - description: The results of a Deidentify action from an inspect job. - properties: - deidentifyStats: - description: Stats about the de-identification operation. - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyDataSourceStats' - requestedOptions: - $ref: '#/components/schemas/GooglePrivacyDlpV2RequestedDeidentifyOptions' - description: De-identification config used for the request. - id: GooglePrivacyDlpV2DeidentifyDataSourceDetails - type: object - GooglePrivacyDlpV2TransformationResultStatus: - description: The outcome of a transformation. + The trigger id can contain uppercase and lowercase letters, numbers, + and hyphens; that is, it must match the regular expression: + `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty + to allow the system to generate one. + type: string + locationId: + description: Deprecated. This field has no effect. + type: string + GooglePrivacyDlpV2JobTrigger: + id: GooglePrivacyDlpV2JobTrigger + description: >- + Contains a configuration to make API calls on a repeating basis. See + https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers + to learn more. type: object properties: - details: - $ref: '#/components/schemas/GoogleRpcStatus' - description: Detailed error codes and messages - resultStatusType: - enum: - - STATE_TYPE_UNSPECIFIED - - INVALID_TRANSFORM - - BIGQUERY_MAX_ROW_SIZE_EXCEEDED - - METADATA_UNRETRIEVABLE - - SUCCESS + name: + description: >- + Unique resource name for the triggeredJob, assigned by the service + when the triggeredJob is created, for example + `projects/dlp-test-project/jobTriggers/53234423`. type: string - enumDescriptions: - - Unused. - - >- - This will be set when a finding could not be transformed (i.e. - outside user set bucket range). - - >- - This will be set when a BigQuery transformation was successful but - could not be stored back in BigQuery because the transformed row - exceeds BigQuery's max row size. - - >- - This will be set when there is a finding in the custom metadata of - a file, but at the write time of the transformed file, this key / - value pair is unretrievable. - - >- - This will be set when the transformation and storing of it is - successful. + displayName: + description: Display name (max 100 chars) + type: string + description: + description: User provided description (max 256 chars) + type: string + inspectJob: + description: For inspect jobs, a snapshot of the configuration. + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectJobConfig' + triggers: description: >- - Transformation result status type, this will be either SUCCESS, or - it will be the reason for why the transformation was not completely - successful. - id: GooglePrivacyDlpV2TransformationResultStatus - GooglePrivacyDlpV2FinishDlpJobRequest: - type: object - description: The request message for finishing a DLP hybrid job. - id: GooglePrivacyDlpV2FinishDlpJobRequest - properties: {} - GooglePrivacyDlpV2ExcludeInfoTypes: - properties: - infoTypes: + A list of triggers which will be OR'ed together. Only one in the + list needs to trigger for a job to be started. The list may contain + only a single Schedule trigger and must have at least one object. type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Trigger' + errors: description: >- - InfoType list in ExclusionRule rule drops a finding when it overlaps - or contained within with a finding of an infoType from this list. - For example, for `InspectionRuleSet.info_types` containing - "PHONE_NUMBER"` and `exclusion_rule` containing - `exclude_info_types.info_types` with "EMAIL_ADDRESS" the phone - number findings are dropped if they overlap with EMAIL_ADDRESS - finding. That leads to "555-222-2222@example.org" to generate only a - single finding, namely email address. + Output only. A stream of errors encountered when the trigger was + activated. Repeated errors may result in the JobTrigger + automatically being paused. Will return the last 100 errors. + Whenever the JobTrigger is modified this list will be cleared. + readOnly: true + type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - type: object - id: GooglePrivacyDlpV2ExcludeInfoTypes - description: List of excluded infoTypes. - GooglePrivacyDlpV2Action: - id: GooglePrivacyDlpV2Action - description: >- - A task to execute on the completion of a job. See - https://cloud.google.com/sensitive-data-protection/docs/concepts-actions - to learn more. - properties: - pubSub: - description: Publish a notification to a Pub/Sub topic. - $ref: '#/components/schemas/GooglePrivacyDlpV2PublishToPubSub' - deidentify: - description: Create a de-identified copy of the input data. - $ref: '#/components/schemas/GooglePrivacyDlpV2Deidentify' - saveFindings: - $ref: '#/components/schemas/GooglePrivacyDlpV2SaveFindings' - description: Save resulting findings in a provided location. - publishSummaryToCscc: - $ref: '#/components/schemas/GooglePrivacyDlpV2PublishSummaryToCscc' - description: Publish summary to Cloud Security Command Center (Alpha). - publishFindingsToCloudDataCatalog: - description: Publish findings to Cloud Datahub. - $ref: >- - #/components/schemas/GooglePrivacyDlpV2PublishFindingsToCloudDataCatalog - jobNotificationEmails: - description: >- - Sends an email when the job completes. The email goes to IAM project - owners and technical [Essential - Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). - $ref: '#/components/schemas/GooglePrivacyDlpV2JobNotificationEmails' - publishToStackdriver: - description: Enable Stackdriver metric dlp.googleapis.com/finding_count. - $ref: '#/components/schemas/GooglePrivacyDlpV2PublishToStackdriver' - type: object - GooglePrivacyDlpV2DatastoreKey: - properties: - entityKey: - $ref: '#/components/schemas/GooglePrivacyDlpV2Key' - description: Datastore entity key. - description: Record key for a finding in Cloud Datastore. - id: GooglePrivacyDlpV2DatastoreKey - type: object - GooglePrivacyDlpV2UnwrappedCryptoKey: - properties: - key: + $ref: '#/components/schemas/GooglePrivacyDlpV2Error' + createTime: + description: Output only. The creation timestamp of a triggeredJob. + readOnly: true type: string - description: Required. A 128/192/256 bit key. - format: byte - type: object - id: GooglePrivacyDlpV2UnwrappedCryptoKey - description: >- - Using raw keys is prone to security risks due to accidentally leaking - the key. Choose another type of key if possible. - GooglePrivacyDlpV2StatisticalTable: - type: object - properties: - relativeFrequency: - description: >- - Required. The relative frequency column must contain a - floating-point number between 0 and 1 (inclusive). Null values are - assumed to be zero. - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - table: - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' - description: Required. Auxiliary table location. - quasiIds: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2QuasiIdentifierField' - description: Required. Quasi-identifier columns. - type: array - id: GooglePrivacyDlpV2StatisticalTable - description: >- - An auxiliary table containing statistical information on the relative - frequency of different quasi-identifiers values. It has one or several - quasi-identifiers columns, and one column that indicates the relative - frequency of each quasi-identifier tuple. If a tuple is present in the - data but not in the auxiliary table, the corresponding relative - frequency is assumed to be zero (and thus, the tuple is highly - reidentifiable). - GooglePrivacyDlpV2TransformationLocation: - id: GooglePrivacyDlpV2TransformationLocation - properties: - findingId: - description: >- - For infotype transformations, link to the corresponding findings ID - so that location information does not need to be duplicated. Each - findings ID correlates to an entry in the findings output table, - this table only gets created when users specify to save findings - (add the save findings action to the request). + format: google-datetime + updateTime: + description: Output only. The last update timestamp of a triggeredJob. + readOnly: true type: string - containerType: + format: google-datetime + lastRunTime: + description: Output only. The timestamp of the last time this trigger executed. + readOnly: true + type: string + format: google-datetime + status: + description: Required. A status for this trigger. type: string - enum: - - TRANSFORM_UNKNOWN_CONTAINER - - TRANSFORM_BODY - - TRANSFORM_METADATA - - TRANSFORM_TABLE enumDescriptions: - Unused. - - Body of a file. - - Metadata for a file. - - A table. - description: >- - Information about the functionality of the container where this - finding occurred, if available. - recordTransformation: - $ref: '#/components/schemas/GooglePrivacyDlpV2RecordTransformation' - description: >- - For record transformations, provide a field and container - information. - description: Specifies the location of a transformation. - type: object - GooglePrivacyDlpV2Value: + - Trigger is healthy. + - Trigger is temporarily paused. + - Trigger is cancelled and can not be resumed. + enum: + - STATUS_UNSPECIFIED + - HEALTHY + - PAUSED + - CANCELLED + GooglePrivacyDlpV2InspectJobConfig: + id: GooglePrivacyDlpV2InspectJobConfig + description: Controls what and how to inspect for findings. type: object - id: GooglePrivacyDlpV2Value properties: - timestampValue: - type: string - description: timestamp - format: google-datetime - timeValue: - description: time of day - $ref: '#/components/schemas/GoogleTypeTimeOfDay' - dayOfWeekValue: - description: day of week - enum: - - DAY_OF_WEEK_UNSPECIFIED - - MONDAY - - TUESDAY - - WEDNESDAY - - THURSDAY - - FRIDAY - - SATURDAY - - SUNDAY - enumDescriptions: - - The day of the week is unspecified. - - Monday - - Tuesday - - Wednesday - - Thursday - - Friday - - Saturday - - Sunday - type: string - booleanValue: - type: boolean - description: boolean - floatValue: - type: number - description: float - format: double - stringValue: - description: string - type: string - dateValue: - $ref: '#/components/schemas/GoogleTypeDate' - description: date - integerValue: - description: integer - format: int64 + storageConfig: + description: The data to scan. + $ref: '#/components/schemas/GooglePrivacyDlpV2StorageConfig' + inspectConfig: + description: How and what to scan for. + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' + inspectTemplateName: + description: >- + If provided, will be used as the default for all values in + InspectConfig. `inspect_config` will be merged into the values + persisted as part of the template. type: string - description: >- - Set of primitive values supported by the system. Note that for the - purposes of inspection or transformation, the number of bytes considered - to comprise a 'Value' is based on its representation as a UTF-8 encoded - string. For example, if 'integer_value' is set to 123456789, the number - of bytes would be counted as 9, even though an int64 only holds up to 8 - bytes of data. - GooglePrivacyDlpV2RequestedRiskAnalysisOptions: + actions: + description: Actions to execute at the completion of the job. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Action' + GooglePrivacyDlpV2StorageConfig: + id: GooglePrivacyDlpV2StorageConfig + description: Shared message indicating Cloud storage type. + type: object properties: - jobConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2RiskAnalysisJobConfig' - description: The job config for the risk job. - id: GooglePrivacyDlpV2RequestedRiskAnalysisOptions + datastoreOptions: + description: Google Cloud Datastore options. + $ref: '#/components/schemas/GooglePrivacyDlpV2DatastoreOptions' + cloudStorageOptions: + description: Cloud Storage options. + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStorageOptions' + bigQueryOptions: + description: BigQuery options. + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryOptions' + hybridOptions: + description: Hybrid inspection options. + $ref: '#/components/schemas/GooglePrivacyDlpV2HybridOptions' + timespanConfig: + description: Configuration of the timespan of the items to include in scanning. + $ref: '#/components/schemas/GooglePrivacyDlpV2TimespanConfig' + GooglePrivacyDlpV2DatastoreOptions: + id: GooglePrivacyDlpV2DatastoreOptions + description: Options defining a data set within Google Cloud Datastore. type: object - description: Risk analysis options. - GoogleTypeDate: - id: GoogleTypeDate + properties: + partitionId: + description: >- + A partition ID identifies a grouping of entities. The grouping is + always by project and namespace, however the namespace ID may be + empty. + $ref: '#/components/schemas/GooglePrivacyDlpV2PartitionId' + kind: + description: The kind to process. + $ref: '#/components/schemas/GooglePrivacyDlpV2KindExpression' + GooglePrivacyDlpV2KindExpression: + id: GooglePrivacyDlpV2KindExpression + description: A representation of a Datastore kind. type: object properties: - day: - type: integer - format: int32 + name: + description: The name of the kind. + type: string + GooglePrivacyDlpV2CloudStorageOptions: + id: GooglePrivacyDlpV2CloudStorageOptions + description: Options defining a file or a set of files within a Cloud Storage bucket. + type: object + properties: + fileSet: + description: The set of one or more files to scan. + $ref: '#/components/schemas/GooglePrivacyDlpV2FileSet' + bytesLimitPerFile: description: >- - Day of a month. Must be from 1 to 31 and valid for the year and - month, or 0 to specify a year by itself or a year and month where - the day isn't significant. - year: - format: int32 + Max number of bytes to scan from a file. If a scanned file's size is + bigger than this value then the rest of the bytes are omitted. Only + one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can + be specified. This field can't be set if de-identification is + requested. For certain file types, setting this field has no effect. + For more information, see [Limits on bytes scanned per + file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + type: string + format: int64 + bytesLimitPerFilePercent: description: >- - Year of the date. Must be from 1 to 9999, or 0 to specify a date - without a year. + Max percentage of bytes to scan from a file. The rest are omitted. + The number of bytes scanned is rounded down. Must be between 0 and + 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only + one of bytes_limit_per_file and bytes_limit_per_file_percent can be + specified. This field can't be set if de-identification is + requested. For certain file types, setting this field has no effect. + For more information, see [Limits on bytes scanned per + file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). type: integer - month: format: int32 + fileTypes: description: >- - Month of a year. Must be from 1 to 12, or 0 to specify a year - without a month and day. + List of file type groups to include in the scan. If empty, all files + are scanned and available data format processors are applied. In + addition, the binary content of the selected files is always scanned + as well. Images are scanned only as binary if the specified region + does not support image inspection and no file_types were specified. + Image inspection is restricted to 'global', 'us', 'asia', and + 'europe'. + type: array + items: + type: string + enumDescriptions: + - Includes all files. + - >- + Includes all file extensions not covered by another entry. + Binary scanning attempts to convert the content of the file to + utf_8 to scan the file. If you wish to avoid this fall back, + specify one or more of the other file types in your storage + scan. + - >- + Included file extensions: asc,asp, aspx, brf, c, cc,cfm, cgi, + cpp, csv, cxx, c++, cs, css, dart, dat, dot, eml,, epbub, ged, + go, h, hh, hpp, hxx, h++, hs, html, htm, mkd, markdown, m, ml, + mli, perl, pl, plist, pm, php, phtml, pht, properties, py, pyw, + rb, rbw, rs, rss, rc, scala, sh, sql, swift, tex, shtml, shtm, + xhtml, lhs, ics, ini, java, js, json, jsonl, kix, kml, ocaml, + md, txt, text, tsv, vb, vcard, vcs, wml, xcodeproj, xml, xsl, + xsd, yml, yaml. + - >- + Included file extensions: bmp, gif, jpg, jpeg, jpe, png. Setting + bytes_limit_per_file or bytes_limit_per_file_percent has no + effect on image files. Image inspection is restricted to the + `global`, `us`, `asia`, and `europe` regions. + - >- + Microsoft Word files larger than 30 MB will be scanned as binary + files. Included file extensions: docx, dotx, docm, dotm. Setting + `bytes_limit_per_file` or `bytes_limit_per_file_percent` has no + effect on Word files. + - >- + PDF files larger than 30 MB will be scanned as binary files. + Included file extensions: pdf. Setting `bytes_limit_per_file` or + `bytes_limit_per_file_percent` has no effect on PDF files. + - 'Included file extensions: avro' + - 'Included file extensions: csv' + - 'Included file extensions: tsv' + - >- + Microsoft PowerPoint files larger than 30 MB will be scanned as + binary files. Included file extensions: pptx, pptm, potx, potm, + pot. Setting `bytes_limit_per_file` or + `bytes_limit_per_file_percent` has no effect on PowerPoint + files. + - >- + Microsoft Excel files larger than 30 MB will be scanned as + binary files. Included file extensions: xlsx, xlsm, xltx, xltm. + Setting `bytes_limit_per_file` or `bytes_limit_per_file_percent` + has no effect on Excel files. + enum: + - FILE_TYPE_UNSPECIFIED + - BINARY_FILE + - TEXT_FILE + - IMAGE + - WORD + - PDF + - AVRO + - CSV + - TSV + - POWERPOINT + - EXCEL + sampleMethod: + description: How to sample the data. + type: string + enumDescriptions: + - No sampling. + - Scan from the top (default). + - >- + For each file larger than bytes_limit_per_file, randomly pick the + offset to start scanning. The scanned bytes are contiguous. + enum: + - SAMPLE_METHOD_UNSPECIFIED + - TOP + - RANDOM_START + filesLimitPercent: + description: >- + Limits the number of files to scan to this percentage of the input + FileSet. Number of files scanned is rounded down. Must be between 0 + and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. type: integer + format: int32 + GooglePrivacyDlpV2FileSet: + id: GooglePrivacyDlpV2FileSet + description: Set of files to scan. + type: object + properties: + url: + description: >- + The Cloud Storage url of the file(s) to scan, in the format + `gs:///`. Trailing wildcard in the path is allowed. If the url ends + in a trailing slash, the bucket or directory represented by the url + will be scanned non-recursively (content in sub-directories will not + be scanned). This means that `gs://mybucket/` is equivalent to + `gs://mybucket/*`, and `gs://mybucket/directory/` is equivalent to + `gs://mybucket/directory/*`. Exactly one of `url` or + `regex_file_set` must be set. + type: string + regexFileSet: + description: >- + The regex-filtered set of files to scan. Exactly one of `url` or + `regex_file_set` must be set. + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStorageRegexFileSet' + GooglePrivacyDlpV2CloudStorageRegexFileSet: + id: GooglePrivacyDlpV2CloudStorageRegexFileSet description: >- - Represents a whole or partial calendar date, such as a birthday. The - time of day and time zone are either specified elsewhere or are - insignificant. The date is relative to the Gregorian Calendar. This can - represent one of the following: * A full date, with non-zero year, - month, and day values. * A month and day, with a zero year (for example, - an anniversary). * A year on its own, with a zero month and a zero day. - * A year and month, with a zero day (for example, a credit card - expiration date). Related types: * google.type.TimeOfDay * - google.type.DateTime * google.protobuf.Timestamp - GooglePrivacyDlpV2ListInspectTemplatesResponse: - description: Response message for ListInspectTemplates. - id: GooglePrivacyDlpV2ListInspectTemplatesResponse + Message representing a set of files in a Cloud Storage bucket. Regular + expressions are used to allow fine-grained control over which files in + the bucket to include. Included files are those that match at least one + item in `include_regex` and do not match any items in `exclude_regex`. + Note that a file that matches items from both lists will _not_ be + included. For a match to occur, the entire file path (i.e., everything + in the url after the bucket name) must match the regular expression. For + example, given the input `{bucket_name: "mybucket", include_regex: + ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]}`: * + `gs://mybucket/directory1/myfile` will be included * + `gs://mybucket/directory1/directory2/myfile` will be included (`.*` + matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will + _not_ be included (the full path doesn't match any items in + `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be + included (the path matches an item in `exclude_regex`) If + `include_regex` is left empty, it will match all files by default (this + is equivalent to setting `include_regex: [".*"]`). Some other common use + cases: * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will + include all files in `mybucket` except for .pdf files * `{bucket_name: + "mybucket", include_regex: ["directory/[^/]+"]}` will include all files + directly under `gs://mybucket/directory/`, without matching across `/` type: object properties: - nextPageToken: + bucketName: + description: The name of a Cloud Storage bucket. Required. type: string + includeRegex: description: >- - If the next page is available then the next page token to be used in - the following ListInspectTemplates request. - inspectTemplates: + A list of regular expressions matching file paths to include. All + files in the bucket that match at least one of these regular + expressions will be included in the set of files, except for those + that also match an item in `exclude_regex`. Leaving this field empty + will match all files by default (this is equivalent to including + `.*` in the list). Regular expressions use RE2 + [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be + found under the google/re2 repository on GitHub. + type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + type: string + excludeRegex: description: >- - List of inspectTemplates, up to page_size in - ListInspectTemplatesRequest. + A list of regular expressions matching file paths to exclude. All + files in the bucket that match at least one of these regular + expressions will be excluded from the scan. Regular expressions use + RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can + be found under the google/re2 repository on GitHub. type: array - GooglePrivacyDlpV2PubSubNotification: + items: + type: string + GooglePrivacyDlpV2BigQueryOptions: + id: GooglePrivacyDlpV2BigQueryOptions + description: Options defining BigQuery table and row identifiers. type: object - description: >- - Send a Pub/Sub message into the given Pub/Sub topic to connect other - systems to data profile generation. The message payload data will be the - byte serialization of `DataProfilePubSubMessage`. - id: GooglePrivacyDlpV2PubSubNotification properties: - pubsubCondition: - $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfilePubSubCondition' + tableReference: + description: Complete BigQuery table reference. + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + identifyingFields: description: >- - Conditions (e.g., data risk or sensitivity level) for triggering a - Pub/Sub. - detailOfMessage: + Table fields that may uniquely identify a row within the table. When + `actions.saveFindings.outputConfig.table` is specified, the values + of columns specified here are available in the output table under + `location.content_locations.record_location.record_key.id_values`. + Nested fields such as `person.birthdate.year` are allowed. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + rowsLimit: + description: >- + Max number of rows to scan. If the table has more rows than this + value, the rest of the rows are omitted. If not set, or if set to 0, + all rows will be scanned. Only one of rows_limit and + rows_limit_percent can be specified. Cannot be used in conjunction + with TimespanConfig. type: string + format: int64 + rowsLimitPercent: description: >- - How much data to include in the Pub/Sub message. If the user wishes - to limit the size of the message, they can use resource_name and - fetch the profile fields they wish to. Per table profile (not per - column). + Max percentage of rows to scan. The rest are omitted. The number of + rows scanned is rounded down. Must be between 0 and 100, + inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one + of rows_limit and rows_limit_percent can be specified. Cannot be + used in conjunction with TimespanConfig. Caution: A [known + issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) + is causing the `rowsLimitPercent` field to behave unexpectedly. We + recommend using `rowsLimit` instead. + type: integer + format: int32 + sampleMethod: + description: How to sample the data. + type: string enumDescriptions: - - Unused. - - The full table data profile. - - The name of the profiled resource. - - The full file store data profile. - enum: - - DETAIL_LEVEL_UNSPECIFIED - - TABLE_PROFILE - - RESOURCE_NAME - - FILE_STORE_PROFILE - event: - enum: - - EVENT_TYPE_UNSPECIFIED - - NEW_PROFILE - - CHANGED_PROFILE - - SCORE_INCREASED - - ERROR_CHANGED - enumDescriptions: - - Unused. - - New profile (not a re-profile). + - No sampling. - >- - One of the following profile metrics changed: Data risk score, - Sensitivity score, Resource visibility, Encryption type, Predicted - infoTypes, Other infoTypes - - Table data risk score or sensitivity score increased. - - A user (non-internal) error occurred. + Scan groups of rows in the order BigQuery provides (default). + Multiple groups of rows may be scanned in parallel, so results may + not appear in the same order the rows are read. + - Randomly pick groups of rows to scan. + enum: + - SAMPLE_METHOD_UNSPECIFIED + - TOP + - RANDOM_START + excludedFields: description: >- - The type of event that triggers a Pub/Sub. At most one - `PubSubNotification` per EventType is permitted. - type: string - topic: + References to fields excluded from scanning. This allows you to skip + inspection of entire columns which you know have no findings. When + inspecting a table, we recommend that you inspect all columns. + Otherwise, findings might be affected because hints from excluded + columns will not be used. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + includedFields: description: >- - Cloud Pub/Sub topic to send notifications to. Format is - projects/{project}/topics/{topic}. - type: string - GooglePrivacyDlpV2Proximity: + Limit scanning only to these fields. When inspecting a table, we + recommend that you inspect all columns. Otherwise, findings might be + affected because hints from excluded columns will not be used. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + GooglePrivacyDlpV2HybridOptions: + id: GooglePrivacyDlpV2HybridOptions + description: >- + Configuration to control jobs where the content being inspected is + outside of Google Cloud Platform. + type: object properties: - windowBefore: - type: integer + description: description: >- - Number of characters before the finding to consider. For tabular - data, if you want to modify the likelihood of an entire column of - findngs, set this to 1. For more information, see [Hotword example: - Set the match likelihood of a table column] - (https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). - format: int32 - windowAfter: - type: integer - format: int32 - description: Number of characters after the finding to consider. + A short description of where the data is coming from. Will be stored + once in the job. 256 max length. + type: string + requiredFindingLabelKeys: + description: >- + These are labels that each inspection request must include within + their 'finding_labels' map. Request may contain others, but any + missing one of these will be rejected. Label keys must be between 1 + and 63 characters long and must conform to the following regular + expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. No more than 10 keys can + be required. + type: array + items: + type: string + labels: + description: >- + To organize findings, these labels will be added to each finding. + Label keys must be between 1 and 63 characters long and must conform + to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. + Label values must be between 0 and 63 characters long and must + conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. + No more than 10 labels can be associated with a given finding. + Examples: * `"environment" : "production"` * `"pipeline" : "etl"` + type: object + additionalProperties: + type: string + tableOptions: + description: >- + If the container is a table, additional information to make findings + meaningful such as the columns that are primary keys. + $ref: '#/components/schemas/GooglePrivacyDlpV2TableOptions' + GooglePrivacyDlpV2TableOptions: + id: GooglePrivacyDlpV2TableOptions + description: Instructions regarding the table content being inspected. type: object - description: >- - Message for specifying a window around a finding to apply a detection - rule. - id: GooglePrivacyDlpV2Proximity + properties: + identifyingFields: + description: >- + The columns that are the primary keys for table objects included in + ContentItem. A copy of this cell's value will stored alongside + alongside each finding so that the finding can be traced to the + specific row it came from. No more than 3 may be provided. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' GooglePrivacyDlpV2TimespanConfig: - type: object id: GooglePrivacyDlpV2TimespanConfig + description: >- + Configuration of the timespan of the items to include in scanning. + Currently only supported when inspecting Cloud Storage and BigQuery. + type: object properties: + startTime: + description: >- + Exclude files, tables, or rows older than this value. If not set, no + lower time limit is applied. + type: string + format: google-datetime + endTime: + description: >- + Exclude files, tables, or rows newer than this value. If not set, no + upper time limit is applied. + type: string + format: google-datetime timestampField: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' description: >- Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For @@ -3667,20 +3536,8 @@ components: [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. - endTime: - type: string - description: >- - Exclude files, tables, or rows newer than this value. If not set, no - upper time limit is applied. - format: google-datetime - startTime: - description: >- - Exclude files, tables, or rows older than this value. If not set, no - lower time limit is applied. - type: string - format: google-datetime + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' enableAutoPopulationOfTimespanConfig: - type: boolean description: >- When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been @@ -3694,1304 +3551,1357 @@ components: the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. + type: boolean + GooglePrivacyDlpV2Action: + id: GooglePrivacyDlpV2Action description: >- - Configuration of the timespan of the items to include in scanning. - Currently only supported when inspecting Cloud Storage and BigQuery. - GooglePrivacyDlpV2ValueFrequency: - description: A value of a field, including its frequency. - properties: - count: - format: int64 - description: How many times the value is contained in the field. - type: string - value: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - description: A value contained in the field in question. - type: object - id: GooglePrivacyDlpV2ValueFrequency - GooglePrivacyDlpV2TransformationConfig: + A task to execute on the completion of a job. See + https://cloud.google.com/sensitive-data-protection/docs/concepts-actions + to learn more. type: object - id: GooglePrivacyDlpV2TransformationConfig properties: - imageRedactTemplate: - description: >- - Image redact template. If this template is specified, it will serve - as the de-identify template for images. If this template is not set, - all findings in the image will be redacted with a black box. - type: string - structuredDeidentifyTemplate: - description: >- - Structured de-identify template. If this template is specified, it - will serve as the de-identify template for structured content such - as delimited files and tables. If this template is not set but the - `deidentify_template` is set, then `deidentify_template` will also - apply to the structured content. If neither template is set, a - default `ReplaceWithInfoTypeConfig` will be used to de-identify - structured content. - type: string - deidentifyTemplate: - type: string + saveFindings: + description: Save resulting findings in a provided location. + $ref: '#/components/schemas/GooglePrivacyDlpV2SaveFindings' + pubSub: + description: Publish a notification to a Pub/Sub topic. + $ref: '#/components/schemas/GooglePrivacyDlpV2PublishToPubSub' + publishSummaryToCscc: + description: Publish summary to Cloud Security Command Center (Alpha). + $ref: '#/components/schemas/GooglePrivacyDlpV2PublishSummaryToCscc' + publishFindingsToCloudDataCatalog: + description: Publish findings to Cloud Datahub. + $ref: >- + #/components/schemas/GooglePrivacyDlpV2PublishFindingsToCloudDataCatalog + deidentify: + description: Create a de-identified copy of the input data. + $ref: '#/components/schemas/GooglePrivacyDlpV2Deidentify' + jobNotificationEmails: description: >- - De-identify template. If this template is specified, it will serve - as the default de-identify template. This template cannot contain - `record_transformations` since it can be used for unstructured - content such as free-form text files. If this template is not set, a - default `ReplaceWithInfoTypeConfig` will be used to de-identify - unstructured content. - description: >- - User specified templates and configs for how to deidentify structured, - unstructures, and image files. User must provide either a unstructured - deidentify template or at least one redact image config. - GooglePrivacyDlpV2TableReference: - id: GooglePrivacyDlpV2TableReference + Sends an email when the job completes. The email goes to IAM project + owners and technical [Essential + Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). + $ref: '#/components/schemas/GooglePrivacyDlpV2JobNotificationEmails' + publishToStackdriver: + description: Enable Stackdriver metric dlp.googleapis.com/finding_count. + $ref: '#/components/schemas/GooglePrivacyDlpV2PublishToStackdriver' + GooglePrivacyDlpV2SaveFindings: + id: GooglePrivacyDlpV2SaveFindings description: >- - Message defining the location of a BigQuery table with the projectId - inferred from the parent project. + If set, the detailed findings will be persisted to the specified + OutputStorageConfig. Only a single instance of this action can be + specified. Compatible with: Inspect, Risk type: object properties: - tableId: - type: string - description: Name of the table. - datasetId: - type: string - description: Dataset ID of the table. - GooglePrivacyDlpV2ReidentifyContentRequest: - description: Request to re-identify an item. + outputConfig: + description: Location to store findings outside of DLP. + $ref: '#/components/schemas/GooglePrivacyDlpV2OutputStorageConfig' + GooglePrivacyDlpV2OutputStorageConfig: + id: GooglePrivacyDlpV2OutputStorageConfig + description: Cloud repository for storing output. type: object properties: - item: - description: The item to re-identify. Will be treated as text. - $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' - inspectTemplateName: + table: description: >- - Template to use. Any configuration directly specified in - `inspect_config` will override those set in the template. Singular - fields that are set in this request will replace their corresponding - fields in the template. Repeated fields are appended. Singular - sub-messages and groups are recursively merged. - type: string - reidentifyTemplateName: - type: string + Store findings in an existing table or a new table in an existing + dataset. If table_id is not set a new one will be generated for you + with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. + Pacific time zone will be used for generating the date details. For + Inspect, each column in an existing output table must have the same + name, type, and mode of a field in the `Finding` object. For Risk, + an existing output table should be the output of a previous Risk + analysis job run on the same source table, with the same privacy + metric and quasi-identifiers. Risk jobs that analyze the same table + but compute a different privacy metric, or use different sets of + quasi-identifiers, cannot store their results in the same table. + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + outputSchema: description: >- - Template to use. References an instance of `DeidentifyTemplate`. Any - configuration directly specified in `reidentify_config` or - `inspect_config` will override those set in the template. The - `DeidentifyTemplate` used must include only reversible - transformations. Singular fields that are set in this request will - replace their corresponding fields in the template. Repeated fields - are appended. Singular sub-messages and groups are recursively - merged. - inspectConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' - description: Configuration for the inspector. - locationId: - description: Deprecated. This field has no effect. + Schema used for writing the findings for Inspect jobs. This field is + only used for Inspect and must be unspecified for Risk jobs. Columns + are derived from the `Finding` object. If appending to an existing + table, any columns from the predefined schema that are missing will + be added. No columns in the existing table will be deleted. If + unspecified, then all available columns will be used for a new table + or an (existing) table with no schema, and no changes will be made + to an existing table that has a schema. Only for use with external + storage. type: string - reidentifyConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyConfig' - description: >- - Configuration for the re-identification of the content item. This - field shares the same proto message type that is used for - de-identification, however its usage here is for the reversal of the - previous de-identification. Re-identification is performed by - examining the transformations used to de-identify the items and - executing the reverse. This requires that only reversible - transformations be provided here. The reversible transformations - are: - `CryptoDeterministicConfig` - `CryptoReplaceFfxFpeConfig` - id: GooglePrivacyDlpV2ReidentifyContentRequest - GooglePrivacyDlpV2RedactConfig: - type: object - id: GooglePrivacyDlpV2RedactConfig + enumDescriptions: + - Unused. + - >- + Basic schema including only `info_type`, `quote`, `certainty`, and + `timestamp`. + - Schema tailored to findings from scanning Cloud Storage. + - Schema tailored to findings from scanning Google Datastore. + - Schema tailored to findings from scanning Google BigQuery. + - Schema containing all columns. + enum: + - OUTPUT_SCHEMA_UNSPECIFIED + - BASIC_COLUMNS + - GCS_COLUMNS + - DATASTORE_COLUMNS + - BIG_QUERY_COLUMNS + - ALL_COLUMNS + GooglePrivacyDlpV2PublishToPubSub: + id: GooglePrivacyDlpV2PublishToPubSub description: >- - Redact a given value. For example, if used with an - `InfoTypeTransformation` transforming PHONE_NUMBER, and input 'My phone - number is 206-555-0123', the output would be 'My phone number is '. - properties: {} - GooglePrivacyDlpV2InspectJobConfig: - id: GooglePrivacyDlpV2InspectJobConfig + Publish a message into a given Pub/Sub topic when DlpJob has completed. + The message contains a single field, `DlpJobName`, which is equal to the + finished job's + [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). + Compatible with: Inspect, Risk type: object properties: - actions: - description: Actions to execute at the completion of the job. - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Action' - inspectTemplateName: + topic: description: >- - If provided, will be used as the default for all values in - InspectConfig. `inspect_config` will be merged into the values - persisted as part of the template. + Cloud Pub/Sub topic to send notifications to. The topic must have + given publishing access rights to the DLP API service account + executing the long running DlpJob sending the notifications. Format + is projects/{project}/topics/{topic}. type: string - inspectConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' - description: How and what to scan for. - storageConfig: - description: The data to scan. - $ref: '#/components/schemas/GooglePrivacyDlpV2StorageConfig' - description: Controls what and how to inspect for findings. - GooglePrivacyDlpV2CryptoHashConfig: - id: GooglePrivacyDlpV2CryptoHashConfig - type: object + GooglePrivacyDlpV2PublishSummaryToCscc: + id: GooglePrivacyDlpV2PublishSummaryToCscc description: >- - Pseudonymization method that generates surrogates via cryptographic - hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. - Outputs a base64 encoded representation of the hashed output (for - example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only - string and integer values can be hashed. See - https://cloud.google.com/sensitive-data-protection/docs/pseudonymization - to learn more. - properties: - cryptoKey: - description: The key used by the hash function. - $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoKey' - GoogleProtobufEmpty: - id: GoogleProtobufEmpty + Publish the result summary of a DlpJob to [Security Command + Center](https://cloud.google.com/security-command-center). This action + is available for only projects that belong to an organization. This + action publishes the count of finding instances and their infoTypes. The + summary of findings are persisted in Security Command Center and are + governed by [service-specific policies for Security Command + Center](https://cloud.google.com/terms/service-terms). Only a single + instance of this action can be specified. Compatible with: Inspect type: object - description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } properties: {} - GooglePrivacyDlpV2CategoricalStatsHistogramBucket: - description: Histogram of value frequencies in the column. - id: GooglePrivacyDlpV2CategoricalStatsHistogramBucket - properties: - bucketValues: - type: array - description: >- - Sample of value frequencies in this bucket. The total number of - values returned per bucket is capped at 20. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2ValueFrequency' - bucketSize: - type: string - description: Total number of values in this bucket. - format: int64 - valueFrequencyUpperBound: - description: Upper bound on the value frequency of the values in this bucket. - type: string - format: int64 - bucketValueCount: - format: int64 - description: Total number of distinct values in this bucket. - type: string - valueFrequencyLowerBound: - description: Lower bound on the value frequency of the values in this bucket. - format: int64 - type: string + GooglePrivacyDlpV2PublishFindingsToCloudDataCatalog: + id: GooglePrivacyDlpV2PublishFindingsToCloudDataCatalog + description: >- + Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag + templates are applied to the resource that Cloud DLP scanned. Data + Catalog tag templates are stored in the same project and region where + the BigQuery table exists. For Cloud DLP to create and apply the tag + template, the Cloud DLP service agent must have the + `roles/datacatalog.tagTemplateOwner` permission on the project. The tag + template contains fields summarizing the results of the DlpJob. Any + field values previously written by another DlpJob are deleted. InfoType + naming patterns are strictly enforced when using this feature. Findings + are persisted in Data Catalog storage and are governed by + service-specific policies for Data Catalog. For more information, see + [Service Specific Terms](https://cloud.google.com/terms/service-terms). + Only a single instance of this action can be specified. This action is + allowed only if all resources being scanned are BigQuery tables. + Compatible with: Inspect type: object - GooglePrivacyDlpV2ListConnectionsResponse: - description: Response message for ListConnections. + properties: {} + GooglePrivacyDlpV2Deidentify: + id: GooglePrivacyDlpV2Deidentify + description: >- + Create a de-identified copy of a storage bucket. Only compatible with + Cloud Storage buckets. A TransformationDetail will be created for each + transformation. Compatible with: Inspection of Cloud Storage type: object - id: GooglePrivacyDlpV2ListConnectionsResponse properties: - connections: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' - type: array - description: List of connections. - nextPageToken: - type: string + transformationConfig: description: >- - Token to retrieve the next page of results. An empty value means - there are no more results. - GooglePrivacyDlpV2DiscoveryFileStoreConditions: - description: >- - Requirements that must be true before a file store is scanned in - discovery for the first time. There is an AND relationship between the - top-level attributes. - properties: - cloudStorageConditions: + User specified deidentify templates and configs for structured, + unstructured, and image files. + $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationConfig' + transformationDetailsStorageConfig: + description: >- + Config for storing transformation details. This field specifies the + configuration for storing detailed metadata about each + transformation performed during a de-identification process. The + metadata is stored separately from the de-identified content itself + and provides a granular record of both successful transformations + and any failures that occurred. Enabling this configuration is + essential for users who need to access comprehensive information + about the status, outcome, and specifics of each transformation. The + details are captured in the TransformationDetails message for each + operation. Key use cases: * **Auditing and compliance** * Provides a + verifiable audit trail of de-identification activities, which is + crucial for meeting regulatory requirements and internal data + governance policies. * Logs what data was transformed, what + transformations were applied, when they occurred, and their success + status. This helps demonstrate accountability and due diligence in + protecting sensitive data. * **Troubleshooting and debugging** * + Offers detailed error messages and context if a transformation + fails. This information is useful for diagnosing and resolving + issues in the de-identification pipeline. * Helps pinpoint the exact + location and nature of failures, speeding up the debugging process. + * **Process verification and quality assurance** * Allows users to + confirm that de-identification rules and transformations were + applied correctly and consistently across the dataset as intended. * + Helps in verifying the effectiveness of the chosen de-identification + strategies. * **Data lineage and impact analysis** * Creates a + record of how data elements were modified, contributing to data + lineage. This is useful for understanding the provenance of + de-identified data. * Aids in assessing the potential impact of + de-identification choices on downstream analytical processes or data + usability. * **Reporting and operational insights** * You can + analyze the metadata stored in a queryable BigQuery table to + generate reports on transformation success rates, common error + types, processing volumes (e.g., transformedBytes), and the types of + transformations applied. * These insights can inform optimization of + de-identification configurations and resource planning. To take + advantage of these benefits, set this configuration. The stored + details include a description of the transformation, success or + error codes, error messages, the number of bytes transformed, the + location of the transformed content, and identifiers for the job and + source data. $ref: >- - #/components/schemas/GooglePrivacyDlpV2DiscoveryCloudStorageConditions - description: Optional. Cloud Storage conditions. - minAge: - type: string + #/components/schemas/GooglePrivacyDlpV2TransformationDetailsStorageConfig + cloudStorageOutput: description: >- - Optional. Minimum age a file store must have. If set, the value must - be 1 hour or greater. - format: google-duration - createdAfter: + Required. User settable Cloud Storage bucket and folders to store + de-identified files. This field must be set for Cloud Storage + deidentification. The output Cloud Storage bucket must be different + from the input bucket. De-identified files will overwrite files in + the output path. Form of: gs://bucket/folder/ or gs://bucket type: string - format: google-datetime + fileTypesToTransform: description: >- - Optional. File store must have been created after this date. Used to - avoid backfilling. - id: GooglePrivacyDlpV2DiscoveryFileStoreConditions - type: object - GooglePrivacyDlpV2LDiversityEquivalenceClass: - properties: - numDistinctSensitiveValues: - type: string - format: int64 - description: Number of distinct sensitive values in this equivalence class. - equivalenceClassSize: - type: string - format: int64 - description: Size of the k-anonymity equivalence class. - topSensitiveValues: + List of user-specified file type groups to transform. If specified, + only the files with these file types are transformed. If empty, all + supported files are transformed. Supported types may be + automatically added over time. Any unsupported file types that are + set in this field are excluded from de-identification. An error is + recorded for each unsupported file in the TransformationDetails + output table. Currently the only file types supported are: IMAGES, + TEXT_FILES, CSV, TSV. type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2ValueFrequency' - description: Estimated frequencies of top sensitive values. - quasiIdsValues: - description: >- - Quasi-identifier values defining the k-anonymity equivalence class. - The order is always the same as the original request. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - type: array - description: The set of columns' values that share the same ldiversity value. - id: GooglePrivacyDlpV2LDiversityEquivalenceClass - type: object - GooglePrivacyDlpV2StoredInfoType: - description: >- - StoredInfoType resource message that contains information about the - current version and any pending updates. - id: GooglePrivacyDlpV2StoredInfoType - properties: - name: - type: string - description: Resource name. - pendingVersions: - type: array - description: >- - Pending versions of the stored info type. Empty if no versions are - pending. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeVersion' - currentVersion: - description: Current version of the stored info type. - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeVersion' - type: object - GooglePrivacyDlpV2SchemaModifiedCadence: - properties: - types: - type: array - description: >- - The types of schema modifications to consider. Defaults to - NEW_COLUMNS. items: type: string enumDescriptions: - - Unused. - - New columns have appeared. - - Columns have been removed from the table. + - Includes all files. + - >- + Includes all file extensions not covered by another entry. + Binary scanning attempts to convert the content of the file to + utf_8 to scan the file. If you wish to avoid this fall back, + specify one or more of the other file types in your storage + scan. + - >- + Included file extensions: asc,asp, aspx, brf, c, cc,cfm, cgi, + cpp, csv, cxx, c++, cs, css, dart, dat, dot, eml,, epbub, ged, + go, h, hh, hpp, hxx, h++, hs, html, htm, mkd, markdown, m, ml, + mli, perl, pl, plist, pm, php, phtml, pht, properties, py, pyw, + rb, rbw, rs, rss, rc, scala, sh, sql, swift, tex, shtml, shtm, + xhtml, lhs, ics, ini, java, js, json, jsonl, kix, kml, ocaml, + md, txt, text, tsv, vb, vcard, vcs, wml, xcodeproj, xml, xsl, + xsd, yml, yaml. + - >- + Included file extensions: bmp, gif, jpg, jpeg, jpe, png. Setting + bytes_limit_per_file or bytes_limit_per_file_percent has no + effect on image files. Image inspection is restricted to the + `global`, `us`, `asia`, and `europe` regions. + - >- + Microsoft Word files larger than 30 MB will be scanned as binary + files. Included file extensions: docx, dotx, docm, dotm. Setting + `bytes_limit_per_file` or `bytes_limit_per_file_percent` has no + effect on Word files. + - >- + PDF files larger than 30 MB will be scanned as binary files. + Included file extensions: pdf. Setting `bytes_limit_per_file` or + `bytes_limit_per_file_percent` has no effect on PDF files. + - 'Included file extensions: avro' + - 'Included file extensions: csv' + - 'Included file extensions: tsv' + - >- + Microsoft PowerPoint files larger than 30 MB will be scanned as + binary files. Included file extensions: pptx, pptm, potx, potm, + pot. Setting `bytes_limit_per_file` or + `bytes_limit_per_file_percent` has no effect on PowerPoint + files. + - >- + Microsoft Excel files larger than 30 MB will be scanned as + binary files. Included file extensions: xlsx, xlsm, xltx, xltm. + Setting `bytes_limit_per_file` or `bytes_limit_per_file_percent` + has no effect on Excel files. enum: - - SQL_SCHEMA_MODIFICATION_UNSPECIFIED - - NEW_COLUMNS - - REMOVED_COLUMNS - frequency: - enumDescriptions: - - Unspecified. - - After the data profile is created, it will never be updated. - - The data profile can be updated up to once every 24 hours. - - The data profile can be updated up to once every 30 days. Default. + - FILE_TYPE_UNSPECIFIED + - BINARY_FILE + - TEXT_FILE + - IMAGE + - WORD + - PDF + - AVRO + - CSV + - TSV + - POWERPOINT + - EXCEL + GooglePrivacyDlpV2TransformationConfig: + id: GooglePrivacyDlpV2TransformationConfig + description: >- + User specified templates and configs for how to deidentify structured, + unstructures, and image files. User must provide either a unstructured + deidentify template or at least one redact image config. + type: object + properties: + deidentifyTemplate: + description: >- + De-identify template. If this template is specified, it will serve + as the default de-identify template. This template cannot contain + `record_transformations` since it can be used for unstructured + content such as free-form text files. If this template is not set, a + default `ReplaceWithInfoTypeConfig` will be used to de-identify + unstructured content. type: string - enum: - - UPDATE_FREQUENCY_UNSPECIFIED - - UPDATE_FREQUENCY_NEVER - - UPDATE_FREQUENCY_DAILY - - UPDATE_FREQUENCY_MONTHLY + structuredDeidentifyTemplate: description: >- - Frequency to regenerate data profiles when the schema is modified. - Defaults to monthly. + Structured de-identify template. If this template is specified, it + will serve as the de-identify template for structured content such + as delimited files and tables. If this template is not set but the + `deidentify_template` is set, then `deidentify_template` will also + apply to the structured content. If neither template is set, a + default `ReplaceWithInfoTypeConfig` will be used to de-identify + structured content. + type: string + imageRedactTemplate: + description: >- + Image redact template. If this template is specified, it will serve + as the de-identify template for images. If this template is not set, + all findings in the image will be redacted with a black box. + type: string + GooglePrivacyDlpV2TransformationDetailsStorageConfig: + id: GooglePrivacyDlpV2TransformationDetailsStorageConfig + description: Config for storing transformation details. type: object - id: GooglePrivacyDlpV2SchemaModifiedCadence + properties: + table: + description: >- + The BigQuery table in which to store the output. This may be an + existing table or in a new table in an existing dataset. If table_id + is not set a new one will be generated for you with the following + format: + dlp_googleapis_transformation_details_yyyy_mm_dd_[dlp_job_id]. + Pacific time zone will be used for generating the date details. + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + GooglePrivacyDlpV2JobNotificationEmails: + id: GooglePrivacyDlpV2JobNotificationEmails description: >- - How frequently to modify the profile when the table's schema is - modified. - GooglePrivacyDlpV2FixedSizeBucketingConfig: + Sends an email when the job completes. The email goes to IAM project + owners and technical [Essential + Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). type: object - id: GooglePrivacyDlpV2FixedSizeBucketingConfig + properties: {} + GooglePrivacyDlpV2PublishToStackdriver: + id: GooglePrivacyDlpV2PublishToStackdriver description: >- - Buckets values based on fixed size ranges. The Bucketing transformation - can provide all of this functionality, but requires more configuration. - This message is provided as a convenience to the user for simple - bucketing strategies. The transformed value will be a hyphenated string - of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and - upper_bound = 20, all values that are within this bucket will be - replaced with "10-20". This can be used on data of type: double, long. - If the bound Value type differs from the type of data being transformed, - we will first attempt converting the type of the data to be transformed - to match the type of the bound before comparing. See - https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing - to learn more. + Enable Stackdriver metric dlp.googleapis.com/finding_count. This will + publish a metric to stack driver on each infotype requested and how many + findings were found for it. CustomDetectors will be bucketed as 'Custom' + under the Stackdriver label 'info_type'. + type: object + properties: {} + GooglePrivacyDlpV2Trigger: + id: GooglePrivacyDlpV2Trigger + description: What event needs to occur for a new job to be started. + type: object properties: - lowerBound: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - description: >- - Required. Lower bound value of buckets. All values less than - `lower_bound` are grouped together into a single bucket; for example - if `lower_bound` = 10, then all values less than 10 are replaced - with the value "-10". - bucketSize: - format: double - type: number + schedule: + description: Create a job on a repeating basis based on the elapse of time. + $ref: '#/components/schemas/GooglePrivacyDlpV2Schedule' + manual: description: >- - Required. Size of each bucket (except for minimum and maximum - buckets). So if `lower_bound` = 10, `upper_bound` = 89, and - `bucket_size` = 10, then the following buckets would be used: -10, - 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. - Precision up to 2 decimals works. - upperBound: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + For use with hybrid jobs. Jobs must be manually created and + finished. + $ref: '#/components/schemas/GooglePrivacyDlpV2Manual' + GooglePrivacyDlpV2Schedule: + id: GooglePrivacyDlpV2Schedule + description: Schedule for inspect job triggers. + type: object + properties: + recurrencePeriodDuration: description: >- - Required. Upper bound value of buckets. All values greater than - upper_bound are grouped together into a single bucket; for example - if `upper_bound` = 89, then all values greater than 89 are replaced - with the value "89+". - GooglePrivacyDlpV2PubSubCondition: + With this option a job is started on a regular periodic basis. For + example: every day (86400 seconds). A scheduled start time will be + skipped if the previous execution has not ended when its scheduled + time occurs. This value must be set to a time duration greater than + or equal to 1 day and can be no longer than 60 days. + type: string + format: google-duration + GooglePrivacyDlpV2Manual: + id: GooglePrivacyDlpV2Manual + description: >- + Job trigger option for hybrid jobs. Jobs must be manually created and + finished. + type: object + properties: {} + GooglePrivacyDlpV2Error: + id: GooglePrivacyDlpV2Error + description: >- + Details information about an error encountered during job execution or + the results of an unsuccessful activation of the JobTrigger. + type: object properties: - minimumRiskScore: + details: + description: Detailed error codes and messages. + $ref: '#/components/schemas/GoogleRpcStatus' + timestamps: + description: >- + The times the error occurred. List includes the oldest timestamp and + the last 9 timestamps. + type: array + items: + type: string + format: google-datetime + extraInfo: + description: Additional information about the error. type: string enumDescriptions: - Unused. - - High risk/sensitivity detected. - - Medium or high risk/sensitivity detected. + - Image scan is not available in the region. + - File store cluster is not supported for profile generation. enum: - - PROFILE_SCORE_BUCKET_UNSPECIFIED - - HIGH - - MEDIUM_OR_HIGH - description: The minimum data risk score that triggers the condition. - minimumSensitivityScore: - enum: - - PROFILE_SCORE_BUCKET_UNSPECIFIED - - HIGH - - MEDIUM_OR_HIGH - enumDescriptions: - - Unused. - - High risk/sensitivity detected. - - Medium or high risk/sensitivity detected. - description: The minimum sensitivity level that triggers the condition. - type: string - type: object - id: GooglePrivacyDlpV2PubSubCondition - description: A condition consisting of a value. - GooglePrivacyDlpV2ActionDetails: + - ERROR_INFO_UNSPECIFIED + - IMAGE_SCAN_UNAVAILABLE_IN_REGION + - FILE_STORE_CLUSTER_UNSUPPORTED + GoogleRpcStatus: + id: GoogleRpcStatus + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). type: object - description: The results of an Action. - id: GooglePrivacyDlpV2ActionDetails - properties: - deidentifyDetails: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyDataSourceDetails' - description: Outcome of a de-identification action. - GooglePrivacyDlpV2InspectConfig: properties: - minLikelihood: + code: + description: The status code, which should be an enum value of google.rpc.Code. + type: integer + format: int32 + message: description: >- - Only returns findings equal to or above this threshold. The default - is POSSIBLE. In general, the highest likelihood setting yields the - fewest findings in results and the lowest chance of a false - positive. For more information, see [Match - likelihood](https://cloud.google.com/sensitive-data-protection/docs/likelihood). - enum: - - LIKELIHOOD_UNSPECIFIED - - VERY_UNLIKELY - - UNLIKELY - - POSSIBLE - - LIKELY - - VERY_LIKELY - enumDescriptions: - - Default value; same as POSSIBLE. - - Highest chance of a false positive. - - High chance of a false positive. - - Some matching signals. The default value. - - Low chance of a false positive. - - Confidence level is high. Lowest chance of a false positive. + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. type: string - excludeInfoTypes: - description: >- - When true, excludes type information of the findings. This is not - used for data profiling. - type: boolean - limits: - $ref: '#/components/schemas/GooglePrivacyDlpV2FindingLimits' - description: >- - Configuration to control the number of findings returned. This is - not used for data profiling. When redacting sensitive data from - images, finding limits don't apply. They can cause unexpected or - inconsistent results, where only some data is redacted. Don't - include finding limits in RedactImage requests. Otherwise, Cloud DLP - returns an error. When set within an InspectJobConfig, the specified - maximum values aren't hard limits. If an inspection job reaches - these limits, the job ends gradually, not abruptly. Therefore, the - actual number of findings that Cloud DLP returns can be multiple - times higher than these maximum values. - customInfoTypes: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2CustomInfoType' - description: >- - CustomInfoTypes provided by the user. See - https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes - to learn more. - type: array - infoTypes: - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - description: >- - Restricts what info_types to look for. The values must correspond to - InfoType values returned by ListInfoTypes or listed at - https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference. - When no InfoTypes or CustomInfoTypes are specified in a request, the - system may automatically choose a default list of detectors to run, - which may change over time. If you need precise control and - predictability as to what detectors are run you should specify - specific InfoTypes listed in the reference, otherwise a default list - will be used, which may change over time. - ruleSet: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectionRuleSet' - type: array + details: description: >- - Set of rules to apply to the findings for this InspectConfig. - Exclusion rules, contained in the set are executed in the end, other - rules are executed in the order they are specified for each info - type. - contentOptions: - description: Deprecated and unused. + A list of messages that carry the error details. There is a common + set of message types for APIs to use. type: array items: - enumDescriptions: - - Includes entire content of a file or a data stream. - - Text content within the data, excluding any metadata. - - Images found in the data. - enum: - - CONTENT_UNSPECIFIED - - CONTENT_TEXT - - CONTENT_IMAGE - type: string - includeQuote: - type: boolean - description: >- - When true, a contextual quote from the data that triggered a finding - is included in the response; see Finding.quote. This is not used for - data profiling. - minLikelihoodPerInfoType: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeLikelihood' - description: >- - Minimum likelihood per infotype. For each infotype, a user can - specify a minimum likelihood. The system only returns a finding if - its likelihood is above this threshold. If this field is not set, - the system uses the InspectConfig min_likelihood. - type: array - description: >- - Configuration description of the scanning process. When used with - redactContent only info_types and min_likelihood are currently used. - id: GooglePrivacyDlpV2InspectConfig + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + GooglePrivacyDlpV2UpdateJobTriggerRequest: + id: GooglePrivacyDlpV2UpdateJobTriggerRequest + description: Request message for UpdateJobTrigger. type: object - GooglePrivacyDlpV2CategoricalStatsConfig: properties: - field: - description: >- - Field to compute categorical stats on. All column types are - supported except for arrays and structs. However, it may be more - informative to use NumericalStats when the field type is supported, - depending on the data. - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - id: GooglePrivacyDlpV2CategoricalStatsConfig + jobTrigger: + description: New JobTrigger value. + $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' + updateMask: + description: Mask to control which fields get updated. + type: string + format: google-fieldmask + GooglePrivacyDlpV2HybridInspectJobTriggerRequest: + id: GooglePrivacyDlpV2HybridInspectJobTriggerRequest + description: Request to search for potentially sensitive info in a custom location. + type: object + properties: + hybridItem: + description: The item to inspect. + $ref: '#/components/schemas/GooglePrivacyDlpV2HybridContentItem' + GooglePrivacyDlpV2HybridContentItem: + id: GooglePrivacyDlpV2HybridContentItem description: >- - Compute numerical stats over an individual column, including number of - distinct values and value count distribution. + An individual hybrid item to inspect. Will be stored temporarily during + processing. type: object - GooglePrivacyDlpV2DiscoveryTableModifiedCadence: - description: The cadence at which to update data profiles when a table is modified. + properties: + item: + description: The item to inspect. + $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' + findingDetails: + description: Supplementary information that will be added to each finding. + $ref: '#/components/schemas/GooglePrivacyDlpV2HybridFindingDetails' + GooglePrivacyDlpV2HybridFindingDetails: + id: GooglePrivacyDlpV2HybridFindingDetails + description: Populate to associate additional data with each finding. type: object properties: - frequency: - enumDescriptions: - - Unspecified. - - After the data profile is created, it will never be updated. - - The data profile can be updated up to once every 24 hours. - - The data profile can be updated up to once every 30 days. Default. + containerDetails: description: >- - How frequently data profiles can be updated when tables are - modified. Defaults to never. - type: string - enum: - - UPDATE_FREQUENCY_UNSPECIFIED - - UPDATE_FREQUENCY_NEVER - - UPDATE_FREQUENCY_DAILY - - UPDATE_FREQUENCY_MONTHLY - types: + Details about the container where the content being inspected is + from. + $ref: '#/components/schemas/GooglePrivacyDlpV2Container' + fileOffset: description: >- - The type of events to consider when deciding if the table has been - modified and should have the profile updated. Defaults to - MODIFIED_TIMESTAMP. - type: array - items: - enum: - - TABLE_MODIFICATION_UNSPECIFIED - - TABLE_MODIFIED_TIMESTAMP - enumDescriptions: - - Unused. - - >- - A table will be considered modified when the last_modified_time - from BigQuery has been updated. - type: string - id: GooglePrivacyDlpV2DiscoveryTableModifiedCadence - GooglePrivacyDlpV2ListColumnDataProfilesResponse: - properties: - nextPageToken: + Offset in bytes of the line, from the beginning of the file, where + the finding is located. Populate if the item being scanned is only + part of a bigger item, such as a shard of a file and you want to + track the absolute position of the finding. type: string - description: The next page token. - columnDataProfiles: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2ColumnDataProfile' - type: array - description: List of data profiles. - type: object - id: GooglePrivacyDlpV2ListColumnDataProfilesResponse - description: List of profiles generated for a given organization or project. - GooglePrivacyDlpV2DataProfileLocation: - type: object - id: GooglePrivacyDlpV2DataProfileLocation - description: The data that will be profiled. - properties: - folderId: + format: int64 + rowOffset: + description: >- + Offset of the row for tables. Populate if the row(s) being scanned + are part of a bigger dataset and you want to keep track of their + absolute position. type: string format: int64 - description: The ID of the folder within an organization to scan. - organizationId: - description: The ID of an organization to scan. - type: string - format: int64 - GooglePrivacyDlpV2SummaryResult: - description: >- - A collection that informs the user the number of times a particular - `TransformationResultCode` and error details occurred. + tableOptions: + description: >- + If the container is a table, additional information to make findings + meaningful such as the columns that are primary keys. If not known + ahead of time, can also be set within each inspect hybrid call and + the two will be merged. Note that identifying_fields will only be + stored to BigQuery, and only if the BigQuery action has been + included. + $ref: '#/components/schemas/GooglePrivacyDlpV2TableOptions' + labels: + description: >- + Labels to represent user provided metadata about the data being + inspected. If configured by the job, some key values may be + required. The labels associated with `Finding`'s produced by hybrid + inspection. Label keys must be between 1 and 63 characters long and + must conform to the following regular expression: + `[a-z]([-a-z0-9]*[a-z0-9])?`. Label values must be between 0 and 63 + characters long and must conform to the regular expression + `([a-z]([-a-z0-9]*[a-z0-9])?)?`. No more than 10 labels can be + associated with a given finding. Examples: * `"environment" : + "production"` * `"pipeline" : "etl"` + type: object + additionalProperties: + type: string + GooglePrivacyDlpV2HybridInspectResponse: + id: GooglePrivacyDlpV2HybridInspectResponse + description: Quota exceeded errors will be thrown once quota has been met. + type: object + properties: {} + GooglePrivacyDlpV2ListJobTriggersResponse: + id: GooglePrivacyDlpV2ListJobTriggersResponse + description: Response message for ListJobTriggers. type: object - id: GooglePrivacyDlpV2SummaryResult properties: - details: - type: string + jobTriggers: + description: List of triggeredJobs, up to page_size in ListJobTriggersRequest. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' + nextPageToken: description: >- - A place for warnings or errors to show up if a transformation didn't - work as expected. - count: - format: int64 - description: Number of transformations counted by this result. + If the next page is available then this value is the next page token + to be used in the following ListJobTriggers request. type: string - code: - description: Outcome of the transformation. + GooglePrivacyDlpV2ActivateJobTriggerRequest: + id: GooglePrivacyDlpV2ActivateJobTriggerRequest + description: Request message for ActivateJobTrigger. + type: object + properties: {} + GooglePrivacyDlpV2DlpJob: + id: GooglePrivacyDlpV2DlpJob + description: Combines all of the information about a DLP job. + type: object + properties: + name: + description: The server-assigned name. + type: string + type: + description: The type of job. type: string + enumDescriptions: + - Defaults to INSPECT_JOB. + - The job inspected Google Cloud for sensitive data. + - The job executed a Risk Analysis computation. enum: - - TRANSFORMATION_RESULT_CODE_UNSPECIFIED - - SUCCESS - - ERROR + - DLP_JOB_TYPE_UNSPECIFIED + - INSPECT_JOB + - RISK_ANALYSIS_JOB + state: + description: State of a job. + type: string enumDescriptions: - - Unused - - Transformation completed without an error. - - Transformation had an error. - GooglePrivacyDlpV2DataProfileConfigSnapshot: - id: GooglePrivacyDlpV2DataProfileConfigSnapshot - properties: - dataProfileJob: - $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileJobConfig' - description: >- - A copy of the configuration used to generate this profile. This is - deprecated, and the DiscoveryConfig field is preferred moving - forward. DataProfileJobConfig will still be written here for - Discovery in BigQuery for backwards compatibility, but will not be - updated with new fields, while DiscoveryConfig will. - deprecated: true - inspectTemplateName: - description: Name of the inspection template used to generate this profile + - Unused. + - The job has not yet started. + - >- + The job is currently running. Once a job has finished it will + transition to FAILED or DONE. + - The job is no longer running. + - The job was canceled before it could be completed. + - The job had an error and did not complete. + - >- + The job is currently accepting findings via hybridInspect. A + hybrid job in ACTIVE state may continue to have findings added to + it through the calling of hybridInspect. After the job has + finished no more calls to hybridInspect may be made. ACTIVE jobs + can transition to DONE. + enum: + - JOB_STATE_UNSPECIFIED + - PENDING + - RUNNING + - DONE + - CANCELED + - FAILED + - ACTIVE + riskDetails: + description: Results from analyzing risk of a data source. + $ref: '#/components/schemas/GooglePrivacyDlpV2AnalyzeDataSourceRiskDetails' + inspectDetails: + description: Results from inspecting a data source. + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectDataSourceDetails' + createTime: + description: Time when the job was created. type: string - discoveryConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' - description: A copy of the configuration used to generate this profile. - inspectConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' - description: >- - A copy of the inspection config used to generate this profile. This - is a copy of the inspect_template specified in - `DataProfileJobConfig`. - inspectTemplateModifiedTime: format: google-datetime - description: Timestamp when the template was modified + startTime: + description: Time when the job started. type: string - description: Snapshot of the configurations used to generate the profile. - type: object - GooglePrivacyDlpV2Error: - properties: - timestamps: + format: google-datetime + endTime: + description: Time when the job finished. + type: string + format: google-datetime + lastModified: + description: Time when the job was last modified by the system. + type: string + format: google-datetime + jobTriggerName: description: >- - The times the error occurred. List includes the oldest timestamp and - the last 9 timestamps. + If created by a job trigger, the resource name of the trigger that + instantiated the job. + type: string + errors: + description: A stream of errors encountered running the job. type: array items: - format: google-datetime - type: string - details: - description: Detailed error codes and messages. - $ref: '#/components/schemas/GoogleRpcStatus' - extraInfo: - type: string - enum: - - ERROR_INFO_UNSPECIFIED - - IMAGE_SCAN_UNAVAILABLE_IN_REGION - - FILE_STORE_CLUSTER_UNSUPPORTED - description: Additional information about the error. - enumDescriptions: - - Unused. - - Image scan is not available in the region. - - File store cluster is not supported for profile generation. + $ref: '#/components/schemas/GooglePrivacyDlpV2Error' + actionDetails: + description: Events that should occur after the job has completed. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2ActionDetails' + GooglePrivacyDlpV2AnalyzeDataSourceRiskDetails: + id: GooglePrivacyDlpV2AnalyzeDataSourceRiskDetails + description: Result of a risk analysis operation request. type: object - id: GooglePrivacyDlpV2Error - description: >- - Details information about an error encountered during job execution or - the results of an unsuccessful activation of the JobTrigger. - GooglePrivacyDlpV2HybridContentItem: properties: - findingDetails: - description: Supplementary information that will be added to each finding. - $ref: '#/components/schemas/GooglePrivacyDlpV2HybridFindingDetails' - item: - description: The item to inspect. - $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' - id: GooglePrivacyDlpV2HybridContentItem - type: object - description: >- - An individual hybrid item to inspect. Will be stored temporarily during - processing. - GooglePrivacyDlpV2InfoTypeStats: - description: Statistics regarding a specific InfoType. + requestedPrivacyMetric: + description: Privacy metric to compute. + $ref: '#/components/schemas/GooglePrivacyDlpV2PrivacyMetric' + requestedSourceTable: + description: Input dataset to compute metrics over. + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + numericalStatsResult: + description: Numerical stats result + $ref: '#/components/schemas/GooglePrivacyDlpV2NumericalStatsResult' + categoricalStatsResult: + description: Categorical stats result + $ref: '#/components/schemas/GooglePrivacyDlpV2CategoricalStatsResult' + kAnonymityResult: + description: K-anonymity result + $ref: '#/components/schemas/GooglePrivacyDlpV2KAnonymityResult' + lDiversityResult: + description: L-divesity result + $ref: '#/components/schemas/GooglePrivacyDlpV2LDiversityResult' + kMapEstimationResult: + description: K-map result + $ref: '#/components/schemas/GooglePrivacyDlpV2KMapEstimationResult' + deltaPresenceEstimationResult: + description: Delta-presence result + $ref: '#/components/schemas/GooglePrivacyDlpV2DeltaPresenceEstimationResult' + requestedOptions: + description: The configuration used for this job. + $ref: '#/components/schemas/GooglePrivacyDlpV2RequestedRiskAnalysisOptions' + GooglePrivacyDlpV2PrivacyMetric: + id: GooglePrivacyDlpV2PrivacyMetric + description: Privacy metric to compute for reidentification risk analysis. type: object - id: GooglePrivacyDlpV2InfoTypeStats properties: - count: - type: string - format: int64 - description: Number of findings for this infoType. - infoType: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - description: The type of finding this stat is for. - GooglePrivacyDlpV2PublishToPubSub: - description: >- - Publish a message into a given Pub/Sub topic when DlpJob has completed. - The message contains a single field, `DlpJobName`, which is equal to the - finished job's - [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). - Compatible with: Inspect, Risk - id: GooglePrivacyDlpV2PublishToPubSub + numericalStatsConfig: + description: Numerical stats + $ref: '#/components/schemas/GooglePrivacyDlpV2NumericalStatsConfig' + categoricalStatsConfig: + description: Categorical stats + $ref: '#/components/schemas/GooglePrivacyDlpV2CategoricalStatsConfig' + kAnonymityConfig: + description: K-anonymity + $ref: '#/components/schemas/GooglePrivacyDlpV2KAnonymityConfig' + lDiversityConfig: + description: l-diversity + $ref: '#/components/schemas/GooglePrivacyDlpV2LDiversityConfig' + kMapEstimationConfig: + description: k-map + $ref: '#/components/schemas/GooglePrivacyDlpV2KMapEstimationConfig' + deltaPresenceEstimationConfig: + description: delta-presence + $ref: '#/components/schemas/GooglePrivacyDlpV2DeltaPresenceEstimationConfig' + GooglePrivacyDlpV2NumericalStatsConfig: + id: GooglePrivacyDlpV2NumericalStatsConfig + description: >- + Compute numerical stats over an individual column, including min, max, + and quantiles. + type: object properties: - topic: - type: string + field: description: >- - Cloud Pub/Sub topic to send notifications to. The topic must have - given publishing access rights to the DLP API service account - executing the long running DlpJob sending the notifications. Format - is projects/{project}/topics/{topic}. - type: object - GooglePrivacyDlpV2LargeCustomDictionaryConfig: + Field to compute numerical stats on. Supported types are integer, + float, date, datetime, timestamp, time. + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + GooglePrivacyDlpV2CategoricalStatsConfig: + id: GooglePrivacyDlpV2CategoricalStatsConfig description: >- - Configuration for a custom dictionary created from a data source of any - size up to the maximum size defined in the - [limits](https://cloud.google.com/sensitive-data-protection/limits) - page. The artifacts of dictionary creation are stored in the specified - Cloud Storage location. Consider using `CustomInfoType.Dictionary` for - smaller dictionaries that satisfy the size requirements. + Compute numerical stats over an individual column, including number of + distinct values and value count distribution. type: object properties: - outputPath: - description: >- - Location to store dictionary artifacts in Cloud Storage. These files - will only be accessible by project owners and the DLP API. If any of - these artifacts are modified, the dictionary is considered invalid - and can no longer be used. - $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStoragePath' - bigQueryField: - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryField' - description: >- - Field in a BigQuery table where each cell represents a dictionary - phrase. - cloudStorageFileSet: + field: description: >- - Set of files containing newline-delimited lists of dictionary - phrases. - $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStorageFileSet' - id: GooglePrivacyDlpV2LargeCustomDictionaryConfig - GooglePrivacyDlpV2DeidentifyConfig: + Field to compute categorical stats on. All column types are + supported except for arrays and structs. However, it may be more + informative to use NumericalStats when the field type is supported, + depending on the data. + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + GooglePrivacyDlpV2KAnonymityConfig: + id: GooglePrivacyDlpV2KAnonymityConfig + description: k-anonymity metric, used for analysis of reidentification risk. + type: object properties: - transformationErrorHandling: - $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationErrorHandling' - description: >- - Mode for handling transformation errors. If left unspecified, the - default mode is `TransformationErrorHandling.ThrowError`. - recordTransformations: - $ref: '#/components/schemas/GooglePrivacyDlpV2RecordTransformations' + quasiIds: description: >- - Treat the dataset as structured. Transformations can be applied to - specific locations within structured datasets, such as transforming - a column within a table. - imageTransformations: - description: Treat the dataset as an image and redact. - $ref: '#/components/schemas/GooglePrivacyDlpV2ImageTransformations' - infoTypeTransformations: + Set of fields to compute k-anonymity over. When multiple fields are + specified, they are considered a single composite key. Structs and + repeated data types are not supported; however, nested fields are + supported so long as they are not structs themselves or nested + within a repeated field. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + entityId: description: >- - Treat the dataset as free-form text and apply the same free text - transformation everywhere. - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeTransformations' - description: The configuration that controls how the data will change. - type: object - id: GooglePrivacyDlpV2DeidentifyConfig - GooglePrivacyDlpV2Manual: - id: GooglePrivacyDlpV2Manual - properties: {} - type: object + Message indicating that multiple rows might be associated to a + single individual. If the same entity_id is associated to multiple + quasi-identifier tuples over distinct rows, we consider the entire + collection of tuples as the composite quasi-identifier. This + collection is a multiset: the order in which the different tuples + appear in the dataset is ignored, but their frequency is taken into + account. Important note: a maximum of 1000 rows can be associated to + a single entity ID. If more rows are associated with the same entity + ID, some might be ignored. + $ref: '#/components/schemas/GooglePrivacyDlpV2EntityId' + GooglePrivacyDlpV2EntityId: + id: GooglePrivacyDlpV2EntityId description: >- - Job trigger option for hybrid jobs. Jobs must be manually created and - finished. - GooglePrivacyDlpV2HotwordRule: + An entity in a dataset is a field or set of fields that correspond to a + single person. For example, in medical records the `EntityId` might be a + patient identifier, or for financial records it might be an account + identifier. This message is used when generalizations or analysis must + take into account that multiple rows correspond to the same entity. type: object properties: - likelihoodAdjustment: - $ref: '#/components/schemas/GooglePrivacyDlpV2LikelihoodAdjustment' - description: Likelihood adjustment to apply to all matching findings. - proximity: - $ref: '#/components/schemas/GooglePrivacyDlpV2Proximity' + field: + description: Composite key indicating which field contains the entity identifier. + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + GooglePrivacyDlpV2LDiversityConfig: + id: GooglePrivacyDlpV2LDiversityConfig + description: l-diversity metric, used for analysis of reidentification risk. + type: object + properties: + quasiIds: description: >- - Range of characters within which the entire hotword must reside. The - total length of the window cannot exceed 1000 characters. The - finding itself will be included in the window, so that hotwords can - be used to match substrings of the finding itself. Suppose you want - Cloud DLP to promote the likelihood of the phone number regex - "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area - code of a company's office. In this case, use the hotword regex - "\(xxx\)", where "xxx" is the area code in question. For tabular - data, if you want to modify the likelihood of an entire column of - findngs, see [Hotword example: Set the match likelihood of a table - column] - (https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). - hotwordRegex: - $ref: '#/components/schemas/GooglePrivacyDlpV2Regex' - description: Regular expression pattern defining what qualifies as a hotword. - description: >- - The rule that adjusts the likelihood of findings within a certain - proximity of hotwords. - id: GooglePrivacyDlpV2HotwordRule - GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig: + Set of quasi-identifiers indicating how equivalence classes are + defined for the l-diversity computation. When multiple fields are + specified, they are considered a single composite key. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + sensitiveAttribute: + description: Sensitive field for computing the l-value. + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + GooglePrivacyDlpV2KMapEstimationConfig: + id: GooglePrivacyDlpV2KMapEstimationConfig description: >- - Replaces an identifier with a surrogate using Format Preserving - Encryption (FPE) with the FFX mode of operation; however when used in - the `ReidentifyContent` API method, it serves the opposite function by - reversing the surrogate back into the original identifier. The - identifier must be encoded as ASCII. For a given crypto key and context, - the same identifier will be replaced with the same surrogate. - Identifiers must be at least two characters long. In the case that the - identifier is the empty string, it will be skipped. See - https://cloud.google.com/sensitive-data-protection/docs/pseudonymization - to learn more. Note: We recommend using CryptoDeterministicConfig for - all use cases which do not require preserving the input alphabet space - and size, plus warrant referential integrity. + Reidentifiability metric. This corresponds to a risk model similar to + what is called "journalist risk" in the literature, except the attack + dataset is statistically modeled instead of being perfectly known. This + can be done using publicly available data (like the US Census), or using + a custom statistical model (indicated as one or several BigQuery + tables), or by extrapolating from the distribution of values in the + input dataset. + type: object properties: - surrogateInfoType: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + quasiIds: description: >- - The custom infoType to annotate the surrogate with. This annotation - will be applied to the surrogate by prefixing it with the name of - the custom infoType followed by the number of characters comprising - the surrogate. The following scheme defines the format: - info_type_name(surrogate_character_count):surrogate For example, if - the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the - surrogate is 'abc', the full replacement value will be: - 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate - when inspecting content using the custom infoType - [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). - This facilitates reversal of the surrogate when it occurs in free - text. In order for inspection to work properly, the name of this - infoType must not occur naturally anywhere in your data; otherwise, - inspection may find a surrogate that does not correspond to an - actual identifier. Therefore, choose your custom infoType name - carefully after considering what your data looks like. One way to - select a name that has a high chance of yielding reliable detection - is to include one or more unicode characters that are highly - improbable to exist in your data. For example, assuming your data is - entered from a regular ASCII keyboard, the symbol with the hex code - point 29DD might be used like so: ⧝MY_TOKEN_TYPE - radix: - description: The native way to select the alphabet. Must be in the range [2, 95]. - format: int32 - type: integer - customAlphabet: + Required. Fields considered to be quasi-identifiers. No two columns + can have the same tag. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2TaggedField' + regionCode: description: >- - This is supported by mapping these to the alphanumeric characters - that the FFX mode natively supports. This happens before/after - encryption/decryption. Each character listed must appear only once. - Number of characters must be in the range [2, 95]. This must be - encoded as ASCII. The order of characters does not matter. The full - list of allowed characters is: - ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` + ISO 3166-1 alpha-2 region code to use in the statistical modeling. + Set if no column is tagged with a region-specific InfoType (like + US_ZIP_5) or a region code. type: string - cryptoKey: - description: Required. The key used by the encryption algorithm. - $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoKey' - context: + auxiliaryTables: description: >- - The 'tweak', a context may be used for higher security since the - same identifier in two different contexts won't be given the same - surrogate. If the context is not set, a default tweak will be used. - If the context is set but: 1. there is no record present when - transforming a given value or 1. the field is not present when - transforming a given value, a default tweak will be used. Note that - case (1) is expected when an `InfoTypeTransformation` is applied to - both structured and unstructured `ContentItem`s. Currently, the - referenced field may be of value type integer or string. The tweak - is constructed as a sequence of bytes in big endian byte order such - that: - a 64 bit integer is encoded followed by a single byte of - value 1 - a string is encoded in UTF-8 format followed by a single - byte of value 2 + Several auxiliary tables can be used in the analysis. Each + custom_tag used to tag a quasi-identifiers column must appear in + exactly one column of one auxiliary table. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2AuxiliaryTable' + GooglePrivacyDlpV2TaggedField: + id: GooglePrivacyDlpV2TaggedField + description: A column with a semantic tag attached. + type: object + properties: + field: + description: Required. Identifies the column. $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - commonAlphabet: - enum: - - FFX_COMMON_NATIVE_ALPHABET_UNSPECIFIED - - NUMERIC - - HEXADECIMAL - - UPPER_CASE_ALPHA_NUMERIC - - ALPHA_NUMERIC - enumDescriptions: - - Unused. - - '`[0-9]` (radix of 10)' - - '`[0-9A-F]` (radix of 16)' - - '`[0-9A-Z]` (radix of 36)' - - '`[0-9A-Za-z]` (radix of 62)' - description: Common alphabets. + infoType: + description: >- + A column can be tagged with a InfoType to use the relevant public + dataset as a statistical model of population, if available. We + currently support US ZIP codes, region codes, ages and genders. To + programmatically obtain the list of supported InfoTypes, use + ListInfoTypes with the supported_by=RISK_ANALYSIS filter. + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + customTag: + description: >- + A column can be tagged with a custom tag. In this case, the user + must indicate an auxiliary table that contains statistical + information on the possible values of this column. type: string - id: GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig - type: object - GooglePrivacyDlpV2VersionDescription: - id: GooglePrivacyDlpV2VersionDescription + inferred: + description: >- + If no semantic tag is indicated, we infer the statistical model from + the distribution of values in the input data + $ref: '#/components/schemas/GoogleProtobufEmpty' + GooglePrivacyDlpV2AuxiliaryTable: + id: GooglePrivacyDlpV2AuxiliaryTable + description: >- + An auxiliary table contains statistical information on the relative + frequency of different quasi-identifiers values. It has one or several + quasi-identifiers columns, and one column that indicates the relative + frequency of each quasi-identifier tuple. If a tuple is present in the + data but not in the auxiliary table, the corresponding relative + frequency is assumed to be zero (and thus, the tuple is highly + reidentifiable). type: object properties: - version: - description: Name of the version - type: string - description: - type: string - description: Description of the version. - description: Details about each available version for an infotype. - GooglePrivacyDlpV2Range: - description: Generic half-open interval [start, end) + table: + description: Required. Auxiliary table location. + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + quasiIds: + description: Required. Quasi-identifier columns. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2QuasiIdField' + relativeFrequency: + description: >- + Required. The relative frequency column must contain a + floating-point number between 0 and 1 (inclusive). Null values are + assumed to be zero. + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + GooglePrivacyDlpV2QuasiIdField: + id: GooglePrivacyDlpV2QuasiIdField + description: >- + A quasi-identifier column has a custom_tag, used to know which column in + the data corresponds to which column in the statistical model. type: object - id: GooglePrivacyDlpV2Range properties: - start: - format: int64 - type: string - description: Index of the first character of the range (inclusive). - end: - format: int64 + field: + description: Identifies the column. + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + customTag: + description: A auxiliary field. type: string - description: Index of the last character of the range (exclusive). - GooglePrivacyDlpV2DataProfileJobConfig: - id: GooglePrivacyDlpV2DataProfileJobConfig + GooglePrivacyDlpV2DeltaPresenceEstimationConfig: + id: GooglePrivacyDlpV2DeltaPresenceEstimationConfig description: >- - Configuration for setting up a job to scan resources for profile - generation. Only one data profile configuration may exist per - organization, folder, or project. The generated data profiles are - retained according to the [data retention policy] - (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). + δ-presence metric, used to estimate how likely it is for an attacker to + figure out that one given individual appears in a de-identified dataset. + Similarly to the k-map metric, we cannot compute δ-presence exactly + without knowing the attack dataset, so we use a statistical model + instead. type: object properties: - inspectTemplates: + quasiIds: description: >- - Detection logic for profile generation. Not all template features - are used by profiles. FindingLimits, include_quote and - exclude_info_types have no impact on data profiling. Multiple - templates may be provided if there is data in multiple regions. At - most one template must be specified per-region (including "global"). - Each region is scanned using the applicable template. If no - region-specific template is specified, but a "global" template is - specified, it will be copied to that region and used instead. If no - global or region-specific template is provided for a region with - data, that region's data will not be scanned. For more information, - see - https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. - items: - type: string + Required. Fields considered to be quasi-identifiers. No two fields + can have the same tag. type: array - projectId: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2QuasiId' + regionCode: + description: >- + ISO 3166-1 alpha-2 region code to use in the statistical modeling. + Set if no column is tagged with a region-specific InfoType (like + US_ZIP_5) or a region code. type: string + auxiliaryTables: description: >- - The project that will run the scan. The DLP service account that - exists within this project must have access to all resources that - are profiled, and the DLP API must be enabled. - dataProfileActions: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileAction' - description: Actions to execute at the completion of the job. + Several auxiliary tables can be used in the analysis. Each + custom_tag used to tag a quasi-identifiers field must appear in + exactly one field of one auxiliary table. type: array - location: - $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileLocation' - description: The data to scan. - otherCloudStartingLocation: - description: Must be set only when scanning other clouds. - $ref: >- - #/components/schemas/GooglePrivacyDlpV2OtherCloudDiscoveryStartingLocation - GooglePrivacyDlpV2BigQueryDiscoveryTarget: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2StatisticalTable' + GooglePrivacyDlpV2QuasiId: + id: GooglePrivacyDlpV2QuasiId + description: A column with a semantic tag attached. type: object properties: - conditions: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryBigQueryConditions' + field: + description: Required. Identifies the column. + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + infoType: description: >- - In addition to matching the filter, these conditions must be true - before a profile is generated. - cadence: + A column can be tagged with a InfoType to use the relevant public + dataset as a statistical model of population, if available. We + currently support US ZIP codes, region codes, ages and genders. To + programmatically obtain the list of supported InfoTypes, use + ListInfoTypes with the supported_by=RISK_ANALYSIS filter. + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + customTag: description: >- - How often and when to update profiles. New tables that match both - the filter and conditions are scanned as quickly as possible - depending on system capacity. - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryGenerationCadence' - filter: + A column can be tagged with a custom tag. In this case, the user + must indicate an auxiliary table that contains statistical + information on the possible values of this column. + type: string + inferred: description: >- - Required. The tables the discovery cadence applies to. The first - target with a matching filter will be the one to apply to a table. - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryBigQueryFilter' - disabled: - description: Tables that match this filter will not have profiles created. - $ref: '#/components/schemas/GooglePrivacyDlpV2Disabled' - id: GooglePrivacyDlpV2BigQueryDiscoveryTarget - description: Target used to match against for discovery with BigQuery tables - GooglePrivacyDlpV2AwsDiscoveryStartingLocation: - id: GooglePrivacyDlpV2AwsDiscoveryStartingLocation + If no semantic tag is indicated, we infer the statistical model from + the distribution of values in the input data + $ref: '#/components/schemas/GoogleProtobufEmpty' + GooglePrivacyDlpV2StatisticalTable: + id: GooglePrivacyDlpV2StatisticalTable + description: >- + An auxiliary table containing statistical information on the relative + frequency of different quasi-identifiers values. It has one or several + quasi-identifiers columns, and one column that indicates the relative + frequency of each quasi-identifier tuple. If a tuple is present in the + data but not in the auxiliary table, the corresponding relative + frequency is assumed to be zero (and thus, the tuple is highly + reidentifiable). type: object properties: - allAssetInventoryAssets: - type: boolean - description: >- - All AWS assets stored in Asset Inventory that didn't match other AWS - discovery configs. - accountId: + table: + description: Required. Auxiliary table location. + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + quasiIds: + description: Required. Quasi-identifier columns. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2QuasiIdentifierField' + relativeFrequency: description: >- - The AWS account ID that this discovery config applies to. Within an - AWS organization, you can find the AWS account ID inside an AWS - account ARN. Example: - arn:{partition}:organizations::{management_account_id}:account/{org_id}/{account_id} - type: string - description: The AWS starting location for discovery. - GooglePrivacyDlpV2RecordSuppression: + Required. The relative frequency column must contain a + floating-point number between 0 and 1 (inclusive). Null values are + assumed to be zero. + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + GooglePrivacyDlpV2QuasiIdentifierField: + id: GooglePrivacyDlpV2QuasiIdentifierField description: >- - Configuration to suppress records whose suppression conditions evaluate - to true. - properties: - condition: - $ref: '#/components/schemas/GooglePrivacyDlpV2RecordCondition' - description: >- - A condition that when it evaluates to true will result in the record - being evaluated to be suppressed from the transformed content. - id: GooglePrivacyDlpV2RecordSuppression + A quasi-identifier column has a custom_tag, used to know which column in + the data corresponds to which column in the statistical model. type: object - GooglePrivacyDlpV2InfoTypeLikelihood: properties: - minLikelihood: - enumDescriptions: - - Default value; same as POSSIBLE. - - Highest chance of a false positive. - - High chance of a false positive. - - Some matching signals. The default value. - - Low chance of a false positive. - - Confidence level is high. Lowest chance of a false positive. + field: + description: Identifies the column. + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + customTag: description: >- - Only returns findings equal to or above this threshold. This field - is required or else the configuration fails. + A column can be tagged with a custom tag. In this case, the user + must indicate an auxiliary table that contains statistical + information on the possible values of this column. type: string - enum: - - LIKELIHOOD_UNSPECIFIED - - VERY_UNLIKELY - - UNLIKELY - - POSSIBLE - - LIKELY - - VERY_LIKELY - infoType: + GooglePrivacyDlpV2NumericalStatsResult: + id: GooglePrivacyDlpV2NumericalStatsResult + description: Result of the numerical stats computation. + type: object + properties: + minValue: + description: Minimum value appearing in the column. + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + maxValue: + description: Maximum value appearing in the column. + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + quantileValues: description: >- - Type of information the likelihood threshold applies to. Only one - likelihood per info_type should be provided. If InfoTypeLikelihood - does not have an info_type, the configuration fails. - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - description: >- - Configuration for setting a minimum likelihood per infotype. Used to - customize the minimum likelihood level for specific infotypes in the - request. For example, use this if you want to lower the precision for - PERSON_NAME without lowering the precision for the other infotypes in - the request. - id: GooglePrivacyDlpV2InfoTypeLikelihood + List of 99 values that partition the set of field values into 100 + equal sized buckets. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + GooglePrivacyDlpV2CategoricalStatsResult: + id: GooglePrivacyDlpV2CategoricalStatsResult + description: Result of the categorical stats computation. type: object - GooglePrivacyDlpV2CreateDiscoveryConfigRequest: - description: Request message for CreateDiscoveryConfig. properties: - discoveryConfig: - description: Required. The DiscoveryConfig to create. - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' - configId: + valueFrequencyHistogramBuckets: + description: Histogram of value frequencies in the column. + type: array + items: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2CategoricalStatsHistogramBucket + GooglePrivacyDlpV2CategoricalStatsHistogramBucket: + id: GooglePrivacyDlpV2CategoricalStatsHistogramBucket + description: Histogram of value frequencies in the column. + type: object + properties: + valueFrequencyLowerBound: + description: Lower bound on the value frequency of the values in this bucket. + type: string + format: int64 + valueFrequencyUpperBound: + description: Upper bound on the value frequency of the values in this bucket. + type: string + format: int64 + bucketSize: + description: Total number of values in this bucket. type: string + format: int64 + bucketValues: description: >- - The config ID can contain uppercase and lowercase letters, numbers, - and hyphens; that is, it must match the regular expression: - `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty - to allow the system to generate one. - type: object - id: GooglePrivacyDlpV2CreateDiscoveryConfigRequest - GooglePrivacyDlpV2DiscoveryConfig: - description: >- - Configuration for discovery to scan resources for profile generation. - Only one discovery configuration may exist per organization, folder, or - project. The generated data profiles are retained according to the [data - retention policy] - (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). + Sample of value frequencies in this bucket. The total number of + values returned per bucket is capped at 20. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2ValueFrequency' + bucketValueCount: + description: Total number of distinct values in this bucket. + type: string + format: int64 + GooglePrivacyDlpV2ValueFrequency: + id: GooglePrivacyDlpV2ValueFrequency + description: A value of a field, including its frequency. type: object - id: GooglePrivacyDlpV2DiscoveryConfig properties: - displayName: + value: + description: A value contained in the field in question. + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + count: + description: How many times the value is contained in the field. type: string - description: Display name (max 100 chars) - targets: + format: int64 + GooglePrivacyDlpV2KAnonymityResult: + id: GooglePrivacyDlpV2KAnonymityResult + description: Result of the k-anonymity computation. + type: object + properties: + equivalenceClassHistogramBuckets: + description: Histogram of k-anonymity equivalence classes. type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryTarget' + $ref: '#/components/schemas/GooglePrivacyDlpV2KAnonymityHistogramBucket' + GooglePrivacyDlpV2KAnonymityHistogramBucket: + id: GooglePrivacyDlpV2KAnonymityHistogramBucket + description: Histogram of k-anonymity equivalence classes. + type: object + properties: + equivalenceClassSizeLowerBound: + description: Lower bound on the size of the equivalence classes in this bucket. + type: string + format: int64 + equivalenceClassSizeUpperBound: + description: Upper bound on the size of the equivalence classes in this bucket. + type: string + format: int64 + bucketSize: + description: Total number of equivalence classes in this bucket. + type: string + format: int64 + bucketValues: description: >- - Target to match against for determining what to scan and how - frequently. - actions: - description: Actions to execute at the completion of scanning. + Sample of equivalence classes in this bucket. The total number of + classes returned per bucket is capped at 20. + type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileAction' + $ref: '#/components/schemas/GooglePrivacyDlpV2KAnonymityEquivalenceClass' + bucketValueCount: + description: Total number of distinct equivalence classes in this bucket. + type: string + format: int64 + GooglePrivacyDlpV2KAnonymityEquivalenceClass: + id: GooglePrivacyDlpV2KAnonymityEquivalenceClass + description: The set of columns' values that share the same ldiversity value + type: object + properties: + quasiIdsValues: + description: >- + Set of values defining the equivalence class. One value per + quasi-identifier column in the original KAnonymity metric message. + The order is always the same as the original request. type: array - name: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + equivalenceClassSize: description: >- - Unique resource name for the DiscoveryConfig, assigned by the - service when the DiscoveryConfig is created, for example - `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. + Size of the equivalence class, for example number of rows with the + above set of values. type: string - inspectTemplates: + format: int64 + GooglePrivacyDlpV2LDiversityResult: + id: GooglePrivacyDlpV2LDiversityResult + description: Result of the l-diversity computation. + type: object + properties: + sensitiveValueFrequencyHistogramBuckets: description: >- - Detection logic for profile generation. Not all template features - are used by Discovery. FindingLimits, include_quote and - exclude_info_types have no impact on Discovery. Multiple templates - may be provided if there is data in multiple regions. At most one - template must be specified per-region (including "global"). Each - region is scanned using the applicable template. If no - region-specific template is specified, but a "global" template is - specified, it will be copied to that region and used instead. If no - global or region-specific template is provided for a region with - data, that region's data will not be scanned. For more information, - see - https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. + Histogram of l-diversity equivalence class sensitive value + frequencies. type: array items: - type: string - updateTime: - description: Output only. The last update timestamp of a DiscoveryConfig. - readOnly: true - format: google-datetime + $ref: '#/components/schemas/GooglePrivacyDlpV2LDiversityHistogramBucket' + GooglePrivacyDlpV2LDiversityHistogramBucket: + id: GooglePrivacyDlpV2LDiversityHistogramBucket + description: Histogram of l-diversity equivalence class sensitive value frequencies. + type: object + properties: + sensitiveValueFrequencyLowerBound: + description: >- + Lower bound on the sensitive value frequencies of the equivalence + classes in this bucket. type: string - createTime: + format: int64 + sensitiveValueFrequencyUpperBound: + description: >- + Upper bound on the sensitive value frequencies of the equivalence + classes in this bucket. type: string - description: Output only. The creation timestamp of a DiscoveryConfig. - format: google-datetime - readOnly: true - lastRunTime: - readOnly: true + format: int64 + bucketSize: + description: Total number of equivalence classes in this bucket. type: string + format: int64 + bucketValues: description: >- - Output only. The timestamp of the last time this config was - executed. - format: google-datetime - status: - type: string - description: Required. A status for this configuration. - enumDescriptions: - - Unused - - The discovery config is currently active. - - The discovery config is paused temporarily. - enum: - - STATUS_UNSPECIFIED - - RUNNING - - PAUSED - orgConfig: - description: Only set when the parent is an org. - $ref: '#/components/schemas/GooglePrivacyDlpV2OrgConfig' - errors: + Sample of equivalence classes in this bucket. The total number of + classes returned per bucket is capped at 20. type: array - description: >- - Output only. A stream of errors encountered when the config was - activated. Repeated errors may result in the config automatically - being paused. Output only field. Will return the last 100 errors. - Whenever the config is modified this list will be cleared. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Error' - readOnly: true - otherCloudStartingLocation: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2OtherCloudDiscoveryStartingLocation - description: Must be set only when scanning other clouds. - GooglePrivacyDlpV2FindingLimits: - description: >- - Configuration to control the number of findings returned for inspection. - This is not used for de-identification or data profiling. When redacting - sensitive data from images, finding limits don't apply. They can cause - unexpected or inconsistent results, where only some data is redacted. - Don't include finding limits in RedactImage requests. Otherwise, Cloud - DLP returns an error. + $ref: '#/components/schemas/GooglePrivacyDlpV2LDiversityEquivalenceClass' + bucketValueCount: + description: Total number of distinct equivalence classes in this bucket. + type: string + format: int64 + GooglePrivacyDlpV2LDiversityEquivalenceClass: + id: GooglePrivacyDlpV2LDiversityEquivalenceClass + description: The set of columns' values that share the same ldiversity value. type: object properties: - maxFindingsPerItem: - description: >- - Max number of findings that are returned for each item scanned. When - set within an InspectContentRequest, this field is ignored. This - value isn't a hard limit. If the number of findings for an item - reaches this limit, the inspection of that item ends gradually, not - abruptly. Therefore, the actual number of findings that Cloud DLP - returns for the item can be multiple times higher than this value. - format: int32 - type: integer - maxFindingsPerRequest: - type: integer + quasiIdsValues: description: >- - Max number of findings that are returned per request or job. If you - set this field in an InspectContentRequest, the resulting maximum - value is the value that you set or 3,000, whichever is lower. This - value isn't a hard limit. If an inspection reaches this limit, the - inspection ends gradually, not abruptly. Therefore, the actual - number of findings that Cloud DLP returns can be multiple times - higher than this value. - format: int32 - maxFindingsPerInfoType: - description: Configuration of findings limit given for specified infoTypes. + Quasi-identifier values defining the k-anonymity equivalence class. + The order is always the same as the original request. + type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeLimit' + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + equivalenceClassSize: + description: Size of the k-anonymity equivalence class. + type: string + format: int64 + numDistinctSensitiveValues: + description: Number of distinct sensitive values in this equivalence class. + type: string + format: int64 + topSensitiveValues: + description: Estimated frequencies of top sensitive values. type: array - id: GooglePrivacyDlpV2FindingLimits - GooglePrivacyDlpV2KAnonymityConfig: - description: k-anonymity metric, used for analysis of reidentification risk. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2ValueFrequency' + GooglePrivacyDlpV2KMapEstimationResult: + id: GooglePrivacyDlpV2KMapEstimationResult + description: >- + Result of the reidentifiability analysis. Note that these results are an + estimation, not exact values. type: object - id: GooglePrivacyDlpV2KAnonymityConfig properties: - entityId: - $ref: '#/components/schemas/GooglePrivacyDlpV2EntityId' - description: >- - Message indicating that multiple rows might be associated to a - single individual. If the same entity_id is associated to multiple - quasi-identifier tuples over distinct rows, we consider the entire - collection of tuples as the composite quasi-identifier. This - collection is a multiset: the order in which the different tuples - appear in the dataset is ignored, but their frequency is taken into - account. Important note: a maximum of 1000 rows can be associated to - a single entity ID. If more rows are associated with the same entity - ID, some might be ignored. - quasiIds: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + kMapEstimationHistogram: description: >- - Set of fields to compute k-anonymity over. When multiple fields are - specified, they are considered a single composite key. Structs and - repeated data types are not supported; however, nested fields are - supported so long as they are not structs themselves or nested - within a repeated field. + The intervals [min_anonymity, max_anonymity] do not overlap. If a + value doesn't correspond to any such interval, the associated + frequency is zero. For example, the following records: + {min_anonymity: 1, max_anonymity: 1, frequency: 17} {min_anonymity: + 2, max_anonymity: 3, frequency: 42} {min_anonymity: 5, + max_anonymity: 10, frequency: 99} mean that there are no record with + an estimated anonymity of 4, 5, or larger than 10. type: array - GooglePrivacyDlpV2BigQueryKey: - description: Row key for identifying a record in BigQuery table. - id: GooglePrivacyDlpV2BigQueryKey + items: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2KMapEstimationHistogramBucket + GooglePrivacyDlpV2KMapEstimationHistogramBucket: + id: GooglePrivacyDlpV2KMapEstimationHistogramBucket + description: >- + A KMapEstimationHistogramBucket message with the following values: + min_anonymity: 3 max_anonymity: 5 frequency: 42 means that there are 42 + records whose quasi-identifier values correspond to 3, 4 or 5 people in + the overlying population. An important particular case is when + min_anonymity = max_anonymity = 1: the frequency field then corresponds + to the number of uniquely identifiable records. type: object properties: - rowNumber: + minAnonymity: + description: Always positive. + type: string + format: int64 + maxAnonymity: + description: Always greater than or equal to min_anonymity. + type: string + format: int64 + bucketSize: + description: Number of records within these anonymity bounds. + type: string format: int64 + bucketValues: description: >- - Row number inferred at the time the table was scanned. This value is - nondeterministic, cannot be queried, and may be null for inspection - jobs. To locate findings within a table, specify - `inspect_job.storage_config.big_query_options.identifying_fields` in - `CreateDlpJobRequest`. + Sample of quasi-identifier tuple values in this bucket. The total + number of classes returned per bucket is capped at 20. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2KMapEstimationQuasiIdValues' + bucketValueCount: + description: >- + Total number of distinct quasi-identifier tuple values in this + bucket. type: string - tableReference: - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' - description: Complete BigQuery table reference. - GooglePrivacyDlpV2ReplaceDictionaryConfig: + format: int64 + GooglePrivacyDlpV2KMapEstimationQuasiIdValues: + id: GooglePrivacyDlpV2KMapEstimationQuasiIdValues + description: A tuple of values for the quasi-identifier columns. type: object properties: - wordList: - $ref: '#/components/schemas/GooglePrivacyDlpV2WordList' - description: >- - A list of words to select from for random replacement. The - [limits](https://cloud.google.com/sensitive-data-protection/limits) - page contains details about the size limits of dictionaries. + quasiIdsValues: + description: The quasi-identifier values. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + estimatedAnonymity: + description: The estimated anonymity for these quasi-identifier values. + type: string + format: int64 + GooglePrivacyDlpV2DeltaPresenceEstimationResult: + id: GooglePrivacyDlpV2DeltaPresenceEstimationResult description: >- - Replace each input value with a value randomly selected from the - dictionary. - id: GooglePrivacyDlpV2ReplaceDictionaryConfig - GooglePrivacyDlpV2ReplaceValueConfig: - description: Replace each input value with a given `Value`. - properties: - newValue: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - description: Value to replace it with. - type: object - id: GooglePrivacyDlpV2ReplaceValueConfig - GooglePrivacyDlpV2TransformationDescription: - id: GooglePrivacyDlpV2TransformationDescription + Result of the δ-presence computation. Note that these results are an + estimation, not exact values. type: object properties: - description: + deltaPresenceEstimationHistogram: description: >- - A description of the transformation. This is empty for a - RECORD_SUPPRESSION, or is the output of calling toString() on the - `PrimitiveTransformation` protocol buffer message for any other type - of transformation. + The intervals [min_probability, max_probability) do not overlap. If + a value doesn't correspond to any such interval, the associated + frequency is zero. For example, the following records: + {min_probability: 0, max_probability: 0.1, frequency: 17} + {min_probability: 0.2, max_probability: 0.3, frequency: 42} + {min_probability: 0.3, max_probability: 0.4, frequency: 99} mean + that there are no record with an estimated probability in [0.1, 0.2) + nor larger or equal to 0.4. + type: array + items: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DeltaPresenceEstimationHistogramBucket + GooglePrivacyDlpV2DeltaPresenceEstimationHistogramBucket: + id: GooglePrivacyDlpV2DeltaPresenceEstimationHistogramBucket + description: >- + A DeltaPresenceEstimationHistogramBucket message with the following + values: min_probability: 0.1 max_probability: 0.2 frequency: 42 means + that there are 42 records for which δ is in [0.1, 0.2). An important + particular case is when min_probability = max_probability = 1: then, + every individual who shares this quasi-identifier combination is in the + dataset. + type: object + properties: + minProbability: + description: Between 0 and 1. + type: number + format: double + maxProbability: + description: Always greater than or equal to min_probability. + type: number + format: double + bucketSize: + description: Number of records within these probability bounds. type: string - infoType: - description: Set if the transformation was limited to a specific `InfoType`. - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - condition: + format: int64 + bucketValues: + description: >- + Sample of quasi-identifier tuple values in this bucket. The total + number of classes returned per bucket is capped at 20. + type: array + items: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DeltaPresenceEstimationQuasiIdValues + bucketValueCount: + description: >- + Total number of distinct quasi-identifier tuple values in this + bucket. type: string + format: int64 + GooglePrivacyDlpV2DeltaPresenceEstimationQuasiIdValues: + id: GooglePrivacyDlpV2DeltaPresenceEstimationQuasiIdValues + description: A tuple of values for the quasi-identifier columns. + type: object + properties: + quasiIdsValues: + description: The quasi-identifier values. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + estimatedProbability: description: >- - A human-readable string representation of the `RecordCondition` - corresponding to this transformation. Set if a `RecordCondition` was - used to determine whether or not to apply this transformation. - Examples: * (age_field > 85) * (age_field <= 18) * (zip_field - exists) * (zip_field == 01234) && (city_field != "Springville") * - (zip_field == 01234) && (age_field <= 18) && (city_field exists) - type: - enumDescriptions: - - Unused - - Record suppression - - Replace value - - Replace value using a dictionary. - - Redact - - Character mask - - FFX-FPE - - Fixed size bucketing - - Bucketing - - Replace with info type - - Time part - - Crypto hash - - Date shift - - Deterministic crypto - - Redact image - description: The transformation type. - enum: - - TRANSFORMATION_TYPE_UNSPECIFIED - - RECORD_SUPPRESSION - - REPLACE_VALUE - - REPLACE_DICTIONARY - - REDACT - - CHARACTER_MASK - - CRYPTO_REPLACE_FFX_FPE - - FIXED_SIZE_BUCKETING - - BUCKETING - - REPLACE_WITH_INFO_TYPE - - TIME_PART - - CRYPTO_HASH - - DATE_SHIFT - - CRYPTO_DETERMINISTIC_CONFIG - - REDACT_IMAGE - type: string + The estimated probability that a given individual sharing these + quasi-identifier values is in the dataset. This value, typically + called δ, is the ratio between the number of records in the dataset + with these quasi-identifier values, and the total number of + individuals (inside *and* outside the dataset) with these + quasi-identifier values. For example, if there are 15 individuals in + the dataset who share the same quasi-identifier values, and an + estimated 100 people in the entire population with these values, + then δ is 0.15. + type: number + format: double + GooglePrivacyDlpV2RequestedRiskAnalysisOptions: + id: GooglePrivacyDlpV2RequestedRiskAnalysisOptions + description: Risk analysis options. + type: object + properties: + jobConfig: + description: The job config for the risk job. + $ref: '#/components/schemas/GooglePrivacyDlpV2RiskAnalysisJobConfig' + GooglePrivacyDlpV2RiskAnalysisJobConfig: + id: GooglePrivacyDlpV2RiskAnalysisJobConfig description: >- - A flattened description of a `PrimitiveTransformation` or - `RecordSuppression`. + Configuration for a risk analysis job. See + https://cloud.google.com/sensitive-data-protection/docs/concepts-risk-analysis + to learn more. + type: object + properties: + privacyMetric: + description: Privacy metric to compute. + $ref: '#/components/schemas/GooglePrivacyDlpV2PrivacyMetric' + sourceTable: + description: Input dataset to compute metrics over. + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + actions: + description: >- + Actions to execute at the completion of the job. Are executed in the + order provided. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Action' + GooglePrivacyDlpV2InspectDataSourceDetails: + id: GooglePrivacyDlpV2InspectDataSourceDetails + description: The results of an inspect DataSource job. + type: object + properties: + requestedOptions: + description: The configuration used for this job. + $ref: '#/components/schemas/GooglePrivacyDlpV2RequestedOptions' + result: + description: A summary of the outcome of this inspection job. + $ref: '#/components/schemas/GooglePrivacyDlpV2Result' GooglePrivacyDlpV2RequestedOptions: + id: GooglePrivacyDlpV2RequestedOptions + description: Snapshot of the inspection configuration. + type: object properties: snapshotInspectTemplate: description: >- @@ -4999,2670 +4909,3241 @@ components: of this run. $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' jobConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectJobConfig' description: Inspect config. + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectJobConfig' + GooglePrivacyDlpV2Result: + id: GooglePrivacyDlpV2Result + description: All Result fields are updated while the job is processing. type: object - description: Snapshot of the inspection configuration. - id: GooglePrivacyDlpV2RequestedOptions - GooglePrivacyDlpV2Color: - id: GooglePrivacyDlpV2Color - properties: - green: - format: float - description: The amount of green in the color as a value in the interval [0, 1]. - type: number - blue: - format: float - description: The amount of blue in the color as a value in the interval [0, 1]. - type: number - red: - type: number - description: The amount of red in the color as a value in the interval [0, 1]. - format: float - type: object - description: Represents a color in the RGB color space. - GooglePrivacyDlpV2LDiversityResult: - description: Result of the l-diversity computation. properties: - sensitiveValueFrequencyHistogramBuckets: + processedBytes: + description: Total size in bytes that were processed. + type: string + format: int64 + totalEstimatedBytes: + description: Estimate of the number of bytes to process. + type: string + format: int64 + infoTypeStats: + description: >- + Statistics of how many instances of each info type were found during + inspect job. type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2LDiversityHistogramBucket' + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeStats' + numRowsProcessed: description: >- - Histogram of l-diversity equivalence class sensitive value - frequencies. - id: GooglePrivacyDlpV2LDiversityResult - type: object - GooglePrivacyDlpV2ProjectDataProfile: + Number of rows scanned after sampling and time filtering (applicable + for row based stores such as BigQuery). + type: string + format: int64 + hybridStats: + description: Statistics related to the processing of hybrid inspect. + $ref: '#/components/schemas/GooglePrivacyDlpV2HybridInspectStatistics' + GooglePrivacyDlpV2InfoTypeStats: + id: GooglePrivacyDlpV2InfoTypeStats + description: Statistics regarding a specific InfoType. type: object - id: GooglePrivacyDlpV2ProjectDataProfile properties: - dataRiskLevel: - $ref: '#/components/schemas/GooglePrivacyDlpV2DataRiskLevel' - description: The data risk level of this project. - profileLastGenerated: - format: google-datetime - description: The last time the profile was generated. - type: string - sensitivityScore: - description: The sensitivity score of this project. - $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' - projectId: - type: string - description: Project ID or account that was profiled. - tableDataProfileCount: + infoType: + description: The type of finding this stat is for. + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + count: + description: Number of findings for this infoType. type: string - description: The number of table data profiles generated for this project. format: int64 - fileStoreDataProfileCount: + GooglePrivacyDlpV2HybridInspectStatistics: + id: GooglePrivacyDlpV2HybridInspectStatistics + description: Statistics related to processing hybrid inspect requests. + type: object + properties: + processedCount: + description: The number of hybrid inspection requests processed within this job. type: string - description: The number of file store data profiles generated for this project. format: int64 - name: - type: string - description: The resource name of the profile. - profileStatus: - $ref: '#/components/schemas/GooglePrivacyDlpV2ProfileStatus' - description: Success or error status of the last attempt to profile the project. - description: >- - An aggregated profile for this project, based on the resources profiled - within it. - GooglePrivacyDlpV2HybridFindingDetails: - properties: - tableOptions: - $ref: '#/components/schemas/GooglePrivacyDlpV2TableOptions' - description: >- - If the container is a table, additional information to make findings - meaningful such as the columns that are primary keys. If not known - ahead of time, can also be set within each inspect hybrid call and - the two will be merged. Note that identifying_fields will only be - stored to BigQuery, and only if the BigQuery action has been - included. - containerDetails: - description: >- - Details about the container where the content being inspected is - from. - $ref: '#/components/schemas/GooglePrivacyDlpV2Container' - labels: + abortedCount: description: >- - Labels to represent user provided metadata about the data being - inspected. If configured by the job, some key values may be - required. The labels associated with `Finding`'s produced by hybrid - inspection. Label keys must be between 1 and 63 characters long and - must conform to the following regular expression: - `[a-z]([-a-z0-9]*[a-z0-9])?`. Label values must be between 0 and 63 - characters long and must conform to the regular expression - `([a-z]([-a-z0-9]*[a-z0-9])?)?`. No more than 10 labels can be - associated with a given finding. Examples: * `"environment" : - "production"` * `"pipeline" : "etl"` - type: object - additionalProperties: - type: string - rowOffset: + The number of hybrid inspection requests aborted because the job ran + out of quota or was ended before they could be processed. type: string - description: >- - Offset of the row for tables. Populate if the row(s) being scanned - are part of a bigger dataset and you want to keep track of their - absolute position. - format: int64 - fileOffset: format: int64 + pendingCount: description: >- - Offset in bytes of the line, from the beginning of the file, where - the finding is located. Populate if the item being scanned is only - part of a bigger item, such as a shard of a file and you want to - track the absolute position of the finding. + The number of hybrid requests currently being processed. Only + populated when called via method `getDlpJob`. A burst of traffic may + cause hybrid inspect requests to be enqueued. Processing will take + place as quickly as possible, but resource limitations may impact + how long a request is enqueued for. type: string - id: GooglePrivacyDlpV2HybridFindingDetails + format: int64 + GooglePrivacyDlpV2ActionDetails: + id: GooglePrivacyDlpV2ActionDetails + description: The results of an Action. type: object - description: Populate to associate additional data with each finding. - GooglePrivacyDlpV2UpdateDiscoveryConfigRequest: - id: GooglePrivacyDlpV2UpdateDiscoveryConfigRequest properties: - updateMask: - description: Mask to control which fields get updated. - type: string - format: google-fieldmask - discoveryConfig: - description: Required. New DiscoveryConfig value. - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' - description: Request message for UpdateDiscoveryConfig. + deidentifyDetails: + description: Outcome of a de-identification action. + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyDataSourceDetails' + GooglePrivacyDlpV2DeidentifyDataSourceDetails: + id: GooglePrivacyDlpV2DeidentifyDataSourceDetails + description: The results of a Deidentify action from an inspect job. type: object - GooglePrivacyDlpV2CloudSqlIamCredential: - description: >- - Use IAM authentication to connect. This requires the Cloud SQL IAM - feature to be enabled on the instance, which is not the default for - Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication - and https://cloud.google.com/sql/docs/mysql/authentication. - properties: {} - id: GooglePrivacyDlpV2CloudSqlIamCredential - type: object - GooglePrivacyDlpV2DiscoveryCloudSqlConditions: - id: GooglePrivacyDlpV2DiscoveryCloudSqlConditions + properties: + requestedOptions: + description: De-identification config used for the request. + $ref: '#/components/schemas/GooglePrivacyDlpV2RequestedDeidentifyOptions' + deidentifyStats: + description: Stats about the de-identification operation. + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyDataSourceStats' + GooglePrivacyDlpV2RequestedDeidentifyOptions: + id: GooglePrivacyDlpV2RequestedDeidentifyOptions + description: De-identification options. type: object properties: - types: + snapshotDeidentifyTemplate: description: >- - Data profiles will only be generated for the database resource types - specified in this field. If not specified, defaults to - [DATABASE_RESOURCE_TYPE_ALL_SUPPORTED_TYPES]. - type: array - items: - type: string - enumDescriptions: - - Unused. - - >- - Includes database resource types that become supported at a - later time. - - Tables. - enum: - - DATABASE_RESOURCE_TYPE_UNSPECIFIED - - DATABASE_RESOURCE_TYPE_ALL_SUPPORTED_TYPES - - DATABASE_RESOURCE_TYPE_TABLE - databaseEngines: - items: - type: string - enumDescriptions: - - Unused. - - Include all supported database engines. - - MySQL database. - - PostgreSQL database. - enum: - - DATABASE_ENGINE_UNSPECIFIED - - ALL_SUPPORTED_DATABASE_ENGINES - - MYSQL - - POSTGRES + Snapshot of the state of the `DeidentifyTemplate` from the + Deidentify action at the time this job was run. + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + snapshotStructuredDeidentifyTemplate: description: >- - Optional. Database engines that should be profiled. Optional. - Defaults to ALL_SUPPORTED_DATABASE_ENGINES if unspecified. - type: array - description: >- - Requirements that must be true before a table is profiled for the first - time. - GooglePrivacyDlpV2InspectContentResponse: - properties: - result: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectResult' - description: The findings. - type: object - id: GooglePrivacyDlpV2InspectContentResponse - description: Results of inspecting an item. - GooglePrivacyDlpV2Conditions: - description: A collection of conditions. - id: GooglePrivacyDlpV2Conditions + Snapshot of the state of the structured `DeidentifyTemplate` from + the `Deidentify` action at the time this job was run. + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + snapshotImageRedactTemplate: + description: >- + Snapshot of the state of the image transformation + `DeidentifyTemplate` from the `Deidentify` action at the time this + job was run. + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + GooglePrivacyDlpV2DeidentifyDataSourceStats: + id: GooglePrivacyDlpV2DeidentifyDataSourceStats + description: Summary of what was modified during a transformation. type: object properties: - conditions: - description: A collection of conditions. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Condition' - type: array - GooglePrivacyDlpV2DataProfileBigQueryRowSchema: - properties: - tableProfile: - $ref: '#/components/schemas/GooglePrivacyDlpV2TableDataProfile' - description: Table data profile column - fileStoreProfile: - description: File store data profile column. - $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreDataProfile' - columnProfile: - $ref: '#/components/schemas/GooglePrivacyDlpV2ColumnDataProfile' - description: Column data profile column + transformedBytes: + description: Total size in bytes that were transformed in some way. + type: string + format: int64 + transformationCount: + description: Number of successfully applied transformations. + type: string + format: int64 + transformationErrorCount: + description: Number of errors encountered while trying to apply transformations. + type: string + format: int64 + GooglePrivacyDlpV2CreateDiscoveryConfigRequest: + id: GooglePrivacyDlpV2CreateDiscoveryConfigRequest + description: Request message for CreateDiscoveryConfig. type: object + properties: + discoveryConfig: + description: Required. The DiscoveryConfig to create. + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + configId: + description: >- + The config ID can contain uppercase and lowercase letters, numbers, + and hyphens; that is, it must match the regular expression: + `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty + to allow the system to generate one. + type: string + GooglePrivacyDlpV2DiscoveryConfig: + id: GooglePrivacyDlpV2DiscoveryConfig description: >- - The schema of data to be saved to the BigQuery table when the - `DataProfileAction` is enabled. - id: GooglePrivacyDlpV2DataProfileBigQueryRowSchema - GooglePrivacyDlpV2Location: + Configuration for discovery to scan resources for profile generation. + Only one discovery configuration may exist per organization, folder, or + project. The generated data profiles are retained according to the [data + retention policy] + (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). + type: object properties: - container: + name: description: >- - Information about the container where this finding occurred, if - available. - $ref: '#/components/schemas/GooglePrivacyDlpV2Container' - contentLocations: + Unique resource name for the DiscoveryConfig, assigned by the + service when the DiscoveryConfig is created, for example + `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. + type: string + displayName: + description: Display name (max 100 chars) + type: string + orgConfig: + description: Only set when the parent is an org. + $ref: '#/components/schemas/GooglePrivacyDlpV2OrgConfig' + otherCloudStartingLocation: + description: Must be set only when scanning other clouds. + $ref: >- + #/components/schemas/GooglePrivacyDlpV2OtherCloudDiscoveryStartingLocation + inspectTemplates: + description: >- + Detection logic for profile generation. Not all template features + are used by Discovery. FindingLimits, include_quote and + exclude_info_types have no impact on Discovery. Multiple templates + may be provided if there is data in multiple regions. At most one + template must be specified per-region (including "global"). Each + region is scanned using the applicable template. If no + region-specific template is specified, but a "global" template is + specified, it will be copied to that region and used instead. If no + global or region-specific template is provided for a region with + data, that region's data will not be scanned. For more information, + see + https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. + type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2ContentLocation' + type: string + actions: + description: Actions to execute at the completion of scanning. type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileAction' + targets: description: >- - List of nested objects pointing to the precise location of the - finding within the file or record. - byteRange: - $ref: '#/components/schemas/GooglePrivacyDlpV2Range' + Target to match against for determining what to scan and how + frequently. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryTarget' + errors: description: >- - Zero-based byte offsets delimiting the finding. These are relative - to the finding's containing element. Note that when the content is - not textual, this references the UTF-8 encoded textual - representation of the content. Omitted if content is an image. - codepointRange: - $ref: '#/components/schemas/GooglePrivacyDlpV2Range' + Output only. A stream of errors encountered when the config was + activated. Repeated errors may result in the config automatically + being paused. Output only field. Will return the last 100 errors. + Whenever the config is modified this list will be cleared. + readOnly: true + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Error' + createTime: + description: Output only. The creation timestamp of a DiscoveryConfig. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. The last update timestamp of a DiscoveryConfig. + readOnly: true + type: string + format: google-datetime + lastRunTime: description: >- - Unicode character offsets delimiting the finding. These are relative - to the finding's containing element. Provided when the content is - text. - description: Specifies the location of the finding. - type: object - id: GooglePrivacyDlpV2Location + Output only. The timestamp of the last time this config was + executed. + readOnly: true + type: string + format: google-datetime + status: + description: Required. A status for this configuration. + type: string + enumDescriptions: + - Unused + - The discovery config is currently active. + - The discovery config is paused temporarily. + enum: + - STATUS_UNSPECIFIED + - RUNNING + - PAUSED + processingLocation: + description: >- + Optional. Processing location configuration. Vertex AI dataset + scanning will set processing_location.image_fallback_type to + MultiRegionProcessing by default. + $ref: '#/components/schemas/GooglePrivacyDlpV2ProcessingLocation' GooglePrivacyDlpV2OrgConfig: + id: GooglePrivacyDlpV2OrgConfig description: >- Project and scan location information. Only set when the parent is an org. type: object properties: location: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryStartingLocation' description: 'The data to scan: folder, org, or project' + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryStartingLocation' projectId: description: >- The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the DLP API must be enabled. type: string - id: GooglePrivacyDlpV2OrgConfig - GooglePrivacyDlpV2RecordCondition: + GooglePrivacyDlpV2DiscoveryStartingLocation: + id: GooglePrivacyDlpV2DiscoveryStartingLocation description: >- - A condition for determining whether a transformation should be applied - to a field. - properties: - expressions: - $ref: '#/components/schemas/GooglePrivacyDlpV2Expressions' - description: An expression. + The location to begin a discovery scan. Denotes an organization ID or + folder ID within an organization. type: object - id: GooglePrivacyDlpV2RecordCondition - GooglePrivacyDlpV2Trigger: properties: - manual: - description: >- - For use with hybrid jobs. Jobs must be manually created and - finished. - $ref: '#/components/schemas/GooglePrivacyDlpV2Manual' - schedule: - description: Create a job on a repeating basis based on the elapse of time. - $ref: '#/components/schemas/GooglePrivacyDlpV2Schedule' - id: GooglePrivacyDlpV2Trigger - description: What event needs to occur for a new job to be started. - type: object - GooglePrivacyDlpV2ListJobTriggersResponse: + organizationId: + description: The ID of an organization to scan. + type: string + format: int64 + folderId: + description: The ID of the folder within an organization to be scanned. + type: string + format: int64 + GooglePrivacyDlpV2OtherCloudDiscoveryStartingLocation: + id: GooglePrivacyDlpV2OtherCloudDiscoveryStartingLocation + description: The other cloud starting location for discovery. type: object - id: GooglePrivacyDlpV2ListJobTriggersResponse properties: - nextPageToken: - type: string - description: >- - If the next page is available then this value is the next page token - to be used in the following ListJobTriggers request. - jobTriggers: - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' - description: List of triggeredJobs, up to page_size in ListJobTriggersRequest. - description: Response message for ListJobTriggers. - GooglePrivacyDlpV2Expressions: + awsLocation: + description: The AWS starting location for discovery. + $ref: '#/components/schemas/GooglePrivacyDlpV2AwsDiscoveryStartingLocation' + GooglePrivacyDlpV2AwsDiscoveryStartingLocation: + id: GooglePrivacyDlpV2AwsDiscoveryStartingLocation + description: The AWS starting location for discovery. + type: object properties: - conditions: - $ref: '#/components/schemas/GooglePrivacyDlpV2Conditions' - description: Conditions to apply to the expression. - logicalOperator: + accountId: description: >- - The operator to apply to the result of conditions. Default and - currently only supported value is `AND`. - enumDescriptions: - - Unused - - Conditional AND - enum: - - LOGICAL_OPERATOR_UNSPECIFIED - - AND + The AWS account ID that this discovery config applies to. Within an + AWS organization, you can find the AWS account ID inside an AWS + account ARN. Example: + arn:{partition}:organizations::{management_account_id}:account/{org_id}/{account_id} type: string - id: GooglePrivacyDlpV2Expressions - description: An expression, consisting of an operator and conditions. + allAssetInventoryAssets: + description: >- + All AWS assets stored in Asset Inventory that didn't match other AWS + discovery configs. + type: boolean + GooglePrivacyDlpV2DataProfileAction: + id: GooglePrivacyDlpV2DataProfileAction + description: A task to execute when a data profile has been generated. type: object - GooglePrivacyDlpV2KAnonymityEquivalenceClass: properties: - equivalenceClassSize: - type: string - format: int64 + exportData: + description: Export data profiles into a provided location. + $ref: '#/components/schemas/GooglePrivacyDlpV2Export' + pubSubNotification: + description: Publish a message into the Pub/Sub topic. + $ref: '#/components/schemas/GooglePrivacyDlpV2PubSubNotification' + publishToChronicle: description: >- - Size of the equivalence class, for example number of rows with the - above set of values. - quasiIdsValues: - type: array + Publishes generated data profiles to Google Security Operations. For + more information, see [Use Sensitive Data Protection data in + context-aware + analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + $ref: '#/components/schemas/GooglePrivacyDlpV2PublishToChronicle' + publishToScc: + description: Publishes findings to Security Command Center for each data profile. + $ref: >- + #/components/schemas/GooglePrivacyDlpV2PublishToSecurityCommandCenter + tagResources: + description: Tags the profiled resources with the specified tag values. + $ref: '#/components/schemas/GooglePrivacyDlpV2TagResources' + publishToDataplexCatalog: description: >- - Set of values defining the equivalence class. One value per - quasi-identifier column in the original KAnonymity metric message. - The order is always the same as the original request. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - description: The set of columns' values that share the same ldiversity value - type: object - id: GooglePrivacyDlpV2KAnonymityEquivalenceClass - GooglePrivacyDlpV2InfoTypeTransformation: + Publishes a portion of each profile to Dataplex Universal Catalog + with the aspect type Sensitive Data Protection Profile. + $ref: '#/components/schemas/GooglePrivacyDlpV2PublishToDataplexCatalog' + GooglePrivacyDlpV2Export: + id: GooglePrivacyDlpV2Export description: >- - A transformation to apply to text that is identified as a specific - info_type. + If set, the detailed data profiles will be persisted to the location of + your choice whenever updated. type: object - id: GooglePrivacyDlpV2InfoTypeTransformation properties: - primitiveTransformation: - description: Required. Primitive transformation to apply to the infoType. - $ref: '#/components/schemas/GooglePrivacyDlpV2PrimitiveTransformation' - infoTypes: + profileTable: description: >- - InfoTypes to apply the transformation to. An empty list will cause - this transformation to apply to all findings that correspond to - infoTypes that were requested in `InspectConfig`. - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - GooglePrivacyDlpV2SurrogateType: - type: object - description: >- - Message for detecting output from deidentification transformations such - as - [`CryptoReplaceFfxFpeConfig`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig). - These types of transformations are those that perform pseudonymization, - thereby producing a "surrogate" as output. This should be used in - conjunction with a field on the transformation such as - `surrogate_info_type`. This CustomInfoType does not support the use of - `detection_rules`. - properties: {} - id: GooglePrivacyDlpV2SurrogateType - GooglePrivacyDlpV2BigQueryRegex: - properties: - tableIdRegex: - description: If unset, this property matches all tables. - type: string - datasetIdRegex: - type: string - description: If unset, this property matches all datasets. - projectIdRegex: + Store all profiles to BigQuery. * The system will create a new + dataset and table for you if none are are provided. The dataset will + be named `sensitive_data_protection_discovery` and table will be + named `discovery_profiles`. This table will be placed in the same + project as the container project running the scan. After the first + profile is generated and the dataset and table are created, the + discovery scan configuration will be updated with the dataset and + table names. * See [Analyze data profiles stored in + BigQuery](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). + * See [Sample queries for your BigQuery + table](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). + * Data is inserted using [streaming + insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) + and so data may be in the buffer for a period of time after the + profile has finished. * The Pub/Sub notification is sent before the + streaming buffer is guaranteed to be written, so data may not be + instantly visible to queries by the time your topic receives the + Pub/Sub notification. * The best practice is to use the same table + for an entire organization so that you can take advantage of the + [provided Looker + reports](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). + If you use VPC Service Controls to define security perimeters, then + you must use a separate table for each boundary. + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + sampleFindingsTable: description: >- - For organizations, if unset, will match all projects. Has no effect - for data profile configurations created within a project. - type: string + Store sample data profile findings in an existing table or a new + table in an existing dataset. Each regeneration will result in new + rows in BigQuery. Data is inserted using [streaming + insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) + and so data may be in the buffer for a period of time after the + profile has finished. + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + GooglePrivacyDlpV2PubSubNotification: + id: GooglePrivacyDlpV2PubSubNotification description: >- - A pattern to match against one or more tables, datasets, or projects - that contain BigQuery tables. At least one pattern must be specified. - Regular expressions use RE2 - [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be - found under the google/re2 repository on GitHub. - id: GooglePrivacyDlpV2BigQueryRegex + Send a Pub/Sub message into the given Pub/Sub topic to connect other + systems to data profile generation. The message payload data will be the + byte serialization of `DataProfilePubSubMessage`. type: object - GooglePrivacyDlpV2InfoType: - id: GooglePrivacyDlpV2InfoType properties: - name: + topic: description: >- - Name of the information type. Either a name of your choosing when - creating a CustomInfoType, or one of the names listed at - https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference - when specifying a built-in type. When sending Cloud DLP results to - Data Catalog, infoType names should conform to the pattern - `[A-Za-z0-9$_-]{1,64}`. - type: string - version: + Cloud Pub/Sub topic to send notifications to. Format is + projects/{project}/topics/{topic}. type: string - description: Optional version name for this InfoType. - sensitivityScore: - $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' + event: description: >- - Optional custom sensitivity for this InfoType. This only applies to - data profiling. - type: object - description: Type of information detected by the API. - GooglePrivacyDlpV2BigQueryTable: - properties: - projectId: + The type of event that triggers a Pub/Sub. At most one + `PubSubNotification` per EventType is permitted. type: string + enumDescriptions: + - Unused. + - New profile (not a re-profile). + - >- + One of the following profile metrics changed: Data risk score, + Sensitivity score, Resource visibility, Encryption type, Predicted + infoTypes, Other infoTypes + - Table data risk score or sensitivity score increased. + - A user (non-internal) error occurred. + enum: + - EVENT_TYPE_UNSPECIFIED + - NEW_PROFILE + - CHANGED_PROFILE + - SCORE_INCREASED + - ERROR_CHANGED + pubsubCondition: description: >- - The Google Cloud project ID of the project containing the table. If - omitted, project ID is inferred from the API call. - datasetId: - type: string - description: Dataset ID of the table. - tableId: + Conditions (e.g., data risk or sensitivity level) for triggering a + Pub/Sub. + $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfilePubSubCondition' + detailOfMessage: + description: >- + How much data to include in the Pub/Sub message. If the user wishes + to limit the size of the message, they can use resource_name and + fetch the profile fields they wish to. Per table profile (not per + column). type: string - description: Name of the table. - description: >- - Message defining the location of a BigQuery table. A table is uniquely - identified by its project_id, dataset_id, and table_name. Within a query - a table is often referenced with a string in the format of: `:.` or - `..`. - id: GooglePrivacyDlpV2BigQueryTable + enumDescriptions: + - Unused. + - The full table data profile. + - The name of the profiled resource. + - The full file store data profile. + enum: + - DETAIL_LEVEL_UNSPECIFIED + - TABLE_PROFILE + - RESOURCE_NAME + - FILE_STORE_PROFILE + GooglePrivacyDlpV2DataProfilePubSubCondition: + id: GooglePrivacyDlpV2DataProfilePubSubCondition + description: A condition for determining whether a Pub/Sub should be triggered. type: object - GooglePrivacyDlpV2SearchConnectionsResponse: + properties: + expressions: + description: An expression. + $ref: '#/components/schemas/GooglePrivacyDlpV2PubSubExpressions' + GooglePrivacyDlpV2PubSubExpressions: + id: GooglePrivacyDlpV2PubSubExpressions + description: An expression, consisting of an operator and conditions. type: object - id: GooglePrivacyDlpV2SearchConnectionsResponse properties: - connections: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' - description: >- - List of connections that match the search query. Note that only a - subset of the fields will be populated, and only "name" is - guaranteed to be set. For full details of a Connection, call - GetConnection with the name. - type: array - nextPageToken: - description: >- - Token to retrieve the next page of results. An empty value means - there are no more results. + logicalOperator: + description: The operator to apply to the collection of conditions. type: string - description: Response message for SearchConnections. - GooglePrivacyDlpV2DeltaPresenceEstimationResult: - type: object - properties: - deltaPresenceEstimationHistogram: - items: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2DeltaPresenceEstimationHistogramBucket + enumDescriptions: + - Unused. + - Conditional OR. + - Conditional AND. + enum: + - LOGICAL_OPERATOR_UNSPECIFIED + - OR + - AND + conditions: + description: Conditions to apply to the expression. type: array - description: >- - The intervals [min_probability, max_probability) do not overlap. If - a value doesn't correspond to any such interval, the associated - frequency is zero. For example, the following records: - {min_probability: 0, max_probability: 0.1, frequency: 17} - {min_probability: 0.2, max_probability: 0.3, frequency: 42} - {min_probability: 0.3, max_probability: 0.4, frequency: 99} mean - that there are no record with an estimated probability in [0.1, 0.2) - nor larger or equal to 0.4. - description: >- - Result of the δ-presence computation. Note that these results are an - estimation, not exact values. - id: GooglePrivacyDlpV2DeltaPresenceEstimationResult - GooglePrivacyDlpV2ListProjectDataProfilesResponse: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2PubSubCondition' + GooglePrivacyDlpV2PubSubCondition: + id: GooglePrivacyDlpV2PubSubCondition + description: A condition consisting of a value. type: object - id: GooglePrivacyDlpV2ListProjectDataProfilesResponse properties: - nextPageToken: - description: The next page token. + minimumRiskScore: + description: The minimum data risk score that triggers the condition. type: string - projectDataProfiles: - description: List of data profiles. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2ProjectDataProfile' - type: array - description: List of profiles generated for a given organization or project. - GooglePrivacyDlpV2OtherCloudResourceRegex: + enumDescriptions: + - Unused. + - High risk/sensitivity detected. + - Medium or high risk/sensitivity detected. + enum: + - PROFILE_SCORE_BUCKET_UNSPECIFIED + - HIGH + - MEDIUM_OR_HIGH + minimumSensitivityScore: + description: The minimum sensitivity level that triggers the condition. + type: string + enumDescriptions: + - Unused. + - High risk/sensitivity detected. + - Medium or high risk/sensitivity detected. + enum: + - PROFILE_SCORE_BUCKET_UNSPECIFIED + - HIGH + - MEDIUM_OR_HIGH + GooglePrivacyDlpV2PublishToChronicle: + id: GooglePrivacyDlpV2PublishToChronicle + description: Message expressing intention to publish to Google Security Operations. + type: object + properties: {} + GooglePrivacyDlpV2PublishToSecurityCommandCenter: + id: GooglePrivacyDlpV2PublishToSecurityCommandCenter description: >- - A pattern to match against one or more resources. At least one pattern - must be specified. Regular expressions use RE2 - [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be - found under the google/re2 repository on GitHub. - id: GooglePrivacyDlpV2OtherCloudResourceRegex + If set, a summary finding will be created or updated in Security Command + Center for each profile. type: object - properties: - amazonS3BucketRegex: - $ref: '#/components/schemas/GooglePrivacyDlpV2AmazonS3BucketRegex' - description: Regex for Amazon S3 buckets. - GooglePrivacyDlpV2ListFileStoreDataProfilesResponse: - id: GooglePrivacyDlpV2ListFileStoreDataProfilesResponse + properties: {} + GooglePrivacyDlpV2TagResources: + id: GooglePrivacyDlpV2TagResources description: >- - List of file store data profiles generated for a given organization or - project. + If set, attaches the [tags] + (https://cloud.google.com/resource-manager/docs/tags/tags-overview) + provided to profiled resources. Tags support [access + control](https://cloud.google.com/iam/docs/tags-access-control). You can + conditionally grant or deny access to a resource based on whether the + resource has a specific tag. type: object properties: - nextPageToken: - type: string - description: The next page token. - fileStoreDataProfiles: - description: List of data profiles. + tagConditions: + description: The tags to associate with different conditions. + type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreDataProfile' + $ref: '#/components/schemas/GooglePrivacyDlpV2TagCondition' + profileGenerationsToTag: + description: >- + The profile generations for which the tag should be attached to + resources. If you attach a tag to only new profiles, then if the + sensitivity score of a profile subsequently changes, its tag doesn't + change. By default, this field includes only new profiles. To + include both new and updated profiles for tagging, this field should + explicitly include both `PROFILE_GENERATION_NEW` and + `PROFILE_GENERATION_UPDATE`. type: array - GooglePrivacyDlpV2DatabaseResourceRegex: - id: GooglePrivacyDlpV2DatabaseResourceRegex - properties: - projectIdRegex: - type: string + items: + type: string + enumDescriptions: + - Unused. + - The profile is the first profile for the resource. + - The profile is an update to a previous profile. + enum: + - PROFILE_GENERATION_UNSPECIFIED + - PROFILE_GENERATION_NEW + - PROFILE_GENERATION_UPDATE + lowerDataRiskToLow: description: >- - For organizations, if unset, will match all projects. Has no effect - for configurations created within a project. - databaseRegex: - type: string + Whether applying a tag to a resource should lower the risk of the + profile for that resource. For example, in conjunction with an [IAM + deny policy](https://cloud.google.com/iam/docs/deny-overview), you + can deny all principals a permission if a tag value is present, + mitigating the risk of the resource. This also lowers the data risk + of resources at the lower levels of the resource hierarchy. For + example, reducing the data risk of a table data profile also reduces + the data risk of the constituent column data profiles. + type: boolean + GooglePrivacyDlpV2TagCondition: + id: GooglePrivacyDlpV2TagCondition + description: >- + The tag to attach to profiles matching the condition. At most one + `TagCondition` can be specified per sensitivity level. + type: object + properties: + tag: + description: The tag value to attach to resources. + $ref: '#/components/schemas/GooglePrivacyDlpV2TagValue' + sensitivityScore: description: >- - Regex to test the database name against. If empty, all databases - match. - databaseResourceNameRegex: - type: string + Conditions attaching the tag to a resource on its profile having + this sensitivity score. + $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' + GooglePrivacyDlpV2TagValue: + id: GooglePrivacyDlpV2TagValue + description: A value of a tag. + type: object + properties: + namespacedValue: description: >- - Regex to test the database resource's name against. An example of a - database resource name is a table's name. Other database resource - names like view names could be included in the future. If empty, all - database resources match. - instanceRegex: + The namespaced name for the tag value to attach to resources. Must + be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, + for example, "123456/environment/prod" for an organization parent, + or "my-project/environment/prod" for a project parent. type: string - description: >- - Regex to test the instance name against. If empty, all instances - match. + GooglePrivacyDlpV2PublishToDataplexCatalog: + id: GooglePrivacyDlpV2PublishToDataplexCatalog description: >- - A pattern to match against one or more database resources. At least one - pattern must be specified. Regular expressions use RE2 - [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be - found under the google/re2 repository on GitHub. + Create Dataplex Universal Catalog aspects for profiled resources with + the aspect type Sensitive Data Protection Profile. To learn more about + aspects, see + https://cloud.google.com/sensitive-data-protection/docs/add-aspects. type: object - GooglePrivacyDlpV2PublishSummaryToCscc: - properties: {} + properties: + lowerDataRiskToLow: + description: >- + Whether creating a Dataplex Universal Catalog aspect for a profiled + resource should lower the risk of the profile for that resource. + This also lowers the data risk of resources at the lower levels of + the resource hierarchy. For example, reducing the data risk of a + table data profile also reduces the data risk of the constituent + column data profiles. + type: boolean + GooglePrivacyDlpV2DiscoveryTarget: + id: GooglePrivacyDlpV2DiscoveryTarget + description: Target used to match against for Discovery. type: object - description: >- - Publish the result summary of a DlpJob to [Security Command - Center](https://cloud.google.com/security-command-center). This action - is available for only projects that belong to an organization. This - action publishes the count of finding instances and their infoTypes. The - summary of findings are persisted in Security Command Center and are - governed by [service-specific policies for Security Command - Center](https://cloud.google.com/terms/service-terms). Only a single - instance of this action can be specified. Compatible with: Inspect - id: GooglePrivacyDlpV2PublishSummaryToCscc - GooglePrivacyDlpV2CharacterMaskConfig: - description: >- - Partially mask a string by replacing a given number of characters with a - fixed character. Masking can start from the beginning or end of the - string. This can be used on data of any type (numbers, longs, and so on) - and when de-identifying structured data we'll attempt to preserve the - original data's type. (This allows you to take a long like 123 and - modify it to a string like **3. properties: - charactersToIgnore: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2CharsToIgnore' + bigQueryTarget: description: >- - When masking a string, items in this list will be skipped when - replacing characters. For example, if the input string is - `555-555-5555` and you instruct Cloud DLP to skip `-` and mask 5 - characters with `*`, Cloud DLP returns `***-**5-5555`. - type: array - numberToMask: - format: int32 - type: integer + BigQuery target for Discovery. The first target to match a table + will be the one applied. + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryDiscoveryTarget' + cloudSqlTarget: description: >- - Number of characters to mask. If not set, all matching chars will be - masked. Skipped characters do not count towards this tally. If - `number_to_mask` is negative, this denotes inverse masking. Cloud - DLP masks all but a number of characters. For example, suppose you - have the following values: - `masking_character` is `*` - - `number_to_mask` is `-4` - `reverse_order` is `false` - - `CharsToIgnore` includes `-` - Input string is `1234-5678-9012-3456` - The resulting de-identified string is `****-****-****-3456`. Cloud - DLP masks all but the last four characters. If `reverse_order` is - `true`, all but the first four characters are masked as - `1234-****-****-****`. - reverseOrder: + Cloud SQL target for Discovery. The first target to match a table + will be the one applied. + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudSqlDiscoveryTarget' + secretsTarget: description: >- - Mask characters in reverse order. For example, if - `masking_character` is `0`, `number_to_mask` is `14`, and - `reverse_order` is `false`, then the input string - `1234-5678-9012-3456` is masked as `00000000000000-3456`. If - `masking_character` is `*`, `number_to_mask` is `3`, and - `reverse_order` is `true`, then the string `12345` is masked as - `12***`. - type: boolean - maskingCharacter: + Discovery target that looks for credentials and secrets stored in + cloud resource metadata and reports them as vulnerabilities to + Security Command Center. Only one target of this type is allowed. + $ref: '#/components/schemas/GooglePrivacyDlpV2SecretsDiscoveryTarget' + cloudStorageTarget: description: >- - Character to use to mask the sensitive values—for example, `*` for - an alphabetic string such as a name, or `0` for a numeric string - such as ZIP code or credit card number. This string must have a - length of 1. If not supplied, this value defaults to `*` for - strings, and `0` for digits. - type: string + Cloud Storage target for Discovery. The first target to match a + table will be the one applied. + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStorageDiscoveryTarget' + otherCloudTarget: + description: >- + Other clouds target for discovery. The first target to match a + resource will be the one applied. + $ref: '#/components/schemas/GooglePrivacyDlpV2OtherCloudDiscoveryTarget' + vertexDatasetTarget: + description: >- + Vertex AI dataset target for Discovery. The first target to match a + dataset will be the one applied. Note that discovery for Vertex AI + can incur Cloud Storage Class B operation charges for + storage.objects.get operations and retrieval fees. For more + information, see [Cloud Storage + pricing](https://cloud.google.com/storage/pricing#price-tables). + Note that discovery for Vertex AI dataset will not be able to scan + images unless + DiscoveryConfig.processing_location.image_fallback_location has + multi_region_processing or global_processing configured. + $ref: '#/components/schemas/GooglePrivacyDlpV2VertexDatasetDiscoveryTarget' + GooglePrivacyDlpV2BigQueryDiscoveryTarget: + id: GooglePrivacyDlpV2BigQueryDiscoveryTarget + description: Target used to match against for discovery with BigQuery tables type: object - id: GooglePrivacyDlpV2CharacterMaskConfig - GooglePrivacyDlpV2DeidentifyContentResponse: - id: GooglePrivacyDlpV2DeidentifyContentResponse - description: Results of de-identifying a ContentItem. properties: - item: - $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' - description: The de-identified item. - overview: - $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationOverview' - description: An overview of the changes that were made on the `item`. + filter: + description: >- + Required. The tables the discovery cadence applies to. The first + target with a matching filter will be the one to apply to a table. + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryBigQueryFilter' + conditions: + description: >- + In addition to matching the filter, these conditions must be true + before a profile is generated. + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryBigQueryConditions' + cadence: + description: >- + How often and when to update profiles. New tables that match both + the filter and conditions are scanned as quickly as possible + depending on system capacity. + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryGenerationCadence' + disabled: + description: Tables that match this filter will not have profiles created. + $ref: '#/components/schemas/GooglePrivacyDlpV2Disabled' + GooglePrivacyDlpV2DiscoveryBigQueryFilter: + id: GooglePrivacyDlpV2DiscoveryBigQueryFilter + description: >- + Determines what tables will have profiles generated within an + organization or project. Includes the ability to filter by regular + expression patterns on project ID, dataset ID, and table ID. type: object - GooglePrivacyDlpV2ImageTransformation: + properties: + tables: + description: >- + A specific set of tables for this filter to apply to. A table + collection must be specified in only one filter per config. If a + table id or dataset is empty, Cloud DLP assumes all tables in that + collection must be profiled. Must specify a project ID. + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTableCollection' + otherTables: + description: >- + Catch-all. This should always be the last filter in the list because + anything above it will apply first. Should only appear once in a + configuration. If none is specified, a default one will be added + automatically. + $ref: '#/components/schemas/GooglePrivacyDlpV2AllOtherBigQueryTables' + tableReference: + description: >- + The table to scan. Discovery configurations including this can only + include one DiscoveryTarget (the DiscoveryTarget with this + TableReference). + $ref: '#/components/schemas/GooglePrivacyDlpV2TableReference' + GooglePrivacyDlpV2BigQueryTableCollection: + id: GooglePrivacyDlpV2BigQueryTableCollection + description: Specifies a collection of BigQuery tables. Used for Discovery. type: object - id: GooglePrivacyDlpV2ImageTransformation properties: - allText: + includeRegexes: description: >- - Apply transformation to all text that doesn't match an infoType. - Only one instance is allowed within the ImageTransformations - message. - $ref: '#/components/schemas/GooglePrivacyDlpV2AllText' - selectedInfoTypes: - description: Apply transformation to the selected info_types. - $ref: '#/components/schemas/GooglePrivacyDlpV2SelectedInfoTypes' - redactionColor: - $ref: '#/components/schemas/GooglePrivacyDlpV2Color' + A collection of regular expressions to match a BigQuery table + against. + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryRegexes' + GooglePrivacyDlpV2BigQueryRegexes: + id: GooglePrivacyDlpV2BigQueryRegexes + description: >- + A collection of regular expressions to determine what tables to match + against. + type: object + properties: + patterns: description: >- - The color to use when redacting content from an image. If not - specified, the default is black. - allInfoTypes: + A single BigQuery regular expression pattern to match against one or + more tables, datasets, or projects that contain BigQuery tables. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryRegex' + GooglePrivacyDlpV2BigQueryRegex: + id: GooglePrivacyDlpV2BigQueryRegex + description: >- + A pattern to match against one or more tables, datasets, or projects + that contain BigQuery tables. At least one pattern must be specified. + Regular expressions use RE2 + [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be + found under the google/re2 repository on GitHub. + type: object + properties: + projectIdRegex: description: >- - Apply transformation to all findings not specified in other - ImageTransformation's selected_info_types. Only one instance is - allowed within the ImageTransformations message. - $ref: '#/components/schemas/GooglePrivacyDlpV2AllInfoTypes' - description: Configuration for determining how redaction of images should occur. - GooglePrivacyDlpV2InfoTypeCategory: - id: GooglePrivacyDlpV2InfoTypeCategory + For organizations, if unset, will match all projects. Has no effect + for data profile configurations created within a project. + type: string + datasetIdRegex: + description: If unset, this property matches all datasets. + type: string + tableIdRegex: + description: If unset, this property matches all tables. + type: string + GooglePrivacyDlpV2AllOtherBigQueryTables: + id: GooglePrivacyDlpV2AllOtherBigQueryTables + description: >- + Catch-all for all other tables not specified by other filters. Should + always be last, except for single-table configurations, which will only + have a TableReference target. + type: object + properties: {} + GooglePrivacyDlpV2TableReference: + id: GooglePrivacyDlpV2TableReference + description: >- + Message defining the location of a BigQuery table with the projectId + inferred from the parent project. type: object properties: - locationCategory: + datasetId: + description: Dataset ID of the table. + type: string + tableId: + description: Name of the table. + type: string + projectId: + description: >- + The Google Cloud project ID of the project containing the table. If + omitted, the project ID is inferred from the parent project. This + field is required if the parent resource is an organization. + type: string + GooglePrivacyDlpV2DiscoveryBigQueryConditions: + id: GooglePrivacyDlpV2DiscoveryBigQueryConditions + description: >- + Requirements that must be true before a table is scanned in discovery + for the first time. There is an AND relationship between the top-level + attributes. Additionally, minimum conditions with an OR relationship + that must be met before Cloud DLP scans a table can be set (like a + minimum row count or a minimum table age). + type: object + properties: + createdAfter: + description: >- + BigQuery table must have been created after this date. Used to avoid + backfilling. + type: string + format: google-datetime + types: + description: Restrict discovery to specific table types. + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTableTypes' + typeCollection: + description: Restrict discovery to categories of table types. type: string enumDescriptions: - - Unused location + - Unused. - >- - The infoType is not issued by or tied to a specific region, but is - used almost everywhere. - - The infoType is typically used in Argentina. - - The infoType is typically used in Armenia. - - The infoType is typically used in Australia. - - The infoType is typically used in Azerbaijan. - - The infoType is typically used in Belarus. - - The infoType is typically used in Belgium. - - The infoType is typically used in Brazil. - - The infoType is typically used in Canada. - - The infoType is typically used in Chile. - - The infoType is typically used in China. - - The infoType is typically used in Colombia. - - The infoType is typically used in Croatia. - - The infoType is typically used in Denmark. - - The infoType is typically used in France. - - The infoType is typically used in Finland. - - The infoType is typically used in Germany. - - The infoType is typically used in Hong Kong. - - The infoType is typically used in India. - - The infoType is typically used in Indonesia. - - The infoType is typically used in Ireland. - - The infoType is typically used in Israel. - - The infoType is typically used in Italy. - - The infoType is typically used in Japan. - - The infoType is typically used in Kazakhstan. - - The infoType is typically used in Korea. - - The infoType is typically used in Mexico. - - The infoType is typically used in the Netherlands. - - The infoType is typically used in New Zealand. - - The infoType is typically used in Norway. - - The infoType is typically used in Paraguay. - - The infoType is typically used in Peru. - - The infoType is typically used in Poland. - - The infoType is typically used in Portugal. - - The infoType is typically used in Russia. - - The infoType is typically used in Singapore. - - The infoType is typically used in South Africa. - - The infoType is typically used in Spain. - - The infoType is typically used in Sweden. - - The infoType is typically used in Switzerland. - - The infoType is typically used in Taiwan. - - The infoType is typically used in Thailand. - - The infoType is typically used in Turkey. - - The infoType is typically used in Ukraine. - - The infoType is typically used in the United Kingdom. - - The infoType is typically used in the United States. - - The infoType is typically used in Uruguay. - - The infoType is typically used in Uzbekistan. - - The infoType is typically used in Venezuela. - - The infoType is typically used in Google internally. + Automatically generate profiles for all tables, even if the table + type is not yet fully supported for analysis. Profiles for + unsupported tables will be generated with errors to indicate their + partial support. When full support is added, the tables will + automatically be profiled during the next scheduled run. + - >- + Only those types fully supported will be profiled. Will expand + automatically as Cloud DLP adds support for new table types. + Unsupported table types will not have partial profiles generated. enum: - - LOCATION_UNSPECIFIED - - GLOBAL - - ARGENTINA - - ARMENIA - - AUSTRALIA - - AZERBAIJAN - - BELARUS - - BELGIUM - - BRAZIL - - CANADA - - CHILE - - CHINA - - COLOMBIA - - CROATIA - - DENMARK - - FRANCE - - FINLAND - - GERMANY - - HONG_KONG - - INDIA - - INDONESIA - - IRELAND - - ISRAEL - - ITALY - - JAPAN - - KAZAKHSTAN - - KOREA - - MEXICO - - THE_NETHERLANDS - - NEW_ZEALAND - - NORWAY - - PARAGUAY - - PERU - - POLAND - - PORTUGAL - - RUSSIA - - SINGAPORE - - SOUTH_AFRICA - - SPAIN - - SWEDEN - - SWITZERLAND - - TAIWAN - - THAILAND - - TURKEY - - UKRAINE - - UNITED_KINGDOM - - UNITED_STATES - - URUGUAY - - UZBEKISTAN - - VENEZUELA - - INTERNAL + - BIG_QUERY_COLLECTION_UNSPECIFIED + - BIG_QUERY_COLLECTION_ALL_TYPES + - BIG_QUERY_COLLECTION_ONLY_SUPPORTED_TYPES + orConditions: + description: >- + At least one of the conditions must be true for a table to be + scanned. + $ref: '#/components/schemas/GooglePrivacyDlpV2OrConditions' + GooglePrivacyDlpV2BigQueryTableTypes: + id: GooglePrivacyDlpV2BigQueryTableTypes + description: The types of BigQuery tables supported by Cloud DLP. + type: object + properties: + types: + description: A set of BigQuery table types. + type: array + items: + type: string + enumDescriptions: + - Unused. + - A normal BigQuery table. + - A table that references data stored in Cloud Storage. + - A snapshot of a BigQuery table. + enum: + - BIG_QUERY_TABLE_TYPE_UNSPECIFIED + - BIG_QUERY_TABLE_TYPE_TABLE + - BIG_QUERY_TABLE_TYPE_EXTERNAL_BIG_LAKE + - BIG_QUERY_TABLE_TYPE_SNAPSHOT + GooglePrivacyDlpV2OrConditions: + id: GooglePrivacyDlpV2OrConditions + description: >- + There is an OR relationship between these attributes. They are used to + determine if a table should be scanned or not in Discovery. + type: object + properties: + minRowCount: + description: >- + Minimum number of rows that should be present before Cloud DLP + profiles a table + type: integer + format: int32 + minAge: + description: >- + Minimum age a table must have before Cloud DLP can profile it. Value + must be 1 hour or greater. + type: string + format: google-duration + GooglePrivacyDlpV2DiscoveryGenerationCadence: + id: GooglePrivacyDlpV2DiscoveryGenerationCadence + description: >- + What must take place for a profile to be updated and how frequently it + should occur. New tables are scanned as quickly as possible depending on + system capacity. + type: object + properties: + schemaModifiedCadence: + description: Governs when to update data profiles when a schema is modified. + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DiscoverySchemaModifiedCadence + tableModifiedCadence: + description: Governs when to update data profiles when a table is modified. + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryTableModifiedCadence' + inspectTemplateModifiedCadence: + description: >- + Governs when to update data profiles when the inspection rules + defined by the `InspectTemplate` change. If not set, changing the + template will not cause a data profile to update. + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence + refreshFrequency: + description: >- + Frequency at which profiles should be updated, regardless of whether + the underlying resource has changed. Defaults to never. + type: string + enumDescriptions: + - Unspecified. + - After the data profile is created, it will never be updated. + - The data profile can be updated up to once every 24 hours. + - The data profile can be updated up to once every 30 days. Default. + enum: + - UPDATE_FREQUENCY_UNSPECIFIED + - UPDATE_FREQUENCY_NEVER + - UPDATE_FREQUENCY_DAILY + - UPDATE_FREQUENCY_MONTHLY + GooglePrivacyDlpV2DiscoverySchemaModifiedCadence: + id: GooglePrivacyDlpV2DiscoverySchemaModifiedCadence + description: The cadence at which to update data profiles when a schema is modified. + type: object + properties: + types: + description: >- + The type of events to consider when deciding if the table's schema + has been modified and should have the profile updated. Defaults to + NEW_COLUMNS. + type: array + items: + type: string + enumDescriptions: + - Unused + - >- + Profiles should be regenerated when new columns are added to the + table. Default. + - >- + Profiles should be regenerated when columns are removed from the + table. + enum: + - SCHEMA_MODIFICATION_UNSPECIFIED + - SCHEMA_NEW_COLUMNS + - SCHEMA_REMOVED_COLUMNS + frequency: + description: >- + How frequently profiles may be updated when schemas are modified. + Defaults to monthly. + type: string + enumDescriptions: + - Unspecified. + - After the data profile is created, it will never be updated. + - The data profile can be updated up to once every 24 hours. + - The data profile can be updated up to once every 30 days. Default. + enum: + - UPDATE_FREQUENCY_UNSPECIFIED + - UPDATE_FREQUENCY_NEVER + - UPDATE_FREQUENCY_DAILY + - UPDATE_FREQUENCY_MONTHLY + GooglePrivacyDlpV2DiscoveryTableModifiedCadence: + id: GooglePrivacyDlpV2DiscoveryTableModifiedCadence + description: The cadence at which to update data profiles when a table is modified. + type: object + properties: + types: description: >- - The region or country that issued the ID or document represented by - the infoType. - industryCategory: + The type of events to consider when deciding if the table has been + modified and should have the profile updated. Defaults to + MODIFIED_TIMESTAMP. + type: array + items: + type: string + enumDescriptions: + - Unused. + - >- + A table will be considered modified when the last_modified_time + from BigQuery has been updated. + enum: + - TABLE_MODIFICATION_UNSPECIFIED + - TABLE_MODIFIED_TIMESTAMP + frequency: + description: >- + How frequently data profiles can be updated when tables are + modified. Defaults to never. type: string enumDescriptions: - - Unused industry - - The infoType is typically used in the finance industry. - - The infoType is typically used in the health industry. - - The infoType is typically used in the telecommunications industry. + - Unspecified. + - After the data profile is created, it will never be updated. + - The data profile can be updated up to once every 24 hours. + - The data profile can be updated up to once every 30 days. Default. enum: - - INDUSTRY_UNSPECIFIED - - FINANCE - - HEALTH - - TELECOMMUNICATIONS + - UPDATE_FREQUENCY_UNSPECIFIED + - UPDATE_FREQUENCY_NEVER + - UPDATE_FREQUENCY_DAILY + - UPDATE_FREQUENCY_MONTHLY + GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence: + id: GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence + description: >- + The cadence at which to update data profiles when the inspection rules + defined by the `InspectTemplate` change. + type: object + properties: + frequency: description: >- - The group of relevant businesses where this infoType is commonly - used - typeCategory: - description: The class of identifiers where this infoType belongs - enum: - - TYPE_UNSPECIFIED - - PII - - SPII - - DEMOGRAPHIC - - CREDENTIAL - - GOVERNMENT_ID - - DOCUMENT - - CONTEXTUAL_INFORMATION + How frequently data profiles can be updated when the template is + modified. Defaults to never. type: string enumDescriptions: - - Unused type - - >- - Personally identifiable information, for example, a name or phone - number - - >- - Personally identifiable information that is especially sensitive, - for example, a passport number. - - >- - Attributes that can partially identify someone, especially in - combination with other attributes, like age, height, and gender. - - Confidential or secret information, for example, a password. - - An identification document issued by a government. - - A document, for example, a resume or source code. - - >- - Information that is not sensitive on its own, but provides details - about the circumstances surrounding an entity or an event. - description: >- - Classification of infoTypes to organize them according to geographic - location, industry, and data type. - GooglePrivacyDlpV2AllOtherBigQueryTables: + - Unspecified. + - After the data profile is created, it will never be updated. + - The data profile can be updated up to once every 24 hours. + - The data profile can be updated up to once every 30 days. Default. + enum: + - UPDATE_FREQUENCY_UNSPECIFIED + - UPDATE_FREQUENCY_NEVER + - UPDATE_FREQUENCY_DAILY + - UPDATE_FREQUENCY_MONTHLY + GooglePrivacyDlpV2Disabled: + id: GooglePrivacyDlpV2Disabled + description: Do not profile the tables. type: object properties: {} - description: >- - Catch-all for all other tables not specified by other filters. Should - always be last, except for single-table configurations, which will only - have a TableReference target. - id: GooglePrivacyDlpV2AllOtherBigQueryTables - GooglePrivacyDlpV2ExclusionRule: - id: GooglePrivacyDlpV2ExclusionRule + GooglePrivacyDlpV2CloudSqlDiscoveryTarget: + id: GooglePrivacyDlpV2CloudSqlDiscoveryTarget + description: Target used to match against for discovery with Cloud SQL tables. + type: object properties: - excludeInfoTypes: - description: Set of infoTypes for which findings would affect this rule. - $ref: '#/components/schemas/GooglePrivacyDlpV2ExcludeInfoTypes' - regex: - $ref: '#/components/schemas/GooglePrivacyDlpV2Regex' - description: Regular expression which defines the rule. - matchingType: - description: How the rule is applied, see MatchingType documentation for details. - enum: - - MATCHING_TYPE_UNSPECIFIED - - MATCHING_TYPE_FULL_MATCH - - MATCHING_TYPE_PARTIAL_MATCH - - MATCHING_TYPE_INVERSE_MATCH - type: string - enumDescriptions: - - Invalid. - - >- - Full match. - Dictionary: join of Dictionary results matched - complete finding quote - Regex: all regex matches fill a finding - quote start to end - Exclude info type: completely inside - affecting info types findings - - >- - Partial match. - Dictionary: at least one of the tokens in the - finding matches - Regex: substring of the finding matches - - Exclude info type: intersects with affecting info types findings - - >- - Inverse match. - Dictionary: no tokens in the finding match the - dictionary - Regex: finding doesn't match the regex - Exclude info - type: no intersection with affecting info types findings - excludeByHotword: - $ref: '#/components/schemas/GooglePrivacyDlpV2ExcludeByHotword' + filter: description: >- - Drop if the hotword rule is contained in the proximate context. For - tabular data, the context includes the column name. - dictionary: - description: Dictionary which defines the rule. - $ref: '#/components/schemas/GooglePrivacyDlpV2Dictionary' + Required. The tables the discovery cadence applies to. The first + target with a matching filter will be the one to apply to a table. + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryCloudSqlFilter' + conditions: + description: >- + In addition to matching the filter, these conditions must be true + before a profile is generated. + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryCloudSqlConditions' + generationCadence: + description: >- + How often and when to update profiles. New tables that match both + the filter and conditions are scanned as quickly as possible + depending on system capacity. + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DiscoveryCloudSqlGenerationCadence + disabled: + description: Disable profiling for database resources that match this filter. + $ref: '#/components/schemas/GooglePrivacyDlpV2Disabled' + GooglePrivacyDlpV2DiscoveryCloudSqlFilter: + id: GooglePrivacyDlpV2DiscoveryCloudSqlFilter description: >- - The rule that specifies conditions when findings of infoTypes specified - in `InspectionRuleSet` are removed from results. - type: object - GooglePrivacyDlpV2DlpJob: - description: Combines all of the information about a DLP job. - id: GooglePrivacyDlpV2DlpJob + Determines what tables will have profiles generated within an + organization or project. Includes the ability to filter by regular + expression patterns on project ID, location, instance, database, and + database resource name. type: object properties: - jobTriggerName: - type: string + collection: + description: A specific set of database resources for this filter to apply to. + $ref: '#/components/schemas/GooglePrivacyDlpV2DatabaseResourceCollection' + others: description: >- - If created by a job trigger, the resource name of the trigger that - instantiated the job. - createTime: - format: google-datetime - description: Time when the job was created. - type: string - type: - description: The type of job. - enumDescriptions: - - Defaults to INSPECT_JOB. - - The job inspected Google Cloud for sensitive data. - - The job executed a Risk Analysis computation. - type: string - enum: - - DLP_JOB_TYPE_UNSPECIFIED - - INSPECT_JOB - - RISK_ANALYSIS_JOB - state: - type: string - enum: - - JOB_STATE_UNSPECIFIED - - PENDING - - RUNNING - - DONE - - CANCELED - - FAILED - - ACTIVE - description: State of a job. - enumDescriptions: - - Unused. - - The job has not yet started. - - >- - The job is currently running. Once a job has finished it will - transition to FAILED or DONE. - - The job is no longer running. - - The job was canceled before it could be completed. - - The job had an error and did not complete. - - >- - The job is currently accepting findings via hybridInspect. A - hybrid job in ACTIVE state may continue to have findings added to - it through the calling of hybridInspect. After the job has - finished no more calls to hybridInspect may be made. ACTIVE jobs - can transition to DONE. - lastModified: - type: string - description: Time when the job was last modified by the system. - format: google-datetime - startTime: - format: google-datetime - description: Time when the job started. - type: string - name: - type: string - description: The server-assigned name. - endTime: - format: google-datetime - type: string - description: Time when the job finished. - riskDetails: - $ref: '#/components/schemas/GooglePrivacyDlpV2AnalyzeDataSourceRiskDetails' - description: Results from analyzing risk of a data source. - inspectDetails: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectDataSourceDetails' - description: Results from inspecting a data source. - errors: - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Error' - description: A stream of errors encountered running the job. - actionDetails: - description: Events that should occur after the job has completed. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2ActionDetails' - type: array - GooglePrivacyDlpV2DiscoveryStartingLocation: + Catch-all. This should always be the last target in the list because + anything above it will apply first. Should only appear once in a + configuration. If none is specified, a default one will be added + automatically. + $ref: '#/components/schemas/GooglePrivacyDlpV2AllOtherDatabaseResources' + databaseResourceReference: + description: >- + The database resource to scan. Targets including this can only + include one target (the target with this database resource + reference). + $ref: '#/components/schemas/GooglePrivacyDlpV2DatabaseResourceReference' + GooglePrivacyDlpV2DatabaseResourceCollection: + id: GooglePrivacyDlpV2DatabaseResourceCollection + description: >- + Match database resources using regex filters. Examples of database + resources are tables, views, and stored procedures. type: object properties: - organizationId: - format: int64 - type: string - description: The ID of an organization to scan. - folderId: - format: int64 - type: string - description: The ID of the folder within an organization to be scanned. - id: GooglePrivacyDlpV2DiscoveryStartingLocation + includeRegexes: + description: >- + A collection of regular expressions to match a database resource + against. + $ref: '#/components/schemas/GooglePrivacyDlpV2DatabaseResourceRegexes' + GooglePrivacyDlpV2DatabaseResourceRegexes: + id: GooglePrivacyDlpV2DatabaseResourceRegexes description: >- - The location to begin a discovery scan. Denotes an organization ID or - folder ID within an organization. - GooglePrivacyDlpV2StorageConfig: - description: Shared message indicating Cloud storage type. - id: GooglePrivacyDlpV2StorageConfig - properties: - hybridOptions: - description: Hybrid inspection options. - $ref: '#/components/schemas/GooglePrivacyDlpV2HybridOptions' - cloudStorageOptions: - $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStorageOptions' - description: Cloud Storage options. - timespanConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2TimespanConfig' - description: Configuration of the timespan of the items to include in scanning. - datastoreOptions: - $ref: '#/components/schemas/GooglePrivacyDlpV2DatastoreOptions' - description: Google Cloud Datastore options. - bigQueryOptions: - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryOptions' - description: BigQuery options. + A collection of regular expressions to determine what database resources + to match against. type: object - GooglePrivacyDlpV2CreateDeidentifyTemplateRequest: properties: - deidentifyTemplate: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' - description: Required. The DeidentifyTemplate to create. - locationId: - type: string - description: Deprecated. This field has no effect. - templateId: + patterns: description: >- - The template id can contain uppercase and lowercase letters, - numbers, and hyphens; that is, it must match the regular expression: - `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty - to allow the system to generate one. - type: string - description: Request message for CreateDeidentifyTemplate. + A group of regular expression patterns to match against one or more + database resources. Maximum of 100 entries. The sum of all regular + expression's length can't exceed 10 KiB. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2DatabaseResourceRegex' + GooglePrivacyDlpV2DatabaseResourceRegex: + id: GooglePrivacyDlpV2DatabaseResourceRegex + description: >- + A pattern to match against one or more database resources. At least one + pattern must be specified. Regular expressions use RE2 + [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be + found under the google/re2 repository on GitHub. type: object - id: GooglePrivacyDlpV2CreateDeidentifyTemplateRequest - GooglePrivacyDlpV2ColumnDataProfile: properties: - freeTextScore: - type: number + projectIdRegex: description: >- - The likelihood that this column contains free-form text. A value - close to 1 may indicate the column is likely to contain free-form or - natural language text. Range in 0-1. - format: double - estimatedNullPercentage: - description: Approximate percentage of entries being null in the column. + For organizations, if unset, will match all projects. Has no effect + for configurations created within a project. type: string - enum: - - NULL_PERCENTAGE_LEVEL_UNSPECIFIED - - NULL_PERCENTAGE_VERY_LOW - - NULL_PERCENTAGE_LOW - - NULL_PERCENTAGE_MEDIUM - - NULL_PERCENTAGE_HIGH - enumDescriptions: - - Unused. - - Very few null entries. - - Some null entries. - - A few null entries. - - A lot of null entries. - tableFullResource: - description: The resource name of the resource this column is within. + instanceRegex: + description: >- + Regex to test the instance name against. If empty, all instances + match. type: string - state: - description: State of a profile. - enum: - - STATE_UNSPECIFIED - - RUNNING - - DONE + databaseRegex: + description: >- + Regex to test the database name against. If empty, all databases + match. type: string - enumDescriptions: - - Unused. - - >- - The profile is currently running. Once a profile has finished it - will transition to DONE. - - >- - The profile is no longer generating. If profile_status.status.code - is 0, the profile succeeded, otherwise, it failed. - profileLastGenerated: - format: google-datetime + databaseResourceNameRegex: + description: >- + Regex to test the database resource's name against. An example of a + database resource name is a table's name. Other database resource + names like view names could be included in the future. If empty, all + database resources match. type: string - description: The last time the profile was generated. - estimatedUniquenessScore: - enumDescriptions: - - >- - Some columns do not have estimated uniqueness. Possible reasons - include having too few values. - - >- - Low uniqueness, possibly a boolean, enum or similiarly typed - column. - - Medium uniqueness. - - >- - High uniqueness, possibly a column of free text or unique - identifiers. - description: Approximate uniqueness of the column. + GooglePrivacyDlpV2AllOtherDatabaseResources: + id: GooglePrivacyDlpV2AllOtherDatabaseResources + description: Match database resources not covered by any other filter. + type: object + properties: {} + GooglePrivacyDlpV2DatabaseResourceReference: + id: GooglePrivacyDlpV2DatabaseResourceReference + description: Identifies a single database resource, like a table within a database. + type: object + properties: + projectId: + description: >- + Required. If within a project-level config, then this must match the + config's project ID. type: string - enum: - - UNIQUENESS_SCORE_LEVEL_UNSPECIFIED - - UNIQUENESS_SCORE_LOW - - UNIQUENESS_SCORE_MEDIUM - - UNIQUENESS_SCORE_HIGH - datasetLocation: + instance: description: >- - If supported, the location where the dataset's data is stored. See - https://cloud.google.com/bigquery/docs/locations for supported - BigQuery locations. + Required. The instance where this resource is located. For example: + Cloud SQL instance ID. type: string - columnType: - enum: - - COLUMN_DATA_TYPE_UNSPECIFIED - - TYPE_INT64 - - TYPE_BOOL - - TYPE_FLOAT64 - - TYPE_STRING - - TYPE_BYTES - - TYPE_TIMESTAMP - - TYPE_DATE - - TYPE_TIME - - TYPE_DATETIME - - TYPE_GEOGRAPHY - - TYPE_NUMERIC - - TYPE_RECORD - - TYPE_BIGNUMERIC - - TYPE_JSON - - TYPE_INTERVAL - - TYPE_RANGE_DATE - - TYPE_RANGE_DATETIME - - TYPE_RANGE_TIMESTAMP - description: The data type of a given column. - enumDescriptions: - - Invalid type. - - Encoded as a string in decimal format. - - Encoded as a boolean "false" or "true". - - Encoded as a number, or string "NaN", "Infinity" or "-Infinity". - - Encoded as a string value. - - Encoded as a base64 string per RFC 4648, section 4. - - >- - Encoded as an RFC 3339 timestamp with mandatory "Z" time zone - string: 1985-04-12T23:20:50.52Z - - 'Encoded as RFC 3339 full-date format string: 1985-04-12' - - 'Encoded as RFC 3339 partial-time format string: 23:20:50.52' - - >- - Encoded as RFC 3339 full-date "T" partial-time: - 1985-04-12T23:20:50.52 - - Encoded as WKT - - Encoded as a decimal string. - - Container of ordered fields, each with a type and field name. - - Decimal type. - - Json type. - - Interval type. - - '`Range` type.' - - '`Range` type.' - - '`Range` type.' + database: + description: Required. Name of a database within the instance. type: string - columnInfoType: + databaseResource: + description: >- + Required. Name of a database resource, for example, a table within + the database. + type: string + GooglePrivacyDlpV2DiscoveryCloudSqlConditions: + id: GooglePrivacyDlpV2DiscoveryCloudSqlConditions + description: >- + Requirements that must be true before a table is profiled for the first + time. + type: object + properties: + databaseEngines: + description: >- + Optional. Database engines that should be profiled. Optional. + Defaults to ALL_SUPPORTED_DATABASE_ENGINES if unspecified. + type: array + items: + type: string + enumDescriptions: + - Unused. + - Include all supported database engines. + - MySQL database. + - PostgreSQL database. + enum: + - DATABASE_ENGINE_UNSPECIFIED + - ALL_SUPPORTED_DATABASE_ENGINES + - MYSQL + - POSTGRES + types: + description: >- + Data profiles will only be generated for the database resource types + specified in this field. If not specified, defaults to + [DATABASE_RESOURCE_TYPE_ALL_SUPPORTED_TYPES]. + type: array + items: + type: string + enumDescriptions: + - Unused. + - >- + Includes database resource types that become supported at a + later time. + - Tables. + enum: + - DATABASE_RESOURCE_TYPE_UNSPECIFIED + - DATABASE_RESOURCE_TYPE_ALL_SUPPORTED_TYPES + - DATABASE_RESOURCE_TYPE_TABLE + GooglePrivacyDlpV2DiscoveryCloudSqlGenerationCadence: + id: GooglePrivacyDlpV2DiscoveryCloudSqlGenerationCadence + description: >- + How often existing tables should have their profiles refreshed. New + tables are scanned as quickly as possible depending on system capacity. + type: object + properties: + schemaModifiedCadence: + description: When to reprofile if the schema has changed. + $ref: '#/components/schemas/GooglePrivacyDlpV2SchemaModifiedCadence' + refreshFrequency: description: >- - If it's been determined this column can be identified as a single - type, this will be set. Otherwise the column either has - unidentifiable content or mixed types. - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeSummary' - datasetProjectId: - description: The Google Cloud project ID that owns the profiled resource. - type: string - column: - description: The name of the column. - type: string - datasetId: + Data changes (non-schema changes) in Cloud SQL tables can't trigger + reprofiling. If you set this field, profiles are refreshed at this + frequency regardless of whether the underlying tables have changed. + Defaults to never. type: string + enumDescriptions: + - Unspecified. + - After the data profile is created, it will never be updated. + - The data profile can be updated up to once every 24 hours. + - The data profile can be updated up to once every 30 days. Default. + enum: + - UPDATE_FREQUENCY_UNSPECIFIED + - UPDATE_FREQUENCY_NEVER + - UPDATE_FREQUENCY_DAILY + - UPDATE_FREQUENCY_MONTHLY + inspectTemplateModifiedCadence: description: >- - The BigQuery dataset ID, if the resource profiled is a BigQuery - table. - otherMatches: - description: Other types found within this column. List will be unordered. + Governs when to update data profiles when the inspection rules + defined by the `InspectTemplate` change. If not set, changing the + template will not cause a data profile to update. + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence + GooglePrivacyDlpV2SchemaModifiedCadence: + id: GooglePrivacyDlpV2SchemaModifiedCadence + description: >- + How frequently to modify the profile when the table's schema is + modified. + type: object + properties: + types: + description: >- + The types of schema modifications to consider. Defaults to + NEW_COLUMNS. type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2OtherInfoTypeSummary' - tableDataProfile: - type: string - description: The resource name of the table data profile. - sensitivityScore: - $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' - description: The sensitivity of this column. - tableId: - type: string - description: The table ID. - profileStatus: - $ref: '#/components/schemas/GooglePrivacyDlpV2ProfileStatus' + type: string + enumDescriptions: + - Unused. + - New columns have appeared. + - Columns have been removed from the table. + enum: + - SQL_SCHEMA_MODIFICATION_UNSPECIFIED + - NEW_COLUMNS + - REMOVED_COLUMNS + frequency: description: >- - Success or error status from the most recent profile generation - attempt. May be empty if the profile is still being generated. - policyState: - description: Indicates if a policy tag has been applied to the column. - enum: - - COLUMN_POLICY_STATE_UNSPECIFIED - - COLUMN_POLICY_TAGGED - enumDescriptions: - - No policy tags. - - Column has policy tag applied. - type: string - name: - description: The name of the profile. + Frequency to regenerate data profiles when the schema is modified. + Defaults to monthly. type: string - dataRiskLevel: - description: The data risk level for this column. - $ref: '#/components/schemas/GooglePrivacyDlpV2DataRiskLevel' - description: The profile for a scanned column within a table. - id: GooglePrivacyDlpV2ColumnDataProfile + enumDescriptions: + - Unspecified. + - After the data profile is created, it will never be updated. + - The data profile can be updated up to once every 24 hours. + - The data profile can be updated up to once every 30 days. Default. + enum: + - UPDATE_FREQUENCY_UNSPECIFIED + - UPDATE_FREQUENCY_NEVER + - UPDATE_FREQUENCY_DAILY + - UPDATE_FREQUENCY_MONTHLY + GooglePrivacyDlpV2SecretsDiscoveryTarget: + id: GooglePrivacyDlpV2SecretsDiscoveryTarget + description: >- + Discovery target for credentials and secrets in cloud resource metadata. + This target does not include any filtering or frequency controls. Cloud + DLP will scan cloud resource metadata for secrets daily. No inspect + template should be included in the discovery config for a security + benchmarks scan. Instead, the built-in list of secrets and credentials + infoTypes will be used (see + https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). + Credentials and secrets discovered will be reported as vulnerabilities + to Security Command Center. type: object - GooglePrivacyDlpV2AwsAccount: - description: AWS account. + properties: {} + GooglePrivacyDlpV2CloudStorageDiscoveryTarget: + id: GooglePrivacyDlpV2CloudStorageDiscoveryTarget + description: Target used to match against for discovery with Cloud Storage buckets. type: object - id: GooglePrivacyDlpV2AwsAccount properties: - accountId: - description: Required. AWS account ID. - type: string - GooglePrivacyDlpV2FileExtensionInfo: + filter: + description: >- + Required. The buckets the generation_cadence applies to. The first + target with a matching filter will be the one to apply to a bucket. + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryCloudStorageFilter' + conditions: + description: >- + Optional. In addition to matching the filter, these conditions must + be true before a profile is generated. + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryFileStoreConditions' + generationCadence: + description: >- + Optional. How often and when to update profiles. New buckets that + match both the filter and conditions are scanned as quickly as + possible depending on system capacity. + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DiscoveryCloudStorageGenerationCadence + disabled: + description: Optional. Disable profiling for buckets that match this filter. + $ref: '#/components/schemas/GooglePrivacyDlpV2Disabled' + GooglePrivacyDlpV2DiscoveryCloudStorageFilter: + id: GooglePrivacyDlpV2DiscoveryCloudStorageFilter + description: >- + Determines which buckets will have profiles generated within an + organization or project. Includes the ability to filter by regular + expression patterns on project ID and bucket name. type: object - id: GooglePrivacyDlpV2FileExtensionInfo properties: - fileExtension: - type: string - description: The file extension if set. (aka .pdf, .jpg, .txt) - description: Information regarding the discovered file extension. - GooglePrivacyDlpV2KMapEstimationConfig: + collection: + description: Optional. A specific set of buckets for this filter to apply to. + $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreCollection' + cloudStorageResourceReference: + description: >- + Optional. The bucket to scan. Targets including this can only + include one target (the target with this bucket). This enables + profiling the contents of a single bucket, while the other options + allow for easy profiling of many bucets within a project or an + organization. + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStorageResourceReference' + others: + description: >- + Optional. Catch-all. This should always be the last target in the + list because anything above it will apply first. Should only appear + once in a configuration. If none is specified, a default one will be + added automatically. + $ref: '#/components/schemas/GooglePrivacyDlpV2AllOtherResources' + GooglePrivacyDlpV2FileStoreCollection: + id: GooglePrivacyDlpV2FileStoreCollection + description: Match file stores (e.g. buckets) using filters. + type: object + properties: + includeRegexes: + description: >- + Optional. A collection of regular expressions to match a file store + against. + $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreRegexes' + GooglePrivacyDlpV2FileStoreRegexes: + id: GooglePrivacyDlpV2FileStoreRegexes description: >- - Reidentifiability metric. This corresponds to a risk model similar to - what is called "journalist risk" in the literature, except the attack - dataset is statistically modeled instead of being perfectly known. This - can be done using publicly available data (like the US Census), or using - a custom statistical model (indicated as one or several BigQuery - tables), or by extrapolating from the distribution of values in the - input dataset. + A collection of regular expressions to determine what file store to + match against. + type: object + properties: + patterns: + description: >- + Required. The group of regular expression patterns to match against + one or more file stores. Maximum of 100 entries. The sum of all + regular expression's length can't exceed 10 KiB. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreRegex' + GooglePrivacyDlpV2FileStoreRegex: + id: GooglePrivacyDlpV2FileStoreRegex + description: A pattern to match against one or more file stores. + type: object + properties: + cloudStorageRegex: + description: Optional. Regex for Cloud Storage. + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStorageRegex' + GooglePrivacyDlpV2CloudStorageRegex: + id: GooglePrivacyDlpV2CloudStorageRegex + description: >- + A pattern to match against one or more file stores. At least one pattern + must be specified. Regular expressions use RE2 + [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be + found under the google/re2 repository on GitHub. + type: object + properties: + projectIdRegex: + description: Optional. For organizations, if unset, will match all projects. + type: string + bucketNameRegex: + description: >- + Optional. Regex to test the bucket name against. If empty, all + buckets match. Example: "marketing2021" or "(marketing)\d{4}" will + both match the bucket gs://marketing2021 + type: string + GooglePrivacyDlpV2CloudStorageResourceReference: + id: GooglePrivacyDlpV2CloudStorageResourceReference + description: Identifies a single Cloud Storage bucket. type: object - id: GooglePrivacyDlpV2KMapEstimationConfig properties: - quasiIds: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2TaggedField' - description: >- - Required. Fields considered to be quasi-identifiers. No two columns - can have the same tag. - type: array - regionCode: - description: >- - ISO 3166-1 alpha-2 region code to use in the statistical modeling. - Set if no column is tagged with a region-specific InfoType (like - US_ZIP_5) or a region code. + bucketName: + description: Required. The bucket to scan. type: string - auxiliaryTables: - type: array + projectId: description: >- - Several auxiliary tables can be used in the analysis. Each - custom_tag used to tag a quasi-identifiers column must appear in - exactly one column of one auxiliary table. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2AuxiliaryTable' - GooglePrivacyDlpV2ProfileStatus: - id: GooglePrivacyDlpV2ProfileStatus + Required. If within a project-level config, then this must match the + config's project id. + type: string + GooglePrivacyDlpV2AllOtherResources: + id: GooglePrivacyDlpV2AllOtherResources + description: Match discovery resources not covered by any other filter. + type: object + properties: {} + GooglePrivacyDlpV2DiscoveryFileStoreConditions: + id: GooglePrivacyDlpV2DiscoveryFileStoreConditions + description: >- + Requirements that must be true before a file store is scanned in + discovery for the first time. There is an AND relationship between the + top-level attributes. + type: object properties: - status: - $ref: '#/components/schemas/GoogleRpcStatus' + createdAfter: description: >- - Profiling status code and optional message. The `status.code` value - is 0 (default value) for OK. - timestamp: + Optional. File store must have been created after this date. Used to + avoid backfilling. type: string - description: Time when the profile generation status was updated format: google-datetime + minAge: + description: >- + Optional. Minimum age a file store must have. If set, the value must + be 1 hour or greater. + type: string + format: google-duration + cloudStorageConditions: + description: Optional. Cloud Storage conditions. + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DiscoveryCloudStorageConditions + GooglePrivacyDlpV2DiscoveryCloudStorageConditions: + id: GooglePrivacyDlpV2DiscoveryCloudStorageConditions + description: >- + Requirements that must be true before a Cloud Storage bucket or object + is scanned in discovery for the first time. There is an AND relationship + between the top-level attributes. type: object - description: Success or errors for the profile generation. - GooglePrivacyDlpV2TagResources: - type: object - id: GooglePrivacyDlpV2TagResources properties: - profileGenerationsToTag: + includedObjectAttributes: description: >- - The profile generations for which the tag should be attached to - resources. If you attach a tag to only new profiles, then if the - sensitivity score of a profile subsequently changes, its tag doesn't - change. By default, this field includes only new profiles. To - include both new and updated profiles for tagging, this field should - explicitly include both `PROFILE_GENERATION_NEW` and - `PROFILE_GENERATION_UPDATE`. + Required. Only objects with the specified attributes will be + scanned. If an object has one of the specified attributes but is + inside an excluded bucket, it will not be scanned. Defaults to + [ALL_SUPPORTED_OBJECTS]. A profile will be created even if no + objects match the included_object_attributes. + type: array items: + type: string enumDescriptions: - Unused. - - The profile is the first profile for the resource. - - The profile is an update to a previous profile. - type: string + - Scan objects regardless of the attribute. + - Scan objects with the standard storage class. + - >- + Scan objects with the nearline storage class. This will incur + retrieval fees. + - >- + Scan objects with the coldline storage class. This will incur + retrieval fees. + - >- + Scan objects with the archive storage class. This will incur + retrieval fees. + - Scan objects with the regional storage class. + - Scan objects with the multi-regional storage class. + - >- + Scan objects with the dual-regional storage class. This will + incur retrieval fees. enum: - - PROFILE_GENERATION_UNSPECIFIED - - PROFILE_GENERATION_NEW - - PROFILE_GENERATION_UPDATE - type: array - lowerDataRiskToLow: + - CLOUD_STORAGE_OBJECT_ATTRIBUTE_UNSPECIFIED + - ALL_SUPPORTED_OBJECTS + - STANDARD + - NEARLINE + - COLDLINE + - ARCHIVE + - REGIONAL + - MULTI_REGIONAL + - DURABLE_REDUCED_AVAILABILITY + includedBucketAttributes: description: >- - Whether applying a tag to a resource should lower the risk of the - profile for that resource. For example, in conjunction with an [IAM - deny policy](https://cloud.google.com/iam/docs/deny-overview), you - can deny all principals a permission if a tag value is present, - mitigating the risk of the resource. This also lowers the data risk - of resources at the lower levels of the resource hierarchy. For - example, reducing the data risk of a table data profile also reduces - the data risk of the constituent column data profiles. - type: boolean - tagConditions: - description: The tags to associate with different conditions. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2TagCondition' + Required. Only objects with the specified attributes will be + scanned. Defaults to [ALL_SUPPORTED_BUCKETS] if unset. type: array + items: + type: string + enumDescriptions: + - Unused. + - Scan buckets regardless of the attribute. + - >- + Buckets with + [Autoclass](https://cloud.google.com/storage/docs/autoclass) + disabled. Only one of AUTOCLASS_DISABLED or AUTOCLASS_ENABLED + should be set. + - >- + Buckets with + [Autoclass](https://cloud.google.com/storage/docs/autoclass) + enabled. Only one of AUTOCLASS_DISABLED or AUTOCLASS_ENABLED + should be set. Scanning Autoclass-enabled buckets can affect + object storage classes. + enum: + - CLOUD_STORAGE_BUCKET_ATTRIBUTE_UNSPECIFIED + - ALL_SUPPORTED_BUCKETS + - AUTOCLASS_DISABLED + - AUTOCLASS_ENABLED + GooglePrivacyDlpV2DiscoveryCloudStorageGenerationCadence: + id: GooglePrivacyDlpV2DiscoveryCloudStorageGenerationCadence description: >- - If set, attaches the [tags] - (https://cloud.google.com/resource-manager/docs/tags/tags-overview) - provided to profiled resources. Tags support [access - control](https://cloud.google.com/iam/docs/tags-access-control). You can - conditionally grant or deny access to a resource based on whether the - resource has a specific tag. - GooglePrivacyDlpV2DeidentifyDataSourceStats: + How often existing buckets should have their profiles refreshed. New + buckets are scanned as quickly as possible depending on system capacity. + type: object properties: - transformationErrorCount: - description: Number of errors encountered while trying to apply transformations. - type: string - format: int64 - transformationCount: - format: int64 - description: Number of successfully applied transformations. + refreshFrequency: + description: >- + Optional. Data changes in Cloud Storage can't trigger reprofiling. + If you set this field, profiles are refreshed at this frequency + regardless of whether the underlying buckets have changed. Defaults + to never. type: string - transformedBytes: - description: Total size in bytes that were transformed in some way. - format: int64 + enumDescriptions: + - Unspecified. + - After the data profile is created, it will never be updated. + - The data profile can be updated up to once every 24 hours. + - The data profile can be updated up to once every 30 days. Default. + enum: + - UPDATE_FREQUENCY_UNSPECIFIED + - UPDATE_FREQUENCY_NEVER + - UPDATE_FREQUENCY_DAILY + - UPDATE_FREQUENCY_MONTHLY + inspectTemplateModifiedCadence: + description: >- + Optional. Governs when to update data profiles when the inspection + rules defined by the `InspectTemplate` change. If not set, changing + the template will not cause a data profile to update. + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence + GooglePrivacyDlpV2OtherCloudDiscoveryTarget: + id: GooglePrivacyDlpV2OtherCloudDiscoveryTarget + description: >- + Target used to match against for discovery of resources from other + clouds. An [AWS connector in Security Command Center + (Enterprise](https://cloud.google.com/security-command-center/docs/connect-scc-to-aws) + is required to use this feature. + type: object + properties: + dataSourceType: + description: >- + Required. The type of data profiles generated by this discovery + target. Supported values are: * aws/s3/bucket + $ref: '#/components/schemas/GooglePrivacyDlpV2DataSourceType' + filter: + description: >- + Required. The resources that the discovery cadence applies to. The + first target with a matching filter will be the one to apply to a + resource. + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryOtherCloudFilter' + conditions: + description: >- + Optional. In addition to matching the filter, these conditions must + be true before a profile is generated. + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryOtherCloudConditions' + generationCadence: + description: >- + How often and when to update data profiles. New resources that match + both the filter and conditions are scanned as quickly as possible + depending on system capacity. + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DiscoveryOtherCloudGenerationCadence + disabled: + description: Disable profiling for resources that match this filter. + $ref: '#/components/schemas/GooglePrivacyDlpV2Disabled' + GooglePrivacyDlpV2DataSourceType: + id: GooglePrivacyDlpV2DataSourceType + description: Message used to identify the type of resource being profiled. + type: object + properties: + dataSource: + description: >- + Output only. An identifying string to the type of resource being + profiled. Current values: * google/bigquery/table * google/project * + google/sql/table * google/gcs/bucket + readOnly: true type: string + GooglePrivacyDlpV2DiscoveryOtherCloudFilter: + id: GooglePrivacyDlpV2DiscoveryOtherCloudFilter + description: >- + Determines which resources from the other cloud will have profiles + generated. Includes the ability to filter by resource names. + type: object + properties: + collection: + description: A collection of resources for this filter to apply to. + $ref: '#/components/schemas/GooglePrivacyDlpV2OtherCloudResourceCollection' + singleResource: + description: >- + The resource to scan. Configs using this filter can only have one + target (the target with this single resource reference). + $ref: >- + #/components/schemas/GooglePrivacyDlpV2OtherCloudSingleResourceReference + others: + description: >- + Optional. Catch-all. This should always be the last target in the + list because anything above it will apply first. Should only appear + once in a configuration. If none is specified, a default one will be + added automatically. + $ref: '#/components/schemas/GooglePrivacyDlpV2AllOtherResources' + GooglePrivacyDlpV2OtherCloudResourceCollection: + id: GooglePrivacyDlpV2OtherCloudResourceCollection + description: Match resources using regex filters. type: object - id: GooglePrivacyDlpV2DeidentifyDataSourceStats - description: Summary of what was modified during a transformation. - GooglePrivacyDlpV2Result: + properties: + includeRegexes: + description: A collection of regular expressions to match a resource against. + $ref: '#/components/schemas/GooglePrivacyDlpV2OtherCloudResourceRegexes' + GooglePrivacyDlpV2OtherCloudResourceRegexes: + id: GooglePrivacyDlpV2OtherCloudResourceRegexes description: >- - All result fields mentioned below are updated while the job is - processing. - id: GooglePrivacyDlpV2Result + A collection of regular expressions to determine what resources to match + against. type: object properties: - hybridStats: - $ref: '#/components/schemas/GooglePrivacyDlpV2HybridInspectStatistics' - description: Statistics related to the processing of hybrid inspect. - totalEstimatedBytes: - description: Estimate of the number of bytes to process. - type: string - format: int64 - numRowsProcessed: + patterns: description: >- - Number of rows scanned after sampling and time filtering (applicable - for row based stores such as BigQuery). - format: int64 - type: string - processedBytes: - description: Total size in bytes that were processed. - format: int64 - type: string - infoTypeStats: + A group of regular expression patterns to match against one or more + resources. Maximum of 100 entries. The sum of all regular + expression's length can't exceed 10 KiB. type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeStats' - description: >- - Statistics of how many instances of each info type were found during - inspect job. - GooglePrivacyDlpV2HybridInspectStatistics: - id: GooglePrivacyDlpV2HybridInspectStatistics - description: Statistics related to processing hybrid inspect requests. + $ref: '#/components/schemas/GooglePrivacyDlpV2OtherCloudResourceRegex' + GooglePrivacyDlpV2OtherCloudResourceRegex: + id: GooglePrivacyDlpV2OtherCloudResourceRegex + description: >- + A pattern to match against one or more resources. At least one pattern + must be specified. Regular expressions use RE2 + [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be + found under the google/re2 repository on GitHub. type: object properties: - processedCount: - format: int64 + amazonS3BucketRegex: + description: Regex for Amazon S3 buckets. + $ref: '#/components/schemas/GooglePrivacyDlpV2AmazonS3BucketRegex' + GooglePrivacyDlpV2AmazonS3BucketRegex: + id: GooglePrivacyDlpV2AmazonS3BucketRegex + description: Amazon S3 bucket regex. + type: object + properties: + awsAccountRegex: + description: The AWS account regex. + $ref: '#/components/schemas/GooglePrivacyDlpV2AwsAccountRegex' + bucketNameRegex: + description: >- + Optional. Regex to test the bucket name against. If empty, all + buckets match. type: string - description: The number of hybrid inspection requests processed within this job. - pendingCount: + GooglePrivacyDlpV2AwsAccountRegex: + id: GooglePrivacyDlpV2AwsAccountRegex + description: AWS account regex. + type: object + properties: + accountIdRegex: description: >- - The number of hybrid requests currently being processed. Only - populated when called via method `getDlpJob`. A burst of traffic may - cause hybrid inspect requests to be enqueued. Processing will take - place as quickly as possible, but resource limitations may impact - how long a request is enqueued for. - format: int64 + Optional. Regex to test the AWS account ID against. If empty, all + accounts match. type: string - abortedCount: - format: int64 + GooglePrivacyDlpV2OtherCloudSingleResourceReference: + id: GooglePrivacyDlpV2OtherCloudSingleResourceReference + description: Identifies a single resource, like a single Amazon S3 bucket. + type: object + properties: + amazonS3Bucket: + description: Amazon S3 bucket. + $ref: '#/components/schemas/GooglePrivacyDlpV2AmazonS3Bucket' + GooglePrivacyDlpV2AmazonS3Bucket: + id: GooglePrivacyDlpV2AmazonS3Bucket + description: Amazon S3 bucket. + type: object + properties: + awsAccount: + description: The AWS account. + $ref: '#/components/schemas/GooglePrivacyDlpV2AwsAccount' + bucketName: + description: Required. The bucket name. type: string - description: >- - The number of hybrid inspection requests aborted because the job ran - out of quota or was ended before they could be processed. - GooglePrivacyDlpV2CloudStorageDiscoveryTarget: + GooglePrivacyDlpV2AwsAccount: + id: GooglePrivacyDlpV2AwsAccount + description: AWS account. type: object - id: GooglePrivacyDlpV2CloudStorageDiscoveryTarget - description: Target used to match against for discovery with Cloud Storage buckets. properties: - disabled: - $ref: '#/components/schemas/GooglePrivacyDlpV2Disabled' - description: Optional. Disable profiling for buckets that match this filter. - generationCadence: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2DiscoveryCloudStorageGenerationCadence - description: >- - Optional. How often and when to update profiles. New buckets that - match both the filter and conditions are scanned as quickly as - possible depending on system capacity. - conditions: - description: >- - Optional. In addition to matching the filter, these conditions must - be true before a profile is generated. - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryFileStoreConditions' - filter: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryCloudStorageFilter' - description: >- - Required. The buckets the generation_cadence applies to. The first - target with a matching filter will be the one to apply to a bucket. - GooglePrivacyDlpV2Key: - id: GooglePrivacyDlpV2Key + accountId: + description: Required. AWS account ID. + type: string + GooglePrivacyDlpV2DiscoveryOtherCloudConditions: + id: GooglePrivacyDlpV2DiscoveryOtherCloudConditions + description: >- + Requirements that must be true before a resource is profiled for the + first time. type: object properties: - partitionId: - $ref: '#/components/schemas/GooglePrivacyDlpV2PartitionId' + minAge: description: >- - Entities are partitioned into subsets, currently identified by a - project ID and namespace ID. Queries are scoped to a single - partition. - path: + Minimum age a resource must be before Cloud DLP can profile it. + Value must be 1 hour or greater. + type: string + format: google-duration + amazonS3BucketConditions: + description: Amazon S3 bucket conditions. + $ref: '#/components/schemas/GooglePrivacyDlpV2AmazonS3BucketConditions' + GooglePrivacyDlpV2AmazonS3BucketConditions: + id: GooglePrivacyDlpV2AmazonS3BucketConditions + description: Amazon S3 bucket conditions. + type: object + properties: + bucketTypes: description: >- - The entity path. An entity path consists of one or more elements - composed of a kind and a string or numerical identifier, which - identify entities. The first element identifies a _root entity_, the - second element identifies a _child_ of the root entity, the third - element identifies a child of the second entity, and so forth. The - entities identified by all prefixes of the path are called the - element's _ancestors_. A path can never be empty, and a path can - have at most 100 elements. + Optional. Bucket types that should be profiled. Optional. Defaults + to TYPE_ALL_SUPPORTED if unspecified. + type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2PathElement' + type: string + enumDescriptions: + - Unused. + - All supported classes. + - A general purpose Amazon S3 bucket. + enum: + - TYPE_UNSPECIFIED + - TYPE_ALL_SUPPORTED + - TYPE_GENERAL_PURPOSE + objectStorageClasses: + description: >- + Optional. Object classes that should be profiled. Optional. Defaults + to ALL_SUPPORTED_CLASSES if unspecified. type: array + items: + type: string + enumDescriptions: + - Unused. + - All supported classes. + - Standard object class. + - Standard - infrequent access object class. + - Glacier - instant retrieval object class. + - Objects in the S3 Intelligent-Tiering access tiers. + enum: + - UNSPECIFIED + - ALL_SUPPORTED_CLASSES + - STANDARD + - STANDARD_INFREQUENT_ACCESS + - GLACIER_INSTANT_RETRIEVAL + - INTELLIGENT_TIERING + GooglePrivacyDlpV2DiscoveryOtherCloudGenerationCadence: + id: GooglePrivacyDlpV2DiscoveryOtherCloudGenerationCadence description: >- - A unique identifier for a Datastore entity. If a key's partition ID or - any of its path kinds or names are reserved/read-only, the key is - reserved/read-only. A reserved/read-only key is forbidden in certain - documented contexts. - GooglePrivacyDlpV2AllOtherDatabaseResources: + How often existing resources should have their profiles refreshed. New + resources are scanned as quickly as possible depending on system + capacity. type: object - properties: {} - description: Match database resources not covered by any other filter. - id: GooglePrivacyDlpV2AllOtherDatabaseResources - GooglePrivacyDlpV2FileSet: properties: - regexFileSet: - $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStorageRegexFileSet' - description: >- - The regex-filtered set of files to scan. Exactly one of `url` or - `regex_file_set` must be set. - url: + refreshFrequency: description: >- - The Cloud Storage url of the file(s) to scan, in the format - `gs:///`. Trailing wildcard in the path is allowed. If the url ends - in a trailing slash, the bucket or directory represented by the url - will be scanned non-recursively (content in sub-directories will not - be scanned). This means that `gs://mybucket/` is equivalent to - `gs://mybucket/*`, and `gs://mybucket/directory/` is equivalent to - `gs://mybucket/directory/*`. Exactly one of `url` or - `regex_file_set` must be set. + Optional. Frequency to update profiles regardless of whether the + underlying resource has changes. Defaults to never. type: string - description: Set of files to scan. - type: object - id: GooglePrivacyDlpV2FileSet - GooglePrivacyDlpV2HybridOptions: - id: GooglePrivacyDlpV2HybridOptions + enumDescriptions: + - Unspecified. + - After the data profile is created, it will never be updated. + - The data profile can be updated up to once every 24 hours. + - The data profile can be updated up to once every 30 days. Default. + enum: + - UPDATE_FREQUENCY_UNSPECIFIED + - UPDATE_FREQUENCY_NEVER + - UPDATE_FREQUENCY_DAILY + - UPDATE_FREQUENCY_MONTHLY + inspectTemplateModifiedCadence: + description: >- + Optional. Governs when to update data profiles when the inspection + rules defined by the `InspectTemplate` change. If not set, changing + the template will not cause a data profile to update. + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence + GooglePrivacyDlpV2VertexDatasetDiscoveryTarget: + id: GooglePrivacyDlpV2VertexDatasetDiscoveryTarget + description: Target used to match against for discovery with Vertex AI datasets. type: object properties: - description: - description: >- - A short description of where the data is coming from. Will be stored - once in the job. 256 max length. - type: string - labels: + filter: description: >- - To organize findings, these labels will be added to each finding. - Label keys must be between 1 and 63 characters long and must conform - to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. - Label values must be between 0 and 63 characters long and must - conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. - No more than 10 labels can be associated with a given finding. - Examples: * `"environment" : "production"` * `"pipeline" : "etl"` - additionalProperties: - type: string - type: object - tableOptions: - $ref: '#/components/schemas/GooglePrivacyDlpV2TableOptions' + Required. The datasets the discovery cadence applies to. The first + target with a matching filter will be the one to apply to a dataset. + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryVertexDatasetFilter' + conditions: description: >- - If the container is a table, additional information to make findings - meaningful such as the columns that are primary keys. - requiredFindingLabelKeys: - items: - type: string - type: array + In addition to matching the filter, these conditions must be true + before a profile is generated. + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DiscoveryVertexDatasetConditions + generationCadence: description: >- - These are labels that each inspection request must include within - their 'finding_labels' map. Request may contain others, but any - missing one of these will be rejected. Label keys must be between 1 - and 63 characters long and must conform to the following regular - expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. No more than 10 keys can - be required. + How often and when to update profiles. New datasets that match both + the filter and conditions are scanned as quickly as possible + depending on system capacity. + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DiscoveryVertexDatasetGenerationCadence + disabled: + description: Disable profiling for datasets that match this filter. + $ref: '#/components/schemas/GooglePrivacyDlpV2Disabled' + GooglePrivacyDlpV2DiscoveryVertexDatasetFilter: + id: GooglePrivacyDlpV2DiscoveryVertexDatasetFilter description: >- - Configuration to control jobs where the content being inspected is - outside of Google Cloud Platform. - GooglePrivacyDlpV2DeidentifyTemplate: + Determines what datasets will have profiles generated within an + organization or project. Includes the ability to filter by regular + expression patterns on project ID or dataset regex. + type: object properties: - description: - type: string - description: Short description (max 256 chars). - deidentifyConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyConfig' - description: The core content of the template. - updateTime: - type: string - readOnly: true - format: google-datetime - description: Output only. The last update timestamp of an inspectTemplate. - createTime: - type: string - readOnly: true - description: Output only. The creation timestamp of an inspectTemplate. - format: google-datetime - displayName: - description: Display name (max 256 chars). - type: string - name: - type: string - readOnly: true + collection: + description: A specific set of Vertex AI datasets for this filter to apply to. + $ref: '#/components/schemas/GooglePrivacyDlpV2VertexDatasetCollection' + vertexDatasetResourceReference: description: >- - Output only. The template name. The template will have one of the - following formats: - `projects/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID` OR - `organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID` - description: >- - DeidentifyTemplates contains instructions on how to de-identify content. - See - https://cloud.google.com/sensitive-data-protection/docs/concepts-templates - to learn more. - type: object - id: GooglePrivacyDlpV2DeidentifyTemplate - GooglePrivacyDlpV2HybridInspectResponse: - description: Quota exceeded errors will be thrown once quota has been met. - id: GooglePrivacyDlpV2HybridInspectResponse + The dataset resource to scan. Targets including this can only + include one target (the target with this dataset resource + reference). + $ref: >- + #/components/schemas/GooglePrivacyDlpV2VertexDatasetResourceReference + others: + description: >- + Catch-all. This should always be the last target in the list because + anything above it will apply first. Should only appear once in a + configuration. If none is specified, a default one will be added + automatically. + $ref: '#/components/schemas/GooglePrivacyDlpV2AllOtherResources' + GooglePrivacyDlpV2VertexDatasetCollection: + id: GooglePrivacyDlpV2VertexDatasetCollection + description: Match dataset resources using regex filters. type: object - properties: {} - GooglePrivacyDlpV2DeltaPresenceEstimationConfig: + properties: + vertexDatasetRegexes: + description: The regex used to filter dataset resources. + $ref: '#/components/schemas/GooglePrivacyDlpV2VertexDatasetRegexes' + GooglePrivacyDlpV2VertexDatasetRegexes: + id: GooglePrivacyDlpV2VertexDatasetRegexes description: >- - δ-presence metric, used to estimate how likely it is for an attacker to - figure out that one given individual appears in a de-identified dataset. - Similarly to the k-map metric, we cannot compute δ-presence exactly - without knowing the attack dataset, so we use a statistical model - instead. + A collection of regular expressions to determine what datasets to match + against. type: object properties: - auxiliaryTables: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2StatisticalTable' - type: array + patterns: description: >- - Several auxiliary tables can be used in the analysis. Each - custom_tag used to tag a quasi-identifiers field must appear in - exactly one field of one auxiliary table. - quasiIds: + Required. The group of regular expression patterns to match against + one or more datasets. Maximum of 100 entries. The sum of the lengths + of all regular expressions can't exceed 10 KiB. type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2QuasiId' + $ref: '#/components/schemas/GooglePrivacyDlpV2VertexDatasetRegex' + GooglePrivacyDlpV2VertexDatasetRegex: + id: GooglePrivacyDlpV2VertexDatasetRegex + description: A pattern to match against one or more dataset resources. + type: object + properties: + projectIdRegex: description: >- - Required. Fields considered to be quasi-identifiers. No two fields - can have the same tag. - regionCode: + For organizations, if unset, will match all projects. Has no effect + for configurations created within a project. type: string - description: >- - ISO 3166-1 alpha-2 region code to use in the statistical modeling. - Set if no column is tagged with a region-specific InfoType (like - US_ZIP_5) or a region code. - id: GooglePrivacyDlpV2DeltaPresenceEstimationConfig - GooglePrivacyDlpV2FieldId: + GooglePrivacyDlpV2VertexDatasetResourceReference: + id: GooglePrivacyDlpV2VertexDatasetResourceReference + description: Identifies a single Vertex AI dataset. type: object - description: General identifier of a data field in a storage service. properties: - name: - description: Name describing the field. + datasetResourceName: + description: >- + Required. The name of the dataset resource. If set within a + project-level configuration, the specified resource must be within + the project. type: string - id: GooglePrivacyDlpV2FieldId - GooglePrivacyDlpV2Connection: + GooglePrivacyDlpV2DiscoveryVertexDatasetConditions: + id: GooglePrivacyDlpV2DiscoveryVertexDatasetConditions + description: >- + Requirements that must be true before a dataset is profiled for the + first time. + type: object properties: - errors: - readOnly: true + createdAfter: description: >- - Output only. Set if status == ERROR, to provide additional details. - Will store the last 10 errors sorted with the most recent first. - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Error' - cloudSql: - $ref: '#/components/schemas/GooglePrivacyDlpV2CloudSqlProperties' - description: Connect to a Cloud SQL instance. - name: - readOnly: true + Vertex AI dataset must have been created after this date. Used to + avoid backfilling. + type: string + format: google-datetime + minAge: description: >- - Output only. Name of the connection: - `projects/{project}/locations/{location}/connections/{name}`. + Minimum age a Vertex AI dataset must have. If set, the value must be + 1 hour or greater. + type: string + format: google-duration + GooglePrivacyDlpV2DiscoveryVertexDatasetGenerationCadence: + id: GooglePrivacyDlpV2DiscoveryVertexDatasetGenerationCadence + description: >- + How often existing datasets should have their profiles refreshed. New + datasets are scanned as quickly as possible depending on system + capacity. + type: object + properties: + refreshFrequency: + description: >- + If you set this field, profiles are refreshed at this frequency + regardless of whether the underlying datasets have changed. Defaults + to never. type: string - state: - description: Required. The connection's state in its lifecycle. enumDescriptions: - - Unused - - >- - The DLP API automatically created this connection during an - initial scan, and it is awaiting full configuration by a user. - - A configured connection that has not encountered any errors. - - >- - A configured connection that encountered errors during its last - use. It will not be used again until it is set to AVAILABLE. If - the resolution requires external action, then the client must send - a request to set the status to AVAILABLE when the connection is - ready for use. If the resolution doesn't require external action, - then any changes to the connection properties will automatically - mark it as AVAILABLE. + - Unspecified. + - After the data profile is created, it will never be updated. + - The data profile can be updated up to once every 24 hours. + - The data profile can be updated up to once every 30 days. Default. enum: - - CONNECTION_STATE_UNSPECIFIED - - MISSING_CREDENTIALS - - AVAILABLE - - ERROR - type: string - id: GooglePrivacyDlpV2Connection + - UPDATE_FREQUENCY_UNSPECIFIED + - UPDATE_FREQUENCY_NEVER + - UPDATE_FREQUENCY_DAILY + - UPDATE_FREQUENCY_MONTHLY + inspectTemplateModifiedCadence: + description: >- + Governs when to update data profiles when the inspection rules + defined by the `InspectTemplate` change. If not set, changing the + template will not cause a data profile to be updated. + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence + GooglePrivacyDlpV2ProcessingLocation: + id: GooglePrivacyDlpV2ProcessingLocation + description: >- + Configure processing location for discovery and inspection. For example, + image OCR is only provided in limited regions but configuring + ProcessingLocation will redirect OCR to a location where OCR is + provided. type: object + properties: + imageFallbackLocation: + description: Image processing falls back using this configuration. + $ref: '#/components/schemas/GooglePrivacyDlpV2ImageFallbackLocation' + documentFallbackLocation: + description: Document processing falls back using this configuration. + $ref: '#/components/schemas/GooglePrivacyDlpV2DocumentFallbackLocation' + GooglePrivacyDlpV2ImageFallbackLocation: + id: GooglePrivacyDlpV2ImageFallbackLocation description: >- - A data connection to allow the DLP API to profile data in locations that - require additional configuration. - GooglePrivacyDlpV2BigQueryField: + Configure image processing to fall back to any of the following + processing options if image processing is unavailable in the original + request location. type: object - description: Message defining a field of a BigQuery table. properties: - field: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - description: Designated field in the BigQuery table. - table: - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' - description: Source table of the field. - id: GooglePrivacyDlpV2BigQueryField - GooglePrivacyDlpV2CharsToIgnore: + multiRegionProcessing: + description: >- + Processing occurs in a multi-region that contains the current region + if available. + $ref: '#/components/schemas/GooglePrivacyDlpV2MultiRegionProcessing' + globalProcessing: + description: Processing occurs in the global region. + $ref: '#/components/schemas/GooglePrivacyDlpV2GlobalProcessing' + GooglePrivacyDlpV2MultiRegionProcessing: + id: GooglePrivacyDlpV2MultiRegionProcessing + description: >- + Processing occurs in a multi-region that contains the current region if + available. + type: object + properties: {} + GooglePrivacyDlpV2GlobalProcessing: + id: GooglePrivacyDlpV2GlobalProcessing + description: Processing occurs in the global region. + type: object + properties: {} + GooglePrivacyDlpV2DocumentFallbackLocation: + id: GooglePrivacyDlpV2DocumentFallbackLocation + description: >- + Configure document processing to fall back to any of the following + processing options if document processing is unavailable in the original + request location. + type: object properties: - commonCharactersToIgnore: + multiRegionProcessing: description: >- - Common characters to not transform when masking. Useful to avoid - removing punctuation. - enumDescriptions: - - Unused. - - 0-9 - - A-Z - - a-z - - US Punctuation, one of !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~ - - Whitespace character, one of [ \t\n\x0B\f\r] - enum: - - COMMON_CHARS_TO_IGNORE_UNSPECIFIED - - NUMERIC - - ALPHA_UPPER_CASE - - ALPHA_LOWER_CASE - - PUNCTUATION - - WHITESPACE - type: string - charactersToSkip: - description: Characters to not transform when masking. + Processing occurs in a multi-region that contains the current region + if available. + $ref: '#/components/schemas/GooglePrivacyDlpV2MultiRegionProcessing' + globalProcessing: + description: Processing occurs in the global region. + $ref: '#/components/schemas/GooglePrivacyDlpV2GlobalProcessing' + GooglePrivacyDlpV2UpdateDiscoveryConfigRequest: + id: GooglePrivacyDlpV2UpdateDiscoveryConfigRequest + description: Request message for UpdateDiscoveryConfig. + type: object + properties: + discoveryConfig: + description: Required. New DiscoveryConfig value. + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + updateMask: + description: Mask to control which fields get updated. type: string - id: GooglePrivacyDlpV2CharsToIgnore - description: >- - Characters to skip when doing deidentification of a value. These will be - left alone and skipped. + format: google-fieldmask + GooglePrivacyDlpV2ListDiscoveryConfigsResponse: + id: GooglePrivacyDlpV2ListDiscoveryConfigsResponse + description: Response message for ListDiscoveryConfigs. type: object - GooglePrivacyDlpV2NumericalStatsResult: properties: - minValue: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - description: Minimum value appearing in the column. - quantileValues: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + discoveryConfigs: + description: List of configs, up to page_size in ListDiscoveryConfigsRequest. type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + nextPageToken: description: >- - List of 99 values that partition the set of field values into 100 - equal sized buckets. - maxValue: - description: Maximum value appearing in the column. - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - type: object - id: GooglePrivacyDlpV2NumericalStatsResult - description: Result of the numerical stats computation. - GooglePrivacyDlpV2OtherCloudDiscoveryTarget: - id: GooglePrivacyDlpV2OtherCloudDiscoveryTarget + If the next page is available then this value is the next page token + to be used in the following ListDiscoveryConfigs request. + type: string + GooglePrivacyDlpV2CreateDlpJobRequest: + id: GooglePrivacyDlpV2CreateDlpJobRequest description: >- - Target used to match against for discovery of resources from other - clouds. An [AWS connector in Security Command Center - (Enterprise](https://cloud.google.com/security-command-center/docs/connect-scc-to-aws) - is required to use this feature. + Request message for CreateDlpJobRequest. Used to initiate long running + jobs such as calculating risk metrics or inspecting Google Cloud + Storage. type: object properties: - generationCadence: - description: >- - How often and when to update data profiles. New resources that match - both the filter and conditions are scanned as quickly as possible - depending on system capacity. - $ref: >- - #/components/schemas/GooglePrivacyDlpV2DiscoveryOtherCloudGenerationCadence - filter: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryOtherCloudFilter' - description: >- - Required. The resources that the discovery cadence applies to. The - first target with a matching filter will be the one to apply to a - resource. - dataSourceType: - $ref: '#/components/schemas/GooglePrivacyDlpV2DataSourceType' + inspectJob: + description: An inspection job scans a storage repository for InfoTypes. + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectJobConfig' + riskJob: description: >- - Required. The type of data profiles generated by this discovery - target. Supported values are: * aws/s3/bucket - conditions: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryOtherCloudConditions' + A risk analysis job calculates re-identification risk metrics for a + BigQuery table. + $ref: '#/components/schemas/GooglePrivacyDlpV2RiskAnalysisJobConfig' + jobId: description: >- - Optional. In addition to matching the filter, these conditions must - be true before a profile is generated. - disabled: - $ref: '#/components/schemas/GooglePrivacyDlpV2Disabled' - description: Disable profiling for resources that match this filter. + The job id can contain uppercase and lowercase letters, numbers, and + hyphens; that is, it must match the regular expression: + `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty + to allow the system to generate one. + type: string + locationId: + description: Deprecated. This field has no effect. + type: string + GooglePrivacyDlpV2ListDlpJobsResponse: + id: GooglePrivacyDlpV2ListDlpJobsResponse + description: The response message for listing DLP jobs. + type: object + properties: + jobs: + description: A list of DlpJobs that matches the specified filter in the request. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' + nextPageToken: + description: The standard List next-page token. + type: string + GooglePrivacyDlpV2CancelDlpJobRequest: + id: GooglePrivacyDlpV2CancelDlpJobRequest + description: The request message for canceling a DLP job. + type: object + properties: {} GooglePrivacyDlpV2CreateStoredInfoTypeRequest: id: GooglePrivacyDlpV2CreateStoredInfoTypeRequest description: Request message for CreateStoredInfoType. + type: object properties: - locationId: - type: string - description: Deprecated. This field has no effect. config: description: Required. Configuration of the storedInfoType to create. $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeConfig' storedInfoTypeId: - type: string description: >- The storedInfoType ID can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty to allow the system to generate one. + type: string + locationId: + description: Deprecated. This field has no effect. + type: string + GooglePrivacyDlpV2StoredInfoTypeConfig: + id: GooglePrivacyDlpV2StoredInfoTypeConfig + description: >- + Configuration for stored infoTypes. All fields and subfield are provided + by the user. For more information, see + https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. type: object - GooglePrivacyDlpV2WordList: properties: - words: + displayName: + description: Display name of the StoredInfoType (max 256 characters). + type: string + description: + description: Description of the StoredInfoType (max 256 characters). + type: string + largeCustomDictionary: + description: >- + StoredInfoType where findings are defined by a dictionary of + phrases. + $ref: '#/components/schemas/GooglePrivacyDlpV2LargeCustomDictionaryConfig' + dictionary: + description: Store dictionary-based CustomInfoType. + $ref: '#/components/schemas/GooglePrivacyDlpV2Dictionary' + regex: + description: Store regular expression-based StoredInfoType. + $ref: '#/components/schemas/GooglePrivacyDlpV2Regex' + GooglePrivacyDlpV2LargeCustomDictionaryConfig: + id: GooglePrivacyDlpV2LargeCustomDictionaryConfig + description: >- + Configuration for a custom dictionary created from a data source of any + size up to the maximum size defined in the + [limits](https://cloud.google.com/sensitive-data-protection/limits) + page. The artifacts of dictionary creation are stored in the specified + Cloud Storage location. Consider using `CustomInfoType.Dictionary` for + smaller dictionaries that satisfy the size requirements. + type: object + properties: + outputPath: + description: >- + Location to store dictionary artifacts in Cloud Storage. These files + will only be accessible by project owners and the DLP API. If any of + these artifacts are modified, the dictionary is considered invalid + and can no longer be used. + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStoragePath' + cloudStorageFileSet: + description: >- + Set of files containing newline-delimited lists of dictionary + phrases. + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStorageFileSet' + bigQueryField: + description: >- + Field in a BigQuery table where each cell represents a dictionary + phrase. + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryField' + GooglePrivacyDlpV2CloudStorageFileSet: + id: GooglePrivacyDlpV2CloudStorageFileSet + description: Message representing a set of files in Cloud Storage. + type: object + properties: + url: + description: >- + The url, in the format `gs:///`. Trailing wildcard in the path is + allowed. + type: string + GooglePrivacyDlpV2BigQueryField: + id: GooglePrivacyDlpV2BigQueryField + description: Message defining a field of a BigQuery table. + type: object + properties: + table: + description: Source table of the field. + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + field: + description: Designated field in the BigQuery table. + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + GooglePrivacyDlpV2StoredInfoType: + id: GooglePrivacyDlpV2StoredInfoType + description: >- + StoredInfoType resource message that contains information about the + current version and any pending updates. + type: object + properties: + name: + description: Resource name. + type: string + currentVersion: + description: Current version of the stored info type. + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeVersion' + pendingVersions: + description: >- + Pending versions of the stored info type. Empty if no versions are + pending. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeVersion' + GooglePrivacyDlpV2StoredInfoTypeVersion: + id: GooglePrivacyDlpV2StoredInfoTypeVersion + description: >- + Version of a StoredInfoType, including the configuration used to build + it, create timestamp, and current state. + type: object + properties: + config: + description: StoredInfoType configuration. + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeConfig' + createTime: + description: >- + Create timestamp of the version. Read-only, determined by the system + when the version is created. + type: string + format: google-datetime + state: + description: >- + Stored info type version state. Read-only, updated by the system + during dictionary creation. + type: string + enumDescriptions: + - Unused + - StoredInfoType version is being created. + - StoredInfoType version is ready for use. + - >- + StoredInfoType creation failed. All relevant error messages are + returned in the `StoredInfoTypeVersion` message. + - >- + StoredInfoType is no longer valid because artifacts stored in + user-controlled storage were modified. To fix an invalid + StoredInfoType, use the `UpdateStoredInfoType` method to create a + new version. + enum: + - STORED_INFO_TYPE_STATE_UNSPECIFIED + - PENDING + - READY + - FAILED + - INVALID + errors: + description: >- + Errors that occurred when creating this storedInfoType version, or + anomalies detected in the storedInfoType data that render it + unusable. Only the five most recent errors will be displayed, with + the most recent error appearing first. For example, some of the data + for stored custom dictionaries is put in the user's Cloud Storage + bucket, and if this data is modified or deleted by the user or + another system, the dictionary becomes invalid. If any errors occur, + fix the problem indicated by the error message and use the + UpdateStoredInfoType API method to create another version of the + storedInfoType to continue using it, reusing the same `config` if it + was not the source of the error. type: array items: - type: string - description: >- - Words or phrases defining the dictionary. The dictionary must - contain at least one phrase and every phrase must contain at least 2 - characters that are letters or digits. [required] + $ref: '#/components/schemas/GooglePrivacyDlpV2Error' + stats: + description: Statistics about this storedInfoType version. + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeStats' + GooglePrivacyDlpV2StoredInfoTypeStats: + id: GooglePrivacyDlpV2StoredInfoTypeStats + description: Statistics for a StoredInfoType. type: object - id: GooglePrivacyDlpV2WordList - description: Message defining a list of words or phrases to search for in the data. - GooglePrivacyDlpV2TagValue: - description: A value of a tag. - id: GooglePrivacyDlpV2TagValue properties: - namespacedValue: - type: string + largeCustomDictionary: description: >- - The namespaced name for the tag value to attach to resources. Must - be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, - for example, "123456/environment/prod". + StoredInfoType where findings are defined by a dictionary of + phrases. + $ref: '#/components/schemas/GooglePrivacyDlpV2LargeCustomDictionaryStats' + GooglePrivacyDlpV2LargeCustomDictionaryStats: + id: GooglePrivacyDlpV2LargeCustomDictionaryStats + description: Summary statistics of a custom dictionary. type: object - GooglePrivacyDlpV2DatabaseResourceReference: - id: GooglePrivacyDlpV2DatabaseResourceReference properties: - projectId: + approxNumPhrases: + description: Approximate number of distinct phrases in the dictionary. type: string + format: int64 + GooglePrivacyDlpV2UpdateStoredInfoTypeRequest: + id: GooglePrivacyDlpV2UpdateStoredInfoTypeRequest + description: Request message for UpdateStoredInfoType. + type: object + properties: + config: description: >- - Required. If within a project-level config, then this must match the - config's project ID. - databaseResource: + Updated configuration for the storedInfoType. If not provided, a new + version of the storedInfoType will be created with the existing + configuration. + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeConfig' + updateMask: + description: Mask to control which fields get updated. type: string + format: google-fieldmask + GooglePrivacyDlpV2ListStoredInfoTypesResponse: + id: GooglePrivacyDlpV2ListStoredInfoTypesResponse + description: Response message for ListStoredInfoTypes. + type: object + properties: + storedInfoTypes: description: >- - Required. Name of a database resource, for example, a table within - the database. - database: - type: string - description: Required. Name of a database within the instance. - instance: + List of storedInfoTypes, up to page_size in + ListStoredInfoTypesRequest. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + nextPageToken: description: >- - Required. The instance where this resource is located. For example: - Cloud SQL instance ID. + If the next page is available then the next page token to be used in + the following ListStoredInfoTypes request. type: string - description: Identifies a single database resource, like a table within a database. + GooglePrivacyDlpV2ListProjectDataProfilesResponse: + id: GooglePrivacyDlpV2ListProjectDataProfilesResponse + description: List of profiles generated for a given organization or project. type: object - GooglePrivacyDlpV2QuasiIdentifierField: - description: >- - A quasi-identifier column has a custom_tag, used to know which column in - the data corresponds to which column in the statistical model. - id: GooglePrivacyDlpV2QuasiIdentifierField properties: - field: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - description: Identifies the column. - customTag: - description: >- - A column can be tagged with a custom tag. In this case, the user - must indicate an auxiliary table that contains statistical - information on the possible values of this column (below). + projectDataProfiles: + description: List of data profiles. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2ProjectDataProfile' + nextPageToken: + description: The next page token. type: string - type: object - GooglePrivacyDlpV2Export: - id: GooglePrivacyDlpV2Export - type: object + GooglePrivacyDlpV2ProjectDataProfile: + id: GooglePrivacyDlpV2ProjectDataProfile description: >- - If set, the detailed data profiles will be persisted to the location of - your choice whenever updated. - properties: - profileTable: - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' - description: >- - Store all table and column profiles in an existing table or a new - table in an existing dataset. Each re-generation will result in new - rows in BigQuery. Data is inserted using [streaming - insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) - and so data may be in the buffer for a period of time after the - profile has finished. The Pub/Sub notification is sent before the - streaming buffer is guaranteed to be written, so data may not be - instantly visible to queries by the time your topic receives the - Pub/Sub notification. - GooglePrivacyDlpV2PartitionId: - id: GooglePrivacyDlpV2PartitionId + An aggregated profile for this project, based on the resources profiled + within it. type: object - description: >- - Datastore partition ID. A partition ID identifies a grouping of - entities. The grouping is always by project and namespace, however the - namespace ID may be empty. A partition ID contains several dimensions: - project ID and namespace ID. properties: + name: + description: The resource name of the profile. + type: string projectId: + description: Project ID or account that was profiled. type: string - description: The ID of the project to which the entities belong. - namespaceId: + profileLastGenerated: + description: The last time the profile was generated. type: string - description: If not empty, the ID of the namespace to which the entities belong. - GooglePrivacyDlpV2CloudStoragePath: - type: object - properties: - path: - description: >- - A URL representing a file or path (no wildcards) in Cloud Storage. - Example: `gs://[BUCKET_NAME]/dictionary.txt` + format: google-datetime + sensitivityScore: + description: The sensitivity score of this project. + $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' + dataRiskLevel: + description: The data risk level of this project. + $ref: '#/components/schemas/GooglePrivacyDlpV2DataRiskLevel' + profileStatus: + description: Success or error status of the last attempt to profile the project. + $ref: '#/components/schemas/GooglePrivacyDlpV2ProfileStatus' + tableDataProfileCount: + description: The number of table data profiles generated for this project. type: string - id: GooglePrivacyDlpV2CloudStoragePath - description: Message representing a single file or path in Cloud Storage. - GooglePrivacyDlpV2DocumentLocation: - description: Location of a finding within a document. - properties: - fileOffset: format: int64 + fileStoreDataProfileCount: + description: The number of file store data profiles generated for this project. type: string - description: >- - Offset of the line, from the beginning of the file, where the - finding is located. - type: object - id: GooglePrivacyDlpV2DocumentLocation - GooglePrivacyDlpV2BigQueryTableTypes: - type: object - properties: - types: - type: array - description: A set of BigQuery table types. - items: - type: string - enum: - - BIG_QUERY_TABLE_TYPE_UNSPECIFIED - - BIG_QUERY_TABLE_TYPE_TABLE - - BIG_QUERY_TABLE_TYPE_EXTERNAL_BIG_LAKE - - BIG_QUERY_TABLE_TYPE_SNAPSHOT - enumDescriptions: - - Unused. - - A normal BigQuery table. - - A table that references data stored in Cloud Storage. - - A snapshot of a BigQuery table. - description: The types of BigQuery tables supported by Cloud DLP. - id: GooglePrivacyDlpV2BigQueryTableTypes - GooglePrivacyDlpV2RedactImageResponse: - description: Results of redacting an image. - id: GooglePrivacyDlpV2RedactImageResponse + format: int64 + GooglePrivacyDlpV2DataRiskLevel: + id: GooglePrivacyDlpV2DataRiskLevel + description: >- + Score is a summary of all elements in the data profile. A higher number + means more risk. type: object properties: - extractedText: - description: >- - If an image was being inspected and the InspectConfig's - include_quote was set to true, then this field will include all - text, if any, that was found in the image. - type: string - redactedImage: - description: The redacted image. The type will be the same as the original image. + score: + description: The score applied to the resource. type: string - format: byte - inspectResult: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectResult' - description: >- - The findings. Populated when include_findings in the request is - true. - GooglePrivacyDlpV2DiscoveryOtherCloudFilter: - description: >- - Determines which resources from the other cloud will have profiles - generated. Includes the ability to filter by resource names. + enumDescriptions: + - Unused. + - >- + Low risk - Lower indication of sensitive data that appears to have + additional access restrictions in place or no indication of + sensitive data found. + - Unable to determine risk. + - >- + Medium risk - Sensitive data may be present but additional access + or fine grain access restrictions appear to be present. Consider + limiting access even further or transform data to mask. + - >- + High risk – SPII may be present. Access controls may include + public ACLs. Exfiltration of data may lead to user data loss. + Re-identification of users may be possible. Consider limiting + usage and or removing SPII. + enum: + - RISK_SCORE_UNSPECIFIED + - RISK_LOW + - RISK_UNKNOWN + - RISK_MODERATE + - RISK_HIGH + GooglePrivacyDlpV2ProfileStatus: + id: GooglePrivacyDlpV2ProfileStatus + description: Success or errors for the profile generation. type: object properties: - others: - $ref: '#/components/schemas/GooglePrivacyDlpV2AllOtherResources' - description: >- - Optional. Catch-all. This should always be the last target in the - list because anything above it will apply first. Should only appear - once in a configuration. If none is specified, a default one will be - added automatically. - collection: - $ref: '#/components/schemas/GooglePrivacyDlpV2OtherCloudResourceCollection' - description: A collection of resources for this filter to apply to. - singleResource: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2OtherCloudSingleResourceReference - description: >- - The resource to scan. Configs using this filter can only have one - target (the target with this single resource reference). - id: GooglePrivacyDlpV2DiscoveryOtherCloudFilter - GooglePrivacyDlpV2KMapEstimationQuasiIdValues: - description: A tuple of values for the quasi-identifier columns. + status: + description: >- + Profiling status code and optional message. The `status.code` value + is 0 (default value) for OK. + $ref: '#/components/schemas/GoogleRpcStatus' + timestamp: + description: Time when the profile generation status was updated + type: string + format: google-datetime + GooglePrivacyDlpV2ListTableDataProfilesResponse: + id: GooglePrivacyDlpV2ListTableDataProfilesResponse + description: List of profiles generated for a given organization or project. type: object properties: - quasiIdsValues: + tableDataProfiles: + description: List of data profiles. type: array - description: The quasi-identifier values. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - estimatedAnonymity: - type: string - description: The estimated anonymity for these quasi-identifier values. - format: int64 - id: GooglePrivacyDlpV2KMapEstimationQuasiIdValues - GooglePrivacyDlpV2UpdateStoredInfoTypeRequest: - id: GooglePrivacyDlpV2UpdateStoredInfoTypeRequest - properties: - updateMask: - format: google-fieldmask + $ref: '#/components/schemas/GooglePrivacyDlpV2TableDataProfile' + nextPageToken: + description: The next page token. type: string - description: Mask to control which fields get updated. - config: - description: >- - Updated configuration for the storedInfoType. If not provided, a new - version of the storedInfoType will be created with the existing - configuration. - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeConfig' - description: Request message for UpdateStoredInfoType. - type: object - GooglePrivacyDlpV2FileClusterSummary: - id: GooglePrivacyDlpV2FileClusterSummary + GooglePrivacyDlpV2TableDataProfile: + id: GooglePrivacyDlpV2TableDataProfile + description: The profile for a scanned table. type: object - description: The file cluster summary. properties: - fileExtensionsSeen: - description: >- - A sample of file types seen in this cluster. Empty if no files were - seen. File extensions can be derived from the file name or the file - content. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FileExtensionInfo' - type: array - sensitivityScore: - description: >- - The sensitivity score of this cluster. The score will be - SENSITIVITY_LOW if nothing has been scanned. - $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' - fileClusterType: - $ref: '#/components/schemas/GooglePrivacyDlpV2FileClusterType' - description: The file cluster type. - noFilesExist: - type: boolean - description: >- - True if no files exist in this cluster. If the bucket had more files - than could be listed, this will be false even if no files for this - cluster were seen and file_extensions_seen is empty. - dataRiskLevel: + name: + description: The name of the profile. + type: string + dataSourceType: + description: The resource type that was profiled. + $ref: '#/components/schemas/GooglePrivacyDlpV2DataSourceType' + projectDataProfile: + description: The resource name of the project data profile for this table. + type: string + datasetProjectId: + description: The Google Cloud project ID that owns the resource. + type: string + datasetLocation: description: >- - The data risk level of this cluster. RISK_LOW if nothing has been - scanned. - $ref: '#/components/schemas/GooglePrivacyDlpV2DataRiskLevel' - fileStoreInfoTypeSummaries: - description: InfoTypes detected in this cluster. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreInfoTypeSummary' - type: array - fileExtensionsScanned: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FileExtensionInfo' - type: array + If supported, the location where the dataset's data is stored. See + https://cloud.google.com/bigquery/docs/locations for supported + locations. + type: string + datasetId: + description: If the resource is BigQuery, the dataset ID. + type: string + tableId: + description: The table ID. + type: string + fullResource: description: >- - A sample of file types scanned in this cluster. Empty if no files - were scanned. File extensions can be derived from the file name or - the file content. - errors: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Error' + The Cloud Asset Inventory resource that was profiled in order to + generate this TableDataProfile. + https://cloud.google.com/apis/design/resource_names#full_resource_name + type: string + profileStatus: description: >- - A list of errors detected while scanning this cluster. The list is - truncated to 10 per cluster. - type: array - GooglePrivacyDlpV2StoredInfoTypeVersion: - type: object - properties: + Success or error status from the most recent profile generation + attempt. May be empty if the profile is still being generated. + $ref: '#/components/schemas/GooglePrivacyDlpV2ProfileStatus' state: description: >- - Stored info type version state. Read-only, updated by the system - during dictionary creation. - enum: - - STORED_INFO_TYPE_STATE_UNSPECIFIED - - PENDING - - READY - - FAILED - - INVALID + State of a profile. This will always be set to DONE when the table + data profile is written to another service like BigQuery or Pub/Sub. type: string enumDescriptions: - - Unused - - StoredInfoType version is being created. - - StoredInfoType version is ready for use. + - Unused. - >- - StoredInfoType creation failed. All relevant error messages are - returned in the `StoredInfoTypeVersion` message. + The profile is currently running. Once a profile has finished it + will transition to DONE. - >- - StoredInfoType is no longer valid because artifacts stored in - user-controlled storage were modified. To fix an invalid - StoredInfoType, use the `UpdateStoredInfoType` method to create a - new version. - errors: + The profile is no longer generating. If profile_status.status.code + is 0, the profile succeeded, otherwise, it failed. + enum: + - STATE_UNSPECIFIED + - RUNNING + - DONE + sensitivityScore: + description: The sensitivity score of this table. + $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' + dataRiskLevel: + description: The data risk level of this table. + $ref: '#/components/schemas/GooglePrivacyDlpV2DataRiskLevel' + predictedInfoTypes: + description: The infoTypes predicted from this table's data. type: array - description: >- - Errors that occurred when creating this storedInfoType version, or - anomalies detected in the storedInfoType data that render it - unusable. Only the five most recent errors will be displayed, with - the most recent error appearing first. For example, some of the data - for stored custom dictionaries is put in the user's Cloud Storage - bucket, and if this data is modified or deleted by the user or - another system, the dictionary becomes invalid. If any errors occur, - fix the problem indicated by the error message and use the - UpdateStoredInfoType API method to create another version of the - storedInfoType to continue using it, reusing the same `config` if it - was not the source of the error. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Error' - stats: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeStats' - description: Statistics about this storedInfoType version. - createTime: - format: google-datetime - description: >- - Create timestamp of the version. Read-only, determined by the system - when the version is created. - type: string - config: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeConfig' - description: StoredInfoType configuration. - id: GooglePrivacyDlpV2StoredInfoTypeVersion - description: >- - Version of a StoredInfoType, including the configuration used to build - it, create timestamp, and current state. - GooglePrivacyDlpV2Deidentify: - id: GooglePrivacyDlpV2Deidentify - type: object - description: >- - Create a de-identified copy of the requested table or files. A - TransformationDetail will be created for each transformation. If any - rows in BigQuery are skipped during de-identification (transformation - errors or row size exceeds BigQuery insert API limits) they are placed - in the failure output table. If the original row exceeds the BigQuery - insert API limit it will be truncated when written to the failure output - table. The failure output table can be set in the - action.deidentify.output.big_query_output.deidentified_failure_output_table - field, if no table is set, a table will be automatically created in the - same project and dataset as the original table. Compatible with: Inspect - properties: - transformationConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationConfig' - description: >- - User specified deidentify templates and configs for structured, - unstructured, and image files. - fileTypesToTransform: items: - type: string - enum: - - FILE_TYPE_UNSPECIFIED - - BINARY_FILE - - TEXT_FILE - - IMAGE - - WORD - - PDF - - AVRO - - CSV - - TSV - - POWERPOINT - - EXCEL - enumDescriptions: - - Includes all files. - - >- - Includes all file extensions not covered by another entry. - Binary scanning attempts to convert the content of the file to - utf_8 to scan the file. If you wish to avoid this fall back, - specify one or more of the other file types in your storage - scan. - - >- - Included file extensions: asc,asp, aspx, brf, c, cc,cfm, cgi, - cpp, csv, cxx, c++, cs, css, dart, dat, dot, eml,, epbub, ged, - go, h, hh, hpp, hxx, h++, hs, html, htm, mkd, markdown, m, ml, - mli, perl, pl, plist, pm, php, phtml, pht, properties, py, pyw, - rb, rbw, rs, rss, rc, scala, sh, sql, swift, tex, shtml, shtm, - xhtml, lhs, ics, ini, java, js, json, jsonl, kix, kml, ocaml, - md, txt, text, tsv, vb, vcard, vcs, wml, xcodeproj, xml, xsl, - xsd, yml, yaml. - - >- - Included file extensions: bmp, gif, jpg, jpeg, jpe, png. Setting - bytes_limit_per_file or bytes_limit_per_file_percent has no - effect on image files. Image inspection is restricted to the - `global`, `us`, `asia`, and `europe` regions. - - >- - Microsoft Word files larger than 30 MB will be scanned as binary - files. Included file extensions: docx, dotx, docm, dotm. Setting - `bytes_limit_per_file` or `bytes_limit_per_file_percent` has no - effect on Word files. - - >- - PDF files larger than 30 MB will be scanned as binary files. - Included file extensions: pdf. Setting `bytes_limit_per_file` or - `bytes_limit_per_file_percent` has no effect on PDF files. - - 'Included file extensions: avro' - - 'Included file extensions: csv' - - 'Included file extensions: tsv' - - >- - Microsoft PowerPoint files larger than 30 MB will be scanned as - binary files. Included file extensions: pptx, pptm, potx, potm, - pot. Setting `bytes_limit_per_file` or - `bytes_limit_per_file_percent` has no effect on PowerPoint - files. - - >- - Microsoft Excel files larger than 30 MB will be scanned as - binary files. Included file extensions: xlsx, xlsm, xltx, xltm. - Setting `bytes_limit_per_file` or `bytes_limit_per_file_percent` - has no effect on Excel files. - description: >- - List of user-specified file type groups to transform. If specified, - only the files with these file types will be transformed. If empty, - all supported files will be transformed. Supported types may be - automatically added over time. If a file type is set in this field - that isn't supported by the Deidentify action then the job will fail - and will not be successfully created/started. Currently the only - file types supported are: IMAGES, TEXT_FILES, CSV, TSV. + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeSummary' + otherInfoTypes: + description: Other infoTypes found in this table's data. type: array - transformationDetailsStorageConfig: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2TransformationDetailsStorageConfig + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2OtherInfoTypeSummary' + configSnapshot: + description: The snapshot of the configurations used to generate the profile. + $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileConfigSnapshot' + lastModifiedTime: + description: The time when this table was last modified + type: string + format: google-datetime + expirationTime: + description: Optional. The time when this table expires. + type: string + format: google-datetime + scannedColumnCount: + description: The number of columns profiled in the table. + type: string + format: int64 + failedColumnCount: + description: The number of columns skipped in the table because of an error. + type: string + format: int64 + tableSizeBytes: + description: The size of the table when the profile was generated. + type: string + format: int64 + rowCount: description: >- - Config for storing transformation details. This is separate from the - de-identified content, and contains metadata about the successful - transformations and/or failures that occurred while de-identifying. - This needs to be set in order for users to access information about - the status of each transformation (see TransformationDetails message - for more information about what is noted). - cloudStorageOutput: + Number of rows in the table when the profile was generated. This + will not be populated for BigLake tables. + type: string + format: int64 + encryptionStatus: + description: How the table is encrypted. + type: string + enumDescriptions: + - Unused. + - Google manages server-side encryption keys on your behalf. + - Customer provides the key. + enum: + - ENCRYPTION_STATUS_UNSPECIFIED + - ENCRYPTION_GOOGLE_MANAGED + - ENCRYPTION_CUSTOMER_MANAGED + resourceVisibility: + description: How broadly a resource has been shared. + type: string + enumDescriptions: + - Unused. + - Visible to any user. + - >- + May contain public items. For example, if a Cloud Storage bucket + has uniform bucket level access disabled, some objects inside it + may be public, but none are known yet. + - Visible only to specific users. + enum: + - RESOURCE_VISIBILITY_UNSPECIFIED + - RESOURCE_VISIBILITY_PUBLIC + - RESOURCE_VISIBILITY_INCONCLUSIVE + - RESOURCE_VISIBILITY_RESTRICTED + profileLastGenerated: + description: The last time the profile was generated. type: string + format: google-datetime + resourceLabels: description: >- - Required. User settable Cloud Storage bucket and folders to store - de-identified files. This field must be set for Cloud Storage - deidentification. The output Cloud Storage bucket must be different - from the input bucket. De-identified files will overwrite files in - the output path. Form of: gs://bucket/folder/ or gs://bucket - GooglePrivacyDlpV2ListInfoTypesResponse: - id: GooglePrivacyDlpV2ListInfoTypesResponse - properties: - infoTypes: - description: Set of sensitive infoTypes. + The labels applied to the resource at the time the profile was + generated. + type: object + additionalProperties: + type: string + createTime: + description: The time at which the table was created. + type: string + format: google-datetime + sampleFindingsTable: + description: The BigQuery table to which the sample findings are written. + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + tags: + description: >- + The tags attached to the table, including any tags attached during + profiling. Because tags are attached to Cloud SQL instances rather + than Cloud SQL tables, this field is empty for Cloud SQL table + profiles. type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeDescription' - description: Response to the ListInfoTypes request. - type: object - GooglePrivacyDlpV2InspectionRuleSet: - id: GooglePrivacyDlpV2InspectionRuleSet - description: >- - Rule set for modifying a set of infoTypes to alter behavior under - certain circumstances, depending on the specific details of the rules - within the set. - type: object - properties: - rules: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectionRule' - description: >- - Set of rules to be applied to infoTypes. The rules are applied in - order. + $ref: '#/components/schemas/GooglePrivacyDlpV2Tag' + relatedResources: + description: Resources related to this profile. type: array - infoTypes: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2RelatedResource' + domains: + description: Domains associated with the profile. type: array - description: List of infoTypes this rule set is applied to. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - GooglePrivacyDlpV2TransientCryptoKey: - properties: - name: - type: string - description: >- - Required. Name of the key. This is an arbitrary string used to - differentiate different keys. A unique key is generated per name: - two separate `TransientCryptoKey` protos share the same generated - key if their names are the same. When the data crypto key is - generated, this name is not used in any way (repeating the api call - will result in a different key being generated). - id: GooglePrivacyDlpV2TransientCryptoKey - description: >- - Use this to have a random data crypto key generated. It will be - discarded after the request finishes. - type: object - GooglePrivacyDlpV2QuasiIdField: + $ref: '#/components/schemas/GooglePrivacyDlpV2Domain' + GooglePrivacyDlpV2InfoTypeSummary: + id: GooglePrivacyDlpV2InfoTypeSummary + description: The infoType details for this column. type: object properties: - customTag: - type: string - description: A auxiliary field. - field: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - description: Identifies the column. - id: GooglePrivacyDlpV2QuasiIdField - description: >- - A quasi-identifier column has a custom_tag, used to know which column in - the data corresponds to which column in the statistical model. - GooglePrivacyDlpV2AllOtherResources: - description: Match discovery resources not covered by any other filter. - type: object - properties: {} - id: GooglePrivacyDlpV2AllOtherResources - GooglePrivacyDlpV2InfoTypeLimit: - description: >- - Max findings configuration per infoType, per content item or long - running DlpJob. - id: GooglePrivacyDlpV2InfoTypeLimit + infoType: + description: The infoType. + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + estimatedPrevalence: + description: Not populated for predicted infotypes. + deprecated: true + type: integer + format: int32 + GooglePrivacyDlpV2OtherInfoTypeSummary: + id: GooglePrivacyDlpV2OtherInfoTypeSummary + description: Infotype details for other infoTypes found within a column. type: object properties: - maxFindings: - format: int32 - description: Max findings limit for the given infoType. - type: integer infoType: + description: The other infoType. $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + estimatedPrevalence: description: >- - Type of information the findings limit applies to. Only one limit - per info_type should be provided. If InfoTypeLimit does not have an - info_type, the DLP API applies the limit against all info_types that - are found but not specified in another InfoTypeLimit. - GooglePrivacyDlpV2InfoTypeTransformations: + Approximate percentage of non-null rows that contained data detected + by this infotype. + type: integer + format: int32 + excludedFromAnalysis: + description: >- + Whether this infoType was excluded from sensitivity and risk + analysis due to factors such as low prevalence (subject to change). + type: boolean + GooglePrivacyDlpV2DataProfileConfigSnapshot: + id: GooglePrivacyDlpV2DataProfileConfigSnapshot + description: Snapshot of the configurations used to generate the profile. type: object properties: - transformations: + inspectConfig: description: >- - Required. Transformation for each infoType. Cannot specify more than - one for a given infoType. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeTransformation' - type: array + A copy of the inspection config used to generate this profile. This + is a copy of the inspect_template specified in + `DataProfileJobConfig`. + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' + dataProfileJob: + description: >- + A copy of the configuration used to generate this profile. This is + deprecated, and the DiscoveryConfig field is preferred moving + forward. DataProfileJobConfig will still be written here for + Discovery in BigQuery for backwards compatibility, but will not be + updated with new fields, while DiscoveryConfig will. + deprecated: true + $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileJobConfig' + discoveryConfig: + description: A copy of the configuration used to generate this profile. + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + inspectTemplateName: + description: Name of the inspection template used to generate this profile + type: string + inspectTemplateModifiedTime: + description: Timestamp when the template was modified + type: string + format: google-datetime + GooglePrivacyDlpV2DataProfileJobConfig: + id: GooglePrivacyDlpV2DataProfileJobConfig description: >- - A type of transformation that will scan unstructured text and apply - various `PrimitiveTransformation`s to each finding, where the - transformation is applied to only values that were identified as a - specific info_type. - id: GooglePrivacyDlpV2InfoTypeTransformations - GooglePrivacyDlpV2UpdateInspectTemplateRequest: - description: Request message for UpdateInspectTemplate. + Configuration for setting up a job to scan resources for profile + generation. Only one data profile configuration may exist per + organization, folder, or project. The generated data profiles are + retained according to the [data retention policy] + (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). + type: object + properties: + location: + description: The data to scan. + $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileLocation' + projectId: + description: >- + The project that will run the scan. The DLP service account that + exists within this project must have access to all resources that + are profiled, and the DLP API must be enabled. + type: string + otherCloudStartingLocation: + description: Must be set only when scanning other clouds. + $ref: >- + #/components/schemas/GooglePrivacyDlpV2OtherCloudDiscoveryStartingLocation + inspectTemplates: + description: >- + Detection logic for profile generation. Not all template features + are used by profiles. FindingLimits, include_quote and + exclude_info_types have no impact on data profiling. Multiple + templates may be provided if there is data in multiple regions. At + most one template must be specified per-region (including "global"). + Each region is scanned using the applicable template. If no + region-specific template is specified, but a "global" template is + specified, it will be copied to that region and used instead. If no + global or region-specific template is provided for a region with + data, that region's data will not be scanned. For more information, + see + https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. + type: array + items: + type: string + dataProfileActions: + description: Actions to execute at the completion of the job. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileAction' + GooglePrivacyDlpV2DataProfileLocation: + id: GooglePrivacyDlpV2DataProfileLocation + description: The data that will be profiled. type: object properties: - updateMask: + organizationId: + description: The ID of an organization to scan. type: string - format: google-fieldmask - description: Mask to control which fields get updated. - inspectTemplate: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' - description: New InspectTemplate value. - id: GooglePrivacyDlpV2UpdateInspectTemplateRequest - GooglePrivacyDlpV2InspectContentRequest: + format: int64 + folderId: + description: The ID of the folder within an organization to scan. + type: string + format: int64 + GooglePrivacyDlpV2Tag: + id: GooglePrivacyDlpV2Tag + description: A tag associated with a resource. + type: object properties: - inspectTemplateName: + namespacedTagValue: + description: >- + The namespaced name for the tag value to attach to Google Cloud + resources. Must be in the format + `{parent_id}/{tag_key_short_name}/{short_name}`, for example, + "123456/environment/prod" for an organization parent, or + "my-project/environment/prod" for a project parent. This is only set + for Google Cloud resources. type: string + key: description: >- - Template to use. Any configuration directly specified in - inspect_config will override those set in the template. Singular - fields that are set in this request will replace their corresponding - fields in the template. Repeated fields are appended. Singular - sub-messages and groups are recursively merged. - inspectConfig: + The key of a tag key-value pair. For Google Cloud resources, this is + the resource name of the key, for example, "tagKeys/123456". + type: string + value: description: >- - Configuration for the inspector. What specified here will override - the template referenced by the inspect_template_name argument. - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' - item: - description: The item to inspect. - $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' - locationId: - description: Deprecated. This field has no effect. + The value of a tag key-value pair. For Google Cloud resources, this + is the resource name of the value, for example, "tagValues/123456". type: string - description: Request to search for potentially sensitive info in a ContentItem. - type: object - id: GooglePrivacyDlpV2InspectContentRequest - GooglePrivacyDlpV2EntityId: + GooglePrivacyDlpV2RelatedResource: + id: GooglePrivacyDlpV2RelatedResource + description: >- + A related resource. Examples: * The source BigQuery table for a Vertex + AI dataset. * The source Cloud Storage bucket for a Vertex AI dataset. type: object + properties: + fullResource: + description: The full resource name of the related resource. + type: string + GooglePrivacyDlpV2Domain: + id: GooglePrivacyDlpV2Domain description: >- - An entity in a dataset is a field or set of fields that correspond to a - single person. For example, in medical records the `EntityId` might be a - patient identifier, or for financial records it might be an account - identifier. This message is used when generalizations or analysis must - take into account that multiple rows correspond to the same entity. - id: GooglePrivacyDlpV2EntityId + A domain represents a thematic category that a data profile can fall + under. + type: object properties: - field: - description: Composite key indicating which field contains the entity identifier. - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - GooglePrivacyDlpV2BigQueryOptions: - id: GooglePrivacyDlpV2BigQueryOptions - description: Options defining BigQuery table and row identifiers. + category: + description: A domain category that this profile is related to. + type: string + enumDescriptions: + - Category unspecified. + - >- + Indicates that the data profile is related to artificial + intelligence. When set, all findings stored to Security Command + Center will set the corresponding AI domain field of `Finding` + objects. + - Indicates that the data profile is related to code. + enum: + - CATEGORY_UNSPECIFIED + - AI + - CODE + signals: + description: The collection of signals that influenced selection of the category. + type: array + items: + type: string + enumDescriptions: + - Unused. + - One or more machine learning models are present. + - A table appears to be a text embedding. + - >- + The [Cloud SQL Vertex + AI](https://cloud.google.com/sql/docs/postgres/integrate-cloud-sql-with-vertex-ai) + plugin is installed on the database. + - >- + Support for [Cloud SQL vector + embeddings](https://cloud.google.com/sql/docs/mysql/enable-vector-search) + is enabled on the database. + - Source code is present. + - >- + If the service determines the category type. For example, Vertex + AI assets would always have a `Category` of `AI`. + enum: + - SIGNAL_UNSPECIFIED + - MODEL + - TEXT_EMBEDDING + - VERTEX_PLUGIN + - VECTOR_PLUGIN + - SOURCE_CODE + - SERVICE + GooglePrivacyDlpV2ListColumnDataProfilesResponse: + id: GooglePrivacyDlpV2ListColumnDataProfilesResponse + description: List of profiles generated for a given organization or project. type: object properties: - rowsLimit: + columnDataProfiles: + description: List of data profiles. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2ColumnDataProfile' + nextPageToken: + description: The next page token. + type: string + GooglePrivacyDlpV2ColumnDataProfile: + id: GooglePrivacyDlpV2ColumnDataProfile + description: The profile for a scanned column within a table. + type: object + properties: + name: + description: The name of the profile. + type: string + profileStatus: description: >- - Max number of rows to scan. If the table has more rows than this - value, the rest of the rows are omitted. If not set, or if set to 0, - all rows will be scanned. Only one of rows_limit and - rows_limit_percent can be specified. Cannot be used in conjunction - with TimespanConfig. + Success or error status from the most recent profile generation + attempt. May be empty if the profile is still being generated. + $ref: '#/components/schemas/GooglePrivacyDlpV2ProfileStatus' + state: + description: State of a profile. type: string - format: int64 - sampleMethod: - description: How to sample the data. + enumDescriptions: + - Unused. + - >- + The profile is currently running. Once a profile has finished it + will transition to DONE. + - >- + The profile is no longer generating. If profile_status.status.code + is 0, the profile succeeded, otherwise, it failed. + enum: + - STATE_UNSPECIFIED + - RUNNING + - DONE + profileLastGenerated: + description: The last time the profile was generated. + type: string + format: google-datetime + tableDataProfile: + description: The resource name of the table data profile. + type: string + tableFullResource: + description: The resource name of the resource this column is within. + type: string + datasetProjectId: + description: The Google Cloud project ID that owns the profiled resource. + type: string + datasetLocation: + description: >- + If supported, the location where the dataset's data is stored. See + https://cloud.google.com/bigquery/docs/locations for supported + BigQuery locations. + type: string + datasetId: + description: >- + The BigQuery dataset ID, if the resource profiled is a BigQuery + table. + type: string + tableId: + description: The table ID. + type: string + column: + description: The name of the column. + type: string + sensitivityScore: + description: The sensitivity of this column. + $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' + dataRiskLevel: + description: The data risk level for this column. + $ref: '#/components/schemas/GooglePrivacyDlpV2DataRiskLevel' + columnInfoType: + description: >- + If it's been determined this column can be identified as a single + type, this will be set. Otherwise the column either has + unidentifiable content or mixed types. + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeSummary' + otherMatches: + description: Other types found within this column. List will be unordered. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2OtherInfoTypeSummary' + estimatedNullPercentage: + description: Approximate percentage of entries being null in the column. + type: string + enumDescriptions: + - Unused. + - Very few null entries. + - Some null entries. + - A few null entries. + - A lot of null entries. + enum: + - NULL_PERCENTAGE_LEVEL_UNSPECIFIED + - NULL_PERCENTAGE_VERY_LOW + - NULL_PERCENTAGE_LOW + - NULL_PERCENTAGE_MEDIUM + - NULL_PERCENTAGE_HIGH + estimatedUniquenessScore: + description: Approximate uniqueness of the column. + type: string + enumDescriptions: + - >- + Some columns do not have estimated uniqueness. Possible reasons + include having too few values. + - >- + Low uniqueness, possibly a boolean, enum or similiarly typed + column. + - Medium uniqueness. + - >- + High uniqueness, possibly a column of free text or unique + identifiers. + enum: + - UNIQUENESS_SCORE_LEVEL_UNSPECIFIED + - UNIQUENESS_SCORE_LOW + - UNIQUENESS_SCORE_MEDIUM + - UNIQUENESS_SCORE_HIGH + freeTextScore: + description: >- + The likelihood that this column contains free-form text. A value + close to 1 may indicate the column is likely to contain free-form or + natural language text. Range in 0-1. + type: number + format: double + columnType: + description: The data type of a given column. + type: string + enumDescriptions: + - Invalid type. + - Encoded as a string in decimal format. + - Encoded as a boolean "false" or "true". + - Encoded as a number, or string "NaN", "Infinity" or "-Infinity". + - Encoded as a string value. + - Encoded as a base64 string per RFC 4648, section 4. + - >- + Encoded as an RFC 3339 timestamp with mandatory "Z" time zone + string: 1985-04-12T23:20:50.52Z + - 'Encoded as RFC 3339 full-date format string: 1985-04-12' + - 'Encoded as RFC 3339 partial-time format string: 23:20:50.52' + - >- + Encoded as RFC 3339 full-date "T" partial-time: + 1985-04-12T23:20:50.52 + - Encoded as WKT + - Encoded as a decimal string. + - Container of ordered fields, each with a type and field name. + - Decimal type. + - Json type. + - Interval type. + - '`Range` type.' + - '`Range` type.' + - '`Range` type.' + enum: + - COLUMN_DATA_TYPE_UNSPECIFIED + - TYPE_INT64 + - TYPE_BOOL + - TYPE_FLOAT64 + - TYPE_STRING + - TYPE_BYTES + - TYPE_TIMESTAMP + - TYPE_DATE + - TYPE_TIME + - TYPE_DATETIME + - TYPE_GEOGRAPHY + - TYPE_NUMERIC + - TYPE_RECORD + - TYPE_BIGNUMERIC + - TYPE_JSON + - TYPE_INTERVAL + - TYPE_RANGE_DATE + - TYPE_RANGE_DATETIME + - TYPE_RANGE_TIMESTAMP + policyState: + description: Indicates if a policy tag has been applied to the column. type: string enumDescriptions: - - No sampling. - - >- - Scan groups of rows in the order BigQuery provides (default). - Multiple groups of rows may be scanned in parallel, so results may - not appear in the same order the rows are read. - - Randomly pick groups of rows to scan. + - No policy tags. + - Column has policy tag applied. enum: - - SAMPLE_METHOD_UNSPECIFIED - - TOP - - RANDOM_START - includedFields: - description: >- - Limit scanning only to these fields. When inspecting a table, we - recommend that you inspect all columns. Otherwise, findings might be - affected because hints from excluded columns will not be used. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - type: array - rowsLimitPercent: - type: integer - description: >- - Max percentage of rows to scan. The rest are omitted. The number of - rows scanned is rounded down. Must be between 0 and 100, - inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one - of rows_limit and rows_limit_percent can be specified. Cannot be - used in conjunction with TimespanConfig. Caution: A [known - issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) - is causing the `rowsLimitPercent` field to behave unexpectedly. We - recommend using `rowsLimit` instead. - format: int32 - excludedFields: + - COLUMN_POLICY_STATE_UNSPECIFIED + - COLUMN_POLICY_TAGGED + GooglePrivacyDlpV2ListFileStoreDataProfilesResponse: + id: GooglePrivacyDlpV2ListFileStoreDataProfilesResponse + description: >- + List of file store data profiles generated for a given organization or + project. + type: object + properties: + fileStoreDataProfiles: + description: List of data profiles. type: array - description: >- - References to fields excluded from scanning. This allows you to skip - inspection of entire columns which you know have no findings. When - inspecting a table, we recommend that you inspect all columns. - Otherwise, findings might be affected because hints from excluded - columns will not be used. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - identifyingFields: items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - description: >- - Table fields that may uniquely identify a row within the table. When - `actions.saveFindings.outputConfig.table` is specified, the values - of columns specified here are available in the output table under - `location.content_locations.record_location.record_key.id_values`. - Nested fields such as `person.birthdate.year` are allowed. - type: array - tableReference: - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' - description: Complete BigQuery table reference. - GooglePrivacyDlpV2PathElement: + $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreDataProfile' + nextPageToken: + description: The next page token. + type: string + GooglePrivacyDlpV2FileStoreDataProfile: + id: GooglePrivacyDlpV2FileStoreDataProfile description: >- - A (kind, ID/name) pair used to construct a key path. If either name or - ID is set, the element is complete. If neither is set, the element is - incomplete. - id: GooglePrivacyDlpV2PathElement + The profile for a file store. * Cloud Storage: maps 1:1 with a bucket. * + Amazon S3: maps 1:1 with a bucket. + type: object properties: - id: - description: >- - The auto-allocated ID of the entity. Never equal to zero. Values - less than zero are discouraged and may not be supported in the - future. - format: int64 - type: string name: + description: The name of the profile. type: string - description: >- - The name of the entity. A name matching regex `__.*__` is - reserved/read-only. A name must not be more than 1500 bytes when - UTF-8 encoded. Cannot be `""`. - kind: + dataSourceType: + description: The resource type that was profiled. + $ref: '#/components/schemas/GooglePrivacyDlpV2DataSourceType' + projectDataProfile: + description: The resource name of the project data profile for this file store. type: string + projectId: description: >- - The kind of the entity. A kind matching regex `__.*__` is - reserved/read-only. A kind must not contain more than 1500 bytes - when UTF-8 encoded. Cannot be `""`. - type: object - GooglePrivacyDlpV2JobTrigger: - properties: - displayName: - description: Display name (max 100 chars) + The Google Cloud project ID that owns the resource. For Amazon S3 + buckets, this is the AWS Account Id. type: string - triggers: + fileStoreLocation: description: >- - A list of triggers which will be OR'ed together. Only one in the - list needs to trigger for a job to be started. The list may contain - only a single Schedule trigger and must have at least one object. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Trigger' - type: array - inspectJob: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectJobConfig' - description: For inspect jobs, a snapshot of the configuration. - name: + The location of the file store. * Cloud Storage: + https://cloud.google.com/storage/docs/locations#available-locations + * Amazon S3: + https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints type: string + dataStorageLocations: description: >- - Unique resource name for the triggeredJob, assigned by the service - when the triggeredJob is created, for example - `projects/dlp-test-project/jobTriggers/53234423`. - description: - type: string - description: User provided description (max 256 chars) - status: - enumDescriptions: - - Unused. - - Trigger is healthy. - - Trigger is temporarily paused. - - Trigger is cancelled and can not be resumed. - description: Required. A status for this trigger. - type: string - enum: - - STATUS_UNSPECIFIED - - HEALTHY - - PAUSED - - CANCELLED - createTime: - description: Output only. The creation timestamp of a triggeredJob. - readOnly: true - format: google-datetime - type: string - errors: - readOnly: true + For resources that have multiple storage locations, these are those + regions. For Cloud Storage this is the list of regions chosen for + dual-region storage. `file_store_location` will normally be the + corresponding multi-region for the list of individual locations. The + first region is always picked as the processing and storage location + for the data profile. + type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Error' + type: string + locationType: description: >- - Output only. A stream of errors encountered when the trigger was - activated. Repeated errors may result in the JobTrigger - automatically being paused. Will return the last 100 errors. - Whenever the JobTrigger is modified this list will be cleared. - type: array - lastRunTime: - type: string - description: Output only. The timestamp of the last time this trigger executed. - readOnly: true - format: google-datetime - updateTime: - description: Output only. The last update timestamp of a triggeredJob. - format: google-datetime - readOnly: true - type: string - description: >- - Contains a configuration to make API calls on a repeating basis. See - https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers - to learn more. - id: GooglePrivacyDlpV2JobTrigger - type: object - GooglePrivacyDlpV2InspectTemplate: - description: >- - The inspectTemplate contains a configuration (set of types of sensitive - data to be detected) to be used anywhere you otherwise would normally - specify InspectConfig. See - https://cloud.google.com/sensitive-data-protection/docs/concepts-templates - to learn more. - type: object - id: GooglePrivacyDlpV2InspectTemplate - properties: - description: - description: Short description (max 256 chars). + The location type of the file store (region, dual-region, + multi-region, etc). If dual-region, expect data_storage_locations to + be populated. type: string - createTime: - format: google-datetime - readOnly: true - description: Output only. The creation timestamp of an inspectTemplate. - type: string - updateTime: - type: string - format: google-datetime - description: Output only. The last update timestamp of an inspectTemplate. - readOnly: true - displayName: + fileStorePath: + description: >- + The file store path. * Cloud Storage: `gs://{bucket}` * Amazon S3: + `s3://{bucket}` * Vertex AI dataset: + `projects/{project_number}/locations/{location}/datasets/{dataset_id}` type: string - description: Display name (max 256 chars). - inspectConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' + fullResource: description: >- - The core content of the template. Configuration of the scanning - process. - name: - readOnly: true + The resource name of the resource profiled. + https://cloud.google.com/apis/design/resource_names#full_resource_name + Example format of an S3 bucket full resource name: + `//cloudasset.googleapis.com/organizations/{org_id}/otherCloudConnections/aws/arn:aws:s3:::{bucket_name}` + type: string + configSnapshot: + description: The snapshot of the configurations used to generate the profile. + $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileConfigSnapshot' + profileStatus: description: >- - Output only. The template name. The template will have one of the - following formats: - `projects/PROJECT_ID/inspectTemplates/TEMPLATE_ID` OR - `organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID`; + Success or error status from the most recent profile generation + attempt. May be empty if the profile is still being generated. + $ref: '#/components/schemas/GooglePrivacyDlpV2ProfileStatus' + state: + description: State of a profile. type: string - GooglePrivacyDlpV2AmazonS3Bucket: - description: Amazon S3 bucket. - properties: - awsAccount: - $ref: '#/components/schemas/GooglePrivacyDlpV2AwsAccount' - description: The AWS account. - bucketName: - description: Required. The bucket name. + enumDescriptions: + - Unused. + - >- + The profile is currently running. Once a profile has finished it + will transition to DONE. + - >- + The profile is no longer generating. If profile_status.status.code + is 0, the profile succeeded, otherwise, it failed. + enum: + - STATE_UNSPECIFIED + - RUNNING + - DONE + profileLastGenerated: + description: The last time the profile was generated. type: string - id: GooglePrivacyDlpV2AmazonS3Bucket - type: object - GooglePrivacyDlpV2StoredType: - id: GooglePrivacyDlpV2StoredType - type: object - properties: - createTime: format: google-datetime - description: >- - Timestamp indicating when the version of the `StoredInfoType` used - for inspection was created. Output-only field, populated by the - system. + resourceVisibility: + description: How broadly a resource has been shared. type: string - name: + enumDescriptions: + - Unused. + - Visible to any user. + - >- + May contain public items. For example, if a Cloud Storage bucket + has uniform bucket level access disabled, some objects inside it + may be public, but none are known yet. + - Visible only to specific users. + enum: + - RESOURCE_VISIBILITY_UNSPECIFIED + - RESOURCE_VISIBILITY_PUBLIC + - RESOURCE_VISIBILITY_INCONCLUSIVE + - RESOURCE_VISIBILITY_RESTRICTED + sensitivityScore: + description: The sensitivity score of this resource. + $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' + dataRiskLevel: + description: The data risk level of this resource. + $ref: '#/components/schemas/GooglePrivacyDlpV2DataRiskLevel' + createTime: + description: The time the file store was first created. type: string - description: >- - Resource name of the requested `StoredInfoType`, for example - `organizations/433245324/storedInfoTypes/432452342` or - `projects/project-id/storedInfoTypes/432452342`. - description: A reference to a StoredInfoType to use with scanning. - GooglePrivacyDlpV2QuasiId: - id: GooglePrivacyDlpV2QuasiId - properties: - customTag: + format: google-datetime + lastModifiedTime: + description: The time the file store was last modified. type: string + format: google-datetime + fileClusterSummaries: + description: FileClusterSummary per each cluster. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2FileClusterSummary' + resourceAttributes: description: >- - A column can be tagged with a custom tag. In this case, the user - must indicate an auxiliary table that contains statistical - information on the possible values of this column (below). - field: - description: Required. Identifies the column. - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - infoType: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + Attributes of the resource being profiled. Currently used + attributes: * customer_managed_encryption: boolean - true: the + resource is encrypted with a customer-managed key. - false: the + resource is encrypted with a provider-managed key. + type: object + additionalProperties: + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + resourceLabels: description: >- - A column can be tagged with a InfoType to use the relevant public - dataset as a statistical model of population, if available. We - currently support US ZIP codes, region codes, ages and genders. To - programmatically obtain the list of supported InfoTypes, use - ListInfoTypes with the supported_by=RISK_ANALYSIS filter. - inferred: - $ref: '#/components/schemas/GoogleProtobufEmpty' + The labels applied to the resource at the time the profile was + generated. + type: object + additionalProperties: + type: string + fileStoreInfoTypeSummaries: + description: InfoTypes detected in this file store. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreInfoTypeSummary' + sampleFindingsTable: + description: The BigQuery table to which the sample findings are written. + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + fileStoreIsEmpty: description: >- - If no semantic tag is indicated, we infer the statistical model from - the distribution of values in the input data - type: object - description: A column with a semantic tag attached. - GooglePrivacyDlpV2BigQueryRegexes: - description: >- - A collection of regular expressions to determine what tables to match - against. - properties: - patterns: + The file store does not have any files. If the profiling operation + failed, this is false. + type: boolean + tags: description: >- - A single BigQuery regular expression pattern to match against one or - more tables, datasets, or projects that contain BigQuery tables. + The tags attached to the resource, including any tags attached + during profiling. type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryRegex' + $ref: '#/components/schemas/GooglePrivacyDlpV2Tag' + relatedResources: + description: Resources related to this profile. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2RelatedResource' + domains: + description: Domains associated with the profile. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Domain' + GooglePrivacyDlpV2FileClusterSummary: + id: GooglePrivacyDlpV2FileClusterSummary + description: The file cluster summary. type: object - id: GooglePrivacyDlpV2BigQueryRegexes - GooglePrivacyDlpV2DiscoveryCloudSqlFilter: properties: - collection: - description: A specific set of database resources for this filter to apply to. - $ref: '#/components/schemas/GooglePrivacyDlpV2DatabaseResourceCollection' - databaseResourceReference: + fileClusterType: + description: The file cluster type. + $ref: '#/components/schemas/GooglePrivacyDlpV2FileClusterType' + fileStoreInfoTypeSummaries: + description: InfoTypes detected in this cluster. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreInfoTypeSummary' + sensitivityScore: description: >- - The database resource to scan. Targets including this can only - include one target (the target with this database resource - reference). - $ref: '#/components/schemas/GooglePrivacyDlpV2DatabaseResourceReference' - others: + The sensitivity score of this cluster. The score will be + SENSITIVITY_LOW if nothing has been scanned. + $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' + dataRiskLevel: description: >- - Catch-all. This should always be the last target in the list because - anything above it will apply first. Should only appear once in a - configuration. If none is specified, a default one will be added - automatically. - $ref: '#/components/schemas/GooglePrivacyDlpV2AllOtherDatabaseResources' - id: GooglePrivacyDlpV2DiscoveryCloudSqlFilter - type: object - description: >- - Determines what tables will have profiles generated within an - organization or project. Includes the ability to filter by regular - expression patterns on project ID, location, instance, database, and - database resource name. - GooglePrivacyDlpV2TransformationDetails: - type: object - id: GooglePrivacyDlpV2TransformationDetails - properties: - containerName: - type: string + The data risk level of this cluster. RISK_LOW if nothing has been + scanned. + $ref: '#/components/schemas/GooglePrivacyDlpV2DataRiskLevel' + errors: description: >- - The top level name of the container where the transformation is - located (this will be the source file name or table name). - transformation: + A list of errors detected while scanning this cluster. The list is + truncated to 10 per cluster. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Error' + fileExtensionsScanned: description: >- - Description of transformation. This would only contain more than one - element if there were multiple matching transformations and which - one to apply was ambiguous. Not set for states that contain no - transformation, currently only state that contains no transformation - is TransformationResultStateType.METADATA_UNRETRIEVABLE. + A sample of file types scanned in this cluster. Empty if no files + were scanned. File extensions can be derived from the file name or + the file content. + type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationDescription' + $ref: '#/components/schemas/GooglePrivacyDlpV2FileExtensionInfo' + fileExtensionsSeen: + description: >- + A sample of file types seen in this cluster. Empty if no files were + seen. File extensions can be derived from the file name or the file + content. type: array - transformedBytes: - format: int64 + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2FileExtensionInfo' + noFilesExist: description: >- - The number of bytes that were transformed. If transformation was - unsuccessful or did not take place because there was no content to - transform, this will be zero. + True if no files exist in this cluster. If the file store had more + files than could be listed, this will be false even if no files for + this cluster were seen and file_extensions_seen is empty. + type: boolean + GooglePrivacyDlpV2FileClusterType: + id: GooglePrivacyDlpV2FileClusterType + description: Message used to identify file cluster type being profiled. + type: object + properties: + cluster: + description: Cluster type. type: string - resourceName: - description: The name of the job that completed the transformation. + enumDescriptions: + - Unused. + - Unsupported files. + - Plain text. + - Structured data like CSV, TSV etc. + - Source code. + - Rich document like docx, xlsx etc. + - Images like jpeg, bmp. + - Archives and containers like .zip, .tar etc. + - Multimedia like .mp4, .avi etc. + - Executable files like .exe, .class, .apk etc. + - AI models like .tflite etc. + enum: + - CLUSTER_UNSPECIFIED + - CLUSTER_UNKNOWN + - CLUSTER_TEXT + - CLUSTER_STRUCTURED_DATA + - CLUSTER_SOURCE_CODE + - CLUSTER_RICH_DOCUMENT + - CLUSTER_IMAGE + - CLUSTER_ARCHIVE + - CLUSTER_MULTIMEDIA + - CLUSTER_EXECUTABLE + - CLUSTER_AI_MODEL + GooglePrivacyDlpV2FileStoreInfoTypeSummary: + id: GooglePrivacyDlpV2FileStoreInfoTypeSummary + description: Information regarding the discovered InfoType. + type: object + properties: + infoType: + description: The InfoType seen. + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + GooglePrivacyDlpV2FileExtensionInfo: + id: GooglePrivacyDlpV2FileExtensionInfo + description: Information regarding the discovered file extension. + type: object + properties: + fileExtension: + description: The file extension if set. (aka .pdf, .jpg, .txt) type: string - statusDetails: - description: >- - Status of the transformation, if transformation was not successful, - this will specify what caused it to fail, otherwise it will show - that the transformation was successful. - $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationResultStatus' - transformationLocation: - $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationLocation' - description: >- - The precise location of the transformed content in the original - container. + GooglePrivacyDlpV2HybridInspectDlpJobRequest: + id: GooglePrivacyDlpV2HybridInspectDlpJobRequest + description: Request to search for potentially sensitive info in a custom location. + type: object + properties: + hybridItem: + description: The item to inspect. + $ref: '#/components/schemas/GooglePrivacyDlpV2HybridContentItem' + GooglePrivacyDlpV2FinishDlpJobRequest: + id: GooglePrivacyDlpV2FinishDlpJobRequest + description: The request message for finishing a DLP hybrid job. + type: object + properties: {} + GooglePrivacyDlpV2CreateConnectionRequest: + id: GooglePrivacyDlpV2CreateConnectionRequest + description: Request message for CreateConnection. + type: object + properties: + connection: + description: Required. The connection resource. + $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' + GooglePrivacyDlpV2Connection: + id: GooglePrivacyDlpV2Connection description: >- - Details about a single transformation. This object contains a - description of the transformation, information about whether the - transformation was successfully applied, and the precise location where - the transformation occurred. These details are stored in a - user-specified BigQuery table. - GooglePrivacyDlpV2StoredInfoTypeConfig: + A data connection to allow the DLP API to profile data in locations that + require additional configuration. type: object properties: - dictionary: - $ref: '#/components/schemas/GooglePrivacyDlpV2Dictionary' - description: Store dictionary-based CustomInfoType. - description: - type: string - description: Description of the StoredInfoType (max 256 characters). - regex: - $ref: '#/components/schemas/GooglePrivacyDlpV2Regex' - description: Store regular expression-based StoredInfoType. - largeCustomDictionary: - $ref: '#/components/schemas/GooglePrivacyDlpV2LargeCustomDictionaryConfig' + name: description: >- - StoredInfoType where findings are defined by a dictionary of - phrases. - displayName: + Output only. Name of the connection: + `projects/{project}/locations/{location}/connections/{name}`. + readOnly: true type: string - description: Display name of the StoredInfoType (max 256 characters). - description: >- - Configuration for stored infoTypes. All fields and subfield are provided - by the user. For more information, see - https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. - id: GooglePrivacyDlpV2StoredInfoTypeConfig + state: + description: Required. The connection's state in its lifecycle. + type: string + enumDescriptions: + - Unused + - >- + The DLP API automatically created this connection during an + initial scan, and it is awaiting full configuration by a user. + - A configured connection that has not encountered any errors. + - >- + A configured connection that encountered errors during its last + use. It will not be used again until it is set to AVAILABLE. If + the resolution requires external action, then the client must send + a request to set the status to AVAILABLE when the connection is + ready for use. If the resolution doesn't require external action, + then any changes to the connection properties will automatically + mark it as AVAILABLE. + enum: + - CONNECTION_STATE_UNSPECIFIED + - MISSING_CREDENTIALS + - AVAILABLE + - ERROR + errors: + description: >- + Output only. Set if status == ERROR, to provide additional details. + Will store the last 10 errors sorted with the most recent first. + readOnly: true + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Error' + cloudSql: + description: Connect to a Cloud SQL instance. + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudSqlProperties' GooglePrivacyDlpV2CloudSqlProperties: - type: object id: GooglePrivacyDlpV2CloudSqlProperties description: Cloud SQL connection properties. + type: object properties: - usernamePassword: - $ref: '#/components/schemas/GooglePrivacyDlpV2SecretManagerCredential' - description: A username and password stored in Secret Manager. - maxConnections: - type: integer - description: >- - Required. The DLP API will limit its connections to max_connections. - Must be 2 or greater. - format: int32 connectionName: - type: string description: >- Optional. Immutable. The Cloud SQL instance for which the connection is defined. Only one connection per instance is allowed. This can @@ -7672,357 +8153,512 @@ components: for Cloud SQL connection_name `project-id:us-central1:sql-instance` must be created under the parent `projects/project-id/locations/us-central1` + type: string + usernamePassword: + description: A username and password stored in Secret Manager. + $ref: '#/components/schemas/GooglePrivacyDlpV2SecretManagerCredential' cloudSqlIam: - $ref: '#/components/schemas/GooglePrivacyDlpV2CloudSqlIamCredential' description: Built-in IAM authentication (must be configured in Cloud SQL). + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudSqlIamCredential' + maxConnections: + description: >- + Required. The DLP API will limit its connections to max_connections. + Must be 2 or greater. + type: integer + format: int32 databaseEngine: + description: >- + Required. The database engine used by the Cloud SQL instance that + this connection configures. + type: string enumDescriptions: - >- An engine that is not currently supported by Sensitive Data Protection. - Cloud SQL for MySQL instance. - Cloud SQL for PostgreSQL instance. - type: string enum: - DATABASE_ENGINE_UNKNOWN - DATABASE_ENGINE_MYSQL - DATABASE_ENGINE_POSTGRES + GooglePrivacyDlpV2SecretManagerCredential: + id: GooglePrivacyDlpV2SecretManagerCredential + description: >- + A credential consisting of a username and password, where the password + is stored in a Secret Manager resource. Note: Secret Manager [charges + apply](https://cloud.google.com/secret-manager/pricing). + type: object + properties: + username: + description: Required. The username. + type: string + passwordSecretVersionName: description: >- - Required. The database engine used by the Cloud SQL instance that - this connection configures. - GooglePrivacyDlpV2DiscoveryBigQueryConditions: - id: GooglePrivacyDlpV2DiscoveryBigQueryConditions + Required. The name of the Secret Manager resource that stores the + password, in the form + `projects/project-id/secrets/secret-name/versions/version`. + type: string + GooglePrivacyDlpV2CloudSqlIamCredential: + id: GooglePrivacyDlpV2CloudSqlIamCredential + description: >- + Use IAM authentication to connect. This requires the Cloud SQL IAM + feature to be enabled on the instance, which is not the default for + Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication + and https://cloud.google.com/sql/docs/mysql/authentication. + type: object + properties: {} + GooglePrivacyDlpV2ListConnectionsResponse: + id: GooglePrivacyDlpV2ListConnectionsResponse + description: Response message for ListConnections. type: object properties: - types: - description: Restrict discovery to specific table types. - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTableTypes' - typeCollection: + connections: + description: List of connections. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' + nextPageToken: + description: >- + Token to retrieve the next page of results. An empty value means + there are no more results. + type: string + GooglePrivacyDlpV2SearchConnectionsResponse: + id: GooglePrivacyDlpV2SearchConnectionsResponse + description: Response message for SearchConnections. + type: object + properties: + connections: + description: >- + List of connections that match the search query. Note that only a + subset of the fields will be populated, and only "name" is + guaranteed to be set. For full details of a Connection, call + GetConnection with the name. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' + nextPageToken: + description: >- + Token to retrieve the next page of results. An empty value means + there are no more results. + type: string + GooglePrivacyDlpV2UpdateConnectionRequest: + id: GooglePrivacyDlpV2UpdateConnectionRequest + description: Request message for UpdateConnection. + type: object + properties: + connection: + description: Required. The connection with new values for the relevant fields. + $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' + updateMask: + description: Optional. Mask to control which fields get updated. + type: string + format: google-fieldmask + GooglePrivacyDlpV2DataProfileFinding: + id: GooglePrivacyDlpV2DataProfileFinding + description: >- + Details about a piece of potentially sensitive information that was + detected when the data resource was profiled. + type: object + properties: + quote: + description: >- + The content that was found. Even if the content is not textual, it + may be converted to a textual representation here. If the finding + exceeds 4096 bytes in length, the quote may be omitted. + type: string + infotype: + description: >- + The [type of + content](https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference) + that might have been found. + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + quoteInfo: + description: >- + Contains data parsed from quotes. Currently supported infoTypes: + DATE, DATE_OF_BIRTH, and TIME. + $ref: '#/components/schemas/GooglePrivacyDlpV2QuoteInfo' + dataProfileResourceName: + description: Resource name of the data profile associated with the finding. + type: string + findingId: + description: A unique identifier for the finding. + type: string + timestamp: + description: Timestamp when the finding was detected. + type: string + format: google-datetime + location: + description: Where the content was found. + $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileFindingLocation' + resourceVisibility: + description: How broadly a resource has been shared. + type: string enumDescriptions: - Unused. + - Visible to any user. - >- - Automatically generate profiles for all tables, even if the table - type is not yet fully supported for analysis. Profiles for - unsupported tables will be generated with errors to indicate their - partial support. When full support is added, the tables will - automatically be profiled during the next scheduled run. - - >- - Only those types fully supported will be profiled. Will expand - automatically as Cloud DLP adds support for new table types. - Unsupported table types will not have partial profiles generated. - description: Restrict discovery to categories of table types. - type: string + May contain public items. For example, if a Cloud Storage bucket + has uniform bucket level access disabled, some objects inside it + may be public, but none are known yet. + - Visible only to specific users. enum: - - BIG_QUERY_COLLECTION_UNSPECIFIED - - BIG_QUERY_COLLECTION_ALL_TYPES - - BIG_QUERY_COLLECTION_ONLY_SUPPORTED_TYPES - orConditions: - description: >- - At least one of the conditions must be true for a table to be - scanned. - $ref: '#/components/schemas/GooglePrivacyDlpV2OrConditions' - createdAfter: + - RESOURCE_VISIBILITY_UNSPECIFIED + - RESOURCE_VISIBILITY_PUBLIC + - RESOURCE_VISIBILITY_INCONCLUSIVE + - RESOURCE_VISIBILITY_RESTRICTED + fullResourceName: description: >- - BigQuery table must have been created after this date. Used to avoid - backfilling. - format: google-datetime + The [full resource + name](https://cloud.google.com/apis/design/resource_names#full_resource_name) + of the resource profiled for this finding. type: string - description: >- - Requirements that must be true before a table is scanned in discovery - for the first time. There is an AND relationship between the top-level - attributes. Additionally, minimum conditions with an OR relationship - that must be met before Cloud DLP scans a table can be set (like a - minimum row count or a minimum table age). - GooglePrivacyDlpV2TransformationDetailsStorageConfig: - description: Config for storing transformation details. - id: GooglePrivacyDlpV2TransformationDetailsStorageConfig + dataSourceType: + description: The type of the resource that was profiled. + $ref: '#/components/schemas/GooglePrivacyDlpV2DataSourceType' + GooglePrivacyDlpV2DataProfileFindingLocation: + id: GooglePrivacyDlpV2DataProfileFindingLocation + description: Location of a data profile finding within a resource. type: object properties: - table: - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + containerName: description: >- - The BigQuery table in which to store the output. This may be an - existing table or in a new table in an existing dataset. If table_id - is not set a new one will be generated for you with the following - format: - dlp_googleapis_transformation_details_yyyy_mm_dd_[dlp_job_id]. - Pacific time zone will be used for generating the date details. - GooglePrivacyDlpV2TransformationErrorHandling: + Name of the container where the finding is located. The top-level + name is the source file name or table name. Names of some common + storage containers are formatted as follows: * BigQuery tables: + `{project_id}:{dataset_id}.{table_id}` * Cloud Storage files: + `gs://{bucket}/{path}` + type: string + dataProfileFindingRecordLocation: + description: >- + Location of a finding within a resource that produces a table data + profile. + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DataProfileFindingRecordLocation + GooglePrivacyDlpV2DataProfileFindingRecordLocation: + id: GooglePrivacyDlpV2DataProfileFindingRecordLocation + description: >- + Location of a finding within a resource that produces a table data + profile. type: object - id: GooglePrivacyDlpV2TransformationErrorHandling properties: - leaveUntransformed: - description: Ignore errors - $ref: '#/components/schemas/GooglePrivacyDlpV2LeaveUntransformed' - throwError: - description: Throw an error - $ref: '#/components/schemas/GooglePrivacyDlpV2ThrowError' + field: + description: Field ID of the column containing the finding. + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + GooglePrivacyDlpV2DataProfilePubSubMessage: + id: GooglePrivacyDlpV2DataProfilePubSubMessage description: >- - How to handle transformation errors during de-identification. A - transformation error occurs when the requested transformation is - incompatible with the data. For example, trying to de-identify an IP - address using a `DateShift` transformation would result in a - transformation error, since date info cannot be extracted from an IP - address. Information about any incompatible transformations, and how - they were handled, is returned in the response as part of the - `TransformationOverviews`. - GooglePrivacyDlpV2DeltaPresenceEstimationHistogramBucket: + Pub/Sub topic message for a DataProfileAction.PubSubNotification event. + To receive a message of protocol buffer schema type, convert the message + data to an object of this proto class. type: object - id: GooglePrivacyDlpV2DeltaPresenceEstimationHistogramBucket properties: - bucketValues: + profile: description: >- - Sample of quasi-identifier tuple values in this bucket. The total - number of classes returned per bucket is capped at 20. - items: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2DeltaPresenceEstimationQuasiIdValues - type: array - minProbability: - description: Between 0 and 1. - type: number - format: double - maxProbability: - type: number - description: Always greater than or equal to min_probability. - format: double - bucketSize: - description: Number of records within these probability bounds. - format: int64 - type: string - bucketValueCount: - format: int64 + If `DetailLevel` is `TABLE_PROFILE` this will be fully populated. + Otherwise, if `DetailLevel` is `RESOURCE_NAME`, then only `name` and + `full_resource` will be populated. + $ref: '#/components/schemas/GooglePrivacyDlpV2TableDataProfile' + fileStoreProfile: description: >- - Total number of distinct quasi-identifier tuple values in this - bucket. + If `DetailLevel` is `FILE_STORE_PROFILE` this will be fully + populated. Otherwise, if `DetailLevel` is `RESOURCE_NAME`, then only + `name` and `file_store_path` will be populated. + $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreDataProfile' + event: + description: The event that caused the Pub/Sub message to be sent. type: string + enumDescriptions: + - Unused. + - New profile (not a re-profile). + - >- + One of the following profile metrics changed: Data risk score, + Sensitivity score, Resource visibility, Encryption type, Predicted + infoTypes, Other infoTypes + - Table data risk score or sensitivity score increased. + - A user (non-internal) error occurred. + enum: + - EVENT_TYPE_UNSPECIFIED + - NEW_PROFILE + - CHANGED_PROFILE + - SCORE_INCREASED + - ERROR_CHANGED + GooglePrivacyDlpV2DataProfileBigQueryRowSchema: + id: GooglePrivacyDlpV2DataProfileBigQueryRowSchema description: >- - A DeltaPresenceEstimationHistogramBucket message with the following - values: min_probability: 0.1 max_probability: 0.2 frequency: 42 means - that there are 42 records for which δ is in [0.1, 0.2). An important - particular case is when min_probability = max_probability = 1: then, - every individual who shares this quasi-identifier combination is in the - dataset. - GooglePrivacyDlpV2CloudStorageRegex: - id: GooglePrivacyDlpV2CloudStorageRegex + The schema of data to be saved to the BigQuery table when the + `DataProfileAction` is enabled. + type: object properties: - bucketNameRegex: - type: string - description: >- - Optional. Regex to test the bucket name against. If empty, all - buckets match. Example: "marketing2021" or "(marketing)\d{4}" will - both match the bucket gs://marketing2021 - projectIdRegex: - type: string - description: Optional. For organizations, if unset, will match all projects. + tableProfile: + description: Table data profile column + $ref: '#/components/schemas/GooglePrivacyDlpV2TableDataProfile' + columnProfile: + description: Column data profile column + $ref: '#/components/schemas/GooglePrivacyDlpV2ColumnDataProfile' + fileStoreProfile: + description: File store data profile column. + $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreDataProfile' + GooglePrivacyDlpV2TransformationDetails: + id: GooglePrivacyDlpV2TransformationDetails description: >- - A pattern to match against one or more file stores. At least one pattern - must be specified. Regular expressions use RE2 - [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be - found under the google/re2 repository on GitHub. - type: object - GooglePrivacyDlpV2TransformationOverview: + Details about a single transformation. This object contains a + description of the transformation, information about whether the + transformation was successfully applied, and the precise location where + the transformation occurred. These details are stored in a + user-specified BigQuery table. type: object properties: - transformedBytes: - format: int64 - description: Total size in bytes that were transformed in some way. + resourceName: + description: The name of the job that completed the transformation. type: string - transformationSummaries: + containerName: + description: >- + The top level name of the container where the transformation is + located (this will be the source file name or table name). + type: string + transformation: + description: >- + Description of transformation. This would only contain more than one + element if there were multiple matching transformations and which + one to apply was ambiguous. Not set for states that contain no + transformation, currently only state that contains no transformation + is TransformationResultStateType.METADATA_UNRETRIEVABLE. type: array - description: Transformations applied to the dataset. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationSummary' - id: GooglePrivacyDlpV2TransformationOverview - description: Overview of the modifications that occurred. - GooglePrivacyDlpV2DiscoverySchemaModifiedCadence: - description: The cadence at which to update data profiles when a schema is modified. + $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationDescription' + statusDetails: + description: >- + Status of the transformation, if transformation was not successful, + this will specify what caused it to fail, otherwise it will show + that the transformation was successful. + $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationResultStatus' + transformedBytes: + description: >- + The number of bytes that were transformed. If transformation was + unsuccessful or did not take place because there was no content to + transform, this will be zero. + type: string + format: int64 + transformationLocation: + description: >- + The precise location of the transformed content in the original + container. + $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationLocation' + GooglePrivacyDlpV2TransformationDescription: + id: GooglePrivacyDlpV2TransformationDescription + description: >- + A flattened description of a `PrimitiveTransformation` or + `RecordSuppression`. + type: object properties: - types: - items: - enumDescriptions: - - Unused - - >- - Profiles should be regenerated when new columns are added to the - table. Default. - - >- - Profiles should be regenerated when columns are removed from the - table. - enum: - - SCHEMA_MODIFICATION_UNSPECIFIED - - SCHEMA_NEW_COLUMNS - - SCHEMA_REMOVED_COLUMNS - type: string + type: + description: The transformation type. + type: string + enumDescriptions: + - Unused + - Record suppression + - Replace value + - Replace value using a dictionary. + - Redact + - Character mask + - FFX-FPE + - Fixed size bucketing + - Bucketing + - Replace with info type + - Time part + - Crypto hash + - Date shift + - Deterministic crypto + - Redact image + enum: + - TRANSFORMATION_TYPE_UNSPECIFIED + - RECORD_SUPPRESSION + - REPLACE_VALUE + - REPLACE_DICTIONARY + - REDACT + - CHARACTER_MASK + - CRYPTO_REPLACE_FFX_FPE + - FIXED_SIZE_BUCKETING + - BUCKETING + - REPLACE_WITH_INFO_TYPE + - TIME_PART + - CRYPTO_HASH + - DATE_SHIFT + - CRYPTO_DETERMINISTIC_CONFIG + - REDACT_IMAGE + description: description: >- - The type of events to consider when deciding if the table's schema - has been modified and should have the profile updated. Defaults to - NEW_COLUMNS. - type: array - frequency: + A description of the transformation. This is empty for a + RECORD_SUPPRESSION, or is the output of calling toString() on the + `PrimitiveTransformation` protocol buffer message for any other type + of transformation. + type: string + condition: + description: >- + A human-readable string representation of the `RecordCondition` + corresponding to this transformation. Set if a `RecordCondition` was + used to determine whether or not to apply this transformation. + Examples: * (age_field > 85) * (age_field <= 18) * (zip_field + exists) * (zip_field == 01234) && (city_field != "Springville") * + (zip_field == 01234) && (age_field <= 18) && (city_field exists) + type: string + infoType: + description: Set if the transformation was limited to a specific `InfoType`. + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + GooglePrivacyDlpV2TransformationResultStatus: + id: GooglePrivacyDlpV2TransformationResultStatus + description: The outcome of a transformation. + type: object + properties: + resultStatusType: description: >- - How frequently profiles may be updated when schemas are modified. - Defaults to monthly. + Transformation result status type, this will be either SUCCESS, or + it will be the reason for why the transformation was not completely + successful. type: string enumDescriptions: - - Unspecified. - - After the data profile is created, it will never be updated. - - The data profile can be updated up to once every 24 hours. - - The data profile can be updated up to once every 30 days. Default. + - Unused. + - >- + This will be set when a finding could not be transformed (i.e. + outside user set bucket range). + - >- + This will be set when a BigQuery transformation was successful but + could not be stored back in BigQuery because the transformed row + exceeds BigQuery's max row size. + - >- + This will be set when there is a finding in the custom metadata of + a file, but at the write time of the transformed file, this key / + value pair is unretrievable. + - >- + This will be set when the transformation and storing of it is + successful. enum: - - UPDATE_FREQUENCY_UNSPECIFIED - - UPDATE_FREQUENCY_NEVER - - UPDATE_FREQUENCY_DAILY - - UPDATE_FREQUENCY_MONTHLY - id: GooglePrivacyDlpV2DiscoverySchemaModifiedCadence - type: object - GooglePrivacyDlpV2PublishToChronicle: - type: object - id: GooglePrivacyDlpV2PublishToChronicle - properties: {} - description: Message expressing intention to publish to Google Security Operations. - GooglePrivacyDlpV2DeidentifyContentRequest: + - STATE_TYPE_UNSPECIFIED + - INVALID_TRANSFORM + - BIGQUERY_MAX_ROW_SIZE_EXCEEDED + - METADATA_UNRETRIEVABLE + - SUCCESS + details: + description: Detailed error codes and messages + $ref: '#/components/schemas/GoogleRpcStatus' + GooglePrivacyDlpV2TransformationLocation: + id: GooglePrivacyDlpV2TransformationLocation + description: Specifies the location of a transformation. type: object - description: Request to de-identify a ContentItem. properties: - item: - description: >- - The item to de-identify. Will be treated as text. This value must be - of type Table if your deidentify_config is a RecordTransformations - object. - $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' - deidentifyTemplateName: + findingId: description: >- - Template to use. Any configuration directly specified in - deidentify_config will override those set in the template. Singular - fields that are set in this request will replace their corresponding - fields in the template. Repeated fields are appended. Singular - sub-messages and groups are recursively merged. + For infotype transformations, link to the corresponding findings ID + so that location information does not need to be duplicated. Each + findings ID correlates to an entry in the findings output table, + this table only gets created when users specify to save findings + (add the save findings action to the request). type: string - deidentifyConfig: - description: >- - Configuration for the de-identification of the content item. Items - specified here will override the template referenced by the - deidentify_template_name argument. - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyConfig' - inspectConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' + recordTransformation: description: >- - Configuration for the inspector. Items specified here will override - the template referenced by the inspect_template_name argument. - locationId: - type: string - description: Deprecated. This field has no effect. - inspectTemplateName: + For record transformations, provide a field and container + information. + $ref: '#/components/schemas/GooglePrivacyDlpV2RecordTransformation' + containerType: description: >- - Template to use. Any configuration directly specified in - inspect_config will override those set in the template. Singular - fields that are set in this request will replace their corresponding - fields in the template. Repeated fields are appended. Singular - sub-messages and groups are recursively merged. + Information about the functionality of the container where this + finding occurred, if available. type: string - id: GooglePrivacyDlpV2DeidentifyContentRequest - GooglePrivacyDlpV2AllText: - type: object - id: GooglePrivacyDlpV2AllText - properties: {} - description: Apply to all text. - GooglePrivacyDlpV2DiscoveryBigQueryFilter: + enumDescriptions: + - Unused. + - Body of a file. + - Metadata for a file. + - A table. + enum: + - TRANSFORM_UNKNOWN_CONTAINER + - TRANSFORM_BODY + - TRANSFORM_METADATA + - TRANSFORM_TABLE + GooglePrivacyDlpV2RecordTransformation: + id: GooglePrivacyDlpV2RecordTransformation + description: The field in a record to transform. type: object - description: >- - Determines what tables will have profiles generated within an - organization or project. Includes the ability to filter by regular - expression patterns on project ID, dataset ID, and table ID. - id: GooglePrivacyDlpV2DiscoveryBigQueryFilter properties: - tables: - description: >- - A specific set of tables for this filter to apply to. A table - collection must be specified in only one filter per config. If a - table id or dataset is empty, Cloud DLP assumes all tables in that - collection must be profiled. Must specify a project ID. - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTableCollection' - otherTables: - description: >- - Catch-all. This should always be the last filter in the list because - anything above it will apply first. Should only appear once in a - configuration. If none is specified, a default one will be added - automatically. - $ref: '#/components/schemas/GooglePrivacyDlpV2AllOtherBigQueryTables' - tableReference: - $ref: '#/components/schemas/GooglePrivacyDlpV2TableReference' - description: >- - The table to scan. Discovery configurations including this can only - include one DiscoveryTarget (the DiscoveryTarget with this - TableReference). - GooglePrivacyDlpV2AllInfoTypes: - type: object - properties: {} - id: GooglePrivacyDlpV2AllInfoTypes - description: Apply transformation to all findings. - GooglePrivacyDlpV2TableOptions: + fieldId: + description: For record transformations, provide a field. + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + containerTimestamp: + description: Findings container modification timestamp, if applicable. + type: string + format: google-datetime + containerVersion: + description: Container version, if available ("generation" for Cloud Storage). + type: string + GooglePrivacyDlpV2SaveToGcsFindingsOutput: + id: GooglePrivacyDlpV2SaveToGcsFindingsOutput + description: >- + Collection of findings saved to a Cloud Storage bucket. This is used as + the proto schema for textproto files created when specifying a cloud + storage path to save Inspect findings. type: object - description: Instructions regarding the table content being inspected. properties: - identifyingFields: - description: >- - The columns that are the primary keys for table objects included in - ContentItem. A copy of this cell's value will stored alongside - alongside each finding so that the finding can be traced to the - specific row it came from. No more than 3 may be provided. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + findings: + description: List of findings. type: array - id: GooglePrivacyDlpV2TableOptions - GooglePrivacyDlpV2ImageRedactionConfig: - description: Configuration for determining how redaction of images should occur. - id: GooglePrivacyDlpV2ImageRedactionConfig + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Finding' + UtilStatusProto: + id: UtilStatusProto + description: Wire-format for a Status object + type: object properties: - redactAllText: - type: boolean + code: description: >- - If true, all text found in the image, regardless whether it matches - an info_type, is redacted. Only one should be provided. - redactionColor: - $ref: '#/components/schemas/GooglePrivacyDlpV2Color' + Numeric code drawn from the space specified below. Often, this is + the canonical error space, and code is drawn from + google3/util/task/codes.proto copybara:strip_begin(b/383363683) + copybara:strip_end_and_replace optional int32 code = 1; + type: integer + format: int32 + space: description: >- - The color to use when redacting content from an image. If not - specified, the default is black. - infoType: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + copybara:strip_begin(b/383363683) Space to which this status belongs + copybara:strip_end_and_replace optional string space = 2; // Space + to which this status belongs + type: string + message: description: >- - Only one per info_type should be provided per request. If not - specified, and redact_all_text is false, the DLP API will redact all - text that it matches against all info_types that are found, but not - specified in another ImageRedactionConfig. - type: object - GooglePrivacyDlpV2HybridInspectJobTriggerRequest: - description: Request to search for potentially sensitive info in a custom location. - properties: - hybridItem: - $ref: '#/components/schemas/GooglePrivacyDlpV2HybridContentItem' - description: The item to inspect. - id: GooglePrivacyDlpV2HybridInspectJobTriggerRequest + Detail message copybara:strip_begin(b/383363683) + copybara:strip_end_and_replace optional string message = 3; + type: string + canonicalCode: + description: >- + copybara:strip_begin(b/383363683) copybara:strip_end_and_replace + optional int32 canonical_code = 6; + type: integer + format: int32 + messageSet: + description: >- + message_set associates an arbitrary proto message with the status. + copybara:strip_begin(b/383363683) copybara:strip_end_and_replace + optional proto2.bridge.MessageSet message_set = 5; + $ref: '#/components/schemas/Proto2BridgeMessageSet' + Proto2BridgeMessageSet: + id: Proto2BridgeMessageSet + deprecated: true + description: >- + This is proto2's version of MessageSet. DEPRECATED: DO NOT USE FOR NEW + FIELDS. If you are using editions or proto2, please make your own + extendable messages for your use case. If you are using proto3, please + use `Any` instead. MessageSet was the implementation of extensions for + proto1. When proto2 was introduced, extensions were implemented as a + first-class feature. This schema for MessageSet was meant to be a + "bridge" solution to migrate MessageSet-bearing messages from proto1 to + proto2. This schema has been open-sourced only to facilitate the + migration of Google products with MessageSet-bearing messages to + open-source environments. type: object + properties: {} parameters: - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - type: string - callback: - description: JSONP - in: query - name: callback - schema: - type: string - 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. + access_token: + description: OAuth access token. in: query - name: quotaUser + name: access_token schema: type: string alt: @@ -8035,16 +8671,16 @@ components: - json - media - proto - prettyPrint: - description: Returns response with indentations and line breaks. + callback: + description: JSONP in: query - name: prettyPrint + name: callback schema: - type: boolean - oauth_token: - description: OAuth 2.0 token for the current user. + type: string + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: oauth_token + name: fields schema: type: string key: @@ -8056,19 +8692,31 @@ components: name: key schema: type: string - _.xgafv: - description: V1 error format. + 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: $.xgafv + name: quotaUser schema: type: string - enum: - - '1' - - '2' - access_token: - description: OAuth access token. + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: access_token + name: upload_protocol schema: type: string uploadType: @@ -8077,241 +8725,344 @@ components: name: uploadType schema: type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + _.xgafv: + description: V1 error format. in: query - name: upload_protocol + name: $.xgafv schema: type: string + enum: + - '1' + - '2' x-stackQL-resources: - stored_info_types: - id: google.dlp.stored_info_types - name: stored_info_types - title: Stored_info_types + content: + id: google.dlp.content + name: content + title: Content methods: - projects_stored_info_types_get: + projects_content_inspect: + operation: + $ref: '#/paths/~1v2~1projects~1{projectsId}~1content:inspect/post' + response: + mediaType: application/json + openAPIDocKey: '200' + projects_content_deidentify: + operation: + $ref: '#/paths/~1v2~1projects~1{projectsId}~1content:deidentify/post' + response: + mediaType: application/json + openAPIDocKey: '200' + projects_content_reidentify: + operation: + $ref: '#/paths/~1v2~1projects~1{projectsId}~1content:reidentify/post' + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_content_inspect: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1storedInfoTypes~1{storedInfoTypesId}/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1content:inspect/post response: mediaType: application/json openAPIDocKey: '200' - projects_stored_info_types_patch: + projects_locations_content_deidentify: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1storedInfoTypes~1{storedInfoTypesId}/patch + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1content:deidentify/post response: mediaType: application/json openAPIDocKey: '200' - projects_stored_info_types_delete: + projects_locations_content_reidentify: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1storedInfoTypes~1{storedInfoTypesId}/delete + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1content:reidentify/post response: mediaType: application/json openAPIDocKey: '200' - projects_stored_info_types_create: + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + image: + id: google.dlp.image + name: image + title: Image + methods: + projects_locations_image_redact: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1storedInfoTypes/post' + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1image:redact/post response: mediaType: application/json openAPIDocKey: '200' - projects_stored_info_types_list: + projects_image_redact: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1storedInfoTypes/get' + $ref: '#/paths/~1v2~1projects~1{projectsId}~1image:redact/post' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.storedInfoTypes - projects_locations_stored_info_types_delete: + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + info_types: + id: google.dlp.info_types + name: info_types + title: Info_types + methods: + projects_locations_info_types_list: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/delete + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1infoTypes/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_stored_info_types_get: + info_types_list: + operation: + $ref: '#/paths/~1v2~1infoTypes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + locations_info_types_list: + operation: + $ref: '#/paths/~1v2~1locations~1{locationsId}~1infoTypes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_info_types_list: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1infoTypes/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_stored_info_types_patch: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/info_types/methods/projects_locations_info_types_list + - $ref: >- + #/components/x-stackQL-resources/info_types/methods/organizations_locations_info_types_list + - $ref: >- + #/components/x-stackQL-resources/info_types/methods/locations_info_types_list + - $ref: >- + #/components/x-stackQL-resources/info_types/methods/info_types_list + insert: [] + update: [] + replace: [] + delete: [] + inspect_templates: + id: google.dlp.inspect_templates + name: inspect_templates + title: Inspect_templates + methods: + projects_locations_inspect_templates_create: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/patch + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1inspectTemplates/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_stored_info_types_list: + projects_locations_inspect_templates_list: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1storedInfoTypes/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1inspectTemplates/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.storedInfoTypes - projects_locations_stored_info_types_create: + objectKey: $.inspectTemplates + projects_locations_inspect_templates_patch: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1storedInfoTypes/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1inspectTemplates~1{inspectTemplatesId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_stored_info_types_list: + projects_locations_inspect_templates_get: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1storedInfoTypes/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1inspectTemplates~1{inspectTemplatesId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.storedInfoTypes - organizations_locations_stored_info_types_create: + projects_locations_inspect_templates_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1storedInfoTypes/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1inspectTemplates~1{inspectTemplatesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_stored_info_types_patch: + projects_inspect_templates_create: + operation: + $ref: '#/paths/~1v2~1projects~1{projectsId}~1inspectTemplates/post' + response: + mediaType: application/json + openAPIDocKey: '200' + projects_inspect_templates_list: + operation: + $ref: '#/paths/~1v2~1projects~1{projectsId}~1inspectTemplates/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.inspectTemplates + projects_inspect_templates_patch: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/patch + #/paths/~1v2~1projects~1{projectsId}~1inspectTemplates~1{inspectTemplatesId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_stored_info_types_delete: + projects_inspect_templates_get: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/delete + #/paths/~1v2~1projects~1{projectsId}~1inspectTemplates~1{inspectTemplatesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_stored_info_types_get: + projects_inspect_templates_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/get + #/paths/~1v2~1projects~1{projectsId}~1inspectTemplates~1{inspectTemplatesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_stored_info_types_list: + organizations_locations_inspect_templates_create: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1storedInfoTypes/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1inspectTemplates/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.storedInfoTypes - organizations_stored_info_types_create: + organizations_locations_inspect_templates_list: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1storedInfoTypes/post + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1inspectTemplates/get response: mediaType: application/json openAPIDocKey: '200' - organizations_stored_info_types_patch: + objectKey: $.inspectTemplates + organizations_locations_inspect_templates_patch: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1storedInfoTypes~1{storedInfoTypesId}/patch + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1inspectTemplates~1{inspectTemplatesId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_stored_info_types_get: + organizations_locations_inspect_templates_get: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1storedInfoTypes~1{storedInfoTypesId}/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1inspectTemplates~1{inspectTemplatesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_stored_info_types_delete: + organizations_locations_inspect_templates_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1storedInfoTypes~1{storedInfoTypesId}/delete + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1inspectTemplates~1{inspectTemplatesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_inspect_templates_create: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1inspectTemplates/post + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_inspect_templates_list: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1inspectTemplates/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.inspectTemplates + organizations_inspect_templates_patch: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1inspectTemplates~1{inspectTemplatesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_inspect_templates_get: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1inspectTemplates~1{inspectTemplatesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_inspect_templates_delete: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1inspectTemplates~1{inspectTemplatesId}/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/projects_locations_stored_info_types_get + #/components/x-stackQL-resources/inspect_templates/methods/projects_locations_inspect_templates_get - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/organizations_locations_stored_info_types_get + #/components/x-stackQL-resources/inspect_templates/methods/organizations_locations_inspect_templates_get - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/projects_stored_info_types_get + #/components/x-stackQL-resources/inspect_templates/methods/projects_locations_inspect_templates_list - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/projects_locations_stored_info_types_list + #/components/x-stackQL-resources/inspect_templates/methods/projects_inspect_templates_get - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/organizations_locations_stored_info_types_list + #/components/x-stackQL-resources/inspect_templates/methods/organizations_locations_inspect_templates_list - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/organizations_stored_info_types_get + #/components/x-stackQL-resources/inspect_templates/methods/organizations_inspect_templates_get - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/projects_stored_info_types_list + #/components/x-stackQL-resources/inspect_templates/methods/projects_inspect_templates_list - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/organizations_stored_info_types_list + #/components/x-stackQL-resources/inspect_templates/methods/organizations_inspect_templates_list insert: - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/projects_locations_stored_info_types_create + #/components/x-stackQL-resources/inspect_templates/methods/projects_locations_inspect_templates_create - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/organizations_locations_stored_info_types_create + #/components/x-stackQL-resources/inspect_templates/methods/organizations_locations_inspect_templates_create - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/projects_stored_info_types_create + #/components/x-stackQL-resources/inspect_templates/methods/projects_inspect_templates_create - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/organizations_stored_info_types_create + #/components/x-stackQL-resources/inspect_templates/methods/organizations_inspect_templates_create update: - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/projects_locations_stored_info_types_patch + #/components/x-stackQL-resources/inspect_templates/methods/projects_locations_inspect_templates_patch - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/organizations_locations_stored_info_types_patch + #/components/x-stackQL-resources/inspect_templates/methods/organizations_locations_inspect_templates_patch - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/projects_stored_info_types_patch + #/components/x-stackQL-resources/inspect_templates/methods/projects_inspect_templates_patch - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/organizations_stored_info_types_patch + #/components/x-stackQL-resources/inspect_templates/methods/organizations_inspect_templates_patch replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/projects_locations_stored_info_types_delete + #/components/x-stackQL-resources/inspect_templates/methods/projects_locations_inspect_templates_delete - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/organizations_locations_stored_info_types_delete + #/components/x-stackQL-resources/inspect_templates/methods/organizations_locations_inspect_templates_delete - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/projects_stored_info_types_delete + #/components/x-stackQL-resources/inspect_templates/methods/projects_inspect_templates_delete - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/organizations_stored_info_types_delete + #/components/x-stackQL-resources/inspect_templates/methods/organizations_inspect_templates_delete deidentify_templates: id: google.dlp.deidentify_templates name: deidentify_templates title: Deidentify_templates methods: - projects_deidentify_templates_patch: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - projects_deidentify_templates_delete: + projects_locations_deidentify_templates_create: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/delete + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1deidentifyTemplates/post response: mediaType: application/json openAPIDocKey: '200' - projects_deidentify_templates_get: + projects_locations_deidentify_templates_list: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - projects_deidentify_templates_create: - operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1deidentifyTemplates/post' - response: - mediaType: application/json - openAPIDocKey: '200' - projects_deidentify_templates_list: - operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1deidentifyTemplates/get' + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1deidentifyTemplates/get response: mediaType: application/json openAPIDocKey: '200' @@ -8337,39 +9088,37 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_locations_deidentify_templates_list: + projects_deidentify_templates_create: operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1deidentifyTemplates/get + $ref: '#/paths/~1v2~1projects~1{projectsId}~1deidentifyTemplates/post' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.deidentifyTemplates - projects_locations_deidentify_templates_create: + projects_deidentify_templates_list: operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1deidentifyTemplates/post + $ref: '#/paths/~1v2~1projects~1{projectsId}~1deidentifyTemplates/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_deidentify_templates_patch: + objectKey: $.deidentifyTemplates + projects_deidentify_templates_patch: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/patch + #/paths/~1v2~1projects~1{projectsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_deidentify_templates_delete: + projects_deidentify_templates_get: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/delete + #/paths/~1v2~1projects~1{projectsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_deidentify_templates_get: + projects_deidentify_templates_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/get + #/paths/~1v2~1projects~1{projectsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/delete response: mediaType: application/json openAPIDocKey: '200' @@ -8388,24 +9137,24 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.deidentifyTemplates - organizations_deidentify_templates_get: + organizations_locations_deidentify_templates_patch: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_deidentify_templates_patch: + organizations_locations_deidentify_templates_get: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/patch + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_deidentify_templates_delete: + organizations_locations_deidentify_templates_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/delete + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/delete response: mediaType: application/json openAPIDocKey: '200' @@ -8424,16 +9173,37 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.deidentifyTemplates + organizations_deidentify_templates_patch: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_deidentify_templates_get: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_deidentify_templates_delete: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/deidentify_templates/methods/projects_locations_deidentify_templates_get - $ref: >- #/components/x-stackQL-resources/deidentify_templates/methods/organizations_locations_deidentify_templates_get - - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/projects_deidentify_templates_get - $ref: >- #/components/x-stackQL-resources/deidentify_templates/methods/projects_locations_deidentify_templates_list + - $ref: >- + #/components/x-stackQL-resources/deidentify_templates/methods/projects_deidentify_templates_get - $ref: >- #/components/x-stackQL-resources/deidentify_templates/methods/organizations_locations_deidentify_templates_list - $ref: >- @@ -8470,647 +9240,609 @@ components: #/components/x-stackQL-resources/deidentify_templates/methods/projects_deidentify_templates_delete - $ref: >- #/components/x-stackQL-resources/deidentify_templates/methods/organizations_deidentify_templates_delete - dlp_jobs: - id: google.dlp.dlp_jobs - name: dlp_jobs - title: Dlp_jobs - methods: - projects_dlp_jobs_create: - operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1dlpJobs/post' - response: - mediaType: application/json - openAPIDocKey: '200' - projects_dlp_jobs_list: - operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1dlpJobs/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.jobs - projects_dlp_jobs_cancel: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1dlpJobs~1{dlpJobsId}:cancel/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_dlp_jobs_delete: - operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1dlpJobs~1{dlpJobsId}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - projects_dlp_jobs_get: - operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1dlpJobs~1{dlpJobsId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_dlp_jobs_hybrid_inspect: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs~1{dlpJobsId}:hybridInspect/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_dlp_jobs_get: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs~1{dlpJobsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_dlp_jobs_delete: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs~1{dlpJobsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_dlp_jobs_finish: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs~1{dlpJobsId}:finish/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_dlp_jobs_cancel: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs~1{dlpJobsId}:cancel/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_dlp_jobs_create: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_dlp_jobs_list: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.jobs - organizations_locations_dlp_jobs_list: - operation: - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1dlpJobs/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.jobs - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/dlp_jobs/methods/projects_locations_dlp_jobs_get - - $ref: >- - #/components/x-stackQL-resources/dlp_jobs/methods/projects_dlp_jobs_get - - $ref: >- - #/components/x-stackQL-resources/dlp_jobs/methods/projects_locations_dlp_jobs_list - - $ref: >- - #/components/x-stackQL-resources/dlp_jobs/methods/organizations_locations_dlp_jobs_list - - $ref: >- - #/components/x-stackQL-resources/dlp_jobs/methods/projects_dlp_jobs_list - insert: - - $ref: >- - #/components/x-stackQL-resources/dlp_jobs/methods/projects_locations_dlp_jobs_create - - $ref: >- - #/components/x-stackQL-resources/dlp_jobs/methods/projects_dlp_jobs_create - update: [] - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/dlp_jobs/methods/projects_locations_dlp_jobs_delete - - $ref: >- - #/components/x-stackQL-resources/dlp_jobs/methods/projects_dlp_jobs_delete - inspect_templates: - id: google.dlp.inspect_templates - name: inspect_templates - title: Inspect_templates + job_triggers: + id: google.dlp.job_triggers + name: job_triggers + title: Job_triggers methods: - projects_inspect_templates_get: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1inspectTemplates~1{inspectTemplatesId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - projects_inspect_templates_patch: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1inspectTemplates~1{inspectTemplatesId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - projects_inspect_templates_delete: + projects_locations_job_triggers_create: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1inspectTemplates~1{inspectTemplatesId}/delete + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers/post response: mediaType: application/json openAPIDocKey: '200' - projects_inspect_templates_create: + projects_locations_job_triggers_list: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1inspectTemplates/post' + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers/get response: mediaType: application/json openAPIDocKey: '200' - projects_inspect_templates_list: + objectKey: $.jobTriggers + projects_locations_job_triggers_patch: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1inspectTemplates/get' + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/patch response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.inspectTemplates - projects_locations_inspect_templates_create: + projects_locations_job_triggers_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1inspectTemplates/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_inspect_templates_list: + projects_locations_job_triggers_delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1inspectTemplates/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.inspectTemplates - projects_locations_inspect_templates_get: + projects_locations_job_triggers_hybrid_inspect: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1inspectTemplates~1{inspectTemplatesId}/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}:hybridInspect/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_inspect_templates_patch: + projects_locations_job_triggers_activate: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1inspectTemplates~1{inspectTemplatesId}/patch + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}:activate/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_inspect_templates_delete: + projects_job_triggers_create: operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1inspectTemplates~1{inspectTemplatesId}/delete + $ref: '#/paths/~1v2~1projects~1{projectsId}~1jobTriggers/post' response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_inspect_templates_get: + projects_job_triggers_list: operation: - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1inspectTemplates~1{inspectTemplatesId}/get + $ref: '#/paths/~1v2~1projects~1{projectsId}~1jobTriggers/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_inspect_templates_patch: + objectKey: $.jobTriggers + projects_job_triggers_patch: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1inspectTemplates~1{inspectTemplatesId}/patch + #/paths/~1v2~1projects~1{projectsId}~1jobTriggers~1{jobTriggersId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_inspect_templates_delete: + projects_job_triggers_get: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1inspectTemplates~1{inspectTemplatesId}/delete + #/paths/~1v2~1projects~1{projectsId}~1jobTriggers~1{jobTriggersId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_inspect_templates_list: + projects_job_triggers_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1inspectTemplates/get + #/paths/~1v2~1projects~1{projectsId}~1jobTriggers~1{jobTriggersId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.inspectTemplates - organizations_locations_inspect_templates_create: + projects_job_triggers_activate: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1inspectTemplates/post + #/paths/~1v2~1projects~1{projectsId}~1jobTriggers~1{jobTriggersId}:activate/post response: mediaType: application/json openAPIDocKey: '200' - organizations_inspect_templates_get: + organizations_locations_job_triggers_create: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1inspectTemplates~1{inspectTemplatesId}/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1jobTriggers/post response: mediaType: application/json openAPIDocKey: '200' - organizations_inspect_templates_delete: + organizations_locations_job_triggers_list: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1inspectTemplates~1{inspectTemplatesId}/delete + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1jobTriggers/get response: mediaType: application/json openAPIDocKey: '200' - organizations_inspect_templates_patch: + objectKey: $.jobTriggers + organizations_locations_job_triggers_patch: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1inspectTemplates~1{inspectTemplatesId}/patch + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_inspect_templates_list: + organizations_locations_job_triggers_get: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1inspectTemplates/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.inspectTemplates - organizations_inspect_templates_create: + organizations_locations_job_triggers_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1inspectTemplates/post + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/projects_locations_inspect_templates_get - - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/organizations_locations_inspect_templates_get - - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/projects_inspect_templates_get + #/components/x-stackQL-resources/job_triggers/methods/projects_locations_job_triggers_get - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/projects_locations_inspect_templates_list + #/components/x-stackQL-resources/job_triggers/methods/organizations_locations_job_triggers_get - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/organizations_locations_inspect_templates_list + #/components/x-stackQL-resources/job_triggers/methods/projects_locations_job_triggers_list - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/organizations_inspect_templates_get + #/components/x-stackQL-resources/job_triggers/methods/projects_job_triggers_get - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/projects_inspect_templates_list + #/components/x-stackQL-resources/job_triggers/methods/organizations_locations_job_triggers_list - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/organizations_inspect_templates_list + #/components/x-stackQL-resources/job_triggers/methods/projects_job_triggers_list insert: - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/projects_locations_inspect_templates_create - - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/organizations_locations_inspect_templates_create + #/components/x-stackQL-resources/job_triggers/methods/projects_locations_job_triggers_create - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/projects_inspect_templates_create + #/components/x-stackQL-resources/job_triggers/methods/organizations_locations_job_triggers_create - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/organizations_inspect_templates_create + #/components/x-stackQL-resources/job_triggers/methods/projects_job_triggers_create update: - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/projects_locations_inspect_templates_patch - - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/organizations_locations_inspect_templates_patch + #/components/x-stackQL-resources/job_triggers/methods/projects_locations_job_triggers_patch - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/projects_inspect_templates_patch + #/components/x-stackQL-resources/job_triggers/methods/organizations_locations_job_triggers_patch - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/organizations_inspect_templates_patch + #/components/x-stackQL-resources/job_triggers/methods/projects_job_triggers_patch replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/projects_locations_inspect_templates_delete - - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/organizations_locations_inspect_templates_delete + #/components/x-stackQL-resources/job_triggers/methods/projects_locations_job_triggers_delete - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/projects_inspect_templates_delete + #/components/x-stackQL-resources/job_triggers/methods/organizations_locations_job_triggers_delete - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/organizations_inspect_templates_delete - job_triggers: - id: google.dlp.job_triggers - name: job_triggers - title: Job_triggers + #/components/x-stackQL-resources/job_triggers/methods/projects_job_triggers_delete + discovery_configs: + id: google.dlp.discovery_configs + name: discovery_configs + title: Discovery_configs methods: - projects_job_triggers_list: + projects_locations_discovery_configs_create: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1jobTriggers/get' + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryConfigs/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.jobTriggers - projects_job_triggers_create: + projects_locations_discovery_configs_list: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1jobTriggers/post' + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryConfigs/get response: mediaType: application/json openAPIDocKey: '200' - projects_job_triggers_get: + objectKey: $.discoveryConfigs + projects_locations_discovery_configs_patch: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1jobTriggers~1{jobTriggersId}/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_job_triggers_delete: + projects_locations_discovery_configs_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1jobTriggers~1{jobTriggersId}/delete + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_job_triggers_patch: + projects_locations_discovery_configs_delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1jobTriggers~1{jobTriggersId}/patch + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_job_triggers_activate: + organizations_locations_discovery_configs_create: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1jobTriggers~1{jobTriggersId}:activate/post + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1discoveryConfigs/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_job_triggers_patch: + organizations_locations_discovery_configs_list: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/patch + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1discoveryConfigs/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_job_triggers_get: + objectKey: $.discoveryConfigs + organizations_locations_discovery_configs_patch: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_job_triggers_delete: + organizations_locations_discovery_configs_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/delete + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_job_triggers_list: + organizations_locations_discovery_configs_delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.jobTriggers - projects_locations_job_triggers_create: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/discovery_configs/methods/projects_locations_discovery_configs_get + - $ref: >- + #/components/x-stackQL-resources/discovery_configs/methods/organizations_locations_discovery_configs_get + - $ref: >- + #/components/x-stackQL-resources/discovery_configs/methods/projects_locations_discovery_configs_list + - $ref: >- + #/components/x-stackQL-resources/discovery_configs/methods/organizations_locations_discovery_configs_list + insert: + - $ref: >- + #/components/x-stackQL-resources/discovery_configs/methods/projects_locations_discovery_configs_create + - $ref: >- + #/components/x-stackQL-resources/discovery_configs/methods/organizations_locations_discovery_configs_create + update: + - $ref: >- + #/components/x-stackQL-resources/discovery_configs/methods/projects_locations_discovery_configs_patch + - $ref: >- + #/components/x-stackQL-resources/discovery_configs/methods/organizations_locations_discovery_configs_patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/discovery_configs/methods/projects_locations_discovery_configs_delete + - $ref: >- + #/components/x-stackQL-resources/discovery_configs/methods/organizations_locations_discovery_configs_delete + dlp_jobs: + id: google.dlp.dlp_jobs + name: dlp_jobs + title: Dlp_jobs + methods: + projects_locations_dlp_jobs_create: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_job_triggers_hybrid_inspect: + projects_locations_dlp_jobs_list: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}:hybridInspect/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_job_triggers_activate: + objectKey: $.jobs + projects_locations_dlp_jobs_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}:activate/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs~1{dlpJobsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_job_triggers_create: + projects_locations_dlp_jobs_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1jobTriggers/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs~1{dlpJobsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_job_triggers_list: + projects_locations_dlp_jobs_cancel: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1jobTriggers/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs~1{dlpJobsId}:cancel/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_dlp_jobs_hybrid_inspect: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs~1{dlpJobsId}:hybridInspect/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_dlp_jobs_finish: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs~1{dlpJobsId}:finish/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_dlp_jobs_create: + operation: + $ref: '#/paths/~1v2~1projects~1{projectsId}~1dlpJobs/post' + response: + mediaType: application/json + openAPIDocKey: '200' + projects_dlp_jobs_list: + operation: + $ref: '#/paths/~1v2~1projects~1{projectsId}~1dlpJobs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.jobs + projects_dlp_jobs_get: + operation: + $ref: '#/paths/~1v2~1projects~1{projectsId}~1dlpJobs~1{dlpJobsId}/get' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.jobTriggers - organizations_locations_job_triggers_patch: + projects_dlp_jobs_delete: operation: - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/patch + $ref: '#/paths/~1v2~1projects~1{projectsId}~1dlpJobs~1{dlpJobsId}/delete' response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_job_triggers_get: + projects_dlp_jobs_cancel: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/get + #/paths/~1v2~1projects~1{projectsId}~1dlpJobs~1{dlpJobsId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_job_triggers_delete: + organizations_locations_dlp_jobs_list: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/delete + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1dlpJobs/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.jobs sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/projects_locations_job_triggers_get - - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/organizations_locations_job_triggers_get + #/components/x-stackQL-resources/dlp_jobs/methods/projects_locations_dlp_jobs_get - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/projects_job_triggers_get + #/components/x-stackQL-resources/dlp_jobs/methods/projects_locations_dlp_jobs_list - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/projects_locations_job_triggers_list + #/components/x-stackQL-resources/dlp_jobs/methods/projects_dlp_jobs_get - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/organizations_locations_job_triggers_list + #/components/x-stackQL-resources/dlp_jobs/methods/organizations_locations_dlp_jobs_list - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/projects_job_triggers_list + #/components/x-stackQL-resources/dlp_jobs/methods/projects_dlp_jobs_list insert: - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/projects_locations_job_triggers_create - - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/organizations_locations_job_triggers_create - - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/projects_job_triggers_create - update: - - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/projects_locations_job_triggers_patch - - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/organizations_locations_job_triggers_patch + #/components/x-stackQL-resources/dlp_jobs/methods/projects_locations_dlp_jobs_create - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/projects_job_triggers_patch + #/components/x-stackQL-resources/dlp_jobs/methods/projects_dlp_jobs_create + update: [] replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/projects_locations_job_triggers_delete - - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/organizations_locations_job_triggers_delete + #/components/x-stackQL-resources/dlp_jobs/methods/projects_locations_dlp_jobs_delete - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/projects_job_triggers_delete - image: - id: google.dlp.image - name: image - title: Image + #/components/x-stackQL-resources/dlp_jobs/methods/projects_dlp_jobs_delete + stored_info_types: + id: google.dlp.stored_info_types + name: stored_info_types + title: Stored_info_types methods: - projects_image_redact: + projects_locations_stored_info_types_create: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1image:redact/post' + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1storedInfoTypes/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_image_redact: + projects_locations_stored_info_types_list: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1image:redact/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1storedInfoTypes/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: [] - connections: - id: google.dlp.connections - name: connections - title: Connections - methods: - projects_locations_connections_search: + objectKey: $.storedInfoTypes + projects_locations_stored_info_types_patch: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections:search/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_connections_create: + projects_locations_stored_info_types_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_connections_list: + projects_locations_stored_info_types_delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.connections - projects_locations_connections_patch: + projects_stored_info_types_create: + operation: + $ref: '#/paths/~1v2~1projects~1{projectsId}~1storedInfoTypes/post' + response: + mediaType: application/json + openAPIDocKey: '200' + projects_stored_info_types_list: + operation: + $ref: '#/paths/~1v2~1projects~1{projectsId}~1storedInfoTypes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.storedInfoTypes + projects_stored_info_types_patch: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}/patch + #/paths/~1v2~1projects~1{projectsId}~1storedInfoTypes~1{storedInfoTypesId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_connections_delete: + projects_stored_info_types_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}/delete + #/paths/~1v2~1projects~1{projectsId}~1storedInfoTypes~1{storedInfoTypesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_connections_get: + projects_stored_info_types_delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}/get + #/paths/~1v2~1projects~1{projectsId}~1storedInfoTypes~1{storedInfoTypesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_connections_search: + organizations_locations_stored_info_types_create: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1connections:search/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1storedInfoTypes/post response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_connections_delete: + organizations_locations_stored_info_types_list: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1connections~1{connectionsId}/delete + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1storedInfoTypes/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_connections_patch: + objectKey: $.storedInfoTypes + organizations_locations_stored_info_types_patch: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1connections~1{connectionsId}/patch + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_connections_get: + organizations_locations_stored_info_types_get: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1connections~1{connectionsId}/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_connections_create: + organizations_locations_stored_info_types_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1connections/post + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_connections_list: + organizations_stored_info_types_create: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1connections/get + #/paths/~1v2~1organizations~1{organizationsId}~1storedInfoTypes/post + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_stored_info_types_list: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1storedInfoTypes/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.storedInfoTypes + organizations_stored_info_types_patch: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1storedInfoTypes~1{storedInfoTypesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_stored_info_types_get: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1storedInfoTypes~1{storedInfoTypesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_stored_info_types_delete: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1storedInfoTypes~1{storedInfoTypesId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.connections sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/connections/methods/projects_locations_connections_get + #/components/x-stackQL-resources/stored_info_types/methods/projects_locations_stored_info_types_get - $ref: >- - #/components/x-stackQL-resources/connections/methods/organizations_locations_connections_get + #/components/x-stackQL-resources/stored_info_types/methods/organizations_locations_stored_info_types_get - $ref: >- - #/components/x-stackQL-resources/connections/methods/projects_locations_connections_list + #/components/x-stackQL-resources/stored_info_types/methods/projects_locations_stored_info_types_list - $ref: >- - #/components/x-stackQL-resources/connections/methods/organizations_locations_connections_list + #/components/x-stackQL-resources/stored_info_types/methods/projects_stored_info_types_get + - $ref: >- + #/components/x-stackQL-resources/stored_info_types/methods/organizations_locations_stored_info_types_list + - $ref: >- + #/components/x-stackQL-resources/stored_info_types/methods/organizations_stored_info_types_get + - $ref: >- + #/components/x-stackQL-resources/stored_info_types/methods/projects_stored_info_types_list + - $ref: >- + #/components/x-stackQL-resources/stored_info_types/methods/organizations_stored_info_types_list insert: - $ref: >- - #/components/x-stackQL-resources/connections/methods/projects_locations_connections_create + #/components/x-stackQL-resources/stored_info_types/methods/projects_locations_stored_info_types_create - $ref: >- - #/components/x-stackQL-resources/connections/methods/organizations_locations_connections_create + #/components/x-stackQL-resources/stored_info_types/methods/organizations_locations_stored_info_types_create + - $ref: >- + #/components/x-stackQL-resources/stored_info_types/methods/projects_stored_info_types_create + - $ref: >- + #/components/x-stackQL-resources/stored_info_types/methods/organizations_stored_info_types_create update: - $ref: >- - #/components/x-stackQL-resources/connections/methods/projects_locations_connections_patch + #/components/x-stackQL-resources/stored_info_types/methods/projects_locations_stored_info_types_patch - $ref: >- - #/components/x-stackQL-resources/connections/methods/organizations_locations_connections_patch + #/components/x-stackQL-resources/stored_info_types/methods/organizations_locations_stored_info_types_patch + - $ref: >- + #/components/x-stackQL-resources/stored_info_types/methods/projects_stored_info_types_patch + - $ref: >- + #/components/x-stackQL-resources/stored_info_types/methods/organizations_stored_info_types_patch replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/connections/methods/projects_locations_connections_delete + #/components/x-stackQL-resources/stored_info_types/methods/projects_locations_stored_info_types_delete - $ref: >- - #/components/x-stackQL-resources/connections/methods/organizations_locations_connections_delete + #/components/x-stackQL-resources/stored_info_types/methods/organizations_locations_stored_info_types_delete + - $ref: >- + #/components/x-stackQL-resources/stored_info_types/methods/projects_stored_info_types_delete + - $ref: >- + #/components/x-stackQL-resources/stored_info_types/methods/organizations_stored_info_types_delete project_data_profiles: id: google.dlp.project_data_profiles name: project_data_profiles title: Project_data_profiles methods: - projects_locations_project_data_profiles_get: + projects_locations_project_data_profiles_list: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1projectDataProfiles~1{projectDataProfilesId}/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1projectDataProfiles/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_project_data_profiles_list: + objectKey: $.projectDataProfiles + projects_locations_project_data_profiles_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1projectDataProfiles/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1projectDataProfiles~1{projectDataProfilesId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.projectDataProfiles organizations_locations_project_data_profiles_list: operation: $ref: >- @@ -9140,109 +9872,73 @@ components: update: [] replace: [] delete: [] - discovery_configs: - id: google.dlp.discovery_configs - name: discovery_configs - title: Discovery_configs + table_data_profiles: + id: google.dlp.table_data_profiles + name: table_data_profiles + title: Table_data_profiles methods: - projects_locations_discovery_configs_get: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_discovery_configs_delete: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_discovery_configs_patch: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_discovery_configs_create: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryConfigs/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_discovery_configs_list: + projects_locations_table_data_profiles_list: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryConfigs/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1tableDataProfiles/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.discoveryConfigs - organizations_locations_discovery_configs_get: + objectKey: $.tableDataProfiles + projects_locations_table_data_profiles_get: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1tableDataProfiles~1{tableDataProfilesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_discovery_configs_delete: + projects_locations_table_data_profiles_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/delete + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1tableDataProfiles~1{tableDataProfilesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_discovery_configs_patch: + organizations_locations_table_data_profiles_list: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/patch + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1tableDataProfiles/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_discovery_configs_list: + objectKey: $.tableDataProfiles + organizations_locations_table_data_profiles_get: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1discoveryConfigs/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1tableDataProfiles~1{tableDataProfilesId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.discoveryConfigs - organizations_locations_discovery_configs_create: + organizations_locations_table_data_profiles_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1discoveryConfigs/post + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1tableDataProfiles~1{tableDataProfilesId}/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/discovery_configs/methods/projects_locations_discovery_configs_get - - $ref: >- - #/components/x-stackQL-resources/discovery_configs/methods/organizations_locations_discovery_configs_get - - $ref: >- - #/components/x-stackQL-resources/discovery_configs/methods/projects_locations_discovery_configs_list - - $ref: >- - #/components/x-stackQL-resources/discovery_configs/methods/organizations_locations_discovery_configs_list - insert: - - $ref: >- - #/components/x-stackQL-resources/discovery_configs/methods/projects_locations_discovery_configs_create + #/components/x-stackQL-resources/table_data_profiles/methods/projects_locations_table_data_profiles_get - $ref: >- - #/components/x-stackQL-resources/discovery_configs/methods/organizations_locations_discovery_configs_create - update: + #/components/x-stackQL-resources/table_data_profiles/methods/organizations_locations_table_data_profiles_get - $ref: >- - #/components/x-stackQL-resources/discovery_configs/methods/projects_locations_discovery_configs_patch + #/components/x-stackQL-resources/table_data_profiles/methods/projects_locations_table_data_profiles_list - $ref: >- - #/components/x-stackQL-resources/discovery_configs/methods/organizations_locations_discovery_configs_patch + #/components/x-stackQL-resources/table_data_profiles/methods/organizations_locations_table_data_profiles_list + insert: [] + update: [] replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/discovery_configs/methods/projects_locations_discovery_configs_delete + #/components/x-stackQL-resources/table_data_profiles/methods/projects_locations_table_data_profiles_delete - $ref: >- - #/components/x-stackQL-resources/discovery_configs/methods/organizations_locations_discovery_configs_delete + #/components/x-stackQL-resources/table_data_profiles/methods/organizations_locations_table_data_profiles_delete column_data_profiles: id: google.dlp.column_data_profiles name: column_data_profiles @@ -9292,237 +9988,221 @@ components: update: [] replace: [] delete: [] - table_data_profiles: - id: google.dlp.table_data_profiles - name: table_data_profiles - title: Table_data_profiles + file_store_data_profiles: + id: google.dlp.file_store_data_profiles + name: file_store_data_profiles + title: File_store_data_profiles methods: - projects_locations_table_data_profiles_delete: + projects_locations_file_store_data_profiles_list: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1tableDataProfiles~1{tableDataProfilesId}/delete + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1fileStoreDataProfiles/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_table_data_profiles_get: + objectKey: $.fileStoreDataProfiles + projects_locations_file_store_data_profiles_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1tableDataProfiles~1{tableDataProfilesId}/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1fileStoreDataProfiles~1{fileStoreDataProfilesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_table_data_profiles_list: + projects_locations_file_store_data_profiles_delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1tableDataProfiles/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1fileStoreDataProfiles~1{fileStoreDataProfilesId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.tableDataProfiles - organizations_locations_table_data_profiles_delete: + organizations_locations_file_store_data_profiles_list: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1tableDataProfiles~1{tableDataProfilesId}/delete + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1fileStoreDataProfiles/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_table_data_profiles_get: + objectKey: $.fileStoreDataProfiles + organizations_locations_file_store_data_profiles_get: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1tableDataProfiles~1{tableDataProfilesId}/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1fileStoreDataProfiles~1{fileStoreDataProfilesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_table_data_profiles_list: + organizations_locations_file_store_data_profiles_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1tableDataProfiles/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1fileStoreDataProfiles~1{fileStoreDataProfilesId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.tableDataProfiles sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/table_data_profiles/methods/projects_locations_table_data_profiles_get + #/components/x-stackQL-resources/file_store_data_profiles/methods/projects_locations_file_store_data_profiles_get - $ref: >- - #/components/x-stackQL-resources/table_data_profiles/methods/organizations_locations_table_data_profiles_get + #/components/x-stackQL-resources/file_store_data_profiles/methods/organizations_locations_file_store_data_profiles_get - $ref: >- - #/components/x-stackQL-resources/table_data_profiles/methods/projects_locations_table_data_profiles_list + #/components/x-stackQL-resources/file_store_data_profiles/methods/projects_locations_file_store_data_profiles_list - $ref: >- - #/components/x-stackQL-resources/table_data_profiles/methods/organizations_locations_table_data_profiles_list + #/components/x-stackQL-resources/file_store_data_profiles/methods/organizations_locations_file_store_data_profiles_list insert: [] update: [] replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/table_data_profiles/methods/projects_locations_table_data_profiles_delete + #/components/x-stackQL-resources/file_store_data_profiles/methods/projects_locations_file_store_data_profiles_delete - $ref: >- - #/components/x-stackQL-resources/table_data_profiles/methods/organizations_locations_table_data_profiles_delete - content: - id: google.dlp.content - name: content - title: Content + #/components/x-stackQL-resources/file_store_data_profiles/methods/organizations_locations_file_store_data_profiles_delete + connections: + id: google.dlp.connections + name: connections + title: Connections methods: - projects_locations_content_reidentify: + projects_locations_connections_create: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1content:reidentify/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_content_deidentify: + projects_locations_connections_list: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1content:deidentify/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_content_inspect: + objectKey: $.connections + projects_locations_connections_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1content:inspect/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_content_inspect: + projects_locations_connections_delete: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1content:inspect/post' + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_content_deidentify: + projects_locations_connections_patch: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1content:deidentify/post' + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_content_reidentify: + projects_locations_connections_search: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1content:reidentify/post' + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections:search/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: [] - file_store_data_profiles: - id: google.dlp.file_store_data_profiles - name: file_store_data_profiles - title: File_store_data_profiles - methods: - projects_locations_file_store_data_profiles_get: + organizations_locations_connections_create: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1fileStoreDataProfiles~1{fileStoreDataProfilesId}/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1connections/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_file_store_data_profiles_delete: + organizations_locations_connections_list: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1fileStoreDataProfiles~1{fileStoreDataProfilesId}/delete + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1connections/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_file_store_data_profiles_list: + objectKey: $.connections + organizations_locations_connections_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1fileStoreDataProfiles/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1connections~1{connectionsId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.fileStoreDataProfiles - organizations_locations_file_store_data_profiles_get: + organizations_locations_connections_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1fileStoreDataProfiles~1{fileStoreDataProfilesId}/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1connections~1{connectionsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_file_store_data_profiles_delete: + organizations_locations_connections_patch: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1fileStoreDataProfiles~1{fileStoreDataProfilesId}/delete + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1connections~1{connectionsId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_file_store_data_profiles_list: + organizations_locations_connections_search: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1fileStoreDataProfiles/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1connections:search/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.fileStoreDataProfiles sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/file_store_data_profiles/methods/projects_locations_file_store_data_profiles_get + #/components/x-stackQL-resources/connections/methods/projects_locations_connections_get - $ref: >- - #/components/x-stackQL-resources/file_store_data_profiles/methods/organizations_locations_file_store_data_profiles_get + #/components/x-stackQL-resources/connections/methods/organizations_locations_connections_get - $ref: >- - #/components/x-stackQL-resources/file_store_data_profiles/methods/projects_locations_file_store_data_profiles_list + #/components/x-stackQL-resources/connections/methods/projects_locations_connections_list - $ref: >- - #/components/x-stackQL-resources/file_store_data_profiles/methods/organizations_locations_file_store_data_profiles_list - insert: [] - update: [] - replace: [] - delete: + #/components/x-stackQL-resources/connections/methods/organizations_locations_connections_list + insert: - $ref: >- - #/components/x-stackQL-resources/file_store_data_profiles/methods/projects_locations_file_store_data_profiles_delete + #/components/x-stackQL-resources/connections/methods/projects_locations_connections_create - $ref: >- - #/components/x-stackQL-resources/file_store_data_profiles/methods/organizations_locations_file_store_data_profiles_delete - info_types: - id: google.dlp.info_types - name: info_types - title: Info_types - methods: - info_types_list: - operation: - $ref: '#/paths/~1v2~1infoTypes/get' - response: - mediaType: application/json - openAPIDocKey: '200' - locations_info_types_list: - operation: - $ref: '#/paths/~1v2~1locations~1{locationsId}~1infoTypes/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: + #/components/x-stackQL-resources/connections/methods/organizations_locations_connections_create + update: - $ref: >- - #/components/x-stackQL-resources/info_types/methods/locations_info_types_list + #/components/x-stackQL-resources/connections/methods/projects_locations_connections_patch - $ref: >- - #/components/x-stackQL-resources/info_types/methods/info_types_list - insert: [] - update: [] + #/components/x-stackQL-resources/connections/methods/organizations_locations_connections_patch replace: [] - delete: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/connections/methods/projects_locations_connections_delete + - $ref: >- + #/components/x-stackQL-resources/connections/methods/organizations_locations_connections_delete paths: - /v2/projects/{projectsId}/storedInfoTypes/{storedInfoTypesId}: + /v2/projects/{projectsId}/content:inspect: parameters: &ref_1 - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - get: + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' + post: description: >- - Gets a stored infoType. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes - to learn more. - operationId: dlp.projects.storedInfoTypes.get + Finds potentially sensitive info in content. This method has limits on + input size, processing time, and output size. When no InfoTypes or + CustomInfoTypes are specified in this request, the system will + automatically choose what detectors to run. By default this may be all + types, but may change over time as detectors are updated. For how to + guides, see + https://cloud.google.com/sensitive-data-protection/docs/inspecting-images + and + https://cloud.google.com/sensitive-data-protection/docs/inspecting-text, + operationId: dlp.projects.content.inspect + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectContentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9534,31 +10214,30 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectContentResponse' parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: storedInfoTypesId - required: true - schema: - type: string - patch: + /v2/projects/{projectsId}/content:deidentify: + parameters: *ref_1 + post: description: >- - Updates the stored infoType by creating a new version. The existing - version will continue to be used until the new version is ready. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes - to learn more. - operationId: dlp.projects.storedInfoTypes.patch + De-identifies potentially sensitive info from a ContentItem. This method + has limits on input size and output size. See + https://cloud.google.com/sensitive-data-protection/docs/deidentify-sensitive-data + to learn more. When no InfoTypes or CustomInfoTypes are specified in + this request, the system will automatically choose what detectors to + run. By default this may be all types, but may change over time as + detectors are updated. + operationId: dlp.projects.content.deidentify requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateStoredInfoTypeRequest + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyContentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9570,24 +10249,27 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DeidentifyContentResponse parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: storedInfoTypesId - required: true - schema: - type: string - delete: + /v2/projects/{projectsId}/content:reidentify: + parameters: *ref_1 + post: description: >- - Deletes a stored infoType. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + Re-identifies content that has been de-identified. See + https://cloud.google.com/sensitive-data-protection/docs/pseudonymization#re-identification_in_free_text_code_example to learn more. - operationId: dlp.projects.storedInfoTypes.delete + operationId: dlp.projects.content.reidentify + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2ReidentifyContentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9599,32 +10281,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ReidentifyContentResponse parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: storedInfoTypesId - required: true - schema: - type: string - /v2/projects/{projectsId}/storedInfoTypes: + /v2/projects/{projectsId}/locations/{locationsId}/content:inspect: parameters: *ref_1 post: description: >- - Creates a pre-built stored infoType to be used for inspection. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes - to learn more. - operationId: dlp.projects.storedInfoTypes.create + Finds potentially sensitive info in content. This method has limits on + input size, processing time, and output size. When no InfoTypes or + CustomInfoTypes are specified in this request, the system will + automatically choose what detectors to run. By default this may be all + types, but may change over time as detectors are updated. For how to + guides, see + https://cloud.google.com/sensitive-data-protection/docs/inspecting-images + and + https://cloud.google.com/sensitive-data-protection/docs/inspecting-text, + operationId: dlp.projects.locations.content.inspect requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateStoredInfoTypeRequest + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectContentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9636,19 +10319,35 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectContentResponse' parameters: - in: path name: projectsId required: true schema: type: string - get: + - in: path + name: locationsId + required: true + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/content:deidentify: + parameters: *ref_1 + post: description: >- - Lists stored infoTypes. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes - to learn more. - operationId: dlp.projects.storedInfoTypes.list + De-identifies potentially sensitive info from a ContentItem. This method + has limits on input size and output size. See + https://cloud.google.com/sensitive-data-protection/docs/deidentify-sensitive-data + to learn more. When no InfoTypes or CustomInfoTypes are specified in + this request, the system will automatically choose what detectors to + run. By default this may be all types, but may change over time as + detectors are updated. + operationId: dlp.projects.locations.content.deidentify + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyContentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9661,44 +10360,31 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListStoredInfoTypesResponse + #/components/schemas/GooglePrivacyDlpV2DeidentifyContentResponse parameters: - in: path name: projectsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: locationId - schema: - type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken + - in: path + name: locationsId + required: true schema: type: string - /v2/projects/{projectsId}/deidentifyTemplates/{deidentifyTemplatesId}: + /v2/projects/{projectsId}/locations/{locationsId}/content:reidentify: parameters: *ref_1 - patch: + post: description: >- - Updates the DeidentifyTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + Re-identifies content that has been de-identified. See + https://cloud.google.com/sensitive-data-protection/docs/pseudonymization#re-identification_in_free_text_code_example to learn more. - operationId: dlp.projects.deidentifyTemplates.patch + operationId: dlp.projects.locations.content.reidentify requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest + $ref: '#/components/schemas/GooglePrivacyDlpV2ReidentifyContentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9710,7 +10396,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ReidentifyContentResponse parameters: - in: path name: projectsId @@ -9718,16 +10405,28 @@ paths: schema: type: string - in: path - name: deidentifyTemplatesId + name: locationsId required: true schema: type: string - delete: + /v2/projects/{projectsId}/locations/{locationsId}/image:redact: + parameters: *ref_1 + post: description: >- - Deletes a DeidentifyTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid - to learn more. - operationId: dlp.projects.deidentifyTemplates.delete + Redacts potentially sensitive info from an image. This method has limits + on input size, processing time, and output size. See + https://cloud.google.com/sensitive-data-protection/docs/redacting-sensitive-data-images + to learn more. When no InfoTypes or CustomInfoTypes are specified in + this request, the system will automatically choose what detectors to + run. By default this may be all types, but may change over time as + detectors are updated. Only the first frame of each multiframe image is + redacted. Metadata and other frames are omitted in the response. + operationId: dlp.projects.locations.image.redact + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2RedactImageRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9739,7 +10438,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2RedactImageResponse' parameters: - in: path name: projectsId @@ -9747,16 +10446,19 @@ paths: schema: type: string - in: path - name: deidentifyTemplatesId + name: locationsId required: true schema: type: string + /v2/projects/{projectsId}/locations/{locationsId}/infoTypes: + parameters: *ref_1 get: description: >- - Gets a DeidentifyTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + Returns a list of the sensitive information types that the DLP API + supports. See + https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference to learn more. - operationId: dlp.projects.deidentifyTemplates.get + operationId: dlp.projects.locations.infoTypes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9768,7 +10470,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2ListInfoTypesResponse' parameters: - in: path name: projectsId @@ -9776,25 +10478,37 @@ paths: schema: type: string - in: path - name: deidentifyTemplatesId + name: locationsId required: true schema: type: string - /v2/projects/{projectsId}/deidentifyTemplates: + - in: query + name: languageCode + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: locationId + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/inspectTemplates: parameters: *ref_1 post: description: >- - Creates a DeidentifyTemplate for reusing frequently used configuration - for de-identifying content, images, and storage. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + Creates an InspectTemplate for reusing frequently used configuration for + inspecting content, images, and storage. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.projects.deidentifyTemplates.create + operationId: dlp.projects.locations.inspectTemplates.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateDeidentifyTemplateRequest + #/components/schemas/GooglePrivacyDlpV2CreateInspectTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9806,19 +10520,24 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' parameters: - in: path name: projectsId required: true schema: type: string + - in: path + name: locationsId + required: true + schema: + type: string get: description: >- - Lists DeidentifyTemplates. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + Lists InspectTemplates. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.projects.deidentifyTemplates.list + operationId: dlp.projects.locations.inspectTemplates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9831,48 +10550,49 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListDeidentifyTemplatesResponse + #/components/schemas/GooglePrivacyDlpV2ListInspectTemplatesResponse parameters: - in: path name: projectsId required: true schema: type: string - - in: query - name: orderBy + - in: path + name: locationsId + required: true schema: type: string - in: query name: pageToken schema: type: string - - in: query - name: locationId - schema: - type: string - in: query name: pageSize schema: type: integer format: int32 - /v2/projects/{projectsId}/dlpJobs: + - in: query + name: orderBy + schema: + type: string + - in: query + name: locationId + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/inspectTemplates/{inspectTemplatesId}: parameters: *ref_1 - post: + patch: description: >- - Creates a new job to inspect storage or calculate risk metrics. See - https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage - and - https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis - to learn more. When no InfoTypes or CustomInfoTypes are specified in - inspect jobs, the system will automatically choose what detectors to - run. By default this may be all types, but may change over time as - detectors are updated. - operationId: dlp.projects.dlpJobs.create + Updates the InspectTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates + to learn more. + operationId: dlp.projects.locations.inspectTemplates.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2CreateDlpJobRequest' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2UpdateInspectTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9884,21 +10604,29 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' parameters: - in: path name: projectsId required: true schema: type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: inspectTemplatesId + required: true + schema: + type: string get: description: >- - Lists DlpJobs that match the specified filter in the request. See - https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage - and - https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis + Gets an InspectTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.projects.dlpJobs.list + operationId: dlp.projects.locations.inspectTemplates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9910,55 +10638,29 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ListDlpJobsResponse' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' parameters: - in: path name: projectsId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: locationId - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken + - in: path + name: locationsId + required: true schema: type: string - - in: query - name: type + - in: path + name: inspectTemplatesId + required: true schema: type: string - /v2/projects/{projectsId}/dlpJobs/{dlpJobsId}:cancel: - parameters: *ref_1 - post: + delete: description: >- - Starts asynchronous cancellation on a long-running DlpJob. The server - makes a best effort to cancel the DlpJob, but success is not guaranteed. - See - https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage - and - https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis + Deletes an InspectTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.projects.dlpJobs.cancel - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2CancelDlpJobRequest' + operationId: dlp.projects.locations.inspectTemplates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9978,22 +10680,30 @@ paths: schema: type: string - in: path - name: dlpJobsId + name: locationsId required: true schema: type: string - /v2/projects/{projectsId}/dlpJobs/{dlpJobsId}: + - in: path + name: inspectTemplatesId + required: true + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/deidentifyTemplates: parameters: *ref_1 - delete: + post: description: >- - Deletes a long-running DlpJob. This method indicates that the client is - no longer interested in the DlpJob result. The job will be canceled if - possible. See - https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage - and - https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis + Creates a DeidentifyTemplate for reusing frequently used configuration + for de-identifying content, images, and storage. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. - operationId: dlp.projects.dlpJobs.delete + operationId: dlp.projects.locations.deidentifyTemplates.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2CreateDeidentifyTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10005,7 +10715,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path name: projectsId @@ -10013,18 +10723,16 @@ paths: schema: type: string - in: path - name: dlpJobsId + name: locationsId required: true schema: type: string get: description: >- - Gets the latest state of a long-running DlpJob. See - https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage - and - https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis + Lists DeidentifyTemplates. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. - operationId: dlp.projects.dlpJobs.get + operationId: dlp.projects.locations.deidentifyTemplates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10036,7 +10744,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListDeidentifyTemplatesResponse parameters: - in: path name: projectsId @@ -10044,18 +10753,41 @@ paths: schema: type: string - in: path - name: dlpJobsId + name: locationsId required: true schema: type: string - /v2/projects/{projectsId}/inspectTemplates/{inspectTemplatesId}: + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: locationId + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/deidentifyTemplates/{deidentifyTemplatesId}: parameters: *ref_1 - get: + patch: description: >- - Gets an InspectTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates + Updates the DeidentifyTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. - operationId: dlp.projects.inspectTemplates.get + operationId: dlp.projects.locations.deidentifyTemplates.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10067,7 +10799,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path name: projectsId @@ -10075,22 +10807,21 @@ paths: schema: type: string - in: path - name: inspectTemplatesId + name: locationsId required: true schema: type: string - patch: + - in: path + name: deidentifyTemplatesId + required: true + schema: + type: string + get: description: >- - Updates the InspectTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates + Gets a DeidentifyTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. - operationId: dlp.projects.inspectTemplates.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateInspectTemplateRequest + operationId: dlp.projects.locations.deidentifyTemplates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10102,7 +10833,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path name: projectsId @@ -10110,16 +10841,21 @@ paths: schema: type: string - in: path - name: inspectTemplatesId + name: locationsId + required: true + schema: + type: string + - in: path + name: deidentifyTemplatesId required: true schema: type: string delete: description: >- - Deletes an InspectTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates + Deletes a DeidentifyTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. - operationId: dlp.projects.inspectTemplates.delete + operationId: dlp.projects.locations.deidentifyTemplates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10139,25 +10875,29 @@ paths: schema: type: string - in: path - name: inspectTemplatesId + name: locationsId required: true schema: type: string - /v2/projects/{projectsId}/inspectTemplates: + - in: path + name: deidentifyTemplatesId + required: true + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/jobTriggers: parameters: *ref_1 post: description: >- - Creates an InspectTemplate for reusing frequently used configuration for - inspecting content, images, and storage. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates + Creates a job trigger to run DLP actions such as scanning storage for + sensitive information on a set schedule. See + https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. - operationId: dlp.projects.inspectTemplates.create + operationId: dlp.projects.locations.jobTriggers.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateInspectTemplateRequest + $ref: '#/components/schemas/GooglePrivacyDlpV2CreateJobTriggerRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10169,63 +10909,24 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' parameters: - in: path name: projectsId required: true schema: type: string - get: - description: >- - Lists InspectTemplates. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates - to learn more. - operationId: dlp.projects.inspectTemplates.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListInspectTemplatesResponse - parameters: - in: path - name: projectsId + name: locationsId required: true schema: type: string - - in: query - name: locationId - schema: - type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v2/projects/{projectsId}/jobTriggers: - parameters: *ref_1 get: description: >- Lists job triggers. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. - operationId: dlp.projects.jobTriggers.list + operationId: dlp.projects.locations.jobTriggers.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10240,14 +10941,24 @@ paths: $ref: '#/components/schemas/GooglePrivacyDlpV2ListJobTriggersResponse' parameters: - in: path - name: projectsId + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId required: true schema: type: string - in: query - name: locationId + name: pageToken schema: type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 - in: query name: orderBy schema: @@ -10257,30 +10968,26 @@ paths: schema: type: string - in: query - name: pageToken + name: type schema: type: string - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: type + name: locationId schema: type: string - post: + /v2/projects/{projectsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}: + parameters: *ref_1 + patch: description: >- - Creates a job trigger to run DLP actions such as scanning storage for - sensitive information on a set schedule. See + Updates a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. - operationId: dlp.projects.jobTriggers.create + operationId: dlp.projects.locations.jobTriggers.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2CreateJobTriggerRequest' + $ref: '#/components/schemas/GooglePrivacyDlpV2UpdateJobTriggerRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10299,14 +11006,22 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/jobTriggers/{jobTriggersId}: - parameters: *ref_1 + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: jobTriggersId + required: true + schema: + type: string get: description: >- Gets a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. - operationId: dlp.projects.jobTriggers.get + operationId: dlp.projects.locations.jobTriggers.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10325,6 +11040,11 @@ paths: required: true schema: type: string + - in: path + name: locationsId + required: true + schema: + type: string - in: path name: jobTriggersId required: true @@ -10335,7 +11055,7 @@ paths: Deletes a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. - operationId: dlp.projects.jobTriggers.delete + operationId: dlp.projects.locations.jobTriggers.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10354,22 +11074,30 @@ paths: required: true schema: type: string + - in: path + name: locationsId + required: true + schema: + type: string - in: path name: jobTriggersId required: true schema: type: string - patch: + /v2/projects/{projectsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}:hybridInspect: + parameters: *ref_1 + post: description: >- - Updates a job trigger. See - https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers - to learn more. - operationId: dlp.projects.jobTriggers.patch + Inspect hybrid content and store findings to a trigger. The inspection + will be processed asynchronously. To review the findings monitor the + jobs within the trigger. + operationId: dlp.projects.locations.jobTriggers.hybridInspect requestBody: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2UpdateJobTriggerRequest' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2HybridInspectJobTriggerRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10381,25 +11109,30 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' + $ref: '#/components/schemas/GooglePrivacyDlpV2HybridInspectResponse' parameters: - in: path name: projectsId required: true schema: type: string + - in: path + name: locationsId + required: true + schema: + type: string - in: path name: jobTriggersId required: true schema: type: string - /v2/projects/{projectsId}/jobTriggers/{jobTriggersId}:activate: + /v2/projects/{projectsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}:activate: parameters: *ref_1 post: description: >- Activate a job trigger. Causes the immediate execute of a trigger instead of waiting on the trigger event to occur. - operationId: dlp.projects.jobTriggers.activate + operationId: dlp.projects.locations.jobTriggers.activate requestBody: content: application/json: @@ -10424,58 +11157,26 @@ paths: schema: type: string - in: path - name: jobTriggersId + name: locationsId required: true schema: type: string - /v2/projects/{projectsId}/image:redact: - parameters: *ref_1 - post: - description: >- - Redacts potentially sensitive info from an image. This method has limits - on input size, processing time, and output size. See - https://cloud.google.com/sensitive-data-protection/docs/redacting-sensitive-data-images - to learn more. When no InfoTypes or CustomInfoTypes are specified in - this request, the system will automatically choose what detectors to - run. By default this may be all types, but may change over time as - detectors are updated. - operationId: dlp.projects.image.redact - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2RedactImageRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2RedactImageResponse' - parameters: - in: path - name: projectsId + name: jobTriggersId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}:hybridInspect: + /v2/projects/{projectsId}/locations/{locationsId}/discoveryConfigs: parameters: *ref_1 post: - description: >- - Inspect hybrid content and store findings to a job. To review the - findings, inspect the job. Inspection will occur asynchronously. - operationId: dlp.projects.locations.dlpJobs.hybridInspect + description: Creates a config for discovery to scan and profile storage. + operationId: dlp.projects.locations.discoveryConfigs.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2HybridInspectDlpJobRequest + #/components/schemas/GooglePrivacyDlpV2CreateDiscoveryConfigRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10487,7 +11188,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2HybridInspectResponse' + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' parameters: - in: path name: projectsId @@ -10499,21 +11200,9 @@ paths: required: true schema: type: string - - in: path - name: dlpJobsId - required: true - schema: - type: string - /v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}: - parameters: *ref_1 get: - description: >- - Gets the latest state of a long-running DlpJob. See - https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage - and - https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis - to learn more. - operationId: dlp.projects.locations.dlpJobs.get + description: Lists discovery configurations. + operationId: dlp.projects.locations.discoveryConfigs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10525,7 +11214,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListDiscoveryConfigsResponse parameters: - in: path name: projectsId @@ -10537,21 +11227,30 @@ paths: required: true schema: type: string - - in: path - name: dlpJobsId - required: true + - in: query + name: pageToken schema: type: string - delete: - description: >- - Deletes a long-running DlpJob. This method indicates that the client is - no longer interested in the DlpJob result. The job will be canceled if - possible. See - https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage - and - https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis - to learn more. - operationId: dlp.projects.locations.dlpJobs.delete + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: orderBy + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/discoveryConfigs/{discoveryConfigsId}: + parameters: *ref_1 + patch: + description: Updates a discovery configuration. + operationId: dlp.projects.locations.discoveryConfigs.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2UpdateDiscoveryConfigRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10563,7 +11262,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' parameters: - in: path name: projectsId @@ -10576,22 +11275,13 @@ paths: schema: type: string - in: path - name: dlpJobsId + name: discoveryConfigsId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}:finish: - parameters: *ref_1 - post: - description: >- - Finish a running hybrid DlpJob. Triggers the finalization steps and - running of any enabled actions that have not yet run. - operationId: dlp.projects.locations.dlpJobs.finish - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2FinishDlpJobRequest' + get: + description: Gets a discovery configuration. + operationId: dlp.projects.locations.discoveryConfigs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10603,7 +11293,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' parameters: - in: path name: projectsId @@ -10616,27 +11306,13 @@ paths: schema: type: string - in: path - name: dlpJobsId + name: discoveryConfigsId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}:cancel: - parameters: *ref_1 - post: - description: >- - Starts asynchronous cancellation on a long-running DlpJob. The server - makes a best effort to cancel the DlpJob, but success is not guaranteed. - See - https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage - and - https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis - to learn more. - operationId: dlp.projects.locations.dlpJobs.cancel - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2CancelDlpJobRequest' + delete: + description: Deletes a discovery configuration. + operationId: dlp.projects.locations.discoveryConfigs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10661,7 +11337,7 @@ paths: schema: type: string - in: path - name: dlpJobsId + name: discoveryConfigsId required: true schema: type: string @@ -10741,10 +11417,6 @@ paths: name: filter schema: type: string - - in: query - name: type - schema: - type: string - in: query name: pageSize schema: @@ -10755,28 +11427,27 @@ paths: schema: type: string - in: query - name: locationId + name: type schema: type: string - in: query name: orderBy schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/inspectTemplates: + - in: query + name: locationId + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}: parameters: *ref_1 - post: + get: description: >- - Creates an InspectTemplate for reusing frequently used configuration for - inspecting content, images, and storage. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates - to learn more. - operationId: dlp.projects.locations.inspectTemplates.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateInspectTemplateRequest + Gets the latest state of a long-running DlpJob. See + https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage + and + https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis + to learn more. + operationId: dlp.projects.locations.dlpJobs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10788,7 +11459,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' parameters: - in: path name: projectsId @@ -10800,12 +11471,21 @@ paths: required: true schema: type: string - get: + - in: path + name: dlpJobsId + required: true + schema: + type: string + delete: description: >- - Lists InspectTemplates. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates + Deletes a long-running DlpJob. This method indicates that the client is + no longer interested in the DlpJob result. The job will be canceled if + possible. See + https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage + and + https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. - operationId: dlp.projects.locations.inspectTemplates.list + operationId: dlp.projects.locations.dlpJobs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10817,8 +11497,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListInspectTemplatesResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -10830,31 +11509,28 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: locationId - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: orderBy + - in: path + name: dlpJobsId + required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/inspectTemplates/{inspectTemplatesId}: + /v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}:cancel: parameters: *ref_1 - get: + post: description: >- - Gets an InspectTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates + Starts asynchronous cancellation on a long-running DlpJob. The server + makes a best effort to cancel the DlpJob, but success is not guaranteed. + See + https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage + and + https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. - operationId: dlp.projects.locations.inspectTemplates.get + operationId: dlp.projects.locations.dlpJobs.cancel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2CancelDlpJobRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10866,7 +11542,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -10879,22 +11555,23 @@ paths: schema: type: string - in: path - name: inspectTemplatesId + name: dlpJobsId required: true schema: type: string - patch: + /v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}:hybridInspect: + parameters: *ref_1 + post: description: >- - Updates the InspectTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates - to learn more. - operationId: dlp.projects.locations.inspectTemplates.patch + Inspect hybrid content and store findings to a job. To review the + findings, inspect the job. Inspection will occur asynchronously. + operationId: dlp.projects.locations.dlpJobs.hybridInspect requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateInspectTemplateRequest + #/components/schemas/GooglePrivacyDlpV2HybridInspectDlpJobRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10906,7 +11583,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2HybridInspectResponse' parameters: - in: path name: projectsId @@ -10919,16 +11596,22 @@ paths: schema: type: string - in: path - name: inspectTemplatesId + name: dlpJobsId required: true schema: type: string - delete: + /v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}:finish: + parameters: *ref_1 + post: description: >- - Deletes an InspectTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates - to learn more. - operationId: dlp.projects.locations.inspectTemplates.delete + Finish a running hybrid DlpJob. Triggers the finalization steps and + running of any enabled actions that have not yet run. + operationId: dlp.projects.locations.dlpJobs.finish + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2FinishDlpJobRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10953,15 +11636,24 @@ paths: schema: type: string - in: path - name: inspectTemplatesId + name: dlpJobsId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections:search: + /v2/projects/{projectsId}/locations/{locationsId}/storedInfoTypes: parameters: *ref_1 - get: - description: Searches for Connections in a parent. - operationId: dlp.projects.locations.connections.search + post: + description: >- + Creates a pre-built stored infoType to be used for inspection. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + to learn more. + operationId: dlp.projects.locations.storedInfoTypes.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2CreateStoredInfoTypeRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10973,8 +11665,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2SearchConnectionsResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' parameters: - in: path name: projectsId @@ -10986,8 +11677,34 @@ paths: required: true schema: type: string - - in: query - name: filter + get: + description: >- + Lists stored infoTypes. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + to learn more. + operationId: dlp.projects.locations.storedInfoTypes.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListStoredInfoTypesResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true schema: type: string - in: query @@ -10999,16 +11716,29 @@ paths: schema: type: integer format: int32 - /v2/projects/{projectsId}/locations/{locationsId}/connections: + - in: query + name: orderBy + schema: + type: string + - in: query + name: locationId + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/storedInfoTypes/{storedInfoTypesId}: parameters: *ref_1 - post: - description: Create a Connection to an external data source. - operationId: dlp.projects.locations.connections.create + patch: + description: >- + Updates the stored infoType by creating a new version. The existing + version will continue to be used until the new version is ready. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + to learn more. + operationId: dlp.projects.locations.storedInfoTypes.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2CreateConnectionRequest' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2UpdateStoredInfoTypeRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11020,7 +11750,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' parameters: - in: path name: projectsId @@ -11032,11 +11762,17 @@ paths: required: true schema: type: string + - in: path + name: storedInfoTypesId + required: true + schema: + type: string get: description: >- - Lists Connections in a parent. Use SearchConnections to see all - connections within an organization. - operationId: dlp.projects.locations.connections.list + Gets a stored infoType. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + to learn more. + operationId: dlp.projects.locations.storedInfoTypes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11048,7 +11784,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ListConnectionsResponse' + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' parameters: - in: path name: projectsId @@ -11060,29 +11796,17 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: storedInfoTypesId + required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}: - parameters: *ref_1 - patch: - description: Update a Connection. - operationId: dlp.projects.locations.connections.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2UpdateConnectionRequest' + delete: + description: >- + Deletes a stored infoType. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + to learn more. + operationId: dlp.projects.locations.storedInfoTypes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11094,7 +11818,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -11107,13 +11831,15 @@ paths: schema: type: string - in: path - name: connectionsId + name: storedInfoTypesId required: true schema: type: string - delete: - description: Delete a Connection. - operationId: dlp.projects.locations.connections.delete + /v2/projects/{projectsId}/locations/{locationsId}/projectDataProfiles: + parameters: *ref_1 + get: + description: Lists project data profiles for an organization. + operationId: dlp.projects.locations.projectDataProfiles.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11125,7 +11851,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListProjectDataProfilesResponse parameters: - in: path name: projectsId @@ -11137,14 +11864,28 @@ paths: required: true schema: type: string - - in: path - name: connectionsId - required: true + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: orderBy schema: type: string + - in: query + name: filter + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/projectDataProfiles/{projectDataProfilesId}: + parameters: *ref_1 get: - description: Get a Connection by name. - operationId: dlp.projects.locations.connections.get + description: Gets a project data profile. + operationId: dlp.projects.locations.projectDataProfiles.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11156,7 +11897,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' + $ref: '#/components/schemas/GooglePrivacyDlpV2ProjectDataProfile' parameters: - in: path name: projectsId @@ -11169,24 +11910,15 @@ paths: schema: type: string - in: path - name: connectionsId + name: projectDataProfilesId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/deidentifyTemplates/{deidentifyTemplatesId}: + /v2/projects/{projectsId}/locations/{locationsId}/tableDataProfiles: parameters: *ref_1 - patch: - description: >- - Updates the DeidentifyTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid - to learn more. - operationId: dlp.projects.locations.deidentifyTemplates.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest + get: + description: Lists table data profiles for an organization. + operationId: dlp.projects.locations.tableDataProfiles.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11198,7 +11930,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListTableDataProfilesResponse parameters: - in: path name: projectsId @@ -11210,17 +11943,28 @@ paths: required: true schema: type: string - - in: path - name: deidentifyTemplatesId - required: true + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: orderBy schema: type: string + - in: query + name: filter + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/tableDataProfiles/{tableDataProfilesId}: + parameters: *ref_1 get: - description: >- - Gets a DeidentifyTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid - to learn more. - operationId: dlp.projects.locations.deidentifyTemplates.get + description: Gets a table data profile. + operationId: dlp.projects.locations.tableDataProfiles.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11232,7 +11976,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2TableDataProfile' parameters: - in: path name: projectsId @@ -11245,16 +11989,15 @@ paths: schema: type: string - in: path - name: deidentifyTemplatesId + name: tableDataProfilesId required: true schema: type: string delete: description: >- - Deletes a DeidentifyTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid - to learn more. - operationId: dlp.projects.locations.deidentifyTemplates.delete + Delete a TableDataProfile. Will not prevent the profile from being + regenerated if the table is still included in a discovery configuration. + operationId: dlp.projects.locations.tableDataProfiles.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11279,18 +12022,15 @@ paths: schema: type: string - in: path - name: deidentifyTemplatesId + name: tableDataProfilesId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/deidentifyTemplates: + /v2/projects/{projectsId}/locations/{locationsId}/columnDataProfiles: parameters: *ref_1 get: - description: >- - Lists DeidentifyTemplates. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid - to learn more. - operationId: dlp.projects.locations.deidentifyTemplates.list + description: Lists column data profiles for an organization. + operationId: dlp.projects.locations.columnDataProfiles.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11303,7 +12043,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListDeidentifyTemplatesResponse + #/components/schemas/GooglePrivacyDlpV2ListColumnDataProfilesResponse parameters: - in: path name: projectsId @@ -11315,6 +12055,10 @@ paths: required: true schema: type: string + - in: query + name: pageToken + schema: + type: string - in: query name: pageSize schema: @@ -11325,26 +12069,14 @@ paths: schema: type: string - in: query - name: pageToken - schema: - type: string - - in: query - name: locationId + name: filter schema: type: string - post: - description: >- - Creates a DeidentifyTemplate for reusing frequently used configuration - for de-identifying content, images, and storage. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid - to learn more. - operationId: dlp.projects.locations.deidentifyTemplates.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateDeidentifyTemplateRequest + /v2/projects/{projectsId}/locations/{locationsId}/columnDataProfiles/{columnDataProfilesId}: + parameters: *ref_1 + get: + description: Gets a column data profile. + operationId: dlp.projects.locations.columnDataProfiles.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11356,7 +12088,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2ColumnDataProfile' parameters: - in: path name: projectsId @@ -11368,19 +12100,16 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}: + - in: path + name: columnDataProfilesId + required: true + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/fileStoreDataProfiles: parameters: *ref_1 - patch: - description: >- - Updates a job trigger. See - https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers - to learn more. - operationId: dlp.projects.locations.jobTriggers.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2UpdateJobTriggerRequest' + get: + description: Lists file store data profiles for an organization. + operationId: dlp.projects.locations.fileStoreDataProfiles.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11392,7 +12121,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListFileStoreDataProfilesResponse parameters: - in: path name: projectsId @@ -11404,17 +12134,28 @@ paths: required: true schema: type: string - - in: path - name: jobTriggersId - required: true + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: filter schema: type: string + /v2/projects/{projectsId}/locations/{locationsId}/fileStoreDataProfiles/{fileStoreDataProfilesId}: + parameters: *ref_1 get: - description: >- - Gets a job trigger. See - https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers - to learn more. - operationId: dlp.projects.locations.jobTriggers.get + description: Gets a file store data profile. + operationId: dlp.projects.locations.fileStoreDataProfiles.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11426,7 +12167,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' + $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreDataProfile' parameters: - in: path name: projectsId @@ -11439,16 +12180,16 @@ paths: schema: type: string - in: path - name: jobTriggersId + name: fileStoreDataProfilesId required: true schema: type: string delete: description: >- - Deletes a job trigger. See - https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers - to learn more. - operationId: dlp.projects.locations.jobTriggers.delete + Delete a FileStoreDataProfile. Will not prevent the profile from being + regenerated if the resource is still included in a discovery + configuration. + operationId: dlp.projects.locations.fileStoreDataProfiles.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11473,18 +12214,20 @@ paths: schema: type: string - in: path - name: jobTriggersId + name: fileStoreDataProfilesId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/jobTriggers: + /v2/projects/{projectsId}/locations/{locationsId}/connections: parameters: *ref_1 - get: - description: >- - Lists job triggers. See - https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers - to learn more. - operationId: dlp.projects.locations.jobTriggers.list + post: + description: Create a Connection to an external data source. + operationId: dlp.projects.locations.connections.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2CreateConnectionRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11496,7 +12239,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ListJobTriggersResponse' + $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' parameters: - in: path name: projectsId @@ -11508,43 +12251,52 @@ paths: required: true schema: type: string - - in: query - name: pageToken + get: + description: >- + Lists Connections in a parent. Use SearchConnections to see all + connections within an organization. + operationId: dlp.projects.locations.connections.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2ListConnectionsResponse' + parameters: + - in: path + name: projectsId + required: true schema: type: string - - in: query - name: orderBy + - in: path + name: locationsId + required: true schema: type: string - in: query - name: type + name: pageSize schema: - type: string + type: integer + format: int32 - in: query - name: filter + name: pageToken schema: type: string - in: query - name: locationId + name: filter schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - post: - description: >- - Creates a job trigger to run DLP actions such as scanning storage for - sensitive information on a set schedule. See - https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers - to learn more. - operationId: dlp.projects.locations.jobTriggers.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2CreateJobTriggerRequest' + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}: + parameters: *ref_1 + get: + description: Get a Connection by name. + operationId: dlp.projects.locations.connections.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11556,32 +12308,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' + $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' parameters: - in: path - name: projectsId + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId required: true schema: type: string - in: path - name: locationsId + name: connectionsId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}:hybridInspect: - parameters: *ref_1 - post: - description: >- - Inspect hybrid content and store findings to a trigger. The inspection - will be processed asynchronously. To review the findings monitor the - jobs within the trigger. - operationId: dlp.projects.locations.jobTriggers.hybridInspect - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2HybridInspectJobTriggerRequest + delete: + description: Delete a Connection. + operationId: dlp.projects.locations.connections.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11593,7 +12339,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2HybridInspectResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -11606,22 +12352,18 @@ paths: schema: type: string - in: path - name: jobTriggersId + name: connectionsId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}:activate: - parameters: *ref_1 - post: - description: >- - Activate a job trigger. Causes the immediate execute of a trigger - instead of waiting on the trigger event to occur. - operationId: dlp.projects.locations.jobTriggers.activate + patch: + description: Update a Connection. + operationId: dlp.projects.locations.connections.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ActivateJobTriggerRequest' + $ref: '#/components/schemas/GooglePrivacyDlpV2UpdateConnectionRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11633,7 +12375,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' + $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' parameters: - in: path name: projectsId @@ -11646,18 +12388,15 @@ paths: schema: type: string - in: path - name: jobTriggersId + name: connectionsId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/storedInfoTypes/{storedInfoTypesId}: + /v2/projects/{projectsId}/locations/{locationsId}/connections:search: parameters: *ref_1 - delete: - description: >- - Deletes a stored infoType. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes - to learn more. - operationId: dlp.projects.locations.storedInfoTypes.delete + get: + description: Searches for Connections in a parent. + operationId: dlp.projects.locations.connections.search security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11669,7 +12408,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2SearchConnectionsResponse parameters: - in: path name: projectsId @@ -11681,17 +12421,37 @@ paths: required: true schema: type: string - - in: path - name: storedInfoTypesId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - get: + - in: query + name: filter + schema: + type: string + /v2/projects/{projectsId}/image:redact: + parameters: *ref_1 + post: description: >- - Gets a stored infoType. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes - to learn more. - operationId: dlp.projects.locations.storedInfoTypes.get + Redacts potentially sensitive info from an image. This method has limits + on input size, processing time, and output size. See + https://cloud.google.com/sensitive-data-protection/docs/redacting-sensitive-data-images + to learn more. When no InfoTypes or CustomInfoTypes are specified in + this request, the system will automatically choose what detectors to + run. By default this may be all types, but may change over time as + detectors are updated. Only the first frame of each multiframe image is + redacted. Metadata and other frames are omitted in the response. + operationId: dlp.projects.image.redact + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2RedactImageRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11703,36 +12463,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: '#/components/schemas/GooglePrivacyDlpV2RedactImageResponse' parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: storedInfoTypesId - required: true - schema: - type: string - patch: + /v2/projects/{projectsId}/inspectTemplates: + parameters: *ref_1 + post: description: >- - Updates the stored infoType by creating a new version. The existing - version will continue to be used until the new version is ready. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + Creates an InspectTemplate for reusing frequently used configuration for + inspecting content, images, and storage. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.projects.locations.storedInfoTypes.patch + operationId: dlp.projects.inspectTemplates.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateStoredInfoTypeRequest + #/components/schemas/GooglePrivacyDlpV2CreateInspectTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11744,31 +12496,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: storedInfoTypesId - required: true - schema: - type: string - /v2/projects/{projectsId}/locations/{locationsId}/storedInfoTypes: - parameters: *ref_1 get: description: >- - Lists stored infoTypes. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + Lists InspectTemplates. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.projects.locations.storedInfoTypes.list + operationId: dlp.projects.inspectTemplates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11781,20 +12521,15 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListStoredInfoTypesResponse + #/components/schemas/GooglePrivacyDlpV2ListInspectTemplatesResponse parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: locationsId - required: true - schema: - type: string - in: query - name: locationId + name: pageToken schema: type: string - in: query @@ -11807,21 +12542,23 @@ paths: schema: type: string - in: query - name: pageToken + name: locationId schema: type: string - post: + /v2/projects/{projectsId}/inspectTemplates/{inspectTemplatesId}: + parameters: *ref_1 + patch: description: >- - Creates a pre-built stored infoType to be used for inspection. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + Updates the InspectTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.projects.locations.storedInfoTypes.create + operationId: dlp.projects.inspectTemplates.patch requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateStoredInfoTypeRequest + #/components/schemas/GooglePrivacyDlpV2UpdateInspectTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11833,7 +12570,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' parameters: - in: path name: projectsId @@ -11841,15 +12578,16 @@ paths: schema: type: string - in: path - name: locationsId + name: inspectTemplatesId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/projectDataProfiles/{projectDataProfilesId}: - parameters: *ref_1 get: - description: Gets a project data profile. - operationId: dlp.projects.locations.projectDataProfiles.get + description: >- + Gets an InspectTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates + to learn more. + operationId: dlp.projects.inspectTemplates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11861,7 +12599,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ProjectDataProfile' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' parameters: - in: path name: projectsId @@ -11869,20 +12607,54 @@ paths: schema: type: string - in: path - name: locationsId + name: inspectTemplatesId + required: true + schema: + type: string + delete: + description: >- + Deletes an InspectTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates + to learn more. + operationId: dlp.projects.inspectTemplates.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: projectsId required: true schema: type: string - in: path - name: projectDataProfilesId + name: inspectTemplatesId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/projectDataProfiles: + /v2/projects/{projectsId}/deidentifyTemplates: parameters: *ref_1 - get: - description: Lists project data profiles for an organization. - operationId: dlp.projects.locations.projectDataProfiles.list + post: + description: >- + Creates a DeidentifyTemplate for reusing frequently used configuration + for de-identifying content, images, and storage. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + to learn more. + operationId: dlp.projects.deidentifyTemplates.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2CreateDeidentifyTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11894,16 +12666,35 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListProjectDataProfilesResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path name: projectsId required: true schema: type: string + get: + description: >- + Lists DeidentifyTemplates. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + to learn more. + operationId: dlp.projects.deidentifyTemplates.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListDeidentifyTemplatesResponse + parameters: - in: path - name: locationsId + name: projectsId required: true schema: type: string @@ -11917,18 +12708,27 @@ paths: type: integer format: int32 - in: query - name: filter + name: orderBy schema: type: string - in: query - name: orderBy + name: locationId schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/discoveryConfigs/{discoveryConfigsId}: + /v2/projects/{projectsId}/deidentifyTemplates/{deidentifyTemplatesId}: parameters: *ref_1 - get: - description: Gets a discovery configuration. - operationId: dlp.projects.locations.discoveryConfigs.get + patch: + description: >- + Updates the DeidentifyTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + to learn more. + operationId: dlp.projects.deidentifyTemplates.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11940,7 +12740,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path name: projectsId @@ -11948,18 +12748,16 @@ paths: schema: type: string - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: discoveryConfigsId + name: deidentifyTemplatesId required: true schema: type: string - delete: - description: Deletes a discovery configuration. - operationId: dlp.projects.locations.discoveryConfigs.delete + get: + description: >- + Gets a DeidentifyTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + to learn more. + operationId: dlp.projects.deidentifyTemplates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11971,7 +12769,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path name: projectsId @@ -11979,24 +12777,16 @@ paths: schema: type: string - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: discoveryConfigsId + name: deidentifyTemplatesId required: true schema: type: string - patch: - description: Updates a discovery configuration. - operationId: dlp.projects.locations.discoveryConfigs.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateDiscoveryConfigRequest + delete: + description: >- + Deletes a DeidentifyTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + to learn more. + operationId: dlp.projects.deidentifyTemplates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12008,7 +12798,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -12016,26 +12806,24 @@ paths: schema: type: string - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: discoveryConfigsId + name: deidentifyTemplatesId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/discoveryConfigs: + /v2/projects/{projectsId}/jobTriggers: parameters: *ref_1 post: - description: Creates a config for discovery to scan and profile storage. - operationId: dlp.projects.locations.discoveryConfigs.create + description: >- + Creates a job trigger to run DLP actions such as scanning storage for + sensitive information on a set schedule. See + https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers + to learn more. + operationId: dlp.projects.jobTriggers.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateDiscoveryConfigRequest + $ref: '#/components/schemas/GooglePrivacyDlpV2CreateJobTriggerRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12047,21 +12835,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: locationsId - required: true - schema: - type: string get: - description: Lists discovery configurations. - operationId: dlp.projects.locations.discoveryConfigs.list + description: >- + Lists job triggers. See + https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers + to learn more. + operationId: dlp.projects.jobTriggers.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12073,17 +12859,15 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListDiscoveryConfigsResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2ListJobTriggersResponse' parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: locationsId - required: true + - in: query + name: pageToken schema: type: string - in: query @@ -12092,30 +12876,34 @@ paths: type: integer format: int32 - in: query - name: pageToken + name: orderBy schema: type: string - in: query - name: orderBy + name: filter schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/image:redact: + - in: query + name: type + schema: + type: string + - in: query + name: locationId + schema: + type: string + /v2/projects/{projectsId}/jobTriggers/{jobTriggersId}: parameters: *ref_1 - post: + patch: description: >- - Redacts potentially sensitive info from an image. This method has limits - on input size, processing time, and output size. See - https://cloud.google.com/sensitive-data-protection/docs/redacting-sensitive-data-images - to learn more. When no InfoTypes or CustomInfoTypes are specified in - this request, the system will automatically choose what detectors to - run. By default this may be all types, but may change over time as - detectors are updated. - operationId: dlp.projects.locations.image.redact + Updates a job trigger. See + https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers + to learn more. + operationId: dlp.projects.jobTriggers.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2RedactImageRequest' + $ref: '#/components/schemas/GooglePrivacyDlpV2UpdateJobTriggerRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12127,7 +12915,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2RedactImageResponse' + $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' parameters: - in: path name: projectsId @@ -12135,15 +12923,16 @@ paths: schema: type: string - in: path - name: locationsId + name: jobTriggersId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/columnDataProfiles: - parameters: *ref_1 get: - description: Lists column data profiles for an organization. - operationId: dlp.projects.locations.columnDataProfiles.list + description: >- + Gets a job trigger. See + https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers + to learn more. + operationId: dlp.projects.jobTriggers.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12155,8 +12944,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListColumnDataProfilesResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' parameters: - in: path name: projectsId @@ -12164,32 +12952,16 @@ paths: schema: type: string - in: path - name: locationsId + name: jobTriggersId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v2/projects/{projectsId}/locations/{locationsId}/columnDataProfiles/{columnDataProfilesId}: - parameters: *ref_1 - get: - description: Gets a column data profile. - operationId: dlp.projects.locations.columnDataProfiles.get + delete: + description: >- + Deletes a job trigger. See + https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers + to learn more. + operationId: dlp.projects.jobTriggers.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12201,7 +12973,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ColumnDataProfile' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -12209,22 +12981,22 @@ paths: schema: type: string - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: columnDataProfilesId + name: jobTriggersId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/tableDataProfiles/{tableDataProfilesId}: + /v2/projects/{projectsId}/jobTriggers/{jobTriggersId}:activate: parameters: *ref_1 - delete: + post: description: >- - Delete a TableDataProfile. Will not prevent the profile from being - regenerated if the table is still included in a discovery configuration. - operationId: dlp.projects.locations.tableDataProfiles.delete + Activate a job trigger. Causes the immediate execute of a trigger + instead of waiting on the trigger event to occur. + operationId: dlp.projects.jobTriggers.activate + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2ActivateJobTriggerRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12236,7 +13008,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' parameters: - in: path name: projectsId @@ -12244,18 +13016,28 @@ paths: schema: type: string - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: tableDataProfilesId + name: jobTriggersId required: true schema: type: string - get: - description: Gets a table data profile. - operationId: dlp.projects.locations.tableDataProfiles.get + /v2/projects/{projectsId}/dlpJobs: + parameters: *ref_1 + post: + description: >- + Creates a new job to inspect storage or calculate risk metrics. See + https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage + and + https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis + to learn more. When no InfoTypes or CustomInfoTypes are specified in + inspect jobs, the system will automatically choose what detectors to + run. By default this may be all types, but may change over time as + detectors are updated. + operationId: dlp.projects.dlpJobs.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2CreateDlpJobRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12267,28 +13049,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2TableDataProfile' + $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: tableDataProfilesId - required: true - schema: - type: string - /v2/projects/{projectsId}/locations/{locationsId}/tableDataProfiles: - parameters: *ref_1 get: - description: Lists table data profiles for an organization. - operationId: dlp.projects.locations.tableDataProfiles.list + description: >- + Lists DlpJobs that match the specified filter in the request. See + https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage + and + https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis + to learn more. + operationId: dlp.projects.dlpJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12300,21 +13075,15 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListTableDataProfilesResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2ListDlpJobsResponse' parameters: - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId + name: projectsId required: true schema: type: string - in: query - name: pageToken + name: filter schema: type: string - in: query @@ -12322,27 +13091,32 @@ paths: schema: type: integer format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: type + schema: + type: string - in: query name: orderBy schema: type: string - in: query - name: filter + name: locationId schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/content:reidentify: + /v2/projects/{projectsId}/dlpJobs/{dlpJobsId}: parameters: *ref_1 - post: + get: description: >- - Re-identifies content that has been de-identified. See - https://cloud.google.com/sensitive-data-protection/docs/pseudonymization#re-identification_in_free_text_code_example + Gets the latest state of a long-running DlpJob. See + https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage + and + https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. - operationId: dlp.projects.locations.content.reidentify - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ReidentifyContentRequest' + operationId: dlp.projects.dlpJobs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12354,8 +13128,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ReidentifyContentResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' parameters: - in: path name: projectsId @@ -12363,27 +13136,20 @@ paths: schema: type: string - in: path - name: locationsId + name: dlpJobsId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/content:deidentify: - parameters: *ref_1 - post: + delete: description: >- - De-identifies potentially sensitive info from a ContentItem. This method - has limits on input size and output size. See - https://cloud.google.com/sensitive-data-protection/docs/deidentify-sensitive-data - to learn more. When no InfoTypes or CustomInfoTypes are specified in - this request, the system will automatically choose what detectors to - run. By default this may be all types, but may change over time as - detectors are updated. - operationId: dlp.projects.locations.content.deidentify - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyContentRequest' + Deletes a long-running DlpJob. This method indicates that the client is + no longer interested in the DlpJob result. The job will be canceled if + possible. See + https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage + and + https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis + to learn more. + operationId: dlp.projects.dlpJobs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12395,8 +13161,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2DeidentifyContentResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -12404,29 +13169,27 @@ paths: schema: type: string - in: path - name: locationsId + name: dlpJobsId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/content:inspect: + /v2/projects/{projectsId}/dlpJobs/{dlpJobsId}:cancel: parameters: *ref_1 post: description: >- - Finds potentially sensitive info in content. This method has limits on - input size, processing time, and output size. When no InfoTypes or - CustomInfoTypes are specified in this request, the system will - automatically choose what detectors to run. By default this may be all - types, but may change over time as detectors are updated. For how to - guides, see - https://cloud.google.com/sensitive-data-protection/docs/inspecting-images + Starts asynchronous cancellation on a long-running DlpJob. The server + makes a best effort to cancel the DlpJob, but success is not guaranteed. + See + https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and - https://cloud.google.com/sensitive-data-protection/docs/inspecting-text, - operationId: dlp.projects.locations.content.inspect + https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis + to learn more. + operationId: dlp.projects.dlpJobs.cancel requestBody: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectContentRequest' + $ref: '#/components/schemas/GooglePrivacyDlpV2CancelDlpJobRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12438,7 +13201,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectContentResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -12446,15 +13209,24 @@ paths: schema: type: string - in: path - name: locationsId + name: dlpJobsId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/fileStoreDataProfiles/{fileStoreDataProfilesId}: + /v2/projects/{projectsId}/storedInfoTypes: parameters: *ref_1 - get: - description: Gets a file store data profile. - operationId: dlp.projects.locations.fileStoreDataProfiles.get + post: + description: >- + Creates a pre-built stored infoType to be used for inspection. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + to learn more. + operationId: dlp.projects.storedInfoTypes.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2CreateStoredInfoTypeRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12466,29 +13238,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreDataProfile' + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: fileStoreDataProfilesId - required: true - schema: - type: string - delete: + get: description: >- - Delete a FileStoreDataProfile. Will not prevent the profile from being - regenerated if the resource is still included in a discovery - configuration. - operationId: dlp.projects.locations.fileStoreDataProfiles.delete + Lists stored infoTypes. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + to learn more. + operationId: dlp.projects.storedInfoTypes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12500,28 +13262,46 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListStoredInfoTypesResponse parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: locationsId - required: true + - in: query + name: pageToken schema: type: string - - in: path - name: fileStoreDataProfilesId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: orderBy schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/fileStoreDataProfiles: + - in: query + name: locationId + schema: + type: string + /v2/projects/{projectsId}/storedInfoTypes/{storedInfoTypesId}: parameters: *ref_1 - get: - description: Lists file store data profiles for an organization. - operationId: dlp.projects.locations.fileStoreDataProfiles.list + patch: + description: >- + Updates the stored infoType by creating a new version. The existing + version will continue to be used until the new version is ready. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + to learn more. + operationId: dlp.projects.storedInfoTypes.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2UpdateStoredInfoTypeRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12533,8 +13313,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListFileStoreDataProfilesResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' parameters: - in: path name: projectsId @@ -12542,46 +13321,16 @@ paths: schema: type: string - in: path - name: locationsId + name: storedInfoTypesId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v2/projects/{projectsId}/content:inspect: - parameters: *ref_1 - post: + get: description: >- - Finds potentially sensitive info in content. This method has limits on - input size, processing time, and output size. When no InfoTypes or - CustomInfoTypes are specified in this request, the system will - automatically choose what detectors to run. By default this may be all - types, but may change over time as detectors are updated. For how to - guides, see - https://cloud.google.com/sensitive-data-protection/docs/inspecting-images - and - https://cloud.google.com/sensitive-data-protection/docs/inspecting-text, - operationId: dlp.projects.content.inspect - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectContentRequest' + Gets a stored infoType. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + to learn more. + operationId: dlp.projects.storedInfoTypes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12593,30 +13342,24 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectContentResponse' + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' parameters: - in: path name: projectsId required: true schema: type: string - /v2/projects/{projectsId}/content:deidentify: - parameters: *ref_1 - post: + - in: path + name: storedInfoTypesId + required: true + schema: + type: string + delete: description: >- - De-identifies potentially sensitive info from a ContentItem. This method - has limits on input size and output size. See - https://cloud.google.com/sensitive-data-protection/docs/deidentify-sensitive-data - to learn more. When no InfoTypes or CustomInfoTypes are specified in - this request, the system will automatically choose what detectors to - run. By default this may be all types, but may change over time as - detectors are updated. - operationId: dlp.projects.content.deidentify - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyContentRequest' + Deletes a stored infoType. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + to learn more. + operationId: dlp.projects.storedInfoTypes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12628,27 +13371,27 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2DeidentifyContentResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId required: true schema: type: string - /v2/projects/{projectsId}/content:reidentify: + - in: path + name: storedInfoTypesId + required: true + schema: + type: string + /v2/infoTypes: parameters: *ref_1 - post: + get: description: >- - Re-identifies content that has been de-identified. See - https://cloud.google.com/sensitive-data-protection/docs/pseudonymization#re-identification_in_free_text_code_example + Returns a list of the sensitive information types that the DLP API + supports. See + https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference to learn more. - operationId: dlp.projects.content.reidentify - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ReidentifyContentRequest' + operationId: dlp.infoTypes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12660,19 +13403,33 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ReidentifyContentResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2ListInfoTypesResponse' parameters: - - in: path - name: projectsId - required: true + - in: query + name: parent schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/connections:search: + - in: query + name: languageCode + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: locationId + schema: + type: string + /v2/locations/{locationsId}/infoTypes: parameters: *ref_1 get: - description: Searches for Connections in a parent. - operationId: dlp.organizations.locations.connections.search + description: >- + Returns a list of the sensitive information types that the DLP API + supports. See + https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference + to learn more. + operationId: dlp.locations.infoTypes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12684,37 +13441,34 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2SearchConnectionsResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2ListInfoTypesResponse' parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - in: path name: locationsId required: true schema: type: string - in: query - name: filter + name: languageCode schema: type: string - in: query - name: pageSize + name: filter schema: - type: integer - format: int32 + type: string - in: query - name: pageToken + name: locationId schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/connections/{connectionsId}: + /v2/organizations/{organizationsId}/locations/{locationsId}/infoTypes: parameters: *ref_1 - delete: - description: Delete a Connection. - operationId: dlp.organizations.locations.connections.delete + get: + description: >- + Returns a list of the sensitive information types that the DLP API + supports. See + https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference + to learn more. + operationId: dlp.organizations.locations.infoTypes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12726,7 +13480,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2ListInfoTypesResponse' parameters: - in: path name: organizationsId @@ -12738,19 +13492,33 @@ paths: required: true schema: type: string - - in: path - name: connectionsId - required: true + - in: query + name: languageCode schema: type: string - patch: - description: Update a Connection. - operationId: dlp.organizations.locations.connections.patch + - in: query + name: filter + schema: + type: string + - in: query + name: locationId + schema: + type: string + /v2/organizations/{organizationsId}/locations/{locationsId}/inspectTemplates: + parameters: *ref_1 + post: + description: >- + Creates an InspectTemplate for reusing frequently used configuration for + inspecting content, images, and storage. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates + to learn more. + operationId: dlp.organizations.locations.inspectTemplates.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2UpdateConnectionRequest' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2CreateInspectTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12762,7 +13530,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' parameters: - in: path name: organizationsId @@ -12774,14 +13542,12 @@ paths: required: true schema: type: string - - in: path - name: connectionsId - required: true - schema: - type: string get: - description: Get a Connection by name. - operationId: dlp.organizations.locations.connections.get + description: >- + Lists InspectTemplates. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates + to learn more. + operationId: dlp.organizations.locations.inspectTemplates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12793,7 +13559,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListInspectTemplatesResponse parameters: - in: path name: organizationsId @@ -12805,21 +13572,37 @@ paths: required: true schema: type: string - - in: path - name: connectionsId - required: true + - in: query + name: pageToken schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/connections: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: locationId + schema: + type: string + /v2/organizations/{organizationsId}/locations/{locationsId}/inspectTemplates/{inspectTemplatesId}: parameters: *ref_1 - post: - description: Create a Connection to an external data source. - operationId: dlp.organizations.locations.connections.create + patch: + description: >- + Updates the InspectTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates + to learn more. + operationId: dlp.organizations.locations.inspectTemplates.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2CreateConnectionRequest' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2UpdateInspectTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12831,7 +13614,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' parameters: - in: path name: organizationsId @@ -12843,52 +13626,17 @@ paths: required: true schema: type: string - get: - description: >- - Lists Connections in a parent. Use SearchConnections to see all - connections within an organization. - operationId: dlp.organizations.locations.connections.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ListConnectionsResponse' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - in: path - name: locationsId + name: inspectTemplatesId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v2/organizations/{organizationsId}/locations/{locationsId}/discoveryConfigs/{discoveryConfigsId}: - parameters: *ref_1 get: - description: Gets a discovery configuration. - operationId: dlp.organizations.locations.discoveryConfigs.get + description: >- + Gets an InspectTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates + to learn more. + operationId: dlp.organizations.locations.inspectTemplates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12900,7 +13648,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' parameters: - in: path name: organizationsId @@ -12913,13 +13661,16 @@ paths: schema: type: string - in: path - name: discoveryConfigsId + name: inspectTemplatesId required: true schema: type: string delete: - description: Deletes a discovery configuration. - operationId: dlp.organizations.locations.discoveryConfigs.delete + description: >- + Deletes an InspectTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates + to learn more. + operationId: dlp.organizations.locations.inspectTemplates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12944,19 +13695,25 @@ paths: schema: type: string - in: path - name: discoveryConfigsId + name: inspectTemplatesId required: true schema: type: string - patch: - description: Updates a discovery configuration. - operationId: dlp.organizations.locations.discoveryConfigs.patch + /v2/organizations/{organizationsId}/locations/{locationsId}/deidentifyTemplates: + parameters: *ref_1 + post: + description: >- + Creates a DeidentifyTemplate for reusing frequently used configuration + for de-identifying content, images, and storage. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + to learn more. + operationId: dlp.organizations.locations.deidentifyTemplates.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateDiscoveryConfigRequest + #/components/schemas/GooglePrivacyDlpV2CreateDeidentifyTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12968,7 +13725,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path name: organizationsId @@ -12980,16 +13737,12 @@ paths: required: true schema: type: string - - in: path - name: discoveryConfigsId - required: true - schema: - type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/discoveryConfigs: - parameters: *ref_1 get: - description: Lists discovery configurations. - operationId: dlp.organizations.locations.discoveryConfigs.list + description: >- + Lists DeidentifyTemplates. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + to learn more. + operationId: dlp.organizations.locations.deidentifyTemplates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13002,7 +13755,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListDiscoveryConfigsResponse + #/components/schemas/GooglePrivacyDlpV2ListDeidentifyTemplatesResponse parameters: - in: path name: organizationsId @@ -13027,15 +13780,24 @@ paths: name: orderBy schema: type: string - post: - description: Creates a config for discovery to scan and profile storage. - operationId: dlp.organizations.locations.discoveryConfigs.create + - in: query + name: locationId + schema: + type: string + /v2/organizations/{organizationsId}/locations/{locationsId}/deidentifyTemplates/{deidentifyTemplatesId}: + parameters: *ref_1 + patch: + description: >- + Updates the DeidentifyTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + to learn more. + operationId: dlp.organizations.locations.deidentifyTemplates.patch requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateDiscoveryConfigRequest + #/components/schemas/GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13047,7 +13809,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path name: organizationsId @@ -13059,11 +13821,17 @@ paths: required: true schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/projectDataProfiles: - parameters: *ref_1 + - in: path + name: deidentifyTemplatesId + required: true + schema: + type: string get: - description: Lists project data profiles for an organization. - operationId: dlp.organizations.locations.projectDataProfiles.list + description: >- + Gets a DeidentifyTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + to learn more. + operationId: dlp.organizations.locations.deidentifyTemplates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13075,8 +13843,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListProjectDataProfilesResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path name: organizationsId @@ -13088,28 +13855,17 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: orderBy + - in: path + name: deidentifyTemplatesId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v2/organizations/{organizationsId}/locations/{locationsId}/projectDataProfiles/{projectDataProfilesId}: - parameters: *ref_1 - get: - description: Gets a project data profile. - operationId: dlp.organizations.locations.projectDataProfiles.get + delete: + description: >- + Deletes a DeidentifyTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + to learn more. + operationId: dlp.organizations.locations.deidentifyTemplates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13121,7 +13877,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ProjectDataProfile' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -13134,20 +13890,24 @@ paths: schema: type: string - in: path - name: projectDataProfilesId + name: deidentifyTemplatesId required: true schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/dlpJobs: + /v2/organizations/{organizationsId}/locations/{locationsId}/jobTriggers: parameters: *ref_1 - get: + post: description: >- - Lists DlpJobs that match the specified filter in the request. See - https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage - and - https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis + Creates a job trigger to run DLP actions such as scanning storage for + sensitive information on a set schedule. See + https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. - operationId: dlp.organizations.locations.dlpJobs.list + operationId: dlp.organizations.locations.jobTriggers.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2CreateJobTriggerRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13159,7 +13919,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ListDlpJobsResponse' + $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' parameters: - in: path name: organizationsId @@ -13171,39 +13931,12 @@ paths: required: true schema: type: string - - in: query - name: type - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: locationId - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - - in: query - name: orderBy - schema: - type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/inspectTemplates/{inspectTemplatesId}: - parameters: *ref_1 get: description: >- - Gets an InspectTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates + Lists job triggers. See + https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. - operationId: dlp.organizations.locations.inspectTemplates.get + operationId: dlp.organizations.locations.jobTriggers.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13215,7 +13948,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2ListJobTriggersResponse' parameters: - in: path name: organizationsId @@ -13227,23 +13960,44 @@ paths: required: true schema: type: string - - in: path - name: inspectTemplatesId - required: true + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: type + schema: + type: string + - in: query + name: locationId schema: type: string + /v2/organizations/{organizationsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}: + parameters: *ref_1 patch: description: >- - Updates the InspectTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates + Updates a job trigger. See + https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. - operationId: dlp.organizations.locations.inspectTemplates.patch + operationId: dlp.organizations.locations.jobTriggers.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateInspectTemplateRequest + $ref: '#/components/schemas/GooglePrivacyDlpV2UpdateJobTriggerRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13255,7 +14009,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' parameters: - in: path name: organizationsId @@ -13268,16 +14022,16 @@ paths: schema: type: string - in: path - name: inspectTemplatesId + name: jobTriggersId required: true schema: type: string - delete: + get: description: >- - Deletes an InspectTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates + Gets a job trigger. See + https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. - operationId: dlp.organizations.locations.inspectTemplates.delete + operationId: dlp.organizations.locations.jobTriggers.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13289,7 +14043,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' parameters: - in: path name: organizationsId @@ -13302,18 +14056,16 @@ paths: schema: type: string - in: path - name: inspectTemplatesId + name: jobTriggersId required: true schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/inspectTemplates: - parameters: *ref_1 - get: + delete: description: >- - Lists InspectTemplates. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates + Deletes a job trigger. See + https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. - operationId: dlp.organizations.locations.inspectTemplates.list + operationId: dlp.organizations.locations.jobTriggers.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13325,8 +14077,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListInspectTemplatesResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -13338,36 +14089,22 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: locationId + - in: path + name: jobTriggersId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 + /v2/organizations/{organizationsId}/locations/{locationsId}/discoveryConfigs: + parameters: *ref_1 post: - description: >- - Creates an InspectTemplate for reusing frequently used configuration for - inspecting content, images, and storage. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates - to learn more. - operationId: dlp.organizations.locations.inspectTemplates.create + description: Creates a config for discovery to scan and profile storage. + operationId: dlp.organizations.locations.discoveryConfigs.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateInspectTemplateRequest + #/components/schemas/GooglePrivacyDlpV2CreateDiscoveryConfigRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13379,7 +14116,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' parameters: - in: path name: organizationsId @@ -13391,14 +14128,9 @@ paths: required: true schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/storedInfoTypes: - parameters: *ref_1 get: - description: >- - Lists stored infoTypes. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes - to learn more. - operationId: dlp.organizations.locations.storedInfoTypes.list + description: Lists discovery configurations. + operationId: dlp.organizations.locations.discoveryConfigs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13411,7 +14143,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListStoredInfoTypesResponse + #/components/schemas/GooglePrivacyDlpV2ListDiscoveryConfigsResponse parameters: - in: path name: organizationsId @@ -13424,7 +14156,7 @@ paths: schema: type: string - in: query - name: locationId + name: pageToken schema: type: string - in: query @@ -13436,22 +14168,17 @@ paths: name: orderBy schema: type: string - - in: query - name: pageToken - schema: - type: string - post: - description: >- - Creates a pre-built stored infoType to be used for inspection. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes - to learn more. - operationId: dlp.organizations.locations.storedInfoTypes.create + /v2/organizations/{organizationsId}/locations/{locationsId}/discoveryConfigs/{discoveryConfigsId}: + parameters: *ref_1 + patch: + description: Updates a discovery configuration. + operationId: dlp.organizations.locations.discoveryConfigs.patch requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateStoredInfoTypeRequest + #/components/schemas/GooglePrivacyDlpV2UpdateDiscoveryConfigRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13463,7 +14190,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' parameters: - in: path name: organizationsId @@ -13475,21 +14202,14 @@ paths: required: true schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/storedInfoTypes/{storedInfoTypesId}: - parameters: *ref_1 - patch: - description: >- - Updates the stored infoType by creating a new version. The existing - version will continue to be used until the new version is ready. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes - to learn more. - operationId: dlp.organizations.locations.storedInfoTypes.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateStoredInfoTypeRequest + - in: path + name: discoveryConfigsId + required: true + schema: + type: string + get: + description: Gets a discovery configuration. + operationId: dlp.organizations.locations.discoveryConfigs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13501,7 +14221,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' parameters: - in: path name: organizationsId @@ -13514,16 +14234,13 @@ paths: schema: type: string - in: path - name: storedInfoTypesId + name: discoveryConfigsId required: true schema: type: string delete: - description: >- - Deletes a stored infoType. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes - to learn more. - operationId: dlp.organizations.locations.storedInfoTypes.delete + description: Deletes a discovery configuration. + operationId: dlp.organizations.locations.discoveryConfigs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13548,16 +14265,20 @@ paths: schema: type: string - in: path - name: storedInfoTypesId + name: discoveryConfigsId required: true schema: type: string + /v2/organizations/{organizationsId}/locations/{locationsId}/dlpJobs: + parameters: *ref_1 get: description: >- - Gets a stored infoType. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + Lists DlpJobs that match the specified filter in the request. See + https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage + and + https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. - operationId: dlp.organizations.locations.storedInfoTypes.get + operationId: dlp.organizations.locations.dlpJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13569,7 +14290,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: '#/components/schemas/GooglePrivacyDlpV2ListDlpJobsResponse' parameters: - in: path name: organizationsId @@ -13581,25 +14302,45 @@ paths: required: true schema: type: string - - in: path - name: storedInfoTypesId - required: true + - in: query + name: filter schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/jobTriggers: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: type + schema: + type: string + - in: query + name: orderBy + schema: + type: string + - in: query + name: locationId + schema: + type: string + /v2/organizations/{organizationsId}/locations/{locationsId}/storedInfoTypes: parameters: *ref_1 post: description: >- - Creates a job trigger to run DLP actions such as scanning storage for - sensitive information on a set schedule. See - https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers + Creates a pre-built stored infoType to be used for inspection. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.organizations.locations.jobTriggers.create + operationId: dlp.organizations.locations.storedInfoTypes.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2CreateJobTriggerRequest' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2CreateStoredInfoTypeRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13611,7 +14352,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' parameters: - in: path name: organizationsId @@ -13625,10 +14366,10 @@ paths: type: string get: description: >- - Lists job triggers. See - https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers + Lists stored infoTypes. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.organizations.locations.jobTriggers.list + operationId: dlp.organizations.locations.storedInfoTypes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13640,7 +14381,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ListJobTriggersResponse' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListStoredInfoTypesResponse parameters: - in: path name: organizationsId @@ -13653,11 +14395,7 @@ paths: schema: type: string - in: query - name: filter - schema: - type: string - - in: query - name: orderBy + name: pageToken schema: type: string - in: query @@ -13666,30 +14404,28 @@ paths: type: integer format: int32 - in: query - name: pageToken + name: orderBy schema: type: string - in: query name: locationId schema: type: string - - in: query - name: type - schema: - type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}: + /v2/organizations/{organizationsId}/locations/{locationsId}/storedInfoTypes/{storedInfoTypesId}: parameters: *ref_1 patch: description: >- - Updates a job trigger. See - https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers + Updates the stored infoType by creating a new version. The existing + version will continue to be used until the new version is ready. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.organizations.locations.jobTriggers.patch + operationId: dlp.organizations.locations.storedInfoTypes.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2UpdateJobTriggerRequest' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2UpdateStoredInfoTypeRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13701,7 +14437,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' parameters: - in: path name: organizationsId @@ -13714,16 +14450,16 @@ paths: schema: type: string - in: path - name: jobTriggersId + name: storedInfoTypesId required: true schema: type: string get: description: >- - Gets a job trigger. See - https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers + Gets a stored infoType. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.organizations.locations.jobTriggers.get + operationId: dlp.organizations.locations.storedInfoTypes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13735,7 +14471,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' parameters: - in: path name: organizationsId @@ -13748,16 +14484,16 @@ paths: schema: type: string - in: path - name: jobTriggersId + name: storedInfoTypesId required: true schema: type: string delete: description: >- - Deletes a job trigger. See - https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers + Deletes a stored infoType. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.organizations.locations.jobTriggers.delete + operationId: dlp.organizations.locations.storedInfoTypes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13782,15 +14518,15 @@ paths: schema: type: string - in: path - name: jobTriggersId + name: storedInfoTypesId required: true schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/fileStoreDataProfiles/{fileStoreDataProfilesId}: + /v2/organizations/{organizationsId}/locations/{locationsId}/projectDataProfiles: parameters: *ref_1 get: - description: Gets a file store data profile. - operationId: dlp.organizations.locations.fileStoreDataProfiles.get + description: Lists project data profiles for an organization. + operationId: dlp.organizations.locations.projectDataProfiles.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13802,7 +14538,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreDataProfile' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListProjectDataProfilesResponse parameters: - in: path name: organizationsId @@ -13814,17 +14551,28 @@ paths: required: true schema: type: string - - in: path - name: fileStoreDataProfilesId - required: true + - in: query + name: pageToken schema: type: string - delete: - description: >- - Delete a FileStoreDataProfile. Will not prevent the profile from being - regenerated if the resource is still included in a discovery - configuration. - operationId: dlp.organizations.locations.fileStoreDataProfiles.delete + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: filter + schema: + type: string + /v2/organizations/{organizationsId}/locations/{locationsId}/projectDataProfiles/{projectDataProfilesId}: + parameters: *ref_1 + get: + description: Gets a project data profile. + operationId: dlp.organizations.locations.projectDataProfiles.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13836,7 +14584,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2ProjectDataProfile' parameters: - in: path name: organizationsId @@ -13849,15 +14597,15 @@ paths: schema: type: string - in: path - name: fileStoreDataProfilesId + name: projectDataProfilesId required: true schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/fileStoreDataProfiles: + /v2/organizations/{organizationsId}/locations/{locationsId}/tableDataProfiles: parameters: *ref_1 get: - description: Lists file store data profiles for an organization. - operationId: dlp.organizations.locations.fileStoreDataProfiles.list + description: Lists table data profiles for an organization. + operationId: dlp.organizations.locations.tableDataProfiles.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13870,7 +14618,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListFileStoreDataProfilesResponse + #/components/schemas/GooglePrivacyDlpV2ListTableDataProfilesResponse parameters: - in: path name: organizationsId @@ -13883,7 +14631,7 @@ paths: schema: type: string - in: query - name: filter + name: pageToken schema: type: string - in: query @@ -13896,23 +14644,14 @@ paths: schema: type: string - in: query - name: pageToken + name: filter schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/deidentifyTemplates/{deidentifyTemplatesId}: + /v2/organizations/{organizationsId}/locations/{locationsId}/tableDataProfiles/{tableDataProfilesId}: parameters: *ref_1 - patch: - description: >- - Updates the DeidentifyTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid - to learn more. - operationId: dlp.organizations.locations.deidentifyTemplates.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest + get: + description: Gets a table data profile. + operationId: dlp.organizations.locations.tableDataProfiles.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13924,7 +14663,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2TableDataProfile' parameters: - in: path name: organizationsId @@ -13937,16 +14676,15 @@ paths: schema: type: string - in: path - name: deidentifyTemplatesId + name: tableDataProfilesId required: true schema: type: string delete: description: >- - Deletes a DeidentifyTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid - to learn more. - operationId: dlp.organizations.locations.deidentifyTemplates.delete + Delete a TableDataProfile. Will not prevent the profile from being + regenerated if the table is still included in a discovery configuration. + operationId: dlp.organizations.locations.tableDataProfiles.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13971,16 +14709,15 @@ paths: schema: type: string - in: path - name: deidentifyTemplatesId + name: tableDataProfilesId required: true schema: type: string + /v2/organizations/{organizationsId}/locations/{locationsId}/columnDataProfiles: + parameters: *ref_1 get: - description: >- - Gets a DeidentifyTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid - to learn more. - operationId: dlp.organizations.locations.deidentifyTemplates.get + description: Lists column data profiles for an organization. + operationId: dlp.organizations.locations.columnDataProfiles.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13992,7 +14729,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListColumnDataProfilesResponse parameters: - in: path name: organizationsId @@ -14004,26 +14742,28 @@ paths: required: true schema: type: string - - in: path - name: deidentifyTemplatesId - required: true + - in: query + name: pageToken schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/deidentifyTemplates: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: filter + schema: + type: string + /v2/organizations/{organizationsId}/locations/{locationsId}/columnDataProfiles/{columnDataProfilesId}: parameters: *ref_1 - post: - description: >- - Creates a DeidentifyTemplate for reusing frequently used configuration - for de-identifying content, images, and storage. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid - to learn more. - operationId: dlp.organizations.locations.deidentifyTemplates.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateDeidentifyTemplateRequest + get: + description: Gets a column data profile. + operationId: dlp.organizations.locations.columnDataProfiles.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14035,7 +14775,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2ColumnDataProfile' parameters: - in: path name: organizationsId @@ -14047,12 +14787,16 @@ paths: required: true schema: type: string + - in: path + name: columnDataProfilesId + required: true + schema: + type: string + /v2/organizations/{organizationsId}/locations/{locationsId}/fileStoreDataProfiles: + parameters: *ref_1 get: - description: >- - Lists DeidentifyTemplates. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid - to learn more. - operationId: dlp.organizations.locations.deidentifyTemplates.list + description: Lists file store data profiles for an organization. + operationId: dlp.organizations.locations.fileStoreDataProfiles.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14065,7 +14809,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListDeidentifyTemplatesResponse + #/components/schemas/GooglePrivacyDlpV2ListFileStoreDataProfilesResponse parameters: - in: path name: organizationsId @@ -14078,7 +14822,7 @@ paths: schema: type: string - in: query - name: locationId + name: pageToken schema: type: string - in: query @@ -14087,18 +14831,18 @@ paths: type: integer format: int32 - in: query - name: pageToken + name: orderBy schema: type: string - in: query - name: orderBy + name: filter schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/columnDataProfiles: + /v2/organizations/{organizationsId}/locations/{locationsId}/fileStoreDataProfiles/{fileStoreDataProfilesId}: parameters: *ref_1 get: - description: Lists column data profiles for an organization. - operationId: dlp.organizations.locations.columnDataProfiles.list + description: Gets a file store data profile. + operationId: dlp.organizations.locations.fileStoreDataProfiles.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14110,8 +14854,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListColumnDataProfilesResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreDataProfile' parameters: - in: path name: organizationsId @@ -14123,28 +14866,17 @@ paths: required: true schema: type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: fileStoreDataProfilesId + required: true schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/columnDataProfiles/{columnDataProfilesId}: - parameters: *ref_1 - get: - description: Gets a column data profile. - operationId: dlp.organizations.locations.columnDataProfiles.get + delete: + description: >- + Delete a FileStoreDataProfile. Will not prevent the profile from being + regenerated if the resource is still included in a discovery + configuration. + operationId: dlp.organizations.locations.fileStoreDataProfiles.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14156,7 +14888,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ColumnDataProfile' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -14169,17 +14901,20 @@ paths: schema: type: string - in: path - name: columnDataProfilesId + name: fileStoreDataProfilesId required: true schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/tableDataProfiles/{tableDataProfilesId}: + /v2/organizations/{organizationsId}/locations/{locationsId}/connections: parameters: *ref_1 - delete: - description: >- - Delete a TableDataProfile. Will not prevent the profile from being - regenerated if the table is still included in a discovery configuration. - operationId: dlp.organizations.locations.tableDataProfiles.delete + post: + description: Create a Connection to an external data source. + operationId: dlp.organizations.locations.connections.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2CreateConnectionRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14191,7 +14926,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' parameters: - in: path name: organizationsId @@ -14203,14 +14938,11 @@ paths: required: true schema: type: string - - in: path - name: tableDataProfilesId - required: true - schema: - type: string get: - description: Gets a table data profile. - operationId: dlp.organizations.locations.tableDataProfiles.get + description: >- + Lists Connections in a parent. Use SearchConnections to see all + connections within an organization. + operationId: dlp.organizations.locations.connections.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14222,7 +14954,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2TableDataProfile' + $ref: '#/components/schemas/GooglePrivacyDlpV2ListConnectionsResponse' parameters: - in: path name: organizationsId @@ -14234,16 +14966,24 @@ paths: required: true schema: type: string - - in: path - name: tableDataProfilesId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/tableDataProfiles: + - in: query + name: filter + schema: + type: string + /v2/organizations/{organizationsId}/locations/{locationsId}/connections/{connectionsId}: parameters: *ref_1 get: - description: Lists table data profiles for an organization. - operationId: dlp.organizations.locations.tableDataProfiles.list + description: Get a Connection by name. + operationId: dlp.organizations.locations.connections.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14255,8 +14995,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListTableDataProfilesResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' parameters: - in: path name: organizationsId @@ -14268,31 +15007,14 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: connectionsId + required: true schema: type: string - /v2/organizations/{organizationsId}/storedInfoTypes: - parameters: *ref_1 - get: - description: >- - Lists stored infoTypes. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes - to learn more. - operationId: dlp.organizations.storedInfoTypes.list + delete: + description: Delete a Connection. + operationId: dlp.organizations.locations.connections.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14304,43 +15026,31 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListStoredInfoTypesResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: locationId + - in: path + name: locationsId + required: true schema: type: string - - in: query - name: orderBy + - in: path + name: connectionsId + required: true schema: type: string - post: - description: >- - Creates a pre-built stored infoType to be used for inspection. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes - to learn more. - operationId: dlp.organizations.storedInfoTypes.create + patch: + description: Update a Connection. + operationId: dlp.organizations.locations.connections.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateStoredInfoTypeRequest + $ref: '#/components/schemas/GooglePrivacyDlpV2UpdateConnectionRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14352,28 +15062,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' parameters: - in: path name: organizationsId required: true schema: type: string - /v2/organizations/{organizationsId}/storedInfoTypes/{storedInfoTypesId}: + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: connectionsId + required: true + schema: + type: string + /v2/organizations/{organizationsId}/locations/{locationsId}/connections:search: parameters: *ref_1 - patch: - description: >- - Updates the stored infoType by creating a new version. The existing - version will continue to be used until the new version is ready. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes - to learn more. - operationId: dlp.organizations.storedInfoTypes.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateStoredInfoTypeRequest + get: + description: Searches for Connections in a parent. + operationId: dlp.organizations.locations.connections.search security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14385,7 +15095,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2SearchConnectionsResponse parameters: - in: path name: organizationsId @@ -14393,16 +15104,38 @@ paths: schema: type: string - in: path - name: storedInfoTypesId + name: locationsId required: true schema: type: string - get: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + /v2/organizations/{organizationsId}/inspectTemplates: + parameters: *ref_1 + post: description: >- - Gets a stored infoType. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + Creates an InspectTemplate for reusing frequently used configuration for + inspecting content, images, and storage. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.organizations.storedInfoTypes.get + operationId: dlp.organizations.inspectTemplates.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2CreateInspectTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14414,24 +15147,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' parameters: - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: storedInfoTypesId + name: organizationsId required: true schema: type: string - delete: + get: description: >- - Deletes a stored infoType. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + Lists InspectTemplates. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.organizations.storedInfoTypes.delete + operationId: dlp.organizations.inspectTemplates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14443,26 +15171,45 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListInspectTemplatesResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: storedInfoTypesId - required: true + - in: query + name: pageToken schema: type: string - /v2/organizations/{organizationsId}/deidentifyTemplates/{deidentifyTemplatesId}: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: locationId + schema: + type: string + /v2/organizations/{organizationsId}/inspectTemplates/{inspectTemplatesId}: parameters: *ref_1 - get: + patch: description: >- - Gets a DeidentifyTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + Updates the InspectTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.organizations.deidentifyTemplates.get + operationId: dlp.organizations.inspectTemplates.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2UpdateInspectTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14474,7 +15221,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' parameters: - in: path name: organizationsId @@ -14482,22 +15229,16 @@ paths: schema: type: string - in: path - name: deidentifyTemplatesId + name: inspectTemplatesId required: true schema: type: string - patch: + get: description: >- - Updates the DeidentifyTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + Gets an InspectTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.organizations.deidentifyTemplates.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest + operationId: dlp.organizations.inspectTemplates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14509,7 +15250,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' parameters: - in: path name: organizationsId @@ -14517,16 +15258,16 @@ paths: schema: type: string - in: path - name: deidentifyTemplatesId + name: inspectTemplatesId required: true schema: type: string delete: description: >- - Deletes a DeidentifyTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + Deletes an InspectTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.organizations.deidentifyTemplates.delete + operationId: dlp.organizations.inspectTemplates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14546,7 +15287,7 @@ paths: schema: type: string - in: path - name: deidentifyTemplatesId + name: inspectTemplatesId required: true schema: type: string @@ -14608,31 +15349,66 @@ paths: required: true schema: type: string + - in: query + name: pageToken + schema: + type: string - in: query name: pageSize schema: type: integer format: int32 - in: query - name: locationId + name: orderBy schema: type: string - in: query - name: pageToken + name: locationId schema: type: string - - in: query - name: orderBy + /v2/organizations/{organizationsId}/deidentifyTemplates/{deidentifyTemplatesId}: + parameters: *ref_1 + patch: + description: >- + Updates the DeidentifyTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + to learn more. + operationId: dlp.organizations.deidentifyTemplates.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: deidentifyTemplatesId + required: true schema: type: string - /v2/organizations/{organizationsId}/inspectTemplates/{inspectTemplatesId}: - parameters: *ref_1 get: description: >- - Gets an InspectTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates + Gets a DeidentifyTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. - operationId: dlp.organizations.inspectTemplates.get + operationId: dlp.organizations.deidentifyTemplates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14644,7 +15420,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path name: organizationsId @@ -14652,16 +15428,16 @@ paths: schema: type: string - in: path - name: inspectTemplatesId + name: deidentifyTemplatesId required: true schema: type: string delete: description: >- - Deletes an InspectTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates + Deletes a DeidentifyTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. - operationId: dlp.organizations.inspectTemplates.delete + operationId: dlp.organizations.deidentifyTemplates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14681,22 +15457,24 @@ paths: schema: type: string - in: path - name: inspectTemplatesId + name: deidentifyTemplatesId required: true schema: type: string - patch: + /v2/organizations/{organizationsId}/storedInfoTypes: + parameters: *ref_1 + post: description: >- - Updates the InspectTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates + Creates a pre-built stored infoType to be used for inspection. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.organizations.inspectTemplates.patch + operationId: dlp.organizations.storedInfoTypes.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateInspectTemplateRequest + #/components/schemas/GooglePrivacyDlpV2CreateStoredInfoTypeRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14708,26 +15486,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: inspectTemplatesId - required: true - schema: - type: string - /v2/organizations/{organizationsId}/inspectTemplates: - parameters: *ref_1 get: description: >- - Lists InspectTemplates. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates + Lists stored infoTypes. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.organizations.inspectTemplates.list + operationId: dlp.organizations.storedInfoTypes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14740,17 +15511,13 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListInspectTemplatesResponse + #/components/schemas/GooglePrivacyDlpV2ListStoredInfoTypesResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: locationId - schema: - type: string - in: query name: pageToken schema: @@ -14764,19 +15531,25 @@ paths: name: orderBy schema: type: string - post: + - in: query + name: locationId + schema: + type: string + /v2/organizations/{organizationsId}/storedInfoTypes/{storedInfoTypesId}: + parameters: *ref_1 + patch: description: >- - Creates an InspectTemplate for reusing frequently used configuration for - inspecting content, images, and storage. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates + Updates the stored infoType by creating a new version. The existing + version will continue to be used until the new version is ready. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.organizations.inspectTemplates.create + operationId: dlp.organizations.storedInfoTypes.patch requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateInspectTemplateRequest + #/components/schemas/GooglePrivacyDlpV2UpdateStoredInfoTypeRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14788,22 +15561,24 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' parameters: - in: path name: organizationsId required: true schema: type: string - /v2/infoTypes: - parameters: *ref_1 + - in: path + name: storedInfoTypesId + required: true + schema: + type: string get: description: >- - Returns a list of the sensitive information types that the DLP API - supports. See - https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference + Gets a stored infoType. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.infoTypes.list + operationId: dlp.organizations.storedInfoTypes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14815,33 +15590,24 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ListInfoTypesResponse' + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' parameters: - - in: query - name: filter - schema: - type: string - - in: query - name: parent - schema: - type: string - - in: query - name: locationId + - in: path + name: organizationsId + required: true schema: type: string - - in: query - name: languageCode + - in: path + name: storedInfoTypesId + required: true schema: type: string - /v2/locations/{locationsId}/infoTypes: - parameters: *ref_1 - get: + delete: description: >- - Returns a list of the sensitive information types that the DLP API - supports. See - https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference + Deletes a stored infoType. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.locations.infoTypes.list + operationId: dlp.organizations.storedInfoTypes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14853,22 +15619,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ListInfoTypesResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: locationsId + name: organizationsId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: languageCode - schema: - type: string - - in: query - name: locationId + - in: path + name: storedInfoTypesId + required: true schema: type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/dns.yaml b/providers/src/googleapis.com/v00.00.00000/services/dns.yaml index 6dbea4d7..34b6f8a0 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/dns.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/dns.yaml @@ -7,8 +7,8 @@ info: title: Cloud DNS API description: '' version: v1 - x-discovery-doc-revision: '20241021' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250729' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/dns/docs servers: @@ -121,8 +121,9 @@ components: $ref: '#/components/schemas/RRSetRoutingPolicyPrimaryBackupPolicy' healthCheck: description: >- - The selfLink attribute of the HealthCheck resource to use for this - RRSetRoutingPolicy. + The fully qualified URL of the HealthCheck to use for this + RRSetRoutingPolicy. Format this URL like + `https://www.googleapis.com/compute/v1/projects/{project}/global/healthChecks/{healthCheck}`. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks type: string kind: @@ -173,8 +174,8 @@ components: signatureRrdatas: description: >- DNSSEC generated signatures for all the `rrdata` within this item. - If health checked targets are provided for DNSSEC enabled zones, - there's a restriction of 1 IP address per item. + When using health-checked targets for DNSSEC-enabled zones, you can + only use at most one health-checked IP address per item. type: array items: type: string @@ -192,7 +193,8 @@ components: description: >- HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included - in the response. + in the response. Set either `internal_load_balancer` or + `external_endpoints`. Do not set both. type: object properties: internalLoadBalancers: @@ -306,8 +308,8 @@ components: signatureRrdatas: description: >- DNSSEC generated signatures for all the `rrdata` within this item. - Note that if health checked targets are provided for DNSSEC enabled - zones, there's a restriction of 1 IP address per item. + When using health-checked targets for DNSSEC-enabled zones, you can + only use at most one health-checked IP address per item. type: array items: type: string @@ -1076,6 +1078,9 @@ components: IPv6 address of a target name server. Does not accept both fields (ipv4 & ipv6) being populated. Public preview as of November 2022. type: string + domainName: + description: Fully qualified domain name for the forwarding target. + type: string kind: default: dns#managedZoneForwardingConfigNameServerTarget type: string @@ -1630,6 +1635,9 @@ components: Controls whether logging is enabled for the networks bound to this policy. Defaults to no logging if not set. type: boolean + dns64Config: + description: Configurations related to DNS64 for this Policy. + $ref: '#/components/schemas/PolicyDns64Config' kind: default: dns#policy type: string @@ -1696,6 +1704,27 @@ components: kind: default: dns#policyAlternativeNameServerConfigTargetNameServer type: string + PolicyDns64Config: + id: PolicyDns64Config + description: DNS64 policies + type: object + properties: + scope: + description: The scope to which DNS64 config will be applied to. + $ref: '#/components/schemas/PolicyDns64ConfigScope' + kind: + default: dns#policyDns64Config + type: string + PolicyDns64ConfigScope: + id: PolicyDns64ConfigScope + type: object + properties: + allQueries: + description: Controls whether DNS64 is enabled globally at the network level. + type: boolean + kind: + default: dns#policyDns64ConfigScope + type: string PoliciesListResponse: id: PoliciesListResponse type: object diff --git a/providers/src/googleapis.com/v00.00.00000/services/documentai.yaml b/providers/src/googleapis.com/v00.00.00000/services/documentai.yaml index 388b8cdc..10ebe985 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/documentai.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/documentai.yaml @@ -10,8 +10,8 @@ info: documents using state-of-the-art Google AI such as natural language, computer vision, translation, and AutoML. version: v1 - x-discovery-doc-revision: '20241031' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250820' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/document-ai/docs/ servers: @@ -37,411 +37,586 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleProtobufEmpty: - properties: {} - id: GoogleProtobufEmpty - type: object - description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } - GoogleCloudDocumentaiV1ProcessorVersionAlias: + GoogleLongrunningListOperationsResponse: + id: GoogleLongrunningListOperationsResponse + description: The response message for Operations.ListOperations. type: object properties: - alias: - type: string - description: The alias in the form of `processor_version` resource name. - processorVersion: + operations: + description: >- + A list of operations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/GoogleLongrunningOperation' + nextPageToken: + description: The standard List next-page token. type: string - description: The resource name of aliased processor version. - description: Contains the alias and the aliased resource name of processor version. - id: GoogleCloudDocumentaiV1ProcessorVersionAlias - GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse: + GoogleLongrunningOperation: + id: GoogleLongrunningOperation + description: >- + This resource represents a long-running operation that is the result of + a network API call. + type: object properties: - evaluation: - description: The resource name of the created evaluation. + name: + description: >- + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. type: string - id: GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse + metadata: + description: >- + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + done: + description: >- + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + type: boolean + error: + description: >- + The error result of the operation in case of failure or + cancellation. + $ref: '#/components/schemas/GoogleRpcStatus' + response: + description: >- + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + GoogleRpcStatus: + id: GoogleRpcStatus + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). type: object - description: Response of the EvaluateProcessorVersion method. - GoogleCloudDocumentaiV1DocumentPageBlock: properties: - provenance: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - description: The history of this annotation. - deprecated: true - layout: - description: Layout for Block. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - detectedLanguages: + code: + description: The status code, which should be an enum value of google.rpc.Code. + type: integer + format: int32 + message: + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + type: string + details: + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. type: array items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - description: A list of detected languages together with confidence. - id: GoogleCloudDocumentaiV1DocumentPageBlock + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + GoogleProtobufEmpty: + id: GoogleProtobufEmpty description: >- - A block has a set of lines (collected into paragraphs) that have a - common line-spacing and orientation. + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } type: object - GoogleCloudDocumentaiV1DocumentPageDetectedBarcode: - description: A detected barcode. + properties: {} + GoogleCloudDocumentaiV1ProcessRequest: + id: GoogleCloudDocumentaiV1ProcessRequest + description: Request message for the ProcessDocument method. type: object - id: GoogleCloudDocumentaiV1DocumentPageDetectedBarcode properties: - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for DetectedBarcode. - barcode: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Barcode' - description: Detailed barcode information of the DetectedBarcode. - GoogleCloudDocumentaiV1EnableProcessorResponse: - id: GoogleCloudDocumentaiV1EnableProcessorResponse + inlineDocument: + description: An inline document proto. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Document' + rawDocument: + description: A raw document content (bytes). + $ref: '#/components/schemas/GoogleCloudDocumentaiV1RawDocument' + gcsDocument: + description: A raw document on Google Cloud Storage. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1GcsDocument' + skipHumanReview: + description: >- + Whether human review should be skipped for this request. Default to + `false`. + type: boolean + fieldMask: + description: >- + Specifies which fields to include in the ProcessResponse.document + output. Only supports top-level document and pages field, so it must + be in the form of `{document_field_name}` or + `pages.{page_field_name}`. + type: string + format: google-fieldmask + processOptions: + description: Inference-time options for the process API + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessOptions' + labels: + description: >- + Optional. The labels with user-defined metadata for the request. + Label keys and values can be no longer than 63 characters (Unicode + codepoints) and can only contain lowercase letters, numeric + characters, underscores, and dashes. International characters are + allowed. Label values are optional. Label keys must start with a + letter. + type: object + additionalProperties: + type: string + imagelessMode: + description: Optional. Option to remove images from the document. + type: boolean + GoogleCloudDocumentaiV1Document: + id: GoogleCloudDocumentaiV1Document description: >- - Response message for the EnableProcessor method. Intentionally empty - proto for adding fields in future. + Document represents the canonical document resource in Document AI. It + is an interchange format that provides insights into documents and + allows for collaboration between users and Document AI to iterate and + optimize for quality. type: object - properties: {} - GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadata: properties: - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - destDatasetType: - enumDescriptions: - - Default value if the enum is not set. - - Identifies the train documents. - - Identifies the test documents. - - Identifies the unassigned documents. - enum: - - DATASET_SPLIT_TYPE_UNSPECIFIED - - DATASET_SPLIT_TRAIN - - DATASET_SPLIT_TEST - - DATASET_SPLIT_UNASSIGNED - deprecated: true + uri: + description: >- + Optional. Currently supports Google Cloud Storage URI of the form + `gs://bucket_name/object_name`. Object versioning is not supported. + For more information, refer to [Google Cloud Storage Request + URIs](https://cloud.google.com/storage/docs/reference-uris). type: string - description: The destination dataset split type. - individualBatchMoveStatuses: - description: The list of response details of each document. + content: + description: >- + Optional. Inline document content, represented as a stream of bytes. + Note: As with all `bytes` fields, protobuffers use a pure binary + representation, whereas JSON representations use base64. + type: string + format: byte + docid: + description: >- + Optional. An internal identifier for document. Should be loggable + (no PII). + type: string + mimeType: + description: >- + An IANA published [media type (MIME + type)](https://www.iana.org/assignments/media-types/media-types.xhtml). + type: string + text: + description: Optional. UTF-8 encoded text in reading order from the document. + type: string + textStyles: + description: Styles for the Document.text. + deprecated: true type: array items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus - destSplitType: - enum: - - DATASET_SPLIT_TYPE_UNSPECIFIED - - DATASET_SPLIT_TRAIN - - DATASET_SPLIT_TEST - - DATASET_SPLIT_UNASSIGNED - enumDescriptions: - - Default value if the enum is not set. - - Identifies the train documents. - - Identifies the test documents. - - Identifies the unassigned documents. - type: string - description: The destination dataset split type. - id: GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadata - type: object - GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata: - id: GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata - type: object - properties: - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - errorDocumentCount: - type: integer - format: int32 - description: Total number of documents that failed to be deleted in storage. - individualBatchDeleteStatuses: - description: The list of response details of each document. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentStyle' + pages: + description: Visual page layout for the Document. + type: array items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPage' + entities: + description: >- + A list of entities detected on Document.text. For document shards, + entities in this list may cross shard boundaries. type: array - totalDocumentCount: - format: int32 - description: Total number of documents deleting from dataset. - type: integer - GoogleCloudDocumentaiV1HumanReviewStatus: - description: The status of human review on a processed document. - id: GoogleCloudDocumentaiV1HumanReviewStatus - type: object - properties: - state: - enum: - - STATE_UNSPECIFIED - - SKIPPED - - VALIDATION_PASSED - - IN_PROGRESS - - ERROR - enumDescriptions: - - >- - Human review state is unspecified. Most likely due to an internal - error. - - >- - Human review is skipped for the document. This can happen because - human review isn't enabled on the processor or the processing - request has been set to skip this document. - - >- - Human review validation is triggered and passed, so no review is - needed. - - >- - Human review validation is triggered and the document is under - review. - - >- - Some error happened during triggering human review, see the - state_message for details. - type: string - description: The state of human review on the processing request. - stateMessage: - type: string - description: A message providing more details about the human review state. - humanReviewOperation: - type: string + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntity' + entityRelations: + description: Placeholder. Relationship among Document.entities. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntityRelation' + textChanges: description: >- - The name of the operation triggered by the processed document. This - field is populated only when the state is - `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and - metadata as the long-running operation returned by ReviewDocument. - GoogleCloudDocumentaiV1DisableProcessorResponse: - properties: {} - description: >- - Response message for the DisableProcessor method. Intentionally empty - proto for adding fields in future. - type: object - id: GoogleCloudDocumentaiV1DisableProcessorResponse - GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata: - type: object - description: Metadata of the auto-labeling documents operation. - properties: - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - totalDocumentCount: - description: Total number of the auto-labeling documents. - format: int32 - type: integer - individualAutoLabelStatuses: + Placeholder. A list of text corrections made to Document.text. This + is usually used for annotating corrections to OCR mistakes. Text + changes for a given revision may not overlap with each other. type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextChange' + shardInfo: description: >- - The list of individual auto-labeling statuses of the dataset - documents. + Information about the sharding if this document is sharded part of a + larger document. If the document is not sharded, this message is not + specified. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentShardInfo' + error: + description: Any error that occurred while processing this document. + $ref: '#/components/schemas/GoogleRpcStatus' + revisions: + description: Placeholder. Revision history of this document. + type: array items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadataIndividualAutoLabelStatus - id: GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata - GoogleCloudDocumentaiV1beta3DocumentId: - id: GoogleCloudDocumentaiV1beta3DocumentId - properties: - unmanagedDocId: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId - description: A document id within unmanaged dataset. - revisionRef: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta3RevisionRef' - description: Points to a specific revision of the document if set. - gcsManagedDocId: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId - description: A document id within user-managed Cloud Storage. - description: Document Identifier. - type: object - GoogleCloudDocumentaiV1BatchProcessRequest: - id: GoogleCloudDocumentaiV1BatchProcessRequest + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentRevision' + documentLayout: + description: Parsed layout of the document. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayout' + chunkedDocument: + description: Document chunked based on chunking config. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocument' + GoogleCloudDocumentaiV1DocumentStyle: + id: GoogleCloudDocumentaiV1DocumentStyle + description: >- + Annotation for common text style attributes. This adheres to CSS + conventions as much as possible. type: object - description: Request message for BatchProcessDocuments. properties: - labels: + textAnchor: + description: Text anchor indexing into the Document.text. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' + color: + description: Text color. + $ref: '#/components/schemas/GoogleTypeColor' + backgroundColor: + description: Text background color. + $ref: '#/components/schemas/GoogleTypeColor' + fontWeight: description: >- - Optional. The labels with user-defined metadata for the request. - Label keys and values can be no longer than 63 characters (Unicode - codepoints) and can only contain lowercase letters, numeric - characters, underscores, and dashes. International characters are - allowed. Label values are optional. Label keys must start with a - letter. - additionalProperties: - type: string - type: object - inputDocuments: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1BatchDocumentsInputConfig - description: The input documents for the BatchProcessDocuments method. - documentOutputConfig: - description: The output configuration for the BatchProcessDocuments method. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentOutputConfig' - skipHumanReview: - type: boolean + [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). + Possible values are `normal`, `bold`, `bolder`, and `lighter`. + type: string + textStyle: description: >- - Whether human review should be skipped for this request. Default to - `false`. - processOptions: - description: Inference-time options for the process API - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessOptions' - GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata: - description: The long-running operation metadata for UpdateLabelerPool. - properties: - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - id: GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata - type: object - GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus: - properties: - documentId: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta3DocumentId' - description: The document id of the document. - status: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The status of deleting the document in storage. - description: The status of each individual document in the batch delete process. + [Text + style](https://www.w3schools.com/cssref/pr_font_font-style.asp). + Possible values are `normal`, `italic`, and `oblique`. + type: string + textDecoration: + description: >- + [Text + decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). + Follows CSS standard. + type: string + fontSize: + description: Font size. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentStyleFontSize' + fontFamily: + description: >- + Font family such as `Arial`, `Times New Roman`. + https://www.w3schools.com/cssref/pr_font_font-family.asp + type: string + GoogleCloudDocumentaiV1DocumentTextAnchor: + id: GoogleCloudDocumentaiV1DocumentTextAnchor + description: Text reference indexing into the Document.text. type: object - id: >- - GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus - GoogleCloudDocumentaiV1DocumentPageSymbol: properties: - detectedLanguages: - description: A list of detected languages together with confidence. + textSegments: + description: The text segments from the Document.text. type: array items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for Symbol. - id: GoogleCloudDocumentaiV1DocumentPageSymbol - type: object - description: A detected symbol. - GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus: + #/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment + content: + description: >- + Contains the content of the text span so that users do not have to + look it up in the text_segments. It is always populated for + formFields. + type: string + GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment: + id: GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment + description: >- + A text segment in the Document.text. The indices may be out of bounds + which indicate that the text extends into another document shard for + large sharded documents. See ShardInfo.text_offset type: object properties: - documentId: - description: The path to source docproto of the document. - $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' - outputGcsDestination: + startIndex: + description: TextSegment start UTF-8 char index in the Document.text. type: string - description: >- - The output_gcs_destination of the exported document if it was - successful, otherwise empty. - status: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The status of the exporting of the document. - description: The status of each individual document in the export process. - id: >- - GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus - GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse: - description: Response of the EvaluateProcessorVersion method. - id: GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse - properties: - evaluation: - description: The resource name of the created evaluation. + format: int64 + endIndex: + description: TextSegment half open end UTF-8 char index in the Document.text. type: string - type: object - GoogleTypeDateTime: - id: GoogleTypeDateTime + format: int64 + GoogleTypeColor: + id: GoogleTypeColor description: >- - Represents civil time (or occasionally physical time). This type can - represent a civil time in one of a few possible ways: * When utc_offset - is set and time_zone is unset: a civil time on a calendar day with a - particular offset from UTC. * When time_zone is set and utc_offset is - unset: a civil time on a calendar day in a particular time zone. * When - neither time_zone nor utc_offset is set: a civil time on a calendar day - in local time. The date is relative to the Proleptic Gregorian Calendar. - If year, month, or day are 0, the DateTime is considered not to have a - specific year, month, or day respectively. This type may also be used to - represent a physical time if all the date and time fields are set and - either case of the `time_offset` oneof is set. Consider using - `Timestamp` message for physical time instead. If your use case also - would like to store the user's timezone, that can be done in another - field. This type is more flexible than some applications may want. Make - sure to document and validate your application's limitations. + Represents a color in the RGBA color space. This representation is + designed for simplicity of conversion to and from color representations + in various languages over compactness. For example, the fields of this + representation can be trivially provided to the constructor of + `java.awt.Color` in Java; it can also be trivially provided to UIColor's + `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little + work, it can be easily formatted into a CSS `rgba()` string in + JavaScript. This reference page doesn't have information about the + absolute color space that should be used to interpret the RGB value—for + example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications + should assume the sRGB color space. When color equality needs to be + decided, implementations, unless documented otherwise, treat two colors + as equal if all their red, green, blue, and alpha values each differ by + at most `1e-5`. Example (Java): import com.google.type.Color; // ... + public static java.awt.Color fromProto(Color protocolor) { float alpha = + protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return + new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), + protocolor.getBlue(), alpha); } public static Color + toProto(java.awt.Color color) { float red = (float) color.getRed(); + float green = (float) color.getGreen(); float blue = (float) + color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder + = Color .newBuilder() .setRed(red / denominator) .setGreen(green / + denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); + if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() + .setValue(((float) alpha) / denominator) .build()); } return + resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static + UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; + float green = [protocolor green]; float blue = [protocolor blue]; + FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if + (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return + [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static + Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if + (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return + nil; } Color* result = [[Color alloc] init]; [result setRed:red]; + [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { + [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; + return result; } // ... Example (JavaScript): // ... var protoToCssColor + = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var + greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || + 0.0; var red = Math.floor(redFrac * 255); var green = + Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if + (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } + var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, + green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, + ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var + rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString + = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var + resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { + resultBuilder.push('0'); } resultBuilder.push(hexString); return + resultBuilder.join(''); }; // ... type: object properties: - nanos: - format: int32 + red: + description: The amount of red in the color as a value in the interval [0, 1]. + type: number + format: float + green: + description: The amount of green in the color as a value in the interval [0, 1]. + type: number + format: float + blue: + description: The amount of blue in the color as a value in the interval [0, 1]. + type: number + format: float + alpha: description: >- - Optional. Fractions of seconds in nanoseconds. Must be from 0 to - 999,999,999, defaults to 0. - type: integer - hours: - type: integer + The fraction of this color that should be applied to the pixel. That + is, the final pixel color is defined by the equation: `pixel color = + alpha * (this color) + (1.0 - alpha) * (background color)` This + means that a value of 1.0 corresponds to a solid color, whereas a + value of 0.0 corresponds to a completely transparent color. This + uses a wrapper message rather than a simple float scalar so that it + is possible to distinguish between a default value and the value + being unset. If omitted, this color object is rendered as a solid + color (as if the alpha value had been explicitly given a value of + 1.0). + type: number + format: float + GoogleCloudDocumentaiV1DocumentStyleFontSize: + id: GoogleCloudDocumentaiV1DocumentStyleFontSize + description: Font size with unit. + type: object + properties: + size: + description: Font size for the text. + type: number + format: float + unit: description: >- - Optional. Hours of day in 24 hour format. Should be from 0 to 23, - defaults to 0 (midnight). An API may choose to allow the value - "24:00:00" for scenarios like business closing time. - format: int32 - month: + Unit for the font size. Follows CSS naming (such as `in`, `px`, and + `pt`). + type: string + GoogleCloudDocumentaiV1DocumentPage: + id: GoogleCloudDocumentaiV1DocumentPage + description: A page in a Document. + type: object + properties: + pageNumber: description: >- - Optional. Month of year. Must be from 1 to 12, or 0 if specifying a - datetime without a month. + 1-based index for current Page in a parent Document. Useful when a + page is taken out of a Document for individual processing. type: integer format: int32 - year: - format: int32 + image: description: >- - Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a - datetime without a year. - type: integer - minutes: - format: int32 - type: integer + Rendered image for this page. This image is preprocessed to remove + any skew, rotation, and distortions such that the annotation + bounding boxes can be upright and axis-aligned. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageImage' + transforms: description: >- - Optional. Minutes of hour of day. Must be from 0 to 59, defaults to - 0. - utcOffset: - type: string - format: google-duration + Transformation matrices that were applied to the original document + image to produce Page.image. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageMatrix' + dimension: + description: Physical dimension of the page. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageDimension' + layout: + description: Layout for the page. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + detectedLanguages: + description: A list of detected languages together with confidence. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + blocks: description: >- - UTC offset. Must be whole seconds, between -18 hours and +18 hours. - For example, a UTC offset of -4:00 would be represented as { - seconds: -14400 }. - seconds: + A list of visually detected text blocks on the page. A block has a + set of lines (collected into paragraphs) that have a common + line-spacing and orientation. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageBlock' + paragraphs: description: >- - Optional. Seconds of minutes of the time. Must normally be from 0 to - 59, defaults to 0. An API may allow the value 60 if it allows - leap-seconds. - format: int32 + A list of visually detected text paragraphs on the page. A + collection of lines that a human would perceive as a paragraph. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageParagraph' + lines: + description: >- + A list of visually detected text lines on the page. A collection of + tokens that a human would perceive as a line. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLine' + tokens: + description: A list of visually detected tokens on the page. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageToken' + visualElements: + description: >- + A list of detected non-text visual elements e.g. checkbox, signature + etc. on the page. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageVisualElement + tables: + description: A list of visually detected tables on the page. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageTable' + formFields: + description: A list of visually detected form fields on the page. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageFormField' + symbols: + description: A list of visually detected symbols on the page. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageSymbol' + detectedBarcodes: + description: A list of detected barcodes. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedBarcode + imageQualityScores: + description: Image quality scores. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageImageQualityScores + provenance: + description: The history of this page. + deprecated: true + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + GoogleCloudDocumentaiV1DocumentPageImage: + id: GoogleCloudDocumentaiV1DocumentPageImage + description: Rendered image contents for this page. + type: object + properties: + content: + description: Raw byte content of the image. + type: string + format: byte + mimeType: + description: >- + Encoding [media type (MIME + type)](https://www.iana.org/assignments/media-types/media-types.xhtml) + for the image. + type: string + width: + description: Width of the image in pixels. type: integer - timeZone: - $ref: '#/components/schemas/GoogleTypeTimeZone' - description: Time zone. - day: format: int32 + height: + description: Height of the image in pixels. type: integer - description: >- - Optional. Day of month. Must be from 1 to 31 and valid for the year - and month, or 0 if specifying a datetime without a day. - GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata: - id: GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata + format: int32 + GoogleCloudDocumentaiV1DocumentPageMatrix: + id: GoogleCloudDocumentaiV1DocumentPageMatrix description: >- - The long-running operation metadata for the SetDefaultProcessorVersion - method. - properties: - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + Representation for transformation matrix, intended to be compatible and + used with OpenCV format for image manipulation. type: object - GoogleCloudDocumentaiV1GcsPrefix: properties: - gcsUriPrefix: + rows: + description: Number of rows in the matrix. + type: integer + format: int32 + cols: + description: Number of columns in the matrix. + type: integer + format: int32 + type: + description: >- + This encodes information about what data type the matrix uses. For + example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of + OpenCV primitive data types, please refer to + https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html + type: integer + format: int32 + data: + description: The matrix data. type: string - description: The URI prefix. - id: GoogleCloudDocumentaiV1GcsPrefix - description: Specifies all documents on Cloud Storage with a common prefix. + format: byte + GoogleCloudDocumentaiV1DocumentPageDimension: + id: GoogleCloudDocumentaiV1DocumentPageDimension + description: Dimension for the page. type: object + properties: + width: + description: Page width. + type: number + format: float + height: + description: Page height. + type: number + format: float + unit: + description: Dimension unit. + type: string GoogleCloudDocumentaiV1DocumentPageLayout: - description: Visual element describing a layout unit on a page. id: GoogleCloudDocumentaiV1DocumentPageLayout + description: Visual element describing a layout unit on a page. + type: object properties: - boundingPoly: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1BoundingPoly' - description: The bounding polygon for the Layout. + textAnchor: + description: Text anchor indexing into the Document.text. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' confidence: description: >- Confidence of the current Layout within context of the object this @@ -449,16 +624,12 @@ components: visual element, etc. depending on context. Range `[0, 1]`. type: number format: float - textAnchor: - description: Text anchor indexing into the Document.text. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' + boundingPoly: + description: The bounding polygon for the Layout. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1BoundingPoly' orientation: - enum: - - ORIENTATION_UNSPECIFIED - - PAGE_UP - - PAGE_RIGHT - - PAGE_DOWN - - PAGE_LEFT + description: Detected orientation for the Layout. + type: string enumDescriptions: - Unspecified orientation. - Orientation is aligned with page up. @@ -471,351 +642,766 @@ components: - >- Orientation is aligned with page left. Turn the head 90 degrees counterclockwise from upright to read. - description: Detected orientation for the Layout. + enum: + - ORIENTATION_UNSPECIFIED + - PAGE_UP + - PAGE_RIGHT + - PAGE_DOWN + - PAGE_LEFT + GoogleCloudDocumentaiV1BoundingPoly: + id: GoogleCloudDocumentaiV1BoundingPoly + description: A bounding polygon for the detected image annotation. + type: object + properties: + vertices: + description: The bounding polygon vertices. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Vertex' + normalizedVertices: + description: The bounding polygon normalized vertices. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1NormalizedVertex' + GoogleCloudDocumentaiV1Vertex: + id: GoogleCloudDocumentaiV1Vertex + description: >- + A vertex represents a 2D point in the image. NOTE: the vertex + coordinates are in the same scale as the original image. + type: object + properties: + x: + description: X coordinate. + type: integer + format: int32 + 'y': + description: Y coordinate (starts from the top of the image). + type: integer + format: int32 + GoogleCloudDocumentaiV1NormalizedVertex: + id: GoogleCloudDocumentaiV1NormalizedVertex + description: >- + A vertex represents a 2D point in the image. NOTE: the normalized vertex + coordinates are relative to the original image and range from 0 to 1. + type: object + properties: + x: + description: X coordinate. + type: number + format: float + 'y': + description: Y coordinate (starts from the top of the image). + type: number + format: float + GoogleCloudDocumentaiV1DocumentPageDetectedLanguage: + id: GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + description: Detected language for a structural component. + type: object + properties: + languageCode: + description: >- + The [BCP-47 language + code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), + such as `en-US` or `sr-Latn`. type: string + confidence: + description: Confidence of detected language. Range `[0, 1]`. + type: number + format: float + GoogleCloudDocumentaiV1DocumentPageBlock: + id: GoogleCloudDocumentaiV1DocumentPageBlock + description: >- + A block has a set of lines (collected into paragraphs) that have a + common line-spacing and orientation. type: object - GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata: properties: - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The long-running operation metadata for the DisableProcessor method. - id: GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata + layout: + description: Layout for Block. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + detectedLanguages: + description: A list of detected languages together with confidence. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + provenance: + description: The history of this annotation. + deprecated: true + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + GoogleCloudDocumentaiV1DocumentProvenance: + id: GoogleCloudDocumentaiV1DocumentProvenance + description: >- + Structure to identify provenance relationships between annotations in + different revisions. type: object + properties: + revision: + description: The index of the revision that produced this element. + deprecated: true + type: integer + format: int32 + id: + description: >- + The Id of this operation. Needs to be unique within the scope of the + revision. + deprecated: true + type: integer + format: int32 + parents: + description: References to the original elements that are replaced. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentProvenanceParent + type: + description: The type of provenance operation. + type: string + enumDescriptions: + - >- + Operation type unspecified. If no operation is specified a + provenance entry is simply used to match against a `parent`. + - Add an element. + - Remove an element identified by `parent`. + - >- + Updates any fields within the given provenance scope of the + message. It overwrites the fields rather than replacing them. Use + this when you want to update a field value of an entity without + also updating all the child properties. + - Currently unused. Replace an element identified by `parent`. + - >- + Deprecated. Request human review for the element identified by + `parent`. + - >- + Deprecated. Element is reviewed and approved at human review, + confidence will be set to 1.0. + - Deprecated. Element is skipped in the validation process. + enumDeprecated: + - false + - false + - false + - false + - false + - true + - true + - true + enum: + - OPERATION_TYPE_UNSPECIFIED + - ADD + - REMOVE + - UPDATE + - REPLACE + - EVAL_REQUESTED + - EVAL_APPROVED + - EVAL_SKIPPED GoogleCloudDocumentaiV1DocumentProvenanceParent: + id: GoogleCloudDocumentaiV1DocumentProvenanceParent + description: >- + The parent element the current element is based on. Used for + referencing/aligning, removal and replacement operations. + type: object properties: - index: + revision: + description: The index of the index into current revision's parent_ids list. + type: integer format: int32 + index: description: >- The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. type: integer + format: int32 id: description: The id of the parent provenance. - format: int32 - type: integer deprecated: true - revision: - description: The index of the index into current revision's parent_ids list. type: integer format: int32 - description: >- - The parent element the current element is based on. Used for - referencing/aligning, removal and replacement operations. + GoogleCloudDocumentaiV1DocumentPageParagraph: + id: GoogleCloudDocumentaiV1DocumentPageParagraph + description: A collection of lines that a human would perceive as a paragraph. type: object - id: GoogleCloudDocumentaiV1DocumentProvenanceParent - GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult: - description: >- - The validation status of each import config. Status is set to an error - if there are no documents to import in the `import_config`, or `OK` if - the operation will try to proceed with at least one document. properties: - status: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The validation status of import config. - inputGcsSource: - type: string - description: The source Cloud Storage URI specified in the import config. - id: >- - GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult - type: object - GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig: - type: object - id: GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig - properties: {} - description: Configuration specific to spanner-based indexing. + layout: + description: Layout for Paragraph. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + detectedLanguages: + description: A list of detected languages together with confidence. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + provenance: + description: The history of this annotation. + deprecated: true + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' GoogleCloudDocumentaiV1DocumentPageLine: - type: object id: GoogleCloudDocumentaiV1DocumentPageLine description: >- A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc. + type: object properties: + layout: + description: Layout for Line. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + detectedLanguages: + description: A list of detected languages together with confidence. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage provenance: + description: The history of this annotation. + deprecated: true $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + GoogleCloudDocumentaiV1DocumentPageToken: + id: GoogleCloudDocumentaiV1DocumentPageToken + description: A detected token. + type: object + properties: + layout: + description: Layout for Token. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + detectedBreak: + description: Detected break at the end of a Token. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak + detectedLanguages: + description: A list of detected languages together with confidence. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + provenance: description: The history of this annotation. deprecated: true + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + styleInfo: + description: Text style attributes. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo + GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak: + id: GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak + description: Detected break at the end of a Token. + type: object + properties: + type: + description: Detected break type. + type: string + enumDescriptions: + - Unspecified break type. + - A single whitespace. + - A wider whitespace. + - A hyphen that indicates that a token has been split across lines. + enum: + - TYPE_UNSPECIFIED + - SPACE + - WIDE_SPACE + - HYPHEN + GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo: + id: GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo + description: Font and other text style attributes. + type: object + properties: + fontSize: + description: Font size in points (`1` point is `¹⁄₇₂` inches). + type: integer + format: int32 + pixelFontSize: + description: >- + Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ + `72.0`. + type: number + format: double + letterSpacing: + description: Letter spacing in points. + type: number + format: double + fontType: + description: Name or style of the font. + type: string + bold: + description: >- + Whether the text is bold (equivalent to font_weight is at least + `700`). + type: boolean + italic: + description: Whether the text is italic. + type: boolean + underlined: + description: Whether the text is underlined. + type: boolean + strikeout: + description: >- + Whether the text is strikethrough. This feature is not supported + yet. + type: boolean + subscript: + description: Whether the text is a subscript. This feature is not supported yet. + type: boolean + superscript: + description: >- + Whether the text is a superscript. This feature is not supported + yet. + type: boolean + smallcaps: + description: >- + Whether the text is in small caps. This feature is not supported + yet. + type: boolean + fontWeight: + description: >- + TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). + Normal is `400`, bold is `700`. + type: integer + format: int32 + handwritten: + description: Whether the text is handwritten. + type: boolean + textColor: + description: Color of the text. + $ref: '#/components/schemas/GoogleTypeColor' + backgroundColor: + description: Color of the background. + $ref: '#/components/schemas/GoogleTypeColor' + GoogleCloudDocumentaiV1DocumentPageVisualElement: + id: GoogleCloudDocumentaiV1DocumentPageVisualElement + description: >- + Detected non-text visual elements e.g. checkbox, signature etc. on the + page. + type: object + properties: + layout: + description: Layout for VisualElement. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + type: + description: Type of the VisualElement. + type: string + detectedLanguages: + description: A list of detected languages together with confidence. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + GoogleCloudDocumentaiV1DocumentPageTable: + id: GoogleCloudDocumentaiV1DocumentPageTable + description: A table representation similar to HTML table structure. + type: object + properties: + layout: + description: Layout for Table. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + headerRows: + description: Header rows of the table. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableRow + bodyRows: + description: Body rows of the table. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableRow + detectedLanguages: + description: A list of detected languages together with confidence. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + provenance: + description: The history of this table. + deprecated: true + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + GoogleCloudDocumentaiV1DocumentPageTableTableRow: + id: GoogleCloudDocumentaiV1DocumentPageTableTableRow + description: A row of table cells. + type: object + properties: + cells: + description: Cells that make up this row. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableCell + GoogleCloudDocumentaiV1DocumentPageTableTableCell: + id: GoogleCloudDocumentaiV1DocumentPageTableTableCell + description: A cell representation inside the table. + type: object + properties: + layout: + description: Layout for TableCell. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + rowSpan: + description: How many rows this cell spans. + type: integer + format: int32 + colSpan: + description: How many columns this cell spans. + type: integer + format: int32 detectedLanguages: + description: A list of detected languages together with confidence. type: array items: $ref: >- #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - description: A list of detected languages together with confidence. - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for Line. - GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest: - id: GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest + GoogleCloudDocumentaiV1DocumentPageFormField: + id: GoogleCloudDocumentaiV1DocumentPageFormField + description: A form field detected on the page. type: object properties: - defaultProcessorVersion: + fieldName: description: >- - Required. The resource name of child ProcessorVersion to use as - default. Format: - `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{version}` - type: string - description: Request message for the SetDefaultProcessorVersion method. - GoogleCloudDocumentaiV1DisableProcessorRequest: - type: object - id: GoogleCloudDocumentaiV1DisableProcessorRequest - properties: {} - description: Request message for the DisableProcessor method. - GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata: - type: object - properties: - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - totalDocumentCount: - description: Total number of the documents that are qualified for importing. - format: int32 - type: integer - importConfigValidationResults: - description: Validation statuses of the batch documents import config. + Layout for the FormField name. e.g. `Address`, `Email`, `Grand + total`, `Phone number`, etc. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + fieldValue: + description: Layout for the FormField value. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + nameDetectedLanguages: + description: A list of detected languages for name together with confidence. type: array items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult - individualImportStatuses: - description: The list of response details of each document. + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + valueDetectedLanguages: + description: A list of detected languages for value together with confidence. type: array items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus - description: Metadata of the import document operation. - id: GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata - GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata: + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + valueType: + description: >- + If the value is non-textual, this field represents the type. Current + valid values are: - blank (this indicates the `field_value` is + normal text) - `unfilled_checkbox` - `filled_checkbox` + type: string + correctedKeyText: + description: >- + Created for Labeling UI to export key text. If corrections were made + to the text identified by the `field_name.text_anchor`, this field + will contain the correction. + type: string + correctedValueText: + description: >- + Created for Labeling UI to export value text. If corrections were + made to the text identified by the `field_value.text_anchor`, this + field will contain the correction. + type: string + provenance: + description: The history of this annotation. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + GoogleCloudDocumentaiV1DocumentPageSymbol: + id: GoogleCloudDocumentaiV1DocumentPageSymbol + description: A detected symbol. type: object - description: Metadata of the import document operation. properties: - individualImportStatuses: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus - description: The list of response details of each document. - totalDocumentCount: - type: integer - description: Total number of the documents that are qualified for importing. - format: int32 - importConfigValidationResults: + layout: + description: Layout for Symbol. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + detectedLanguages: + description: A list of detected languages together with confidence. type: array - description: Validation statuses of the batch documents import config. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - id: GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata - GoogleCloudDocumentaiV1ProcessOptionsLayoutConfig: + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + GoogleCloudDocumentaiV1DocumentPageDetectedBarcode: + id: GoogleCloudDocumentaiV1DocumentPageDetectedBarcode + description: A detected barcode. type: object - description: Serving config for layout parser processor. properties: - chunkingConfig: - description: Optional. Config for chunking in layout parser processor. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1ProcessOptionsLayoutConfigChunkingConfig - id: GoogleCloudDocumentaiV1ProcessOptionsLayoutConfig - GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId: + layout: + description: Layout for DetectedBarcode. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + barcode: + description: Detailed barcode information of the DetectedBarcode. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Barcode' + GoogleCloudDocumentaiV1Barcode: + id: GoogleCloudDocumentaiV1Barcode + description: Encodes the detailed information of a barcode. + type: object properties: - gcsUri: + format: + description: >- + Format of a barcode. The supported formats are: - `CODE_128`: Code + 128 type. - `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - + `CODABAR`: Codabar type. - `DATA_MATRIX`: 2D Data Matrix type. - + `ITF`: ITF type. - `EAN_13`: EAN-13 type. - `EAN_8`: EAN-8 type. - + `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A type. - `UPC_E`: UPC-E + type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code type. - + `DATABAR`: GS1 DataBar code type. type: string - description: Required. The Cloud Storage URI where the actual document is stored. - cwDocId: - deprecated: true + valueFormat: + description: >- + Value format describes the format of the value that a barcode + encodes. The supported formats are: - `CONTACT_INFO`: Contact + information. - `EMAIL`: Email address. - `ISBN`: ISBN identifier. - + `PHONE`: Phone number. - `PRODUCT`: Product. - `SMS`: SMS message. - + `TEXT`: Text string. - `URL`: URL address. - `WIFI`: Wifi + information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`: Calendar + event. - `DRIVER_LICENSE`: Driver's license. type: string - description: Id of the document (indexed) managed by Content Warehouse. - type: object - description: >- - Identifies a document uniquely within the scope of a dataset in the - user-managed Cloud Storage option. - id: GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId - GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo: - description: Information about Generative AI model-based processor versions. + rawValue: + description: >- + Raw value encoded in the barcode. For example: + `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`. + type: string + GoogleCloudDocumentaiV1DocumentPageImageQualityScores: + id: GoogleCloudDocumentaiV1DocumentPageImageQualityScores + description: Image quality scores for the page image. type: object properties: - customGenAiModelInfo: - description: Information for a custom Generative AI model created by the user. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo - foundationGenAiModelInfo: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo - description: Information for a pretrained Google-managed foundation model. - id: GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo - GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo: - id: GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo + qualityScore: + description: >- + The overall quality score. Range `[0, 1]` where `1` is perfect + quality. + type: number + format: float + detectedDefects: + description: A list of detected defects. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect + GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect: + id: GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect + description: Image Quality Defects + type: object properties: - superscript: - type: boolean + type: description: >- - Whether the text is a superscript. This feature is not supported - yet. - strikeout: - type: boolean + Name of the defect type. Supported values are: - + `quality/defect_blurry` - `quality/defect_noisy` - + `quality/defect_dark` - `quality/defect_faint` - + `quality/defect_text_too_small` - `quality/defect_document_cutoff` - + `quality/defect_text_cutoff` - `quality/defect_glare` + type: string + confidence: description: >- - Whether the text is strikethrough. This feature is not supported - yet. - italic: - type: boolean - description: Whether the text is italic. - fontType: + Confidence of detected defect. Range `[0, 1]` where `1` indicates + strong confidence that the defect exists. + type: number + format: float + GoogleCloudDocumentaiV1DocumentEntity: + id: GoogleCloudDocumentaiV1DocumentEntity + description: >- + An entity that could be a phrase in the text or a property that belongs + to the document. It is a known entity type, such as a person, an + organization, or location. + type: object + properties: + textAnchor: + description: >- + Optional. Provenance of the entity. Text anchor indexing into the + Document.text. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' + type: + description: Required. Entity type from a schema e.g. `Address`. type: string - description: Name or style of the font. - pixelFontSize: - format: double + mentionText: + description: Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`. + type: string + mentionId: + description: Optional. Deprecated. Use `id` field instead. + type: string + confidence: + description: Optional. Confidence of detected Schema entity. Range `[0, 1]`. + type: number + format: float + pageAnchor: + description: >- + Optional. Represents the provenance of this entity wrt. the location + on the page where it was found. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageAnchor' + id: description: >- - Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ - `72.0`. - type: number - smallcaps: - type: boolean + Optional. Canonical id. This will be a unique value in the entity + list for this document. + type: string + normalizedValue: description: >- - Whether the text is in small caps. This feature is not supported - yet. - bold: - type: boolean + Optional. Normalized entity value. Absent if the extracted value + could not be converted or the type (e.g. address) is not supported + for certain parsers. This field is also only populated for certain + supported document types. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentEntityNormalizedValue + properties: description: >- - Whether the text is bold (equivalent to font_weight is at least - `700`). - fontWeight: - format: int32 - type: integer + Optional. Entities can be nested to form a hierarchical data + structure representing the content in the document. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntity' + provenance: + description: Optional. The history of this annotation. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + redacted: description: >- - TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). - Normal is `400`, bold is `700`. - underlined: - description: Whether the text is underlined. - type: boolean - subscript: - type: boolean - description: Whether the text is a subscript. This feature is not supported yet. - handwritten: + Optional. Whether the entity will be redacted for de-identification + purposes. type: boolean - description: Whether the text is handwritten. - letterSpacing: - format: double - type: number - description: Letter spacing in points. - backgroundColor: - $ref: '#/components/schemas/GoogleTypeColor' - description: Color of the background. - fontSize: - format: int32 - type: integer - description: Font size in points (`1` point is `¹⁄₇₂` inches). - textColor: - description: Color of the text. - $ref: '#/components/schemas/GoogleTypeColor' - type: object - description: Font and other text style attributes. - GoogleCloudDocumentaiV1DocumentPageFormField: + method: + description: Optional. Specifies how the entity's value is obtained. + type: string + enumDescriptions: + - >- + When the method is not specified, it should be treated as + `EXTRACT`. + - >- + The entity's value is directly extracted as-is from the document + text. + - >- + The entity's value is derived through inference and is not + necessarily an exact text extraction from the document. + enum: + - METHOD_UNSPECIFIED + - EXTRACT + - DERIVE + GoogleCloudDocumentaiV1DocumentPageAnchor: + id: GoogleCloudDocumentaiV1DocumentPageAnchor + description: >- + Referencing the visual context of the entity in the Document.pages. Page + anchors can be cross-page, consist of multiple bounding polygons and + optionally reference specific layout element types. type: object - description: A form field detected on the page. properties: - nameDetectedLanguages: + pageRefs: + description: One or more references to visual page elements type: array items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - description: A list of detected languages for name together with confidence. - correctedValueText: - type: string + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageAnchorPageRef + GoogleCloudDocumentaiV1DocumentPageAnchorPageRef: + id: GoogleCloudDocumentaiV1DocumentPageAnchorPageRef + description: Represents a weak reference to a page element within a document. + type: object + properties: + page: description: >- - Created for Labeling UI to export value text. If corrections were - made to the text identified by the `field_value.text_anchor`, this - field will contain the correction. - valueType: + Required. Index into the Document.pages element, for example using + `Document.pages` to locate the related page element. This field is + skipped when its value is the default `0`. See + https://developers.google.com/protocol-buffers/docs/proto3#json. + type: string + format: int64 + layoutType: description: >- - If the value is non-textual, this field represents the type. Current - valid values are: - blank (this indicates the `field_value` is - normal text) - `unfilled_checkbox` - `filled_checkbox` + Optional. The type of the layout element that is being referenced if + any. type: string - correctedKeyText: + enumDescriptions: + - Layout Unspecified. + - References a Page.blocks element. + - References a Page.paragraphs element. + - References a Page.lines element. + - References a Page.tokens element. + - References a Page.visual_elements element. + - Refrrences a Page.tables element. + - References a Page.form_fields element. + enum: + - LAYOUT_TYPE_UNSPECIFIED + - BLOCK + - PARAGRAPH + - LINE + - TOKEN + - VISUAL_ELEMENT + - TABLE + - FORM_FIELD + layoutId: + description: Optional. Deprecated. Use PageRef.bounding_poly instead. + deprecated: true type: string + boundingPoly: description: >- - Created for Labeling UI to export key text. If corrections were made - to the text identified by the `field_name.text_anchor`, this field - will contain the correction. - valueDetectedLanguages: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - description: A list of detected languages for value together with confidence. - type: array - fieldName: + Optional. Identifies the bounding polygon of a layout element on the + page. If `layout_type` is set, the bounding polygon must be exactly + the same to the layout element it's referring to. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1BoundingPoly' + confidence: description: >- - Layout for the FormField name. e.g. `Address`, `Email`, `Grand - total`, `Phone number`, etc. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - fieldValue: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for the FormField value. - provenance: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - description: The history of this annotation. - id: GoogleCloudDocumentaiV1DocumentPageFormField - GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsResponse: - id: GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsResponse - properties: {} - description: Response of the batch move documents operation. - type: object - GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse: - type: object - id: GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse - properties: {} - description: >- - Response message for the EnableProcessor method. Intentionally empty - proto for adding fields in future. - GoogleCloudDocumentaiV1TrainProcessorVersionMetadata: - type: object - properties: - testDatasetValidation: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation - description: The test dataset validation information. - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' - trainingDatasetValidation: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation - description: The training dataset validation information. - id: GoogleCloudDocumentaiV1TrainProcessorVersionMetadata - description: The metadata that represents a processor version being created. - GoogleCloudDocumentaiV1DeployProcessorVersionMetadata: - type: object - id: GoogleCloudDocumentaiV1DeployProcessorVersionMetadata - properties: - commonMetadata: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' - description: The basic metadata of the long-running operation. - description: >- - The long-running operation metadata for the DeployProcessorVersion - method. - GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig: - description: Configuration specific to an unmanaged dataset. - properties: {} + Optional. Confidence of detected page element, if applicable. Range + `[0, 1]`. + type: number + format: float + GoogleCloudDocumentaiV1DocumentEntityNormalizedValue: + id: GoogleCloudDocumentaiV1DocumentEntityNormalizedValue + description: Parsed and normalized entity value. type: object - id: GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig - GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata: properties: - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - id: GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata - description: >- - The long-running operation metadata for updating the human review - configuration. + moneyValue: + description: >- + Money value. See also: + https://github.com/googleapis/googleapis/blob/master/google/type/money.proto + $ref: '#/components/schemas/GoogleTypeMoney' + dateValue: + description: >- + Date value. Includes year, month, day. See also: + https://github.com/googleapis/googleapis/blob/master/google/type/date.proto + $ref: '#/components/schemas/GoogleTypeDate' + datetimeValue: + description: >- + DateTime value. Includes date, time, and timezone. See also: + https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto + $ref: '#/components/schemas/GoogleTypeDateTime' + addressValue: + description: >- + Postal address. See also: + https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto + $ref: '#/components/schemas/GoogleTypePostalAddress' + booleanValue: + description: >- + Boolean value. Can be used for entities with binary values, or for + checkboxes. + type: boolean + integerValue: + description: Integer value. + type: integer + format: int32 + floatValue: + description: Float value. + type: number + format: float + signatureValue: + type: boolean + text: + description: >- + Optional. An optional field to store a normalized string. For some + entity types, one of respective `structured_value` fields may also + be populated. Also not all the types of `structured_value` will be + normalized. For example, some processors may not generate `float` or + `integer` normalized text by default. Below are sample formats + mapped to structured values. - Money/Currency type (`money_value`) + is in the ISO 4217 text format. - Date type (`date_value`) is in the + ISO 8601 text format. - Datetime type (`datetime_value`) is in the + ISO 8601 text format. + type: string + GoogleTypeMoney: + id: GoogleTypeMoney + description: Represents an amount of money with its currency type. type: object + properties: + currencyCode: + description: The three-letter currency code defined in ISO 4217. + type: string + units: + description: >- + The whole units of the amount. For example if `currencyCode` is + `"USD"`, then 1 unit is one US dollar. + type: string + format: int64 + nanos: + description: >- + Number of nano (10^-9) units of the amount. The value must be + between -999,999,999 and +999,999,999 inclusive. If `units` is + positive, `nanos` must be positive or zero. If `units` is zero, + `nanos` can be positive, zero, or negative. If `units` is negative, + `nanos` must be negative or zero. For example $-1.75 is represented + as `units`=-1 and `nanos`=-750,000,000. + type: integer + format: int32 GoogleTypeDate: - type: object id: GoogleTypeDate description: >- Represents a whole or partial calendar date, such as a birthday. The @@ -827,986 +1413,967 @@ components: * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp + type: object properties: year: description: >- Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + type: integer format: int32 + month: + description: >- + Month of a year. Must be from 1 to 12, or 0 to specify a year + without a month and day. type: integer - day: format: int32 + day: description: >- Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. type: integer + format: int32 + GoogleTypeDateTime: + id: GoogleTypeDateTime + description: >- + Represents civil time (or occasionally physical time). This type can + represent a civil time in one of a few possible ways: * When utc_offset + is set and time_zone is unset: a civil time on a calendar day with a + particular offset from UTC. * When time_zone is set and utc_offset is + unset: a civil time on a calendar day in a particular time zone. * When + neither time_zone nor utc_offset is set: a civil time on a calendar day + in local time. The date is relative to the Proleptic Gregorian Calendar. + If year, month, or day are 0, the DateTime is considered not to have a + specific year, month, or day respectively. This type may also be used to + represent a physical time if all the date and time fields are set and + either case of the `time_offset` oneof is set. Consider using + `Timestamp` message for physical time instead. If your use case also + would like to store the user's timezone, that can be done in another + field. This type is more flexible than some applications may want. Make + sure to document and validate your application's limitations. + type: object + properties: + year: + description: >- + Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a + datetime without a year. + type: integer + format: int32 month: description: >- - Month of a year. Must be from 1 to 12, or 0 to specify a year - without a month and day. + Optional. Month of year. Must be from 1 to 12, or 0 if specifying a + datetime without a month. type: integer format: int32 - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow: + day: + description: >- + Optional. Day of month. Must be from 1 to 31 and valid for the year + and month, or 0 if specifying a datetime without a day. + type: integer + format: int32 + hours: + description: >- + Optional. Hours of day in 24 hour format. Should be from 0 to 23, + defaults to 0 (midnight). An API may choose to allow the value + "24:00:00" for scenarios like business closing time. + type: integer + format: int32 + minutes: + description: >- + Optional. Minutes of hour of day. Must be from 0 to 59, defaults to + 0. + type: integer + format: int32 + seconds: + description: >- + Optional. Seconds of minutes of the time. Must normally be from 0 to + 59, defaults to 0. An API may allow the value 60 if it allows + leap-seconds. + type: integer + format: int32 + nanos: + description: >- + Optional. Fractions of seconds in nanoseconds. Must be from 0 to + 999,999,999, defaults to 0. + type: integer + format: int32 + utcOffset: + description: >- + UTC offset. Must be whole seconds, between -18 hours and +18 hours. + For example, a UTC offset of -4:00 would be represented as { + seconds: -14400 }. + type: string + format: google-duration + timeZone: + description: Time zone. + $ref: '#/components/schemas/GoogleTypeTimeZone' + GoogleTypeTimeZone: + id: GoogleTypeTimeZone + description: >- + Represents a time zone from the [IANA Time Zone + Database](https://www.iana.org/time-zones). + type: object properties: - cells: - type: array - description: A table row is a list of table cells. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell - description: Represents a row in a table. + id: + description: IANA Time Zone Database time zone. For example "America/New_York". + type: string + version: + description: >- + Optional. IANA Time Zone Database version number. For example + "2019a". + type: string + GoogleTypePostalAddress: + id: GoogleTypePostalAddress + description: >- + Represents a postal address, such as for postal delivery or payments + addresses. With a postal address, a postal service can deliver items to + a premise, P.O. box, or similar. A postal address is not intended to + model geographical locations like roads, towns, or mountains. In typical + usage, an address would be created by user input or from importing + existing data, depending on the type of process. Advice on address input + or editing: - Use an internationalization-ready address widget such as + https://github.com/google/libaddressinput. - Users should not be + presented with UI elements for input or editing of fields outside + countries where that field is used. For more guidance on how to use this + schema, see: https://support.google.com/business/answer/6397478. type: object - id: >- - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow - GoogleCloudDocumentaiV1DocumentPage: properties: - transforms: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageMatrix' - type: array + revision: description: >- - Transformation matrices that were applied to the original document - image to produce Page.image. - formFields: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageFormField' - type: array - description: A list of visually detected form fields on the page. - layout: - description: Layout for the page. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - symbols: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageSymbol' - type: array - description: A list of visually detected symbols on the page. - dimension: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageDimension' - description: Physical dimension of the page. - provenance: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - description: The history of this page. - deprecated: true - paragraphs: + The schema revision of the `PostalAddress`. This must be set to 0, + which is the latest revision. All new revisions **must** be backward + compatible with old revisions. + type: integer + format: int32 + regionCode: description: >- - A list of visually detected text paragraphs on the page. A - collection of lines that a human would perceive as a paragraph. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageParagraph' - type: array - image: + Required. CLDR region code of the country/region of the address. + This is never inferred and it is up to the user to ensure the value + is correct. See https://cldr.unicode.org/ and + https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html + for details. Example: "CH" for Switzerland. + type: string + languageCode: description: >- - Rendered image for this page. This image is preprocessed to remove - any skew, rotation, and distortions such that the annotation - bounding boxes can be upright and axis-aligned. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageImage' - pageNumber: + Optional. BCP-47 language code of the contents of this address (if + known). This is often the UI language of the input form or is + expected to match one of the languages used in the address' + country/region, or their transliterated equivalents. This can affect + formatting in certain countries, but is not critical to the + correctness of the data and will never affect any validation or + other non-formatting related operations. If this value is not known, + it should be omitted (rather than specifying a possibly incorrect + default). Examples: "zh-Hant", "ja", "ja-Latn", "en". + type: string + postalCode: description: >- - 1-based index for current Page in a parent Document. Useful when a - page is taken out of a Document for individual processing. - type: integer - format: int32 - detectedBarcodes: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedBarcode - type: array - description: A list of detected barcodes. - tokens: - description: A list of visually detected tokens on the page. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageToken' - type: array - detectedLanguages: - description: A list of detected languages together with confidence. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - type: array - blocks: + Optional. Postal code of the address. Not all countries use or + require postal codes to be present, but where they are used, they + may trigger additional validation with other parts of the address + (for example, state or zip code validation in the United States). + type: string + sortingCode: description: >- - A list of visually detected text blocks on the page. A block has a - set of lines (collected into paragraphs) that have a common - line-spacing and orientation. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageBlock' - type: array - imageQualityScores: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageImageQualityScores - description: Image quality scores. - lines: + Optional. Additional, country-specific, sorting code. This is not + used in most regions. Where it is used, the value is either a string + like "CEDEX", optionally followed by a number (for example, "CEDEX + 7"), or just a number alone, representing the "sector code" + (Jamaica), "delivery area indicator" (Malawi) or "post office + indicator" (Côte d'Ivoire). + type: string + administrativeArea: + description: >- + Optional. Highest administrative subdivision which is used for + postal addresses of a country or region. For example, this can be a + state, a province, an oblast, or a prefecture. For Spain, this is + the province and not the autonomous community (for example, + "Barcelona" and not "Catalonia"). Many countries don't use an + administrative area in postal addresses. For example, in + Switzerland, this should be left unpopulated. + type: string + locality: + description: >- + Optional. Generally refers to the city or town portion of the + address. Examples: US city, IT comune, UK post town. In regions of + the world where localities are not well defined or do not fit into + this structure well, leave `locality` empty and use `address_lines`. + type: string + sublocality: + description: >- + Optional. Sublocality of the address. For example, this can be a + neighborhood, borough, or district. + type: string + addressLines: + description: >- + Unstructured address lines describing the lower levels of an + address. Because values in `address_lines` do not have type + information and may sometimes contain multiple values in a single + field (for example, "Austin, TX"), it is important that the line + order is clear. The order of address lines should be "envelope + order" for the country or region of the address. In places where + this can vary (for example, Japan), `address_language` is used to + make it explicit (for example, "ja" for large-to-small ordering and + "ja-Latn" or "en" for small-to-large). In this way, the most + specific line of an address can be selected based on the language. + The minimum permitted structural representation of an address + consists of a `region_code` with all remaining information placed in + the `address_lines`. It would be possible to format such an address + very approximately without geocoding, but no semantic reasoning + could be made about any of the address components until it was at + least partially resolved. Creating an address only containing a + `region_code` and `address_lines` and then geocoding is the + recommended way to handle completely unstructured addresses (as + opposed to guessing which parts of the address should be localities + or administrative areas). type: array items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLine' + type: string + recipients: description: >- - A list of visually detected text lines on the page. A collection of - tokens that a human would perceive as a line. - tables: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageTable' - description: A list of visually detected tables on the page. + Optional. The recipient at the address. This field may, under + certain circumstances, contain multiline information. For example, + it might contain "care of" information. type: array - visualElements: items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageVisualElement - type: array - description: >- - A list of detected non-text visual elements e.g. checkbox, signature - etc. on the page. - type: object - id: GoogleCloudDocumentaiV1DocumentPage - description: A page in a Document. - GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus: + type: string + organization: + description: Optional. The name of the organization at the address. + type: string + GoogleCloudDocumentaiV1DocumentEntityRelation: + id: GoogleCloudDocumentaiV1DocumentEntityRelation + description: Relationship between Entities. type: object - id: GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus properties: - status: - $ref: '#/components/schemas/GoogleRpcStatus' - description: >- - The status of resyncing the dataset with regards to the detected - inconsistency. Empty if ResyncDatasetRequest.validate_only is - `true`. - datasetInconsistencyType: - description: The type of the inconsistency of the dataset. - enumDescriptions: - - Default value. - - The marker file under the dataset folder is not found. + subjectId: + description: Subject entity id. type: string - enum: - - DATASET_INCONSISTENCY_TYPE_UNSPECIFIED - - DATASET_INCONSISTENCY_TYPE_NO_STORAGE_MARKER - description: Resync status against inconsistency types on the dataset level. - GoogleCloudDocumentaiV1beta3EnableProcessorMetadata: - properties: - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - id: GoogleCloudDocumentaiV1beta3EnableProcessorMetadata - description: The long-running operation metadata for the EnableProcessor method. - type: object - GoogleCloudDocumentaiV1beta3UndeployProcessorVersionResponse: - id: GoogleCloudDocumentaiV1beta3UndeployProcessorVersionResponse - type: object - description: Response message for the UndeployProcessorVersion method. - properties: {} - GoogleCloudDocumentaiV1DocumentPageToken: + objectId: + description: Object entity id. + type: string + relation: + description: Relationship description. + type: string + GoogleCloudDocumentaiV1DocumentTextChange: + id: GoogleCloudDocumentaiV1DocumentTextChange + description: This message is used for text changes aka. OCR corrections. type: object properties: - detectedBreak: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak - description: Detected break at the end of a Token. - styleInfo: - description: Text style attributes. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo + textAnchor: + description: >- + Provenance of the correction. Text anchor indexing into the + Document.text. There can only be a single `TextAnchor.text_segments` + element. If the start and end index of the text segment are the + same, the text change is inserted before that index. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' + changedText: + description: The text that replaces the text identified in the `text_anchor`. + type: string provenance: - deprecated: true description: The history of this annotation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - detectedLanguages: - description: A list of detected languages together with confidence. + deprecated: true type: array items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - layout: - description: Layout for Token. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: A detected token. - id: GoogleCloudDocumentaiV1DocumentPageToken - GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata: - type: object + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + GoogleCloudDocumentaiV1DocumentShardInfo: + id: GoogleCloudDocumentaiV1DocumentShardInfo description: >- - The long-running operation metadata for the SetDefaultProcessorVersion - method. - properties: - commonMetadata: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' - description: The basic metadata of the long-running operation. - id: GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata - GoogleCloudLocationLocation: + For a large document, sharding may be performed to produce several + document shards. Each document shard contains this field to detail which + shard it is. type: object - description: A resource that represents a Google Cloud location. properties: - locationId: - description: 'The canonical id for this location. For example: `"us-east1"`.' + shardIndex: + description: The 0-based index of this shard. type: string - name: + format: int64 + shardCount: + description: Total number of shards. type: string + format: int64 + textOffset: description: >- - Resource name for the location, which may vary between - implementations. For example: - `"projects/example-project/locations/us-east1"` - metadata: + The index of the first character in Document.text in the overall + document global text. + type: string + format: int64 + GoogleCloudDocumentaiV1DocumentRevision: + id: GoogleCloudDocumentaiV1DocumentRevision + description: Contains past or forward revisions of this document. + type: object + properties: + agent: description: >- - Service-specific metadata. For example the available capacity at the - given location. - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - labels: - additionalProperties: - type: string + If the change was made by a person specify the name or id of that + person. + type: string + processor: description: >- - Cross-service attributes for the location. For example - {"cloud.googleapis.com/region": "us-east1"} - type: object - displayName: + If the annotation was made by processor identify the processor by + its resource name. type: string + id: description: >- - The friendly name for this location, typically a nearby city name. - For example, "Tokyo". - id: GoogleCloudLocationLocation - GoogleCloudDocumentaiV1DocumentPageAnchor: - description: >- - Referencing the visual context of the entity in the Document.pages. Page - anchors can be cross-page, consist of multiple bounding polygons and - optionally reference specific layout element types. - properties: - pageRefs: - description: One or more references to visual page elements + Id of the revision, internally generated by doc proto storage. + Unique within the context of the document. + type: string + parent: + description: >- + The revisions that this revision is based on. This can include one + or more parent (when documents are merged.) This field represents + the index into the `revisions` field. + deprecated: true type: array items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageAnchorPageRef - type: object - id: GoogleCloudDocumentaiV1DocumentPageAnchor - GoogleCloudDocumentaiV1beta3CommonOperationMetadata: - description: The common metadata for long running operations. + type: integer + format: int32 + parentIds: + description: >- + The revisions that this revision is based on. Must include all the + ids that have anything to do with this revision - eg. there are + `provenance.parent.revision` fields that index into this field. + type: array + items: + type: string + createTime: + description: >- + The time that the revision was created, internally generated by doc + proto storage at the time of create. + type: string + format: google-datetime + humanReview: + description: Human Review information of this revision. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentRevisionHumanReview + GoogleCloudDocumentaiV1DocumentRevisionHumanReview: + id: GoogleCloudDocumentaiV1DocumentRevisionHumanReview + description: Human Review information of the document. type: object - id: GoogleCloudDocumentaiV1beta3CommonOperationMetadata properties: state: - description: The state of the operation. - enum: - - STATE_UNSPECIFIED - - RUNNING - - CANCELLING - - SUCCEEDED - - FAILED - - CANCELLED - enumDescriptions: - - Unspecified state. - - Operation is still running. - - Operation is being cancelled. - - Operation succeeded. - - Operation failed. - - Operation is cancelled. - type: string - updateTime: - description: The last update time of the operation. - format: google-datetime + description: Human review state. e.g. `requested`, `succeeded`, `rejected`. type: string stateMessage: - type: string description: >- A message providing more details about the current state of - processing. - createTime: - type: string - format: google-datetime - description: The creation time of the operation. - resource: + processing. For example, the rejection reason when the state is + `rejected`. type: string - description: A related resource to this operation. - GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics: + GoogleCloudDocumentaiV1DocumentDocumentLayout: + id: GoogleCloudDocumentaiV1DocumentDocumentLayout + description: >- + Represents the parsed layout of a document as a collection of blocks + that the document is divided into. + type: object + properties: + blocks: + description: List of blocks in the document. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock: + id: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + description: >- + Represents a block. A block could be one of the various types (text, + table, list) supported. type: object - id: GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics - description: Evaluations metrics, at a specific confidence level. properties: - confidenceLevel: - format: float - description: The confidence level. - type: number - metrics: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1EvaluationMetrics' - description: The metrics at the specific confidence level. - GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics: - description: Metrics across multiple confidence levels. + textBlock: + description: Block consisting of text content. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock + tableBlock: + description: Block consisting of table content/structure. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock + listBlock: + description: Block consisting of list content/structure. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock + blockId: + description: ID of the block. + type: string + pageSpan: + description: Page span of the block. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan + boundingBox: + description: Identifies the bounding box for the block. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1BoundingPoly' + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock: + id: >- + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock + description: Represents a text type block. type: object properties: - metricsType: - description: The metrics type for the label. + text: + description: Text content stored in the block. type: string - enum: - - METRICS_TYPE_UNSPECIFIED - - AGGREGATE - enumDescriptions: - - >- - The metrics type is unspecified. By default, metrics without a - particular specification are for leaf entity types (i.e., - top-level entity types without child types, or child types which - are not parent types themselves). - - >- - Indicates whether metrics for this particular label type represent - an aggregate of metrics for other types instead of being based on - actual TP/FP/FN values for the label type. Metrics for parent - (i.e., non-leaf) entity types are an aggregate of metrics for - their children. - estimatedCalibrationError: + type: description: >- - The Estimated Calibration Error (ECE) of the confidence of the - predicted entities. - format: float - type: number - auprcExact: - format: float + Type of the text in the block. Available options are: `paragraph`, + `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, + `heading-5`, `header`, `footer`. + type: string + blocks: description: >- - The AUPRC for metrics with fuzzy matching disabled, i.e., exact - matching only. - type: number - confidenceLevelMetrics: + A text block could further have child blocks. Repeated blocks + support further hierarchies and nested blocks. + type: array items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics - description: Metrics across confidence levels with fuzzy matching enabled. + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock: + id: >- + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock + description: Represents a table type block. + type: object + properties: + headerRows: + description: Header rows at the top of the table. type: array - estimatedCalibrationErrorExact: - type: number - format: float - description: >- - The ECE for the predicted entities with fuzzy matching disabled, - i.e., exact matching only. - auprc: - format: float - type: number - description: >- - The calculated area under the precision recall curve (AUPRC), - computed by integrating over all confidence thresholds. - confidenceLevelMetricsExact: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow + bodyRows: + description: Body rows containing main table content. type: array items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics - description: Metrics across confidence levels with only exact matching. - id: GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics - GoogleCloudDocumentaiV1DocumentSchemaEntityType: - description: >- - EntityType is the wrapper of a label of the corresponding model with - detailed attributes and limitations for entity-based processors. - Multiple types can also compose a dependency tree to represent nested - types. + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow + caption: + description: Table caption/title. + type: string + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow: + id: >- + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow + description: Represents a row in a table. + type: object properties: - enumValues: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues - description: >- - If specified, lists all the possible values for this entity. This - should not be more than a handful of values. If the number of values - is >10 or could change frequently use the - `EntityType.value_ontology` field and specify a list of all possible - values in a value ontology file. - baseTypes: + cells: + description: A table row is a list of table cells. + type: array items: - type: string + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell: + id: >- + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell + description: Represents a cell in a table row. + type: object + properties: + blocks: description: >- - The entity type that this type is derived from. For now, one and - only one should be set. - type: array - properties: + A table cell is a list of blocks. Repeated blocks support further + hierarchies and nested blocks. type: array - description: Description the nested structure, or composition of an entity. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty - name: - type: string - description: >- - Name of the type. It must be unique within the schema file and - cannot be a "Common Type". The following naming conventions are - used: - Use `snake_casing`. - Name matching is case-sensitive. - - Maximum 64 characters. - Must start with a letter. - Allowed - characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility - internal infrastructure and tooling can handle any ascii character.) - - The `/` is sometimes used to denote a property of a type. For - example `line_item/amount`. This convention is deprecated, but will - still be honored for backward compatibility. - displayName: - type: string - description: User defined name for the type. - id: GoogleCloudDocumentaiV1DocumentSchemaEntityType + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + rowSpan: + description: How many rows this cell spans. + type: integer + format: int32 + colSpan: + description: How many columns this cell spans. + type: integer + format: int32 + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock: + id: >- + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock + description: Represents a list type block. type: object - GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata: - description: The long-running operation metadata for the ReviewDocument method. - id: GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata properties: - questionId: + listEntries: + description: List entries that constitute a list block. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry + type: + description: >- + Type of the list_entries (if exist). Available options are `ordered` + and `unordered`. type: string - description: The Crowd Compute question ID. - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' - type: object - GoogleCloudDocumentaiV1DocumentSchema: - description: The schema defines the output of the processed document by a processor. + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry: + id: >- + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry + description: Represents an entry in the list. type: object - id: GoogleCloudDocumentaiV1DocumentSchema properties: - entityTypes: + blocks: + description: >- + A list entry is a list of blocks. Repeated blocks support further + hierarchies and nested blocks. + type: array items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentSchemaEntityType - type: array - description: Entity types of the schema. - displayName: - type: string - description: Display name to show to users. - description: - type: string - description: Description of the schema. - metadata: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentSchemaMetadata' - description: Metadata of the schema. - GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata: - id: GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan: + id: >- + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan + description: Represents where the block starts and ends in the document. type: object - description: Metadata of the sample documents operation. properties: - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. + pageStart: + description: Page where block starts in the document. + type: integer + format: int32 + pageEnd: + description: Page where block ends in the document. + type: integer + format: int32 + GoogleCloudDocumentaiV1DocumentChunkedDocument: + id: GoogleCloudDocumentaiV1DocumentChunkedDocument + description: Represents the chunks that the document is divided into. + type: object + properties: + chunks: + description: List of chunks. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk: + id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk + description: Represents a chunk. + type: object properties: + chunkId: + description: ID of the chunk. + type: string sourceBlockIds: + description: Unused. type: array items: type: string - description: Unused. content: description: Text content of the chunk. type: string - pageHeaders: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader - description: Page headers associated with the chunk. - type: array pageSpan: description: Page span of the chunk. $ref: >- #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan + pageHeaders: + description: Page headers associated with the chunk. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader pageFooters: + description: Page footers associated with the chunk. type: array items: $ref: >- #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter - description: Page footers associated with the chunk. - chunkId: - description: ID of the chunk. - type: string - id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk - description: Represents a chunk. - type: object - GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation: - id: >- - GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation + GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan: + id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan + description: Represents where the chunk starts and ends in the document. type: object - description: >- - The dataset validation information. This includes any and all errors - with documents and the dataset. properties: - documentErrorCount: - format: int32 + pageStart: + description: Page where chunk starts in the document. type: integer - description: The total number of document errors. - documentErrors: - description: >- - Error information pertaining to specific documents. A maximum of 10 - document errors will be returned. Any document with errors will not - be used throughout training. - type: array - items: - $ref: '#/components/schemas/GoogleRpcStatus' - datasetErrors: - type: array - description: >- - Error information for the dataset as a whole. A maximum of 10 - dataset errors will be returned. A single dataset error is terminal - for training. - items: - $ref: '#/components/schemas/GoogleRpcStatus' - datasetErrorCount: format: int32 + pageEnd: + description: Page where chunk ends in the document. type: integer - description: The total number of dataset errors. - GoogleCloudDocumentaiV1DocumentTextChange: - type: object - description: This message is used for text changes aka. OCR corrections. - properties: - provenance: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - deprecated: true - type: array - description: The history of this annotation. - changedText: - type: string - description: The text that replaces the text identified in the `text_anchor`. - textAnchor: - description: >- - Provenance of the correction. Text anchor indexing into the - Document.text. There can only be a single `TextAnchor.text_segments` - element. If the start and end index of the text segment are the - same, the text change is inserted before that index. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' - id: GoogleCloudDocumentaiV1DocumentTextChange - GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId: - id: GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId - properties: - docId: - type: string - description: Required. The id of the document. - type: object - description: >- - Identifies a document uniquely within the scope of a dataset in - unmanaged option. - GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues: - id: GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues - description: Defines the a list of enum values. - properties: - values: - items: - type: string - description: The individual values that this enum values type can include. - type: array - type: object - GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse: - type: object - properties: - selectedDocuments: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument - description: The result of the sampling process. - type: array - sampleTestStatus: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The status of sampling documents in test split. - sampleTrainingStatus: - description: The status of sampling documents in training split. - $ref: '#/components/schemas/GoogleRpcStatus' - description: Response of the sample documents operation. - id: GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse - GoogleCloudDocumentaiV1beta3GcsPrefix: - type: object - properties: - gcsUriPrefix: - description: The URI prefix. - type: string - description: Specifies all documents on Cloud Storage with a common prefix. - id: GoogleCloudDocumentaiV1beta3GcsPrefix - GoogleCloudDocumentaiUiv1beta3ResyncDatasetResponse: - id: GoogleCloudDocumentaiUiv1beta3ResyncDatasetResponse + format: int32 + GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader: + id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader + description: Represents the page header associated with the chunk. type: object - properties: {} - description: The response proto of ResyncDataset method. - GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus: - description: The status of a each individual document in the batch process. - id: GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus properties: - humanReviewOperation: - type: string - deprecated: true - description: >- - The name of the operation triggered by the processed document. If - the human review process isn't triggered, this field will be empty. - It has the same response type and metadata as the long-running - operation returned by the ReviewDocument method. - status: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The status processing the document. - outputGcsDestination: - description: >- - The Cloud Storage output destination (in the request as - DocumentOutputConfig.GcsOutputConfig.gcs_uri) of the processed - document if it was successful, otherwise empty. - type: string - humanReviewStatus: - description: The status of human review on the processed document. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta3HumanReviewStatus' - inputGcsSource: + text: + description: Header in text format. type: string - description: >- - The source of the document, same as the input_gcs_source field in - the request when the batch process started. + pageSpan: + description: Page span of the header. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan + GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter: + id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter + description: Represents the page footer associated with the chunk. type: object - GoogleTypePostalAddress: - id: GoogleTypePostalAddress properties: - sortingCode: - description: >- - Optional. Additional, country-specific, sorting code. This is not - used in most regions. Where it is used, the value is either a string - like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or - just a number alone, representing the "sector code" (Jamaica), - "delivery area indicator" (Malawi) or "post office indicator" (e.g. - Côte d'Ivoire). - type: string - revision: - type: integer - format: int32 - description: >- - The schema revision of the `PostalAddress`. This must be set to 0, - which is the latest revision. All new revisions **must** be backward - compatible with old revisions. - postalCode: - description: >- - Optional. Postal code of the address. Not all countries use or - require postal codes to be present, but where they are used, they - may trigger additional validation with other parts of the address - (e.g. state/zip validation in the U.S.A.). - type: string - languageCode: - type: string - description: >- - Optional. BCP-47 language code of the contents of this address (if - known). This is often the UI language of the input form or is - expected to match one of the languages used in the address' - country/region, or their transliterated equivalents. This can affect - formatting in certain countries, but is not critical to the - correctness of the data and will never affect any validation or - other non-formatting related operations. If this value is not known, - it should be omitted (rather than specifying a possibly incorrect - default). Examples: "zh-Hant", "ja", "ja-Latn", "en". - administrativeArea: - description: >- - Optional. Highest administrative subdivision which is used for - postal addresses of a country or region. For example, this can be a - state, a province, an oblast, or a prefecture. Specifically, for - Spain this is the province and not the autonomous community (e.g. - "Barcelona" and not "Catalonia"). Many countries don't use an - administrative area in postal addresses. E.g. in Switzerland this - should be left unpopulated. - type: string - sublocality: - type: string - description: >- - Optional. Sublocality of the address. For example, this can be - neighborhoods, boroughs, districts. - recipients: - items: - type: string - type: array - description: >- - Optional. The recipient at the address. This field may, under - certain circumstances, contain multiline information. For example, - it might contain "care of" information. - addressLines: - type: array - items: - type: string - description: >- - Unstructured address lines describing the lower levels of an - address. Because values in address_lines do not have type - information and may sometimes contain multiple values in a single - field (e.g. "Austin, TX"), it is important that the line order is - clear. The order of address lines should be "envelope order" for the - country/region of the address. In places where this can vary (e.g. - Japan), address_language is used to make it explicit (e.g. "ja" for - large-to-small ordering and "ja-Latn" or "en" for small-to-large). - This way, the most specific line of an address can be selected based - on the language. The minimum permitted structural representation of - an address consists of a region_code with all remaining information - placed in the address_lines. It would be possible to format such an - address very approximately without geocoding, but no semantic - reasoning could be made about any of the address components until it - was at least partially resolved. Creating an address only containing - a region_code and address_lines, and then geocoding is the - recommended way to handle completely unstructured addresses (as - opposed to guessing which parts of the address should be localities - or administrative areas). - regionCode: + text: + description: Footer in text format. type: string - description: >- - Required. CLDR region code of the country/region of the address. - This is never inferred and it is up to the user to ensure the value - is correct. See https://cldr.unicode.org/ and - https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html - for details. Example: "CH" for Switzerland. - locality: + pageSpan: + description: Page span of the footer. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan + GoogleCloudDocumentaiV1RawDocument: + id: GoogleCloudDocumentaiV1RawDocument + description: Payload message of raw document content (bytes). + type: object + properties: + content: + description: Inline document content. type: string + format: byte + mimeType: description: >- - Optional. Generally refers to the city/town portion of the address. - Examples: US city, IT comune, UK post town. In regions of the world - where localities are not well defined or do not fit into this - structure well, leave locality empty and use address_lines. - organization: - description: Optional. The name of the organization at the address. + An IANA MIME type (RFC6838) indicating the nature and format of the + content. type: string - description: >- - Represents a postal address, e.g. for postal delivery or payments - addresses. Given a postal address, a postal service can deliver items to - a premise, P.O. Box or similar. It is not intended to model geographical - locations (roads, towns, mountains). In typical usage an address would - be created via user input or from importing existing data, depending on - the type of process. Advice on address input / editing: - Use an - internationalization-ready address widget such as - https://github.com/google/libaddressinput) - Users should not be - presented with UI elements for input or editing of fields outside - countries where that field is used. For more guidance on how to use this - schema, please see: https://support.google.com/business/answer/6397478 - type: object - GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadataIndividualAutoLabelStatus: - properties: - status: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The status of the document auto-labeling. - documentId: - $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' + displayName: description: >- - The document id of the auto-labeled document. This will replace the - gcs_uri. - type: object - description: The status of individual documents in the auto-labeling process. - id: >- - GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadataIndividualAutoLabelStatus - GoogleCloudDocumentaiV1BatchProcessMetadata: + The display name of the document, it supports all Unicode characters + except the following: `*`, `?`, `[`, `]`, `%`, `{`, `}`,`'`, `\"`, + `,` `~`, `=` and `:` are reserved. If not specified, a default ID is + generated. + type: string + GoogleCloudDocumentaiV1GcsDocument: + id: GoogleCloudDocumentaiV1GcsDocument + description: Specifies a document stored on Cloud Storage. type: object - id: GoogleCloudDocumentaiV1BatchProcessMetadata - description: The long-running operation metadata for BatchProcessDocuments. properties: - updateTime: - description: The last update time of the operation. - format: google-datetime - type: string - createTime: - type: string - format: google-datetime - description: The creation time of the operation. - individualProcessStatuses: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus - type: array - description: The list of response details of each document. - state: - description: The state of the current batch processing. + gcsUri: + description: The Cloud Storage object uri. type: string - enumDescriptions: - - The default value. This value is used if the state is omitted. - - Request operation is waiting for scheduling. - - Request is being processed. - - The batch processing completed successfully. - - The batch processing was being cancelled. - - The batch processing was cancelled. - - The batch processing has failed. - enum: - - STATE_UNSPECIFIED - - WAITING - - RUNNING - - SUCCEEDED - - CANCELLING - - CANCELLED - - FAILED - stateMessage: + mimeType: + description: An IANA MIME type (RFC6838) of the content. type: string - description: >- - A message providing more details about the current state of - processing. For example, the error message if the operation is - failed. - GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionResponse: - id: GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionResponse + GoogleCloudDocumentaiV1ProcessOptions: + id: GoogleCloudDocumentaiV1ProcessOptions + description: Options for Process API type: object - properties: {} - description: Response message for the SetDefaultProcessorVersion method. - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry: properties: - blocks: - type: array + individualPageSelector: + description: Which pages to process (1-indexed). + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1ProcessOptionsIndividualPageSelector + fromStart: description: >- - A list entry is a list of blocks. Repeated blocks support further - hierarchies and nested blocks. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock - id: >- - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry + Only process certain pages from the start. Process all if the + document has fewer pages. + type: integer + format: int32 + fromEnd: + description: Only process certain pages from the end, same as above. + type: integer + format: int32 + ocrConfig: + description: >- + Only applicable to `OCR_PROCESSOR` and `FORM_PARSER_PROCESSOR`. + Returns error if set on other processor types. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1OcrConfig' + layoutConfig: + description: >- + Optional. Only applicable to `LAYOUT_PARSER_PROCESSOR`. Returns + error if set on other processor types. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1ProcessOptionsLayoutConfig + schemaOverride: + description: >- + Optional. Override the schema of the ProcessorVersion. Will return + an Invalid Argument error if this field is set when the underlying + ProcessorVersion doesn't support schema override. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentSchema' + GoogleCloudDocumentaiV1ProcessOptionsIndividualPageSelector: + id: GoogleCloudDocumentaiV1ProcessOptionsIndividualPageSelector + description: A list of individual page numbers. type: object - description: Represents an entry in the list. - GoogleCloudDocumentaiV1NormalizedVertex: properties: - x: - type: number - format: float - description: X coordinate. - 'y': - description: Y coordinate (starts from the top of the image). - format: float - type: number - id: GoogleCloudDocumentaiV1NormalizedVertex - type: object - description: >- - A vertex represents a 2D point in the image. NOTE: the normalized vertex - coordinates are relative to the original image and range from 0 to 1. - GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata: + pages: + description: Optional. Indices of the pages (starting from 1). + type: array + items: + type: integer + format: int32 + GoogleCloudDocumentaiV1OcrConfig: + id: GoogleCloudDocumentaiV1OcrConfig + description: Config for Document OCR. type: object - description: The long-running operation metadata for the DeleteProcessor method. properties: - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - id: GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata - GoogleCloudLocationListLocationsResponse: - id: GoogleCloudLocationListLocationsResponse - description: The response message for Locations.ListLocations. + hints: + description: Hints for the OCR model. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1OcrConfigHints' + enableNativePdfParsing: + description: >- + Enables special handling for PDFs with existing text information. + Results in better text extraction quality in such PDF inputs. + type: boolean + enableImageQualityScores: + description: >- + Enables intelligent document quality scores after OCR. Can help with + diagnosing why OCR responses are of poor quality for a given input. + Adds additional latency comparable to regular OCR to the process + call. + type: boolean + advancedOcrOptions: + description: >- + A list of advanced OCR options to further fine-tune OCR behavior. + Current valid values are: - `legacy_layout`: a heuristics layout + detection algorithm, which serves as an alternative to the current + ML-based layout detection algorithm. Customers can choose the best + suitable layout algorithm based on their situation. + type: array + items: + type: string + enableSymbol: + description: Includes symbol level OCR information if set to true. + type: boolean + computeStyleInfo: + description: >- + Turn on font identification model and return font style information. + Deprecated, use PremiumFeatures.compute_style_info instead. + deprecated: true + type: boolean + disableCharacterBoxesDetection: + description: >- + Turn off character box detector in OCR engine. Character box + detection is enabled by default in OCR 2.0 (and later) processors. + type: boolean + premiumFeatures: + description: Configurations for premium OCR features. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1OcrConfigPremiumFeatures' + GoogleCloudDocumentaiV1OcrConfigHints: + id: GoogleCloudDocumentaiV1OcrConfigHints + description: Hints for OCR Engine type: object properties: - locations: - items: - $ref: '#/components/schemas/GoogleCloudLocationLocation' + languageHints: description: >- - A list of locations that matches the specified filter in the - request. + List of BCP-47 language codes to use for OCR. In most cases, not + specifying it yields the best results since it enables automatic + language detection. For languages based on the Latin alphabet, + setting hints is not needed. In rare cases, when the language of the + text in the image is known, setting a hint will help get better + results (although it will be a significant hindrance if the hint is + wrong). type: array - nextPageToken: - description: The standard List next-page token. - type: string - GoogleCloudDocumentaiUiv1beta3DocumentId: - properties: - revisionRef: - $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3RevisionRef' - description: Points to a specific revision of the document if set. - unmanagedDocId: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId - description: A document id within unmanaged dataset. - gcsManagedDocId: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId - description: A document id within user-managed Cloud Storage. + items: + type: string + GoogleCloudDocumentaiV1OcrConfigPremiumFeatures: + id: GoogleCloudDocumentaiV1OcrConfigPremiumFeatures + description: Configurations for premium OCR features. type: object - id: GoogleCloudDocumentaiUiv1beta3DocumentId - description: Document Identifier. - GoogleCloudDocumentaiV1UndeployProcessorVersionRequest: - description: Request message for the UndeployProcessorVersion method. - properties: {} + properties: + enableSelectionMarkDetection: + description: >- + Turn on selection mark detector in OCR engine. Only available in OCR + 2.0 (and later) processors. + type: boolean + computeStyleInfo: + description: Turn on font identification model and return font style information. + type: boolean + enableMathOcr: + description: Turn on the model that can extract LaTeX math formulas. + type: boolean + GoogleCloudDocumentaiV1ProcessOptionsLayoutConfig: + id: GoogleCloudDocumentaiV1ProcessOptionsLayoutConfig + description: Serving config for layout parser processor. type: object - id: GoogleCloudDocumentaiV1UndeployProcessorVersionRequest - GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation: + properties: + chunkingConfig: + description: Optional. Config for chunking in layout parser processor. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1ProcessOptionsLayoutConfigChunkingConfig + returnImages: + description: >- + Optional. Whether to include images in layout parser processor + response. + type: boolean + returnBoundingBoxes: + description: >- + Optional. Whether to include bounding boxes in layout parser + processor response. + type: boolean + GoogleCloudDocumentaiV1ProcessOptionsLayoutConfigChunkingConfig: + id: GoogleCloudDocumentaiV1ProcessOptionsLayoutConfigChunkingConfig + description: Serving config for chunking. type: object - id: >- - GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation - description: >- - The dataset validation information. This includes any and all errors - with documents and the dataset. properties: - datasetErrorCount: - description: The total number of dataset errors. - type: integer - format: int32 - datasetErrors: - items: - $ref: '#/components/schemas/GoogleRpcStatus' - type: array + chunkSize: description: >- - Error information for the dataset as a whole. A maximum of 10 - dataset errors will be returned. A single dataset error is terminal - for training. - documentErrorCount: - format: int32 + Optional. The chunk sizes to use when splitting documents, in order + of level. type: integer - description: The total number of document errors. - documentErrors: + format: int32 + includeAncestorHeadings: description: >- - Error information pertaining to specific documents. A maximum of 10 - document errors will be returned. Any document with errors will not - be used throughout training. - type: array - items: - $ref: '#/components/schemas/GoogleRpcStatus' - GoogleCloudDocumentaiV1Evaluation: + Optional. Whether or not to include ancestor headings when + splitting. + type: boolean + GoogleCloudDocumentaiV1DocumentSchema: + id: GoogleCloudDocumentaiV1DocumentSchema + description: The schema defines the output of the processed document by a processor. type: object properties: - kmsKeyVersionName: + displayName: + description: Display name to show to users. type: string - description: The KMS key version with which data is encrypted. - kmsKeyName: + description: + description: Description of the schema. type: string - description: The KMS key name used for encryption. - createTime: + entityTypes: + description: Entity types of the schema. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentSchemaEntityType + metadata: + description: Metadata of the schema. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentSchemaMetadata' + GoogleCloudDocumentaiV1DocumentSchemaEntityType: + id: GoogleCloudDocumentaiV1DocumentSchemaEntityType + description: >- + EntityType is the wrapper of a label of the corresponding model with + detailed attributes and limitations for entity-based processors. + Multiple types can also compose a dependency tree to represent nested + types. + type: object + properties: + enumValues: + description: >- + If specified, lists all the possible values for this entity. This + should not be more than a handful of values. If the number of values + is >10 or could change frequently use the + `EntityType.value_ontology` field and specify a list of all possible + values in a value ontology file. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues + displayName: + description: User defined name for the type. type: string - description: The time that the evaluation was created. - format: google-datetime name: + description: >- + Name of the type. It must be unique within the schema file and + cannot be a "Common Type". The following naming conventions are + used: - Use `snake_casing`. - Name matching is case-sensitive. - + Maximum 64 characters. - Must start with a letter. - Allowed + characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility + internal infrastructure and tooling can handle any ascii character.) + - The `/` is sometimes used to denote a property of a type. For + example `line_item/amount`. This convention is deprecated, but will + still be honored for backward compatibility. type: string + baseTypes: description: >- - The resource name of the evaluation. Format: - `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}` - entityMetrics: - type: object - additionalProperties: + The entity type that this type is derived from. For now, one and + only one should be set. + type: array + items: + type: string + properties: + description: Description the nested structure, or composition of an entity. + type: array + items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics - description: Metrics across confidence levels, for different entities. - documentCounters: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1EvaluationCounters' - description: Counters for the documents used in the evaluation. - allEntitiesMetrics: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics - description: Metrics for all the entities in aggregate. - id: GoogleCloudDocumentaiV1Evaluation - description: An evaluation of a ProcessorVersion's performance. - GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter: - properties: - pageSpan: - description: Page span of the footer. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan - text: - type: string - description: Footer in text format. - description: Represents the page footer associated with the chunk. + #/components/schemas/GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty + GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues: + id: GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues + description: Defines the a list of enum values. type: object - id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter - GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse: - id: GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse - description: Response message for the UndeployProcessorVersion method. + properties: + values: + description: The individual values that this enum values type can include. + type: array + items: + type: string + GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty: + id: GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty + description: Defines properties that can be part of the entity type. type: object - properties: {} - GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat: properties: - splitType: - description: The dataset split type. - enum: - - DATASET_SPLIT_TYPE_UNSPECIFIED - - DATASET_SPLIT_TRAIN - - DATASET_SPLIT_TEST - - DATASET_SPLIT_UNASSIGNED + name: + description: >- + The name of the property. Follows the same guidelines as the + EntityType name. + type: string + displayName: + description: User defined name for the property. + type: string + valueType: + description: >- + A reference to the value type of the property. This type is subject + to the same conventions as the `Entity.base_types` field. + type: string + occurrenceType: + description: >- + Occurrence type limits the number of instances an entity type + appears in the document. + type: string enumDescriptions: - - Default value if the enum is not set. - - Identifies the train documents. - - Identifies the test documents. - - Identifies the unassigned documents. + - Unspecified occurrence type. + - >- + There will be zero or one instance of this entity type. The same + entity instance may be mentioned multiple times. + - The entity type will appear zero or multiple times. + - >- + The entity type will only appear exactly once. The same entity + instance may be mentioned multiple times. + - The entity type will appear once or more times. + enum: + - OCCURRENCE_TYPE_UNSPECIFIED + - OPTIONAL_ONCE + - OPTIONAL_MULTIPLE + - REQUIRED_ONCE + - REQUIRED_MULTIPLE + method: + description: Specifies how the entity's value is obtained. type: string - totalDocumentCount: - type: integer - format: int32 + enumDescriptions: + - Unspecified method. It defaults to `EXTRACT`. + - >- + The entity's value is directly extracted as-is from the document + text. + - >- + The entity's value is derived through inference and is not + necessarily an exact text extraction from the document. + enum: + - METHOD_UNSPECIFIED + - EXTRACT + - DERIVE + GoogleCloudDocumentaiV1DocumentSchemaMetadata: + id: GoogleCloudDocumentaiV1DocumentSchemaMetadata + description: Metadata for global schema behavior. + type: object + properties: + documentSplitter: description: >- - Total number of documents with the given dataset split type to be - exported. + If true, a `document` entity type can be applied to subdocument + (splitting). Otherwise, it can only be applied to the entire + document (classification). + type: boolean + documentAllowMultipleLabels: + description: >- + If true, on a given page, there can be multiple `document` + annotations covering it. + type: boolean + prefixedNamingOnProperties: + description: If set, all the nested entities must be prefixed with the parents. + type: boolean + skipNamingValidation: + description: >- + If set, we will skip the naming format validation in the schema. So + the string values in `DocumentSchema.EntityType.name` and + `DocumentSchema.EntityType.Property.name` will not be checked. + type: boolean + GoogleCloudDocumentaiV1ProcessResponse: + id: GoogleCloudDocumentaiV1ProcessResponse + description: Response message for the ProcessDocument method. type: object - id: GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat - description: The statistic representing a dataset split type for this export. - GoogleCloudDocumentaiV1beta3HumanReviewStatus: - id: GoogleCloudDocumentaiV1beta3HumanReviewStatus + properties: + document: + description: >- + The document payload, will populate fields based on the processor's + behavior. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Document' + humanReviewStatus: + description: The status of human review on the processed document. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1HumanReviewStatus' + GoogleCloudDocumentaiV1HumanReviewStatus: + id: GoogleCloudDocumentaiV1HumanReviewStatus description: The status of human review on a processed document. + type: object properties: state: - enum: - - STATE_UNSPECIFIED - - SKIPPED - - VALIDATION_PASSED - - IN_PROGRESS - - ERROR + description: The state of human review on the processing request. + type: string enumDescriptions: - >- Human review state is unspecified. Most likely due to an internal @@ -1824,11 +2391,15 @@ components: - >- Some error happened during triggering human review, see the state_message for details. - type: string - description: The state of human review on the processing request. + enum: + - STATE_UNSPECIFIED + - SKIPPED + - VALIDATION_PASSED + - IN_PROGRESS + - ERROR stateMessage: - type: string description: A message providing more details about the human review state. + type: string humanReviewOperation: description: >- The name of the operation triggered by the processed document. This @@ -1836,2625 +2407,2138 @@ components: `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and metadata as the long-running operation returned by ReviewDocument. type: string + GoogleCloudDocumentaiV1BatchProcessRequest: + id: GoogleCloudDocumentaiV1BatchProcessRequest + description: Request message for BatchProcessDocuments. type: object - GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData: properties: - testDocuments: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1BatchDocumentsInputConfig - description: The documents used for testing the trained version. - trainingDocuments: - description: The documents used for training the new version. + inputDocuments: + description: The input documents for the BatchProcessDocuments method. $ref: >- #/components/schemas/GoogleCloudDocumentaiV1BatchDocumentsInputConfig + documentOutputConfig: + description: The output configuration for the BatchProcessDocuments method. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentOutputConfig' + skipHumanReview: + description: >- + Whether human review should be skipped for this request. Default to + `false`. + type: boolean + processOptions: + description: Inference-time options for the process API + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessOptions' + labels: + description: >- + Optional. The labels with user-defined metadata for the request. + Label keys and values can be no longer than 63 characters (Unicode + codepoints) and can only contain lowercase letters, numeric + characters, underscores, and dashes. International characters are + allowed. Label values are optional. Label keys must start with a + letter. + type: object + additionalProperties: + type: string + GoogleCloudDocumentaiV1BatchDocumentsInputConfig: + id: GoogleCloudDocumentaiV1BatchDocumentsInputConfig + description: The common config to specify a set of documents used as input. type: object - description: The input data used to train a new ProcessorVersion. - id: GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData - GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsResponse: - type: object - properties: {} - description: Response of the batch update documents operation. - id: GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsResponse - GoogleCloudDocumentaiV1DisableProcessorMetadata: - id: GoogleCloudDocumentaiV1DisableProcessorMetadata - description: The long-running operation metadata for the DisableProcessor method. + properties: + gcsPrefix: + description: >- + The set of documents that match the specified Cloud Storage + `gcs_prefix`. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1GcsPrefix' + gcsDocuments: + description: The set of documents individually specified on Cloud Storage. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1GcsDocuments' + GoogleCloudDocumentaiV1GcsPrefix: + id: GoogleCloudDocumentaiV1GcsPrefix + description: Specifies all documents on Cloud Storage with a common prefix. type: object properties: - commonMetadata: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' - description: The basic metadata of the long-running operation. - GoogleCloudDocumentaiV1DocumentPageTableTableCell: - description: A cell representation inside the table. + gcsUriPrefix: + description: The URI prefix. + type: string + GoogleCloudDocumentaiV1GcsDocuments: + id: GoogleCloudDocumentaiV1GcsDocuments + description: Specifies a set of documents on Cloud Storage. type: object properties: - detectedLanguages: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - description: A list of detected languages together with confidence. + documents: + description: The list of documents. type: array - colSpan: - format: int32 - description: How many columns this cell spans. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1GcsDocument' + GoogleCloudDocumentaiV1DocumentOutputConfig: + id: GoogleCloudDocumentaiV1DocumentOutputConfig + description: >- + Config that controls the output of documents. All documents will be + written as a JSON file. + type: object + properties: + gcsOutputConfig: + description: Output config to write the results to Cloud Storage. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig + GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig: + id: GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig + description: The configuration used when outputting documents. + type: object + properties: + gcsUri: + description: The Cloud Storage uri (a directory) of the output. + type: string + fieldMask: + description: >- + Specifies which fields to include in the output documents. Only + supports top level document and pages field so it must be in the + form of `{document_field_name}` or `pages.{page_field_name}`. + type: string + format: google-fieldmask + shardingConfig: + description: Specifies the sharding config for the output document. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig + GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig: + id: GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig + description: The sharding config for the output document. + type: object + properties: + pagesPerShard: + description: The number of pages per shard. type: integer - rowSpan: + format: int32 + pagesOverlap: + description: The number of overlapping pages between consecutive shards. type: integer format: int32 - description: How many rows this cell spans. - layout: - description: Layout for TableCell. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - id: GoogleCloudDocumentaiV1DocumentPageTableTableCell - GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus: + GoogleCloudDocumentaiV1FetchProcessorTypesResponse: + id: GoogleCloudDocumentaiV1FetchProcessorTypesResponse + description: Response message for the FetchProcessorTypes method. + type: object properties: - status: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The status of deleting the document in storage. - documentId: - description: The document id of the document. - $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' + processorTypes: + description: The list of processor types. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorType' + GoogleCloudDocumentaiV1ProcessorType: + id: GoogleCloudDocumentaiV1ProcessorType + description: >- + A processor type is responsible for performing a certain document + understanding task on a certain type of document. type: object - id: >- - GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus - description: The status of each individual document in the batch delete process. - GoogleCloudDocumentaiV1ReviewDocumentResponse: - description: Response message for the ReviewDocument method. + properties: + name: + description: >- + The resource name of the processor type. Format: + `projects/{project}/processorTypes/{processor_type}` + type: string + type: + description: 'The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.' + type: string + category: + description: The processor category, used by UI to group processor types. + type: string + availableLocations: + description: The locations in which this processor is available. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1ProcessorTypeLocationInfo + allowCreation: + description: >- + Whether the processor type allows creation. If true, users can + create a processor of this processor type. Otherwise, users need to + request access. + type: boolean + launchStage: + description: Launch stage of the processor type + type: string + enumDescriptions: + - Do not use this default value. + - The feature is not yet implemented. Users can not use it. + - >- + Prelaunch features are hidden from users and are only visible + internally. + - >- + Early Access features are limited to a closed group of testers. To + use these features, you must sign up in advance and sign a Trusted + Tester agreement (which includes confidentiality provisions). + These features may be unstable, changed in backward-incompatible + ways, and are not guaranteed to be released. + - >- + Alpha is a limited availability test for releases before they are + cleared for widespread use. By Alpha, all significant design + issues are resolved and we are in the process of verifying + functionality. Alpha customers need to apply for access, agree to + applicable terms, and have their projects allowlisted. Alpha + releases don't have to be feature complete, no SLAs are provided, + and there are no technical support obligations, but they will be + far enough along that customers can actually use them in test + environments or for limited-use tests -- just like they would in + normal production cases. + - >- + Beta is the point at which we are ready to open a release for any + customer to use. There are no SLA or technical support obligations + in a Beta release. Products will be complete from a feature + perspective, but may have some open outstanding issues. Beta + releases are suitable for limited production use cases. + - >- + GA features are open to all developers and are considered stable + and fully qualified for production use. + - >- + Deprecated features are scheduled to be shut down and removed. For + more information, see the "Deprecation Policy" section of our + [Terms of Service](https://cloud.google.com/terms/) and the + [Google Cloud Platform Subject to the Deprecation + Policy](https://cloud.google.com/terms/deprecation) documentation. + enum: + - LAUNCH_STAGE_UNSPECIFIED + - UNIMPLEMENTED + - PRELAUNCH + - EARLY_ACCESS + - ALPHA + - BETA + - GA + - DEPRECATED + sampleDocumentUris: + description: A set of Cloud Storage URIs of sample documents for this processor. + type: array + items: + type: string + GoogleCloudDocumentaiV1ProcessorTypeLocationInfo: + id: GoogleCloudDocumentaiV1ProcessorTypeLocationInfo + description: The location information about where the processor is available. type: object - id: GoogleCloudDocumentaiV1ReviewDocumentResponse properties: - state: - description: The state of the review operation. - type: string - enum: - - STATE_UNSPECIFIED - - REJECTED - - SUCCEEDED - enumDescriptions: - - The default value. This value is used if the state is omitted. - - The review operation is rejected by the reviewer. - - The review operation is succeeded. - rejectionReason: - description: The reason why the review is rejected by reviewer. - type: string - gcsDestination: + locationId: description: >- - The Cloud Storage uri for the human reviewed document if the review - is succeeded. + The location ID. For supported locations, refer to [regional and + multi-regional support](/document-ai/docs/regions). type: string GoogleCloudDocumentaiV1ListProcessorTypesResponse: + id: GoogleCloudDocumentaiV1ListProcessorTypesResponse + description: Response message for the ListProcessorTypes method. + type: object properties: processorTypes: + description: The processor types. type: array items: $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorType' - description: The processor types. nextPageToken: description: Points to the next page, otherwise empty. type: string + GoogleCloudDocumentaiV1ListProcessorsResponse: + id: GoogleCloudDocumentaiV1ListProcessorsResponse + description: Response message for the ListProcessors method. type: object - description: Response message for the ListProcessorTypes method. - id: GoogleCloudDocumentaiV1ListProcessorTypesResponse - GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty: properties: - displayName: - type: string - description: User defined name for the property. - occurrenceType: - description: >- - Occurrence type limits the number of instances an entity type - appears in the document. + processors: + description: The list of processors. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Processor' + nextPageToken: + description: Points to the next processor, otherwise empty. type: string - enum: - - OCCURRENCE_TYPE_UNSPECIFIED - - OPTIONAL_ONCE - - OPTIONAL_MULTIPLE - - REQUIRED_ONCE - - REQUIRED_MULTIPLE - enumDescriptions: - - Unspecified occurrence type. - - >- - There will be zero or one instance of this entity type. The same - entity instance may be mentioned multiple times. - - The entity type will appear zero or multiple times. - - >- - The entity type will only appear exactly once. The same entity - instance may be mentioned multiple times. - - The entity type will appear once or more times. + GoogleCloudDocumentaiV1Processor: + id: GoogleCloudDocumentaiV1Processor + description: >- + The first-class citizen for Document AI. Each processor defines how to + extract structural information from a document. + type: object + properties: name: - type: string description: >- - The name of the property. Follows the same guidelines as the - EntityType name. - valueType: + Output only. Immutable. The resource name of the processor. Format: + `projects/{project}/locations/{location}/processors/{processor}` + readOnly: true type: string + type: description: >- - A reference to the value type of the property. This type is subject - to the same conventions as the `Entity.base_types` field. - description: Defines properties that can be part of the entity type. - id: GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty - type: object - GoogleCloudDocumentaiV1DocumentPageDimension: - id: GoogleCloudDocumentaiV1DocumentPageDimension - description: Dimension for the page. - type: object - properties: - height: - format: float - type: number - description: Page height. - unit: - description: Dimension unit. + The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. + To get a list of processor types, see FetchProcessorTypes. type: string - width: - type: number - description: Page width. - format: float - GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId: - type: object - properties: - docId: - description: Required. The id of the document. + displayName: + description: The display name of the processor. type: string - id: GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId - description: >- - Identifies a document uniquely within the scope of a dataset in - unmanaged option. - GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan: - type: object - id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan - description: Represents where the chunk starts and ends in the document. - properties: - pageStart: - description: Page where chunk starts in the document. - format: int32 - type: integer - pageEnd: - type: integer - description: Page where chunk ends in the document. - format: int32 - GoogleCloudDocumentaiV1EvaluationCounters: - description: Evaluation counters for the documents that were used. - properties: - evaluatedDocumentsCount: - format: int32 - type: integer - description: How many documents were used in the evaluation. - invalidDocumentsCount: - format: int32 - type: integer - description: >- - How many documents were not included in the evaluation as they - didn't pass validation. - inputDocumentsCount: - format: int32 - description: How many documents were sent for evaluation. - type: integer - failedDocumentsCount: - type: integer - description: >- - How many documents were not included in the evaluation as Document - AI failed to process them. - format: int32 - type: object - id: GoogleCloudDocumentaiV1EvaluationCounters - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock: - description: >- - Represents a block. A block could be one of the various types (text, - table, list) supported. - type: object - id: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock - properties: - pageSpan: - description: Page span of the block. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan - listBlock: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock - description: Block consisting of list content/structure. - textBlock: - description: Block consisting of text content. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock - tableBlock: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock - description: Block consisting of table content/structure. - blockId: + state: + description: Output only. The state of the processor. + readOnly: true type: string - description: ID of the block. - GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak: - type: object - id: GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak - properties: - type: enumDescriptions: - - Unspecified break type. - - A single whitespace. - - A wider whitespace. - - A hyphen that indicates that a token has been split across lines. - description: Detected break type. + - The processor is in an unspecified state. + - >- + The processor is enabled, i.e., has an enabled version which can + currently serve processing requests and all the feature + dependencies have been successfully initialized. + - The processor is disabled. + - >- + The processor is being enabled, will become `ENABLED` if + successful. + - >- + The processor is being disabled, will become `DISABLED` if + successful. + - >- + The processor is being created, will become either `ENABLED` (for + successful creation) or `FAILED` (for failed ones). Once a + processor is in this state, it can then be used for document + processing, but the feature dependencies of the processor might + not be fully created yet. + - >- + The processor failed during creation or initialization of feature + dependencies. The user should delete the processor and recreate + one as all the functionalities of the processor are disabled. + - The processor is being deleted, will be removed if successful. enum: - - TYPE_UNSPECIFIED - - SPACE - - WIDE_SPACE - - HYPHEN - type: string - description: Detected break at the end of a Token. - GoogleCloudDocumentaiV1beta3ImportProcessorVersionResponse: - properties: - processorVersion: - type: string - description: The destination processor version name. - description: The response message for the ImportProcessorVersion method. - id: GoogleCloudDocumentaiV1beta3ImportProcessorVersionResponse - type: object - GoogleCloudDocumentaiV1DocumentDocumentLayout: - type: object - properties: - blocks: - description: List of blocks in the document. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock - type: array - description: >- - Represents the parsed layout of a document as a collection of blocks - that the document is divided into. - id: GoogleCloudDocumentaiV1DocumentDocumentLayout - GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus: - type: object - id: >- - GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus - description: The status of each individual document in the import process. - properties: - outputDocumentId: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta3DocumentId' + - STATE_UNSPECIFIED + - ENABLED + - DISABLED + - ENABLING + - DISABLING + - CREATING + - FAILED + - DELETING + defaultProcessorVersion: + description: The default processor version. + type: string + processorVersionAliases: + description: Output only. The processor version aliases. + readOnly: true + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorVersionAlias' + processEndpoint: description: >- - The document id of imported document if it was successful, otherwise - empty. - inputGcsSource: - description: The source Cloud Storage URI of the document. + Output only. Immutable. The http endpoint that can be called to + invoke processing. + readOnly: true type: string - status: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The status of the importing of the document. - GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId: + createTime: + description: Output only. The time the processor was created. + readOnly: true + type: string + format: google-datetime + kmsKeyName: + description: >- + The [KMS key](https://cloud.google.com/security-key-management) used + for encryption and decryption in CMEK scenarios. + type: string + satisfiesPzs: + description: Output only. Reserved for future use. + readOnly: true + type: boolean + satisfiesPzi: + description: Output only. Reserved for future use. + readOnly: true + type: boolean + GoogleCloudDocumentaiV1ProcessorVersionAlias: + id: GoogleCloudDocumentaiV1ProcessorVersionAlias + description: Contains the alias and the aliased resource name of processor version. type: object properties: - cwDocId: - deprecated: true - description: Id of the document (indexed) managed by Content Warehouse. + alias: + description: The alias in the form of `processor_version` resource name. type: string - gcsUri: + processorVersion: + description: The resource name of aliased processor version. type: string - description: Required. The Cloud Storage URI where the actual document is stored. - id: GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId - description: >- - Identifies a document uniquely within the scope of a dataset in the - user-managed Cloud Storage option. - GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata: + GoogleCloudDocumentaiV1TrainProcessorVersionRequest: + id: GoogleCloudDocumentaiV1TrainProcessorVersionRequest + description: Request message for the TrainProcessorVersion method. + type: object properties: - commonMetadata: + customDocumentExtractionOptions: + description: Options to control Custom Document Extraction (CDE) Processor. $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. + #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions + foundationModelTuningOptions: + description: Options to control foundation model tuning of a processor. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions + processorVersion: + description: Required. The processor version to be created. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorVersion' + documentSchema: + description: Optional. The schema the processor version will be trained with. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentSchema' + inputData: + description: Optional. The input data used to train the ProcessorVersion. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData + baseProcessorVersion: + description: >- + Optional. The processor version to use as a base for training. This + processor version must be a child of `parent`. Format: + `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`. + type: string + GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions: + id: >- + GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions description: >- - The long-running operation metadata for the DeleteProcessorVersion - method. - id: GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata + Options to control the training of the Custom Document Extraction (CDE) + Processor. type: object + properties: + trainingMethod: + description: Training method to use for CDE training. + type: string + enumDescriptions: + - '' + - '' + - '' + enum: + - TRAINING_METHOD_UNSPECIFIED + - MODEL_BASED + - TEMPLATE_BASED GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions: + id: >- + GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions + description: Options to control foundation model tuning of the processor. + type: object properties: - learningRateMultiplier: - format: float - type: number - description: >- - Optional. The multiplier to apply to the recommended learning rate. - Valid values are between 0.1 and 10. If not provided, recommended - learning rate will be used. trainSteps: - type: integer description: >- Optional. The number of steps to run for model tuning. Valid values are between 1 and 400. If not provided, recommended steps will be used. + type: integer format: int32 - id: >- - GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions - description: Options to control foundation model tuning of the processor. + learningRateMultiplier: + description: >- + Optional. The multiplier to apply to the recommended learning rate. + Valid values are between 0.1 and 10. If not provided, recommended + learning rate will be used. + type: number + format: float + GoogleCloudDocumentaiV1ProcessorVersion: + id: GoogleCloudDocumentaiV1ProcessorVersion + description: >- + A processor version is an implementation of a processor. Each processor + can have multiple versions, pretrained by Google internally or uptrained + by the customer. A processor can only have one default version at a + time. Its document-processing behavior is defined by that version. type: object - GoogleCloudDocumentaiV1DocumentShardInfo: - id: GoogleCloudDocumentaiV1DocumentShardInfo properties: - textOffset: - type: string + name: description: >- - The index of the first character in Document.text in the overall - document global text. - format: int64 - shardIndex: - format: int64 - description: The 0-based index of this shard. + Identifier. The resource name of the processor version. Format: + `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}` type: string - shardCount: - description: Total number of shards. + displayName: + description: The display name of the processor version. type: string - format: int64 - description: >- - For a large document, sharding may be performed to produce several - document shards. Each document shard contains this field to detail which - shard it is. - type: object - GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig: - id: GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig - description: The configuration used when outputting documents. - type: object - properties: - gcsUri: + documentSchema: + description: >- + Output only. The schema of the processor version. Describes the + output. + readOnly: true + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentSchema' + state: + description: Output only. The state of the processor version. + readOnly: true type: string - description: The Cloud Storage uri (a directory) of the output. - fieldMask: + enumDescriptions: + - The processor version is in an unspecified state. + - The processor version is deployed and can be used for processing. + - The processor version is being deployed. + - >- + The processor version is not deployed and cannot be used for + processing. + - The processor version is being undeployed. + - The processor version is being created. + - The processor version is being deleted. + - The processor version failed and is in an indeterminate state. + - The processor version is being imported. + enum: + - STATE_UNSPECIFIED + - DEPLOYED + - DEPLOYING + - UNDEPLOYED + - UNDEPLOYING + - CREATING + - DELETING + - FAILED + - IMPORTING + createTime: + description: Output only. The time the processor version was created. + readOnly: true + type: string + format: google-datetime + latestEvaluation: description: >- - Specifies which fields to include in the output documents. Only - supports top level document and pages field so it must be in the - form of `{document_field_name}` or `pages.{page_field_name}`. - format: google-fieldmask + Output only. The most recently invoked evaluation for the processor + version. + readOnly: true + $ref: '#/components/schemas/GoogleCloudDocumentaiV1EvaluationReference' + kmsKeyName: + description: Output only. The KMS key name used for encryption. + readOnly: true type: string - shardingConfig: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig - description: Specifies the sharding config for the output document. - GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata: - type: object - id: GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata - description: Metadata of the batch export documents operation. - properties: - commonMetadata: + kmsKeyVersionName: + description: Output only. The KMS key version with which data is encrypted. + readOnly: true + type: string + googleManaged: + description: >- + Output only. Denotes that this `ProcessorVersion` is managed by + Google. + readOnly: true + type: boolean + deprecationInfo: + description: >- + Output only. If set, information about the eventual deprecation of + this version. + readOnly: true $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - individualExportStatuses: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus - type: array - description: The list of response details of each document. - splitExportStats: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat - type: array - description: The list of statistics for each dataset split type. - GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata: - type: object - id: GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata - properties: - commonMetadata: + #/components/schemas/GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo + modelType: + description: Output only. The model type of this processor version. + readOnly: true + type: string + enumDescriptions: + - The processor version has unspecified model type. + - The processor version has generative model type. + - The processor version has custom model type. + enum: + - MODEL_TYPE_UNSPECIFIED + - MODEL_TYPE_GENERATIVE + - MODEL_TYPE_CUSTOM + satisfiesPzs: + description: Output only. Reserved for future use. + readOnly: true + type: boolean + satisfiesPzi: + description: Output only. Reserved for future use. + readOnly: true + type: boolean + genAiModelInfo: + description: >- + Output only. Information about Generative AI model-based processor + versions. + readOnly: true $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - GoogleCloudDocumentaiV1BatchProcessResponse: - description: Response message for BatchProcessDocuments. - id: GoogleCloudDocumentaiV1BatchProcessResponse - properties: {} - type: object - GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsResponse: - id: GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsResponse - properties: {} - description: Response of the delete documents operation. - type: object - GoogleCloudDocumentaiV1ListEvaluationsResponse: - description: The response from `ListEvaluations`. - id: GoogleCloudDocumentaiV1ListEvaluationsResponse + #/components/schemas/GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo + GoogleCloudDocumentaiV1EvaluationReference: + id: GoogleCloudDocumentaiV1EvaluationReference + description: >- + Gives a short summary of an evaluation, and links to the evaluation + itself. type: object properties: - nextPageToken: + operation: + description: The resource name of the Long Running Operation for the evaluation. + type: string + evaluation: + description: The resource name of the evaluation. type: string + aggregateMetrics: description: >- - A token, which can be sent as `page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. - evaluations: - description: The evaluations requested. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Evaluation' - type: array - GoogleCloudDocumentaiV1beta3DisableProcessorMetadata: + An aggregate of the statistics for the evaluation with fuzzy + matching on. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1EvaluationMetrics' + aggregateMetricsExact: + description: >- + An aggregate of the statistics for the evaluation with fuzzy + matching off. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1EvaluationMetrics' + GoogleCloudDocumentaiV1EvaluationMetrics: + id: GoogleCloudDocumentaiV1EvaluationMetrics + description: Evaluation metrics, either in aggregate or about a specific entity. type: object properties: - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - id: GoogleCloudDocumentaiV1beta3DisableProcessorMetadata - description: The long-running operation metadata for the DisableProcessor method. - GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata: - properties: - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - trainingDatasetValidation: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation - description: The training dataset validation information. - testDatasetValidation: - description: The test dataset validation information. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation - type: object - id: GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata - description: The metadata that represents a processor version being created. - GoogleCloudDocumentaiV1beta3BatchProcessResponse: - description: Response message for BatchProcessDocuments. - id: GoogleCloudDocumentaiV1beta3BatchProcessResponse - type: object - properties: {} - GoogleCloudDocumentaiV1UndeployProcessorVersionResponse: - type: object - description: Response message for the UndeployProcessorVersion method. - id: GoogleCloudDocumentaiV1UndeployProcessorVersionResponse - properties: {} - GoogleCloudDocumentaiUiv1beta3ExportDocumentsResponse: - description: The response proto of ExportDocuments method. - properties: {} - id: GoogleCloudDocumentaiUiv1beta3ExportDocumentsResponse - type: object - GoogleCloudDocumentaiV1DocumentTextAnchor: - description: Text reference indexing into the Document.text. - id: GoogleCloudDocumentaiV1DocumentTextAnchor + precision: + description: The calculated precision. + type: number + format: float + recall: + description: The calculated recall. + type: number + format: float + f1Score: + description: The calculated f1 score. + type: number + format: float + predictedOccurrencesCount: + description: The amount of occurrences in predicted documents. + type: integer + format: int32 + groundTruthOccurrencesCount: + description: The amount of occurrences in ground truth documents. + type: integer + format: int32 + predictedDocumentCount: + description: The amount of documents with a predicted occurrence. + type: integer + format: int32 + groundTruthDocumentCount: + description: The amount of documents with a ground truth occurrence. + type: integer + format: int32 + truePositivesCount: + description: The amount of true positives. + type: integer + format: int32 + falsePositivesCount: + description: The amount of false positives. + type: integer + format: int32 + falseNegativesCount: + description: The amount of false negatives. + type: integer + format: int32 + totalDocumentsCount: + description: The amount of documents that had an occurrence of this label. + type: integer + format: int32 + GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo: + id: GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo + description: Information about the upcoming deprecation of this processor version. type: object properties: - textSegments: - description: The text segments from the Document.text. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment - content: + deprecationTime: + description: The time at which this processor version will be deprecated. type: string - description: >- - Contains the content of the text span so that users do not have to - look it up in the text_segments. It is always populated for - formFields. - GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata: - id: GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata + format: google-datetime + replacementProcessorVersion: + description: If set, the processor version that will be used as a replacement. + type: string + GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo: + id: GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo + description: Information about Generative AI model-based processor versions. + type: object properties: - commonMetadata: - description: The basic metadata of the long-running operation. + foundationGenAiModelInfo: + description: Information for a pretrained Google-managed foundation model. $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - type: object - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell: + #/components/schemas/GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo + customGenAiModelInfo: + description: Information for a custom Generative AI model created by the user. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo + GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo: + id: >- + GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo + description: Information for a pretrained Google-managed foundation model. type: object properties: - blocks: - type: array + finetuningAllowed: + description: Whether finetuning is allowed for this base processor version. + type: boolean + minTrainLabeledDocuments: description: >- - A table cell is a list of blocks. Repeated blocks support further - hierarchies and nested blocks. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock - colSpan: - description: How many columns this cell spans. - format: int32 - type: integer - rowSpan: + The minimum number of labeled documents in the training dataset + required for finetuning. type: integer - description: How many rows this cell spans. format: int32 + GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo: id: >- - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell - description: Represents a cell in a table row. - GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus: + GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo + description: >- + Information for a custom Generative AI model created by the user. These + are created with `Create New Version` in either the `Call foundation + model` or `Fine tuning` tabs. + type: object properties: - documentId: - $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' - description: The document id of the document. - status: - description: The status of moving the document. - $ref: '#/components/schemas/GoogleRpcStatus' - description: The status of each individual document in the batch move process. + customModelType: + description: The type of custom model created by the user. + type: string + enumDescriptions: + - The model type is unspecified. + - The model is a versioned foundation model. + - The model is a finetuned foundation model. + enum: + - CUSTOM_MODEL_TYPE_UNSPECIFIED + - VERSIONED_FOUNDATION + - FINE_TUNED + baseProcessorVersionId: + description: The base processor version ID for the custom model. + type: string + GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData: + id: GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData + description: The input data used to train a new ProcessorVersion. type: object - id: >- - GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus - GoogleCloudDocumentaiV1ProcessResponse: properties: - document: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Document' - description: >- - The document payload, will populate fields based on the processor's - behavior. - humanReviewStatus: - description: The status of human review on the processed document. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1HumanReviewStatus' + trainingDocuments: + description: The documents used for training the new version. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1BatchDocumentsInputConfig + testDocuments: + description: The documents used for testing the trained version. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1BatchDocumentsInputConfig + GoogleCloudDocumentaiV1ListProcessorVersionsResponse: + id: GoogleCloudDocumentaiV1ListProcessorVersionsResponse + description: Response message for the ListProcessorVersions method. type: object - description: Response message for the ProcessDocument method. - id: GoogleCloudDocumentaiV1ProcessResponse - GoogleCloudDocumentaiV1BoundingPoly: - id: GoogleCloudDocumentaiV1BoundingPoly properties: - normalizedVertices: - type: array - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1NormalizedVertex' - description: The bounding polygon normalized vertices. - vertices: - description: The bounding polygon vertices. + processorVersions: + description: The list of processors. type: array items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Vertex' - description: A bounding polygon for the detected image annotation. - type: object - GoogleCloudDocumentaiV1DocumentEntityNormalizedValue: - properties: - moneyValue: - $ref: '#/components/schemas/GoogleTypeMoney' - description: >- - Money value. See also: - https://github.com/googleapis/googleapis/blob/master/google/type/money.proto - booleanValue: - type: boolean - description: >- - Boolean value. Can be used for entities with binary values, or for - checkboxes. - text: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorVersion' + nextPageToken: + description: Points to the next processor, otherwise empty. type: string - description: >- - Optional. An optional field to store a normalized string. For some - entity types, one of respective `structured_value` fields may also - be populated. Also not all the types of `structured_value` will be - normalized. For example, some processors may not generate `float` or - `integer` normalized text by default. Below are sample formats - mapped to structured values. - Money/Currency type (`money_value`) - is in the ISO 4217 text format. - Date type (`date_value`) is in the - ISO 8601 text format. - Datetime type (`datetime_value`) is in the - ISO 8601 text format. - addressValue: - $ref: '#/components/schemas/GoogleTypePostalAddress' - description: >- - Postal address. See also: - https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto - integerValue: - type: integer - format: int32 - description: Integer value. - dateValue: - $ref: '#/components/schemas/GoogleTypeDate' - description: >- - Date value. Includes year, month, day. See also: - https://github.com/googleapis/googleapis/blob/master/google/type/date.proto - floatValue: - type: number - format: float - description: Float value. - datetimeValue: - description: >- - DateTime value. Includes date, time, and timezone. See also: - https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto - $ref: '#/components/schemas/GoogleTypeDateTime' - id: GoogleCloudDocumentaiV1DocumentEntityNormalizedValue - description: Parsed and normalized entity value. + GoogleCloudDocumentaiV1DeployProcessorVersionRequest: + id: GoogleCloudDocumentaiV1DeployProcessorVersionRequest + description: Request message for the DeployProcessorVersion method. type: object - GoogleCloudDocumentaiV1SetDefaultProcessorVersionResponse: - id: GoogleCloudDocumentaiV1SetDefaultProcessorVersionResponse properties: {} + GoogleCloudDocumentaiV1UndeployProcessorVersionRequest: + id: GoogleCloudDocumentaiV1UndeployProcessorVersionRequest + description: Request message for the UndeployProcessorVersion method. type: object - description: Response message for the SetDefaultProcessorVersion method. - GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader: + properties: {} + GoogleCloudDocumentaiV1EnableProcessorRequest: + id: GoogleCloudDocumentaiV1EnableProcessorRequest + description: Request message for the EnableProcessor method. + type: object + properties: {} + GoogleCloudDocumentaiV1DisableProcessorRequest: + id: GoogleCloudDocumentaiV1DisableProcessorRequest + description: Request message for the DisableProcessor method. + type: object + properties: {} + GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest: + id: GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest + description: Request message for the SetDefaultProcessorVersion method. type: object properties: - pageSpan: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan - description: Page span of the header. - text: - description: Header in text format. + defaultProcessorVersion: + description: >- + Required. The resource name of child ProcessorVersion to use as + default. Format: + `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{version}` type: string - description: Represents the page header associated with the chunk. - id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader - GoogleCloudDocumentaiV1ProcessorVersion: - id: GoogleCloudDocumentaiV1ProcessorVersion + GoogleCloudDocumentaiV1ReviewDocumentRequest: + id: GoogleCloudDocumentaiV1ReviewDocumentRequest + description: Request message for the ReviewDocument method. type: object - description: >- - A processor version is an implementation of a processor. Each processor - can have multiple versions, pretrained by Google internally or uptrained - by the customer. A processor can only have one default version at a - time. Its document-processing behavior is defined by that version. properties: - latestEvaluation: - description: The most recently invoked evaluation for the processor version. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1EvaluationReference' - name: - type: string + inlineDocument: + description: An inline document proto. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Document' + enableSchemaValidation: description: >- - Identifier. The resource name of the processor version. Format: - `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}` - documentSchema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentSchema' - description: The schema of the processor version. Describes the output. - googleManaged: - readOnly: true + Whether the validation should be performed on the ad-hoc review + request. type: boolean - description: >- - Output only. Denotes that this `ProcessorVersion` is managed by - Google. - kmsKeyVersionName: - description: The KMS key version with which data is encrypted. + priority: + description: The priority of the human review task. type: string - satisfiesPzi: - readOnly: true - type: boolean - description: Output only. Reserved for future use. - state: enumDescriptions: - - The processor version is in an unspecified state. - - The processor version is deployed and can be used for processing. - - The processor version is being deployed. + - The default priority level. - >- - The processor version is not deployed and cannot be used for - processing. - - The processor version is being undeployed. - - The processor version is being created. - - The processor version is being deleted. - - The processor version failed and is in an indeterminate state. - - The processor version is being imported. - description: Output only. The state of the processor version. - type: string + The urgent priority level. The labeling manager should allocate + labeler resource to the urgent task queue to respect this priority + level. enum: - - STATE_UNSPECIFIED - - DEPLOYED - - DEPLOYING - - UNDEPLOYED - - UNDEPLOYING - - CREATING - - DELETING - - FAILED - - IMPORTING - readOnly: true - satisfiesPzs: - type: boolean - description: Output only. Reserved for future use. - readOnly: true - kmsKeyName: - type: string - description: The KMS key name used for encryption. - genAiModelInfo: + - DEFAULT + - URGENT + documentSchema: + description: The document schema of the human review task. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentSchema' + GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest: + id: GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest + description: Evaluates the given ProcessorVersion against the supplied documents. + type: object + properties: + evaluationDocuments: description: >- - Output only. Information about Generative AI model-based processor - versions. - readOnly: true + Optional. The documents used in the evaluation. If unspecified, use + the processor's dataset as evaluation input. $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo + #/components/schemas/GoogleCloudDocumentaiV1BatchDocumentsInputConfig + GoogleCloudDocumentaiV1Evaluation: + id: GoogleCloudDocumentaiV1Evaluation + description: An evaluation of a ProcessorVersion's performance. + type: object + properties: + name: + description: >- + The resource name of the evaluation. Format: + `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}` + type: string createTime: + description: The time that the evaluation was created. type: string format: google-datetime - description: The time the processor version was created. - modelType: - enum: - - MODEL_TYPE_UNSPECIFIED - - MODEL_TYPE_GENERATIVE - - MODEL_TYPE_CUSTOM - description: Output only. The model type of this processor version. - readOnly: true - enumDescriptions: - - The processor version has unspecified model type. - - The processor version has generative model type. - - The processor version has custom model type. - type: string - deprecationInfo: - description: If set, information about the eventual deprecation of this version. + documentCounters: + description: Counters for the documents used in the evaluation. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1EvaluationCounters' + allEntitiesMetrics: + description: Metrics for all the entities in aggregate. $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo - displayName: - type: string - description: The display name of the processor version. - GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo: - description: Information about the upcoming deprecation of this processor version. - properties: - deprecationTime: - format: google-datetime + #/components/schemas/GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics + entityMetrics: + description: Metrics across confidence levels, for different entities. + type: object + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics + kmsKeyName: + description: The KMS key name used for encryption. type: string - description: The time at which this processor version will be deprecated. - replacementProcessorVersion: - description: If set, the processor version that will be used as a replacement. + kmsKeyVersionName: + description: The KMS key version with which data is encrypted. type: string - id: GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo - type: object - GoogleCloudDocumentaiV1EnableProcessorMetadata: - id: GoogleCloudDocumentaiV1EnableProcessorMetadata + GoogleCloudDocumentaiV1EvaluationCounters: + id: GoogleCloudDocumentaiV1EvaluationCounters + description: Evaluation counters for the documents that were used. type: object properties: - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' - description: The long-running operation metadata for the EnableProcessor method. - GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect: - id: GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect + inputDocumentsCount: + description: How many documents were sent for evaluation. + type: integer + format: int32 + invalidDocumentsCount: + description: >- + How many documents were not included in the evaluation as they + didn't pass validation. + type: integer + format: int32 + failedDocumentsCount: + description: >- + How many documents were not included in the evaluation as Document + AI failed to process them. + type: integer + format: int32 + evaluatedDocumentsCount: + description: How many documents were used in the evaluation. + type: integer + format: int32 + GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics: + id: GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics + description: Metrics across multiple confidence levels. type: object properties: - type: - type: string + confidenceLevelMetrics: + description: Metrics across confidence levels with fuzzy matching enabled. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics + confidenceLevelMetricsExact: + description: Metrics across confidence levels with only exact matching. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics + auprc: description: >- - Name of the defect type. Supported values are: - - `quality/defect_blurry` - `quality/defect_noisy` - - `quality/defect_dark` - `quality/defect_faint` - - `quality/defect_text_too_small` - `quality/defect_document_cutoff` - - `quality/defect_text_cutoff` - `quality/defect_glare` - confidence: + The calculated area under the precision recall curve (AUPRC), + computed by integrating over all confidence thresholds. + type: number + format: float + estimatedCalibrationError: description: >- - Confidence of detected defect. Range `[0, 1]` where `1` indicates - strong confidence that the defect exists. + The Estimated Calibration Error (ECE) of the confidence of the + predicted entities. + type: number format: float + auprcExact: + description: >- + The AUPRC for metrics with fuzzy matching disabled, i.e., exact + matching only. type: number - description: Image Quality Defects - GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata: - description: Metadata of the EvaluateProcessorVersion method. + format: float + estimatedCalibrationErrorExact: + description: >- + The ECE for the predicted entities with fuzzy matching disabled, + i.e., exact matching only. + type: number + format: float + metricsType: + description: The metrics type for the label. + type: string + enumDescriptions: + - >- + The metrics type is unspecified. By default, metrics without a + particular specification are for leaf entity types (i.e., + top-level entity types without child types, or child types which + are not parent types themselves). + - >- + Indicates whether metrics for this particular label type represent + an aggregate of metrics for other types instead of being based on + actual TP/FP/FN values for the label type. Metrics for parent + (i.e., non-leaf) entity types are an aggregate of metrics for + their children. + enum: + - METRICS_TYPE_UNSPECIFIED + - AGGREGATE + GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics: + id: GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics + description: Evaluations metrics, at a specific confidence level. + type: object properties: - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. + confidenceLevel: + description: The confidence level. + type: number + format: float + metrics: + description: The metrics at the specific confidence level. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1EvaluationMetrics' + GoogleCloudDocumentaiV1ListEvaluationsResponse: + id: GoogleCloudDocumentaiV1ListEvaluationsResponse + description: The response from `ListEvaluations`. type: object - id: GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata - GoogleCloudDocumentaiV1GcsDocument: - id: GoogleCloudDocumentaiV1GcsDocument - description: Specifies a document stored on Cloud Storage. properties: - gcsUri: - type: string - description: The Cloud Storage object uri. - mimeType: - description: An IANA MIME type (RFC6838) of the content. + evaluations: + description: The evaluations requested. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Evaluation' + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. type: string + GoogleCloudLocationListLocationsResponse: + id: GoogleCloudLocationListLocationsResponse + description: The response message for Locations.ListLocations. type: object - GoogleCloudDocumentaiV1DocumentPageAnchorPageRef: properties: - confidence: + locations: description: >- - Optional. Confidence of detected page element, if applicable. Range - `[0, 1]`. - format: float - type: number - page: + A list of locations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/GoogleCloudLocationLocation' + nextPageToken: + description: The standard List next-page token. + type: string + GoogleCloudLocationLocation: + id: GoogleCloudLocationLocation + description: A resource that represents a Google Cloud location. + type: object + properties: + name: description: >- - Required. Index into the Document.pages element, for example using - `Document.pages` to locate the related page element. This field is - skipped when its value is the default `0`. See - https://developers.google.com/protocol-buffers/docs/proto3#json. - format: int64 + Resource name for the location, which may vary between + implementations. For example: + `"projects/example-project/locations/us-east1"` type: string - layoutId: - deprecated: true + locationId: + description: 'The canonical id for this location. For example: `"us-east1"`.' type: string - description: Optional. Deprecated. Use PageRef.bounding_poly instead. - layoutType: - enumDescriptions: - - Layout Unspecified. - - References a Page.blocks element. - - References a Page.paragraphs element. - - References a Page.lines element. - - References a Page.tokens element. - - References a Page.visual_elements element. - - Refrrences a Page.tables element. - - References a Page.form_fields element. - enum: - - LAYOUT_TYPE_UNSPECIFIED - - BLOCK - - PARAGRAPH - - LINE - - TOKEN - - VISUAL_ELEMENT - - TABLE - - FORM_FIELD + displayName: + description: >- + The friendly name for this location, typically a nearby city name. + For example, "Tokyo". type: string + labels: description: >- - Optional. The type of the layout element that is being referenced if - any. - boundingPoly: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1BoundingPoly' + Cross-service attributes for the location. For example + {"cloud.googleapis.com/region": "us-east1"} + type: object + additionalProperties: + type: string + metadata: description: >- - Optional. Identifies the bounding polygon of a layout element on the - page. If `layout_type` is set, the bounding polygon must be exactly - the same to the layout element it's referring to. - description: Represents a weak reference to a page element within a document. - type: object - id: GoogleCloudDocumentaiV1DocumentPageAnchorPageRef - GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse: + Service-specific metadata. For example the available capacity at the + given location. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + CloudAiDocumentaiLabHifiaToolsValidationValidatorInput: + id: CloudAiDocumentaiLabHifiaToolsValidationValidatorInput + description: >- + Definition of the validation rules. Those are the input to the validator + logic and they are used to validate a document. type: object - description: The response for TrainProcessorVersion. properties: - processorVersion: - description: The resource name of the processor version produced by training. - type: string - id: GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse - GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse: + validationRules: + type: array + items: + $ref: >- + #/components/schemas/CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRule + CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRule: + id: CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRule type: object - id: GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse - description: The response for TrainProcessorVersion. properties: - processorVersion: - description: The resource name of the processor version produced by training. + name: + description: Name of the validation rule. type: string - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan: + description: + description: >- + Description of the validation rule. This has no use but for + documentation + type: string + fieldOccurrences: + $ref: >- + #/components/schemas/CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFieldOccurrences + fieldRegex: + $ref: >- + #/components/schemas/CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFieldRegex + formValidation: + $ref: >- + #/components/schemas/CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFormValidation + CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFieldOccurrences: id: >- - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan - description: Represents where the block starts and ends in the document. + CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFieldOccurrences + type: object properties: - pageStart: + field: + $ref: >- + #/components/schemas/CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField + minOccurrences: + description: >- + Min and max occurrences of the field. If not set, there is limit + set. The defined interval is a closed-closed interval, i.e. [min, + max]. type: integer - description: Page where block starts in the document. - format: int32 - pageEnd: - description: Page where block ends in the document. + format: uint32 + maxOccurrences: type: integer - format: int32 - type: object - GoogleCloudDocumentaiV1beta3ReviewDocumentResponse: + format: uint32 + CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField: + id: >- + CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField type: object - id: GoogleCloudDocumentaiV1beta3ReviewDocumentResponse properties: - state: - enum: - - STATE_UNSPECIFIED - - REJECTED - - SUCCEEDED - enumDescriptions: - - The default value. This value is used if the state is omitted. - - The review operation is rejected by the reviewer. - - The review operation is succeeded. - type: string - description: The state of the review operation. - rejectionReason: - type: string - description: The reason why the review is rejected by reviewer. - gcsDestination: + fieldName: description: >- - The Cloud Storage uri for the human reviewed document if the review - is succeeded. + The field name to validate. This can be a simple field name or a + nested field one using the ':' (meant as an aggregator) or '*' + (meant as foreach) operators. type: string - description: Response message for the ReviewDocument method. - GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata: + defaultValue: + description: >- + Default value to use if the field is not present. If the field is + missing and the default value is not set, the validation run as if + the field is not present in the validation logic. + $ref: >- + #/components/schemas/CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleConstant + CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleConstant: + id: >- + CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleConstant + description: The constant value used in the validation rules. type: object properties: - commonMetadata: + floatValue: + type: number + format: float + CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFieldRegex: + id: >- + CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFieldRegex + type: object + properties: + field: $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - id: GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata - description: >- - The long-running operation metadata for the UndeployProcessorVersion - method. - GoogleCloudDocumentaiV1DocumentOutputConfig: - id: GoogleCloudDocumentaiV1DocumentOutputConfig + #/components/schemas/CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField + pattern: + description: Python regex to validate the field values. + type: string + CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFormValidation: + id: >- + CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFormValidation type: object properties: - gcsOutputConfig: - description: Output config to write the results to Cloud Storage. + leftOperand: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig - description: >- - Config that controls the output of documents. All documents will be - written as a JSON file. - GoogleCloudDocumentaiV1DocumentPageTable: + #/components/schemas/CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFormValidationOperation + rightOperand: + $ref: >- + #/components/schemas/CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFormValidationOperation + validationOperator: + description: The relational operator to be applied to the operands. + type: string + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + enum: + - OPERATION_TYPE_UNSPECIFIED + - OPERATION_TYPE_EQ + - OPERATION_TYPE_NE + - OPERATION_TYPE_LT + - OPERATION_TYPE_LE + - OPERATION_TYPE_GT + - OPERATION_TYPE_GE + CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFormValidationOperation: + id: >- + CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFormValidationOperation type: object - description: A table representation similar to HTML table structure. properties: - detectedLanguages: + fields: + description: A list of fields to be used as operands. + type: array items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - description: A list of detected languages together with confidence. + #/components/schemas/CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField + constants: + description: A list of constants to be used as operands. type: array - headerRows: + items: + $ref: >- + #/components/schemas/CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleConstant + operations: + description: A list of recursive operations to be used as operands. type: array - description: Header rows of the table. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableRow - provenance: - description: The history of this table. - deprecated: true - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - layout: - description: Layout for Table. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - bodyRows: - description: Body rows of the table. + #/components/schemas/CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFormValidationOperation + operationType: + description: The operation type to be applied to all the operands. + type: string + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + enum: + - OPERATION_TYPE_UNSPECIFIED + - OPERATION_TYPE_SUM + - OPERATION_TYPE_SUB + - OPERATION_TYPE_MUL + - OPERATION_TYPE_DIV + - OPERATION_TYPE_MAX + - OPERATION_TYPE_MIN + - OPERATION_TYPE_ABS + - OPERATION_TYPE_UNIQUE + - OPERATION_TYPE_COUNT + GoogleCloudDocumentaiV1BatchProcessResponse: + id: GoogleCloudDocumentaiV1BatchProcessResponse + description: Response message for BatchProcessDocuments. + type: object + properties: {} + GoogleCloudDocumentaiV1BatchProcessMetadata: + id: GoogleCloudDocumentaiV1BatchProcessMetadata + description: The long-running operation metadata for BatchProcessDocuments. + type: object + properties: + state: + description: The state of the current batch processing. + type: string + enumDescriptions: + - The default value. This value is used if the state is omitted. + - Request operation is waiting for scheduling. + - Request is being processed. + - The batch processing completed successfully. + - The batch processing was being cancelled. + - The batch processing was cancelled. + - The batch processing has failed. + enum: + - STATE_UNSPECIFIED + - WAITING + - RUNNING + - SUCCEEDED + - CANCELLING + - CANCELLED + - FAILED + stateMessage: + description: >- + A message providing more details about the current state of + processing. For example, the error message if the operation is + failed. + type: string + createTime: + description: The creation time of the operation. + type: string + format: google-datetime + updateTime: + description: The last update time of the operation. + type: string + format: google-datetime + individualProcessStatuses: + description: The list of response details of each document. type: array items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableRow - id: GoogleCloudDocumentaiV1DocumentPageTable + #/components/schemas/GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus: + id: GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus + description: The status of a each individual document in the batch process. type: object properties: - humanReviewStatus: - description: The status of human review on the processed document. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1HumanReviewStatus' inputGcsSource: - type: string description: >- The source of the document, same as the input_gcs_source field in the request when the batch process started. - outputGcsDestination: type: string + status: + description: The status processing the document. + $ref: '#/components/schemas/GoogleRpcStatus' + outputGcsDestination: description: >- The Cloud Storage output destination (in the request as DocumentOutputConfig.GcsOutputConfig.gcs_uri) of the processed document if it was successful, otherwise empty. - status: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The status processing the document. - description: The status of a each individual document in the batch process. - id: GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus - GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse: - description: Response message for the SetDefaultProcessorVersion method. - id: GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse - properties: {} - type: object - GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation: + type: string + humanReviewStatus: + description: The status of human review on the processed document. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1HumanReviewStatus' + GoogleCloudDocumentaiV1ReviewDocumentResponse: + id: GoogleCloudDocumentaiV1ReviewDocumentResponse + description: Response message for the ReviewDocument method. type: object properties: - datasetErrorCount: - description: The total number of dataset errors. - format: int32 - type: integer - documentErrors: - type: array - description: >- - Error information pertaining to specific documents. A maximum of 10 - document errors will be returned. Any document with errors will not - be used throughout training. - items: - $ref: '#/components/schemas/GoogleRpcStatus' - datasetErrors: - items: - $ref: '#/components/schemas/GoogleRpcStatus' + gcsDestination: description: >- - Error information for the dataset as a whole. A maximum of 10 - dataset errors will be returned. A single dataset error is terminal - for training. - type: array - documentErrorCount: - format: int32 - type: integer - description: The total number of document errors. - description: >- - The dataset validation information. This includes any and all errors - with documents and the dataset. - id: GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation - GoogleCloudDocumentaiV1DocumentPageImage: + The Cloud Storage uri for the human reviewed document if the review + is succeeded. + type: string + state: + description: The state of the review operation. + type: string + enumDescriptions: + - The default value. This value is used if the state is omitted. + - The review operation is rejected by the reviewer. + - The review operation is succeeded. + enum: + - STATE_UNSPECIFIED + - REJECTED + - SUCCEEDED + rejectionReason: + description: The reason why the review is rejected by reviewer. + type: string + GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata: + id: GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata + description: The long-running operation metadata for the ReviewDocument method. type: object - id: GoogleCloudDocumentaiV1DocumentPageImage properties: - height: - description: Height of the image in pixels. - format: int32 - type: integer - content: - format: byte - description: Raw byte content of the image. + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' + questionId: + description: The Crowd Compute question ID. type: string - mimeType: + GoogleCloudDocumentaiV1CommonOperationMetadata: + id: GoogleCloudDocumentaiV1CommonOperationMetadata + description: The common metadata for long running operations. + type: object + properties: + state: + description: The state of the operation. + type: string + enumDescriptions: + - Unspecified state. + - Operation is still running. + - Operation is being cancelled. + - Operation succeeded. + - Operation failed. + - Operation is cancelled. + enum: + - STATE_UNSPECIFIED + - RUNNING + - CANCELLING + - SUCCEEDED + - FAILED + - CANCELLED + stateMessage: description: >- - Encoding [media type (MIME - type)](https://www.iana.org/assignments/media-types/media-types.xhtml) - for the image. + A message providing more details about the current state of + processing. type: string - width: - format: int32 - description: Width of the image in pixels. - type: integer - description: Rendered image contents for this page. - GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata: - id: GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata + resource: + description: A related resource to this operation. + type: string + createTime: + description: The creation time of the operation. + type: string + format: google-datetime + updateTime: + description: The last update time of the operation. + type: string + format: google-datetime + GoogleCloudDocumentaiV1DeleteProcessorMetadata: + id: GoogleCloudDocumentaiV1DeleteProcessorMetadata + description: The long-running operation metadata for the DeleteProcessor method. type: object properties: commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata for the long-running operation. + description: The basic metadata of the long-running operation. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' + GoogleCloudDocumentaiV1EnableProcessorResponse: + id: GoogleCloudDocumentaiV1EnableProcessorResponse description: >- - The long-running operation metadata for the ImportProcessorVersion - method. - GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse: - properties: - gcsUri: - type: string - description: The Cloud Storage URI containing the output artifacts. - id: GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse + Response message for the EnableProcessor method. Intentionally empty + proto for adding fields in future. + type: object + properties: {} + GoogleCloudDocumentaiV1EnableProcessorMetadata: + id: GoogleCloudDocumentaiV1EnableProcessorMetadata + description: The long-running operation metadata for the EnableProcessor method. type: object - description: Response message associated with the ExportProcessorVersion operation. - GoogleCloudDocumentaiV1GcsDocuments: properties: - documents: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1GcsDocument' - type: array - description: The list of documents. - id: GoogleCloudDocumentaiV1GcsDocuments + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' + GoogleCloudDocumentaiV1DisableProcessorResponse: + id: GoogleCloudDocumentaiV1DisableProcessorResponse + description: >- + Response message for the DisableProcessor method. Intentionally empty + proto for adding fields in future. type: object - description: Specifies a set of documents on Cloud Storage. - GoogleCloudDocumentaiV1ListProcessorVersionsResponse: - id: GoogleCloudDocumentaiV1ListProcessorVersionsResponse + properties: {} + GoogleCloudDocumentaiV1DisableProcessorMetadata: + id: GoogleCloudDocumentaiV1DisableProcessorMetadata + description: The long-running operation metadata for the DisableProcessor method. type: object - description: Response message for the ListProcessorVersions method. - properties: - nextPageToken: - description: Points to the next processor, otherwise empty. - type: string - processorVersions: - type: array - description: The list of processors. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorVersion' - GoogleCloudDocumentaiUiv1beta3RevisionRef: - id: GoogleCloudDocumentaiUiv1beta3RevisionRef - description: The revision reference specifies which revision on the document to read. properties: - revisionId: - description: Reads the revision given by the id. - type: string - revisionCase: - description: Reads the revision by the predefined case. - enum: - - REVISION_CASE_UNSPECIFIED - - LATEST_HUMAN_REVIEW - - LATEST_TIMESTAMP - - BASE_OCR_REVISION - enumDescriptions: - - Unspecified case, fall back to read the `LATEST_HUMAN_REVIEW`. - - The latest revision made by a human. - - The latest revision based on timestamp. - - The first (OCR) revision. - type: string - latestProcessorVersion: - type: string - description: >- - Reads the revision generated by the processor version. The format - takes the full resource name of processor version. - `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` - type: object - GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata: + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' + GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata: + id: GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata description: >- - The long-running operation metadata for the DeployProcessorVersion + The long-running operation metadata for the DeleteProcessorVersion method. - id: GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata type: object properties: commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata description: The basic metadata of the long-running operation. - GoogleCloudDocumentaiV1OcrConfigPremiumFeatures: - id: GoogleCloudDocumentaiV1OcrConfigPremiumFeatures - properties: - enableSelectionMarkDetection: - type: boolean - description: >- - Turn on selection mark detector in OCR engine. Only available in OCR - 2.0 (and later) processors. - enableMathOcr: - type: boolean - description: Turn on the model that can extract LaTeX math formulas. - computeStyleInfo: - description: Turn on font identification model and return font style information. - type: boolean - description: Configurations for premium OCR features. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' + GoogleCloudDocumentaiV1DeployProcessorVersionMetadata: + id: GoogleCloudDocumentaiV1DeployProcessorVersionMetadata + description: >- + The long-running operation metadata for the DeployProcessorVersion + method. type: object - GoogleCloudDocumentaiV1BatchDocumentsInputConfig: - id: GoogleCloudDocumentaiV1BatchDocumentsInputConfig properties: - gcsDocuments: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1GcsDocuments' - description: The set of documents individually specified on Cloud Storage. - gcsPrefix: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1GcsPrefix' - description: >- - The set of documents that match the specified Cloud Storage - `gcs_prefix`. - type: object - description: The common config to specify a set of documents used as input. - GoogleCloudDocumentaiUiv1beta3DisableProcessorResponse: + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' + GoogleCloudDocumentaiV1DeployProcessorVersionResponse: + id: GoogleCloudDocumentaiV1DeployProcessorVersionResponse + description: Response message for the DeployProcessorVersion method. type: object - id: GoogleCloudDocumentaiUiv1beta3DisableProcessorResponse properties: {} + GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata: + id: GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata description: >- - Response message for the DisableProcessor method. Intentionally empty - proto for adding fields in future. - GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionMetadata: + The long-running operation metadata for the UndeployProcessorVersion + method. + type: object properties: commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The common metadata about the operation. + description: The basic metadata of the long-running operation. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' + GoogleCloudDocumentaiV1UndeployProcessorVersionResponse: + id: GoogleCloudDocumentaiV1UndeployProcessorVersionResponse + description: Response message for the UndeployProcessorVersion method. type: object - id: GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionMetadata - description: Metadata message associated with the ExportProcessorVersion operation. - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock: + properties: {} + GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata: + id: GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata + description: >- + The long-running operation metadata for the SetDefaultProcessorVersion + method. type: object properties: - bodyRows: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow - description: Body rows containing main table content. - caption: - type: string - description: Table caption/title. - headerRows: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow - description: Header rows at the top of the table. - id: >- - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock - description: Represents a table type block. - GoogleCloudDocumentaiV1beta3DeployProcessorVersionResponse: - description: Response message for the DeployProcessorVersion method. + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' + GoogleCloudDocumentaiV1SetDefaultProcessorVersionResponse: + id: GoogleCloudDocumentaiV1SetDefaultProcessorVersionResponse + description: Response message for the SetDefaultProcessorVersion method. + type: object properties: {} - id: GoogleCloudDocumentaiV1beta3DeployProcessorVersionResponse + GoogleCloudDocumentaiV1TrainProcessorVersionMetadata: + id: GoogleCloudDocumentaiV1TrainProcessorVersionMetadata + description: The metadata that represents a processor version being created. type: object - GoogleCloudDocumentaiV1ListProcessorsResponse: + properties: + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' + trainingDatasetValidation: + description: The training dataset validation information. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation + testDatasetValidation: + description: The test dataset validation information. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation + GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation: + id: GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation + description: >- + The dataset validation information. This includes any and all errors + with documents and the dataset. type: object properties: - nextPageToken: - type: string - description: Points to the next processor, otherwise empty. - processors: - description: The list of processors. + documentErrorCount: + description: The total number of document errors. + type: integer + format: int32 + datasetErrorCount: + description: The total number of dataset errors. + type: integer + format: int32 + documentErrors: + description: >- + Error information pertaining to specific documents. A maximum of 10 + document errors will be returned. Any document with errors will not + be used throughout training. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + datasetErrors: + description: >- + Error information for the dataset as a whole. A maximum of 10 + dataset errors will be returned. A single dataset error is terminal + for training. type: array items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Processor' - description: Response message for the ListProcessors method. - id: GoogleCloudDocumentaiV1ListProcessorsResponse - GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionResponse: - description: Response message for the DeployProcessorVersion method. - id: GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionResponse - properties: {} + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudDocumentaiV1TrainProcessorVersionResponse: + id: GoogleCloudDocumentaiV1TrainProcessorVersionResponse + description: The response for TrainProcessorVersion. type: object - GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata: properties: - testDatasetValidation: - description: The test dataset validation information. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation - trainingDatasetValidation: - description: The training dataset validation information. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - type: object - id: GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata - description: The metadata that represents a processor version being created. + processorVersion: + description: The resource name of the processor version produced by training. + type: string GoogleCloudDocumentaiV1EvaluateProcessorVersionMetadata: + id: GoogleCloudDocumentaiV1EvaluateProcessorVersionMetadata description: Metadata of the EvaluateProcessorVersion method. type: object - id: GoogleCloudDocumentaiV1EvaluateProcessorVersionMetadata properties: commonMetadata: description: The basic metadata of the long-running operation. $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' - GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment: + GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse: + id: GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse + description: Response of the EvaluateProcessorVersion method. + type: object properties: - endIndex: - format: int64 - type: string - description: TextSegment half open end UTF-8 char index in the Document.text. - startIndex: - format: int64 + evaluation: + description: The resource name of the created evaluation. type: string - description: TextSegment start UTF-8 char index in the Document.text. - description: >- - A text segment in the Document.text. The indices may be out of bounds - which indicate that the text extends into another document shard for - large sharded documents. See ShardInfo.text_offset - id: GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment + GoogleCloudDocumentaiV1beta3BatchProcessResponse: + id: GoogleCloudDocumentaiV1beta3BatchProcessResponse + description: Response message for BatchProcessDocuments. + type: object + properties: {} + GoogleCloudDocumentaiV1beta3BatchProcessMetadata: + id: GoogleCloudDocumentaiV1beta3BatchProcessMetadata + description: The long-running operation metadata for BatchProcessDocuments. type: object - GoogleCloudDocumentaiV1OcrConfig: properties: - disableCharacterBoxesDetection: - type: boolean - description: >- - Turn off character box detector in OCR engine. Character box - detection is enabled by default in OCR 2.0 (and later) processors. - advancedOcrOptions: + state: + description: The state of the current batch processing. + type: string + enumDescriptions: + - The default value. This value is used if the state is omitted. + - Request operation is waiting for scheduling. + - Request is being processed. + - The batch processing completed successfully. + - The batch processing was being cancelled. + - The batch processing was cancelled. + - The batch processing has failed. + enum: + - STATE_UNSPECIFIED + - WAITING + - RUNNING + - SUCCEEDED + - CANCELLING + - CANCELLED + - FAILED + stateMessage: description: >- - A list of advanced OCR options to further fine-tune OCR behavior. - Current valid values are: - `legacy_layout`: a heuristics layout - detection algorithm, which serves as an alternative to the current - ML-based layout detection algorithm. Customers can choose the best - suitable layout algorithm based on their situation. + A message providing more details about the current state of + processing. For example, the error message if the operation is + failed. + type: string + createTime: + description: The creation time of the operation. + type: string + format: google-datetime + updateTime: + description: The last update time of the operation. + type: string + format: google-datetime + individualProcessStatuses: + description: The list of response details of each document. type: array items: - type: string - enableSymbol: - description: Includes symbol level OCR information if set to true. - type: boolean - premiumFeatures: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1OcrConfigPremiumFeatures' - description: Configurations for premium OCR features. - hints: - description: Hints for the OCR model. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1OcrConfigHints' - enableNativePdfParsing: - type: boolean - description: >- - Enables special handling for PDFs with existing text information. - Results in better text extraction quality in such PDF inputs. - enableImageQualityScores: - type: boolean - description: >- - Enables intelligent document quality scores after OCR. Can help with - diagnosing why OCR responses are of poor quality for a given input. - Adds additional latency comparable to regular OCR to the process - call. - computeStyleInfo: - deprecated: true - type: boolean - description: >- - Turn on font identification model and return font style information. - Deprecated, use PremiumFeatures.compute_style_info instead. - id: GoogleCloudDocumentaiV1OcrConfig - type: object - description: Config for Document OCR. - GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata: - type: object - description: >- - The long-running operation metadata for the ImportProcessorVersion - method. - id: GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata - properties: - commonMetadata: - description: The basic metadata for the long-running operation. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig: - id: GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig - type: object - properties: - pagesOverlap: - type: integer - format: int32 - description: The number of overlapping pages between consecutive shards. - pagesPerShard: - description: The number of pages per shard. - format: int32 - type: integer - description: The sharding config for the output document. - GoogleCloudDocumentaiV1Barcode: - id: GoogleCloudDocumentaiV1Barcode + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus + GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus: + id: GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus + description: The status of a each individual document in the batch process. type: object - description: Encodes the detailed information of a barcode. properties: - format: + inputGcsSource: description: >- - Format of a barcode. The supported formats are: - `CODE_128`: Code - 128 type. - `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - - `CODABAR`: Codabar type. - `DATA_MATRIX`: 2D Data Matrix type. - - `ITF`: ITF type. - `EAN_13`: EAN-13 type. - `EAN_8`: EAN-8 type. - - `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A type. - `UPC_E`: UPC-E - type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code type. - - `DATABAR`: GS1 DataBar code type. + The source of the document, same as the input_gcs_source field in + the request when the batch process started. type: string - valueFormat: + status: + description: The status processing the document. + $ref: '#/components/schemas/GoogleRpcStatus' + outputGcsDestination: description: >- - Value format describes the format of the value that a barcode - encodes. The supported formats are: - `CONTACT_INFO`: Contact - information. - `EMAIL`: Email address. - `ISBN`: ISBN identifier. - - `PHONE`: Phone number. - `PRODUCT`: Product. - `SMS`: SMS message. - - `TEXT`: Text string. - `URL`: URL address. - `WIFI`: Wifi - information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`: Calendar - event. - `DRIVER_LICENSE`: Driver's license. - type: string - rawValue: + The Cloud Storage output destination (in the request as + DocumentOutputConfig.GcsOutputConfig.gcs_uri) of the processed + document if it was successful, otherwise empty. type: string + humanReviewOperation: description: >- - Raw value encoded in the barcode. For example: - `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`. - GoogleCloudDocumentaiV1EnableProcessorRequest: - description: Request message for the EnableProcessor method. - properties: {} - id: GoogleCloudDocumentaiV1EnableProcessorRequest - type: object - GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse: - type: object - properties: - evaluation: - description: The resource name of the created evaluation. + The name of the operation triggered by the processed document. If + the human review process isn't triggered, this field will be empty. + It has the same response type and metadata as the long-running + operation returned by the ReviewDocument method. + deprecated: true type: string - description: Response of the EvaluateProcessorVersion method. - id: GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse - GoogleCloudDocumentaiV1ProcessorTypeLocationInfo: + humanReviewStatus: + description: The status of human review on the processed document. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta3HumanReviewStatus' + GoogleCloudDocumentaiV1beta3HumanReviewStatus: + id: GoogleCloudDocumentaiV1beta3HumanReviewStatus + description: The status of human review on a processed document. type: object - id: GoogleCloudDocumentaiV1ProcessorTypeLocationInfo properties: - locationId: + state: + description: The state of human review on the processing request. + type: string + enumDescriptions: + - >- + Human review state is unspecified. Most likely due to an internal + error. + - >- + Human review is skipped for the document. This can happen because + human review isn't enabled on the processor or the processing + request has been set to skip this document. + - >- + Human review validation is triggered and passed, so no review is + needed. + - >- + Human review validation is triggered and the document is under + review. + - >- + Some error happened during triggering human review, see the + state_message for details. + enum: + - STATE_UNSPECIFIED + - SKIPPED + - VALIDATION_PASSED + - IN_PROGRESS + - ERROR + stateMessage: + description: A message providing more details about the human review state. type: string + humanReviewOperation: description: >- - The location ID. For supported locations, refer to [regional and - multi-regional support](/document-ai/docs/regions). - description: The location information about where the processor is available. + The name of the operation triggered by the processed document. This + field is populated only when the state is + `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and + metadata as the long-running operation returned by ReviewDocument. + type: string GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata: + id: GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata description: The long-running operation metadata for the DeleteProcessor method. type: object - id: GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata properties: commonMetadata: + description: The basic metadata of the long-running operation. $ref: >- #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - GoogleCloudDocumentaiV1FetchProcessorTypesResponse: - description: Response message for the FetchProcessorTypes method. - id: GoogleCloudDocumentaiV1FetchProcessorTypesResponse - type: object - properties: - processorTypes: - type: array - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorType' - description: The list of processor types. - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock: + GoogleCloudDocumentaiV1beta3CommonOperationMetadata: + id: GoogleCloudDocumentaiV1beta3CommonOperationMetadata + description: The common metadata for long running operations. type: object - id: >- - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock properties: - listEntries: - description: List entries that constitute a list block. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry - type: array - type: + state: + description: The state of the operation. + type: string + enumDescriptions: + - Unspecified state. + - Operation is still running. + - Operation is being cancelled. + - Operation succeeded. + - Operation failed. + - Operation is cancelled. + enum: + - STATE_UNSPECIFIED + - RUNNING + - CANCELLING + - SUCCEEDED + - FAILED + - CANCELLED + stateMessage: description: >- - Type of the list_entries (if exist). Available options are `ordered` - and `unordered`. + A message providing more details about the current state of + processing. type: string - description: Represents a list type block. - GoogleCloudDocumentaiV1TrainProcessorVersionRequest: - type: object - id: GoogleCloudDocumentaiV1TrainProcessorVersionRequest - properties: - documentSchema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentSchema' - description: Optional. The schema the processor version will be trained with. - foundationModelTuningOptions: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions - description: Options to control foundation model tuning of a processor. - processorVersion: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorVersion' - description: Required. The processor version to be created. - baseProcessorVersion: + resource: + description: A related resource to this operation. type: string - description: >- - Optional. The processor version to use as a base for training. This - processor version must be a child of `parent`. Format: - `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`. - inputData: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData - description: Optional. The input data used to train the ProcessorVersion. - customDocumentExtractionOptions: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions - description: Options to control Custom Document Extraction (CDE) Processor. - description: Request message for the TrainProcessorVersion method. - GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions: - description: >- - Options to control the training of the Custom Document Extraction (CDE) - Processor. - properties: - trainingMethod: + createTime: + description: The creation time of the operation. type: string - description: Training method to use for CDE training. - enumDescriptions: - - '' - - '' - - '' - enum: - - TRAINING_METHOD_UNSPECIFIED - - MODEL_BASED - - TEMPLATE_BASED - type: object - id: >- - GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions + format: google-datetime + updateTime: + description: The last update time of the operation. + type: string + format: google-datetime GoogleCloudDocumentaiV1beta3EnableProcessorResponse: + id: GoogleCloudDocumentaiV1beta3EnableProcessorResponse description: >- Response message for the EnableProcessor method. Intentionally empty proto for adding fields in future. - id: GoogleCloudDocumentaiV1beta3EnableProcessorResponse - properties: {} type: object - GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig: - description: Configuration specific to the Cloud Storage-based implementation. - id: GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig + properties: {} + GoogleCloudDocumentaiV1beta3EnableProcessorMetadata: + id: GoogleCloudDocumentaiV1beta3EnableProcessorMetadata + description: The long-running operation metadata for the EnableProcessor method. type: object properties: - gcsPrefix: - description: >- - Required. The Cloud Storage URI (a directory) where the documents - belonging to the dataset must be stored. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta3GcsPrefix' - GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata: - description: The metadata proto of `ResyncDataset` method. - id: GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + GoogleCloudDocumentaiV1beta3DisableProcessorResponse: + id: GoogleCloudDocumentaiV1beta3DisableProcessorResponse + description: >- + Response message for the DisableProcessor method. Intentionally empty + proto for adding fields in future. + type: object + properties: {} + GoogleCloudDocumentaiV1beta3DisableProcessorMetadata: + id: GoogleCloudDocumentaiV1beta3DisableProcessorMetadata + description: The long-running operation metadata for the DisableProcessor method. type: object properties: commonMetadata: description: The basic metadata of the long-running operation. $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - individualDocumentResyncStatuses: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus - description: >- - The list of document resync statuses. The same document could have - multiple `individual_document_resync_statuses` if it has multiple - inconsistencies. - datasetResyncStatuses: - type: array - description: >- - The list of dataset resync statuses. Not checked when - ResyncDatasetRequest.dataset_documents is specified. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus - GoogleCloudDocumentaiV1ProcessRequest: - id: GoogleCloudDocumentaiV1ProcessRequest + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + GoogleCloudDocumentaiV1beta3ReviewDocumentResponse: + id: GoogleCloudDocumentaiV1beta3ReviewDocumentResponse + description: Response message for the ReviewDocument method. + type: object properties: - imagelessMode: - type: boolean - description: Optional. Option to remove images from the document. - fieldMask: + gcsDestination: description: >- - Specifies which fields to include in the ProcessResponse.document - output. Only supports top-level document and pages field, so it must - be in the form of `{document_field_name}` or - `pages.{page_field_name}`. + The Cloud Storage uri for the human reviewed document if the review + is succeeded. type: string - format: google-fieldmask - processOptions: - description: Inference-time options for the process API - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessOptions' - labels: - description: >- - Optional. The labels with user-defined metadata for the request. - Label keys and values can be no longer than 63 characters (Unicode - codepoints) and can only contain lowercase letters, numeric - characters, underscores, and dashes. International characters are - allowed. Label values are optional. Label keys must start with a - letter. - type: object - additionalProperties: - type: string - gcsDocument: - description: A raw document on Google Cloud Storage. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1GcsDocument' - inlineDocument: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Document' - description: An inline document proto. - rawDocument: - description: A raw document content (bytes). - $ref: '#/components/schemas/GoogleCloudDocumentaiV1RawDocument' - skipHumanReview: - type: boolean - description: >- - Whether human review should be skipped for this request. Default to - `false`. - description: Request message for the ProcessDocument method. - type: object - GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo: - id: >- - GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo + state: + description: The state of the review operation. + type: string + enumDescriptions: + - The default value. This value is used if the state is omitted. + - The review operation is rejected by the reviewer. + - The review operation is succeeded. + enum: + - STATE_UNSPECIFIED + - REJECTED + - SUCCEEDED + rejectionReason: + description: The reason why the review is rejected by reviewer. + type: string + GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata: + id: GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata + description: The long-running operation metadata for the ReviewDocument method. type: object - description: Information for a pretrained Google-managed foundation model. - properties: - minTrainLabeledDocuments: - format: int32 - description: >- - The minimum number of labeled documents in the training dataset - required for finetuning. - type: integer - finetuningAllowed: - type: boolean - description: Whether finetuning is allowed for this base processor version. - GoogleCloudDocumentaiV1beta3BatchProcessMetadata: properties: state: + description: Used only when Operation.done is false. type: string enumDescriptions: - - The default value. This value is used if the state is omitted. - - Request operation is waiting for scheduling. - - Request is being processed. - - The batch processing completed successfully. - - The batch processing was being cancelled. - - The batch processing was cancelled. - - The batch processing has failed. - description: The state of the current batch processing. + - Unspecified state. + - Operation is still running. + - Operation is being cancelled. + - Operation succeeded. + - Operation failed. + - Operation is cancelled. enum: - STATE_UNSPECIFIED - - WAITING - RUNNING - - SUCCEEDED - CANCELLING - - CANCELLED + - SUCCEEDED - FAILED + - CANCELLED stateMessage: description: >- A message providing more details about the current state of processing. For example, the error message if the operation is failed. type: string - individualProcessStatuses: - description: The list of response details of each document. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus - updateTime: - description: The last update time of the operation. - format: google-datetime - type: string createTime: description: The creation time of the operation. type: string format: google-datetime - id: GoogleCloudDocumentaiV1beta3BatchProcessMetadata - description: The long-running operation metadata for BatchProcessDocuments. - type: object - GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus: - description: Resync status for each document per inconsistency type. - properties: - status: - description: >- - The status of resyncing the document with regards to the detected - inconsistency. Empty if ResyncDatasetRequest.validate_only is - `true`. - $ref: '#/components/schemas/GoogleRpcStatus' - documentInconsistencyType: - description: The type of document inconsistency. - type: string - enumDescriptions: - - Default value. - - The document proto is invalid. - - Indexed docproto metadata is mismatched. - - The page image or thumbnails are missing. - enum: - - DOCUMENT_INCONSISTENCY_TYPE_UNSPECIFIED - - DOCUMENT_INCONSISTENCY_TYPE_INVALID_DOCPROTO - - DOCUMENT_INCONSISTENCY_TYPE_MISMATCHED_METADATA - - DOCUMENT_INCONSISTENCY_TYPE_NO_PAGE_IMAGE - documentId: - $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' - description: The document identifier. - id: >- - GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus - type: object - GoogleTypeTimeZone: - type: object - properties: - id: - type: string - description: IANA Time Zone Database time zone, e.g. "America/New_York". - version: + updateTime: + description: The last update time of the operation. type: string - description: Optional. IANA Time Zone Database version number, e.g. "2019a". - id: GoogleTypeTimeZone - description: >- - Represents a time zone from the [IANA Time Zone - Database](https://www.iana.org/time-zones). - GoogleCloudDocumentaiV1DocumentEntity: - type: object - description: >- - An entity that could be a phrase in the text or a property that belongs - to the document. It is a known entity type, such as a person, an - organization, or location. - properties: - redacted: - description: >- - Optional. Whether the entity will be redacted for de-identification - purposes. - type: boolean - properties: - type: array - description: >- - Optional. Entities can be nested to form a hierarchical data - structure representing the content in the document. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntity' - textAnchor: - description: >- - Optional. Provenance of the entity. Text anchor indexing into the - Document.text. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' - normalizedValue: + format: google-datetime + commonMetadata: + description: The basic metadata of the long-running operation. $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentEntityNormalizedValue - description: >- - Optional. Normalized entity value. Absent if the extracted value - could not be converted or the type (e.g. address) is not supported - for certain parsers. This field is also only populated for certain - supported document types. - mentionText: - type: string - description: Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`. - provenance: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - description: Optional. The history of this annotation. - mentionId: - description: Optional. Deprecated. Use `id` field instead. - type: string - type: - type: string - description: Required. Entity type from a schema e.g. `Address`. - id: - description: >- - Optional. Canonical id. This will be a unique value in the entity - list for this document. - type: string - pageAnchor: - description: >- - Optional. Represents the provenance of this entity wrt. the location - on the page where it was found. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageAnchor' - confidence: - description: Optional. Confidence of detected Schema entity. Range `[0, 1]`. - format: float - type: number - id: GoogleCloudDocumentaiV1DocumentEntity - GoogleCloudDocumentaiV1TrainProcessorVersionResponse: - properties: - processorVersion: + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + questionId: + description: The Crowd Compute question ID. type: string - description: The resource name of the processor version produced by training. - type: object - id: GoogleCloudDocumentaiV1TrainProcessorVersionResponse - description: The response for TrainProcessorVersion. - GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest: - description: Evaluates the given ProcessorVersion against the supplied documents. - id: GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest + GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata: + id: GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata + description: >- + The long-running operation metadata for the DeleteProcessorVersion + method. type: object - properties: - evaluationDocuments: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1BatchDocumentsInputConfig - description: >- - Optional. The documents used in the evaluation. If unspecified, use - the processor's dataset as evaluation input. - GoogleCloudDocumentaiV1DeleteProcessorMetadata: properties: commonMetadata: description: The basic metadata of the long-running operation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' - description: The long-running operation metadata for the DeleteProcessor method. - id: GoogleCloudDocumentaiV1DeleteProcessorMetadata - type: object - GoogleTypeColor: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata: + id: GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata description: >- - Represents a color in the RGBA color space. This representation is - designed for simplicity of conversion to and from color representations - in various languages over compactness. For example, the fields of this - representation can be trivially provided to the constructor of - `java.awt.Color` in Java; it can also be trivially provided to UIColor's - `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little - work, it can be easily formatted into a CSS `rgba()` string in - JavaScript. This reference page doesn't have information about the - absolute color space that should be used to interpret the RGB value—for - example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications - should assume the sRGB color space. When color equality needs to be - decided, implementations, unless documented otherwise, treat two colors - as equal if all their red, green, blue, and alpha values each differ by - at most `1e-5`. Example (Java): import com.google.type.Color; // ... - public static java.awt.Color fromProto(Color protocolor) { float alpha = - protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return - new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), - protocolor.getBlue(), alpha); } public static Color - toProto(java.awt.Color color) { float red = (float) color.getRed(); - float green = (float) color.getGreen(); float blue = (float) - color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder - = Color .newBuilder() .setRed(red / denominator) .setGreen(green / - denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); - if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() - .setValue(((float) alpha) / denominator) .build()); } return - resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static - UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; - float green = [protocolor green]; float blue = [protocolor blue]; - FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if - (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return - [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static - Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if - (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return - nil; } Color* result = [[Color alloc] init]; [result setRed:red]; - [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { - [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; - return result; } // ... Example (JavaScript): // ... var protoToCssColor - = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var - greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || - 0.0; var red = Math.floor(redFrac * 255); var green = - Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if - (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } - var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, - green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, - ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var - rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString - = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var - resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { - resultBuilder.push('0'); } resultBuilder.push(hexString); return - resultBuilder.join(''); }; // ... - type: object - id: GoogleTypeColor - properties: - blue: - format: float - description: The amount of blue in the color as a value in the interval [0, 1]. - type: number - red: - format: float - type: number - description: The amount of red in the color as a value in the interval [0, 1]. - green: - description: The amount of green in the color as a value in the interval [0, 1]. - type: number - format: float - alpha: - type: number - format: float - description: >- - The fraction of this color that should be applied to the pixel. That - is, the final pixel color is defined by the equation: `pixel color = - alpha * (this color) + (1.0 - alpha) * (background color)` This - means that a value of 1.0 corresponds to a solid color, whereas a - value of 0.0 corresponds to a completely transparent color. This - uses a wrapper message rather than a simple float scalar so that it - is possible to distinguish between a default value and the value - being unset. If omitted, this color object is rendered as a solid - color (as if the alpha value had been explicitly given a value of - 1.0). - GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata: - properties: - errorDocumentCount: - description: Total number of documents that failed to be deleted in storage. - type: integer - format: int32 - individualBatchDeleteStatuses: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus - description: The list of response details of each document. - totalDocumentCount: - description: Total number of documents deleting from dataset. - format: int32 - type: integer + The long-running operation metadata for the DeployProcessorVersion + method. + type: object + properties: commonMetadata: description: The basic metadata of the long-running operation. $ref: >- #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - id: GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata - type: object - GoogleTypeMoney: - properties: - currencyCode: - type: string - description: The three-letter currency code defined in ISO 4217. - units: - description: >- - The whole units of the amount. For example if `currencyCode` is - `"USD"`, then 1 unit is one US dollar. - type: string - format: int64 - nanos: - type: integer - description: >- - Number of nano (10^-9) units of the amount. The value must be - between -999,999,999 and +999,999,999 inclusive. If `units` is - positive, `nanos` must be positive or zero. If `units` is zero, - `nanos` can be positive, zero, or negative. If `units` is negative, - `nanos` must be negative or zero. For example $-1.75 is represented - as `units`=-1 and `nanos`=-750,000,000. - format: int32 - description: Represents an amount of money with its currency type. + GoogleCloudDocumentaiV1beta3DeployProcessorVersionResponse: + id: GoogleCloudDocumentaiV1beta3DeployProcessorVersionResponse + description: Response message for the DeployProcessorVersion method. type: object - id: GoogleTypeMoney - GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo: - id: >- - GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo + properties: {} + GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata: + id: GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata description: >- - Information for a custom Generative AI model created by the user. These - are created with `Create New Version` in either the `Call foundation - model` or `Fine tuning` tabs. + The long-running operation metadata for the UndeployProcessorVersion + method. + type: object properties: - baseProcessorVersionId: - type: string - description: The base processor version ID for the custom model. - customModelType: - type: string - enum: - - CUSTOM_MODEL_TYPE_UNSPECIFIED - - VERSIONED_FOUNDATION - - FINE_TUNED - description: The type of custom model created by the user. - enumDescriptions: - - The model type is unspecified. - - The model is a versioned foundation model. - - The model is a finetuned foundation model. + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + GoogleCloudDocumentaiV1beta3UndeployProcessorVersionResponse: + id: GoogleCloudDocumentaiV1beta3UndeployProcessorVersionResponse + description: Response message for the UndeployProcessorVersion method. type: object - GoogleCloudDocumentaiV1DocumentSchemaMetadata: + properties: {} + GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata: + id: GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata + description: >- + The long-running operation metadata for the SetDefaultProcessorVersion + method. type: object - id: GoogleCloudDocumentaiV1DocumentSchemaMetadata - description: Metadata for global schema behavior. properties: - skipNamingValidation: - type: boolean - description: >- - If set, we will skip the naming format validation in the schema. So - the string values in `DocumentSchema.EntityType.name` and - `DocumentSchema.EntityType.Property.name` will not be checked. - documentAllowMultipleLabels: - type: boolean - description: >- - If true, on a given page, there can be multiple `document` - annotations covering it. - prefixedNamingOnProperties: - type: boolean - description: If set, all the nested entities must be prefixed with the parents. - documentSplitter: - type: boolean - description: >- - If true, a `document` entity type can be applied to subdocument - (splitting). Otherwise, it can only be applied to the entire - document (classification). - GoogleCloudDocumentaiV1DocumentChunkedDocument: - id: GoogleCloudDocumentaiV1DocumentChunkedDocument - description: Represents the chunks that the document is divided into. + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionResponse: + id: GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionResponse + description: Response message for the SetDefaultProcessorVersion method. type: object - properties: - chunks: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk - type: array - description: List of chunks. - GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig: - properties: - schema: - type: string - readOnly: true - description: >- - Output only. The schema in Document AI Warehouse associated with the - dataset. - collection: - type: string - description: >- - Output only. The collection in Document AI Warehouse associated with - the dataset. - readOnly: true - description: >- - Configuration specific to the Document AI Warehouse-based - implementation. + properties: {} + GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata: + id: GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata + description: The metadata that represents a processor version being created. type: object - id: GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig - GoogleCloudDocumentaiV1beta3RevisionRef: - id: GoogleCloudDocumentaiV1beta3RevisionRef properties: - revisionId: - description: Reads the revision given by the id. - type: string - latestProcessorVersion: - type: string - description: >- - Reads the revision generated by the processor version. The format - takes the full resource name of processor version. - `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` - revisionCase: - enumDescriptions: - - Unspecified case, fall back to read the `LATEST_HUMAN_REVIEW`. - - The latest revision made by a human. - - The latest revision based on timestamp. - - The first (OCR) revision. - enum: - - REVISION_CASE_UNSPECIFIED - - LATEST_HUMAN_REVIEW - - LATEST_TIMESTAMP - - BASE_OCR_REVISION - type: string - description: Reads the revision by the predefined case. - description: The revision reference specifies which revision on the document to read. + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + trainingDatasetValidation: + description: The training dataset validation information. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation + testDatasetValidation: + description: The test dataset validation information. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation + GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation: + id: >- + GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation + description: >- + The dataset validation information. This includes any and all errors + with documents and the dataset. type: object - GoogleCloudDocumentaiV1ProcessorType: - id: GoogleCloudDocumentaiV1ProcessorType properties: - availableLocations: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1ProcessorTypeLocationInfo - type: array - description: The locations in which this processor is available. - category: - description: The processor category, used by UI to group processor types. - type: string - launchStage: - enum: - - LAUNCH_STAGE_UNSPECIFIED - - UNIMPLEMENTED - - PRELAUNCH - - EARLY_ACCESS - - ALPHA - - BETA - - GA - - DEPRECATED - enumDescriptions: - - Do not use this default value. - - The feature is not yet implemented. Users can not use it. - - >- - Prelaunch features are hidden from users and are only visible - internally. - - >- - Early Access features are limited to a closed group of testers. To - use these features, you must sign up in advance and sign a Trusted - Tester agreement (which includes confidentiality provisions). - These features may be unstable, changed in backward-incompatible - ways, and are not guaranteed to be released. - - >- - Alpha is a limited availability test for releases before they are - cleared for widespread use. By Alpha, all significant design - issues are resolved and we are in the process of verifying - functionality. Alpha customers need to apply for access, agree to - applicable terms, and have their projects allowlisted. Alpha - releases don't have to be feature complete, no SLAs are provided, - and there are no technical support obligations, but they will be - far enough along that customers can actually use them in test - environments or for limited-use tests -- just like they would in - normal production cases. - - >- - Beta is the point at which we are ready to open a release for any - customer to use. There are no SLA or technical support obligations - in a Beta release. Products will be complete from a feature - perspective, but may have some open outstanding issues. Beta - releases are suitable for limited production use cases. - - >- - GA features are open to all developers and are considered stable - and fully qualified for production use. - - >- - Deprecated features are scheduled to be shut down and removed. For - more information, see the "Deprecation Policy" section of our - [Terms of Service](https://cloud.google.com/terms/) and the - [Google Cloud Platform Subject to the Deprecation - Policy](https://cloud.google.com/terms/deprecation) documentation. - type: string - description: Launch stage of the processor type - allowCreation: - type: boolean + documentErrorCount: + description: The total number of document errors. + type: integer + format: int32 + datasetErrorCount: + description: The total number of dataset errors. + type: integer + format: int32 + documentErrors: description: >- - Whether the processor type allows creation. If true, users can - create a processor of this processor type. Otherwise, users need to - request access. - type: - description: 'The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.' - type: string - sampleDocumentUris: + Error information pertaining to specific documents. A maximum of 10 + document errors will be returned. Any document with errors will not + be used throughout training. + type: array items: - type: string - description: A set of Cloud Storage URIs of sample documents for this processor. + $ref: '#/components/schemas/GoogleRpcStatus' + datasetErrors: + description: >- + Error information for the dataset as a whole. A maximum of 10 + dataset errors will be returned. A single dataset error is terminal + for training. type: array - name: + items: + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse: + id: GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse + description: The response for TrainProcessorVersion. + type: object + properties: + processorVersion: + description: The resource name of the processor version produced by training. type: string - description: >- - The resource name of the processor type. Format: - `projects/{project}/processorTypes/{processor_type}` - description: >- - A processor type is responsible for performing a certain document - understanding task on a certain type of document. + GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata: + id: GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata + description: Metadata of the EvaluateProcessorVersion method. type: object - GoogleCloudDocumentaiV1DocumentStyle: + properties: + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse: + id: GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse + description: Response of the EvaluateProcessorVersion method. type: object - id: GoogleCloudDocumentaiV1DocumentStyle - description: >- - Annotation for common text style attributes. This adheres to CSS - conventions as much as possible. properties: - textDecoration: - type: string - description: >- - [Text - decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). - Follows CSS standard. - color: - description: Text color. - $ref: '#/components/schemas/GoogleTypeColor' - fontSize: - description: Font size. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentStyleFontSize' - textStyle: - description: >- - [Text - style](https://www.w3schools.com/cssref/pr_font_font-style.asp). - Possible values are `normal`, `italic`, and `oblique`. - type: string - textAnchor: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' - description: Text anchor indexing into the Document.text. - backgroundColor: - $ref: '#/components/schemas/GoogleTypeColor' - description: Text background color. - fontWeight: - type: string - description: >- - [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). - Possible values are `normal`, `bold`, `bolder`, and `lighter`. - fontFamily: - description: >- - Font family such as `Arial`, `Times New Roman`. - https://www.w3schools.com/cssref/pr_font_font-family.asp + evaluation: + description: The resource name of the created evaluation. type: string - GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata: + GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata: + id: GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata + description: >- + The long-running operation metadata for the ImportProcessorVersion + method. + type: object properties: commonMetadata: + description: The basic metadata for the long-running operation. $ref: >- #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + GoogleCloudDocumentaiV1beta3ImportProcessorVersionResponse: + id: GoogleCloudDocumentaiV1beta3ImportProcessorVersionResponse + description: The response message for the ImportProcessorVersion method. + type: object + properties: + processorVersion: + description: The destination processor version name. + type: string + GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata: + id: GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata + type: object + properties: + commonMetadata: description: The basic metadata of the long-running operation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + GoogleCloudDocumentaiV1beta3Dataset: + id: GoogleCloudDocumentaiV1beta3Dataset description: >- - The long-running operation metadata for the UndeployProcessorVersion - method. - id: GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata + A singleton resource under a Processor which configures a collection of + documents. type: object - GoogleCloudDocumentaiV1Processor: - id: GoogleCloudDocumentaiV1Processor properties: + gcsManagedConfig: + description: >- + Optional. User-managed Cloud Storage dataset configuration. Use this + configuration if the dataset documents are stored under a + user-managed Cloud Storage location. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig + documentWarehouseConfig: + description: >- + Optional. Deprecated. Warehouse-based dataset configuration is not + supported. + deprecated: true + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig + unmanagedDatasetConfig: + description: >- + Optional. Unmanaged dataset configuration. Use this configuration if + the dataset documents are managed by the document service internally + (not user-managed). + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig + spannerIndexingConfig: + description: >- + Optional. A lightweight indexing source with low latency and high + reliability, but lacking advanced features like CMEK and + content-based search. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig name: - type: string - readOnly: true description: >- - Output only. Immutable. The resource name of the processor. Format: - `projects/{project}/locations/{location}/processors/{processor}` - displayName: - description: The display name of the processor. + Dataset resource name. Format: + `projects/{project}/locations/{location}/processors/{processor}/dataset` + type: string + state: + description: Required. State of the dataset. Ignored when updating dataset. type: string + enumDescriptions: + - Default unspecified enum, should not be used. + - Dataset has not been initialized. + - Dataset is being initialized. + - Dataset has been initialized. + enum: + - STATE_UNSPECIFIED + - UNINITIALIZED + - INITIALIZING + - INITIALIZED satisfiesPzs: - readOnly: true description: Output only. Reserved for future use. - type: boolean - defaultProcessorVersion: - description: The default processor version. - type: string - processEndpoint: - type: string - readOnly: true - description: >- - Output only. Immutable. The http endpoint that can be called to - invoke processing. - processorVersionAliases: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorVersionAlias' - type: array - description: Output only. The processor version aliases. readOnly: true - type: - description: >- - The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. - To get a list of processor types, see FetchProcessorTypes. - type: string - createTime: - description: The time the processor was created. - format: google-datetime - type: string + type: boolean satisfiesPzi: description: Output only. Reserved for future use. readOnly: true type: boolean - state: - enumDescriptions: - - The processor is in an unspecified state. - - >- - The processor is enabled, i.e., has an enabled version which can - currently serve processing requests and all the feature - dependencies have been successfully initialized. - - The processor is disabled. - - >- - The processor is being enabled, will become `ENABLED` if - successful. - - >- - The processor is being disabled, will become `DISABLED` if - successful. - - >- - The processor is being created, will become either `ENABLED` (for - successful creation) or `FAILED` (for failed ones). Once a - processor is in this state, it can then be used for document - processing, but the feature dependencies of the processor might - not be fully created yet. - - >- - The processor failed during creation or initialization of feature - dependencies. The user should delete the processor and recreate - one as all the functionalities of the processor are disabled. - - The processor is being deleted, will be removed if successful. - enum: - - STATE_UNSPECIFIED - - ENABLED - - DISABLED - - ENABLING - - DISABLING - - CREATING - - FAILED - - DELETING - readOnly: true - type: string - description: Output only. The state of the processor. - kmsKeyName: - description: >- - The [KMS key](https://cloud.google.com/security-key-management) used - for encryption and decryption in CMEK scenarios. - type: string - type: object - description: >- - The first-class citizen for Document AI. Each processor defines how to - extract structural information from a document. - GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata: - type: object - properties: - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - description: The long-running operation metadata for the CreateLabelerPool method. - id: GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata - GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata: - properties: - commonMetadata: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' - description: The basic metadata of the long-running operation. - id: GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata - description: >- - The long-running operation metadata for the UndeployProcessorVersion - method. - type: object - GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata: - description: >- - The long-running operation metadata for the DeployProcessorVersion - method. - id: GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata + GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig: + id: GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig + description: Configuration specific to the Cloud Storage-based implementation. type: object properties: - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponse: - description: The response message for the ImportProcessorVersion method. - id: GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponse + gcsPrefix: + description: >- + Required. The Cloud Storage URI (a directory) where the documents + belonging to the dataset must be stored. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta3GcsPrefix' + GoogleCloudDocumentaiV1beta3GcsPrefix: + id: GoogleCloudDocumentaiV1beta3GcsPrefix + description: Specifies all documents on Cloud Storage with a common prefix. + type: object properties: - processorVersion: + gcsUriPrefix: + description: The URI prefix. type: string - description: The destination processor version name. - type: object - GoogleCloudDocumentaiV1EvaluationReference: - id: GoogleCloudDocumentaiV1EvaluationReference + GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig: + id: GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig description: >- - Gives a short summary of an evaluation, and links to the evaluation - itself. + Configuration specific to the Document AI Warehouse-based + implementation. + type: object properties: - aggregateMetricsExact: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1EvaluationMetrics' + collection: description: >- - An aggregate of the statistics for the evaluation with fuzzy - matching off. - evaluation: + Output only. The collection in Document AI Warehouse associated with + the dataset. + readOnly: true type: string - description: The resource name of the evaluation. - aggregateMetrics: + schema: description: >- - An aggregate of the statistics for the evaluation with fuzzy - matching on. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1EvaluationMetrics' - operation: - description: The resource name of the Long Running Operation for the evaluation. + Output only. The schema in Document AI Warehouse associated with the + dataset. + readOnly: true type: string + GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig: + id: GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig + description: Configuration specific to an unmanaged dataset. type: object - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock: - id: >- - GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock - description: Represents a text type block. + properties: {} + GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig: + id: GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig + description: Configuration specific to spanner-based indexing. + type: object + properties: {} + GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata: + id: GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata + description: Metadata of the import document operation. type: object properties: - text: - type: string - description: Text content stored in the block. - blocks: - description: >- - A text block could further have child blocks. Repeated blocks - support further hierarchies and nested blocks. + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + individualImportStatuses: + description: The list of response details of each document. type: array items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock - type: - description: >- - Type of the text in the block. Available options are: `paragraph`, - `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, - `heading-5`, `header`, `footer`. - type: string - GoogleLongrunningListOperationsResponse: - description: The response message for Operations.ListOperations. + #/components/schemas/GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus + importConfigValidationResults: + description: Validation statuses of the batch documents import config. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult + totalDocumentCount: + description: Total number of the documents that are qualified for importing. + type: integer + format: int32 + GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus: + id: >- + GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus + description: The status of each individual document in the import process. + type: object properties: - nextPageToken: - description: The standard List next-page token. + inputGcsSource: + description: The source Cloud Storage URI of the document. type: string - operations: - items: - $ref: '#/components/schemas/GoogleLongrunningOperation' - type: array + status: + description: The status of the importing of the document. + $ref: '#/components/schemas/GoogleRpcStatus' + outputDocumentId: description: >- - A list of operations that matches the specified filter in the - request. - id: GoogleLongrunningListOperationsResponse + The document id of imported document if it was successful, otherwise + empty. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta3DocumentId' + GoogleCloudDocumentaiV1beta3DocumentId: + id: GoogleCloudDocumentaiV1beta3DocumentId + description: Document Identifier. type: object - GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata: - id: GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata properties: - commonMetadata: + gcsManagedDocId: + description: A document id within user-managed Cloud Storage. $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - type: object + #/components/schemas/GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId + unmanagedDocId: + description: A document id within unmanaged dataset. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId + revisionRef: + description: Points to a specific revision of the document if set. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta3RevisionRef' + GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId: + id: GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId description: >- - The long-running operation metadata for the DeleteProcessorVersion - method. - GoogleCloudDocumentaiV1ProcessOptionsIndividualPageSelector: - properties: - pages: - items: - format: int32 - type: integer - type: array - description: Optional. Indices of the pages (starting from 1). + Identifies a document uniquely within the scope of a dataset in the + user-managed Cloud Storage option. type: object - description: A list of individual page numbers. - id: GoogleCloudDocumentaiV1ProcessOptionsIndividualPageSelector - GoogleCloudDocumentaiV1Document: - description: >- - Document represents the canonical document resource in Document AI. It - is an interchange format that provides insights into documents and - allows for collaboration between users and Document AI to iterate and - optimize for quality. properties: - entityRelations: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntityRelation' - description: Placeholder. Relationship among Document.entities. - type: array - text: + gcsUri: + description: Required. The Cloud Storage URI where the actual document is stored. type: string - description: Optional. UTF-8 encoded text in reading order from the document. - pages: - description: Visual page layout for the Document. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPage' - type: array - revisions: - description: Placeholder. Revision history of this document. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentRevision' - type: array - textStyles: - description: Styles for the Document.text. - type: array + cwDocId: + description: Id of the document (indexed) managed by Content Warehouse. deprecated: true - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentStyle' - error: - $ref: '#/components/schemas/GoogleRpcStatus' - description: Any error that occurred while processing this document. - entities: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntity' - description: >- - A list of entities detected on Document.text. For document shards, - entities in this list may cross shard boundaries. - type: array - shardInfo: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentShardInfo' - description: >- - Information about the sharding if this document is sharded part of a - larger document. If the document is not sharded, this message is not - specified. - uri: - description: >- - Optional. Currently supports Google Cloud Storage URI of the form - `gs://bucket_name/object_name`. Object versioning is not supported. - For more information, refer to [Google Cloud Storage Request - URIs](https://cloud.google.com/storage/docs/reference-uris). - type: string - documentLayout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayout' - description: Parsed layout of the document. - content: - type: string - format: byte - description: >- - Optional. Inline document content, represented as a stream of bytes. - Note: As with all `bytes` fields, protobuffers use a pure binary - representation, whereas JSON representations use base64. - chunkedDocument: - description: Document chunked based on chunking config. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocument' - mimeType: - type: string - description: >- - An IANA published [media type (MIME - type)](https://www.iana.org/assignments/media-types/media-types.xhtml). - textChanges: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextChange' - description: >- - Placeholder. A list of text corrections made to Document.text. This - is usually used for annotating corrections to OCR mistakes. Text - changes for a given revision may not overlap with each other. - type: array - id: GoogleCloudDocumentaiV1Document - type: object - GoogleCloudDocumentaiV1DocumentEntityRelation: - id: GoogleCloudDocumentaiV1DocumentEntityRelation - description: Relationship between Entities. - properties: - subjectId: - description: Subject entity id. - type: string - objectId: - description: Object entity id. - type: string - relation: type: string - description: Relationship description. - type: object - GoogleCloudDocumentaiV1CommonOperationMetadata: - id: GoogleCloudDocumentaiV1CommonOperationMetadata + GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId: + id: GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId + description: >- + Identifies a document uniquely within the scope of a dataset in + unmanaged option. type: object properties: - updateTime: - type: string - format: google-datetime - description: The last update time of the operation. - createTime: - description: The creation time of the operation. + docId: + description: Required. The id of the document. type: string - format: google-datetime - resource: - description: A related resource to this operation. + GoogleCloudDocumentaiV1beta3RevisionRef: + id: GoogleCloudDocumentaiV1beta3RevisionRef + description: The revision reference specifies which revision on the document to read. + type: object + properties: + revisionCase: + description: Reads the revision by the predefined case. type: string - state: - description: The state of the operation. enumDescriptions: - - Unspecified state. - - Operation is still running. - - Operation is being cancelled. - - Operation succeeded. - - Operation failed. - - Operation is cancelled. - type: string + - Unspecified case, fall back to read the `LATEST_HUMAN_REVIEW`. + - The latest revision made by a human. + - The latest revision based on timestamp. + - The first (OCR) revision. enum: - - STATE_UNSPECIFIED - - RUNNING - - CANCELLING - - SUCCEEDED - - FAILED - - CANCELLED - stateMessage: - type: string - description: >- - A message providing more details about the current state of - processing. - description: The common metadata for long running operations. - GoogleCloudDocumentaiV1RawDocument: - properties: - mimeType: - description: >- - An IANA MIME type (RFC6838) indicating the nature and format of the - content. - type: string - content: + - REVISION_CASE_UNSPECIFIED + - LATEST_HUMAN_REVIEW + - LATEST_TIMESTAMP + - BASE_OCR_REVISION + revisionId: + description: Reads the revision given by the id. type: string - format: byte - description: Inline document content. - displayName: + latestProcessorVersion: description: >- - The display name of the document, it supports all Unicode characters - except the following: `*`, `?`, `[`, `]`, `%`, `{`, `}`,`'`, `\"`, - `,` `~`, `=` and `:` are reserved. If not specified, a default ID is - generated. + Reads the revision generated by the processor version. The format + takes the full resource name of processor version. + `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` type: string - type: object - description: Payload message of raw document content (bytes). - id: GoogleCloudDocumentaiV1RawDocument - GoogleCloudDocumentaiV1Vertex: - id: GoogleCloudDocumentaiV1Vertex - properties: - x: - format: int32 - description: X coordinate. - type: integer - 'y': - format: int32 - type: integer - description: Y coordinate (starts from the top of the image). + GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult: + id: >- + GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult description: >- - A vertex represents a 2D point in the image. NOTE: the vertex - coordinates are in the same scale as the original image. + The validation status of each import config. Status is set to an error + if there are no documents to import in the `import_config`, or `OK` if + the operation will try to proceed with at least one document. type: object - GoogleRpcStatus: properties: - details: - type: array - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - items: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - message: - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. + inputGcsSource: + description: The source Cloud Storage URI specified in the import config. type: string - code: - format: int32 - type: integer - description: The status code, which should be an enum value of google.rpc.Code. - id: GoogleRpcStatus - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). + status: + description: The validation status of import config. + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudDocumentaiV1beta3ImportDocumentsResponse: + id: GoogleCloudDocumentaiV1beta3ImportDocumentsResponse + description: Response of the import document operation. type: object - GoogleCloudDocumentaiV1ProcessOptions: + properties: {} + GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata: + id: GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata type: object properties: - individualPageSelector: - description: Which pages to process (1-indexed). - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1ProcessOptionsIndividualPageSelector - layoutConfig: - description: >- - Optional. Only applicable to `LAYOUT_PARSER_PROCESSOR`. Returns - error if set on other processor types. + commonMetadata: + description: The basic metadata of the long-running operation. $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1ProcessOptionsLayoutConfig - ocrConfig: - description: >- - Only applicable to `OCR_PROCESSOR` and `FORM_PARSER_PROCESSOR`. - Returns error if set on other processor types. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1OcrConfig' - schemaOverride: - description: >- - Optional. Override the schema of the ProcessorVersion. Will return - an Invalid Argument error if this field is set when the underlying - ProcessorVersion doesn't support schema override. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentSchema' - fromStart: + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + individualBatchDeleteStatuses: + description: The list of response details of each document. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus + totalDocumentCount: + description: Total number of documents deleting from dataset. type: integer - description: >- - Only process certain pages from the start. Process all if the - document has fewer pages. format: int32 - fromEnd: - description: Only process certain pages from the end, same as above. + errorDocumentCount: + description: Total number of documents that failed to be deleted in storage. type: integer format: int32 - description: Options for Process API - id: GoogleCloudDocumentaiV1ProcessOptions - GoogleCloudDocumentaiV1beta3ImportDocumentsResponse: - properties: {} - type: object - description: Response of the import document operation. - id: GoogleCloudDocumentaiV1beta3ImportDocumentsResponse - GoogleCloudDocumentaiV1DocumentPageVisualElement: - properties: - type: - type: string - description: Type of the VisualElement. - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for VisualElement. - detectedLanguages: - type: array - description: A list of detected languages together with confidence. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - id: GoogleCloudDocumentaiV1DocumentPageVisualElement + GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus: + id: >- + GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus + description: The status of each individual document in the batch delete process. type: object - description: >- - Detected non-text visual elements e.g. checkbox, signature etc. on the - page. - GoogleLongrunningOperation: - id: GoogleLongrunningOperation - description: >- - This resource represents a long-running operation that is the result of - a network API call. properties: - metadata: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - done: - type: boolean - description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - error: - $ref: '#/components/schemas/GoogleRpcStatus' - description: >- - The error result of the operation in case of failure or - cancellation. - name: - description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. - type: string - response: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. + documentId: + description: The document id of the document. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta3DocumentId' + status: + description: The status of deleting the document in storage. + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse: + id: GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse + description: Response of the delete documents operation. + type: object + properties: {} + GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata: + id: GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata + description: The long-running operation metadata for the DeleteProcessor method. type: object - GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata: properties: - updateTime: - description: The last update time of the operation. - format: google-datetime - type: string - questionId: - description: The Crowd Compute question ID. - type: string commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata description: The basic metadata of the long-running operation. - createTime: - type: string - format: google-datetime - description: The creation time of the operation. - stateMessage: - type: string - description: >- - A message providing more details about the current state of - processing. For example, the error message if the operation is - failed. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata: + id: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + description: The common metadata for long running operations. + type: object + properties: state: + description: The state of the operation. + type: string enumDescriptions: - Unspecified state. - Operation is still running. @@ -4469,303 +4553,308 @@ components: - SUCCEEDED - FAILED - CANCELLED + stateMessage: + description: >- + A message providing more details about the current state of + processing. type: string - description: Used only when Operation.done is false. + resource: + description: A related resource to this operation. + type: string + createTime: + description: The creation time of the operation. + type: string + format: google-datetime + updateTime: + description: The last update time of the operation. + type: string + format: google-datetime + GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse: + id: GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse + description: >- + Response message for the EnableProcessor method. Intentionally empty + proto for adding fields in future. type: object - id: GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata - description: The long-running operation metadata for the ReviewDocument method. - GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsResponse: - id: GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsResponse + properties: {} + GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata: + id: GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata + description: The long-running operation metadata for the EnableProcessor method. + type: object + properties: + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + GoogleCloudDocumentaiUiv1beta3DisableProcessorResponse: + id: GoogleCloudDocumentaiUiv1beta3DisableProcessorResponse + description: >- + Response message for the DisableProcessor method. Intentionally empty + proto for adding fields in future. type: object properties: {} - description: The response proto of AutoLabelDocuments method. - GoogleCloudDocumentaiV1EvaluationMetrics: - description: Evaluation metrics, either in aggregate or about a specific entity. + GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata: + id: GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata + description: The long-running operation metadata for the DisableProcessor method. + type: object properties: - precision: - format: float - description: The calculated precision. - type: number - groundTruthOccurrencesCount: - type: integer - description: The amount of occurrences in ground truth documents. - format: int32 - f1Score: - format: float - type: number - description: The calculated f1 score. - recall: - description: The calculated recall. - format: float - type: number - truePositivesCount: - description: The amount of true positives. - format: int32 - type: integer - falsePositivesCount: - description: The amount of false positives. - type: integer - format: int32 - predictedOccurrencesCount: - type: integer - description: The amount of occurrences in predicted documents. - format: int32 - predictedDocumentCount: - type: integer - description: The amount of documents with a predicted occurrence. - format: int32 - falseNegativesCount: - type: integer - description: The amount of false negatives. - format: int32 - groundTruthDocumentCount: - type: integer - description: The amount of documents with a ground truth occurrence. - format: int32 - totalDocumentsCount: - type: integer - format: int32 - description: The amount of documents that had an occurrence of this label. - id: GoogleCloudDocumentaiV1EvaluationMetrics + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata: + id: GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata + description: The metadata that represents a processor version being created. type: object - GoogleCloudDocumentaiV1DocumentProvenance: - id: GoogleCloudDocumentaiV1DocumentProvenance properties: - parents: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentProvenanceParent - description: References to the original elements that are replaced. - type: - type: string - enum: - - OPERATION_TYPE_UNSPECIFIED - - ADD - - REMOVE - - UPDATE - - REPLACE - - EVAL_REQUESTED - - EVAL_APPROVED - - EVAL_SKIPPED - enumDescriptions: - - >- - Operation type unspecified. If no operation is specified a - provenance entry is simply used to match against a `parent`. - - Add an element. - - Remove an element identified by `parent`. - - >- - Updates any fields within the given provenance scope of the - message. It overwrites the fields rather than replacing them. Use - this when you want to update a field value of an entity without - also updating all the child properties. - - Currently unused. Replace an element identified by `parent`. - - >- - Deprecated. Request human review for the element identified by - `parent`. - - >- - Deprecated. Element is reviewed and approved at human review, - confidence will be set to 1.0. - - Deprecated. Element is skipped in the validation process. - enumDeprecated: - - false - - false - - false - - false - - false - - true - - true - - true - description: The type of provenance operation. - revision: + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + trainingDatasetValidation: + description: The training dataset validation information. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation + testDatasetValidation: + description: The test dataset validation information. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation + GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation: + id: >- + GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation + description: >- + The dataset validation information. This includes any and all errors + with documents and the dataset. + type: object + properties: + documentErrorCount: + description: The total number of document errors. type: integer - deprecated: true - description: The index of the revision that produced this element. format: int32 - id: - deprecated: true + datasetErrorCount: + description: The total number of dataset errors. type: integer format: int32 + documentErrors: description: >- - The Id of this operation. Needs to be unique within the scope of the - revision. - description: >- - Structure to identify provenance relationships between annotations in - different revisions. + Error information pertaining to specific documents. A maximum of 10 + document errors will be returned. Any document with errors will not + be used throughout training. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + datasetErrors: + description: >- + Error information for the dataset as a whole. A maximum of 10 + dataset errors will be returned. A single dataset error is terminal + for training. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse: + id: GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse + description: The response for TrainProcessorVersion. type: object - GoogleCloudDocumentaiV1ProcessOptionsLayoutConfigChunkingConfig: - id: GoogleCloudDocumentaiV1ProcessOptionsLayoutConfigChunkingConfig properties: - includeAncestorHeadings: - description: >- - Optional. Whether or not to include ancestor headings when - splitting. - type: boolean - chunkSize: - type: integer - format: int32 - description: >- - Optional. The chunk sizes to use when splitting documents, in order - of level. + processorVersion: + description: The resource name of the processor version produced by training. + type: string + GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata: + id: GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata + description: The long-running operation metadata for the CreateLabelerPool method. type: object - description: Serving config for chunking. - GoogleCloudDocumentaiV1beta3Dataset: properties: - state: - description: Required. State of the dataset. Ignored when updating dataset. - enum: - - STATE_UNSPECIFIED - - UNINITIALIZED - - INITIALIZING - - INITIALIZED - enumDescriptions: - - Default unspecified enum, should not be used. - - Dataset has not been initialized. - - Dataset is being initialized. - - Dataset has been initialized. - type: string - gcsManagedConfig: + commonMetadata: + description: The basic metadata of the long-running operation. $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig - description: >- - Optional. User-managed Cloud Storage dataset configuration. Use this - configuration if the dataset documents are stored under a - user-managed Cloud Storage location. - unmanagedDatasetConfig: - description: >- - Optional. Unmanaged dataset configuration. Use this configuration if - the dataset documents are managed by the document service internally - (not user-managed). + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata: + id: GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata + description: The long-running operation metadata for UpdateLabelerPool. + type: object + properties: + commonMetadata: + description: The basic metadata of the long-running operation. $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig - name: - type: string - description: >- - Dataset resource name. Format: - `projects/{project}/locations/{location}/processors/{processor}/dataset` - documentWarehouseConfig: - deprecated: true + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata: + id: GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata + description: The long-running operation metadata for DeleteLabelerPool. + type: object + properties: + commonMetadata: + description: The basic metadata of the long-running operation. $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig - description: >- - Optional. Deprecated. Warehouse-based dataset configuration is not - supported. - spannerIndexingConfig: - description: >- - Optional. A lightweight indexing source with low latency and high - reliability, but lacking advanced features like CMEK and - content-based search. + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata: + id: GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata + description: >- + The long-running operation metadata for updating the human review + configuration. + type: object + properties: + commonMetadata: + description: The basic metadata of the long-running operation. $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig - satisfiesPzi: - type: boolean - readOnly: true - description: Output only. Reserved for future use. - satisfiesPzs: - type: boolean - description: Output only. Reserved for future use. - readOnly: true - id: GoogleCloudDocumentaiV1beta3Dataset + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata: + id: GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata description: >- - A singleton resource under a Processor which configures a collection of - documents. + The long-running operation metadata for the DeleteProcessorVersion + method. type: object - GoogleCloudDocumentaiV1DeployProcessorVersionResponse: - id: GoogleCloudDocumentaiV1DeployProcessorVersionResponse + properties: + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata: + id: GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata + description: >- + The long-running operation metadata for the DeployProcessorVersion + method. + type: object + properties: + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionResponse: + id: GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionResponse description: Response message for the DeployProcessorVersion method. type: object properties: {} - GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument: + GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata: + id: GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata + description: >- + The long-running operation metadata for the UndeployProcessorVersion + method. type: object properties: - documentId: - type: string - description: An internal identifier for document. - id: GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument - GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadata: + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse: + id: GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse + description: Response message for the UndeployProcessorVersion method. + type: object + properties: {} + GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata: + id: GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata + description: Metadata of the EvaluateProcessorVersion method. + type: object properties: commonMetadata: + description: The basic metadata of the long-running operation. $ref: >- #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse: + id: GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse + description: Response of the EvaluateProcessorVersion method. + type: object + properties: + evaluation: + description: The resource name of the created evaluation. + type: string + GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata: + id: GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata + description: >- + The long-running operation metadata for the SetDefaultProcessorVersion + method. + type: object + properties: + commonMetadata: description: The basic metadata of the long-running operation. - individualBatchUpdateStatuses: - description: The list of response details of each document. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataIndividualBatchUpdateStatus - id: GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadata + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse: + id: GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse + description: Response message for the SetDefaultProcessorVersion method. type: object - GoogleCloudDocumentaiV1DocumentPageImageQualityScores: - id: GoogleCloudDocumentaiV1DocumentPageImageQualityScores + properties: {} + GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionMetadata: + id: GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionMetadata + description: Metadata message associated with the ExportProcessorVersion operation. type: object properties: - qualityScore: - description: >- - The overall quality score. Range `[0, 1]` where `1` is perfect - quality. - type: number - format: float - detectedDefects: - type: array - description: A list of detected defects. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect - description: Image quality scores for the page image. - GoogleCloudDocumentaiV1DocumentRevision: - description: Contains past or forward revisions of this document. + commonMetadata: + description: The common metadata about the operation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse: + id: GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse + description: Response message associated with the ExportProcessorVersion operation. type: object - id: GoogleCloudDocumentaiV1DocumentRevision properties: - id: - type: string - description: >- - Id of the revision, internally generated by doc proto storage. - Unique within the context of the document. - createTime: - format: google-datetime - description: >- - The time that the revision was created, internally generated by doc - proto storage at the time of create. - type: string - agent: - description: >- - If the change was made by a person specify the name or id of that - person. + gcsUri: + description: The Cloud Storage URI containing the output artifacts. type: string - processor: + GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata: + id: GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata + description: >- + The long-running operation metadata for the ImportProcessorVersion + method. + type: object + properties: + commonMetadata: + description: The basic metadata for the long-running operation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponse: + id: GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponse + description: The response message for the ImportProcessorVersion method. + type: object + properties: + processorVersion: + description: The destination processor version name. type: string - description: >- - If the annotation was made by processor identify the processor by - its resource name. - humanReview: + GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata: + id: GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata + type: object + properties: + commonMetadata: + description: The basic metadata of the long-running operation. $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentRevisionHumanReview - description: Human Review information of this revision. - parentIds: - items: - type: string - description: >- - The revisions that this revision is based on. Must include all the - ids that have anything to do with this revision - eg. there are - `provenance.parent.revision` fields that index into this field. + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse: + id: GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse + description: Response of the import document operation. + type: object + properties: {} + GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata: + id: GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata + description: Metadata of the import document operation. + type: object + properties: + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + individualImportStatuses: + description: The list of response details of each document. type: array - parent: items: - format: int32 - type: integer - description: >- - The revisions that this revision is based on. This can include one - or more parent (when documents are merged.) This field represents - the index into the `revisions` field. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus + importConfigValidationResults: + description: Validation statuses of the batch documents import config. type: array - deprecated: true + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult + totalDocumentCount: + description: Total number of the documents that are qualified for importing. + type: integer + format: int32 GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus: - description: The status of each individual document in the import process. id: >- GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus + description: The status of each individual document in the import process. + type: object properties: + inputGcsSource: + description: The source Cloud Storage URI of the document. + type: string status: description: The status of the importing of the document. $ref: '#/components/schemas/GoogleRpcStatus' @@ -4774,329 +4863,445 @@ components: The output_gcs_destination of the processed document if it was successful, otherwise empty. type: string - inputGcsSource: - type: string - description: The source Cloud Storage URI of the document. outputDocumentId: description: >- The document id of imported document if it was successful, otherwise empty. $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' + GoogleCloudDocumentaiUiv1beta3DocumentId: + id: GoogleCloudDocumentaiUiv1beta3DocumentId + description: Document Identifier. type: object - GoogleCloudDocumentaiV1DocumentPageDetectedLanguage: properties: - confidence: - description: Confidence of detected language. Range `[0, 1]`. - format: float - type: number - languageCode: - type: string - description: >- - The [BCP-47 language - code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), - such as `en-US` or `sr-Latn`. - type: object - id: GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - description: Detected language for a structural component. - GoogleCloudDocumentaiV1DocumentPageParagraph: + gcsManagedDocId: + description: A document id within user-managed Cloud Storage. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId + unmanagedDocId: + description: A document id within unmanaged dataset. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId + revisionRef: + description: Points to a specific revision of the document if set. + $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3RevisionRef' + GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId: + id: GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId + description: >- + Identifies a document uniquely within the scope of a dataset in the + user-managed Cloud Storage option. type: object properties: - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for Paragraph. - detectedLanguages: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - description: A list of detected languages together with confidence. - provenance: - description: The history of this annotation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + gcsUri: + description: Required. The Cloud Storage URI where the actual document is stored. + type: string + cwDocId: + description: Id of the document (indexed) managed by Content Warehouse. deprecated: true - description: A collection of lines that a human would perceive as a paragraph. - id: GoogleCloudDocumentaiV1DocumentPageParagraph - GoogleCloudDocumentaiV1OcrConfigHints: + type: string + GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId: + id: GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId + description: >- + Identifies a document uniquely within the scope of a dataset in + unmanaged option. type: object - id: GoogleCloudDocumentaiV1OcrConfigHints - description: Hints for OCR Engine properties: - languageHints: - items: - type: string + docId: + description: Required. The id of the document. + type: string + GoogleCloudDocumentaiUiv1beta3RevisionRef: + id: GoogleCloudDocumentaiUiv1beta3RevisionRef + description: The revision reference specifies which revision on the document to read. + type: object + properties: + revisionCase: + description: Reads the revision by the predefined case. + type: string + enumDescriptions: + - Unspecified case, fall back to read the `LATEST_HUMAN_REVIEW`. + - The latest revision made by a human. + - The latest revision based on timestamp. + - The first (OCR) revision. + enum: + - REVISION_CASE_UNSPECIFIED + - LATEST_HUMAN_REVIEW + - LATEST_TIMESTAMP + - BASE_OCR_REVISION + revisionId: + description: Reads the revision given by the id. + type: string + latestProcessorVersion: description: >- - List of BCP-47 language codes to use for OCR. In most cases, not - specifying it yields the best results since it enables automatic - language detection. For languages based on the Latin alphabet, - setting hints is not needed. In rare cases, when the language of the - text in the image is known, setting a hint will help get better - results (although it will be a significant hindrance if the hint is - wrong). - type: array - GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata: - id: GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata - description: The long-running operation metadata for DeleteLabelerPool. + Reads the revision generated by the processor version. The format + takes the full resource name of processor version. + `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` + type: string + GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult: + id: >- + GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult + description: >- + The validation status of each import config. Status is set to an error + if there are no documents to import in the `import_config`, or `OK` if + the operation will try to proceed with at least one document. type: object properties: - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata: + inputGcsSource: + description: The source Cloud Storage URI specified in the import config. + type: string + status: + description: The validation status of import config. + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsResponse: + id: GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsResponse + description: Response of the batch move documents operation. + type: object + properties: {} + GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadata: + id: GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadata type: object properties: commonMetadata: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' description: The basic metadata of the long-running operation. - id: GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata - description: >- - The long-running operation metadata for the DeleteProcessorVersion - method. - GoogleCloudDocumentaiV1DocumentRevisionHumanReview: - description: Human Review information of the document. - type: object - id: GoogleCloudDocumentaiV1DocumentRevisionHumanReview - properties: - stateMessage: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + individualBatchMoveStatuses: + description: The list of response details of each document. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus + destDatasetType: + description: The destination dataset split type. + deprecated: true type: string - description: >- - A message providing more details about the current state of - processing. For example, the rejection reason when the state is - `rejected`. - state: + enumDescriptions: + - Default value if the enum is not set. + - Identifies the train documents. + - Identifies the test documents. + - Identifies the unassigned documents. + enum: + - DATASET_SPLIT_TYPE_UNSPECIFIED + - DATASET_SPLIT_TRAIN + - DATASET_SPLIT_TEST + - DATASET_SPLIT_UNASSIGNED + destSplitType: + description: The destination dataset split type. type: string - description: Human review state. e.g. `requested`, `succeeded`, `rejected`. - GoogleCloudDocumentaiV1DocumentPageTableTableRow: + enumDescriptions: + - Default value if the enum is not set. + - Identifies the train documents. + - Identifies the test documents. + - Identifies the unassigned documents. + enum: + - DATASET_SPLIT_TYPE_UNSPECIFIED + - DATASET_SPLIT_TRAIN + - DATASET_SPLIT_TEST + - DATASET_SPLIT_UNASSIGNED + GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus: + id: >- + GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus + description: The status of each individual document in the batch move process. type: object - description: A row of table cells. - id: GoogleCloudDocumentaiV1DocumentPageTableTableRow properties: - cells: + documentId: + description: The document id of the document. + $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' + status: + description: The status of moving the document. + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsResponse: + id: GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsResponse + description: Response of the batch update documents operation. + type: object + properties: {} + GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadata: + id: GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadata + type: object + properties: + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + individualBatchUpdateStatuses: + description: The list of response details of each document. type: array items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableCell - description: Cells that make up this row. - GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult: + #/components/schemas/GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataIndividualBatchUpdateStatus + GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataIndividualBatchUpdateStatus: id: >- - GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult - description: >- - The validation status of each import config. Status is set to an error - if there are no documents to import in the `import_config`, or `OK` if - the operation will try to proceed with at least one document. + GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataIndividualBatchUpdateStatus + description: The status of each individual document in the batch update process. + type: object properties: - inputGcsSource: - type: string - description: The source Cloud Storage URI specified in the import config. + documentId: + description: The document id of the document. + $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' status: + description: The status of updating the document in storage. $ref: '#/components/schemas/GoogleRpcStatus' - description: The validation status of import config. + GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsResponse: + id: GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsResponse + description: Response of the delete documents operation. type: object - GoogleCloudDocumentaiV1beta3DisableProcessorResponse: - description: >- - Response message for the DisableProcessor method. Intentionally empty - proto for adding fields in future. - id: GoogleCloudDocumentaiV1beta3DisableProcessorResponse properties: {} + GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata: + id: GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata type: object - GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata: - description: The long-running operation metadata for the EnableProcessor method. properties: commonMetadata: + description: The basic metadata of the long-running operation. $ref: >- #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - type: object - id: GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata - GoogleCloudDocumentaiV1ReviewDocumentRequest: - description: Request message for the ReviewDocument method. - properties: - enableSchemaValidation: - description: >- - Whether the validation should be performed on the ad-hoc review - request. - type: boolean - inlineDocument: - description: An inline document proto. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Document' - priority: - enum: - - DEFAULT - - URGENT - description: The priority of the human review task. - type: string - enumDescriptions: - - The default priority level. - - >- - The urgent priority level. The labeling manager should allocate - labeler resource to the urgent task queue to respect this priority - level. - documentSchema: - description: The document schema of the human review task. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentSchema' - type: object - id: GoogleCloudDocumentaiV1ReviewDocumentRequest - GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataIndividualBatchUpdateStatus: + individualBatchDeleteStatuses: + description: The list of response details of each document. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus + totalDocumentCount: + description: Total number of documents deleting from dataset. + type: integer + format: int32 + errorDocumentCount: + description: Total number of documents that failed to be deleted in storage. + type: integer + format: int32 + GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus: id: >- - GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataIndividualBatchUpdateStatus + GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus + description: The status of each individual document in the batch delete process. type: object - description: The status of each individual document in the batch update process. properties: documentId: description: The document id of the document. $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' status: - description: The status of updating the document in storage. + description: The status of deleting the document in storage. $ref: '#/components/schemas/GoogleRpcStatus' - GoogleCloudDocumentaiV1DeployProcessorVersionRequest: - id: GoogleCloudDocumentaiV1DeployProcessorVersionRequest - description: Request message for the DeployProcessorVersion method. + GoogleCloudDocumentaiUiv1beta3ResyncDatasetResponse: + id: GoogleCloudDocumentaiUiv1beta3ResyncDatasetResponse + description: The response proto of ResyncDataset method. type: object properties: {} - GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata: + GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata: + id: GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata + description: The metadata proto of `ResyncDataset` method. type: object - description: >- - The long-running operation metadata for the SetDefaultProcessorVersion - method. - id: GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata properties: commonMetadata: description: The basic metadata of the long-running operation. $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - GoogleCloudDocumentaiV1DocumentStyleFontSize: - description: Font size with unit. + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + individualDocumentResyncStatuses: + description: >- + The list of document resync statuses. The same document could have + multiple `individual_document_resync_statuses` if it has multiple + inconsistencies. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus + datasetResyncStatuses: + description: >- + The list of dataset resync statuses. Not checked when + ResyncDatasetRequest.dataset_documents is specified. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus + GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus: + id: >- + GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus + description: Resync status for each document per inconsistency type. type: object properties: - unit: + documentId: + description: The document identifier. + $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' + documentInconsistencyType: + description: The type of document inconsistency. + type: string + enumDescriptions: + - Default value. + - The document proto is invalid. + - Indexed docproto metadata is mismatched. + - The page image or thumbnails are missing. + enum: + - DOCUMENT_INCONSISTENCY_TYPE_UNSPECIFIED + - DOCUMENT_INCONSISTENCY_TYPE_INVALID_DOCPROTO + - DOCUMENT_INCONSISTENCY_TYPE_MISMATCHED_METADATA + - DOCUMENT_INCONSISTENCY_TYPE_NO_PAGE_IMAGE + status: + description: >- + The status of resyncing the document with regards to the detected + inconsistency. Empty if ResyncDatasetRequest.validate_only is + `true`. + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus: + id: GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus + description: Resync status against inconsistency types on the dataset level. + type: object + properties: + datasetInconsistencyType: + description: The type of the inconsistency of the dataset. type: string + enumDescriptions: + - Default value. + - The marker file under the dataset folder is not found. + enum: + - DATASET_INCONSISTENCY_TYPE_UNSPECIFIED + - DATASET_INCONSISTENCY_TYPE_NO_STORAGE_MARKER + status: description: >- - Unit for the font size. Follows CSS naming (such as `in`, `px`, and - `pt`). - size: - description: Font size for the text. - type: number - format: float - id: GoogleCloudDocumentaiV1DocumentStyleFontSize - GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse: - description: Response of the import document operation. + The status of resyncing the dataset with regards to the detected + inconsistency. Empty if ResyncDatasetRequest.validate_only is + `true`. + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudDocumentaiUiv1beta3ExportDocumentsResponse: + id: GoogleCloudDocumentaiUiv1beta3ExportDocumentsResponse + description: The response proto of ExportDocuments method. type: object properties: {} - id: GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse - GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse: - properties: {} + GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata: + id: GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata + description: Metadata of the batch export documents operation. type: object - id: GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse - description: Response of the delete documents operation. - GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata: properties: - stateMessage: - type: string + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + individualExportStatuses: + description: The list of response details of each document. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus + splitExportStats: + description: The list of statistics for each dataset split type. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat + GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus: + id: >- + GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus + description: The status of each individual document in the export process. + type: object + properties: + documentId: + description: The path to source docproto of the document. + $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' + status: + description: The status of the exporting of the document. + $ref: '#/components/schemas/GoogleRpcStatus' + outputGcsDestination: description: >- - A message providing more details about the current state of - processing. - updateTime: - format: google-datetime - description: The last update time of the operation. - type: string - createTime: - type: string - description: The creation time of the operation. - format: google-datetime - resource: - description: A related resource to this operation. + The output_gcs_destination of the exported document if it was + successful, otherwise empty. type: string - state: - description: The state of the operation. - enum: - - STATE_UNSPECIFIED - - RUNNING - - CANCELLING - - SUCCEEDED - - FAILED - - CANCELLED + GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat: + id: GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat + description: The statistic representing a dataset split type for this export. + type: object + properties: + splitType: + description: The dataset split type. type: string enumDescriptions: - - Unspecified state. - - Operation is still running. - - Operation is being cancelled. - - Operation succeeded. - - Operation failed. - - Operation is cancelled. - id: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + - Default value if the enum is not set. + - Identifies the train documents. + - Identifies the test documents. + - Identifies the unassigned documents. + enum: + - DATASET_SPLIT_TYPE_UNSPECIFIED + - DATASET_SPLIT_TRAIN + - DATASET_SPLIT_TEST + - DATASET_SPLIT_UNASSIGNED + totalDocumentCount: + description: >- + Total number of documents with the given dataset split type to be + exported. + type: integer + format: int32 + GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsResponse: + id: GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsResponse + description: The response proto of AutoLabelDocuments method. + type: object + properties: {} + GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata: + id: GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata + description: Metadata of the auto-labeling documents operation. type: object - description: The common metadata for long running operations. - GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata: properties: commonMetadata: description: The basic metadata of the long-running operation. $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - type: object - description: Metadata of the EvaluateProcessorVersion method. - id: GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata - GoogleCloudDocumentaiV1DocumentPageMatrix: - id: GoogleCloudDocumentaiV1DocumentPageMatrix - description: >- - Representation for transformation matrix, intended to be compatible and - used with OpenCV format for image manipulation. - properties: - data: - format: byte - description: The matrix data. - type: string - type: + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + individualAutoLabelStatuses: description: >- - This encodes information about what data type the matrix uses. For - example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of - OpenCV primitive data types, please refer to - https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html - type: integer - format: int32 - rows: - format: int32 - description: Number of rows in the matrix. - type: integer - cols: - description: Number of columns in the matrix. + The list of individual auto-labeling statuses of the dataset + documents. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadataIndividualAutoLabelStatus + totalDocumentCount: + description: Total number of the auto-labeling documents. type: integer format: int32 + GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadataIndividualAutoLabelStatus: + id: >- + GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadataIndividualAutoLabelStatus + description: The status of individual documents in the auto-labeling process. + type: object + properties: + status: + description: The status of the document auto-labeling. + $ref: '#/components/schemas/GoogleRpcStatus' + documentId: + description: >- + The document id of the auto-labeled document. This will replace the + gcs_uri. + $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' + GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse: + id: GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse + description: Response of the sample documents operation. + type: object + properties: + selectedDocuments: + description: The result of the sampling process. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument + sampleTestStatus: + description: The status of sampling documents in test split. + $ref: '#/components/schemas/GoogleRpcStatus' + sampleTrainingStatus: + description: The status of sampling documents in training split. + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument: + id: GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument + type: object + properties: + documentId: + description: An internal identifier for document. + type: string + GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata: + id: GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata + description: Metadata of the sample documents operation. type: object + properties: + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata parameters: - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean - 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 - _.xgafv: - description: V1 error format. - in: query - name: $.xgafv - schema: - type: string - enum: - - '1' - - '2' - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + access_token: + description: OAuth access token. in: query - name: uploadType + name: access_token schema: type: string alt: @@ -5109,24 +5314,39 @@ components: - json - media - proto + 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 - callback: - description: JSONP + 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: callback + name: key schema: type: string - access_token: - description: OAuth access token. + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: access_token + 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 @@ -5136,24 +5356,33 @@ components: name: quotaUser schema: type: string - oauth_token: - description: OAuth 2.0 token for the current user. + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: oauth_token + name: upload_protocol + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv schema: type: string + enum: + - '1' + - '2' x-stackQL-resources: operations: id: google.documentai.operations name: operations title: Operations methods: - operations_delete: - operation: - $ref: '#/paths/~1v1~1operations~1{operationsId}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' projects_operations_get: operation: $ref: >- @@ -5169,6 +5398,13 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations + projects_locations_operations_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' projects_locations_operations_cancel: operation: $ref: >- @@ -5176,10 +5412,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_locations_operations_get: + operations_delete: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/get + $ref: '#/paths/~1v1~1operations~1{operationsId}/delete' response: mediaType: application/json openAPIDocKey: '200' @@ -5197,69 +5432,69 @@ components: delete: - $ref: >- #/components/x-stackQL-resources/operations/methods/operations_delete - locations: - id: google.documentai.locations - name: locations - title: Locations + processor_types: + id: google.documentai.processor_types + name: processor_types + title: Processor_types methods: - projects_locations_get: + projects_locations_fetch_processor_types: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:fetchProcessorTypes/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_list: + projects_locations_processor_types_list: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processorTypes/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.processorTypes + projects_locations_processor_types_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processorTypes~1{processorTypesId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.locations sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/locations/methods/projects_locations_get + #/components/x-stackQL-resources/processor_types/methods/projects_locations_processor_types_get - $ref: >- - #/components/x-stackQL-resources/locations/methods/projects_locations_list + #/components/x-stackQL-resources/processor_types/methods/projects_locations_fetch_processor_types + - $ref: >- + #/components/x-stackQL-resources/processor_types/methods/projects_locations_processor_types_list insert: [] update: [] replace: [] delete: [] - processor_types: - id: google.documentai.processor_types - name: processor_types - title: Processor_types + locations: + id: google.documentai.locations + name: locations + title: Locations methods: - projects_locations_fetch_processor_types: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:fetchProcessorTypes/get - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_processor_types_get: + projects_locations_list: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processorTypes~1{processorTypesId}/get + $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processor_types_list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processorTypes/get + objectKey: $.locations + projects_locations_get: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.processorTypes sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/processor_types/methods/projects_locations_processor_types_get - - $ref: >- - #/components/x-stackQL-resources/processor_types/methods/projects_locations_fetch_processor_types + #/components/x-stackQL-resources/locations/methods/projects_locations_get - $ref: >- - #/components/x-stackQL-resources/processor_types/methods/projects_locations_processor_types_list + #/components/x-stackQL-resources/locations/methods/projects_locations_list insert: [] update: [] replace: [] @@ -5269,67 +5504,67 @@ components: name: processors title: Processors methods: - projects_locations_processors_disable: + projects_locations_processors_process: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}:disable/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}:process/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_enable: + projects_locations_processors_batch_process: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}:enable/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}:batchProcess/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_delete: + projects_locations_processors_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_get: + objectKey: $.processors + projects_locations_processors_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_batch_process: + projects_locations_processors_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}:batchProcess/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_list: + projects_locations_processors_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.processors - projects_locations_processors_create: + projects_locations_processors_enable: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}:enable/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_set_default_processor_version: + projects_locations_processors_disable: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}:setDefaultProcessorVersion/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}:disable/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_process: + projects_locations_processors_set_default_processor_version: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}:process/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}:setDefaultProcessorVersion/post response: mediaType: application/json openAPIDocKey: '200' @@ -5347,59 +5582,32 @@ components: delete: - $ref: >- #/components/x-stackQL-resources/processors/methods/projects_locations_processors_delete - human_review_config: - id: google.documentai.human_review_config - name: human_review_config - title: Human_review_config + processor_versions: + id: google.documentai.processor_versions + name: processor_versions + title: Processor_versions methods: - projects_locations_processors_human_review_config_review_document: + projects_locations_processors_processor_versions_process: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1humanReviewConfig:reviewDocument/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}:process/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: [] - evaluations: - id: google.documentai.evaluations - name: evaluations - title: Evaluations - methods: - projects_locations_processors_processor_versions_evaluations_list: + projects_locations_processors_processor_versions_batch_process: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}~1evaluations/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}:batchProcess/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.evaluations - projects_locations_processors_processor_versions_evaluations_get: + projects_locations_processors_processor_versions_train: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}~1evaluations~1{evaluationsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions:train/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/evaluations/methods/projects_locations_processors_processor_versions_evaluations_get - - $ref: >- - #/components/x-stackQL-resources/evaluations/methods/projects_locations_processors_processor_versions_evaluations_list - insert: [] - update: [] - replace: [] - delete: [] - processor_versions: - id: google.documentai.processor_versions - name: processor_versions - title: Processor_versions - methods: projects_locations_processors_processor_versions_get: operation: $ref: >- @@ -5414,109 +5622,109 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_processor_versions_deploy: + projects_locations_processors_processor_versions_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}:deploy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_processor_versions_undeploy: + objectKey: $.processorVersions + projects_locations_processors_processor_versions_deploy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}:undeploy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}:deploy/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_processor_versions_train: + projects_locations_processors_processor_versions_undeploy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions:train/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}:undeploy/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_processor_versions_batch_process: + projects_locations_processors_processor_versions_evaluate_processor_version: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}:batchProcess/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}:evaluateProcessorVersion/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_processor_versions_list: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/processor_versions/methods/projects_locations_processors_processor_versions_get + - $ref: >- + #/components/x-stackQL-resources/processor_versions/methods/projects_locations_processors_processor_versions_list + insert: [] + update: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/processor_versions/methods/projects_locations_processors_processor_versions_delete + evaluations: + id: google.documentai.evaluations + name: evaluations + title: Evaluations + methods: + projects_locations_processors_processor_versions_evaluations_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}~1evaluations~1{evaluationsId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.processorVersions - projects_locations_processors_processor_versions_process: + projects_locations_processors_processor_versions_evaluations_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}:process/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}~1evaluations/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_processor_versions_evaluate_processor_version: + objectKey: $.evaluations + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/evaluations/methods/projects_locations_processors_processor_versions_evaluations_get + - $ref: >- + #/components/x-stackQL-resources/evaluations/methods/projects_locations_processors_processor_versions_evaluations_list + insert: [] + update: [] + replace: [] + delete: [] + human_review_config: + id: google.documentai.human_review_config + name: human_review_config + title: Human_review_config + methods: + projects_locations_processors_human_review_config_review_document: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}:evaluateProcessorVersion/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1humanReviewConfig:reviewDocument/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/processor_versions/methods/projects_locations_processors_processor_versions_get - - $ref: >- - #/components/x-stackQL-resources/processor_versions/methods/projects_locations_processors_processor_versions_list + select: [] insert: [] update: [] replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/processor_versions/methods/projects_locations_processors_processor_versions_delete + delete: [] paths: - /v1/operations/{operationsId}: + /v1/projects/{projectsId}/operations/{operationsId}: parameters: &ref_1 - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - delete: - description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: documentai.operations.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' - parameters: - - in: path - name: operationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/operations/{operationsId}: - parameters: *ref_1 + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -5546,11 +5754,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}: + /v1/projects/{projectsId}/locations/{locationsId}:fetchProcessorTypes: parameters: *ref_1 get: - description: Gets information about a location. - operationId: documentai.projects.locations.get + description: >- + Fetches processor types. Note that we don't use ListProcessorTypes here, + because it isn't paginated. + operationId: documentai.projects.locations.fetchProcessorTypes security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5562,7 +5772,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudLocationLocation' + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1FetchProcessorTypesResponse parameters: - in: path name: projectsId @@ -5598,7 +5809,7 @@ paths: schema: type: string - in: query - name: pageToken + name: filter schema: type: string - in: query @@ -5607,16 +5818,18 @@ paths: type: integer format: int32 - in: query - name: filter + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}:fetchProcessorTypes: + - in: query + name: extraLocationTypes + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: - description: >- - Fetches processor types. Note that we don't use ListProcessorTypes here, - because it isn't paginated. - operationId: documentai.projects.locations.fetchProcessorTypes + description: Gets information about a location. + operationId: documentai.projects.locations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5628,8 +5841,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1FetchProcessorTypesResponse + $ref: '#/components/schemas/GoogleCloudLocationLocation' parameters: - in: path name: projectsId @@ -5641,17 +5853,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:disable: + /v1/projects/{projectsId}/locations/{locationsId}/operations: parameters: *ref_1 - post: - description: Disables a processor - operationId: documentai.projects.locations.processors.disable - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DisableProcessorRequest + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: documentai.projects.locations.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5663,7 +5871,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -5675,22 +5883,27 @@ paths: required: true schema: type: string - - in: path - name: processorsId - required: true + - in: query + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:enable: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: parameters: *ref_1 - post: - description: Enables a processor - operationId: documentai.projects.locations.processors.enable - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1EnableProcessorRequest + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: documentai.projects.locations.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5715,17 +5928,24 @@ paths: schema: type: string - in: path - name: processorsId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}: + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: parameters: *ref_1 - delete: + post: description: >- - Deletes the processor, unloads all deployed model artifacts if it was - enabled and then deletes all artifacts associated with this processor. - operationId: documentai.projects.locations.processors.delete + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + `1`, corresponding to `Code.CANCELLED`. + operationId: documentai.projects.locations.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5737,7 +5957,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -5750,13 +5970,20 @@ paths: schema: type: string - in: path - name: processorsId + name: operationsId required: true schema: type: string - get: - description: Gets a processor detail. - operationId: documentai.projects.locations.processors.get + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:process: + parameters: *ref_1 + post: + description: Processes a single document. + operationId: documentai.projects.locations.processors.process + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5768,7 +5995,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Processor' + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessResponse' parameters: - in: path name: projectsId @@ -5854,15 +6081,15 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - in: query name: pageSize schema: type: integer format: int32 + - in: query + name: pageToken + schema: + type: string post: description: >- Creates a processor from the ProcessorType provided. The processor will @@ -5900,19 +6127,83 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:setDefaultProcessorVersion: + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}: parameters: *ref_1 - post: + get: + description: Gets a processor detail. + operationId: documentai.projects.locations.processors.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Processor' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: processorsId + required: true + schema: + type: string + delete: description: >- - Set the default (active) version of a Processor that will be used in - ProcessDocument and BatchProcessDocuments. - operationId: documentai.projects.locations.processors.setDefaultProcessorVersion + Deletes the processor, unloads all deployed model artifacts if it was + enabled and then deletes all artifacts associated with this processor. + operationId: documentai.projects.locations.processors.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: processorsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:enable: + parameters: *ref_1 + post: + description: Enables a processor + operationId: documentai.projects.locations.processors.enable requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest + #/components/schemas/GoogleCloudDocumentaiV1EnableProcessorRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5941,16 +6232,17 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:process: + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:disable: parameters: *ref_1 post: - description: Processes a single document. - operationId: documentai.projects.locations.processors.process + description: Disables a processor + operationId: documentai.projects.locations.processors.disable requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessRequest' + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DisableProcessorRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5962,7 +6254,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -5979,20 +6271,19 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/humanReviewConfig:reviewDocument: + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:setDefaultProcessorVersion: parameters: *ref_1 post: description: >- - Send a document for Human Review. The input document should be processed - by the specified processor. - operationId: >- - documentai.projects.locations.processors.humanReviewConfig.reviewDocument + Set the default (active) version of a Processor that will be used in + ProcessDocument and BatchProcessDocuments. + operationId: documentai.projects.locations.processors.setDefaultProcessorVersion requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1ReviewDocumentRequest + #/components/schemas/GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6021,12 +6312,16 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}/evaluations: + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}:process: parameters: *ref_1 - get: - description: Retrieves a set of evaluations for a given processor version. - operationId: >- - documentai.projects.locations.processors.processorVersions.evaluations.list + post: + description: Processes a single document. + operationId: documentai.projects.locations.processors.processorVersions.process + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6038,8 +6333,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1ListEvaluationsResponse + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessResponse' parameters: - in: path name: projectsId @@ -6061,21 +6355,18 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}/evaluations/{evaluationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}:batchProcess: parameters: *ref_1 - get: - description: Retrieves a specific evaluation. - operationId: >- - documentai.projects.locations.processors.processorVersions.evaluations.get + post: + description: >- + LRO endpoint to batch process many documents. The output is written to + Cloud Storage as JSON in the [Document] format. + operationId: documentai.projects.locations.processors.processorVersions.batchProcess + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1BatchProcessRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6087,7 +6378,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Evaluation' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -6109,8 +6400,44 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions:train: + parameters: *ref_1 + post: + description: >- + Trains a new processor version. Operation metadata is returned as + TrainProcessorVersionMetadata. + operationId: documentai.projects.locations.processors.processorVersions.train + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string - in: path - name: evaluationsId + name: processorsId required: true schema: type: string @@ -6190,17 +6517,11 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}:deploy: + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions: parameters: *ref_1 - post: - description: Deploys the processor version. - operationId: documentai.projects.locations.processors.processorVersions.deploy - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DeployProcessorVersionRequest + get: + description: Lists all versions of a processor. + operationId: documentai.projects.locations.processors.processorVersions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6212,7 +6533,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1ListProcessorVersionsResponse parameters: - in: path name: projectsId @@ -6229,22 +6551,26 @@ paths: required: true schema: type: string - - in: path - name: processorVersionsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}:undeploy: + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}:deploy: parameters: *ref_1 post: - description: Undeploys the processor version. - operationId: documentai.projects.locations.processors.processorVersions.undeploy + description: Deploys the processor version. + operationId: documentai.projects.locations.processors.processorVersions.deploy requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1UndeployProcessorVersionRequest + #/components/schemas/GoogleCloudDocumentaiV1DeployProcessorVersionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6278,19 +6604,17 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions:train: + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}:undeploy: parameters: *ref_1 post: - description: >- - Trains a new processor version. Operation metadata is returned as - TrainProcessorVersionMetadata. - operationId: documentai.projects.locations.processors.processorVersions.train + description: Undeploys the processor version. + operationId: documentai.projects.locations.processors.processorVersions.undeploy requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionRequest + #/components/schemas/GoogleCloudDocumentaiV1UndeployProcessorVersionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6319,18 +6643,25 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}:batchProcess: + - in: path + name: processorVersionsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}:evaluateProcessorVersion: parameters: *ref_1 post: description: >- - LRO endpoint to batch process many documents. The output is written to - Cloud Storage as JSON in the [Document] format. - operationId: documentai.projects.locations.processors.processorVersions.batchProcess + Evaluates a ProcessorVersion against annotated documents, producing an + Evaluation. + operationId: >- + documentai.projects.locations.processors.processorVersions.evaluateProcessorVersion requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1BatchProcessRequest' + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6364,11 +6695,12 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions: + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}/evaluations/{evaluationsId}: parameters: *ref_1 get: - description: Lists all versions of a processor. - operationId: documentai.projects.locations.processors.processorVersions.list + description: Retrieves a specific evaluation. + operationId: >- + documentai.projects.locations.processors.processorVersions.evaluations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6380,8 +6712,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1ListProcessorVersionsResponse + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Evaluation' parameters: - in: path name: projectsId @@ -6398,25 +6729,22 @@ paths: required: true schema: type: string - - in: query - name: pageSize + - in: path + name: processorVersionsId + required: true schema: - type: integer - format: int32 - - in: query - name: pageToken + type: string + - in: path + name: evaluationsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}:process: + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}/evaluations: parameters: *ref_1 - post: - description: Processes a single document. - operationId: documentai.projects.locations.processors.processorVersions.process - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessRequest' + get: + description: Retrieves a set of evaluations for a given processor version. + operationId: >- + documentai.projects.locations.processors.processorVersions.evaluations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6428,7 +6756,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessResponse' + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1ListEvaluationsResponse parameters: - in: path name: projectsId @@ -6450,20 +6779,29 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}:evaluateProcessorVersion: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/humanReviewConfig:reviewDocument: parameters: *ref_1 post: description: >- - Evaluates a ProcessorVersion against annotated documents, producing an - Evaluation. + Send a document for Human Review. The input document should be processed + by the specified processor. operationId: >- - documentai.projects.locations.processors.processorVersions.evaluateProcessorVersion + documentai.projects.locations.processors.humanReviewConfig.reviewDocument requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest + #/components/schemas/GoogleCloudDocumentaiV1ReviewDocumentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6492,18 +6830,11 @@ paths: required: true schema: type: string - - in: path - name: processorVersionsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/processorTypes: parameters: *ref_1 get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: documentai.projects.locations.operations.list + description: Lists the processor types that exist. + operationId: documentai.projects.locations.processorTypes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6515,7 +6846,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1ListProcessorTypesResponse parameters: - in: path name: projectsId @@ -6527,95 +6859,13 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - in: query name: pageSize schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_1 - post: - description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: documentai.projects.locations.operations.cancel - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: operationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_1 - get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: documentai.projects.locations.operations.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: operationsId - required: true + - in: query + name: pageToken schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/processorTypes/{processorTypesId}: @@ -6651,11 +6901,15 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processorTypes: + /v1/operations/{operationsId}: parameters: *ref_1 - get: - description: Lists the processor types that exist. - operationId: documentai.projects.locations.processorTypes.list + delete: + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: documentai.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6667,25 +6921,10 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1ListProcessorTypesResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId + name: operationsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/domains.yaml b/providers/src/googleapis.com/v00.00.00000/services/domains.yaml index 3c1492c5..f6e19366 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/domains.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/domains.yaml @@ -7,8 +7,8 @@ info: title: Cloud Domains API description: Enables management and configuration of domain names. version: v1 - x-discovery-doc-revision: '20241023' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250225' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/domains/ servers: @@ -1040,17 +1040,17 @@ components: PostalAddress: id: PostalAddress description: >- - Represents a postal address, e.g. for postal delivery or payments + Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would - be created via user input or from importing existing data, depending on + be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this - schema, please see: https://support.google.com/business/answer/6397478 + schema, see: https://support.google.com/business/answer/6397478 type: object properties: revision: @@ -1085,26 +1085,26 @@ components: Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address - (e.g. state/zip validation in the U.S.A.). + (For example state/zip validation in the U.S.A.). type: string sortingCode: description: >- Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string - like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or - just a number alone, representing the "sector code" (Jamaica), - "delivery area indicator" (Malawi) or "post office indicator" (e.g. - Côte d'Ivoire). + like "CEDEX", optionally followed by a number (For example "CEDEX + 7"), or just a number alone, representing the "sector code" + (Jamaica), "delivery area indicator" (Malawi) or "post office + indicator" (For example Côte d'Ivoire). type: string administrativeArea: description: >- Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for - Spain this is the province and not the autonomous community (e.g. - "Barcelona" and not "Catalonia"). Many countries don't use an - administrative area in postal addresses. E.g. in Switzerland this - should be left unpopulated. + Spain this is the province and not the autonomous community (For + example "Barcelona" and not "Catalonia"). Many countries don't use + an administrative area in postal addresses. For example in + Switzerland this should be left unpopulated. type: string locality: description: >- @@ -1123,22 +1123,22 @@ components: Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single - field (e.g. "Austin, TX"), it is important that the line order is - clear. The order of address lines should be "envelope order" for the - country/region of the address. In places where this can vary (e.g. - Japan), address_language is used to make it explicit (e.g. "ja" for - large-to-small ordering and "ja-Latn" or "en" for small-to-large). - This way, the most specific line of an address can be selected based - on the language. The minimum permitted structural representation of - an address consists of a region_code with all remaining information - placed in the address_lines. It would be possible to format such an - address very approximately without geocoding, but no semantic - reasoning could be made about any of the address components until it - was at least partially resolved. Creating an address only containing - a region_code and address_lines, and then geocoding is the - recommended way to handle completely unstructured addresses (as - opposed to guessing which parts of the address should be localities - or administrative areas). + field (For example "Austin, TX"), it is important that the line + order is clear. The order of address lines should be "envelope + order" for the country/region of the address. In places where this + can vary (For example Japan), address_language is used to make it + explicit (For example "ja" for large-to-small ordering and "ja-Latn" + or "en" for small-to-large). This way, the most specific line of an + address can be selected based on the language. The minimum permitted + structural representation of an address consists of a region_code + with all remaining information placed in the address_lines. It would + be possible to format such an address very approximately without + geocoding, but no semantic reasoning could be made about any of the + address components until it was at least partially resolved. + Creating an address only containing a region_code and address_lines, + and then geocoding is the recommended way to handle completely + unstructured addresses (as opposed to guessing which parts of the + address should be localities or administrative areas). type: array items: type: string @@ -1521,8 +1521,9 @@ components: $ref: '#/components/schemas/PrimaryBackupPolicy' healthCheck: description: >- - The selfLink attribute of the HealthCheck resource to use for this - RRSetRoutingPolicy. + The fully qualified URL of the HealthCheck to use for this + RRSetRoutingPolicy. Format this URL like + `https://www.googleapis.com/compute/v1/projects/{project}/global/healthChecks/{healthCheck}`. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks type: string GeoPolicy: @@ -1567,8 +1568,8 @@ components: signatureRrdata: description: >- DNSSEC generated signatures for all the `rrdata` within this item. - If health checked targets are provided for DNSSEC enabled zones, - there's a restriction of 1 IP address per item. + When using health-checked targets for DNSSEC-enabled zones, you can + only use at most one health-checked IP address per item. type: array items: type: string @@ -1583,7 +1584,8 @@ components: description: >- HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included - in the response. + in the response. Set either `internal_load_balancer` or + `external_endpoints`. Do not set both. type: object properties: internalLoadBalancer: @@ -1691,8 +1693,8 @@ components: signatureRrdata: description: >- DNSSEC generated signatures for all the `rrdata` within this item. - Note that if health checked targets are provided for DNSSEC enabled - zones, there's a restriction of 1 IP address per item. + When using health-checked targets for DNSSEC-enabled zones, you can + only use at most one health-checked IP address per item. type: array items: type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/essentialcontacts.yaml b/providers/src/googleapis.com/v00.00.00000/services/essentialcontacts.yaml index 626f7c92..d08f139e 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/essentialcontacts.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/essentialcontacts.yaml @@ -7,8 +7,8 @@ info: title: Essential Contacts API description: '' version: v1 - x-discovery-doc-revision: '20241024' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250814' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/essentialcontacts/docs/ servers: @@ -34,69 +34,27 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudEssentialcontactsV1SendTestMessageRequest: + GoogleCloudEssentialcontactsV1Contact: + id: GoogleCloudEssentialcontactsV1Contact + description: A contact that will receive notifications from Google Cloud. + type: object properties: - notificationCategory: - enum: - - NOTIFICATION_CATEGORY_UNSPECIFIED - - ALL - - SUSPENSION - - SECURITY - - TECHNICAL - - BILLING - - LEGAL - - PRODUCT_UPDATES - - TECHNICAL_INCIDENTS - enumDescriptions: - - Notification category is unrecognized or unspecified. - - >- - All notifications related to the resource, including notifications - pertaining to categories added in the future. - - Notifications related to imminent account suspension. - - >- - Notifications related to security/privacy incidents, - notifications, and vulnerabilities. - - >- - Notifications related to technical events and issues such as - outages, errors, or bugs. - - >- - Notifications related to billing and payments notifications, price - updates, errors, or credits. - - >- - Notifications related to enforcement actions, regulatory - compliance, or government notices. - - >- - Notifications related to new versions, product terms updates, or - deprecations. - - >- - Child category of TECHNICAL. If assigned, technical incident - notifications will go to these contacts instead of TECHNICAL. + name: description: >- - Required. The notification category to send the test message for. - All contacts must be subscribed to this category. + Output only. The identifier for the contact. Format: + {resource_type}/{resource_id}/contacts/{contact_id} + readOnly: true type: string - contacts: - type: array - items: - type: string - description: >- - Required. The list of names of the contacts to send a test message - to. Format: organizations/{organization_id}/contacts/{contact_id}, - folders/{folder_id}/contacts/{contact_id} or - projects/{project_id}/contacts/{contact_id} - description: Request message for the SendTestMessage method. - id: GoogleCloudEssentialcontactsV1SendTestMessageRequest - type: object - GoogleCloudEssentialcontactsV1Contact: - properties: - languageTag: + email: description: >- - Required. The preferred language for notifications, as a ISO 639-1 - language code. See [Supported - languages](https://cloud.google.com/resource-manager/docs/managing-notification-contacts#supported-languages) - for a list of supported languages. + Required. The email address to send notifications to. The email + address does not need to be a Google Account. type: string notificationCategorySubscriptions: + description: >- + Required. The categories of notifications that the contact will + receive communications for. + type: array items: type: string enumDescriptions: @@ -133,24 +91,20 @@ components: - LEGAL - PRODUCT_UPDATES - TECHNICAL_INCIDENTS - type: array - description: >- - Required. The categories of notifications that the contact will - receive communications for. - validateTime: - description: >- - The last time the validation_state was updated, either manually or - automatically. A contact is considered stale if its validation state - was updated more than 1 year ago. - format: google-datetime - type: string - email: + languageTag: description: >- - Required. The email address to send notifications to. The email - address does not need to be a Google Account. + Required. The preferred language for notifications, as a ISO 639-1 + language code. See [Supported + languages](https://cloud.google.com/resource-manager/docs/managing-notification-contacts#supported-languages) + for a list of supported languages. type: string validationState: + description: >- + Output only. The validity of the contact. A contact is considered + valid if it is the correct recipient for notifications for a + particular resource. readOnly: true + type: string enumDescriptions: - The validation state is unknown or unspecified. - >- @@ -159,72 +113,119 @@ components: - >- The contact is considered invalid. This may become the state if the contact's email is found to be unreachable. - type: string enum: - VALIDATION_STATE_UNSPECIFIED - VALID - INVALID + validateTime: description: >- - Output only. The validity of the contact. A contact is considered - valid if it is the correct recipient for notifications for a - particular resource. - name: + Output only. The last time the validation_state was updated, either + manually or automatically. A contact is considered stale if its + validation state was updated more than 1 year ago. readOnly: true type: string - description: >- - Output only. The identifier for the contact. Format: - {resource_type}/{resource_id}/contacts/{contact_id} - id: GoogleCloudEssentialcontactsV1Contact - type: object - description: A contact that will receive notifications from Google Cloud. - GoogleCloudEssentialcontactsV1ComputeContactsResponse: - id: GoogleCloudEssentialcontactsV1ComputeContactsResponse + format: google-datetime + GoogleCloudEssentialcontactsV1ListContactsResponse: + id: GoogleCloudEssentialcontactsV1ListContactsResponse + description: Response message for the ListContacts method. type: object properties: contacts: - description: >- - All contacts for the resource that are subscribed to the specified - notification categories, including contacts inherited from any - parent resources. + description: The contacts for the specified resource. + type: array items: $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' - type: array nextPageToken: - type: string description: >- If there are more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token` and the rest of the parameters the same as the original request. - description: Response message for the ComputeContacts method. + type: string GoogleProtobufEmpty: - properties: {} id: GoogleProtobufEmpty - type: object description: >- A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } - GoogleCloudEssentialcontactsV1ListContactsResponse: - description: Response message for the ListContacts method. + type: object + properties: {} + GoogleCloudEssentialcontactsV1ComputeContactsResponse: + id: GoogleCloudEssentialcontactsV1ComputeContactsResponse + description: Response message for the ComputeContacts method. type: object properties: + contacts: + description: >- + All contacts for the resource that are subscribed to the specified + notification categories, including contacts inherited from any + parent resources. + type: array + items: + $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' nextPageToken: - type: string description: >- If there are more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token` and the rest of the parameters the same as the original request. + type: string + GoogleCloudEssentialcontactsV1SendTestMessageRequest: + id: GoogleCloudEssentialcontactsV1SendTestMessageRequest + description: Request message for the SendTestMessage method. + type: object + properties: contacts: - description: The contacts for the specified resource. - items: - $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' + description: >- + Required. The list of names of the contacts to send a test message + to. Format: organizations/{organization_id}/contacts/{contact_id}, + folders/{folder_id}/contacts/{contact_id} or + projects/{project_id}/contacts/{contact_id} type: array - id: GoogleCloudEssentialcontactsV1ListContactsResponse + items: + type: string + notificationCategory: + description: >- + Required. The notification category to send the test message for. + All contacts must be subscribed to this category. + type: string + enumDescriptions: + - Notification category is unrecognized or unspecified. + - >- + All notifications related to the resource, including notifications + pertaining to categories added in the future. + - Notifications related to imminent account suspension. + - >- + Notifications related to security/privacy incidents, + notifications, and vulnerabilities. + - >- + Notifications related to technical events and issues such as + outages, errors, or bugs. + - >- + Notifications related to billing and payments notifications, price + updates, errors, or credits. + - >- + Notifications related to enforcement actions, regulatory + compliance, or government notices. + - >- + Notifications related to new versions, product terms updates, or + deprecations. + - >- + Child category of TECHNICAL. If assigned, technical incident + notifications will go to these contacts instead of TECHNICAL. + enum: + - NOTIFICATION_CATEGORY_UNSPECIFIED + - ALL + - SUSPENSION + - SECURITY + - TECHNICAL + - BILLING + - LEGAL + - PRODUCT_UPDATES + - TECHNICAL_INCIDENTS parameters: access_token: description: OAuth access token. @@ -242,6 +243,18 @@ components: - json - media - proto + 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 @@ -251,12 +264,18 @@ components: name: key schema: type: string - fields: - description: Selector specifying which fields to include in a partial response. + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: fields + 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 @@ -266,19 +285,10 @@ components: name: quotaUser schema: type: string - _.xgafv: - description: V1 error format. - in: query - name: $.xgafv - schema: - type: string - enum: - - '1' - - '2' - oauth_token: - description: OAuth 2.0 token for the current user. + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: oauth_token + name: upload_protocol schema: type: string uploadType: @@ -287,68 +297,59 @@ components: name: uploadType schema: type: string - callback: - description: JSONP - in: query - name: callback - schema: - type: string - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + _.xgafv: + description: V1 error format. in: query - name: upload_protocol + name: $.xgafv schema: type: string + enum: + - '1' + - '2' x-stackQL-resources: contacts: id: google.essentialcontacts.contacts name: contacts title: Contacts methods: - projects_contacts_patch: + projects_contacts_create: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1contacts~1{contactsId}/patch' + $ref: '#/paths/~1v1~1projects~1{projectsId}~1contacts/post' response: mediaType: application/json openAPIDocKey: '200' - projects_contacts_delete: + projects_contacts_list: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1contacts~1{contactsId}/delete + $ref: '#/paths/~1v1~1projects~1{projectsId}~1contacts/get' response: mediaType: application/json openAPIDocKey: '200' - projects_contacts_get: + objectKey: $.contacts + projects_contacts_patch: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1contacts~1{contactsId}/get' + $ref: '#/paths/~1v1~1projects~1{projectsId}~1contacts~1{contactsId}/patch' response: mediaType: application/json openAPIDocKey: '200' - projects_contacts_compute: + projects_contacts_get: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1contacts:compute/get' + $ref: '#/paths/~1v1~1projects~1{projectsId}~1contacts~1{contactsId}/get' response: mediaType: application/json openAPIDocKey: '200' - projects_contacts_create: + projects_contacts_delete: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1contacts/post' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1contacts~1{contactsId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_contacts_list: + projects_contacts_compute: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1contacts/get' + $ref: '#/paths/~1v1~1projects~1{projectsId}~1contacts:compute/get' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.contacts projects_contacts_send_test_message: operation: $ref: >- @@ -356,94 +357,94 @@ components: response: mediaType: application/json openAPIDocKey: '200' - organizations_contacts_get: + folders_contacts_create: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1contacts~1{contactsId}/get + $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts/post' response: mediaType: application/json openAPIDocKey: '200' - organizations_contacts_patch: + folders_contacts_list: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1contacts~1{contactsId}/patch + $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_contacts_delete: + objectKey: $.contacts + folders_contacts_patch: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1contacts~1{contactsId}/delete + $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts~1{contactsId}/patch' response: mediaType: application/json openAPIDocKey: '200' - organizations_contacts_create: + folders_contacts_get: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1contacts/post' + $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts~1{contactsId}/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_contacts_list: + folders_contacts_delete: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1contacts/get' + $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts~1{contactsId}/delete' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.contacts - organizations_contacts_send_test_message: + folders_contacts_compute: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1contacts:sendTestMessage/post + $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts:compute/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_contacts_compute: + folders_contacts_send_test_message: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1contacts:compute/get + $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts:sendTestMessage/post' response: mediaType: application/json openAPIDocKey: '200' - folders_contacts_delete: + organizations_contacts_create: operation: - $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts~1{contactsId}/delete' + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1contacts/post' response: mediaType: application/json openAPIDocKey: '200' - folders_contacts_get: + organizations_contacts_list: operation: - $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts~1{contactsId}/get' + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1contacts/get' response: mediaType: application/json openAPIDocKey: '200' - folders_contacts_patch: + objectKey: $.contacts + organizations_contacts_patch: operation: - $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts~1{contactsId}/patch' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1contacts~1{contactsId}/patch response: mediaType: application/json openAPIDocKey: '200' - folders_contacts_send_test_message: + organizations_contacts_get: operation: - $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts:sendTestMessage/post' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1contacts~1{contactsId}/get response: mediaType: application/json openAPIDocKey: '200' - folders_contacts_list: + organizations_contacts_delete: operation: - $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1contacts~1{contactsId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.contacts - folders_contacts_create: + organizations_contacts_compute: operation: - $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts/post' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1contacts:compute/get response: mediaType: application/json openAPIDocKey: '200' - folders_contacts_compute: + organizations_contacts_send_test_message: operation: - $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts:compute/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1contacts:sendTestMessage/post response: mediaType: application/json openAPIDocKey: '200' @@ -451,55 +452,55 @@ components: select: - $ref: >- #/components/x-stackQL-resources/contacts/methods/projects_contacts_get - - $ref: >- - #/components/x-stackQL-resources/contacts/methods/organizations_contacts_get - $ref: >- #/components/x-stackQL-resources/contacts/methods/folders_contacts_get - $ref: >- - #/components/x-stackQL-resources/contacts/methods/projects_contacts_list + #/components/x-stackQL-resources/contacts/methods/organizations_contacts_get - $ref: >- - #/components/x-stackQL-resources/contacts/methods/organizations_contacts_list + #/components/x-stackQL-resources/contacts/methods/projects_contacts_list - $ref: >- #/components/x-stackQL-resources/contacts/methods/folders_contacts_list + - $ref: >- + #/components/x-stackQL-resources/contacts/methods/organizations_contacts_list insert: - $ref: >- #/components/x-stackQL-resources/contacts/methods/projects_contacts_create - - $ref: >- - #/components/x-stackQL-resources/contacts/methods/organizations_contacts_create - $ref: >- #/components/x-stackQL-resources/contacts/methods/folders_contacts_create + - $ref: >- + #/components/x-stackQL-resources/contacts/methods/organizations_contacts_create update: - $ref: >- #/components/x-stackQL-resources/contacts/methods/projects_contacts_patch - - $ref: >- - #/components/x-stackQL-resources/contacts/methods/organizations_contacts_patch - $ref: >- #/components/x-stackQL-resources/contacts/methods/folders_contacts_patch + - $ref: >- + #/components/x-stackQL-resources/contacts/methods/organizations_contacts_patch replace: [] delete: - $ref: >- #/components/x-stackQL-resources/contacts/methods/projects_contacts_delete - - $ref: >- - #/components/x-stackQL-resources/contacts/methods/organizations_contacts_delete - $ref: >- #/components/x-stackQL-resources/contacts/methods/folders_contacts_delete + - $ref: >- + #/components/x-stackQL-resources/contacts/methods/organizations_contacts_delete paths: - /v1/projects/{projectsId}/contacts/{contactsId}: + /v1/projects/{projectsId}/contacts: parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - patch: - description: 'Updates a contact. Note: A contact''s email address cannot be changed.' - operationId: essentialcontacts.projects.contacts.patch + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' + post: + description: Adds a new contact for a resource. + operationId: essentialcontacts.projects.contacts.create requestBody: content: application/json: @@ -523,19 +524,9 @@ paths: required: true schema: type: string - - in: path - name: contactsId - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: - description: Deletes a contact. - operationId: essentialcontacts.projects.contacts.delete + get: + description: Lists the contacts that have been set on a resource. + operationId: essentialcontacts.projects.contacts.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -547,21 +538,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudEssentialcontactsV1ListContactsResponse parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: contactsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - get: - description: Gets a single contact. - operationId: essentialcontacts.projects.contacts.get + /v1/projects/{projectsId}/contacts/{contactsId}: + parameters: *ref_1 + patch: + description: 'Updates a contact. Note: A contact''s email address cannot be changed.' + operationId: essentialcontacts.projects.contacts.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -585,14 +588,14 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/contacts:compute: - parameters: *ref_1 + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask get: - description: >- - Lists all contacts for the resource that are subscribed to the specified - notification categories, including contacts inherited from any parent - resources. - operationId: essentialcontacts.projects.contacts.compute + description: Gets a single contact. + operationId: essentialcontacts.projects.contacts.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -604,37 +607,21 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudEssentialcontactsV1ComputeContactsResponse + $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' parameters: - in: path name: projectsId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: notificationCategories + - in: path + name: contactsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/contacts: - parameters: *ref_1 - post: - description: Adds a new contact for a resource. - operationId: essentialcontacts.projects.contacts.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' + delete: + description: Deletes a contact. + operationId: essentialcontacts.projects.contacts.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -646,16 +633,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId required: true schema: type: string + - in: path + name: contactsId + required: true + schema: + type: string + /v1/projects/{projectsId}/contacts:compute: + parameters: *ref_1 get: - description: Lists the contacts that have been set on a resource. - operationId: essentialcontacts.projects.contacts.list + description: >- + Lists all contacts for the resource that are subscribed to the specified + notification categories, including contacts inherited from any parent + resources. + operationId: essentialcontacts.projects.contacts.compute security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -668,13 +665,17 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudEssentialcontactsV1ListContactsResponse + #/components/schemas/GoogleCloudEssentialcontactsV1ComputeContactsResponse parameters: - in: path name: projectsId required: true schema: type: string + - in: query + name: notificationCategories + schema: + type: string - in: query name: pageSize schema: @@ -715,11 +716,16 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/contacts/{contactsId}: + /v1/folders/{foldersId}/contacts: parameters: *ref_1 - get: - description: Gets a single contact. - operationId: essentialcontacts.organizations.contacts.get + post: + description: Adds a new contact for a resource. + operationId: essentialcontacts.folders.contacts.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -734,18 +740,46 @@ paths: $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' parameters: - in: path - name: organizationsId + name: foldersId required: true schema: type: string + get: + description: Lists the contacts that have been set on a resource. + operationId: essentialcontacts.folders.contacts.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudEssentialcontactsV1ListContactsResponse + parameters: - in: path - name: contactsId + name: foldersId required: true schema: type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/folders/{foldersId}/contacts/{contactsId}: + parameters: *ref_1 patch: description: 'Updates a contact. Note: A contact''s email address cannot be changed.' - operationId: essentialcontacts.organizations.contacts.patch + operationId: essentialcontacts.folders.contacts.patch requestBody: content: application/json: @@ -765,7 +799,7 @@ paths: $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' parameters: - in: path - name: organizationsId + name: foldersId required: true schema: type: string @@ -779,9 +813,9 @@ paths: schema: type: string format: google-fieldmask - delete: - description: Deletes a contact. - operationId: essentialcontacts.organizations.contacts.delete + get: + description: Gets a single contact. + operationId: essentialcontacts.folders.contacts.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -793,10 +827,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' parameters: - in: path - name: organizationsId + name: foldersId required: true schema: type: string @@ -805,16 +839,9 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/contacts: - parameters: *ref_1 - post: - description: Adds a new contact for a resource. - operationId: essentialcontacts.organizations.contacts.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' + delete: + description: Deletes a contact. + operationId: essentialcontacts.folders.contacts.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -826,16 +853,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: organizationsId + name: foldersId + required: true + schema: + type: string + - in: path + name: contactsId required: true schema: type: string + /v1/folders/{foldersId}/contacts:compute: + parameters: *ref_1 get: - description: Lists the contacts that have been set on a resource. - operationId: essentialcontacts.organizations.contacts.list + description: >- + Lists all contacts for the resource that are subscribed to the specified + notification categories, including contacts inherited from any parent + resources. + operationId: essentialcontacts.folders.contacts.compute security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -848,15 +885,15 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudEssentialcontactsV1ListContactsResponse + #/components/schemas/GoogleCloudEssentialcontactsV1ComputeContactsResponse parameters: - in: path - name: organizationsId + name: foldersId required: true schema: type: string - in: query - name: pageToken + name: notificationCategories schema: type: string - in: query @@ -864,13 +901,17 @@ paths: schema: type: integer format: int32 - /v1/organizations/{organizationsId}/contacts:sendTestMessage: + - in: query + name: pageToken + schema: + type: string + /v1/folders/{foldersId}/contacts:sendTestMessage: parameters: *ref_1 post: description: >- Allows a contact admin to send a test message to contact to verify that it has been configured correctly. - operationId: essentialcontacts.organizations.contacts.sendTestMessage + operationId: essentialcontacts.folders.contacts.sendTestMessage requestBody: content: application/json: @@ -891,18 +932,20 @@ paths: $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: organizationsId + name: foldersId required: true schema: type: string - /v1/organizations/{organizationsId}/contacts:compute: + /v1/organizations/{organizationsId}/contacts: parameters: *ref_1 - get: - description: >- - Lists all contacts for the resource that are subscribed to the specified - notification categories, including contacts inherited from any parent - resources. - operationId: essentialcontacts.organizations.contacts.compute + post: + description: Adds a new contact for a resource. + operationId: essentialcontacts.organizations.contacts.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -914,32 +957,16 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudEssentialcontactsV1ComputeContactsResponse + $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: notificationCategories - schema: - type: string - - in: query - name: pageToken - schema: - type: string - /v1/folders/{foldersId}/contacts/{contactsId}: - parameters: *ref_1 - delete: - description: Deletes a contact. - operationId: essentialcontacts.folders.contacts.delete + get: + description: Lists the contacts that have been set on a resource. + operationId: essentialcontacts.organizations.contacts.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -951,21 +978,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudEssentialcontactsV1ListContactsResponse parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string - - in: path - name: contactsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - get: - description: Gets a single contact. - operationId: essentialcontacts.folders.contacts.get + /v1/organizations/{organizationsId}/contacts/{contactsId}: + parameters: *ref_1 + patch: + description: 'Updates a contact. Note: A contact''s email address cannot be changed.' + operationId: essentialcontacts.organizations.contacts.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -980,7 +1019,7 @@ paths: $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string @@ -989,14 +1028,14 @@ paths: required: true schema: type: string - patch: - description: 'Updates a contact. Note: A contact''s email address cannot be changed.' - operationId: essentialcontacts.folders.contacts.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + get: + description: Gets a single contact. + operationId: essentialcontacts.organizations.contacts.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1011,7 +1050,7 @@ paths: $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string @@ -1020,24 +1059,9 @@ paths: required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1/folders/{foldersId}/contacts:sendTestMessage: - parameters: *ref_1 - post: - description: >- - Allows a contact admin to send a test message to contact to verify that - it has been configured correctly. - operationId: essentialcontacts.folders.contacts.sendTestMessage - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudEssentialcontactsV1SendTestMessageRequest + delete: + description: Deletes a contact. + operationId: essentialcontacts.organizations.contacts.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1052,15 +1076,23 @@ paths: $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string - /v1/folders/{foldersId}/contacts: + - in: path + name: contactsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/contacts:compute: parameters: *ref_1 get: - description: Lists the contacts that have been set on a resource. - operationId: essentialcontacts.folders.contacts.list + description: >- + Lists all contacts for the resource that are subscribed to the specified + notification categories, including contacts inherited from any parent + resources. + operationId: essentialcontacts.organizations.contacts.compute security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1073,15 +1105,15 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudEssentialcontactsV1ListContactsResponse + #/components/schemas/GoogleCloudEssentialcontactsV1ComputeContactsResponse parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string - in: query - name: pageToken + name: notificationCategories schema: type: string - in: query @@ -1089,40 +1121,23 @@ paths: schema: type: integer format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/organizations/{organizationsId}/contacts:sendTestMessage: + parameters: *ref_1 post: - description: Adds a new contact for a resource. - operationId: essentialcontacts.folders.contacts.create + description: >- + Allows a contact admin to send a test message to contact to verify that + it has been configured correctly. + operationId: essentialcontacts.organizations.contacts.sendTestMessage requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' - parameters: - - in: path - name: foldersId - required: true - schema: - type: string - /v1/folders/{foldersId}/contacts:compute: - parameters: *ref_1 - get: - description: >- - Lists all contacts for the resource that are subscribed to the specified - notification categories, including contacts inherited from any parent - resources. - operationId: essentialcontacts.folders.contacts.compute + $ref: >- + #/components/schemas/GoogleCloudEssentialcontactsV1SendTestMessageRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1134,24 +1149,10 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudEssentialcontactsV1ComputeContactsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string - - in: query - name: notificationCategories - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/eventarc.yaml b/providers/src/googleapis.com/v00.00.00000/services/eventarc.yaml index 121615ca..197c31ee 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/eventarc.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/eventarc.yaml @@ -7,8 +7,8 @@ info: title: Eventarc API description: Build event-driven applications on Google Cloud Platform. version: v1 - x-discovery-doc-revision: '20241029' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250815' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/eventarc servers: @@ -364,7 +364,7 @@ components: properties: uri: description: >- - Required. The URI of the HTTP enpdoint. The value must be a RFC2396 + Required. The URI of the HTTP endpoint. The value must be a RFC2396 URI string. Examples: `http://10.10.10.8:80/route`, `http://svc.us-central1.p.local:8080/`. Only HTTP and HTTPS protocols are supported. The host can be either a static IP @@ -648,8 +648,8 @@ components: type: string cryptoKeyName: description: >- - Resource name of a KMS crypto key (managed by the user) used to - encrypt/decrypt their event data. It must match the pattern + Optional. Resource name of a KMS crypto key (managed by the user) + used to encrypt/decrypt their event data. It must match the pattern `projects/*/locations/*/keyRings/*/cryptoKeys/*`. type: string satisfiesPzs: @@ -658,6 +658,11 @@ components: of physical zone separation readOnly: true type: boolean + labels: + description: Optional. Resource labels. + type: object + additionalProperties: + type: string ListChannelsResponse: id: ListChannelsResponse description: The response message for the `ListChannels` method. @@ -826,6 +831,11 @@ components: the provider project. This field will not be stored in the provider resource. type: string + labels: + description: Optional. Resource labels. + type: object + additionalProperties: + type: string ListChannelConnectionsResponse: id: ListChannelConnectionsResponse description: The response message for the `ListChannelConnections` method. @@ -860,7 +870,9 @@ components: name: description: >- Required. The resource name of the config. Must be in the format of, - `projects/{project}/locations/{location}/googleChannelConfig`. + `projects/{project}/locations/{location}/googleChannelConfig`. In + API responses, the config name always includes the projectID, + regardless of whether the projectID or projectNumber was provided. type: string updateTime: description: Output only. The last-modified time. @@ -873,6 +885,11 @@ components: used to encrypt/decrypt their event data. It must match the pattern `projects/*/locations/*/keyRings/*/cryptoKeys/*`. type: string + labels: + description: Optional. Resource labels. + type: object + additionalProperties: + type: string MessageBus: id: MessageBus description: >- @@ -940,7 +957,7 @@ components: LoggingConfig: id: LoggingConfig description: >- - The configuration for Platform Telemetry logging for Eventarc Avdvanced + The configuration for Platform Telemetry logging for Eventarc Advanced resources. type: object properties: @@ -1082,8 +1099,8 @@ components: type: string messageBus: description: >- - Required. Resource name of the message bus identifying the source of - the messages. It matches the form + Required. Immutable. Resource name of the message bus identifying + the source of the messages. It matches the form projects/{project}/locations/{location}/messageBuses/{messageBus}. type: string destination: @@ -1216,7 +1233,14 @@ components: Output only. This checksum is computed by the server based on the value of other fields, and might be sent only on create requests to ensure that the client has an up-to-date value before proceeding. + readOnly: true type: string + satisfiesPzs: + description: >- + Output only. Whether or not this Pipeline satisfies the requirements + of physical zone separation + readOnly: true + type: boolean GoogleCloudEventarcV1PipelineDestination: id: GoogleCloudEventarcV1PipelineDestination description: Represents a target of an invocation over HTTP. @@ -1294,7 +1318,7 @@ components: properties: uri: description: >- - Required. The URI of the HTTP enpdoint. The value must be a RFC2396 + Required. The URI of the HTTP endpoint. The value must be a RFC2396 URI string. Examples: `https://svc.us-central1.p.local:8080/route`. Only the HTTPS protocol is supported. type: string @@ -1304,13 +1328,14 @@ components: destination-bound HTTP request is constructed. If a binding expression is not specified here, the message is treated as a CloudEvent and is mapped to the HTTP request according to the - CloudEvent HTTP Protocol Binding Binary Content Mode. In this - representation, all fields except the `data` and `datacontenttype` - field on the message are mapped to HTTP request headers with a - prefix of `ce-`. To construct the HTTP request payload and the value - of the content-type HTTP header, the payload format is defined as - follows: 1) Use the output_payload_format_type on the - Pipeline.Destination if it is set, else: 2) Use the + CloudEvent HTTP Protocol Binding Binary Content Mode + (https://github.com/cloudevents/spec/blob/main/cloudevents/bindings/http-protocol-binding.md#31-binary-content-mode). + In this representation, all fields except the `data` and + `datacontenttype` field on the message are mapped to HTTP request + headers with a prefix of `ce-`. To construct the HTTP request + payload and the value of the content-type HTTP header, the payload + format is defined as follows: 1) Use the output_payload_format_type + on the Pipeline.Destination if it is set, else: 2) Use the input_payload_format_type on the Pipeline if it is set, else: 3) Treat the payload as opaque binary data. The `data` field of the message is converted to the payload format or left as-is for case 3) @@ -1365,53 +1390,54 @@ components: Binary Content Mode representation of the final message and by overwriting the body of the request: ``` { "headers": headers.merge({"new-header-key": "new-header-value"}), "body": - "new-body" } ``` Additionally, the following CEL extension functions - are provided for use in this CEL expression: - toBase64Url: - map.toBase64Url() -> string - Converts a CelValue to a base64url - encoded string - toJsonString: map.toJsonString() -> string - - Converts a CelValue to a JSON string - merge: map1.merge(map2) -> - map3 - Merges the passed CEL map with the existing CEL map the - function is applied to. - If the same key exists in both maps, if - the key's value is type map both maps are merged else the value from - the passed map is used. - denormalize: map.denormalize() -> map - - Denormalizes a CEL map such that every value of type map or key in - the map is expanded to return a single level map. - The resulting - keys are "." separated indices of the map keys. - For example: { - "a": 1, "b": { "c": 2, "d": 3 } "e": [4, 5] } .denormalize() -> { - "a": 1, "b.c": 2, "b.d": 3, "e.0": 4, "e.1": 5 } - setField: - map.setField(key, value) -> message - Sets the field of the message - with the given key to the given value. - If the field is not present - it will be added. - If the field is present it will be overwritten. - - The key can be a dot separated path to set a field in a nested - message. - Key must be of type string. - Value may be any valid - type. - removeFields: map.removeFields([key1, key2, ...]) -> message - - Removes the fields of the map with the given keys. - The keys can - be a dot separated path to remove a field in a nested message. - If - a key is not found it will be ignored. - Keys must be of type - string. - toMap: [map1, map2, ...].toMap() -> map - Converts a CEL - list of CEL maps to a single CEL map - toDestinationPayloadFormat(): - message.data.toDestinationPayloadFormat() -> string or bytes - - Converts the message data to the destination payload format - specified in Pipeline.Destination.output_payload_format - This - function is meant to be applied to the message.data field. - If the - destination payload format is not set, the function will return the - message data unchanged. - toCloudEventJsonWithPayloadFormat: + "new-body" } ``` - The default binding for the message payload can + be accessed using the `body` variable. It conatins a string + representation of the message payload in the format specified by the + `output_payload_format` field. If the `input_payload_format` field + is not set, the `body` variable contains the same message payload + bytes that were published. Additionally, the following CEL extension + functions are provided for use in this CEL expression: - + toBase64Url: map.toBase64Url() -> string - Converts a CelValue to a + base64url encoded string - toJsonString: map.toJsonString() -> + string - Converts a CelValue to a JSON string - merge: + map1.merge(map2) -> map3 - Merges the passed CEL map with the + existing CEL map the function is applied to. - If the same key + exists in both maps, if the key's value is type map both maps are + merged else the value from the passed map is used. - denormalize: + map.denormalize() -> map - Denormalizes a CEL map such that every + value of type map or key in the map is expanded to return a single + level map. - The resulting keys are "." separated indices of the map + keys. - For example: { "a": 1, "b": { "c": 2, "d": 3 } "e": [4, 5] } + .denormalize() -> { "a": 1, "b.c": 2, "b.d": 3, "e.0": 4, "e.1": 5 } + - setField: map.setField(key, value) -> message - Sets the field of + the message with the given key to the given value. - If the field is + not present it will be added. - If the field is present it will be + overwritten. - The key can be a dot separated path to set a field in + a nested message. - Key must be of type string. - Value may be any + valid type. - removeFields: map.removeFields([key1, key2, ...]) -> + message - Removes the fields of the map with the given keys. - The + keys can be a dot separated path to remove a field in a nested + message. - If a key is not found it will be ignored. - Keys must be + of type string. - toMap: [map1, map2, ...].toMap() -> map - Converts + a CEL list of CEL maps to a single CEL map - + toCloudEventJsonWithPayloadFormat: message.toCloudEventJsonWithPayloadFormat() -> map - Converts a message to the corresponding structure of JSON format for - CloudEvents - This function applies toDestinationPayloadFormat() to - the message data. It also sets the corresponding datacontenttype of - the CloudEvent, as indicated by - Pipeline.Destination.output_payload_format. If no - output_payload_format is set it will use the existing - datacontenttype on the CloudEvent if present, else leave - datacontenttype absent. - This function expects that the content of - the message will adhere to the standard CloudEvent format. If it - doesn't then this function will fail. - The result is a CEL map that - corresponds to the JSON representation of the CloudEvent. To convert - that data to a JSON string it can be chained with the toJsonString - function. The Pipeline expects that the message it receives adheres - to the standard CloudEvent format. If it doesn't then the outgoing - message request may fail with a persistent error. + CloudEvents. - It converts `data` to destination payload format + specified in `output_payload_format`. If `output_payload_format` is + not set, the data will remain unchanged. - It also sets the + corresponding datacontenttype of the CloudEvent, as indicated by + `output_payload_format`. If no `output_payload_format` is set it + will use the value of the "datacontenttype" attribute on the + CloudEvent if present, else remove "datacontenttype" attribute. - + This function expects that the content of the message will adhere to + the standard CloudEvent format. If it doesn't then this function + will fail. - The result is a CEL map that corresponds to the JSON + representation of the CloudEvent. To convert that data to a JSON + string it can be chained with the toJsonString function. The + Pipeline expects that the message it receives adheres to the + standard CloudEvent format. If it doesn't then the outgoing message + request may fail with a persistent error. type: string GoogleCloudEventarcV1PipelineDestinationAuthenticationConfig: id: GoogleCloudEventarcV1PipelineDestinationAuthenticationConfig @@ -2994,6 +3020,43 @@ components: - $ref: >- #/components/x-stackQL-resources/google_api_sources_iam_policies/methods/set_iam_policy delete: [] + kafka_sources_iam_policies: + id: google.eventarc.kafka_sources_iam_policies + name: kafka_sources_iam_policies + title: Kafka_sources_iam_policies + methods: + set_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1kafkaSources~1{kafkaSourcesId}:setIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + get_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1kafkaSources~1{kafkaSourcesId}:getIamPolicy/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.bindings + test_iam_permissions: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1kafkaSources~1{kafkaSourcesId}:testIamPermissions/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/kafka_sources_iam_policies/methods/get_iam_policy + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/kafka_sources_iam_policies/methods/set_iam_policy + delete: [] paths: /v1/projects/{projectsId}/locations/{locationsId}/googleChannelConfig: parameters: &ref_1 @@ -3009,7 +3072,9 @@ paths: - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/_.xgafv' get: - description: Get a GoogleChannelConfig + description: >- + Get a GoogleChannelConfig. The name of the GoogleChannelConfig in the + response is ALWAYS coded with projectID. operationId: eventarc.projects.locations.getGoogleChannelConfig security: - Oauth2: @@ -3106,6 +3171,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: @@ -3260,7 +3329,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: eventarc.projects.locations.operations.cancel requestBody: content: @@ -5657,3 +5726,127 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/kafkaSources/{kafkaSourcesId}:setIamPolicy: + parameters: *ref_1 + post: + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and + `PERMISSION_DENIED` errors. + operationId: eventarc.projects.locations.kafkaSources.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetIamPolicyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: kafkaSourcesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/kafkaSources/{kafkaSourcesId}:getIamPolicy: + parameters: *ref_1 + get: + description: >- + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: eventarc.projects.locations.kafkaSources.getIamPolicy + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: kafkaSourcesId + required: true + schema: + type: string + - in: query + name: options.requestedPolicyVersion + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/kafkaSources/{kafkaSourcesId}:testIamPermissions: + parameters: *ref_1 + post: + description: >- + Returns permissions that a caller has on the specified resource. If the + resource does not exist, this will return an empty set of permissions, + not a `NOT_FOUND` error. Note: This operation is designed to be used for + building permission-aware UIs and command-line tools, not for + authorization checking. This operation may "fail open" without warning. + operationId: eventarc.projects.locations.kafkaSources.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: kafkaSourcesId + required: true + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/file.yaml b/providers/src/googleapis.com/v00.00.00000/services/file.yaml index bfa0fbd9..d2631328 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/file.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/file.yaml @@ -9,8 +9,8 @@ info: The Cloud Filestore API is used for creating and managing cloud file servers. version: v1 - x-discovery-doc-revision: '20241015' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250810' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/filestore/ servers: @@ -169,7 +169,7 @@ components: returned if there are no more results in the list. type: string unreachable: - description: Locations that could not be reached. + description: Unordered list. Locations that could not be reached. type: array items: type: string @@ -330,9 +330,14 @@ components: $ref: '#/components/schemas/Replication' tags: description: >- - Optional. Input only. Immutable. Tag key-value pairs are bound to - this resource. For example: "123/environment": "production", - "123/costCenter": "marketing" + Optional. Input only. Immutable. Tag key-value pairs bound to this + resource. Each key must be a namespaced name and each value a short + name. Example: "123456789012/environment" : "production", + "123456789013/costCenter" : "marketing" See the documentation for + more information: - Namespaced name: + https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_key + - Short name: + https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_value type: object additionalProperties: type: string @@ -352,11 +357,11 @@ components: - FILE_PROTOCOL_UNSPECIFIED - NFS_V3 - NFS_V4_1 - configurablePerformanceEnabled: + customPerformanceSupported: description: >- - Output only. Indicates whether this instance's performance is - configurable. If enabled, adjust it using the 'performance_config' - field. + Output only. Indicates whether this instance supports configuring + its performance. If true, the user can configure the instance's + performance by using the 'performance_config' field. readOnly: true type: boolean performanceConfig: @@ -374,6 +379,21 @@ components: deletionProtectionReason: description: Optional. The reason for enabling deletion protection. type: string + minCapacityGb: + description: Output only. The min capacity of the instance in GB. + readOnly: true + type: string + format: int64 + maxCapacityGb: + description: Output only. The max capacity of the instance in GB. + readOnly: true + type: string + format: int64 + capacityStepSizeGb: + description: Output only. The increase/decrease capacity step size in GB. + readOnly: true + type: string + format: int64 FileShareConfig: id: FileShareConfig description: File share configuration for the instance. @@ -580,12 +600,25 @@ components: The replica is experiencing an issue and might be unusable. You can get further details from the `stateReasons` field of the `ReplicaConfig` object. + - The replica is being promoted. + - The replica is being paused. + - The replica is paused. + - The replica is being resumed. enum: - STATE_UNSPECIFIED - CREATING - READY - REMOVING - FAILED + - PROMOTING + - PAUSING + - PAUSED + - RESUMING + stateUpdateTime: + description: Output only. The time when the replica state was updated. + readOnly: true + type: string + format: google-datetime stateReasons: description: >- Output only. Additional information about the replication state, if @@ -597,9 +630,15 @@ components: enumDescriptions: - Reason not specified. - The peer instance is unreachable. + - The remove replica peer instance operation failed. + - The pause replica operation failed. + - The resume replica operation failed. enum: - STATE_REASON_UNSPECIFIED - PEER_INSTANCE_UNREACHABLE + - REMOVE_FAILED + - PAUSE_FAILED + - RESUME_FAILED peerInstance: description: Optional. The peer instance. type: string @@ -625,15 +664,15 @@ components: iopsPerTb: description: >- Provision IOPS dynamically based on the capacity of the instance. - Provisioned read IOPS will be calculated by multiplying the capacity - of the instance in TiB by the `iops_per_tb` value. For example, for - a 2 TiB instance with an `iops_per_tb` value of 17000 the - provisioned read IOPS will be 34000. If the calculated value is - outside the supported range for the instance's capacity during - instance creation, instance creation will fail with an - `InvalidArgument` error. Similarly, if an instance capacity update - would result in a value outside the supported range, the update will - fail with an `InvalidArgument` error. + Provisioned IOPS will be calculated by multiplying the capacity of + the instance in TiB by the `iops_per_tb` value. For example, for a 2 + TiB instance with an `iops_per_tb` value of 17000 the provisioned + IOPS will be 34000. If the calculated value is outside the supported + range for the instance's capacity during instance creation, instance + creation will fail with an `InvalidArgument` error. Similarly, if an + instance capacity update would result in a value outside the + supported range, the update will fail with an `InvalidArgument` + error. $ref: '#/components/schemas/IOPSPerTB' fixedIops: description: >- @@ -651,13 +690,6 @@ components: description: IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB). type: object properties: - maxReadIopsPerTb: - description: >- - Optional. Deprecated: `max_iops_per_tb` should be used instead of - this parameter. Maximum read IOPS per TiB. - deprecated: true - type: string - format: int64 maxIopsPerTb: description: Required. Maximum IOPS per TiB. type: string @@ -667,13 +699,6 @@ components: description: Fixed IOPS (input/output operations per second) parameters. type: object properties: - maxReadIops: - description: >- - Optional. Deprecated: `max_iops` should be used instead of this - parameter. Maximum raw read IOPS. - deprecated: true - type: string - format: int64 maxIops: description: Required. Maximum IOPS. type: string @@ -685,6 +710,11 @@ components: performance configuration. type: object properties: + maxIops: + description: Output only. The max IOPS. + readOnly: true + type: string + format: int64 maxReadIops: description: Output only. The max read IOPS. readOnly: true @@ -751,6 +781,11 @@ components: The token you can use to retrieve the next page of results. Not returned if there are no more results in the list. type: string + unreachable: + description: Unordered list. Locations that could not be reached. + type: array + items: + type: string Snapshot: id: Snapshot description: A Filestore snapshot. @@ -800,9 +835,14 @@ components: format: int64 tags: description: >- - Optional. Input only. Immutable. Tag key-value pairs are bound to - this resource. For example: "123/environment": "production", - "123/costCenter": "marketing" + Optional. Input only. Immutable. Tag key-value pairs bound to this + resource. Each key must be a namespaced name and each value a short + name. Example: "123456789012/environment" : "production", + "123456789013/costCenter" : "marketing" See the documentation for + more information: - Namespaced name: + https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_key + - Short name: + https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_value type: object additionalProperties: type: string @@ -828,7 +868,7 @@ components: returned if there are no more results in the list. type: string unreachable: - description: Locations that could not be reached. + description: Unordered list. Locations that could not be reached. type: array items: type: string @@ -968,9 +1008,14 @@ components: type: string tags: description: >- - Optional. Input only. Immutable. Tag key-value pairs are bound to - this resource. For example: "123/environment": "production", - "123/costCenter": "marketing" + Optional. Input only. Immutable. Tag key-value pairs bound to this + resource. Each key must be a namespaced name and each value a short + name. Example: "123456789012/environment" : "production", + "123456789013/costCenter" : "marketing" See the documentation for + more information: - Namespaced name: + https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_key + - Short name: + https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_value type: object additionalProperties: type: string @@ -994,7 +1039,15 @@ components: id: PromoteReplicaRequest description: PromoteReplicaRequest promotes a Filestore standby instance (replica). type: object - properties: {} + properties: + peerInstance: + description: >- + Optional. The resource name of the peer instance to promote, in the + format + `projects/{project_id}/locations/{location_id}/instances/{instance_id}`. + The peer instance is required if the operation is called on an + active instance. + type: string ListLocationsResponse: id: ListLocationsResponse description: The response message for Locations.ListLocations. @@ -1077,8 +1130,8 @@ components: description: >- Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully - have Operation.error value with a google.rpc.Status.code of 1, - corresponding to `Code.CANCELLED`. + have google.longrunning.Operation.error value with a + google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. readOnly: true type: boolean apiVersion: @@ -1257,6 +1310,18 @@ components: additionalProperties: $ref: >- #/components/schemas/GoogleCloudSaasacceleratorManagementProvidersV1NotificationParameter + consumerProjectNumber: + description: >- + Optional. The consumer_project_number associated with this Apigee + instance. This field is added specifically to support Apigee + integration with SLM Rollout and UMM. It represents the numerical + project ID of the GCP project that consumes this Apigee instance. It + is used for SLM rollout notifications and UMM integration, enabling + proper mapping to customer projects and log delivery for Apigee + instances. This field complements consumer_project_id and may be + used for specific Apigee scenarios where the numerical ID is + required. + type: string GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource: id: GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource description: Describes provisioned dataplane resources. @@ -2077,10 +2142,6 @@ paths: name: filter schema: type: string - - in: query - name: includeUnrevealedLocations - schema: - type: boolean - in: query name: pageSize schema: @@ -2090,6 +2151,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: @@ -2244,7 +2309,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: file.projects.locations.operations.cancel requestBody: content: @@ -2644,6 +2709,10 @@ paths: name: filter schema: type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean post: description: Creates a snapshot. operationId: file.projects.locations.instances.snapshots.create diff --git a/providers/src/googleapis.com/v00.00.00000/services/firestore.yaml b/providers/src/googleapis.com/v00.00.00000/services/firestore.yaml index 18ec11e4..e1a4101b 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/firestore.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/firestore.yaml @@ -9,8 +9,8 @@ info: Accesses the NoSQL document database built for automatic scaling, high performance, and ease of application development. version: v1 - x-discovery-doc-revision: '20241018' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250824' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/firestore servers: @@ -250,9 +250,11 @@ components: - >- The index can only be used by the Firestore in Datastore Mode query API. + - The index can only be used by the MONGODB_COMPATIBLE_API. enum: - ANY_API - DATASTORE_MODE_API + - MONGODB_COMPATIBLE_API fields: description: >- The fields supported by this index. For composite indexes, this @@ -294,6 +296,51 @@ components: - CREATING - READY - NEEDS_REPAIR + density: + description: Immutable. The density configuration of the index. + type: string + enumDescriptions: + - >- + Unspecified. It will use database default setting. This value is + input only. + - >- + In order for an index entry to be added, the document must contain + all fields specified in the index. This is the only allowed value + for indexes having ApiScope `ANY_API` and `DATASTORE_MODE_API`. + - >- + In order for an index entry to be added, the document must contain + at least one of the fields specified in the index. Non-existent + fields are treated as having a NULL value when generating index + entries. + - >- + An index entry will be added regardless of whether the document + contains any of the fields specified in the index. Non-existent + fields are treated as having a NULL value when generating index + entries. + enum: + - DENSITY_UNSPECIFIED + - SPARSE_ALL + - SPARSE_ANY + - DENSE + multikey: + description: >- + Optional. Whether the index is multikey. By default, the index is + not multikey. For non-multikey indexes, none of the paths in the + index definition reach or traverse an array, except via an explicit + array index. For multikey indexes, at most one of the paths in the + index definition reach or traverse an array, except via an explicit + array index. Violations will result in errors. Note this field only + applies to index with MONGODB_COMPATIBLE_API ApiScope. + type: boolean + shardCount: + description: Optional. The number of shards for the index. + type: integer + format: int32 + unique: + description: >- + Optional. Whether it is an unique index. Unique index ensures all + values for the indexed field(s) are unique across documents. + type: boolean GoogleFirestoreAdminV1IndexField: id: GoogleFirestoreAdminV1IndexField description: >- @@ -763,12 +810,44 @@ components: description: Output only. Information about the provenance of this database. readOnly: true $ref: '#/components/schemas/GoogleFirestoreAdminV1SourceInfo' + tags: + description: >- + Optional. Input only. Immutable. Tag keys/values directly bound to + this resource. For example: "123/environment": "production", + "123/costCenter": "marketing" + type: object + additionalProperties: + type: string + freeTier: + description: >- + Output only. Background: Free tier is the ability of a Firestore + database to use a small amount of resources every day without being + charged. Once usage exceeds the free tier limit further usage is + charged. Whether this database can make use of the free tier. Only + one database per project can be eligible for the free tier. The + first (or next) database that is created in a project without a free + tier database will be marked as eligible for the free tier. + Databases that are created while there is a free tier database will + not be eligible for the free tier. + readOnly: true + type: boolean etag: description: >- This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. type: string + databaseEdition: + description: Immutable. The edition of the database. + type: string + enumDescriptions: + - Not used. + - Standard edition. This is the default setting if not specified. + - Enterprise edition. + enum: + - DATABASE_EDITION_UNSPECIFIED + - STANDARD + - ENTERPRISE GoogleFirestoreAdminV1CmekConfig: id: GoogleFirestoreAdminV1CmekConfig description: >- @@ -849,6 +928,86 @@ components: type: array items: type: string + GoogleFirestoreAdminV1UserCreds: + id: GoogleFirestoreAdminV1UserCreds + description: A Cloud Firestore User Creds. + type: object + properties: + name: + description: >- + Identifier. The resource name of the UserCreds. Format: + `projects/{project}/databases/{database}/userCreds/{user_creds}` + type: string + createTime: + description: Output only. The time the user creds were created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. The time the user creds were last updated. + readOnly: true + type: string + format: google-datetime + state: + description: >- + Output only. Whether the user creds are enabled or disabled. + Defaults to ENABLED on creation. + readOnly: true + type: string + enumDescriptions: + - The default value. Should not be used. + - The user creds are enabled. + - The user creds are disabled. + enum: + - STATE_UNSPECIFIED + - ENABLED + - DISABLED + securePassword: + description: >- + Output only. The plaintext server-generated password for the user + creds. Only populated in responses for CreateUserCreds and + ResetUserPassword. + readOnly: true + type: string + resourceIdentity: + description: Resource Identity descriptor. + $ref: '#/components/schemas/GoogleFirestoreAdminV1ResourceIdentity' + GoogleFirestoreAdminV1ResourceIdentity: + id: GoogleFirestoreAdminV1ResourceIdentity + description: Describes a Resource Identity principal. + type: object + properties: + principal: + description: >- + Output only. Principal identifier string. See: + https://cloud.google.com/iam/docs/principal-identifiers + readOnly: true + type: string + GoogleFirestoreAdminV1ListUserCredsResponse: + id: GoogleFirestoreAdminV1ListUserCredsResponse + description: The response for FirestoreAdmin.ListUserCreds. + type: object + properties: + userCreds: + description: The user creds for the database. + type: array + items: + $ref: '#/components/schemas/GoogleFirestoreAdminV1UserCreds' + GoogleFirestoreAdminV1EnableUserCredsRequest: + id: GoogleFirestoreAdminV1EnableUserCredsRequest + description: The request for FirestoreAdmin.EnableUserCreds. + type: object + properties: {} + GoogleFirestoreAdminV1DisableUserCredsRequest: + id: GoogleFirestoreAdminV1DisableUserCredsRequest + description: The request for FirestoreAdmin.DisableUserCreds. + type: object + properties: {} + GoogleFirestoreAdminV1ResetUserPasswordRequest: + id: GoogleFirestoreAdminV1ResetUserPasswordRequest + description: The request for FirestoreAdmin.ResetUserPassword. + type: object + properties: {} GoogleFirestoreAdminV1Backup: id: GoogleFirestoreAdminV1Backup description: >- @@ -967,7 +1126,7 @@ components: be 4-63 characters. Valid characters are /a-z-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. "(default)" database ID - is also valid. + is also valid if the database is Standard edition. type: string backup: description: >- @@ -983,6 +1142,14 @@ components: encryption configuration as the backup, namely use_source_encryption. $ref: '#/components/schemas/GoogleFirestoreAdminV1EncryptionConfig' + tags: + description: >- + Optional. Immutable. Tags to be bound to the restored database. The + tags should be provided in the format of `tagKeys/{tag_key_id} -> + tagValues/{tag_value_id}`. + type: object + additionalProperties: + type: string GoogleFirestoreAdminV1EncryptionConfig: id: GoogleFirestoreAdminV1EncryptionConfig description: >- @@ -1121,6 +1288,68 @@ components: type: array items: $ref: '#/components/schemas/GoogleFirestoreAdminV1BackupSchedule' + GoogleFirestoreAdminV1CloneDatabaseRequest: + id: GoogleFirestoreAdminV1CloneDatabaseRequest + description: The request message for FirestoreAdmin.CloneDatabase. + type: object + properties: + databaseId: + description: >- + Required. The ID to use for the database, which will become the + final component of the database's resource name. This database ID + must not be associated with an existing database. This value should + be 4-63 characters. Valid characters are /a-z-/ with first character + a letter and the last a letter or a number. Must not be UUID-like + /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. "(default)" database ID + is also valid if the database is Standard edition. + type: string + pitrSnapshot: + description: >- + Required. Specification of the PITR data to clone from. The source + database must exist. The cloned database will be created in the same + location as the source database. + $ref: '#/components/schemas/GoogleFirestoreAdminV1PitrSnapshot' + encryptionConfig: + description: >- + Optional. Encryption configuration for the cloned database. If this + field is not specified, the cloned database will use the same + encryption configuration as the source database, namely + use_source_encryption. + $ref: '#/components/schemas/GoogleFirestoreAdminV1EncryptionConfig' + tags: + description: >- + Optional. Immutable. Tags to be bound to the cloned database. The + tags should be provided in the format of `tagKeys/{tag_key_id} -> + tagValues/{tag_value_id}`. + type: object + additionalProperties: + type: string + GoogleFirestoreAdminV1PitrSnapshot: + id: GoogleFirestoreAdminV1PitrSnapshot + description: >- + A consistent snapshot of a database at a specific point in time. A PITR + (Point-in-time recovery) snapshot with previous versions of a database's + data is available for every minute up to the associated database's data + retention period. If the PITR feature is enabled, the retention period + is 7 days; otherwise, it is one hour. + type: object + properties: + database: + description: >- + Required. The name of the database that this was a snapshot of. + Format: `projects/{project}/databases/{database}`. + type: string + databaseUid: + description: >- + Output only. Public UUID of the database the snapshot was associated + with. + readOnly: true + type: string + format: byte + snapshotTime: + description: Required. Snapshot time of the database. + type: string + format: google-datetime Document: id: Document description: A Firestore document. Must not exceed 1 MiB - 4 bytes. @@ -2037,8 +2266,8 @@ components: `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. * For EUCLIDEAN, COSINE: - WHERE distance <= distance_threshold * For DOT_PRODUCT: WHERE - distance >= distance_threshold + `WHERE distance <= distance_threshold` * For DOT_PRODUCT: `WHERE + distance >= distance_threshold` type: number format: double ExplainOptions: @@ -2540,7 +2769,7 @@ components: after a target with `target_id=0` is added, the server will immediately send a response with a `TargetChange::Remove` event. Note that if the client sends multiple `AddTarget` requests without - an ID, the order of IDs returned in `TargetChage.target_ids` are + an ID, the order of IDs returned in `TargetChange.target_ids` are undefined. Therefore, clients should provide a target ID instead of relying on the server to assign one. If `target_id` is non-zero, there must not be an existing active target on this stream with the @@ -3350,6 +3579,55 @@ components: How far along the restore is as an estimated percentage of remaining time. $ref: '#/components/schemas/GoogleFirestoreAdminV1Progress' + GoogleFirestoreAdminV1CloneDatabaseMetadata: + id: GoogleFirestoreAdminV1CloneDatabaseMetadata + description: Metadata for the long-running operation from the CloneDatabase request. + type: object + properties: + startTime: + description: The time the clone was started. + type: string + format: google-datetime + endTime: + description: The time the clone finished, unset for ongoing clones. + type: string + format: google-datetime + operationState: + description: The operation state of the clone. + type: string + enumDescriptions: + - Unspecified. + - Request is being prepared for processing. + - Request is actively being processed. + - >- + Request is in the process of being cancelled after user called + google.longrunning.Operations.CancelOperation on the operation. + - Request has been processed and is in its finalization stage. + - Request has completed successfully. + - Request has finished being processed, but encountered an error. + - >- + Request has finished being cancelled after user called + google.longrunning.Operations.CancelOperation. + enum: + - OPERATION_STATE_UNSPECIFIED + - INITIALIZING + - PROCESSING + - CANCELLING + - FINALIZING + - SUCCESSFUL + - FAILED + - CANCELLED + database: + description: The name of the database being cloned to. + type: string + pitrSnapshot: + description: The snapshot from which this database was cloned. + $ref: '#/components/schemas/GoogleFirestoreAdminV1PitrSnapshot' + progressPercentage: + description: >- + How far along the clone is as an estimated percentage of remaining + time. + $ref: '#/components/schemas/GoogleFirestoreAdminV1Progress' parameters: access_token: description: OAuth access token. @@ -3556,6 +3834,12 @@ components: response: mediaType: application/json openAPIDocKey: '200' + clone: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1databases:clone/post' + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/databases/methods/get' @@ -3692,6 +3976,70 @@ components: - $ref: '#/components/x-stackQL-resources/fields/methods/patch' replace: [] delete: [] + user_creds: + id: google.firestore.user_creds + name: user_creds + title: User_creds + methods: + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1databases~1{databasesId}~1userCreds/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1databases~1{databasesId}~1userCreds/get + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1databases~1{databasesId}~1userCreds~1{userCredsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1databases~1{databasesId}~1userCreds~1{userCredsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + enable: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1databases~1{databasesId}~1userCreds~1{userCredsId}:enable/post + response: + mediaType: application/json + openAPIDocKey: '200' + disable: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1databases~1{databasesId}~1userCreds~1{userCredsId}:disable/post + response: + mediaType: application/json + openAPIDocKey: '200' + reset_password: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1databases~1{databasesId}~1userCreds~1{userCredsId}:resetPassword/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/user_creds/methods/get' + - $ref: '#/components/x-stackQL-resources/user_creds/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/user_creds/methods/create' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/user_creds/methods/delete' backup_schedules: id: google.firestore.backup_schedules name: backup_schedules @@ -3947,6 +4295,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: @@ -4439,6 +4791,48 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/databases:clone: + parameters: *ref_1 + post: + description: >- + Creates a new database by cloning an existing one. The new database must + be in the same cloud region or multi-region location as the existing + database. This behaves similar to FirestoreAdmin.CreateDatabase except + instead of creating a new empty database, a new database is created with + the database type, index configuration, and documents from an existing + database. The long-running operation can be used to track the progress + of the clone, with the Operation's metadata field type being the + CloneDatabaseMetadata. The response type is the Database if the clone + was successful. The new database is not readable or writeable until the + LRO has completed. + operationId: firestore.projects.databases.clone + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleFirestoreAdminV1CloneDatabaseRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/datastore + Oauth2c: + - https://www.googleapis.com/auth/datastore + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string /v1/projects/{projectsId}/databases/{databasesId}/operations: parameters: *ref_1 get: @@ -4577,7 +4971,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: firestore.projects.databases.operations.cancel requestBody: content: @@ -4948,6 +5342,283 @@ paths: name: pageToken schema: type: string + /v1/projects/{projectsId}/databases/{databasesId}/userCreds: + parameters: *ref_1 + post: + description: Create a user creds. + operationId: firestore.projects.databases.userCreds.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleFirestoreAdminV1UserCreds' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/datastore + Oauth2c: + - https://www.googleapis.com/auth/datastore + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleFirestoreAdminV1UserCreds' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: databasesId + required: true + schema: + type: string + - in: query + name: userCredsId + schema: + type: string + get: + description: >- + List all user creds in the database. Note that the returned resource + does not contain the secret value itself. + operationId: firestore.projects.databases.userCreds.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/datastore + Oauth2c: + - https://www.googleapis.com/auth/datastore + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleFirestoreAdminV1ListUserCredsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: databasesId + required: true + schema: + type: string + /v1/projects/{projectsId}/databases/{databasesId}/userCreds/{userCredsId}: + parameters: *ref_1 + get: + description: >- + Gets a user creds resource. Note that the returned resource does not + contain the secret value itself. + operationId: firestore.projects.databases.userCreds.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/datastore + Oauth2c: + - https://www.googleapis.com/auth/datastore + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleFirestoreAdminV1UserCreds' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: databasesId + required: true + schema: + type: string + - in: path + name: userCredsId + required: true + schema: + type: string + delete: + description: Deletes a user creds. + operationId: firestore.projects.databases.userCreds.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/datastore + Oauth2c: + - https://www.googleapis.com/auth/datastore + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: databasesId + required: true + schema: + type: string + - in: path + name: userCredsId + required: true + schema: + type: string + /v1/projects/{projectsId}/databases/{databasesId}/userCreds/{userCredsId}:enable: + parameters: *ref_1 + post: + description: Enables a user creds. No-op if the user creds are already enabled. + operationId: firestore.projects.databases.userCreds.enable + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleFirestoreAdminV1EnableUserCredsRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/datastore + Oauth2c: + - https://www.googleapis.com/auth/datastore + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleFirestoreAdminV1UserCreds' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: databasesId + required: true + schema: + type: string + - in: path + name: userCredsId + required: true + schema: + type: string + /v1/projects/{projectsId}/databases/{databasesId}/userCreds/{userCredsId}:disable: + parameters: *ref_1 + post: + description: Disables a user creds. No-op if the user creds are already disabled. + operationId: firestore.projects.databases.userCreds.disable + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleFirestoreAdminV1DisableUserCredsRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/datastore + Oauth2c: + - https://www.googleapis.com/auth/datastore + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleFirestoreAdminV1UserCreds' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: databasesId + required: true + schema: + type: string + - in: path + name: userCredsId + required: true + schema: + type: string + /v1/projects/{projectsId}/databases/{databasesId}/userCreds/{userCredsId}:resetPassword: + parameters: *ref_1 + post: + description: Resets the password of a user creds. + operationId: firestore.projects.databases.userCreds.resetPassword + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleFirestoreAdminV1ResetUserPasswordRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/datastore + Oauth2c: + - https://www.googleapis.com/auth/datastore + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleFirestoreAdminV1UserCreds' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: databasesId + required: true + schema: + type: string + - in: path + name: userCredsId + required: true + schema: + type: string /v1/projects/{projectsId}/databases/{databasesId}/backupSchedules: parameters: *ref_1 post: diff --git a/providers/src/googleapis.com/v00.00.00000/services/geminicloudassist.yaml b/providers/src/googleapis.com/v00.00.00000/services/geminicloudassist.yaml new file mode 100644 index 00000000..d25f0e6b --- /dev/null +++ b/providers/src/googleapis.com/v00.00.00000/services/geminicloudassist.yaml @@ -0,0 +1,2560 @@ +openapi: 3.1.0 +info: + contact: + name: StackQL Studios + url: https://github.com/stackql/google-discovery-to-openapi + email: info@stackql.io + title: Gemini Cloud Assist API + description: 'The AI-powered assistant for Google Cloud. ' + version: v1alpha + x-discovery-doc-revision: '20250821' + x-generated-date: '2025-08-28' +externalDocs: + url: https://cloud.google.com/gemini +servers: + - url: https://geminicloudassist.googleapis.com +components: + securitySchemes: + Oauth2: + type: oauth2 + description: Oauth 2.0 implicit authentication + flows: + implicit: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + scopes: &ref_0 + 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. + Oauth2c: + type: oauth2 + description: Oauth 2.0 authorization code authentication + flows: + authorizationCode: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + tokenUrl: https://accounts.google.com/o/oauth2/token + scopes: *ref_0 + schemas: + InvokeExplainRequest: + id: InvokeExplainRequest + description: Request for InvokeExplain. + type: object + properties: + contents: + description: >- + Optional. Content of the input. It is repeated because it can + contain the history of the conversation. Most recent content is the + last element of the list. + type: array + items: + $ref: '#/components/schemas/Content' + Content: + id: Content + description: >- + A `Content` includes a `role` field designating the producer of the + `Content` and a `parts` field containing multi-part data that contains + the content of the message turn. + type: object + properties: + role: + description: >- + Optional. The producer of the content. Must be either 'user' or + 'model'. Useful to set for multi-turn conversations, otherwise can + be left blank or unset. + type: string + parts: + description: >- + Required. Ordered `Parts` that constitute a single message. In the + future, parts may have different IANA MIME types. + type: array + items: + $ref: '#/components/schemas/Part' + Part: + id: Part + description: >- + A datatype containing media that is part of a multi-part `Content` + message. A `Part` consists of data which has an associated datatype. A + `Part` can only contain one of the accepted types in `Part.data`. + type: object + properties: + text: + description: Optional. Text part (can be code). + type: string + InvokeExplainResponse: + id: InvokeExplainResponse + description: Response for InvokeExplain. + type: object + properties: + content: + description: The output content. + $ref: '#/components/schemas/Content' + ListOperationsResponse: + id: ListOperationsResponse + description: The response message for Operations.ListOperations. + type: object + properties: + operations: + description: >- + A list of operations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/Operation' + nextPageToken: + description: The standard List next-page token. + type: string + Operation: + id: Operation + description: >- + This resource represents a long-running operation that is the result of + a network API call. + type: object + properties: + name: + description: >- + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. + type: string + metadata: + description: >- + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + done: + description: >- + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + type: boolean + error: + description: >- + The error result of the operation in case of failure or + cancellation. + $ref: '#/components/schemas/Status' + response: + description: >- + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + Status: + id: Status + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + type: object + properties: + code: + description: The status code, which should be an enum value of google.rpc.Code. + type: integer + format: int32 + message: + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + type: string + details: + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + type: array + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + Empty: + id: Empty + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + type: object + properties: {} + CancelOperationRequest: + id: CancelOperationRequest + description: The request message for Operations.CancelOperation. + type: object + properties: {} + ListInvestigationsResponse: + id: ListInvestigationsResponse + description: Message for response to listing Investigations + type: object + properties: + investigations: + description: The list of Investigation + type: array + items: + $ref: '#/components/schemas/Investigation' + nextPageToken: + description: A token identifying a page of results the server should return. + type: string + unreachable: + description: Unordered list. Locations that could not be reached. + type: array + items: + type: string + Investigation: + id: Investigation + description: 'Message describing Investigation object Next Id: 24' + type: object + properties: + name: + description: Identifier. name of resource + type: string + createTime: + description: Output only. [Output only] Create time stamp + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. [Output only] Update time stamp + readOnly: true + type: string + format: google-datetime + labels: + description: Optional. Labels as key value pairs + type: object + additionalProperties: + type: string + revision: + description: Output only. [Output only] Current revision of the investigation + readOnly: true + type: string + revisionIndex: + description: >- + Output only. [Output only] Index of the current revision of the + investigation. 1-based. + readOnly: true + type: integer + format: int32 + revisionPredecessor: + description: >- + Optional. The name of the revision that was this revision's + predecessor. The UI, for example, will set this to the existing + revision when when a new revision is created due to an edit. + type: string + annotations: + description: >- + Optional. Annotations on the investigation. Unlike labels, these may + carry semantic meaning in running the investigation, and will not be + read by other systems such as billing. + $ref: '#/components/schemas/InvestigationAnnotations' + executionState: + description: >- + Output only. [Output only] The execution state of this + investigation. + readOnly: true + type: string + enumDescriptions: + - Default value. This value is unused. + - The investigation is being executed. + - >- + The investigation has not yet been executed since the symptom was + last updated. + - >- + The investigation execution has completed, but the execution has + failed. + - >- + All execution tasks have completed and the investigation is at + rest. + enum: + - INVESTIGATION_EXECUTION_STATE_UNSPECIFIED + - INVESTIGATION_EXECUTION_STATE_RUNNING + - INVESTIGATION_EXECUTION_STATE_MODIFIED + - INVESTIGATION_EXECUTION_STATE_FAILED + - INVESTIGATION_EXECUTION_STATE_COMPLETED + error: + description: >- + Output only. [Output only] If the investigation execution state is + FAILED, this field will contain the error message. + readOnly: true + $ref: '#/components/schemas/Status' + operation: + description: >- + Output only. The Run operation most recently performed on the + investigation. + readOnly: true + type: string + title: + description: Required. Human-readable display title for the investigation. + type: string + observations: + description: >- + Optional. A map from observation ID to the observation. This is a + map so that we can cleanly overwrite old observations with the + version from the latest revision. See Observation for guidance on + choosing IDs. + type: object + additionalProperties: + $ref: '#/components/schemas/Observation' + observerStatuses: + description: >- + Optional. Plural version of above. Code will transition to this over + time. + type: object + additionalProperties: + $ref: '#/components/schemas/ObserverStatus' + dataVersion: + description: >- + Optional. The data model version of this Investigation. Should be + either 1 or 2. Treat 0 as 1. If 1, use V1 Investigation data model. + If 2, use the Investigation Observation data model. + type: integer + format: int32 + clarificationsNeeded: + description: >- + Optional. Questions that the system needs to ask the user. The + results will be passed back by the UI as new Observations. The ID + for those observations will be the key of the entry in the + clarifications_needed map. + type: object + additionalProperties: + $ref: '#/components/schemas/ClarificationNeeded' + InvestigationAnnotations: + id: InvestigationAnnotations + description: >- + Additional user-defined annotations on an Investigation. There are some + pre-defined ones, and a map for new applications to add their own. + type: object + properties: + followUp: + description: >- + Output only. Follow-up is required to continue the investigation. + Generally set to true by the troubleshooter and false when the + questions have been answered. + readOnly: true + type: boolean + newlyCreated: + description: >- + Optional. This investigation is been newly created and hasn't been + saved by the user yet. Set to true when an Investigation is created + by an application (like Chat) and false when the user requests + action via the UI. + type: boolean + supportCase: + description: Optional. The support case ID associated with the investigation. + type: string + uiReadOnly: + description: >- + Optional. Whether the UI should disable editing of this + investigation. + type: boolean + uiHidden: + description: >- + Optional. Whether the UI should hide this investigation from its + list. + type: boolean + extrasMap: + description: >- + Optional. Additional annotations required by applications. These + will not be redacted and should NOT contain any CCC/PII. + type: object + additionalProperties: + type: string + componentVersions: + description: >- + Output only. Map of component key to version. Filled in by the run + process. The key is unique to a "component", broadly defined. A + component might be the TAF framework, Titan, a GCA tool, etc. The + version is a string that is unique to a particular release of the + component, e.g., a build label. + readOnly: true + type: object + additionalProperties: + type: string + revisionLastRunInterval: + description: Output only. Start/end time when the revision was last run. + readOnly: true + $ref: '#/components/schemas/Interval' + featureFlags: + description: >- + Output only. Map of feature flag names to their (string-serialized) + values. Filled in by, and at the very start of, the run process. + Treat as immutable for the subsequent life of an investigation run. + readOnly: true + type: object + additionalProperties: + type: string + pagePath: + description: Optional. Page path field set by the UI. + type: string + Interval: + id: Interval + description: >- + Represents a time interval, encoded as a Timestamp start (inclusive) and + a Timestamp end (exclusive). The start must be less than or equal to the + end. When the start equals the end, the interval is empty (matches no + time). When both start and end are unspecified, the interval matches any + time. + type: object + properties: + startTime: + description: >- + Optional. Inclusive start of the interval. If specified, a Timestamp + matching this interval will have to be the same or after the start. + type: string + format: google-datetime + endTime: + description: >- + Optional. Exclusive end of the interval. If specified, a Timestamp + matching this interval will have to be before the end. + type: string + format: google-datetime + Observation: + id: Observation + description: >- + An observation is the basic unit of interchange between user and system, + or between different components of the system. It is the element that + has a relevance. They should therefore be relatively small; if you + expect users to react to "part" of an observation, it should be broken + up into smaller observations. A particular runbook run, a particular + user parameter input, a particular interesting log entry might all be + separate observations. This means there might be dozens or hundreds in + an investigation. Next Id: 26 + type: object + properties: + id: + description: >- + Optional. Uniquely identifies this observation. Should depend on the + 'core content' of the observation, but not e.g. on the relevance. + Should not depend on anything that can vary unpredictably from + revision to revision to run. This is also the map key in the parent + Investigation. They should be hierarchical with '.' as the separator + starting with the name of the observer. So for instance, + diagnostics.runbook.ABC, or signals.logs, or user.input.2 It should + be usable as a URL component. (Case-insensitive [a-z0-9-._]+) These + will not be rendered for users, but will be visible in the data + model. They will be used by Google engineers to localize bugs so + should be semi-readable. + type: string + timeRanges: + description: >- + Optional. When this observation occurred. Observations should have + at least one time range so that the observations can be shown on a + timeline and so we can find related events. For a repeated but not + continuous event, it is appropriate to have more than one range. The + UI may combine these. DEPRECATED: Use time_intervals instead. + deprecated: true + type: array + items: + $ref: '#/components/schemas/TimeRange' + timeIntervals: + description: >- + Optional. When this observation occurred. Observations should have + at least one time range so that the observations can be shown on a + timeline and so we can find related events. For a repeated but not + continuous event, it is appropriate to have more than one range. The + UI may combine these. + type: array + items: + $ref: '#/components/schemas/Interval' + title: + description: >- + Optional. The label shown in the UI. This need not be unique within + an investigation. However, it should be specific and less than 80 + characters so that the user can easily scan across many + observations. "Nettools pod configured with ALL capabilities + dropped" is much better than "Interesting pod configuration". + type: string + observationType: + description: Required. The type of the observation (e.g. log, metric, etc.) + type: string + enumDescriptions: + - >- + Do not use. Specify the type of the observation. Add a new enum if + you need it. + - The text of this observation is a log entry. + - The content of this observation is a metric or group of metrics. + - A config + - A change of config + - An alert + - >- + An event from a continuous integration system, e.g. prober + failure. + - Free text input, such as the initial user input. Can be markdown. + - >- + This is for [tentative] conclusions drawn by the system. These can + become inputs to a subsequent revision. In this case the + recommendations will be used, but not the remediation. + - Structured input, e.g. runbook parameters put into a form + - >- + Used for an observation that includes more than one kind of + evidence, such as a runbook output. + - Runbook output can be 'other' if none of the other types apply. + - Resources we think are related to the investigation. + - A theme discovered in the logs. + - Signals output that includes a config analyzed by LLM. + - Signals output that includes an outage from PSH. + - >- + Text that provides knowledge about a particular user's problem. + For example, error catalog instructions/external links, RAG etc. + enum: + - OBSERVATION_TYPE_UNSPECIFIED + - OBSERVATION_TYPE_CLOUD_LOG + - OBSERVATION_TYPE_CLOUD_METRIC + - OBSERVATION_TYPE_CAIS_CONFIG + - OBSERVATION_TYPE_CAIS_CONFIG_DIFF + - OBSERVATION_TYPE_CLOUD_ALERT + - OBSERVATION_TYPE_CICD_EVENT + - OBSERVATION_TYPE_TEXT_DESCRIPTION + - OBSERVATION_TYPE_HYPOTHESIS + - OBSERVATION_TYPE_STRUCTURED_INPUT + - OBSERVATION_TYPE_COMPOSITE + - OBSERVATION_TYPE_OTHER + - OBSERVATION_TYPE_RELATED_RESOURCES + - OBSERVATION_TYPE_LOG_THEME + - OBSERVATION_TYPE_CONFIG_ANALYSIS + - OBSERVATION_TYPE_OUTAGE + - OBSERVATION_TYPE_KNOWLEDGE + observerType: + description: Required. The origin of the data, e.g. user, system code, LLM etc. + type: string + enumDescriptions: + - >- + Do not use. Specify where the observation came from. Add a new + enum if you need it. + - >- + We separate these for internal attribution reasons. Diagnostics + have an explicit notion of root causes, e.g. via runbooks. + - Signals is for processing that doesn't have explicit root causes. + - >- + This is for code that depends only on premises. In particular, + error catalog lookups. + - >- + This is for AI inferences made along the way that depend only on + observations listed as premises. + - User-input observation, including answers to clarifications. + - An observation from an external-to-GCA alert. + enum: + - OBSERVER_TYPE_UNSPECIFIED + - OBSERVER_TYPE_DIAGNOSTICS + - OBSERVER_TYPE_SIGNALS + - OBSERVER_TYPE_DETERMINISTIC_CODE + - OBSERVER_TYPE_AI + - OBSERVER_TYPE_USER + - OBSERVER_TYPE_ALERT + text: + description: >- + Optional. Natural-language [markdown] text associated with the + observation. This is the core content, not a metadata description. + type: string + data: + description: >- + Optional. A structured representation of the observation, as chosen + by the observer. Optional. If present, an observer SHOULD also + supply a text description of the observation to facilitate + processing by an LLM and rendering in the UI. + type: object + additionalProperties: + type: any + description: Properties of the object. + dataUrls: + description: >- + Optional. A map from human-readable names to URLs for supportive + evidence. The map key will be rendered as URL anchor text. Fill this + in whenever an observation depends on a thing outside the system. + For example, logging/metrics/etc query that can regenerate the + observation. + type: object + additionalProperties: + type: string + knowledgeUrls: + description: Optional. A map from human-readable names to URLs for documentation. + type: object + additionalProperties: + type: string + baseObservations: + description: >- + Optional. The ids of other observations that this observation is + based on. For example, a conclusion observation will record the + observations that were used to generate it. An extracted param will + record what it was extracted from. The graph of premises and + conclusions will be acyclic within a revision. + type: array + items: + type: string + relevantResources: + description: >- + Optional. The Google Cloud resources relevant to the observation. + These should be fully qualified resource URIs, e.g., + "//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance" + type: array + items: + type: string + recommendation: + description: >- + Optional. Natural language [markdown] text which describes a + recommended action to remediate / fix the root cause. This is free + form and not machine- processed at this time. A recommendation can + be: - High-level remediation descriptions - Specific and tactical + remediation steps with executable commands - Specific and tactical + troubleshooting steps for where to investigate next with executable + commands + type: string + systemRelevanceScore: + description: >- + Optional. How relevant this observation is to the investigation, as + inferred by the system. Optional. Should be in the range [-1, 1]. + For OBSERVATION_TYPE_HYPOTHESIS, represents confidence in the + explanation. Only root-cause hypotheses are ranked against each + other. For other ObservationTypes, this represents a relevance + score, and they are ranked against each other. A value of 0 is + neutral. + type: number + format: float + relevanceOverride: + description: Optional. The user's relevance judgement. + type: string + enumDescriptions: + - >- + The user has not marked this observation as relevant or + irrelevant. + - The user marked this observation as relevant. + - The user marked this observation as irrelevant. + enum: + - USER_RELEVANCE_UNSPECIFIED + - USER_RELEVANCE_PROMOTED + - USER_RELEVANCE_REJECTED + observerErrors: + description: >- + Output only. An error within the Investigation system that blocked + an observer from making a particular observation. The error string + here will be shown to users. Repeated because an observer might lack + multiple permissions. Deprecated: Use ObserverStatus.observer_errors + instead. + readOnly: true + deprecated: true + type: array + items: + $ref: '#/components/schemas/Status' + observationCompletionState: + description: >- + Optional. An ObservationCompletionState represents whether the + emitted observation is fully formed and should be shown the to the + user. This is intended to allow hiding observations that are in an + intermediate state. + type: string + enumDescriptions: + - Do not use. + - >- + This observation is fully formed and should be shown the to the + user. + - >- + This observation is missing some information, or needs further + processing by a different observer. This type of Observation + should not be persisted into future investigation revisions. + enum: + - OBSERVATION_COMPLETION_STATE_UNSPECIFIED + - OBSERVATION_COMPLETION_STATE_COMPLETE + - OBSERVATION_COMPLETION_STATE_INCOMPLETE + observedNormalOperation: + description: >- + Optional. Whether this observation gives us information about an + issue / root cause (false) or indicates normal operation (true). + This is conceptually different from the relevance and used + differently. An irrelevant observation should be hidden from the LLM + and also the user. A relevant observation of a problem should be + shown as an observation and should motivate a hypothesis. A relevant + finding of normalcy may / may not be shown in the UI, but should be + used by the LLM to filter out hypotheses that are refuted by the + finding. + type: boolean + TimeRange: + id: TimeRange + description: >- + Represents a time range at which an observation applies DEPRECATED: Use + google.type.Interval instead. + type: object + properties: + startTime: + description: >- + When this observation began applying. Use 'now' if the observer is + just looking at the current state of Google Cloud. + deprecated: true + type: string + format: google-datetime + endTime: + description: >- + If end is unspecified, that implies that it continues to the + present. Use end==start for a single moment. + deprecated: true + type: string + format: google-datetime + ObserverStatus: + id: ObserverStatus + description: >- + An ObserverStatus represents the status of an observer at a particular + point during execution of an investigation. NOTE: By default, nothing in + this message is redacted. Components should NOT put PII / CCC here + except where redacted. Next Id: 13 + type: object + properties: + observer: + description: >- + Optional. The ID of the observer that this status is for. Observer + IDs should be human-readable and hierarchical, e.g. + "signals.logs.firewall_rules" or "diagnostics.error_catalog". + type: string + observerExecutionState: + description: Optional. The current execution state of the observer. + type: string + enumDescriptions: + - The observer state is unspecified. + - The investigation has not yet started. + - >- + The investigation is running and this observer is runnable or + running. + - The observer has finished without an internal error. + - >- + The observer tried to run but failed due to an error. This is + specific to a component and may be rendered in the UI if the + observation is shown, as very low priority. + - The observer is blocked pending an input. + - >- + The observer reports an error that blocks or severely impacts the + investigation, for example CAIS or logging disabled. Should be + rendered in the UI prominently. + - >- + The observer reports an error that degrades the investigation, may + require user to escalate or re-run the investigation after + mitigating the cause. + enum: + - OBSERVER_EXECUTION_UNSPECIFIED + - OBSERVER_EXECUTION_NOT_STARTED + - OBSERVER_EXECUTION_RUNNING + - OBSERVER_EXECUTION_COMPLETE + - OBSERVER_EXECUTION_FAILED + - OBSERVER_EXECUTION_BLOCKED + - OBSERVER_EXECUTION_INVESTIGATION_BLOCKED + - OBSERVER_EXECUTION_INVESTIGATION_DEGRADED + observerDisplayName: + description: >- + Required. The name to show the user when describing this observer. + Note that the UI might replace this with an internationalized + counterpart, so it should not be generated dynamically. Required so + that the user can see which observer (e.g. runbook) the system is + talking about. + type: string + updateTime: + description: >- + Optional. The time when the status was updated. Optional because the + observer is responsible for setting it. Becomes end_time when the + observer is complete. + type: string + format: google-datetime + startTime: + description: >- + Optional. The time when the observer started. Optional because the + observer is responsible for setting it. When the observer is + finished, the difference between this and update_time is the + observer run time. + type: string + format: google-datetime + updateComment: + description: >- + Optional. A status update from the observer. May be logged for + debugging purposes. These may be shown to users. A good update would + be "parameters matched, queued for execution" or "checked log file + 2/5". + type: string + absentObservations: + description: >- + Optional. The IDs of any predicate observations that would be needed + to run this observer, but are missing. Runbook parameters are the + motivating example. An observer must not emit an ID corresponding to + an existing observation. + type: array + items: + $ref: '#/components/schemas/AbsentObservation' + observerErrors: + description: >- + Optional. An error within the Investigation system that blocked an + observer from making a particular observation. The error string here + will be shown to users. Repeated because an observer might lack + multiple permissions. + type: array + items: + $ref: '#/components/schemas/Status' + AbsentObservation: + id: AbsentObservation + description: >- + An identifier of an observation that is needed. Typically a parameter + but extensible to other cases. + type: object + properties: + param: + description: Optional. A runbook parameter. + type: string + generalMissingObservation: + description: >- + Optional. A missing observation that the user could supply that is + not a runbook parameter. + $ref: '#/components/schemas/GeneralAbsentObservation' + pendingObservation: + description: >- + Optional. An observation that is not yet created that an observer + should create by running. This might prompt the system to execute a + runbook. + type: string + GeneralAbsentObservation: + id: GeneralAbsentObservation + description: An absent observation that is not a runbook parameter. + type: object + properties: + id: + description: Optional. The ID of the missing observation. + type: string + title: + description: Optional. The title to display in the UI + type: string + validationRegex: + description: >- + Optional. The regex that the answer must match. Must conform to + JavaScript's regular expression string pattern syntax. See + https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/RegExp#syntax + type: string + ClarificationNeeded: + id: ClarificationNeeded + description: A clarification needed by the system. + type: object + properties: + runbookParameter: + description: >- + Optional. The result of a clarification is an observation. A runbook + parameter that the user needs to provide. + $ref: '#/components/schemas/RunbookParameter' + generalMissingObservation: + description: Optional. A missing observation that is not a runbook parameter. + $ref: '#/components/schemas/GeneralAbsentObservation' + parentObserverNames: + description: >- + Optional. The display names of the observers that asked for this + clarification. The UI will group by these names. + type: array + items: + type: string + RunbookParameter: + id: RunbookParameter + description: Parameter metadata for runbooks updated by the Diagnostic task. + type: object + properties: + id: + description: Optional. The name of the parameter. + type: string + displayName: + description: Optional. The name of the parameter to be displayed to the user. + type: string + description: + description: Optional. The description of the parameter. + type: string + exampleValues: + description: Optional. Examples of the parameter value. + type: array + items: + type: string + value: + description: Optional. The value of the parameter if available. + type: string + associatedAssetTypes: + description: >- + Optional. If present, a list of resource types that this parameter + might be. For example, "compute.googleapis.com/Instance". + type: array + items: + type: string + ListInvestigationRevisionsResponse: + id: ListInvestigationRevisionsResponse + description: Message for response to listing revisions of a given Investigation + type: object + properties: + revisions: + description: The list of Investigation revisions + type: array + items: + $ref: '#/components/schemas/InvestigationRevision' + nextPageToken: + description: A token identifying a page of results the server should return. + type: string + unreachable: + description: Unordered list. Locations that could not be reached. + type: array + items: + type: string + InvestigationRevision: + id: InvestigationRevision + description: Message describing a revision of an Investigation + type: object + properties: + name: + description: Identifier. name of resource + type: string + snapshot: + description: >- + Optional. [Output only] Snapshot of the investigation contents at + this revision + $ref: '#/components/schemas/Investigation' + createTime: + description: Output only. [Output only] Create time stamp + readOnly: true + type: string + format: google-datetime + labels: + description: Optional. Labels as key value pairs + type: object + additionalProperties: + type: string + index: + description: Output only. Revision index number, in order of creation. + readOnly: true + type: integer + format: int32 + RunInvestigationRevisionRequest: + id: RunInvestigationRevisionRequest + description: Request for running an investigation at a particular revision. + type: object + properties: + runParameters: + description: Optional. Parameters to pass through to Titan. + $ref: '#/components/schemas/InvestigationRunParameters' + updatedRevision: + description: Optional. Revision to update before running. + $ref: '#/components/schemas/InvestigationRevision' + updateMask: + description: >- + Optional. The fields of the revision to update. Note that only + user-writeable fields can be updated. + type: string + format: google-fieldmask + InvestigationRunParameters: + id: InvestigationRunParameters + description: Represents user parameters for running an investigation. + type: object + properties: + accessTokens: + description: >- + Optional. If populated, map of project to access token for + TSE-triggered investigations. + type: object + additionalProperties: + type: string + ListLocationsResponse: + id: ListLocationsResponse + description: The response message for Locations.ListLocations. + type: object + properties: + locations: + description: >- + A list of locations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/Location' + nextPageToken: + description: The standard List next-page token. + type: string + Location: + id: Location + description: A resource that represents a Google Cloud location. + type: object + properties: + name: + description: >- + Resource name for the location, which may vary between + implementations. For example: + `"projects/example-project/locations/us-east1"` + type: string + locationId: + description: 'The canonical id for this location. For example: `"us-east1"`.' + type: string + displayName: + description: >- + The friendly name for this location, typically a nearby city name. + For example, "Tokyo". + type: string + labels: + description: >- + Cross-service attributes for the location. For example + {"cloud.googleapis.com/region": "us-east1"} + type: object + additionalProperties: + type: string + metadata: + description: >- + Service-specific metadata. For example the available capacity at the + given location. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + SetIamPolicyRequest: + id: SetIamPolicyRequest + description: Request message for `SetIamPolicy` method. + type: object + properties: + policy: + description: >- + REQUIRED: The complete policy to be applied to the `resource`. The + size of the policy is limited to a few 10s of KB. An empty policy is + a valid policy but certain Google Cloud services (such as Projects) + might reject them. + $ref: '#/components/schemas/Policy' + updateMask: + description: >- + OPTIONAL: A FieldMask specifying which fields of the policy to + modify. Only the fields in the mask will be modified. If no mask is + provided, the following default mask is used: `paths: "bindings, + etag"` + type: string + format: google-fieldmask + Policy: + id: Policy + description: >- + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. A `Policy` is a collection of + `bindings`. A `binding` binds one or more `members`, or principals, to a + single `role`. Principals can be user accounts, service accounts, Google + groups, and domains (such as G Suite). A `role` is a named list of + permissions; each `role` can be an IAM predefined role or a user-created + custom role. For some types of Google Cloud resources, a `binding` can + also specify a `condition`, which is a logical expression that allows + access to a resource only if the expression evaluates to `true`. A + condition can add constraints based on attributes of the request, the + resource, or both. To learn which resources support conditions in their + IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + **JSON example:** ``` { "bindings": [ { "role": + "roles/resourcemanager.organizationAdmin", "members": [ + "user:mike@example.com", "group:admins@example.com", + "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { + "role": "roles/resourcemanager.organizationViewer", "members": [ + "user:eve@example.com" ], "condition": { "title": "expirable access", + "description": "Does not grant access after Sep 2020", "expression": + "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": + "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - + members: - user:mike@example.com - group:admins@example.com - + domain:google.com - + serviceAccount:my-project-id@appspot.gserviceaccount.com role: + roles/resourcemanager.organizationAdmin - members: - + user:eve@example.com role: roles/resourcemanager.organizationViewer + condition: title: expirable access description: Does not grant access + after Sep 2020 expression: request.time < + timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` + For a description of IAM and its features, see the [IAM + documentation](https://cloud.google.com/iam/docs/). + type: object + properties: + 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). + type: integer + format: int32 + bindings: + description: >- + Associates a list of `members`, or principals, with a `role`. + Optionally, may specify a `condition` that determines how and when + the `bindings` are applied. Each of the `bindings` must contain at + least one principal. The `bindings` in a `Policy` can refer to up to + 1,500 principals; up to 250 of these principals can be Google + groups. Each occurrence of a principal counts towards these limits. + For example, if the `bindings` grant 50 different roles to + `user:alice@example.com`, and not to any other principal, then you + can add another 1,450 principals to the `bindings` in the `Policy`. + type: array + items: + $ref: '#/components/schemas/Binding' + auditConfigs: + description: Specifies cloud audit logging configuration for this policy. + type: array + items: + $ref: '#/components/schemas/AuditConfig' + 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. + type: string + format: byte + Binding: + id: Binding + description: Associates `members`, or principals, with a `role`. + type: object + properties: + role: + description: >- + Role that is assigned to the list of `members`, or principals. For + example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an + overview of the IAM roles and permissions, see the [IAM + documentation](https://cloud.google.com/iam/docs/roles-overview). + For a list of the available pre-defined roles, see + [here](https://cloud.google.com/iam/docs/understanding-roles). + type: string + members: + description: >- + Specifies the principals requesting access for a Google Cloud + 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. Does not include identities + that come from external identity providers (IdPs) through identity + federation. * `user:{emailid}`: An email address that represents a + specific Google account. For example, `alice@example.com` . * + `serviceAccount:{emailid}`: An email address that represents a + Google service account. For example, + `my-other-app@appspot.gserviceaccount.com`. * + `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: + An identifier for a [Kubernetes service + account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). + For example, + `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * + `group:{emailid}`: An email address that represents a Google group. + For example, `admins@example.com`. * `domain:{domain}`: The G Suite + domain (primary) that represents all the users of that domain. For + example, `google.com` or `example.com`. * + `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workforce identity pool. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: + All workforce identities in a group. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All workforce identities with a specific attribute value. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: + All identities in a workforce identity pool. * + `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workload identity pool. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: + A workload identity pool group. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All identities in a workload identity pool with a certain attribute. + * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: + All identities in a workload identity pool. * + `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. * + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + Deleted single identity in a workforce identity pool. For example, + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + type: array + items: + type: string + condition: + description: >- + The condition that is associated with this binding. If the condition + evaluates to `true`, then this binding applies to the current + request. If the condition evaluates to `false`, then this binding + does not apply to the current request. However, a different role + binding might grant the same role to one or more of the principals + in this binding. To learn which resources support conditions in + their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + $ref: '#/components/schemas/Expr' + Expr: + id: 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. + type: object + properties: + expression: + description: >- + Textual representation of an expression in Common Expression + Language syntax. + 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 + 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 + 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 + AuditConfig: + id: 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. + type: object + properties: + 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 + auditLogConfigs: + description: The configuration for logging of each type of permission. + type: array + items: + $ref: '#/components/schemas/AuditLogConfig' + AuditLogConfig: + id: 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. + type: object + properties: + logType: + description: The log type that this config enables. + type: string + enumDescriptions: + - Default case. Should never be this. + - 'Admin reads. Example: CloudIAM getIamPolicy' + - 'Data writes. Example: CloudSQL Users create' + - 'Data reads. Example: CloudSQL Users list' + enum: + - LOG_TYPE_UNSPECIFIED + - ADMIN_READ + - DATA_WRITE + - DATA_READ + exemptedMembers: + description: >- + Specifies the identities that do not cause logging for this type of + permission. Follows the same format of Binding.members. + type: array + items: + type: string + TestIamPermissionsRequest: + id: TestIamPermissionsRequest + description: Request message for `TestIamPermissions` method. + type: object + properties: + permissions: + description: >- + The set of permissions to check for the `resource`. Permissions with + wildcards (such as `*` or `storage.*`) are not allowed. For more + information see [IAM + Overview](https://cloud.google.com/iam/docs/overview#permissions). + type: array + items: + type: string + TestIamPermissionsResponse: + id: TestIamPermissionsResponse + description: Response message for `TestIamPermissions` method. + type: object + properties: + permissions: + description: >- + A subset of `TestPermissionsRequest.permissions` that the caller is + allowed. + type: array + items: + type: string + OperationMetadata: + id: OperationMetadata + description: Represents the metadata of the long-running operation. + type: object + properties: + createTime: + description: Output only. The time the operation was created. + readOnly: true + type: string + format: google-datetime + endTime: + description: Output only. The time the operation finished running. + readOnly: true + type: string + format: google-datetime + target: + description: >- + Output only. Server-defined resource path for the target of the + operation. + readOnly: true + type: string + verb: + description: Output only. Name of the verb executed by the operation. + readOnly: true + type: string + statusMessage: + description: Output only. Human-readable status of the operation, if any. + readOnly: true + type: string + requestedCancellation: + description: >- + Output only. Identifies whether the user has requested cancellation + of the operation. Operations that have been cancelled successfully + have Operation.error value with a google.rpc.Status.code of 1, + corresponding to `Code.CANCELLED`. + readOnly: true + type: boolean + apiVersion: + description: Output only. API version used to start the operation. + readOnly: true + type: string + parameters: + 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: + type: string + enum: + - json + - media + - proto + 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 + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + x-stackQL-resources: + locations: + id: google.geminicloudassist.locations + name: locations + title: Locations + methods: + list: + operation: + $ref: '#/paths/~1v1alpha~1projects~1{projectsId}~1locations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.locations + get: + operation: + $ref: >- + #/paths/~1v1alpha~1projects~1{projectsId}~1locations~1{locationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + instances: + id: google.geminicloudassist.instances + name: instances + title: Instances + methods: + invoke_explain: + operation: + $ref: >- + #/paths/~1v1alpha~1projects~1{projectsId}~1locations~1{locationsId}~1instances~1{instancesId}:invokeExplain/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + operations: + id: google.geminicloudassist.operations + name: operations + title: Operations + methods: + list: + operation: + $ref: >- + #/paths/~1v1alpha~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.operations + get: + operation: + $ref: >- + #/paths/~1v1alpha~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1alpha~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + cancel: + operation: + $ref: >- + #/paths/~1v1alpha~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' + insert: [] + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/operations/methods/delete' + investigations: + id: google.geminicloudassist.investigations + name: investigations + title: Investigations + methods: + list: + operation: + $ref: >- + #/paths/~1v1alpha~1projects~1{projectsId}~1locations~1{locationsId}~1investigations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.investigations + create: + operation: + $ref: >- + #/paths/~1v1alpha~1projects~1{projectsId}~1locations~1{locationsId}~1investigations/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1alpha~1projects~1{projectsId}~1locations~1{locationsId}~1investigations~1{investigationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1alpha~1projects~1{projectsId}~1locations~1{locationsId}~1investigations~1{investigationsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1alpha~1projects~1{projectsId}~1locations~1{locationsId}~1investigations~1{investigationsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/investigations/methods/get' + - $ref: '#/components/x-stackQL-resources/investigations/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/investigations/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/investigations/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/investigations/methods/delete' + investigations_iam_policies: + id: google.geminicloudassist.investigations_iam_policies + name: investigations_iam_policies + title: Investigations_iam_policies + methods: + set_iam_policy: + operation: + $ref: >- + #/paths/~1v1alpha~1projects~1{projectsId}~1locations~1{locationsId}~1investigations~1{investigationsId}:setIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + get_iam_policy: + operation: + $ref: >- + #/paths/~1v1alpha~1projects~1{projectsId}~1locations~1{locationsId}~1investigations~1{investigationsId}:getIamPolicy/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.bindings + test_iam_permissions: + operation: + $ref: >- + #/paths/~1v1alpha~1projects~1{projectsId}~1locations~1{locationsId}~1investigations~1{investigationsId}:testIamPermissions/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/investigations_iam_policies/methods/get_iam_policy + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/investigations_iam_policies/methods/set_iam_policy + delete: [] + revisions: + id: google.geminicloudassist.revisions + name: revisions + title: Revisions + methods: + list: + operation: + $ref: >- + #/paths/~1v1alpha~1projects~1{projectsId}~1locations~1{locationsId}~1investigations~1{investigationsId}~1revisions/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.revisions + create: + operation: + $ref: >- + #/paths/~1v1alpha~1projects~1{projectsId}~1locations~1{locationsId}~1investigations~1{investigationsId}~1revisions/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1alpha~1projects~1{projectsId}~1locations~1{locationsId}~1investigations~1{investigationsId}~1revisions~1{revisionsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1alpha~1projects~1{projectsId}~1locations~1{locationsId}~1investigations~1{investigationsId}~1revisions~1{revisionsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1alpha~1projects~1{projectsId}~1locations~1{locationsId}~1investigations~1{investigationsId}~1revisions~1{revisionsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + run: + operation: + $ref: >- + #/paths/~1v1alpha~1projects~1{projectsId}~1locations~1{locationsId}~1investigations~1{investigationsId}~1revisions~1{revisionsId}:run/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/revisions/methods/get' + - $ref: '#/components/x-stackQL-resources/revisions/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/revisions/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/revisions/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/revisions/methods/delete' +paths: + /v1alpha/projects/{projectsId}/locations: + parameters: &ref_1 + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' + get: + description: Lists information about the supported locations for this service. + operationId: geminicloudassist.projects.locations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListLocationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: extraLocationTypes + schema: + type: string + /v1alpha/projects/{projectsId}/locations/{locationsId}: + parameters: *ref_1 + get: + description: Gets information about a location. + operationId: geminicloudassist.projects.locations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Location' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1alpha/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:invokeExplain: + parameters: *ref_1 + post: + description: Invokes Explain with Gemini Cloud Assist. + operationId: geminicloudassist.projects.locations.instances.invokeExplain + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InvokeExplainRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/InvokeExplainResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + /v1alpha/projects/{projectsId}/locations/{locationsId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: geminicloudassist.projects.locations.operations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListOperationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: geminicloudassist.projects.locations.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + delete: + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: geminicloudassist.projects.locations.operations.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + `1`, corresponding to `Code.CANCELLED`. + operationId: geminicloudassist.projects.locations.operations.cancel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CancelOperationRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1alpha/projects/{projectsId}/locations/{locationsId}/investigations: + parameters: *ref_1 + get: + description: Lists Investigations in a given project and location. + operationId: geminicloudassist.projects.locations.investigations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListInvestigationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + post: + description: Creates a new Investigation in a given project and location. + operationId: geminicloudassist.projects.locations.investigations.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Investigation' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Investigation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: investigationId + schema: + type: string + - in: query + name: requestId + schema: + type: string + /v1alpha/projects/{projectsId}/locations/{locationsId}/investigations/{investigationsId}: + parameters: *ref_1 + get: + description: Gets details of a single Investigation. + operationId: geminicloudassist.projects.locations.investigations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Investigation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: investigationsId + required: true + schema: + type: string + patch: + description: Updates the parameters of a single Investigation. + operationId: geminicloudassist.projects.locations.investigations.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Investigation' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Investigation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: investigationsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: requestId + schema: + type: string + delete: + description: Deletes a single Investigation. + operationId: geminicloudassist.projects.locations.investigations.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: investigationsId + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + /v1alpha/projects/{projectsId}/locations/{locationsId}/investigations/{investigationsId}:setIamPolicy: + parameters: *ref_1 + post: + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and + `PERMISSION_DENIED` errors. + operationId: geminicloudassist.projects.locations.investigations.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetIamPolicyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: investigationsId + required: true + schema: + type: string + /v1alpha/projects/{projectsId}/locations/{locationsId}/investigations/{investigationsId}:getIamPolicy: + parameters: *ref_1 + get: + description: >- + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: geminicloudassist.projects.locations.investigations.getIamPolicy + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: investigationsId + required: true + schema: + type: string + - in: query + name: options.requestedPolicyVersion + schema: + type: integer + format: int32 + /v1alpha/projects/{projectsId}/locations/{locationsId}/investigations/{investigationsId}:testIamPermissions: + parameters: *ref_1 + post: + description: >- + Returns permissions that a caller has on the specified resource. If the + resource does not exist, this will return an empty set of permissions, + not a `NOT_FOUND` error. Note: This operation is designed to be used for + building permission-aware UIs and command-line tools, not for + authorization checking. This operation may "fail open" without warning. + operationId: geminicloudassist.projects.locations.investigations.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: investigationsId + required: true + schema: + type: string + /v1alpha/projects/{projectsId}/locations/{locationsId}/investigations/{investigationsId}/revisions: + parameters: *ref_1 + get: + description: Lists Investigations in a given project and location. + operationId: geminicloudassist.projects.locations.investigations.revisions.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListInvestigationRevisionsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: investigationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + post: + description: Creates a new revision of a given Investigation. + operationId: geminicloudassist.projects.locations.investigations.revisions.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InvestigationRevision' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/InvestigationRevision' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: investigationsId + required: true + schema: + type: string + - in: query + name: investigationRevisionId + schema: + type: string + - in: query + name: requestId + schema: + type: string + /v1alpha/projects/{projectsId}/locations/{locationsId}/investigations/{investigationsId}/revisions/{revisionsId}: + parameters: *ref_1 + get: + description: Gets details of a single revision of an Investigation. + operationId: geminicloudassist.projects.locations.investigations.revisions.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/InvestigationRevision' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: investigationsId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string + delete: + description: >- + Deletes a single revision of an Investigation. Fails if the revision is + the investigation's active revision. + operationId: geminicloudassist.projects.locations.investigations.revisions.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: investigationsId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + patch: + description: Updates the parameters of a single Investigation. + operationId: geminicloudassist.projects.locations.investigations.revisions.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InvestigationRevision' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/InvestigationRevision' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: investigationsId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: requestId + schema: + type: string + /v1alpha/projects/{projectsId}/locations/{locationsId}/investigations/{investigationsId}/revisions/{revisionsId}:run: + parameters: *ref_1 + post: + description: Run an existing revision of an investigation. + operationId: geminicloudassist.projects.locations.investigations.revisions.run + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RunInvestigationRevisionRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: investigationsId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/gkebackup.yaml b/providers/src/googleapis.com/v00.00.00000/services/gkebackup.yaml index 01643013..74b38546 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/gkebackup.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/gkebackup.yaml @@ -9,8 +9,8 @@ info: Backup for GKE is a managed Kubernetes workload backup and restore service for GKE clusters. version: v1 - x-discovery-doc-revision: '20241016' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250813' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke servers: @@ -267,7 +267,9 @@ components: stateReason: description: >- Output only. Human-readable description of why BackupPlan is in the - current `state` + current `state`. This field is only meant for human readability and + should not be used programmatically as this field is not guaranteed + to be consistent. readOnly: true type: string rpoRiskLevel: @@ -284,6 +286,23 @@ components: the current rpo_risk_level and action items if any. readOnly: true type: string + backupChannel: + description: >- + Output only. The fully qualified name of the BackupChannel to be + used to create a backup. This field is set only if the cluster being + backed up is in a different project. + `projects/*/locations/*/backupChannels/*` + readOnly: true + type: string + lastSuccessfulBackupTime: + description: >- + Output only. Completion time of the last successful Backup. This is + sourced from a successful Backup's complete_time field. This field + is added to maintain consistency with BackupPlanBinding to display + last successful backup time. + readOnly: true + type: string + format: google-datetime RetentionPolicy: id: RetentionPolicy description: RetentionPolicy defines a Backup retention policy for a BackupPlan. @@ -539,6 +558,11 @@ components: If set, include just the resources referenced by the listed ProtectedApplications. $ref: '#/components/schemas/NamespacedNames' + selectedNamespaceLabels: + description: >- + If set, the list of labels whose constituent namespaces were + included in the Backup. + $ref: '#/components/schemas/ResourceLabels' includeVolumeData: description: >- Optional. This flag specifies whether volume data should be backed @@ -594,6 +618,27 @@ components: name: description: Optional. The name of the Kubernetes resource. type: string + ResourceLabels: + id: ResourceLabels + description: A list of Kubernetes labels. + type: object + properties: + resourceLabels: + description: Optional. A list of Kubernetes label-value pairs. + type: array + items: + $ref: '#/components/schemas/Label' + Label: + id: Label + description: A single Kubernetes label-value pair. + type: object + properties: + key: + description: Optional. The key/name of the label. + type: string + value: + description: Optional. The value of the label. + type: string EncryptionKey: id: EncryptionKey description: >- @@ -627,6 +672,332 @@ components: type: array items: type: string + BackupChannel: + id: BackupChannel + description: >- + A BackupChannel imposes constraints on where clusters can be backed up. + The BackupChannel should be in the same project and region as the + cluster being backed up. The backup can be created only in + destination_project. + type: object + properties: + name: + description: >- + Identifier. The fully qualified name of the BackupChannel. + `projects/*/locations/*/backupChannels/*` + type: string + destinationProject: + description: >- + Required. Immutable. The project where Backups are allowed to be + stored. The format is `projects/{projectId}` or + `projects/{projectNumber}`. + type: string + uid: + description: >- + Output only. Server generated global unique identifier of + [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) + format. + readOnly: true + type: string + createTime: + description: >- + Output only. The timestamp when this BackupChannel resource was + created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: >- + Output only. The timestamp when this BackupChannel resource was last + updated. + readOnly: true + type: string + format: google-datetime + labels: + description: Optional. A set of custom labels supplied by user. + type: object + additionalProperties: + type: string + description: + description: Optional. User specified descriptive string for this BackupChannel. + type: string + etag: + description: >- + Output only. `etag` is used for optimistic concurrency control as a + way to help prevent simultaneous updates of a BackupChannel from + overwriting each other. It is strongly suggested that systems make + use of the 'etag' in the read-modify-write cycle to perform + BackupChannel updates in order to avoid race conditions: An `etag` + is returned in the response to `GetBackupChannel`, and systems are + expected to put that etag in the request to `UpdateBackupChannel` or + `DeleteBackupChannel` to ensure that their change will be applied to + the same version of the resource. + readOnly: true + type: string + destinationProjectId: + description: >- + Output only. The project_id where Backups are allowed to be stored. + Example Project ID: "my-project-id". This will be an OUTPUT_ONLY + field to return the project_id of the destination project. + readOnly: true + type: string + ListBackupChannelsResponse: + id: ListBackupChannelsResponse + description: Response message for ListBackupChannels. + type: object + properties: + backupChannels: + description: The list of BackupChannels matching the given criteria. + type: array + items: + $ref: '#/components/schemas/BackupChannel' + nextPageToken: + description: >- + A token which may be sent as page_token in a subsequent + `ListBackupChannels` call to retrieve the next page of results. If + this field is omitted or empty, then there are no more results to + return. + type: string + unreachable: + description: Locations that could not be reached. + type: array + items: + type: string + ListBackupPlanBindingsResponse: + id: ListBackupPlanBindingsResponse + description: Response message for ListBackupPlanBindings. + type: object + properties: + backupPlanBindings: + description: The list of BackupPlanBindings matching the given criteria. + type: array + items: + $ref: '#/components/schemas/BackupPlanBinding' + nextPageToken: + description: >- + A token which may be sent as page_token in a subsequent + `ListBackupPlanBindingss` call to retrieve the next page of results. + If this field is omitted or empty, then there are no more results to + return. + type: string + unreachable: + description: Locations that could not be reached. + type: array + items: + type: string + BackupPlanBinding: + id: BackupPlanBinding + description: >- + A BackupPlanBinding binds a BackupPlan with a BackupChannel. This + resource is created automatically when a BackupPlan is created using a + BackupChannel. This also serves as a holder for cross-project fields + that need to be displayed in the current project. + type: object + properties: + name: + description: >- + Identifier. The fully qualified name of the BackupPlanBinding. + `projects/*/locations/*/backupChannels/*/backupPlanBindings/*` + type: string + uid: + description: >- + Output only. Server generated global unique identifier of + [UUID4](https://en.wikipedia.org/wiki/Universally_unique_identifier) + readOnly: true + type: string + createTime: + description: Output only. The timestamp when this binding was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. The timestamp when this binding was created. + readOnly: true + type: string + format: google-datetime + backupPlan: + description: >- + Output only. Immutable. The fully qualified name of the BackupPlan + bound with the parent BackupChannel. + `projects/*/locations/*/backupPlans/{backup_plan}` + readOnly: true + type: string + cluster: + description: >- + Output only. Immutable. The fully qualified name of the cluster that + is being backed up Valid formats: - + `projects/*/locations/*/clusters/*` - + `projects/*/zones/*/clusters/*` + readOnly: true + type: string + backupPlanDetails: + description: Output only. Contains details about the backup plan/backup. + readOnly: true + $ref: '#/components/schemas/BackupPlanDetails' + etag: + description: >- + Output only. `etag` is used for optimistic concurrency control as a + way to help prevent simultaneous updates of a BackupPlanBinding from + overwriting each other. It is strongly suggested that systems make + use of the 'etag' in the read-modify-write cycle to perform + BackupPlanBinding updates in order to avoid race conditions: An + `etag` is returned in the response to `GetBackupPlanBinding`, and + systems are expected to put that etag in the request to + `UpdateBackupPlanBinding` or `DeleteBackupPlanBinding` to ensure + that their change will be applied to the same version of the + resource. + readOnly: true + type: string + BackupPlanDetails: + id: BackupPlanDetails + description: Contains metadata about the backup plan/backup. + type: object + properties: + protectedPodCount: + description: >- + Output only. The number of Kubernetes Pods backed up in the last + successful Backup created via this BackupPlan. + readOnly: true + type: integer + format: int32 + state: + description: Output only. State of the BackupPlan. + readOnly: true + type: string + enumDescriptions: + - Default first value for Enums. + - Waiting for cluster state to be RUNNING. + - The BackupPlan is in the process of being created. + - >- + The BackupPlan has successfully been created and is ready for + Backups. + - BackupPlan creation has failed. + - The BackupPlan has been deactivated. + - The BackupPlan is in the process of being deleted. + enum: + - STATE_UNSPECIFIED + - CLUSTER_PENDING + - PROVISIONING + - READY + - FAILED + - DEACTIVATED + - DELETING + lastSuccessfulBackupTime: + description: >- + Output only. Completion time of the last successful Backup. This is + sourced from a successful Backup's complete_time field. + readOnly: true + type: string + format: google-datetime + nextScheduledBackupTime: + description: >- + Output only. Start time of next scheduled backup under this + BackupPlan by either cron_schedule or rpo config. This is sourced + from BackupPlan. + readOnly: true + type: string + format: google-datetime + rpoRiskLevel: + description: >- + Output only. A number that represents the current risk level of this + BackupPlan from RPO perspective with 1 being no risk and 5 being + highest risk. + readOnly: true + type: integer + format: int32 + lastSuccessfulBackup: + description: >- + Output only. The fully qualified name of the last successful Backup + created under this BackupPlan. + `projects/*/locations/*/backupPlans/*/backups/*` + readOnly: true + type: string + backupConfigDetails: + description: >- + Output only. Contains details about the BackupConfig of Backups + created via this BackupPlan. + readOnly: true + $ref: '#/components/schemas/BackupConfigDetails' + retentionPolicyDetails: + description: >- + Output only. Contains details about the RetentionPolicy of Backups + created via this BackupPlan. + readOnly: true + $ref: '#/components/schemas/RetentionPolicyDetails' + BackupConfigDetails: + id: BackupConfigDetails + description: >- + BackupConfigDetails defines the configuration of Backups created via + this BackupPlan. + type: object + properties: + allNamespaces: + description: Output only. If True, include all namespaced resources + readOnly: true + type: boolean + selectedNamespaces: + description: >- + Output only. If set, include just the resources in the listed + namespaces. + readOnly: true + $ref: '#/components/schemas/Namespaces' + selectedApplications: + description: >- + Output only. If set, include just the resources referenced by the + listed ProtectedApplications. + readOnly: true + $ref: '#/components/schemas/NamespacedNames' + includeVolumeData: + description: >- + Output only. This flag specifies whether volume data should be + backed up when PVCs are included in the scope of a Backup. Default: + False + readOnly: true + type: boolean + includeSecrets: + description: >- + Output only. This flag specifies whether Kubernetes Secret resources + should be included when they fall into the scope of Backups. + Default: False + readOnly: true + type: boolean + encryptionKey: + description: >- + Output only. This defines a customer managed encryption key that + will be used to encrypt the "config" portion (the Kubernetes + resources) of Backups created via this plan. Default (empty): Config + backup artifacts will not be encrypted. + readOnly: true + $ref: '#/components/schemas/EncryptionKey' + RetentionPolicyDetails: + id: RetentionPolicyDetails + description: >- + RetentionPolicyDetails defines a Backup retention policy for a + BackupPlan. + type: object + properties: + backupDeleteLockDays: + description: >- + Optional. Minimum age for Backups created via this BackupPlan (in + days). This field MUST be an integer value between 0-90 (inclusive). + A Backup created under this BackupPlan will NOT be deletable until + it reaches Backup's (create_time + backup_delete_lock_days). + Updating this field of a BackupPlan does NOT affect existing Backups + under it. Backups created AFTER a successful update will inherit the + new value. Default: 0 (no delete blocking) + type: integer + format: int32 + backupRetainDays: + description: >- + Optional. The default maximum age of a Backup created via this + BackupPlan. This field MUST be an integer value >= 0 and <= 365. If + specified, a Backup created under this BackupPlan will be + automatically deleted after its age reaches (create_time + + backup_retain_days). If not specified, Backups created under this + BackupPlan will NOT be subject to automatic deletion. Default: 0 (no + automatic deletion) + type: integer + format: int32 Backup: id: Backup description: >- @@ -730,6 +1101,12 @@ components: resources were included in the Backup. readOnly: true $ref: '#/components/schemas/NamespacedNames' + selectedNamespaceLabels: + description: >- + Output only. If set, the list of labels whose constituent namespaces + were included in the Backup. + readOnly: true + $ref: '#/components/schemas/ResourceLabels' containsVolumeData: description: >- Output only. Whether or not the Backup contains volume data. @@ -775,9 +1152,17 @@ components: stateReason: description: >- Output only. Human-readable description of why the backup is in the - current `state`. + current `state`. This field is only meant for human readability and + should not be used programmatically as this field is not guaranteed + to be consistent. readOnly: true type: string + troubleshootingInfo: + description: >- + Output only. Information about the troubleshooting steps which will + provide debugging information to the end users. + readOnly: true + $ref: '#/components/schemas/TroubleshootingInfo' completeTime: description: Output only. Completion time of the Backup readOnly: true @@ -840,6 +1225,14 @@ components: permissive_mode value. readOnly: true type: boolean + satisfiesPzs: + description: Output only. [Output Only] Reserved for future use. + readOnly: true + type: boolean + satisfiesPzi: + description: Output only. [Output Only] Reserved for future use. + readOnly: true + type: boolean ClusterMetadata: id: ClusterMetadata description: Information about the GKE cluster from which this Backup was created. @@ -873,15 +1266,35 @@ components: description: Output only. Anthos version readOnly: true type: string - ListBackupsResponse: - id: ListBackupsResponse - description: Response message for ListBackups. + TroubleshootingInfo: + id: TroubleshootingInfo + description: >- + Stores information about troubleshooting doc for debugging a particular + state of an operation (eg - backup/restore). This will be used by the + end user to debug their operation failure scenario easily. type: object properties: - backups: - description: The list of Backups matching the given criteria. - type: array - items: + stateReasonCode: + description: >- + Output only. Unique code for each backup/restore operation failure + message which helps user identify the failure. + readOnly: true + type: string + stateReasonUri: + description: >- + Output only. URL for the troubleshooting doc which will help the + user fix the failing backup/restore operation. + readOnly: true + type: string + ListBackupsResponse: + id: ListBackupsResponse + description: Response message for ListBackups. + type: object + properties: + backups: + description: The list of Backups matching the given criteria. + type: array + items: $ref: '#/components/schemas/Backup' nextPageToken: description: >- @@ -889,6 +1302,11 @@ components: `ListBackups` call to retrieve the next page of results. If this field is omitted or empty, then there are no more results to return. type: string + unreachable: + description: Locations that could not be reached. + type: array + items: + type: string ListVolumeBackupsResponse: id: ListVolumeBackupsResponse description: Response message for ListVolumeBackups. @@ -1010,6 +1428,9 @@ components: - >- This VolumeBackup resource (and its associated artifacts) is in the process of being deleted. + - >- + The underlying artifacts of a volume backup (eg: persistent disk + snapshots) are deleted. enum: - STATE_UNSPECIFIED - CREATING @@ -1018,10 +1439,13 @@ components: - SUCCEEDED - FAILED - DELETING + - CLEANED_UP stateMessage: description: >- Output only. A human readable message explaining why the - VolumeBackup is in its current state. + VolumeBackup is in its current state. This field is only meant for + human consumption and should not be used programmatically as this + field is not guaranteed to be consistent. readOnly: true type: string etag: @@ -1033,6 +1457,14 @@ components: backup updates in order to avoid race conditions. readOnly: true type: string + satisfiesPzs: + description: Output only. [Output Only] Reserved for future use. + readOnly: true + type: boolean + satisfiesPzi: + description: Output only. [Output Only] Reserved for future use. + readOnly: true + type: boolean RestorePlan: id: RestorePlan description: >- @@ -1128,7 +1560,17 @@ components: stateReason: description: >- Output only. Human-readable description of why RestorePlan is in the - current `state` + current `state`. This field is only meant for human readability and + should not be used programmatically as this field is not guaranteed + to be consistent. + readOnly: true + type: string + restoreChannel: + description: >- + Output only. The fully qualified name of the RestoreChannel to be + used to create a RestorePlan. This field is set only if the + `backup_plan` is in a different project than the RestorePlan. + Format: `projects/*/locations/*/restoreChannels/*` readOnly: true type: string RestoreConfig: @@ -1317,13 +1759,14 @@ components: Defines the scope of cluster-scoped resources to restore. Some group kinds are not reasonable choices for a restore, and will cause an error if selected here. Any scope selection that would restore "all valid" - resources automatically excludes these group kinds. - - gkebackup.gke.io/BackupJob - gkebackup.gke.io/RestoreJob - - metrics.k8s.io/NodeMetrics - migration.k8s.io/StorageState - - migration.k8s.io/StorageVersionMigration - Node - - snapshot.storage.k8s.io/VolumeSnapshotContent - storage.k8s.io/CSINode - Some group kinds are driven by restore configuration elsewhere, and will - cause an error if selected here. - Namespace - PersistentVolume + resources automatically excludes these group kinds. - Node - + ComponentStatus - gkebackup.gke.io/BackupJob - + gkebackup.gke.io/RestoreJob - metrics.k8s.io/NodeMetrics - + migration.k8s.io/StorageState - migration.k8s.io/StorageVersionMigration + - snapshot.storage.k8s.io/VolumeSnapshotContent - storage.k8s.io/CSINode + - storage.k8s.io/VolumeAttachment Some group kinds are driven by restore + configuration elsewhere, and will cause an error if selected here. - + Namespace - PersistentVolume type: object properties: selectedGroupKinds: @@ -1655,6 +2098,174 @@ components: type: array items: type: string + RestoreChannel: + id: RestoreChannel + description: >- + A RestoreChannel imposes constraints on where backups can be restored. + The RestoreChannel should be in the same project and region as the + backups. The backups can only be restored in the `destination_project`. + type: object + properties: + name: + description: >- + Identifier. The fully qualified name of the RestoreChannel. + `projects/*/locations/*/restoreChannels/*` + type: string + destinationProject: + description: >- + Required. Immutable. The project into which the backups will be + restored. The format is `projects/{projectId}` or + `projects/{projectNumber}`. + type: string + uid: + description: >- + Output only. Server generated global unique identifier of + [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) + format. + readOnly: true + type: string + createTime: + description: Output only. The timestamp when this RestoreChannel was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: >- + Output only. The timestamp when this RestoreChannel was last + updated. + readOnly: true + type: string + format: google-datetime + labels: + description: Optional. A set of custom labels supplied by user. + type: object + additionalProperties: + type: string + description: + description: Optional. User specified descriptive string for this RestoreChannel. + type: string + etag: + description: >- + Output only. `etag` is used for optimistic concurrency control as a + way to help prevent simultaneous updates of a RestoreChannel from + overwriting each other. It is strongly suggested that systems make + use of the 'etag' in the read-modify-write cycle to perform + RestoreChannel updates in order to avoid race conditions: An `etag` + is returned in the response to `GetRestoreChannel`, and systems are + expected to put that etag in the request to `UpdateRestoreChannel` + or `DeleteRestoreChannel` to ensure that their change will be + applied to the same version of the resource. + readOnly: true + type: string + destinationProjectId: + description: >- + Output only. The project_id where backups will be restored. Example + Project ID: "my-project-id". This will be an OUTPUT_ONLY field to + return the project_id of the destination project. + readOnly: true + type: string + ListRestoreChannelsResponse: + id: ListRestoreChannelsResponse + description: Response message for ListRestoreChannels. + type: object + properties: + restoreChannels: + description: The list of RestoreChannels matching the given criteria. + type: array + items: + $ref: '#/components/schemas/RestoreChannel' + nextPageToken: + description: >- + A token which may be sent as page_token in a subsequent + `ListRestoreChannels` call to retrieve the next page of results. If + this field is omitted or empty, then there are no more results to + return. + type: string + unreachable: + description: Locations that could not be reached. + type: array + items: + type: string + ListRestorePlanBindingsResponse: + id: ListRestorePlanBindingsResponse + description: Response message for ListRestorePlanBindings. + type: object + properties: + restorePlanBindings: + description: The list of RestorePlanBindings matching the given criteria. + type: array + items: + $ref: '#/components/schemas/RestorePlanBinding' + nextPageToken: + description: >- + A token which may be sent as page_token in a subsequent + `ListRestorePlanBindings` call to retrieve the next page of results. + If this field is omitted or empty, then there are no more results to + return. + type: string + unreachable: + description: Unordered list. Locations that could not be reached. + type: array + items: + type: string + RestorePlanBinding: + id: RestorePlanBinding + description: >- + A RestorePlanBinding binds a RestorePlan with a RestoreChannel. This + resource is created automatically when a RestorePlan is created using a + RestoreChannel. This also serves as a holder for cross-project fields + that need to be displayed in the current project. + type: object + properties: + name: + description: >- + Identifier. The fully qualified name of the RestorePlanBinding. + `projects/*/locations/*/restoreChannels/*/restorePlanBindings/*` + type: string + uid: + description: >- + Output only. Server generated global unique identifier of + [UUID4](https://en.wikipedia.org/wiki/Universally_unique_identifier) + readOnly: true + type: string + createTime: + description: Output only. The timestamp when this binding was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. The timestamp when this binding was created. + readOnly: true + type: string + format: google-datetime + restorePlan: + description: >- + Output only. The fully qualified name of the RestorePlan bound to + this RestoreChannel. + `projects/*/locations/*/restorePlans/{restore_plan}` + readOnly: true + type: string + etag: + description: >- + Output only. `etag` is used for optimistic concurrency control as a + way to help prevent simultaneous updates of a RestorePlanBinding + from overwriting each other. It is strongly suggested that systems + make use of the 'etag' in the read-modify-write cycle to perform + RestorePlanBinding updates in order to avoid race conditions: An + `etag` is returned in the response to `GetRestorePlanBinding`, and + systems are expected to put that etag in the request to + `UpdateRestorePlanBinding` or `DeleteRestorePlanBinding` to ensure + that their change will be applied to the same version of the + resource. + readOnly: true + type: string + backupPlan: + description: >- + Output only. The fully qualified name of the BackupPlan bound to the + specified RestorePlan. + `projects/*/locations/*/backukpPlans/{backup_plan}` + readOnly: true + type: string Restore: id: Restore description: >- @@ -1688,7 +2299,7 @@ components: type: string format: google-datetime description: - description: User specified descriptive string for this Restore. + description: Optional. User specified descriptive string for this Restore. type: string backup: description: >- @@ -1748,9 +2359,17 @@ components: stateReason: description: >- Output only. Human-readable description of why the Restore is in its - current state. + current state. This field is only meant for human readability and + should not be used programmatically as this field is not guaranteed + to be consistent. readOnly: true type: string + troubleshootingInfo: + description: >- + Output only. Information about the troubleshooting steps which will + provide debugging information to the end users. + readOnly: true + $ref: '#/components/schemas/TroubleshootingInfo' completeTime: description: Output only. Timestamp of when the restore operation completed. readOnly: true @@ -1802,7 +2421,7 @@ components: Optional. Immutable. Filters resources for `Restore`. If not specified, the scope of the restore will remain the same as defined in the `RestorePlan`. If this is specified and no resources are - matched by the `inclusion_filters` or everyting is excluded by the + matched by the `inclusion_filters` or everything is excluded by the `exclusion_filters`, nothing will be restored. This filter can only be specified if the value of namespaced_resource_restore_mode is set to `MERGE_SKIP_ON_CONFLICT`, `MERGE_REPLACE_VOLUME_ON_CONFLICT` or @@ -2068,6 +2687,7 @@ components: type: object properties: signedUrl: + description: Required. The signed URL for downloading the backup index. type: string ListLocationsResponse: id: ListLocationsResponse @@ -2483,8 +3103,8 @@ components: description: >- Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled - have Operation.error value with a google.rpc.Status.code of 1, - corresponding to `Code.CANCELLED`. + have google.longrunning.Operation.error value with a + google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. readOnly: true type: boolean apiVersion: @@ -2904,6 +3524,86 @@ components: - $ref: >- #/components/x-stackQL-resources/volume_backups_iam_policies/methods/set_iam_policy delete: [] + backup_channels: + id: google.gkebackup.backup_channels + name: backup_channels + title: Backup_channels + methods: + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupChannels/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupChannels/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.backupChannels + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupChannels~1{backupChannelsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupChannels~1{backupChannelsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupChannels~1{backupChannelsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/backup_channels/methods/get' + - $ref: '#/components/x-stackQL-resources/backup_channels/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/backup_channels/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/backup_channels/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/backup_channels/methods/delete' + backup_plan_bindings: + id: google.gkebackup.backup_plan_bindings + name: backup_plan_bindings + title: Backup_plan_bindings + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupChannels~1{backupChannelsId}~1backupPlanBindings/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.backupPlanBindings + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupChannels~1{backupChannelsId}~1backupPlanBindings~1{backupPlanBindingsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/backup_plan_bindings/methods/get' + - $ref: '#/components/x-stackQL-resources/backup_plan_bindings/methods/list' + insert: [] + update: [] + replace: [] + delete: [] restore_plans: id: google.gkebackup.restore_plans name: restore_plans @@ -3147,6 +3847,87 @@ components: - $ref: >- #/components/x-stackQL-resources/volume_restores_iam_policies/methods/set_iam_policy delete: [] + restore_channels: + id: google.gkebackup.restore_channels + name: restore_channels + title: Restore_channels + methods: + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1restoreChannels/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1restoreChannels/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.restoreChannels + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1restoreChannels~1{restoreChannelsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1restoreChannels~1{restoreChannelsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1restoreChannels~1{restoreChannelsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/restore_channels/methods/get' + - $ref: '#/components/x-stackQL-resources/restore_channels/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/restore_channels/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/restore_channels/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/restore_channels/methods/delete' + restore_plan_bindings: + id: google.gkebackup.restore_plan_bindings + name: restore_plan_bindings + title: Restore_plan_bindings + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1restoreChannels~1{restoreChannelsId}~1restorePlanBindings/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.restorePlanBindings + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1restoreChannels~1{restoreChannelsId}~1restorePlanBindings~1{restorePlanBindingsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/restore_plan_bindings/methods/get' + - $ref: >- + #/components/x-stackQL-resources/restore_plan_bindings/methods/list + insert: [] + update: [] + replace: [] + delete: [] paths: /v1/projects/{projectsId}/locations: parameters: &ref_1 @@ -3195,6 +3976,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: @@ -3349,7 +4134,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: gkebackup.projects.locations.operations.cancel requestBody: content: @@ -3787,6 +4572,10 @@ paths: name: orderBy schema: type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean /v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}/backups/{backupsId}: parameters: *ref_1 get: @@ -4321,7 +5110,293 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TestIamPermissionsResponse' + $ref: '#/components/schemas/TestIamPermissionsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: backupPlansId + required: true + schema: + type: string + - in: path + name: backupsId + required: true + schema: + type: string + - in: path + name: volumeBackupsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/backupChannels: + parameters: *ref_1 + post: + description: Creates a new BackupChannel in a given location. + operationId: gkebackup.projects.locations.backupChannels.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BackupChannel' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: backupChannelId + schema: + type: string + get: + description: Lists BackupChannels in a given location. + operationId: gkebackup.projects.locations.backupChannels.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListBackupChannelsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/backupChannels/{backupChannelsId}: + parameters: *ref_1 + get: + description: Retrieve the details of a single BackupChannel. + operationId: gkebackup.projects.locations.backupChannels.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/BackupChannel' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: backupChannelsId + required: true + schema: + type: string + patch: + description: Update a BackupChannel. + operationId: gkebackup.projects.locations.backupChannels.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BackupChannel' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: backupChannelsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes an existing BackupChannel. + operationId: gkebackup.projects.locations.backupChannels.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: backupChannelsId + required: true + schema: + type: string + - in: query + name: etag + schema: + type: string + - in: query + name: force + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/backupChannels/{backupChannelsId}/backupPlanBindings: + parameters: *ref_1 + get: + description: Lists BackupPlanBindings in a given location. + operationId: gkebackup.projects.locations.backupChannels.backupPlanBindings.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListBackupPlanBindingsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: backupChannelsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/backupChannels/{backupChannelsId}/backupPlanBindings/{backupPlanBindingsId}: + parameters: *ref_1 + get: + description: Retrieve the details of a single BackupPlanBinding. + operationId: gkebackup.projects.locations.backupChannels.backupPlanBindings.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/BackupPlanBinding' parameters: - in: path name: projectsId @@ -4334,17 +5409,12 @@ paths: schema: type: string - in: path - name: backupPlansId - required: true - schema: - type: string - - in: path - name: backupsId + name: backupChannelsId required: true schema: type: string - in: path - name: volumeBackupsId + name: backupPlanBindingsId required: true schema: type: string @@ -5277,3 +6347,280 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/restoreChannels: + parameters: *ref_1 + post: + description: Creates a new RestoreChannel in a given location. + operationId: gkebackup.projects.locations.restoreChannels.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RestoreChannel' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: restoreChannelId + schema: + type: string + get: + description: Lists RestoreChannels in a given location. + operationId: gkebackup.projects.locations.restoreChannels.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListRestoreChannelsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/restoreChannels/{restoreChannelsId}: + parameters: *ref_1 + get: + description: Retrieve the details of a single RestoreChannel. + operationId: gkebackup.projects.locations.restoreChannels.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/RestoreChannel' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: restoreChannelsId + required: true + schema: + type: string + patch: + description: Update a RestoreChannel. + operationId: gkebackup.projects.locations.restoreChannels.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RestoreChannel' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: restoreChannelsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes an existing RestoreChannel. + operationId: gkebackup.projects.locations.restoreChannels.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: restoreChannelsId + required: true + schema: + type: string + - in: query + name: etag + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/restoreChannels/{restoreChannelsId}/restorePlanBindings: + parameters: *ref_1 + get: + description: Lists RestorePlanBindings in a given location. + operationId: gkebackup.projects.locations.restoreChannels.restorePlanBindings.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListRestorePlanBindingsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: restoreChannelsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/restoreChannels/{restoreChannelsId}/restorePlanBindings/{restorePlanBindingsId}: + parameters: *ref_1 + get: + description: Retrieve the details of a single RestorePlanBinding. + operationId: gkebackup.projects.locations.restoreChannels.restorePlanBindings.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/RestorePlanBinding' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: restoreChannelsId + required: true + schema: + type: string + - in: path + name: restorePlanBindingsId + required: true + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/gkehub.yaml b/providers/src/googleapis.com/v00.00.00000/services/gkehub.yaml index f9af147b..3a3edb95 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/gkehub.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/gkehub.yaml @@ -7,8 +7,8 @@ info: title: GKE Hub API description: '' version: v2 - x-discovery-doc-revision: '20241025' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250815' + x-generated-date: '2025-08-28' externalDocs: url: >- https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster @@ -167,13 +167,8 @@ components: type: object additionalProperties: type: string - featureConfigRef: - description: >- - Reference information for a FeatureConfig applied on the - MembershipFeature. - $ref: '#/components/schemas/FeatureConfigRef' spec: - description: Spec of this membershipFeature. + description: Optional. Spec of this membershipFeature. $ref: '#/components/schemas/FeatureSpec' state: description: Output only. State of the this membershipFeature. @@ -198,27 +193,6 @@ components: readOnly: true type: string format: google-datetime - FeatureConfigRef: - id: FeatureConfigRef - description: Information of the FeatureConfig applied on the MembershipFeature. - type: object - properties: - config: - description: >- - Input only. Resource name of FeatureConfig, in the format: - `projects/{project}/locations/global/featureConfigs/{feature_config}`. - type: string - uuid: - description: Output only. An id that uniquely identify a FeatureConfig object. - readOnly: true - type: string - configUpdateTime: - description: >- - Output only. When the FeatureConfig was last applied and copied to - FeatureSpec. - readOnly: true - type: string - format: google-datetime FeatureSpec: id: FeatureSpec description: FeatureSpec contains user input per-feature spec information. @@ -233,6 +207,9 @@ components: policycontroller: description: Policycontroller-specific FeatureSpec. $ref: '#/components/schemas/PolicyControllerSpec' + rbacrolebindingactuation: + description: Rbacrolebindingactuation-specific FeatureSpec. + $ref: '#/components/schemas/RBACRoleBindingActuationSpec' identityservice: description: IdentityService FeatureSpec. $ref: '#/components/schemas/IdentityServiceSpec' @@ -525,6 +502,13 @@ components: effect: description: Matches a taint effect. type: string + RBACRoleBindingActuationSpec: + id: RBACRoleBindingActuationSpec + description: >- + **RBAC RoleBinding Actuation**: The membership-specific input for + RBACRoleBindingActuation feature. + type: object + properties: {} IdentityServiceSpec: id: IdentityServiceSpec description: '**IdentityService**: Configuration for a single membership.' @@ -944,13 +928,17 @@ components: description: Optional. Enables automatic Service Mesh management. type: string enumDescriptions: - - Unspecified + - Unspecified. - Google should manage my Service Mesh for the cluster. - User will manually configure their service mesh components. + - >- + Google should remove any managed Service Mesh components from this + cluster and deprovision any resources. enum: - MANAGEMENT_UNSPECIFIED - MANAGEMENT_AUTOMATIC - MANAGEMENT_MANUAL + - MANAGEMENT_NOT_INSTALLED configApi: description: >- Optional. Specifies the API that will be used for configuring the @@ -972,33 +960,36 @@ components: type: object properties: configSync: - description: Config Sync configuration for the cluster. + description: Optional. Config Sync configuration for the cluster. $ref: '#/components/schemas/ConfigManagementConfigSync' policyController: description: >- - Policy Controller configuration for the cluster. Deprecated: - Configuring Policy Controller through the configmanagement feature - is no longer recommended. Use the policycontroller feature instead. + Optional. Policy Controller configuration for the cluster. + Deprecated: Configuring Policy Controller through the + configmanagement feature is no longer recommended. Use the + policycontroller feature instead. + deprecated: true $ref: '#/components/schemas/ConfigManagementPolicyController' binauthz: description: >- - Binauthz conifguration for the cluster. Deprecated: This field will - be ignored and should not be set. + Optional. Binauthz conifguration for the cluster. Deprecated: This + field will be ignored and should not be set. deprecated: true $ref: '#/components/schemas/ConfigManagementBinauthzConfig' hierarchyController: description: >- - Hierarchy Controller configuration for the cluster. Deprecated: - Configuring Hierarchy Controller through the configmanagement - feature is no longer recommended. Use + Optional. Hierarchy Controller configuration for the cluster. + Deprecated: Configuring Hierarchy Controller through the + configmanagement feature is no longer recommended. Use https://github.com/kubernetes-sigs/hierarchical-namespaces instead. + deprecated: true $ref: '#/components/schemas/ConfigManagementHierarchyControllerConfig' version: - description: Version of ACM installed. + description: Optional. Version of ACM installed. type: string cluster: description: >- - The user-specified cluster name used by Config Sync + Optional. The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync @@ -1007,7 +998,7 @@ components: by Config Sync cluster-name-selector annotation or ClusterSelector. type: string management: - description: Enables automatic Feature management. + description: Optional. Enables automatic Feature management. type: string enumDescriptions: - Unspecified @@ -1023,42 +1014,36 @@ components: type: object properties: git: - description: Git repo configuration for the cluster. + description: Optional. Git repo configuration for the cluster. $ref: '#/components/schemas/ConfigManagementGitConfig' sourceFormat: description: >- - Specifies whether the Config Sync Repo is in "hierarchical" or - "unstructured" mode. + Optional. Specifies whether the Config Sync Repo is in + "hierarchical" or "unstructured" mode. type: string enabled: description: >- - Enables the installation of ConfigSync. If set to true, ConfigSync - resources will be created and the other ConfigSync fields will be - applied if exist. If set to false, all other ConfigSync fields will - be ignored, ConfigSync resources will be deleted. If omitted, - ConfigSync resources will be managed depends on the presence of the - git or oci field. + Optional. Enables the installation of ConfigSync. If set to true, + ConfigSync resources will be created and the other ConfigSync fields + will be applied if exist. If set to false, all other ConfigSync + fields will be ignored, ConfigSync resources will be deleted. If + omitted, ConfigSync resources will be managed depends on the + presence of the git or oci field. type: boolean preventDrift: description: >- - Set to true to enable the Config Sync admission webhook to prevent - drifts. If set to `false`, disables the Config Sync admission - webhook and does not prevent drifts. + Optional. Set to true to enable the Config Sync admission webhook to + prevent drifts. If set to `false`, disables the Config Sync + admission webhook and does not prevent drifts. type: boolean oci: - description: OCI repo configuration for the cluster. + description: Optional. OCI repo configuration for the cluster. $ref: '#/components/schemas/ConfigManagementOciConfig' - allowVerticalScale: - description: >- - Set to true to allow the vertical scaling. Defaults to false which - disallows vertical scaling. This field is deprecated. - deprecated: true - type: boolean metricsGcpServiceAccountEmail: description: >- - The Email of the Google Cloud Service Account (GSA) used for - exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch - when Workload Identity is enabled. The GSA should have the + Optional. The Email of the Google Cloud Service Account (GSA) used + for exporting Config Sync metrics to Cloud Monitoring and Cloud + Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. @@ -1070,46 +1055,56 @@ components: type: string stopSyncing: description: >- - Set to true to stop syncing configs for a single cluster. Default to - false. + Optional. Set to true to stop syncing configs for a single cluster. + Default to false. type: boolean + deploymentOverrides: + description: Optional. Configuration for deployment overrides. + type: array + items: + $ref: '#/components/schemas/ConfigManagementDeploymentOverride' ConfigManagementGitConfig: id: ConfigManagementGitConfig description: Git repo configuration for a single cluster. type: object properties: syncRepo: - description: The URL of the Git repository to use as the source of truth. + description: >- + Required. The URL of the Git repository to use as the source of + truth. type: string syncBranch: - description: 'The branch of the repository to sync from. Default: master.' + description: >- + Optional. The branch of the repository to sync from. Default: + master. type: string policyDir: description: >- - The path within the Git repository that represents the top level of - the repo to sync. Default: the root directory of the repository. + Optional. The path within the Git repository that represents the top + level of the repo to sync. Default: the root directory of the + repository. type: string syncWaitSecs: - description: 'Period in seconds between consecutive syncs. Default: 15.' + description: 'Optional. Period in seconds between consecutive syncs. Default: 15.' type: string format: int64 syncRev: - description: Git revision (tag or hash) to check out. Default HEAD. + description: Optional. Git revision (tag or hash) to check out. Default HEAD. type: string secretType: description: >- - Type of secret configured for access to the Git repo. Must be one of - ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The - validation of this is case-sensitive. Required. + Required. Type of secret configured for access to the Git repo. Must + be one of ssh, cookiefile, gcenode, token, gcpserviceaccount, + githubapp or none. The validation of this is case-sensitive. type: string httpsProxy: description: >- - URL for the HTTPS proxy to be used when communicating with the Git - repo. + Optional. URL for the HTTPS proxy to be used when communicating with + the Git repo. type: string gcpServiceAccountEmail: description: >- - The Google Cloud Service Account Email used for auth when + Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. type: string ConfigManagementOciConfig: @@ -1119,26 +1114,68 @@ components: properties: syncRepo: description: >- - The OCI image repository URL for the package to sync from. e.g. + Required. The OCI image repository URL for the package to sync from. + e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. type: string policyDir: description: >- - The absolute path of the directory that contains the local + Optional. The absolute path of the directory that contains the local resources. Default: the root directory of the image. type: string syncWaitSecs: - description: 'Period in seconds between consecutive syncs. Default: 15.' + description: 'Optional. Period in seconds between consecutive syncs. Default: 15.' type: string format: int64 secretType: - description: Type of secret configured for access to the Git repo. + description: >- + Required. Type of secret configured for access to the OCI repo. Must + be one of gcenode, gcpserviceaccount, k8sserviceaccount or none. The + validation of this is case-sensitive. type: string gcpServiceAccountEmail: description: >- - The Google Cloud Service Account Email used for auth when + Optional. The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount. type: string + ConfigManagementDeploymentOverride: + id: ConfigManagementDeploymentOverride + description: Configuration for a deployment override. + type: object + properties: + deploymentName: + description: Required. The name of the deployment resource to be overridden. + type: string + deploymentNamespace: + description: Required. The namespace of the deployment resource to be overridden. + type: string + containers: + description: >- + Optional. The containers of the deployment resource to be + overridden. + type: array + items: + $ref: '#/components/schemas/ConfigManagementContainerOverride' + ConfigManagementContainerOverride: + id: ConfigManagementContainerOverride + description: Configuration for a container override. + type: object + properties: + containerName: + description: Required. The name of the container. + type: string + cpuRequest: + description: Optional. The cpu request of the container. + type: string + cpuLimit: + description: Optional. The cpu limit of the container. + type: string + memoryRequest: + description: Optional. The memory request of the container. + type: string + memoryLimit: + description: Optional. The memory limit of the container. + type: string ConfigManagementPolicyController: id: ConfigManagementPolicyController description: Configuration for Policy Controller @@ -1278,6 +1315,9 @@ components: policycontroller: description: Policy Controller state $ref: '#/components/schemas/PolicyControllerState' + rbacrolebindingactuation: + description: RBAC Role Binding Actuation state + $ref: '#/components/schemas/RBACRoleBindingActuationState' appdevexperience: description: Appdevexperience specific state. $ref: '#/components/schemas/AppDevExperienceState' @@ -1368,6 +1408,10 @@ components: - >- The upgrade has passed all post conditions (soaking). At the scope level, this means all eligible clusters are in COMPLETE status. + - >- + The upgrade was forced into soaking and the soaking time has + passed. This is the equivalent of COMPLETE status for upgrades + that were forced into soaking. enum: - CODE_UNSPECIFIED - INELIGIBLE @@ -1376,6 +1420,7 @@ components: - SOAKING - FORCED_SOAKING - COMPLETE + - FORCED_COMPLETE reason: description: Reason for this status. type: string @@ -1563,6 +1608,7 @@ components: - >- DEGRADED means that the component is ready, but operating in a degraded state. + - DEPROVISIONING means that deprovisioning is in progress. enum: - LIFECYCLE_STATE_UNSPECIFIED - DISABLED @@ -1572,6 +1618,7 @@ components: - STALLED - NEEDS_ATTENTION - DEGRADED + - DEPROVISIONING implementation: description: Output only. Implementation of managed control plane. readOnly: true @@ -1621,6 +1668,7 @@ components: - >- DEGRADED means that the component is ready, but operating in a degraded state. + - DEPROVISIONING means that deprovisioning is in progress. enum: - LIFECYCLE_STATE_UNSPECIFIED - DISABLED @@ -1630,6 +1678,7 @@ components: - STALLED - NEEDS_ATTENTION - DEGRADED + - DEPROVISIONING details: description: Explanation of the status. type: array @@ -1655,6 +1704,7 @@ components: - CNI installation failed error code - CNI pod unschedulable error code - Cluster has zero node code + - Failure to reconcile CanonicalServices - Multiple control planes unsupported error code - VPC-SC GA is supported for this control plane. - >- @@ -1685,10 +1735,33 @@ components: - HTTPFilter quota exceeded error code. - TCPFilter quota exceeded error code. - NetworkEndpointGroup quota exceeded error code. + - Legacy istio secrets found for multicluster error code + - Workload identity required error code + - Non-standard binary usage error code + - Unsupported gateway class error code + - Managed CNI not enabled error code - Modernization is scheduled for a cluster. - Modernization is in progress for a cluster. - Modernization is completed for a cluster. - Modernization is aborted for a cluster. + - Preparing cluster so that its workloads can be migrated. + - Modernization is stalled for a cluster. + - Cluster has been prepared for its workloads to be migrated. + - Migrating the cluster's workloads to the new implementation. + - Rollback is in progress for modernization of a cluster. + - Modernization will be scheduled for a fleet. + - Fleet is opted out from automated modernization. + - Fleet is eligible for modernization. + - Modernization of one or more clusters in a fleet is in progress. + - >- + Modernization of all the fleet's clusters is complete. Soaking + before finalizing the modernization. + - >- + Modernization is finalized for all clusters in a fleet. Rollback + is no longer allowed. + - >- + Rollback is in progress for modernization of all clusters in a + fleet. enum: - CODE_UNSPECIFIED - MESH_IAM_PERMISSION_DENIED @@ -1699,6 +1772,7 @@ components: - CNI_INSTALLATION_FAILED - CNI_POD_UNSCHEDULABLE - CLUSTER_HAS_ZERO_NODES + - CANONICAL_SERVICE_ERROR - UNSUPPORTED_MULTIPLE_CONTROL_PLANES - VPCSC_GA_SUPPORTED - DEPRECATED_SPEC_CONTROL_PLANE_MANAGEMENT @@ -1721,10 +1795,27 @@ components: - QUOTA_EXCEEDED_HTTP_FILTERS - QUOTA_EXCEEDED_TCP_FILTERS - QUOTA_EXCEEDED_NETWORK_ENDPOINT_GROUPS + - LEGACY_MC_SECRETS + - WORKLOAD_IDENTITY_REQUIRED + - NON_STANDARD_BINARY_USAGE + - UNSUPPORTED_GATEWAY_CLASS + - MANAGED_CNI_NOT_ENABLED - MODERNIZATION_SCHEDULED - MODERNIZATION_IN_PROGRESS - MODERNIZATION_COMPLETED - MODERNIZATION_ABORTED + - MODERNIZATION_PREPARING + - MODERNIZATION_STALLED + - MODERNIZATION_PREPARED + - MODERNIZATION_MIGRATING_WORKLOADS + - MODERNIZATION_ROLLING_BACK_CLUSTER + - MODERNIZATION_WILL_BE_SCHEDULED + - MODERNIZATION_MANUAL + - MODERNIZATION_ELIGIBLE + - MODERNIZATION_MODERNIZING + - MODERNIZATION_MODERNIZED_SOAKING + - MODERNIZATION_FINALIZED + - MODERNIZATION_ROLLING_BACK_FLEET documentationLink: description: Links contains actionable information. type: string @@ -1772,30 +1863,37 @@ components: properties: clusterName: description: >- - This field is set to the `cluster_name` field of the Membership Spec - if it is not empty. Otherwise, it is set to the cluster's fleet - membership name. + Output only. This field is set to the `cluster_name` field of the + Membership Spec if it is not empty. Otherwise, it is set to the + cluster's fleet membership name. + readOnly: true type: string membershipSpec: description: >- - Membership configuration in the cluster. This represents the actual - state in the cluster, while the MembershipSpec in the FeatureSpec - represents the intended state. + Output only. Membership configuration in the cluster. This + represents the actual state in the cluster, while the MembershipSpec + in the FeatureSpec represents the intended state. + readOnly: true $ref: '#/components/schemas/ConfigManagementSpec' operatorState: - description: Current install status of ACM's Operator. + description: Output only. Current install status of ACM's Operator. + readOnly: true $ref: '#/components/schemas/ConfigManagementOperatorState' configSyncState: - description: Current sync status. + description: Output only. Current sync status. + readOnly: true $ref: '#/components/schemas/ConfigManagementConfigSyncState' policyControllerState: - description: PolicyController status. + description: Output only. PolicyController status. + readOnly: true $ref: '#/components/schemas/ConfigManagementPolicyControllerState' binauthzState: - description: Binauthz status. + description: Output only. Binauthz status. + readOnly: true $ref: '#/components/schemas/ConfigManagementBinauthzState' hierarchyControllerState: - description: Hierarchy Controller status. + description: Output only. Hierarchy Controller status. + readOnly: true $ref: '#/components/schemas/ConfigManagementHierarchyControllerState' ConfigManagementOperatorState: id: ConfigManagementOperatorState @@ -1839,23 +1937,30 @@ components: type: object properties: version: - description: The version of ConfigSync deployed. + description: Output only. The version of ConfigSync deployed. + readOnly: true $ref: '#/components/schemas/ConfigManagementConfigSyncVersion' deploymentState: description: >- - Information about the deployment of ConfigSync, including the - version. of the various Pods deployed + Output only. Information about the deployment of ConfigSync, + including the version. of the various Pods deployed + readOnly: true $ref: '#/components/schemas/ConfigManagementConfigSyncDeploymentState' syncState: - description: The state of ConfigSync's process to sync configs to a cluster. + description: >- + Output only. The state of ConfigSync's process to sync configs to a + cluster. + readOnly: true $ref: '#/components/schemas/ConfigManagementSyncState' errors: - description: Errors pertaining to the installation of Config Sync. + description: Output only. Errors pertaining to the installation of Config Sync. + readOnly: true type: array items: $ref: '#/components/schemas/ConfigManagementConfigSyncError' rootsyncCrd: - description: The state of the RootSync CRD + description: Output only. The state of the RootSync CRD + readOnly: true type: string enumDescriptions: - CRD's state cannot be determined @@ -1870,7 +1975,8 @@ components: - TERMINATING - INSTALLING reposyncCrd: - description: The state of the Reposync CRD + description: Output only. The state of the Reposync CRD + readOnly: true type: string enumDescriptions: - CRD's state cannot be determined @@ -1886,8 +1992,9 @@ components: - INSTALLING state: description: >- - The state of CS This field summarizes the other fields in this - message. + Output only. The state of CS This field summarizes the other fields + in this message. + readOnly: true type: string enumDescriptions: - CS's state cannot be determined. @@ -1903,8 +2010,9 @@ components: - CONFIG_SYNC_PENDING clusterLevelStopSyncingState: description: >- - Whether syncing resources to the cluster is stopped at the cluster - level. + Output only. Whether syncing resources to the cluster is stopped at + the cluster level. + readOnly: true type: string enumDescriptions: - State cannot be determined @@ -2569,6 +2677,52 @@ components: represent the state of either the syncSet object(s) or the config object, depending on the version of PoCo configured by the user. $ref: '#/components/schemas/PolicyControllerOnClusterState' + RBACRoleBindingActuationState: + id: RBACRoleBindingActuationState + description: >- + **RBAC RoleBinding Actuation**: A membership-specific Feature state for + the RBACRoleBindingActuation fleet feature. + type: object + properties: + rbacrolebindingStates: + description: >- + Output only. The state of RBACRoleBindings using custom roles that + exist on the cluster, keyed by RBACRoleBinding resource name with + format: + projects/{project}/locations/{location}/scopes/{scope}/rbacrolebindings/{rbacrolebinding}. + readOnly: true + type: object + additionalProperties: + $ref: '#/components/schemas/RBACRoleBindingActuationRBACRoleBindingState' + RBACRoleBindingActuationRBACRoleBindingState: + id: RBACRoleBindingActuationRBACRoleBindingState + description: >- + RBACRoleBindingState is the status of an RBACRoleBinding which exists on + a membership. + type: object + properties: + state: + description: Output only. The state of the RBACRoleBinding. + readOnly: true + type: string + enumDescriptions: + - Unspecified state. + - RBACRoleBinding is created properly on the cluster. + - >- + The RBACRoleBinding was created on the cluster but the specified + custom role does not exist on the cluster, hence the + RBACRoleBinding has no effect. + enum: + - ROLE_BINDING_STATE_UNSPECIFIED + - OK + - CUSTOM_ROLE_MISSING_FROM_CLUSTER + description: + description: The reason for the failure. + type: string + updateTime: + description: The time the RBACRoleBinding status was last updated. + type: string + format: google-datetime AppDevExperienceState: id: AppDevExperienceState description: State for App Dev Exp Feature. @@ -3045,6 +3199,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v2/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: @@ -3164,7 +3322,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: gkehub.projects.locations.operations.cancel requestBody: content: diff --git a/providers/src/googleapis.com/v00.00.00000/services/gkeonprem.yaml b/providers/src/googleapis.com/v00.00.00000/services/gkeonprem.yaml index 5b04e483..7618d23f 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/gkeonprem.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/gkeonprem.yaml @@ -4,11 +4,11 @@ info: name: StackQL Studios url: https://github.com/stackql/google-discovery-to-openapi email: info@stackql.io - title: GDC Virtual API + title: GKE On-Prem API description: '' version: v1 - x-discovery-doc-revision: '20241023' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250813' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/anthos/clusters/docs/on-prem/ servers: @@ -326,6 +326,10 @@ components: upgradePolicy: description: The cluster upgrade policy. $ref: '#/components/schemas/BareMetalClusterUpgradePolicy' + localNamespace: + description: Output only. The namespace of the cluster. + readOnly: true + type: string BareMetalNetworkConfig: id: BareMetalNetworkConfig description: Specifies the cluster network configuration. @@ -1206,6 +1210,9 @@ components: membership. In the future, references to other resource types might be allowed if admin clusters are modeled as their own resources. type: string + localNamespace: + description: Optional. The namespace of the cluster. + type: string ListBareMetalClustersResponse: id: ListBareMetalClustersResponse description: Response message for listing bare metal Clusters. @@ -1498,6 +1505,9 @@ components: disableBundledIngress: description: Disable bundled ingress. type: boolean + enableAdvancedCluster: + description: Enable advanced cluster. + type: boolean VmwareControlPlaneNodeConfig: id: VmwareControlPlaneNodeConfig description: Specifies control plane node config for the VMware user cluster. @@ -2532,6 +2542,12 @@ components: check job. readOnly: true $ref: '#/components/schemas/ValidationCheck' + enableAdvancedCluster: + description: Enable advanced cluster. + type: boolean + privateRegistryConfig: + description: Configuration for registry. + $ref: '#/components/schemas/VmwareAdminPrivateRegistryConfig' VmwareAdminVCenterConfig: id: VmwareAdminVCenterConfig description: >- @@ -2711,7 +2727,10 @@ components: MetalLB load balancer. For admin clusters, currently no configurations is needed. type: object - properties: {} + properties: + enabled: + description: Whether MetalLB is enabled. + type: boolean VmwareAdminSeesawConfig: id: VmwareAdminSeesawConfig description: >- @@ -2857,6 +2876,24 @@ components: type: array items: $ref: '#/components/schemas/ClusterUser' + VmwareAdminPrivateRegistryConfig: + id: VmwareAdminPrivateRegistryConfig + description: >- + VmwareAdminPrivateRegistryConfig represents configuration for admin + cluster registry. + type: object + properties: + address: + description: The registry address. + type: string + caCert: + description: >- + When the container runtime pulls an image from private registry, the + registry must prove its identity by presenting a certificate. The + registry's certificate is signed by a certificate authority (CA). + The container runtime uses the CA's certificate to validate the + registry's certificate. + type: string ListVmwareAdminClustersResponse: id: ListVmwareAdminClustersResponse description: Response message for listing VMware admin clusters. @@ -4901,6 +4938,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: @@ -5055,7 +5096,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: gkeonprem.projects.locations.operations.cancel requestBody: content: @@ -7653,6 +7694,10 @@ paths: name: validateOnly schema: type: boolean + - in: query + name: ignoreErrors + schema: + type: boolean /v1/projects/{projectsId}/locations/{locationsId}/vmwareAdminClusters/{vmwareAdminClustersId}:setIamPolicy: parameters: *ref_1 post: diff --git a/providers/src/googleapis.com/v00.00.00000/services/healthcare.yaml b/providers/src/googleapis.com/v00.00.00000/services/healthcare.yaml index 29ab4ba0..87869573 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/healthcare.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/healthcare.yaml @@ -7,8 +7,8 @@ info: title: Cloud Healthcare API description: Manage, store, and access healthcare data in Google Cloud Platform. version: v1 - x-discovery-doc-revision: '20241023' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250724' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/healthcare servers: @@ -1355,26 +1355,26 @@ components: type: object properties: dicom: - description: Configures de-id of application/DICOM content. + description: Optional. Configures de-id of application/DICOM content. $ref: '#/components/schemas/DicomConfig' fhir: - description: Configures de-id of application/FHIR content. + description: Optional. Configures de-id of application/FHIR content. $ref: '#/components/schemas/FhirConfig' image: description: >- - Configures de-identification of image pixels wherever they are found - in the source_dataset. + Optional. Configures de-identification of image pixels wherever they + are found in the source_dataset. $ref: '#/components/schemas/ImageConfig' text: description: >- - Configures de-identification of text wherever it is found in the - source_dataset. + Optional. Configures de-identification of text wherever it is found + in the source_dataset. $ref: '#/components/schemas/TextConfig' useRegionalDataProcessing: description: >- - Ensures in-flight data remains in the region of origin during - de-identification. The default value is false. Using this option - results in a significant reduction of throughput, and is not + Optional. Ensures in-flight data remains in the region of origin + during de-identification. The default value is false. Using this + option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. @@ -1386,14 +1386,14 @@ components: properties: skipIdRedaction: description: >- - If true, skip replacing StudyInstanceUID, SeriesInstanceUID, - SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them - untouched. The Cloud Healthcare API regenerates these UIDs by - default based on the DICOM Standard's reasoning: "Whilst these UIDs - cannot be mapped directly to an individual out of context, given - access to the original images, or to a database of the original - images containing the UIDs, it would be possible to recover the - individual's identity." + Optional. If true, skip replacing StudyInstanceUID, + SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID + and leave them untouched. The Cloud Healthcare API regenerates these + UIDs by default based on the DICOM Standard's reasoning: "Whilst + these UIDs cannot be mapped directly to an individual out of + context, given access to the original images, or to a database of + the original images containing the UIDs, it would be possible to + recover the individual's identity." http://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html type: boolean keepList: @@ -1431,8 +1431,9 @@ components: properties: tags: description: >- - Tags to be filtered. Tags must be DICOM Data Elements, File Meta - Elements, or Directory Structuring Elements, as defined at: + Optional. Tags to be filtered. Tags must be DICOM Data Elements, + File Meta Elements, or Directory Structuring Elements, as defined + at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example "PatientID", "00100010". @@ -1446,18 +1447,18 @@ components: properties: fieldMetadataList: description: >- - Specifies FHIR paths to match and how to transform them. Any field - that is not matched by a FieldMetadata is passed through to the - output dataset unmodified. All extensions will be processed + Optional. Specifies FHIR paths to match and how to transform them. + Any field that is not matched by a FieldMetadata is passed through + to the output dataset unmodified. All extensions will be processed according to `default_keep_extensions`. type: array items: $ref: '#/components/schemas/FieldMetadata' defaultKeepExtensions: description: >- - The behaviour for handling FHIR extensions that aren't otherwise - specified for de-identification. If true, all extensions are - preserved during de-identification by default. If false or + Optional. The behaviour for handling FHIR extensions that aren't + otherwise specified for de-identification. If true, all extensions + are preserved during de-identification by default. If false or unspecified, all extensions are removed during de-identification by default. type: boolean @@ -1470,23 +1471,23 @@ components: properties: paths: description: >- - List of paths to FHIR fields to be redacted. Each path is a - period-separated list where each component is either a field name or - FHIR type name, for example: Patient, HumanName. For "choice" types - (those defined in the FHIR spec with the form: field[x]) we use two - separate components. For example, "deceasedAge.unit" is matched by - "Deceased.Age.unit". Supported types are: AdministrativeGenderCode, - Base64Binary, Boolean, Code, Date, DateTime, Decimal, HumanName, Id, - Instant, Integer, LanguageCode, Markdown, Oid, PositiveInt, String, - UnsignedInt, Uri, Uuid, Xhtml. + Optional. List of paths to FHIR fields to be redacted. Each path is + a period-separated list where each component is either a field name + or FHIR type name, for example: Patient, HumanName. For "choice" + types (those defined in the FHIR spec with the form: field[x]) we + use two separate components. For example, "deceasedAge.unit" is + matched by "Deceased.Age.unit". Supported types are: + AdministrativeGenderCode, Base64Binary, Boolean, Code, Date, + DateTime, Decimal, HumanName, Id, Instant, Integer, LanguageCode, + Markdown, Oid, PositiveInt, String, UnsignedInt, Uri, Uuid, Xhtml. type: array items: type: string action: - description: Deidentify action for one field. + description: Optional. Deidentify action for one field. type: string enumDescriptions: - - No action specified. + - No action specified. Defaults to DO_NOT_TRANSFORM. - Transform the entire field. - Inspect and transform any found PHI. - Do not transform. @@ -1501,7 +1502,7 @@ components: type: object properties: textRedactionMode: - description: Determines how to redact text from image. + description: Optional. Determines how to redact text from image. type: string enumDescriptions: - No text redaction specified. Same as REDACT_NO_TEXT. @@ -1521,21 +1522,21 @@ components: properties: transformations: description: >- - The transformations to apply to the detected data. Deprecated. Use - `additional_transformations` instead. + Optional. The transformations to apply to the detected data. + Deprecated. Use `additional_transformations` instead. type: array items: $ref: '#/components/schemas/InfoTypeTransformation' additionalTransformations: description: >- - Transformations to apply to the detected data, overridden by - `exclude_info_types`. + Optional. Transformations to apply to the detected data, overridden + by `exclude_info_types`. type: array items: $ref: '#/components/schemas/InfoTypeTransformation' excludeInfoTypes: description: >- - InfoTypes to skip transforming, overriding + Optional. InfoTypes to skip transforming, overriding `additional_transformations`. type: array items: @@ -1549,8 +1550,8 @@ components: properties: infoTypes: description: >- - InfoTypes to apply this transformation to. If this is not specified, - the transformation applies to any info_type. + Optional. InfoTypes to apply this transformation to. If this is not + specified, the transformation applies to any info_type. type: array items: type: string @@ -1583,8 +1584,8 @@ components: properties: maskingCharacter: description: >- - Character to mask the sensitive values. If not supplied, defaults to - "*". + Optional. Character to mask the sensitive values. If not supplied, + defaults to "*". type: string DateShiftConfig: id: DateShiftConfig @@ -1760,6 +1761,14 @@ components: this key. If empty, the Dataset is secured by the default Google encryption key. $ref: '#/components/schemas/EncryptionSpec' + satisfiesPzs: + description: Output only. Whether the dataset satisfies zone separation. + readOnly: true + type: boolean + satisfiesPzi: + description: Output only. Whether the dataset satisfies zone isolation. + readOnly: true + type: boolean EncryptionSpec: id: EncryptionSpec description: >- @@ -1977,6 +1986,13 @@ components: type: array items: $ref: '#/components/schemas/GoogleCloudHealthcareV1DicomStreamConfig' + notificationConfigs: + description: >- + Optional. Specifies where and whether to send notifications upon + changes to a DICOM store. + type: array + items: + $ref: '#/components/schemas/DicomNotificationConfig' NotificationConfig: id: NotificationConfig description: Specifies where to send notifications upon changes to a data store. @@ -2076,6 +2092,50 @@ components: - WRITE_EMPTY - WRITE_TRUNCATE - WRITE_APPEND + DicomNotificationConfig: + id: DicomNotificationConfig + description: Contains the configuration for DICOM notifications. + type: object + properties: + pubsubTopic: + description: >- + Required. The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic + that notifications of changes are published on. Supplied by the + client. The notification is a `PubsubMessage` with the following + fields: * `PubsubMessage.Data` contains the resource name. * + `PubsubMessage.MessageId` is the ID of this notification. It is + guaranteed to be unique within the topic. * + `PubsubMessage.PublishTime` is the time when the message was + published. * `PubsubMessage.Attributes` contains the following + attributes: * `action`: The name of the endpoint that generated the + notification. Possible values are `StoreInstances`, + `SetBlobSettings`, `ImportDicomData`, etc. * `lastUpdatedTime`: The + latest timestamp when the DICOM instance was updated. * `storeName`: + The resource name of the DICOM store, of the form + `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. + * `studyInstanceUID`: The study UID of the DICOM instance that was + changed. * `seriesInstanceUID`: The series UID of the DICOM instance + that was changed. * `sopInstanceUID`: The instance UID of the DICOM + instance that was changed. * `versionId`: The version ID of the + DICOM instance that was changed. * `modality`: The modality tag of + the DICOM instance that was changed. * `previousStorageClass`: The + storage class where the DICOM instance was previously stored if the + storage class was changed. * `storageClass`: The storage class where + the DICOM instance is currently stored. Note that notifications are + only sent if the topic is non-empty. [Topic + names](https://cloud.google.com/pubsub/docs/overview#names) must be + scoped to a project. The Cloud Healthcare API service account, + service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have the + `pubsub.topics.publish` permission (which is typically included in + `roles/pubsub.publisher` role) on the given Pub/Sub topic. Not + having adequate permissions causes the calls that send notifications + to fail + (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). + If a notification can't be published to Pub/Sub, errors are logged + to Cloud Logging. For more information, see [Viewing error logs in + Cloud + Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging). + type: string ListDicomStoresResponse: id: ListDicomStoresResponse description: Lists the DICOM stores in the given dataset. @@ -3224,11 +3284,12 @@ components: properties: resourceType: description: >- - Required. The FHIR resource type to search, such as Patient or + Optional. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index - ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), - [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), - [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). + ([DSTU2](https://hl7.org/fhir/DSTU2/resourcelist.html), + [STU3](https://hl7.org/fhir/STU3/resourcelist.html), + [R4](https://hl7.org/fhir/R4/resourcelist.html)), + [R5](https://hl7.org/fhir/R5/resourcelist.html)). type: string FhirStore: id: FhirStore @@ -3261,7 +3322,8 @@ components: publish all resource modifications of this FHIR store to this destination. The Pub/Sub message attributes contain a map with a string describing the action that has triggered the notification. - For example, "action":"CreateResource". + For example, "action":"CreateResource". Not supported in R5. Use + `notification_configs` instead. deprecated: true $ref: '#/components/schemas/NotificationConfig' disableReferentialIntegrity: @@ -3314,11 +3376,13 @@ components: 2](https://www.hl7.org/fhir/DSTU2) - Standard for Trial Use, [Release 3](https://www.hl7.org/fhir/STU3) - '[Release 4](https://www.hl7.org/fhir/R4)' + - '[Release 5](https://www.hl7.org/fhir/R5)' enum: - VERSION_UNSPECIFIED - DSTU2 - STU3 - R4 + - R5 streamConfigs: description: >- Optional. A list of streaming configs that configure the @@ -3362,7 +3426,7 @@ components: data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain - references to non-existent resources. + references to non-existent resources. Cannot be disabled in R5. type: string enumDescriptions: - >- @@ -3381,6 +3445,21 @@ components: type: array items: $ref: '#/components/schemas/FhirNotificationConfig' + bulkExportGcsDestination: + description: >- + Optional. FHIR bulk export exports resources to the specified Cloud + Storage destination. A Cloud Storage destination is a URI for a + Cloud Storage directory where result files will be written. Only + used in the spec-defined bulk $export methods. The Cloud Healthcare + Service Agent requires the `roles/storage.objectAdmin` Cloud IAM + role on the destination. + $ref: '#/components/schemas/BulkExportGcsDestination' + consentConfig: + description: >- + Optional. Specifies whether this store has consent enforcement. Not + available for DSTU2 FHIR version due to absence of Consent + resources. Not supported for R5 FHIR version. + $ref: '#/components/schemas/ConsentConfig' StreamConfig: id: StreamConfig description: Contains configuration for streaming FHIR export. @@ -3452,6 +3531,7 @@ components: true. If a resource cannot be de-identified, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). + Not supported for R5 stores. $ref: '#/components/schemas/DeidentifiedStoreDestination' GoogleCloudHealthcareV1FhirBigQueryDestination: id: GoogleCloudHealthcareV1FhirBigQueryDestination @@ -3585,8 +3665,8 @@ components: type: string config: description: >- - The configuration to use when de-identifying resources that are - added to this store. + Optional. The configuration to use when de-identifying resources + that are added to this store. $ref: '#/components/schemas/DeidentifyConfig' ValidationConfig: id: ValidationConfig @@ -3694,6 +3774,149 @@ components: from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. type: boolean + BulkExportGcsDestination: + id: BulkExportGcsDestination + description: >- + The configuration for exporting to Cloud Storage using the bulk export + API. + type: object + properties: + uriPrefix: + description: >- + Optional. URI for a Cloud Storage directory where the server writes + result files, in the format + `gs://{bucket-id}/{path/to/destination/dir}`. If there is no + trailing slash, the service appends one when composing the object + path. The user is responsible for creating the Cloud Storage bucket + referenced in `uri_prefix`. + type: string + ConsentConfig: + id: ConsentConfig + description: >- + Configures whether to enforce consent for the FHIR store and which + consent enforcement version is being used. + type: object + properties: + version: + description: >- + Required. Specifies which consent enforcement version is being used + for this FHIR store. This field can only be set once by either + CreateFhirStore or UpdateFhirStore. After that, you must call + ApplyConsents to change the version. + type: string + enumDescriptions: + - Users must specify an enforcement version or an error is returned. + - >- + Enforcement version 1. See the [FHIR Consent resources in the + Cloud Healthcare + API](https://cloud.google.com/healthcare-api/docs/fhir-consent) + guide for more details. + enum: + - CONSENT_ENFORCEMENT_VERSION_UNSPECIFIED + - V1 + accessEnforced: + description: >- + Optional. The default value is false. If set to true, when accessing + FHIR resources, the consent headers will be verified against + consents given by patients. See the ConsentEnforcementVersion for + the supported consent headers. + type: boolean + consentHeaderHandling: + description: >- + Optional. Different options to configure the behaviour of the server + when handling the `X-Consent-Scope` header. + $ref: '#/components/schemas/ConsentHeaderHandling' + accessDeterminationLogConfig: + description: >- + Optional. Specifies how the server logs the consent-aware requests. + If not specified, the + `AccessDeterminationLogConfig.LogLevel.MINIMUM` option is used. + $ref: '#/components/schemas/AccessDeterminationLogConfig' + enforcedAdminConsents: + description: >- + Output only. The versioned names of the enforced admin Consent + resource(s), in the format + `projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resource_id}/_history/{version_id}`. + For FHIR stores with `disable_resource_versioning=true`, the format + is + `projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resource_id}`. + This field can only be updated using ApplyAdminConsents. + readOnly: true + type: array + items: + type: string + ConsentHeaderHandling: + id: ConsentHeaderHandling + description: How the server handles the consent header. + type: object + properties: + profile: + description: >- + Optional. Specifies the default server behavior when the header is + empty. If not specified, the `ScopeProfile.PERMIT_EMPTY_SCOPE` + option is used. + type: string + enumDescriptions: + - If not specified, the default value `PERMIT_EMPTY_SCOPE` is used. + - >- + When no consent scopes are provided (for example, if there's an + empty or missing header), then consent check is disabled, similar + to when `access_enforced` is `false`. You can use audit logs to + differentiate these two cases by looking at the value of + `protopayload.metadata.consentMode`. If consents scopes are + present, they must be valid and within the allowed limits, + otherwise the request will be rejected with a `4xx` code. + - >- + The consent header must be non-empty when performing read and + search operations, otherwise the request is rejected with a `4xx` + code. Additionally, invalid consent scopes or scopes exceeding the + allowed limits are rejected. + enum: + - SCOPE_PROFILE_UNSPECIFIED + - PERMIT_EMPTY_SCOPE + - REQUIRED_ON_READ + AccessDeterminationLogConfig: + id: AccessDeterminationLogConfig + description: >- + Configures consent audit log config for FHIR create, read, update, and + delete (CRUD) operations. Cloud audit log for healthcare API must be + [enabled](https://cloud.google.com/logging/docs/audit/configure-data-access#config-console-enable). + The consent-related logs are included as part of + `protoPayload.metadata`. + type: object + properties: + logLevel: + description: >- + Optional. Controls the amount of detail to include as part of the + audit logs. + type: string + enumDescriptions: + - No log level specified. This value is unused. + - No additional consent-related logging is added to audit logs. + - >- + The following information is included: * One of the following + [`consentMode`](https://cloud.google.com/healthcare-api/docs/fhir-consent#audit_logs) + fields: (`off`|`emptyScope`|`enforced`|`btg`|`bypass`). * The + accessor's request headers * The `log_level` of the + AccessDeterminationLogConfig * The final consent evaluation + (`PERMIT`, `DENY`, or `NO_CONSENT`) * A human-readable summary of + the evaluation + - >- + Includes `MINIMUM` and, for each resource owner, returns: * The + resource owner's name * Most specific part of the + `X-Consent-Scope` resulting in consensual determination * + Timestamp of the applied enforcement leading to the decision * + Enforcement version at the time the applicable consents were + applied * The Consent resource name * The timestamp of the Consent + resource used for enforcement * Policy type (`PATIENT` or `ADMIN`) + Due to the limited space for logging, this mode is the same as + `MINIMUM` for methods that return multiple resources (such as FHIR + Search). + enum: + - LOG_LEVEL_UNSPECIFIED + - DISABLED + - MINIMUM + - VERBOSE ListFhirStoresResponse: id: ListFhirStoresResponse description: Lists the FHIR stores in the given dataset. @@ -3773,6 +3996,270 @@ components: `?` to match 1 character Files matching the wildcard are expected to contain content only, no metadata. type: string + ApplyConsentsRequest: + id: ApplyConsentsRequest + description: Request to apply the Consent resources for the specified FHIR store. + type: object + properties: + patientScope: + description: Optional. Scope down to a list of patients. + $ref: '#/components/schemas/PatientScope' + timeRange: + description: >- + Optional. Scope down to patients whose most recent consent changes + are in the time range. Can only be used with a versioning store + (i.e. when disable_resource_versioning is set to false). + $ref: '#/components/schemas/TimeRange' + validateOnly: + description: >- + Optional. If true, the method only validates Consent resources to + make sure they are supported. When the operation completes, + ApplyConsentsResponse is returned where `consent_apply_success` and + `consent_apply_failure` indicate supported and unsupported (or + invalid) Consent resources, respectively. Otherwise, the method + propagates the aggregate consensual information to the patient's + resources. Upon success, `affected_resources` in the + ApplyConsentsResponse indicates the number of resources that may + have consensual access changed. + type: boolean + PatientScope: + id: PatientScope + description: Apply consents given by a list of patients. + type: object + properties: + patientIds: + description: >- + Optional. The list of patient IDs whose Consent resources will be + enforced. At most 10,000 patients can be specified. An empty list is + equivalent to all patients (meaning the entire FHIR store). + type: array + items: + type: string + TimeRange: + id: TimeRange + description: >- + Apply consents given by patients whose most recent consent changes are + in the time range. Note that after identifying these patients, the + server applies all Consent resources given by those patients, not just + the Consent resources within the timestamp in the range. + type: object + properties: + start: + description: >- + Optional. The earliest consent change time, in format + YYYY-MM-DDThh:mm:ss.sss+zz:zz If not specified, the system uses the + FHIR store creation time. + type: string + end: + description: >- + Optional. The latest consent change time, in format + YYYY-MM-DDThh:mm:ss.sss+zz:zz If not specified, the system uses the + time when ApplyConsents was called. + type: string + ApplyAdminConsentsRequest: + id: ApplyAdminConsentsRequest + description: >- + Request to apply the admin Consent resources for the specified FHIR + store. + type: object + properties: + newConsentsList: + description: >- + A new list of admin Consent resources to be applied. Any existing + enforced Consents, which are specified in + `consent_config.enforced_admin_consents` of the FhirStore, that are + not part of this list will be disabled. An empty list is equivalent + to clearing or disabling all Consents enforced on the FHIR store. + When a FHIR store has `disable_resource_versioning=true` and this + list contains a Consent resource that exists in + `consent_config.enforced_admin_consents`, the method enforces any + updates to the existing resource since the last enforcement. If the + existing resource hasn't been updated since the last enforcement, + the resource is unaffected. After the method finishes, the resulting + consent enforcement model is determined by the contents of the + Consent resource(s) when the method was called: * When + `disable_resource_versioning=true`, the result is identical to the + current resource(s) in the FHIR store. * When + `disable_resource_versioning=false`, the result is based on the + historical version(s) of the Consent resource(s) at the point in + time when the method was called. At most 200 Consents can be + specified. + $ref: '#/components/schemas/AdminConsents' + validateOnly: + description: >- + Optional. If true, the method only validates Consent resources to + make sure they are supported. Otherwise, the method applies the + aggregate consent information to update the enforcement model and + reindex the FHIR resources. If all Consent resources can be applied + successfully, the ApplyAdminConsentsResponse is returned containing + the following fields: * `consent_apply_success` to indicate the + number of Consent resources applied. * `affected_resources` to + indicate the number of resources that might have had their consent + access changed. If, however, one or more Consent resources are + unsupported or cannot be applied, the method fails and + ApplyAdminConsentsErrorDetail is is returned with details about the + unsupported Consent resources. + type: boolean + AdminConsents: + id: AdminConsents + description: List of admin Consent resources to be applied. + type: object + properties: + names: + description: >- + Optional. The versioned names of the admin Consent resource(s), in + the format + `projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resource_id}/_history/{version_id}`. + For FHIR stores with `disable_resource_versioning=true`, the format + is + `projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resource_id}`. + type: array + items: + type: string + ExplainDataAccessResponse: + id: ExplainDataAccessResponse + description: >- + List of consent scopes that are applicable to the explained access on a + given resource. + type: object + properties: + consentScopes: + description: >- + List of applicable consent scopes. Sorted in order of actor such + that scopes belonging to the same actor will be adjacent to each + other in the list. + type: array + items: + $ref: '#/components/schemas/ExplainDataAccessConsentScope' + warning: + description: >- + Warnings associated with this response. It inform user with exceeded + scope limit errors. + type: string + ExplainDataAccessConsentScope: + id: ExplainDataAccessConsentScope + description: >- + A single consent scope that provides info on who has access to the + requested resource scope for a particular purpose and environment, + enforced by which consent. + type: object + properties: + decision: + description: >- + Whether the current consent scope is permitted or denied access on + the requested resource. + type: string + enumDescriptions: + - Unspecified consent decision type. + - Consent permitted access. + - Consent denied access. + enum: + - CONSENT_DECISION_TYPE_UNSPECIFIED + - CONSENT_DECISION_TYPE_PERMIT + - CONSENT_DECISION_TYPE_DENY + enforcingConsents: + description: >- + Metadata of the consent resources that enforce the consent scope's + access. + type: array + items: + $ref: '#/components/schemas/ExplainDataAccessConsentInfo' + exceptions: + description: Other consent scopes that created exceptions within this scope. + type: array + items: + $ref: '#/components/schemas/ExplainDataAccessConsentScope' + accessorScope: + description: >- + The accessor scope that describes who can access, for what purpose, + and in which environment. + $ref: '#/components/schemas/ConsentAccessorScope' + ExplainDataAccessConsentInfo: + id: ExplainDataAccessConsentInfo + description: The enforcing consent's metadata. + type: object + properties: + consentResource: + description: >- + The resource name of this consent resource, in the format: + `projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resource_id}`. + type: string + type: + description: The policy type of consent resource (e.g. PATIENT, ADMIN). + type: string + enumDescriptions: + - Unspecified policy type. + - Consent represent a patient consent. + - Consent represent an admin consent. + enum: + - CONSENT_POLICY_TYPE_UNSPECIFIED + - CONSENT_POLICY_TYPE_PATIENT + - CONSENT_POLICY_TYPE_ADMIN + variants: + description: >- + The consent's variant combinations. A single consent may have + multiple variants. + type: array + items: + type: string + enumDescriptions: + - Consent variant unspecified. + - Consent is a standard patient or admin consent. + - Consent is a cascading consent. + enum: + - CONSENT_VARIANT_UNSPECIFIED + - CONSENT_VARIANT_STANDARD + - CONSENT_VARIANT_CASCADE + enforcementTime: + description: Last enforcement timestamp of this consent resource. + type: string + format: google-datetime + patientConsentOwner: + description: >- + The patient owning the consent (only applicable for patient + consents), in the format: + `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Patient/{patient_id}` + type: string + cascadeOrigins: + description: >- + The compartment base resources that matched a cascading policy. Each + resource has the following format: + `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/{resource_type}/{resource_id}` + type: array + items: + type: string + matchingAccessorScopes: + description: >- + A list of all the matching accessor scopes of this consent policy + that enforced ExplainDataAccessConsentScope.accessor_scope. + type: array + items: + $ref: '#/components/schemas/ConsentAccessorScope' + ConsentAccessorScope: + id: ConsentAccessorScope + description: >- + The accessor scope that describes who can access, for what purpose, in + which environment. + type: object + properties: + actor: + description: >- + An individual, group, or access role that identifies the accessor or + a characteristic of the accessor. This can be a resource ID (such as + `{resourceType}/{id}`) or an external URI. This value must be + present. + type: string + purpose: + description: >- + The intent of data use. If it's not specified, it applies to all + purposes. + type: string + environment: + description: >- + An abstract identifier that describes the environment or conditions + under which the accessor is acting. If it's not specified, it + applies to all environments. + type: string ExportResourcesRequest: id: ExportResourcesRequest description: Request to export resources. @@ -4255,6 +4742,106 @@ components: "projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /fhirStores/{fhir_store_id}". type: string + ApplyConsentsResponse: + id: ApplyConsentsResponse + description: >- + Response when all Consent resources in scope were processed and all + affected resources were reindexed successfully. This structure is + included in the response when the operation finishes successfully. + type: object + properties: + consentApplySuccess: + description: >- + If `validate_only = false` in ApplyConsentsRequest, this counter is + the number of Consent resources that were successfully applied. + Otherwise, it is the number of Consent resources that are supported. + type: string + format: int64 + consentApplyFailure: + description: >- + If `validate_only = false` in ApplyConsentsRequest, this counter is + the number of Consent resources that were failed to apply. + Otherwise, it is the number of Consent resources that are not + supported or invalid. + type: string + format: int64 + affectedResources: + description: >- + The number of resources (including the Consent resources) that may + have consensual access change. + type: string + format: int64 + failedResources: + description: >- + The number of resources (including the Consent resources) that + ApplyConsents failed to re-index. + type: string + format: int64 + ApplyAdminConsentsResponse: + id: ApplyAdminConsentsResponse + description: >- + Response when all admin Consent resources in scope were processed and + all affected resources were reindexed successfully. This structure will + be included in the response when the operation finishes successfully. + type: object + properties: + consentApplySuccess: + description: >- + If `validate_only=false` in ApplyAdminConsentsRequest, this counter + contains the number of Consent resources that were successfully + applied. Otherwise, it is the number of Consent resources that are + supported. + type: string + format: int64 + affectedResources: + description: >- + The number of resources (including the Consent resources) that may + have consent access change. + type: string + format: int64 + failedResources: + description: >- + The number of resources (including the Consent resources) that + ApplyAdminConsents failed to re-index. + type: string + format: int64 + ApplyAdminConsentsErrorDetail: + id: ApplyAdminConsentsErrorDetail + description: >- + Contains the error details of the unsupported admin Consent resources + for when the ApplyAdminConsents method fails to apply one or more + Consent resources. + type: object + properties: + consentErrors: + description: >- + The list of Consent resources that are unsupported or cannot be + applied and the error associated with each of them. + type: array + items: + $ref: '#/components/schemas/ConsentErrors' + existingOperationId: + description: >- + The currently in progress non-validate-only ApplyAdminConsents + operation ID if exist. + type: string + format: uint64 + ConsentErrors: + id: ConsentErrors + description: The Consent resource name and error. + type: object + properties: + name: + description: >- + The versioned name of the admin Consent resource, in the format + `projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resource_id}/_history/{version_id}`. + For FHIR stores with `disable_resource_versioning=true`, the format + is + `projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resource_id}`. + type: string + error: + description: The error code and message. + $ref: '#/components/schemas/Status' ExportMessagesResponse: id: ExportMessagesResponse description: >- @@ -4774,10 +5361,10 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/consents/methods/delete' - consents_revision: - id: google.healthcare.consents_revision - name: consents_revision - title: Consents_revision + consents_revisions: + id: google.healthcare.consents_revisions + name: consents_revisions + title: Consents_revisions methods: delete_revision: operation: @@ -4786,19 +5373,6 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/consents_revision/methods/delete_revision - consents_revisions: - id: google.healthcare.consents_revisions - name: consents_revisions - title: Consents_revisions - methods: list_revisions: operation: $ref: >- @@ -4814,7 +5388,9 @@ components: insert: [] update: [] replace: [] - delete: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/consents_revisions/methods/delete_revision user_data_mappings: id: google.healthcare.user_data_mappings name: user_data_mappings @@ -5045,6 +5621,27 @@ components: response: mediaType: application/json openAPIDocKey: '200' + retrieve_frames: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1dicomStores~1{dicomStoresId}~1dicomWeb~1studies~1{studiesId}~1series~1{seriesId}~1instances~1{instancesId}~1frames~1{framesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + retrieve_rendered: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1dicomStores~1{dicomStoresId}~1dicomWeb~1studies~1{studiesId}~1series~1{seriesId}~1instances~1{instancesId}~1frames~1{framesId}~1rendered/get + response: + mediaType: application/json + openAPIDocKey: '200' + retrieve_bulkdata: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1dicomStores~1{dicomStoresId}~1dicomWeb~1studies~1{studiesId}~1series~1{seriesId}~1instances~1{instancesId}~1bulkdata~1{bulkdataId}~1{bulkdataId1}/get + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/dicom_stores/methods/get' @@ -5056,10 +5653,10 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/dicom_stores/methods/delete' - dicom_stores_dicomstore_metrics: - id: google.healthcare.dicom_stores_dicomstore_metrics - name: dicom_stores_dicomstore_metrics - title: Dicom_stores_dicomstore_metrics + dicom_store_metrics: + id: google.healthcare.dicom_store_metrics + name: dicom_store_metrics + title: Dicom_store_metrics methods: get_dicomstore_metrics: operation: @@ -5071,7 +5668,7 @@ components: sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/dicom_stores_dicomstore_metrics/methods/get_dicomstore_metrics + #/components/x-stackQL-resources/dicom_store_metrics/methods/get_dicomstore_metrics insert: [] update: [] replace: [] @@ -5123,10 +5720,10 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/studies/methods/delete' - studies_study_metrics: - id: google.healthcare.studies_study_metrics - name: studies_study_metrics - title: Studies_study_metrics + study_metrics: + id: google.healthcare.study_metrics + name: study_metrics + title: Study_metrics methods: get_study_metrics: operation: @@ -5138,15 +5735,15 @@ components: sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/studies_study_metrics/methods/get_study_metrics + #/components/x-stackQL-resources/study_metrics/methods/get_study_metrics insert: [] update: [] replace: [] delete: [] - series_series_metrics: - id: google.healthcare.series_series_metrics - name: series_series_metrics - title: Series_series_metrics + series_metrics: + id: google.healthcare.series_metrics + name: series_metrics + title: Series_metrics methods: get_series_metrics: operation: @@ -5158,7 +5755,7 @@ components: sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/series_series_metrics/methods/get_series_metrics + #/components/x-stackQL-resources/series_metrics/methods/get_series_metrics insert: [] update: [] replace: [] @@ -5223,10 +5820,10 @@ components: update: [] replace: [] delete: [] - series_series: - id: google.healthcare.series_series - name: series_series - title: Series_series + series: + id: google.healthcare.series + name: series + title: Series methods: retrieve_series: operation: @@ -5235,19 +5832,6 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/series_series/methods/retrieve_series - insert: [] - update: [] - replace: [] - delete: [] - series: - id: google.healthcare.series - name: series - title: Series - methods: delete: operation: $ref: >- @@ -5263,7 +5847,8 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: '#/components/x-stackQL-resources/series/methods/retrieve_series' insert: [] update: [] replace: [] @@ -5289,10 +5874,10 @@ components: update: [] replace: [] delete: [] - instances_instance: - id: google.healthcare.instances_instance - name: instances_instance - title: Instances_instance + instances: + id: google.healthcare.instances + name: instances + title: Instances methods: retrieve_instance: operation: @@ -5301,19 +5886,6 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/instances_instance/methods/retrieve_instance - insert: [] - update: [] - replace: [] - delete: [] - instances: - id: google.healthcare.instances - name: instances - title: Instances - methods: delete: operation: $ref: >- @@ -5322,7 +5894,9 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/instances/methods/retrieve_instance insert: [] update: [] replace: [] @@ -5368,46 +5942,6 @@ components: update: [] replace: [] delete: [] - frames_frames: - id: google.healthcare.frames_frames - name: frames_frames - title: Frames_frames - methods: - retrieve_frames: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1dicomStores~1{dicomStoresId}~1dicomWeb~1studies~1{studiesId}~1series~1{seriesId}~1instances~1{instancesId}~1frames~1{framesId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/frames_frames/methods/retrieve_frames - insert: [] - update: [] - replace: [] - delete: [] - frames_rendered: - id: google.healthcare.frames_rendered - name: frames_rendered - title: Frames_rendered - methods: - retrieve_rendered: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1dicomStores~1{dicomStoresId}~1dicomWeb~1studies~1{studiesId}~1series~1{seriesId}~1instances~1{instancesId}~1frames~1{framesId}~1rendered/get - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/frames_rendered/methods/retrieve_rendered - insert: [] - update: [] - replace: [] - delete: [] hl7_v2_stores_iam_policies: id: google.healthcare.hl7_v2_stores_iam_policies name: hl7_v2_stores_iam_policies @@ -5518,10 +6052,10 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/hl7_v2_stores/methods/delete' - hl7_v2_stores_hl7v2_store_metrics: - id: google.healthcare.hl7_v2_stores_hl7v2_store_metrics - name: hl7_v2_stores_hl7v2_store_metrics - title: Hl7_v2_stores_hl7v2_store_metrics + hl7_v2_store_metrics: + id: google.healthcare.hl7_v2_store_metrics + name: hl7_v2_store_metrics + title: Hl7_v2_store_metrics methods: get_hl7v2_store_metrics: operation: @@ -5533,7 +6067,7 @@ components: sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/hl7_v2_stores_hl7v2_store_metrics/methods/get_hl7v2_store_metrics + #/components/x-stackQL-resources/hl7_v2_store_metrics/methods/get_hl7v2_store_metrics insert: [] update: [] replace: [] @@ -5646,6 +6180,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + bulk-export-group: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1fhirStores~1{fhirStoresId}~1fhir~1Group~1{GroupId}~1$export/get + response: + mediaType: application/json + openAPIDocKey: '200' create: operation: $ref: >- @@ -5689,6 +6230,27 @@ components: response: mediaType: application/json openAPIDocKey: '200' + apply_consents: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1fhirStores~1{fhirStoresId}:applyConsents/post + response: + mediaType: application/json + openAPIDocKey: '200' + apply_admin_consents: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1fhirStores~1{fhirStoresId}:applyAdminConsents/post + response: + mediaType: application/json + openAPIDocKey: '200' + explain_data_access: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1fhirStores~1{fhirStoresId}:explainDataAccess/get + response: + mediaType: application/json + openAPIDocKey: '200' export: operation: $ref: >- @@ -5714,10 +6276,10 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/fhir_stores/methods/delete' - fhir_stores_fhirstore_metrics: - id: google.healthcare.fhir_stores_fhirstore_metrics - name: fhir_stores_fhirstore_metrics - title: Fhir_stores_fhirstore_metrics + fhir_store_metrics: + id: google.healthcare.fhir_store_metrics + name: fhir_store_metrics + title: Fhir_store_metrics methods: get_fhirstore_metrics: operation: @@ -5729,7 +6291,7 @@ components: sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/fhir_stores_fhirstore_metrics/methods/get_fhirstore_metrics + #/components/x-stackQL-resources/fhir_store_metrics/methods/get_fhirstore_metrics insert: [] update: [] replace: [] @@ -5879,6 +6441,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + bulk-export: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1fhirStores~1{fhirStoresId}~1fhir~1$export/get + response: + mediaType: application/json + openAPIDocKey: '200' resource-validate: operation: $ref: >- @@ -5886,6 +6455,20 @@ components: response: mediaType: application/json openAPIDocKey: '200' + consent-enforcement-status: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1fhirStores~1{fhirStoresId}~1fhir~1Consent~1{ConsentId}~1$consent-enforcement-status/get + response: + mediaType: application/json + openAPIDocKey: '200' + patient-consent-enforcement-status: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1fhirStores~1{fhirStoresId}~1fhir~1Patient~1{PatientId}~1$consent-enforcement-status/get + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: [] insert: @@ -5896,11 +6479,38 @@ components: - $ref: '#/components/x-stackQL-resources/fhir/methods/update' delete: - $ref: '#/components/x-stackQL-resources/fhir/methods/delete' + fhir_operation_status: + id: google.healthcare.fhir_operation_status + name: fhir_operation_status + title: Fhir_operation_status + methods: + get-fhir-operation-status: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1fhirStores~1{fhirStoresId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/fhir_operation_status/methods/get-fhir-operation-status + insert: [] + update: [] + replace: [] + delete: [] operations: id: google.healthcare.operations name: operations title: Operations methods: + delete-fhir-operation: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1fhirStores~1{fhirStoresId}~1operations~1{operationsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' list: operation: $ref: >- @@ -6001,6 +6611,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: @@ -9660,8 +10274,7 @@ paths: get: description: >- RetrieveStudyMetadata returns instance associated with the given study - presented as metadata with the bulk data removed. See - [RetrieveTransaction] + presented as metadata. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudyMetadata, see [Metadata @@ -9949,8 +10562,7 @@ paths: get: description: >- RetrieveSeriesMetadata returns instance associated with the given study - and series, presented as metadata with the bulk data removed. See - [RetrieveTransaction] + and series, presented as metadata. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeriesMetadata, see [Metadata @@ -10267,13 +10879,17 @@ paths: required: true schema: type: string + - in: query + name: viewport + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/metadata: parameters: *ref_1 get: description: >- RetrieveInstanceMetadata returns instance associated with the given - study, series, and SOP Instance UID presented as metadata with the bulk - data removed. See [RetrieveTransaction] + study, series, and SOP Instance UID presented as metadata. See + [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstanceMetadata, see [Metadata @@ -10479,6 +11095,86 @@ paths: required: true schema: type: string + - in: query + name: viewport + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/bulkdata/{bulkdataId}/{bulkdataId1}: + parameters: *ref_1 + get: + description: >- + Returns uncompressed, unencoded bytes representing the referenced + bulkdata tag from an instance. See [Retrieve + Transaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). + For details on the implementation of RetrieveBulkdata, see [Bulkdata + resources](https://cloud.google.com/healthcare/docs/dicom#bulkdata-resources) + in the Cloud Healthcare API conformance statement. For samples that show + how to call RetrieveBulkdata, see [Retrieve + bulkdata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-bulkdata). + operationId: >- + healthcare.projects.locations.datasets.dicomStores.studies.series.instances.bulkdata.retrieveBulkdata + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-healthcare + Oauth2c: + - https://www.googleapis.com/auth/cloud-healthcare + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/HttpBody' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: dicomStoresId + required: true + schema: + type: string + - in: path + name: studiesId + required: true + schema: + type: string + - in: path + name: seriesId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + - in: path + name: bulkdataId + required: true + schema: + type: string + - in: path + name: bulkdataId1 + required: true + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/hl7V2Stores/{hl7V2StoresId}:setIamPolicy: parameters: *ref_1 post: @@ -11618,6 +12314,102 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Group/{GroupId}/$export: + parameters: *ref_1 + get: + description: >- + Bulk exports a Group resource and resources in the member field, + including related resources for each Patient member. The export for each + Patient is identical to a GetPatientEverything request. Implements the + FHIR implementation guide [$export group of + patients](https://build.fhir.org/ig/HL7/bulk-data/export.html#endpoint---group-of-patients). + The following headers must be set in the request: * `Accept`: specifies + the format of the `OperationOutcome` response. Only + `application/fhir+json` is supported. * `Prefer`: specifies whether the + response is immediate or asynchronous. Must be to `respond-async` + because only asynchronous responses are supported. Specify the + destination for the server to write result files by setting the Cloud + Storage location bulk_export_gcs_destination on the FHIR store. URI of + an existing Cloud Storage directory where the server writes result + files, in the format gs://{bucket-id}/{path/to/destination/dir}. If + there is no trailing slash, the service appends one when composing the + object path. The user is responsible for creating the Cloud Storage + bucket referenced. Supports the following query parameters: * `_type`: + string of comma-delimited FHIR resource types. If provided, only + resources of the specified type(s) are exported. * `_since`: if + provided, only resources updated after the specified time are exported. + * `_outputFormat`: optional, specify ndjson to export data in NDJSON + format. Exported file names use the format: + {export_id}_{resource_type}.ndjson. * `organizeOutputBy`: resource type + to organize the output by. Required and must be set to `Patient`. When + specified, output files are organized by instances of the specified + resource type, including the resource, referenced resources, and + resources that contain references to that resource. On success, the + `Content-Location` header of response is set to a URL that you can use + to query the status of the export. The URL is in the format + `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/operations/{export_id}`. + See get-fhir-operation-status for more information. Errors generated by + the FHIR store contain a JSON-encoded `OperationOutcome` resource + describing the reason for the error. + operationId: healthcare.projects.locations.datasets.fhirStores.bulk-export-group + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-healthcare + Oauth2c: + - https://www.googleapis.com/auth/cloud-healthcare + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/HttpBody' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: fhirStoresId + required: true + schema: + type: string + - in: path + name: GroupId + required: true + schema: + type: string + - in: query + name: _since + schema: + type: string + - in: query + name: _type + schema: + type: string + - in: query + name: outputFormat + schema: + type: string + - in: query + name: organizeOutputBy + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores: parameters: *ref_1 post: @@ -11949,25 +12741,31 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:export: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:applyConsents: parameters: *ref_1 post: description: >- - Export resources from the FHIR store to the specified destination. This - method returns an Operation that can be used to track the status of the - export by calling GetOperation. Immediate fatal errors appear in the - error field, errors are also logged to Cloud Logging (see [Viewing error + Apply the Consent resources for the FHIR store and reindex the + underlying resources in the FHIR store according to the aggregate + consent. The aggregate consent of the patient in scope in this request + replaces any previous call of this method. Any Consent resource change + after this operation execution (including deletion) requires you to call + ApplyConsents again to have effect. This method returns an Operation + that can be used to track the progress of the consent resources that + were processed by calling GetOperation. Upon completion, the + ApplyConsentsResponse additionally contains the number of resources that + was reindexed. Errors are logged to Cloud Logging (see [Viewing error logs in Cloud - Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). - Otherwise, when the operation finishes, a detailed response of type - ExportResourcesResponse is returned in the response field. The metadata - field type for this operation is OperationMetadata. - operationId: healthcare.projects.locations.datasets.fhirStores.export + Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). To + enforce consent check for data access, `consent_config.access_enforced` + must be set to true for the FhirStore. FHIR Consent is not supported in + DSTU2 or R5. + operationId: healthcare.projects.locations.datasets.fhirStores.applyConsents requestBody: content: application/json: schema: - $ref: '#/components/schemas/ExportResourcesRequest' + $ref: '#/components/schemas/ApplyConsentsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare @@ -12005,12 +12803,180 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:getFHIRStoreMetrics: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:applyAdminConsents: parameters: *ref_1 - get: - description: Gets metrics associated with the FHIR store. - operationId: healthcare.projects.locations.datasets.fhirStores.getFHIRStoreMetrics - security: + post: + description: >- + Applies the admin Consent resources for the FHIR store and reindexes the + underlying resources in the FHIR store according to the aggregate + consents. This method also updates the + `consent_config.enforced_admin_consents` field of the FhirStore unless + `validate_only=true` in ApplyAdminConsentsRequest. Any admin Consent + resource change after this operation execution (including deletion) + requires you to call ApplyAdminConsents again for the change to take + effect. This method returns an Operation that can be used to track the + progress of the resources that were reindexed, by calling GetOperation. + Upon completion, the ApplyAdminConsentsResponse additionally contains + the number of resources that were reindexed. If at least one Consent + resource contains an error or fails be be enforced for any reason, the + method returns an error instead of an Operation. No resources will be + reindexed and the `consent_config.enforced_admin_consents` field will be + unchanged. To enforce a consent check for data access, + `consent_config.access_enforced` must be set to true for the FhirStore. + FHIR Consent is not supported in DSTU2 or R5. + operationId: healthcare.projects.locations.datasets.fhirStores.applyAdminConsents + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ApplyAdminConsentsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-healthcare + Oauth2c: + - https://www.googleapis.com/auth/cloud-healthcare + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: fhirStoresId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:explainDataAccess: + parameters: *ref_1 + get: + description: >- + Explains all the permitted/denied actor, purpose and environment for a + given resource. FHIR Consent is not supported in DSTU2 or R5. + operationId: healthcare.projects.locations.datasets.fhirStores.explainDataAccess + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-healthcare + Oauth2c: + - https://www.googleapis.com/auth/cloud-healthcare + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ExplainDataAccessResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: fhirStoresId + required: true + schema: + type: string + - in: query + name: resourceId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:export: + parameters: *ref_1 + post: + description: >- + Export resources from the FHIR store to the specified destination. This + method returns an Operation that can be used to track the status of the + export by calling GetOperation. Immediate fatal errors appear in the + error field, errors are also logged to Cloud Logging (see [Viewing error + logs in Cloud + Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). + Otherwise, when the operation finishes, a detailed response of type + ExportResourcesResponse is returned in the response field. The metadata + field type for this operation is OperationMetadata. + operationId: healthcare.projects.locations.datasets.fhirStores.export + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExportResourcesRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-healthcare + Oauth2c: + - https://www.googleapis.com/auth/cloud-healthcare + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: fhirStoresId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:getFHIRStoreMetrics: + parameters: *ref_1 + get: + description: Gets metrics associated with the FHIR store. + operationId: healthcare.projects.locations.datasets.fhirStores.getFHIRStoreMetrics + security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare Oauth2c: @@ -12108,30 +13074,31 @@ paths: post: description: >- Creates a FHIR resource. Implements the FHIR standard create interaction - ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#create), - [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#create), - [R4](http://hl7.org/implement/standards/fhir/R4/http.html#create)), - which creates a new resource with a server-assigned resource ID. Also - supports the FHIR standard conditional create interaction - ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#ccreate), - [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#ccreate), - [R4](https://hl7.org/implement/standards/fhir/R4/http.html#ccreate)), - specified by supplying an `If-None-Exist` header containing a FHIR - search query, limited to searching by resource identifier. If no - resources match this search query, the server processes the create - operation as normal. When using conditional create, the search term for - identifier should be in the pattern `identifier=system|value` or - `identifier=value` - similar to the `search` method on resources with a - specific identifier. The request body must contain a JSON-encoded FHIR - resource, and the request headers must contain `Content-Type: - application/fhir+json`. On success, the response body contains a - JSON-encoded representation of the resource as it was created on the - server, including the server-assigned resource ID and version ID. Errors - generated by the FHIR store contain a JSON-encoded `OperationOutcome` - resource describing the reason for the error. If the request cannot be - mapped to a valid API method on a FHIR store, a generic GCP error might - be returned instead. For samples that show how to call `create`, see - [Creating a FHIR + ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#create), + [STU3](https://hl7.org/fhir/STU3/http.html#create), + [R4](https://hl7.org/fhir/R4/http.html#create), + [R5](https://hl7.org/fhir/R5/http.html#create)), which creates a new + resource with a server-assigned resource ID. Also supports the FHIR + standard conditional create interaction + ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#ccreate), + [STU3](https://hl7.org/fhir/STU3/http.html#ccreate), + [R4](https://hl7.org/fhir/R4/http.html#ccreate), + [R5](https://hl7.org/fhir/R5/http.html#ccreate)), specified by supplying + an `If-None-Exist` header containing a FHIR search query, limited to + searching by resource identifier. If no resources match this search + query, the server processes the create operation as normal. When using + conditional create, the search term for identifier should be in the + pattern `identifier=system|value` or `identifier=value` - similar to the + `search` method on resources with a specific identifier. The request + body must contain a JSON-encoded FHIR resource, and the request headers + must contain `Content-Type: application/fhir+json`. On success, the + response body contains a JSON-encoded representation of the resource as + it was created on the server, including the server-assigned resource ID + and version ID. Errors generated by the FHIR store contain a + JSON-encoded `OperationOutcome` resource describing the reason for the + error. If the request cannot be mapped to a valid API method on a FHIR + store, a generic GCP error might be returned instead. For samples that + show how to call `create`, see [Creating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#creating_a_fhir_resource). operationId: healthcare.projects.locations.datasets.fhirStores.fhir.create requestBody: @@ -12399,15 +13366,15 @@ paths: in the same way as non-FHIR data (e.g., images, zip archives, pdf files, documents). When a non-FHIR content type is used in the request, a Binary resource will be generated, and the uploaded data will be stored - in the `content` field (`DSTU2` and `STU3`), or the `data` field (`R4`). - The Binary resource's `contentType` will be filled in using the value of - the `Content-Type` header, and the `securityContext` field (not present - in `DSTU2`) will be populated from the `X-Security-Context` header if it - exists. At this time `securityContext` has no special behavior in the - Cloud Healthcare API. Note: the limit on data ingested through this - method is 2 GB. For best performance, use a non-FHIR data type instead - of wrapping the data in a Binary resource. Some of the Healthcare API - features, such as [exporting to + in the `content` field (`DSTU2` and `STU3`), or the `data` field (`R4` + and `R5`). The Binary resource's `contentType` will be filled in using + the value of the `Content-Type` header, and the `securityContext` field + (not present in `DSTU2`) will be populated from the `X-Security-Context` + header if it exists. At this time `securityContext` has no special + behavior in the Cloud Healthcare API. Note: the limit on data ingested + through this method is 1 GB. For best performance, use a non-FHIR data + type instead of wrapping the data in a Binary resource. Some of the + Healthcare API features, such as [exporting to BigQuery](https://cloud.google.com/healthcare-api/docs/how-tos/fhir-export-bigquery) or [Pub/Sub notifications](https://cloud.google.com/healthcare-api/docs/fhir-pubsub#behavior_when_a_fhir_resource_is_too_large_or_traffic_is_high) @@ -12469,22 +13436,22 @@ paths: get: description: >- Gets the contents of a FHIR resource. Implements the FHIR standard read - interaction - ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#read), - [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#read), - [R4](http://hl7.org/implement/standards/fhir/R4/http.html#read)). Also - supports the FHIR standard conditional read interaction - ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#cread), - [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#cread), - [R4](http://hl7.org/implement/standards/fhir/R4/http.html#cread)) - specified by supplying an `If-Modified-Since` header with a date/time - value or an `If-None-Match` header with an ETag value. On success, the - response body contains a JSON-encoded representation of the resource. - Errors generated by the FHIR store contain a JSON-encoded - `OperationOutcome` resource describing the reason for the error. If the - request cannot be mapped to a valid API method on a FHIR store, a - generic GCP error might be returned instead. For samples that show how - to call `read`, see [Getting a FHIR + interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#read), + [STU3](https://hl7.org/fhir/STU3/http.html#read), + [R4](https://hl7.org/fhir/R4/http.html#read), + [R5](https://hl7.org/fhir/R5/http.html#read)). Also supports the FHIR + standard conditional read interaction + ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#cread), + [STU3](https://hl7.org/fhir/STU3/http.html#cread), + [R4](https://hl7.org/fhir/R4/http.html#cread), + [R5](https://hl7.org/fhir/R5/http.html#cread)) specified by supplying an + `If-Modified-Since` header with a date/time value or an `If-None-Match` + header with an ETag value. On success, the response body contains a + JSON-encoded representation of the resource. Errors generated by the + FHIR store contain a JSON-encoded `OperationOutcome` resource describing + the reason for the error. If the request cannot be mapped to a valid API + method on a FHIR store, a generic GCP error might be returned instead. + For samples that show how to call `read`, see [Getting a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#getting_a_fhir_resource). operationId: healthcare.projects.locations.datasets.fhirStores.fhir.read security: @@ -12537,15 +13504,15 @@ paths: delete: description: >- Deletes a FHIR resource. Implements the FHIR standard delete interaction - ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#delete), - [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#delete), - [R4](http://hl7.org/implement/standards/fhir/R4/http.html#delete)). - Note: Unless resource versioning is disabled by setting the - disable_resource_versioning flag on the FHIR store, the deleted - resources will be moved to a history repository that can still be - retrieved through vread and related methods, unless they are removed by - the purge method. For samples that show how to call `delete`, see - [Deleting a FHIR + ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#delete), + [STU3](https://hl7.org/fhir/STU3/http.html#delete), + [R4](https://hl7.org/fhir/R4/http.html#delete), + [R5](https://hl7.org/fhir/R5/http.html#delete)). Note: Unless resource + versioning is disabled by setting the disable_resource_versioning flag + on the FHIR store, the deleted resources will be moved to a history + repository that can still be retrieved through vread and related + methods, unless they are removed by the purge method. For samples that + show how to call `delete`, see [Deleting a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#deleting_a_fhir_resource). operationId: healthcare.projects.locations.datasets.fhirStores.fhir.delete security: @@ -12599,25 +13566,28 @@ paths: description: >- Updates the entire contents of a resource. Implements the FHIR standard update interaction - ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#update), - [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#update), - [R4](http://hl7.org/implement/standards/fhir/R4/http.html#update)). If - the specified resource does not exist and the FHIR store has - enable_update_create set, creates the resource with the client-specified - ID. It is strongly advised not to include or encode any sensitive data - such as patient identifiers in client-specified resource IDs. Those IDs - are part of the FHIR resource path recorded in Cloud Audit Logs and - Pub/Sub notifications. Those IDs can also be contained in reference - fields within other resources. The request body must contain a - JSON-encoded FHIR resource, and the request headers must contain - `Content-Type: application/fhir+json`. The resource must contain an `id` - element having an identical value to the ID in the REST path of the - request. On success, the response body contains a JSON-encoded - representation of the updated resource, including the server-assigned - version ID. Errors generated by the FHIR store contain a JSON-encoded - `OperationOutcome` resource describing the reason for the error. If the - request cannot be mapped to a valid API method on a FHIR store, a - generic GCP error might be returned instead. For samples that show how + ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#update), + [STU3](https://hl7.org/fhir/STU3/http.html#update), + [R4](https://hl7.org/fhir/R4/http.html#update), + [R5](https://hl7.org/fhir/R5/http.html#update)). If the specified + resource does not exist and the FHIR store has enable_update_create set, + creates the resource with the client-specified ID. It is strongly + advised not to include or encode any sensitive data such as patient + identifiers in client-specified resource IDs. Those IDs are part of the + FHIR resource path recorded in Cloud Audit Logs and Pub/Sub + notifications. Those IDs can also be contained in reference fields + within other resources. The request body must contain a JSON-encoded + FHIR resource, and the request headers must contain `Content-Type: + application/fhir+json`. The resource must contain an `id` element having + an identical value to the ID in the REST path of the request. On + success, the response body contains a JSON-encoded representation of the + updated resource, including the server-assigned version ID. Errors + generated by the FHIR store contain a JSON-encoded `OperationOutcome` + resource describing the reason for the error. If the request cannot be + mapped to a valid API method on a FHIR store, a generic GCP error might + be returned instead. The conditional update interaction If-None-Match is + supported, including the wildcard behaviour, as defined by the R5 spec. + This functionality is supported in R4 and R5. For samples that show how to call `update`, see [Updating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#updating_a_fhir_resource). operationId: healthcare.projects.locations.datasets.fhirStores.fhir.update @@ -12678,11 +13648,12 @@ paths: Updates part of an existing resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard patch interaction - ([STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#patch), - [R4](http://hl7.org/implement/standards/fhir/R4/http.html#patch)). DSTU2 - doesn't define a patch method, but the server supports it in the same - way it supports STU3. The request body must contain a JSON Patch - document, and the request headers must contain `Content-Type: + ([STU3](https://hl7.org/fhir/STU3/http.html#patch), + [R4](https://hl7.org/fhir/R4/http.html#patch), + [R5](https://hl7.org/fhir/R5/http.html#patch)). DSTU2 doesn't define a + patch method, but the server supports it in the same way it supports + STU3. The request body must contain a JSON Patch document, and the + request headers must contain `Content-Type: application/json-patch+json`. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a @@ -12817,15 +13788,15 @@ paths: treated in the same way as non-FHIR data. When a non-FHIR content type is used in the request, a Binary resource will be generated using the ID from the resource path, and the uploaded data will be stored in the - `content` field (`DSTU2` and `STU3`), or the `data` field (`R4`). The - Binary resource's `contentType` will be filled in using the value of the - `Content-Type` header, and the `securityContext` field (not present in - `DSTU2`) will be populated from the `X-Security-Context` header if it - exists. At this time `securityContext` has no special behavior in the - Cloud Healthcare API. Note: the limit on data ingested through this - method is 2 GB. For best performance, use a non-FHIR data type instead - of wrapping the data in a Binary resource. Some of the Healthcare API - features, such as [exporting to + `content` field (`DSTU2` and `STU3`), or the `data` field (`R4` and + `R5`). The Binary resource's `contentType` will be filled in using the + value of the `Content-Type` header, and the `securityContext` field (not + present in `DSTU2`) will be populated from the `X-Security-Context` + header if it exists. At this time `securityContext` has no special + behavior in the Cloud Healthcare API. Note: the limit on data ingested + through this method is 2 GB. For best performance, use a non-FHIR data + type instead of wrapping the data in a Binary resource. Some of the + Healthcare API features, such as [exporting to BigQuery](https://cloud.google.com/healthcare-api/docs/how-tos/fhir-export-bigquery) or [Pub/Sub notifications](https://cloud.google.com/healthcare-api/docs/fhir-pubsub#behavior_when_a_fhir_resource_is_too_large_or_traffic_is_high) @@ -12893,15 +13864,16 @@ paths: description: >- Gets the contents of a version (current or historical) of a FHIR resource by version ID. Implements the FHIR standard vread interaction - ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#vread), - [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#vread), - [R4](http://hl7.org/implement/standards/fhir/R4/http.html#vread)). On - success, the response body contains a JSON-encoded representation of the - resource. Errors generated by the FHIR store contain a JSON-encoded - `OperationOutcome` resource describing the reason for the error. If the - request cannot be mapped to a valid API method on a FHIR store, a - generic GCP error might be returned instead. For samples that show how - to call `vread`, see [Retrieving a FHIR resource + ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#vread), + [STU3](https://hl7.org/fhir/STU3/http.html#vread), + [R4](https://hl7.org/fhir/R4/http.html#vread), + [R5](https://hl7.org/fhir/R5/http.html#vread)). On success, the response + body contains a JSON-encoded representation of the resource. Errors + generated by the FHIR store contain a JSON-encoded `OperationOutcome` + resource describing the reason for the error. If the request cannot be + mapped to a valid API method on a FHIR store, a generic GCP error might + be returned instead. For samples that show how to call `vread`, see + [Retrieving a FHIR resource version](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#retrieving_a_fhir_resource_version). operationId: healthcare.projects.locations.datasets.fhirStores.fhir.vread security: @@ -13024,18 +13996,19 @@ paths: description: >- Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search - interaction - ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#search), - [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#search), - [R4](http://hl7.org/implement/standards/fhir/R4/http.html#search)) using - the search semantics described in the FHIR Search specification - ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/search.html), - [STU3](http://hl7.org/implement/standards/fhir/STU3/search.html), - [R4](http://hl7.org/implement/standards/fhir/R4/search.html)). Supports - four methods of search defined by the specification: * `GET - [base]?[parameters]` to search across all resources. * `GET - [base]/[type]?[parameters]` to search resources of a specified type. * - `POST [base]/_search?[parameters]` as an alternate form having the same + interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#search), + [STU3](https://hl7.org/fhir/STU3/http.html#search), + [R4](https://hl7.org/fhir/R4/http.html#search), + [R5](https://hl7.org/fhir/R5/http.html#search)) using the search + semantics described in the FHIR Search specification + ([DSTU2](https://hl7.org/fhir/DSTU2/search.html), + [STU3](https://hl7.org/fhir/STU3/search.html), + [R4](https://hl7.org/fhir/R4/search.html), + [R5](https://hl7.org/fhir/R5/search.html)). Supports four methods of + search defined by the specification: * `GET [base]?[parameters]` to + search across all resources. * `GET [base]/[type]?[parameters]` to + search resources of a specified type. * `POST + [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and @@ -13051,13 +14024,14 @@ paths: parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry - ([STU3](http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), - [R4](http://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). - FHIR search parameters for DSTU2 can be found on each resource's - definition page. Supported search modifiers: `:missing`, `:exact`, - `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, - `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4). Supported - search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, + ([STU3](https://hl7.org/fhir/STU3/searchparameter-registry.html), + [R4](https://hl7.org/fhir/R4/searchparameter-registry.html), + [R5](https://hl7.org/fhir/R5/searchparameter-registry.html)). FHIR + search parameters for DSTU2 can be found on each resource's definition + page. Supported search modifiers: `:missing`, `:exact`, `:contains`, + `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and + `recurse` (DSTU2 and STU3) or `:iterate` (R4 and R5). Supported search + result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might @@ -13140,18 +14114,19 @@ paths: description: >- Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search - interaction - ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#search), - [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#search), - [R4](http://hl7.org/implement/standards/fhir/R4/http.html#search)) using - the search semantics described in the FHIR Search specification - ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/search.html), - [STU3](http://hl7.org/implement/standards/fhir/STU3/search.html), - [R4](http://hl7.org/implement/standards/fhir/R4/search.html)). Supports - four methods of search defined by the specification: * `GET - [base]?[parameters]` to search across all resources. * `GET - [base]/[type]?[parameters]` to search resources of a specified type. * - `POST [base]/_search?[parameters]` as an alternate form having the same + interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#search), + [STU3](https://hl7.org/fhir/STU3/http.html#search), + [R4](https://hl7.org/fhir/R4/http.html#search), + [R5](https://hl7.org/fhir/R5/http.html#search)) using the search + semantics described in the FHIR Search specification + ([DSTU2](https://hl7.org/fhir/DSTU2/search.html), + [STU3](https://hl7.org/fhir/STU3/search.html), + [R4](https://hl7.org/fhir/R4/search.html), + [R5](https://hl7.org/fhir/R5/search.html)). Supports four methods of + search defined by the specification: * `GET [base]?[parameters]` to + search across all resources. * `GET [base]/[type]?[parameters]` to + search resources of a specified type. * `POST + [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and @@ -13167,13 +14142,14 @@ paths: parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry - ([STU3](http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), - [R4](http://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). - FHIR search parameters for DSTU2 can be found on each resource's - definition page. Supported search modifiers: `:missing`, `:exact`, - `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, - `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4). Supported - search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, + ([STU3](https://hl7.org/fhir/STU3/searchparameter-registry.html), + [R4](https://hl7.org/fhir/R4/searchparameter-registry.html), + [R5](https://hl7.org/fhir/R5/searchparameter-registry.html)). FHIR + search parameters for DSTU2 can be found on each resource's definition + page. Supported search modifiers: `:missing`, `:exact`, `:contains`, + `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and + `recurse` (DSTU2 and STU3) or `:iterate` (R4 and R5). Supported search + result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might @@ -13261,11 +14237,12 @@ paths: description: >- Retrieves a Patient resource and resources related to that patient. Implements the FHIR extended operation Patient-everything - ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/patient-operations.html#everything), - [STU3](http://hl7.org/implement/standards/fhir/STU3/patient-operations.html#everything), - [R4](http://hl7.org/implement/standards/fhir/R4/patient-operations.html#everything)). - On success, the response body contains a JSON-encoded representation of - a `Bundle` resource of type `searchset`, containing the results of the + ([DSTU2](https://hl7.org/fhir/DSTU2/patient-operations.html#everything), + [STU3](https://hl7.org/fhir/STU3/patient-operations.html#everything), + [R4](https://hl7.org/fhir/R4/patient-operation-everything.html), + [R5](https://hl7.org/fhir/R5/patient-operation-everything.html)). On + success, the response body contains a JSON-encoded representation of a + `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a @@ -13277,7 +14254,8 @@ paths: compartment definition ([DSTU2](http://hl7.org/fhir/DSTU2/compartment-patient.html), [STU3](http://www.hl7.org/fhir/stu3/compartmentdefinition-patient.html), - [R4](http://hl7.org/fhir/R4/compartmentdefinition-patient.html)), which + [R4](http://hl7.org/fhir/R4/compartmentdefinition-patient.html), + [R5](http://hl7.org/fhir/R5/compartmentdefinition-patient.html)), which details the eligible resource types and referencing search parameters. For samples that show how to call `Patient-everything`, see [Getting all patient compartment @@ -13356,18 +14334,19 @@ paths: get: description: >- Gets the FHIR capability statement - ([STU3](http://hl7.org/implement/standards/fhir/STU3/capabilitystatement.html), - [R4](http://hl7.org/implement/standards/fhir/R4/capabilitystatement.html)), - or the [conformance - statement](http://hl7.org/implement/standards/fhir/DSTU2/conformance.html) - in the DSTU2 case for the store, which contains a description of + ([STU3](https://hl7.org/fhir/STU3/capabilitystatement.html), + [R4](https://hl7.org/fhir/R4/capabilitystatement.html), + [R5](https://hl7.org/fhir/R5/capabilitystatement.html)), or the + [conformance statement](https://hl7.org/fhir/DSTU2/conformance.html) in + the DSTU2 case for the store, which contains a description of functionality supported by the server. Implements the FHIR standard capabilities interaction - ([STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#capabilities), - [R4](http://hl7.org/implement/standards/fhir/R4/http.html#capabilities)), - or the [conformance - interaction](http://hl7.org/implement/standards/fhir/DSTU2/http.html#conformance) - in the DSTU2 case. On success, the response body contains a JSON-encoded + ([STU3](https://hl7.org/fhir/STU3/http.html#capabilities), + [R4](https://hl7.org/fhir/R4/http.html#capabilities), + [R5](https://hl7.org/fhir/R5/http.html#capabilities)), or the + [conformance + interaction](https://hl7.org/fhir/DSTU2/http.html#conformance) in the + DSTU2 case. On success, the response body contains a JSON-encoded representation of a `CapabilityStatement` resource. operationId: healthcare.projects.locations.datasets.fhirStores.fhir.capabilities security: @@ -13413,26 +14392,29 @@ paths: description: >- Executes all the requests in the given Bundle. Implements the FHIR standard batch/transaction interaction - ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#transaction), - [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#transaction), - [R4](https://hl7.org/implement/standards/fhir/R4/http.html#transaction)). - Supports all interactions within a bundle, except search. This method - accepts Bundles of type `batch` and `transaction`, processing them - according to the batch processing rules - ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.1), - [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.1), - [R4](https://hl7.org/implement/standards/fhir/R4/http.html#brules)) and - transaction processing rules - ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.2), - [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.2), - [R4](https://hl7.org/implement/standards/fhir/R4/http.html#trules)). The - request body must contain a JSON-encoded FHIR `Bundle` resource, and the - request headers must contain `Content-Type: application/fhir+json`. For - a batch bundle or a successful transaction, the response body contains a - JSON-encoded representation of a `Bundle` resource of type - `batch-response` or `transaction-response` containing one entry for each - entry in the request, with the outcome of processing the entry. In the - case of an error for a transaction bundle, the response body contains a + ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#transaction), + [STU3](https://hl7.org/fhir/STU3/http.html#transaction), + [R4](https://hl7.org/fhir/R4/http.html#transaction), + [R5](https://hl7.org/fhir/R5/http.html#transaction)). Supports all + interactions within a bundle, except search. This method accepts Bundles + of type `batch` and `transaction`, processing them according to the + batch processing rules + ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#2.1.0.16.1), + [STU3](https://hl7.org/fhir/STU3/http.html#2.21.0.17.1), + [R4](https://hl7.org/fhir/R4/http.html#brules), + [R5](https://hl7.org/fhir/R5/http.html#brules)) and transaction + processing rules + ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#2.1.0.16.2), + [STU3](https://hl7.org/fhir/STU3/http.html#2.21.0.17.2), + [R4](https://hl7.org/fhir/R4/http.html#trules), + [R5](https://hl7.org/fhir/R5/http.html#trules)). The request body must + contain a JSON-encoded FHIR `Bundle` resource, and the request headers + must contain `Content-Type: application/fhir+json`. For a batch bundle + or a successful transaction, the response body contains a JSON-encoded + representation of a `Bundle` resource of type `batch-response` or + `transaction-response` containing one entry for each entry in the + request, with the outcome of processing the entry. In the case of an + error for a transaction bundle, the response body contains a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. This method checks @@ -13498,16 +14480,17 @@ paths: Lists all the versions of a resource (including the current version and deleted versions) from the FHIR store. Implements the per-resource form of the FHIR standard history interaction - ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#history), - [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#history), - [R4](http://hl7.org/implement/standards/fhir/R4/http.html#history)). On - success, the response body contains a JSON-encoded representation of a - `Bundle` resource of type `history`, containing the version history - sorted from most recent to oldest versions. Errors generated by the FHIR - store contain a JSON-encoded `OperationOutcome` resource describing the - reason for the error. If the request cannot be mapped to a valid API - method on a FHIR store, a generic GCP error might be returned instead. - For samples that show how to call `history`, see [Listing FHIR resource + ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#history), + [STU3](https://hl7.org/fhir/STU3/http.html#history), + [R4](https://hl7.org/fhir/R4/http.html#history), + [R5](https://hl7.org/fhir/R5/http.html#history)). On success, the + response body contains a JSON-encoded representation of a `Bundle` + resource of type `history`, containing the version history sorted from + most recent to oldest versions. Errors generated by the FHIR store + contain a JSON-encoded `OperationOutcome` resource describing the reason + for the error. If the request cannot be mapped to a valid API method on + a FHIR store, a generic GCP error might be returned instead. For samples + that show how to call `history`, see [Listing FHIR resource versions](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#listing_fhir_resource_versions). operationId: healthcare.projects.locations.datasets.fhirStores.fhir.history security: @@ -13632,6 +14615,87 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/$export: + parameters: *ref_1 + get: + description: >- + Bulk exports all resources from the FHIR store to the specified + destination. Implements the FHIR implementation guide [system level + $export](https://build.fhir.org/ig/HL7/bulk-data/export.html#endpoint---system-level-export. + The following headers must be set in the request: * `Accept`: specifies + the format of the `OperationOutcome` response. Only + `application/fhir+json` is supported. * `Prefer`: specifies whether the + response is immediate or asynchronous. Must be to `respond-async` + because only asynchronous responses are supported. Specify the + destination for the server to write result files by setting the Cloud + Storage location bulk_export_gcs_destination on the FHIR store. URI of + an existing Cloud Storage directory where the server writes result + files, in the format gs://{bucket-id}/{path/to/destination/dir}. If + there is no trailing slash, the service appends one when composing the + object path. The user is responsible for creating the Cloud Storage + bucket referenced. Supports the following query parameters: * `_type`: + string of comma-delimited FHIR resource types. If provided, only the + resources of the specified type(s) are exported. * `_since`: if + provided, only the resources that are updated after the specified time + are exported. * `_outputFormat`: optional, specify ndjson to export data + in NDJSON format. Exported file names use the format: + {export_id}_{resource_type}.ndjson. On success, the `Content-Location` + header of the response is set to a URL that the user can use to query + the status of the export. The URL is in the format: + `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/operations/{export_id}`. + See get-fhir-operation-status for more information. Errors generated by + the FHIR store contain a JSON-encoded `OperationOutcome` resource + describing the reason for the error. + operationId: healthcare.projects.locations.datasets.fhirStores.fhir.bulk-export + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-healthcare + Oauth2c: + - https://www.googleapis.com/auth/cloud-healthcare + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/HttpBody' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: fhirStoresId + required: true + schema: + type: string + - in: query + name: _since + schema: + type: string + - in: query + name: _type + schema: + type: string + - in: query + name: outputFormat + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}/$validate: parameters: *ref_1 post: @@ -13639,12 +14703,12 @@ paths: Validates an input FHIR resource's conformance to its profiles and the profiles configured on the FHIR store. Implements the FHIR extended operation $validate - ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resource-operations.html#validate), - [STU3](http://hl7.org/implement/standards/fhir/STU3/resource-operations.html#validate), - or - [R4](http://hl7.org/implement/standards/fhir/R4/resource-operation-validate.html)). - The request body must contain a JSON-encoded FHIR resource, and the - request headers must contain `Content-Type: application/fhir+json`. The + ([DSTU2](https://hl7.org/fhir/DSTU2/resource-operations.html#validate), + [STU3](https://hl7.org/fhir/STU3/resource-operations.html#validate), + [R4](https://hl7.org/fhir/R4/resource-operation-validate.html). or + [R5](https://hl7.org/fhir/R5/resource-operation-validate.html)). The + request body must contain a JSON-encoded FHIR resource, and the request + headers must contain `Content-Type: application/fhir+json`. The `Parameters` input syntax is not supported. The `profile` query parameter can be used to request that the resource only be validated against a specific profile. If a profile with the given URL cannot be @@ -13704,6 +14768,232 @@ paths: name: profile schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Consent/{ConsentId}/$consent-enforcement-status: + parameters: *ref_1 + get: + description: >- + Returns the consent enforcement status of a single consent resource. On + success, the response body contains a JSON-encoded representation of a + `Parameters` (http://hl7.org/fhir/parameters.html) FHIR resource, + containing the current enforcement status. Does not support DSTU2. + operationId: >- + healthcare.projects.locations.datasets.fhirStores.fhir.Consent-enforcement-status + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-healthcare + Oauth2c: + - https://www.googleapis.com/auth/cloud-healthcare + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/HttpBody' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: fhirStoresId + required: true + schema: + type: string + - in: path + name: ConsentId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Patient/{PatientId}/$consent-enforcement-status: + parameters: *ref_1 + get: + description: >- + Returns the consent enforcement status of all consent resources for a + patient. On success, the response body contains a JSON-encoded + representation of a bundle of `Parameters` + (http://hl7.org/fhir/parameters.html) FHIR resources, containing the + current enforcement status for each consent resource of the patient. + Does not support DSTU2. + operationId: >- + healthcare.projects.locations.datasets.fhirStores.fhir.Patient-consent-enforcement-status + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-healthcare + Oauth2c: + - https://www.googleapis.com/auth/cloud-healthcare + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/HttpBody' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: fhirStoresId + required: true + schema: + type: string + - in: path + name: PatientId + required: true + schema: + type: string + - in: query + name: _count + schema: + type: integer + format: int32 + - in: query + name: _page_token + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the status of operations as defined in the FHIR specification. + Implements the FHIR implementation guide [bulk data status + request](https://build.fhir.org/ig/HL7/bulk-data/export.html#bulk-data-status-request). + Operations can have one of these states: * in-progress: response status + code is `202` and `X-Progress` header is set to `in progress`. * + complete: response status code is `200` and the body is a JSON-encoded + operation response as defined by the spec. For a bulk export, this + response is defined in + https://build.fhir.org/ig/HL7/bulk-data/export.html#response---complete-status. + * error: response status code is `5XX`, and the body is a JSON-encoded + `OperationOutcome` resource describing the reason for the error. + operationId: >- + healthcare.projects.locations.datasets.fhirStores.operations.get-fhir-operation-status + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-healthcare + Oauth2c: + - https://www.googleapis.com/auth/cloud-healthcare + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/HttpBody' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: fhirStoresId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + delete: + description: >- + Deletes operations as defined in the FHIR specification. Implements the + FHIR implementation guide [bulk data delete + request](https://build.fhir.org/ig/HL7/bulk-data/export.html#bulk-data-delete-request). + Returns success if the operation was successfully cancelled. If the + operation is complete, or has already been cancelled, returns an error + response. + operationId: >- + healthcare.projects.locations.datasets.fhirStores.operations.delete-fhir-operation + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-healthcare + Oauth2c: + - https://www.googleapis.com/auth/cloud-healthcare + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/HttpBody' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: fhirStoresId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations: parameters: *ref_1 get: @@ -13813,7 +15103,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: healthcare.projects.locations.datasets.operations.cancel requestBody: content: diff --git a/providers/src/googleapis.com/v00.00.00000/services/iam.yaml b/providers/src/googleapis.com/v00.00.00000/services/iam.yaml index b34a4938..d8cb6244 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/iam.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/iam.yaml @@ -12,8 +12,8 @@ info: Account Credentials API (iamcredentials.googleapis.com). However, disabling this API doesn't disable the IAM Service Account Credentials API. version: v1 - x-discovery-doc-revision: '20241028' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250825' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/iam/ servers: @@ -952,10 +952,11 @@ components: properties: fullResourceName: description: >- - Required. The full resource name to query from the list of grantable - roles. The name follows the Google Cloud Platform resource format. - For example, a Cloud Platform project with id `my-project` will be - named `//cloudresourcemanager.googleapis.com/projects/my-project`. + Required. Required. The full resource name to query from the list of + grantable roles. The name follows the Google Cloud Platform resource + format. For example, a Cloud Platform project with id `my-project` + will be named + `//cloudresourcemanager.googleapis.com/projects/my-project`. type: string view: type: string @@ -1344,7 +1345,7 @@ components: properties: name: description: >- - Immutable. The resource name of the OauthClient. + Immutable. Identifier. The resource name of the OauthClient. Format:`projects/{project}/locations/{location}/oauthClients/{oauth_client}`. type: string state: @@ -1416,7 +1417,11 @@ components: request during OAuth flows. The following scopes are supported: * `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. + address for your Google Account. * `openid`: The OAuth client can + associate you with your personal information on Google Cloud. * + `email`: The OAuth client can read a federated identity's email + address. * `groups`: The OAuth client can read a federated + identity's groups. type: array items: type: string @@ -1459,7 +1464,8 @@ components: properties: name: description: >- - Immutable. The resource name of the OauthClientCredential. Format: + Immutable. Identifier. The resource name of the + OauthClientCredential. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}` type: string disabled: @@ -1505,9 +1511,8 @@ components: properties: name: description: >- - Output only. The resource name of the pool. Format: + Identifier. The resource name of the pool. Format: `locations/{location}/workforcePools/{workforce_pool_id}` - readOnly: true type: string parent: description: >- @@ -1658,9 +1663,8 @@ components: properties: name: description: >- - Output only. The resource name of the provider. Format: + Identifier. The resource name of the provider. Format: `locations/{location}/workforcePools/{workforce_pool_id}/providers/{provider_id}` - readOnly: true type: string displayName: description: >- @@ -1789,6 +1793,28 @@ components: configuration is only supported with OIDC protocol. $ref: >- #/components/schemas/GoogleIamAdminV1WorkforcePoolProviderExtraAttributesOAuth2Client + detailedAuditLogging: + description: >- + Optional. If true, populates additional debug information in Cloud + Audit Logs for this provider. Logged attribute mappings and values + can be found in `sts.googleapis.com` data access logs. Default value + is false. + type: boolean + extendedAttributesOauth2Client: + description: >- + Optional. The configuration for OAuth 2.0 client used to get the + extended group memberships for user identities. Only the + `AZURE_AD_GROUPS_ID` attribute type is supported. Extended groups + supports a subset of Google Cloud services. When the user accesses + these services, extended group memberships override the mapped + `google.groups` attribute. Extended group memberships cannot be used + in attribute mapping or attribute condition expressions. To keep + extended group memberships up to date, extended groups are retrieved + when the user signs in and at regular intervals during the user's + active session. Each user identity in the workforce identity pool + must map to a unique Microsoft Entra ID user. + $ref: >- + #/components/schemas/GoogleIamAdminV1WorkforcePoolProviderExtraAttributesOAuth2Client GoogleIamAdminV1WorkforcePoolProviderSaml: id: GoogleIamAdminV1WorkforcePoolProviderSaml description: Represents a SAML identity provider. @@ -1804,7 +1830,7 @@ components: constraints: 1) Must contain an Identity Provider Entity ID. 2) Must contain at least one non-expired signing key certificate. 3) For each signing key: a) Valid from should be no more than 7 days from - now. b) Valid to should be no more than 20 years in the future. 4) + now. b) Valid to should be no more than 25 years in the future. 4) Up to 3 IdP signing keys are allowed in the metadata xml. When updating the provider's metadata xml, at least one non-expired signing key must overlap with the existing metadata. This @@ -1965,16 +1991,29 @@ components: - No AttributesType specified. - >- Used to get the user's group claims from the Microsoft Entra ID - identity provider using configuration provided in - ExtraAttributesOAuth2Client and `mail` property of the + identity provider using the configuration provided in + ExtraAttributesOAuth2Client. The `mail` property of the + `microsoft.graph.group` object is used for claim mapping. See + https://learn.microsoft.com/en-us/graph/api/resources/group?view=graph-rest-1.0#properties + for more details on `microsoft.graph.group` properties. The group + mail addresses of the user's groups that are returned from + Microsoft Entra ID can be mapped by using the following + attributes: * OIDC: `assertion.groups` * SAML: + `assertion.attributes.groups` + - >- + Used to get the user's group claims from the Microsoft Entra ID + identity provider using the configuration provided in + ExtraAttributesOAuth2Client. The `id` property of the `microsoft.graph.group` object is used for claim mapping. See https://learn.microsoft.com/en-us/graph/api/resources/group?view=graph-rest-1.0#properties - for more details on `microsoft.graph.group` properties. The - attributes obtained from idntity provider are mapped to - `assertion.groups`. + for more details on `microsoft.graph.group` properties. The group + IDs of the user's groups that are returned from Microsoft Entra ID + can be mapped by using the following attributes: * OIDC: + `assertion.groups` * SAML: `assertion.attributes.groups` enum: - ATTRIBUTES_TYPE_UNSPECIFIED - AZURE_AD_GROUPS_MAIL + - AZURE_AD_GROUPS_ID queryParameters: description: >- Optional. Represents the parameters to control which claims are @@ -1991,13 +2030,23 @@ components: properties: filter: description: >- - Optional. The filter used to request specific records from IdP. In - case of attributes type as AZURE_AD_GROUPS_MAIL, it represents the - filter used to request specific groups for users from IdP. By - default, all of the groups associated with the user are fetched. The - groups should be mail enabled and security enabled. See - https://learn.microsoft.com/en-us/graph/search-query-parameter for - more details. + Optional. The filter used to request specific records from the IdP. + By default, all of the groups that are associated with a user are + fetched. For Microsoft Entra ID, you can add `$search` query + parameters using [Keyword Query Language] + (https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference). + To learn more about `$search` querying in Microsoft Entra ID, see + [Use the `$search` query parameter] + (https://learn.microsoft.com/en-us/graph/search-query-parameter). + Additionally, Workforce Identity Federation automatically adds the + following [`$filter` query parameters] + (https://learn.microsoft.com/en-us/graph/filter-query-parameter), + based on the value of `attributes_type`. Values passed to `filter` + are converted to `$search` query parameters. Additional `$filter` + query parameters cannot be added using this field. * + `AZURE_AD_GROUPS_MAIL`: `mailEnabled` and `securityEnabled` filters + are applied. * `AZURE_AD_GROUPS_ID`: `securityEnabled` filter is + applied. type: string UndeleteWorkforcePoolProviderRequest: id: UndeleteWorkforcePoolProviderRequest @@ -2029,8 +2078,9 @@ components: type: object properties: name: - description: Output only. The resource name of the key. - readOnly: true + description: >- + Identifier. The resource name of the key. Format: + `locations/{location}/workforcePools/{workforce_pool_id}/providers/{provider_id}/keys/{key_id}` type: string keyData: description: Immutable. Public half of the asymmetric key. @@ -2134,6 +2184,149 @@ components: description: Request message for UndeleteWorkforcePoolSubject. type: object properties: {} + ListWorkforcePoolProviderScimTenantsResponse: + id: ListWorkforcePoolProviderScimTenantsResponse + description: Response message for ListWorkforcePoolProviderScimTenants. + type: object + properties: + workforcePoolProviderScimTenants: + description: Output only. A list of scim tenants. + readOnly: true + type: array + items: + $ref: '#/components/schemas/WorkforcePoolProviderScimTenant' + nextPageToken: + description: >- + Optional. A token, which can be sent as `page_token` to retrieve the + next page. If this field is omitted, there are no subsequent pages. + type: string + WorkforcePoolProviderScimTenant: + id: WorkforcePoolProviderScimTenant + description: >- + Represents a scim tenant. Used for provisioning and managing identity + data (such as Users and Groups) in cross-domain environments. + type: object + properties: + name: + description: >- + Identifier. The resource name of the SCIM Tenant. Format: + `locations/{location}/workforcePools/{workforce_pool}/providers/ + {workforce_pool_provider}/scimTenants/{scim_tenant}` + type: string + baseUri: + description: >- + Output only. Represents the base URI as defined in [RFC 7644, + Section + 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). + Clients must use this as the root address for managing resources + under the tenant. Format: + https://iamscim.googleapis.com/{version}/{tenant_id}/ + readOnly: true + type: string + state: + description: Output only. The state of the tenant. + readOnly: true + type: string + enumDescriptions: + - State unspecified. + - >- + The tenant is active and may be used to provision users and + groups. + - >- + The tenant is soft-deleted. Soft-deleted tenants are permanently + deleted after approximately 30 days. + enum: + - STATE_UNSPECIFIED + - ACTIVE + - DELETED + description: + description: >- + Optional. The user-specified description of the scim tenant. Cannot + exceed 256 characters. + type: string + displayName: + description: >- + Optional. The user-specified display name of the scim tenant. Cannot + exceed 32 characters. + type: string + claimMapping: + description: Optional. Maps BYOID claims to SCIM claims. + type: object + additionalProperties: + type: string + purgeTime: + description: >- + Output only. The timestamp when the scim tenant is going to be + purged. + readOnly: true + type: string + format: google-datetime + UndeleteWorkforcePoolProviderScimTenantRequest: + id: UndeleteWorkforcePoolProviderScimTenantRequest + description: Request message for UndeleteWorkforcePoolProviderScimTenant. + type: object + properties: {} + ListWorkforcePoolProviderScimTokensResponse: + id: ListWorkforcePoolProviderScimTokensResponse + description: Response message for ListWorkforcePoolProviderScimTokens. + type: object + properties: + workforcePoolProviderScimTokens: + description: Output only. A list of scim tokens. + readOnly: true + type: array + items: + $ref: '#/components/schemas/WorkforcePoolProviderScimToken' + nextPageToken: + description: >- + Optional. A token, which can be sent as `page_token` to retrieve the + next page. If this field is omitted, there are no subsequent pages. + type: string + WorkforcePoolProviderScimToken: + id: WorkforcePoolProviderScimToken + description: >- + Represents a token for the WorkforcePoolProviderScimTenant. Used for + authenticating SCIM Provisioning requests. + type: object + properties: + name: + description: >- + Identifier. The resource name of the SCIM Token. Format: + `locations/{location}/workforcePools/{workforce_pool}/providers/ + {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}` + type: string + securityToken: + description: >- + Output only. The token string. Provide this to the IdP for + authentication. Will be set only during creation. + readOnly: true + type: string + state: + description: Output only. The state of the token. + readOnly: true + type: string + enumDescriptions: + - State unspecified. + - >- + The tenant is active and may be used to provision users and + groups. + - >- + The tenant is soft-deleted. Soft-deleted tenants are permanently + deleted after approximately 30 days. + enum: + - STATE_UNSPECIFIED + - ACTIVE + - DELETED + displayName: + description: >- + Optional. The user-specified display name of the scim token. Cannot + exceed 32 characters. + type: string + UndeleteWorkforcePoolProviderScimTokenRequest: + id: UndeleteWorkforcePoolProviderScimTokenRequest + description: Request message for UndeleteWorkforcePoolProviderScimToken. + type: object + properties: {} ListWorkloadIdentityPoolsResponse: id: ListWorkloadIdentityPoolsResponse description: Response message for ListWorkloadIdentityPools. @@ -2161,10 +2354,10 @@ components: readOnly: true type: string displayName: - description: A display name for the pool. Cannot exceed 32 characters. + description: Optional. A display name for the pool. Cannot exceed 32 characters. type: string description: - description: A description of the pool. Cannot exceed 256 characters. + description: Optional. A description of the pool. Cannot exceed 256 characters. type: string state: description: Output only. The state of the pool. @@ -2187,10 +2380,36 @@ components: - DELETED disabled: description: >- - Whether the pool is disabled. You cannot use a disabled pool to - exchange tokens, or use existing tokens to access resources. If the - pool is re-enabled, existing tokens grant access again. + Optional. Whether the pool is disabled. You cannot use a disabled + pool to exchange tokens, or use existing tokens to access resources. + If the pool is re-enabled, existing tokens grant access again. type: boolean + mode: + description: Immutable. The mode the pool is operating in. + type: string + enumDescriptions: + - >- + State unspecified. New pools should not use this mode. Pools with + an unspecified mode will operate as if they are in federation-only + mode. + - >- + Federation-only mode. Federation-only pools can only be used for + federating external workload identities into Google Cloud. Unless + otherwise noted, no structure or format constraints are applied to + workload identities in a federation-only pool, and you cannot + create any resources within the pool besides providers. + - >- + Trust-domain mode. Trust-domain pools can be used to assign + identities to Google Cloud workloads. All identities within a + trust-domain pool must consist of a single namespace and + individual workload identifier. The subject identifier for all + identities must conform to the following format: `ns//sa/` + WorkloadIdentityPoolProviders cannot be created within + trust-domain pools. + enum: + - MODE_UNSPECIFIED + - FEDERATION_ONLY + - TRUST_DOMAIN expireTime: description: >- Output only. Time after which the workload identity pool will be @@ -2198,11 +2417,293 @@ components: readOnly: true type: string format: google-datetime + inlineCertificateIssuanceConfig: + description: >- + Optional. Defines the Certificate Authority (CA) pool resources and + configurations required for issuance and rotation of mTLS workload + certificates. + $ref: '#/components/schemas/InlineCertificateIssuanceConfig' + inlineTrustConfig: + description: Optional. Represents config to add additional trusted trust domains. + $ref: '#/components/schemas/InlineTrustConfig' + InlineCertificateIssuanceConfig: + id: InlineCertificateIssuanceConfig + description: >- + Represents configuration for generating mutual TLS (mTLS) certificates + for the identities within this pool. + type: object + properties: + caPools: + description: >- + Optional. A required mapping of a Google Cloud region to the CA pool + resource located in that region. The CA pool is used for certificate + issuance, adhering to the following constraints: * Key format: A + supported cloud region name equivalent to the location identifier in + the corresponding map entry's value. * Value format: A valid CA pool + resource path format like: + "projects/{project}/locations/{location}/caPools/{ca_pool}" * Region + Matching: Workloads are ONLY issued certificates from CA pools + within the same region. Also the CA pool region (in value) must + match the workload's region (key). + type: object + additionalProperties: + type: string + lifetime: + description: >- + Optional. Lifetime of the workload certificates issued by the CA + pool. Must be between 24 hours and 30 days. If not specified, this + will be defaulted to 24 hours. + type: string + format: google-duration + rotationWindowPercentage: + description: >- + Optional. Rotation window percentage, the percentage of remaining + lifetime after which certificate rotation is initiated. Must be + between 50 and 80. If no value is specified, rotation window + percentage is defaulted to 50. + type: integer + format: int32 + keyAlgorithm: + description: >- + Optional. Key algorithm to use when generating the key pair. This + key pair will be used to create the certificate. If not specified, + this will default to ECDSA_P256. + type: string + enumDescriptions: + - Unspecified key algorithm. Defaults to ECDSA_P256. + - Specifies RSA with a 2048-bit modulus. + - Specifies RSA with a 3072-bit modulus. + - Specifies RSA with a 4096-bit modulus. + - Specifies ECDSA with curve P256. + - Specifies ECDSA with curve P384. + enum: + - KEY_ALGORITHM_UNSPECIFIED + - RSA_2048 + - RSA_3072 + - RSA_4096 + - ECDSA_P256 + - ECDSA_P384 + InlineTrustConfig: + id: InlineTrustConfig + description: >- + Defines configuration for extending trust to additional trust domains. + By establishing trust with another domain, the current domain will + recognize and accept certificates issued by entities within the trusted + domains. Note that a trust domain automatically trusts itself, + eliminating the need for explicit configuration. + type: object + properties: + additionalTrustBundles: + description: >- + Optional. Maps specific trust domains (e.g., "example.com") to their + corresponding TrustStore, which contain the trusted root + certificates for that domain. There can be a maximum of 10 trust + domain entries in this map. Note that a trust domain automatically + trusts itself and don't need to be specified here. If however, this + WorkloadIdentityPool's trust domain contains any trust anchors in + the additional_trust_bundles map, those trust anchors will be + *appended to* the trust bundle automatically derived from your + InlineCertificateIssuanceConfig's ca_pools. + type: object + additionalProperties: + $ref: '#/components/schemas/TrustStore' + TrustStore: + id: TrustStore + description: >- + Trust store that contains trust anchors and optional intermediate CAs + used in PKI to build a trust chain(trust hierarchy) and verify a + client's identity. + type: object + properties: + trustAnchors: + description: >- + Required. List of trust anchors to be used while performing + validation against a given TrustStore. The incoming end entity's + certificate must be in the trust chain of one of the trust anchors + here. + type: array + items: + $ref: '#/components/schemas/TrustAnchor' + intermediateCas: + description: >- + Optional. Set of intermediate CA certificates used for building the + trust chain to the trust anchor. Important: Intermediate CAs are + only supported for X.509 federation. + type: array + items: + $ref: '#/components/schemas/IntermediateCA' + TrustAnchor: + id: TrustAnchor + description: Represents a root of trust. + type: object + properties: + pemCertificate: + description: >- + PEM certificate of the PKI used for validation. Must only contain + one ca certificate(either root or intermediate cert). + type: string + IntermediateCA: + id: IntermediateCA + description: >- + Intermediate CA certificates used for building the trust chain to trust + anchor + type: object + properties: + pemCertificate: + description: >- + PEM certificate of the PKI used for validation. Must only contain + one ca certificate. + type: string UndeleteWorkloadIdentityPoolRequest: id: UndeleteWorkloadIdentityPoolRequest description: Request message for UndeleteWorkloadIdentityPool. type: object properties: {} + ListWorkloadIdentityPoolNamespacesResponse: + id: ListWorkloadIdentityPoolNamespacesResponse + description: Response message for ListWorkloadIdentityPoolNamespaces. + type: object + properties: + workloadIdentityPoolNamespaces: + description: A list of namespaces. + type: array + items: + $ref: '#/components/schemas/WorkloadIdentityPoolNamespace' + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + WorkloadIdentityPoolNamespace: + id: WorkloadIdentityPoolNamespace + description: >- + Represents a namespace for a workload identity pool. Namespaces are used + to segment identities within the pool. + type: object + properties: + name: + description: Output only. The resource name of the namespace. + readOnly: true + type: string + description: + description: >- + Optional. A description of the namespace. Cannot exceed 256 + characters. + type: string + state: + description: Output only. The state of the namespace. + readOnly: true + type: string + enumDescriptions: + - State unspecified. + - The namespace is active. + - >- + The namespace is soft-deleted. Soft-deleted namespaces are + permanently deleted after approximately 30 days. You can restore a + soft-deleted namespace using + UndeleteWorkloadIdentityPoolNamespace. You cannot reuse the ID of + a soft-deleted namespace until it is permanently deleted. + enum: + - STATE_UNSPECIFIED + - ACTIVE + - DELETED + disabled: + description: >- + Optional. Whether the namespace is disabled. If disabled, + credentials may no longer be issued for identities within this + namespace, however existing credentials will still be accepted until + they expire. + type: boolean + expireTime: + description: >- + Output only. Time after which the namespace will be permanently + purged and cannot be recovered. + readOnly: true + type: string + format: google-datetime + ownerService: + description: Output only. The Google Cloud service that owns this namespace. + readOnly: true + $ref: '#/components/schemas/OwnerService' + OwnerService: + id: OwnerService + description: The Google Cloud service that owns this namespace. + type: object + properties: + principalSubject: + description: >- + Required. The service agent principal subject, e.g. + "serviceAccount:service-1234@gcp-sa-gkehub.iam.gserviceaccount.com". + type: string + UndeleteWorkloadIdentityPoolNamespaceRequest: + id: UndeleteWorkloadIdentityPoolNamespaceRequest + description: Request message for UndeleteWorkloadIdentityPoolNamespace. + type: object + properties: {} + ListWorkloadIdentityPoolManagedIdentitiesResponse: + id: ListWorkloadIdentityPoolManagedIdentitiesResponse + description: Response message for ListWorkloadIdentityPoolManagedIdentities. + type: object + properties: + workloadIdentityPoolManagedIdentities: + description: A list of managed identities. + type: array + items: + $ref: '#/components/schemas/WorkloadIdentityPoolManagedIdentity' + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + WorkloadIdentityPoolManagedIdentity: + id: WorkloadIdentityPoolManagedIdentity + description: Represents a managed identity for a workload identity pool namespace. + type: object + properties: + name: + description: Identifier. The resource name of the managed identity. + type: string + description: + description: >- + Optional. A description of the managed identity. Cannot exceed 256 + characters. + type: string + state: + description: Output only. The state of the managed identity. + readOnly: true + type: string + enumDescriptions: + - State unspecified. + - The managed identity is active. + - >- + The managed identity is soft-deleted. Soft-deleted managed + identities are permanently deleted after approximately 30 days. + You can restore a soft-deleted managed identity using + UndeleteWorkloadIdentityPoolManagedIdentity. You cannot reuse the + ID of a soft-deleted managed identity until it is permanently + deleted. + enum: + - STATE_UNSPECIFIED + - ACTIVE + - DELETED + disabled: + description: >- + Optional. Whether the managed identity is disabled. If disabled, + credentials may no longer be issued for the identity, however + existing credentials will still be accepted until they expire. + type: boolean + expireTime: + description: >- + Output only. Time after which the managed identity will be + permanently purged and cannot be recovered. + readOnly: true + type: string + format: google-datetime + UndeleteWorkloadIdentityPoolManagedIdentityRequest: + id: UndeleteWorkloadIdentityPoolManagedIdentityRequest + description: Request message for UndeleteWorkloadIdentityPoolManagedIdentity. + type: object + properties: {} ListWorkloadIdentityPoolProvidersResponse: id: ListWorkloadIdentityPoolProvidersResponse description: Response message for ListWorkloadIdentityPoolProviders. @@ -2224,14 +2725,17 @@ components: type: object properties: name: - description: Output only. The resource name of the provider. - readOnly: true + description: Identifier. The resource name of the provider. type: string displayName: - description: A display name for the provider. Cannot exceed 32 characters. + description: >- + Optional. A display name for the provider. Cannot exceed 32 + characters. type: string description: - description: A description for the provider. Cannot exceed 256 characters. + description: >- + Optional. A description for the provider. Cannot exceed 256 + characters. type: string state: description: Output only. The state of the provider. @@ -2254,17 +2758,61 @@ components: - DELETED disabled: description: >- - Whether the provider is disabled. You cannot use a disabled provider - to exchange tokens. However, existing tokens still grant access. + Optional. Whether the provider is disabled. You cannot use a + disabled provider to exchange tokens. However, existing tokens still + grant access. type: boolean attributeMapping: - description: ' Maps attributes from authentication credentials issued by an external identity provider to Google Cloud attributes, such as `subject` and `segment`. Each key must be a string specifying the Google Cloud IAM attribute to map to. The following keys are supported: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. Cannot exceed 127 bytes. * `google.groups`: Groups the external identity belongs to. You can grant groups access to resources using an IAM `principalSet` binding; access applies to all members of the group. You can also provide custom attributes by specifying `attribute.{custom_attribute}`, where `{custom_attribute}` is the name of the custom attribute to be mapped. You can define a maximum of 50 custom attributes. The maximum length of a mapped attribute key is 100 characters, and the key may only contain the characters [a-z0-9_]. You can reference these attributes in IAM policies to define fine-grained access for a workload to Google Cloud resources. For example: * `google.subject`: `principal://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/subject/{value}` * `google.groups`: `principalSet://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/group/{value}` * `attribute.{custom_attribute}`: `principalSet://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/attribute.{custom_attribute}/{value}` Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) function that maps an identity provider credential to the normalized attribute specified by the corresponding map key. You can use the `assertion` keyword in the expression to access a JSON representation of the authentication credential issued by the provider. The maximum length of an attribute mapping expression is 2048 characters. When evaluated, the total size of all mapped attributes must not exceed 8KB. For AWS providers, if no attribute mapping is defined, the following default mapping applies: ``` { "google.subject":"assertion.arn", "attribute.aws_role": "assertion.arn.contains(''assumed-role'')" " ? assertion.arn.extract(''{account_arn}assumed-role/'')" " + ''assumed-role/''" " + assertion.arn.extract(''assumed-role/{role_name}/'')" " : assertion.arn", } ``` If any custom attribute mappings are defined, they must include a mapping to the `google.subject` attribute. For OIDC providers, you must supply a custom mapping, which must include the `google.subject` attribute. For example, the following maps the `sub` claim of the incoming credential to the `subject` attribute on a Google token: ``` {"google.subject": "assertion.sub"} ```' + description: >- + Optional. Maps attributes from authentication credentials issued by + an external identity provider to Google Cloud attributes, such as + `subject` and `segment`. Each key must be a string specifying the + Google Cloud IAM attribute to map to. The following keys are + supported: * `google.subject`: The principal IAM is authenticating. + You can reference this value in IAM bindings. This is also the + subject that appears in Cloud Logging logs. Cannot exceed 127 bytes. + * `google.groups`: Groups the external identity belongs to. You can + grant groups access to resources using an IAM `principalSet` + binding; access applies to all members of the group. You can also + provide custom attributes by specifying + `attribute.{custom_attribute}`, where `{custom_attribute}` is the + name of the custom attribute to be mapped. You can define a maximum + of 50 custom attributes. The maximum length of a mapped attribute + key is 100 characters, and the key may only contain the characters + [a-z0-9_]. You can reference these attributes in IAM policies to + define fine-grained access for a workload to Google Cloud resources. + For example: * `google.subject`: + `principal://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/subject/{value}` + * `google.groups`: + `principalSet://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/group/{value}` + * `attribute.{custom_attribute}`: + `principalSet://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/attribute.{custom_attribute}/{value}` + Each value must be a [Common Expression Language] + (https://opensource.google/projects/cel) function that maps an + identity provider credential to the normalized attribute specified + by the corresponding map key. You can use the `assertion` keyword in + the expression to access a JSON representation of the authentication + credential issued by the provider. The maximum length of an + attribute mapping expression is 2048 characters. When evaluated, the + total size of all mapped attributes must not exceed 8KB. For AWS + providers, if no attribute mapping is defined, the following default + mapping applies: ``` { "google.subject":"assertion.arn", + "attribute.aws_role": "assertion.arn.contains('assumed-role')" " ? + assertion.arn.extract('{account_arn}assumed-role/')" " + + 'assumed-role/'" " + + assertion.arn.extract('assumed-role/{role_name}/')" " : + assertion.arn", } ``` If any custom attribute mappings are defined, + they must include a mapping to the `google.subject` attribute. For + OIDC providers, you must supply a custom mapping, which must include + the `google.subject` attribute. For example, the following maps the + `sub` claim of the incoming credential to the `subject` attribute on + a Google token: ``` {"google.subject": "assertion.sub"} ``` type: object additionalProperties: type: string attributeCondition: description: >- - [A Common Expression + Optional. [A Common Expression Language](https://opensource.google/projects/cel) expression, in plain text, to restrict what otherwise valid authentication credentials issued by the provider should not be accepted. The @@ -2289,6 +2837,9 @@ components: saml: description: An SAML 2.0 identity provider. $ref: '#/components/schemas/Saml' + x509: + description: An X.509-type identity provider. + $ref: '#/components/schemas/X509' expireTime: description: >- Output only. Time after which the workload identity pool provider @@ -2310,17 +2861,23 @@ components: type: object properties: issuerUri: - description: Required. The OIDC issuer URL. Must be an HTTPS endpoint. + description: >- + Required. The OIDC issuer URL. Must be an HTTPS endpoint. Per OpenID + Connect Discovery 1.0 spec, the OIDC issuer URL is used to locate + the provider's public keys (via `jwks_uri`) for verifying tokens + like the OIDC ID token. These public key types must be 'EC' or + 'RSA'. type: string allowedAudiences: description: >- - Acceptable values for the `aud` field (audience) in the OIDC token. - Token exchange requests are rejected if the token audience does not - match one of the configured values. Each audience may be at most 256 - characters. A maximum of 10 audiences may be configured. If this - list is empty, the OIDC token audience must be equal to the full - canonical resource name of the WorkloadIdentityPoolProvider, with or - without the HTTPS prefix. For example: ``` + Optional. Acceptable values for the `aud` field (audience) in the + OIDC token. Token exchange requests are rejected if the token + audience does not match one of the configured values. Each audience + may be at most 256 characters. A maximum of 10 audiences may be + configured. If this list is empty, the OIDC token audience must be + equal to the full canonical resource name of the + WorkloadIdentityPoolProvider, with or without the HTTPS prefix. For + example: ``` //iam.googleapis.com/projects//locations//workloadIdentityPools//providers/ https://iam.googleapis.com/projects//locations//workloadIdentityPools//providers/ ``` @@ -2353,12 +2910,28 @@ components: constraints: * Must contain an IdP Entity ID. * Must contain at least one non-expired signing certificate. * For each signing certificate, the expiration must be: * From no more than 7 days in - the future. * To no more than 20 years in the future. * Up to three + the future. * To no more than 25 years in the future. * Up to three IdP signing keys are allowed. When updating the provider's metadata XML, at least one non-expired signing key must overlap with the existing metadata. This requirement is skipped if there are no non-expired signing keys present in the existing metadata. type: string + X509: + id: X509 + description: >- + An X.509-type identity provider represents a CA. It is trusted to assert + a client identity if the client has a certificate that chains up to this + CA. + type: object + properties: + trustStore: + description: >- + Required. A TrustStore. Use this trust store as a wrapper to config + the trust anchor and optional intermediate cas to help build the + trust chain for the incoming end entity certificate. Follow the + X.509 guidelines to define those PEM encoded certs. Only one trust + store is currently supported. + $ref: '#/components/schemas/TrustStore' UndeleteWorkloadIdentityPoolProviderRequest: id: UndeleteWorkloadIdentityPoolProviderRequest description: Request message for UndeleteWorkloadIdentityPoolProvider. @@ -2433,6 +3006,62 @@ components: description: Request message for UndeleteWorkloadIdentityPoolProviderKey. type: object properties: {} + AddAttestationRuleRequest: + id: AddAttestationRuleRequest + description: Request message for AddAttestationRule. + type: object + properties: + attestationRule: + description: Required. The attestation rule to be added. + $ref: '#/components/schemas/AttestationRule' + AttestationRule: + id: AttestationRule + description: >- + Defines which workloads can receive an identity within a pool. When an + AttestationRule is defined under a managed identity, matching workloads + may receive that identity. + type: object + properties: + googleCloudResource: + description: >- + Optional. A single workload operating on Google Cloud. For example: + `//compute.googleapis.com/projects/123/uid/zones/us-central1-a/instances/12345`. + type: string + RemoveAttestationRuleRequest: + id: RemoveAttestationRuleRequest + description: Request message for RemoveAttestationRule. + type: object + properties: + attestationRule: + description: Required. The attestation rule to be removed. + $ref: '#/components/schemas/AttestationRule' + SetAttestationRulesRequest: + id: SetAttestationRulesRequest + description: Request message for SetAttestationRules. + type: object + properties: + attestationRules: + description: >- + Required. The attestation rules to be set. At most 50 attestation + rules can be set. + type: array + items: + $ref: '#/components/schemas/AttestationRule' + ListAttestationRulesResponse: + id: ListAttestationRulesResponse + description: Response message for ListAttestationRules. + type: object + properties: + attestationRules: + description: A list of AttestationRules. + type: array + items: + $ref: '#/components/schemas/AttestationRule' + nextPageToken: + description: >- + Optional. A token, which can be sent as `page_token` to retrieve the + next page. If this field is omitted, there are no subsequent pages. + type: string AdminAuditData: id: AdminAuditData description: >- @@ -2550,8 +3179,8 @@ components: description: >- Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully - have Operation.error value with a google.rpc.Status.code of 1, - corresponding to `Code.CANCELLED`. + have google.longrunning.Operation.error value with a + google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. readOnly: true type: boolean apiVersion: @@ -2851,6 +3480,43 @@ components: delete: - $ref: >- #/components/x-stackQL-resources/workload_identity_pools/methods/delete + workload_identity_pools_iam_policies: + id: google.iam.workload_identity_pools_iam_policies + name: workload_identity_pools_iam_policies + title: Workload_identity_pools_iam_policies + methods: + set_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}:setIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + get_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}:getIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.bindings + test_iam_permissions: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}:testIamPermissions/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/workload_identity_pools_iam_policies/methods/get_iam_policy + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/workload_identity_pools_iam_policies/methods/set_iam_policy + delete: [] operations: id: google.iam.operations name: operations @@ -2952,6 +3618,170 @@ components: update: [] replace: [] delete: [] + namespaces: + id: google.iam.namespaces + name: namespaces + title: Namespaces + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}~1namespaces/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.workloadIdentityPoolNamespaces + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}~1namespaces/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}~1namespaces~1{namespacesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}~1namespaces~1{namespacesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}~1namespaces~1{namespacesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + undelete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}~1namespaces~1{namespacesId}:undelete/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/namespaces/methods/get' + - $ref: '#/components/x-stackQL-resources/namespaces/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/namespaces/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/namespaces/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/namespaces/methods/delete' + managed_identities: + id: google.iam.managed_identities + name: managed_identities + title: Managed_identities + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}~1namespaces~1{namespacesId}~1managedIdentities/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.workloadIdentityPoolManagedIdentities + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}~1namespaces~1{namespacesId}~1managedIdentities/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}~1namespaces~1{namespacesId}~1managedIdentities~1{managedIdentitiesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}~1namespaces~1{namespacesId}~1managedIdentities~1{managedIdentitiesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}~1namespaces~1{namespacesId}~1managedIdentities~1{managedIdentitiesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + undelete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}~1namespaces~1{namespacesId}~1managedIdentities~1{managedIdentitiesId}:undelete/post + response: + mediaType: application/json + openAPIDocKey: '200' + set_attestation_rules: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}~1namespaces~1{namespacesId}~1managedIdentities~1{managedIdentitiesId}:setAttestationRules/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/managed_identities/methods/get' + - $ref: '#/components/x-stackQL-resources/managed_identities/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/managed_identities/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/managed_identities/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/managed_identities/methods/delete' + managed_identities_attestation_rules: + id: google.iam.managed_identities_attestation_rules + name: managed_identities_attestation_rules + title: Managed_identities_attestation_rules + methods: + add_attestation_rule: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}~1namespaces~1{namespacesId}~1managedIdentities~1{managedIdentitiesId}:addAttestationRule/post + response: + mediaType: application/json + openAPIDocKey: '200' + remove_attestation_rule: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}~1namespaces~1{namespacesId}~1managedIdentities~1{managedIdentitiesId}:removeAttestationRule/post + response: + mediaType: application/json + openAPIDocKey: '200' + list_attestation_rules: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}~1namespaces~1{namespacesId}~1managedIdentities~1{managedIdentitiesId}:listAttestationRules/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.attestationRules + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/managed_identities_attestation_rules/methods/list_attestation_rules + insert: + - $ref: >- + #/components/x-stackQL-resources/managed_identities_attestation_rules/methods/add_attestation_rule + update: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/managed_identities_attestation_rules/methods/remove_attestation_rule workload_identity_pool_providers: id: google.iam.workload_identity_pool_providers name: workload_identity_pool_providers @@ -3604,6 +4434,124 @@ components: delete: - $ref: >- #/components/x-stackQL-resources/workforce_pool_provider_keys/methods/delete + scim_tenants: + id: google.iam.scim_tenants + name: scim_tenants + title: Scim_tenants + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}~1scimTenants/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.workforcePoolProviderScimTenants + create: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}~1scimTenants/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}~1scimTenants~1{scimTenantsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}~1scimTenants~1{scimTenantsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}~1scimTenants~1{scimTenantsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + undelete: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}~1scimTenants~1{scimTenantsId}:undelete/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/scim_tenants/methods/get' + - $ref: '#/components/x-stackQL-resources/scim_tenants/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/scim_tenants/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/scim_tenants/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/scim_tenants/methods/delete' + tokens: + id: google.iam.tokens + name: tokens + title: Tokens + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}~1scimTenants~1{scimTenantsId}~1tokens/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.workforcePoolProviderScimTokens + create: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}~1scimTenants~1{scimTenantsId}~1tokens/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}~1scimTenants~1{scimTenantsId}~1tokens~1{tokensId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}~1scimTenants~1{scimTenantsId}~1tokens~1{tokensId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}~1scimTenants~1{scimTenantsId}~1tokens~1{tokensId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + undelete: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}~1scimTenants~1{scimTenantsId}~1tokens~1{tokensId}:undelete/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tokens/methods/get' + - $ref: '#/components/x-stackQL-resources/tokens/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/tokens/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/tokens/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/tokens/methods/delete' workforce_pool_subjects: id: google.iam.workforce_pool_subjects name: workforce_pool_subjects @@ -4344,14 +5292,16 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}:setIamPolicy: parameters: *ref_1 - get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: iam.projects.locations.workloadIdentityPools.operations.get + post: + description: Sets the IAM policies on a WorkloadIdentityPool + operationId: iam.projects.locations.workloadIdentityPools.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4363,7 +5313,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Policy' parameters: - in: path name: projectsId @@ -4380,19 +5330,16 @@ paths: required: true schema: type: string - - in: path - name: operationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}:getIamPolicy: parameters: *ref_1 - get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: iam.projects.locations.workloadIdentityPools.namespaces.operations.get + post: + description: Gets the IAM policy of a WorkloadIdentityPool. + operationId: iam.projects.locations.workloadIdentityPools.getIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4404,7 +5351,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Policy' parameters: - in: path name: projectsId @@ -4421,25 +5368,16 @@ paths: required: true schema: type: string - - in: path - name: namespacesId - required: true - schema: - type: string - - in: path - name: operationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}/managedIdentities/{managedIdentitiesId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}:testIamPermissions: parameters: *ref_1 - get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: >- - iam.projects.locations.workloadIdentityPools.namespaces.managedIdentities.operations.get + post: + description: Returns the caller's permissions on a WorkloadIdentityPool + operationId: iam.projects.locations.workloadIdentityPools.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4451,7 +5389,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/TestIamPermissionsResponse' parameters: - in: path name: projectsId @@ -4468,30 +5406,14 @@ paths: required: true schema: type: string - - in: path - name: namespacesId - required: true - schema: - type: string - - in: path - name: managedIdentitiesId - required: true - schema: - type: string - - in: path - name: operationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}/managedIdentities/{managedIdentitiesId}/workloadSources/{workloadSourcesId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/operations/{operationsId}: parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - operationId: >- - iam.projects.locations.workloadIdentityPools.namespaces.managedIdentities.workloadSources.operations.get + operationId: iam.projects.locations.workloadIdentityPools.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4520,34 +5442,19 @@ paths: required: true schema: type: string - - in: path - name: namespacesId - required: true - schema: - type: string - - in: path - name: managedIdentitiesId - required: true - schema: - type: string - - in: path - name: workloadSourcesId - required: true - schema: - type: string - in: path name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/providers: + /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces: parameters: *ref_1 get: description: >- - Lists all non-deleted WorkloadIdentityPoolProviders in a - WorkloadIdentityPool. If `show_deleted` is set to `true`, then deleted - providers are also listed. - operationId: iam.projects.locations.workloadIdentityPools.providers.list + Lists all non-deleted WorkloadIdentityPoolNamespaces in a workload + identity pool. If `show_deleted` is set to `true`, then deleted + namespaces are also listed. + operationId: iam.projects.locations.workloadIdentityPools.namespaces.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4559,7 +5466,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListWorkloadIdentityPoolProvidersResponse' + $ref: >- + #/components/schemas/ListWorkloadIdentityPoolNamespacesResponse parameters: - in: path name: projectsId @@ -4590,16 +5498,13 @@ paths: schema: type: boolean post: - description: >- - Creates a new WorkloadIdentityPoolProvider in a WorkloadIdentityPool. - You cannot reuse the name of a deleted provider until 30 days after - deletion. - operationId: iam.projects.locations.workloadIdentityPools.providers.create + description: Creates a new WorkloadIdentityPoolNamespace in a WorkloadIdentityPool. + operationId: iam.projects.locations.workloadIdentityPools.namespaces.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/WorkloadIdentityPoolProvider' + $ref: '#/components/schemas/WorkloadIdentityPoolNamespace' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4629,14 +5534,14 @@ paths: schema: type: string - in: query - name: workloadIdentityPoolProviderId + name: workloadIdentityPoolNamespaceId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/providers/{providersId}: + /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}: parameters: *ref_1 get: - description: Gets an individual WorkloadIdentityPoolProvider. - operationId: iam.projects.locations.workloadIdentityPools.providers.get + description: Gets an individual WorkloadIdentityPoolNamespace. + operationId: iam.projects.locations.workloadIdentityPools.namespaces.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4648,7 +5553,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/WorkloadIdentityPoolProvider' + $ref: '#/components/schemas/WorkloadIdentityPoolNamespace' parameters: - in: path name: projectsId @@ -4666,18 +5571,20 @@ paths: schema: type: string - in: path - name: providersId + name: namespacesId required: true schema: type: string patch: - description: Updates an existing WorkloadIdentityPoolProvider. - operationId: iam.projects.locations.workloadIdentityPools.providers.patch + description: >- + Updates an existing WorkloadIdentityPoolNamespace in a + WorkloadIdentityPool. + operationId: iam.projects.locations.workloadIdentityPools.namespaces.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/WorkloadIdentityPoolProvider' + $ref: '#/components/schemas/WorkloadIdentityPoolNamespace' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4707,7 +5614,7 @@ paths: schema: type: string - in: path - name: providersId + name: namespacesId required: true schema: type: string @@ -4718,12 +5625,9 @@ paths: format: google-fieldmask delete: description: >- - Deletes a WorkloadIdentityPoolProvider. Deleting a provider does not - revoke credentials that have already been issued; they continue to grant - access. You can undelete a provider for 30 days. After 30 days, deletion - is permanent. You cannot update deleted providers. However, you can view - and list them. - operationId: iam.projects.locations.workloadIdentityPools.providers.delete + Deletes a WorkloadIdentityPoolNamespace. You can undelete a namespace + for 30 days. After 30 days, deletion is permanent. + operationId: iam.projects.locations.workloadIdentityPools.namespaces.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4753,22 +5657,23 @@ paths: schema: type: string - in: path - name: providersId + name: namespacesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/providers/{providersId}:undelete: + /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}:undelete: parameters: *ref_1 post: description: >- - Undeletes a WorkloadIdentityPoolProvider, as long as it was deleted + Undeletes a WorkloadIdentityPoolNamespace, as long as it was deleted fewer than 30 days ago. - operationId: iam.projects.locations.workloadIdentityPools.providers.undelete + operationId: iam.projects.locations.workloadIdentityPools.namespaces.undelete requestBody: content: application/json: schema: - $ref: '#/components/schemas/UndeleteWorkloadIdentityPoolProviderRequest' + $ref: >- + #/components/schemas/UndeleteWorkloadIdentityPoolNamespaceRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4798,18 +5703,18 @@ paths: schema: type: string - in: path - name: providersId + name: namespacesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/providers/{providersId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}/operations/{operationsId}: parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - operationId: iam.projects.locations.workloadIdentityPools.providers.operations.get + operationId: iam.projects.locations.workloadIdentityPools.namespaces.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4839,7 +5744,7 @@ paths: schema: type: string - in: path - name: providersId + name: namespacesId required: true schema: type: string @@ -4848,13 +5753,15 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/providers/{providersId}/keys: + /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}/managedIdentities: parameters: *ref_1 get: description: >- - Lists all non-deleted WorkloadIdentityPoolProviderKeys in a project. If - show_deleted is set to `true`, then deleted pools are also listed. - operationId: iam.projects.locations.workloadIdentityPools.providers.keys.list + Lists all non-deleted WorkloadIdentityPoolManagedIdentitys in a + namespace. If `show_deleted` is set to `true`, then deleted managed + identities are also listed. + operationId: >- + iam.projects.locations.workloadIdentityPools.namespaces.managedIdentities.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4867,7 +5774,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/ListWorkloadIdentityPoolProviderKeysResponse + #/components/schemas/ListWorkloadIdentityPoolManagedIdentitiesResponse parameters: - in: path name: projectsId @@ -4885,7 +5792,7 @@ paths: schema: type: string - in: path - name: providersId + name: namespacesId required: true schema: type: string @@ -4904,14 +5811,15 @@ paths: type: boolean post: description: >- - Create a new WorkloadIdentityPoolProviderKey in a - WorkloadIdentityPoolProvider. - operationId: iam.projects.locations.workloadIdentityPools.providers.keys.create + Creates a new WorkloadIdentityPoolManagedIdentity in a + WorkloadIdentityPoolNamespace. + operationId: >- + iam.projects.locations.workloadIdentityPools.namespaces.managedIdentities.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/WorkloadIdentityPoolProviderKey' + $ref: '#/components/schemas/WorkloadIdentityPoolManagedIdentity' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4941,19 +5849,20 @@ paths: schema: type: string - in: path - name: providersId + name: namespacesId required: true schema: type: string - in: query - name: workloadIdentityPoolProviderKeyId + name: workloadIdentityPoolManagedIdentityId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/providers/{providersId}/keys/{keysId}: + /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}/managedIdentities/{managedIdentitiesId}: parameters: *ref_1 get: - description: Gets an individual WorkloadIdentityPoolProviderKey. - operationId: iam.projects.locations.workloadIdentityPools.providers.keys.get + description: Gets an individual WorkloadIdentityPoolManagedIdentity. + operationId: >- + iam.projects.locations.workloadIdentityPools.namespaces.managedIdentities.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4965,7 +5874,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/WorkloadIdentityPoolProviderKey' + $ref: '#/components/schemas/WorkloadIdentityPoolManagedIdentity' parameters: - in: path name: projectsId @@ -4983,20 +5892,26 @@ paths: schema: type: string - in: path - name: providersId + name: namespacesId required: true schema: type: string - in: path - name: keysId + name: managedIdentitiesId required: true schema: type: string - delete: + patch: description: >- - Deletes an WorkloadIdentityPoolProviderKey. You can undelete a key for - 30 days. After 30 days, deletion is permanent. - operationId: iam.projects.locations.workloadIdentityPools.providers.keys.delete + Updates an existing WorkloadIdentityPoolManagedIdentity in a + WorkloadIdentityPoolNamespace. + operationId: >- + iam.projects.locations.workloadIdentityPools.namespaces.managedIdentities.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WorkloadIdentityPoolManagedIdentity' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5026,28 +5941,26 @@ paths: schema: type: string - in: path - name: providersId + name: namespacesId required: true schema: type: string - in: path - name: keysId + name: managedIdentitiesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/providers/{providersId}/keys/{keysId}:undelete: - parameters: *ref_1 - post: + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: description: >- - Undeletes an WorkloadIdentityPoolProviderKey, as long as it was deleted - fewer than 30 days ago. - operationId: iam.projects.locations.workloadIdentityPools.providers.keys.undelete - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/UndeleteWorkloadIdentityPoolProviderKeyRequest + Deletes a WorkloadIdentityPoolManagedIdentity. You can undelete a + managed identity for 30 days. After 30 days, deletion is permanent. + operationId: >- + iam.projects.locations.workloadIdentityPools.namespaces.managedIdentities.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5077,24 +5990,29 @@ paths: schema: type: string - in: path - name: providersId + name: namespacesId required: true schema: type: string - in: path - name: keysId + name: managedIdentitiesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/providers/{providersId}/keys/{keysId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}/managedIdentities/{managedIdentitiesId}:undelete: parameters: *ref_1 - get: + post: description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. + Undeletes a WorkloadIdentityPoolManagedIdentity, as long as it was + deleted fewer than 30 days ago. operationId: >- - iam.projects.locations.workloadIdentityPools.providers.keys.operations.get + iam.projects.locations.workloadIdentityPools.namespaces.managedIdentities.undelete + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/UndeleteWorkloadIdentityPoolManagedIdentityRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5124,25 +6042,28 @@ paths: schema: type: string - in: path - name: providersId - required: true - schema: - type: string - - in: path - name: keysId + name: namespacesId required: true schema: type: string - in: path - name: operationsId + name: managedIdentitiesId required: true schema: type: string - /v1/projects/{projectsId}/serviceAccounts: + /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}/managedIdentities/{managedIdentitiesId}:addAttestationRule: parameters: *ref_1 - get: - description: Lists every ServiceAccount that belongs to a specific project. - operationId: iam.projects.serviceAccounts.list + post: + description: >- + Add an AttestationRule on a WorkloadIdentityPoolManagedIdentity. The + total attestation rules after addition must not exceed 50. + operationId: >- + iam.projects.locations.workloadIdentityPools.namespaces.managedIdentities.addAttestationRule + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddAttestationRuleRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5154,30 +6075,1183 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListServiceAccountsResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId required: true schema: type: string - - in: query - name: pageSize + - in: path + name: locationsId + required: true schema: - type: integer - format: int32 - - in: query - name: pageToken + type: string + - in: path + name: workloadIdentityPoolsId + required: true schema: type: string - post: - description: Creates a ServiceAccount. - operationId: iam.projects.serviceAccounts.create - requestBody: + - in: path + name: namespacesId + required: true + schema: + type: string + - in: path + name: managedIdentitiesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}/managedIdentities/{managedIdentitiesId}:removeAttestationRule: + parameters: *ref_1 + post: + description: Remove an AttestationRule on a WorkloadIdentityPoolManagedIdentity. + operationId: >- + iam.projects.locations.workloadIdentityPools.namespaces.managedIdentities.removeAttestationRule + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RemoveAttestationRuleRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workloadIdentityPoolsId + required: true + schema: + type: string + - in: path + name: namespacesId + required: true + schema: + type: string + - in: path + name: managedIdentitiesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}/managedIdentities/{managedIdentitiesId}:setAttestationRules: + parameters: *ref_1 + post: + description: >- + Set all AttestationRule on a WorkloadIdentityPoolManagedIdentity. A + maximum of 50 AttestationRules can be set. + operationId: >- + iam.projects.locations.workloadIdentityPools.namespaces.managedIdentities.setAttestationRules + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetAttestationRulesRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workloadIdentityPoolsId + required: true + schema: + type: string + - in: path + name: namespacesId + required: true + schema: + type: string + - in: path + name: managedIdentitiesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}/managedIdentities/{managedIdentitiesId}:listAttestationRules: + parameters: *ref_1 + get: + description: List all AttestationRule on a WorkloadIdentityPoolManagedIdentity. + operationId: >- + iam.projects.locations.workloadIdentityPools.namespaces.managedIdentities.listAttestationRules + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListAttestationRulesResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workloadIdentityPoolsId + required: true + schema: + type: string + - in: path + name: namespacesId + required: true + schema: + type: string + - in: path + name: managedIdentitiesId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}/managedIdentities/{managedIdentitiesId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: >- + iam.projects.locations.workloadIdentityPools.namespaces.managedIdentities.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workloadIdentityPoolsId + required: true + schema: + type: string + - in: path + name: namespacesId + required: true + schema: + type: string + - in: path + name: managedIdentitiesId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}/managedIdentities/{managedIdentitiesId}/workloadSources/{workloadSourcesId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: >- + iam.projects.locations.workloadIdentityPools.namespaces.managedIdentities.workloadSources.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workloadIdentityPoolsId + required: true + schema: + type: string + - in: path + name: namespacesId + required: true + schema: + type: string + - in: path + name: managedIdentitiesId + required: true + schema: + type: string + - in: path + name: workloadSourcesId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/providers: + parameters: *ref_1 + get: + description: >- + Lists all non-deleted WorkloadIdentityPoolProviders in a + WorkloadIdentityPool. If `show_deleted` is set to `true`, then deleted + providers are also listed. + operationId: iam.projects.locations.workloadIdentityPools.providers.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListWorkloadIdentityPoolProvidersResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workloadIdentityPoolsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: showDeleted + schema: + type: boolean + post: + description: >- + Creates a new WorkloadIdentityPoolProvider in a WorkloadIdentityPool. + You cannot reuse the name of a deleted provider until 30 days after + deletion. + operationId: iam.projects.locations.workloadIdentityPools.providers.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WorkloadIdentityPoolProvider' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workloadIdentityPoolsId + required: true + schema: + type: string + - in: query + name: workloadIdentityPoolProviderId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/providers/{providersId}: + parameters: *ref_1 + get: + description: Gets an individual WorkloadIdentityPoolProvider. + operationId: iam.projects.locations.workloadIdentityPools.providers.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/WorkloadIdentityPoolProvider' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workloadIdentityPoolsId + required: true + schema: + type: string + - in: path + name: providersId + required: true + schema: + type: string + patch: + description: Updates an existing WorkloadIdentityPoolProvider. + operationId: iam.projects.locations.workloadIdentityPools.providers.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WorkloadIdentityPoolProvider' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workloadIdentityPoolsId + required: true + schema: + type: string + - in: path + name: providersId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: >- + Deletes a WorkloadIdentityPoolProvider. Deleting a provider does not + revoke credentials that have already been issued; they continue to grant + access. You can undelete a provider for 30 days. After 30 days, deletion + is permanent. You cannot update deleted providers. However, you can view + and list them. + operationId: iam.projects.locations.workloadIdentityPools.providers.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workloadIdentityPoolsId + required: true + schema: + type: string + - in: path + name: providersId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/providers/{providersId}:undelete: + parameters: *ref_1 + post: + description: >- + Undeletes a WorkloadIdentityPoolProvider, as long as it was deleted + fewer than 30 days ago. + operationId: iam.projects.locations.workloadIdentityPools.providers.undelete + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UndeleteWorkloadIdentityPoolProviderRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workloadIdentityPoolsId + required: true + schema: + type: string + - in: path + name: providersId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/providers/{providersId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: iam.projects.locations.workloadIdentityPools.providers.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workloadIdentityPoolsId + required: true + schema: + type: string + - in: path + name: providersId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/providers/{providersId}/keys: + parameters: *ref_1 + get: + description: >- + Lists all non-deleted WorkloadIdentityPoolProviderKeys in a project. If + show_deleted is set to `true`, then deleted pools are also listed. + operationId: iam.projects.locations.workloadIdentityPools.providers.keys.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/ListWorkloadIdentityPoolProviderKeysResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workloadIdentityPoolsId + required: true + schema: + type: string + - in: path + name: providersId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: showDeleted + schema: + type: boolean + post: + description: >- + Create a new WorkloadIdentityPoolProviderKey in a + WorkloadIdentityPoolProvider. + operationId: iam.projects.locations.workloadIdentityPools.providers.keys.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WorkloadIdentityPoolProviderKey' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workloadIdentityPoolsId + required: true + schema: + type: string + - in: path + name: providersId + required: true + schema: + type: string + - in: query + name: workloadIdentityPoolProviderKeyId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/providers/{providersId}/keys/{keysId}: + parameters: *ref_1 + get: + description: Gets an individual WorkloadIdentityPoolProviderKey. + operationId: iam.projects.locations.workloadIdentityPools.providers.keys.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/WorkloadIdentityPoolProviderKey' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workloadIdentityPoolsId + required: true + schema: + type: string + - in: path + name: providersId + required: true + schema: + type: string + - in: path + name: keysId + required: true + schema: + type: string + delete: + description: >- + Deletes an WorkloadIdentityPoolProviderKey. You can undelete a key for + 30 days. After 30 days, deletion is permanent. + operationId: iam.projects.locations.workloadIdentityPools.providers.keys.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workloadIdentityPoolsId + required: true + schema: + type: string + - in: path + name: providersId + required: true + schema: + type: string + - in: path + name: keysId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/providers/{providersId}/keys/{keysId}:undelete: + parameters: *ref_1 + post: + description: >- + Undeletes an WorkloadIdentityPoolProviderKey, as long as it was deleted + fewer than 30 days ago. + operationId: iam.projects.locations.workloadIdentityPools.providers.keys.undelete + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/UndeleteWorkloadIdentityPoolProviderKeyRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workloadIdentityPoolsId + required: true + schema: + type: string + - in: path + name: providersId + required: true + schema: + type: string + - in: path + name: keysId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/providers/{providersId}/keys/{keysId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: >- + iam.projects.locations.workloadIdentityPools.providers.keys.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workloadIdentityPoolsId + required: true + schema: + type: string + - in: path + name: providersId + required: true + schema: + type: string + - in: path + name: keysId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/serviceAccounts: + parameters: *ref_1 + get: + description: Lists every ServiceAccount that belongs to a specific project. + operationId: iam.projects.serviceAccounts.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListServiceAccountsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + post: + description: Creates a ServiceAccount. + operationId: iam.projects.serviceAccounts.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateServiceAccountRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceAccount' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + /v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}: + parameters: *ref_1 + get: + description: Gets a ServiceAccount. + operationId: iam.projects.serviceAccounts.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceAccount' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: serviceAccountsId + required: true + schema: + type: string + put: + description: >- + **Note:** We are in the process of deprecating this method. Use + PatchServiceAccount instead. Updates a ServiceAccount. You can update + only the `display_name` field. + operationId: iam.projects.serviceAccounts.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceAccount' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceAccount' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: serviceAccountsId + required: true + schema: + type: string + patch: + description: Patches a ServiceAccount. + operationId: iam.projects.serviceAccounts.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchServiceAccountRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceAccount' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: serviceAccountsId + required: true + schema: + type: string + delete: + description: >- + Deletes a ServiceAccount. **Warning:** After you delete a service + account, you might not be able to undelete it. If you know that you need + to re-enable the service account in the future, use + DisableServiceAccount instead. If you delete a service account, IAM + permanently removes the service account 30 days later. Google Cloud + cannot recover the service account after it is permanently removed, even + if you file a support request. To help avoid unplanned outages, we + recommend that you disable the service account before you delete it. Use + DisableServiceAccount to disable the service account, then wait at least + 24 hours and watch for unintended consequences. If there are no + unintended consequences, you can delete the service account. + operationId: iam.projects.serviceAccounts.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: serviceAccountsId + required: true + schema: + type: string + /v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:undelete: + parameters: *ref_1 + post: + description: >- + Restores a deleted ServiceAccount. **Important:** It is not always + possible to restore a deleted service account. Use this method only as a + last resort. After you delete a service account, IAM permanently removes + the service account 30 days later. There is no way to restore a deleted + service account that has been permanently removed. + operationId: iam.projects.serviceAccounts.undelete + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UndeleteServiceAccountRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/UndeleteServiceAccountResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: serviceAccountsId + required: true + schema: + type: string + /v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:enable: + parameters: *ref_1 + post: + description: >- + Enables a ServiceAccount that was disabled by DisableServiceAccount. If + the service account is already enabled, then this method has no effect. + If the service account was disabled by other means—for example, if + Google disabled the service account because it was compromised—you + cannot use this method to enable the service account. + operationId: iam.projects.serviceAccounts.enable + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EnableServiceAccountRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: serviceAccountsId + required: true + schema: + type: string + /v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:disable: + parameters: *ref_1 + post: + description: >- + Disables a ServiceAccount immediately. If an application uses the + service account to authenticate, that application can no longer call + Google APIs or access Google Cloud resources. Existing access tokens for + the service account are rejected, and requests for new access tokens + will fail. To re-enable the service account, use EnableServiceAccount. + After you re-enable the service account, its existing access tokens will + be accepted, and you can request new access tokens. To help avoid + unplanned outages, we recommend that you disable the service account + before you delete it. Use this method to disable the service account, + then wait at least 24 hours and watch for unintended consequences. If + there are no unintended consequences, you can delete the service account + with DeleteServiceAccount. + operationId: iam.projects.serviceAccounts.disable + requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateServiceAccountRequest' + $ref: '#/components/schemas/DisableServiceAccountRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5189,18 +7263,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServiceAccount' + $ref: '#/components/schemas/Empty' parameters: - in: path name: projectsId required: true schema: type: string - /v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}: + - in: path + name: serviceAccountsId + required: true + schema: + type: string + /v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:signBlob: parameters: *ref_1 - get: - description: Gets a ServiceAccount. - operationId: iam.projects.serviceAccounts.get + post: + description: ' Signs a blob using the system-managed private key for a ServiceAccount.' + operationId: iam.projects.serviceAccounts.signBlob + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SignBlobRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5212,7 +7296,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServiceAccount' + $ref: '#/components/schemas/SignBlobResponse' parameters: - in: path name: projectsId @@ -5224,17 +7308,104 @@ paths: required: true schema: type: string - put: + /v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:signJwt: + parameters: *ref_1 + post: + description: ' Signs a JSON Web Token (JWT) using the system-managed private key for a ServiceAccount.' + operationId: iam.projects.serviceAccounts.signJwt + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SignJwtRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SignJwtResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: serviceAccountsId + required: true + schema: + type: string + /v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:getIamPolicy: + parameters: *ref_1 + post: description: >- - **Note:** We are in the process of deprecating this method. Use - PatchServiceAccount instead. Updates a ServiceAccount. You can update - only the `display_name` field. - operationId: iam.projects.serviceAccounts.update + Gets the IAM policy that is attached to a ServiceAccount. This IAM + policy specifies which principals have access to the service account. + This method does not tell you whether the service account has been + granted any roles on other resources. To check whether a service account + has role grants on a resource, use the `getIamPolicy` method for that + resource. For example, to view the role grants for a project, call the + Resource Manager API's + [projects.getIamPolicy](https://cloud.google.com/resource-manager/reference/rest/v1/projects/getIamPolicy) + method. + operationId: iam.projects.serviceAccounts.getIamPolicy + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: serviceAccountsId + required: true + schema: + type: string + - in: query + name: options.requestedPolicyVersion + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:setIamPolicy: + parameters: *ref_1 + post: + description: >- + Sets the IAM policy that is attached to a ServiceAccount. Use this + method to grant or revoke access to the service account. For example, + you could grant a principal the ability to impersonate the service + account. This method does not enable the service account to access other + resources. To grant roles to a service account on a resource, follow + these steps: 1. Call the resource's `getIamPolicy` method to get its + current IAM policy. 2. Edit the policy so that it binds the service + account to an IAM role for the resource. 3. Call the resource's + `setIamPolicy` method to update its IAM policy. For detailed + instructions, see [Manage access to project, folders, and + organizations](https://cloud.google.com/iam/help/service-accounts/granting-access-to-service-accounts) + or [Manage access to other + resources](https://cloud.google.com/iam/help/access/manage-other-resources). + operationId: iam.projects.serviceAccounts.setIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/ServiceAccount' + $ref: '#/components/schemas/SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5246,7 +7417,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServiceAccount' + $ref: '#/components/schemas/Policy' parameters: - in: path name: projectsId @@ -5258,14 +7429,109 @@ paths: required: true schema: type: string - patch: - description: Patches a ServiceAccount. - operationId: iam.projects.serviceAccounts.patch + /v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:testIamPermissions: + parameters: *ref_1 + post: + description: >- + Tests whether the caller has the specified permissions on a + ServiceAccount. + operationId: iam.projects.serviceAccounts.testIamPermissions requestBody: content: application/json: schema: - $ref: '#/components/schemas/PatchServiceAccountRequest' + $ref: '#/components/schemas/TestIamPermissionsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: serviceAccountsId + required: true + schema: + type: string + /v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys: + parameters: *ref_1 + get: + description: Lists every ServiceAccountKey for a service account. + operationId: iam.projects.serviceAccounts.keys.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListServiceAccountKeysResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: serviceAccountsId + required: true + schema: + type: string + - in: query + name: keyTypes + schema: + type: string + post: + description: Creates a ServiceAccountKey. + operationId: iam.projects.serviceAccounts.keys.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateServiceAccountKeyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceAccountKey' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: serviceAccountsId + required: true + schema: + type: string + /v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys/{keysId}: + parameters: *ref_1 + get: + description: Gets a ServiceAccountKey. + operationId: iam.projects.serviceAccounts.keys.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5277,7 +7543,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServiceAccount' + $ref: '#/components/schemas/ServiceAccountKey' parameters: - in: path name: projectsId @@ -5289,20 +7555,21 @@ paths: required: true schema: type: string + - in: path + name: keysId + required: true + schema: + type: string + - in: query + name: publicKeyType + schema: + type: string delete: description: >- - Deletes a ServiceAccount. **Warning:** After you delete a service - account, you might not be able to undelete it. If you know that you need - to re-enable the service account in the future, use - DisableServiceAccount instead. If you delete a service account, IAM - permanently removes the service account 30 days later. Google Cloud - cannot recover the service account after it is permanently removed, even - if you file a support request. To help avoid unplanned outages, we - recommend that you disable the service account before you delete it. Use - DisableServiceAccount to disable the service account, then wait at least - 24 hours and watch for unintended consequences. If there are no - unintended consequences, you can delete the service account. - operationId: iam.projects.serviceAccounts.delete + Deletes a ServiceAccountKey. Deleting a service account key does not + revoke short-lived credentials that have been issued based on the + service account key. + operationId: iam.projects.serviceAccounts.keys.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5326,21 +7593,25 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:undelete: + - in: path + name: keysId + required: true + schema: + type: string + /v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys:upload: parameters: *ref_1 post: description: >- - Restores a deleted ServiceAccount. **Important:** It is not always - possible to restore a deleted service account. Use this method only as a - last resort. After you delete a service account, IAM permanently removes - the service account 30 days later. There is no way to restore a deleted - service account that has been permanently removed. - operationId: iam.projects.serviceAccounts.undelete + Uploads the public key portion of a key pair that you manage, and + associates the public key with a ServiceAccount. After you upload the + public key, you can use the private key from the key pair as a service + account key. + operationId: iam.projects.serviceAccounts.keys.upload requestBody: content: application/json: schema: - $ref: '#/components/schemas/UndeleteServiceAccountRequest' + $ref: '#/components/schemas/UploadServiceAccountKeyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5352,7 +7623,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UndeleteServiceAccountResponse' + $ref: '#/components/schemas/ServiceAccountKey' parameters: - in: path name: projectsId @@ -5364,21 +7635,18 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:enable: + /v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys/{keysId}:disable: parameters: *ref_1 post: description: >- - Enables a ServiceAccount that was disabled by DisableServiceAccount. If - the service account is already enabled, then this method has no effect. - If the service account was disabled by other means—for example, if - Google disabled the service account because it was compromised—you - cannot use this method to enable the service account. - operationId: iam.projects.serviceAccounts.enable + Disable a ServiceAccountKey. A disabled service account key can be + re-enabled with EnableServiceAccountKey. + operationId: iam.projects.serviceAccounts.keys.disable requestBody: content: application/json: schema: - $ref: '#/components/schemas/EnableServiceAccountRequest' + $ref: '#/components/schemas/DisableServiceAccountKeyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5402,28 +7670,21 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:disable: + - in: path + name: keysId + required: true + schema: + type: string + /v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys/{keysId}:enable: parameters: *ref_1 post: - description: >- - Disables a ServiceAccount immediately. If an application uses the - service account to authenticate, that application can no longer call - Google APIs or access Google Cloud resources. Existing access tokens for - the service account are rejected, and requests for new access tokens - will fail. To re-enable the service account, use EnableServiceAccount. - After you re-enable the service account, its existing access tokens will - be accepted, and you can request new access tokens. To help avoid - unplanned outages, we recommend that you disable the service account - before you delete it. Use this method to disable the service account, - then wait at least 24 hours and watch for unintended consequences. If - there are no unintended consequences, you can delete the service account - with DeleteServiceAccount. - operationId: iam.projects.serviceAccounts.disable + description: Enable a ServiceAccountKey. + operationId: iam.projects.serviceAccounts.keys.enable requestBody: content: application/json: schema: - $ref: '#/components/schemas/DisableServiceAccountRequest' + $ref: '#/components/schemas/EnableServiceAccountKeyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5447,23 +7708,18 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:signBlob: + - in: path + name: keysId + required: true + schema: + type: string + /v1/projects/{projectsId}/roles: parameters: *ref_1 - post: + get: description: >- - **Note:** This method is deprecated. Use the - [signBlob](https://cloud.google.com/iam/help/rest-credentials/v1/projects.serviceAccounts/signBlob) - method in the IAM Service Account Credentials API instead. If you - currently use this method, see the [migration - guide](https://cloud.google.com/iam/help/credentials/migrate-api) for - instructions. Signs a blob using the system-managed private key for a - ServiceAccount. - operationId: iam.projects.serviceAccounts.signBlob - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SignBlobRequest' + Lists every predefined Role that IAM supports, or every custom role that + is defined for an organization or project. + operationId: iam.projects.roles.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5475,35 +7731,38 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SignBlobResponse' + $ref: '#/components/schemas/ListRolesResponse' parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: serviceAccountsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:signJwt: - parameters: *ref_1 + - in: query + name: view + schema: + type: string + - in: query + name: showDeleted + schema: + type: boolean post: - description: >- - **Note:** This method is deprecated. Use the - [signJwt](https://cloud.google.com/iam/help/rest-credentials/v1/projects.serviceAccounts/signJwt) - method in the IAM Service Account Credentials API instead. If you - currently use this method, see the [migration - guide](https://cloud.google.com/iam/help/credentials/migrate-api) for - instructions. Signs a JSON Web Token (JWT) using the system-managed - private key for a ServiceAccount. - operationId: iam.projects.serviceAccounts.signJwt + description: Creates a new custom Role. + operationId: iam.projects.roles.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SignJwtRequest' + $ref: '#/components/schemas/CreateRoleRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5515,7 +7774,30 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SignJwtResponse' + $ref: '#/components/schemas/Role' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + /v1/projects/{projectsId}/roles/{rolesId}: + parameters: *ref_1 + get: + description: Gets the definition of a Role. + operationId: iam.projects.roles.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Role' parameters: - in: path name: projectsId @@ -5523,24 +7805,18 @@ paths: schema: type: string - in: path - name: serviceAccountsId + name: rolesId required: true schema: type: string - /v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:getIamPolicy: - parameters: *ref_1 - post: - description: >- - Gets the IAM policy that is attached to a ServiceAccount. This IAM - policy specifies which principals have access to the service account. - This method does not tell you whether the service account has been - granted any roles on other resources. To check whether a service account - has role grants on a resource, use the `getIamPolicy` method for that - resource. For example, to view the role grants for a project, call the - Resource Manager API's - [projects.getIamPolicy](https://cloud.google.com/resource-manager/reference/rest/v1/projects/getIamPolicy) - method. - operationId: iam.projects.serviceAccounts.getIamPolicy + patch: + description: Updates the definition of a custom Role. + operationId: iam.projects.roles.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Role' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5552,7 +7828,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Role' parameters: - in: path name: projectsId @@ -5560,38 +7836,30 @@ paths: schema: type: string - in: path - name: serviceAccountsId + name: rolesId required: true schema: type: string - in: query - name: options.requestedPolicyVersion + name: updateMask schema: - type: integer - format: int32 - /v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:setIamPolicy: - parameters: *ref_1 - post: + type: string + format: google-fieldmask + delete: description: >- - Sets the IAM policy that is attached to a ServiceAccount. Use this - method to grant or revoke access to the service account. For example, - you could grant a principal the ability to impersonate the service - account. This method does not enable the service account to access other - resources. To grant roles to a service account on a resource, follow - these steps: 1. Call the resource's `getIamPolicy` method to get its - current IAM policy. 2. Edit the policy so that it binds the service - account to an IAM role for the resource. 3. Call the resource's - `setIamPolicy` method to update its IAM policy. For detailed - instructions, see [Manage access to project, folders, and - organizations](https://cloud.google.com/iam/help/service-accounts/granting-access-to-service-accounts) - or [Manage access to other - resources](https://cloud.google.com/iam/help/access/manage-other-resources). - operationId: iam.projects.serviceAccounts.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SetIamPolicyRequest' + Deletes a custom Role. When you delete a custom role, the following + changes occur immediately: * You cannot bind a principal to the custom + role in an IAM Policy. * Existing bindings to the custom role are not + changed, but they have no effect. * By default, the response from + ListRoles does not include the custom role. A deleted custom role still + counts toward the [custom role + limit](https://cloud.google.com/iam/help/limits) until it is permanently + deleted. You have 7 days to undelete the custom role. After 7 days, the + following changes occur: * The custom role is permanently deleted and + cannot be recovered. * If an IAM policy contains a binding to the custom + role, the binding is permanently removed. * The custom role no longer + counts toward your custom role limit. + operationId: iam.projects.roles.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5603,7 +7871,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Role' parameters: - in: path name: projectsId @@ -5611,22 +7879,25 @@ paths: schema: type: string - in: path - name: serviceAccountsId + name: rolesId required: true schema: type: string - /v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:testIamPermissions: + - in: query + name: etag + schema: + type: string + format: byte + /v1/projects/{projectsId}/roles/{rolesId}:undelete: parameters: *ref_1 post: - description: >- - Tests whether the caller has the specified permissions on a - ServiceAccount. - operationId: iam.projects.serviceAccounts.testIamPermissions + description: Undeletes a custom Role. + operationId: iam.projects.roles.undelete requestBody: content: application/json: schema: - $ref: '#/components/schemas/TestIamPermissionsRequest' + $ref: '#/components/schemas/UndeleteRoleRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5638,7 +7909,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TestIamPermissionsResponse' + $ref: '#/components/schemas/Role' parameters: - in: path name: projectsId @@ -5646,15 +7917,17 @@ paths: schema: type: string - in: path - name: serviceAccountsId + name: rolesId required: true schema: type: string - /v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys: + /v1/locations/{locationsId}/workforcePools: parameters: *ref_1 get: - description: Lists every ServiceAccountKey for a service account. - operationId: iam.projects.serviceAccounts.keys.list + description: >- + Lists all non-deleted WorkforcePools under the specified parent. If + `show_deleted` is set to `true`, then deleted pools are also listed. + operationId: iam.locations.workforcePools.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5666,30 +7939,40 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListServiceAccountKeysResponse' + $ref: '#/components/schemas/ListWorkforcePoolsResponse' parameters: - in: path - name: projectsId + name: locationsId required: true schema: type: string - - in: path - name: serviceAccountsId - required: true + - in: query + name: parent schema: type: string - in: query - name: keyTypes + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string + - in: query + name: showDeleted + schema: + type: boolean post: - description: Creates a ServiceAccountKey. - operationId: iam.projects.serviceAccounts.keys.create + description: >- + Creates a new WorkforcePool. You cannot reuse the name of a deleted pool + until 30 days after deletion. + operationId: iam.locations.workforcePools.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateServiceAccountKeyRequest' + $ref: '#/components/schemas/WorkforcePool' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5701,23 +7984,22 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServiceAccountKey' + $ref: '#/components/schemas/Operation' parameters: - in: path - name: projectsId + name: locationsId required: true schema: type: string - - in: path - name: serviceAccountsId - required: true + - in: query + name: workforcePoolId schema: type: string - /v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys/{keysId}: + /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}: parameters: *ref_1 get: - description: Gets a ServiceAccountKey. - operationId: iam.projects.serviceAccounts.keys.get + description: Gets an individual WorkforcePool. + operationId: iam.locations.workforcePools.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5729,33 +8011,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServiceAccountKey' + $ref: '#/components/schemas/WorkforcePool' parameters: - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: serviceAccountsId + name: locationsId required: true schema: type: string - in: path - name: keysId + name: workforcePoolsId required: true schema: type: string - - in: query - name: publicKeyType - schema: - type: string - delete: - description: >- - Deletes a ServiceAccountKey. Deleting a service account key does not - revoke short-lived credentials that have been issued based on the - service account key. - operationId: iam.projects.serviceAccounts.keys.delete + patch: + description: Updates an existing WorkforcePool. + operationId: iam.locations.workforcePools.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WorkforcePool' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5767,37 +8042,34 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/Operation' parameters: - in: path - name: projectsId + name: locationsId required: true schema: type: string - in: path - name: serviceAccountsId + name: workforcePoolsId required: true schema: type: string - - in: path - name: keysId - required: true + - in: query + name: updateMask schema: type: string - /v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys:upload: - parameters: *ref_1 - post: + format: google-fieldmask + delete: description: >- - Uploads the public key portion of a key pair that you manage, and - associates the public key with a ServiceAccount. After you upload the - public key, you can use the private key from the key pair as a service - account key. - operationId: iam.projects.serviceAccounts.keys.upload - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/UploadServiceAccountKeyRequest' + Deletes a WorkforcePool. You cannot use a deleted WorkforcePool to + exchange external credentials for Google Cloud credentials. However, + deletion does not revoke credentials that have already been issued. + Credentials issued for a deleted pool do not grant access to resources. + If the pool is undeleted, and the credentials are not expired, they + grant access again. You can undelete a pool for 30 days. After 30 days, + deletion is permanent. You cannot update deleted pools. However, you can + view and list them. + operationId: iam.locations.workforcePools.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5809,30 +8081,30 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServiceAccountKey' + $ref: '#/components/schemas/Operation' parameters: - in: path - name: projectsId + name: locationsId required: true schema: type: string - in: path - name: serviceAccountsId + name: workforcePoolsId required: true schema: type: string - /v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys/{keysId}:disable: + /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}:undelete: parameters: *ref_1 post: description: >- - Disable a ServiceAccountKey. A disabled service account key can be - re-enabled with EnableServiceAccountKey. - operationId: iam.projects.serviceAccounts.keys.disable + Undeletes a WorkforcePool, as long as it was deleted fewer than 30 days + ago. + operationId: iam.locations.workforcePools.undelete requestBody: content: application/json: schema: - $ref: '#/components/schemas/DisableServiceAccountKeyRequest' + $ref: '#/components/schemas/UndeleteWorkforcePoolRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5844,33 +8116,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/Operation' parameters: - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: serviceAccountsId + name: locationsId required: true schema: type: string - in: path - name: keysId + name: workforcePoolsId required: true schema: type: string - /v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys/{keysId}:enable: + /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}:getIamPolicy: parameters: *ref_1 post: - description: Enable a ServiceAccountKey. - operationId: iam.projects.serviceAccounts.keys.enable + description: Gets IAM policies on a WorkforcePool. + operationId: iam.locations.workforcePools.getIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/EnableServiceAccountKeyRequest' + $ref: '#/components/schemas/GetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5882,30 +8149,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/Policy' parameters: - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: serviceAccountsId + name: locationsId required: true schema: type: string - in: path - name: keysId + name: workforcePoolsId required: true schema: type: string - /v1/projects/{projectsId}/roles: + /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}:setIamPolicy: parameters: *ref_1 - get: - description: >- - Lists every predefined Role that IAM supports, or every custom role that - is defined for an organization or project. - operationId: iam.projects.roles.list + post: + description: Sets IAM policies on a WorkforcePool. + operationId: iam.locations.workforcePools.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5917,38 +8182,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListRolesResponse' + $ref: '#/components/schemas/Policy' parameters: - in: path - name: projectsId + name: locationsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: view + - in: path + name: workforcePoolsId + required: true schema: type: string - - in: query - name: showDeleted - schema: - type: boolean + /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}:testIamPermissions: + parameters: *ref_1 post: - description: Creates a new custom Role. - operationId: iam.projects.roles.create + description: >- + Returns the caller's permissions on the WorkforcePool. If the pool + doesn't exist, this call returns an empty set of permissions. It doesn't + return a `NOT_FOUND` error. + operationId: iam.locations.workforcePools.testIamPermissions requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateRoleRequest' + $ref: '#/components/schemas/TestIamPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5960,18 +8218,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Role' + $ref: '#/components/schemas/TestIamPermissionsResponse' parameters: - in: path - name: projectsId + name: locationsId required: true schema: type: string - /v1/projects/{projectsId}/roles/{rolesId}: + - in: path + name: workforcePoolsId + required: true + schema: + type: string + /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/operations/{operationsId}: parameters: *ref_1 get: - description: Gets the definition of a Role. - operationId: iam.projects.roles.get + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: iam.locations.workforcePools.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5983,26 +8249,30 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Role' + $ref: '#/components/schemas/Operation' parameters: - in: path - name: projectsId + name: locationsId required: true schema: type: string - in: path - name: rolesId + name: workforcePoolsId required: true schema: type: string - patch: - description: Updates the definition of a custom Role. - operationId: iam.projects.roles.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Role' + - in: path + name: operationsId + required: true + schema: + type: string + /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers: + parameters: *ref_1 + get: + description: >- + Lists all non-deleted WorkforcePoolProviders in a WorkforcePool. If + `show_deleted` is set to `true`, then deleted providers are also listed. + operationId: iam.locations.workforcePools.providers.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6014,38 +8284,41 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Role' + $ref: '#/components/schemas/ListWorkforcePoolProvidersResponse' parameters: - in: path - name: projectsId + name: locationsId required: true schema: type: string - in: path - name: rolesId + name: workforcePoolsId required: true schema: type: string - in: query - name: updateMask + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - format: google-fieldmask - delete: + - in: query + name: showDeleted + schema: + type: boolean + post: description: >- - Deletes a custom Role. When you delete a custom role, the following - changes occur immediately: * You cannot bind a principal to the custom - role in an IAM Policy. * Existing bindings to the custom role are not - changed, but they have no effect. * By default, the response from - ListRoles does not include the custom role. A deleted custom role still - counts toward the [custom role - limit](https://cloud.google.com/iam/help/limits) until it is permanently - deleted. You have 7 days to undelete the custom role. After 7 days, the - following changes occur: * The custom role is permanently deleted and - cannot be recovered. * If an IAM policy contains a binding to the custom - role, the binding is permanently removed. * The custom role no longer - counts toward your custom role limit. - operationId: iam.projects.roles.delete + Creates a new WorkforcePoolProvider in a WorkforcePool. You cannot reuse + the name of a deleted provider until 30 days after deletion. + operationId: iam.locations.workforcePools.providers.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WorkforcePoolProvider' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6057,33 +8330,27 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Role' + $ref: '#/components/schemas/Operation' parameters: - in: path - name: projectsId + name: locationsId required: true schema: type: string - in: path - name: rolesId + name: workforcePoolsId required: true schema: type: string - in: query - name: etag + name: workforcePoolProviderId schema: type: string - format: byte - /v1/projects/{projectsId}/roles/{rolesId}:undelete: + /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}: parameters: *ref_1 - post: - description: Undeletes a custom Role. - operationId: iam.projects.roles.undelete - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/UndeleteRoleRequest' + get: + description: Gets an individual WorkforcePoolProvider. + operationId: iam.locations.workforcePools.providers.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6095,25 +8362,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Role' + $ref: '#/components/schemas/WorkforcePoolProvider' parameters: - in: path - name: projectsId + name: locationsId required: true schema: type: string - in: path - name: rolesId + name: workforcePoolsId required: true schema: type: string - /v1/locations/{locationsId}/workforcePools: - parameters: *ref_1 - get: - description: >- - Lists all non-deleted WorkforcePools under the specified parent. If - `show_deleted` is set to `true`, then deleted pools are also listed. - operationId: iam.locations.workforcePools.list + - in: path + name: providersId + required: true + schema: + type: string + patch: + description: Updates an existing WorkforcePoolProvider. + operationId: iam.locations.workforcePools.providers.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WorkforcePoolProvider' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6125,40 +8398,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListWorkforcePoolsResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: locationsId required: true schema: type: string - - in: query - name: parent + - in: path + name: workforcePoolsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: providersId + required: true schema: type: string - in: query - name: showDeleted + name: updateMask schema: - type: boolean - post: + type: string + format: google-fieldmask + delete: description: >- - Creates a new WorkforcePool. You cannot reuse the name of a deleted pool - until 30 days after deletion. - operationId: iam.locations.workforcePools.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/WorkforcePool' + Deletes a WorkforcePoolProvider. Deleting a provider does not revoke + credentials that have already been issued; they continue to grant + access. You can undelete a provider for 30 days. After 30 days, deletion + is permanent. You cannot update deleted providers. However, you can view + and list them. + operationId: iam.locations.workforcePools.providers.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6177,15 +8446,28 @@ paths: required: true schema: type: string - - in: query - name: workforcePoolId + - in: path + name: workforcePoolsId + required: true schema: type: string - /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}: + - in: path + name: providersId + required: true + schema: + type: string + /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}:undelete: parameters: *ref_1 - get: - description: Gets an individual WorkforcePool. - operationId: iam.locations.workforcePools.get + post: + description: >- + Undeletes a WorkforcePoolProvider, as long as it was deleted fewer than + 30 days ago. + operationId: iam.locations.workforcePools.providers.undelete + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UndeleteWorkforcePoolProviderRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6197,7 +8479,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/WorkforcePool' + $ref: '#/components/schemas/Operation' parameters: - in: path name: locationsId @@ -6209,14 +8491,19 @@ paths: required: true schema: type: string - patch: - description: Updates an existing WorkforcePool. - operationId: iam.locations.workforcePools.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/WorkforcePool' + - in: path + name: providersId + required: true + schema: + type: string + /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: iam.locations.workforcePools.providers.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6240,22 +8527,24 @@ paths: required: true schema: type: string - - in: query - name: updateMask + - in: path + name: providersId + required: true schema: type: string - format: google-fieldmask - delete: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/keys: + parameters: *ref_1 + get: description: >- - Deletes a WorkforcePool. You cannot use a deleted WorkforcePool to - exchange external credentials for Google Cloud credentials. However, - deletion does not revoke credentials that have already been issued. - Credentials issued for a deleted pool do not grant access to resources. - If the pool is undeleted, and the credentials are not expired, they - grant access again. You can undelete a pool for 30 days. After 30 days, - deletion is permanent. You cannot update deleted pools. However, you can - view and list them. - operationId: iam.locations.workforcePools.delete + Lists all non-deleted WorkforcePoolProviderKeys in a + WorkforcePoolProvider. If `show_deleted` is set to `true`, then deleted + keys are also listed. + operationId: iam.locations.workforcePools.providers.keys.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6267,7 +8556,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/ListWorkforcePoolProviderKeysResponse' parameters: - in: path name: locationsId @@ -6279,18 +8568,32 @@ paths: required: true schema: type: string - /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}:undelete: - parameters: *ref_1 + - in: path + name: providersId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: showDeleted + schema: + type: boolean post: - description: >- - Undeletes a WorkforcePool, as long as it was deleted fewer than 30 days - ago. - operationId: iam.locations.workforcePools.undelete + description: Creates a new WorkforcePoolProviderKey in a WorkforcePoolProvider. + operationId: iam.locations.workforcePools.providers.keys.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/UndeleteWorkforcePoolRequest' + $ref: '#/components/schemas/WorkforcePoolProviderKey' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6314,16 +8617,20 @@ paths: required: true schema: type: string - /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}:getIamPolicy: + - in: path + name: providersId + required: true + schema: + type: string + - in: query + name: workforcePoolProviderKeyId + schema: + type: string + /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/keys/{keysId}: parameters: *ref_1 - post: - description: Gets IAM policies on a WorkforcePool. - operationId: iam.locations.workforcePools.getIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GetIamPolicyRequest' + get: + description: Gets a WorkforcePoolProviderKey. + operationId: iam.locations.workforcePools.providers.keys.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6335,7 +8642,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/WorkforcePoolProviderKey' parameters: - in: path name: locationsId @@ -6347,16 +8654,21 @@ paths: required: true schema: type: string - /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}:setIamPolicy: - parameters: *ref_1 - post: - description: Sets IAM policies on a WorkforcePool. - operationId: iam.locations.workforcePools.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SetIamPolicyRequest' + - in: path + name: providersId + required: true + schema: + type: string + - in: path + name: keysId + required: true + schema: + type: string + delete: + description: >- + Deletes a WorkforcePoolProviderKey. You can undelete a key for 30 days. + After 30 days, deletion is permanent. + operationId: iam.locations.workforcePools.providers.keys.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6368,7 +8680,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Operation' parameters: - in: path name: locationsId @@ -6380,19 +8692,28 @@ paths: required: true schema: type: string - /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}:testIamPermissions: + - in: path + name: providersId + required: true + schema: + type: string + - in: path + name: keysId + required: true + schema: + type: string + /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/keys/{keysId}:undelete: parameters: *ref_1 post: description: >- - Returns the caller's permissions on the WorkforcePool. If the pool - doesn't exist, this call returns an empty set of permissions. It doesn't - return a `NOT_FOUND` error. - operationId: iam.locations.workforcePools.testIamPermissions + Undeletes a WorkforcePoolProviderKey, as long as it was deleted fewer + than 30 days ago. + operationId: iam.locations.workforcePools.providers.keys.undelete requestBody: content: application/json: schema: - $ref: '#/components/schemas/TestIamPermissionsRequest' + $ref: '#/components/schemas/UndeleteWorkforcePoolProviderKeyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6404,7 +8725,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TestIamPermissionsResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: locationsId @@ -6416,14 +8737,24 @@ paths: required: true schema: type: string - /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/operations/{operationsId}: + - in: path + name: providersId + required: true + schema: + type: string + - in: path + name: keysId + required: true + schema: + type: string + /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/keys/{keysId}/operations/{operationsId}: parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - operationId: iam.locations.workforcePools.operations.get + operationId: iam.locations.workforcePools.providers.keys.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6447,18 +8778,29 @@ paths: required: true schema: type: string + - in: path + name: providersId + required: true + schema: + type: string + - in: path + name: keysId + required: true + schema: + type: string - in: path name: operationsId required: true schema: type: string - /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers: + /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants: parameters: *ref_1 get: description: >- - Lists all non-deleted WorkforcePoolProviders in a WorkforcePool. If - `show_deleted` is set to `true`, then deleted providers are also listed. - operationId: iam.locations.workforcePools.providers.list + Lists all non-deleted WorkforcePoolProviderScimTenants in a + WorkforcePoolProvider. If `show_deleted` is set to `true`, then deleted + scim tenants are also listed. + operationId: iam.locations.workforcePools.providers.scimTenants.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6470,7 +8812,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListWorkforcePoolProvidersResponse' + $ref: >- + #/components/schemas/ListWorkforcePoolProviderScimTenantsResponse parameters: - in: path name: locationsId @@ -6482,6 +8825,11 @@ paths: required: true schema: type: string + - in: path + name: providersId + required: true + schema: + type: string - in: query name: pageSize schema: @@ -6497,14 +8845,15 @@ paths: type: boolean post: description: >- - Creates a new WorkforcePoolProvider in a WorkforcePool. You cannot reuse - the name of a deleted provider until 30 days after deletion. - operationId: iam.locations.workforcePools.providers.create + Creates a new WorkforcePoolProviderScimTenant in a + WorkforcePoolProvider. You cannot reuse the name of a deleted scim + tenant until 30 days after deletion. + operationId: iam.locations.workforcePools.providers.scimTenants.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/WorkforcePoolProvider' + $ref: '#/components/schemas/WorkforcePoolProviderScimTenant' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6516,7 +8865,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/WorkforcePoolProviderScimTenant' parameters: - in: path name: locationsId @@ -6528,15 +8877,20 @@ paths: required: true schema: type: string + - in: path + name: providersId + required: true + schema: + type: string - in: query - name: workforcePoolProviderId + name: workforcePoolProviderScimTenantId schema: type: string - /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}: + /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants/{scimTenantsId}: parameters: *ref_1 get: - description: Gets an individual WorkforcePoolProvider. - operationId: iam.locations.workforcePools.providers.get + description: Gets an individual WorkforcePoolProviderScimTenant. + operationId: iam.locations.workforcePools.providers.scimTenants.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6548,7 +8902,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/WorkforcePoolProvider' + $ref: '#/components/schemas/WorkforcePoolProviderScimTenant' parameters: - in: path name: locationsId @@ -6565,14 +8919,19 @@ paths: required: true schema: type: string + - in: path + name: scimTenantsId + required: true + schema: + type: string patch: - description: Updates an existing WorkforcePoolProvider. - operationId: iam.locations.workforcePools.providers.patch + description: Updates an existing WorkforcePoolProviderScimTenant. + operationId: iam.locations.workforcePools.providers.scimTenants.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/WorkforcePoolProvider' + $ref: '#/components/schemas/WorkforcePoolProviderScimTenant' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6584,7 +8943,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/WorkforcePoolProviderScimTenant' parameters: - in: path name: locationsId @@ -6601,6 +8960,11 @@ paths: required: true schema: type: string + - in: path + name: scimTenantsId + required: true + schema: + type: string - in: query name: updateMask schema: @@ -6608,12 +8972,10 @@ paths: format: google-fieldmask delete: description: >- - Deletes a WorkforcePoolProvider. Deleting a provider does not revoke - credentials that have already been issued; they continue to grant - access. You can undelete a provider for 30 days. After 30 days, deletion - is permanent. You cannot update deleted providers. However, you can view - and list them. - operationId: iam.locations.workforcePools.providers.delete + Deletes a WorkforcePoolProviderScimTenant. You can undelete a scim + tenant for 30 days. After 30 days, deletion is permanent. You cannot + update deleted scim tenants. However, you can view and list them. + operationId: iam.locations.workforcePools.providers.scimTenants.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6625,7 +8987,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/WorkforcePoolProviderScimTenant' parameters: - in: path name: locationsId @@ -6642,54 +9004,24 @@ paths: required: true schema: type: string - /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}:undelete: + - in: path + name: scimTenantsId + required: true + schema: + type: string + /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants/{scimTenantsId}:undelete: parameters: *ref_1 post: description: >- - Undeletes a WorkforcePoolProvider, as long as it was deleted fewer than - 30 days ago. - operationId: iam.locations.workforcePools.providers.undelete + Undeletes a WorkforcePoolProviderScimTenant, as long as it was deleted + fewer than 30 days ago. + operationId: iam.locations.workforcePools.providers.scimTenants.undelete requestBody: content: application/json: schema: - $ref: '#/components/schemas/UndeleteWorkforcePoolProviderRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: workforcePoolsId - required: true - schema: - type: string - - in: path - name: providersId - required: true - schema: - type: string - /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/operations/{operationsId}: - parameters: *ref_1 - get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: iam.locations.workforcePools.providers.operations.get + $ref: >- + #/components/schemas/UndeleteWorkforcePoolProviderScimTenantRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6701,7 +9033,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/WorkforcePoolProviderScimTenant' parameters: - in: path name: locationsId @@ -6719,18 +9051,18 @@ paths: schema: type: string - in: path - name: operationsId + name: scimTenantsId required: true schema: type: string - /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/keys: + /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants/{scimTenantsId}/tokens: parameters: *ref_1 get: description: >- - Lists all non-deleted WorkforcePoolProviderKeys in a - WorkforcePoolProvider. If `show_deleted` is set to `true`, then deleted - keys are also listed. - operationId: iam.locations.workforcePools.providers.keys.list + Lists all non-deleted WorkforcePoolProviderScimTokenss in a + WorkforcePoolProviderScimTenant. If `show_deleted` is set to `true`, + then deleted SCIM tokens are also listed. + operationId: iam.locations.workforcePools.providers.scimTenants.tokens.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6742,7 +9074,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListWorkforcePoolProviderKeysResponse' + $ref: >- + #/components/schemas/ListWorkforcePoolProviderScimTokensResponse parameters: - in: path name: locationsId @@ -6759,6 +9092,11 @@ paths: required: true schema: type: string + - in: path + name: scimTenantsId + required: true + schema: + type: string - in: query name: pageSize schema: @@ -6773,13 +9111,16 @@ paths: schema: type: boolean post: - description: Creates a new WorkforcePoolProviderKey in a WorkforcePoolProvider. - operationId: iam.locations.workforcePools.providers.keys.create + description: >- + Creates a new WorkforcePoolProviderScimToken in a + WorkforcePoolProviderScimTenant. You cannot reuse the name of a deleted + SCIM token until 30 days after deletion. + operationId: iam.locations.workforcePools.providers.scimTenants.tokens.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/WorkforcePoolProviderKey' + $ref: '#/components/schemas/WorkforcePoolProviderScimToken' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6791,7 +9132,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/WorkforcePoolProviderScimToken' parameters: - in: path name: locationsId @@ -6808,15 +9149,20 @@ paths: required: true schema: type: string + - in: path + name: scimTenantsId + required: true + schema: + type: string - in: query - name: workforcePoolProviderKeyId + name: workforcePoolProviderScimTokenId schema: type: string - /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/keys/{keysId}: + /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants/{scimTenantsId}/tokens/{tokensId}: parameters: *ref_1 get: - description: Gets a WorkforcePoolProviderKey. - operationId: iam.locations.workforcePools.providers.keys.get + description: Gets an individual WorkforcePoolProviderScimToken. + operationId: iam.locations.workforcePools.providers.scimTenants.tokens.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6828,7 +9174,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/WorkforcePoolProviderKey' + $ref: '#/components/schemas/WorkforcePoolProviderScimToken' parameters: - in: path name: locationsId @@ -6846,15 +9192,23 @@ paths: schema: type: string - in: path - name: keysId + name: scimTenantsId required: true schema: type: string - delete: - description: >- - Deletes a WorkforcePoolProviderKey. You can undelete a key for 30 days. - After 30 days, deletion is permanent. - operationId: iam.locations.workforcePools.providers.keys.delete + - in: path + name: tokensId + required: true + schema: + type: string + patch: + description: Updates an existing WorkforcePoolProviderScimToken. + operationId: iam.locations.workforcePools.providers.scimTenants.tokens.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WorkforcePoolProviderScimToken' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6866,7 +9220,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/WorkforcePoolProviderScimToken' parameters: - in: path name: locationsId @@ -6884,22 +9238,26 @@ paths: schema: type: string - in: path - name: keysId + name: scimTenantsId required: true schema: type: string - /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/keys/{keysId}:undelete: - parameters: *ref_1 - post: + - in: path + name: tokensId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: description: >- - Undeletes a WorkforcePoolProviderKey, as long as it was deleted fewer - than 30 days ago. - operationId: iam.locations.workforcePools.providers.keys.undelete - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/UndeleteWorkforcePoolProviderKeyRequest' + Deletes a WorkforcePoolProviderScimToken. You can undelete a scim token + for 30 days. After 30 days, deletion is permanent. You cannot update + deleted scim tokens. However, you can view and list them. + operationId: iam.locations.workforcePools.providers.scimTenants.tokens.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6911,7 +9269,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/WorkforcePoolProviderScimToken' parameters: - in: path name: locationsId @@ -6929,18 +9287,28 @@ paths: schema: type: string - in: path - name: keysId + name: scimTenantsId required: true schema: type: string - /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/keys/{keysId}/operations/{operationsId}: + - in: path + name: tokensId + required: true + schema: + type: string + /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants/{scimTenantsId}/tokens/{tokensId}:undelete: parameters: *ref_1 - get: + post: description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: iam.locations.workforcePools.providers.keys.operations.get + Undeletes a WorkforcePoolProviderScimToken, as long as it was deleted + fewer than 30 days ago. + operationId: iam.locations.workforcePools.providers.scimTenants.tokens.undelete + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/UndeleteWorkforcePoolProviderScimTokenRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6952,7 +9320,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/WorkforcePoolProviderScimToken' parameters: - in: path name: locationsId @@ -6970,12 +9338,12 @@ paths: schema: type: string - in: path - name: keysId + name: scimTenantsId required: true schema: type: string - in: path - name: operationsId + name: tokensId required: true schema: type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/iamcredentials.yaml b/providers/src/googleapis.com/v00.00.00000/services/iamcredentials.yaml index 08d251e6..cbb4b88a 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/iamcredentials.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/iamcredentials.yaml @@ -10,8 +10,8 @@ info: Disabling this API also disables the IAM API (iam.googleapis.com). However, enabling this API doesn't enable the IAM API. version: v1 - x-discovery-doc-revision: '20241024' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250717' + x-generated-date: '2025-08-28' externalDocs: url: >- https://cloud.google.com/iam/docs/creating-short-lived-service-account-credentials @@ -124,12 +124,29 @@ components: Include the service account email in the token. If set to `true`, the token will contain `email` and `email_verified` claims. type: boolean + organizationNumberIncluded: + description: >- + Include the organization number of the service account in the token. + If set to `true`, the token will contain a + `google.organization_number` claim. The value of the claim will be + `null` if the service account isn't associated with an organization. + type: boolean GenerateIdTokenResponse: id: GenerateIdTokenResponse type: object properties: token: - description: The OpenId Connect ID token. + description: >- + The OpenId Connect ID token. The token is a JSON Web Token (JWT) + that contains a payload with claims. See the [JSON Web Token + spec](https://tools.ietf.org/html/rfc7519) for more information. + Here is an example of a decoded JWT payload: ``` { "iss": + "https://accounts.google.com", "iat": 1496953245, "exp": 1496953245, + "aud": "https://www.example.com", "sub": "107517467455664443765", + "azp": "107517467455664443765", "email": + "my-iam-account@my-project.iam.gserviceaccount.com", + "email_verified": true, "google": { "organization_number": 123456 } + } ``` type: string SignBlobRequest: id: SignBlobRequest @@ -250,6 +267,40 @@ components: description: Output only. The hex encoded bitmap of the trust boundary locations readOnly: true type: string + WorkloadIdentityPoolAllowedLocations: + id: WorkloadIdentityPoolAllowedLocations + description: Represents a list of allowed locations for given workload identity pool. + type: object + properties: + locations: + description: >- + Output only. The human readable trust boundary locations. For + example, ["us-central1", "europe-west1"] + readOnly: true + type: array + items: + type: string + encodedLocations: + description: Output only. The hex encoded bitmap of the trust boundary locations + readOnly: true + type: string + WorkforcePoolAllowedLocations: + id: WorkforcePoolAllowedLocations + description: Represents a list of allowed locations for given workforce pool. + type: object + properties: + locations: + description: >- + Output only. The human readable trust boundary locations. For + example, ["us-central1", "europe-west1"] + readOnly: true + type: array + items: + type: string + encodedLocations: + description: Output only. The hex encoded bitmap of the trust boundary locations + readOnly: true + type: string parameters: access_token: description: OAuth access token. @@ -370,22 +421,22 @@ components: update: [] replace: [] delete: [] - service_accounts_allowed_locations: - id: google.iamcredentials.service_accounts_allowed_locations - name: service_accounts_allowed_locations - title: Service_accounts_allowed_locations + allowed_locations: + id: google.iamcredentials.allowed_locations + name: allowed_locations + title: Allowed_locations methods: get_allowed_locations: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}~1allowedLocations/get + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1allowedLocations/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/service_accounts_allowed_locations/methods/get_allowed_locations + #/components/x-stackQL-resources/allowed_locations/methods/get_allowed_locations insert: [] update: [] replace: [] @@ -558,3 +609,57 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/allowedLocations: + parameters: *ref_1 + get: + description: Returns the trust boundary info for a given workload identity pool. + operationId: >- + iamcredentials.projects.locations.workloadIdentityPools.getAllowedLocations + security: [] + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/WorkloadIdentityPoolAllowedLocations' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workloadIdentityPoolsId + required: true + schema: + type: string + /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/allowedLocations: + parameters: *ref_1 + get: + description: Returns the trust boundary info for a given workforce pool. + operationId: iamcredentials.locations.workforcePools.getAllowedLocations + security: [] + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/WorkforcePoolAllowedLocations' + parameters: + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workforcePoolsId + required: true + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/iamv2.yaml b/providers/src/googleapis.com/v00.00.00000/services/iamv2.yaml index d814d1f2..85bfefb4 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/iamv2.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/iamv2.yaml @@ -12,8 +12,8 @@ info: Account Credentials API (iamcredentials.googleapis.com). However, disabling this API doesn't disable the IAM Service Account Credentials API. version: v2 - x-discovery-doc-revision: '20241028' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250825' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/iam/ servers: @@ -227,61 +227,7 @@ components: type: object properties: deniedPrincipals: - description: >- - The identities that are prevented from using one or more permissions - on Google Cloud resources. This field can contain the following - values: * `principal://goog/subject/{email_id}`: A specific Google - Account. Includes Gmail, Cloud Identity, and Google Workspace user - accounts. For example, `principal://goog/subject/alice@example.com`. - * - `principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}`: - A Google Cloud service account. For example, - `principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com`. - * `principalSet://goog/group/{group_id}`: A Google group. For - example, `principalSet://goog/group/admins@example.com`. * - `principalSet://goog/public:all`: A special identifier that - represents any principal that is on the internet, even if they do - not have a Google Account or are not logged in. * - `principalSet://goog/cloudIdentityCustomerId/{customer_id}`: All of - the principals associated with the specified Google Workspace or - Cloud Identity customer ID. For example, - `principalSet://goog/cloudIdentityCustomerId/C01Abc35`. * - `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workforce identity pool. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: - All workforce identities in a group. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All workforce identities with a specific attribute value. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: - All identities in a workforce identity pool. * - `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workload identity pool. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: - A workload identity pool group. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All identities in a workload identity pool with a certain attribute. - * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: - All identities in a workload identity pool. * - `deleted:principal://goog/subject/{email_id}?uid={uid}`: A specific - Google Account that was deleted recently. For example, - `deleted:principal://goog/subject/alice@example.com?uid=1234567890`. - If the Google Account is recovered, this identifier reverts to the - standard identifier for a Google Account. * - `deleted:principalSet://goog/group/{group_id}?uid={uid}`: A Google - group that was deleted recently. For example, - `deleted:principalSet://goog/group/admins@example.com?uid=1234567890`. - If the Google group is restored, this identifier reverts to the - standard identifier for a Google group. * - `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}?uid={uid}`: - A Google Cloud service account that was deleted recently. For - example, - `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com?uid=1234567890`. - If the service account is undeleted, this identifier reverts to the - standard identifier for a service account. * - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - Deleted single identity in a workforce identity pool. For example, - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + description: ' The identities that are prevented from using one or more permissions on Google Cloud resources. This field can contain the following values: * `principal://goog/subject/{email_id}`: A specific Google Account. Includes Gmail, Cloud Identity, and Google Workspace user accounts. For example, `principal://goog/subject/alice@example.com`. * `principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}`: A Google Cloud service account. For example, `principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com`. * `principalSet://goog/group/{group_id}`: A Google group. For example, `principalSet://goog/group/admins@example.com`. * `principalSet://goog/public:all`: A special identifier that represents any principal that is on the internet, even if they do not have a Google Account or are not logged in. * `principalSet://goog/cloudIdentityCustomerId/{customer_id}`: All of the principals associated with the specified Google Workspace or Cloud Identity customer ID. For example, `principalSet://goog/cloudIdentityCustomerId/C01Abc35`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number}/type/ServiceAccount`: All service accounts grouped under a resource (project, folder, or organization). * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number}/type/ServiceAgent`: All service agents grouped under a resource (project, folder, or organization). * `deleted:principal://goog/subject/{email_id}?uid={uid}`: A specific Google Account that was deleted recently. For example, `deleted:principal://goog/subject/alice@example.com?uid=1234567890`. If the Google Account is recovered, this identifier reverts to the standard identifier for a Google Account. * `deleted:principalSet://goog/group/{group_id}?uid={uid}`: A Google group that was deleted recently. For example, `deleted:principalSet://goog/group/admins@example.com?uid=1234567890`. If the Google group is restored, this identifier reverts to the standard identifier for a Google group. * `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}?uid={uid}`: A Google Cloud service account that was deleted recently. For example, `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com?uid=1234567890`. If the service account is undeleted, this identifier reverts to the standard identifier for a service account. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.' type: array items: type: string @@ -495,8 +441,8 @@ components: description: >- Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully - have Operation.error value with a google.rpc.Status.code of 1, - corresponding to `Code.CANCELLED`. + have google.longrunning.Operation.error value with a + google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. readOnly: true type: boolean apiVersion: diff --git a/providers/src/googleapis.com/v00.00.00000/services/iamv2beta.yaml b/providers/src/googleapis.com/v00.00.00000/services/iamv2beta.yaml index 8d277727..0a6a76c0 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/iamv2beta.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/iamv2beta.yaml @@ -12,8 +12,8 @@ info: Account Credentials API (iamcredentials.googleapis.com). However, disabling this API doesn't disable the IAM Service Account Credentials API. version: v2beta - x-discovery-doc-revision: '20241028' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250815' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/iam/ servers: @@ -227,61 +227,7 @@ components: type: object properties: deniedPrincipals: - description: >- - The identities that are prevented from using one or more permissions - on Google Cloud resources. This field can contain the following - values: * `principal://goog/subject/{email_id}`: A specific Google - Account. Includes Gmail, Cloud Identity, and Google Workspace user - accounts. For example, `principal://goog/subject/alice@example.com`. - * - `principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}`: - A Google Cloud service account. For example, - `principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com`. - * `principalSet://goog/group/{group_id}`: A Google group. For - example, `principalSet://goog/group/admins@example.com`. * - `principalSet://goog/public:all`: A special identifier that - represents any principal that is on the internet, even if they do - not have a Google Account or are not logged in. * - `principalSet://goog/cloudIdentityCustomerId/{customer_id}`: All of - the principals associated with the specified Google Workspace or - Cloud Identity customer ID. For example, - `principalSet://goog/cloudIdentityCustomerId/C01Abc35`. * - `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workforce identity pool. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: - All workforce identities in a group. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All workforce identities with a specific attribute value. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: - All identities in a workforce identity pool. * - `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workload identity pool. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: - A workload identity pool group. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All identities in a workload identity pool with a certain attribute. - * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: - All identities in a workload identity pool. * - `deleted:principal://goog/subject/{email_id}?uid={uid}`: A specific - Google Account that was deleted recently. For example, - `deleted:principal://goog/subject/alice@example.com?uid=1234567890`. - If the Google Account is recovered, this identifier reverts to the - standard identifier for a Google Account. * - `deleted:principalSet://goog/group/{group_id}?uid={uid}`: A Google - group that was deleted recently. For example, - `deleted:principalSet://goog/group/admins@example.com?uid=1234567890`. - If the Google group is restored, this identifier reverts to the - standard identifier for a Google group. * - `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}?uid={uid}`: - A Google Cloud service account that was deleted recently. For - example, - `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com?uid=1234567890`. - If the service account is undeleted, this identifier reverts to the - standard identifier for a service account. * - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - Deleted single identity in a workforce identity pool. For example, - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + description: ' The identities that are prevented from using one or more permissions on Google Cloud resources. This field can contain the following values: * `principal://goog/subject/{email_id}`: A specific Google Account. Includes Gmail, Cloud Identity, and Google Workspace user accounts. For example, `principal://goog/subject/alice@example.com`. * `principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}`: A Google Cloud service account. For example, `principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com`. * `principalSet://goog/group/{group_id}`: A Google group. For example, `principalSet://goog/group/admins@example.com`. * `principalSet://goog/public:all`: A special identifier that represents any principal that is on the internet, even if they do not have a Google Account or are not logged in. * `principalSet://goog/cloudIdentityCustomerId/{customer_id}`: All of the principals associated with the specified Google Workspace or Cloud Identity customer ID. For example, `principalSet://goog/cloudIdentityCustomerId/C01Abc35`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number}/type/ServiceAccount`: All service accounts grouped under a resource (project, folder, or organization). * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number}/type/ServiceAgent`: All service agents grouped under a resource (project, folder, or organization). * `deleted:principal://goog/subject/{email_id}?uid={uid}`: A specific Google Account that was deleted recently. For example, `deleted:principal://goog/subject/alice@example.com?uid=1234567890`. If the Google Account is recovered, this identifier reverts to the standard identifier for a Google Account. * `deleted:principalSet://goog/group/{group_id}?uid={uid}`: A Google group that was deleted recently. For example, `deleted:principalSet://goog/group/admins@example.com?uid=1234567890`. If the Google group is restored, this identifier reverts to the standard identifier for a Google group. * `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}?uid={uid}`: A Google Cloud service account that was deleted recently. For example, `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com?uid=1234567890`. If the service account is undeleted, this identifier reverts to the standard identifier for a service account. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.' type: array items: type: string @@ -495,8 +441,8 @@ components: description: >- Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully - have Operation.error value with a google.rpc.Status.code of 1, - corresponding to `Code.CANCELLED`. + have google.longrunning.Operation.error value with a + google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. readOnly: true type: boolean apiVersion: @@ -773,10 +719,10 @@ components: - '1' - '2' x-stackQL-resources: - policies_policies: - id: google.iamv2beta.policies_policies - name: policies_policies - title: Policies_policies + policies: + id: google.iamv2beta.policies + name: policies + title: Policies methods: list_policies: operation: @@ -785,38 +731,12 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.policies - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/policies_policies/methods/list_policies - insert: [] - update: [] - replace: [] - delete: [] - policies_policy: - id: google.iamv2beta.policies_policy - name: policies_policy - title: Policies_policy - methods: create_policy: operation: $ref: '#/paths/~1v2beta~1policies~1{policiesId}~1{policiesId1}/post' response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: >- - #/components/x-stackQL-resources/policies_policy/methods/create_policy - update: [] - replace: [] - delete: [] - policies: - id: google.iamv2beta.policies - name: policies - title: Policies - methods: get: operation: $ref: >- @@ -841,7 +761,9 @@ components: sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/policies/methods/get' - insert: [] + - $ref: '#/components/x-stackQL-resources/policies/methods/list_policies' + insert: + - $ref: '#/components/x-stackQL-resources/policies/methods/create_policy' update: [] replace: - $ref: '#/components/x-stackQL-resources/policies/methods/update' diff --git a/providers/src/googleapis.com/v00.00.00000/services/iap.yaml b/providers/src/googleapis.com/v00.00.00000/services/iap.yaml index f8faf810..f460603f 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/iap.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/iap.yaml @@ -7,8 +7,8 @@ info: title: Cloud Identity-Aware Proxy API description: Controls access to cloud applications running on Google Cloud Platform. version: v1 - x-discovery-doc-revision: '20241028' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250802' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/iap servers: @@ -389,17 +389,19 @@ components: - WORKFORCE_IDENTITY_FEDERATION GcipSettings: id: GcipSettings - description: Allows customers to configure tenant_id for GCIP instance per-app. + description: >- + Allows customers to configure tenant IDs for a Cloud Identity Platform + (GCIP) instance for each application. type: object properties: tenantIds: description: >- - Optional. GCIP tenant ids that are linked to the IAP resource. - tenant_ids could be a string beginning with a number character to - indicate authenticating with GCIP tenant flow, or in the format of _ - to indicate authenticating with GCIP agent flow. If agent flow is - used, tenant_ids should only contain one single element, while for - tenant flow, tenant_ids can contain multiple elements. + Optional. GCIP tenant IDs that are linked to the IAP resource. + `tenant_ids` could be a string beginning with a number character to + indicate authenticating with GCIP tenant flow, or in the format of + `_` to indicate authenticating with GCIP agent flow. If agent flow + is used, `tenant_ids` should only contain one single element, while + for tenant flow, `tenant_ids` can contain multiple elements. type: array items: type: string @@ -413,13 +415,14 @@ components: id: CorsSettings description: >- Allows customers to configure HTTP request paths that'll allow HTTP - OPTIONS call to bypass authentication and authorization. + `OPTIONS` call to bypass authentication and authorization. type: object properties: allowHttpOptions: description: >- - Configuration to allow HTTP OPTIONS calls to skip authorization. If - undefined, IAP will not apply any special logic to OPTIONS requests. + Configuration to allow HTTP `OPTIONS` calls to skip authentication + and authorization. If undefined, IAP will not apply any special + logic to `OPTIONS` requests. type: boolean OAuthSettings: id: OAuthSettings @@ -541,14 +544,12 @@ components: can omit this field. Services integrated with custom org policy must populate this field for all requests where the API call changes the state of the resource. Custom org policy backend uses these - attributes to enforce custom org policies. When a proto is wrapped, - it is generally the One Platform API proto. When a JSON string is - wrapped, use `google.protobuf.StringValue` for the inner value. For - create operations, GCP service is expected to pass resource from - customer request as is. For update/patch operations, GCP service is - expected to compute the next state with the patch provided by the - user. See go/custom-constraints-org-policy-integration-guide for - additional details. + attributes to enforce custom org policies. For create operations, + GCP service is expected to pass resource from customer request as + is. For update/patch operations, GCP service is expected to compute + the next state with the patch provided by the user. See + go/federated-custom-org-policy-integration-guide for additional + details. type: object additionalProperties: type: any @@ -564,6 +565,20 @@ components: formats to be passed in. IMPORTANT: If tags are unchanged, this field should not be set. $ref: '#/components/schemas/NextStateOfTags' + locations: + description: >- + The locations of the resource. This field is used to determine + whether the request is compliant with Trust Boundaries. Usage: - If + unset or empty, the location of authorization is used as the target + location. - For global resources: use a single value of "global". - + For regional/multi-regional resources: use name of the GCP region(s) + where the resource exists (e.g., ["us-east1", "us-west1"]). For + multi-regional resources specify the name of each GCP region in the + resource's multi-region. NOTE: Only GCP cloud region names are + supported - go/cloud-region-names. + type: array + items: + type: string NextStateOfTags: id: NextStateOfTags description: >- @@ -1112,10 +1127,10 @@ components: - $ref: >- #/components/x-stackQL-resources/iap_iam_policies/methods/set_iam_policy delete: [] - iap_iap_settings: - id: google.iap.iap_iap_settings - name: iap_iap_settings - title: Iap_iap_settings + iap_settings: + id: google.iap.iap_settings + name: iap_settings + title: Iap_settings methods: get_iap_settings: operation: @@ -1132,11 +1147,11 @@ components: sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/iap_iap_settings/methods/get_iap_settings + #/components/x-stackQL-resources/iap_settings/methods/get_iap_settings insert: [] update: - $ref: >- - #/components/x-stackQL-resources/iap_iap_settings/methods/update_iap_settings + #/components/x-stackQL-resources/iap_settings/methods/update_iap_settings replace: [] delete: [] iap: diff --git a/providers/src/googleapis.com/v00.00.00000/services/identitytoolkit.yaml b/providers/src/googleapis.com/v00.00.00000/services/identitytoolkit.yaml index 1962f4b3..476fe283 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/identitytoolkit.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/identitytoolkit.yaml @@ -8,7 +8,7 @@ info: description: Help the third party sites to implement federated login. version: v3 x-discovery-doc-revision: '20180723' - x-generated-date: '2024-11-06' + x-generated-date: '2025-08-28' externalDocs: url: https://developers.google.com/identity-toolkit/v3/ servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/ids.yaml b/providers/src/googleapis.com/v00.00.00000/services/ids.yaml index 05edc083..6e5e6944 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/ids.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/ids.yaml @@ -12,8 +12,8 @@ info: When you use this product, your organization name and consumption levels will be shared with Palo Alto Networks. version: v1 - x-discovery-doc-revision: '20240815' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250729' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/ servers: @@ -313,338 +313,6 @@ components: additionalProperties: type: any description: Properties of the object. Contains field @type with type URL. - SetIamPolicyRequest: - id: SetIamPolicyRequest - description: Request message for `SetIamPolicy` method. - type: object - properties: - policy: - description: >- - REQUIRED: The complete policy to be applied to the `resource`. The - size of the policy is limited to a few 10s of KB. An empty policy is - a valid policy but certain Google Cloud services (such as Projects) - might reject them. - $ref: '#/components/schemas/Policy' - updateMask: - description: >- - OPTIONAL: A FieldMask specifying which fields of the policy to - modify. Only the fields in the mask will be modified. If no mask is - provided, the following default mask is used: `paths: "bindings, - etag"` - type: string - format: google-fieldmask - Policy: - id: Policy - description: >- - An Identity and Access Management (IAM) policy, which specifies access - controls for Google Cloud resources. A `Policy` is a collection of - `bindings`. A `binding` binds one or more `members`, or principals, to a - single `role`. Principals can be user accounts, service accounts, Google - groups, and domains (such as G Suite). A `role` is a named list of - permissions; each `role` can be an IAM predefined role or a user-created - custom role. For some types of Google Cloud resources, a `binding` can - also specify a `condition`, which is a logical expression that allows - access to a resource only if the expression evaluates to `true`. A - condition can add constraints based on attributes of the request, the - resource, or both. To learn which resources support conditions in their - IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - **JSON example:** ``` { "bindings": [ { "role": - "roles/resourcemanager.organizationAdmin", "members": [ - "user:mike@example.com", "group:admins@example.com", - "domain:google.com", - "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { - "role": "roles/resourcemanager.organizationViewer", "members": [ - "user:eve@example.com" ], "condition": { "title": "expirable access", - "description": "Does not grant access after Sep 2020", "expression": - "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": - "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - - members: - user:mike@example.com - group:admins@example.com - - domain:google.com - - serviceAccount:my-project-id@appspot.gserviceaccount.com role: - roles/resourcemanager.organizationAdmin - members: - - user:eve@example.com role: roles/resourcemanager.organizationViewer - condition: title: expirable access description: Does not grant access - after Sep 2020 expression: request.time < - timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` - For a description of IAM and its features, see the [IAM - documentation](https://cloud.google.com/iam/docs/). - type: object - properties: - 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). - type: integer - format: int32 - bindings: - description: >- - Associates a list of `members`, or principals, with a `role`. - Optionally, may specify a `condition` that determines how and when - the `bindings` are applied. Each of the `bindings` must contain at - least one principal. The `bindings` in a `Policy` can refer to up to - 1,500 principals; up to 250 of these principals can be Google - groups. Each occurrence of a principal counts towards these limits. - For example, if the `bindings` grant 50 different roles to - `user:alice@example.com`, and not to any other principal, then you - can add another 1,450 principals to the `bindings` in the `Policy`. - type: array - items: - $ref: '#/components/schemas/Binding' - auditConfigs: - description: Specifies cloud audit logging configuration for this policy. - type: array - items: - $ref: '#/components/schemas/AuditConfig' - 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. - type: string - format: byte - Binding: - id: Binding - description: Associates `members`, or principals, with a `role`. - type: object - properties: - role: - description: >- - Role that is assigned to the list of `members`, or principals. For - example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an - overview of the IAM roles and permissions, see the [IAM - documentation](https://cloud.google.com/iam/docs/roles-overview). - For a list of the available pre-defined roles, see - [here](https://cloud.google.com/iam/docs/understanding-roles). - type: string - members: - description: >- - Specifies the principals requesting access for a Google Cloud - 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. Does not include identities - that come from external identity providers (IdPs) through identity - federation. * `user:{emailid}`: An email address that represents a - specific Google account. For example, `alice@example.com` . * - `serviceAccount:{emailid}`: An email address that represents a - Google service account. For example, - `my-other-app@appspot.gserviceaccount.com`. * - `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: - An identifier for a [Kubernetes service - account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). - For example, - `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * - `group:{emailid}`: An email address that represents a Google group. - For example, `admins@example.com`. * `domain:{domain}`: The G Suite - domain (primary) that represents all the users of that domain. For - example, `google.com` or `example.com`. * - `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workforce identity pool. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: - All workforce identities in a group. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All workforce identities with a specific attribute value. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: - All identities in a workforce identity pool. * - `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workload identity pool. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: - A workload identity pool group. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All identities in a workload identity pool with a certain attribute. - * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: - All identities in a workload identity pool. * - `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. * - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - Deleted single identity in a workforce identity pool. For example, - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. - type: array - items: - type: string - condition: - description: >- - The condition that is associated with this binding. If the condition - evaluates to `true`, then this binding applies to the current - request. If the condition evaluates to `false`, then this binding - does not apply to the current request. However, a different role - binding might grant the same role to one or more of the principals - in this binding. To learn which resources support conditions in - their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - $ref: '#/components/schemas/Expr' - Expr: - id: 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. - type: object - properties: - expression: - description: >- - Textual representation of an expression in Common Expression - Language syntax. - 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 - 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 - 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 - AuditConfig: - id: 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. - type: object - properties: - 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 - auditLogConfigs: - description: The configuration for logging of each type of permission. - type: array - items: - $ref: '#/components/schemas/AuditLogConfig' - AuditLogConfig: - id: 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. - type: object - properties: - logType: - description: The log type that this config enables. - type: string - enumDescriptions: - - Default case. Should never be this. - - 'Admin reads. Example: CloudIAM getIamPolicy' - - 'Data writes. Example: CloudSQL Users create' - - 'Data reads. Example: CloudSQL Users list' - enum: - - LOG_TYPE_UNSPECIFIED - - ADMIN_READ - - DATA_WRITE - - DATA_READ - exemptedMembers: - description: >- - Specifies the identities that do not cause logging for this type of - permission. Follows the same format of Binding.members. - type: array - items: - type: string - TestIamPermissionsRequest: - id: TestIamPermissionsRequest - description: Request message for `TestIamPermissions` method. - type: object - properties: - permissions: - description: >- - The set of permissions to check for the `resource`. Permissions with - wildcards (such as `*` or `storage.*`) are not allowed. For more - information see [IAM - Overview](https://cloud.google.com/iam/docs/overview#permissions). - type: array - items: - type: string - TestIamPermissionsResponse: - id: TestIamPermissionsResponse - description: Response message for `TestIamPermissions` method. - type: object - properties: - permissions: - description: >- - A subset of `TestPermissionsRequest.permissions` that the caller is - allowed. - type: array - items: - type: string OperationMetadata: id: OperationMetadata description: Represents the metadata of the long-running operation. @@ -678,8 +346,8 @@ components: description: >- Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled - have Operation.error value with a google.rpc.Status.code of 1, - corresponding to `Code.CANCELLED`. + have google.longrunning.Operation.error value with a + google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. readOnly: true type: boolean apiVersion: @@ -888,43 +556,6 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/endpoints/methods/delete' - endpoints_iam_policies: - id: google.ids.endpoints_iam_policies - name: endpoints_iam_policies - title: Endpoints_iam_policies - methods: - set_iam_policy: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:setIamPolicy/post - response: - mediaType: application/json - openAPIDocKey: '200' - get_iam_policy: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:getIamPolicy/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.bindings - test_iam_permissions: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:testIamPermissions/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/endpoints_iam_policies/methods/get_iam_policy - insert: [] - update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/endpoints_iam_policies/methods/set_iam_policy - delete: [] paths: /v1/projects/{projectsId}/locations: parameters: &ref_1 @@ -973,6 +604,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: @@ -1127,7 +762,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: ids.projects.locations.operations.cancel requestBody: content: @@ -1359,127 +994,3 @@ paths: name: requestId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:setIamPolicy: - parameters: *ref_1 - post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - `PERMISSION_DENIED` errors. - operationId: ids.projects.locations.endpoints.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SetIamPolicyRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Policy' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: endpointsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:getIamPolicy: - parameters: *ref_1 - get: - description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: ids.projects.locations.endpoints.getIamPolicy - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Policy' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: endpointsId - required: true - schema: - type: string - - in: query - name: options.requestedPolicyVersion - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:testIamPermissions: - parameters: *ref_1 - post: - description: >- - Returns permissions that a caller has on the specified resource. If the - resource does not exist, this will return an empty set of permissions, - not a `NOT_FOUND` error. Note: This operation is designed to be used for - building permission-aware UIs and command-line tools, not for - authorization checking. This operation may "fail open" without warning. - operationId: ids.projects.locations.endpoints.testIamPermissions - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TestIamPermissionsRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/TestIamPermissionsResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: endpointsId - required: true - schema: - type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/integrations.yaml b/providers/src/googleapis.com/v00.00.00000/services/integrations.yaml index d96bd8b2..f458ed30 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/integrations.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/integrations.yaml @@ -7,8 +7,8 @@ info: title: Application Integration API description: '' version: v1 - x-discovery-doc-revision: '20241028' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250825' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/application-integration servers: @@ -34,750 +34,489 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudConnectorsV1HPAConfig: + GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectRequest: + id: GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectRequest + description: Request for LinkAppsScriptProject rpc call. type: object properties: - memoryUtilizationThreshold: - format: int64 - description: >- - Output only. Percent Memory utilization where HPA triggers - autoscaling. - type: string - readOnly: true - cpuUtilizationThreshold: - readOnly: true - format: int64 - description: Output only. Percent CPU utilization where HPA triggers autoscaling. + scriptId: + description: The id of the Apps Script project to be linked. type: string - id: GoogleCloudConnectorsV1HPAConfig - description: Autoscaling config for connector deployment system metrics. - EnterpriseCrmEventbusProtoTaskUiModuleConfig: - description: Task author would use this type to configure a config module. + GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectResponse: + id: GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectResponse + description: Response for LinkAppsScriptProject rpc call. type: object properties: - moduleId: - description: ID of the config module. - enumDescriptions: - - Default - - Supports editing label of a task config. - - Supports editing error handling settings such as retry strategy. - - >- - Supports adding, removing and editing task parameter values in a - table with little assistance or restriction. - - >- - Supports editing values of declared input parameters of a task. - Think of it as a "strongly typed" upgrade to the TASK_PARAM_TABLE. - - Supports editing preconditions of a task config. - - >- - Supports adding, editing, and deleting the scripts associated with - a script task, as well as modifying the input/output parameters. - - >- - Supports editing task parameters associated with an RPC/stubby - task. - - >- - Contains readonly task information, including input/output type - info. - - Configures a SuspensionTask. - - Configures a GenericStubbyTypedTask. - - Configures a SubWorkflowExecutorTask. - - Supports navigating to Apps Script editor - - Configures a SubWorkflowForEachLoopTask. - - Configures a FieldMappingTask. - - Contains embedded in-product documentation for a task. - - UI widget for the rest caller task. - - Configures a SubWorkflowScatterGatherTask. - - Configures a CloudSql Task. - - Configure a GenericConnectorTask. + scriptId: + description: The id of the linked Apps Script project. type: string - enum: - - UNSPECIFIED_TASK_MODULE - - LABEL - - ERROR_HANDLING - - TASK_PARAM_TABLE - - TASK_PARAM_FORM - - PRECONDITION - - SCRIPT_EDITOR - - RPC - - TASK_SUMMARY - - SUSPENSION - - RPC_TYPED - - SUB_WORKFLOW - - APPS_SCRIPT_NAVIGATOR - - SUB_WORKFLOW_FOR_EACH_LOOP - - FIELD_MAPPING - - README - - REST_CALLER - - SUB_WORKFLOW_SCATTER_GATHER - - CLOUD_SQL - - GENERIC_CONNECTOR_TASK - id: EnterpriseCrmEventbusProtoTaskUiModuleConfig - GoogleCloudIntegrationsV1alphaTemplateComponent: + GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectRequest: + id: GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectRequest + description: Request for CreateAppsScriptProject rpc call. type: object - id: GoogleCloudIntegrationsV1alphaTemplateComponent properties: - name: - description: Optional. Name of the component. + appsScriptProject: + description: The name of the Apps Script project to be created. type: string - type: - enumDescriptions: - - Component type is unspecified - - Trigger component - - Task component - - Connector component + authConfigId: + description: >- + The auth config id necessary to fetch the necessary credentials to + create the project for external clients type: string - description: Optional. Type of the component. - enum: - - TYPE_UNSPECIFIED - - TRIGGER - - TASK - - CONNECTOR - description: Define the components that are present in a template. - GoogleCloudIntegrationsV1alphaListIntegrationsResponse: + GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectResponse: + id: GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectResponse + description: Response for CreateAppsScriptProject rpc call. type: object properties: - nextPageToken: + projectId: + description: The created AppsScriptProject ID. type: string - description: The next page token for the response. - integrations: - description: The integrations which match the request. - type: array - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaIntegration' - description: Response for ListIntegrations. - id: GoogleCloudIntegrationsV1alphaListIntegrationsResponse - GoogleCloudIntegrationsV1alphaAttemptStats: - description: Status for the execution attempt. + GoogleCloudIntegrationsV1alphaProvisionClientRequest: + id: GoogleCloudIntegrationsV1alphaProvisionClientRequest + description: Request for the Provision rpc type: object properties: - endTime: - description: The end time of the integration execution for current attempt. - type: string - format: google-datetime - startTime: - type: string + cloudKmsConfig: description: >- - The start time of the integration execution for current attempt. - This could be in the future if it's been scheduled. - format: google-datetime - id: GoogleCloudIntegrationsV1alphaAttemptStats - GoogleCloudConnectorsV1AuthConfigOauth2JwtBearer: - type: object - description: >- - Parameters to support JSON Web Token (JWT) Profile for Oauth 2.0 - Authorization Grant based authentication. See - https://tools.ietf.org/html/rfc7523 for more details. - properties: - jwtClaims: - $ref: >- - #/components/schemas/GoogleCloudConnectorsV1AuthConfigOauth2JwtBearerJwtClaims - description: JwtClaims providers fields to generate the token. - clientKey: + Optional. OPTIONAL: Cloud KMS config for AuthModule to + encrypt/decrypt credentials. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCloudKmsConfig' + createSampleWorkflows: description: >- - Secret version reference containing a PKCS#8 PEM-encoded private key - associated with the Client Certificate. This private key will be - used to sign JWTs used for the jwt-bearer authorization grant. - Specified in the form as: `projects/*/secrets/*/versions/*`. - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' - id: GoogleCloudConnectorsV1AuthConfigOauth2JwtBearer - GoogleCloudIntegrationsV1alphaTakeoverEditLockRequest: - properties: {} - type: object - id: GoogleCloudIntegrationsV1alphaTakeoverEditLockRequest - description: Request for TakeoverEditLock. - GoogleCloudConnectorsV1ResourceLimits: - type: object - id: GoogleCloudConnectorsV1ResourceLimits - description: Resource limits defined for connection pods of a given connector type. - properties: - memory: - description: Output only. Memory limit. - type: string - readOnly: true - cpu: - type: string - readOnly: true - description: Output only. CPU limit. - EnterpriseCrmEventbusProtoConditionResult: - id: EnterpriseCrmEventbusProtoConditionResult - properties: - result: + Optional. Indicates if sample workflow should be created along with + provisioning + type: boolean + provisionGmek: description: >- - the result comes out after evaluate the combined condition. True if - there's no combined condition specified. + Optional. Deprecated. Indicates provision with GMEK or CMEK. This + field is deprecated and the provision would always be GMEK if + cloud_kms_config is not present in the request. + deprecated: true type: boolean - currentTaskNumber: - type: string - description: the current task number. - nextTaskNumber: - type: string - description: the next task number. - description: Contains the combined condition calculation results. - type: object - EnterpriseCrmFrontendsEventbusProtoTriggerConfig: - type: object - id: EnterpriseCrmFrontendsEventbusProtoTriggerConfig - properties: - triggerName: + runAsServiceAccount: description: >- - Optional. Name of the trigger This is added to identify the type of - trigger. This is avoid the logic on triggerId to identify the - trigger_type and push the same to monitoring. + Optional. User input run-as service account, if empty, will bring up + a new default service account type: string - properties: - type: object + skipCpProvision: + description: Optional. Indicates if skip CP provision or not + type: boolean + enableHttpCall: description: >- - Configurable properties of the trigger, not to be confused with - workflow parameters. E.g. "name" is a property for API triggers and - "subscription" is a property for Cloud Pubsub triggers. - additionalProperties: - type: string - pauseWorkflowExecutions: + Optional. Indicates if the client should be allowed to make HTTP + calls. + type: boolean + enableManagedAiFeatures: description: >- - Optional. If set to true, any upcoming requests for this trigger - config will be paused and the executions will be resumed later when - the flag is reset. The workflow to which this trigger config belongs - has to be in ACTIVE status for the executions to be paused or - resumed. + Optional. Indicates if the client should be allowed to use managed + AI features, i.e. using Cloud Companion APIs of the tenant project. + This will allow the customers to use features like Troubleshooting, + OpenAPI spec enrichment, etc. for free. type: boolean - description: + GoogleCloudIntegrationsV1alphaCloudKmsConfig: + id: GoogleCloudIntegrationsV1alphaCloudKmsConfig + description: Configuration information for Client's Cloud KMS information + type: object + properties: + kmsLocation: + description: Required. Location name of the key ring, e.g. "us-west1". type: string + kmsRing: description: >- - User-provided description intended to give more business context - about the task. - errorCatcherId: + Required. A key ring organizes keys in a specific Google Cloud + location and allows you to manage access control on groups of keys. + A key ring's name does not need to be unique across a Google Cloud + project, but must be unique within a given location. type: string + key: description: >- - Optional Error catcher id of the error catch flow which will be - executed when execution error happens in the task - position: - description: >- - Optional. Informs the front-end application where to draw this - trigger config on the UI. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCoordinate' - enabledClients: + Required. A Cloud KMS key is a named object containing one or more + key versions, along with metadata for the key. A key exists on + exactly one key ring tied to a specific location. + type: string + keyVersion: description: >- - Required. The list of client ids which are enabled to execute the - workflow using this trigger. In other words, these clients have the - workflow execution privledges for this trigger. For API trigger, the - client id in the incoming request is validated against the list of - enabled clients. For non-API triggers, one workflow execution is - triggered on behalf of each enabled client. + Optional. Each version of a key contains key material used for + encryption or signing. A key's version is represented by an integer, + starting at 1. To decrypt data or verify a signature, you must use + the same key version that was used to encrypt or sign the data. + type: string + kmsProjectId: + description: >- + Optional. The gcp project id of the project where the kms key + stored. If empty, the kms key is stored at the same project as + customer's project and ecrypted with CMEK, otherwise, the kms key is + stored in the tenant project and encrypted with GMEK + type: string + GoogleProtobufEmpty: + id: GoogleProtobufEmpty + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + type: object + properties: {} + GoogleCloudIntegrationsV1alphaProvisionClientPostProcessorRequest: + id: GoogleCloudIntegrationsV1alphaProvisionClientPostProcessorRequest + description: Request for PostProvisioning rpc call. + type: object + properties: + workflows: + description: Optional. Indicate which workflows to create type: array items: type: string - outputVariables: - description: Optional. List of output variables for the api trigger. - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoTriggerConfigVariables - cloudSchedulerConfig: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCloudSchedulerConfig' - triggerNumber: + enumDescriptions: + - Default value, should not be used. + - Ecom processing workflow + - Connector tool workflow + enum: + - SAMPLE_INTEGRATIONS_UNSPECIFIED + - SAMPLE_WORKFLOW_ECOM_PROCESSING + - EXECUTE_CONNECTOR_TOOL_WORKFLOW + GoogleCloudIntegrationsV1alphaProvisionClientPostProcessorResponse: + id: GoogleCloudIntegrationsV1alphaProvisionClientPostProcessorResponse + description: Response for PostProvisioning rpc call. + type: object + properties: {} + GoogleCloudIntegrationsV1alphaDeprovisionClientRequest: + id: GoogleCloudIntegrationsV1alphaDeprovisionClientRequest + description: Request for the Deprovision rpc + type: object + properties: {} + GoogleCloudIntegrationsV1alphaGetClientResponse: + id: GoogleCloudIntegrationsV1alphaGetClientResponse + description: Response for the GetClient rpc + type: object + properties: + client: + description: 'Required. Required: The client configuration that was requested' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaClientConfig' + GoogleCloudIntegrationsV1alphaClientConfig: + id: GoogleCloudIntegrationsV1alphaClientConfig + description: The configuration information for the Client + type: object + properties: + id: + description: Globally unique ID (project_id + region) type: string - description: >- - Required. A number to uniquely identify each trigger config within - the workflow on UI. - inputVariables: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoTriggerConfigVariables - description: Optional. List of input variables for the api trigger. - nextTasksExecutionPolicy: - enumDescriptions: - - Default - - Execute all the tasks that satisfy their associated condition. - - Execute the first task that satisfies the associated condition. - enum: - - UNSPECIFIED - - RUN_ALL_MATCH - - RUN_FIRST_MATCH - description: Dictates how next tasks will be executed. + projectId: + description: The GCP project id of the client associated with type: string - triggerId: + description: + description: Description of what the client is used for type: string - description: The backend trigger ID. - triggerType: + region: + description: The region the client is linked to. + type: string + cloudKmsConfig: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCloudKmsConfig' + createTime: + description: The timestamp when the client was first created. + type: string + format: google-datetime + p4ServiceAccount: + description: The service agent associated with this client + type: string + billingType: + description: Indicates the billing type of the client + type: string + enumDescriptions: + - Unspecified billing type + - A trial org provisioned through Apigee Provisioning Wizard + - Subscription based users of Apigee + - Consumption based users of IP enum: - - UNKNOWN - - CLOUD_PUBSUB - - GOOPS - - SFDC_SYNC - - CRON - - API - - MANIFOLD_TRIGGER - - DATALAYER_DATA_CHANGE - - SFDC_CHANNEL - - CLOUD_PUBSUB_EXTERNAL - - SFDC_CDC_CHANNEL - - SFDC_PLATFORM_EVENTS_CHANNEL - - CLOUD_SCHEDULER - - INTEGRATION_CONNECTOR_TRIGGER - - PRIVATE_TRIGGER + - BILLING_TYPE_UNSPECIFIED + - BILLING_TYPE_APIGEE_TRIALS + - BILLING_TYPE_APIGEE_SUBSCRIPTION + - BILLING_TYPE_PAYG + clientState: + description: Indicates the activity state the client + type: string enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' + - The client state is unspecified + - The client is active and able to make calls to the IP APIs + - The client is disabled and will soon be deleted + enum: + - CLIENT_STATE_UNSPECIFIED + - CLIENT_STATE_ACTIVE + - CLIENT_STATE_DISABLED + runAsServiceAccount: type: string - triggerCriteria: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTriggerCriteria' + enableVariableMasking: + description: 'Optional. ' + type: boolean + isGmek: + description: Optional. Indicates the client is provisioned with CMEK or GMEK. + type: boolean + enableInternalIp: description: >- - Optional. When set, Eventbus will run the task specified in the - trigger_criteria and validate the result using the - trigger_criteria.condition, and only execute the workflow when - result is true. - label: + Optional. Indicates the client enables internal IP feature, this is + applicable for internal clients only. + type: boolean + enableHttpCall: + description: 'Optional. ' + type: boolean + enableManagedAiFeatures: + description: 'Optional. ' + type: boolean + customerConfig: + description: Optional. Customer configuration information for the given client. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCustomerConfig' + GoogleCloudIntegrationsV1alphaCustomerConfig: + id: GoogleCloudIntegrationsV1alphaCustomerConfig + description: Customer configuration information for the given client + type: object + properties: + enableManagedAiFeatures: + description: >- + Optional. Indicates if the client should be allowed to use managed + AI features, i.e. using Cloud Companion APIs of the tenant project. + This will allow the customers to use features like Troubleshooting, + OpenAPI spec enrichment, etc. for free. + type: boolean + runAsServiceAccount: + description: >- + Optional. Run-as service account to be updated for the provisioned + client. type: string - description: The user created label for a particular trigger. - startTasks: + enableVariableMasking: description: >- - Set of tasks numbers from where the workflow execution is started by - this trigger. If this is empty, then workflow is executed with - default start tasks. In the list of start tasks, none of two tasks - can have direct ancestor-descendant relationships (i.e. in a same - workflow execution graph). - type: array - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoNextTask' - alertConfig: + Optional. True if variable masking feature should be turned on for + this region. + type: boolean + enableHttpCall: description: >- - An alert threshold configuration for the [trigger + client + - workflow] tuple. If these values are not specified in the trigger - config, default values will be populated by the system. Note that - there must be exactly one alert threshold configured per [client + - trigger + workflow] when published. - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoWorkflowAlertConfig' - type: array - description: 'Configuration detail of a trigger. Next available id: 22' - EnterpriseCrmEventbusProtoExecutionTraceInfo: + Optional. Indicates if the client should be allowed to make HTTP + calls. True if http call feature should be turned on for this + region. + type: boolean + cloudKmsConfig: + description: >- + Optional. Cloud KMS config for Auth Module to encrypt/decrypt + credentials. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCloudKmsConfig' + GoogleCloudIntegrationsV1alphaChangeCustomerConfigRequest: + id: GoogleCloudIntegrationsV1alphaChangeCustomerConfigRequest + description: Request for the ChangeCustomerConfig rpc type: object properties: - traceId: - description: Used to aggregate ExecutionTraceInfo. - type: string - parentEventExecutionInfoId: + updateMask: description: >- - Parent event execution info id that triggers the current execution - through SubWorkflowExecutorTask. + Required. Field mask specifying the fields in the customer config + that have been modified and must be updated. If absent or empty, no + fields are updated. type: string - description: >- - Message that helps aggregate all sub-executions triggered by one - execution and keeps track of child-parent relationships. - id: EnterpriseCrmEventbusProtoExecutionTraceInfo - EnterpriseCrmFrontendsEventbusProtoStringParameterArray: - properties: - stringValues: - type: array - items: - type: string + format: google-fieldmask + customerConfig: + description: Optional. The customer configuration to be updated. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCustomerConfig' + GoogleCloudIntegrationsV1alphaChangeCustomerConfigResponse: + id: GoogleCloudIntegrationsV1alphaChangeCustomerConfigResponse + description: Response for the ChangeCustomerConfig rpc type: object - id: EnterpriseCrmFrontendsEventbusProtoStringParameterArray - GoogleCloudIntegrationsV1alphaLiftSuspensionResponse: properties: - eventExecutionInfoId: - type: string - description: Execution Id that will be returned - description: Response of lift Suspense + customerConfig: + description: Required. The updated customer configuration. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCustomerConfig' + GoogleCloudIntegrationsV1alphaGetClientMetadataResponse: + id: GoogleCloudIntegrationsV1alphaGetClientMetadataResponse + description: Response for the GetClientMetadata rpc type: object - id: GoogleCloudIntegrationsV1alphaLiftSuspensionResponse - GoogleCloudConnectorsV1ConnectionStatus: - id: GoogleCloudConnectorsV1ConnectionStatus - description: ConnectionStatus indicates the state of the connection. + properties: + properties: + description: 'Required. Required: The client configuration that was requested' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaProjectProperties' + GoogleCloudIntegrationsV1alphaProjectProperties: + id: GoogleCloudIntegrationsV1alphaProjectProperties + description: Metadata information for the given project type: object properties: - description: - description: Description. - type: string - state: - description: State. + ipEnablementState: + description: An enum value of what the enablement state is for the given project type: string enumDescriptions: - - Connection does not have a state yet. - - Connection is being created. - - Connection is running and ready for requests. - - Connection is stopped. - - Connection is being deleted. - - Connection is being updated. - - Connection is not running due to an error. - - >- - Connection is not running because the authorization configuration - is not complete. + - The client enablement status is unspecified + - The client is enabled on Standalone IP + - The client is enabled on Apigee + - The client is entitled for Apigee but not enabled enum: - - STATE_UNSPECIFIED - - CREATING - - ACTIVE - - INACTIVE - - DELETING - - UPDATING - - ERROR - - AUTHORIZATION_REQUIRED - status: - description: Status provides detailed information for the state. - type: string - EnterpriseCrmEventbusProtoBaseFunction: - id: EnterpriseCrmEventbusProtoBaseFunction - type: object - properties: - functionName: - enum: - - UNSPECIFIED - - NOW_IN_MILLIS - - INT_LIST - - ENVIRONMENT - - GET_EXECUTION_ID - - GET_INTEGRATION_NAME - - GET_REGION - - GET_UUID - - GET_PROJECT_ID + - IP_ENABLEMENT_STATE_UNSPECIFIED + - IP_ENABLEMENT_STATE_STANDALONE + - IP_ENABLEMENT_STATE_APIGEE + - IP_ENABLEMENT_STATE_APIGEE_ENTITLED + provisionedRegions: + description: A list of provisioned regions on the current project + type: array + items: + type: string + billingType: + description: 'Required. Required: The client billing type that was requested' type: string enumDescriptions: - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - EnterpriseCrmEventbusProtoMappedField: - description: Mapped field is a pair of input field and output field. - id: EnterpriseCrmEventbusProtoMappedField - properties: - outputField: - description: The output field being mapped to. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoField' - inputField: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoField' - description: The input field being mapped from. + - A trial org provisioned through Apigee Provisioning Wizard + - >- + Subscription based on concurrency model for Apigee and Application + Integration users. + - Consumption based users of IP + - >- + Argentum subscription for Application Integration users. To be + used in the future. + - >- + Special billing type to avoid any billing to clients (eg: trusted + tester program). This should not be used without consulting with + the leads. + enum: + - BILLING_TYPE_UNSPECIFIED + - APIGEE_TRIALS + - APIGEE_SUBSCRIPTION + - PAYG + - SUBSCRIPTION + - NO_BILLING + GoogleCloudIntegrationsV1alphaSwitchEncryptionRequest: + id: GoogleCloudIntegrationsV1alphaSwitchEncryptionRequest + description: Request for the SwitchEncryption rpc type: object - GoogleCloudIntegrationsV1alphaUploadTemplateResponse: - description: Response for UploadTemplate. - id: GoogleCloudIntegrationsV1alphaUploadTemplateResponse properties: - template: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' - description: The uploaded Template + cloudKmsConfig: + description: >- + Required. REQUIRED: Cloud KMS config for AuthModule to + encrypt/decrypt credentials. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCloudKmsConfig' + GoogleCloudIntegrationsV1alphaReplaceServiceAccountRequest: + id: GoogleCloudIntegrationsV1alphaReplaceServiceAccountRequest + description: Request for the ReplaceServiceAccount rpc type: object - EnterpriseCrmEventbusProtoBooleanArrayFunction: - id: EnterpriseCrmEventbusProtoBooleanArrayFunction properties: - functionName: + runAsServiceAccount: + description: 'Required. REQUIRED: Run-as service account to be updated' type: string - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - enum: - - UNSPECIFIED - - GET - - APPEND - - SIZE - - TO_SET - - APPEND_ALL - - TO_JSON - - SET - - REMOVE - - REMOVE_AT - - CONTAINS - - FOR_EACH - - FILTER - type: object - GoogleCloudConnectorsV1EventingRuntimeData: + GoogleCloudIntegrationsV1alphaSwitchVariableMaskingRequest: + id: GoogleCloudIntegrationsV1alphaSwitchVariableMaskingRequest + description: Request to enable/disable variable masking for a provisioned client type: object - id: GoogleCloudConnectorsV1EventingRuntimeData - description: >- - Eventing runtime data has the details related to eventing managed by the - system. properties: - eventsListenerPscSa: - description: >- - Output only. Events listener PSC Service attachment. The value will - be populated after provisioning the events listener with private - connectivity enabled. - readOnly: true - type: string - status: - $ref: '#/components/schemas/GoogleCloudConnectorsV1EventingStatus' - description: Output only. Current status of eventing. - readOnly: true - webhookData: - $ref: >- - #/components/schemas/GoogleCloudConnectorsV1EventingRuntimeDataWebhookData - readOnly: true - description: Output only. Webhook data. - webhookSubscriptions: - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudConnectorsV1EventingRuntimeDataWebhookSubscriptions - description: Output only. Webhook subscriptions. - eventsListenerEndpoint: - readOnly: true + enableVariableMasking: description: >- - Output only. Events listener endpoint. The value will populated - after provisioning the events listener. - type: string - GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest: + Required. REQUIRED: True if variable masking feature should be + turned on for this region + type: boolean + GoogleCloudIntegrationsV1alphaToggleHttpRequest: + id: GoogleCloudIntegrationsV1alphaToggleHttpRequest + description: Request to enable/disable http call for a provisioned client type: object - description: 'The request for scheduling an integration. Next available id: 11' properties: - userGeneratedExecutionId: - type: string + enableHttpCall: description: >- - Optional. This is a unique id provided by the method caller. If - provided this will be used as the execution_id when a new execution - info is created. This is a string representation of a UUID. Must - have no more than 36 characters and contain only alphanumeric - characters and hyphens. - requestId: + Required. REQUIRED: True if http call feature should be turned on + for this region + type: boolean + GoogleCloudIntegrationsV1alphaCreateCloudFunctionRequest: + id: GoogleCloudIntegrationsV1alphaCreateCloudFunctionRequest + description: Request for Creating Cloud Function rpc call. + type: object + properties: + projectId: description: >- - This is used to de-dup incoming request: if the duplicate request - was detected, the response from the previous execution is returned. + Indicates the id of the GCP project that the function will be + created in. type: string - inputParameters: - description: Optional. Input parameters used by integration execution. - type: object - additionalProperties: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' - parameters: - description: Passed in as parameters to each integration execution. - deprecated: true - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' - parameterEntries: - description: >- - Parameters are a part of Event and can be used to communicate - between different tasks that are part of the same integration - execution. - type: array - deprecated: true - items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry - scheduleTime: - format: google-datetime - description: >- - The time that the integration should be executed. If the time is - less or equal to the current time, the integration is executed - immediately. + functionName: + description: The function name of CF to be created type: string - triggerId: + functionRegion: + description: The function region of CF to be created type: string - description: >- - Required. Matched against all {@link TriggerConfig}s across all - integrations. i.e. TriggerConfig.trigger_id.equals(trigger_id) - id: GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest - GoogleCloudIntegrationsV1alphaConditionalFailurePolicies: + gcfApiVersion: + description: Optional. The api version of CF to be created + type: string + enumDescriptions: + - Unspecified. + - V1 API version. + - V2 API version. + enum: + - GCF_API_VERSION_UNSPECIFIED + - API_VERSION_V1 + - API_VERSION_V2 + GoogleCloudIntegrationsV1alphaCreateCloudFunctionResponse: + id: GoogleCloudIntegrationsV1alphaCreateCloudFunctionResponse + description: Response for Creating Cloud Function rpc call. type: object - id: GoogleCloudIntegrationsV1alphaConditionalFailurePolicies - description: Conditional task failur retry strategies properties: - failurePolicies: - description: >- - The list of failure policies that will be applied to the task in - order. - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaFailurePolicy' - type: array - defaultFailurePolicy: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaFailurePolicy' - description: >- - The default failure policy to be applied if no conditional failure - policy matches. - EnterpriseCrmEventbusProtoParameterMapEntry: + triggerUrl: + description: The trigger url that will be returned + type: string + GoogleCloudIntegrationsV1alphaListCertificatesResponse: + id: GoogleCloudIntegrationsV1alphaListCertificatesResponse + description: Response to list Certificates. type: object properties: - value: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterMapField' - key: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterMapField' - id: EnterpriseCrmEventbusProtoParameterMapEntry - description: Entry is a pair of key and value. - GoogleCloudIntegrationsV1alphaTriggerConfigVariables: - properties: - names: + certificates: + description: The list of Certificates retrieved. type: array items: - type: string - description: Optional. List of variable names. - type: object - id: GoogleCloudIntegrationsV1alphaTriggerConfigVariables - description: Variables names mapped to api trigger. - GoogleCloudIntegrationsV1alphaGetClientMetadataResponse: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + nextPageToken: + description: The token used to retrieve the next page of results. + type: string + GoogleCloudIntegrationsV1alphaCertificate: + id: GoogleCloudIntegrationsV1alphaCertificate + description: The certificate definition type: object - id: GoogleCloudIntegrationsV1alphaGetClientMetadataResponse - description: Response for the GetClientMetadata rpc - properties: - properties: - description: 'Required. Required: The client configuration that was requested' - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaProjectProperties' - EnterpriseCrmFrontendsEventbusProtoParamSpecEntry: properties: - collectionElementClassName: - type: string - description: >- - If it is a collection of objects, this would be the FCQN of every - individual element in the collection. If this is "java.lang.Object", - the parameter is a collection of any type. - protoDef: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryProtoDefinition - description: Populated if this represents a proto or proto array. - defaultValue: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterValueType - description: >- - Default values for the defined keys. Each value can either be - string, int, double or any proto message or a serialized object. - isOutput: - type: boolean - required: - description: If set, the user must provide an input value for this parameter. - type: boolean - validationRule: - description: >- - Rule used to validate inputs (individual values and collection - elements) for this parameter. - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryValidationRule - className: - description: >- - The FQCN of the Java object this represents. A string, for example, - would be "java.lang.String". If this is "java.lang.Object", the - parameter can be of any type. + name: + description: Output only. Auto generated primary key + readOnly: true type: string - config: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryConfig' - description: Optional fields, such as help text and other useful info. - jsonSchema: - description: If the data_type is JSON_VALUE, then this will define its schema. + displayName: + description: Required. Name of the certificate type: string - key: + description: + description: Description of the certificate type: string + requestorId: description: >- - Key is used to retrieve the corresponding parameter value. This - should be unique for a given task. These parameters must be - predefined in the workflow definition. - dataType: + Immutable. Requestor ID to be used to register certificate with + trawler + type: string + credentialId: + description: Immutable. Credential id that will be used to register with trawler + type: string + certificateStatus: + description: Status of the certificate type: string enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - >- - BYTES and BYTES_ARRAY data types are not allowed for top-level - params. They're only meant to support protobufs with BYTES - (sub)fields. - - '' - - '' - - '' + - Unspecified certificate status + - Certificate in active state will be able to use + - Certificate in expired state needs to be updated enum: - - DATA_TYPE_UNSPECIFIED - - STRING_VALUE - - INT_VALUE - - DOUBLE_VALUE - - BOOLEAN_VALUE - - PROTO_VALUE - - SERIALIZED_OBJECT_VALUE - - STRING_ARRAY - - INT_ARRAY - - DOUBLE_ARRAY - - PROTO_ARRAY - - PROTO_ENUM - - BOOLEAN_ARRAY - - PROTO_ENUM_ARRAY - - BYTES - - BYTES_ARRAY - - NON_SERIALIZABLE_OBJECT - - JSON_VALUE - description: The data type of the parameter. - isDeprecated: - type: boolean - description: >- - If set, this entry is deprecated, so further use of this parameter - should be prohibited. - id: EnterpriseCrmFrontendsEventbusProtoParamSpecEntry - description: 'Key-value pair of EventBus task parameters. Next id: 13' - type: object - EnterpriseCrmEventbusProtoDoubleArray: - properties: - values: - items: - format: double - type: number - type: array - id: EnterpriseCrmEventbusProtoDoubleArray - type: object - EnterpriseCrmEventbusProtoTeardown: - properties: - teardownTaskConfigs: - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTeardownTaskConfig' - type: array - description: Required. - type: object - id: EnterpriseCrmEventbusProtoTeardown - GoogleCloudIntegrationsV1alphaGenerateTokenResponse: - id: GoogleCloudIntegrationsV1alphaGenerateTokenResponse - type: object - description: Returns success or error message - properties: - message: - type: string - description: The message that notifies the user if the request succeeded or not. - GoogleCloudIntegrationsV1alphaCreateCloudFunctionResponse: - description: Response for Creating Cloud Function rpc call. - properties: - triggerUrl: - description: The trigger url that will be returned + - STATE_UNSPECIFIED + - ACTIVE + - EXPIRED + validStartTime: + description: Output only. The timestamp after which certificate will be valid + readOnly: true type: string - id: GoogleCloudIntegrationsV1alphaCreateCloudFunctionResponse - type: object - GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectResponse: - properties: - scriptId: + format: google-datetime + validEndTime: + description: Output only. The timestamp after which certificate will expire + readOnly: true type: string - description: The id of the linked Apps Script project. - type: object - description: Response for LinkAppsScriptProject rpc call. - id: GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectResponse + format: google-datetime + rawCertificate: + description: >- + Input only. Raw client certificate which would be registered with + trawler + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaClientCertificate' GoogleCloudIntegrationsV1alphaClientCertificate: id: GoogleCloudIntegrationsV1alphaClientCertificate - type: object description: Contains client certificate information + type: object properties: sslCertificate: - type: string description: >- The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN @@ -795,14 +534,8 @@ components: JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE----- - passphrase: type: string - description: >- - 'passphrase' should be left unset if private key is not encrypted. - Note that 'passphrase' is not the password for web server, but an - extra layer of security to protected private key. encryptedPrivateKey: - type: string description: >- The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN @@ -820,2719 +553,1946 @@ components: JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE----- - GoogleCloudIntegrationsV1alphaUsernameAndPassword: - properties: - password: - type: string - description: Password to be used - username: - type: string - description: Username to be used - type: object - description: Username and password pair. - id: GoogleCloudIntegrationsV1alphaUsernameAndPassword - GoogleCloudIntegrationsV1alphaImportTemplateRequest: - description: Request to Import template - properties: - integration: type: string + passphrase: description: >- - Required. Name of the integration where template needs to be - imported. - subIntegrations: - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails - type: object - description: Optional. Sub Integration which would be created via templates. - integrationRegion: + 'passphrase' should be left unset if private key is not encrypted. + Note that 'passphrase' is not the password for web server, but an + extra layer of security to protected private key. type: string - description: Required. The region of the Integration to be created. + GoogleCloudIntegrationsV1alphaAuthConfig: + id: GoogleCloudIntegrationsV1alphaAuthConfig + description: The AuthConfig resource use to hold channels and connection config data. type: object - id: GoogleCloudIntegrationsV1alphaImportTemplateRequest - GoogleCloudIntegrationsV1alphaAuthToken: properties: - token: - description: The token for the auth type. + name: + description: >- + Resource name of the auth config. For more information, see Manage + authentication profiles. + projects/{project}/locations/{location}/authConfigs/{authConfig}. type: string - type: - description: Authentication type, e.g. "Basic", "Bearer", etc. + displayName: + description: Required. The name of the auth config. type: string - type: object - description: >- - The credentials to authenticate a user agent with a server that is put - in HTTP Authorization request header. - id: GoogleCloudIntegrationsV1alphaAuthToken - EnterpriseCrmEventbusProtoTaskAlertConfig: - description: >- - Message to be used to configure alerting in the {@code TaskConfig} - protos for tasks in an event. - properties: - clientId: + description: + description: Optional. A description of the auth config. type: string + encryptedCredential: description: >- - Client associated with this alert configuration. Must be a client - enabled in one of the containing workflow's triggers. - warningEnumList: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList - metricType: - enum: - - METRIC_TYPE_UNSPECIFIED - - TASK_ERROR_RATE - - TASK_WARNING_RATE - - TASK_RATE - - TASK_AVERAGE_DURATION - - TASK_PERCENTILE_DURATION - enumDescriptions: - - >- - The default value. Metric type should always be set to one of the - other non-default values, otherwise it will result in an - INVALID_ARGUMENT error. - - >- - Specifies alerting on the rate of errors (potentially for a - specific set of enum values) for the enclosing TaskConfig. - - >- - Specifies alerting on the rate of warnings (potentially for a - specific set of enum values) for the enclosing TaskConfig. - Warnings use the same enum values as errors. - - >- - Specifies alerting on the number of instances for the enclosing - TaskConfig executed in the given aggregation_period. - - >- - Specifies alerting on the average duration of execution for the - enclosing task. - - >- - Specifies alerting on the duration of a particular percentile of - task executions. E.g. If 10% or more of the task executions have - durations above 5 seconds, alert. + Auth credential encrypted by Cloud KMS. Can be decrypted as + Credential with proper KMS key. + type: string + format: byte + decryptedCredential: + description: Raw auth credentials. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCredential' + certificateId: + description: Certificate id for client certificate + type: string + credentialType: + description: Required. Credential type of the encrypted credential. type: string - thresholdType: - description: >- - The threshold type for which this alert is being configured. If - value falls below expected_min or exceeds expected_max, an alert - will be fired. enumDescriptions: - - '' + - Unspecified credential type + - Regular username/password pair. + - API key. + - OAuth 2.0 Authorization Code Grant Type. + - OAuth 2.0 Implicit Grant Type. + - OAuth 2.0 Client Credentials Grant Type. + - OAuth 2.0 Resource Owner Credentials Grant Type. + - JWT Token. + - Auth Token, e.g. bearer token. - >- - Note that this field will only trigger alerts if the workflow - specifying it runs at least once in 24 hours (which is our - in-memory retention period for monarch streams). Also note that - `aggregation_period` for this alert configuration must be less - than 24 hours. - - '' - type: string + Service Account which can be used to generate token for + authentication. + - Client Certificate only. + - Google OIDC ID Token enum: - - UNSPECIFIED_THRESHOLD_TYPE - - EXPECTED_MIN - - EXPECTED_MAX - onlyFinalAttempt: - type: boolean - description: Only count final task attempts, not retries. - errorEnumList: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList - numAggregationPeriods: - format: int32 - description: >- - For how many contiguous aggregation periods should the expected min - or max be violated for the alert to be fired. - type: integer - thresholdValue: - description: >- - The metric value, above or below which the alert should be - triggered. - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue - durationThresholdMs: - description: >- - Should be specified only for TASK_AVERAGE_DURATION and - TASK_PERCENTILE_DURATION metrics. This member should be used to - specify what duration value the metrics should exceed for the alert - to trigger. - format: int64 - type: string - playbookUrl: - description: >- - Link to a playbook for resolving the issue that triggered this - alert. - type: string - alertDisabled: - type: boolean - description: >- - Set to false by default. When set to true, the metrics are not - aggregated or pushed to Monarch for this workflow alert. - aggregationPeriod: + - CREDENTIAL_TYPE_UNSPECIFIED + - USERNAME_AND_PASSWORD + - API_KEY + - OAUTH2_AUTHORIZATION_CODE + - OAUTH2_IMPLICIT + - OAUTH2_CLIENT_CREDENTIALS + - OAUTH2_RESOURCE_OWNER_CREDENTIALS + - JWT + - AUTH_TOKEN + - SERVICE_ACCOUNT + - CLIENT_CERTIFICATE_ONLY + - OIDC_TOKEN + creatorEmail: description: >- - The period over which the metric value should be aggregated and - evaluated. Format is , where integer should be a positive integer - and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, - day, week). + The creator's email address. Generated based on the End User + Credentials/LOAS role of the user making the call. type: string - alertName: + createTime: + description: Output only. The timestamp when the auth config is created. + readOnly: true type: string + format: google-datetime + lastModifierEmail: description: >- - A name to identify this alert. This will be displayed in the alert - subject. If set, this name should be unique in within the scope of - the containing workflow. - id: EnterpriseCrmEventbusProtoTaskAlertConfig - type: object - GoogleCloudIntegrationsV1alphaNextTask: - properties: - taskConfigId: - type: string - description: ID of the next task. - description: + The last modifier's email address. Generated based on the End User + Credentials/LOAS role of the user making the call. type: string - description: >- - User-provided description intended to give additional business - context about the task. - condition: + updateTime: + description: Output only. The timestamp when the auth config is modified. + readOnly: true type: string - description: >- - Standard filter expression for this task to become an eligible next - task. - displayName: + format: google-datetime + visibility: + description: Optional. The visibility of the auth config. type: string - description: User-provided label that is attached to this edge in the UI. - taskId: + enumDescriptions: + - Visibility not specified. + - Profile visible to the creator only. + - Profile visible within the client. + enum: + - AUTH_CONFIG_VISIBILITY_UNSPECIFIED + - PRIVATE + - CLIENT_VISIBLE + state: + description: Output only. The status of the auth config. + readOnly: true type: string - description: Task number of the next task. - id: GoogleCloudIntegrationsV1alphaNextTask - description: >- - The task that is next in line to be executed, if the condition specified - evaluated to true. - type: object - GoogleCloudIntegrationsV1alphaExecutionSnapshotExecutionSnapshotMetadata: - id: GoogleCloudIntegrationsV1alphaExecutionSnapshotExecutionSnapshotMetadata - properties: - integrationName: + enumDescriptions: + - Status not specified. + - Valid Auth config. + - >- + General invalidity, if it doesn't fits in the detailed issue + below. + - Auth config soft deleted. + - Auth config expired. + - Auth config unauthorized. + - Auth config not supported. + enum: + - STATE_UNSPECIFIED + - VALID + - INVALID + - SOFT_DELETED + - EXPIRED + - UNAUTHORIZED + - UNSUPPORTED + reason: + description: Output only. The reason / details of the current status. + readOnly: true type: string + expiryNotificationDuration: description: >- - The direct integration which the event execution snapshots belongs - to - task: - description: the task name associated with this snapshot. - type: string - taskAttempt: - description: the task attempt number this snapshot belongs to. - type: integer - format: int32 - ancestorTaskNumbers: + Optional. User can define the time to receive notification after + which the auth config becomes invalid. Support up to 30 days. + Support granularity in hours. + type: array items: type: string - type: array + format: google-duration + validTime: description: >- - Ancestor task number for the task(it will only be non-empty if the - task is under 'private workflow') - taskNumber: - description: The task number associated with this snapshot. + Optional. The time until the auth config is valid. Empty or max + value is considered the auth config won't expire. type: string - executionAttempt: - type: integer - format: int32 - description: the execution attempt number this snapshot belongs to. - ancestorIterationNumbers: - items: - type: string - type: array + format: google-datetime + overrideValidTime: description: >- - Ancestor iteration number for the task(it will only be non-empty if - the task is under 'private workflow') - taskLabel: + Optional. User provided expiry time to override. For the example of + Salesforce, username/password credentials can be valid for 6 months + depending on the instance settings. type: string - description: the task label associated with this snapshot. Could be empty. + format: google-datetime + GoogleCloudIntegrationsV1alphaCredential: + id: GoogleCloudIntegrationsV1alphaCredential + description: Defines parameters for a single, canonical credential. type: object - description: Metadata of the execution snapshot. - GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse: properties: - outputParameters: - type: object - additionalProperties: - description: Properties of the object. - type: any - description: >- - OUTPUT parameters in format of Map. Where Key is the name of the - parameter. Note: Name of the system generated parameters are wrapped - by backtick(`) to distinguish them from the user defined parameters. - parameterEntries: - items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry - deprecated: true - type: array - description: >- - Parameters are a part of Event and can be used to communicate - between different tasks that are part of the same integration - execution. - eventParameters: - description: Details for the integration that were executed. - deprecated: true - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters - executionId: + credentialType: + description: Credential type associated with auth config. type: string - description: The id of the execution corresponding to this run of integration. - executionFailed: - deprecated: true - type: boolean - description: Is true if any execution in the integration failed. False otherwise. - id: GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse - description: The response for executing an integration. - type: object - EnterpriseCrmEventbusProtoTriggerCriteria: - id: EnterpriseCrmEventbusProtoTriggerCriteria + enumDescriptions: + - Unspecified credential type + - Regular username/password pair. + - API key. + - OAuth 2.0 Authorization Code Grant Type. + - OAuth 2.0 Implicit Grant Type. + - OAuth 2.0 Client Credentials Grant Type. + - OAuth 2.0 Resource Owner Credentials Grant Type. + - JWT Token. + - Auth Token, e.g. bearer token. + - >- + Service Account which can be used to generate token for + authentication. + - Client Certificate only. + - Google OIDC ID Token + enum: + - CREDENTIAL_TYPE_UNSPECIFIED + - USERNAME_AND_PASSWORD + - API_KEY + - OAUTH2_AUTHORIZATION_CODE + - OAUTH2_IMPLICIT + - OAUTH2_CLIENT_CREDENTIALS + - OAUTH2_RESOURCE_OWNER_CREDENTIALS + - JWT + - AUTH_TOKEN + - SERVICE_ACCOUNT + - CLIENT_CERTIFICATE_ONLY + - OIDC_TOKEN + usernameAndPassword: + description: Username and password credential + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaUsernameAndPassword + oauth2AuthorizationCode: + description: >- + The api_key and oauth2_implicit are not covered in v1 and will be + picked up once v1 is implemented. ApiKey api_key = 3; OAuth2 + authorization code credential + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaOAuth2AuthorizationCode + oauth2ClientCredentials: + description: OAuth2Implicit oauth2_implicit = 5; OAuth2 client credentials + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaOAuth2ClientCredentials + oauth2ResourceOwnerCredentials: + description: OAuth2 resource owner credentials + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaOAuth2ResourceOwnerCredentials + jwt: + description: JWT credential + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaJwt' + authToken: + description: Auth token credential + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthToken' + serviceAccountCredentials: + description: Service account credential + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaServiceAccountCredentials + oidcToken: + description: Google OIDC ID Token + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaOidcToken' + GoogleCloudIntegrationsV1alphaUsernameAndPassword: + id: GoogleCloudIntegrationsV1alphaUsernameAndPassword + description: Username and password pair. type: object properties: - triggerCriteriaTaskImplementationClassName: - description: >- - Optional. Implementation class name. The class should implement the - “TypedTask” interface. + username: + description: Username to be used type: string - parameters: - description: Optional. To be used in TaskConfig for the implementation class. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' - condition: + password: + description: Password to be used type: string - description: >- - Required. Standard filter expression, when true the workflow will be - executed. If there's no - trigger_criteria_task_implementation_class_name specified, the - condition will be validated directly. - GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse: + GoogleCloudIntegrationsV1alphaOAuth2AuthorizationCode: + id: GoogleCloudIntegrationsV1alphaOAuth2AuthorizationCode + description: >- + The OAuth Type where the client sends request with the client id and + requested scopes to auth endpoint. User sees a consent screen and auth + code is received at specified redirect url afterwards. The auth code is + then combined with the client id and secret and sent to the token + endpoint in exchange for the access and refresh token. The refresh token + can be used to fetch new access tokens. type: object - description: Response to list SfdcInstances. properties: - nextPageToken: + clientId: + description: The client's id. type: string - description: The token used to retrieve the next page of results. - sfdcInstances: - description: The list of SfdcInstances retrieved. - type: array - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance' - id: GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse - GoogleCloudIntegrationsV1alphaCloudSchedulerConfig: - properties: - cronTab: + clientSecret: + description: The client's secret. type: string - description: Required. The cron tab of cloud scheduler trigger. - serviceAccountEmail: + scope: + description: A space-delimited list of requested scope permissions. type: string - description: >- - Required. Service account used by Cloud Scheduler to trigger the - integration at scheduled time - errorMessage: + authEndpoint: + description: The auth url endpoint to send the auth code request to. type: string - description: >- - Optional. When the job was deleted from Pantheon UI, error_message - will be populated when Get/List integrations - location: - description: >- - Required. The location where associated cloud scheduler job will be - created + authParams: + description: The auth parameters sent along with the auth code request. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMap' + tokenEndpoint: + description: The token url endpoint to send the token request to. type: string - type: object - id: GoogleCloudIntegrationsV1alphaCloudSchedulerConfig - description: Cloud Scheduler Trigger configuration - GoogleCloudConnectorsV1LogConfig: - properties: - enabled: - type: boolean - description: >- - Enabled represents whether logging is enabled or not for a - connection. - level: - description: Optional. Log configuration level. + tokenParams: + description: The token parameters sent along with the token request. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMap' + accessToken: + description: The access token received from the token endpoint. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAccessToken' + authCode: + description: The Auth Code that is used to initially retrieve the access token. + type: string + requestType: + description: Represent how to pass parameters to fetch access token type: string - enum: - - LOG_LEVEL_UNSPECIFIED - - ERROR - - INFO - - DEBUG enumDescriptions: - - Log level unspecified. - - Only error logs are enabled. - - Info and error logs are enabled. - - Debug and high verbosity logs are enabled. - id: GoogleCloudConnectorsV1LogConfig - type: object - description: Log configuration for the connection. - EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleStringRegex: - description: Rule used to validate strings. - properties: - exclusive: - type: boolean + - Unspecified request type + - To pass all the parameters in post body. + - To pass all the parameters as a part of query parameter. + - >- + To pass client id and client secret as base 64 encoding of + client_id:client_password and rest parameters in post body. + enum: + - REQUEST_TYPE_UNSPECIFIED + - REQUEST_BODY + - QUERY_PARAMETERS + - ENCODED_HEADER + applyReauthPolicy: description: >- - Whether the regex matcher is applied exclusively (if true, matching - values will be rejected). - regex: - type: string - description: The regex applied to the input value(s). - type: object - id: EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleStringRegex - GoogleCloudIntegrationsV1alphaJwt: + Indicates if the user has opted in Google Reauth Policy. If opted + in, the refresh token will be valid for 20 hours, after which time + users must re-authenticate in order to obtain a new one. + type: boolean + GoogleCloudIntegrationsV1alphaParameterMap: + id: GoogleCloudIntegrationsV1alphaParameterMap + description: >- + A generic multi-map that holds key value pairs. They keys and values can + be of any type, unless specified. type: object - id: GoogleCloudIntegrationsV1alphaJwt properties: - jwt: - description: The token calculated by the header, payload and signature. - type: string - jwtPayload: - type: string + entries: + description: A list of parameter map entries. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaParameterMapEntry + keyType: description: >- - Contains a set of claims. The JWT specification defines seven - Registered Claim Names which are the standard fields commonly - included in tokens. Custom claims are usually also included, - depending on the purpose of the token. - secret: - description: User's pre-shared secret to sign the token. - type: string - jwtHeader: - description: Identifies which algorithm is used to generate the signature. + Option to specify key type for all entries of the map. If provided + then field types for all entries must conform to this. type: string - description: >- - Represents JSON web token(JWT), which is a compact, URL-safe means of - representing claims to be transferred between two parties, enabling the - claims to be digitally signed or integrity protected. - GoogleCloudIntegrationsV1alphaTriggerConfig: - type: object - properties: - triggerType: enumDescriptions: - - Unknown. - - Trigger by scheduled time. - - Trigger by API call. - - Trigger by Salesforce Channel. - - Trigger by Pub/Sub external. - - SFDC Channel Trigger for CDC. - - Trigger by Cloud Scheduler job. - - Trigger by Connector Event - - Trigger for private workflow - - Trigger by cloud pub/sub for internal ip - type: string - description: Optional. Type of trigger + - Unspecified. + - String. + - Integer. + - Double Number. + - Boolean. + - String Array. + - Integer Array. + - Double Number Array. + - Boolean Array. + - Json. + - Proto Value (Internal use only). + - Proto Array (Internal use only). + - // Non-serializable object (Internal use only). + - Proto Enum (Internal use only). + - Serialized object (Internal use only). + - Proto Enum Array (Internal use only). + - >- + BYTES data types are not allowed for top-level params. They're + only meant to support protobufs with BYTES (sub)fields. + - >- + BYTES_ARRAY data types are not allowed for top-level params. + They're only meant to support protobufs with BYTES (sub)fields. enum: - - TRIGGER_TYPE_UNSPECIFIED - - CRON - - API - - SFDC_CHANNEL - - CLOUD_PUBSUB_EXTERNAL - - SFDC_CDC_CHANNEL - - CLOUD_SCHEDULER - - INTEGRATION_CONNECTOR_TRIGGER - - PRIVATE_TRIGGER - - CLOUD_PUBSUB - triggerNumber: + - INTEGRATION_PARAMETER_DATA_TYPE_UNSPECIFIED + - STRING_VALUE + - INT_VALUE + - DOUBLE_VALUE + - BOOLEAN_VALUE + - STRING_ARRAY + - INT_ARRAY + - DOUBLE_ARRAY + - BOOLEAN_ARRAY + - JSON_VALUE + - PROTO_VALUE + - PROTO_ARRAY + - NON_SERIALIZABLE_OBJECT + - PROTO_ENUM + - SERIALIZED_OBJECT_VALUE + - PROTO_ENUM_ARRAY + - BYTES + - BYTES_ARRAY + valueType: description: >- - Required. A number to uniquely identify each trigger config within - the integration on UI. + Option to specify value type for all entries of the map. If provided + then field types for all entries must conform to this. type: string - description: + enumDescriptions: + - Unspecified. + - String. + - Integer. + - Double Number. + - Boolean. + - String Array. + - Integer Array. + - Double Number Array. + - Boolean Array. + - Json. + - Proto Value (Internal use only). + - Proto Array (Internal use only). + - // Non-serializable object (Internal use only). + - Proto Enum (Internal use only). + - Serialized object (Internal use only). + - Proto Enum Array (Internal use only). + - >- + BYTES data types are not allowed for top-level params. They're + only meant to support protobufs with BYTES (sub)fields. + - >- + BYTES_ARRAY data types are not allowed for top-level params. + They're only meant to support protobufs with BYTES (sub)fields. + enum: + - INTEGRATION_PARAMETER_DATA_TYPE_UNSPECIFIED + - STRING_VALUE + - INT_VALUE + - DOUBLE_VALUE + - BOOLEAN_VALUE + - STRING_ARRAY + - INT_ARRAY + - DOUBLE_ARRAY + - BOOLEAN_ARRAY + - JSON_VALUE + - PROTO_VALUE + - PROTO_ARRAY + - NON_SERIALIZABLE_OBJECT + - PROTO_ENUM + - SERIALIZED_OBJECT_VALUE + - PROTO_ENUM_ARRAY + - BYTES + - BYTES_ARRAY + GoogleCloudIntegrationsV1alphaParameterMapEntry: + id: GoogleCloudIntegrationsV1alphaParameterMapEntry + description: Entry is a pair of key and value. + type: object + properties: + key: + description: Key of the map entry. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMapField' + value: + description: Value of the map entry. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMapField' + GoogleCloudIntegrationsV1alphaParameterMapField: + id: GoogleCloudIntegrationsV1alphaParameterMapField + description: Field represents either the key or value in an entry. + type: object + properties: + referenceKey: + description: Referencing one of the Integration variables. type: string - description: >- - Optional. User-provided description intended to give additional - business context about the task. - properties: - type: object - description: >- - Optional. Configurable properties of the trigger, not to be confused - with integration parameters. E.g. "name" is a property for API - triggers and "subscription" is a property for Pub/sub triggers. - additionalProperties: - type: string - errorCatcherId: + literalValue: + description: Passing a literal value. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' + GoogleCloudIntegrationsV1alphaValueType: + id: GoogleCloudIntegrationsV1alphaValueType + description: The type of the parameter. + type: object + properties: + stringValue: + description: String. type: string - description: >- - Optional. Optional Error catcher id of the error catch flow which - will be executed when execution error happens in the task - alertConfig: - type: array - description: >- - Optional. An alert threshold configuration for the [trigger + client - + integration] tuple. If these values are not specified in the - trigger config, default values will be populated by the system. Note - that there must be exactly one alert threshold configured per - [client + trigger + integration] when published. - items: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationAlertConfig - startTasks: - description: >- - Optional. Set of tasks numbers from where the integration execution - is started by this trigger. If this is empty, then integration is - executed with default start tasks. In the list of start tasks, none - of two tasks can have direct ancestor-descendant relationships (i.e. - in a same integration execution graph). - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaNextTask' - type: array - triggerId: + intValue: + description: Integer. type: string - description: >- - Optional. Auto-generated trigger ID. The ID is based on the - properties that you define in the trigger config. For example, for - an API trigger, the trigger ID follows the format: - api_trigger/TRIGGER_NAME Where trigger config has properties with - value {"Trigger name": TRIGGER_NAME} - position: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCoordinate' - description: >- - Optional. Informs the front-end application where to draw this error - catcher config on the UI. - outputVariables: + format: int64 + doubleValue: + description: Double Number. + type: number + format: double + booleanValue: + description: Boolean. + type: boolean + stringArray: + description: String Array. $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaTriggerConfigVariables - description: Optional. List of output variables for the api trigger. - cloudSchedulerConfig: + #/components/schemas/GoogleCloudIntegrationsV1alphaStringParameterArray + intArray: + description: Integer Array. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaIntParameterArray' + doubleArray: + description: Double Number Array. $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaCloudSchedulerConfig - description: Optional. Cloud Scheduler Trigger related metadata - trigger: - type: string - description: >- - Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub - Sub Trigger" When set will be sent out to monitoring dashabord for - tracking purpose. - nextTasksExecutionPolicy: - enumDescriptions: - - Default. - - Execute all the tasks that satisfy their associated condition. - - Execute the first task that satisfies the associated condition. - description: Optional. Dictates how next tasks will be executed. - enum: - - NEXT_TASKS_EXECUTION_POLICY_UNSPECIFIED - - RUN_ALL_MATCH - - RUN_FIRST_MATCH - type: string - inputVariables: + #/components/schemas/GoogleCloudIntegrationsV1alphaDoubleParameterArray + booleanArray: + description: Boolean Array. $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaTriggerConfigVariables - description: Optional. List of input variables for the api trigger. - label: - description: Optional. The user created label for a particular trigger. + #/components/schemas/GoogleCloudIntegrationsV1alphaBooleanParameterArray + jsonValue: + description: Json. type: string - description: Configuration detail of a trigger. - id: GoogleCloudIntegrationsV1alphaTriggerConfig - EnterpriseCrmEventbusProtoEventExecutionDetails: + GoogleCloudIntegrationsV1alphaStringParameterArray: + id: GoogleCloudIntegrationsV1alphaStringParameterArray + description: This message only contains a field of string array. + type: object properties: - cancelReason: - description: >- - If the execution is manually canceled, this field will contain the - reason for cancellation. - type: string - eventExecutionSnapshotsSize: - description: Total size of all event_execution_snapshots for an execution - type: string - format: int64 - eventAttemptStats: + stringValues: + description: String array. type: array items: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats - networkAddress: - description: >- - The network address (aka. bns address) that indicates where the - event executor is running. - type: string - eventExecutionSnapshot: + type: string + GoogleCloudIntegrationsV1alphaIntParameterArray: + id: GoogleCloudIntegrationsV1alphaIntParameterArray + description: This message only contains a field of integer array. + type: object + properties: + intValues: + description: Integer array. + type: array items: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoEventExecutionSnapshot + type: string + format: int64 + GoogleCloudIntegrationsV1alphaDoubleParameterArray: + id: GoogleCloudIntegrationsV1alphaDoubleParameterArray + description: This message only contains a field of double number array. + type: object + properties: + doubleValues: + description: Double number array. type: array - ryeLockUnheldCount: - format: int32 + items: + type: number + format: double + GoogleCloudIntegrationsV1alphaBooleanParameterArray: + id: GoogleCloudIntegrationsV1alphaBooleanParameterArray + description: This message only contains a field of boolean array. + type: object + properties: + booleanValues: + description: Boolean array. + type: array + items: + type: boolean + GoogleCloudIntegrationsV1alphaAccessToken: + id: GoogleCloudIntegrationsV1alphaAccessToken + description: >- + The access token represents the authorization of a specific application + to access specific parts of a user’s data. + type: object + properties: + accessToken: description: >- - Used internally and shouldn't be exposed to users. A counter for the - cron job to record how many times this event is in in_process state - but don't have a lock consecutively/ - type: integer - nextExecutionTime: + The access token encapsulating the security identity of a process or + thread. type: string + accessTokenExpireTime: description: >- - Next scheduled execution time in case the execution status was - RETRY_ON_HOLD. - format: int64 - logFilePath: - description: The log file path (aka. cns address) for this event. + Required. The approximate time until the access token retrieved is + valid. type: string - eventExecutionState: + format: google-datetime + tokenType: + description: >- + Only support "bearer" token in v1 as bearer token is the predominant + type used with OAuth 2.0. type: string - enum: - - UNSPECIFIED - - ON_HOLD - - IN_PROCESS - - SUCCEEDED - - FAILED - - CANCELED - - RETRY_ON_HOLD - - SUSPENDED - enumDescriptions: - - '' - - >- - Event is received and waiting for the execution. This happens when - firing the event via "postToQueue" or "schedule". - - Event is under processing. - - >- - Event execution successfully finished. There's no more change - after this state. - - Event execution failed. There's no more change after this state. - - >- - Event execution canceled by user. There's no more change after - this state. - - Event execution failed and waiting for retry. - - Event execution suspended and waiting for manual intervention. - eventRetriesFromBeginningCount: - type: integer - format: int32 + refreshToken: description: >- - Indicates the number of times the execution has restarted from the - beginning. - id: EnterpriseCrmEventbusProtoEventExecutionDetails - type: object + If the access token will expire, use the refresh token to obtain + another access token. + type: string + refreshTokenExpireTime: + description: The approximate time until the refresh token retrieved is valid. + type: string + format: google-datetime + GoogleCloudIntegrationsV1alphaOAuth2ClientCredentials: + id: GoogleCloudIntegrationsV1alphaOAuth2ClientCredentials description: >- - Contains the details of the execution info of this event: this includes - the tasks execution details plus the event execution statistics. Next - available id: 12 - GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlowGoogleManaged: + For client credentials grant, the client sends a POST request with + grant_type as 'client_credentials' to the authorization server. The + authorization server will respond with a JSON object containing the + access token. type: object - id: GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlowGoogleManaged - description: >- - Parameters to support Oauth 2.0 Auth Code Grant Authentication using - Google Provided OAuth Client. See - https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. properties: - redirectUri: + clientId: + description: The client's ID. type: string - description: Optional. Redirect URI to be provided during the auth code exchange. - authCode: + clientSecret: + description: The client's secret. type: string + tokenEndpoint: description: >- - Optional. Authorization code to be exchanged for access and refresh - tokens. - scopes: - items: - type: string - description: >- - Required. Scopes the connection will request when the user performs - the auth code flow. - type: array - GoogleCloudIntegrationsV1alphaDownloadJsonPackageResponse: - properties: - files: - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaFile' - description: List containing JSON for multiple file with type information. - type: array - description: Response for DownloadJsonPackage. - type: object - id: GoogleCloudIntegrationsV1alphaDownloadJsonPackageResponse - GoogleCloudConnectorsV1EventingStatus: - type: object - id: GoogleCloudConnectorsV1EventingStatus - properties: - state: - readOnly: true + The token endpoint is used by the client to obtain an access token + by presenting its authorization grant or refresh token. type: string - enum: - - STATE_UNSPECIFIED - - ACTIVE - - ERROR - - INGRESS_ENDPOINT_REQUIRED - description: Output only. State. - enumDescriptions: - - Default state. - - Eventing is enabled and ready to receive events. - - Eventing is not active due to an error. - - Ingress endpoint required. - description: - readOnly: true + scope: + description: A space-delimited list of requested scope permissions. type: string - description: Output only. Description of error if State is set to "ERROR". - description: EventingStatus indicates the state of eventing. - GoogleCloudIntegrationsV1alphaMockConfig: - id: GoogleCloudIntegrationsV1alphaMockConfig - description: >- - The configuration for mocking of a task during test execution Next - available id: 4 - properties: - failedExecutions: - format: int64 + tokenParams: + description: Token parameters for the auth request. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMap' + accessToken: + description: Access token fetched from the authorization server. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAccessToken' + requestType: + description: Represent how to pass parameters to fetch access token type: string - description: >- - Optional. Number of times the given task should fail for failure - mock strategy - mockStrategy: - enum: - - MOCK_STRATEGY_UNSPECIFIED - - NO_MOCK_STRATEGY - - SPECIFIC_MOCK_STRATEGY - - FAILURE_MOCK_STRATEGY - - SKIP_MOCK_STRATEGY enumDescriptions: - - This should never be used to annotate a field - - Execute actual task + - Unspecified request type + - To pass all the parameters in post body. + - To pass all the parameters as a part of query parameter. - >- - Don't execute actual task, instead use the values specified by - user for output of the task - - Don't execute actual task, instead return task failure - - Don't execute actual task, instead mark it as successful - description: >- - Mockstrategy defines how the particular task should be mocked during - test execution - type: string - parameters: - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaEventParameter' - type: array - description: Optional. List of key-value pairs for specific mock strategy - type: object - GoogleCloudIntegrationsV1alphaCertificate: - description: The certificate definition - id: GoogleCloudIntegrationsV1alphaCertificate + To pass client id and client secret as base 64 encoding of + client_id:client_password and rest parameters in post body. + enum: + - REQUEST_TYPE_UNSPECIFIED + - REQUEST_BODY + - QUERY_PARAMETERS + - ENCODED_HEADER + GoogleCloudIntegrationsV1alphaOAuth2ResourceOwnerCredentials: + id: GoogleCloudIntegrationsV1alphaOAuth2ResourceOwnerCredentials + description: >- + For resource owner credentials grant, the client will ask the user for + their authorization credentials (ususally a username and password) and + send a POST request to the authorization server. The authorization + server will respond with a JSON object containing the access token. type: object properties: - description: + clientId: + description: The client's ID. type: string - description: Description of the certificate - certificateStatus: - enum: - - STATE_UNSPECIFIED - - ACTIVE - - EXPIRED - enumDescriptions: - - Unspecified certificate status - - Certificate in active state will be able to use - - Certificate in expired state needs to be updated - description: Status of the certificate + clientSecret: + description: The client's secret. type: string - validStartTime: - description: Output only. The timestamp after which certificate will be valid - format: google-datetime + username: + description: The user's username. type: string - readOnly: true - requestorId: + password: + description: The user's password. type: string + tokenEndpoint: description: >- - Immutable. Requestor ID to be used to register certificate with - trawler - credentialId: - type: string - description: Immutable. Credential id that will be used to register with trawler - name: - description: Output only. Auto generated primary key - readOnly: true + The token endpoint is used by the client to obtain an access token + by presenting its authorization grant or refresh token. type: string - validEndTime: + scope: + description: A space-delimited list of requested scope permissions. type: string - format: google-datetime - readOnly: true - description: Output only. The timestamp after which certificate will expire - displayName: - description: Required. Name of the certificate + tokenParams: + description: Token parameters for the auth request. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMap' + accessToken: + description: Access token fetched from the authorization server. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAccessToken' + requestType: + description: Represent how to pass parameters to fetch access token type: string - rawCertificate: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaClientCertificate' - description: >- - Input only. Raw client certificate which would be registered with - trawler - EnterpriseCrmEventbusProtoTaskUiConfig: - properties: - taskUiModuleConfigs: - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTaskUiModuleConfig' - description: Configurations of included config modules. - type: array - type: object + enumDescriptions: + - Unspecified request type + - To pass all the parameters in post body. + - To pass all the parameters as a part of query parameter. + - >- + To pass client id and client secret as base 64 encoding of + client_id:client_password and rest parameters in post body. + enum: + - REQUEST_TYPE_UNSPECIFIED + - REQUEST_BODY + - QUERY_PARAMETERS + - ENCODED_HEADER + GoogleCloudIntegrationsV1alphaJwt: + id: GoogleCloudIntegrationsV1alphaJwt description: >- - Task authors would use this type to configure the UI for a particular - task by specifying what UI config modules should be included to compose - the UI. Learn more about config module framework: - id: EnterpriseCrmEventbusProtoTaskUiConfig - GoogleCloudIntegrationsV1alphaParameterMapField: + Represents JSON web token(JWT), which is a compact, URL-safe means of + representing claims to be transferred between two parties, enabling the + claims to be digitally signed or integrity protected. type: object properties: - literalValue: - description: Passing a literal value. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' - referenceKey: + jwtHeader: + description: Identifies which algorithm is used to generate the signature. type: string - description: Referencing one of the Integration variables. - id: GoogleCloudIntegrationsV1alphaParameterMapField - description: Field represents either the key or value in an entry. - GoogleCloudIntegrationsV1alphaExecuteTestCaseResponse: - description: The response for executing a functional test. - properties: - assertionResults: - type: array - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAssertionResult' - description: Results of each assertions ran during execution of test case. - outputParameters: + jwtPayload: description: >- - OUTPUT parameters in format of Map. Where Key is the name of the - parameter. Note: Name of the system generated parameters are wrapped - by backtick(`) to distinguish them from the user defined parameters. - additionalProperties: - description: Properties of the object. - type: any - type: object - testExecutionState: - enum: - - STATE_UNSPECIFIED - - PASSED - - FAILED - enumDescriptions: - - Unspecified state - - Test case execution passed - - Test case execution failed - description: State of the test case execution + Contains a set of claims. The JWT specification defines seven + Registered Claim Names which are the standard fields commonly + included in tokens. Custom claims are usually also included, + depending on the purpose of the token. type: string - executionId: + secret: + description: User's pre-shared secret to sign the token. type: string - description: The id of the execution corresponding to this run of integration. - type: object - id: GoogleCloudIntegrationsV1alphaExecuteTestCaseResponse - EnterpriseCrmFrontendsEventbusProtoBooleanParameterArray: - type: object - id: EnterpriseCrmFrontendsEventbusProtoBooleanParameterArray - properties: - booleanValues: - items: - type: boolean - type: array - GoogleCloudIntegrationsV1alphaCreateCloudFunctionRequest: - id: GoogleCloudIntegrationsV1alphaCreateCloudFunctionRequest + jwt: + description: The token calculated by the header, payload and signature. + type: string + GoogleCloudIntegrationsV1alphaAuthToken: + id: GoogleCloudIntegrationsV1alphaAuthToken + description: >- + The credentials to authenticate a user agent with a server that is put + in HTTP Authorization request header. type: object properties: - functionName: + type: + description: Authentication type, e.g. "Basic", "Bearer", etc. type: string - description: The function name of CF to be created - functionRegion: + token: + description: The token for the auth type. type: string - description: The function region of CF to be created - projectId: + GoogleCloudIntegrationsV1alphaServiceAccountCredentials: + id: GoogleCloudIntegrationsV1alphaServiceAccountCredentials + description: >- + Represents the service account which can be used to generate access + token for authenticating the service call. + type: object + properties: + serviceAccount: description: >- - Indicates the id of the GCP project that the function will be - created in. + Name of the service account that has the permission to make the + request. type: string - description: Request for Creating Cloud Function rpc call. - GoogleCloudIntegrationsV1alphaTestIntegrationsResponse: - id: GoogleCloudIntegrationsV1alphaTestIntegrationsResponse + scope: + description: A space-delimited list of requested scope permissions. + type: string + GoogleCloudIntegrationsV1alphaOidcToken: + id: GoogleCloudIntegrationsV1alphaOidcToken + description: OIDC Token + type: object properties: - executionId: + serviceAccountEmail: + description: The service account email to be used as the identity for the token. type: string - description: The id of the execution corresponding to this run of integration. - parameters: - type: object + audience: description: >- - Optional. Parameters are a part of Event and can be used to - communicate between different tasks that are part of the same - integration execution. - additionalProperties: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' - eventParameters: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters - description: Details for the integration that were executed. - deprecated: true - executionFailed: - description: Is true if any execution in the integration failed. False otherwise. - type: boolean - parameterEntries: + Audience to be used when generating OIDC token. The audience claim + identifies the recipients that the JWT is intended for. + type: string + token: + description: ID token obtained for the service account + type: string + tokenExpireTime: + description: The approximate time until the token retrieved is valid. + type: string + format: google-datetime + GoogleCloudIntegrationsV1alphaListAuthConfigsResponse: + id: GoogleCloudIntegrationsV1alphaListAuthConfigsResponse + description: Response to list AuthConfigs. + type: object + properties: + authConfigs: + description: The list of AuthConfigs retrieved. type: array - description: >- - Parameters are a part of Event and can be used to communicate - between different tasks that are part of the same integration - execution. - deprecated: true items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry - type: object - description: The response for testing an integration. - EnterpriseCrmEventbusProtoProtoParameterArray: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + nextPageToken: + description: The token used to retrieve the next page of results. + type: string + GoogleCloudIntegrationsV1alphaEnumerateConnectorPlatformRegionsResponse: + id: GoogleCloudIntegrationsV1alphaEnumerateConnectorPlatformRegionsResponse + description: Response containing all provisioned regions for Connector Platform. type: object properties: - protoValues: + regions: + description: All regions where Connector Platform is provisioned. type: array items: - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - id: EnterpriseCrmEventbusProtoProtoParameterArray - EnterpriseCrmEventbusProtoEventBusProperties: - id: EnterpriseCrmEventbusProtoEventBusProperties + type: string + GoogleCloudIntegrationsV1alphaListConnectionsResponse: + id: GoogleCloudIntegrationsV1alphaListConnectionsResponse + description: Response containing Connections listed by region. + type: object properties: - properties: - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoPropertyEntry' - description: An unordered list of property entries. + connections: + description: Connections. type: array - description: >- - LINT.IfChange This message is used for storing key value pair properties - for each Event / Task in the EventBus. + items: + $ref: '#/components/schemas/GoogleCloudConnectorsV1Connection' + nextPageToken: + description: Next page token. + type: string + GoogleCloudConnectorsV1Connection: + id: GoogleCloudConnectorsV1Connection + description: Connection represents an instance of connector. type: object - EnterpriseCrmEventbusProtoDoubleFunction: properties: - functionName: - enum: - - UNSPECIFIED - - TO_JSON - - TO_STRING - - ADD - - SUBTRACT - - MULTIPLY - - DIVIDE - - EXPONENT - - ROUND - - FLOOR - - CEIL - - GREATER_THAN - - LESS_THAN - - EQUALS - - GREATER_THAN_EQUALS - - LESS_THAN_EQUALS - - MOD - type: string - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - id: EnterpriseCrmEventbusProtoDoubleFunction - type: object - GoogleCloudIntegrationsV1alphaSuspension: - description: A record representing a suspension. - properties: - integration: - description: Required. The name of the originating integration. - type: string name: - type: string - description: Resource name for suspensions suspension/{suspension_id} - audit: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSuspensionAudit' - description: Metadata pertaining to the resolution of this suspension. - eventExecutionInfoId: - type: string - description: Required. ID of the associated execution. - taskId: - type: string - description: Required. Task id of the associated SuspensionTask. - suspensionConfig: description: >- - Controls the notifications and resolver permissions for this - suspension. - deprecated: true - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoSuspensionConfig' - createTime: - format: google-datetime + Output only. Resource name of the Connection. Format: + projects/{project}/locations/{location}/connections/{connection} + readOnly: true type: string - description: Output only. Auto-generated. + createTime: + description: Output only. Created time. readOnly: true - lastModifyTime: - description: Output only. Auto-generated. type: string format: google-datetime + updateTime: + description: Output only. Updated time. readOnly: true - approvalConfig: + type: string + format: google-datetime + labels: description: >- - Controls the notifications and approval permissions for this - suspension. - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSuspensionApprovalConfig - state: + Optional. Resource labels to represent user-provided metadata. Refer + to cloud documentation on labels for more details. + https://cloud.google.com/compute/docs/labeling-resources + type: object + additionalProperties: + type: string + description: + description: Optional. Description of the resource. + type: string + connectorVersion: description: >- - Required. State of this suspension, indicating what action a - resolver has taken. + Required. Connector version on which the connection is created. The + format is: + projects/*/locations/*/providers/*/connectors/*/versions/* Only + global location is supported for ConnectorVersion resource. type: string - enumDescriptions: - - Unset state. - - The suspension has not yet been resolved. - - The resolver has rejected the suspension. - - The resolver has lifted the suspension. - enum: - - RESOLUTION_STATE_UNSPECIFIED - - PENDING - - REJECTED - - LIFTED - id: GoogleCloudIntegrationsV1alphaSuspension - type: object - EnterpriseCrmEventbusProtoSuspensionConfig: - properties: - whoMayResolve: + status: + description: Output only. Current status of the connection. + readOnly: true + $ref: '#/components/schemas/GoogleCloudConnectorsV1ConnectionStatus' + configVariables: + description: >- + Optional. Configuration for configuring the connection with an + external system. type: array items: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoSuspensionAuthPermissions - description: Identities able to resolve this suspension. - customMessage: - type: string + $ref: '#/components/schemas/GoogleCloudConnectorsV1ConfigVariable' + authConfig: description: >- - Optional information to provide recipients of the suspension in - addition to the resolution URL, typically containing relevant - parameter values from the originating workflow. - notifications: - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoNotification' + Optional. Configuration for establishing the connection's + authentication with an external system. + $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfig' + lockConfig: + description: >- + Optional. Configuration that indicates whether or not the Connection + can be edited. + $ref: '#/components/schemas/GoogleCloudConnectorsV1LockConfig' + destinationConfigs: + description: >- + Optional. Configuration of the Connector's destination. Only + accepted for Connectors that accepts user defined destination(s). type: array - suspensionExpiration: + items: + $ref: '#/components/schemas/GoogleCloudConnectorsV1DestinationConfig' + imageLocation: description: >- - Indicates the next steps when no external actions happen on the - suspension. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoSuspensionExpiration' - type: object - id: EnterpriseCrmEventbusProtoSuspensionConfig - GoogleCloudIntegrationsV1alphaDownloadTestCaseResponse: - id: GoogleCloudIntegrationsV1alphaDownloadTestCaseResponse - properties: - content: - description: String representation of the test case. + Output only. GCR location where the runtime image is stored. + formatted like: gcr.io/{bucketName}/{imageName} + readOnly: true type: string - description: Response for DownloadTestCase. - type: object - EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleIntRange: - description: Range used to validate longs and ints. - properties: - max: - description: The inclusive maximum of the acceptable range. - format: int64 + serviceAccount: + description: >- + Optional. Service account needed for runtime plane to access Google + Cloud resources. type: string - min: - format: int64 - description: The inclusive minimum of the acceptable range. + serviceDirectory: + description: >- + Output only. The name of the Service Directory service name. Used + for Private Harpoon to resolve the ILB address. e.g. + "projects/cloud-connectors-e2e-testing/locations/us-central1/namespaces/istio-system/services/istio-ingressgateway-connectors" + readOnly: true type: string - type: object - id: EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleIntRange - EnterpriseCrmEventbusProtoIntArray: - properties: - values: - type: array - items: - format: int64 - type: string - type: object - id: EnterpriseCrmEventbusProtoIntArray - EnterpriseCrmEventbusProtoStringFunction: - type: object - id: EnterpriseCrmEventbusProtoStringFunction - properties: - functionName: + envoyImageLocation: + description: >- + Output only. GCR location where the envoy image is stored. formatted + like: gcr.io/{bucketName}/{imageName} + readOnly: true + type: string + suspended: + description: >- + Optional. Suspended indicates if a user has suspended a connection + or not. + type: boolean + nodeConfig: + description: Optional. Node configuration for the connection. + $ref: '#/components/schemas/GoogleCloudConnectorsV1NodeConfig' + logConfig: + description: Optional. Log configuration for the connection. + $ref: '#/components/schemas/GoogleCloudConnectorsV1LogConfig' + sslConfig: + description: Optional. Ssl config of a connection + $ref: '#/components/schemas/GoogleCloudConnectorsV1SslConfig' + subscriptionType: + description: >- + Output only. This subscription type enum states the subscription + type of the project. + readOnly: true + type: string + enumDescriptions: + - Unspecified subscription type. + - PayG subscription. + - Paid Subscription. enum: - - UNSPECIFIED - - CONCAT - - TO_UPPERCASE - - TO_LOWERCASE - - CONTAINS - - SPLIT - - LENGTH - - EQUALS - - TO_INT - - TO_DOUBLE - - TO_BOOLEAN - - TO_BASE_64 - - TO_JSON - - EQUALS_IGNORE_CASE - - REPLACE_ALL - - SUBSTRING - - RESOLVE_TEMPLATE - - DECODE_BASE64_STRING + - SUBSCRIPTION_TYPE_UNSPECIFIED + - PAY_G + - PAID + connectionRevision: + description: >- + Output only. Connection revision. This field is only updated when + the connection is created or updated by User. + readOnly: true + type: string + format: int64 + eventingEnablementType: + description: >- + Optional. Eventing enablement type. Will be nil if eventing is not + enabled. type: string enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - GoogleCloudIntegrationsV1alphaListSuspensionsResponse: - id: GoogleCloudIntegrationsV1alphaListSuspensionsResponse - type: object - properties: - suspensions: - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSuspension' - type: array - description: >- - The suspensions for the relevant execution which the caller has - permissions to view and resolve. - nextPageToken: - description: Token to retrieve the next page of results. + - Eventing Enablement Type Unspecifeied. + - Both connection and eventing. + - Only Eventing. + enum: + - EVENTING_ENABLEMENT_TYPE_UNSPECIFIED + - EVENTING_AND_CONNECTION + - ONLY_EVENTING + eventingConfig: + description: Optional. Eventing config of a connection + $ref: '#/components/schemas/GoogleCloudConnectorsV1EventingConfig' + connectorVersionLaunchStage: + description: Output only. Flag to mark the version indicating the launch stage. + readOnly: true type: string - description: Response for Suspensions.ListSuspensions. - GoogleCloudIntegrationsV1alphaCancelExecutionResponse: - description: Response for cancelling an execution. - type: object - id: GoogleCloudIntegrationsV1alphaCancelExecutionResponse - properties: - isCanceled: + enumDescriptions: + - LAUNCH_STAGE_UNSPECIFIED. + - PREVIEW. + - GA. + - DEPRECATED. + - TEST. + - PRIVATE_PREVIEW. + enum: + - LAUNCH_STAGE_UNSPECIFIED + - PREVIEW + - GA + - DEPRECATED + - TEST + - PRIVATE_PREVIEW + eventingRuntimeData: + description: Output only. Eventing Runtime Data. + readOnly: true + $ref: '#/components/schemas/GoogleCloudConnectorsV1EventingRuntimeData' + connectorVersionInfraConfig: + description: Output only. Infra configs supported by Connector Version. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudConnectorsV1ConnectorVersionInfraConfig + isTrustedTester: + description: Output only. Is trusted tester program enabled for the project. + readOnly: true type: boolean - description: True if cancellation performed successfully. - GoogleCloudIntegrationsV1alphaParameterMap: - id: GoogleCloudIntegrationsV1alphaParameterMap - description: >- - A generic multi-map that holds key value pairs. They keys and values can - be of any type, unless specified. - type: object - properties: - keyType: + authOverrideEnabled: description: >- - Option to specify key type for all entries of the map. If provided - then field types for all entries must conform to this. + Optional. Auth override enabled for the connection. If Auth Override + is enabled, Connection allows the backend service auth to be + overridden in the entities/actions API. + type: boolean + billingConfig: + description: Output only. Billing config for the connection. + readOnly: true + $ref: '#/components/schemas/GoogleCloudConnectorsV1BillingConfig' + asyncOperationsEnabled: + description: >- + Optional. Async operations enabled for the connection. If Async + Operations is enabled, Connection allows the customers to initiate + async long running operations using the actions API. + type: boolean + host: + description: >- + Output only. The name of the Hostname of the Service Directory + service with TLS. + readOnly: true type: string - enumDescriptions: - - Unspecified. - - String. - - Integer. - - Double Number. - - Boolean. - - String Array. - - Integer Array. - - Double Number Array. - - Boolean Array. - - Json. - - Proto Value (Internal use only). - - Proto Array (Internal use only). - - // Non-serializable object (Internal use only). - - Proto Enum (Internal use only). - - Serialized object (Internal use only). - - Proto Enum Array (Internal use only). - - >- - BYTES data types are not allowed for top-level params. They're - only meant to support protobufs with BYTES (sub)fields. - - >- - BYTES_ARRAY data types are not allowed for top-level params. - They're only meant to support protobufs with BYTES (sub)fields. - enum: - - INTEGRATION_PARAMETER_DATA_TYPE_UNSPECIFIED - - STRING_VALUE - - INT_VALUE - - DOUBLE_VALUE - - BOOLEAN_VALUE - - STRING_ARRAY - - INT_ARRAY - - DOUBLE_ARRAY - - BOOLEAN_ARRAY - - JSON_VALUE - - PROTO_VALUE - - PROTO_ARRAY - - NON_SERIALIZABLE_OBJECT - - PROTO_ENUM - - SERIALIZED_OBJECT_VALUE - - PROTO_ENUM_ARRAY - - BYTES - - BYTES_ARRAY - entries: - description: A list of parameter map entries. + tlsServiceDirectory: + description: Output only. The name of the Service Directory service with TLS. + readOnly: true + type: string + euaOauthAuthConfig: + description: >- + Optional. Additional Oauth2.0 Auth config for EUA. If the connection + is configured using non-OAuth authentication but OAuth needs to be + used for EUA, this field can be populated with the OAuth config. + This should be a OAuth2AuthCodeFlow Auth type only. + $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfig' + trafficShapingConfigs: + description: Optional. Traffic shaping configuration for the connection. type: array items: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaParameterMapEntry - valueType: - type: string - enumDescriptions: - - Unspecified. - - String. - - Integer. - - Double Number. - - Boolean. - - String Array. - - Integer Array. - - Double Number Array. - - Boolean Array. - - Json. - - Proto Value (Internal use only). - - Proto Array (Internal use only). - - // Non-serializable object (Internal use only). - - Proto Enum (Internal use only). - - Serialized object (Internal use only). - - Proto Enum Array (Internal use only). - - >- - BYTES data types are not allowed for top-level params. They're - only meant to support protobufs with BYTES (sub)fields. - - >- - BYTES_ARRAY data types are not allowed for top-level params. - They're only meant to support protobufs with BYTES (sub)fields. + $ref: '#/components/schemas/GoogleCloudConnectorsV1TrafficShapingConfig' + fallbackOnAdminCredentials: description: >- - Option to specify value type for all entries of the map. If provided - then field types for all entries must conform to this. - enum: - - INTEGRATION_PARAMETER_DATA_TYPE_UNSPECIFIED - - STRING_VALUE - - INT_VALUE - - DOUBLE_VALUE - - BOOLEAN_VALUE - - STRING_ARRAY - - INT_ARRAY - - DOUBLE_ARRAY - - BOOLEAN_ARRAY - - JSON_VALUE - - PROTO_VALUE - - PROTO_ARRAY - - NON_SERIALIZABLE_OBJECT - - PROTO_ENUM - - SERIALIZED_OBJECT_VALUE - - PROTO_ENUM_ARRAY - - BYTES - - BYTES_ARRAY - EnterpriseCrmEventbusProtoField: + Optional. Fallback on admin credentials for the connection. If this + both auth_override_enabled and fallback_on_admin_credentials are set + to true, the connection will use the admin credentials if the + dynamic auth header is not present during auth override. + type: boolean + GoogleCloudConnectorsV1ConnectionStatus: + id: GoogleCloudConnectorsV1ConnectionStatus + description: ConnectionStatus indicates the state of the connection. type: object properties: - cardinality: + state: + description: State. + type: string enumDescriptions: - - For fields with unspecified cardinality. + - Connection does not have a state yet. + - Connection is being created. + - Connection is running and ready for requests. + - Connection is stopped. + - Connection is being deleted. + - Connection is being updated. + - Connection is not running due to an error. - >- - If field cardinality is set to optional, ignore errors if input - field value is null or the reference_key is not found. + Connection is not running because the authorization configuration + is not complete. enum: - - UNSPECIFIED - - OPTIONAL + - STATE_UNSPECIFIED + - CREATING + - ACTIVE + - INACTIVE + - DELETING + - UPDATING + - ERROR + - AUTHORIZATION_REQUIRED + description: + description: Description. type: string - description: >- - By default, if the cardinality is unspecified the field is - considered required while mapping. - protoDefPath: + status: + description: Status provides detailed information for the state. type: string - description: >- - Optional. The fully qualified proto name (e.g. - enterprise.crm.storage.Account). Required for output field of type - PROTO_VALUE or PROTO_ARRAY. For e.g., if input field_type is BYTES - and output field_type is PROTO_VALUE, then fully qualified proto - type url should be provided to parse the input bytes. If field_type - is *_ARRAY, then all the converted protos are of the same type. - transformExpression: - description: >- - This is the transform expression to fetch the input field value. for - e.g. $param1$.CONCAT('test'). Keep points - 1. Only input field can - have a transform expression. 2. If a transform expression is - provided, reference_key will be ignored. 3. If no value is returned - after evaluation of transform expression, default_value can be - mapped if provided. 4. The field_type should be the type of the - final object returned after the transform expression is evaluated. - Scrubs the transform expression before logging as value provided by - user so may or may not contain PII or SPII data. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTransformExpression' - defaultValue: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType' - description: >- - This holds the default values for the fields. This value is supplied - by user so may or may not contain PII or SPII data. - referenceKey: - type: string - description: >- - This holds the reference key of the workflow or task parameter. 1. - Any workflow parameter, for e.g. $workflowParam1$. 2. Any task input - or output parameter, for e.g. $task1_param1$. 3. Any workflow or - task parameters with subfield references, for e.g., - $task1_param1.employee.id$ - fieldType: - enum: - - DATA_TYPE_UNSPECIFIED - - STRING_VALUE - - INT_VALUE - - DOUBLE_VALUE - - BOOLEAN_VALUE - - PROTO_VALUE - - SERIALIZED_OBJECT_VALUE - - STRING_ARRAY - - INT_ARRAY - - DOUBLE_ARRAY - - PROTO_ARRAY - - PROTO_ENUM - - BOOLEAN_ARRAY - - PROTO_ENUM_ARRAY - - BYTES - - BYTES_ARRAY - - NON_SERIALIZABLE_OBJECT - - JSON_VALUE - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - >- - BYTES and BYTES_ARRAY data types are not allowed for top-level - params. They're only meant to support protobufs with BYTES - (sub)fields. - - '' - - '' - - '' - type: string - description: Specifies the data type of the field. - id: EnterpriseCrmEventbusProtoField - description: Information about the value and type of the field. - GoogleCloudIntegrationsV1alphaAssertion: - type: object + GoogleCloudConnectorsV1ConfigVariable: + id: GoogleCloudConnectorsV1ConfigVariable description: >- - An assertion which will check for a condition over task execution status - or an expression for task output variables Next available id: 5 - properties: - condition: - type: string - description: Optional. Standard filter expression for ASSERT_CONDITION to succeed - retryCount: - format: int32 - description: >- - Number of times given task should be retried in case of - ASSERT_FAILED_EXECUTION - type: integer - assertionStrategy: - enumDescriptions: - - Unspecified Assertion strategy - - Test a successful execution - - Test a failed execution - - Test that the task was never executed - - Test the parameter selected is equal to the expected value - - Test the parameter selected is not equal to the expected value - - Test the parameter selected contains the configured value - - Test a specific condition - type: string - description: The type of assertion to perform. - enum: - - ASSERTION_STRATEGY_UNSPECIFIED - - ASSERT_SUCCESSFUL_EXECUTION - - ASSERT_FAILED_EXECUTION - - ASSERT_NO_EXECUTION - - ASSERT_EQUALS - - ASSERT_NOT_EQUALS - - ASSERT_CONTAINS - - ASSERT_CONDITION - parameter: - description: >- - Optional. Key-value pair for ASSERT_EQUALS, ASSERT_NOT_EQUALS, - ASSERT_CONTAINS to succeed - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaEventParameter' - id: GoogleCloudIntegrationsV1alphaAssertion - EnterpriseCrmEventbusProtoBuganizerNotification: - id: EnterpriseCrmEventbusProtoBuganizerNotification + ConfigVariable represents a configuration variable present in a + Connection. or AuthConfig. + type: object properties: - assigneeEmailAddress: - type: string - description: Whom to assign the new bug. Optional. - componentId: - description: >- - ID of the buganizer component within which to create a new issue. - Required. + key: + description: Optional. Key of the config variable. type: string - format: int64 - templateId: + intValue: + description: Value is an integer type: string - description: ID of the buganizer template to use. Optional. format: int64 - title: + boolValue: + description: Value is a bool. + type: boolean + stringValue: + description: Value is a string. type: string - description: Title of the issue to be created. Required. - type: object - EnterpriseCrmEventbusProtoConnectorsGenericConnectorTaskConfig: + secretValue: + description: Value is a secret. + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + encryptionKeyValue: + description: Value is a Encryption Key. + $ref: '#/components/schemas/GoogleCloudConnectorsV1EncryptionKey' + GoogleCloudConnectorsV1Secret: + id: GoogleCloudConnectorsV1Secret + description: Secret provides a reference to entries in Secret Manager. type: object - id: EnterpriseCrmEventbusProtoConnectorsGenericConnectorTaskConfig properties: - operation: - enum: - - OPERATION_UNSPECIFIED - - EXECUTE_ACTION - - LIST_ENTITIES - - GET_ENTITY - - CREATE_ENTITY - - UPDATE_ENTITY - - DELETE_ENTITY - - EXECUTE_QUERY - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' + secretVersion: + description: >- + Optional. The resource name of the secret version in the format, + format as: `projects/*/secrets/*/versions/*`. type: string - description: Operation to perform using the configured connection. - connection: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoConnectorsConnection' - description: User-selected connection. - EnterpriseCrmFrontendsEventbusProtoSerializedObjectParameter: + GoogleCloudConnectorsV1EncryptionKey: + id: GoogleCloudConnectorsV1EncryptionKey + description: Encryption Key value. type: object properties: - objectValue: - format: byte + type: + description: Type. type: string - id: EnterpriseCrmFrontendsEventbusProtoSerializedObjectParameter - EnterpriseCrmEventbusProtoStringParameterArray: - id: EnterpriseCrmEventbusProtoStringParameterArray - properties: - stringValues: - items: - type: string - type: array - type: object - GoogleCloudIntegrationsV1alphaTakeoverEditLockResponse: - id: GoogleCloudIntegrationsV1alphaTakeoverEditLockResponse - description: Response for TakeoverEditLock. - type: object - properties: - integrationVersion: - description: Version after the lock is acquired by the new user. - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion - GoogleCloudIntegrationsV1alphaSuccessPolicy: - id: GoogleCloudIntegrationsV1alphaSuccessPolicy - properties: - finalState: enumDescriptions: - - UNSPECIFIED. - - >- - The default behavior, where successful tasks will be marked as - SUCCEEDED. - - >- - Sets the state to SUSPENDED after executing. This is required for - SuspensionTask; event execution will continue once the user calls - ResolveSuspensions with the event_execution_info_id and the task - number. - description: >- - State to which the execution snapshot status will be set if the task - succeeds. + - Value type is not specified. + - Google Managed. + - Customer Managed. enum: - - FINAL_STATE_UNSPECIFIED - - SUCCEEDED - - SUSPENDED - type: string - description: >- - Policy that dictates the behavior for the task after it completes - successfully. - type: object - GoogleCloudIntegrationsV1alphaExecuteEventResponse: - description: The response for executing an integration. - properties: - executionId: + - TYPE_UNSPECIFIED + - GOOGLE_MANAGED + - CUSTOMER_MANAGED + kmsKeyName: + description: >- + Optional. The [KMS key name] with which the content of the Operation + is encrypted. The expected format: + `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty + string if google managed. type: string - description: The id of the execution corresponding to this run of integration. - type: object - id: GoogleCloudIntegrationsV1alphaExecuteEventResponse - GoogleCloudIntegrationsV1alphaEventParameter: + GoogleCloudConnectorsV1AuthConfig: + id: GoogleCloudConnectorsV1AuthConfig + description: AuthConfig defines details of a authentication type. type: object - id: GoogleCloudIntegrationsV1alphaEventParameter - description: >- - This message is used for processing and persisting (when applicable) key - value pair parameters for each event in the event bus. Next available - id: 4 properties: - masked: - description: True if this parameter should be masked in the logs - type: boolean - value: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' - description: >- - Values for the defined keys. Each value can either be string, int, - double or any proto message. - key: + authType: + description: Optional. The type of authentication configured. type: string - description: >- - Key is used to retrieve the corresponding parameter value. This - should be unique for a given fired event. These parameters must be - predefined in the integration definition. - EnterpriseCrmEventbusProtoTransformExpression: - id: EnterpriseCrmEventbusProtoTransformExpression - properties: - transformationFunctions: - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFunction' + enumDescriptions: + - Authentication type not specified. + - Username and Password Authentication. + - >- + JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant + based authentication + - Oauth 2.0 Client Credentials Grant Authentication + - SSH Public Key Authentication + - Oauth 2.0 Authorization Code Flow + - Google authentication + - >- + Oauth 2.0 Authorization Code Flow with Google Provided OAuth + Client + enum: + - AUTH_TYPE_UNSPECIFIED + - USER_PASSWORD + - OAUTH2_JWT_BEARER + - OAUTH2_CLIENT_CREDENTIALS + - SSH_PUBLIC_KEY + - OAUTH2_AUTH_CODE_FLOW + - GOOGLE_AUTHENTICATION + - OAUTH2_AUTH_CODE_FLOW_GOOGLE_MANAGED + userPassword: + description: UserPassword. + $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfigUserPassword' + oauth2JwtBearer: + description: Oauth2JwtBearer. + $ref: >- + #/components/schemas/GoogleCloudConnectorsV1AuthConfigOauth2JwtBearer + oauth2ClientCredentials: + description: Oauth2ClientCredentials. + $ref: >- + #/components/schemas/GoogleCloudConnectorsV1AuthConfigOauth2ClientCredentials + sshPublicKey: + description: SSH Public Key. + $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfigSshPublicKey' + oauth2AuthCodeFlow: + description: Oauth2AuthCodeFlow. + $ref: >- + #/components/schemas/GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlow + oauth2AuthCodeFlowGoogleManaged: + description: Oauth2AuthCodeFlowGoogleManaged. + $ref: >- + #/components/schemas/GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlowGoogleManaged + additionalVariables: + description: Optional. List containing additional auth configs. type: array - description: Transformations to be applied sequentially. - initialValue: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBaseValue' - description: Initial value upon which to perform transformations. - type: object - GoogleCloudIntegrationsV1alphaDeprovisionClientRequest: - properties: {} - description: Request for the Deprovision rpc - type: object - id: GoogleCloudIntegrationsV1alphaDeprovisionClientRequest - GoogleCloudIntegrationsV1alphaResolveSuspensionResponse: - type: object - description: Response for Suspensions.ResolveSuspensions. - properties: {} - id: GoogleCloudIntegrationsV1alphaResolveSuspensionResponse - EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue: - id: EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue + items: + $ref: '#/components/schemas/GoogleCloudConnectorsV1ConfigVariable' + authKey: + description: Optional. Identifier key for auth config + type: string + GoogleCloudConnectorsV1AuthConfigUserPassword: + id: GoogleCloudConnectorsV1AuthConfigUserPassword + description: Parameters to support Username and Password Authentication. type: object properties: - percentage: - type: integer - format: int32 - absolute: + username: + description: Optional. Username. type: string - format: int64 + password: + description: Optional. Secret version reference containing the password. + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + GoogleCloudConnectorsV1AuthConfigOauth2JwtBearer: + id: GoogleCloudConnectorsV1AuthConfigOauth2JwtBearer description: >- - The threshold value of the metric, above or below which the alert should - be triggered. See EventAlertConfig or TaskAlertConfig for the different - alert metric types in each case. For the *RATE metrics, one or both of - these fields may be set. Zero is the default value and can be left at - that. For *PERCENTILE_DURATION metrics, one or both of these fields may - be set, and also, the duration threshold value should be specified in - the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, - these fields should not be set at all. A different member, - threshold_duration_ms, must be set in the EventAlertConfig or the - TaskAlertConfig. - EnterpriseCrmFrontendsEventbusProtoParameterEntry: + Parameters to support JSON Web Token (JWT) Profile for Oauth 2.0 + Authorization Grant based authentication. See + https://tools.ietf.org/html/rfc7523 for more details. + type: object properties: - value: + clientKey: description: >- - Values for the defined keys. Each value can either be string, int, - double or any proto message. + Optional. Secret version reference containing a PKCS#8 PEM-encoded + private key associated with the Client Certificate. This private key + will be used to sign JWTs used for the jwt-bearer authorization + grant. Specified in the form as: `projects/*/secrets/*/versions/*`. + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + jwtClaims: + description: Optional. JwtClaims providers fields to generate the token. $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterValueType - key: - description: >- - Key is used to retrieve the corresponding parameter value. This - should be unique for a given fired event. These parameters must be - predefined in the workflow definition. - type: string - dataType: - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - >- - BYTES and BYTES_ARRAY data types are not allowed for top-level - params. They're only meant to support protobufs with BYTES - (sub)fields. - - '' - - '' - - '' - description: Explicitly getting the type of the parameter. - type: string - enum: - - DATA_TYPE_UNSPECIFIED - - STRING_VALUE - - INT_VALUE - - DOUBLE_VALUE - - BOOLEAN_VALUE - - PROTO_VALUE - - SERIALIZED_OBJECT_VALUE - - STRING_ARRAY - - INT_ARRAY - - DOUBLE_ARRAY - - PROTO_ARRAY - - PROTO_ENUM - - BOOLEAN_ARRAY - - PROTO_ENUM_ARRAY - - BYTES - - BYTES_ARRAY - - NON_SERIALIZABLE_OBJECT - - JSON_VALUE - masked: - type: boolean - description: True if this parameter should be masked in the logs - id: EnterpriseCrmFrontendsEventbusProtoParameterEntry - description: Key-value pair of EventBus parameters. + #/components/schemas/GoogleCloudConnectorsV1AuthConfigOauth2JwtBearerJwtClaims + GoogleCloudConnectorsV1AuthConfigOauth2JwtBearerJwtClaims: + id: GoogleCloudConnectorsV1AuthConfigOauth2JwtBearerJwtClaims + description: JWT claims used for the jwt-bearer authorization grant. type: object - EnterpriseCrmEventbusProtoTaskExecutionDetails: properties: - taskExecutionState: - enum: - - UNSPECIFIED - - PENDING_EXECUTION - - IN_PROCESS - - SUCCEED - - FAILED - - FATAL - - RETRY_ON_HOLD - - SKIPPED - - CANCELED - - PENDING_ROLLBACK - - ROLLBACK_IN_PROCESS - - ROLLEDBACK - - SUSPENDED - enumDescriptions: - - '' - - >- - Task is waiting for its precondition tasks to finish to start the - execution. - - Task is under processing. - - >- - Task execution successfully finished. There's no more change after - this state. - - Task execution failed. There's no more change after this state. - - >- - Task execution failed and cause the whole event execution to fail - immediately. There's no more change after this state. - - Task execution failed and waiting for retry. - - >- - Task execution skipped. This happens when its precondition wasn't - met, or the event execution been canceled before reach to the - task. There's no more changes after this state. - - >- - Task execution canceled when in progress. This happens when event - execution been canceled or any other task fall in fatal state. - - >- - Task is waiting for its dependency tasks' rollback to finish to - start its rollback. - - Task is rolling back. - - >- - Task is rolled back. This is the state we will set regardless of - rollback succeeding or failing. - - >- - Task is a SuspensionTask which has executed once, creating a - pending suspension. + issuer: + description: Optional. Value for the "iss" claim. type: string - taskAttemptStats: - type: array - items: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoTaskExecutionDetailsTaskAttemptStats - taskNumber: + subject: + description: Optional. Value for the "sub" claim. type: string - description: Pointer to the task config it used for execution. - type: object - id: EnterpriseCrmEventbusProtoTaskExecutionDetails + audience: + description: Optional. Value for the "aud" claim. + type: string + GoogleCloudConnectorsV1AuthConfigOauth2ClientCredentials: + id: GoogleCloudConnectorsV1AuthConfigOauth2ClientCredentials description: >- - Contains the details of the execution of this task. Next available id: - 11 - GoogleCloudIntegrationsV1alphaImportTemplateResponse: - description: Response for import template - id: GoogleCloudIntegrationsV1alphaImportTemplateResponse + Parameters to support Oauth 2.0 Client Credentials Grant Authentication. + See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. + type: object properties: - subIntegrationVersions: - items: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion - type: array - description: Sub integration versions which are imported. - integrationVersion: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion - description: IntegrationVersion after the import. + clientId: + description: Optional. The client identifier. + type: string + clientSecret: + description: Optional. Secret version reference containing the client secret. + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + GoogleCloudConnectorsV1AuthConfigSshPublicKey: + id: GoogleCloudConnectorsV1AuthConfigSshPublicKey + description: Parameters to support Ssh public key Authentication. type: object - EnterpriseCrmFrontendsEventbusProtoTaskEntity: properties: - uiConfig: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTaskUiConfig' + username: + description: Optional. The user account used to authenticate. + type: string + sshClientCert: description: >- - UI configuration for this task Also associated with the METADATA - mask. - taskType: - enumDescriptions: - - Normal IP task - - Task is of As-Is Template type - - Task is of I/O template type with a different underlying task - enum: - - TASK - - ASIS_TEMPLATE - - IO_TEMPLATE - description: Defines the type of the task + Optional. SSH Client Cert. It should contain both public and private + key. + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + certType: + description: Optional. Format of SSH Client cert. type: string - metadata: - description: Metadata inclueds the task name, author and so on. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTaskMetadata' - paramSpecs: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParamSpecsMessage + sshClientCertPass: description: >- - Declarations for inputs/outputs for a TypedTask. This is also - associated with the METADATA mask. - stats: - $ref: '#/components/schemas/EnterpriseCrmEventbusStats' - deprecated: true - description: Deprecated - statistics from the Monarch query. - disabledForVpcSc: - type: boolean - description: True if the task has conflict with vpcsc + Optional. Password (passphrase) for ssh client certificate if it has + one. + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlow: + id: GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlow description: >- - Contains a task's metadata and associated information. Next available - id: 7 - id: EnterpriseCrmFrontendsEventbusProtoTaskEntity + Parameters to support Oauth 2.0 Auth Code Grant Authentication. See + https://www.rfc-editor.org/rfc/rfc6749#section-1.3.1 for more details. type: object - GoogleCloudIntegrationsV1alphaAssertionResult: - id: GoogleCloudIntegrationsV1alphaAssertionResult properties: - assertion: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAssertion' - description: Assertion that was run. - status: - enum: - - ASSERTION_STATUS_UNSPECIFIED - - SUCCEEDED - - FAILED - enumDescriptions: - - Unspecified assertion status - - Assertion succeeded - - Assertion failed - type: string - description: Status of assertion to signify if the assertion succeeded or failed - failureMessage: - description: Details of the assertion failure + authCode: + description: >- + Optional. Authorization code to be exchanged for access and refresh + tokens. type: string - taskNumber: - description: Task number of task where the assertion was run. + pkceVerifier: + description: Optional. PKCE verifier to be used during the auth code exchange. type: string - taskName: + redirectUri: + description: Optional. Redirect URI to be provided during the auth code exchange. type: string - description: Task name of task where the assertion was run. - type: object - description: The result of an assertion. - GoogleCloudConnectorsV1AuthConfigOauth2ClientCredentials: - type: object - description: >- - Parameters to support Oauth 2.0 Client Credentials Grant Authentication. - See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. - properties: clientId: - description: The client identifier. + description: Optional. Client ID for user-provided OAuth app. type: string clientSecret: + description: Optional. Client secret for user-provided OAuth app. $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' - description: Secret version reference containing the client secret. - id: GoogleCloudConnectorsV1AuthConfigOauth2ClientCredentials - GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse: - id: GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse - type: object - description: Response to list SfdcChannels. - properties: - nextPageToken: - type: string - description: The token used to retrieve the next page of results. - sfdcChannels: - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' - description: The list of SfdcChannels retrieved. - type: array - GoogleCloudIntegrationsV1alphaParameterMapEntry: - properties: - key: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMapField' - description: Key of the map entry. - value: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMapField' - description: Value of the map entry. - description: Entry is a pair of key and value. - id: GoogleCloudIntegrationsV1alphaParameterMapEntry - type: object - GoogleCloudConnectorsV1Secret: - description: Secret provides a reference to entries in Secret Manager. - type: object - properties: - secretVersion: + scopes: description: >- - The resource name of the secret version in the format, format as: - `projects/*/secrets/*/versions/*`. - type: string - id: GoogleCloudConnectorsV1Secret - GoogleCloudIntegrationsV1alphaListRuntimeEntitySchemasResponse: - id: GoogleCloudIntegrationsV1alphaListRuntimeEntitySchemasResponse - type: object - description: Response for listing RuntimeEntitySchemas for a specific Connection. - properties: - runtimeEntitySchemas: - description: Runtime entity schemas. + Optional. Scopes the connection will request when the user performs + the auth code flow. type: array items: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaRuntimeEntitySchema - nextPageToken: - description: Next page token. + type: string + enablePkce: + description: >- + Optional. Whether to enable PKCE when the user performs the auth + code flow. + type: boolean + authUri: + description: Optional. Auth URL for Authorization Code Flow type: string - GoogleCloudIntegrationsV1alphaSearchTemplatesResponse: - id: GoogleCloudIntegrationsV1alphaSearchTemplatesResponse - description: Response for a request to search templates + GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlowGoogleManaged: + id: GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlowGoogleManaged + description: >- + Parameters to support Oauth 2.0 Auth Code Grant Authentication using + Google Provided OAuth Client. See + https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. type: object properties: - nextPageToken: - description: The token used to retrieve the next page results. + authCode: + description: >- + Optional. Authorization code to be exchanged for access and refresh + tokens. type: string - templates: - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' - description: List of templates retrieved. - type: array - EnterpriseCrmEventbusProtoFunction: - id: EnterpriseCrmEventbusProtoFunction - properties: - functionType: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFunctionType' - description: The name of the function to perform. - parameters: - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTransformExpression' - description: List of parameters required for the transformation. - type: array - type: object - GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest: - description: Request for UnpublishIntegrationVersion. - type: object - properties: {} - id: GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest - GoogleCloudIntegrationsV1alphaListTestCasesResponse: - id: GoogleCloudIntegrationsV1alphaListTestCasesResponse - description: Response for ListTestCases - type: object - properties: - nextPageToken: + redirectUri: + description: Optional. Redirect URI to be provided during the auth code exchange. type: string + scopes: description: >- - A token, which can be sent as `page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. - testCases: + Required. Scopes the connection will request when the user performs + the auth code flow. type: array items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTestCase' - description: The test cases corresponding to the specified filter - GoogleCloudConnectorsV1ResourceRequests: + type: string + GoogleCloudConnectorsV1LockConfig: + id: GoogleCloudConnectorsV1LockConfig + description: >- + Determines whether or no a connection is locked. If locked, a reason + must be specified. + type: object properties: - memory: - type: string - description: Output only. Memory request. - readOnly: true - cpu: + locked: + description: Optional. Indicates whether or not the connection is locked. + type: boolean + reason: + description: Optional. Describes why a connection is locked. type: string - readOnly: true - description: Output only. CPU request. - id: GoogleCloudConnectorsV1ResourceRequests - description: Resource requests defined for connection pods of a given connector type. + GoogleCloudConnectorsV1DestinationConfig: + id: GoogleCloudConnectorsV1DestinationConfig + description: Define the Connectors target endpoint. type: object - EnterpriseCrmFrontendsEventbusProtoEventExecutionDetails: properties: - networkAddress: - description: >- - The network address (aka. bns address) that indicates where the - event executor is running. - type: string - ryeLockUnheldCount: - format: int32 + key: description: >- - Used internally and shouldn't be exposed to users. A counter for the - cron job to record how many times this event is in in_process state - but don't have a lock consecutively/ - type: integer - eventExecutionSnapshotsSize: - description: Total size of all event_execution_snapshots for an execution + The key is the destination identifier that is supported by the + Connector. type: string - format: int64 - eventAttemptStats: + destinations: + description: The destinations for the key. type: array items: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats - eventRetriesFromBeginningCount: + $ref: '#/components/schemas/GoogleCloudConnectorsV1Destination' + GoogleCloudConnectorsV1Destination: + id: GoogleCloudConnectorsV1Destination + type: object + properties: + serviceAttachment: description: >- - Indicates the number of times the execution has restarted from the - beginning. - type: integer - format: int32 - logFilePath: - description: The log file path (aka. cns address) for this event. - type: string - cancelReason: + PSC service attachments. Format: + projects/*/regions/*/serviceAttachments/* + deprecated: true type: string - description: >- - If the execution is manually canceled, this field will contain the - reason for cancellation. - nextExecutionTime: - format: int64 + host: + description: For publicly routable host. type: string + port: description: >- - Next scheduled execution time in case the execution status was - RETRY_ON_HOLD. - eventExecutionState: - type: string - enum: - - UNSPECIFIED - - ON_HOLD - - IN_PROCESS - - SUCCEEDED - - FAILED - - CANCELED - - RETRY_ON_HOLD - - SUSPENDED - description: The execution state of this event. - enumDescriptions: - - '' - - >- - Event is received and waiting for the execution. This happens when - firing the event via "postToQueue" or "schedule". - - Event is under processing. - - >- - Event execution successfully finished. There's no more change - after this state. - - Event execution failed. There's no more change after this state. - - >- - Event execution canceled by user. There's no more change after - this state. - - Event execution failed and waiting for retry. - - Event execution suspended and waiting for manual intervention. - eventExecutionSnapshot: - description: >- - After snapshot migration, this field will no longer be populated, - but old execution snapshots will still be accessible. - type: array - items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventExecutionSnapshot - description: >- - Contains the details of the execution info of this event: this includes - the tasks execution details plus the event execution statistics. Next - available id: 12 - id: EnterpriseCrmFrontendsEventbusProtoEventExecutionDetails + The port is the target port number that is accepted by the + destination. + type: integer + format: int32 + GoogleCloudConnectorsV1NodeConfig: + id: GoogleCloudConnectorsV1NodeConfig + description: Node configuration for the connection. type: object - GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse: - id: GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse properties: - executionInfoIds: - description: The execution info id for the executed integrations. - items: - type: string - type: array - description: The response for executing an integration. + minNodeCount: + description: Optional. Minimum number of nodes in the runtime nodes. + type: integer + format: int32 + maxNodeCount: + description: Optional. Maximum number of nodes in the runtime nodes. + type: integer + format: int32 + GoogleCloudConnectorsV1LogConfig: + id: GoogleCloudConnectorsV1LogConfig + description: Log configuration for the connection. type: object - GoogleCloudIntegrationsV1alphaOAuth2ResourceOwnerCredentials: - id: GoogleCloudIntegrationsV1alphaOAuth2ResourceOwnerCredentials properties: - tokenParams: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMap' - description: Token parameters for the auth request. - clientId: - type: string - description: The client's ID. - accessToken: - description: Access token fetched from the authorization server. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAccessToken' - password: - description: The user's password. + enabled: + description: >- + Optional. Enabled represents whether logging is enabled or not for a + connection. + type: boolean + level: + description: Optional. Log configuration level. type: string - requestType: - enum: - - REQUEST_TYPE_UNSPECIFIED - - REQUEST_BODY - - QUERY_PARAMETERS - - ENCODED_HEADER - description: Represent how to pass parameters to fetch access token enumDescriptions: - - Unspecified request type - - To pass all the parameters in post body. - - To pass all the parameters as a part of query parameter. - - >- - To pass client id and client secret as base 64 encoding of - client_id:client_password and rest parameters in post body. + - Log level unspecified. + - Only error logs are enabled. + - Info and error logs are enabled. + - Debug and high verbosity logs are enabled. + enum: + - LOG_LEVEL_UNSPECIFIED + - ERROR + - INFO + - DEBUG + GoogleCloudConnectorsV1SslConfig: + id: GoogleCloudConnectorsV1SslConfig + description: SSL Configuration of a connection + type: object + properties: + type: + description: Optional. Controls the ssl type for the given connector version. type: string - tokenEndpoint: + enumDescriptions: + - No SSL configuration required. + - TLS Handshake + - mutual TLS (MTLS) Handshake + enum: + - SSL_TYPE_UNSPECIFIED + - TLS + - MTLS + trustModel: + description: Optional. Trust Model of the SSL connection type: string + enumDescriptions: + - Public Trust Model. Takes the Default Java trust store. + - Private Trust Model. Takes custom/private trust store. + - Insecure Trust Model. Accept all certificates. + enum: + - PUBLIC + - PRIVATE + - INSECURE + privateServerCertificate: description: >- - The token endpoint is used by the client to obtain an access token - by presenting its authorization grant or refresh token. - clientSecret: - description: The client's secret. - type: string - scope: - description: A space-delimited list of requested scope permissions. + Optional. Private Server Certificate. Needs to be specified if trust + model is `PRIVATE`. + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + clientCertificate: + description: Optional. Client Certificate + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + clientPrivateKey: + description: Optional. Client Private Key + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + clientPrivateKeyPass: + description: >- + Optional. Secret containing the passphrase protecting the Client + Private Key + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + serverCertType: + description: Optional. Type of Server Cert (PEM/JKS/.. etc.) type: string - username: + enumDescriptions: + - Cert type unspecified. + - Privacy Enhanced Mail (PEM) Type + enum: + - CERT_TYPE_UNSPECIFIED + - PEM + clientCertType: + description: Optional. Type of Client Cert (PEM/JKS/.. etc.) type: string - description: The user's username. - description: >- - For resource owner credentials grant, the client will ask the user for - their authorization credentials (ususally a username and password) and - send a POST request to the authorization server. The authorization - server will respond with a JSON object containing the access token. - type: object - EnterpriseCrmEventbusProtoScatterResponse: + enumDescriptions: + - Cert type unspecified. + - Privacy Enhanced Mail (PEM) Type + enum: + - CERT_TYPE_UNSPECIFIED + - PEM + useSsl: + description: Optional. Bool for enabling SSL + type: boolean + additionalVariables: + description: Optional. Additional SSL related field values + type: array + items: + $ref: '#/components/schemas/GoogleCloudConnectorsV1ConfigVariable' + GoogleCloudConnectorsV1EventingConfig: + id: GoogleCloudConnectorsV1EventingConfig + description: 'Eventing Configuration of a connection next: 19' type: object properties: - executionIds: - description: The execution ids of each Subworkflow fired by this scatter. - items: - type: string + registrationDestinationConfig: + description: Optional. Registration endpoint for auto registration. + $ref: '#/components/schemas/GoogleCloudConnectorsV1DestinationConfig' + authConfig: + description: Optional. Auth details for the webhook adapter. + $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfig' + listenerAuthConfig: + description: Optional. Auth details for the event listener. + $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfig' + additionalVariables: + description: Optional. Additional eventing related field values type: array - isSuccessful: - description: >- - If execution is sync, this is true if the execution passed and false - if it failed. If the execution is async, this is true if the WF was - fired off successfully, and false if it failed to execute. The - success or failure of the subworkflows executed are not captured. + items: + $ref: '#/components/schemas/GoogleCloudConnectorsV1ConfigVariable' + enrichmentEnabled: + description: Optional. Enrichment Enabled. type: boolean - scatterElement: - description: The element that was scattered for this execution. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType' - errorMsg: + privateConnectivityEnabled: + description: Optional. Private Connectivity Enabled. + type: boolean + eventsListenerIngressEndpoint: + description: >- + Optional. Ingress endpoint of the event listener. This is used only + when private connectivity is enabled. type: string - description: The error message of the failure if applicable. - responseParams: - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterEntry' + deadLetterConfig: + description: Optional. Dead letter configuration for eventing of a connection. + $ref: >- + #/components/schemas/GoogleCloudConnectorsV1EventingConfigDeadLetterConfig + proxyDestinationConfig: + description: Optional. Proxy for Eventing auto-registration. + $ref: '#/components/schemas/GoogleCloudConnectorsV1DestinationConfig' + enrichmentConfig: + description: Optional. Data enrichment configuration. + $ref: '#/components/schemas/GoogleCloudConnectorsV1EnrichmentConfig' + sslConfig: + description: Optional. Ssl config of a connection + $ref: '#/components/schemas/GoogleCloudConnectorsV1SslConfig' + privateConnectivityAllowlistedProjects: description: >- - A list of all the response parameters in the aggregtorMap stored - with the remapped key. + Optional. List of projects to be allowlisted for the service + attachment created in the tenant project for eventing ingress. type: array - id: EnterpriseCrmEventbusProtoScatterResponse - GoogleCloudIntegrationsV1alphaServiceAccountCredentials: - description: >- - Represents the service account which can be used to generate access - token for authenticating the service call. - id: GoogleCloudIntegrationsV1alphaServiceAccountCredentials + items: + type: string + GoogleCloudConnectorsV1EventingConfigDeadLetterConfig: + id: GoogleCloudConnectorsV1EventingConfigDeadLetterConfig + description: Dead Letter configuration details provided by the user. + type: object properties: - serviceAccount: + topic: + description: Optional. Topic to push events which couldn't be processed. type: string - description: >- - Name of the service account that has the permission to make the - request. - scope: - description: A space-delimited list of requested scope permissions. + projectId: + description: Optional. Project which has the topic given. type: string + GoogleCloudConnectorsV1EnrichmentConfig: + id: GoogleCloudConnectorsV1EnrichmentConfig + description: Data enrichment configuration. type: object - GoogleCloudIntegrationsV1alphaValueType: properties: - intArray: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaIntParameterArray' - description: Integer Array. - stringValue: - type: string - description: String. - intValue: - description: Integer. - type: string - format: int64 - doubleValue: - type: number - format: double - description: Double Number. - doubleArray: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaDoubleParameterArray - description: Double Number Array. - booleanArray: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaBooleanParameterArray - description: Boolean Array. - booleanValue: + appendAcl: + description: Optional. Append ACL to the event. type: boolean - description: Boolean. - jsonValue: - description: Json. - type: string - stringArray: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaStringParameterArray - description: String Array. - description: The type of the parameter. - id: GoogleCloudIntegrationsV1alphaValueType - type: object - EnterpriseCrmEventbusProtoStringArrayFunction: + GoogleCloudConnectorsV1EventingRuntimeData: + id: GoogleCloudConnectorsV1EventingRuntimeData + description: >- + Eventing runtime data has the details related to eventing managed by the + system. type: object - id: EnterpriseCrmEventbusProtoStringArrayFunction properties: - functionName: - enum: - - UNSPECIFIED - - GET - - APPEND - - SIZE - - TO_SET - - APPEND_ALL - - TO_JSON - - SET - - REMOVE - - REMOVE_AT - - CONTAINS - - FOR_EACH - - FILTER - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' + status: + description: Output only. Current status of eventing. + readOnly: true + $ref: '#/components/schemas/GoogleCloudConnectorsV1EventingStatus' + eventsListenerEndpoint: + description: >- + Output only. Events listener endpoint. The value will populated + after provisioning the events listener. + readOnly: true type: string - GoogleCloudIntegrationsV1alphaConnectionSchemaMetadata: - description: Metadata of runtime connection schema. - properties: - actions: - description: List of actions. - type: array - items: - type: string - entities: - type: array - items: - type: string - description: List of entity names. + eventsListenerPscSa: + description: >- + Output only. Events listener PSC Service attachment. The value will + be populated after provisioning the events listener with private + connectivity enabled. + readOnly: true + type: string + webhookData: + description: Output only. Webhook data. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudConnectorsV1EventingRuntimeDataWebhookData + webhookSubscriptions: + description: Output only. Webhook subscriptions. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudConnectorsV1EventingRuntimeDataWebhookSubscriptions + GoogleCloudConnectorsV1EventingStatus: + id: GoogleCloudConnectorsV1EventingStatus + description: EventingStatus indicates the state of eventing. type: object - id: GoogleCloudIntegrationsV1alphaConnectionSchemaMetadata - EnterpriseCrmEventbusProtoIntFunction: - id: EnterpriseCrmEventbusProtoIntFunction properties: - functionName: + state: + description: Output only. State. + readOnly: true + type: string enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' + - Default state. + - Eventing is enabled and ready to receive events. + - Eventing is not active due to an error. + - Ingress endpoint required. enum: - - UNSPECIFIED - - ADD - - SUBTRACT - - MULTIPLY - - DIVIDE - - EXPONENT - - GREATER_THAN_EQUAL_TO - - GREATER_THAN - - LESS_THAN_EQUAL_TO - - LESS_THAN - - TO_DOUBLE - - TO_STRING - - EQUALS - - TO_JSON - - MOD - - EPOCH_TO_HUMAN_READABLE_TIME + - STATE_UNSPECIFIED + - ACTIVE + - ERROR + - INGRESS_ENDPOINT_REQUIRED + description: + description: Output only. Description of error if State is set to "ERROR". + readOnly: true type: string + GoogleCloudConnectorsV1EventingRuntimeDataWebhookData: + id: GoogleCloudConnectorsV1EventingRuntimeDataWebhookData + description: WebhookData has details of webhook configuration. type: object - GoogleCloudIntegrationsV1alphaCoordinate: - description: Configuration detail of coordinate, it used for UI - type: object - id: GoogleCloudIntegrationsV1alphaCoordinate - properties: - x: - format: int32 - type: integer - description: Required. X axis of the coordinate - 'y': - type: integer - format: int32 - description: Required. Y axis of the coordinate - EnterpriseCrmFrontendsEventbusProtoEventExecutionSnapshot: properties: - checkpointTaskNumber: + name: + description: Output only. Name of the Webhook + readOnly: true type: string - description: >- - Indicates "right after which checkpoint task's execution" this - snapshot is taken. - diffParams: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters - description: The parameters in Event object that differs from last snapshot. - conditionResults: + id: + description: Output only. ID to uniquely identify webhook. + readOnly: true + type: string + additionalVariables: + description: Output only. Additional webhook related field values. + readOnly: true type: array items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoConditionResult' - description: All of the computed conditions that been calculated. - taskName: + $ref: '#/components/schemas/GoogleCloudConnectorsV1ConfigVariable' + createTime: + description: Output only. Timestamp when the webhook was created. + readOnly: true type: string - description: The task name associated with this snapshot. Could be empty. - deprecated: true - eventExecutionSnapshotMetadata: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata - eventExecutionInfoId: - description: Points to the event execution info this snapshot belongs to. + format: google-datetime + updateTime: + description: Output only. Timestamp when the webhook was last updated. + readOnly: true type: string - eventExecutionSnapshotId: + format: google-datetime + nextRefreshTime: description: >- - Auto-generated. Used as primary key for EventExecutionSnapshots - table. - type: string - snapshotTime: - description: Indicates when this snapshot is taken. - format: int64 + Output only. Next webhook refresh time. Will be null if refresh is + not supported. + readOnly: true type: string - eventParams: - description: The parameters in Event object. - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters - taskExecutionDetails: + format: google-datetime + GoogleCloudConnectorsV1EventingRuntimeDataWebhookSubscriptions: + id: GoogleCloudConnectorsV1EventingRuntimeDataWebhookSubscriptions + description: WebhookSubscriptions has details of webhook subscriptions. + type: object + properties: + webhookData: + description: Output only. Webhook data. + readOnly: true + type: array items: $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoTaskExecutionDetails - description: All of the task execution details at the given point of time. - type: array - id: EnterpriseCrmFrontendsEventbusProtoEventExecutionSnapshot + #/components/schemas/GoogleCloudConnectorsV1EventingRuntimeDataWebhookData + GoogleCloudConnectorsV1ConnectorVersionInfraConfig: + id: GoogleCloudConnectorsV1ConnectorVersionInfraConfig + description: >- + This configuration provides infra configs like rate limit threshold + which need to be configurable for every connector version type: object - EnterpriseCrmEventbusProtoToken: properties: - name: - type: string - value: + ratelimitThreshold: + description: >- + Output only. Max QPS supported by the connector version before + throttling of requests. + readOnly: true type: string - type: object - id: EnterpriseCrmEventbusProtoToken - GoogleCloudIntegrationsV1alphaIntParameterArray: - type: object - properties: - intValues: - type: array - description: Integer array. - items: - type: string - format: int64 - id: GoogleCloudIntegrationsV1alphaIntParameterArray - description: This message only contains a field of integer array. - GoogleCloudIntegrationsV1alphaExecutionReplayInfo: - description: >- - Contains the details of the execution info: this includes the replay - reason and replay tree connecting executions in a parent-child - relationship - type: object - properties: - originalExecutionInfoId: - description: >- - If this execution is a replay of another execution, then this field - contains the original execution id. - type: string - replayedExecutionInfoIds: + format: int64 + internalclientRatelimitThreshold: description: >- - If this execution has been replayed, then this field contains the - execution ids of the replayed executions. - type: array - items: - type: string - replayReason: - description: reason for replay + Output only. Max QPS supported for internal requests originating + from Connd. + readOnly: true type: string - id: GoogleCloudIntegrationsV1alphaExecutionReplayInfo - GoogleCloudIntegrationsV1alphaCloudKmsConfig: - type: object - description: Configuration information for Client's Cloud KMS information - properties: - kmsRing: + format: int64 + hpaConfig: + description: Output only. HPA autoscaling config. + readOnly: true + $ref: '#/components/schemas/GoogleCloudConnectorsV1HPAConfig' + resourceRequests: + description: Output only. System resource requests. + readOnly: true + $ref: '#/components/schemas/GoogleCloudConnectorsV1ResourceRequests' + resourceLimits: + description: Output only. System resource limits. + readOnly: true + $ref: '#/components/schemas/GoogleCloudConnectorsV1ResourceLimits' + sharedDeployment: + description: Output only. The name of shared connector deployment. + readOnly: true type: string + connectionRatelimitWindowSeconds: description: >- - Required. A key ring organizes keys in a specific Google Cloud - location and allows you to manage access control on groups of keys. - A key ring's name does not need to be unique across a Google Cloud - project, but must be unique within a given location. - key: + Output only. The window used for ratelimiting runtime requests to + connections. + readOnly: true type: string - description: >- - Required. A Cloud KMS key is a named object containing one or more - key versions, along with metadata for the key. A key exists on - exactly one key ring tied to a specific location. - keyVersion: - description: >- - Optional. Each version of a key contains key material used for - encryption or signing. A key's version is represented by an integer, - starting at 1. To decrypt data or verify a signature, you must use - the same key version that was used to encrypt or sign the data. + format: int64 + deploymentModel: + description: Output only. Indicates whether connector is deployed on GKE/CloudRun + readOnly: true type: string - kmsLocation: + enumDescriptions: + - Deployment model is not specified. + - Default model gke mst. + - Cloud run mst. + enum: + - DEPLOYMENT_MODEL_UNSPECIFIED + - GKE_MST + - CLOUD_RUN_MST + deploymentModelMigrationState: + description: Output only. Status of the deployment model migration. + readOnly: true type: string - description: Required. Location name of the key ring, e.g. "us-west1". - kmsProjectId: + enumDescriptions: + - Deployment model migration state is not specified. + - Deployment model migration is in progress. + - Deployment model migration is completed. + - Deployment model migration rolledback. + - Deployment model migration rollback in progress. + enum: + - DEPLOYMENT_MODEL_MIGRATION_STATE_UNSPECIFIED + - IN_PROGRESS + - COMPLETED + - ROLLEDBACK + - ROLLBACK_IN_PROGRESS + maxInstanceRequestConcurrency: + description: Output only. Max instance request concurrency. + readOnly: true + type: integer + format: int32 + tlsMigrationState: + description: Output only. Status of the TLS migration. + readOnly: true type: string - description: >- - Optional. The gcp project id of the project where the kms key - stored. If empty, the kms key is stored at the same project as - customer's project and ecrypted with CMEK, otherwise, the kms key is - stored in the tenant project and encrypted with GMEK - id: GoogleCloudIntegrationsV1alphaCloudKmsConfig - GoogleCloudIntegrationsV1alphaDownloadExecutionResponse: + enumDescriptions: + - TLS migration state is not specified. + - TLS migration is in progress. + - TLS migration is completed. + enum: + - TLS_MIGRATION_STATE_UNSPECIFIED + - TLS_MIGRATION_NOT_STARTED + - TLS_MIGRATION_COMPLETED + GoogleCloudConnectorsV1HPAConfig: + id: GoogleCloudConnectorsV1HPAConfig + description: Autoscaling config for connector deployment system metrics. type: object - id: GoogleCloudIntegrationsV1alphaDownloadExecutionResponse properties: - content: + cpuUtilizationThreshold: + description: Output only. Percent CPU utilization where HPA triggers autoscaling. + readOnly: true type: string - description: The content of downloaded execution. - description: Response for downloading an execution. - EnterpriseCrmEventbusProtoProtoArrayFunction: - id: EnterpriseCrmEventbusProtoProtoArrayFunction + format: int64 + memoryUtilizationThreshold: + description: >- + Output only. Percent Memory utilization where HPA triggers + autoscaling. + readOnly: true + type: string + format: int64 + GoogleCloudConnectorsV1ResourceRequests: + id: GoogleCloudConnectorsV1ResourceRequests + description: Resource requests defined for connection pods of a given connector type. type: object properties: - functionName: - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - enum: - - UNSPECIFIED - - GET - - APPEND - - SIZE - - TO_SET - - APPEND_ALL - - TO_JSON - - SET - - REMOVE - - REMOVE_AT - - CONTAINS - - FOR_EACH - - FILTER + cpu: + description: Output only. CPU request. + readOnly: true type: string - EnterpriseCrmEventbusProtoBooleanFunction: + memory: + description: Output only. Memory request. + readOnly: true + type: string + GoogleCloudConnectorsV1ResourceLimits: + id: GoogleCloudConnectorsV1ResourceLimits + description: Resource limits defined for connection pods of a given connector type. type: object properties: - functionName: - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - enum: - - UNSPECIFIED - - TO_JSON - - NOT - - AND - - NAND - - OR - - XOR - - NOR - - XNOR - - TO_STRING - - EQUALS + cpu: + description: Output only. CPU limit. + readOnly: true type: string - id: EnterpriseCrmEventbusProtoBooleanFunction - GoogleCloudConnectorsV1EncryptionKey: - description: Encryption Key value. - id: GoogleCloudConnectorsV1EncryptionKey + memory: + description: Output only. Memory limit. + readOnly: true + type: string + GoogleCloudConnectorsV1BillingConfig: + id: GoogleCloudConnectorsV1BillingConfig + description: Billing config for the connection. type: object properties: - type: + billingCategory: + description: Output only. Billing category for the connector. + readOnly: true + type: string enumDescriptions: - - Value type is not specified. - - Google Managed. - - Customer Managed. + - Billing category is not specified. + - GCP/Technical connector. + - Non-GCP connector. enum: - - TYPE_UNSPECIFIED - - GOOGLE_MANAGED - - CUSTOMER_MANAGED - description: Type. + - BILLING_CATEGORY_UNSPECIFIED + - GCP_AND_TECHNICAL_CONNECTOR + - NON_GCP_CONNECTOR + GoogleCloudConnectorsV1TrafficShapingConfig: + id: GoogleCloudConnectorsV1TrafficShapingConfig + description: >- + * TrafficShapingConfig defines the configuration for shaping API traffic + by specifying a quota limit and the duration over which this limit is + enforced. This configuration helps to control and manage the rate at + which API calls are made on the client side, preventing service overload + on the backend. For example: - if the quota limit is 100 calls per 10 + seconds, then the message would be: { quota_limit: 100 duration: { + seconds: 10 } } - if the quota limit is 100 calls per 5 minutes, then + the message would be: { quota_limit: 100 duration: { seconds: 300 } } - + if the quota limit is 10000 calls per day, then the message would be: { + quota_limit: 10000 duration: { seconds: 86400 } and so on. + type: object + properties: + quotaLimit: + description: Required. Maximum number of api calls allowed. type: string - kmsKeyName: + format: int64 + duration: + description: >- + Required. * The duration over which the API call quota limits are + calculated. This duration is used to define the time window for + evaluating if the number of API calls made by a user is within the + allowed quota limits. For example: - To define a quota sampled over + 16 seconds, set `seconds` to 16 - To define a quota sampled over 5 + minutes, set `seconds` to 300 (5 * 60) - To define a quota sampled + over 1 day, set `seconds` to 86400 (24 * 60 * 60) and so on. It is + important to note that this duration is not the time the quota is + valid for, but rather the time window over which the quota is + evaluated. For example, if the quota is 100 calls per 10 seconds, + then this duration field would be set to 10 seconds. type: string - description: >- - The [KMS key name] with which the content of the Operation is - encrypted. The expected format: - `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty - string if google managed. - EnterpriseCrmFrontendsEventbusProtoWorkflowParameters: - id: EnterpriseCrmFrontendsEventbusProtoWorkflowParameters - description: >- - LINT.IfChange This is the frontend version of WorkflowParameters. It's - exactly like the backend version except that instead of flattening - protobuf parameters and treating every field and subfield of a protobuf - parameter as a separate parameter, the fields/subfields of a protobuf - parameter will be nested as "children" (see 'children' field below) - parameters of the parent parameter. Please refer to - enterprise/crm/eventbus/proto/workflow_parameters.proto for more - information about WorkflowParameters. + format: google-duration + GoogleCloudIntegrationsV1alphaConnectionSchemaMetadata: + id: GoogleCloudIntegrationsV1alphaConnectionSchemaMetadata + description: Metadata of runtime connection schema. type: object properties: - parameters: + entities: + description: List of entity names. type: array items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry - description: >- - Parameters are a part of Event and can be used to communiticate - between different tasks that are part of the same workflow - execution. - GoogleCloudConnectorsV1EventingConfig: - type: object - properties: - authConfig: - $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfig' - description: Auth details for the webhook adapter. - listenerAuthConfig: - $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfig' - description: Optional. Auth details for the event listener. - registrationDestinationConfig: - description: Registration endpoint for auto registration. - $ref: '#/components/schemas/GoogleCloudConnectorsV1DestinationConfig' - proxyDestinationConfig: - $ref: '#/components/schemas/GoogleCloudConnectorsV1DestinationConfig' - description: Optional. Proxy for Eventing auto-registration. - enrichmentEnabled: - type: boolean - description: Enrichment Enabled. - deadLetterConfig: - $ref: >- - #/components/schemas/GoogleCloudConnectorsV1EventingConfigDeadLetterConfig - description: Optional. Dead letter configuration for eventing of a connection. - eventsListenerIngressEndpoint: - description: >- - Optional. Ingress endpoint of the event listener. This is used only - when private connectivity is enabled. - type: string - privateConnectivityEnabled: - type: boolean - description: Optional. Private Connectivity Enabled. - additionalVariables: - items: - $ref: '#/components/schemas/GoogleCloudConnectorsV1ConfigVariable' - description: Additional eventing related field values + type: string + actions: + description: List of actions. type: array - id: GoogleCloudConnectorsV1EventingConfig - description: Eventing Configuration of a connection - EnterpriseCrmEventbusProtoEventParameters: - type: object - properties: - parameters: - description: >- - Parameters are a part of Event and can be used to communicate - between different tasks that are part of the same integration - execution. items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterEntry' - type: array - description: >- - LINT.IfChange This message is used for processing and persisting (when - applicable) key value pair parameters for each event in the event bus. - Please see - id: EnterpriseCrmEventbusProtoEventParameters - EnterpriseCrmEventbusProtoPropertyEntry: - properties: - key: - description: >- - Key is used to retrieve the corresponding property value. This - should be unique for a given fired event. The Tasks should be aware - of the keys used while firing the events for them to be able to - retrieve the values. - type: string - value: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoValueType' - description: >- - Values for the defined keys. Each value can either be string, int, - double or any proto message. - id: EnterpriseCrmEventbusProtoPropertyEntry - description: Key-value pair of EventBus property. - type: object - EnterpriseCrmEventbusStats: - properties: - warningRate: - description: Average warning rate. - type: number - format: double - errorRate: - type: number - description: Average error rate. - format: double - dimensions: - $ref: '#/components/schemas/EnterpriseCrmEventbusStatsDimensions' - description: Dimensions that these stats have been aggregated on. - qps: - description: Queries per second. - type: number - format: double - durationInSeconds: - format: double - type: number - description: Average duration in seconds. - description: >- - Stats for the requested dimensions: QPS, duration, and error/warning - rate - id: EnterpriseCrmEventbusStats - type: object - GoogleCloudConnectorsV1NodeConfig: - description: Node configuration for the connection. - id: GoogleCloudConnectorsV1NodeConfig - type: object - properties: - minNodeCount: - format: int32 - description: Minimum number of nodes in the runtime nodes. - type: integer - maxNodeCount: - format: int32 - type: integer - description: Maximum number of nodes in the runtime nodes. - EnterpriseCrmEventbusProtoParameterMap: - id: EnterpriseCrmEventbusProtoParameterMap + type: string + GoogleCloudIntegrationsV1alphaListRuntimeEntitySchemasResponse: + id: GoogleCloudIntegrationsV1alphaListRuntimeEntitySchemasResponse + description: Response for listing RuntimeEntitySchemas for a specific Connection. type: object properties: - keyType: - enum: - - DATA_TYPE_UNSPECIFIED - - STRING_VALUE - - INT_VALUE - - DOUBLE_VALUE - - BOOLEAN_VALUE - - PROTO_VALUE - - SERIALIZED_OBJECT_VALUE - - STRING_ARRAY - - INT_ARRAY - - DOUBLE_ARRAY - - PROTO_ARRAY - - PROTO_ENUM - - BOOLEAN_ARRAY - - PROTO_ENUM_ARRAY - - BYTES - - BYTES_ARRAY - - NON_SERIALIZABLE_OBJECT - - JSON_VALUE - type: string - description: >- - Option to specify key value type for all entries of the map. If - provided then field types for all entries must conform to this. - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - >- - BYTES and BYTES_ARRAY data types are not allowed for top-level - params. They're only meant to support protobufs with BYTES - (sub)fields. - - '' - - '' - - '' - valueType: - enum: - - DATA_TYPE_UNSPECIFIED - - STRING_VALUE - - INT_VALUE - - DOUBLE_VALUE - - BOOLEAN_VALUE - - PROTO_VALUE - - SERIALIZED_OBJECT_VALUE - - STRING_ARRAY - - INT_ARRAY - - DOUBLE_ARRAY - - PROTO_ARRAY - - PROTO_ENUM - - BOOLEAN_ARRAY - - PROTO_ENUM_ARRAY - - BYTES - - BYTES_ARRAY - - NON_SERIALIZABLE_OBJECT - - JSON_VALUE - type: string - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - >- - BYTES and BYTES_ARRAY data types are not allowed for top-level - params. They're only meant to support protobufs with BYTES - (sub)fields. - - '' - - '' - - '' - entries: + runtimeEntitySchemas: + description: Runtime entity schemas. type: array items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterMapEntry' - description: >- - A generic multi-map that holds key value pairs. They keys and values can - be of any type, unless specified. - GoogleCloudIntegrationsV1alphaListRuntimeActionSchemasResponse: - type: object - id: GoogleCloudIntegrationsV1alphaListRuntimeActionSchemasResponse - properties: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaRuntimeEntitySchema nextPageToken: - type: string description: Next page token. - runtimeActionSchemas: - items: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaRuntimeActionSchema - description: Runtime action schemas. - type: array - description: Response for listing RuntimeActionSchemas for a specific Connection. + type: string GoogleCloudIntegrationsV1alphaRuntimeEntitySchema: - description: Metadata of an entity, including a schema for its properties. id: GoogleCloudIntegrationsV1alphaRuntimeEntitySchema + description: Metadata of an entity, including a schema for its properties. type: object properties: entity: description: Name of the entity. type: string fieldSchema: - type: string description: List of fields in the entity. + type: string arrayFieldSchema: description: The above schema, but for an array of the associated entity. type: string - GoogleCloudIntegrationsV1alphaCancelExecutionRequest: - description: Request for cancelling an execution. + GoogleCloudIntegrationsV1alphaListRuntimeActionSchemasResponse: + id: GoogleCloudIntegrationsV1alphaListRuntimeActionSchemasResponse + description: Response for listing RuntimeActionSchemas for a specific Connection. + type: object properties: - cancelReason: - description: >- - Required. Reason for cancelling the execution. This is provided by - the client requesting the cancellation, and is not used by the - Platform. + runtimeActionSchemas: + description: Runtime action schemas. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaRuntimeActionSchema + nextPageToken: + description: Next page token. type: string + GoogleCloudIntegrationsV1alphaRuntimeActionSchema: + id: GoogleCloudIntegrationsV1alphaRuntimeActionSchema + description: Metadata of an action, including schemas for its inputs and outputs. type: object - id: GoogleCloudIntegrationsV1alphaCancelExecutionRequest - EnterpriseCrmFrontendsEventbusProtoEventExecutionInfo: - type: object - description: >- - Contains all the execution details for a workflow instance. Next - available id: 27 properties: - tenant: + action: + description: Name of the action. type: string - description: >- - Tenant this event is created. Used to reschedule the event to - correct tenant. - workflowRetryBackoffIntervalSeconds: - format: int64 + inputSchema: + description: Input parameter schema for the action. type: string - description: >- - Time interval in seconds to schedule retry of workflow in manifold - when workflow is already running - cloudLoggingDetails: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCloudLoggingDetails' - description: Cloud Logging details for execution info - createTime: - description: Auto-generated. - format: int64 + outputSchema: + description: Output parameter schema for the action. type: string - workflowName: - description: Name of the workflow. + GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse: + id: GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse + description: Response for ListIntegrationVersions. + type: object + properties: + integrationVersions: + description: The integrations which match the request. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. type: string - executionTraceInfo: - description: Execution trace info to aggregate parent-child executions. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoExecutionTraceInfo' - clientId: + noPermission: + description: Whether the user has no permission on the version or not. + type: boolean + GoogleCloudIntegrationsV1alphaIntegrationVersion: + id: GoogleCloudIntegrationsV1alphaIntegrationVersion + description: The integration version definition. + type: object + properties: + name: + description: Output only. Auto-generated primary key. + readOnly: true type: string - description: The event data user sends as request. - requestId: + description: + description: Optional. The integration description. type: string - description: Optional. This is used to de-dup incoming request. - responseParams: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters - description: Event parameters come out as part of the response. - eventExecutionDetails: - description: The execution info about this event. - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventExecutionDetails - errorCode: - $ref: '#/components/schemas/CrmlogErrorCode' - description: Final error-code if event failed. - errors: - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoErrorDetail' + taskConfigsInternal: + description: >- + Optional. Task configuration for the integration. It's optional, but + the integration doesn't do anything without task_configs. + deprecated: true type: array + items: + $ref: '#/components/schemas/EnterpriseCrmFrontendsEventbusProtoTaskConfig' + taskConfigs: description: >- - Errors, warnings, and informationals associated with the - workflow/task. The order in which the errors were added by the - workflow/task is maintained. - triggerId: + Optional. Task configuration for the integration. It's optional, but + the integration doesn't do anything without task_configs. + type: array + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTaskConfig' + triggerConfigsInternal: + description: Optional. Trigger configurations. + deprecated: true + type: array + items: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoTriggerConfig + triggerConfigs: + description: Optional. Trigger configurations. + type: array + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTriggerConfig' + integrationParametersInternal: description: >- - The trigger id of the workflow trigger config. If both trigger_id - and client_id is present, the workflow is executed from the start - tasks provided by the matching trigger config otherwise it is - executed from the default start tasks. - type: string - replayInfo: - description: Replay info for the execution + Optional. Parameters that are expected to be passed to the + integration when an event is triggered. This consists of all the + parameters that are expected in the integration execution. This + gives the user the ability to provide default values, add + information like PII and also provide data types of each parameter. + deprecated: true $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventExecutionInfoReplayInfo - snapshotNumber: - description: Workflow snapshot number. - format: int64 + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoWorkflowParameters + integrationParameters: + description: >- + Optional. Parameters that are expected to be passed to the + integration when an event is triggered. This consists of all the + parameters that are expected in the integration execution. This + gives the user the ability to provide default values, add + information like PII and also provide data types of each parameter. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationParameter + teardown: + description: >- + Optional. Contains a graph of tasks that will be executed before + putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), + regardless of success or failure, similar to "finally" in code. + deprecated: true + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTeardown' + origin: + description: >- + Optional. The origin that indicates where this integration is coming + from. + deprecated: true type: string - postMethod: + enumDescriptions: + - '' + - Workflow is being created via event bus UI. + - >- + User checked in this workflow in Piper as v2 textproto format and + we synced it into spanner. + - >- + User checked in this workflow in piper as v3 textproto format and + we synced it into spanner. + - Workflow is being created via Standalone IP Provisioning + - Workflow is being created via Test Case. + enumDeprecated: + - false + - false + - true + - false + - false + - false enum: - UNSPECIFIED - - POST - - POST_TO_QUEUE - - SCHEDULE - - POST_BY_EVENT_CONFIG_ID - - POST_WITH_EVENT_DETAILS - description: The ways user posts this event. + - UI + - PIPER_V2 + - PIPER_V3 + - APPLICATION_IP_PROVISIONING + - TEST_CASE + status: + description: >- + Output only. Generated by eventbus. User should not set it as an + input. + readOnly: true + deprecated: true type: string enumDescriptions: - '' @@ -3540,534 +2500,655 @@ components: - '' - '' - '' - - '' - lastModifiedTime: - description: Auto-generated. + enum: + - UNKNOWN + - DRAFT + - ACTIVE + - ARCHIVED + - SNAPSHOT + state: + description: Output only. User should not set it as an input. + readOnly: true + type: string + enumDescriptions: + - Default. + - Draft. + - Active. + - Archived. + - Snapshot. + enum: + - INTEGRATION_STATE_UNSPECIFIED + - DRAFT + - ACTIVE + - ARCHIVED + - SNAPSHOT + snapshotNumber: + description: >- + Output only. An increasing sequence that is set when a new snapshot + is created. The last created snapshot can be identified by + [workflow_name, org_id latest(snapshot_number)]. However, last + created snapshot need not be same as the HEAD. So users should + always use "HEAD" tag to identify the head. + readOnly: true type: string format: int64 - requestParams: - description: Event parameters come in as part of the request. - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters - eventExecutionInfoId: + updateTime: + description: Output only. Auto-generated. + readOnly: true type: string - description: Auto-generated primary key. - workflowId: + format: google-datetime + lockHolder: + description: >- + Optional. The edit lock holder's email address. Generated based on + the End User Credentials/LOAS role of the user making the call. type: string - description: Required. Pointer to the workflow it is executing. - integrationVersionUserLabel: - description: User-defined label that annotates the executed integration version. + createTime: + description: Output only. Auto-generated. + readOnly: true type: string - product: - enum: - - UNSPECIFIED_PRODUCT - - IP - - APIGEE - - SECURITY + format: google-datetime + lastModifierEmail: description: >- - Which Google product the execution_info belongs to. If not set, the - execution_info belongs to Integration Platform by default. + Optional. The last modifier's email address. Generated based on the + End User Credentials/LOAS role of the user making the call. type: string - enumDescriptions: - - '' - - '' - - '' - - '' - id: EnterpriseCrmFrontendsEventbusProtoEventExecutionInfo - GoogleCloudIntegrationsV1alphaReplaceServiceAccountRequest: - id: GoogleCloudIntegrationsV1alphaReplaceServiceAccountRequest - description: Request for the ReplaceServiceAccount rpc - type: object - properties: - runAsServiceAccount: + parentTemplateId: + description: >- + Optional. The id of the template which was used to create this + integration_version. type: string - description: 'Required. REQUIRED: Run-as service account to be updated' - GoogleCloudIntegrationsV1alphaListTemplatesResponse: - id: GoogleCloudIntegrationsV1alphaListTemplatesResponse - type: object - properties: - nextPageToken: - description: The token used to retrieve the next page results. + userLabel: + description: >- + Optional. A user-defined label that annotates an integration + version. Typically, this is only set when the integration version is + created. type: string - templates: - type: array - description: List of templates retrieved. - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' - description: Response for a request to list templates - GoogleCloudIntegrationsV1alphaUnshareTemplateRequest: - description: Request to Unshare template - id: GoogleCloudIntegrationsV1alphaUnshareTemplateRequest - type: object - properties: - resourceNames: - items: - type: string + databasePersistencePolicy: description: >- - Optional. Project name resources to unshare the template. The - project names is expected in resource format Ex: - projects/{project-number} - type: array - EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry: - properties: - dataType: - enum: - - DATA_TYPE_UNSPECIFIED - - STRING_VALUE - - INT_VALUE - - DOUBLE_VALUE - - BOOLEAN_VALUE - - PROTO_VALUE - - SERIALIZED_OBJECT_VALUE - - STRING_ARRAY - - INT_ARRAY - - DOUBLE_ARRAY - - PROTO_ARRAY - - PROTO_ENUM - - BOOLEAN_ARRAY - - PROTO_ENUM_ARRAY - - BYTES - - BYTES_ARRAY - - NON_SERIALIZABLE_OBJECT - - JSON_VALUE + Optional. Flag to disable database persistence for execution data, + including event execution info, execution export info, execution + metadata index and execution param index. type: string enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - >- - BYTES and BYTES_ARRAY data types are not allowed for top-level - params. They're only meant to support protobufs with BYTES - (sub)fields. - - '' - - '' - - '' - description: The data type of the parameter. - protoDefPath: - type: string + - Enables persistence for all execution data. + - Disables persistence for all execution data. + - Asynchronously persist all execution data. + enum: + - DATABASE_PERSISTENCE_POLICY_UNSPECIFIED + - DATABASE_PERSISTENCE_DISABLED + - DATABASE_PERSISTENCE_ASYNC + errorCatcherConfigs: description: >- - If the data type is of type proto or proto array, this field needs - to be populated with the fully qualified proto name. This message, - for example, would be - "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry". - jsonSchema: + Optional. Error Catch Task configuration for the integration. It's + optional. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaErrorCatcherConfig + runAsServiceAccount: description: >- - This schema will be used to validate runtime JSON-typed values of - this parameter. - type: string - attributes: - description: Metadata information about the parameters. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoAttributes' - key: + Optional. The run-as service account email, if set and auth config + is not configured, that will be used to generate auth token to be + used in Connector task, Rest caller task and Cloud function task. type: string + cloudLoggingDetails: + description: Optional. Cloud Logging details for the integration version + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaCloudLoggingDetails + integrationConfigParameters: description: >- - Key is used to retrieve the corresponding parameter value. This - should be unique for a given fired event. These parameters must be - predefined in the workflow definition. - containsLargeData: + Optional. Config Parameters that are expected to be passed to the + integration when an integration is published. This consists of all + the parameters that are expected to provide configuration in the + integration execution. This gives the user the ability to provide + default values, value, add information like connection url, project + based configuration value and also provide data types of each + parameter. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationConfigParameter + enableVariableMasking: + description: >- + Optional. True if variable masking feature should be turned on for + this version type: boolean + createdFromTemplate: description: >- - Indicates whether this variable contains large data and need to be - uploaded to Cloud Storage. - inOutType: + Optional. Optional. The resource name of the template from which the + integration is created. type: string - enum: - - IN_OUT_TYPE_UNSPECIFIED - - IN - - OUT - - IN_OUT - description: Specifies the input/output type for the parameter. - enumDescriptions: - - '' - - >- - Input parameters for the workflow. EventBus validates that these - parameters exist in the workflows before execution. - - >- - Output Parameters for the workflow. EventBus will only return the - workflow parameters tagged with OUT in the response back. - - >- - Input or Output Parameters. These can be used as both input and - output. EventBus will validate for the existence of these - parameters before execution and will also return this parameter - back in the response. - protoDefName: + cloudKmsKey: + description: Optional. Cloud KMS resource name for the CMEK encryption key. type: string - description: >- - The name of the protobuf type if the parameter has a protobuf data - type. - producer: + EnterpriseCrmFrontendsEventbusProtoTaskConfig: + id: EnterpriseCrmFrontendsEventbusProtoTaskConfig + description: >- + The task configuration details. This is not the implementation of Task. + There might be multiple TaskConfigs for the same Task. + type: object + properties: + taskName: + description: The name for the task. type: string - defaultValue: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterValueType + taskNumber: description: >- - Default values for the defined keys. Each value can either be - string, int, double or any proto message or a serialized object. - producedBy: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoNodeIdentifier' + REQUIRED: the identifier of this task within its parent event + config, specified by the client. This should be unique among all the + tasks belong to the same event config. We use this field as the + identifier to find next tasks (via field `next_tasks.task_number`). + type: string + parameters: + description: The customized parameters the user can pass to this task. + type: object + additionalProperties: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry + taskSpec: description: >- - The identifier of the node (TaskConfig/TriggerConfig) this parameter - was produced by, if it is a transient param or a copy of an input - param. - required: - type: boolean - isTransient: - type: boolean - description: Whether this parameter is a transient parameter. - description: - description: Optional. The description about the parameter + A string template that allows user to configure task parameters + (with either literal default values or tokens which will be resolved + at execution time) for the task. It will eventually replace the old + "parameters" field. type: string - name: + creatorEmail: + description: The creator's email address. Auto-generated from the user's email. + type: string + createTime: + description: Auto-generated. + type: string + format: google-datetime + lastModifiedTime: + description: Auto-generated. type: string + format: google-datetime + failurePolicy: description: >- - The name (without prefix) to be displayed in the UI for this - parameter. E.g. if the key is "foo.bar.myName", then the name would - be "myName". - children: - items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry + Optional. Determines the number of times the task will be retried on + failure and with what retry strategy. This is applicable for + asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.). + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFailurePolicy' + synchronousCallFailurePolicy: description: >- - Child parameters nested within this parameter. This field only - applies to protobuf parameters - type: array - type: object - id: EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry - EnterpriseCrmFrontendsEventbusProtoTriggerConfigVariables: - description: Variables names mapped to api trigger. - properties: - names: - items: - type: string + Optional. Determines the number of times the task will be retried on + failure and with what retry strategy. This is applicable for + synchronous calls to Eventbus alone (Post). + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFailurePolicy' + conditionalFailurePolicies: + description: >- + Optional. Determines the number of times the task will be retried on + failure and with what retry strategy. This is applicable for + synchronous calls to Eventbus alone (Post). + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoConditionalFailurePolicies + nextTasks: + description: >- + The set of tasks that are next in line to be executed as per the + execution graph defined for the parent event, specified by + `event_config_id`. Each of these next tasks are executed only if the + condition associated with them evaluates to true. type: array - description: Optional. List of variable names. - id: EnterpriseCrmFrontendsEventbusProtoTriggerConfigVariables - type: object - EnterpriseCrmFrontendsEventbusProtoDoubleParameterArray: - type: object - properties: - doubleValues: items: - format: double - type: number - type: array - id: EnterpriseCrmFrontendsEventbusProtoDoubleParameterArray - EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList: - id: EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList - properties: - filterType: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoNextTask' + nextTasksExecutionPolicy: + description: >- + The policy dictating the execution of the next set of tasks for the + current task. type: string - enum: - - DEFAULT_INCLUSIVE - - EXCLUSIVE enumDescriptions: - - '' - - '' - enumStrings: + - Default + - Execute all the tasks that satisfy their associated condition. + - Execute the first task that satisfies the associated condition. + enum: + - UNSPECIFIED + - RUN_ALL_MATCH + - RUN_FIRST_MATCH + alertConfigs: + description: >- + Alert configurations on error rate, warning rate, number of runs, + durations, etc. type: array items: - type: string - type: object - description: List of error enums for alerts. - GoogleCloudIntegrationsV1alphaLiftSuspensionRequest: - description: Request for lift Suspension - properties: - suspensionResult: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTaskAlertConfig' + rollbackStrategy: description: >- - User passed in suspension result and will be used to control - workflow execution branching behavior by setting up corresponnding - edge condition with suspension result. For example, if you want to - lift the suspension, you can pass "Approved", or if you want to - reject the suspension and terminate workfloe execution, you can pass - "Rejected" and terminate the workflow execution with configuring the - edge condition. + Optional. Contains information about what needs to be done upon + failure (either a permanent error or after it has been retried too + many times). + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoRollbackStrategy + position: + description: >- + Optional. Informs the front-end application where to draw this task + config on the UI. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCoordinate' + taskExecutionStrategy: + description: The policy dictating the execution strategy of this task. type: string - id: GoogleCloudIntegrationsV1alphaLiftSuspensionRequest - type: object - GoogleCloudConnectorsV1Destination: - properties: - port: - format: int32 + enumDescriptions: + - >- + Wait until all of its previous tasks finished execution, then + verify at least one of the edge conditions is met, and execute if + possible. This should be considered as WHEN_ALL_TASKS_SUCCEED. + - >- + Start execution as long as any of its previous tasks finished + execution and the corresponding edge condition is met (since we + will execute if only that succeeding edge condition is met). + - >- + Wait until all of its previous tasks finished execution, then + verify the all edge conditions are met and execute if possible. + enum: + - WHEN_ALL_SUCCEED + - WHEN_ANY_SUCCEED + - WHEN_ALL_TASKS_AND_CONDITIONS_SUCCEED + label: + description: User-provided label that is attached to this TaskConfig in the UI. + type: string + incomingEdgeCount: + description: The number of edges leading into this TaskConfig. type: integer + format: int32 + precondition: description: >- - The port is the target port number that is accepted by the - destination. - serviceAttachment: + Optional. Standard filter expression evaluated before execution. + Independent of other conditions and tasks. Can be used to enable + rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to + task. type: string + preconditionLabel: description: >- - PSC service attachments. Format: - projects/*/regions/*/serviceAttachments/* - deprecated: true - host: + Optional. User-provided label that is attached to precondition in + the UI. type: string - description: For publicly routable host. - id: GoogleCloudConnectorsV1Destination - type: object - GoogleCloudIntegrationsV1alphaExecutionSnapshot: - properties: - executionSnapshotMetadata: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaExecutionSnapshotExecutionSnapshotMetadata - description: Metadata of the execution snapshot. - taskExecutionDetails: - items: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaTaskExecutionDetails - description: All of the task execution details at the given point of time. - type: array - checkpointTaskNumber: + disableStrictTypeValidation: description: >- - Indicates "after which checkpoint task's execution" this snapshot is - taken. + If this config contains a TypedTask, allow validation to succeed if + an input is read from the output of another TypedTask whose output + type is declared as a superclass of the requested input type. For + instance, if the previous task declares an output of type Message, + any task with this flag enabled will pass validation when attempting + to read any proto Message type from the resultant Event parameter. + type: boolean + successPolicy: + description: Determines what action to take upon successful task completion. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoSuccessPolicy' + taskEntity: + description: Copy of the task entity that this task config is an instance of. + $ref: '#/components/schemas/EnterpriseCrmFrontendsEventbusProtoTaskEntity' + jsonValidationOption: + description: >- + If set, overrides the option configured in the Task implementation + class. type: string - params: - description: Parameters used during the execution. - type: object - additionalProperties: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' - id: GoogleCloudIntegrationsV1alphaExecutionSnapshot - type: object - description: Contains the snapshot of the execution for a given checkpoint. - GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails: - id: GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails - properties: - integrationDescription: + enumDescriptions: + - >- + As per the default behavior, no validation will be run. Will not + override any option set in a Task. + - Do not run any validation against JSON schemas. + - >- + Validate all potential input JSON parameters against schemas + specified in WorkflowParameters. + - >- + Validate all potential output JSON parameters against schemas + specified in WorkflowParameters. + - Perform both PRE_EXECUTION and POST_EXECUTION validations. + enum: + - UNSPECIFIED_JSON_VALIDATION_OPTION + - SKIP + - PRE_EXECUTION + - POST_EXECUTION + - PRE_POST_EXECUTION + taskType: + description: Defines the type of the task type: string + enumDescriptions: + - Normal IP task + - Task is of As-Is Template type + - Task is of I/O template type with a different underlying task + enum: + - TASK + - ASIS_TEMPLATE + - IO_TEMPLATE + description: description: >- - Optional. Description of the sub integration which would be created - via templates. - integration: + User-provided description intended to give more business context + about the task. + type: string + taskTemplateName: + description: Used to define task-template name if task is of type task-template type: string + errorCatcherId: description: >- - Required. Name of the sub integration which would be created via - templates. - type: object - description: Sub Integration which would be created via templates. - EnterpriseCrmEventbusProtoProtoFunction: - type: object - properties: - functionName: - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' + Optional Error catcher id of the error catch flow which will be + executed when execution error happens in the task type: string + externalTaskType: + type: string + enumDescriptions: + - Default value. External task type is not specified + - Tasks belongs to the normal task flows + - Task belongs to the error catch task flows enum: - - UNSPECIFIED - - GET_STRING_SUBFIELD - - GET_INT_SUBFIELD - - GET_DOUBLE_SUBFIELD - - GET_BOOLEAN_SUBFIELD - - GET_STRING_ARRAY_SUBFIELD - - GET_INT_ARRAY_SUBFIELD - - GET_DOUBLE_ARRAY_SUBFIELD - - GET_BOOLEAN_ARRAY_SUBFIELD - - GET_PROTO_ARRAY_SUBFIELD - - GET_PROTO_SUBFIELD - - TO_JSON - - GET_BYTES_SUBFIELD_AS_UTF_8_STRING - - GET_BYTES_SUBFIELD_AS_PROTO - - EQUALS - id: EnterpriseCrmEventbusProtoProtoFunction - GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest: + - EXTERNAL_TASK_TYPE_UNSPECIFIED + - NORMAL_TASK + - ERROR_TASK + EnterpriseCrmFrontendsEventbusProtoParameterEntry: + id: EnterpriseCrmFrontendsEventbusProtoParameterEntry + description: Key-value pair of EventBus parameters. type: object properties: - ignoreErrorIfNoActiveWorkflow: - description: >- - Optional. Flag to determine whether clients would suppress a warning - when no ACTIVE workflows are not found. If this flag is set to be - true, an error will not be thrown if the requested trigger_id or - client_id is not found in any ACTIVE workflow. Otherwise, the error - is always thrown. The flag is set to be false by default. - type: boolean - testMode: - description: >- - Optional. Sets test mode in {@link - enterprise/crm/eventbus/event_message.proto}. - type: boolean - requestId: - description: >- - Optional. This is used to de-dup incoming request: if the duplicate - request was detected, the response from the previous execution is - returned. Must have no more than 36 characters and contain only - alphanumeric characters and hyphens. - type: string - triggerId: - type: string - description: >- - Matched against all {@link TriggerConfig}s across all workflows. - i.e. TriggerConfig.trigger_id.equals(trigger_id) Required. - workflowName: - type: string - description: >- - Optional. If provided, the workflow_name is used to filter all the - matched workflows having same trigger_id+client_id. A combination of - trigger_id, client_id and workflow_name identifies a unique - workflow. - scheduledTime: + key: description: >- - Optional. Time in milliseconds since epoch when the given event - would be scheduled. + Key is used to retrieve the corresponding parameter value. This + should be unique for a given fired event. These parameters must be + predefined in the workflow definition. type: string - format: int64 - parameters: - description: Passed in as parameters to each workflow execution. Optional. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' - quotaRetryCount: - description: >- - Optional. This is a field to see the quota retry count for - integration execution - type: integer - format: int32 - priority: - enum: - - UNSPCIFIED - - SHEDDABLE - - SHEDDABLE_PLUS - - CRITICAL - - CRITICAL_PLUS + value: description: >- - The request priority this request should be processed at. For - internal users: + Values for the defined keys. Each value can either be string, int, + double or any proto message. + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterValueType + dataType: + description: Explicitly getting the type of the parameter. type: string enumDescriptions: - - Unspecified - - >- - Frequent partial and occasional full unavailability is expected - and not pageable. * Requests to this band will be shed before all - other requests. * This is the default for async calls sent from - batch jobs. - - >- - Partial unavailability is expected and is not necessarily - pageable. * Requests to this band will be shed before any critical - traffic. * This is the default for async calls sent from - production jobs. - - >- - Any outage is a pageable event. * During a production outage - requests in this band will only be shed before CRITICAL_PLUS. * - This is the default for sync calls sent from production jobs. + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' - >- - Any outage is a pageable event. * The guideline is for < 10% of - requests to a service to be in this band. * During a production - outage requests in this band will be prioritized above all others. - * Opt-in to CRITICAL_PLUS when your workflow triggers by human. - clientId: - type: string - description: >- - Optional. If the client id is provided, then the combination of - trigger id and client id is matched across all the workflows. If the - client id is not provided, then workflows with matching trigger id - are executed for each client id in the {@link TriggerConfig}. For - Api Trigger, the client id is required and will be validated against - the allowed clients. - resourceName: - type: string - description: >- - This field is only required when using Admin Access. The resource - name of target, or the parent resource name. For example: - "projects/*/locations/*/integrations/*" - userGeneratedExecutionId: - description: >- - This is a unique id provided by the method caller. If provided this - will be used as the execution_id when a new execution info is - created. This is a string representation of a UUID. Must have no - more than 36 characters and contain only alphanumeric characters and - hyphens. - type: string - description: >- - LINT.IfChange Use this request to post all workflows associated with a - given trigger id. Next available id: 13 - id: GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest - GoogleCloudIntegrationsV1alphaUploadTemplateRequest: + BYTES and BYTES_ARRAY data types are not allowed for top-level + params. They're only meant to support protobufs with BYTES + (sub)fields. + - '' + - '' + - '' + enum: + - DATA_TYPE_UNSPECIFIED + - STRING_VALUE + - INT_VALUE + - DOUBLE_VALUE + - BOOLEAN_VALUE + - PROTO_VALUE + - SERIALIZED_OBJECT_VALUE + - STRING_ARRAY + - INT_ARRAY + - DOUBLE_ARRAY + - PROTO_ARRAY + - PROTO_ENUM + - BOOLEAN_ARRAY + - PROTO_ENUM_ARRAY + - BYTES + - BYTES_ARRAY + - NON_SERIALIZABLE_OBJECT + - JSON_VALUE + masked: + description: True if this parameter should be masked in the logs + type: boolean + EnterpriseCrmFrontendsEventbusProtoParameterValueType: + id: EnterpriseCrmFrontendsEventbusProtoParameterValueType + description: 'To support various types of parameter values. Next available id: 14' type: object - id: GoogleCloudIntegrationsV1alphaUploadTemplateRequest properties: - content: - description: Required. The textproto of the template. + stringValue: type: string - fileFormat: - enumDescriptions: - - Unspecified file format - - JSON File Format - - YAML File Format + intValue: type: string - description: Required. File format for upload request. - enum: - - FILE_FORMAT_UNSPECIFIED - - JSON - - YAML - description: Request for UploadTemplate. - EnterpriseCrmEventbusProtoSerializedObjectParameter: - id: EnterpriseCrmEventbusProtoSerializedObjectParameter + format: int64 + doubleValue: + type: number + format: double + booleanValue: + type: boolean + protoValue: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + serializedObjectValue: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoSerializedObjectParameter + stringArray: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoStringParameterArray + intArray: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoIntParameterArray + doubleArray: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoDoubleParameterArray + protoArray: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoProtoParameterArray + booleanArray: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoBooleanParameterArray + jsonValue: + type: string + EnterpriseCrmFrontendsEventbusProtoSerializedObjectParameter: + id: EnterpriseCrmFrontendsEventbusProtoSerializedObjectParameter type: object properties: objectValue: - format: byte type: string - GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectRequest: + format: byte + EnterpriseCrmFrontendsEventbusProtoStringParameterArray: + id: EnterpriseCrmFrontendsEventbusProtoStringParameterArray + type: object properties: - appsScriptProject: - type: string - description: The name of the Apps Script project to be created. - authConfigId: - type: string - description: >- - The auth config id necessary to fetch the necessary credentials to - create the project for external clients - id: GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectRequest + stringValues: + type: array + items: + type: string + EnterpriseCrmFrontendsEventbusProtoIntParameterArray: + id: EnterpriseCrmFrontendsEventbusProtoIntParameterArray type: object - description: Request for CreateAppsScriptProject rpc call. - EnterpriseCrmEventbusProtoCondition: - description: Condition that uses `operator` to evaluate the key against the value. properties: - eventPropertyKey: - description: >- - Key that's evaluated against the `value`. Please note the data type + intValues: + type: array + items: + type: string + format: int64 + EnterpriseCrmFrontendsEventbusProtoDoubleParameterArray: + id: EnterpriseCrmFrontendsEventbusProtoDoubleParameterArray + type: object + properties: + doubleValues: + type: array + items: + type: number + format: double + EnterpriseCrmFrontendsEventbusProtoProtoParameterArray: + id: EnterpriseCrmFrontendsEventbusProtoProtoParameterArray + type: object + properties: + protoValues: + type: array + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + EnterpriseCrmFrontendsEventbusProtoBooleanParameterArray: + id: EnterpriseCrmFrontendsEventbusProtoBooleanParameterArray + type: object + properties: + booleanValues: + type: array + items: + type: boolean + EnterpriseCrmEventbusProtoFailurePolicy: + id: EnterpriseCrmEventbusProtoFailurePolicy + description: >- + Policy that defines the task retry logic and failure type. If no + FailurePolicy is defined for a task, all its dependent tasks will not be + executed (i.e, a `retry_strategy` of NONE will be applied). + type: object + properties: + retryStrategy: + description: Defines what happens to the task upon failure. + type: string + enumDescriptions: + - '' + - >- + Ignores the failure of this task. The rest of the workflow will be + executed Assuming this task succeeded. + - >- + Causes a permanent failure of the task. However, if the last + task(s) of event was successfully completed despite the failure of + this task, it has no impact on the workflow. + - >- + Causes a permanent failure of the event. It is different from NONE + because this will mark the event as FAILED by shutting down the + event execution. + - >- + The task will be retried from the failed task onwards after a + fixed delay. A max-retry count is required to be specified with + this strategy. A jitter is added to each exponential interval so + that concurrently failing tasks of the same type do not end up + retrying after the exact same exponential interval. + Max_num_retries and interval_in_seconds must be specified. + - >- + The task will be retried from the failed task onwards after a + fixed delay that linearly increases with each retry attempt. A + jitter is added to each exponential interval so that concurrently + failing tasks of the same type do not end up retrying after the + exact same exponential interval. A max-retry count is required to + be specified with this strategy. Max_num_retries and + interval_in_seconds must be specified. + - >- + The task will be retried after an exponentially increasing period + of time with each failure. A jitter is added to each exponential + interval so that concurrently failing tasks of the same type do + not end up retrying after the exact same exponential interval. A + max-retry count is required to be specified with this strategy. + `max_num_retries` and `interval_in_seconds` must be specified. + - >- + The entire workflow will be restarted with the initial parameters + that were set when the event was fired. A max-retry count is + required to be specified with this strategy. `max_num_retries` and + `interval_in_seconds` must be specified. + enum: + - UNSPECIFIED + - IGNORE + - NONE + - FATAL + - FIXED_INTERVAL + - LINEAR_BACKOFF + - EXPONENTIAL_BACKOFF + - RESTART_WORKFLOW_WITH_BACKOFF + maxNumRetries: + description: >- + Required if retry_strategy is FIXED_INTERVAL or + LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines + the number of times the task will be retried if failed. + type: integer + format: int32 + intervalInSeconds: + description: >- + Required if retry_strategy is FIXED_INTERVAL or + LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines + the initial interval for backoff. + type: string + format: int64 + retryCondition: + description: >- + Optional. The retry condition that will be evaluated for this + failure policy with the corresponding retry strategy. + type: string + EnterpriseCrmEventbusProtoConditionalFailurePolicies: + id: EnterpriseCrmEventbusProtoConditionalFailurePolicies + type: object + properties: + failurePolicies: + description: >- + The list of failure policies that will be applied to the task in + order. + type: array + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFailurePolicy' + defaultFailurePolicy: + description: >- + The default failure policy to be applied if no conditional failure + policy matches + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFailurePolicy' + EnterpriseCrmEventbusProtoNextTask: + id: EnterpriseCrmEventbusProtoNextTask + description: >- + The task that is next in line to be executed, if the condition specified + evaluated to true. + type: object + properties: + taskConfigId: + description: ID of the next task. + type: string + taskNumber: + description: Task number of the next task. + type: string + combinedConditions: + description: >- + Combined condition for this task to become an eligible next task. + Each of these combined_conditions are joined with logical OR. + DEPRECATED: use `condition` + deprecated: true + type: array + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCombinedCondition' + condition: + description: >- + Standard filter expression for this task to become an eligible next + task. + type: string + label: + description: User-provided label that is attached to this edge in the UI. + type: string + description: + description: >- + User-provided description intended to give more business context + about the next task edge or condition. + type: string + EnterpriseCrmEventbusProtoCombinedCondition: + id: EnterpriseCrmEventbusProtoCombinedCondition + deprecated: true + description: >- + This message recursively combines constituent conditions using logical + AND. + type: object + properties: + conditions: + description: A set of individual constituent conditions. + type: array + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCondition' + EnterpriseCrmEventbusProtoCondition: + id: EnterpriseCrmEventbusProtoCondition + deprecated: true + description: Condition that uses `operator` to evaluate the key against the value. + type: object + properties: + eventPropertyKey: + description: >- + Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown. type: string - value: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoValueType' - description: Value that's checked for the key. operator: - type: string - enum: - - UNSET - - EQUALS - - CONTAINS - - LESS_THAN - - GREATER_THAN - - EXISTS - - DOES_NOT_EXIST - - IS_EMPTY - - IS_NOT_EMPTY description: >- Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair. + type: string enumDescriptions: - '' - '' @@ -4078,379 +3159,466 @@ components: - '' - '' - '' - type: object - id: EnterpriseCrmEventbusProtoCondition - deprecated: true - GoogleCloudIntegrationsV1alphaIntegrationAlertConfig: + enum: + - UNSET + - EQUALS + - CONTAINS + - LESS_THAN + - GREATER_THAN + - EXISTS + - DOES_NOT_EXIST + - IS_EMPTY + - IS_NOT_EMPTY + value: + description: Value that's checked for the key. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoValueType' + EnterpriseCrmEventbusProtoValueType: + id: EnterpriseCrmEventbusProtoValueType description: >- - Message to be used to configure custom alerting in the {@code - EventConfig} protos for an event. + Used for define type for values. Currently supported value types include + int, string, double, array, and any proto message. type: object properties: - disableAlert: - description: >- - Set to false by default. When set to true, the metrics are not - aggregated or pushed to Monarch for this integration alert. - type: boolean - thresholdType: - enumDescriptions: - - Default. - - >- - Note that this field will only trigger alerts if the integration - specifying it runs at least once in 24 hours (which is our - in-memory retention period for monarch streams). Also note that - `aggregation_period` for this alert configuration must be less - than 24 hours. Min value threshold. - - Max value threshold. + stringValue: type: string - description: >- - The threshold type, whether lower(expected_min) or - upper(expected_max), for which this alert is being configured. If - value falls below expected_min or exceeds expected_max, an alert - will be fired. - enum: - - THRESHOLD_TYPE_UNSPECIFIED - - EXPECTED_MIN - - EXPECTED_MAX - displayName: + intValue: type: string - description: >- - Name of the alert. This will be displayed in the alert subject. If - set, this name should be unique within the scope of the integration. - alertThreshold: - type: integer - format: int32 - description: >- - For how many contiguous aggregation periods should the expected min - or max be violated for the alert to be fired. - onlyFinalAttempt: - description: >- - For either events or tasks, depending on the type of alert, count - only final attempts, not retries. + format: int64 + doubleValue: + type: number + format: double + protoValue: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + stringArray: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoStringArray' + intArray: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoIntArray' + doubleArray: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoDoubleArray' + booleanValue: type: boolean - aggregationPeriod: - description: >- - The period over which the metric value should be aggregated and - evaluated. Format is , where integer should be a positive integer - and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, - day, week). For an EXPECTED_MIN threshold, this aggregation_period - must be lesser than 24 hours. - type: string - durationThreshold: + EnterpriseCrmEventbusProtoStringArray: + id: EnterpriseCrmEventbusProtoStringArray + type: object + properties: + values: + type: array + items: + type: string + EnterpriseCrmEventbusProtoIntArray: + id: EnterpriseCrmEventbusProtoIntArray + type: object + properties: + values: + type: array + items: + type: string + format: int64 + EnterpriseCrmEventbusProtoDoubleArray: + id: EnterpriseCrmEventbusProtoDoubleArray + type: object + properties: + values: + type: array + items: + type: number + format: double + EnterpriseCrmEventbusProtoTaskAlertConfig: + id: EnterpriseCrmEventbusProtoTaskAlertConfig + description: >- + Message to be used to configure alerting in the {@code TaskConfig} + protos for tasks in an event. + type: object + properties: + alertName: description: >- - Should be specified only for *AVERAGE_DURATION and - *PERCENTILE_DURATION metrics. This member should be used to specify - what duration value the metrics should exceed for the alert to - trigger. + A name to identify this alert. This will be displayed in the alert + subject. If set, this name should be unique in within the scope of + the containing workflow. type: string - format: google-duration - thresholdValue: - description: >- - The metric value, above or below which the alert should be - triggered. - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationAlertConfigThresholdValue metricType: - enum: - - METRIC_TYPE_UNSPECIFIED - - EVENT_ERROR_RATE - - EVENT_WARNING_RATE - - TASK_ERROR_RATE - - TASK_WARNING_RATE - - TASK_RATE - - EVENT_RATE - - EVENT_AVERAGE_DURATION - - EVENT_PERCENTILE_DURATION - - TASK_AVERAGE_DURATION - - TASK_PERCENTILE_DURATION + type: string enumDescriptions: - >- The default value. Metric type should always be set to one of the other non-default values, otherwise it will result in an INVALID_ARGUMENT error. - >- - Specifies alerting on the rate of errors for the enclosing - integration. - - >- - Specifies alerting on the rate of warnings for the enclosing - integration. Warnings use the same enum values as errors. - - >- - Specifies alerting on the rate of errors for any task in the - enclosing integration. - - >- - Specifies alerting on the rate of warnings for any task in the - enclosing integration. - - >- - Specifies alerting on the rate of executions over all tasks in the - enclosing integration. - - >- - Specifies alerting on the number of events executed in the given - aggregation_period. + Specifies alerting on the rate of errors (potentially for a + specific set of enum values) for the enclosing TaskConfig. - >- - Specifies alerting on the average duration of executions for this - integration. + Specifies alerting on the rate of warnings (potentially for a + specific set of enum values) for the enclosing TaskConfig. + Warnings use the same enum values as errors. - >- - Specifies alerting on the duration value of a particular - percentile of integration executions. E.g. If 10% or more of the - integration executions have durations above 5 seconds, alert. + Specifies alerting on the number of instances for the enclosing + TaskConfig executed in the given aggregation_period. - >- - Specifies alerting on the average duration of any task in the - enclosing integration, + Specifies alerting on the average duration of execution for the + enclosing task. - >- - Specifies alerting on the duration value of a particular - percentile of any task executions within the enclosing - integration. E.g. If 10% or more of the task executions in the - integration have durations above 5 seconds, alert. - type: string - description: The type of metric. - id: GoogleCloudIntegrationsV1alphaIntegrationAlertConfig - GoogleCloudIntegrationsV1alphaTaskExecutionDetails: - type: object - id: GoogleCloudIntegrationsV1alphaTaskExecutionDetails - properties: - taskNumber: + Specifies alerting on the duration of a particular percentile of + task executions. E.g. If 10% or more of the task executions have + durations above 5 seconds, alert. + enum: + - METRIC_TYPE_UNSPECIFIED + - TASK_ERROR_RATE + - TASK_WARNING_RATE + - TASK_RATE + - TASK_AVERAGE_DURATION + - TASK_PERCENTILE_DURATION + thresholdType: + description: >- + The threshold type for which this alert is being configured. If + value falls below expected_min or exceeds expected_max, an alert + will be fired. type: string - description: Pointer to the task config it used for execution. - taskExecutionState: enumDescriptions: - - Default value. - - >- - Task is waiting for its precondition tasks to finish to start the - execution. - - Task is under processing. - - >- - Task execution successfully finished. There's no more change after - this state. - - Task execution failed. There's no more change after this state. - - >- - Task execution failed and cause the whole integration execution to - fail immediately. There's no more change after this state. - - Task execution failed and waiting for retry. - - >- - Task execution skipped. This happens when its precondition wasn't - met, or the integration execution been canceled before reach to - the task. There's no more changes after this state. - - >- - Task execution canceled when in progress. This happens when - integration execution been canceled or any other task fall in - fatal state. - - >- - Task is waiting for its dependency tasks' rollback to finish to - start its rollback. - - Task is rolling back. - - >- - Task is rolled back. This is the state we will set regardless of - rollback succeeding or failing. + - '' - >- - Task is a SuspensionTask which has executed once, creating a - pending suspension. + Note that this field will only trigger alerts if the workflow + specifying it runs at least once in 24 hours (which is our + in-memory retention period for monarch streams). Also note that + `aggregation_period` for this alert configuration must be less + than 24 hours. + - '' enum: - - TASK_EXECUTION_STATE_UNSPECIFIED - - PENDING_EXECUTION - - IN_PROCESS - - SUCCEED - - FAILED - - FATAL - - RETRY_ON_HOLD - - SKIPPED - - CANCELLED - - PENDING_ROLLBACK - - ROLLBACK_IN_PROCESS - - ROLLEDBACK - - SUSPENDED - type: string - description: The execution state of this task. - taskAttemptStats: - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAttemptStats' - type: array - description: Status for the current task execution attempt. - description: Contains the details of the execution of this task. - EnterpriseCrmEventbusProtoNotification: - id: EnterpriseCrmEventbusProtoNotification - type: object - properties: - escalatorQueue: - type: string - request: + - UNSPECIFIED_THRESHOLD_TYPE + - EXPECTED_MIN + - EXPECTED_MAX + thresholdValue: + description: >- + The metric value, above or below which the alert should be + triggered. $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoCustomSuspensionRequest + #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue + durationThresholdMs: description: >- - If the out-of-the-box email/pubsub notifications are not suitable - and custom logic is required, fire a workflow containing all info - needed to notify users to resume execution. - emailAddress: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoAddress' - pubsubTopic: + Should be specified only for TASK_AVERAGE_DURATION and + TASK_PERCENTILE_DURATION metrics. This member should be used to + specify what duration value the metrics should exceed for the alert + to trigger. type: string - buganizerNotification: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBuganizerNotification' - EnterpriseCrmEventbusProtoParamSpecEntryValidationRule: - id: EnterpriseCrmEventbusProtoParamSpecEntryValidationRule - properties: - intRange: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleIntRange - doubleRange: + format: int64 + errorEnumList: $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleDoubleRange - stringRegex: + #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList + warningEnumList: $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleStringRegex - type: object - GoogleCloudIntegrationsV1alphaReplayExecutionResponse: - id: GoogleCloudIntegrationsV1alphaReplayExecutionResponse - properties: - executionId: + #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList + aggregationPeriod: description: >- - Next ID: 4 The id of the execution corresponding to this run of the - integration. + The period over which the metric value should be aggregated and + evaluated. Format is , where integer should be a positive integer + and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, + day, week). type: string - outputParameters: - type: object + numAggregationPeriods: description: >- - OUTPUT parameters in format of Map. Where Key is the name of the - parameter. The parameters would only be present in case of - synchrounous execution. Note: Name of the system generated - parameters are wrapped by backtick(`) to distinguish them from the - user defined parameters. - additionalProperties: - type: any - description: Properties of the object. - replayedExecutionId: + For how many contiguous aggregation periods should the expected min + or max be violated for the alert to be fired. + type: integer + format: int32 + alertDisabled: + description: >- + Set to false by default. When set to true, the metrics are not + aggregated or pushed to Monarch for this workflow alert. + type: boolean + onlyFinalAttempt: + description: Only count final task attempts, not retries. + type: boolean + playbookUrl: + description: >- + Link to a playbook for resolving the issue that triggered this + alert. type: string - description: The execution id which is replayed. - type: object - description: Response for replaying an execution. - GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse: - type: object - properties: {} - description: Response for PublishIntegrationVersion. - id: GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse - GoogleCloudIntegrationsV1alphaTaskConfig: + clientId: + description: >- + Client associated with this alert configuration. Must be a client + enabled in one of the containing workflow's triggers. + type: string + EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue: + id: EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue + description: >- + The threshold value of the metric, above or below which the alert should + be triggered. See EventAlertConfig or TaskAlertConfig for the different + alert metric types in each case. For the *RATE metrics, one or both of + these fields may be set. Zero is the default value and can be left at + that. For *PERCENTILE_DURATION metrics, one or both of these fields may + be set, and also, the duration threshold value should be specified in + the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, + these fields should not be set at all. A different member, + threshold_duration_ms, must be set in the EventAlertConfig or the + TaskAlertConfig. type: object - id: GoogleCloudIntegrationsV1alphaTaskConfig properties: - errorCatcherId: - type: string - description: >- - Optional. Optional Error catcher id of the error catch flow which - will be executed when execution error happens in the task - displayName: + absolute: type: string - description: >- - Optional. User-provided label that is attached to this TaskConfig in - the UI. - externalTaskType: - description: Optional. External task type of the task + format: int64 + percentage: + type: integer + format: int32 + EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList: + id: EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList + description: List of error enums for alerts. + type: object + properties: + enumStrings: + type: array + items: + type: string + filterType: type: string enumDescriptions: - - Default value. External task type is not specified - - Tasks belongs to the normal task flows - - Task belongs to the error catch task flows + - '' + - '' enum: - - EXTERNAL_TASK_TYPE_UNSPECIFIED - - NORMAL_TASK - - ERROR_TASK - synchronousCallFailurePolicy: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaFailurePolicy' - description: >- - Optional. Determines the number of times the task will be retried on - failure and with what retry strategy. This is applicable for - synchronous calls to Eventbus alone (Post). - nextTasks: - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaNextTask' - type: array + - DEFAULT_INCLUSIVE + - EXCLUSIVE + EnterpriseCrmFrontendsEventbusProtoRollbackStrategy: + id: EnterpriseCrmFrontendsEventbusProtoRollbackStrategy + description: 'Next available id: 4' + type: object + properties: + rollbackTaskImplementationClassName: description: >- - Optional. The set of tasks that are next in line to be executed as - per the execution graph defined for the parent event, specified by - `event_config_id`. Each of these next tasks are executed only if the - condition associated with them evaluates to true. + Required. This is the name of the task that needs to be executed + upon rollback of this task. + type: string parameters: - type: object - additionalProperties: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaEventParameter' description: Optional. The customized parameters the user can pass to this task. - nextTasksExecutionPolicy: - type: string - enumDescriptions: - - Default. - - Execute all the tasks that satisfy their associated condition. - - Execute the first task that satisfies the associated condition. - enum: - - NEXT_TASKS_EXECUTION_POLICY_UNSPECIFIED - - RUN_ALL_MATCH - - RUN_FIRST_MATCH + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters + taskNumbersToRollback: description: >- - Optional. The policy dictating the execution of the next set of - tasks for the current task. - conditionalFailurePolicies: + Required. These are the tasks numbers of the tasks whose + `rollback_strategy.rollback_task_implementation_class_name` needs to + be executed upon failure of this task. + type: array + items: + type: string + EnterpriseCrmFrontendsEventbusProtoEventParameters: + id: EnterpriseCrmFrontendsEventbusProtoEventParameters + description: >- + LINT.IfChange This message is used for processing and persisting (when + applicable) key value pair parameters for each event in the event bus. + Please see + type: object + properties: + parameters: description: >- - Optional. The list of conditional failure policies that will be - applied to the task in order. - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaConditionalFailurePolicies - taskExecutionStrategy: + Parameters are a part of Event and can be used to communicate + between different tasks that are part of the same workflow + execution. + type: array + items: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry + EnterpriseCrmEventbusProtoCoordinate: + id: EnterpriseCrmEventbusProtoCoordinate + description: Represents two-dimensional positions. + type: object + properties: + x: + type: integer + format: int32 + 'y': + type: integer + format: int32 + EnterpriseCrmEventbusProtoSuccessPolicy: + id: EnterpriseCrmEventbusProtoSuccessPolicy + description: >- + Policy that dictates the behavior for the task after it completes + successfully. + type: object + properties: + finalState: + description: >- + State to which the execution snapshot status will be set if the task + succeeds. type: string - description: Optional. The policy dictating the execution strategy of this task. enumDescriptions: + - '' - >- - Default. If the strategy is not set explicitly, it will default to - `WHEN_ALL_SUCCEED`. - - >- - Wait until all of its previous tasks finished execution, then - verify at least one of the edge conditions is met, and execute if - possible. This should be considered as WHEN_ALL_TASKS_SUCCEED. - - >- - Start execution as long as any of its previous tasks finished - execution and the corresponding edge condition is met (since we - will execute if only that succeeding edge condition is met). + The default behavior, where successful tasks will be marked as + SUCCEEDED. - >- - Wait until all of its previous tasks finished execution, then - verify the all edge conditions are met and execute if possible. + Sets the state to SUSPENDED after executing. This is required for + SuspensionTask; event execution will continue once the user calls + ResolveSuspensions with the event_execution_info_id and the task + number. enum: - - TASK_EXECUTION_STRATEGY_UNSPECIFIED - - WHEN_ALL_SUCCEED - - WHEN_ANY_SUCCEED - - WHEN_ALL_TASKS_AND_CONDITIONS_SUCCEED - failurePolicy: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaFailurePolicy' - description: >- - Optional. Determines the number of times the task will be retried on - failure and with what retry strategy. This is applicable for - asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.). - taskTemplate: - type: string + - UNSPECIFIED + - SUCCEEDED + - SUSPENDED + EnterpriseCrmFrontendsEventbusProtoTaskEntity: + id: EnterpriseCrmFrontendsEventbusProtoTaskEntity + description: >- + Contains a task's metadata and associated information. Next available + id: 7 + type: object + properties: + metadata: + description: Metadata inclueds the task name, author and so on. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTaskMetadata' + stats: + description: Deprecated - statistics from the Monarch query. + deprecated: true + $ref: '#/components/schemas/EnterpriseCrmEventbusStats' + paramSpecs: description: >- - Optional. Used to define task-template name if task is of type - task-template - taskId: - type: string + Declarations for inputs/outputs for a TypedTask. This is also + associated with the METADATA mask. + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParamSpecsMessage + uiConfig: description: >- - Required. The identifier of this task within its parent event - config, specified by the client. This should be unique among all the - tasks belong to the same event config. We use this field as the - identifier to find next tasks (via field `next_tasks.task_id`). - task: - description: Optional. The name for the task. + UI configuration for this task Also associated with the METADATA + mask. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTaskUiConfig' + taskType: + description: Defines the type of the task type: string - successPolicy: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSuccessPolicy' + enumDescriptions: + - Normal IP task + - Task is of As-Is Template type + - Task is of I/O template type with a different underlying task + enum: + - TASK + - ASIS_TEMPLATE + - IO_TEMPLATE + disabledForVpcSc: + description: True if the task has conflict with vpcsc + type: boolean + EnterpriseCrmEventbusProtoTaskMetadata: + id: EnterpriseCrmEventbusProtoTaskMetadata + description: >- + TaskMetadata are attributes that are associated to every common Task we + have. + type: object + properties: + admins: + type: array + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTaskMetadataAdmin' + name: description: >- - Optional. Determines what action to take upon successful task - completion. + The actual class name or the annotated name of the task. Task Author + should initialize this field with value from the getName() method of + the Task class. + type: string + descriptiveName: + description: >- + The string name to show on the task list on the Workflow editor + screen. This should be a very short, one to two words name for the + task. (e.g. "Send Mail") + type: string description: + description: In a few sentences, describe the purpose and usage of the task. + type: string + defaultSpec: description: >- - Optional. User-provided description intended to give additional - business context about the task. + Contains the initial configuration of the task with default values + set. For now, The string should be compatible to an ASCII-proto + format. type: string - position: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCoordinate' + g3DocLink: + description: URL to the associated G3 Doc for the task if available + type: string + iconLink: description: >- - Optional. Informs the front-end application where to draw this error - catcher config on the UI. - jsonValidationOption: + URL to gstatic image icon for this task. This icon shows up on the + task list panel along with the task name in the Workflow Editor + screen. Use the 24p, 2x, gray color icon image format. + type: string + status: + description: >- + Allows author to indicate if the task is ready to use or not. If not + set, then it will default to INACTIVE. + type: string + enumDescriptions: + - >- + Default value. Actual Task Status should always be set to either + INACTIVE or ACTIVE. If none is specified at runtime, it will be + set to INACTIVE. + - Still in-progress or incomplete, and not intended for use. + - Available for use. + enum: + - UNSPECIFIED_STATUS + - DEFAULT_INACTIVE + - ACTIVE + codeSearchLink: + description: The Code Search link to the Task Java file. + type: string + isDeprecated: + description: The deprecation status of the current task. Default value is false; + type: boolean + activeTaskName: + description: >- + The new task name to replace the current task if it is deprecated. + Otherwise, it is the same as the current task name. + type: string + docMarkdown: + description: Snippet of markdown documentation to embed in the RHP for this task. + type: string + category: + type: string + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - Internal IP tasks that should not be available in the UI. + - Tasks that are relevant to cloud systems teams and typically + - Task entities that derive from a custom task template. + - Category to show task recommendations + enum: + - UNSPECIFIED_CATEGORY + - CUSTOM + - FLOW_CONTROL + - DATA_MANIPULATION + - SCRIPTING + - CONNECTOR + - HIDDEN + - CLOUD_SYSTEMS + - CUSTOM_TASK_TEMPLATE + - TASK_RECOMMENDATIONS + system: + type: string + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + enum: + - UNSPECIFIED_SYSTEM + - GENERIC + - BUGANIZER + - SALESFORCE + - CLOUD_SQL + - PLX + - SHEETS + - GOOGLE_GROUPS + - EMAIL + - SPANNER + - DATA_BRIDGE + defaultJsonValidationOption: + description: >- + Controls whether JSON workflow parameters are validated against + provided schemas before and/or after this task's execution. + type: string enumDescriptions: - >- As per the default behavior, no validation will be run. Will not @@ -4458,254 +3626,190 @@ components: - Do not run any validation against JSON schemas. - >- Validate all potential input JSON parameters against schemas - specified in IntegrationParameter. + specified in WorkflowParameters. - >- Validate all potential output JSON parameters against schemas - specified in IntegrationParameter. + specified in WorkflowParameters. - Perform both PRE_EXECUTION and POST_EXECUTION validations. enum: - - JSON_VALIDATION_OPTION_UNSPECIFIED + - UNSPECIFIED_JSON_VALIDATION_OPTION - SKIP - PRE_EXECUTION - POST_EXECUTION - PRE_POST_EXECUTION + tags: description: >- - Optional. If set, overrides the option configured in the Task - implementation class. - type: string - description: >- - The task configuration details. This is not the implementation of Task. - There might be multiple TaskConfigs for the same Task. - GoogleCloudIntegrationsV1alphaCloudLoggingDetails: - properties: - enableCloudLogging: - description: >- - Optional. Status of whether Cloud Logging is enabled or not for the - integration version getting executed. - type: boolean - cloudLoggingSeverity: - description: >- - Optional. Severity selected by the customer for the logs to be sent - to Cloud Logging, for the integration version getting executed. - enum: - - CLOUD_LOGGING_SEVERITY_UNSPECIFIED - - INFO - - ERROR - - WARNING + A set of tags that pertain to a particular task. This can be used to + improve the searchability of tasks with several names ("REST Caller" + vs. "Call REST Endpoint") or to help users find tasks based on + related words. + type: array + items: + type: string + externalCategory: type: string enumDescriptions: - - Unspecified - - >- - If Severity selected is `INFO`, then all the Integration Execution - States (`IN_PROCESS`, `ON_HOLD`, `SUCCEEDED`, `SUSPENDED`, - `ERROR`, `CANCELLED`) will be sent to Cloud Logging. - - >- - If Severity selected is `ERROR`, then only the following - Integration Execution States (`ERROR`, `CANCELLED`) will be sent - to Cloud Logging. - - >- - If Severity selected is `WARNING`, then only the following - Integration Execution States (`ERROR`, `CANCELLED`) will be sent - to Cloud Logging. - description: Cloud Logging details for execution info - type: object - id: GoogleCloudIntegrationsV1alphaCloudLoggingDetails - GoogleCloudConnectorsV1EventingRuntimeDataWebhookData: - description: WebhookData has details of webhook configuration. - properties: - name: + - '' + - '' + - '' + - HTTP tasks, e.g. rest api call task + - Integration services, e.g. connector task + - Customer ations, e.g. email task + - Flow control, e.g. while loop task + - Workspace tasks, e.g. list drive task + - Security, e.g. kms related tasks + - Database operation tasks, e.g. read firestore info tasks + - Analytics tasks, e.g. dataflow creattion tasks + - BYOC tasks + - BYOT tasks + - AI related tasks. + - Data manipulation related tasks, e.g. data mapping task + enum: + - UNSPECIFIED_EXTERNAL_CATEGORY + - CORE + - CONNECTORS + - EXTERNAL_HTTP + - EXTERNAL_INTEGRATION_SERVICES + - EXTERNAL_CUSTOMER_ACTIONS + - EXTERNAL_FLOW_CONTROL + - EXTERNAL_WORKSPACE + - EXTERNAL_SECURITY + - EXTERNAL_DATABASES + - EXTERNAL_ANALYTICS + - EXTERNAL_BYOC + - EXTERNAL_BYOT + - EXTERNAL_ARTIFICIAL_INTELIGENCE + - EXTERNAL_DATA_MANIPULATION + externalCategorySequence: + description: >- + Sequence with which the task in specific category to be displayed in + task discovery panel for external users. + type: integer + format: int32 + externalDocMarkdown: + description: 'DEPRECATED: Use external_doc_html.' type: string - readOnly: true - description: Output only. Name of the Webhook - nextRefreshTime: - readOnly: true - format: google-datetime + externalDocHtml: + description: External-facing documention embedded in the RHP for this task. type: string + standaloneExternalDocHtml: description: >- - Output only. Next webhook refresh time. Will be null if refresh is - not supported. - id: - readOnly: true - type: string - description: Output only. ID to uniquely identify webhook. - createTime: - description: Output only. Timestamp when the webhook was created. + External-facing documention for standalone IP in pantheon embedded + in the RHP for this task. Non null only if different from + external_doc_html type: string - format: google-datetime - readOnly: true - additionalVariables: - readOnly: true - type: array - description: Output only. Additional webhook related field values. - items: - $ref: '#/components/schemas/GoogleCloudConnectorsV1ConfigVariable' - updateTime: - format: google-datetime - readOnly: true + externalDocLink: + description: Doc link for external-facing documentation (separate from g3doc). type: string - description: Output only. Timestamp when the webhook was last updated. + EnterpriseCrmEventbusProtoTaskMetadataAdmin: + id: EnterpriseCrmEventbusProtoTaskMetadataAdmin + description: >- + Admins are owners of a Task, and have all permissions on a particular + task identified by the task name. By default, Eventbus periodically + scans all task metadata and syncs (adds) any new admins defined here to + Zanzibar. type: object - id: GoogleCloudConnectorsV1EventingRuntimeDataWebhookData - GoogleCloudConnectorsV1ConfigVariable: properties: - encryptionKeyValue: - $ref: '#/components/schemas/GoogleCloudConnectorsV1EncryptionKey' - description: Value is a Encryption Key. - intValue: - format: int64 - type: string - description: Value is an integer - boolValue: - description: Value is a bool. - type: boolean - key: + userEmail: type: string - description: Key of the config variable. - stringValue: + googleGroupEmail: type: string - description: Value is a string. - secretValue: - description: Value is a secret. - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' - id: GoogleCloudConnectorsV1ConfigVariable - type: object + EnterpriseCrmEventbusStats: + id: EnterpriseCrmEventbusStats description: >- - ConfigVariable represents a configuration variable present in a - Connection. or AuthConfig. - CrmlogErrorCode: + Stats for the requested dimensions: QPS, duration, and error/warning + rate + type: object properties: - commonErrorCode: + dimensions: + description: Dimensions that these stats have been aggregated on. + $ref: '#/components/schemas/EnterpriseCrmEventbusStatsDimensions' + qps: + description: Queries per second. + type: number + format: double + durationInSeconds: + description: Average duration in seconds. + type: number + format: double + errorRate: + description: Average error rate. + type: number + format: double + warningRate: + description: Average warning rate. + type: number + format: double + EnterpriseCrmEventbusStatsDimensions: + id: EnterpriseCrmEventbusStatsDimensions + type: object + properties: + triggerId: + description: >- + Stats have been or will be aggregated on set fields for any + semantically-meaningful combination. + type: string + clientId: + type: string + workflowName: + type: string + workflowId: + type: string + taskName: + type: string + taskNumber: + type: string + errorEnumString: + type: string + warningEnumString: + type: string + retryAttempt: type: string - enumDeprecated: - - false - - true - - false - - false - - true - - true - - true - - false - - false - - true - - false - - false - - false - - false - - true - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - enum: - - COMMON_ERROR_CODE_UNSPECIFIED - - INVALID_CREDENTIALS - - REQUIRED_FIELDS_MISSING - - INVALID_FIELDS - - BACKEND - - GENERAL - - INTERNAL - - IO_ERROR - - NOT_FOUND - - EVENT_BUS - - ALREADY_EXISTS - - CONCORD - - CONVERSION - - FLUME - - PERMISSION - - SALES_FORCE - - SPANNER - - UNIMPLEMENTED - - RELTIO - - WORKFLOW_NOT_FOUND - - QUOTA_THROTTLED - - QUOTA_ENQUEUED - - INVALID_QUOTA_CONFIGURATION - - TASK_NOT_FOUND - - EXECUTION_TIMEOUT - - INVALID_EVENT_EXECUTION_STATE - - INVALID_ATTRIBUTE - - MISSING_ATTRIBUTE - - CLIENT_UNAUTHORIZED_FOR_WORKFLOW - - INVALID_PARAMETER - - MISSING_PARAMETER - - UNAUTHROIZED_WORKFLOW_EDITOR_ACTION - - FAILED_PRECONDITION - - INVALID_CLIENT - - MISSING_CLIENT - - INVALID_WORKFLOW - - MISSING_QUOTA_CONFIGURATION - - UNHANDLED_TASK_ERROR - - SCRIPT_TASK_RUNTIME_ERROR - - RPC - - INVALID_PROTO - - UNHANDLED_EVENTBUS_ERROR - - INVALID_TASK_STATE - - TYPED_TASK_INVALID_INPUT_OPERATION - - TYPED_TASK_INVALID_OUTPUT_OPERATION - - VALIDATION_ERROR - - RESUME_ERROR - - APPS_SCRIPT_EXECUTION_ERROR - - INVALID_VECTOR_USER - - INFORMATICA - - RETRYABLE_TASK_ERROR - - INVALID_TENANT - - WRONG_TENANT - - INFORMATICA_BACKEND_UNAVAILABLE - - RPC_PERMISSION_DENIED - - SYNC_EVENTBUS_EXECUTION_TIMEOUT - - ASYNC_EVENTBUS_EXECUTION_TIMEOUT - - NOT_SUPPORTED_DATA_TYPE - - UNSANITIZED_USER_INPUT - - TRANSFORM_EXPRESSION_EVALUATION_ERROR - - HTTP_EXCEPTION - - EXECUTION_CANCELLED enumDescriptions: - '' + - >- + Task has completed successfully or has depleted all retry + attempts. + - Task has failed but may be retried. + - Task has been deliberately canceled. + enum: + - UNSPECIFIED + - FINAL + - RETRYABLE + - CANCELED + enumFilterType: + description: Whether to include or exclude the enums matching the regex. + type: string + enumDescriptions: - '' - '' + enum: + - DEFAULT_INCLUSIVE + - EXCLUSIVE + EnterpriseCrmFrontendsEventbusProtoParamSpecsMessage: + id: EnterpriseCrmFrontendsEventbusProtoParamSpecsMessage + type: object + properties: + parameters: + type: array + items: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParamSpecEntry + EnterpriseCrmFrontendsEventbusProtoParamSpecEntry: + id: EnterpriseCrmFrontendsEventbusProtoParamSpecEntry + description: 'Key-value pair of EventBus task parameters. Next id: 13' + type: object + properties: + key: + description: >- + Key is used to retrieve the corresponding parameter value. This + should be unique for a given task. These parameters must be + predefined in the workflow definition. + type: string + dataType: + description: The data type of the parameter. + type: string + enumDescriptions: - '' - '' - '' @@ -4720,600 +3824,643 @@ components: - '' - '' - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - SYNC_EVENTBUS_EXECUTION_TIMEOUT is for eventbus internal use only. - >- - ASYNC_EVENTBUS_EXECUTION_TIMEOUT is for eventbus internal use - only. This error will be counted as server availability error. - - '' - - '' + BYTES and BYTES_ARRAY data types are not allowed for top-level + params. They're only meant to support protobufs with BYTES + (sub)fields. - '' - '' - '' - id: CrmlogErrorCode - type: object - description: >- - Registered ids for errors, as "oneof" enums. Each task or logical - grouping of tasks may share the same enum. - EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats: + enum: + - DATA_TYPE_UNSPECIFIED + - STRING_VALUE + - INT_VALUE + - DOUBLE_VALUE + - BOOLEAN_VALUE + - PROTO_VALUE + - SERIALIZED_OBJECT_VALUE + - STRING_ARRAY + - INT_ARRAY + - DOUBLE_ARRAY + - PROTO_ARRAY + - PROTO_ENUM + - BOOLEAN_ARRAY + - PROTO_ENUM_ARRAY + - BYTES + - BYTES_ARRAY + - NON_SERIALIZABLE_OBJECT + - JSON_VALUE + protoDef: + description: Populated if this represents a proto or proto array. + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryProtoDefinition + className: + description: >- + The FQCN of the Java object this represents. A string, for example, + would be "java.lang.String". If this is "java.lang.Object", the + parameter can be of any type. + type: string + collectionElementClassName: + description: >- + If it is a collection of objects, this would be the FCQN of every + individual element in the collection. If this is "java.lang.Object", + the parameter is a collection of any type. + type: string + jsonSchema: + description: If the data_type is JSON_VALUE, then this will define its schema. + type: string + defaultValue: + description: >- + Default values for the defined keys. Each value can either be + string, int, double or any proto message or a serialized object. + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterValueType + isOutput: + type: boolean + config: + description: Optional fields, such as help text and other useful info. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryConfig' + required: + description: If set, the user must provide an input value for this parameter. + type: boolean + isDeprecated: + description: >- + If set, this entry is deprecated, so further use of this parameter + should be prohibited. + type: boolean + validationRule: + description: >- + Rule used to validate inputs (individual values and collection + elements) for this parameter. + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryValidationRule + EnterpriseCrmEventbusProtoParamSpecEntryProtoDefinition: + id: EnterpriseCrmEventbusProtoParamSpecEntryProtoDefinition type: object properties: - endTime: + path: + description: Path to the proto file that contains the message type's definition. type: string - format: int64 - description: The end time of the event execution for current attempt. - startTime: - format: int64 + fullName: description: >- - The start time of the event execution for current attempt. This - could be in the future if it's been scheduled. + The fully-qualified proto name. This message, for example, would be + "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition". type: string - id: EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats - GoogleCloudIntegrationsV1alphaClientConfig: + EnterpriseCrmEventbusProtoParamSpecEntryConfig: + id: EnterpriseCrmEventbusProtoParamSpecEntryConfig + type: object properties: - billingType: - enum: - - BILLING_TYPE_UNSPECIFIED - - BILLING_TYPE_APIGEE_TRIALS - - BILLING_TYPE_APIGEE_SUBSCRIPTION - - BILLING_TYPE_PAYG - enumDescriptions: - - Unspecified billing type - - A trial org provisioned through Apigee Provisioning Wizard - - Subscription based users of Apigee - - Consumption based users of IP - description: Indicates the billing type of the client - type: string - runAsServiceAccount: + descriptivePhrase: + description: A short phrase to describe what this parameter contains. type: string - description: >- - Default run-as service account email, set up during project - provision time, that will be used to generate auth token to be used - in Connector task, Rest caller task, Cloud function task and - Subworkflows. - projectId: + label: + description: A user-friendly label for the parameter. type: string - description: The GCP project id of the client associated with - enableInternalIp: - type: boolean + helpText: description: >- - Optional. Indicates the client enables internal IP feature, this is - applicable for internal clients only. - description: + Detailed help text for this parameter containing information not + provided elsewhere. For example, instructions on how to migrate from + a deprecated parameter. type: string - description: Description of what the client is used for - enableVariableMasking: - type: boolean + uiPlaceholderText: description: >- - Optional. True if variable masking feature should be turned on for - this region - isGmek: - type: boolean - description: Optional. Indicates the client is provisioned with CMEK or GMEK. - p4ServiceAccount: - description: The service agent associated with this client - type: string - region: + Placeholder text which will appear in the UI input form for this + parameter. type: string - description: The region the client is linked to. - createTime: - description: The timestamp when the client was first created. - format: google-datetime + inputDisplayOption: type: string - clientState: - enum: - - CLIENT_STATE_UNSPECIFIED - - CLIENT_STATE_ACTIVE - - CLIENT_STATE_DISABLED enumDescriptions: - - The client state is unspecified - - The client is active and able to make calls to the IP APIs - - The client is disabled and will soon be deleted - description: Indicates the activity state the client + - >- + A single-line input for strings, a numeric input box for numbers, + or a checkbox for booleans. + - A multi-line input box for longer strings/string templates. + - >- + A slider to select a numerical value. The default range is [0, + 100]. + - A toggle button for boolean parameters. + enum: + - DEFAULT + - STRING_MULTI_LINE + - NUMBER_SLIDER + - BOOLEAN_TOGGLE + subSectionLabel: + description: >- + A user-friendly label for subSection under which the parameter will + be displayed. type: string - id: + parameterNameOption: type: string - description: Globally unique ID (project_id + region) - cloudKmsConfig: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCloudKmsConfig' - description: Cloud KMS config for Auth Module to encrypt/decrypt credentials. - type: object - description: The configuration information for the Client - id: GoogleCloudIntegrationsV1alphaClientConfig - GoogleCloudIntegrationsV1alphaCredential: - type: object - description: Defines parameters for a single, canonical credential. - id: GoogleCloudIntegrationsV1alphaCredential - properties: - credentialType: enumDescriptions: - - Unspecified credential type - - Regular username/password pair. - - API key. - - OAuth 2.0 Authorization Code Grant Type. - - OAuth 2.0 Implicit Grant Type. - - OAuth 2.0 Client Credentials Grant Type. - - OAuth 2.0 Resource Owner Credentials Grant Type. - - JWT Token. - - Auth Token, e.g. bearer token. + - This field is not a parameter name. - >- - Service Account which can be used to generate token for - authentication. - - Client Certificate only. - - Google OIDC ID Token - type: string + If this field is a string and this option is selected, the field + will be interpreted as a parameter name. Users will be able to + choose a variable using the autocomplete, but the name will be + stored as a literal string. + - >- + If this field is a ParameterMap and this option is selected, the + map's keys will be interpreted as parameter names. Ignored if this + field is not a ParameterMap. + - >- + If this field is a ParameterMap and this option is selected, the + map's values will be interpreted as parameter names. Ignored if + this field is not a ParameterMap. enum: - - CREDENTIAL_TYPE_UNSPECIFIED - - USERNAME_AND_PASSWORD - - API_KEY - - OAUTH2_AUTHORIZATION_CODE - - OAUTH2_IMPLICIT - - OAUTH2_CLIENT_CREDENTIALS - - OAUTH2_RESOURCE_OWNER_CREDENTIALS - - JWT - - AUTH_TOKEN - - SERVICE_ACCOUNT - - CLIENT_CERTIFICATE_ONLY - - OIDC_TOKEN - description: Credential type associated with auth config. - jwt: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaJwt' - description: JWT credential - oauth2ClientCredentials: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaOAuth2ClientCredentials - description: OAuth2Implicit oauth2_implicit = 5; OAuth2 client credentials - authToken: - description: Auth token credential - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthToken' - oidcToken: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaOidcToken' - description: Google OIDC ID Token - oauth2ResourceOwnerCredentials: - description: OAuth2 resource owner credentials - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaOAuth2ResourceOwnerCredentials - usernameAndPassword: + - DEFAULT_NOT_PARAMETER_NAME + - IS_PARAMETER_NAME + - KEY_IS_PARAMETER_NAME + - VALUE_IS_PARAMETER_NAME + isHidden: + description: Whether this field is hidden in the UI. + type: boolean + hideDefaultValue: + description: Whether the default value is hidden in the UI. + type: boolean + EnterpriseCrmEventbusProtoParamSpecEntryValidationRule: + id: EnterpriseCrmEventbusProtoParamSpecEntryValidationRule + type: object + properties: + intRange: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUsernameAndPassword - description: Username and password credential - serviceAccountCredentials: + #/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleIntRange + doubleRange: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaServiceAccountCredentials - description: Service account credential - oauth2AuthorizationCode: + #/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleDoubleRange + stringRegex: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaOAuth2AuthorizationCode - description: >- - The api_key and oauth2_implicit are not covered in v1 and will be - picked up once v1 is implemented. ApiKey api_key = 3; OAuth2 - authorization code credential - EnterpriseCrmEventbusProtoSuccessPolicy: - type: object - properties: - finalState: - enum: - - UNSPECIFIED - - SUCCEEDED - - SUSPENDED - enumDescriptions: - - '' - - >- - The default behavior, where successful tasks will be marked as - SUCCEEDED. - - >- - Sets the state to SUSPENDED after executing. This is required for - SuspensionTask; event execution will continue once the user calls - ResolveSuspensions with the event_execution_info_id and the task - number. - type: string - description: >- - State to which the execution snapshot status will be set if the task - succeeds. - description: >- - Policy that dictates the behavior for the task after it completes - successfully. - id: EnterpriseCrmEventbusProtoSuccessPolicy - EnterpriseCrmEventbusProtoSuspensionExpiration: - id: EnterpriseCrmEventbusProtoSuspensionExpiration - properties: - expireAfterMs: - type: integer - description: Milliseconds after which the suspension expires, if no action taken. - format: int32 - remindAfterMs: - description: >- - Milliseconds after which the previous suspension action reminder, if - any, is sent using the selected notification option, for a - suspension which is still PENDING_UNSPECIFIED. - type: integer - format: int32 - liftWhenExpired: - description: >- - Whether the suspension will be REJECTED or LIFTED upon expiration. - REJECTED is the default behavior. - type: boolean + #/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleStringRegex + EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleIntRange: + id: EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleIntRange + description: Range used to validate longs and ints. type: object - EnterpriseCrmEventbusProtoLoopMetadata: properties: - currentIterationCount: - description: Starting from 1, not 0. + min: + description: The inclusive minimum of the acceptable range. type: string format: int64 - currentIterationDetail: - type: string - description: >- - Needs to be set by the loop impl class before each iteration. The - abstract loop class will append the request and response to it. Eg. - The foreach Loop will clean up and set it as the current iteration - element at the start of each loop. The post request and response - will be appended to the value once they are available. - errorMsg: - type: string - description: Add the error message when loops fail. - failureLocation: - enum: - - UNKNOWN - - SUBWORKFLOW - - PARAM_OVERRIDING - - PARAM_AGGREGATING - - SETTING_ITERATION_ELEMENT - - GETTING_LIST_TO_ITERATE - - CONDITION_EVALUATION - - BUILDING_REQUEST + max: + description: The inclusive maximum of the acceptable range. type: string - description: Indicates where in the loop logic did it error out. - enumDescriptions: - - No error or Unknown. - - Subworkflow failed while firing/running. - - Param overrides failed. - - Param aggregation failed. - - Setting for loop current element failed. - - Getting the list to iterate. - - Evaluating the while loop condition. - - Building the iteration request - id: EnterpriseCrmEventbusProtoLoopMetadata + format: int64 + EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleDoubleRange: + id: EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleDoubleRange + description: Range used to validate doubles and floats. type: object - GoogleCloudIntegrationsV1alphaAuthConfig: - description: The AuthConfig resource use to hold channels and connection config data. + properties: + min: + description: The inclusive minimum of the acceptable range. + type: number + format: double + max: + description: The inclusive maximum of the acceptable range. + type: number + format: double + EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleStringRegex: + id: EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleStringRegex + description: Rule used to validate strings. type: object properties: - certificateId: - type: string - description: Certificate id for client certificate - creatorEmail: + regex: + description: The regex applied to the input value(s). type: string + exclusive: description: >- - The creator's email address. Generated based on the End User - Credentials/LOAS role of the user making the call. - expiryNotificationDuration: - description: >- - User can define the time to receive notification after which the - auth config becomes invalid. Support up to 30 days. Support - granularity in hours. - items: - format: google-duration - type: string + Whether the regex matcher is applied exclusively (if true, matching + values will be rejected). + type: boolean + EnterpriseCrmEventbusProtoTaskUiConfig: + id: EnterpriseCrmEventbusProtoTaskUiConfig + description: >- + Task authors would use this type to configure the UI for a particular + task by specifying what UI config modules should be included to compose + the UI. Learn more about config module framework: + type: object + properties: + taskUiModuleConfigs: + description: Configurations of included config modules. type: array - lastModifierEmail: - description: >- - The last modifier's email address. Generated based on the End User - Credentials/LOAS role of the user making the call. - type: string - encryptedCredential: - format: byte - type: string - description: >- - Auth credential encrypted by Cloud KMS. Can be decrypted as - Credential with proper KMS key. - createTime: - readOnly: true - format: google-datetime - type: string - description: Output only. The timestamp when the auth config is created. - decryptedCredential: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCredential' - description: Raw auth credentials. - reason: - description: The reason / details of the current status. - type: string - validTime: - format: google-datetime - type: string - description: >- - The time until the auth config is valid. Empty or max value is - considered the auth config won't expire. - overrideValidTime: - type: string - description: >- - User provided expiry time to override. For the example of - Salesforce, username/password credentials can be valid for 6 months - depending on the instance settings. - format: google-datetime - description: - description: A description of the auth config. + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTaskUiModuleConfig' + EnterpriseCrmEventbusProtoTaskUiModuleConfig: + id: EnterpriseCrmEventbusProtoTaskUiModuleConfig + description: Task author would use this type to configure a config module. + type: object + properties: + moduleId: + description: ID of the config module. type: string - visibility: - description: The visibility of the auth config. enumDescriptions: - - Visibility not specified. - - Profile visible to the creator only. - - Profile visible within the client. - enum: - - AUTH_CONFIG_VISIBILITY_UNSPECIFIED - - PRIVATE - - CLIENT_VISIBLE - type: string - state: - type: string - description: The status of the auth config. - enum: - - STATE_UNSPECIFIED - - VALID - - INVALID - - SOFT_DELETED - - EXPIRED - - UNAUTHORIZED - - UNSUPPORTED - enumDescriptions: - - Status not specified. - - Valid Auth config. + - Default + - Supports editing label of a task config. + - Supports editing error handling settings such as retry strategy. - >- - General invalidity, if it doesn't fits in the detailed issue - below. - - Auth config soft deleted. - - Auth config expired. - - Auth config unauthorized. - - Auth config not supported. - displayName: - description: Required. The name of the auth config. + Supports adding, removing and editing task parameter values in a + table with little assistance or restriction. + - >- + Supports editing values of declared input parameters of a task. + Think of it as a "strongly typed" upgrade to the TASK_PARAM_TABLE. + - Supports editing preconditions of a task config. + - >- + Supports adding, editing, and deleting the scripts associated with + a script task, as well as modifying the input/output parameters. + - >- + Supports editing task parameters associated with an RPC/stubby + task. + - >- + Contains readonly task information, including input/output type + info. + - Configures a SuspensionTask. + - Configures a GenericStubbyTypedTask. + - Configures a SubWorkflowExecutorTask. + - Supports navigating to Apps Script editor + - Configures a SubWorkflowForEachLoopTask. + - Configures a FieldMappingTask. + - Contains embedded in-product documentation for a task. + - UI widget for the rest caller task. + - Configures a SubWorkflowScatterGatherTask. + - Configures a CloudSql Task. + - Configure a GenericConnectorTask. + enum: + - UNSPECIFIED_TASK_MODULE + - LABEL + - ERROR_HANDLING + - TASK_PARAM_TABLE + - TASK_PARAM_FORM + - PRECONDITION + - SCRIPT_EDITOR + - RPC + - TASK_SUMMARY + - SUSPENSION + - RPC_TYPED + - SUB_WORKFLOW + - APPS_SCRIPT_NAVIGATOR + - SUB_WORKFLOW_FOR_EACH_LOOP + - FIELD_MAPPING + - README + - REST_CALLER + - SUB_WORKFLOW_SCATTER_GATHER + - CLOUD_SQL + - GENERIC_CONNECTOR_TASK + GoogleCloudIntegrationsV1alphaTaskConfig: + id: GoogleCloudIntegrationsV1alphaTaskConfig + description: >- + The task configuration details. This is not the implementation of Task. + There might be multiple TaskConfigs for the same Task. + type: object + properties: + task: + description: Optional. The name for the task. type: string - updateTime: - format: google-datetime + taskId: + description: >- + Required. The identifier of this task within its parent event + config, specified by the client. This should be unique among all the + tasks belong to the same event config. We use this field as the + identifier to find next tasks (via field `next_tasks.task_id`). type: string - description: Output only. The timestamp when the auth config is modified. - readOnly: true - credentialType: + parameters: + description: Optional. The customized parameters the user can pass to this task. + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaEventParameter' + failurePolicy: + description: >- + Optional. Determines the number of times the task will be retried on + failure and with what retry strategy. This is applicable for + asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.). + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaFailurePolicy' + synchronousCallFailurePolicy: + description: >- + Optional. Determines the number of times the task will be retried on + failure and with what retry strategy. This is applicable for + synchronous calls to Eventbus alone (Post). + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaFailurePolicy' + conditionalFailurePolicies: + description: >- + Optional. The list of conditional failure policies that will be + applied to the task in order. + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaConditionalFailurePolicies + nextTasks: + description: >- + Optional. The set of tasks that are next in line to be executed as + per the execution graph defined for the parent event, specified by + `event_config_id`. Each of these next tasks are executed only if the + condition associated with them evaluates to true. + type: array + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaNextTask' + nextTasksExecutionPolicy: + description: >- + Optional. The policy dictating the execution of the next set of + tasks for the current task. type: string + enumDescriptions: + - Default. + - Execute all the tasks that satisfy their associated condition. + - Execute the first task that satisfies the associated condition. enum: - - CREDENTIAL_TYPE_UNSPECIFIED - - USERNAME_AND_PASSWORD - - API_KEY - - OAUTH2_AUTHORIZATION_CODE - - OAUTH2_IMPLICIT - - OAUTH2_CLIENT_CREDENTIALS - - OAUTH2_RESOURCE_OWNER_CREDENTIALS - - JWT - - AUTH_TOKEN - - SERVICE_ACCOUNT - - CLIENT_CERTIFICATE_ONLY - - OIDC_TOKEN - description: Credential type of the encrypted credential. + - NEXT_TASKS_EXECUTION_POLICY_UNSPECIFIED + - RUN_ALL_MATCH + - RUN_FIRST_MATCH + taskExecutionStrategy: + description: Optional. The policy dictating the execution strategy of this task. + type: string enumDescriptions: - - Unspecified credential type - - Regular username/password pair. - - API key. - - OAuth 2.0 Authorization Code Grant Type. - - OAuth 2.0 Implicit Grant Type. - - OAuth 2.0 Client Credentials Grant Type. - - OAuth 2.0 Resource Owner Credentials Grant Type. - - JWT Token. - - Auth Token, e.g. bearer token. - >- - Service Account which can be used to generate token for - authentication. - - Client Certificate only. - - Google OIDC ID Token - name: - type: string + Default. If the strategy is not set explicitly, it will default to + `WHEN_ALL_SUCCEED`. + - >- + Wait until all of its previous tasks finished execution, then + verify at least one of the edge conditions is met, and execute if + possible. This should be considered as WHEN_ALL_TASKS_SUCCEED. + - >- + Start execution as long as any of its previous tasks finished + execution and the corresponding edge condition is met (since we + will execute if only that succeeding edge condition is met). + - >- + Wait until all of its previous tasks finished execution, then + verify the all edge conditions are met and execute if possible. + enum: + - TASK_EXECUTION_STRATEGY_UNSPECIFIED + - WHEN_ALL_SUCCEED + - WHEN_ANY_SUCCEED + - WHEN_ALL_TASKS_AND_CONDITIONS_SUCCEED + displayName: description: >- - Resource name of the auth config. For more information, see Manage - authentication profiles. - projects/{project}/locations/{location}/authConfigs/{authConfig}. - id: GoogleCloudIntegrationsV1alphaAuthConfig - GoogleCloudIntegrationsV1alphaIntegration: - properties: - lastModifierEmail: + Optional. User-provided label that is attached to this TaskConfig in + the UI. type: string - description: Required. The last modifier of this integration - updateTime: - description: Output only. Auto-generated. - readOnly: true - format: google-datetime + successPolicy: + description: >- + Optional. Determines what action to take upon successful task + completion. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSuccessPolicy' + jsonValidationOption: + description: >- + Optional. If set, overrides the option configured in the Task + implementation class. type: string + enumDescriptions: + - >- + As per the default behavior, no validation will be run. Will not + override any option set in a Task. + - Do not run any validation against JSON schemas. + - >- + Validate all potential input JSON parameters against schemas + specified in IntegrationParameter. + - >- + Validate all potential output JSON parameters against schemas + specified in IntegrationParameter. + - Perform both PRE_EXECUTION and POST_EXECUTION validations. + enum: + - JSON_VALIDATION_OPTION_UNSPECIFIED + - SKIP + - PRE_EXECUTION + - POST_EXECUTION + - PRE_POST_EXECUTION description: + description: >- + Optional. User-provided description intended to give additional + business context about the task. type: string - description: Optional. - name: - type: string - description: Required. The resource name of the integration. - creatorEmail: - readOnly: true - type: string + taskTemplate: description: >- - Output only. The creator's email address. Generated based on the End - User Credentials/LOAS role of the user making the call. - createTime: - readOnly: true + Optional. Used to define task-template name if task is of type + task-template type: string - format: google-datetime - description: Required. Output only. Auto-generated. - active: - description: Required. If any integration version is published. - type: boolean - type: object - id: GoogleCloudIntegrationsV1alphaIntegration - description: The integration definition. - GoogleCloudIntegrationsV1alphaShareTemplateRequest: - id: GoogleCloudIntegrationsV1alphaShareTemplateRequest - properties: - resourceNames: - items: - type: string + errorCatcherId: description: >- - Optional. Project name resources to share the template. The project - names is expected in resource format Ex: projects/{project-number} - or organization/{org-id} - type: array - description: Request to Share template - type: object - GoogleCloudIntegrationsV1alphaUploadTestCaseResponse: + Optional. Optional Error catcher id of the error catch flow which + will be executed when execution error happens in the task + type: string + externalTaskType: + description: Optional. External task type of the task + type: string + enumDescriptions: + - Default value. External task type is not specified + - Tasks belongs to the normal task flows + - Task belongs to the error catch task flows + enum: + - EXTERNAL_TASK_TYPE_UNSPECIFIED + - NORMAL_TASK + - ERROR_TASK + position: + description: >- + Optional. Informs the front-end application where to draw this error + catcher config on the UI. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCoordinate' + GoogleCloudIntegrationsV1alphaEventParameter: + id: GoogleCloudIntegrationsV1alphaEventParameter + description: >- + This message is used for processing and persisting (when applicable) key + value pair parameters for each event in the event bus. Next available + id: 4 type: object - id: GoogleCloudIntegrationsV1alphaUploadTestCaseResponse - description: Response for UploadTestCase. properties: - testCase: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTestCase' - description: The uploaded TestCase - GoogleCloudIntegrationsV1alphaExecuteTestCaseRequest: + key: + description: >- + Key is used to retrieve the corresponding parameter value. This + should be unique for a given fired event. These parameters must be + predefined in the integration definition. + type: string + value: + description: >- + Values for the defined keys. Each value can either be string, int, + double or any proto message. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' + masked: + description: True if this parameter should be masked in the logs + type: boolean + GoogleCloudIntegrationsV1alphaFailurePolicy: + id: GoogleCloudIntegrationsV1alphaFailurePolicy + description: >- + Policy that defines the task retry logic and failure type. If no + FailurePolicy is defined for a task, all its dependent tasks will not be + executed (i.e, a `retry_strategy` of NONE will be applied). type: object - description: The request for executing a functional test. - properties: - inputParameters: - additionalProperties: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' - description: Optional. Input parameters used by test case execution. - type: object - id: GoogleCloudIntegrationsV1alphaExecuteTestCaseRequest - EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata: properties: - taskNumber: - description: The task number associated with this snapshot. Could be empty. - type: string - taskName: - description: the task name associated with this snapshot. Could be empty. + retryStrategy: + description: Defines what happens to the task upon failure. type: string - ancestorTaskNumbers: - type: array + enumDescriptions: + - UNSPECIFIED. + - >- + Ignores the failure of this task. The rest of the integration will + be executed Assuming this task succeeded. + - >- + Causes a permanent failure of the task. However, if the last + task(s) of event was successfully completed despite the failure of + this task, it has no impact on the integration. + - >- + Causes a permanent failure of the event. It is different from NONE + because this will mark the event as FAILED by shutting down the + event execution. + - >- + The task will be retried from the failed task onwards after a + fixed delay. A max-retry count is required to be specified with + this strategy. A jitter is added to each exponential interval so + that concurrently failing tasks of the same type do not end up + retrying after the exact same exponential interval. max_retries + and interval_in_seconds must be specified. + - >- + The task will be retried from the failed task onwards after a + fixed delay that linearly increases with each retry attempt. A + jitter is added to each exponential interval so that concurrently + failing tasks of the same type do not end up retrying after the + exact same exponential interval. A max-retry count is required to + be specified with this strategy. max_retries and + interval_in_seconds must be specified. + - >- + The task will be retried after an exponentially increasing period + of time with each failure. A jitter is added to each exponential + interval so that concurrently failing tasks of the same type do + not end up retrying after the exact same exponential interval. A + max-retry count is required to be specified with this strategy. + `max_retries` and `interval_in_seconds` must be specified. + - >- + The entire integration will be restarted with the initial + parameters that were set when the event was fired. A max-retry + count is required to be specified with this strategy. + `max_retries` and `interval_in_seconds` must be specified. + enum: + - RETRY_STRATEGY_UNSPECIFIED + - IGNORE + - NONE + - FATAL + - FIXED_INTERVAL + - LINEAR_BACKOFF + - EXPONENTIAL_BACKOFF + - RESTART_INTEGRATION_WITH_BACKOFF + maxRetries: description: >- - Ancestor task number for the task(it will only be non-empty if the - task is under 'private workflow') - items: - type: string - taskAttemptNum: - description: the task attempt number this snapshot belongs to. Could be empty. - format: int32 - type: integer - eventAttemptNum: - description: the event attempt number this snapshot belongs to. + Required if retry_strategy is FIXED_INTERVAL or + LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines + the number of times the task will be retried if failed. type: integer format: int32 - ancestorIterationNumbers: - items: - type: string - type: array - description: >- - Ancestor iteration number for the task(it will only be non-empty if - the task is under 'private workflow') - integrationName: + intervalTime: description: >- - The direct integration which the event execution snapshots belongs - to + Required if retry_strategy is FIXED_INTERVAL or + LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines + the initial interval in seconds for backoff. type: string - taskLabel: + format: google-datetime + condition: + description: >- + Optional. The string condition that will be evaluated to determine + if the task should be retried with this failure policy. type: string - description: the task label associated with this snapshot. Could be empty. + GoogleCloudIntegrationsV1alphaConditionalFailurePolicies: + id: GoogleCloudIntegrationsV1alphaConditionalFailurePolicies + description: Conditional task failur retry strategies type: object - id: >- - EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata - GoogleCloudConnectorsV1EventingRuntimeDataWebhookSubscriptions: properties: - webhookData: - items: - $ref: >- - #/components/schemas/GoogleCloudConnectorsV1EventingRuntimeDataWebhookData + failurePolicies: + description: >- + The list of failure policies that will be applied to the task in + order. type: array - description: Output only. Webhook data. - readOnly: true - description: WebhookSubscriptions has details of webhook subscriptions. - id: GoogleCloudConnectorsV1EventingRuntimeDataWebhookSubscriptions + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaFailurePolicy' + defaultFailurePolicy: + description: >- + The default failure policy to be applied if no conditional failure + policy matches. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaFailurePolicy' + GoogleCloudIntegrationsV1alphaNextTask: + id: GoogleCloudIntegrationsV1alphaNextTask + description: >- + The task that is next in line to be executed, if the condition specified + evaluated to true. type: object - EnterpriseCrmFrontendsEventbusProtoParameterMap: properties: - keyType: + taskConfigId: + description: ID of the next task. + type: string + taskId: + description: Task number of the next task. + type: string + condition: + description: >- + Standard filter expression for this task to become an eligible next + task. + type: string + displayName: + description: User-provided label that is attached to this edge in the UI. + type: string + description: + description: >- + User-provided description intended to give additional business + context about the task. + type: string + GoogleCloudIntegrationsV1alphaSuccessPolicy: + id: GoogleCloudIntegrationsV1alphaSuccessPolicy + description: >- + Policy that dictates the behavior for the task after it completes + successfully. + type: object + properties: + finalState: + description: >- + State to which the execution snapshot status will be set if the task + succeeds. + type: string enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' + - UNSPECIFIED. - >- - BYTES and BYTES_ARRAY data types are not allowed for top-level - params. They're only meant to support protobufs with BYTES - (sub)fields. - - '' - - '' - - '' + The default behavior, where successful tasks will be marked as + SUCCEEDED. + - >- + Sets the state to SUSPENDED after executing. This is required for + SuspensionTask; event execution will continue once the user calls + ResolveSuspensions with the event_execution_info_id and the task + number. enum: - - DATA_TYPE_UNSPECIFIED - - STRING_VALUE - - INT_VALUE - - DOUBLE_VALUE - - BOOLEAN_VALUE - - PROTO_VALUE - - SERIALIZED_OBJECT_VALUE - - STRING_ARRAY - - INT_ARRAY - - DOUBLE_ARRAY - - PROTO_ARRAY - - PROTO_ENUM - - BOOLEAN_ARRAY - - PROTO_ENUM_ARRAY - - BYTES - - BYTES_ARRAY - - NON_SERIALIZABLE_OBJECT - - JSON_VALUE + - FINAL_STATE_UNSPECIFIED + - SUCCEEDED + - SUSPENDED + GoogleCloudIntegrationsV1alphaCoordinate: + id: GoogleCloudIntegrationsV1alphaCoordinate + description: Configuration detail of coordinate, it used for UI + type: object + properties: + x: + description: Required. X axis of the coordinate + type: integer + format: int32 + 'y': + description: Required. Y axis of the coordinate + type: integer + format: int32 + EnterpriseCrmFrontendsEventbusProtoTriggerConfig: + id: EnterpriseCrmFrontendsEventbusProtoTriggerConfig + description: 'Configuration detail of a trigger. Next available id: 22' + type: object + properties: + label: + description: The user created label for a particular trigger. + type: string + startTasks: description: >- - Option to specify key value type for all entries of the map. If - provided then field types for all entries must conform to this. + Set of tasks numbers from where the workflow execution is started by + this trigger. If this is empty, then workflow is executed with + default start tasks. In the list of start tasks, none of two tasks + can have direct ancestor-descendant relationships (i.e. in a same + workflow execution graph). + type: array + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoNextTask' + properties: + description: >- + Configurable properties of the trigger, not to be confused with + workflow parameters. E.g. "name" is a property for API triggers and + "subscription" is a property for Cloud Pubsub triggers. + type: object + additionalProperties: + type: string + triggerType: type: string - valueType: enumDescriptions: - '' - '' @@ -5329,960 +4476,1027 @@ components: - '' - '' - '' - - >- - BYTES and BYTES_ARRAY data types are not allowed for top-level - params. They're only meant to support protobufs with BYTES - (sub)fields. - - '' - '' - '' - type: string enum: - - DATA_TYPE_UNSPECIFIED - - STRING_VALUE - - INT_VALUE - - DOUBLE_VALUE - - BOOLEAN_VALUE - - PROTO_VALUE - - SERIALIZED_OBJECT_VALUE - - STRING_ARRAY - - INT_ARRAY - - DOUBLE_ARRAY - - PROTO_ARRAY - - PROTO_ENUM - - BOOLEAN_ARRAY - - PROTO_ENUM_ARRAY - - BYTES - - BYTES_ARRAY - - NON_SERIALIZABLE_OBJECT - - JSON_VALUE - entries: + - UNKNOWN + - CLOUD_PUBSUB + - GOOPS + - SFDC_SYNC + - CRON + - API + - MANIFOLD_TRIGGER + - DATALAYER_DATA_CHANGE + - SFDC_CHANNEL + - CLOUD_PUBSUB_EXTERNAL + - SFDC_CDC_CHANNEL + - SFDC_PLATFORM_EVENTS_CHANNEL + - CLOUD_SCHEDULER + - INTEGRATION_CONNECTOR_TRIGGER + - PRIVATE_TRIGGER + - EVENTARC_TRIGGER + position: + description: >- + Optional. Informs the front-end application where to draw this + trigger config on the UI. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCoordinate' + triggerNumber: + description: >- + Required. A number to uniquely identify each trigger config within + the workflow on UI. + type: string + alertConfig: + description: >- + An alert threshold configuration for the [trigger + client + + workflow] tuple. If these values are not specified in the trigger + config, default values will be populated by the system. Note that + there must be exactly one alert threshold configured per [client + + trigger + workflow] when published. type: array items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterMapEntry - id: EnterpriseCrmFrontendsEventbusProtoParameterMap - type: object - description: >- - A generic multi-map that holds key value pairs. They keys and values can - be of any type, unless specified. - EnterpriseCrmEventbusProtoParameterMapField: - description: Field represents either the key or value in an entry. - id: EnterpriseCrmEventbusProtoParameterMapField - properties: - referenceKey: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoWorkflowAlertConfig' + nextTasksExecutionPolicy: + description: Dictates how next tasks will be executed. type: string - description: Referencing one of the WF variables. - literalValue: - description: Passing a literal value. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType' - type: object - EnterpriseCrmEventbusProtoBooleanParameterArray: - properties: - booleanValues: - items: - type: boolean + enumDescriptions: + - Default + - Execute all the tasks that satisfy their associated condition. + - Execute the first task that satisfies the associated condition. + enum: + - UNSPECIFIED + - RUN_ALL_MATCH + - RUN_FIRST_MATCH + enabledClients: + description: >- + Required. The list of client ids which are enabled to execute the + workflow using this trigger. In other words, these clients have the + workflow execution privledges for this trigger. For API trigger, the + client id in the incoming request is validated against the list of + enabled clients. For non-API triggers, one workflow execution is + triggered on behalf of each enabled client. type: array - type: object - id: EnterpriseCrmEventbusProtoBooleanParameterArray - GoogleCloudIntegrationsV1alphaTestIntegrationsRequest: - type: object - description: The request for testing an integration. - id: GoogleCloudIntegrationsV1alphaTestIntegrationsRequest - properties: - inputParameters: - description: Optional. Input parameters used during integration execution. - additionalProperties: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' - type: object - integrationVersion: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion - description: Required. integration config to execute the workflow + items: + type: string + pauseWorkflowExecutions: + description: >- + Optional. If set to true, any upcoming requests for this trigger + config will be paused and the executions will be resumed later when + the flag is reset. The workflow to which this trigger config belongs + has to be in ACTIVE status for the executions to be paused or + resumed. + type: boolean + triggerCriteria: + description: >- + Optional. When set, Eventbus will run the task specified in the + trigger_criteria and validate the result using the + trigger_criteria.condition, and only execute the workflow when + result is true. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTriggerCriteria' triggerId: + description: The backend trigger ID. type: string + description: description: >- - Required. The trigger id of the integration trigger config. If both - trigger_id and client_id is present, the integration is executed - from the start tasks provided by the matching trigger config - otherwise it is executed from the default start tasks. - clientId: - description: >- - Required. This is used to identify the client on whose behalf the - event will be executed. + User-provided description intended to give more business context + about the task. type: string - parameters: - deprecated: true - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters - description: Optional. Passed in as parameters to each integration execution. - configParameters: - type: object - additionalProperties: - type: any - description: Properties of the object. - description: Optional. Config parameters used during integration execution. - deadlineSecondsTime: - description: Optional. custom deadline of the rpc + cloudSchedulerConfig: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCloudSchedulerConfig' + errorCatcherId: + description: >- + Optional Error catcher id of the error catch flow which will be + executed when execution error happens in the task type: string - format: google-datetime - testMode: + triggerName: description: >- - Optional. Can be specified in the event request, otherwise false - (default). If true, enables tasks with condition "test_mode = true". - If false, disables tasks with condition "test_mode = true" if global - test mode (set by platform) is also false {@link EventBusConfig}. - type: boolean - GoogleCloudIntegrationsV1alphaIntegrationAlertConfigThresholdValue: - type: object - description: >- - The threshold value of the metric, above or below which the alert should - be triggered. See EventAlertConfig or TaskAlertConfig for the different - alert metric types in each case. For the *RATE metrics, one or both of - these fields may be set. Zero is the default value and can be left at - that. For *PERCENTILE_DURATION metrics, one or both of these fields may - be set, and also, the duration threshold value should be specified in - the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, - these fields should not be set at all. A different member, - threshold_duration_ms, must be set in the EventAlertConfig or the - TaskAlertConfig. - id: GoogleCloudIntegrationsV1alphaIntegrationAlertConfigThresholdValue - properties: - percentage: - format: int32 - type: integer - description: Percentage threshold. - absolute: - format: int64 + Optional. Name of the trigger This is added to identify the type of + trigger. This is avoid the logic on triggerId to identify the + trigger_type and push the same to monitoring. type: string - description: Absolute value threshold. - EnterpriseCrmEventbusProtoJsonFunction: - id: EnterpriseCrmEventbusProtoJsonFunction - properties: - functionName: + inputVariables: + description: Optional. List of input variables for the api trigger. + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoTriggerConfigVariables + outputVariables: + description: Optional. List of output variables for the api trigger. + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoTriggerConfigVariables + EnterpriseCrmEventbusProtoWorkflowAlertConfig: + id: EnterpriseCrmEventbusProtoWorkflowAlertConfig + description: >- + Message to be used to configure custom alerting in the {@code + EventConfig} protos for an event. + type: object + properties: + alertName: + description: >- + A name to identify this alert. This will be displayed in the alert + subject. If set, this name should be unique within the scope of the + workflow. + type: string + metricType: type: string + enumDescriptions: + - >- + The default value. Metric type should always be set to one of the + other non-default values, otherwise it will result in an + INVALID_ARGUMENT error. + - >- + Specifies alerting on the rate of errors for the enclosing + workflow. + - >- + Specifies alerting on the rate of warnings for the enclosing + workflow. Warnings use the same enum values as errors. + - >- + Specifies alerting on the rate of errors for any task in the + enclosing workflow. + - >- + Specifies alerting on the rate of warnings for any task in the + enclosing workflow. + - >- + Specifies alerting on the rate of executions over all tasks in the + enclosing workflow. + - >- + Specifies alerting on the number of events executed in the given + aggregation_period. + - >- + Specifies alerting on the average duration of executions for this + workflow. + - >- + Specifies alerting on the duration value of a particular + percentile of workflow executions. E.g. If 10% or more of the + workflow executions have durations above 5 seconds, alert. + - >- + Specifies alerting on the average duration of any task in the + enclosing workflow, + - >- + Specifies alerting on the duration value of a particular + percentile of any task executions within the enclosing workflow. + E.g. If 10% or more of the task executions in the workflow have + durations above 5 seconds, alert. enum: - - UNSPECIFIED - - GET_PROPERTY - - GET_ELEMENT - - APPEND_ELEMENT - - SIZE - - SET_PROPERTY - - FLATTEN - - FLATTEN_ONCE - - MERGE - - TO_STRING - - TO_INT - - TO_DOUBLE - - TO_BOOLEAN - - TO_PROTO - - TO_STRING_ARRAY - - TO_INT_ARRAY - - TO_DOUBLE_ARRAY - - TO_PROTO_ARRAY - - TO_BOOLEAN_ARRAY - - REMOVE_PROPERTY - - RESOLVE_TEMPLATE - - EQUALS - - FOR_EACH - - FILTER_ELEMENTS + - METRIC_TYPE_UNSPECIFIED + - EVENT_ERROR_RATE + - EVENT_WARNING_RATE + - TASK_ERROR_RATE + - TASK_WARNING_RATE + - TASK_RATE + - EVENT_RATE + - EVENT_AVERAGE_DURATION + - EVENT_PERCENTILE_DURATION + - TASK_AVERAGE_DURATION + - TASK_PERCENTILE_DURATION + thresholdType: + description: >- + The threshold type, whether lower(expected_min) or + upper(expected_max), for which this alert is being configured. If + value falls below expected_min or exceeds expected_max, an alert + will be fired. + type: string enumDescriptions: - '' + - >- + Note that this field will only trigger alerts if the workflow + specifying it runs at least once in 24 hours (which is our + in-memory retention period for monarch streams). Also note that + `aggregation_period` for this alert configuration must be less + than 24 hours. - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - type: object - GoogleCloudIntegrationsV1alphaTakeoverTestCaseEditLockRequest: - description: Request for TakeoverTestCaseEditLock. - type: object - properties: {} - id: GoogleCloudIntegrationsV1alphaTakeoverTestCaseEditLockRequest - GoogleCloudIntegrationsV1alphaUseTemplateResponse: - description: Response for use template - type: object - properties: - integrationVersion: + enum: + - UNSPECIFIED_THRESHOLD_TYPE + - EXPECTED_MIN + - EXPECTED_MAX + thresholdValue: + description: >- + The metric value, above or below which the alert should be + triggered. $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion - description: IntegrationVersion which is created. - subIntegrationVersions: - description: Sub integration versions which are created. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion - id: GoogleCloudIntegrationsV1alphaUseTemplateResponse - GoogleCloudIntegrationsV1alphaResolveSuspensionRequest: - id: GoogleCloudIntegrationsV1alphaResolveSuspensionRequest - properties: - suspension: + #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue + durationThresholdMs: description: >- - Suspension, containing the event_execution_info_id, task_id, and - state to set on the corresponding suspension record. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSuspension' - type: object - description: Request for [Suspensions.ResolveSuspensions]. - EnterpriseCrmEventbusProtoConnectorsConnection: - id: EnterpriseCrmEventbusProtoConnectorsConnection - type: object - properties: - connectionName: + Should be specified only for *AVERAGE_DURATION and + *PERCENTILE_DURATION metrics. This member should be used to specify + what duration value the metrics should exceed for the alert to + trigger. type: string + format: int64 + errorEnumList: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList + warningEnumList: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList + aggregationPeriod: description: >- - Connection name Format: - projects/{project}/locations/{location}/connections/{connection} - serviceName: - description: >- - Service name Format: - projects/{project}/locations/{location}/namespaces/{namespace}/services/{service} + For an EXPECTED_MIN threshold, this aggregation_period must be + lesser than 24 hours. type: string - host: + numAggregationPeriods: description: >- - The name of the Hostname of the Service Directory service with TLS - if used. + For how many contiguous aggregation periods should the expected min + or max be violated for the alert to be fired. + type: integer + format: int32 + alertDisabled: + description: >- + Set to false by default. When set to true, the metrics are not + aggregated or pushed to Monarch for this workflow alert. + type: boolean + clientId: + description: Client associated with this alert configuration. type: string - connectorVersion: + onlyFinalAttempt: description: >- - Connector version Format: - projects/{project}/locations/{location}/providers/{provider}/connectors/{connector}/versions/{version} + For either events or tasks, depending on the type of alert, count + only final attempts, not retries. + type: boolean + playbookUrl: + description: >- + Link to a playbook for resolving the issue that triggered this + alert. type: string - GoogleCloudConnectorsV1ConnectorVersionInfraConfig: - description: >- - This cofiguration provides infra configs like rate limit threshold which - need to be configurable for every connector version + EnterpriseCrmEventbusProtoTriggerCriteria: + id: EnterpriseCrmEventbusProtoTriggerCriteria + type: object properties: - connectionRatelimitWindowSeconds: - format: int64 - type: string + triggerCriteriaTaskImplementationClassName: description: >- - Output only. The window used for ratelimiting runtime requests to - connections. - readOnly: true - resourceRequests: - readOnly: true - description: Output only. System resource requests. - $ref: '#/components/schemas/GoogleCloudConnectorsV1ResourceRequests' - internalclientRatelimitThreshold: - format: int64 + Optional. Implementation class name. The class should implement the + “TypedTask” interface. + type: string + parameters: + description: Optional. To be used in TaskConfig for the implementation class. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' + condition: description: >- - Output only. Max QPS supported for internal requests originating - from Connd. - readOnly: true + Required. Standard filter expression, when true the workflow will be + executed. If there's no + trigger_criteria_task_implementation_class_name specified, the + condition will be validated directly. type: string - tlsMigrationState: - enum: - - TLS_MIGRATION_STATE_UNSPECIFIED - - TLS_MIGRATION_NOT_STARTED - - TLS_MIGRATION_COMPLETED - readOnly: true - enumDescriptions: - - TLS migration state is not specified. - - TLS migration is in progress. - - TLS migration is completed. - type: string - description: Output only. Status of the TLS migration. - deploymentModelMigrationState: - enum: - - DEPLOYMENT_MODEL_MIGRATION_STATE_UNSPECIFIED - - IN_PROGRESS - - COMPLETED - - ROLLEDBACK - - ROLLBACK_IN_PROGRESS - description: Output only. Status of the deployment model migration. - type: string - readOnly: true - enumDescriptions: - - Deployment model migration state is not specified. - - Deployment model migration is in progress. - - Deployment model migration is completed. - - Deployment model migration rolledback. - - Deployment model migration rollback in progress. - resourceLimits: - readOnly: true - $ref: '#/components/schemas/GoogleCloudConnectorsV1ResourceLimits' - description: Output only. System resource limits. - ratelimitThreshold: - readOnly: true - type: string - description: >- - Output only. Max QPS supported by the connector version before - throttling of requests. - format: int64 - maxInstanceRequestConcurrency: - type: integer - format: int32 - description: Output only. Max instance request concurrency. - readOnly: true - hpaConfig: - description: Output only. HPA autoscaling config. - readOnly: true - $ref: '#/components/schemas/GoogleCloudConnectorsV1HPAConfig' - sharedDeployment: - description: Output only. The name of shared connector deployment. - type: string - readOnly: true - deploymentModel: - type: string - enumDescriptions: - - Deployment model is not specified. - - Default model gke mst. - - Cloud run mst. - description: Optional. Indicates whether connector is deployed on GKE/CloudRun - enum: - - DEPLOYMENT_MODEL_UNSPECIFIED - - GKE_MST - - CLOUD_RUN_MST - id: GoogleCloudConnectorsV1ConnectorVersionInfraConfig - type: object - EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleDoubleRange: - properties: - min: - format: double - type: number - description: The inclusive minimum of the acceptable range. - max: - type: number - format: double - description: The inclusive maximum of the acceptable range. - description: Range used to validate doubles and floats. + EnterpriseCrmEventbusProtoEventParameters: + id: EnterpriseCrmEventbusProtoEventParameters + description: >- + LINT.IfChange This message is used for processing and persisting (when + applicable) key value pair parameters for each event in the event bus. + Please see type: object - id: EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleDoubleRange - GoogleCloudIntegrationsV1alphaEnumerateConnectorPlatformRegionsResponse: - id: GoogleCloudIntegrationsV1alphaEnumerateConnectorPlatformRegionsResponse properties: - regions: + parameters: + description: >- + Parameters are a part of Event and can be used to communicate + between different tasks that are part of the same integration + execution. type: array items: - type: string - description: All regions where Connector Platform is provisioned. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterEntry' + EnterpriseCrmEventbusProtoParameterEntry: + id: EnterpriseCrmEventbusProtoParameterEntry + description: Key-value pair of EventBus parameters. type: object - description: Response containing all provisioned regions for Connector Platform. - GoogleCloudIntegrationsV1alphaIntegrationConfigParameter: - id: GoogleCloudIntegrationsV1alphaIntegrationConfigParameter properties: + key: + description: >- + Key is used to retrieve the corresponding parameter value. This + should be unique for a given fired event. These parameters must be + predefined in the integration definition. + type: string value: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' description: >- Values for the defined keys. Each value can either be string, int, - double or any proto message or a serialized object. - parameter: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationParameter - description: >- - Optional. Integration Parameter to provide the default value, data - type and attributes required for the Integration config variables. - type: object + double or any proto message. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType' + masked: + description: True if this parameter should be masked in the logs + type: boolean + EnterpriseCrmEventbusProtoParameterValueType: + id: EnterpriseCrmEventbusProtoParameterValueType description: >- - Integration Config Parameter is defined in the integration config and - are used to provide external configuration for integration. It provide - information about data types of the expected parameters and provide any - default values or value. They can also be used to add custom attributes. - EnterpriseCrmEventbusProtoNextTask: + LINT.IfChange To support various types of parameter values. Next + available id: 14 type: object - description: >- - The task that is next in line to be executed, if the condition specified - evaluated to true. - id: EnterpriseCrmEventbusProtoNextTask properties: - label: - description: User-provided label that is attached to this edge in the UI. - type: string - description: - type: string - description: >- - User-provided description intended to give more business context - about the next task edge or condition. - combinedConditions: - type: array - description: >- - Combined condition for this task to become an eligible next task. - Each of these combined_conditions are joined with logical OR. - DEPRECATED: use `condition` - deprecated: true - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCombinedCondition' - taskConfigId: - description: ID of the next task. - type: string - taskNumber: + stringValue: type: string - description: Task number of the next task. - condition: - description: >- - Standard filter expression for this task to become an eligible next - task. + intValue: type: string - GoogleCloudIntegrationsV1alphaFile: - properties: - integrationConfig: - description: Integration version config file + format: int64 + doubleValue: + type: number + format: double + booleanValue: + type: boolean + protoValue: + type: object additionalProperties: - description: Properties of the object. type: any - type: object - type: - type: string - enum: - - INTEGRATION_FILE_UNSPECIFIED - - INTEGRATION - - INTEGRATION_CONFIG_VARIABLES - enumDescriptions: - - Default value. - - Integration file. - - Integration Config variables. - description: >- - File information like Integration version, Integration Config - variables etc. - integrationVersion: - description: Integration version + description: Properties of the object. Contains field @type with type URL. + serializedObjectValue: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion - description: >- - To store Integration version related file i.e. Integration Version, - Config variable etc. + #/components/schemas/EnterpriseCrmEventbusProtoSerializedObjectParameter + stringArray: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoStringParameterArray' + intArray: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoIntParameterArray' + doubleArray: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoDoubleParameterArray' + protoArray: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoProtoParameterArray' + booleanArray: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBooleanParameterArray' + EnterpriseCrmEventbusProtoSerializedObjectParameter: + id: EnterpriseCrmEventbusProtoSerializedObjectParameter type: object - id: GoogleCloudIntegrationsV1alphaFile - GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest: properties: - configParameters: - description: Optional. Config parameters used during integration execution. - type: object - additionalProperties: - type: any - description: Properties of the object. - id: GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest + objectValue: + type: string + format: byte + EnterpriseCrmEventbusProtoStringParameterArray: + id: EnterpriseCrmEventbusProtoStringParameterArray type: object - description: Request for PublishIntegrationVersion. - EnterpriseCrmFrontendsEventbusProtoParameterMapField: + properties: + stringValues: + type: array + items: + type: string + EnterpriseCrmEventbusProtoIntParameterArray: + id: EnterpriseCrmEventbusProtoIntParameterArray type: object - id: EnterpriseCrmFrontendsEventbusProtoParameterMapField properties: - referenceKey: - type: string - description: Referencing one of the WF variables. - literalValue: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterValueType - description: Passing a literal value. - description: Field represents either the key or value in an entry. - GoogleCloudConnectorsV1BillingConfig: - description: Billing config for the connection. + intValues: + type: array + items: + type: string + format: int64 + EnterpriseCrmEventbusProtoDoubleParameterArray: + id: EnterpriseCrmEventbusProtoDoubleParameterArray type: object - id: GoogleCloudConnectorsV1BillingConfig properties: - billingCategory: - readOnly: true - type: string - enum: - - BILLING_CATEGORY_UNSPECIFIED - - GCP_AND_TECHNICAL_CONNECTOR - - NON_GCP_CONNECTOR - description: Output only. Billing category for the connector. - enumDescriptions: - - Billing category is not specified. - - GCP/Technical connector. - - Non-GCP connector. - GoogleCloudConnectorsV1AuthConfigOauth2JwtBearerJwtClaims: + doubleValues: + type: array + items: + type: number + format: double + EnterpriseCrmEventbusProtoProtoParameterArray: + id: EnterpriseCrmEventbusProtoProtoParameterArray + type: object properties: - audience: - type: string - description: Value for the "aud" claim. - subject: - description: Value for the "sub" claim. - type: string - issuer: - type: string - description: Value for the "iss" claim. - description: JWT claims used for the jwt-bearer authorization grant. - id: GoogleCloudConnectorsV1AuthConfigOauth2JwtBearerJwtClaims + protoValues: + type: array + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + EnterpriseCrmEventbusProtoBooleanParameterArray: + id: EnterpriseCrmEventbusProtoBooleanParameterArray type: object - GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlow: + properties: + booleanValues: + type: array + items: + type: boolean + EnterpriseCrmEventbusProtoCloudSchedulerConfig: + id: EnterpriseCrmEventbusProtoCloudSchedulerConfig + description: Cloud Scheduler Trigger configuration type: object properties: - pkceVerifier: - description: PKCE verifier to be used during the auth code exchange. - type: string - clientSecret: - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' - description: Client secret for user-provided OAuth app. - enablePkce: - description: Whether to enable PKCE when the user performs the auth code flow. - type: boolean - redirectUri: - type: string - description: Redirect URI to be provided during the auth code exchange. - clientId: + serviceAccountEmail: + description: >- + Required. Service account used by Cloud Scheduler to trigger the + integration at scheduled time type: string - description: Client ID for user-provided OAuth app. - authUri: + cronTab: + description: Required. The cron tab of cloud scheduler trigger. type: string - description: Auth URL for Authorization Code Flow - scopes: - type: array + location: description: >- - Scopes the connection will request when the user performs the auth - code flow. - items: - type: string - authCode: - description: Authorization code to be exchanged for access and refresh tokens. + Required. The location where associated cloud scheduler job will be + created type: string - description: >- - Parameters to support Oauth 2.0 Auth Code Grant Authentication. See - https://www.rfc-editor.org/rfc/rfc6749#section-1.3.1 for more details. - id: GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlow - GoogleCloudIntegrationsV1alphaUseTemplateRequest: - id: GoogleCloudIntegrationsV1alphaUseTemplateRequest - properties: - subIntegrations: - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails - description: Optional. Sub Integration which would be created via templates. - type: object - integrationRegion: + errorMessage: + description: >- + Optional. When the job was deleted from Pantheon UI, error_message + will be populated when Get/List integrations type: string - description: Required. The region of the Integration to be created. - integrationDetails: - description: Required. Integration details which would be created via templates. - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails - type: object - description: Request to Use template - GoogleCloudIntegrationsV1alphaSwitchVariableMaskingRequest: - description: Request to enable/disable variable masking for a provisioned client + EnterpriseCrmFrontendsEventbusProtoTriggerConfigVariables: + id: EnterpriseCrmFrontendsEventbusProtoTriggerConfigVariables + description: Variables names mapped to api trigger. type: object properties: - enableVariableMasking: - type: boolean - description: >- - Required. REQUIRED: True if variable masking feature should be - turned on for this region - id: GoogleCloudIntegrationsV1alphaSwitchVariableMaskingRequest - EnterpriseCrmEventbusProtoConditionalFailurePolicies: + names: + description: Optional. List of variable names. + type: array + items: + type: string + GoogleCloudIntegrationsV1alphaTriggerConfig: + id: GoogleCloudIntegrationsV1alphaTriggerConfig + description: Configuration detail of a trigger. type: object properties: - defaultFailurePolicy: + label: + description: Optional. The user created label for a particular trigger. + type: string + startTasks: description: >- - The default failure policy to be applied if no conditional failure - policy matches - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFailurePolicy' - failurePolicies: + Optional. Set of tasks numbers from where the integration execution + is started by this trigger. If this is empty, then integration is + executed with default start tasks. In the list of start tasks, none + of two tasks can have direct ancestor-descendant relationships (i.e. + in a same integration execution graph). type: array items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFailurePolicy' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaNextTask' + properties: description: >- - The list of failure policies that will be applied to the task in - order. - id: EnterpriseCrmEventbusProtoConditionalFailurePolicies - EnterpriseCrmEventbusProtoParameterEntry: - properties: - key: + Optional. Configurable properties of the trigger, not to be confused + with integration parameters. E.g. "name" is a property for API + triggers and "subscription" is a property for Pub/sub triggers. + type: object + additionalProperties: + type: string + triggerType: + description: Optional. Type of trigger type: string + enumDescriptions: + - Unknown. + - Trigger by scheduled time. + - Trigger by API call. + - Trigger by Salesforce Channel. + - Trigger by Pub/Sub external. + - SFDC Channel Trigger for CDC. + - Trigger by Cloud Scheduler job. + - Trigger by Connector Event + - Trigger for private workflow + - Trigger by cloud pub/sub for internal ip + - Trigger by Eventarc + enum: + - TRIGGER_TYPE_UNSPECIFIED + - CRON + - API + - SFDC_CHANNEL + - CLOUD_PUBSUB_EXTERNAL + - SFDC_CDC_CHANNEL + - CLOUD_SCHEDULER + - INTEGRATION_CONNECTOR_TRIGGER + - PRIVATE_TRIGGER + - CLOUD_PUBSUB + - EVENTARC_TRIGGER + triggerNumber: description: >- - Key is used to retrieve the corresponding parameter value. This - should be unique for a given fired event. These parameters must be - predefined in the integration definition. - value: - description: >- - Values for the defined keys. Each value can either be string, int, - double or any proto message. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType' - masked: - type: boolean - description: True if this parameter should be masked in the logs - description: Key-value pair of EventBus parameters. - type: object - id: EnterpriseCrmEventbusProtoParameterEntry - GoogleCloudIntegrationsV1alphaTestTaskConfig: - description: >- - The task mock configuration details and assertions for functional tests. - Next available id: 6 - id: GoogleCloudIntegrationsV1alphaTestTaskConfig - type: object - properties: - assertions: + Required. A number to uniquely identify each trigger config within + the integration on UI. + type: string + alertConfig: description: >- - Optional. List of conditions or expressions which should be - evaluated to true unless there is a bug/problem in the integration. - These are evaluated one the task execution is completed as per the - mock strategy in test case - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAssertion' + Optional. An alert threshold configuration for the [trigger + client + + integration] tuple. If these values are not specified in the + trigger config, default values will be populated by the system. Note + that there must be exactly one alert threshold configured per + [client + trigger + integration] when published. type: array - mockConfig: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaMockConfig' - description: Optional. Defines how to mock the given task during test execution - taskConfig: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTaskConfig' - description: Optional. Auto-generated. - taskNumber: + items: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationAlertConfig + nextTasksExecutionPolicy: + description: Optional. Dictates how next tasks will be executed. type: string + enumDescriptions: + - Default. + - Execute all the tasks that satisfy their associated condition. + - Execute the first task that satisfies the associated condition. + enum: + - NEXT_TASKS_EXECUTION_POLICY_UNSPECIFIED + - RUN_ALL_MATCH + - RUN_FIRST_MATCH + triggerId: description: >- - Required. This defines in the test case, the task in integration - which will be mocked by this test task config - task: + Optional. Auto-generated trigger ID. The ID is based on the + properties that you define in the trigger config. For example, for + an API trigger, the trigger ID follows the format: + api_trigger/TRIGGER_NAME Where trigger config has properties with + value {"Trigger name": TRIGGER_NAME} + type: string + description: description: >- - Required. This defines in the test case, the task name in - integration which will be mocked by this test task config + Optional. User-provided description intended to give additional + business context about the task. type: string - EnterpriseCrmFrontendsEventbusProtoParameterValueType: - id: EnterpriseCrmFrontendsEventbusProtoParameterValueType - type: object - description: 'To support various types of parameter values. Next available id: 14' - properties: - protoArray: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoProtoParameterArray - serializedObjectValue: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoSerializedObjectParameter - stringArray: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoStringParameterArray - doubleArray: + cloudSchedulerConfig: + description: Optional. Cloud Scheduler Trigger related metadata $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoDoubleParameterArray - jsonValue: - type: string - booleanValue: - type: boolean - intValue: + #/components/schemas/GoogleCloudIntegrationsV1alphaCloudSchedulerConfig + errorCatcherId: + description: >- + Optional. Optional Error catcher id of the error catch flow which + will be executed when execution error happens in the task type: string - format: int64 - stringValue: + position: + description: >- + Optional. Informs the front-end application where to draw this error + catcher config on the UI. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCoordinate' + trigger: + description: >- + Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub + Sub Trigger" When set will be sent out to monitoring dashabord for + tracking purpose. type: string - doubleValue: - format: double - type: number - intArray: + inputVariables: + description: Optional. List of input variables for the api trigger. $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoIntParameterArray - booleanArray: + #/components/schemas/GoogleCloudIntegrationsV1alphaTriggerConfigVariables + outputVariables: + description: Optional. List of output variables for the api trigger. $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoBooleanParameterArray - protoValue: - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: object - EnterpriseCrmEventbusProtoEventExecutionSnapshot: + #/components/schemas/GoogleCloudIntegrationsV1alphaTriggerConfigVariables + GoogleCloudIntegrationsV1alphaIntegrationAlertConfig: + id: GoogleCloudIntegrationsV1alphaIntegrationAlertConfig + description: >- + Message to be used to configure custom alerting in the {@code + EventConfig} protos for an event. + type: object properties: - eventParams: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' - description: The parameters in Event object. - exceedMaxSize: - description: indicate whether snapshot exceeded maximum size before clean up - type: boolean - clientId: - description: Client that the execution snapshot is associated to. - type: string - snapshotTime: - type: string - description: Indicates when this snapshot is taken. - format: int64 - workflowName: + displayName: + description: >- + Name of the alert. This will be displayed in the alert subject. If + set, this name should be unique within the scope of the integration. type: string - description: Name of the workflow this event execution snapshot belongs to. - taskName: + metricType: + description: The type of metric. type: string - description: The task name associated with this snapshot. Could be empty. - deprecated: true - eventExecutionSnapshotId: + enumDescriptions: + - >- + The default value. Metric type should always be set to one of the + other non-default values, otherwise it will result in an + INVALID_ARGUMENT error. + - >- + Specifies alerting on the rate of errors for the enclosing + integration. + - >- + Specifies alerting on the rate of warnings for the enclosing + integration. Warnings use the same enum values as errors. + - >- + Specifies alerting on the rate of errors for any task in the + enclosing integration. + - >- + Specifies alerting on the rate of warnings for any task in the + enclosing integration. + - >- + Specifies alerting on the rate of executions over all tasks in the + enclosing integration. + - >- + Specifies alerting on the number of events executed in the given + aggregation_period. + - >- + Specifies alerting on the average duration of executions for this + integration. + - >- + Specifies alerting on the duration value of a particular + percentile of integration executions. E.g. If 10% or more of the + integration executions have durations above 5 seconds, alert. + - >- + Specifies alerting on the average duration of any task in the + enclosing integration, + - >- + Specifies alerting on the duration value of a particular + percentile of any task executions within the enclosing + integration. E.g. If 10% or more of the task executions in the + integration have durations above 5 seconds, alert. + enum: + - METRIC_TYPE_UNSPECIFIED + - EVENT_ERROR_RATE + - EVENT_WARNING_RATE + - TASK_ERROR_RATE + - TASK_WARNING_RATE + - TASK_RATE + - EVENT_RATE + - EVENT_AVERAGE_DURATION + - EVENT_PERCENTILE_DURATION + - TASK_AVERAGE_DURATION + - TASK_PERCENTILE_DURATION + thresholdType: description: >- - Auto-generated. Used as primary key for EventExecutionSnapshots - table. - type: string - checkpointTaskNumber: + The threshold type, whether lower(expected_min) or + upper(expected_max), for which this alert is being configured. If + value falls below expected_min or exceeds expected_max, an alert + will be fired. type: string + enumDescriptions: + - Default. + - >- + Note that this field will only trigger alerts if the integration + specifying it runs at least once in 24 hours (which is our + in-memory retention period for monarch streams). Also note that + `aggregation_period` for this alert configuration must be less + than 24 hours. Min value threshold. + - Max value threshold. + enum: + - THRESHOLD_TYPE_UNSPECIFIED + - EXPECTED_MIN + - EXPECTED_MAX + thresholdValue: description: >- - Indicates "right after which checkpoint task's execution" this - snapshot is taken. - eventExecutionSnapshotMetadata: + The metric value, above or below which the alert should be + triggered. $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata - conditionResults: - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoConditionResult' - type: array - description: All of the computed conditions that been calculated. - eventExecutionInfoId: + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationAlertConfigThresholdValue + durationThreshold: + description: >- + Should be specified only for *AVERAGE_DURATION and + *PERCENTILE_DURATION metrics. This member should be used to specify + what duration value the metrics should exceed for the alert to + trigger. type: string - description: Points to the event execution info this snapshot belongs to. - diffParams: - description: The parameters in Event object that differs from last snapshot. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' - taskExecutionDetails: - description: All of the task execution details at the given point of time. - items: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoTaskExecutionDetails - type: array - type: object + format: google-duration + aggregationPeriod: + description: >- + The period over which the metric value should be aggregated and + evaluated. Format is , where integer should be a positive integer + and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, + day, week). For an EXPECTED_MIN threshold, this aggregation_period + must be lesser than 24 hours. + type: string + alertThreshold: + description: >- + For how many contiguous aggregation periods should the expected min + or max be violated for the alert to be fired. + type: integer + format: int32 + disableAlert: + description: >- + Set to false by default. When set to true, the metrics are not + aggregated or pushed to Monarch for this integration alert. + type: boolean + onlyFinalAttempt: + description: >- + For either events or tasks, depending on the type of alert, count + only final attempts, not retries. + type: boolean + GoogleCloudIntegrationsV1alphaIntegrationAlertConfigThresholdValue: + id: GoogleCloudIntegrationsV1alphaIntegrationAlertConfigThresholdValue description: >- - Contains the snapshot of the event execution for a given checkpoint. - Next available id: 15 - id: EnterpriseCrmEventbusProtoEventExecutionSnapshot - EnterpriseCrmEventbusProtoCoordinate: + The threshold value of the metric, above or below which the alert should + be triggered. See EventAlertConfig or TaskAlertConfig for the different + alert metric types in each case. For the *RATE metrics, one or both of + these fields may be set. Zero is the default value and can be left at + that. For *PERCENTILE_DURATION metrics, one or both of these fields may + be set, and also, the duration threshold value should be specified in + the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, + these fields should not be set at all. A different member, + threshold_duration_ms, must be set in the EventAlertConfig or the + TaskAlertConfig. + type: object properties: - x: - format: int32 - type: integer - 'y': + absolute: + description: Absolute value threshold. + type: string + format: int64 + percentage: + description: Percentage threshold. type: integer format: int32 + GoogleCloudIntegrationsV1alphaCloudSchedulerConfig: + id: GoogleCloudIntegrationsV1alphaCloudSchedulerConfig + description: Cloud Scheduler Trigger configuration type: object - description: Represents two-dimensional positions. - id: EnterpriseCrmEventbusProtoCoordinate - GoogleCloudIntegrationsV1alphaExecution: - type: object - id: GoogleCloudIntegrationsV1alphaExecution properties: - triggerId: + serviceAccountEmail: description: >- - The trigger id of the integration trigger config. If both trigger_id - and client_id is present, the integration is executed from the start - tasks provided by the matching trigger config otherwise it is - executed from the default start tasks. - type: string - executionMethod: + Required. Service account used by Cloud Scheduler to trigger the + integration at scheduled time type: string - enumDescriptions: - - Default value. - - Sync post. - - Async post. - - Async post with schedule time. - enum: - - EXECUTION_METHOD_UNSPECIFIED - - POST - - POST_TO_QUEUE - - SCHEDULE - description: The ways user posts this event. - updateTime: + cronTab: + description: Required. The cron tab of cloud scheduler trigger. type: string - readOnly: true - description: Output only. Last modified time of the execution. - format: google-datetime - snapshotNumber: - type: string - format: int64 + location: description: >- - Output only. An increasing sequence that is set when a new snapshot - is created - readOnly: true - eventExecutionDetails: - description: The execution info about this event. - deprecated: true - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventExecutionDetails' - createTime: - readOnly: true - format: google-datetime - type: string - description: Output only. Created time of the execution. - cloudLoggingDetails: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaCloudLoggingDetails - description: Cloud Logging details for the integration version - name: + Required. The location where associated cloud scheduler job will be + created type: string - description: Auto-generated primary key. - requestParameters: - description: Event parameters come in as part of the request. - additionalProperties: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' - type: object - replayInfo: - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaExecutionReplayInfo - description: Output only. Replay info for the execution - responseParameters: + errorMessage: description: >- - Event parameters returned as part of the response. In the case of - error, the `ErrorInfo` field is returned in the following format: { - "ErrorInfo": { "message": String, "code": Number } } - additionalProperties: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' - type: object - integrationVersionState: - enum: - - INTEGRATION_STATE_UNSPECIFIED - - DRAFT - - ACTIVE - - ARCHIVED - - SNAPSHOT - readOnly: true - description: Output only. State of the integration version + Optional. When the job was deleted from Pantheon UI, error_message + will be populated when Get/List integrations type: string - enumDescriptions: - - Default. - - Draft. - - Active. - - Archived. - - Snapshot. - directSubExecutions: - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaExecution' + GoogleCloudIntegrationsV1alphaTriggerConfigVariables: + id: GoogleCloudIntegrationsV1alphaTriggerConfigVariables + description: Variables names mapped to api trigger. + type: object + properties: + names: + description: Optional. List of variable names. type: array - description: Direct sub executions of the following Execution. - executionDetails: - description: Detailed info of this execution. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaExecutionDetails' - responseParams: items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry - deprecated: true + type: string + EnterpriseCrmFrontendsEventbusProtoWorkflowParameters: + id: EnterpriseCrmFrontendsEventbusProtoWorkflowParameters + description: >- + LINT.IfChange This is the frontend version of WorkflowParameters. It's + exactly like the backend version except that instead of flattening + protobuf parameters and treating every field and subfield of a protobuf + parameter as a separate parameter, the fields/subfields of a protobuf + parameter will be nested as "children" (see 'children' field below) + parameters of the parent parameter. Please refer to + enterprise/crm/eventbus/proto/workflow_parameters.proto for more + information about WorkflowParameters. + type: object + properties: + parameters: + description: >- + Parameters are a part of Event and can be used to communiticate + between different tasks that are part of the same workflow + execution. type: array - requestParams: items: $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry - description: Event parameters come in as part of the request. - type: array - deprecated: true - description: >- - The Execution resource contains detailed information of an individual - integration execution. - EnterpriseCrmEventbusProtoNextTeardownTask: - id: EnterpriseCrmEventbusProtoNextTeardownTask - properties: - name: - description: Required. Name of the next teardown task. - type: string - type: object - description: >- - The teardown task that is next in line to be executed. We support only - sequential execution of teardown tasks (i.e. no branching). - EnterpriseCrmEventbusProtoSuspensionResolutionInfo: + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry + EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry: + id: EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry type: object - id: EnterpriseCrmEventbusProtoSuspensionResolutionInfo properties: - eventExecutionInfoId: - description: Required. ID of the associated execution. - type: string - product: + key: description: >- - Which Google product the suspension belongs to. If not set, the - suspension belongs to Integration Platform by default. + Key is used to retrieve the corresponding parameter value. This + should be unique for a given fired event. These parameters must be + predefined in the workflow definition. + type: string + dataType: + description: The data type of the parameter. + type: string enumDescriptions: - '' - '' - '' - '' - enum: - - UNSPECIFIED_PRODUCT - - IP - - APIGEE - - SECURITY - type: string - externalTraffic: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoExternalTraffic' - description: The origin of the suspension for periodic notifications. - workflowName: - type: string - description: Required. The name of the originating workflow. - status: - enum: - - PENDING_UNSPECIFIED - - REJECTED - - LIFTED - - CANCELED - enumDescriptions: - '' - '' - '' - '' - type: string - clientId: - description: The event data user sends as request. - type: string - cloudKmsConfig: - description: KMS info, used by cmek/gmek integration - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCloudKmsConfig' - taskNumber: - type: string - description: Required. Task number of the associated SuspensionTask. - createdTimestamp: - description: Auto-generated. - type: string - format: google-datetime - suspensionConfig: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoSuspensionConfig' - encryptedSuspensionResolutionInfo: - type: string - format: byte - description: Encrypted SuspensionResolutionInfo - wrappedDek: - description: Wrapped dek - type: string - format: byte - suspensionId: - type: string - description: Primary key for the SuspensionResolutionInfoTable. - audit: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoSuspensionResolutionInfoAudit - lastModifiedTimestamp: - format: google-datetime - type: string - description: Auto-generated. - GoogleCloudIntegrationsV1alphaIntegrationParameter: - description: >- - Integration Parameter is defined in the integration config and are used - to provide information about data types of the expected parameters and - provide any default values if needed. They can also be used to add - custom attributes. These are static in nature and should not be used for - dynamic event definition. - id: GoogleCloudIntegrationsV1alphaIntegrationParameter - type: object - properties: - producer: + - '' + - '' + - '' + - '' + - '' + - '' + - >- + BYTES and BYTES_ARRAY data types are not allowed for top-level + params. They're only meant to support protobufs with BYTES + (sub)fields. + - '' + - '' + - '' + enum: + - DATA_TYPE_UNSPECIFIED + - STRING_VALUE + - INT_VALUE + - DOUBLE_VALUE + - BOOLEAN_VALUE + - PROTO_VALUE + - SERIALIZED_OBJECT_VALUE + - STRING_ARRAY + - INT_ARRAY + - DOUBLE_ARRAY + - PROTO_ARRAY + - PROTO_ENUM + - BOOLEAN_ARRAY + - PROTO_ENUM_ARRAY + - BYTES + - BYTES_ARRAY + - NON_SERIALIZABLE_OBJECT + - JSON_VALUE + protoDefPath: description: >- - The identifier of the node (TaskConfig/TriggerConfig) this parameter - was produced by, if it is a transient param or a copy of an input - param. + If the data type is of type proto or proto array, this field needs + to be populated with the fully qualified proto name. This message, + for example, would be + "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry". type: string - containsLargeData: - type: boolean + defaultValue: description: >- - Indicates whether this variable contains large data and need to be - uploaded to Cloud Storage. - jsonSchema: - type: string + Default values for the defined keys. Each value can either be + string, int, double or any proto message or a serialized object. + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterValueType + attributes: + description: Metadata information about the parameters. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoAttributes' + children: description: >- - This schema will be used to validate runtime JSON-typed values of - this parameter. - isTransient: - type: boolean - description: Whether this parameter is a transient parameter. - displayName: + Child parameters nested within this parameter. This field only + applies to protobuf parameters + type: array + items: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry + name: description: >- The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". type: string + inOutType: + description: Specifies the input/output type for the parameter. + type: string + enumDescriptions: + - '' + - >- + Input parameters for the workflow. EventBus validates that these + parameters exist in the workflows before execution. + - >- + Output Parameters for the workflow. EventBus will only return the + workflow parameters tagged with OUT in the response back. + - >- + Input or Output Parameters. These can be used as both input and + output. EventBus will validate for the existence of these + parameters before execution and will also return this parameter + back in the response. + enum: + - IN_OUT_TYPE_UNSPECIFIED + - IN + - OUT + - IN_OUT + protoDefName: + description: >- + The name of the protobuf type if the parameter has a protobuf data + type. + type: string + isTransient: + description: Whether this parameter is a transient parameter. + type: boolean + producedBy: + description: >- + The identifier of the node (TaskConfig/TriggerConfig) this parameter + was produced by, if it is a transient param or a copy of an input + param. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoNodeIdentifier' + jsonSchema: + description: >- + This schema will be used to validate runtime JSON-typed values of + this parameter. + type: string + producer: + type: string + description: + description: Optional. The description about the parameter + type: string + containsLargeData: + description: >- + Indicates whether this variable contains large data and need to be + uploaded to Cloud Storage. + type: boolean + required: + type: boolean + EnterpriseCrmEventbusProtoAttributes: + id: EnterpriseCrmEventbusProtoAttributes + description: >- + Attributes are additional options that can be associated with each event + property. For more information, see + type: object + properties: + dataType: + description: >- + Things like URL, Email, Currency, Timestamp (rather than string, + int64...) + type: string + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - >- + Domain is a web url string with one top-level private domain and a + suffix (for example: google.com, walmart.com) + enum: + - DATA_TYPE_UNSPECIFIED + - EMAIL + - URL + - CURRENCY + - TIMESTAMP + - DOMAIN_NAME + isRequired: + description: >- + Required for event execution. The validation will be done by the + event bus when the event is triggered. + type: boolean + defaultValue: + description: Used to define defaults. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoValueType' + taskVisibility: + description: List of tasks that can view this property, if empty then all. + type: array + items: + type: string + logSettings: + description: See + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoLogSettings' + isSearchable: + description: >- + Used to indicate if a ParameterEntry should be converted to + ParamIndexes for ST-Spanner full-text search. DEPRECATED: use + searchable. + deprecated: true + type: boolean + searchable: + type: string + enumDescriptions: + - '' + - >- + If yes, the parameter key and value will be full-text indexed. In + a proto, this value will propagate to all children whose + searchable is unspecified. + - >- + If no, the parameter key and value will not be full-text indexed. + In a proto, this value will propagate to all children whose + searchable is unspecified. + enum: + - UNSPECIFIED + - 'YES' + - 'NO' + readOnly: + description: Used to indicate if the ParameterEntry is a read only field or not. + type: boolean + masked: + description: True if this workflow parameter should be masked in the logs + type: boolean + EnterpriseCrmEventbusProtoLogSettings: + id: EnterpriseCrmEventbusProtoLogSettings + description: >- + The LogSettings define the logging attributes for an event property. + These attributes are used to map the property to the parameter in the + log proto. Also used to define scrubbing/truncation behavior and PII + information. + type: object + properties: + logFieldName: + description: >- + The name of corresponding logging field of the event property. If + omitted, assumes the same name as the event property key. + type: string + seedScope: + type: string + enumDescriptions: + - '' + - Hash computations include the event name. + - Hash computations include a time period. + - Hash computations include the param name. + enum: + - SEED_SCOPE_UNSPECIFIED + - EVENT_NAME + - TIME_PERIOD + - PARAM_NAME + seedPeriod: + type: string + enumDescriptions: + - '' + - Sanitized values remain constant for the day of the event. + - >- + Sanitized values remain constant for the week of the event; may + cross month boundaries. + - Sanitized values remain constant for the month of the event. + enum: + - SEED_PERIOD_UNSPECIFIED + - DAY + - WEEK + - MONTH + EnterpriseCrmEventbusProtoNodeIdentifier: + id: EnterpriseCrmEventbusProtoNodeIdentifier + description: 'Represents a node identifier (type + id). Next highest id: 3' + type: object + properties: + elementType: + description: Destination node where the edge ends. It can only be a task config. + type: string + enumDescriptions: + - '' + - '' + - '' + enum: + - UNKNOWN_TYPE + - TASK_CONFIG + - TRIGGER_CONFIG + elementIdentifier: + description: Configuration of the edge. + type: string + GoogleCloudIntegrationsV1alphaIntegrationParameter: + id: GoogleCloudIntegrationsV1alphaIntegrationParameter + description: >- + Integration Parameter is defined in the integration config and are used + to provide information about data types of the expected parameters and + provide any default values if needed. They can also be used to add + custom attributes. These are static in nature and should not be used for + dynamic event definition. + type: object + properties: + key: + description: >- + Key is used to retrieve the corresponding parameter value. This + should be unique for a given fired event. These parameters must be + predefined in the integration definition. + type: string dataType: + description: Type of the parameter. type: string enumDescriptions: - Unspecified. @@ -6307,7 +5521,6 @@ components: - >- BYTES_ARRAY data types are not allowed for top-level params. They're only meant to support protobufs with BYTES (sub)fields. - description: Type of the parameter. enum: - INTEGRATION_PARAMETER_DATA_TYPE_UNSPECIFIED - STRING_VALUE @@ -6327,27 +5540,22 @@ components: - PROTO_ENUM_ARRAY - BYTES - BYTES_ARRAY - searchable: - description: Searchable in the execution log or not. - type: boolean - key: - description: >- - Key is used to retrieve the corresponding parameter value. This - should be unique for a given fired event. These parameters must be - predefined in the integration definition. - type: string - description: - type: string - description: Optional. Description of the parameter. defaultValue: description: >- Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object. $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' - masked: + searchable: + description: Searchable in the execution log or not. type: boolean - description: True if this parameter should be masked in the logs + displayName: + description: >- + The name (without prefix) to be displayed in the UI for this + parameter. E.g. if the key is "foo.bar.myName", then the name would + be "myName". + type: string inputOutputType: + description: Specifies the input/output type for the parameter. type: string enumDescriptions: - Default. @@ -6362,197 +5570,111 @@ components: output. EventBus will validate for the existence of these parameters before execution and will also return this parameter back in the response. - description: Specifies the input/output type for the parameter. enum: - IN_OUT_TYPE_UNSPECIFIED - IN - OUT - IN_OUT - GoogleCloudIntegrationsV1alphaListAuthConfigsResponse: - properties: - authConfigs: - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' - type: array - description: The list of AuthConfigs retrieved. - nextPageToken: + isTransient: + description: Whether this parameter is a transient parameter. + type: boolean + producer: + description: >- + The identifier of the node (TaskConfig/TriggerConfig) this parameter + was produced by, if it is a transient param or a copy of an input + param. type: string - description: The token used to retrieve the next page of results. - description: Response to list AuthConfigs. - id: GoogleCloudIntegrationsV1alphaListAuthConfigsResponse - type: object - EnterpriseCrmEventbusProtoSuspensionResolutionInfoAudit: - properties: - resolvedBy: - type: string - timestamp: + jsonSchema: + description: >- + This schema will be used to validate runtime JSON-typed values of + this parameter. type: string - format: google-datetime - resolvedByCpi: + containsLargeData: + description: >- + Indicates whether this variable contains large data and need to be + uploaded to Cloud Storage. + type: boolean + masked: + description: True if this parameter should be masked in the logs + type: boolean + description: + description: Optional. Description of the parameter. type: string - id: EnterpriseCrmEventbusProtoSuspensionResolutionInfoAudit + EnterpriseCrmEventbusProtoTeardown: + id: EnterpriseCrmEventbusProtoTeardown type: object - EnterpriseCrmFrontendsEventbusProtoEventParameters: properties: - parameters: - items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry + teardownTaskConfigs: + description: Required. type: array - description: >- - Parameters are a part of Event and can be used to communicate - between different tasks that are part of the same workflow - execution. - description: >- - LINT.IfChange This message is used for processing and persisting (when - applicable) key value pair parameters for each event in the event bus. - Please see - id: EnterpriseCrmFrontendsEventbusProtoEventParameters - type: object - EnterpriseCrmEventbusProtoIntArrayFunction: + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTeardownTaskConfig' + EnterpriseCrmEventbusProtoTeardownTaskConfig: + id: EnterpriseCrmEventbusProtoTeardownTaskConfig type: object properties: - functionName: + teardownTaskImplementationClassName: + description: Required. Implementation class name. type: string - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - enum: - - UNSPECIFIED - - GET - - APPEND - - SIZE - - SUM - - AVG - - MAX - - MIN - - TO_SET - - APPEND_ALL - - TO_JSON - - SET - - REMOVE - - REMOVE_AT - - CONTAINS - - FOR_EACH - - FILTER - id: EnterpriseCrmEventbusProtoIntArrayFunction - EnterpriseCrmFrontendsEventbusProtoParameterMapEntry: - id: EnterpriseCrmFrontendsEventbusProtoParameterMapEntry - type: object - properties: - key: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterMapField - value: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterMapField - description: Entry is a pair of key and value. - GoogleCloudIntegrationsV1alphaGetClientResponse: - type: object - description: Response for the GetClient rpc - properties: - client: - description: 'Required. Required: The client configuration that was requested' - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaClientConfig' - id: GoogleCloudIntegrationsV1alphaGetClientResponse - GoogleCloudIntegrationsV1alphaSwitchEncryptionRequest: - properties: - cloudKmsConfig: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCloudKmsConfig' + name: description: >- - Required. REQUIRED: Cloud KMS config for AuthModule to - encrypt/decrypt credentials. - description: Request for the SwitchEncryption rpc - type: object - id: GoogleCloudIntegrationsV1alphaSwitchEncryptionRequest - GoogleCloudIntegrationsV1alphaExecutionDetails: + Required. Unique identifier of the teardown task within this Config. + We use this field as the identifier to find next teardown tasks. + type: string + parameters: + description: The parameters the user can pass to this task. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' + properties: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventBusProperties' + creatorEmail: + description: The creator's email address. + type: string + nextTeardownTask: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoNextTeardownTask' + EnterpriseCrmEventbusProtoEventBusProperties: + id: EnterpriseCrmEventbusProtoEventBusProperties + description: >- + LINT.IfChange This message is used for storing key value pair properties + for each Event / Task in the EventBus. type: object - id: GoogleCloudIntegrationsV1alphaExecutionDetails properties: - state: - type: string - description: Status of the execution. - enum: - - STATE_UNSPECIFIED - - PENDING - - PROCESSING - - SUCCEEDED - - FAILED - - CANCELLED - - RETRY_ON_HOLD - - SUSPENDED - enumDescriptions: - - Default. - - Execution is scheduled and awaiting to be triggered. - - Execution is processing. - - >- - Execution successfully finished. There's no more change after this - state. - - Execution failed. There's no more change after this state. - - >- - Execution canceled by user. There's no more change after this - state. - - Execution failed and waiting for retry. - - Execution suspended and waiting for manual intervention. - attemptStats: - type: array - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAttemptStats' - description: List of Start and end time of the execution attempts. - executionSnapshots: - description: List of snapshots taken during the execution. + properties: + description: An unordered list of property entries. type: array items: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaExecutionSnapshot - eventExecutionSnapshotsSize: - format: int64 - type: string - description: Total size of all event_execution_snapshots for an execution - description: >- - Contains the details of the execution info: this includes the tasks - execution details plus the event execution statistics. - EnterpriseCrmEventbusProtoTaskExecutionDetailsTaskAttemptStats: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoPropertyEntry' + EnterpriseCrmEventbusProtoPropertyEntry: + id: EnterpriseCrmEventbusProtoPropertyEntry + description: Key-value pair of EventBus property. type: object properties: - startTime: + key: description: >- - The start time of the task execution for current attempt. This could - be in the future if it's been scheduled. + Key is used to retrieve the corresponding property value. This + should be unique for a given fired event. The Tasks should be aware + of the keys used while firing the events for them to be able to + retrieve the values. type: string - format: int64 - endTime: + value: + description: >- + Values for the defined keys. Each value can either be string, int, + double or any proto message. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoValueType' + EnterpriseCrmEventbusProtoNextTeardownTask: + id: EnterpriseCrmEventbusProtoNextTeardownTask + description: >- + The teardown task that is next in line to be executed. We support only + sequential execution of teardown tasks (i.e. no branching). + type: object + properties: + name: + description: Required. Name of the next teardown task. type: string - format: int64 - description: The end time of the task execution for current attempt. - id: EnterpriseCrmEventbusProtoTaskExecutionDetailsTaskAttemptStats GoogleCloudIntegrationsV1alphaErrorCatcherConfig: + id: GoogleCloudIntegrationsV1alphaErrorCatcherConfig + description: Configuration detail of a error catch task + type: object properties: - errorCatcherNumber: - type: string - description: >- - Required. A number to uniquely identify each error catcher config - within the workflow on UI. - position: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCoordinate' - description: >- - Optional. Informs the front-end application where to draw this error - catcher config on the UI. errorCatcherId: description: >- Required. An error catcher id is string representation for the error @@ -6560,117 +5682,114 @@ components: identifies an error catcher config among all error catcher configs for the workflow type: string + label: + description: >- + Optional. The user created label for a particular error catcher. + Optional. + type: string + errorCatcherNumber: + description: >- + Required. A number to uniquely identify each error catcher config + within the workflow on UI. + type: string startErrorTasks: - type: array - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaNextTask' description: >- Required. The set of start tasks that are to be executed for the error catch flow + type: array + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaNextTask' description: - type: string description: >- Optional. User-provided description intended to give more business context about the error catcher config. - label: type: string + position: description: >- - Optional. The user created label for a particular error catcher. - Optional. - description: Configuration detail of a error catch task - type: object - id: GoogleCloudIntegrationsV1alphaErrorCatcherConfig - EnterpriseCrmEventbusProtoAttributes: + Optional. Informs the front-end application where to draw this error + catcher config on the UI. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCoordinate' + GoogleCloudIntegrationsV1alphaCloudLoggingDetails: + id: GoogleCloudIntegrationsV1alphaCloudLoggingDetails + description: Cloud Logging details for execution info type: object - description: >- - Attributes are additional options that can be associated with each event - property. For more information, see properties: - defaultValue: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoValueType' - description: Used to define defaults. - readOnly: - description: Used to indicate if the ParameterEntry is a read only field or not. - type: boolean - taskVisibility: - type: array - items: - type: string - description: List of tasks that can view this property, if empty then all. - dataType: - enum: - - DATA_TYPE_UNSPECIFIED - - EMAIL - - URL - - CURRENCY - - TIMESTAMP - - DOMAIN_NAME + cloudLoggingSeverity: description: >- - Things like URL, Email, Currency, Timestamp (rather than string, - int64...) - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - >- - Domain is a web url string with one top-level private domain and a - suffix (for example: google.com, walmart.com) + Optional. Severity selected by the customer for the logs to be sent + to Cloud Logging, for the integration version getting executed. type: string - isSearchable: - type: boolean - deprecated: true - description: >- - Used to indicate if a ParameterEntry should be converted to - ParamIndexes for ST-Spanner full-text search. DEPRECATED: use - searchable. - isRequired: - type: boolean - description: >- - Required for event execution. The validation will be done by the - event bus when the event is triggered. - logSettings: - description: See - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoLogSettings' - masked: - type: boolean - description: True if this workflow parameter should be masked in the logs - searchable: enumDescriptions: - - '' + - Unspecified - >- - If yes, the parameter key and value will be full-text indexed. In - a proto, this value will propagate to all children whose - searchable is unspecified. + If Severity selected is `INFO`, then all the Integration Execution + States (`IN_PROCESS`, `ON_HOLD`, `SUCCEEDED`, `SUSPENDED`, + `ERROR`, `CANCELLED`) will be sent to Cloud Logging. - >- - If no, the parameter key and value will not be full-text indexed. - In a proto, this value will propagate to all children whose - searchable is unspecified. + If Severity selected is `ERROR`, then only the following + Integration Execution States (`ERROR`, `CANCELLED`) will be sent + to Cloud Logging. + - >- + If Severity selected is `WARNING`, then only the following + Integration Execution States (`ERROR`, `CANCELLED`) will be sent + to Cloud Logging. enum: - - UNSPECIFIED - - 'YES' - - 'NO' - type: string - id: EnterpriseCrmEventbusProtoAttributes - EnterpriseCrmEventbusProtoParamSpecEntryProtoDefinition: + - CLOUD_LOGGING_SEVERITY_UNSPECIFIED + - INFO + - ERROR + - WARNING + enableCloudLogging: + description: >- + Optional. Status of whether Cloud Logging is enabled or not for the + integration version getting executed. + type: boolean + GoogleCloudIntegrationsV1alphaIntegrationConfigParameter: + id: GoogleCloudIntegrationsV1alphaIntegrationConfigParameter + description: >- + Integration Config Parameter is defined in the integration config and + are used to provide external configuration for integration. It provide + information about data types of the expected parameters and provide any + default values or value. They can also be used to add custom attributes. type: object - id: EnterpriseCrmEventbusProtoParamSpecEntryProtoDefinition properties: - fullName: - type: string + parameter: description: >- - The fully-qualified proto name. This message, for example, would be - "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition". - path: - type: string - description: Path to the proto file that contains the message type's definition. + Optional. Integration Parameter to provide the default value, data + type and attributes required for the Integration config variables. + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationParameter + value: + description: >- + Values for the defined keys. Each value can either be string, int, + double or any proto message or a serialized object. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' + GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest: + id: GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest + description: Request for PublishIntegrationVersion. + type: object + properties: + configParameters: + description: Optional. Config parameters used during integration execution. + type: object + additionalProperties: + type: any + description: Properties of the object. + GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse: + id: GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse + description: Response for PublishIntegrationVersion. + type: object + properties: {} GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest: id: GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest description: Request for UploadIntegrationVersion. type: object properties: + content: + description: The textproto of the IntegrationVersion. + type: string fileFormat: + description: File format for upload request. + type: string enumDescriptions: - Unspecified file format - JSON File Format @@ -6679,224 +5798,323 @@ components: - FILE_FORMAT_UNSPECIFIED - JSON - YAML - description: File format for upload request. + GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse: + id: GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse + description: Response for UploadIntegrationVersion. + type: object + properties: + integrationVersion: + description: The uploaded integration. + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse: + id: GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse + description: Response for DownloadIntegrationVersion. + type: object + properties: + content: + description: String representation of the requested file. type: string + files: + description: List containing String represendation for multiple file with type. + type: array + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSerializedFile' + GoogleCloudIntegrationsV1alphaSerializedFile: + id: GoogleCloudIntegrationsV1alphaSerializedFile + description: To store string representation of Integration file. + type: object + properties: content: + description: String representation of the file content. type: string - description: The textproto of the IntegrationVersion. - EnterpriseCrmEventbusProtoDoubleParameterArray: + file: + description: >- + File information like Integration version, Integration Config + variables etc. + type: string + enumDescriptions: + - Default value. + - Integration file. + - Integration Config variables. + enum: + - INTEGRATION_FILE_UNSPECIFIED + - INTEGRATION + - INTEGRATION_CONFIG_VARIABLES + GoogleCloudIntegrationsV1alphaDownloadJsonPackageResponse: + id: GoogleCloudIntegrationsV1alphaDownloadJsonPackageResponse + description: Response for DownloadJsonPackage. + type: object properties: - doubleValues: + files: + description: List containing JSON for multiple file with type information. type: array items: - format: double - type: number - type: object - id: EnterpriseCrmEventbusProtoDoubleParameterArray - EnterpriseCrmEventbusProtoParameterValueType: - id: EnterpriseCrmEventbusProtoParameterValueType + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaFile' + GoogleCloudIntegrationsV1alphaFile: + id: GoogleCloudIntegrationsV1alphaFile description: >- - LINT.IfChange To support various types of parameter values. Next - available id: 14 + To store Integration version related file i.e. Integration Version, + Config variable etc. type: object properties: - stringValue: - type: string - protoArray: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoProtoParameterArray' - doubleValue: - format: double - type: number - intValue: - type: string - format: int64 - doubleArray: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoDoubleParameterArray' - serializedObjectValue: + integrationVersion: + description: Integration version $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoSerializedObjectParameter - intArray: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoIntParameterArray' - protoValue: + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + integrationConfig: + description: Integration version config file + type: object additionalProperties: type: any - description: Properties of the object. Contains field @type with type URL. - type: object - stringArray: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoStringParameterArray' - booleanValue: - type: boolean - booleanArray: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBooleanParameterArray' - GoogleCloudConnectorsV1AuthConfig: - id: GoogleCloudConnectorsV1AuthConfig - description: AuthConfig defines details of a authentication type. + description: Properties of the object. + type: + description: >- + File information like Integration version, Integration Config + variables etc. + type: string + enumDescriptions: + - Default value. + - Integration file. + - Integration Config variables. + enum: + - INTEGRATION_FILE_UNSPECIFIED + - INTEGRATION + - INTEGRATION_CONFIG_VARIABLES + GoogleCloudIntegrationsV1alphaTakeoverEditLockRequest: + id: GoogleCloudIntegrationsV1alphaTakeoverEditLockRequest + description: Request for TakeoverEditLock. + type: object + properties: {} + GoogleCloudIntegrationsV1alphaTakeoverEditLockResponse: + id: GoogleCloudIntegrationsV1alphaTakeoverEditLockResponse + description: Response for TakeoverEditLock. + type: object properties: - additionalVariables: - type: array - description: List containing additional auth configs. - items: - $ref: '#/components/schemas/GoogleCloudConnectorsV1ConfigVariable' - oauth2ClientCredentials: - $ref: >- - #/components/schemas/GoogleCloudConnectorsV1AuthConfigOauth2ClientCredentials - description: Oauth2ClientCredentials. - oauth2JwtBearer: - description: Oauth2JwtBearer. - $ref: >- - #/components/schemas/GoogleCloudConnectorsV1AuthConfigOauth2JwtBearer - oauth2AuthCodeFlow: - description: Oauth2AuthCodeFlow. - $ref: >- - #/components/schemas/GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlow - oauth2AuthCodeFlowGoogleManaged: - description: Oauth2AuthCodeFlowGoogleManaged. + integrationVersion: + description: Version after the lock is acquired by the new user. $ref: >- - #/components/schemas/GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlowGoogleManaged - sshPublicKey: - description: SSH Public Key. - $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfigSshPublicKey' - authType: - description: The type of authentication configured. - enum: - - AUTH_TYPE_UNSPECIFIED - - USER_PASSWORD - - OAUTH2_JWT_BEARER - - OAUTH2_CLIENT_CREDENTIALS - - SSH_PUBLIC_KEY - - OAUTH2_AUTH_CODE_FLOW - - GOOGLE_AUTHENTICATION - - OAUTH2_AUTH_CODE_FLOW_GOOGLE_MANAGED - enumDescriptions: - - Authentication type not specified. - - Username and Password Authentication. - - >- - JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant - based authentication - - Oauth 2.0 Client Credentials Grant Authentication - - SSH Public Key Authentication - - Oauth 2.0 Authorization Code Flow - - Google authentication - - >- - Oauth 2.0 Authorization Code Flow with Google Provided OAuth - Client - type: string - userPassword: - description: UserPassword. - $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfigUserPassword' - authKey: - description: Identifier key for auth config - type: string + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest: + id: GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest + description: Request for UnpublishIntegrationVersion. type: object - GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectRequest: - properties: - scriptId: - description: The id of the Apps Script project to be linked. - type: string + properties: {} + GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest: + id: GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest + description: The request for executing an integration. type: object - description: Request for LinkAppsScriptProject rpc call. - id: GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectRequest - EnterpriseCrmEventbusProtoTaskMetadata: properties: - tags: - type: array + triggerId: description: >- - A set of tags that pertain to a particular task. This can be used to - improve the searchability of tasks with several names ("REST Caller" - vs. "Call REST Endpoint") or to help users find tasks based on - related words. - items: - type: string - defaultJsonValidationOption: - enum: - - UNSPECIFIED_JSON_VALIDATION_OPTION - - SKIP - - PRE_EXECUTION - - POST_EXECUTION - - PRE_POST_EXECUTION + Required. Matched against all {@link TriggerConfig}s across all + integrations. i.e. TriggerConfig.trigger_id.equals(trigger_id). The + trigger_id is in the format of `api_trigger/TRIGGER_NAME`. type: string - enumDescriptions: - - >- - As per the default behavior, no validation will be run. Will not - override any option set in a Task. - - Do not run any validation against JSON schemas. - - >- - Validate all potential input JSON parameters against schemas - specified in WorkflowParameters. - - >- - Validate all potential output JSON parameters against schemas - specified in WorkflowParameters. - - Perform both PRE_EXECUTION and POST_EXECUTION validations. + parameters: description: >- - Controls whether JSON workflow parameters are validated against - provided schemas before and/or after this task's execution. - admins: - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTaskMetadataAdmin' + Optional. Passed in as parameters to each integration execution. + Redacted + deprecated: true + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters + doNotPropagateError: + description: >- + Optional. Flag to determine how to should propagate errors. If this + flag is set to be true, it will not throw an exception. Instead, it + will return a {@link ExecuteIntegrationsResponse} with an execution + id and error messages as PostWithTriggerIdExecutionException in + {@link EventParameters}. The flag is set to be false by default. + type: boolean + parameterEntries: + description: >- + Optional. Parameters are a part of Event and can be used to + communicate between different tasks that are part of the same + integration execution. + deprecated: true type: array - standaloneExternalDocHtml: - type: string + items: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry + requestId: description: >- - External-facing documention for standalone IP in pantheon embedded - in the RHP for this task. Non null only if different from - external_doc_html - externalDocLink: - description: Doc link for external-facing documentation (separate from g3doc). + Optional. This is used to de-dup incoming request: if the duplicate + request was detected, the response from the previous execution is + returned. type: string - status: - description: >- - Allows author to indicate if the task is ready to use or not. If not - set, then it will default to INACTIVE. - enum: - - UNSPECIFIED_STATUS - - DEFAULT_INACTIVE - - ACTIVE - enumDescriptions: - - >- - Default value. Actual Task Status should always be set to either - INACTIVE or ACTIVE. If none is specified at runtime, it will be - set to INACTIVE. - - Still in-progress or incomplete, and not intended for use. - - Available for use. + executionId: + description: Optional. The id of the ON_HOLD execution to be resumed. type: string - isDeprecated: - description: The deprecation status of the current task. Default value is false; + inputParameters: + description: Optional. Input parameters used by integration execution. + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' + GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse: + id: GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse + description: The response for executing an integration. + type: object + properties: + executionId: + description: The id of the execution corresponding to this run of integration. + type: string + eventParameters: + description: Details for the integration that were executed. + deprecated: true + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters + executionFailed: + description: Is true if any execution in the integration failed. False otherwise. + deprecated: true type: boolean - iconLink: + parameterEntries: description: >- - URL to gstatic image icon for this task. This icon shows up on the - task list panel along with the task name in the Workflow Editor - screen. Use the 24p, 2x, gray color icon image format. + Parameters are a part of Event and can be used to communicate + between different tasks that are part of the same integration + execution. + deprecated: true + type: array + items: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry + outputParameters: + description: >- + OUTPUT parameters in format of Map. Where Key is the name of the + parameter. Note: Name of the system generated parameters are wrapped + by backtick(`) to distinguish them from the user defined parameters. + type: object + additionalProperties: + type: any + description: Properties of the object. + parameters: + description: Optional. OUTPUT parameters from integration execution. + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' + GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest: + id: GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest + description: The request for scheduling an integration. + type: object + properties: + triggerId: + description: >- + Required. Matched against all {@link TriggerConfig}s across all + integrations. i.e. TriggerConfig.trigger_id.equals(trigger_id) type: string - externalCategorySequence: - format: int32 - type: integer + parameters: + description: Passed in as parameters to each integration execution. + deprecated: true + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' + scheduleTime: description: >- - Sequence with which the task in specific category to be displayed in - task discovery panel for external users. - descriptiveName: + The time that the integration should be executed. If the time is + less or equal to the current time, the integration is executed + immediately. type: string + format: google-datetime + requestId: description: >- - The string name to show on the task list on the Workflow editor - screen. This should be a very short, one to two words name for the - task. (e.g. "Send Mail") - externalDocMarkdown: + This is used to de-dup incoming request: if the duplicate request + was detected, the response from the previous execution is returned. type: string - description: 'DEPRECATED: Use external_doc_html.' - system: + parameterEntries: + description: >- + Parameters are a part of Event and can be used to communicate + between different tasks that are part of the same integration + execution. + deprecated: true + type: array + items: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry + inputParameters: + description: Optional. Input parameters used by integration execution. + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' + userGeneratedExecutionId: + description: >- + Optional. This is a unique id provided by the method caller. If + provided this will be used as the execution_id when a new execution + info is created. This is a string representation of a UUID. Must + have no more than 36 characters and contain only alphanumeric + characters and hyphens. + type: string + GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse: + id: GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse + description: The response for executing an integration. + type: object + properties: + executionInfoIds: + description: The execution info id for the executed integrations. + type: array + items: + type: string + GoogleCloudIntegrationsV1alphaExecuteEventResponse: + id: GoogleCloudIntegrationsV1alphaExecuteEventResponse + description: The response for executing an integration. + type: object + properties: + executionId: + description: The id of the execution corresponding to this run of integration. + type: string + GoogleCloudIntegrationsV1alphaListExecutionsResponse: + id: GoogleCloudIntegrationsV1alphaListExecutionsResponse + description: Response for listing the integration execution data. + type: object + properties: + executionInfos: + description: Required. The detailed information of requested executions. + deprecated: true + type: array + items: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventExecutionInfo + nextPageToken: + description: The token used to retrieve the next page results. + type: string + executions: + description: The detailed information of requested executions + type: array + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaExecution' + EnterpriseCrmFrontendsEventbusProtoEventExecutionInfo: + id: EnterpriseCrmFrontendsEventbusProtoEventExecutionInfo + description: >- + Contains all the execution details for a workflow instance. Next + available id: 27 + type: object + properties: + eventExecutionInfoId: + description: Auto-generated primary key. + type: string + workflowName: + description: Name of the workflow. + type: string + workflowId: + description: Required. Pointer to the workflow it is executing. + type: string + clientId: + description: The event data user sends as request. + type: string + triggerId: + description: >- + The trigger id of the workflow trigger config. If both trigger_id + and client_id is present, the workflow is executed from the start + tasks provided by the matching trigger config otherwise it is + executed from the default start tasks. + type: string + requestParams: + description: Event parameters come in as part of the request. + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters + responseParams: + description: Event parameters come out as part of the response. + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters + postMethod: + description: The ways user posts this event. type: string - enum: - - UNSPECIFIED_SYSTEM - - GENERIC - - BUGANIZER - - SALESFORCE - - CLOUD_SQL - - PLX - - SHEETS - - GOOGLE_GROUPS - - EMAIL - - SPANNER - - DATA_BRIDGE enumDescriptions: - '' - '' @@ -6904,1175 +6122,1723 @@ components: - '' - '' - '' - - '' - - '' - - '' - - '' - - '' - g3DocLink: - type: string - description: URL to the associated G3 Doc for the task if available - externalCategory: - enumDescriptions: - - '' - - '' - - '' - - HTTP tasks, e.g. rest api call task - - Integration services, e.g. connector task - - Customer ations, e.g. email task - - Flow control, e.g. while loop task - - Workspace tasks, e.g. list drive task - - Security, e.g. kms related tasks - - Database operation tasks, e.g. read firestore info tasks - - Analytics tasks, e.g. dataflow creattion tasks - - BYOC tasks - - BYOT tasks - - AI related tasks. - - Data manipulation related tasks, e.g. data mapping task - type: string enum: - - UNSPECIFIED_EXTERNAL_CATEGORY - - CORE - - CONNECTORS - - EXTERNAL_HTTP - - EXTERNAL_INTEGRATION_SERVICES - - EXTERNAL_CUSTOMER_ACTIONS - - EXTERNAL_FLOW_CONTROL - - EXTERNAL_WORKSPACE - - EXTERNAL_SECURITY - - EXTERNAL_DATABASES - - EXTERNAL_ANALYTICS - - EXTERNAL_BYOC - - EXTERNAL_BYOT - - EXTERNAL_ARTIFICIAL_INTELIGENCE - - EXTERNAL_DATA_MANIPULATION - name: + - UNSPECIFIED + - POST + - POST_TO_QUEUE + - SCHEDULE + - POST_BY_EVENT_CONFIG_ID + - POST_WITH_EVENT_DETAILS + eventExecutionDetails: + description: The execution info about this event. + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventExecutionDetails + createTime: + description: Auto-generated. + type: string + format: int64 + lastModifiedTime: + description: Auto-generated. type: string + format: int64 + errors: description: >- - The actual class name or the annotated name of the task. Task Author - should initialize this field with value from the getName() method of - the Task class. - defaultSpec: + Errors, warnings, and informationals associated with the + workflow/task. The order in which the errors were added by the + workflow/task is maintained. + type: array + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoErrorDetail' + errorCode: + description: Final error-code if event failed. + $ref: '#/components/schemas/CrmlogErrorCode' + tenant: + description: >- + Tenant this event is created. Used to reschedule the event to + correct tenant. type: string + product: description: >- - Contains the initial configuration of the task with default values - set. For now, The string should be compatible to an ASCII-proto - format. - category: + Which Google product the execution_info belongs to. If not set, the + execution_info belongs to Integration Platform by default. type: string enumDescriptions: - '' - '' - '' - '' - - '' - - '' - - Internal IP tasks that should not be available in the UI. - - Tasks that are relevant to cloud systems teams and typically - - Task entities that derive from a custom task template. - - Category to show task recommendations enum: - - UNSPECIFIED_CATEGORY - - CUSTOM - - FLOW_CONTROL - - DATA_MANIPULATION - - SCRIPTING - - CONNECTOR - - HIDDEN - - CLOUD_SYSTEMS - - CUSTOM_TASK_TEMPLATE - - TASK_RECOMMENDATIONS - activeTaskName: - type: string - description: >- - The new task name to replace the current task if it is deprecated. - Otherwise, it is the same as the current task name. - externalDocHtml: + - UNSPECIFIED_PRODUCT + - IP + - APIGEE + - SECURITY + snapshotNumber: + description: Workflow snapshot number. type: string - description: External-facing documention embedded in the RHP for this task. - docMarkdown: + format: int64 + requestId: + description: Optional. This is used to de-dup incoming request. type: string - description: Snippet of markdown documentation to embed in the RHP for this task. - codeSearchLink: - description: The Code Search link to the Task Java file. + executionTraceInfo: + description: Execution trace info to aggregate parent-child executions. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoExecutionTraceInfo' + workflowRetryBackoffIntervalSeconds: + description: >- + Time interval in seconds to schedule retry of workflow in manifold + when workflow is already running type: string - description: - description: In a few sentences, describe the purpose and usage of the task. + format: int64 + replayInfo: + description: Replay info for the execution + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventExecutionInfoReplayInfo + cloudLoggingDetails: + description: Cloud Logging details for execution info + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCloudLoggingDetails' + integrationVersionUserLabel: + description: User-defined label that annotates the executed integration version. type: string - id: EnterpriseCrmEventbusProtoTaskMetadata - type: object + EnterpriseCrmFrontendsEventbusProtoEventExecutionDetails: + id: EnterpriseCrmFrontendsEventbusProtoEventExecutionDetails description: >- - TaskMetadata are attributes that are associated to every common Task we - have. - EnterpriseCrmEventbusProtoBaseValue: + Contains the details of the execution info of this event: this includes + the tasks execution details plus the event execution statistics. Next + available id: 12 type: object properties: - referenceValue: - type: string - description: Start with a reference value to dereference. - literalValue: - description: Start with a literal value. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType' - baseFunction: - description: >- - Start with a function that does not build on existing values. Eg. - CurrentTime, Min, Max, Exists, etc. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFunction' - id: EnterpriseCrmEventbusProtoBaseValue - EnterpriseCrmEventbusProtoErrorDetail: - description: An error, warning, or information message associated with a workflow. - type: object - id: EnterpriseCrmEventbusProtoErrorDetail - properties: - severity: - enum: - - SEVERITY_UNSPECIFIED - - ERROR - - WARN - - INFO - description: 'The severity of the error: ERROR|WARN|INFO.' + eventExecutionState: + description: The execution state of this event. type: string enumDescriptions: - '' - - '' - - '' - - '' - taskNumber: + - >- + Event is received and waiting for the execution. This happens when + firing the event via "postToQueue" or "schedule". + - Event is under processing. + - >- + Event execution successfully finished. There's no more change + after this state. + - Event execution failed. There's no more change after this state. + - >- + Event execution canceled by user. There's no more change after + this state. + - Event execution failed and waiting for retry. + - Event execution suspended and waiting for manual intervention. + enum: + - UNSPECIFIED + - ON_HOLD + - IN_PROCESS + - SUCCEEDED + - FAILED + - CANCELED + - RETRY_ON_HOLD + - SUSPENDED + eventExecutionSnapshot: description: >- - The task try-number, in which, the error occurred. If zero, the - error happened at the event level. + After snapshot migration, this field will no longer be populated, + but old execution snapshots will still be accessible. + type: array + items: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventExecutionSnapshot + networkAddress: + description: >- + The network address (aka. bns address) that indicates where the + event executor is running. + type: string + logFilePath: + description: The log file path (aka. cns address) for this event. + type: string + eventAttemptStats: + type: array + items: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats + ryeLockUnheldCount: + description: >- + Used internally and shouldn't be exposed to users. A counter for the + cron job to record how many times this event is in in_process state + but don't have a lock consecutively/ type: integer format: int32 - errorMessage: + nextExecutionTime: description: >- - The full text of the error message, including any parameters that - were thrown along with the exception. + Next scheduled execution time in case the execution status was + RETRY_ON_HOLD. type: string - errorCode: - description: The associated error-code, which can be a common or internal code. - $ref: '#/components/schemas/CrmlogErrorCode' - EnterpriseCrmEventbusAuthconfigAuthConfigTaskParam: - id: EnterpriseCrmEventbusAuthconfigAuthConfigTaskParam + format: int64 + eventRetriesFromBeginningCount: + description: >- + Indicates the number of times the execution has restarted from the + beginning. + type: integer + format: int32 + eventExecutionSnapshotsSize: + description: Total size of all event_execution_snapshots for an execution + type: string + format: int64 + cancelReason: + description: >- + If the execution is manually canceled, this field will contain the + reason for cancellation. + type: string + EnterpriseCrmFrontendsEventbusProtoEventExecutionSnapshot: + id: EnterpriseCrmFrontendsEventbusProtoEventExecutionSnapshot type: object properties: - scope: + eventExecutionSnapshotId: + description: >- + Auto-generated. Used as primary key for EventExecutionSnapshots + table. type: string - description: A space-delimited list of requested scope permissions. - allowedServiceAccountInContext: - type: boolean - allowedCredentialTypes: + eventExecutionInfoId: + description: Points to the event execution info this snapshot belongs to. + type: string + checkpointTaskNumber: + description: >- + Indicates "right after which checkpoint task's execution" this + snapshot is taken. + type: string + eventExecutionSnapshotMetadata: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata + taskName: + description: The task name associated with this snapshot. Could be empty. + deprecated: true + type: string + snapshotTime: + description: Indicates when this snapshot is taken. + type: string + format: int64 + eventParams: + description: The parameters in Event object. + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters + diffParams: + description: The parameters in Event object that differs from last snapshot. + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters + taskExecutionDetails: + description: All of the task execution details at the given point of time. + type: array + items: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoTaskExecutionDetails + conditionResults: + description: All of the computed conditions that been calculated. + type: array + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoConditionResult' + EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata: + id: >- + EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata + type: object + properties: + taskNumber: + description: The task number associated with this snapshot. Could be empty. + type: string + taskName: + description: the task name associated with this snapshot. Could be empty. + type: string + eventAttemptNum: + description: the event attempt number this snapshot belongs to. + type: integer + format: int32 + taskAttemptNum: + description: the task attempt number this snapshot belongs to. Could be empty. + type: integer + format: int32 + taskLabel: + description: the task label associated with this snapshot. Could be empty. + type: string + ancestorTaskNumbers: + description: >- + Ancestor task number for the task(it will only be non-empty if the + task is under 'private workflow') + type: array items: type: string - enum: - - CREDENTIAL_TYPE_UNSPECIFIED - - USERNAME_AND_PASSWORD - - API_KEY - - OAUTH2_AUTHORIZATION_CODE - - OAUTH2_IMPLICIT - - OAUTH2_CLIENT_CREDENTIALS - - OAUTH2_RESOURCE_OWNER_CREDENTIALS - - JWT - - AUTH_TOKEN - - SERVICE_ACCOUNT - - CLIENT_CERTIFICATE_ONLY - - OIDC_TOKEN - enumDescriptions: - - '' - - Regular username/password pair. - - API key. - - OAuth 2.0 Authorization Code Grant Type. - - OAuth 2.0 Implicit Grant Type. - - OAuth 2.0 Client Credentials Grant Type. - - OAuth 2.0 Resource Owner Credentials Grant Type. - - JWT Token. - - Auth Token, e.g. bearer token. - - >- - Service Account which can be used to generate token for - authentication. - - Client Certificate only. - - Google OIDC ID Token + ancestorIterationNumbers: + description: >- + Ancestor iteration number for the task(it will only be non-empty if + the task is under 'private workflow') type: array + items: + type: string + integrationName: description: >- - Defines the credential types to be supported as Task may restrict - specific types to use, e.g. Cloud SQL Task will use - username/password type only. - useServiceAccountInContext: - type: boolean - authConfigId: - description: UUID of the AuthConfig. + The direct integration which the event execution snapshots belongs + to type: string - GoogleCloudIntegrationsV1alphaFailurePolicy: + EnterpriseCrmEventbusProtoTaskExecutionDetails: + id: EnterpriseCrmEventbusProtoTaskExecutionDetails description: >- - Policy that defines the task retry logic and failure type. If no - FailurePolicy is defined for a task, all its dependent tasks will not be - executed (i.e, a `retry_strategy` of NONE will be applied). + Contains the details of the execution of this task. Next available id: + 11 type: object - id: GoogleCloudIntegrationsV1alphaFailurePolicy properties: - maxRetries: - type: integer - description: >- - Required if retry_strategy is FIXED_INTERVAL or - LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines - the number of times the task will be retried if failed. - format: int32 - retryStrategy: + taskNumber: + description: Pointer to the task config it used for execution. + type: string + taskExecutionState: type: string enumDescriptions: - - UNSPECIFIED. + - '' - >- - Ignores the failure of this task. The rest of the integration will - be executed Assuming this task succeeded. + Task is waiting for its precondition tasks to finish to start the + execution. + - Task is under processing. - >- - Causes a permanent failure of the task. However, if the last - task(s) of event was successfully completed despite the failure of - this task, it has no impact on the integration. + Task execution successfully finished. There's no more change after + this state. + - Task execution failed. There's no more change after this state. - >- - Causes a permanent failure of the event. It is different from NONE - because this will mark the event as FAILED by shutting down the - event execution. + Task execution failed and cause the whole event execution to fail + immediately. There's no more change after this state. + - Task execution failed and waiting for retry. - >- - The task will be retried from the failed task onwards after a - fixed delay. A max-retry count is required to be specified with - this strategy. A jitter is added to each exponential interval so - that concurrently failing tasks of the same type do not end up - retrying after the exact same exponential interval. max_retries - and interval_in_seconds must be specified. + Task execution skipped. This happens when its precondition wasn't + met, or the event execution been canceled before reach to the + task. There's no more changes after this state. - >- - The task will be retried from the failed task onwards after a - fixed delay that linearly increases with each retry attempt. A - jitter is added to each exponential interval so that concurrently - failing tasks of the same type do not end up retrying after the - exact same exponential interval. A max-retry count is required to - be specified with this strategy. max_retries and - interval_in_seconds must be specified. + Task execution canceled when in progress. This happens when event + execution been canceled or any other task fall in fatal state. - >- - The task will be retried after an exponentially increasing period - of time with each failure. A jitter is added to each exponential - interval so that concurrently failing tasks of the same type do - not end up retrying after the exact same exponential interval. A - max-retry count is required to be specified with this strategy. - `max_retries` and `interval_in_seconds` must be specified. + Task is waiting for its dependency tasks' rollback to finish to + start its rollback. + - Task is rolling back. - >- - The entire integration will be restarted with the initial - parameters that were set when the event was fired. A max-retry - count is required to be specified with this strategy. - `max_retries` and `interval_in_seconds` must be specified. - description: Defines what happens to the task upon failure. + Task is rolled back. This is the state we will set regardless of + rollback succeeding or failing. + - >- + Task is a SuspensionTask which has executed once, creating a + pending suspension. enum: - - RETRY_STRATEGY_UNSPECIFIED - - IGNORE - - NONE + - UNSPECIFIED + - PENDING_EXECUTION + - IN_PROCESS + - SUCCEED + - FAILED - FATAL - - FIXED_INTERVAL - - LINEAR_BACKOFF - - EXPONENTIAL_BACKOFF - - RESTART_INTEGRATION_WITH_BACKOFF - intervalTime: - type: string - format: google-datetime - description: >- - Required if retry_strategy is FIXED_INTERVAL or - LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines - the initial interval in seconds for backoff. - condition: - type: string + - RETRY_ON_HOLD + - SKIPPED + - CANCELED + - PENDING_ROLLBACK + - ROLLBACK_IN_PROCESS + - ROLLEDBACK + - SUSPENDED + taskAttemptStats: + type: array + items: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoTaskExecutionDetailsTaskAttemptStats + skippedOnFailure: description: >- - Optional. The string condition that will be evaluated to determine - if the task should be retried with this failure policy. - GoogleCloudIntegrationsV1alphaSuspensionApprovalConfig: + Indicates whether the task was skipped on failure. Only relevant if + the task is in SKIPPED state. + type: boolean + EnterpriseCrmEventbusProtoTaskExecutionDetailsTaskAttemptStats: + id: EnterpriseCrmEventbusProtoTaskExecutionDetailsTaskAttemptStats type: object properties: - expiration: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSuspensionApprovalExpiration + startTime: description: >- - Indicates the next steps when no external actions happen on the - suspension. - emailAddresses: - description: Email addresses to send approval request to. - type: array - items: - type: string - customMessage: + The start time of the task execution for current attempt. This could + be in the future if it's been scheduled. type: string - description: Information to provide for recipients. - id: GoogleCloudIntegrationsV1alphaSuspensionApprovalConfig - description: Configurations for approving the Suspension. - GoogleCloudIntegrationsV1alphaListCertificatesResponse: - description: Response to list Certificates. - id: GoogleCloudIntegrationsV1alphaListCertificatesResponse - properties: - nextPageToken: - description: The token used to retrieve the next page of results. + format: int64 + endTime: + description: The end time of the task execution for current attempt. type: string - certificates: - type: array - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' - description: The list of Certificates retrieved. - type: object - GoogleCloudIntegrationsV1alphaSfdcInstance: + format: int64 + EnterpriseCrmEventbusProtoConditionResult: + id: EnterpriseCrmEventbusProtoConditionResult + description: Contains the combined condition calculation results. type: object properties: - description: - type: string - description: A description of the sfdc instance. - updateTime: - format: google-datetime - readOnly: true - description: Output only. Time when the instance was last updated - type: string - displayName: - type: string - description: User selected unique name/alias to easily reference an instance. - sfdcOrgId: - description: The SFDC Org Id. This is defined in salesforce. + currentTaskNumber: + description: the current task number. type: string - authConfigId: - description: A list of AuthConfigs that can be tried to open the channel to SFDC - type: array - items: - type: string - deleteTime: + nextTaskNumber: + description: the next task number. type: string - readOnly: true + result: description: >- - Output only. Time when the instance was deleted. Empty if not - deleted. - format: google-datetime - serviceAuthority: + the result comes out after evaluate the combined condition. True if + there's no combined condition specified. + type: boolean + EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats: + id: EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats + type: object + properties: + startTime: description: >- - URL used for API calls after authentication (the login authority is - configured within the referenced AuthConfig). - type: string - createTime: - readOnly: true + The start time of the event execution for current attempt. This + could be in the future if it's been scheduled. type: string - format: google-datetime - description: Output only. Time when the instance is created - name: - description: >- - Resource name of the SFDC instance - projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}. + format: int64 + endTime: + description: The end time of the event execution for current attempt. type: string - description: >- - The SfdcInstance resource use to hold channels and connection config - data. - id: GoogleCloudIntegrationsV1alphaSfdcInstance - GoogleCloudIntegrationsV1alphaOAuth2AuthorizationCode: - id: GoogleCloudIntegrationsV1alphaOAuth2AuthorizationCode - description: >- - The OAuth Type where the client sends request with the client id and - requested scopes to auth endpoint. User sees a consent screen and auth - code is received at specified redirect url afterwards. The auth code is - then combined with the client id and secret and sent to the token - endpoint in exchange for the access and refresh token. The refresh token - can be used to fetch new access tokens. + format: int64 + EnterpriseCrmEventbusProtoErrorDetail: + id: EnterpriseCrmEventbusProtoErrorDetail + description: An error, warning, or information message associated with a workflow. + type: object properties: - tokenEndpoint: - description: The token url endpoint to send the token request to. - type: string - tokenParams: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMap' - description: The token parameters sent along with the token request. - applyReauthPolicy: - type: boolean + errorCode: + description: The associated error-code, which can be a common or internal code. + $ref: '#/components/schemas/CrmlogErrorCode' + errorMessage: description: >- - Indicates if the user has opted in Google Reauth Policy. If opted - in, the refresh token will be valid for 20 hours, after which time - users must re-authenticate in order to obtain a new one. - authEndpoint: + The full text of the error message, including any parameters that + were thrown along with the exception. type: string - description: The auth url endpoint to send the auth code request to. - scope: - description: A space-delimited list of requested scope permissions. + severity: + description: 'The severity of the error: ERROR|WARN|INFO.' type: string - requestType: - description: Represent how to pass parameters to fetch access token - enum: - - REQUEST_TYPE_UNSPECIFIED - - REQUEST_BODY - - QUERY_PARAMETERS - - ENCODED_HEADER enumDescriptions: - - Unspecified request type - - To pass all the parameters in post body. - - To pass all the parameters as a part of query parameter. - - >- - To pass client id and client secret as base 64 encoding of - client_id:client_password and rest parameters in post body. - type: string - clientSecret: - type: string - description: The client's secret. - clientId: - description: The client's id. - type: string - authCode: - description: The Auth Code that is used to initially retrieve the access token. - type: string - accessToken: - description: The access token received from the token endpoint. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAccessToken' - authParams: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMap' - description: The auth parameters sent along with the auth code request. - type: object - GoogleCloudConnectorsV1LockConfig: - id: GoogleCloudConnectorsV1LockConfig - type: object + - '' + - '' + - '' + - '' + enum: + - SEVERITY_UNSPECIFIED + - ERROR + - WARN + - INFO + taskNumber: + description: >- + The task try-number, in which, the error occurred. If zero, the + error happened at the event level. + type: integer + format: int32 + CrmlogErrorCode: + id: CrmlogErrorCode description: >- - Determines whether or no a connection is locked. If locked, a reason - must be specified. + Registered ids for errors, as "oneof" enums. Each task or logical + grouping of tasks may share the same enum. + type: object properties: - locked: - type: boolean - description: Indicates whether or not the connection is locked. - reason: + commonErrorCode: type: string - description: Describes why a connection is locked. - GoogleCloudIntegrationsV1alphaBooleanParameterArray: - properties: - booleanValues: - description: Boolean array. + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - SYNC_EVENTBUS_EXECUTION_TIMEOUT is for eventbus internal use only. + - >- + ASYNC_EVENTBUS_EXECUTION_TIMEOUT is for eventbus internal use + only. This error will be counted as server availability error. + - '' + - '' + - '' + - '' + - '' + enumDeprecated: + - false + - true + - false + - false + - true + - true + - true + - false + - false + - true + - false + - false + - false + - false + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + enum: + - COMMON_ERROR_CODE_UNSPECIFIED + - INVALID_CREDENTIALS + - REQUIRED_FIELDS_MISSING + - INVALID_FIELDS + - BACKEND + - GENERAL + - INTERNAL + - IO_ERROR + - NOT_FOUND + - EVENT_BUS + - ALREADY_EXISTS + - CONCORD + - CONVERSION + - FLUME + - PERMISSION + - SALES_FORCE + - SPANNER + - UNIMPLEMENTED + - RELTIO + - WORKFLOW_NOT_FOUND + - QUOTA_THROTTLED + - QUOTA_ENQUEUED + - INVALID_QUOTA_CONFIGURATION + - TASK_NOT_FOUND + - EXECUTION_TIMEOUT + - INVALID_EVENT_EXECUTION_STATE + - INVALID_ATTRIBUTE + - MISSING_ATTRIBUTE + - CLIENT_UNAUTHORIZED_FOR_WORKFLOW + - INVALID_PARAMETER + - MISSING_PARAMETER + - UNAUTHROIZED_WORKFLOW_EDITOR_ACTION + - FAILED_PRECONDITION + - INVALID_CLIENT + - MISSING_CLIENT + - INVALID_WORKFLOW + - MISSING_QUOTA_CONFIGURATION + - UNHANDLED_TASK_ERROR + - SCRIPT_TASK_RUNTIME_ERROR + - RPC + - INVALID_PROTO + - UNHANDLED_EVENTBUS_ERROR + - INVALID_TASK_STATE + - TYPED_TASK_INVALID_INPUT_OPERATION + - TYPED_TASK_INVALID_OUTPUT_OPERATION + - VALIDATION_ERROR + - RESUME_ERROR + - APPS_SCRIPT_EXECUTION_ERROR + - INVALID_VECTOR_USER + - INFORMATICA + - RETRYABLE_TASK_ERROR + - INVALID_TENANT + - WRONG_TENANT + - INFORMATICA_BACKEND_UNAVAILABLE + - RPC_PERMISSION_DENIED + - SYNC_EVENTBUS_EXECUTION_TIMEOUT + - ASYNC_EVENTBUS_EXECUTION_TIMEOUT + - NOT_SUPPORTED_DATA_TYPE + - UNSANITIZED_USER_INPUT + - TRANSFORM_EXPRESSION_EVALUATION_ERROR + - HTTP_EXCEPTION + - EXECUTION_CANCELLED + EnterpriseCrmEventbusProtoExecutionTraceInfo: + id: EnterpriseCrmEventbusProtoExecutionTraceInfo + description: >- + Message that helps aggregate all sub-executions triggered by one + execution and keeps track of child-parent relationships. + type: object + properties: + traceId: + description: Used to aggregate ExecutionTraceInfo. + type: string + parentEventExecutionInfoId: + description: >- + Parent event execution info id that triggers the current execution + through SubWorkflowExecutorTask. + type: string + EnterpriseCrmFrontendsEventbusProtoEventExecutionInfoReplayInfo: + id: EnterpriseCrmFrontendsEventbusProtoEventExecutionInfoReplayInfo + description: >- + Contains the details of the execution info: this includes the replay + reason and replay tree connecting executions in a parent-child + relationship + type: object + properties: + originalExecutionInfoId: + description: >- + If this execution is a replay of another execution, then this field + contains the original execution id. + type: string + replayedExecutionInfoIds: + description: >- + If this execution has been replayed, then this field contains the + execution ids of the replayed executions. + type: array items: - type: boolean + type: string + replayReason: + description: reason for replay + type: string + replayMode: + description: Replay mode for the execution + type: string + enumDescriptions: + - '' + - Replay the original execution from the beginning. + - Replay the execution from the first failed task. + enum: + - REPLAY_MODE_UNSPECIFIED + - REPLAY_MODE_FROM_BEGINNING + - REPLAY_MODE_POINT_OF_FAILURE + EnterpriseCrmEventbusProtoCloudLoggingDetails: + id: EnterpriseCrmEventbusProtoCloudLoggingDetails + description: >- + Cloud Logging details, selected by the user for the integration version + (workflow). This message field will be also used in ExecutionInfo, to + indicate the CloudLoggingDetails config at the time of workflow + (integration version) execution, since this field value can be changed + for an unpublished workflow. + type: object + properties: + enableCloudLogging: + description: >- + Status of whether Cloud Logging is enabled or not for the + integration version getting executed. + type: boolean + cloudLoggingSeverity: + description: >- + Severity selected by the customer for the logs to be sent to Cloud + Logging, for the integration version getting executed. + type: string + enumDescriptions: + - Unspecified + - >- + If Severity selected is `INFO`, then all the Integration Execution + States (`IN_PROCESS`, `ON_HOLD`, `SUCCEEDED`, `SUSPENDED`, + `ERROR`, `CANCELLED`) will be sent to Cloud Logging. + - >- + If Severity selected is `ERROR`, then only the following + Integration Execution States (`ERROR`, `CANCELLED`) will be sent + to Cloud Logging. + - >- + If Severity selected is `WARNING`, then only the following + Integration Execution States (`ERROR`, `CANCELLED`) will be sent + to Cloud Logging. + enum: + - CLOUD_LOGGING_SEVERITY_UNSPECIFIED + - INFO + - ERROR + - WARNING + GoogleCloudIntegrationsV1alphaExecution: + id: GoogleCloudIntegrationsV1alphaExecution + description: >- + The Execution resource contains detailed information of an individual + integration execution. + type: object + properties: + name: + description: Auto-generated primary key. + type: string + triggerId: + description: >- + The trigger id of the integration trigger config. If both trigger_id + and client_id is present, the integration is executed from the start + tasks provided by the matching trigger config otherwise it is + executed from the default start tasks. + type: string + requestParams: + description: Event parameters come in as part of the request. + deprecated: true type: array - description: This message only contains a field of boolean array. - id: GoogleCloudIntegrationsV1alphaBooleanParameterArray + items: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry + responseParams: + deprecated: true + type: array + items: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry + executionMethod: + description: The ways user posts this event. + type: string + enumDescriptions: + - Default value. + - Sync post. + - Async post. + - Async post with schedule time. + enum: + - EXECUTION_METHOD_UNSPECIFIED + - POST + - POST_TO_QUEUE + - SCHEDULE + eventExecutionDetails: + description: The execution info about this event. + deprecated: true + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventExecutionDetails' + createTime: + description: Output only. Created time of the execution. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. Last modified time of the execution. + readOnly: true + type: string + format: google-datetime + directSubExecutions: + description: Direct sub executions of the following Execution. + type: array + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaExecution' + executionDetails: + description: Detailed info of this execution. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaExecutionDetails' + requestParameters: + description: Event parameters come in as part of the request. + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' + responseParameters: + description: >- + Event parameters returned as part of the response. In the case of + error, the `ErrorInfo` field is returned in the following format: { + "ErrorInfo": { "message": String, "code": Number } } + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' + cloudLoggingDetails: + description: Cloud Logging details for the integration version + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaCloudLoggingDetails + integrationVersionState: + description: Output only. State of the integration version + readOnly: true + type: string + enumDescriptions: + - Default. + - Draft. + - Active. + - Archived. + - Snapshot. + enum: + - INTEGRATION_STATE_UNSPECIFIED + - DRAFT + - ACTIVE + - ARCHIVED + - SNAPSHOT + snapshotNumber: + description: >- + Output only. An increasing sequence that is set when a new snapshot + is created + readOnly: true + type: string + format: int64 + replayInfo: + description: Output only. Replay info for the execution + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaExecutionReplayInfo + cloudKmsKey: + description: Optional. Cloud KMS resource name for the CMEK encryption key. + type: string + EnterpriseCrmEventbusProtoEventExecutionDetails: + id: EnterpriseCrmEventbusProtoEventExecutionDetails + description: >- + Contains the details of the execution info of this event: this includes + the tasks execution details plus the event execution statistics. Next + available id: 12 type: object - GoogleCloudIntegrationsV1alphaIntegrationVersion: properties: - lastModifierEmail: + eventExecutionState: + type: string + enumDescriptions: + - '' + - >- + Event is received and waiting for the execution. This happens when + firing the event via "postToQueue" or "schedule". + - Event is under processing. + - >- + Event execution successfully finished. There's no more change + after this state. + - Event execution failed. There's no more change after this state. + - >- + Event execution canceled by user. There's no more change after + this state. + - Event execution failed and waiting for retry. + - Event execution suspended and waiting for manual intervention. + enum: + - UNSPECIFIED + - ON_HOLD + - IN_PROCESS + - SUCCEEDED + - FAILED + - CANCELED + - RETRY_ON_HOLD + - SUSPENDED + eventExecutionSnapshot: + type: array + items: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoEventExecutionSnapshot + networkAddress: + description: >- + The network address (aka. bns address) that indicates where the + event executor is running. + type: string + logFilePath: + description: The log file path (aka. cns address) for this event. type: string + eventAttemptStats: + type: array + items: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats + ryeLockUnheldCount: description: >- - Optional. The last modifier's email address. Generated based on the - End User Credentials/LOAS role of the user making the call. - createdFromTemplate: + Used internally and shouldn't be exposed to users. A counter for the + cron job to record how many times this event is in in_process state + but don't have a lock consecutively/ + type: integer + format: int32 + nextExecutionTime: + description: >- + Next scheduled execution time in case the execution status was + RETRY_ON_HOLD. + type: string + format: int64 + eventRetriesFromBeginningCount: + description: >- + Indicates the number of times the execution has restarted from the + beginning. + type: integer + format: int32 + eventExecutionSnapshotsSize: + description: Total size of all event_execution_snapshots for an execution + type: string + format: int64 + cancelReason: + description: >- + If the execution is manually canceled, this field will contain the + reason for cancellation. + type: string + EnterpriseCrmEventbusProtoEventExecutionSnapshot: + id: EnterpriseCrmEventbusProtoEventExecutionSnapshot + description: >- + Contains the snapshot of the event execution for a given checkpoint. + Next available id: 15 + type: object + properties: + eventExecutionSnapshotId: + description: >- + Auto-generated. Used as primary key for EventExecutionSnapshots + table. + type: string + eventExecutionInfoId: + description: Points to the event execution info this snapshot belongs to. + type: string + checkpointTaskNumber: + description: >- + Indicates "right after which checkpoint task's execution" this + snapshot is taken. + type: string + eventExecutionSnapshotMetadata: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata + taskName: + description: The task name associated with this snapshot. Could be empty. + deprecated: true + type: string + snapshotTime: + description: Indicates when this snapshot is taken. + type: string + format: int64 + eventParams: + description: The parameters in Event object. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' + diffParams: + description: The parameters in Event object that differs from last snapshot. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' + taskExecutionDetails: + description: All of the task execution details at the given point of time. + type: array + items: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoTaskExecutionDetails + conditionResults: + description: All of the computed conditions that been calculated. + type: array + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoConditionResult' + exceedMaxSize: + description: indicate whether snapshot exceeded maximum size before clean up + type: boolean + clientId: + description: Client that the execution snapshot is associated to. type: string - description: >- - Optional. Optional. The resource name of the template from which the - integration is created. - runAsServiceAccount: - description: >- - Optional. The run-as service account email, if set and auth config - is not configured, that will be used to generate auth token to be - used in Connector task, Rest caller task and Cloud function task. + workflowName: + description: Name of the workflow this event execution snapshot belongs to. type: string - origin: - enumDeprecated: - - false - - false - - true - - false - - false - - false - description: >- - Optional. The origin that indicates where this integration is coming - from. + GoogleCloudIntegrationsV1alphaExecutionDetails: + id: GoogleCloudIntegrationsV1alphaExecutionDetails + description: >- + Contains the details of the execution info: this includes the tasks + execution details plus the event execution statistics. + type: object + properties: + state: + description: Status of the execution. type: string - deprecated: true enumDescriptions: - - '' - - Workflow is being created via event bus UI. + - Default. + - Execution is scheduled and awaiting to be triggered. + - Execution is processing. - >- - User checked in this workflow in Piper as v2 textproto format and - we synced it into spanner. + Execution successfully finished. There's no more change after this + state. + - Execution failed. There's no more change after this state. - >- - User checked in this workflow in piper as v3 textproto format and - we synced it into spanner. - - Workflow is being created via Standalone IP Provisioning - - Workflow is being created via Test Case. + Execution canceled by user. There's no more change after this + state. + - Execution failed and waiting for retry. + - Execution suspended and waiting for manual intervention. enum: - - UNSPECIFIED - - UI - - PIPER_V2 - - PIPER_V3 - - APPLICATION_IP_PROVISIONING - - TEST_CASE - triggerConfigsInternal: - deprecated: true - description: Optional. Trigger configurations. + - STATE_UNSPECIFIED + - PENDING + - PROCESSING + - SUCCEEDED + - FAILED + - CANCELLED + - RETRY_ON_HOLD + - SUSPENDED + executionSnapshots: + description: List of snapshots taken during the execution. + type: array items: $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoTriggerConfig + #/components/schemas/GoogleCloudIntegrationsV1alphaExecutionSnapshot + attemptStats: + description: List of Start and end time of the execution attempts. type: array - parentTemplateId: + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAttemptStats' + eventExecutionSnapshotsSize: + description: Total size of all event_execution_snapshots for an execution type: string + format: int64 + GoogleCloudIntegrationsV1alphaExecutionSnapshot: + id: GoogleCloudIntegrationsV1alphaExecutionSnapshot + description: Contains the snapshot of the execution for a given checkpoint. + type: object + properties: + checkpointTaskNumber: description: >- - Optional. The id of the template which was used to create this - integration_version. - updateTime: - description: Output only. Auto-generated. - readOnly: true + Indicates "after which checkpoint task's execution" this snapshot is + taken. type: string - format: google-datetime - triggerConfigs: - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTriggerConfig' - description: Optional. Trigger configurations. + executionSnapshotMetadata: + description: Metadata of the execution snapshot. + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaExecutionSnapshotExecutionSnapshotMetadata + params: + description: Parameters used during the execution. + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' + taskExecutionDetails: + description: All of the task execution details at the given point of time. type: array - snapshotNumber: - description: >- - Optional. An increasing sequence that is set when a new snapshot is - created. The last created snapshot can be identified by - [workflow_name, org_id latest(snapshot_number)]. However, last - created snapshot need not be same as the HEAD. So users should - always use "HEAD" tag to identify the head. - format: int64 + items: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaTaskExecutionDetails + GoogleCloudIntegrationsV1alphaExecutionSnapshotExecutionSnapshotMetadata: + id: GoogleCloudIntegrationsV1alphaExecutionSnapshotExecutionSnapshotMetadata + description: Metadata of the execution snapshot. + type: object + properties: + taskNumber: + description: The task number associated with this snapshot. type: string - errorCatcherConfigs: + task: + description: the task name associated with this snapshot. + type: string + executionAttempt: + description: the execution attempt number this snapshot belongs to. + type: integer + format: int32 + taskAttempt: + description: the task attempt number this snapshot belongs to. + type: integer + format: int32 + taskLabel: + description: the task label associated with this snapshot. Could be empty. + type: string + ancestorTaskNumbers: description: >- - Optional. Error Catch Task configuration for the integration. It's - optional. + Ancestor task number for the task(it will only be non-empty if the + task is under 'private workflow') + type: array items: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaErrorCatcherConfig + type: string + ancestorIterationNumbers: + description: >- + Ancestor iteration number for the task(it will only be non-empty if + the task is under 'private workflow') type: array - lockHolder: - type: string + items: + type: string + integrationName: description: >- - Optional. The edit lock holder's email address. Generated based on - the End User Credentials/LOAS role of the user making the call. - description: + The direct integration which the event execution snapshots belongs + to + type: string + GoogleCloudIntegrationsV1alphaTaskExecutionDetails: + id: GoogleCloudIntegrationsV1alphaTaskExecutionDetails + description: Contains the details of the execution of this task. + type: object + properties: + taskNumber: + description: Pointer to the task config it used for execution. + type: string + taskExecutionState: + description: The execution state of this task. type: string - description: Optional. The integration description. - databasePersistencePolicy: - enum: - - DATABASE_PERSISTENCE_POLICY_UNSPECIFIED - - DATABASE_PERSISTENCE_DISABLED - - DATABASE_PERSISTENCE_ASYNC enumDescriptions: - - Enables persistence for all execution data. - - Disables persistence for all execution data. - - Asynchronously persist all execution data. + - Default value. + - >- + Task is waiting for its precondition tasks to finish to start the + execution. + - Task is under processing. + - >- + Task execution successfully finished. There's no more change after + this state. + - Task execution failed. There's no more change after this state. + - >- + Task execution failed and cause the whole integration execution to + fail immediately. There's no more change after this state. + - Task execution failed and waiting for retry. + - >- + Task execution skipped. This happens when its precondition wasn't + met, or the integration execution been canceled before reach to + the task. There's no more changes after this state. + - >- + Task execution canceled when in progress. This happens when + integration execution been canceled or any other task fall in + fatal state. + - >- + Task is waiting for its dependency tasks' rollback to finish to + start its rollback. + - Task is rolling back. + - >- + Task is rolled back. This is the state we will set regardless of + rollback succeeding or failing. + - >- + Task is a SuspensionTask which has executed once, creating a + pending suspension. + enum: + - TASK_EXECUTION_STATE_UNSPECIFIED + - PENDING_EXECUTION + - IN_PROCESS + - SUCCEED + - FAILED + - FATAL + - RETRY_ON_HOLD + - SKIPPED + - CANCELLED + - PENDING_ROLLBACK + - ROLLBACK_IN_PROCESS + - ROLLEDBACK + - SUSPENDED + taskAttemptStats: + description: Status for the current task execution attempt. + type: array + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAttemptStats' + GoogleCloudIntegrationsV1alphaAttemptStats: + id: GoogleCloudIntegrationsV1alphaAttemptStats + description: Status for the execution attempt. + type: object + properties: + startTime: + description: >- + The start time of the integration execution for current attempt. + This could be in the future if it's been scheduled. + type: string + format: google-datetime + endTime: + description: The end time of the integration execution for current attempt. + type: string + format: google-datetime + GoogleCloudIntegrationsV1alphaExecutionReplayInfo: + id: GoogleCloudIntegrationsV1alphaExecutionReplayInfo + description: >- + Contains the details of the execution info: this includes the replay + reason and replay tree connecting executions in a parent-child + relationship + type: object + properties: + originalExecutionInfoId: description: >- - Optional. Flag to disable database persistence for execution data, - including event execution info, execution export info, execution - metadata index and execution param index. + If this execution is a replay of another execution, then this field + contains the original execution id. type: string - integrationParametersInternal: + replayedExecutionInfoIds: description: >- - Optional. Parameters that are expected to be passed to the - integration when an event is triggered. This consists of all the - parameters that are expected in the integration execution. This - gives the user the ability to provide default values, add - information like PII and also provide data types of each parameter. - deprecated: true - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoWorkflowParameters - state: - enum: - - INTEGRATION_STATE_UNSPECIFIED - - DRAFT - - ACTIVE - - ARCHIVED - - SNAPSHOT + If this execution has been replayed, then this field contains the + execution ids of the replayed executions. + type: array + items: + type: string + replayReason: + description: reason for replay + type: string + replayMode: + description: Replay mode for the execution type: string - description: Output only. User should not set it as an input. enumDescriptions: - - Default. - - Draft. - - Active. - - Archived. - - Snapshot. - readOnly: true - enableVariableMasking: - type: boolean - description: >- - Optional. True if variable masking feature should be turned on for - this version - status: + - Default value. + - Replay the original execution from the beginning. + - Replay the execution from the first failed task. + enum: + - REPLAY_MODE_UNSPECIFIED + - REPLAY_MODE_FROM_BEGINNING + - REPLAY_MODE_POINT_OF_FAILURE + GoogleCloudIntegrationsV1alphaCancelExecutionRequest: + id: GoogleCloudIntegrationsV1alphaCancelExecutionRequest + description: Request for cancelling an execution. + type: object + properties: + cancelReason: description: >- - Output only. Generated by eventbus. User should not set it as an - input. + Required. Reason for cancelling the execution. This is provided by + the client requesting the cancellation, and is not used by the + Platform. type: string + GoogleCloudIntegrationsV1alphaCancelExecutionResponse: + id: GoogleCloudIntegrationsV1alphaCancelExecutionResponse + description: Response for cancelling an execution. + type: object + properties: + isCanceled: + description: True if cancellation performed successfully. + type: boolean + GoogleCloudIntegrationsV1alphaTestIntegrationsRequest: + id: GoogleCloudIntegrationsV1alphaTestIntegrationsRequest + description: The request for testing an integration. + type: object + properties: + integrationVersion: + description: Required. integration config to execute the workflow + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + parameters: + description: Optional. Passed in as parameters to each integration execution. deprecated: true - readOnly: true - enum: - - UNKNOWN - - DRAFT - - ACTIVE - - ARCHIVED - - SNAPSHOT - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - taskConfigs: - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTaskConfig' - type: array - description: >- - Optional. Task configuration for the integration. It's optional, but - the integration doesn't do anything without task_configs. - integrationParameters: - items: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationParameter - description: >- - Optional. Parameters that are expected to be passed to the - integration when an event is triggered. This consists of all the - parameters that are expected in the integration execution. This - gives the user the ability to provide default values, add - information like PII and also provide data types of each parameter. - type: array - cloudLoggingDetails: - description: Optional. Cloud Logging details for the integration version $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaCloudLoggingDetails - userLabel: + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters + triggerId: description: >- - Optional. A user-defined label that annotates an integration - version. Typically, this is only set when the integration version is - created. + Required. The trigger id of the integration trigger config. If both + trigger_id and client_id is present, the integration is executed + from the start tasks provided by the matching trigger config + otherwise it is executed from the default start tasks. type: string - teardown: + clientId: description: >- - Optional. Contains a graph of tasks that will be executed before - putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), - regardless of success or failure, similar to "finally" in code. - deprecated: true - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTeardown' - taskConfigsInternal: + Required. This is used to identify the client on whose behalf the + event will be executed. + type: string + testMode: description: >- - Optional. Task configuration for the integration. It's optional, but - the integration doesn't do anything without task_configs. - deprecated: true - type: array - items: - $ref: '#/components/schemas/EnterpriseCrmFrontendsEventbusProtoTaskConfig' - name: - readOnly: true + Optional. Can be specified in the event request, otherwise false + (default). If true, enables tasks with condition "test_mode = true". + If false, disables tasks with condition "test_mode = true" if global + test mode (set by platform) is also false {@link EventBusConfig}. + type: boolean + deadlineSecondsTime: + description: Optional. custom deadline of the rpc type: string - description: Output only. Auto-generated primary key. - createTime: - description: Output only. Auto-generated. format: google-datetime - readOnly: true + inputParameters: + description: Optional. Input parameters used during integration execution. + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' + configParameters: + description: Optional. Config parameters used during integration execution. + type: object + additionalProperties: + type: any + description: Properties of the object. + GoogleCloudIntegrationsV1alphaTestIntegrationsResponse: + id: GoogleCloudIntegrationsV1alphaTestIntegrationsResponse + description: The response for testing an integration. + type: object + properties: + executionId: + description: The id of the execution corresponding to this run of integration. type: string - integrationConfigParameters: + eventParameters: + description: Details for the integration that were executed. + deprecated: true + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters + executionFailed: + description: Is true if any execution in the integration failed. False otherwise. + type: boolean + parameterEntries: description: >- - Optional. Config Parameters that are expected to be passed to the - integration when an integration is published. This consists of all - the parameters that are expected to provide configuration in the - integration execution. This gives the user the ability to provide - default values, value, add information like connection url, project - based configuration value and also provide data types of each - parameter. + Parameters are a part of Event and can be used to communicate + between different tasks that are part of the same integration + execution. + deprecated: true type: array items: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationConfigParameter - type: object - id: GoogleCloudIntegrationsV1alphaIntegrationVersion - description: The integration version definition. - GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse: + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry + parameters: + description: >- + Optional. Parameters are a part of Event and can be used to + communicate between different tasks that are part of the same + integration execution. + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' + GoogleCloudIntegrationsV1alphaDownloadExecutionResponse: + id: GoogleCloudIntegrationsV1alphaDownloadExecutionResponse + description: Response for downloading an execution. type: object properties: - files: - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSerializedFile' - type: array - description: List containing String represendation for multiple file with type. content: - description: String representation of the requested file. + description: The content of downloaded execution. type: string - description: Response for DownloadIntegrationVersion. - id: GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse - GoogleCloudIntegrationsV1alphaStringParameterArray: - description: This message only contains a field of string array. - type: object - properties: - stringValues: - type: array - description: String array. - items: - type: string - id: GoogleCloudIntegrationsV1alphaStringParameterArray - EnterpriseCrmEventbusProtoCustomSuspensionRequest: - id: EnterpriseCrmEventbusProtoCustomSuspensionRequest + GoogleCloudIntegrationsV1alphaReplayExecutionRequest: + id: GoogleCloudIntegrationsV1alphaReplayExecutionRequest + description: Request for replaying an execution. type: object properties: - postToQueueWithTriggerIdRequest: - description: Request to fire an event containing the SuspensionInfo message. - $ref: >- - #/components/schemas/GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest - suspensionInfoEventParameterKey: + replayReason: + description: Required. The user provided reason for replaying the execution. type: string - description: >- - In the fired event, set the SuspensionInfo message as the value for - this key. - GoogleCloudIntegrationsV1alphaAccessToken: - description: >- - The access token represents the authorization of a specific application - to access specific parts of a user’s data. + updateMask: + description: >- + Optional. The list of parameters to be updated. - If the + `update_mask` is not specified, all the parameters from original + execution will be ignored and only the `modified_parameters` will be + used. - It is an error to include a parameter in `update_mask` but + not in `modified_parameters`. - Updating nested fields in a JSON + parameter is not supported, please provide the complete JSON in the + `modified_parameters`. + type: string + format: google-fieldmask + modifiedParameters: + description: >- + Optional. The modified input parameters for replay. - Provide values + for all the fields in the 'update_mask'. Any field not present in + the 'update_mask' will be ignored and its value will be taken from + the original execution. - If the 'update_mask' is not specified, all + the parameters from original execution will be ignored and only the + `modified_parameters` will be used. + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' + replayMode: + description: Optional. The mode of the replay. + type: string + enumDescriptions: + - Default value. + - Replay the original execution. + - Replay the execution with the modified parameters. + enum: + - REPLAY_MODE_UNSPECIFIED + - REPLAY_MODE_FROM_BEGINNING + - REPLAY_MODE_POINT_OF_FAILURE + GoogleCloudIntegrationsV1alphaReplayExecutionResponse: + id: GoogleCloudIntegrationsV1alphaReplayExecutionResponse + description: Response for replaying an execution. type: object properties: - refreshTokenExpireTime: - format: google-datetime - type: string - description: The approximate time until the refresh token retrieved is valid. - refreshToken: - description: >- - If the access token will expire, use the refresh token to obtain - another access token. - type: string - accessToken: + executionId: description: >- - The access token encapsulating the security identity of a process or - thread. - type: string - tokenType: + Next ID: 4 The id of the execution corresponding to this run of the + integration. type: string - description: >- - Only support "bearer" token in v1 as bearer token is the predominant - type used with OAuth 2.0. - accessTokenExpireTime: + replayedExecutionId: + description: The execution id which is replayed. type: string + outputParameters: description: >- - Required. The approximate time until the access token retrieved is - valid. - format: google-datetime - id: GoogleCloudIntegrationsV1alphaAccessToken - EnterpriseCrmEventbusProtoCloudSchedulerConfig: - id: EnterpriseCrmEventbusProtoCloudSchedulerConfig + OUTPUT parameters in format of Map. Where Key is the name of the + parameter. The parameters would only be present in case of + synchrounous execution. Note: Name of the system generated + parameters are wrapped by backtick(`) to distinguish them from the + user defined parameters. + type: object + additionalProperties: + type: any + description: Properties of the object. + GoogleCloudIntegrationsV1alphaListIntegrationsResponse: + id: GoogleCloudIntegrationsV1alphaListIntegrationsResponse + description: Response for ListIntegrations. type: object - description: Cloud Scheduler Trigger configuration properties: - location: + integrations: + description: The integrations which match the request. + type: array + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaIntegration' + nextPageToken: + description: The next page token for the response. type: string - description: >- - Required. The location where associated cloud scheduler job will be - created - serviceAccountEmail: - description: >- - Required. Service account used by Cloud Scheduler to trigger the - integration at scheduled time + GoogleCloudIntegrationsV1alphaIntegration: + id: GoogleCloudIntegrationsV1alphaIntegration + description: The integration definition. + type: object + properties: + name: + description: Required. The resource name of the integration. type: string - cronTab: + description: + description: Optional. type: string - description: Required. The cron tab of cloud scheduler trigger. - errorMessage: + updateTime: + description: Output only. Auto-generated. + readOnly: true type: string + format: google-datetime + active: + description: Required. If any integration version is published. + type: boolean + creatorEmail: description: >- - Optional. When the job was deleted from Pantheon UI, error_message - will be populated when Get/List integrations - EnterpriseCrmEventbusProtoLogSettings: - properties: - seedPeriod: - enum: - - SEED_PERIOD_UNSPECIFIED - - DAY - - WEEK - - MONTH - enumDescriptions: - - '' - - Sanitized values remain constant for the day of the event. - - >- - Sanitized values remain constant for the week of the event; may - cross month boundaries. - - Sanitized values remain constant for the month of the event. + Output only. The creator's email address. Generated based on the End + User Credentials/LOAS role of the user making the call. + readOnly: true type: string - seedScope: - enumDescriptions: - - '' - - Hash computations include the event name. - - Hash computations include a time period. - - Hash computations include the param name. + lastModifierEmail: + description: Required. The last modifier of this integration type: string - enum: - - SEED_SCOPE_UNSPECIFIED - - EVENT_NAME - - TIME_PERIOD - - PARAM_NAME - logFieldName: + createTime: + description: Required. Output only. Auto-generated. + readOnly: true type: string - description: >- - The name of corresponding logging field of the event property. If - omitted, assumes the same name as the event property key. - description: >- - The LogSettings define the logging attributes for an event property. - These attributes are used to map the property to the parameter in the - log proto. Also used to define scrubbing/truncation behavior and PII - information. - id: EnterpriseCrmEventbusProtoLogSettings - type: object - GoogleCloudIntegrationsV1alphaTemplate: + format: google-datetime + GoogleCloudIntegrationsV1alphaSearchIntegrationsResponse: + id: GoogleCloudIntegrationsV1alphaSearchIntegrationsResponse + description: Response for SearchIntegrations. type: object - description: Defines the template for Application Integration - id: GoogleCloudIntegrationsV1alphaTemplate properties: - visibility: - enum: - - VISIBILITY_UNSPECIFIED - - PRIVATE - - SHARED - - PUBLIC - enumDescriptions: - - Visibility is unspecified - - Visibility is private - - Visibility is shared - - Visibility is public - description: Required. Visibility of the template. - type: string - description: - description: >- - Optional. Description of the template. The length should not be more - than 255 characters - type: string - components: + integrations: + description: The list of integrations that match the search criteria. + type: array items: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaTemplateComponent - description: >- - Optional. Components being used in the template. This could be used - to categorize and filter. - type: array - templateBundle: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplateBundle' - description: >- - Required. Bundle which is part of the templates. The template - entities in the bundle would be converted to an actual entity. - usageInfo: + #/components/schemas/GoogleCloudIntegrationsV1alphaSearchIntegrationsResponseIntegrationSearchResult + nextPageToken: description: >- - Optional. Information on how to use the template. This should - contain detailed information about usage of the template. + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. type: string + GoogleCloudIntegrationsV1alphaSearchIntegrationsResponseIntegrationSearchResult: + id: >- + GoogleCloudIntegrationsV1alphaSearchIntegrationsResponseIntegrationSearchResult + description: The integration search result with integration level information. + type: object + properties: name: - description: Identifier. Resource name of the template. + description: The integration document metadata. type: string - categories: - description: >- - Required. Categories associated with the Template. The categories - listed below will be utilized for the Template listing. - type: array - items: - enumDescriptions: - - Category is unspecified - - AI_MACHINE_LEARNING - - BUSINESS_INTELLIGENCE - - COLLABORATION - - CUSTOMER_SERVICE - - DATAABASES - - DEVOPS_IT - - CONTENT_AND_FILES - - FINANCE_AND_ACCOUNTING - - HUMAN_RESOURCES - - OPERATIONS - - PRODUCT_PROJECT_MANAGEMENT - - PRODUCTIVITY - - SALES_AND_MARKETING - - UNIVERSAL_CONNECTORS - - UTILITY - - OTHERS - type: string - enum: - - CATEGORY_UNSPECIFIED - - AI_MACHINE_LEARNING - - BUSINESS_INTELLIGENCE - - COLLABORATION - - CUSTOMER_SERVICE - - DATABASES - - DEVOPS_IT - - CONTENT_AND_FILES - - FINANCE_AND_ACCOUNTING - - HUMAN_RESOURCES - - OPERATIONS - - PRODUCT_PROJECT_MANAGEMENT - - PRODUCTIVITY - - SALES_AND_MARKETING - - UNIVERSAL_CONNECTORS - - UTILITY - - OTHERS - sharedWith: - items: - type: string - type: array - description: >- - Required. Resource names with which the template is shared for - example ProjectNumber/Ord id - lastUsedTime: - description: Optional. Time the template was last used. + id: + description: The integration id. type: string - format: google-datetime - tags: - type: array - items: - type: string - description: >- - Required. Tags which are used to identify templates. These tags - could be for business use case, connectors etc. - updateTime: + creator: + description: The creator of the integration version. + type: string + description: + description: The description of the integration version. + type: string + status: + description: Output only. The status of the integration version. + readOnly: true + type: string + enumDescriptions: + - Default. + - Draft. + - Active. + - Archived. + - Snapshot. + enum: + - INTEGRATION_STATE_UNSPECIFIED + - DRAFT + - ACTIVE + - ARCHIVED + - SNAPSHOT + region: + description: The region of the integration version. + type: string + createTime: + description: Output only. The create time of the integration version. readOnly: true type: string - description: Output only. Auto-generated format: google-datetime - docLink: - description: Optional. Link to template documentation. + version: + description: The version of the integration version. type: string - usageCount: + GoogleCloudIntegrationsV1alphaSfdcChannel: + id: GoogleCloudIntegrationsV1alphaSfdcChannel + description: The SfdcChannel that points to a CDC or Platform Event Channel. + type: object + properties: + name: + description: >- + Resource name of the SFDC channel + projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}. type: string - description: Optional. Number of template usages. - format: int64 - author: - description: Optional. Creator of the template. + displayName: + description: >- + Optional. Client level unique name/alias to easily reference a + channel. + type: string + description: + description: Optional. The description for this channel + type: string + channelTopic: + description: >- + Required. The Channel topic defined by salesforce once an channel is + opened type: string + isActive: + description: >- + Output only. Indicated if a channel has any active integrations + referencing it. Set to false when the channel is created, and set to + true if there is any integration published with the channel + configured in it. + readOnly: true + type: boolean createTime: - description: Output only. Auto-generated. - format: google-datetime + description: Output only. Time when the channel is created readOnly: true type: string - displayName: + format: google-datetime + updateTime: + description: Output only. Time when the channel was last updated + readOnly: true type: string - description: Required. The name of the template - GoogleCloudIntegrationsV1alphaSuspensionAudit: - properties: - resolveTime: format: google-datetime + deleteTime: + description: >- + Output only. Time when the channel was deleted. Empty if not + deleted. + readOnly: true type: string - description: Time at which this suspension was resolved. - resolver: - description: Email address of the person who resolved this suspension. + format: google-datetime + lastReplayId: + description: Output only. Last sfdc messsage replay id for channel + readOnly: true type: string + GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse: + id: GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse + description: Response to list SfdcChannels. type: object - id: GoogleCloudIntegrationsV1alphaSuspensionAudit - description: Contains when and by whom the suspension was resolved. - EnterpriseCrmEventbusProtoTeardownTaskConfig: + properties: + sfdcChannels: + description: The list of SfdcChannels retrieved. + type: array + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + nextPageToken: + description: The token used to retrieve the next page of results. + type: string + GoogleCloudIntegrationsV1alphaSfdcInstance: + id: GoogleCloudIntegrationsV1alphaSfdcInstance + description: >- + The SfdcInstance resource use to hold channels and connection config + data. type: object - id: EnterpriseCrmEventbusProtoTeardownTaskConfig properties: name: + description: >- + Resource name of the SFDC instance + projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}. type: string + displayName: description: >- - Required. Unique identifier of the teardown task within this Config. - We use this field as the identifier to find next teardown tasks. - creatorEmail: + Optional. User selected unique name/alias to easily reference an + instance. type: string - description: The creator's email address. - nextTeardownTask: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoNextTeardownTask' - properties: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventBusProperties' - teardownTaskImplementationClassName: + description: + description: Optional. A description of the sfdc instance. type: string - description: Required. Implementation class name. - parameters: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' - description: The parameters the user can pass to this task. - EnterpriseCrmEventbusProtoIntParameterArray: - id: EnterpriseCrmEventbusProtoIntParameterArray - type: object - properties: - intValues: + sfdcOrgId: + description: The SFDC Org Id. This is defined in salesforce. + type: string + authConfigId: + description: A list of AuthConfigs that can be tried to open the channel to SFDC + type: array items: - format: int64 type: string - type: array - EnterpriseCrmEventbusProtoExternalTraffic: - properties: - retryRequestForQuota: - description: Enqueue the execution request due to quota issue - type: boolean - enableInternalIp: - description: >- - Indicates the client enables internal IP feature, this is applicable - for internal clients only. - type: boolean - gcpProjectId: - description: User’s GCP project id the traffic is referring to. + createTime: + description: Output only. Time when the instance is created + readOnly: true type: string - location: + format: google-datetime + updateTime: + description: Output only. Time when the instance was last updated + readOnly: true type: string - description: Location for the user's request. - gcpProjectNumber: + format: google-datetime + deleteTime: + description: >- + Output only. Time when the instance was deleted. Empty if not + deleted. + readOnly: true type: string - description: User’s GCP project number the traffic is referring to. - source: - enumDescriptions: - - '' - - '' - - '' - enum: - - SOURCE_UNSPECIFIED - - APIGEE - - SECURITY + format: google-datetime + serviceAuthority: + description: >- + Optional. URL used for API calls after authentication (the login + authority is configured within the referenced AuthConfig). type: string - id: EnterpriseCrmEventbusProtoExternalTraffic + GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse: + id: GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse + description: Response to list SfdcInstances. type: object - description: Represents external traffic type and id. - GoogleCloudIntegrationsV1alphaDoubleParameterArray: properties: - doubleValues: - description: Double number array. + sfdcInstances: + description: The list of SfdcInstances retrieved. type: array items: - type: number - format: double - type: object - description: This message only contains a field of double number array. - id: GoogleCloudIntegrationsV1alphaDoubleParameterArray - EnterpriseCrmEventbusProtoValueType: - properties: - protoValue: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - stringValue: - type: string - stringArray: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoStringArray' - doubleArray: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoDoubleArray' - booleanValue: - type: boolean - doubleValue: - type: number - format: double - intValue: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance' + nextPageToken: + description: The token used to retrieve the next page of results. type: string - format: int64 - intArray: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoIntArray' + GoogleCloudIntegrationsV1alphaResolveSuspensionRequest: + id: GoogleCloudIntegrationsV1alphaResolveSuspensionRequest + description: Request for [Suspensions.ResolveSuspensions]. type: object - description: >- - Used for define type for values. Currently supported value types include - int, string, double, array, and any proto message. - id: EnterpriseCrmEventbusProtoValueType - EnterpriseCrmEventbusProtoFieldMappingConfig: - id: EnterpriseCrmEventbusProtoFieldMappingConfig properties: - mappedFields: - type: array - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoMappedField' - description: >- - Field Mapping Config to map multiple output fields values from input - fields values. - type: object - EnterpriseCrmEventbusProtoFailurePolicy: - description: >- - Policy that defines the task retry logic and failure type. If no - FailurePolicy is defined for a task, all its dependent tasks will not be - executed (i.e, a `retry_strategy` of NONE will be applied). + suspension: + description: >- + Suspension, containing the event_execution_info_id, task_id, and + state to set on the corresponding suspension record. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSuspension' + GoogleCloudIntegrationsV1alphaSuspension: + id: GoogleCloudIntegrationsV1alphaSuspension + description: A record representing a suspension. type: object - id: EnterpriseCrmEventbusProtoFailurePolicy properties: - intervalInSeconds: + name: + description: Resource name for suspensions suspension/{suspension_id} type: string + eventExecutionInfoId: + description: Required. ID of the associated execution. + type: string + taskId: + description: Required. Task id of the associated SuspensionTask. + type: string + state: description: >- - Required if retry_strategy is FIXED_INTERVAL or - LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines - the initial interval for backoff. - format: int64 - retryCondition: - description: >- - Optional. The retry condition that will be evaluated for this - failure policy with the corresponding retry strategy. + Required. State of this suspension, indicating what action a + resolver has taken. + type: string + enumDescriptions: + - Unset state. + - The suspension has not yet been resolved. + - The resolver has rejected the suspension. + - The resolver has lifted the suspension. + enum: + - RESOLUTION_STATE_UNSPECIFIED + - PENDING + - REJECTED + - LIFTED + audit: + description: Metadata pertaining to the resolution of this suspension. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSuspensionAudit' + createTime: + description: Output only. Auto-generated. + readOnly: true + type: string + format: google-datetime + lastModifyTime: + description: Output only. Auto-generated. + readOnly: true type: string - maxNumRetries: - type: integer + format: google-datetime + suspensionConfig: description: >- - Required if retry_strategy is FIXED_INTERVAL or - LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines - the number of times the task will be retried if failed. - format: int32 - retryStrategy: - description: Defines what happens to the task upon failure. - enum: - - UNSPECIFIED - - IGNORE - - NONE - - FATAL - - FIXED_INTERVAL - - LINEAR_BACKOFF - - EXPONENTIAL_BACKOFF - - RESTART_WORKFLOW_WITH_BACKOFF - enumDescriptions: - - '' - - >- - Ignores the failure of this task. The rest of the workflow will be - executed Assuming this task succeeded. - - >- - Causes a permanent failure of the task. However, if the last - task(s) of event was successfully completed despite the failure of - this task, it has no impact on the workflow. - - >- - Causes a permanent failure of the event. It is different from NONE - because this will mark the event as FAILED by shutting down the - event execution. - - >- - The task will be retried from the failed task onwards after a - fixed delay. A max-retry count is required to be specified with - this strategy. A jitter is added to each exponential interval so - that concurrently failing tasks of the same type do not end up - retrying after the exact same exponential interval. - Max_num_retries and interval_in_seconds must be specified. - - >- - The task will be retried from the failed task onwards after a - fixed delay that linearly increases with each retry attempt. A - jitter is added to each exponential interval so that concurrently - failing tasks of the same type do not end up retrying after the - exact same exponential interval. A max-retry count is required to - be specified with this strategy. Max_num_retries and - interval_in_seconds must be specified. - - >- - The task will be retried after an exponentially increasing period - of time with each failure. A jitter is added to each exponential - interval so that concurrently failing tasks of the same type do - not end up retrying after the exact same exponential interval. A - max-retry count is required to be specified with this strategy. - `max_num_retries` and `interval_in_seconds` must be specified. - - >- - The entire workflow will be restarted with the initial parameters - that were set when the event was fired. A max-retry count is - required to be specified with this strategy. `max_num_retries` and - `interval_in_seconds` must be specified. + Controls the notifications and resolver permissions for this + suspension. + deprecated: true + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoSuspensionConfig' + integration: + description: Required. The name of the originating integration. type: string - GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse: - id: GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse + approvalConfig: + description: >- + Controls the notifications and approval permissions for this + suspension. + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaSuspensionApprovalConfig + GoogleCloudIntegrationsV1alphaSuspensionAudit: + id: GoogleCloudIntegrationsV1alphaSuspensionAudit + description: Contains when and by whom the suspension was resolved. + type: object properties: - noPermission: - type: boolean - description: Whether the user has no permission on the version or not. - nextPageToken: + resolveTime: + description: Time at which this suspension was resolved. type: string - description: >- - A token, which can be sent as `page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. - integrationVersions: + format: google-datetime + resolver: + description: Email address of the person who resolved this suspension. + type: string + EnterpriseCrmEventbusProtoSuspensionConfig: + id: EnterpriseCrmEventbusProtoSuspensionConfig + type: object + properties: + whoMayResolve: + description: Identities able to resolve this suspension. + type: array items: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + #/components/schemas/EnterpriseCrmEventbusProtoSuspensionAuthPermissions + customMessage: + description: >- + Optional information to provide recipients of the suspension in + addition to the resolution URL, typically containing relevant + parameter values from the originating workflow. + type: string + notifications: type: array - description: The integrations which match the request. + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoNotification' + suspensionExpiration: + description: >- + Indicates the next steps when no external actions happen on the + suspension. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoSuspensionExpiration' + EnterpriseCrmEventbusProtoSuspensionAuthPermissions: + id: EnterpriseCrmEventbusProtoSuspensionAuthPermissions + description: LINT.IfChange type: object - description: Response for ListIntegrationVersions. - GoogleCloudIntegrationsV1alphaRuntimeActionSchema: + properties: + mdbGroup: + type: string + loasRole: + type: string + gaiaIdentity: + description: Represents a Gaia identity for a person or service account. + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity + googleGroup: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity + EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity: + id: EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity type: object - id: GoogleCloudIntegrationsV1alphaRuntimeActionSchema properties: - outputSchema: - description: Output parameter schema for the action. + emailAddress: type: string - inputSchema: - description: Input parameter schema for the action. + gaiaId: type: string - action: - description: Name of the action. + format: int64 + EnterpriseCrmEventbusProtoNotification: + id: EnterpriseCrmEventbusProtoNotification + type: object + properties: + emailAddress: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoAddress' + pubsubTopic: type: string - description: Metadata of an action, including schemas for its inputs and outputs. + buganizerNotification: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBuganizerNotification' + escalatorQueue: + type: string + request: + description: >- + If the out-of-the-box email/pubsub notifications are not suitable + and custom logic is required, fire a workflow containing all info + needed to notify users to resume execution. + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoCustomSuspensionRequest EnterpriseCrmEventbusProtoAddress: - type: object id: EnterpriseCrmEventbusProtoAddress description: >- Email address along with optional name and tokens. These tokens will be substituted for the variables in the form of [{var_name}], where var_name could be any string of no more than 32 bytes. + type: object properties: email: description: Required. @@ -8080,1240 +7846,1746 @@ components: name: type: string tokens: + type: array items: $ref: '#/components/schemas/EnterpriseCrmEventbusProtoToken' - type: array - GoogleCloudConnectorsV1DestinationConfig: - id: GoogleCloudConnectorsV1DestinationConfig - description: Define the Connectors target endpoint. + EnterpriseCrmEventbusProtoToken: + id: EnterpriseCrmEventbusProtoToken type: object properties: - destinations: - items: - $ref: '#/components/schemas/GoogleCloudConnectorsV1Destination' - description: The destinations for the key. - type: array - key: + name: + type: string + value: + type: string + EnterpriseCrmEventbusProtoBuganizerNotification: + id: EnterpriseCrmEventbusProtoBuganizerNotification + type: object + properties: + componentId: description: >- - The key is the destination identifier that is supported by the - Connector. + ID of the buganizer component within which to create a new issue. + Required. type: string - GoogleCloudIntegrationsV1alphaSerializedFile: + format: int64 + title: + description: Title of the issue to be created. Required. + type: string + assigneeEmailAddress: + description: Whom to assign the new bug. Optional. + type: string + templateId: + description: ID of the buganizer template to use. Optional. + type: string + format: int64 + EnterpriseCrmEventbusProtoCustomSuspensionRequest: + id: EnterpriseCrmEventbusProtoCustomSuspensionRequest type: object properties: - file: + suspensionInfoEventParameterKey: + description: >- + In the fired event, set the SuspensionInfo message as the value for + this key. + type: string + postToQueueWithTriggerIdRequest: + description: Request to fire an event containing the SuspensionInfo message. + $ref: >- + #/components/schemas/GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest + GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest: + id: GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest + description: >- + LINT.IfChange Use this request to post all workflows associated with a + given trigger id. Next available id: 13 + type: object + properties: + triggerId: + description: >- + Matched against all {@link TriggerConfig}s across all workflows. + i.e. TriggerConfig.trigger_id.equals(trigger_id) Required. type: string + clientId: description: >- - File information like Integration version, Integration Config - variables etc. - enum: - - INTEGRATION_FILE_UNSPECIFIED - - INTEGRATION - - INTEGRATION_CONFIG_VARIABLES - enumDescriptions: - - Default value. - - Integration file. - - Integration Config variables. - content: - description: String representation of the file content. + Optional. If the client id is provided, then the combination of + trigger id and client id is matched across all the workflows. If the + client id is not provided, then workflows with matching trigger id + are executed for each client id in the {@link TriggerConfig}. For + Api Trigger, the client id is required and will be validated against + the allowed clients. + type: string + parameters: + description: Passed in as parameters to each workflow execution. Optional. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' + priority: + description: >- + The request priority this request should be processed at. For + internal users: type: string - description: To store string representation of Integration file. - id: GoogleCloudIntegrationsV1alphaSerializedFile - EnterpriseCrmEventbusProtoCloudLoggingDetails: - description: >- - Cloud Logging details, selected by the user for the integration version - (workflow). This message field will be also used in ExecutionInfo, to - indicate the CloudLoggingDetails config at the time of workflow - (integration version) execution, since this field value can be changed - for an unpublished workflow. - id: EnterpriseCrmEventbusProtoCloudLoggingDetails - properties: - cloudLoggingSeverity: - enum: - - CLOUD_LOGGING_SEVERITY_UNSPECIFIED - - INFO - - ERROR - - WARNING enumDescriptions: - Unspecified - >- - If Severity selected is `INFO`, then all the Integration Execution - States (`IN_PROCESS`, `ON_HOLD`, `SUCCEEDED`, `SUSPENDED`, - `ERROR`, `CANCELLED`) will be sent to Cloud Logging. + Frequent partial and occasional full unavailability is expected + and not pageable. * Requests to this band will be shed before all + other requests. * This is the default for async calls sent from + batch jobs. - >- - If Severity selected is `ERROR`, then only the following - Integration Execution States (`ERROR`, `CANCELLED`) will be sent - to Cloud Logging. + Partial unavailability is expected and is not necessarily + pageable. * Requests to this band will be shed before any critical + traffic. * This is the default for async calls sent from + production jobs. - >- - If Severity selected is `WARNING`, then only the following - Integration Execution States (`ERROR`, `CANCELLED`) will be sent - to Cloud Logging. + Any outage is a pageable event. * During a production outage + requests in this band will only be shed before CRITICAL_PLUS. * + This is the default for sync calls sent from production jobs. + - >- + Any outage is a pageable event. * The guideline is for < 10% of + requests to a service to be in this band. * During a production + outage requests in this band will be prioritized above all others. + * Opt-in to CRITICAL_PLUS when your workflow triggers by human. + enum: + - UNSPCIFIED + - SHEDDABLE + - SHEDDABLE_PLUS + - CRITICAL + - CRITICAL_PLUS + testMode: description: >- - Severity selected by the customer for the logs to be sent to Cloud - Logging, for the integration version getting executed. - type: string - enableCloudLogging: + Optional. Sets test mode in {@link + enterprise/crm/eventbus/event_message.proto}. type: boolean + scheduledTime: description: >- - Status of whether Cloud Logging is enabled or not for the - integration version getting executed. - type: object - EnterpriseCrmEventbusProtoStringArray: - type: object - id: EnterpriseCrmEventbusProtoStringArray - properties: - values: - type: array - items: - type: string - GoogleCloudIntegrationsV1alphaDownloadTemplateResponse: - description: Response for DownloadTemplate. - type: object - id: GoogleCloudIntegrationsV1alphaDownloadTemplateResponse - properties: - content: + Optional. Time in milliseconds since epoch when the given event + would be scheduled. type: string - description: String representation of the template. - GoogleCloudIntegrationsV1alphaOidcToken: - properties: - serviceAccountEmail: - description: The service account email to be used as the identity for the token. + format: int64 + ignoreErrorIfNoActiveWorkflow: + description: >- + Optional. Flag to determine whether clients would suppress a warning + when no ACTIVE workflows are not found. If this flag is set to be + true, an error will not be thrown if the requested trigger_id or + client_id is not found in any ACTIVE workflow. Otherwise, the error + is always thrown. The flag is set to be false by default. + type: boolean + workflowName: + description: >- + Optional. If provided, the workflow_name is used to filter all the + matched workflows having same trigger_id+client_id. A combination of + trigger_id, client_id and workflow_name identifies a unique + workflow. type: string - audience: + requestId: description: >- - Audience to be used when generating OIDC token. The audience claim - identifies the recipients that the JWT is intended for. + Optional. This is used to de-dup incoming request: if the duplicate + request was detected, the response from the previous execution is + returned. Must have no more than 36 characters and contain only + alphanumeric characters and hyphens. type: string - token: - description: ID token obtained for the service account + resourceName: + description: >- + This field is only required when using Admin Access. The resource + name of target, or the parent resource name. For example: + "projects/*/locations/*/integrations/*" type: string - tokenExpireTime: - format: google-datetime + userGeneratedExecutionId: + description: >- + This is a unique id provided by the method caller. If provided this + will be used as the execution_id when a new execution info is + created. This is a string representation of a UUID. Must have no + more than 36 characters and contain only alphanumeric characters and + hyphens. type: string - description: The approximate time until the token retrieved is valid. - id: GoogleCloudIntegrationsV1alphaOidcToken - description: OIDC Token + quotaRetryCount: + description: >- + Optional. This is a field to see the quota retry count for + integration execution + type: integer + format: int32 + EnterpriseCrmEventbusProtoSuspensionExpiration: + id: EnterpriseCrmEventbusProtoSuspensionExpiration type: object - GoogleCloudIntegrationsV1alphaSuspensionApprovalExpiration: properties: + remindAfterMs: + description: >- + Milliseconds after which the previous suspension action reminder, if + any, is sent using the selected notification option, for a + suspension which is still PENDING_UNSPECIFIED. + type: integer + format: int32 + expireAfterMs: + description: Milliseconds after which the suspension expires, if no action taken. + type: integer + format: int32 liftWhenExpired: - type: boolean description: >- Whether the suspension will be REJECTED or LIFTED upon expiration. REJECTED is the default behavior. + type: boolean + GoogleCloudIntegrationsV1alphaSuspensionApprovalConfig: + id: GoogleCloudIntegrationsV1alphaSuspensionApprovalConfig + description: Configurations for approving the Suspension. + type: object + properties: + customMessage: + description: Information to provide for recipients. + type: string + emailAddresses: + description: Email addresses to send approval request to. + type: array + items: + type: string + expiration: + description: >- + Indicates the next steps when no external actions happen on the + suspension. + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaSuspensionApprovalExpiration + GoogleCloudIntegrationsV1alphaSuspensionApprovalExpiration: + id: GoogleCloudIntegrationsV1alphaSuspensionApprovalExpiration + description: Expiration configs for the approval request. + type: object + properties: remindTime: description: >- Time after the previous suspension action reminder, if any, is sent using the selected notification option, for a suspension which is still PENDING_UNSPECIFIED. - format: google-datetime type: string - expireTime: format: google-datetime + expireTime: description: >- Output only. Time after which the suspension expires, if no action taken. readOnly: true type: string - type: object - id: GoogleCloudIntegrationsV1alphaSuspensionApprovalExpiration - description: Expiration configs for the approval request. - GoogleCloudIntegrationsV1alphaProvisionClientRequest: - description: Request for the Provision rpc - properties: - createSampleWorkflows: - type: boolean - description: >- - Optional. Indicates if sample workflow should be created along with - provisioning - cloudKmsConfig: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCloudKmsConfig' + format: google-datetime + liftWhenExpired: description: >- - Optional. OPTIONAL: Cloud KMS config for AuthModule to - encrypt/decrypt credentials. - skipCpProvision: - description: Optional. Indicates if skip CP provision or not - type: boolean - provisionGmek: + Whether the suspension will be REJECTED or LIFTED upon expiration. + REJECTED is the default behavior. type: boolean - description: >- - Optional. Deprecated. Indicates provision with GMEK or CMEK. This - field is deprecated and the provision would always be GMEK if - cloud_kms_config is not present in the request. - deprecated: true - runAsServiceAccount: - description: >- - Optional. User input run-as service account, if empty, will bring up - a new default service account - type: string - id: GoogleCloudIntegrationsV1alphaProvisionClientRequest - type: object - EnterpriseCrmFrontendsEventbusProtoProtoParameterArray: - id: EnterpriseCrmFrontendsEventbusProtoProtoParameterArray - type: object - properties: - protoValues: - type: array - items: - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: object - GoogleCloudConnectorsV1AuthConfigSshPublicKey: - description: Parameters to support Ssh public key Authentication. - type: object - properties: - sshClientCert: - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' - description: SSH Client Cert. It should contain both public and private key. - sshClientCertPass: - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' - description: Password (passphrase) for ssh client certificate if it has one. - certType: - description: Format of SSH Client cert. - type: string - username: - type: string - description: The user account used to authenticate. - id: GoogleCloudConnectorsV1AuthConfigSshPublicKey - GoogleCloudIntegrationsV1alphaReplayExecutionRequest: - id: GoogleCloudIntegrationsV1alphaReplayExecutionRequest - type: object - properties: - replayReason: - type: string - description: Required. The user provided reason for replaying the execution. - description: Request for replaying an execution. - GoogleCloudIntegrationsV1alphaUploadTestCaseRequest: - properties: - fileFormat: - enum: - - FILE_FORMAT_UNSPECIFIED - - JSON - - YAML - description: File format for upload request. - enumDescriptions: - - Unspecified file format - - JSON File Format - - YAML File Format - type: string - content: - type: string - description: The textproto of the test case. + GoogleCloudIntegrationsV1alphaResolveSuspensionResponse: + id: GoogleCloudIntegrationsV1alphaResolveSuspensionResponse + description: Response for Suspensions.ResolveSuspensions. type: object - id: GoogleCloudIntegrationsV1alphaUploadTestCaseRequest - description: Request for UploadTestCase. - EnterpriseCrmEventbusProtoTaskMetadataAdmin: + properties: {} + GoogleCloudIntegrationsV1alphaListSuspensionsResponse: + id: GoogleCloudIntegrationsV1alphaListSuspensionsResponse + description: Response for Suspensions.ListSuspensions. type: object - id: EnterpriseCrmEventbusProtoTaskMetadataAdmin properties: - googleGroupEmail: - type: string - userEmail: + suspensions: + description: >- + The suspensions for the relevant execution which the caller has + permissions to view and resolve. + type: array + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSuspension' + nextPageToken: + description: Token to retrieve the next page of results. type: string - description: >- - Admins are owners of a Task, and have all permissions on a particular - task identified by the task name. By default, Eventbus periodically - scans all task metadata and syncs (adds) any new admins defined here to - Zanzibar. - GoogleCloudConnectorsV1AuthConfigUserPassword: + GoogleCloudIntegrationsV1alphaLiftSuspensionRequest: + id: GoogleCloudIntegrationsV1alphaLiftSuspensionRequest + description: Request for lift Suspension + type: object properties: - password: - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' - description: Secret version reference containing the password. - username: - description: Username. + suspensionResult: + description: >- + User passed in suspension result and will be used to control + workflow execution branching behavior by setting up corresponnding + edge condition with suspension result. For example, if you want to + lift the suspension, you can pass "Approved", or if you want to + reject the suspension and terminate workfloe execution, you can pass + "Rejected" and terminate the workflow execution with configuring the + edge condition. type: string - description: Parameters to support Username and Password Authentication. - type: object - id: GoogleCloudConnectorsV1AuthConfigUserPassword - GoogleCloudIntegrationsV1alphaIntegrationVersionTemplate: - id: GoogleCloudIntegrationsV1alphaIntegrationVersionTemplate + GoogleCloudIntegrationsV1alphaLiftSuspensionResponse: + id: GoogleCloudIntegrationsV1alphaLiftSuspensionResponse + description: Response of lift Suspense type: object properties: - key: - description: Required. Unique Key of the IntegrationVersion. + eventExecutionInfoId: + description: Execution Id that will be returned type: string - integrationVersion: - description: Required. Templatized version of integration. - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion - description: Define the template of IntegrationVersion. - EnterpriseCrmEventbusProtoCombinedCondition: + GoogleCloudIntegrationsV1alphaTestCase: + id: GoogleCloudIntegrationsV1alphaTestCase description: >- - This message recursively combines constituent conditions using logical - AND. - properties: - conditions: - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCondition' - type: array - description: A set of individual constituent conditions. + Defines the functional test case for Application Integration. Next + available id: 15 type: object - id: EnterpriseCrmEventbusProtoCombinedCondition - deprecated: true - EnterpriseCrmEventbusProtoSuspensionAuthPermissions: - description: LINT.IfChange properties: - googleGroup: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity - loasRole: + name: + description: Output only. Auto-generated primary key. + readOnly: true type: string - gaiaIdentity: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity - description: Represents a Gaia identity for a person or service account. - mdbGroup: + displayName: + description: Required. The display name of test case. type: string - id: EnterpriseCrmEventbusProtoSuspensionAuthPermissions - type: object - GoogleProtobufEmpty: - properties: {} - description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } - id: GoogleProtobufEmpty - type: object - EnterpriseCrmFrontendsEventbusProtoTaskConfig: - properties: - taskNumber: + description: + description: Optional. Description of the test case. type: string + triggerId: description: >- - REQUIRED: the identifier of this task within its parent event - config, specified by the client. This should be unique among all the - tasks belong to the same event config. We use this field as the - identifier to find next tasks (via field `next_tasks.task_number`). - failurePolicy: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFailurePolicy' + Required. This defines the trigger ID in workflow which is + considered to be executed as starting point of the test case + type: string + testInputParameters: description: >- - Optional. Determines the number of times the task will be retried on - failure and with what retry strategy. This is applicable for - asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.). - disableStrictTypeValidation: - type: boolean + Optional. Parameters that are expected to be passed to the test case + when the test case is triggered. This gives the user the ability to + provide default values. This should include all the output variables + of the trigger as input variables. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationParameter + testTaskConfigs: description: >- - If this config contains a TypedTask, allow validation to succeed if - an input is read from the output of another TypedTask whose output - type is declared as a superclass of the requested input type. For - instance, if the previous task declares an output of type Message, - any task with this flag enabled will pass validation when attempting - to read any proto Message type from the resultant Event parameter. - label: - description: User-provided label that is attached to this TaskConfig in the UI. + Optional. However, the test case doesn't mock or assert anything + without test_task_configs. + type: array + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTestTaskConfig' + databasePersistencePolicy: + description: >- + Optional. Various policies for how to persist the test execution + info including execution info, execution export info, execution + metadata index and execution param index.. type: string - precondition: + enumDescriptions: + - Enables persistence for all execution data. + - Disables persistence for all execution data. + - Asynchronously persist all execution data. + enum: + - DATABASE_PERSISTENCE_POLICY_UNSPECIFIED + - DATABASE_PERSISTENCE_DISABLED + - DATABASE_PERSISTENCE_ASYNC + creatorEmail: description: >- - Optional. Standard filter expression evaluated before execution. - Independent of other conditions and tasks. Can be used to enable - rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to - task. + Optional. The creator's email address. Generated based on the End + User Credentials/LOAS role of the user making the call. type: string - taskSpec: + createTime: + description: Auto-generated. type: string + format: google-datetime + lastModifierEmail: description: >- - A string template that allows user to configure task parameters - (with either literal default values or tokens which will be resolved - at execution time) for the task. It will eventually replace the old - "parameters" field. - nextTasksExecutionPolicy: - enumDescriptions: - - Default - - Execute all the tasks that satisfy their associated condition. - - Execute the first task that satisfies the associated condition. + The last modifier's email address. Generated based on the End User + Credentials/LOAS role of the user making the call. type: string + updateTime: + description: Auto-generated. + type: string + format: google-datetime + lockHolderEmail: description: >- - The policy dictating the execution of the next set of tasks for the - current task. - enum: - - UNSPECIFIED - - RUN_ALL_MATCH - - RUN_FIRST_MATCH - alertConfigs: - type: array - description: >- - Alert configurations on error rate, warning rate, number of runs, - durations, etc. - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTaskAlertConfig' - taskTemplateName: + Optional. The edit lock holder's email address. Generated based on + the End User Credentials/LOAS role of the user making the call. type: string - description: Used to define task-template name if task is of type task-template - synchronousCallFailurePolicy: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFailurePolicy' + triggerConfig: + description: Optional. Auto-generated. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTriggerConfig' + GoogleCloudIntegrationsV1alphaTestTaskConfig: + id: GoogleCloudIntegrationsV1alphaTestTaskConfig + description: >- + The task mock configuration details and assertions for functional tests. + Next available id: 6 + type: object + properties: + taskNumber: description: >- - Optional. Determines the number of times the task will be retried on - failure and with what retry strategy. This is applicable for - synchronous calls to Eventbus alone (Post). - successPolicy: - description: Determines what action to take upon successful task completion. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoSuccessPolicy' - description: + Required. This defines in the test case, the task in integration + which will be mocked by this test task config type: string + mockConfig: + description: Optional. Defines how to mock the given task during test execution + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaMockConfig' + assertions: description: >- - User-provided description intended to give more business context - about the task. - jsonValidationOption: + Optional. List of conditions or expressions which should be + evaluated to true unless there is a bug/problem in the integration. + These are evaluated one the task execution is completed as per the + mock strategy in test case + type: array + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAssertion' + task: + description: >- + Required. This defines in the test case, the task name in + integration which will be mocked by this test task config + type: string + taskConfig: + description: Optional. Auto-generated. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTaskConfig' + GoogleCloudIntegrationsV1alphaMockConfig: + id: GoogleCloudIntegrationsV1alphaMockConfig + description: >- + The configuration for mocking of a task during test execution Next + available id: 4 + type: object + properties: + mockStrategy: + description: >- + Mockstrategy defines how the particular task should be mocked during + test execution type: string enumDescriptions: + - This should never be used to annotate a field + - Execute actual task - >- - As per the default behavior, no validation will be run. Will not - override any option set in a Task. - - Do not run any validation against JSON schemas. - - >- - Validate all potential input JSON parameters against schemas - specified in WorkflowParameters. - - >- - Validate all potential output JSON parameters against schemas - specified in WorkflowParameters. - - Perform both PRE_EXECUTION and POST_EXECUTION validations. + Don't execute actual task, instead use the values specified by + user for output of the task + - Don't execute actual task, instead return task failure + - Don't execute actual task, instead mark it as successful enum: - - UNSPECIFIED_JSON_VALIDATION_OPTION - - SKIP - - PRE_EXECUTION - - POST_EXECUTION - - PRE_POST_EXECUTION - description: >- - If set, overrides the option configured in the Task implementation - class. - position: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCoordinate' + - MOCK_STRATEGY_UNSPECIFIED + - NO_MOCK_STRATEGY + - SPECIFIC_MOCK_STRATEGY + - FAILURE_MOCK_STRATEGY + - SKIP_MOCK_STRATEGY + parameters: + description: Optional. List of key-value pairs for specific mock strategy + type: array + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaEventParameter' + failedExecutions: description: >- - Optional. Informs the front-end application where to draw this task - config on the UI. - incomingEdgeCount: - type: integer - description: The number of edges leading into this TaskConfig. - format: int32 - creatorEmail: + Optional. Number of times the given task should fail for failure + mock strategy type: string - description: The creator's email address. Auto-generated from the user's email. - externalTaskType: + format: int64 + GoogleCloudIntegrationsV1alphaAssertion: + id: GoogleCloudIntegrationsV1alphaAssertion + description: >- + An assertion which will check for a condition over task execution status + or an expression for task output variables + type: object + properties: + assertionStrategy: + description: Optional. The type of assertion to perform. type: string - enum: - - EXTERNAL_TASK_TYPE_UNSPECIFIED - - NORMAL_TASK - - ERROR_TASK enumDescriptions: - - Default value. External task type is not specified - - Tasks belongs to the normal task flows - - Task belongs to the error catch task flows - createTime: - format: google-datetime - description: Auto-generated. + - Unspecified Assertion strategy + - Test a successful execution + - Test a failed execution + - Test that the task was never executed + - Test the parameter selected is equal to the expected value + - Test the parameter selected is not equal to the expected value + - Test the parameter selected contains the configured value + - Test a specific condition + enum: + - ASSERTION_STRATEGY_UNSPECIFIED + - ASSERT_SUCCESSFUL_EXECUTION + - ASSERT_FAILED_EXECUTION + - ASSERT_NO_EXECUTION + - ASSERT_EQUALS + - ASSERT_NOT_EQUALS + - ASSERT_CONTAINS + - ASSERT_CONDITION + parameter: + description: >- + Optional. Key-value pair for ASSERT_EQUALS, ASSERT_NOT_EQUALS, + ASSERT_CONTAINS to succeed + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaEventParameter' + condition: + description: Optional. Standard filter expression for ASSERT_CONDITION to succeed type: string - conditionalFailurePolicies: + retryCount: description: >- - Optional. Determines the number of times the task will be retried on - failure and with what retry strategy. This is applicable for - synchronous calls to Eventbus alone (Post). - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoConditionalFailurePolicies - rollbackStrategy: + Number of times given task should be retried in case of + ASSERT_FAILED_EXECUTION + type: integer + format: int32 + GoogleCloudIntegrationsV1alphaListTestCasesResponse: + id: GoogleCloudIntegrationsV1alphaListTestCasesResponse + description: Response for ListTestCases + type: object + properties: + testCases: + description: The test cases corresponding to the specified filter + type: array + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTestCase' + nextPageToken: description: >- - Optional. Contains information about what needs to be done upon - failure (either a permanent error or after it has been retried too - many times). - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoRollbackStrategy - taskName: - description: The name for the task. + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. type: string - parameters: + GoogleCloudIntegrationsV1alphaExecuteTestCaseRequest: + id: GoogleCloudIntegrationsV1alphaExecuteTestCaseRequest + description: The request for executing a functional test. + type: object + properties: + inputParameters: + description: Optional. Input parameters used by test case execution. type: object additionalProperties: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry - description: The customized parameters the user can pass to this task. - errorCatcherId: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' + GoogleCloudIntegrationsV1alphaExecuteTestCaseResponse: + id: GoogleCloudIntegrationsV1alphaExecuteTestCaseResponse + description: The response for executing a functional test. + type: object + properties: + executionId: + description: The id of the execution corresponding to this run of integration. + type: string + outputParameters: description: >- - Optional Error catcher id of the error catch flow which will be - executed when execution error happens in the task + OUTPUT parameters in format of Map. Where Key is the name of the + parameter. Note: Name of the system generated parameters are wrapped + by backtick(`) to distinguish them from the user defined parameters. + type: object + additionalProperties: + type: any + description: Properties of the object. + assertionResults: + description: Results of each assertions ran during execution of test case. + type: array + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAssertionResult' + testExecutionState: + description: State of the test case execution type: string - lastModifiedTime: - format: google-datetime - description: Auto-generated. + enumDescriptions: + - Unspecified state + - Test case execution passed + - Test case execution failed + enum: + - STATE_UNSPECIFIED + - PASSED + - FAILED + GoogleCloudIntegrationsV1alphaAssertionResult: + id: GoogleCloudIntegrationsV1alphaAssertionResult + description: The result of an assertion. + type: object + properties: + assertion: + description: Assertion that was run. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAssertion' + taskNumber: + description: Task number of task where the assertion was run. type: string - taskExecutionStrategy: + taskName: + description: Task name of task where the assertion was run. + type: string + status: + description: Status of assertion to signify if the assertion succeeded or failed + type: string + enumDescriptions: + - Unspecified assertion status + - Assertion succeeded + - Assertion failed enum: - - WHEN_ALL_SUCCEED - - WHEN_ANY_SUCCEED - - WHEN_ALL_TASKS_AND_CONDITIONS_SUCCEED - description: The policy dictating the execution strategy of this task. + - ASSERTION_STATUS_UNSPECIFIED + - SUCCEEDED + - FAILED + failureMessage: + description: Details of the assertion failure + type: string + GoogleCloudIntegrationsV1alphaUploadTestCaseRequest: + id: GoogleCloudIntegrationsV1alphaUploadTestCaseRequest + description: Request for UploadTestCase. + type: object + properties: + content: + description: The textproto of the test case. + type: string + fileFormat: + description: File format for upload request. type: string enumDescriptions: - - >- - Wait until all of its previous tasks finished execution, then - verify at least one of the edge conditions is met, and execute if - possible. This should be considered as WHEN_ALL_TASKS_SUCCEED. - - >- - Start execution as long as any of its previous tasks finished - execution and the corresponding edge condition is met (since we - will execute if only that succeeding edge condition is met). - - >- - Wait until all of its previous tasks finished execution, then - verify the all edge conditions are met and execute if possible. - taskEntity: - description: Copy of the task entity that this task config is an instance of. - $ref: '#/components/schemas/EnterpriseCrmFrontendsEventbusProtoTaskEntity' - nextTasks: - description: >- - The set of tasks that are next in line to be executed as per the - execution graph defined for the parent event, specified by - `event_config_id`. Each of these next tasks are executed only if the - condition associated with them evaluates to true. + - Unspecified file format + - JSON File Format + - YAML File Format + enum: + - FILE_FORMAT_UNSPECIFIED + - JSON + - YAML + GoogleCloudIntegrationsV1alphaUploadTestCaseResponse: + id: GoogleCloudIntegrationsV1alphaUploadTestCaseResponse + description: Response for UploadTestCase. + type: object + properties: + testCase: + description: The uploaded TestCase + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTestCase' + GoogleCloudIntegrationsV1alphaDownloadTestCaseResponse: + id: GoogleCloudIntegrationsV1alphaDownloadTestCaseResponse + description: Response for DownloadTestCase. + type: object + properties: + content: + description: String representation of the test case. + type: string + GoogleCloudIntegrationsV1alphaTakeoverTestCaseEditLockRequest: + id: GoogleCloudIntegrationsV1alphaTakeoverTestCaseEditLockRequest + description: Request for TakeoverTestCaseEditLock. + type: object + properties: {} + GoogleCloudIntegrationsV1alphaExecuteTestCasesRequest: + id: GoogleCloudIntegrationsV1alphaExecuteTestCasesRequest + description: Request for ExecuteTestCases. + type: object + properties: {} + GoogleCloudIntegrationsV1alphaExecuteTestCasesResponse: + id: GoogleCloudIntegrationsV1alphaExecuteTestCasesResponse + description: Response for ExecuteTestCases. + type: object + properties: + executeTestCaseResponses: + description: Results of each execution of test cases in an integration version. + type: array items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoNextTask' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaExecuteTestCaseResponse + GoogleCloudIntegrationsV1alphaListTemplatesResponse: + id: GoogleCloudIntegrationsV1alphaListTemplatesResponse + description: Response for a request to list templates + type: object + properties: + templates: + description: List of templates retrieved. type: array - taskType: - enum: - - TASK - - ASIS_TEMPLATE - - IO_TEMPLATE - type: string - enumDescriptions: - - Normal IP task - - Task is of As-Is Template type - - Task is of I/O template type with a different underlying task - description: Defines the type of the task - preconditionLabel: + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' + nextPageToken: + description: The token used to retrieve the next page results. type: string - description: >- - Optional. User-provided label that is attached to precondition in - the UI. - id: EnterpriseCrmFrontendsEventbusProtoTaskConfig - description: >- - The task configuration details. This is not the implementation of Task. - There might be multiple TaskConfigs for the same Task. + GoogleCloudIntegrationsV1alphaTemplate: + id: GoogleCloudIntegrationsV1alphaTemplate + description: Defines the template for Application Integration type: object - GoogleCloudIntegrationsV1alphaTestCase: - id: GoogleCloudIntegrationsV1alphaTestCase properties: - triggerId: - type: string - description: >- - Required. This defines the trigger ID in workflow which is - considered to be executed as starting point of the test case - creatorEmail: - description: >- - Optional. The creator's email address. Generated based on the End - User Credentials/LOAS role of the user making the call. + name: + description: Identifier. Resource name of the template. type: string - lastModifierEmail: - description: >- - The last modifier's email address. Generated based on the End User - Credentials/LOAS role of the user making the call. + displayName: + description: Required. The name of the template type: string description: - type: string - description: Optional. Description of the test case. - databasePersistencePolicy: - enum: - - DATABASE_PERSISTENCE_POLICY_UNSPECIFIED - - DATABASE_PERSISTENCE_DISABLED - - DATABASE_PERSISTENCE_ASYNC description: >- - Optional. Various policies for how to persist the test execution - info including execution info, execution export info, execution - metadata index and execution param index.. - enumDescriptions: - - Enables persistence for all execution data. - - Disables persistence for all execution data. - - Asynchronously persist all execution data. - type: string - lockHolderEmail: + Optional. Description of the template. The length should not be more + than 255 characters type: string + usageInfo: description: >- - Optional. The edit lock holder's email address. Generated based on - the End User Credentials/LOAS role of the user making the call. - createTime: + Optional. Information on how to use the template. This should + contain detailed information about usage of the template. type: string - format: google-datetime - description: Auto-generated. - displayName: - description: Required. The display name of test case. + docLink: + description: Optional. Link to template documentation. type: string - triggerConfig: - description: Optional. Auto-generated. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTriggerConfig' - testTaskConfigs: - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTestTaskConfig' + templateBundle: description: >- - Optional. However, the test case doesn't mock or assert anything - without test_task_configs. - type: array - updateTime: - type: string - description: Auto-generated. - format: google-datetime - name: - type: string - readOnly: true - description: Output only. Auto-generated primary key. - testInputParameters: + Required. Bundle which is part of the templates. The template + entities in the bundle would be converted to an actual entity. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplateBundle' + components: description: >- - Optional. Parameters that are expected to be passed to the test case - when the test case is triggered. This gives the user the ability to - provide default values. This should include all the output variables - of the trigger as input variables. + Optional. Components being used in the template. This could be used + to categorize and filter. type: array items: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationParameter - type: object - description: >- - Defines the functional test case for Application Integration. Next - available id: 15 - EnterpriseCrmEventbusProtoCloudKmsConfig: - properties: - keyRingName: - type: string + #/components/schemas/GoogleCloudIntegrationsV1alphaTemplateComponent + tags: description: >- - A key ring organizes keys in a specific Google Cloud location and - allows you to manage access control on groups of keys. A key ring's - name does not need to be unique across a Google Cloud project, but - must be unique within a given location. - keyName: - type: string + Required. Tags which are used to identify templates. These tags + could be for business use case, connectors etc. + type: array + items: + type: string + categories: description: >- - A Cloud KMS key is a named object containing one or more key - versions, along with metadata for the key. A key exists on exactly - one key ring tied to a specific location. - serviceAccount: + Required. Categories associated with the Template. The categories + listed below will be utilized for the Template listing. + type: array + items: + type: string + enumDescriptions: + - Category is unspecified + - AI_MACHINE_LEARNING + - BUSINESS_INTELLIGENCE + - COLLABORATION + - CUSTOMER_SERVICE + - DATAABASES + - DEVOPS_IT + - CONTENT_AND_FILES + - FINANCE_AND_ACCOUNTING + - HUMAN_RESOURCES + - OPERATIONS + - PRODUCT_PROJECT_MANAGEMENT + - PRODUCTIVITY + - SALES_AND_MARKETING + - UNIVERSAL_CONNECTORS + - UTILITY + - OTHERS + enum: + - CATEGORY_UNSPECIFIED + - AI_MACHINE_LEARNING + - BUSINESS_INTELLIGENCE + - COLLABORATION + - CUSTOMER_SERVICE + - DATABASES + - DEVOPS_IT + - CONTENT_AND_FILES + - FINANCE_AND_ACCOUNTING + - HUMAN_RESOURCES + - OPERATIONS + - PRODUCT_PROJECT_MANAGEMENT + - PRODUCTIVITY + - SALES_AND_MARKETING + - UNIVERSAL_CONNECTORS + - UTILITY + - OTHERS + createTime: + description: Output only. Auto-generated. + readOnly: true type: string - description: >- - Optional. The service account used for authentication of this KMS - key. If this is not provided, the service account in - Client.clientSource will be used. - keyVersionName: - description: >- - Optional. Each version of a key contains key material used for - encryption or signing. A key's version is represented by an integer, - starting at 1. To decrypt data or verify a signature, you must use - the same key version that was used to encrypt or sign the data. + format: google-datetime + updateTime: + description: Output only. Auto-generated + readOnly: true type: string - gcpProjectId: - description: >- - Optional. The id of GCP project where the KMS key is stored. If not - provided, assume the key is stored in the same GCP project defined - in Client (tag 14). + format: google-datetime + author: + description: Optional. Creator of the template. type: string - locationName: - description: Location name of the key ring, e.g. "us-west1". + usageCount: + description: Optional. Number of template usages. type: string - id: EnterpriseCrmEventbusProtoCloudKmsConfig - type: object - GoogleCloudIntegrationsV1alphaListExecutionsResponse: - id: GoogleCloudIntegrationsV1alphaListExecutionsResponse - description: Response for listing the integration execution data. - properties: - nextPageToken: + format: int64 + lastUsedTime: + description: Optional. Time the template was last used. type: string - description: The token used to retrieve the next page results. - executions: + format: google-datetime + visibility: + description: Required. Visibility of the template. + type: string + enumDescriptions: + - Visibility is unspecified + - Visibility is private + - Visibility is shared + - Visibility is public + enum: + - VISIBILITY_UNSPECIFIED + - PRIVATE + - SHARED + - PUBLIC + sharedWith: + description: >- + Required. Resource names with which the template is shared for + example ProjectNumber/Ord id + type: array items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaExecution' - description: The detailed information of requested executions + type: string + GoogleCloudIntegrationsV1alphaTemplateBundle: + id: GoogleCloudIntegrationsV1alphaTemplateBundle + description: Define the bundle of the template. + type: object + properties: + integrationVersionTemplate: + description: Required. Main integration templates of the template bundle. + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersionTemplate + subIntegrationVersionTemplates: + description: >- + Optional. Sub integration templates which would be added along with + main integration. type: array - executionInfos: - description: Required. The detailed information of requested executions. items: $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventExecutionInfo - deprecated: true - type: array - type: object - EnterpriseCrmEventbusStatsDimensions: + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersionTemplate + GoogleCloudIntegrationsV1alphaIntegrationVersionTemplate: + id: GoogleCloudIntegrationsV1alphaIntegrationVersionTemplate + description: Define the template of IntegrationVersion. type: object properties: - warningEnumString: - type: string - retryAttempt: - enumDescriptions: - - '' - - >- - Task has completed successfully or has depleted all retry - attempts. - - Task has failed but may be retried. - - Task has been deliberately canceled. - enum: - - UNSPECIFIED - - FINAL - - RETRYABLE - - CANCELED - type: string - taskNumber: + key: + description: Required. Unique Key of the IntegrationVersion. type: string - enumFilterType: + integrationVersion: + description: Required. Templatized version of integration. + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + GoogleCloudIntegrationsV1alphaTemplateComponent: + id: GoogleCloudIntegrationsV1alphaTemplateComponent + description: Define the components that are present in a template. + type: object + properties: + type: + description: Optional. Type of the component. type: string enumDescriptions: - - '' - - '' + - Component type is unspecified + - Trigger component + - Task component + - Connector component enum: - - DEFAULT_INCLUSIVE - - EXCLUSIVE - description: Whether to include or exclude the enums matching the regex. - workflowName: - type: string - clientId: + - TYPE_UNSPECIFIED + - TRIGGER + - TASK + - CONNECTOR + name: + description: Optional. Name of the component. type: string - taskName: + GoogleCloudIntegrationsV1alphaSearchTemplatesResponse: + id: GoogleCloudIntegrationsV1alphaSearchTemplatesResponse + description: Response for a request to search templates + type: object + properties: + templates: + description: List of templates retrieved. + type: array + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' + nextPageToken: + description: The token used to retrieve the next page results. type: string - errorEnumString: + GoogleCloudIntegrationsV1alphaUseTemplateRequest: + id: GoogleCloudIntegrationsV1alphaUseTemplateRequest + description: Request to Use template + type: object + properties: + integrationDetails: + description: Required. Integration details which would be created via templates. + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails + subIntegrations: + description: Optional. Sub Integration which would be created via templates. + type: object + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails + integrationRegion: + description: Required. The region of the Integration to be created. type: string - triggerId: + GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails: + id: GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails + description: Sub Integration which would be created via templates. + type: object + properties: + integration: + description: >- + Required. Name of the sub integration which would be created via + templates. type: string + integrationDescription: description: >- - Stats have been or will be aggregated on set fields for any - semantically-meaningful combination. - workflowId: + Optional. Description of the sub integration which would be created + via templates. type: string - id: EnterpriseCrmEventbusStatsDimensions - EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity: + GoogleCloudIntegrationsV1alphaUseTemplateResponse: + id: GoogleCloudIntegrationsV1alphaUseTemplateResponse + description: Response for use template type: object - id: EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity properties: - gaiaId: - format: int64 - type: string - emailAddress: - type: string - GoogleCloudIntegrationsV1alphaOAuth2ClientCredentials: + integrationVersion: + description: IntegrationVersion which is created. + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + subIntegrationVersions: + description: Sub integration versions which are created. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + GoogleCloudIntegrationsV1alphaImportTemplateRequest: + id: GoogleCloudIntegrationsV1alphaImportTemplateRequest + description: Request to Import template type: object - id: GoogleCloudIntegrationsV1alphaOAuth2ClientCredentials properties: - scope: - description: A space-delimited list of requested scope permissions. - type: string - clientSecret: - type: string - description: The client's secret. - clientId: - description: The client's ID. - type: string - tokenParams: - description: Token parameters for the auth request. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMap' - accessToken: - description: Access token fetched from the authorization server. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAccessToken' - tokenEndpoint: + integration: description: >- - The token endpoint is used by the client to obtain an access token - by presenting its authorization grant or refresh token. - type: string - requestType: - description: Represent how to pass parameters to fetch access token - enum: - - REQUEST_TYPE_UNSPECIFIED - - REQUEST_BODY - - QUERY_PARAMETERS - - ENCODED_HEADER + Required. Resource Name of the integration where template needs to + be imported/inserted. type: string - enumDescriptions: - - Unspecified request type - - To pass all the parameters in post body. - - To pass all the parameters as a part of query parameter. - - >- - To pass client id and client secret as base 64 encoding of - client_id:client_password and rest parameters in post body. - description: >- - For client credentials grant, the client sends a POST request with - grant_type as 'client_credentials' to the authorization server. The - authorization server will respond with a JSON object containing the - access token. - GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse: - description: Response for UploadIntegrationVersion. + subIntegrations: + description: Optional. Sub Integration which would be created via templates. + type: object + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails + GoogleCloudIntegrationsV1alphaImportTemplateResponse: + id: GoogleCloudIntegrationsV1alphaImportTemplateResponse + description: Response for import template + type: object properties: integrationVersion: + description: IntegrationVersion after the import. $ref: >- #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion - description: The uploaded integration. - id: GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse + subIntegrationVersions: + description: Sub integration versions which are imported. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + GoogleCloudIntegrationsV1alphaShareTemplateRequest: + id: GoogleCloudIntegrationsV1alphaShareTemplateRequest + description: Request to Share template type: object - GoogleCloudIntegrationsV1alphaSfdcChannel: - description: The SfdcChannel that points to a CDC or Platform Event Channel. - id: GoogleCloudIntegrationsV1alphaSfdcChannel + properties: + resourceNames: + description: >- + Optional. Project name resources to share the template. The project + names is expected in resource format Ex: projects/{project-number} + or organization/{org-id} + type: array + items: + type: string + GoogleCloudIntegrationsV1alphaUnshareTemplateRequest: + id: GoogleCloudIntegrationsV1alphaUnshareTemplateRequest + description: Request to Unshare template + type: object + properties: + resourceNames: + description: >- + Optional. Project name resources to unshare the template. The + project names is expected in resource format Ex: + projects/{project-number} + type: array + items: + type: string + GoogleCloudIntegrationsV1alphaUploadTemplateRequest: + id: GoogleCloudIntegrationsV1alphaUploadTemplateRequest + description: Request for UploadTemplate. + type: object + properties: + content: + description: Required. The textproto of the template. + type: string + fileFormat: + description: Required. File format for upload request. + type: string + enumDescriptions: + - Unspecified file format + - JSON File Format + - YAML File Format + enum: + - FILE_FORMAT_UNSPECIFIED + - JSON + - YAML + GoogleCloudIntegrationsV1alphaUploadTemplateResponse: + id: GoogleCloudIntegrationsV1alphaUploadTemplateResponse + description: Response for UploadTemplate. type: object properties: - displayName: + template: + description: The uploaded Template + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' + GoogleCloudIntegrationsV1alphaDownloadTemplateResponse: + id: GoogleCloudIntegrationsV1alphaDownloadTemplateResponse + description: Response for DownloadTemplate. + type: object + properties: + content: + description: String representation of the template. type: string - description: Client level unique name/alias to easily reference a channel. - name: - description: >- - Resource name of the SFDC channel - projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}. + GoogleCloudIntegrationsV1alphaGenerateOpenApiSpecRequest: + id: GoogleCloudIntegrationsV1alphaGenerateOpenApiSpecRequest + description: Request for GenerateOpenApiSpec. + type: object + properties: + apiTriggerResources: + description: Required. List of api triggers + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaApiTriggerResource + fileFormat: + description: Required. File format for generated spec. type: string - description: + enumDescriptions: + - Unspecified file format + - JSON File Format + - YAML File Format + enum: + - FILE_FORMAT_UNSPECIFIED + - JSON + - YAML + GoogleCloudIntegrationsV1alphaApiTriggerResource: + id: GoogleCloudIntegrationsV1alphaApiTriggerResource + description: List of API triggerID and their workflow resource name. + type: object + properties: + integrationResource: + description: Required. Integration where the API is published type: string - description: The description for this channel - updateTime: + triggerId: + description: Required. Trigger Id of the API trigger(s) in the integration + type: array + items: + type: string + GoogleCloudIntegrationsV1alphaGenerateOpenApiSpecResponse: + id: GoogleCloudIntegrationsV1alphaGenerateOpenApiSpecResponse + description: Response of the GenerateOpenApiSpec API. + type: object + properties: + openApiSpec: + description: Open API spec as per the required format type: string - description: Output only. Time when the channel was last updated - readOnly: true - format: google-datetime - createTime: + GoogleCloudIntegrationsV1alphaGenerateTokenResponse: + id: GoogleCloudIntegrationsV1alphaGenerateTokenResponse + description: Returns success or error message + type: object + properties: + message: + description: The message that notifies the user if the request succeeded or not. type: string - format: google-datetime - readOnly: true - description: Output only. Time when the channel is created - deleteTime: - format: google-datetime + EnterpriseCrmEventbusAuthconfigAuthConfigTaskParam: + id: EnterpriseCrmEventbusAuthconfigAuthConfigTaskParam + type: object + properties: + authConfigId: + description: UUID of the AuthConfig. type: string - readOnly: true + allowedCredentialTypes: description: >- - Output only. Time when the channel was deleted. Empty if not - deleted. - isActive: + Defines the credential types to be supported as Task may restrict + specific types to use, e.g. Cloud SQL Task will use + username/password type only. + type: array + items: + type: string + enumDescriptions: + - '' + - Regular username/password pair. + - API key. + - OAuth 2.0 Authorization Code Grant Type. + - OAuth 2.0 Implicit Grant Type. + - OAuth 2.0 Client Credentials Grant Type. + - OAuth 2.0 Resource Owner Credentials Grant Type. + - JWT Token. + - Auth Token, e.g. bearer token. + - >- + Service Account which can be used to generate token for + authentication. + - Client Certificate only. + - Google OIDC ID Token + enum: + - CREDENTIAL_TYPE_UNSPECIFIED + - USERNAME_AND_PASSWORD + - API_KEY + - OAUTH2_AUTHORIZATION_CODE + - OAUTH2_IMPLICIT + - OAUTH2_CLIENT_CREDENTIALS + - OAUTH2_RESOURCE_OWNER_CREDENTIALS + - JWT + - AUTH_TOKEN + - SERVICE_ACCOUNT + - CLIENT_CERTIFICATE_ONLY + - OIDC_TOKEN + allowedServiceAccountInContext: type: boolean - description: >- - Indicated if a channel has any active integrations referencing it. - Set to false when the channel is created, and set to true if there - is any integration published with the channel configured in it. - channelTopic: - type: string - description: The Channel topic defined by salesforce once an channel is opened - lastReplayId: - description: Last sfdc messsage replay id for channel + useServiceAccountInContext: + type: boolean + scope: + description: A space-delimited list of requested scope permissions. type: string - EnterpriseCrmFrontendsEventbusProtoRollbackStrategy: - description: 'Next available id: 4' + EnterpriseCrmEventbusProtoFieldMappingConfig: + id: EnterpriseCrmEventbusProtoFieldMappingConfig + description: >- + Field Mapping Config to map multiple output fields values from input + fields values. + type: object properties: - parameters: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters - description: Optional. The customized parameters the user can pass to this task. - rollbackTaskImplementationClassName: - description: >- - Required. This is the name of the task that needs to be executed - upon rollback of this task. - type: string - taskNumbersToRollback: + mappedFields: type: array items: - type: string - description: >- - Required. These are the tasks numbers of the tasks whose - `rollback_strategy.rollback_task_implementation_class_name` needs to - be executed upon failure of this task. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoMappedField' + EnterpriseCrmEventbusProtoMappedField: + id: EnterpriseCrmEventbusProtoMappedField + description: Mapped field is a pair of input field and output field. type: object - id: EnterpriseCrmFrontendsEventbusProtoRollbackStrategy - GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest: properties: - inputParameters: - type: object - additionalProperties: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' - description: Optional. Input parameters used by integration execution. - parameters: - deprecated: true + inputField: + description: The input field being mapped from. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoField' + outputField: + description: The output field being mapped to. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoField' + EnterpriseCrmEventbusProtoField: + id: EnterpriseCrmEventbusProtoField + description: Information about the value and type of the field. + type: object + properties: + referenceKey: description: >- - Optional. Passed in as parameters to each integration execution. - Redacted - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters - executionId: - description: Optional. The id of the ON_HOLD execution to be resumed. - type: string - triggerId: + This holds the reference key of the workflow or task parameter. 1. + Any workflow parameter, for e.g. $workflowParam1$. 2. Any task input + or output parameter, for e.g. $task1_param1$. 3. Any workflow or + task parameters with subfield references, for e.g., + $task1_param1.employee.id$ type: string + transformExpression: description: >- - Required. Matched against all {@link TriggerConfig}s across all - integrations. i.e. TriggerConfig.trigger_id.equals(trigger_id). The - trigger_id is in the format of `api_trigger/TRIGGER_NAME`. - doNotPropagateError: - description: >- - Optional. Flag to determine how to should propagate errors. If this - flag is set to be true, it will not throw an exception. Instead, it - will return a {@link ExecuteIntegrationsResponse} with an execution - id and error messages as PostWithTriggerIdExecutionException in - {@link EventParameters}. The flag is set to be false by default. - type: boolean - parameterEntries: - type: array - deprecated: true - items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry - description: >- - Optional. Parameters are a part of Event and can be used to - communicate between different tasks that are part of the same - integration execution. - requestId: + This is the transform expression to fetch the input field value. for + e.g. $param1$.CONCAT('test'). Keep points - 1. Only input field can + have a transform expression. 2. If a transform expression is + provided, reference_key will be ignored. 3. If no value is returned + after evaluation of transform expression, default_value can be + mapped if provided. 4. The field_type should be the type of the + final object returned after the transform expression is evaluated. + Scrubs the transform expression before logging as value provided by + user so may or may not contain PII or SPII data. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTransformExpression' + defaultValue: description: >- - Optional. This is used to de-dup incoming request: if the duplicate - request was detected, the response from the previous execution is - returned. + This holds the default values for the fields. This value is supplied + by user so may or may not contain PII or SPII data. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType' + fieldType: + description: Specifies the data type of the field. type: string - description: The request for executing an integration. - id: GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest - type: object - GoogleCloudConnectorsV1SslConfig: - id: GoogleCloudConnectorsV1SslConfig - properties: - clientPrivateKey: - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' - description: Client Private Key - clientCertType: - enum: - - CERT_TYPE_UNSPECIFIED - - PEM enumDescriptions: - - Cert type unspecified. - - Privacy Enhanced Mail (PEM) Type - type: string - description: Type of Client Cert (PEM/JKS/.. etc.) - clientCertificate: - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' - description: Client Certificate - type: - enum: - - SSL_TYPE_UNSPECIFIED - - TLS - - MTLS - description: Controls the ssl type for the given connector version. + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - >- + BYTES and BYTES_ARRAY data types are not allowed for top-level + params. They're only meant to support protobufs with BYTES + (sub)fields. + - '' + - '' + - '' + enum: + - DATA_TYPE_UNSPECIFIED + - STRING_VALUE + - INT_VALUE + - DOUBLE_VALUE + - BOOLEAN_VALUE + - PROTO_VALUE + - SERIALIZED_OBJECT_VALUE + - STRING_ARRAY + - INT_ARRAY + - DOUBLE_ARRAY + - PROTO_ARRAY + - PROTO_ENUM + - BOOLEAN_ARRAY + - PROTO_ENUM_ARRAY + - BYTES + - BYTES_ARRAY + - NON_SERIALIZABLE_OBJECT + - JSON_VALUE + protoDefPath: + description: >- + Optional. The fully qualified proto name (e.g. + enterprise.crm.storage.Account). Required for output field of type + PROTO_VALUE or PROTO_ARRAY. For e.g., if input field_type is BYTES + and output field_type is PROTO_VALUE, then fully qualified proto + type url should be provided to parse the input bytes. If field_type + is *_ARRAY, then all the converted protos are of the same type. type: string - enumDescriptions: - - No SSL configuration required. - - TLS Handshake - - mutual TLS (MTLS) Handshake - privateServerCertificate: + cardinality: description: >- - Private Server Certificate. Needs to be specified if trust model is - `PRIVATE`. - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' - clientPrivateKeyPass: - description: Secret containing the passphrase protecting the Client Private Key - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' - serverCertType: - enum: - - CERT_TYPE_UNSPECIFIED - - PEM - enumDescriptions: - - Cert type unspecified. - - Privacy Enhanced Mail (PEM) Type + By default, if the cardinality is unspecified the field is + considered required while mapping. type: string - description: Type of Server Cert (PEM/JKS/.. etc.) - useSsl: - type: boolean - description: Bool for enabling SSL - trustModel: enumDescriptions: - - Public Trust Model. Takes the Default Java trust store. - - Private Trust Model. Takes custom/private trust store. - - Insecure Trust Model. Accept all certificates. - type: string - description: Trust Model of the SSL connection + - For fields with unspecified cardinality. + - >- + If field cardinality is set to optional, ignore errors if input + field value is null or the reference_key is not found. enum: - - PUBLIC - - PRIVATE - - INSECURE - additionalVariables: + - UNSPECIFIED + - OPTIONAL + EnterpriseCrmEventbusProtoTransformExpression: + id: EnterpriseCrmEventbusProtoTransformExpression + type: object + properties: + initialValue: + description: Initial value upon which to perform transformations. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBaseValue' + transformationFunctions: + description: Transformations to be applied sequentially. type: array items: - $ref: '#/components/schemas/GoogleCloudConnectorsV1ConfigVariable' - description: Additional SSL related field values - description: SSL Configuration of a connection + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFunction' + EnterpriseCrmEventbusProtoBaseValue: + id: EnterpriseCrmEventbusProtoBaseValue + type: object + properties: + literalValue: + description: Start with a literal value. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType' + referenceValue: + description: Start with a reference value to dereference. + type: string + baseFunction: + description: >- + Start with a function that does not build on existing values. Eg. + CurrentTime, Min, Max, Exists, etc. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFunction' + EnterpriseCrmEventbusProtoFunction: + id: EnterpriseCrmEventbusProtoFunction type: object + properties: + functionType: + description: The name of the function to perform. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFunctionType' + parameters: + description: List of parameters required for the transformation. + type: array + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTransformExpression' EnterpriseCrmEventbusProtoFunctionType: + id: EnterpriseCrmEventbusProtoFunctionType + type: object properties: - stringFunction: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoStringFunction' - jsonFunction: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoJsonFunction' baseFunction: description: LINT.IfChange $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBaseFunction' - doubleArrayFunction: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoDoubleArrayFunction' - protoArrayFunction: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoProtoArrayFunction' - doubleFunction: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoDoubleFunction' - stringArrayFunction: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoStringArrayFunction' + stringFunction: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoStringFunction' intFunction: $ref: '#/components/schemas/EnterpriseCrmEventbusProtoIntFunction' + doubleFunction: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoDoubleFunction' booleanFunction: $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBooleanFunction' + protoFunction: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoProtoFunction' + stringArrayFunction: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoStringArrayFunction' intArrayFunction: $ref: '#/components/schemas/EnterpriseCrmEventbusProtoIntArrayFunction' + doubleArrayFunction: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoDoubleArrayFunction' booleanArrayFunction: $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBooleanArrayFunction' - protoFunction: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoProtoFunction' + protoArrayFunction: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoProtoArrayFunction' + jsonFunction: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoJsonFunction' + EnterpriseCrmEventbusProtoBaseFunction: + id: EnterpriseCrmEventbusProtoBaseFunction + type: object + properties: + functionName: + type: string + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + enum: + - UNSPECIFIED + - NOW_IN_MILLIS + - INT_LIST + - ENVIRONMENT + - GET_EXECUTION_ID + - GET_INTEGRATION_NAME + - GET_REGION + - GET_UUID + - GET_PROJECT_ID + EnterpriseCrmEventbusProtoStringFunction: + id: EnterpriseCrmEventbusProtoStringFunction + type: object + properties: + functionName: + type: string + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + enum: + - UNSPECIFIED + - CONCAT + - TO_UPPERCASE + - TO_LOWERCASE + - CONTAINS + - SPLIT + - LENGTH + - EQUALS + - TO_INT + - TO_DOUBLE + - TO_BOOLEAN + - TO_BASE_64 + - TO_JSON + - EQUALS_IGNORE_CASE + - REPLACE_ALL + - SUBSTRING + - RESOLVE_TEMPLATE + - DECODE_BASE64_STRING + EnterpriseCrmEventbusProtoIntFunction: + id: EnterpriseCrmEventbusProtoIntFunction + type: object + properties: + functionName: + type: string + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + enum: + - UNSPECIFIED + - ADD + - SUBTRACT + - MULTIPLY + - DIVIDE + - EXPONENT + - GREATER_THAN_EQUAL_TO + - GREATER_THAN + - LESS_THAN_EQUAL_TO + - LESS_THAN + - TO_DOUBLE + - TO_STRING + - EQUALS + - TO_JSON + - MOD + - EPOCH_TO_HUMAN_READABLE_TIME + EnterpriseCrmEventbusProtoDoubleFunction: + id: EnterpriseCrmEventbusProtoDoubleFunction + type: object + properties: + functionName: + type: string + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + enum: + - UNSPECIFIED + - TO_JSON + - TO_STRING + - ADD + - SUBTRACT + - MULTIPLY + - DIVIDE + - EXPONENT + - ROUND + - FLOOR + - CEIL + - GREATER_THAN + - LESS_THAN + - EQUALS + - GREATER_THAN_EQUALS + - LESS_THAN_EQUALS + - MOD + EnterpriseCrmEventbusProtoBooleanFunction: + id: EnterpriseCrmEventbusProtoBooleanFunction type: object - id: EnterpriseCrmEventbusProtoFunctionType - EnterpriseCrmEventbusProtoNodeIdentifier: properties: - elementIdentifier: - description: Configuration of the edge. - type: string - elementType: + functionName: type: string - enum: - - UNKNOWN_TYPE - - TASK_CONFIG - - TRIGGER_CONFIG enumDescriptions: - '' - '' - '' - description: Destination node where the edge ends. It can only be a task config. - id: EnterpriseCrmEventbusProtoNodeIdentifier - type: object - description: 'Represents a node identifier (type + id). Next highest id: 3' - GoogleCloudIntegrationsV1alphaTemplateBundle: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + enum: + - UNSPECIFIED + - TO_JSON + - NOT + - AND + - NAND + - OR + - XOR + - NOR + - XNOR + - TO_STRING + - EQUALS + EnterpriseCrmEventbusProtoProtoFunction: + id: EnterpriseCrmEventbusProtoProtoFunction type: object - id: GoogleCloudIntegrationsV1alphaTemplateBundle properties: - integrationVersionTemplate: - description: Required. Main integration templates of the template bundle. - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersionTemplate - subIntegrationVersionTemplates: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersionTemplate - description: >- - Optional. Sub integration templates which would be added along with - main integration. - description: Define the bundle of the template. - EnterpriseCrmEventbusProtoWorkflowAlertConfig: + functionName: + type: string + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + enum: + - UNSPECIFIED + - GET_STRING_SUBFIELD + - GET_INT_SUBFIELD + - GET_DOUBLE_SUBFIELD + - GET_BOOLEAN_SUBFIELD + - GET_STRING_ARRAY_SUBFIELD + - GET_INT_ARRAY_SUBFIELD + - GET_DOUBLE_ARRAY_SUBFIELD + - GET_BOOLEAN_ARRAY_SUBFIELD + - GET_PROTO_ARRAY_SUBFIELD + - GET_PROTO_SUBFIELD + - TO_JSON + - GET_BYTES_SUBFIELD_AS_UTF_8_STRING + - GET_BYTES_SUBFIELD_AS_PROTO + - EQUALS + EnterpriseCrmEventbusProtoStringArrayFunction: + id: EnterpriseCrmEventbusProtoStringArrayFunction type: object - description: >- - Message to be used to configure custom alerting in the {@code - EventConfig} protos for an event. - id: EnterpriseCrmEventbusProtoWorkflowAlertConfig properties: - playbookUrl: - description: >- - Link to a playbook for resolving the issue that triggered this - alert. + functionName: type: string - metricType: enumDescriptions: - - >- - The default value. Metric type should always be set to one of the - other non-default values, otherwise it will result in an - INVALID_ARGUMENT error. - - >- - Specifies alerting on the rate of errors for the enclosing - workflow. - - >- - Specifies alerting on the rate of warnings for the enclosing - workflow. Warnings use the same enum values as errors. - - >- - Specifies alerting on the rate of errors for any task in the - enclosing workflow. - - >- - Specifies alerting on the rate of warnings for any task in the - enclosing workflow. - - >- - Specifies alerting on the rate of executions over all tasks in the - enclosing workflow. - - >- - Specifies alerting on the number of events executed in the given - aggregation_period. - - >- - Specifies alerting on the average duration of executions for this - workflow. - - >- - Specifies alerting on the duration value of a particular - percentile of workflow executions. E.g. If 10% or more of the - workflow executions have durations above 5 seconds, alert. - - >- - Specifies alerting on the average duration of any task in the - enclosing workflow, - - >- - Specifies alerting on the duration value of a particular - percentile of any task executions within the enclosing workflow. - E.g. If 10% or more of the task executions in the workflow have - durations above 5 seconds, alert. - type: string + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' enum: - - METRIC_TYPE_UNSPECIFIED - - EVENT_ERROR_RATE - - EVENT_WARNING_RATE - - TASK_ERROR_RATE - - TASK_WARNING_RATE - - TASK_RATE - - EVENT_RATE - - EVENT_AVERAGE_DURATION - - EVENT_PERCENTILE_DURATION - - TASK_AVERAGE_DURATION - - TASK_PERCENTILE_DURATION - onlyFinalAttempt: - type: boolean - description: >- - For either events or tasks, depending on the type of alert, count - only final attempts, not retries. - alertDisabled: - description: >- - Set to false by default. When set to true, the metrics are not - aggregated or pushed to Monarch for this workflow alert. - type: boolean - errorEnumList: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList - numAggregationPeriods: - type: integer - description: >- - For how many contiguous aggregation periods should the expected min - or max be violated for the alert to be fired. - format: int32 - aggregationPeriod: - type: string - description: >- - For an EXPECTED_MIN threshold, this aggregation_period must be - lesser than 24 hours. - alertName: - type: string - description: >- - A name to identify this alert. This will be displayed in the alert - subject. If set, this name should be unique within the scope of the - workflow. - thresholdValue: - description: >- - The metric value, above or below which the alert should be - triggered. - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue - warningEnumList: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList - thresholdType: + - UNSPECIFIED + - GET + - APPEND + - SIZE + - TO_SET + - APPEND_ALL + - TO_JSON + - SET + - REMOVE + - REMOVE_AT + - CONTAINS + - FOR_EACH + - FILTER + EnterpriseCrmEventbusProtoIntArrayFunction: + id: EnterpriseCrmEventbusProtoIntArrayFunction + type: object + properties: + functionName: type: string + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' enum: - - UNSPECIFIED_THRESHOLD_TYPE - - EXPECTED_MIN - - EXPECTED_MAX + - UNSPECIFIED + - GET + - APPEND + - SIZE + - SUM + - AVG + - MAX + - MIN + - TO_SET + - APPEND_ALL + - TO_JSON + - SET + - REMOVE + - REMOVE_AT + - CONTAINS + - FOR_EACH + - FILTER + EnterpriseCrmEventbusProtoDoubleArrayFunction: + id: EnterpriseCrmEventbusProtoDoubleArrayFunction + type: object + properties: + functionName: + type: string enumDescriptions: - '' - - >- - Note that this field will only trigger alerts if the workflow - specifying it runs at least once in 24 hours (which is our - in-memory retention period for monarch streams). Also note that - `aggregation_period` for this alert configuration must be less - than 24 hours. - '' - description: >- - The threshold type, whether lower(expected_min) or - upper(expected_max), for which this alert is being configured. If - value falls below expected_min or exceeds expected_max, an alert - will be fired. - clientId: - description: Client associated with this alert configuration. - type: string - durationThresholdMs: - format: int64 - type: string - description: >- - Should be specified only for *AVERAGE_DURATION and - *PERCENTILE_DURATION metrics. This member should be used to specify - what duration value the metrics should exceed for the alert to - trigger. - GoogleCloudConnectorsV1EventingConfigDeadLetterConfig: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + enum: + - UNSPECIFIED + - GET + - APPEND + - SIZE + - SUM + - AVG + - MAX + - MIN + - TO_SET + - APPEND_ALL + - TO_JSON + - SET + - REMOVE + - REMOVE_AT + - CONTAINS + - FOR_EACH + - FILTER + EnterpriseCrmEventbusProtoBooleanArrayFunction: + id: EnterpriseCrmEventbusProtoBooleanArrayFunction + type: object properties: - projectId: - description: Optional. Project which has the topic given. - type: string - topic: - description: Optional. Topic to push events which couldn't be processed. + functionName: type: string - type: object - description: Dead Letter configuration details provided by the user. - id: GoogleCloudConnectorsV1EventingConfigDeadLetterConfig - EnterpriseCrmEventbusProtoParamSpecEntryConfig: - id: EnterpriseCrmEventbusProtoParamSpecEntryConfig + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + enum: + - UNSPECIFIED + - GET + - APPEND + - SIZE + - TO_SET + - APPEND_ALL + - TO_JSON + - SET + - REMOVE + - REMOVE_AT + - CONTAINS + - FOR_EACH + - FILTER + EnterpriseCrmEventbusProtoProtoArrayFunction: + id: EnterpriseCrmEventbusProtoProtoArrayFunction type: object properties: - parameterNameOption: - enum: - - DEFAULT_NOT_PARAMETER_NAME - - IS_PARAMETER_NAME - - KEY_IS_PARAMETER_NAME - - VALUE_IS_PARAMETER_NAME + functionName: type: string enumDescriptions: - - This field is not a parameter name. - - >- - If this field is a string and this option is selected, the field - will be interpreted as a parameter name. Users will be able to - choose a variable using the autocomplete, but the name will be - stored as a literal string. - - >- - If this field is a ParameterMap and this option is selected, the - map's keys will be interpreted as parameter names. Ignored if this - field is not a ParameterMap. - - >- - If this field is a ParameterMap and this option is selected, the - map's values will be interpreted as parameter names. Ignored if - this field is not a ParameterMap. - helpText: - type: string - description: >- - Detailed help text for this parameter containing information not - provided elsewhere. For example, instructions on how to migrate from - a deprecated parameter. - label: - description: A user-friendly label for the parameter. + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + enum: + - UNSPECIFIED + - GET + - APPEND + - SIZE + - TO_SET + - APPEND_ALL + - TO_JSON + - SET + - REMOVE + - REMOVE_AT + - CONTAINS + - FOR_EACH + - FILTER + EnterpriseCrmEventbusProtoJsonFunction: + id: EnterpriseCrmEventbusProtoJsonFunction + type: object + properties: + functionName: type: string - isHidden: - type: boolean - description: Whether this field is hidden in the UI. - subSectionLabel: + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + enum: + - UNSPECIFIED + - GET_PROPERTY + - GET_ELEMENT + - APPEND_ELEMENT + - SIZE + - SET_PROPERTY + - FLATTEN + - FLATTEN_ONCE + - MERGE + - TO_STRING + - TO_INT + - TO_DOUBLE + - TO_BOOLEAN + - TO_PROTO + - TO_STRING_ARRAY + - TO_INT_ARRAY + - TO_DOUBLE_ARRAY + - TO_PROTO_ARRAY + - TO_BOOLEAN_ARRAY + - REMOVE_PROPERTY + - RESOLVE_TEMPLATE + - EQUALS + - FOR_EACH + - FILTER_ELEMENTS + EnterpriseCrmEventbusProtoLoopMetadata: + id: EnterpriseCrmEventbusProtoLoopMetadata + type: object + properties: + currentIterationCount: + description: Starting from 1, not 0. + type: string + format: int64 + currentIterationDetail: description: >- - A user-friendly label for subSection under which the parameter will - be displayed. + Needs to be set by the loop impl class before each iteration. The + abstract loop class will append the request and response to it. Eg. + The foreach Loop will clean up and set it as the current iteration + element at the start of each loop. The post request and response + will be appended to the value once they are available. type: string - hideDefaultValue: - description: Whether the default value is hidden in the UI. - type: boolean - descriptivePhrase: + errorMsg: + description: Add the error message when loops fail. type: string - description: A short phrase to describe what this parameter contains. - uiPlaceholderText: + failureLocation: + description: Indicates where in the loop logic did it error out. type: string - description: >- - Placeholder text which will appear in the UI input form for this - parameter. - inputDisplayOption: - enum: - - DEFAULT - - STRING_MULTI_LINE - - NUMBER_SLIDER - - BOOLEAN_TOGGLE enumDescriptions: - - >- - A single-line input for strings, a numeric input box for numbers, - or a checkbox for booleans. - - A multi-line input box for longer strings/string templates. - - >- - A slider to select a numerical value. The default range is [0, - 100]. - - A toggle button for boolean parameters. - type: string - GoogleCloudIntegrationsV1alphaListConnectionsResponse: - id: GoogleCloudIntegrationsV1alphaListConnectionsResponse + - No error or Unknown. + - Subworkflow failed while firing/running. + - Param overrides failed. + - Param aggregation failed. + - Setting for loop current element failed. + - Getting the list to iterate. + - Evaluating the while loop condition. + - Building the iteration request + enum: + - UNKNOWN + - SUBWORKFLOW + - PARAM_OVERRIDING + - PARAM_AGGREGATING + - SETTING_ITERATION_ELEMENT + - GETTING_LIST_TO_ITERATE + - CONDITION_EVALUATION + - BUILDING_REQUEST + EnterpriseCrmEventbusProtoParameterMap: + id: EnterpriseCrmEventbusProtoParameterMap + description: >- + A generic multi-map that holds key value pairs. They keys and values can + be of any type, unless specified. type: object properties: - connections: + entries: type: array - description: Connections. items: - $ref: '#/components/schemas/GoogleCloudConnectorsV1Connection' - nextPageToken: - description: Next page token. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterMapEntry' + keyType: + description: >- + Option to specify key value type for all entries of the map. If + provided then field types for all entries must conform to this. type: string - description: Response containing Connections listed by region. - EnterpriseCrmEventbusProtoDoubleArrayFunction: - properties: - functionName: enumDescriptions: - '' - '' @@ -9329,362 +9601,460 @@ components: - '' - '' - '' + - >- + BYTES and BYTES_ARRAY data types are not allowed for top-level + params. They're only meant to support protobufs with BYTES + (sub)fields. - '' - '' - '' enum: - - UNSPECIFIED - - GET - - APPEND - - SIZE - - SUM - - AVG - - MAX - - MIN - - TO_SET - - APPEND_ALL - - TO_JSON - - SET - - REMOVE - - REMOVE_AT - - CONTAINS - - FOR_EACH - - FILTER + - DATA_TYPE_UNSPECIFIED + - STRING_VALUE + - INT_VALUE + - DOUBLE_VALUE + - BOOLEAN_VALUE + - PROTO_VALUE + - SERIALIZED_OBJECT_VALUE + - STRING_ARRAY + - INT_ARRAY + - DOUBLE_ARRAY + - PROTO_ARRAY + - PROTO_ENUM + - BOOLEAN_ARRAY + - PROTO_ENUM_ARRAY + - BYTES + - BYTES_ARRAY + - NON_SERIALIZABLE_OBJECT + - JSON_VALUE + valueType: type: string - id: EnterpriseCrmEventbusProtoDoubleArrayFunction + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - >- + BYTES and BYTES_ARRAY data types are not allowed for top-level + params. They're only meant to support protobufs with BYTES + (sub)fields. + - '' + - '' + - '' + enum: + - DATA_TYPE_UNSPECIFIED + - STRING_VALUE + - INT_VALUE + - DOUBLE_VALUE + - BOOLEAN_VALUE + - PROTO_VALUE + - SERIALIZED_OBJECT_VALUE + - STRING_ARRAY + - INT_ARRAY + - DOUBLE_ARRAY + - PROTO_ARRAY + - PROTO_ENUM + - BOOLEAN_ARRAY + - PROTO_ENUM_ARRAY + - BYTES + - BYTES_ARRAY + - NON_SERIALIZABLE_OBJECT + - JSON_VALUE + EnterpriseCrmEventbusProtoParameterMapEntry: + id: EnterpriseCrmEventbusProtoParameterMapEntry + description: Entry is a pair of key and value. type: object - GoogleCloudConnectorsV1Connection: + properties: + key: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterMapField' + value: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterMapField' + EnterpriseCrmEventbusProtoParameterMapField: + id: EnterpriseCrmEventbusProtoParameterMapField + description: Field represents either the key or value in an entry. type: object - id: GoogleCloudConnectorsV1Connection properties: - asyncOperationsEnabled: - type: boolean - description: >- - Optional. Async operations enabled for the connection. If Async - Operations is enabled, Connection allows the customers to initiate - async long running operations using the actions API. - serviceAccount: - description: >- - Optional. Service account needed for runtime plane to access Google - Cloud resources. + referenceKey: + description: Referencing one of the WF variables. type: string - suspended: + literalValue: + description: Passing a literal value. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType' + EnterpriseCrmEventbusProtoScatterResponse: + id: EnterpriseCrmEventbusProtoScatterResponse + type: object + properties: + scatterElement: + description: The element that was scattered for this execution. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType' + executionIds: + description: The execution ids of each Subworkflow fired by this scatter. + type: array + items: + type: string + isSuccessful: description: >- - Optional. Suspended indicates if a user has suspended a connection - or not. + If execution is sync, this is true if the execution passed and false + if it failed. If the execution is async, this is true if the WF was + fired off successfully, and false if it failed to execute. The + success or failure of the subworkflows executed are not captured. type: boolean - logConfig: - description: Optional. Log configuration for the connection. - $ref: '#/components/schemas/GoogleCloudConnectorsV1LogConfig' - serviceDirectory: + responseParams: description: >- - Output only. The name of the Service Directory service name. Used - for Private Harpoon to resolve the ILB address. e.g. - "projects/cloud-connectors-e2e-testing/locations/us-central1/namespaces/istio-system/services/istio-ingressgateway-connectors" - readOnly: true + A list of all the response parameters in the aggregtorMap stored + with the remapped key. + type: array + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterEntry' + errorMsg: + description: The error message of the failure if applicable. + type: string + EnterpriseCrmEventbusProtoSuspensionResolutionInfo: + id: EnterpriseCrmEventbusProtoSuspensionResolutionInfo + type: object + properties: + suspensionId: + description: Primary key for the SuspensionResolutionInfoTable. + type: string + eventExecutionInfoId: + description: Required. ID of the associated execution. + type: string + taskNumber: + description: Required. Task number of the associated SuspensionTask. + type: string + status: + type: string + enumDescriptions: + - '' + - '' + - '' + - '' + enum: + - PENDING_UNSPECIFIED + - REJECTED + - LIFTED + - CANCELED + audit: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoSuspensionResolutionInfoAudit + createdTimestamp: + description: Auto-generated. + type: string + format: google-datetime + lastModifiedTimestamp: + description: Auto-generated. type: string - eventingConfig: - $ref: '#/components/schemas/GoogleCloudConnectorsV1EventingConfig' - description: Optional. Eventing config of a connection - createTime: format: google-datetime + suspensionConfig: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoSuspensionConfig' + workflowName: + description: Required. The name of the originating workflow. type: string - readOnly: true - description: Output only. Created time. - connectorVersion: + externalTraffic: + description: The origin of the suspension for periodic notifications. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoExternalTraffic' + product: description: >- - Required. Connector version on which the connection is created. The - format is: - projects/*/locations/*/providers/*/connectors/*/versions/* Only - global location is supported for ConnectorVersion resource. + Which Google product the suspension belongs to. If not set, the + suspension belongs to Integration Platform by default. type: string - eventingRuntimeData: - description: Output only. Eventing Runtime Data. - readOnly: true - $ref: '#/components/schemas/GoogleCloudConnectorsV1EventingRuntimeData' - imageLocation: - readOnly: true + enumDescriptions: + - '' + - '' + - '' + - '' + enum: + - UNSPECIFIED_PRODUCT + - IP + - APIGEE + - SECURITY + cloudKmsConfig: + description: KMS info, used by cmek/gmek integration + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCloudKmsConfig' + encryptedSuspensionResolutionInfo: + description: Encrypted SuspensionResolutionInfo type: string - description: >- - Output only. GCR location where the runtime image is stored. - formatted like: gcr.io/{bucketName}/{imageName} - updateTime: - format: google-datetime - readOnly: true - description: Output only. Updated time. + format: byte + wrappedDek: + description: Wrapped dek type: string - labels: - description: >- - Optional. Resource labels to represent user-provided metadata. Refer - to cloud documentation on labels for more details. - https://cloud.google.com/compute/docs/labeling-resources - additionalProperties: - type: string - type: object - nodeConfig: - $ref: '#/components/schemas/GoogleCloudConnectorsV1NodeConfig' - description: Optional. Node configuration for the connection. - eventingEnablementType: - enum: - - EVENTING_ENABLEMENT_TYPE_UNSPECIFIED - - EVENTING_AND_CONNECTION - - ONLY_EVENTING - enumDescriptions: - - Eventing Enablement Type Unspecifeied. - - Both connection and eventing. - - Only Eventing. + format: byte + clientId: + description: The event data user sends as request. type: string - description: >- - Optional. Eventing enablement type. Will be nil if eventing is not - enabled. - billingConfig: - readOnly: true - $ref: '#/components/schemas/GoogleCloudConnectorsV1BillingConfig' - description: Output only. Billing config for the connection. - lockConfig: - description: >- - Optional. Configuration that indicates whether or not the Connection - can be edited. - $ref: '#/components/schemas/GoogleCloudConnectorsV1LockConfig' - host: - readOnly: true + EnterpriseCrmEventbusProtoSuspensionResolutionInfoAudit: + id: EnterpriseCrmEventbusProtoSuspensionResolutionInfoAudit + type: object + properties: + timestamp: type: string - description: >- - Output only. The name of the Hostname of the Service Directory - service with TLS. - sslConfig: - $ref: '#/components/schemas/GoogleCloudConnectorsV1SslConfig' - description: Optional. Ssl config of a connection - authConfig: - description: >- - Optional. Configuration for establishing the connection's - authentication with an external system. - $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfig' - connectorVersionInfraConfig: - readOnly: true - description: Output only. Infra configs supported by Connector Version. - $ref: >- - #/components/schemas/GoogleCloudConnectorsV1ConnectorVersionInfraConfig - authOverrideEnabled: - type: boolean - description: >- - Optional. Auth override enabled for the connection. If Auth Override - is enabled, Connection allows the backend service auth to be - overridden in the entities/actions API. - name: + format: google-datetime + resolvedBy: type: string - readOnly: true - description: >- - Output only. Resource name of the Connection. Format: - projects/{project}/locations/{location}/connections/{connection} - tlsServiceDirectory: + resolvedByCpi: type: string - readOnly: true - description: Output only. The name of the Service Directory service with TLS. - status: - description: Output only. Current status of the connection. - readOnly: true - $ref: '#/components/schemas/GoogleCloudConnectorsV1ConnectionStatus' - subscriptionType: - readOnly: true - description: >- - Output only. This subscription type enum states the subscription - type of the project. - enum: - - SUBSCRIPTION_TYPE_UNSPECIFIED - - PAY_G - - PAID + EnterpriseCrmEventbusProtoExternalTraffic: + id: EnterpriseCrmEventbusProtoExternalTraffic + description: Represents external traffic type and id. + type: object + properties: + source: type: string enumDescriptions: - - Unspecified subscription type. - - PayG subscription. - - Paid Subscription. - destinationConfigs: - type: array - description: >- - Optional. Configuration of the Connector's destination. Only - accepted for Connectors that accepts user defined destination(s). - items: - $ref: '#/components/schemas/GoogleCloudConnectorsV1DestinationConfig' - envoyImageLocation: - readOnly: true + - '' + - '' + - '' + enum: + - SOURCE_UNSPECIFIED + - APIGEE + - SECURITY + gcpProjectId: + description: User’s GCP project id the traffic is referring to. + type: string + gcpProjectNumber: + description: User’s GCP project number the traffic is referring to. type: string + location: + description: Location for the user's request. + type: string + retryRequestForQuota: + description: Enqueue the execution request due to quota issue + type: boolean + enableInternalIp: description: >- - Output only. GCR location where the envoy image is stored. formatted - like: gcr.io/{bucketName}/{imageName} - isTrustedTester: - description: Output only. Is trusted tester program enabled for the project. + Indicates the client enables internal IP feature, this is applicable + for internal clients only. type: boolean - readOnly: true - connectorVersionLaunchStage: - readOnly: true + EnterpriseCrmEventbusProtoCloudKmsConfig: + id: EnterpriseCrmEventbusProtoCloudKmsConfig + type: object + properties: + locationName: + description: Location name of the key ring, e.g. "us-west1". type: string - enum: - - LAUNCH_STAGE_UNSPECIFIED - - PREVIEW - - GA - - DEPRECATED - - PRIVATE_PREVIEW - description: Output only. Flag to mark the version indicating the launch stage. - enumDescriptions: - - LAUNCH_STAGE_UNSPECIFIED. - - PREVIEW. - - GA. - - DEPRECATED. - - PRIVATE_PREVIEW. - configVariables: - type: array - items: - $ref: '#/components/schemas/GoogleCloudConnectorsV1ConfigVariable' + keyRingName: description: >- - Optional. Configuration for configuring the connection with an - external system. - description: - description: Optional. Description of the resource. + A key ring organizes keys in a specific Google Cloud location and + allows you to manage access control on groups of keys. A key ring's + name does not need to be unique across a Google Cloud project, but + must be unique within a given location. type: string - connectionRevision: - readOnly: true + keyName: + description: >- + A Cloud KMS key is a named object containing one or more key + versions, along with metadata for the key. A key exists on exactly + one key ring tied to a specific location. type: string - format: int64 + keyVersionName: description: >- - Output only. Connection revision. This field is only updated when - the connection is created or updated by User. - description: Connection represents an instance of connector. - EnterpriseCrmFrontendsEventbusProtoParamSpecsMessage: - properties: - parameters: - items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParamSpecEntry - type: array - type: object - id: EnterpriseCrmFrontendsEventbusProtoParamSpecsMessage - GoogleCloudIntegrationsV1alphaListTestCaseExecutionsResponse: - description: The response for listing the functional test execution data. - type: object - id: GoogleCloudIntegrationsV1alphaListTestCaseExecutionsResponse - properties: - executions: - description: The detailed information of requested executions - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaExecution' - type: array - nextPageToken: - description: The token used to retrieve the next page results. + Optional. Each version of a key contains key material used for + encryption or signing. A key's version is represented by an integer, + starting at 1. To decrypt data or verify a signature, you must use + the same key version that was used to encrypt or sign the data. + type: string + gcpProjectId: + description: >- + Optional. The id of GCP project where the KMS key is stored. If not + provided, assume the key is stored in the same GCP project defined + in Client (tag 14). type: string - GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectResponse: - type: object - description: Response for CreateAppsScriptProject rpc call. - id: GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectResponse - properties: - projectId: + serviceAccount: + description: >- + Optional. The service account used for authentication of this KMS + key. If this is not provided, the service account in + Client.clientSource will be used. type: string - description: The created AppsScriptProject ID. - EnterpriseCrmFrontendsEventbusProtoIntParameterArray: - properties: - intValues: - items: - format: int64 - type: string - type: array - id: EnterpriseCrmFrontendsEventbusProtoIntParameterArray - type: object - EnterpriseCrmFrontendsEventbusProtoEventExecutionInfoReplayInfo: + EnterpriseCrmFrontendsEventbusProtoParameterMap: + id: EnterpriseCrmFrontendsEventbusProtoParameterMap description: >- - Contains the details of the execution info: this includes the replay - reason and replay tree connecting executions in a parent-child - relationship - id: EnterpriseCrmFrontendsEventbusProtoEventExecutionInfoReplayInfo + A generic multi-map that holds key value pairs. They keys and values can + be of any type, unless specified. + type: object properties: - originalExecutionInfoId: - type: string - description: >- - If this execution is a replay of another execution, then this field - contains the original execution id. - replayedExecutionInfoIds: + entries: type: array items: - type: string + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterMapEntry + keyType: description: >- - If this execution has been replayed, then this field contains the - execution ids of the replayed executions. - replayReason: - description: reason for replay + Option to specify key value type for all entries of the map. If + provided then field types for all entries must conform to this. type: string - type: object - GoogleCloudIntegrationsV1alphaProjectProperties: - id: GoogleCloudIntegrationsV1alphaProjectProperties - properties: - ipEnablementState: + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - >- + BYTES and BYTES_ARRAY data types are not allowed for top-level + params. They're only meant to support protobufs with BYTES + (sub)fields. + - '' + - '' + - '' enum: - - IP_ENABLEMENT_STATE_UNSPECIFIED - - IP_ENABLEMENT_STATE_STANDALONE - - IP_ENABLEMENT_STATE_APIGEE - - IP_ENABLEMENT_STATE_APIGEE_ENTITLED + - DATA_TYPE_UNSPECIFIED + - STRING_VALUE + - INT_VALUE + - DOUBLE_VALUE + - BOOLEAN_VALUE + - PROTO_VALUE + - SERIALIZED_OBJECT_VALUE + - STRING_ARRAY + - INT_ARRAY + - DOUBLE_ARRAY + - PROTO_ARRAY + - PROTO_ENUM + - BOOLEAN_ARRAY + - PROTO_ENUM_ARRAY + - BYTES + - BYTES_ARRAY + - NON_SERIALIZABLE_OBJECT + - JSON_VALUE + valueType: type: string - enumDescriptions: - - The client enablement status is unspecified - - The client is enabled on Standalone IP - - The client is enabled on Apigee - - The client is entitled for Apigee but not enabled - description: An enum value of what the enablement state is for the given project - provisionedRegions: - type: array - description: A list of provisioned regions on the current project - items: - type: string - billingType: enumDescriptions: - '' - - A trial org provisioned through Apigee Provisioning Wizard - - >- - Subscription based on concurrency model for Apigee and Application - Integration users. - - Consumption based users of IP - - >- - Argentum subscription for Application Integration users. To be - used in the future. + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' - >- - Special billing type to avoid any billing to clients (eg: trusted - tester program). This should not be used without consulting with - the leads. - description: 'Required. Required: The client billing type that was requested' + BYTES and BYTES_ARRAY data types are not allowed for top-level + params. They're only meant to support protobufs with BYTES + (sub)fields. + - '' + - '' + - '' enum: - - BILLING_TYPE_UNSPECIFIED - - APIGEE_TRIALS - - APIGEE_SUBSCRIPTION - - PAYG - - SUBSCRIPTION - - NO_BILLING + - DATA_TYPE_UNSPECIFIED + - STRING_VALUE + - INT_VALUE + - DOUBLE_VALUE + - BOOLEAN_VALUE + - PROTO_VALUE + - SERIALIZED_OBJECT_VALUE + - STRING_ARRAY + - INT_ARRAY + - DOUBLE_ARRAY + - PROTO_ARRAY + - PROTO_ENUM + - BOOLEAN_ARRAY + - PROTO_ENUM_ARRAY + - BYTES + - BYTES_ARRAY + - NON_SERIALIZABLE_OBJECT + - JSON_VALUE + EnterpriseCrmFrontendsEventbusProtoParameterMapEntry: + id: EnterpriseCrmFrontendsEventbusProtoParameterMapEntry + description: Entry is a pair of key and value. + type: object + properties: + key: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterMapField + value: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterMapField + EnterpriseCrmFrontendsEventbusProtoParameterMapField: + id: EnterpriseCrmFrontendsEventbusProtoParameterMapField + description: Field represents either the key or value in an entry. + type: object + properties: + referenceKey: + description: Referencing one of the WF variables. + type: string + literalValue: + description: Passing a literal value. + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterValueType + EnterpriseCrmEventbusProtoConnectorsGenericConnectorTaskConfig: + id: EnterpriseCrmEventbusProtoConnectorsGenericConnectorTaskConfig + type: object + properties: + connection: + description: User-selected connection. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoConnectorsConnection' + operation: + description: Operation to perform using the configured connection. type: string + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + enum: + - OPERATION_UNSPECIFIED + - EXECUTE_ACTION + - LIST_ENTITIES + - GET_ENTITY + - CREATE_ENTITY + - UPDATE_ENTITY + - DELETE_ENTITY + - EXECUTE_QUERY + EnterpriseCrmEventbusProtoConnectorsConnection: + id: EnterpriseCrmEventbusProtoConnectorsConnection type: object - description: Metadata information for the given project - parameters: - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean - _.xgafv: - description: V1 error format. - in: query - name: $.xgafv - schema: - type: string - enum: - - '1' - - '2' - oauth_token: - description: OAuth 2.0 token for the current user. - in: query - name: oauth_token - schema: - type: string - callback: - description: JSONP + properties: + connectionName: + description: >- + Connection name Format: + projects/{project}/locations/{location}/connections/{connection} + type: string + serviceName: + description: >- + Service name Format: + projects/{project}/locations/{location}/namespaces/{namespace}/services/{service} + type: string + connectorVersion: + description: >- + Connector version Format: + projects/{project}/locations/{location}/providers/{provider}/connectors/{connector}/versions/{version} + type: string + host: + description: >- + The name of the Hostname of the Service Directory service with TLS + if used. + type: string + parameters: + access_token: + description: OAuth access token. in: query - name: callback + name: access_token schema: type: string alt: @@ -9697,16 +10067,10 @@ components: - json - media - proto - 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"). + callback: + description: JSONP in: query - name: upload_protocol + name: callback schema: type: string fields: @@ -9724,12 +10088,18 @@ components: name: key schema: type: string - access_token: - description: OAuth access token. + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: access_token + 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 @@ -9739,229 +10109,186 @@ components: name: quotaUser schema: type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' x-stackQL-resources: - sfdc_channels: - id: google.integrations.sfdc_channels - name: sfdc_channels - title: Sfdc_channels + clientmetadata: + id: google.integrations.clientmetadata + name: clientmetadata + title: Clientmetadata methods: - projects_locations_sfdc_instances_sfdc_channels_delete: + projects_get_clientmetadata: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/delete + $ref: '#/paths/~1v1~1projects~1{projectsId}~1clientmetadata/get' response: mediaType: application/json openAPIDocKey: '200' - projects_locations_sfdc_instances_sfdc_channels_get: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/clientmetadata/methods/projects_get_clientmetadata + insert: [] + update: [] + replace: [] + delete: [] + clients: + id: google.integrations.clients + name: clients + title: Clients + methods: + projects_locations_get_clients: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_sfdc_instances_sfdc_channels_patch: + projects_locations_clients_provision: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:provision/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_sfdc_instances_sfdc_channels_list: + projects_locations_clients_provision_client_post_processor: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:provisionClientPostProcessor/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.sfdcChannels - projects_locations_sfdc_instances_sfdc_channels_create: + projects_locations_clients_deprovision: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:deprovision/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_sfdc_instances_sfdc_channels_create: + projects_locations_clients_change_config: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:changeConfig/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_sfdc_instances_sfdc_channels_list: + projects_locations_clients_switch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:switch/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.sfdcChannels - projects_locations_products_sfdc_instances_sfdc_channels_patch: + projects_locations_clients_replace: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:replace/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_sfdc_instances_sfdc_channels_delete: + projects_locations_clients_switch_variable_masking: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:switchVariableMasking/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_sfdc_instances_sfdc_channels_get: + projects_locations_clients_toggle_http: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:toggleHttp/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_products_sfdc_instances_sfdc_channels_get - - $ref: >- - #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_sfdc_instances_sfdc_channels_get - - $ref: >- - #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_products_sfdc_instances_sfdc_channels_list - - $ref: >- - #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_sfdc_instances_sfdc_channels_list - insert: - - $ref: >- - #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_products_sfdc_instances_sfdc_channels_create - - $ref: >- - #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_sfdc_instances_sfdc_channels_create - update: - - $ref: >- - #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_products_sfdc_instances_sfdc_channels_patch - - $ref: >- - #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_sfdc_instances_sfdc_channels_patch - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_products_sfdc_instances_sfdc_channels_delete + #/components/x-stackQL-resources/clients/methods/projects_locations_get_clients + insert: [] + update: [] + replace: - $ref: >- - #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_sfdc_instances_sfdc_channels_delete - sfdc_instances: - id: google.integrations.sfdc_instances - name: sfdc_instances - title: Sfdc_instances + #/components/x-stackQL-resources/clients/methods/projects_locations_clients_replace + delete: [] + locations: + id: google.integrations.locations + name: locations + title: Locations methods: - projects_locations_sfdc_instances_list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.sfdcInstances - projects_locations_sfdc_instances_create: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_sfdc_instances_get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_sfdc_instances_delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_sfdc_instances_patch: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_products_sfdc_instances_list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.sfdcInstances - projects_locations_products_sfdc_instances_create: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_products_sfdc_instances_get: + projects_locations_generate_open_api_spec: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:generateOpenApiSpec/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_sfdc_instances_delete: + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + apps_script_projects: + id: google.integrations.apps_script_projects + name: apps_script_projects + title: Apps_script_projects + methods: + projects_locations_apps_script_projects_link: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1appsScriptProjects:link/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_sfdc_instances_patch: + projects_locations_apps_script_projects_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1appsScriptProjects/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_products_sfdc_instances_get - - $ref: >- - #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_sfdc_instances_get - - $ref: >- - #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_products_sfdc_instances_list - - $ref: >- - #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_sfdc_instances_list + select: [] insert: - $ref: >- - #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_products_sfdc_instances_create - - $ref: >- - #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_sfdc_instances_create - update: - - $ref: >- - #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_products_sfdc_instances_patch - - $ref: >- - #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_sfdc_instances_patch + #/components/x-stackQL-resources/apps_script_projects/methods/projects_locations_apps_script_projects_create + update: [] replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_products_sfdc_instances_delete - - $ref: >- - #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_sfdc_instances_delete - apps_script_projects: - id: google.integrations.apps_script_projects - name: apps_script_projects - title: Apps_script_projects + delete: [] + cloud_functions: + id: google.integrations.cloud_functions + name: cloud_functions + title: Cloud_functions methods: - projects_locations_apps_script_projects_create: + projects_locations_products_cloud_functions_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1appsScriptProjects/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1cloudFunctions/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_apps_script_projects_link: + projects_locations_cloud_functions_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1appsScriptProjects:link/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1cloudFunctions/post response: mediaType: application/json openAPIDocKey: '200' @@ -9969,7 +10296,9 @@ components: select: [] insert: - $ref: >- - #/components/x-stackQL-resources/apps_script_projects/methods/projects_locations_apps_script_projects_create + #/components/x-stackQL-resources/cloud_functions/methods/projects_locations_products_cloud_functions_create + - $ref: >- + #/components/x-stackQL-resources/cloud_functions/methods/projects_locations_cloud_functions_create update: [] replace: [] delete: [] @@ -9978,75 +10307,75 @@ components: name: certificates title: Certificates methods: - projects_locations_certificates_list: + projects_locations_products_certificates_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificates/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1certificates/get response: mediaType: application/json openAPIDocKey: '200' objectKey: $.certificates - projects_locations_certificates_create: + projects_locations_products_certificates_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificates/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1certificates/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_certificates_patch: + projects_locations_products_certificates_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificates~1{certificatesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1certificates~1{certificatesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_certificates_get: + projects_locations_products_certificates_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificates~1{certificatesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1certificates~1{certificatesId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_certificates_delete: + projects_locations_products_certificates_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificates~1{certificatesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1certificates~1{certificatesId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_certificates_delete: + projects_locations_certificates_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1certificates~1{certificatesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificates/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_certificates_get: + objectKey: $.certificates + projects_locations_certificates_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1certificates~1{certificatesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificates/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_certificates_patch: + projects_locations_certificates_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1certificates~1{certificatesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificates~1{certificatesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_certificates_list: + projects_locations_certificates_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1certificates/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificates~1{certificatesId}/patch response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.certificates - projects_locations_products_certificates_create: + projects_locations_certificates_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1certificates/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificates~1{certificatesId}/delete response: mediaType: application/json openAPIDocKey: '200' @@ -10054,10 +10383,10 @@ components: select: - $ref: >- #/components/x-stackQL-resources/certificates/methods/projects_locations_products_certificates_get - - $ref: >- - #/components/x-stackQL-resources/certificates/methods/projects_locations_certificates_get - $ref: >- #/components/x-stackQL-resources/certificates/methods/projects_locations_products_certificates_list + - $ref: >- + #/components/x-stackQL-resources/certificates/methods/projects_locations_certificates_get - $ref: >- #/components/x-stackQL-resources/certificates/methods/projects_locations_certificates_list insert: @@ -10076,385 +10405,342 @@ components: #/components/x-stackQL-resources/certificates/methods/projects_locations_products_certificates_delete - $ref: >- #/components/x-stackQL-resources/certificates/methods/projects_locations_certificates_delete - cloud_functions: - id: google.integrations.cloud_functions - name: cloud_functions - title: Cloud_functions + auth_configs: + id: google.integrations.auth_configs + name: auth_configs + title: Auth_configs methods: - projects_locations_cloud_functions_create: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1cloudFunctions/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_products_cloud_functions_create: + projects_locations_products_auth_configs_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1cloudFunctions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1authConfigs/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: >- - #/components/x-stackQL-resources/cloud_functions/methods/projects_locations_products_cloud_functions_create - - $ref: >- - #/components/x-stackQL-resources/cloud_functions/methods/projects_locations_cloud_functions_create - update: [] - replace: [] - delete: [] - integrations: - id: google.integrations.integrations - name: integrations - title: Integrations - methods: - projects_locations_integrations_test: + projects_locations_products_auth_configs_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}:test/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1authConfigs/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_delete: + objectKey: $.authConfigs + projects_locations_products_auth_configs_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1authConfigs~1{authConfigsId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_list: + projects_locations_products_auth_configs_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1authConfigs~1{authConfigsId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.integrations - projects_locations_integrations_execute: + projects_locations_products_auth_configs_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}:execute/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1authConfigs~1{authConfigsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_schedule: + projects_locations_auth_configs_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}:schedule/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authConfigs/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_execute: + projects_locations_auth_configs_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}:execute/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authConfigs/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_list: + objectKey: $.authConfigs + projects_locations_auth_configs_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authConfigs~1{authConfigsId}/patch response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.integrations - projects_locations_products_integrations_test: + projects_locations_auth_configs_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}:test/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authConfigs~1{authConfigsId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_schedule: + projects_locations_auth_configs_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}:schedule/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authConfigs~1{authConfigsId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/integrations/methods/projects_locations_products_integrations_list + #/components/x-stackQL-resources/auth_configs/methods/projects_locations_products_auth_configs_get - $ref: >- - #/components/x-stackQL-resources/integrations/methods/projects_locations_integrations_list - insert: [] - update: [] + #/components/x-stackQL-resources/auth_configs/methods/projects_locations_products_auth_configs_list + - $ref: >- + #/components/x-stackQL-resources/auth_configs/methods/projects_locations_auth_configs_get + - $ref: >- + #/components/x-stackQL-resources/auth_configs/methods/projects_locations_auth_configs_list + insert: + - $ref: >- + #/components/x-stackQL-resources/auth_configs/methods/projects_locations_products_auth_configs_create + - $ref: >- + #/components/x-stackQL-resources/auth_configs/methods/projects_locations_auth_configs_create + update: + - $ref: >- + #/components/x-stackQL-resources/auth_configs/methods/projects_locations_products_auth_configs_patch + - $ref: >- + #/components/x-stackQL-resources/auth_configs/methods/projects_locations_auth_configs_patch replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/integrations/methods/projects_locations_integrations_delete - skip_this_resource: - id: google.integrations.skip_this_resource - name: skip_this_resource - title: Skip_this_resource + #/components/x-stackQL-resources/auth_configs/methods/projects_locations_products_auth_configs_delete + - $ref: >- + #/components/x-stackQL-resources/auth_configs/methods/projects_locations_auth_configs_delete + integrations: + id: google.integrations.integrations + name: integrations + title: Integrations methods: - projects_locations_integrations_execute_event: + projects_locations_products_integrations_execute: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}:executeEvent/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}:execute/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: [] - test_cases: - id: google.integrations.test_cases - name: test_cases - title: Test_cases - methods: - projects_locations_integrations_versions_test_cases_delete: + projects_locations_products_integrations_schedule: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}~1testCases~1{testCasesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}:schedule/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_versions_test_cases_patch: + projects_locations_products_integrations_test: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}~1testCases~1{testCasesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}:test/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_versions_test_cases_get: + projects_locations_products_integrations_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}~1testCases~1{testCasesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_versions_test_cases_create: + objectKey: $.integrations + projects_locations_integrations_execute: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}~1testCases/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}:execute/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_versions_test_cases_list: + projects_locations_integrations_schedule: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}~1testCases/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}:schedule/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.testCases - projects_locations_integrations_versions_test_cases_upload: + projects_locations_integrations_test: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}~1testCases:upload/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}:test/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_versions_test_cases_execute_test: + projects_locations_integrations_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}~1testCases~1{testCasesId}:executeTest/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_versions_test_cases_takeover_edit_lock: + objectKey: $.integrations + projects_locations_integrations_search: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}~1testCases~1{testCasesId}:takeoverEditLock/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations:search/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_versions_test_cases_download: + projects_locations_integrations_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}~1testCases~1{testCasesId}:download/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/test_cases/methods/projects_locations_integrations_versions_test_cases_get - - $ref: >- - #/components/x-stackQL-resources/test_cases/methods/projects_locations_integrations_versions_test_cases_list - insert: - - $ref: >- - #/components/x-stackQL-resources/test_cases/methods/projects_locations_integrations_versions_test_cases_create - update: - - $ref: >- - #/components/x-stackQL-resources/test_cases/methods/projects_locations_integrations_versions_test_cases_patch - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/test_cases/methods/projects_locations_integrations_versions_test_cases_delete - test_cases_executions: - id: google.integrations.test_cases_executions - name: test_cases_executions - title: Test_cases_executions - methods: - projects_locations_integrations_versions_test_cases_list_executions: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}~1testCases~1{testCasesId}:executions/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.executions - sqlVerbs: - select: + #/components/x-stackQL-resources/integrations/methods/projects_locations_products_integrations_list - $ref: >- - #/components/x-stackQL-resources/test_cases_executions/methods/projects_locations_integrations_versions_test_cases_list_executions + #/components/x-stackQL-resources/integrations/methods/projects_locations_integrations_list insert: [] update: [] replace: [] - delete: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/integrations/methods/projects_locations_integrations_delete versions: id: google.integrations.versions name: versions title: Versions methods: - projects_locations_integrations_versions_upload: + projects_locations_products_integrations_versions_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions:upload/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_versions_patch: + objectKey: $.integrationVersions + projects_locations_products_integrations_versions_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_versions_delete: + projects_locations_products_integrations_versions_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_versions_get: + projects_locations_products_integrations_versions_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_versions_publish: + projects_locations_products_integrations_versions_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:publish/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_versions_list: + projects_locations_products_integrations_versions_publish: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:publish/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.integrationVersions - projects_locations_integrations_versions_create: + projects_locations_products_integrations_versions_upload: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions:upload/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_versions_unpublish: + projects_locations_products_integrations_versions_download: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:unpublish/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:download/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_versions_download: + projects_locations_products_integrations_versions_takeover_edit_lock: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:download/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:takeoverEditLock/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_versions_download_json_package: + projects_locations_products_integrations_versions_unpublish: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:downloadJsonPackage/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:unpublish/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_versions_create: + projects_locations_integrations_versions_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_versions_list: + objectKey: $.integrationVersions + projects_locations_integrations_versions_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.integrationVersions - projects_locations_products_integrations_versions_download: + projects_locations_integrations_versions_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:download/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_versions_delete: + projects_locations_integrations_versions_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_versions_patch: + projects_locations_integrations_versions_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_versions_get: + projects_locations_integrations_versions_publish: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:publish/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_versions_publish: + projects_locations_integrations_versions_upload: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:publish/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions:upload/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_versions_upload: + projects_locations_integrations_versions_download: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions:upload/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:download/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_versions_unpublish: + projects_locations_integrations_versions_download_json_package: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:unpublish/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:downloadJsonPackage/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_versions_takeover_edit_lock: + projects_locations_integrations_versions_unpublish: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:takeoverEditLock/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:unpublish/post response: mediaType: application/json openAPIDocKey: '200' @@ -10462,10 +10748,10 @@ components: select: - $ref: >- #/components/x-stackQL-resources/versions/methods/projects_locations_products_integrations_versions_get - - $ref: >- - #/components/x-stackQL-resources/versions/methods/projects_locations_integrations_versions_get - $ref: >- #/components/x-stackQL-resources/versions/methods/projects_locations_products_integrations_versions_list + - $ref: >- + #/components/x-stackQL-resources/versions/methods/projects_locations_integrations_versions_get - $ref: >- #/components/x-stackQL-resources/versions/methods/projects_locations_integrations_versions_list insert: @@ -10489,35 +10775,36 @@ components: name: executions title: Executions methods: - projects_locations_integrations_executions_list: + projects_locations_products_integrations_executions_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions/get response: mediaType: application/json openAPIDocKey: '200' objectKey: $.executions - projects_locations_integrations_executions_replay: + projects_locations_products_integrations_executions_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions~1{executionsId}:replay/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions~1{executionsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_executions_download: + projects_locations_products_integrations_executions_download: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions~1{executionsId}:download/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions~1{executionsId}:download/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_executions_cancel: + projects_locations_integrations_executions_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions~1{executionsId}:cancel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.executions projects_locations_integrations_executions_get: operation: $ref: >- @@ -10525,25 +10812,24 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_executions_list: + projects_locations_integrations_executions_cancel: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions~1{executionsId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.executions - projects_locations_products_integrations_executions_download: + projects_locations_integrations_executions_download: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions~1{executionsId}:download/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions~1{executionsId}:download/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_executions_get: + projects_locations_integrations_executions_replay: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions~1{executionsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions~1{executionsId}:replay/post response: mediaType: application/json openAPIDocKey: '200' @@ -10551,10 +10837,10 @@ components: select: - $ref: >- #/components/x-stackQL-resources/executions/methods/projects_locations_products_integrations_executions_get - - $ref: >- - #/components/x-stackQL-resources/executions/methods/projects_locations_integrations_executions_get - $ref: >- #/components/x-stackQL-resources/executions/methods/projects_locations_products_integrations_executions_list + - $ref: >- + #/components/x-stackQL-resources/executions/methods/projects_locations_integrations_executions_get - $ref: >- #/components/x-stackQL-resources/executions/methods/projects_locations_integrations_executions_list insert: [] @@ -10566,47 +10852,47 @@ components: name: suspensions title: Suspensions methods: - projects_locations_integrations_executions_suspensions_resolve: + projects_locations_products_integrations_executions_suspensions_resolve: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions~1{suspensionsId}:resolve/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions~1{suspensionsId}:resolve/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_executions_suspensions_lift: + projects_locations_products_integrations_executions_suspensions_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions~1{suspensionsId}:lift/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_executions_suspensions_list: + objectKey: $.suspensions + projects_locations_products_integrations_executions_suspensions_lift: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions~1{suspensionsId}:lift/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.suspensions - projects_locations_products_integrations_executions_suspensions_list: + projects_locations_integrations_executions_suspensions_resolve: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions~1{suspensionsId}:resolve/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.suspensions - projects_locations_products_integrations_executions_suspensions_lift: + projects_locations_integrations_executions_suspensions_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions~1{suspensionsId}:lift/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_executions_suspensions_resolve: + objectKey: $.suspensions + projects_locations_integrations_executions_suspensions_lift: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions~1{suspensionsId}:resolve/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions~1{suspensionsId}:lift/post response: mediaType: application/json openAPIDocKey: '200' @@ -10620,165 +10906,252 @@ components: update: [] replace: [] delete: [] - auth_configs: - id: google.integrations.auth_configs - name: auth_configs - title: Auth_configs + sfdc_instances: + id: google.integrations.sfdc_instances + name: sfdc_instances + title: Sfdc_instances methods: - projects_locations_auth_configs_list: + projects_locations_products_sfdc_instances_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authConfigs/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.authConfigs - projects_locations_auth_configs_create: + projects_locations_products_sfdc_instances_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authConfigs/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_auth_configs_patch: + objectKey: $.sfdcInstances + projects_locations_products_sfdc_instances_patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_products_sfdc_instances_delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_products_sfdc_instances_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_sfdc_instances_create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_sfdc_instances_list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.sfdcInstances + projects_locations_sfdc_instances_patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_sfdc_instances_delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_sfdc_instances_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_products_sfdc_instances_get + - $ref: >- + #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_products_sfdc_instances_list + - $ref: >- + #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_sfdc_instances_get + - $ref: >- + #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_sfdc_instances_list + insert: + - $ref: >- + #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_products_sfdc_instances_create + - $ref: >- + #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_sfdc_instances_create + update: + - $ref: >- + #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_products_sfdc_instances_patch + - $ref: >- + #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_sfdc_instances_patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_products_sfdc_instances_delete + - $ref: >- + #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_sfdc_instances_delete + sfdc_channels: + id: google.integrations.sfdc_channels + name: sfdc_channels + title: Sfdc_channels + methods: + projects_locations_products_sfdc_instances_sfdc_channels_create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_products_sfdc_instances_sfdc_channels_list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.sfdcChannels + projects_locations_products_sfdc_instances_sfdc_channels_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authConfigs~1{authConfigsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_auth_configs_get: + projects_locations_products_sfdc_instances_sfdc_channels_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authConfigs~1{authConfigsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_auth_configs_delete: + projects_locations_products_sfdc_instances_sfdc_channels_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authConfigs~1{authConfigsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_auth_configs_delete: + projects_locations_sfdc_instances_sfdc_channels_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1authConfigs~1{authConfigsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_auth_configs_patch: + projects_locations_sfdc_instances_sfdc_channels_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1authConfigs~1{authConfigsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_auth_configs_get: + objectKey: $.sfdcChannels + projects_locations_sfdc_instances_sfdc_channels_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1authConfigs~1{authConfigsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_auth_configs_list: + projects_locations_sfdc_instances_sfdc_channels_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1authConfigs/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.authConfigs - projects_locations_products_auth_configs_create: + projects_locations_sfdc_instances_sfdc_channels_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1authConfigs/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/auth_configs/methods/projects_locations_products_auth_configs_get + #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_products_sfdc_instances_sfdc_channels_get - $ref: >- - #/components/x-stackQL-resources/auth_configs/methods/projects_locations_auth_configs_get + #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_products_sfdc_instances_sfdc_channels_list - $ref: >- - #/components/x-stackQL-resources/auth_configs/methods/projects_locations_products_auth_configs_list + #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_sfdc_instances_sfdc_channels_get - $ref: >- - #/components/x-stackQL-resources/auth_configs/methods/projects_locations_auth_configs_list + #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_sfdc_instances_sfdc_channels_list insert: - $ref: >- - #/components/x-stackQL-resources/auth_configs/methods/projects_locations_products_auth_configs_create + #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_products_sfdc_instances_sfdc_channels_create - $ref: >- - #/components/x-stackQL-resources/auth_configs/methods/projects_locations_auth_configs_create + #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_sfdc_instances_sfdc_channels_create update: - $ref: >- - #/components/x-stackQL-resources/auth_configs/methods/projects_locations_products_auth_configs_patch + #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_products_sfdc_instances_sfdc_channels_patch - $ref: >- - #/components/x-stackQL-resources/auth_configs/methods/projects_locations_auth_configs_patch + #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_sfdc_instances_sfdc_channels_patch replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/auth_configs/methods/projects_locations_products_auth_configs_delete + #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_products_sfdc_instances_sfdc_channels_delete - $ref: >- - #/components/x-stackQL-resources/auth_configs/methods/projects_locations_auth_configs_delete - clients: - id: google.integrations.clients - name: clients - title: Clients + #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_sfdc_instances_sfdc_channels_delete + connections: + id: google.integrations.connections + name: connections + title: Connections methods: - projects_locations_clients_deprovision: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:deprovision/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_clients_switch: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:switch/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_clients_replace: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:replace/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_clients_provision: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:provision/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_clients_switch_variable_masking: + projects_locations_connections_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:switchVariableMasking/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connections/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_get_clients: + objectKey: $.connections + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/connections/methods/projects_locations_connections_list + insert: [] + update: [] + replace: [] + delete: [] + connection_schema_metadata: + id: google.integrations.connection_schema_metadata + name: connection_schema_metadata + title: Connection_schema_metadata + methods: + projects_locations_connections_get_connection_schema_metadata: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1connectionSchemaMetadata/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/clients/methods/projects_locations_get_clients + #/components/x-stackQL-resources/connection_schema_metadata/methods/projects_locations_connections_get_connection_schema_metadata insert: [] update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/clients/methods/projects_locations_clients_replace + replace: [] delete: [] runtime_entity_schemas: id: google.integrations.runtime_entity_schemas @@ -10822,63 +11195,115 @@ components: update: [] replace: [] delete: [] - connections_connection_schema_metadata: - id: google.integrations.connections_connection_schema_metadata - name: connections_connection_schema_metadata - title: Connections_connection_schema_metadata + test_cases: + id: google.integrations.test_cases + name: test_cases + title: Test_cases methods: - projects_locations_connections_get_connection_schema_metadata: + projects_locations_integrations_versions_test_cases_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1connectionSchemaMetadata/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}~1testCases/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/connections_connection_schema_metadata/methods/projects_locations_connections_get_connection_schema_metadata - insert: [] - update: [] - replace: [] - delete: [] - connections: - id: google.integrations.connections - name: connections - title: Connections - methods: - projects_locations_connections_list: + projects_locations_integrations_versions_test_cases_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connections/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}~1testCases/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.testCases + projects_locations_integrations_versions_test_cases_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}~1testCases~1{testCasesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_integrations_versions_test_cases_patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}~1testCases~1{testCasesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_integrations_versions_test_cases_delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}~1testCases~1{testCasesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_integrations_versions_test_cases_execute_test: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}~1testCases~1{testCasesId}:executeTest/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_integrations_versions_test_cases_upload: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}~1testCases:upload/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_integrations_versions_test_cases_download: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}~1testCases~1{testCasesId}:download/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_integrations_versions_test_cases_takeover_edit_lock: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}~1testCases~1{testCasesId}:takeoverEditLock/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_integrations_versions_test_cases_execute: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}~1testCases:execute/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.connections sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/connections/methods/projects_locations_connections_list - insert: [] - update: [] + #/components/x-stackQL-resources/test_cases/methods/projects_locations_integrations_versions_test_cases_get + - $ref: >- + #/components/x-stackQL-resources/test_cases/methods/projects_locations_integrations_versions_test_cases_list + insert: + - $ref: >- + #/components/x-stackQL-resources/test_cases/methods/projects_locations_integrations_versions_test_cases_create + update: + - $ref: >- + #/components/x-stackQL-resources/test_cases/methods/projects_locations_integrations_versions_test_cases_patch replace: [] - delete: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/test_cases/methods/projects_locations_integrations_versions_test_cases_delete templates: id: google.integrations.templates name: templates title: Templates methods: - projects_locations_templates_import: + projects_locations_templates_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates~1{templatesId}:import/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_templates_patch: + objectKey: $.templates + projects_locations_templates_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates~1{templatesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates/post response: mediaType: application/json openAPIDocKey: '200' @@ -10889,6 +11314,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + projects_locations_templates_patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates~1{templatesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' projects_locations_templates_delete: operation: $ref: >- @@ -10896,32 +11328,31 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_locations_templates_share: + projects_locations_templates_search: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates~1{templatesId}:share/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates:search/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_templates_list: + projects_locations_templates_use: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates~1{templatesId}:use/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.templates - projects_locations_templates_create: + projects_locations_templates_import: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates~1{templatesId}:import/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_templates_search: + projects_locations_templates_share: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates:search/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates~1{templatesId}:share/post response: mediaType: application/json openAPIDocKey: '200' @@ -10932,10 +11363,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_locations_templates_use: + projects_locations_templates_upload: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates~1{templatesId}:use/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates:upload/post response: mediaType: application/json openAPIDocKey: '200' @@ -10946,13 +11377,6 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_locations_templates_upload: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates:upload/post - response: - mediaType: application/json - openAPIDocKey: '200' sqlVerbs: select: - $ref: >- @@ -10968,22 +11392,20 @@ components: replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/templates/methods/projects_locations_templates_delete - clientmetadata: - id: google.integrations.clientmetadata - name: clientmetadata - title: Clientmetadata + #/components/x-stackQL-resources/templates/methods/projects_locations_templates_delete + connector_platform_regions: + id: google.integrations.connector_platform_regions + name: connector_platform_regions + title: Connector_platform_regions methods: - projects_get_clientmetadata: + connector_platform_regions_enumerate: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1clientmetadata/get' + $ref: '#/paths/~1v1~1connectorPlatformRegions:enumerate/get' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/clientmetadata/methods/projects_get_clientmetadata + select: [] insert: [] update: [] replace: [] @@ -11005,40 +11427,23 @@ components: update: [] replace: [] delete: [] - connector_platform_regions: - id: google.integrations.connector_platform_regions - name: connector_platform_regions - title: Connector_platform_regions - methods: - connector_platform_regions_enumerate: - operation: - $ref: '#/paths/~1v1~1connectorPlatformRegions:enumerate/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: [] paths: - /v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}: + /v1/projects/{projectsId}/clientmetadata: parameters: &ref_1 - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - delete: - description: Deletes an sfdc channel. - operationId: integrations.projects.locations.sfdcInstances.sfdcChannels.delete + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' + get: + description: Gets the metadata info for the requested client + operationId: integrations.projects.getClientmetadata security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11050,33 +11455,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaGetClientMetadataResponse parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: sfdcInstancesId - required: true - schema: - type: string - - in: path - name: sfdcChannelsId - required: true - schema: - type: string + /v1/projects/{projectsId}/locations/{locationsId}/clients: + parameters: *ref_1 get: description: >- - Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND - exception will be thrown. - operationId: integrations.projects.locations.sfdcInstances.sfdcChannels.get + Gets the client configuration for the given project and location + resource name + operationId: integrations.projects.locations.getClients security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11088,7 +11481,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaGetClientResponse parameters: - in: path name: projectsId @@ -11100,26 +11494,52 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}:generateOpenApiSpec: + parameters: *ref_1 + post: + description: Generate OpenAPI spec for the requested integrations and api triggers + operationId: integrations.projects.locations.generateOpenApiSpec + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaGenerateOpenApiSpecRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaGenerateOpenApiSpecResponse + parameters: - in: path - name: sfdcInstancesId + name: projectsId required: true schema: type: string - in: path - name: sfdcChannelsId + name: locationsId required: true schema: type: string - patch: - description: >- - Updates an sfdc channel. Updates the sfdc channel in spanner. Returns - the sfdc channel. - operationId: integrations.projects.locations.sfdcInstances.sfdcChannels.patch + /v1/projects/{projectsId}/locations/{locationsId}/appsScriptProjects:link: + parameters: *ref_1 + post: + description: Links a existing Apps Script project. + operationId: integrations.projects.locations.appsScriptProjects.link requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11131,7 +11551,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectResponse parameters: - in: path name: projectsId @@ -11143,28 +11564,55 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/appsScriptProjects: + parameters: *ref_1 + post: + description: Creates an Apps Script project. + operationId: integrations.projects.locations.appsScriptProjects.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectResponse + parameters: - in: path - name: sfdcInstancesId + name: projectsId required: true schema: type: string - in: path - name: sfdcChannelsId + name: locationsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels: + /v1/projects/{projectsId}/locations/{locationsId}/clients:provision: parameters: *ref_1 - get: + post: description: >- - Lists all sfdc channels that match the filter. Restrict to sfdc channels - belonging to the current client only. - operationId: integrations.projects.locations.sfdcInstances.sfdcChannels.list + Perform the provisioning steps to enable a user GCP project to use IP. + If GCP project already registered on IP end via Apigee Integration, + provisioning will fail. + operationId: integrations.projects.locations.clients.provision + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaProvisionClientRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11176,8 +11624,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -11189,39 +11636,17 @@ paths: required: true schema: type: string - - in: path - name: sfdcInstancesId - required: true - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/clients:provisionClientPostProcessor: + parameters: *ref_1 post: - description: >- - Creates an sfdc channel record. Store the sfdc channel in Spanner. - Returns the sfdc channel. - operationId: integrations.projects.locations.sfdcInstances.sfdcChannels.create + description: Perform post provisioning steps after client is provisioned. + operationId: integrations.projects.locations.clients.provisionClientPostProcessor requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaProvisionClientPostProcessorRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11233,7 +11658,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaProvisionClientPostProcessorResponse parameters: - in: path name: projectsId @@ -11245,18 +11671,19 @@ paths: required: true schema: type: string - - in: path - name: sfdcInstancesId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances: + /v1/projects/{projectsId}/locations/{locationsId}/clients:deprovision: parameters: *ref_1 - get: + post: description: >- - Lists all sfdc instances that match the filter. Restrict to sfdc - instances belonging to the current client only. - operationId: integrations.projects.locations.sfdcInstances.list + Perform the deprovisioning steps to disable a user GCP project to use IP + and purge all related data in a wipeout-compliant way. + operationId: integrations.projects.locations.clients.deprovision + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaDeprovisionClientRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11268,8 +11695,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -11281,34 +11707,19 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string + /v1/projects/{projectsId}/locations/{locationsId}/clients:changeConfig: + parameters: *ref_1 post: description: >- - Creates an sfdc instance record. Store the sfdc instance in Spanner. - Returns the sfdc instance. - operationId: integrations.projects.locations.sfdcInstances.create + Updates the client customer configuration for the given project and + location resource name + operationId: integrations.projects.locations.clients.changeConfig requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaChangeCustomerConfigRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11321,7 +11732,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance + #/components/schemas/GoogleCloudIntegrationsV1alphaChangeCustomerConfigResponse parameters: - in: path name: projectsId @@ -11333,13 +11744,17 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}: + /v1/projects/{projectsId}/locations/{locationsId}/clients:switch: parameters: *ref_1 - get: - description: >- - Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND - exception will be thrown. - operationId: integrations.projects.locations.sfdcInstances.get + post: + description: Update client from GMEK to CMEK + operationId: integrations.projects.locations.clients.switch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaSwitchEncryptionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11351,8 +11766,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -11364,14 +11778,17 @@ paths: required: true schema: type: string - - in: path - name: sfdcInstancesId - required: true - schema: - type: string - delete: - description: Deletes an sfdc instance. - operationId: integrations.projects.locations.sfdcInstances.delete + /v1/projects/{projectsId}/locations/{locationsId}/clients:replace: + parameters: *ref_1 + post: + description: Update run-as service account for provisioned client + operationId: integrations.projects.locations.clients.replace + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaReplaceServiceAccountRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11395,21 +11812,17 @@ paths: required: true schema: type: string - - in: path - name: sfdcInstancesId - required: true - schema: - type: string - patch: - description: >- - Updates an sfdc instance. Updates the sfdc instance in spanner. Returns - the sfdc instance. - operationId: integrations.projects.locations.sfdcInstances.patch + /v1/projects/{projectsId}/locations/{locationsId}/clients:switchVariableMasking: + parameters: *ref_1 + post: + description: Update variable masking for provisioned client + operationId: integrations.projects.locations.clients.switchVariableMasking requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaSwitchVariableMaskingRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11421,8 +11834,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -11434,27 +11846,17 @@ paths: required: true schema: type: string - - in: path - name: sfdcInstancesId - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/appsScriptProjects: + /v1/projects/{projectsId}/locations/{locationsId}/clients:toggleHttp: parameters: *ref_1 post: - description: Creates an Apps Script project. - operationId: integrations.projects.locations.appsScriptProjects.create + description: Enable/Disable http call for provisioned client + operationId: integrations.projects.locations.clients.toggleHttp requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaToggleHttpRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11466,8 +11868,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -11479,17 +11880,17 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/appsScriptProjects:link: + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/cloudFunctions: parameters: *ref_1 post: - description: Links a existing Apps Script project. - operationId: integrations.projects.locations.appsScriptProjects.link + description: Creates a cloud function project. + operationId: integrations.projects.locations.products.cloudFunctions.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaCreateCloudFunctionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11502,7 +11903,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaCreateCloudFunctionResponse parameters: - in: path name: projectsId @@ -11514,13 +11915,18 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/certificates: + - in: path + name: productsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates: parameters: *ref_1 get: description: >- List all the certificates that match the filter. Restrict to certificate of current client only. - operationId: integrations.projects.locations.certificates.list + operationId: integrations.projects.locations.products.certificates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11545,8 +11951,9 @@ paths: required: true schema: type: string - - in: query - name: pageToken + - in: path + name: productsId + required: true schema: type: string - in: query @@ -11554,6 +11961,10 @@ paths: schema: type: integer format: int32 + - in: query + name: pageToken + schema: + type: string - in: query name: filter schema: @@ -11568,7 +11979,7 @@ paths: Creates a new certificate. The certificate will be registered to the trawler service and will be encrypted using cloud KMS and stored in Spanner Returns the certificate. - operationId: integrations.projects.locations.certificates.create + operationId: integrations.projects.locations.products.certificates.create requestBody: content: application/json: @@ -11597,15 +12008,56 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/certificates/{certificatesId}: + - in: path + name: productsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates/{certificatesId}: parameters: *ref_1 + get: + description: Get a certificates in the specified project. + operationId: integrations.projects.locations.products.certificates.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: productsId + required: true + schema: + type: string + - in: path + name: certificatesId + required: true + schema: + type: string patch: description: >- Updates the certificate by id. If new certificate file is updated, it will register with the trawler service, re-encrypt with cloud KMS and update the Spanner record. Other fields will directly update the Spanner record. Returns the Certificate. - operationId: integrations.projects.locations.certificates.patch + operationId: integrations.projects.locations.products.certificates.patch requestBody: content: application/json: @@ -11634,6 +12086,11 @@ paths: required: true schema: type: string + - in: path + name: productsId + required: true + schema: + type: string - in: path name: certificatesId required: true @@ -11644,9 +12101,9 @@ paths: schema: type: string format: google-fieldmask - get: - description: Get a certificates in the specified project. - operationId: integrations.projects.locations.certificates.get + delete: + description: Delete a certificate + operationId: integrations.projects.locations.products.certificates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11658,7 +12115,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -11670,14 +12127,30 @@ paths: required: true schema: type: string + - in: path + name: productsId + required: true + schema: + type: string - in: path name: certificatesId required: true schema: type: string - delete: - description: Delete a certificate - operationId: integrations.projects.locations.certificates.delete + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs: + parameters: *ref_1 + post: + description: >- + Creates an auth config record. Fetch corresponding credentials for + specific auth types, e.g. access token for OAuth 2.0, JWT token for JWT. + Encrypt the auth config with Cloud KMS and store the encrypted + credentials in Spanner. Returns the encrypted auth config. + operationId: integrations.projects.locations.products.authConfigs.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11689,7 +12162,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' parameters: - in: path name: projectsId @@ -11702,21 +12175,27 @@ paths: schema: type: string - in: path - name: certificatesId + name: productsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/cloudFunctions: - parameters: *ref_1 - post: - description: Creates a cloud function project. - operationId: integrations.projects.locations.cloudFunctions.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaCreateCloudFunctionRequest + - in: query + name: clientCertificate.sslCertificate + schema: + type: string + - in: query + name: clientCertificate.encryptedPrivateKey + schema: + type: string + - in: query + name: clientCertificate.passphrase + schema: + type: string + get: + description: >- + Lists all auth configs that match the filter. Restrict to auth configs + belong to the current client only. + operationId: integrations.projects.locations.products.authConfigs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11729,7 +12208,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaCreateCloudFunctionResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListAuthConfigsResponse parameters: - in: path name: projectsId @@ -11741,17 +12220,44 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:test: + - in: path + name: productsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs/{authConfigsId}: parameters: *ref_1 - post: - description: Execute the integration in draft state - operationId: integrations.projects.locations.integrations.test + patch: + description: >- + Updates an auth config. If credential is updated, fetch the encrypted + auth config from Spanner, decrypt with Cloud KMS key, update the + credential fields, re-encrypt with Cloud KMS key and update the Spanner + record. For other fields, directly update the Spanner record. Returns + the encrypted auth config. + operationId: integrations.projects.locations.products.authConfigs.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaTestIntegrationsRequest + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11763,8 +12269,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaTestIntegrationsResponse + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' parameters: - in: path name: projectsId @@ -11777,48 +12282,35 @@ paths: schema: type: string - in: path - name: integrationsId + name: productsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}: - parameters: *ref_1 - delete: - description: Delete the selected integration and all versions inside - operationId: integrations.projects.locations.integrations.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' - parameters: - in: path - name: projectsId + name: authConfigsId required: true schema: type: string - - in: path - name: locationsId - required: true + - in: query + name: updateMask schema: type: string - - in: path - name: integrationsId - required: true + format: google-fieldmask + - in: query + name: clientCertificate.sslCertificate schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations: - parameters: *ref_1 - get: - description: Returns the list of all integrations in the specified project. - operationId: integrations.projects.locations.integrations.list + - in: query + name: clientCertificate.encryptedPrivateKey + schema: + type: string + - in: query + name: clientCertificate.passphrase + schema: + type: string + delete: + description: Deletes an auth config. + operationId: integrations.projects.locations.products.authConfigs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11830,8 +12322,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListIntegrationsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -11843,31 +12334,22 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: orderBy + - in: path + name: productsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + - in: path + name: authConfigsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:executeEvent: - parameters: *ref_1 - post: + get: description: >- - Executes an integration on receiving events from Integration Connector - triggers, Eventarc or CPS Trigger. Input data to integration is received - in body in json format - operationId: integrations.projects.locations.integrations.executeEvent + Gets a complete auth config. If the auth config doesn't exist, + Code.NOT_FOUND exception will be thrown. Returns the decrypted auth + config. + operationId: integrations.projects.locations.products.authConfigs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11879,8 +12361,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaExecuteEventResponse + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' parameters: - in: path name: projectsId @@ -11893,15 +12374,16 @@ paths: schema: type: string - in: path - name: integrationsId + name: productsId required: true schema: type: string - - in: query - name: triggerId + - in: path + name: authConfigsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:execute: + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:execute: parameters: *ref_1 post: description: >- @@ -11912,7 +12394,7 @@ paths: given trigger_id will be executed. Otherwise only the specified integration for the given `trigger_id` is executed. This is helpful for execution the integration from UI. - operationId: integrations.projects.locations.integrations.execute + operationId: integrations.projects.locations.products.integrations.execute requestBody: content: application/json: @@ -11943,18 +12425,23 @@ paths: required: true schema: type: string + - in: path + name: productsId + required: true + schema: + type: string - in: path name: integrationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:schedule: + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:schedule: parameters: *ref_1 post: description: >- Schedules an integration for execution by passing the trigger id and the scheduled time in the request body. - operationId: integrations.projects.locations.integrations.schedule + operationId: integrations.projects.locations.products.integrations.schedule requestBody: content: application/json: @@ -11985,16 +12472,27 @@ paths: required: true schema: type: string + - in: path + name: productsId + required: true + schema: + type: string - in: path name: integrationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases/{testCasesId}: + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:test: parameters: *ref_1 - delete: - description: Deletes a test case - operationId: integrations.projects.locations.integrations.versions.testCases.delete + post: + description: Execute the integration in draft state + operationId: integrations.projects.locations.products.integrations.test + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaTestIntegrationsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12006,7 +12504,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaTestIntegrationsResponse parameters: - in: path name: projectsId @@ -12019,28 +12518,20 @@ paths: schema: type: string - in: path - name: integrationsId - required: true - schema: - type: string - - in: path - name: versionsId + name: productsId required: true schema: type: string - in: path - name: testCasesId + name: integrationsId required: true schema: type: string - patch: - description: Updates a test case - operationId: integrations.projects.locations.integrations.versions.testCases.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTestCase' + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations: + parameters: *ref_1 + get: + description: Returns the list of all integrations in the specified project. + operationId: integrations.projects.locations.products.integrations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12052,7 +12543,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTestCase' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaListIntegrationsResponse parameters: - in: path name: projectsId @@ -12065,28 +12557,32 @@ paths: schema: type: string - in: path - name: integrationsId + name: productsId required: true schema: type: string - - in: path - name: versionsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - - in: path - name: testCasesId - required: true + - in: query + name: orderBy schema: type: string - in: query - name: updateMask + name: filter schema: type: string - format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions: + parameters: *ref_1 get: - description: Get a test case - operationId: integrations.projects.locations.integrations.versions.testCases.get + description: Returns the list of all integration versions in the specified project. + operationId: integrations.projects.locations.products.integrations.versions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12098,7 +12594,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTestCase' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse parameters: - in: path name: projectsId @@ -12111,70 +12608,46 @@ paths: schema: type: string - in: path - name: integrationsId - required: true - schema: - type: string - - in: path - name: versionsId + name: productsId required: true schema: type: string - in: path - name: testCasesId + name: integrationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases: - parameters: *ref_1 - post: - description: Creates a new test case - operationId: integrations.projects.locations.integrations.versions.testCases.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTestCase' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTestCase' - parameters: - - in: path - name: projectsId - required: true + - in: query + name: pageSize schema: - type: string - - in: path - name: locationsId - required: true + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - - in: path - name: integrationsId - required: true + - in: query + name: filter schema: type: string - - in: path - name: versionsId - required: true + - in: query + name: orderBy schema: type: string - in: query - name: testCaseId + name: fieldMask schema: type: string - get: - description: Lists all the test cases that satisfy the filters. - operationId: integrations.projects.locations.integrations.versions.testCases.list + format: google-fieldmask + post: + description: Create a integration with a draft version in the specified project. + operationId: integrations.projects.locations.products.integrations.versions.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12187,7 +12660,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListTestCasesResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion parameters: - in: path name: projectsId @@ -12200,52 +12673,34 @@ paths: schema: type: string - in: path - name: integrationsId + name: productsId required: true schema: type: string - in: path - name: versionsId + name: integrationsId required: true schema: type: string - in: query - name: pageToken - schema: - type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize + name: newIntegration schema: - type: integer - format: int32 + type: boolean - in: query - name: orderBy + name: createSampleIntegrations schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases:upload: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}: parameters: *ref_1 - post: - description: >- - Uploads a test case. The content can be a previously downloaded test - case. Performs the same function as CreateTestCase, but accepts input in - a string format, which holds the complete representation of the TestCase - content. - operationId: integrations.projects.locations.integrations.versions.testCases.upload + patch: + description: Update a integration with a draft version in the specified project. + operationId: integrations.projects.locations.products.integrations.versions.patch requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUploadTestCaseRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12258,7 +12713,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUploadTestCaseResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion parameters: - in: path name: projectsId @@ -12270,6 +12725,11 @@ paths: required: true schema: type: string + - in: path + name: productsId + required: true + schema: + type: string - in: path name: integrationsId required: true @@ -12280,18 +12740,14 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases/{testCasesId}:executeTest: - parameters: *ref_1 - post: - description: Executes functional test - operationId: >- - integrations.projects.locations.integrations.versions.testCases.executeTest - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaExecuteTestCaseRequest + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + get: + description: Get a integration in the specified project. + operationId: integrations.projects.locations.products.integrations.versions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12304,7 +12760,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaExecuteTestCaseResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion parameters: - in: path name: projectsId @@ -12317,30 +12773,32 @@ paths: schema: type: string - in: path - name: integrationsId + name: productsId required: true schema: type: string - in: path - name: versionsId + name: integrationsId required: true schema: type: string - in: path - name: testCasesId + name: versionsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases/{testCasesId}:executions: - parameters: *ref_1 - get: + delete: description: >- - Lists the results of all functional test executions. The response - includes the same information as the [execution - log](https://cloud.google.com/application-integration/docs/viewing-logs) - in the Integration UI. - operationId: >- - integrations.projects.locations.integrations.versions.testCases.listExecutions + Soft-deletes the integration. Changes the status of the integration to + ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag + is removed from this snapshot and set to the previous non-ARCHIVED + snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. + This RPC throws an exception if the version being deleted is DRAFT, and + if the `locked_by` user is not the same as the user performing the + Delete. Audit fields updated include last_modified_timestamp, + last_modified_by. Any existing lock is released when Deleting a + integration. Currently, there is no undelete mechanism. + operationId: integrations.projects.locations.products.integrations.versions.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12352,8 +12810,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListTestCaseExecutionsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -12366,58 +12823,37 @@ paths: schema: type: string - in: path - name: integrationsId + name: productsId required: true schema: type: string - in: path - name: versionsId + name: integrationsId required: true schema: type: string - in: path - name: testCasesId + name: versionsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: truncateParams - schema: - type: boolean - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: filter - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases/{testCasesId}:takeoverEditLock: + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:publish: parameters: *ref_1 post: - description: Clear the lock fields and assign them to current user - operationId: >- - integrations.projects.locations.integrations.versions.testCases.takeoverEditLock + description: >- + This RPC throws an exception if the integration is in ARCHIVED or ACTIVE + state. This RPC throws an exception if the version being published is + DRAFT, and if the `locked_by` user is not the same as the user + performing the Publish. Audit fields updated include + last_published_timestamp, last_published_by, last_modified_timestamp, + last_modified_by. Any existing lock is on this integration is released. + operationId: integrations.projects.locations.products.integrations.versions.publish requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaTakeoverTestCaseEditLockRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12429,7 +12865,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTestCase' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse parameters: - in: path name: projectsId @@ -12442,27 +12879,36 @@ paths: schema: type: string - in: path - name: integrationsId + name: productsId required: true schema: type: string - in: path - name: versionsId + name: integrationsId required: true schema: type: string - in: path - name: testCasesId + name: versionsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases/{testCasesId}:download: + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions:upload: parameters: *ref_1 - get: + post: description: >- - Downloads a test case. Retrieves the `TestCase` for a given - `test_case_id` and returns the response as a string. - operationId: integrations.projects.locations.integrations.versions.testCases.download + Uploads an integration. The content can be a previously downloaded + integration. Performs the same function as + CreateDraftIntegrationVersion, but accepts input in a string format, + which holds the complete representation of the IntegrationVersion + content. + operationId: integrations.projects.locations.products.integrations.versions.upload + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12475,7 +12921,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadTestCaseResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse parameters: - in: path name: projectsId @@ -12488,40 +12934,22 @@ paths: schema: type: string - in: path - name: integrationsId - required: true - schema: - type: string - - in: path - name: versionsId + name: productsId required: true schema: type: string - in: path - name: testCasesId + name: integrationsId required: true schema: type: string - - in: query - name: fileFormat - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions:upload: + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:download: parameters: *ref_1 - post: + get: description: >- - Uploads an integration. The content can be a previously downloaded - integration. Performs the same function as - CreateDraftIntegrationVersion, but accepts input in a string format, - which holds the complete representation of the IntegrationVersion - content. - operationId: integrations.projects.locations.integrations.versions.upload - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest + Downloads an integration. Retrieves the `IntegrationVersion` for a given + `integration_id` and returns the response as a string. + operationId: integrations.projects.locations.products.integrations.versions.download security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12534,7 +12962,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse parameters: - in: path name: projectsId @@ -12546,22 +12974,53 @@ paths: required: true schema: type: string + - in: path + name: productsId + required: true + schema: + type: string - in: path name: integrationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}: + - in: path + name: versionsId + required: true + schema: + type: string + - in: query + name: fileFormat + schema: + type: string + - in: query + name: files + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:takeoverEditLock: parameters: *ref_1 - patch: - description: Update a integration with a draft version in the specified project. - operationId: integrations.projects.locations.integrations.versions.patch + post: + description: >- + Clears the `locked_by` and `locked_at_timestamp`in the DRAFT version of + this integration. It then performs the same action as the + CreateDraftIntegrationVersion (i.e., copies the DRAFT version of the + integration as a SNAPSHOT and then creates a new DRAFT version with the + `locked_by` set to the `user_taking_over` and the `locked_at_timestamp` + set to the current timestamp). Both the `locked_by` and + `user_taking_over` are notified via email about the takeover. This RPC + throws an exception if the integration is not in DRAFT status or if the + `locked_by` and `locked_at_timestamp` fields are not set.The + TakeoverEdit lock is treated the same as an edit of the integration, and + hence shares ACLs with edit. Audit fields updated include + last_modified_timestamp, last_modified_by. + operationId: >- + integrations.projects.locations.products.integrations.versions.takeoverEditLock requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + #/components/schemas/GoogleCloudIntegrationsV1alphaTakeoverEditLockRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12574,7 +13033,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + #/components/schemas/GoogleCloudIntegrationsV1alphaTakeoverEditLockResponse parameters: - in: path name: projectsId @@ -12582,7 +13041,12 @@ paths: schema: type: string - in: path - name: locationsId + name: locationsId + required: true + schema: + type: string + - in: path + name: productsId required: true schema: type: string @@ -12596,23 +13060,22 @@ paths: required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:unpublish: + parameters: *ref_1 + post: description: >- - Soft-deletes the integration. Changes the status of the integration to - ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag - is removed from this snapshot and set to the previous non-ARCHIVED - snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. - This RPC throws an exception if the version being deleted is DRAFT, and - if the `locked_by` user is not the same as the user performing the - Delete. Audit fields updated include last_modified_timestamp, - last_modified_by. Any existing lock is released when Deleting a - integration. Currently, there is no undelete mechanism. - operationId: integrations.projects.locations.integrations.versions.delete + Sets the status of the ACTIVE integration to SNAPSHOT with a new tag + "PREVIOUSLY_PUBLISHED" after validating it. The "HEAD" and + "PUBLISH_REQUESTED" tags do not change. This RPC throws an exception if + the version being snapshot is not ACTIVE. Audit fields added include + action, action_by, action_timestamp. + operationId: integrations.projects.locations.products.integrations.versions.unpublish + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12636,6 +13099,11 @@ paths: required: true schema: type: string + - in: path + name: productsId + required: true + schema: + type: string - in: path name: integrationsId required: true @@ -12646,9 +13114,15 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions: + parameters: *ref_1 get: - description: Get a integration in the specified project. - operationId: integrations.projects.locations.integrations.versions.get + description: >- + Lists the results of all the integration executions. The response + includes the same information as the [execution + log](https://cloud.google.com/application-integration/docs/viewing-logs) + in the Integration UI. + operationId: integrations.projects.locations.products.integrations.executions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12661,7 +13135,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + #/components/schemas/GoogleCloudIntegrationsV1alphaListExecutionsResponse parameters: - in: path name: projectsId @@ -12674,32 +13148,104 @@ paths: schema: type: string - in: path - name: integrationsId + name: productsId required: true schema: type: string - in: path - name: versionsId + name: integrationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:publish: + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: orderBy + schema: + type: string + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: filterParams.workflowName + schema: + type: string + - in: query + name: filterParams.startTime + schema: + type: string + format: int64 + - in: query + name: filterParams.endTime + schema: + type: string + format: int64 + - in: query + name: filterParams.eventStatuses + schema: + type: string + - in: query + name: filterParams.taskStatuses + schema: + type: string + - in: query + name: filterParams.customFilter + schema: + type: string + - in: query + name: filterParams.executionId + schema: + type: string + - in: query + name: filterParams.parameterValue + schema: + type: string + - in: query + name: filterParams.parameterType + schema: + type: string + - in: query + name: filterParams.parameterKey + schema: + type: string + - in: query + name: filterParams.parameterPairKey + schema: + type: string + - in: query + name: filterParams.parameterPairValue + schema: + type: string + - in: query + name: refreshAcl + schema: + type: boolean + - in: query + name: truncateParams + schema: + type: boolean + - in: query + name: snapshotMetadataWithoutParams + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}: parameters: *ref_1 - post: - description: >- - This RPC throws an exception if the integration is in ARCHIVED or ACTIVE - state. This RPC throws an exception if the version being published is - DRAFT, and if the `locked_by` user is not the same as the user - performing the Publish. Audit fields updated include - last_published_timestamp, last_published_by, last_modified_timestamp, - last_modified_by. Any existing lock is on this integration is released. - operationId: integrations.projects.locations.integrations.versions.publish - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest + get: + description: Get an execution in the specified project. + operationId: integrations.projects.locations.products.integrations.executions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12711,8 +13257,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaExecution' parameters: - in: path name: projectsId @@ -12724,21 +13269,27 @@ paths: required: true schema: type: string + - in: path + name: productsId + required: true + schema: + type: string - in: path name: integrationsId required: true schema: type: string - in: path - name: versionsId + name: executionsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions: + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}:download: parameters: *ref_1 get: - description: Returns the list of all integration versions in the specified project. - operationId: integrations.projects.locations.integrations.versions.list + description: Download the execution. + operationId: >- + integrations.projects.locations.products.integrations.executions.download security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12751,7 +13302,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadExecutionResponse parameters: - in: path name: projectsId @@ -12764,41 +13315,35 @@ paths: schema: type: string - in: path - name: integrationsId + name: productsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: fieldMask - schema: - type: string - format: google-fieldmask - - in: query - name: pageToken - schema: - type: string - - in: query - name: orderBy + - in: path + name: integrationsId + required: true schema: type: string - - in: query - name: filter + - in: path + name: executionsId + required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:resolve: + parameters: *ref_1 post: - description: Create a integration with a draft version in the specified project. - operationId: integrations.projects.locations.integrations.versions.create + description: >- + * Resolves (lifts/rejects) any number of suspensions. If the integration + is already running, only the status of the suspension is updated. + Otherwise, the suspended integration will begin execution again. + operationId: >- + integrations.projects.locations.products.integrations.executions.suspensions.resolve requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + #/components/schemas/GoogleCloudIntegrationsV1alphaResolveSuspensionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12811,7 +13356,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + #/components/schemas/GoogleCloudIntegrationsV1alphaResolveSuspensionResponse parameters: - in: path name: projectsId @@ -12823,35 +13368,35 @@ paths: required: true schema: type: string + - in: path + name: productsId + required: true + schema: + type: string - in: path name: integrationsId required: true schema: type: string - - in: query - name: createSampleIntegrations + - in: path + name: executionsId + required: true schema: - type: boolean - - in: query - name: newIntegration + type: string + - in: path + name: suspensionsId + required: true schema: - type: boolean - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:unpublish: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions: parameters: *ref_1 - post: + get: description: >- - Sets the status of the ACTIVE integration to SNAPSHOT with a new tag - "PREVIOUSLY_PUBLISHED" after validating it. The "HEAD" and - "PUBLISH_REQUESTED" tags do not change. This RPC throws an exception if - the version being snapshot is not ACTIVE. Audit fields added include - action, action_by, action_timestamp. - operationId: integrations.projects.locations.integrations.versions.unpublish - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest + * Lists suspensions associated with a specific execution. Only those + with permissions to resolve the relevant suspensions will be able to + view them. + operationId: >- + integrations.projects.locations.products.integrations.executions.suspensions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12863,7 +13408,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaListSuspensionsResponse parameters: - in: path name: projectsId @@ -12875,23 +13421,53 @@ paths: required: true schema: type: string + - in: path + name: productsId + required: true + schema: + type: string - in: path name: integrationsId required: true schema: type: string - in: path - name: versionsId + name: executionsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:download: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:lift: parameters: *ref_1 - get: + post: description: >- - Downloads an integration. Retrieves the `IntegrationVersion` for a given - `integration_id` and returns the response as a string. - operationId: integrations.projects.locations.integrations.versions.download + * Lifts suspension for the Suspension task. Fetch corresponding + suspension with provided suspension Id, resolve suspension, and set up + suspension result for the Suspension Task. + operationId: >- + integrations.projects.locations.products.integrations.executions.suspensions.lift + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaLiftSuspensionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12904,7 +13480,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaLiftSuspensionResponse parameters: - in: path name: projectsId @@ -12917,33 +13493,37 @@ paths: schema: type: string - in: path - name: integrationsId + name: productsId required: true schema: type: string - in: path - name: versionsId + name: integrationsId required: true schema: type: string - - in: query - name: files + - in: path + name: executionsId + required: true schema: type: string - - in: query - name: fileFormat + - in: path + name: suspensionsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:downloadJsonPackage: + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances: parameters: *ref_1 - get: + post: description: >- - Downloads an Integration version package like - IntegrationVersion,Integration Config etc. Retrieves the - IntegrationVersion package for a given `integration_id` and returns the - response as a JSON. - operationId: >- - integrations.projects.locations.integrations.versions.downloadJsonPackage + Creates an sfdc instance record. Store the sfdc instance in Spanner. + Returns the sfdc instance. + operationId: integrations.projects.locations.products.sfdcInstances.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12956,7 +13536,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadJsonPackageResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance parameters: - in: path name: projectsId @@ -12969,28 +13549,15 @@ paths: schema: type: string - in: path - name: integrationsId - required: true - schema: - type: string - - in: path - name: versionsId + name: productsId required: true schema: type: string - - in: query - name: files - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions: - parameters: *ref_1 get: description: >- - Lists the results of all the integration executions. The response - includes the same information as the [execution - log](https://cloud.google.com/application-integration/docs/viewing-logs) - in the Integration UI. - operationId: integrations.projects.locations.integrations.executions.list + Lists all sfdc instances that match the filter. Restrict to sfdc + instances belonging to the current client only. + operationId: integrations.projects.locations.products.sfdcInstances.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13003,7 +13570,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListExecutionsResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse parameters: - in: path name: projectsId @@ -13016,107 +13583,82 @@ paths: schema: type: string - in: path - name: integrationsId + name: productsId required: true schema: type: string - - in: query - name: filterParams.executionId - schema: - type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: pageToken - schema: - type: string - in: query name: pageSize schema: type: integer format: int32 - in: query - name: orderBy - schema: - type: string - - in: query - name: filterParams.endTime - schema: - type: string - format: int64 - - in: query - name: snapshotMetadataWithoutParams - schema: - type: boolean - - in: query - name: filterParams.parameterValue - schema: - type: string - - in: query - name: filterParams.eventStatuses - schema: - type: string - - in: query - name: filterParams.parameterPairKey - schema: - type: string - - in: query - name: filterParams.taskStatuses + name: pageToken schema: type: string - in: query - name: filterParams.startTime + name: filter schema: type: string - format: int64 - in: query - name: filterParams.customFilter + name: readMask schema: type: string - - in: query - name: filter + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}: + parameters: *ref_1 + patch: + description: >- + Updates an sfdc instance. Updates the sfdc instance in spanner. Returns + the sfdc instance. + operationId: integrations.projects.locations.products.sfdcInstances.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance + parameters: + - in: path + name: projectsId + required: true schema: type: string - - in: query - name: refreshAcl - schema: - type: boolean - - in: query - name: filterParams.parameterPairValue + - in: path + name: locationsId + required: true schema: type: string - - in: query - name: filterParams.parameterKey + - in: path + name: productsId + required: true schema: type: string - - in: query - name: truncateParams - schema: - type: boolean - - in: query - name: filterParams.parameterType + - in: path + name: sfdcInstancesId + required: true schema: type: string - in: query - name: filterParams.workflowName + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}:replay: - parameters: *ref_1 - post: - description: >- - Re-execute an existing execution, with same request parameters and - execution strategy. - operationId: integrations.projects.locations.integrations.executions.replay - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaReplayExecutionRequest + format: google-fieldmask + delete: + description: Deletes an sfdc instance. + operationId: integrations.projects.locations.products.sfdcInstances.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13128,8 +13670,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaReplayExecutionResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -13142,20 +13683,20 @@ paths: schema: type: string - in: path - name: integrationsId + name: productsId required: true schema: type: string - in: path - name: executionsId + name: sfdcInstancesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}:download: - parameters: *ref_1 get: - description: Download the execution. - operationId: integrations.projects.locations.integrations.executions.download + description: >- + Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND + exception will be thrown. + operationId: integrations.projects.locations.products.sfdcInstances.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13168,7 +13709,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadExecutionResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance parameters: - in: path name: projectsId @@ -13181,29 +13722,28 @@ paths: schema: type: string - in: path - name: integrationsId + name: productsId required: true schema: type: string - in: path - name: executionsId + name: sfdcInstancesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels: parameters: *ref_1 - post: - description: >- - Cancellation of an execution and associated sub-executions. This will - not cancel an IN_PROCESS or completed(SUCCESSFUL, FAILED or CANCELLED) - executions. - operationId: integrations.projects.locations.integrations.executions.cancel + post: + description: >- + Creates an sfdc channel record. Store the sfdc channel in Spanner. + Returns the sfdc channel. + operationId: >- + integrations.projects.locations.products.sfdcInstances.sfdcChannels.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaCancelExecutionRequest + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13215,8 +13755,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaCancelExecutionResponse + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' parameters: - in: path name: projectsId @@ -13229,20 +13768,20 @@ paths: schema: type: string - in: path - name: integrationsId + name: productsId required: true schema: type: string - in: path - name: executionsId + name: sfdcInstancesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}: - parameters: *ref_1 get: - description: Get an execution in the specified project. - operationId: integrations.projects.locations.integrations.executions.get + description: >- + Lists all sfdc channels that match the filter. Restrict to sfdc channels + belonging to the current client only. + operationId: integrations.projects.locations.products.sfdcInstances.sfdcChannels.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13254,7 +13793,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaExecution' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse parameters: - in: path name: projectsId @@ -13267,30 +13807,46 @@ paths: schema: type: string - in: path - name: integrationsId + name: productsId required: true schema: type: string - in: path - name: executionsId + name: sfdcInstancesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:resolve: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}: parameters: *ref_1 - post: + patch: description: >- - * Resolves (lifts/rejects) any number of suspensions. If the integration - is already running, only the status of the suspension is updated. - Otherwise, the suspended integration will begin execution again. + Updates an sfdc channel. Updates the sfdc channel in spanner. Returns + the sfdc channel. operationId: >- - integrations.projects.locations.integrations.executions.suspensions.resolve + integrations.projects.locations.products.sfdcInstances.sfdcChannels.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaResolveSuspensionRequest + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13302,8 +13858,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaResolveSuspensionResponse + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' parameters: - in: path name: projectsId @@ -13316,34 +13871,29 @@ paths: schema: type: string - in: path - name: integrationsId + name: productsId required: true schema: type: string - in: path - name: executionsId + name: sfdcInstancesId required: true schema: type: string - in: path - name: suspensionsId + name: sfdcChannelsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:lift: - parameters: *ref_1 - post: - description: >- - * Lifts suspension for the Suspension task. Fetch corresponding - suspension with provided suspension Id, resolve suspension, and set up - suspension result for the Suspension Task. - operationId: integrations.projects.locations.integrations.executions.suspensions.lift - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaLiftSuspensionRequest + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes an sfdc channel. + operationId: >- + integrations.projects.locations.products.sfdcInstances.sfdcChannels.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13355,8 +13905,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaLiftSuspensionResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -13369,28 +13918,25 @@ paths: schema: type: string - in: path - name: integrationsId + name: productsId required: true schema: type: string - in: path - name: executionsId + name: sfdcInstancesId required: true schema: type: string - in: path - name: suspensionsId + name: sfdcChannelsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions: - parameters: *ref_1 get: description: >- - * Lists suspensions associated with a specific execution. Only those - with permissions to resolve the relevant suspensions will be able to - view them. - operationId: integrations.projects.locations.integrations.executions.suspensions.list + Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND + exception will be thrown. + operationId: integrations.projects.locations.products.sfdcInstances.sfdcChannels.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13402,8 +13948,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListSuspensionsResponse + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' parameters: - in: path name: projectsId @@ -13416,39 +13961,62 @@ paths: schema: type: string - in: path - name: integrationsId + name: productsId required: true schema: type: string - in: path - name: executionsId + name: sfdcInstancesId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + - in: path + name: sfdcChannelsId + required: true schema: type: string - - in: query - name: pageToken + /v1/projects/{projectsId}/locations/{locationsId}/cloudFunctions: + parameters: *ref_1 + post: + description: Creates a cloud function project. + operationId: integrations.projects.locations.cloudFunctions.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaCreateCloudFunctionRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaCreateCloudFunctionResponse + parameters: + - in: path + name: projectsId + required: true schema: type: string - - in: query - name: orderBy + - in: path + name: locationsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/authConfigs: + /v1/projects/{projectsId}/locations/{locationsId}/certificates: parameters: *ref_1 get: description: >- - Lists all auth configs that match the filter. Restrict to auth configs - belong to the current client only. - operationId: integrations.projects.locations.authConfigs.list + List all the certificates that match the filter. Restrict to certificate + of current client only. + operationId: integrations.projects.locations.certificates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13461,7 +14029,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListAuthConfigsResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListCertificatesResponse parameters: - in: path name: projectsId @@ -13474,35 +14042,34 @@ paths: schema: type: string - in: query - name: filter + name: pageSize schema: - type: string + type: integer + format: int32 - in: query - name: readMask + name: pageToken schema: type: string - format: google-fieldmask - in: query - name: pageToken + name: filter schema: type: string - in: query - name: pageSize + name: readMask schema: - type: integer - format: int32 + type: string + format: google-fieldmask post: description: >- - Creates an auth config record. Fetch corresponding credentials for - specific auth types, e.g. access token for OAuth 2.0, JWT token for JWT. - Encrypt the auth config with Cloud KMS and store the encrypted - credentials in Spanner. Returns the encrypted auth config. - operationId: integrations.projects.locations.authConfigs.create + Creates a new certificate. The certificate will be registered to the + trawler service and will be encrypted using cloud KMS and stored in + Spanner Returns the certificate. + operationId: integrations.projects.locations.certificates.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13514,7 +14081,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' parameters: - in: path name: projectsId @@ -13526,33 +14093,11 @@ paths: required: true schema: type: string - - in: query - name: clientCertificate.sslCertificate - schema: - type: string - - in: query - name: clientCertificate.passphrase - schema: - type: string - - in: query - name: clientCertificate.encryptedPrivateKey - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/authConfigs/{authConfigsId}: + /v1/projects/{projectsId}/locations/{locationsId}/certificates/{certificatesId}: parameters: *ref_1 - patch: - description: >- - Updates an auth config. If credential is updated, fetch the encrypted - auth config from Spanner, decrypt with Cloud KMS key, update the - credential fields, re-encrypt with Cloud KMS key and update the Spanner - record. For other fields, directly update the Spanner record. Returns - the encrypted auth config. - operationId: integrations.projects.locations.authConfigs.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + get: + description: Get a certificates in the specified project. + operationId: integrations.projects.locations.certificates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13564,7 +14109,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' parameters: - in: path name: projectsId @@ -13576,34 +14121,23 @@ paths: required: true schema: type: string - - in: path - name: authConfigsId - required: true - schema: - type: string - - in: query - name: clientCertificate.sslCertificate - schema: - type: string - - in: query - name: clientCertificate.passphrase - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - - in: query - name: clientCertificate.encryptedPrivateKey + - in: path + name: certificatesId + required: true schema: type: string - get: + patch: description: >- - Gets a complete auth config. If the auth config doesn't exist, - Code.NOT_FOUND exception will be thrown. Returns the decrypted auth - config. - operationId: integrations.projects.locations.authConfigs.get + Updates the certificate by id. If new certificate file is updated, it + will register with the trawler service, re-encrypt with cloud KMS and + update the Spanner record. Other fields will directly update the Spanner + record. Returns the Certificate. + operationId: integrations.projects.locations.certificates.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13615,7 +14149,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' parameters: - in: path name: projectsId @@ -13628,13 +14162,18 @@ paths: schema: type: string - in: path - name: authConfigsId + name: certificatesId required: true schema: type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask delete: - description: Deletes an auth config. - operationId: integrations.projects.locations.authConfigs.delete + description: Delete a certificate + operationId: integrations.projects.locations.certificates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13659,23 +14198,24 @@ paths: schema: type: string - in: path - name: authConfigsId + name: certificatesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/clients:deprovision: + /v1/projects/{projectsId}/locations/{locationsId}/authConfigs: parameters: *ref_1 post: description: >- - Perform the deprovisioning steps to disable a user GCP project to use IP - and purge all related data in a wipeout-compliant way. - operationId: integrations.projects.locations.clients.deprovision + Creates an auth config record. Fetch corresponding credentials for + specific auth types, e.g. access token for OAuth 2.0, JWT token for JWT. + Encrypt the auth config with Cloud KMS and store the encrypted + credentials in Spanner. Returns the encrypted auth config. + operationId: integrations.projects.locations.authConfigs.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaDeprovisionClientRequest + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13687,7 +14227,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' parameters: - in: path name: projectsId @@ -13699,17 +14239,23 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/clients:switch: - parameters: *ref_1 - post: - description: Update client from GMEK to CMEK - operationId: integrations.projects.locations.clients.switch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSwitchEncryptionRequest + - in: query + name: clientCertificate.sslCertificate + schema: + type: string + - in: query + name: clientCertificate.encryptedPrivateKey + schema: + type: string + - in: query + name: clientCertificate.passphrase + schema: + type: string + get: + description: >- + Lists all auth configs that match the filter. Restrict to auth configs + belong to the current client only. + operationId: integrations.projects.locations.authConfigs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13721,7 +14267,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaListAuthConfigsResponse parameters: - in: path name: projectsId @@ -13733,17 +14280,39 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/clients:replace: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/authConfigs/{authConfigsId}: parameters: *ref_1 - post: - description: Update run-as service account for provisioned client - operationId: integrations.projects.locations.clients.replace + patch: + description: >- + Updates an auth config. If credential is updated, fetch the encrypted + auth config from Spanner, decrypt with Cloud KMS key, update the + credential fields, re-encrypt with Cloud KMS key and update the Spanner + record. For other fields, directly update the Spanner record. Returns + the encrypted auth config. + operationId: integrations.projects.locations.authConfigs.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaReplaceServiceAccountRequest + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13755,7 +14324,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' parameters: - in: path name: projectsId @@ -13767,20 +14336,31 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/clients:provision: - parameters: *ref_1 - post: - description: >- - Perform the provisioning steps to enable a user GCP project to use IP. - If GCP project already registered on IP end via Apigee Integration, - provisioning will fail. - operationId: integrations.projects.locations.clients.provision - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaProvisionClientRequest + - in: path + name: authConfigsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: clientCertificate.sslCertificate + schema: + type: string + - in: query + name: clientCertificate.encryptedPrivateKey + schema: + type: string + - in: query + name: clientCertificate.passphrase + schema: + type: string + delete: + description: Deletes an auth config. + operationId: integrations.projects.locations.authConfigs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13804,17 +14384,17 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/clients:switchVariableMasking: - parameters: *ref_1 - post: - description: Update variable masking for provisioned client - operationId: integrations.projects.locations.clients.switchVariableMasking - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSwitchVariableMaskingRequest + - in: path + name: authConfigsId + required: true + schema: + type: string + get: + description: >- + Gets a complete auth config. If the auth config doesn't exist, + Code.NOT_FOUND exception will be thrown. Returns the decrypted auth + config. + operationId: integrations.projects.locations.authConfigs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13826,7 +14406,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' parameters: - in: path name: projectsId @@ -13838,13 +14418,16 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/runtimeEntitySchemas: + - in: path + name: authConfigsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/connections: parameters: *ref_1 get: - description: >- - Lists the JSON schemas for the properties of runtime entities, filtered - by entity name. - operationId: integrations.projects.locations.connections.runtimeEntitySchemas.list + description: Lists Connections in a given project and location. + operationId: integrations.projects.locations.connections.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13857,7 +14440,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListRuntimeEntitySchemasResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListConnectionsResponse parameters: - in: path name: projectsId @@ -13869,11 +14452,6 @@ paths: required: true schema: type: string - - in: path - name: connectionsId - required: true - schema: - type: string - in: query name: pageSize schema: @@ -13887,13 +14465,15 @@ paths: name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/runtimeActionSchemas: + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/connectionSchemaMetadata: parameters: *ref_1 get: - description: >- - Lists the JSON schemas for the inputs and outputs of actions, filtered - by action name. - operationId: integrations.projects.locations.connections.runtimeActionSchemas.list + description: Lists the available entities and actions associated with a Connection. + operationId: integrations.projects.locations.connections.getConnectionSchemaMetadata security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13906,7 +14486,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListRuntimeActionSchemasResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaConnectionSchemaMetadata parameters: - in: path name: projectsId @@ -13923,24 +14503,13 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/connectionSchemaMetadata: + /v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/runtimeEntitySchemas: parameters: *ref_1 get: - description: Lists the available entities and actions associated with a Connection. - operationId: integrations.projects.locations.connections.getConnectionSchemaMetadata + description: >- + Lists the JSON schemas for the properties of runtime entities, filtered + by entity name. + operationId: integrations.projects.locations.connections.runtimeEntitySchemas.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13953,7 +14522,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaConnectionSchemaMetadata + #/components/schemas/GoogleCloudIntegrationsV1alphaListRuntimeEntitySchemasResponse parameters: - in: path name: projectsId @@ -13970,11 +14539,26 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/connections: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/runtimeActionSchemas: parameters: *ref_1 get: - description: Lists Connections in a given project and location. - operationId: integrations.projects.locations.connections.list + description: >- + Lists the JSON schemas for the inputs and outputs of actions, filtered + by action name. + operationId: integrations.projects.locations.connections.runtimeActionSchemas.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13987,7 +14571,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListConnectionsResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListRuntimeActionSchemasResponse parameters: - in: path name: projectsId @@ -13999,8 +14583,9 @@ paths: required: true schema: type: string - - in: query - name: pageToken + - in: path + name: connectionsId + required: true schema: type: string - in: query @@ -14009,27 +14594,31 @@ paths: type: integer format: int32 - in: query - name: filter + name: pageToken schema: type: string - in: query - name: orderBy + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:import: + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:execute: parameters: *ref_1 post: description: >- - Import the template to an existing integration. This api would keep - track of usage_count and last_used_time. PERMISSION_DENIED would be - thrown if template is not accessible by client. - operationId: integrations.projects.locations.templates.import + Executes integrations synchronously by passing the trigger id in the + request body. The request is not returned until the requested executions + are either fulfilled or experienced an error. If the integration name is + not specified (passing `-`), all of the associated integration under the + given trigger_id will be executed. Otherwise only the specified + integration for the given `trigger_id` is executed. This is helpful for + execution the integration from UI. + operationId: integrations.projects.locations.integrations.execute requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaImportTemplateRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14042,7 +14631,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaImportTemplateResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse parameters: - in: path name: projectsId @@ -14055,20 +14644,23 @@ paths: schema: type: string - in: path - name: templatesId + name: integrationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}: + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:schedule: parameters: *ref_1 - patch: - description: Updates the template by given id. - operationId: integrations.projects.locations.templates.patch + post: + description: >- + Schedules an integration for execution by passing the trigger id and the + scheduled time in the request body. + operationId: integrations.projects.locations.integrations.schedule requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14080,7 +14672,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse parameters: - in: path name: projectsId @@ -14093,18 +14686,18 @@ paths: schema: type: string - in: path - name: templatesId + name: integrationsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - get: - description: Get a template in the specified project. - operationId: integrations.projects.locations.templates.get + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:executeEvent: + parameters: *ref_1 + post: + description: >- + Executes an integration on receiving events from Integration Connector + triggers, Eventarc or CPS Trigger. Input data to integration is received + in body in json format + operationId: integrations.projects.locations.integrations.executeEvent security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14116,7 +14709,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaExecuteEventResponse parameters: - in: path name: projectsId @@ -14129,13 +14723,25 @@ paths: schema: type: string - in: path - name: templatesId + name: integrationsId required: true schema: type: string - delete: - description: Deletes a template - operationId: integrations.projects.locations.templates.delete + - in: query + name: triggerId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:test: + parameters: *ref_1 + post: + description: Execute the integration in draft state + operationId: integrations.projects.locations.integrations.test + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaTestIntegrationsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14147,7 +14753,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaTestIntegrationsResponse parameters: - in: path name: projectsId @@ -14160,24 +14767,15 @@ paths: schema: type: string - in: path - name: templatesId + name: integrationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:share: + /v1/projects/{projectsId}/locations/{locationsId}/integrations: parameters: *ref_1 - post: - description: >- - Share a template with other clients. Only the template owner can share - the templates with other projects. PERMISSION_DENIED would be thrown if - the request is not from the owner. - operationId: integrations.projects.locations.templates.share - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaShareTemplateRequest + get: + description: Returns the list of all integrations in the specified project. + operationId: integrations.projects.locations.integrations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14189,7 +14787,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaListIntegrationsResponse parameters: - in: path name: projectsId @@ -14201,16 +14800,28 @@ paths: required: true schema: type: string - - in: path - name: templatesId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/templates: + - in: query + name: orderBy + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/integrations:search: parameters: *ref_1 get: - description: Lists all templates matching the filter. - operationId: integrations.projects.locations.templates.list + description: Searches and returns the list of integrations in the specified project. + operationId: integrations.projects.locations.integrations.search security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14223,7 +14834,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListTemplatesResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaSearchIntegrationsResponse parameters: - in: path name: projectsId @@ -14236,7 +14847,7 @@ paths: schema: type: string - in: query - name: orderBy + name: query schema: type: string - in: query @@ -14253,18 +14864,14 @@ paths: schema: type: string - in: query - name: readMask + name: enableNaturalLanguageQueryUnderstanding schema: - type: string - format: google-fieldmask - post: - description: Creates a new template - operationId: integrations.projects.locations.templates.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}: + parameters: *ref_1 + delete: + description: Delete the selected integration and all versions inside + operationId: integrations.projects.locations.integrations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14276,7 +14883,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -14288,13 +14895,16 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/templates:search: + - in: path + name: integrationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions: parameters: *ref_1 get: - description: >- - Search templates based on user query and filters. This api would query - the templates and return a list of templates based on the user filter. - operationId: integrations.projects.locations.templates.search + description: Returns the list of all integration versions in the specified project. + operationId: integrations.projects.locations.integrations.versions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14307,7 +14917,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSearchTemplatesResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse parameters: - in: path name: projectsId @@ -14319,17 +14929,9 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: orderBy + - in: path + name: integrationsId + required: true schema: type: string - in: query @@ -14338,66 +14940,31 @@ paths: type: integer format: int32 - in: query - name: filter + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:unshare: - parameters: *ref_1 - post: - description: >- - Unshare a template from given clients. Owner of the template can unshare - template with clients. Shared client can only unshare the template from - itself. PERMISSION_DENIED would be thrown if request is not from owner - or for unsharing itself. - operationId: integrations.projects.locations.templates.unshare - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUnshareTemplateRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' - parameters: - - in: path - name: projectsId - required: true + - in: query + name: filter schema: type: string - - in: path - name: locationsId - required: true + - in: query + name: orderBy schema: type: string - - in: path - name: templatesId - required: true + - in: query + name: fieldMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:use: - parameters: *ref_1 + format: google-fieldmask post: - description: >- - Use the template to create integration. This api would keep track of - usage_count and last_used_time. PERMISSION_DENIED would be thrown if - template is not accessible by client. - operationId: integrations.projects.locations.templates.use + description: Create a integration with a draft version in the specified project. + operationId: integrations.projects.locations.integrations.versions.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUseTemplateRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14410,7 +14977,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUseTemplateResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion parameters: - in: path name: projectsId @@ -14423,17 +14990,29 @@ paths: schema: type: string - in: path - name: templatesId + name: integrationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:download: + - in: query + name: newIntegration + schema: + type: boolean + - in: query + name: createSampleIntegrations + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}: parameters: *ref_1 - get: - description: >- - Downloads a template. Retrieves the `Template` and returns the response - as a string. - operationId: integrations.projects.locations.templates.download + patch: + description: Update a integration with a draft version in the specified project. + operationId: integrations.projects.locations.integrations.versions.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14446,7 +15025,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadTemplateResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion parameters: - in: path name: projectsId @@ -14459,29 +15038,23 @@ paths: schema: type: string - in: path - name: templatesId + name: integrationsId + required: true + schema: + type: string + - in: path + name: versionsId required: true schema: type: string - in: query - name: fileFormat + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/templates:upload: - parameters: *ref_1 - post: - description: >- - Uploads a template. The content can be a previously downloaded template. - Performs the same function as CreateTemplate, but accepts input in a - string format, which holds the complete representation of the Template - content. - operationId: integrations.projects.locations.templates.upload - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUploadTemplateRequest + format: google-fieldmask + get: + description: Get a integration in the specified project. + operationId: integrations.projects.locations.integrations.versions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14494,7 +15067,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUploadTemplateResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion parameters: - in: path name: projectsId @@ -14506,15 +15079,28 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions: - parameters: *ref_1 - get: + - in: path + name: integrationsId + required: true + schema: + type: string + - in: path + name: versionsId + required: true + schema: + type: string + delete: description: >- - * Lists suspensions associated with a specific execution. Only those - with permissions to resolve the relevant suspensions will be able to - view them. - operationId: >- - integrations.projects.locations.products.integrations.executions.suspensions.list + Soft-deletes the integration. Changes the status of the integration to + ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag + is removed from this snapshot and set to the previous non-ARCHIVED + snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. + This RPC throws an exception if the version being deleted is DRAFT, and + if the `locked_by` user is not the same as the user performing the + Delete. Audit fields updated include last_modified_timestamp, + last_modified_by. Any existing lock is released when Deleting a + integration. Currently, there is no undelete mechanism. + operationId: integrations.projects.locations.integrations.versions.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14526,8 +15112,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListSuspensionsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -14539,53 +15124,33 @@ paths: required: true schema: type: string - - in: path - name: productsId - required: true - schema: - type: string - in: path name: integrationsId required: true schema: type: string - in: path - name: executionsId + name: versionsId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:lift: + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:publish: parameters: *ref_1 post: description: >- - * Lifts suspension for the Suspension task. Fetch corresponding - suspension with provided suspension Id, resolve suspension, and set up - suspension result for the Suspension Task. - operationId: >- - integrations.projects.locations.products.integrations.executions.suspensions.lift + This RPC throws an exception if the integration is in ARCHIVED or ACTIVE + state. This RPC throws an exception if the version being published is + DRAFT, and if the `locked_by` user is not the same as the user + performing the Publish. Audit fields updated include + last_published_timestamp, last_published_by, last_modified_timestamp, + last_modified_by. Any existing lock is on this integration is released. + operationId: integrations.projects.locations.integrations.versions.publish requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaLiftSuspensionRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14598,7 +15163,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaLiftSuspensionResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse parameters: - in: path name: projectsId @@ -14610,41 +15175,32 @@ paths: required: true schema: type: string - - in: path - name: productsId - required: true - schema: - type: string - in: path name: integrationsId required: true schema: type: string - in: path - name: executionsId - required: true - schema: - type: string - - in: path - name: suspensionsId + name: versionsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:resolve: + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions:upload: parameters: *ref_1 post: description: >- - * Resolves (lifts/rejects) any number of suspensions. If the integration - is already running, only the status of the suspension is updated. - Otherwise, the suspended integration will begin execution again. - operationId: >- - integrations.projects.locations.products.integrations.executions.suspensions.resolve + Uploads an integration. The content can be a previously downloaded + integration. Performs the same function as + CreateDraftIntegrationVersion, but accepts input in a string format, + which holds the complete representation of the IntegrationVersion + content. + operationId: integrations.projects.locations.integrations.versions.upload requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaResolveSuspensionRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14657,7 +15213,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaResolveSuspensionResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse parameters: - in: path name: projectsId @@ -14669,35 +15225,18 @@ paths: required: true schema: type: string - - in: path - name: productsId - required: true - schema: - type: string - in: path name: integrationsId required: true schema: type: string - - in: path - name: executionsId - required: true - schema: - type: string - - in: path - name: suspensionsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions: + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:download: parameters: *ref_1 get: description: >- - Lists the results of all the integration executions. The response - includes the same information as the [execution - log](https://cloud.google.com/application-integration/docs/viewing-logs) - in the Integration UI. - operationId: integrations.projects.locations.products.integrations.executions.list + Downloads an integration. Retrieves the `IntegrationVersion` for a given + `integration_id` and returns the response as a string. + operationId: integrations.projects.locations.integrations.versions.download security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14710,7 +15249,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListExecutionsResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse parameters: - in: path name: projectsId @@ -14721,107 +15260,35 @@ paths: name: locationsId required: true schema: - type: string - - in: path - name: productsId - required: true - schema: - type: string - - in: path - name: integrationsId - required: true - schema: - type: string - - in: query - name: truncateParams - schema: - type: boolean - - in: query - name: refreshAcl - schema: - type: boolean - - in: query - name: filterParams.endTime - schema: - type: string - format: int64 - - in: query - name: filterParams.customFilter - schema: - type: string - - in: query - name: filterParams.parameterKey - schema: - type: string - - in: query - name: filterParams.startTime - schema: - type: string - format: int64 - - in: query - name: filterParams.parameterType - schema: - type: string - - in: query - name: filterParams.parameterPairKey - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: filterParams.taskStatuses - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filterParams.parameterPairValue - schema: - type: string - - in: query - name: filterParams.executionId - schema: - type: string - - in: query - name: filterParams.workflowName - schema: - type: string - - in: query - name: snapshotMetadataWithoutParams - schema: - type: boolean - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken + type: string + - in: path + name: integrationsId + required: true schema: type: string - - in: query - name: readMask + - in: path + name: versionsId + required: true schema: type: string - format: google-fieldmask - in: query - name: filterParams.parameterValue + name: fileFormat schema: type: string - in: query - name: filterParams.eventStatuses + name: files schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}:download: + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:downloadJsonPackage: parameters: *ref_1 get: - description: Download the execution. + description: >- + Downloads an Integration version package like + IntegrationVersion,Integration Config etc. Retrieves the + IntegrationVersion package for a given `integration_id` and returns the + response as a JSON. operationId: >- - integrations.projects.locations.products.integrations.executions.download + integrations.projects.locations.integrations.versions.downloadJsonPackage security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14834,7 +15301,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadExecutionResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadJsonPackageResponse parameters: - in: path name: projectsId @@ -14847,25 +15314,35 @@ paths: schema: type: string - in: path - name: productsId + name: integrationsId required: true schema: type: string - in: path - name: integrationsId + name: versionsId required: true schema: type: string - - in: path - name: executionsId - required: true + - in: query + name: files schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}: + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:unpublish: parameters: *ref_1 - get: - description: Get an execution in the specified project. - operationId: integrations.projects.locations.products.integrations.executions.get + post: + description: >- + Sets the status of the ACTIVE integration to SNAPSHOT with a new tag + "PREVIOUSLY_PUBLISHED" after validating it. The "HEAD" and + "PUBLISH_REQUESTED" tags do not change. This RPC throws an exception if + the version being snapshot is not ACTIVE. Audit fields added include + action, action_by, action_timestamp. + operationId: integrations.projects.locations.integrations.versions.unpublish + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14877,7 +15354,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaExecution' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -14889,32 +15366,26 @@ paths: required: true schema: type: string - - in: path - name: productsId - required: true - schema: - type: string - in: path name: integrationsId required: true schema: type: string - in: path - name: executionsId + name: versionsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions: + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases: parameters: *ref_1 post: - description: Create a integration with a draft version in the specified project. - operationId: integrations.projects.locations.products.integrations.versions.create + description: Creates a new test case + operationId: integrations.projects.locations.integrations.versions.testCases.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTestCase' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14926,8 +15397,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTestCase' parameters: - in: path name: projectsId @@ -14940,26 +15410,22 @@ paths: schema: type: string - in: path - name: productsId + name: integrationsId required: true schema: type: string - in: path - name: integrationsId + name: versionsId required: true schema: type: string - in: query - name: createSampleIntegrations - schema: - type: boolean - - in: query - name: newIntegration + name: testCaseId schema: - type: boolean + type: string get: - description: Returns the list of all integration versions in the specified project. - operationId: integrations.projects.locations.products.integrations.versions.list + description: Lists all the test cases that satisfy the filters. + operationId: integrations.projects.locations.integrations.versions.testCases.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14972,7 +15438,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListTestCasesResponse parameters: - in: path name: projectsId @@ -14985,12 +15451,12 @@ paths: schema: type: string - in: path - name: productsId + name: integrationsId required: true schema: type: string - in: path - name: integrationsId + name: versionsId required: true schema: type: string @@ -15012,17 +15478,15 @@ paths: schema: type: string - in: query - name: fieldMask + name: readMask schema: type: string format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:download: + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases/{testCasesId}: parameters: *ref_1 get: - description: >- - Downloads an integration. Retrieves the `IntegrationVersion` for a given - `integration_id` and returns the response as a string. - operationId: integrations.projects.locations.products.integrations.versions.download + description: Get a test case + operationId: integrations.projects.locations.integrations.versions.testCases.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15034,8 +15498,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTestCase' parameters: - in: path name: projectsId @@ -15048,7 +15511,48 @@ paths: schema: type: string - in: path - name: productsId + name: integrationsId + required: true + schema: + type: string + - in: path + name: versionsId + required: true + schema: + type: string + - in: path + name: testCasesId + required: true + schema: + type: string + patch: + description: Updates a test case + operationId: integrations.projects.locations.integrations.versions.testCases.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTestCase' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTestCase' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId required: true schema: type: string @@ -15062,28 +15566,19 @@ paths: required: true schema: type: string - - in: query - name: files + - in: path + name: testCasesId + required: true schema: type: string - in: query - name: fileFormat + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}: - parameters: *ref_1 + format: google-fieldmask delete: - description: >- - Soft-deletes the integration. Changes the status of the integration to - ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag - is removed from this snapshot and set to the previous non-ARCHIVED - snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. - This RPC throws an exception if the version being deleted is DRAFT, and - if the `locked_by` user is not the same as the user performing the - Delete. Audit fields updated include last_modified_timestamp, - last_modified_by. Any existing lock is released when Deleting a - integration. Currently, there is no undelete mechanism. - operationId: integrations.projects.locations.products.integrations.versions.delete + description: Deletes a test case + operationId: integrations.projects.locations.integrations.versions.testCases.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15108,29 +15603,32 @@ paths: schema: type: string - in: path - name: productsId + name: integrationsId required: true schema: type: string - in: path - name: integrationsId + name: versionsId required: true schema: type: string - in: path - name: versionsId + name: testCasesId required: true schema: type: string - patch: - description: Update a integration with a draft version in the specified project. - operationId: integrations.projects.locations.products.integrations.versions.patch + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases/{testCasesId}:executeTest: + parameters: *ref_1 + post: + description: Executes functional test + operationId: >- + integrations.projects.locations.integrations.versions.testCases.executeTest requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + #/components/schemas/GoogleCloudIntegrationsV1alphaExecuteTestCaseRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15143,7 +15641,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + #/components/schemas/GoogleCloudIntegrationsV1alphaExecuteTestCaseResponse parameters: - in: path name: projectsId @@ -15156,28 +15654,76 @@ paths: schema: type: string - in: path - name: productsId + name: integrationsId required: true schema: type: string - in: path - name: integrationsId + name: versionsId required: true schema: type: string - in: path - name: versionsId + name: testCasesId required: true schema: type: string - - in: query - name: updateMask + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases:upload: + parameters: *ref_1 + post: + description: >- + Uploads a test case. The content can be a previously downloaded test + case. Performs the same function as CreateTestCase, but accepts input in + a string format, which holds the complete representation of the TestCase + content. + operationId: integrations.projects.locations.integrations.versions.testCases.upload + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaUploadTestCaseRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaUploadTestCaseResponse + parameters: + - in: path + name: projectsId + required: true schema: type: string - format: google-fieldmask - get: - description: Get a integration in the specified project. - operationId: integrations.projects.locations.products.integrations.versions.get + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: integrationsId + required: true + schema: + type: string + - in: path + name: versionsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases/{testCasesId}:download: + parameters: *ref_1 + get: + description: >- + Downloads a test case. Retrieves the `TestCase` for a given + `test_case_id` and returns the response as a string. + operationId: integrations.projects.locations.integrations.versions.testCases.download security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15190,7 +15736,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadTestCaseResponse parameters: - in: path name: projectsId @@ -15203,37 +15749,36 @@ paths: schema: type: string - in: path - name: productsId + name: integrationsId required: true schema: type: string - in: path - name: integrationsId + name: versionsId required: true schema: type: string - in: path - name: versionsId + name: testCasesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:publish: + - in: query + name: fileFormat + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases/{testCasesId}:takeoverEditLock: parameters: *ref_1 post: - description: >- - This RPC throws an exception if the integration is in ARCHIVED or ACTIVE - state. This RPC throws an exception if the version being published is - DRAFT, and if the `locked_by` user is not the same as the user - performing the Publish. Audit fields updated include - last_published_timestamp, last_published_by, last_modified_timestamp, - last_modified_by. Any existing lock is on this integration is released. - operationId: integrations.projects.locations.products.integrations.versions.publish + description: Clear the lock fields and assign them to current user + operationId: >- + integrations.projects.locations.integrations.versions.testCases.takeoverEditLock requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaTakeoverTestCaseEditLockRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15245,8 +15790,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTestCase' parameters: - in: path name: projectsId @@ -15259,36 +15803,31 @@ paths: schema: type: string - in: path - name: productsId + name: integrationsId required: true schema: type: string - in: path - name: integrationsId + name: versionsId required: true schema: type: string - in: path - name: versionsId + name: testCasesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions:upload: + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases:execute: parameters: *ref_1 post: - description: >- - Uploads an integration. The content can be a previously downloaded - integration. Performs the same function as - CreateDraftIntegrationVersion, but accepts input in a string format, - which holds the complete representation of the IntegrationVersion - content. - operationId: integrations.projects.locations.products.integrations.versions.upload + description: Executes all test cases in an integration version. + operationId: integrations.projects.locations.integrations.versions.testCases.execute requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaExecuteTestCasesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15301,7 +15840,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaExecuteTestCasesResponse parameters: - in: path name: projectsId @@ -15314,31 +15853,24 @@ paths: schema: type: string - in: path - name: productsId + name: integrationsId required: true schema: type: string - in: path - name: integrationsId + name: versionsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:unpublish: + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions: parameters: *ref_1 - post: + get: description: >- - Sets the status of the ACTIVE integration to SNAPSHOT with a new tag - "PREVIOUSLY_PUBLISHED" after validating it. The "HEAD" and - "PUBLISH_REQUESTED" tags do not change. This RPC throws an exception if - the version being snapshot is not ACTIVE. Audit fields added include - action, action_by, action_timestamp. - operationId: integrations.projects.locations.products.integrations.versions.unpublish - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest + Lists the results of all the integration executions. The response + includes the same information as the [execution + log](https://cloud.google.com/application-integration/docs/viewing-logs) + in the Integration UI. + operationId: integrations.projects.locations.integrations.executions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15350,7 +15882,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaListExecutionsResponse parameters: - in: path name: projectsId @@ -15363,44 +15896,99 @@ paths: schema: type: string - in: path - name: productsId + name: integrationsId required: true schema: type: string - - in: path - name: integrationsId - required: true + - in: query + name: filter schema: type: string - - in: path - name: versionsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:takeoverEditLock: + - in: query + name: orderBy + schema: + type: string + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: filterParams.workflowName + schema: + type: string + - in: query + name: filterParams.startTime + schema: + type: string + format: int64 + - in: query + name: filterParams.endTime + schema: + type: string + format: int64 + - in: query + name: filterParams.eventStatuses + schema: + type: string + - in: query + name: filterParams.taskStatuses + schema: + type: string + - in: query + name: filterParams.customFilter + schema: + type: string + - in: query + name: filterParams.executionId + schema: + type: string + - in: query + name: filterParams.parameterValue + schema: + type: string + - in: query + name: filterParams.parameterType + schema: + type: string + - in: query + name: filterParams.parameterKey + schema: + type: string + - in: query + name: filterParams.parameterPairKey + schema: + type: string + - in: query + name: filterParams.parameterPairValue + schema: + type: string + - in: query + name: refreshAcl + schema: + type: boolean + - in: query + name: truncateParams + schema: + type: boolean + - in: query + name: snapshotMetadataWithoutParams + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}: parameters: *ref_1 - post: - description: >- - Clears the `locked_by` and `locked_at_timestamp`in the DRAFT version of - this integration. It then performs the same action as the - CreateDraftIntegrationVersion (i.e., copies the DRAFT version of the - integration as a SNAPSHOT and then creates a new DRAFT version with the - `locked_by` set to the `user_taking_over` and the `locked_at_timestamp` - set to the current timestamp). Both the `locked_by` and - `user_taking_over` are notified via email about the takeover. This RPC - throws an exception if the integration is not in DRAFT status or if the - `locked_by` and `locked_at_timestamp` fields are not set.The - TakeoverEdit lock is treated the same as an edit of the integration, and - hence shares ACLs with edit. Audit fields updated include - last_modified_timestamp, last_modified_by. - operationId: >- - integrations.projects.locations.products.integrations.versions.takeoverEditLock - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaTakeoverEditLockRequest + get: + description: Get an execution in the specified project. + operationId: integrations.projects.locations.integrations.executions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15412,8 +16000,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaTakeoverEditLockResponse + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaExecution' parameters: - in: path name: projectsId @@ -15425,39 +16012,30 @@ paths: required: true schema: type: string - - in: path - name: productsId - required: true - schema: - type: string - in: path name: integrationsId required: true schema: type: string - in: path - name: versionsId + name: executionsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:execute: + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}:cancel: parameters: *ref_1 post: description: >- - Executes integrations synchronously by passing the trigger id in the - request body. The request is not returned until the requested executions - are either fulfilled or experienced an error. If the integration name is - not specified (passing `-`), all of the associated integration under the - given trigger_id will be executed. Otherwise only the specified - integration for the given `trigger_id` is executed. This is helpful for - execution the integration from UI. - operationId: integrations.projects.locations.products.integrations.execute + Cancellation of an execution and associated sub-executions. This will + not cancel an IN_PROCESS or completed(SUCCESSFUL, FAILED or CANCELLED) + executions. + operationId: integrations.projects.locations.integrations.executions.cancel requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaCancelExecutionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15470,7 +16048,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaCancelExecutionResponse parameters: - in: path name: projectsId @@ -15483,20 +16061,20 @@ paths: schema: type: string - in: path - name: productsId + name: integrationsId required: true schema: type: string - in: path - name: integrationsId + name: executionsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations: + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}:download: parameters: *ref_1 get: - description: Returns the list of all integrations in the specified project. - operationId: integrations.projects.locations.products.integrations.list + description: Download the execution. + operationId: integrations.projects.locations.integrations.executions.download security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15509,7 +16087,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListIntegrationsResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadExecutionResponse parameters: - in: path name: projectsId @@ -15522,38 +16100,28 @@ paths: schema: type: string - in: path - name: productsId + name: integrationsId required: true schema: type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + - in: path + name: executionsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:test: + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}:replay: parameters: *ref_1 post: - description: Execute the integration in draft state - operationId: integrations.projects.locations.products.integrations.test + description: >- + Re-execute an existing execution, with same request parameters and + execution strategy. + operationId: integrations.projects.locations.integrations.executions.replay requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaTestIntegrationsRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaReplayExecutionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15566,7 +16134,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaTestIntegrationsResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaReplayExecutionResponse parameters: - in: path name: projectsId @@ -15579,28 +16147,30 @@ paths: schema: type: string - in: path - name: productsId + name: integrationsId required: true schema: type: string - in: path - name: integrationsId + name: executionsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:schedule: + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:resolve: parameters: *ref_1 post: description: >- - Schedules an integration for execution by passing the trigger id and the - scheduled time in the request body. - operationId: integrations.projects.locations.products.integrations.schedule + * Resolves (lifts/rejects) any number of suspensions. If the integration + is already running, only the status of the suspension is updated. + Otherwise, the suspended integration will begin execution again. + operationId: >- + integrations.projects.locations.integrations.executions.suspensions.resolve requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaResolveSuspensionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15613,7 +16183,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaResolveSuspensionResponse parameters: - in: path name: projectsId @@ -15626,26 +16196,28 @@ paths: schema: type: string - in: path - name: productsId + name: integrationsId required: true schema: type: string - in: path - name: integrationsId + name: executionsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/cloudFunctions: + - in: path + name: suspensionsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions: parameters: *ref_1 - post: - description: Creates a cloud function project. - operationId: integrations.projects.locations.products.cloudFunctions.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaCreateCloudFunctionRequest + get: + description: >- + * Lists suspensions associated with a specific execution. Only those + with permissions to resolve the relevant suspensions will be able to + view them. + operationId: integrations.projects.locations.integrations.executions.suspensions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15658,7 +16230,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaCreateCloudFunctionResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListSuspensionsResponse parameters: - in: path name: projectsId @@ -15671,15 +16243,46 @@ paths: schema: type: string - in: path - name: productsId + name: integrationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs/{authConfigsId}: + - in: path + name: executionsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:lift: parameters: *ref_1 - delete: - description: Deletes an auth config. - operationId: integrations.projects.locations.products.authConfigs.delete + post: + description: >- + * Lifts suspension for the Suspension task. Fetch corresponding + suspension with provided suspension Id, resolve suspension, and set up + suspension result for the Suspension Task. + operationId: integrations.projects.locations.integrations.executions.suspensions.lift + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaLiftSuspensionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15691,7 +16294,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaLiftSuspensionResponse parameters: - in: path name: projectsId @@ -15704,28 +16308,32 @@ paths: schema: type: string - in: path - name: productsId + name: integrationsId required: true schema: type: string - in: path - name: authConfigsId + name: executionsId required: true schema: type: string - patch: + - in: path + name: suspensionsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances: + parameters: *ref_1 + post: description: >- - Updates an auth config. If credential is updated, fetch the encrypted - auth config from Spanner, decrypt with Cloud KMS key, update the - credential fields, re-encrypt with Cloud KMS key and update the Spanner - record. For other fields, directly update the Spanner record. Returns - the encrypted auth config. - operationId: integrations.projects.locations.products.authConfigs.patch + Creates an sfdc instance record. Store the sfdc instance in Spanner. + Returns the sfdc instance. + operationId: integrations.projects.locations.sfdcInstances.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15737,7 +16345,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance parameters: - in: path name: projectsId @@ -15749,39 +16358,65 @@ paths: required: true schema: type: string + get: + description: >- + Lists all sfdc instances that match the filter. Restrict to sfdc + instances belonging to the current client only. + operationId: integrations.projects.locations.sfdcInstances.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse + parameters: - in: path - name: productsId + name: projectsId required: true schema: type: string - in: path - name: authConfigsId + name: locationsId required: true schema: type: string - in: query - name: clientCertificate.sslCertificate + name: pageSize schema: - type: string + type: integer + format: int32 - in: query - name: clientCertificate.passphrase + name: pageToken schema: type: string - in: query - name: updateMask + name: filter schema: type: string - format: google-fieldmask - in: query - name: clientCertificate.encryptedPrivateKey + name: readMask schema: type: string - get: + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}: + parameters: *ref_1 + patch: description: >- - Gets a complete auth config. If the auth config doesn't exist, - Code.NOT_FOUND exception will be thrown. Returns the decrypted auth - config. - operationId: integrations.projects.locations.products.authConfigs.get + Updates an sfdc instance. Updates the sfdc instance in spanner. Returns + the sfdc instance. + operationId: integrations.projects.locations.sfdcInstances.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15793,7 +16428,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance parameters: - in: path name: projectsId @@ -15806,22 +16442,18 @@ paths: schema: type: string - in: path - name: productsId + name: sfdcInstancesId required: true schema: type: string - - in: path - name: authConfigsId - required: true + - in: query + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs: - parameters: *ref_1 - get: - description: >- - Lists all auth configs that match the filter. Restrict to auth configs - belong to the current client only. - operationId: integrations.projects.locations.products.authConfigs.list + format: google-fieldmask + delete: + description: Deletes an sfdc instance. + operationId: integrations.projects.locations.sfdcInstances.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15833,8 +16465,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListAuthConfigsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -15847,40 +16478,15 @@ paths: schema: type: string - in: path - name: productsId + name: sfdcInstancesId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - post: + get: description: >- - Creates an auth config record. Fetch corresponding credentials for - specific auth types, e.g. access token for OAuth 2.0, JWT token for JWT. - Encrypt the auth config with Cloud KMS and store the encrypted - credentials in Spanner. Returns the encrypted auth config. - operationId: integrations.projects.locations.products.authConfigs.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND + exception will be thrown. + operationId: integrations.projects.locations.sfdcInstances.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15892,7 +16498,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance parameters: - in: path name: projectsId @@ -15904,28 +16511,23 @@ paths: required: true schema: type: string - - in: path - name: productsId - required: true - schema: - type: string - - in: query - name: clientCertificate.passphrase - schema: - type: string - - in: query - name: clientCertificate.encryptedPrivateKey - schema: - type: string - - in: query - name: clientCertificate.sslCertificate + - in: path + name: sfdcInstancesId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates/{certificatesId}: + /v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels: parameters: *ref_1 - delete: - description: Delete a certificate - operationId: integrations.projects.locations.products.certificates.delete + post: + description: >- + Creates an sfdc channel record. Store the sfdc channel in Spanner. + Returns the sfdc channel. + operationId: integrations.projects.locations.sfdcInstances.sfdcChannels.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15937,7 +16539,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' parameters: - in: path name: projectsId @@ -15950,18 +16552,15 @@ paths: schema: type: string - in: path - name: productsId - required: true - schema: - type: string - - in: path - name: certificatesId + name: sfdcInstancesId required: true schema: type: string get: - description: Get a certificates in the specified project. - operationId: integrations.projects.locations.products.certificates.get + description: >- + Lists all sfdc channels that match the filter. Restrict to sfdc channels + belonging to the current client only. + operationId: integrations.projects.locations.sfdcInstances.sfdcChannels.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15973,7 +16572,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse parameters: - in: path name: projectsId @@ -15986,27 +16586,40 @@ paths: schema: type: string - in: path - name: productsId + name: sfdcInstancesId required: true schema: type: string - - in: path - name: certificatesId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string + - in: query + name: filter + schema: + type: string + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}: + parameters: *ref_1 patch: description: >- - Updates the certificate by id. If new certificate file is updated, it - will register with the trawler service, re-encrypt with cloud KMS and - update the Spanner record. Other fields will directly update the Spanner - record. Returns the Certificate. - operationId: integrations.projects.locations.products.certificates.patch + Updates an sfdc channel. Updates the sfdc channel in spanner. Returns + the sfdc channel. + operationId: integrations.projects.locations.sfdcInstances.sfdcChannels.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16018,7 +16631,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' parameters: - in: path name: projectsId @@ -16031,12 +16644,12 @@ paths: schema: type: string - in: path - name: productsId + name: sfdcInstancesId required: true schema: type: string - in: path - name: certificatesId + name: sfdcChannelsId required: true schema: type: string @@ -16045,13 +16658,9 @@ paths: schema: type: string format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates: - parameters: *ref_1 - get: - description: >- - List all the certificates that match the filter. Restrict to certificate - of current client only. - operationId: integrations.projects.locations.products.certificates.list + delete: + description: Deletes an sfdc channel. + operationId: integrations.projects.locations.sfdcInstances.sfdcChannels.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16063,8 +16672,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListCertificatesResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -16077,39 +16685,20 @@ paths: schema: type: string - in: path - name: productsId + name: sfdcInstancesId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: filter + - in: path + name: sfdcChannelsId + required: true schema: type: string - post: + get: description: >- - Creates a new certificate. The certificate will be registered to the - trawler service and will be encrypted using cloud KMS and stored in - Spanner Returns the certificate. - operationId: integrations.projects.locations.products.certificates.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND + exception will be thrown. + operationId: integrations.projects.locations.sfdcInstances.sfdcChannels.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16121,7 +16710,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' parameters: - in: path name: projectsId @@ -16134,17 +16723,20 @@ paths: schema: type: string - in: path - name: productsId + name: sfdcInstancesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances: + - in: path + name: sfdcChannelsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/templates: parameters: *ref_1 get: - description: >- - Lists all sfdc instances that match the filter. Restrict to sfdc - instances belonging to the current client only. - operationId: integrations.projects.locations.products.sfdcInstances.list + description: Lists all templates matching the filter. + operationId: integrations.projects.locations.templates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16157,7 +16749,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListTemplatesResponse parameters: - in: path name: projectsId @@ -16169,11 +16761,6 @@ paths: required: true schema: type: string - - in: path - name: productsId - required: true - schema: - type: string - in: query name: pageSize schema: @@ -16187,21 +16774,23 @@ paths: name: filter schema: type: string + - in: query + name: orderBy + schema: + type: string - in: query name: readMask schema: type: string format: google-fieldmask post: - description: >- - Creates an sfdc instance record. Store the sfdc instance in Spanner. - Returns the sfdc instance. - operationId: integrations.projects.locations.products.sfdcInstances.create + description: Creates a new template + operationId: integrations.projects.locations.templates.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16213,8 +16802,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' parameters: - in: path name: projectsId @@ -16226,55 +16814,11 @@ paths: required: true schema: type: string - - in: path - name: productsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}: + /v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}: parameters: *ref_1 get: - description: >- - Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND - exception will be thrown. - operationId: integrations.projects.locations.products.sfdcInstances.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: productsId - required: true - schema: - type: string - - in: path - name: sfdcInstancesId - required: true - schema: - type: string - delete: - description: Deletes an sfdc instance. - operationId: integrations.projects.locations.products.sfdcInstances.delete + description: Get a template in the specified project. + operationId: integrations.projects.locations.templates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16286,7 +16830,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' parameters: - in: path name: projectsId @@ -16299,25 +16843,18 @@ paths: schema: type: string - in: path - name: productsId - required: true - schema: - type: string - - in: path - name: sfdcInstancesId + name: templatesId required: true schema: type: string patch: - description: >- - Updates an sfdc instance. Updates the sfdc instance in spanner. Returns - the sfdc instance. - operationId: integrations.projects.locations.products.sfdcInstances.patch + description: Updates the template by given id. + operationId: integrations.projects.locations.templates.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16329,8 +16866,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' parameters: - in: path name: projectsId @@ -16343,33 +16879,18 @@ paths: schema: type: string - in: path - name: productsId - required: true - schema: - type: string - - in: path - name: sfdcInstancesId + name: templatesId required: true schema: type: string - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels: - parameters: *ref_1 - post: - description: >- - Creates an sfdc channel record. Store the sfdc channel in Spanner. - Returns the sfdc channel. - operationId: >- - integrations.projects.locations.products.sfdcInstances.sfdcChannels.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a template + operationId: integrations.projects.locations.templates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16381,7 +16902,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -16394,20 +16915,17 @@ paths: schema: type: string - in: path - name: productsId - required: true - schema: - type: string - - in: path - name: sfdcInstancesId + name: templatesId required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/templates:search: + parameters: *ref_1 get: description: >- - Lists all sfdc channels that match the filter. Restrict to sfdc channels - belonging to the current client only. - operationId: integrations.projects.locations.products.sfdcInstances.sfdcChannels.list + Search templates based on user query and filters. This api would query + the templates and return a list of templates based on the user filter. + operationId: integrations.projects.locations.templates.search security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16420,7 +16938,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaSearchTemplatesResponse parameters: - in: path name: projectsId @@ -16432,47 +16950,50 @@ paths: required: true schema: type: string - - in: path - name: productsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - - in: path - name: sfdcInstancesId - required: true + - in: query + name: filter schema: type: string - in: query - name: readMask + name: orderBy schema: type: string - format: google-fieldmask - in: query - name: pageToken + name: readMask schema: type: string + format: google-fieldmask - in: query - name: filter + name: query schema: type: string - in: query - name: pageSize + name: enableNaturalLanguageQueryUnderstanding schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:use: parameters: *ref_1 - patch: + post: description: >- - Updates an sfdc channel. Updates the sfdc channel in spanner. Returns - the sfdc channel. - operationId: >- - integrations.projects.locations.products.sfdcInstances.sfdcChannels.patch + Use the template to create integration. This api would keep track of + usage_count and last_used_time. PERMISSION_DENIED would be thrown if + template is not accessible by client. + operationId: integrations.projects.locations.templates.use requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaUseTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16484,7 +17005,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaUseTemplateResponse parameters: - in: path name: projectsId @@ -16497,29 +17019,67 @@ paths: schema: type: string - in: path - name: productsId + name: templatesId required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:import: + parameters: *ref_1 + post: + description: >- + Import the template to an existing integration. This api would keep + track of usage_count and last_used_time. PERMISSION_DENIED would be + thrown if template is not accessible by client. + operationId: integrations.projects.locations.templates.import + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaImportTemplateRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaImportTemplateResponse + parameters: - in: path - name: sfdcInstancesId + name: projectsId required: true schema: type: string - in: path - name: sfdcChannelsId + name: locationsId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: templatesId + required: true schema: type: string - format: google-fieldmask - delete: - description: Deletes an sfdc channel. - operationId: >- - integrations.projects.locations.products.sfdcInstances.sfdcChannels.delete + /v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:share: + parameters: *ref_1 + post: + description: >- + Share a template with other clients. Only the template owner can share + the templates with other projects. PERMISSION_DENIED would be thrown if + the request is not from the owner. + operationId: integrations.projects.locations.templates.share + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaShareTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16544,25 +17104,25 @@ paths: schema: type: string - in: path - name: productsId - required: true - schema: - type: string - - in: path - name: sfdcInstancesId - required: true - schema: - type: string - - in: path - name: sfdcChannelsId + name: templatesId required: true schema: type: string - get: + /v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:unshare: + parameters: *ref_1 + post: description: >- - Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND - exception will be thrown. - operationId: integrations.projects.locations.products.sfdcInstances.sfdcChannels.get + Unshare a template from given clients. Owner of the template can unshare + template with clients. Shared client can only unshare the template from + itself. PERMISSION_DENIED would be thrown if request is not from owner + or for unsharing itself. + operationId: integrations.projects.locations.templates.unshare + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaUnshareTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16574,7 +17134,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -16587,27 +17147,56 @@ paths: schema: type: string - in: path - name: productsId + name: templatesId required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/templates:upload: + parameters: *ref_1 + post: + description: >- + Uploads a template. The content can be a previously downloaded template. + Performs the same function as CreateTemplate, but accepts input in a + string format, which holds the complete representation of the Template + content. + operationId: integrations.projects.locations.templates.upload + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaUploadTemplateRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaUploadTemplateResponse + parameters: - in: path - name: sfdcInstancesId + name: projectsId required: true schema: type: string - in: path - name: sfdcChannelsId + name: locationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/clients: + /v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:download: parameters: *ref_1 get: description: >- - Gets the client configuration for the given project and location - resource name - operationId: integrations.projects.locations.getClients + Downloads a template. Retrieves the `Template` and returns the response + as a string. + operationId: integrations.projects.locations.templates.download security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16620,7 +17209,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaGetClientResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadTemplateResponse parameters: - in: path name: projectsId @@ -16632,11 +17221,20 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/clientmetadata: + - in: path + name: templatesId + required: true + schema: + type: string + - in: query + name: fileFormat + schema: + type: string + /v1/connectorPlatformRegions:enumerate: parameters: *ref_1 get: - description: Gets the metadata info for the requested client - operationId: integrations.projects.getClientmetadata + description: Enumerates the regions for which Connector Platform is provisioned. + operationId: integrations.connectorPlatformRegions.enumerate security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16649,13 +17247,8 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaGetClientMetadataResponse - parameters: - - in: path - name: projectsId - required: true - schema: - type: string + #/components/schemas/GoogleCloudIntegrationsV1alphaEnumerateConnectorPlatformRegionsResponse + parameters: [] /v1/callback:generateToken: parameters: *ref_1 get: @@ -16679,15 +17272,15 @@ paths: #/components/schemas/GoogleCloudIntegrationsV1alphaGenerateTokenResponse parameters: - in: query - name: code + name: state schema: type: string - in: query - name: state + name: code schema: type: string - in: query - name: product + name: gcpProjectId schema: type: string - in: query @@ -16695,25 +17288,6 @@ paths: schema: type: string - in: query - name: gcpProjectId + name: product schema: type: string - /v1/connectorPlatformRegions:enumerate: - parameters: *ref_1 - get: - description: Enumerates the regions for which Connector Platform is provisioned. - operationId: integrations.connectorPlatformRegions.enumerate - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaEnumerateConnectorPlatformRegionsResponse - parameters: [] diff --git a/providers/src/googleapis.com/v00.00.00000/services/jobs.yaml b/providers/src/googleapis.com/v00.00.00000/services/jobs.yaml index e811b595..962c212e 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/jobs.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/jobs.yaml @@ -9,8 +9,8 @@ info: Cloud Talent Solution provides the capability to create, read, update, and delete job postings, as well as search jobs based on keywords and filters. version: v4 - x-discovery-doc-revision: '20241011' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250326' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/talent-solution/job-search/docs/ servers: @@ -296,17 +296,17 @@ components: PostalAddress: id: PostalAddress description: >- - Represents a postal address, e.g. for postal delivery or payments - addresses. Given a postal address, a postal service can deliver items to - a premise, P.O. Box or similar. It is not intended to model geographical - locations (roads, towns, mountains). In typical usage an address would - be created via user input or from importing existing data, depending on - the type of process. Advice on address input / editing: - Use an - internationalization-ready address widget such as - https://github.com/google/libaddressinput) - Users should not be + Represents a postal address (for example, for postal delivery or + payments addresses). Given a postal address, a postal service can + deliver items to a premise, P.O. box or similar. It is not intended to + model geographical locations (roads, towns, mountains). In typical + usage, an address would be created by user input or from importing + existing data, depending on the type of process. Advice on address input + or editing: - Use an internationalization-ready address widget such as + https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this - schema, please see: https://support.google.com/business/answer/6397478 + schema, see: https://support.google.com/business/answer/6397478. type: object properties: revision: @@ -341,57 +341,58 @@ components: Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address - (e.g. state/zip validation in the U.S.A.). + (for example, state or zip code validation in the United States). type: string sortingCode: description: >- Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string - like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or - just a number alone, representing the "sector code" (Jamaica), - "delivery area indicator" (Malawi) or "post office indicator" (e.g. - Côte d'Ivoire). + like "CEDEX", optionally followed by a number (for example, "CEDEX + 7"), or just a number alone, representing the "sector code" + (Jamaica), "delivery area indicator" (Malawi) or "post office + indicator" (Côte d'Ivoire). type: string administrativeArea: description: >- Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a - state, a province, an oblast, or a prefecture. Specifically, for - Spain this is the province and not the autonomous community (e.g. + state, a province, an oblast, or a prefecture. For Spain, this is + the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an - administrative area in postal addresses. E.g. in Switzerland this - should be left unpopulated. + administrative area in postal addresses. For example, in + Switzerland, this should be left unpopulated. type: string locality: description: >- - Optional. Generally refers to the city/town portion of the address. - Examples: US city, IT comune, UK post town. In regions of the world - where localities are not well defined or do not fit into this - structure well, leave locality empty and use address_lines. + Optional. Generally refers to the city or town portion of the + address. Examples: US city, IT comune, UK post town. In regions of + the world where localities are not well defined or do not fit into + this structure well, leave `locality` empty and use `address_lines`. type: string sublocality: description: >- - Optional. Sublocality of the address. For example, this can be - neighborhoods, boroughs, districts. + Optional. Sublocality of the address. For example, this can be a + neighborhood, borough, or district. type: string addressLines: description: >- Unstructured address lines describing the lower levels of an - address. Because values in address_lines do not have type + address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single - field (e.g. "Austin, TX"), it is important that the line order is - clear. The order of address lines should be "envelope order" for the - country/region of the address. In places where this can vary (e.g. - Japan), address_language is used to make it explicit (e.g. "ja" for - large-to-small ordering and "ja-Latn" or "en" for small-to-large). - This way, the most specific line of an address can be selected based - on the language. The minimum permitted structural representation of - an address consists of a region_code with all remaining information - placed in the address_lines. It would be possible to format such an - address very approximately without geocoding, but no semantic - reasoning could be made about any of the address components until it - was at least partially resolved. Creating an address only containing - a region_code and address_lines, and then geocoding is the + field (for example, "Austin, TX"), it is important that the line + order is clear. The order of address lines should be "envelope + order" for the country or region of the address. In places where + this can vary (for example, Japan), `address_language` is used to + make it explicit (for example, "ja" for large-to-small ordering and + "ja-Latn" or "en" for small-to-large). In this way, the most + specific line of an address can be selected based on the language. + The minimum permitted structural representation of an address + consists of a `region_code` with all remaining information placed in + the `address_lines`. It would be possible to format such an address + very approximately without geocoding, but no semantic reasoning + could be made about any of the address components until it was at + least partially resolved. Creating an address only containing a + `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). @@ -1035,7 +1036,9 @@ components: type: string enumDescriptions: - Default value. - - The resource is only visible to the GCP account who owns it. + - >- + The resource is only visible to the Google Cloud account who owns + it. - >- The resource is visible to the owner and may be visible to other applications and processes at Google. @@ -1088,15 +1091,15 @@ components: immediately on creation. This kind of job can not be updated. And when creating a job with past timestamp, the posting_publish_time must be set before posting_expire_time. The purpose of this feature - is to allow other objects, such as Application, to refer a job that - didn't exist in the system prior to becoming expired. If you want to - modify a job that was expired on creation, delete it and create a - new one. If this value isn't provided at the time of job creation or - is invalid, the job posting expires after 30 days from the job's - creation time. For example, if the job was created on 2017/01/01 - 13:00AM UTC with an unspecified expiration date, the job expires - after 2017/01/31 13:00AM UTC. If this value isn't provided on job - update, it depends on the field masks set by + is to allow other objects, such as ApplicationInfo, to refer a job + that didn't exist in the system prior to becoming expired. If you + want to modify a job that was expired on creation, delete it and + create a new one. If this value isn't provided at the time of job + creation or is invalid, the job posting expires after 30 days from + the job's creation time. For example, if the job was created on + 2017/01/01 13:00AM UTC with an unspecified expiration date, the job + expires after 2017/01/31 13:00AM UTC. If this value isn't provided + on job update, it depends on the field masks set by UpdateJobRequest.update_mask. If the field masks include job_end_time, or the masks are empty meaning that every field is updated, the job posting expires after 30 days from the job's last @@ -1839,6 +1842,27 @@ components: - KEYWORD_MATCH_DISABLED - KEYWORD_MATCH_ALL - KEYWORD_MATCH_TITLE_ONLY + relevanceThreshold: + description: >- + Optional. The relevance threshold of the search results. Default to + Google defined threshold, leveraging a balance of precision and + recall to deliver both highly accurate results and comprehensive + coverage of relevant information. + type: string + enumDescriptions: + - >- + Default value. In this case, server behavior defaults to Google + defined threshold. + - Lowest relevance threshold. + - Low relevance threshold. + - Medium relevance threshold. + - High relevance threshold. + enum: + - RELEVANCE_THRESHOLD_UNSPECIFIED + - LOWEST + - LOW + - MEDIUM + - HIGH RequestMetadata: id: RequestMetadata description: >- @@ -2243,8 +2267,8 @@ components: TelecommutePreference.TELECOMMUTE_EXCLUDED, the telecommute status of the jobs is ignored. Jobs that have PostingRegion.TELECOMMUTE and have additional Job.addresses may still be matched based on other - location filters using address or latlng. This filter can be used by - itself to search exclusively for telecommuting jobs, or it can be + location filters using address or lat_lng. This filter can be used + by itself to search exclusively for telecommuting jobs, or it can be combined with another location filter to search for a combination of job locations, such as "Mountain View" or "telecommuting" jobs. However, when used in combination with other location filters, @@ -2344,23 +2368,28 @@ components: properties: hours: description: >- - Hours of day in 24 hour format. Should be from 0 to 23. An API may - choose to allow the value "24:00:00" for scenarios like business - closing time. + Hours of a day in 24 hour format. Must be greater than or equal to 0 + and typically must be less than or equal to 23. An API may choose to + allow the value "24:00:00" for scenarios like business closing time. type: integer format: int32 minutes: - description: Minutes of hour of day. Must be from 0 to 59. + description: >- + Minutes of an hour. Must be greater than or equal to 0 and less than + or equal to 59. type: integer format: int32 seconds: description: >- - Seconds of minutes of the time. Must normally be from 0 to 59. An - API may allow the value 60 if it allows leap-seconds. + Seconds of a minute. Must be greater than or equal to 0 and + typically must be less than or equal to 59. An API may allow the + value 60 if it allows leap-seconds. type: integer format: int32 nanos: - description: Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. + description: >- + Fractions of seconds, in nanoseconds. Must be greater than or equal + to 0 and less than or equal to 999,999,999. type: integer format: int32 CompensationFilter: diff --git a/providers/src/googleapis.com/v00.00.00000/services/kmsinventory.yaml b/providers/src/googleapis.com/v00.00.00000/services/kmsinventory.yaml index ed6c9a09..b1ea6224 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/kmsinventory.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/kmsinventory.yaml @@ -7,8 +7,8 @@ info: title: KMS Inventory API description: '' version: v1 - x-discovery-doc-revision: '20241027' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250824' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/kms/ servers: @@ -34,129 +34,225 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudKmsV1KeyOperationAttestationCertificateChains: - description: >- - Certificate chains needed to verify the attestation. Certificates in - chains are PEM-encoded and are ordered based on - https://tools.ietf.org/html/rfc5246#section-7.4.2. + GoogleCloudKmsInventoryV1ListCryptoKeysResponse: + id: GoogleCloudKmsInventoryV1ListCryptoKeysResponse + description: Response message for KeyDashboardService.ListCryptoKeys. + type: object properties: - googleCardCerts: - description: Google card certificate chain corresponding to the attestation. + cryptoKeys: + description: The list of CryptoKeys. type: array items: - type: string - googlePartitionCerts: - description: Google partition certificate chain corresponding to the attestation. - items: - type: string - type: array - caviumCerts: - items: - type: string - description: Cavium certificate chain corresponding to the attestation. - type: array - type: object - id: GoogleCloudKmsV1KeyOperationAttestationCertificateChains - GoogleCloudKmsV1KeyAccessJustificationsPolicy: - id: GoogleCloudKmsV1KeyAccessJustificationsPolicy - type: object + $ref: '#/components/schemas/GoogleCloudKmsV1CryptoKey' + nextPageToken: + description: >- + The page token returned from the previous response if the next page + is desired. + type: string + GoogleCloudKmsV1CryptoKey: + id: GoogleCloudKmsV1CryptoKey description: >- - A KeyAccessJustificationsPolicy specifies zero or more allowed - AccessReason values for encrypt, decrypt, and sign operations on a - CryptoKey. + A CryptoKey represents a logical key that can be used for cryptographic + operations. A CryptoKey is made up of zero or more versions, which + represent the actual key material used in cryptographic operations. + type: object properties: - allowedAccessReasons: - type: array - items: - enumDescriptions: - - Unspecified access reason. - - Customer-initiated support. - - >- - Google-initiated access for system management and - troubleshooting. - - >- - Google-initiated access in response to a legal request or legal - process. - - >- - Google-initiated access for security, fraud, abuse, or - compliance purposes. - - >- - Customer uses their account to perform any access to their own - data which their IAM policy authorizes. - - >- - Google systems access customer data to help optimize the - structure of the data or quality for future uses by the - customer. - - No reason is expected for this key request. - - >- - Customer uses their account to perform any access to their own - data which their IAM policy authorizes, and one of the following - is true: * A Google administrator has reset the root-access - account associated with the user's organization within the past - 7 days. * A Google-initiated emergency access operation has - interacted with a resource in the same project or folder as the - currently accessed resource within the past 7 days. - - >- - Google systems access customer data to help optimize the - structure of the data or quality for future uses by the - customer, and one of the following is true: * A Google - administrator has reset the root-access account associated with - the user's organization within the past 7 days. * A - Google-initiated emergency access operation has interacted with - a resource in the same project or folder as the currently - accessed resource within the past 7 days. - - Google-initiated access to maintain system reliability. - - >- - One of the following operations is being executed while - simultaneously encountering an internal technical issue which - prevented a more precise justification code from being - generated: * Your account has been used to perform any access to - your own data which your IAM policy authorizes. * An automated - Google system operates on encrypted customer data which your IAM - policy authorizes. * Customer-initiated Google support access. * - Google-initiated support access to protect system reliability. + name: + description: >- + Output only. The resource name for this CryptoKey in the format + `projects/*/locations/*/keyRings/*/cryptoKeys/*`. + readOnly: true + type: string + primary: + description: >- + Output only. A copy of the "primary" CryptoKeyVersion that will be + used by Encrypt when this CryptoKey is given in EncryptRequest.name. + The CryptoKey's primary version can be updated via + UpdateCryptoKeyPrimaryVersion. Keys with purpose ENCRYPT_DECRYPT may + have a primary. For other keys, this field will be omitted. + readOnly: true + $ref: '#/components/schemas/GoogleCloudKmsV1CryptoKeyVersion' + purpose: + description: Immutable. The immutable purpose of this CryptoKey. + type: string + enumDescriptions: + - Not specified. + - CryptoKeys with this purpose may be used with Encrypt and Decrypt. + - >- + CryptoKeys with this purpose may be used with AsymmetricSign and + GetPublicKey. + - >- + CryptoKeys with this purpose may be used with AsymmetricDecrypt + and GetPublicKey. + - >- + CryptoKeys with this purpose may be used with RawEncrypt and + RawDecrypt. This purpose is meant to be used for interoperable + symmetric encryption and does not support automatic CryptoKey + rotation. + - CryptoKeys with this purpose may be used with MacSign. + - >- + CryptoKeys with this purpose may be used with GetPublicKey and + Decapsulate. + enum: + - CRYPTO_KEY_PURPOSE_UNSPECIFIED + - ENCRYPT_DECRYPT + - ASYMMETRIC_SIGN + - ASYMMETRIC_DECRYPT + - RAW_ENCRYPT_DECRYPT + - MAC + - KEY_ENCAPSULATION + createTime: + description: Output only. The time at which this CryptoKey was created. + readOnly: true + type: string + format: google-datetime + nextRotationTime: + description: >- + At next_rotation_time, the Key Management Service will + automatically: 1. Create a new version of this CryptoKey. 2. Mark + the new version as primary. Key rotations performed manually via + CreateCryptoKeyVersion and UpdateCryptoKeyPrimaryVersion do not + affect next_rotation_time. Keys with purpose ENCRYPT_DECRYPT support + automatic rotation. For other keys, this field must be omitted. + type: string + format: google-datetime + rotationPeriod: + description: >- + next_rotation_time will be advanced by this period when the service + automatically rotates a key. Must be at least 24 hours and at most + 876,000 hours. If rotation_period is set, next_rotation_time must + also be set. Keys with purpose ENCRYPT_DECRYPT support automatic + rotation. For other keys, this field must be omitted. + type: string + format: google-duration + versionTemplate: + description: >- + A template describing settings for new CryptoKeyVersion instances. + The properties of new CryptoKeyVersion instances created by either + CreateCryptoKeyVersion or auto-rotation are controlled by this + template. + $ref: '#/components/schemas/GoogleCloudKmsV1CryptoKeyVersionTemplate' + labels: + description: >- + Labels with user-defined metadata. For more information, see + [Labeling Keys](https://cloud.google.com/kms/docs/labeling-keys). + type: object + additionalProperties: type: string - enum: - - REASON_UNSPECIFIED - - CUSTOMER_INITIATED_SUPPORT - - GOOGLE_INITIATED_SERVICE - - THIRD_PARTY_DATA_REQUEST - - GOOGLE_INITIATED_REVIEW - - CUSTOMER_INITIATED_ACCESS - - GOOGLE_INITIATED_SYSTEM_OPERATION - - REASON_NOT_EXPECTED - - MODIFIED_CUSTOMER_INITIATED_ACCESS - - MODIFIED_GOOGLE_INITIATED_SYSTEM_OPERATION - - GOOGLE_RESPONSE_TO_PRODUCTION_ALERT - - CUSTOMER_AUTHORIZED_WORKFLOW_SERVICING + importOnly: + description: Immutable. Whether this key may contain imported versions only. + type: boolean + destroyScheduledDuration: description: >- - The list of allowed reasons for access to a CryptoKey. Zero allowed - access reasons means all encrypt, decrypt, and sign operations for - the CryptoKey associated with this policy will fail. - GoogleCloudKmsInventoryV1ListCryptoKeysResponse: - description: Response message for KeyDashboardService.ListCryptoKeys. - properties: - nextPageToken: + Immutable. The period of time that versions of this key spend in the + DESTROY_SCHEDULED state before transitioning to DESTROYED. If not + specified at creation time, the default duration is 30 days. type: string + format: google-duration + cryptoKeyBackend: description: >- - The page token returned from the previous response if the next page - is desired. - cryptoKeys: - items: - $ref: '#/components/schemas/GoogleCloudKmsV1CryptoKey' - description: The list of CryptoKeys. - type: array - id: GoogleCloudKmsInventoryV1ListCryptoKeysResponse + Immutable. The resource name of the backend environment where the + key material for all CryptoKeyVersions associated with this + CryptoKey reside and where all related cryptographic operations are + performed. Only applicable if CryptoKeyVersions have a + ProtectionLevel of EXTERNAL_VPC, with the resource name in the + format `projects/*/locations/*/ekmConnections/*`. Note, this list is + non-exhaustive and may apply to additional ProtectionLevels in the + future. + type: string + keyAccessJustificationsPolicy: + description: >- + Optional. The policy used for Key Access Justifications Policy + Enforcement. If this field is present and this key is enrolled in + Key Access Justifications Policy Enforcement, the policy will be + evaluated in encrypt, decrypt, and sign operations, and the + operation will fail if rejected by the policy. The policy is defined + by specifying zero or more allowed justification codes. + https://cloud.google.com/assured-workloads/key-access-justifications/docs/justification-codes + By default, this field is absent, and all justification codes are + allowed. + $ref: '#/components/schemas/GoogleCloudKmsV1KeyAccessJustificationsPolicy' + GoogleCloudKmsV1CryptoKeyVersion: + id: GoogleCloudKmsV1CryptoKeyVersion + description: >- + A CryptoKeyVersion represents an individual cryptographic key, and the + associated key material. An ENABLED version can be used for + cryptographic operations. For security reasons, the raw cryptographic + key material represented by a CryptoKeyVersion can never be viewed or + exported. It can only be used to encrypt, decrypt, or sign data when an + authorized user or application invokes Cloud KMS. type: object - GoogleCloudKmsV1CryptoKeyVersionTemplate: properties: - protectionLevel: + name: + description: >- + Output only. The resource name for this CryptoKeyVersion in the + format + `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`. + readOnly: true + type: string + state: + description: The current state of the CryptoKeyVersion. + type: string + enumDescriptions: + - Not specified. + - >- + This version is still being generated. It may not be used, + enabled, disabled, or destroyed yet. Cloud KMS will automatically + mark this version ENABLED as soon as the version is ready. + - This version may be used for cryptographic operations. + - >- + This version may not be used, but the key material is still + available, and the version can be placed back into the ENABLED + state. + - >- + The key material of this version is destroyed and no longer + stored. This version may only become ENABLED again if this version + is reimport_eligible and the original key material is reimported + with a call to KeyManagementService.ImportCryptoKeyVersion. + - >- + This version is scheduled for destruction, and will be destroyed + soon. Call RestoreCryptoKeyVersion to put it back into the + DISABLED state. + - >- + This version is still being imported. It may not be used, enabled, + disabled, or destroyed yet. Cloud KMS will automatically mark this + version ENABLED as soon as the version is ready. + - >- + This version was not imported successfully. It may not be used, + enabled, disabled, or destroyed. The submitted key material has + been discarded. Additional details can be found in + CryptoKeyVersion.import_failure_reason. + - >- + This version was not generated successfully. It may not be used, + enabled, disabled, or destroyed. Additional details can be found + in CryptoKeyVersion.generation_failure_reason. + - >- + This version was destroyed, and it may not be used or enabled + again. Cloud KMS is waiting for the corresponding key material + residing in an external key manager to be destroyed. + - >- + This version was destroyed, and it may not be used or enabled + again. However, Cloud KMS could not confirm that the corresponding + key material residing in an external key manager was destroyed. + Additional details can be found in + CryptoKeyVersion.external_destruction_failure_reason. enum: - - PROTECTION_LEVEL_UNSPECIFIED - - SOFTWARE - - HSM - - EXTERNAL - - EXTERNAL_VPC + - CRYPTO_KEY_VERSION_STATE_UNSPECIFIED + - PENDING_GENERATION + - ENABLED + - DISABLED + - DESTROYED + - DESTROY_SCHEDULED + - PENDING_IMPORT + - IMPORT_FAILED + - GENERATION_FAILED + - PENDING_EXTERNAL_DESTRUCTION + - EXTERNAL_DESTRUCTION_FAILED + protectionLevel: + description: >- + Output only. The ProtectionLevel describing how crypto operations + are performed with this CryptoKeyVersion. + readOnly: true type: string enumDescriptions: - Not specified. @@ -164,53 +260,18 @@ components: - Crypto operations are performed in a Hardware Security Module. - Crypto operations are performed by an external key manager. - Crypto operations are performed in an EKM-over-VPC backend. - description: >- - ProtectionLevel to use when creating a CryptoKeyVersion based on - this template. Immutable. Defaults to SOFTWARE. + enum: + - PROTECTION_LEVEL_UNSPECIFIED + - SOFTWARE + - HSM + - EXTERNAL + - EXTERNAL_VPC algorithm: description: >- - Required. Algorithm to use when creating a CryptoKeyVersion based on - this template. For backwards compatibility, - GOOGLE_SYMMETRIC_ENCRYPTION is implied if both this field is omitted - and CryptoKey.purpose is ENCRYPT_DECRYPT. + Output only. The CryptoKeyVersionAlgorithm that this + CryptoKeyVersion supports. + readOnly: true type: string - enum: - - CRYPTO_KEY_VERSION_ALGORITHM_UNSPECIFIED - - GOOGLE_SYMMETRIC_ENCRYPTION - - AES_128_GCM - - AES_256_GCM - - AES_128_CBC - - AES_256_CBC - - AES_128_CTR - - AES_256_CTR - - RSA_SIGN_PSS_2048_SHA256 - - RSA_SIGN_PSS_3072_SHA256 - - RSA_SIGN_PSS_4096_SHA256 - - RSA_SIGN_PSS_4096_SHA512 - - RSA_SIGN_PKCS1_2048_SHA256 - - RSA_SIGN_PKCS1_3072_SHA256 - - RSA_SIGN_PKCS1_4096_SHA256 - - RSA_SIGN_PKCS1_4096_SHA512 - - RSA_SIGN_RAW_PKCS1_2048 - - RSA_SIGN_RAW_PKCS1_3072 - - RSA_SIGN_RAW_PKCS1_4096 - - RSA_DECRYPT_OAEP_2048_SHA256 - - RSA_DECRYPT_OAEP_3072_SHA256 - - RSA_DECRYPT_OAEP_4096_SHA256 - - RSA_DECRYPT_OAEP_4096_SHA512 - - RSA_DECRYPT_OAEP_2048_SHA1 - - RSA_DECRYPT_OAEP_3072_SHA1 - - RSA_DECRYPT_OAEP_4096_SHA1 - - EC_SIGN_P256_SHA256 - - EC_SIGN_P384_SHA384 - - EC_SIGN_SECP256K1_SHA256 - - EC_SIGN_ED25519 - - HMAC_SHA256 - - HMAC_SHA1 - - HMAC_SHA384 - - HMAC_SHA512 - - HMAC_SHA224 - - EXTERNAL_SYMMETRIC_ENCRYPTION enumDescriptions: - Not specified. - Creates symmetric encryption keys. @@ -260,142 +321,256 @@ components: - >- Algorithm representing symmetric encryption by an external key manager. - description: >- - A CryptoKeyVersionTemplate specifies the properties to use when creating - a new CryptoKeyVersion, either manually with CreateCryptoKeyVersion or - automatically as a result of auto-rotation. - type: object - id: GoogleCloudKmsV1CryptoKeyVersionTemplate - GoogleCloudKmsInventoryV1ProtectedResource: - type: object - properties: - project: - type: string - description: 'Format: `projects/{PROJECT_NUMBER}`.' - labels: - type: object - description: A key-value pair of the resource's labels (v1) to their values. - additionalProperties: - type: string + - ML-KEM-768 (FIPS 203) + - ML-KEM-1024 (FIPS 203) + - >- + X-Wing hybrid KEM combining ML-KEM-768 with X25519 following + datatracker.ietf.org/doc/draft-connolly-cfrg-xwing-kem/. + - >- + The post-quantum Module-Lattice-Based Digital Signature Algorithm, + at security level 3. Randomized version. + - >- + The post-quantum stateless hash-based digital signature algorithm, + at security level 1. Randomized version. + - >- + The post-quantum stateless hash-based digital signature algorithm, + at security level 1. Randomized pre-hash version supporting SHA256 + digests. + enum: + - CRYPTO_KEY_VERSION_ALGORITHM_UNSPECIFIED + - GOOGLE_SYMMETRIC_ENCRYPTION + - AES_128_GCM + - AES_256_GCM + - AES_128_CBC + - AES_256_CBC + - AES_128_CTR + - AES_256_CTR + - RSA_SIGN_PSS_2048_SHA256 + - RSA_SIGN_PSS_3072_SHA256 + - RSA_SIGN_PSS_4096_SHA256 + - RSA_SIGN_PSS_4096_SHA512 + - RSA_SIGN_PKCS1_2048_SHA256 + - RSA_SIGN_PKCS1_3072_SHA256 + - RSA_SIGN_PKCS1_4096_SHA256 + - RSA_SIGN_PKCS1_4096_SHA512 + - RSA_SIGN_RAW_PKCS1_2048 + - RSA_SIGN_RAW_PKCS1_3072 + - RSA_SIGN_RAW_PKCS1_4096 + - RSA_DECRYPT_OAEP_2048_SHA256 + - RSA_DECRYPT_OAEP_3072_SHA256 + - RSA_DECRYPT_OAEP_4096_SHA256 + - RSA_DECRYPT_OAEP_4096_SHA512 + - RSA_DECRYPT_OAEP_2048_SHA1 + - RSA_DECRYPT_OAEP_3072_SHA1 + - RSA_DECRYPT_OAEP_4096_SHA1 + - EC_SIGN_P256_SHA256 + - EC_SIGN_P384_SHA384 + - EC_SIGN_SECP256K1_SHA256 + - EC_SIGN_ED25519 + - HMAC_SHA256 + - HMAC_SHA1 + - HMAC_SHA384 + - HMAC_SHA512 + - HMAC_SHA224 + - EXTERNAL_SYMMETRIC_ENCRYPTION + - ML_KEM_768 + - ML_KEM_1024 + - KEM_XWING + - PQ_SIGN_ML_DSA_65 + - PQ_SIGN_SLH_DSA_SHA2_128S + - PQ_SIGN_HASH_SLH_DSA_SHA2_128S_SHA256 + attestation: + description: >- + Output only. Statement that was generated and signed by the HSM at + key creation time. Use this statement to verify attributes of the + key as stored on the HSM, independently of Google. Only provided for + key versions with protection_level HSM. + readOnly: true + $ref: '#/components/schemas/GoogleCloudKmsV1KeyOperationAttestation' createTime: + description: Output only. The time at which this CryptoKeyVersion was created. + readOnly: true + type: string + format: google-datetime + generateTime: + description: >- + Output only. The time this CryptoKeyVersion's key material was + generated. readOnly: true + type: string format: google-datetime + destroyTime: + description: >- + Output only. The time this CryptoKeyVersion's key material is + scheduled for destruction. Only present if state is + DESTROY_SCHEDULED. + readOnly: true type: string + format: google-datetime + destroyEventTime: description: >- - Output only. The time at which this resource was created. The - granularity is in seconds. Timestamp.nanos will always be 0. - location: + Output only. The time this CryptoKeyVersion's key material was + destroyed. Only present if state is DESTROYED. + readOnly: true type: string + format: google-datetime + importJob: description: >- - Location can be `global`, regional like `us-east1`, or zonal like - `us-west1-b`. - resourceType: + Output only. The name of the ImportJob used in the most recent + import of this CryptoKeyVersion. Only present if the underlying key + material was imported. + readOnly: true type: string - description: 'Example: `compute.googleapis.com/Disk`' - name: + importTime: description: >- - The full resource name of the resource. Example: - `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. + Output only. The time at which this CryptoKeyVersion's key material + was most recently imported. + readOnly: true type: string - cryptoKeyVersions: + format: google-datetime + importFailureReason: description: >- - The names of the Cloud KMS - [CryptoKeyVersion](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys.cryptoKeyVersions?hl=en) - used to protect this resource via CMEK. This field is empty if the - Google Cloud product owning the resource does not provide key - versions data to Asset Inventory. The first element of this field is - stored in crypto_key_version. + Output only. The root cause of the most recent import failure. Only + present if state is IMPORT_FAILED. + readOnly: true + type: string + generationFailureReason: + description: >- + Output only. The root cause of the most recent generation failure. + Only present if state is GENERATION_FAILED. + readOnly: true + type: string + externalDestructionFailureReason: + description: >- + Output only. The root cause of the most recent external destruction + failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED. + readOnly: true + type: string + externalProtectionLevelOptions: + description: >- + ExternalProtectionLevelOptions stores a group of additional fields + for configuring a CryptoKeyVersion that are specific to the EXTERNAL + protection level and EXTERNAL_VPC protection levels. + $ref: '#/components/schemas/GoogleCloudKmsV1ExternalProtectionLevelOptions' + reimportEligible: + description: >- + Output only. Whether or not this key version is eligible for + reimport, by being specified as a target in + ImportCryptoKeyVersionRequest.crypto_key_version. + readOnly: true + type: boolean + GoogleCloudKmsV1KeyOperationAttestation: + id: GoogleCloudKmsV1KeyOperationAttestation + description: >- + Contains an HSM-generated attestation about a key operation. For more + information, see [Verifying attestations] + (https://cloud.google.com/kms/docs/attest-key). + type: object + properties: + format: + description: Output only. The format of the attestation data. + readOnly: true + type: string + enumDescriptions: + - Not specified. + - >- + Cavium HSM attestation compressed with gzip. Note that this format + is defined by Cavium and subject to change at any time. See + https://www.marvell.com/products/security-solutions/nitrox-hs-adapters/software-key-attestation.html. + - >- + Cavium HSM attestation V2 compressed with gzip. This is a new + format introduced in Cavium's version 3.2-08. + enum: + - ATTESTATION_FORMAT_UNSPECIFIED + - CAVIUM_V1_COMPRESSED + - CAVIUM_V2_COMPRESSED + content: + description: >- + Output only. The attestation data provided by the HSM when the key + operation was performed. + readOnly: true + type: string + format: byte + certChains: + description: >- + Output only. The certificate chains needed to validate the + attestation + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudKmsV1KeyOperationAttestationCertificateChains + GoogleCloudKmsV1KeyOperationAttestationCertificateChains: + id: GoogleCloudKmsV1KeyOperationAttestationCertificateChains + description: >- + Certificate chains needed to verify the attestation. Certificates in + chains are PEM-encoded and are ordered based on + https://tools.ietf.org/html/rfc5246#section-7.4.2. + type: object + properties: + caviumCerts: + description: Cavium certificate chain corresponding to the attestation. + type: array + items: + type: string + googleCardCerts: + description: Google card certificate chain corresponding to the attestation. type: array items: type: string - projectId: - description: The ID of the project that owns the resource. - type: string - cryptoKeyVersion: + googlePartitionCerts: + description: Google partition certificate chain corresponding to the attestation. + type: array + items: + type: string + GoogleCloudKmsV1ExternalProtectionLevelOptions: + id: GoogleCloudKmsV1ExternalProtectionLevelOptions + description: >- + ExternalProtectionLevelOptions stores a group of additional fields for + configuring a CryptoKeyVersion that are specific to the EXTERNAL + protection level and EXTERNAL_VPC protection levels. + type: object + properties: + externalKeyUri: + description: >- + The URI for an external resource that this CryptoKeyVersion + represents. type: string + ekmConnectionKeyPath: description: >- - The name of the Cloud KMS - [CryptoKeyVersion](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys.cryptoKeyVersions?hl=en) - used to protect this resource via CMEK. This field is empty if the - Google Cloud product owning the resource does not provide key - version data to Asset Inventory. If there are multiple key versions - protecting the resource, then this is same value as the first - element of crypto_key_versions. - cloudProduct: - description: 'The Cloud product that owns the resource. Example: `compute`' + The path to the external key material on the EKM when using + EkmConnection e.g., "v0/my/key". Set this field instead of + external_key_uri when using an EkmConnection. type: string - id: GoogleCloudKmsInventoryV1ProtectedResource - description: Metadata about a resource protected by a Cloud KMS key. - GoogleCloudKmsV1CryptoKeyVersion: + GoogleCloudKmsV1CryptoKeyVersionTemplate: + id: GoogleCloudKmsV1CryptoKeyVersionTemplate + description: >- + A CryptoKeyVersionTemplate specifies the properties to use when creating + a new CryptoKeyVersion, either manually with CreateCryptoKeyVersion or + automatically as a result of auto-rotation. type: object - id: GoogleCloudKmsV1CryptoKeyVersion properties: - state: - enum: - - CRYPTO_KEY_VERSION_STATE_UNSPECIFIED - - PENDING_GENERATION - - ENABLED - - DISABLED - - DESTROYED - - DESTROY_SCHEDULED - - PENDING_IMPORT - - IMPORT_FAILED - - GENERATION_FAILED - - PENDING_EXTERNAL_DESTRUCTION - - EXTERNAL_DESTRUCTION_FAILED + protectionLevel: + description: >- + ProtectionLevel to use when creating a CryptoKeyVersion based on + this template. Immutable. Defaults to SOFTWARE. + type: string enumDescriptions: - Not specified. - - >- - This version is still being generated. It may not be used, - enabled, disabled, or destroyed yet. Cloud KMS will automatically - mark this version ENABLED as soon as the version is ready. - - This version may be used for cryptographic operations. - - >- - This version may not be used, but the key material is still - available, and the version can be placed back into the ENABLED - state. - - >- - This version is destroyed, and the key material is no longer - stored. This version may only become ENABLED again if this version - is reimport_eligible and the original key material is reimported - with a call to KeyManagementService.ImportCryptoKeyVersion. - - >- - This version is scheduled for destruction, and will be destroyed - soon. Call RestoreCryptoKeyVersion to put it back into the - DISABLED state. - - >- - This version is still being imported. It may not be used, enabled, - disabled, or destroyed yet. Cloud KMS will automatically mark this - version ENABLED as soon as the version is ready. - - >- - This version was not imported successfully. It may not be used, - enabled, disabled, or destroyed. The submitted key material has - been discarded. Additional details can be found in - CryptoKeyVersion.import_failure_reason. - - >- - This version was not generated successfully. It may not be used, - enabled, disabled, or destroyed. Additional details can be found - in CryptoKeyVersion.generation_failure_reason. - - >- - This version was destroyed, and it may not be used or enabled - again. Cloud KMS is waiting for the corresponding key material - residing in an external key manager to be destroyed. - - >- - This version was destroyed, and it may not be used or enabled - again. However, Cloud KMS could not confirm that the corresponding - key material residing in an external key manager was destroyed. - Additional details can be found in - CryptoKeyVersion.external_destruction_failure_reason. - description: The current state of the CryptoKeyVersion. - type: string - importJob: - type: string - readOnly: true - description: >- - Output only. The name of the ImportJob used in the most recent - import of this CryptoKeyVersion. Only present if the underlying key - material was imported. + - Crypto operations are performed in software. + - Crypto operations are performed in a Hardware Security Module. + - Crypto operations are performed by an external key manager. + - Crypto operations are performed in an EKM-over-VPC backend. + enum: + - PROTECTION_LEVEL_UNSPECIFIED + - SOFTWARE + - HSM + - EXTERNAL + - EXTERNAL_VPC algorithm: + description: >- + Required. Algorithm to use when creating a CryptoKeyVersion based on + this template. For backwards compatibility, + GOOGLE_SYMMETRIC_ENCRYPTION is implied if both this field is omitted + and CryptoKey.purpose is ENCRYPT_DECRYPT. type: string enumDescriptions: - Not specified. @@ -446,10 +621,21 @@ components: - >- Algorithm representing symmetric encryption by an external key manager. - description: >- - Output only. The CryptoKeyVersionAlgorithm that this - CryptoKeyVersion supports. - readOnly: true + - ML-KEM-768 (FIPS 203) + - ML-KEM-1024 (FIPS 203) + - >- + X-Wing hybrid KEM combining ML-KEM-768 with X25519 following + datatracker.ietf.org/doc/draft-connolly-cfrg-xwing-kem/. + - >- + The post-quantum Module-Lattice-Based Digital Signature Algorithm, + at security level 3. Randomized version. + - >- + The post-quantum stateless hash-based digital signature algorithm, + at security level 1. Randomized version. + - >- + The post-quantum stateless hash-based digital signature algorithm, + at security level 1. Randomized pre-hash version supporting SHA256 + digests. enum: - CRYPTO_KEY_VERSION_ALGORITHM_UNSPECIFIED - GOOGLE_SYMMETRIC_ENCRYPTION @@ -487,369 +673,214 @@ components: - HMAC_SHA512 - HMAC_SHA224 - EXTERNAL_SYMMETRIC_ENCRYPTION - createTime: - format: google-datetime - readOnly: true - type: string - description: Output only. The time at which this CryptoKeyVersion was created. - reimportEligible: - type: boolean - description: >- - Output only. Whether or not this key version is eligible for - reimport, by being specified as a target in - ImportCryptoKeyVersionRequest.crypto_key_version. - readOnly: true - attestation: - description: >- - Output only. Statement that was generated and signed by the HSM at - key creation time. Use this statement to verify attributes of the - key as stored on the HSM, independently of Google. Only provided for - key versions with protection_level HSM. - $ref: '#/components/schemas/GoogleCloudKmsV1KeyOperationAttestation' - readOnly: true - externalProtectionLevelOptions: - description: >- - ExternalProtectionLevelOptions stores a group of additional fields - for configuring a CryptoKeyVersion that are specific to the EXTERNAL - protection level and EXTERNAL_VPC protection levels. - $ref: '#/components/schemas/GoogleCloudKmsV1ExternalProtectionLevelOptions' - destroyEventTime: - description: >- - Output only. The time this CryptoKeyVersion's key material was - destroyed. Only present if state is DESTROYED. - type: string - readOnly: true - format: google-datetime - name: - type: string - readOnly: true - description: >- - Output only. The resource name for this CryptoKeyVersion in the - format - `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`. - generateTime: - type: string - readOnly: true - format: google-datetime - description: >- - Output only. The time this CryptoKeyVersion's key material was - generated. - destroyTime: - readOnly: true - format: google-datetime - description: >- - Output only. The time this CryptoKeyVersion's key material is - scheduled for destruction. Only present if state is - DESTROY_SCHEDULED. - type: string - importTime: - readOnly: true - format: google-datetime - description: >- - Output only. The time at which this CryptoKeyVersion's key material - was most recently imported. - type: string - protectionLevel: - enum: - - PROTECTION_LEVEL_UNSPECIFIED - - SOFTWARE - - HSM - - EXTERNAL - - EXTERNAL_VPC - type: string - readOnly: true - enumDescriptions: - - Not specified. - - Crypto operations are performed in software. - - Crypto operations are performed in a Hardware Security Module. - - Crypto operations are performed by an external key manager. - - Crypto operations are performed in an EKM-over-VPC backend. - description: >- - Output only. The ProtectionLevel describing how crypto operations - are performed with this CryptoKeyVersion. - generationFailureReason: - readOnly: true - description: >- - Output only. The root cause of the most recent generation failure. - Only present if state is GENERATION_FAILED. - type: string - externalDestructionFailureReason: - type: string - description: >- - Output only. The root cause of the most recent external destruction - failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED. - readOnly: true - importFailureReason: - description: >- - Output only. The root cause of the most recent import failure. Only - present if state is IMPORT_FAILED. - readOnly: true - type: string + - ML_KEM_768 + - ML_KEM_1024 + - KEM_XWING + - PQ_SIGN_ML_DSA_65 + - PQ_SIGN_SLH_DSA_SHA2_128S + - PQ_SIGN_HASH_SLH_DSA_SHA2_128S_SHA256 + GoogleCloudKmsV1KeyAccessJustificationsPolicy: + id: GoogleCloudKmsV1KeyAccessJustificationsPolicy description: >- - A CryptoKeyVersion represents an individual cryptographic key, and the - associated key material. An ENABLED version can be used for - cryptographic operations. For security reasons, the raw cryptographic - key material represented by a CryptoKeyVersion can never be viewed or - exported. It can only be used to encrypt, decrypt, or sign data when an - authorized user or application invokes Cloud KMS. + A KeyAccessJustificationsPolicy specifies zero or more allowed + AccessReason values for encrypt, decrypt, and sign operations on a + CryptoKey. + type: object + properties: + allowedAccessReasons: + description: >- + The list of allowed reasons for access to a CryptoKey. Zero allowed + access reasons means all encrypt, decrypt, and sign operations for + the CryptoKey associated with this policy will fail. + type: array + items: + type: string + enumDescriptions: + - Unspecified access reason. + - Customer-initiated support. + - >- + Google-initiated access for system management and + troubleshooting. + - >- + Google-initiated access in response to a legal request or legal + process. + - >- + Google-initiated access for security, fraud, abuse, or + compliance purposes. + - >- + Customer uses their account to perform any access to their own + data which their IAM policy authorizes. + - >- + Google systems access customer data to help optimize the + structure of the data or quality for future uses by the + customer. + - No reason is expected for this key request. + - >- + Customer uses their account to perform any access to their own + data which their IAM policy authorizes, and one of the following + is true: * A Google administrator has reset the root-access + account associated with the user's organization within the past + 7 days. * A Google-initiated emergency access operation has + interacted with a resource in the same project or folder as the + currently accessed resource within the past 7 days. + - >- + Google systems access customer data to help optimize the + structure of the data or quality for future uses by the + customer, and one of the following is true: * A Google + administrator has reset the root-access account associated with + the user's organization within the past 7 days. * A + Google-initiated emergency access operation has interacted with + a resource in the same project or folder as the currently + accessed resource within the past 7 days. + - Google-initiated access to maintain system reliability. + - >- + One of the following operations is being executed while + simultaneously encountering an internal technical issue which + prevented a more precise justification code from being + generated: * Your account has been used to perform any access to + your own data which your IAM policy authorizes. * An automated + Google system operates on encrypted customer data which your IAM + policy authorizes. * Customer-initiated Google support access. * + Google-initiated support access to protect system reliability. + enum: + - REASON_UNSPECIFIED + - CUSTOMER_INITIATED_SUPPORT + - GOOGLE_INITIATED_SERVICE + - THIRD_PARTY_DATA_REQUEST + - GOOGLE_INITIATED_REVIEW + - CUSTOMER_INITIATED_ACCESS + - GOOGLE_INITIATED_SYSTEM_OPERATION + - REASON_NOT_EXPECTED + - MODIFIED_CUSTOMER_INITIATED_ACCESS + - MODIFIED_GOOGLE_INITIATED_SYSTEM_OPERATION + - GOOGLE_RESPONSE_TO_PRODUCTION_ALERT + - CUSTOMER_AUTHORIZED_WORKFLOW_SERVICING GoogleCloudKmsInventoryV1ProtectedResourcesSummary: id: GoogleCloudKmsInventoryV1ProtectedResourcesSummary + description: >- + Aggregate information about the resources protected by a Cloud KMS key + in the same Cloud organization as the key. type: object properties: - locations: - additionalProperties: - type: string - format: int64 - description: The number of resources protected by the key grouped by region. - type: object - cloudProducts: + name: description: >- - The number of resources protected by the key grouped by Cloud - product. - type: object - additionalProperties: - type: string - format: int64 - resourceCount: + The full name of the ProtectedResourcesSummary resource. Example: + projects/test-project/locations/us/keyRings/test-keyring/cryptoKeys/test-key/protectedResourcesSummary type: string + resourceCount: description: >- The total number of protected resources in the same Cloud organization as the key. - format: int64 - name: type: string + format: int64 + projectCount: description: >- - The full name of the ProtectedResourcesSummary resource. Example: - projects/test-project/locations/us/keyRings/test-keyring/cryptoKeys/test-key/protectedResourcesSummary + The number of distinct Cloud projects in the same Cloud organization + as the key that have resources protected by the key. + type: integer + format: int32 resourceTypes: - type: object description: >- The number of resources protected by the key grouped by resource type. + type: object additionalProperties: - format: int64 type: string - projectCount: - format: int32 - description: >- - The number of distinct Cloud projects in the same Cloud organization - as the key that have resources protected by the key. - type: integer - description: >- - Aggregate information about the resources protected by a Cloud KMS key - in the same Cloud organization as the key. - GoogleCloudKmsV1CryptoKey: - id: GoogleCloudKmsV1CryptoKey - properties: - name: - type: string + format: int64 + cloudProducts: description: >- - Output only. The resource name for this CryptoKey in the format - `projects/*/locations/*/keyRings/*/cryptoKeys/*`. - readOnly: true - labels: + The number of resources protected by the key grouped by Cloud + product. + type: object additionalProperties: type: string + format: int64 + locations: + description: The number of resources protected by the key grouped by region. type: object - description: >- - Labels with user-defined metadata. For more information, see - [Labeling Keys](https://cloud.google.com/kms/docs/labeling-keys). - purpose: - type: string - enumDescriptions: - - Not specified. - - CryptoKeys with this purpose may be used with Encrypt and Decrypt. - - >- - CryptoKeys with this purpose may be used with AsymmetricSign and - GetPublicKey. - - >- - CryptoKeys with this purpose may be used with AsymmetricDecrypt - and GetPublicKey. - - >- - CryptoKeys with this purpose may be used with RawEncrypt and - RawDecrypt. This purpose is meant to be used for interoperable - symmetric encryption and does not support automatic CryptoKey - rotation. - - CryptoKeys with this purpose may be used with MacSign. - description: Immutable. The immutable purpose of this CryptoKey. - enum: - - CRYPTO_KEY_PURPOSE_UNSPECIFIED - - ENCRYPT_DECRYPT - - ASYMMETRIC_SIGN - - ASYMMETRIC_DECRYPT - - RAW_ENCRYPT_DECRYPT - - MAC - createTime: - description: Output only. The time at which this CryptoKey was created. - format: google-datetime - type: string - readOnly: true - versionTemplate: - description: >- - A template describing settings for new CryptoKeyVersion instances. - The properties of new CryptoKeyVersion instances created by either - CreateCryptoKeyVersion or auto-rotation are controlled by this - template. - $ref: '#/components/schemas/GoogleCloudKmsV1CryptoKeyVersionTemplate' - cryptoKeyBackend: - type: string - description: >- - Immutable. The resource name of the backend environment where the - key material for all CryptoKeyVersions associated with this - CryptoKey reside and where all related cryptographic operations are - performed. Only applicable if CryptoKeyVersions have a - ProtectionLevel of EXTERNAL_VPC, with the resource name in the - format `projects/*/locations/*/ekmConnections/*`. Note, this list is - non-exhaustive and may apply to additional ProtectionLevels in the - future. - destroyScheduledDuration: - description: >- - Immutable. The period of time that versions of this key spend in the - DESTROY_SCHEDULED state before transitioning to DESTROYED. If not - specified at creation time, the default duration is 30 days. - type: string - format: google-duration - primary: - $ref: '#/components/schemas/GoogleCloudKmsV1CryptoKeyVersion' - readOnly: true - description: >- - Output only. A copy of the "primary" CryptoKeyVersion that will be - used by Encrypt when this CryptoKey is given in EncryptRequest.name. - The CryptoKey's primary version can be updated via - UpdateCryptoKeyPrimaryVersion. Keys with purpose ENCRYPT_DECRYPT may - have a primary. For other keys, this field will be omitted. - importOnly: - description: Immutable. Whether this key may contain imported versions only. - type: boolean - keyAccessJustificationsPolicy: - description: >- - Optional. The policy used for Key Access Justifications Policy - Enforcement. If this field is present and this key is enrolled in - Key Access Justifications Policy Enforcement, the policy will be - evaluated in encrypt, decrypt, and sign operations, and the - operation will fail if rejected by the policy. The policy is defined - by specifying zero or more allowed justification codes. - https://cloud.google.com/assured-workloads/key-access-justifications/docs/justification-codes - By default, this field is absent, and all justification codes are - allowed. - $ref: '#/components/schemas/GoogleCloudKmsV1KeyAccessJustificationsPolicy' - rotationPeriod: - format: google-duration - description: >- - next_rotation_time will be advanced by this period when the service - automatically rotates a key. Must be at least 24 hours and at most - 876,000 hours. If rotation_period is set, next_rotation_time must - also be set. Keys with purpose ENCRYPT_DECRYPT support automatic - rotation. For other keys, this field must be omitted. - type: string - nextRotationTime: - format: google-datetime - description: >- - At next_rotation_time, the Key Management Service will - automatically: 1. Create a new version of this CryptoKey. 2. Mark - the new version as primary. Key rotations performed manually via - CreateCryptoKeyVersion and UpdateCryptoKeyPrimaryVersion do not - affect next_rotation_time. Keys with purpose ENCRYPT_DECRYPT support - automatic rotation. For other keys, this field must be omitted. - type: string - description: >- - A CryptoKey represents a logical key that can be used for cryptographic - operations. A CryptoKey is made up of zero or more versions, which - represent the actual key material used in cryptographic operations. - type: object + additionalProperties: + type: string + format: int64 GoogleCloudKmsInventoryV1SearchProtectedResourcesResponse: id: GoogleCloudKmsInventoryV1SearchProtectedResourcesResponse description: Response message for KeyTrackingService.SearchProtectedResources. + type: object properties: + protectedResources: + description: Protected resources for this page. + type: array + items: + $ref: '#/components/schemas/GoogleCloudKmsInventoryV1ProtectedResource' nextPageToken: - type: string description: >- A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. - protectedResources: - items: - $ref: '#/components/schemas/GoogleCloudKmsInventoryV1ProtectedResource' - description: Protected resources for this page. - type: array + type: string + GoogleCloudKmsInventoryV1ProtectedResource: + id: GoogleCloudKmsInventoryV1ProtectedResource + description: Metadata about a resource protected by a Cloud KMS key. type: object - GoogleCloudKmsV1ExternalProtectionLevelOptions: - id: GoogleCloudKmsV1ExternalProtectionLevelOptions properties: - ekmConnectionKeyPath: + name: + description: >- + The full resource name of the resource. Example: + `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. + type: string + project: + description: 'Format: `projects/{PROJECT_NUMBER}`.' + type: string + projectId: + description: The ID of the project that owns the resource. + type: string + cloudProduct: + description: 'The Cloud product that owns the resource. Example: `compute`' type: string - description: >- - The path to the external key material on the EKM when using - EkmConnection e.g., "v0/my/key". Set this field instead of - external_key_uri when using an EkmConnection. - externalKeyUri: + resourceType: + description: 'Example: `compute.googleapis.com/Disk`' type: string + location: description: >- - The URI for an external resource that this CryptoKeyVersion - represents. - description: >- - ExternalProtectionLevelOptions stores a group of additional fields for - configuring a CryptoKeyVersion that are specific to the EXTERNAL - protection level and EXTERNAL_VPC protection levels. - type: object - GoogleCloudKmsV1KeyOperationAttestation: - properties: - format: - readOnly: true - enum: - - ATTESTATION_FORMAT_UNSPECIFIED - - CAVIUM_V1_COMPRESSED - - CAVIUM_V2_COMPRESSED - description: Output only. The format of the attestation data. - enumDescriptions: - - Not specified. - - >- - Cavium HSM attestation compressed with gzip. Note that this format - is defined by Cavium and subject to change at any time. See - https://www.marvell.com/products/security-solutions/nitrox-hs-adapters/software-key-attestation.html. - - >- - Cavium HSM attestation V2 compressed with gzip. This is a new - format introduced in Cavium's version 3.2-08. + Location can be `global`, regional like `us-east1`, or zonal like + `us-west1-b`. type: string - content: - format: byte + labels: + description: A key-value pair of the resource's labels (v1) to their values. + type: object + additionalProperties: + type: string + cryptoKeyVersion: description: >- - Output only. The attestation data provided by the HSM when the key - operation was performed. - readOnly: true + The name of the Cloud KMS + [CryptoKeyVersion](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys.cryptoKeyVersions?hl=en) + used to protect this resource via CMEK. This field is empty if the + Google Cloud product owning the resource does not provide key + version data to Asset Inventory. If there are multiple key versions + protecting the resource, then this is same value as the first + element of crypto_key_versions. type: string - certChains: - $ref: >- - #/components/schemas/GoogleCloudKmsV1KeyOperationAttestationCertificateChains + cryptoKeyVersions: description: >- - Output only. The certificate chains needed to validate the - attestation + The names of the Cloud KMS + [CryptoKeyVersion](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys.cryptoKeyVersions?hl=en) + used to protect this resource via CMEK. This field is empty if the + Google Cloud product owning the resource does not provide key + versions data to Asset Inventory. The first element of this field is + stored in crypto_key_version. + type: array + items: + type: string + createTime: + description: >- + Output only. The time at which this resource was created. The + granularity is in seconds. Timestamp.nanos will always be 0. readOnly: true - description: >- - Contains an HSM-generated attestation about a key operation. For more - information, see [Verifying attestations] - (https://cloud.google.com/kms/docs/attest-key). - type: object - id: GoogleCloudKmsV1KeyOperationAttestation + type: string + format: google-datetime parameters: - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean - 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 - fields: - description: Selector specifying which fields to include in a partial response. + access_token: + description: OAuth access token. in: query - name: fields + name: access_token schema: type: string alt: @@ -862,16 +893,25 @@ components: - json - media - proto - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + callback: + description: JSONP in: query - name: uploadType + name: callback schema: type: string - access_token: - description: OAuth access token. + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: access_token + 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: @@ -880,51 +920,58 @@ components: name: oauth_token schema: type: string - callback: - description: JSONP + prettyPrint: + description: Returns response with indentations and line breaks. in: query - name: callback + name: prettyPrint schema: - type: string - _.xgafv: - description: V1 error format. + 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: $.xgafv + name: quotaUser schema: type: string - enum: - - '1' - - '2' upload_protocol: description: Upload protocol for media (e.g. "raw", "multipart"). in: query name: upload_protocol schema: type: string - 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. + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: quotaUser + name: uploadType + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv schema: type: string + enum: + - '1' + - '2' x-stackQL-resources: - protected_resources: - id: google.kmsinventory.protected_resources - name: protected_resources - title: Protected_resources + crypto_keys: + id: google.kmsinventory.crypto_keys + name: crypto_keys + title: Crypto_keys methods: - search: + list: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1protectedResources:search/get + $ref: '#/paths/~1v1~1projects~1{projectsId}~1cryptoKeys/get' response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.cryptoKeys sqlVerbs: - select: [] + select: + - $ref: '#/components/x-stackQL-resources/crypto_keys/methods/list' insert: [] update: [] replace: [] @@ -949,44 +996,44 @@ components: update: [] replace: [] delete: [] - crypto_keys: - id: google.kmsinventory.crypto_keys - name: crypto_keys - title: Crypto_keys + protected_resources: + id: google.kmsinventory.protected_resources + name: protected_resources + title: Protected_resources methods: - list: + search: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1cryptoKeys/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1protectedResources:search/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.cryptoKeys sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/crypto_keys/methods/list' + select: [] insert: [] update: [] replace: [] delete: [] paths: - /v1/organizations/{organizationsId}/protectedResources:search: + /v1/projects/{projectsId}/cryptoKeys: parameters: &ref_1 - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' get: description: >- - Returns metadata about the resources protected by the given Cloud KMS - CryptoKey in the given Cloud organization. - operationId: kmsinventory.organizations.protectedResources.search + Returns cryptographic keys managed by Cloud KMS in a given Cloud + project. Note that this data is sourced from snapshots, meaning it may + not completely reflect the actual state of key metadata at call time. + operationId: kmsinventory.projects.cryptoKeys.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -999,10 +1046,10 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudKmsInventoryV1SearchProtectedResourcesResponse + #/components/schemas/GoogleCloudKmsInventoryV1ListCryptoKeysResponse parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -1011,14 +1058,6 @@ paths: schema: type: integer format: int32 - - in: query - name: resourceTypes - schema: - type: string - - in: query - name: cryptoKey - schema: - type: string - in: query name: pageToken schema: @@ -1067,14 +1106,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/cryptoKeys: + /v1/organizations/{organizationsId}/protectedResources:search: parameters: *ref_1 get: description: >- - Returns cryptographic keys managed by Cloud KMS in a given Cloud - project. Note that this data is sourced from snapshots, meaning it may - not completely reflect the actual state of key metadata at call time. - operationId: kmsinventory.projects.cryptoKeys.list + Returns metadata about the resources protected by the given Cloud KMS + CryptoKey in the given Cloud organization. + operationId: kmsinventory.organizations.protectedResources.search security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1087,15 +1125,15 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudKmsInventoryV1ListCryptoKeysResponse + #/components/schemas/GoogleCloudKmsInventoryV1SearchProtectedResourcesResponse parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string - in: query - name: pageToken + name: cryptoKey schema: type: string - in: query @@ -1103,3 +1141,11 @@ paths: schema: type: integer format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: resourceTypes + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/language.yaml b/providers/src/googleapis.com/v00.00.00000/services/language.yaml index 0f7ac79b..beee574b 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/language.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/language.yaml @@ -10,8 +10,8 @@ info: analysis, entity recognition, entity sentiment analysis, and other text annotations, to developers. version: v2 - x-discovery-doc-revision: '20241103' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250824' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/natural-language/ servers: @@ -25,12 +25,12 @@ components: implicit: authorizationUrl: https://accounts.google.com/o/oauth2/auth scopes: &ref_0 - https://www.googleapis.com/auth/cloud-platform: >- - See, edit, configure, and delete your Google Cloud data and see - the email address for your Google Account. https://www.googleapis.com/auth/cloud-language: >- Apply machine learning models to reveal the structure and meaning of text + 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. Oauth2c: type: oauth2 description: Oauth 2.0 authorization code authentication @@ -40,1066 +40,937 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - XPSTranslationPreprocessResponse: - description: Translation preprocess response. - id: XPSTranslationPreprocessResponse + AnalyzeSentimentRequest: + id: AnalyzeSentimentRequest + description: The sentiment analysis request message. type: object properties: - validExampleCount: - description: Total valid example count. - format: int64 + document: + description: Required. Input document. + $ref: '#/components/schemas/Document' + encodingType: + description: The encoding type used by the API to calculate sentence offsets. type: string - parsedExampleCount: - description: Total example count parsed. + enumDescriptions: + - >- + If `EncodingType` is not specified, encoding-dependent information + (such as `begin_offset`) will be set at `-1`. + - >- + Encoding-dependent information (such as `begin_offset`) is + calculated based on the UTF-8 encoding of the input. C++ and Go + are examples of languages that use this encoding natively. + - >- + Encoding-dependent information (such as `begin_offset`) is + calculated based on the UTF-16 encoding of the input. Java and + JavaScript are examples of languages that use this encoding + natively. + - >- + Encoding-dependent information (such as `begin_offset`) is + calculated based on the UTF-32 encoding of the input. Python is an + example of a language that uses this encoding natively. + enum: + - NONE + - UTF8 + - UTF16 + - UTF32 + Document: + id: Document + description: Represents the input to API methods. + type: object + properties: + type: + description: >- + Required. If the type is not set or is `TYPE_UNSPECIFIED`, returns + an `INVALID_ARGUMENT` error. type: string - format: int64 - XPSTextTrainResponse: - id: XPSTextTrainResponse + enumDescriptions: + - The content type is not specified. + - Plain text + - HTML + enum: + - TYPE_UNSPECIFIED + - PLAIN_TEXT + - HTML + content: + description: >- + The content of the input in string format. Cloud audit logging + exempt since it is based on user data. + type: string + gcsContentUri: + description: >- + The Google Cloud Storage URI where the file content is located. This + URI must be of the form: gs://bucket_name/object_name. For more + details, see https://cloud.google.com/storage/docs/reference-uris. + NOTE: Cloud Storage object versioning is not supported. + type: string + languageCode: + description: >- + Optional. The language of the document (if not specified, the + language is automatically detected). Both ISO and BCP-47 language + codes are accepted. [Language + Support](https://cloud.google.com/natural-language/docs/languages) + lists currently supported languages for each API method. If the + language (either specified by the caller or automatically detected) + is not supported by the called API method, an `INVALID_ARGUMENT` + error is returned. + type: string + AnalyzeSentimentResponse: + id: AnalyzeSentimentResponse + description: The sentiment analysis response message. + type: object properties: - componentModel: + documentSentiment: + description: The overall sentiment of the input document. + $ref: '#/components/schemas/Sentiment' + languageCode: + description: >- + The language of the text, which will be the same as the language + specified in the request or, if not specified, the + automatically-detected language. See Document.language_code field + for more details. + type: string + sentences: + description: The sentiment for all the sentences in the document. type: array items: - $ref: '#/components/schemas/XPSTextComponentModel' - description: Component submodels. + $ref: '#/components/schemas/Sentence' + languageSupported: + description: >- + Whether the language is officially supported. The API may still + return a response when the language is not supported, but it is on a + best effort basis. + type: boolean + Sentiment: + id: Sentiment + description: >- + Represents the feeling associated with the entire text or entities in + the text. type: object - RamMetric: - id: RamMetric + properties: + magnitude: + description: >- + A non-negative number in the [0, +inf] range, which represents the + absolute magnitude of sentiment regardless of score (positive or + negative). + type: number + format: float + score: + description: >- + Sentiment score between -1.0 (negative sentiment) and 1.0 (positive + sentiment). + type: number + format: float + Sentence: + id: Sentence + description: Represents a sentence in the input document. type: object properties: - gibSec: - format: int64 + text: + description: The sentence text. + $ref: '#/components/schemas/TextSpan' + sentiment: + description: >- + For calls to AnalyzeSentiment or if + AnnotateTextRequest.Features.extract_document_sentiment is set to + true, this field will contain the sentiment for the sentence. + $ref: '#/components/schemas/Sentiment' + TextSpan: + id: TextSpan + description: Represents a text span in the input document. + type: object + properties: + content: + description: The content of the text span, which is a substring of the document. type: string + beginOffset: description: >- - Required. VM memory in Gigabyte second, e.g. 3600. Using int64 type - to match billing metrics definition. - machineSpec: + The API calculates the beginning offset of the content in the + original document according to the EncodingType specified in the API + request. + type: integer + format: int32 + AnalyzeEntitiesRequest: + id: AnalyzeEntitiesRequest + description: The entity analysis request message. + type: object + properties: + document: + description: Required. Input document. + $ref: '#/components/schemas/Document' + encodingType: + description: The encoding type used by the API to calculate offsets. + type: string enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' + - >- + If `EncodingType` is not specified, encoding-dependent information + (such as `begin_offset`) will be set at `-1`. + - >- + Encoding-dependent information (such as `begin_offset`) is + calculated based on the UTF-8 encoding of the input. C++ and Go + are examples of languages that use this encoding natively. + - >- + Encoding-dependent information (such as `begin_offset`) is + calculated based on the UTF-16 encoding of the input. Java and + JavaScript are examples of languages that use this encoding + natively. + - >- + Encoding-dependent information (such as `begin_offset`) is + calculated based on the UTF-32 encoding of the input. Python is an + example of a language that uses this encoding natively. + enum: + - NONE + - UTF8 + - UTF16 + - UTF32 + AnalyzeEntitiesResponse: + id: AnalyzeEntitiesResponse + description: The entity analysis response message. + type: object + properties: + entities: + description: The recognized entities in the input document. + type: array + items: + $ref: '#/components/schemas/Entity' + languageCode: + description: >- + The language of the text, which will be the same as the language + specified in the request or, if not specified, the + automatically-detected language. See Document.language_code field + for more details. type: string - description: Required. Machine spec, e.g. N1_STANDARD_4. + languageSupported: + description: >- + Whether the language is officially supported. The API may still + return a response when the language is not supported, but it is on a + best effort basis. + type: boolean + Entity: + id: Entity + description: >- + Represents a phrase in the text that is a known entity, such as a + person, an organization, or location. The API associates information, + such as probability and mentions, with entities. + type: object + properties: + name: + description: The representative name for the entity. + type: string + type: + description: The entity type. + type: string + enumDescriptions: + - Unknown + - Person + - Location + - Organization + - Event + - Artwork + - Consumer product + - Other types of entities + - >- + Phone number The metadata lists the phone number, formatted + according to local convention, plus whichever additional elements + appear in the text: * `number` - the actual number, broken down + into sections as per local convention * `national_prefix` - + country code, if detected * `area_code` - region or area code, if + detected * `extension` - phone extension (to be dialed after + connection), if detected + - >- + Address The metadata identifies the street number and locality + plus whichever additional elements appear in the text: * + `street_number` - street number * `locality` - city or town * + `street_name` - street/route name, if detected * `postal_code` - + postal code, if detected * `country` - country, if detected * + `broad_region` - administrative area, such as the state, if + detected * `narrow_region` - smaller administrative area, such as + county, if detected * `sublocality` - used in Asian addresses to + demark a district within a city, if detected + - >- + Date The metadata identifies the components of the date: * `year` + - four digit year, if detected * `month` - two digit month number, + if detected * `day` - two digit day number, if detected + - Number The metadata is the number itself. + - Price The metadata identifies the `value` and `currency`. enum: - - UNKNOWN_MACHINE_SPEC - - N1_STANDARD_2 - - N1_STANDARD_4 - - N1_STANDARD_8 - - N1_STANDARD_16 - - N1_STANDARD_32 - - N1_STANDARD_64 - - N1_STANDARD_96 - - N1_HIGHMEM_2 - - N1_HIGHMEM_4 - - N1_HIGHMEM_8 - - N1_HIGHMEM_16 - - N1_HIGHMEM_32 - - N1_HIGHMEM_64 - - N1_HIGHMEM_96 - - N1_HIGHCPU_2 - - N1_HIGHCPU_4 - - N1_HIGHCPU_8 - - N1_HIGHCPU_16 - - N1_HIGHCPU_32 - - N1_HIGHCPU_64 - - N1_HIGHCPU_96 - - A2_HIGHGPU_1G - - A2_HIGHGPU_2G - - A2_HIGHGPU_4G - - A2_HIGHGPU_8G - - A2_MEGAGPU_16G - - A2_ULTRAGPU_1G - - A2_ULTRAGPU_2G - - A2_ULTRAGPU_4G - - A2_ULTRAGPU_8G - - A3_HIGHGPU_1G - - A3_HIGHGPU_2G - - A3_HIGHGPU_4G - - A3_HIGHGPU_8G - - A3_MEGAGPU_8G - - E2_STANDARD_2 - - E2_STANDARD_4 - - E2_STANDARD_8 - - E2_STANDARD_16 - - E2_STANDARD_32 - - E2_HIGHMEM_2 - - E2_HIGHMEM_4 - - E2_HIGHMEM_8 - - E2_HIGHMEM_16 - - E2_HIGHCPU_2 - - E2_HIGHCPU_4 - - E2_HIGHCPU_8 - - E2_HIGHCPU_16 - - E2_HIGHCPU_32 - - N2_STANDARD_2 - - N2_STANDARD_4 - - N2_STANDARD_8 - - N2_STANDARD_16 - - N2_STANDARD_32 - - N2_STANDARD_48 - - N2_STANDARD_64 - - N2_STANDARD_80 - - N2_STANDARD_96 - - N2_STANDARD_128 - - N2_HIGHMEM_2 - - N2_HIGHMEM_4 - - N2_HIGHMEM_8 - - N2_HIGHMEM_16 - - N2_HIGHMEM_32 - - N2_HIGHMEM_48 - - N2_HIGHMEM_64 - - N2_HIGHMEM_80 - - N2_HIGHMEM_96 - - N2_HIGHMEM_128 - - N2_HIGHCPU_2 - - N2_HIGHCPU_4 - - N2_HIGHCPU_8 - - N2_HIGHCPU_16 - - N2_HIGHCPU_32 - - N2_HIGHCPU_48 - - N2_HIGHCPU_64 - - N2_HIGHCPU_80 - - N2_HIGHCPU_96 - - N2D_STANDARD_2 - - N2D_STANDARD_4 - - N2D_STANDARD_8 - - N2D_STANDARD_16 - - N2D_STANDARD_32 - - N2D_STANDARD_48 - - N2D_STANDARD_64 - - N2D_STANDARD_80 - - N2D_STANDARD_96 - - N2D_STANDARD_128 - - N2D_STANDARD_224 - - N2D_HIGHMEM_2 - - N2D_HIGHMEM_4 - - N2D_HIGHMEM_8 - - N2D_HIGHMEM_16 - - N2D_HIGHMEM_32 - - N2D_HIGHMEM_48 - - N2D_HIGHMEM_64 - - N2D_HIGHMEM_80 - - N2D_HIGHMEM_96 - - N2D_HIGHCPU_2 - - N2D_HIGHCPU_4 - - N2D_HIGHCPU_8 - - N2D_HIGHCPU_16 - - N2D_HIGHCPU_32 - - N2D_HIGHCPU_48 - - N2D_HIGHCPU_64 - - N2D_HIGHCPU_80 - - N2D_HIGHCPU_96 - - N2D_HIGHCPU_128 - - N2D_HIGHCPU_224 - - C2_STANDARD_4 - - C2_STANDARD_8 - - C2_STANDARD_16 - - C2_STANDARD_30 - - C2_STANDARD_60 - - C2D_STANDARD_2 - - C2D_STANDARD_4 - - C2D_STANDARD_8 - - C2D_STANDARD_16 - - C2D_STANDARD_32 - - C2D_STANDARD_56 - - C2D_STANDARD_112 - - C2D_HIGHCPU_2 - - C2D_HIGHCPU_4 - - C2D_HIGHCPU_8 - - C2D_HIGHCPU_16 - - C2D_HIGHCPU_32 - - C2D_HIGHCPU_56 - - C2D_HIGHCPU_112 - - C2D_HIGHMEM_2 - - C2D_HIGHMEM_4 - - C2D_HIGHMEM_8 - - C2D_HIGHMEM_16 - - C2D_HIGHMEM_32 - - C2D_HIGHMEM_56 - - C2D_HIGHMEM_112 - - G2_STANDARD_4 - - G2_STANDARD_8 - - G2_STANDARD_12 - - G2_STANDARD_16 - - G2_STANDARD_24 - - G2_STANDARD_32 - - G2_STANDARD_48 - - G2_STANDARD_96 - - C3_STANDARD_4 - - C3_STANDARD_8 - - C3_STANDARD_22 - - C3_STANDARD_44 - - C3_STANDARD_88 - - C3_STANDARD_176 - - C3_HIGHCPU_4 - - C3_HIGHCPU_8 - - C3_HIGHCPU_22 - - C3_HIGHCPU_44 - - C3_HIGHCPU_88 - - C3_HIGHCPU_176 - - C3_HIGHMEM_4 - - C3_HIGHMEM_8 - - C3_HIGHMEM_22 - - C3_HIGHMEM_44 - - C3_HIGHMEM_88 - - C3_HIGHMEM_176 - memories: - type: number - format: double - description: Required. VM memory in gb. - ramType: - enumDescriptions: - - '' - - '' - - '' - - COMPUTE_OPTIMIZED - - '' - - '' - - '' - - '' - - '' - - MEMORY_OPTIMIZED_UPGRADE_PREMIUM - - MEMORY_OPTIMIZED - - '' - - '' - - '' - - '' - type: string - description: Required. Type of ram. - enum: - - UNKNOWN_RAM_TYPE - - A2 - - A3 - - C2 - - C2D - - CUSTOM - - E2 - - G2 - - C3 - - M2 - - M1 - - N1 - - N2_CUSTOM - - N2 - - N2D - trackingLabels: + - UNKNOWN + - PERSON + - LOCATION + - ORGANIZATION + - EVENT + - WORK_OF_ART + - CONSUMER_GOOD + - OTHER + - PHONE_NUMBER + - ADDRESS + - DATE + - NUMBER + - PRICE + metadata: + description: >- + Metadata associated with the entity. For the metadata associated + with other entity types, see the Type table below. type: object additionalProperties: type: string + mentions: description: >- - Billing tracking labels. They do not contain any user data but only - the labels set by Vertex Core Infra itself. Tracking labels' keys - are defined with special format: goog-[\p{Ll}\p{N}]+ E.g. "key": - "goog-k8s-cluster-name","value": "us-east1-b4rk" - XPSEvaluationMetricsSet: - type: object - id: XPSEvaluationMetricsSet - properties: - evaluationMetrics: - description: >- - Inline EvaluationMetrics - should be relatively small. For passing - large quantities of exhaustive metrics, use file_spec. + The mentions of this entity in the input document. The API currently + supports proper noun mentions. type: array items: - $ref: '#/components/schemas/XPSEvaluationMetrics' - numEvaluationMetrics: - description: >- - Number of the evaluation metrics (usually one per label plus - overall). - type: string - format: int64 - fileSpec: + $ref: '#/components/schemas/EntityMention' + sentiment: description: >- - File spec containing evaluation metrics of a model, must point to - RecordIO file(s) of intelligence.cloud.automl.xps.EvaluationMetrics - messages. - $ref: '#/components/schemas/XPSFileSpec' - description: Specifies location of model evaluation metrics. - XPSTablesClassificationMetrics: - description: Metrics for Tables classification problems. - type: object - properties: - curveMetrics: - type: array - description: Metrics building a curve. - items: - $ref: '#/components/schemas/XPSTablesClassificationMetricsCurveMetrics' - id: XPSTablesClassificationMetrics - XPSTablesModelStructure: - id: XPSTablesModelStructure + For calls to AnalyzeEntitySentiment this field will contain the + aggregate sentiment expressed for this entity in the provided + document. + $ref: '#/components/schemas/Sentiment' + EntityMention: + id: EntityMention + description: >- + Represents a mention for an entity in the text. Currently, proper noun + mentions are supported. type: object - description: A description of Tables model structure. - properties: - modelParameters: - description: A list of models. - type: array - items: - $ref: '#/components/schemas/XPSTablesModelStructureModelParameters' - Sentence: properties: text: - description: The sentence text. + description: The mention text. $ref: '#/components/schemas/TextSpan' + type: + description: The type of the entity mention. + type: string + enumDescriptions: + - Unknown + - Proper name + - Common noun (or noun compound) + enum: + - TYPE_UNKNOWN + - PROPER + - COMMON sentiment: description: >- - For calls to AnalyzeSentimentRequest or if - AnnotateTextRequest.Features.extract_document_sentiment is set to - true, this field will contain the sentiment for the sentence. + For calls to AnalyzeEntitySentiment this field will contain the + sentiment expressed for this mention of the entity in the provided + document. $ref: '#/components/schemas/Sentiment' + probability: + description: >- + Probability score associated with the entity. The score shows the + probability of the entity mention being the entity type. The score + is in (0, 1] range. + type: number + format: float + ClassifyTextRequest: + id: ClassifyTextRequest + description: The document classification request message. type: object - id: Sentence - description: Represents a sentence in the input document. - XPSTablesClassificationMetricsCurveMetrics: + properties: + document: + description: Required. Input document. + $ref: '#/components/schemas/Document' + ClassifyTextResponse: + id: ClassifyTextResponse + description: The document classification response message. type: object - id: XPSTablesClassificationMetricsCurveMetrics - description: Metrics curve data point for a single value. properties: - value: + categories: + description: Categories representing the input document. + type: array + items: + $ref: '#/components/schemas/ClassificationCategory' + languageCode: + description: >- + The language of the text, which will be the same as the language + specified in the request or, if not specified, the + automatically-detected language. See Document.language_code field + for more details. type: string + languageSupported: description: >- - The CATEGORY row value (for ARRAY unnested) the curve metrics are - for. - positionThreshold: - type: integer - format: int32 - description: The position threshold value used to compute the metrics. - confidenceMetricsEntries: - type: array + Whether the language is officially supported. The API may still + return a response when the language is not supported, but it is on a + best effort basis. + type: boolean + ClassificationCategory: + id: ClassificationCategory + description: Represents a category returned from the text classifier. + type: object + properties: + name: + description: The name of the category representing the document. + type: string + confidence: description: >- - Metrics that have confidence thresholds. Precision-recall curve and - ROC curve can be derived from them. - items: - $ref: '#/components/schemas/XPSTablesConfidenceMetricsEntry' - aucPr: - format: double - type: number - description: The area under the precision-recall curve. - aucRoc: - format: double - description: The area under receiver operating characteristic curve. + The classifier's confidence of the category. Number represents how + certain the classifier is that this category represents the given + text. type: number - logLoss: - description: The Log loss metric. - format: double + format: float + severity: + description: >- + Optional. The classifier's severity of the category. This is only + present when the ModerateTextRequest.ModelVersion is set to + MODEL_VERSION_2, and the corresponding category has a severity + score. type: number - XPSModelArtifactItem: + format: float + ModerateTextRequest: + id: ModerateTextRequest + description: The document moderation request message. + type: object properties: - gcsUri: + document: + description: Required. Input document. + $ref: '#/components/schemas/Document' + modelVersion: + description: Optional. The model version to use for ModerateText. type: string - description: The Google Cloud Storage URI that stores the model binary files. - artifactFormat: enumDescriptions: - - Should not be used. - - >- - The Tensorflow checkpoints. See - https://www.tensorflow.org/guide/checkpoint. - - The Tensorflow SavedModel binary. - - >- - Model artifact in generic TensorFlow Lite (.tflite) format. See - https://www.tensorflow.org/lite. - - Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. + - The default model version. - >- - A [TensorFlow.js](https://www.tensorflow.org/js) model that can be - used in the browser and in Node.js using JavaScript. + Use the v1 model, this model is used by default when not provided. + The v1 model only returns probability (confidence) score for each + category. - >- - Used for iOS mobile devices in (.mlmodel) format. See - https://developer.apple.com/documentation/coreml - description: The model artifact format. + Use the v2 model. The v2 model only returns probability + (confidence) score for each category, and returns severity score + for a subset of the categories. enum: - - ARTIFACT_FORMAT_UNSPECIFIED - - TF_CHECKPOINT - - TF_SAVED_MODEL - - TF_LITE - - EDGE_TPU_TF_LITE - - TF_JS - - CORE_ML - type: string - id: XPSModelArtifactItem - type: object - description: A single model artifact item. - XPSTrackMetricsEntryConfidenceMetricsEntry: + - MODEL_VERSION_UNSPECIFIED + - MODEL_VERSION_1 + - MODEL_VERSION_2 + ModerateTextResponse: + id: ModerateTextResponse + description: The document moderation response message. type: object - id: XPSTrackMetricsEntryConfidenceMetricsEntry properties: - mismatchRate: - description: >- - Output only. Mismatch rate, which measures the tracking consistency, - i.e. correctness of instance ID continuity. - type: number - format: float - confidenceThreshold: + moderationCategories: + description: Harmful and sensitive categories representing the input document. + type: array + items: + $ref: '#/components/schemas/ClassificationCategory' + languageCode: description: >- - Output only. The confidence threshold value used to compute the - metrics. - type: number - format: float - trackingPrecision: - type: number - description: Output only. Tracking precision. - format: float - trackingRecall: - type: number - description: Output only. Tracking recall. - format: float - boundingBoxIou: - type: number - format: float + The language of the text, which will be the same as the language + specified in the request or, if not specified, the + automatically-detected language. See Document.language_code field + for more details. + type: string + languageSupported: description: >- - Output only. Bounding box intersection-over-union precision. - Measures how well the bounding boxes overlap between each other - (e.g. complete overlap or just barely above iou_threshold). - description: 'Metrics for a single confidence threshold. Next tag: 6.' - XPSColorMap: - type: object + Whether the language is officially supported. The API may still + return a response when the language is not supported, but it is on a + best effort basis. + type: boolean + AnnotateTextRequest: + id: AnnotateTextRequest description: >- - Map from color to display name. Will only be used by Image Segmentation - for uCAIP. - id: XPSColorMap + The request message for the text annotation API, which can perform + multiple analysis types in one call. + type: object properties: - intColor: - $ref: '#/components/schemas/XPSColorMapIntColor' - displayName: - type: string - description: Should be used during preprocessing. - annotationSpecIdToken: + document: + description: Required. Input document. + $ref: '#/components/schemas/Document' + features: + description: Required. The enabled features. + $ref: '#/components/schemas/AnnotateTextRequestFeatures' + encodingType: + description: The encoding type used by the API to calculate offsets. type: string - description: Should be used during training. - color: - description: >- - This type is deprecated in favor of the IntColor below. This is - because google.type.Color represent color has a float which - semantically does not reflect discrete classes/categories concept. - Moreover, to handle it well we need to have some tolerance when - converting to a discretized color. As such, the recommendation is to - have API surface still use google.type.Color while internally - IntColor is used. - deprecated: true - $ref: '#/components/schemas/Color' - XPSClassificationEvaluationMetrics: + enumDescriptions: + - >- + If `EncodingType` is not specified, encoding-dependent information + (such as `begin_offset`) will be set at `-1`. + - >- + Encoding-dependent information (such as `begin_offset`) is + calculated based on the UTF-8 encoding of the input. C++ and Go + are examples of languages that use this encoding natively. + - >- + Encoding-dependent information (such as `begin_offset`) is + calculated based on the UTF-16 encoding of the input. Java and + JavaScript are examples of languages that use this encoding + natively. + - >- + Encoding-dependent information (such as `begin_offset`) is + calculated based on the UTF-32 encoding of the input. Python is an + example of a language that uses this encoding natively. + enum: + - NONE + - UTF8 + - UTF16 + - UTF32 + AnnotateTextRequestFeatures: + id: AnnotateTextRequestFeatures description: >- - Model evaluation metrics for classification problems. It can be used for - image and video classification. Next tag: 9. + All available features. Setting each one to true will enable that + specific analysis for the input. + type: object properties: - auRoc: - format: float - type: number - description: >- - The Area Under Receiver Operating Characteristic curve metric. - Micro-averaged for the overall evaluation. - baseAuPrc: - type: number - format: float - description: The Area under precision recall curve metric based on priors. - auPrc: - format: float - description: The Area under precision recall curve metric. - type: number - confusionMatrix: - $ref: '#/components/schemas/XPSConfusionMatrix' - description: >- - Confusion matrix of the evaluation. Only set for MULTICLASS - classification problems where number of annotation specs is no more - than 10. Only set for model level evaluation, not for evaluation per - label. - evaluatedExamplesCount: - description: The number of examples used for model evaluation. - type: integer - format: int32 - logLoss: - type: number - format: float - description: The Log Loss metric. - confidenceMetricsEntries: + extractEntities: + description: Optional. Extract entities. + type: boolean + extractDocumentSentiment: + description: Optional. Extract document-level sentiment. + type: boolean + classifyText: + description: Optional. Classify the full document into categories. + type: boolean + moderateText: description: >- - Metrics that have confidence thresholds. Precision-recall curve can - be derived from it. - items: - $ref: '#/components/schemas/XPSConfidenceMetricsEntry' - type: array + Optional. Moderate the document for harmful and sensitive + categories. + type: boolean + AnnotateTextResponse: + id: AnnotateTextResponse + description: The text annotations response message. type: object - id: XPSClassificationEvaluationMetrics - XPSVideoObjectTrackingEvaluationMetrics: - id: XPSVideoObjectTrackingEvaluationMetrics properties: - boundingBoxMetricsEntries: + sentences: + description: >- + Sentences in the input document. Populated if the user enables + AnnotateTextRequest.Features.extract_document_sentiment. type: array items: - $ref: '#/components/schemas/XPSBoundingBoxMetricsEntry' - description: >- - Output only. The bounding boxes match metrics for each - Intersection-over-union threshold - 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. - trackMetricsEntries: + $ref: '#/components/schemas/Sentence' + entities: description: >- - Output only. The tracks match metrics for each - Intersection-over-union threshold - 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. + Entities, along with their semantic information, in the input + document. Populated if the user enables + AnnotateTextRequest.Features.extract_entities . type: array items: - $ref: '#/components/schemas/XPSTrackMetricsEntry' - trackMeanAveragePrecision: - format: float - description: >- - Output only. The single metric for tracks accuracy evaluation: the - mean_average_precision averaged over all track_metrics_entries. - type: number - evaluatedFrameCount: - format: int32 - description: The number of video frames used for model evaluation. - type: integer - trackMeanMismatchRate: + $ref: '#/components/schemas/Entity' + documentSentiment: description: >- - Output only. The single metric for tracking consistency evaluation: - the mean_mismatch_rate averaged over all track_metrics_entries. - type: number - format: float - evaluatedBoundingboxCount: - type: integer - description: The number of bounding boxes used for model evaluation. - format: int32 - boundingBoxMeanAveragePrecision: - type: number - format: float + The overall sentiment for the document. Populated if the user + enables AnnotateTextRequest.Features.extract_document_sentiment. + $ref: '#/components/schemas/Sentiment' + languageCode: description: >- - Output only. The single metric for bounding boxes evaluation: the - mean_average_precision averaged over all - bounding_box_metrics_entries. - evaluatedTrackCount: - description: The number of tracks used for model evaluation. - format: int32 - type: integer - trackMeanBoundingBoxIou: - format: float + The language of the text, which will be the same as the language + specified in the request or, if not specified, the + automatically-detected language. See Document.language_code field + for more details. + type: string + categories: + description: Categories identified in the input document. + type: array + items: + $ref: '#/components/schemas/ClassificationCategory' + moderationCategories: + description: Harmful and sensitive categories identified in the input document. + type: array + items: + $ref: '#/components/schemas/ClassificationCategory' + languageSupported: description: >- - Output only. The single metric for tracks bounding box iou - evaluation: the mean_bounding_box_iou averaged over all - track_metrics_entries. - type: number - description: 'Model evaluation metrics for ObjectTracking problems. Next tag: 10.' - type: object - XPSTfLiteFormat: - properties: {} + Whether the language is officially supported by all requested + features. The API may still return a response when the language is + not supported, but it is on a best effort basis. + type: boolean + Status: + id: Status description: >- - LINT.IfChange A model format used for mobile and IoT devices. See - https://www.tensorflow.org/lite. + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). type: object - id: XPSTfLiteFormat - XPSResponseExplanationParameters: properties: - xraiAttribution: - $ref: '#/components/schemas/XPSXraiAttribution' - description: >- - An attribution method that redistributes Integrated Gradients - attribution to segmented regions, taking advantage of the model's - fully differentiable structure. Refer to this paper for more - details: https://arxiv.org/abs/1906.02825 XRAI currently performs - better on natural images, like a picture of a house or an animal. If - the images are taken in artificial environments, like a lab or - manufacturing line, or from diagnostic equipment, like x-rays or - quality-control cameras, use Integrated Gradients instead. - integratedGradientsAttribution: - $ref: '#/components/schemas/XPSIntegratedGradientsAttribution' + code: + description: The status code, which should be an enum value of google.rpc.Code. + type: integer + format: int32 + message: description: >- - An attribution method that computes Aumann-Shapley values taking - advantage of the model's fully differentiable structure. Refer to - this paper for more details: https://arxiv.org/abs/1703.01365 - deprecated: true - id: XPSResponseExplanationParameters - type: object - XPSImageModelServingSpecModelThroughputEstimation: - properties: - computeEngineAcceleratorType: - enum: - - UNSPECIFIED - - NVIDIA_TESLA_K80 - - NVIDIA_TESLA_P100 - - NVIDIA_TESLA_V100 - - NVIDIA_TESLA_P4 - - NVIDIA_TESLA_T4 - - NVIDIA_TESLA_A100 - - NVIDIA_A100_80GB - - NVIDIA_L4 - - NVIDIA_H100_80GB - - NVIDIA_H100_MEGA_80GB - - TPU_V2 - - TPU_V3 - - TPU_V4_POD - - TPU_V5_LITEPOD - enumDescriptions: - - '' - - Nvidia Tesla K80 GPU. - - Nvidia Tesla P100 GPU. - - Nvidia Tesla V100 GPU. - - Nvidia Tesla P4 GPU. - - Nvidia Tesla T4 GPU. - - Nvidia Tesla A100 GPU. - - Nvidia A100 80GB GPU. - - Nvidia L4 GPU. - - Nvidia H100 80Gb GPU. - - Nvidia H100 80Gb GPU. - - TPU v2 (JellyFish). - - TPU v3 (DragonFish). - - TPU_v4 (PufferFish). - - TPU v5 Lite Pods. - type: string - latencyInMilliseconds: - type: number - format: double - description: Estimated latency. - nodeQps: - format: double - description: The approximate qps a deployed node can serve. - type: number - servomaticPartitionType: - enumDescriptions: - - '' - - The default partition. - - >- - It has significantly lower replication than partition-0 and is - located in the US only. It also has a larger model size limit and - higher default RAM quota than partition-0. Customers with batch - traffic, US-based traffic, or very large models should use this - partition. Capacity in this partition is significantly cheaper - than partition-0. - - To be used by customers with Jellyfish-accelerated ops. - - The partition used by regionalized servomatic cloud regions. - - The partition used for loading models from custom storage. + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. type: string - enum: - - PARTITION_TYPE_UNSPECIFIED - - PARTITION_ZERO - - PARTITION_REDUCED_HOMING - - PARTITION_JELLYFISH - - PARTITION_CPU - - PARTITION_CUSTOM_STORAGE_CPU - type: object - id: XPSImageModelServingSpecModelThroughputEstimation - XPSSpeechPreprocessStats: - properties: - numLogsExamples: - format: int32 - type: integer - description: The number of samples found in the previously recorded logs data. - dataErrors: + details: + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. type: array - description: Different types of data errors and the counts associated with them. items: - $ref: '#/components/schemas/XPSDataErrors' - testSentencesCount: - type: integer - format: int32 - description: The number of sentences in the test data set. - testExamplesCount: - format: int32 - type: integer - description: The number of examples labelled as TEST by Speech xps server. - testWordsCount: - type: integer - description: The number of words in the test data set. - format: int32 - numMachineTranscribedExamples: - format: int32 - description: The number of rows marked as MACHINE_TRANSCRIBED - type: integer - trainExamplesCount: - description: The number of examples labeled as TRAIN by Speech xps server. - format: int32 - type: integer - trainSentencesCount: - description: The number of sentences in the training data set. - format: int32 - type: integer - trainWordsCount: - description: The number of words in the training data set. - format: int32 - type: integer - numHumanLabeledExamples: - description: The number of rows marked HUMAN_LABELLED - type: integer - format: int32 - id: XPSSpeechPreprocessStats + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + XPSBatchPredictResponse: + id: XPSBatchPredictResponse type: object + properties: + exampleSet: + description: >- + Examples for batch prediction result. Under full API implementation, + results are stored in shared RecordIO of AnnotatedExample protobufs, + the annotations field of which is populated by XPS backend. + $ref: '#/components/schemas/XPSExampleSet' XPSExampleSet: + id: XPSExampleSet description: Set of examples or input sources. type: object - id: XPSExampleSet properties: fileSpec: - $ref: '#/components/schemas/XPSFileSpec' description: File spec of the examples or input sources. + $ref: '#/components/schemas/XPSFileSpec' numExamples: description: Number of examples. type: string format: int64 + numInputSources: + description: Number of input sources. + type: string + format: int64 fingerprint: description: Fingerprint of the example set. - format: int64 type: string - numInputSources: format: int64 - type: string - description: Number of input sources. - XPSBoundingBoxMetricsEntry: - id: XPSBoundingBoxMetricsEntry + XPSFileSpec: + id: XPSFileSpec + description: >- + Spec of input and output files, on external file systems (for example, + Colossus Namespace System or Google Cloud Storage). + type: object properties: - iouThreshold: - type: number - description: >- - The intersection-over-union threshold value used to compute this - metrics entry. - format: float - confidenceMetricsEntries: - description: >- - Metrics for each label-match confidence_threshold from - 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. - type: array - items: - $ref: >- - #/components/schemas/XPSBoundingBoxMetricsEntryConfidenceMetricsEntry - meanAveragePrecision: - description: The mean average precision. - type: number - format: float - type: object - description: >- - Bounding box matching model metrics for a single intersection-over-union - threshold and multiple label match confidence thresholds. - XPSResponseExplanationMetadata: - id: XPSResponseExplanationMetadata - type: object - properties: - outputs: - additionalProperties: - $ref: '#/components/schemas/XPSResponseExplanationMetadataOutputMetadata' - description: Metadata of the output. - type: object - inputs: - description: Metadata of the input. - type: object - additionalProperties: - $ref: '#/components/schemas/XPSResponseExplanationMetadataInputMetadata' - deprecated: true - XPSTimestampStatsGranularStats: - id: XPSTimestampStatsGranularStats - type: object - description: Stats split by a defined in context granularity. - properties: - buckets: - type: object - additionalProperties: - type: string - format: int64 - description: >- - A map from granularity key to example count for that key. E.g. for - hour_of_day `13` means 1pm, or for month_of_year `5` means May). - XPSResponseExplanationMetadataInputMetadata: - properties: - visualizationConfig: - $ref: '#/components/schemas/XPSVisualization' - description: Visualization configurations for image explanation. - inputTensorName: - type: string - description: >- - Name of the input tensor for this model. Only needed in train - response. - modality: + fileFormat: type: string - description: >- - Modality of the feature. Valid values are: numeric, image. Defaults - to numeric. enumDescriptions: - '' - '' + - Internal format for parallel text data used by Google Translate. - '' + - >- + Only the lexicographically first file described by the file_spec + contains the header line. - '' + enumDeprecated: + - false + - true + - false + - false + - false + - false enum: - - MODALITY_UNSPECIFIED - - NUMERIC - - IMAGE - - CATEGORICAL - id: XPSResponseExplanationMetadataInputMetadata - description: Metadata of the input of a feature. + - FILE_FORMAT_UNKNOWN + - FILE_FORMAT_SSTABLE + - FILE_FORMAT_TRANSLATION_RKV + - FILE_FORMAT_RECORDIO + - FILE_FORMAT_RAW_CSV + - FILE_FORMAT_RAW_CAPACITOR + directoryPath: + description: Deprecated. Use file_spec. + deprecated: true + type: string + singleFilePath: + description: Deprecated. Use file_spec. + deprecated: true + type: string + fileSpec: + description: >- + Single file path, or file pattern of format + "/path/to/file@shard_count". E.g. /cns/cell-d/somewhere/file@2 is + expanded to two files: /cns/cell-d/somewhere/file-00000-of-00002 and + /cns/cell-d/somewhere/file-00001-of-00002. + type: string + XPSPreprocessResponse: + id: XPSPreprocessResponse type: object - Status: + properties: + outputExampleSet: + description: >- + Preprocessed examples, that are to be imported into AutoML storage. + This should point to RecordIO file(s) of PreprocessedExample + messages. The PreprocessedExample.mvp_training_data-s returned here + are later verbatim passed to Train() call in + TrainExample.mvp_training_data. + $ref: '#/components/schemas/XPSExampleSet' + speechPreprocessResp: + $ref: '#/components/schemas/XPSSpeechPreprocessResponse' + translationPreprocessResp: + $ref: '#/components/schemas/XPSTranslationPreprocessResponse' + tablesPreprocessResponse: + $ref: '#/components/schemas/XPSTablesPreprocessResponse' + XPSSpeechPreprocessResponse: + id: XPSSpeechPreprocessResponse type: object - id: Status - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). properties: - message: + speechPreprocessStats: + description: Stats associated with the data. + $ref: '#/components/schemas/XPSSpeechPreprocessStats' + cnsTrainDataPath: description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. + Location of shards of sstables (training data) of DataUtterance + protos. type: string - details: - items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - type: array + cnsTestDataPath: + description: Location od shards of sstables (test data) of DataUtterance protos. + type: string + prebuiltModelEvaluationMetrics: description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - code: - description: The status code, which should be an enum value of google.rpc.Code. + The metrics for prebuilt speech models. They are included here + because there is no prebuilt speech models stored in the AutoML. + $ref: '#/components/schemas/XPSSpeechEvaluationMetrics' + XPSSpeechPreprocessStats: + id: XPSSpeechPreprocessStats + type: object + properties: + trainExamplesCount: + description: The number of examples labeled as TRAIN by Speech xps server. + type: integer format: int32 + testExamplesCount: + description: The number of examples labelled as TEST by Speech xps server. type: integer - AnalyzeEntitiesRequest: - id: AnalyzeEntitiesRequest + format: int32 + numMachineTranscribedExamples: + description: The number of rows marked as MACHINE_TRANSCRIBED + type: integer + format: int32 + numHumanLabeledExamples: + description: The number of rows marked HUMAN_LABELLED + type: integer + format: int32 + numLogsExamples: + description: The number of samples found in the previously recorded logs data. + type: integer + format: int32 + dataErrors: + description: Different types of data errors and the counts associated with them. + type: array + items: + $ref: '#/components/schemas/XPSDataErrors' + trainSentencesCount: + description: The number of sentences in the training data set. + type: integer + format: int32 + testSentencesCount: + description: The number of sentences in the test data set. + type: integer + format: int32 + trainWordsCount: + description: The number of words in the training data set. + type: integer + format: int32 + testWordsCount: + description: The number of words in the test data set. + type: integer + format: int32 + XPSDataErrors: + id: XPSDataErrors + description: Different types of errors and the stats associatesd with each error. + type: object properties: - document: - description: Required. Input document. - $ref: '#/components/schemas/Document' - encodingType: - description: The encoding type used by the API to calculate offsets. + errorType: + description: Type of the error. type: string - enum: - - NONE - - UTF8 - - UTF16 - - UTF32 enumDescriptions: + - Not specified. - >- - If `EncodingType` is not specified, encoding-dependent information - (such as `begin_offset`) will be set at `-1`. - - >- - Encoding-dependent information (such as `begin_offset`) is - calculated based on the UTF-8 encoding of the input. C++ and Go - are examples of languages that use this encoding natively. - - >- - Encoding-dependent information (such as `begin_offset`) is - calculated based on the UTF-16 encoding of the input. Java and - JavaScript are examples of languages that use this encoding - natively. + Audio format not in the formats by cloud-speech AutoML. Currently + only wav and flac file formats are supported. - >- - Encoding-dependent information (such as `begin_offset`) is - calculated based on the UTF-32 encoding of the input. Python is an - example of a language that uses this encoding natively. - description: The entity analysis request message. - type: object - XPSTablesModelColumnInfo: - id: XPSTablesModelColumnInfo - description: >- - An information specific to given column and Tables Model, in context of - the Model and the predictions created by it. + File format differnt from what is specified in the file name + extension. + - File too large. Maximum allowed size is 50 MB. + - Transcript is missing. + enum: + - ERROR_TYPE_UNSPECIFIED + - UNSUPPORTED_AUDIO_FORMAT + - FILE_EXTENSION_MISMATCH_WITH_AUDIO_FORMAT + - FILE_TOO_LARGE + - MISSING_TRANSCRIPTION + count: + description: Number of records having errors associated with the enum. + type: integer + format: int32 + XPSSpeechEvaluationMetrics: + id: XPSSpeechEvaluationMetrics type: object properties: - featureImportance: - description: >- - When given as part of a Model: Measurement of how much model - predictions correctness on the TEST data depend on values in this - column. A value between 0 and 1, higher means higher influence. - These values are normalized - for all input feature columns of a - given model they add to 1. When given back by Predict or Batch - Predict: Measurement of how impactful for the prediction returned - for the given row the value in this column was. Specifically, the - feature importance specifies the marginal contribution that the - feature made to the prediction score compared to the baseline score. - These values are computed using the Sampled Shapley method. - format: float + subModelEvaluationMetrics: + description: Evaluation metrics for all submodels contained in this model. + type: array + items: + $ref: >- + #/components/schemas/XPSSpeechEvaluationMetricsSubModelEvaluationMetric + XPSSpeechEvaluationMetricsSubModelEvaluationMetric: + id: XPSSpeechEvaluationMetricsSubModelEvaluationMetric + type: object + properties: + wer: + description: Word error rate (standard error metric used for speech recognition). type: number - columnId: + format: double + numWords: + description: Number of words over which the word error rate was computed. type: integer - description: The ID of the column. format: int32 - XPSDataType: + numUtterances: + description: Number of utterances used in the wer computation. + type: integer + format: int32 + sentenceAccuracy: + description: Below fields are used for debugging purposes + type: number + format: double + numInsertions: + type: integer + format: int32 + numSubstitutions: + type: integer + format: int32 + numDeletions: + type: integer + format: int32 + biasingModelType: + description: Type of the biasing model. + type: string + enumDescriptions: + - '' + - Build biasing model on top of COMMAND_AND_SEARCH model + - Build biasing model on top of PHONE_CALL model + - Build biasing model on top of VIDEO model + - Build biasing model on top of DEFAULT model + enum: + - BIASING_MODEL_TYPE_UNSPECIFIED + - COMMAND_AND_SEARCH + - PHONE_CALL + - VIDEO + - DEFAULT + isEnhancedModel: + description: >- + If true then it means we have an enhanced version of the biasing + models. + type: boolean + XPSTranslationPreprocessResponse: + id: XPSTranslationPreprocessResponse + description: Translation preprocess response. type: object - id: XPSDataType properties: - compatibleDataTypes: - description: The highly compatible data types to this data type. - type: array - items: - $ref: '#/components/schemas/XPSDataType' - timeFormat: + parsedExampleCount: + description: Total example count parsed. + type: string + format: int64 + validExampleCount: + description: Total valid example count. type: string + format: int64 + XPSTablesPreprocessResponse: + id: XPSTablesPreprocessResponse + type: object + properties: + tablesDatasetMetadata: description: >- - If type_code == TIMESTAMP then `time_format` provides the format in - which that time field is expressed. The time_format must be written - in `strftime` syntax. If time_format is not set, then the default - format as described on the field is used. - structType: + The table/column id, column_name and the DataTypes of the columns + will be populated. + $ref: '#/components/schemas/XPSTablesDatasetMetadata' + XPSTablesDatasetMetadata: + id: XPSTablesDatasetMetadata + description: Metadata for a dataset used for AutoML Tables. + type: object + properties: + primaryTableSpec: + description: Primary table. + $ref: '#/components/schemas/XPSTableSpec' + targetColumnId: description: >- - If type_code == STRUCT, then `struct_type` provides type information - for the struct's fields. - $ref: '#/components/schemas/XPSStructType' - typeCode: - enum: - - TYPE_CODE_UNSPECIFIED - - FLOAT64 - - TIMESTAMP - - STRING - - ARRAY - - STRUCT - - CATEGORY + Id of the primary table column that should be used as the training + label. + type: integer + format: int32 + weightColumnId: + description: >- + Id of the primary table column that should be used as the weight + column. + type: integer + format: int32 + mlUseColumnId: + description: Id the column to split the table. + type: integer + format: int32 + targetColumnCorrelations: + description: '(the column id : its CorrelationStats with target column).' + type: object + additionalProperties: + $ref: '#/components/schemas/XPSCorrelationStats' + XPSTableSpec: + id: XPSTableSpec + type: object + properties: + timeColumnId: + description: The id of the time column. + type: integer + format: int32 + rowCount: + description: The number of rows in the table. + type: string + format: int64 + validRowCount: + description: The number of valid rows. + type: string + format: int64 + columnSpecs: + description: Mapping from column id to column spec. + type: object + additionalProperties: + $ref: '#/components/schemas/XPSColumnSpec' + importedDataSizeInBytes: + description: The total size of imported data of the table. + type: string + format: int64 + XPSColumnSpec: + id: XPSColumnSpec + type: object + properties: + columnId: + description: >- + The unique id of the column. When Preprocess, the Tables BE will + popuate the order id of the column, which reflects the order of the + column inside the table, i.e. 0 means the first column in the table, + N-1 means the last column. AutoML BE will persist this order id in + Spanner and set the order id here when calling RefreshTablesStats + and Train. Note: it's different than the column_spec_id that is + generated in AutoML BE. + type: integer + format: int32 + displayName: + description: >- + The display name of the column. It's outputed in Preprocess and a + required input for RefreshTablesStats and Train. type: string + dataType: + description: >- + The data type of the column. It's outputed in Preprocess rpc and a + required input for RefreshTablesStats and Train. + $ref: '#/components/schemas/XPSDataType' + dataStats: + description: >- + The data stats of the column. It's outputed in RefreshTablesStats + and a required input for Train. + $ref: '#/components/schemas/XPSDataStats' + topCorrelatedColumns: + description: It's outputed in RefreshTablesStats, and a required input in Train. + type: array + items: + $ref: '#/components/schemas/XPSColumnSpecCorrelatedColumn' + forecastingMetadata: + $ref: '#/components/schemas/XPSColumnSpecForecastingMetadata' + XPSDataType: + id: XPSDataType + description: >- + Indicated the type of data that can be stored in a structured data + entity (e.g. a table). + type: object + properties: + typeCode: description: Required. The TypeCode for this type. + type: string enumDescriptions: - Not specified. Should not be used. - >- @@ -1123,397 +994,1196 @@ components: FLOAT64), or is unable to say if one value contains another (as it could with STRING). Encoded as `string` (bytes should be base64-encoded, as described in RFC 4648, section 4). + enum: + - TYPE_CODE_UNSPECIFIED + - FLOAT64 + - TIMESTAMP + - STRING + - ARRAY + - STRUCT + - CATEGORY + nullable: + description: If true, this DataType can also be `null`. + type: boolean listElementType: description: >- If type_code == ARRAY, then `list_element_type` is the type of the elements. $ref: '#/components/schemas/XPSDataType' - nullable: - description: If true, this DataType can also be `null`. - type: boolean - description: >- - Indicated the type of data that can be stored in a structured data - entity (e.g. a table). - XPSVisualization: + structType: + description: >- + If type_code == STRUCT, then `struct_type` provides type information + for the struct's fields. + $ref: '#/components/schemas/XPSStructType' + timeFormat: + description: >- + If type_code == TIMESTAMP then `time_format` provides the format in + which that time field is expressed. The time_format must be written + in `strftime` syntax. If time_format is not set, then the default + format as described on the field is used. + type: string + compatibleDataTypes: + description: The highly compatible data types to this data type. + type: array + items: + $ref: '#/components/schemas/XPSDataType' + XPSStructType: + id: XPSStructType + description: '`StructType` defines the DataType-s of a STRUCT type.' type: object - deprecated: true - id: XPSVisualization - description: Visualization configurations for image explanation. properties: - type: - type: string - enum: - - TYPE_UNSPECIFIED - - PIXELS - - OUTLINES - description: >- - Type of the image visualization. Only applicable to Integrated - Gradients attribution. OUTLINES shows regions of attribution, while - PIXELS shows per-pixel attribution. Defaults to OUTLINES. - enumDescriptions: - - Should not be used. - - Shows which pixel contributed to the image prediction. - - >- - Shows which region contributed to the image prediction by - outlining the region. - colorMap: - enumDescriptions: - - Should not be used. - - 'Positive: green. Negative: pink.' - - >- - Viridis color map: A perceptually uniform color mapping which is - easier to see by those with colorblindness and progresses from - yellow to green to blue. Positive: yellow. Negative: blue. - - 'Positive: red. Negative: red.' - - 'Positive: green. Negative: green.' - - 'Positive: green. Negative: red.' - - PiYG palette. - description: >- - The color scheme used for the highlighted areas. Defaults to - PINK_GREEN for Integrated Gradients attribution, which shows - positive attributions in green and negative in pink. Defaults to - VIRIDIS for XRAI attribution, which highlights the most influential - regions in yellow and the least influential in blue. - enum: - - COLOR_MAP_UNSPECIFIED - - PINK_GREEN - - VIRIDIS - - RED - - GREEN - - RED_GREEN - - PINK_WHITE_GREEN - type: string - clipPercentLowerbound: - type: number - format: float - description: >- - Excludes attributions below the specified percentile, from the - highlighted areas. Defaults to 62. - overlayType: - enumDescriptions: - - Default value. This is the same as NONE. - - No overlay. - - The attributions are shown on top of the original image. - - >- - The attributions are shown on top of grayscaled version of the - original image. - - >- - The attributions are used as a mask to reveal predictive parts of - the image and hide the un-predictive parts. - enum: - - OVERLAY_TYPE_UNSPECIFIED - - NONE - - ORIGINAL - - GRAYSCALE - - MASK_BLACK - description: >- - How the original image is displayed in the visualization. Adjusting - the overlay can help increase visual clarity if the original image - makes it difficult to view the visualization. Defaults to NONE. - type: string - polarity: - enumDescriptions: - - Default value. This is the same as POSITIVE. - - >- - Highlights the pixels/outlines that were most influential to the - model's prediction. - - >- - Setting polarity to negative highlights areas that does not lead - to the models's current prediction. - - Shows both positive and negative attributions. - type: string - enum: - - POLARITY_UNSPECIFIED - - POSITIVE - - NEGATIVE - - BOTH - description: >- - Whether to only highlight pixels with positive contributions, - negative or both. Defaults to POSITIVE. - clipPercentUpperbound: - format: float - description: >- - Excludes attributions above the specified percentile from the - highlighted areas. Using the clip_percent_upperbound and - clip_percent_lowerbound together can be useful for filtering out - noise and making it easier to see areas of strong attribution. - Defaults to 99.9. - type: number - XPSDockerFormat: + fields: + description: Unordered map of struct field names to their data types. + type: object + additionalProperties: + $ref: '#/components/schemas/XPSDataType' + XPSDataStats: + id: XPSDataStats + description: The data statistics of a series of values that share the same DataType. type: object - description: >- - A model format used for Docker containers. Use the params field to - customize the container. The container is verified to work correctly on - ubuntu 16.04 operating system. properties: - gpuArchitecture: - enum: - - GPU_ARCHITECTURE_UNSPECIFIED - - GPU_ARCHITECTURE_NVIDIA - description: >- - Optional. Additional gpu information describing the requirements for - the to be exported model files. - enumDescriptions: - - '' - - '' + distinctValueCount: + description: The number of distinct values. type: string - cpuArchitecture: + format: int64 + nullValueCount: + description: The number of values that are null. type: string - description: >- - Optional. Additional cpu information describing the requirements for - the to be exported model files. - enum: - - CPU_ARCHITECTURE_UNSPECIFIED - - CPU_ARCHITECTURE_X86_64 - enumDescriptions: - - '' - - '' - id: XPSDockerFormat - XPSTrackMetricsEntry: + format: int64 + validValueCount: + description: The number of values that are valid. + type: string + format: int64 + float64Stats: + description: The statistics for FLOAT64 DataType. + $ref: '#/components/schemas/XPSFloat64Stats' + stringStats: + description: The statistics for STRING DataType. + $ref: '#/components/schemas/XPSStringStats' + timestampStats: + description: The statistics for TIMESTAMP DataType. + $ref: '#/components/schemas/XPSTimestampStats' + arrayStats: + description: The statistics for ARRAY DataType. + $ref: '#/components/schemas/XPSArrayStats' + structStats: + description: The statistics for STRUCT DataType. + $ref: '#/components/schemas/XPSStructStats' + categoryStats: + description: The statistics for CATEGORY DataType. + $ref: '#/components/schemas/XPSCategoryStats' + XPSFloat64Stats: + id: XPSFloat64Stats + description: The data statistics of a series of FLOAT64 values. + type: object properties: - meanBoundingBoxIou: + mean: + description: The mean of the series. type: number + format: double + standardDeviation: + description: The standard deviation of the series. + type: number + format: double + quantiles: description: >- - Output only. The mean bounding box iou over all confidence - thresholds. - format: float - confidenceMetricsEntries: + Ordered from 0 to k k-quantile values of the data series of n + values. The value at index i is, approximately, the i*n/k-th + smallest value in the series; for i = 0 and i = k these are, + respectively, the min and max values. type: array - description: >- - Output only. Metrics for each label-match confidence_threshold from - 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. Precision-recall curve is - derived from them. items: - $ref: '#/components/schemas/XPSTrackMetricsEntryConfidenceMetricsEntry' - meanMismatchRate: - description: Output only. The mean mismatch rate over all confidence thresholds. - format: float - type: number - meanTrackingAveragePrecision: - format: float - description: >- - Output only. The mean average precision over all confidence - thresholds. - type: number - iouThreshold: - format: float + type: number + format: double + histogramBuckets: description: >- - Output only. The intersection-over-union threshold value between - bounding boxes across frames used to compute this metric entry. - type: number - type: object - id: XPSTrackMetricsEntry - description: >- - Track matching model metrics for a single track match threshold and - multiple label match confidence thresholds. Next tag: 6. + Histogram buckets of the data series. Sorted by the min value of the + bucket, ascendingly, and the number of the buckets is dynamically + generated. The buckets are non-overlapping and completely cover + whole FLOAT64 range with min of first bucket being `"-Infinity"`, + and max of the last one being `"Infinity"`. + type: array + items: + $ref: '#/components/schemas/XPSFloat64StatsHistogramBucket' + commonStats: + $ref: '#/components/schemas/XPSCommonStats' XPSFloat64StatsHistogramBucket: id: XPSFloat64StatsHistogramBucket - type: object description: A bucket of a histogram. + type: object properties: - count: - description: >- - The number of data values that are in the bucket, i.e. are between - min and max values. - format: int64 - type: string min: + description: The minimum value of the bucket, inclusive. type: number format: double - description: The minimum value of the bucket, inclusive. max: - format: double description: >- The maximum value of the bucket, exclusive unless max = `"Infinity"`, in which case it's inclusive. type: number - XPSMetricEntryLabel: + format: double + count: + description: >- + The number of data values that are in the bucket, i.e. are between + min and max values. + type: string + format: int64 + XPSCommonStats: + id: XPSCommonStats + description: Common statistics for a column with a specified data type. + type: object properties: - labelName: + distinctValueCount: type: string - description: The name of the label. - labelValue: + format: int64 + validValueCount: type: string - description: The value of the label. - id: XPSMetricEntryLabel + format: int64 + nullValueCount: + type: string + format: int64 + XPSStringStats: + id: XPSStringStats + description: The data statistics of a series of STRING values. type: object - XPSExportModelOutputConfig: properties: - tfLiteFormat: - $ref: '#/components/schemas/XPSTfLiteFormat' - edgeTpuTfLiteFormat: - $ref: '#/components/schemas/XPSEdgeTpuTfLiteFormat' - coreMlFormat: - $ref: '#/components/schemas/XPSCoreMlFormat' - tfSavedModelFormat: - $ref: '#/components/schemas/XPSTfSavedModelFormat' - outputGcrUri: + topUnigramStats: description: >- - The Google Contained Registry path the exported files to be pushed - to. This location is set if the exported format is DOCKDER. + The statistics of the top 20 unigrams, ordered by + StringStats.UnigramStats.count. + type: array + items: + $ref: '#/components/schemas/XPSStringStatsUnigramStats' + commonStats: + $ref: '#/components/schemas/XPSCommonStats' + XPSStringStatsUnigramStats: + id: XPSStringStatsUnigramStats + description: The statistics of a unigram. + type: object + properties: + value: + description: The unigram. type: string - exportFirebaseAuxiliaryInfo: - type: boolean + count: + description: The number of occurrences of this unigram in the series. + type: string + format: int64 + XPSTimestampStats: + id: XPSTimestampStats + description: The data statistics of a series of TIMESTAMP values. + type: object + properties: + granularStats: description: >- - For any model and format: If true, will additionally export - FirebaseExportedModelInfo in a firebase.txt file. - dockerFormat: - $ref: '#/components/schemas/XPSDockerFormat' - outputGcsUri: + The string key is the pre-defined granularity. Currently supported: + hour_of_day, day_of_week, month_of_year. Granularities finer that + the granularity of timestamp data are not populated (e.g. if + timestamps are at day granularity, then hour_of_day is not + populated). + type: object + additionalProperties: + $ref: '#/components/schemas/XPSTimestampStatsGranularStats' + commonStats: + $ref: '#/components/schemas/XPSCommonStats' + medianTimestampNanos: type: string + format: int64 + XPSTimestampStatsGranularStats: + id: XPSTimestampStatsGranularStats + description: Stats split by a defined in context granularity. + type: object + properties: + buckets: description: >- - The Google Cloud Storage directory where XPS will output the - exported models and related files. Format: gs://bucket/directory - tfJsFormat: - $ref: '#/components/schemas/XPSTfJsFormat' - id: XPSExportModelOutputConfig + A map from granularity key to example count for that key. E.g. for + hour_of_day `13` means 1pm, or for month_of_year `5` means May). + type: object + additionalProperties: + type: string + format: int64 + XPSArrayStats: + id: XPSArrayStats + description: The data statistics of a series of ARRAY values. type: object - XPSVideoActionRecognitionEvaluationMetrics: - id: XPSVideoActionRecognitionEvaluationMetrics properties: - videoActionMetricsEntries: - items: - $ref: '#/components/schemas/XPSVideoActionMetricsEntry' - type: array + memberStats: description: >- - Output only. The metric entries for precision window lengths: - 1s,2s,3s,4s, 5s. - evaluatedActionCount: + Stats of all the values of all arrays, as if they were a single long + series of data. The type depends on the element type of the array. + $ref: '#/components/schemas/XPSDataStats' + commonStats: + $ref: '#/components/schemas/XPSCommonStats' + XPSStructStats: + id: XPSStructStats + description: The data statistics of a series of STRUCT values. + type: object + properties: + fieldStats: description: >- - Output only. The number of ground truth actions used to create this - evaluation. - type: integer - format: int32 + Map from a field name of the struct to data stats aggregated over + series of all data in that field across all the structs. + type: object + additionalProperties: + $ref: '#/components/schemas/XPSDataStats' + commonStats: + $ref: '#/components/schemas/XPSCommonStats' + XPSCategoryStats: + id: XPSCategoryStats + description: The data statistics of a series of CATEGORY values. type: object - description: Model evaluation metrics for video action recognition. - XPSXpsOperationMetadata: - id: XPSXpsOperationMetadata + properties: + topCategoryStats: + description: >- + The statistics of the top 20 CATEGORY values, ordered by + CategoryStats.SingleCategoryStats.count. + type: array + items: + $ref: '#/components/schemas/XPSCategoryStatsSingleCategoryStats' + commonStats: + $ref: '#/components/schemas/XPSCommonStats' + XPSCategoryStatsSingleCategoryStats: + id: XPSCategoryStatsSingleCategoryStats + description: The statistics of a single CATEGORY value. type: object properties: - exampleCount: + value: + description: The CATEGORY value. + type: string + count: + description: The number of occurrences of this value in the series. type: string - description: >- - Optional. XPS server can opt to provide example count of the long - running operation (e.g. training, data importing, batch prediction). format: int64 - tablesTrainingOperationMetadata: - $ref: '#/components/schemas/XPSTablesTrainingOperationMetadata' - videoTrainingOperationMetadata: - $ref: '#/components/schemas/XPSVideoTrainingOperationMetadata' - videoBatchPredictOperationMetadata: - $ref: '#/components/schemas/XPSVideoBatchPredictOperationMetadata' - visionTrainingOperationMetadata: - $ref: '#/components/schemas/XPSVisionTrainingOperationMetadata' - reportingMetrics: - description: >- - Metrics for the operation. By the time the operation is terminated - (whether succeeded or failed) as returned from XPS, AutoML BE - assumes the metrics are finalized. AutoML BE transparently posts the - metrics to Chemist if it's not empty, regardless of the response - content or error type. If user is supposed to be charged in case of - cancellation/error, this field should be set. In the case where the - type of LRO doesn't require any billing, this field should be left - unset. - $ref: '#/components/schemas/XPSReportingMetrics' - Document: + XPSColumnSpecCorrelatedColumn: + id: XPSColumnSpecCorrelatedColumn + description: >- + Identifies a table's column, and its correlation with the column this + ColumnSpec describes. type: object - description: Represents the input to API methods. properties: - gcsContentUri: - description: >- - The Google Cloud Storage URI where the file content is located. This - URI must be of the form: gs://bucket_name/object_name. For more - details, see https://cloud.google.com/storage/docs/reference-uris. - NOTE: Cloud Storage object versioning is not supported. - type: string - type: + columnId: + type: integer + format: int32 + correlationStats: + $ref: '#/components/schemas/XPSCorrelationStats' + XPSCorrelationStats: + id: XPSCorrelationStats + description: >- + A correlation statistics between two series of DataType values. The + series may have differing DataType-s, but within a single series the + DataType must be the same. + type: object + properties: + cramersV: + description: The correlation value using the Cramer's V measure. + type: number + format: double + XPSColumnSpecForecastingMetadata: + id: XPSColumnSpecForecastingMetadata + type: object + properties: + columnType: + description: The type of the column for FORECASTING model training purposes. type: string enumDescriptions: - - The content type is not specified. - - Plain text - - HTML - description: >- - Required. If the type is not set or is `TYPE_UNSPECIFIED`, returns - an `INVALID_ARGUMENT` error. + - An un-set value of this enum. + - Key columns are used to identify timeseries. + - >- + This column contains information describing static properties of + the entities identified by the key column(s) (e.g. city's ZIP + code). + - >- + This column contains information for the given entity, at any time + poinrt, they are only available in the time series before. + - >- + This column contains information for the given entity is known + both for the past and the sufficiently far future. enum: - - TYPE_UNSPECIFIED - - PLAIN_TEXT - - HTML - languageCode: - type: string - description: >- - Optional. The language of the document (if not specified, the - language is automatically detected). Both ISO and BCP-47 language - codes are accepted. [Language - Support](https://cloud.google.com/natural-language/docs/languages) - lists currently supported languages for each API method. If the - language (either specified by the caller or automatically detected) - is not supported by the called API method, an `INVALID_ARGUMENT` - error is returned. - content: - description: >- - The content of the input in string format. Cloud audit logging - exempt since it is based on user data. - type: string - id: Document - GpuMetric: + - COLUMN_TYPE_UNSPECIFIED + - KEY + - KEY_METADATA + - TIME_SERIES_AVAILABLE_PAST_ONLY + - TIME_SERIES_AVAILABLE_PAST_AND_FUTURE + XPSTrainResponse: + id: XPSTrainResponse type: object properties: - gpuType: - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - description: Required. Type of GPU, e.g. NVIDIA_TESLA_V100. + modelToken: + description: >- + Token that represents the trained model. This is considered + immutable and is persisted in AutoML. xPS can put their own proto in + the byte string, to e.g. point to the model checkpoints. The token + is passed to other xPS APIs to refer to the model. type: string - enum: - - UNKNOWN_GPU_TYPE - - NVIDIA_TESLA_A100 - - NVIDIA_A100_80GB - - NVIDIA_TESLA_K80 - - NVIDIA_L4 - - NVIDIA_TESLA_P100 - - NVIDIA_TESLA_P4 - - NVIDIA_TESLA_T4 - - NVIDIA_TESLA_V100 - - NVIDIA_H100_80GB - gpuSec: + format: byte + speechTrainResp: + $ref: '#/components/schemas/XPSSpeechModelSpec' + tablesTrainResp: + $ref: '#/components/schemas/XPSTablesTrainResponse' + imageObjectDetectionTrainResp: + $ref: '#/components/schemas/XPSImageObjectDetectionModelSpec' + textToSpeechTrainResp: + $ref: '#/components/schemas/XPSTextToSpeechTrainResponse' + videoObjectTrackingTrainResp: + $ref: '#/components/schemas/XPSVideoObjectTrackingTrainResponse' + videoClassificationTrainResp: + $ref: '#/components/schemas/XPSVideoClassificationTrainResponse' + videoActionRecognitionTrainResp: + $ref: '#/components/schemas/XPSVideoActionRecognitionTrainResponse' + imageClassificationTrainResp: + $ref: '#/components/schemas/XPSImageClassificationTrainResponse' + translationTrainResp: + $ref: '#/components/schemas/XPSTranslationTrainResponse' + imageSegmentationTrainResp: + $ref: '#/components/schemas/XPSImageSegmentationTrainResponse' + textTrainResp: + description: Will only be needed for uCAIP from Beta. + $ref: '#/components/schemas/XPSTextTrainResponse' + evaluationMetricsSet: + description: >- + The trained model evaluation metrics. This can be optionally + returned. + $ref: '#/components/schemas/XPSEvaluationMetricsSet' + evaluatedExampleSet: + description: >- + Examples used to evaluate the model (usually the test set), with the + predicted annotations. The file_spec should point to recordio + file(s) of AnnotatedExample. For each returned example, the + example_id_token and annotations predicted by the model must be set. + The example payload can and is recommended to be omitted. + $ref: '#/components/schemas/XPSExampleSet' + deployedModelSizeBytes: + description: Estimated model size in bytes once deployed. type: string format: int64 - description: Required. Seconds of GPU usage, e.g. 3600. - trackingLabels: - type: object - additionalProperties: - type: string + explanationConfigs: description: >- - Billing tracking labels. They do not contain any user data but only - the labels set by Vertex Core Infra itself. Tracking labels' keys - are defined with special format: goog-[\p{Ll}\p{N}]+ E.g. "key": - "goog-k8s-cluster-name","value": "us-east1-b4rk" - machineSpec: + VisionExplanationConfig for XAI on test set. Optional for when XAI + is enable in training request. + deprecated: true + type: array + items: + $ref: '#/components/schemas/XPSResponseExplanationSpec' + errorAnalysisConfigs: + description: >- + Optional vision model error analysis configuration. The field is set + when model error analysis is enabled in the training request. The + results of error analysis will be binded together with evaluation + results (in the format of AnnotatedExample). + type: array + items: + $ref: '#/components/schemas/XPSVisionErrorAnalysisConfig' + XPSSpeechModelSpec: + id: XPSSpeechModelSpec + type: object + properties: + subModelSpecs: + description: Model specs for all submodels contained in this model. + type: array + items: + $ref: '#/components/schemas/XPSSpeechModelSpecSubModelSpec' + datasetId: + description: >- + Required for speech xps backend. Speech xps has to use dataset_id + and model_id as the primary key in db so that speech API can query + the db directly. + type: string + format: int64 + language: + type: string + XPSSpeechModelSpecSubModelSpec: + id: XPSSpeechModelSpecSubModelSpec + type: object + properties: + clientId: + description: In S3, Recognition ClientContextId.client_id + type: string + contextId: + description: In S3, Recognition ClientContextId.context_id + type: string + biasingModelType: + description: Type of the biasing model. type: string - description: Required. Machine spec, e.g. N1_STANDARD_4. enumDescriptions: - '' + - Build biasing model on top of COMMAND_AND_SEARCH model + - Build biasing model on top of PHONE_CALL model + - Build biasing model on top of VIDEO model + - Build biasing model on top of DEFAULT model + enum: + - BIASING_MODEL_TYPE_UNSPECIFIED + - COMMAND_AND_SEARCH + - PHONE_CALL + - VIDEO + - DEFAULT + isEnhancedModel: + description: >- + If true then it means we have an enhanced version of the biasing + models. + type: boolean + XPSTablesTrainResponse: + id: XPSTablesTrainResponse + type: object + properties: + tablesModelColumnInfo: + description: >- + Output only. Auxiliary information for each of the + input_feature_column_specs, with respect to this particular model. + type: array + items: + $ref: '#/components/schemas/XPSTablesModelColumnInfo' + predictionSampleRows: + description: Sample rows from the dataset this model was trained. + type: array + items: + $ref: '#/components/schemas/XPSRow' + trainCostMilliNodeHours: + description: >- + The actual training cost of the model, expressed in milli node + hours, i.e. 1,000 value in this field means 1 node hour. Guaranteed + to not exceed the train budget. + type: string + format: int64 + modelStructure: + $ref: '#/components/schemas/XPSTablesModelStructure' + XPSTablesModelColumnInfo: + id: XPSTablesModelColumnInfo + description: >- + An information specific to given column and Tables Model, in context of + the Model and the predictions created by it. + type: object + properties: + columnId: + description: The ID of the column. + type: integer + format: int32 + featureImportance: + description: >- + When given as part of a Model: Measurement of how much model + predictions correctness on the TEST data depend on values in this + column. A value between 0 and 1, higher means higher influence. + These values are normalized - for all input feature columns of a + given model they add to 1. When given back by Predict or Batch + Predict: Measurement of how impactful for the prediction returned + for the given row the value in this column was. Specifically, the + feature importance specifies the marginal contribution that the + feature made to the prediction score compared to the baseline score. + These values are computed using the Sampled Shapley method. + type: number + format: float + XPSRow: + id: XPSRow + type: object + properties: + columnIds: + description: >- + The ids of the columns. Note: The below `values` field must match + order of this field, if this field is set. + type: array + items: + type: integer + format: int32 + values: + description: >- + The values of the row cells, given in the same order as the + column_ids. If column_ids is not set, then in the same order as the + input_feature_column_ids in TablesModelMetadata. + type: array + items: + type: any + XPSTablesModelStructure: + id: XPSTablesModelStructure + description: A description of Tables model structure. + type: object + properties: + modelParameters: + description: A list of models. + type: array + items: + $ref: '#/components/schemas/XPSTablesModelStructureModelParameters' + XPSTablesModelStructureModelParameters: + id: XPSTablesModelStructureModelParameters + description: Model hyper-parameters for a model. + type: object + properties: + hyperparameters: + type: array + items: + $ref: >- + #/components/schemas/XPSTablesModelStructureModelParametersParameter + XPSTablesModelStructureModelParametersParameter: + id: XPSTablesModelStructureModelParametersParameter + type: object + properties: + name: + description: Parameter name. + type: string + floatValue: + description: Float type parameter value. + type: number + format: double + intValue: + description: Integer type parameter value. + type: string + format: int64 + stringValue: + description: String type parameter value. + type: string + XPSImageObjectDetectionModelSpec: + id: XPSImageObjectDetectionModelSpec + type: object + properties: + modelServingSpec: + $ref: '#/components/schemas/XPSImageModelServingSpec' + exportModelSpec: + $ref: '#/components/schemas/XPSImageExportModelSpec' + trainCostNodeSeconds: + description: >- + The actual train cost of creating this model, expressed in node + seconds, i.e. 3,600 value in this field means 1 node hour. + type: string + format: int64 + stopReason: + description: >- + Stop reason for training job, e.g. 'TRAIN_BUDGET_REACHED', + 'MODEL_CONVERGED'. + type: string + enumDescriptions: - '' - '' + - Model fully converged, can not be resumbed training. + - >- + Model early converged, can be further trained till full + convergency. + enum: + - TRAIN_STOP_REASON_UNSPECIFIED + - TRAIN_STOP_REASON_BUDGET_REACHED + - TRAIN_STOP_REASON_MODEL_CONVERGED + - TRAIN_STOP_REASON_MODEL_EARLY_STOPPED + modelArtifactSpec: + description: '## The fields below are only populated under uCAIP request scope.' + $ref: '#/components/schemas/XPSImageModelArtifactSpec' + maxBoundingBoxCount: + description: Max number of bounding box. + type: string + format: int64 + classCount: + description: Total number of classes. + type: string + format: int64 + XPSImageModelServingSpec: + id: XPSImageModelServingSpec + description: Serving specification for image models. + type: object + properties: + nodeQps: + description: >- + An estimated value of how much traffic a node can serve. Populated + for AutoMl request only. + type: number + format: double + tfRuntimeVersion: + description: >- + ## The fields below are only populated under uCAIP request scope. + https://cloud.google.com/ml-engine/docs/runtime-version-list + type: string + modelThroughputEstimation: + description: Populate under uCAIP request scope. + type: array + items: + $ref: >- + #/components/schemas/XPSImageModelServingSpecModelThroughputEstimation + XPSImageModelServingSpecModelThroughputEstimation: + id: XPSImageModelServingSpecModelThroughputEstimation + type: object + properties: + nodeQps: + description: The approximate qps a deployed node can serve. + type: number + format: double + latencyInMilliseconds: + description: Estimated latency. + type: number + format: double + computeEngineAcceleratorType: + type: string + enumDescriptions: - '' + - Nvidia Tesla K80 GPU. + - Nvidia Tesla P100 GPU. + - Nvidia Tesla V100 GPU. + - Nvidia Tesla P4 GPU. + - Nvidia Tesla T4 GPU. + - Nvidia Tesla A100 GPU. + - Nvidia A100 80GB GPU. + - Nvidia L4 GPU. + - Nvidia H100 80Gb GPU. + - Nvidia H100 80Gb GPU. + - Nvidia H200 141Gb GPU. + - Nvidia B200 GPU. + - Nvidia GB200 GPU. + - TPU v2 (JellyFish). + - TPU v3 (DragonFish). + - TPU_v4 (PufferFish). + - TPU v5 Lite Pods. + enum: + - UNSPECIFIED + - NVIDIA_TESLA_K80 + - NVIDIA_TESLA_P100 + - NVIDIA_TESLA_V100 + - NVIDIA_TESLA_P4 + - NVIDIA_TESLA_T4 + - NVIDIA_TESLA_A100 + - NVIDIA_A100_80GB + - NVIDIA_L4 + - NVIDIA_H100_80GB + - NVIDIA_H100_MEGA_80GB + - NVIDIA_H200_141GB + - NVIDIA_B200 + - NVIDIA_GB200 + - TPU_V2 + - TPU_V3 + - TPU_V4_POD + - TPU_V5_LITEPOD + servomaticPartitionType: + type: string + enumDescriptions: - '' + - The default partition. + - >- + It has significantly lower replication than partition-0 and is + located in the US only. It also has a larger model size limit and + higher default RAM quota than partition-0. Customers with batch + traffic, US-based traffic, or very large models should use this + partition. Capacity in this partition is significantly cheaper + than partition-0. + - To be used by customers with Jellyfish-accelerated ops. + - The partition used by regionalized servomatic cloud regions. + - The partition used for loading models from custom storage. + enum: + - PARTITION_TYPE_UNSPECIFIED + - PARTITION_ZERO + - PARTITION_REDUCED_HOMING + - PARTITION_JELLYFISH + - PARTITION_CPU + - PARTITION_CUSTOM_STORAGE_CPU + XPSImageExportModelSpec: + id: XPSImageExportModelSpec + description: >- + Information of downloadable models that are pre-generated as part of + training flow and will be persisted in AutoMl backend. Upon receiving + ExportModel request from user, AutoMl backend can serve the + pre-generated models to user if exists (by copying the files from + internal path to user provided location), otherwise, AutoMl backend will + call xPS ExportModel API to generate the model on the fly with the + requesting format. + type: object + properties: + exportModelOutputConfig: + description: >- + Contains the model format and internal location of the model files + to be exported/downloaded. Use the Google Cloud Storage bucket name + which is provided via TrainRequest.gcs_bucket_name to store the + model files. + type: array + items: + $ref: '#/components/schemas/XPSExportModelOutputConfig' + XPSExportModelOutputConfig: + id: XPSExportModelOutputConfig + type: object + properties: + outputGcsUri: + description: >- + The Google Cloud Storage directory where XPS will output the + exported models and related files. Format: gs://bucket/directory + type: string + outputGcrUri: + description: >- + The Google Contained Registry path the exported files to be pushed + to. This location is set if the exported format is DOCKDER. + type: string + tfLiteFormat: + $ref: '#/components/schemas/XPSTfLiteFormat' + edgeTpuTfLiteFormat: + $ref: '#/components/schemas/XPSEdgeTpuTfLiteFormat' + tfSavedModelFormat: + $ref: '#/components/schemas/XPSTfSavedModelFormat' + dockerFormat: + $ref: '#/components/schemas/XPSDockerFormat' + coreMlFormat: + $ref: '#/components/schemas/XPSCoreMlFormat' + tfJsFormat: + $ref: '#/components/schemas/XPSTfJsFormat' + exportFirebaseAuxiliaryInfo: + description: >- + For any model and format: If true, will additionally export + FirebaseExportedModelInfo in a firebase.txt file. + type: boolean + XPSTfLiteFormat: + id: XPSTfLiteFormat + description: >- + LINT.IfChange A model format used for mobile and IoT devices. See + https://www.tensorflow.org/lite. + type: object + properties: {} + XPSEdgeTpuTfLiteFormat: + id: XPSEdgeTpuTfLiteFormat + description: >- + A model format used for [Edge TPU](https://cloud.google.com/edge-tpu/) + devices. + type: object + properties: {} + XPSTfSavedModelFormat: + id: XPSTfSavedModelFormat + description: A tensorflow model format in SavedModel format. + type: object + properties: {} + XPSDockerFormat: + id: XPSDockerFormat + description: >- + A model format used for Docker containers. Use the params field to + customize the container. The container is verified to work correctly on + ubuntu 16.04 operating system. + type: object + properties: + cpuArchitecture: + description: >- + Optional. Additional cpu information describing the requirements for + the to be exported model files. + type: string + enumDescriptions: - '' - '' + enum: + - CPU_ARCHITECTURE_UNSPECIFIED + - CPU_ARCHITECTURE_X86_64 + gpuArchitecture: + description: >- + Optional. Additional gpu information describing the requirements for + the to be exported model files. + type: string + enumDescriptions: - '' - '' + enum: + - GPU_ARCHITECTURE_UNSPECIFIED + - GPU_ARCHITECTURE_NVIDIA + XPSCoreMlFormat: + id: XPSCoreMlFormat + description: A model format used for iOS mobile devices. + type: object + properties: {} + XPSTfJsFormat: + id: XPSTfJsFormat + description: >- + A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used + in the browser and in Node.js using JavaScript. + type: object + properties: {} + XPSImageModelArtifactSpec: + id: XPSImageModelArtifactSpec + description: >- + Stores the locations and related metadata of the model artifacts. + Populated for uCAIP requests only. + type: object + properties: + checkpointArtifact: + description: The Tensorflow checkpoint files. e.g. Used for resumable training. + $ref: '#/components/schemas/XPSModelArtifactItem' + servingArtifact: + description: >- + The default model binary file used for serving (e.g. online predict, + batch predict) via public Cloud AI Platform API. + $ref: '#/components/schemas/XPSModelArtifactItem' + exportArtifact: + description: The model binary files in different formats for model export. + type: array + items: + $ref: '#/components/schemas/XPSModelArtifactItem' + tfLiteMetadataGcsUri: + description: >- + Google Cloud Storage URI of Tensorflow Lite metadata + 'tflite_metadata.json'. + type: string + labelGcsUri: + description: >- + Google Cloud Storage URI of decoded labels file for model export + 'dict.txt'. + type: string + tfJsBinaryGcsPrefix: + description: >- + Google Cloud Storage URI prefix of Tensorflow JavaScript binary + files 'groupX-shardXofX.bin'. Deprecated. + type: string + XPSModelArtifactItem: + id: XPSModelArtifactItem + description: A single model artifact item. + type: object + properties: + artifactFormat: + description: The model artifact format. + type: string + enumDescriptions: + - Should not be used. + - >- + The Tensorflow checkpoints. See + https://www.tensorflow.org/guide/checkpoint. + - The Tensorflow SavedModel binary. + - >- + Model artifact in generic TensorFlow Lite (.tflite) format. See + https://www.tensorflow.org/lite. + - Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. + - >- + A [TensorFlow.js](https://www.tensorflow.org/js) model that can be + used in the browser and in Node.js using JavaScript. + - >- + Used for iOS mobile devices in (.mlmodel) format. See + https://developer.apple.com/documentation/coreml + enum: + - ARTIFACT_FORMAT_UNSPECIFIED + - TF_CHECKPOINT + - TF_SAVED_MODEL + - TF_LITE + - EDGE_TPU_TF_LITE + - TF_JS + - CORE_ML + gcsUri: + description: The Google Cloud Storage URI that stores the model binary files. + type: string + XPSTextToSpeechTrainResponse: + id: XPSTextToSpeechTrainResponse + description: TextToSpeech train response + type: object + properties: {} + XPSVideoObjectTrackingTrainResponse: + id: XPSVideoObjectTrackingTrainResponse + type: object + properties: + exportModelSpec: + description: Populated for AutoML request only. + $ref: '#/components/schemas/XPSVideoExportModelSpec' + modelArtifactSpec: + description: '## The fields below are only populated under uCAIP request scope.' + $ref: '#/components/schemas/XPSVideoModelArtifactSpec' + trainCostNodeSeconds: + description: >- + The actual train cost of creating this model, expressed in node + seconds, i.e. 3,600 value in this field means 1 node hour. + type: string + format: int64 + XPSVideoExportModelSpec: + id: XPSVideoExportModelSpec + description: >- + Information of downloadable models that are pre-generated as part of + training flow and will be persisted in AutoMl backend. Upon receiving + ExportModel request from user, AutoMl backend can serve the + pre-generated models to user if exists (by copying the files from + internal path to user provided location), otherwise, AutoMl backend will + call xPS ExportModel API to generate the model on the fly with the + requesting format. + type: object + properties: + exportModelOutputConfig: + description: >- + Contains the model format and internal location of the model files + to be exported/downloaded. Use the Google Cloud Storage bucket name + which is provided via TrainRequest.gcs_bucket_name to store the + model files. + type: array + items: + $ref: '#/components/schemas/XPSExportModelOutputConfig' + XPSVideoModelArtifactSpec: + id: XPSVideoModelArtifactSpec + type: object + properties: + servingArtifact: + description: >- + The default model binary file used for serving (e.g. batch predict) + via public Cloud AI Platform API. + $ref: '#/components/schemas/XPSModelArtifactItem' + exportArtifact: + description: The model binary files in different formats for model export. + type: array + items: + $ref: '#/components/schemas/XPSModelArtifactItem' + XPSVideoClassificationTrainResponse: + id: XPSVideoClassificationTrainResponse + type: object + properties: + modelArtifactSpec: + description: '## The fields below are only populated under uCAIP request scope.' + $ref: '#/components/schemas/XPSVideoModelArtifactSpec' + trainCostNodeSeconds: + description: >- + The actual train cost of creating this model, expressed in node + seconds, i.e. 3,600 value in this field means 1 node hour. + type: string + format: int64 + XPSVideoActionRecognitionTrainResponse: + id: XPSVideoActionRecognitionTrainResponse + type: object + properties: + modelArtifactSpec: + description: '## The fields below are only populated under uCAIP request scope.' + $ref: '#/components/schemas/XPSVideoModelArtifactSpec' + trainCostNodeSeconds: + description: >- + The actual train cost of creating this model, expressed in node + seconds, i.e. 3,600 value in this field means 1 node hour. + type: string + format: int64 + XPSImageClassificationTrainResponse: + id: XPSImageClassificationTrainResponse + type: object + properties: + trainCostInNodeTime: + description: >- + The actual cost to create this model. - For edge type model, the + cost is expressed in node hour. - For cloud type model,the cost is + expressed in compute hour. - Populated for models created before GA. + To be deprecated after GA. + type: string + format: google-duration + trainCostNodeSeconds: + description: >- + The actual training cost, expressed in node seconds. Populated for + models trained in node time. + type: string + format: int64 + stopReason: + description: >- + Stop reason for training job, e.g. 'TRAIN_BUDGET_REACHED', + 'MODEL_CONVERGED', 'MODEL_EARLY_STOPPED'. + type: string + enumDescriptions: - '' - '' + - Model fully converged, can not be resumbed training. + - >- + Model early converged, can be further trained till full + convergency. + enum: + - TRAIN_STOP_REASON_UNSPECIFIED + - TRAIN_STOP_REASON_BUDGET_REACHED + - TRAIN_STOP_REASON_MODEL_CONVERGED + - TRAIN_STOP_REASON_MODEL_EARLY_STOPPED + exportModelSpec: + description: >- + Information of downloadable models that are pre-generated as part of + training flow and will be persisted in AutoMl backend. Populated for + AutoMl requests. + $ref: '#/components/schemas/XPSImageExportModelSpec' + modelServingSpec: + $ref: '#/components/schemas/XPSImageModelServingSpec' + modelArtifactSpec: + description: '## The fields below are only populated under uCAIP request scope.' + $ref: '#/components/schemas/XPSImageModelArtifactSpec' + classCount: + description: Total number of classes. + type: string + format: int64 + XPSTranslationTrainResponse: + id: XPSTranslationTrainResponse + description: Train response for translation. + type: object + properties: + modelType: + description: Type of the model. + type: string + enumDescriptions: + - Default + - Legacy model. Will be deprecated. + - Current model. + enum: + - MODEL_TYPE_UNSPECIFIED + - LEGACY + - CURRENT + XPSImageSegmentationTrainResponse: + id: XPSImageSegmentationTrainResponse + type: object + properties: + modelServingSpec: + $ref: '#/components/schemas/XPSImageModelServingSpec' + exportModelSpec: + description: 'NOTE: These fields are not used/needed in EAP but will be set later.' + $ref: '#/components/schemas/XPSImageExportModelSpec' + trainCostNodeSeconds: + description: >- + The actual train cost of creating this model, expressed in node + seconds, i.e. 3,600 value in this field means 1 node hour. + type: string + format: int64 + stopReason: + description: >- + Stop reason for training job, e.g. 'TRAIN_BUDGET_REACHED', + 'MODEL_CONVERGED'. + type: string + enumDescriptions: - '' - '' + - Model fully converged, can not be resumbed training. + - >- + Model early converged, can be further trained till full + convergency. + enum: + - TRAIN_STOP_REASON_UNSPECIFIED + - TRAIN_STOP_REASON_BUDGET_REACHED + - TRAIN_STOP_REASON_MODEL_CONVERGED + - TRAIN_STOP_REASON_MODEL_EARLY_STOPPED + modelArtifactSpec: + description: >- + ## The fields below are only populated under uCAIP request scope. + Model artifact spec stores and model gcs pathes and related metadata + $ref: '#/components/schemas/XPSImageModelArtifactSpec' + colorMaps: + description: Color map of the model. + type: array + items: + $ref: '#/components/schemas/XPSColorMap' + XPSColorMap: + id: XPSColorMap + description: >- + Map from color to display name. Will only be used by Image Segmentation + for uCAIP. + type: object + properties: + color: + description: >- + This type is deprecated in favor of the IntColor below. This is + because google.type.Color represent color has a float which + semantically does not reflect discrete classes/categories concept. + Moreover, to handle it well we need to have some tolerance when + converting to a discretized color. As such, the recommendation is to + have API surface still use google.type.Color while internally + IntColor is used. + deprecated: true + $ref: '#/components/schemas/Color' + intColor: + $ref: '#/components/schemas/XPSColorMapIntColor' + displayName: + description: Should be used during preprocessing. + type: string + annotationSpecIdToken: + description: Should be used during training. + type: string + Color: + id: Color + description: >- + Represents a color in the RGBA color space. This representation is + designed for simplicity of conversion to and from color representations + in various languages over compactness. For example, the fields of this + representation can be trivially provided to the constructor of + `java.awt.Color` in Java; it can also be trivially provided to UIColor's + `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little + work, it can be easily formatted into a CSS `rgba()` string in + JavaScript. This reference page doesn't have information about the + absolute color space that should be used to interpret the RGB value—for + example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications + should assume the sRGB color space. When color equality needs to be + decided, implementations, unless documented otherwise, treat two colors + as equal if all their red, green, blue, and alpha values each differ by + at most `1e-5`. Example (Java): import com.google.type.Color; // ... + public static java.awt.Color fromProto(Color protocolor) { float alpha = + protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return + new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), + protocolor.getBlue(), alpha); } public static Color + toProto(java.awt.Color color) { float red = (float) color.getRed(); + float green = (float) color.getGreen(); float blue = (float) + color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder + = Color .newBuilder() .setRed(red / denominator) .setGreen(green / + denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); + if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() + .setValue(((float) alpha) / denominator) .build()); } return + resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static + UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; + float green = [protocolor green]; float blue = [protocolor blue]; + FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if + (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return + [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static + Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if + (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return + nil; } Color* result = [[Color alloc] init]; [result setRed:red]; + [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { + [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; + return result; } // ... Example (JavaScript): // ... var protoToCssColor + = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var + greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || + 0.0; var red = Math.floor(redFrac * 255); var green = + Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if + (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } + var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, + green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, + ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var + rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString + = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var + resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { + resultBuilder.push('0'); } resultBuilder.push(hexString); return + resultBuilder.join(''); }; // ... + type: object + properties: + red: + description: The amount of red in the color as a value in the interval [0, 1]. + type: number + format: float + green: + description: The amount of green in the color as a value in the interval [0, 1]. + type: number + format: float + blue: + description: The amount of blue in the color as a value in the interval [0, 1]. + type: number + format: float + alpha: + description: >- + The fraction of this color that should be applied to the pixel. That + is, the final pixel color is defined by the equation: `pixel color = + alpha * (this color) + (1.0 - alpha) * (background color)` This + means that a value of 1.0 corresponds to a solid color, whereas a + value of 0.0 corresponds to a completely transparent color. This + uses a wrapper message rather than a simple float scalar so that it + is possible to distinguish between a default value and the value + being unset. If omitted, this color object is rendered as a solid + color (as if the alpha value had been explicitly given a value of + 1.0). + type: number + format: float + XPSColorMapIntColor: + id: XPSColorMapIntColor + description: RGB color and each channel is represented by an integer. + type: object + properties: + red: + description: The value should be in range of [0, 255]. + type: integer + format: int32 + green: + description: The value should be in range of [0, 255]. + type: integer + format: int32 + blue: + description: The value should be in range of [0, 255]. + type: integer + format: int32 + XPSTextTrainResponse: + id: XPSTextTrainResponse + type: object + properties: + componentModel: + description: Component submodels. + type: array + items: + $ref: '#/components/schemas/XPSTextComponentModel' + XPSTextComponentModel: + id: XPSTextComponentModel + description: Component model. + type: object + properties: + submodelName: + description: The name of the trained NL submodel. + type: string + submodelType: + description: The type of trained NL submodel + type: string + enumDescriptions: - '' - '' - '' @@ -1521,3322 +2191,2692 @@ components: - '' - '' - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' + - Model type for entity extraction. + - Model type for relationship extraction. + - >- + A composite model represents a set of component models that have + to be used together for prediction. A composite model appears to + be a single model to the model user. It may contain only one + component model. + - >- + Model type used to train default, MA, and ATC models in a single + batch worker pipeline. + - >- + BERT pipeline needs a specific model type, since it uses a + different TFX configuration compared with DEFAULT (despite sharing + most of the code). + - Model type for EncPaLM. enum: - - UNKNOWN_MACHINE_SPEC - - N1_STANDARD_2 - - N1_STANDARD_4 - - N1_STANDARD_8 - - N1_STANDARD_16 - - N1_STANDARD_32 - - N1_STANDARD_64 - - N1_STANDARD_96 - - N1_HIGHMEM_2 - - N1_HIGHMEM_4 - - N1_HIGHMEM_8 - - N1_HIGHMEM_16 - - N1_HIGHMEM_32 - - N1_HIGHMEM_64 - - N1_HIGHMEM_96 - - N1_HIGHCPU_2 - - N1_HIGHCPU_4 - - N1_HIGHCPU_8 - - N1_HIGHCPU_16 - - N1_HIGHCPU_32 - - N1_HIGHCPU_64 - - N1_HIGHCPU_96 - - A2_HIGHGPU_1G - - A2_HIGHGPU_2G - - A2_HIGHGPU_4G - - A2_HIGHGPU_8G - - A2_MEGAGPU_16G - - A2_ULTRAGPU_1G - - A2_ULTRAGPU_2G - - A2_ULTRAGPU_4G - - A2_ULTRAGPU_8G - - A3_HIGHGPU_1G - - A3_HIGHGPU_2G - - A3_HIGHGPU_4G - - A3_HIGHGPU_8G - - A3_MEGAGPU_8G - - E2_STANDARD_2 - - E2_STANDARD_4 - - E2_STANDARD_8 - - E2_STANDARD_16 - - E2_STANDARD_32 - - E2_HIGHMEM_2 - - E2_HIGHMEM_4 - - E2_HIGHMEM_8 - - E2_HIGHMEM_16 - - E2_HIGHCPU_2 - - E2_HIGHCPU_4 - - E2_HIGHCPU_8 - - E2_HIGHCPU_16 - - E2_HIGHCPU_32 - - N2_STANDARD_2 - - N2_STANDARD_4 - - N2_STANDARD_8 - - N2_STANDARD_16 - - N2_STANDARD_32 - - N2_STANDARD_48 - - N2_STANDARD_64 - - N2_STANDARD_80 - - N2_STANDARD_96 - - N2_STANDARD_128 - - N2_HIGHMEM_2 - - N2_HIGHMEM_4 - - N2_HIGHMEM_8 - - N2_HIGHMEM_16 - - N2_HIGHMEM_32 - - N2_HIGHMEM_48 - - N2_HIGHMEM_64 - - N2_HIGHMEM_80 - - N2_HIGHMEM_96 - - N2_HIGHMEM_128 - - N2_HIGHCPU_2 - - N2_HIGHCPU_4 - - N2_HIGHCPU_8 - - N2_HIGHCPU_16 - - N2_HIGHCPU_32 - - N2_HIGHCPU_48 - - N2_HIGHCPU_64 - - N2_HIGHCPU_80 - - N2_HIGHCPU_96 - - N2D_STANDARD_2 - - N2D_STANDARD_4 - - N2D_STANDARD_8 - - N2D_STANDARD_16 - - N2D_STANDARD_32 - - N2D_STANDARD_48 - - N2D_STANDARD_64 - - N2D_STANDARD_80 - - N2D_STANDARD_96 - - N2D_STANDARD_128 - - N2D_STANDARD_224 - - N2D_HIGHMEM_2 - - N2D_HIGHMEM_4 - - N2D_HIGHMEM_8 - - N2D_HIGHMEM_16 - - N2D_HIGHMEM_32 - - N2D_HIGHMEM_48 - - N2D_HIGHMEM_64 - - N2D_HIGHMEM_80 - - N2D_HIGHMEM_96 - - N2D_HIGHCPU_2 - - N2D_HIGHCPU_4 - - N2D_HIGHCPU_8 - - N2D_HIGHCPU_16 - - N2D_HIGHCPU_32 - - N2D_HIGHCPU_48 - - N2D_HIGHCPU_64 - - N2D_HIGHCPU_80 - - N2D_HIGHCPU_96 - - N2D_HIGHCPU_128 - - N2D_HIGHCPU_224 - - C2_STANDARD_4 - - C2_STANDARD_8 - - C2_STANDARD_16 - - C2_STANDARD_30 - - C2_STANDARD_60 - - C2D_STANDARD_2 - - C2D_STANDARD_4 - - C2D_STANDARD_8 - - C2D_STANDARD_16 - - C2D_STANDARD_32 - - C2D_STANDARD_56 - - C2D_STANDARD_112 - - C2D_HIGHCPU_2 - - C2D_HIGHCPU_4 - - C2D_HIGHCPU_8 - - C2D_HIGHCPU_16 - - C2D_HIGHCPU_32 - - C2D_HIGHCPU_56 - - C2D_HIGHCPU_112 - - C2D_HIGHMEM_2 - - C2D_HIGHMEM_4 - - C2D_HIGHMEM_8 - - C2D_HIGHMEM_16 - - C2D_HIGHMEM_32 - - C2D_HIGHMEM_56 - - C2D_HIGHMEM_112 - - G2_STANDARD_4 - - G2_STANDARD_8 - - G2_STANDARD_12 - - G2_STANDARD_16 - - G2_STANDARD_24 - - G2_STANDARD_32 - - G2_STANDARD_48 - - G2_STANDARD_96 - - C3_STANDARD_4 - - C3_STANDARD_8 - - C3_STANDARD_22 - - C3_STANDARD_44 - - C3_STANDARD_88 - - C3_STANDARD_176 - - C3_HIGHCPU_4 - - C3_HIGHCPU_8 - - C3_HIGHCPU_22 - - C3_HIGHCPU_44 - - C3_HIGHCPU_88 - - C3_HIGHCPU_176 - - C3_HIGHMEM_4 - - C3_HIGHMEM_8 - - C3_HIGHMEM_22 - - C3_HIGHMEM_44 - - C3_HIGHMEM_88 - - C3_HIGHMEM_176 - id: GpuMetric - XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry: - properties: - precision: - description: Precision for the given confidence threshold. - format: float - type: number - confusionMatrix: - $ref: '#/components/schemas/XPSConfusionMatrix' - description: >- - Confusion matrix of the per confidence_threshold evaluation. Pixel - counts are set here. Only set for model level evaluation, not for - evaluation per label. - confidenceThreshold: - type: number - description: The confidence threshold value used to compute the metrics. - format: float - recall: - description: Recall for the given confidence threshold. - type: number - format: float - iouScore: - type: number - description: IOU score. - format: float - diceScoreCoefficient: - type: number - format: float - description: 'DSC or the F1 score: The harmonic mean of recall and precision.' - id: XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry - type: object - description: Metrics for a single confidence threshold. - XPSImageSegmentationTrainResponse: - properties: - modelArtifactSpec: - $ref: '#/components/schemas/XPSImageModelArtifactSpec' + - TEXT_MODEL_TYPE_UNSPECIFIED + - TEXT_MODEL_TYPE_DEFAULT + - TEXT_MODEL_TYPE_META_ARCHITECT + - TEXT_MODEL_TYPE_ATC + - TEXT_MODEL_TYPE_CLARA2 + - TEXT_MODEL_TYPE_CHATBASE + - TEXT_MODEL_TYPE_SAFT_SPAN_LABELING + - TEXT_MODEL_TYPE_TEXT_EXTRACTION + - TEXT_MODEL_TYPE_RELATIONSHIP_EXTRACTION + - TEXT_MODEL_TYPE_COMPOSITE + - TEXT_MODEL_TYPE_ALL_MODELS + - TEXT_MODEL_TYPE_BERT + - TEXT_MODEL_TYPE_ENC_PALM + servoModelName: description: >- - ## The fields below are only populated under uCAIP request scope. - Model artifact spec stores and model gcs pathes and related metadata - trainCostNodeSeconds: + The name of servo model. Populated by uCAIP BE as part of online + PredictRequest. + type: string + versionNumber: description: >- - The actual train cost of creating this model, expressed in node - seconds, i.e. 3,600 value in this field means 1 node hour. + The servomatic model version number. Populated by uCAIP BE as part + of online PredictRequest. type: string format: int64 - colorMaps: - description: Color map of the model. - type: array - items: - $ref: '#/components/schemas/XPSColorMap' - modelServingSpec: - $ref: '#/components/schemas/XPSImageModelServingSpec' - exportModelSpec: - description: 'NOTE: These fields are not used/needed in EAP but will be set later.' - $ref: '#/components/schemas/XPSImageExportModelSpec' - stopReason: + partition: description: >- - Stop reason for training job, e.g. 'TRAIN_BUDGET_REACHED', - 'MODEL_CONVERGED'. + The partition where the model is deployed. Populated by uCAIP BE as + part of online PredictRequest. type: string - enum: - - TRAIN_STOP_REASON_UNSPECIFIED - - TRAIN_STOP_REASON_BUDGET_REACHED - - TRAIN_STOP_REASON_MODEL_CONVERGED - - TRAIN_STOP_REASON_MODEL_EARLY_STOPPED enumDescriptions: - '' - - '' - - Model fully converged, can not be resumbed training. + - The default partition. - >- - Model early converged, can be further trained till full - convergency. - type: object - id: XPSImageSegmentationTrainResponse - XPSSpeechModelSpec: - properties: - language: - type: string - subModelSpecs: - type: array - description: Model specs for all submodels contained in this model. + It has significantly lower replication than partition-0 and is + located in the US only. It also has a larger model size limit and + higher default RAM quota than partition-0. Customers with batch + traffic, US-based traffic, or very large models should use this + partition. Capacity in this partition is significantly cheaper + than partition-0. + - To be used by customers with Jellyfish-accelerated ops. + - The partition used by regionalized servomatic cloud regions. + - The partition used for loading models from custom storage. + enum: + - PARTITION_TYPE_UNSPECIFIED + - PARTITION_ZERO + - PARTITION_REDUCED_HOMING + - PARTITION_JELLYFISH + - PARTITION_CPU + - PARTITION_CUSTOM_STORAGE_CPU + onlinePredictionModelGcsUri: + description: The Cloud Storage resource path to hold online prediction model. + type: string + batchPredictionModelGcsUri: + description: The Cloud Storage resource path to hold batch prediction model. + type: string + servingArtifact: + description: >- + The default model binary file used for serving (e.g. online predict, + batch predict) via public Cloud Ai Platform API. + $ref: '#/components/schemas/XPSModelArtifactItem' + tfRuntimeVersion: + description: >- + ## The fields below are only populated under uCAIP request scope. + https://cloud.google.com/ml-engine/docs/runtime-version-list + type: string + XPSEvaluationMetricsSet: + id: XPSEvaluationMetricsSet + description: Specifies location of model evaluation metrics. + type: object + properties: + evaluationMetrics: + description: >- + Inline EvaluationMetrics - should be relatively small. For passing + large quantities of exhaustive metrics, use file_spec. + type: array items: - $ref: '#/components/schemas/XPSSpeechModelSpecSubModelSpec' - datasetId: + $ref: '#/components/schemas/XPSEvaluationMetrics' + fileSpec: + description: >- + File spec containing evaluation metrics of a model, must point to + RecordIO file(s) of intelligence.cloud.automl.xps.EvaluationMetrics + messages. + $ref: '#/components/schemas/XPSFileSpec' + numEvaluationMetrics: + description: >- + Number of the evaluation metrics (usually one per label plus + overall). type: string format: int64 + XPSEvaluationMetrics: + id: XPSEvaluationMetrics + description: >- + Contains xPS-specific model evaluation metrics either for a single + annotation spec (label), or for the model overall. Next tag: 18. + type: object + properties: + annotationSpecIdToken: description: >- - Required for speech xps backend. Speech xps has to use dataset_id - and model_id as the primary key in db so that speech API can query - the db directly. - id: XPSSpeechModelSpec + The annotation_spec for which this evaluation metrics instance had + been created. Empty iff this is an overall model evaluation (like + Tables evaluation metrics), i.e. aggregated across all labels. The + value comes from the input annotations in AnnotatedExample. For MVP + product or for text sentiment models where annotation_spec_id_token + is not available, set label instead. + type: string + label: + description: >- + The label for which this evaluation metrics instance had been + created. Empty iff this is an overall model evaluation (like Tables + evaluation metrics), i.e. aggregated across all labels. The label + maps to AnnotationSpec.display_name in Public API protos. Only used + by MVP implementation and text sentiment FULL implementation. + type: string + category: + description: >- + The integer category label for which this evaluation metric instance + had been created. Valid categories are 0 or higher. Overall model + evaluation should set this to negative values (rather than implicit + zero). Only used for Image Segmentation (prefer to set + annotation_spec_id_token instead). Note: uCAIP Image Segmentation + should use annotation_spec_id_token. + type: integer + format: int32 + evaluatedExampleCount: + description: >- + The number of examples used to create this evaluation metrics + instance. + type: integer + format: int32 + videoClassificationEvalMetrics: + $ref: '#/components/schemas/XPSClassificationEvaluationMetrics' + imageObjectDetectionEvalMetrics: + $ref: '#/components/schemas/XPSImageObjectDetectionEvaluationMetrics' + textExtractionEvalMetrics: + $ref: '#/components/schemas/XPSTextExtractionEvaluationMetrics' + videoObjectTrackingEvalMetrics: + $ref: '#/components/schemas/XPSVideoObjectTrackingEvaluationMetrics' + tablesEvalMetrics: + $ref: '#/components/schemas/XPSTablesEvaluationMetrics' + tablesClassificationEvalMetrics: + $ref: '#/components/schemas/XPSClassificationEvaluationMetrics' + regressionEvalMetrics: + $ref: '#/components/schemas/XPSRegressionEvaluationMetrics' + textClassificationEvalMetrics: + $ref: '#/components/schemas/XPSClassificationEvaluationMetrics' + videoActionRecognitionEvalMetrics: + $ref: '#/components/schemas/XPSVideoActionRecognitionEvaluationMetrics' + translationEvalMetrics: + $ref: '#/components/schemas/XPSTranslationEvaluationMetrics' + imageClassificationEvalMetrics: + $ref: '#/components/schemas/XPSClassificationEvaluationMetrics' + imageSegmentationEvalMetrics: + $ref: '#/components/schemas/XPSImageSegmentationEvaluationMetrics' + textSentimentEvalMetrics: + $ref: '#/components/schemas/XPSTextSentimentEvaluationMetrics' + XPSClassificationEvaluationMetrics: + id: XPSClassificationEvaluationMetrics + description: >- + Model evaluation metrics for classification problems. It can be used for + image and video classification. Next tag: 9. type: object - XPSRegressionEvaluationMetrics: properties: - meanAbsolutePercentageError: + auPrc: + description: The Area under precision recall curve metric. type: number format: float - description: >- - Mean absolute percentage error. Only set if all ground truth values - are positive. - rSquared: + baseAuPrc: + description: The Area under precision recall curve metric based on priors. type: number format: float - description: R squared. - rootMeanSquaredLogError: - format: float - description: Root mean squared log error. + auRoc: + description: >- + The Area Under Receiver Operating Characteristic curve metric. + Micro-averaged for the overall evaluation. type: number - rootMeanSquaredError: + format: float + logLoss: + description: The Log Loss metric. type: number - description: Root Mean Squared Error (RMSE). format: float - regressionMetricsEntries: + evaluatedExamplesCount: + description: The number of examples used for model evaluation. + type: integer + format: int32 + confidenceMetricsEntries: description: >- - A list of actual versus predicted points for the model being - evaluated. + Metrics that have confidence thresholds. Precision-recall curve can + be derived from it. type: array items: - $ref: '#/components/schemas/XPSRegressionMetricsEntry' - meanAbsoluteError: - type: number - description: Mean Absolute Error (MAE). - format: float - type: object - id: XPSRegressionEvaluationMetrics + $ref: '#/components/schemas/XPSConfidenceMetricsEntry' + confusionMatrix: + description: >- + Confusion matrix of the evaluation. Only set for MULTICLASS + classification problems where number of annotation specs is no more + than 10. Only set for model level evaluation, not for evaluation per + label. + $ref: '#/components/schemas/XPSConfusionMatrix' + XPSConfidenceMetricsEntry: + id: XPSConfidenceMetricsEntry description: >- - Model evaluation metrics for regression problems. It can be used for - Tables. - XPSCommonStats: + ConfidenceMetricsEntry includes generic precision, recall, f1 score etc. + Next tag: 16. + type: object properties: - distinctValueCount: + confidenceThreshold: + description: >- + Metrics are computed with an assumption that the model never return + predictions with score lower than this value. + type: number + format: float + positionThreshold: + description: >- + Metrics are computed with an assumption that the model always + returns at most this many predictions (ordered by their score, + descendingly), but they all still need to meet the + confidence_threshold. + type: integer + format: int32 + recall: + description: Recall (true positive rate) for the given confidence threshold. + type: number + format: float + precision: + description: Precision for the given confidence threshold. + type: number + format: float + falsePositiveRate: + description: False Positive Rate for the given confidence threshold. + type: number + format: float + f1Score: + description: The harmonic mean of recall and precision. + type: number + format: float + recallAt1: + description: >- + The recall (true positive rate) when only considering the label that + has the highest prediction score and not below the confidence + threshold for each example. + type: number + format: float + precisionAt1: + description: >- + The precision when only considering the label that has the highest + prediction score and not below the confidence threshold for each + example. + type: number + format: float + falsePositiveRateAt1: + description: >- + The False Positive Rate when only considering the label that has the + highest prediction score and not below the confidence threshold for + each example. + type: number + format: float + f1ScoreAt1: + description: The harmonic mean of recall_at1 and precision_at1. + type: number + format: float + truePositiveCount: + description: The number of model created labels that match a ground truth label. type: string format: int64 - validValueCount: - format: int64 + falsePositiveCount: + description: >- + The number of model created labels that do not match a ground truth + label. type: string - nullValueCount: format: int64 + falseNegativeCount: + description: >- + The number of ground truth labels that are not matched by a model + created label. type: string - description: Common statistics for a column with a specified data type. - id: XPSCommonStats - type: object - XPSCorrelationStats: - type: object - description: >- - A correlation statistics between two series of DataType values. The - series may have differing DataType-s, but within a single series the - DataType must be the same. - properties: - cramersV: - type: number - format: double - description: The correlation value using the Cramer's V measure. - id: XPSCorrelationStats - XPSVideoExportModelSpec: - type: object - properties: - exportModelOutputConfig: - type: array - description: >- - Contains the model format and internal location of the model files - to be exported/downloaded. Use the Google Cloud Storage bucket name - which is provided via TrainRequest.gcs_bucket_name to store the - model files. - items: - $ref: '#/components/schemas/XPSExportModelOutputConfig' - description: >- - Information of downloadable models that are pre-generated as part of - training flow and will be persisted in AutoMl backend. Upon receiving - ExportModel request from user, AutoMl backend can serve the - pre-generated models to user if exists (by copying the files from - internal path to user provided location), otherwise, AutoMl backend will - call xPS ExportModel API to generate the model on the fly with the - requesting format. - id: XPSVideoExportModelSpec - AnalyzeEntitiesResponse: - type: object - description: The entity analysis response message. - properties: - languageSupported: + format: int64 + trueNegativeCount: description: >- - Whether the language is officially supported. The API may still - return a response when the language is not supported, but it is on a - best effort basis. - type: boolean - languageCode: + The number of labels that were not created by the model, but if they + would, they would not match a ground truth label. type: string - description: >- - The language of the text, which will be the same as the language - specified in the request or, if not specified, the - automatically-detected language. See Document.language field for - more details. - entities: - items: - $ref: '#/components/schemas/Entity' - type: array - description: The recognized entities in the input document. - id: AnalyzeEntitiesResponse + format: int64 XPSConfusionMatrix: + id: XPSConfusionMatrix + description: Confusion matrix of the model running the classification. + type: object properties: - sentimentLabel: + annotationSpecIdToken: + description: >- + For the following three repeated fields, only one is intended to be + set. annotation_spec_id_token is preferable to be set. ID tokens of + the annotation specs used in the confusion matrix. type: array items: - format: int32 - type: integer + type: string + sentimentLabel: description: >- Sentiment labels used in the confusion matrix. Set only for text sentiment models. For AutoML Text Revamp, use `annotation_spec_id_token` instead and leave this field empty. - annotationSpecIdToken: - items: - type: string type: array + items: + type: integer + format: int32 + category: description: >- - For the following three repeated fields, only one is intended to be - set. annotation_spec_id_token is preferable to be set. ID tokens of - the annotation specs used in the confusion matrix. - row: + Category (mainly for segmentation). Set only for image segmentation + models. Note: uCAIP Image Segmentation should use + annotation_spec_id_token. type: array items: - $ref: '#/components/schemas/XPSConfusionMatrixRow' + type: integer + format: int32 + row: description: >- Rows in the confusion matrix. The number of rows is equal to the size of `annotation_spec_id_token`. `row[i].value[j]` is the number of examples that have ground truth of the `annotation_spec_id_token[i]` and are predicted as `annotation_spec_id_token[j]` by the model being evaluated. - category: + type: array + items: + $ref: '#/components/schemas/XPSConfusionMatrixRow' + XPSConfusionMatrixRow: + id: XPSConfusionMatrixRow + description: A row in the confusion matrix. + type: object + properties: + exampleCount: + description: >- + Value of the specific cell in the confusion matrix. The number of + values each row has (i.e. the length of the row) is equal to the + length of the annotation_spec_id_token field. type: array items: type: integer format: int32 + count: description: >- - Category (mainly for segmentation). Set only for image segmentation - models. Note: uCAIP Image Segmentation should use - annotation_spec_id_token. - type: object - description: Confusion matrix of the model running the classification. - id: XPSConfusionMatrix - XPSVideoModelArtifactSpec: + Same as above except intended to represent other counts (for e.g. + for segmentation this is pixel count). NOTE(params): Only + example_count or count is set (oneoff does not support repeated + fields unless they are embedded inside another message). + type: array + items: + type: string + format: int64 + XPSImageObjectDetectionEvaluationMetrics: + id: XPSImageObjectDetectionEvaluationMetrics + description: >- + Model evaluation metrics for image object detection problems. Evaluates + prediction quality of labeled bounding boxes. type: object properties: - servingArtifact: + evaluatedBoundingBoxCount: description: >- - The default model binary file used for serving (e.g. batch predict) - via public Cloud AI Platform API. - $ref: '#/components/schemas/XPSModelArtifactItem' - exportArtifact: - items: - $ref: '#/components/schemas/XPSModelArtifactItem' + The total number of bounding boxes (i.e. summed over all images) the + ground truth used to create this evaluation had. + type: integer + format: int32 + boundingBoxMetricsEntries: + description: >- + The bounding boxes match metrics for each Intersection-over-union + threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 and each label + confidence threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 pair. type: array - description: The model binary files in different formats for model export. - id: XPSVideoModelArtifactSpec - ModerateTextResponse: + items: + $ref: '#/components/schemas/XPSBoundingBoxMetricsEntry' + boundingBoxMeanAveragePrecision: + description: >- + The single metric for bounding boxes evaluation: the + mean_average_precision averaged over all + bounding_box_metrics_entries. + type: number + format: float + XPSBoundingBoxMetricsEntry: + id: XPSBoundingBoxMetricsEntry + description: >- + Bounding box matching model metrics for a single intersection-over-union + threshold and multiple label match confidence thresholds. type: object properties: - languageSupported: + iouThreshold: description: >- - Whether the language is officially supported. The API may still - return a response when the language is not supported, but it is on a - best effort basis. - type: boolean - languageCode: - type: string + The intersection-over-union threshold value used to compute this + metrics entry. + type: number + format: float + meanAveragePrecision: + description: The mean average precision. + type: number + format: float + confidenceMetricsEntries: description: >- - The language of the text, which will be the same as the language - specified in the request or, if not specified, the - automatically-detected language. See Document.language field for - more details. - moderationCategories: - items: - $ref: '#/components/schemas/ClassificationCategory' + Metrics for each label-match confidence_threshold from + 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. type: array - description: Harmful and sensitive categories representing the input document. - description: The document moderation response message. - id: ModerateTextResponse - XPSDataErrors: - description: Different types of errors and the stats associatesd with each error. + items: + $ref: >- + #/components/schemas/XPSBoundingBoxMetricsEntryConfidenceMetricsEntry + XPSBoundingBoxMetricsEntryConfidenceMetricsEntry: + id: XPSBoundingBoxMetricsEntryConfidenceMetricsEntry + description: Metrics for a single confidence threshold. + type: object properties: - errorType: - description: Type of the error. - enumDescriptions: - - Not specified. - - >- - Audio format not in the formats by cloud-speech AutoML. Currently - only wav and flac file formats are supported. - - >- - File format differnt from what is specified in the file name - extension. - - File too large. Maximum allowed size is 50 MB. - - Transcript is missing. - type: string - enum: - - ERROR_TYPE_UNSPECIFIED - - UNSUPPORTED_AUDIO_FORMAT - - FILE_EXTENSION_MISMATCH_WITH_AUDIO_FORMAT - - FILE_TOO_LARGE - - MISSING_TRANSCRIPTION - count: - format: int32 - description: Number of records having errors associated with the enum. - type: integer + confidenceThreshold: + description: The confidence threshold value used to compute the metrics. + type: number + format: float + recall: + description: Recall for the given confidence threshold. + type: number + format: float + precision: + description: Precision for the given confidence threshold. + type: number + format: float + f1Score: + description: The harmonic mean of recall and precision. + type: number + format: float + XPSTextExtractionEvaluationMetrics: + id: XPSTextExtractionEvaluationMetrics type: object - id: XPSDataErrors - CpuMetric: properties: - cpuType: - enum: - - UNKNOWN_CPU_TYPE - - A2 - - A3 - - C2 - - C2D - - CUSTOM - - E2 - - G2 - - C3 - - M2 - - M1 - - N1 - - N2_CUSTOM - - N2 - - N2D - description: Required. Type of cpu, e.g. N2. - enumDescriptions: - - '' - - GPU-based machine, skip quota reporting. - - GPU-based machine, skip quota reporting. - - COMPUTE_OPTIMIZED - - '' - - '' - - '' - - GPU-based machine, skip quota reporting. - - '' - - MEMORY_OPTIMIZED_UPGRADE_PREMIUM - - MEMORY_OPTIMIZED - - '' - - '' - - '' - - '' - type: string - machineSpec: - description: Required. Machine spec, e.g. N1_STANDARD_4. - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - enum: - - UNKNOWN_MACHINE_SPEC - - N1_STANDARD_2 - - N1_STANDARD_4 - - N1_STANDARD_8 - - N1_STANDARD_16 - - N1_STANDARD_32 - - N1_STANDARD_64 - - N1_STANDARD_96 - - N1_HIGHMEM_2 - - N1_HIGHMEM_4 - - N1_HIGHMEM_8 - - N1_HIGHMEM_16 - - N1_HIGHMEM_32 - - N1_HIGHMEM_64 - - N1_HIGHMEM_96 - - N1_HIGHCPU_2 - - N1_HIGHCPU_4 - - N1_HIGHCPU_8 - - N1_HIGHCPU_16 - - N1_HIGHCPU_32 - - N1_HIGHCPU_64 - - N1_HIGHCPU_96 - - A2_HIGHGPU_1G - - A2_HIGHGPU_2G - - A2_HIGHGPU_4G - - A2_HIGHGPU_8G - - A2_MEGAGPU_16G - - A2_ULTRAGPU_1G - - A2_ULTRAGPU_2G - - A2_ULTRAGPU_4G - - A2_ULTRAGPU_8G - - A3_HIGHGPU_1G - - A3_HIGHGPU_2G - - A3_HIGHGPU_4G - - A3_HIGHGPU_8G - - A3_MEGAGPU_8G - - E2_STANDARD_2 - - E2_STANDARD_4 - - E2_STANDARD_8 - - E2_STANDARD_16 - - E2_STANDARD_32 - - E2_HIGHMEM_2 - - E2_HIGHMEM_4 - - E2_HIGHMEM_8 - - E2_HIGHMEM_16 - - E2_HIGHCPU_2 - - E2_HIGHCPU_4 - - E2_HIGHCPU_8 - - E2_HIGHCPU_16 - - E2_HIGHCPU_32 - - N2_STANDARD_2 - - N2_STANDARD_4 - - N2_STANDARD_8 - - N2_STANDARD_16 - - N2_STANDARD_32 - - N2_STANDARD_48 - - N2_STANDARD_64 - - N2_STANDARD_80 - - N2_STANDARD_96 - - N2_STANDARD_128 - - N2_HIGHMEM_2 - - N2_HIGHMEM_4 - - N2_HIGHMEM_8 - - N2_HIGHMEM_16 - - N2_HIGHMEM_32 - - N2_HIGHMEM_48 - - N2_HIGHMEM_64 - - N2_HIGHMEM_80 - - N2_HIGHMEM_96 - - N2_HIGHMEM_128 - - N2_HIGHCPU_2 - - N2_HIGHCPU_4 - - N2_HIGHCPU_8 - - N2_HIGHCPU_16 - - N2_HIGHCPU_32 - - N2_HIGHCPU_48 - - N2_HIGHCPU_64 - - N2_HIGHCPU_80 - - N2_HIGHCPU_96 - - N2D_STANDARD_2 - - N2D_STANDARD_4 - - N2D_STANDARD_8 - - N2D_STANDARD_16 - - N2D_STANDARD_32 - - N2D_STANDARD_48 - - N2D_STANDARD_64 - - N2D_STANDARD_80 - - N2D_STANDARD_96 - - N2D_STANDARD_128 - - N2D_STANDARD_224 - - N2D_HIGHMEM_2 - - N2D_HIGHMEM_4 - - N2D_HIGHMEM_8 - - N2D_HIGHMEM_16 - - N2D_HIGHMEM_32 - - N2D_HIGHMEM_48 - - N2D_HIGHMEM_64 - - N2D_HIGHMEM_80 - - N2D_HIGHMEM_96 - - N2D_HIGHCPU_2 - - N2D_HIGHCPU_4 - - N2D_HIGHCPU_8 - - N2D_HIGHCPU_16 - - N2D_HIGHCPU_32 - - N2D_HIGHCPU_48 - - N2D_HIGHCPU_64 - - N2D_HIGHCPU_80 - - N2D_HIGHCPU_96 - - N2D_HIGHCPU_128 - - N2D_HIGHCPU_224 - - C2_STANDARD_4 - - C2_STANDARD_8 - - C2_STANDARD_16 - - C2_STANDARD_30 - - C2_STANDARD_60 - - C2D_STANDARD_2 - - C2D_STANDARD_4 - - C2D_STANDARD_8 - - C2D_STANDARD_16 - - C2D_STANDARD_32 - - C2D_STANDARD_56 - - C2D_STANDARD_112 - - C2D_HIGHCPU_2 - - C2D_HIGHCPU_4 - - C2D_HIGHCPU_8 - - C2D_HIGHCPU_16 - - C2D_HIGHCPU_32 - - C2D_HIGHCPU_56 - - C2D_HIGHCPU_112 - - C2D_HIGHMEM_2 - - C2D_HIGHMEM_4 - - C2D_HIGHMEM_8 - - C2D_HIGHMEM_16 - - C2D_HIGHMEM_32 - - C2D_HIGHMEM_56 - - C2D_HIGHMEM_112 - - G2_STANDARD_4 - - G2_STANDARD_8 - - G2_STANDARD_12 - - G2_STANDARD_16 - - G2_STANDARD_24 - - G2_STANDARD_32 - - G2_STANDARD_48 - - G2_STANDARD_96 - - C3_STANDARD_4 - - C3_STANDARD_8 - - C3_STANDARD_22 - - C3_STANDARD_44 - - C3_STANDARD_88 - - C3_STANDARD_176 - - C3_HIGHCPU_4 - - C3_HIGHCPU_8 - - C3_HIGHCPU_22 - - C3_HIGHCPU_44 - - C3_HIGHCPU_88 - - C3_HIGHCPU_176 - - C3_HIGHMEM_4 - - C3_HIGHMEM_8 - - C3_HIGHMEM_22 - - C3_HIGHMEM_44 - - C3_HIGHMEM_88 - - C3_HIGHMEM_176 - type: string - coreNumber: - description: Required. Number of CPU cores. - type: string - format: int64 - coreSec: - format: int64 - description: Required. Total seconds of core usage, e.g. 4. - type: string - trackingLabels: - additionalProperties: - type: string - description: >- - Billing tracking labels. They do not contain any user data but only - the labels set by Vertex Core Infra itself. Tracking labels' keys - are defined with special format: goog-[\p{Ll}\p{N}]+ E.g. "key": - "goog-k8s-cluster-name","value": "us-east1-b4rk" - type: object - description: Metric for billing reports. - type: object - id: CpuMetric - XPSTablesEvaluationMetrics: - properties: - regressionMetrics: - $ref: '#/components/schemas/XPSTablesRegressionMetrics' - description: Regression metrics. - classificationMetrics: - description: Classification metrics. - $ref: '#/components/schemas/XPSTablesClassificationMetrics' - id: XPSTablesEvaluationMetrics - type: object - XPSSpeechPreprocessResponse: - type: object - id: XPSSpeechPreprocessResponse - properties: - cnsTestDataPath: - type: string - description: Location od shards of sstables (test data) of DataUtterance protos. - cnsTrainDataPath: - description: >- - Location of shards of sstables (training data) of DataUtterance - protos. - type: string - speechPreprocessStats: - $ref: '#/components/schemas/XPSSpeechPreprocessStats' - description: Stats associated with the data. - prebuiltModelEvaluationMetrics: - $ref: '#/components/schemas/XPSSpeechEvaluationMetrics' - description: >- - The metrics for prebuilt speech models. They are included here - because there is no prebuilt speech models stored in the AutoML. - TpuMetric: - properties: - tpuType: - type: string - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - description: Required. Type of TPU, e.g. TPU_V2, TPU_V3_POD. - enum: - - UNKNOWN_TPU_TYPE - - TPU_V2_POD - - TPU_V2 - - TPU_V3_POD - - TPU_V3 - - TPU_V5_LITEPOD - tpuSec: - description: Required. Seconds of TPU usage, e.g. 3600. - type: string - format: int64 - id: TpuMetric - type: object - XPSStringStats: - properties: - commonStats: - $ref: '#/components/schemas/XPSCommonStats' - topUnigramStats: - type: array - items: - $ref: '#/components/schemas/XPSStringStatsUnigramStats' - description: >- - The statistics of the top 20 unigrams, ordered by - StringStats.UnigramStats.count. - id: XPSStringStats - description: The data statistics of a series of STRING values. - type: object - XPSTablesRegressionMetrics: - description: Metrics for Tables regression problems. - id: XPSTablesRegressionMetrics - properties: - rootMeanSquaredLogError: - type: number - description: Root mean squared log error. - format: double - rootMeanSquaredError: - format: double - type: number - description: Root mean squared error. - meanAbsolutePercentageError: - format: double - type: number - description: >- - Mean absolute percentage error, only set if all of the target - column's values are positive. - rSquared: - format: double - description: R squared. - type: number - meanAbsoluteError: - format: double - type: number - description: Mean absolute error. - regressionMetricsEntries: - description: >- - A list of actual versus predicted points for the model being - evaluated. - items: - $ref: '#/components/schemas/XPSRegressionMetricsEntry' - type: array - type: object - EntityMention: - id: EntityMention - description: >- - Represents a mention for an entity in the text. Currently, proper noun - mentions are supported. - properties: - type: - enum: - - TYPE_UNKNOWN - - PROPER - - COMMON - type: string - description: The type of the entity mention. - enumDescriptions: - - Unknown - - Proper name - - Common noun (or noun compound) - probability: - format: float - type: number - description: >- - Probability score associated with the entity. The score shows the - probability of the entity mention being the entity type. The score - is in (0, 1] range. - text: - $ref: '#/components/schemas/TextSpan' - description: The mention text. - sentiment: - $ref: '#/components/schemas/Sentiment' - description: >- - For calls to AnalyzeEntitySentimentRequest or if - AnnotateTextRequest.Features.extract_entity_sentiment is set to - true, this field will contain the sentiment expressed for this - mention of the entity in the provided document. - type: object - XPSEvaluationMetrics: - id: XPSEvaluationMetrics - description: >- - Contains xPS-specific model evaluation metrics either for a single - annotation spec (label), or for the model overall. Next tag: 18. - type: object - properties: - videoActionRecognitionEvalMetrics: - $ref: '#/components/schemas/XPSVideoActionRecognitionEvaluationMetrics' - category: - description: >- - The integer category label for which this evaluation metric instance - had been created. Valid categories are 0 or higher. Overall model - evaluation should set this to negative values (rather than implicit - zero). Only used for Image Segmentation (prefer to set - annotation_spec_id_token instead). Note: uCAIP Image Segmentation - should use annotation_spec_id_token. - format: int32 - type: integer - tablesEvalMetrics: - $ref: '#/components/schemas/XPSTablesEvaluationMetrics' - label: - description: >- - The label for which this evaluation metrics instance had been - created. Empty iff this is an overall model evaluation (like Tables - evaluation metrics), i.e. aggregated across all labels. The label - maps to AnnotationSpec.display_name in Public API protos. Only used - by MVP implementation and text sentiment FULL implementation. - type: string - imageObjectDetectionEvalMetrics: - $ref: '#/components/schemas/XPSImageObjectDetectionEvaluationMetrics' - regressionEvalMetrics: - $ref: '#/components/schemas/XPSRegressionEvaluationMetrics' - imageClassificationEvalMetrics: - $ref: '#/components/schemas/XPSClassificationEvaluationMetrics' - textExtractionEvalMetrics: - $ref: '#/components/schemas/XPSTextExtractionEvaluationMetrics' - imageSegmentationEvalMetrics: - $ref: '#/components/schemas/XPSImageSegmentationEvaluationMetrics' - annotationSpecIdToken: - description: >- - The annotation_spec for which this evaluation metrics instance had - been created. Empty iff this is an overall model evaluation (like - Tables evaluation metrics), i.e. aggregated across all labels. The - value comes from the input annotations in AnnotatedExample. For MVP - product or for text sentiment models where annotation_spec_id_token - is not available, set label instead. - type: string - evaluatedExampleCount: - type: integer - format: int32 - description: >- - The number of examples used to create this evaluation metrics - instance. - videoClassificationEvalMetrics: - $ref: '#/components/schemas/XPSClassificationEvaluationMetrics' - tablesClassificationEvalMetrics: - $ref: '#/components/schemas/XPSClassificationEvaluationMetrics' - textSentimentEvalMetrics: - $ref: '#/components/schemas/XPSTextSentimentEvaluationMetrics' - videoObjectTrackingEvalMetrics: - $ref: '#/components/schemas/XPSVideoObjectTrackingEvaluationMetrics' - textClassificationEvalMetrics: - $ref: '#/components/schemas/XPSClassificationEvaluationMetrics' - translationEvalMetrics: - $ref: '#/components/schemas/XPSTranslationEvaluationMetrics' - XPSIntegratedGradientsAttribution: - deprecated: true - type: object - properties: - stepCount: - format: int32 - description: >- - The number of steps for approximating the path integral. A good - value to start is 50 and gradually increase until the sum to diff - property is within the desired error range. Valid range of its value - is [1, 100], inclusively. - type: integer - id: XPSIntegratedGradientsAttribution - description: >- - An attribution method that computes the Aumann-Shapley value taking - advantage of the model's fully differentiable structure. Refer to this - paper for more details: https://arxiv.org/abs/1703.01365 - XPSDataStats: - id: XPSDataStats - properties: - structStats: - $ref: '#/components/schemas/XPSStructStats' - description: The statistics for STRUCT DataType. - stringStats: - description: The statistics for STRING DataType. - $ref: '#/components/schemas/XPSStringStats' - float64Stats: - $ref: '#/components/schemas/XPSFloat64Stats' - description: The statistics for FLOAT64 DataType. - arrayStats: - $ref: '#/components/schemas/XPSArrayStats' - description: The statistics for ARRAY DataType. - nullValueCount: - description: The number of values that are null. - type: string - format: int64 - validValueCount: - description: The number of values that are valid. - type: string - format: int64 - categoryStats: - $ref: '#/components/schemas/XPSCategoryStats' - description: The statistics for CATEGORY DataType. - distinctValueCount: - type: string - description: The number of distinct values. - format: int64 - timestampStats: - $ref: '#/components/schemas/XPSTimestampStats' - description: The statistics for TIMESTAMP DataType. - type: object - description: The data statistics of a series of values that share the same DataType. - XPSVideoTrainingOperationMetadata: - type: object - id: XPSVideoTrainingOperationMetadata - properties: - trainCostMilliNodeHour: - format: int64 - description: >- - This is an estimation of the node hours necessary for training a - model, expressed in milli node hours (i.e. 1,000 value in this field - means 1 node hour). A node hour represents the time a virtual - machine spends running your training job. The cost of one node - running for one hour is a node hour. - type: string - XPSCategoryStats: - type: object - properties: - commonStats: - $ref: '#/components/schemas/XPSCommonStats' - topCategoryStats: - type: array - items: - $ref: '#/components/schemas/XPSCategoryStatsSingleCategoryStats' - description: >- - The statistics of the top 20 CATEGORY values, ordered by - CategoryStats.SingleCategoryStats.count. - id: XPSCategoryStats - description: The data statistics of a series of CATEGORY values. - XPSColorMapIntColor: - description: RGB color and each channel is represented by an integer. - properties: - blue: - format: int32 - description: The value should be in range of [0, 255]. - type: integer - green: - description: The value should be in range of [0, 255]. - type: integer - format: int32 - red: - format: int32 - description: The value should be in range of [0, 255]. - type: integer - id: XPSColorMapIntColor - type: object - XPSSpeechModelSpecSubModelSpec: - id: XPSSpeechModelSpecSubModelSpec - type: object - properties: - contextId: - description: In S3, Recognition ClientContextId.context_id - type: string - isEnhancedModel: - type: boolean - description: >- - If true then it means we have an enhanced version of the biasing - models. - clientId: - type: string - description: In S3, Recognition ClientContextId.client_id - biasingModelType: - description: Type of the biasing model. - type: string - enum: - - BIASING_MODEL_TYPE_UNSPECIFIED - - COMMAND_AND_SEARCH - - PHONE_CALL - - VIDEO - - DEFAULT - enumDescriptions: - - '' - - Build biasing model on top of COMMAND_AND_SEARCH model - - Build biasing model on top of PHONE_CALL model - - Build biasing model on top of VIDEO model - - Build biasing model on top of DEFAULT model - XPSTrainResponse: - properties: - explanationConfigs: - description: >- - VisionExplanationConfig for XAI on test set. Optional for when XAI - is enable in training request. - deprecated: true - items: - $ref: '#/components/schemas/XPSResponseExplanationSpec' - type: array - textTrainResp: - $ref: '#/components/schemas/XPSTextTrainResponse' - description: Will only be needed for uCAIP from Beta. - imageClassificationTrainResp: - $ref: '#/components/schemas/XPSImageClassificationTrainResponse' - speechTrainResp: - $ref: '#/components/schemas/XPSSpeechModelSpec' - errorAnalysisConfigs: - items: - $ref: '#/components/schemas/XPSVisionErrorAnalysisConfig' - description: >- - Optional vision model error analysis configuration. The field is set - when model error analysis is enabled in the training request. The - results of error analysis will be binded together with evaluation - results (in the format of AnnotatedExample). - type: array - textToSpeechTrainResp: - $ref: '#/components/schemas/XPSTextToSpeechTrainResponse' - modelToken: - type: string - description: >- - Token that represents the trained model. This is considered - immutable and is persisted in AutoML. xPS can put their own proto in - the byte string, to e.g. point to the model checkpoints. The token - is passed to other xPS APIs to refer to the model. - format: byte - videoClassificationTrainResp: - $ref: '#/components/schemas/XPSVideoClassificationTrainResponse' - tablesTrainResp: - $ref: '#/components/schemas/XPSTablesTrainResponse' - translationTrainResp: - $ref: '#/components/schemas/XPSTranslationTrainResponse' - imageObjectDetectionTrainResp: - $ref: '#/components/schemas/XPSImageObjectDetectionModelSpec' - deployedModelSizeBytes: - description: Estimated model size in bytes once deployed. - type: string - format: int64 - videoObjectTrackingTrainResp: - $ref: '#/components/schemas/XPSVideoObjectTrackingTrainResponse' - videoActionRecognitionTrainResp: - $ref: '#/components/schemas/XPSVideoActionRecognitionTrainResponse' - evaluationMetricsSet: - $ref: '#/components/schemas/XPSEvaluationMetricsSet' - description: >- - The trained model evaluation metrics. This can be optionally - returned. - imageSegmentationTrainResp: - $ref: '#/components/schemas/XPSImageSegmentationTrainResponse' - evaluatedExampleSet: - $ref: '#/components/schemas/XPSExampleSet' - description: >- - Examples used to evaluate the model (usually the test set), with the - predicted annotations. The file_spec should point to recordio - file(s) of AnnotatedExample. For each returned example, the - example_id_token and annotations predicted by the model must be set. - The example payload can and is recommended to be omitted. - type: object - id: XPSTrainResponse - AnnotateTextRequestFeatures: - description: >- - All available features. Setting each one to true will enable that - specific analysis for the input. - type: object - id: AnnotateTextRequestFeatures - properties: - extractEntities: - description: Optional. Extract entities. - type: boolean - extractDocumentSentiment: - description: Optional. Extract document-level sentiment. - type: boolean - classifyText: - description: Optional. Classify the full document into categories. - type: boolean - moderateText: - description: >- - Optional. Moderate the document for harmful and sensitive - categories. - type: boolean - XPSTextComponentModel: - properties: - submodelType: - enum: - - TEXT_MODEL_TYPE_UNSPECIFIED - - TEXT_MODEL_TYPE_DEFAULT - - TEXT_MODEL_TYPE_META_ARCHITECT - - TEXT_MODEL_TYPE_ATC - - TEXT_MODEL_TYPE_CLARA2 - - TEXT_MODEL_TYPE_CHATBASE - - TEXT_MODEL_TYPE_SAFT_SPAN_LABELING - - TEXT_MODEL_TYPE_TEXT_EXTRACTION - - TEXT_MODEL_TYPE_RELATIONSHIP_EXTRACTION - - TEXT_MODEL_TYPE_COMPOSITE - - TEXT_MODEL_TYPE_ALL_MODELS - - TEXT_MODEL_TYPE_BERT - - TEXT_MODEL_TYPE_ENC_PALM - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - Model type for entity extraction. - - Model type for relationship extraction. - - >- - A composite model represents a set of component models that have - to be used together for prediction. A composite model appears to - be a single model to the model user. It may contain only one - component model. - - >- - Model type used to train default, MA, and ATC models in a single - batch worker pipeline. - - >- - BERT pipeline needs a specific model type, since it uses a - different TFX configuration compared with DEFAULT (despite sharing - most of the code). - - Model type for EncPaLM. - type: string - description: The type of trained NL submodel - submodelName: - type: string - description: The name of the trained NL submodel. - servingArtifact: - $ref: '#/components/schemas/XPSModelArtifactItem' - description: >- - The default model binary file used for serving (e.g. online predict, - batch predict) via public Cloud Ai Platform API. - batchPredictionModelGcsUri: - type: string - description: The Cloud Storage resource path to hold batch prediction model. - servoModelName: - type: string - description: >- - The name of servo model. Populated by uCAIP BE as part of online - PredictRequest. - versionNumber: - description: >- - The servomatic model version number. Populated by uCAIP BE as part - of online PredictRequest. - type: string - format: int64 - onlinePredictionModelGcsUri: - type: string - description: The Cloud Storage resource path to hold online prediction model. - tfRuntimeVersion: - type: string - description: >- - ## The fields below are only populated under uCAIP request scope. - https://cloud.google.com/ml-engine/docs/runtime-version-list - partition: - enumDescriptions: - - '' - - The default partition. - - >- - It has significantly lower replication than partition-0 and is - located in the US only. It also has a larger model size limit and - higher default RAM quota than partition-0. Customers with batch - traffic, US-based traffic, or very large models should use this - partition. Capacity in this partition is significantly cheaper - than partition-0. - - To be used by customers with Jellyfish-accelerated ops. - - The partition used by regionalized servomatic cloud regions. - - The partition used for loading models from custom storage. - enum: - - PARTITION_TYPE_UNSPECIFIED - - PARTITION_ZERO - - PARTITION_REDUCED_HOMING - - PARTITION_JELLYFISH - - PARTITION_CPU - - PARTITION_CUSTOM_STORAGE_CPU - type: string - description: >- - The partition where the model is deployed. Populated by uCAIP BE as - part of online PredictRequest. - type: object - description: Component model. - id: XPSTextComponentModel - XPSXraiAttribution: - id: XPSXraiAttribution - type: object - deprecated: true - properties: - stepCount: - description: >- - The number of steps for approximating the path integral. A good - value to start is 50 and gradually increase until the sum to diff - property is met within the desired error range. Valid range of its - value is [1, 100], inclusively. - format: int32 - type: integer - description: >- - An explanation method that redistributes Integrated Gradients - attributions to segmented regions, taking advantage of the model's fully - differentiable structure. Refer to this paper for more details: - https://arxiv.org/abs/1906.02825 Only supports image Models (modality is - IMAGE). - ClassificationCategory: - id: ClassificationCategory - type: object - properties: - severity: - description: >- - Optional. The classifier's severity of the category. This is only - present when the ModerateTextRequest.ModelVersion is set to - MODEL_VERSION_2, and the corresponding category has a severity - score. - type: number - format: float - name: - description: The name of the category representing the document. - type: string - confidence: - description: >- - The classifier's confidence of the category. Number represents how - certain the classifier is that this category represents the given - text. - format: float - type: number - description: Represents a category returned from the text classifier. - InfraUsage: - description: Infra Usage of billing metrics. - type: object - properties: - diskMetrics: - type: array - items: - $ref: '#/components/schemas/DiskMetric' - description: Aggregated persistent disk metrics since requested start_time. - tpuMetrics: - type: array - description: Aggregated tpu metrics since requested start_time. - items: - $ref: '#/components/schemas/TpuMetric' - ramMetrics: - description: Aggregated ram metrics since requested start_time. - type: array - items: - $ref: '#/components/schemas/RamMetric' - gpuMetrics: - description: Aggregated gpu metrics since requested start_time. - type: array - items: - $ref: '#/components/schemas/GpuMetric' - cpuMetrics: - description: Aggregated core metrics since requested start_time. - type: array - items: - $ref: '#/components/schemas/CpuMetric' - id: InfraUsage - XPSColumnSpec: - properties: - columnId: - format: int32 - description: >- - The unique id of the column. When Preprocess, the Tables BE will - popuate the order id of the column, which reflects the order of the - column inside the table, i.e. 0 means the first column in the table, - N-1 means the last column. AutoML BE will persist this order id in - Spanner and set the order id here when calling RefreshTablesStats - and Train. Note: it's different than the column_spec_id that is - generated in AutoML BE. - type: integer - forecastingMetadata: - $ref: '#/components/schemas/XPSColumnSpecForecastingMetadata' - dataType: - $ref: '#/components/schemas/XPSDataType' - description: >- - The data type of the column. It's outputed in Preprocess rpc and a - required input for RefreshTablesStats and Train. - displayName: - type: string + confidenceMetricsEntries: description: >- - The display name of the column. It's outputed in Preprocess and a - required input for RefreshTablesStats and Train. - topCorrelatedColumns: + If the enclosing EvaluationMetrics.label is empty, + confidence_metrics_entries is an evaluation of the entire model + across all labels. If the enclosing EvaluationMetrics.label is set, + confidence_metrics_entries applies to that label. type: array items: - $ref: '#/components/schemas/XPSColumnSpecCorrelatedColumn' - description: It's outputed in RefreshTablesStats, and a required input in Train. - dataStats: - $ref: '#/components/schemas/XPSDataStats' - description: >- - The data stats of the column. It's outputed in RefreshTablesStats - and a required input for Train. - type: object - id: XPSColumnSpec - AnalyzeSentimentResponse: - type: object - properties: - languageCode: - type: string + $ref: '#/components/schemas/XPSConfidenceMetricsEntry' + bestF1ConfidenceMetrics: description: >- - The language of the text, which will be the same as the language - specified in the request or, if not specified, the - automatically-detected language. See Document.language field for - more details. - documentSentiment: - description: The overall sentiment of the input document. - $ref: '#/components/schemas/Sentiment' - sentences: - description: The sentiment for all the sentences in the document. - type: array - items: - $ref: '#/components/schemas/Sentence' - languageSupported: + Values are at the highest F1 score on the precision-recall curve. + Only confidence_threshold, recall, precision, and f1_score will be + set. + deprecated: true + $ref: '#/components/schemas/XPSConfidenceMetricsEntry' + perLabelConfidenceMetrics: + description: Only recall, precision, and f1_score will be set. + deprecated: true + type: object + additionalProperties: + $ref: '#/components/schemas/XPSConfidenceMetricsEntry' + confusionMatrix: description: >- - Whether the language is officially supported. The API may still - return a response when the language is not supported, but it is on a - best effort basis. - type: boolean - id: AnalyzeSentimentResponse - description: The sentiment analysis response message. - XPSTablesDatasetMetadata: - description: Metadata for a dataset used for AutoML Tables. - id: XPSTablesDatasetMetadata + Confusion matrix of the model, at the default confidence threshold + (0.0). Only set for whole-model evaluation, not for evaluation per + label. + $ref: '#/components/schemas/XPSConfusionMatrix' + XPSVideoObjectTrackingEvaluationMetrics: + id: XPSVideoObjectTrackingEvaluationMetrics + description: 'Model evaluation metrics for ObjectTracking problems. Next tag: 10.' + type: object properties: - primaryTableSpec: - description: Primary table. - $ref: '#/components/schemas/XPSTableSpec' - mlUseColumnId: - format: int32 - description: Id the column to split the table. + evaluatedFrameCount: + description: The number of video frames used for model evaluation. type: integer - weightColumnId: + format: int32 + evaluatedBoundingboxCount: + description: The number of bounding boxes used for model evaluation. type: integer - description: >- - Id of the primary table column that should be used as the weight - column. format: int32 - targetColumnCorrelations: - description: '(the column id : its CorrelationStats with target column).' - type: object - additionalProperties: - $ref: '#/components/schemas/XPSCorrelationStats' - targetColumnId: + evaluatedTrackCount: + description: The number of tracks used for model evaluation. type: integer - description: >- - Id of the primary table column that should be used as the training - label. format: int32 - type: object - XPSMetricEntry: - type: object - properties: - systemLabels: - type: array - description: Billing system labels for this (metric, value) pair. - items: - $ref: '#/components/schemas/XPSMetricEntryLabel' - argentumMetricId: - type: string - description: >- - For billing metrics that are using legacy sku's, set the legacy - billing metric id here. This will be sent to Chemist as the - "cloudbilling.googleapis.com/argentum_metric_id" label. Otherwise - leave empty. - doubleValue: - description: A double value. - format: double - type: number - int64Value: - format: int64 - description: A signed 64-bit integer value. - type: string - metricName: - description: The metric name defined in the service configuration. - type: string - id: XPSMetricEntry - XPSVideoClassificationTrainResponse: - properties: - trainCostNodeSeconds: - format: int64 - type: string - description: >- - The actual train cost of creating this model, expressed in node - seconds, i.e. 3,600 value in this field means 1 node hour. - modelArtifactSpec: - $ref: '#/components/schemas/XPSVideoModelArtifactSpec' - description: '## The fields below are only populated under uCAIP request scope.' - type: object - id: XPSVideoClassificationTrainResponse - AnalyzeSentimentRequest: - type: object - properties: - encodingType: - type: string - enumDescriptions: - - >- - If `EncodingType` is not specified, encoding-dependent information - (such as `begin_offset`) will be set at `-1`. - - >- - Encoding-dependent information (such as `begin_offset`) is - calculated based on the UTF-8 encoding of the input. C++ and Go - are examples of languages that use this encoding natively. - - >- - Encoding-dependent information (such as `begin_offset`) is - calculated based on the UTF-16 encoding of the input. Java and - JavaScript are examples of languages that use this encoding - natively. - - >- - Encoding-dependent information (such as `begin_offset`) is - calculated based on the UTF-32 encoding of the input. Python is an - example of a language that uses this encoding natively. - enum: - - NONE - - UTF8 - - UTF16 - - UTF32 - description: The encoding type used by the API to calculate sentence offsets. - document: - description: Required. Input document. - $ref: '#/components/schemas/Document' - id: AnalyzeSentimentRequest - description: The sentiment analysis request message. - XPSTfSavedModelFormat: - id: XPSTfSavedModelFormat - properties: {} - description: A tensorflow model format in SavedModel format. - type: object - XPSVisionTrainingOperationMetadata: - type: object - properties: - explanationUsage: - $ref: '#/components/schemas/InfraUsage' + boundingBoxMetricsEntries: description: >- - Aggregated infra usage within certain time period, for billing - report purpose if XAI is enable in training request. - id: XPSVisionTrainingOperationMetadata - deprecated: true - XPSTablesTrainResponse: - properties: - modelStructure: - $ref: '#/components/schemas/XPSTablesModelStructure' - tablesModelColumnInfo: - items: - $ref: '#/components/schemas/XPSTablesModelColumnInfo' + Output only. The bounding boxes match metrics for each + Intersection-over-union threshold + 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. type: array + items: + $ref: '#/components/schemas/XPSBoundingBoxMetricsEntry' + trackMetricsEntries: description: >- - Output only. Auxiliary information for each of the - input_feature_column_specs, with respect to this particular model. - trainCostMilliNodeHours: - description: >- - The actual training cost of the model, expressed in milli node - hours, i.e. 1,000 value in this field means 1 node hour. Guaranteed - to not exceed the train budget. - format: int64 - type: string - predictionSampleRows: + Output only. The tracks match metrics for each + Intersection-over-union threshold + 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. type: array - description: Sample rows from the dataset this model was trained. items: - $ref: '#/components/schemas/XPSRow' - type: object - id: XPSTablesTrainResponse - XPSResponseExplanationSpec: - description: >- - Specification of Model explanation. Feature-based XAI in AutoML Vision - ICN is deprecated. - type: object - id: XPSResponseExplanationSpec - properties: - parameters: - $ref: '#/components/schemas/XPSResponseExplanationParameters' - description: Parameters that configure explaining of the Model's predictions. - explanationType: - description: >- - Explanation type. For AutoML Image Classification models, possible - values are: * `image-integrated-gradients` * `image-xrai` - type: string - metadata: - description: Metadata describing the Model's input and output for explanation. - $ref: '#/components/schemas/XPSResponseExplanationMetadata' - deprecated: true - XPSConfidenceMetricsEntry: - description: >- - ConfidenceMetricsEntry includes generic precision, recall, f1 score etc. - Next tag: 16. - properties: - positionThreshold: + $ref: '#/components/schemas/XPSTrackMetricsEntry' + boundingBoxMeanAveragePrecision: description: >- - Metrics are computed with an assumption that the model always - returns at most this many predictions (ordered by their score, - descendingly), but they all still need to meet the - confidence_threshold. - type: integer - format: int32 - precision: - format: float - description: Precision for the given confidence threshold. + Output only. The single metric for bounding boxes evaluation: the + mean_average_precision averaged over all + bounding_box_metrics_entries. type: number - f1ScoreAt1: - description: The harmonic mean of recall_at1 and precision_at1. format: float - type: number - trueNegativeCount: - format: int64 - type: string + trackMeanAveragePrecision: description: >- - The number of labels that were not created by the model, but if they - would, they would not match a ground truth label. - recallAt1: + Output only. The single metric for tracks accuracy evaluation: the + mean_average_precision averaged over all track_metrics_entries. + type: number format: float + trackMeanBoundingBoxIou: description: >- - The recall (true positive rate) when only considering the label that - has the highest prediction score and not below the confidence - threshold for each example. + Output only. The single metric for tracks bounding box iou + evaluation: the mean_bounding_box_iou averaged over all + track_metrics_entries. type: number - falseNegativeCount: - type: string - format: int64 - description: >- - The number of ground truth labels that are not matched by a model - created label. - falsePositiveRateAt1: format: float + trackMeanMismatchRate: description: >- - The False Positive Rate when only considering the label that has the - highest prediction score and not below the confidence threshold for - each example. - type: number - f1Score: + Output only. The single metric for tracking consistency evaluation: + the mean_mismatch_rate averaged over all track_metrics_entries. type: number - description: The harmonic mean of recall and precision. format: float - precisionAt1: - type: number + XPSTrackMetricsEntry: + id: XPSTrackMetricsEntry + description: >- + Track matching model metrics for a single track match threshold and + multiple label match confidence thresholds. Next tag: 6. + type: object + properties: + iouThreshold: description: >- - The precision when only considering the label that has the highest - prediction score and not below the confidence threshold for each - example. - format: float - falsePositiveRate: - format: float + Output only. The intersection-over-union threshold value between + bounding boxes across frames used to compute this metric entry. type: number - description: False Positive Rate for the given confidence threshold. - truePositiveCount: - description: The number of model created labels that match a ground truth label. - type: string - format: int64 - recall: format: float - description: Recall (true positive rate) for the given confidence threshold. - type: number - falsePositiveCount: - type: string - format: int64 + meanTrackingAveragePrecision: description: >- - The number of model created labels that do not match a ground truth - label. - confidenceThreshold: + Output only. The mean average precision over all confidence + thresholds. type: number - description: >- - Metrics are computed with an assumption that the model never return - predictions with score lower than this value. format: float - type: object - id: XPSConfidenceMetricsEntry - XPSTablesPreprocessResponse: - id: XPSTablesPreprocessResponse - type: object - properties: - tablesDatasetMetadata: - description: >- - The table/column id, column_name and the DataTypes of the columns - will be populated. - $ref: '#/components/schemas/XPSTablesDatasetMetadata' - TextSpan: - properties: - content: - description: The content of the text span, which is a substring of the document. - type: string - beginOffset: - format: int32 - type: integer + meanBoundingBoxIou: description: >- - The API calculates the beginning offset of the content in the - original document according to the EncodingType specified in the API - request. - id: TextSpan - description: Represents a text span in the input document. - type: object - XPSArrayStats: - properties: - commonStats: - $ref: '#/components/schemas/XPSCommonStats' - memberStats: + Output only. The mean bounding box iou over all confidence + thresholds. + type: number + format: float + meanMismatchRate: + description: Output only. The mean mismatch rate over all confidence thresholds. + type: number + format: float + confidenceMetricsEntries: description: >- - Stats of all the values of all arrays, as if they were a single long - series of data. The type depends on the element type of the array. - $ref: '#/components/schemas/XPSDataStats' - id: XPSArrayStats - type: object - description: The data statistics of a series of ARRAY values. - XPSPreprocessResponse: - id: XPSPreprocessResponse + Output only. Metrics for each label-match confidence_threshold from + 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. Precision-recall curve is + derived from them. + type: array + items: + $ref: '#/components/schemas/XPSTrackMetricsEntryConfidenceMetricsEntry' + XPSTrackMetricsEntryConfidenceMetricsEntry: + id: XPSTrackMetricsEntryConfidenceMetricsEntry + description: 'Metrics for a single confidence threshold. Next tag: 6.' type: object properties: - outputExampleSet: - $ref: '#/components/schemas/XPSExampleSet' + confidenceThreshold: description: >- - Preprocessed examples, that are to be imported into AutoML storage. - This should point to RecordIO file(s) of PreprocessedExample - messages. The PreprocessedExample.mvp_training_data-s returned here - are later verbatim passed to Train() call in - TrainExample.mvp_training_data. - tablesPreprocessResponse: - $ref: '#/components/schemas/XPSTablesPreprocessResponse' - speechPreprocessResp: - $ref: '#/components/schemas/XPSSpeechPreprocessResponse' - translationPreprocessResp: - $ref: '#/components/schemas/XPSTranslationPreprocessResponse' - XPSTranslationTrainResponse: - description: Train response for translation. - id: XPSTranslationTrainResponse - type: object - properties: - modelType: - description: Type of the model. - enum: - - MODEL_TYPE_UNSPECIFIED - - LEGACY - - CURRENT - enumDescriptions: - - Default - - Legacy model. Will be deprecated. - - Current model. - type: string - XPSVideoActionMetricsEntryConfidenceMetricsEntry: - description: Metrics for a single confidence threshold. - id: XPSVideoActionMetricsEntryConfidenceMetricsEntry - properties: - precision: - format: float - description: Output only. Precision for the given confidence threshold. + Output only. The confidence threshold value used to compute the + metrics. type: number - f1Score: - description: Output only. The harmonic mean of recall and precision. format: float + trackingPrecision: + description: Output only. Tracking precision. type: number - confidenceThreshold: + format: float + trackingRecall: + description: Output only. Tracking recall. type: number format: float + boundingBoxIou: description: >- - Output only. The confidence threshold value used to compute the - metrics. - recall: - description: Output only. Recall for the given confidence threshold. + Output only. Bounding box intersection-over-union precision. + Measures how well the bounding boxes overlap between each other + (e.g. complete overlap or just barely above iou_threshold). + type: number format: float + mismatchRate: + description: >- + Output only. Mismatch rate, which measures the tracking consistency, + i.e. correctness of instance ID continuity. type: number - type: object - XPSVideoActionRecognitionTrainResponse: + format: float + XPSTablesEvaluationMetrics: + id: XPSTablesEvaluationMetrics type: object properties: - modelArtifactSpec: - $ref: '#/components/schemas/XPSVideoModelArtifactSpec' - description: '## The fields below are only populated under uCAIP request scope.' - trainCostNodeSeconds: - format: int64 - type: string - description: >- - The actual train cost of creating this model, expressed in node - seconds, i.e. 3,600 value in this field means 1 node hour. - id: XPSVideoActionRecognitionTrainResponse - XPSTextToSpeechTrainResponse: - id: XPSTextToSpeechTrainResponse - type: object - properties: {} - description: TextToSpeech train response - XPSEdgeTpuTfLiteFormat: - properties: {} - type: object - description: >- - A model format used for [Edge TPU](https://cloud.google.com/edge-tpu/) - devices. - id: XPSEdgeTpuTfLiteFormat - Sentiment: + classificationMetrics: + description: Classification metrics. + $ref: '#/components/schemas/XPSTablesClassificationMetrics' + regressionMetrics: + description: Regression metrics. + $ref: '#/components/schemas/XPSTablesRegressionMetrics' + XPSTablesClassificationMetrics: + id: XPSTablesClassificationMetrics + description: Metrics for Tables classification problems. type: object properties: - magnitude: - type: number - format: float - description: >- - A non-negative number in the [0, +inf] range, which represents the - absolute magnitude of sentiment regardless of score (positive or - negative). - score: - type: number - format: float - description: >- - Sentiment score between -1.0 (negative sentiment) and 1.0 (positive - sentiment). - id: Sentiment - description: >- - Represents the feeling associated with the entire text or entities in - the text. - XPSImageModelArtifactSpec: + curveMetrics: + description: Metrics building a curve. + type: array + items: + $ref: '#/components/schemas/XPSTablesClassificationMetricsCurveMetrics' + XPSTablesClassificationMetricsCurveMetrics: + id: XPSTablesClassificationMetricsCurveMetrics + description: Metrics curve data point for a single value. + type: object properties: - tfLiteMetadataGcsUri: + value: description: >- - Google Cloud Storage URI of Tensorflow Lite metadata - 'tflite_metadata.json'. + The CATEGORY row value (for ARRAY unnested) the curve metrics are + for. type: string - checkpointArtifact: - description: The Tensorflow checkpoint files. e.g. Used for resumable training. - $ref: '#/components/schemas/XPSModelArtifactItem' - exportArtifact: - description: The model binary files in different formats for model export. + positionThreshold: + description: The position threshold value used to compute the metrics. + type: integer + format: int32 + confidenceMetricsEntries: + description: >- + Metrics that have confidence thresholds. Precision-recall curve and + ROC curve can be derived from them. type: array items: - $ref: '#/components/schemas/XPSModelArtifactItem' - labelGcsUri: + $ref: '#/components/schemas/XPSTablesConfidenceMetricsEntry' + aucPr: + description: The area under the precision-recall curve. + type: number + format: double + aucRoc: + description: The area under receiver operating characteristic curve. + type: number + format: double + logLoss: + description: The Log loss metric. + type: number + format: double + XPSTablesConfidenceMetricsEntry: + id: XPSTablesConfidenceMetricsEntry + description: Metrics for a single confidence threshold. + type: object + properties: + confidenceThreshold: + description: The confidence threshold value used to compute the metrics. + type: number + format: double + falsePositiveRate: + description: 'FPR = #false positives / (#false positives + #true negatives)' + type: number + format: double + truePositiveRate: + description: 'TPR = #true positives / (#true positives + #false negatvies)' + type: number + format: double + recall: + description: 'Recall = #true positives / (#true positives + #false negatives).' + type: number + format: double + precision: + description: 'Precision = #true positives / (#true positives + #false positives).' + type: number + format: double + f1Score: description: >- - Google Cloud Storage URI of decoded labels file for model export - 'dict.txt'. + The harmonic mean of recall and precision. (2 * precision * recall) + / (precision + recall) + type: number + format: double + truePositiveCount: + description: True positive count. type: string - tfJsBinaryGcsPrefix: - description: >- - Google Cloud Storage URI prefix of Tensorflow JavaScript binary - files 'groupX-shardXofX.bin'. Deprecated. + format: int64 + falsePositiveCount: + description: False positive count. type: string - servingArtifact: - $ref: '#/components/schemas/XPSModelArtifactItem' - description: >- - The default model binary file used for serving (e.g. online predict, - batch predict) via public Cloud AI Platform API. - description: >- - Stores the locations and related metadata of the model artifacts. - Populated for uCAIP requests only. - id: XPSImageModelArtifactSpec - type: object - XPSTranslationEvaluationMetrics: - id: XPSTranslationEvaluationMetrics - description: Evaluation metrics for the dataset. + format: int64 + trueNegativeCount: + description: True negative count. + type: string + format: int64 + falseNegativeCount: + description: False negative count. + type: string + format: int64 + XPSTablesRegressionMetrics: + id: XPSTablesRegressionMetrics + description: Metrics for Tables regression problems. type: object properties: - baseBleuScore: + rootMeanSquaredError: + description: Root mean squared error. + type: number format: double - description: BLEU score for base model. + meanAbsoluteError: + description: Mean absolute error. type: number - bleuScore: - description: BLEU score. + format: double + meanAbsolutePercentageError: + description: >- + Mean absolute percentage error, only set if all of the target + column's values are positive. type: number format: double - XPSRow: - properties: - columnIds: - type: array - items: - type: integer - format: int32 + rSquared: + description: R squared. + type: number + format: double + rootMeanSquaredLogError: + description: Root mean squared log error. + type: number + format: double + regressionMetricsEntries: description: >- - The ids of the columns. Note: The below `values` field must match - order of this field, if this field is set. - values: - items: - type: any + A list of actual versus predicted points for the model being + evaluated. type: array - description: >- - The values of the row cells, given in the same order as the - column_ids. If column_ids is not set, then in the same order as the - input_feature_column_ids in TablesModelMetadata. - id: XPSRow - type: object - AnnotateTextRequest: - description: >- - The request message for the text annotation API, which can perform - multiple analysis types in one call. - id: AnnotateTextRequest - type: object - properties: - document: - description: Required. Input document. - $ref: '#/components/schemas/Document' - encodingType: - enum: - - NONE - - UTF8 - - UTF16 - - UTF32 - description: The encoding type used by the API to calculate offsets. - enumDescriptions: - - >- - If `EncodingType` is not specified, encoding-dependent information - (such as `begin_offset`) will be set at `-1`. - - >- - Encoding-dependent information (such as `begin_offset`) is - calculated based on the UTF-8 encoding of the input. C++ and Go - are examples of languages that use this encoding natively. - - >- - Encoding-dependent information (such as `begin_offset`) is - calculated based on the UTF-16 encoding of the input. Java and - JavaScript are examples of languages that use this encoding - natively. - - >- - Encoding-dependent information (such as `begin_offset`) is - calculated based on the UTF-32 encoding of the input. Python is an - example of a language that uses this encoding natively. - type: string - features: - $ref: '#/components/schemas/AnnotateTextRequestFeatures' - description: Required. The enabled features. - XPSTablesModelStructureModelParameters: - description: Model hyper-parameters for a model. - properties: - hyperparameters: items: - $ref: >- - #/components/schemas/XPSTablesModelStructureModelParametersParameter - type: array + $ref: '#/components/schemas/XPSRegressionMetricsEntry' + XPSRegressionMetricsEntry: + id: XPSRegressionMetricsEntry + description: A pair of actual & observed values for the model being evaluated. type: object - id: XPSTablesModelStructureModelParameters - XPSVideoObjectTrackingTrainResponse: + properties: + trueValue: + description: The actual target value for a row in the dataset. + type: number + format: float + predictedValue: + description: The observed value for a row in the dataset. + type: number + format: float + XPSRegressionEvaluationMetrics: + id: XPSRegressionEvaluationMetrics + description: >- + Model evaluation metrics for regression problems. It can be used for + Tables. type: object - id: XPSVideoObjectTrackingTrainResponse properties: - trainCostNodeSeconds: - format: int64 - type: string + rootMeanSquaredError: + description: Root Mean Squared Error (RMSE). + type: number + format: float + meanAbsoluteError: + description: Mean Absolute Error (MAE). + type: number + format: float + meanAbsolutePercentageError: description: >- - The actual train cost of creating this model, expressed in node - seconds, i.e. 3,600 value in this field means 1 node hour. - modelArtifactSpec: - $ref: '#/components/schemas/XPSVideoModelArtifactSpec' - description: '## The fields below are only populated under uCAIP request scope.' - exportModelSpec: - description: Populated for AutoML request only. - $ref: '#/components/schemas/XPSVideoExportModelSpec' - XPSConfusionMatrixRow: - properties: - count: - items: - format: int64 - type: string + Mean absolute percentage error. Only set if all ground truth values + are positive. + type: number + format: float + rSquared: + description: R squared. + type: number + format: float + rootMeanSquaredLogError: + description: Root mean squared log error. + type: number + format: float + regressionMetricsEntries: description: >- - Same as above except intended to represent other counts (for e.g. - for segmentation this is pixel count). NOTE(params): Only - example_count or count is set (oneoff does not support repeated - fields unless they are embedded inside another message). - type: array - exampleCount: + A list of actual versus predicted points for the model being + evaluated. type: array - description: >- - Value of the specific cell in the confusion matrix. The number of - values each row has (i.e. the length of the row) is equal to the - length of the annotation_spec_id_token field. items: - type: integer - format: int32 - id: XPSConfusionMatrixRow - description: A row in the confusion matrix. - type: object - DiskMetric: + $ref: '#/components/schemas/XPSRegressionMetricsEntry' + XPSVideoActionRecognitionEvaluationMetrics: + id: XPSVideoActionRecognitionEvaluationMetrics + description: Model evaluation metrics for video action recognition. type: object - id: DiskMetric properties: - diskType: - enum: - - UNKNOWN_DISK_TYPE - - REGIONAL_SSD - - REGIONAL_STORAGE - - PD_SSD - - PD_STANDARD - - STORAGE_SNAPSHOT - description: Required. Type of Disk, e.g. REGIONAL_SSD. - type: string - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - gibSec: - type: string - description: Required. Seconds of physical disk usage, e.g. 3600. - format: int64 + evaluatedActionCount: + description: >- + Output only. The number of ground truth actions used to create this + evaluation. + type: integer + format: int32 + videoActionMetricsEntries: + description: >- + Output only. The metric entries for precision window lengths: + 1s,2s,3s,4s, 5s. + type: array + items: + $ref: '#/components/schemas/XPSVideoActionMetricsEntry' XPSVideoActionMetricsEntry: + id: XPSVideoActionMetricsEntry + description: The Evaluation metrics entry given a specific precision_window_length. type: object properties: precisionWindowLength: - format: google-duration - type: string description: >- This VideoActionMetricsEntry is calculated based on this prediction window length. If the predicted action's timestamp is inside the time window whose center is the ground truth action's timestamp with this specific length, the prediction result is treated as a true positive. + type: string + format: google-duration + meanAveragePrecision: + description: The mean average precision. + type: number + format: float confidenceMetricsEntries: description: >- Metrics for each label-match confidence_threshold from 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. + type: array items: $ref: >- #/components/schemas/XPSVideoActionMetricsEntryConfidenceMetricsEntry - type: array - meanAveragePrecision: - type: number - format: float - description: The mean average precision. - description: The Evaluation metrics entry given a specific precision_window_length. - id: XPSVideoActionMetricsEntry - XPSTuningTrial: - id: XPSTuningTrial - description: >- - Metrics for a tuning job generated, will get forwarded to Stackdriver as - model tuning logs. Setting this as a standalone message out of - CreateModelMetadata to avoid confusion as we expose this message only to - users. - properties: - modelStructure: - $ref: '#/components/schemas/XPSTablesModelStructure' - description: Model parameters for the trial. - trainingObjectivePoint: - description: The optimization objective evaluation of the eval split data. - $ref: '#/components/schemas/XPSTrainingObjectivePoint' - type: object - XPSStringStatsUnigramStats: + XPSVideoActionMetricsEntryConfidenceMetricsEntry: + id: XPSVideoActionMetricsEntryConfidenceMetricsEntry + description: Metrics for a single confidence threshold. type: object - id: XPSStringStatsUnigramStats - description: The statistics of a unigram. - properties: - value: - description: The unigram. - type: string - count: - description: The number of occurrences of this unigram in the series. - type: string - format: int64 - XPSColumnSpecCorrelatedColumn: - id: XPSColumnSpecCorrelatedColumn - description: >- - Identifies a table's column, and its correlation with the column this - ColumnSpec describes. properties: - columnId: - type: integer - format: int32 - correlationStats: - $ref: '#/components/schemas/XPSCorrelationStats' + confidenceThreshold: + description: >- + Output only. The confidence threshold value used to compute the + metrics. + type: number + format: float + recall: + description: Output only. Recall for the given confidence threshold. + type: number + format: float + precision: + description: Output only. Precision for the given confidence threshold. + type: number + format: float + f1Score: + description: Output only. The harmonic mean of recall and precision. + type: number + format: float + XPSTranslationEvaluationMetrics: + id: XPSTranslationEvaluationMetrics + description: Evaluation metrics for the dataset. type: object - XPSResponseExplanationMetadataOutputMetadata: - id: XPSResponseExplanationMetadataOutputMetadata - description: Metadata of the prediction output to be explained. properties: - outputTensorName: - type: string - description: Name of the output tensor. Only needed in train response. - type: object - AnnotateTextResponse: - id: AnnotateTextResponse + bleuScore: + description: BLEU score. + type: number + format: double + baseBleuScore: + description: BLEU score for base model. + type: number + format: double + XPSImageSegmentationEvaluationMetrics: + id: XPSImageSegmentationEvaluationMetrics + description: 'Model evaluation metrics for image segmentation problems. Next tag: 4.' type: object properties: - moderationCategories: - items: - $ref: '#/components/schemas/ClassificationCategory' - description: Harmful and sensitive categories identified in the input document. - type: array - documentSentiment: - $ref: '#/components/schemas/Sentiment' - description: >- - The overall sentiment for the document. Populated if the user - enables AnnotateTextRequest.Features.extract_document_sentiment. - categories: - description: Categories identified in the input document. - items: - $ref: '#/components/schemas/ClassificationCategory' - type: array - languageSupported: - description: >- - Whether the language is officially supported by all requested - features. The API may still return a response when the language is - not supported, but it is on a best effort basis. - type: boolean - sentences: + confidenceMetricsEntries: description: >- - Sentences in the input document. Populated if the user enables - AnnotateTextRequest.Features.extract_document_sentiment. - items: - $ref: '#/components/schemas/Sentence' + Metrics that have confidence thresholds. Precision-recall curve can + be derived from it. type: array - entities: items: - $ref: '#/components/schemas/Entity' - description: >- - Entities, along with their semantic information, in the input - document. Populated if the user enables - AnnotateTextRequest.Features.extract_entities or - AnnotateTextRequest.Features.extract_entity_sentiment. - type: array - languageCode: - type: string - description: >- - The language of the text, which will be the same as the language - specified in the request or, if not specified, the - automatically-detected language. See Document.language field for - more details. - description: The text annotations response message. - XPSBatchPredictResponse: + $ref: >- + #/components/schemas/XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry + XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry: + id: XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry + description: Metrics for a single confidence threshold. type: object - id: XPSBatchPredictResponse - properties: - exampleSet: - description: >- - Examples for batch prediction result. Under full API implementation, - results are stored in shared RecordIO of AnnotatedExample protobufs, - the annotations field of which is populated by XPS backend. - $ref: '#/components/schemas/XPSExampleSet' - XPSSpeechEvaluationMetricsSubModelEvaluationMetric: properties: - biasingModelType: - enumDescriptions: - - '' - - Build biasing model on top of COMMAND_AND_SEARCH model - - Build biasing model on top of PHONE_CALL model - - Build biasing model on top of VIDEO model - - Build biasing model on top of DEFAULT model - description: Type of the biasing model. - type: string - enum: - - BIASING_MODEL_TYPE_UNSPECIFIED - - COMMAND_AND_SEARCH - - PHONE_CALL - - VIDEO - - DEFAULT - numSubstitutions: - type: integer - format: int32 - numInsertions: - format: int32 - type: integer - sentenceAccuracy: - format: double - description: Below fields are used for debugging purposes + confidenceThreshold: + description: The confidence threshold value used to compute the metrics. type: number - numUtterances: - description: Number of utterances used in the wer computation. - type: integer - format: int32 - numWords: - type: integer - format: int32 - description: Number of words over which the word error rate was computed. - numDeletions: - type: integer - format: int32 - isEnhancedModel: - type: boolean - description: >- - If true then it means we have an enhanced version of the biasing - models. - wer: - description: Word error rate (standard error metric used for speech recognition). - format: double + format: float + recall: + description: Recall for the given confidence threshold. + type: number + format: float + precision: + description: Precision for the given confidence threshold. + type: number + format: float + diceScoreCoefficient: + description: 'DSC or the F1 score: The harmonic mean of recall and precision.' type: number - type: object - id: XPSSpeechEvaluationMetricsSubModelEvaluationMetric - XPSCategoryStatsSingleCategoryStats: - id: XPSCategoryStatsSingleCategoryStats - description: The statistics of a single CATEGORY value. - type: object - properties: - value: - type: string - description: The CATEGORY value. - count: - type: string - format: int64 - description: The number of occurrences of this value in the series. + format: float + iouScore: + description: IOU score. + type: number + format: float + confusionMatrix: + description: >- + Confusion matrix of the per confidence_threshold evaluation. Pixel + counts are set here. Only set for model level evaluation, not for + evaluation per label. + $ref: '#/components/schemas/XPSConfusionMatrix' XPSTextSentimentEvaluationMetrics: - description: Model evaluation metrics for text sentiment problems. id: XPSTextSentimentEvaluationMetrics + description: Model evaluation metrics for text sentiment problems. + type: object properties: - meanAbsoluteError: + precision: + description: Output only. Precision. + type: number + format: float + recall: + description: Output only. Recall. + type: number + format: float + f1Score: + description: Output only. The harmonic mean of recall and precision. type: number + format: float + meanAbsoluteError: description: >- Output only. Mean absolute error. Only set for the overall model evaluation, not for evaluation of a single annotation spec. + type: number format: float - confusionMatrix: - $ref: '#/components/schemas/XPSConfusionMatrix' - description: >- - Output only. Confusion matrix of the evaluation. Only set for the - overall model evaluation, not for evaluation of a single annotation - spec. meanSquaredError: - format: float - type: number description: >- Output only. Mean squared error. Only set for the overall model evaluation, not for evaluation of a single annotation spec. - linearKappa: - format: float type: number + format: float + linearKappa: description: >- Output only. Linear weighted kappa. Only set for the overall model evaluation, not for evaluation of a single annotation spec. - f1Score: - format: float - type: number - description: Output only. The harmonic mean of recall and precision. - precision: - format: float - type: number - description: Output only. Precision. - recall: type: number format: float - description: Output only. Recall. quadraticKappa: - format: float - type: number description: >- Output only. Quadratic weighted kappa. Only set for the overall model evaluation, not for evaluation of a single annotation spec. - type: object - XPSTfJsFormat: + type: number + format: float + confusionMatrix: + description: >- + Output only. Confusion matrix of the evaluation. Only set for the + overall model evaluation, not for evaluation of a single annotation + spec. + $ref: '#/components/schemas/XPSConfusionMatrix' + XPSResponseExplanationSpec: + id: XPSResponseExplanationSpec + deprecated: true description: >- - A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used - in the browser and in Node.js using JavaScript. - properties: {} - id: XPSTfJsFormat - type: object - XPSTablesTrainingOperationMetadata: + Specification of Model explanation. Feature-based XAI in AutoML Vision + ICN is deprecated. type: object properties: - topTrials: - type: array - items: - $ref: '#/components/schemas/XPSTuningTrial' + explanationType: description: >- - This field is for training. When the operation is terminated - successfully, AutoML Backend post this field to operation metadata - in spanner. If the metadata has no trials returned, the training - operation is supposed to be a failure. - trainBudgetMilliNodeHours: - format: int64 - type: string - description: Creating model budget. - createModelStage: - enumDescriptions: - - Unspecified stage. - - Prepare the model training pipeline and run data processing. - - Training model. - - Run evaluation. - - Finalizing model training pipeline. + Explanation type. For AutoML Image Classification models, possible + values are: * `image-integrated-gradients` * `image-xrai` type: string - enum: - - CREATE_MODEL_STAGE_UNSPECIFIED - - DATA_PREPROCESSING - - TRAINING - - EVALUATING - - MODEL_POST_PROCESSING - description: Current stage of creating model. - trainingObjectivePoints: - type: array - items: - $ref: '#/components/schemas/XPSTrainingObjectivePoint' + parameters: + description: Parameters that configure explaining of the Model's predictions. + $ref: '#/components/schemas/XPSResponseExplanationParameters' + metadata: + description: Metadata describing the Model's input and output for explanation. + $ref: '#/components/schemas/XPSResponseExplanationMetadata' + XPSResponseExplanationParameters: + id: XPSResponseExplanationParameters + deprecated: true + type: object + properties: + integratedGradientsAttribution: description: >- - This field records the training objective value with respect to - time, giving insight into how the model architecture search is - performing as training time elapses. - trainingStartTime: - description: Timestamp when training process starts. - type: string - format: google-datetime - optimizationObjective: - type: string - description: The optimization objective for model. - id: XPSTablesTrainingOperationMetadata - XPSTimestampStats: + An attribution method that computes Aumann-Shapley values taking + advantage of the model's fully differentiable structure. Refer to + this paper for more details: https://arxiv.org/abs/1703.01365 + $ref: '#/components/schemas/XPSIntegratedGradientsAttribution' + xraiAttribution: + description: >- + An attribution method that redistributes Integrated Gradients + attribution to segmented regions, taking advantage of the model's + fully differentiable structure. Refer to this paper for more + details: https://arxiv.org/abs/1906.02825 XRAI currently performs + better on natural images, like a picture of a house or an animal. If + the images are taken in artificial environments, like a lab or + manufacturing line, or from diagnostic equipment, like x-rays or + quality-control cameras, use Integrated Gradients instead. + $ref: '#/components/schemas/XPSXraiAttribution' + XPSIntegratedGradientsAttribution: + id: XPSIntegratedGradientsAttribution + deprecated: true + description: >- + An attribution method that computes the Aumann-Shapley value taking + advantage of the model's fully differentiable structure. Refer to this + paper for more details: https://arxiv.org/abs/1703.01365 + type: object properties: - commonStats: - $ref: '#/components/schemas/XPSCommonStats' - medianTimestampNanos: - type: string - format: int64 - granularStats: + stepCount: + description: >- + The number of steps for approximating the path integral. A good + value to start is 50 and gradually increase until the sum to diff + property is within the desired error range. Valid range of its value + is [1, 100], inclusively. + type: integer + format: int32 + XPSXraiAttribution: + id: XPSXraiAttribution + deprecated: true + description: >- + An explanation method that redistributes Integrated Gradients + attributions to segmented regions, taking advantage of the model's fully + differentiable structure. Refer to this paper for more details: + https://arxiv.org/abs/1906.02825 Only supports image Models (modality is + IMAGE). + type: object + properties: + stepCount: + description: >- + The number of steps for approximating the path integral. A good + value to start is 50 and gradually increase until the sum to diff + property is met within the desired error range. Valid range of its + value is [1, 100], inclusively. + type: integer + format: int32 + XPSResponseExplanationMetadata: + id: XPSResponseExplanationMetadata + deprecated: true + type: object + properties: + inputs: + description: Metadata of the input. type: object additionalProperties: - $ref: '#/components/schemas/XPSTimestampStatsGranularStats' - description: >- - The string key is the pre-defined granularity. Currently supported: - hour_of_day, day_of_week, month_of_year. Granularities finer that - the granularity of timestamp data are not populated (e.g. if - timestamps are at day granularity, then hour_of_day is not - populated). - id: XPSTimestampStats - description: The data statistics of a series of TIMESTAMP values. + $ref: '#/components/schemas/XPSResponseExplanationMetadataInputMetadata' + outputs: + description: Metadata of the output. + type: object + additionalProperties: + $ref: '#/components/schemas/XPSResponseExplanationMetadataOutputMetadata' + XPSResponseExplanationMetadataInputMetadata: + id: XPSResponseExplanationMetadataInputMetadata + description: Metadata of the input of a feature. type: object - XPSImageModelServingSpec: - id: XPSImageModelServingSpec - description: Serving specification for image models. + properties: + visualizationConfig: + description: Visualization configurations for image explanation. + $ref: '#/components/schemas/XPSVisualization' + inputTensorName: + description: >- + Name of the input tensor for this model. Only needed in train + response. + type: string + modality: + description: >- + Modality of the feature. Valid values are: numeric, image. Defaults + to numeric. + type: string + enumDescriptions: + - '' + - '' + - '' + - '' + enum: + - MODALITY_UNSPECIFIED + - NUMERIC + - IMAGE + - CATEGORICAL + XPSVisualization: + id: XPSVisualization + deprecated: true + description: Visualization configurations for image explanation. type: object properties: - tfRuntimeVersion: + type: description: >- - ## The fields below are only populated under uCAIP request scope. - https://cloud.google.com/ml-engine/docs/runtime-version-list + Type of the image visualization. Only applicable to Integrated + Gradients attribution. OUTLINES shows regions of attribution, while + PIXELS shows per-pixel attribution. Defaults to OUTLINES. type: string - modelThroughputEstimation: - type: array - description: Populate under uCAIP request scope. - items: - $ref: >- - #/components/schemas/XPSImageModelServingSpecModelThroughputEstimation - nodeQps: - description: >- - An estimated value of how much traffic a node can serve. Populated - for AutoMl request only. - type: number - format: double - XPSReportingMetrics: - properties: - metricEntries: - items: - $ref: '#/components/schemas/XPSMetricEntry' + enumDescriptions: + - Should not be used. + - Shows which pixel contributed to the image prediction. + - >- + Shows which region contributed to the image prediction by + outlining the region. + enum: + - TYPE_UNSPECIFIED + - PIXELS + - OUTLINES + polarity: description: >- - One entry per metric name. The values must be aggregated per metric - name. - type: array - effectiveTrainingDuration: + Whether to only highlight pixels with positive contributions, + negative or both. Defaults to POSITIVE. + type: string + enumDescriptions: + - Default value. This is the same as POSITIVE. + - >- + Highlights the pixels/outlines that were most influential to the + model's prediction. + - >- + Setting polarity to negative highlights areas that does not lead + to the models's current prediction. + - Shows both positive and negative attributions. + enum: + - POLARITY_UNSPECIFIED + - POSITIVE + - NEGATIVE + - BOTH + colorMap: description: >- - The effective time training used. If set, this is used for quota - management and billing. Deprecated. AutoML BE doesn't use this. - Don't set. + The color scheme used for the highlighted areas. Defaults to + PINK_GREEN for Integrated Gradients attribution, which shows + positive attributions in green and negative in pink. Defaults to + VIRIDIS for XRAI attribution, which highlights the most influential + regions in yellow and the least influential in blue. type: string - deprecated: true - format: google-duration - id: XPSReportingMetrics - type: object - XPSImageObjectDetectionEvaluationMetrics: - id: XPSImageObjectDetectionEvaluationMetrics - properties: - boundingBoxMeanAveragePrecision: - format: float - type: number + enumDescriptions: + - Should not be used. + - 'Positive: green. Negative: pink.' + - >- + Viridis color map: A perceptually uniform color mapping which is + easier to see by those with colorblindness and progresses from + yellow to green to blue. Positive: yellow. Negative: blue. + - 'Positive: red. Negative: red.' + - 'Positive: green. Negative: green.' + - 'Positive: green. Negative: red.' + - PiYG palette. + enum: + - COLOR_MAP_UNSPECIFIED + - PINK_GREEN + - VIRIDIS + - RED + - GREEN + - RED_GREEN + - PINK_WHITE_GREEN + clipPercentUpperbound: description: >- - The single metric for bounding boxes evaluation: the - mean_average_precision averaged over all - bounding_box_metrics_entries. - evaluatedBoundingBoxCount: + Excludes attributions above the specified percentile from the + highlighted areas. Using the clip_percent_upperbound and + clip_percent_lowerbound together can be useful for filtering out + noise and making it easier to see areas of strong attribution. + Defaults to 99.9. + type: number + format: float + clipPercentLowerbound: description: >- - The total number of bounding boxes (i.e. summed over all images) the - ground truth used to create this evaluation had. - type: integer - format: int32 - boundingBoxMetricsEntries: - items: - $ref: '#/components/schemas/XPSBoundingBoxMetricsEntry' + Excludes attributions below the specified percentile, from the + highlighted areas. Defaults to 62. + type: number + format: float + overlayType: description: >- - The bounding boxes match metrics for each Intersection-over-union - threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 and each label - confidence threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 pair. - type: array - description: >- - Model evaluation metrics for image object detection problems. Evaluates - prediction quality of labeled bounding boxes. - type: object - XPSColumnSpecForecastingMetadata: - type: object - properties: - columnType: - enum: - - COLUMN_TYPE_UNSPECIFIED - - KEY - - KEY_METADATA - - TIME_SERIES_AVAILABLE_PAST_ONLY - - TIME_SERIES_AVAILABLE_PAST_AND_FUTURE + How the original image is displayed in the visualization. Adjusting + the overlay can help increase visual clarity if the original image + makes it difficult to view the visualization. Defaults to NONE. + type: string enumDescriptions: - - An un-set value of this enum. - - Key columns are used to identify timeseries. - - >- - This column contains information describing static properties of - the entities identified by the key column(s) (e.g. city's ZIP - code). + - Default value. This is the same as NONE. + - No overlay. + - The attributions are shown on top of the original image. - >- - This column contains information for the given entity, at any time - poinrt, they are only available in the time series before. + The attributions are shown on top of grayscaled version of the + original image. - >- - This column contains information for the given entity is known - both for the past and the sufficiently far future. - description: The type of the column for FORECASTING model training purposes. - type: string - id: XPSColumnSpecForecastingMetadata - XPSFileSpec: + The attributions are used as a mask to reveal predictive parts of + the image and hide the un-predictive parts. + enum: + - OVERLAY_TYPE_UNSPECIFIED + - NONE + - ORIGINAL + - GRAYSCALE + - MASK_BLACK + XPSResponseExplanationMetadataOutputMetadata: + id: XPSResponseExplanationMetadataOutputMetadata + description: Metadata of the prediction output to be explained. + type: object properties: - singleFilePath: - description: Deprecated. Use file_spec. - deprecated: true + outputTensorName: + description: Name of the output tensor. Only needed in train response. type: string - directoryPath: - description: Deprecated. Use file_spec. - deprecated: true + XPSVisionErrorAnalysisConfig: + id: XPSVisionErrorAnalysisConfig + description: 'The vision model error analysis configuration. Next tag: 3' + type: object + properties: + exampleCount: + description: The number of query examples in error analysis. + type: integer + format: int32 + queryType: + description: >- + The query type used in retrieval. The enum values are frozen in the + foreseeable future. type: string - fileFormat: - enumDeprecated: - - false - - true - - false - - false - - false - - false enumDescriptions: - - '' - - '' - - Internal format for parallel text data used by Google Translate. - - '' - - >- - Only the lexicographically first file described by the file_spec - contains the header line. - - '' + - Unspecified query type for model error analysis. + - Query similar samples across all classes in the dataset. + - Query similar samples from the same class of the input sample. + - Query dissimilar samples from the same class of the input sample. enum: - - FILE_FORMAT_UNKNOWN - - FILE_FORMAT_SSTABLE - - FILE_FORMAT_TRANSLATION_RKV - - FILE_FORMAT_RECORDIO - - FILE_FORMAT_RAW_CSV - - FILE_FORMAT_RAW_CAPACITOR - type: string - fileSpec: - type: string - description: >- - Single file path, or file pattern of format - "/path/to/file@shard_count". E.g. /cns/cell-d/somewhere/file@2 is - expanded to two files: /cns/cell-d/somewhere/file-00000-of-00002 and - /cns/cell-d/somewhere/file-00001-of-00002. + - QUERY_TYPE_UNSPECIFIED + - QUERY_TYPE_ALL_SIMILAR + - QUERY_TYPE_SAME_CLASS_SIMILAR + - QUERY_TYPE_SAME_CLASS_DISSIMILAR + XPSXpsOperationMetadata: + id: XPSXpsOperationMetadata type: object - id: XPSFileSpec - description: >- - Spec of input and output files, on external file systems (for example, - Colossus Namespace System or Google Cloud Storage). - ClassifyTextResponse: - description: The document classification response message. + properties: + reportingMetrics: + description: >- + Metrics for the operation. By the time the operation is terminated + (whether succeeded or failed) as returned from XPS, AutoML BE + assumes the metrics are finalized. AutoML BE transparently posts the + metrics to Chemist if it's not empty, regardless of the response + content or error type. If user is supposed to be charged in case of + cancellation/error, this field should be set. In the case where the + type of LRO doesn't require any billing, this field should be left + unset. + $ref: '#/components/schemas/XPSReportingMetrics' + exampleCount: + description: >- + Optional. XPS server can opt to provide example count of the long + running operation (e.g. training, data importing, batch prediction). + type: string + format: int64 + tablesTrainingOperationMetadata: + $ref: '#/components/schemas/XPSTablesTrainingOperationMetadata' + videoTrainingOperationMetadata: + $ref: '#/components/schemas/XPSVideoTrainingOperationMetadata' + videoBatchPredictOperationMetadata: + $ref: '#/components/schemas/XPSVideoBatchPredictOperationMetadata' + visionTrainingOperationMetadata: + $ref: '#/components/schemas/XPSVisionTrainingOperationMetadata' + XPSReportingMetrics: + id: XPSReportingMetrics type: object properties: - languageCode: - type: string + metricEntries: description: >- - The language of the text, which will be the same as the language - specified in the request or, if not specified, the - automatically-detected language. See Document.language field for - more details. - categories: - items: - $ref: '#/components/schemas/ClassificationCategory' + One entry per metric name. The values must be aggregated per metric + name. type: array - description: Categories representing the input document. - languageSupported: - type: boolean + items: + $ref: '#/components/schemas/XPSMetricEntry' + effectiveTrainingDuration: description: >- - Whether the language is officially supported. The API may still - return a response when the language is not supported, but it is on a - best effort basis. - id: ClassifyTextResponse - XPSCoreMlFormat: - id: XPSCoreMlFormat + The effective time training used. If set, this is used for quota + management and billing. Deprecated. AutoML BE doesn't use this. + Don't set. + deprecated: true + type: string + format: google-duration + XPSMetricEntry: + id: XPSMetricEntry type: object - description: A model format used for iOS mobile devices. - properties: {} - XPSTablesModelStructureModelParametersParameter: properties: - floatValue: - type: number - description: Float type parameter value. - format: double - name: - description: Parameter name. + metricName: + description: The metric name defined in the service configuration. type: string - intValue: - description: Integer type parameter value. + argentumMetricId: + description: >- + For billing metrics that are using legacy sku's, set the legacy + billing metric id here. This will be sent to Chemist as the + "cloudbilling.googleapis.com/argentum_metric_id" label. Otherwise + leave empty. + type: string + int64Value: + description: A signed 64-bit integer value. type: string format: int64 - stringValue: + doubleValue: + description: A double value. + type: number + format: double + systemLabels: + description: Billing system labels for this (metric, value) pair. + type: array + items: + $ref: '#/components/schemas/XPSMetricEntryLabel' + XPSMetricEntryLabel: + id: XPSMetricEntryLabel + type: object + properties: + labelName: + description: The name of the label. type: string - description: String type parameter value. - id: XPSTablesModelStructureModelParametersParameter + labelValue: + description: The value of the label. + type: string + XPSTablesTrainingOperationMetadata: + id: XPSTablesTrainingOperationMetadata type: object - XPSSpeechEvaluationMetrics: properties: - subModelEvaluationMetrics: + topTrials: + description: >- + This field is for training. When the operation is terminated + successfully, AutoML Backend post this field to operation metadata + in spanner. If the metadata has no trials returned, the training + operation is supposed to be a failure. + type: array items: - $ref: >- - #/components/schemas/XPSSpeechEvaluationMetricsSubModelEvaluationMetric + $ref: '#/components/schemas/XPSTuningTrial' + trainingObjectivePoints: + description: >- + This field records the training objective value with respect to + time, giving insight into how the model architecture search is + performing as training time elapses. type: array - description: Evaluation metrics for all submodels contained in this model. + items: + $ref: '#/components/schemas/XPSTrainingObjectivePoint' + createModelStage: + description: Current stage of creating model. + type: string + enumDescriptions: + - Unspecified stage. + - Prepare the model training pipeline and run data processing. + - Training model. + - Run evaluation. + - Finalizing model training pipeline. + enum: + - CREATE_MODEL_STAGE_UNSPECIFIED + - DATA_PREPROCESSING + - TRAINING + - EVALUATING + - MODEL_POST_PROCESSING + optimizationObjective: + description: The optimization objective for model. + type: string + trainBudgetMilliNodeHours: + description: Creating model budget. + type: string + format: int64 + trainingStartTime: + description: Timestamp when training process starts. + type: string + format: google-datetime + XPSTuningTrial: + id: XPSTuningTrial + description: >- + Metrics for a tuning job generated, will get forwarded to Stackdriver as + model tuning logs. Setting this as a standalone message out of + CreateModelMetadata to avoid confusion as we expose this message only to + users. type: object - id: XPSSpeechEvaluationMetrics + properties: + modelStructure: + description: Model parameters for the trial. + $ref: '#/components/schemas/XPSTablesModelStructure' + trainingObjectivePoint: + description: The optimization objective evaluation of the eval split data. + $ref: '#/components/schemas/XPSTrainingObjectivePoint' XPSTrainingObjectivePoint: + id: XPSTrainingObjectivePoint + type: object properties: + value: + description: The objective value when this point was recorded. + type: number + format: float createTime: description: The time at which this point was recorded. type: string format: google-datetime - value: - description: The objective value when this point was recorded. - format: float - type: number - id: XPSTrainingObjectivePoint + XPSVideoTrainingOperationMetadata: + id: XPSVideoTrainingOperationMetadata type: object - Entity: - description: >- - Represents a phrase in the text that is a known entity, such as a - person, an organization, or location. The API associates information, - such as probability and mentions, with entities. properties: - type: - type: string - enumDescriptions: - - Unknown - - Person - - Location - - Organization - - Event - - Artwork - - Consumer product - - Other types of entities - - >- - Phone number The metadata lists the phone number, formatted - according to local convention, plus whichever additional elements - appear in the text: * `number` - the actual number, broken down - into sections as per local convention * `national_prefix` - - country code, if detected * `area_code` - region or area code, if - detected * `extension` - phone extension (to be dialed after - connection), if detected - - >- - Address The metadata identifies the street number and locality - plus whichever additional elements appear in the text: * - `street_number` - street number * `locality` - city or town * - `street_name` - street/route name, if detected * `postal_code` - - postal code, if detected * `country` - country, if detected * - `broad_region` - administrative area, such as the state, if - detected * `narrow_region` - smaller administrative area, such as - county, if detected * `sublocality` - used in Asian addresses to - demark a district within a city, if detected - - >- - Date The metadata identifies the components of the date: * `year` - - four digit year, if detected * `month` - two digit month number, - if detected * `day` - two digit day number, if detected - - Number The metadata is the number itself. - - Price The metadata identifies the `value` and `currency`. - description: The entity type. - enum: - - UNKNOWN - - PERSON - - LOCATION - - ORGANIZATION - - EVENT - - WORK_OF_ART - - CONSUMER_GOOD - - OTHER - - PHONE_NUMBER - - ADDRESS - - DATE - - NUMBER - - PRICE - name: + trainCostMilliNodeHour: + description: >- + This is an estimation of the node hours necessary for training a + model, expressed in milli node hours (i.e. 1,000 value in this field + means 1 node hour). A node hour represents the time a virtual + machine spends running your training job. The cost of one node + running for one hour is a node hour. type: string - description: The representative name for the entity. - metadata: - type: object + format: int64 + XPSVideoBatchPredictOperationMetadata: + id: XPSVideoBatchPredictOperationMetadata + type: object + properties: + outputExamples: description: >- - Metadata associated with the entity. For the metadata associated - with other entity types, see the Type table below. - additionalProperties: + All the partial batch prediction results that are completed at the + moment. Output examples are sorted by completion time. The order + will not be changed. Each output example should be the path of a + single RecordIO file of AnnotatedExamples. + type: array + items: type: string - sentiment: - $ref: '#/components/schemas/Sentiment' + XPSVisionTrainingOperationMetadata: + id: XPSVisionTrainingOperationMetadata + deprecated: true + type: object + properties: + explanationUsage: description: >- - For calls to AnalyzeEntitySentimentRequest or if - AnnotateTextRequest.Features.extract_entity_sentiment is set to - true, this field will contain the aggregate sentiment expressed for - this entity in the provided document. - mentions: + Aggregated infra usage within certain time period, for billing + report purpose if XAI is enable in training request. + $ref: '#/components/schemas/InfraUsage' + InfraUsage: + id: InfraUsage + description: 'LINT: LEGACY_NAMES Infra Usage of billing metrics.' + type: object + properties: + cpuMetrics: + description: Aggregated core metrics since requested start_time. + type: array items: - $ref: '#/components/schemas/EntityMention' - description: >- - The mentions of this entity in the input document. The API currently - supports proper noun mentions. + $ref: '#/components/schemas/CpuMetric' + ramMetrics: + description: Aggregated ram metrics since requested start_time. + type: array + items: + $ref: '#/components/schemas/RamMetric' + gpuMetrics: + description: Aggregated gpu metrics since requested start_time. + type: array + items: + $ref: '#/components/schemas/GpuMetric' + tpuMetrics: + description: Aggregated tpu metrics since requested start_time. type: array + items: + $ref: '#/components/schemas/TpuMetric' + diskMetrics: + description: Aggregated persistent disk metrics since requested start_time. + type: array + items: + $ref: '#/components/schemas/DiskMetric' + CpuMetric: + id: CpuMetric + description: Metric for billing reports. type: object - id: Entity - XPSImageObjectDetectionModelSpec: properties: - stopReason: + cpuType: + description: Required. Type of cpu, e.g. N2. + type: string enumDescriptions: + - '' + - GPU-based machine, skip quota reporting. + - GPU-based machine, skip quota reporting. + - GPU-based machine, skip quota reporting. + - GPU-based machine, skip quota reporting. + - COMPUTE_OPTIMIZED + - '' + - '' + - '' + - GPU-based machine, skip quota reporting. + - GPU-based machine, skip quota reporting. + - '' + - MEMORY_OPTIMIZED_UPGRADE_PREMIUM + - MEMORY_OPTIMIZED + - '' + - '' - '' - '' - - Model fully converged, can not be resumbed training. - - >- - Model early converged, can be further trained till full - convergency. - description: >- - Stop reason for training job, e.g. 'TRAIN_BUDGET_REACHED', - 'MODEL_CONVERGED'. enum: - - TRAIN_STOP_REASON_UNSPECIFIED - - TRAIN_STOP_REASON_BUDGET_REACHED - - TRAIN_STOP_REASON_MODEL_CONVERGED - - TRAIN_STOP_REASON_MODEL_EARLY_STOPPED - type: string - modelArtifactSpec: - description: '## The fields below are only populated under uCAIP request scope.' - $ref: '#/components/schemas/XPSImageModelArtifactSpec' - classCount: + - UNKNOWN_CPU_TYPE + - A2 + - A3 + - A4 + - A4X + - C2 + - C2D + - CUSTOM + - E2 + - G2 + - G4 + - C3 + - M2 + - M1 + - N1 + - N2_CUSTOM + - N2 + - N2D + coreSec: + description: Required. Total seconds of core usage, e.g. 4. type: string format: int64 - description: Total number of classes. - exportModelSpec: - $ref: '#/components/schemas/XPSImageExportModelSpec' - trainCostNodeSeconds: + coreNumber: + description: Required. Number of CPU cores. type: string - description: >- - The actual train cost of creating this model, expressed in node - seconds, i.e. 3,600 value in this field means 1 node hour. format: int64 - modelServingSpec: - $ref: '#/components/schemas/XPSImageModelServingSpec' - maxBoundingBoxCount: + machineSpec: + description: Required. Machine spec, e.g. N1_STANDARD_4. type: string - format: int64 - description: Max number of bounding box. - id: XPSImageObjectDetectionModelSpec - type: object - XPSRegressionMetricsEntry: - type: object - properties: - predictedValue: - format: float - description: The observed value for a row in the dataset. - type: number - trueValue: - format: float - type: number - description: The actual target value for a row in the dataset. - description: A pair of actual & observed values for the model being evaluated. - id: XPSRegressionMetricsEntry - XPSImageExportModelSpec: - id: XPSImageExportModelSpec - type: object - properties: - exportModelOutputConfig: - description: >- - Contains the model format and internal location of the model files - to be exported/downloaded. Use the Google Cloud Storage bucket name - which is provided via TrainRequest.gcs_bucket_name to store the - model files. - type: array - items: - $ref: '#/components/schemas/XPSExportModelOutputConfig' - description: >- - Information of downloadable models that are pre-generated as part of - training flow and will be persisted in AutoMl backend. Upon receiving - ExportModel request from user, AutoMl backend can serve the - pre-generated models to user if exists (by copying the files from - internal path to user provided location), otherwise, AutoMl backend will - call xPS ExportModel API to generate the model on the fly with the - requesting format. - XPSVisionErrorAnalysisConfig: - type: object - properties: - exampleCount: - type: integer - format: int32 - description: The number of query examples in error analysis. - queryType: enumDescriptions: - - Unspecified query type for model error analysis. - - Query similar samples across all classes in the dataset. - - Query similar samples from the same class of the input sample. - - Query dissimilar samples from the same class of the input sample. - description: >- - The query type used in retrieval. The enum values are frozen in the - foreseeable future. + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' enum: - - QUERY_TYPE_UNSPECIFIED - - QUERY_TYPE_ALL_SIMILAR - - QUERY_TYPE_SAME_CLASS_SIMILAR - - QUERY_TYPE_SAME_CLASS_DISSIMILAR - type: string - id: XPSVisionErrorAnalysisConfig - description: 'The vision model error analysis configuration. Next tag: 3' - ClassifyTextRequest: - type: object - description: The document classification request message. - properties: - document: - description: Required. Input document. - $ref: '#/components/schemas/Document' - id: ClassifyTextRequest - XPSStructStats: - type: object - properties: - fieldStats: - additionalProperties: - $ref: '#/components/schemas/XPSDataStats' + - UNKNOWN_MACHINE_SPEC + - N1_STANDARD_2 + - N1_STANDARD_4 + - N1_STANDARD_8 + - N1_STANDARD_16 + - N1_STANDARD_32 + - N1_STANDARD_64 + - N1_STANDARD_96 + - N1_HIGHMEM_2 + - N1_HIGHMEM_4 + - N1_HIGHMEM_8 + - N1_HIGHMEM_16 + - N1_HIGHMEM_32 + - N1_HIGHMEM_64 + - N1_HIGHMEM_96 + - N1_HIGHCPU_2 + - N1_HIGHCPU_4 + - N1_HIGHCPU_8 + - N1_HIGHCPU_16 + - N1_HIGHCPU_32 + - N1_HIGHCPU_64 + - N1_HIGHCPU_96 + - A2_HIGHGPU_1G + - A2_HIGHGPU_2G + - A2_HIGHGPU_4G + - A2_HIGHGPU_8G + - A2_MEGAGPU_16G + - A2_ULTRAGPU_1G + - A2_ULTRAGPU_2G + - A2_ULTRAGPU_4G + - A2_ULTRAGPU_8G + - A3_HIGHGPU_1G + - A3_HIGHGPU_2G + - A3_HIGHGPU_4G + - A3_HIGHGPU_8G + - A3_MEGAGPU_8G + - A3_ULTRAGPU_8G + - A3_EDGEGPU_8G + - A4_HIGHGPU_8G + - A4X_HIGHGPU_4G + - E2_STANDARD_2 + - E2_STANDARD_4 + - E2_STANDARD_8 + - E2_STANDARD_16 + - E2_STANDARD_32 + - E2_HIGHMEM_2 + - E2_HIGHMEM_4 + - E2_HIGHMEM_8 + - E2_HIGHMEM_16 + - E2_HIGHCPU_2 + - E2_HIGHCPU_4 + - E2_HIGHCPU_8 + - E2_HIGHCPU_16 + - E2_HIGHCPU_32 + - N2_STANDARD_2 + - N2_STANDARD_4 + - N2_STANDARD_8 + - N2_STANDARD_16 + - N2_STANDARD_32 + - N2_STANDARD_48 + - N2_STANDARD_64 + - N2_STANDARD_80 + - N2_STANDARD_96 + - N2_STANDARD_128 + - N2_HIGHMEM_2 + - N2_HIGHMEM_4 + - N2_HIGHMEM_8 + - N2_HIGHMEM_16 + - N2_HIGHMEM_32 + - N2_HIGHMEM_48 + - N2_HIGHMEM_64 + - N2_HIGHMEM_80 + - N2_HIGHMEM_96 + - N2_HIGHMEM_128 + - N2_HIGHCPU_2 + - N2_HIGHCPU_4 + - N2_HIGHCPU_8 + - N2_HIGHCPU_16 + - N2_HIGHCPU_32 + - N2_HIGHCPU_48 + - N2_HIGHCPU_64 + - N2_HIGHCPU_80 + - N2_HIGHCPU_96 + - N2D_STANDARD_2 + - N2D_STANDARD_4 + - N2D_STANDARD_8 + - N2D_STANDARD_16 + - N2D_STANDARD_32 + - N2D_STANDARD_48 + - N2D_STANDARD_64 + - N2D_STANDARD_80 + - N2D_STANDARD_96 + - N2D_STANDARD_128 + - N2D_STANDARD_224 + - N2D_HIGHMEM_2 + - N2D_HIGHMEM_4 + - N2D_HIGHMEM_8 + - N2D_HIGHMEM_16 + - N2D_HIGHMEM_32 + - N2D_HIGHMEM_48 + - N2D_HIGHMEM_64 + - N2D_HIGHMEM_80 + - N2D_HIGHMEM_96 + - N2D_HIGHCPU_2 + - N2D_HIGHCPU_4 + - N2D_HIGHCPU_8 + - N2D_HIGHCPU_16 + - N2D_HIGHCPU_32 + - N2D_HIGHCPU_48 + - N2D_HIGHCPU_64 + - N2D_HIGHCPU_80 + - N2D_HIGHCPU_96 + - N2D_HIGHCPU_128 + - N2D_HIGHCPU_224 + - C2_STANDARD_4 + - C2_STANDARD_8 + - C2_STANDARD_16 + - C2_STANDARD_30 + - C2_STANDARD_60 + - C2D_STANDARD_2 + - C2D_STANDARD_4 + - C2D_STANDARD_8 + - C2D_STANDARD_16 + - C2D_STANDARD_32 + - C2D_STANDARD_56 + - C2D_STANDARD_112 + - C2D_HIGHCPU_2 + - C2D_HIGHCPU_4 + - C2D_HIGHCPU_8 + - C2D_HIGHCPU_16 + - C2D_HIGHCPU_32 + - C2D_HIGHCPU_56 + - C2D_HIGHCPU_112 + - C2D_HIGHMEM_2 + - C2D_HIGHMEM_4 + - C2D_HIGHMEM_8 + - C2D_HIGHMEM_16 + - C2D_HIGHMEM_32 + - C2D_HIGHMEM_56 + - C2D_HIGHMEM_112 + - G2_STANDARD_4 + - G2_STANDARD_8 + - G2_STANDARD_12 + - G2_STANDARD_16 + - G2_STANDARD_24 + - G2_STANDARD_32 + - G2_STANDARD_48 + - G2_STANDARD_96 + - G4_STANDARD_48 + - C3_STANDARD_4 + - C3_STANDARD_8 + - C3_STANDARD_22 + - C3_STANDARD_44 + - C3_STANDARD_88 + - C3_STANDARD_176 + - C3_HIGHCPU_4 + - C3_HIGHCPU_8 + - C3_HIGHCPU_22 + - C3_HIGHCPU_44 + - C3_HIGHCPU_88 + - C3_HIGHCPU_176 + - C3_HIGHMEM_4 + - C3_HIGHMEM_8 + - C3_HIGHMEM_22 + - C3_HIGHMEM_44 + - C3_HIGHMEM_88 + - C3_HIGHMEM_176 + trackingLabels: + description: >- + Billing tracking labels. They do not contain any user data but only + the labels set by Vertex Core Infra itself. Tracking labels' keys + are defined with special format: goog-[\p{Ll}\p{N}]+ E.g. "key": + "goog-k8s-cluster-name","value": "us-east1-b4rk" type: object - description: >- - Map from a field name of the struct to data stats aggregated over - series of all data in that field across all the structs. - commonStats: - $ref: '#/components/schemas/XPSCommonStats' - description: The data statistics of a series of STRUCT values. - id: XPSStructStats - XPSTablesConfidenceMetricsEntry: + additionalProperties: + type: string + RamMetric: + id: RamMetric type: object properties: - recall: - type: number - format: double - description: 'Recall = #true positives / (#true positives + #false negatives).' - truePositiveRate: - description: 'TPR = #true positives / (#true positives + #false negatvies)' - type: number - format: double - falseNegativeCount: - description: False negative count. - type: string - format: int64 - truePositiveCount: - format: int64 - description: True positive count. - type: string - confidenceThreshold: - type: number - format: double - description: The confidence threshold value used to compute the metrics. - falsePositiveCount: - format: int64 - description: False positive count. + ramType: + description: Required. Type of ram. type: string - falsePositiveRate: - description: 'FPR = #false positives / (#false positives + #true negatives)' - type: number - format: double - f1Score: - type: number - format: double + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - COMPUTE_OPTIMIZED + - '' + - '' + - '' + - '' + - '' + - '' + - MEMORY_OPTIMIZED_UPGRADE_PREMIUM + - MEMORY_OPTIMIZED + - '' + - '' + - '' + - '' + enum: + - UNKNOWN_RAM_TYPE + - A2 + - A3 + - A4 + - A4X + - C2 + - C2D + - CUSTOM + - E2 + - G2 + - G4 + - C3 + - M2 + - M1 + - N1 + - N2_CUSTOM + - N2 + - N2D + gibSec: description: >- - The harmonic mean of recall and precision. (2 * precision * recall) - / (precision + recall) - trueNegativeCount: + Required. VM memory in Gigabyte second, e.g. 3600. Using int64 type + to match billing metrics definition. type: string format: int64 - description: True negative count. - precision: + memories: + description: Required. VM memory in gb. type: number format: double - description: 'Precision = #true positives / (#true positives + #false positives).' - id: XPSTablesConfidenceMetricsEntry - description: Metrics for a single confidence threshold. - XPSTextExtractionEvaluationMetrics: - type: object - id: XPSTextExtractionEvaluationMetrics - properties: - confidenceMetricsEntries: - type: array - description: >- - If the enclosing EvaluationMetrics.label is empty, - confidence_metrics_entries is an evaluation of the entire model - across all labels. If the enclosing EvaluationMetrics.label is set, - confidence_metrics_entries applies to that label. - items: - $ref: '#/components/schemas/XPSConfidenceMetricsEntry' - confusionMatrix: - $ref: '#/components/schemas/XPSConfusionMatrix' - description: >- - Confusion matrix of the model, at the default confidence threshold - (0.0). Only set for whole-model evaluation, not for evaluation per - label. - perLabelConfidenceMetrics: - deprecated: true - description: Only recall, precision, and f1_score will be set. - type: object - additionalProperties: - $ref: '#/components/schemas/XPSConfidenceMetricsEntry' - bestF1ConfidenceMetrics: - deprecated: true - description: >- - Values are at the highest F1 score on the precision-recall curve. - Only confidence_threshold, recall, precision, and f1_score will be - set. - $ref: '#/components/schemas/XPSConfidenceMetricsEntry' - XPSImageClassificationTrainResponse: - type: object - id: XPSImageClassificationTrainResponse - properties: - modelServingSpec: - $ref: '#/components/schemas/XPSImageModelServingSpec' - modelArtifactSpec: - description: '## The fields below are only populated under uCAIP request scope.' - $ref: '#/components/schemas/XPSImageModelArtifactSpec' - trainCostNodeSeconds: - format: int64 - type: string - description: >- - The actual training cost, expressed in node seconds. Populated for - models trained in node time. - exportModelSpec: - $ref: '#/components/schemas/XPSImageExportModelSpec' - description: >- - Information of downloadable models that are pre-generated as part of - training flow and will be persisted in AutoMl backend. Populated for - AutoMl requests. - classCount: - description: Total number of classes. - format: int64 + machineSpec: + description: Required. Machine spec, e.g. N1_STANDARD_4. type: string - stopReason: - enum: - - TRAIN_STOP_REASON_UNSPECIFIED - - TRAIN_STOP_REASON_BUDGET_REACHED - - TRAIN_STOP_REASON_MODEL_CONVERGED - - TRAIN_STOP_REASON_MODEL_EARLY_STOPPED - description: >- - Stop reason for training job, e.g. 'TRAIN_BUDGET_REACHED', - 'MODEL_CONVERGED', 'MODEL_EARLY_STOPPED'. enumDescriptions: - '' - '' - - Model fully converged, can not be resumbed training. - - >- - Model early converged, can be further trained till full - convergency. - type: string - trainCostInNodeTime: - type: string - description: >- - The actual cost to create this model. - For edge type model, the - cost is expressed in node hour. - For cloud type model,the cost is - expressed in compute hour. - Populated for models created before GA. - To be deprecated after GA. - format: google-duration - XPSFloat64Stats: - id: XPSFloat64Stats - description: The data statistics of a series of FLOAT64 values. - properties: - commonStats: - $ref: '#/components/schemas/XPSCommonStats' - standardDeviation: - format: double - description: The standard deviation of the series. - type: number - histogramBuckets: - items: - $ref: '#/components/schemas/XPSFloat64StatsHistogramBucket' - type: array - description: >- - Histogram buckets of the data series. Sorted by the min value of the - bucket, ascendingly, and the number of the buckets is dynamically - generated. The buckets are non-overlapping and completely cover - whole FLOAT64 range with min of first bucket being `"-Infinity"`, - and max of the last one being `"Infinity"`. - mean: - description: The mean of the series. - format: double - type: number - quantiles: - items: - type: number - format: double - description: >- - Ordered from 0 to k k-quantile values of the data series of n - values. The value at index i is, approximately, the i*n/k-th - smallest value in the series; for i = 0 and i = k these are, - respectively, the min and max values. - type: array - type: object - XPSVideoBatchPredictOperationMetadata: - properties: - outputExamples: - items: - type: string + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + enum: + - UNKNOWN_MACHINE_SPEC + - N1_STANDARD_2 + - N1_STANDARD_4 + - N1_STANDARD_8 + - N1_STANDARD_16 + - N1_STANDARD_32 + - N1_STANDARD_64 + - N1_STANDARD_96 + - N1_HIGHMEM_2 + - N1_HIGHMEM_4 + - N1_HIGHMEM_8 + - N1_HIGHMEM_16 + - N1_HIGHMEM_32 + - N1_HIGHMEM_64 + - N1_HIGHMEM_96 + - N1_HIGHCPU_2 + - N1_HIGHCPU_4 + - N1_HIGHCPU_8 + - N1_HIGHCPU_16 + - N1_HIGHCPU_32 + - N1_HIGHCPU_64 + - N1_HIGHCPU_96 + - A2_HIGHGPU_1G + - A2_HIGHGPU_2G + - A2_HIGHGPU_4G + - A2_HIGHGPU_8G + - A2_MEGAGPU_16G + - A2_ULTRAGPU_1G + - A2_ULTRAGPU_2G + - A2_ULTRAGPU_4G + - A2_ULTRAGPU_8G + - A3_HIGHGPU_1G + - A3_HIGHGPU_2G + - A3_HIGHGPU_4G + - A3_HIGHGPU_8G + - A3_MEGAGPU_8G + - A3_ULTRAGPU_8G + - A3_EDGEGPU_8G + - A4_HIGHGPU_8G + - A4X_HIGHGPU_4G + - E2_STANDARD_2 + - E2_STANDARD_4 + - E2_STANDARD_8 + - E2_STANDARD_16 + - E2_STANDARD_32 + - E2_HIGHMEM_2 + - E2_HIGHMEM_4 + - E2_HIGHMEM_8 + - E2_HIGHMEM_16 + - E2_HIGHCPU_2 + - E2_HIGHCPU_4 + - E2_HIGHCPU_8 + - E2_HIGHCPU_16 + - E2_HIGHCPU_32 + - N2_STANDARD_2 + - N2_STANDARD_4 + - N2_STANDARD_8 + - N2_STANDARD_16 + - N2_STANDARD_32 + - N2_STANDARD_48 + - N2_STANDARD_64 + - N2_STANDARD_80 + - N2_STANDARD_96 + - N2_STANDARD_128 + - N2_HIGHMEM_2 + - N2_HIGHMEM_4 + - N2_HIGHMEM_8 + - N2_HIGHMEM_16 + - N2_HIGHMEM_32 + - N2_HIGHMEM_48 + - N2_HIGHMEM_64 + - N2_HIGHMEM_80 + - N2_HIGHMEM_96 + - N2_HIGHMEM_128 + - N2_HIGHCPU_2 + - N2_HIGHCPU_4 + - N2_HIGHCPU_8 + - N2_HIGHCPU_16 + - N2_HIGHCPU_32 + - N2_HIGHCPU_48 + - N2_HIGHCPU_64 + - N2_HIGHCPU_80 + - N2_HIGHCPU_96 + - N2D_STANDARD_2 + - N2D_STANDARD_4 + - N2D_STANDARD_8 + - N2D_STANDARD_16 + - N2D_STANDARD_32 + - N2D_STANDARD_48 + - N2D_STANDARD_64 + - N2D_STANDARD_80 + - N2D_STANDARD_96 + - N2D_STANDARD_128 + - N2D_STANDARD_224 + - N2D_HIGHMEM_2 + - N2D_HIGHMEM_4 + - N2D_HIGHMEM_8 + - N2D_HIGHMEM_16 + - N2D_HIGHMEM_32 + - N2D_HIGHMEM_48 + - N2D_HIGHMEM_64 + - N2D_HIGHMEM_80 + - N2D_HIGHMEM_96 + - N2D_HIGHCPU_2 + - N2D_HIGHCPU_4 + - N2D_HIGHCPU_8 + - N2D_HIGHCPU_16 + - N2D_HIGHCPU_32 + - N2D_HIGHCPU_48 + - N2D_HIGHCPU_64 + - N2D_HIGHCPU_80 + - N2D_HIGHCPU_96 + - N2D_HIGHCPU_128 + - N2D_HIGHCPU_224 + - C2_STANDARD_4 + - C2_STANDARD_8 + - C2_STANDARD_16 + - C2_STANDARD_30 + - C2_STANDARD_60 + - C2D_STANDARD_2 + - C2D_STANDARD_4 + - C2D_STANDARD_8 + - C2D_STANDARD_16 + - C2D_STANDARD_32 + - C2D_STANDARD_56 + - C2D_STANDARD_112 + - C2D_HIGHCPU_2 + - C2D_HIGHCPU_4 + - C2D_HIGHCPU_8 + - C2D_HIGHCPU_16 + - C2D_HIGHCPU_32 + - C2D_HIGHCPU_56 + - C2D_HIGHCPU_112 + - C2D_HIGHMEM_2 + - C2D_HIGHMEM_4 + - C2D_HIGHMEM_8 + - C2D_HIGHMEM_16 + - C2D_HIGHMEM_32 + - C2D_HIGHMEM_56 + - C2D_HIGHMEM_112 + - G2_STANDARD_4 + - G2_STANDARD_8 + - G2_STANDARD_12 + - G2_STANDARD_16 + - G2_STANDARD_24 + - G2_STANDARD_32 + - G2_STANDARD_48 + - G2_STANDARD_96 + - G4_STANDARD_48 + - C3_STANDARD_4 + - C3_STANDARD_8 + - C3_STANDARD_22 + - C3_STANDARD_44 + - C3_STANDARD_88 + - C3_STANDARD_176 + - C3_HIGHCPU_4 + - C3_HIGHCPU_8 + - C3_HIGHCPU_22 + - C3_HIGHCPU_44 + - C3_HIGHCPU_88 + - C3_HIGHCPU_176 + - C3_HIGHMEM_4 + - C3_HIGHMEM_8 + - C3_HIGHMEM_22 + - C3_HIGHMEM_44 + - C3_HIGHMEM_88 + - C3_HIGHMEM_176 + trackingLabels: description: >- - All the partial batch prediction results that are completed at the - moment. Output examples are sorted by completion time. The order - will not be changed. Each output example should be the path of a - single RecordIO file of AnnotatedExamples. - type: array - id: XPSVideoBatchPredictOperationMetadata - type: object - XPSStructType: - type: object - id: XPSStructType - properties: - fields: - additionalProperties: - $ref: '#/components/schemas/XPSDataType' + Billing tracking labels. They do not contain any user data but only + the labels set by Vertex Core Infra itself. Tracking labels' keys + are defined with special format: goog-[\p{Ll}\p{N}]+ E.g. "key": + "goog-k8s-cluster-name","value": "us-east1-b4rk" type: object - description: Unordered map of struct field names to their data types. - description: '`StructType` defines the DataType-s of a STRUCT type.' - XPSImageSegmentationEvaluationMetrics: - type: object - properties: - confidenceMetricsEntries: - description: >- - Metrics that have confidence thresholds. Precision-recall curve can - be derived from it. - type: array - items: - $ref: >- - #/components/schemas/XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry - description: 'Model evaluation metrics for image segmentation problems. Next tag: 4.' - id: XPSImageSegmentationEvaluationMetrics - XPSTableSpec: - id: XPSTableSpec + additionalProperties: + type: string + GpuMetric: + id: GpuMetric type: object properties: - importedDataSizeInBytes: - description: The total size of imported data of the table. - format: int64 + gpuType: + description: Required. Type of GPU, e.g. NVIDIA_TESLA_V100. type: string - columnSpecs: - type: object - description: Mapping from column id to column spec. - additionalProperties: - $ref: '#/components/schemas/XPSColumnSpec' - validRowCount: - format: int64 - description: The number of valid rows. + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + enum: + - UNKNOWN_GPU_TYPE + - NVIDIA_TESLA_A100 + - NVIDIA_A100_80GB + - NVIDIA_B200 + - NVIDIA_GB200 + - NVIDIA_TESLA_K80 + - NVIDIA_L4 + - NVIDIA_TESLA_P100 + - NVIDIA_TESLA_P4 + - NVIDIA_TESLA_T4 + - NVIDIA_TESLA_V100 + - NVIDIA_H100_80GB + - NVIDIA_H100_MEGA_80GB + - NVIDIA_H200_141GB + - NVIDIA_RTX_PRO_6000 + gpuSec: + description: Required. Seconds of GPU usage, e.g. 3600. type: string - rowCount: format: int64 - description: The number of rows in the table. + machineSpec: + description: Required. Machine spec, e.g. N1_STANDARD_4. type: string - timeColumnId: - type: integer - description: The id of the time column. - format: int32 - ModerateTextRequest: - type: object - description: The document moderation request message. - properties: - document: - description: Required. Input document. - $ref: '#/components/schemas/Document' - modelVersion: - description: Optional. The model version to use for ModerateText. + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' enum: - - MODEL_VERSION_UNSPECIFIED - - MODEL_VERSION_1 - - MODEL_VERSION_2 - enumDescriptions: - - The default model version. - - >- - Use the v1 model, this model is used by default when not provided. - The v1 model only returns probability (confidence) score for each - category. - - >- - Use the v2 model. The v2 model only returns probability - (confidence) score for each category, and returns severity score - for a subset of the categories. - type: string - id: ModerateTextRequest - Color: - type: object - properties: - red: - format: float - type: number - description: The amount of red in the color as a value in the interval [0, 1]. - alpha: - description: >- - The fraction of this color that should be applied to the pixel. That - is, the final pixel color is defined by the equation: `pixel color = - alpha * (this color) + (1.0 - alpha) * (background color)` This - means that a value of 1.0 corresponds to a solid color, whereas a - value of 0.0 corresponds to a completely transparent color. This - uses a wrapper message rather than a simple float scalar so that it - is possible to distinguish between a default value and the value - being unset. If omitted, this color object is rendered as a solid - color (as if the alpha value had been explicitly given a value of - 1.0). - type: number - format: float - green: - format: float - type: number - description: The amount of green in the color as a value in the interval [0, 1]. - blue: - type: number - description: The amount of blue in the color as a value in the interval [0, 1]. - format: float - description: >- - Represents a color in the RGBA color space. This representation is - designed for simplicity of conversion to and from color representations - in various languages over compactness. For example, the fields of this - representation can be trivially provided to the constructor of - `java.awt.Color` in Java; it can also be trivially provided to UIColor's - `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little - work, it can be easily formatted into a CSS `rgba()` string in - JavaScript. This reference page doesn't have information about the - absolute color space that should be used to interpret the RGB value—for - example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications - should assume the sRGB color space. When color equality needs to be - decided, implementations, unless documented otherwise, treat two colors - as equal if all their red, green, blue, and alpha values each differ by - at most `1e-5`. Example (Java): import com.google.type.Color; // ... - public static java.awt.Color fromProto(Color protocolor) { float alpha = - protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return - new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), - protocolor.getBlue(), alpha); } public static Color - toProto(java.awt.Color color) { float red = (float) color.getRed(); - float green = (float) color.getGreen(); float blue = (float) - color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder - = Color .newBuilder() .setRed(red / denominator) .setGreen(green / - denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); - if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() - .setValue(((float) alpha) / denominator) .build()); } return - resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static - UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; - float green = [protocolor green]; float blue = [protocolor blue]; - FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if - (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return - [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static - Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if - (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return - nil; } Color* result = [[Color alloc] init]; [result setRed:red]; - [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { - [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; - return result; } // ... Example (JavaScript): // ... var protoToCssColor - = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var - greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || - 0.0; var red = Math.floor(redFrac * 255); var green = - Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if - (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } - var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, - green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, - ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var - rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString - = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var - resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { - resultBuilder.push('0'); } resultBuilder.push(hexString); return - resultBuilder.join(''); }; // ... - id: Color - XPSBoundingBoxMetricsEntryConfidenceMetricsEntry: - description: Metrics for a single confidence threshold. - id: XPSBoundingBoxMetricsEntryConfidenceMetricsEntry + - UNKNOWN_MACHINE_SPEC + - N1_STANDARD_2 + - N1_STANDARD_4 + - N1_STANDARD_8 + - N1_STANDARD_16 + - N1_STANDARD_32 + - N1_STANDARD_64 + - N1_STANDARD_96 + - N1_HIGHMEM_2 + - N1_HIGHMEM_4 + - N1_HIGHMEM_8 + - N1_HIGHMEM_16 + - N1_HIGHMEM_32 + - N1_HIGHMEM_64 + - N1_HIGHMEM_96 + - N1_HIGHCPU_2 + - N1_HIGHCPU_4 + - N1_HIGHCPU_8 + - N1_HIGHCPU_16 + - N1_HIGHCPU_32 + - N1_HIGHCPU_64 + - N1_HIGHCPU_96 + - A2_HIGHGPU_1G + - A2_HIGHGPU_2G + - A2_HIGHGPU_4G + - A2_HIGHGPU_8G + - A2_MEGAGPU_16G + - A2_ULTRAGPU_1G + - A2_ULTRAGPU_2G + - A2_ULTRAGPU_4G + - A2_ULTRAGPU_8G + - A3_HIGHGPU_1G + - A3_HIGHGPU_2G + - A3_HIGHGPU_4G + - A3_HIGHGPU_8G + - A3_MEGAGPU_8G + - A3_ULTRAGPU_8G + - A3_EDGEGPU_8G + - A4_HIGHGPU_8G + - A4X_HIGHGPU_4G + - E2_STANDARD_2 + - E2_STANDARD_4 + - E2_STANDARD_8 + - E2_STANDARD_16 + - E2_STANDARD_32 + - E2_HIGHMEM_2 + - E2_HIGHMEM_4 + - E2_HIGHMEM_8 + - E2_HIGHMEM_16 + - E2_HIGHCPU_2 + - E2_HIGHCPU_4 + - E2_HIGHCPU_8 + - E2_HIGHCPU_16 + - E2_HIGHCPU_32 + - N2_STANDARD_2 + - N2_STANDARD_4 + - N2_STANDARD_8 + - N2_STANDARD_16 + - N2_STANDARD_32 + - N2_STANDARD_48 + - N2_STANDARD_64 + - N2_STANDARD_80 + - N2_STANDARD_96 + - N2_STANDARD_128 + - N2_HIGHMEM_2 + - N2_HIGHMEM_4 + - N2_HIGHMEM_8 + - N2_HIGHMEM_16 + - N2_HIGHMEM_32 + - N2_HIGHMEM_48 + - N2_HIGHMEM_64 + - N2_HIGHMEM_80 + - N2_HIGHMEM_96 + - N2_HIGHMEM_128 + - N2_HIGHCPU_2 + - N2_HIGHCPU_4 + - N2_HIGHCPU_8 + - N2_HIGHCPU_16 + - N2_HIGHCPU_32 + - N2_HIGHCPU_48 + - N2_HIGHCPU_64 + - N2_HIGHCPU_80 + - N2_HIGHCPU_96 + - N2D_STANDARD_2 + - N2D_STANDARD_4 + - N2D_STANDARD_8 + - N2D_STANDARD_16 + - N2D_STANDARD_32 + - N2D_STANDARD_48 + - N2D_STANDARD_64 + - N2D_STANDARD_80 + - N2D_STANDARD_96 + - N2D_STANDARD_128 + - N2D_STANDARD_224 + - N2D_HIGHMEM_2 + - N2D_HIGHMEM_4 + - N2D_HIGHMEM_8 + - N2D_HIGHMEM_16 + - N2D_HIGHMEM_32 + - N2D_HIGHMEM_48 + - N2D_HIGHMEM_64 + - N2D_HIGHMEM_80 + - N2D_HIGHMEM_96 + - N2D_HIGHCPU_2 + - N2D_HIGHCPU_4 + - N2D_HIGHCPU_8 + - N2D_HIGHCPU_16 + - N2D_HIGHCPU_32 + - N2D_HIGHCPU_48 + - N2D_HIGHCPU_64 + - N2D_HIGHCPU_80 + - N2D_HIGHCPU_96 + - N2D_HIGHCPU_128 + - N2D_HIGHCPU_224 + - C2_STANDARD_4 + - C2_STANDARD_8 + - C2_STANDARD_16 + - C2_STANDARD_30 + - C2_STANDARD_60 + - C2D_STANDARD_2 + - C2D_STANDARD_4 + - C2D_STANDARD_8 + - C2D_STANDARD_16 + - C2D_STANDARD_32 + - C2D_STANDARD_56 + - C2D_STANDARD_112 + - C2D_HIGHCPU_2 + - C2D_HIGHCPU_4 + - C2D_HIGHCPU_8 + - C2D_HIGHCPU_16 + - C2D_HIGHCPU_32 + - C2D_HIGHCPU_56 + - C2D_HIGHCPU_112 + - C2D_HIGHMEM_2 + - C2D_HIGHMEM_4 + - C2D_HIGHMEM_8 + - C2D_HIGHMEM_16 + - C2D_HIGHMEM_32 + - C2D_HIGHMEM_56 + - C2D_HIGHMEM_112 + - G2_STANDARD_4 + - G2_STANDARD_8 + - G2_STANDARD_12 + - G2_STANDARD_16 + - G2_STANDARD_24 + - G2_STANDARD_32 + - G2_STANDARD_48 + - G2_STANDARD_96 + - G4_STANDARD_48 + - C3_STANDARD_4 + - C3_STANDARD_8 + - C3_STANDARD_22 + - C3_STANDARD_44 + - C3_STANDARD_88 + - C3_STANDARD_176 + - C3_HIGHCPU_4 + - C3_HIGHCPU_8 + - C3_HIGHCPU_22 + - C3_HIGHCPU_44 + - C3_HIGHCPU_88 + - C3_HIGHCPU_176 + - C3_HIGHMEM_4 + - C3_HIGHMEM_8 + - C3_HIGHMEM_22 + - C3_HIGHMEM_44 + - C3_HIGHMEM_88 + - C3_HIGHMEM_176 + trackingLabels: + description: >- + Billing tracking labels. They do not contain any user data but only + the labels set by Vertex Core Infra itself. Tracking labels' keys + are defined with special format: goog-[\p{Ll}\p{N}]+ E.g. "key": + "goog-k8s-cluster-name","value": "us-east1-b4rk" + type: object + additionalProperties: + type: string + TpuMetric: + id: TpuMetric type: object properties: - precision: - format: float - description: Precision for the given confidence threshold. - type: number - confidenceThreshold: - type: number - description: The confidence threshold value used to compute the metrics. - format: float - recall: - description: Recall for the given confidence threshold. - type: number - format: float - f1Score: - description: The harmonic mean of recall and precision. - format: float - type: number + tpuType: + description: Required. Type of TPU, e.g. TPU_V2, TPU_V3_POD. + type: string + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + enum: + - UNKNOWN_TPU_TYPE + - TPU_V2_POD + - TPU_V2 + - TPU_V3_POD + - TPU_V3 + - TPU_V5_LITEPOD + tpuSec: + description: Required. Seconds of TPU usage, e.g. 3600. + type: string + format: int64 + DiskMetric: + id: DiskMetric + type: object + properties: + diskType: + description: Required. Type of Disk, e.g. REGIONAL_SSD. + type: string + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + enum: + - UNKNOWN_DISK_TYPE + - REGIONAL_SSD + - REGIONAL_STORAGE + - PD_SSD + - PD_STANDARD + - STORAGE_SNAPSHOT + gibSec: + description: Required. Seconds of physical disk usage, e.g. 3600. + type: string + format: int64 parameters: - callback: - description: JSONP - in: query - name: callback - schema: - type: string access_token: description: OAuth access token. in: query name: access_token schema: type: string - _.xgafv: - description: V1 error format. - in: query - name: $.xgafv - schema: - type: string - enum: - - '1' - - '2' alt: description: Data format for response. in: query @@ -4847,6 +4887,12 @@ components: - json - media - proto + callback: + description: JSONP + in: query + name: callback + schema: + type: string fields: description: Selector specifying which fields to include in a partial response. in: query @@ -4862,12 +4908,27 @@ components: 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 upload_protocol: description: Upload protocol for media (e.g. "raw", "multipart"). in: query @@ -4880,54 +4941,48 @@ components: name: uploadType schema: type: string - 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 - oauth_token: - description: OAuth 2.0 token for the current user. + _.xgafv: + description: V1 error format. in: query - name: oauth_token + name: $.xgafv schema: type: string + enum: + - '1' + - '2' x-stackQL-resources: documents: id: google.language.documents name: documents title: Documents methods: - moderate_text: + analyze_sentiment: operation: - $ref: '#/paths/~1v2~1documents:moderateText/post' + $ref: '#/paths/~1v2~1documents:analyzeSentiment/post' response: mediaType: application/json openAPIDocKey: '200' - classify_text: + analyze_entities: operation: - $ref: '#/paths/~1v2~1documents:classifyText/post' + $ref: '#/paths/~1v2~1documents:analyzeEntities/post' response: mediaType: application/json openAPIDocKey: '200' - annotate_text: + classify_text: operation: - $ref: '#/paths/~1v2~1documents:annotateText/post' + $ref: '#/paths/~1v2~1documents:classifyText/post' response: mediaType: application/json openAPIDocKey: '200' - analyze_entities: + moderate_text: operation: - $ref: '#/paths/~1v2~1documents:analyzeEntities/post' + $ref: '#/paths/~1v2~1documents:moderateText/post' response: mediaType: application/json openAPIDocKey: '200' - analyze_sentiment: + annotate_text: operation: - $ref: '#/paths/~1v2~1documents:analyzeSentiment/post' + $ref: '#/paths/~1v2~1documents:annotateText/post' response: mediaType: application/json openAPIDocKey: '200' @@ -4938,27 +4993,27 @@ components: replace: [] delete: [] paths: - /v2/documents:moderateText: + /v2/documents:analyzeSentiment: parameters: &ref_1 - - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/_.xgafv' post: - description: Moderates a document for harmful and sensitive categories. - operationId: language.documents.moderateText + description: Analyzes the sentiment of the provided text. + operationId: language.documents.analyzeSentiment requestBody: content: application/json: schema: - $ref: '#/components/schemas/ModerateTextRequest' + $ref: '#/components/schemas/AnalyzeSentimentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-language @@ -4974,18 +5029,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ModerateTextResponse' + $ref: '#/components/schemas/AnalyzeSentimentResponse' parameters: [] - /v2/documents:classifyText: + /v2/documents:analyzeEntities: parameters: *ref_1 post: - description: Classifies a document into categories. - operationId: language.documents.classifyText + description: >- + Finds named entities (currently proper names and common nouns) in the + text along with entity types, probability, mentions for each entity, and + other properties. + operationId: language.documents.analyzeEntities requestBody: content: application/json: schema: - $ref: '#/components/schemas/ClassifyTextRequest' + $ref: '#/components/schemas/AnalyzeEntitiesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-language @@ -5001,18 +5059,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ClassifyTextResponse' + $ref: '#/components/schemas/AnalyzeEntitiesResponse' parameters: [] - /v2/documents:annotateText: + /v2/documents:classifyText: parameters: *ref_1 post: - description: A convenience method that provides all features in one call. - operationId: language.documents.annotateText + description: Classifies a document into categories. + operationId: language.documents.classifyText requestBody: content: application/json: schema: - $ref: '#/components/schemas/AnnotateTextRequest' + $ref: '#/components/schemas/ClassifyTextRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-language @@ -5028,21 +5086,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AnnotateTextResponse' + $ref: '#/components/schemas/ClassifyTextResponse' parameters: [] - /v2/documents:analyzeEntities: + /v2/documents:moderateText: parameters: *ref_1 post: - description: >- - Finds named entities (currently proper names and common nouns) in the - text along with entity types, probability, mentions for each entity, and - other properties. - operationId: language.documents.analyzeEntities + description: Moderates a document for harmful and sensitive categories. + operationId: language.documents.moderateText requestBody: content: application/json: schema: - $ref: '#/components/schemas/AnalyzeEntitiesRequest' + $ref: '#/components/schemas/ModerateTextRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-language @@ -5058,18 +5113,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AnalyzeEntitiesResponse' + $ref: '#/components/schemas/ModerateTextResponse' parameters: [] - /v2/documents:analyzeSentiment: + /v2/documents:annotateText: parameters: *ref_1 post: - description: Analyzes the sentiment of the provided text. - operationId: language.documents.analyzeSentiment + description: A convenience method that provides all features in one call. + operationId: language.documents.annotateText requestBody: content: application/json: schema: - $ref: '#/components/schemas/AnalyzeSentimentRequest' + $ref: '#/components/schemas/AnnotateTextRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-language @@ -5085,5 +5140,5 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AnalyzeSentimentResponse' + $ref: '#/components/schemas/AnnotateTextResponse' parameters: [] diff --git a/providers/src/googleapis.com/v00.00.00000/services/libraryagent.yaml b/providers/src/googleapis.com/v00.00.00000/services/libraryagent.yaml index 99240d7a..b6b08722 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/libraryagent.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/libraryagent.yaml @@ -7,8 +7,8 @@ info: title: Library Agent API description: A simple Google Example Library API. version: v1 - x-discovery-doc-revision: '20241104' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250826' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/docs/quota servers: @@ -34,47 +34,28 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleExampleLibraryagentV1Book: + GoogleExampleLibraryagentV1Shelf: + id: GoogleExampleLibraryagentV1Shelf + description: A Shelf contains a collection of books with a theme. + type: object properties: name: - type: string description: >- - The resource name of the book. Book names have the form - `shelves/{shelf_id}/books/{book_id}`. The name is ignored when - creating a book. - read: - type: boolean - description: Value indicating whether the book has been read. - author: - type: string - description: The name of the book author. - title: - description: The title of the book. + Output only. The resource name of the shelf. Shelf names have the + form `shelves/{shelf_id}`. The name is ignored when creating a + shelf. type: string - description: A single book in the library. - id: GoogleExampleLibraryagentV1Book - type: object - GoogleExampleLibraryagentV1ListBooksResponse: - properties: - nextPageToken: + theme: + description: The theme of the shelf type: string - description: >- - A token to retrieve next page of results. Pass this value in the - ListBooksRequest.page_token field in the subsequent call to - `ListBooks` method to retrieve the next page of results. - books: - type: array - description: The list of books. - items: - $ref: '#/components/schemas/GoogleExampleLibraryagentV1Book' - description: Response message for LibraryAgent.ListBooks. - type: object - id: GoogleExampleLibraryagentV1ListBooksResponse GoogleExampleLibraryagentV1ListShelvesResponse: + id: GoogleExampleLibraryagentV1ListShelvesResponse + description: Response message for LibraryAgent.ListShelves. + type: object properties: shelves: - type: array description: The list of shelves. + type: array items: $ref: '#/components/schemas/GoogleExampleLibraryagentV1Shelf' nextPageToken: @@ -83,22 +64,41 @@ components: ListShelvesRequest.page_token field in the subsequent call to `ListShelves` method to retrieve the next page of results. type: string + GoogleExampleLibraryagentV1Book: + id: GoogleExampleLibraryagentV1Book + description: A single book in the library. type: object - description: Response message for LibraryAgent.ListShelves. - id: GoogleExampleLibraryagentV1ListShelvesResponse - GoogleExampleLibraryagentV1Shelf: - description: A Shelf contains a collection of books with a theme. - type: object - id: GoogleExampleLibraryagentV1Shelf properties: name: description: >- - Output only. The resource name of the shelf. Shelf names have the - form `shelves/{shelf_id}`. The name is ignored when creating a - shelf. + The resource name of the book. Book names have the form + `shelves/{shelf_id}/books/{book_id}`. The name is ignored when + creating a book. type: string - theme: - description: The theme of the shelf + author: + description: The name of the book author. + type: string + title: + description: The title of the book. + type: string + read: + description: Value indicating whether the book has been read. + type: boolean + GoogleExampleLibraryagentV1ListBooksResponse: + id: GoogleExampleLibraryagentV1ListBooksResponse + description: Response message for LibraryAgent.ListBooks. + type: object + properties: + books: + description: The list of books. + type: array + items: + $ref: '#/components/schemas/GoogleExampleLibraryagentV1Book' + nextPageToken: + description: >- + A token to retrieve next page of results. Pass this value in the + ListBooksRequest.page_token field in the subsequent call to + `ListBooks` method to retrieve the next page of results. type: string parameters: access_token: @@ -117,34 +117,31 @@ components: - json - media - proto - 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. + callback: + description: JSONP in: query - name: quotaUser + name: callback schema: type: string - oauth_token: - description: OAuth 2.0 token for the current user. + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: oauth_token + name: fields schema: type: string - _.xgafv: - description: V1 error format. + 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: $.xgafv + name: key schema: type: string - enum: - - '1' - - '2' - callback: - description: JSONP + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: callback + name: oauth_token schema: type: string prettyPrint: @@ -153,25 +150,19 @@ components: name: prettyPrint schema: type: boolean - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string - key: + quotaUser: 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. + 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: key + name: quotaUser schema: type: string - fields: - description: Selector specifying which fields to include in a partial response. + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: fields + name: upload_protocol schema: type: string uploadType: @@ -180,91 +171,97 @@ components: name: uploadType schema: type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' x-stackQL-resources: - books: - id: google.libraryagent.books - name: books - title: Books + shelves: + id: google.libraryagent.shelves + name: shelves + title: Shelves methods: - list: - operation: - $ref: '#/paths/~1v1~1shelves~1{shelvesId}~1books/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.books - return: - operation: - $ref: '#/paths/~1v1~1shelves~1{shelvesId}~1books~1{booksId}:return/post' - response: - mediaType: application/json - openAPIDocKey: '200' get: operation: - $ref: '#/paths/~1v1~1shelves~1{shelvesId}~1books~1{booksId}/get' + $ref: '#/paths/~1v1~1shelves~1{shelvesId}/get' response: mediaType: application/json openAPIDocKey: '200' - borrow: + list: operation: - $ref: '#/paths/~1v1~1shelves~1{shelvesId}~1books~1{booksId}:borrow/post' + $ref: '#/paths/~1v1~1shelves/get' response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.shelves sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/books/methods/get' - - $ref: '#/components/x-stackQL-resources/books/methods/list' + - $ref: '#/components/x-stackQL-resources/shelves/methods/get' + - $ref: '#/components/x-stackQL-resources/shelves/methods/list' insert: [] update: [] replace: [] delete: [] - shelves: - id: google.libraryagent.shelves - name: shelves - title: Shelves + books: + id: google.libraryagent.books + name: books + title: Books methods: get: operation: - $ref: '#/paths/~1v1~1shelves~1{shelvesId}/get' + $ref: '#/paths/~1v1~1shelves~1{shelvesId}~1books~1{booksId}/get' response: mediaType: application/json openAPIDocKey: '200' list: operation: - $ref: '#/paths/~1v1~1shelves/get' + $ref: '#/paths/~1v1~1shelves~1{shelvesId}~1books/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.books + borrow: + operation: + $ref: '#/paths/~1v1~1shelves~1{shelvesId}~1books~1{booksId}:borrow/post' + response: + mediaType: application/json + openAPIDocKey: '200' + return: + operation: + $ref: '#/paths/~1v1~1shelves~1{shelvesId}~1books~1{booksId}:return/post' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.shelves sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/shelves/methods/get' - - $ref: '#/components/x-stackQL-resources/shelves/methods/list' + - $ref: '#/components/x-stackQL-resources/books/methods/get' + - $ref: '#/components/x-stackQL-resources/books/methods/list' insert: [] update: [] replace: [] delete: [] paths: - /v1/shelves/{shelvesId}/books: + /v1/shelves/{shelvesId}: parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' get: - description: >- - Lists books in a shelf. The order is unspecified but deterministic. - Newly created books will not necessarily be added to the end of this - list. Returns NOT_FOUND if the shelf does not exist. - operationId: libraryagent.shelves.books.list + description: Gets a shelf. Returns NOT_FOUND if the shelf does not exist. + operationId: libraryagent.shelves.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -276,31 +273,48 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleExampleLibraryagentV1ListBooksResponse + $ref: '#/components/schemas/GoogleExampleLibraryagentV1Shelf' parameters: - in: path name: shelvesId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string + /v1/shelves: + parameters: *ref_1 + get: + description: >- + Lists shelves. The order is unspecified but deterministic. Newly created + shelves will not necessarily be added to the end of this list. + operationId: libraryagent.shelves.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleExampleLibraryagentV1ListShelvesResponse + parameters: - in: query name: pageSize schema: type: integer format: int32 - /v1/shelves/{shelvesId}/books/{booksId}:return: + - in: query + name: pageToken + schema: + type: string + /v1/shelves/{shelvesId}/books/{booksId}: parameters: *ref_1 - post: - description: >- - Return a book to the library. Returns the book if it is returned to the - library successfully. Returns error if the book does not belong to the - library or the users didn't borrow before. - operationId: libraryagent.shelves.books.return + get: + description: Gets a book. Returns NOT_FOUND if the book does not exist. + operationId: libraryagent.shelves.books.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -324,11 +338,14 @@ paths: required: true schema: type: string - /v1/shelves/{shelvesId}/books/{booksId}: + /v1/shelves/{shelvesId}/books: parameters: *ref_1 get: - description: Gets a book. Returns NOT_FOUND if the book does not exist. - operationId: libraryagent.shelves.books.get + description: >- + Lists books in a shelf. The order is unspecified but deterministic. + Newly created books will not necessarily be added to the end of this + list. Returns NOT_FOUND if the shelf does not exist. + operationId: libraryagent.shelves.books.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -340,16 +357,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleExampleLibraryagentV1Book' + $ref: >- + #/components/schemas/GoogleExampleLibraryagentV1ListBooksResponse parameters: - in: path name: shelvesId required: true schema: type: string - - in: path - name: booksId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string /v1/shelves/{shelvesId}/books/{booksId}:borrow: @@ -384,11 +406,14 @@ paths: required: true schema: type: string - /v1/shelves/{shelvesId}: + /v1/shelves/{shelvesId}/books/{booksId}:return: parameters: *ref_1 - get: - description: Gets a shelf. Returns NOT_FOUND if the shelf does not exist. - operationId: libraryagent.shelves.get + post: + description: >- + Return a book to the library. Returns the book if it is returned to the + library successfully. Returns error if the book does not belong to the + library or the users didn't borrow before. + operationId: libraryagent.shelves.books.return security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -400,40 +425,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleExampleLibraryagentV1Shelf' + $ref: '#/components/schemas/GoogleExampleLibraryagentV1Book' parameters: - in: path name: shelvesId required: true schema: type: string - /v1/shelves: - parameters: *ref_1 - get: - description: >- - Lists shelves. The order is unspecified but deterministic. Newly created - shelves will not necessarily be added to the end of this list. - operationId: libraryagent.shelves.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleExampleLibraryagentV1ListShelvesResponse - parameters: - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: booksId + required: true schema: type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/lifesciences.yaml b/providers/src/googleapis.com/v00.00.00000/services/lifesciences.yaml index f3d6fb29..467c6712 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/lifesciences.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/lifesciences.yaml @@ -9,8 +9,8 @@ info: Cloud Life Sciences is a suite of services and tools for managing, processing, and transforming life sciences data. version: v2beta - x-discovery-doc-revision: '20241025' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250708' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/life-sciences servers: @@ -1366,6 +1366,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v2beta/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: diff --git a/providers/src/googleapis.com/v00.00.00000/services/logging.yaml b/providers/src/googleapis.com/v00.00.00000/services/logging.yaml index 3c07b9ea..49510dc9 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/logging.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/logging.yaml @@ -7,8 +7,8 @@ info: title: Cloud Logging API description: Writes log entries and manages your Cloud Logging configuration. version: v2 - x-discovery-doc-revision: '20241024' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250704' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/logging/docs/ servers: @@ -130,11 +130,6 @@ components: type: array items: $ref: '#/components/schemas/Binding' - auditConfigs: - description: Specifies cloud audit logging configuration for this policy. - type: array - items: - $ref: '#/components/schemas/AuditConfig' etag: description: >- etag is used for optimistic concurrency control as a way to help @@ -278,69 +273,6 @@ components: Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. type: string - AuditConfig: - id: 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. - type: object - properties: - 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 - auditLogConfigs: - description: The configuration for logging of each type of permission. - type: array - items: - $ref: '#/components/schemas/AuditLogConfig' - AuditLogConfig: - id: 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. - type: object - properties: - logType: - description: The log type that this config enables. - type: string - enumDescriptions: - - Default case. Should never be this. - - 'Admin reads. Example: CloudIAM getIamPolicy' - - 'Data writes. Example: CloudSQL Users create' - - 'Data reads. Example: CloudSQL Users list' - enum: - - LOG_TYPE_UNSPECIFIED - - ADMIN_READ - - DATA_WRITE - - DATA_READ - exemptedMembers: - description: >- - Specifies the identities that do not cause logging for this type of - permission. Follows the same format of Binding.members. - type: array - items: - type: string GetIamPolicyRequest: id: GetIamPolicyRequest description: Request message for GetIamPolicy method. @@ -910,11 +842,10 @@ components: properties: name: description: >- - Output only. A client-assigned identifier, such as + Optional. A client-assigned identifier, such as "load-balancer-exclusion". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. First character has to be alphanumeric. - readOnly: true type: string description: description: Optional. A description of this exclusion. @@ -978,13 +909,12 @@ components: properties: name: description: >- - Output only. The client-assigned sink identifier, unique within the + Optional. The client-assigned sink identifier, unique within the project.For example: "my-syslog-errors-to-pubsub".Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, periods.First character has to be alphanumeric. - readOnly: true type: string resourceName: description: >- @@ -1032,7 +962,7 @@ components: description: >- Optional. Log entries that match any of these exclusion filters will not be exported.If a log entry is matched by both filter and one of - exclusion_filters it will not be exported. + exclusions it will not be exported. type: array items: $ref: '#/components/schemas/LogExclusion' @@ -1526,12 +1456,11 @@ components: properties: name: description: >- - Output only. Resource name of the recent query.In the format: + Optional. Resource name of the recent query.In the format: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/recentQueries/[QUERY_ID]" For a list of supported locations, see Supported Regions (https://cloud.google.com/logging/docs/region-support)The QUERY_ID is a system generated alphanumeric ID. - readOnly: true type: string loggingQuery: description: >- @@ -1563,7 +1492,9 @@ components: entries. type: string destination: - description: Required. Destination to which to copy log entries. + description: >- + Required. Destination to which to copy log entries. For example: + "storage.googleapis.com/GCS_BUCKET" type: string WriteLogEntriesRequest: id: WriteLogEntriesRequest @@ -1892,6 +1823,21 @@ components: type: array items: $ref: '#/components/schemas/LogErrorGroup' + apphub: + description: >- + Output only. AppHub application metadata associated with this + LogEntry. May be empty if there is no associated AppHub application + or multiple associated applications (such as for VPC flow logs) + readOnly: true + $ref: '#/components/schemas/AppHub' + apphubDestination: + description: >- + Output only. AppHub application metadata associated with the + destination application. This is only populated if the log + represented "edge"-like data (such as for VPC flow logs) with a + source and destination. + readOnly: true + $ref: '#/components/schemas/AppHub' HttpRequest: id: HttpRequest description: >- @@ -2108,6 +2054,69 @@ components: Service Data is handled, see Google Cloud Privacy Notice (https://cloud.google.com/terms/cloud-privacy-notice). type: string + AppHub: + id: AppHub + description: Metadata associated with App Hub. + type: object + properties: + application: + description: Metadata associated with the application. + $ref: '#/components/schemas/AppHubApplication' + service: + description: Metadata associated with the service. + $ref: '#/components/schemas/AppHubService' + workload: + description: Metadata associated with the workload. + $ref: '#/components/schemas/AppHubWorkload' + AppHubApplication: + id: AppHubApplication + description: >- + Resource identifiers associated with an AppHub application AppHub + resources are of the form projects//locations//applications/ + projects//locations//applications//services/ + projects//locations//applications//workloads/ These resources can be + reconstructed from the components below. + type: object + properties: + container: + description: >- + Resource container that owns the application. Example: + "projects/management_project" + type: string + location: + description: 'Location associated with the Application. Example: "us-east1"' + type: string + id: + description: 'Application Id. Example: "my-app"' + type: string + AppHubService: + id: AppHubService + description: Metadata associated with an App Hub service. + type: object + properties: + id: + description: 'Service Id. Example: "my-service"' + type: string + environmentType: + description: 'Service environment type Example: "DEV"' + type: string + criticalityType: + description: 'Service criticality type Example: "CRITICAL"' + type: string + AppHubWorkload: + id: AppHubWorkload + description: Metadata associated with an App Hub workload. + type: object + properties: + id: + description: 'Workload Id. Example: "my-workload"' + type: string + environmentType: + description: 'Workload environment type Example: "DEV"' + type: string + criticalityType: + description: 'Workload criticality type Example: "CRITICAL"' + type: string WriteLogEntriesResponse: id: WriteLogEntriesResponse description: Result returned from WriteLogEntries. @@ -3450,10 +3459,7 @@ components: parent: description: >- Required. The full resource name of the bucket to create a link for. - "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" - "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" - "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" - "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" + "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" type: string link: description: Required. The new link. @@ -5948,6 +5954,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v2/{name}: parameters: *ref_1 get: @@ -7043,6 +7053,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v2/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: @@ -9215,11 +9229,11 @@ paths: parameters: *ref_1 delete: description: >- - Deletes all the log entries in a log for the _Default Log Bucket. The - log reappears if it receives new entries. Log entries written shortly - before the delete operation might not be deleted. Entries received after - the delete operation with a timestamp before the operation will be - deleted. + Deletes all the log entries in a log for the global _Default Log Bucket. + The log reappears if it receives new entries. Log entries written + shortly before the delete operation might not be deleted. Entries + received after the delete operation with a timestamp before the + operation will be deleted. operationId: logging.projects.logs.delete security: - Oauth2: @@ -9711,6 +9725,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v2/organizations/{organizationsId}/locations/{locationsId}: parameters: *ref_1 get: @@ -11883,11 +11901,11 @@ paths: parameters: *ref_1 delete: description: >- - Deletes all the log entries in a log for the _Default Log Bucket. The - log reappears if it receives new entries. Log entries written shortly - before the delete operation might not be deleted. Entries received after - the delete operation with a timestamp before the operation will be - deleted. + Deletes all the log entries in a log for the global _Default Log Bucket. + The log reappears if it receives new entries. Log entries written + shortly before the delete operation might not be deleted. Entries + received after the delete operation with a timestamp before the + operation will be deleted. operationId: logging.organizations.logs.delete security: - Oauth2: @@ -12143,6 +12161,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v2/folders/{foldersId}/locations/{locationsId}: parameters: *ref_1 get: @@ -14315,11 +14337,11 @@ paths: parameters: *ref_1 delete: description: >- - Deletes all the log entries in a log for the _Default Log Bucket. The - log reappears if it receives new entries. Log entries written shortly - before the delete operation might not be deleted. Entries received after - the delete operation with a timestamp before the operation will be - deleted. + Deletes all the log entries in a log for the global _Default Log Bucket. + The log reappears if it receives new entries. Log entries written + shortly before the delete operation might not be deleted. Entries + received after the delete operation with a timestamp before the + operation will be deleted. operationId: logging.folders.logs.delete security: - Oauth2: @@ -14528,6 +14550,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v2/billingAccounts/{billingAccountsId}/locations/{locationsId}: parameters: *ref_1 get: @@ -16320,11 +16346,11 @@ paths: parameters: *ref_1 delete: description: >- - Deletes all the log entries in a log for the _Default Log Bucket. The - log reappears if it receives new entries. Log entries written shortly - before the delete operation might not be deleted. Entries received after - the delete operation with a timestamp before the operation will be - deleted. + Deletes all the log entries in a log for the global _Default Log Bucket. + The log reappears if it receives new entries. Log entries written + shortly before the delete operation might not be deleted. Entries + received after the delete operation with a timestamp before the + operation will be deleted. operationId: logging.billingAccounts.logs.delete security: - Oauth2: @@ -16548,11 +16574,11 @@ paths: parameters: *ref_1 delete: description: >- - Deletes all the log entries in a log for the _Default Log Bucket. The - log reappears if it receives new entries. Log entries written shortly - before the delete operation might not be deleted. Entries received after - the delete operation with a timestamp before the operation will be - deleted. + Deletes all the log entries in a log for the global _Default Log Bucket. + The log reappears if it receives new entries. Log entries written + shortly before the delete operation might not be deleted. Entries + received after the delete operation with a timestamp before the + operation will be deleted. operationId: logging.logs.delete security: - Oauth2: diff --git a/providers/src/googleapis.com/v00.00.00000/services/looker.yaml b/providers/src/googleapis.com/v00.00.00000/services/looker.yaml index 33917cf6..85b217cb 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/looker.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/looker.yaml @@ -7,8 +7,8 @@ info: title: Looker (Google Cloud core) API description: '' version: v1 - x-discovery-doc-revision: '20241024' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250730' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/looker/docs/reference/rest/ servers: @@ -225,6 +225,12 @@ components: - Subscription Standard. - Subscription Enterprise. - Subscription Embed. + - Nonprod Subscription Standard. + - Nonprod Subscription Enterprise. + - Nonprod Subscription Embed. + - Trial Standard. + - Trial Enterprise. + - Trial Embed. enum: - PLATFORM_EDITION_UNSPECIFIED - LOOKER_CORE_TRIAL @@ -232,6 +238,12 @@ components: - LOOKER_CORE_STANDARD_ANNUAL - LOOKER_CORE_ENTERPRISE_ANNUAL - LOOKER_CORE_EMBED_ANNUAL + - LOOKER_CORE_NONPROD_STANDARD_ANNUAL + - LOOKER_CORE_NONPROD_ENTERPRISE_ANNUAL + - LOOKER_CORE_NONPROD_EMBED_ANNUAL + - LOOKER_CORE_TRIAL_STANDARD + - LOOKER_CORE_TRIAL_ENTERPRISE + - LOOKER_CORE_TRIAL_EMBED publicIpEnabled: description: Whether public IP is enabled on the Looker instance. type: boolean @@ -298,9 +310,10 @@ components: description: Maintenance schedule for this instance. $ref: '#/components/schemas/MaintenanceSchedule' userMetadata: - description: User metadata. + description: Optional. User metadata. $ref: '#/components/schemas/UserMetadata' customDomain: + description: Custom domain configuration for the instance. $ref: '#/components/schemas/CustomDomain' encryptionConfig: description: >- @@ -325,6 +338,25 @@ components: Optional. Whether Gemini feature is enabled on the Looker instance or not. type: boolean + satisfiesPzs: + description: Output only. Reserved for future use. + readOnly: true + type: boolean + satisfiesPzi: + description: Output only. Reserved for future use. + readOnly: true + type: boolean + classType: + description: Optional. Storage class of the instance. + type: string + enumDescriptions: + - Unspecified storage class. + - Filestore. + - PD SSD. + enum: + - CLASS_TYPE_UNSPECIFIED + - R1 + - P1 PscConfig: id: PscConfig description: >- @@ -355,7 +387,7 @@ components: properties: localFqdn: description: >- - Required. Fully qualified domain name that will be used in the + Optional. Fully qualified domain name that will be used in the private DNS record created for the service attachment. type: string targetServiceAttachmentUri: @@ -389,6 +421,13 @@ components: - REJECTED - NEEDS_ATTENTION - CLOSED + localFqdns: + description: >- + Optional. List of fully qualified domain names that will be used in + the private DNS record created for the service attachment. + type: array + items: + type: string MaintenanceWindow: id: MaintenanceWindow description: Specifies the recurring maintenance window. @@ -625,6 +664,79 @@ components: description: Request options for restarting an instance. type: object properties: {} + ListInstanceBackupsResponse: + id: ListInstanceBackupsResponse + description: Response from listing Looker instance backups. + type: object + properties: + instanceBackups: + description: >- + The list of instances matching the request filters, up to the + requested `page_size`. + type: array + items: + $ref: '#/components/schemas/InstanceBackup' + nextPageToken: + description: >- + If provided, a page token that can look up the next `page_size` + results. If empty, the results list is exhausted. + type: string + unreachable: + description: Locations that could not be reached. + type: array + items: + type: string + InstanceBackup: + id: InstanceBackup + description: The details of a backup resource. + type: object + properties: + name: + description: >- + Immutable. The relative resource name of the backup, in the + following form: + `projects/{project_number}/locations/{location_id}/instances/{instance_id}/backups/{backup}` + type: string + createTime: + description: Output only. The time when the backup was started. + readOnly: true + type: string + format: google-datetime + expireTime: + description: Output only. The time when the backup will be deleted. + readOnly: true + type: string + format: google-datetime + state: + description: Output only. The current state of the backup. + readOnly: true + type: string + enumDescriptions: + - The state of the backup is unknown. + - The backup is being created. + - The backup is being deleted. + - The backup is active and ready to use. + - The backup failed. + enum: + - STATE_UNSPECIFIED + - CREATING + - DELETING + - ACTIVE + - FAILED + encryptionConfig: + description: Output only. Current status of the CMEK encryption + readOnly: true + $ref: '#/components/schemas/EncryptionConfig' + RestoreInstanceRequest: + id: RestoreInstanceRequest + description: Request options for restoring an instance + type: object + properties: + backup: + description: >- + Required. Backup being used to restore the instance Format: + projects/{project}/locations/{location}/instances/{instance}/backups/{backup} + type: string ImportInstanceRequest: id: ImportInstanceRequest description: Requestion options for importing looker data to an Instance @@ -707,338 +819,6 @@ components: additionalProperties: type: any description: Properties of the object. Contains field @type with type URL. - SetIamPolicyRequest: - id: SetIamPolicyRequest - description: Request message for `SetIamPolicy` method. - type: object - properties: - policy: - description: >- - REQUIRED: The complete policy to be applied to the `resource`. The - size of the policy is limited to a few 10s of KB. An empty policy is - a valid policy but certain Google Cloud services (such as Projects) - might reject them. - $ref: '#/components/schemas/Policy' - updateMask: - description: >- - OPTIONAL: A FieldMask specifying which fields of the policy to - modify. Only the fields in the mask will be modified. If no mask is - provided, the following default mask is used: `paths: "bindings, - etag"` - type: string - format: google-fieldmask - Policy: - id: Policy - description: >- - An Identity and Access Management (IAM) policy, which specifies access - controls for Google Cloud resources. A `Policy` is a collection of - `bindings`. A `binding` binds one or more `members`, or principals, to a - single `role`. Principals can be user accounts, service accounts, Google - groups, and domains (such as G Suite). A `role` is a named list of - permissions; each `role` can be an IAM predefined role or a user-created - custom role. For some types of Google Cloud resources, a `binding` can - also specify a `condition`, which is a logical expression that allows - access to a resource only if the expression evaluates to `true`. A - condition can add constraints based on attributes of the request, the - resource, or both. To learn which resources support conditions in their - IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - **JSON example:** ``` { "bindings": [ { "role": - "roles/resourcemanager.organizationAdmin", "members": [ - "user:mike@example.com", "group:admins@example.com", - "domain:google.com", - "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { - "role": "roles/resourcemanager.organizationViewer", "members": [ - "user:eve@example.com" ], "condition": { "title": "expirable access", - "description": "Does not grant access after Sep 2020", "expression": - "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": - "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - - members: - user:mike@example.com - group:admins@example.com - - domain:google.com - - serviceAccount:my-project-id@appspot.gserviceaccount.com role: - roles/resourcemanager.organizationAdmin - members: - - user:eve@example.com role: roles/resourcemanager.organizationViewer - condition: title: expirable access description: Does not grant access - after Sep 2020 expression: request.time < - timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` - For a description of IAM and its features, see the [IAM - documentation](https://cloud.google.com/iam/docs/). - type: object - properties: - 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). - type: integer - format: int32 - bindings: - description: >- - Associates a list of `members`, or principals, with a `role`. - Optionally, may specify a `condition` that determines how and when - the `bindings` are applied. Each of the `bindings` must contain at - least one principal. The `bindings` in a `Policy` can refer to up to - 1,500 principals; up to 250 of these principals can be Google - groups. Each occurrence of a principal counts towards these limits. - For example, if the `bindings` grant 50 different roles to - `user:alice@example.com`, and not to any other principal, then you - can add another 1,450 principals to the `bindings` in the `Policy`. - type: array - items: - $ref: '#/components/schemas/Binding' - auditConfigs: - description: Specifies cloud audit logging configuration for this policy. - type: array - items: - $ref: '#/components/schemas/AuditConfig' - 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. - type: string - format: byte - Binding: - id: Binding - description: Associates `members`, or principals, with a `role`. - type: object - properties: - role: - description: >- - Role that is assigned to the list of `members`, or principals. For - example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an - overview of the IAM roles and permissions, see the [IAM - documentation](https://cloud.google.com/iam/docs/roles-overview). - For a list of the available pre-defined roles, see - [here](https://cloud.google.com/iam/docs/understanding-roles). - type: string - members: - description: >- - Specifies the principals requesting access for a Google Cloud - 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. Does not include identities - that come from external identity providers (IdPs) through identity - federation. * `user:{emailid}`: An email address that represents a - specific Google account. For example, `alice@example.com` . * - `serviceAccount:{emailid}`: An email address that represents a - Google service account. For example, - `my-other-app@appspot.gserviceaccount.com`. * - `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: - An identifier for a [Kubernetes service - account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). - For example, - `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * - `group:{emailid}`: An email address that represents a Google group. - For example, `admins@example.com`. * `domain:{domain}`: The G Suite - domain (primary) that represents all the users of that domain. For - example, `google.com` or `example.com`. * - `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workforce identity pool. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: - All workforce identities in a group. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All workforce identities with a specific attribute value. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: - All identities in a workforce identity pool. * - `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workload identity pool. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: - A workload identity pool group. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All identities in a workload identity pool with a certain attribute. - * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: - All identities in a workload identity pool. * - `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. * - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - Deleted single identity in a workforce identity pool. For example, - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. - type: array - items: - type: string - condition: - description: >- - The condition that is associated with this binding. If the condition - evaluates to `true`, then this binding applies to the current - request. If the condition evaluates to `false`, then this binding - does not apply to the current request. However, a different role - binding might grant the same role to one or more of the principals - in this binding. To learn which resources support conditions in - their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - $ref: '#/components/schemas/Expr' - Expr: - id: 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. - type: object - properties: - expression: - description: >- - Textual representation of an expression in Common Expression - Language syntax. - 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 - 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 - 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 - AuditConfig: - id: 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. - type: object - properties: - 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 - auditLogConfigs: - description: The configuration for logging of each type of permission. - type: array - items: - $ref: '#/components/schemas/AuditLogConfig' - AuditLogConfig: - id: 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. - type: object - properties: - logType: - description: The log type that this config enables. - type: string - enumDescriptions: - - Default case. Should never be this. - - 'Admin reads. Example: CloudIAM getIamPolicy' - - 'Data writes. Example: CloudSQL Users create' - - 'Data reads. Example: CloudSQL Users list' - enum: - - LOG_TYPE_UNSPECIFIED - - ADMIN_READ - - DATA_WRITE - - DATA_READ - exemptedMembers: - description: >- - Specifies the identities that do not cause logging for this type of - permission. Follows the same format of Binding.members. - type: array - items: - type: string - TestIamPermissionsRequest: - id: TestIamPermissionsRequest - description: Request message for `TestIamPermissions` method. - type: object - properties: - permissions: - description: >- - The set of permissions to check for the `resource`. Permissions with - wildcards (such as `*` or `storage.*`) are not allowed. For more - information see [IAM - Overview](https://cloud.google.com/iam/docs/overview#permissions). - type: array - items: - type: string - TestIamPermissionsResponse: - id: TestIamPermissionsResponse - description: Response message for `TestIamPermissions` method. - type: object - properties: - permissions: - description: >- - A subset of `TestPermissionsRequest.permissions` that the caller is - allowed. - type: array - items: - type: string OperationMetadata: id: OperationMetadata description: Represents the metadata of the long-running operation. @@ -1326,6 +1106,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + restore: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1instances~1{instancesId}:restore/post + response: + mediaType: application/json + openAPIDocKey: '200' import: operation: $ref: >- @@ -1351,80 +1138,50 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/instances/methods/delete' - instances_iam_policies: - id: google.looker.instances_iam_policies - name: instances_iam_policies - title: Instances_iam_policies + backups: + id: google.looker.backups + name: backups + title: Backups methods: - set_iam_policy: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1instances~1{instancesId}:setIamPolicy/post - response: - mediaType: application/json - openAPIDocKey: '200' - get_iam_policy: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1instances~1{instancesId}:getIamPolicy/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.bindings - test_iam_permissions: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1instances~1{instancesId}:testIamPermissions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1instances~1{instancesId}~1backups/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/instances_iam_policies/methods/get_iam_policy - insert: [] - update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/instances_iam_policies/methods/set_iam_policy - delete: [] - backups_iam_policies: - id: google.looker.backups_iam_policies - name: backups_iam_policies - title: Backups_iam_policies - methods: - set_iam_policy: + objectKey: $.instanceBackups + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1instances~1{instancesId}~1backups~1{backupsId}:setIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1instances~1{instancesId}~1backups/post response: mediaType: application/json openAPIDocKey: '200' - get_iam_policy: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1instances~1{instancesId}~1backups~1{backupsId}:getIamPolicy/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1instances~1{instancesId}~1backups~1{backupsId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.bindings - test_iam_permissions: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1instances~1{instancesId}~1backups~1{backupsId}:testIamPermissions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1instances~1{instancesId}~1backups~1{backupsId}/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/backups_iam_policies/methods/get_iam_policy - insert: [] + - $ref: '#/components/x-stackQL-resources/backups/methods/get' + - $ref: '#/components/x-stackQL-resources/backups/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/backups/methods/create' update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/backups_iam_policies/methods/set_iam_policy - delete: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/backups/methods/delete' paths: /v1/projects/{projectsId}/locations: parameters: &ref_1 @@ -1473,6 +1230,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: @@ -1627,7 +1388,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: looker.projects.locations.operations.cancel requestBody: content: @@ -1881,16 +1642,16 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:import: + /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:restore: parameters: *ref_1 post: - description: Import instance. - operationId: looker.projects.locations.instances.import + description: Restore Looker instance. + operationId: looker.projects.locations.instances.restore requestBody: content: application/json: schema: - $ref: '#/components/schemas/ImportInstanceRequest' + $ref: '#/components/schemas/RestoreInstanceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1919,16 +1680,16 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:export: + /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:import: parameters: *ref_1 post: - description: Export instance. - operationId: looker.projects.locations.instances.export + description: Import instance. + operationId: looker.projects.locations.instances.import requestBody: content: application/json: schema: - $ref: '#/components/schemas/ExportInstanceRequest' + $ref: '#/components/schemas/ImportInstanceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1957,19 +1718,16 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:setIamPolicy: + /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:export: parameters: *ref_1 post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - `PERMISSION_DENIED` errors. - operationId: looker.projects.locations.instances.setIamPolicy + description: Export instance. + operationId: looker.projects.locations.instances.export requestBody: content: application/json: schema: - $ref: '#/components/schemas/SetIamPolicyRequest' + $ref: '#/components/schemas/ExportInstanceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1981,7 +1739,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -1998,13 +1756,11 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:getIamPolicy: + /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/backups: parameters: *ref_1 get: - description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: looker.projects.locations.instances.getIamPolicy + description: List backups of Looker instance. + operationId: looker.projects.locations.instances.backups.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2016,7 +1772,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/ListInstanceBackupsResponse' parameters: - in: path name: projectsId @@ -2034,66 +1790,26 @@ paths: schema: type: string - in: query - name: options.requestedPolicyVersion + name: pageSize schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:testIamPermissions: - parameters: *ref_1 - post: - description: >- - Returns permissions that a caller has on the specified resource. If the - resource does not exist, this will return an empty set of permissions, - not a `NOT_FOUND` error. Note: This operation is designed to be used for - building permission-aware UIs and command-line tools, not for - authorization checking. This operation may "fail open" without warning. - operationId: looker.projects.locations.instances.testIamPermissions - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TestIamPermissionsRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/TestIamPermissionsResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true + - in: query + name: pageToken schema: type: string - - in: path - name: instancesId - required: true + - in: query + name: orderBy schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/backups/{backupsId}:setIamPolicy: - parameters: *ref_1 post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - `PERMISSION_DENIED` errors. - operationId: looker.projects.locations.instances.backups.setIamPolicy + description: Backup Looker instance. + operationId: looker.projects.locations.instances.backups.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SetIamPolicyRequest' + $ref: '#/components/schemas/InstanceBackup' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2105,7 +1821,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -2122,18 +1838,11 @@ paths: required: true schema: type: string - - in: path - name: backupsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/backups/{backupsId}:getIamPolicy: + /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/backups/{backupsId}: parameters: *ref_1 get: - description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: looker.projects.locations.instances.backups.getIamPolicy + description: '' + operationId: looker.projects.locations.instances.backups.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2145,7 +1854,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/InstanceBackup' parameters: - in: path name: projectsId @@ -2167,26 +1876,9 @@ paths: required: true schema: type: string - - in: query - name: options.requestedPolicyVersion - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/backups/{backupsId}:testIamPermissions: - parameters: *ref_1 - post: - description: >- - Returns permissions that a caller has on the specified resource. If the - resource does not exist, this will return an empty set of permissions, - not a `NOT_FOUND` error. Note: This operation is designed to be used for - building permission-aware UIs and command-line tools, not for - authorization checking. This operation may "fail open" without warning. - operationId: looker.projects.locations.instances.backups.testIamPermissions - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TestIamPermissionsRequest' + delete: + description: Delete backup. + operationId: looker.projects.locations.instances.backups.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2198,7 +1890,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TestIamPermissionsResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId diff --git a/providers/src/googleapis.com/v00.00.00000/services/managedidentities.yaml b/providers/src/googleapis.com/v00.00.00000/services/managedidentities.yaml index cd9d205e..b659b65f 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/managedidentities.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/managedidentities.yaml @@ -10,8 +10,8 @@ info: a highly available, hardened service running Microsoft Active Directory (AD). version: v1 - x-discovery-doc-revision: '20240912' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250116' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/managed-microsoft-ad/ servers: @@ -1236,8 +1236,8 @@ components: description: >- Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully - have Operation.error value with a google.rpc.Status.code of 1, - corresponding to `Code.CANCELLED`. + have google.longrunning.Operation.error value with a + google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. readOnly: true type: boolean apiVersion: @@ -1843,23 +1843,28 @@ components: properties: hours: description: >- - Hours of day in 24 hour format. Should be from 0 to 23. An API may - choose to allow the value "24:00:00" for scenarios like business - closing time. + Hours of a day in 24 hour format. Must be greater than or equal to 0 + and typically must be less than or equal to 23. An API may choose to + allow the value "24:00:00" for scenarios like business closing time. type: integer format: int32 minutes: - description: Minutes of hour of day. Must be from 0 to 59. + description: >- + Minutes of an hour. Must be greater than or equal to 0 and less than + or equal to 59. type: integer format: int32 seconds: description: >- - Seconds of minutes of the time. Must normally be from 0 to 59. An - API may allow the value 60 if it allows leap-seconds. + Seconds of a minute. Must be greater than or equal to 0 and + typically must be less than or equal to 59. An API may allow the + value 60 if it allows leap-seconds. type: integer format: int32 nanos: - description: Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. + description: >- + Fractions of seconds, in nanoseconds. Must be greater than or equal + to 0 and less than or equal to 999,999,999. type: integer format: int32 WeeklyCycle: @@ -2714,7 +2719,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: managedidentities.projects.locations.global.operations.cancel requestBody: content: diff --git a/providers/src/googleapis.com/v00.00.00000/services/managedkafka.yaml b/providers/src/googleapis.com/v00.00.00000/services/managedkafka.yaml new file mode 100644 index 00000000..dcb38455 --- /dev/null +++ b/providers/src/googleapis.com/v00.00.00000/services/managedkafka.yaml @@ -0,0 +1,6073 @@ +openapi: 3.1.0 +info: + contact: + name: StackQL Studios + url: https://github.com/stackql/google-discovery-to-openapi + email: info@stackql.io + title: Managed Service for Apache Kafka API + description: 'Manage Apache Kafka clusters and resources. ' + version: v1 + x-discovery-doc-revision: '20250814' + x-generated-date: '2025-08-28' +externalDocs: + url: https://cloud.google.com/managed-service-for-apache-kafka/docs +servers: + - url: https://managedkafka.googleapis.com +components: + securitySchemes: + Oauth2: + type: oauth2 + description: Oauth 2.0 implicit authentication + flows: + implicit: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + scopes: &ref_0 + 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. + Oauth2c: + type: oauth2 + description: Oauth 2.0 authorization code authentication + flows: + authorizationCode: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + tokenUrl: https://accounts.google.com/o/oauth2/token + scopes: *ref_0 + schemas: + ListOperationsResponse: + id: ListOperationsResponse + description: The response message for Operations.ListOperations. + type: object + properties: + operations: + description: >- + A list of operations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/Operation' + nextPageToken: + description: The standard List next-page token. + type: string + Operation: + id: Operation + description: >- + This resource represents a long-running operation that is the result of + a network API call. + type: object + properties: + name: + description: >- + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. + type: string + metadata: + description: >- + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + done: + description: >- + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + type: boolean + error: + description: >- + The error result of the operation in case of failure or + cancellation. + $ref: '#/components/schemas/Status' + response: + description: >- + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + Status: + id: Status + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + type: object + properties: + code: + description: The status code, which should be an enum value of google.rpc.Code. + type: integer + format: int32 + message: + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + type: string + details: + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + type: array + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + Empty: + id: Empty + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + type: object + properties: {} + CancelOperationRequest: + id: CancelOperationRequest + description: The request message for Operations.CancelOperation. + type: object + properties: {} + ListClustersResponse: + id: ListClustersResponse + description: Response for ListClusters. + type: object + properties: + clusters: + description: The list of Clusters in the requested parent. + type: array + items: + $ref: '#/components/schemas/Cluster' + nextPageToken: + description: >- + A token that can be sent as `page_token` to retrieve the next page + of results. If this field is omitted, there are no more results. + type: string + unreachable: + description: Locations that could not be reached. + type: array + items: + type: string + Cluster: + id: Cluster + description: An Apache Kafka cluster deployed in a location. + type: object + properties: + gcpConfig: + description: >- + Required. Configuration properties for a Kafka cluster deployed to + Google Cloud Platform. + $ref: '#/components/schemas/GcpConfig' + name: + description: >- + Identifier. The name of the cluster. Structured like: + projects/{project_number}/locations/{location}/clusters/{cluster_id} + type: string + createTime: + description: Output only. The time when the cluster was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. The time when the cluster was last updated. + readOnly: true + type: string + format: google-datetime + labels: + description: Optional. Labels as key value pairs. + type: object + additionalProperties: + type: string + capacityConfig: + description: Required. Capacity configuration for the Kafka cluster. + $ref: '#/components/schemas/CapacityConfig' + rebalanceConfig: + description: Optional. Rebalance configuration for the Kafka cluster. + $ref: '#/components/schemas/RebalanceConfig' + state: + description: Output only. The current state of the cluster. + readOnly: true + type: string + enumDescriptions: + - A state was not specified. + - The cluster is being created. + - The cluster is active. + - The cluster is being deleted. + enum: + - STATE_UNSPECIFIED + - CREATING + - ACTIVE + - DELETING + satisfiesPzi: + description: Output only. Reserved for future use. + readOnly: true + type: boolean + satisfiesPzs: + description: Output only. Reserved for future use. + readOnly: true + type: boolean + tlsConfig: + description: Optional. TLS configuration for the Kafka cluster. + $ref: '#/components/schemas/TlsConfig' + GcpConfig: + id: GcpConfig + description: >- + Configuration properties for a Kafka cluster deployed to Google Cloud + Platform. + type: object + properties: + accessConfig: + description: Required. Access configuration for the Kafka cluster. + $ref: '#/components/schemas/AccessConfig' + kmsKey: + description: >- + Optional. Immutable. The Cloud KMS Key name to use for encryption. + The key must be located in the same region as the cluster and cannot + be changed. Structured like: + projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}. + type: string + AccessConfig: + id: AccessConfig + description: The configuration of access to the Kafka cluster. + type: object + properties: + networkConfigs: + description: >- + Required. Virtual Private Cloud (VPC) networks that must be granted + direct access to the Kafka cluster. Minimum of 1 network is + required. Maximum 10 networks can be specified. + type: array + items: + $ref: '#/components/schemas/NetworkConfig' + NetworkConfig: + id: NetworkConfig + description: >- + The configuration of a Virtual Private Cloud (VPC) network that can + access the Kafka cluster. + type: object + properties: + subnet: + description: >- + Required. Name of the VPC subnet in which to create Private Service + Connect (PSC) endpoints for the Kafka brokers and bootstrap address. + Structured like: + projects/{project}/regions/{region}/subnetworks/{subnet_id} The + subnet must be located in the same region as the Kafka cluster. The + project may differ. Multiple subnets from the same parent network + must not be specified. + type: string + CapacityConfig: + id: CapacityConfig + description: A capacity configuration of a Kafka cluster. + type: object + properties: + vcpuCount: + description: >- + Required. The number of vCPUs to provision for the cluster. Minimum: + 3. + type: string + format: int64 + memoryBytes: + description: >- + Required. The memory to provision for the cluster in bytes. The + CPU:memory ratio (vCPU:GiB) must be between 1:1 and 1:8. Minimum: + 3221225472 (3 GiB). + type: string + format: int64 + RebalanceConfig: + id: RebalanceConfig + description: Defines rebalancing behavior of a Kafka cluster. + type: object + properties: + mode: + description: >- + Optional. The rebalance behavior for the cluster. When not + specified, defaults to `NO_REBALANCE`. + type: string + enumDescriptions: + - A mode was not specified. Do not use. + - Do not rebalance automatically. + - >- + Automatically rebalance topic partitions among brokers when the + cluster is scaled up. + enum: + - MODE_UNSPECIFIED + - NO_REBALANCE + - AUTO_REBALANCE_ON_SCALE_UP + TlsConfig: + id: TlsConfig + description: The TLS configuration for the Kafka cluster. + type: object + properties: + trustConfig: + description: >- + Optional. The configuration of the broker truststore. If specified, + clients can use mTLS for authentication. + $ref: '#/components/schemas/TrustConfig' + sslPrincipalMappingRules: + description: >- + Optional. A list of rules for mapping from SSL principal names to + short names. These are applied in order by Kafka. Refer to the + Apache Kafka documentation for `ssl.principal.mapping.rules` for the + precise formatting details and syntax. Example: + "RULE:^CN=(.*?),OU=ServiceUsers.*$/$1@example.com/,DEFAULT" This is + a static Kafka broker configuration. Setting or modifying this field + will trigger a rolling restart of the Kafka brokers to apply the + change. An empty string means no rules are applied (Kafka default). + type: string + TrustConfig: + id: TrustConfig + description: Sources of CA certificates to install in the broker's truststore. + type: object + properties: + casConfigs: + description: >- + Optional. Configuration for the Google Certificate Authority + Service. Maximum 10. + type: array + items: + $ref: '#/components/schemas/CertificateAuthorityServiceConfig' + CertificateAuthorityServiceConfig: + id: CertificateAuthorityServiceConfig + description: A configuration for the Google Certificate Authority Service. + type: object + properties: + caPool: + description: >- + Required. The name of the CA pool to pull CA certificates from. + Structured like: + projects/{project}/locations/{location}/caPools/{ca_pool}. The CA + pool does not need to be in the same project or location as the + Kafka cluster. + type: string + ListTopicsResponse: + id: ListTopicsResponse + description: Response for ListTopics. + type: object + properties: + topics: + description: >- + The list of topics in the requested parent. The order of the topics + is unspecified. + type: array + items: + $ref: '#/components/schemas/Topic' + nextPageToken: + description: >- + A token that can be sent as `page_token` to retrieve the next page + of results. If this field is omitted, there are no more results. + type: string + Topic: + id: Topic + description: A Kafka topic in a given cluster. + type: object + properties: + name: + description: >- + Identifier. The name of the topic. The `topic` segment is used when + connecting directly to the cluster. Structured like: + projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic} + type: string + partitionCount: + description: >- + Required. The number of partitions this topic has. The partition + count can only be increased, not decreased. Please note that if + partitions are increased for a topic that has a key, the + partitioning logic or the ordering of the messages will be affected. + type: integer + format: int32 + replicationFactor: + description: >- + Required. Immutable. The number of replicas of each partition. A + replication factor of 3 is recommended for high availability. + type: integer + format: int32 + configs: + description: >- + Optional. Configurations for the topic that are overridden from the + cluster defaults. The key of the map is a Kafka topic property name, + for example: `cleanup.policy`, `compression.type`. + type: object + additionalProperties: + type: string + ListConsumerGroupsResponse: + id: ListConsumerGroupsResponse + description: Response for ListConsumerGroups. + type: object + properties: + consumerGroups: + description: >- + The list of consumer group in the requested parent. The order of the + consumer groups is unspecified. + type: array + items: + $ref: '#/components/schemas/ConsumerGroup' + nextPageToken: + description: >- + A token that can be sent as `page_token` to retrieve the next page + of results. If this field is omitted, there are no more results. + type: string + ConsumerGroup: + id: ConsumerGroup + description: A Kafka consumer group in a given cluster. + type: object + properties: + name: + description: >- + Identifier. The name of the consumer group. The `consumer_group` + segment is used when connecting directly to the cluster. Structured + like: + projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumer_group} + type: string + topics: + description: >- + Optional. Metadata for this consumer group for all topics it has + metadata for. The key of the map is a topic name, structured like: + projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic} + type: object + additionalProperties: + $ref: '#/components/schemas/ConsumerTopicMetadata' + ConsumerTopicMetadata: + id: ConsumerTopicMetadata + description: Metadata for a consumer group corresponding to a specific topic. + type: object + properties: + partitions: + description: >- + Optional. Metadata for this consumer group and topic for all + partition indexes it has metadata for. + type: object + additionalProperties: + $ref: '#/components/schemas/ConsumerPartitionMetadata' + ConsumerPartitionMetadata: + id: ConsumerPartitionMetadata + description: Metadata for a consumer group corresponding to a specific partition. + type: object + properties: + offset: + description: >- + Required. The current offset for this partition, or 0 if no offset + has been committed. + type: string + format: int64 + metadata: + description: >- + Optional. The associated metadata for this partition, or empty if it + does not exist. + type: string + ListAclsResponse: + id: ListAclsResponse + description: Response for ListAcls. + type: object + properties: + acls: + description: >- + The list of acls in the requested parent. The order of the acls is + unspecified. + type: array + items: + $ref: '#/components/schemas/Acl' + nextPageToken: + description: >- + A token that can be sent as `page_token` to retrieve the next page + of results. If this field is omitted, there are no more results. + type: string + Acl: + id: Acl + description: >- + Represents the set of ACLs for a given Kafka Resource Pattern, which + consists of resource_type, resource_name and pattern_type. + type: object + properties: + name: + description: >- + Identifier. The name for the acl. Represents a single Resource + Pattern. Structured like: + projects/{project}/locations/{location}/clusters/{cluster}/acls/{acl_id} + The structure of `acl_id` defines the Resource Pattern + (resource_type, resource_name, pattern_type) of the acl. `acl_id` is + structured like one of the following: For acls on the cluster: + `cluster` For acls on a single resource within the cluster: + `topic/{resource_name}` `consumerGroup/{resource_name}` + `transactionalId/{resource_name}` For acls on all resources that + match a prefix: `topicPrefixed/{resource_name}` + `consumerGroupPrefixed/{resource_name}` + `transactionalIdPrefixed/{resource_name}` For acls on all resources + of a given type (i.e. the wildcard literal "*"): `allTopics` + (represents `topic/*`) `allConsumerGroups` (represents + `consumerGroup/*`) `allTransactionalIds` (represents + `transactionalId/*`) + type: string + aclEntries: + description: >- + Required. The ACL entries that apply to the resource pattern. The + maximum number of allowed entries 100. + type: array + items: + $ref: '#/components/schemas/AclEntry' + etag: + description: >- + Optional. `etag` is used for concurrency control. An `etag` is + returned in the response to `GetAcl` and `CreateAcl`. Callers are + required to put that etag in the request to `UpdateAcl` to ensure + that their change will be applied to the same version of the acl + that exists in the Kafka Cluster. A terminal 'T' character in the + etag indicates that the AclEntries were truncated; more entries for + the Acl exist on the Kafka Cluster, but can't be returned in the Acl + due to repeated field limits. + type: string + resourceType: + description: >- + Output only. The ACL resource type derived from the name. One of: + CLUSTER, TOPIC, GROUP, TRANSACTIONAL_ID. + readOnly: true + type: string + resourceName: + description: >- + Output only. The ACL resource name derived from the name. For + cluster resource_type, this is always "kafka-cluster". Can be the + wildcard literal "*". + readOnly: true + type: string + patternType: + description: >- + Output only. The ACL pattern type derived from the name. One of: + LITERAL, PREFIXED. + readOnly: true + type: string + AclEntry: + id: AclEntry + description: Represents the access granted for a given Resource Pattern in an ACL. + type: object + properties: + principal: + description: >- + Required. The principal. Specified as Google Cloud account, with the + Kafka StandardAuthorizer prefix "User:". For example: + "User:test-kafka-client@test-project.iam.gserviceaccount.com". Can + be the wildcard "User:*" to refer to all users. + type: string + permissionType: + description: >- + Required. The permission type. Accepted values are (case + insensitive): ALLOW, DENY. + type: string + operation: + description: >- + Required. The operation type. Allowed values are (case insensitive): + ALL, READ, WRITE, CREATE, DELETE, ALTER, DESCRIBE, CLUSTER_ACTION, + DESCRIBE_CONFIGS, ALTER_CONFIGS, and IDEMPOTENT_WRITE. See + https://kafka.apache.org/documentation/#operations_resources_and_protocols + for valid combinations of resource_type and operation for different + Kafka API requests. + type: string + host: + description: >- + Required. The host. Must be set to "*" for Managed Service for + Apache Kafka. + type: string + AddAclEntryResponse: + id: AddAclEntryResponse + description: Response for AddAclEntry. + type: object + properties: + acl: + description: The updated acl. + $ref: '#/components/schemas/Acl' + aclCreated: + description: Whether the acl was created as a result of adding the acl entry. + type: boolean + RemoveAclEntryResponse: + id: RemoveAclEntryResponse + description: Response for RemoveAclEntry. + type: object + properties: + acl: + description: >- + The updated acl. Returned if the removed acl entry was not the last + entry in the acl. + $ref: '#/components/schemas/Acl' + aclDeleted: + description: >- + Returned with value true if the removed acl entry was the last entry + in the acl, resulting in acl deletion. + type: boolean + ListConnectClustersResponse: + id: ListConnectClustersResponse + description: Response for ListConnectClusters. + type: object + properties: + connectClusters: + description: The list of Connect clusters in the requested parent. + type: array + items: + $ref: '#/components/schemas/ConnectCluster' + nextPageToken: + description: >- + A token that can be sent as `page_token` to retrieve the next page + of results. If this field is omitted, there are no more results. + type: string + unreachable: + description: Locations that could not be reached. + type: array + items: + type: string + ConnectCluster: + id: ConnectCluster + description: An Apache Kafka Connect cluster deployed in a location. + type: object + properties: + gcpConfig: + description: >- + Required. Configuration properties for a Kafka Connect cluster + deployed to Google Cloud Platform. + $ref: '#/components/schemas/ConnectGcpConfig' + name: + description: >- + Identifier. The name of the Kafka Connect cluster. Structured like: + projects/{project_number}/locations/{location}/connectClusters/{connect_cluster_id} + type: string + kafkaCluster: + description: >- + Required. Immutable. The name of the Kafka cluster this Kafka + Connect cluster is attached to. Structured like: + projects/{project}/locations/{location}/clusters/{cluster} + type: string + createTime: + description: Output only. The time when the cluster was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. The time when the cluster was last updated. + readOnly: true + type: string + format: google-datetime + labels: + description: Optional. Labels as key value pairs. + type: object + additionalProperties: + type: string + capacityConfig: + description: Required. Capacity configuration for the Kafka Connect cluster. + $ref: '#/components/schemas/CapacityConfig' + state: + description: Output only. The current state of the cluster. + readOnly: true + type: string + enumDescriptions: + - A state was not specified. + - The cluster is being created. + - The cluster is active. + - The cluster is being deleted. + enum: + - STATE_UNSPECIFIED + - CREATING + - ACTIVE + - DELETING + config: + description: >- + Optional. Configurations for the worker that are overridden from the + defaults. The key of the map is a Kafka Connect worker property + name, for example: `exactly.once.source.support`. + type: object + additionalProperties: + type: string + satisfiesPzi: + description: Output only. Reserved for future use. + readOnly: true + type: boolean + satisfiesPzs: + description: Output only. Reserved for future use. + readOnly: true + type: boolean + ConnectGcpConfig: + id: ConnectGcpConfig + description: >- + Configuration properties for a Kafka Connect cluster deployed to Google + Cloud Platform. + type: object + properties: + accessConfig: + description: Required. Access configuration for the Kafka Connect cluster. + $ref: '#/components/schemas/ConnectAccessConfig' + secretPaths: + description: >- + Optional. Secrets to load into workers. Exact SecretVersions from + Secret Manager must be provided -- aliases are not supported. Up to + 32 secrets may be loaded into one cluster. Format: + projects//secrets//versions/ + type: array + items: + type: string + ConnectAccessConfig: + id: ConnectAccessConfig + description: The configuration of access to the Kafka Connect cluster. + type: object + properties: + networkConfigs: + description: >- + Required. Virtual Private Cloud (VPC) networks that must be granted + direct access to the Kafka Connect cluster. Minimum of 1 network is + required. Maximum 10 networks can be specified. + type: array + items: + $ref: '#/components/schemas/ConnectNetworkConfig' + ConnectNetworkConfig: + id: ConnectNetworkConfig + description: >- + The configuration of a Virtual Private Cloud (VPC) network that can + access the Kafka Connect cluster. + type: object + properties: + primarySubnet: + description: >- + Required. VPC subnet to make available to the Kafka Connect cluster. + Structured like: + projects/{project}/regions/{region}/subnetworks/{subnet_id} It is + used to create a Private Service Connect (PSC) interface for the + Kafka Connect workers. It must be located in the same region as the + Kafka Connect cluster. The CIDR range of the subnet must be within + the IPv4 address ranges for private networks, as specified in RFC + 1918. The primary subnet CIDR range must have a minimum size of /22 + (1024 addresses). + type: string + additionalSubnets: + description: >- + Optional. Additional subnets may be specified. They may be in + another region, but must be in the same VPC network. The Connect + workers can communicate with network endpoints in either the primary + or additional subnets. + type: array + items: + type: string + dnsDomainNames: + description: >- + Optional. Additional DNS domain names from the subnet's network to + be made visible to the Connect Cluster. When using MirrorMaker2, + it's necessary to add the bootstrap address's dns domain name of the + target cluster to make it visible to the connector. For example: + my-kafka-cluster.us-central1.managedkafka.my-project.cloud.goog + type: array + items: + type: string + ListConnectorsResponse: + id: ListConnectorsResponse + description: Response for ListConnectors. + type: object + properties: + connectors: + description: The list of connectors in the requested parent. + type: array + items: + $ref: '#/components/schemas/Connector' + nextPageToken: + description: >- + A token that can be sent as `page_token` to retrieve the next page + of results. If this field is omitted, there are no more results. + type: string + Connector: + id: Connector + description: A Kafka Connect connector in a given ConnectCluster. + type: object + properties: + taskRestartPolicy: + description: Optional. Restarts the individual tasks of a Connector. + $ref: '#/components/schemas/TaskRetryPolicy' + name: + description: >- + Identifier. The name of the connector. Structured like: + projects/{project}/locations/{location}/connectClusters/{connect_cluster}/connectors/{connector} + type: string + configs: + description: >- + Optional. Connector config as keys/values. The keys of the map are + connector property names, for example: `connector.class`, + `tasks.max`, `key.converter`. + type: object + additionalProperties: + type: string + state: + description: Output only. The current state of the connector. + readOnly: true + type: string + enumDescriptions: + - A state was not specified. + - The connector is not assigned to any tasks, usually transient. + - The connector is running. + - The connector has been paused. + - The connector has failed. See logs for why. + - The connector is restarting. + - The connector has been stopped. + enum: + - STATE_UNSPECIFIED + - UNASSIGNED + - RUNNING + - PAUSED + - FAILED + - RESTARTING + - STOPPED + TaskRetryPolicy: + id: TaskRetryPolicy + description: >- + Task Retry Policy is implemented on a best-effort basis. Retry delay + will be exponential based on provided minimum and maximum backoffs. + https://en.wikipedia.org/wiki/Exponential_backoff. Note that the delay + between consecutive task restarts may not always precisely match the + configured settings. This can happen when the ConnectCluster is in + rebalancing state or if the ConnectCluster is unresponsive etc. The + default values for minimum and maximum backoffs are 60 seconds and 30 + minutes respectively. + type: object + properties: + minimumBackoff: + description: >- + Optional. The minimum amount of time to wait before retrying a + failed task. This sets a lower bound for the backoff delay. + type: string + format: google-duration + maximumBackoff: + description: >- + Optional. The maximum amount of time to wait before retrying a + failed task. This sets an upper bound for the backoff delay. + type: string + format: google-duration + PauseConnectorRequest: + id: PauseConnectorRequest + description: Request for PauseConnector. + type: object + properties: {} + PauseConnectorResponse: + id: PauseConnectorResponse + description: Response for PauseConnector. + type: object + properties: {} + ResumeConnectorRequest: + id: ResumeConnectorRequest + description: Request for ResumeConnector. + type: object + properties: {} + ResumeConnectorResponse: + id: ResumeConnectorResponse + description: Response for ResumeConnector. + type: object + properties: {} + RestartConnectorRequest: + id: RestartConnectorRequest + description: Request for RestartConnector. + type: object + properties: {} + RestartConnectorResponse: + id: RestartConnectorResponse + description: Response for RestartConnector. + type: object + properties: {} + StopConnectorRequest: + id: StopConnectorRequest + description: Request for StopConnector. + type: object + properties: {} + StopConnectorResponse: + id: StopConnectorResponse + description: Response for StopConnector. + type: object + properties: {} + ListLocationsResponse: + id: ListLocationsResponse + description: The response message for Locations.ListLocations. + type: object + properties: + locations: + description: >- + A list of locations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/Location' + nextPageToken: + description: The standard List next-page token. + type: string + Location: + id: Location + description: A resource that represents a Google Cloud location. + type: object + properties: + name: + description: >- + Resource name for the location, which may vary between + implementations. For example: + `"projects/example-project/locations/us-east1"` + type: string + locationId: + description: 'The canonical id for this location. For example: `"us-east1"`.' + type: string + displayName: + description: >- + The friendly name for this location, typically a nearby city name. + For example, "Tokyo". + type: string + labels: + description: >- + Cross-service attributes for the location. For example + {"cloud.googleapis.com/region": "us-east1"} + type: object + additionalProperties: + type: string + metadata: + description: >- + Service-specific metadata. For example the available capacity at the + given location. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + SchemaRegistry: + id: SchemaRegistry + description: SchemaRegistry is a schema registry instance. + type: object + properties: + name: + description: >- + Identifier. The name of the schema registry instance. Structured + like: + `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}` + The instance name {schema_registry} can contain the following: * Up + to 255 characters. * Letters (uppercase or lowercase), numbers, and + underscores. + type: string + contexts: + description: Output only. The contexts of the schema registry instance. + readOnly: true + type: array + items: + type: string + ListSchemaRegistriesResponse: + id: ListSchemaRegistriesResponse + description: Request for ListSchemaRegistries. + type: object + properties: + schemaRegistries: + description: The schema registry instances. + type: array + items: + $ref: '#/components/schemas/SchemaRegistry' + CreateSchemaRegistryRequest: + id: CreateSchemaRegistryRequest + description: Request to create a schema registry instance. + type: object + properties: + schemaRegistryId: + description: >- + Required. The schema registry instance ID to use for this schema + registry. The ID must contain only letters (a-z, A-Z), numbers + (0-9), and underscores (-). The maximum length is 63 characters. The + ID must not start with a number. + type: string + schemaRegistry: + description: >- + Required. The schema registry instance to create. The name field is + ignored. + $ref: '#/components/schemas/SchemaRegistry' + Context: + id: Context + description: >- + Context represents an independent schema grouping in a schema registry + instance. + type: object + properties: + name: + description: >- + Identifier. The name of the context. Structured like: + `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}` + The context name {context} can contain the following: * Up to 255 + characters. * Allowed characters: letters (uppercase or lowercase), + numbers, and the following special characters: `.`, `-`, `_`, `+`, + `%`, and `~`. + type: string + subjects: + description: Optional. The subjects of the context. + type: array + items: + type: string + HttpBody: + id: HttpBody + description: >- + Message that represents an arbitrary HTTP body. It should only be used + for payload formats that can't be represented as JSON, such as raw + binary or an HTML page. This message can be used both in streaming and + non-streaming API methods in the request as well as the response. It can + be used as a top-level request field, which is convenient if one wants + to extract parameters from either the URL or HTTP template into the + request fields and also want access to the raw HTTP body. Example: + message GetResourceRequest { // A unique request id. string request_id = + 1; // The raw HTTP body is bound to this field. google.api.HttpBody + http_body = 2; } service ResourceService { rpc + GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc + UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } + Example with streaming methods: service CaldavService { rpc + GetCalendar(stream google.api.HttpBody) returns (stream + google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) + returns (stream google.api.HttpBody); } Use of this type only changes + how the request and response bodies are handled, all other features will + continue to work unchanged. + type: object + properties: + contentType: + description: >- + The HTTP Content-Type header value specifying the content type of + the body. + type: string + data: + description: The HTTP request/response body as raw binary. + type: string + format: byte + extensions: + description: >- + Application specific response metadata. Must be set in the first + response for streaming APIs. + type: array + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + Schema: + id: Schema + description: Schema for a Kafka message. + type: object + properties: + schemaType: + description: Optional. The schema type of the schema. + type: string + enumDescriptions: + - No schema type. The default will be AVRO. + - Avro schema type. + - JSON schema type. + - Protobuf schema type. + enum: + - SCHEMA_TYPE_UNSPECIFIED + - AVRO + - JSON + - PROTOBUF + schema: + description: The schema payload. + type: string + references: + description: Optional. The schema references used by the schema. + type: array + items: + $ref: '#/components/schemas/SchemaReference' + SchemaReference: + id: SchemaReference + description: SchemaReference is a reference to a schema. + type: object + properties: + name: + description: Required. The name of the reference. + type: string + subject: + description: Required. The subject of the reference. + type: string + version: + description: Required. The version of the reference. + type: integer + format: int32 + LookupVersionRequest: + id: LookupVersionRequest + description: Request for LookupVersion. + type: object + properties: + schemaType: + description: Optional. The schema type of the schema. + type: string + enumDescriptions: + - No schema type. The default will be AVRO. + - Avro schema type. + - JSON schema type. + - Protobuf schema type. + enum: + - SCHEMA_TYPE_UNSPECIFIED + - AVRO + - JSON + - PROTOBUF + schema: + description: Required. The schema payload + type: string + references: + description: Optional. The schema references used by the schema. + type: array + items: + $ref: '#/components/schemas/SchemaReference' + normalize: + description: >- + Optional. If true, the schema will be normalized before being looked + up. The default is false. + type: boolean + deleted: + description: >- + Optional. If true, soft-deleted versions will be included in lookup, + no matter if the subject is active or soft-deleted. If false, + soft-deleted versions will be excluded. The default is false. + type: boolean + SchemaVersion: + id: SchemaVersion + description: Version of a schema. + type: object + properties: + subject: + description: Required. The subject of the version. + type: string + version: + description: Required. The version ID + type: integer + format: int32 + id: + description: Required. The schema ID. + type: integer + format: int32 + schemaType: + description: Optional. The schema type of the schema. + type: string + enumDescriptions: + - No schema type. The default will be AVRO. + - Avro schema type. + - JSON schema type. + - Protobuf schema type. + enum: + - SCHEMA_TYPE_UNSPECIFIED + - AVRO + - JSON + - PROTOBUF + schema: + description: Required. The schema payload. + type: string + references: + description: Optional. The schema references used by the schema. + type: array + items: + $ref: '#/components/schemas/SchemaReference' + CreateVersionRequest: + id: CreateVersionRequest + description: Request for CreateVersion. + type: object + properties: + version: + description: >- + Optional. The version to create. It is optional. If not specified, + the version will be created with the max version ID of the subject + increased by 1. If the version ID is specified, it will be used as + the new version ID and must not be used by an existing version of + the subject. + type: integer + format: int32 + id: + description: >- + Optional. The schema ID of the schema. If not specified, the schema + ID will be generated by the server. If the schema ID is specified, + it must not be used by an existing schema that is different from the + schema to be created. + type: integer + format: int32 + schemaType: + description: >- + Optional. The type of the schema. It is optional. If not specified, + the schema type will be AVRO. + type: string + enumDescriptions: + - No schema type. The default will be AVRO. + - Avro schema type. + - JSON schema type. + - Protobuf schema type. + enum: + - SCHEMA_TYPE_UNSPECIFIED + - AVRO + - JSON + - PROTOBUF + schema: + description: Required. The schema payload + type: string + references: + description: Optional. The schema references used by the schema. + type: array + items: + $ref: '#/components/schemas/SchemaReference' + normalize: + description: >- + Optional. If true, the schema will be normalized before being + stored. The default is false. + type: boolean + CreateVersionResponse: + id: CreateVersionResponse + description: Response for CreateVersion. + type: object + properties: + id: + description: The unique identifier of the schema created. + type: integer + format: int32 + CheckCompatibilityRequest: + id: CheckCompatibilityRequest + description: Request for CheckCompatibility. + type: object + properties: + schemaType: + description: Optional. The schema type of the schema. + type: string + enumDescriptions: + - No schema type. The default will be AVRO. + - Avro schema type. + - JSON schema type. + - Protobuf schema type. + enum: + - SCHEMA_TYPE_UNSPECIFIED + - AVRO + - JSON + - PROTOBUF + schema: + description: Required. The schema payload + type: string + references: + description: Optional. The schema references used by the schema. + type: array + items: + $ref: '#/components/schemas/SchemaReference' + verbose: + description: >- + Optional. If true, the response will contain the compatibility check + result with reasons for failed checks. The default is false. + type: boolean + CheckCompatibilityResponse: + id: CheckCompatibilityResponse + description: Response for CheckCompatibility. + type: object + properties: + is_compatible: + description: >- + The compatibility check result. If true, the schema is compatible + with the resource. + type: boolean + messages: + description: Failure reasons if verbose = true. + type: array + items: + type: string + SchemaConfig: + id: SchemaConfig + description: >- + SchemaConfig represents configuration for a schema registry or a + specific subject. + type: object + properties: + compatibility: + description: >- + Required. The compatibility type of the schema. The default value is + BACKWARD. If unset in a SchemaSubject-level SchemaConfig, defaults + to the global value. If unset in a SchemaRegistry-level + SchemaConfig, reverts to the default value. + type: string + enumDescriptions: + - No compatibility check. + - Backwards compatible with the most recent version. + - Backwards compatible with all previous versions. + - Forwards compatible with the most recent version. + - Forwards compatible with all previous versions. + - Backwards and forwards compatible with the most recent version. + - Backwards and forwards compatible with all previous versions. + enum: + - NONE + - BACKWARD + - BACKWARD_TRANSITIVE + - FORWARD + - FORWARD_TRANSITIVE + - FULL + - FULL_TRANSITIVE + normalize: + description: >- + Optional. If true, the schema will be normalized before being stored + or looked up. The default is false. If unset in a + SchemaSubject-level SchemaConfig, the global value will be used. If + unset in a SchemaRegistry-level SchemaConfig, reverts to the default + value. + type: boolean + alias: + description: >- + Optional. The subject to which this subject is an alias of. Only + applicable for subject config. + type: string + UpdateSchemaConfigRequest: + id: UpdateSchemaConfigRequest + description: >- + Request for updating schema config. On a SchemaSubject-level + SchemaConfig, an unset field will be removed from the SchemaConfig. + type: object + properties: + compatibility: + description: >- + Required. The compatibility type of the schemas. Cannot be unset for + a SchemaRegistry-level SchemaConfig. If unset on a + SchemaSubject-level SchemaConfig, removes the compatibility field + for the SchemaConfig. + type: string + enumDescriptions: + - No compatibility check. + - Backwards compatible with the most recent version. + - Backwards compatible with all previous versions. + - Forwards compatible with the most recent version. + - Forwards compatible with all previous versions. + - Backwards and forwards compatible with the most recent version. + - Backwards and forwards compatible with all previous versions. + enum: + - NONE + - BACKWARD + - BACKWARD_TRANSITIVE + - FORWARD + - FORWARD_TRANSITIVE + - FULL + - FULL_TRANSITIVE + normalize: + description: >- + Optional. If true, the schema will be normalized before being stored + or looked up. The default is false. Cannot be unset for a + SchemaRegistry-level SchemaConfig. If unset on a SchemaSubject-level + SchemaConfig, removes the normalize field for the SchemaConfig. + type: boolean + SchemaMode: + id: SchemaMode + description: >- + SchemaMode represents the mode of a schema registry or a specific + subject. Four modes are supported: * NONE: deprecated. This was the + default mode for a subject, but now the default is unset (which means + use the global schema registry setting) * READONLY: The schema registry + is in read-only mode. * READWRITE: The schema registry is in read-write + mode, which allows limited write operations on the schema. * IMPORT: The + schema registry is in import mode, which allows more editing operations + on the schema for data importing purposes. + type: object + properties: + mode: + description: >- + Required. The mode type of a schema registry (READWRITE by default) + or of a subject (unset by default, which means use the global schema + registry setting). + type: string + enumDescriptions: + - >- + The default / unset value. The subject mode is NONE/unset by + default, which means use the global schema registry mode. This + should not be used for setting the mode. + - READONLY mode. + - READWRITE mode. + - IMPORT mode. + enum: + - NONE + - READONLY + - READWRITE + - IMPORT + UpdateSchemaModeRequest: + id: UpdateSchemaModeRequest + description: Request for updating schema registry or subject mode. + type: object + properties: + mode: + description: Required. The mode type. + type: string + enumDescriptions: + - >- + The default / unset value. The subject mode is NONE/unset by + default, which means use the global schema registry mode. This + should not be used for setting the mode. + - READONLY mode. + - READWRITE mode. + - IMPORT mode. + enum: + - NONE + - READONLY + - READWRITE + - IMPORT + OperationMetadata: + id: OperationMetadata + description: Represents the metadata of the long-running operation. + type: object + properties: + createTime: + description: Output only. The time the operation was created. + readOnly: true + type: string + format: google-datetime + endTime: + description: Output only. The time the operation finished running. + readOnly: true + type: string + format: google-datetime + target: + description: >- + Output only. Server-defined resource path for the target of the + operation. + readOnly: true + type: string + verb: + description: Output only. Name of the verb executed by the operation. + readOnly: true + type: string + statusMessage: + description: Output only. Human-readable status of the operation, if any. + readOnly: true + type: string + requestedCancellation: + description: >- + Output only. Identifies whether the user has requested cancellation + of the operation. Operations that have been cancelled successfully + have Operation.error value with a google.rpc.Status.code of 1, + corresponding to `Code.CANCELLED`. + readOnly: true + type: boolean + apiVersion: + description: Output only. API version used to start the operation. + readOnly: true + type: string + parameters: + 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: + type: string + enum: + - json + - media + - proto + 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 + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + x-stackQL-resources: + locations: + id: google.managedkafka.locations + name: locations + title: Locations + methods: + list: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.locations + get: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + operations: + id: google.managedkafka.operations + name: operations + title: Operations + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.operations + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + cancel: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' + insert: [] + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/operations/methods/delete' + clusters: + id: google.managedkafka.clusters + name: clusters + title: Clusters + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clusters/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.clusters + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clusters/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clusters~1{clustersId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clusters~1{clustersId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clusters~1{clustersId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/clusters/methods/get' + - $ref: '#/components/x-stackQL-resources/clusters/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/clusters/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/clusters/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/clusters/methods/delete' + topics: + id: google.managedkafka.topics + name: topics + title: Topics + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clusters~1{clustersId}~1topics/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.topics + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clusters~1{clustersId}~1topics/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clusters~1{clustersId}~1topics~1{topicsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clusters~1{clustersId}~1topics~1{topicsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clusters~1{clustersId}~1topics~1{topicsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/topics/methods/get' + - $ref: '#/components/x-stackQL-resources/topics/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/topics/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/topics/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/topics/methods/delete' + consumer_groups: + id: google.managedkafka.consumer_groups + name: consumer_groups + title: Consumer_groups + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clusters~1{clustersId}~1consumerGroups/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.consumerGroups + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clusters~1{clustersId}~1consumerGroups~1{consumerGroupsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clusters~1{clustersId}~1consumerGroups~1{consumerGroupsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clusters~1{clustersId}~1consumerGroups~1{consumerGroupsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/consumer_groups/methods/get' + - $ref: '#/components/x-stackQL-resources/consumer_groups/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/consumer_groups/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/consumer_groups/methods/delete' + acls: + id: google.managedkafka.acls + name: acls + title: Acls + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clusters~1{clustersId}~1acls/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.acls + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clusters~1{clustersId}~1acls/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clusters~1{clustersId}~1acls~1{aclsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clusters~1{clustersId}~1acls~1{aclsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clusters~1{clustersId}~1acls~1{aclsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/acls/methods/get' + - $ref: '#/components/x-stackQL-resources/acls/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/acls/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/acls/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/acls/methods/delete' + acls_acl_entry: + id: google.managedkafka.acls_acl_entry + name: acls_acl_entry + title: Acls_acl_entry + methods: + add_acl_entry: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clusters~1{clustersId}~1acls~1{aclsId}:addAclEntry/post + response: + mediaType: application/json + openAPIDocKey: '200' + remove_acl_entry: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clusters~1{clustersId}~1acls~1{aclsId}:removeAclEntry/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/acls_acl_entry/methods/add_acl_entry + update: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/acls_acl_entry/methods/remove_acl_entry + connect_clusters: + id: google.managedkafka.connect_clusters + name: connect_clusters + title: Connect_clusters + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connectClusters/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.connectClusters + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connectClusters/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connectClusters~1{connectClustersId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connectClusters~1{connectClustersId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connectClusters~1{connectClustersId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/connect_clusters/methods/get' + - $ref: '#/components/x-stackQL-resources/connect_clusters/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/connect_clusters/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/connect_clusters/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/connect_clusters/methods/delete' + connectors: + id: google.managedkafka.connectors + name: connectors + title: Connectors + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connectClusters~1{connectClustersId}~1connectors/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.connectors + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connectClusters~1{connectClustersId}~1connectors/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connectClusters~1{connectClustersId}~1connectors~1{connectorsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connectClusters~1{connectClustersId}~1connectors~1{connectorsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connectClusters~1{connectClustersId}~1connectors~1{connectorsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + pause: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connectClusters~1{connectClustersId}~1connectors~1{connectorsId}:pause/post + response: + mediaType: application/json + openAPIDocKey: '200' + resume: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connectClusters~1{connectClustersId}~1connectors~1{connectorsId}:resume/post + response: + mediaType: application/json + openAPIDocKey: '200' + restart: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connectClusters~1{connectClustersId}~1connectors~1{connectorsId}:restart/post + response: + mediaType: application/json + openAPIDocKey: '200' + stop: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connectClusters~1{connectClustersId}~1connectors~1{connectorsId}:stop/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/connectors/methods/get' + - $ref: '#/components/x-stackQL-resources/connectors/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/connectors/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/connectors/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/connectors/methods/delete' + schema_registries: + id: google.managedkafka.schema_registries + name: schema_registries + title: Schema_registries + methods: + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schemaRegistries~1{schemaRegistriesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schemaRegistries~1{schemaRegistriesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schemaRegistries/get + response: + mediaType: application/json + openAPIDocKey: '200' + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schemaRegistries/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/schema_registries/methods/get' + - $ref: '#/components/x-stackQL-resources/schema_registries/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/schema_registries/methods/create' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/schema_registries/methods/delete' + contexts: + id: google.managedkafka.contexts + name: contexts + title: Contexts + methods: + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schemaRegistries~1{schemaRegistriesId}~1contexts~1{contextsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schemaRegistries~1{schemaRegistriesId}~1contexts/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/contexts/methods/get' + - $ref: '#/components/x-stackQL-resources/contexts/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + schemas: + id: google.managedkafka.schemas + name: schemas + title: Schemas + methods: + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schemaRegistries~1{schemaRegistriesId}~1schemas~1{schemasId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/schemas/methods/get' + insert: [] + update: [] + replace: [] + delete: [] + schemas_schema: + id: google.managedkafka.schemas_schema + name: schemas_schema + title: Schemas_schema + methods: + get_schema: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schemaRegistries~1{schemaRegistriesId}~1schemas~1{schemasId}~1schema/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/schemas_schema/methods/get_schema' + insert: [] + update: [] + replace: [] + delete: [] + versions: + id: google.managedkafka.versions + name: versions + title: Versions + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schemaRegistries~1{schemaRegistriesId}~1subjects~1{subjectsId}~1versions/get + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schemaRegistries~1{schemaRegistriesId}~1subjects~1{subjectsId}~1versions~1{versionsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schemaRegistries~1{schemaRegistriesId}~1subjects~1{subjectsId}~1versions~1{versionsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schemaRegistries~1{schemaRegistriesId}~1subjects~1{subjectsId}~1versions/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/versions/methods/get' + - $ref: '#/components/x-stackQL-resources/versions/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/versions/methods/create' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/versions/methods/delete' + types: + id: google.managedkafka.types + name: types + title: Types + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schemaRegistries~1{schemaRegistriesId}~1schemas~1types/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/types/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + subjects: + id: google.managedkafka.subjects + name: subjects + title: Subjects + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schemaRegistries~1{schemaRegistriesId}~1subjects/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schemaRegistries~1{schemaRegistriesId}~1subjects~1{subjectsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + lookup_version: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schemaRegistries~1{schemaRegistriesId}~1subjects~1{subjectsId}/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/subjects/methods/list' + insert: [] + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/subjects/methods/delete' + versions_schema: + id: google.managedkafka.versions_schema + name: versions_schema + title: Versions_schema + methods: + get_schema: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schemaRegistries~1{schemaRegistriesId}~1subjects~1{subjectsId}~1versions~1{versionsId}~1schema/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/versions_schema/methods/get_schema + insert: [] + update: [] + replace: [] + delete: [] + referencedby: + id: google.managedkafka.referencedby + name: referencedby + title: Referencedby + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schemaRegistries~1{schemaRegistriesId}~1subjects~1{subjectsId}~1versions~1{versionsId}~1referencedby/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/referencedby/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + compatibility: + id: google.managedkafka.compatibility + name: compatibility + title: Compatibility + methods: + check_compatibility: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schemaRegistries~1{schemaRegistriesId}~1compatibility~1{compatibilityId}/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + config: + id: google.managedkafka.config + name: config + title: Config + methods: + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schemaRegistries~1{schemaRegistriesId}~1config~1{configId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schemaRegistries~1{schemaRegistriesId}~1config~1{configId}/put + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schemaRegistries~1{schemaRegistriesId}~1config~1{configId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/config/methods/get' + insert: [] + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/config/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/config/methods/delete' + mode: + id: google.managedkafka.mode + name: mode + title: Mode + methods: + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schemaRegistries~1{schemaRegistriesId}~1mode~1{modeId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schemaRegistries~1{schemaRegistriesId}~1mode~1{modeId}/put + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schemaRegistries~1{schemaRegistriesId}~1mode~1{modeId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/mode/methods/get' + insert: [] + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/mode/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/mode/methods/delete' +paths: + /v1/projects/{projectsId}/locations: + parameters: &ref_1 + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' + get: + description: Lists information about the supported locations for this service. + operationId: managedkafka.projects.locations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListLocationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: extraLocationTypes + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}: + parameters: *ref_1 + get: + description: Gets information about a location. + operationId: managedkafka.projects.locations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Location' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: managedkafka.projects.locations.operations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListOperationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: managedkafka.projects.locations.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + delete: + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: managedkafka.projects.locations.operations.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + `1`, corresponding to `Code.CANCELLED`. + operationId: managedkafka.projects.locations.operations.cancel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CancelOperationRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/clusters: + parameters: *ref_1 + get: + description: Lists the clusters in a given project and location. + operationId: managedkafka.projects.locations.clusters.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListClustersResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + post: + description: Creates a new cluster in a given project and location. + operationId: managedkafka.projects.locations.clusters.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Cluster' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: clusterId + schema: + type: string + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}: + parameters: *ref_1 + get: + description: Returns the properties of a single cluster. + operationId: managedkafka.projects.locations.clusters.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Cluster' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + patch: + description: Updates the properties of a single cluster. + operationId: managedkafka.projects.locations.clusters.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Cluster' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: requestId + schema: + type: string + delete: + description: Deletes a single cluster. + operationId: managedkafka.projects.locations.clusters.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/topics: + parameters: *ref_1 + get: + description: Lists the topics in a given cluster. + operationId: managedkafka.projects.locations.clusters.topics.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListTopicsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + post: + description: Creates a new topic in a given project and location. + operationId: managedkafka.projects.locations.clusters.topics.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Topic' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Topic' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + - in: query + name: topicId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/topics/{topicsId}: + parameters: *ref_1 + get: + description: Returns the properties of a single topic. + operationId: managedkafka.projects.locations.clusters.topics.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Topic' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + - in: path + name: topicsId + required: true + schema: + type: string + patch: + description: Updates the properties of a single topic. + operationId: managedkafka.projects.locations.clusters.topics.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Topic' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Topic' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + - in: path + name: topicsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a single topic. + operationId: managedkafka.projects.locations.clusters.topics.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + - in: path + name: topicsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/consumerGroups: + parameters: *ref_1 + get: + description: Lists the consumer groups in a given cluster. + operationId: managedkafka.projects.locations.clusters.consumerGroups.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListConsumerGroupsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/consumerGroups/{consumerGroupsId}: + parameters: *ref_1 + get: + description: Returns the properties of a single consumer group. + operationId: managedkafka.projects.locations.clusters.consumerGroups.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ConsumerGroup' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + - in: path + name: consumerGroupsId + required: true + schema: + type: string + patch: + description: Updates the properties of a single consumer group. + operationId: managedkafka.projects.locations.clusters.consumerGroups.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ConsumerGroup' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ConsumerGroup' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + - in: path + name: consumerGroupsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a single consumer group. + operationId: managedkafka.projects.locations.clusters.consumerGroups.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + - in: path + name: consumerGroupsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/acls: + parameters: *ref_1 + get: + description: Lists the acls in a given cluster. + operationId: managedkafka.projects.locations.clusters.acls.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListAclsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + post: + description: Creates a new acl in the given project, location, and cluster. + operationId: managedkafka.projects.locations.clusters.acls.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Acl' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Acl' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + - in: query + name: aclId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/acls/{aclsId}: + parameters: *ref_1 + get: + description: Returns the properties of a single acl. + operationId: managedkafka.projects.locations.clusters.acls.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Acl' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + - in: path + name: aclsId + required: true + schema: + type: string + patch: + description: Updates the properties of a single acl. + operationId: managedkafka.projects.locations.clusters.acls.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Acl' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Acl' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + - in: path + name: aclsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes an acl. + operationId: managedkafka.projects.locations.clusters.acls.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + - in: path + name: aclsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/acls/{aclsId}:addAclEntry: + parameters: *ref_1 + post: + description: >- + Incremental update: Adds an acl entry to an acl. Creates the acl if it + does not exist yet. + operationId: managedkafka.projects.locations.clusters.acls.addAclEntry + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AclEntry' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/AddAclEntryResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + - in: path + name: aclsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/acls/{aclsId}:removeAclEntry: + parameters: *ref_1 + post: + description: >- + Incremental update: Removes an acl entry from an acl. Deletes the acl if + its acl entries become empty (i.e. if the removed entry was the last one + in the acl). + operationId: managedkafka.projects.locations.clusters.acls.removeAclEntry + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AclEntry' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/RemoveAclEntryResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + - in: path + name: aclsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/connectClusters: + parameters: *ref_1 + get: + description: Lists the Kafka Connect clusters in a given project and location. + operationId: managedkafka.projects.locations.connectClusters.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListConnectClustersResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + post: + description: Creates a new Kafka Connect cluster in a given project and location. + operationId: managedkafka.projects.locations.connectClusters.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ConnectCluster' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: connectClusterId + schema: + type: string + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/connectClusters/{connectClustersId}: + parameters: *ref_1 + get: + description: Returns the properties of a single Kafka Connect cluster. + operationId: managedkafka.projects.locations.connectClusters.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ConnectCluster' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: connectClustersId + required: true + schema: + type: string + patch: + description: Updates the properties of a single Kafka Connect cluster. + operationId: managedkafka.projects.locations.connectClusters.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ConnectCluster' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: connectClustersId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: requestId + schema: + type: string + delete: + description: Deletes a single Connect cluster. + operationId: managedkafka.projects.locations.connectClusters.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: connectClustersId + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/connectClusters/{connectClustersId}/connectors: + parameters: *ref_1 + get: + description: Lists the connectors in a given Connect cluster. + operationId: managedkafka.projects.locations.connectClusters.connectors.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListConnectorsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: connectClustersId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + post: + description: Creates a new connector in a given Connect cluster. + operationId: managedkafka.projects.locations.connectClusters.connectors.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Connector' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Connector' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: connectClustersId + required: true + schema: + type: string + - in: query + name: connectorId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/connectClusters/{connectClustersId}/connectors/{connectorsId}: + parameters: *ref_1 + get: + description: Returns the properties of a single connector. + operationId: managedkafka.projects.locations.connectClusters.connectors.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Connector' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: connectClustersId + required: true + schema: + type: string + - in: path + name: connectorsId + required: true + schema: + type: string + patch: + description: Updates the properties of a connector. + operationId: managedkafka.projects.locations.connectClusters.connectors.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Connector' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Connector' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: connectClustersId + required: true + schema: + type: string + - in: path + name: connectorsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a connector. + operationId: managedkafka.projects.locations.connectClusters.connectors.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: connectClustersId + required: true + schema: + type: string + - in: path + name: connectorsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/connectClusters/{connectClustersId}/connectors/{connectorsId}:pause: + parameters: *ref_1 + post: + description: Pauses the connector and its tasks. + operationId: managedkafka.projects.locations.connectClusters.connectors.pause + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PauseConnectorRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/PauseConnectorResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: connectClustersId + required: true + schema: + type: string + - in: path + name: connectorsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/connectClusters/{connectClustersId}/connectors/{connectorsId}:resume: + parameters: *ref_1 + post: + description: Resumes the connector and its tasks. + operationId: managedkafka.projects.locations.connectClusters.connectors.resume + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ResumeConnectorRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ResumeConnectorResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: connectClustersId + required: true + schema: + type: string + - in: path + name: connectorsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/connectClusters/{connectClustersId}/connectors/{connectorsId}:restart: + parameters: *ref_1 + post: + description: Restarts the connector. + operationId: managedkafka.projects.locations.connectClusters.connectors.restart + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RestartConnectorRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/RestartConnectorResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: connectClustersId + required: true + schema: + type: string + - in: path + name: connectorsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/connectClusters/{connectClustersId}/connectors/{connectorsId}:stop: + parameters: *ref_1 + post: + description: Stops the connector. + operationId: managedkafka.projects.locations.connectClusters.connectors.stop + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StopConnectorRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/StopConnectorResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: connectClustersId + required: true + schema: + type: string + - in: path + name: connectorsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}: + parameters: *ref_1 + get: + description: Get the schema registry instance. + operationId: managedkafka.projects.locations.schemaRegistries.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SchemaRegistry' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: schemaRegistriesId + required: true + schema: + type: string + delete: + description: Delete a schema registry instance. + operationId: managedkafka.projects.locations.schemaRegistries.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: schemaRegistriesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries: + parameters: *ref_1 + get: + description: List schema registries. + operationId: managedkafka.projects.locations.schemaRegistries.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListSchemaRegistriesResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: view + schema: + type: string + post: + description: Create a schema registry instance. + operationId: managedkafka.projects.locations.schemaRegistries.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateSchemaRegistryRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SchemaRegistry' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}: + parameters: *ref_1 + get: + description: Get the context. + operationId: managedkafka.projects.locations.schemaRegistries.contexts.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Context' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: schemaRegistriesId + required: true + schema: + type: string + - in: path + name: contextsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts: + parameters: *ref_1 + get: + description: List contexts for a schema registry. + operationId: managedkafka.projects.locations.schemaRegistries.contexts.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/HttpBody' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: schemaRegistriesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/schemas/{schemasId}: + parameters: *ref_1 + get: + description: Get the schema for the given schema id. + operationId: managedkafka.projects.locations.schemaRegistries.contexts.schemas.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Schema' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: schemaRegistriesId + required: true + schema: + type: string + - in: path + name: contextsId + required: true + schema: + type: string + - in: path + name: schemasId + required: true + schema: + type: string + - in: query + name: subject + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/schemas/{schemasId}/schema: + parameters: *ref_1 + get: + description: >- + Get the schema string for the given schema id. The response will be the + schema string. + operationId: >- + managedkafka.projects.locations.schemaRegistries.contexts.schemas.getSchema + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/HttpBody' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: schemaRegistriesId + required: true + schema: + type: string + - in: path + name: contextsId + required: true + schema: + type: string + - in: path + name: schemasId + required: true + schema: + type: string + - in: query + name: subject + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/schemas/{schemasId}/versions: + parameters: *ref_1 + get: + description: >- + List the schema versions for the given schema id. The response will be + an array of subject-version pairs as: [{"subject":"subject1", + "version":1}, {"subject":"subject2", "version":2}]. + operationId: >- + managedkafka.projects.locations.schemaRegistries.contexts.schemas.versions.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/HttpBody' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: schemaRegistriesId + required: true + schema: + type: string + - in: path + name: contextsId + required: true + schema: + type: string + - in: path + name: schemasId + required: true + schema: + type: string + - in: query + name: subject + schema: + type: string + - in: query + name: deleted + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/schemas/types: + parameters: *ref_1 + get: + description: >- + List the supported schema types. The response will be an array of schema + types. + operationId: >- + managedkafka.projects.locations.schemaRegistries.contexts.schemas.types.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/HttpBody' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: schemaRegistriesId + required: true + schema: + type: string + - in: path + name: contextsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/schemas/{schemasId}/subjects: + parameters: *ref_1 + get: + description: >- + List subjects which reference a particular schema id. The response will + be an array of subject names. + operationId: >- + managedkafka.projects.locations.schemaRegistries.contexts.schemas.subjects.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/HttpBody' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: schemaRegistriesId + required: true + schema: + type: string + - in: path + name: contextsId + required: true + schema: + type: string + - in: path + name: schemasId + required: true + schema: + type: string + - in: query + name: subject + schema: + type: string + - in: query + name: deleted + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/subjects: + parameters: *ref_1 + get: + description: >- + List subjects in the schema registry. The response will be an array of + subject names. + operationId: managedkafka.projects.locations.schemaRegistries.contexts.subjects.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/HttpBody' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: schemaRegistriesId + required: true + schema: + type: string + - in: path + name: contextsId + required: true + schema: + type: string + - in: query + name: subjectPrefix + schema: + type: string + - in: query + name: deleted + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/subjects/{subjectsId}: + parameters: *ref_1 + delete: + description: >- + Delete a subject. The response will be an array of versions of the + deleted subject. + operationId: >- + managedkafka.projects.locations.schemaRegistries.contexts.subjects.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/HttpBody' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: schemaRegistriesId + required: true + schema: + type: string + - in: path + name: contextsId + required: true + schema: + type: string + - in: path + name: subjectsId + required: true + schema: + type: string + - in: query + name: permanent + schema: + type: boolean + post: + description: Lookup a schema under the specified subject. + operationId: >- + managedkafka.projects.locations.schemaRegistries.contexts.subjects.lookupVersion + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LookupVersionRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SchemaVersion' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: schemaRegistriesId + required: true + schema: + type: string + - in: path + name: contextsId + required: true + schema: + type: string + - in: path + name: subjectsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/subjects/{subjectsId}/versions/{versionsId}: + parameters: *ref_1 + get: + description: Get a versioned schema (schema with subject/version) of a subject. + operationId: >- + managedkafka.projects.locations.schemaRegistries.contexts.subjects.versions.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SchemaVersion' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: schemaRegistriesId + required: true + schema: + type: string + - in: path + name: contextsId + required: true + schema: + type: string + - in: path + name: subjectsId + required: true + schema: + type: string + - in: path + name: versionsId + required: true + schema: + type: string + - in: query + name: deleted + schema: + type: boolean + delete: + description: >- + Delete a version of a subject. The response will be the deleted version + id. + operationId: >- + managedkafka.projects.locations.schemaRegistries.contexts.subjects.versions.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/HttpBody' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: schemaRegistriesId + required: true + schema: + type: string + - in: path + name: contextsId + required: true + schema: + type: string + - in: path + name: subjectsId + required: true + schema: + type: string + - in: path + name: versionsId + required: true + schema: + type: string + - in: query + name: permanent + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/subjects/{subjectsId}/versions/{versionsId}/schema: + parameters: *ref_1 + get: + description: >- + Get the schema string only for a version of a subject. The response will + be the schema string. + operationId: >- + managedkafka.projects.locations.schemaRegistries.contexts.subjects.versions.getSchema + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/HttpBody' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: schemaRegistriesId + required: true + schema: + type: string + - in: path + name: contextsId + required: true + schema: + type: string + - in: path + name: subjectsId + required: true + schema: + type: string + - in: path + name: versionsId + required: true + schema: + type: string + - in: query + name: deleted + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/subjects/{subjectsId}/versions: + parameters: *ref_1 + get: + description: >- + Get all versions of a subject. The response will be an array of versions + of the subject. + operationId: >- + managedkafka.projects.locations.schemaRegistries.contexts.subjects.versions.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/HttpBody' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: schemaRegistriesId + required: true + schema: + type: string + - in: path + name: contextsId + required: true + schema: + type: string + - in: path + name: subjectsId + required: true + schema: + type: string + - in: query + name: deleted + schema: + type: boolean + post: + description: Register a new version under a given subject with the given schema. + operationId: >- + managedkafka.projects.locations.schemaRegistries.contexts.subjects.versions.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateVersionRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/CreateVersionResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: schemaRegistriesId + required: true + schema: + type: string + - in: path + name: contextsId + required: true + schema: + type: string + - in: path + name: subjectsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/subjects/{subjectsId}/versions/{versionsId}/referencedby: + parameters: *ref_1 + get: + description: >- + Get a list of IDs of schemas that reference the schema with the given + subject and version. + operationId: >- + managedkafka.projects.locations.schemaRegistries.contexts.subjects.versions.referencedby.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/HttpBody' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: schemaRegistriesId + required: true + schema: + type: string + - in: path + name: contextsId + required: true + schema: + type: string + - in: path + name: subjectsId + required: true + schema: + type: string + - in: path + name: versionsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/compatibility/{compatibilityId}: + parameters: *ref_1 + post: + description: >- + Check compatibility of a schema with all versions or a specific version + of a subject. + operationId: >- + managedkafka.projects.locations.schemaRegistries.contexts.compatibility.checkCompatibility + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CheckCompatibilityRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/CheckCompatibilityResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: schemaRegistriesId + required: true + schema: + type: string + - in: path + name: contextsId + required: true + schema: + type: string + - in: path + name: compatibilityId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/config/{configId}: + parameters: *ref_1 + get: + description: Get schema config at global level or for a subject. + operationId: managedkafka.projects.locations.schemaRegistries.contexts.config.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SchemaConfig' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: schemaRegistriesId + required: true + schema: + type: string + - in: path + name: contextsId + required: true + schema: + type: string + - in: path + name: configId + required: true + schema: + type: string + - in: query + name: defaultToGlobal + schema: + type: boolean + put: + description: >- + Update config at global level or for a subject. Creates a + SchemaSubject-level SchemaConfig if it does not exist. + operationId: managedkafka.projects.locations.schemaRegistries.contexts.config.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateSchemaConfigRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SchemaConfig' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: schemaRegistriesId + required: true + schema: + type: string + - in: path + name: contextsId + required: true + schema: + type: string + - in: path + name: configId + required: true + schema: + type: string + delete: + description: Delete schema config for a subject. + operationId: managedkafka.projects.locations.schemaRegistries.contexts.config.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SchemaConfig' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: schemaRegistriesId + required: true + schema: + type: string + - in: path + name: contextsId + required: true + schema: + type: string + - in: path + name: configId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/mode/{modeId}: + parameters: *ref_1 + get: + description: Get mode at global level or for a subject. + operationId: managedkafka.projects.locations.schemaRegistries.contexts.mode.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SchemaMode' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: schemaRegistriesId + required: true + schema: + type: string + - in: path + name: contextsId + required: true + schema: + type: string + - in: path + name: modeId + required: true + schema: + type: string + put: + description: Update mode at global level or for a subject. + operationId: managedkafka.projects.locations.schemaRegistries.contexts.mode.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateSchemaModeRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SchemaMode' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: schemaRegistriesId + required: true + schema: + type: string + - in: path + name: contextsId + required: true + schema: + type: string + - in: path + name: modeId + required: true + schema: + type: string + delete: + description: Delete schema mode for a subject. + operationId: managedkafka.projects.locations.schemaRegistries.contexts.mode.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SchemaMode' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: schemaRegistriesId + required: true + schema: + type: string + - in: path + name: contextsId + required: true + schema: + type: string + - in: path + name: modeId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/schemas/{schemasId}: + parameters: *ref_1 + get: + description: Get the schema for the given schema id. + operationId: managedkafka.projects.locations.schemaRegistries.schemas.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Schema' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: schemaRegistriesId + required: true + schema: + type: string + - in: path + name: schemasId + required: true + schema: + type: string + - in: query + name: subject + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/schemas/{schemasId}/schema: + parameters: *ref_1 + get: + description: >- + Get the schema string for the given schema id. The response will be the + schema string. + operationId: managedkafka.projects.locations.schemaRegistries.schemas.getSchema + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/HttpBody' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: schemaRegistriesId + required: true + schema: + type: string + - in: path + name: schemasId + required: true + schema: + type: string + - in: query + name: subject + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/schemas/{schemasId}/versions: + parameters: *ref_1 + get: + description: >- + List the schema versions for the given schema id. The response will be + an array of subject-version pairs as: [{"subject":"subject1", + "version":1}, {"subject":"subject2", "version":2}]. + operationId: managedkafka.projects.locations.schemaRegistries.schemas.versions.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/HttpBody' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: schemaRegistriesId + required: true + schema: + type: string + - in: path + name: schemasId + required: true + schema: + type: string + - in: query + name: subject + schema: + type: string + - in: query + name: deleted + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/schemas/types: + parameters: *ref_1 + get: + description: >- + List the supported schema types. The response will be an array of schema + types. + operationId: managedkafka.projects.locations.schemaRegistries.schemas.types.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/HttpBody' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: schemaRegistriesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/schemas/{schemasId}/subjects: + parameters: *ref_1 + get: + description: >- + List subjects which reference a particular schema id. The response will + be an array of subject names. + operationId: managedkafka.projects.locations.schemaRegistries.schemas.subjects.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/HttpBody' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: schemaRegistriesId + required: true + schema: + type: string + - in: path + name: schemasId + required: true + schema: + type: string + - in: query + name: subject + schema: + type: string + - in: query + name: deleted + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/subjects: + parameters: *ref_1 + get: + description: >- + List subjects in the schema registry. The response will be an array of + subject names. + operationId: managedkafka.projects.locations.schemaRegistries.subjects.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/HttpBody' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: schemaRegistriesId + required: true + schema: + type: string + - in: query + name: subjectPrefix + schema: + type: string + - in: query + name: deleted + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/subjects/{subjectsId}: + parameters: *ref_1 + delete: + description: >- + Delete a subject. The response will be an array of versions of the + deleted subject. + operationId: managedkafka.projects.locations.schemaRegistries.subjects.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/HttpBody' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: schemaRegistriesId + required: true + schema: + type: string + - in: path + name: subjectsId + required: true + schema: + type: string + - in: query + name: permanent + schema: + type: boolean + post: + description: Lookup a schema under the specified subject. + operationId: managedkafka.projects.locations.schemaRegistries.subjects.lookupVersion + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LookupVersionRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SchemaVersion' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: schemaRegistriesId + required: true + schema: + type: string + - in: path + name: subjectsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/subjects/{subjectsId}/versions/{versionsId}: + parameters: *ref_1 + get: + description: Get a versioned schema (schema with subject/version) of a subject. + operationId: managedkafka.projects.locations.schemaRegistries.subjects.versions.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SchemaVersion' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: schemaRegistriesId + required: true + schema: + type: string + - in: path + name: subjectsId + required: true + schema: + type: string + - in: path + name: versionsId + required: true + schema: + type: string + - in: query + name: deleted + schema: + type: boolean + delete: + description: >- + Delete a version of a subject. The response will be the deleted version + id. + operationId: >- + managedkafka.projects.locations.schemaRegistries.subjects.versions.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/HttpBody' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: schemaRegistriesId + required: true + schema: + type: string + - in: path + name: subjectsId + required: true + schema: + type: string + - in: path + name: versionsId + required: true + schema: + type: string + - in: query + name: permanent + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/subjects/{subjectsId}/versions/{versionsId}/schema: + parameters: *ref_1 + get: + description: >- + Get the schema string only for a version of a subject. The response will + be the schema string. + operationId: >- + managedkafka.projects.locations.schemaRegistries.subjects.versions.getSchema + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/HttpBody' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: schemaRegistriesId + required: true + schema: + type: string + - in: path + name: subjectsId + required: true + schema: + type: string + - in: path + name: versionsId + required: true + schema: + type: string + - in: query + name: deleted + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/subjects/{subjectsId}/versions: + parameters: *ref_1 + get: + description: >- + Get all versions of a subject. The response will be an array of versions + of the subject. + operationId: managedkafka.projects.locations.schemaRegistries.subjects.versions.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/HttpBody' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: schemaRegistriesId + required: true + schema: + type: string + - in: path + name: subjectsId + required: true + schema: + type: string + - in: query + name: deleted + schema: + type: boolean + post: + description: Register a new version under a given subject with the given schema. + operationId: >- + managedkafka.projects.locations.schemaRegistries.subjects.versions.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateVersionRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/CreateVersionResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: schemaRegistriesId + required: true + schema: + type: string + - in: path + name: subjectsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/subjects/{subjectsId}/versions/{versionsId}/referencedby: + parameters: *ref_1 + get: + description: >- + Get a list of IDs of schemas that reference the schema with the given + subject and version. + operationId: >- + managedkafka.projects.locations.schemaRegistries.subjects.versions.referencedby.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/HttpBody' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: schemaRegistriesId + required: true + schema: + type: string + - in: path + name: subjectsId + required: true + schema: + type: string + - in: path + name: versionsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/compatibility/{compatibilityId}: + parameters: *ref_1 + post: + description: >- + Check compatibility of a schema with all versions or a specific version + of a subject. + operationId: >- + managedkafka.projects.locations.schemaRegistries.compatibility.checkCompatibility + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CheckCompatibilityRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/CheckCompatibilityResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: schemaRegistriesId + required: true + schema: + type: string + - in: path + name: compatibilityId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/config/{configId}: + parameters: *ref_1 + get: + description: Get schema config at global level or for a subject. + operationId: managedkafka.projects.locations.schemaRegistries.config.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SchemaConfig' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: schemaRegistriesId + required: true + schema: + type: string + - in: path + name: configId + required: true + schema: + type: string + - in: query + name: defaultToGlobal + schema: + type: boolean + put: + description: >- + Update config at global level or for a subject. Creates a + SchemaSubject-level SchemaConfig if it does not exist. + operationId: managedkafka.projects.locations.schemaRegistries.config.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateSchemaConfigRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SchemaConfig' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: schemaRegistriesId + required: true + schema: + type: string + - in: path + name: configId + required: true + schema: + type: string + delete: + description: Delete schema config for a subject. + operationId: managedkafka.projects.locations.schemaRegistries.config.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SchemaConfig' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: schemaRegistriesId + required: true + schema: + type: string + - in: path + name: configId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/mode/{modeId}: + parameters: *ref_1 + get: + description: Get mode at global level or for a subject. + operationId: managedkafka.projects.locations.schemaRegistries.mode.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SchemaMode' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: schemaRegistriesId + required: true + schema: + type: string + - in: path + name: modeId + required: true + schema: + type: string + put: + description: Update mode at global level or for a subject. + operationId: managedkafka.projects.locations.schemaRegistries.mode.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateSchemaModeRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SchemaMode' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: schemaRegistriesId + required: true + schema: + type: string + - in: path + name: modeId + required: true + schema: + type: string + delete: + description: Delete schema mode for a subject. + operationId: managedkafka.projects.locations.schemaRegistries.mode.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SchemaMode' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: schemaRegistriesId + required: true + schema: + type: string + - in: path + name: modeId + required: true + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/memcache.yaml b/providers/src/googleapis.com/v00.00.00000/services/memcache.yaml index 33989668..c2f8a732 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/memcache.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/memcache.yaml @@ -9,8 +9,8 @@ info: Google Cloud Memorystore for Memcached API is used for creating and managing Memcached instances in GCP. version: v1 - x-discovery-doc-revision: '20241010' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250612' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/memorystore/ servers: @@ -984,6 +984,18 @@ components: additionalProperties: $ref: >- #/components/schemas/GoogleCloudSaasacceleratorManagementProvidersV1NotificationParameter + consumerProjectNumber: + description: >- + Optional. The consumer_project_number associated with this Apigee + instance. This field is added specifically to support Apigee + integration with SLM Rollout and UMM. It represents the numerical + project ID of the GCP project that consumes this Apigee instance. It + is used for SLM rollout notifications and UMM integration, enabling + proper mapping to customer projects and log delivery for Apigee + instances. This field complements consumer_project_id and may be + used for specific Apigee scenarios where the numerical ID is + required. + type: string GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource: id: GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource description: Describes provisioned dataplane resources. @@ -1403,327 +1415,6 @@ components: type: array items: type: string - AssetLocation: - id: AssetLocation - description: >- - Provides the mapping of a cloud asset to a direct physical location or - to a proxy that defines the location on its behalf. - type: object - properties: - expected: - description: >- - Defines the customer expectation around ZI/ZS for this asset and - ZI/ZS state of the region at the time of asset creation. - $ref: '#/components/schemas/IsolationExpectations' - locationData: - description: Contains all kinds of physical location definitions for this asset. - type: array - items: - $ref: '#/components/schemas/LocationData' - parentAsset: - description: >- - Defines parents assets if any in order to allow later generation of - child_asset_location data via child assets. - type: array - items: - $ref: '#/components/schemas/CloudAsset' - extraParameters: - description: Defines extra parameters required for specific asset types. - type: array - items: - $ref: '#/components/schemas/ExtraParameter' - ccfeRmsPath: - description: >- - Spanner path of the CCFE RMS database. It is only applicable for - CCFE tenants that use CCFE RMS for storing resource metadata. - type: string - IsolationExpectations: - id: IsolationExpectations - type: object - properties: - zoneIsolation: - description: >- - Deprecated: use zi_org_policy, zi_region_policy and zi_region_state - instead for setting ZI expectations as per - go/zicy-publish-physical-location. - deprecated: true - type: string - enumDescriptions: - - '' - - To be used if tracking is not available - - '' - - '' - - '' - enum: - - ZI_UNSPECIFIED - - ZI_UNKNOWN - - ZI_NOT_REQUIRED - - ZI_PREFERRED - - ZI_REQUIRED - zoneSeparation: - description: >- - Deprecated: use zs_org_policy, and zs_region_stateinstead for - setting Zs expectations as per go/zicy-publish-physical-location. - deprecated: true - type: string - enumDescriptions: - - '' - - To be used if tracking is not available - - '' - - '' - enum: - - ZS_UNSPECIFIED - - ZS_UNKNOWN - - ZS_NOT_REQUIRED - - ZS_REQUIRED - zsOrgPolicy: - type: string - enumDescriptions: - - '' - - To be used if tracking is not available - - '' - - '' - enum: - - ZS_UNSPECIFIED - - ZS_UNKNOWN - - ZS_NOT_REQUIRED - - ZS_REQUIRED - zsRegionState: - type: string - enumDescriptions: - - '' - - To be used if tracking of the asset ZS-bit is not available - - '' - - '' - enum: - - ZS_REGION_UNSPECIFIED - - ZS_REGION_UNKNOWN - - ZS_REGION_NOT_ENABLED - - ZS_REGION_ENABLED - ziOrgPolicy: - type: string - enumDescriptions: - - '' - - To be used if tracking is not available - - '' - - '' - - '' - enum: - - ZI_UNSPECIFIED - - ZI_UNKNOWN - - ZI_NOT_REQUIRED - - ZI_PREFERRED - - ZI_REQUIRED - ziRegionPolicy: - type: string - enumDescriptions: - - '' - - To be used if tracking is not available - - '' - - '' - - '' - enum: - - ZI_REGION_POLICY_UNSPECIFIED - - ZI_REGION_POLICY_UNKNOWN - - ZI_REGION_POLICY_NOT_SET - - ZI_REGION_POLICY_FAIL_OPEN - - ZI_REGION_POLICY_FAIL_CLOSED - ziRegionState: - type: string - enumDescriptions: - - '' - - To be used if tracking is not available - - '' - - '' - enum: - - ZI_REGION_UNSPECIFIED - - ZI_REGION_UNKNOWN - - ZI_REGION_NOT_ENABLED - - ZI_REGION_ENABLED - requirementOverride: - description: >- - Explicit overrides for ZI and ZS requirements to be used for - resources that should be excluded from ZI/ZS verification logic. - $ref: '#/components/schemas/RequirementOverride' - RequirementOverride: - id: RequirementOverride - type: object - properties: - ziOverride: - type: string - enumDescriptions: - - '' - - To be used if tracking is not available - - '' - - '' - - '' - enum: - - ZI_UNSPECIFIED - - ZI_UNKNOWN - - ZI_NOT_REQUIRED - - ZI_PREFERRED - - ZI_REQUIRED - zsOverride: - type: string - enumDescriptions: - - '' - - To be used if tracking is not available - - '' - - '' - enum: - - ZS_UNSPECIFIED - - ZS_UNKNOWN - - ZS_NOT_REQUIRED - - ZS_REQUIRED - LocationData: - id: LocationData - type: object - properties: - directLocation: - $ref: '#/components/schemas/DirectLocationAssignment' - spannerLocation: - $ref: '#/components/schemas/SpannerLocation' - childAssetLocation: - $ref: '#/components/schemas/CloudAssetComposition' - gcpProjectProxy: - $ref: '#/components/schemas/TenantProjectProxy' - blobstoreLocation: - $ref: '#/components/schemas/BlobstoreLocation' - placerLocation: - $ref: '#/components/schemas/PlacerLocation' - DirectLocationAssignment: - id: DirectLocationAssignment - type: object - properties: - location: - type: array - items: - $ref: '#/components/schemas/LocationAssignment' - LocationAssignment: - id: LocationAssignment - type: object - properties: - location: - type: string - locationType: - type: string - enumDescriptions: - - '' - - '1-10: Physical failure domains.' - - '' - - '11-20: Logical failure domains.' - - '' - - '' - - '' - - '' - - '' - enum: - - UNSPECIFIED - - CLUSTER - - POP - - CLOUD_ZONE - - CLOUD_REGION - - MULTI_REGION_GEO - - MULTI_REGION_JURISDICTION - - GLOBAL - - OTHER - SpannerLocation: - id: SpannerLocation - type: object - properties: - dbName: - description: Set of databases used by the resource in format /span// - type: array - items: - type: string - backupName: - description: >- - Set of backups used by the resource with name in the same format as - what is available at http://table/spanner_automon.backup_metadata - type: array - items: - type: string - CloudAssetComposition: - id: CloudAssetComposition - type: object - properties: - childAsset: - type: array - items: - $ref: '#/components/schemas/CloudAsset' - CloudAsset: - id: CloudAsset - type: object - properties: - assetType: - type: string - assetName: - type: string - TenantProjectProxy: - id: TenantProjectProxy - type: object - properties: - projectNumbers: - type: array - items: - type: string - BlobstoreLocation: - id: BlobstoreLocation - description: >- - Policy ID that identified data placement in Blobstore as per - go/blobstore-user-guide#data-metadata-placement-and-failure-domains - type: object - properties: - policyId: - type: array - items: - type: string - PlacerLocation: - id: PlacerLocation - description: >- - Message describing that the location of the customer resource is tied to - placer allocations - type: object - properties: - placerConfig: - description: >- - Directory with a config related to it in placer (e.g. - "/placer/prod/home/my-root/my-dir") - type: string - ExtraParameter: - id: ExtraParameter - description: Defines parameters that should only be used for specific asset types. - type: object - properties: - regionalMigDistributionPolicy: - description: >- - Details about zones used by regional - compute.googleapis.com/InstanceGroupManager to create instances. - $ref: '#/components/schemas/RegionalMigDistributionPolicy' - RegionalMigDistributionPolicy: - id: RegionalMigDistributionPolicy - description: >- - To be used for specifying the intended distribution of regional - compute.googleapis.com/InstanceGroupManager instances - type: object - properties: - zones: - description: Cloud zones used by regional MIG to create instances. - type: array - items: - $ref: '#/components/schemas/ZoneConfiguration' - targetShape: - description: >- - The shape in which the group converges around distribution of - resources. Instance of proto2 enum - type: integer - format: int32 - ZoneConfiguration: - id: ZoneConfiguration - type: object - properties: - zone: - type: string parameters: access_token: description: OAuth access token. @@ -2015,6 +1706,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: @@ -2169,7 +1864,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: memcache.projects.locations.operations.cancel requestBody: content: diff --git a/providers/src/googleapis.com/v00.00.00000/services/metastore.yaml b/providers/src/googleapis.com/v00.00.00000/services/metastore.yaml deleted file mode 100644 index b628114d..00000000 --- a/providers/src/googleapis.com/v00.00.00000/services/metastore.yaml +++ /dev/null @@ -1,4721 +0,0 @@ -openapi: 3.1.0 -info: - contact: - name: StackQL Studios - url: https://github.com/stackql/google-discovery-to-openapi - email: info@stackql.io - title: Dataproc Metastore API - description: >- - The Dataproc Metastore API is used to manage the lifecycle and configuration - of metastore services. - version: v1 - x-discovery-doc-revision: '20241029' - x-generated-date: '2024-11-06' -externalDocs: - url: https://cloud.google.com/dataproc-metastore/docs -servers: - - url: https://metastore.googleapis.com -components: - securitySchemes: - Oauth2: - type: oauth2 - description: Oauth 2.0 implicit authentication - flows: - implicit: - authorizationUrl: https://accounts.google.com/o/oauth2/auth - scopes: &ref_0 - 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. - Oauth2c: - type: oauth2 - description: Oauth 2.0 authorization code authentication - flows: - authorizationCode: - authorizationUrl: https://accounts.google.com/o/oauth2/auth - tokenUrl: https://accounts.google.com/o/oauth2/token - scopes: *ref_0 - schemas: - ListOperationsResponse: - id: ListOperationsResponse - description: The response message for Operations.ListOperations. - type: object - properties: - operations: - description: >- - A list of operations that matches the specified filter in the - request. - type: array - items: - $ref: '#/components/schemas/Operation' - nextPageToken: - description: The standard List next-page token. - type: string - Operation: - id: Operation - description: >- - This resource represents a long-running operation that is the result of - a network API call. - type: object - properties: - name: - description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the name should be a resource name ending with - operations/{unique_id}. - type: string - metadata: - description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - done: - description: >- - If the value is false, it means the operation is still in progress. - If true, the operation is completed, and either error or response is - available. - type: boolean - error: - description: >- - The error result of the operation in case of failure or - cancellation. - $ref: '#/components/schemas/Status' - response: - description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as Delete, the response is - google.protobuf.Empty. If the original method is standard - Get/Create/Update, the response should be the resource. For other - methods, the response should have the type XxxResponse, where Xxx is - the original method name. For example, if the original method name - is TakeSnapshot(), the inferred response type is - TakeSnapshotResponse. - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - Status: - id: Status - description: >- - The Status type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by gRPC (https://github.com/grpc). Each Status message contains - three pieces of data: error code, error message, and error details.You - can find out more about this error model and how to work with it in the - API Design Guide (https://cloud.google.com/apis/design/errors). - type: object - properties: - code: - description: The status code, which should be an enum value of google.rpc.Code. - type: integer - format: int32 - message: - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - type: string - details: - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - type: array - items: - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - Empty: - id: Empty - description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } - type: object - properties: {} - CancelOperationRequest: - id: CancelOperationRequest - description: The request message for Operations.CancelOperation. - type: object - properties: {} - ListFederationsResponse: - id: ListFederationsResponse - description: Response message for ListFederations - type: object - properties: - federations: - description: The services in the specified location. - type: array - items: - $ref: '#/components/schemas/Federation' - nextPageToken: - description: >- - A token that can be sent as page_token to retrieve the next page. If - this field is omitted, there are no subsequent pages. - type: string - unreachable: - description: Locations that could not be reached. - type: array - items: - type: string - Federation: - id: Federation - description: Represents a federation of multiple backend metastores. - type: object - properties: - name: - description: >- - Immutable. The relative resource name of the federation, of the - form: - projects/{project_number}/locations/{location_id}/federations/{federation_id}`. - type: string - createTime: - description: Output only. The time when the metastore federation was created. - readOnly: true - type: string - format: google-datetime - updateTime: - description: >- - Output only. The time when the metastore federation was last - updated. - readOnly: true - type: string - format: google-datetime - labels: - description: User-defined labels for the metastore federation. - type: object - additionalProperties: - type: string - version: - description: >- - Immutable. The Apache Hive metastore version of the federation. All - backend metastore versions must be compatible with the federation - version. - type: string - backendMetastores: - description: >- - A map from BackendMetastore rank to BackendMetastores from which the - federation service serves metadata at query time. The map key - represents the order in which BackendMetastores should be evaluated - to resolve database names at query time and should be greater than - or equal to zero. A BackendMetastore with a lower number will be - evaluated before a BackendMetastore with a higher number. - type: object - additionalProperties: - $ref: '#/components/schemas/BackendMetastore' - endpointUri: - description: Output only. The federation endpoint. - readOnly: true - type: string - state: - description: Output only. The current state of the federation. - readOnly: true - type: string - enumDescriptions: - - The state of the metastore federation is unknown. - - The metastore federation is in the process of being created. - - The metastore federation is running and ready to serve queries. - - >- - The metastore federation is being updated. It remains usable but - cannot accept additional update requests or be deleted at this - time. - - >- - The metastore federation is undergoing deletion. It cannot be - used. - - >- - The metastore federation has encountered an error and cannot be - used. The metastore federation should be deleted. - enum: - - STATE_UNSPECIFIED - - CREATING - - ACTIVE - - UPDATING - - DELETING - - ERROR - stateMessage: - description: >- - Output only. Additional information about the current state of the - metastore federation, if available. - readOnly: true - type: string - uid: - description: >- - Output only. The globally unique resource identifier of the - metastore federation. - readOnly: true - type: string - BackendMetastore: - id: BackendMetastore - description: Represents a backend metastore for the federation. - type: object - properties: - name: - description: >- - The relative resource name of the metastore that is being federated. - The formats of the relative resource names for the currently - supported metastores are listed below: BigQuery - projects/{project_id} Dataproc Metastore - projects/{project_id}/locations/{location}/services/{service_id} - type: string - metastoreType: - description: The type of the backend metastore. - type: string - enumDescriptions: - - The metastore type is not set. - - The backend metastore is BigQuery. - - The backend metastore is Dataproc Metastore. - enum: - - METASTORE_TYPE_UNSPECIFIED - - BIGQUERY - - DATAPROC_METASTORE - ListServicesResponse: - id: ListServicesResponse - description: Response message for DataprocMetastore.ListServices. - type: object - properties: - services: - description: The services in the specified location. - type: array - items: - $ref: '#/components/schemas/Service' - nextPageToken: - description: >- - A token that can be sent as page_token to retrieve the next page. If - this field is omitted, there are no subsequent pages. - type: string - unreachable: - description: Locations that could not be reached. - type: array - items: - type: string - Service: - id: Service - description: A managed metastore service that serves metadata queries. - type: object - properties: - hiveMetastoreConfig: - description: >- - Configuration information specific to running Hive metastore - software as the metastore service. - $ref: '#/components/schemas/HiveMetastoreConfig' - name: - description: >- - Immutable. The relative resource name of the metastore service, in - the following - format:projects/{project_number}/locations/{location_id}/services/{service_id}. - type: string - createTime: - description: Output only. The time when the metastore service was created. - readOnly: true - type: string - format: google-datetime - updateTime: - description: Output only. The time when the metastore service was last updated. - readOnly: true - type: string - format: google-datetime - labels: - description: User-defined labels for the metastore service. - type: object - additionalProperties: - type: string - network: - description: >- - Immutable. The relative resource name of the VPC network on which - the instance can be accessed. It is specified in the following - form:projects/{project_number}/global/networks/{network_id}. - type: string - endpointUri: - description: >- - Output only. The URI of the endpoint used to access the metastore - service. - readOnly: true - type: string - port: - description: >- - The TCP port at which the metastore service is reached. Default: - 9083. - type: integer - format: int32 - state: - description: Output only. The current state of the metastore service. - readOnly: true - type: string - enumDescriptions: - - The state of the metastore service is unknown. - - The metastore service is in the process of being created. - - The metastore service is running and ready to serve queries. - - >- - The metastore service is entering suspension. Its query-serving - availability may cease unexpectedly. - - The metastore service is suspended and unable to serve queries. - - >- - The metastore service is being updated. It remains usable but - cannot accept additional update requests or be deleted at this - time. - - The metastore service is undergoing deletion. It cannot be used. - - >- - The metastore service has encountered an error and cannot be used. - The metastore service should be deleted. - - The Dataproc Metastore service 2 is being scaled up or down. - - The metastore service is processing a managed migration. - enum: - - STATE_UNSPECIFIED - - CREATING - - ACTIVE - - SUSPENDING - - SUSPENDED - - UPDATING - - DELETING - - ERROR - - AUTOSCALING - - MIGRATING - stateMessage: - description: >- - Output only. Additional information about the current state of the - metastore service, if available. - readOnly: true - type: string - artifactGcsUri: - description: >- - Output only. A Cloud Storage URI (starting with gs://) that - specifies where artifacts related to the metastore service are - stored. - readOnly: true - type: string - tier: - description: The tier of the service. - type: string - enumDescriptions: - - The tier is not set. - - >- - The developer tier provides limited scalability and no fault - tolerance. Good for low-cost proof-of-concept. - - >- - The enterprise tier provides multi-zone high availability, and - sufficient scalability for enterprise-level Dataproc Metastore - workloads. - enum: - - TIER_UNSPECIFIED - - DEVELOPER - - ENTERPRISE - metadataIntegration: - description: >- - Optional. The setting that defines how metastore metadata should be - integrated with external services and systems. - $ref: '#/components/schemas/MetadataIntegration' - maintenanceWindow: - description: >- - The one hour maintenance window of the metastore service. This - specifies when the service can be restarted for maintenance purposes - in UTC time. Maintenance window is not needed for services with the - SPANNER database type. - $ref: '#/components/schemas/MaintenanceWindow' - uid: - description: >- - Output only. The globally unique resource identifier of the - metastore service. - readOnly: true - type: string - metadataManagementActivity: - description: >- - Output only. The metadata management activities of the metastore - service. - readOnly: true - $ref: '#/components/schemas/MetadataManagementActivity' - releaseChannel: - description: >- - Immutable. The release channel of the service. If unspecified, - defaults to STABLE. - type: string - enumDescriptions: - - Release channel is not specified. - - >- - The CANARY release channel contains the newest features, which may - be unstable and subject to unresolved issues with no known - workarounds. Services using the CANARY release channel are not - subject to any SLAs. - - >- - The STABLE release channel contains features that are considered - stable and have been validated for production use. - enum: - - RELEASE_CHANNEL_UNSPECIFIED - - CANARY - - STABLE - encryptionConfig: - description: >- - Immutable. Information used to configure the Dataproc Metastore - service to encrypt customer data at rest. Cannot be updated. - $ref: '#/components/schemas/EncryptionConfig' - networkConfig: - description: >- - The configuration specifying the network settings for the Dataproc - Metastore service. - $ref: '#/components/schemas/NetworkConfig' - databaseType: - description: >- - Immutable. The database type that the Metastore service stores its - data. - type: string - enumDescriptions: - - The DATABASE_TYPE is not set. - - MySQL is used to persist the metastore data. - - Spanner is used to persist the metastore data. - enum: - - DATABASE_TYPE_UNSPECIFIED - - MYSQL - - SPANNER - telemetryConfig: - description: >- - The configuration specifying telemetry settings for the Dataproc - Metastore service. If unspecified defaults to JSON. - $ref: '#/components/schemas/TelemetryConfig' - scalingConfig: - description: Scaling configuration of the metastore service. - $ref: '#/components/schemas/ScalingConfig' - scheduledBackup: - description: >- - Optional. The configuration of scheduled backup for the metastore - service. - $ref: '#/components/schemas/ScheduledBackup' - deletionProtection: - description: >- - Optional. Indicates if the dataproc metastore should be protected - against accidental deletions. - type: boolean - HiveMetastoreConfig: - id: HiveMetastoreConfig - description: >- - Specifies configuration information specific to running Hive metastore - software as the metastore service. - type: object - properties: - version: - description: Immutable. The Hive metastore schema version. - type: string - configOverrides: - description: >- - A mapping of Hive metastore configuration key-value pairs to apply - to the Hive metastore (configured in hive-site.xml). The mappings - override system defaults (some keys cannot be overridden). These - overrides are also applied to auxiliary versions and can be further - customized in the auxiliary version's AuxiliaryVersionConfig. - type: object - additionalProperties: - type: string - kerberosConfig: - description: >- - Information used to configure the Hive metastore service as a - service principal in a Kerberos realm. To disable Kerberos, use the - UpdateService method and specify this field's path - (hive_metastore_config.kerberos_config) in the request's update_mask - while omitting this field from the request's service. - $ref: '#/components/schemas/KerberosConfig' - endpointProtocol: - description: >- - The protocol to use for the metastore service endpoint. If - unspecified, defaults to THRIFT. - type: string - enumDescriptions: - - The protocol is not set. - - >- - Use the legacy Apache Thrift protocol for the metastore service - endpoint. - - >- - Use the modernized gRPC protocol for the metastore service - endpoint. - enum: - - ENDPOINT_PROTOCOL_UNSPECIFIED - - THRIFT - - GRPC - auxiliaryVersions: - description: >- - A mapping of Hive metastore version to the auxiliary version - configuration. When specified, a secondary Hive metastore service is - created along with the primary service. All auxiliary versions must - be less than the service's primary version. The key is the auxiliary - service name and it must match the regular expression a-z?. This - means that the first character must be a lowercase letter, and all - the following characters must be hyphens, lowercase letters, or - digits, except the last character, which cannot be a hyphen. - type: object - additionalProperties: - $ref: '#/components/schemas/AuxiliaryVersionConfig' - KerberosConfig: - id: KerberosConfig - description: Configuration information for a Kerberos principal. - type: object - properties: - keytab: - description: >- - A Kerberos keytab file that can be used to authenticate a service - principal with a Kerberos Key Distribution Center (KDC). - $ref: '#/components/schemas/Secret' - principal: - description: >- - A Kerberos principal that exists in the both the keytab the KDC to - authenticate as. A typical principal is of the form - primary/instance@REALM, but there is no exact format. - type: string - krb5ConfigGcsUri: - description: >- - A Cloud Storage URI that specifies the path to a krb5.conf file. It - is of the form gs://{bucket_name}/path/to/krb5.conf, although the - file does not need to be named krb5.conf explicitly. - type: string - Secret: - id: Secret - description: A securely stored value. - type: object - properties: - cloudSecret: - description: >- - The relative resource name of a Secret Manager secret version, in - the following - form:projects/{project_number}/secrets/{secret_id}/versions/{version_id}. - type: string - AuxiliaryVersionConfig: - id: AuxiliaryVersionConfig - description: Configuration information for the auxiliary service versions. - type: object - properties: - version: - description: >- - The Hive metastore version of the auxiliary service. It must be less - than the primary Hive metastore service's version. - type: string - configOverrides: - description: >- - A mapping of Hive metastore configuration key-value pairs to apply - to the auxiliary Hive metastore (configured in hive-site.xml) in - addition to the primary version's overrides. If keys are present in - both the auxiliary version's overrides and the primary version's - overrides, the value from the auxiliary version's overrides takes - precedence. - type: object - additionalProperties: - type: string - networkConfig: - description: >- - Output only. The network configuration contains the endpoint URI(s) - of the auxiliary Hive metastore service. - readOnly: true - $ref: '#/components/schemas/NetworkConfig' - NetworkConfig: - id: NetworkConfig - description: Network configuration for the Dataproc Metastore service. - type: object - properties: - consumers: - description: >- - Immutable. The consumer-side network configuration for the Dataproc - Metastore instance. - type: array - items: - $ref: '#/components/schemas/Consumer' - Consumer: - id: Consumer - description: Contains information of the customer's network configurations. - type: object - properties: - subnetwork: - description: >- - Immutable. The subnetwork of the customer project from which an IP - address is reserved and used as the Dataproc Metastore service's - endpoint. It is accessible to hosts in the subnet and to all hosts - in a subnet in the same region and same network. There must be at - least one IP address available in the subnet's primary range. The - subnet is specified in the following - form:projects/{project_number}/regions/{region_id}/subnetworks/{subnetwork_id} - type: string - endpointUri: - description: >- - Output only. The URI of the endpoint used to access the metastore - service. - readOnly: true - type: string - endpointLocation: - description: >- - Output only. The location of the endpoint URI. Format: - projects/{project}/locations/{location}. - readOnly: true - type: string - MetadataIntegration: - id: MetadataIntegration - description: >- - Specifies how metastore metadata should be integrated with external - services. - type: object - properties: - dataCatalogConfig: - description: Optional. The integration config for the Data Catalog service. - $ref: '#/components/schemas/DataCatalogConfig' - DataCatalogConfig: - id: DataCatalogConfig - description: >- - Specifies how metastore metadata should be integrated with the Data - Catalog service. - type: object - properties: - enabled: - description: >- - Optional. Defines whether the metastore metadata should be synced to - Data Catalog. The default value is to disable syncing metastore - metadata to Data Catalog. - type: boolean - MaintenanceWindow: - id: MaintenanceWindow - description: >- - Maintenance window. This specifies when Dataproc Metastore may perform - system maintenance operation to the service. - type: object - properties: - hourOfDay: - description: The hour of day (0-23) when the window starts. - type: integer - format: int32 - dayOfWeek: - description: The day of week, when the window starts. - type: string - enumDescriptions: - - The day of the week is unspecified. - - Monday - - Tuesday - - Wednesday - - Thursday - - Friday - - Saturday - - Sunday - enum: - - DAY_OF_WEEK_UNSPECIFIED - - MONDAY - - TUESDAY - - WEDNESDAY - - THURSDAY - - FRIDAY - - SATURDAY - - SUNDAY - MetadataManagementActivity: - id: MetadataManagementActivity - description: The metadata management activities of the metastore service. - type: object - properties: - metadataExports: - description: Output only. The latest metadata exports of the metastore service. - readOnly: true - type: array - items: - $ref: '#/components/schemas/MetadataExport' - restores: - description: Output only. The latest restores of the metastore service. - readOnly: true - type: array - items: - $ref: '#/components/schemas/Restore' - MetadataExport: - id: MetadataExport - description: The details of a metadata export operation. - type: object - properties: - destinationGcsUri: - description: >- - Output only. A Cloud Storage URI of a folder that metadata are - exported to, in the form of gs:////, where is automatically - generated. - readOnly: true - type: string - startTime: - description: Output only. The time when the export started. - readOnly: true - type: string - format: google-datetime - endTime: - description: Output only. The time when the export ended. - readOnly: true - type: string - format: google-datetime - state: - description: Output only. The current state of the export. - readOnly: true - type: string - enumDescriptions: - - The state of the metadata export is unknown. - - The metadata export is running. - - The metadata export completed successfully. - - The metadata export failed. - - The metadata export is cancelled. - enum: - - STATE_UNSPECIFIED - - RUNNING - - SUCCEEDED - - FAILED - - CANCELLED - databaseDumpType: - description: Output only. The type of the database dump. - readOnly: true - type: string - enumDescriptions: - - The type of the database dump is unknown. - - Database dump is a MySQL dump file. - - Database dump contains Avro files. - enum: - - TYPE_UNSPECIFIED - - MYSQL - - AVRO - Restore: - id: Restore - description: The details of a metadata restore operation. - type: object - properties: - startTime: - description: Output only. The time when the restore started. - readOnly: true - type: string - format: google-datetime - endTime: - description: Output only. The time when the restore ended. - readOnly: true - type: string - format: google-datetime - state: - description: Output only. The current state of the restore. - readOnly: true - type: string - enumDescriptions: - - The state of the metadata restore is unknown. - - The metadata restore is running. - - The metadata restore completed successfully. - - The metadata restore failed. - - The metadata restore is cancelled. - enum: - - STATE_UNSPECIFIED - - RUNNING - - SUCCEEDED - - FAILED - - CANCELLED - backup: - description: >- - Output only. The relative resource name of the metastore service - backup to restore from, in the following - form:projects/{project_id}/locations/{location_id}/services/{service_id}/backups/{backup_id}. - readOnly: true - type: string - type: - description: Output only. The type of restore. - readOnly: true - type: string - enumDescriptions: - - The restore type is unknown. - - The service's metadata and configuration are restored. - - Only the service's metadata is restored. - enum: - - RESTORE_TYPE_UNSPECIFIED - - FULL - - METADATA_ONLY - details: - description: >- - Output only. The restore details containing the revision of the - service to be restored to, in format of JSON. - readOnly: true - type: string - backupLocation: - description: >- - Optional. A Cloud Storage URI specifying where the backup artifacts - are stored, in the format gs:///. - type: string - EncryptionConfig: - id: EncryptionConfig - description: Encryption settings for the service. - type: object - properties: - kmsKey: - description: >- - The fully qualified customer provided Cloud KMS key name to use for - customer data encryption, in the following - format:projects/{project_number}/locations/{location_id}/keyRings/{key_ring_id}/cryptoKeys/{crypto_key_id}. - type: string - TelemetryConfig: - id: TelemetryConfig - description: Telemetry Configuration for the Dataproc Metastore service. - type: object - properties: - logFormat: - description: The output format of the Dataproc Metastore service's logs. - type: string - enumDescriptions: - - The LOG_FORMAT is not set. - - Logging output uses the legacy textPayload format. - - Logging output uses the jsonPayload format. - enum: - - LOG_FORMAT_UNSPECIFIED - - LEGACY - - JSON - ScalingConfig: - id: ScalingConfig - description: Represents the scaling configuration of a metastore service. - type: object - properties: - instanceSize: - description: >- - An enum of readable instance sizes, with each instance size mapping - to a float value (e.g. InstanceSize.EXTRA_SMALL = - scaling_factor(0.1)) - type: string - enumDescriptions: - - Unspecified instance size - - Extra small instance size, maps to a scaling factor of 0.1. - - Small instance size, maps to a scaling factor of 0.5. - - Medium instance size, maps to a scaling factor of 1.0. - - Large instance size, maps to a scaling factor of 3.0. - - Extra large instance size, maps to a scaling factor of 6.0. - enum: - - INSTANCE_SIZE_UNSPECIFIED - - EXTRA_SMALL - - SMALL - - MEDIUM - - LARGE - - EXTRA_LARGE - scalingFactor: - description: >- - Scaling factor, increments of 0.1 for values less than 1.0, and - increments of 1.0 for values greater than 1.0. - type: number - format: float - autoscalingConfig: - description: Optional. The autoscaling configuration. - $ref: '#/components/schemas/AutoscalingConfig' - AutoscalingConfig: - id: AutoscalingConfig - description: Represents the autoscaling configuration of a metastore service. - type: object - properties: - autoscalingFactor: - description: >- - Output only. The scaling factor of a service with autoscaling - enabled. - readOnly: true - type: number - format: float - autoscalingEnabled: - description: Optional. Whether or not autoscaling is enabled for this service. - type: boolean - limitConfig: - description: Optional. The LimitConfig of the service. - $ref: '#/components/schemas/LimitConfig' - LimitConfig: - id: LimitConfig - description: Represents the autoscaling limit configuration of a metastore service. - type: object - properties: - maxScalingFactor: - description: >- - Optional. The highest scaling factor that the service should be - autoscaled to. - type: number - format: float - minScalingFactor: - description: >- - Optional. The lowest scaling factor that the service should be - autoscaled to. - type: number - format: float - ScheduledBackup: - id: ScheduledBackup - description: This specifies the configuration of scheduled backup. - type: object - properties: - enabled: - description: >- - Optional. Defines whether the scheduled backup is enabled. The - default value is false. - type: boolean - cronSchedule: - description: >- - Optional. The scheduled interval in Cron format, see - https://en.wikipedia.org/wiki/Cron The default is empty: scheduled - backup is not enabled. Must be specified to enable scheduled - backups. - type: string - timeZone: - description: >- - Optional. Specifies the time zone to be used when interpreting - cron_schedule. Must be a time zone name from the time zone database - (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones), e.g. - America/Los_Angeles or Africa/Abidjan. If left unspecified, the - default is UTC. - type: string - nextScheduledTime: - description: >- - Output only. The time when the next backups execution is scheduled - to start. - readOnly: true - type: string - format: google-datetime - backupLocation: - description: >- - Optional. A Cloud Storage URI of a folder, in the format gs:///. A - sub-folder containing backup files will be stored below it. - type: string - latestBackup: - description: Output only. The details of the latest scheduled backup. - readOnly: true - $ref: '#/components/schemas/LatestBackup' - LatestBackup: - id: LatestBackup - description: The details of the latest scheduled backup. - type: object - properties: - backupId: - description: >- - Output only. The ID of an in-progress scheduled backup. Empty if no - backup is in progress. - readOnly: true - type: string - startTime: - description: Output only. The time when the backup was started. - readOnly: true - type: string - format: google-datetime - state: - description: Output only. The current state of the backup. - readOnly: true - type: string - enumDescriptions: - - The state of the backup is unknown. - - The backup is in progress. - - The backup completed. - - The backup failed. - enum: - - STATE_UNSPECIFIED - - IN_PROGRESS - - SUCCEEDED - - FAILED - duration: - description: Output only. The duration of the backup completion. - readOnly: true - type: string - format: google-duration - ListMetadataImportsResponse: - id: ListMetadataImportsResponse - description: Response message for DataprocMetastore.ListMetadataImports. - type: object - properties: - metadataImports: - description: The imports in the specified service. - type: array - items: - $ref: '#/components/schemas/MetadataImport' - nextPageToken: - description: >- - A token that can be sent as page_token to retrieve the next page. If - this field is omitted, there are no subsequent pages. - type: string - unreachable: - description: Locations that could not be reached. - type: array - items: - type: string - MetadataImport: - id: MetadataImport - description: A metastore resource that imports metadata. - type: object - properties: - databaseDump: - description: Immutable. A database dump from a pre-existing metastore's database. - $ref: '#/components/schemas/DatabaseDump' - name: - description: >- - Immutable. The relative resource name of the metadata import, of the - form:projects/{project_number}/locations/{location_id}/services/{service_id}/metadataImports/{metadata_import_id}. - type: string - description: - description: The description of the metadata import. - type: string - createTime: - description: Output only. The time when the metadata import was started. - readOnly: true - type: string - format: google-datetime - updateTime: - description: Output only. The time when the metadata import was last updated. - readOnly: true - type: string - format: google-datetime - endTime: - description: Output only. The time when the metadata import finished. - readOnly: true - type: string - format: google-datetime - state: - description: Output only. The current state of the metadata import. - readOnly: true - type: string - enumDescriptions: - - The state of the metadata import is unknown. - - The metadata import is running. - - The metadata import completed successfully. - - The metadata import is being updated. - - >- - The metadata import failed, and attempted metadata changes were - rolled back. - enum: - - STATE_UNSPECIFIED - - RUNNING - - SUCCEEDED - - UPDATING - - FAILED - DatabaseDump: - id: DatabaseDump - description: >- - A specification of the location of and metadata about a database dump - from a relational database management system. - type: object - properties: - databaseType: - description: The type of the database. - deprecated: true - type: string - enumDescriptions: - - The type of the source database is unknown. - - The type of the source database is MySQL. - enum: - - DATABASE_TYPE_UNSPECIFIED - - MYSQL - gcsUri: - description: >- - A Cloud Storage object or folder URI that specifies the source from - which to import metadata. It must begin with gs://. - type: string - sourceDatabase: - description: The name of the source database. - deprecated: true - type: string - type: - description: >- - Optional. The type of the database dump. If unspecified, defaults to - MYSQL. - type: string - enumDescriptions: - - The type of the database dump is unknown. - - Database dump is a MySQL dump file. - - Database dump contains Avro files. - enum: - - TYPE_UNSPECIFIED - - MYSQL - - AVRO - ExportMetadataRequest: - id: ExportMetadataRequest - description: Request message for DataprocMetastore.ExportMetadata. - type: object - properties: - destinationGcsFolder: - description: >- - A Cloud Storage URI of a folder, in the format gs:///. A sub-folder - containing exported files will be created below it. - type: string - requestId: - description: >- - Optional. A request ID. Specify a unique request ID to allow the - server to ignore the request if it has completed. The server will - ignore subsequent requests that provide a duplicate request ID for - at least 60 minutes after the first request.For example, if an - initial request times out, followed by another request with the same - request ID, the server ignores the second request to prevent the - creation of duplicate commitments.The request ID must be a valid - UUID - (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format). - A zero UUID (00000000-0000-0000-0000-000000000000) is not supported. - type: string - databaseDumpType: - description: >- - Optional. The type of the database dump. If unspecified, defaults to - MYSQL. - type: string - enumDescriptions: - - The type of the database dump is unknown. - - Database dump is a MySQL dump file. - - Database dump contains Avro files. - enum: - - TYPE_UNSPECIFIED - - MYSQL - - AVRO - RestoreServiceRequest: - id: RestoreServiceRequest - description: Request message for DataprocMetastore.Restore. - type: object - properties: - backup: - description: >- - Optional. The relative resource name of the metastore service backup - to restore from, in the following - form:projects/{project_id}/locations/{location_id}/services/{service_id}/backups/{backup_id}. - Mutually exclusive with backup_location, and exactly one of the two - must be set. - type: string - backupLocation: - description: >- - Optional. A Cloud Storage URI specifying the location of the backup - artifacts, namely - backup avro files under "avro/", - backup_metastore.json and service.json, in the following form:gs://. - Mutually exclusive with backup, and exactly one of the two must be - set. - type: string - restoreType: - description: >- - Optional. The type of restore. If unspecified, defaults to - METADATA_ONLY. - type: string - enumDescriptions: - - The restore type is unknown. - - The service's metadata and configuration are restored. - - Only the service's metadata is restored. - enum: - - RESTORE_TYPE_UNSPECIFIED - - FULL - - METADATA_ONLY - requestId: - description: >- - Optional. A request ID. Specify a unique request ID to allow the - server to ignore the request if it has completed. The server will - ignore subsequent requests that provide a duplicate request ID for - at least 60 minutes after the first request.For example, if an - initial request times out, followed by another request with the same - request ID, the server ignores the second request to prevent the - creation of duplicate commitments.The request ID must be a valid - UUID - (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format). - A zero UUID (00000000-0000-0000-0000-000000000000) is not supported. - type: string - ListBackupsResponse: - id: ListBackupsResponse - description: Response message for DataprocMetastore.ListBackups. - type: object - properties: - backups: - description: The backups of the specified service. - type: array - items: - $ref: '#/components/schemas/Backup' - nextPageToken: - description: >- - A token that can be sent as page_token to retrieve the next page. If - this field is omitted, there are no subsequent pages. - type: string - unreachable: - description: Locations that could not be reached. - type: array - items: - type: string - Backup: - id: Backup - description: The details of a backup resource. - type: object - properties: - name: - description: >- - Immutable. The relative resource name of the backup, in the - following - form:projects/{project_number}/locations/{location_id}/services/{service_id}/backups/{backup_id} - type: string - createTime: - description: Output only. The time when the backup was started. - readOnly: true - type: string - format: google-datetime - endTime: - description: Output only. The time when the backup finished creating. - readOnly: true - type: string - format: google-datetime - state: - description: Output only. The current state of the backup. - readOnly: true - type: string - enumDescriptions: - - The state of the backup is unknown. - - The backup is being created. - - The backup is being deleted. - - The backup is active and ready to use. - - The backup failed. - - The backup is being restored. - enum: - - STATE_UNSPECIFIED - - CREATING - - DELETING - - ACTIVE - - FAILED - - RESTORING - serviceRevision: - description: Output only. The revision of the service at the time of backup. - readOnly: true - $ref: '#/components/schemas/Service' - description: - description: The description of the backup. - type: string - restoringServices: - description: Output only. Services that are restoring from the backup. - readOnly: true - type: array - items: - type: string - QueryMetadataRequest: - id: QueryMetadataRequest - description: Request message for DataprocMetastore.QueryMetadata. - type: object - properties: - query: - description: >- - Required. A read-only SQL query to execute against the metadata - database. The query cannot change or mutate the data. - type: string - MoveTableToDatabaseRequest: - id: MoveTableToDatabaseRequest - description: Request message for DataprocMetastore.MoveTableToDatabase. - type: object - properties: - tableName: - description: Required. The name of the table to be moved. - type: string - dbName: - description: Required. The name of the database where the table resides. - type: string - destinationDbName: - description: Required. The name of the database where the table should be moved. - type: string - AlterMetadataResourceLocationRequest: - id: AlterMetadataResourceLocationRequest - description: Request message for DataprocMetastore.AlterMetadataResourceLocation. - type: object - properties: - resourceName: - description: >- - Required. The relative metadata resource name in the following - format.databases/{database_id} or - databases/{database_id}/tables/{table_id} or - databases/{database_id}/tables/{table_id}/partitions/{partition_id} - type: string - locationUri: - description: Required. The new location URI for the metadata resource. - type: string - AlterTablePropertiesRequest: - id: AlterTablePropertiesRequest - description: Request message for DataprocMetastore.AlterTableProperties. - type: object - properties: - tableName: - description: >- - Required. The name of the table containing the properties you're - altering in the following - format.databases/{database_id}/tables/{table_id} - type: string - updateMask: - description: >- - A field mask that specifies the metadata table properties that are - overwritten by the update. Fields specified in the update_mask are - relative to the resource (not to the full request). A field is - overwritten if it is in the mask.For example, given the target - properties: properties { a: 1 b: 2 } And an update properties: - properties { a: 2 b: 3 c: 4 } then if the field mask is:paths: - "properties.b", "properties.c"then the result will be: properties { - a: 1 b: 3 c: 4 } - type: string - format: google-fieldmask - properties: - description: >- - A map that describes the desired values to mutate. If update_mask is - empty, the properties will not update. Otherwise, the properties - only alters the value whose associated paths exist in the update - mask - type: object - additionalProperties: - type: string - StartMigrationRequest: - id: StartMigrationRequest - description: Request message for DataprocMetastore.StartMigration. - type: object - properties: - migrationExecution: - description: Required. The configuration details for the migration. - $ref: '#/components/schemas/MigrationExecution' - requestId: - description: >- - Optional. A request ID. Specify a unique request ID to allow the - server to ignore the request if it has completed. The server will - ignore subsequent requests that provide a duplicate request ID for - at least 60 minutes after the first request.For example, if an - initial request times out, followed by another request with the same - request ID, the server ignores the second request to prevent the - creation of duplicate commitments.The request ID must be a valid - UUID - (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) - A zero UUID (00000000-0000-0000-0000-000000000000) is not supported. - type: string - MigrationExecution: - id: MigrationExecution - description: The details of a migration execution resource. - type: object - properties: - cloudSqlMigrationConfig: - description: >- - Configuration information specific to migrating from self-managed - hive metastore on Google Cloud using Cloud SQL as the backend - database to Dataproc Metastore. - $ref: '#/components/schemas/CloudSQLMigrationConfig' - name: - description: >- - Output only. The relative resource name of the migration execution, - in the following form: - projects/{project_number}/locations/{location_id}/services/{service_id}/migrationExecutions/{migration_execution_id} - readOnly: true - type: string - createTime: - description: Output only. The time when the migration execution was started. - readOnly: true - type: string - format: google-datetime - endTime: - description: Output only. The time when the migration execution finished. - readOnly: true - type: string - format: google-datetime - state: - description: Output only. The current state of the migration execution. - readOnly: true - type: string - enumDescriptions: - - The state of the migration execution is unknown. - - The migration execution is starting. - - The migration execution is running. - - The migration execution is in the process of being cancelled. - - The migration execution is awaiting user action. - - The migration execution has completed successfully. - - The migration execution has failed. - - The migration execution is cancelled. - - The migration execution is being deleted. - enum: - - STATE_UNSPECIFIED - - STARTING - - RUNNING - - CANCELLING - - AWAITING_USER_ACTION - - SUCCEEDED - - FAILED - - CANCELLED - - DELETING - phase: - description: Output only. The current phase of the migration execution. - readOnly: true - type: string - enumDescriptions: - - The phase of the migration execution is unknown. - - >- - Replication phase refers to the migration phase when Dataproc - Metastore is running a pipeline to replicate changes in the - customer database to its backend database. During this phase, - Dataproc Metastore uses the customer database as the hive - metastore backend database. - - >- - Cutover phase refers to the migration phase when Dataproc - Metastore switches to using its own backend database. Migration - enters this phase when customer is done migrating all their - clusters/workloads to Dataproc Metastore and triggers - CompleteMigration. - enum: - - PHASE_UNSPECIFIED - - REPLICATION - - CUTOVER - stateMessage: - description: >- - Output only. Additional information about the current state of the - migration execution. - readOnly: true - type: string - CloudSQLMigrationConfig: - id: CloudSQLMigrationConfig - description: >- - Configuration information for migrating from self-managed hive metastore - on Google Cloud using Cloud SQL as the backend database to Dataproc - Metastore. - type: object - properties: - cdcConfig: - description: >- - Required. Configuration information to start the Change Data Capture - (CDC) streams from customer database to backend database of Dataproc - Metastore. Dataproc Metastore switches to using its backend database - after the cutover phase of migration. - $ref: '#/components/schemas/CdcConfig' - cloudSqlConnectionConfig: - description: >- - Required. Configuration information to establish customer database - connection before the cutover phase of migration - $ref: '#/components/schemas/CloudSQLConnectionConfig' - CdcConfig: - id: CdcConfig - description: >- - Configuration information to start the Change Data Capture (CDC) streams - from customer database to backend database of Dataproc Metastore. - type: object - properties: - vpcNetwork: - description: >- - Required. Fully qualified name of the Cloud SQL instance's VPC - network or the shared VPC network that Datastream will peer to, in - the following format: - projects/{project_id}/locations/global/networks/{network_id}. More - context in - https://cloud.google.com/datastream/docs/network-connectivity-options#privateconnectivity - type: string - subnetIpRange: - description: Required. A /29 CIDR IP range for peering with datastream. - type: string - username: - description: >- - Required. The username that the Datastream service should use for - the MySQL connection. - type: string - password: - description: >- - Required. Input only. The password for the user that Datastream - service should use for the MySQL connection. This field is not - returned on request. - type: string - reverseProxySubnet: - description: >- - Required. The URL of the subnetwork resource to create the VM - instance hosting the reverse proxy in. More context in - https://cloud.google.com/datastream/docs/private-connectivity#reverse-csql-proxy - The subnetwork should reside in the network provided in the request - that Datastream will peer to and should be in the same region as - Datastream, in the following format. - projects/{project_id}/regions/{region_id}/subnetworks/{subnetwork_id} - type: string - bucket: - description: >- - Optional. The bucket to write the intermediate stream event data in. - The bucket name must be without any prefix like "gs://". See the - bucket naming requirements - (https://cloud.google.com/storage/docs/buckets#naming). This field - is optional. If not set, the Artifacts Cloud Storage bucket will be - used. - type: string - rootPath: - description: >- - Optional. The root path inside the Cloud Storage bucket. The stream - event data will be written to this path. The default value is - /migration. - type: string - CloudSQLConnectionConfig: - id: CloudSQLConnectionConfig - description: >- - Configuration information to establish customer database connection - before the cutover phase of migration - type: object - properties: - instanceConnectionName: - description: >- - Required. Cloud SQL database connection name - (project_id:region:instance_name) - type: string - ipAddress: - description: Required. The private IP address of the Cloud SQL instance. - type: string - port: - description: Required. The network port of the database. - type: integer - format: int32 - hiveDatabaseName: - description: Required. The hive database name. - type: string - username: - description: >- - Required. The username that Dataproc Metastore service will use to - connect to the database. - type: string - password: - description: >- - Required. Input only. The password for the user that Dataproc - Metastore service will be using to connect to the database. This - field is not returned on request. - type: string - proxySubnet: - description: >- - Required. The relative resource name of the subnetwork to deploy the - SOCKS5 proxy service in. The subnetwork should reside in a network - through which the Cloud SQL instance is accessible. The resource - name should be in the format, - projects/{project_id}/regions/{region_id}/subnetworks/{subnetwork_id} - type: string - natSubnet: - description: >- - Required. The relative resource name of the subnetwork to be used - for Private Service Connect. Note that this cannot be a regular - subnet and is used only for NAT. - (https://cloud.google.com/vpc/docs/about-vpc-hosted-services#psc-subnets) - This subnet is used to publish the SOCKS5 proxy service. The subnet - size must be at least /29 and it should reside in a network through - which the Cloud SQL instance is accessible. The resource name should - be in the format, - projects/{project_id}/regions/{region_id}/subnetworks/{subnetwork_id} - type: string - CompleteMigrationRequest: - id: CompleteMigrationRequest - description: Request message for DataprocMetastore.CompleteMigration. - type: object - properties: {} - CancelMigrationRequest: - id: CancelMigrationRequest - description: Request message for DataprocMetastore.CancelMigration. - type: object - properties: {} - ListMigrationExecutionsResponse: - id: ListMigrationExecutionsResponse - description: Response message for DataprocMetastore.ListMigrationExecutions. - type: object - properties: - migrationExecutions: - description: The migration executions on the specified service. - type: array - items: - $ref: '#/components/schemas/MigrationExecution' - nextPageToken: - description: >- - A token that can be sent as page_token to retrieve the next page. If - this field is omitted, there are no subsequent pages. - type: string - unreachable: - description: Locations that could not be reached. - type: array - items: - type: string - ListLocationsResponse: - id: ListLocationsResponse - description: The response message for Locations.ListLocations. - type: object - properties: - locations: - description: >- - A list of locations that matches the specified filter in the - request. - type: array - items: - $ref: '#/components/schemas/Location' - nextPageToken: - description: The standard List next-page token. - type: string - Location: - id: Location - description: A resource that represents a Google Cloud location. - type: object - properties: - name: - description: >- - Resource name for the location, which may vary between - implementations. For example: - "projects/example-project/locations/us-east1" - type: string - locationId: - description: 'The canonical id for this location. For example: "us-east1".' - type: string - displayName: - description: >- - The friendly name for this location, typically a nearby city name. - For example, "Tokyo". - type: string - labels: - description: >- - Cross-service attributes for the location. For example - {"cloud.googleapis.com/region": "us-east1"} - type: object - additionalProperties: - type: string - metadata: - description: >- - Service-specific metadata. For example the available capacity at the - given location. - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - SetIamPolicyRequest: - id: SetIamPolicyRequest - description: Request message for SetIamPolicy method. - type: object - properties: - policy: - description: >- - REQUIRED: The complete policy to be applied to the resource. The - size of the policy is limited to a few 10s of KB. An empty policy is - a valid policy but certain Google Cloud services (such as Projects) - might reject them. - $ref: '#/components/schemas/Policy' - updateMask: - description: >- - OPTIONAL: A FieldMask specifying which fields of the policy to - modify. Only the fields in the mask will be modified. If no mask is - provided, the following default mask is used:paths: "bindings, etag" - type: string - format: google-fieldmask - Policy: - id: Policy - description: >- - An Identity and Access Management (IAM) policy, which specifies access - controls for Google Cloud resources.A Policy is a collection of - bindings. A binding binds one or more members, or principals, to a - single role. Principals can be user accounts, service accounts, Google - groups, and domains (such as G Suite). A role is a named list of - permissions; each role can be an IAM predefined role or a user-created - custom role.For some types of Google Cloud resources, a binding can also - specify a condition, which is a logical expression that allows access to - a resource only if the expression evaluates to true. A condition can add - constraints based on attributes of the request, the resource, or both. - To learn which resources support conditions in their IAM policies, see - the IAM documentation - (https://cloud.google.com/iam/help/conditions/resource-policies).JSON - example: { "bindings": [ { "role": - "roles/resourcemanager.organizationAdmin", "members": [ - "user:mike@example.com", "group:admins@example.com", - "domain:google.com", - "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { - "role": "roles/resourcemanager.organizationViewer", "members": [ - "user:eve@example.com" ], "condition": { "title": "expirable access", - "description": "Does not grant access after Sep 2020", "expression": - "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": - "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - - user:mike@example.com - group:admins@example.com - domain:google.com - - serviceAccount:my-project-id@appspot.gserviceaccount.com role: - roles/resourcemanager.organizationAdmin - members: - - user:eve@example.com role: roles/resourcemanager.organizationViewer - condition: title: expirable access description: Does not grant access - after Sep 2020 expression: request.time < - timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For - a description of IAM and its features, see the IAM documentation - (https://cloud.google.com/iam/docs/). - type: object - properties: - 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 conditionsImportant: 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). - type: integer - format: int32 - bindings: - description: >- - Associates a list of members, or principals, with a role. - Optionally, may specify a condition that determines how and when the - bindings are applied. Each of the bindings must contain at least one - principal.The bindings in a Policy can refer to up to 1,500 - principals; up to 250 of these principals can be Google groups. Each - occurrence of a principal counts towards these limits. For example, - if the bindings grant 50 different roles to user:alice@example.com, - and not to any other principal, then you can add another 1,450 - principals to the bindings in the Policy. - type: array - items: - $ref: '#/components/schemas/Binding' - auditConfigs: - description: Specifies cloud audit logging configuration for this policy. - type: array - items: - $ref: '#/components/schemas/AuditConfig' - 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. - type: string - format: byte - Binding: - id: Binding - description: Associates members, or principals, with a role. - type: object - properties: - role: - description: >- - Role that is assigned to the list of members, or principals. For - example, roles/viewer, roles/editor, or roles/owner.For an overview - of the IAM roles and permissions, see the IAM documentation - (https://cloud.google.com/iam/docs/roles-overview). For a list of - the available pre-defined roles, see here - (https://cloud.google.com/iam/docs/understanding-roles). - type: string - members: - description: >- - Specifies the principals requesting access for a Google Cloud - 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. Does not include identities that come - from external identity providers (IdPs) through identity federation. - user:{emailid}: An email address that represents a specific Google - account. For example, alice@example.com . serviceAccount:{emailid}: - An email address that represents a Google service account. For - example, my-other-app@appspot.gserviceaccount.com. - serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: - An identifier for a Kubernetes service account - (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). - For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. - group:{emailid}: An email address that represents a Google group. - For example, admins@example.com. domain:{domain}: The G Suite domain - (primary) that represents all the users of that domain. For example, - google.com or example.com. - principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: - A single identity in a workforce identity pool. - principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}: - All workforce identities in a group. - principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}: - All workforce identities with a specific attribute value. - principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*: - All identities in a workforce identity pool. - principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}: - A single identity in a workload identity pool. - principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}: - A workload identity pool group. - principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}: - All identities in a workload identity pool with a certain attribute. - principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*: - All identities in a workload identity pool. - 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. - deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: - Deleted single identity in a workforce identity pool. For example, - deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value. - type: array - items: - type: string - condition: - description: >- - The condition that is associated with this binding.If the condition - evaluates to true, then this binding applies to the current - request.If the condition evaluates to false, then this binding does - not apply to the current request. However, a different role binding - might grant the same role to one or more of the principals in this - binding.To learn which resources support conditions in their IAM - policies, see the IAM documentation - (https://cloud.google.com/iam/help/conditions/resource-policies). - $ref: '#/components/schemas/Expr' - Expr: - id: 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. - type: object - properties: - expression: - description: >- - Textual representation of an expression in Common Expression - Language syntax. - 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 - 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 - 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 - AuditConfig: - id: 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. - type: object - properties: - 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 - auditLogConfigs: - description: The configuration for logging of each type of permission. - type: array - items: - $ref: '#/components/schemas/AuditLogConfig' - AuditLogConfig: - id: 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. - type: object - properties: - logType: - description: The log type that this config enables. - type: string - enumDescriptions: - - Default case. Should never be this. - - 'Admin reads. Example: CloudIAM getIamPolicy' - - 'Data writes. Example: CloudSQL Users create' - - 'Data reads. Example: CloudSQL Users list' - enum: - - LOG_TYPE_UNSPECIFIED - - ADMIN_READ - - DATA_WRITE - - DATA_READ - exemptedMembers: - description: >- - Specifies the identities that do not cause logging for this type of - permission. Follows the same format of Binding.members. - type: array - items: - type: string - TestIamPermissionsRequest: - id: TestIamPermissionsRequest - description: Request message for TestIamPermissions method. - type: object - properties: - permissions: - description: >- - The set of permissions to check for the resource. Permissions with - wildcards (such as * or storage.*) are not allowed. For more - information see IAM Overview - (https://cloud.google.com/iam/docs/overview#permissions). - type: array - items: - type: string - TestIamPermissionsResponse: - id: TestIamPermissionsResponse - description: Response message for TestIamPermissions method. - type: object - properties: - permissions: - description: >- - A subset of TestPermissionsRequest.permissions that the caller is - allowed. - type: array - items: - type: string - LocationMetadata: - id: LocationMetadata - description: Metadata about the service in a location. - type: object - properties: - supportedHiveMetastoreVersions: - description: >- - The versions of Hive Metastore that can be used when creating a new - metastore service in this location. The server guarantees that - exactly one HiveMetastoreVersion in the list will set is_default. - type: array - items: - $ref: '#/components/schemas/HiveMetastoreVersion' - multiRegionMetadata: - description: The multi-region metadata if the current region is a multi-region. - $ref: '#/components/schemas/MultiRegionMetadata' - customRegionMetadata: - description: >- - Possible configurations supported if the current region is a custom - region. - type: array - items: - $ref: '#/components/schemas/CustomRegionMetadata' - HiveMetastoreVersion: - id: HiveMetastoreVersion - description: A specification of a supported version of the Hive Metastore software. - type: object - properties: - version: - description: The semantic version of the Hive Metastore software. - type: string - isDefault: - description: >- - Whether version will be chosen by the server if a metastore service - is created with a HiveMetastoreConfig that omits the version. - type: boolean - MultiRegionMetadata: - id: MultiRegionMetadata - description: >- - The metadata for the multi-region that includes the constituent regions. - The metadata is only populated if the region is multi-region. For single - region or custom dual region, it will be empty. - type: object - properties: - constituentRegions: - description: The regions constituting the multi-region. - type: array - items: - type: string - CustomRegionMetadata: - id: CustomRegionMetadata - description: >- - Metadata about a custom region. This is only populated if the region is - a custom region. For single/multi regions, it will be empty. - type: object - properties: - requiredReadWriteRegions: - description: The read-write regions for this custom region. - type: array - items: - type: string - optionalReadOnlyRegions: - description: The read-only regions for this custom region. - type: array - items: - type: string - witnessRegion: - description: The Spanner witness region for this custom region. - type: string - OperationMetadata: - id: OperationMetadata - description: Represents the metadata of a long-running operation. - type: object - properties: - createTime: - description: Output only. The time the operation was created. - readOnly: true - type: string - format: google-datetime - endTime: - description: Output only. The time the operation finished running. - readOnly: true - type: string - format: google-datetime - target: - description: >- - Output only. Server-defined resource path for the target of the - operation. - readOnly: true - type: string - verb: - description: Output only. Name of the verb executed by the operation. - readOnly: true - type: string - statusMessage: - description: Output only. Human-readable status of the operation, if any. - readOnly: true - type: string - requestedCancellation: - description: >- - Output only. Identifies whether the caller has requested - cancellation of the operation. Operations that have successfully - been cancelled have Operation.error value with a - google.rpc.Status.code of 1, corresponding to Code.CANCELLED. - readOnly: true - type: boolean - apiVersion: - description: Output only. API version used to start the operation. - readOnly: true - type: string - QueryMetadataResponse: - id: QueryMetadataResponse - description: Response message for DataprocMetastore.QueryMetadata. - type: object - properties: - resultManifestUri: - description: >- - The manifest URI is link to a JSON instance in Cloud Storage. This - instance manifests immediately along with QueryMetadataResponse. The - content of the URI is not retriable until the long-running operation - query against the metadata finishes. - type: string - MoveTableToDatabaseResponse: - id: MoveTableToDatabaseResponse - description: Response message for DataprocMetastore.MoveTableToDatabase. - type: object - properties: {} - AlterMetadataResourceLocationResponse: - id: AlterMetadataResourceLocationResponse - description: Response message for DataprocMetastore.AlterMetadataResourceLocation. - type: object - properties: {} - ErrorDetails: - id: ErrorDetails - description: >- - Error details in public error message for - DataprocMetastore.QueryMetadata. - type: object - properties: - details: - description: >- - Additional structured details about this error.Keys define the - failure items. Value describes the exception or details of the item. - type: object - additionalProperties: - type: string - parameters: - 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: - type: string - enum: - - json - - media - - proto - 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 - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string - _.xgafv: - description: V1 error format. - in: query - name: $.xgafv - schema: - type: string - enum: - - '1' - - '2' - x-stackQL-resources: - locations: - id: google.metastore.locations - name: locations - title: Locations - methods: - list: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.locations - get: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/locations/methods/get' - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - insert: [] - update: [] - replace: [] - delete: [] - operations: - id: google.metastore.operations - name: operations - title: Operations - methods: - list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.operations - get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - cancel: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - insert: [] - update: [] - replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - federations: - id: google.metastore.federations - name: federations - title: Federations - methods: - list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1federations/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.federations - create: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1federations/post - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1federations~1{federationsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - patch: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1federations~1{federationsId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1federations~1{federationsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/federations/methods/get' - - $ref: '#/components/x-stackQL-resources/federations/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/federations/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/federations/methods/patch' - replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/federations/methods/delete' - federations_iam_policies: - id: google.metastore.federations_iam_policies - name: federations_iam_policies - title: Federations_iam_policies - methods: - set_iam_policy: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1federations~1{federationsId}:setIamPolicy/post - response: - mediaType: application/json - openAPIDocKey: '200' - get_iam_policy: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1federations~1{federationsId}:getIamPolicy/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.bindings - test_iam_permissions: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1federations~1{federationsId}:testIamPermissions/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/federations_iam_policies/methods/get_iam_policy - insert: [] - update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/federations_iam_policies/methods/set_iam_policy - delete: [] - services: - id: google.metastore.services - name: services - title: Services - methods: - list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1services/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.services - create: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1services/post - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1services~1{servicesId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - patch: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1services~1{servicesId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1services~1{servicesId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - export_metadata: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1services~1{servicesId}:exportMetadata/post - response: - mediaType: application/json - openAPIDocKey: '200' - restore: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1services~1{servicesId}:restore/post - response: - mediaType: application/json - openAPIDocKey: '200' - query_metadata: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1services~1{servicesId}:queryMetadata/post - response: - mediaType: application/json - openAPIDocKey: '200' - move_table_to_database: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1services~1{servicesId}:moveTableToDatabase/post - response: - mediaType: application/json - openAPIDocKey: '200' - alter_location: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1services~1{servicesId}:alterLocation/post - response: - mediaType: application/json - openAPIDocKey: '200' - alter_table_properties: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1services~1{servicesId}:alterTableProperties/post - response: - mediaType: application/json - openAPIDocKey: '200' - start_migration: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1services~1{servicesId}:startMigration/post - response: - mediaType: application/json - openAPIDocKey: '200' - complete_migration: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1services~1{servicesId}:completeMigration/post - response: - mediaType: application/json - openAPIDocKey: '200' - cancel_migration: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1services~1{servicesId}:cancelMigration/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/services/methods/get' - - $ref: '#/components/x-stackQL-resources/services/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/services/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/services/methods/patch' - replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/services/methods/delete' - services_iam_policies: - id: google.metastore.services_iam_policies - name: services_iam_policies - title: Services_iam_policies - methods: - set_iam_policy: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1services~1{servicesId}:setIamPolicy/post - response: - mediaType: application/json - openAPIDocKey: '200' - get_iam_policy: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1services~1{servicesId}:getIamPolicy/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.bindings - test_iam_permissions: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1services~1{servicesId}:testIamPermissions/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/services_iam_policies/methods/get_iam_policy - insert: [] - update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/services_iam_policies/methods/set_iam_policy - delete: [] - metadata_imports: - id: google.metastore.metadata_imports - name: metadata_imports - title: Metadata_imports - methods: - list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1services~1{servicesId}~1metadataImports/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.metadataImports - create: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1services~1{servicesId}~1metadataImports/post - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1services~1{servicesId}~1metadataImports~1{metadataImportsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - patch: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1services~1{servicesId}~1metadataImports~1{metadataImportsId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/metadata_imports/methods/get' - - $ref: '#/components/x-stackQL-resources/metadata_imports/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/metadata_imports/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/metadata_imports/methods/patch' - replace: [] - delete: [] - backups: - id: google.metastore.backups - name: backups - title: Backups - methods: - list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1services~1{servicesId}~1backups/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.backups - create: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1services~1{servicesId}~1backups/post - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1services~1{servicesId}~1backups~1{backupsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1services~1{servicesId}~1backups~1{backupsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/backups/methods/get' - - $ref: '#/components/x-stackQL-resources/backups/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/backups/methods/create' - update: [] - replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/backups/methods/delete' - backups_iam_policies: - id: google.metastore.backups_iam_policies - name: backups_iam_policies - title: Backups_iam_policies - methods: - set_iam_policy: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1services~1{servicesId}~1backups~1{backupsId}:setIamPolicy/post - response: - mediaType: application/json - openAPIDocKey: '200' - get_iam_policy: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1services~1{servicesId}~1backups~1{backupsId}:getIamPolicy/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.bindings - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/backups_iam_policies/methods/get_iam_policy - insert: [] - update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/backups_iam_policies/methods/set_iam_policy - delete: [] - migration_executions: - id: google.metastore.migration_executions - name: migration_executions - title: Migration_executions - methods: - get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1services~1{servicesId}~1migrationExecutions~1{migrationExecutionsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1services~1{servicesId}~1migrationExecutions~1{migrationExecutionsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1services~1{servicesId}~1migrationExecutions/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.migrationExecutions - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/migration_executions/methods/get' - - $ref: '#/components/x-stackQL-resources/migration_executions/methods/list' - insert: [] - update: [] - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/migration_executions/methods/delete - databases_iam_policies: - id: google.metastore.databases_iam_policies - name: databases_iam_policies - title: Databases_iam_policies - methods: - set_iam_policy: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1services~1{servicesId}~1databases~1{databasesId}:setIamPolicy/post - response: - mediaType: application/json - openAPIDocKey: '200' - get_iam_policy: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1services~1{servicesId}~1databases~1{databasesId}:getIamPolicy/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.bindings - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/databases_iam_policies/methods/get_iam_policy - insert: [] - update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/databases_iam_policies/methods/set_iam_policy - delete: [] - tables_iam_policies: - id: google.metastore.tables_iam_policies - name: tables_iam_policies - title: Tables_iam_policies - methods: - set_iam_policy: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1services~1{servicesId}~1databases~1{databasesId}~1tables~1{tablesId}:setIamPolicy/post - response: - mediaType: application/json - openAPIDocKey: '200' - get_iam_policy: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1services~1{servicesId}~1databases~1{databasesId}~1tables~1{tablesId}:getIamPolicy/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.bindings - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/tables_iam_policies/methods/get_iam_policy - insert: [] - update: [] - replace: - - $ref: >- - #/components/x-stackQL-resources/tables_iam_policies/methods/set_iam_policy - delete: [] -paths: - /v1/projects/{projectsId}/locations: - parameters: &ref_1 - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/_.xgafv' - get: - description: Lists information about the supported locations for this service. - operationId: metastore.projects.locations.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/ListLocationsResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_1 - get: - description: Gets information about a location. - operationId: metastore.projects.locations.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Location' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_1 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns UNIMPLEMENTED. - operationId: metastore.projects.locations.operations.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/ListOperationsResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_1 - get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: metastore.projects.locations.operations.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: operationsId - required: true - schema: - type: string - delete: - description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - google.rpc.Code.UNIMPLEMENTED. - operationId: metastore.projects.locations.operations.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Empty' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: operationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_1 - post: - description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to Code.CANCELLED. - operationId: metastore.projects.locations.operations.cancel - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CancelOperationRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Empty' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: operationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/federations: - parameters: *ref_1 - get: - description: Lists federations in a project and location. - operationId: metastore.projects.locations.federations.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/ListFederationsResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: orderBy - schema: - type: string - post: - description: Creates a metastore federation in a project and location. - operationId: metastore.projects.locations.federations.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Federation' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: query - name: federationId - schema: - type: string - - in: query - name: requestId - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/federations/{federationsId}: - parameters: *ref_1 - get: - description: Gets the details of a single federation. - operationId: metastore.projects.locations.federations.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Federation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: federationsId - required: true - schema: - type: string - patch: - description: Updates the fields of a federation. - operationId: metastore.projects.locations.federations.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Federation' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: federationsId - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - - in: query - name: requestId - schema: - type: string - delete: - description: Deletes a single federation. - operationId: metastore.projects.locations.federations.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: federationsId - required: true - schema: - type: string - - in: query - name: requestId - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/federations/{federationsId}:setIamPolicy: - parameters: *ref_1 - post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and - PERMISSION_DENIED errors. - operationId: metastore.projects.locations.federations.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SetIamPolicyRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Policy' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: federationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/federations/{federationsId}:getIamPolicy: - parameters: *ref_1 - get: - description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: metastore.projects.locations.federations.getIamPolicy - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Policy' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: federationsId - required: true - schema: - type: string - - in: query - name: options.requestedPolicyVersion - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/federations/{federationsId}:testIamPermissions: - parameters: *ref_1 - post: - description: >- - Returns permissions that a caller has on the specified resource. If the - resource does not exist, this will return an empty set of permissions, - not a NOT_FOUND error.Note: This operation is designed to be used for - building permission-aware UIs and command-line tools, not for - authorization checking. This operation may "fail open" without warning. - operationId: metastore.projects.locations.federations.testIamPermissions - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TestIamPermissionsRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/TestIamPermissionsResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: federationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/services: - parameters: *ref_1 - get: - description: Lists services in a project and location. - operationId: metastore.projects.locations.services.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/ListServicesResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: orderBy - schema: - type: string - post: - description: Creates a metastore service in a project and location. - operationId: metastore.projects.locations.services.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Service' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: query - name: serviceId - schema: - type: string - - in: query - name: requestId - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}: - parameters: *ref_1 - get: - description: Gets the details of a single service. - operationId: metastore.projects.locations.services.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Service' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: servicesId - required: true - schema: - type: string - patch: - description: Updates the parameters of a single service. - operationId: metastore.projects.locations.services.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Service' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: servicesId - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - - in: query - name: requestId - schema: - type: string - delete: - description: Deletes a single service. - operationId: metastore.projects.locations.services.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: servicesId - required: true - schema: - type: string - - in: query - name: requestId - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:exportMetadata: - parameters: *ref_1 - post: - description: Exports metadata from a service. - operationId: metastore.projects.locations.services.exportMetadata - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ExportMetadataRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: servicesId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:restore: - parameters: *ref_1 - post: - description: Restores a service from a backup. - operationId: metastore.projects.locations.services.restore - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RestoreServiceRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: servicesId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:queryMetadata: - parameters: *ref_1 - post: - description: Query Dataproc Metastore metadata. - operationId: metastore.projects.locations.services.queryMetadata - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/QueryMetadataRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: servicesId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:moveTableToDatabase: - parameters: *ref_1 - post: - description: Move a table to another database. - operationId: metastore.projects.locations.services.moveTableToDatabase - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MoveTableToDatabaseRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: servicesId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:alterLocation: - parameters: *ref_1 - post: - description: >- - Alter metadata resource location. The metadata resource can be a - database, table, or partition. This functionality only updates the - parent directory for the respective metadata resource and does not - transfer any existing data to the new location. - operationId: metastore.projects.locations.services.alterLocation - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AlterMetadataResourceLocationRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: servicesId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:alterTableProperties: - parameters: *ref_1 - post: - description: Alter metadata table properties. - operationId: metastore.projects.locations.services.alterTableProperties - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AlterTablePropertiesRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: servicesId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:startMigration: - parameters: *ref_1 - post: - description: Starts the Managed Migration process. - operationId: metastore.projects.locations.services.startMigration - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/StartMigrationRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: servicesId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:completeMigration: - parameters: *ref_1 - post: - description: >- - Completes the managed migration process. The Dataproc Metastore service - will switch to using its own backend database after successful - migration. - operationId: metastore.projects.locations.services.completeMigration - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CompleteMigrationRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: servicesId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:cancelMigration: - parameters: *ref_1 - post: - description: Cancels the ongoing Managed Migration process. - operationId: metastore.projects.locations.services.cancelMigration - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CancelMigrationRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: servicesId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:setIamPolicy: - parameters: *ref_1 - post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and - PERMISSION_DENIED errors. - operationId: metastore.projects.locations.services.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SetIamPolicyRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Policy' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: servicesId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:getIamPolicy: - parameters: *ref_1 - get: - description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: metastore.projects.locations.services.getIamPolicy - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Policy' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: servicesId - required: true - schema: - type: string - - in: query - name: options.requestedPolicyVersion - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:testIamPermissions: - parameters: *ref_1 - post: - description: >- - Returns permissions that a caller has on the specified resource. If the - resource does not exist, this will return an empty set of permissions, - not a NOT_FOUND error.Note: This operation is designed to be used for - building permission-aware UIs and command-line tools, not for - authorization checking. This operation may "fail open" without warning. - operationId: metastore.projects.locations.services.testIamPermissions - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TestIamPermissionsRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/TestIamPermissionsResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: servicesId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/metadataImports: - parameters: *ref_1 - get: - description: Lists imports in a service. - operationId: metastore.projects.locations.services.metadataImports.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/ListMetadataImportsResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: servicesId - required: true - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: orderBy - schema: - type: string - post: - description: Creates a new MetadataImport in a given project and location. - operationId: metastore.projects.locations.services.metadataImports.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MetadataImport' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: servicesId - required: true - schema: - type: string - - in: query - name: metadataImportId - schema: - type: string - - in: query - name: requestId - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/metadataImports/{metadataImportsId}: - parameters: *ref_1 - get: - description: Gets details of a single import. - operationId: metastore.projects.locations.services.metadataImports.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/MetadataImport' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: servicesId - required: true - schema: - type: string - - in: path - name: metadataImportsId - required: true - schema: - type: string - patch: - description: >- - Updates a single import. Only the description field of MetadataImport is - supported to be updated. - operationId: metastore.projects.locations.services.metadataImports.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MetadataImport' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: servicesId - required: true - schema: - type: string - - in: path - name: metadataImportsId - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - - in: query - name: requestId - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/backups: - parameters: *ref_1 - get: - description: Lists backups in a service. - operationId: metastore.projects.locations.services.backups.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/ListBackupsResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: servicesId - required: true - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: orderBy - schema: - type: string - post: - description: Creates a new backup in a given project and location. - operationId: metastore.projects.locations.services.backups.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Backup' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: servicesId - required: true - schema: - type: string - - in: query - name: backupId - schema: - type: string - - in: query - name: requestId - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/backups/{backupsId}: - parameters: *ref_1 - get: - description: Gets details of a single backup. - operationId: metastore.projects.locations.services.backups.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Backup' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: servicesId - required: true - schema: - type: string - - in: path - name: backupsId - required: true - schema: - type: string - delete: - description: Deletes a single backup. - operationId: metastore.projects.locations.services.backups.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: servicesId - required: true - schema: - type: string - - in: path - name: backupsId - required: true - schema: - type: string - - in: query - name: requestId - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/backups/{backupsId}:setIamPolicy: - parameters: *ref_1 - post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and - PERMISSION_DENIED errors. - operationId: metastore.projects.locations.services.backups.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SetIamPolicyRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Policy' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: servicesId - required: true - schema: - type: string - - in: path - name: backupsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/backups/{backupsId}:getIamPolicy: - parameters: *ref_1 - get: - description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: metastore.projects.locations.services.backups.getIamPolicy - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Policy' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: servicesId - required: true - schema: - type: string - - in: path - name: backupsId - required: true - schema: - type: string - - in: query - name: options.requestedPolicyVersion - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/migrationExecutions/{migrationExecutionsId}: - parameters: *ref_1 - get: - description: Gets details of a single migration execution. - operationId: metastore.projects.locations.services.migrationExecutions.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/MigrationExecution' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: servicesId - required: true - schema: - type: string - - in: path - name: migrationExecutionsId - required: true - schema: - type: string - delete: - description: Deletes a single migration execution. - operationId: metastore.projects.locations.services.migrationExecutions.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: servicesId - required: true - schema: - type: string - - in: path - name: migrationExecutionsId - required: true - schema: - type: string - - in: query - name: requestId - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/migrationExecutions: - parameters: *ref_1 - get: - description: Lists migration executions on a service. - operationId: metastore.projects.locations.services.migrationExecutions.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/ListMigrationExecutionsResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: servicesId - required: true - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: orderBy - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/databases/{databasesId}:setIamPolicy: - parameters: *ref_1 - post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and - PERMISSION_DENIED errors. - operationId: metastore.projects.locations.services.databases.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SetIamPolicyRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Policy' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: servicesId - required: true - schema: - type: string - - in: path - name: databasesId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/databases/{databasesId}:getIamPolicy: - parameters: *ref_1 - get: - description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: metastore.projects.locations.services.databases.getIamPolicy - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Policy' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: servicesId - required: true - schema: - type: string - - in: path - name: databasesId - required: true - schema: - type: string - - in: query - name: options.requestedPolicyVersion - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/databases/{databasesId}/tables/{tablesId}:setIamPolicy: - parameters: *ref_1 - post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and - PERMISSION_DENIED errors. - operationId: metastore.projects.locations.services.databases.tables.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SetIamPolicyRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Policy' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: servicesId - required: true - schema: - type: string - - in: path - name: databasesId - required: true - schema: - type: string - - in: path - name: tablesId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/databases/{databasesId}/tables/{tablesId}:getIamPolicy: - parameters: *ref_1 - get: - description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: metastore.projects.locations.services.databases.tables.getIamPolicy - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Policy' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: servicesId - required: true - schema: - type: string - - in: path - name: databasesId - required: true - schema: - type: string - - in: path - name: tablesId - required: true - schema: - type: string - - in: query - name: options.requestedPolicyVersion - schema: - type: integer - format: int32 diff --git a/providers/src/googleapis.com/v00.00.00000/services/migrationcenter.yaml b/providers/src/googleapis.com/v00.00.00000/services/migrationcenter.yaml index c6a76603..5d096144 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/migrationcenter.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/migrationcenter.yaml @@ -9,8 +9,8 @@ info: A unified platform that helps you accelerate your end-to-end cloud journey from your current on-premises or cloud environments to Google Cloud. version: v1 - x-discovery-doc-revision: '20241027' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250821' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/migration-center servers: @@ -176,6 +176,10 @@ components: description: Output only. The full name of the asset. readOnly: true type: string + title: + description: Output only. Server generated human readable name of the asset. + readOnly: true + type: string createTime: description: Output only. The timestamp when the asset was created. readOnly: true @@ -202,6 +206,25 @@ components: machines. readOnly: true $ref: '#/components/schemas/MachineDetails' + databaseDeploymentDetails: + description: Output only. Asset information specific for database deployments. + readOnly: true + $ref: '#/components/schemas/DatabaseDeploymentDetails' + databaseDetails: + description: Output only. Asset information specific for logical databases. + readOnly: true + $ref: '#/components/schemas/DatabaseDetails' + hidden: + description: Optional. Indicates if the asset is hidden. + type: boolean + hideReason: + description: Optional. An optional reason for marking this asset as hidden. + type: string + hideTime: + description: Output only. The timestamp when the asset was marked as hidden. + readOnly: true + type: string + format: google-datetime insightList: description: Output only. The list of insights associated with the asset. readOnly: true @@ -279,6 +302,12 @@ components: disks: description: Disk details. $ref: '#/components/schemas/MachineDiskDetails' + diskPartitions: + description: >- + Optional. Disk partitions details. Note: Partitions are not + necessarily mounted on local disks and therefore might not have a + one-to-one correspondence with local disks. + $ref: '#/components/schemas/DiskPartitionDetails' platform: description: Platform specific information. $ref: '#/components/schemas/PlatformDetails' @@ -293,6 +322,9 @@ components: cpuName: description: CPU name, e.g., "Intel Xeon E5-2690", "AMD EPYC 7571" etc. type: string + cpuManufacturer: + description: Optional. CPU manufacturer, e.g., "Intel", "AMD". + type: string vendor: description: Hardware vendor. type: string @@ -862,7 +894,7 @@ components: type: string enumDescriptions: - Unknown (default value). - - Staticly assigned IP. + - Statically assigned IP. - Dynamically assigned IP (DHCP). enum: - ADDRESS_ASSIGNMENT_UNSPECIFIED @@ -965,7 +997,7 @@ components: description: Partition file system. type: string mountPoint: - description: Mount pount (Linux/Windows) or drive letter (Windows). + description: Mount point (Linux/Windows) or drive letter (Windows). type: string capacityBytes: description: Partition capacity. @@ -1038,6 +1070,24 @@ components: - RDM_COMPATIBILITY_UNSPECIFIED - PHYSICAL_COMPATIBILITY - VIRTUAL_COMPATIBILITY + DiskPartitionDetails: + id: DiskPartitionDetails + description: Disk partition details. + type: object + properties: + totalCapacityBytes: + description: Output only. Total capacity of all partitions. + readOnly: true + type: string + format: int64 + freeSpaceBytes: + description: Output only. Total free space of all partitions. + readOnly: true + type: string + format: int64 + partitions: + description: Optional. List of partitions. + $ref: '#/components/schemas/DiskPartitionList' PlatformDetails: id: PlatformDetails description: Information about the platform. @@ -1185,6 +1235,515 @@ components: - HYPERTHREADING_STATUS_UNSPECIFIED - HYPERTHREADING_STATUS_DISABLED - HYPERTHREADING_STATUS_ENABLED + DatabaseDeploymentDetails: + id: DatabaseDeploymentDetails + description: The details of a database deployment asset. + type: object + properties: + generatedId: + description: Optional. The database deployment generated ID. + type: string + manualUniqueId: + description: Optional. A manual unique ID set by the user. + type: string + version: + description: Optional. The database deployment version. + type: string + edition: + description: Optional. The database deployment edition. + type: string + topology: + description: Optional. Details of the database deployment topology. + $ref: '#/components/schemas/DatabaseDeploymentTopology' + sqlServer: + description: Optional. Details of a Microsoft SQL Server database deployment. + $ref: '#/components/schemas/SqlServerDatabaseDeployment' + mysql: + description: Optional. Details of a MYSQL database deployment. + $ref: '#/components/schemas/MysqlDatabaseDeployment' + postgresql: + description: Optional. Details of a PostgreSQL database deployment. + $ref: '#/components/schemas/PostgreSqlDatabaseDeployment' + aggregatedStats: + description: Output only. Aggregated stats for the database deployment. + readOnly: true + $ref: '#/components/schemas/DatabaseDeploymentDetailsAggregatedStats' + awsRds: + description: Optional. Details of an AWS RDS instance. + $ref: '#/components/schemas/AwsRds' + DatabaseDeploymentTopology: + id: DatabaseDeploymentTopology + description: Details of database deployment's topology. + type: object + properties: + coreCount: + description: Optional. Number of total logical cores. + type: integer + format: int32 + physicalCoreCount: + description: Optional. Number of total physical cores. + type: integer + format: int32 + memoryBytes: + description: Optional. Total memory in bytes. + type: string + format: int64 + diskAllocatedBytes: + description: Optional. Disk allocated in bytes. + type: string + format: int64 + diskUsedBytes: + description: Optional. Disk used in bytes. + type: string + format: int64 + coreLimit: + description: Optional. Number of total logical cores limited by db deployment. + type: integer + format: int32 + physicalCoreLimit: + description: Optional. Number of total physical cores limited by db deployment. + type: integer + format: int32 + memoryLimitBytes: + description: Optional. Total memory in bytes limited by db deployment. + type: string + format: int64 + instances: + description: Optional. List of database instances. + type: array + items: + $ref: '#/components/schemas/DatabaseInstance' + DatabaseInstance: + id: DatabaseInstance + description: Details of a database instance. + type: object + properties: + instanceName: + description: Optional. The instance's name. + type: string + role: + description: Optional. The instance role in the database engine. + type: string + enumDescriptions: + - Unspecified. + - Primary. + - Secondary. + - Arbiter. + enum: + - ROLE_UNSPECIFIED + - PRIMARY + - SECONDARY + - ARBITER + network: + description: Optional. Networking details. + $ref: '#/components/schemas/DatabaseInstanceNetwork' + DatabaseInstanceNetwork: + id: DatabaseInstanceNetwork + description: Network details of a database instance. + type: object + properties: + primaryMacAddress: + description: Optional. The instance's primary MAC address. + type: string + ipAddresses: + description: Optional. The instance's IP addresses. + type: array + items: + type: string + hostNames: + description: Optional. The instance's host names. + type: array + items: + type: string + SqlServerDatabaseDeployment: + id: SqlServerDatabaseDeployment + description: Specific details for a Microsoft SQL Server database deployment. + type: object + properties: + features: + description: Optional. List of SQL Server features. + type: array + items: + $ref: '#/components/schemas/SqlServerFeature' + serverFlags: + description: Optional. List of SQL Server server flags. + type: array + items: + $ref: '#/components/schemas/SqlServerServerFlag' + traceFlags: + description: Optional. List of SQL Server trace flags. + type: array + items: + $ref: '#/components/schemas/SqlServerTraceFlag' + SqlServerFeature: + id: SqlServerFeature + description: SQL Server feature details. + type: object + properties: + featureName: + description: Required. The feature name. + type: string + enabled: + description: >- + Required. Field enabled is set when a feature is used on the source + deployment. + type: boolean + SqlServerServerFlag: + id: SqlServerServerFlag + description: SQL Server server flag details. + type: object + properties: + serverFlagName: + description: Required. The server flag name. + type: string + value: + description: Required. The server flag value set by the user. + type: string + valueInUse: + description: >- + Required. The server flag actual value. If `value_in_use` is + different from `value` it means that either the configuration change + was not applied or it is an expected behavior. See SQL Server + documentation for more details. + type: string + SqlServerTraceFlag: + id: SqlServerTraceFlag + description: SQL Server trace flag details. + type: object + properties: + traceFlagName: + description: Required. The trace flag name. + type: string + scope: + description: Required. The trace flag scope. + type: string + enumDescriptions: + - Unspecified. + - Off. + - Global. + - Session. + enum: + - SCOPE_UNSPECIFIED + - 'OFF' + - GLOBAL + - SESSION + MysqlDatabaseDeployment: + id: MysqlDatabaseDeployment + description: Specific details for a Mysql database deployment. + type: object + properties: + properties: + description: Optional. List of MySql properties. + type: array + items: + $ref: '#/components/schemas/MySqlProperty' + plugins: + description: Optional. List of MySql plugins. + type: array + items: + $ref: '#/components/schemas/MySqlPlugin' + resourceGroupsCount: + description: Optional. Number of resource groups. + type: integer + format: int32 + variables: + description: Optional. List of MySql variables. + type: array + items: + $ref: '#/components/schemas/MySqlVariable' + MySqlProperty: + id: MySqlProperty + description: MySql property. + type: object + properties: + property: + description: Required. The property name. + type: string + enabled: + description: Required. The property is enabled. + type: boolean + numericValue: + description: Required. The property numeric value. + type: string + format: int64 + MySqlPlugin: + id: MySqlPlugin + description: MySql plugin. + type: object + properties: + plugin: + description: Required. The plugin name. + type: string + version: + description: Required. The plugin version. + type: string + enabled: + description: Required. The plugin is active. + type: boolean + MySqlVariable: + id: MySqlVariable + description: MySql variable. + type: object + properties: + variable: + description: Required. The variable name. + type: string + value: + description: Required. The variable value. + type: string + category: + description: Required. The variable category. + type: string + PostgreSqlDatabaseDeployment: + id: PostgreSqlDatabaseDeployment + description: Specific details for a PostgreSQL database deployment. + type: object + properties: + properties: + description: Optional. List of PostgreSql properties. + type: array + items: + $ref: '#/components/schemas/PostgreSqlProperty' + settings: + description: Optional. List of PostgreSql settings. + type: array + items: + $ref: '#/components/schemas/PostgreSqlSetting' + PostgreSqlProperty: + id: PostgreSqlProperty + description: PostgreSql property. + type: object + properties: + property: + description: Required. The property name. + type: string + enabled: + description: Required. The property is enabled. + type: boolean + numericValue: + description: Required. The property numeric value. + type: string + format: int64 + PostgreSqlSetting: + id: PostgreSqlSetting + description: PostgreSql setting. + type: object + properties: + setting: + description: Required. The setting name. + type: string + source: + description: Required. The setting source. + type: string + unit: + description: Optional. The setting unit. + type: string + boolValue: + description: Required. The setting boolean value. + type: boolean + intValue: + description: Required. The setting int value. + type: string + format: int64 + realValue: + description: Required. The setting real value. + type: number + format: float + stringValue: + description: >- + Required. The setting string value. Notice that enum values are + stored as strings. + type: string + DatabaseDeploymentDetailsAggregatedStats: + id: DatabaseDeploymentDetailsAggregatedStats + description: Aggregated stats for the database deployment. + type: object + properties: + databaseCount: + description: Output only. The number of databases in the deployment. + readOnly: true + type: integer + format: int32 + AwsRds: + id: AwsRds + description: Specific details for an AWS RDS database deployment. + type: object + properties: {} + DatabaseDetails: + id: DatabaseDetails + description: Details of a logical database. + type: object + properties: + databaseName: + description: Required. The name of the database. + type: string + parentDatabaseDeployment: + description: >- + Required. The parent database deployment that contains the logical + database. + $ref: '#/components/schemas/DatabaseDetailsParentDatabaseDeployment' + allocatedStorageBytes: + description: Optional. The allocated storage for the database in bytes. + type: string + format: int64 + schemas: + description: Optional. The database schemas. + type: array + items: + $ref: '#/components/schemas/DatabaseSchema' + DatabaseDetailsParentDatabaseDeployment: + id: DatabaseDetailsParentDatabaseDeployment + description: The identifiers of the parent database deployment. + type: object + properties: + generatedId: + description: Optional. The parent database deployment generated ID. + type: string + manualUniqueId: + description: >- + Optional. The parent database deployment optional manual unique ID + set by the user. + type: string + DatabaseSchema: + id: DatabaseSchema + description: Details of a database schema. + type: object + properties: + schemaName: + description: Required. The name of the schema. + type: string + tablesSizeBytes: + description: Optional. The total size of tables in bytes. + type: string + format: int64 + objects: + description: Optional. List of details of objects by category. + type: array + items: + $ref: '#/components/schemas/DatabaseObjects' + sqlServer: + description: Optional. Details of a SqlServer schema. + $ref: '#/components/schemas/SqlServerSchemaDetails' + mysql: + description: Optional. Details of a Mysql schema. + $ref: '#/components/schemas/MySqlSchemaDetails' + postgresql: + description: Optional. Details of a PostgreSql schema. + $ref: '#/components/schemas/PostgreSqlSchemaDetails' + DatabaseObjects: + id: DatabaseObjects + description: Details of a group of database objects. + type: object + properties: + category: + description: Optional. The category of the objects. + type: string + enumDescriptions: + - Unspecified type. + - Table. + - Index. + - Constraints. + - Views. + - Source code, e.g. procedures. + - Uncategorized objects. + enum: + - CATEGORY_UNSPECIFIED + - TABLE + - INDEX + - CONSTRAINTS + - VIEWS + - SOURCE_CODE + - OTHER + count: + description: Optional. The number of objects. + type: string + format: int64 + SqlServerSchemaDetails: + id: SqlServerSchemaDetails + description: Specific details for a SqlServer database. + type: object + properties: + clrObjectCount: + description: Optional. SqlServer number of CLR objects. + type: integer + format: int32 + MySqlSchemaDetails: + id: MySqlSchemaDetails + description: Specific details for a Mysql database. + type: object + properties: + storageEngines: + description: Optional. Mysql storage engine tables. + type: array + items: + $ref: '#/components/schemas/MySqlStorageEngineDetails' + MySqlStorageEngineDetails: + id: MySqlStorageEngineDetails + description: Mysql storage engine tables. + type: object + properties: + engine: + description: Required. The storage engine. + type: string + enumDescriptions: + - Unspecified storage engine. + - InnoDB. + - MyISAM. + - Memory. + - CSV. + - Archive. + - Blackhole. + - NDB. + - Merge. + - Federated. + - Example. + - Other. + enum: + - ENGINE_UNSPECIFIED + - INNODB + - MYISAM + - MEMORY + - CSV + - ARCHIVE + - BLACKHOLE + - NDB + - MERGE + - FEDERATED + - EXAMPLE + - OTHER + tableCount: + description: Optional. The number of tables. + type: integer + format: int32 + encryptedTableCount: + description: Optional. The number of encrypted tables. + type: integer + format: int32 + PostgreSqlSchemaDetails: + id: PostgreSqlSchemaDetails + description: Specific details for a PostgreSql schema. + type: object + properties: + foreignTablesCount: + description: Optional. PostgreSql foreign tables. + type: integer + format: int32 + postgresqlExtensions: + description: Optional. PostgreSql extensions. + type: array + items: + $ref: '#/components/schemas/PostgreSqlExtension' + PostgreSqlExtension: + id: PostgreSqlExtension + description: PostgreSql extension. + type: object + properties: + extension: + description: Required. The extension name. + type: string + version: + description: Required. The extension version. + type: string InsightList: id: InsightList description: Message containing insights list. @@ -1211,7 +1770,7 @@ components: readOnly: true $ref: '#/components/schemas/MigrationInsight' genericInsight: - description: Output only. A generic insight about an asset + description: Output only. A generic insight about an asset. readOnly: true $ref: '#/components/schemas/GenericInsight' MigrationInsight: @@ -1427,7 +1986,13 @@ components: type: object properties: iops: - description: Disk I/O operations per second. + description: Optional. Disk I/O operations per second. + $ref: '#/components/schemas/DailyResourceUsageAggregationStats' + readIops: + description: Optional. Disk read I/O operations per second. + $ref: '#/components/schemas/DailyResourceUsageAggregationStats' + writeIops: + description: Optional. Disk write I/O operations per second. $ref: '#/components/schemas/DailyResourceUsageAggregationStats' BatchUpdateAssetsRequest: id: BatchUpdateAssetsRequest @@ -1505,6 +2070,24 @@ components: https://google.aip.dev/135#delete-if-existing for additional details. Default value is `false`. type: boolean + cascadingRules: + description: Optional. Optional cascading rules for deleting related assets. + type: array + items: + $ref: '#/components/schemas/CascadingRule' + CascadingRule: + id: CascadingRule + description: Specifies cascading rules for traversing relations. + type: object + properties: + cascadeLogicalDbs: + description: Cascading rule for related logical DBs. + $ref: '#/components/schemas/CascadeLogicalDBsRule' + CascadeLogicalDBsRule: + id: CascadeLogicalDBsRule + description: Cascading rule for related logical DBs. + type: object + properties: {} Frames: id: Frames description: Collection of frame data. @@ -1523,6 +2106,12 @@ components: machineDetails: description: Asset information specific for virtual machines. $ref: '#/components/schemas/MachineDetails' + databaseDeploymentDetails: + description: Asset information specific for database deployments. + $ref: '#/components/schemas/DatabaseDeploymentDetails' + databaseDetails: + description: Asset information specific for logical databases. + $ref: '#/components/schemas/DatabaseDetails' reportTime: description: The time the data was reported. type: string @@ -1638,7 +2227,22 @@ components: type: object properties: averageIops: - description: Average IOPS sampled over a short window. Must be non-negative. + description: >- + Optional. Average IOPS sampled over a short window. Must be + non-negative. If read or write are set, the sum of read and write + will override the value of the average_iops. + type: number + format: float + averageReadIops: + description: >- + Optional. Average read IOPS sampled over a short window. Must be + non-negative. If both read and write are zero they are ignored. + type: number + format: float + averageWriteIops: + description: >- + Optional. Average write IOPS sampled over a short window. Must be + non-negative. If both read and write are zero they are ignored. type: number format: float ReportAssetFramesResponse: @@ -1663,6 +2267,11 @@ components: Optional. The aggregation will be performed on assets that match the provided filter. type: string + showHidden: + description: >- + Optional. When this value is set to 'true,' the response will + include all assets, including those that are hidden. + type: boolean Aggregation: id: Aggregation description: >- @@ -1929,6 +2538,10 @@ components: vmUuid: description: The VM UUID. type: string + assetTitle: + description: Output only. The asset title. + readOnly: true + type: string errors: description: The list of errors detected in the row. type: array @@ -1940,6 +2553,9 @@ components: xlsxError: description: Error details for an XLSX file. $ref: '#/components/schemas/ImportRowErrorXlsxErrorDetails' + archiveError: + description: Error details for an archive file. + $ref: '#/components/schemas/ImportRowErrorArchiveErrorDetails' ImportError: id: ImportError description: >- @@ -1984,6 +2600,20 @@ components: description: The row number where the error was detected. type: integer format: int32 + ImportRowErrorArchiveErrorDetails: + id: ImportRowErrorArchiveErrorDetails + description: Error details for an archive file. + type: object + properties: + filePath: + description: >- + Output only. The file path inside the archive where the error was + detected. + readOnly: true + type: string + csvError: + description: Error details for a CSV file. + $ref: '#/components/schemas/ImportRowErrorCsvErrorDetails' ExecutionReport: id: ExecutionReport description: A resource that reports result of the import job execution. @@ -2085,6 +2715,7 @@ components: - >- CSV format created manually and following the StratoZone format. For more information, see Manually create and upload data tables. + - ZIP file with nested CSV files generated by a database collector. enum: - IMPORT_JOB_FORMAT_UNSPECIFIED - IMPORT_JOB_FORMAT_RVTOOLS_XLSX @@ -2092,6 +2723,7 @@ components: - IMPORT_JOB_FORMAT_EXPORTED_AWS_CSV - IMPORT_JOB_FORMAT_EXPORTED_AZURE_CSV - IMPORT_JOB_FORMAT_STRATOZONE_CSV + - IMPORT_JOB_FORMAT_DATABASE_ZIP createTime: description: Output only. The timestamp when the file was created. readOnly: true @@ -2500,7 +3132,7 @@ components: enumDescriptions: - Unspecified (default value). - Prefer to migrate to Google Cloud Compute Engine. - - Prefer to migrate to Google Cloud VMware Engine. + - Prefer to migrate to Google Cloud VMware Engine.6278 - Prefer to migrate to Google Cloud Sole Tenant Nodes. enum: - COMPUTE_MIGRATION_TARGET_PRODUCT_UNSPECIFIED @@ -3391,6 +4023,54 @@ components: type: array items: $ref: '#/components/schemas/Status' + Relation: + id: Relation + description: Message representing a relation between 2 resource. + type: object + properties: + name: + description: Output only. Identifier. The identifier of the relation. + readOnly: true + type: string + srcAsset: + description: Output only. The source asset name in the relation. + readOnly: true + type: string + dstAsset: + description: Output only. The destination asset name in the relation. + readOnly: true + type: string + type: + description: Optional. The type of the relation. + type: string + enumDescriptions: + - Default value. + - DBDeployment -> Database + - >- + A relation between a machine/VM and the database deployment it + hosts. + enum: + - TYPE_UNSPECIFIED + - LOGICAL_DATABASE + - DATABASE_DEPLOYMENT_HOSTING_SERVER + createTime: + description: Output only. The timestamp when the relation was created. + readOnly: true + type: string + format: google-datetime + ListRelationsResponse: + id: ListRelationsResponse + description: Response message for listing relations. + type: object + properties: + relations: + description: A list of relations. + type: array + items: + $ref: '#/components/schemas/Relation' + nextPageToken: + description: A token identifying a page of results the server should return. + type: string ListLocationsResponse: id: ListLocationsResponse description: The response message for Locations.ListLocations. @@ -4201,6 +4881,34 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/discovery_clients/methods/delete' + relations: + id: google.migrationcenter.relations + name: relations + title: Relations + methods: + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1relations~1{relationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1relations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.relations + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/relations/methods/get' + - $ref: '#/components/x-stackQL-resources/relations/methods/list' + insert: [] + update: [] + replace: [] + delete: [] paths: /v1/projects/{projectsId}/locations/{locationsId}/settings: parameters: &ref_1 @@ -4317,6 +5025,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: @@ -4471,7 +5183,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: migrationcenter.projects.locations.operations.cancel requestBody: content: @@ -4555,6 +5267,10 @@ paths: name: view schema: type: string + - in: query + name: showHidden + schema: + type: boolean /v1/projects/{projectsId}/locations/{locationsId}/assets/{assetsId}: parameters: *ref_1 get: @@ -6589,3 +7305,81 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/relations/{relationsId}: + parameters: *ref_1 + get: + description: Gets the details of an relation. + operationId: migrationcenter.projects.locations.relations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Relation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: relationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/relations: + parameters: *ref_1 + get: + description: Lists all the relations in a given project and location. + operationId: migrationcenter.projects.locations.relations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListRelationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/ml.yaml b/providers/src/googleapis.com/v00.00.00000/services/ml.yaml index 838caa14..150b6e12 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/ml.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/ml.yaml @@ -7,8 +7,8 @@ info: title: AI Platform Training & Prediction API description: An API to enable creating and using machine learning models. version: v1 - x-discovery-doc-revision: '20241026' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250823' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/ml/ servers: @@ -1790,7 +1790,7 @@ components: format: " project_id.dataset_name.table_name" The specified table must already exist, and the "Cloud ML Service Agent" for your project must have permission to write to it. The table must have the - following [schema](/bigquery/docs/schemas): Field nameType Mode + following [schema](/bigquery/docs/schemas): Field name Type Mode model STRING REQUIRED model_version STRING REQUIRED time TIMESTAMP REQUIRED raw_data STRING REQUIRED raw_prediction STRING NULLABLE groundtruth STRING NULLABLE @@ -4343,7 +4343,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: ml.projects.locations.operations.cancel security: - Oauth2: @@ -4986,7 +4986,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: ml.projects.operations.cancel security: - Oauth2: diff --git a/providers/src/googleapis.com/v00.00.00000/services/monitoring.yaml b/providers/src/googleapis.com/v00.00.00000/services/monitoring.yaml index 89dbbf1e..840ffa67 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/monitoring.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/monitoring.yaml @@ -7,8 +7,8 @@ info: title: Cloud Monitoring API description: Manages your Cloud Monitoring data and configurations. version: v3 - x-discovery-doc-revision: '20241024' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250814' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/monitoring/api/ servers: @@ -543,6 +543,13 @@ components: metric types, or a unit is absent), then unit will be "{not_a_unit}". type: string + unreachable: + description: >- + Cloud regions that were unreachable which may have caused incomplete + data to be returned. + type: array + items: + type: string TimeSeries: id: TimeSeries description: >- @@ -1674,14 +1681,14 @@ components: format: double duration: description: >- - The amount of time that a time series must violate the threshold to - be considered failing. Currently, only values that are a multiple of - a minute--e.g., 0, 60, 120, or 300 seconds--are supported. If an - invalid value is given, an error will be returned. When choosing a - duration, it is useful to keep in mind the frequency of the - underlying time series data (which may also be affected by any - alignments specified in the aggregations field); a good duration is - long enough so that a single outlier does not generate spurious + Required. The amount of time that a time series must violate the + threshold to be considered failing. Currently, only values that are + a multiple of a minute--e.g., 0, 60, 120, or 300 seconds--are + supported. If an invalid value is given, an error will be returned. + When choosing a duration, it is useful to keep in mind the frequency + of the underlying time series data (which may also be affected by + any alignments specified in the aggregations field); a good duration + is long enough so that a single outlier does not generate spurious alerts, but short enough that unhealthy states are detected and alerted on quickly. type: string @@ -2114,11 +2121,11 @@ components: $ref: '#/components/schemas/Aggregation' duration: description: >- - The amount of time that a time series must fail to report new data - to be considered failing. The minimum value of this field is 120 - seconds. Larger values that are a multiple of a minute--for example, - 240 or 300 seconds--are supported. If an invalid value is given, an - error will be returned. The Duration.nanos field is ignored. + Required. The amount of time that a time series must fail to report + new data to be considered failing. The minimum value of this field + is 120 seconds. Larger values that are a multiple of a minute--for + example, 240 or 300 seconds--are supported. If an invalid value is + given, an error will be returned. type: string format: google-duration trigger: @@ -2172,16 +2179,16 @@ components: type: string duration: description: >- - The amount of time that a time series must violate the threshold to - be considered failing. Currently, only values that are a multiple of - a minute--e.g., 0, 60, 120, or 300 seconds--are supported. If an - invalid value is given, an error will be returned. When choosing a - duration, it is useful to keep in mind the frequency of the - underlying time series data (which may also be affected by any - alignments specified in the aggregations field); a good duration is - long enough so that a single outlier does not generate spurious + Optional. The amount of time that a time series must violate the + threshold to be considered failing. Currently, only values that are + a multiple of a minute--e.g., 0, 60, 120, or 300 seconds--are + supported. If an invalid value is given, an error will be returned. + When choosing a duration, it is useful to keep in mind the frequency + of the underlying time series data (which may also be affected by + any alignments specified in the aggregations field); a good duration + is long enough so that a single outlier does not generate spurious alerts, but short enough that unhealthy states are detected and - alerted on quickly. + alerted on quickly. The default value is zero. type: string format: google-duration trigger: @@ -2308,6 +2315,15 @@ components: (https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels). This field may not exceed 2048 Unicode characters in length. type: string + disableMetricValidation: + description: >- + Optional. Whether to disable metric existence validation for this + condition.This allows alerting policies to be defined on metrics + that do not yet exist, improving advanced customer workflows such as + configuring alerting policies using Terraform.Users with the + monitoring.alertPolicyViewer role are able to see the name of the + non-existent metric in the alerting policy condition. + type: boolean SqlCondition: id: SqlCondition description: >- @@ -2323,10 +2339,10 @@ components: try to filter the input by time. A filter will automatically be applied to filter the input so that the query receives all rows received since the last time the query was run.For example, the - following query extracts all log entries containing an HTTP - request:SELECT timestamp, log_name, severity, http_request, - resource, labels FROM my-project.global._Default._AllLogs WHERE - http_request IS NOT NULL + following query extracts all log entries containing an HTTP request: + SELECT timestamp, log_name, severity, http_request, resource, labels + FROM my-project.global._Default._AllLogs WHERE http_request IS NOT + NULL type: string minutes: description: Schedule the query to execute every so many minutes. @@ -3900,10 +3916,32 @@ components: The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze - creation. + creation. Exactly 1 alert policy is required if filter is specified + at the same time. type: array items: type: string + filter: + description: >- + Optional. When you define a snooze, you can also define a filter for + that snooze. The filter is a string containing one or more key-value + pairs. The string uses the standard https://google.aip.dev/160 + filter syntax. If you define a filter for a snooze, then the snooze + can only apply to one alert policy. When the snooze is active, + incidents won't be created when the incident would have key-value + pairs (labels) that match those specified by the filter in the + snooze.Snooze filters support resource, metric, and metadata labels. + If multiple labels are used, then they must be connected with an AND + operator. For example, the following filter applies the snooze to + incidents that have a resource label with an instance ID of + 1234567890, a metric label with an instance name of test_group, a + metadata user label with a key of foo and a value of bar, and a + metadata system label with a key of region and a value of + us-central1: "filter": "resource.labels.instance_id=\"1234567890\" + AND metric.labels.instance_name=\"test_group\" AND + metadata.user_labels.foo=\"bar\" AND + metadata.system_labels.region=\"us-central1\"" + type: string ListSnoozesResponse: id: ListSnoozesResponse description: >- @@ -4036,6 +4074,9 @@ components: - CHECKER_TYPE_UNSPECIFIED - STATIC_IP_CHECKERS - VPC_CHECKERS + disabled: + description: Whether the check is disabled or not. + type: boolean selectedRegions: description: >- The list of regions from which the check will be run. Some regions @@ -4080,6 +4121,11 @@ components: - USA_OREGON - USA_IOWA - USA_VIRGINIA + logCheckFailures: + description: >- + To specify whether to log the results of failed probes to Cloud + Logging. + type: boolean isInternal: description: >- If this is true, then checks are made only from the @@ -4623,7 +4669,12 @@ components: type: string Type: id: Type - description: A protocol buffer message type. + description: >- + A protocol buffer message type.New usages of this message as an + alternative to DescriptorProto are strongly discouraged. This message + does not reliability preserve all information necessary to model the + schema and preserve semantics. Instead make use of FileDescriptorSet + which preserves the necessary information. type: object properties: name: @@ -4665,7 +4716,12 @@ components: type: string Field: id: Field - description: A single field of a message type. + description: >- + A single field of a message type.New usages of this message as an + alternative to FieldDescriptorProto are strongly discouraged. This + message does not reliability preserve all information necessary to model + the schema and preserve semantics. Instead make use of FileDescriptorSet + which preserves the necessary information. type: object properties: kind: @@ -4763,7 +4819,10 @@ components: id: Option description: >- A protocol buffer option, which can be attached to a message, field, - enumeration, etc. + enumeration, etc.New usages of this message as an alternative to + FileOptions, MessageOptions, FieldOptions, EnumOptions, + EnumValueOptions, ServiceOptions, or MethodOptions are strongly + discouraged. type: object properties: name: @@ -5709,6 +5768,10 @@ paths: name: pageToken schema: type: string + - in: query + name: activeOnly + schema: + type: boolean post: description: >- Creates a new metric descriptor. The creation is executed diff --git a/providers/src/googleapis.com/v00.00.00000/services/netapp.yaml b/providers/src/googleapis.com/v00.00.00000/services/netapp.yaml index d88c2b61..3ec95a64 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/netapp.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/netapp.yaml @@ -10,8 +10,8 @@ info: service that provides advanced data management capabilities and highly scalable performance with global availability. version: v1 - x-discovery-doc-revision: '20241023' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250825' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/netapp/ servers: @@ -37,55 +37,6 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - ListLocationsResponse: - id: ListLocationsResponse - description: The response message for Locations.ListLocations. - type: object - properties: - locations: - description: >- - A list of locations that matches the specified filter in the - request. - type: array - items: - $ref: '#/components/schemas/Location' - nextPageToken: - description: The standard List next-page token. - type: string - Location: - id: Location - description: A resource that represents a Google Cloud location. - type: object - properties: - name: - description: >- - Resource name for the location, which may vary between - implementations. For example: - `"projects/example-project/locations/us-east1"` - type: string - locationId: - description: 'The canonical id for this location. For example: `"us-east1"`.' - type: string - displayName: - description: >- - The friendly name for this location, typically a nearby city name. - For example, "Tokyo". - type: string - labels: - description: >- - Cross-service attributes for the location. For example - {"cloud.googleapis.com/region": "us-east1"} - type: object - additionalProperties: - type: string - metadata: - description: >- - Service-specific metadata. For example the available capacity at the - given location. - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. ListOperationsResponse: id: ListOperationsResponse description: The response message for Operations.ListOperations. @@ -347,6 +298,76 @@ components: zone: description: Optional. Specifies the active zone for regional storagePool. type: string + satisfiesPzs: + description: Output only. Reserved for future use + readOnly: true + type: boolean + satisfiesPzi: + description: Output only. Reserved for future use + readOnly: true + type: boolean + customPerformanceEnabled: + description: >- + Optional. True if using Independent Scaling of capacity and + performance (Hyperdisk) By default set to false + type: boolean + totalThroughputMibps: + description: Optional. Custom Performance Total Throughput of the pool (in MiBps) + type: string + format: int64 + totalIops: + description: >- + Optional. Custom Performance Total IOPS of the pool if not provided, + it will be calculated based on the total_throughput_mibps + type: string + format: int64 + hotTierSizeGib: + description: >- + Optional. Total hot tier capacity for the Storage Pool. It is + applicable only to Flex service level. It should be less than the + minimum storage pool size and cannot be more than the current + storage pool size. It cannot be decreased once set. + type: string + format: int64 + enableHotTierAutoResize: + description: >- + Optional. Flag indicating that the hot-tier threshold will be + auto-increased by 10% of the hot-tier when it hits 100%. Default is + true. The increment will kick in only if the new size after + increment is still less than or equal to storage pool size. + type: boolean + qosType: + description: Optional. QoS (Quality of Service) Type of the storage pool + type: string + enumDescriptions: + - Unspecified QoS Type + - QoS Type is Auto + - QoS Type is Manual + enum: + - QOS_TYPE_UNSPECIFIED + - AUTO + - MANUAL + availableThroughputMibps: + description: Output only. Available throughput of the storage pool (in MiB/s). + readOnly: true + type: number + format: double + ValidateDirectoryServiceRequest: + id: ValidateDirectoryServiceRequest + description: >- + ValidateDirectoryServiceRequest validates the directory service policy + attached to the storage pool. + type: object + properties: + directoryServiceType: + description: Type of directory service policy attached to the storage pool. + type: string + enumDescriptions: + - Directory service type is not specified. + - Active directory policy attached to the storage pool. + enum: + - DIRECTORY_SERVICE_TYPE_UNSPECIFIED + - ACTIVE_DIRECTORY SwitchActiveReplicaZoneRequest: id: SwitchActiveReplicaZoneRequest description: >- @@ -393,6 +414,12 @@ components: - Volume State is Restoring - Volume State is Disabled - Volume State is Error + - >- + Volume State is Preparing. Note that this is different from + CREATING where CREATING means the volume is being created, while + PREPARING means the volume is created and now being prepared for + the replication. + - Volume State is Read Only enum: - STATE_UNSPECIFIED - READY @@ -402,6 +429,8 @@ components: - RESTORING - DISABLED - ERROR + - PREPARING + - READ_ONLY stateDetails: description: Output only. State details of the volume readOnly: true @@ -626,10 +655,19 @@ components: readOnly: true type: string coldTierSizeGib: - description: Output only. Size of the volume cold tier data in GiB. + description: >- + Output only. Size of the volume cold tier data rounded down to the + nearest GiB. readOnly: true type: string format: int64 + hybridReplicationParameters: + description: Optional. The Hybrid Replication parameters for the volume. + $ref: '#/components/schemas/HybridReplicationParameters' + throughputMibps: + description: Optional. Throughput of the volume (in MiB/s) + type: number + format: double ExportPolicy: id: ExportPolicy description: Defines the export policy for the volume. @@ -736,6 +774,10 @@ components: instructions: description: Instructions for mounting type: string + ipAddress: + description: Output only. IP Address. + readOnly: true + type: string SnapshotPolicy: id: SnapshotPolicy description: Snapshot Policy for a volume. @@ -910,10 +952,94 @@ components: coolingThresholdDays: description: >- Optional. Time in days to mark the volume's data block as cold and - make it eligible for tiering, can be range from 7-183. Default is + make it eligible for tiering, can be range from 2-183. Default is 31. type: integer format: int32 + hotTierBypassModeEnabled: + description: >- + Optional. Flag indicating that the hot tier bypass mode is enabled. + Default is false. This is only applicable to Flex service level. + type: boolean + HybridReplicationParameters: + id: HybridReplicationParameters + description: The Hybrid Replication parameters for the volume. + type: object + properties: + replication: + description: Required. Desired name for the replication of this volume. + type: string + peerVolumeName: + description: >- + Required. Name of the user's local source volume to be peered with + the destination volume. + type: string + peerClusterName: + description: >- + Required. Name of the user's local source cluster to be peered with + the destination cluster. + type: string + peerSvmName: + description: >- + Required. Name of the user's local source vserver svm to be peered + with the destination vserver svm. + type: string + peerIpAddresses: + description: Required. List of node ip addresses to be peered with. + type: array + items: + type: string + clusterLocation: + description: >- + Optional. Name of source cluster location associated with the Hybrid + replication. This is a free-form field for the display purpose only. + type: string + description: + description: Optional. Description of the replication. + type: string + labels: + description: >- + Optional. Labels to be added to the replication as the key value + pairs. + type: object + additionalProperties: + type: string + replicationSchedule: + description: Optional. Replication Schedule for the replication created. + type: string + enumDescriptions: + - Unspecified HybridReplicationSchedule + - Replication happens once every 10 minutes. + - Replication happens once every hour. + - Replication happens once every day. + enum: + - HYBRID_REPLICATION_SCHEDULE_UNSPECIFIED + - EVERY_10_MINUTES + - HOURLY + - DAILY + hybridReplicationType: + description: Optional. Type of the hybrid replication. + type: string + enumDescriptions: + - Unspecified hybrid replication type. + - Hybrid replication type for migration. + - Hybrid replication type for continuous replication. + - >- + New field for reversible OnPrem replication, to be used for data + protection. + - >- + New field for reversible OnPrem replication, to be used for data + protection. + enum: + - VOLUME_HYBRID_REPLICATION_TYPE_UNSPECIFIED + - MIGRATION + - CONTINUOUS_REPLICATION + - ONPREM_REPLICATION + - REVERSE_ONPREM_REPLICATION + largeVolumeConstituentCount: + description: Optional. Constituent volume count for large volume. + type: integer + format: int32 RevertVolumeRequest: id: RevertVolumeRequest description: RevertVolumeRequest reverts the given volume to the specified snapshot. @@ -1312,6 +1438,14 @@ components: - Replication is updating. - Replication is deleting. - Replication is in error state. + - Replication is waiting for cluster peering to be established. + - Replication is waiting for SVM peering to be established. + - >- + Replication is waiting for Commands to be executed on Onprem + ONTAP. + - >- + Onprem ONTAP is destination and Replication can only be managed + from Onprem. enum: - STATE_UNSPECIFIED - CREATING @@ -1319,6 +1453,10 @@ components: - UPDATING - DELETING - ERROR + - PENDING_CLUSTER_PEERING + - PENDING_SVM_PEERING + - PENDING_REMOTE_RESYNC + - EXTERNALLY_MANAGED_REPLICATION stateDetails: description: Output only. State details of the replication. readOnly: true @@ -1360,12 +1498,20 @@ components: replication transfers. - Destination volume is not receiving replication transfers. - Incremental replication is in progress. + - Baseline replication is in progress. + - Replication is aborted. + - Replication is being managed from Onprem ONTAP. + - Peering is yet to be established. enum: - MIRROR_STATE_UNSPECIFIED - PREPARING - MIRRORED - STOPPED - TRANSFERRING + - BASELINE_TRANSFERRING + - ABORTED + - EXTERNALLY_MANAGED + - PENDING_PEERING healthy: description: >- Output only. Condition of the relationship. Can be one of the @@ -1407,6 +1553,39 @@ components: "projects/{project}/locations/{location}/volumes/{volume_id}" readOnly: true type: string + hybridPeeringDetails: + description: Output only. Hybrid peering details. + readOnly: true + $ref: '#/components/schemas/HybridPeeringDetails' + clusterLocation: + description: Optional. Location of the user cluster. + type: string + hybridReplicationType: + description: Output only. Type of the hybrid replication. + readOnly: true + type: string + enumDescriptions: + - Unspecified hybrid replication type. + - Hybrid replication type for migration. + - Hybrid replication type for continuous replication. + - >- + New field for reversible OnPrem replication, to be used for data + protection. + - >- + Hybrid replication type for incremental Transfer in the reverse + direction (GCNV is source and Onprem is destination) + enum: + - HYBRID_REPLICATION_TYPE_UNSPECIFIED + - MIGRATION + - CONTINUOUS_REPLICATION + - ONPREM_REPLICATION + - REVERSE_ONPREM_REPLICATION + hybridReplicationUserCommands: + description: >- + Output only. Copy pastable snapmirror commands to be executed on + onprem cluster by the customer. + readOnly: true + $ref: '#/components/schemas/UserCommands' TransferStats: id: TransferStats description: TransferStats reports all statistics related to replication transfer. @@ -1414,8 +1593,8 @@ components: properties: transferBytes: description: >- - Cumulative bytes trasferred so far for the replication - relatinonship. + Cumulative bytes transferred so far for the replication + relationship. type: string format: int64 totalTransferDuration: @@ -1474,6 +1653,66 @@ components: description: description: Description for the destination volume. type: string + tieringPolicy: + description: Optional. Tiering policy for the volume. + $ref: '#/components/schemas/TieringPolicy' + HybridPeeringDetails: + id: HybridPeeringDetails + description: HybridPeeringDetails contains details about the hybrid peering. + type: object + properties: + subnetIp: + description: Output only. IP address of the subnet. + readOnly: true + type: string + command: + description: >- + Output only. Copy-paste-able commands to be used on user's ONTAP to + accept peering requests. + readOnly: true + type: string + commandExpiryTime: + description: >- + Output only. Expiration time for the peering command to be executed + on user's ONTAP. + readOnly: true + type: string + format: google-datetime + passphrase: + description: >- + Output only. Temporary passphrase generated to accept cluster + peering command. + readOnly: true + type: string + peerVolumeName: + description: >- + Output only. Name of the user's local source volume to be peered + with the destination volume. + readOnly: true + type: string + peerClusterName: + description: >- + Output only. Name of the user's local source cluster to be peered + with the destination cluster. + readOnly: true + type: string + peerSvmName: + description: >- + Output only. Name of the user's local source vserver svm to be + peered with the destination vserver svm. + readOnly: true + type: string + UserCommands: + id: UserCommands + description: UserCommands contains the commands to be executed by the customer. + type: object + properties: + commands: + description: Output only. List of commands to be executed by the customer. + readOnly: true + type: array + items: + type: string StopReplicationRequest: id: StopReplicationRequest description: StopReplicationRequest stops a replication until resumed. @@ -1499,6 +1738,38 @@ components: Source becomes destination and destination becomes source. type: object properties: {} + EstablishPeeringRequest: + id: EstablishPeeringRequest + description: >- + EstablishPeeringRequest establishes cluster and svm peerings between the + source and the destination replications. + type: object + properties: + peerClusterName: + description: >- + Required. Name of the user's local source cluster to be peered with + the destination cluster. + type: string + peerSvmName: + description: >- + Required. Name of the user's local source vserver svm to be peered + with the destination vserver svm. + type: string + peerIpAddresses: + description: Optional. List of IPv4 ip addresses to be used for peering. + type: array + items: + type: string + peerVolumeName: + description: >- + Required. Name of the user's local source volume to be peered with + the destination volume. + type: string + SyncReplicationRequest: + id: SyncReplicationRequest + description: SyncReplicationRequest syncs the replication from source to destination. + type: object + properties: {} BackupVault: id: BackupVault description: A NetApp BackupVault. @@ -1540,6 +1811,80 @@ components: type: object additionalProperties: type: string + backupVaultType: + description: Optional. Type of backup vault to be created. Default is IN_REGION. + type: string + enumDescriptions: + - BackupVault type not set. + - BackupVault type is IN_REGION. + - BackupVault type is CROSS_REGION. + enum: + - BACKUP_VAULT_TYPE_UNSPECIFIED + - IN_REGION + - CROSS_REGION + sourceRegion: + description: >- + Output only. Region in which the backup vault is created. Format: + `projects/{project_id}/locations/{location}` + readOnly: true + type: string + backupRegion: + description: >- + Optional. Region where the backups are stored. Format: + `projects/{project_id}/locations/{location}` + type: string + sourceBackupVault: + description: >- + Output only. Name of the Backup vault created in source region. + Format: + `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}` + readOnly: true + type: string + destinationBackupVault: + description: >- + Output only. Name of the Backup vault created in backup region. + Format: + `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}` + readOnly: true + type: string + backupRetentionPolicy: + description: Optional. Backup retention policy defining the retenton of backups. + $ref: '#/components/schemas/BackupRetentionPolicy' + BackupRetentionPolicy: + id: BackupRetentionPolicy + description: Retention policy for backups in the backup vault + type: object + properties: + backupMinimumEnforcedRetentionDays: + description: >- + Required. Minimum retention duration in days for backups in the + backup vault. + type: integer + format: int32 + dailyBackupImmutable: + description: >- + Optional. Indicates if the daily backups are immutable. At least one + of daily_backup_immutable, weekly_backup_immutable, + monthly_backup_immutable and manual_backup_immutable must be true. + type: boolean + weeklyBackupImmutable: + description: >- + Optional. Indicates if the weekly backups are immutable. At least + one of daily_backup_immutable, weekly_backup_immutable, + monthly_backup_immutable and manual_backup_immutable must be true. + type: boolean + monthlyBackupImmutable: + description: >- + Optional. Indicates if the monthly backups are immutable. At least + one of daily_backup_immutable, weekly_backup_immutable, + monthly_backup_immutable and manual_backup_immutable must be true. + type: boolean + manualBackupImmutable: + description: >- + Optional. Indicates if the manual backups are immutable. At least + one of daily_backup_immutable, weekly_backup_immutable, + monthly_backup_immutable and manual_backup_immutable must be true. + type: boolean ListBackupVaultsResponse: id: ListBackupVaultsResponse description: ListBackupVaultsResponse is the result of ListBackupVaultsRequest. @@ -1653,6 +1998,31 @@ components: readOnly: true type: string format: int64 + satisfiesPzs: + description: Output only. Reserved for future use + readOnly: true + type: boolean + satisfiesPzi: + description: Output only. Reserved for future use + readOnly: true + type: boolean + volumeRegion: + description: >- + Output only. Region of the volume from which the backup was created. + Format: `projects/{project_id}/locations/{location}` + readOnly: true + type: string + backupRegion: + description: >- + Output only. Region in which backup is stored. Format: + `projects/{project_id}/locations/{location}` + readOnly: true + type: string + enforcedRetentionEndTime: + description: Output only. The time until which the backup is not deletable. + readOnly: true + type: string + format: google-datetime ListBackupsResponse: id: ListBackupsResponse description: ListBackupsResponse is the result of ListBackupsRequest. @@ -1763,32 +2133,171 @@ components: type: array items: type: string - OperationMetadata: - id: OperationMetadata - description: Represents the metadata of the long-running operation. + ListQuotaRulesResponse: + id: ListQuotaRulesResponse + description: ListQuotaRulesResponse is the response to a ListQuotaRulesRequest. type: object properties: - createTime: - description: Output only. The time the operation was created. - readOnly: true + quotaRules: + description: List of quota rules + type: array + items: + $ref: '#/components/schemas/QuotaRule' + nextPageToken: + description: A token identifying a page of results the server should return. type: string - format: google-datetime - endTime: - description: Output only. The time the operation finished running. - readOnly: true + unreachable: + description: Locations that could not be reached. + type: array + items: + type: string + QuotaRule: + id: QuotaRule + description: >- + QuotaRule specifies the maximum disk space a user or group can use + within a volume. They can be used for creating default and individual + quota rules. + type: object + properties: + name: + description: >- + Identifier. The resource name of the quota rule. Format: + `projects/{project_number}/locations/{location_id}/volumes/volumes/{volume_id}/quotaRules/{quota_rule_id}`. type: string - format: google-datetime target: description: >- - Output only. Server-defined resource path for the target of the - operation. - readOnly: true + Optional. The quota rule applies to the specified user or group, + identified by a Unix UID/GID, Windows SID, or null for default. type: string - verb: - description: Output only. Name of the verb executed by the operation. - readOnly: true + type: + description: Required. The type of quota rule. type: string - statusMessage: + enumDescriptions: + - Unspecified type for quota rule + - Individual user quota rule + - Individual group quota rule + - Default user quota rule + - Default group quota rule + enum: + - TYPE_UNSPECIFIED + - INDIVIDUAL_USER_QUOTA + - INDIVIDUAL_GROUP_QUOTA + - DEFAULT_USER_QUOTA + - DEFAULT_GROUP_QUOTA + diskLimitMib: + description: Required. The maximum allowed disk space in MiB. + type: integer + format: int32 + state: + description: Output only. State of the quota rule + readOnly: true + type: string + enumDescriptions: + - Unspecified state for quota rule + - Quota rule is creating + - Quota rule is updating + - Quota rule is deleting + - Quota rule is ready + - Quota rule is in error state. + enum: + - STATE_UNSPECIFIED + - CREATING + - UPDATING + - DELETING + - READY + - ERROR + stateDetails: + description: Output only. State details of the quota rule + readOnly: true + type: string + createTime: + description: Output only. Create time of the quota rule + readOnly: true + type: string + format: google-datetime + description: + description: Optional. Description of the quota rule + type: string + labels: + description: Optional. Labels of the quota rule + type: object + additionalProperties: + type: string + ListLocationsResponse: + id: ListLocationsResponse + description: The response message for Locations.ListLocations. + type: object + properties: + locations: + description: >- + A list of locations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/Location' + nextPageToken: + description: The standard List next-page token. + type: string + Location: + id: Location + description: A resource that represents a Google Cloud location. + type: object + properties: + name: + description: >- + Resource name for the location, which may vary between + implementations. For example: + `"projects/example-project/locations/us-east1"` + type: string + locationId: + description: 'The canonical id for this location. For example: `"us-east1"`.' + type: string + displayName: + description: >- + The friendly name for this location, typically a nearby city name. + For example, "Tokyo". + type: string + labels: + description: >- + Cross-service attributes for the location. For example + {"cloud.googleapis.com/region": "us-east1"} + type: object + additionalProperties: + type: string + metadata: + description: >- + Service-specific metadata. For example the available capacity at the + given location. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + OperationMetadata: + id: OperationMetadata + description: Represents the metadata of the long-running operation. + type: object + properties: + createTime: + description: Output only. The time the operation was created. + readOnly: true + type: string + format: google-datetime + endTime: + description: Output only. The time the operation finished running. + readOnly: true + type: string + format: google-datetime + target: + description: >- + Output only. Server-defined resource path for the target of the + operation. + readOnly: true + type: string + verb: + description: Output only. Name of the verb executed by the operation. + readOnly: true + type: string + statusMessage: description: Output only. Human-readable status of the operation, if any. readOnly: true type: string @@ -1827,6 +2336,24 @@ components: - EXTREME - STANDARD - FLEX + supportedFlexPerformance: + description: Output only. Supported flex performance in a location. + readOnly: true + type: array + items: + type: string + enumDescriptions: + - Unspecified flex performance. + - Flex Storage Pool with default performance. + - Flex Storage Pool with custom performance. + enum: + - FLEX_PERFORMANCE_UNSPECIFIED + - FLEX_PERFORMANCE_DEFAULT + - FLEX_PERFORMANCE_CUSTOM + hasVcp: + description: Output only. Indicates if the location has VCP support. + readOnly: true + type: boolean parameters: access_token: description: OAuth access token. @@ -2018,6 +2545,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + validate_directory_service: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1storagePools~1{storagePoolsId}:validateDirectoryService/post + response: + mediaType: application/json + openAPIDocKey: '200' switch: operation: $ref: >- @@ -2209,6 +2743,20 @@ components: response: mediaType: application/json openAPIDocKey: '200' + establish_peering: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1volumes~1{volumesId}~1replications~1{replicationsId}:establishPeering/post + response: + mediaType: application/json + openAPIDocKey: '200' + sync: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1volumes~1{volumesId}~1replications~1{replicationsId}:sync/post + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/replications/methods/get' @@ -2220,6 +2768,58 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/replications/methods/delete' + quota_rules: + id: google.netapp.quota_rules + name: quota_rules + title: Quota_rules + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1volumes~1{volumesId}~1quotaRules/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.quotaRules + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1volumes~1{volumesId}~1quotaRules/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1volumes~1{volumesId}~1quotaRules~1{quotaRulesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1volumes~1{volumesId}~1quotaRules~1{quotaRulesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1volumes~1{volumesId}~1quotaRules~1{quotaRulesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/quota_rules/methods/get' + - $ref: '#/components/x-stackQL-resources/quota_rules/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/quota_rules/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/quota_rules/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/quota_rules/methods/delete' active_directories: id: google.netapp.active_directories name: active_directories @@ -2542,6 +3142,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: @@ -2696,7 +3300,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: netapp.projects.locations.operations.cancel requestBody: content: @@ -2916,6 +3520,46 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}:validateDirectoryService: + parameters: *ref_1 + post: + description: >- + ValidateDirectoryService does a connectivity check for a directory + service policy attached to the storage pool. + operationId: netapp.projects.locations.storagePools.validateDirectoryService + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ValidateDirectoryServiceRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: storagePoolsId + required: true + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}:switch: parameters: *ref_1 post: @@ -3737,6 +4381,304 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/replications/{replicationsId}:establishPeering: + parameters: *ref_1 + post: + description: Establish replication peering. + operationId: netapp.projects.locations.volumes.replications.establishPeering + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EstablishPeeringRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: volumesId + required: true + schema: + type: string + - in: path + name: replicationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/replications/{replicationsId}:sync: + parameters: *ref_1 + post: + description: >- + Syncs the replication. This will invoke one time volume data transfer + from source to destination. + operationId: netapp.projects.locations.volumes.replications.sync + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SyncReplicationRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: volumesId + required: true + schema: + type: string + - in: path + name: replicationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/quotaRules: + parameters: *ref_1 + get: + description: Returns list of all quota rules in a location. + operationId: netapp.projects.locations.volumes.quotaRules.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListQuotaRulesResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: volumesId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + post: + description: Creates a new quota rule. + operationId: netapp.projects.locations.volumes.quotaRules.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QuotaRule' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: volumesId + required: true + schema: + type: string + - in: query + name: quotaRuleId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/quotaRules/{quotaRulesId}: + parameters: *ref_1 + get: + description: Returns details of the specified quota rule. + operationId: netapp.projects.locations.volumes.quotaRules.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/QuotaRule' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: volumesId + required: true + schema: + type: string + - in: path + name: quotaRulesId + required: true + schema: + type: string + patch: + description: Updates a quota rule. + operationId: netapp.projects.locations.volumes.quotaRules.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QuotaRule' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: volumesId + required: true + schema: + type: string + - in: path + name: quotaRulesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a quota rule. + operationId: netapp.projects.locations.volumes.quotaRules.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: volumesId + required: true + schema: + type: string + - in: path + name: quotaRulesId + required: true + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/activeDirectories: parameters: *ref_1 get: diff --git a/providers/src/googleapis.com/v00.00.00000/services/networkconnectivity.yaml b/providers/src/googleapis.com/v00.00.00000/services/networkconnectivity.yaml index fd3dc807..4ed3a4b0 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/networkconnectivity.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/networkconnectivity.yaml @@ -7,8 +7,8 @@ info: title: Network Connectivity API description: This API enables connectivity with and between Google Cloud resources. version: v1 - x-discovery-doc-revision: '20241030' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250819' + x-generated-date: '2025-08-28' externalDocs: url: >- https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/rest @@ -238,8 +238,8 @@ components: token: description: >- The token provided by the consumer. This token authenticates that - the consumer can create a connecton within the specified project and - network. + the consumer can create a connection within the specified project + and network. type: string etag: description: >- @@ -503,14 +503,14 @@ components: type: string metadata: description: >- - Additional structured details about this error. Keys must match - /a-z+/ but should ideally be lowerCamelCase. Also they must be - limited to 64 characters in length. When identifying the current - value of an exceeded limit, the units should be contained in the - key, not the value. For example, rather than {"instanceLimit": - "100/request"}, should be returned as, {"instanceLimitPerRequest": - "100"}, if the client exceeds the number of instances that can be - created in a single (batch) request. + Additional structured details about this error. Keys must match a + regular expression of `a-z+` but should ideally be lowerCamelCase. + Also, they must be limited to 64 characters in length. When + identifying the current value of an exceeded limit, the units should + be contained in the key, not the value. For example, rather than + `{"instanceLimit": "100/request"}`, should be returned as, + `{"instanceLimitPerRequest": "100"}`, if the client exceeds the + number of instances that can be created in a single (batch) request. type: object additionalProperties: type: string @@ -630,7 +630,7 @@ components: format: int64 producerInstanceLocation: description: >- - Required. ProducerInstanceLocation is used to specify which + Optional. ProducerInstanceLocation is used to specify which authorization mechanism to use to determine which projects the Producer instance can be within. type: string @@ -911,6 +911,327 @@ components: type: array items: type: string + ListMulticloudDataTransferConfigsResponse: + id: ListMulticloudDataTransferConfigsResponse + description: Response message for ListMulticloudDataTransferConfigs. + type: object + properties: + multicloudDataTransferConfigs: + description: MulticloudDataTransferConfigs to be returned. + type: array + items: + $ref: '#/components/schemas/MulticloudDataTransferConfig' + nextPageToken: + description: The next page token. + type: string + unreachable: + description: Locations that could not be reached. + type: array + items: + type: string + MulticloudDataTransferConfig: + id: MulticloudDataTransferConfig + description: >- + The MulticloudDataTransferConfig resource. This lists the services for + which customer is opting in for Multicloud Data Transfer. + type: object + properties: + name: + description: >- + Identifier. The name of the MulticloudDataTransferConfig resource. + Format: + `projects/{project}/locations/{location}/multicloudDataTransferConfigs/{multicloud_data_transfer_config}`. + type: string + createTime: + description: Output only. Time when the MulticloudDataTransferConfig was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. Time when the MulticloudDataTransferConfig was updated. + readOnly: true + type: string + format: google-datetime + labels: + description: Optional. User-defined labels. + type: object + additionalProperties: + type: string + etag: + description: >- + The etag is computed by the server, and may be sent on update and + delete requests to ensure the client has an up-to-date value before + proceeding. + type: string + description: + description: >- + Optional. An optional field to provide a description of this + resource. + type: string + destinationsCount: + description: >- + Output only. The number of Destinations configured under the + MulticloudDataTransferConfig resource. + readOnly: true + type: integer + format: int32 + destinationsActiveCount: + description: >- + Output only. The number of Destinations in use under the + MulticloudDataTransferConfig resource. + readOnly: true + type: integer + format: int32 + services: + description: >- + Optional. This map services to either their current or planned + states. Service names are keys, and the associated values describe + the service's state. If a state change is expected, the value will + be the list of ADDING or DELETING states depending on the actions + taken. Example: "services": { "big-query": { "states": [ { "state": + "ADDING", "effective_time": "2024-12-12T08:00:00Z" }, ] }, + "cloud-storage": { "states": [ { "state": "ACTIVE", } ] } } + type: object + additionalProperties: + $ref: '#/components/schemas/StateTimeline' + uid: + description: >- + Output only. The Google-generated UUID for the + MulticloudDataTransferConfig. This value is unique across all + MulticloudDataTransferConfig resources. If a + MulticloudDataTransferConfig is deleted and another with the same + name is created, the new MulticloudDataTransferConfig is assigned a + different uid. + readOnly: true + type: string + StateTimeline: + id: StateTimeline + description: The timeline of pending states for a resource. + type: object + properties: + states: + description: >- + Output only. The state and activation time details of the resource + state. + readOnly: true + type: array + items: + $ref: '#/components/schemas/StateMetadata' + StateMetadata: + id: StateMetadata + description: The state and activation time details of the resource state. + type: object + properties: + state: + description: Output only. The state of the resource. + readOnly: true + type: string + enumDescriptions: + - An invalid state as the default case. + - The resource is being added. + - The resource is in use. + - The resource is being deleted. + - The resource is being suspended. + - The resource is not in use for billing and is suspended. + enum: + - STATE_UNSPECIFIED + - ADDING + - ACTIVE + - DELETING + - SUSPENDING + - SUSPENDED + effectiveTime: + description: >- + Output only. This field will be accompanied only with transient + states (PENDING_ADD, PENDING_DELETE, PENDING_SUSPENSION) and denotes + the time when the transient state of the resource will be effective. + For instance, if the state is "ADDING," this field will show the + time the resource transitions to "ACTIVE." Similarly, if the state + is "PENDING_DELETE," it will show the deletion time. + readOnly: true + type: string + format: google-datetime + ListDestinationsResponse: + id: ListDestinationsResponse + description: Response message for ListDestinations. + type: object + properties: + destinations: + description: Destinations to be returned. + type: array + items: + $ref: '#/components/schemas/Destination' + nextPageToken: + description: The next page token. + type: string + unreachable: + description: Locations that could not be reached. + type: array + items: + type: string + Destination: + id: Destination + description: The Destination resource. + type: object + properties: + name: + description: >- + Identifier. The name of the Destination resource. Format: + `projects/{project}/locations/{location}/multicloudDataTransferConfigs/{multicloud_data_transfer_config}/destinations/{destination}`. + type: string + createTime: + description: Output only. Time when the Destination was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. Time when the Destination was updated. + readOnly: true + type: string + format: google-datetime + labels: + description: Optional. User-defined labels. + type: object + additionalProperties: + type: string + etag: + description: >- + The etag is computed by the server, and may be sent on update and + delete requests to ensure the client has an up-to-date value before + proceeding. + type: string + description: + description: >- + Optional. An optional field to provide a description of this + resource. + type: string + ipPrefix: + description: >- + Required. Immutable. Remote IP Prefix in the remote CSP, where the + customer's workload is located + type: string + endpoints: + description: >- + Required. Unordered list. The list of Endpoints configured for the + IP Prefix. + type: array + items: + $ref: '#/components/schemas/DestinationEndpoint' + stateTimeline: + description: >- + Output only. The timeline of the expected Destination states or the + current rest state. If a state change is expected, the value will be + the list of ADDING, DELETING or SUSPENDING statesdepending on the + actions taken. Example: "state_timeline": { "states": [ { "state": + "ADDING", // The time when the Destination will be activated. + "effective_time": "2024-12-01T08:00:00Z" }, { "state": "SUSPENDING", + // The time when the Destination will be suspended. + "effective_time": "2024-12-01T20:00:00Z" } ] } + readOnly: true + $ref: '#/components/schemas/StateTimeline' + uid: + description: >- + Output only. The Google-generated UUID for the destination. This + value is unique across all destination resources. If a destination + is deleted and another with the same name is created, the new + destination is assigned a different uid. + readOnly: true + type: string + DestinationEndpoint: + id: DestinationEndpoint + description: The metadata for a DestinationEndpoint. + type: object + properties: + asn: + description: Required. The ASN of the remote IP Prefix. + type: string + format: int64 + csp: + description: Required. The name of the CSP of the remote IP Prefix. + type: string + state: + description: Output only. The state of the Endpoint. + readOnly: true + type: string + enumDescriptions: + - An invalid state as the default case. + - The Endpoint is valid. + - The Endpoint is invalid. + enum: + - STATE_UNSPECIFIED + - VALID + - INVALID + updateTime: + description: Output only. Time when the DestinationEndpoint was updated. + readOnly: true + type: string + format: google-datetime + MulticloudDataTransferSupportedService: + id: MulticloudDataTransferSupportedService + description: The supported service for Multicloud Data Transfer. + type: object + properties: + name: + description: Identifier. The name of the service. + type: string + serviceConfigs: + description: Output only. The network service tiers supported for the service. + readOnly: true + type: array + items: + $ref: '#/components/schemas/ServiceConfig' + ServiceConfig: + id: ServiceConfig + description: >- + Specifies the Multicloud Data Transfer supported services configuration. + This includes either the network tier or the request endpoint. If end of + support for multicloud data transfer is planned for a service's network + tier or request endpoint, the end time will be provided. + type: object + properties: + eligibilityCriteria: + description: >- + Output only. The eligibility criteria for the service. The user has + to meet the eligibility criteria specified here for the service to + qualify for multicloud data transfer. + readOnly: true + type: string + enumDescriptions: + - An invalid eligibility criteria as the default case. + - >- + The service is eligible for multicloud data transfer only for the + premium network tier. + - >- + The service is eligible for multicloud data transfer only for the + standard network tier. + - >- + The service is eligible for multicloud data transfer only for the + regional endpoint. + enum: + - ELIGIBILITY_CRITERIA_UNSPECIFIED + - NETWORK_SERVICE_TIER_PREMIUM_ONLY + - NETWORK_SERVICE_TIER_STANDARD_ONLY + - REQUEST_ENDPOINT_REGIONAL_ENDPOINT_ONLY + supportEndTime: + description: >- + Output only. The eligibility criteria support end time. If the end + time is not specified, no planned end time is available. + readOnly: true + type: string + format: google-datetime + ListMulticloudDataTransferSupportedServicesResponse: + id: ListMulticloudDataTransferSupportedServicesResponse + description: Response message for ListMulticloudDataTransferSupportedServices. + type: object + properties: + multicloudDataTransferSupportedServices: + description: The list of supported services. + type: array + items: + $ref: '#/components/schemas/MulticloudDataTransferSupportedService' + nextPageToken: + description: The next page token. + type: string ListHubsResponse: id: ListHubsResponse description: Response for HubService.ListHubs method. @@ -968,7 +1289,7 @@ components: additionalProperties: type: string description: - description: An optional description of the hub. + description: Optional. An optional description of the hub. type: string uniqueId: description: >- @@ -994,6 +1315,10 @@ components: - >- The hub associated with this spoke resource has been deleted. This state applies to spoke resources only. + - >- + The resource is in an undefined state due to resource creation or + deletion failure. You can try to delete the resource later or + contact support for help. enum: - STATE_UNSPECIFIED - CREATING @@ -1004,11 +1329,13 @@ components: - UPDATING - INACTIVE - OBSOLETE + - FAILED routingVpcs: description: >- - The VPC networks associated with this hub's spokes. This field is - read-only. Network Connectivity Center automatically populates it - based on the set of spokes attached to the hub. + Output only. The VPC networks associated with this hub's spokes. + This field is read-only. Network Connectivity Center automatically + populates it based on the set of spokes attached to the hub. + readOnly: true type: array items: $ref: '#/components/schemas/RoutingVPC' @@ -1071,10 +1398,10 @@ components: - STAR exportPsc: description: >- - Optional. Whether Private Service Connect transitivity is enabled - for the hub. If true, Private Service Connect endpoints in VPC - spokes attached to the hub are made accessible to other VPC spokes - attached to the hub. The default value is false. + Optional. Whether Private Service Connect connection propagation is + enabled for the hub. If true, Private Service Connect endpoints in + VPC spokes attached to the hub are made accessible to other VPC + spokes attached to the hub. The default value is false. type: boolean RoutingVPC: id: RoutingVPC @@ -1185,6 +1512,10 @@ components: - >- The hub associated with this spoke resource has been deleted. This state applies to spoke resources only. + - >- + The resource is in an undefined state due to resource creation or + deletion failure. You can try to delete the resource later or + contact support for help. enum: - STATE_UNSPECIFIED - CREATING @@ -1195,6 +1526,7 @@ components: - UPDATING - INACTIVE - OBSOLETE + - FAILED count: description: >- Output only. The total number of spokes that are in this state and @@ -1300,7 +1632,7 @@ components: additionalProperties: type: string description: - description: An optional description of the spoke. + description: Optional. An optional description of the spoke. type: string hub: description: Immutable. The name of the hub that this spoke is attached to. @@ -1309,13 +1641,15 @@ components: description: Optional. The name of the group that this spoke is associated with. type: string linkedVpnTunnels: - description: VPN tunnels that are associated with the spoke. + description: Optional. VPN tunnels that are associated with the spoke. $ref: '#/components/schemas/LinkedVpnTunnels' linkedInterconnectAttachments: - description: VLAN attachments that are associated with the spoke. + description: Optional. VLAN attachments that are associated with the spoke. $ref: '#/components/schemas/LinkedInterconnectAttachments' linkedRouterApplianceInstances: - description: Router appliance instances that are associated with the spoke. + description: >- + Optional. Router appliance instances that are associated with the + spoke. $ref: '#/components/schemas/LinkedRouterApplianceInstances' linkedVpcNetwork: description: Optional. VPC network that is associated with the spoke. @@ -1347,6 +1681,10 @@ components: - >- The hub associated with this spoke resource has been deleted. This state applies to spoke resources only. + - >- + The resource is in an undefined state due to resource creation or + deletion failure. You can try to delete the resource later or + contact support for help. enum: - STATE_UNSPECIFIED - CREATING @@ -1357,6 +1695,7 @@ components: - UPDATING - INACTIVE - OBSOLETE + - FAILED reasons: description: Output only. The reasons for current state of the spoke. readOnly: true @@ -1381,6 +1720,19 @@ components: - ROUTER_APPLIANCE - VPC_NETWORK - PRODUCER_VPC_NETWORK + etag: + description: >- + Optional. This checksum is computed by the server based on the value + of other fields, and may be sent on update and delete requests to + ensure the client has an up-to-date value before proceeding. + type: string + fieldPathsPendingUpdate: + description: >- + Optional. The list of fields waiting for hub administration's + approval. + type: array + items: + type: string LinkedVpnTunnels: id: LinkedVpnTunnels description: >- @@ -1407,9 +1759,8 @@ components: type: string includeImportRanges: description: >- - Optional. IP ranges allowed to be included during import from hub - (does not control transit connectivity). The only allowed value for - now is "ALL_IPV4_RANGES". + Optional. Hub routes fully encompassed by include import ranges are + included during import from hub. type: array items: type: string @@ -1441,9 +1792,8 @@ components: type: string includeImportRanges: description: >- - Optional. IP ranges allowed to be included during import from hub - (does not control transit connectivity). The only allowed value for - now is "ALL_IPV4_RANGES". + Optional. Hub routes fully encompassed by include import ranges are + included during import from hub. type: array items: type: string @@ -1475,9 +1825,8 @@ components: type: string includeImportRanges: description: >- - Optional. IP ranges allowed to be included during import from hub - (does not control transit connectivity). The only allowed value for - now is "ALL_IPV4_RANGES". + Optional. Hub routes fully encompassed by include import ranges are + included during import from hub. type: array items: type: string @@ -1516,11 +1865,31 @@ components: type: array items: type: string + proposedIncludeExportRanges: + description: >- + Output only. The proposed include export IP ranges waiting for hub + administration's approval. + readOnly: true + type: array + items: + type: string + proposedExcludeExportRanges: + description: >- + Output only. The proposed exclude export IP ranges waiting for hub + administration's approval. + readOnly: true + type: array + items: + type: string producerVpcSpokes: description: >- Output only. The list of Producer VPC spokes that this VPC spoke is a service consumer VPC spoke for. These producer VPCs are connected - through VPC peering to this spoke's backing VPC network. + through VPC peering to this spoke's backing VPC network. Because + they are directly connected through VPC peering, NCC export filters + do not apply between the service consumer VPC spoke and any of its + producer VPC spokes. This VPC spoke cannot be deleted as long as any + of these producer VPC spokes are connected to the NCC Hub. readOnly: true type: array items: @@ -1560,6 +1929,22 @@ components: type: array items: type: string + proposedIncludeExportRanges: + description: >- + Output only. The proposed include export IP ranges waiting for hub + administration's approval. + readOnly: true + type: array + items: + type: string + proposedExcludeExportRanges: + description: >- + Output only. The proposed exclude export IP ranges waiting for hub + administration's approval. + readOnly: true + type: array + items: + type: string StateReason: id: StateReason description: The reason a spoke is inactive. @@ -1616,24 +2001,31 @@ components: type: string HubStatusEntry: id: HubStatusEntry - description: The hub status entry. + description: >- + A hub status entry represents the status of a set of propagated Private + Service Connect connections grouped by certain fields. type: object properties: count: description: >- - The number of status. If group_by is not set in the request, the - default is 1. + The number of propagated Private Service Connect connections with + this status. If the `group_by` field was not set in the request + message, the value of this field is 1. type: integer format: int32 groupBy: - description: The same group_by field from the request. + description: >- + The fields that this entry is grouped by. This has the same value as + the `group_by` field in the request message. type: string pscPropagationStatus: - description: The PSC propagation status. + description: The Private Service Connect propagation status. $ref: '#/components/schemas/PscPropagationStatus' PscPropagationStatus: id: PscPropagationStatus - description: The PSC propagation status in a hub. + description: >- + The status of one or more propagated Private Service Connect connections + in a hub. type: object properties: sourceSpoke: @@ -1656,25 +2048,28 @@ components: type: string enumDescriptions: - The code is unspecified. - - The propagated PSC connection is ready. - - PSC connection is propagating. This is a transient state. + - The propagated Private Service Connect connection is ready. - >- - The PSC connection propagation failed because the VPC network or - the project of the target spoke has exceeded the connection limit - set by the producer. + The Private Service Connect connection is propagating. This is a + transient state. - >- - The PSC connection propagation failed because the NAT IP subnet - space has been exhausted. It is equivalent to the `Needs - attention` status of the PSC connection. See + The Private Service Connect connection propagation failed because + the VPC network or the project of the target spoke has exceeded + the connection limit set by the producer. + - >- + The Private Service Connect connection propagation failed because + the NAT IP subnet space has been exhausted. It is equivalent to + the `Needs attention` status of the Private Service Connect + connection. See https://cloud.google.com/vpc/docs/about-accessing-vpc-hosted-services-endpoints#connection-statuses. - >- - PSC connection propagation failed because the - `PSC_ILB_CONSUMER_FORWARDING_RULES_PER_PRODUCER_NETWORK` quota in - the producer VPC network has been exceeded. + The Private Service Connect connection propagation failed because + the `PSC_ILB_CONSUMER_FORWARDING_RULES_PER_PRODUCER_NETWORK` quota + in the producer VPC network has been exceeded. - >- - The PSC connection propagation failed because the - `PSC_PROPAGATED_CONNECTIONS_PER_VPC_NETWORK` quota in the consumer - VPC network has been exceeded. + The Private Service Connect connection propagation failed because + the `PSC_PROPAGATED_CONNECTIONS_PER_VPC_NETWORK` quota in the + consumer VPC network has been exceeded. enum: - CODE_UNSPECIFIED - READY @@ -1684,7 +2079,9 @@ components: - ERROR_PRODUCER_QUOTA_EXCEEDED - ERROR_CONSUMER_QUOTA_EXCEEDED message: - description: The human-readable summary of the PSC connection propagation status. + description: >- + The human-readable summary of the Private Service Connect connection + propagation status. type: string ListSpokesResponse: id: ListSpokesResponse @@ -1756,6 +2153,61 @@ components: request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). type: string + AcceptSpokeUpdateRequest: + id: AcceptSpokeUpdateRequest + description: The request for HubService.AcceptSpokeUpdate. + type: object + properties: + spokeUri: + description: Required. The URI of the spoke to accept update. + type: string + spokeEtag: + description: Required. The etag of the spoke to accept update. + type: string + requestId: + description: >- + Optional. A request ID to identify requests. Specify a unique + request ID so that if you must retry your request, the server knows + to ignore the request if it has already been completed. The server + guarantees that a request doesn't result in creation of duplicate + commitments for at least 60 minutes. For example, consider a + situation where you make an initial request and the request times + out. If you make the request again with the same request ID, the + server can check to see whether the original operation was received. + If it was, the server ignores the second request. This behavior + prevents clients from mistakenly creating duplicate commitments. The + request ID must be a valid UUID, with the exception that zero UUID + is not supported (00000000-0000-0000-0000-000000000000). + type: string + RejectSpokeUpdateRequest: + id: RejectSpokeUpdateRequest + description: The request for HubService.RejectSpokeUpdate. + type: object + properties: + spokeUri: + description: Required. The URI of the spoke to reject update. + type: string + spokeEtag: + description: Required. The etag of the spoke to reject update. + type: string + details: + description: Optional. Additional information provided by the hub administrator. + type: string + requestId: + description: >- + Optional. A request ID to identify requests. Specify a unique + request ID so that if you must retry your request, the server knows + to ignore the request if it has already been completed. The server + guarantees that a request doesn't result in creation of duplicate + commitments for at least 60 minutes. For example, consider a + situation where you make an initial request and the request times + out. If you make the request again with the same request ID, the + server can check to see whether the original operation was received. + If it was, the server ignores the second request. This behavior + prevents clients from mistakenly creating duplicate commitments. The + request ID must be a valid UUID, with the exception that zero UUID + is not supported (00000000-0000-0000-0000-000000000000). + type: string RouteTable: id: RouteTable type: object @@ -1811,6 +2263,10 @@ components: - >- The hub associated with this spoke resource has been deleted. This state applies to spoke resources only. + - >- + The resource is in an undefined state due to resource creation or + deletion failure. You can try to delete the resource later or + contact support for help. enum: - STATE_UNSPECIFIED - CREATING @@ -1821,6 +2277,7 @@ components: - UPDATING - INACTIVE - OBSOLETE + - FAILED Route: id: Route description: >- @@ -1908,6 +2365,10 @@ components: - >- The hub associated with this spoke resource has been deleted. This state applies to spoke resources only. + - >- + The resource is in an undefined state due to resource creation or + deletion failure. You can try to delete the resource later or + contact support for help. enum: - STATE_UNSPECIFIED - CREATING @@ -1918,6 +2379,7 @@ components: - UPDATING - INACTIVE - OBSOLETE + - FAILED spoke: description: >- Immutable. The spoke that this route leads to. Example: @@ -1949,6 +2411,9 @@ components: nextHopInterconnectAttachment: description: Immutable. The next-hop VLAN attachment for packets on this route. $ref: '#/components/schemas/NextHopInterconnectAttachment' + nextHopSpoke: + description: Immutable. The next-hop spoke for packets on this route. + $ref: '#/components/schemas/NextHopSpoke' NextHopVpcNetwork: id: NextHopVpcNetwork type: object @@ -2009,6 +2474,23 @@ components: [supported locations](https://cloud.google.com/network-connectivity/docs/network-connectivity-center/concepts/locations). type: boolean + NextHopSpoke: + id: NextHopSpoke + description: A route next hop that leads to a spoke resource. + type: object + properties: + uri: + description: The URI of the spoke resource. + type: string + siteToSiteDataTransfer: + description: >- + Indicates whether site-to-site data transfer is allowed for this + spoke resource. Data transfer is available only in [supported + locations](https://cloud.google.com/network-connectivity/docs/network-connectivity-center/concepts/locations). + Whether this route is accessible to other hybrid spokes with + site-to-site data transfer enabled. If this is false, the route is + only accessible to VPC spokes of the connected Hub. + type: boolean ListRoutesResponse: id: ListRoutesResponse description: Response for HubService.ListRoutes method. @@ -2107,6 +2589,10 @@ components: - >- The hub associated with this spoke resource has been deleted. This state applies to spoke resources only. + - >- + The resource is in an undefined state due to resource creation or + deletion failure. You can try to delete the resource later or + contact support for help. enum: - STATE_UNSPECIFIED - CREATING @@ -2117,6 +2603,7 @@ components: - UPDATING - INACTIVE - OBSOLETE + - FAILED autoAccept: description: Optional. The auto-accept setting for this group. $ref: '#/components/schemas/AutoAccept' @@ -2140,9 +2627,9 @@ components: properties: autoAcceptProjects: description: >- - A list of project ids or project numbers for which you want to - enable auto-accept. The auto-accept setting is applied to spokes - being created or updated in these projects. + Optional. A list of project ids or project numbers for which you + want to enable auto-accept. The auto-accept setting is applied to + spokes being created or updated in these projects. type: array items: type: string @@ -2193,14 +2680,14 @@ components: description: >- The internal range resource for IPAM operations within a VPC network. Used to represent a private address range along with behavioral - characterstics of that range (its usage and peering behavior). + characteristics of that range (its usage and peering behavior). Networking resources can link to this range if they are created as belonging to it. type: object properties: name: description: >- - Immutable. The name of an internal range. Format: + Identifier. The name of an internal range. Format: projects/{project}/locations/{location}/internalRanges/{internal_range} See: https://google.aip.dev/122#fields-representing-resource-names type: string @@ -2218,26 +2705,26 @@ components: additionalProperties: type: string description: - description: A description of this resource. + description: Optional. A description of this resource. type: string ipCidrRange: description: >- - The IP range that this internal range defines. NOTE: IPv6 ranges are - limited to usage=EXTERNAL_TO_VPC and peering=FOR_SELF. NOTE: For - IPv6 Ranges this field is compulsory, i.e. the address range must be - specified explicitly. + Optional. The IP range that this internal range defines. NOTE: IPv6 + ranges are limited to usage=EXTERNAL_TO_VPC and peering=FOR_SELF. + NOTE: For IPv6 Ranges this field is compulsory, i.e. the address + range must be specified explicitly. type: string network: description: >- - The URL or resource ID of the network in which to reserve the - internal range. The network cannot be deleted if there are any + Immutable. The URL or resource ID of the network in which to reserve + the internal range. The network cannot be deleted if there are any reserved internal ranges referring to it. Legacy networks are not supported. For example: https://www.googleapis.com/compute/v1/projects/{project}/locations/global/networks/{network} projects/{project}/locations/global/networks/{network} {network} type: string usage: - description: The type of usage set for this InternalRange. + description: Optional. The type of usage set for this InternalRange. type: string enumDescriptions: - >- @@ -2258,14 +2745,14 @@ components: Ranges created FOR_MIGRATION can be used to lock a CIDR range between a source and target subnet. If usage is set to FOR_MIGRATION, the peering value has to be set to FOR_SELF or - default to FOR_SELF when unset. This value is for internal use. + default to FOR_SELF when unset. enum: - USAGE_UNSPECIFIED - FOR_VPC - EXTERNAL_TO_VPC - FOR_MIGRATION peering: - description: The type of peering set for this internal range. + description: Optional. The type of peering set for this internal range. type: string enumDescriptions: - >- @@ -2298,21 +2785,23 @@ components: - NOT_SHARED prefixLength: description: >- - An alternate to ip_cidr_range. Can be set when trying to create an - IPv4 reservation that automatically finds a free range of the given - size. If both ip_cidr_range and prefix_length are set, there is an - error if the range sizes do not match. Can also be used during - updates to change the range size. NOTE: For IPv6 this field only - works if ip_cidr_range is set as well, and both fields must match. - In other words, with IPv6 this field only works as a redundant - parameter. + Optional. An alternate to ip_cidr_range. Can be set when trying to + create an IPv4 reservation that automatically finds a free range of + the given size. If both ip_cidr_range and prefix_length are set, + there is an error if the range sizes do not match. Can also be used + during updates to change the range size. NOTE: For IPv6 this field + only works if ip_cidr_range is set as well, and both fields must + match. In other words, with IPv6 this field only works as a + redundant parameter. type: integer format: int32 targetCidrRange: description: >- Optional. Can be set to narrow down or pick a different address space while searching for a free range. If not set, defaults to the - "10.0.0.0/8" address space. This can be used to search in other + ["10.0.0.0/8", "172.16.0.0/12", "192.168.0.0/16"] address space (for + auto-mode networks, the "10.0.0.0/9" range is used instead of + "10.0.0.0/8"). This can be used to target the search in other rfc-1918 address spaces like "172.16.0.0/12" and "192.168.0.0/16" or non-rfc-1918 address spaces used in the VPC. type: array @@ -2350,10 +2839,27 @@ components: - OVERLAP_ROUTE_RANGE - OVERLAP_EXISTING_SUBNET_RANGE migration: - description: >- - Optional. Must be present if usage is set to FOR_MIGRATION. This - field is for internal use. + description: Optional. Must be present if usage is set to FOR_MIGRATION. $ref: '#/components/schemas/Migration' + immutable: + description: >- + Optional. Immutable ranges cannot have their fields modified, except + for labels and description. + type: boolean + allocationOptions: + description: >- + Optional. Range auto-allocation options, may be set only when + auto-allocation is selected by not setting ip_cidr_range (and + setting prefix_length). + $ref: '#/components/schemas/AllocationOptions' + excludeCidrRanges: + description: >- + Optional. ExcludeCidrRanges flag. Specifies a set of CIDR blocks + that allows exclusion of particular CIDR ranges from the + auto-allocation process, without having to reserve these blocks + type: array + items: + type: string Migration: id: Migration description: Specification for migration with source and target resource names. @@ -2370,12 +2876,63 @@ components: description: >- Immutable. Resource path of the target resource. The target project can be different, as in the cases when migrating to peer networks. - The resource For example: + For example: /projects/{project}/regions/{region}/subnetworks/{subnet} type: string + AllocationOptions: + id: AllocationOptions + description: >- + Range auto-allocation options, to be optionally used when CIDR block is + not explicitly set. + type: object + properties: + allocationStrategy: + description: >- + Optional. Allocation strategy Not setting this field when the + allocation is requested means an implementation defined strategy is + used. + type: string + enumDescriptions: + - >- + Unspecified is the only valid option when the range is specified + explicitly by ip_cidr_range field. Otherwise unspefified means + using the default strategy. + - >- + Random strategy, the legacy algorithm, used for backwards + compatibility. This allocation strategy remains efficient in the + case of concurrent allocation requests in the same peered network + space and doesn't require providing the level of concurrency in an + explicit parameter, but it is prone to fragmenting available + address space. + - >- + Pick the first available address range. This strategy is + deterministic and the result is easy to predict. + - >- + Pick an arbitrary range out of the first N available ones. The N + will be set in the first_available_ranges_lookup_size field. This + strategy should be used when concurrent allocation requests are + made in the same space of peered networks while the fragmentation + of the addrress space is reduced. + - >- + Pick the smallest but fitting available range. This deterministic + strategy minimizes fragmentation of the address space. + enum: + - ALLOCATION_STRATEGY_UNSPECIFIED + - RANDOM + - FIRST_AVAILABLE + - RANDOM_FIRST_N_AVAILABLE + - FIRST_SMALLEST_FITTING + firstAvailableRangesLookupSize: + description: >- + Optional. This field must be set only when allocation_strategy is + set to RANDOM_FIRST_N_AVAILABLE. The value should be the maximum + expected parallelism of range creation requests issued to the same + space of peered netwroks. + type: integer + format: int32 ListPolicyBasedRoutesResponse: id: ListPolicyBasedRoutesResponse - description: Response for PolicyBasedRouting.ListPolicyBasedRoutes method. + description: Response for PolicyBasedRoutingService.ListPolicyBasedRoutes method. type: object properties: policyBasedRoutes: @@ -2532,26 +3089,27 @@ components: description: >- Optional. The source IP range of outgoing packets that this policy-based route applies to. Default is "0.0.0.0/0" if protocol - version is IPv4. + version is IPv4 and "::/0" if protocol version is IPv6. type: string destRange: description: >- Optional. The destination IP range of outgoing packets that this policy-based route applies to. Default is "0.0.0.0/0" if protocol - version is IPv4. + version is IPv4 and "::/0" if protocol version is IPv6. type: string protocolVersion: description: >- Required. Internet protocol versions this policy-based route applies - to. For this version, only IPV4 is supported. IPV6 is supported in - preview. + to. IPV4 and IPV6 is supported. type: string enumDescriptions: - Default value. - The PBR is for IPv4 internet protocol traffic. + - The PBR is for IPv6 internet protocol traffic. enum: - PROTOCOL_VERSION_UNSPECIFIED - IPV4 + - IPV6 Warnings: id: Warnings description: Informational warning message. @@ -2618,8 +3176,8 @@ components: properties: name: description: >- - Output only. The name of a RegionalEndpoint. Format: - `projects/{project}/locations/{location}/regionalEndpoints/{regional_endpoint}`. + Output only. The name of a RegionalEndpoint. Pattern: + `projects/{project}/locations/{location}/regionalEndpoints/^[-a-z0-9](?:[-a-z0-9]{0,44})[a-z0-9]$`. readOnly: true type: string createTime: @@ -2694,7 +3252,8 @@ components: is provided, an IP from the subnetwork is allocated. Use one of the following formats: * IPv4 address as in `10.0.0.1` * Address resource URI as in - `projects/{project}/regions/{region}/addresses/{address_name}` + `projects/{project}/regions/{region}/addresses/{address_name}` for + an IPv4 or IPv6 address. type: string ListLocationsResponse: id: ListLocationsResponse @@ -3110,8 +3669,8 @@ components: description: >- Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully - have Operation.error value with a google.rpc.Status.code of 1, - corresponding to `Code.CANCELLED`. + have google.longrunning.Operation.error value with a + google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. readOnly: true type: boolean apiVersion: @@ -3132,10 +3691,12 @@ components: - No publicly supported feature in this location - Site-to-cloud spokes are supported in this location - Site-to-site spokes are supported in this location + - Gateway spokes are supported in this location. enum: - LOCATION_FEATURE_UNSPECIFIED - SITE_TO_CLOUD_SPOKES - SITE_TO_SITE_SPOKES + - GATEWAY_SPOKES AcceptHubSpokeResponse: id: AcceptHubSpokeResponse description: The response for HubService.AcceptHubSpoke. @@ -3619,6 +4180,145 @@ components: delete: - $ref: >- #/components/x-stackQL-resources/service_connection_tokens/methods/delete + multicloud_data_transfer_configs: + id: google.networkconnectivity.multicloud_data_transfer_configs + name: multicloud_data_transfer_configs + title: Multicloud_data_transfer_configs + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1multicloudDataTransferConfigs/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.multicloudDataTransferConfigs + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1multicloudDataTransferConfigs/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1multicloudDataTransferConfigs~1{multicloudDataTransferConfigsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1multicloudDataTransferConfigs~1{multicloudDataTransferConfigsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1multicloudDataTransferConfigs~1{multicloudDataTransferConfigsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/multicloud_data_transfer_configs/methods/get + - $ref: >- + #/components/x-stackQL-resources/multicloud_data_transfer_configs/methods/list + insert: + - $ref: >- + #/components/x-stackQL-resources/multicloud_data_transfer_configs/methods/create + update: + - $ref: >- + #/components/x-stackQL-resources/multicloud_data_transfer_configs/methods/patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/multicloud_data_transfer_configs/methods/delete + destinations: + id: google.networkconnectivity.destinations + name: destinations + title: Destinations + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1multicloudDataTransferConfigs~1{multicloudDataTransferConfigsId}~1destinations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.destinations + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1multicloudDataTransferConfigs~1{multicloudDataTransferConfigsId}~1destinations/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1multicloudDataTransferConfigs~1{multicloudDataTransferConfigsId}~1destinations~1{destinationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1multicloudDataTransferConfigs~1{multicloudDataTransferConfigsId}~1destinations~1{destinationsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1multicloudDataTransferConfigs~1{multicloudDataTransferConfigsId}~1destinations~1{destinationsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/destinations/methods/get' + - $ref: '#/components/x-stackQL-resources/destinations/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/destinations/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/destinations/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/destinations/methods/delete' + multicloud_data_transfer_supported_services: + id: google.networkconnectivity.multicloud_data_transfer_supported_services + name: multicloud_data_transfer_supported_services + title: Multicloud_data_transfer_supported_services + methods: + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1multicloudDataTransferSupportedServices~1{multicloudDataTransferSupportedServicesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1multicloudDataTransferSupportedServices/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.multicloudDataTransferSupportedServices + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/multicloud_data_transfer_supported_services/methods/get + - $ref: >- + #/components/x-stackQL-resources/multicloud_data_transfer_supported_services/methods/list + insert: [] + update: [] + replace: [] + delete: [] hubs: id: google.networkconnectivity.hubs name: hubs @@ -3679,6 +4379,20 @@ components: response: mediaType: application/json openAPIDocKey: '200' + accept_spoke_update: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1global~1hubs~1{hubsId}:acceptSpokeUpdate/post + response: + mediaType: application/json + openAPIDocKey: '200' + reject_spoke_update: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1global~1hubs~1{hubsId}:rejectSpokeUpdate/post + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/hubs/methods/get' @@ -4090,6 +4804,43 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/internal_ranges/methods/delete' + internal_ranges_iam_policies: + id: google.networkconnectivity.internal_ranges_iam_policies + name: internal_ranges_iam_policies + title: Internal_ranges_iam_policies + methods: + set_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1internalRanges~1{internalRangesId}:setIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + get_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1internalRanges~1{internalRangesId}:getIamPolicy/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.bindings + test_iam_permissions: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1internalRanges~1{internalRangesId}:testIamPermissions/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/internal_ranges_iam_policies/methods/get_iam_policy + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/internal_ranges_iam_policies/methods/set_iam_policy + delete: [] regional_endpoints: id: google.networkconnectivity.regional_endpoints name: regional_endpoints @@ -4182,6 +4933,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: @@ -4336,7 +5091,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: networkconnectivity.projects.locations.operations.cancel requestBody: content: @@ -5329,7 +6084,515 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServiceConnectionToken' + $ref: '#/components/schemas/ServiceConnectionToken' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: serviceConnectionTokensId + required: true + schema: + type: string + delete: + description: Deletes a single ServiceConnectionToken. + operationId: networkconnectivity.projects.locations.serviceConnectionTokens.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: serviceConnectionTokensId + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + - in: query + name: etag + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/serviceConnectionTokens: + parameters: *ref_1 + get: + description: Lists ServiceConnectionTokens in a given project and location. + operationId: networkconnectivity.projects.locations.serviceConnectionTokens.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListServiceConnectionTokensResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + post: + description: Creates a new ServiceConnectionToken in a given project and location. + operationId: networkconnectivity.projects.locations.serviceConnectionTokens.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceConnectionToken' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: serviceConnectionTokenId + schema: + type: string + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/multicloudDataTransferConfigs: + parameters: *ref_1 + get: + description: Lists MulticloudDataTransferConfigs in a given project and location. + operationId: >- + networkconnectivity.projects.locations.multicloudDataTransferConfigs.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListMulticloudDataTransferConfigsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean + post: + description: Creates a MulticloudDataTransferConfig in a given project and location. + operationId: >- + networkconnectivity.projects.locations.multicloudDataTransferConfigs.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MulticloudDataTransferConfig' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: multicloudDataTransferConfigId + schema: + type: string + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/multicloudDataTransferConfigs/{multicloudDataTransferConfigsId}: + parameters: *ref_1 + get: + description: Gets details of a single MulticloudDataTransferConfig. + operationId: networkconnectivity.projects.locations.multicloudDataTransferConfigs.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/MulticloudDataTransferConfig' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: multicloudDataTransferConfigsId + required: true + schema: + type: string + patch: + description: Updates a MulticloudDataTransferConfig in a given project and location. + operationId: >- + networkconnectivity.projects.locations.multicloudDataTransferConfigs.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MulticloudDataTransferConfig' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: multicloudDataTransferConfigsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: requestId + schema: + type: string + delete: + description: Deletes a single MulticloudDataTransferConfig. + operationId: >- + networkconnectivity.projects.locations.multicloudDataTransferConfigs.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: multicloudDataTransferConfigsId + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + - in: query + name: etag + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/multicloudDataTransferConfigs/{multicloudDataTransferConfigsId}/destinations: + parameters: *ref_1 + get: + description: Lists Destinations in a given project and location. + operationId: >- + networkconnectivity.projects.locations.multicloudDataTransferConfigs.destinations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListDestinationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: multicloudDataTransferConfigsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean + post: + description: Creates a Destination in a given project and location. + operationId: >- + networkconnectivity.projects.locations.multicloudDataTransferConfigs.destinations.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Destination' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: multicloudDataTransferConfigsId + required: true + schema: + type: string + - in: query + name: destinationId + schema: + type: string + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/multicloudDataTransferConfigs/{multicloudDataTransferConfigsId}/destinations/{destinationsId}: + parameters: *ref_1 + get: + description: Gets details of a single Destination. + operationId: >- + networkconnectivity.projects.locations.multicloudDataTransferConfigs.destinations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Destination' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: multicloudDataTransferConfigsId + required: true + schema: + type: string + - in: path + name: destinationsId + required: true + schema: + type: string + patch: + description: Updates a Destination in a given project and location. + operationId: >- + networkconnectivity.projects.locations.multicloudDataTransferConfigs.destinations.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Destination' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -5342,13 +6605,28 @@ paths: schema: type: string - in: path - name: serviceConnectionTokensId + name: multicloudDataTransferConfigsId + required: true + schema: + type: string + - in: path + name: destinationsId required: true schema: type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: requestId + schema: + type: string delete: - description: Deletes a single ServiceConnectionToken. - operationId: networkconnectivity.projects.locations.serviceConnectionTokens.delete + description: Deletes a single Destination. + operationId: >- + networkconnectivity.projects.locations.multicloudDataTransferConfigs.destinations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5373,7 +6651,12 @@ paths: schema: type: string - in: path - name: serviceConnectionTokensId + name: multicloudDataTransferConfigsId + required: true + schema: + type: string + - in: path + name: destinationsId required: true schema: type: string @@ -5385,11 +6668,12 @@ paths: name: etag schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/serviceConnectionTokens: + /v1/projects/{projectsId}/locations/{locationsId}/multicloudDataTransferSupportedServices/{multicloudDataTransferSupportedServicesId}: parameters: *ref_1 get: - description: Lists ServiceConnectionTokens in a given project and location. - operationId: networkconnectivity.projects.locations.serviceConnectionTokens.list + description: Gets details of a single MulticloudDataTransferSupportedServices. + operationId: >- + networkconnectivity.projects.locations.multicloudDataTransferSupportedServices.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5401,7 +6685,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListServiceConnectionTokensResponse' + $ref: '#/components/schemas/MulticloudDataTransferSupportedService' parameters: - in: path name: projectsId @@ -5413,31 +6697,19 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: orderBy + - in: path + name: multicloudDataTransferSupportedServicesId + required: true schema: type: string - post: - description: Creates a new ServiceConnectionToken in a given project and location. - operationId: networkconnectivity.projects.locations.serviceConnectionTokens.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceConnectionToken' + /v1/projects/{projectsId}/locations/{locationsId}/multicloudDataTransferSupportedServices: + parameters: *ref_1 + get: + description: >- + Lists the supported services for Multicloud Data Transfer. This is a + passthrough method. + operationId: >- + networkconnectivity.projects.locations.multicloudDataTransferSupportedServices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5449,7 +6721,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/ListMulticloudDataTransferSupportedServicesResponse parameters: - in: path name: projectsId @@ -5462,11 +6735,12 @@ paths: schema: type: string - in: query - name: serviceConnectionTokenId + name: pageSize schema: - type: string + type: integer + format: int32 - in: query - name: requestId + name: pageToken schema: type: string /v1/projects/{projectsId}/locations/global/hubs: @@ -5705,8 +6979,8 @@ paths: parameters: *ref_1 get: description: >- - Query PSC propagation status the status of a Network Connectivity Center - hub. + Query the Private Service Connect propagation status of a Network + Connectivity Center hub. operationId: networkconnectivity.projects.locations.global.hubs.queryStatus security: - Oauth2: @@ -5824,6 +7098,76 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/global/hubs/{hubsId}:acceptSpokeUpdate: + parameters: *ref_1 + post: + description: >- + Accepts a proposal to update a Network Connectivity Center spoke in a + hub. + operationId: networkconnectivity.projects.locations.global.hubs.acceptSpokeUpdate + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AcceptSpokeUpdateRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: hubsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/global/hubs/{hubsId}:rejectSpokeUpdate: + parameters: *ref_1 + post: + description: >- + Rejects a proposal to update a Network Connectivity Center spoke in a + hub. + operationId: networkconnectivity.projects.locations.global.hubs.rejectSpokeUpdate + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RejectSpokeUpdateRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: hubsId + required: true + schema: + type: string /v1/projects/{projectsId}/locations/global/hubs/{hubsId}:setIamPolicy: parameters: *ref_1 post: @@ -7113,6 +8457,130 @@ paths: name: requestId schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/internalRanges/{internalRangesId}:setIamPolicy: + parameters: *ref_1 + post: + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and + `PERMISSION_DENIED` errors. + operationId: networkconnectivity.projects.locations.internalRanges.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetIamPolicyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: internalRangesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/internalRanges/{internalRangesId}:getIamPolicy: + parameters: *ref_1 + get: + description: >- + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: networkconnectivity.projects.locations.internalRanges.getIamPolicy + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: internalRangesId + required: true + schema: + type: string + - in: query + name: options.requestedPolicyVersion + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/internalRanges/{internalRangesId}:testIamPermissions: + parameters: *ref_1 + post: + description: >- + Returns permissions that a caller has on the specified resource. If the + resource does not exist, this will return an empty set of permissions, + not a `NOT_FOUND` error. Note: This operation is designed to be used for + building permission-aware UIs and command-line tools, not for + authorization checking. This operation may "fail open" without warning. + operationId: networkconnectivity.projects.locations.internalRanges.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: internalRangesId + required: true + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/regionalEndpoints: parameters: *ref_1 get: diff --git a/providers/src/googleapis.com/v00.00.00000/services/networkmanagement.yaml b/providers/src/googleapis.com/v00.00.00000/services/networkmanagement.yaml index 4f03d097..6a5033d1 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/networkmanagement.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/networkmanagement.yaml @@ -9,8 +9,8 @@ info: The Network Management API provides a collection of network performance monitoring and diagnostic capabilities. version: v1 - x-discovery-doc-revision: '20241023' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250813' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/ servers: @@ -196,6 +196,554 @@ components: description: The request message for Operations.CancelOperation. type: object properties: {} + ListNetworkMonitoringProvidersResponse: + id: ListNetworkMonitoringProvidersResponse + description: Message for response to listing NetworkMonitoringProviders + type: object + properties: + networkMonitoringProviders: + description: The list of NetworkMonitoringProvider + type: array + items: + $ref: '#/components/schemas/NetworkMonitoringProvider' + nextPageToken: + description: A token identifying a page of results the server should return. + type: string + NetworkMonitoringProvider: + id: NetworkMonitoringProvider + description: Message describing NetworkMonitoringProvider resource. + type: object + properties: + name: + description: >- + Output only. Identifier. Name of the resource. Format: + `projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}` + readOnly: true + type: string + createTime: + description: Output only. The time the NetworkMonitoringProvider was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. The time the NetworkMonitoringProvider was updated. + readOnly: true + type: string + format: google-datetime + providerType: + description: Required. Type of the NetworkMonitoringProvider. + type: string + enumDescriptions: + - The default value. This value is used if the type is omitted. + - External provider. + enum: + - PROVIDER_TYPE_UNSPECIFIED + - EXTERNAL + providerUri: + description: Output only. Link to the provider's UI. + readOnly: true + type: string + state: + description: Output only. State of the NetworkMonitoringProvider. + readOnly: true + type: string + enumDescriptions: + - The default value. This value is used if the status is omitted. + - NetworkMonitoringProvider is being activated. + - NetworkMonitoringProvider is active. + - NetworkMonitoringProvider is being suspended. + - NetworkMonitoringProvider is suspended. + - NetworkMonitoringProvider is being deleted. + - NetworkMonitoringProvider is deleted. + enum: + - STATE_UNSPECIFIED + - ACTIVATING + - ACTIVE + - SUSPENDING + - SUSPENDED + - DELETING + - DELETED + errors: + description: >- + Output only. The list of error messages detected for the + NetworkMonitoringProvider. + readOnly: true + type: array + items: + type: string + ListMonitoringPointsResponse: + id: ListMonitoringPointsResponse + description: Message for response to listing MonitoringPoints + type: object + properties: + monitoringPoints: + description: The list of MonitoringPoints. + type: array + items: + $ref: '#/components/schemas/MonitoringPoint' + nextPageToken: + description: A token identifying a page of results the server should return. + type: string + MonitoringPoint: + id: MonitoringPoint + description: Message describing MonitoringPoint resource. + type: object + properties: + name: + description: >- + Identifier. Name of the resource. Format: + `projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/monitoringPoints/{monitoring_point}` + type: string + createTime: + description: Output only. The time the MonitoringPoint was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. The time the MonitoringPoint was updated. + readOnly: true + type: string + format: google-datetime + displayName: + description: Output only. Display name of the MonitoringPoint. + readOnly: true + type: string + originatingIp: + description: >- + Output only. IP address visible when MonitoringPoint connects to the + provider. + readOnly: true + type: string + version: + description: Output only. Version of the software running on the MonitoringPoint. + readOnly: true + type: string + type: + description: Output only. Deployment type of the MonitoringPoint. + readOnly: true + type: string + connectionStatus: + description: Output only. Connection status of the MonitoringPoint. + readOnly: true + type: string + enumDescriptions: + - The default value. This value is used if the status is omitted. + - MonitoringPoint is online. + - MonitoringPoint is offline. + enum: + - CONNECTION_STATUS_UNSPECIFIED + - ONLINE + - OFFLINE + hostname: + description: Output only. The hostname of the MonitoringPoint. + readOnly: true + type: string + geoLocation: + description: Output only. The geographical location of the MonitoringPoint. ; + readOnly: true + $ref: '#/components/schemas/GeoLocation' + upgradeType: + description: Output only. The type of upgrade available for the MonitoringPoint. + readOnly: true + type: string + enumDescriptions: + - >- + The default value. This value is used if the upgrade type is + omitted. + - Upgrades are performed manually. + - Upgrades are managed. + - Upgrade is scheduled. + - Upgrades are performed automatically. + - Upgrades are performed externally. + enum: + - UPGRADE_TYPE_UNSPECIFIED + - MANUAL + - MANAGED + - SCHEDULED + - AUTO + - EXTERNAL + networkInterfaces: + description: Output only. The network interfaces of the MonitoringPoint. + readOnly: true + type: array + items: + $ref: '#/components/schemas/NetworkInterface' + errors: + description: Output only. The codes of errors detected in the MonitoringPoint. + readOnly: true + type: array + items: + type: string + enumDescriptions: + - >- + The default value. This value is used if the error code is + omitted. + - Error detected in NTP service. + - Error detected during the upgrade process. + - Error detected while downloading. + enum: + - ERROR_CODE_UNSPECIFIED + - NTP_ERROR + - UPGRADE_ERROR + - DOWNLOAD_FAILED + autoGeoLocationEnabled: + description: >- + Output only. Indicates if automaitic geographic location is enabled + for the MonitoringPoint. + readOnly: true + type: boolean + providerTags: + description: Output only. The provider tags of the MonitoringPoint. + readOnly: true + type: array + items: + $ref: '#/components/schemas/ProviderTag' + host: + description: Output only. The host information of the MonitoringPoint. + readOnly: true + $ref: '#/components/schemas/Host' + upgradeAvailable: + description: >- + Output only. Indicates if an upgrade is available for the + MonitoringPoint. + readOnly: true + type: boolean + GeoLocation: + id: GeoLocation + description: The geographical location of the MonitoringPoint. + type: object + properties: + formattedAddress: + description: Formatted address. + type: string + country: + description: Country. + type: string + NetworkInterface: + id: NetworkInterface + description: Message describing network interfaces. + type: object + properties: + interfaceName: + description: 'Output only. The name of the network interface. Examples: eth0, eno1' + readOnly: true + type: string + speed: + description: Output only. Speed of the interface in millions of bits per second. + readOnly: true + type: string + format: int64 + ipAddress: + description: Output only. The IP address of the interface. + readOnly: true + type: string + cidr: + description: >- + Output only. The IP address of the interface and subnet mask in CIDR + format. Examples: 192.168.1.0/24, 2001:db8::/32 + readOnly: true + type: string + macAddress: + description: Output only. The MAC address of the interface. + readOnly: true + type: string + adapterDescription: + description: Output only. The description of the interface. + readOnly: true + type: string + vlanId: + description: Output only. The id of the VLAN. + readOnly: true + type: string + format: int64 + ProviderTag: + id: ProviderTag + description: Message describing the provider tag. + type: object + properties: + category: + description: Output only. The category of the provider tag. + readOnly: true + type: string + value: + description: Output only. The value of the provider tag. + readOnly: true + type: string + resourceType: + description: Output only. The resource type of the provider tag. + readOnly: true + type: string + enumDescriptions: + - The default value. This value is used if the status is omitted. + - Network path. + - Web path. + - Monitoring policy. + - Monitoring point. + enum: + - RESOURCE_TYPE_UNSPECIFIED + - NETWORK_PATH + - WEB_PATH + - MONITORING_POLICY + - MONITORING_POINT + Host: + id: Host + description: Message describing information about the host. + type: object + properties: + os: + description: Output only. The operating system of the host. + readOnly: true + type: string + cloudProvider: + description: Output only. The cloud provider of the host. + readOnly: true + type: string + cloudProjectId: + description: Output only. The cloud project id of the host. + readOnly: true + type: string + cloudInstanceId: + description: Output only. The cloud instance id of the host. + readOnly: true + type: string + cloudRegion: + description: Output only. The cloud region of the host. + readOnly: true + type: string + cloudZone: + description: Output only. The cloud zone of the host. + readOnly: true + type: string + cloudVpcId: + description: Output only. The id of Virtual Private Cloud (VPC) of the host. + readOnly: true + type: string + cloudVirtualNetworkIds: + description: Output only. The ids of cloud virtual networks of the host. + readOnly: true + type: array + items: + type: string + ListNetworkPathsResponse: + id: ListNetworkPathsResponse + description: Message for response to listing NetworkPaths + type: object + properties: + networkPaths: + description: The list of NetworkPath + type: array + items: + $ref: '#/components/schemas/NetworkPath' + nextPageToken: + description: A token identifying a page of results the server should return. + type: string + NetworkPath: + id: NetworkPath + description: Message describing NetworkPath resource. + type: object + properties: + name: + description: >- + Identifier. Name of the resource. Format: + `projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/networkPaths/{network_path}` + type: string + createTime: + description: Output only. The time the NetworkPath was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. The time the NetworkPath was updated. + readOnly: true + type: string + format: google-datetime + sourceMonitoringPointId: + description: >- + Output only. Provider's UUID of the source MonitoringPoint. This id + may not point to a resource in the GCP. + readOnly: true + type: string + destination: + description: Output only. IP address or hostname of the network path destination. + readOnly: true + type: string + dualEnded: + description: >- + Output only. Indicates if the network path is dual ended. When true, + the network path is measured both: from both source to destination, + and from destination to source. When false, the network path is + measured from the source through the destination back to the source + (round trip measurement). + readOnly: true + type: boolean + displayName: + description: Output only. The display name of the network path. + readOnly: true + type: string + destinationGeoLocation: + description: >- + Output only. Geographical location of the destination + MonitoringPoint. ; + readOnly: true + $ref: '#/components/schemas/GeoLocation' + networkProtocol: + description: Output only. The network protocol of the network path. + readOnly: true + type: string + enumDescriptions: + - >- + The default value. This value is used if the network protocol is + omitted. + - ICMP. + - UDP. + - TCP. + enum: + - NETWORK_PROTOCOL_UNSPECIFIED + - ICMP + - UDP + - TCP + monitoringEnabled: + description: Output only. Is monitoring enabled for the network path. + readOnly: true + type: boolean + monitoringStatus: + description: Output only. The monitoring status of the network path. + readOnly: true + type: string + enumDescriptions: + - The default value. This value is used if the status is omitted. + - Monitoring is enabled. + - Policy is mismatched. + - Monitoring point is offline. + - Monitoring is disabled. + enum: + - MONITORING_STATUS_UNSPECIFIED + - MONITORING + - POLICY_MISMATCH + - MONITORING_POINT_OFFLINE + - DISABLED + providerTags: + description: Output only. The provider tags of the network path. + readOnly: true + type: array + items: + $ref: '#/components/schemas/ProviderTag' + monitoringPolicyId: + description: Output only. ID of monitoring policy. + readOnly: true + type: string + monitoringPolicyDisplayName: + description: Output only. Display name of the monitoring policy. + readOnly: true + type: string + providerUiUri: + description: Output only. Link to provider's UI; link shows the NetworkPath. + readOnly: true + type: string + ListWebPathsResponse: + id: ListWebPathsResponse + description: Message for response to listing WebPaths + type: object + properties: + webPaths: + description: The list of WebPath. + type: array + items: + $ref: '#/components/schemas/WebPath' + nextPageToken: + description: A token identifying a page of results the server should return. + type: string + WebPath: + id: WebPath + description: Message describing WebPath resource. + type: object + properties: + name: + description: >- + Identifier. Name of the resource. Format: + `projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/webPaths/{web_path}` + type: string + createTime: + description: Output only. The time the WebPath was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. The time the WebPath was updated. + readOnly: true + type: string + format: google-datetime + sourceMonitoringPointId: + description: Output only. ID of the source MonitoringPoint. + readOnly: true + type: string + displayName: + description: Output only. Display name of the WebPath. + readOnly: true + type: string + destination: + description: Output only. Web monitoring target. + readOnly: true + type: string + monitoringEnabled: + description: Output only. Is monitoring enabled for the WebPath. + readOnly: true + type: boolean + monitoringStatus: + description: Output only. The monitoring status of the WebPath. + readOnly: true + type: string + enumDescriptions: + - The default value. This value is used if the status is omitted. + - Monitoring is enabled. + - Policy is mismatched. + - Monitoring point is offline. + - Monitoring is disabled. + enum: + - MONITORING_STATUS_UNSPECIFIED + - MONITORING + - POLICY_MISMATCH + - MONITORING_POINT_OFFLINE + - DISABLED + interval: + description: Output only. Monitoring interval. + readOnly: true + type: string + format: google-duration + workflowType: + description: Output only. The workflow type of the WebPath. + readOnly: true + type: string + enumDescriptions: + - The default value. This value is used if the status is omitted. + - Browser. + - HTTP. + enum: + - WORKFLOW_TYPE_UNSPECIFIED + - BROWSER + - HTTP + relatedNetworkPathId: + description: Output only. Provider's UUID of the related NetworkPath. + readOnly: true + type: string + providerTags: + description: Output only. The provider tags of the web path. + readOnly: true + type: array + items: + $ref: '#/components/schemas/ProviderTag' + monitoringPolicyId: + description: Output only. ID of the monitoring policy. + readOnly: true + type: string + monitoringPolicyDisplayName: + description: Output only. Display name of the monitoring policy. + readOnly: true + type: string + providerUiUri: + description: Output only. Link to provider's UI; link shows the WebPath. + readOnly: true + type: string ListConnectivityTestsResponse: id: ListConnectivityTestsResponse description: Response for the `ListConnectivityTests` method. @@ -234,35 +782,20 @@ components: source: description: >- Required. Source specification of the Connectivity Test. You can use - a combination of source IP address, virtual machine (VM) instance, - or Compute Engine network to uniquely identify the source location. - Examples: If the source IP address is an internal IP address within - a Google Cloud Virtual Private Cloud (VPC) network, then you must - also specify the VPC network. Otherwise, specify the VM instance, - which already contains its internal IP address and VPC network - information. If the source of the test is within an on-premises - network, then you must provide the destination VPC network. If the - source endpoint is a Compute Engine VM instance with multiple - network interfaces, the instance itself is not sufficient to - identify the endpoint. So, you must also specify the source IP - address or VPC network. A reachability analysis proceeds even if the - source location is ambiguous. However, the test result may include - endpoints that you don't intend to test. + a combination of source IP address, URI of a supported endpoint, + project ID, or VPC network to identify the source location. + Reachability analysis might proceed even if the source location is + ambiguous. However, the test result might include endpoints or use a + source that you don't intend to test. $ref: '#/components/schemas/Endpoint' destination: description: >- Required. Destination specification of the Connectivity Test. You - can use a combination of destination IP address, Compute Engine VM - instance, or VPC network to uniquely identify the destination - location. Even if the destination IP address is not unique, the - source IP location is unique. Usually, the analysis can infer the - destination endpoint from route information. If the destination you - specify is a VM instance and the instance has multiple network - interfaces, then you must also specify either a destination IP - address or VPC network to identify the destination interface. A - reachability analysis proceeds even if the destination location is - ambiguous. However, the result can include endpoints that you don't - intend to test. + can use a combination of destination IP address, URI of a supported + endpoint, project ID, or VPC network to identify the destination + location. Reachability analysis proceeds even if the destination + location is ambiguous. However, the test result might include + endpoints or use a destination that you don't intend to test. $ref: '#/components/schemas/Endpoint' protocol: description: IP Protocol of the test. When not provided, "TCP" is assumed. @@ -309,13 +842,26 @@ components: one-time rerun of an existing test. readOnly: true $ref: '#/components/schemas/ProbingDetails' - bypassFirewallChecks: + roundTrip: description: >- - Whether the test should skip firewall checking. If not provided, we - assume false. + Whether run analysis for the return path from destination to source. + Default value is false. type: boolean - Endpoint: - id: Endpoint + returnReachabilityDetails: + description: >- + Output only. The reachability details of this test from the latest + run for the return path. The details are updated when creating a new + test, updating an existing test, or triggering a one-time rerun of + an existing test. + readOnly: true + $ref: '#/components/schemas/ReachabilityDetails' + bypassFirewallChecks: + description: >- + Whether the analysis should skip firewall checking. Default value is + false. + type: boolean + Endpoint: + id: Endpoint description: Source or destination of the Connectivity Test. type: object properties: @@ -339,9 +885,9 @@ components: frontend configuration of a Google Cloud load balancer. Forwarding rules are also used for protocol forwarding, Private Service Connect and other network services to provide forwarding information in the - control plane. Format: - projects/{project}/global/forwardingRules/{id} or - projects/{project}/regions/{region}/forwardingRules/{id} + control plane. Applicable only to destination endpoint. Format: + `projects/{project}/global/forwardingRules/{id}` or + `projects/{project}/regions/{region}/forwardingRules/{id}` type: string forwardingRuleTarget: description: >- @@ -411,7 +957,7 @@ components: DNS endpoint of [Google Kubernetes Engine cluster control plane](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture). Requires gke_master_cluster to be set, can't be used simultaneoulsly - with ip_address. + with ip_address or network. Applicable only to destination endpoint. type: string cloudSqlInstance: description: A [Cloud SQL](https://cloud.google.com/sql) instance URI. @@ -419,28 +965,32 @@ components: redisInstance: description: >- A [Redis Instance](https://cloud.google.com/memorystore/docs/redis) - URI. + URI. Applicable only to destination endpoint. type: string redisCluster: description: >- A [Redis Cluster](https://cloud.google.com/memorystore/docs/cluster) - URI. + URI. Applicable only to destination endpoint. type: string cloudFunction: - description: A [Cloud Function](https://cloud.google.com/functions). + description: >- + A [Cloud Function](https://cloud.google.com/functions). Applicable + only to source endpoint. $ref: '#/components/schemas/CloudFunctionEndpoint' appEngineVersion: description: >- An [App Engine](https://cloud.google.com/appengine) [service version](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions). + Applicable only to source endpoint. $ref: '#/components/schemas/AppEngineVersionEndpoint' cloudRunRevision: description: >- A [Cloud Run](https://cloud.google.com/run) [revision](https://cloud.google.com/run/docs/reference/rest/v1/namespaces.revisions/get) + Applicable only to source endpoint. $ref: '#/components/schemas/CloudRunRevisionEndpoint' network: - description: A Compute Engine network URI. + description: A VPC network URI. type: string networkType: description: >- @@ -455,22 +1005,22 @@ components: output, specify the URI for the source or destination network. - >- A network hosted outside of Google Cloud. This can be an - on-premises network, or a network hosted by another cloud - provider. + on-premises network, an internet resource or a network hosted by + another cloud provider. enum: - NETWORK_TYPE_UNSPECIFIED - GCP_NETWORK - NON_GCP_NETWORK projectId: description: >- - Project ID where the endpoint is located. The Project ID can be - derived from the URI if you provide a VM instance or network URI. - The following are two cases where you must provide the project ID: - 1. Only the IP address is specified, and the IP address is within a - Google Cloud project. 2. When you are using Shared VPC and the IP - address that you provide is from the service project. In this case, - the network that the IP address resides in is defined in the host - project. + Project ID where the endpoint is located. The project ID can be + derived from the URI if you provide a endpoint or network URI. The + following are two cases where you may need to provide the project + ID: 1. Only the IP address is specified, and the IP address is + within a Google Cloud project. 2. When you are using Shared VPC and + the IP address that you provide is from the service project. In this + case, the network that the IP address resides in is defined in the + host project. type: string CloudFunctionEndpoint: id: CloudFunctionEndpoint @@ -503,6 +1053,13 @@ components: URI. The format is: projects/{project}/locations/{location}/revisions/{revision} type: string + serviceUri: + description: >- + Output only. The URI of the Cloud Run service that the revision + belongs to. The format is: + projects/{project}/locations/{location}/services/{service} + readOnly: true + type: string ReachabilityDetails: id: ReachabilityDetails description: Results of the configuration analysis from the last run of the test. @@ -710,7 +1267,14 @@ components: balancer. - 'Forwarding state: arriving at a Cloud VPN gateway.' - 'Forwarding state: arriving at a Cloud VPN tunnel.' + - 'Forwarding state: arriving at an interconnect attachment.' - 'Forwarding state: arriving at a VPC connector.' + - >- + Forwarding state: for packets originating from a serverless + endpoint forwarded through Direct VPC egress. + - >- + Forwarding state: for packets originating from a serverless + endpoint forwarded through public (external) connectivity. - 'Transition state: packet header translated.' - >- Transition state: original connection is terminated and a new @@ -759,6 +1323,9 @@ components: - false - false - false + - false + - false + - false enum: - STATE_UNSPECIFIED - START_FROM_INSTANCE @@ -786,7 +1353,10 @@ components: - ARRIVE_AT_EXTERNAL_LOAD_BALANCER - ARRIVE_AT_VPN_GATEWAY - ARRIVE_AT_VPN_TUNNEL + - ARRIVE_AT_INTERCONNECT_ATTACHMENT - ARRIVE_AT_VPC_CONNECTOR + - DIRECT_VPC_EGRESS_CONNECTION + - SERVERLESS_EXTERNAL_CONNECTION - NAT - PROXY_CONNECTION - DELIVER @@ -828,9 +1398,18 @@ components: vpnTunnel: description: Display information of a Compute Engine VPN tunnel. $ref: '#/components/schemas/VpnTunnelInfo' + interconnectAttachment: + description: Display information of an interconnect attachment. + $ref: '#/components/schemas/InterconnectAttachmentInfo' vpcConnector: description: Display information of a VPC connector. $ref: '#/components/schemas/VpcConnectorInfo' + directVpcEgressConnection: + description: Display information of a serverless direct VPC egress connection. + $ref: '#/components/schemas/DirectVpcEgressConnectionInfo' + serverlessExternalConnection: + description: Display information of a serverless public (external) connection. + $ref: '#/components/schemas/ServerlessExternalConnectionInfo' deliver: description: Display information of the final state "deliver" and reason. $ref: '#/components/schemas/DeliverInfo' @@ -929,6 +1508,23 @@ components: URI of the PSC network attachment the NIC is attached to (if relevant). type: string + running: + description: >- + Indicates whether the Compute Engine instance is running. + Deprecated: use the `status` field instead. + deprecated: true + type: boolean + status: + description: The status of the instance. + type: string + enumDescriptions: + - Default unspecified value. + - The instance is running. + - The instance has any status other than "RUNNING". + enum: + - STATUS_UNSPECIFIED + - RUNNING + - NOT_RUNNING FirewallInfo: id: FirewallInfo description: >- @@ -1023,6 +1619,9 @@ components: Tracking state for response traffic created when request traffic goes through allow firewall rule. For details, see [firewall rules specifications](https://cloud.google.com/firewall/docs/firewalls#specifications) + - >- + Firewall analysis was skipped due to executing Connectivity Test + in the BypassFirewallChecks mode enum: - FIREWALL_RULE_TYPE_UNSPECIFIED - HIERARCHICAL_FIREWALL_POLICY_RULE @@ -1033,6 +1632,27 @@ components: - NETWORK_REGIONAL_FIREWALL_POLICY_RULE - UNSUPPORTED_FIREWALL_POLICY_RULE - TRACKING_STATE + - ANALYSIS_SKIPPED + policyPriority: + description: >- + The priority of the firewall policy that this rule is associated + with. This field is not applicable to VPC firewall rules and implied + VPC firewall rules. + type: integer + format: int32 + targetType: + description: Target type of the firewall rule. + type: string + enumDescriptions: + - >- + Target type is not specified. In this case we treat the rule as + applying to INSTANCES target type. + - Firewall rule applies to instances. + - Firewall rule applies to internal managed load balancers. + enum: + - TARGET_TYPE_UNSPECIFIED + - INSTANCES + - INTERNAL_MANAGED_LB RouteInfo: id: RouteInfo description: For display only. Metadata associated with a Compute Engine route. @@ -1048,9 +1668,9 @@ components: Static route created by the user, including the default route to the internet. - Dynamic route exchanged between BGP peers. - - A subnet route received from peering network. + - A subnet route received from peering network or NCC Hub. - A static route received from peering network. - - A dynamic route received from peering network. + - A dynamic route received from peering network or NCC Hub. - Policy based route. - >- Advertised route. Synthetic route which is used to transition from @@ -1073,7 +1693,10 @@ components: - Next hop is an IP address. - Next hop is a Compute Engine instance. - Next hop is a VPC network gateway. - - Next hop is a peering VPC. + - >- + Next hop is a peering VPC. This scenario only happens when the + user doesn't have permissions to the project where the next hop + resource is located. - Next hop is an interconnect. - Next hop is a VPN tunnel. - >- @@ -1085,12 +1708,16 @@ components: - Next hop is an internet gateway. - >- Next hop is blackhole; that is, the next hop either does not exist - or is not running. + or is unusable. - Next hop is the forwarding rule of an Internal Load Balancer. - >- Next hop is a [router appliance instance](https://cloud.google.com/network-connectivity/docs/network-connectivity-center/concepts/ra-overview). - - Next hop is an NCC hub. + - >- + Next hop is an NCC hub. This scenario only happens when the user + doesn't have permissions to the project where the next hop + resource is located. + - Next hop is Secure Web Proxy Gateway. enum: - NEXT_HOP_TYPE_UNSPECIFIED - NEXT_HOP_IP @@ -1105,8 +1732,12 @@ components: - NEXT_HOP_ILB - NEXT_HOP_ROUTER_APPLIANCE - NEXT_HOP_NCC_HUB + - SECURE_WEB_PROXY_GATEWAY routeScope: - description: Indicates where route is applicable. + description: >- + Indicates where route is applicable. Deprecated, routes with NCC_HUB + scope are not included in the trace in new tests. + deprecated: true type: string enumDescriptions: - Unspecified scope. Default value. @@ -1120,19 +1751,29 @@ components: description: Name of a route. type: string uri: - description: URI of a route (if applicable). + description: >- + URI of a route. SUBNET, STATIC, PEERING_SUBNET (only for peering + network) and POLICY_BASED routes only. type: string region: - description: Region of the route (if applicable). + description: >- + Region of the route. DYNAMIC, PEERING_DYNAMIC, POLICY_BASED and + ADVERTISED routes only. If set for POLICY_BASED route, this is a + region of VLAN attachments for Cloud Interconnect the route applies + to. type: string destIpRange: description: Destination IP range of the route. type: string nextHop: - description: Next hop of the route. + description: >- + String type of the next hop of the route (for example, "VPN + tunnel"). Deprecated in favor of the next_hop_type and next_hop_uri + fields, not used in new tests. + deprecated: true type: string networkUri: - description: URI of a Compute Engine network. NETWORK routes only. + description: URI of a VPC network where route is located. type: string priority: description: Priority of the route. @@ -1144,40 +1785,68 @@ components: items: type: string srcIpRange: - description: Source IP address range of the route. Policy based routes only. + description: Source IP address range of the route. POLICY_BASED routes only. type: string destPortRanges: - description: Destination port ranges of the route. Policy based routes only. + description: Destination port ranges of the route. POLICY_BASED routes only. type: array items: type: string srcPortRanges: - description: Source port ranges of the route. Policy based routes only. + description: Source port ranges of the route. POLICY_BASED routes only. type: array items: type: string protocols: - description: Protocols of the route. Policy based routes only. + description: Protocols of the route. POLICY_BASED routes only. type: array items: type: string nccHubUri: - description: URI of a NCC Hub. NCC_HUB routes only. + description: >- + URI of the NCC Hub the route is advertised by. PEERING_SUBNET and + PEERING_DYNAMIC routes that are advertised by NCC Hub only. type: string nccSpokeUri: - description: URI of a NCC Spoke. NCC_HUB routes only. + description: >- + URI of the destination NCC Spoke. PEERING_SUBNET and PEERING_DYNAMIC + routes that are advertised by NCC Hub only. type: string advertisedRouteSourceRouterUri: description: >- - For advertised dynamic routes, the URI of the Cloud Router that + For ADVERTISED dynamic routes, the URI of the Cloud Router that advertised the corresponding IP prefix. type: string advertisedRouteNextHopUri: description: >- - For advertised routes, the URI of their next hop, i.e. the URI of + For ADVERTISED routes, the URI of their next hop, i.e. the URI of the hybrid endpoint (VPN tunnel, Interconnect attachment, NCC router appliance) the advertised prefix is advertised through, or URI of - the source peered network. + the source peered network. Deprecated in favor of the next_hop_uri + field, not used in new tests. + deprecated: true + type: string + nextHopUri: + description: URI of the next hop resource. + type: string + nextHopNetworkUri: + description: URI of a VPC network where the next hop resource is located. + type: string + originatingRouteUri: + description: >- + For PEERING_SUBNET and PEERING_STATIC routes, the URI of the + originating SUBNET/STATIC route. + type: string + originatingRouteDisplayName: + description: >- + For PEERING_SUBNET, PEERING_STATIC and PEERING_DYNAMIC routes, the + name of the originating SUBNET/STATIC/DYNAMIC route. + type: string + nccHubRouteUri: + description: >- + For PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by + NCC Hub, the URI of the corresponding route in NCC Hub's routing + table. type: string GoogleServiceInfo: id: GoogleServiceInfo @@ -1216,6 +1885,9 @@ components: - >- Google API via VPC Service Controls. https://cloud.google.com/vpc/docs/configure-private-service-connect-apis + - >- + Google API via Serverless VPC Access. + https://cloud.google.com/vpc/docs/serverless-vpc-access enum: - GOOGLE_SERVICE_TYPE_UNSPECIFIED - IAP @@ -1224,6 +1896,7 @@ components: - GOOGLE_API - GOOGLE_API_PSC - GOOGLE_API_VPC_SC + - SERVERLESS_VPC_ACCESS ForwardingRuleInfo: id: ForwardingRuleInfo description: >- @@ -1339,6 +2012,30 @@ components: - ROUTE_BASED - POLICY_BASED - DYNAMIC + InterconnectAttachmentInfo: + id: InterconnectAttachmentInfo + description: For display only. Metadata associated with an Interconnect attachment. + type: object + properties: + displayName: + description: Name of an Interconnect attachment. + type: string + uri: + description: URI of an Interconnect attachment. + type: string + interconnectUri: + description: >- + URI of the Interconnect where the Interconnect attachment is + configured. + type: string + region: + description: >- + Name of a Google Cloud region where the Interconnect attachment is + configured. + type: string + cloudRouterUri: + description: URI of the Cloud Router to be used for dynamic routing. + type: string VpcConnectorInfo: id: VpcConnectorInfo description: For display only. Metadata associated with a VPC connector. @@ -1353,6 +2050,38 @@ components: location: description: Location in which the VPC connector is deployed. type: string + DirectVpcEgressConnectionInfo: + id: DirectVpcEgressConnectionInfo + description: >- + For display only. Metadata associated with a serverless direct VPC + egress connection. + type: object + properties: + networkUri: + description: URI of direct access network. + type: string + subnetworkUri: + description: URI of direct access subnetwork. + type: string + selectedIpRange: + description: Selected IP range. + type: string + selectedIpAddress: + description: Selected starting IP address, from the selected IP range. + type: string + region: + description: Region in which the Direct VPC egress is deployed. + type: string + ServerlessExternalConnectionInfo: + id: ServerlessExternalConnectionInfo + description: >- + For display only. Metadata associated with a serverless public + connection. + type: object + properties: + selectedIpAddress: + description: Selected starting IP address, from the Google dynamic address pool. + type: string DeliverInfo: id: DeliverInfo description: Details of the final state "deliver" and associated resource. @@ -1421,6 +2150,38 @@ components: pscGoogleApiTarget: description: PSC Google API target the packet is delivered to (if applicable). type: string + googleServiceType: + description: >- + Recognized type of a Google Service the packet is delivered to (if + applicable). + type: string + enumDescriptions: + - Unspecified Google Service. + - >- + Identity aware proxy. + https://cloud.google.com/iap/docs/using-tcp-forwarding + - >- + One of two services sharing IP ranges: * Load Balancer proxy * + Centralized Health Check prober + https://cloud.google.com/load-balancing/docs/firewall-rules + - >- + Connectivity from Cloud DNS to forwarding targets or alternate + name servers that use private routing. + https://cloud.google.com/dns/docs/zones/forwarding-zones#firewall-rules + https://cloud.google.com/dns/docs/policies#firewall-rules + - private.googleapis.com and restricted.googleapis.com + - >- + Google API via Private Service Connect. + https://cloud.google.com/vpc/docs/configure-private-service-connect-apis + Google API via Serverless VPC Access. + https://cloud.google.com/vpc/docs/serverless-vpc-access + enum: + - GOOGLE_SERVICE_TYPE_UNSPECIFIED + - IAP + - GFE_PROXY_OR_HEALTH_CHECK_PROBER + - CLOUD_DNS + - PRIVATE_GOOGLE_ACCESS + - SERVERLESS_VPC_ACCESS ForwardInfo: id: ForwardInfo description: Details of the final state "forward" and associated resource. @@ -1442,6 +2203,7 @@ components: - Forwarded to a VPC network in another project. - Forwarded to an NCC Hub. - Forwarded to a router appliance. + - Forwarded to a Secure Web Proxy Gateway. enumDeprecated: - false - false @@ -1453,6 +2215,7 @@ components: - false - false - false + - false enum: - TARGET_UNSPECIFIED - PEERING_VPC @@ -1464,6 +2227,7 @@ components: - ANOTHER_PROJECT - NCC_HUB - ROUTER_APPLIANCE + - SECURE_WEB_PROXY_GATEWAY resourceUri: description: URI of the resource that the packet is forwarded to. type: string @@ -1554,8 +2318,11 @@ components: - Aborted because expected firewall configuration was missing. - Aborted because expected route configuration was missing. - >- - Aborted because a PSC endpoint selection for the Google-managed + Aborted because PSC endpoint selection for the Google-managed service is ambiguous (several PSC endpoints satisfy test input). + - >- + Aborted because endpoint selection for the Google-managed service + is ambiguous (several endpoints satisfy test input). - >- Aborted because tests with a PSC-based Cloud SQL instance as a source are not supported. @@ -1575,6 +2342,13 @@ components: - >- Aborted due to an unsupported configuration of the Google-managed project. + - >- + Aborted because the source endpoint is a Cloud Run revision with + direct VPC access enabled, but there are no reserved serverless IP + ranges. + - >- + Aborted because the used protocol is not supported for the used IP + version. enumDeprecated: - false - true @@ -1612,6 +2386,9 @@ components: - false - false - false + - false + - false + - false enum: - CAUSE_UNSPECIFIED - UNKNOWN_NETWORK @@ -1642,6 +2419,7 @@ components: - FIREWALL_CONFIG_NOT_FOUND - ROUTE_CONFIG_NOT_FOUND - GOOGLE_MANAGED_SERVICE_AMBIGUOUS_PSC_ENDPOINT + - GOOGLE_MANAGED_SERVICE_AMBIGUOUS_ENDPOINT - SOURCE_PSC_CLOUD_SQL_UNSUPPORTED - SOURCE_REDIS_CLUSTER_UNSUPPORTED - SOURCE_REDIS_INSTANCE_UNSUPPORTED @@ -1649,6 +2427,8 @@ components: - NON_ROUTABLE_IP_ADDRESS - UNKNOWN_ISSUE_IN_GOOGLE_MANAGED_PROJECT - UNSUPPORTED_GOOGLE_MANAGED_PROJECT_CONFIG + - NO_SERVERLESS_IP_RANGES + - IP_VERSION_PROTOCOL_MISMATCH resourceUri: description: URI of the resource that caused the abort. type: string @@ -1705,7 +2485,12 @@ components: - >- Route's next hop forwarding rule type is invalid (it's not a forwarding rule of the internal passthrough load balancer). - - Packet is sent from the Internet to the private IPv6 address. + - >- + Packet is sent from the Internet or Google service to the private + IPv6 address. + - >- + Packet is sent from the external IPv6 source address of an + instance to the private IPv6 address of an instance. - >- The packet does not match a policy-based VPN tunnel local selector. @@ -1716,17 +2501,16 @@ components: Packet with internal destination address sent to the internet gateway. - >- - Instance with only an internal IP address tries to access Google - API and services, but private Google access is not enabled in the - subnet. + Endpoint with only an internal IP address tries to access Google + API and services, but Private Google Access is not enabled in the + subnet or is not applicable. - >- Source endpoint tries to access Google API and services through the VPN tunnel to another network, but Private Google Access needs to be enabled in the source endpoint network. - >- - Instance with only an internal IP address tries to access external - hosts, but Cloud NAT is not enabled in the subnet, unless special - configurations on a VM allow this connection. + Endpoint with only an internal IP address tries to access external + hosts, but there is no matching Cloud NAT gateway in the subnet. - >- Destination internal address cannot be resolved to a known target. If this is a shared VPC scenario, verify if the service project ID @@ -1741,6 +2525,11 @@ components: the backends to be unavailable for traffic from the load balancer. For more details, see [Health check firewall rules](https://cloud.google.com/load-balancing/docs/health-checks#firewall_rules). + - >- + Matching ingress firewall rules by network tags for packets sent + via serverless VPC direct egress is unsupported. Behavior is + undefined. + https://cloud.google.com/run/docs/configuring/vpc-direct-vpc#limitations - >- Packet is sent from or to a Compute Engine instance that is not in a running state. @@ -1916,6 +2705,34 @@ components: - >- Packet from the unknown peered network is dropped due to no known route from the source network to the destination IP address. + - >- + Sending packets processed by the Private NAT Gateways to the + Private Service Connect endpoints is not supported. + - >- + Packet is sent to the PSC port mapping service, but its + destination port does not match any port mapping rules. + - >- + Sending packets directly to the PSC port mapping service without + going through the PSC connection is not supported. + - >- + Packet with destination IP address within the reserved NAT64 range + is dropped due to matching a route of an unsupported type. + - >- + Packet could be dropped because hybrid endpoint like a VPN gateway + or Interconnect is not allowed to send traffic to the Internet. + - >- + Packet with destination IP address within the reserved NAT64 range + is dropped due to no matching NAT gateway in the subnet. + - >- + Packet is dropped due to being sent to a backend of a passthrough + load balancer that doesn't use the same IP version as the + frontend. + - >- + Packet from the unknown NCC network is dropped due to no known + route from the source network to the destination IP address. + - >- + Packet is dropped by Cloud NAT due to using an unsupported + protocol. enum: - CAUSE_UNSPECIFIED - UNKNOWN_EXTERNAL_ADDRESS @@ -1932,6 +2749,7 @@ components: - ROUTE_NEXT_HOP_VPN_TUNNEL_NOT_ESTABLISHED - ROUTE_NEXT_HOP_FORWARDING_RULE_TYPE_INVALID - NO_ROUTE_FROM_INTERNET_TO_PRIVATE_IPV6_ADDRESS + - NO_ROUTE_FROM_EXTERNAL_IPV6_SOURCE_TO_PRIVATE_IPV6_ADDRESS - VPN_TUNNEL_LOCAL_SELECTOR_MISMATCH - VPN_TUNNEL_REMOTE_SELECTOR_MISMATCH - PRIVATE_TRAFFIC_TO_INTERNET @@ -1942,6 +2760,7 @@ components: - FORWARDING_RULE_MISMATCH - FORWARDING_RULE_NO_INSTANCES - FIREWALL_BLOCKING_LOAD_BALANCER_BACKEND_HEALTH_CHECK + - INGRESS_FIREWALL_TAGS_UNSUPPORTED_BY_DIRECT_VPC_EGRESS - INSTANCE_NOT_RUNNING - GKE_CLUSTER_NOT_RUNNING - CLOUD_SQL_INSTANCE_NOT_RUNNING @@ -2000,6 +2819,15 @@ components: - NO_ADVERTISED_ROUTE_TO_GCP_DESTINATION - NO_TRAFFIC_SELECTOR_TO_GCP_DESTINATION - NO_KNOWN_ROUTE_FROM_PEERED_NETWORK_TO_DESTINATION + - PRIVATE_NAT_TO_PSC_ENDPOINT_UNSUPPORTED + - PSC_PORT_MAPPING_PORT_MISMATCH + - PSC_PORT_MAPPING_WITHOUT_PSC_CONNECTION_UNSUPPORTED + - UNSUPPORTED_ROUTE_MATCHED_FOR_NAT64_DESTINATION + - TRAFFIC_FROM_HYBRID_ENDPOINT_TO_INTERNET_DISALLOWED + - NO_MATCHING_NAT64_GATEWAY + - LOAD_BALANCER_BACKEND_IP_VERSION_MISMATCH + - NO_KNOWN_ROUTE_FROM_NCC_NETWORK_TO_DESTINATION + - CLOUD_NAT_PROTOCOL_UNSUPPORTED resourceUri: description: URI of the resource that caused the drop. type: string @@ -2012,6 +2840,14 @@ components: region: description: Region of the dropped packet (if relevant). type: string + sourceGeolocationCode: + description: Geolocation (region code) of the source IP address (if relevant). + type: string + destinationGeolocationCode: + description: >- + Geolocation (region code) of the destination IP address (if + relevant). + type: string LoadBalancerInfo: id: LoadBalancerInfo description: For display only. Metadata associated with a load balancer. @@ -2109,9 +2945,7 @@ components: type: string NetworkInfo: id: NetworkInfo - description: >- - For display only. Metadata associated with a Compute Engine network. - Next ID: 7 + description: For display only. Metadata associated with a Compute Engine network. type: object properties: displayName: @@ -2145,10 +2979,13 @@ components: description: URI of a GKE cluster network. type: string internalIp: - description: Internal IP address of a GKE cluster master. + description: Internal IP address of a GKE cluster control plane. type: string externalIp: - description: External IP address of a GKE cluster master. + description: External IP address of a GKE cluster control plane. + type: string + dnsEndpoint: + description: DNS endpoint of a GKE cluster control plane. type: string CloudSQLInstanceInfo: id: CloudSQLInstanceInfo @@ -2213,7 +3050,7 @@ components: type: string networkUri: description: >- - URI of a Redis Cluster network in format + URI of the network containing the Redis Cluster endpoints in format "projects/{project_id}/global/networks/{network_id}". type: string discoveryEndpointIpAddress: @@ -2564,13 +3401,20 @@ components: $ref: '#/components/schemas/LatencyDistribution' destinationEgressLocation: description: >- - The EdgeLocation from which a packet destined for/originating from - the internet will egress/ingress the Google network. This will only - be populated for a connectivity test which has an internet - destination/source address. The absence of this field *must not* be - used as an indication that the destination/source is part of the - Google network. + The EdgeLocation from which a packet, destined to the internet, will + egress the Google network. This will only be populated for a + connectivity test which has an internet destination address. The + absence of this field *must not* be used as an indication that the + destination is part of the Google network. $ref: '#/components/schemas/EdgeLocation' + edgeResponses: + description: Probing results for all edge devices. + type: array + items: + $ref: '#/components/schemas/SingleEdgeResponse' + probedAllDevices: + description: Whether all relevant edge devices were probed. + type: boolean LatencyDistribution: id: LatencyDistribution description: Describes measured latency distribution. @@ -2607,11 +3451,212 @@ components: metropolitanArea: description: Name of the metropolitan area. type: string + SingleEdgeResponse: + id: SingleEdgeResponse + description: Probing results for a single edge device. + type: object + properties: + result: + description: The overall result of active probing for this egress device. + type: string + enumDescriptions: + - No result was specified. + - At least 95% of packets reached the destination. + - No packets reached the destination. + - Less than 95% of packets reached the destination. + - >- + Reachability could not be determined. Possible reasons are: * The + user lacks permission to access some of the network resources + required to run the test. * No valid source endpoint could be + derived from the request. * An internal error occurred. + enum: + - PROBING_RESULT_UNSPECIFIED + - REACHABLE + - UNREACHABLE + - REACHABILITY_INCONSISTENT + - UNDETERMINED + sentProbeCount: + description: Number of probes sent. + type: integer + format: int32 + successfulProbeCount: + description: Number of probes that reached the destination. + type: integer + format: int32 + probingLatency: + description: >- + Latency as measured by active probing in one direction: from the + source to the destination endpoint. + $ref: '#/components/schemas/LatencyDistribution' + destinationEgressLocation: + description: >- + The EdgeLocation from which a packet, destined to the internet, will + egress the Google network. This will only be populated for a + connectivity test which has an internet destination address. The + absence of this field *must not* be used as an indication that the + destination is part of the Google network. + $ref: '#/components/schemas/EdgeLocation' + destinationRouter: + description: >- + Router name in the format '{router}.{metroshard}'. For example: + pf01.aaa01, pr02.aaa01. + type: string RerunConnectivityTestRequest: id: RerunConnectivityTestRequest description: Request for the `RerunConnectivityTest` method. type: object properties: {} + ListVpcFlowLogsConfigsResponse: + id: ListVpcFlowLogsConfigsResponse + description: Response for the `ListVpcFlowLogsConfigs` method. + type: object + properties: + vpcFlowLogsConfigs: + description: List of VPC Flow Log configurations. + type: array + items: + $ref: '#/components/schemas/VpcFlowLogsConfig' + nextPageToken: + description: Page token to fetch the next set of configurations. + type: string + unreachable: + description: >- + Locations that could not be reached (when querying all locations + with `-`). + type: array + items: + type: string + VpcFlowLogsConfig: + id: VpcFlowLogsConfig + description: A configuration to generate VPC Flow Logs. + type: object + properties: + name: + description: >- + Identifier. Unique name of the configuration. The name can have one + of the following forms: - For project-level configurations: + `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}` + - For organization-level configurations: + `organizations/{organization_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}` + type: string + description: + description: >- + Optional. The user-supplied description of the VPC Flow Logs + configuration. Maximum of 512 characters. + type: string + state: + description: >- + Optional. The state of the VPC Flow Log configuration. Default value + is ENABLED. When creating a new configuration, it must be enabled. + Setting state=DISABLED will pause the log generation for this + config. + type: string + enumDescriptions: + - If not specified, will default to ENABLED. + - When ENABLED, this configuration will generate logs. + - When DISABLED, this configuration will not generate logs. + enum: + - STATE_UNSPECIFIED + - ENABLED + - DISABLED + aggregationInterval: + description: >- + Optional. The aggregation interval for the logs. Default value is + INTERVAL_5_SEC. + type: string + enumDescriptions: + - If not specified, will default to INTERVAL_5_SEC. + - Aggregate logs in 5s intervals. + - Aggregate logs in 30s intervals. + - Aggregate logs in 1m intervals. + - Aggregate logs in 5m intervals. + - Aggregate logs in 10m intervals. + - Aggregate logs in 15m intervals. + enum: + - AGGREGATION_INTERVAL_UNSPECIFIED + - INTERVAL_5_SEC + - INTERVAL_30_SEC + - INTERVAL_1_MIN + - INTERVAL_5_MIN + - INTERVAL_10_MIN + - INTERVAL_15_MIN + flowSampling: + description: >- + Optional. The value of the field must be in (0, 1]. The sampling + rate of VPC Flow Logs where 1.0 means all collected logs are + reported. Setting the sampling rate to 0.0 is not allowed. If you + want to disable VPC Flow Logs, use the state field instead. Default + value is 1.0. + type: number + format: float + metadata: + description: >- + Optional. Configures whether all, none or a subset of metadata + fields should be added to the reported VPC flow logs. Default value + is INCLUDE_ALL_METADATA. + type: string + enumDescriptions: + - If not specified, will default to INCLUDE_ALL_METADATA. + - Include all metadata fields. + - Exclude all metadata fields. + - Include only custom fields (specified in metadata_fields). + enum: + - METADATA_UNSPECIFIED + - INCLUDE_ALL_METADATA + - EXCLUDE_ALL_METADATA + - CUSTOM_METADATA + metadataFields: + description: >- + Optional. Custom metadata fields to include in the reported VPC flow + logs. Can only be specified if "metadata" was set to + CUSTOM_METADATA. + type: array + items: + type: string + filterExpr: + description: >- + Optional. Export filter used to define which VPC Flow Logs should be + logged. + type: string + targetResourceState: + description: >- + Output only. Describes the state of the configured target resource + for diagnostic purposes. + readOnly: true + type: string + enumDescriptions: + - Unspecified target resource state. + - Indicates that the target resource exists. + - Indicates that the target resource does not exist. + enum: + - TARGET_RESOURCE_STATE_UNSPECIFIED + - TARGET_RESOURCE_EXISTS + - TARGET_RESOURCE_DOES_NOT_EXIST + interconnectAttachment: + description: >- + Traffic will be logged from the Interconnect Attachment. Format: + projects/{project_id}/regions/{region}/interconnectAttachments/{name} + type: string + vpnTunnel: + description: >- + Traffic will be logged from the VPN Tunnel. Format: + projects/{project_id}/regions/{region}/vpnTunnels/{name} + type: string + labels: + description: Optional. Resource labels to represent user-provided metadata. + type: object + additionalProperties: + type: string + createTime: + description: Output only. The time the config was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. The time the config was updated. + readOnly: true + type: string + format: google-datetime SetIamPolicyRequest: id: SetIamPolicyRequest description: Request message for `SetIamPolicy` method. @@ -3062,14 +4107,15 @@ components: methods: list: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1locations/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations get: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}/get response: mediaType: application/json openAPIDocKey: '200' @@ -3089,7 +4135,7 @@ components: list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1global~1operations/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1operations/get response: mediaType: application/json openAPIDocKey: '200' @@ -3097,21 +4143,21 @@ components: get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1global~1operations~1{operationsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1global~1operations~1{operationsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1operations~1{operationsId}/delete response: mediaType: application/json openAPIDocKey: '200' cancel: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1global~1operations~1{operationsId}:cancel/post + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' @@ -3220,23 +4266,755 @@ components: - $ref: >- #/components/x-stackQL-resources/connectivity_tests_iam_policies/methods/set_iam_policy delete: [] -paths: - /v1/projects/{projectsId}/locations: - parameters: &ref_1 - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/_.xgafv' + network_monitoring_providers: + id: google.networkmanagement.network_monitoring_providers + name: network_monitoring_providers + title: Network_monitoring_providers + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1networkMonitoringProviders/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.networkMonitoringProviders + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1networkMonitoringProviders/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1networkMonitoringProviders~1{networkMonitoringProvidersId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1networkMonitoringProviders~1{networkMonitoringProvidersId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/network_monitoring_providers/methods/get + - $ref: >- + #/components/x-stackQL-resources/network_monitoring_providers/methods/list + insert: + - $ref: >- + #/components/x-stackQL-resources/network_monitoring_providers/methods/create + update: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/network_monitoring_providers/methods/delete + monitoring_points: + id: google.networkmanagement.monitoring_points + name: monitoring_points + title: Monitoring_points + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1networkMonitoringProviders~1{networkMonitoringProvidersId}~1monitoringPoints/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.monitoringPoints + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1networkMonitoringProviders~1{networkMonitoringProvidersId}~1monitoringPoints~1{monitoringPointsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/monitoring_points/methods/get' + - $ref: '#/components/x-stackQL-resources/monitoring_points/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + network_paths: + id: google.networkmanagement.network_paths + name: network_paths + title: Network_paths + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1networkMonitoringProviders~1{networkMonitoringProvidersId}~1networkPaths/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.networkPaths + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1networkMonitoringProviders~1{networkMonitoringProvidersId}~1networkPaths~1{networkPathsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/network_paths/methods/get' + - $ref: '#/components/x-stackQL-resources/network_paths/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + web_paths: + id: google.networkmanagement.web_paths + name: web_paths + title: Web_paths + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1networkMonitoringProviders~1{networkMonitoringProvidersId}~1webPaths/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.webPaths + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1networkMonitoringProviders~1{networkMonitoringProvidersId}~1webPaths~1{webPathsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/web_paths/methods/get' + - $ref: '#/components/x-stackQL-resources/web_paths/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + vpc_flow_logs_configs: + id: google.networkmanagement.vpc_flow_logs_configs + name: vpc_flow_logs_configs + title: Vpc_flow_logs_configs + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1vpcFlowLogsConfigs/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.vpcFlowLogsConfigs + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1vpcFlowLogsConfigs/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1vpcFlowLogsConfigs~1{vpcFlowLogsConfigsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1vpcFlowLogsConfigs~1{vpcFlowLogsConfigsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1vpcFlowLogsConfigs~1{vpcFlowLogsConfigsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/vpc_flow_logs_configs/methods/get' + - $ref: >- + #/components/x-stackQL-resources/vpc_flow_logs_configs/methods/list + insert: + - $ref: >- + #/components/x-stackQL-resources/vpc_flow_logs_configs/methods/create + update: + - $ref: >- + #/components/x-stackQL-resources/vpc_flow_logs_configs/methods/patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/vpc_flow_logs_configs/methods/delete +paths: + /v1/projects/{projectsId}/locations: + parameters: &ref_1 + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' + get: + description: Lists information about the supported locations for this service. + operationId: networkmanagement.projects.locations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListLocationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: extraLocationTypes + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}: + parameters: *ref_1 + get: + description: Gets information about a location. + operationId: networkmanagement.projects.locations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Location' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/global/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: networkmanagement.projects.locations.global.operations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListOperationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/global/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: networkmanagement.projects.locations.global.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + delete: + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: networkmanagement.projects.locations.global.operations.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/global/operations/{operationsId}:cancel: + parameters: *ref_1 + post: + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + `1`, corresponding to `Code.CANCELLED`. + operationId: networkmanagement.projects.locations.global.operations.cancel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CancelOperationRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/global/connectivityTests: + parameters: *ref_1 + get: + description: Lists all Connectivity Tests owned by a project. + operationId: networkmanagement.projects.locations.global.connectivityTests.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListConnectivityTestsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + post: + description: >- + Creates a new Connectivity Test. After you create a test, the + reachability analysis is performed as part of the long running + operation, which completes when the analysis completes. If the endpoint + specifications in `ConnectivityTest` are invalid (for example, + containing non-existent resources in the network, or you don't have read + permissions to the network configurations of listed projects), then the + reachability result returns a value of `UNKNOWN`. If the endpoint + specifications in `ConnectivityTest` are incomplete, the reachability + result returns a value of AMBIGUOUS. For more information, see the + Connectivity Test documentation. + operationId: networkmanagement.projects.locations.global.connectivityTests.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ConnectivityTest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: query + name: testId + schema: + type: string + /v1/projects/{projectsId}/locations/global/connectivityTests/{connectivityTestsId}: + parameters: *ref_1 + get: + description: Gets the details of a specific Connectivity Test. + operationId: networkmanagement.projects.locations.global.connectivityTests.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ConnectivityTest' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: connectivityTestsId + required: true + schema: + type: string + patch: + description: >- + Updates the configuration of an existing `ConnectivityTest`. After you + update a test, the reachability analysis is performed as part of the + long running operation, which completes when the analysis completes. The + Reachability state in the test resource is updated with the new result. + If the endpoint specifications in `ConnectivityTest` are invalid (for + example, they contain non-existent resources in the network, or the user + does not have read permissions to the network configurations of listed + projects), then the reachability result returns a value of UNKNOWN. If + the endpoint specifications in `ConnectivityTest` are incomplete, the + reachability result returns a value of `AMBIGUOUS`. See the + documentation in `ConnectivityTest` for more details. + operationId: networkmanagement.projects.locations.global.connectivityTests.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ConnectivityTest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: connectivityTestsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a specific `ConnectivityTest`. + operationId: networkmanagement.projects.locations.global.connectivityTests.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: connectivityTestsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/global/connectivityTests/{connectivityTestsId}:rerun: + parameters: *ref_1 + post: + description: >- + Rerun an existing `ConnectivityTest`. After the user triggers the rerun, + the reachability analysis is performed as part of the long running + operation, which completes when the analysis completes. Even though the + test configuration remains the same, the reachability result may change + due to underlying network configuration changes. If the endpoint + specifications in `ConnectivityTest` become invalid (for example, + specified resources are deleted in the network, or you lost read + permissions to the network configurations of listed projects), then the + reachability result returns a value of `UNKNOWN`. + operationId: networkmanagement.projects.locations.global.connectivityTests.rerun + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RerunConnectivityTestRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: connectivityTestsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/global/connectivityTests/{connectivityTestsId}:setIamPolicy: + parameters: *ref_1 + post: + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and + `PERMISSION_DENIED` errors. + operationId: >- + networkmanagement.projects.locations.global.connectivityTests.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetIamPolicyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: connectivityTestsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/global/connectivityTests/{connectivityTestsId}:getIamPolicy: + parameters: *ref_1 + get: + description: >- + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: >- + networkmanagement.projects.locations.global.connectivityTests.getIamPolicy + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: connectivityTestsId + required: true + schema: + type: string + - in: query + name: options.requestedPolicyVersion + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/global/connectivityTests/{connectivityTestsId}:testIamPermissions: + parameters: *ref_1 + post: + description: >- + Returns permissions that a caller has on the specified resource. If the + resource does not exist, this will return an empty set of permissions, + not a `NOT_FOUND` error. Note: This operation is designed to be used for + building permission-aware UIs and command-line tools, not for + authorization checking. This operation may "fail open" without warning. + operationId: >- + networkmanagement.projects.locations.global.connectivityTests.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: connectivityTestsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/networkMonitoringProviders: + parameters: *ref_1 get: - description: Lists information about the supported locations for this service. - operationId: networkmanagement.projects.locations.list + description: Lists NetworkMonitoringProviders for a given project and location. + operationId: networkmanagement.projects.locations.networkMonitoringProviders.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3248,15 +5026,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListLocationsResponse' + $ref: '#/components/schemas/ListNetworkMonitoringProvidersResponse' parameters: - in: path name: projectsId required: true schema: type: string - - in: query - name: filter + - in: path + name: locationsId + required: true schema: type: string - in: query @@ -3268,11 +5047,46 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}: + post: + description: Creates a NetworkMonitoringProvider resource. + operationId: networkmanagement.projects.locations.networkMonitoringProviders.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkMonitoringProvider' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: networkMonitoringProviderId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/networkMonitoringProviders/{networkMonitoringProvidersId}: parameters: *ref_1 get: - description: Gets information about a location. - operationId: networkmanagement.projects.locations.get + description: Gets the NetworkMonitoringProvider resource. + operationId: networkmanagement.projects.locations.networkMonitoringProviders.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3284,7 +5098,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Location' + $ref: '#/components/schemas/NetworkMonitoringProvider' parameters: - in: path name: projectsId @@ -3296,13 +5110,50 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/global/operations: + - in: path + name: networkMonitoringProvidersId + required: true + schema: + type: string + delete: + description: >- + Deletes a NetworkMonitoringProvider resource and all of its child + resources. + operationId: networkmanagement.projects.locations.networkMonitoringProviders.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: networkMonitoringProvidersId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/networkMonitoringProviders/{networkMonitoringProvidersId}/monitoringPoints: parameters: *ref_1 get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: networkmanagement.projects.locations.global.operations.list + description: Lists MonitoringPoints for a given network monitoring provider. + operationId: >- + networkmanagement.projects.locations.networkMonitoringProviders.monitoringPoints.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3314,15 +5165,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListOperationsResponse' + $ref: '#/components/schemas/ListMonitoringPointsResponse' parameters: - in: path name: projectsId required: true schema: type: string - - in: query - name: filter + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: networkMonitoringProvidersId + required: true schema: type: string - in: query @@ -3334,14 +5191,12 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/global/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/networkMonitoringProviders/{networkMonitoringProvidersId}/monitoringPoints/{monitoringPointsId}: parameters: *ref_1 get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: networkmanagement.projects.locations.global.operations.get + description: Gets the MonitoringPoint resource. + operationId: >- + networkmanagement.projects.locations.networkMonitoringProviders.monitoringPoints.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3353,7 +5208,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/MonitoringPoint' parameters: - in: path name: projectsId @@ -3361,17 +5216,26 @@ paths: schema: type: string - in: path - name: operationsId + name: locationsId required: true schema: type: string - delete: - description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: networkmanagement.projects.locations.global.operations.delete + - in: path + name: networkMonitoringProvidersId + required: true + schema: + type: string + - in: path + name: monitoringPointsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/networkMonitoringProviders/{networkMonitoringProvidersId}/networkPaths: + parameters: *ref_1 + get: + description: Lists NetworkPaths for a given network monitoring provider. + operationId: >- + networkmanagement.projects.locations.networkMonitoringProviders.networkPaths.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3383,7 +5247,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/ListNetworkPathsResponse' parameters: - in: path name: projectsId @@ -3391,29 +5255,112 @@ paths: schema: type: string - in: path - name: operationsId + name: locationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/global/operations/{operationsId}:cancel: + - in: path + name: networkMonitoringProvidersId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/networkMonitoringProviders/{networkMonitoringProvidersId}/networkPaths/{networkPathsId}: parameters: *ref_1 - post: - description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: networkmanagement.projects.locations.global.operations.cancel - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CancelOperationRequest' + get: + description: Gets the NetworkPath resource. + operationId: >- + networkmanagement.projects.locations.networkMonitoringProviders.networkPaths.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkPath' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: networkMonitoringProvidersId + required: true + schema: + type: string + - in: path + name: networkPathsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/networkMonitoringProviders/{networkMonitoringProvidersId}/webPaths: + parameters: *ref_1 + get: + description: Lists WebPaths for a given network monitoring provider. + operationId: >- + networkmanagement.projects.locations.networkMonitoringProviders.webPaths.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListWebPathsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: networkMonitoringProvidersId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/networkMonitoringProviders/{networkMonitoringProvidersId}/webPaths/{webPathsId}: + parameters: *ref_1 + get: + description: Gets the WebPath resource. + operationId: >- + networkmanagement.projects.locations.networkMonitoringProviders.webPaths.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3425,7 +5372,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/WebPath' parameters: - in: path name: projectsId @@ -3433,15 +5380,25 @@ paths: schema: type: string - in: path - name: operationsId + name: locationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/global/connectivityTests: + - in: path + name: networkMonitoringProvidersId + required: true + schema: + type: string + - in: path + name: webPathsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/vpcFlowLogsConfigs: parameters: *ref_1 get: - description: Lists all Connectivity Tests owned by a project. - operationId: networkmanagement.projects.locations.global.connectivityTests.list + description: Lists all `VpcFlowLogsConfigs` in a given project. + operationId: networkmanagement.projects.locations.vpcFlowLogsConfigs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3453,13 +5410,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListConnectivityTestsResponse' + $ref: '#/components/schemas/ListVpcFlowLogsConfigsResponse' parameters: - in: path name: projectsId required: true schema: type: string + - in: path + name: locationsId + required: true + schema: + type: string - in: query name: pageSize schema: @@ -3479,22 +5441,20 @@ paths: type: string post: description: >- - Creates a new Connectivity Test. After you create a test, the - reachability analysis is performed as part of the long running - operation, which completes when the analysis completes. If the endpoint - specifications in `ConnectivityTest` are invalid (for example, - containing non-existent resources in the network, or you don't have read - permissions to the network configurations of listed projects), then the - reachability result returns a value of `UNKNOWN`. If the endpoint - specifications in `ConnectivityTest` are incomplete, the reachability - result returns a value of AMBIGUOUS. For more information, see the - Connectivity Test documentation. - operationId: networkmanagement.projects.locations.global.connectivityTests.create + Creates a new `VpcFlowLogsConfig`. If a configuration with the exact + same settings already exists (even if the ID is different), the creation + fails. Notes: 1. Creating a configuration with `state=DISABLED` will + fail 2. The following fields are not considered as settings for the + purpose of the check mentioned above, therefore - creating another + configuration with the same fields but different values for the + following fields will fail as well: * name * create_time * update_time * + labels * description + operationId: networkmanagement.projects.locations.vpcFlowLogsConfigs.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/ConnectivityTest' + $ref: '#/components/schemas/VpcFlowLogsConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3513,15 +5473,20 @@ paths: required: true schema: type: string + - in: path + name: locationsId + required: true + schema: + type: string - in: query - name: testId + name: vpcFlowLogsConfigId schema: type: string - /v1/projects/{projectsId}/locations/global/connectivityTests/{connectivityTestsId}: + /v1/projects/{projectsId}/locations/{locationsId}/vpcFlowLogsConfigs/{vpcFlowLogsConfigsId}: parameters: *ref_1 get: - description: Gets the details of a specific Connectivity Test. - operationId: networkmanagement.projects.locations.global.connectivityTests.get + description: Gets the details of a specific `VpcFlowLogsConfig`. + operationId: networkmanagement.projects.locations.vpcFlowLogsConfigs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3533,7 +5498,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ConnectivityTest' + $ref: '#/components/schemas/VpcFlowLogsConfig' parameters: - in: path name: projectsId @@ -3541,29 +5506,31 @@ paths: schema: type: string - in: path - name: connectivityTestsId + name: locationsId + required: true + schema: + type: string + - in: path + name: vpcFlowLogsConfigsId required: true schema: type: string patch: description: >- - Updates the configuration of an existing `ConnectivityTest`. After you - update a test, the reachability analysis is performed as part of the - long running operation, which completes when the analysis completes. The - Reachability state in the test resource is updated with the new result. - If the endpoint specifications in `ConnectivityTest` are invalid (for - example, they contain non-existent resources in the network, or the user - does not have read permissions to the network configurations of listed - projects), then the reachability result returns a value of UNKNOWN. If - the endpoint specifications in `ConnectivityTest` are incomplete, the - reachability result returns a value of `AMBIGUOUS`. See the - documentation in `ConnectivityTest` for more details. - operationId: networkmanagement.projects.locations.global.connectivityTests.patch + Updates an existing `VpcFlowLogsConfig`. If a configuration with the + exact same settings already exists (even if the ID is different), the + creation fails. Notes: 1. Updating a configuration with `state=DISABLED` + will fail. 2. The following fields are not considered as settings for + the purpose of the check mentioned above, therefore - updating another + configuration with the same fields but different values for the + following fields will fail as well: * name * create_time * update_time * + labels * description + operationId: networkmanagement.projects.locations.vpcFlowLogsConfigs.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/ConnectivityTest' + $ref: '#/components/schemas/VpcFlowLogsConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3583,7 +5550,12 @@ paths: schema: type: string - in: path - name: connectivityTestsId + name: locationsId + required: true + schema: + type: string + - in: path + name: vpcFlowLogsConfigsId required: true schema: type: string @@ -3593,8 +5565,8 @@ paths: type: string format: google-fieldmask delete: - description: Deletes a specific `ConnectivityTest`. - operationId: networkmanagement.projects.locations.global.connectivityTests.delete + description: Deletes a specific `VpcFlowLogsConfig`. + operationId: networkmanagement.projects.locations.vpcFlowLogsConfigs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3614,29 +5586,20 @@ paths: schema: type: string - in: path - name: connectivityTestsId + name: locationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/global/connectivityTests/{connectivityTestsId}:rerun: + - in: path + name: vpcFlowLogsConfigsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/locations: parameters: *ref_1 - post: - description: >- - Rerun an existing `ConnectivityTest`. After the user triggers the rerun, - the reachability analysis is performed as part of the long running - operation, which completes when the analysis completes. Even though the - test configuration remains the same, the reachability result may change - due to underlying network configuration changes. If the endpoint - specifications in `ConnectivityTest` become invalid (for example, - specified resources are deleted in the network, or you lost read - permissions to the network configurations of listed projects), then the - reachability result returns a value of `UNKNOWN`. - operationId: networkmanagement.projects.locations.global.connectivityTests.rerun - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RerunConnectivityTestRequest' + get: + description: Lists information about the supported locations for this service. + operationId: networkmanagement.organizations.locations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3648,32 +5611,35 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/ListLocationsResponse' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string - - in: path - name: connectivityTestsId - required: true + - in: query + name: filter schema: type: string - /v1/projects/{projectsId}/locations/global/connectivityTests/{connectivityTestsId}:setIamPolicy: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: extraLocationTypes + schema: + type: string + /v1/organizations/{organizationsId}/locations/{locationsId}: parameters: *ref_1 - post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - `PERMISSION_DENIED` errors. - operationId: >- - networkmanagement.projects.locations.global.connectivityTests.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SetIamPolicyRequest' + get: + description: Gets information about a location. + operationId: networkmanagement.organizations.locations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3685,26 +5651,25 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Location' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string - in: path - name: connectivityTestsId + name: locationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/global/connectivityTests/{connectivityTestsId}:getIamPolicy: + /v1/organizations/{organizationsId}/locations/{locationsId}/operations: parameters: *ref_1 get: description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: >- - networkmanagement.projects.locations.global.connectivityTests.getIamPolicy + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: networkmanagement.organizations.locations.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3716,39 +5681,121 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/ListOperationsResponse' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string - in: path - name: connectivityTestsId + name: locationsId required: true schema: type: string - in: query - name: options.requestedPolicyVersion + name: filter + schema: + type: string + - in: query + name: pageSize schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/global/connectivityTests/{connectivityTestsId}:testIamPermissions: + - in: query + name: pageToken + schema: + type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: networkmanagement.organizations.locations.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + delete: + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: networkmanagement.organizations.locations.operations.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- - Returns permissions that a caller has on the specified resource. If the - resource does not exist, this will return an empty set of permissions, - not a `NOT_FOUND` error. Note: This operation is designed to be used for - building permission-aware UIs and command-line tools, not for - authorization checking. This operation may "fail open" without warning. - operationId: >- - networkmanagement.projects.locations.global.connectivityTests.testIamPermissions + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + `1`, corresponding to `Code.CANCELLED`. + operationId: networkmanagement.organizations.locations.operations.cancel requestBody: content: application/json: schema: - $ref: '#/components/schemas/TestIamPermissionsRequest' + $ref: '#/components/schemas/CancelOperationRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3760,15 +5807,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TestIamPermissionsResponse' + $ref: '#/components/schemas/Empty' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string - in: path - name: connectivityTestsId + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId required: true schema: type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/networksecurity.yaml b/providers/src/googleapis.com/v00.00.00000/services/networksecurity.yaml index a3ca77cd..101151c3 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/networksecurity.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/networksecurity.yaml @@ -7,8 +7,8 @@ info: title: Network Security API description: '' version: v1 - x-discovery-doc-revision: '20240919' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250806' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/networking servers: @@ -162,6 +162,11 @@ components: results, call this method again using the value of `next_page_token` as `page_token`. type: string + unreachable: + description: Locations that could not be reached. + type: array + items: + type: string AddressGroup: id: AddressGroup description: >- @@ -363,11 +368,11 @@ components: type: string FirewallEndpoint: id: FirewallEndpoint - description: Message describing Endpoint object + description: Message describing Endpoint object. type: object properties: name: - description: Immutable. Identifier. name of resource + description: Immutable. Identifier. Name of resource. type: string description: description: >- @@ -375,7 +380,7 @@ components: characters. type: string createTime: - description: Output only. Create time stamp + description: Output only. Create time stamp. readOnly: true type: string format: google-datetime @@ -432,6 +437,14 @@ components: type: array items: $ref: '#/components/schemas/FirewallEndpointAssociationReference' + satisfiesPzs: + description: Output only. [Output Only] Reserved for future use. + readOnly: true + type: boolean + satisfiesPzi: + description: Output only. [Output Only] Reserved for future use. + readOnly: true + type: boolean billingProjectId: description: Required. Project to bill on endpoint uptime usage. type: string @@ -506,7 +519,7 @@ components: - Active and ready for traffic. - Being deleted. - Down or in an error state. - - The GCP project that housed the association has been deleted. + - The project that housed the association has been deleted. enum: - STATE_UNSPECIFIED - CREATING @@ -536,1683 +549,3690 @@ components: Optional. Whether the association is disabled. True indicates that traffic won't be intercepted type: boolean - ListAuthorizationPoliciesResponse: - id: ListAuthorizationPoliciesResponse - description: Response returned by the ListAuthorizationPolicies method. + ListInterceptEndpointGroupsResponse: + id: ListInterceptEndpointGroupsResponse + description: Response message for ListInterceptEndpointGroups. type: object properties: - authorizationPolicies: - description: List of AuthorizationPolicies resources. + interceptEndpointGroups: + description: The endpoint groups from the specified parent. type: array items: - $ref: '#/components/schemas/AuthorizationPolicy' + $ref: '#/components/schemas/InterceptEndpointGroup' nextPageToken: description: >- - If there might be more results than those appearing in this - response, then `next_page_token` is included. To get the next set of - results, call this method again using the value of `next_page_token` - as `page_token`. + A token that can be sent as `page_token` to retrieve the next page. + If this field is omitted, there are no subsequent pages. See + https://google.aip.dev/158 for more details. type: string - AuthorizationPolicy: - id: AuthorizationPolicy + InterceptEndpointGroup: + id: InterceptEndpointGroup description: >- - AuthorizationPolicy is a resource that specifies how a server should - authorize incoming connections. This resource in itself does not change - the configuration unless it's attached to a target https proxy or - endpoint config selector resource. + An endpoint group is a consumer frontend for a deployment group + (backend). In order to configure intercept for a network, consumers must + create: - An association between their network and the endpoint group. - + A security profile that points to the endpoint group. - A firewall rule + that references the security profile (group). type: object properties: name: description: >- - Required. Name of the AuthorizationPolicy resource. It matches - pattern - `projects/{project}/locations/{location}/authorizationPolicies/`. - type: string - description: - description: Optional. Free-text description of the resource. + Immutable. Identifier. The resource name of this endpoint group, for + example: + `projects/123456789/locations/global/interceptEndpointGroups/my-eg`. + See https://google.aip.dev/122 for more details. type: string createTime: - description: Output only. The timestamp when the resource was created. + description: >- + Output only. The timestamp when the resource was created. See + https://google.aip.dev/148#timestamps. readOnly: true type: string format: google-datetime updateTime: - description: Output only. The timestamp when the resource was updated. + description: >- + Output only. The timestamp when the resource was most recently + updated. See https://google.aip.dev/148#timestamps. readOnly: true type: string format: google-datetime labels: description: >- - Optional. Set of label tags associated with the AuthorizationPolicy - resource. + Optional. Labels are key/value pairs that help to organize and + filter resources. type: object additionalProperties: type: string - action: + interceptDeploymentGroup: description: >- - Required. The action to take when a rule match is found. Possible - values are "ALLOW" or "DENY". + Required. Immutable. The deployment group that this endpoint group + is connected to, for example: + `projects/123456789/locations/global/interceptDeploymentGroups/my-dg`. + See https://google.aip.dev/124. + type: string + connectedDeploymentGroup: + description: >- + Output only. Details about the connected deployment group to this + endpoint group. + readOnly: true + $ref: '#/components/schemas/InterceptEndpointGroupConnectedDeploymentGroup' + state: + description: >- + Output only. The current state of the endpoint group. See + https://google.aip.dev/216. + readOnly: true type: string enumDescriptions: - - Default value. - - Grant access. + - State not set (this is not a valid state). - >- - Deny access. Deny rules should be avoided unless they are used to - provide a default "deny all" fallback. + The endpoint group is ready and in sync with the target deployment + group. + - >- + The deployment group backing this endpoint group has been + force-deleted. This endpoint group cannot be used and interception + is effectively disabled. + - The endpoint group is being created. + - The endpoint group is being deleted. + - >- + The endpoint group is out of sync with the backing deployment + group. In most cases, this is a result of a transient issue within + the system (e.g. an inaccessible location) and the system is + expected to recover automatically. See the associations field for + details per network and location. + - >- + An attempt to delete the endpoint group has failed. This is a + terminal state and the endpoint group is not expected to recover. + The only permitted operation is to retry deleting the endpoint + group. enum: - - ACTION_UNSPECIFIED - - ALLOW - - DENY - rules: - description: >- - Optional. List of rules to match. Note that at least one of the - rules must match in order for the action specified in the 'action' - field to be taken. A rule is a match if there is a matching source - and destination. If left blank, the action specified in the `action` - field will be applied on every request. - type: array - items: - $ref: '#/components/schemas/Rule' - Rule: - id: Rule - description: Specification of rules. - type: object - properties: - sources: + - STATE_UNSPECIFIED + - ACTIVE + - CLOSED + - CREATING + - DELETING + - OUT_OF_SYNC + - DELETE_FAILED + reconciling: description: >- - Optional. List of attributes for the traffic source. All of the - sources must match. A source is a match if both principals and - ip_blocks match. If not set, the action specified in the 'action' - field will be applied without any rule checks for the source. + Output only. The current state of the resource does not match the + user's intended state, and the system is working to reconcile them. + This is part of the normal operation (e.g. adding a new association + to the group). See https://google.aip.dev/128. + readOnly: true + type: boolean + associations: + description: Output only. List of associations to this endpoint group. + readOnly: true type: array items: - $ref: '#/components/schemas/Source' - destinations: + $ref: '#/components/schemas/InterceptEndpointGroupAssociationDetails' + description: description: >- - Optional. List of attributes for the traffic destination. All of the - destinations must match. A destination is a match if a request - matches all the specified hosts, ports, methods and headers. If not - set, the action specified in the 'action' field will be applied - without any rule checks for the destination. - type: array - items: - $ref: '#/components/schemas/Destination' - Source: - id: Source - description: Specification of traffic source attributes. + Optional. User-provided description of the endpoint group. Used as + additional context for the endpoint group. + type: string + InterceptEndpointGroupConnectedDeploymentGroup: + id: InterceptEndpointGroupConnectedDeploymentGroup + description: The endpoint group's view of a connected deployment group. type: object properties: - principals: + name: description: >- - Optional. List of peer identities to match for authorization. At - least one principal should match. Each peer can be an exact match, - or a prefix match (example, "namespace/*") or a suffix match - (example, "*/service-account") or a presence match "*". - Authorization based on the principal name without certificate - validation (configured by ServerTlsPolicy resource) is considered - insecure. - type: array - items: - type: string - ipBlocks: + Output only. The connected deployment group's resource name, for + example: + `projects/123456789/locations/global/interceptDeploymentGroups/my-dg`. + See https://google.aip.dev/124. + readOnly: true + type: string + locations: description: >- - Optional. List of CIDR ranges to match based on source IP address. - At least one IP block should match. Single IP (e.g., "1.2.3.4") and - CIDR (e.g., "1.2.3.0/24") are supported. Authorization based on - source IP alone should be avoided. The IP addresses of any load - balancers or proxies should be considered untrusted. + Output only. The list of locations where the deployment group is + present. + readOnly: true type: array items: - type: string - Destination: - id: Destination - description: Specification of traffic destination attributes. + $ref: '#/components/schemas/InterceptLocation' + InterceptLocation: + id: InterceptLocation + description: Details about intercept in a specific cloud location. type: object properties: - hosts: - description: >- - Required. List of host names to match. Matched against the - ":authority" header in http requests. At least one host should - match. Each host can be an exact match, or a prefix match (example - "mydomain.*") or a suffix match (example "*.myorg.com") or a - presence (any) match "*". - type: array - items: - type: string - ports: - description: >- - Required. List of destination ports to match. At least one port - should match. - type: array - items: - type: integer - format: uint32 - methods: - description: >- - Optional. A list of HTTP methods to match. At least one method - should match. Should not be set for gRPC services. - type: array - items: - type: string - httpHeaderMatch: + location: description: >- - Optional. Match against key:value pair in http header. Provides a - flexible match based on HTTP headers, for potentially advanced use - cases. At least one header should match. Avoid using header matches - to make authorization decisions unless there is a strong guarantee - that requests arrive through a trusted client or proxy. - $ref: '#/components/schemas/HttpHeaderMatch' - HttpHeaderMatch: - id: HttpHeaderMatch - description: Specification of HTTP header match attributes. + Output only. The cloud location, e.g. "us-central1-a" or + "asia-south1". + readOnly: true + type: string + state: + description: Output only. The current state of the association in this location. + readOnly: true + type: string + enumDescriptions: + - State not set (this is not a valid state). + - The resource is ready and in sync in the location. + - >- + The resource is out of sync in the location. In most cases, this + is a result of a transient issue within the system (e.g. an + inaccessible location) and the system is expected to recover + automatically. + enum: + - STATE_UNSPECIFIED + - ACTIVE + - OUT_OF_SYNC + InterceptEndpointGroupAssociationDetails: + id: InterceptEndpointGroupAssociationDetails + description: The endpoint group's view of a connected association. type: object properties: - regexMatch: + name: description: >- - Required. The value of the header must match the regular expression - specified in regexMatch. For regular expression grammar, please see: - en.cppreference.com/w/cpp/regex/ecmascript For matching against a - port specified in the HTTP request, use a headerMatch with - headerName set to Host and a regular expression that satisfies the - RFC2616 Host header's port specifier. + Output only. The connected association's resource name, for example: + `projects/123456789/locations/global/interceptEndpointGroupAssociations/my-ega`. + See https://google.aip.dev/124. + readOnly: true type: string - headerName: + network: description: >- - Required. 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". + Output only. The associated network, for example: + projects/123456789/global/networks/my-network. See + https://google.aip.dev/124. + readOnly: true type: string - ListServerTlsPoliciesResponse: - id: ListServerTlsPoliciesResponse - description: Response returned by the ListServerTlsPolicies method. + state: + description: Output only. Most recent known state of the association. + readOnly: true + type: string + enumDescriptions: + - Not set. + - >- + The association is ready and in sync with the linked endpoint + group. + - The association is being created. + - The association is being deleted. + - >- + The association is disabled due to a breaking change in another + resource. + - >- + The association is out of sync with the linked endpoint group. In + most cases, this is a result of a transient issue within the + system (e.g. an inaccessible location) and the system is expected + to recover automatically. Check the `locations_details` field for + more details. + - >- + An attempt to delete the association has failed. This is a + terminal state and the association is not expected to be usable as + some of its resources have been deleted. The only permitted + operation is to retry deleting the association. + enum: + - STATE_UNSPECIFIED + - ACTIVE + - CREATING + - DELETING + - CLOSED + - OUT_OF_SYNC + - DELETE_FAILED + ListInterceptEndpointGroupAssociationsResponse: + id: ListInterceptEndpointGroupAssociationsResponse + description: Response message for ListInterceptEndpointGroupAssociations. type: object properties: - serverTlsPolicies: - description: List of ServerTlsPolicy resources. + interceptEndpointGroupAssociations: + description: The associations from the specified parent. type: array items: - $ref: '#/components/schemas/ServerTlsPolicy' + $ref: '#/components/schemas/InterceptEndpointGroupAssociation' nextPageToken: description: >- - If there might be more results than those appearing in this - response, then `next_page_token` is included. To get the next set of - results, call this method again using the value of `next_page_token` - as `page_token`. + A token that can be sent as `page_token` to retrieve the next page. + If this field is omitted, there are no subsequent pages. See + https://google.aip.dev/158 for more details. type: string - ServerTlsPolicy: - id: ServerTlsPolicy + InterceptEndpointGroupAssociation: + id: InterceptEndpointGroupAssociation description: >- - ServerTlsPolicy is a resource that specifies how a server should - authenticate incoming requests. This resource itself does not affect - configuration unless it is attached to a target HTTPS proxy or endpoint - config selector resource. ServerTlsPolicy in the form accepted by - Application Load Balancers can be attached only to TargetHttpsProxy with - an `EXTERNAL`, `EXTERNAL_MANAGED` or `INTERNAL_MANAGED` load balancing - scheme. Traffic Director compatible ServerTlsPolicies can be attached to - EndpointPolicy and TargetHttpsProxy with Traffic Director - `INTERNAL_SELF_MANAGED` load balancing scheme. + An endpoint group association represents a link between a network and an + endpoint group in the organization. Creating an association creates the + networking infrastructure linking the network to the endpoint group, but + does not enable intercept by itself. To enable intercept, the user must + also create a network firewall policy containing intercept rules and + associate it with the network. type: object properties: name: description: >- - Required. Name of the ServerTlsPolicy resource. It matches the - pattern - `projects/*/locations/{location}/serverTlsPolicies/{server_tls_policy}` - type: string - description: - description: Free-text description of the resource. + Immutable. Identifier. The resource name of this endpoint group + association, for example: + `projects/123456789/locations/global/interceptEndpointGroupAssociations/my-eg-association`. + See https://google.aip.dev/122 for more details. type: string createTime: - description: Output only. The timestamp when the resource was created. + description: >- + Output only. The timestamp when the resource was created. See + https://google.aip.dev/148#timestamps. readOnly: true type: string format: google-datetime updateTime: - description: Output only. The timestamp when the resource was updated. + description: >- + Output only. The timestamp when the resource was most recently + updated. See https://google.aip.dev/148#timestamps. readOnly: true type: string format: google-datetime labels: - description: Set of label tags associated with the resource. + description: >- + Optional. Labels are key/value pairs that help to organize and + filter resources. type: object additionalProperties: type: string - allowOpen: + interceptEndpointGroup: description: >- - This field applies only for Traffic Director policies. It is must be - set to false for Application Load Balancer policies. Determines if - server allows plaintext connections. If set to true, server allows - plain text connections. By default, it is set to false. This setting - is not exclusive of other encryption modes. For example, if - `allow_open` and `mtls_policy` are set, server allows both plain - text and mTLS connections. See documentation of other encryption - modes to confirm compatibility. Consider using it if you wish to - upgrade in place your deployment to TLS while having mixed TLS and - non-TLS traffic reaching port :80. - type: boolean - serverCertificate: + Required. Immutable. The endpoint group that this association is + connected to, for example: + `projects/123456789/locations/global/interceptEndpointGroups/my-eg`. + See https://google.aip.dev/124. + type: string + network: description: >- - Optional if policy is to be used with Traffic Director. For - Application Load Balancers must be empty. Defines a mechanism to - provision server identity (public and private keys). Cannot be - combined with `allow_open` as a permissive mode that allows both - plain text and TLS is not supported. - $ref: '#/components/schemas/GoogleCloudNetworksecurityV1CertificateProvider' - mtlsPolicy: - description: >- - This field is required if the policy is used with Application Load - Balancers. This field can be empty for Traffic Director. Defines a - mechanism to provision peer validation certificates for peer to peer - authentication (Mutual TLS - mTLS). If not specified, client - certificate will not be requested. The connection is treated as TLS - and not mTLS. If `allow_open` and `mtls_policy` are set, server - allows both plain text and mTLS connections. - $ref: '#/components/schemas/MTLSPolicy' - GoogleCloudNetworksecurityV1CertificateProvider: - id: GoogleCloudNetworksecurityV1CertificateProvider - description: >- - Specification of certificate provider. Defines the mechanism to obtain - the certificate and private key for peer to peer authentication. - type: object - properties: - grpcEndpoint: - description: >- - gRPC specific configuration to access the gRPC server to obtain the - cert and private key. - $ref: '#/components/schemas/GoogleCloudNetworksecurityV1GrpcEndpoint' - certificateProviderInstance: - description: >- - The certificate provider instance specification that will be passed - to the data plane, which will be used to load necessary credential - information. - $ref: '#/components/schemas/CertificateProviderInstance' - GoogleCloudNetworksecurityV1GrpcEndpoint: - id: GoogleCloudNetworksecurityV1GrpcEndpoint - description: Specification of the GRPC Endpoint. - type: object - properties: - targetUri: - description: >- - Required. The target URI of the gRPC endpoint. Only UDS path is - supported, and should start with "unix:". - type: string - CertificateProviderInstance: - id: CertificateProviderInstance - description: >- - Specification of a TLS certificate provider instance. Workloads may have - one or more CertificateProvider instances (plugins) and one of them is - enabled and configured by specifying this message. Workloads use the - values from this message to locate and load the CertificateProvider - instance configuration. - type: object - properties: - pluginInstance: - description: >- - Required. Plugin instance name, used to locate and load - CertificateProvider instance configuration. Set to - "google_cloud_private_spiffe" to use Certificate Authority Service - certificate provider instance. + Required. Immutable. The VPC network that is associated. for + example: `projects/123456789/global/networks/my-network`. See + https://google.aip.dev/124. type: string - MTLSPolicy: - id: MTLSPolicy - description: Specification of the MTLSPolicy. - type: object - properties: - clientValidationMode: + locationsDetails: description: >- - When the client presents an invalid certificate or no certificate to - the load balancer, the `client_validation_mode` specifies how the - client connection is handled. Required if the policy is to be used - with the Application Load Balancers. For Traffic Director it must be - empty. + Output only. The list of locations where the association is present. + This information is retrieved from the linked endpoint group, and + not configured as part of the association itself. + readOnly: true + deprecated: true + type: array + items: + $ref: >- + #/components/schemas/InterceptEndpointGroupAssociationLocationDetails + state: + description: Output only. Current state of the endpoint group association. + readOnly: true type: string enumDescriptions: - - Not allowed. + - Not set. - >- - Allow connection even if certificate chain validation of the - client certificate failed or no client certificate was presented. - The proof of possession of the private key is always checked if - client certificate was presented. This mode requires the backend - to implement processing of data extracted from a client - certificate to authenticate the peer, or to reject connections if - the client certificate fingerprint is missing. + The association is ready and in sync with the linked endpoint + group. + - The association is being created. + - The association is being deleted. - >- - Require a client certificate and allow connection to the backend - only if validation of the client certificate passed. If set, - requires a reference to non-empty TrustConfig specified in - `client_validation_trust_config`. + The association is disabled due to a breaking change in another + resource. + - >- + The association is out of sync with the linked endpoint group. In + most cases, this is a result of a transient issue within the + system (e.g. an inaccessible location) and the system is expected + to recover automatically. Check the `locations_details` field for + more details. + - >- + An attempt to delete the association has failed. This is a + terminal state and the association is not expected to be usable as + some of its resources have been deleted. The only permitted + operation is to retry deleting the association. enum: - - CLIENT_VALIDATION_MODE_UNSPECIFIED - - ALLOW_INVALID_OR_MISSING_CLIENT_CERT - - REJECT_INVALID - clientValidationCa: + - STATE_UNSPECIFIED + - ACTIVE + - CREATING + - DELETING + - CLOSED + - OUT_OF_SYNC + - DELETE_FAILED + reconciling: description: >- - Required if the policy is to be used with Traffic Director. For - Application Load Balancers it must be empty. Defines the mechanism - to obtain the Certificate Authority certificate to validate the - client certificate. + Output only. The current state of the resource does not match the + user's intended state, and the system is working to reconcile them. + This part of the normal operation (e.g. adding a new location to the + target deployment group). See https://google.aip.dev/128. + readOnly: true + type: boolean + locations: + description: >- + Output only. The list of locations where the association is + configured. This information is retrieved from the linked endpoint + group. + readOnly: true type: array items: - $ref: '#/components/schemas/ValidationCA' - clientValidationTrustConfig: - description: >- - Reference to the TrustConfig from certificatemanager.googleapis.com - namespace. If specified, the chain validation will be performed - against certificates configured in the given TrustConfig. Allowed - only if the policy is to be used with Application Load Balancers. - type: string - ValidationCA: - id: ValidationCA + $ref: '#/components/schemas/InterceptLocation' + InterceptEndpointGroupAssociationLocationDetails: + id: InterceptEndpointGroupAssociationLocationDetails description: >- - Specification of ValidationCA. Defines the mechanism to obtain the - Certificate Authority certificate to validate the peer certificate. + Contains details about the state of an association in a specific cloud + location. type: object properties: - grpcEndpoint: - description: >- - gRPC specific configuration to access the gRPC server to obtain the - CA certificate. - $ref: '#/components/schemas/GoogleCloudNetworksecurityV1GrpcEndpoint' - certificateProviderInstance: + location: description: >- - The certificate provider instance specification that will be passed - to the data plane, which will be used to load necessary credential - information. - $ref: '#/components/schemas/CertificateProviderInstance' - ListClientTlsPoliciesResponse: - id: ListClientTlsPoliciesResponse - description: Response returned by the ListClientTlsPolicies method. + Output only. The cloud location, e.g. "us-central1-a" or + "asia-south1". + readOnly: true + type: string + state: + description: Output only. The current state of the association in this location. + readOnly: true + type: string + enumDescriptions: + - Not set. + - >- + The association is ready and in sync with the linked endpoint + group. + - >- + The association is out of sync with the linked endpoint group. In + most cases, this is a result of a transient issue within the + system (e.g. an inaccessible location) and the system is expected + to recover automatically. + enum: + - STATE_UNSPECIFIED + - ACTIVE + - OUT_OF_SYNC + ListInterceptDeploymentGroupsResponse: + id: ListInterceptDeploymentGroupsResponse + description: Response message for ListInterceptDeploymentGroups. type: object properties: - clientTlsPolicies: - description: List of ClientTlsPolicy resources. + interceptDeploymentGroups: + description: The deployment groups from the specified parent. type: array items: - $ref: '#/components/schemas/ClientTlsPolicy' + $ref: '#/components/schemas/InterceptDeploymentGroup' nextPageToken: description: >- - If there might be more results than those appearing in this - response, then `next_page_token` is included. To get the next set of - results, call this method again using the value of `next_page_token` - as `page_token`. + A token that can be sent as `page_token` to retrieve the next page. + If this field is omitted, there are no subsequent pages. See + https://google.aip.dev/158 for more details. type: string - ClientTlsPolicy: - id: ClientTlsPolicy + InterceptDeploymentGroup: + id: InterceptDeploymentGroup description: >- - ClientTlsPolicy is a resource that specifies how a client should - authenticate connections to backends of a service. This resource itself - does not affect configuration unless it is attached to a backend service - resource. + A deployment group aggregates many zonal intercept backends + (deployments) into a single global intercept service. Consumers can + connect this service using an endpoint group. type: object properties: name: description: >- - Required. Name of the ClientTlsPolicy resource. It matches the - pattern - `projects/*/locations/{location}/clientTlsPolicies/{client_tls_policy}` - type: string - description: - description: Optional. Free-text description of the resource. + Immutable. Identifier. The resource name of this deployment group, + for example: + `projects/123456789/locations/global/interceptDeploymentGroups/my-dg`. + See https://google.aip.dev/122 for more details. type: string createTime: - description: Output only. The timestamp when the resource was created. + description: >- + Output only. The timestamp when the resource was created. See + https://google.aip.dev/148#timestamps. readOnly: true type: string format: google-datetime updateTime: - description: Output only. The timestamp when the resource was updated. + description: >- + Output only. The timestamp when the resource was most recently + updated. See https://google.aip.dev/148#timestamps. readOnly: true type: string format: google-datetime labels: - description: Optional. Set of label tags associated with the resource. + description: >- + Optional. Labels are key/value pairs that help to organize and + filter resources. type: object additionalProperties: type: string - sni: + network: description: >- - Optional. Server Name Indication string to present to the server - during TLS handshake. E.g: "secure.example.com". + Required. Immutable. The network that will be used for all child + deployments, for example: + `projects/{project}/global/networks/{network}`. See + https://google.aip.dev/124. type: string - clientCertificate: + connectedEndpointGroups: description: >- - Optional. Defines a mechanism to provision client identity (public - and private keys) for peer to peer authentication. The presence of - this dictates mTLS. - $ref: '#/components/schemas/GoogleCloudNetworksecurityV1CertificateProvider' - serverValidationCa: + Output only. The list of endpoint groups that are connected to this + resource. + readOnly: true + type: array + items: + $ref: >- + #/components/schemas/InterceptDeploymentGroupConnectedEndpointGroup + nestedDeployments: description: >- - Optional. Defines the mechanism to obtain the Certificate Authority - certificate to validate the server certificate. If empty, client - does not validate the server certificate. + Output only. The list of Intercept Deployments that belong to this + group. + readOnly: true + deprecated: true type: array items: - $ref: '#/components/schemas/ValidationCA' - ListGatewaySecurityPoliciesResponse: - id: ListGatewaySecurityPoliciesResponse - description: Response returned by the ListGatewaySecurityPolicies method. + $ref: '#/components/schemas/InterceptDeploymentGroupDeployment' + state: + description: >- + Output only. The current state of the deployment group. See + https://google.aip.dev/216. + readOnly: true + type: string + enumDescriptions: + - State not set (this is not a valid state). + - The deployment group is ready. + - The deployment group is being created. + - The deployment group is being deleted. + enum: + - STATE_UNSPECIFIED + - ACTIVE + - CREATING + - DELETING + reconciling: + description: >- + Output only. The current state of the resource does not match the + user's intended state, and the system is working to reconcile them. + This is part of the normal operation (e.g. adding a new deployment + to the group) See https://google.aip.dev/128. + readOnly: true + type: boolean + description: + description: >- + Optional. User-provided description of the deployment group. Used as + additional context for the deployment group. + type: string + locations: + description: >- + Output only. The list of locations where the deployment group is + present. + readOnly: true + type: array + items: + $ref: '#/components/schemas/InterceptLocation' + InterceptDeploymentGroupConnectedEndpointGroup: + id: InterceptDeploymentGroupConnectedEndpointGroup + description: An endpoint group connected to this deployment group. type: object properties: - gatewaySecurityPolicies: - description: List of GatewaySecurityPolicies resources. + name: + description: >- + Output only. The connected endpoint group's resource name, for + example: + `projects/123456789/locations/global/interceptEndpointGroups/my-eg`. + See https://google.aip.dev/124. + readOnly: true + type: string + InterceptDeploymentGroupDeployment: + id: InterceptDeploymentGroupDeployment + description: A deployment belonging to this deployment group. + type: object + properties: + name: + description: >- + Output only. The name of the Intercept Deployment, in the format: + `projects/{project}/locations/{location}/interceptDeployments/{intercept_deployment}`. + readOnly: true + type: string + state: + description: Output only. Most recent known state of the deployment. + readOnly: true + type: string + enumDescriptions: + - State not set (this is not a valid state). + - The deployment is ready and in sync with the parent group. + - The deployment is being created. + - The deployment is being deleted. + - >- + The deployment is out of sync with the parent group. In most + cases, this is a result of a transient issue within the system + (e.g. a delayed data-path config) and the system is expected to + recover automatically. See the parent deployment group's state for + more details. + - >- + An attempt to delete the deployment has failed. This is a terminal + state and the deployment is not expected to recover. The only + permitted operation is to retry deleting the deployment. + enum: + - STATE_UNSPECIFIED + - ACTIVE + - CREATING + - DELETING + - OUT_OF_SYNC + - DELETE_FAILED + ListInterceptDeploymentsResponse: + id: ListInterceptDeploymentsResponse + description: Response message for ListInterceptDeployments. + type: object + properties: + interceptDeployments: + description: The deployments from the specified parent. type: array items: - $ref: '#/components/schemas/GatewaySecurityPolicy' + $ref: '#/components/schemas/InterceptDeployment' nextPageToken: description: >- - If there might be more results than those appearing in this - response, then 'next_page_token' is included. To get the next set of - results, call this method again using the value of 'next_page_token' - as 'page_token'. + A token that can be sent as `page_token` to retrieve the next page. + If this field is omitted, there are no subsequent pages. See + https://google.aip.dev/158 for more details. type: string unreachable: description: Locations that could not be reached. type: array items: type: string - GatewaySecurityPolicy: - id: GatewaySecurityPolicy + InterceptDeployment: + id: InterceptDeployment description: >- - The GatewaySecurityPolicy resource contains a collection of - GatewaySecurityPolicyRules and associated metadata. + A deployment represents a zonal intercept backend ready to accept + GENEVE-encapsulated traffic, e.g. a zonal instance group fronted by an + internal passthrough load balancer. Deployments are always part of a + global deployment group which represents a global intercept service. type: object properties: name: description: >- - Required. Name of the resource. Name is of the form - projects/{project}/locations/{location}/gatewaySecurityPolicies/{gateway_security_policy} - gateway_security_policy should match the - pattern:(^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$). + Immutable. Identifier. The resource name of this deployment, for + example: + `projects/123456789/locations/us-central1-a/interceptDeployments/my-dep`. + See https://google.aip.dev/122 for more details. type: string createTime: - description: Output only. The timestamp when the resource was created. + description: >- + Output only. The timestamp when the resource was created. See + https://google.aip.dev/148#timestamps. readOnly: true type: string format: google-datetime updateTime: - description: Output only. The timestamp when the resource was updated. + description: >- + Output only. The timestamp when the resource was most recently + updated. See https://google.aip.dev/148#timestamps. readOnly: true type: string format: google-datetime - description: - description: Optional. Free-text description of the resource. + labels: + description: >- + Optional. Labels are key/value pairs that help to organize and + filter resources. + type: object + additionalProperties: + type: string + forwardingRule: + description: >- + Required. Immutable. The regional forwarding rule that fronts the + interceptors, for example: + `projects/123456789/regions/us-central1/forwardingRules/my-rule`. + See https://google.aip.dev/124. type: string - tlsInspectionPolicy: + interceptDeploymentGroup: description: >- - Optional. Name of a TLS Inspection Policy resource that defines how - TLS inspection will be performed for any rule(s) which enables it. + Required. Immutable. The deployment group that this deployment is a + part of, for example: + `projects/123456789/locations/global/interceptDeploymentGroups/my-dg`. + See https://google.aip.dev/124. type: string - ListGatewaySecurityPolicyRulesResponse: - id: ListGatewaySecurityPolicyRulesResponse - description: Response returned by the ListGatewaySecurityPolicyRules method. + state: + description: >- + Output only. The current state of the deployment. See + https://google.aip.dev/216. + readOnly: true + type: string + enumDescriptions: + - State not set (this is not a valid state). + - The deployment is ready and in sync with the parent group. + - The deployment is being created. + - The deployment is being deleted. + - >- + The deployment is out of sync with the parent group. In most + cases, this is a result of a transient issue within the system + (e.g. a delayed data-path config) and the system is expected to + recover automatically. See the parent deployment group's state for + more details. + - >- + An attempt to delete the deployment has failed. This is a terminal + state and the deployment is not expected to recover. The only + permitted operation is to retry deleting the deployment. + enum: + - STATE_UNSPECIFIED + - ACTIVE + - CREATING + - DELETING + - OUT_OF_SYNC + - DELETE_FAILED + reconciling: + description: >- + Output only. The current state of the resource does not match the + user's intended state, and the system is working to reconcile them. + This part of the normal operation (e.g. linking a new association to + the parent group). See https://google.aip.dev/128. + readOnly: true + type: boolean + description: + description: >- + Optional. User-provided description of the deployment. Used as + additional context for the deployment. + type: string + ListMirroringEndpointGroupsResponse: + id: ListMirroringEndpointGroupsResponse + description: Response message for ListMirroringEndpointGroups. type: object properties: - gatewaySecurityPolicyRules: - description: List of GatewaySecurityPolicyRule resources. + mirroringEndpointGroups: + description: The endpoint groups from the specified parent. type: array items: - $ref: '#/components/schemas/GatewaySecurityPolicyRule' + $ref: '#/components/schemas/MirroringEndpointGroup' nextPageToken: description: >- - If there might be more results than those appearing in this - response, then 'next_page_token' is included. To get the next set of - results, call this method again using the value of 'next_page_token' - as 'page_token'. + A token that can be sent as `page_token` to retrieve the next page. + If this field is omitted, there are no subsequent pages. See + https://google.aip.dev/158 for more details. type: string - unreachable: - description: Locations that could not be reached. - type: array - items: - type: string - GatewaySecurityPolicyRule: - id: GatewaySecurityPolicyRule + MirroringEndpointGroup: + id: MirroringEndpointGroup description: >- - The GatewaySecurityPolicyRule resource is in a nested collection within - a GatewaySecurityPolicy and represents a traffic matching condition and - associated action to perform. + An endpoint group is a consumer frontend for a deployment group + (backend). In order to configure mirroring for a network, consumers must + create: - An association between their network and the endpoint group. - + A security profile that points to the endpoint group. - A mirroring rule + that references the security profile (group). type: object properties: - basicProfile: - description: Required. Profile which tells what the primitive action should be. - type: string - enumDescriptions: - - If there is not a mentioned action for the target. - - Allow the matched traffic. - - Deny the matched traffic. - enum: - - BASIC_PROFILE_UNSPECIFIED - - ALLOW - - DENY name: description: >- - Required. Immutable. Name of the resource. ame is the full resource - name so - projects/{project}/locations/{location}/gatewaySecurityPolicies/{gateway_security_policy}/rules/{rule} - rule should match the pattern: (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$). + Immutable. Identifier. The resource name of this endpoint group, for + example: + `projects/123456789/locations/global/mirroringEndpointGroups/my-eg`. + See https://google.aip.dev/122 for more details. type: string createTime: - description: Output only. Time when the rule was created. + description: >- + Output only. The timestamp when the resource was created. See + https://google.aip.dev/148#timestamps. readOnly: true type: string format: google-datetime updateTime: - description: Output only. Time when the rule was updated. + description: >- + Output only. The timestamp when the resource was most recently + updated. See https://google.aip.dev/148#timestamps. readOnly: true type: string format: google-datetime - enabled: - description: Required. Whether the rule is enforced. - type: boolean - priority: + labels: description: >- - Required. Priority of the rule. Lower number corresponds to higher - precedence. - type: integer - format: int32 - description: - description: Optional. Free-text description of the resource. - type: string - sessionMatcher: - description: Required. CEL expression for matching on session criteria. + Optional. Labels are key/value pairs that help to organize and + filter resources. + type: object + additionalProperties: + type: string + mirroringDeploymentGroup: + description: >- + Immutable. The deployment group that this DIRECT endpoint group is + connected to, for example: + `projects/123456789/locations/global/mirroringDeploymentGroups/my-dg`. + See https://google.aip.dev/124. type: string - applicationMatcher: + connectedDeploymentGroups: description: >- - Optional. CEL expression for matching on L7/application level - criteria. + Output only. List of details about the connected deployment groups + to this endpoint group. + readOnly: true + type: array + items: + $ref: >- + #/components/schemas/MirroringEndpointGroupConnectedDeploymentGroup + state: + description: >- + Output only. The current state of the endpoint group. See + https://google.aip.dev/216. + readOnly: true type: string - tlsInspectionEnabled: + enumDescriptions: + - State not set (this is not a valid state). + - >- + The endpoint group is ready and in sync with the target deployment + group. + - >- + The deployment group backing this endpoint group has been + force-deleted. This endpoint group cannot be used and mirroring is + effectively disabled. + - The endpoint group is being created. + - The endpoint group is being deleted. + - >- + The endpoint group is out of sync with the backing deployment + group. In most cases, this is a result of a transient issue within + the system (e.g. an inaccessible location) and the system is + expected to recover automatically. See the associations field for + details per network and location. + - >- + An attempt to delete the endpoint group has failed. This is a + terminal state and the endpoint group is not expected to recover. + The only permitted operation is to retry deleting the endpoint + group. + enum: + - STATE_UNSPECIFIED + - ACTIVE + - CLOSED + - CREATING + - DELETING + - OUT_OF_SYNC + - DELETE_FAILED + reconciling: description: >- - Optional. Flag to enable TLS inspection of traffic matching on , can - only be true if the parent GatewaySecurityPolicy references a - TLSInspectionConfig. + Output only. The current state of the resource does not match the + user's intended state, and the system is working to reconcile them. + This is part of the normal operation (e.g. adding a new association + to the group). See https://google.aip.dev/128. + readOnly: true type: boolean - ListUrlListsResponse: - id: ListUrlListsResponse - description: Response returned by the ListUrlLists method. - type: object - properties: - urlLists: - description: List of UrlList resources. + associations: + description: Output only. List of associations to this endpoint group. + readOnly: true type: array items: - $ref: '#/components/schemas/UrlList' - nextPageToken: + $ref: '#/components/schemas/MirroringEndpointGroupAssociationDetails' + description: description: >- - If there might be more results than those appearing in this - response, then `next_page_token` is included. To get the next set of - results, call this method again using the value of `next_page_token` - as `page_token`. + Optional. User-provided description of the endpoint group. Used as + additional context for the endpoint group. type: string - unreachable: - description: Locations that could not be reached. + MirroringEndpointGroupConnectedDeploymentGroup: + id: MirroringEndpointGroupConnectedDeploymentGroup + description: The endpoint group's view of a connected deployment group. + type: object + properties: + name: + description: >- + Output only. The connected deployment group's resource name, for + example: + `projects/123456789/locations/global/mirroringDeploymentGroups/my-dg`. + See https://google.aip.dev/124. + readOnly: true + type: string + locations: + description: >- + Output only. The list of locations where the deployment group is + present. + readOnly: true type: array items: - type: string - UrlList: - id: UrlList - description: >- - UrlList proto helps users to set reusable, independently manageable - lists of hosts, host patterns, URLs, URL patterns. + $ref: '#/components/schemas/MirroringLocation' + MirroringLocation: + id: MirroringLocation + description: Details about mirroring in a specific cloud location. type: object properties: - name: + location: description: >- - Required. Name of the resource provided by the user. Name is of the - form projects/{project}/locations/{location}/urlLists/{url_list} - url_list should match the - pattern:(^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$). + Output only. The cloud location, e.g. "us-central1-a" or + "asia-south1". + readOnly: true type: string - createTime: - description: Output only. Time when the security policy was created. + state: + description: Output only. The current state of the association in this location. readOnly: true type: string - format: google-datetime - updateTime: - description: Output only. Time when the security policy was updated. + enumDescriptions: + - State not set (this is not a valid state). + - The resource is ready and in sync in the location. + - >- + The resource is out of sync in the location. In most cases, this + is a result of a transient issue within the system (e.g. an + inaccessible location) and the system is expected to recover + automatically. + enum: + - STATE_UNSPECIFIED + - ACTIVE + - OUT_OF_SYNC + MirroringEndpointGroupAssociationDetails: + id: MirroringEndpointGroupAssociationDetails + description: The endpoint group's view of a connected association. + type: object + properties: + name: + description: >- + Output only. The connected association's resource name, for example: + `projects/123456789/locations/global/mirroringEndpointGroupAssociations/my-ega`. + See https://google.aip.dev/124. readOnly: true type: string - format: google-datetime - description: - description: Optional. Free-text description of the resource. + network: + description: >- + Output only. The associated network, for example: + projects/123456789/global/networks/my-network. See + https://google.aip.dev/124. + readOnly: true type: string - values: - description: Required. FQDNs and URLs. - type: array - items: - type: string - ListTlsInspectionPoliciesResponse: - id: ListTlsInspectionPoliciesResponse - description: Response returned by the ListTlsInspectionPolicies method. + state: + description: Output only. Most recent known state of the association. + readOnly: true + type: string + enumDescriptions: + - Not set. + - >- + The association is ready and in sync with the linked endpoint + group. + - The association is being created. + - The association is being deleted. + - >- + The association is disabled due to a breaking change in another + resource. + - >- + The association is out of sync with the linked endpoint group. In + most cases, this is a result of a transient issue within the + system (e.g. an inaccessible location) and the system is expected + to recover automatically. Check the `locations_details` field for + more details. + - >- + An attempt to delete the association has failed. This is a + terminal state and the association is not expected to be usable as + some of its resources have been deleted. The only permitted + operation is to retry deleting the association. + enum: + - STATE_UNSPECIFIED + - ACTIVE + - CREATING + - DELETING + - CLOSED + - OUT_OF_SYNC + - DELETE_FAILED + ListMirroringEndpointGroupAssociationsResponse: + id: ListMirroringEndpointGroupAssociationsResponse + description: Response message for ListMirroringEndpointGroupAssociations. type: object properties: - tlsInspectionPolicies: - description: List of TlsInspectionPolicies resources. + mirroringEndpointGroupAssociations: + description: The associations from the specified parent. type: array items: - $ref: '#/components/schemas/TlsInspectionPolicy' + $ref: '#/components/schemas/MirroringEndpointGroupAssociation' nextPageToken: description: >- - If there might be more results than those appearing in this - response, then 'next_page_token' is included. To get the next set of - results, call this method again using the value of 'next_page_token' - as 'page_token'. + A token that can be sent as `page_token` to retrieve the next page. + If this field is omitted, there are no subsequent pages. See + https://google.aip.dev/158 for more details. type: string - unreachable: - description: Locations that could not be reached. - type: array - items: - type: string - TlsInspectionPolicy: - id: TlsInspectionPolicy + MirroringEndpointGroupAssociation: + id: MirroringEndpointGroupAssociation description: >- - The TlsInspectionPolicy resource contains references to CA pools in - Certificate Authority Service and associated metadata. + An endpoint group association represents a link between a network and an + endpoint group in the organization. Creating an association creates the + networking infrastructure linking the network to the endpoint group, but + does not enable mirroring by itself. To enable mirroring, the user must + also create a network firewall policy containing mirroring rules and + associate it with the network. type: object properties: name: description: >- - Required. Name of the resource. Name is of the form - projects/{project}/locations/{location}/tlsInspectionPolicies/{tls_inspection_policy} - tls_inspection_policy should match the - pattern:(^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$). - type: string - description: - description: Optional. Free-text description of the resource. + Immutable. Identifier. The resource name of this endpoint group + association, for example: + `projects/123456789/locations/global/mirroringEndpointGroupAssociations/my-eg-association`. + See https://google.aip.dev/122 for more details. type: string createTime: - description: Output only. The timestamp when the resource was created. + description: >- + Output only. The timestamp when the resource was created. See + https://google.aip.dev/148#timestamps. readOnly: true type: string format: google-datetime updateTime: - description: Output only. The timestamp when the resource was updated. + description: >- + Output only. The timestamp when the resource was most recently + updated. See https://google.aip.dev/148#timestamps. readOnly: true type: string format: google-datetime - caPool: + labels: description: >- - Required. A CA pool resource used to issue interception - certificates. The CA pool string has a relative resource path - following the form - "projects/{project}/locations/{location}/caPools/{ca_pool}". + Optional. Labels are key/value pairs that help to organize and + filter resources. + type: object + additionalProperties: + type: string + mirroringEndpointGroup: + description: >- + Immutable. The endpoint group that this association is connected to, + for example: + `projects/123456789/locations/global/mirroringEndpointGroups/my-eg`. + See https://google.aip.dev/124. type: string - trustConfig: + network: description: >- - Optional. A TrustConfig resource used when making a connection to - the TLS server. This is a relative resource path following the form - "projects/{project}/locations/{location}/trustConfigs/{trust_config}". - This is necessary to intercept TLS connections to servers with - certificates signed by a private CA or self-signed certificates. - Note that Secure Web Proxy does not yet honor this field. + Immutable. The VPC network that is associated. for example: + `projects/123456789/global/networks/my-network`. See + https://google.aip.dev/124. type: string - excludePublicCaSet: + locationsDetails: description: >- - Optional. If FALSE (the default), use our default set of public CAs - in addition to any CAs specified in trust_config. These public CAs - are currently based on the Mozilla Root Program and are subject to - change over time. If TRUE, do not accept our default set of public - CAs. Only CAs specified in trust_config will be accepted. This - defaults to FALSE (use public CAs in addition to trust_config) for - backwards compatibility, but trusting public root CAs is *not - recommended* unless the traffic in question is outbound to public - web servers. When possible, prefer setting this to "false" and - explicitly specifying trusted CAs and certificates in a TrustConfig. - Note that Secure Web Proxy does not yet honor this field. - type: boolean - minTlsVersion: - description: >- - Optional. Minimum TLS version that the firewall should use when - negotiating connections with both clients and servers. If this is - not set, then the default value is to allow the broadest set of - clients and servers (TLS 1.0 or higher). Setting this to more - restrictive values may improve security, but may also prevent the - firewall from connecting to some clients or servers. Note that - Secure Web Proxy does not yet honor this field. - type: string - enumDescriptions: - - Indicates no TLS version was specified. - - TLS 1.0 - - TLS 1.1 - - TLS 1.2 - - TLS 1.3 - enum: - - TLS_VERSION_UNSPECIFIED - - TLS_1_0 - - TLS_1_1 - - TLS_1_2 - - TLS_1_3 - tlsFeatureProfile: - description: >- - Optional. The selected Profile. If this is not set, then the default - value is to allow the broadest set of clients and servers - ("PROFILE_COMPATIBLE"). Setting this to more restrictive values may - improve security, but may also prevent the TLS inspection proxy from - connecting to some clients or servers. Note that Secure Web Proxy - does not yet honor this field. + Output only. The list of locations where the association is present. + This information is retrieved from the linked endpoint group, and + not configured as part of the association itself. + readOnly: true + deprecated: true + type: array + items: + $ref: >- + #/components/schemas/MirroringEndpointGroupAssociationLocationDetails + state: + description: Output only. Current state of the endpoint group association. + readOnly: true type: string enumDescriptions: - - Indicates no profile was specified. + - Not set. - >- - Compatible profile. Allows the broadest set of clients, even those - which support only out-of-date SSL features to negotiate with the - TLS inspection proxy. + The association is ready and in sync with the linked endpoint + group. + - The association is being created. + - The association is being deleted. - >- - Modern profile. Supports a wide set of SSL features, allowing - modern clients to negotiate SSL with the TLS inspection proxy. + The association is disabled due to a breaking change in another + resource. - >- - Restricted profile. Supports a reduced set of SSL features, - intended to meet stricter compliance requirements. + The association is out of sync with the linked endpoint group. In + most cases, this is a result of a transient issue within the + system (e.g. an inaccessible location) and the system is expected + to recover automatically. Check the `locations_details` field for + more details. - >- - Custom profile. Allow only the set of allowed SSL features - specified in the custom_features field of SslPolicy. + An attempt to delete the association has failed. This is a + terminal state and the association is not expected to be usable as + some of its resources have been deleted. The only permitted + operation is to retry deleting the association. enum: - - PROFILE_UNSPECIFIED - - PROFILE_COMPATIBLE - - PROFILE_MODERN - - PROFILE_RESTRICTED - - PROFILE_CUSTOM - customTlsFeatures: + - STATE_UNSPECIFIED + - ACTIVE + - CREATING + - DELETING + - CLOSED + - OUT_OF_SYNC + - DELETE_FAILED + reconciling: description: >- - Optional. List of custom TLS cipher suites selected. This field is - valid only if the selected tls_feature_profile is CUSTOM. The - compute.SslPoliciesService.ListAvailableFeatures method returns the - set of features that can be specified in this list. Note that Secure - Web Proxy does not yet honor this field. + Output only. The current state of the resource does not match the + user's intended state, and the system is working to reconcile them. + This part of the normal operation (e.g. adding a new location to the + target deployment group). See https://google.aip.dev/128. + readOnly: true + type: boolean + locations: + description: >- + Output only. The list of locations where the association is + configured. This information is retrieved from the linked endpoint + group. + readOnly: true type: array items: - type: string - ListSecurityProfileGroupsResponse: - id: ListSecurityProfileGroupsResponse - description: Response returned by the ListSecurityProfileGroups method. + $ref: '#/components/schemas/MirroringLocation' + MirroringEndpointGroupAssociationLocationDetails: + id: MirroringEndpointGroupAssociationLocationDetails + description: >- + Contains details about the state of an association in a specific cloud + location. type: object properties: - securityProfileGroups: - description: List of SecurityProfileGroups resources. + location: + description: >- + Output only. The cloud location, e.g. "us-central1-a" or + "asia-south1". + readOnly: true + type: string + state: + description: Output only. The current state of the association in this location. + readOnly: true + type: string + enumDescriptions: + - Not set. + - >- + The association is ready and in sync with the linked endpoint + group. + - >- + The association is out of sync with the linked endpoint group. In + most cases, this is a result of a transient issue within the + system (e.g. an inaccessible location) and the system is expected + to recover automatically. + enum: + - STATE_UNSPECIFIED + - ACTIVE + - OUT_OF_SYNC + ListMirroringDeploymentGroupsResponse: + id: ListMirroringDeploymentGroupsResponse + description: Response message for ListMirroringDeploymentGroups. + type: object + properties: + mirroringDeploymentGroups: + description: The deployment groups from the specified parent. type: array items: - $ref: '#/components/schemas/SecurityProfileGroup' + $ref: '#/components/schemas/MirroringDeploymentGroup' nextPageToken: description: >- - If there might be more results than those appearing in this - response, then `next_page_token` is included. To get the next set of - results, call this method again using the value of `next_page_token` - as `page_token`. + A token that can be sent as `page_token` to retrieve the next page. + If this field is omitted, there are no subsequent pages. See + https://google.aip.dev/158 for more details. type: string - SecurityProfileGroup: - id: SecurityProfileGroup + MirroringDeploymentGroup: + id: MirroringDeploymentGroup description: >- - SecurityProfileGroup is a resource that defines the behavior for various - ProfileTypes. Next ID: 11 + A deployment group aggregates many zonal mirroring backends + (deployments) into a single global mirroring service. Consumers can + connect this service using an endpoint group. type: object properties: name: description: >- - Immutable. Identifier. Name of the SecurityProfileGroup resource. It - matches pattern - `projects|organizations/*/locations/{location}/securityProfileGroups/{security_profile_group}`. - type: string - description: - description: >- - Optional. An optional description of the profile group. Max length - 2048 characters. + Immutable. Identifier. The resource name of this deployment group, + for example: + `projects/123456789/locations/global/mirroringDeploymentGroups/my-dg`. + See https://google.aip.dev/122 for more details. type: string createTime: - description: Output only. Resource creation timestamp. + description: >- + Output only. The timestamp when the resource was created. See + https://google.aip.dev/148#timestamps. readOnly: true type: string format: google-datetime updateTime: - description: Output only. Last resource update timestamp. - readOnly: true - type: string - format: google-datetime - etag: description: >- - Output only. This checksum is computed by the server based on the - value of other fields, and may be sent on update and delete requests - to ensure the client has an up-to-date value before proceeding. + Output only. The timestamp when the resource was most recently + updated. See https://google.aip.dev/148#timestamps. readOnly: true type: string + format: google-datetime labels: - description: Optional. Labels as key value pairs. + description: >- + Optional. Labels are key/value pairs that help to organize and + filter resources. type: object additionalProperties: type: string - threatPreventionProfile: + network: description: >- - Optional. Reference to a SecurityProfile with the ThreatPrevention - configuration. + Required. Immutable. The network that will be used for all child + deployments, for example: + `projects/{project}/global/networks/{network}`. See + https://google.aip.dev/124. type: string - customMirroringProfile: + connectedEndpointGroups: description: >- - Optional. Reference to a SecurityProfile with the CustomMirroring - configuration. + Output only. The list of endpoint groups that are connected to this + resource. + readOnly: true + type: array + items: + $ref: >- + #/components/schemas/MirroringDeploymentGroupConnectedEndpointGroup + nestedDeployments: + description: >- + Output only. The list of Mirroring Deployments that belong to this + group. + readOnly: true + deprecated: true + type: array + items: + $ref: '#/components/schemas/MirroringDeploymentGroupDeployment' + state: + description: >- + Output only. The current state of the deployment group. See + https://google.aip.dev/216. + readOnly: true type: string - ListSecurityProfilesResponse: - id: ListSecurityProfilesResponse - description: Response returned by the ListSecurityProfiles method. + enumDescriptions: + - State not set (this is not a valid state). + - The deployment group is ready. + - The deployment group is being created. + - The deployment group is being deleted. + enum: + - STATE_UNSPECIFIED + - ACTIVE + - CREATING + - DELETING + reconciling: + description: >- + Output only. The current state of the resource does not match the + user's intended state, and the system is working to reconcile them. + This is part of the normal operation (e.g. adding a new deployment + to the group) See https://google.aip.dev/128. + readOnly: true + type: boolean + description: + description: >- + Optional. User-provided description of the deployment group. Used as + additional context for the deployment group. + type: string + locations: + description: >- + Output only. The list of locations where the deployment group is + present. + readOnly: true + type: array + items: + $ref: '#/components/schemas/MirroringLocation' + MirroringDeploymentGroupConnectedEndpointGroup: + id: MirroringDeploymentGroupConnectedEndpointGroup + description: An endpoint group connected to this deployment group. type: object properties: - securityProfiles: - description: List of SecurityProfile resources. + name: + description: >- + Output only. The connected endpoint group's resource name, for + example: + `projects/123456789/locations/global/mirroringEndpointGroups/my-eg`. + See https://google.aip.dev/124. + readOnly: true + type: string + MirroringDeploymentGroupDeployment: + id: MirroringDeploymentGroupDeployment + description: A deployment belonging to this deployment group. + type: object + properties: + name: + description: >- + Output only. The name of the Mirroring Deployment, in the format: + `projects/{project}/locations/{location}/mirroringDeployments/{mirroring_deployment}`. + readOnly: true + type: string + state: + description: Output only. Most recent known state of the deployment. + readOnly: true + type: string + enumDescriptions: + - State not set (this is not a valid state). + - The deployment is ready and in sync with the parent group. + - The deployment is being created. + - The deployment is being deleted. + - >- + The deployment is out of sync with the parent group. In most + cases, this is a result of a transient issue within the system + (e.g. a delayed data-path config) and the system is expected to + recover automatically. See the parent deployment group's state for + more details. + - >- + An attempt to delete the deployment has failed. This is a terminal + state and the deployment is not expected to recover. The only + permitted operation is to retry deleting the deployment. + enum: + - STATE_UNSPECIFIED + - ACTIVE + - CREATING + - DELETING + - OUT_OF_SYNC + - DELETE_FAILED + ListMirroringDeploymentsResponse: + id: ListMirroringDeploymentsResponse + description: Response message for ListMirroringDeployments. + type: object + properties: + mirroringDeployments: + description: The deployments from the specified parent. type: array items: - $ref: '#/components/schemas/SecurityProfile' + $ref: '#/components/schemas/MirroringDeployment' nextPageToken: description: >- - If there might be more results than those appearing in this - response, then `next_page_token` is included. To get the next set of - results, call this method again using the value of `next_page_token` - as `page_token`. + A token that can be sent as `page_token` to retrieve the next page. + If this field is omitted, there are no subsequent pages. See + https://google.aip.dev/158 for more details. type: string - SecurityProfile: - id: SecurityProfile + unreachable: + description: Locations that could not be reached. + type: array + items: + type: string + MirroringDeployment: + id: MirroringDeployment description: >- - SecurityProfile is a resource that defines the behavior for one of many - ProfileTypes. Next ID: 12 + A deployment represents a zonal mirroring backend ready to accept + GENEVE-encapsulated replica traffic, e.g. a zonal instance group fronted + by an internal passthrough load balancer. Deployments are always part of + a global deployment group which represents a global mirroring service. type: object properties: - threatPreventionProfile: - description: The threat prevention configuration for the SecurityProfile. - $ref: '#/components/schemas/ThreatPreventionProfile' - customMirroringProfile: - description: >- - The custom Packet Mirroring v2 configuration for the - SecurityProfile. - $ref: '#/components/schemas/CustomMirroringProfile' name: description: >- - Immutable. Identifier. Name of the SecurityProfile resource. It - matches pattern - `projects|organizations/*/locations/{location}/securityProfiles/{security_profile}`. - type: string - description: - description: >- - Optional. An optional description of the profile. Max length 512 - characters. + Immutable. Identifier. The resource name of this deployment, for + example: + `projects/123456789/locations/us-central1-a/mirroringDeployments/my-dep`. + See https://google.aip.dev/122 for more details. type: string createTime: - description: Output only. Resource creation timestamp. + description: >- + Output only. The timestamp when the resource was created. See + https://google.aip.dev/148#timestamps. readOnly: true type: string format: google-datetime updateTime: - description: Output only. Last resource update timestamp. - readOnly: true - type: string - format: google-datetime - etag: description: >- - Output only. This checksum is computed by the server based on the - value of other fields, and may be sent on update and delete requests - to ensure the client has an up-to-date value before proceeding. + Output only. The timestamp when the resource was most recently + updated. See https://google.aip.dev/148#timestamps. readOnly: true type: string + format: google-datetime labels: - description: Optional. Labels as key value pairs. + description: >- + Optional. Labels are key/value pairs that help to organize and + filter resources. type: object additionalProperties: type: string - type: + forwardingRule: description: >- - Immutable. The single ProfileType that the SecurityProfile resource - configures. + Required. Immutable. The regional forwarding rule that fronts the + mirroring collectors, for example: + `projects/123456789/regions/us-central1/forwardingRules/my-rule`. + See https://google.aip.dev/124. + type: string + mirroringDeploymentGroup: + description: >- + Required. Immutable. The deployment group that this deployment is a + part of, for example: + `projects/123456789/locations/global/mirroringDeploymentGroups/my-dg`. + See https://google.aip.dev/124. + type: string + state: + description: >- + Output only. The current state of the deployment. See + https://google.aip.dev/216. + readOnly: true type: string enumDescriptions: - - Profile type not specified. - - Profile type for threat prevention. - - Profile type for packet mirroring v2 + - State not set (this is not a valid state). + - The deployment is ready and in sync with the parent group. + - The deployment is being created. + - The deployment is being deleted. + - >- + The deployment is out of sync with the parent group. In most + cases, this is a result of a transient issue within the system + (e.g. a delayed data-path config) and the system is expected to + recover automatically. See the parent deployment group's state for + more details. + - >- + An attempt to delete the deployment has failed. This is a terminal + state and the deployment is not expected to recover. The only + permitted operation is to retry deleting the deployment. enum: - - PROFILE_TYPE_UNSPECIFIED - - THREAT_PREVENTION - - CUSTOM_MIRRORING - ThreatPreventionProfile: - id: ThreatPreventionProfile - description: >- - ThreatPreventionProfile defines an action for specific threat signatures - or severity levels. - type: object - properties: - severityOverrides: + - STATE_UNSPECIFIED + - ACTIVE + - CREATING + - DELETING + - OUT_OF_SYNC + - DELETE_FAILED + reconciling: description: >- - Optional. Configuration for overriding threats actions by severity - match. - type: array - items: - $ref: '#/components/schemas/SeverityOverride' - threatOverrides: + Output only. The current state of the resource does not match the + user's intended state, and the system is working to reconcile them. + This part of the normal operation (e.g. linking a new association to + the parent group). See https://google.aip.dev/128. + readOnly: true + type: boolean + description: description: >- - Optional. Configuration for overriding threats actions by threat_id - match. If a threat is matched both by configuration provided in - severity_overrides and threat_overrides, the threat_overrides action - is applied. + Optional. User-provided description of the deployment. Used as + additional context for the deployment. + type: string + ListAuthorizationPoliciesResponse: + id: ListAuthorizationPoliciesResponse + description: Response returned by the ListAuthorizationPolicies method. + type: object + properties: + authorizationPolicies: + description: List of AuthorizationPolicies resources. type: array items: - $ref: '#/components/schemas/ThreatOverride' - SeverityOverride: - id: SeverityOverride - description: Defines what action to take for a specific severity match. + $ref: '#/components/schemas/AuthorizationPolicy' + nextPageToken: + description: >- + If there might be more results than those appearing in this + response, then `next_page_token` is included. To get the next set of + results, call this method again using the value of `next_page_token` + as `page_token`. + type: string + AuthorizationPolicy: + id: AuthorizationPolicy + description: >- + AuthorizationPolicy is a resource that specifies how a server should + authorize incoming connections. This resource in itself does not change + the configuration unless it's attached to a target https proxy or + endpoint config selector resource. type: object properties: - severity: - description: Required. Severity level to match. + name: + description: >- + Required. Name of the AuthorizationPolicy resource. It matches + pattern + `projects/{project}/locations/{location}/authorizationPolicies/`. type: string - enumDescriptions: - - Severity level not specified. - - >- - Suspicious events that do not pose an immediate threat, but that - are reported to call attention to deeper problems that could - possibly exist. - - >- - Warning-level threats that have very little impact on an - organization's infrastructure. They usually require local or - physical system access and may often result in victim privacy - issues and information leakage. - - >- - Minor threats in which impact is minimized, that do not compromise - the target or exploits that require an attacker to reside on the - same local network as the victim, affect only non-standard - configurations or obscure applications, or provide very limited - access. - - >- - Threats that have the ability to become critical but have - mitigating factors; for example, they may be difficult to exploit, - do not result in elevated privileges, or do not have a large - victim pool. - - >- - Serious threats, such as those that affect default installations - of widely deployed software, result in root compromise of servers, - and the exploit code is widely available to attackers. The - attacker usually does not need any special authentication - credentials or knowledge about the individual victims and the - target does not need to be manipulated into performing any special - functions. - enum: - - SEVERITY_UNSPECIFIED - - INFORMATIONAL - - LOW - - MEDIUM - - HIGH - - CRITICAL - action: - description: Required. Threat action override. + description: + description: Optional. Free-text description of the resource. type: string - enumDescriptions: - - Threat action not specified. - - The default action (as specified by the vendor) is taken. - - The packet matching this rule will be allowed to transmit. - - >- - The packet matching this rule will be allowed to transmit, but a - threat_log entry will be sent to the consumer project. - - >- - The packet matching this rule will be dropped, and a threat_log - entry will be sent to the consumer project. - enum: - - THREAT_ACTION_UNSPECIFIED - - DEFAULT_ACTION - - ALLOW - - ALERT - - DENY - ThreatOverride: - id: ThreatOverride - description: Defines what action to take for a specific threat_id match. - type: object - properties: - threatId: - description: Required. Vendor-specific ID of a threat to override. + createTime: + description: Output only. The timestamp when the resource was created. + readOnly: true type: string - type: - description: Output only. Type of the threat (read only). + format: google-datetime + updateTime: + description: Output only. The timestamp when the resource was updated. readOnly: true type: string - enumDescriptions: - - Type of threat not specified. - - >- - Type of threat is not derivable from threat ID. An override will - be created for all types. Firewall will ignore overridden - signature ID's that don't exist in the specific type. - - >- - Threats related to system flaws that an attacker might otherwise - attempt to exploit. - - >- - Threats related to viruses and malware found in executables and - file types. - - >- - Threats related to command-and-control (C2) activity, where - spyware on an infected client is collecting data without the - user's consent and/or communicating with a remote attacker. - - Threats related to DNS. - enum: - - THREAT_TYPE_UNSPECIFIED - - UNKNOWN - - VULNERABILITY - - ANTIVIRUS - - SPYWARE - - DNS + format: google-datetime + labels: + description: >- + Optional. Set of label tags associated with the AuthorizationPolicy + resource. + type: object + additionalProperties: + type: string action: description: >- - Required. Threat action override. For some threat types, only a - subset of actions applies. + Required. The action to take when a rule match is found. Possible + values are "ALLOW" or "DENY". type: string enumDescriptions: - - Threat action not specified. - - The default action (as specified by the vendor) is taken. - - The packet matching this rule will be allowed to transmit. - - >- - The packet matching this rule will be allowed to transmit, but a - threat_log entry will be sent to the consumer project. + - Default value. + - Grant access. - >- - The packet matching this rule will be dropped, and a threat_log - entry will be sent to the consumer project. + Deny access. Deny rules should be avoided unless they are used to + provide a default "deny all" fallback. enum: - - THREAT_ACTION_UNSPECIFIED - - DEFAULT_ACTION + - ACTION_UNSPECIFIED - ALLOW - - ALERT - DENY - CustomMirroringProfile: - id: CustomMirroringProfile - description: >- - CustomMirroringProfile defines an action for mirroring traffic to a - collector's EndpointGroup + rules: + description: >- + Optional. List of rules to match. Note that at least one of the + rules must match in order for the action specified in the 'action' + field to be taken. A rule is a match if there is a matching source + and destination. If left blank, the action specified in the `action` + field will be applied on every request. + type: array + items: + $ref: '#/components/schemas/Rule' + Rule: + id: Rule + description: Specification of rules. type: object properties: - mirroringEndpointGroup: + sources: description: >- - Required. The MirroringEndpointGroup to which traffic associated - with the SP should be mirrored. - type: string - ListLocationsResponse: - id: ListLocationsResponse - description: The response message for Locations.ListLocations. + Optional. List of attributes for the traffic source. All of the + sources must match. A source is a match if both principals and + ip_blocks match. If not set, the action specified in the 'action' + field will be applied without any rule checks for the source. + type: array + items: + $ref: '#/components/schemas/Source' + destinations: + description: >- + Optional. List of attributes for the traffic destination. All of the + destinations must match. A destination is a match if a request + matches all the specified hosts, ports, methods and headers. If not + set, the action specified in the 'action' field will be applied + without any rule checks for the destination. + type: array + items: + $ref: '#/components/schemas/Destination' + Source: + id: Source + description: Specification of traffic source attributes. type: object properties: - locations: + principals: description: >- - A list of locations that matches the specified filter in the - request. + Optional. List of peer identities to match for authorization. At + least one principal should match. Each peer can be an exact match, + or a prefix match (example, "namespace/*") or a suffix match + (example, "*/service-account") or a presence match "*". + Authorization based on the principal name without certificate + validation (configured by ServerTlsPolicy resource) is considered + insecure. type: array items: - $ref: '#/components/schemas/Location' - nextPageToken: - description: The standard List next-page token. - type: string - Location: - id: Location - description: A resource that represents a Google Cloud location. + type: string + ipBlocks: + description: >- + Optional. List of CIDR ranges to match based on source IP address. + At least one IP block should match. Single IP (e.g., "1.2.3.4") and + CIDR (e.g., "1.2.3.0/24") are supported. Authorization based on + source IP alone should be avoided. The IP addresses of any load + balancers or proxies should be considered untrusted. + type: array + items: + type: string + Destination: + id: Destination + description: Specification of traffic destination attributes. type: object properties: - name: + hosts: description: >- - Resource name for the location, which may vary between - implementations. For example: - `"projects/example-project/locations/us-east1"` - type: string - locationId: - description: 'The canonical id for this location. For example: `"us-east1"`.' - type: string - displayName: + Required. List of host names to match. Matched against the + ":authority" header in http requests. At least one host should + match. Each host can be an exact match, or a prefix match (example + "mydomain.*") or a suffix match (example "*.myorg.com") or a + presence (any) match "*". + type: array + items: + type: string + ports: description: >- - The friendly name for this location, typically a nearby city name. - For example, "Tokyo". - type: string - labels: + Required. List of destination ports to match. At least one port + should match. + type: array + items: + type: integer + format: uint32 + methods: description: >- - Cross-service attributes for the location. For example - {"cloud.googleapis.com/region": "us-east1"} - type: object - additionalProperties: + Optional. A list of HTTP methods to match. At least one method + should match. Should not be set for gRPC services. + type: array + items: type: string - metadata: + httpHeaderMatch: description: >- - Service-specific metadata. For example the available capacity at the - given location. - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - GoogleIamV1SetIamPolicyRequest: - id: GoogleIamV1SetIamPolicyRequest - description: Request message for `SetIamPolicy` method. + Optional. Match against key:value pair in http header. Provides a + flexible match based on HTTP headers, for potentially advanced use + cases. At least one header should match. Avoid using header matches + to make authorization decisions unless there is a strong guarantee + that requests arrive through a trusted client or proxy. + $ref: '#/components/schemas/HttpHeaderMatch' + HttpHeaderMatch: + id: HttpHeaderMatch + description: Specification of HTTP header match attributes. type: object properties: - policy: + regexMatch: description: >- - REQUIRED: The complete policy to be applied to the `resource`. The - size of the policy is limited to a few 10s of KB. An empty policy is - a valid policy but certain Google Cloud services (such as Projects) - might reject them. - $ref: '#/components/schemas/GoogleIamV1Policy' - updateMask: + Required. The value of the header must match the regular expression + specified in regexMatch. For regular expression grammar, please see: + en.cppreference.com/w/cpp/regex/ecmascript For matching against a + port specified in the HTTP request, use a headerMatch with + headerName set to Host and a regular expression that satisfies the + RFC2616 Host header's port specifier. + type: string + headerName: description: >- - OPTIONAL: A FieldMask specifying which fields of the policy to - modify. Only the fields in the mask will be modified. If no mask is - provided, the following default mask is used: `paths: "bindings, - etag"` + Required. 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". type: string - format: google-fieldmask - GoogleIamV1Policy: - id: GoogleIamV1Policy - description: >- - An Identity and Access Management (IAM) policy, which specifies access - controls for Google Cloud resources. A `Policy` is a collection of - `bindings`. A `binding` binds one or more `members`, or principals, to a - single `role`. Principals can be user accounts, service accounts, Google - groups, and domains (such as G Suite). A `role` is a named list of - permissions; each `role` can be an IAM predefined role or a user-created - custom role. For some types of Google Cloud resources, a `binding` can - also specify a `condition`, which is a logical expression that allows - access to a resource only if the expression evaluates to `true`. A - condition can add constraints based on attributes of the request, the - resource, or both. To learn which resources support conditions in their - IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - **JSON example:** ``` { "bindings": [ { "role": - "roles/resourcemanager.organizationAdmin", "members": [ - "user:mike@example.com", "group:admins@example.com", - "domain:google.com", - "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { - "role": "roles/resourcemanager.organizationViewer", "members": [ - "user:eve@example.com" ], "condition": { "title": "expirable access", - "description": "Does not grant access after Sep 2020", "expression": - "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": - "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - - members: - user:mike@example.com - group:admins@example.com - - domain:google.com - - serviceAccount:my-project-id@appspot.gserviceaccount.com role: - roles/resourcemanager.organizationAdmin - members: - - user:eve@example.com role: roles/resourcemanager.organizationViewer - condition: title: expirable access description: Does not grant access - after Sep 2020 expression: request.time < - timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` - For a description of IAM and its features, see the [IAM - documentation](https://cloud.google.com/iam/docs/). + ListBackendAuthenticationConfigsResponse: + id: ListBackendAuthenticationConfigsResponse + description: Response returned by the ListBackendAuthenticationConfigs method. type: object properties: - 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). - type: integer - format: int32 - bindings: - description: >- - Associates a list of `members`, or principals, with a `role`. - Optionally, may specify a `condition` that determines how and when - the `bindings` are applied. Each of the `bindings` must contain at - least one principal. The `bindings` in a `Policy` can refer to up to - 1,500 principals; up to 250 of these principals can be Google - groups. Each occurrence of a principal counts towards these limits. - For example, if the `bindings` grant 50 different roles to - `user:alice@example.com`, and not to any other principal, then you - can add another 1,450 principals to the `bindings` in the `Policy`. + backendAuthenticationConfigs: + description: List of BackendAuthenticationConfig resources. type: array items: - $ref: '#/components/schemas/GoogleIamV1Binding' - auditConfigs: - description: Specifies cloud audit logging configuration for this policy. + $ref: '#/components/schemas/BackendAuthenticationConfig' + nextPageToken: + description: >- + If there might be more results than those appearing in this + response, then `next_page_token` is included. To get the next set of + results, call this method again using the value of `next_page_token` + as `page_token`. + type: string + unreachable: + description: Locations that could not be reached. type: array items: - $ref: '#/components/schemas/GoogleIamV1AuditConfig' - etag: + type: string + BackendAuthenticationConfig: + id: BackendAuthenticationConfig + description: >- + BackendAuthenticationConfig message groups the TrustConfig together with + other settings that control how the load balancer authenticates, and + expresses its identity to, the backend: * `trustConfig` is the attached + TrustConfig. * `wellKnownRoots` indicates whether the load balance + should trust backend server certificates that are issued by public + certificate authorities, in addition to certificates trusted by the + TrustConfig. * `clientCertificate` is a client certificate that the load + balancer uses to express its identity to the backend, if the connection + to the backend uses mTLS. You can attach the BackendAuthenticationConfig + to the load balancer's BackendService directly determining how that + BackendService negotiates TLS. + type: object + properties: + name: 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. + Required. Name of the BackendAuthenticationConfig resource. It + matches the pattern + `projects/*/locations/{location}/backendAuthenticationConfigs/{backend_authentication_config}` type: string - format: byte - GoogleIamV1Binding: - id: GoogleIamV1Binding - description: Associates `members`, or principals, with a `role`. + description: + description: Optional. Free-text description of the resource. + type: string + createTime: + description: Output only. The timestamp when the resource was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. The timestamp when the resource was updated. + readOnly: true + type: string + format: google-datetime + labels: + description: Set of label tags associated with the resource. + type: object + additionalProperties: + type: string + clientCertificate: + description: >- + Optional. A reference to a + certificatemanager.googleapis.com.Certificate resource. This is a + relative resource path following the form + "projects/{project}/locations/{location}/certificates/{certificate}". + Used by a BackendService to negotiate mTLS when the backend + connection uses TLS and the backend requests a client certificate. + Must have a CLIENT_AUTH scope. + type: string + trustConfig: + description: >- + Optional. A reference to a TrustConfig resource from the + certificatemanager.googleapis.com namespace. This is a relative + resource path following the form + "projects/{project}/locations/{location}/trustConfigs/{trust_config}". + A BackendService uses the chain of trust represented by this + TrustConfig, if specified, to validate the server certificates + presented by the backend. Required unless wellKnownRoots is set to + PUBLIC_ROOTS. + type: string + wellKnownRoots: + description: Well known roots to use for server certificate validation. + type: string + enumDescriptions: + - Equivalent to NONE. + - >- + The BackendService will only validate server certificates against + roots specified in TrustConfig. + - >- + The BackendService uses a set of well-known public roots, in + addition to any roots specified in the trustConfig field, when + validating the server certificates presented by the backend. + Validation with these roots is only considered when the + TlsSettings.sni field in the BackendService is set. The well-known + roots are a set of root CAs managed by Google. CAs in this set can + be added or removed without notice. + enum: + - WELL_KNOWN_ROOTS_UNSPECIFIED + - NONE + - PUBLIC_ROOTS + etag: + description: Output only. Etag of the resource. + readOnly: true + type: string + ListServerTlsPoliciesResponse: + id: ListServerTlsPoliciesResponse + description: Response returned by the ListServerTlsPolicies method. type: object properties: - role: + serverTlsPolicies: + description: List of ServerTlsPolicy resources. + type: array + items: + $ref: '#/components/schemas/ServerTlsPolicy' + nextPageToken: description: >- - Role that is assigned to the list of `members`, or principals. For - example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an - overview of the IAM roles and permissions, see the [IAM - documentation](https://cloud.google.com/iam/docs/roles-overview). - For a list of the available pre-defined roles, see - [here](https://cloud.google.com/iam/docs/understanding-roles). + If there might be more results than those appearing in this + response, then `next_page_token` is included. To get the next set of + results, call this method again using the value of `next_page_token` + as `page_token`. type: string - members: + unreachable: description: >- - Specifies the principals requesting access for a Google Cloud - 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. Does not include identities - that come from external identity providers (IdPs) through identity - federation. * `user:{emailid}`: An email address that represents a - specific Google account. For example, `alice@example.com` . * - `serviceAccount:{emailid}`: An email address that represents a - Google service account. For example, - `my-other-app@appspot.gserviceaccount.com`. * - `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: - An identifier for a [Kubernetes service - account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). - For example, - `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * - `group:{emailid}`: An email address that represents a Google group. - For example, `admins@example.com`. * `domain:{domain}`: The G Suite - domain (primary) that represents all the users of that domain. For - example, `google.com` or `example.com`. * - `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workforce identity pool. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: - All workforce identities in a group. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All workforce identities with a specific attribute value. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: - All identities in a workforce identity pool. * - `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workload identity pool. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: - A workload identity pool group. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All identities in a workload identity pool with a certain attribute. - * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: - All identities in a workload identity pool. * - `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. * - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - Deleted single identity in a workforce identity pool. For example, - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + Unreachable resources. Populated when the request opts into + `return_partial_success` and reading across collections e.g. when + attempting to list all resources across all supported locations. type: array items: type: string - condition: - description: >- - The condition that is associated with this binding. If the condition - evaluates to `true`, then this binding applies to the current - request. If the condition evaluates to `false`, then this binding - does not apply to the current request. However, a different role - binding might grant the same role to one or more of the principals - in this binding. To learn which resources support conditions in - their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - $ref: '#/components/schemas/Expr' - Expr: - id: Expr + ServerTlsPolicy: + id: ServerTlsPolicy 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. + ServerTlsPolicy is a resource that specifies how a server should + authenticate incoming requests. This resource itself does not affect + configuration unless it is attached to a target HTTPS proxy or endpoint + config selector resource. ServerTlsPolicy in the form accepted by + Application Load Balancers can be attached only to TargetHttpsProxy with + an `EXTERNAL`, `EXTERNAL_MANAGED` or `INTERNAL_MANAGED` load balancing + scheme. Traffic Director compatible ServerTlsPolicies can be attached to + EndpointPolicy and TargetHttpsProxy with Traffic Director + `INTERNAL_SELF_MANAGED` load balancing scheme. type: object properties: - expression: - description: >- - Textual representation of an expression in Common Expression - Language syntax. - type: string - title: + name: 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. + Required. Name of the ServerTlsPolicy resource. It matches the + pattern + `projects/*/locations/{location}/serverTlsPolicies/{server_tls_policy}` type: string 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. + description: Free-text description of the resource. 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. + createTime: + description: Output only. The timestamp when the resource was created. + readOnly: true type: string - GoogleIamV1AuditConfig: - id: GoogleIamV1AuditConfig + format: google-datetime + updateTime: + description: Output only. The timestamp when the resource was updated. + readOnly: true + type: string + format: google-datetime + labels: + description: Set of label tags associated with the resource. + type: object + additionalProperties: + type: string + allowOpen: + description: >- + This field applies only for Traffic Director policies. It is must be + set to false for Application Load Balancer policies. Determines if + server allows plaintext connections. If set to true, server allows + plain text connections. By default, it is set to false. This setting + is not exclusive of other encryption modes. For example, if + `allow_open` and `mtls_policy` are set, server allows both plain + text and mTLS connections. See documentation of other encryption + modes to confirm compatibility. Consider using it if you wish to + upgrade in place your deployment to TLS while having mixed TLS and + non-TLS traffic reaching port :80. + type: boolean + serverCertificate: + description: >- + Optional if policy is to be used with Traffic Director. For + Application Load Balancers must be empty. Defines a mechanism to + provision server identity (public and private keys). Cannot be + combined with `allow_open` as a permissive mode that allows both + plain text and TLS is not supported. + $ref: '#/components/schemas/GoogleCloudNetworksecurityV1CertificateProvider' + mtlsPolicy: + description: >- + This field is required if the policy is used with Application Load + Balancers. This field can be empty for Traffic Director. Defines a + mechanism to provision peer validation certificates for peer to peer + authentication (Mutual TLS - mTLS). If not specified, client + certificate will not be requested. The connection is treated as TLS + and not mTLS. If `allow_open` and `mtls_policy` are set, server + allows both plain text and mTLS connections. + $ref: '#/components/schemas/MTLSPolicy' + GoogleCloudNetworksecurityV1CertificateProvider: + id: GoogleCloudNetworksecurityV1CertificateProvider 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. + Specification of certificate provider. Defines the mechanism to obtain + the certificate and private key for peer to peer authentication. type: object properties: - service: + grpcEndpoint: 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 - auditLogConfigs: - description: The configuration for logging of each type of permission. - type: array - items: - $ref: '#/components/schemas/GoogleIamV1AuditLogConfig' - GoogleIamV1AuditLogConfig: - id: GoogleIamV1AuditLogConfig - 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. + gRPC specific configuration to access the gRPC server to obtain the + cert and private key. + $ref: '#/components/schemas/GoogleCloudNetworksecurityV1GrpcEndpoint' + certificateProviderInstance: + description: >- + The certificate provider instance specification that will be passed + to the data plane, which will be used to load necessary credential + information. + $ref: '#/components/schemas/CertificateProviderInstance' + GoogleCloudNetworksecurityV1GrpcEndpoint: + id: GoogleCloudNetworksecurityV1GrpcEndpoint + description: Specification of the GRPC Endpoint. type: object properties: - logType: - description: The log type that this config enables. - type: string - enumDescriptions: - - Default case. Should never be this. - - 'Admin reads. Example: CloudIAM getIamPolicy' - - 'Data writes. Example: CloudSQL Users create' - - 'Data reads. Example: CloudSQL Users list' - enum: - - LOG_TYPE_UNSPECIFIED - - ADMIN_READ - - DATA_WRITE - - DATA_READ - exemptedMembers: + targetUri: description: >- - Specifies the identities that do not cause logging for this type of - permission. Follows the same format of Binding.members. - type: array - items: - type: string - GoogleIamV1TestIamPermissionsRequest: - id: GoogleIamV1TestIamPermissionsRequest - description: Request message for `TestIamPermissions` method. + Required. The target URI of the gRPC endpoint. Only UDS path is + supported, and should start with "unix:". + type: string + CertificateProviderInstance: + id: CertificateProviderInstance + description: >- + Specification of a TLS certificate provider instance. Workloads may have + one or more CertificateProvider instances (plugins) and one of them is + enabled and configured by specifying this message. Workloads use the + values from this message to locate and load the CertificateProvider + instance configuration. type: object properties: - permissions: + pluginInstance: description: >- - The set of permissions to check for the `resource`. Permissions with - wildcards (such as `*` or `storage.*`) are not allowed. For more - information see [IAM - Overview](https://cloud.google.com/iam/docs/overview#permissions). - type: array - items: - type: string - GoogleIamV1TestIamPermissionsResponse: - id: GoogleIamV1TestIamPermissionsResponse - description: Response message for `TestIamPermissions` method. + Required. Plugin instance name, used to locate and load + CertificateProvider instance configuration. Set to + "google_cloud_private_spiffe" to use Certificate Authority Service + certificate provider instance. + type: string + MTLSPolicy: + id: MTLSPolicy + description: Specification of the MTLSPolicy. type: object properties: - permissions: + clientValidationMode: description: >- - A subset of `TestPermissionsRequest.permissions` that the caller is - allowed. - type: array - items: - type: string - OperationMetadata: - id: OperationMetadata - description: Represents the metadata of the long-running operation. + When the client presents an invalid certificate or no certificate to + the load balancer, the `client_validation_mode` specifies how the + client connection is handled. Required if the policy is to be used + with the Application Load Balancers. For Traffic Director it must be + empty. + type: string + enumDescriptions: + - Not allowed. + - >- + Allow connection even if certificate chain validation of the + client certificate failed or no client certificate was presented. + The proof of possession of the private key is always checked if + client certificate was presented. This mode requires the backend + to implement processing of data extracted from a client + certificate to authenticate the peer, or to reject connections if + the client certificate fingerprint is missing. + - >- + Require a client certificate and allow connection to the backend + only if validation of the client certificate passed. If set, + requires a reference to non-empty TrustConfig specified in + `client_validation_trust_config`. + enum: + - CLIENT_VALIDATION_MODE_UNSPECIFIED + - ALLOW_INVALID_OR_MISSING_CLIENT_CERT + - REJECT_INVALID + clientValidationCa: + description: >- + Required if the policy is to be used with Traffic Director. For + Application Load Balancers it must be empty. Defines the mechanism + to obtain the Certificate Authority certificate to validate the + client certificate. + type: array + items: + $ref: '#/components/schemas/ValidationCA' + clientValidationTrustConfig: + description: >- + Reference to the TrustConfig from certificatemanager.googleapis.com + namespace. If specified, the chain validation will be performed + against certificates configured in the given TrustConfig. Allowed + only if the policy is to be used with Application Load Balancers. + type: string + ValidationCA: + id: ValidationCA + description: >- + Specification of ValidationCA. Defines the mechanism to obtain the + Certificate Authority certificate to validate the peer certificate. + type: object + properties: + grpcEndpoint: + description: >- + gRPC specific configuration to access the gRPC server to obtain the + CA certificate. + $ref: '#/components/schemas/GoogleCloudNetworksecurityV1GrpcEndpoint' + certificateProviderInstance: + description: >- + The certificate provider instance specification that will be passed + to the data plane, which will be used to load necessary credential + information. + $ref: '#/components/schemas/CertificateProviderInstance' + ListClientTlsPoliciesResponse: + id: ListClientTlsPoliciesResponse + description: Response returned by the ListClientTlsPolicies method. + type: object + properties: + clientTlsPolicies: + description: List of ClientTlsPolicy resources. + type: array + items: + $ref: '#/components/schemas/ClientTlsPolicy' + nextPageToken: + description: >- + If there might be more results than those appearing in this + response, then `next_page_token` is included. To get the next set of + results, call this method again using the value of `next_page_token` + as `page_token`. + type: string + ClientTlsPolicy: + id: ClientTlsPolicy + description: >- + ClientTlsPolicy is a resource that specifies how a client should + authenticate connections to backends of a service. This resource itself + does not affect configuration unless it is attached to a backend service + resource. type: object properties: + name: + description: >- + Required. Name of the ClientTlsPolicy resource. It matches the + pattern + `projects/{project}/locations/{location}/clientTlsPolicies/{client_tls_policy}` + type: string + description: + description: Optional. Free-text description of the resource. + type: string createTime: - description: Output only. The time the operation was created. + description: Output only. The timestamp when the resource was created. readOnly: true type: string format: google-datetime - endTime: - description: Output only. The time the operation finished running. + updateTime: + description: Output only. The timestamp when the resource was updated. readOnly: true type: string format: google-datetime - target: + labels: + description: Optional. Set of label tags associated with the resource. + type: object + additionalProperties: + type: string + sni: description: >- - Output only. Server-defined resource path for the target of the - operation. - readOnly: true + Optional. Server Name Indication string to present to the server + during TLS handshake. E.g: "secure.example.com". type: string - verb: - description: Output only. Name of the verb executed by the operation. + clientCertificate: + description: >- + Optional. Defines a mechanism to provision client identity (public + and private keys) for peer to peer authentication. The presence of + this dictates mTLS. + $ref: '#/components/schemas/GoogleCloudNetworksecurityV1CertificateProvider' + serverValidationCa: + description: >- + Optional. Defines the mechanism to obtain the Certificate Authority + certificate to validate the server certificate. If empty, client + does not validate the server certificate. + type: array + items: + $ref: '#/components/schemas/ValidationCA' + ListGatewaySecurityPoliciesResponse: + id: ListGatewaySecurityPoliciesResponse + description: Response returned by the ListGatewaySecurityPolicies method. + type: object + properties: + gatewaySecurityPolicies: + description: List of GatewaySecurityPolicies resources. + type: array + items: + $ref: '#/components/schemas/GatewaySecurityPolicy' + nextPageToken: + description: >- + If there might be more results than those appearing in this + response, then 'next_page_token' is included. To get the next set of + results, call this method again using the value of 'next_page_token' + as 'page_token'. + type: string + unreachable: + description: Locations that could not be reached. + type: array + items: + type: string + GatewaySecurityPolicy: + id: GatewaySecurityPolicy + description: >- + The GatewaySecurityPolicy resource contains a collection of + GatewaySecurityPolicyRules and associated metadata. + type: object + properties: + name: + description: >- + Required. Name of the resource. Name is of the form + projects/{project}/locations/{location}/gatewaySecurityPolicies/{gateway_security_policy} + gateway_security_policy should match the + pattern:(^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$). + type: string + createTime: + description: Output only. The timestamp when the resource was created. readOnly: true type: string - statusMessage: - description: Output only. Human-readable status of the operation, if any. + format: google-datetime + updateTime: + description: Output only. The timestamp when the resource was updated. readOnly: true type: string - requestedCancellation: + format: google-datetime + description: + description: Optional. Free-text description of the resource. + type: string + tlsInspectionPolicy: description: >- - Output only. Identifies whether the user has requested cancellation - of the operation. Operations that have successfully been cancelled - have Operation.error value with a google.rpc.Status.code of 1, - corresponding to `Code.CANCELLED`. + Optional. Name of a TLS Inspection Policy resource that defines how + TLS inspection will be performed for any rule(s) which enables it. + type: string + ListGatewaySecurityPolicyRulesResponse: + id: ListGatewaySecurityPolicyRulesResponse + description: Response returned by the ListGatewaySecurityPolicyRules method. + type: object + properties: + gatewaySecurityPolicyRules: + description: List of GatewaySecurityPolicyRule resources. + type: array + items: + $ref: '#/components/schemas/GatewaySecurityPolicyRule' + nextPageToken: + description: >- + If there might be more results than those appearing in this + response, then 'next_page_token' is included. To get the next set of + results, call this method again using the value of 'next_page_token' + as 'page_token'. + type: string + unreachable: + description: Locations that could not be reached. + type: array + items: + type: string + GatewaySecurityPolicyRule: + id: GatewaySecurityPolicyRule + description: >- + The GatewaySecurityPolicyRule resource is in a nested collection within + a GatewaySecurityPolicy and represents a traffic matching condition and + associated action to perform. + type: object + properties: + basicProfile: + description: Required. Profile which tells what the primitive action should be. + type: string + enumDescriptions: + - If there is not a mentioned action for the target. + - Allow the matched traffic. + - Deny the matched traffic. + enum: + - BASIC_PROFILE_UNSPECIFIED + - ALLOW + - DENY + name: + description: >- + Required. Immutable. Name of the resource. ame is the full resource + name so + projects/{project}/locations/{location}/gatewaySecurityPolicies/{gateway_security_policy}/rules/{rule} + rule should match the pattern: (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$). + type: string + createTime: + description: Output only. Time when the rule was created. readOnly: true - type: boolean - apiVersion: - description: Output only. API version used to start the operation. + type: string + format: google-datetime + updateTime: + description: Output only. Time when the rule was updated. readOnly: true type: string - parameters: - 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: - type: string - enum: - - json - - media - - proto - 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: + format: google-datetime + enabled: + description: Required. Whether the rule is enforced. + type: boolean + priority: + description: >- + Required. Priority of the rule. Lower number corresponds to higher + precedence. + type: integer + format: int32 + description: + description: Optional. Free-text description of the resource. + type: string + sessionMatcher: + description: Required. CEL expression for matching on session criteria. + type: string + applicationMatcher: + description: >- + Optional. CEL expression for matching on L7/application level + criteria. + type: string + tlsInspectionEnabled: + description: >- + Optional. Flag to enable TLS inspection of traffic matching on , can + only be true if the parent GatewaySecurityPolicy references a + TLSInspectionConfig. + type: boolean + ListUrlListsResponse: + id: ListUrlListsResponse + description: Response returned by the ListUrlLists method. + type: object + properties: + urlLists: + description: List of UrlList resources. + type: array + items: + $ref: '#/components/schemas/UrlList' + nextPageToken: + description: >- + If there might be more results than those appearing in this + response, then `next_page_token` is included. To get the next set of + results, call this method again using the value of `next_page_token` + as `page_token`. + type: string + unreachable: + description: Locations that could not be reached. + type: array + items: + type: string + UrlList: + id: UrlList 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: + UrlList proto helps users to set reusable, independently manageable + lists of hosts, host patterns, URLs, URL patterns. + type: object + properties: + name: + description: >- + Required. Name of the resource provided by the user. Name is of the + form projects/{project}/locations/{location}/urlLists/{url_list} + url_list should match the + pattern:(^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$). + type: string + createTime: + description: Output only. Time when the security policy was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. Time when the security policy was updated. + readOnly: true + type: string + format: google-datetime + description: + description: Optional. Free-text description of the resource. + type: string + values: + description: Required. FQDNs and URLs. + type: array + items: + type: string + ListTlsInspectionPoliciesResponse: + id: ListTlsInspectionPoliciesResponse + description: Response returned by the ListTlsInspectionPolicies method. + type: object + properties: + tlsInspectionPolicies: + description: List of TlsInspectionPolicies resources. + type: array + items: + $ref: '#/components/schemas/TlsInspectionPolicy' + nextPageToken: + description: >- + If there might be more results than those appearing in this + response, then 'next_page_token' is included. To get the next set of + results, call this method again using the value of 'next_page_token' + as 'page_token'. + type: string + unreachable: + description: Locations that could not be reached. + type: array + items: + type: string + TlsInspectionPolicy: + id: TlsInspectionPolicy 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 - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string - _.xgafv: - description: V1 error format. - in: query - name: $.xgafv - schema: - type: string - enum: - - '1' - - '2' - x-stackQL-resources: - locations: - id: google.networksecurity.locations - name: locations - title: Locations - methods: - projects_locations_list: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.locations - projects_locations_get: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/locations/methods/projects_locations_get - - $ref: >- - #/components/x-stackQL-resources/locations/methods/projects_locations_list - insert: [] - update: [] - replace: [] - delete: [] - operations: - id: google.networksecurity.operations - name: operations - title: Operations - methods: - projects_locations_operations_list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.operations - projects_locations_operations_get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_operations_delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_operations_cancel: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_locations_operations_list: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1operations/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.operations - organizations_locations_operations_get: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1operations~1{operationsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_locations_operations_delete: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1operations~1{operationsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_locations_operations_cancel: - operation: - $ref: >- + The TlsInspectionPolicy resource contains references to CA pools in + Certificate Authority Service and associated metadata. + type: object + properties: + name: + description: >- + Required. Name of the resource. Name is of the form + projects/{project}/locations/{location}/tlsInspectionPolicies/{tls_inspection_policy} + tls_inspection_policy should match the + pattern:(^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$). + type: string + description: + description: Optional. Free-text description of the resource. + type: string + createTime: + description: Output only. The timestamp when the resource was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. The timestamp when the resource was updated. + readOnly: true + type: string + format: google-datetime + caPool: + description: >- + Required. A CA pool resource used to issue interception + certificates. The CA pool string has a relative resource path + following the form + "projects/{project}/locations/{location}/caPools/{ca_pool}". + type: string + trustConfig: + description: >- + Optional. A TrustConfig resource used when making a connection to + the TLS server. This is a relative resource path following the form + "projects/{project}/locations/{location}/trustConfigs/{trust_config}". + This is necessary to intercept TLS connections to servers with + certificates signed by a private CA or self-signed certificates. + Note that Secure Web Proxy does not yet honor this field. + type: string + excludePublicCaSet: + description: >- + Optional. If FALSE (the default), use our default set of public CAs + in addition to any CAs specified in trust_config. These public CAs + are currently based on the Mozilla Root Program and are subject to + change over time. If TRUE, do not accept our default set of public + CAs. Only CAs specified in trust_config will be accepted. This + defaults to FALSE (use public CAs in addition to trust_config) for + backwards compatibility, but trusting public root CAs is *not + recommended* unless the traffic in question is outbound to public + web servers. When possible, prefer setting this to "false" and + explicitly specifying trusted CAs and certificates in a TrustConfig. + Note that Secure Web Proxy does not yet honor this field. + type: boolean + minTlsVersion: + description: >- + Optional. Minimum TLS version that the firewall should use when + negotiating connections with both clients and servers. If this is + not set, then the default value is to allow the broadest set of + clients and servers (TLS 1.0 or higher). Setting this to more + restrictive values may improve security, but may also prevent the + firewall from connecting to some clients or servers. Note that + Secure Web Proxy does not yet honor this field. + type: string + enumDescriptions: + - Indicates no TLS version was specified. + - TLS 1.0 + - TLS 1.1 + - TLS 1.2 + - TLS 1.3 + enum: + - TLS_VERSION_UNSPECIFIED + - TLS_1_0 + - TLS_1_1 + - TLS_1_2 + - TLS_1_3 + tlsFeatureProfile: + description: >- + Optional. The selected Profile. If this is not set, then the default + value is to allow the broadest set of clients and servers + ("PROFILE_COMPATIBLE"). Setting this to more restrictive values may + improve security, but may also prevent the TLS inspection proxy from + connecting to some clients or servers. Note that Secure Web Proxy + does not yet honor this field. + type: string + enumDescriptions: + - Indicates no profile was specified. + - >- + Compatible profile. Allows the broadest set of clients, even those + which support only out-of-date SSL features to negotiate with the + TLS inspection proxy. + - >- + Modern profile. Supports a wide set of SSL features, allowing + modern clients to negotiate SSL with the TLS inspection proxy. + - >- + Restricted profile. Supports a reduced set of SSL features, + intended to meet stricter compliance requirements. + - >- + Custom profile. Allow only the set of allowed SSL features + specified in the custom_features field of SslPolicy. + enum: + - PROFILE_UNSPECIFIED + - PROFILE_COMPATIBLE + - PROFILE_MODERN + - PROFILE_RESTRICTED + - PROFILE_CUSTOM + customTlsFeatures: + description: >- + Optional. List of custom TLS cipher suites selected. This field is + valid only if the selected tls_feature_profile is CUSTOM. The + compute.SslPoliciesService.ListAvailableFeatures method returns the + set of features that can be specified in this list. Note that Secure + Web Proxy does not yet honor this field. + type: array + items: + type: string + ListAuthzPoliciesResponse: + id: ListAuthzPoliciesResponse + description: Message for response to listing `AuthzPolicy` resources. + type: object + properties: + authzPolicies: + description: The list of `AuthzPolicy` resources. + type: array + items: + $ref: '#/components/schemas/AuthzPolicy' + nextPageToken: + description: A token identifying a page of results that the server returns. + type: string + unreachable: + description: Locations that could not be reached. + type: array + items: + type: string + AuthzPolicy: + id: AuthzPolicy + description: >- + `AuthzPolicy` is a resource that allows to forward traffic to a callout + backend designed to scan the traffic for security purposes. + type: object + properties: + name: + description: >- + Required. Identifier. Name of the `AuthzPolicy` resource in the + following format: + `projects/{project}/locations/{location}/authzPolicies/{authz_policy}`. + type: string + createTime: + description: Output only. The timestamp when the resource was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. The timestamp when the resource was updated. + readOnly: true + type: string + format: google-datetime + description: + description: Optional. A human-readable description of the resource. + type: string + labels: + description: >- + Optional. Set of labels associated with the `AuthzPolicy` resource. + The format must comply with [the following + requirements](/compute/docs/labeling-resources#requirements). + type: object + additionalProperties: + type: string + target: + description: >- + Required. Specifies the set of resources to which this policy should + be applied to. + $ref: '#/components/schemas/AuthzPolicyTarget' + httpRules: + description: >- + Optional. A list of authorization HTTP rules to match against the + incoming request. A policy match occurs when at least one HTTP rule + matches the request or when no HTTP rules are specified in the + policy. At least one HTTP Rule is required for Allow or Deny Action. + Limited to 5 rules. + type: array + items: + $ref: '#/components/schemas/AuthzPolicyAuthzRule' + action: + description: >- + Required. Can be one of `ALLOW`, `DENY`, `CUSTOM`. When the action + is `CUSTOM`, `customProvider` must be specified. When the action is + `ALLOW`, only requests matching the policy will be allowed. When the + action is `DENY`, only requests matching the policy will be denied. + When a request arrives, the policies are evaluated in the following + order: 1. If there is a `CUSTOM` policy that matches the request, + the `CUSTOM` policy is evaluated using the custom authorization + providers and the request is denied if the provider rejects the + request. 2. If there are any `DENY` policies that match the request, + the request is denied. 3. If there are no `ALLOW` policies for the + resource or if any of the `ALLOW` policies match the request, the + request is allowed. 4. Else the request is denied by default if none + of the configured AuthzPolicies with `ALLOW` action match the + request. + type: string + enumDescriptions: + - Unspecified action. + - Allow request to pass through to the backend. + - Deny the request and return a HTTP 404 to the client. + - >- + Delegate the authorization decision to an external authorization + engine. + enum: + - AUTHZ_ACTION_UNSPECIFIED + - ALLOW + - DENY + - CUSTOM + customProvider: + description: >- + Optional. Required if the action is `CUSTOM`. Allows delegating + authorization decisions to Cloud IAP or to Service Extensions. One + of `cloudIap` or `authzExtension` must be specified. + $ref: '#/components/schemas/AuthzPolicyCustomProvider' + AuthzPolicyTarget: + id: AuthzPolicyTarget + description: Specifies the set of targets to which this policy should be applied to. + type: object + properties: + loadBalancingScheme: + description: >- + Required. All gateways and forwarding rules referenced by this + policy and extensions must share the same load balancing scheme. + Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For + more information, refer to [Backend services + overview](https://cloud.google.com/load-balancing/docs/backend-service). + type: string + enumDescriptions: + - Default value. Do not use. + - >- + Signifies that this is used for Regional internal or Cross-region + internal Application Load Balancing. + - >- + Signifies that this is used for Global external or Regional + external Application Load Balancing. + - >- + Signifies that this is used for Cloud Service Mesh. Meant for use + by CSM GKE controller only. + enum: + - LOAD_BALANCING_SCHEME_UNSPECIFIED + - INTERNAL_MANAGED + - EXTERNAL_MANAGED + - INTERNAL_SELF_MANAGED + resources: + description: >- + Required. A list of references to the Forwarding Rules on which this + policy will be applied. + type: array + items: + type: string + AuthzPolicyAuthzRule: + id: AuthzPolicyAuthzRule + description: Conditions to match against the incoming request. + type: object + properties: + from: + description: Optional. Describes properties of a source of a request. + $ref: '#/components/schemas/AuthzPolicyAuthzRuleFrom' + to: + description: Optional. Describes properties of a target of a request. + $ref: '#/components/schemas/AuthzPolicyAuthzRuleTo' + when: + description: >- + Optional. CEL expression that describes the conditions to be + satisfied for the action. The result of the CEL expression is ANDed + with the from and to. Refer to the CEL language reference for a list + of available attributes. + type: string + AuthzPolicyAuthzRuleFrom: + id: AuthzPolicyAuthzRuleFrom + description: Describes properties of one or more sources of a request. + type: object + properties: + sources: + description: >- + Optional. Describes the properties of a request's sources. At least + one of sources or notSources must be specified. Limited to 1 source. + A match occurs when ANY source (in sources or notSources) matches + the request. Within a single source, the match follows AND semantics + across fields and OR semantics within a single field, i.e. a match + occurs when ANY principal matches AND ANY ipBlocks match. + type: array + items: + $ref: '#/components/schemas/AuthzPolicyAuthzRuleFromRequestSource' + notSources: + description: >- + Optional. Describes the negated properties of request sources. + Matches requests from sources that do not match the criteria + specified in this field. At least one of sources or notSources must + be specified. + type: array + items: + $ref: '#/components/schemas/AuthzPolicyAuthzRuleFromRequestSource' + AuthzPolicyAuthzRuleFromRequestSource: + id: AuthzPolicyAuthzRuleFromRequestSource + description: Describes the properties of a single source. + type: object + properties: + principals: + description: >- + Optional. A list of identities derived from the client's + certificate. This field will not match on a request unless frontend + mutual TLS is enabled for the forwarding rule or Gateway and the + client certificate has been successfully validated by mTLS. Each + identity is a string whose value is matched against a list of URI + SANs, DNS Name SANs, or the common name in the client's certificate. + A match happens when any principal matches with the rule. Limited to + 50 principals per Authorization Policy for Regional Internal + Application Load Balancer, Regional External Application Load + Balancer, Cross-region Internal Application Load Balancer, and Cloud + Service Mesh. Limited to 25 principals per Authorization Policy for + Global External Application Load Balancer. + type: array + items: + $ref: '#/components/schemas/AuthzPolicyAuthzRulePrincipal' + ipBlocks: + description: >- + Optional. A list of IP addresses or IP address ranges to match + against the source IP address of the request. Limited to 10 + ip_blocks per Authorization Policy + type: array + items: + $ref: '#/components/schemas/AuthzPolicyAuthzRuleIpBlock' + resources: + description: >- + Optional. A list of resources to match against the resource of the + source VM of a request. Limited to 10 resources per Authorization + Policy. + type: array + items: + $ref: '#/components/schemas/AuthzPolicyAuthzRuleRequestResource' + AuthzPolicyAuthzRulePrincipal: + id: AuthzPolicyAuthzRulePrincipal + description: Describes the properties of a principal to be matched against. + type: object + properties: + principalSelector: + description: >- + Optional. An enum to decide what principal value the principal rule + will match against. If not specified, the PrincipalSelector is + CLIENT_CERT_URI_SAN. + type: string + enumDescriptions: + - >- + Unspecified principal selector. It will be treated as + CLIENT_CERT_URI_SAN by default. + - >- + The principal rule is matched against a list of URI SANs in the + validated client's certificate. A match happens when there is any + exact URI SAN value match. This is the default principal selector. + - >- + The principal rule is matched against a list of DNS Name SANs in + the validated client's certificate. A match happens when there is + any exact DNS Name SAN value match. This is only applicable for + Application Load Balancers except for classic Global External + Application load balancer. CLIENT_CERT_DNS_NAME_SAN is not + supported for INTERNAL_SELF_MANAGED load balancing scheme. + - >- + The principal rule is matched against the common name in the + client's certificate. Authorization against multiple common names + in the client certificate is not supported. Requests with multiple + common names in the client certificate will be rejected if + CLIENT_CERT_COMMON_NAME is set as the principal selector. A match + happens when there is an exact common name value match. This is + only applicable for Application Load Balancers except for classic + Global External Application load balancer. CLIENT_CERT_COMMON_NAME + is not supported for INTERNAL_SELF_MANAGED load balancing scheme. + enum: + - PRINCIPAL_SELECTOR_UNSPECIFIED + - CLIENT_CERT_URI_SAN + - CLIENT_CERT_DNS_NAME_SAN + - CLIENT_CERT_COMMON_NAME + principal: + description: >- + Required. A non-empty string whose value is matched against the + principal value based on the principal_selector. Only exact match + can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, + CLIENT_CERT_COMMON_NAME selectors. + $ref: '#/components/schemas/AuthzPolicyAuthzRuleStringMatch' + AuthzPolicyAuthzRuleStringMatch: + id: AuthzPolicyAuthzRuleStringMatch + description: Determines how a string value should be matched. + type: object + properties: + exact: + description: >- + The input string must match exactly the string specified here. + Examples: * ``abc`` only matches the value ``abc``. + type: string + prefix: + description: >- + The input string must have the prefix specified here. Note: empty + prefix is not allowed, please use regex instead. Examples: * ``abc`` + matches the value ``abc.xyz`` + type: string + suffix: + description: >- + The input string must have the suffix specified here. Note: empty + prefix is not allowed, please use regex instead. Examples: * ``abc`` + matches the value ``xyz.abc`` + type: string + contains: + description: >- + The input string must have the substring specified here. Note: empty + contains match is not allowed, please use regex instead. Examples: * + ``abc`` matches the value ``xyz.abc.def`` + type: string + ignoreCase: + description: >- + If true, indicates the exact/prefix/suffix/contains matching should + be case insensitive. For example, the matcher ``data`` will match + both input string ``Data`` and ``data`` if set to true. + type: boolean + AuthzPolicyAuthzRuleIpBlock: + id: AuthzPolicyAuthzRuleIpBlock + description: Represents a range of IP Addresses. + type: object + properties: + prefix: + description: Required. The address prefix. + type: string + length: + description: Required. The length of the address range. + type: integer + format: int32 + AuthzPolicyAuthzRuleRequestResource: + id: AuthzPolicyAuthzRuleRequestResource + description: >- + Describes the properties of a client VM resource accessing the internal + application load balancers. + type: object + properties: + tagValueIdSet: + description: >- + Optional. A list of resource tag value permanent IDs to match + against the resource manager tags value associated with the source + VM of a request. + $ref: >- + #/components/schemas/AuthzPolicyAuthzRuleRequestResourceTagValueIdSet + iamServiceAccount: + description: >- + Optional. An IAM service account to match against the source service + account of the VM sending the request. + $ref: '#/components/schemas/AuthzPolicyAuthzRuleStringMatch' + AuthzPolicyAuthzRuleRequestResourceTagValueIdSet: + id: AuthzPolicyAuthzRuleRequestResourceTagValueIdSet + description: >- + Describes a set of resource tag value permanent IDs to match against the + resource manager tags value associated with the source VM of a request. + type: object + properties: + ids: + description: >- + Required. A list of resource tag value permanent IDs to match + against the resource manager tags value associated with the source + VM of a request. The match follows AND semantics which means all the + ids must match. Limited to 5 ids in the Tag value id set. + type: array + items: + type: string + format: int64 + AuthzPolicyAuthzRuleTo: + id: AuthzPolicyAuthzRuleTo + description: Describes properties of one or more targets of a request. + type: object + properties: + operations: + description: >- + Optional. Describes properties of one or more targets of a request. + At least one of operations or notOperations must be specified. + Limited to 1 operation. A match occurs when ANY operation (in + operations or notOperations) matches. Within an operation, the match + follows AND semantics across fields and OR semantics within a field, + i.e. a match occurs when ANY path matches AND ANY header matches and + ANY method matches. + type: array + items: + $ref: '#/components/schemas/AuthzPolicyAuthzRuleToRequestOperation' + notOperations: + description: >- + Optional. Describes the negated properties of the targets of a + request. Matches requests for operations that do not match the + criteria specified in this field. At least one of operations or + notOperations must be specified. + type: array + items: + $ref: '#/components/schemas/AuthzPolicyAuthzRuleToRequestOperation' + AuthzPolicyAuthzRuleToRequestOperation: + id: AuthzPolicyAuthzRuleToRequestOperation + description: Describes properties of one or more targets of a request. + type: object + properties: + headerSet: + description: Optional. A list of headers to match against in http header. + $ref: '#/components/schemas/AuthzPolicyAuthzRuleToRequestOperationHeaderSet' + hosts: + description: >- + Optional. A list of HTTP Hosts to match against. The match can be + one of exact, prefix, suffix, or contains (substring match). Matches + are always case sensitive unless the ignoreCase is set. Limited to + 10 hosts per Authorization Policy. + type: array + items: + $ref: '#/components/schemas/AuthzPolicyAuthzRuleStringMatch' + paths: + description: >- + Optional. A list of paths to match against. The match can be one of + exact, prefix, suffix, or contains (substring match). Matches are + always case sensitive unless the ignoreCase is set. Limited to 10 + paths per Authorization Policy. Note that this path match includes + the query parameters. For gRPC services, this should be a + fully-qualified name of the form /package.service/method. + type: array + items: + $ref: '#/components/schemas/AuthzPolicyAuthzRuleStringMatch' + methods: + description: >- + Optional. A list of HTTP methods to match against. Each entry must + be a valid HTTP method name (GET, PUT, POST, HEAD, PATCH, DELETE, + OPTIONS). It only allows exact match and is always case sensitive. + Limited to 10 methods per Authorization Policy. + type: array + items: + type: string + AuthzPolicyAuthzRuleToRequestOperationHeaderSet: + id: AuthzPolicyAuthzRuleToRequestOperationHeaderSet + description: Describes a set of HTTP headers to match against. + type: object + properties: + headers: + description: >- + Required. A list of headers to match against in http header. The + match can be one of exact, prefix, suffix, or contains (substring + match). The match follows AND semantics which means all the headers + must match. Matches are always case sensitive unless the ignoreCase + is set. Limited to 10 headers per Authorization Policy. + type: array + items: + $ref: '#/components/schemas/AuthzPolicyAuthzRuleHeaderMatch' + AuthzPolicyAuthzRuleHeaderMatch: + id: AuthzPolicyAuthzRuleHeaderMatch + description: Determines how a HTTP header should be matched. + type: object + properties: + name: + description: Optional. Specifies the name of the header in the request. + type: string + value: + description: Optional. Specifies how the header match will be performed. + $ref: '#/components/schemas/AuthzPolicyAuthzRuleStringMatch' + AuthzPolicyCustomProvider: + id: AuthzPolicyCustomProvider + description: >- + Allows delegating authorization decisions to Cloud IAP or to Service + Extensions. + type: object + properties: + cloudIap: + description: >- + Optional. Delegates authorization decisions to Cloud IAP. Applicable + only for managed load balancers. Enabling Cloud IAP at the + AuthzPolicy level is not compatible with Cloud IAP settings in the + BackendService. Enabling IAP in both places will result in request + failure. Ensure that IAP is enabled in either the AuthzPolicy or the + BackendService but not in both places. + $ref: '#/components/schemas/AuthzPolicyCustomProviderCloudIap' + authzExtension: + description: >- + Optional. Delegate authorization decision to user authored Service + Extension. Only one of cloudIap or authzExtension can be specified. + $ref: '#/components/schemas/AuthzPolicyCustomProviderAuthzExtension' + AuthzPolicyCustomProviderCloudIap: + id: AuthzPolicyCustomProviderCloudIap + description: >- + Optional. Delegates authorization decisions to Cloud IAP. Applicable + only for managed load balancers. Enabling Cloud IAP at the AuthzPolicy + level is not compatible with Cloud IAP settings in the BackendService. + Enabling IAP in both places will result in request failure. Ensure that + IAP is enabled in either the AuthzPolicy or the BackendService but not + in both places. + type: object + properties: {} + AuthzPolicyCustomProviderAuthzExtension: + id: AuthzPolicyCustomProviderAuthzExtension + description: >- + Optional. Delegate authorization decision to user authored extension. + Only one of cloudIap or authzExtension can be specified. + type: object + properties: + resources: + description: >- + Required. A list of references to authorization extensions that will + be invoked for requests matching this policy. Limited to 1 custom + provider. + type: array + items: + type: string + ListSecurityProfileGroupsResponse: + id: ListSecurityProfileGroupsResponse + description: Response returned by the ListSecurityProfileGroups method. + type: object + properties: + securityProfileGroups: + description: List of SecurityProfileGroups resources. + type: array + items: + $ref: '#/components/schemas/SecurityProfileGroup' + nextPageToken: + description: >- + If there might be more results than those appearing in this + response, then `next_page_token` is included. To get the next set of + results, call this method again using the value of `next_page_token` + as `page_token`. + type: string + SecurityProfileGroup: + id: SecurityProfileGroup + description: >- + SecurityProfileGroup is a resource that defines the behavior for various + ProfileTypes. + type: object + properties: + name: + description: >- + Immutable. Identifier. Name of the SecurityProfileGroup resource. It + matches pattern + `projects|organizations/*/locations/{location}/securityProfileGroups/{security_profile_group}`. + type: string + description: + description: >- + Optional. An optional description of the profile group. Max length + 2048 characters. + type: string + createTime: + description: Output only. Resource creation timestamp. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. Last resource update timestamp. + readOnly: true + type: string + format: google-datetime + etag: + description: >- + Output only. This checksum is computed by the server based on the + value of other fields, and may be sent on update and delete requests + to ensure the client has an up-to-date value before proceeding. + readOnly: true + type: string + dataPathId: + description: >- + Output only. Identifier used by the data-path. Unique within + {container, location}. + readOnly: true + type: string + format: uint64 + labels: + description: Optional. Labels as key value pairs. + type: object + additionalProperties: + type: string + threatPreventionProfile: + description: >- + Optional. Reference to a SecurityProfile with the ThreatPrevention + configuration. + type: string + customMirroringProfile: + description: >- + Optional. Reference to a SecurityProfile with the CustomMirroring + configuration. + type: string + customInterceptProfile: + description: >- + Optional. Reference to a SecurityProfile with the CustomIntercept + configuration. + type: string + ListSecurityProfilesResponse: + id: ListSecurityProfilesResponse + description: Response returned by the ListSecurityProfiles method. + type: object + properties: + securityProfiles: + description: List of SecurityProfile resources. + type: array + items: + $ref: '#/components/schemas/SecurityProfile' + nextPageToken: + description: >- + If there might be more results than those appearing in this + response, then `next_page_token` is included. To get the next set of + results, call this method again using the value of `next_page_token` + as `page_token`. + type: string + SecurityProfile: + id: SecurityProfile + description: >- + SecurityProfile is a resource that defines the behavior for one of many + ProfileTypes. + type: object + properties: + threatPreventionProfile: + description: The threat prevention configuration for the SecurityProfile. + $ref: '#/components/schemas/ThreatPreventionProfile' + customMirroringProfile: + description: >- + The custom Packet Mirroring v2 configuration for the + SecurityProfile. + $ref: '#/components/schemas/CustomMirroringProfile' + customInterceptProfile: + description: The custom TPPI configuration for the SecurityProfile. + $ref: '#/components/schemas/CustomInterceptProfile' + name: + description: >- + Immutable. Identifier. Name of the SecurityProfile resource. It + matches pattern + `projects|organizations/*/locations/{location}/securityProfiles/{security_profile}`. + type: string + description: + description: >- + Optional. An optional description of the profile. Max length 512 + characters. + type: string + createTime: + description: Output only. Resource creation timestamp. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. Last resource update timestamp. + readOnly: true + type: string + format: google-datetime + etag: + description: >- + Output only. This checksum is computed by the server based on the + value of other fields, and may be sent on update and delete requests + to ensure the client has an up-to-date value before proceeding. + readOnly: true + type: string + labels: + description: Optional. Labels as key value pairs. + type: object + additionalProperties: + type: string + type: + description: >- + Immutable. The single ProfileType that the SecurityProfile resource + configures. + type: string + enumDescriptions: + - Profile type not specified. + - Profile type for threat prevention. + - Profile type for packet mirroring v2 + - Profile type for TPPI. + enum: + - PROFILE_TYPE_UNSPECIFIED + - THREAT_PREVENTION + - CUSTOM_MIRRORING + - CUSTOM_INTERCEPT + ThreatPreventionProfile: + id: ThreatPreventionProfile + description: >- + ThreatPreventionProfile defines an action for specific threat signatures + or severity levels. + type: object + properties: + severityOverrides: + description: >- + Optional. Configuration for overriding threats actions by severity + match. + type: array + items: + $ref: '#/components/schemas/SeverityOverride' + threatOverrides: + description: >- + Optional. Configuration for overriding threats actions by threat_id + match. If a threat is matched both by configuration provided in + severity_overrides and threat_overrides, the threat_overrides action + is applied. + type: array + items: + $ref: '#/components/schemas/ThreatOverride' + antivirusOverrides: + description: >- + Optional. Configuration for overriding antivirus actions per + protocol. + type: array + items: + $ref: '#/components/schemas/AntivirusOverride' + SeverityOverride: + id: SeverityOverride + description: Defines what action to take for a specific severity match. + type: object + properties: + severity: + description: Required. Severity level to match. + type: string + enumDescriptions: + - Severity level not specified. + - >- + Suspicious events that do not pose an immediate threat, but that + are reported to call attention to deeper problems that could + possibly exist. + - >- + Warning-level threats that have very little impact on an + organization's infrastructure. They usually require local or + physical system access and may often result in victim privacy + issues and information leakage. + - >- + Minor threats in which impact is minimized, that do not compromise + the target or exploits that require an attacker to reside on the + same local network as the victim, affect only non-standard + configurations or obscure applications, or provide very limited + access. + - >- + Threats that have the ability to become critical but have + mitigating factors; for example, they may be difficult to exploit, + do not result in elevated privileges, or do not have a large + victim pool. + - >- + Serious threats, such as those that affect default installations + of widely deployed software, result in root compromise of servers, + and the exploit code is widely available to attackers. The + attacker usually does not need any special authentication + credentials or knowledge about the individual victims and the + target does not need to be manipulated into performing any special + functions. + enum: + - SEVERITY_UNSPECIFIED + - INFORMATIONAL + - LOW + - MEDIUM + - HIGH + - CRITICAL + action: + description: Required. Threat action override. + type: string + enumDescriptions: + - Threat action not specified. + - The default action (as specified by the vendor) is taken. + - The packet matching this rule will be allowed to transmit. + - >- + The packet matching this rule will be allowed to transmit, but a + threat_log entry will be sent to the consumer project. + - >- + The packet matching this rule will be dropped, and a threat_log + entry will be sent to the consumer project. + enum: + - THREAT_ACTION_UNSPECIFIED + - DEFAULT_ACTION + - ALLOW + - ALERT + - DENY + ThreatOverride: + id: ThreatOverride + description: Defines what action to take for a specific threat_id match. + type: object + properties: + threatId: + description: Required. Vendor-specific ID of a threat to override. + type: string + type: + description: Output only. Type of the threat (read only). + readOnly: true + type: string + enumDescriptions: + - Type of threat not specified. + - >- + Type of threat is not derivable from threat ID. An override will + be created for all types. Firewall will ignore overridden + signature ID's that don't exist in the specific type. + - >- + Threats related to system flaws that an attacker might otherwise + attempt to exploit. + - >- + Threats related to viruses and malware found in executables and + file types. + - >- + Threats related to command-and-control (C2) activity, where + spyware on an infected client is collecting data without the + user's consent and/or communicating with a remote attacker. + - Threats related to DNS. + enum: + - THREAT_TYPE_UNSPECIFIED + - UNKNOWN + - VULNERABILITY + - ANTIVIRUS + - SPYWARE + - DNS + action: + description: >- + Required. Threat action override. For some threat types, only a + subset of actions applies. + type: string + enumDescriptions: + - Threat action not specified. + - The default action (as specified by the vendor) is taken. + - The packet matching this rule will be allowed to transmit. + - >- + The packet matching this rule will be allowed to transmit, but a + threat_log entry will be sent to the consumer project. + - >- + The packet matching this rule will be dropped, and a threat_log + entry will be sent to the consumer project. + enum: + - THREAT_ACTION_UNSPECIFIED + - DEFAULT_ACTION + - ALLOW + - ALERT + - DENY + AntivirusOverride: + id: AntivirusOverride + description: Defines what action to take for antivirus threats per protocol. + type: object + properties: + protocol: + description: Required. Protocol to match. + type: string + enumDescriptions: + - Protocol not specified. + - SMTP protocol + - SMB protocol + - POP3 protocol + - IMAP protocol + - HTTP2 protocol + - HTTP protocol + - FTP protocol + enum: + - PROTOCOL_UNSPECIFIED + - SMTP + - SMB + - POP3 + - IMAP + - HTTP2 + - HTTP + - FTP + action: + description: >- + Required. Threat action override. For some threat types, only a + subset of actions applies. + type: string + enumDescriptions: + - Threat action not specified. + - The default action (as specified by the vendor) is taken. + - The packet matching this rule will be allowed to transmit. + - >- + The packet matching this rule will be allowed to transmit, but a + threat_log entry will be sent to the consumer project. + - >- + The packet matching this rule will be dropped, and a threat_log + entry will be sent to the consumer project. + enum: + - THREAT_ACTION_UNSPECIFIED + - DEFAULT_ACTION + - ALLOW + - ALERT + - DENY + CustomMirroringProfile: + id: CustomMirroringProfile + description: >- + CustomMirroringProfile defines out-of-band integration behavior + (mirroring). It is used by mirroring rules with a MIRROR action. + type: object + properties: + mirroringEndpointGroup: + description: >- + Required. The target MirroringEndpointGroup. When a mirroring rule + with this security profile attached matches a packet, a replica will + be mirrored to the location-local target in this group. + type: string + CustomInterceptProfile: + id: CustomInterceptProfile + description: >- + CustomInterceptProfile defines in-band integration behavior (intercept). + It is used by firewall rules with an APPLY_SECURITY_PROFILE_GROUP + action. + type: object + properties: + interceptEndpointGroup: + description: >- + Required. The target InterceptEndpointGroup. When a firewall rule + with this security profile attached matches a packet, the packet + will be intercepted to the location-local target in this group. + type: string + ListLocationsResponse: + id: ListLocationsResponse + description: The response message for Locations.ListLocations. + type: object + properties: + locations: + description: >- + A list of locations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/Location' + nextPageToken: + description: The standard List next-page token. + type: string + Location: + id: Location + description: A resource that represents a Google Cloud location. + type: object + properties: + name: + description: >- + Resource name for the location, which may vary between + implementations. For example: + `"projects/example-project/locations/us-east1"` + type: string + locationId: + description: 'The canonical id for this location. For example: `"us-east1"`.' + type: string + displayName: + description: >- + The friendly name for this location, typically a nearby city name. + For example, "Tokyo". + type: string + labels: + description: >- + Cross-service attributes for the location. For example + {"cloud.googleapis.com/region": "us-east1"} + type: object + additionalProperties: + type: string + metadata: + description: >- + Service-specific metadata. For example the available capacity at the + given location. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + GoogleIamV1SetIamPolicyRequest: + id: GoogleIamV1SetIamPolicyRequest + description: Request message for `SetIamPolicy` method. + type: object + properties: + policy: + description: >- + REQUIRED: The complete policy to be applied to the `resource`. The + size of the policy is limited to a few 10s of KB. An empty policy is + a valid policy but certain Google Cloud services (such as Projects) + might reject them. + $ref: '#/components/schemas/GoogleIamV1Policy' + updateMask: + description: >- + OPTIONAL: A FieldMask specifying which fields of the policy to + modify. Only the fields in the mask will be modified. If no mask is + provided, the following default mask is used: `paths: "bindings, + etag"` + type: string + format: google-fieldmask + GoogleIamV1Policy: + id: GoogleIamV1Policy + description: >- + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. A `Policy` is a collection of + `bindings`. A `binding` binds one or more `members`, or principals, to a + single `role`. Principals can be user accounts, service accounts, Google + groups, and domains (such as G Suite). A `role` is a named list of + permissions; each `role` can be an IAM predefined role or a user-created + custom role. For some types of Google Cloud resources, a `binding` can + also specify a `condition`, which is a logical expression that allows + access to a resource only if the expression evaluates to `true`. A + condition can add constraints based on attributes of the request, the + resource, or both. To learn which resources support conditions in their + IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + **JSON example:** ``` { "bindings": [ { "role": + "roles/resourcemanager.organizationAdmin", "members": [ + "user:mike@example.com", "group:admins@example.com", + "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { + "role": "roles/resourcemanager.organizationViewer", "members": [ + "user:eve@example.com" ], "condition": { "title": "expirable access", + "description": "Does not grant access after Sep 2020", "expression": + "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": + "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - + members: - user:mike@example.com - group:admins@example.com - + domain:google.com - + serviceAccount:my-project-id@appspot.gserviceaccount.com role: + roles/resourcemanager.organizationAdmin - members: - + user:eve@example.com role: roles/resourcemanager.organizationViewer + condition: title: expirable access description: Does not grant access + after Sep 2020 expression: request.time < + timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` + For a description of IAM and its features, see the [IAM + documentation](https://cloud.google.com/iam/docs/). + type: object + properties: + 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). + type: integer + format: int32 + bindings: + description: >- + Associates a list of `members`, or principals, with a `role`. + Optionally, may specify a `condition` that determines how and when + the `bindings` are applied. Each of the `bindings` must contain at + least one principal. The `bindings` in a `Policy` can refer to up to + 1,500 principals; up to 250 of these principals can be Google + groups. Each occurrence of a principal counts towards these limits. + For example, if the `bindings` grant 50 different roles to + `user:alice@example.com`, and not to any other principal, then you + can add another 1,450 principals to the `bindings` in the `Policy`. + type: array + items: + $ref: '#/components/schemas/GoogleIamV1Binding' + auditConfigs: + description: Specifies cloud audit logging configuration for this policy. + type: array + items: + $ref: '#/components/schemas/GoogleIamV1AuditConfig' + 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. + type: string + format: byte + GoogleIamV1Binding: + id: GoogleIamV1Binding + description: Associates `members`, or principals, with a `role`. + type: object + properties: + role: + description: >- + Role that is assigned to the list of `members`, or principals. For + example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an + overview of the IAM roles and permissions, see the [IAM + documentation](https://cloud.google.com/iam/docs/roles-overview). + For a list of the available pre-defined roles, see + [here](https://cloud.google.com/iam/docs/understanding-roles). + type: string + members: + description: >- + Specifies the principals requesting access for a Google Cloud + 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. Does not include identities + that come from external identity providers (IdPs) through identity + federation. * `user:{emailid}`: An email address that represents a + specific Google account. For example, `alice@example.com` . * + `serviceAccount:{emailid}`: An email address that represents a + Google service account. For example, + `my-other-app@appspot.gserviceaccount.com`. * + `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: + An identifier for a [Kubernetes service + account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). + For example, + `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * + `group:{emailid}`: An email address that represents a Google group. + For example, `admins@example.com`. * `domain:{domain}`: The G Suite + domain (primary) that represents all the users of that domain. For + example, `google.com` or `example.com`. * + `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workforce identity pool. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: + All workforce identities in a group. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All workforce identities with a specific attribute value. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: + All identities in a workforce identity pool. * + `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workload identity pool. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: + A workload identity pool group. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All identities in a workload identity pool with a certain attribute. + * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: + All identities in a workload identity pool. * + `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. * + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + Deleted single identity in a workforce identity pool. For example, + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + type: array + items: + type: string + condition: + description: >- + The condition that is associated with this binding. If the condition + evaluates to `true`, then this binding applies to the current + request. If the condition evaluates to `false`, then this binding + does not apply to the current request. However, a different role + binding might grant the same role to one or more of the principals + in this binding. To learn which resources support conditions in + their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + $ref: '#/components/schemas/Expr' + Expr: + id: 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. + type: object + properties: + expression: + description: >- + Textual representation of an expression in Common Expression + Language syntax. + 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 + 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 + 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 + GoogleIamV1AuditConfig: + id: GoogleIamV1AuditConfig + 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. + type: object + properties: + 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 + auditLogConfigs: + description: The configuration for logging of each type of permission. + type: array + items: + $ref: '#/components/schemas/GoogleIamV1AuditLogConfig' + GoogleIamV1AuditLogConfig: + id: GoogleIamV1AuditLogConfig + 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. + type: object + properties: + logType: + description: The log type that this config enables. + type: string + enumDescriptions: + - Default case. Should never be this. + - 'Admin reads. Example: CloudIAM getIamPolicy' + - 'Data writes. Example: CloudSQL Users create' + - 'Data reads. Example: CloudSQL Users list' + enum: + - LOG_TYPE_UNSPECIFIED + - ADMIN_READ + - DATA_WRITE + - DATA_READ + exemptedMembers: + description: >- + Specifies the identities that do not cause logging for this type of + permission. Follows the same format of Binding.members. + type: array + items: + type: string + GoogleIamV1TestIamPermissionsRequest: + id: GoogleIamV1TestIamPermissionsRequest + description: Request message for `TestIamPermissions` method. + type: object + properties: + permissions: + description: >- + The set of permissions to check for the `resource`. Permissions with + wildcards (such as `*` or `storage.*`) are not allowed. For more + information see [IAM + Overview](https://cloud.google.com/iam/docs/overview#permissions). + type: array + items: + type: string + GoogleIamV1TestIamPermissionsResponse: + id: GoogleIamV1TestIamPermissionsResponse + description: Response message for `TestIamPermissions` method. + type: object + properties: + permissions: + description: >- + A subset of `TestPermissionsRequest.permissions` that the caller is + allowed. + type: array + items: + type: string + OperationMetadata: + id: OperationMetadata + description: Represents the metadata of the long-running operation. + type: object + properties: + createTime: + description: Output only. The time the operation was created. + readOnly: true + type: string + format: google-datetime + endTime: + description: Output only. The time the operation finished running. + readOnly: true + type: string + format: google-datetime + target: + description: >- + Output only. Server-defined resource path for the target of the + operation. + readOnly: true + type: string + verb: + description: Output only. Name of the verb executed by the operation. + readOnly: true + type: string + statusMessage: + description: Output only. Human-readable status of the operation, if any. + readOnly: true + type: string + requestedCancellation: + description: >- + Output only. Identifies whether the user has requested cancellation + of the operation. Operations that have successfully been cancelled + have Operation.error value with a google.rpc.Status.code of 1, + corresponding to `Code.CANCELLED`. + readOnly: true + type: boolean + apiVersion: + description: Output only. API version used to start the operation. + readOnly: true + type: string + parameters: + 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: + type: string + enum: + - json + - media + - proto + 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 + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + x-stackQL-resources: + locations: + id: google.networksecurity.locations + name: locations + title: Locations + methods: + projects_locations_list: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.locations + projects_locations_get: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/locations/methods/projects_locations_get + - $ref: >- + #/components/x-stackQL-resources/locations/methods/projects_locations_list + insert: [] + update: [] + replace: [] + delete: [] + operations: + id: google.networksecurity.operations + name: operations + title: Operations + methods: + projects_locations_operations_list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.operations + projects_locations_operations_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_operations_delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_operations_cancel: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_operations_list: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1operations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.operations + organizations_locations_operations_get: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_operations_delete: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1operations~1{operationsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_operations_cancel: + operation: + $ref: >- #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post response: mediaType: application/json @@ -2220,310 +4240,766 @@ components: sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_operations_get + #/components/x-stackQL-resources/operations/methods/projects_locations_operations_get + - $ref: >- + #/components/x-stackQL-resources/operations/methods/organizations_locations_operations_get + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_locations_operations_list + - $ref: >- + #/components/x-stackQL-resources/operations/methods/organizations_locations_operations_list + insert: [] + update: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_locations_operations_delete + - $ref: >- + #/components/x-stackQL-resources/operations/methods/organizations_locations_operations_delete + address_groups: + id: google.networksecurity.address_groups + name: address_groups + title: Address_groups + methods: + projects_locations_address_groups_list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1addressGroups/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.addressGroups + projects_locations_address_groups_create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1addressGroups/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_address_groups_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1addressGroups~1{addressGroupsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_address_groups_patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1addressGroups~1{addressGroupsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_address_groups_delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1addressGroups~1{addressGroupsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_address_groups_clone_items: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1addressGroups~1{addressGroupsId}:cloneItems/post + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_address_groups_list: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1addressGroups/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.addressGroups + organizations_locations_address_groups_create: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1addressGroups/post + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_address_groups_get: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1addressGroups~1{addressGroupsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_address_groups_patch: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1addressGroups~1{addressGroupsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_address_groups_delete: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1addressGroups~1{addressGroupsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_address_groups_clone_items: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1addressGroups~1{addressGroupsId}:cloneItems/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/address_groups/methods/projects_locations_address_groups_get + - $ref: >- + #/components/x-stackQL-resources/address_groups/methods/organizations_locations_address_groups_get + - $ref: >- + #/components/x-stackQL-resources/address_groups/methods/projects_locations_address_groups_list + - $ref: >- + #/components/x-stackQL-resources/address_groups/methods/organizations_locations_address_groups_list + insert: + - $ref: >- + #/components/x-stackQL-resources/address_groups/methods/projects_locations_address_groups_create + - $ref: >- + #/components/x-stackQL-resources/address_groups/methods/organizations_locations_address_groups_create + update: + - $ref: >- + #/components/x-stackQL-resources/address_groups/methods/projects_locations_address_groups_patch + - $ref: >- + #/components/x-stackQL-resources/address_groups/methods/organizations_locations_address_groups_patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/address_groups/methods/projects_locations_address_groups_delete + - $ref: >- + #/components/x-stackQL-resources/address_groups/methods/organizations_locations_address_groups_delete + address_groups_items: + id: google.networksecurity.address_groups_items + name: address_groups_items + title: Address_groups_items + methods: + projects_locations_address_groups_add_items: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1addressGroups~1{addressGroupsId}:addItems/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_address_groups_remove_items: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1addressGroups~1{addressGroupsId}:removeItems/post + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_address_groups_add_items: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1addressGroups~1{addressGroupsId}:addItems/post + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_address_groups_remove_items: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1addressGroups~1{addressGroupsId}:removeItems/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/address_groups_items/methods/projects_locations_address_groups_add_items + - $ref: >- + #/components/x-stackQL-resources/address_groups_items/methods/organizations_locations_address_groups_add_items + update: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/address_groups_items/methods/projects_locations_address_groups_remove_items + - $ref: >- + #/components/x-stackQL-resources/address_groups_items/methods/organizations_locations_address_groups_remove_items + address_groups_references: + id: google.networksecurity.address_groups_references + name: address_groups_references + title: Address_groups_references + methods: + projects_locations_address_groups_list_references: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1addressGroups~1{addressGroupsId}:listReferences/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.addressGroupReferences + organizations_locations_address_groups_list_references: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1addressGroups~1{addressGroupsId}:listReferences/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.addressGroupReferences + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/address_groups_references/methods/projects_locations_address_groups_list_references + - $ref: >- + #/components/x-stackQL-resources/address_groups_references/methods/organizations_locations_address_groups_list_references + insert: [] + update: [] + replace: [] + delete: [] + address_groups_iam_policies: + id: google.networksecurity.address_groups_iam_policies + name: address_groups_iam_policies + title: Address_groups_iam_policies + methods: + projects_locations_address_groups_set_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1addressGroups~1{addressGroupsId}:setIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_address_groups_get_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1addressGroups~1{addressGroupsId}:getIamPolicy/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.bindings + projects_locations_address_groups_test_iam_permissions: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1addressGroups~1{addressGroupsId}:testIamPermissions/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/address_groups_iam_policies/methods/projects_locations_address_groups_get_iam_policy + insert: [] + update: [] + replace: - $ref: >- - #/components/x-stackQL-resources/operations/methods/organizations_locations_operations_get + #/components/x-stackQL-resources/address_groups_iam_policies/methods/projects_locations_address_groups_set_iam_policy + delete: [] + firewall_endpoint_associations: + id: google.networksecurity.firewall_endpoint_associations + name: firewall_endpoint_associations + title: Firewall_endpoint_associations + methods: + projects_locations_firewall_endpoint_associations_list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1firewallEndpointAssociations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.firewallEndpointAssociations + projects_locations_firewall_endpoint_associations_create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1firewallEndpointAssociations/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_firewall_endpoint_associations_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1firewallEndpointAssociations~1{firewallEndpointAssociationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_firewall_endpoint_associations_delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1firewallEndpointAssociations~1{firewallEndpointAssociationsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_firewall_endpoint_associations_patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1firewallEndpointAssociations~1{firewallEndpointAssociationsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_operations_list + #/components/x-stackQL-resources/firewall_endpoint_associations/methods/projects_locations_firewall_endpoint_associations_get - $ref: >- - #/components/x-stackQL-resources/operations/methods/organizations_locations_operations_list - insert: [] - update: [] + #/components/x-stackQL-resources/firewall_endpoint_associations/methods/projects_locations_firewall_endpoint_associations_list + insert: + - $ref: >- + #/components/x-stackQL-resources/firewall_endpoint_associations/methods/projects_locations_firewall_endpoint_associations_create + update: + - $ref: >- + #/components/x-stackQL-resources/firewall_endpoint_associations/methods/projects_locations_firewall_endpoint_associations_patch replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_operations_delete - - $ref: >- - #/components/x-stackQL-resources/operations/methods/organizations_locations_operations_delete - address_groups: - id: google.networksecurity.address_groups - name: address_groups - title: Address_groups + #/components/x-stackQL-resources/firewall_endpoint_associations/methods/projects_locations_firewall_endpoint_associations_delete + intercept_endpoint_groups: + id: google.networksecurity.intercept_endpoint_groups + name: intercept_endpoint_groups + title: Intercept_endpoint_groups methods: - projects_locations_address_groups_list: + projects_locations_intercept_endpoint_groups_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1addressGroups/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1interceptEndpointGroups/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.addressGroups - projects_locations_address_groups_create: + objectKey: $.interceptEndpointGroups + projects_locations_intercept_endpoint_groups_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1addressGroups/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1interceptEndpointGroups/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_address_groups_get: + projects_locations_intercept_endpoint_groups_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1addressGroups~1{addressGroupsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1interceptEndpointGroups~1{interceptEndpointGroupsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_address_groups_patch: + projects_locations_intercept_endpoint_groups_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1addressGroups~1{addressGroupsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1interceptEndpointGroups~1{interceptEndpointGroupsId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_address_groups_delete: + projects_locations_intercept_endpoint_groups_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1addressGroups~1{addressGroupsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1interceptEndpointGroups~1{interceptEndpointGroupsId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_address_groups_clone_items: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/intercept_endpoint_groups/methods/projects_locations_intercept_endpoint_groups_get + - $ref: >- + #/components/x-stackQL-resources/intercept_endpoint_groups/methods/projects_locations_intercept_endpoint_groups_list + insert: + - $ref: >- + #/components/x-stackQL-resources/intercept_endpoint_groups/methods/projects_locations_intercept_endpoint_groups_create + update: + - $ref: >- + #/components/x-stackQL-resources/intercept_endpoint_groups/methods/projects_locations_intercept_endpoint_groups_patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/intercept_endpoint_groups/methods/projects_locations_intercept_endpoint_groups_delete + intercept_endpoint_group_associations: + id: google.networksecurity.intercept_endpoint_group_associations + name: intercept_endpoint_group_associations + title: Intercept_endpoint_group_associations + methods: + projects_locations_intercept_endpoint_group_associations_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1addressGroups~1{addressGroupsId}:cloneItems/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1interceptEndpointGroupAssociations/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_address_groups_list: + objectKey: $.interceptEndpointGroupAssociations + projects_locations_intercept_endpoint_group_associations_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1addressGroups/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1interceptEndpointGroupAssociations/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.addressGroups - organizations_locations_address_groups_create: + projects_locations_intercept_endpoint_group_associations_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1addressGroups/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1interceptEndpointGroupAssociations~1{interceptEndpointGroupAssociationsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_address_groups_get: + projects_locations_intercept_endpoint_group_associations_patch: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1addressGroups~1{addressGroupsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1interceptEndpointGroupAssociations~1{interceptEndpointGroupAssociationsId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_address_groups_patch: + projects_locations_intercept_endpoint_group_associations_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1addressGroups~1{addressGroupsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1interceptEndpointGroupAssociations~1{interceptEndpointGroupAssociationsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_address_groups_delete: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/intercept_endpoint_group_associations/methods/projects_locations_intercept_endpoint_group_associations_get + - $ref: >- + #/components/x-stackQL-resources/intercept_endpoint_group_associations/methods/projects_locations_intercept_endpoint_group_associations_list + insert: + - $ref: >- + #/components/x-stackQL-resources/intercept_endpoint_group_associations/methods/projects_locations_intercept_endpoint_group_associations_create + update: + - $ref: >- + #/components/x-stackQL-resources/intercept_endpoint_group_associations/methods/projects_locations_intercept_endpoint_group_associations_patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/intercept_endpoint_group_associations/methods/projects_locations_intercept_endpoint_group_associations_delete + intercept_deployment_groups: + id: google.networksecurity.intercept_deployment_groups + name: intercept_deployment_groups + title: Intercept_deployment_groups + methods: + projects_locations_intercept_deployment_groups_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1addressGroups~1{addressGroupsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1interceptDeploymentGroups/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_address_groups_clone_items: + objectKey: $.interceptDeploymentGroups + projects_locations_intercept_deployment_groups_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1addressGroups~1{addressGroupsId}:cloneItems/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1interceptDeploymentGroups/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_intercept_deployment_groups_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1interceptDeploymentGroups~1{interceptDeploymentGroupsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_intercept_deployment_groups_patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1interceptDeploymentGroups~1{interceptDeploymentGroupsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_intercept_deployment_groups_delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1interceptDeploymentGroups~1{interceptDeploymentGroupsId}/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/address_groups/methods/projects_locations_address_groups_get + #/components/x-stackQL-resources/intercept_deployment_groups/methods/projects_locations_intercept_deployment_groups_get - $ref: >- - #/components/x-stackQL-resources/address_groups/methods/organizations_locations_address_groups_get + #/components/x-stackQL-resources/intercept_deployment_groups/methods/projects_locations_intercept_deployment_groups_list + insert: - $ref: >- - #/components/x-stackQL-resources/address_groups/methods/projects_locations_address_groups_list + #/components/x-stackQL-resources/intercept_deployment_groups/methods/projects_locations_intercept_deployment_groups_create + update: - $ref: >- - #/components/x-stackQL-resources/address_groups/methods/organizations_locations_address_groups_list - insert: + #/components/x-stackQL-resources/intercept_deployment_groups/methods/projects_locations_intercept_deployment_groups_patch + replace: [] + delete: - $ref: >- - #/components/x-stackQL-resources/address_groups/methods/projects_locations_address_groups_create + #/components/x-stackQL-resources/intercept_deployment_groups/methods/projects_locations_intercept_deployment_groups_delete + intercept_deployments: + id: google.networksecurity.intercept_deployments + name: intercept_deployments + title: Intercept_deployments + methods: + projects_locations_intercept_deployments_list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1interceptDeployments/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.interceptDeployments + projects_locations_intercept_deployments_create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1interceptDeployments/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_intercept_deployments_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1interceptDeployments~1{interceptDeploymentsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_intercept_deployments_patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1interceptDeployments~1{interceptDeploymentsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_intercept_deployments_delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1interceptDeployments~1{interceptDeploymentsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: - $ref: >- - #/components/x-stackQL-resources/address_groups/methods/organizations_locations_address_groups_create - update: + #/components/x-stackQL-resources/intercept_deployments/methods/projects_locations_intercept_deployments_get - $ref: >- - #/components/x-stackQL-resources/address_groups/methods/projects_locations_address_groups_patch + #/components/x-stackQL-resources/intercept_deployments/methods/projects_locations_intercept_deployments_list + insert: - $ref: >- - #/components/x-stackQL-resources/address_groups/methods/organizations_locations_address_groups_patch + #/components/x-stackQL-resources/intercept_deployments/methods/projects_locations_intercept_deployments_create + update: + - $ref: >- + #/components/x-stackQL-resources/intercept_deployments/methods/projects_locations_intercept_deployments_patch replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/address_groups/methods/projects_locations_address_groups_delete - - $ref: >- - #/components/x-stackQL-resources/address_groups/methods/organizations_locations_address_groups_delete - address_groups_items: - id: google.networksecurity.address_groups_items - name: address_groups_items - title: Address_groups_items + #/components/x-stackQL-resources/intercept_deployments/methods/projects_locations_intercept_deployments_delete + mirroring_endpoint_groups: + id: google.networksecurity.mirroring_endpoint_groups + name: mirroring_endpoint_groups + title: Mirroring_endpoint_groups methods: - projects_locations_address_groups_add_items: + projects_locations_mirroring_endpoint_groups_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1addressGroups~1{addressGroupsId}:addItems/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1mirroringEndpointGroups/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_address_groups_remove_items: + objectKey: $.mirroringEndpointGroups + projects_locations_mirroring_endpoint_groups_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1addressGroups~1{addressGroupsId}:removeItems/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1mirroringEndpointGroups/post response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_address_groups_add_items: + projects_locations_mirroring_endpoint_groups_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1addressGroups~1{addressGroupsId}:addItems/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1mirroringEndpointGroups~1{mirroringEndpointGroupsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_address_groups_remove_items: + projects_locations_mirroring_endpoint_groups_patch: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1addressGroups~1{addressGroupsId}:removeItems/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1mirroringEndpointGroups~1{mirroringEndpointGroupsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_mirroring_endpoint_groups_delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1mirroringEndpointGroups~1{mirroringEndpointGroupsId}/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/mirroring_endpoint_groups/methods/projects_locations_mirroring_endpoint_groups_get + - $ref: >- + #/components/x-stackQL-resources/mirroring_endpoint_groups/methods/projects_locations_mirroring_endpoint_groups_list insert: - $ref: >- - #/components/x-stackQL-resources/address_groups_items/methods/projects_locations_address_groups_add_items + #/components/x-stackQL-resources/mirroring_endpoint_groups/methods/projects_locations_mirroring_endpoint_groups_create + update: - $ref: >- - #/components/x-stackQL-resources/address_groups_items/methods/organizations_locations_address_groups_add_items - update: [] + #/components/x-stackQL-resources/mirroring_endpoint_groups/methods/projects_locations_mirroring_endpoint_groups_patch replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/address_groups_items/methods/projects_locations_address_groups_remove_items - - $ref: >- - #/components/x-stackQL-resources/address_groups_items/methods/organizations_locations_address_groups_remove_items - address_groups_references: - id: google.networksecurity.address_groups_references - name: address_groups_references - title: Address_groups_references + #/components/x-stackQL-resources/mirroring_endpoint_groups/methods/projects_locations_mirroring_endpoint_groups_delete + mirroring_endpoint_group_associations: + id: google.networksecurity.mirroring_endpoint_group_associations + name: mirroring_endpoint_group_associations + title: Mirroring_endpoint_group_associations methods: - projects_locations_address_groups_list_references: + projects_locations_mirroring_endpoint_group_associations_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1addressGroups~1{addressGroupsId}:listReferences/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1mirroringEndpointGroupAssociations/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.addressGroupReferences - organizations_locations_address_groups_list_references: + objectKey: $.mirroringEndpointGroupAssociations + projects_locations_mirroring_endpoint_group_associations_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1addressGroups~1{addressGroupsId}:listReferences/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1mirroringEndpointGroupAssociations/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_mirroring_endpoint_group_associations_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1mirroringEndpointGroupAssociations~1{mirroringEndpointGroupAssociationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_mirroring_endpoint_group_associations_patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1mirroringEndpointGroupAssociations~1{mirroringEndpointGroupAssociationsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_mirroring_endpoint_group_associations_delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1mirroringEndpointGroupAssociations~1{mirroringEndpointGroupAssociationsId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.addressGroupReferences sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/address_groups_references/methods/projects_locations_address_groups_list_references + #/components/x-stackQL-resources/mirroring_endpoint_group_associations/methods/projects_locations_mirroring_endpoint_group_associations_get - $ref: >- - #/components/x-stackQL-resources/address_groups_references/methods/organizations_locations_address_groups_list_references - insert: [] - update: [] + #/components/x-stackQL-resources/mirroring_endpoint_group_associations/methods/projects_locations_mirroring_endpoint_group_associations_list + insert: + - $ref: >- + #/components/x-stackQL-resources/mirroring_endpoint_group_associations/methods/projects_locations_mirroring_endpoint_group_associations_create + update: + - $ref: >- + #/components/x-stackQL-resources/mirroring_endpoint_group_associations/methods/projects_locations_mirroring_endpoint_group_associations_patch replace: [] - delete: [] - address_groups_iam_policies: - id: google.networksecurity.address_groups_iam_policies - name: address_groups_iam_policies - title: Address_groups_iam_policies + delete: + - $ref: >- + #/components/x-stackQL-resources/mirroring_endpoint_group_associations/methods/projects_locations_mirroring_endpoint_group_associations_delete + mirroring_deployment_groups: + id: google.networksecurity.mirroring_deployment_groups + name: mirroring_deployment_groups + title: Mirroring_deployment_groups methods: - projects_locations_address_groups_set_iam_policy: + projects_locations_mirroring_deployment_groups_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1addressGroups~1{addressGroupsId}:setIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1mirroringDeploymentGroups/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_address_groups_get_iam_policy: + objectKey: $.mirroringDeploymentGroups + projects_locations_mirroring_deployment_groups_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1addressGroups~1{addressGroupsId}:getIamPolicy/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1mirroringDeploymentGroups/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.bindings - projects_locations_address_groups_test_iam_permissions: + projects_locations_mirroring_deployment_groups_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1addressGroups~1{addressGroupsId}:testIamPermissions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1mirroringDeploymentGroups~1{mirroringDeploymentGroupsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_mirroring_deployment_groups_patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1mirroringDeploymentGroups~1{mirroringDeploymentGroupsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_mirroring_deployment_groups_delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1mirroringDeploymentGroups~1{mirroringDeploymentGroupsId}/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/address_groups_iam_policies/methods/projects_locations_address_groups_get_iam_policy - insert: [] - update: [] - replace: + #/components/x-stackQL-resources/mirroring_deployment_groups/methods/projects_locations_mirroring_deployment_groups_get - $ref: >- - #/components/x-stackQL-resources/address_groups_iam_policies/methods/projects_locations_address_groups_set_iam_policy - delete: [] - firewall_endpoint_associations: - id: google.networksecurity.firewall_endpoint_associations - name: firewall_endpoint_associations - title: Firewall_endpoint_associations + #/components/x-stackQL-resources/mirroring_deployment_groups/methods/projects_locations_mirroring_deployment_groups_list + insert: + - $ref: >- + #/components/x-stackQL-resources/mirroring_deployment_groups/methods/projects_locations_mirroring_deployment_groups_create + update: + - $ref: >- + #/components/x-stackQL-resources/mirroring_deployment_groups/methods/projects_locations_mirroring_deployment_groups_patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/mirroring_deployment_groups/methods/projects_locations_mirroring_deployment_groups_delete + mirroring_deployments: + id: google.networksecurity.mirroring_deployments + name: mirroring_deployments + title: Mirroring_deployments methods: - projects_locations_firewall_endpoint_associations_list: + projects_locations_mirroring_deployments_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1firewallEndpointAssociations/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1mirroringDeployments/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.firewallEndpointAssociations - projects_locations_firewall_endpoint_associations_create: + objectKey: $.mirroringDeployments + projects_locations_mirroring_deployments_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1firewallEndpointAssociations/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1mirroringDeployments/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_firewall_endpoint_associations_get: + projects_locations_mirroring_deployments_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1firewallEndpointAssociations~1{firewallEndpointAssociationsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1mirroringDeployments~1{mirroringDeploymentsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_firewall_endpoint_associations_delete: + projects_locations_mirroring_deployments_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1firewallEndpointAssociations~1{firewallEndpointAssociationsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1mirroringDeployments~1{mirroringDeploymentsId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_firewall_endpoint_associations_patch: + projects_locations_mirroring_deployments_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1firewallEndpointAssociations~1{firewallEndpointAssociationsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1mirroringDeployments~1{mirroringDeploymentsId}/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/firewall_endpoint_associations/methods/projects_locations_firewall_endpoint_associations_get + #/components/x-stackQL-resources/mirroring_deployments/methods/projects_locations_mirroring_deployments_get - $ref: >- - #/components/x-stackQL-resources/firewall_endpoint_associations/methods/projects_locations_firewall_endpoint_associations_list + #/components/x-stackQL-resources/mirroring_deployments/methods/projects_locations_mirroring_deployments_list insert: - $ref: >- - #/components/x-stackQL-resources/firewall_endpoint_associations/methods/projects_locations_firewall_endpoint_associations_create + #/components/x-stackQL-resources/mirroring_deployments/methods/projects_locations_mirroring_deployments_create update: - $ref: >- - #/components/x-stackQL-resources/firewall_endpoint_associations/methods/projects_locations_firewall_endpoint_associations_patch + #/components/x-stackQL-resources/mirroring_deployments/methods/projects_locations_mirroring_deployments_patch replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/firewall_endpoint_associations/methods/projects_locations_firewall_endpoint_associations_delete + #/components/x-stackQL-resources/mirroring_deployments/methods/projects_locations_mirroring_deployments_delete authorization_policies: id: google.networksecurity.authorization_policies name: authorization_policies @@ -2618,6 +5094,63 @@ components: - $ref: >- #/components/x-stackQL-resources/authorization_policies_iam_policies/methods/projects_locations_authorization_policies_set_iam_policy delete: [] + backend_authentication_configs: + id: google.networksecurity.backend_authentication_configs + name: backend_authentication_configs + title: Backend_authentication_configs + methods: + projects_locations_backend_authentication_configs_list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backendAuthenticationConfigs/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.backendAuthenticationConfigs + projects_locations_backend_authentication_configs_create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backendAuthenticationConfigs/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_backend_authentication_configs_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backendAuthenticationConfigs~1{backendAuthenticationConfigsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_backend_authentication_configs_patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backendAuthenticationConfigs~1{backendAuthenticationConfigsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_backend_authentication_configs_delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backendAuthenticationConfigs~1{backendAuthenticationConfigsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/backend_authentication_configs/methods/projects_locations_backend_authentication_configs_get + - $ref: >- + #/components/x-stackQL-resources/backend_authentication_configs/methods/projects_locations_backend_authentication_configs_list + insert: + - $ref: >- + #/components/x-stackQL-resources/backend_authentication_configs/methods/projects_locations_backend_authentication_configs_create + update: + - $ref: >- + #/components/x-stackQL-resources/backend_authentication_configs/methods/projects_locations_backend_authentication_configs_patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/backend_authentication_configs/methods/projects_locations_backend_authentication_configs_delete server_tls_policies: id: google.networksecurity.server_tls_policies name: server_tls_policies @@ -3034,6 +5567,63 @@ components: delete: - $ref: >- #/components/x-stackQL-resources/tls_inspection_policies/methods/projects_locations_tls_inspection_policies_delete + authz_policies: + id: google.networksecurity.authz_policies + name: authz_policies + title: Authz_policies + methods: + projects_locations_authz_policies_list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authzPolicies/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.authzPolicies + projects_locations_authz_policies_create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authzPolicies/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_authz_policies_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authzPolicies~1{authzPoliciesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_authz_policies_patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authzPolicies~1{authzPoliciesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_authz_policies_delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authzPolicies~1{authzPoliciesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/authz_policies/methods/projects_locations_authz_policies_get + - $ref: >- + #/components/x-stackQL-resources/authz_policies/methods/projects_locations_authz_policies_list + insert: + - $ref: >- + #/components/x-stackQL-resources/authz_policies/methods/projects_locations_authz_policies_create + update: + - $ref: >- + #/components/x-stackQL-resources/authz_policies/methods/projects_locations_authz_policies_patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/authz_policies/methods/projects_locations_authz_policies_delete authz_policies_iam_policies: id: google.networksecurity.authz_policies_iam_policies name: authz_policies_iam_policies @@ -3257,8 +5847,1771 @@ paths: - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/_.xgafv' get: - description: Lists information about the supported locations for this service. - operationId: networksecurity.projects.locations.list + description: Lists information about the supported locations for this service. + operationId: networksecurity.projects.locations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListLocationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: extraLocationTypes + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}: + parameters: *ref_1 + get: + description: Gets information about a location. + operationId: networksecurity.projects.locations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Location' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: networksecurity.projects.locations.operations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListOperationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: networksecurity.projects.locations.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + delete: + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: networksecurity.projects.locations.operations.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + `1`, corresponding to `Code.CANCELLED`. + operationId: networksecurity.projects.locations.operations.cancel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CancelOperationRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/addressGroups: + parameters: *ref_1 + get: + description: Lists address groups in a given project and location. + operationId: networksecurity.projects.locations.addressGroups.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListAddressGroupsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean + post: + description: Creates a new address group in a given project and location. + operationId: networksecurity.projects.locations.addressGroups.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddressGroup' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: addressGroupId + schema: + type: string + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/addressGroups/{addressGroupsId}: + parameters: *ref_1 + get: + description: Gets details of a single address group. + operationId: networksecurity.projects.locations.addressGroups.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/AddressGroup' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: addressGroupsId + required: true + schema: + type: string + patch: + description: Updates the parameters of a single address group. + operationId: networksecurity.projects.locations.addressGroups.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddressGroup' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: addressGroupsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: requestId + schema: + type: string + delete: + description: Deletes a single address group. + operationId: networksecurity.projects.locations.addressGroups.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: addressGroupsId + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/addressGroups/{addressGroupsId}:addItems: + parameters: *ref_1 + post: + description: Adds items to an address group. + operationId: networksecurity.projects.locations.addressGroups.addItems + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddAddressGroupItemsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: addressGroupsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/addressGroups/{addressGroupsId}:removeItems: + parameters: *ref_1 + post: + description: Removes items from an address group. + operationId: networksecurity.projects.locations.addressGroups.removeItems + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RemoveAddressGroupItemsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: addressGroupsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/addressGroups/{addressGroupsId}:cloneItems: + parameters: *ref_1 + post: + description: Clones items from one address group to another. + operationId: networksecurity.projects.locations.addressGroups.cloneItems + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CloneAddressGroupItemsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: addressGroupsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/addressGroups/{addressGroupsId}:listReferences: + parameters: *ref_1 + get: + description: Lists references of an address group. + operationId: networksecurity.projects.locations.addressGroups.listReferences + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListAddressGroupReferencesResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: addressGroupsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/addressGroups/{addressGroupsId}:setIamPolicy: + parameters: *ref_1 + post: + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and + `PERMISSION_DENIED` errors. + operationId: networksecurity.projects.locations.addressGroups.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: addressGroupsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/addressGroups/{addressGroupsId}:getIamPolicy: + parameters: *ref_1 + get: + description: >- + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: networksecurity.projects.locations.addressGroups.getIamPolicy + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: addressGroupsId + required: true + schema: + type: string + - in: query + name: options.requestedPolicyVersion + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/addressGroups/{addressGroupsId}:testIamPermissions: + parameters: *ref_1 + post: + description: >- + Returns permissions that a caller has on the specified resource. If the + resource does not exist, this will return an empty set of permissions, + not a `NOT_FOUND` error. Note: This operation is designed to be used for + building permission-aware UIs and command-line tools, not for + authorization checking. This operation may "fail open" without warning. + operationId: networksecurity.projects.locations.addressGroups.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: addressGroupsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/firewallEndpointAssociations: + parameters: *ref_1 + get: + description: Lists Associations in a given project and location. + operationId: networksecurity.projects.locations.firewallEndpointAssociations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListFirewallEndpointAssociationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + post: + description: >- + Creates a new FirewallEndpointAssociation in a given project and + location. + operationId: networksecurity.projects.locations.firewallEndpointAssociations.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FirewallEndpointAssociation' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: firewallEndpointAssociationId + schema: + type: string + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/firewallEndpointAssociations/{firewallEndpointAssociationsId}: + parameters: *ref_1 + get: + description: Gets details of a single FirewallEndpointAssociation. + operationId: networksecurity.projects.locations.firewallEndpointAssociations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/FirewallEndpointAssociation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: firewallEndpointAssociationsId + required: true + schema: + type: string + delete: + description: Deletes a single FirewallEndpointAssociation. + operationId: networksecurity.projects.locations.firewallEndpointAssociations.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: firewallEndpointAssociationsId + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + patch: + description: Update a single FirewallEndpointAssociation. + operationId: networksecurity.projects.locations.firewallEndpointAssociations.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FirewallEndpointAssociation' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: firewallEndpointAssociationsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/interceptEndpointGroups: + parameters: *ref_1 + get: + description: >- + Lists endpoint groups in a given project and location. See + https://google.aip.dev/132. + operationId: networksecurity.projects.locations.interceptEndpointGroups.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListInterceptEndpointGroupsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + post: + description: >- + Creates an endpoint group in a given project and location. See + https://google.aip.dev/133. + operationId: networksecurity.projects.locations.interceptEndpointGroups.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InterceptEndpointGroup' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: interceptEndpointGroupId + schema: + type: string + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/interceptEndpointGroups/{interceptEndpointGroupsId}: + parameters: *ref_1 + get: + description: Gets a specific endpoint group. See https://google.aip.dev/131. + operationId: networksecurity.projects.locations.interceptEndpointGroups.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/InterceptEndpointGroup' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: interceptEndpointGroupsId + required: true + schema: + type: string + patch: + description: Updates an endpoint group. See https://google.aip.dev/134. + operationId: networksecurity.projects.locations.interceptEndpointGroups.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InterceptEndpointGroup' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: interceptEndpointGroupsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: requestId + schema: + type: string + delete: + description: Deletes an endpoint group. See https://google.aip.dev/135. + operationId: networksecurity.projects.locations.interceptEndpointGroups.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: interceptEndpointGroupsId + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/interceptEndpointGroupAssociations: + parameters: *ref_1 + get: + description: >- + Lists associations in a given project and location. See + https://google.aip.dev/132. + operationId: >- + networksecurity.projects.locations.interceptEndpointGroupAssociations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/ListInterceptEndpointGroupAssociationsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + post: + description: >- + Creates an association in a given project and location. See + https://google.aip.dev/133. + operationId: >- + networksecurity.projects.locations.interceptEndpointGroupAssociations.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InterceptEndpointGroupAssociation' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: interceptEndpointGroupAssociationId + schema: + type: string + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/interceptEndpointGroupAssociations/{interceptEndpointGroupAssociationsId}: + parameters: *ref_1 + get: + description: Gets a specific association. See https://google.aip.dev/131. + operationId: >- + networksecurity.projects.locations.interceptEndpointGroupAssociations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/InterceptEndpointGroupAssociation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: interceptEndpointGroupAssociationsId + required: true + schema: + type: string + patch: + description: Updates an association. See https://google.aip.dev/134. + operationId: >- + networksecurity.projects.locations.interceptEndpointGroupAssociations.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InterceptEndpointGroupAssociation' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: interceptEndpointGroupAssociationsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: requestId + schema: + type: string + delete: + description: Deletes an association. See https://google.aip.dev/135. + operationId: >- + networksecurity.projects.locations.interceptEndpointGroupAssociations.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: interceptEndpointGroupAssociationsId + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/interceptDeploymentGroups: + parameters: *ref_1 + get: + description: >- + Lists deployment groups in a given project and location. See + https://google.aip.dev/132. + operationId: networksecurity.projects.locations.interceptDeploymentGroups.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListInterceptDeploymentGroupsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + post: + description: >- + Creates a deployment group in a given project and location. See + https://google.aip.dev/133. + operationId: networksecurity.projects.locations.interceptDeploymentGroups.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InterceptDeploymentGroup' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: interceptDeploymentGroupId + schema: + type: string + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/interceptDeploymentGroups/{interceptDeploymentGroupsId}: + parameters: *ref_1 + get: + description: Gets a specific deployment group. See https://google.aip.dev/131. + operationId: networksecurity.projects.locations.interceptDeploymentGroups.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/InterceptDeploymentGroup' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: interceptDeploymentGroupsId + required: true + schema: + type: string + patch: + description: Updates a deployment group. See https://google.aip.dev/134. + operationId: networksecurity.projects.locations.interceptDeploymentGroups.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InterceptDeploymentGroup' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: interceptDeploymentGroupsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: requestId + schema: + type: string + delete: + description: Deletes a deployment group. See https://google.aip.dev/135. + operationId: networksecurity.projects.locations.interceptDeploymentGroups.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: interceptDeploymentGroupsId + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/interceptDeployments: + parameters: *ref_1 + get: + description: >- + Lists deployments in a given project and location. See + https://google.aip.dev/132. + operationId: networksecurity.projects.locations.interceptDeployments.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListInterceptDeploymentsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + post: + description: >- + Creates a deployment in a given project and location. See + https://google.aip.dev/133. + operationId: networksecurity.projects.locations.interceptDeployments.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InterceptDeployment' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: interceptDeploymentId + schema: + type: string + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/interceptDeployments/{interceptDeploymentsId}: + parameters: *ref_1 + get: + description: Gets a specific deployment. See https://google.aip.dev/131. + operationId: networksecurity.projects.locations.interceptDeployments.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/InterceptDeployment' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: interceptDeploymentsId + required: true + schema: + type: string + patch: + description: Updates a deployment. See https://google.aip.dev/134. + operationId: networksecurity.projects.locations.interceptDeployments.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InterceptDeployment' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: interceptDeploymentsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: requestId + schema: + type: string + delete: + description: Deletes a deployment. See https://google.aip.dev/135. + operationId: networksecurity.projects.locations.interceptDeployments.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: interceptDeploymentsId + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroups: + parameters: *ref_1 + get: + description: >- + Lists endpoint groups in a given project and location. See + https://google.aip.dev/132. + operationId: networksecurity.projects.locations.mirroringEndpointGroups.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListMirroringEndpointGroupsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + post: + description: >- + Creates an endpoint group in a given project and location. See + https://google.aip.dev/133. + operationId: networksecurity.projects.locations.mirroringEndpointGroups.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MirroringEndpointGroup' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3270,31 +7623,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListLocationsResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId required: true schema: type: string - - in: query - name: filter + - in: path + name: locationsId + required: true schema: type: string - in: query - name: pageSize + name: mirroringEndpointGroupId schema: - type: integer - format: int32 + type: string - in: query - name: pageToken + name: requestId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroups/{mirroringEndpointGroupsId}: parameters: *ref_1 get: - description: Gets information about a location. - operationId: networksecurity.projects.locations.get + description: Gets a specific endpoint group. See https://google.aip.dev/131. + operationId: networksecurity.projects.locations.mirroringEndpointGroups.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3306,7 +7659,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Location' + $ref: '#/components/schemas/MirroringEndpointGroup' parameters: - in: path name: projectsId @@ -3318,13 +7671,19 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_1 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: networksecurity.projects.locations.operations.list + - in: path + name: mirroringEndpointGroupsId + required: true + schema: + type: string + patch: + description: Updates an endpoint group. See https://google.aip.dev/134. + operationId: networksecurity.projects.locations.mirroringEndpointGroups.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MirroringEndpointGroup' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3336,7 +7695,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListOperationsResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -3348,27 +7707,23 @@ paths: required: true schema: type: string - - in: query - name: filter + - in: path + name: mirroringEndpointGroupsId + required: true schema: type: string - in: query - name: pageSize + name: updateMask schema: - type: integer - format: int32 + type: string + format: google-fieldmask - in: query - name: pageToken + name: requestId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_1 - get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: networksecurity.projects.locations.operations.get + delete: + description: Deletes an endpoint group. See https://google.aip.dev/135. + operationId: networksecurity.projects.locations.mirroringEndpointGroups.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3393,17 +7748,22 @@ paths: schema: type: string - in: path - name: operationsId + name: mirroringEndpointGroupsId required: true schema: type: string - delete: + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroupAssociations: + parameters: *ref_1 + get: description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: networksecurity.projects.locations.operations.delete + Lists associations in a given project and location. See + https://google.aip.dev/132. + operationId: >- + networksecurity.projects.locations.mirroringEndpointGroupAssociations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3415,7 +7775,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: >- + #/components/schemas/ListMirroringEndpointGroupAssociationsResponse parameters: - in: path name: projectsId @@ -3427,30 +7788,34 @@ paths: required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_1 post: description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: networksecurity.projects.locations.operations.cancel + Creates an association in a given project and location. See + https://google.aip.dev/133. + operationId: >- + networksecurity.projects.locations.mirroringEndpointGroupAssociations.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/CancelOperationRequest' + $ref: '#/components/schemas/MirroringEndpointGroupAssociation' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3462,7 +7827,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -3474,16 +7839,20 @@ paths: required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: mirroringEndpointGroupAssociationId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/addressGroups: + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroupAssociations/{mirroringEndpointGroupAssociationsId}: parameters: *ref_1 get: - description: Lists address groups in a given project and location. - operationId: networksecurity.projects.locations.addressGroups.list + description: Gets a specific association. See https://google.aip.dev/131. + operationId: >- + networksecurity.projects.locations.mirroringEndpointGroupAssociations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3495,7 +7864,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListAddressGroupsResponse' + $ref: '#/components/schemas/MirroringEndpointGroupAssociation' parameters: - in: path name: projectsId @@ -3507,23 +7876,20 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: mirroringEndpointGroupAssociationsId + required: true schema: type: string - post: - description: Creates a new address group in a given project and location. - operationId: networksecurity.projects.locations.addressGroups.create + patch: + description: Updates an association. See https://google.aip.dev/134. + operationId: >- + networksecurity.projects.locations.mirroringEndpointGroupAssociations.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/AddressGroup' + $ref: '#/components/schemas/MirroringEndpointGroupAssociation' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3547,19 +7913,24 @@ paths: required: true schema: type: string + - in: path + name: mirroringEndpointGroupAssociationsId + required: true + schema: + type: string - in: query - name: addressGroupId + name: updateMask schema: type: string + format: google-fieldmask - in: query name: requestId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/addressGroups/{addressGroupsId}: - parameters: *ref_1 - get: - description: Gets details of a single address group. - operationId: networksecurity.projects.locations.addressGroups.get + delete: + description: Deletes an association. See https://google.aip.dev/135. + operationId: >- + networksecurity.projects.locations.mirroringEndpointGroupAssociations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3571,7 +7942,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AddressGroup' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -3584,18 +7955,21 @@ paths: schema: type: string - in: path - name: addressGroupsId + name: mirroringEndpointGroupAssociationsId required: true schema: type: string - patch: - description: Updates the parameters of a single address group. - operationId: networksecurity.projects.locations.addressGroups.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AddressGroup' + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/mirroringDeploymentGroups: + parameters: *ref_1 + get: + description: >- + Lists deployment groups in a given project and location. See + https://google.aip.dev/132. + operationId: networksecurity.projects.locations.mirroringDeploymentGroups.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3607,7 +7981,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/ListMirroringDeploymentGroupsResponse' parameters: - in: path name: projectsId @@ -3619,23 +7993,33 @@ paths: required: true schema: type: string - - in: path - name: addressGroupsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - in: query - name: updateMask + name: filter schema: type: string - format: google-fieldmask - in: query - name: requestId + name: orderBy schema: type: string - delete: - description: Deletes a single address group. - operationId: networksecurity.projects.locations.addressGroups.delete + post: + description: >- + Creates a deployment group in a given project and location. See + https://google.aip.dev/133. + operationId: networksecurity.projects.locations.mirroringDeploymentGroups.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MirroringDeploymentGroup' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3659,25 +8043,19 @@ paths: required: true schema: type: string - - in: path - name: addressGroupsId - required: true + - in: query + name: mirroringDeploymentGroupId schema: type: string - in: query name: requestId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/addressGroups/{addressGroupsId}:addItems: + /v1/projects/{projectsId}/locations/{locationsId}/mirroringDeploymentGroups/{mirroringDeploymentGroupsId}: parameters: *ref_1 - post: - description: Adds items to an address group. - operationId: networksecurity.projects.locations.addressGroups.addItems - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AddAddressGroupItemsRequest' + get: + description: Gets a specific deployment group. See https://google.aip.dev/131. + operationId: networksecurity.projects.locations.mirroringDeploymentGroups.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3689,7 +8067,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/MirroringDeploymentGroup' parameters: - in: path name: projectsId @@ -3702,20 +8080,18 @@ paths: schema: type: string - in: path - name: addressGroupsId + name: mirroringDeploymentGroupsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/addressGroups/{addressGroupsId}:removeItems: - parameters: *ref_1 - post: - description: Removes items from an address group. - operationId: networksecurity.projects.locations.addressGroups.removeItems + patch: + description: Updates a deployment group. See https://google.aip.dev/134. + operationId: networksecurity.projects.locations.mirroringDeploymentGroups.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/RemoveAddressGroupItemsRequest' + $ref: '#/components/schemas/MirroringDeploymentGroup' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3740,20 +8116,22 @@ paths: schema: type: string - in: path - name: addressGroupsId + name: mirroringDeploymentGroupsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/addressGroups/{addressGroupsId}:cloneItems: - parameters: *ref_1 - post: - description: Clones items from one address group to another. - operationId: networksecurity.projects.locations.addressGroups.cloneItems - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CloneAddressGroupItemsRequest' + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: requestId + schema: + type: string + delete: + description: Deletes a deployment group. See https://google.aip.dev/135. + operationId: networksecurity.projects.locations.mirroringDeploymentGroups.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3778,15 +8156,21 @@ paths: schema: type: string - in: path - name: addressGroupsId + name: mirroringDeploymentGroupsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/addressGroups/{addressGroupsId}:listReferences: + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/mirroringDeployments: parameters: *ref_1 get: - description: Lists references of an address group. - operationId: networksecurity.projects.locations.addressGroups.listReferences + description: >- + Lists deployments in a given project and location. See + https://google.aip.dev/132. + operationId: networksecurity.projects.locations.mirroringDeployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3798,7 +8182,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListAddressGroupReferencesResponse' + $ref: '#/components/schemas/ListMirroringDeploymentsResponse' parameters: - in: path name: projectsId @@ -3810,33 +8194,33 @@ paths: required: true schema: type: string - - in: path - name: addressGroupsId - required: true - schema: - type: string - in: query name: pageSize schema: type: integer format: int32 - in: query - name: pageToken + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/addressGroups/{addressGroupsId}:setIamPolicy: - parameters: *ref_1 post: description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - `PERMISSION_DENIED` errors. - operationId: networksecurity.projects.locations.addressGroups.setIamPolicy + Creates a deployment in a given project and location. See + https://google.aip.dev/133. + operationId: networksecurity.projects.locations.mirroringDeployments.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' + $ref: '#/components/schemas/MirroringDeployment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3848,7 +8232,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -3860,18 +8244,19 @@ paths: required: true schema: type: string - - in: path - name: addressGroupsId - required: true + - in: query + name: mirroringDeploymentId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/addressGroups/{addressGroupsId}:getIamPolicy: + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/mirroringDeployments/{mirroringDeploymentsId}: parameters: *ref_1 get: - description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: networksecurity.projects.locations.addressGroups.getIamPolicy + description: Gets a specific deployment. See https://google.aip.dev/131. + operationId: networksecurity.projects.locations.mirroringDeployments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3883,7 +8268,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/MirroringDeployment' parameters: - in: path name: projectsId @@ -3896,30 +8281,18 @@ paths: schema: type: string - in: path - name: addressGroupsId + name: mirroringDeploymentsId required: true schema: type: string - - in: query - name: options.requestedPolicyVersion - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/addressGroups/{addressGroupsId}:testIamPermissions: - parameters: *ref_1 - post: - description: >- - Returns permissions that a caller has on the specified resource. If the - resource does not exist, this will return an empty set of permissions, - not a `NOT_FOUND` error. Note: This operation is designed to be used for - building permission-aware UIs and command-line tools, not for - authorization checking. This operation may "fail open" without warning. - operationId: networksecurity.projects.locations.addressGroups.testIamPermissions + patch: + description: Updates a deployment. See https://google.aip.dev/134. + operationId: networksecurity.projects.locations.mirroringDeployments.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsRequest' + $ref: '#/components/schemas/MirroringDeployment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3931,7 +8304,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -3944,15 +8317,22 @@ paths: schema: type: string - in: path - name: addressGroupsId + name: mirroringDeploymentsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/firewallEndpointAssociations: - parameters: *ref_1 - get: - description: Lists Associations in a given project and location. - operationId: networksecurity.projects.locations.firewallEndpointAssociations.list + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: requestId + schema: + type: string + delete: + description: Deletes a deployment. See https://google.aip.dev/135. + operationId: networksecurity.projects.locations.mirroringDeployments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3964,7 +8344,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListFirewallEndpointAssociationsResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -3976,33 +8356,20 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + - in: path + name: mirroringDeploymentsId + required: true schema: type: string - in: query - name: orderBy + name: requestId schema: type: string - post: - description: >- - Creates a new FirewallEndpointAssociation in a given project and - location. - operationId: networksecurity.projects.locations.firewallEndpointAssociations.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/FirewallEndpointAssociation' + /v1/projects/{projectsId}/locations/{locationsId}/authorizationPolicies: + parameters: *ref_1 + get: + description: Lists AuthorizationPolicies in a given project and location. + operationId: networksecurity.projects.locations.authorizationPolicies.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4014,7 +8381,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/ListAuthorizationPoliciesResponse' parameters: - in: path name: projectsId @@ -4027,18 +8394,22 @@ paths: schema: type: string - in: query - name: firewallEndpointAssociationId + name: pageSize schema: - type: string + type: integer + format: int32 - in: query - name: requestId + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/firewallEndpointAssociations/{firewallEndpointAssociationsId}: - parameters: *ref_1 - get: - description: Gets details of a single FirewallEndpointAssociation. - operationId: networksecurity.projects.locations.firewallEndpointAssociations.get + post: + description: Creates a new AuthorizationPolicy in a given project and location. + operationId: networksecurity.projects.locations.authorizationPolicies.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AuthorizationPolicy' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4050,7 +8421,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FirewallEndpointAssociation' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -4062,14 +8433,15 @@ paths: required: true schema: type: string - - in: path - name: firewallEndpointAssociationsId - required: true + - in: query + name: authorizationPolicyId schema: type: string - delete: - description: Deletes a single FirewallEndpointAssociation. - operationId: networksecurity.projects.locations.firewallEndpointAssociations.delete + /v1/projects/{projectsId}/locations/{locationsId}/authorizationPolicies/{authorizationPoliciesId}: + parameters: *ref_1 + get: + description: Gets details of a single AuthorizationPolicy. + operationId: networksecurity.projects.locations.authorizationPolicies.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4081,7 +8453,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/AuthorizationPolicy' parameters: - in: path name: projectsId @@ -4094,22 +8466,18 @@ paths: schema: type: string - in: path - name: firewallEndpointAssociationsId + name: authorizationPoliciesId required: true schema: type: string - - in: query - name: requestId - schema: - type: string patch: - description: Update a single FirewallEndpointAssociation. - operationId: networksecurity.projects.locations.firewallEndpointAssociations.patch + description: Updates the parameters of a single AuthorizationPolicy. + operationId: networksecurity.projects.locations.authorizationPolicies.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/FirewallEndpointAssociation' + $ref: '#/components/schemas/AuthorizationPolicy' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4134,7 +8502,7 @@ paths: schema: type: string - in: path - name: firewallEndpointAssociationsId + name: authorizationPoliciesId required: true schema: type: string @@ -4143,15 +8511,9 @@ paths: schema: type: string format: google-fieldmask - - in: query - name: requestId - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/authorizationPolicies: - parameters: *ref_1 - get: - description: Lists AuthorizationPolicies in a given project and location. - operationId: networksecurity.projects.locations.authorizationPolicies.list + delete: + description: Deletes a single AuthorizationPolicy. + operationId: networksecurity.projects.locations.authorizationPolicies.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4163,7 +8525,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListAuthorizationPoliciesResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -4175,23 +8537,24 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: authorizationPoliciesId + required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/authorizationPolicies/{authorizationPoliciesId}:setIamPolicy: + parameters: *ref_1 post: - description: Creates a new AuthorizationPolicy in a given project and location. - operationId: networksecurity.projects.locations.authorizationPolicies.create + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and + `PERMISSION_DENIED` errors. + operationId: networksecurity.projects.locations.authorizationPolicies.setIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/AuthorizationPolicy' + $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4203,7 +8566,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -4215,15 +8578,18 @@ paths: required: true schema: type: string - - in: query - name: authorizationPolicyId + - in: path + name: authorizationPoliciesId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/authorizationPolicies/{authorizationPoliciesId}: + /v1/projects/{projectsId}/locations/{locationsId}/authorizationPolicies/{authorizationPoliciesId}:getIamPolicy: parameters: *ref_1 get: - description: Gets details of a single AuthorizationPolicy. - operationId: networksecurity.projects.locations.authorizationPolicies.get + description: >- + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: networksecurity.projects.locations.authorizationPolicies.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4235,7 +8601,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AuthorizationPolicy' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -4252,14 +8618,27 @@ paths: required: true schema: type: string - patch: - description: Updates the parameters of a single AuthorizationPolicy. - operationId: networksecurity.projects.locations.authorizationPolicies.patch + - in: query + name: options.requestedPolicyVersion + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/authorizationPolicies/{authorizationPoliciesId}:testIamPermissions: + parameters: *ref_1 + post: + description: >- + Returns permissions that a caller has on the specified resource. If the + resource does not exist, this will return an empty set of permissions, + not a `NOT_FOUND` error. Note: This operation is designed to be used for + building permission-aware UIs and command-line tools, not for + authorization checking. This operation may "fail open" without warning. + operationId: >- + networksecurity.projects.locations.authorizationPolicies.testIamPermissions requestBody: content: application/json: schema: - $ref: '#/components/schemas/AuthorizationPolicy' + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4271,7 +8650,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' parameters: - in: path name: projectsId @@ -4288,14 +8667,53 @@ paths: required: true schema: type: string - - in: query - name: updateMask + /v1/projects/{projectsId}/locations/{locationsId}/backendAuthenticationConfigs: + parameters: *ref_1 + get: + description: Lists BackendAuthenticationConfigs in a given project and location. + operationId: networksecurity.projects.locations.backendAuthenticationConfigs.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListBackendAuthenticationConfigsResponse' + parameters: + - in: path + name: projectsId + required: true schema: type: string - format: google-fieldmask - delete: - description: Deletes a single AuthorizationPolicy. - operationId: networksecurity.projects.locations.authorizationPolicies.delete + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + post: + description: >- + Creates a new BackendAuthenticationConfig in a given project and + location. + operationId: networksecurity.projects.locations.backendAuthenticationConfigs.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BackendAuthenticationConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4319,24 +8737,17 @@ paths: required: true schema: type: string - - in: path - name: authorizationPoliciesId - required: true + - in: query + name: backendAuthenticationConfigId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/authorizationPolicies/{authorizationPoliciesId}:setIamPolicy: + /v1/projects/{projectsId}/locations/{locationsId}/backendAuthenticationConfigs/{backendAuthenticationConfigsId}: parameters: *ref_1 - post: + get: description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - `PERMISSION_DENIED` errors. - operationId: networksecurity.projects.locations.authorizationPolicies.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' + Gets details of a single BackendAuthenticationConfig to + BackendAuthenticationConfig. + operationId: networksecurity.projects.locations.backendAuthenticationConfigs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4348,7 +8759,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/BackendAuthenticationConfig' parameters: - in: path name: projectsId @@ -4361,17 +8772,20 @@ paths: schema: type: string - in: path - name: authorizationPoliciesId + name: backendAuthenticationConfigsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/authorizationPolicies/{authorizationPoliciesId}:getIamPolicy: - parameters: *ref_1 - get: + patch: description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: networksecurity.projects.locations.authorizationPolicies.getIamPolicy + Updates the parameters of a single BackendAuthenticationConfig to + BackendAuthenticationConfig. + operationId: networksecurity.projects.locations.backendAuthenticationConfigs.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BackendAuthenticationConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4383,7 +8797,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -4396,31 +8810,20 @@ paths: schema: type: string - in: path - name: authorizationPoliciesId + name: backendAuthenticationConfigsId required: true schema: type: string - in: query - name: options.requestedPolicyVersion + name: updateMask schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/authorizationPolicies/{authorizationPoliciesId}:testIamPermissions: - parameters: *ref_1 - post: + type: string + format: google-fieldmask + delete: description: >- - Returns permissions that a caller has on the specified resource. If the - resource does not exist, this will return an empty set of permissions, - not a `NOT_FOUND` error. Note: This operation is designed to be used for - building permission-aware UIs and command-line tools, not for - authorization checking. This operation may "fail open" without warning. - operationId: >- - networksecurity.projects.locations.authorizationPolicies.testIamPermissions - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsRequest' + Deletes a single BackendAuthenticationConfig to + BackendAuthenticationConfig. + operationId: networksecurity.projects.locations.backendAuthenticationConfigs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4432,7 +8835,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -4445,10 +8848,14 @@ paths: schema: type: string - in: path - name: authorizationPoliciesId + name: backendAuthenticationConfigsId required: true schema: type: string + - in: query + name: etag + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/serverTlsPolicies: parameters: *ref_1 get: @@ -4486,6 +8893,10 @@ paths: name: pageToken schema: type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean post: description: Creates a new ServerTlsPolicy in a given project and location. operationId: networksecurity.projects.locations.serverTlsPolicies.create @@ -5788,6 +10199,203 @@ paths: name: force schema: type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/authzPolicies: + parameters: *ref_1 + get: + description: Lists AuthzPolicies in a given project and location. + operationId: networksecurity.projects.locations.authzPolicies.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListAuthzPoliciesResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + post: + description: Creates a new AuthzPolicy in a given project and location. + operationId: networksecurity.projects.locations.authzPolicies.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AuthzPolicy' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: authzPolicyId + schema: + type: string + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/authzPolicies/{authzPoliciesId}: + parameters: *ref_1 + get: + description: Gets details of a single AuthzPolicy. + operationId: networksecurity.projects.locations.authzPolicies.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/AuthzPolicy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: authzPoliciesId + required: true + schema: + type: string + patch: + description: Updates the parameters of a single AuthzPolicy. + operationId: networksecurity.projects.locations.authzPolicies.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AuthzPolicy' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: authzPoliciesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: requestId + schema: + type: string + delete: + description: Deletes a single AuthzPolicy. + operationId: networksecurity.projects.locations.authzPolicies.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: authzPoliciesId + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/authzPolicies/{authzPoliciesId}:setIamPolicy: parameters: *ref_1 post: @@ -6038,7 +10646,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: networksecurity.organizations.locations.operations.cancel requestBody: content: @@ -6110,6 +10718,10 @@ paths: name: pageToken schema: type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean post: description: Creates a new address group in a given project and location. operationId: networksecurity.organizations.locations.addressGroups.create diff --git a/providers/src/googleapis.com/v00.00.00000/services/networkservices.yaml b/providers/src/googleapis.com/v00.00.00000/services/networkservices.yaml index dac8f4df..07b79b9a 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/networkservices.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/networkservices.yaml @@ -7,8 +7,8 @@ info: title: Network Services API description: '' version: v1 - x-discovery-doc-revision: '20241010' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250730' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/networking servers: @@ -202,10 +202,10 @@ components: type: string forwardingRules: description: >- - Required. A list of references to the forwarding rules to which this - service extension is attached to. At least one forwarding rule is - required. There can be only one `LBTrafficExtension` resource per - forwarding rule. + Optional. A list of references to the forwarding rules to which this + service extension is attached. At least one forwarding rule is + required. Only one `LbTrafficExtension` resource can be associated + with a forwarding rule. type: array items: type: string @@ -224,7 +224,7 @@ components: description: >- Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported - values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. For more + values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). type: string @@ -240,13 +240,19 @@ components: - EXTERNAL_MANAGED metadata: description: >- - Optional. The metadata provided here is included in the - `ProcessingRequest.metadata_context.filter_metadata` map field. The - metadata is available under the key + Optional. The metadata provided here is included as part of the + `metadata_context` (of type `google.protobuf.Struct`) in the + `ProcessingRequest` message sent to the extension server. The + metadata applies to all extensions in all extensions chains in this + resource. The metadata is available under the key `com.google.lb_traffic_extension.`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with - the forwarding rule's fully qualified resource name. This field is - not supported for plugin extensions and must not be set. + the forwarding rule's fully qualified resource name. This field must + not be set if at least one of the extension chains contains plugin + extensions. Setting it results in a validation error. You can set + metadata at either the resource level or the extension level. The + extension level metadata is recommended because you can pass a + different set of metadata through each extension to the backend. type: object additionalProperties: type: any @@ -276,8 +282,8 @@ components: Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` resource. - `LbRouteExtension` chains are limited to 1 extension per extension - chain. + `LbRouteExtension` and `LbEdgeExtension` chains are limited to 1 + extension per extension chain. type: array items: $ref: '#/components/schemas/ExtensionChainExtension' @@ -310,32 +316,38 @@ components: description: >- Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. - This field is not supported for plugin extensions and must not be - set. + This field is not supported for plugin extensions. Setting it + results in a validation error. type: string service: description: >- - Required. The reference to the service that runs the extension. - Currently only callout extensions are supported here. To configure a - callout extension, `service` must be a fully-qualified reference to - a [backend + Required. The reference to the service that runs the extension. To + configure a callout extension, `service` must be a fully-qualified + reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. - To configure a plugin extension, this must be a reference to a [wasm - plugin](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) + To configure a plugin extension, `service` must be a reference to a + [`WasmPlugin` + resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. + Plugin extensions are currently supported for the + `LbTrafficExtension`, the `LbRouteExtension`, and the + `LbEdgeExtension` resources. type: string supportedEvents: description: >- Optional. A set of events during request or response processing for - which this extension is called. This field is required for the - `LbTrafficExtension` resource. It must not be set for the - `LbRouteExtension` resource. + which this extension is called. For the `LbTrafficExtension` + resource, this field is required. For the `LbRouteExtension` + resource, this field is optional. If unspecified, `REQUEST_HEADERS` + event is assumed as supported. For the `LbEdgeExtension` resource, + this field is required and must only contain `REQUEST_HEADERS` + event. type: array items: type: string @@ -370,9 +382,9 @@ components: timeout: description: >- Optional. Specifies the timeout for each individual message on the - stream. The timeout must be between 10-1000 milliseconds. Required - for callout extensions. This field is not supported for plugin - extensions and must not be set. + stream. The timeout must be between `10`-`10000` milliseconds. + Required for callout extensions. This field is not supported for + plugin extensions. Setting it results in a validation error. type: string format: google-duration failOpen: @@ -406,8 +418,16 @@ components: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's - fully qualified resource name. This field is not supported for - plugin extensions and must not be set. + fully qualified resource name. This field must not be set for plugin + extensions. Setting it results in a validation error. You can set + metadata at either the resource level or the extension level. The + extension level metadata is recommended because you can pass a + different set of metadata through each extension to the backend. + This field is subject to following limitations: * The total size of + the metadata must be less than 1KiB. * The total number of keys in + the metadata must be less than 16. * The length of each key must be + less than 64 characters. * The length of each value must be less + than 1024 characters. * All values must be strings. type: object additionalProperties: type: any @@ -468,9 +488,9 @@ components: forwardingRules: description: >- Required. A list of references to the forwarding rules to which this - service extension is attached to. At least one forwarding rule is - required. There can be only one `LbRouteExtension` resource per - forwarding rule. + service extension is attached. At least one forwarding rule is + required. Only one `LbRouteExtension` resource can be associated + with a forwarding rule. type: array items: type: string @@ -508,16 +528,170 @@ components: Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The - metadata is available under the namespace + metadata applies to all extensions in all extensions chains in this + resource. The metadata is available under the key `com.google.lb_route_extension.`. The following variables are - supported in the metadata Struct: `{forwarding_rule_id}` - - substituted with the forwarding rule's fully qualified resource - name. This field is not supported for plugin extensions and must not - be set. + supported in the metadata: `{forwarding_rule_id}` - substituted with + the forwarding rule's fully qualified resource name. This field must + not be set if at least one of the extension chains contains plugin + extensions. Setting it results in a validation error. You can set + metadata at either the resource level or the extension level. The + extension level metadata is recommended because you can pass a + different set of metadata through each extension to the backend. + type: object + additionalProperties: + type: any + description: Properties of the object. + ListAuthzExtensionsResponse: + id: ListAuthzExtensionsResponse + description: Message for response to listing `AuthzExtension` resources. + type: object + properties: + authzExtensions: + description: The list of `AuthzExtension` resources. + type: array + items: + $ref: '#/components/schemas/AuthzExtension' + nextPageToken: + description: A token identifying a page of results that the server returns. + type: string + unreachable: + description: Locations that could not be reached. + type: array + items: + type: string + AuthzExtension: + id: AuthzExtension + description: >- + `AuthzExtension` is a resource that allows traffic forwarding to a + callout backend service to make an authorization decision. + type: object + properties: + name: + description: >- + Required. Identifier. Name of the `AuthzExtension` resource in the + following format: + `projects/{project}/locations/{location}/authzExtensions/{authz_extension}`. + type: string + createTime: + description: Output only. The timestamp when the resource was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. The timestamp when the resource was updated. + readOnly: true + type: string + format: google-datetime + description: + description: Optional. A human-readable description of the resource. + type: string + labels: + description: >- + Optional. Set of labels associated with the `AuthzExtension` + resource. The format must comply with [the requirements for + labels](/compute/docs/labeling-resources#requirements) for Google + Cloud resources. + type: object + additionalProperties: + type: string + loadBalancingScheme: + description: >- + Required. All backend services and forwarding rules referenced by + this extension must share the same load balancing scheme. Supported + values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. For more + information, refer to [Backend services + overview](https://cloud.google.com/load-balancing/docs/backend-service). + type: string + enumDescriptions: + - Default value. Do not use. + - Signifies that this is used for Internal HTTP(S) Load Balancing. + - >- + Signifies that this is used for External Managed HTTP(S) Load + Balancing. + enum: + - LOAD_BALANCING_SCHEME_UNSPECIFIED + - INTERNAL_MANAGED + - EXTERNAL_MANAGED + authority: + description: >- + Required. The `:authority` header in the gRPC request sent from + Envoy to the extension service. + type: string + service: + description: >- + Required. The reference to the service that runs the extension. To + configure a callout extension, `service` must be a fully-qualified + reference to a [backend + service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) + in the format: + `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` + or + `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. + type: string + timeout: + description: >- + Required. Specifies the timeout for each individual message on the + stream. The timeout must be between 10-10000 milliseconds. + type: string + format: google-duration + failOpen: + description: >- + Optional. Determines how the proxy behaves if the call to the + extension fails or times out. When set to `TRUE`, request or + response processing continues without error. Any subsequent + extensions in the extension chain are also executed. When set to + `FALSE` or the default setting of `FALSE` is used, one of the + following happens: * If response headers have not been delivered to + the downstream client, a generic 500 error is returned to the + client. The error response can be tailored by configuring a custom + error response in the load balancer. * If response headers have been + delivered, then the HTTP stream to the downstream client is reset. + type: boolean + metadata: + description: >- + Optional. The metadata provided here is included as part of the + `metadata_context` (of type `google.protobuf.Struct`) in the + `ProcessingRequest` message sent to the extension server. The + metadata is available under the namespace + `com.google.authz_extension.`. The following variables are supported + in the metadata Struct: `{forwarding_rule_id}` - substituted with + the forwarding rule's fully qualified resource name. type: object additionalProperties: type: any description: Properties of the object. + forwardHeaders: + description: >- + Optional. List of the HTTP headers to forward to the extension (from + the client). If omitted, all headers are sent. Each element is a + string indicating the header name. + type: array + items: + type: string + wireFormat: + description: >- + Optional. The format of communication supported by the callout + extension. If not specified, the default value `EXT_PROC_GRPC` is + used. + type: string + enumDescriptions: + - Not specified. + - >- + The extension service uses ext_proc gRPC API over a gRPC stream. + This is the default value if the wire format is not specified. The + backend service for the extension must use HTTP2 or H2C as the + protocol. All `supported_events` for a client request are sent as + part of the same gRPC stream. + - >- + The extension service uses Envoy's `ext_authz` gRPC API. The + backend service for the extension must use HTTP2, or H2C as the + protocol. `EXT_AUTHZ_GRPC` is only supported for `AuthzExtension` + resources. + enum: + - WIRE_FORMAT_UNSPECIFIED + - EXT_PROC_GRPC + - EXT_AUTHZ_GRPC ListEndpointPoliciesResponse: id: ListEndpointPoliciesResponse description: Response returned by the ListEndpointPolicies method. @@ -535,6 +709,14 @@ components: results, call this method again using the value of `next_page_token` as `page_token`. type: string + unreachable: + description: >- + Unreachable resources. Populated when the request opts into + return_partial_success and reading across collections e.g. when + attempting to list all resources across all supported locations. + type: array + items: + type: string EndpointPolicy: id: EndpointPolicy description: >- @@ -720,29 +902,46 @@ components: results, call this method again using the value of `next_page_token` as `page_token`. type: string + unreachable: + description: >- + Unreachable resources. Populated when the request attempts to list + all resources across all supported locations, while some locations + are temporarily unavailable. + type: array + items: + type: string WasmPluginVersion: id: WasmPluginVersion description: >- - A single immutable version of a `WasmPlugin`. Defines the Wasm module - used and optionally its runtime config. + A single immutable version of a `WasmPlugin` resource. Defines the Wasm + module used and optionally its runtime config. type: object properties: pluginConfigData: description: >- - Configuration for the Wasm plugin. The configuration is provided to - the Wasm plugin at runtime through the `ON_CONFIGURE` callback. When - a new `WasmPluginVersion` resource is created, the digest of the - contents is saved in the `plugin_config_digest` field. + Configuration for the plugin. The configuration is provided to the + plugin at runtime through the `ON_CONFIGURE` callback. When a new + `WasmPluginVersion` resource is created, the digest of the contents + is saved in the `plugin_config_digest` field. type: string format: byte pluginConfigUri: description: >- - URI of the Wasm plugin configuration stored in the Artifact - Registry. The configuration is provided to the plugin at runtime - through the `ON_CONFIGURE` callback. The container image must - contain only a single file with the name `plugin.config`. When a new - `WasmPluginVersion` resource is created, the digest of the container - image is saved in the `plugin_config_digest` field. + URI of the plugin configuration stored in the Artifact Registry. The + configuration is provided to the plugin at runtime through the + `ON_CONFIGURE` callback. The URI can refer to one of the following + repository formats: * Container images: the `plugin_config_uri` must + point to a container that contains a single file with the name + `plugin.config`. When a new `WasmPluginVersion` resource is created, + the digest of the image is saved in the `plugin_config_digest` + field. When pulling a container image from Artifact Registry, the + digest value is used instead of an image tag. * Generic artifacts: + the `plugin_config_uri` must be in this format: + `projects/{project}/locations/{location}/repositories/{repository}/ + genericArtifacts/{package}:{version}`. The specified package and + version must contain a file with the name `plugin.config`. When a + new `WasmPluginVersion` resource is created, the checksum of the + contents of the file is saved in the `plugin_config_digest` field. type: string name: description: >- @@ -773,26 +972,37 @@ components: type: string imageUri: description: >- - Optional. URI of the container image containing the Wasm plugin, - stored in the Artifact Registry. When a new `WasmPluginVersion` - resource is created, the digest of the container image is saved in - the `image_digest` field. When downloading an image, the digest - value is used instead of an image tag. + Optional. URI of the image containing the Wasm module, stored in + Artifact Registry. The URI can refer to one of the following + repository formats: * Container images: the `image_uri` must point + to a container that contains a single file with the name + `plugin.wasm`. When a new `WasmPluginVersion` resource is created, + the digest of the image is saved in the `image_digest` field. When + pulling a container image from Artifact Registry, the digest value + is used instead of an image tag. * Generic artifacts: the + `image_uri` must be in this format: + `projects/{project}/locations/{location}/repositories/{repository}/ + genericArtifacts/{package}:{version}`. The specified package and + version must contain a file with the name `plugin.wasm`. When a new + `WasmPluginVersion` resource is created, the checksum of the + contents of the file is saved in the `image_digest` field. type: string imageDigest: description: >- - Output only. The resolved digest for the image specified in `image`. - The digest is resolved during the creation of `WasmPluginVersion` - resource. This field holds the digest value regardless of whether a - tag or digest was originally specified in the `image` field. + Output only. This field holds the digest (usually checksum) value + for the plugin image. The value is calculated based on the + `image_uri` field. If the `image_uri` field refers to a container + image, the digest value is obtained from the container image. If the + `image_uri` field refers to a generic artifact, the digest value is + calculated based on the contents of the file. readOnly: true type: string pluginConfigDigest: description: >- Output only. This field holds the digest (usually checksum) value for the plugin configuration. The value is calculated based on the - contents of the `plugin_config_data` or the container image defined - by the `plugin_config_uri` field. + contents of `plugin_config_data` field or the image defined by the + `plugin_config_uri` field. readOnly: true type: string ListWasmPluginsResponse: @@ -812,6 +1022,14 @@ components: results, call this method again using the value of `next_page_token` as `page_token`. type: string + unreachable: + description: >- + Unreachable resources. Populated when the request attempts to list + all resources across all supported locations, while some locations + are temporarily unavailable. + type: array + items: + type: string WasmPlugin: id: WasmPlugin description: >- @@ -855,31 +1073,32 @@ components: logConfig: description: >- Optional. Specifies the logging options for the activity performed - by this `WasmPlugin`. If logging is enabled, plugin logs are - exported to Cloud Logging. Note that the settings relate to the logs - generated by using logging statements in your Wasm code. + by this plugin. If logging is enabled, plugin logs are exported to + Cloud Logging. Note that the settings relate to the logs generated + by using logging statements in your Wasm code. $ref: '#/components/schemas/WasmPluginLogConfig' versions: description: >- - Optional. All versions of this `WasmPlugin` in the key-value format. - The key is the resource ID, the value is the `VersionDetails`. - Allows to create or update `WasmPlugin` and its WasmPluginVersions - in a single request. When the `main_version_id` field is not empty - it must point to one of the VersionDetails in the map. If provided - in the update request, the new versions replace the previous set. - Any version omitted from the `versions` will be removed. Since the - `WasmPluginVersion` resource is immutable, if the WasmPluginVersion - with the same name already exists and differs the Update request - will fail. Note: In the GET request, this field is populated only if - the GetWasmPluginRequest.view is set to WASM_PLUGIN_VIEW_FULL. + Optional. All versions of this `WasmPlugin` resource in the + key-value format. The key is the resource ID, and the value is the + `VersionDetails` object. Lets you create or update a `WasmPlugin` + resource and its versions in a single request. When the + `main_version_id` field is not empty, it must point to one of the + `VersionDetails` objects in the map. If provided in a `PATCH` + request, the new versions replace the previous set. Any version + omitted from the `versions` field is removed. Because the + `WasmPluginVersion` resource is immutable, if a `WasmPluginVersion` + resource with the same name already exists and differs, the request + fails. Note: In a `GET` request, this field is populated only if the + field `GetWasmPluginRequest.view` is set to `WASM_PLUGIN_VIEW_FULL`. type: object additionalProperties: $ref: '#/components/schemas/WasmPluginVersionDetails' usedBy: description: >- - Output only. List of all [Service - Extensions](https://cloud.google.com/service-extensions/docs/overview) - that use this `WasmPlugin`. + Output only. List of all + [extensions](https://cloud.google.com/service-extensions/docs/overview) + that use this `WasmPlugin` resource. readOnly: true type: array items: @@ -887,15 +1106,14 @@ components: WasmPluginLogConfig: id: WasmPluginLogConfig description: >- - Specifies the logging options for the activity performed by this - `WasmPlugin`. If logging is enabled, plugin logs are exported to Cloud - Logging. + Specifies the logging options for the activity performed by this plugin. + If logging is enabled, plugin logs are exported to Cloud Logging. type: object properties: enable: description: >- Optional. Specifies whether to enable logging for activity by this - `WasmPlugin`. Defaults to `false`. + plugin. Defaults to `false`. type: boolean sampleRate: description: >- @@ -904,21 +1122,21 @@ components: activity is reported. A floating point value between `0.0` and `1.0` indicates that a percentage of log messages is stored. The default value when logging is enabled is `1.0`. The value of the field must - be between `0` and `1` (inclusive). This field can only be specified - if logging is enabled for this `WasmPlugin`. + be between `0` and `1` (inclusive). This field can be specified only + if logging is enabled for this plugin. type: number format: float minLogLevel: description: >- - Non-empty default. Specificies the lowest level of the plugin logs + Non-empty default. Specifies the lowest level of the plugin logs that are exported to Cloud Logging. This setting relates to the logs generated by using logging statements in your Wasm code. This field - is can be set only if logging is enabled for the `WasmPlugin` - resource. If the field is not provided when logging is enabled, it - is set to `INFO` by default. + is can be set only if logging is enabled for the plugin. If the + field is not provided when logging is enabled, it is set to `INFO` + by default. type: string enumDescriptions: - - Unspecified value. + - Unspecified value. Defaults to `LogLevel.INFO`. - Report logs with TRACE level and above. - Report logs with DEBUG level and above. - Report logs with INFO level and above. @@ -942,20 +1160,29 @@ components: properties: pluginConfigData: description: >- - Configuration for the Wasm plugin. The configuration is provided to - the Wasm plugin at runtime through the `ON_CONFIGURE` callback. When - a new `WasmPluginVersion` version is created, the digest of the - contents is saved in the `plugin_config_digest` field. + Configuration for the plugin. The configuration is provided to the + plugin at runtime through the `ON_CONFIGURE` callback. When a new + `WasmPluginVersion` version is created, the digest of the contents + is saved in the `plugin_config_digest` field. type: string format: byte pluginConfigUri: description: >- - URI of the WasmPlugin configuration stored in the Artifact Registry. - The configuration is provided to the Wasm plugin at runtime through - the `ON_CONFIGURE` callback. The container image must contain only a - single file with the name `plugin.config`. When a new - `WasmPluginVersion` resource is created, the digest of the container - image is saved in the `plugin_config_digest` field. + URI of the plugin configuration stored in the Artifact Registry. The + configuration is provided to the plugin at runtime through the + `ON_CONFIGURE` callback. The URI can refer to one of the following + repository formats: * Container images: the `plugin_config_uri` must + point to a container that contains a single file with the name + `plugin.config`. When a new `WasmPluginVersion` resource is created, + the digest of the image is saved in the `plugin_config_digest` + field. When pulling a container image from Artifact Registry, the + digest value is used instead of an image tag. * Generic artifacts: + the `plugin_config_uri` must be in this format: + `projects/{project}/locations/{location}/repositories/{repository}/ + genericArtifacts/{package}:{version}`. The specified package and + version must contain a file with the name `plugin.config`. When a + new `WasmPluginVersion` resource is created, the checksum of the + contents of the file is saved in the `plugin_config_digest` field. type: string createTime: description: Output only. The timestamp when the resource was created. @@ -979,37 +1206,48 @@ components: type: string imageUri: description: >- - Optional. URI of the container image containing the Wasm module, - stored in the Artifact Registry. The container image must contain - only a single file with the name `plugin.wasm`. When a new - `WasmPluginVersion` resource is created, the URI gets resolved to an - image digest and saved in the `image_digest` field. + Optional. URI of the image containing the Wasm module, stored in + Artifact Registry. The URI can refer to one of the following + repository formats: * Container images: the `image_uri` must point + to a container that contains a single file with the name + `plugin.wasm`. When a new `WasmPluginVersion` resource is created, + the digest of the image is saved in the `image_digest` field. When + pulling a container image from Artifact Registry, the digest value + is used instead of an image tag. * Generic artifacts: the + `image_uri` must be in this format: + `projects/{project}/locations/{location}/repositories/{repository}/ + genericArtifacts/{package}:{version}`. The specified package and + version must contain a file with the name `plugin.wasm`. When a new + `WasmPluginVersion` resource is created, the checksum of the + contents of the file is saved in the `image_digest` field. type: string imageDigest: description: >- - Output only. The resolved digest for the image specified in `image`. - The digest is resolved during the creation of a `WasmPluginVersion` - resource. This field holds the digest value regardless of whether a - tag or digest was originally specified in the `image` field. + Output only. This field holds the digest (usually checksum) value + for the plugin image. The value is calculated based on the + `image_uri` field. If the `image_uri` field refers to a container + image, the digest value is obtained from the container image. If the + `image_uri` field refers to a generic artifact, the digest value is + calculated based on the contents of the file. readOnly: true type: string pluginConfigDigest: description: >- Output only. This field holds the digest (usually checksum) value for the plugin configuration. The value is calculated based on the - contents of the `plugin_config_data` or the container image defined - by the `plugin_config_uri` field. + contents of `plugin_config_data` field or the image defined by the + `plugin_config_uri` field. readOnly: true type: string WasmPluginUsedBy: id: WasmPluginUsedBy - description: Defines a resource that uses the `WasmPlugin`. + description: Defines a resource that uses the `WasmPlugin` resource. type: object properties: name: description: >- Output only. Full name of the resource - https://google.aip.dev/122#full-resource-names, e.g. + https://google.aip.dev/122#full-resource-names, for example `//networkservices.googleapis.com/projects/{project}/locations/{location}/lbRouteExtensions/{extension}` readOnly: true type: string @@ -1042,7 +1280,6 @@ components: balancer. It captures the ip:port over which the services are exposed by the proxy, along with any policy configurations. Routes have reference to to Gateways to dictate how requests should be routed by this Gateway. - Next id: 33 type: object properties: name: @@ -1105,7 +1342,7 @@ components: description: >- Required. One or more port numbers (1-65535), on which the Gateway will receive traffic. The proxy binds to the specified ports. - Gateways of type 'SECURE_WEB_GATEWAY' are limited to 1 port. + Gateways of type 'SECURE_WEB_GATEWAY' are limited to 5 ports. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6 and support multiple ports. type: array @@ -1117,7 +1354,7 @@ components: Optional. Scope determines how configuration across multiple Gateway instances are merged. The configuration for multiple Gateway instances with the same scope will be merged as presented as a - single coniguration to the proxy/load balancer. Max length 64 + single configuration to the proxy/load balancer. Max length 64 characters. Scope should start with a letter and can only have letters, numbers, hyphens. type: string @@ -1224,6 +1461,14 @@ components: results, call this method again using the value of `next_page_token` as `page_token`. type: string + unreachable: + description: >- + Unreachable resources. Populated when the request opts into + return_partial_success and reading across collections e.g. when + attempting to list all resources across all supported locations. + type: array + items: + type: string GrpcRoute: id: GrpcRoute description: >- @@ -1585,7 +1830,8 @@ components: description: >- Required. The cookie TTL value for the Set-Cookie header generated by the data plane. The lifetime of the cookie may be set to a value - from 1 to 86400 seconds (24 hours) inclusive. + from 0 to 86400 seconds (24 hours) inclusive. Set this to 0s to use + a session cookie and disable cookie expiration. type: string format: google-duration ListHttpRoutesResponse: @@ -1605,6 +1851,14 @@ components: results, call this method again using the value of `next_page_token` as `page_token`. type: string + unreachable: + description: >- + Unreachable resources. Populated when the request opts into + return_partial_success and reading across collections e.g. when + attempting to list all resources across all supported locations. + type: array + items: + type: string HttpRoute: id: HttpRoute description: >- @@ -2166,7 +2420,8 @@ components: Specifies the policy on how requests are shadowed to a separate mirrored destination service. The proxy 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. + host/authority header is suffixed with -shadow. Mirroring is currently + not supported for Cloud Run destinations. type: object properties: destination: @@ -2250,7 +2505,8 @@ components: description: >- Required. The cookie TTL value for the Set-Cookie header generated by the data plane. The lifetime of the cookie may be set to a value - from 1 to 86400 seconds (24 hours) inclusive. + from 0 to 86400 seconds (24 hours) inclusive. Set this to 0s to use + a session cookie and disable cookie expiration. type: string format: google-duration HttpRouteHttpDirectResponse: @@ -2290,6 +2546,14 @@ components: results, call this method again using the value of `next_page_token` as `page_token`. type: string + unreachable: + description: >- + Unreachable resources. Populated when the request opts into + return_partial_success and reading across collections e.g. when + attempting to list all resources across all supported locations. + type: array + items: + type: string TcpRoute: id: TcpRoute description: >- @@ -2461,6 +2725,14 @@ components: results, call this method again using the value of `next_page_token` as `page_token`. type: string + unreachable: + description: >- + Unreachable resources. Populated when the request opts into + return_partial_success and reading across collections e.g. when + attempting to list all resources across all supported locations. + type: array + items: + type: string TlsRoute: id: TlsRoute description: >- @@ -2535,6 +2807,7 @@ components: description: >- Required. RouteMatch defines the predicate used to match requests to a given action. Multiple match types are "OR"ed for evaluation. + Atleast one RouteMatch must be supplied. type: array items: $ref: '#/components/schemas/TlsRouteRouteMatch' @@ -2545,9 +2818,7 @@ components: id: TlsRouteRouteMatch description: >- RouteMatch defines the predicate used to match requests to a given - action. Multiple match types are "AND"ed for evaluation. If no - routeMatch field is specified, this rule will unconditionally match - traffic. + action. Multiple match types are "AND"ed for evaluation. type: object properties: sniHost: @@ -2600,7 +2871,7 @@ components: type: string weight: description: >- - Optional. Specifies the proportion of requests forwareded to the + Optional. Specifies the proportion of requests forwarded to the backend referenced by the service_name field. This is computed as: - weight/Sum(weights in destinations) Weights in all destinations does not need to sum up to 100. @@ -2623,17 +2894,29 @@ components: results, call this method again using the value of `next_page_token` as `page_token`. type: string + unreachable: + description: >- + Unreachable resources. Populated when the request attempts to list + all resources across all supported locations, while some locations + are temporarily unavailable. + type: array + items: + type: string ServiceBinding: id: ServiceBinding description: >- - ServiceBinding is the resource that defines a Service Directory Service - to be used in a BackendService resource. + ServiceBinding can be used to: - Bind a Service Directory Service to be + used in a BackendService resource. This feature will be deprecated soon. + - Bind a Private Service Connect producer service to be used in consumer + Cloud Service Mesh or Application Load Balancers. - Bind a Cloud Run + service to be used in consumer Cloud Service Mesh or Application Load + Balancers. type: object properties: name: description: >- Identifier. Name of the ServiceBinding resource. It matches pattern - `projects/*/locations/global/serviceBindings/service_binding_name`. + `projects/*/locations/*/serviceBindings/`. type: string description: description: >- @@ -2652,16 +2935,21 @@ components: format: google-datetime service: description: >- - Required. The full Service Directory Service name of the format - projects/*/locations/*/namespaces/*/services/* + Optional. The full Service Directory Service name of the format + `projects/*/locations/*/namespaces/*/services/*`. This field is for + Service Directory integration which will be deprecated soon. + deprecated: true type: string serviceId: description: >- Output only. The unique identifier of the Service Directory Service - against which the Service Binding resource is validated. This is + against which the ServiceBinding resource is validated. This is populated when the Service Binding resource is used in another - resource (like Backend Service). This is of the UUID4 format. + resource (like Backend Service). This is of the UUID4 format. This + field is for Service Directory integration which will be deprecated + soon. readOnly: true + deprecated: true type: string labels: description: >- @@ -2687,6 +2975,14 @@ components: results, call this method again using the value of `next_page_token` as `page_token`. type: string + unreachable: + description: >- + Unreachable resources. Populated when the request opts into + `return_partial_success` and reading across collections e.g. when + attempting to list all resources across all supported locations. + type: array + items: + type: string Mesh: id: Mesh description: >- @@ -2769,6 +3065,14 @@ components: results, call this method again using the value of `next_page_token` as `page_token`. type: string + unreachable: + description: >- + Unreachable resources. Populated when the request attempts to list + all resources across all supported locations, while some locations + are temporarily unavailable. + type: array + items: + type: string ServiceLbPolicy: id: ServiceLbPolicy description: >- @@ -2839,6 +3143,11 @@ components: failoverConfig: description: Optional. Configuration related to health based failover. $ref: '#/components/schemas/ServiceLbPolicyFailoverConfig' + isolationConfig: + description: >- + Optional. Configuration to provide isolation support for the + associated Backend Service. + $ref: '#/components/schemas/ServiceLbPolicyIsolationConfig' ServiceLbPolicyAutoCapacityDrain: id: ServiceLbPolicyAutoCapacityDrain description: >- @@ -2872,6 +3181,147 @@ components: for others. type: integer format: int32 + ServiceLbPolicyIsolationConfig: + id: ServiceLbPolicyIsolationConfig + description: >- + Configuration to provide isolation support for the associated Backend + Service. + type: object + properties: + isolationGranularity: + description: Optional. The isolation granularity of the load balancer. + type: string + enumDescriptions: + - >- + No isolation is configured for the backend service. Traffic can + overflow based on the load balancing algorithm. + - >- + Traffic for this service will be isolated at the cloud region + level. + enum: + - ISOLATION_GRANULARITY_UNSPECIFIED + - REGION + isolationMode: + description: Optional. The isolation mode of the load balancer. + type: string + enumDescriptions: + - No isolation mode is configured for the backend service. + - Traffic will be sent to the nearest region. + - >- + Traffic will fail if no serving backends are available in the same + region as the load balancer. + enum: + - ISOLATION_MODE_UNSPECIFIED + - NEAREST + - STRICT + GatewayRouteView: + id: GatewayRouteView + description: GatewayRouteView defines view-only resource for Routes to a Gateway + type: object + properties: + name: + description: >- + Output only. Identifier. Full path name of the GatewayRouteView + resource. Format: + projects/{project_number}/locations/{location}/gateways/{gateway}/routeViews/{route_view} + readOnly: true + type: string + routeProjectNumber: + description: Output only. Project number where the route exists. + readOnly: true + type: string + format: int64 + routeLocation: + description: Output only. Location where the route exists. + readOnly: true + type: string + routeType: + description: >- + Output only. Type of the route: HttpRoute,GrpcRoute,TcpRoute, or + TlsRoute + readOnly: true + type: string + routeId: + description: Output only. The resource id for the route. + readOnly: true + type: string + MeshRouteView: + id: MeshRouteView + description: MeshRouteView defines view-only resource for Routes to a Mesh + type: object + properties: + name: + description: >- + Output only. Identifier. Full path name of the MeshRouteView + resource. Format: + projects/{project_number}/locations/{location}/meshes/{mesh}/routeViews/{route_view} + readOnly: true + type: string + routeProjectNumber: + description: Output only. Project number where the route exists. + readOnly: true + type: string + format: int64 + routeLocation: + description: Output only. Location where the route exists. + readOnly: true + type: string + routeType: + description: >- + Output only. Type of the route: HttpRoute,GrpcRoute,TcpRoute, or + TlsRoute + readOnly: true + type: string + routeId: + description: Output only. The resource id for the route. + readOnly: true + type: string + ListGatewayRouteViewsResponse: + id: ListGatewayRouteViewsResponse + description: Response returned by the ListGatewayRouteViews method. + type: object + properties: + gatewayRouteViews: + description: List of GatewayRouteView resources. + type: array + items: + $ref: '#/components/schemas/GatewayRouteView' + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + unreachable: + description: >- + Unreachable resources. Populated when the request attempts to list + all resources across all supported locations, while some locations + are temporarily unavailable. + type: array + items: + type: string + ListMeshRouteViewsResponse: + id: ListMeshRouteViewsResponse + description: Response returned by the ListMeshRouteViews method. + type: object + properties: + meshRouteViews: + description: List of MeshRouteView resources. + type: array + items: + $ref: '#/components/schemas/MeshRouteView' + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + unreachable: + description: >- + Unreachable resources. Populated when the request attempts to list + all resources across all supported locations, while some locations + are temporarily unavailable. + type: array + items: + type: string ListLocationsResponse: id: ListLocationsResponse description: The response message for Locations.ListLocations. @@ -3297,7 +3747,7 @@ components: LoggingConfig: id: LoggingConfig description: >- - The configuration for Platform Telemetry logging for Eventarc Avdvanced + The configuration for Platform Telemetry logging for Eventarc Advanced resources. type: object properties: @@ -3603,65 +4053,117 @@ components: delete: - $ref: >- #/components/x-stackQL-resources/lb_route_extensions/methods/delete - endpoint_policies: - id: google.networkservices.endpoint_policies - name: endpoint_policies - title: Endpoint_policies + authz_extensions: + id: google.networkservices.authz_extensions + name: authz_extensions + title: Authz_extensions methods: list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpointPolicies/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authzExtensions/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.endpointPolicies + objectKey: $.authzExtensions create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpointPolicies/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authzExtensions/post response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpointPolicies~1{endpointPoliciesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authzExtensions~1{authzExtensionsId}/get response: mediaType: application/json openAPIDocKey: '200' patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpointPolicies~1{endpointPoliciesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authzExtensions~1{authzExtensionsId}/patch response: mediaType: application/json openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpointPolicies~1{endpointPoliciesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authzExtensions~1{authzExtensionsId}/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/endpoint_policies/methods/get' - - $ref: '#/components/x-stackQL-resources/endpoint_policies/methods/list' + - $ref: '#/components/x-stackQL-resources/authz_extensions/methods/get' + - $ref: '#/components/x-stackQL-resources/authz_extensions/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/endpoint_policies/methods/create' + - $ref: '#/components/x-stackQL-resources/authz_extensions/methods/create' update: - - $ref: '#/components/x-stackQL-resources/endpoint_policies/methods/patch' + - $ref: '#/components/x-stackQL-resources/authz_extensions/methods/patch' replace: [] delete: - - $ref: '#/components/x-stackQL-resources/endpoint_policies/methods/delete' - wasm_plugins: - id: google.networkservices.wasm_plugins - name: wasm_plugins - title: Wasm_plugins - methods: - list: - operation: + - $ref: '#/components/x-stackQL-resources/authz_extensions/methods/delete' + endpoint_policies: + id: google.networkservices.endpoint_policies + name: endpoint_policies + title: Endpoint_policies + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpointPolicies/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.endpointPolicies + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpointPolicies/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpointPolicies~1{endpointPoliciesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpointPolicies~1{endpointPoliciesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpointPolicies~1{endpointPoliciesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/endpoint_policies/methods/get' + - $ref: '#/components/x-stackQL-resources/endpoint_policies/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/endpoint_policies/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/endpoint_policies/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/endpoint_policies/methods/delete' + wasm_plugins: + id: google.networkservices.wasm_plugins + name: wasm_plugins + title: Wasm_plugins + methods: + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1wasmPlugins/get response: @@ -3803,6 +4305,34 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/gateways/methods/delete' + route_views: + id: google.networkservices.route_views + name: route_views + title: Route_views + methods: + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1meshes~1{meshesId}~1routeViews~1{routeViewsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1meshes~1{meshesId}~1routeViews/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.meshRouteViews + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/route_views/methods/get' + - $ref: '#/components/x-stackQL-resources/route_views/methods/list' + insert: [] + update: [] + replace: [] + delete: [] grpc_routes: id: google.networkservices.grpc_routes name: grpc_routes @@ -4038,6 +4568,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1serviceBindings~1{serviceBindingsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' delete: operation: $ref: >- @@ -4051,7 +4588,8 @@ components: - $ref: '#/components/x-stackQL-resources/service_bindings/methods/list' insert: - $ref: '#/components/x-stackQL-resources/service_bindings/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/service_bindings/methods/patch' replace: [] delete: - $ref: '#/components/x-stackQL-resources/service_bindings/methods/delete' @@ -4320,6 +4858,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: @@ -4474,7 +5016,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: networkservices.projects.locations.operations.cancel requestBody: content: @@ -4907,6 +5449,203 @@ paths: name: requestId schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/authzExtensions: + parameters: *ref_1 + get: + description: Lists `AuthzExtension` resources in a given project and location. + operationId: networkservices.projects.locations.authzExtensions.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListAuthzExtensionsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + post: + description: Creates a new `AuthzExtension` resource in a given project and location. + operationId: networkservices.projects.locations.authzExtensions.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AuthzExtension' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: authzExtensionId + schema: + type: string + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/authzExtensions/{authzExtensionsId}: + parameters: *ref_1 + get: + description: Gets details of the specified `AuthzExtension` resource. + operationId: networkservices.projects.locations.authzExtensions.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/AuthzExtension' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: authzExtensionsId + required: true + schema: + type: string + patch: + description: Updates the parameters of the specified `AuthzExtension` resource. + operationId: networkservices.projects.locations.authzExtensions.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AuthzExtension' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: authzExtensionsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: requestId + schema: + type: string + delete: + description: Deletes the specified `AuthzExtension` resource. + operationId: networkservices.projects.locations.authzExtensions.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: authzExtensionsId + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/endpointPolicies: parameters: *ref_1 get: @@ -4944,6 +5683,10 @@ paths: name: pageToken schema: type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean post: description: Creates a new EndpointPolicy in a given project and location. operationId: networkservices.projects.locations.endpointPolicies.create @@ -5600,6 +6343,86 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/gateways/{gatewaysId}/routeViews/{routeViewsId}: + parameters: *ref_1 + get: + description: Get a single RouteView of a Gateway. + operationId: networkservices.projects.locations.gateways.routeViews.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GatewayRouteView' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: gatewaysId + required: true + schema: + type: string + - in: path + name: routeViewsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/gateways/{gatewaysId}/routeViews: + parameters: *ref_1 + get: + description: Lists RouteViews + operationId: networkservices.projects.locations.gateways.routeViews.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListGatewayRouteViewsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: gatewaysId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/grpcRoutes: parameters: *ref_1 get: @@ -5637,6 +6460,10 @@ paths: name: pageToken schema: type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean post: description: Creates a new GrpcRoute in a given project and location. operationId: networkservices.projects.locations.grpcRoutes.create @@ -5814,6 +6641,10 @@ paths: name: pageToken schema: type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean post: description: Creates a new HttpRoute in a given project and location. operationId: networkservices.projects.locations.httpRoutes.create @@ -5991,6 +6822,10 @@ paths: name: pageToken schema: type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean post: description: Creates a new TcpRoute in a given project and location. operationId: networkservices.projects.locations.tcpRoutes.create @@ -6168,6 +7003,10 @@ paths: name: pageToken schema: type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean post: description: Creates a new TlsRoute in a given project and location. operationId: networkservices.projects.locations.tlsRoutes.create @@ -6413,6 +7252,47 @@ paths: required: true schema: type: string + patch: + description: Updates the parameters of a single ServiceBinding. + operationId: networkservices.projects.locations.serviceBindings.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceBinding' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: serviceBindingsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask delete: description: Deletes a single ServiceBinding. operationId: networkservices.projects.locations.serviceBindings.delete @@ -6481,6 +7361,10 @@ paths: name: pageToken schema: type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean post: description: Creates a new Mesh in a given project and location. operationId: networkservices.projects.locations.meshes.create @@ -6621,6 +7505,86 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/meshes/{meshesId}/routeViews/{routeViewsId}: + parameters: *ref_1 + get: + description: Get a single RouteView of a Mesh. + operationId: networkservices.projects.locations.meshes.routeViews.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/MeshRouteView' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: meshesId + required: true + schema: + type: string + - in: path + name: routeViewsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/meshes/{meshesId}/routeViews: + parameters: *ref_1 + get: + description: Lists RouteViews + operationId: networkservices.projects.locations.meshes.routeViews.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListMeshRouteViewsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: meshesId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/serviceLbPolicies: parameters: *ref_1 get: diff --git a/providers/src/googleapis.com/v00.00.00000/services/notebooks.yaml b/providers/src/googleapis.com/v00.00.00000/services/notebooks.yaml index 5eec4eeb..6618c443 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/notebooks.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/notebooks.yaml @@ -7,8 +7,8 @@ info: title: Notebooks API description: Notebooks API is used to manage notebook resources in Google Cloud. version: v2 - x-discovery-doc-revision: '20241023' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250730' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/notebooks/docs/ servers: @@ -241,10 +241,10 @@ components: type: string instanceOwners: description: >- - Optional. Input only. The owner of this instance after creation. - Format: `alias@example.com` Currently supports one owner only. If - not specified, all of the service account users of your VM - instance's service account can use the instance. + Optional. The owner of this instance after creation. Format: + `alias@example.com` Currently supports one owner only. If not + specified, all of the service account users of your VM instance's + service account can use the instance. type: array items: type: string @@ -364,6 +364,22 @@ components: description: Output only. Reserved for future use for Zone Isolation. readOnly: true type: boolean + enableThirdPartyIdentity: + description: >- + Optional. Flag that specifies that a notebook can be accessed with + third party identity provider. + type: boolean + enableManagedEuc: + description: >- + Optional. Flag to enable managed end user credentials for the + instance. + type: boolean + enableDeletionProtection: + description: >- + Optional. If true, deletion protection will be enabled for this + Workbench Instance. If false, deletion protection will be disabled + for this Workbench Instance. + type: boolean GceSetup: id: GceSetup description: >- @@ -456,6 +472,14 @@ components: gpuDriverConfig: description: Optional. Configuration for GPU drivers. $ref: '#/components/schemas/GPUDriverConfig' + reservationAffinity: + description: >- + Optional. Specifies the reservations that this instance can consume + from. + $ref: '#/components/schemas/ReservationAffinity' + confidentialInstanceConfig: + description: Optional. Confidential instance configuration. + $ref: '#/components/schemas/ConfidentialInstanceConfig' AcceleratorConfig: id: AcceleratorConfig description: >- @@ -478,6 +502,8 @@ components: - Accelerator type is Nvidia Tesla A100 - 40GB. - Accelerator type is Nvidia Tesla A100 - 80GB. - Accelerator type is Nvidia Tesla L4. + - Accelerator type is Nvidia Tesla H100 - 80GB. + - Accelerator type is Nvidia Tesla H100 - MEGA 80GB. - Accelerator type is NVIDIA Tesla T4 Virtual Workstations. - Accelerator type is NVIDIA Tesla P100 Virtual Workstations. - Accelerator type is NVIDIA Tesla P4 Virtual Workstations. @@ -490,6 +516,8 @@ components: - NVIDIA_TESLA_A100 - NVIDIA_A100_80GB - NVIDIA_L4 + - NVIDIA_H100_80GB + - NVIDIA_H100_MEGA_80GB - NVIDIA_TESLA_T4_VWS - NVIDIA_TESLA_P100_VWS - NVIDIA_TESLA_P4_VWS @@ -663,9 +691,7 @@ components: Disabled by default. type: boolean enableVtpm: - description: >- - Optional. Defines whether the VM instance has the vTPM enabled. - Enabled by default. + description: Optional. Defines whether the VM instance has the vTPM enabled. type: boolean enableIntegrityMonitoring: description: >- @@ -674,7 +700,6 @@ components: the VM instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the VM instance is created. - Enabled by default. type: boolean NetworkInterface: id: NetworkInterface @@ -745,6 +770,63 @@ components: is stored. If not specified, we'll automatically choose from official GPU drivers. type: string + ReservationAffinity: + id: ReservationAffinity + description: A reservation that an instance can consume from. + type: object + properties: + consumeReservationType: + description: >- + Required. Specifies the type of reservation from which this instance + can consume resources: RESERVATION_ANY (default), + RESERVATION_SPECIFIC, or RESERVATION_NONE. See Consuming reserved + instances for examples. + type: string + enumDescriptions: + - Default type. + - Do not consume from any allocated capacity. + - Consume any reservation available. + - >- + Must consume from a specific reservation. Must specify key value + fields for specifying the reservations. + enum: + - RESERVATION_UNSPECIFIED + - RESERVATION_NONE + - RESERVATION_ANY + - RESERVATION_SPECIFIC + key: + description: >- + Optional. Corresponds to the label key of a reservation resource. To + target a RESERVATION_SPECIFIC by name, use + compute.googleapis.com/reservation-name as the key and specify the + name of your reservation as its value. + type: string + values: + description: >- + Optional. 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. + type: array + items: + type: string + ConfidentialInstanceConfig: + id: ConfidentialInstanceConfig + description: A set of Confidential Instance options. + type: object + properties: + confidentialInstanceType: + description: >- + Optional. Defines the type of technology used by the confidential + instance. + type: string + enumDescriptions: + - No type specified. Do not use this value. + - AMD Secure Encrypted Virtualization. + enum: + - CONFIDENTIAL_INSTANCE_TYPE_UNSPECIFIED + - SEV UpgradeHistoryEntry: id: UpgradeHistoryEntry description: The entry of VM image upgrade history. @@ -941,6 +1023,12 @@ components: type: array items: $ref: '#/components/schemas/ImageRelease' + disableWorkbenchLegacyCreation: + description: >- + Output only. Flag to disable the creation of legacy Workbench + notebooks (User-managed notebooks and Google-managed notebooks). + readOnly: true + type: boolean DefaultValues: id: DefaultValues description: DefaultValues represents the default configuration values. @@ -1073,6 +1161,76 @@ components: Required. The VM hardware token for authenticating the VM. https://cloud.google.com/compute/docs/instances/verifying-instance-identity type: string + CheckAuthorizationRequest: + id: CheckAuthorizationRequest + description: Request message for checking authorization for the instance owner. + type: object + properties: + authorizationDetails: + description: >- + Optional. The details of the OAuth authorization response. This may + include additional params such as dry_run, version_info, origin, + propagate, etc. + type: object + additionalProperties: + type: string + CheckAuthorizationResponse: + id: CheckAuthorizationResponse + description: Response message for checking authorization for the instance owner. + type: object + properties: + createTime: + description: Output only. Timestamp when this Authorization request was created. + readOnly: true + type: string + format: google-datetime + success: + description: >- + Success indicates that the user completed OAuth consent and access + tokens can be generated. + type: boolean + oauth_uri: + description: >- + If the user has not completed OAuth consent, then the oauth_url is + returned. Otherwise, this field is not set. + type: string + GenerateAccessTokenRequest: + id: GenerateAccessTokenRequest + description: Request message for generating an EUC for the instance owner. + type: object + properties: + vmToken: + description: >- + Required. The VM identity token (a JWT) for authenticating the VM. + https://cloud.google.com/compute/docs/instances/verifying-instance-identity + type: string + GenerateAccessTokenResponse: + id: GenerateAccessTokenResponse + description: Response message for generating an EUC for the instance owner. + type: object + properties: + access_token: + description: >- + Short-lived access token string which may be used to access Google + APIs. + type: string + expires_in: + description: >- + The time in seconds when the access token expires. Typically that's + 3600. + type: integer + format: int32 + scope: + description: >- + Space-separated list of scopes contained in the returned token. + https://cloud.google.com/docs/authentication/token-types#access-contents + type: string + token_type: + description: >- + Type of the returned access token (e.g. "Bearer"). It specifies how + the token must be used. Bearer tokens may be used by any entity + without proof of identity. + type: string SetIamPolicyRequest: id: SetIamPolicyRequest description: Request message for `SetIamPolicy` method. @@ -1355,8 +1513,8 @@ components: description: >- Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have - Operation.error value with a google.rpc.Status.code of 1, - corresponding to `Code.CANCELLED`. + google.longrunning.Operation.error value with a + google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. type: boolean apiVersion: description: API version used to start the operation. @@ -1632,6 +1790,20 @@ components: response: mediaType: application/json openAPIDocKey: '200' + check_authorization: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1instances~1{instancesId}:checkAuthorization/post + response: + mediaType: application/json + openAPIDocKey: '200' + generate_access_token: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1instances~1{instancesId}:generateAccessToken/post + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/instances/methods/get' @@ -1748,6 +1920,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v2/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: @@ -1902,7 +2078,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: notebooks.projects.locations.operations.cancel requestBody: content: @@ -2436,12 +2612,7 @@ paths: /v2/projects/{projectsId}/locations/{locationsId}/instances:getConfig: parameters: *ref_1 get: - description: >- - Gets general backend configurations that might also affect the frontend. - Location is required by CCFE. Although we could bypass it to send - location- less request directly to the backend job, we would need CPE - (go/cloud-cpe). Having the location might also be useful depending on - the query. + description: Returns various configuration parameters. operationId: notebooks.projects.locations.instances.getConfig security: - Oauth2: @@ -2585,6 +2756,87 @@ paths: required: true schema: type: string + /v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:checkAuthorization: + parameters: *ref_1 + post: + description: >- + Initiated by Cloud Console for Oauth consent flow for Workbench + Instances. Do not use this method directly. Design doc: + go/wbi-euc:auth-dd + operationId: notebooks.projects.locations.instances.checkAuthorization + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CheckAuthorizationRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/CheckAuthorizationResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:generateAccessToken: + parameters: *ref_1 + post: + description: >- + Called by VM to return an EUC for the instance owner. Do not use this + method directly. Design doc: go/wbi-euc:dd + operationId: notebooks.projects.locations.instances.generateAccessToken + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GenerateAccessTokenRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GenerateAccessTokenResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string /v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:setIamPolicy: parameters: *ref_1 post: diff --git a/providers/src/googleapis.com/v00.00.00000/services/observability.yaml b/providers/src/googleapis.com/v00.00.00000/services/observability.yaml new file mode 100644 index 00000000..0686bac3 --- /dev/null +++ b/providers/src/googleapis.com/v00.00.00000/services/observability.yaml @@ -0,0 +1,1039 @@ +openapi: 3.1.0 +info: + contact: + name: StackQL Studios + url: https://github.com/stackql/google-discovery-to-openapi + email: info@stackql.io + title: Observability API + description: '' + version: v1 + x-discovery-doc-revision: '20250822' + x-generated-date: '2025-08-28' +externalDocs: + url: https://cloud.google.com/stackdriver/docs/ +servers: + - url: https://observability.googleapis.com +components: + securitySchemes: + Oauth2: + type: oauth2 + description: Oauth 2.0 implicit authentication + flows: + implicit: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + scopes: &ref_0 + 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. + Oauth2c: + type: oauth2 + description: Oauth 2.0 authorization code authentication + flows: + authorizationCode: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + tokenUrl: https://accounts.google.com/o/oauth2/token + scopes: *ref_0 + schemas: + ListOperationsResponse: + id: ListOperationsResponse + description: The response message for Operations.ListOperations. + type: object + properties: + operations: + description: >- + A list of operations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/Operation' + nextPageToken: + description: The standard List next-page token. + type: string + Operation: + id: Operation + description: >- + This resource represents a long-running operation that is the result of + a network API call. + type: object + properties: + name: + description: >- + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. + type: string + metadata: + description: >- + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + done: + description: >- + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + type: boolean + error: + description: >- + The error result of the operation in case of failure or + cancellation. + $ref: '#/components/schemas/Status' + response: + description: >- + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + Status: + id: Status + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + type: object + properties: + code: + description: The status code, which should be an enum value of google.rpc.Code. + type: integer + format: int32 + message: + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + type: string + details: + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + type: array + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + Empty: + id: Empty + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + type: object + properties: {} + CancelOperationRequest: + id: CancelOperationRequest + description: The request message for Operations.CancelOperation. + type: object + properties: {} + Scope: + id: Scope + description: Message describing Scope object + type: object + properties: + name: + description: >- + Identifier. Name of the resource. The format is: + projects/{project}/locations/{location}/scopes/{scope} The + `{location}` field must be set to `global`. The `{scope}` field must + be set to `_Default`. + type: string + updateTime: + description: >- + Output only. Update timestamp. Note: The Update timestamp for the + default scope is initially unset. + readOnly: true + type: string + format: google-datetime + logScope: + description: >- + Required. The full resource name of the `LogScope`. For example: + //logging.googleapis.com/projects/myproject/locations/global/logScopes/my-log-scope + type: string + traceScope: + description: >- + Required. The resource name of the `TraceScope`. For example: + projects/myproject/locations/global/traceScopes/my-trace-scope + type: string + TraceScope: + id: TraceScope + description: >- + A trace scope is a collection of resources whose traces are queried + together. + type: object + properties: + name: + description: >- + Identifier. The resource name of the trace scope. For example: + projects/my-project/locations/global/traceScopes/my-trace-scope + type: string + resourceNames: + description: >- + Required. Names of the projects that are included in this trace + scope. * `projects/[PROJECT_ID]` A trace scope can include a maximum + of 20 projects. + type: array + items: + type: string + description: + description: >- + Optional. Describes this trace scope. The maximum length of the + description is 8000 characters. + type: string + createTime: + description: Output only. The creation timestamp of the trace scope. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. The last update timestamp of the trace scope. + readOnly: true + type: string + format: google-datetime + ListTraceScopesResponse: + id: ListTraceScopesResponse + description: Response for listing TraceScopes. + type: object + properties: + traceScopes: + description: Optional. A list of trace scopes. + type: array + items: + $ref: '#/components/schemas/TraceScope' + nextPageToken: + description: >- + Optional. If there might be more results than appear in this + response, then `next_page_token` is included. To get the next set of + results, call the same method again using the value of + `next_page_token` as `page_token`. + type: string + ListLocationsResponse: + id: ListLocationsResponse + description: The response message for Locations.ListLocations. + type: object + properties: + locations: + description: >- + A list of locations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/Location' + nextPageToken: + description: The standard List next-page token. + type: string + Location: + id: Location + description: A resource that represents a Google Cloud location. + type: object + properties: + name: + description: >- + Resource name for the location, which may vary between + implementations. For example: + `"projects/example-project/locations/us-east1"` + type: string + locationId: + description: 'The canonical id for this location. For example: `"us-east1"`.' + type: string + displayName: + description: >- + The friendly name for this location, typically a nearby city name. + For example, "Tokyo". + type: string + labels: + description: >- + Cross-service attributes for the location. For example + {"cloud.googleapis.com/region": "us-east1"} + type: object + additionalProperties: + type: string + metadata: + description: >- + Service-specific metadata. For example the available capacity at the + given location. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + OperationMetadata: + id: OperationMetadata + description: Represents the metadata of the long-running operation. + type: object + properties: + createTime: + description: Output only. The time the operation was created. + readOnly: true + type: string + format: google-datetime + endTime: + description: Output only. The time the operation finished running. + readOnly: true + type: string + format: google-datetime + target: + description: >- + Output only. Server-defined resource path for the target of the + operation. + readOnly: true + type: string + verb: + description: Output only. Name of the verb executed by the operation. + readOnly: true + type: string + statusMessage: + description: Output only. Human-readable status of the operation, if any. + readOnly: true + type: string + requestedCancellation: + description: >- + Output only. Identifies whether the user has requested cancellation + of the operation. Operations that have been cancelled successfully + have Operation.error value with a google.rpc.Status.code of 1, + corresponding to `Code.CANCELLED`. + readOnly: true + type: boolean + apiVersion: + description: Output only. API version used to start the operation. + readOnly: true + type: string + parameters: + 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: + type: string + enum: + - json + - media + - proto + 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 + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + x-stackQL-resources: + locations: + id: google.observability.locations + name: locations + title: Locations + methods: + list: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.locations + get: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + operations: + id: google.observability.operations + name: operations + title: Operations + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.operations + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + cancel: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' + insert: [] + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/operations/methods/delete' + scopes: + id: google.observability.scopes + name: scopes + title: Scopes + methods: + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1scopes~1{scopesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1scopes~1{scopesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/scopes/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/scopes/methods/patch' + replace: [] + delete: [] + trace_scopes: + id: google.observability.trace_scopes + name: trace_scopes + title: Trace_scopes + methods: + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1traceScopes~1{traceScopesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1traceScopes~1{traceScopesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1traceScopes~1{traceScopesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1traceScopes/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.traceScopes + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1traceScopes/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/trace_scopes/methods/get' + - $ref: '#/components/x-stackQL-resources/trace_scopes/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/trace_scopes/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/trace_scopes/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/trace_scopes/methods/delete' +paths: + /v1/projects/{projectsId}/locations: + parameters: &ref_1 + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' + get: + description: Lists information about the supported locations for this service. + operationId: observability.projects.locations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListLocationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: extraLocationTypes + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}: + parameters: *ref_1 + get: + description: Gets information about a location. + operationId: observability.projects.locations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Location' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: observability.projects.locations.operations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListOperationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: observability.projects.locations.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + delete: + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: observability.projects.locations.operations.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + `1`, corresponding to `Code.CANCELLED`. + operationId: observability.projects.locations.operations.cancel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CancelOperationRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/scopes/{scopesId}: + parameters: *ref_1 + get: + description: Gets details of a single Scope. + operationId: observability.projects.locations.scopes.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Scope' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: scopesId + required: true + schema: + type: string + patch: + description: Updates the parameters of a single Scope. + operationId: observability.projects.locations.scopes.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Scope' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Scope' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: scopesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/traceScopes/{traceScopesId}: + parameters: *ref_1 + get: + description: Get TraceScope resource. + operationId: observability.projects.locations.traceScopes.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/TraceScope' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: traceScopesId + required: true + schema: + type: string + patch: + description: Update a TraceScope. + operationId: observability.projects.locations.traceScopes.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TraceScope' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/TraceScope' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: traceScopesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Delete a TraceScope. + operationId: observability.projects.locations.traceScopes.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: traceScopesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/traceScopes: + parameters: *ref_1 + get: + description: List TraceScopes of a project in a particular location. + operationId: observability.projects.locations.traceScopes.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListTraceScopesResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + post: + description: Create a new TraceScope. + operationId: observability.projects.locations.traceScopes.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TraceScope' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/TraceScope' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: traceScopeId + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/ondemandscanning.yaml b/providers/src/googleapis.com/v00.00.00000/services/ondemandscanning.yaml index c3d0d57c..df6cf9f7 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/ondemandscanning.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/ondemandscanning.yaml @@ -7,8 +7,8 @@ info: title: On-Demand Scanning API description: A service to scan container images for vulnerabilities. version: v1 - x-discovery-doc-revision: '20241028' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250815' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/container-analysis/docs/on-demand-scanning/ servers: @@ -201,7 +201,7 @@ components: - NPM packages. - Nuget (C#/.NET) packages. - Ruby packges (from RubyGems package manager). - - Rust packages from Cargo (Github ecosystem is `RUST`). + - Rust packages from Cargo (GitHub ecosystem is `RUST`). - PHP packages from Composer package manager. - Swift packages from Swift Package Manager (SwiftPM). enum: @@ -229,9 +229,7 @@ components: items: $ref: '#/components/schemas/FileLocation' patchedCve: - description: >- - CVEs that this package is no longer vulnerable to - go/drydock-dd-custom-binary-scanning + description: CVEs that this package is no longer vulnerable to type: array items: type: string @@ -272,6 +270,8 @@ components: type: array items: type: string + layerDetails: + $ref: '#/components/schemas/LayerDetails' FileLocation: id: FileLocation description: Indicates the location at which a package was found. @@ -282,6 +282,52 @@ components: For jars that are contained inside .war files, this filepath can indicate the path to war file combined with the path to jar file. type: string + layerDetails: + $ref: '#/components/schemas/LayerDetails' + LayerDetails: + id: LayerDetails + description: Details about the layer a package was found in. + type: object + properties: + index: + description: The index of the layer in the container image. + type: integer + format: int32 + diffId: + description: The diff ID (sha256 hash) of the layer in the container image. + type: string + chainId: + description: >- + The layer chain ID (sha256 hash) of the layer in the container + image. + https://github.com/opencontainers/image-spec/blob/main/config.md#layer-chainid + type: string + command: + description: >- + The layer build command that was used to build the layer. This may + not be found in all layers depending on how the container image is + built. + type: string + baseImages: + description: The base images the layer is found within. + type: array + items: + $ref: '#/components/schemas/BaseImage' + BaseImage: + id: BaseImage + description: BaseImage describes a base image of a container image. + type: object + properties: + name: + description: The name of the base image. + type: string + repository: + description: The repository name in which the base image is from. + type: string + layerCount: + description: The number of layers that the base image is composed of. + type: integer + format: int32 LanguagePackageDependency: id: LanguagePackageDependency description: >- @@ -333,7 +379,7 @@ components: than the binary itself. Historically if they've differed, we've stored the name of the source and its version in the package/version fields, but we should also store the binary package info, as that's - what's actually installed. See b/175908657#comment15. + what's actually installed. $ref: '#/components/schemas/PackageVersion' sourceVersion: description: >- @@ -403,6 +449,7 @@ components: - This represents a DSSE attestation Note - This represents a Vulnerability Assessment. - This represents an SBOM Reference. + - This represents a secret. enum: - NOTE_KIND_UNSPECIFIED - VULNERABILITY @@ -417,6 +464,7 @@ components: - DSSE_ATTESTATION - VULNERABILITY_ASSESSMENT - SBOM_REFERENCE + - SECRET remediation: description: A description of actions that can be taken to remedy the note. type: string @@ -463,6 +511,9 @@ components: sbomReference: description: Describes a specific SBOM reference occurrences. $ref: '#/components/schemas/SBOMReferenceOccurrence' + secret: + description: Describes a secret. + $ref: '#/components/schemas/SecretOccurrence' envelope: description: https://github.com/secure-systems-lab/dsse $ref: '#/components/schemas/Envelope' @@ -573,6 +624,9 @@ components: extraDetails: description: Occurrence-specific extra details about the vulnerability. type: string + risk: + description: Risk information about the vulnerability, such as CISA, EPSS, etc. + $ref: '#/components/schemas/Risk' CVSS: id: CVSS description: >- @@ -840,6 +894,57 @@ components: For jars that are contained inside .war files, this filepath can indicate the path to war file combined with the path to jar file. type: string + layerDetails: + description: >- + Each package found in a file should have its own layer metadata + (that is, information from the origin layer of the package). + $ref: '#/components/schemas/GrafeasV1LayerDetails' + GrafeasV1LayerDetails: + id: GrafeasV1LayerDetails + description: Details about the layer a package was found in. + type: object + properties: + index: + description: The index of the layer in the container image. + type: integer + format: int32 + diffId: + description: >- + The diff ID (typically a sha256 hash) of the layer in the container + image. + type: string + chainId: + description: >- + The layer chain ID (sha256 hash) of the layer in the container + image. + https://github.com/opencontainers/image-spec/blob/main/config.md#layer-chainid + type: string + command: + description: >- + The layer build command that was used to build the layer. This may + not be found in all layers depending on how the container image is + built. + type: string + baseImages: + description: The base images the layer is found within. + type: array + items: + $ref: '#/components/schemas/GrafeasV1BaseImage' + GrafeasV1BaseImage: + id: GrafeasV1BaseImage + description: BaseImage describes a base image of a container image. + type: object + properties: + name: + description: The name of the base image. + type: string + repository: + description: The repository name in which the base image is from. + type: string + layerCount: + description: The number of layers that the base image is composed of. + type: integer + format: int32 RelatedUrl: id: RelatedUrl description: Metadata for any related URL information. @@ -991,6 +1096,46 @@ components: details: description: Additional details on why this justification was chosen. type: string + Risk: + id: Risk + type: object + properties: + cisaKev: + description: >- + CISA maintains the authoritative source of vulnerabilities that have + been exploited in the wild. + $ref: '#/components/schemas/CISAKnownExploitedVulnerabilities' + epss: + description: >- + The Exploit Prediction Scoring System (EPSS) estimates the + likelihood (probability) that a software vulnerability will be + exploited in the wild. + $ref: '#/components/schemas/ExploitPredictionScoringSystem' + CISAKnownExploitedVulnerabilities: + id: CISAKnownExploitedVulnerabilities + type: object + properties: + knownRansomwareCampaignUse: + description: >- + Whether the vulnerability is known to have been leveraged as part of + a ransomware campaign. + type: string + ExploitPredictionScoringSystem: + id: ExploitPredictionScoringSystem + type: object + properties: + percentile: + description: >- + The percentile of the current score, the proportion of all scored + vulnerabilities with the same or a lower EPSS score + type: number + format: double + score: + description: >- + The EPSS score representing the probability [0-1] of exploitation in + the wild in the next 30 days + type: number + format: double BuildOccurrence: id: BuildOccurrence description: Details of a build occurrence. @@ -2137,6 +2282,11 @@ components: sbomStatus: description: The status of an SBOM generation. $ref: '#/components/schemas/SBOMStatus' + files: + description: Files that make up the resource described by the occurrence. + type: array + items: + $ref: '#/components/schemas/File' AnalysisCompleted: id: AnalysisCompleted description: >- @@ -2169,6 +2319,16 @@ components: If there was an error generating an SBOM, this will indicate what that error was. type: string + File: + id: File + type: object + properties: + name: + type: string + digest: + type: object + additionalProperties: + type: string AttestationOccurrence: id: AttestationOccurrence description: >- @@ -2552,6 +2712,67 @@ components: type: object additionalProperties: type: string + SecretOccurrence: + id: SecretOccurrence + description: The occurrence provides details of a secret. + type: object + properties: + kind: + description: Required. Type of secret. + type: string + enumDescriptions: + - Unspecified + - The secret kind is unknown. + - >- + A GCP service account key per: + https://cloud.google.com/iam/docs/creating-managing-service-account-keys + enum: + - SECRET_KIND_UNSPECIFIED + - SECRET_KIND_UNKNOWN + - SECRET_KIND_GCP_SERVICE_ACCOUNT_KEY + locations: + description: Optional. Locations where the secret is detected. + type: array + items: + $ref: '#/components/schemas/SecretLocation' + statuses: + description: Optional. Status of the secret. + type: array + items: + $ref: '#/components/schemas/SecretStatus' + SecretLocation: + id: SecretLocation + description: The location of the secret. + type: object + properties: + fileLocation: + description: The secret is found from a file. + $ref: '#/components/schemas/GrafeasV1FileLocation' + SecretStatus: + id: SecretStatus + description: The status of the secret with a timestamp. + type: object + properties: + status: + description: Optional. The status of the secret. + type: string + enumDescriptions: + - Unspecified + - The status of the secret is unknown. + - The secret is valid. + - The secret is invalid. + enum: + - STATUS_UNSPECIFIED + - UNKNOWN + - VALID + - INVALID + updateTime: + description: Optional. The time the secret status was last updated. + type: string + format: google-datetime + message: + description: Optional. Optional message about the status code. + type: string AnalyzePackagesMetadataV1: id: AnalyzePackagesMetadataV1 description: >- @@ -2907,7 +3128,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: ondemandscanning.projects.locations.operations.cancel security: - Oauth2: diff --git a/providers/src/googleapis.com/v00.00.00000/services/oracledatabase.yaml b/providers/src/googleapis.com/v00.00.00000/services/oracledatabase.yaml index 0d1c3ede..f55101fe 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/oracledatabase.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/oracledatabase.yaml @@ -9,8 +9,8 @@ info: The Oracle Database@Google Cloud API provides a set of APIs to manage Oracle database services, such as Exadata and Autonomous Databases. version: v1 - x-discovery-doc-revision: '20241017' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250825' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/oracle/database/docs servers: @@ -178,8 +178,9 @@ components: type: string gcpOracleZone: description: >- - Optional. Google Cloud Platform location where Oracle Exadata is - hosted. + Optional. The GCP Oracle zone where Oracle Exadata Infrastructure is + hosted. Example: us-east4-b-r2. If not specified, the system will + pick a zone based on availability. type: string entitlementId: description: >- @@ -374,6 +375,31 @@ components: (dom0) in the Exadata Infrastructure. Example: 20.1.15 readOnly: true type: string + computeModel: + description: Output only. The compute model of the Exadata Infrastructure. + readOnly: true + type: string + enumDescriptions: + - Unspecified compute model. + - >- + Abstract measure of compute resources. ECPUs are based on the + number of cores elastically allocated from a pool of compute and + storage servers. + - >- + Physical measure of compute resources. OCPUs are based on the + physical core of a processor. + enum: + - COMPUTE_MODEL_UNSPECIFIED + - COMPUTE_MODEL_ECPU + - COMPUTE_MODEL_OCPU + databaseServerType: + description: Output only. The database server type of the Exadata Infrastructure. + readOnly: true + type: string + storageServerType: + description: Output only. The storage server type of the Exadata Infrastructure. + readOnly: true + type: string MaintenanceWindow: id: MaintenanceWindow description: >- @@ -557,13 +583,6 @@ components: displayName: description: Optional. User friendly name for this resource. type: string - gcpOracleZone: - description: >- - Output only. Google Cloud Platform location where Oracle Exadata is - hosted. It is same as Google Cloud Platform Oracle zone of Exadata - infrastructure. - readOnly: true - type: string properties: description: Optional. Various properties of the VM Cluster. $ref: '#/components/schemas/CloudVmClusterProperties' @@ -578,16 +597,43 @@ components: type: string format: google-datetime cidr: - description: Required. Network settings. CIDR to use for cluster IP allocation. + description: Optional. Network settings. CIDR to use for cluster IP allocation. type: string backupSubnetCidr: - description: Required. CIDR range of the backup subnet. + description: Optional. CIDR range of the backup subnet. type: string network: description: >- - Required. The name of the VPC network. Format: + Optional. The name of the VPC network. Format: projects/{project}/global/networks/{network} type: string + gcpOracleZone: + description: >- + Output only. The GCP Oracle zone where Oracle CloudVmCluster is + hosted. This will be the same as the gcp_oracle_zone of the + CloudExadataInfrastructure. Example: us-east4-b-r2. + readOnly: true + type: string + odbNetwork: + description: >- + Optional. The name of the OdbNetwork associated with the VM Cluster. + Format: + projects/{project}/locations/{location}/odbNetworks/{odb_network} It + is optional but if specified, this should match the parent + ODBNetwork of the odb_subnet and backup_odb_subnet. + type: string + odbSubnet: + description: >- + Optional. The name of the OdbSubnet associated with the VM Cluster + for IP allocation. Format: + projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet} + type: string + backupOdbSubnet: + description: >- + Optional. The name of the backup OdbSubnet associated with the VM + Cluster. Format: + projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet} + type: string CloudVmClusterProperties: id: CloudVmClusterProperties description: Various properties and settings associated with Exadata VM cluster. @@ -730,8 +776,7 @@ components: type: integer format: int32 systemVersion: - description: Output only. Operating system version of the image. - readOnly: true + description: Optional. Operating system version of the image. type: string scanIpIds: description: Output only. OCIDs of scan IPs. @@ -763,6 +808,23 @@ components: clusterName: description: Optional. OCI Cluster name. type: string + computeModel: + description: Output only. The compute model of the VM Cluster. + readOnly: true + type: string + enumDescriptions: + - Unspecified compute model. + - >- + Abstract measure of compute resources. ECPUs are based on the + number of cores elastically allocated from a pool of compute and + storage servers. + - >- + Physical measure of compute resources. OCPUs are based on the + physical core of a processor. + enum: + - COMPUTE_MODEL_UNSPECIFIED + - COMPUTE_MODEL_ECPU + - COMPUTE_MODEL_OCPU TimeZone: id: TimeZone description: >- @@ -771,10 +833,12 @@ components: type: object properties: id: - description: IANA Time Zone Database time zone, e.g. "America/New_York". + description: IANA Time Zone Database time zone. For example "America/New_York". type: string version: - description: Optional. IANA Time Zone Database version number, e.g. "2019a". + description: >- + Optional. IANA Time Zone Database version number. For example + "2019a". type: string DataCollectionOptions: id: DataCollectionOptions @@ -835,11 +899,15 @@ components: - Account not linked. - Account is linked but not active. - Entitlement and Account are active. + - Account is suspended. + - Entitlement is not approved in private marketplace. enum: - STATE_UNSPECIFIED - ACCOUNT_NOT_LINKED - ACCOUNT_NOT_ACTIVE - ACTIVE + - ACCOUNT_SUSPENDED + - NOT_APPROVED_IN_PRIVATE_MARKETPLACE CloudAccountDetails: id: CloudAccountDetails description: Details of the OCI Cloud Account. @@ -1042,6 +1110,11 @@ components: description: Total CPU core count of the database node. type: integer format: int32 + createTime: + description: Output only. The date and time that the database node was created. + readOnly: true + type: string + format: google-datetime ListGiVersionsResponse: id: ListGiVersionsResponse description: The response for `GiVersion.List`. @@ -1198,13 +1271,42 @@ components: type: string network: description: >- - Required. The name of the VPC network used by the Autonomous + Optional. The name of the VPC network used by the Autonomous Database in the following format: projects/{project}/global/networks/{network} type: string cidr: - description: Required. The subnet CIDR range for the Autonmous Database. + description: Optional. The subnet CIDR range for the Autonomous Database. + type: string + odbNetwork: + description: >- + Optional. The name of the OdbNetwork associated with the Autonomous + Database. Format: + projects/{project}/locations/{location}/odbNetworks/{odb_network} It + is optional but if specified, this should match the parent + ODBNetwork of the OdbSubnet. + type: string + odbSubnet: + description: >- + Optional. The name of the OdbSubnet associated with the Autonomous + Database. Format: + projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet} type: string + sourceConfig: + description: >- + Optional. The source Autonomous Database configuration for the + standby Autonomous Database. The source Autonomous Database is + configured while creating the Peer Autonomous Database and can't be + updated after creation. + $ref: '#/components/schemas/SourceConfig' + peerAutonomousDatabases: + description: >- + Output only. The peer Autonomous Database names of the given + Autonomous Database. + readOnly: true + type: array + items: + type: string createTime: description: >- Output only. The date and time that the Autonomous Database was @@ -1212,6 +1314,15 @@ components: readOnly: true type: string format: google-datetime + disasterRecoverySupportedLocations: + description: >- + Output only. List of supported GCP region to clone the Autonomous + Database for disaster recovery. Format: + `project/{project}/locations/{location}`. + readOnly: true + type: array + items: + type: string AutonomousDatabaseProperties: id: AutonomousDatabaseProperties description: The properties of an Autonomous Database. @@ -1714,6 +1825,20 @@ components: readOnly: true type: string format: google-datetime + dataGuardRoleChangedTime: + description: >- + Output only. The date and time the Autonomous Data Guard role was + changed for the standby Autonomous Database. + readOnly: true + type: string + format: google-datetime + disasterRecoveryRoleChangedTime: + description: >- + Output only. The date and time the Disaster Recovery role was + changed for the standby Autonomous Database. + readOnly: true + type: string + format: google-datetime maintenanceBeginTime: description: Output only. The date and time when maintenance will begin. readOnly: true @@ -1724,6 +1849,13 @@ components: readOnly: true type: string format: google-datetime + allowlistedIps: + description: >- + Optional. The list of allowlisted IP addresses for the Autonomous + Database. + type: array + items: + type: string AutonomousDatabaseApex: id: AutonomousDatabaseApex description: >- @@ -2133,6 +2265,21 @@ components: to 0 and less than or equal to 999,999,999. type: integer format: int32 + SourceConfig: + id: SourceConfig + description: The source configuration for the standby Autonomous Database. + type: object + properties: + autonomousDatabase: + description: >- + Optional. The name of the primary Autonomous Database that is used + to create a Peer Autonomous Database from a source. + type: string + automaticBackupsReplicationEnabled: + description: >- + Optional. This field specifies if the replication of automatic + backups is enabled when creating a Data Guard. + type: boolean RestoreAutonomousDatabaseRequest: id: RestoreAutonomousDatabaseRequest description: The request for `AutonomousDatabase.Restore`. @@ -2451,6 +2598,168 @@ components: vaultId: description: Optional. The OCID of the vault. type: string + StopAutonomousDatabaseRequest: + id: StopAutonomousDatabaseRequest + description: The request for `AutonomousDatabase.Stop`. + type: object + properties: {} + StartAutonomousDatabaseRequest: + id: StartAutonomousDatabaseRequest + description: The request for `AutonomousDatabase.Start`. + type: object + properties: {} + RestartAutonomousDatabaseRequest: + id: RestartAutonomousDatabaseRequest + description: The request for `AutonomousDatabase.Restart`. + type: object + properties: {} + SwitchoverAutonomousDatabaseRequest: + id: SwitchoverAutonomousDatabaseRequest + description: The request for `OracleDatabase.SwitchoverAutonomousDatabase`. + type: object + properties: + peerAutonomousDatabase: + description: Required. The peer database name to switch over to. + type: string + ListOdbNetworksResponse: + id: ListOdbNetworksResponse + description: The response for `OdbNetwork.List`. + type: object + properties: + odbNetworks: + description: The list of ODB Networks. + type: array + items: + $ref: '#/components/schemas/OdbNetwork' + nextPageToken: + description: A token identifying a page of results the server should return. + type: string + unreachable: + description: >- + Unreachable locations when listing resources across all locations + using wildcard location '-'. + type: array + items: + type: string + OdbNetwork: + id: OdbNetwork + description: Represents OdbNetwork resource. + type: object + properties: + name: + description: >- + Identifier. The name of the OdbNetwork resource in the following + format: + projects/{project}/locations/{region}/odbNetworks/{odb_network} + type: string + network: + description: >- + Required. The name of the VPC network in the following format: + projects/{project}/global/networks/{network} + type: string + labels: + description: Optional. Labels or tags associated with the resource. + type: object + additionalProperties: + type: string + createTime: + description: Output only. The date and time that the OdbNetwork was created. + readOnly: true + type: string + format: google-datetime + state: + description: Output only. State of the ODB Network. + readOnly: true + type: string + enumDescriptions: + - Default unspecified value. + - Indicates that the resource is in provisioning state. + - Indicates that the resource is in available state. + - Indicates that the resource is in terminating state. + - Indicates that the resource is in failed state. + enum: + - STATE_UNSPECIFIED + - PROVISIONING + - AVAILABLE + - TERMINATING + - FAILED + entitlementId: + description: >- + Output only. The ID of the subscription entitlement associated with + the OdbNetwork. + readOnly: true + type: string + ListOdbSubnetsResponse: + id: ListOdbSubnetsResponse + description: The response for `OdbSubnet.List`. + type: object + properties: + odbSubnets: + description: The list of ODB Subnets. + type: array + items: + $ref: '#/components/schemas/OdbSubnet' + nextPageToken: + description: A token identifying a page of results the server should return. + type: string + unreachable: + description: >- + Unreachable locations when listing resources across all locations + using wildcard location '-'. + type: array + items: + type: string + OdbSubnet: + id: OdbSubnet + description: Represents OdbSubnet resource. + type: object + properties: + name: + description: >- + Identifier. The name of the OdbSubnet resource in the following + format: + projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet} + type: string + cidrRange: + description: Required. The CIDR range of the subnet. + type: string + purpose: + description: Required. Purpose of the subnet. + type: string + enumDescriptions: + - Default unspecified value. + - Subnet to be used for client connections. + - Subnet to be used for backup. + enum: + - PURPOSE_UNSPECIFIED + - CLIENT_SUBNET + - BACKUP_SUBNET + labels: + description: Optional. Labels or tags associated with the resource. + type: object + additionalProperties: + type: string + createTime: + description: Output only. The date and time that the OdbNetwork was created. + readOnly: true + type: string + format: google-datetime + state: + description: Output only. State of the ODB Subnet. + readOnly: true + type: string + enumDescriptions: + - Default unspecified value. + - Indicates that the resource is in provisioning state. + - Indicates that the resource is in available state. + - Indicates that the resource is in terminating state. + - Indicates that the resource is in failed state. + enum: + - STATE_UNSPECIFIED + - PROVISIONING + - AVAILABLE + - TERMINATING + - FAILED ListLocationsResponse: id: ListLocationsResponse description: The response message for Locations.ListLocations. @@ -2949,6 +3258,34 @@ components: response: mediaType: application/json openAPIDocKey: '200' + stop: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1autonomousDatabases~1{autonomousDatabasesId}:stop/post + response: + mediaType: application/json + openAPIDocKey: '200' + start: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1autonomousDatabases~1{autonomousDatabasesId}:start/post + response: + mediaType: application/json + openAPIDocKey: '200' + restart: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1autonomousDatabases~1{autonomousDatabasesId}:restart/post + response: + mediaType: application/json + openAPIDocKey: '200' + switchover: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1autonomousDatabases~1{autonomousDatabasesId}:switchover/post + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/autonomous_databases/methods/get' @@ -3024,61 +3361,153 @@ components: update: [] replace: [] delete: [] -paths: - /v1/projects/{projectsId}/locations: - parameters: &ref_1 - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/_.xgafv' - get: - description: Lists information about the supported locations for this service. - operationId: oracledatabase.projects.locations.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/ListLocationsResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_1 - get: - description: Gets information about a location. - operationId: oracledatabase.projects.locations.get - security: - - Oauth2: + odb_networks: + id: google.oracledatabase.odb_networks + name: odb_networks + title: Odb_networks + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1odbNetworks/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.odbNetworks + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1odbNetworks/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1odbNetworks~1{odbNetworksId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1odbNetworks~1{odbNetworksId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/odb_networks/methods/get' + - $ref: '#/components/x-stackQL-resources/odb_networks/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/odb_networks/methods/create' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/odb_networks/methods/delete' + odb_subnets: + id: google.oracledatabase.odb_subnets + name: odb_subnets + title: Odb_subnets + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1odbNetworks~1{odbNetworksId}~1odbSubnets/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.odbSubnets + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1odbNetworks~1{odbNetworksId}~1odbSubnets/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1odbNetworks~1{odbNetworksId}~1odbSubnets~1{odbSubnetsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1odbNetworks~1{odbNetworksId}~1odbSubnets~1{odbSubnetsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/odb_subnets/methods/get' + - $ref: '#/components/x-stackQL-resources/odb_subnets/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/odb_subnets/methods/create' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/odb_subnets/methods/delete' +paths: + /v1/projects/{projectsId}/locations: + parameters: &ref_1 + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' + get: + description: Lists information about the supported locations for this service. + operationId: oracledatabase.projects.locations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListLocationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: extraLocationTypes + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}: + parameters: *ref_1 + get: + description: Gets information about a location. + operationId: oracledatabase.projects.locations.get + security: + - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform @@ -3226,7 +3655,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: oracledatabase.projects.locations.operations.cancel requestBody: content: @@ -3722,6 +4151,10 @@ paths: name: pageToken schema: type: string + - in: query + name: filter + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/dbSystemShapes: parameters: *ref_1 get: @@ -3987,13 +4420,16 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/autonomousDbVersions: + /v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabases/{autonomousDatabasesId}:stop: parameters: *ref_1 - get: - description: >- - Lists all the available Autonomous Database versions for a project and - location. - operationId: oracledatabase.projects.locations.autonomousDbVersions.list + post: + description: Stops an Autonomous Database. + operationId: oracledatabase.projects.locations.autonomousDatabases.stop + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StopAutonomousDatabaseRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4005,7 +4441,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListAutonomousDbVersionsResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -4017,22 +4453,21 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: autonomousDatabasesId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabaseCharacterSets: + /v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabases/{autonomousDatabasesId}:start: parameters: *ref_1 - get: - description: >- - Lists Autonomous Database Character Sets in a given project and - location. - operationId: oracledatabase.projects.locations.autonomousDatabaseCharacterSets.list + post: + description: Starts an Autonomous Database. + operationId: oracledatabase.projects.locations.autonomousDatabases.start + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StartAutonomousDatabaseRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4044,8 +4479,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/ListAutonomousDatabaseCharacterSetsResponse + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -4057,24 +4491,61 @@ paths: required: true schema: type: string - - in: query - name: pageSize + - in: path + name: autonomousDatabasesId + required: true schema: - type: integer - format: int32 - - in: query - name: pageToken + type: string + /v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabases/{autonomousDatabasesId}:restart: + parameters: *ref_1 + post: + description: Restarts an Autonomous Database. + operationId: oracledatabase.projects.locations.autonomousDatabases.restart + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RestartAutonomousDatabaseRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true schema: type: string - - in: query - name: filter + - in: path + name: locationsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabaseBackups: + - in: path + name: autonomousDatabasesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabases/{autonomousDatabasesId}:switchover: parameters: *ref_1 - get: - description: Lists the long-term and automatic backups of an Autonomous Database. - operationId: oracledatabase.projects.locations.autonomousDatabaseBackups.list + post: + description: >- + Initiates a switchover of specified autonomous database to the + associated peer database. + operationId: oracledatabase.projects.locations.autonomousDatabases.switchover + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SwitchoverAutonomousDatabaseRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4086,7 +4557,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListAutonomousDatabaseBackupsResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -4098,8 +4569,39 @@ paths: required: true schema: type: string - - in: query - name: filter + - in: path + name: autonomousDatabasesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/autonomousDbVersions: + parameters: *ref_1 + get: + description: >- + Lists all the available Autonomous Database versions for a project and + location. + operationId: oracledatabase.projects.locations.autonomousDbVersions.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListAutonomousDbVersionsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true schema: type: string - in: query @@ -4111,3 +4613,412 @@ paths: name: pageToken schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabaseCharacterSets: + parameters: *ref_1 + get: + description: >- + Lists Autonomous Database Character Sets in a given project and + location. + operationId: oracledatabase.projects.locations.autonomousDatabaseCharacterSets.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/ListAutonomousDatabaseCharacterSetsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabaseBackups: + parameters: *ref_1 + get: + description: Lists the long-term and automatic backups of an Autonomous Database. + operationId: oracledatabase.projects.locations.autonomousDatabaseBackups.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListAutonomousDatabaseBackupsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/odbNetworks: + parameters: *ref_1 + get: + description: Lists the ODB Networks in a given project and location. + operationId: oracledatabase.projects.locations.odbNetworks.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListOdbNetworksResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + post: + description: Creates a new ODB Network in a given project and location. + operationId: oracledatabase.projects.locations.odbNetworks.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OdbNetwork' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: odbNetworkId + schema: + type: string + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}: + parameters: *ref_1 + get: + description: Gets details of a single ODB Network. + operationId: oracledatabase.projects.locations.odbNetworks.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/OdbNetwork' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: odbNetworksId + required: true + schema: + type: string + delete: + description: Deletes a single ODB Network. + operationId: oracledatabase.projects.locations.odbNetworks.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: odbNetworksId + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}/odbSubnets: + parameters: *ref_1 + get: + description: Lists all the ODB Subnets in a given ODB Network. + operationId: oracledatabase.projects.locations.odbNetworks.odbSubnets.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListOdbSubnetsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: odbNetworksId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + post: + description: Creates a new ODB Subnet in a given ODB Network. + operationId: oracledatabase.projects.locations.odbNetworks.odbSubnets.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OdbSubnet' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: odbNetworksId + required: true + schema: + type: string + - in: query + name: odbSubnetId + schema: + type: string + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}/odbSubnets/{odbSubnetsId}: + parameters: *ref_1 + get: + description: Gets details of a single ODB Subnet. + operationId: oracledatabase.projects.locations.odbNetworks.odbSubnets.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/OdbSubnet' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: odbNetworksId + required: true + schema: + type: string + - in: path + name: odbSubnetsId + required: true + schema: + type: string + delete: + description: Deletes a single ODB Subnet. + operationId: oracledatabase.projects.locations.odbNetworks.odbSubnets.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: odbNetworksId + required: true + schema: + type: string + - in: path + name: odbSubnetsId + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/orgpolicy.yaml b/providers/src/googleapis.com/v00.00.00000/services/orgpolicy.yaml index 54a1610a..9bf0670c 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/orgpolicy.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/orgpolicy.yaml @@ -9,8 +9,8 @@ info: The Organization Policy API allows users to configure governance rules on their Google Cloud resources across the resource hierarchy. version: v2 - x-discovery-doc-revision: '20241021' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250822' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/orgpolicy/docs/reference/rest/index.html servers: @@ -36,140 +36,134 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleTypeExpr: + GoogleCloudOrgpolicyV2ListConstraintsResponse: + id: GoogleCloudOrgpolicyV2ListConstraintsResponse + description: The response returned from the ListConstraints method. type: object properties: - title: - type: string - 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. - 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 - location: - type: string + constraints: description: >- - Optional. String indicating the location of the expression for error - reporting, e.g. a file name and a position in the file. - expression: + The collection of constraints that are available on the targeted + resource. + type: array + items: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Constraint' + nextPageToken: description: >- - Textual representation of an expression in Common Expression - Language syntax. + Page token used to retrieve the next page. This is currently not + used. type: string - id: GoogleTypeExpr + GoogleCloudOrgpolicyV2Constraint: + id: GoogleCloudOrgpolicyV2Constraint 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. - GoogleCloudOrgpolicyV2AlternatePolicySpec: - id: GoogleCloudOrgpolicyV2AlternatePolicySpec + A constraint describes a way to restrict resource's configuration. For + example, you could enforce a constraint that controls which Google Cloud + services can be activated across an organization, or whether a Compute + Engine instance can have serial port connections established. + Constraints can be configured by the organization policy administrator + to fit the needs of the organization by setting a policy that includes + constraints at different locations in the organization's resource + hierarchy. Policies are inherited down the resource hierarchy from + higher levels, but can also be overridden. For details about the + inheritance rules, see `Policy`. Constraints have a default behavior + determined by the `constraint_default` field, which is the enforcement + behavior that is used in the absence of a policy being defined or + inherited for the resource in question. + type: object properties: - spec: - description: Specify constraint for configurations of Google Cloud resources. - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' - launch: + name: description: >- - Reference to the launch that will be used while audit logging and to - control the launch. Should be set only in the alternate policy. + Immutable. The resource name of the constraint. Must be in one of + the following forms: * + `projects/{project_number}/constraints/{constraint_name}` * + `folders/{folder_id}/constraints/{constraint_name}` * + `organizations/{organization_id}/constraints/{constraint_name}` For + example, + "/projects/123/constraints/compute.disableSerialPortAccess". type: string - type: object - description: >- - Similar to PolicySpec but with an extra 'launch' field for launch - reference. The PolicySpec here is specific for dry-run/darklaunch. - GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinitionParameter: - description: Defines a parameter structure. - id: GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinitionParameter - properties: - metadata: - $ref: >- - #/components/schemas/GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinitionParameterMetadata + displayName: + description: The human readable name. Mutable. + type: string + description: description: >- - Defines subproperties primarily used by the UI to display - user-friendly information. - item: - enum: - - TYPE_UNSPECIFIED - - LIST - - STRING - - BOOLEAN + Detailed description of what this constraint controls as well as how + and where it is enforced. Mutable. type: string + constraintDefault: description: >- - Determines the parameter’s value structure. For example, LIST can be - specified by defining type : LIST, and item type as : STRING. - enumDescriptions: - - Unspecified. Results in an error. - - List parameter type. - - String parameter type. - - Boolean parameter type. - type: + The evaluation behavior of this constraint in the absence of a + policy. + type: string enumDescriptions: - - Unspecified. Results in an error. - - List parameter type. - - String parameter type. - - Boolean parameter type. + - >- + This is only used for distinguishing unset values and should never + be used. Results in an error. + - >- + Indicate that all values are allowed for list constraints. + Indicate that enforcement is off for boolean constraints. + - >- + Indicate that all values are denied for list constraints. Indicate + that enforcement is on for boolean constraints. enum: - - TYPE_UNSPECIFIED - - LIST - - STRING - - BOOLEAN - description: Type of the parameter. - type: string - defaultValue: - type: any - description: >- - Sets the value of the parameter in an assignment if no value is - given. - validValuesExpr: + - CONSTRAINT_DEFAULT_UNSPECIFIED + - ALLOW + - DENY + listConstraint: + description: Defines this constraint as being a list constraint. + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2ConstraintListConstraint' + booleanConstraint: + description: Defines this constraint as being a boolean constraint. + $ref: >- + #/components/schemas/GoogleCloudOrgpolicyV2ConstraintBooleanConstraint + supportsDryRun: + description: Shows if dry run is supported for this constraint or not. + type: boolean + equivalentConstraint: description: >- - Provides a CEL expression to specify the acceptable parameter values - during assignment. For example, parameterName in ("parameterValue1", - "parameterValue2") + Managed constraint and canned constraint sometimes can have + equivalents. This field is used to store the equivalent constraint + name. type: string - type: object - GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinitionParameterMetadata: - description: Defines Medata structure. + supportsSimulation: + description: Shows if simulation is supported for this constraint or not. + type: boolean + GoogleCloudOrgpolicyV2ConstraintListConstraint: + id: GoogleCloudOrgpolicyV2ConstraintListConstraint + description: >- + A constraint type that allows or disallows a list of string values, + which are configured in the `PolicyRule`. type: object properties: - description: - type: string + supportsIn: description: >- - Detailed description of what this `parameter` is and use of it. - Mutable. - id: >- - GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinitionParameterMetadata - GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinition: - type: object + Indicates whether values grouped into categories can be used in + `Policy.allowed_values` and `Policy.denied_values`. For example, + `"in:Python"` would match any value in the 'Python' group. + type: boolean + supportsUnder: + description: >- + Indicates whether subtrees of the Resource Manager resource + hierarchy can be used in `Policy.allowed_values` and + `Policy.denied_values`. For example, `"under:folders/123"` would + match any resource under the 'folders/123' folder. + type: boolean + GoogleCloudOrgpolicyV2ConstraintBooleanConstraint: + id: GoogleCloudOrgpolicyV2ConstraintBooleanConstraint description: >- - Currently used for Managed Constraints. This represents a subset of - fields missing from Constraint proto that are required to describe - CustomConstraint + A constraint type is enforced or not enforced, which is configured in + the `PolicyRule`. If `customConstraintDefinition` is defined, this + constraint is a managed constraint. + type: object + properties: + customConstraintDefinition: + description: Custom constraint definition. Defines this as a managed constraint. + $ref: >- + #/components/schemas/GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinition + GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinition: id: GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinition + description: Custom constraint definition. Defines this as a managed constraint. + type: object properties: - parameters: - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinitionParameter - type: object - description: >- - Stores Structure of parameters used by Constraint condition. Key of - map represents name of the parameter. resourceTypes: description: >- The resource instance type on which this policy applies. Format will @@ -177,82 +171,20 @@ components: type: array items: type: string - actionType: - type: string - description: Allow or deny type. - enumDescriptions: - - Unspecified. Results in an error. - - Allowed action type. - - Deny action type. - enum: - - ACTION_TYPE_UNSPECIFIED - - ALLOW - - DENY - condition: - description: >- - Org policy condition/expression. For example: - `resource.instanceName.matches("[production|test]_.*_(\d)+")` or, - `resource.management.auto_upgrade == true` The max length of the - condition is 1000 characters. - type: string methodTypes: description: All the operations being applied for this constraint. type: array items: type: string - enum: - - METHOD_TYPE_UNSPECIFIED - - CREATE - - UPDATE - - DELETE - - REMOVE_GRANT - - GOVERN_TAGS enumDescriptions: - - Unspecified. Results in an error. - - Constraint applied when creating the resource. - - Constraint applied when updating the resource. - >- - Constraint applied when deleting the resource. Not supported - yet. - - Constraint applied when removing an IAM grant. - - Constraint applied when enforcing forced tagging. - GoogleProtobufEmpty: - description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } - properties: {} - id: GoogleProtobufEmpty - type: object - GoogleCloudOrgpolicyV2CustomConstraint: - id: GoogleCloudOrgpolicyV2CustomConstraint - type: object - description: >- - A custom constraint defined by customers which can *only* be applied to - the given resource types and organization. By creating a custom - constraint, customers can apply policies of this custom constraint. - *Creating a custom constraint itself does NOT apply any policy - enforcement*. - properties: - condition: - type: string - description: >- - Org policy condition/expression. For example: - `resource.instanceName.matches("[production|test]_.*_(\d)+")` or, - `resource.management.auto_upgrade == true` The max length of the - condition is 1000 characters. - methodTypes: - type: array - items: - type: string - enumDescriptions: - - Unspecified. Results in an error. + This is only used for distinguishing unset values and should + never be used. Results in an error. - Constraint applied when creating the resource. - Constraint applied when updating the resource. - >- - Constraint applied when deleting the resource. Not supported - yet. + Constraint applied when deleting the resource. Not currently + supported. - Constraint applied when removing an IAM grant. - Constraint applied when enforcing forced tagging. enum: @@ -262,121 +194,195 @@ components: - DELETE - REMOVE_GRANT - GOVERN_TAGS - description: All the operations being applied for this constraint. - displayName: + condition: description: >- - One line display name for the UI. The max length of the display_name - is 200 characters. + Org policy condition/expression. For example: + `resource.instanceName.matches("[production|test]_.*_(\d)+")` or, + `resource.management.auto_upgrade == true` The max length of the + condition is 1000 characters. type: string - name: - type: string - description: >- - Immutable. Name of the constraint. This is unique within the - organization. Format of the name should be * - `organizations/{organization_id}/customConstraints/{custom_constraint_id}` - Example: - `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The - max length is 70 characters and the minimum length is 1. Note that - the prefix `organizations/{organization_id}/customConstraints/` is - not counted. - updateTime: - description: >- - Output only. The last time this custom constraint was updated. This - represents the last time that the `CreateCustomConstraint` or - `UpdateCustomConstraint` RPC was called - readOnly: true - type: string - format: google-datetime - resourceTypes: - description: >- - Immutable. The resource instance type on which this policy applies. - Format will be of the form : `/` Example: * - `compute.googleapis.com/Instance`. - items: - type: string - type: array - description: - type: string - description: >- - Detailed information about this custom policy constraint. The max - length of the description is 2000 characters. actionType: + description: Allow or deny type. + type: string enumDescriptions: - - Unspecified. Results in an error. + - >- + This is only used for distinguishing unset values and should never + be used. Results in an error. - Allowed action type. - Deny action type. - type: string enum: - ACTION_TYPE_UNSPECIFIED - ALLOW - DENY - description: Allow or deny type. - GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues: + parameters: + description: >- + Stores the structure of `Parameters` used by the constraint + condition. The key of `map` represents the name of the parameter. + type: object + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinitionParameter + GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinitionParameter: + id: GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinitionParameter + description: Defines a parameter structure. + type: object properties: - deniedValues: + type: + description: Type of the parameter. + type: string + enumDescriptions: + - >- + This is only used for distinguishing unset values and should never + be used. Results in an error. + - List parameter type. + - String parameter type. + - Boolean parameter type. + enum: + - TYPE_UNSPECIFIED + - LIST + - STRING + - BOOLEAN + defaultValue: + description: >- + Sets the value of the parameter in an assignment if no value is + given. + type: any + validValuesExpr: + description: >- + Provides a CEL expression to specify the acceptable parameter values + during assignment. For example, parameterName in ("parameterValue1", + "parameterValue2") + type: string + metadata: + description: >- + Defines subproperties primarily used by the UI to display + user-friendly information. + $ref: >- + #/components/schemas/GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinitionParameterMetadata + item: + description: >- + Determines the parameter's value structure. For example, `LIST` can + be specified by defining `type: LIST`, and `item: STRING`. + type: string + enumDescriptions: + - >- + This is only used for distinguishing unset values and should never + be used. Results in an error. + - List parameter type. + - String parameter type. + - Boolean parameter type. + enum: + - TYPE_UNSPECIFIED + - LIST + - STRING + - BOOLEAN + GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinitionParameterMetadata: + id: >- + GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinitionParameterMetadata + description: Defines Metadata structure. + type: object + properties: + description: + description: >- + Detailed description of what this `parameter` is and use of it. + Mutable. + type: string + GoogleCloudOrgpolicyV2ListPoliciesResponse: + id: GoogleCloudOrgpolicyV2ListPoliciesResponse + description: >- + The response returned from the ListPolicies method. It will be empty if + no policies are set on the resource. + type: object + properties: + policies: + description: >- + All policies that exist on the resource. It will be empty if no + policies are set. type: array items: - type: string - description: List of values denied at this resource. - allowedValues: - items: - type: string - type: array - description: List of values allowed at this resource. - id: GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + nextPageToken: + description: >- + Page token used to retrieve the next page. This is currently not + used, but the server may at any point start supplying a valid token. + type: string + GoogleCloudOrgpolicyV2Policy: + id: GoogleCloudOrgpolicyV2Policy description: >- - A message that holds specific allowed and denied values. This message - can define specific values and subtrees of the Resource Manager resource - hierarchy (`Organizations`, `Folders`, `Projects`) that are allowed or - denied. This is achieved by using the `under:` and optional `is:` - prefixes. The `under:` prefix is used to denote resource subtree values. - The `is:` prefix is used to denote specific values, and is required only - if the value contains a ":". Values prefixed with "is:" are treated the - same as values with no prefix. Ancestry subtrees must be in one of the - following formats: - `projects/` (for example, - `projects/tokyo-rain-123`) - `folders/` (for example, `folders/1234`) - - `organizations/` (for example, `organizations/1234`) The - `supports_under` field of the associated `Constraint` defines whether - ancestry prefixes can be used. - type: object - GoogleCloudOrgpolicyV2ListConstraintsResponse: + Defines an organization policy which is used to specify constraints for + configurations of Google Cloud resources. type: object - id: GoogleCloudOrgpolicyV2ListConstraintsResponse properties: - constraints: - items: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Constraint' - type: array + name: description: >- - The collection of constraints that are available on the targeted - resource. - nextPageToken: + Immutable. The resource name of the policy. Must be one of the + following forms, where `constraint_name` is the name of the + constraint which this policy configures: * + `projects/{project_number}/policies/{constraint_name}` * + `folders/{folder_id}/policies/{constraint_name}` * + `organizations/{organization_id}/policies/{constraint_name}` For + example, `projects/123/policies/compute.disableSerialPortAccess`. + Note: `projects/{project_id}/policies/{constraint_name}` is also an + acceptable name for API requests, but responses will return the name + using the equivalent project number. type: string + spec: + description: Basic information about the organization policy. + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' + alternate: + description: Deprecated. + deprecated: true + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2AlternatePolicySpec' + dryRunSpec: description: >- - Page token used to retrieve the next page. This is currently not - used. - description: The response returned from the ListConstraints method. + Dry-run policy. Audit-only policy, can be used to monitor how the + policy would have impacted the existing and future resources if it's + enforced. + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' + etag: + description: >- + Optional. An opaque tag indicating the current state of the policy, + used for concurrency control. This 'etag' is computed by the server + based on the value of other fields, and may be sent on update and + delete requests to ensure the client has an up-to-date value before + proceeding. + type: string GoogleCloudOrgpolicyV2PolicySpec: + id: GoogleCloudOrgpolicyV2PolicySpec description: >- Defines a Google Cloud policy specification which is used to specify constraints for configurations of Google Cloud resources. + type: object properties: + etag: + description: >- + An opaque tag indicating the current version of the policySpec, used + for concurrency control. This field is ignored if used in a + `CreatePolicy` request. When the policy is returned from either a + `GetPolicy` or a `ListPolicies` request, this `etag` indicates the + version of the current policySpec to use when executing a + read-modify-write loop. When the policy is returned from a + `GetEffectivePolicy` request, the `etag` will be unset. + type: string updateTime: description: >- Output only. The time stamp this was previously updated. This represents the last time a call to `CreatePolicy` or `UpdatePolicy` was made for that policy. - format: google-datetime readOnly: true type: string - reset: - type: boolean + format: google-datetime + rules: description: >- - Ignores policies set above this resource and restores the - `constraint_default` enforcement behavior of the specific constraint - at this resource. This field can be set in policies for either list - or boolean constraints. If set, `rules` must be empty and - `inherit_from_parent` must be set to false. + In policies for boolean constraints, the following requirements + apply: - There must be one and only one policy rule where condition + is unset. - Boolean policy rules with conditions must set `enforced` + to the opposite of the policy rule without a condition. - During + policy evaluation, policy rules with conditions that are true for a + target resource take precedence. + type: array + items: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpecPolicyRule' inheritFromParent: description: >- Determines the inheritance behavior for this policy. If @@ -386,247 +392,270 @@ components: this policy becomes the new root for evaluation. This field can be set only for policies which configure list constraints. type: boolean - rules: - type: array + reset: description: >- - In policies for boolean constraints, the following requirements - apply: - There must be one and only one policy rule where condition - is unset. - Boolean policy rules with conditions must set `enforced` - to the opposite of the policy rule without a condition. - During - policy evaluation, policy rules with conditions that are true for a - target resource take precedence. - items: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpecPolicyRule' - etag: + Ignores policies set above this resource and restores the + `constraint_default` enforcement behavior of the specific constraint + at this resource. This field can be set in policies for either list + or boolean constraints. If set, `rules` must be empty and + `inherit_from_parent` must be set to false. + type: boolean + GoogleCloudOrgpolicyV2PolicySpecPolicyRule: + id: GoogleCloudOrgpolicyV2PolicySpecPolicyRule + description: A rule used to express this policy. + type: object + properties: + values: description: >- - An opaque tag indicating the current version of the policySpec, used - for concurrency control. This field is ignored if used in a - `CreatePolicy` request. When the policy is returned from either a - `GetPolicy` or a `ListPolicies` request, this `etag` indicates the - version of the current policySpec to use when executing a - read-modify-write loop. When the policy is returned from a - `GetEffectivePolicy` request, the `etag` will be unset. - type: string + List of values to be used for this policy rule. This field can be + set only in policies for list constraints. + $ref: >- + #/components/schemas/GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues + allowAll: + description: >- + Setting this to true means that all values are allowed. This field + can be set only in policies for list constraints. + type: boolean + denyAll: + description: >- + Setting this to true means that all values are denied. This field + can be set only in policies for list constraints. + type: boolean + enforce: + description: >- + If `true`, then the policy is enforced. If `false`, then any + configuration is acceptable. This field can be set in policies for + boolean constraints, custom constraints and managed constraints. + type: boolean + condition: + description: >- + A condition which determines whether this rule is used in the + evaluation of the policy. When set, the `expression` field in the + `Expr' must include from 1 to 10 subexpressions, joined by the "||" + or "&&" operators. Each subexpression must be of the form + "resource.matchTag('/tag_key_short_name, 'tag_value_short_name')". + or "resource.matchTagId('tagKeys/key_id', 'tagValues/value_id')". + where key_name and value_name are the resource names for Label Keys + and Values. These names are available from the Tag Manager Service. + An example expression is: "resource.matchTag('123456789/environment, + 'prod')". or "resource.matchTagId('tagKeys/123', 'tagValues/456')". + $ref: '#/components/schemas/GoogleTypeExpr' + parameters: + description: >- + Optional. Required for managed constraints if parameters are + defined. Passes parameter values when policy enforcement is enabled. + Ensure that parameter value types match those defined in the + constraint definition. For example: ``` { "allowedLocations" : + ["us-east1", "us-west1"], "allowAll" : true } ``` + type: object + additionalProperties: + type: any + description: Properties of the object. + GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues: + id: GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues + description: >- + A message that holds specific allowed and denied values. This message + can define specific values and subtrees of the Resource Manager resource + hierarchy (`Organizations`, `Folders`, `Projects`) that are allowed or + denied. This is achieved by using the `under:` and optional `is:` + prefixes. The `under:` prefix is used to denote resource subtree values. + The `is:` prefix is used to denote specific values, and is required only + if the value contains a ":". Values prefixed with "is:" are treated the + same as values with no prefix. Ancestry subtrees must be in one of the + following formats: - `projects/` (for example, + `projects/tokyo-rain-123`) - `folders/` (for example, `folders/1234`) - + `organizations/` (for example, `organizations/1234`) The + `supports_under` field of the associated `Constraint` defines whether + ancestry prefixes can be used. type: object - id: GoogleCloudOrgpolicyV2PolicySpec - GoogleCloudOrgpolicyV2Policy: + properties: + allowedValues: + description: List of values allowed at this resource. + type: array + items: + type: string + deniedValues: + description: List of values denied at this resource. + type: array + items: + type: string + GoogleTypeExpr: + id: GoogleTypeExpr description: >- - Defines an organization policy which is used to specify constraints for - configurations of Google Cloud resources. + 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. + type: object properties: - spec: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' - description: Basic information about the Organization Policy. - alternate: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2AlternatePolicySpec' - deprecated: true - description: Deprecated. - etag: + expression: description: >- - Optional. An opaque tag indicating the current state of the policy, - used for concurrency control. This 'etag' is computed by the server - based on the value of other fields, and may be sent on update and - delete requests to ensure the client has an up-to-date value before - proceeding. + Textual representation of an expression in Common Expression + Language syntax. type: string - dryRunSpec: + title: description: >- - Dry-run policy. Audit-only policy, can be used to monitor how the - policy would have impacted the existing and future resources if it's - enforced. - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' - name: + 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 + description: description: >- - Immutable. The resource name of the policy. Must be one of the - following forms, where `constraint_name` is the name of the - constraint which this policy configures: * - `projects/{project_number}/policies/{constraint_name}` * - `folders/{folder_id}/policies/{constraint_name}` * - `organizations/{organization_id}/policies/{constraint_name}` For - example, `projects/123/policies/compute.disableSerialPortAccess`. - Note: `projects/{project_id}/policies/{constraint_name}` is also an - acceptable name for API requests, but responses will return the name - using the equivalent project number. - id: GoogleCloudOrgpolicyV2Policy + 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 + 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 + GoogleCloudOrgpolicyV2AlternatePolicySpec: + id: GoogleCloudOrgpolicyV2AlternatePolicySpec + description: >- + Similar to PolicySpec but with an extra 'launch' field for launch + reference. The PolicySpec here is specific for dry-run. type: object - GoogleCloudOrgpolicyV2Constraint: properties: - supportsDryRun: - description: Shows if dry run is supported for this constraint or not. - type: boolean - listConstraint: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2ConstraintListConstraint' - description: Defines this constraint as being a ListConstraint. - description: + launch: description: >- - Detailed description of what this constraint controls as well as how - and where it is enforced. Mutable. + Reference to the launch that will be used while audit logging and to + control the launch. Should be set only in the alternate policy. type: string + spec: + description: Specify constraint for configurations of Google Cloud resources. + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' + GoogleProtobufEmpty: + id: GoogleProtobufEmpty + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + type: object + properties: {} + GoogleCloudOrgpolicyV2CustomConstraint: + id: GoogleCloudOrgpolicyV2CustomConstraint + description: >- + A custom constraint defined by customers which can *only* be applied to + the given resource types and organization. By creating a custom + constraint, customers can apply policies of this custom constraint. + *Creating a custom constraint itself does NOT apply any policy + enforcement*. + type: object + properties: name: description: >- - Immutable. The resource name of the constraint. Must be in one of - the following forms: * - `projects/{project_number}/constraints/{constraint_name}` * - `folders/{folder_id}/constraints/{constraint_name}` * - `organizations/{organization_id}/constraints/{constraint_name}` For - example, - "/projects/123/constraints/compute.disableSerialPortAccess". + Immutable. Name of the constraint. This is unique within the + organization. Format of the name should be * + `organizations/{organization_id}/customConstraints/{custom_constraint_id}` + Example: + `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The + max length is 70 characters and the minimum length is 1. Note that + the prefix `organizations/{organization_id}/customConstraints/` is + not counted. type: string - displayName: + resourceTypes: + description: >- + Immutable. The resource instance type on which this policy applies. + Format will be of the form : `/` Example: * + `compute.googleapis.com/Instance`. + type: array + items: + type: string + methodTypes: + description: All the operations being applied for this constraint. + type: array + items: + type: string + enumDescriptions: + - >- + This is only used for distinguishing unset values and should + never be used. Results in an error. + - Constraint applied when creating the resource. + - Constraint applied when updating the resource. + - >- + Constraint applied when deleting the resource. Not currently + supported. + - Constraint applied when removing an IAM grant. + - Constraint applied when enforcing forced tagging. + enum: + - METHOD_TYPE_UNSPECIFIED + - CREATE + - UPDATE + - DELETE + - REMOVE_GRANT + - GOVERN_TAGS + condition: + description: >- + A Common Expression Language (CEL) condition which is used in the + evaluation of the constraint. For example: + `resource.instanceName.matches("[production|test]_.*_(\d)+")` or, + `resource.management.auto_upgrade == true` The max length of the + condition is 1000 characters. + type: string + actionType: + description: Allow or deny type. type: string - description: The human readable name. Mutable. - constraintDefault: enumDescriptions: - >- This is only used for distinguishing unset values and should never - be used. - - >- - Indicate that all values are allowed for list constraints. - Indicate that enforcement is off for boolean constraints. - - >- - Indicate that all values are denied for list constraints. Indicate - that enforcement is on for boolean constraints. + be used. Results in an error. + - Allowed action type. + - Deny action type. + enum: + - ACTION_TYPE_UNSPECIFIED + - ALLOW + - DENY + displayName: + description: >- + One line display name for the UI. The max length of the display_name + is 200 characters. type: string - enum: - - CONSTRAINT_DEFAULT_UNSPECIFIED - - ALLOW - - DENY + description: description: >- - The evaluation behavior of this constraint in the absence of a - policy. - booleanConstraint: - $ref: >- - #/components/schemas/GoogleCloudOrgpolicyV2ConstraintBooleanConstraint - description: Defines this constraint as being a BooleanConstraint. - description: >- - A constraint describes a way to restrict resource's configuration. For - example, you could enforce a constraint that controls which Google Cloud - services can be activated across an organization, or whether a Compute - Engine instance can have serial port connections established. - Constraints can be configured by the organization policy administrator - to fit the needs of the organization by setting a policy that includes - constraints at different locations in the organization's resource - hierarchy. Policies are inherited down the resource hierarchy from - higher levels, but can also be overridden. For details about the - inheritance rules please read about `policies`. Constraints have a - default behavior determined by the `constraint_default` field, which is - the enforcement behavior that is used in the absence of a policy being - defined or inherited for the resource in question. - type: object - id: GoogleCloudOrgpolicyV2Constraint - GoogleCloudOrgpolicyV2ConstraintBooleanConstraint: - properties: - customConstraintDefinition: + Detailed information about this custom policy constraint. The max + length of the description is 2000 characters. + type: string + updateTime: description: >- - Custom constraint definition. This is set only for Managed - Constraints - $ref: >- - #/components/schemas/GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinition - type: object - description: >- - A constraint that is either enforced or not. For example, a constraint - `constraints/compute.disableSerialPortAccess`. If it is enforced on a VM - instance, serial port connections will not be opened to that instance. - id: GoogleCloudOrgpolicyV2ConstraintBooleanConstraint + Output only. The last time this custom constraint was updated. This + represents the last time that the `CreateCustomConstraint` or + `UpdateCustomConstraint` methods were called. + readOnly: true + type: string + format: google-datetime GoogleCloudOrgpolicyV2ListCustomConstraintsResponse: - type: object + id: GoogleCloudOrgpolicyV2ListCustomConstraintsResponse description: >- The response returned from the ListCustomConstraints method. It will be - empty if no custom constraints are set on the organization resource. + empty if no custom or managed constraints are set on the organization + resource. + type: object properties: customConstraints: description: >- - All custom constraints that exist on the organization resource. It - will be empty if no custom constraints are set. + All custom and managed constraints that exist on the organization + resource. It will be empty if no custom constraints are set. type: array items: $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' nextPageToken: - type: string description: >- Page token used to retrieve the next page. This is currently not used, but the server may at any point start supplying a valid token. - id: GoogleCloudOrgpolicyV2ListCustomConstraintsResponse - GoogleCloudOrgpolicyV2ListPoliciesResponse: - type: object - properties: - policies: - items: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' - description: >- - All policies that exist on the resource. It will be empty if no - policies are set. - type: array - nextPageToken: type: string - description: >- - Page token used to retrieve the next page. This is currently not - used, but the server may at any point start supplying a valid token. - id: GoogleCloudOrgpolicyV2ListPoliciesResponse - description: >- - The response returned from the ListPolicies method. It will be empty if - no policies are set on the resource. - GoogleCloudOrgpolicyV2ConstraintListConstraint: - properties: - supportsUnder: - type: boolean - description: >- - Indicates whether subtrees of the Resource Manager resource - hierarchy can be used in `Policy.allowed_values` and - `Policy.denied_values`. For example, `"under:folders/123"` would - match any resource under the 'folders/123' folder. - supportsIn: - description: >- - Indicates whether values grouped into categories can be used in - `Policy.allowed_values` and `Policy.denied_values`. For example, - `"in:Python"` would match any value in the 'Python' group. - type: boolean - id: GoogleCloudOrgpolicyV2ConstraintListConstraint - type: object - description: >- - A constraint that allows or disallows a list of string values, which are - configured by an Organization Policy administrator with a policy. - GoogleCloudOrgpolicyV2PolicySpecPolicyRule: - type: object - id: GoogleCloudOrgpolicyV2PolicySpecPolicyRule - description: A rule used to express this policy. - properties: - allowAll: - type: boolean - description: >- - Setting this to true means that all values are allowed. This field - can be set only in policies for list constraints. - values: - $ref: >- - #/components/schemas/GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues - description: >- - List of values to be used for this policy rule. This field can be - set only in policies for list constraints. - condition: - $ref: '#/components/schemas/GoogleTypeExpr' - description: >- - A condition which determines whether this rule is used in the - evaluation of the policy. When set, the `expression` field in the - `Expr' must include from 1 to 10 subexpressions, joined by the "||" - or "&&" operators. Each subexpression must be of the form - "resource.matchTag('/tag_key_short_name, 'tag_value_short_name')". - or "resource.matchTagId('tagKeys/key_id', 'tagValues/value_id')". - where key_name and value_name are the resource names for Label Keys - and Values. These names are available from the Tag Manager Service. - An example expression is: "resource.matchTag('123456789/environment, - 'prod')". or "resource.matchTagId('tagKeys/123', 'tagValues/456')". - enforce: - description: >- - If `true`, then the policy is enforced. If `false`, then any - configuration is acceptable. This field can be set only in policies - for boolean constraints. - type: boolean - denyAll: - description: >- - Setting this to true means that all values are denied. This field - can be set only in policies for list constraints. - type: boolean parameters: access_token: description: OAuth access token. @@ -634,40 +663,26 @@ components: name: access_token schema: type: string - _.xgafv: - description: V1 error format. + alt: + description: Data format for response. in: query - name: $.xgafv + name: alt schema: type: string enum: - - '1' - - '2' - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string + - json + - media + - proto callback: description: JSONP in: query name: callback schema: type: string - 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"). + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: uploadType + name: fields schema: type: string key: @@ -679,61 +694,121 @@ components: name: key schema: type: string - alt: - description: Data format for response. + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: alt + name: oauth_token schema: type: string - enum: - - json - - media - - proto prettyPrint: description: Returns response with indentations and line breaks. in: query name: prettyPrint schema: type: boolean - oauth_token: - description: OAuth 2.0 token for the current user. + 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: oauth_token + name: quotaUser schema: type: string - fields: - description: Selector specifying which fields to include in a partial response. + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: fields + name: upload_protocol + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv schema: type: string + enum: + - '1' + - '2' x-stackQL-resources: + constraints: + id: google.orgpolicy.constraints + name: constraints + title: Constraints + methods: + projects_constraints_list: + operation: + $ref: '#/paths/~1v2~1projects~1{projectsId}~1constraints/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.constraints + folders_constraints_list: + operation: + $ref: '#/paths/~1v2~1folders~1{foldersId}~1constraints/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.constraints + organizations_constraints_list: + operation: + $ref: '#/paths/~1v2~1organizations~1{organizationsId}~1constraints/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.constraints + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/constraints/methods/projects_constraints_list + - $ref: >- + #/components/x-stackQL-resources/constraints/methods/folders_constraints_list + - $ref: >- + #/components/x-stackQL-resources/constraints/methods/organizations_constraints_list + insert: [] + update: [] + replace: [] + delete: [] policies: id: google.orgpolicy.policies name: policies title: Policies methods: - folders_policies_get: + projects_policies_list: operation: - $ref: '#/paths/~1v2~1folders~1{foldersId}~1policies~1{policiesId}/get' + $ref: '#/paths/~1v2~1projects~1{projectsId}~1policies/get' response: mediaType: application/json openAPIDocKey: '200' - folders_policies_delete: + objectKey: $.policies + projects_policies_create: operation: - $ref: '#/paths/~1v2~1folders~1{foldersId}~1policies~1{policiesId}/delete' + $ref: '#/paths/~1v2~1projects~1{projectsId}~1policies/post' response: mediaType: application/json openAPIDocKey: '200' - folders_policies_patch: + projects_policies_get: operation: - $ref: '#/paths/~1v2~1folders~1{foldersId}~1policies~1{policiesId}/patch' + $ref: '#/paths/~1v2~1projects~1{projectsId}~1policies~1{policiesId}/get' response: mediaType: application/json openAPIDocKey: '200' - folders_policies_create: + projects_policies_patch: operation: - $ref: '#/paths/~1v2~1folders~1{foldersId}~1policies/post' + $ref: '#/paths/~1v2~1projects~1{projectsId}~1policies~1{policiesId}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + projects_policies_delete: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1policies~1{policiesId}/delete response: mediaType: application/json openAPIDocKey: '200' @@ -744,42 +819,40 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.policies - projects_policies_patch: + folders_policies_create: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1policies~1{policiesId}/patch' + $ref: '#/paths/~1v2~1folders~1{foldersId}~1policies/post' response: mediaType: application/json openAPIDocKey: '200' - projects_policies_delete: + folders_policies_get: operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1policies~1{policiesId}/delete + $ref: '#/paths/~1v2~1folders~1{foldersId}~1policies~1{policiesId}/get' response: mediaType: application/json openAPIDocKey: '200' - projects_policies_get: + folders_policies_patch: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1policies~1{policiesId}/get' + $ref: '#/paths/~1v2~1folders~1{foldersId}~1policies~1{policiesId}/patch' response: mediaType: application/json openAPIDocKey: '200' - projects_policies_create: + folders_policies_delete: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1policies/post' + $ref: '#/paths/~1v2~1folders~1{foldersId}~1policies~1{policiesId}/delete' response: mediaType: application/json openAPIDocKey: '200' - projects_policies_list: + organizations_policies_list: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1policies/get' + $ref: '#/paths/~1v2~1organizations~1{organizationsId}~1policies/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.policies - organizations_policies_delete: + organizations_policies_create: operation: - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1policies~1{policiesId}/delete + $ref: '#/paths/~1v2~1organizations~1{organizationsId}~1policies/post' response: mediaType: application/json openAPIDocKey: '200' @@ -797,53 +870,47 @@ components: response: mediaType: application/json openAPIDocKey: '200' - organizations_policies_create: - operation: - $ref: '#/paths/~1v2~1organizations~1{organizationsId}~1policies/post' - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_policies_list: + organizations_policies_delete: operation: - $ref: '#/paths/~1v2~1organizations~1{organizationsId}~1policies/get' + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1policies~1{policiesId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.policies sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/policies/methods/folders_policies_get - $ref: >- #/components/x-stackQL-resources/policies/methods/projects_policies_get - $ref: >- - #/components/x-stackQL-resources/policies/methods/organizations_policies_get + #/components/x-stackQL-resources/policies/methods/folders_policies_get - $ref: >- - #/components/x-stackQL-resources/policies/methods/folders_policies_list + #/components/x-stackQL-resources/policies/methods/organizations_policies_get - $ref: >- #/components/x-stackQL-resources/policies/methods/projects_policies_list + - $ref: >- + #/components/x-stackQL-resources/policies/methods/folders_policies_list - $ref: >- #/components/x-stackQL-resources/policies/methods/organizations_policies_list insert: - - $ref: >- - #/components/x-stackQL-resources/policies/methods/folders_policies_create - $ref: >- #/components/x-stackQL-resources/policies/methods/projects_policies_create + - $ref: >- + #/components/x-stackQL-resources/policies/methods/folders_policies_create - $ref: >- #/components/x-stackQL-resources/policies/methods/organizations_policies_create update: - - $ref: >- - #/components/x-stackQL-resources/policies/methods/folders_policies_patch - $ref: >- #/components/x-stackQL-resources/policies/methods/projects_policies_patch + - $ref: >- + #/components/x-stackQL-resources/policies/methods/folders_policies_patch - $ref: >- #/components/x-stackQL-resources/policies/methods/organizations_policies_patch replace: [] delete: - - $ref: >- - #/components/x-stackQL-resources/policies/methods/folders_policies_delete - $ref: >- #/components/x-stackQL-resources/policies/methods/projects_policies_delete + - $ref: >- + #/components/x-stackQL-resources/policies/methods/folders_policies_delete - $ref: >- #/components/x-stackQL-resources/policies/methods/organizations_policies_delete policies_effective_policy: @@ -851,17 +918,17 @@ components: name: policies_effective_policy title: Policies_effective_policy methods: - folders_policies_get_effective_policy: + projects_policies_get_effective_policy: operation: $ref: >- - #/paths/~1v2~1folders~1{foldersId}~1policies~1{policiesId}:getEffectivePolicy/get + #/paths/~1v2~1projects~1{projectsId}~1policies~1{policiesId}:getEffectivePolicy/get response: mediaType: application/json openAPIDocKey: '200' - projects_policies_get_effective_policy: + folders_policies_get_effective_policy: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1policies~1{policiesId}:getEffectivePolicy/get + #/paths/~1v2~1folders~1{foldersId}~1policies~1{policiesId}:getEffectivePolicy/get response: mediaType: application/json openAPIDocKey: '200' @@ -874,50 +941,12 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/policies_effective_policy/methods/folders_policies_get_effective_policy - $ref: >- #/components/x-stackQL-resources/policies_effective_policy/methods/projects_policies_get_effective_policy - $ref: >- - #/components/x-stackQL-resources/policies_effective_policy/methods/organizations_policies_get_effective_policy - insert: [] - update: [] - replace: [] - delete: [] - constraints: - id: google.orgpolicy.constraints - name: constraints - title: Constraints - methods: - folders_constraints_list: - operation: - $ref: '#/paths/~1v2~1folders~1{foldersId}~1constraints/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.constraints - projects_constraints_list: - operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1constraints/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.constraints - organizations_constraints_list: - operation: - $ref: '#/paths/~1v2~1organizations~1{organizationsId}~1constraints/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.constraints - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/constraints/methods/folders_constraints_list - - $ref: >- - #/components/x-stackQL-resources/constraints/methods/projects_constraints_list + #/components/x-stackQL-resources/policies_effective_policy/methods/folders_policies_get_effective_policy - $ref: >- - #/components/x-stackQL-resources/constraints/methods/organizations_constraints_list + #/components/x-stackQL-resources/policies_effective_policy/methods/organizations_policies_get_effective_policy insert: [] update: [] replace: [] @@ -927,42 +956,42 @@ components: name: custom_constraints title: Custom_constraints methods: - organizations_custom_constraints_patch: + organizations_custom_constraints_create: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1customConstraints~1{customConstraintsId}/patch + #/paths/~1v2~1organizations~1{organizationsId}~1customConstraints/post response: mediaType: application/json openAPIDocKey: '200' - organizations_custom_constraints_get: + organizations_custom_constraints_list: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1customConstraints~1{customConstraintsId}/get + #/paths/~1v2~1organizations~1{organizationsId}~1customConstraints/get response: mediaType: application/json openAPIDocKey: '200' - organizations_custom_constraints_delete: + objectKey: $.customConstraints + organizations_custom_constraints_patch: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1customConstraints~1{customConstraintsId}/delete + #/paths/~1v2~1organizations~1{organizationsId}~1customConstraints~1{customConstraintsId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_custom_constraints_create: + organizations_custom_constraints_get: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1customConstraints/post + #/paths/~1v2~1organizations~1{organizationsId}~1customConstraints~1{customConstraintsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_custom_constraints_list: + organizations_custom_constraints_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1customConstraints/get + #/paths/~1v2~1organizations~1{organizationsId}~1customConstraints~1{customConstraintsId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.customConstraints sqlVerbs: select: - $ref: >- @@ -980,137 +1009,22 @@ components: - $ref: >- #/components/x-stackQL-resources/custom_constraints/methods/organizations_custom_constraints_delete paths: - /v2/folders/{foldersId}/policies/{policiesId}: + /v2/projects/{projectsId}/constraints: parameters: &ref_1 - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/fields' - get: - description: >- - Gets a policy on a resource. If no policy is set on the resource, - `NOT_FOUND` is returned. The `etag` value can be used with - `UpdatePolicy()` to update a policy during read-modify-write. - operationId: orgpolicy.folders.policies.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' - parameters: - - in: path - name: foldersId - required: true - schema: - type: string - - in: path - name: policiesId - required: true - schema: - type: string - delete: - description: >- - Deletes a policy. Returns a `google.rpc.Status` with - `google.rpc.Code.NOT_FOUND` if the constraint or organization policy - does not exist. - operationId: orgpolicy.folders.policies.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' - parameters: - - in: path - name: foldersId - required: true - schema: - type: string - - in: path - name: policiesId - required: true - schema: - type: string - - in: query - name: etag - schema: - type: string - patch: - description: >- - Updates a policy. Returns a `google.rpc.Status` with - `google.rpc.Code.NOT_FOUND` if the constraint or the policy do not - exist. Returns a `google.rpc.Status` with `google.rpc.Code.ABORTED` if - the etag supplied in the request does not match the persisted etag of - the policy Note: the supplied policy will perform a full overwrite of - all fields. - operationId: orgpolicy.folders.policies.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' - parameters: - - in: path - name: foldersId - required: true - schema: - type: string - - in: path - name: policiesId - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v2/folders/{foldersId}/policies: - parameters: *ref_1 - post: - description: >- - Creates a policy. Returns a `google.rpc.Status` with - `google.rpc.Code.NOT_FOUND` if the constraint does not exist. Returns a - `google.rpc.Status` with `google.rpc.Code.ALREADY_EXISTS` if the policy - already exists on the given Google Cloud resource. - operationId: orgpolicy.folders.policies.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' + get: + description: Lists constraints that could be applied on the specified resource. + operationId: orgpolicy.projects.constraints.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1122,16 +1036,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + $ref: >- + #/components/schemas/GoogleCloudOrgpolicyV2ListConstraintsResponse parameters: - in: path - name: foldersId + name: projectsId required: true schema: type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v2/projects/{projectsId}/policies: + parameters: *ref_1 get: description: Retrieves all of the policies that exist on a particular resource. - operationId: orgpolicy.folders.policies.list + operationId: orgpolicy.projects.policies.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1147,29 +1073,31 @@ paths: #/components/schemas/GoogleCloudOrgpolicyV2ListPoliciesResponse parameters: - in: path - name: foldersId + name: projectsId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - in: query name: pageSize schema: type: integer format: int32 - /v2/folders/{foldersId}/policies/{policiesId}:getEffectivePolicy: - parameters: *ref_1 - get: + - in: query + name: pageToken + schema: + type: string + post: description: >- - Gets the effective policy on a resource. This is the result of merging - policies in the resource hierarchy and evaluating conditions. The - returned policy will not have an `etag` or `condition` set because it is - an evaluated policy across multiple resources. Subtrees of Resource - Manager resource hierarchy with 'under:' prefix will not be expanded. - operationId: orgpolicy.folders.policies.getEffectivePolicy + Creates a policy. Returns a `google.rpc.Status` with + `google.rpc.Code.NOT_FOUND` if the constraint does not exist. Returns a + `google.rpc.Status` with `google.rpc.Code.ALREADY_EXISTS` if the policy + already exists on the given Google Cloud resource. + operationId: orgpolicy.projects.policies.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1184,20 +1112,18 @@ paths: $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' parameters: - in: path - name: foldersId - required: true - schema: - type: string - - in: path - name: policiesId + name: projectsId required: true schema: type: string - /v2/folders/{foldersId}/constraints: + /v2/projects/{projectsId}/policies/{policiesId}: parameters: *ref_1 get: - description: Lists constraints that could be applied on the specified resource. - operationId: orgpolicy.folders.constraints.list + description: >- + Gets a policy on a resource. If no policy is set on the resource, + `NOT_FOUND` is returned. The `etag` value can be used with + `UpdatePolicy()` to update a policy during read-modify-write. + operationId: orgpolicy.projects.policies.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1209,25 +1135,18 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudOrgpolicyV2ListConstraintsResponse + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' parameters: - in: path - name: foldersId + name: projectsId required: true schema: type: string - - in: query - name: pageToken + - in: path + name: policiesId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v2/projects/{projectsId}/policies/{policiesId}: - parameters: *ref_1 patch: description: >- Updates a policy. Returns a `google.rpc.Status` with @@ -1303,12 +1222,16 @@ paths: name: etag schema: type: string + /v2/projects/{projectsId}/policies/{policiesId}:getEffectivePolicy: + parameters: *ref_1 get: description: >- - Gets a policy on a resource. If no policy is set on the resource, - `NOT_FOUND` is returned. The `etag` value can be used with - `UpdatePolicy()` to update a policy during read-modify-write. - operationId: orgpolicy.projects.policies.get + Gets the effective policy on a resource. This is the result of merging + policies in the resource hierarchy and evaluating conditions. The + returned policy will not have an `etag` or `condition` set because it is + an evaluated policy across multiple resources. Subtrees of Resource + Manager resource hierarchy with 'under:' prefix will not be expanded. + operationId: orgpolicy.projects.policies.getEffectivePolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1332,15 +1255,79 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/policies: + /v2/folders/{foldersId}/constraints: + parameters: *ref_1 + get: + description: Lists constraints that could be applied on the specified resource. + operationId: orgpolicy.folders.constraints.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudOrgpolicyV2ListConstraintsResponse + parameters: + - in: path + name: foldersId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v2/folders/{foldersId}/policies: parameters: *ref_1 + get: + description: Retrieves all of the policies that exist on a particular resource. + operationId: orgpolicy.folders.policies.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudOrgpolicyV2ListPoliciesResponse + parameters: + - in: path + name: foldersId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string post: description: >- Creates a policy. Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the constraint does not exist. Returns a `google.rpc.Status` with `google.rpc.Code.ALREADY_EXISTS` if the policy already exists on the given Google Cloud resource. - operationId: orgpolicy.projects.policies.create + operationId: orgpolicy.folders.policies.create requestBody: content: application/json: @@ -1360,13 +1347,18 @@ paths: $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string + /v2/folders/{foldersId}/policies/{policiesId}: + parameters: *ref_1 get: - description: Retrieves all of the policies that exist on a particular resource. - operationId: orgpolicy.projects.policies.list + description: >- + Gets a policy on a resource. If no policy is set on the resource, + `NOT_FOUND` is returned. The `etag` value can be used with + `UpdatePolicy()` to update a policy during read-modify-write. + operationId: orgpolicy.folders.policies.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1378,33 +1370,32 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudOrgpolicyV2ListPoliciesResponse + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string - - in: query - name: pageToken + - in: path + name: policiesId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v2/projects/{projectsId}/policies/{policiesId}:getEffectivePolicy: - parameters: *ref_1 - get: + patch: description: >- - Gets the effective policy on a resource. This is the result of merging - policies in the resource hierarchy and evaluating conditions. The - returned policy will not have an `etag` or `condition` set because it is - an evaluated policy across multiple resources. Subtrees of Resource - Manager resource hierarchy with 'under:' prefix will not be expanded. - operationId: orgpolicy.projects.policies.getEffectivePolicy + Updates a policy. Returns a `google.rpc.Status` with + `google.rpc.Code.NOT_FOUND` if the constraint or the policy do not + exist. Returns a `google.rpc.Status` with `google.rpc.Code.ABORTED` if + the etag supplied in the request does not match the persisted etag of + the policy Note: the supplied policy will perform a full overwrite of + all fields. + operationId: orgpolicy.folders.policies.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1419,7 +1410,7 @@ paths: $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string @@ -1428,11 +1419,17 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/constraints: - parameters: *ref_1 - get: - description: Lists constraints that could be applied on the specified resource. - operationId: orgpolicy.projects.constraints.list + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: >- + Deletes a policy. Returns a `google.rpc.Status` with + `google.rpc.Code.NOT_FOUND` if the constraint or organization policy + does not exist. + operationId: orgpolicy.folders.policies.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1444,36 +1441,32 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudOrgpolicyV2ListConstraintsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string - - in: query - name: pageSize + - in: path + name: policiesId + required: true schema: - type: integer - format: int32 + type: string - in: query - name: pageToken + name: etag schema: type: string - /v2/organizations/{organizationsId}/customConstraints/{customConstraintsId}: + /v2/folders/{foldersId}/policies/{policiesId}:getEffectivePolicy: parameters: *ref_1 - patch: + get: description: >- - Updates a custom constraint. Returns a `google.rpc.Status` with - `google.rpc.Code.NOT_FOUND` if the constraint does not exist. Note: the - supplied policy will perform a full overwrite of all fields. - operationId: orgpolicy.organizations.customConstraints.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' + Gets the effective policy on a resource. This is the result of merging + policies in the resource hierarchy and evaluating conditions. The + returned policy will not have an `etag` or `condition` set because it is + an evaluated policy across multiple resources. Subtrees of Resource + Manager resource hierarchy with 'under:' prefix will not be expanded. + operationId: orgpolicy.folders.policies.getEffectivePolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1485,23 +1478,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' parameters: - in: path - name: organizationsId + name: foldersId required: true schema: type: string - in: path - name: customConstraintsId + name: policiesId required: true schema: type: string + /v2/organizations/{organizationsId}/constraints: + parameters: *ref_1 get: - description: >- - Gets a custom constraint. Returns a `google.rpc.Status` with - `google.rpc.Code.NOT_FOUND` if the custom constraint does not exist. - operationId: orgpolicy.organizations.customConstraints.get + description: Lists constraints that could be applied on the specified resource. + operationId: orgpolicy.organizations.constraints.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1513,23 +1506,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' + $ref: >- + #/components/schemas/GoogleCloudOrgpolicyV2ListConstraintsResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: customConstraintsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - delete: - description: >- - Deletes a custom constraint. Returns a `google.rpc.Status` with - `google.rpc.Code.NOT_FOUND` if the constraint does not exist. - operationId: orgpolicy.organizations.customConstraints.delete + /v2/organizations/{organizationsId}/policies: + parameters: *ref_1 + get: + description: Retrieves all of the policies that exist on a particular resource. + operationId: orgpolicy.organizations.policies.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1541,32 +1539,35 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudOrgpolicyV2ListPoliciesResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: customConstraintsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v2/organizations/{organizationsId}/customConstraints: - parameters: *ref_1 post: description: >- - Creates a custom constraint. Returns a `google.rpc.Status` with - `google.rpc.Code.NOT_FOUND` if the organization does not exist. Returns - a `google.rpc.Status` with `google.rpc.Code.ALREADY_EXISTS` if the - constraint already exists on the given organization. - operationId: orgpolicy.organizations.customConstraints.create + Creates a policy. Returns a `google.rpc.Status` with + `google.rpc.Code.NOT_FOUND` if the constraint does not exist. Returns a + `google.rpc.Status` with `google.rpc.Code.ALREADY_EXISTS` if the policy + already exists on the given Google Cloud resource. + operationId: orgpolicy.organizations.policies.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1578,18 +1579,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' parameters: - in: path name: organizationsId required: true schema: type: string + /v2/organizations/{organizationsId}/policies/{policiesId}: + parameters: *ref_1 get: description: >- - Retrieves all of the custom constraints that exist on a particular - organization resource. - operationId: orgpolicy.organizations.customConstraints.list + Gets a policy on a resource. If no policy is set on the resource, + `NOT_FOUND` is returned. The `etag` value can be used with + `UpdatePolicy()` to update a policy during read-modify-write. + operationId: orgpolicy.organizations.policies.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1601,28 +1605,32 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudOrgpolicyV2ListCustomConstraintsResponse + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: pageToken + - in: path + name: policiesId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v2/organizations/{organizationsId}/constraints: - parameters: *ref_1 - get: - description: Lists constraints that could be applied on the specified resource. - operationId: orgpolicy.organizations.constraints.list + patch: + description: >- + Updates a policy. Returns a `google.rpc.Status` with + `google.rpc.Code.NOT_FOUND` if the constraint or the policy do not + exist. Returns a `google.rpc.Status` with `google.rpc.Code.ABORTED` if + the etag supplied in the request does not match the persisted etag of + the policy Note: the supplied policy will perform a full overwrite of + all fields. + operationId: orgpolicy.organizations.policies.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1634,25 +1642,23 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudOrgpolicyV2ListConstraintsResponse + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: pageToken + - in: path + name: policiesId + required: true schema: type: string - in: query - name: pageSize + name: updateMask schema: - type: integer - format: int32 - /v2/organizations/{organizationsId}/policies/{policiesId}: - parameters: *ref_1 + type: string + format: google-fieldmask delete: description: >- Deletes a policy. Returns a `google.rpc.Status` with @@ -1686,12 +1692,16 @@ paths: name: etag schema: type: string + /v2/organizations/{organizationsId}/policies/{policiesId}:getEffectivePolicy: + parameters: *ref_1 get: description: >- - Gets a policy on a resource. If no policy is set on the resource, - `NOT_FOUND` is returned. The `etag` value can be used with - `UpdatePolicy()` to update a policy during read-modify-write. - operationId: orgpolicy.organizations.policies.get + Gets the effective policy on a resource. This is the result of merging + policies in the resource hierarchy and evaluating conditions. The + returned policy will not have an `etag` or `condition` set because it is + an evaluated policy across multiple resources. Subtrees of Resource + Manager resource hierarchy with 'under:' prefix will not be expanded. + operationId: orgpolicy.organizations.policies.getEffectivePolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1715,20 +1725,20 @@ paths: required: true schema: type: string - patch: + /v2/organizations/{organizationsId}/customConstraints: + parameters: *ref_1 + post: description: >- - Updates a policy. Returns a `google.rpc.Status` with - `google.rpc.Code.NOT_FOUND` if the constraint or the policy do not - exist. Returns a `google.rpc.Status` with `google.rpc.Code.ABORTED` if - the etag supplied in the request does not match the persisted etag of - the policy Note: the supplied policy will perform a full overwrite of - all fields. - operationId: orgpolicy.organizations.policies.patch + Creates a custom constraint. Returns a `google.rpc.Status` with + `google.rpc.Code.NOT_FOUND` if the organization does not exist. Returns + a `google.rpc.Status` with `google.rpc.Code.ALREADY_EXISTS` if the + constraint already exists on the given organization. + operationId: orgpolicy.organizations.customConstraints.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1740,37 +1750,59 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' parameters: - in: path name: organizationsId required: true schema: type: string + get: + description: >- + Retrieves all of the custom constraints that exist on a particular + organization resource. + operationId: orgpolicy.organizations.customConstraints.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudOrgpolicyV2ListCustomConstraintsResponse + parameters: - in: path - name: policiesId + name: organizationsId required: true schema: type: string - in: query - name: updateMask + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - format: google-fieldmask - /v2/organizations/{organizationsId}/policies: + /v2/organizations/{organizationsId}/customConstraints/{customConstraintsId}: parameters: *ref_1 - post: + patch: description: >- - Creates a policy. Returns a `google.rpc.Status` with - `google.rpc.Code.NOT_FOUND` if the constraint does not exist. Returns a - `google.rpc.Status` with `google.rpc.Code.ALREADY_EXISTS` if the policy - already exists on the given Google Cloud resource. - operationId: orgpolicy.organizations.policies.create + Updates a custom constraint. Returns a `google.rpc.Status` with + `google.rpc.Code.NOT_FOUND` if the constraint does not exist. Note: the + supplied policy will perform a full overwrite of all fields. + operationId: orgpolicy.organizations.customConstraints.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1782,16 +1814,24 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' parameters: - in: path name: organizationsId required: true schema: type: string + - in: path + name: customConstraintsId + required: true + schema: + type: string get: - description: Retrieves all of the policies that exist on a particular resource. - operationId: orgpolicy.organizations.policies.list + description: >- + Gets a custom or managed constraint. Returns a `google.rpc.Status` with + `google.rpc.Code.NOT_FOUND` if the custom or managed constraint does not + exist. + operationId: orgpolicy.organizations.customConstraints.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1803,33 +1843,23 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudOrgpolicyV2ListPoliciesResponse + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: customConstraintsId + required: true schema: type: string - /v2/organizations/{organizationsId}/policies/{policiesId}:getEffectivePolicy: - parameters: *ref_1 - get: + delete: description: >- - Gets the effective policy on a resource. This is the result of merging - policies in the resource hierarchy and evaluating conditions. The - returned policy will not have an `etag` or `condition` set because it is - an evaluated policy across multiple resources. Subtrees of Resource - Manager resource hierarchy with 'under:' prefix will not be expanded. - operationId: orgpolicy.organizations.policies.getEffectivePolicy + Deletes a custom constraint. Returns a `google.rpc.Status` with + `google.rpc.Code.NOT_FOUND` if the constraint does not exist. + operationId: orgpolicy.organizations.customConstraints.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1841,7 +1871,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -1849,7 +1879,7 @@ paths: schema: type: string - in: path - name: policiesId + name: customConstraintsId required: true schema: type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/osconfig.yaml b/providers/src/googleapis.com/v00.00.00000/services/osconfig.yaml index a16d7612..f6e5702a 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/osconfig.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/osconfig.yaml @@ -8,9 +8,9 @@ info: description: >- OS management tools that can be used for patch management, patch compliance, and configuration management on VM instances. - version: v1 - x-discovery-doc-revision: '20241028' - x-generated-date: '2024-11-06' + version: v2 + x-discovery-doc-revision: '20250824' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/compute/docs/osconfig/rest servers: @@ -36,6 +36,21 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: + ListOperationsResponse: + id: ListOperationsResponse + description: The response message for Operations.ListOperations. + type: object + properties: + operations: + description: >- + A list of operations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/Operation' + nextPageToken: + description: The standard List next-page token. + type: string Operation: id: Operation description: >- @@ -118,11 +133,6 @@ components: additionalProperties: type: any description: Properties of the object. Contains field @type with type URL. - CancelOperationRequest: - id: CancelOperationRequest - description: The request message for Operations.CancelOperation. - type: object - properties: {} Empty: id: Empty description: >- @@ -132,1285 +142,389 @@ components: { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } type: object properties: {} - ProjectFeatureSettings: - id: ProjectFeatureSettings - description: >- - ProjectFeatureSettings represents the VM Manager feature settings in a - project. For more information, see Enable full VM Manager functionality. + CancelOperationRequest: + id: CancelOperationRequest + description: The request message for Operations.CancelOperation. + type: object + properties: {} + GoogleCloudOsconfigV2__PolicyOrchestrator: + id: GoogleCloudOsconfigV2__PolicyOrchestrator + description: >- + PolicyOrchestrator helps managing project+zone level policy resources + (e.g. OS Policy Assignments), by providing tools to create, update and + delete them across projects and locations, at scale. Policy orchestrator + functions as an endless loop. Each iteration orchestrator computes a set + of resources that should be affected, then progressively applies changes + to them. If for some reason this set of resources changes over time + (e.g. new projects are added), the future loop iterations will address + that. Orchestrator can either upsert or delete policy resources. For + more details, see the description of the `action`, and + `orchestrated_resource` fields. Note that policy orchestrator do not + "manage" the resources it creates. Every iteration is independent and + only minimal history of past actions is retained (apart from Cloud + Logging). If orchestrator gets deleted, it does not affect the resources + it created in the past. Those will remain where they were. Same applies + if projects are removed from the orchestrator's scope. type: object properties: name: description: >- - Required. Immutable. Name specifies the URL for the - ProjectFeatureSettings resource: - projects/project_id/locations/global/projectFeatureSettings. + Immutable. Identifier. In form of * + `organizations/{organization_id}/locations/global/policyOrchestrators/{orchestrator_id}` + * + `folders/{folder_id}/locations/global/policyOrchestrators/{orchestrator_id}` + * + `projects/{project_id_or_number}/locations/global/policyOrchestrators/{orchestrator_id}` type: string - patchAndConfigFeatureSet: - description: Set PatchAndConfigFeatureSet for the project. - type: string - enumDescriptions: - - Not specified placeholder - - Enables only the basic set of VM Manager features in the project. - - Enables all VM Manager features in the project. - enum: - - PATCH_AND_CONFIG_FEATURE_SET_UNSPECIFIED - - OSCONFIG_B - - OSCONFIG_C - ExecutePatchJobRequest: - id: ExecutePatchJobRequest - description: A request message to initiate patching across Compute Engine instances. - type: object - properties: description: + description: Optional. Freeform text describing the purpose of the resource. + type: string + etag: description: >- - Description of the patch job. Length of the description is limited - to 1024 characters. + Output only. This checksum is computed by the server based on the + value of other fields, and may be sent on update and delete requests + to ensure the client has an up-to-date value before proceeding. + readOnly: true type: string - instanceFilter: + state: description: >- - Required. Instances to patch, either explicitly or filtered by some - criteria such as zone or labels. - $ref: '#/components/schemas/PatchInstanceFilter' - patchConfig: + Optional. State of the orchestrator. Can be updated to change + orchestrator behaviour. Allowed values: - `ACTIVE` - orchestrator is + actively looking for actions to be taken. - `STOPPED` - orchestrator + won't make any changes. Note: There might be more states added in + the future. We use string here instead of an enum, to avoid the need + of propagating new states to all the client code. + type: string + reconciling: description: >- - Patch configuration being applied. If omitted, instances are patched - using the default configurations. - $ref: '#/components/schemas/PatchConfig' - duration: + Output only. Set to true, if the there are ongoing changes being + applied by the orchestrator. + readOnly: true + type: boolean + orchestrationScope: + description: >- + Optional. Defines scope for the orchestration, in context of the + enclosing PolicyOrchestrator resource. Scope is expanded into a list + of pairs, in which the rollout action will take place. Expansion + starts with a Folder resource parenting the PolicyOrchestrator + resource: - All the descendant projects are listed. - List of + project is cross joined with a list of all available zones. - + Resulting list of pairs is filtered according to the selectors. + $ref: '#/components/schemas/GoogleCloudOsconfigV2__OrchestrationScope' + action: + description: >- + Required. Action to be done by the orchestrator in + `projects/{project_id}/zones/{zone_id}` locations defined by the + `orchestration_scope`. Allowed values: - `UPSERT` - Orchestrator + will create or update target resources. - `DELETE` - Orchestrator + will delete target resources, if they exist + type: string + orchestratedResource: + description: Required. Resource to be orchestrated by the policy orchestrator. + $ref: '#/components/schemas/GoogleCloudOsconfigV2__OrchestratedResource' + orchestrationState: + description: Output only. State of the orchestration. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudOsconfigV2_PolicyOrchestrator_OrchestrationState + createTime: description: >- - Duration of the patch job. After the duration ends, the patch job - times out. + Output only. Timestamp when the policy orchestrator resource was + created. + readOnly: true type: string - format: google-duration - dryRun: + format: google-datetime + updateTime: description: >- - If this patch is a dry-run only, instances are contacted but will do - nothing. - type: boolean - displayName: - description: Display name for this patch job. This does not have to be unique. + Output only. Timestamp when the policy orchestrator resource was + last modified. + readOnly: true type: string - rollout: - description: Rollout strategy of the patch job. - $ref: '#/components/schemas/PatchRollout' - PatchInstanceFilter: - id: PatchInstanceFilter + format: google-datetime + labels: + description: Optional. Labels as key value pairs + type: object + additionalProperties: + type: string + GoogleCloudOsconfigV2__OrchestrationScope: + id: GoogleCloudOsconfigV2__OrchestrationScope description: >- - A filter to target VM instances for patching. The targeted VMs must meet - all criteria specified. So if both labels and zones are specified, the - patch job targets only VMs with those labels and in those zones. + Defines a set of selectors which drive which resources are in scope of + policy orchestration. type: object properties: - all: - description: >- - Target all VM instances in the project. If true, no other criteria - is permitted. - type: boolean - groupLabels: + selectors: description: >- - Targets VM instances matching ANY of these GroupLabels. This allows - targeting of disparate groups of VM instances. + Optional. Selectors of the orchestration scope. There is a logical + AND between each selector defined. When there is no explicit + `ResourceHierarchySelector` selector specified, the scope is by + default bounded to the parent of the policy orchestrator resource. type: array items: - $ref: '#/components/schemas/PatchInstanceFilterGroupLabel' - zones: + $ref: >- + #/components/schemas/GoogleCloudOsconfigV2_OrchestrationScope_Selector + GoogleCloudOsconfigV2_OrchestrationScope_Selector: + id: GoogleCloudOsconfigV2_OrchestrationScope_Selector + description: Selector for the resources in scope of orchestration. + type: object + properties: + resourceHierarchySelector: + description: Selector for selecting resource hierarchy. + $ref: >- + #/components/schemas/GoogleCloudOsconfigV2_OrchestrationScope_ResourceHierarchySelector + locationSelector: + description: Selector for selecting locations. + $ref: >- + #/components/schemas/GoogleCloudOsconfigV2_OrchestrationScope_LocationSelector + GoogleCloudOsconfigV2_OrchestrationScope_ResourceHierarchySelector: + id: GoogleCloudOsconfigV2_OrchestrationScope_ResourceHierarchySelector + description: Selector containing Cloud Resource Manager resource hierarchy nodes. + type: object + properties: + includedProjects: description: >- - Targets VM instances in ANY of these zones. Leave empty to target VM - instances in any zone. + Optional. Names of the projects in scope. Format: + `projects/{project_number}` type: array items: type: string - instances: + includedFolders: description: >- - Targets any of the VM instances specified. Instances are specified - by their URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`, - `projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or - `https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]` + Optional. Names of the folders in scope. Format: + `folders/{folder_id}` type: array items: type: string - instanceNamePrefixes: - description: >- - Targets VMs whose name starts with one of these prefixes. Similar to - labels, this is another way to group VMs when targeting configs, for - example prefix="prod-". + GoogleCloudOsconfigV2_OrchestrationScope_LocationSelector: + id: GoogleCloudOsconfigV2_OrchestrationScope_LocationSelector + description: Selector containing locations in scope. + type: object + properties: + includedLocations: + description: 'Optional. Names of the locations in scope. Format: `us-central1-a`' type: array items: type: string - PatchInstanceFilterGroupLabel: - id: PatchInstanceFilterGroupLabel + GoogleCloudOsconfigV2__OrchestratedResource: + id: GoogleCloudOsconfigV2__OrchestratedResource description: >- - Targets a group of VM instances by using their [assigned - labels](https://cloud.google.com/compute/docs/labeling-resources). - Labels are key-value pairs. A `GroupLabel` is a combination of labels - that is used to target VMs for a patch job. For example, a patch job can - target VMs that have the following `GroupLabel`: `{"env":"test", - "app":"web"}`. This means that the patch job is applied to VMs that have - both the labels `env=test` and `app=web`. + Represents a resource that is being orchestrated by the policy + orchestrator. type: object properties: - labels: + osPolicyAssignmentV1Payload: description: >- - Compute Engine instance labels that must be present for a VM - instance to be targeted by this filter. - type: object - additionalProperties: - type: string - PatchConfig: - id: PatchConfig + Optional. OSPolicyAssignment resource to be created, updated or + deleted. Name field is ignored and replace with a generated value. + With this field set, orchestrator will perform actions on + `project/{project}/locations/{zone}/osPolicyAssignments/{resource_id}` + resources, where `project` and `zone` pairs come from the expanded + scope, and `resource_id` comes from the `resource_id` field of + orchestrator resource. + $ref: '#/components/schemas/OSPolicyAssignment' + id: + description: >- + Optional. ID of the resource to be used while generating set of + affected resources. For UPSERT action the value is auto-generated + during PolicyOrchestrator creation when not set. When the value is + set it should following next restrictions: * Must contain only + lowercase letters, numbers, and hyphens. * Must start with a letter. + * Must be between 1-63 characters. * Must end with a number or a + letter. * Must be unique within the project. For DELETE action, ID + must be specified explicitly during PolicyOrchestrator creation. + type: string + OSPolicyAssignment: + id: OSPolicyAssignment description: >- - Patch configuration specifications. Contains details on how to apply the - patch(es) to a VM instance. + OS policy assignment is an API resource that is used to apply a set of + OS policies to a dynamically targeted group of Compute Engine VM + instances. An OS policy is used to define the desired state + configuration for a Compute Engine VM instance through a set of + configuration resources that provide capabilities such as installing or + removing software packages, or executing a script. For more information + about the OS policy resource definitions and examples, see [OS policy + and OS policy + assignment](https://cloud.google.com/compute/docs/os-configuration-management/working-with-os-policies). type: object properties: - rebootConfig: - description: Post-patch reboot settings. + name: + description: >- + Resource name. Format: + `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id}` + This field is ignored when you create an OS policy assignment. type: string - enumDescriptions: - - The default behavior is DEFAULT. - - >- - The agent decides if a reboot is necessary by checking signals - such as registry keys on Windows or `/var/run/reboot-required` on - APT based systems. On RPM based systems, a set of core system - package install times are compared with system boot time. - - Always reboot the machine after the update completes. - - Never reboot the machine after the update completes. - enum: - - REBOOT_CONFIG_UNSPECIFIED - - DEFAULT - - ALWAYS - - NEVER - apt: + description: description: >- - Apt update settings. Use this setting to override the default `apt` - patch rules. - $ref: '#/components/schemas/AptSettings' - yum: + OS policy assignment description. Length of the description is + limited to 1024 characters. + type: string + osPolicies: + description: Required. List of OS policies to be applied to the VMs. + type: array + items: + $ref: '#/components/schemas/OSPolicy' + instanceFilter: + description: Required. Filter to select VMs. + $ref: '#/components/schemas/OSPolicyAssignmentInstanceFilter' + rollout: description: >- - Yum update settings. Use this setting to override the default `yum` - patch rules. - $ref: '#/components/schemas/YumSettings' - goo: + Required. Rollout to deploy the OS policy assignment. A rollout is + triggered in the following situations: 1) OSPolicyAssignment is + created. 2) OSPolicyAssignment is updated and the update contains + changes to one of the following fields: - instance_filter - + os_policies 3) OSPolicyAssignment is deleted. + $ref: '#/components/schemas/OSPolicyAssignmentRollout' + revisionId: description: >- - Goo update settings. Use this setting to override the default `goo` - patch rules. - $ref: '#/components/schemas/GooSettings' - zypper: + Output only. The assignment revision ID A new revision is committed + whenever a rollout is triggered for a OS policy assignment + readOnly: true + type: string + revisionCreateTime: + description: Output only. The timestamp that the revision was created. + readOnly: true + type: string + format: google-datetime + etag: + description: >- + The etag for this OS policy assignment. If this is provided on + update, it must match the server's etag. + type: string + rolloutState: + description: Output only. OS policy assignment rollout state + readOnly: true + type: string + enumDescriptions: + - Invalid value + - The rollout is in progress. + - The rollout is being cancelled. + - The rollout is cancelled. + - The rollout has completed successfully. + enum: + - ROLLOUT_STATE_UNSPECIFIED + - IN_PROGRESS + - CANCELLING + - CANCELLED + - SUCCEEDED + baseline: + description: >- + Output only. Indicates that this revision has been successfully + rolled out in this zone and new VMs will be assigned OS policies + from this revision. For a given OS policy assignment, there is only + one revision with a value of `true` for this field. + readOnly: true + type: boolean + deleted: description: >- - Zypper update settings. Use this setting to override the default - `zypper` patch rules. - $ref: '#/components/schemas/ZypperSettings' - windowsUpdate: + Output only. Indicates that this revision deletes the OS policy + assignment. + readOnly: true + type: boolean + reconciling: description: >- - Windows update settings. Use this override the default windows patch - rules. - $ref: '#/components/schemas/WindowsUpdateSettings' - preStep: - description: The `ExecStep` to run before the patch update. - $ref: '#/components/schemas/ExecStep' - postStep: - description: The `ExecStep` to run after the patch update. - $ref: '#/components/schemas/ExecStep' - migInstancesAllowed: - description: Allows the patch job to run on Managed instance groups (MIGs). + Output only. Indicates that reconciliation is in progress for the + revision. This value is `true` when the `rollout_state` is one of: * + IN_PROGRESS * CANCELLING + readOnly: true type: boolean - AptSettings: - id: AptSettings - description: >- - Apt patching is completed by executing `apt-get update && apt-get - upgrade`. Additional options can be set to control how this is executed. + uid: + description: >- + Output only. Server generated unique id for the OS policy assignment + resource. + readOnly: true + type: string + OSPolicy: + id: OSPolicy + description: An OS policy defines the desired state configuration for a VM. type: object properties: - type: + id: + description: >- + Required. The id of the OS policy with the following restrictions: * + Must contain only lowercase letters, numbers, and hyphens. * Must + start with a letter. * Must be between 1-63 characters. * Must end + with a number or a letter. * Must be unique within the assignment. + type: string + description: description: >- - By changing the type to DIST, the patching is performed using - `apt-get dist-upgrade` instead. + Policy description. Length of the description is limited to 1024 + characters. + type: string + mode: + description: Required. Policy mode type: string enumDescriptions: - - By default, upgrade will be performed. - - Runs `apt-get dist-upgrade`. - - Runs `apt-get upgrade`. + - Invalid mode + - >- + This mode checks if the configuration resources in the policy are + in their desired state. No actions are performed if they are not + in the desired state. This mode is used for reporting purposes. + - >- + This mode checks if the configuration resources in the policy are + in their desired state, and if not, enforces the desired state. enum: - - TYPE_UNSPECIFIED - - DIST - - UPGRADE - excludes: + - MODE_UNSPECIFIED + - VALIDATION + - ENFORCEMENT + resourceGroups: description: >- - List of packages to exclude from update. These packages will be - excluded + Required. List of resource groups for the policy. For a particular + VM, resource groups are evaluated in the order specified and the + first resource group that is applicable is selected and the rest are + ignored. If none of the resource groups are applicable for a VM, the + VM is considered to be non-compliant w.r.t this policy. This + behavior can be toggled by the flag `allow_no_resource_group_match` type: array items: - type: string - exclusivePackages: + $ref: '#/components/schemas/OSPolicyResourceGroup' + allowNoResourceGroupMatch: description: >- - An exclusive list of packages to be updated. These are the only - packages that will be updated. If these packages are not installed, - they will be ignored. This field cannot be specified with any other - patch configuration fields. - type: array - items: - type: string - YumSettings: - id: YumSettings + This flag determines the OS policy compliance status when none of + the resource groups within the policy are applicable for a VM. Set + this value to `true` if the policy needs to be reported as compliant + even if the policy has nothing to validate or enforce. + type: boolean + OSPolicyResourceGroup: + id: OSPolicyResourceGroup description: >- - Yum patching is performed by executing `yum update`. Additional options - can be set to control how this is executed. Note that not all settings - are supported on all platforms. + Resource groups provide a mechanism to group OS policy resources. + Resource groups enable OS policy authors to create a single OS policy to + be applied to VMs running different operating Systems. When the OS + policy is applied to a target VM, the appropriate resource group within + the OS policy is selected based on the `OSFilter` specified within the + resource group. type: object properties: - security: - description: >- - Adds the `--security` flag to `yum update`. Not supported on all - platforms. - type: boolean - minimal: - description: Will cause patch to run `yum update-minimal` instead. - type: boolean - excludes: + inventoryFilters: description: >- - List of packages to exclude from update. These packages are excluded - by using the yum `--exclude` flag. + List of inventory filters for the resource group. The resources in + this resource group are applied to the target VM if it satisfies at + least one of the following inventory filters. For example, to apply + this resource group to VMs running either `RHEL` or `CentOS` + operating systems, specify 2 items for the list with following + values: inventory_filters[0].os_short_name='rhel' and + inventory_filters[1].os_short_name='centos' If the list is empty, + this resource group will be applied to the target VM + unconditionally. type: array items: - type: string - exclusivePackages: + $ref: '#/components/schemas/OSPolicyInventoryFilter' + resources: description: >- - An exclusive list of packages to be updated. These are the only - packages that will be updated. If these packages are not installed, - they will be ignored. This field must not be specified with any - other patch configuration fields. + Required. List of resources configured for this resource group. The + resources are executed in the exact order specified here. type: array items: - type: string - GooSettings: - id: GooSettings - description: Googet patching is performed by running `googet update`. - type: object - properties: {} - ZypperSettings: - id: ZypperSettings - description: >- - Zypper patching is performed by running `zypper patch`. See also - https://en.opensuse.org/SDB:Zypper_manual. + $ref: '#/components/schemas/OSPolicyResource' + OSPolicyInventoryFilter: + id: OSPolicyInventoryFilter + description: Filtering criteria to select VMs based on inventory details. type: object properties: - withOptional: - description: Adds the `--with-optional` flag to `zypper patch`. - type: boolean - withUpdate: - description: Adds the `--with-update` flag, to `zypper patch`. - type: boolean - categories: - description: >- - Install only patches with these categories. Common categories - include security, recommended, and feature. - type: array - items: - type: string - severities: - description: >- - Install only patches with these severities. Common severities - include critical, important, moderate, and low. - type: array - items: - type: string - excludes: - description: List of patches to exclude from update. - type: array - items: - type: string - exclusivePatches: - description: >- - An exclusive list of patches to be updated. These are the only - patches that will be installed using 'zypper patch patch:' command. - This field must not be used with any other patch configuration - fields. - type: array - items: - type: string - WindowsUpdateSettings: - id: WindowsUpdateSettings - description: Windows patching is performed using the Windows Update Agent. - type: object - properties: - classifications: - description: >- - Only apply updates of these windows update classifications. If - empty, all updates are applied. - type: array - items: - type: string - enumDescriptions: - - >- - Invalid. If classifications are included, they must be - specified. - - >- - "A widely released fix for a specific problem that addresses a - critical, non-security-related bug." [1] - - >- - "A widely released fix for a product-specific, security-related - vulnerability. Security vulnerabilities are rated by their - severity. The severity rating is indicated in the Microsoft - security bulletin as critical, important, moderate, or low." [1] - - >- - "A widely released and frequent software update that contains - additions to a product's definition database. Definition - databases are often used to detect objects that have specific - attributes, such as malicious code, phishing websites, or junk - mail." [1] - - '"Software that controls the input and output of a device." [1]' - - >- - "New product functionality that is first distributed outside the - context of a product release and that is typically included in - the next full product release." [1] - - >- - "A tested, cumulative set of all hotfixes, security updates, - critical updates, and updates. Additionally, service packs may - contain additional fixes for problems that are found internally - since the release of the product. Service packs my also contain - a limited number of customer-requested design changes or - features." [1] - - >- - "A utility or feature that helps complete a task or set of - tasks." [1] - - >- - "A tested, cumulative set of hotfixes, security updates, - critical updates, and updates that are packaged together for - easy deployment. A rollup generally targets a specific area, - such as security, or a component of a product, such as Internet - Information Services (IIS)." [1] - - >- - "A widely released fix for a specific problem. An update - addresses a noncritical, non-security-related bug." [1] - enum: - - CLASSIFICATION_UNSPECIFIED - - CRITICAL - - SECURITY - - DEFINITION - - DRIVER - - FEATURE_PACK - - SERVICE_PACK - - TOOL - - UPDATE_ROLLUP - - UPDATE - excludes: - description: List of KBs to exclude from update. - type: array - items: - type: string - exclusivePatches: - description: >- - An exclusive list of kbs to be updated. These are the only patches - that will be updated. This field must not be used with other patch - configurations. - type: array - items: - type: string - ExecStep: - id: ExecStep - description: A step that runs an executable for a PatchJob. - type: object - properties: - linuxExecStepConfig: - description: The ExecStepConfig for all Linux VMs targeted by the PatchJob. - $ref: '#/components/schemas/ExecStepConfig' - windowsExecStepConfig: - description: The ExecStepConfig for all Windows VMs targeted by the PatchJob. - $ref: '#/components/schemas/ExecStepConfig' - ExecStepConfig: - id: ExecStepConfig - description: Common configurations for an ExecStep. - type: object - properties: - localPath: - description: An absolute path to the executable on the VM. - type: string - gcsObject: - description: A Cloud Storage object containing the executable. - $ref: '#/components/schemas/GcsObject' - allowedSuccessCodes: - description: >- - Defaults to [0]. A list of possible return values that the execution - can return to indicate a success. - type: array - items: - type: integer - format: int32 - interpreter: - description: >- - The script interpreter to use to run the script. If no interpreter - is specified the script will be executed directly, which will likely - only succeed for scripts with [shebang lines] - (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). - type: string - enumDescriptions: - - If the interpreter is not specified, the value defaults to `NONE`. - - >- - Indicates that the file is run as follows on each operating - system: + For Linux VMs, the file is ran as an executable and the - interpreter might be parsed from the [shebang - line](https://wikipedia.org/wiki/Shebang_(Unix)) of the file. + - For Windows VM, this value is not supported. - - >- - Indicates that the file is run with `/bin/sh` on Linux and `cmd` - on Windows. - - Indicates that the file is run with PowerShell. - enum: - - INTERPRETER_UNSPECIFIED - - NONE - - SHELL - - POWERSHELL - GcsObject: - id: GcsObject - description: Cloud Storage object representation. - type: object - properties: - bucket: - description: Required. Bucket of the Cloud Storage object. - type: string - object: - description: Required. Name of the Cloud Storage object. - type: string - generationNumber: - description: >- - Required. Generation number of the Cloud Storage object. This is - used to ensure that the ExecStep specified by this PatchJob does not - change. - type: string - format: int64 - PatchRollout: - id: PatchRollout - description: >- - Patch rollout configuration specifications. Contains details on the - concurrency control when applying patch(es) to all targeted VMs. - type: object - properties: - mode: - description: Mode of the patch rollout. - type: string - enumDescriptions: - - Mode must be specified. - - >- - Patches are applied one zone at a time. The patch job begins in - the region with the lowest number of targeted VMs. Within the - region, patching begins in the zone with the lowest number of - targeted VMs. If multiple regions (or zones within a region) have - the same number of targeted VMs, a tie-breaker is achieved by - sorting the regions or zones in alphabetical order. - - Patches are applied to VMs in all zones at the same time. - enum: - - MODE_UNSPECIFIED - - ZONE_BY_ZONE - - CONCURRENT_ZONES - disruptionBudget: - description: >- - The maximum number (or percentage) of VMs per zone to disrupt at any - given moment. The number of VMs calculated from multiplying the - percentage by the total number of VMs in a zone is rounded up. - During patching, a VM is considered disrupted from the time the - agent is notified to begin until patching has completed. This - disruption time includes the time to complete reboot and any - post-patch steps. A VM contributes to the disruption budget if its - patching operation fails either when applying the patches, running - pre or post patch steps, or if it fails to respond with a success - notification before timing out. VMs that are not running or do not - have an active agent do not count toward this disruption budget. For - zone-by-zone rollouts, if the disruption budget in a zone is - exceeded, the patch job stops, because continuing to the next zone - requires completion of the patch process in the previous zone. For - example, if the disruption budget has a fixed value of `10`, and 8 - VMs fail to patch in the current zone, the patch job continues to - patch 2 VMs at a time until the zone is completed. When that zone is - completed successfully, patching begins with 10 VMs at a time in the - next zone. If 10 VMs in the next zone fail to patch, the patch job - stops. - $ref: '#/components/schemas/FixedOrPercent' - FixedOrPercent: - id: FixedOrPercent - description: >- - Message encapsulating a value that can be either absolute ("fixed") or - relative ("percent") to a value. - type: object - properties: - fixed: - description: Specifies a fixed value. - type: integer - format: int32 - percent: - description: >- - Specifies the relative value defined as a percentage, which will be - multiplied by a reference value. - type: integer - format: int32 - PatchJob: - id: PatchJob - description: >- - A high level representation of a patch job that is either in progress or - has completed. Instance details are not included in the job. To paginate - through instance details, use `ListPatchJobInstanceDetails`. For more - information about patch jobs, see [Creating patch - jobs](https://cloud.google.com/compute/docs/os-patch-management/create-patch-job). - type: object - properties: - name: - description: >- - Unique identifier for this patch job in the form - `projects/*/patchJobs/*` - type: string - displayName: - description: Display name for this patch job. This is not a unique identifier. - type: string - description: - description: >- - Description of the patch job. Length of the description is limited - to 1024 characters. - type: string - createTime: - description: Time this patch job was created. - type: string - format: google-datetime - updateTime: - description: Last time this patch job was updated. - type: string - format: google-datetime - state: - description: The current state of the PatchJob. - type: string - enumDescriptions: - - State must be specified. - - The patch job was successfully initiated. - - The patch job is looking up instances to run the patch on. - - Instances are being patched. - - Patch job completed successfully. - - Patch job completed but there were errors. - - The patch job was canceled. - - The patch job timed out. - enum: - - STATE_UNSPECIFIED - - STARTED - - INSTANCE_LOOKUP - - PATCHING - - SUCCEEDED - - COMPLETED_WITH_ERRORS - - CANCELED - - TIMED_OUT - instanceFilter: - description: Instances to patch. - $ref: '#/components/schemas/PatchInstanceFilter' - patchConfig: - description: Patch configuration being applied. - $ref: '#/components/schemas/PatchConfig' - duration: - description: >- - Duration of the patch job. After the duration ends, the patch job - times out. - type: string - format: google-duration - instanceDetailsSummary: - description: Summary of instance details. - $ref: '#/components/schemas/PatchJobInstanceDetailsSummary' - dryRun: - description: >- - If this patch job is a dry run, the agent reports that it has - finished without running any updates on the VM instance. - type: boolean - errorMessage: - description: >- - If this patch job failed, this message provides information about - the failure. - type: string - percentComplete: - description: >- - Reflects the overall progress of the patch job in the range of 0.0 - being no progress to 100.0 being complete. - type: number - format: double - patchDeployment: - description: >- - Output only. Name of the patch deployment that created this patch - job. - readOnly: true - type: string - rollout: - description: Rollout strategy being applied. - $ref: '#/components/schemas/PatchRollout' - PatchJobInstanceDetailsSummary: - id: PatchJobInstanceDetailsSummary - description: >- - A summary of the current patch state across all instances that this - patch job affects. Contains counts of instances in different states. - These states map to `InstancePatchState`. List patch job instance - details to see the specific states of each instance. - type: object - properties: - pendingInstanceCount: - description: Number of instances pending patch job. - type: string - format: int64 - inactiveInstanceCount: - description: Number of instances that are inactive. - type: string - format: int64 - notifiedInstanceCount: - description: Number of instances notified about patch job. - type: string - format: int64 - startedInstanceCount: - description: Number of instances that have started. - type: string - format: int64 - downloadingPatchesInstanceCount: - description: Number of instances that are downloading patches. - type: string - format: int64 - applyingPatchesInstanceCount: - description: Number of instances that are applying patches. - type: string - format: int64 - rebootingInstanceCount: - description: Number of instances rebooting. - type: string - format: int64 - succeededInstanceCount: - description: Number of instances that have completed successfully. - type: string - format: int64 - succeededRebootRequiredInstanceCount: - description: Number of instances that require reboot. - type: string - format: int64 - failedInstanceCount: - description: Number of instances that failed. - type: string - format: int64 - ackedInstanceCount: - description: Number of instances that have acked and will start shortly. - type: string - format: int64 - timedOutInstanceCount: - description: >- - Number of instances that exceeded the time out while applying the - patch. - type: string - format: int64 - prePatchStepInstanceCount: - description: Number of instances that are running the pre-patch step. - type: string - format: int64 - postPatchStepInstanceCount: - description: Number of instances that are running the post-patch step. - type: string - format: int64 - noAgentDetectedInstanceCount: - description: >- - Number of instances that do not appear to be running the agent. - Check to ensure that the agent is installed, running, and able to - communicate with the service. - type: string - format: int64 - CancelPatchJobRequest: - id: CancelPatchJobRequest - description: Message for canceling a patch job. - type: object - properties: {} - ListPatchJobsResponse: - id: ListPatchJobsResponse - description: A response message for listing patch jobs. - type: object - properties: - patchJobs: - description: The list of patch jobs. - type: array - items: - $ref: '#/components/schemas/PatchJob' - nextPageToken: - description: A pagination token that can be used to get the next page of results. - type: string - ListPatchJobInstanceDetailsResponse: - id: ListPatchJobInstanceDetailsResponse - description: A response message for listing the instances details for a patch job. - type: object - properties: - patchJobInstanceDetails: - description: A list of instance status. - type: array - items: - $ref: '#/components/schemas/PatchJobInstanceDetails' - nextPageToken: - description: A pagination token that can be used to get the next page of results. - type: string - PatchJobInstanceDetails: - id: PatchJobInstanceDetails - description: >- - Patch details for a VM instance. For more information about reviewing VM - instance details, see [Listing all VM instance details for a specific - patch - job](https://cloud.google.com/compute/docs/os-patch-management/manage-patch-jobs#list-instance-details). - type: object - properties: - name: - description: The instance name in the form `projects/*/zones/*/instances/*` - type: string - instanceSystemId: - description: >- - The unique identifier for the instance. This identifier is defined - by the server. - type: string - state: - description: Current state of instance patch. - type: string - enumDescriptions: - - Unspecified. - - The instance is not yet notified. - - Instance is inactive and cannot be patched. - - The instance is notified that it should be patched. - - The instance has started the patching process. - - The instance is downloading patches. - - The instance is applying patches. - - The instance is rebooting. - - The instance has completed applying patches. - - >- - The instance has completed applying patches but a reboot is - required. - - The instance has failed to apply the patch. - - The instance acked the notification and will start shortly. - - The instance exceeded the time out while applying the patch. - - The instance is running the pre-patch step. - - The instance is running the post-patch step. - - >- - The service could not detect the presence of the agent. Check to - ensure that the agent is installed, running, and able to - communicate with the service. - enum: - - PATCH_STATE_UNSPECIFIED - - PENDING - - INACTIVE - - NOTIFIED - - STARTED - - DOWNLOADING_PATCHES - - APPLYING_PATCHES - - REBOOTING - - SUCCEEDED - - SUCCEEDED_REBOOT_REQUIRED - - FAILED - - ACKED - - TIMED_OUT - - RUNNING_PRE_PATCH_STEP - - RUNNING_POST_PATCH_STEP - - NO_AGENT_DETECTED - failureReason: - description: If the patch fails, this field provides the reason. - type: string - attemptCount: - description: >- - The number of times the agent that the agent attempts to apply the - patch. - type: string - format: int64 - PatchDeployment: - id: PatchDeployment - description: >- - Patch deployments are configurations that individual patch jobs use to - complete a patch. These configurations include instance filter, package - repository settings, and a schedule. For more information about creating - and managing patch deployments, see [Scheduling patch - jobs](https://cloud.google.com/compute/docs/os-patch-management/schedule-patch-jobs). - type: object - properties: - name: - description: >- - Unique name for the patch deployment resource in a project. The - patch deployment name is in the form: - `projects/{project_id}/patchDeployments/{patch_deployment_id}`. This - field is ignored when you create a new patch deployment. - type: string - description: - description: >- - Optional. Description of the patch deployment. Length of the - description is limited to 1024 characters. - type: string - instanceFilter: - description: Required. VM instances to patch. - $ref: '#/components/schemas/PatchInstanceFilter' - patchConfig: - description: Optional. Patch configuration that is applied. - $ref: '#/components/schemas/PatchConfig' - duration: - description: >- - Optional. Duration of the patch. After the duration ends, the patch - times out. - type: string - format: google-duration - oneTimeSchedule: - description: Required. Schedule a one-time execution. - $ref: '#/components/schemas/OneTimeSchedule' - recurringSchedule: - description: Required. Schedule recurring executions. - $ref: '#/components/schemas/RecurringSchedule' - createTime: - description: >- - Output only. Time the patch deployment was created. Timestamp is in - [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - readOnly: true - type: string - format: google-datetime - updateTime: - description: >- - Output only. Time the patch deployment was last updated. Timestamp - is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - readOnly: true - type: string - format: google-datetime - lastExecuteTime: - description: >- - Output only. The last time a patch job was started by this - deployment. Timestamp is in - [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - readOnly: true - type: string - format: google-datetime - rollout: - description: Optional. Rollout strategy of the patch job. - $ref: '#/components/schemas/PatchRollout' - state: - description: Output only. Current state of the patch deployment. - readOnly: true - type: string - enumDescriptions: - - The default value. This value is used if the state is omitted. - - Active value means that patch deployment generates Patch Jobs. - - >- - Paused value means that patch deployment does not generate Patch - jobs. Requires user action to move in and out from this state. - enum: - - STATE_UNSPECIFIED - - ACTIVE - - PAUSED - OneTimeSchedule: - id: OneTimeSchedule - description: >- - Sets the time for a one time patch deployment. Timestamp is in - [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - type: object - properties: - executeTime: - description: Required. The desired patch job execution time. - type: string - format: google-datetime - RecurringSchedule: - id: RecurringSchedule - description: Sets the time for recurring patch deployments. - type: object - properties: - timeZone: - description: >- - Required. Defines the time zone that `time_of_day` is relative to. - The rules for daylight saving time are determined by the chosen time - zone. - $ref: '#/components/schemas/TimeZone' - startTime: - description: >- - Optional. The time that the recurring schedule becomes effective. - Defaults to `create_time` of the patch deployment. - type: string - format: google-datetime - endTime: - description: >- - Optional. The end time at which a recurring patch deployment - schedule is no longer active. - type: string - format: google-datetime - timeOfDay: - description: Required. Time of the day to run a recurring deployment. - $ref: '#/components/schemas/TimeOfDay' - frequency: - description: Required. The frequency unit of this recurring schedule. - type: string - enumDescriptions: - - Invalid. A frequency must be specified. - - >- - Indicates that the frequency of recurrence should be expressed in - terms of weeks. - - >- - Indicates that the frequency of recurrence should be expressed in - terms of months. - - >- - Indicates that the frequency of recurrence should be expressed in - terms of days. - enum: - - FREQUENCY_UNSPECIFIED - - WEEKLY - - MONTHLY - - DAILY - weekly: - description: Required. Schedule with weekly executions. - $ref: '#/components/schemas/WeeklySchedule' - monthly: - description: Required. Schedule with monthly executions. - $ref: '#/components/schemas/MonthlySchedule' - lastExecuteTime: - description: Output only. The time the last patch job ran successfully. - readOnly: true - type: string - format: google-datetime - nextExecuteTime: - description: Output only. The time the next patch job is scheduled to run. - readOnly: true - type: string - format: google-datetime - TimeZone: - id: TimeZone - description: >- - Represents a time zone from the [IANA Time Zone - Database](https://www.iana.org/time-zones). - type: object - properties: - id: - description: IANA Time Zone Database time zone, e.g. "America/New_York". - type: string - version: - description: Optional. IANA Time Zone Database version number, e.g. "2019a". - type: string - TimeOfDay: - id: TimeOfDay - description: >- - Represents a time of day. The date and time zone are either not - significant or are specified elsewhere. An API may choose to allow leap - seconds. Related types are google.type.Date and - `google.protobuf.Timestamp`. - type: object - properties: - hours: - description: >- - Hours of a day in 24 hour format. Must be greater than or equal to 0 - and typically must be less than or equal to 23. An API may choose to - allow the value "24:00:00" for scenarios like business closing time. - type: integer - format: int32 - minutes: - description: >- - Minutes of an hour. Must be greater than or equal to 0 and less than - or equal to 59. - type: integer - format: int32 - seconds: - description: >- - Seconds of a minute. Must be greater than or equal to 0 and - typically must be less than or equal to 59. An API may allow the - value 60 if it allows leap-seconds. - type: integer - format: int32 - nanos: - description: >- - Fractions of seconds, in nanoseconds. Must be greater than or equal - to 0 and less than or equal to 999,999,999. - type: integer - format: int32 - WeeklySchedule: - id: WeeklySchedule - description: Represents a weekly schedule. - type: object - properties: - dayOfWeek: - description: Required. Day of the week. - type: string - enumDescriptions: - - The day of the week is unspecified. - - Monday - - Tuesday - - Wednesday - - Thursday - - Friday - - Saturday - - Sunday - enum: - - DAY_OF_WEEK_UNSPECIFIED - - MONDAY - - TUESDAY - - WEDNESDAY - - THURSDAY - - FRIDAY - - SATURDAY - - SUNDAY - MonthlySchedule: - id: MonthlySchedule - description: >- - Represents a monthly schedule. An example of a valid monthly schedule is - "on the third Tuesday of the month" or "on the 15th of the month". - type: object - properties: - weekDayOfMonth: - description: Required. Week day in a month. - $ref: '#/components/schemas/WeekDayOfMonth' - monthDay: - description: >- - Required. One day of the month. 1-31 indicates the 1st to the 31st - day. -1 indicates the last day of the month. Months without the - target day will be skipped. For example, a schedule to run "every - month on the 31st" will not run in February, April, June, etc. - type: integer - format: int32 - WeekDayOfMonth: - id: WeekDayOfMonth - description: Represents one week day in a month. An example is "the 4th Sunday". - type: object - properties: - weekOrdinal: - description: >- - Required. Week number in a month. 1-4 indicates the 1st to 4th week - of the month. -1 indicates the last week of the month. - type: integer - format: int32 - dayOfWeek: - description: Required. A day of the week. - type: string - enumDescriptions: - - The day of the week is unspecified. - - Monday - - Tuesday - - Wednesday - - Thursday - - Friday - - Saturday - - Sunday - enum: - - DAY_OF_WEEK_UNSPECIFIED - - MONDAY - - TUESDAY - - WEDNESDAY - - THURSDAY - - FRIDAY - - SATURDAY - - SUNDAY - dayOffset: - description: >- - Optional. Represents the number of days before or after the given - week day of month that the patch deployment is scheduled for. For - example if `week_ordinal` and `day_of_week` values point to the - second Tuesday of the month and the `day_offset` value is set to - `3`, patch deployment takes place three days after the second - Tuesday of the month. If this value is negative, for example -5, - patches are deployed five days before the second Tuesday of the - month. Allowed values are in range [-30, 30]. - type: integer - format: int32 - ListPatchDeploymentsResponse: - id: ListPatchDeploymentsResponse - description: A response message for listing patch deployments. - type: object - properties: - patchDeployments: - description: The list of patch deployments. - type: array - items: - $ref: '#/components/schemas/PatchDeployment' - nextPageToken: - description: >- - A pagination token that can be used to get the next page of patch - deployments. - type: string - PausePatchDeploymentRequest: - id: PausePatchDeploymentRequest - description: A request message for pausing a patch deployment. - type: object - properties: {} - ResumePatchDeploymentRequest: - id: ResumePatchDeploymentRequest - description: A request message for resuming a patch deployment. - type: object - properties: {} - OSPolicyAssignment: - id: OSPolicyAssignment - description: >- - OS policy assignment is an API resource that is used to apply a set of - OS policies to a dynamically targeted group of Compute Engine VM - instances. An OS policy is used to define the desired state - configuration for a Compute Engine VM instance through a set of - configuration resources that provide capabilities such as installing or - removing software packages, or executing a script. For more information - about the OS policy resource definitions and examples, see [OS policy - and OS policy - assignment](https://cloud.google.com/compute/docs/os-configuration-management/working-with-os-policies). - type: object - properties: - name: - description: >- - Resource name. Format: - `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id}` - This field is ignored when you create an OS policy assignment. - type: string - description: - description: >- - OS policy assignment description. Length of the description is - limited to 1024 characters. - type: string - osPolicies: - description: Required. List of OS policies to be applied to the VMs. - type: array - items: - $ref: '#/components/schemas/OSPolicy' - instanceFilter: - description: Required. Filter to select VMs. - $ref: '#/components/schemas/OSPolicyAssignmentInstanceFilter' - rollout: - description: >- - Required. Rollout to deploy the OS policy assignment. A rollout is - triggered in the following situations: 1) OSPolicyAssignment is - created. 2) OSPolicyAssignment is updated and the update contains - changes to one of the following fields: - instance_filter - - os_policies 3) OSPolicyAssignment is deleted. - $ref: '#/components/schemas/OSPolicyAssignmentRollout' - revisionId: - description: >- - Output only. The assignment revision ID A new revision is committed - whenever a rollout is triggered for a OS policy assignment - readOnly: true - type: string - revisionCreateTime: - description: Output only. The timestamp that the revision was created. - readOnly: true - type: string - format: google-datetime - etag: - description: >- - The etag for this OS policy assignment. If this is provided on - update, it must match the server's etag. - type: string - rolloutState: - description: Output only. OS policy assignment rollout state - readOnly: true - type: string - enumDescriptions: - - Invalid value - - The rollout is in progress. - - The rollout is being cancelled. - - The rollout is cancelled. - - The rollout has completed successfully. - enum: - - ROLLOUT_STATE_UNSPECIFIED - - IN_PROGRESS - - CANCELLING - - CANCELLED - - SUCCEEDED - baseline: - description: >- - Output only. Indicates that this revision has been successfully - rolled out in this zone and new VMs will be assigned OS policies - from this revision. For a given OS policy assignment, there is only - one revision with a value of `true` for this field. - readOnly: true - type: boolean - deleted: - description: >- - Output only. Indicates that this revision deletes the OS policy - assignment. - readOnly: true - type: boolean - reconciling: - description: >- - Output only. Indicates that reconciliation is in progress for the - revision. This value is `true` when the `rollout_state` is one of: * - IN_PROGRESS * CANCELLING - readOnly: true - type: boolean - uid: - description: >- - Output only. Server generated unique id for the OS policy assignment - resource. - readOnly: true - type: string - OSPolicy: - id: OSPolicy - description: An OS policy defines the desired state configuration for a VM. - type: object - properties: - id: - description: >- - Required. The id of the OS policy with the following restrictions: * - Must contain only lowercase letters, numbers, and hyphens. * Must - start with a letter. * Must be between 1-63 characters. * Must end - with a number or a letter. * Must be unique within the assignment. - type: string - description: - description: >- - Policy description. Length of the description is limited to 1024 - characters. - type: string - mode: - description: Required. Policy mode - type: string - enumDescriptions: - - Invalid mode - - >- - This mode checks if the configuration resources in the policy are - in their desired state. No actions are performed if they are not - in the desired state. This mode is used for reporting purposes. - - >- - This mode checks if the configuration resources in the policy are - in their desired state, and if not, enforces the desired state. - enum: - - MODE_UNSPECIFIED - - VALIDATION - - ENFORCEMENT - resourceGroups: - description: >- - Required. List of resource groups for the policy. For a particular - VM, resource groups are evaluated in the order specified and the - first resource group that is applicable is selected and the rest are - ignored. If none of the resource groups are applicable for a VM, the - VM is considered to be non-compliant w.r.t this policy. This - behavior can be toggled by the flag `allow_no_resource_group_match` - type: array - items: - $ref: '#/components/schemas/OSPolicyResourceGroup' - allowNoResourceGroupMatch: - description: >- - This flag determines the OS policy compliance status when none of - the resource groups within the policy are applicable for a VM. Set - this value to `true` if the policy needs to be reported as compliant - even if the policy has nothing to validate or enforce. - type: boolean - OSPolicyResourceGroup: - id: OSPolicyResourceGroup - description: >- - Resource groups provide a mechanism to group OS policy resources. - Resource groups enable OS policy authors to create a single OS policy to - be applied to VMs running different operating Systems. When the OS - policy is applied to a target VM, the appropriate resource group within - the OS policy is selected based on the `OSFilter` specified within the - resource group. - type: object - properties: - inventoryFilters: - description: >- - List of inventory filters for the resource group. The resources in - this resource group are applied to the target VM if it satisfies at - least one of the following inventory filters. For example, to apply - this resource group to VMs running either `RHEL` or `CentOS` - operating systems, specify 2 items for the list with following - values: inventory_filters[0].os_short_name='rhel' and - inventory_filters[1].os_short_name='centos' If the list is empty, - this resource group will be applied to the target VM - unconditionally. - type: array - items: - $ref: '#/components/schemas/OSPolicyInventoryFilter' - resources: - description: >- - Required. List of resources configured for this resource group. The - resources are executed in the exact order specified here. - type: array - items: - $ref: '#/components/schemas/OSPolicyResource' - OSPolicyInventoryFilter: - id: OSPolicyInventoryFilter - description: Filtering criteria to select VMs based on inventory details. - type: object - properties: - osShortName: - description: Required. The OS short name - type: string - osVersion: + osShortName: + description: Required. The OS short name + type: string + osVersion: description: >- The OS version Prefix matches are supported if asterisk(*) is provided as the last character. For example, to match all versions @@ -1851,1050 +965,221 @@ components: - CONTENTS_MATCH permissions: description: >- - Consists of three octal digits which represent, in order, the - permissions of the owner, group, and other users for the file - (similarly to the numeric mode used in the linux chmod utility). - Each digit represents a three bit number with the 4 bit - corresponding to the read permissions, the 2 bit corresponds to the - write bit, and the one bit corresponds to the execute permission. - Default behavior is 755. Below are some examples of permissions and - their associated values: read, write, and execute: 7 read and - execute: 5 read and write: 6 read only: 4 - type: string - OSPolicyAssignmentInstanceFilter: - id: OSPolicyAssignmentInstanceFilter - description: >- - Filters to select target VMs for an assignment. If more than one filter - criteria is specified below, a VM will be selected if and only if it - satisfies all of them. - type: object - properties: - all: - description: >- - Target all VMs in the project. If true, no other criteria is - permitted. - type: boolean - inclusionLabels: - description: >- - List of label sets used for VM inclusion. If the list has more than - one `LabelSet`, the VM is included if any of the label sets are - applicable for the VM. - type: array - items: - $ref: '#/components/schemas/OSPolicyAssignmentLabelSet' - exclusionLabels: - description: >- - List of label sets used for VM exclusion. If the list has more than - one label set, the VM is excluded if any of the label sets are - applicable for the VM. - type: array - items: - $ref: '#/components/schemas/OSPolicyAssignmentLabelSet' - inventories: - description: >- - List of inventories to select VMs. A VM is selected if its inventory - data matches at least one of the following inventories. - type: array - items: - $ref: '#/components/schemas/OSPolicyAssignmentInstanceFilterInventory' - OSPolicyAssignmentLabelSet: - id: OSPolicyAssignmentLabelSet - description: >- - Message representing label set. * A label is a key value pair set for a - VM. * A LabelSet is a set of labels. * Labels within a LabelSet are - ANDed. In other words, a LabelSet is applicable for a VM only if it - matches all the labels in the LabelSet. * Example: A LabelSet with 2 - labels: `env=prod` and `type=webserver` will only be applicable for - those VMs with both labels present. - type: object - properties: - labels: - description: >- - Labels are identified by key/value pairs in this map. A VM should - contain all the key/value pairs specified in this map to be - selected. - type: object - additionalProperties: - type: string - OSPolicyAssignmentInstanceFilterInventory: - id: OSPolicyAssignmentInstanceFilterInventory - description: VM inventory details. - type: object - properties: - osShortName: - description: Required. The OS short name - type: string - osVersion: - description: >- - The OS version Prefix matches are supported if asterisk(*) is - provided as the last character. For example, to match all versions - with a major version of `7`, specify the following value for this - field `7.*` An empty string matches all OS versions. - type: string - OSPolicyAssignmentRollout: - id: OSPolicyAssignmentRollout - description: >- - Message to configure the rollout at the zonal level for the OS policy - assignment. - type: object - properties: - disruptionBudget: - description: >- - Required. The maximum number (or percentage) of VMs per zone to - disrupt at any given moment. - $ref: '#/components/schemas/FixedOrPercent' - minWaitDuration: - description: >- - Required. This determines the minimum duration of time to wait after - the configuration changes are applied through the current rollout. A - VM continues to count towards the `disruption_budget` at least until - this duration of time has passed after configuration changes are - applied. - type: string - format: google-duration - ListOSPolicyAssignmentsResponse: - id: ListOSPolicyAssignmentsResponse - description: A response message for listing all assignments under given parent. - type: object - properties: - osPolicyAssignments: - description: The list of assignments - type: array - items: - $ref: '#/components/schemas/OSPolicyAssignment' - nextPageToken: - description: >- - The pagination token to retrieve the next page of OS policy - assignments. - type: string - ListOSPolicyAssignmentRevisionsResponse: - id: ListOSPolicyAssignmentRevisionsResponse - description: A response message for listing all revisions for a OS policy assignment. - type: object - properties: - osPolicyAssignments: - description: The OS policy assignment revisions - type: array - items: - $ref: '#/components/schemas/OSPolicyAssignment' - nextPageToken: - description: >- - The pagination token to retrieve the next page of OS policy - assignment revisions. - type: string - OSPolicyAssignmentReport: - id: OSPolicyAssignmentReport - description: A report of the OS policy assignment status for a given instance. - type: object - properties: - name: - description: >- - The `OSPolicyAssignmentReport` API resource name. Format: - `projects/{project_number}/locations/{location}/instances/{instance_id}/osPolicyAssignments/{os_policy_assignment_id}/report` - type: string - instance: - description: The Compute Engine VM instance name. - type: string - osPolicyAssignment: - description: >- - Reference to the `OSPolicyAssignment` API resource that the - `OSPolicy` belongs to. Format: - `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id@revision_id}` - type: string - osPolicyCompliances: - description: Compliance data for each `OSPolicy` that is applied to the VM. - type: array - items: - $ref: '#/components/schemas/OSPolicyAssignmentReportOSPolicyCompliance' - updateTime: - description: Timestamp for when the report was last generated. - type: string - format: google-datetime - lastRunId: - description: >- - Unique identifier of the last attempted run to apply the OS policies - associated with this assignment on the VM. This ID is logged by the - OS Config agent while applying the OS policies associated with this - assignment on the VM. NOTE: If the service is unable to successfully - connect to the agent for this run, then this id will not be - available in the agent logs. - type: string - OSPolicyAssignmentReportOSPolicyCompliance: - id: OSPolicyAssignmentReportOSPolicyCompliance - description: Compliance data for an OS policy - type: object - properties: - osPolicyId: - description: The OS policy id - type: string - complianceState: - description: The compliance state of the OS policy. - type: string - enumDescriptions: - - >- - The policy is in an unknown compliance state. Refer to the field - `compliance_state_reason` to learn the exact reason for the policy - to be in this compliance state. - - >- - Policy is compliant. The policy is compliant if all the underlying - resources are also compliant. - - >- - Policy is non-compliant. The policy is non-compliant if one or - more underlying resources are non-compliant. - enum: - - UNKNOWN - - COMPLIANT - - NON_COMPLIANT - complianceStateReason: - description: >- - The reason for the OS policy to be in an unknown compliance state. - This field is always populated when `compliance_state` is `UNKNOWN`. - If populated, the field can contain one of the following values: * - `vm-not-running`: The VM was not running. * - `os-policies-not-supported-by-agent`: The version of the OS Config - agent running on the VM does not support running OS policies. * - `no-agent-detected`: The OS Config agent is not detected for the VM. - * `resource-execution-errors`: The OS Config agent encountered - errors while executing one or more resources in the policy. See - `os_policy_resource_compliances` for details. * `task-timeout`: The - task sent to the agent to apply the policy timed out. * - `unexpected-agent-state`: The OS Config agent did not report the - final status of the task that attempted to apply the policy. - Instead, the agent unexpectedly started working on a different task. - This mostly happens when the agent or VM unexpectedly restarts while - applying OS policies. * `internal-service-errors`: Internal service - errors were encountered while attempting to apply the policy. * - `os-policy-execution-pending`: OS policy was assigned to the given - VM, but was not executed yet. Typically this is a transient - condition that will go away after the next policy execution cycle. - type: string - osPolicyResourceCompliances: - description: >- - Compliance data for each resource within the policy that is applied - to the VM. - type: array - items: - $ref: >- - #/components/schemas/OSPolicyAssignmentReportOSPolicyComplianceOSPolicyResourceCompliance - OSPolicyAssignmentReportOSPolicyComplianceOSPolicyResourceCompliance: - id: OSPolicyAssignmentReportOSPolicyComplianceOSPolicyResourceCompliance - description: Compliance data for an OS policy resource. - type: object - properties: - osPolicyResourceId: - description: The ID of the OS policy resource. - type: string - configSteps: - description: >- - Ordered list of configuration completed by the agent for the OS - policy resource. - type: array - items: - $ref: >- - #/components/schemas/OSPolicyAssignmentReportOSPolicyComplianceOSPolicyResourceComplianceOSPolicyResourceConfigStep - complianceState: - description: The compliance state of the resource. - type: string - enumDescriptions: - - >- - The resource is in an unknown compliance state. To get more - details about why the policy is in this state, review the output - of the `compliance_state_reason` field. - - Resource is compliant. - - Resource is non-compliant. - enum: - - UNKNOWN - - COMPLIANT - - NON_COMPLIANT - complianceStateReason: - description: >- - A reason for the resource to be in the given compliance state. This - field is always populated when `compliance_state` is `UNKNOWN`. The - following values are supported when `compliance_state == UNKNOWN` * - `execution-errors`: Errors were encountered by the agent while - executing the resource and the compliance state couldn't be - determined. * `execution-skipped-by-agent`: Resource execution was - skipped by the agent because errors were encountered while executing - prior resources in the OS policy. * - `os-policy-execution-attempt-failed`: The execution of the OS policy - containing this resource failed and the compliance state couldn't be - determined. * `os-policy-execution-pending`: OS policy that owns - this resource was assigned to the given VM, but was not executed - yet. - type: string - execResourceOutput: - description: ExecResource specific output. - $ref: >- - #/components/schemas/OSPolicyAssignmentReportOSPolicyComplianceOSPolicyResourceComplianceExecResourceOutput - OSPolicyAssignmentReportOSPolicyComplianceOSPolicyResourceComplianceOSPolicyResourceConfigStep: - id: >- - OSPolicyAssignmentReportOSPolicyComplianceOSPolicyResourceComplianceOSPolicyResourceConfigStep - description: >- - Step performed by the OS Config agent for configuring an `OSPolicy` - resource to its desired state. - type: object - properties: - type: - description: Configuration step type. - type: string - enumDescriptions: - - Default value. This value is unused. - - Checks for resource conflicts such as schema errors. - - Checks the current status of the desired state for a resource. - - >- - Enforces the desired state for a resource that is not in desired - state. - - >- - Re-checks the status of the desired state. This check is done for - a resource after the enforcement of all OS policies. This step is - used to determine the final desired state status for the resource. - It accounts for any resources that might have drifted from their - desired state due to side effects from executing other resources. - enum: - - TYPE_UNSPECIFIED - - VALIDATION - - DESIRED_STATE_CHECK - - DESIRED_STATE_ENFORCEMENT - - DESIRED_STATE_CHECK_POST_ENFORCEMENT - errorMessage: - description: >- - An error message recorded during the execution of this step. Only - populated if errors were encountered during this step execution. - type: string - OSPolicyAssignmentReportOSPolicyComplianceOSPolicyResourceComplianceExecResourceOutput: - id: >- - OSPolicyAssignmentReportOSPolicyComplianceOSPolicyResourceComplianceExecResourceOutput - description: ExecResource specific output. - type: object - properties: - enforcementOutput: - description: >- - Output from enforcement phase output file (if run). Output size is - limited to 100K bytes. - type: string - format: byte - ListOSPolicyAssignmentReportsResponse: - id: ListOSPolicyAssignmentReportsResponse - description: >- - A response message for listing OS Policy assignment reports including - the page of results and page token. - type: object - properties: - osPolicyAssignmentReports: - description: List of OS policy assignment reports. - type: array - items: - $ref: '#/components/schemas/OSPolicyAssignmentReport' - nextPageToken: - description: >- - The pagination token to retrieve the next page of OS policy - assignment report objects. - type: string - Inventory: - id: Inventory - description: >- - This API resource represents the available inventory data for a Compute - Engine virtual machine (VM) instance at a given point in time. You can - use this API resource to determine the inventory data of your VM. For - more information, see [Information provided by OS inventory - management](https://cloud.google.com/compute/docs/instances/os-inventory-management#data-collected). - type: object - properties: - name: - description: >- - Output only. The `Inventory` API resource name. Format: - `projects/{project_number}/locations/{location}/instances/{instance_id}/inventory` - readOnly: true - type: string - osInfo: - description: Base level operating system information for the VM. - $ref: '#/components/schemas/InventoryOsInfo' - items: - description: >- - Inventory items related to the VM keyed by an opaque unique - identifier for each inventory item. The identifier is unique to each - distinct and addressable inventory item and will change, when there - is a new package version. - type: object - additionalProperties: - $ref: '#/components/schemas/InventoryItem' - updateTime: - description: Output only. Timestamp of the last reported inventory for the VM. - readOnly: true - type: string - format: google-datetime - InventoryOsInfo: - id: InventoryOsInfo - description: Operating system information for the VM. - type: object - properties: - hostname: - description: The VM hostname. - type: string - longName: - description: >- - The operating system long name. For example 'Debian GNU/Linux 9' or - 'Microsoft Window Server 2019 Datacenter'. - type: string - shortName: - description: The operating system short name. For example, 'windows' or 'debian'. - type: string - version: - description: The version of the operating system. - type: string - architecture: - description: The system architecture of the operating system. - type: string - kernelVersion: - description: The kernel version of the operating system. - type: string - kernelRelease: - description: The kernel release of the operating system. - type: string - osconfigAgentVersion: - description: The current version of the OS Config agent running on the VM. - type: string - InventoryItem: - id: InventoryItem - description: A single piece of inventory on a VM. - type: object - properties: - id: - description: Identifier for this item, unique across items for this VM. - type: string - originType: - description: The origin of this inventory item. - type: string - enumDescriptions: - - Invalid. An origin type must be specified. - - >- - This inventory item was discovered as the result of the agent - reporting inventory via the reporting API. - enum: - - ORIGIN_TYPE_UNSPECIFIED - - INVENTORY_REPORT - createTime: - description: When this inventory item was first detected. - type: string - format: google-datetime - updateTime: - description: When this inventory item was last modified. - type: string - format: google-datetime - type: - description: The specific type of inventory, correlating to its specific details. - type: string - enumDescriptions: - - Invalid. A type must be specified. - - This represents a package that is installed on the VM. - - This represents an update that is available for a package. - enum: - - TYPE_UNSPECIFIED - - INSTALLED_PACKAGE - - AVAILABLE_PACKAGE - installedPackage: - description: Software package present on the VM instance. - $ref: '#/components/schemas/InventorySoftwarePackage' - availablePackage: - description: Software package available to be installed on the VM instance. - $ref: '#/components/schemas/InventorySoftwarePackage' - InventorySoftwarePackage: - id: InventorySoftwarePackage - description: Software package information of the operating system. - type: object - properties: - yumPackage: - description: >- - Yum package info. For details about the yum package manager, see - https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/6/html/deployment_guide/ch-yum. - $ref: '#/components/schemas/InventoryVersionedPackage' - aptPackage: - description: >- - Details of an APT package. For details about the apt package - manager, see https://wiki.debian.org/Apt. - $ref: '#/components/schemas/InventoryVersionedPackage' - zypperPackage: - description: >- - Details of a Zypper package. For details about the Zypper package - manager, see https://en.opensuse.org/SDB:Zypper_manual. - $ref: '#/components/schemas/InventoryVersionedPackage' - googetPackage: - description: >- - Details of a Googet package. For details about the googet package - manager, see https://github.com/google/googet. - $ref: '#/components/schemas/InventoryVersionedPackage' - zypperPatch: - description: >- - Details of a Zypper patch. For details about the Zypper package - manager, see https://en.opensuse.org/SDB:Zypper_manual. - $ref: '#/components/schemas/InventoryZypperPatch' - wuaPackage: - description: >- - Details of a Windows Update package. See - https://docs.microsoft.com/en-us/windows/win32/api/_wua/ for - information about Windows Update. - $ref: '#/components/schemas/InventoryWindowsUpdatePackage' - qfePackage: - description: >- - Details of a Windows Quick Fix engineering package. See - https://docs.microsoft.com/en-us/windows/win32/cimwin32prov/win32-quickfixengineering - for info in Windows Quick Fix Engineering. - $ref: '#/components/schemas/InventoryWindowsQuickFixEngineeringPackage' - cosPackage: - description: Details of a COS package. - $ref: '#/components/schemas/InventoryVersionedPackage' - windowsApplication: - description: Details of Windows Application. - $ref: '#/components/schemas/InventoryWindowsApplication' - InventoryVersionedPackage: - id: InventoryVersionedPackage - description: >- - Information related to the a standard versioned package. This includes - package info for APT, Yum, Zypper, and Googet package managers. - type: object - properties: - packageName: - description: The name of the package. - type: string - architecture: - description: The system architecture this package is intended for. - type: string - version: - description: The version of the package. - type: string - InventoryZypperPatch: - id: InventoryZypperPatch - description: Details related to a Zypper Patch. - type: object - properties: - patchName: - description: The name of the patch. - type: string - category: - description: The category of the patch. - type: string - severity: - description: The severity specified for this patch - type: string - summary: - description: Any summary information provided about this patch. + Consists of three octal digits which represent, in order, the + permissions of the owner, group, and other users for the file + (similarly to the numeric mode used in the linux chmod utility). + Each digit represents a three bit number with the 4 bit + corresponding to the read permissions, the 2 bit corresponds to the + write bit, and the one bit corresponds to the execute permission. + Default behavior is 755. Below are some examples of permissions and + their associated values: read, write, and execute: 7 read and + execute: 5 read and write: 6 read only: 4 type: string - InventoryWindowsUpdatePackage: - id: InventoryWindowsUpdatePackage + OSPolicyAssignmentInstanceFilter: + id: OSPolicyAssignmentInstanceFilter description: >- - Details related to a Windows Update package. Field data and names are - taken from Windows Update API IUpdate Interface: - https://docs.microsoft.com/en-us/windows/win32/api/_wua/ Descriptive - fields like title, and description are localized based on the locale of - the VM being updated. + Filters to select target VMs for an assignment. If more than one filter + criteria is specified below, a VM will be selected if and only if it + satisfies all of them. type: object properties: - title: - description: The localized title of the update package. - type: string - description: - description: The localized description of the update package. - type: string - categories: - description: The categories that are associated with this update package. + all: + description: >- + Target all VMs in the project. If true, no other criteria is + permitted. + type: boolean + inclusionLabels: + description: >- + List of label sets used for VM inclusion. If the list has more than + one `LabelSet`, the VM is included if any of the label sets are + applicable for the VM. type: array items: - $ref: >- - #/components/schemas/InventoryWindowsUpdatePackageWindowsUpdateCategory - kbArticleIds: + $ref: '#/components/schemas/OSPolicyAssignmentLabelSet' + exclusionLabels: description: >- - A collection of Microsoft Knowledge Base article IDs that are - associated with the update package. + List of label sets used for VM exclusion. If the list has more than + one label set, the VM is excluded if any of the label sets are + applicable for the VM. type: array items: - type: string - supportUrl: - description: >- - A hyperlink to the language-specific support information for the - update. - type: string - moreInfoUrls: + $ref: '#/components/schemas/OSPolicyAssignmentLabelSet' + inventories: description: >- - A collection of URLs that provide more information about the update - package. + List of inventories to select VMs. A VM is selected if its inventory + data matches at least one of the following inventories. type: array items: - type: string - updateId: - description: >- - Gets the identifier of an update package. Stays the same across - revisions. - type: string - revisionNumber: - description: The revision number of this update package. - type: integer - format: int32 - lastDeploymentChangeTime: - description: The last published date of the update, in (UTC) date and time. - type: string - format: google-datetime - InventoryWindowsUpdatePackageWindowsUpdateCategory: - id: InventoryWindowsUpdatePackageWindowsUpdateCategory - description: Categories specified by the Windows Update. + $ref: '#/components/schemas/OSPolicyAssignmentInstanceFilterInventory' + OSPolicyAssignmentLabelSet: + id: OSPolicyAssignmentLabelSet + description: >- + Message representing label set. * A label is a key value pair set for a + VM. * A LabelSet is a set of labels. * Labels within a LabelSet are + ANDed. In other words, a LabelSet is applicable for a VM only if it + matches all the labels in the LabelSet. * Example: A LabelSet with 2 + labels: `env=prod` and `type=webserver` will only be applicable for + those VMs with both labels present. type: object properties: - id: - description: The identifier of the windows update category. - type: string - name: - description: The name of the windows update category. - type: string - InventoryWindowsQuickFixEngineeringPackage: - id: InventoryWindowsQuickFixEngineeringPackage - description: >- - Information related to a Quick Fix Engineering package. Fields are taken - from Windows QuickFixEngineering Interface and match the source names: - https://docs.microsoft.com/en-us/windows/win32/cimwin32prov/win32-quickfixengineering + labels: + description: >- + Labels are identified by key/value pairs in this map. A VM should + contain all the key/value pairs specified in this map to be + selected. + type: object + additionalProperties: + type: string + OSPolicyAssignmentInstanceFilterInventory: + id: OSPolicyAssignmentInstanceFilterInventory + description: VM inventory details. type: object properties: - caption: - description: A short textual description of the QFE update. - type: string - description: - description: A textual description of the QFE update. - type: string - hotFixId: - description: Unique identifier associated with a particular QFE update. + osShortName: + description: Required. The OS short name type: string - installTime: + osVersion: description: >- - Date that the QFE update was installed. Mapped from installed_on - field. + The OS version Prefix matches are supported if asterisk(*) is + provided as the last character. For example, to match all versions + with a major version of `7`, specify the following value for this + field `7.*` An empty string matches all OS versions. type: string - format: google-datetime - InventoryWindowsApplication: - id: InventoryWindowsApplication + OSPolicyAssignmentRollout: + id: OSPolicyAssignmentRollout description: >- - Contains information about a Windows application that is retrieved from - the Windows Registry. For more information about these fields, see: - https://docs.microsoft.com/en-us/windows/win32/msi/uninstall-registry-key + Message to configure the rollout at the zonal level for the OS policy + assignment. type: object properties: - displayName: - description: The name of the application or product. - type: string - displayVersion: - description: The version of the product or application in string format. - type: string - publisher: - description: The name of the manufacturer for the product or application. - type: string - installDate: + disruptionBudget: + description: >- + Required. The maximum number (or percentage) of VMs per zone to + disrupt at any given moment. + $ref: '#/components/schemas/FixedOrPercent' + minWaitDuration: description: >- - The last time this product received service. The value of this - property is replaced each time a patch is applied or removed from - the product or the command-line option is used to repair the - product. - $ref: '#/components/schemas/Date' - helpLink: - description: The internet address for technical support. + Required. This determines the minimum duration of time to wait after + the configuration changes are applied through the current rollout. A + VM continues to count towards the `disruption_budget` at least until + this duration of time has passed after configuration changes are + applied. type: string - Date: - id: Date + format: google-duration + FixedOrPercent: + id: FixedOrPercent description: >- - Represents a whole or partial calendar date, such as a birthday. The - time of day and time zone are either specified elsewhere or are - insignificant. The date is relative to the Gregorian Calendar. This can - represent one of the following: * A full date, with non-zero year, - month, and day values. * A month and day, with a zero year (for example, - an anniversary). * A year on its own, with a zero month and a zero day. - * A year and month, with a zero day (for example, a credit card - expiration date). Related types: * google.type.TimeOfDay * - google.type.DateTime * google.protobuf.Timestamp + Message encapsulating a value that can be either absolute ("fixed") or + relative ("percent") to a value. type: object properties: - year: - description: >- - Year of the date. Must be from 1 to 9999, or 0 to specify a date - without a year. - type: integer - format: int32 - month: - description: >- - Month of a year. Must be from 1 to 12, or 0 to specify a year - without a month and day. + fixed: + description: Specifies a fixed value. type: integer format: int32 - day: + percent: description: >- - Day of a month. Must be from 1 to 31 and valid for the year and - month, or 0 to specify a year by itself or a year and month where - the day isn't significant. + Specifies the relative value defined as a percentage, which will be + multiplied by a reference value. type: integer format: int32 - ListInventoriesResponse: - id: ListInventoriesResponse - description: >- - A response message for listing inventory data for all VMs in a specified - location. - type: object - properties: - inventories: - description: List of inventory objects. - type: array - items: - $ref: '#/components/schemas/Inventory' - nextPageToken: - description: The pagination token to retrieve the next page of inventory objects. - type: string - VulnerabilityReport: - id: VulnerabilityReport - description: >- - This API resource represents the vulnerability report for a specified - Compute Engine virtual machine (VM) instance at a given point in time. - For more information, see [Vulnerability - reports](https://cloud.google.com/compute/docs/instances/os-inventory-management#vulnerability-reports). + GoogleCloudOsconfigV2_PolicyOrchestrator_OrchestrationState: + id: GoogleCloudOsconfigV2_PolicyOrchestrator_OrchestrationState + description: Describes the state of the orchestration process. type: object properties: - name: - description: >- - Output only. The `vulnerabilityReport` API resource name. Format: - `projects/{project_number}/locations/{location}/instances/{instance_id}/vulnerabilityReport` + currentIterationState: + description: Output only. Current Wave iteration state. readOnly: true - type: string - vulnerabilities: - description: Output only. List of vulnerabilities affecting the VM. - readOnly: true - type: array - items: - $ref: '#/components/schemas/VulnerabilityReportVulnerability' - updateTime: - description: >- - Output only. The timestamp for when the last vulnerability report - was generated for the VM. + $ref: >- + #/components/schemas/GoogleCloudOsconfigV2_PolicyOrchestrator_IterationState + previousIterationState: + description: Output only. Previous Wave iteration state. readOnly: true - type: string - format: google-datetime - VulnerabilityReportVulnerability: - id: VulnerabilityReportVulnerability - description: A vulnerability affecting the VM instance. - type: object - properties: - details: - description: >- - Contains metadata as per the upstream feed of the operating system - and NVD. - $ref: '#/components/schemas/VulnerabilityReportVulnerabilityDetails' - installedInventoryItemIds: - description: >- - Corresponds to the `INSTALLED_PACKAGE` inventory item on the VM. - This field displays the inventory items affected by this - vulnerability. If the vulnerability report was not updated after the - VM inventory update, these values might not display in VM inventory. - For some distros, this field may be empty. - deprecated: true - type: array - items: - type: string - availableInventoryItemIds: - description: >- - Corresponds to the `AVAILABLE_PACKAGE` inventory item on the VM. If - the vulnerability report was not updated after the VM inventory - update, these values might not display in VM inventory. If there is - no available fix, the field is empty. The `inventory_item` value - specifies the latest `SoftwarePackage` available to the VM that - fixes the vulnerability. - deprecated: true - type: array - items: - type: string - createTime: - description: The timestamp for when the vulnerability was first detected. - type: string - format: google-datetime - updateTime: - description: The timestamp for when the vulnerability was last modified. - type: string - format: google-datetime - items: - description: List of items affected by the vulnerability. - type: array - items: - $ref: '#/components/schemas/VulnerabilityReportVulnerabilityItem' - VulnerabilityReportVulnerabilityDetails: - id: VulnerabilityReportVulnerabilityDetails - description: >- - Contains metadata information for the vulnerability. This information is - collected from the upstream feed of the operating system. - type: object - properties: - cve: - description: >- - The CVE of the vulnerability. CVE cannot be empty and the - combination of should be unique across vulnerabilities for a VM. - type: string - cvssV2Score: - description: >- - The CVSS V2 score of this vulnerability. CVSS V2 score is on a scale - of 0 - 10 where 0 indicates low severity and 10 indicates high - severity. - type: number - format: float - cvssV3: - description: The full description of the CVSSv3 for this vulnerability from NVD. - $ref: '#/components/schemas/CVSSv3' - severity: - description: Assigned severity/impact ranking from the distro. - type: string - description: - description: >- - The note or description describing the vulnerability from the - distro. - type: string - references: - description: >- - Corresponds to the references attached to the - `VulnerabilityDetails`. - type: array - items: - $ref: >- - #/components/schemas/VulnerabilityReportVulnerabilityDetailsReference - CVSSv3: - id: CVSSv3 - description: >- - Common Vulnerability Scoring System version 3. For details, see - https://www.first.org/cvss/specification-document + $ref: >- + #/components/schemas/GoogleCloudOsconfigV2_PolicyOrchestrator_IterationState + GoogleCloudOsconfigV2_PolicyOrchestrator_IterationState: + id: GoogleCloudOsconfigV2_PolicyOrchestrator_IterationState + description: Describes the state of a single iteration of the orchestrator. type: object properties: - baseScore: - description: >- - The base score is a function of the base metric scores. - https://www.first.org/cvss/specification-document#Base-Metrics - type: number - format: float - exploitabilityScore: - description: >- - The Exploitability sub-score equation is derived from the Base - Exploitability metrics. - https://www.first.org/cvss/specification-document#2-1-Exploitability-Metrics - type: number - format: float - impactScore: - description: >- - The Impact sub-score equation is derived from the Base Impact - metrics. - type: number - format: float - attackVector: - description: >- - This metric reflects the context by which vulnerability exploitation - is possible. - type: string - enumDescriptions: - - Invalid value. - - >- - The vulnerable component is bound to the network stack and the set - of possible attackers extends beyond the other options listed - below, up to and including the entire Internet. - - >- - The vulnerable component is bound to the network stack, but the - attack is limited at the protocol level to a logically adjacent - topology. - - >- - The vulnerable component is not bound to the network stack and the - attacker's path is via read/write/execute capabilities. - - >- - The attack requires the attacker to physically touch or manipulate - the vulnerable component. - enum: - - ATTACK_VECTOR_UNSPECIFIED - - ATTACK_VECTOR_NETWORK - - ATTACK_VECTOR_ADJACENT - - ATTACK_VECTOR_LOCAL - - ATTACK_VECTOR_PHYSICAL - attackComplexity: - description: >- - This metric describes the conditions beyond the attacker's control - that must exist in order to exploit the vulnerability. - type: string - enumDescriptions: - - Invalid value. - - >- - Specialized access conditions or extenuating circumstances do not - exist. An attacker can expect repeatable success when attacking - the vulnerable component. - - >- - A successful attack depends on conditions beyond the attacker's - control. That is, a successful attack cannot be accomplished at - will, but requires the attacker to invest in some measurable - amount of effort in preparation or execution against the - vulnerable component before a successful attack can be expected. - enum: - - ATTACK_COMPLEXITY_UNSPECIFIED - - ATTACK_COMPLEXITY_LOW - - ATTACK_COMPLEXITY_HIGH - privilegesRequired: - description: >- - This metric describes the level of privileges an attacker must - possess before successfully exploiting the vulnerability. - type: string - enumDescriptions: - - Invalid value. - - >- - The attacker is unauthorized prior to attack, and therefore does - not require any access to settings or files of the vulnerable - system to carry out an attack. - - >- - The attacker requires privileges that provide basic user - capabilities that could normally affect only settings and files - owned by a user. Alternatively, an attacker with Low privileges - has the ability to access only non-sensitive resources. - - >- - The attacker requires privileges that provide significant (e.g., - administrative) control over the vulnerable component allowing - access to component-wide settings and files. - enum: - - PRIVILEGES_REQUIRED_UNSPECIFIED - - PRIVILEGES_REQUIRED_NONE - - PRIVILEGES_REQUIRED_LOW - - PRIVILEGES_REQUIRED_HIGH - userInteraction: - description: >- - This metric captures the requirement for a human user, other than - the attacker, to participate in the successful compromise of the - vulnerable component. - type: string - enumDescriptions: - - Invalid value. - - >- - The vulnerable system can be exploited without interaction from - any user. - - >- - Successful exploitation of this vulnerability requires a user to - take some action before the vulnerability can be exploited. - enum: - - USER_INTERACTION_UNSPECIFIED - - USER_INTERACTION_NONE - - USER_INTERACTION_REQUIRED - scope: - description: >- - The Scope metric captures whether a vulnerability in one vulnerable - component impacts resources in components beyond its security scope. - type: string - enumDescriptions: - - Invalid value. - - >- - An exploited vulnerability can only affect resources managed by - the same security authority. - - >- - An exploited vulnerability can affect resources beyond the - security scope managed by the security authority of the vulnerable - component. - enum: - - SCOPE_UNSPECIFIED - - SCOPE_UNCHANGED - - SCOPE_CHANGED - confidentialityImpact: - description: >- - This metric measures the impact to the confidentiality of the - information resources managed by a software component due to a - successfully exploited vulnerability. + state: + description: Output only. State of the iteration. + readOnly: true type: string enumDescriptions: - - Invalid value. - - High impact. - - Low impact. - - No impact. + - Default value. This value is unused. + - Iteration is in progress. + - Iteration completed, with all actions being successful. + - Iteration completed, with failures. + - Iteration was explicitly cancelled. + - Impossible to determine current state of the iteration. enum: - - IMPACT_UNSPECIFIED - - IMPACT_HIGH - - IMPACT_LOW - - IMPACT_NONE - integrityImpact: - description: >- - This metric measures the impact to integrity of a successfully - exploited vulnerability. + - STATE_UNSPECIFIED + - PROCESSING + - COMPLETED + - FAILED + - CANCELLED + - UNKNOWN + iterationId: + description: Output only. Unique identifier of the iteration. + readOnly: true type: string - enumDescriptions: - - Invalid value. - - High impact. - - Low impact. - - No impact. - enum: - - IMPACT_UNSPECIFIED - - IMPACT_HIGH - - IMPACT_LOW - - IMPACT_NONE - availabilityImpact: + progress: description: >- - This metric measures the impact to the availability of the impacted - component resulting from a successfully exploited vulnerability. - type: string - enumDescriptions: - - Invalid value. - - High impact. - - Low impact. - - No impact. - enum: - - IMPACT_UNSPECIFIED - - IMPACT_HIGH - - IMPACT_LOW - - IMPACT_NONE - VulnerabilityReportVulnerabilityDetailsReference: - id: VulnerabilityReportVulnerabilityDetailsReference - description: A reference for this vulnerability. - type: object - properties: - url: - description: The url of the reference. - type: string - source: - description: The source of the reference e.g. NVD. - type: string - VulnerabilityReportVulnerabilityItem: - id: VulnerabilityReportVulnerabilityItem - description: >- - OS inventory item that is affected by a vulnerability or fixed as a - result of a vulnerability. - type: object - properties: - installedInventoryItemId: + Output only. An estimated percentage of the progress. Number between + 0 and 100. + readOnly: true + type: number + format: float + performedActions: description: >- - Corresponds to the `INSTALLED_PACKAGE` inventory item on the VM. - This field displays the inventory items affected by this - vulnerability. If the vulnerability report was not updated after the - VM inventory update, these values might not display in VM inventory. - For some operating systems, this field might be empty. + Output only. Overall number of actions done by the orchestrator so + far. + readOnly: true type: string - availableInventoryItemId: + format: int64 + failedActions: description: >- - Corresponds to the `AVAILABLE_PACKAGE` inventory item on the VM. If - the vulnerability report was not updated after the VM inventory - update, these values might not display in VM inventory. If there is - no available fix, the field is empty. The `inventory_item` value - specifies the latest `SoftwarePackage` available to the VM that - fixes the vulnerability. + Output only. Number of orchestration actions which failed so far. + For more details, query the Cloud Logs. + readOnly: true type: string - fixedCpeUri: - description: >- - The recommended [CPE URI](https://cpe.mitre.org/specification/) - update that contains a fix for this vulnerability. + format: int64 + startTime: + description: Output only. Start time of the wave iteration. + readOnly: true type: string - upstreamFix: - description: The upstream OS patch, packages or KB that fixes the vulnerability. + format: google-datetime + finishTime: + description: Output only. Finish time of the wave iteration. + readOnly: true type: string - ListVulnerabilityReportsResponse: - id: ListVulnerabilityReportsResponse - description: >- - A response message for listing vulnerability reports for all VM - instances in the specified location. + format: google-datetime + error: + description: Output only. Error thrown in the wave iteration. + readOnly: true + $ref: '#/components/schemas/Status' + GoogleCloudOsconfigV2__ListPolicyOrchestratorsResponse: + id: GoogleCloudOsconfigV2__ListPolicyOrchestratorsResponse + description: Response for the list policy orchestrator resources. type: object properties: - vulnerabilityReports: - description: List of vulnerabilityReport objects. + policyOrchestrators: + description: The policy orchestrators for the specified parent resource. type: array items: - $ref: '#/components/schemas/VulnerabilityReport' + $ref: '#/components/schemas/GoogleCloudOsconfigV2__PolicyOrchestrator' nextPageToken: description: >- - The pagination token to retrieve the next page of - vulnerabilityReports object. + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. type: string + unreachable: + description: Locations that could not be reached. + type: array + items: + type: string OSPolicyAssignmentOperationMetadata: id: OSPolicyAssignmentOperationMetadata description: >- @@ -2991,6 +1276,47 @@ components: description: Rollout update time type: string format: google-datetime + GoogleCloudOsconfigV2__OperationMetadata: + id: GoogleCloudOsconfigV2__OperationMetadata + description: Represents the metadata of the long-running operation. + type: object + properties: + createTime: + description: Output only. The time the operation was created. + readOnly: true + type: string + format: google-datetime + endTime: + description: Output only. The time the operation finished running. + readOnly: true + type: string + format: google-datetime + target: + description: >- + Output only. Server-defined resource path for the target of the + operation. + readOnly: true + type: string + verb: + description: Output only. Name of the verb executed by the operation. + readOnly: true + type: string + statusMessage: + description: Output only. Human-readable status of the operation, if any. + readOnly: true + type: string + requestedCancellation: + description: >- + Output only. Identifies whether the user has requested cancellation + of the operation. Operations that have been cancelled successfully + have Operation.error value with a google.rpc.Status.code of 1, + corresponding to `Code.CANCELLED`. + readOnly: true + type: boolean + apiVersion: + description: Output only. API version used to start the operation. + readOnly: true + type: string GoogleCloudOsconfigV2beta__OperationMetadata: id: GoogleCloudOsconfigV2beta__OperationMetadata description: Represents the metadata of the long-running operation. @@ -3032,6 +1358,58 @@ components: description: Output only. API version used to start the operation. readOnly: true type: string + StatusProto: + id: StatusProto + description: Wire-format for a Status object + type: object + properties: + code: + description: >- + Numeric code drawn from the space specified below. Often, this is + the canonical error space, and code is drawn from + google3/util/task/codes.proto copybara:strip_begin(b/383363683) + copybara:strip_end_and_replace optional int32 code = 1; + type: integer + format: int32 + space: + description: >- + copybara:strip_begin(b/383363683) Space to which this status belongs + copybara:strip_end_and_replace optional string space = 2; // Space + to which this status belongs + type: string + message: + description: >- + Detail message copybara:strip_begin(b/383363683) + copybara:strip_end_and_replace optional string message = 3; + type: string + canonicalCode: + description: >- + copybara:strip_begin(b/383363683) copybara:strip_end_and_replace + optional int32 canonical_code = 6; + type: integer + format: int32 + messageSet: + description: >- + message_set associates an arbitrary proto message with the status. + copybara:strip_begin(b/383363683) copybara:strip_end_and_replace + optional proto2.bridge.MessageSet message_set = 5; + $ref: '#/components/schemas/MessageSet' + MessageSet: + id: MessageSet + deprecated: true + description: >- + This is proto2's version of MessageSet. DEPRECATED: DO NOT USE FOR NEW + FIELDS. If you are using editions or proto2, please make your own + extendable messages for your use case. If you are using proto3, please + use `Any` instead. MessageSet was the implementation of extensions for + proto1. When proto2 was introduced, extensions were implemented as a + first-class feature. This schema for MessageSet was meant to be a + "bridge" solution to migrate MessageSet-bearing messages from proto1 to + proto2. This schema has been open-sourced only to facilitate the + migration of Google products with MessageSet-bearing messages to + open-source environments. + type: object + properties: {} parameters: access_token: description: OAuth access token. @@ -3113,380 +1491,106 @@ components: - '1' - '2' x-stackQL-resources: - global_project_feature_settings: - id: google.osconfig.global_project_feature_settings - name: global_project_feature_settings - title: Global_project_feature_settings - methods: - get_project_feature_settings: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1global~1projectFeatureSettings/get - response: - mediaType: application/json - openAPIDocKey: '200' - update_project_feature_settings: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1global~1projectFeatureSettings/patch - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/global_project_feature_settings/methods/get_project_feature_settings - insert: [] - update: - - $ref: >- - #/components/x-stackQL-resources/global_project_feature_settings/methods/update_project_feature_settings - replace: [] - delete: [] - os_policy_assignments: - id: google.osconfig.os_policy_assignments - name: os_policy_assignments - title: Os_policy_assignments - methods: - create: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1osPolicyAssignments/post - response: - mediaType: application/json - openAPIDocKey: '200' - list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1osPolicyAssignments/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.osPolicyAssignments - patch: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1osPolicyAssignments~1{osPolicyAssignmentsId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1osPolicyAssignments~1{osPolicyAssignmentsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1osPolicyAssignments~1{osPolicyAssignmentsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/os_policy_assignments/methods/get' - - $ref: >- - #/components/x-stackQL-resources/os_policy_assignments/methods/list - insert: - - $ref: >- - #/components/x-stackQL-resources/os_policy_assignments/methods/create - update: - - $ref: >- - #/components/x-stackQL-resources/os_policy_assignments/methods/patch - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/os_policy_assignments/methods/delete - os_policy_assignments_revisions: - id: google.osconfig.os_policy_assignments_revisions - name: os_policy_assignments_revisions - title: Os_policy_assignments_revisions - methods: - list_revisions: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1osPolicyAssignments~1{osPolicyAssignmentsId}:listRevisions/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.osPolicyAssignments - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/os_policy_assignments_revisions/methods/list_revisions - insert: [] - update: [] - replace: [] - delete: [] operations: id: google.osconfig.operations name: operations title: Operations - methods: - get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1osPolicyAssignments~1{osPolicyAssignmentsId}~1operations~1{operationsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - cancel: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1osPolicyAssignments~1{osPolicyAssignmentsId}~1operations~1{operationsId}:cancel/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - insert: [] - update: [] - replace: [] - delete: [] - report: - id: google.osconfig.report - name: report - title: Report - methods: - get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1instances~1{instancesId}~1osPolicyAssignments~1{osPolicyAssignmentsId}~1report/get - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/report/methods/get' - insert: [] - update: [] - replace: [] - delete: [] - reports: - id: google.osconfig.reports - name: reports - title: Reports - methods: - list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1instances~1{instancesId}~1osPolicyAssignments~1{osPolicyAssignmentsId}~1reports/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.osPolicyAssignmentReports - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/reports/methods/list' - insert: [] - update: [] - replace: [] - delete: [] - inventory: - id: google.osconfig.inventory - name: inventory - title: Inventory - methods: - get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1instances~1{instancesId}~1inventory/get - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: [] - inventories: - id: google.osconfig.inventories - name: inventories - title: Inventories methods: list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1instances~1{instancesId}~1inventories/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1operations/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.inventories - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/inventories/methods/list' - insert: [] - update: [] - replace: [] - delete: [] - vulnerability_report: - id: google.osconfig.vulnerability_report - name: vulnerability_report - title: Vulnerability_report - methods: + objectKey: $.operations get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1instances~1{instancesId}~1vulnerabilityReport/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/vulnerability_report/methods/get' - insert: [] - update: [] - replace: [] - delete: [] - vulnerability_reports: - id: google.osconfig.vulnerability_reports - name: vulnerability_reports - title: Vulnerability_reports - methods: - list: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1instances~1{instancesId}~1vulnerabilityReports/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.vulnerabilityReports - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/vulnerability_reports/methods/list - insert: [] - update: [] - replace: [] - delete: [] - patch_jobs: - id: google.osconfig.patch_jobs - name: patch_jobs - title: Patch_jobs - methods: - execute: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1patchJobs:execute/post' - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1patchJobs~1{patchJobsId}/get' + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1operations~1{operationsId}/delete response: mediaType: application/json openAPIDocKey: '200' cancel: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1patchJobs~1{patchJobsId}:cancel/post - response: - mediaType: application/json - openAPIDocKey: '200' - list: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1patchJobs/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.patchJobs - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/patch_jobs/methods/get' - - $ref: '#/components/x-stackQL-resources/patch_jobs/methods/list' - insert: [] - update: [] - replace: [] - delete: [] - instance_details: - id: google.osconfig.instance_details - name: instance_details - title: Instance_details - methods: - list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1patchJobs~1{patchJobsId}~1instanceDetails/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.patchJobInstanceDetails sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/instance_details/methods/list' + - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] replace: [] - delete: [] - patch_deployments: - id: google.osconfig.patch_deployments - name: patch_deployments - title: Patch_deployments + delete: + - $ref: '#/components/x-stackQL-resources/operations/methods/delete' + policy_orchestrators: + id: google.osconfig.policy_orchestrators + name: policy_orchestrators + title: Policy_orchestrators methods: create: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1patchDeployments/post' - response: - mediaType: application/json - openAPIDocKey: '200' - list: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1patchDeployments/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.patchDeployments - get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1patchDeployments~1{patchDeploymentsId}/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1global~1policyOrchestrators/post response: mediaType: application/json openAPIDocKey: '200' - delete: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1patchDeployments~1{patchDeploymentsId}/delete + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1global~1policyOrchestrators/get response: mediaType: application/json openAPIDocKey: '200' - patch: + objectKey: $.policyOrchestrators + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1patchDeployments~1{patchDeploymentsId}/patch + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1global~1policyOrchestrators~1{policyOrchestratorsId}/get response: mediaType: application/json openAPIDocKey: '200' - pause: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1patchDeployments~1{patchDeploymentsId}:pause/post + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1global~1policyOrchestrators~1{policyOrchestratorsId}/patch response: mediaType: application/json openAPIDocKey: '200' - resume: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1patchDeployments~1{patchDeploymentsId}:resume/post + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1global~1policyOrchestrators~1{policyOrchestratorsId}/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/patch_deployments/methods/get' - - $ref: '#/components/x-stackQL-resources/patch_deployments/methods/list' + - $ref: '#/components/x-stackQL-resources/policy_orchestrators/methods/get' + - $ref: '#/components/x-stackQL-resources/policy_orchestrators/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/patch_deployments/methods/create' + - $ref: >- + #/components/x-stackQL-resources/policy_orchestrators/methods/create update: - - $ref: '#/components/x-stackQL-resources/patch_deployments/methods/patch' + - $ref: >- + #/components/x-stackQL-resources/policy_orchestrators/methods/patch replace: [] delete: - - $ref: '#/components/x-stackQL-resources/patch_deployments/methods/delete' + - $ref: >- + #/components/x-stackQL-resources/policy_orchestrators/methods/delete paths: - /v1/projects/{projectsId}/locations/global/projectFeatureSettings: + /v2/projects/{projectsId}/locations/{locationsId}/operations: parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' @@ -3501,9 +1605,9 @@ paths: - $ref: '#/components/parameters/_.xgafv' get: description: >- - GetProjectFeatureSettings returns the VM Manager feature settings for a - project. - operationId: osconfig.projects.locations.global.getProjectFeatureSettings + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: osconfig.projects.locations.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3515,59 +1619,39 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ProjectFeatureSettings' + $ref: '#/components/schemas/ListOperationsResponse' parameters: - in: path name: projectsId required: true schema: type: string - patch: - description: UpdateProjectFeatureSettings sets the VM Manager features for a project. - operationId: osconfig.projects.locations.global.updateProjectFeatureSettings - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ProjectFeatureSettings' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/ProjectFeatureSettings' - parameters: - in: path - name: projectsId + name: locationsId required: true schema: type: string - in: query - name: updateMask + name: filter schema: type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/osPolicyAssignments: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: parameters: *ref_1 - post: + get: description: >- - Create an OS policy assignment. This method also creates the first - revision of the OS policy assignment. This method returns a long running - operation (LRO) that contains the rollout details. The rollout can be - cancelled by cancelling the LRO. For more information, see [Method: - projects.locations.osPolicyAssignments.operations.cancel](https://cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.osPolicyAssignments.operations/cancel). - operationId: osconfig.projects.locations.osPolicyAssignments.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/OSPolicyAssignment' + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: osconfig.projects.locations.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3591,19 +1675,18 @@ paths: required: true schema: type: string - - in: query - name: osPolicyAssignmentId - schema: - type: string - - in: query - name: requestId + - in: path + name: operationsId + required: true schema: type: string - get: + delete: description: >- - List the OS policy assignments under the parent resource. For each OS - policy assignment, the latest revision is returned. - operationId: osconfig.projects.locations.osPolicyAssignments.list + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: osconfig.projects.locations.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3615,7 +1698,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListOSPolicyAssignmentsResponse' + $ref: '#/components/schemas/Empty' parameters: - in: path name: projectsId @@ -3627,30 +1710,30 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: operationsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/osPolicyAssignments/{osPolicyAssignmentsId}: + /v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: parameters: *ref_1 - patch: + post: description: >- - Update an existing OS policy assignment. This method creates a new - revision of the OS policy assignment. This method returns a long running - operation (LRO) that contains the rollout details. The rollout can be - cancelled by cancelling the LRO. For more information, see [Method: - projects.locations.osPolicyAssignments.operations.cancel](https://cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.osPolicyAssignments.operations/cancel). - operationId: osconfig.projects.locations.osPolicyAssignments.patch + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + `1`, corresponding to `Code.CANCELLED`. + operationId: osconfig.projects.locations.operations.cancel requestBody: content: application/json: schema: - $ref: '#/components/schemas/OSPolicyAssignment' + $ref: '#/components/schemas/CancelOperationRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3662,7 +1745,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Empty' parameters: - in: path name: projectsId @@ -3675,29 +1758,25 @@ paths: schema: type: string - in: path - name: osPolicyAssignmentsId + name: operationsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - - in: query - name: allowMissing - schema: - type: boolean - - in: query - name: requestId - schema: - type: string - get: + /v2/projects/{projectsId}/locations/global/policyOrchestrators: + parameters: *ref_1 + post: description: >- - Retrieve an existing OS policy assignment. This method always returns - the latest revision. In order to retrieve a previous revision of the - assignment, also provide the revision ID in the `name` parameter. - operationId: osconfig.projects.locations.osPolicyAssignments.get + Creates a new policy orchestrator under the given project resource. + `name` field of the given orchestrator are ignored and instead replaced + by a product of `parent` and `policy_orchestrator_id`. Orchestrator + state field might be only set to `ACTIVE`, `STOPPED` or omitted (in + which case, the created resource will be in `ACTIVE` state anyway). + operationId: osconfig.projects.locations.global.policyOrchestrators.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudOsconfigV2__PolicyOrchestrator' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3709,33 +1788,24 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/OSPolicyAssignment' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: locationsId - required: true + - in: query + name: policyOrchestratorId schema: type: string - - in: path - name: osPolicyAssignmentsId - required: true + - in: query + name: requestId schema: type: string - delete: - description: >- - Delete the OS policy assignment. This method creates a new revision of - the OS policy assignment. This method returns a long running operation - (LRO) that contains the rollout details. The rollout can be cancelled by - cancelling the LRO. If the LRO completes and is not cancelled, all - revisions associated with the OS policy assignment are deleted. For more - information, see [Method: - projects.locations.osPolicyAssignments.operations.cancel](https://cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.osPolicyAssignments.operations/cancel). - operationId: osconfig.projects.locations.osPolicyAssignments.delete + get: + description: Lists the policy orchestrators under the given parent project resource. + operationId: osconfig.projects.locations.global.policyOrchestrators.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3747,34 +1817,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: >- + #/components/schemas/GoogleCloudOsconfigV2__ListPolicyOrchestratorsResponse parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: locationsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - - in: path - name: osPolicyAssignmentsId - required: true + - in: query + name: filter schema: type: string - in: query - name: requestId + name: orderBy schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/osPolicyAssignments/{osPolicyAssignmentsId}:listRevisions: + /v2/projects/{projectsId}/locations/global/policyOrchestrators/{policyOrchestratorsId}: parameters: *ref_1 get: - description: >- - List the OS policy assignment revisions for a given OS policy - assignment. - operationId: osconfig.projects.locations.osPolicyAssignments.listRevisions + description: Retrieves an existing policy orchestrator, parented by a project. + operationId: osconfig.projects.locations.global.policyOrchestrators.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3786,7 +1858,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListOSPolicyAssignmentRevisionsResponse' + $ref: '#/components/schemas/GoogleCloudOsconfigV2__PolicyOrchestrator' parameters: - in: path name: projectsId @@ -3794,32 +1866,49 @@ paths: schema: type: string - in: path - name: locationsId + name: policyOrchestratorsId required: true schema: type: string + patch: + description: Updates an existing policy orchestrator, parented by a project. + operationId: osconfig.projects.locations.global.policyOrchestrators.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudOsconfigV2__PolicyOrchestrator' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: - in: path - name: osPolicyAssignmentsId + name: projectsId required: true schema: type: string - - in: query - name: pageSize + - in: path + name: policyOrchestratorsId + required: true schema: - type: integer - format: int32 + type: string - in: query - name: pageToken + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/osPolicyAssignments/{osPolicyAssignmentsId}/operations/{operationsId}: - parameters: *ref_1 - get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: osconfig.projects.locations.osPolicyAssignments.operations.get + format: google-fieldmask + delete: + description: Deletes an existing policy orchestrator resource, parented by a project. + operationId: osconfig.projects.locations.global.policyOrchestrators.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3839,39 +1928,25 @@ paths: schema: type: string - in: path - name: locationsId + name: policyOrchestratorsId required: true schema: type: string - - in: path - name: osPolicyAssignmentsId - required: true + - in: query + name: requestId schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: etag schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/osPolicyAssignments/{osPolicyAssignmentsId}/operations/{operationsId}:cancel: + /v2/folders/{foldersId}/locations/{locationsId}/operations: parameters: *ref_1 - post: + get: description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: osconfig.projects.locations.osPolicyAssignments.operations.cancel - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CancelOperationRequest' + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: osconfig.folders.locations.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3883,10 +1958,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/ListOperationsResponse' parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string @@ -3895,23 +1970,27 @@ paths: required: true schema: type: string - - in: path - name: osPolicyAssignmentsId - required: true + - in: query + name: filter schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/osPolicyAssignments/{osPolicyAssignmentsId}/report: + /v2/folders/{foldersId}/locations/{locationsId}/operations/{operationsId}: parameters: *ref_1 get: description: >- - Get the OS policy assignment report for the specified Compute Engine VM - instance. - operationId: osconfig.projects.locations.instances.osPolicyAssignments.reports.get + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: osconfig.folders.locations.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3923,10 +2002,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/OSPolicyAssignmentReport' + $ref: '#/components/schemas/Operation' parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string @@ -3936,22 +2015,17 @@ paths: schema: type: string - in: path - name: instancesId - required: true - schema: - type: string - - in: path - name: osPolicyAssignmentsId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/osPolicyAssignments/{osPolicyAssignmentsId}/reports: - parameters: *ref_1 - get: + delete: description: >- - List OS policy assignment reports for all Compute Engine VM instances in - the specified zone. - operationId: osconfig.projects.locations.instances.osPolicyAssignments.reports.list + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: osconfig.folders.locations.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3963,10 +2037,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListOSPolicyAssignmentReportsResponse' + $ref: '#/components/schemas/Empty' parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string @@ -3976,35 +2050,29 @@ paths: schema: type: string - in: path - name: instancesId - required: true - schema: - type: string - - in: path - name: osPolicyAssignmentsId + name: operationsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/inventory: + /v2/folders/{foldersId}/locations/{locationsId}/operations/{operationsId}:cancel: parameters: *ref_1 - get: + post: description: >- - Get inventory data for the specified VM instance. If the VM has no - associated inventory, the message `NOT_FOUND` is returned. - operationId: osconfig.projects.locations.instances.inventories.get + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + `1`, corresponding to `Code.CANCELLED`. + operationId: osconfig.folders.locations.operations.cancel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CancelOperationRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4016,10 +2084,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Inventory' + $ref: '#/components/schemas/Empty' parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string @@ -4029,19 +2097,25 @@ paths: schema: type: string - in: path - name: instancesId + name: operationsId required: true schema: type: string - - in: query - name: view - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/inventories: + /v2/folders/{foldersId}/locations/global/policyOrchestrators: parameters: *ref_1 - get: - description: List inventory data for all VM instances in the specified zone. - operationId: osconfig.projects.locations.instances.inventories.list + post: + description: >- + Creates a new policy orchestrator under the given folder resource. + `name` field of the given orchestrator are ignored and instead replaced + by a product of `parent` and `policy_orchestrator_id`. Orchestrator + state field might be only set to `ACTIVE`, `STOPPED` or omitted (in + which case, the created resource will be in `ACTIVE` state anyway). + operationId: osconfig.folders.locations.global.policyOrchestrators.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudOsconfigV2__PolicyOrchestrator' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4053,25 +2127,41 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListInventoriesResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string - - in: path - name: locationsId - required: true + - in: query + name: policyOrchestratorId schema: type: string - - in: path - name: instancesId - required: true + - in: query + name: requestId schema: type: string - - in: query - name: view + get: + description: Lists the policy orchestrators under the given parent folder resource. + operationId: osconfig.folders.locations.global.policyOrchestrators.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudOsconfigV2__ListPolicyOrchestratorsResponse + parameters: + - in: path + name: foldersId + required: true schema: type: string - in: query @@ -4087,13 +2177,15 @@ paths: name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/vulnerabilityReport: + - in: query + name: orderBy + schema: + type: string + /v2/folders/{foldersId}/locations/global/policyOrchestrators/{policyOrchestratorsId}: parameters: *ref_1 get: - description: >- - Gets the vulnerability report for the specified VM instance. Only VMs - with inventory data have vulnerability reports associated with them. - operationId: osconfig.projects.locations.instances.vulnerabilityReports.get + description: Retrieves an existing policy orchestrator, parented by a folder. + operationId: osconfig.folders.locations.global.policyOrchestrators.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4105,28 +2197,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/VulnerabilityReport' + $ref: '#/components/schemas/GoogleCloudOsconfigV2__PolicyOrchestrator' parameters: - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId + name: foldersId required: true schema: type: string - in: path - name: instancesId + name: policyOrchestratorsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/vulnerabilityReports: - parameters: *ref_1 - get: - description: List vulnerability reports for all VM instances in the specified zone. - operationId: osconfig.projects.locations.instances.vulnerabilityReports.list + patch: + description: Updates an existing policy orchestrator, parented by a folder. + operationId: osconfig.folders.locations.global.policyOrchestrators.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudOsconfigV2__PolicyOrchestrator' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4138,46 +2228,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListVulnerabilityReportsResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId + name: foldersId required: true schema: type: string - in: path - name: instancesId + name: policyOrchestratorsId required: true schema: type: string - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + name: updateMask schema: type: string - /v1/projects/{projectsId}/patchJobs:execute: - parameters: *ref_1 - post: - description: Patch VM instances by creating and running a patch job. - operationId: osconfig.projects.patchJobs.execute - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ExecutePatchJobRequest' + format: google-fieldmask + delete: + description: Deletes an existing policy orchestrator resource, parented by a folder. + operationId: osconfig.folders.locations.global.policyOrchestrators.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4189,20 +2259,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PatchJob' + $ref: '#/components/schemas/Operation' parameters: - in: path - name: projectsId + name: foldersId + required: true + schema: + type: string + - in: path + name: policyOrchestratorsId required: true schema: type: string - /v1/projects/{projectsId}/patchJobs/{patchJobsId}: + - in: query + name: requestId + schema: + type: string + - in: query + name: etag + schema: + type: string + /v2/organizations/{organizationsId}/locations/{locationsId}/operations: parameters: *ref_1 get: description: >- - Get the patch job. This can be used to track the progress of an ongoing - patch job or review the details of completed jobs. - operationId: osconfig.projects.patchJobs.get + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: osconfig.organizations.locations.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4214,30 +2297,39 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PatchJob' + $ref: '#/components/schemas/ListOperationsResponse' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string - in: path - name: patchJobsId + name: locationsId required: true schema: type: string - /v1/projects/{projectsId}/patchJobs/{patchJobsId}:cancel: + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v2/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}: parameters: *ref_1 - post: + get: description: >- - Cancel a patch job. The patch job must be active. Canceled patch jobs - cannot be restarted. - operationId: osconfig.projects.patchJobs.cancel - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CancelPatchJobRequest' + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: osconfig.organizations.locations.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4249,23 +2341,30 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PatchJob' + $ref: '#/components/schemas/Operation' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string - in: path - name: patchJobsId + name: locationsId required: true schema: type: string - /v1/projects/{projectsId}/patchJobs: - parameters: *ref_1 - get: - description: Get a list of patch jobs. - operationId: osconfig.projects.patchJobs.list + - in: path + name: operationsId + required: true + schema: + type: string + delete: + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: osconfig.organizations.locations.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4277,31 +2376,42 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListPatchJobsResponse' + $ref: '#/components/schemas/Empty' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: locationsId + required: true schema: type: string - - in: query - name: filter + - in: path + name: operationsId + required: true schema: type: string - /v1/projects/{projectsId}/patchJobs/{patchJobsId}/instanceDetails: + /v2/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}:cancel: parameters: *ref_1 - get: - description: Get a list of instance details for a given patch job. - operationId: osconfig.projects.patchJobs.instanceDetails.list + post: + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + `1`, corresponding to `Code.CANCELLED`. + operationId: osconfig.organizations.locations.operations.cancel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CancelOperationRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4313,41 +2423,39 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListPatchJobInstanceDetailsResponse' + $ref: '#/components/schemas/Empty' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string - in: path - name: patchJobsId + name: locationsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + - in: path + name: operationsId + required: true schema: type: string - /v1/projects/{projectsId}/patchDeployments: + /v2/organizations/{organizationsId}/locations/global/policyOrchestrators: parameters: *ref_1 post: - description: Create an OS Config patch deployment. - operationId: osconfig.projects.patchDeployments.create + description: >- + Creates a new policy orchestrator under the given organizations + resource. `name` field of the given orchestrator are ignored and instead + replaced by a product of `parent` and `policy_orchestrator_id`. + Orchestrator state field might be only set to `ACTIVE`, `STOPPED` or + omitted (in which case, the created resource will be in `ACTIVE` state + anyway). + operationId: osconfig.organizations.locations.global.policyOrchestrators.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/PatchDeployment' + $ref: '#/components/schemas/GoogleCloudOsconfigV2__PolicyOrchestrator' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4359,20 +2467,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PatchDeployment' + $ref: '#/components/schemas/Operation' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string - in: query - name: patchDeploymentId + name: policyOrchestratorId + schema: + type: string + - in: query + name: requestId schema: type: string get: - description: Get a page of OS Config patch deployments. - operationId: osconfig.projects.patchDeployments.list + description: >- + Lists the policy orchestrators under the given parent organization + resource. + operationId: osconfig.organizations.locations.global.policyOrchestrators.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4384,10 +2498,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListPatchDeploymentsResponse' + $ref: >- + #/components/schemas/GoogleCloudOsconfigV2__ListPolicyOrchestratorsResponse parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -4400,37 +2515,19 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/patchDeployments/{patchDeploymentsId}: - parameters: *ref_1 - get: - description: Get an OS Config patch deployment. - operationId: osconfig.projects.patchDeployments.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/PatchDeployment' - parameters: - - in: path - name: projectsId - required: true + - in: query + name: filter schema: type: string - - in: path - name: patchDeploymentsId - required: true + - in: query + name: orderBy schema: type: string - delete: - description: Delete an OS Config patch deployment. - operationId: osconfig.projects.patchDeployments.delete + /v2/organizations/{organizationsId}/locations/global/policyOrchestrators/{policyOrchestratorsId}: + parameters: *ref_1 + get: + description: Retrieves an existing policy orchestrator, parented by an organization. + operationId: osconfig.organizations.locations.global.policyOrchestrators.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4442,26 +2539,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/GoogleCloudOsconfigV2__PolicyOrchestrator' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string - in: path - name: patchDeploymentsId + name: policyOrchestratorsId required: true schema: type: string patch: - description: Update an OS Config patch deployment. - operationId: osconfig.projects.patchDeployments.patch + description: Updates an existing policy orchestrator, parented by an organization. + operationId: osconfig.organizations.locations.global.policyOrchestrators.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/PatchDeployment' + $ref: '#/components/schemas/GoogleCloudOsconfigV2__PolicyOrchestrator' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4473,15 +2570,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PatchDeployment' + $ref: '#/components/schemas/Operation' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string - in: path - name: patchDeploymentsId + name: policyOrchestratorsId required: true schema: type: string @@ -4490,18 +2587,11 @@ paths: schema: type: string format: google-fieldmask - /v1/projects/{projectsId}/patchDeployments/{patchDeploymentsId}:pause: - parameters: *ref_1 - post: + delete: description: >- - Change state of patch deployment to "PAUSED". Patch deployment in paused - state doesn't generate patch jobs. - operationId: osconfig.projects.patchDeployments.pause - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PausePatchDeploymentRequest' + Deletes an existing policy orchestrator resource, parented by an + organization. + operationId: osconfig.organizations.locations.global.policyOrchestrators.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4513,50 +2603,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PatchDeployment' + $ref: '#/components/schemas/Operation' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string - in: path - name: patchDeploymentsId + name: policyOrchestratorsId required: true schema: type: string - /v1/projects/{projectsId}/patchDeployments/{patchDeploymentsId}:resume: - parameters: *ref_1 - post: - description: >- - Change state of patch deployment back to "ACTIVE". Patch deployment in - active state continues to generate patch jobs. - operationId: osconfig.projects.patchDeployments.resume - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ResumePatchDeploymentRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/PatchDeployment' - parameters: - - in: path - name: projectsId - required: true + - in: query + name: requestId schema: type: string - - in: path - name: patchDeploymentsId - required: true + - in: query + name: etag schema: type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/oslogin.yaml b/providers/src/googleapis.com/v00.00.00000/services/oslogin.yaml index 2010317e..6d50a21a 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/oslogin.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/oslogin.yaml @@ -7,8 +7,8 @@ info: title: Cloud OS Login API description: You can use OS Login to manage access to your VM instances using IAM roles. version: v1 - x-discovery-doc-revision: '20241030' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250810' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/compute/docs/oslogin/ servers: @@ -45,7 +45,9 @@ components: type: object properties: key: - description: Public key text in SSH format, defined by RFC4253 section 6.6. + description: >- + Required. Public key text in SSH format, defined by + [RFC4253](https://www.ietf.org/rfc/rfc4253.txt) section 6.6. type: string expirationTimeUsec: description: An expiration time in microseconds since epoch. diff --git a/providers/src/googleapis.com/v00.00.00000/services/parallelstore.yaml b/providers/src/googleapis.com/v00.00.00000/services/parallelstore.yaml new file mode 100644 index 00000000..4f099593 --- /dev/null +++ b/providers/src/googleapis.com/v00.00.00000/services/parallelstore.yaml @@ -0,0 +1,1330 @@ +openapi: 3.1.0 +info: + contact: + name: StackQL Studios + url: https://github.com/stackql/google-discovery-to-openapi + email: info@stackql.io + title: Parallelstore API + description: '' + version: v1 + x-discovery-doc-revision: '20250804' + x-generated-date: '2025-08-28' +externalDocs: + url: https://cloud.google.com/parallelstore +servers: + - url: https://parallelstore.googleapis.com +components: + securitySchemes: + Oauth2: + type: oauth2 + description: Oauth 2.0 implicit authentication + flows: + implicit: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + scopes: &ref_0 + 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. + Oauth2c: + type: oauth2 + description: Oauth 2.0 authorization code authentication + flows: + authorizationCode: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + tokenUrl: https://accounts.google.com/o/oauth2/token + scopes: *ref_0 + schemas: + ListOperationsResponse: + id: ListOperationsResponse + description: The response message for Operations.ListOperations. + type: object + properties: + operations: + description: >- + A list of operations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/Operation' + nextPageToken: + description: The standard List next-page token. + type: string + Operation: + id: Operation + description: >- + This resource represents a long-running operation that is the result of + a network API call. + type: object + properties: + name: + description: >- + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. + type: string + metadata: + description: >- + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + done: + description: >- + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + type: boolean + error: + description: >- + The error result of the operation in case of failure or + cancellation. + $ref: '#/components/schemas/Status' + response: + description: >- + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + Status: + id: Status + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + type: object + properties: + code: + description: The status code, which should be an enum value of google.rpc.Code. + type: integer + format: int32 + message: + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + type: string + details: + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + type: array + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + GoogleProtobufEmpty: + id: GoogleProtobufEmpty + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + type: object + properties: {} + CancelOperationRequest: + id: CancelOperationRequest + description: The request message for Operations.CancelOperation. + type: object + properties: {} + ListInstancesResponse: + id: ListInstancesResponse + description: Response from ListInstances. + type: object + properties: + instances: + description: The list of Parallelstore instances. + type: array + items: + $ref: '#/components/schemas/Instance' + nextPageToken: + description: A token identifying a page of results the server should return. + type: string + unreachable: + description: Locations that could not be reached. + type: array + items: + type: string + Instance: + id: Instance + description: A Parallelstore instance. + type: object + properties: + name: + description: >- + Identifier. The resource name of the instance, in the format + `projects/{project}/locations/{location}/instances/{instance_id}`. + type: string + description: + description: Optional. The description of the instance. 2048 characters or less. + type: string + state: + description: Output only. The instance state. + readOnly: true + type: string + enumDescriptions: + - Not set. + - The instance is being created. + - The instance is available for use. + - The instance is being deleted. + - The instance is not usable. + - The instance is being upgraded. + - >- + The instance is being repaired. This should only be used by + instances using the `PERSISTENT` deployment type. + enum: + - STATE_UNSPECIFIED + - CREATING + - ACTIVE + - DELETING + - FAILED + - UPGRADING + - REPAIRING + createTime: + description: Output only. The time when the instance was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. The time when the instance was updated. + readOnly: true + type: string + format: google-datetime + labels: + description: >- + Optional. Cloud Labels are a flexible and lightweight mechanism for + organizing cloud resources into groups that reflect a customer's + organizational needs and deployment strategies. See + https://cloud.google.com/resource-manager/docs/labels-overview for + details. + type: object + additionalProperties: + type: string + capacityGib: + description: >- + Required. Immutable. The instance's storage capacity in Gibibytes + (GiB). Allowed values are between 12000 and 100000, in multiples of + 4000; e.g., 12000, 16000, 20000, ... + type: string + format: int64 + daosVersion: + description: >- + Output only. Deprecated: The version of DAOS software running in the + instance. + readOnly: true + deprecated: true + type: string + accessPoints: + description: >- + Output only. A list of IPv4 addresses used for client side + configuration. + readOnly: true + type: array + items: + type: string + network: + description: >- + Optional. Immutable. The name of the Compute Engine [VPC + network](https://cloud.google.com/vpc/docs/vpc) to which the + instance is connected. + type: string + reservedIpRange: + description: >- + Optional. Immutable. The ID of the IP address range being used by + the instance's VPC network. See [Configure a VPC + network](https://cloud.google.com/parallelstore/docs/vpc#create_and_configure_the_vpc). + If no ID is provided, all ranges are considered. + type: string + effectiveReservedIpRange: + description: >- + Output only. Immutable. The ID of the IP address range being used by + the instance's VPC network. This field is populated by the service + and contains the value currently used by the service. + readOnly: true + type: string + fileStripeLevel: + description: >- + Optional. Immutable. Stripe level for files. Allowed values are: * + `FILE_STRIPE_LEVEL_MIN`: offers the best performance for small size + files. * `FILE_STRIPE_LEVEL_BALANCED`: balances performance for + workloads involving a mix of small and large files. * + `FILE_STRIPE_LEVEL_MAX`: higher throughput performance for larger + files. + type: string + enumDescriptions: + - >- + If not set, FileStripeLevel will default to + FILE_STRIPE_LEVEL_BALANCED + - Minimum file striping + - Medium file striping + - Maximum file striping + enum: + - FILE_STRIPE_LEVEL_UNSPECIFIED + - FILE_STRIPE_LEVEL_MIN + - FILE_STRIPE_LEVEL_BALANCED + - FILE_STRIPE_LEVEL_MAX + directoryStripeLevel: + description: >- + Optional. Immutable. Stripe level for directories. Allowed values + are: * `DIRECTORY_STRIPE_LEVEL_MIN`: recommended when directories + contain a small number of files. * + `DIRECTORY_STRIPE_LEVEL_BALANCED`: balances performance for + workloads involving a mix of small and large directories. * + `DIRECTORY_STRIPE_LEVEL_MAX`: recommended for directories with a + large number of files. + type: string + enumDescriptions: + - >- + If not set, DirectoryStripeLevel will default to + DIRECTORY_STRIPE_LEVEL_MAX + - Minimum directory striping + - Medium directory striping + - Maximum directory striping + enum: + - DIRECTORY_STRIPE_LEVEL_UNSPECIFIED + - DIRECTORY_STRIPE_LEVEL_MIN + - DIRECTORY_STRIPE_LEVEL_BALANCED + - DIRECTORY_STRIPE_LEVEL_MAX + deploymentType: + description: >- + Optional. Immutable. The deployment type of the instance. Allowed + values are: * `SCRATCH`: the instance is a scratch instance. * + `PERSISTENT`: the instance is a persistent instance. + type: string + enumDescriptions: + - Default Deployment Type It is equivalent to SCRATCH + - Scratch + - Persistent + enum: + - DEPLOYMENT_TYPE_UNSPECIFIED + - SCRATCH + - PERSISTENT + ImportDataRequest: + id: ImportDataRequest + description: Import data from Cloud Storage into a Parallelstore instance. + type: object + properties: + sourceGcsBucket: + description: >- + The Cloud Storage source bucket and, optionally, path inside the + bucket. + $ref: '#/components/schemas/SourceGcsBucket' + destinationParallelstore: + description: Parallelstore destination. + $ref: '#/components/schemas/DestinationParallelstore' + requestId: + description: >- + Optional. An optional request ID to identify requests. Specify a + unique request ID so that if you must retry your request, the server + will know to ignore the request if it has already been completed. + The server will guarantee that for at least 60 minutes since the + first request. For example, consider a situation where you make an + initial request and the request times out. If you make the request + again with the same request ID, the server can check if original + operation with the same request ID was received, and if so, will + ignore the second request. This prevents clients from accidentally + creating duplicate commitments. The request ID must be a valid UUID + with the exception that zero UUID is not supported + (00000000-0000-0000-0000-000000000000). + type: string + serviceAccount: + description: >- + Optional. User-specified service account credentials to be used when + performing the transfer. Use one of the following formats: * + `{EMAIL_ADDRESS_OR_UNIQUE_ID}` * + `projects/{PROJECT_ID_OR_NUMBER}/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}` + * `projects/-/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}` If + unspecified, the Parallelstore service agent is used: + `service-@gcp-sa-parallelstore.iam.gserviceaccount.com` + type: string + metadataOptions: + description: Optional. The transfer metadata options for the import data. + $ref: '#/components/schemas/TransferMetadataOptions' + SourceGcsBucket: + id: SourceGcsBucket + description: Cloud Storage as the source of a data transfer. + type: object + properties: + uri: + description: >- + Required. URI to a Cloud Storage bucket in the format: `gs:///`. The + path inside the bucket is optional. + type: string + DestinationParallelstore: + id: DestinationParallelstore + description: Parallelstore as the destination of a data transfer. + type: object + properties: + path: + description: >- + Optional. Root directory path to the Paralellstore filesystem, + starting with `/`. Defaults to `/` if unset. + type: string + TransferMetadataOptions: + id: TransferMetadataOptions + description: Transfer metadata options for the instance. + type: object + properties: + uid: + description: Optional. The UID preservation behavior. + type: string + enumDescriptions: + - default is UID_NUMBER_PRESERVE. + - Do not preserve UID during a transfer job. + - Preserve UID that is in number format during a transfer job. + enum: + - UID_UNSPECIFIED + - UID_SKIP + - UID_NUMBER_PRESERVE + gid: + description: Optional. The GID preservation behavior. + type: string + enumDescriptions: + - default is GID_NUMBER_PRESERVE. + - Do not preserve GID during a transfer job. + - Preserve GID that is in number format during a transfer job. + enum: + - GID_UNSPECIFIED + - GID_SKIP + - GID_NUMBER_PRESERVE + mode: + description: Optional. The mode preservation behavior. + type: string + enumDescriptions: + - default is MODE_PRESERVE. + - Do not preserve mode during a transfer job. + - Preserve mode during a transfer job. + enum: + - MODE_UNSPECIFIED + - MODE_SKIP + - MODE_PRESERVE + ExportDataRequest: + id: ExportDataRequest + description: Export data from Parallelstore to Cloud Storage. + type: object + properties: + sourceParallelstore: + description: Parallelstore source. + $ref: '#/components/schemas/SourceParallelstore' + destinationGcsBucket: + description: Cloud Storage destination. + $ref: '#/components/schemas/DestinationGcsBucket' + requestId: + description: >- + Optional. An optional request ID to identify requests. Specify a + unique request ID so that if you must retry your request, the server + will know to ignore the request if it has already been completed. + The server will guarantee that for at least 60 minutes since the + first request. For example, consider a situation where you make an + initial request and the request times out. If you make the request + again with the same request ID, the server can check if original + operation with the same request ID was received, and if so, will + ignore the second request. This prevents clients from accidentally + creating duplicate commitments. The request ID must be a valid UUID + with the exception that zero UUID is not supported + (00000000-0000-0000-0000-000000000000). + type: string + serviceAccount: + description: >- + Optional. User-specified Service Account (SA) credentials to be used + when performing the transfer. Use one of the following formats: * + `{EMAIL_ADDRESS_OR_UNIQUE_ID}` * + `projects/{PROJECT_ID_OR_NUMBER}/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}` + * `projects/-/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}` If + unspecified, the Parallelstore service agent is used: + `service-@gcp-sa-parallelstore.iam.gserviceaccount.com` + type: string + metadataOptions: + description: Optional. The metadata options for the export data. + $ref: '#/components/schemas/TransferMetadataOptions' + SourceParallelstore: + id: SourceParallelstore + description: Parallelstore as the source of a data transfer. + type: object + properties: + path: + description: >- + Optional. Root directory path to the Paralellstore filesystem, + starting with `/`. Defaults to `/` if unset. + type: string + DestinationGcsBucket: + id: DestinationGcsBucket + description: Cloud Storage as the destination of a data transfer. + type: object + properties: + uri: + description: >- + Required. URI to a Cloud Storage bucket in the format: `gs:///`. The + path inside the bucket is optional. + type: string + ListLocationsResponse: + id: ListLocationsResponse + description: The response message for Locations.ListLocations. + type: object + properties: + locations: + description: >- + A list of locations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/Location' + nextPageToken: + description: The standard List next-page token. + type: string + Location: + id: Location + description: A resource that represents a Google Cloud location. + type: object + properties: + name: + description: >- + Resource name for the location, which may vary between + implementations. For example: + `"projects/example-project/locations/us-east1"` + type: string + locationId: + description: 'The canonical id for this location. For example: `"us-east1"`.' + type: string + displayName: + description: >- + The friendly name for this location, typically a nearby city name. + For example, "Tokyo". + type: string + labels: + description: >- + Cross-service attributes for the location. For example + {"cloud.googleapis.com/region": "us-east1"} + type: object + additionalProperties: + type: string + metadata: + description: >- + Service-specific metadata. For example the available capacity at the + given location. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + OperationMetadata: + id: OperationMetadata + description: Long-running operation metadata. + type: object + properties: + createTime: + description: Output only. The time the operation was created. + readOnly: true + type: string + format: google-datetime + endTime: + description: Output only. The time the operation finished running. + readOnly: true + type: string + format: google-datetime + target: + description: >- + Output only. Server-defined resource path for the target of the + operation. + readOnly: true + type: string + verb: + description: Output only. Name of the verb executed by the operation. + readOnly: true + type: string + statusMessage: + description: Output only. Human-readable status of the operation, if any. + readOnly: true + type: string + requestedCancellation: + description: >- + Output only. Identifies whether the user has requested cancellation + of the operation. Operations that have been cancelled successfully + have Operation.error value with a google.rpc.Status.code of 1, + corresponding to `Code.CANCELLED`. + readOnly: true + type: boolean + apiVersion: + description: Output only. API version used to start the operation. + readOnly: true + type: string + ReconciliationOperationMetadata: + id: ReconciliationOperationMetadata + description: >- + Operation metadata returned by the CLH during resource state + reconciliation. + type: object + properties: + deleteResource: + description: DEPRECATED. Use exclusive_action instead. + deprecated: true + type: boolean + exclusiveAction: + description: Excluisive action returned by the CLH. + type: string + enumDescriptions: + - Unknown repair action. + - >- + The resource has to be deleted. When using this bit, the CLH + should fail the operation. DEPRECATED. Instead use DELETE_RESOURCE + OperationSignal in SideChannel. + - >- + This resource could not be repaired but the repair should be tried + again at a later time. This can happen if there is a dependency + that needs to be resolved first- e.g. if a parent resource must be + repaired before a child resource. + enumDeprecated: + - false + - true + - false + enum: + - UNKNOWN_REPAIR_ACTION + - DELETE + - RETRY + parameters: + 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: + type: string + enum: + - json + - media + - proto + 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 + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + x-stackQL-resources: + locations: + id: google.parallelstore.locations + name: locations + title: Locations + methods: + list: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.locations + get: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + operations: + id: google.parallelstore.operations + name: operations + title: Operations + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.operations + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + cancel: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' + insert: [] + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/operations/methods/delete' + instances: + id: google.parallelstore.instances + name: instances + title: Instances + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1instances/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.instances + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1instances/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1instances~1{instancesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1instances~1{instancesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1instances~1{instancesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + import_data: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1instances~1{instancesId}:importData/post + response: + mediaType: application/json + openAPIDocKey: '200' + export_data: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1instances~1{instancesId}:exportData/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/instances/methods/get' + - $ref: '#/components/x-stackQL-resources/instances/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/instances/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/instances/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/instances/methods/delete' +paths: + /v1/projects/{projectsId}/locations: + parameters: &ref_1 + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' + get: + description: Lists information about the supported locations for this service. + operationId: parallelstore.projects.locations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListLocationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: extraLocationTypes + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}: + parameters: *ref_1 + get: + description: Gets information about a location. + operationId: parallelstore.projects.locations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Location' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: parallelstore.projects.locations.operations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListOperationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: parallelstore.projects.locations.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + delete: + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: parallelstore.projects.locations.operations.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + `1`, corresponding to `Code.CANCELLED`. + operationId: parallelstore.projects.locations.operations.cancel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CancelOperationRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/instances: + parameters: *ref_1 + get: + description: Lists all instances in a given project and location. + operationId: parallelstore.projects.locations.instances.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListInstancesResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + post: + description: Creates a Parallelstore instance in a given project and location. + operationId: parallelstore.projects.locations.instances.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Instance' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: instanceId + schema: + type: string + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}: + parameters: *ref_1 + get: + description: Gets details of a single instance. + operationId: parallelstore.projects.locations.instances.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Instance' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + patch: + description: Updates the parameters of a single instance. + operationId: parallelstore.projects.locations.instances.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Instance' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: requestId + schema: + type: string + delete: + description: Deletes a single instance. + operationId: parallelstore.projects.locations.instances.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:importData: + parameters: *ref_1 + post: + description: Copies data from Cloud Storage to Parallelstore. + operationId: parallelstore.projects.locations.instances.importData + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ImportDataRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:exportData: + parameters: *ref_1 + post: + description: Copies data from Parallelstore to Cloud Storage. + operationId: parallelstore.projects.locations.instances.exportData + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExportDataRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/parametermanager.yaml b/providers/src/googleapis.com/v00.00.00000/services/parametermanager.yaml new file mode 100644 index 00000000..de46320d --- /dev/null +++ b/providers/src/googleapis.com/v00.00.00000/services/parametermanager.yaml @@ -0,0 +1,1051 @@ +openapi: 3.1.0 +info: + contact: + name: StackQL Studios + url: https://github.com/stackql/google-discovery-to-openapi + email: info@stackql.io + title: Parameter Manager API + description: >- + Parameter Manager is a single source of truth to store, access and manage + the lifecycle of your workload parameters. Parameter Manager aims to make + management of sensitive application parameters effortless for customers + without diminishing focus on security. + version: v1 + x-discovery-doc-revision: '20250820' + x-generated-date: '2025-08-28' +externalDocs: + url: https://cloud.google.com/secret-manager/parameter-manager/docs/overview +servers: + - url: https://parametermanager.googleapis.com +components: + securitySchemes: + Oauth2: + type: oauth2 + description: Oauth 2.0 implicit authentication + flows: + implicit: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + scopes: &ref_0 + 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. + Oauth2c: + type: oauth2 + description: Oauth 2.0 authorization code authentication + flows: + authorizationCode: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + tokenUrl: https://accounts.google.com/o/oauth2/token + scopes: *ref_0 + schemas: + ListParametersResponse: + id: ListParametersResponse + description: Message for response to listing Parameters + type: object + properties: + parameters: + description: The list of Parameters + type: array + items: + $ref: '#/components/schemas/Parameter' + nextPageToken: + description: A token identifying a page of results the server should return. + type: string + unreachable: + description: Unordered list. Locations that could not be reached. + type: array + items: + type: string + Parameter: + id: Parameter + description: Message describing Parameter resource + type: object + properties: + name: + description: >- + Identifier. [Output only] The resource name of the Parameter in the + format `projects/*/locations/*/parameters/*`. + type: string + createTime: + description: Output only. [Output only] Create time stamp + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. [Output only] Update time stamp + readOnly: true + type: string + format: google-datetime + labels: + description: Optional. Labels as key value pairs + type: object + additionalProperties: + type: string + format: + description: Optional. Specifies the format of a Parameter. + type: string + enumDescriptions: + - >- + The default / unset value. The API will default to the UNFORMATTED + format. + - Unformatted. + - YAML format. + - JSON format. + enum: + - PARAMETER_FORMAT_UNSPECIFIED + - UNFORMATTED + - YAML + - JSON + policyMember: + description: >- + Output only. [Output-only] policy member strings of a Google Cloud + resource. + readOnly: true + $ref: '#/components/schemas/ResourcePolicyMember' + kmsKey: + description: >- + Optional. Customer managed encryption key (CMEK) to use for + encrypting the Parameter Versions. If not set, the default + Google-managed encryption key will be used. Cloud KMS CryptoKeys + must reside in the same location as the Parameter. The expected + format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`. + type: string + ResourcePolicyMember: + id: ResourcePolicyMember + description: >- + Output-only policy member strings of a Google Cloud resource's built-in + identity. + type: object + properties: + iamPolicyNamePrincipal: + description: >- + Output only. IAM policy binding member referring to a Google Cloud + resource by user-assigned name (https://google.aip.dev/122). If a + resource is deleted and recreated with the same name, the binding + will be applicable to the new resource. Example: + `principal://parametermanager.googleapis.com/projects/12345/name/locations/us-central1-a/parameters/my-parameter` + readOnly: true + type: string + iamPolicyUidPrincipal: + description: >- + Output only. IAM policy binding member referring to a Google Cloud + resource by system-assigned unique identifier + (https://google.aip.dev/148#uid). If a resource is deleted and + recreated with the same name, the binding will not be applicable to + the new resource Example: + `principal://parametermanager.googleapis.com/projects/12345/uid/locations/us-central1-a/parameters/a918fed5` + readOnly: true + type: string + Empty: + id: Empty + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + type: object + properties: {} + ListParameterVersionsResponse: + id: ListParameterVersionsResponse + description: Message for response to listing ParameterVersions + type: object + properties: + parameterVersions: + description: The list of ParameterVersions + type: array + items: + $ref: '#/components/schemas/ParameterVersion' + nextPageToken: + description: A token identifying a page of results the server should return. + type: string + unreachable: + description: Unordered list. Locations that could not be reached. + type: array + items: + type: string + ParameterVersion: + id: ParameterVersion + description: Message describing ParameterVersion resource + type: object + properties: + name: + description: >- + Identifier. [Output only] The resource name of the ParameterVersion + in the format `projects/*/locations/*/parameters/*/versions/*`. + type: string + createTime: + description: Output only. [Output only] Create time stamp + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. [Output only] Update time stamp + readOnly: true + type: string + format: google-datetime + disabled: + description: >- + Optional. Disabled boolean to determine if a ParameterVersion acts + as a metadata only resource (payload is never returned if disabled + is true). If true any calls will always default to BASIC view even + if the user explicitly passes FULL view as part of the request. A + render call on a disabled resource fails with an error. Default + value is False. + type: boolean + payload: + description: >- + Required. Immutable. Payload content of a ParameterVersion resource. + This is only returned when the request provides the View value of + FULL (default for GET request). + $ref: '#/components/schemas/ParameterVersionPayload' + kmsKeyVersion: + description: >- + Optional. Output only. [Output only] The resource name of the KMS + key version used to encrypt the ParameterVersion payload. This field + is populated only if the Parameter resource has customer managed + encryption key (CMEK) configured. + readOnly: true + type: string + ParameterVersionPayload: + id: ParameterVersionPayload + description: Message for storing a ParameterVersion resource's payload data + type: object + properties: + data: + description: Required. bytes data for storing payload. + type: string + format: byte + RenderParameterVersionResponse: + id: RenderParameterVersionResponse + description: Message describing RenderParameterVersionResponse resource + type: object + properties: + parameterVersion: + description: >- + Output only. Resource identifier of a ParameterVersion in the format + `projects/*/locations/*/parameters/*/versions/*`. + readOnly: true + type: string + payload: + description: Payload content of a ParameterVersion resource. + $ref: '#/components/schemas/ParameterVersionPayload' + renderedPayload: + description: >- + Output only. Server generated rendered version of the user provided + payload data (ParameterVersionPayload) which has substitutions of + all (if any) references to a SecretManager SecretVersion resources. + This substitution only works for a Parameter which is in JSON or + YAML format. + readOnly: true + type: string + format: byte + ListLocationsResponse: + id: ListLocationsResponse + description: The response message for Locations.ListLocations. + type: object + properties: + locations: + description: >- + A list of locations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/Location' + nextPageToken: + description: The standard List next-page token. + type: string + Location: + id: Location + description: A resource that represents a Google Cloud location. + type: object + properties: + name: + description: >- + Resource name for the location, which may vary between + implementations. For example: + `"projects/example-project/locations/us-east1"` + type: string + locationId: + description: 'The canonical id for this location. For example: `"us-east1"`.' + type: string + displayName: + description: >- + The friendly name for this location, typically a nearby city name. + For example, "Tokyo". + type: string + labels: + description: >- + Cross-service attributes for the location. For example + {"cloud.googleapis.com/region": "us-east1"} + type: object + additionalProperties: + type: string + metadata: + description: >- + Service-specific metadata. For example the available capacity at the + given location. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + parameters: + 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: + type: string + enum: + - json + - media + - proto + 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 + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + x-stackQL-resources: + locations: + id: google.parametermanager.locations + name: locations + title: Locations + methods: + list: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.locations + get: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + parameters: + id: google.parametermanager.parameters + name: parameters + title: Parameters + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1parameters/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.parameters + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1parameters/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1parameters~1{parametersId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1parameters~1{parametersId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1parameters~1{parametersId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/parameters/methods/get' + - $ref: '#/components/x-stackQL-resources/parameters/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/parameters/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/parameters/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/parameters/methods/delete' + versions: + id: google.parametermanager.versions + name: versions + title: Versions + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1parameters~1{parametersId}~1versions/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.parameterVersions + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1parameters~1{parametersId}~1versions/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1parameters~1{parametersId}~1versions~1{versionsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1parameters~1{parametersId}~1versions~1{versionsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1parameters~1{parametersId}~1versions~1{versionsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + render: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1parameters~1{parametersId}~1versions~1{versionsId}:render/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/versions/methods/get' + - $ref: '#/components/x-stackQL-resources/versions/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/versions/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/versions/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/versions/methods/delete' +paths: + /v1/projects/{projectsId}/locations: + parameters: &ref_1 + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' + get: + description: Lists information about the supported locations for this service. + operationId: parametermanager.projects.locations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListLocationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: extraLocationTypes + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}: + parameters: *ref_1 + get: + description: Gets information about a location. + operationId: parametermanager.projects.locations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Location' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/parameters: + parameters: *ref_1 + get: + description: Lists Parameters in a given project and location. + operationId: parametermanager.projects.locations.parameters.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListParametersResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + post: + description: Creates a new Parameter in a given project and location. + operationId: parametermanager.projects.locations.parameters.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Parameter' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Parameter' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: parameterId + schema: + type: string + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/parameters/{parametersId}: + parameters: *ref_1 + get: + description: Gets details of a single Parameter. + operationId: parametermanager.projects.locations.parameters.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Parameter' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: parametersId + required: true + schema: + type: string + patch: + description: Updates a single Parameter. + operationId: parametermanager.projects.locations.parameters.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Parameter' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Parameter' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: parametersId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: requestId + schema: + type: string + delete: + description: Deletes a single Parameter. + operationId: parametermanager.projects.locations.parameters.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: parametersId + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/parameters/{parametersId}/versions: + parameters: *ref_1 + get: + description: Lists ParameterVersions in a given project, location, and parameter. + operationId: parametermanager.projects.locations.parameters.versions.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListParameterVersionsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: parametersId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + post: + description: >- + Creates a new ParameterVersion in a given project, location, and + parameter. + operationId: parametermanager.projects.locations.parameters.versions.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ParameterVersion' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ParameterVersion' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: parametersId + required: true + schema: + type: string + - in: query + name: parameterVersionId + schema: + type: string + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/parameters/{parametersId}/versions/{versionsId}: + parameters: *ref_1 + get: + description: Gets details of a single ParameterVersion. + operationId: parametermanager.projects.locations.parameters.versions.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ParameterVersion' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: parametersId + required: true + schema: + type: string + - in: path + name: versionsId + required: true + schema: + type: string + - in: query + name: view + schema: + type: string + patch: + description: Updates a single ParameterVersion. + operationId: parametermanager.projects.locations.parameters.versions.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ParameterVersion' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ParameterVersion' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: parametersId + required: true + schema: + type: string + - in: path + name: versionsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: requestId + schema: + type: string + delete: + description: Deletes a single ParameterVersion. + operationId: parametermanager.projects.locations.parameters.versions.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: parametersId + required: true + schema: + type: string + - in: path + name: versionsId + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/parameters/{parametersId}/versions/{versionsId}:render: + parameters: *ref_1 + get: + description: Gets rendered version of a ParameterVersion. + operationId: parametermanager.projects.locations.parameters.versions.render + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/RenderParameterVersionResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: parametersId + required: true + schema: + type: string + - in: path + name: versionsId + required: true + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/places.yaml b/providers/src/googleapis.com/v00.00.00000/services/places.yaml index cb521c75..39015e70 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/places.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/places.yaml @@ -7,8 +7,8 @@ info: title: Places API (New) description: '' version: v1 - x-discovery-doc-revision: '20241030' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250826' + x-generated-date: '2025-08-28' externalDocs: url: https://mapsplatform.google.com/maps-products/#places-section servers: @@ -22,24 +22,24 @@ components: implicit: authorizationUrl: https://accounts.google.com/o/oauth2/auth scopes: &ref_0 - https://www.googleapis.com/auth/maps-platform.places.nearbysearch: >- - Private Service: - https://www.googleapis.com/auth/maps-platform.places.nearbysearch - https://www.googleapis.com/auth/maps-platform.places.details: >- - Private Service: - https://www.googleapis.com/auth/maps-platform.places.details - https://www.googleapis.com/auth/maps-platform.places: >- - Private Service: - https://www.googleapis.com/auth/maps-platform.places 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/maps-platform.places: >- + Private Service: + https://www.googleapis.com/auth/maps-platform.places https://www.googleapis.com/auth/maps-platform.places.autocomplete: >- Private Service: https://www.googleapis.com/auth/maps-platform.places.autocomplete + https://www.googleapis.com/auth/maps-platform.places.details: >- + Private Service: + https://www.googleapis.com/auth/maps-platform.places.details https://www.googleapis.com/auth/maps-platform.places.getphotomedia: >- Private Service: https://www.googleapis.com/auth/maps-platform.places.getphotomedia + https://www.googleapis.com/auth/maps-platform.places.nearbysearch: >- + Private Service: + https://www.googleapis.com/auth/maps-platform.places.nearbysearch https://www.googleapis.com/auth/maps-platform.places.textsearch: >- Private Service: https://www.googleapis.com/auth/maps-platform.places.textsearch @@ -52,1516 +52,1790 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleMapsPlacesV1PlaceOpeningHoursPeriod: - id: GoogleMapsPlacesV1PlaceOpeningHoursPeriod - properties: - open: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHoursPeriodPoint' - description: The time that the place starts to be open. - close: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHoursPeriodPoint' - description: The time that the place starts to be closed. - description: A period the place remains in open_now status. - type: object - GoogleMapsPlacesV1PlaceAccessibilityOptions: - properties: - wheelchairAccessibleRestroom: - type: boolean - description: Place has wheelchair accessible restroom. - wheelchairAccessibleEntrance: - type: boolean - description: Places has wheelchair accessible entrance. - wheelchairAccessibleSeating: - description: Place has wheelchair accessible seating. - type: boolean - wheelchairAccessibleParking: - type: boolean - description: Place offers wheelchair accessible parking. - description: Information about the accessibility options a place offers. + GoogleMapsPlacesV1SearchNearbyRequest: + id: GoogleMapsPlacesV1SearchNearbyRequest + description: 'Request proto for Search Nearby. ' type: object - id: GoogleMapsPlacesV1PlaceAccessibilityOptions - GoogleMapsPlacesV1SearchTextRequestEVOptions: properties: - connectorTypes: + languageCode: + description: >- + Place details will be displayed with the preferred language if + available. If the language code is unspecified or unrecognized, + place details of any language may be returned, with a preference for + English if such details exist. Current list of supported languages: + https://developers.google.com/maps/faq#languagesupport. + type: string + regionCode: + description: >- + The Unicode country/region code (CLDR) of the location where the + request is coming from. This parameter is used to display the place + details, like region-specific place name, if available. The + parameter can affect results based on applicable law. For more + information, see + https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html. + Note that 3-digit region codes are not currently supported. + type: string + includedTypes: + description: >- + Included Place type (eg, "restaurant" or "gas_station") from + https://developers.google.com/maps/documentation/places/web-service/place-types. + Up to 50 types from [Table + A](https://developers.google.com/maps/documentation/places/web-service/place-types#table-a) + may be specified. If there are any conflicting types, i.e. a type + appears in both included_types and excluded_types, an + INVALID_ARGUMENT error is returned. If a Place type is specified + with multiple type restrictions, only places that satisfy all of the + restrictions are returned. For example, if we have {included_types = + ["restaurant"], excluded_primary_types = ["restaurant"]}, the + returned places provide "restaurant" related services but do not + operate primarily as "restaurants". type: array items: - enum: - - EV_CONNECTOR_TYPE_UNSPECIFIED - - EV_CONNECTOR_TYPE_OTHER - - EV_CONNECTOR_TYPE_J1772 - - EV_CONNECTOR_TYPE_TYPE_2 - - EV_CONNECTOR_TYPE_CHADEMO - - EV_CONNECTOR_TYPE_CCS_COMBO_1 - - EV_CONNECTOR_TYPE_CCS_COMBO_2 - - EV_CONNECTOR_TYPE_TESLA - - EV_CONNECTOR_TYPE_UNSPECIFIED_GB_T - - EV_CONNECTOR_TYPE_UNSPECIFIED_WALL_OUTLET type: string - enumDescriptions: - - Unspecified connector. - - Other connector types. - - J1772 type 1 connector. - - IEC 62196 type 2 connector. Often referred to as MENNEKES. - - CHAdeMO type connector. - - >- - Combined Charging System (AC and DC). Based on SAE. Type-1 - J-1772 connector - - >- - Combined Charging System (AC and DC). Based on Type-2 Mennekes - connector - - >- - The generic TESLA connector. This is NACS in the North America - but can be non-NACS in other parts of the world (e.g. CCS Combo - 2 (CCS2) or GB/T). This value is less representative of an - actual connector type, and more represents the ability to charge - a Tesla brand vehicle at a Tesla owned charging station. - - >- - GB/T type corresponds to the GB/T standard in China. This type - covers all GB_T types. - - Unspecified wall outlet. - description: >- - Optional. The list of preferred EV connector types. A place that - does not support any of the listed connector types is filtered out. - minimumChargingRateKw: - format: double - type: number + excludedTypes: description: >- - Optional. Minimum required charging rate in kilowatts. A place with - a charging rate less than the specified rate is filtered out. - id: GoogleMapsPlacesV1SearchTextRequestEVOptions - description: Searchable EV options of a place search request. - type: object - GoogleMapsPlacesV1AutocompletePlacesResponse: - id: GoogleMapsPlacesV1AutocompletePlacesResponse - type: object - properties: - suggestions: + Excluded Place type (eg, "restaurant" or "gas_station") from + https://developers.google.com/maps/documentation/places/web-service/place-types. + Up to 50 types from [Table + A](https://developers.google.com/maps/documentation/places/web-service/place-types#table-a) + may be specified. If the client provides both included_types (e.g. + restaurant) and excluded_types (e.g. cafe), then the response should + include places that are restaurant but not cafe. The response + includes places that match at least one of the included_types and + none of the excluded_types. If there are any conflicting types, i.e. + a type appears in both included_types and excluded_types, an + INVALID_ARGUMENT error is returned. If a Place type is specified + with multiple type restrictions, only places that satisfy all of the + restrictions are returned. For example, if we have {included_types = + ["restaurant"], excluded_primary_types = ["restaurant"]}, the + returned places provide "restaurant" related services but do not + operate primarily as "restaurants". type: array items: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestion + type: string + includedPrimaryTypes: description: >- - Contains a list of suggestions, ordered in descending order of - relevance. - description: Response proto for AutocompletePlaces. - GoogleMapsPlacesV1PlacePlusCode: - type: object - id: GoogleMapsPlacesV1PlacePlusCode - description: >- - Plus code (http://plus.codes) is a location reference with two formats: - global code defining a 14mx14m (1/8000th of a degree) or smaller - rectangle, and compound code, replacing the prefix with a reference - location. - properties: - compoundCode: + Included primary Place type (e.g. "restaurant" or "gas_station") + from + https://developers.google.com/maps/documentation/places/web-service/place-types. + A place can only have a single primary type from the supported types + table associated with it. Up to 50 types from [Table + A](https://developers.google.com/maps/documentation/places/web-service/place-types#table-a) + may be specified. If there are any conflicting primary types, i.e. a + type appears in both included_primary_types and + excluded_primary_types, an INVALID_ARGUMENT error is returned. If a + Place type is specified with multiple type restrictions, only places + that satisfy all of the restrictions are returned. For example, if + we have {included_types = ["restaurant"], excluded_primary_types = + ["restaurant"]}, the returned places provide "restaurant" related + services but do not operate primarily as "restaurants". + type: array + items: + type: string + excludedPrimaryTypes: description: >- - Place's compound code, such as "33GV+HQ, Ramberg, Norway", - containing the suffix of the global code and replacing the prefix - with a formatted name of a reference entity. - type: string - globalCode: - type: string + Excluded primary Place type (e.g. "restaurant" or "gas_station") + from + https://developers.google.com/maps/documentation/places/web-service/place-types. + Up to 50 types from [Table + A](https://developers.google.com/maps/documentation/places/web-service/place-types#table-a) + may be specified. If there are any conflicting primary types, i.e. a + type appears in both included_primary_types and + excluded_primary_types, an INVALID_ARGUMENT error is returned. If a + Place type is specified with multiple type restrictions, only places + that satisfy all of the restrictions are returned. For example, if + we have {included_types = ["restaurant"], excluded_primary_types = + ["restaurant"]}, the returned places provide "restaurant" related + services but do not operate primarily as "restaurants". + type: array + items: + type: string + maxResultCount: description: >- - Place's global (full) code, such as "9FWM33GV+HQ", representing an - 1/8000 by 1/8000 degree area (~14 by 14 meters). - GoogleMapsPlacesV1AutocompletePlacesResponseSuggestion: - id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestion - properties: - queryPrediction: - description: A prediction for a query. - $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionQueryPrediction - placePrediction: + Maximum number of results to return. It must be between 1 and 20 + (default), inclusively. If the number is unset, it falls back to the + upper limit. If the number is set to negative or exceeds the upper + limit, an INVALID_ARGUMENT error is returned. + type: integer + format: int32 + locationRestriction: + description: Required. The region to search. $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionPlacePrediction - description: A prediction for a Place. + #/components/schemas/GoogleMapsPlacesV1SearchNearbyRequestLocationRestriction + rankPreference: + description: How results will be ranked in the response. + type: string + enumDescriptions: + - >- + RankPreference value not set. Will use rank by POPULARITY by + default. + - Ranks results by distance. + - Ranks results by popularity. + enum: + - RANK_PREFERENCE_UNSPECIFIED + - DISTANCE + - POPULARITY + routingParameters: + description: Optional. Parameters that affect the routing to the search results. + $ref: '#/components/schemas/GoogleMapsPlacesV1RoutingParameters' + GoogleMapsPlacesV1SearchNearbyRequestLocationRestriction: + id: GoogleMapsPlacesV1SearchNearbyRequestLocationRestriction + description: The region to search. type: object - description: An Autocomplete suggestion result. - GoogleTypeLatLng: + properties: + circle: + description: A circle defined by center point and radius. + $ref: '#/components/schemas/GoogleMapsPlacesV1Circle' + GoogleMapsPlacesV1Circle: + id: GoogleMapsPlacesV1Circle + description: Circle with a LatLng as center and radius. type: object - id: GoogleTypeLatLng properties: - latitude: - format: double - type: number - description: The latitude in degrees. It must be in the range [-90.0, +90.0]. - longitude: + center: + description: >- + Required. Center latitude and longitude. The range of latitude must + be within [-90.0, 90.0]. The range of the longitude must be within + [-180.0, 180.0]. + $ref: '#/components/schemas/GoogleTypeLatLng' + radius: + description: >- + Required. Radius measured in meters. The radius must be within [0.0, + 50000.0]. type: number format: double - description: The longitude in degrees. It must be in the range [-180.0, +180.0]. + GoogleTypeLatLng: + id: GoogleTypeLatLng description: >- An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. - GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedTextHighlightedTextRange: - description: The range of highlighted text. - id: >- - GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedTextHighlightedTextRange - properties: - endIndex: - format: int32 - type: integer - startIndex: - type: integer - format: int32 type: object - GoogleMapsPlacesV1FuelOptionsFuelPrice: + properties: + latitude: + description: The latitude in degrees. It must be in the range [-90.0, +90.0]. + type: number + format: double + longitude: + description: The longitude in degrees. It must be in the range [-180.0, +180.0]. + type: number + format: double + GoogleMapsPlacesV1RoutingParameters: + id: GoogleMapsPlacesV1RoutingParameters + description: >- + Parameters to configure the routing calculations to the places in the + response, both along a route (where result ranking will be influenced) + and for calculating travel times on results. type: object properties: - type: + origin: + description: >- + Optional. An explicit routing origin that overrides the origin + defined in the polyline. By default, the polyline origin is used. + $ref: '#/components/schemas/GoogleTypeLatLng' + travelMode: + description: Optional. The travel mode. type: string enumDescriptions: - - Unspecified fuel type. - - Diesel fuel. - - Regular unleaded. - - Midgrade. - - Premium. - - SP 91. - - SP 91 E10. - - SP 92. - - SP 95. - - SP95 E10. - - SP 98. - - SP 99. - - SP 100. - - LPG. - - E 80. - - E 85. - - Methane. - - Bio-diesel. - - Truck diesel. + - No travel mode specified. Defaults to `DRIVE`. + - Travel by passenger car. + - >- + Travel by bicycle. Not supported with + `search_along_route_parameters`. + - >- + Travel by walking. Not supported with + `search_along_route_parameters`. + - >- + Motorized two wheeled vehicles of all kinds such as scooters and + motorcycles. Note that this is distinct from the `BICYCLE` travel + mode which covers human-powered transport. Not supported with + `search_along_route_parameters`. Only supported in those countries + listed at [Countries and regions supported for two-wheeled + vehicles](https://developers.google.com/maps/documentation/routes/coverage-two-wheeled). enum: - - FUEL_TYPE_UNSPECIFIED - - DIESEL - - REGULAR_UNLEADED - - MIDGRADE - - PREMIUM - - SP91 - - SP91_E10 - - SP92 - - SP95 - - SP95_E10 - - SP98 - - SP99 - - SP100 - - LPG - - E80 - - E85 - - METHANE - - BIO_DIESEL - - TRUCK_DIESEL - description: The type of fuel. - price: - $ref: '#/components/schemas/GoogleTypeMoney' - description: The price of the fuel. - updateTime: - description: The time the fuel price was last updated. + - TRAVEL_MODE_UNSPECIFIED + - DRIVE + - BICYCLE + - WALK + - TWO_WHEELER + routeModifiers: + description: Optional. The route modifiers. + $ref: '#/components/schemas/GoogleMapsPlacesV1RouteModifiers' + routingPreference: + description: >- + Optional. Specifies how to compute the routing summaries. The server + attempts to use the selected routing preference to compute the + route. The traffic aware routing preference is only available for + the `DRIVE` or `TWO_WHEELER` `travelMode`. type: string - format: google-datetime - description: Fuel price information for a given type. - id: GoogleMapsPlacesV1FuelOptionsFuelPrice - GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText: - type: object + enumDescriptions: + - No routing preference specified. Default to `TRAFFIC_UNAWARE`. + - >- + Computes routes without taking live traffic conditions into + consideration. Suitable when traffic conditions don't matter or + are not applicable. Using this value produces the lowest latency. + Note: For `TravelMode` `DRIVE` and `TWO_WHEELER`, the route and + duration chosen are based on road network and average + time-independent traffic conditions, not current road conditions. + Consequently, routes may include roads that are temporarily + closed. Results for a given request may vary over time due to + changes in the road network, updated average traffic conditions, + and the distributed nature of the service. Results may also vary + between nearly-equivalent routes at any time or frequency. + - >- + Calculates routes taking live traffic conditions into + consideration. In contrast to `TRAFFIC_AWARE_OPTIMAL`, some + optimizations are applied to significantly reduce latency. + - >- + Calculates the routes taking live traffic conditions into + consideration, without applying most performance optimizations. + Using this value produces the highest latency. + enum: + - ROUTING_PREFERENCE_UNSPECIFIED + - TRAFFIC_UNAWARE + - TRAFFIC_AWARE + - TRAFFIC_AWARE_OPTIMAL + GoogleMapsPlacesV1RouteModifiers: + id: GoogleMapsPlacesV1RouteModifiers description: >- - Text representing a Place or query prediction. The text may be used as - is or formatted. - id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText + Encapsulates a set of optional conditions to satisfy when calculating + the routes. + type: object properties: - matches: + avoidTolls: description: >- - A list of string ranges identifying where the input request matched - in `text`. The ranges can be used to format specific parts of - `text`. The substrings may not be exact matches of `input` if the - matching was determined by criteria other than string matching (for - example, spell corrections or transliterations). These values are - Unicode character offsets of `text`. The ranges are guaranteed to be - ordered in increasing offset values. - type: array - items: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStringRange - text: - description: Text that may be used as is or formatted with `matches`. - type: string + Optional. When set to true, avoids toll roads where reasonable, + giving preference to routes not containing toll roads. Applies only + to the `DRIVE` and `TWO_WHEELER` `TravelMode`. + type: boolean + avoidHighways: + description: >- + Optional. When set to true, avoids highways where reasonable, giving + preference to routes not containing highways. Applies only to the + `DRIVE` and `TWO_WHEELER` `TravelMode`. + type: boolean + avoidFerries: + description: >- + Optional. When set to true, avoids ferries where reasonable, giving + preference to routes not containing ferries. Applies only to the + `DRIVE` and `TWO_WHEELER` `TravelMode`. + type: boolean + avoidIndoor: + description: >- + Optional. When set to true, avoids navigating indoors where + reasonable, giving preference to routes not containing indoor + navigation. Applies only to the `WALK` `TravelMode`. + type: boolean GoogleMapsPlacesV1SearchNearbyResponse: + id: GoogleMapsPlacesV1SearchNearbyResponse description: 'Response proto for Search Nearby. ' + type: object properties: places: description: >- A list of places that meets user's requirements like places types, number of places and specific location restriction. + type: array items: $ref: '#/components/schemas/GoogleMapsPlacesV1Place' - type: array routingSummaries: - type: array description: >- A list of routing summaries where each entry associates to the corresponding place in the same index in the `places` field. If the routing summary is not available for one of the places, it will contain an empty entry. This list should have as many entries as the list of places if requested. + type: array items: $ref: '#/components/schemas/GoogleMapsPlacesV1RoutingSummary' + GoogleMapsPlacesV1Place: + id: GoogleMapsPlacesV1Place + description: All the information representing a Place. type: object - id: GoogleMapsPlacesV1SearchNearbyResponse - GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedText: - type: object - id: >- - GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedText properties: - highlightedTextRanges: - type: array - items: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedTextHighlightedTextRange - description: The list of the ranges of the highlighted text. - text: + name: + description: >- + This Place's resource name, in `places/{place_id}` format. Can be + used to look up the Place. type: string - description: >- - The text highlighted by the justification. This is a subset of the - review itself. The exact word to highlight is marked by the - HighlightedTextRange. There could be several words in the text being - highlighted. - GoogleTypeDate: - properties: - month: - type: integer - format: int32 + id: + description: The unique identifier of a place. + type: string + displayName: description: >- - Month of a year. Must be from 1 to 12, or 0 to specify a year - without a month and day. - day: - format: int32 + The localized name of the place, suitable as a short human-readable + description. For example, "Google Sydney", "Starbucks", "Pyrmont", + etc. + $ref: '#/components/schemas/GoogleTypeLocalizedText' + types: description: >- - Day of a month. Must be from 1 to 31 and valid for the year and - month, or 0 to specify a year by itself or a year and month where - the day isn't significant. - type: integer - year: + A set of type tags for this result. For example, "political" and + "locality". For the complete list of possible values, see Table A + and Table B at + https://developers.google.com/maps/documentation/places/web-service/place-types + type: array + items: + type: string + primaryType: description: >- - Year of the date. Must be from 1 to 9999, or 0 to specify a date - without a year. - type: integer - format: int32 - id: GoogleTypeDate - type: object - description: >- - Represents a whole or partial calendar date, such as a birthday. The - time of day and time zone are either specified elsewhere or are - insignificant. The date is relative to the Gregorian Calendar. This can - represent one of the following: * A full date, with non-zero year, - month, and day values. * A month and day, with a zero year (for example, - an anniversary). * A year on its own, with a zero month and a zero day. - * A year and month, with a zero day (for example, a credit card - expiration date). Related types: * google.type.TimeOfDay * - google.type.DateTime * google.protobuf.Timestamp - GoogleMapsPlacesV1AutocompletePlacesRequestLocationBias: - properties: - circle: - description: A circle defined by a center point and radius. - $ref: '#/components/schemas/GoogleMapsPlacesV1Circle' - rectangle: - $ref: '#/components/schemas/GoogleGeoTypeViewport' - description: A viewport defined by a northeast and a southwest corner. - description: >- - The region to search. The results may be biased around the specified - region. - type: object - id: GoogleMapsPlacesV1AutocompletePlacesRequestLocationBias - GoogleMapsPlacesV1SearchTextRequestLocationBias: - type: object - description: >- - The region to search. This location serves as a bias which means results - around given location might be returned. - properties: - rectangle: + The primary type of the given result. This type must be one of the + Places API supported types. For example, "restaurant", "cafe", + "airport", etc. A place can only have a single primary type. For the + complete list of possible values, see Table A and Table B at + https://developers.google.com/maps/documentation/places/web-service/place-types. + The primary type may be missing if the place's primary type is not a + supported type. When a primary type is present, it is always one of + the types in the `types` field. + type: string + primaryTypeDisplayName: description: >- - A rectangle box defined by northeast and southwest corner. - `rectangle.high()` must be the northeast point of the rectangle - viewport. `rectangle.low()` must be the southwest point of the - rectangle viewport. `rectangle.low().latitude()` cannot be greater - than `rectangle.high().latitude()`. This will result in an empty - latitude range. A rectangle viewport cannot be wider than 180 - degrees. - $ref: '#/components/schemas/GoogleGeoTypeViewport' - circle: - description: A circle defined by center point and radius. - $ref: '#/components/schemas/GoogleMapsPlacesV1Circle' - id: GoogleMapsPlacesV1SearchTextRequestLocationBias - GoogleMapsPlacesV1PhotoMedia: - type: object - id: GoogleMapsPlacesV1PhotoMedia - properties: - photoUri: - description: A short-lived uri that can be used to render the photo. + The display name of the primary type, localized to the request + language if applicable. For the complete list of possible values, + see Table A and Table B at + https://developers.google.com/maps/documentation/places/web-service/place-types. + The primary type may be missing if the place's primary type is not a + supported type. + $ref: '#/components/schemas/GoogleTypeLocalizedText' + nationalPhoneNumber: + description: A human-readable phone number for the place, in national format. type: string - name: + internationalPhoneNumber: + description: >- + A human-readable phone number for the place, in international + format. type: string + formattedAddress: + description: A full, human-readable address for this place. + type: string + shortFormattedAddress: + description: A short, human-readable address for this place. + type: string + postalAddress: + description: The address in postal address format. + $ref: '#/components/schemas/GoogleTypePostalAddress' + addressComponents: description: >- - The resource name of a photo media in the format: - `places/{place_id}/photos/{photo_reference}/media`. - description: A photo media from Places API. - GoogleTypeLocalizedText: - description: Localized variant of a text in a particular language. - type: object - properties: - languageCode: + Repeated components for each locality level. Note the following + facts about the address_components[] array: - The array of address + components may contain more components than the formatted_address. - + The array does not necessarily include all the political entities + that contain an address, apart from those included in the + formatted_address. To retrieve all the political entities that + contain a specific address, you should use reverse geocoding, + passing the latitude/longitude of the address as a parameter to the + request. - The format of the response is not guaranteed to remain + the same between requests. In particular, the number of + address_components varies based on the address requested and can + change over time for the same address. A component can change + position in the array. The type of the component can change. A + particular component may be missing in a later response. + type: array + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceAddressComponent' + plusCode: + description: Plus code of the place location lat/long. + $ref: '#/components/schemas/GoogleMapsPlacesV1PlacePlusCode' + location: + description: The position of this place. + $ref: '#/components/schemas/GoogleTypeLatLng' + viewport: description: >- - The text's BCP-47 language code, such as "en-US" or "sr-Latn". For - more information, see - http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + A viewport suitable for displaying the place on an average-sized + map. This viewport should not be used as the physical boundary or + the service area of the business. + $ref: '#/components/schemas/GoogleGeoTypeViewport' + rating: + description: A rating between 1.0 and 5.0, based on user reviews of this place. + type: number + format: double + googleMapsUri: + description: A URL providing more information about this place. type: string - text: + websiteUri: description: >- - Localized string in the language corresponding to language_code - below. + The authoritative website for this place, e.g. a business' homepage. + Note that for places that are part of a chain (e.g. an IKEA store), + this will usually be the website for the individual store, not the + overall chain. type: string - id: GoogleTypeLocalizedText - GoogleMapsPlacesV1PlaceOpeningHours: - type: object - properties: - periods: + reviews: description: >- - The periods that this place is open during the week. The periods are - in chronological order, starting with Sunday in the place-local - timezone. An empty (but not absent) value indicates a place that is - never open, e.g. because it is closed temporarily for renovations. - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHoursPeriod' + List of reviews about this place, sorted by relevance. A maximum of + 5 reviews can be returned. type: array - openNow: - type: boolean + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1Review' + regularOpeningHours: description: >- - Whether the opening hours period is currently active. For regular - opening hours and current opening hours, this field means whether - the place is open. For secondary opening hours and current secondary - opening hours, this field means whether the secondary hours of this - place is active. - specialDays: + The regular hours of operation. Note that if a place is always open + (24 hours), the `close` field will not be set. Clients can rely on + always open (24 hours) being represented as an + [`open`](https://developers.google.com/maps/documentation/places/web-service/reference/rest/v1/places#Period) + period containing + [`day`](https://developers.google.com/maps/documentation/places/web-service/reference/rest/v1/places#Point) + with value `0`, + [`hour`](https://developers.google.com/maps/documentation/places/web-service/reference/rest/v1/places#Point) + with value `0`, and + [`minute`](https://developers.google.com/maps/documentation/places/web-service/reference/rest/v1/places#Point) + with value `0`. + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHours' + utcOffsetMinutes: description: >- - Structured information for special days that fall within the period - that the returned opening hours cover. Special days are days that - could impact the business hours of a place, e.g. Christmas day. Set - for current_opening_hours and current_secondary_opening_hours if - there are exceptional hours. - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHoursSpecialDay' - type: array - weekdayDescriptions: + Number of minutes this place's timezone is currently offset from + UTC. This is expressed in minutes to support timezones that are + offset by fractions of an hour, e.g. X hours and 15 minutes. + type: integer + format: int32 + timeZone: + description: IANA Time Zone Database time zone. For example "America/New_York". + $ref: '#/components/schemas/GoogleTypeTimeZone' + photos: description: >- - Localized strings describing the opening hours of this place, one - string for each day of the week. Will be empty if the hours are - unknown or could not be converted to localized text. Example: "Sun: - 18:00–06:00" + Information (including references) about photos of this place. A + maximum of 10 photos can be returned. type: array items: - type: string - secondaryHoursType: - enum: - - SECONDARY_HOURS_TYPE_UNSPECIFIED - - DRIVE_THROUGH - - HAPPY_HOUR - - DELIVERY - - TAKEOUT - - KITCHEN - - BREAKFAST - - LUNCH - - DINNER - - BRUNCH - - PICKUP - - ACCESS - - SENIOR_HOURS - - ONLINE_SERVICE_HOURS - enumDescriptions: - - Default value when secondary hour type is not specified. - - The drive-through hour for banks, restaurants, or pharmacies. - - The happy hour. - - The delivery hour. - - The takeout hour. - - The kitchen hour. - - The breakfast hour. - - The lunch hour. - - The dinner hour. - - The brunch hour. - - The pickup hour. - - The access hours for storage places. - - The special hours for seniors. - - The online service hours. - type: string - description: A type string used to identify the type of secondary hours. - description: Information about business hour of the place. - id: GoogleMapsPlacesV1PlaceOpeningHours - GoogleMapsPlacesV1Circle: - properties: - radius: - description: >- - Required. Radius measured in meters. The radius must be within [0.0, - 50000.0]. - type: number - format: double - center: - $ref: '#/components/schemas/GoogleTypeLatLng' + $ref: '#/components/schemas/GoogleMapsPlacesV1Photo' + adrFormatAddress: description: >- - Required. Center latitude and longitude. The range of latitude must - be within [-90.0, 90.0]. The range of the longitude must be within - [-180.0, 180.0]. - id: GoogleMapsPlacesV1Circle - type: object - description: Circle with a LatLng as center and radius. - GoogleMapsPlacesV1AddressDescriptorLandmark: - description: >- - Basic landmark information and the landmark's relationship with the - target location. Landmarks are prominent places that can be used to - describe a location. - type: object - id: GoogleMapsPlacesV1AddressDescriptorLandmark - properties: - placeId: + The place's address in adr microformat: + http://microformats.org/wiki/adr. type: string - description: The landmark's place id. - straightLineDistanceMeters: - format: float - type: number - description: >- - The straight line distance, in meters, between the center point of - the target and the center point of the landmark. In some situations, - this value can be longer than `travel_distance_meters`. - travelDistanceMeters: - description: >- - The travel distance, in meters, along the road network from the - target to the landmark, if known. This value does not take into - account the mode of transportation, such as walking, driving, or - biking. - format: float - type: number - types: - description: >- - A set of type tags for this landmark. For a complete list of - possible values, see - https://developers.google.com/maps/documentation/places/web-service/place-types. - items: - type: string - type: array - spatialRelationship: - description: >- - Defines the spatial relationship between the target location and the - landmark. - enum: - - NEAR - - WITHIN - - BESIDE - - ACROSS_THE_ROAD - - DOWN_THE_ROAD - - AROUND_THE_CORNER - - BEHIND + businessStatus: + description: The business status for the place. type: string enumDescriptions: - - >- - This is the default relationship when nothing more specific below - applies. - - >- - The landmark has a spatial geometry and the target is within its - bounds. - - The target is directly adjacent to the landmark. - - >- - The target is directly opposite the landmark on the other side of - the road. - - On the same route as the landmark but not besides or across. - - Not on the same route as the landmark but a single turn away. - - >- - Close to the landmark's structure but further away from its street - entrances. - displayName: - $ref: '#/components/schemas/GoogleTypeLocalizedText' - description: The landmark's display name. - name: + - Default value. This value is unused. + - The establishment is operational, not necessarily open now. + - The establishment is temporarily closed. + - The establishment is permanently closed. + enum: + - BUSINESS_STATUS_UNSPECIFIED + - OPERATIONAL + - CLOSED_TEMPORARILY + - CLOSED_PERMANENTLY + priceLevel: + description: Price level of the place. type: string - description: The landmark's resource name. - GoogleMapsPlacesV1SearchTextRequestLocationRestriction: - description: >- - The region to search. This location serves as a restriction which means - results outside given location will not be returned. - type: object - properties: - rectangle: - description: >- - A rectangle box defined by northeast and southwest corner. - `rectangle.high()` must be the northeast point of the rectangle - viewport. `rectangle.low()` must be the southwest point of the - rectangle viewport. `rectangle.low().latitude()` cannot be greater - than `rectangle.high().latitude()`. This will result in an empty - latitude range. A rectangle viewport cannot be wider than 180 - degrees. - $ref: '#/components/schemas/GoogleGeoTypeViewport' - id: GoogleMapsPlacesV1SearchTextRequestLocationRestriction - GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStructuredFormat: - id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStructuredFormat - description: >- - Contains a breakdown of a Place or query prediction into main text and - secondary text. For Place predictions, the main text contains the - specific name of the Place. For query predictions, the main text - contains the query. The secondary text contains additional - disambiguating features (such as a city or region) to further identify - the Place or refine the query. - properties: - secondaryText: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText - description: >- - Represents additional disambiguating features (such as a city or - region) to further identify the Place or refine the query. - mainText: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText - description: Represents the name of the Place or query. - type: object - GoogleMapsPlacesV1PlaceOpeningHoursPeriodPoint: - id: GoogleMapsPlacesV1PlaceOpeningHoursPeriodPoint - properties: - date: - $ref: '#/components/schemas/GoogleTypeDate' - description: Date in the local timezone for the place. - minute: - description: The minute in 2 digits. Ranges from 00 to 59. - type: integer - format: int32 - day: - format: int32 - type: integer - description: >- - A day of the week, as an integer in the range 0-6. 0 is Sunday, 1 is - Monday, etc. - hour: + enumDescriptions: + - Place price level is unspecified or unknown. + - Place provides free services. + - Place provides inexpensive services. + - Place provides moderately priced services. + - Place provides expensive services. + - Place provides very expensive services. + enum: + - PRICE_LEVEL_UNSPECIFIED + - PRICE_LEVEL_FREE + - PRICE_LEVEL_INEXPENSIVE + - PRICE_LEVEL_MODERATE + - PRICE_LEVEL_EXPENSIVE + - PRICE_LEVEL_VERY_EXPENSIVE + attributions: + description: A set of data provider that must be shown with this result. + type: array + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceAttribution' + userRatingCount: + description: The total number of reviews (with or without text) for this place. type: integer - description: The hour in 2 digits. Ranges from 00 to 23. format: int32 - truncated: + iconMaskBaseUri: description: >- - Whether or not this endpoint was truncated. Truncation occurs when - the real hours are outside the times we are willing to return hours - between, so we truncate the hours back to these boundaries. This - ensures that at most 24 * 7 hours from midnight of the day of the - request are returned. + A truncated URL to an icon mask. User can access different icon type + by appending type suffix to the end (eg, ".svg" or ".png"). + type: string + iconBackgroundColor: + description: 'Background color for icon_mask in hex format, e.g. #909CE1.' + type: string + takeout: + description: Specifies if the business supports takeout. type: boolean - description: Status changing points. - type: object - GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionPlacePrediction: - id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionPlacePrediction - properties: - distanceMeters: - description: >- - The length of the geodesic in meters from `origin` if `origin` is - specified. Certain predictions such as routes may not populate this - field. - format: int32 - type: integer - structuredFormat: - description: >- - A breakdown of the Place prediction into main text containing the - name of the Place and secondary text containing additional - disambiguating features (such as a city or region). - `structured_format` is recommended for developers who wish to show - two separate, but related, UI elements. Developers who wish to show - a single UI element may want to use `text` instead. They are two - different ways to represent a Place prediction. Users should not try - to parse `structured_format` into `text` or vice versa. - $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStructuredFormat - placeId: + delivery: + description: Specifies if the business supports delivery. + type: boolean + dineIn: description: >- - The unique identifier of the suggested Place. This identifier can be - used in other APIs that accept Place IDs. - type: string - place: + Specifies if the business supports indoor or outdoor seating + options. + type: boolean + curbsidePickup: + description: Specifies if the business supports curbside pickup. + type: boolean + reservable: + description: Specifies if the place supports reservations. + type: boolean + servesBreakfast: + description: Specifies if the place serves breakfast. + type: boolean + servesLunch: + description: Specifies if the place serves lunch. + type: boolean + servesDinner: + description: Specifies if the place serves dinner. + type: boolean + servesBeer: + description: Specifies if the place serves beer. + type: boolean + servesWine: + description: Specifies if the place serves wine. + type: boolean + servesBrunch: + description: Specifies if the place serves brunch. + type: boolean + servesVegetarianFood: + description: Specifies if the place serves vegetarian food. + type: boolean + currentOpeningHours: description: >- - The resource name of the suggested Place. This name can be used in - other APIs that accept Place names. - type: string - text: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText + The hours of operation for the next seven days (including today). + The time period starts at midnight on the date of the request and + ends at 11:59 pm six days later. This field includes the + special_days subfield of all hours, set for dates that have + exceptional hours. + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHours' + currentSecondaryOpeningHours: description: >- - Contains the human-readable name for the returned result. For - establishment results, this is usually the business name and - address. `text` is recommended for developers who wish to show a - single UI element. Developers who wish to show two separate, but - related, UI elements may want to use `structured_format` instead. - They are two different ways to represent a Place prediction. Users - should not try to parse `structured_format` into `text` or vice - versa. This text may be different from the `display_name` returned - by GetPlace. May be in mixed languages if the request `input` and - `language_code` are in different languages or if the Place does not - have a translation from the local language to `language_code`. - types: + Contains an array of entries for the next seven days including + information about secondary hours of a business. Secondary hours are + different from a business's main hours. For example, a restaurant + can specify drive through hours or delivery hours as its secondary + hours. This field populates the type subfield, which draws from a + predefined list of opening hours types (such as DRIVE_THROUGH, + PICKUP, or TAKEOUT) based on the types of the place. This field + includes the special_days subfield of all hours, set for dates that + have exceptional hours. type: array items: - type: string + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHours' + regularSecondaryOpeningHours: description: >- - List of types that apply to this Place from Table A or Table B in - https://developers.google.com/maps/documentation/places/web-service/place-types. - A type is a categorization of a Place. Places with shared types will - share similar characteristics. - description: Prediction results for a Place Autocomplete prediction. - type: object - GoogleMapsPlacesV1SearchNearbyRequestLocationRestriction: - type: object - properties: - circle: - $ref: '#/components/schemas/GoogleMapsPlacesV1Circle' - description: A circle defined by center point and radius. - id: GoogleMapsPlacesV1SearchNearbyRequestLocationRestriction - description: The region to search. - GoogleGeoTypeViewport: - description: >- - A latitude-longitude viewport, represented as two diagonally opposite - `low` and `high` points. A viewport is considered a closed region, i.e. - it includes its boundary. The latitude bounds must range between -90 to - 90 degrees inclusive, and the longitude bounds must range between -180 - to 180 degrees inclusive. Various cases include: - If `low` = `high`, - the viewport consists of that single point. - If `low.longitude` > - `high.longitude`, the longitude range is inverted (the viewport crosses - the 180 degree longitude line). - If `low.longitude` = -180 degrees and - `high.longitude` = 180 degrees, the viewport includes all longitudes. - - If `low.longitude` = 180 degrees and `high.longitude` = -180 degrees, - the longitude range is empty. - If `low.latitude` > `high.latitude`, the - latitude range is empty. Both `low` and `high` must be populated, and - the represented box cannot be empty (as specified by the definitions - above). An empty viewport will result in an error. For example, this - viewport fully encloses New York City: { "low": { "latitude": 40.477398, - "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": - -73.70018 } } - properties: - low: - $ref: '#/components/schemas/GoogleTypeLatLng' - description: Required. The low point of the viewport. - high: - $ref: '#/components/schemas/GoogleTypeLatLng' - description: Required. The high point of the viewport. - type: object - id: GoogleGeoTypeViewport - GoogleMapsPlacesV1ContextualContent: - id: GoogleMapsPlacesV1ContextualContent - properties: - reviews: - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1Review' - description: List of reviews about this place, contexual to the place query. + Contains an array of entries for information about regular secondary + hours of a business. Secondary hours are different from a business's + main hours. For example, a restaurant can specify drive through + hours or delivery hours as its secondary hours. This field populates + the type subfield, which draws from a predefined list of opening + hours types (such as DRIVE_THROUGH, PICKUP, or TAKEOUT) based on the + types of the place. type: array - justifications: items: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1ContextualContentJustification + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHours' + editorialSummary: description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. Justifications for the place. + Contains a summary of the place. A summary is comprised of a textual + overview, and also includes the language code for these if + applicable. Summary text must be presented as-is and can not be + modified or altered. + $ref: '#/components/schemas/GoogleTypeLocalizedText' + outdoorSeating: + description: Place provides outdoor seating. + type: boolean + liveMusic: + description: Place provides live music. + type: boolean + menuForChildren: + description: Place has a children's menu. + type: boolean + servesCocktails: + description: Place serves cocktails. + type: boolean + servesDessert: + description: Place serves dessert. + type: boolean + servesCoffee: + description: Place serves coffee. + type: boolean + goodForChildren: + description: Place is good for children. + type: boolean + allowsDogs: + description: Place allows dogs. + type: boolean + restroom: + description: Place has restroom. + type: boolean + goodForGroups: + description: Place accommodates groups. + type: boolean + goodForWatchingSports: + description: Place is suitable for watching sports. + type: boolean + paymentOptions: + description: >- + Payment options the place accepts. If a payment option data is not + available, the payment option field will be unset. + $ref: '#/components/schemas/GoogleMapsPlacesV1PlacePaymentOptions' + parkingOptions: + description: Options of parking provided by the place. + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceParkingOptions' + subDestinations: + description: A list of sub-destinations related to the place. type: array - photos: items: - $ref: '#/components/schemas/GoogleMapsPlacesV1Photo' + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceSubDestination' + accessibilityOptions: + description: Information about the accessibility options a place offers. + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceAccessibilityOptions' + fuelOptions: + description: >- + The most recent information about fuel options in a gas station. + This information is updated regularly. + $ref: '#/components/schemas/GoogleMapsPlacesV1FuelOptions' + evChargeOptions: + description: Information of ev charging options. + $ref: '#/components/schemas/GoogleMapsPlacesV1EVChargeOptions' + generativeSummary: + description: AI-generated summary of the place. + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceGenerativeSummary' + containingPlaces: + description: List of places in which the current place is located. type: array + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceContainingPlace' + pureServiceAreaBusiness: + description: >- + Indicates whether the place is a pure service area business. Pure + service area business is a business that visits or delivers to + customers directly but does not serve customers at their business + address. For example, businesses like cleaning services or plumbers. + Those businesses may not have a physical address or location on + Google Maps. + type: boolean + addressDescriptor: description: >- - Information (including references) about photos of this place, - contexual to the place query. - type: object - description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. Content that is contextual to the place query. - GoogleMapsPlacesV1AutocompletePlacesRequestLocationRestriction: - properties: - rectangle: - $ref: '#/components/schemas/GoogleGeoTypeViewport' - description: A viewport defined by a northeast and a southwest corner. - circle: - description: A circle defined by a center point and radius. - $ref: '#/components/schemas/GoogleMapsPlacesV1Circle' - type: object - description: >- - The region to search. The results will be restricted to the specified - region. - id: GoogleMapsPlacesV1AutocompletePlacesRequestLocationRestriction - GoogleMapsPlacesV1ContextualContentJustification: + The address descriptor of the place. Address descriptors include + additional information that help describe a location using landmarks + and areas. See address descriptor regional coverage in + https://developers.google.com/maps/documentation/geocoding/address-descriptors/coverage. + $ref: '#/components/schemas/GoogleMapsPlacesV1AddressDescriptor' + googleMapsLinks: + description: Links to trigger different Google Maps actions. + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceGoogleMapsLinks' + priceRange: + description: The price range associated with a Place. + $ref: '#/components/schemas/GoogleMapsPlacesV1PriceRange' + reviewSummary: + description: AI-generated summary of the place using user reviews. + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceReviewSummary' + evChargeAmenitySummary: + description: The summary of amenities near the EV charging station. + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceEvChargeAmenitySummary' + neighborhoodSummary: + description: A summary of points of interest near the place. + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceNeighborhoodSummary' + GoogleTypeLocalizedText: + id: GoogleTypeLocalizedText + description: Localized variant of a text in a particular language. type: object - description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. Justifications for the place. Justifications answers - the question of why a place could interest an end user. - id: GoogleMapsPlacesV1ContextualContentJustification properties: - reviewJustification: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1ContextualContentJustificationReviewJustification - description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. - businessAvailabilityAttributesJustification: - description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. - $ref: >- - #/components/schemas/GoogleMapsPlacesV1ContextualContentJustificationBusinessAvailabilityAttributesJustification - GoogleMapsPlacesV1Place: - id: GoogleMapsPlacesV1Place - properties: - viewport: - $ref: '#/components/schemas/GoogleGeoTypeViewport' - description: >- - A viewport suitable for displaying the place on an average-sized - map. This viewport should not be used as the physical boundary or - the service area of the business. - reservable: - type: boolean - description: Specifies if the place supports reservations. - primaryTypeDisplayName: - $ref: '#/components/schemas/GoogleTypeLocalizedText' + text: description: >- - The display name of the primary type, localized to the request - language if applicable. For the complete list of possible values, - see Table A and Table B at - https://developers.google.com/maps/documentation/places/web-service/place-types - servesDessert: - type: boolean - description: Place serves dessert. - adrFormatAddress: + Localized string in the language corresponding to language_code + below. + type: string + languageCode: + description: >- + The text's BCP-47 language code, such as "en-US" or "sr-Latn". For + more information, see + http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. type: string + GoogleTypePostalAddress: + id: GoogleTypePostalAddress + description: >- + Represents a postal address, such as for postal delivery or payments + addresses. With a postal address, a postal service can deliver items to + a premise, P.O. box, or similar. A postal address is not intended to + model geographical locations like roads, towns, or mountains. In typical + usage, an address would be created by user input or from importing + existing data, depending on the type of process. Advice on address input + or editing: - Use an internationalization-ready address widget such as + https://github.com/google/libaddressinput. - Users should not be + presented with UI elements for input or editing of fields outside + countries where that field is used. For more guidance on how to use this + schema, see: https://support.google.com/business/answer/6397478. + type: object + properties: + revision: + description: >- + The schema revision of the `PostalAddress`. This must be set to 0, + which is the latest revision. All new revisions **must** be backward + compatible with old revisions. + type: integer + format: int32 + regionCode: description: >- - The place's address in adr microformat: - http://microformats.org/wiki/adr. - types: + Required. CLDR region code of the country/region of the address. + This is never inferred and it is up to the user to ensure the value + is correct. See https://cldr.unicode.org/ and + https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html + for details. Example: "CH" for Switzerland. + type: string + languageCode: description: >- - A set of type tags for this result. For example, "political" and - "locality". For the complete list of possible values, see Table A - and Table B at - https://developers.google.com/maps/documentation/places/web-service/place-types + Optional. BCP-47 language code of the contents of this address (if + known). This is often the UI language of the input form or is + expected to match one of the languages used in the address' + country/region, or their transliterated equivalents. This can affect + formatting in certain countries, but is not critical to the + correctness of the data and will never affect any validation or + other non-formatting related operations. If this value is not known, + it should be omitted (rather than specifying a possibly incorrect + default). Examples: "zh-Hant", "ja", "ja-Latn", "en". + type: string + postalCode: + description: >- + Optional. Postal code of the address. Not all countries use or + require postal codes to be present, but where they are used, they + may trigger additional validation with other parts of the address + (for example, state or zip code validation in the United States). + type: string + sortingCode: + description: >- + Optional. Additional, country-specific, sorting code. This is not + used in most regions. Where it is used, the value is either a string + like "CEDEX", optionally followed by a number (for example, "CEDEX + 7"), or just a number alone, representing the "sector code" + (Jamaica), "delivery area indicator" (Malawi) or "post office + indicator" (Côte d'Ivoire). + type: string + administrativeArea: + description: >- + Optional. Highest administrative subdivision which is used for + postal addresses of a country or region. For example, this can be a + state, a province, an oblast, or a prefecture. For Spain, this is + the province and not the autonomous community (for example, + "Barcelona" and not "Catalonia"). Many countries don't use an + administrative area in postal addresses. For example, in + Switzerland, this should be left unpopulated. + type: string + locality: + description: >- + Optional. Generally refers to the city or town portion of the + address. Examples: US city, IT comune, UK post town. In regions of + the world where localities are not well defined or do not fit into + this structure well, leave `locality` empty and use `address_lines`. + type: string + sublocality: + description: >- + Optional. Sublocality of the address. For example, this can be a + neighborhood, borough, or district. + type: string + addressLines: + description: >- + Unstructured address lines describing the lower levels of an + address. Because values in `address_lines` do not have type + information and may sometimes contain multiple values in a single + field (for example, "Austin, TX"), it is important that the line + order is clear. The order of address lines should be "envelope + order" for the country or region of the address. In places where + this can vary (for example, Japan), `address_language` is used to + make it explicit (for example, "ja" for large-to-small ordering and + "ja-Latn" or "en" for small-to-large). In this way, the most + specific line of an address can be selected based on the language. + The minimum permitted structural representation of an address + consists of a `region_code` with all remaining information placed in + the `address_lines`. It would be possible to format such an address + very approximately without geocoding, but no semantic reasoning + could be made about any of the address components until it was at + least partially resolved. Creating an address only containing a + `region_code` and `address_lines` and then geocoding is the + recommended way to handle completely unstructured addresses (as + opposed to guessing which parts of the address should be localities + or administrative areas). + type: array items: type: string + recipients: + description: >- + Optional. The recipient at the address. This field may, under + certain circumstances, contain multiline information. For example, + it might contain "care of" information. type: array - takeout: - description: Specifies if the business supports takeout. - type: boolean - nationalPhoneNumber: - description: A human-readable phone number for the place, in national format. + items: + type: string + organization: + description: Optional. The name of the organization at the address. type: string - displayName: - $ref: '#/components/schemas/GoogleTypeLocalizedText' - description: >- - The localized name of the place, suitable as a short human-readable - description. For example, "Google Sydney", "Starbucks", "Pyrmont", - etc. - paymentOptions: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlacePaymentOptions' - description: >- - Payment options the place accepts. If a payment option data is not - available, the payment option field will be unset. - fuelOptions: - $ref: '#/components/schemas/GoogleMapsPlacesV1FuelOptions' + GoogleMapsPlacesV1PlaceAddressComponent: + id: GoogleMapsPlacesV1PlaceAddressComponent + description: >- + The structured components that form the formatted address, if this + information is available. + type: object + properties: + longText: description: >- - The most recent information about fuel options in a gas station. - This information is updated regularly. - goodForWatchingSports: - type: boolean - description: Place is suitable for watching sports. - servesBreakfast: - description: Specifies if the place serves breakfast. - type: boolean - servesLunch: - description: Specifies if the place serves lunch. - type: boolean - subDestinations: - description: A list of sub destinations related to the place. - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceSubDestination' - type: array - servesBrunch: - description: Specifies if the place serves brunch. - type: boolean - regularSecondaryOpeningHours: + The full text description or name of the address component. For + example, an address component for the country Australia may have a + long_name of "Australia". + type: string + shortText: description: >- - Contains an array of entries for information about regular secondary - hours of a business. Secondary hours are different from a business's - main hours. For example, a restaurant can specify drive through - hours or delivery hours as its secondary hours. This field populates - the type subfield, which draws from a predefined list of opening - hours types (such as DRIVE_THROUGH, PICKUP, or TAKEOUT) based on the - types of the place. + An abbreviated textual name for the address component, if available. + For example, an address component for the country of Australia may + have a short_name of "AU". + type: string + types: + description: An array indicating the type(s) of the address component. type: array items: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHours' - primaryType: + type: string + languageCode: + description: The language used to format this components, in CLDR notation. + type: string + GoogleMapsPlacesV1PlacePlusCode: + id: GoogleMapsPlacesV1PlacePlusCode + description: >- + Plus code (http://plus.codes) is a location reference with two formats: + global code defining a 14mx14m (1/8000th of a degree) or smaller + rectangle, and compound code, replacing the prefix with a reference + location. + type: object + properties: + globalCode: + description: >- + Place's global (full) code, such as "9FWM33GV+HQ", representing an + 1/8000 by 1/8000 degree area (~14 by 14 meters). type: string + compoundCode: description: >- - The primary type of the given result. This type must one of the - Places API supported types. For example, "restaurant", "cafe", - "airport", etc. A place can only have a single primary type. For the - complete list of possible values, see Table A and Table B at - https://developers.google.com/maps/documentation/places/web-service/place-types - curbsidePickup: - type: boolean - description: Specifies if the business supports curbside pickup. - allowsDogs: - type: boolean - description: Place allows dogs. + Place's compound code, such as "33GV+HQ, Ramberg, Norway", + containing the suffix of the global code and replacing the prefix + with a formatted name of a reference entity. + type: string + GoogleGeoTypeViewport: + id: GoogleGeoTypeViewport + description: >- + A latitude-longitude viewport, represented as two diagonally opposite + `low` and `high` points. A viewport is considered a closed region, i.e. + it includes its boundary. The latitude bounds must range between -90 to + 90 degrees inclusive, and the longitude bounds must range between -180 + to 180 degrees inclusive. Various cases include: - If `low` = `high`, + the viewport consists of that single point. - If `low.longitude` > + `high.longitude`, the longitude range is inverted (the viewport crosses + the 180 degree longitude line). - If `low.longitude` = -180 degrees and + `high.longitude` = 180 degrees, the viewport includes all longitudes. - + If `low.longitude` = 180 degrees and `high.longitude` = -180 degrees, + the longitude range is empty. - If `low.latitude` > `high.latitude`, the + latitude range is empty. Both `low` and `high` must be populated, and + the represented box cannot be empty (as specified by the definitions + above). An empty viewport will result in an error. For example, this + viewport fully encloses New York City: { "low": { "latitude": 40.477398, + "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": + -73.70018 } } + type: object + properties: + low: + description: Required. The low point of the viewport. + $ref: '#/components/schemas/GoogleTypeLatLng' + high: + description: Required. The high point of the viewport. + $ref: '#/components/schemas/GoogleTypeLatLng' + GoogleMapsPlacesV1Review: + id: GoogleMapsPlacesV1Review + description: Information about a review of a place. + type: object + properties: + name: + description: >- + A reference representing this place review which may be used to look + up this place review again (also called the API "resource" name: + `places/{place_id}/reviews/{review}`). + type: string + relativePublishTimeDescription: + description: >- + A string of formatted recent time, expressing the review time + relative to the current time in a form appropriate for the language + and country. + type: string + text: + description: The localized text of the review. + $ref: '#/components/schemas/GoogleTypeLocalizedText' + originalText: + description: The review text in its original language. + $ref: '#/components/schemas/GoogleTypeLocalizedText' rating: + description: A number between 1.0 and 5.0, also called the number of stars. type: number format: double - description: A rating between 1.0 and 5.0, based on user reviews of this place. - formattedAddress: - description: A full, human-readable address for this place. + authorAttribution: + description: This review's author. + $ref: '#/components/schemas/GoogleMapsPlacesV1AuthorAttribution' + publishTime: + description: Timestamp for the review. type: string - currentSecondaryOpeningHours: + format: google-datetime + flagContentUri: + description: A link where users can flag a problem with the review. + type: string + googleMapsUri: + description: A link to show the review on Google Maps. + type: string + GoogleMapsPlacesV1AuthorAttribution: + id: GoogleMapsPlacesV1AuthorAttribution + description: Information about the author of the UGC data. Used in Photo, and Review. + type: object + properties: + displayName: + description: Name of the author of the Photo or Review. + type: string + uri: + description: URI of the author of the Photo or Review. + type: string + photoUri: + description: Profile photo URI of the author of the Photo or Review. + type: string + GoogleMapsPlacesV1PlaceOpeningHours: + id: GoogleMapsPlacesV1PlaceOpeningHours + description: Information about business hour of the place. + type: object + properties: + openNow: description: >- - Contains an array of entries for the next seven days including - information about secondary hours of a business. Secondary hours are - different from a business's main hours. For example, a restaurant - can specify drive through hours or delivery hours as its secondary - hours. This field populates the type subfield, which draws from a - predefined list of opening hours types (such as DRIVE_THROUGH, - PICKUP, or TAKEOUT) based on the types of the place. This field - includes the special_days subfield of all hours, set for dates that - have exceptional hours. - type: array - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHours' - delivery: + Whether the opening hours period is currently active. For regular + opening hours and current opening hours, this field means whether + the place is open. For secondary opening hours and current secondary + opening hours, this field means whether the secondary hours of this + place is active. type: boolean - description: Specifies if the business supports delivery. - currentOpeningHours: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHours' - description: >- - The hours of operation for the next seven days (including today). - The time period starts at midnight on the date of the request and - ends at 11:59 pm six days later. This field includes the - special_days subfield of all hours, set for dates that have - exceptional hours. - generativeSummary: + periods: description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. AI-generated summary of the place. - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceGenerativeSummary' - photos: + The periods that this place is open during the week. The periods are + in chronological order, in the place-local timezone. An empty (but + not absent) value indicates a place that is never open, e.g. because + it is closed temporarily for renovations. The starting day of + `periods` is NOT fixed and should not be assumed to be Sunday. The + API determines the start day based on a variety of factors. For + example, for a 24/7 business, the first period may begin on the day + of the request. For other businesses, it might be the first day of + the week that they are open. NOTE: The ordering of the `periods` + array is independent of the ordering of the `weekday_descriptions` + array. Do not assume they will begin on the same day. + type: array items: - $ref: '#/components/schemas/GoogleMapsPlacesV1Photo' + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHoursPeriod' + weekdayDescriptions: description: >- - Information (including references) about photos of this place. A - maximum of 10 photos can be returned. + Localized strings describing the opening hours of this place, one + string for each day of the week. NOTE: The order of the days and the + start of the week is determined by the locale (language and region). + The ordering of the `periods` array is independent of the ordering + of the `weekday_descriptions` array. Do not assume they will begin + on the same day. Will be empty if the hours are unknown or could not + be converted to localized text. Example: "Sun: 18:00–06:00" type: array - servesCoffee: - description: Place serves coffee. - type: boolean - goodForChildren: - description: Place is good for children. - type: boolean - name: + items: + type: string + secondaryHoursType: + description: A type string used to identify the type of secondary hours. type: string + enumDescriptions: + - Default value when secondary hour type is not specified. + - The drive-through hour for banks, restaurants, or pharmacies. + - The happy hour. + - The delivery hour. + - The takeout hour. + - The kitchen hour. + - The breakfast hour. + - The lunch hour. + - The dinner hour. + - The brunch hour. + - The pickup hour. + - The access hours for storage places. + - The special hours for seniors. + - The online service hours. + enum: + - SECONDARY_HOURS_TYPE_UNSPECIFIED + - DRIVE_THROUGH + - HAPPY_HOUR + - DELIVERY + - TAKEOUT + - KITCHEN + - BREAKFAST + - LUNCH + - DINNER + - BRUNCH + - PICKUP + - ACCESS + - SENIOR_HOURS + - ONLINE_SERVICE_HOURS + specialDays: description: >- - This Place's resource name, in `places/{place_id}` format. Can be - used to look up the Place. - reviews: + Structured information for special days that fall within the period + that the returned opening hours cover. Special days are days that + could impact the business hours of a place, e.g. Christmas day. Set + for current_opening_hours and current_secondary_opening_hours if + there are exceptional hours. type: array - description: >- - List of reviews about this place, sorted by relevance. A maximum of - 5 reviews can be returned. items: - $ref: '#/components/schemas/GoogleMapsPlacesV1Review' - websiteUri: + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHoursSpecialDay' + nextOpenTime: description: >- - The authoritative website for this place, e.g. a business' homepage. - Note that for places that are part of a chain (e.g. an IKEA store), - this will usually be the website for the individual store, not the - overall chain. - type: string - servesWine: - description: Specifies if the place serves wine. - type: boolean - internationalPhoneNumber: + The next time the current opening hours period starts up to 7 days + in the future. This field is only populated if the opening hours + period is not active at the time of serving the request. type: string + format: google-datetime + nextCloseTime: description: >- - A human-readable phone number for the place, in international - format. - googleMapsLinks: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceGoogleMapsLinks' - description: Links to trigger different Google Maps actions. - outdoorSeating: - description: Place provides outdoor seating. - type: boolean - googleMapsUri: - description: A URL providing more information about this place. - type: string - attributions: - description: A set of data provider that must be shown with this result. - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceAttribution' - type: array - plusCode: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlacePlusCode' - description: Plus code of the place location lat/long. - liveMusic: - description: Place provides live music. - type: boolean - servesCocktails: - description: Place serves cocktails. - type: boolean - iconBackgroundColor: + The next time the current opening hours period ends up to 7 days in + the future. This field is only populated if the opening hours period + is active at the time of serving the request. type: string - description: 'Background color for icon_mask in hex format, e.g. #909CE1.' - areaSummary: + format: google-datetime + GoogleMapsPlacesV1PlaceOpeningHoursPeriod: + id: GoogleMapsPlacesV1PlaceOpeningHoursPeriod + description: A period the place remains in open_now status. + type: object + properties: + open: + description: The time that the place starts to be open. + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHoursPeriodPoint' + close: + description: The time that the place starts to be closed. + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHoursPeriodPoint' + GoogleMapsPlacesV1PlaceOpeningHoursPeriodPoint: + id: GoogleMapsPlacesV1PlaceOpeningHoursPeriodPoint + description: Status changing points. + type: object + properties: + day: description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. AI-generated summary of the area that the place is - in. - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceAreaSummary' - userRatingCount: - description: The total number of reviews (with or without text) for this place. + A day of the week, as an integer in the range 0-6. 0 is Sunday, 1 is + Monday, etc. type: integer format: int32 - goodForGroups: - description: Place accommodates groups. - type: boolean - regularOpeningHours: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHours' - description: The regular hours of operation. - menuForChildren: - description: Place has a children's menu. - type: boolean - accessibilityOptions: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceAccessibilityOptions' - description: Information about the accessibility options a place offers. - addressDescriptor: - $ref: '#/components/schemas/GoogleMapsPlacesV1AddressDescriptor' - description: >- - The address descriptor of the place. Address descriptors include - additional information that help describe a location using landmarks - and areas. See address descriptor regional coverage in - https://developers.google.com/maps/documentation/geocoding/address-descriptors/coverage. - evChargeOptions: - description: Information of ev charging options. - $ref: '#/components/schemas/GoogleMapsPlacesV1EVChargeOptions' - dineIn: + hour: + description: The hour in 24 hour format. Ranges from 0 to 23. + type: integer + format: int32 + minute: + description: The minute. Ranges from 0 to 59. + type: integer + format: int32 + date: + description: Date in the local timezone for the place. + $ref: '#/components/schemas/GoogleTypeDate' + truncated: description: >- - Specifies if the business supports indoor or outdoor seating - options. + Whether or not this endpoint was truncated. Truncation occurs when + the real hours are outside the times we are willing to return hours + between, so we truncate the hours back to these boundaries. This + ensures that at most 24 * 7 hours from midnight of the day of the + request are returned. type: boolean - iconMaskBaseUri: - type: string + GoogleTypeDate: + id: GoogleTypeDate + description: >- + Represents a whole or partial calendar date, such as a birthday. The + time of day and time zone are either specified elsewhere or are + insignificant. The date is relative to the Gregorian Calendar. This can + represent one of the following: * A full date, with non-zero year, + month, and day values. * A month and day, with a zero year (for example, + an anniversary). * A year on its own, with a zero month and a zero day. + * A year and month, with a zero day (for example, a credit card + expiration date). Related types: * google.type.TimeOfDay * + google.type.DateTime * google.protobuf.Timestamp + type: object + properties: + year: description: >- - A truncated URL to an icon mask. User can access different icon type - by appending type suffix to the end (eg, ".svg" or ".png"). - parkingOptions: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceParkingOptions' - description: Options of parking provided by the place. - addressComponents: - type: array - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceAddressComponent' + Year of the date. Must be from 1 to 9999, or 0 to specify a date + without a year. + type: integer + format: int32 + month: description: >- - Repeated components for each locality level. Note the following - facts about the address_components[] array: - The array of address - components may contain more components than the formatted_address. - - The array does not necessarily include all the political entities - that contain an address, apart from those included in the - formatted_address. To retrieve all the political entities that - contain a specific address, you should use reverse geocoding, - passing the latitude/longitude of the address as a parameter to the - request. - The format of the response is not guaranteed to remain - the same between requests. In particular, the number of - address_components varies based on the address requested and can - change over time for the same address. A component can change - position in the array. The type of the component can change. A - particular component may be missing in a later response. - restroom: - type: boolean - description: Place has restroom. - utcOffsetMinutes: + Month of a year. Must be from 1 to 12, or 0 to specify a year + without a month and day. type: integer format: int32 + day: description: >- - Number of minutes this place's timezone is currently offset from - UTC. This is expressed in minutes to support timezones that are - offset by fractions of an hour, e.g. X hours and 15 minutes. - businessStatus: - enum: - - BUSINESS_STATUS_UNSPECIFIED - - OPERATIONAL - - CLOSED_TEMPORARILY - - CLOSED_PERMANENTLY - enumDescriptions: - - Default value. This value is unused. - - The establishment is operational, not necessarily open now. - - The establishment is temporarily closed. - - The establishment is permanently closed. - type: string - servesBeer: - type: boolean - description: Specifies if the place serves beer. - servesDinner: - description: Specifies if the place serves dinner. - type: boolean - priceLevel: - type: string - description: Price level of the place. - enum: - - PRICE_LEVEL_UNSPECIFIED - - PRICE_LEVEL_FREE - - PRICE_LEVEL_INEXPENSIVE - - PRICE_LEVEL_MODERATE - - PRICE_LEVEL_EXPENSIVE - - PRICE_LEVEL_VERY_EXPENSIVE - enumDescriptions: - - Place price level is unspecified or unknown. - - Place provides free services. - - Place provides inexpensive services. - - Place provides moderately priced services. - - Place provides expensive services. - - Place provides very expensive services. - shortFormattedAddress: - description: A short, human-readable address for this place. + Day of a month. Must be from 1 to 31 and valid for the year and + month, or 0 to specify a year by itself or a year and month where + the day isn't significant. + type: integer + format: int32 + GoogleMapsPlacesV1PlaceOpeningHoursSpecialDay: + id: GoogleMapsPlacesV1PlaceOpeningHoursSpecialDay + description: >- + Structured information for special days that fall within the period that + the returned opening hours cover. Special days are days that could + impact the business hours of a place, e.g. Christmas day. + type: object + properties: + date: + description: The date of this special day. + $ref: '#/components/schemas/GoogleTypeDate' + GoogleTypeTimeZone: + id: GoogleTypeTimeZone + description: >- + Represents a time zone from the [IANA Time Zone + Database](https://www.iana.org/time-zones). + type: object + properties: + id: + description: IANA Time Zone Database time zone. For example "America/New_York". type: string - servesVegetarianFood: - type: boolean - description: Specifies if the place serves vegetarian food. - editorialSummary: - $ref: '#/components/schemas/GoogleTypeLocalizedText' + version: description: >- - Contains a summary of the place. A summary is comprised of a textual - overview, and also includes the language code for these if - applicable. Summary text must be presented as-is and can not be - modified or altered. - id: - description: The unique identifier of a place. + Optional. IANA Time Zone Database version number. For example + "2019a". type: string - location: - description: The position of this place. - $ref: '#/components/schemas/GoogleTypeLatLng' - description: All the information representing a Place. - type: object - GoogleMapsPlacesV1PlaceAreaSummary: + GoogleMapsPlacesV1Photo: + id: GoogleMapsPlacesV1Photo + description: Information about a photo of a place. type: object - description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. AI-generated summary of the area that the place is in. properties: - flagContentUri: + name: + description: >- + Identifier. A reference representing this place photo which may be + used to look up this place photo again (also called the API + "resource" name: `places/{place_id}/photos/{photo}`). type: string - description: A link where users can flag a problem with the summary. - contentBlocks: + widthPx: + description: The maximum available width, in pixels. + type: integer + format: int32 + heightPx: + description: The maximum available height, in pixels. + type: integer + format: int32 + authorAttributions: + description: This photo's authors. type: array items: - $ref: '#/components/schemas/GoogleMapsPlacesV1ContentBlock' + $ref: '#/components/schemas/GoogleMapsPlacesV1AuthorAttribution' + flagContentUri: + description: A link where users can flag a problem with the photo. + type: string + googleMapsUri: + description: A link to show the photo on Google Maps. + type: string + GoogleMapsPlacesV1PlaceAttribution: + id: GoogleMapsPlacesV1PlaceAttribution + description: Information about data providers of this place. + type: object + properties: + provider: + description: Name of the Place's data provider. + type: string + providerUri: + description: URI to the Place's data provider. + type: string + GoogleMapsPlacesV1PlacePaymentOptions: + id: GoogleMapsPlacesV1PlacePaymentOptions + description: Payment options the place accepts. + type: object + properties: + acceptsCreditCards: + description: Place accepts credit cards as payment. + type: boolean + acceptsDebitCards: + description: Place accepts debit cards as payment. + type: boolean + acceptsCashOnly: description: >- - Content blocks that compose the area summary. Each block has a - separate topic about the area. - id: GoogleMapsPlacesV1PlaceAreaSummary - GoogleMapsPlacesV1References: + Place accepts cash only as payment. Places with this attribute may + still accept other payment methods. + type: boolean + acceptsNfc: + description: Place accepts NFC payments. + type: boolean + GoogleMapsPlacesV1PlaceParkingOptions: + id: GoogleMapsPlacesV1PlaceParkingOptions description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. Reference that the generative content is related to. - id: GoogleMapsPlacesV1References + Information about parking options for the place. A parking lot could + support more than one option at the same time. + type: object properties: - reviews: - description: Reviews that serve as references. - type: array - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1Review' - places: + freeParkingLot: + description: Place offers free parking lots. + type: boolean + paidParkingLot: + description: Place offers paid parking lots. + type: boolean + freeStreetParking: + description: Place offers free street parking. + type: boolean + paidStreetParking: + description: Place offers paid street parking. + type: boolean + valetParking: + description: Place offers valet parking. + type: boolean + freeGarageParking: + description: Place offers free garage parking. + type: boolean + paidGarageParking: + description: Place offers paid garage parking. + type: boolean + GoogleMapsPlacesV1PlaceSubDestination: + id: GoogleMapsPlacesV1PlaceSubDestination + description: >- + Sub-destinations are specific places associated with a main place. These + provide more specific destinations for users who are searching within a + large or complex place, like an airport, national park, university, or + stadium. For example, sub-destinations at an airport might include + associated terminals and parking lots. Sub-destinations return the place + ID and place resource name, which can be used in subsequent Place + Details (New) requests to fetch richer details, including the + sub-destination's display name and location. + type: object + properties: + name: + description: The resource name of the sub-destination. + type: string + id: + description: The place id of the sub-destination. + type: string + GoogleMapsPlacesV1PlaceAccessibilityOptions: + id: GoogleMapsPlacesV1PlaceAccessibilityOptions + description: Information about the accessibility options a place offers. + type: object + properties: + wheelchairAccessibleParking: + description: Place offers wheelchair accessible parking. + type: boolean + wheelchairAccessibleEntrance: + description: Places has wheelchair accessible entrance. + type: boolean + wheelchairAccessibleRestroom: + description: Place has wheelchair accessible restroom. + type: boolean + wheelchairAccessibleSeating: + description: Place has wheelchair accessible seating. + type: boolean + GoogleMapsPlacesV1FuelOptions: + id: GoogleMapsPlacesV1FuelOptions + description: >- + The most recent information about fuel options in a gas station. This + information is updated regularly. + type: object + properties: + fuelPrices: description: >- - The list of resource names of the referenced places. This name can - be used in other APIs that accept Place resource names. + The last known fuel price for each type of fuel this station has. + There is one entry per fuel type this station has. Order is not + important. type: array items: - type: string + $ref: '#/components/schemas/GoogleMapsPlacesV1FuelOptionsFuelPrice' + GoogleMapsPlacesV1FuelOptionsFuelPrice: + id: GoogleMapsPlacesV1FuelOptionsFuelPrice + description: Fuel price information for a given type. type: object - GoogleMapsPlacesV1AddressDescriptorArea: - description: >- - Area information and the area's relationship with the target location. - Areas includes precise sublocality, neighborhoods, and large compounds - that are useful for describing a location. properties: - displayName: - $ref: '#/components/schemas/GoogleTypeLocalizedText' - description: The area's display name. - containment: - description: >- - Defines the spatial relationship between the target location and the - area. + type: + description: The type of fuel. + type: string enumDescriptions: - - The containment is unspecified. - - >- - The target location is within the area region, close to the - center. - - The target location is within the area region, close to the edge. - - The target location is outside the area region, but close by. + - Unspecified fuel type. + - Diesel fuel. + - Diesel plus fuel. + - Regular unleaded. + - Midgrade. + - Premium. + - SP 91. + - SP 91 E10. + - SP 92. + - SP 95. + - SP95 E10. + - SP 98. + - SP 99. + - SP 100. + - Liquefied Petroleum Gas. + - E 80. + - E 85. + - E 100. + - Methane. + - Bio-diesel. + - Truck diesel. enum: - - CONTAINMENT_UNSPECIFIED - - WITHIN - - OUTSKIRTS - - NEAR - type: string - placeId: - description: The area's place id. - type: string - name: - description: The area's resource name. + - FUEL_TYPE_UNSPECIFIED + - DIESEL + - DIESEL_PLUS + - REGULAR_UNLEADED + - MIDGRADE + - PREMIUM + - SP91 + - SP91_E10 + - SP92 + - SP95 + - SP95_E10 + - SP98 + - SP99 + - SP100 + - LPG + - E80 + - E85 + - E100 + - METHANE + - BIO_DIESEL + - TRUCK_DIESEL + price: + description: The price of the fuel. + $ref: '#/components/schemas/GoogleTypeMoney' + updateTime: + description: The time the fuel price was last updated. type: string - id: GoogleMapsPlacesV1AddressDescriptorArea - type: object - GoogleMapsPlacesV1Review: + format: google-datetime + GoogleTypeMoney: + id: GoogleTypeMoney + description: Represents an amount of money with its currency type. type: object - description: Information about a review of a place. - id: GoogleMapsPlacesV1Review properties: - originalText: - description: The review text in its original language. - $ref: '#/components/schemas/GoogleTypeLocalizedText' - googleMapsUri: - type: string - description: A link to show the review on Google Maps. - text: - description: The localized text of the review. - $ref: '#/components/schemas/GoogleTypeLocalizedText' - flagContentUri: - type: string - description: A link where users can flag a problem with the review. - rating: - type: number - format: double - description: A number between 1.0 and 5.0, also called the number of stars. - publishTime: + currencyCode: + description: The three-letter currency code defined in ISO 4217. type: string - format: google-datetime - description: Timestamp for the review. - name: + units: description: >- - A reference representing this place review which may be used to look - up this place review again (also called the API "resource" name: - `places/{place_id}/reviews/{review}`). + The whole units of the amount. For example if `currencyCode` is + `"USD"`, then 1 unit is one US dollar. type: string - authorAttribution: - $ref: '#/components/schemas/GoogleMapsPlacesV1AuthorAttribution' - description: This review's author. - relativePublishTimeDescription: + format: int64 + nanos: description: >- - A string of formatted recent time, expressing the review time - relative to the current time in a form appropriate for the language - and country. - type: string + Number of nano (10^-9) units of the amount. The value must be + between -999,999,999 and +999,999,999 inclusive. If `units` is + positive, `nanos` must be positive or zero. If `units` is zero, + `nanos` can be positive, zero, or negative. If `units` is negative, + `nanos` must be negative or zero. For example $-1.75 is represented + as `units`=-1 and `nanos`=-750,000,000. + type: integer + format: int32 GoogleMapsPlacesV1EVChargeOptions: + id: GoogleMapsPlacesV1EVChargeOptions + description: >- + Information about the EV Charge Station hosted in Place. Terminology + follows https://afdc.energy.gov/fuels/electricity_infrastructure.html + One port could charge one car at a time. One port has one or more + connectors. One station has one or more ports. type: object properties: - connectorAggregation: - items: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1EVChargeOptionsConnectorAggregation - description: >- - A list of EV charging connector aggregations that contain connectors - of the same type and same charge rate. - type: array connectorCount: description: >- Number of connectors at this station. However, because some ports can have multiple connectors but only be able to charge one car at a time (e.g.) the number of connectors may be greater than the total number of cars which can charge simultaneously. - format: int32 type: integer - id: GoogleMapsPlacesV1EVChargeOptions + format: int32 + connectorAggregation: + description: >- + A list of EV charging connector aggregations that contain connectors + of the same type and same charge rate. + type: array + items: + $ref: >- + #/components/schemas/GoogleMapsPlacesV1EVChargeOptionsConnectorAggregation + GoogleMapsPlacesV1EVChargeOptionsConnectorAggregation: + id: GoogleMapsPlacesV1EVChargeOptionsConnectorAggregation description: >- - Information about the EV Charge Station hosted in Place. Terminology - follows https://afdc.energy.gov/fuels/electricity_infrastructure.html - One port could charge one car at a time. One port has one or more - connectors. One station has one or more ports. - GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStringRange: + EV charging information grouped by [type, max_charge_rate_kw]. Shows EV + charge aggregation of connectors that have the same type and max charge + rate in kw. type: object - description: Identifies a substring within a given text. - id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStringRange properties: - endOffset: + type: + description: The connector type of this aggregation. + type: string + enumDescriptions: + - Unspecified connector. + - Other connector types. + - J1772 type 1 connector. + - IEC 62196 type 2 connector. Often referred to as MENNEKES. + - CHAdeMO type connector. + - >- + Combined Charging System (AC and DC). Based on SAE. Type-1 J-1772 + connector + - >- + Combined Charging System (AC and DC). Based on Type-2 Mennekes + connector + - >- + The generic TESLA connector. This is NACS in the North America but + can be non-NACS in other parts of the world (e.g. CCS Combo 2 + (CCS2) or GB/T). This value is less representative of an actual + connector type, and more represents the ability to charge a Tesla + brand vehicle at a Tesla owned charging station. + - >- + GB/T type corresponds to the GB/T standard in China. This type + covers all GB_T types. + - Unspecified wall outlet. + - >- + The North American Charging System (NACS), standardized as SAE + J3400. + enum: + - EV_CONNECTOR_TYPE_UNSPECIFIED + - EV_CONNECTOR_TYPE_OTHER + - EV_CONNECTOR_TYPE_J1772 + - EV_CONNECTOR_TYPE_TYPE_2 + - EV_CONNECTOR_TYPE_CHADEMO + - EV_CONNECTOR_TYPE_CCS_COMBO_1 + - EV_CONNECTOR_TYPE_CCS_COMBO_2 + - EV_CONNECTOR_TYPE_TESLA + - EV_CONNECTOR_TYPE_UNSPECIFIED_GB_T + - EV_CONNECTOR_TYPE_UNSPECIFIED_WALL_OUTLET + - EV_CONNECTOR_TYPE_NACS + maxChargeRateKw: + description: >- + The static max charging rate in kw of each connector in the + aggregation. + type: number + format: double + count: + description: Number of connectors in this aggregation. type: integer - description: Zero-based offset of the last Unicode character (exclusive). format: int32 - startOffset: + availableCount: + description: >- + Number of connectors in this aggregation that are currently + available. type: integer + format: int32 + outOfServiceCount: description: >- - Zero-based offset of the first Unicode character of the string - (inclusive). + Number of connectors in this aggregation that are currently out of + service. + type: integer format: int32 - GoogleMapsPlacesV1PlaceAddressComponent: - id: GoogleMapsPlacesV1PlaceAddressComponent - description: >- - The structured components that form the formatted address, if this - information is available. - properties: - languageCode: + availabilityLastUpdateTime: + description: >- + The timestamp when the connector availability information in this + aggregation was last updated. type: string - description: The language used to format this components, in CLDR notation. - longText: + format: google-datetime + GoogleMapsPlacesV1PlaceGenerativeSummary: + id: GoogleMapsPlacesV1PlaceGenerativeSummary + description: AI-generated summary of the place. + type: object + properties: + overview: + description: The overview of the place. + $ref: '#/components/schemas/GoogleTypeLocalizedText' + overviewFlagContentUri: + description: A link where users can flag a problem with the overview summary. type: string + disclosureText: description: >- - The full text description or name of the address component. For - example, an address component for the country Australia may have a - long_name of "Australia". - shortText: + The AI disclosure message "Summarized with Gemini" (and its + localized variants). This will be in the language specified in the + request if available. + $ref: '#/components/schemas/GoogleTypeLocalizedText' + GoogleMapsPlacesV1PlaceContainingPlace: + id: GoogleMapsPlacesV1PlaceContainingPlace + description: Info about the place in which this place is located. + type: object + properties: + name: + description: The resource name of the place in which this place is located. + type: string + id: + description: The place id of the place in which this place is located. type: string + GoogleMapsPlacesV1AddressDescriptor: + id: GoogleMapsPlacesV1AddressDescriptor + description: >- + A relational description of a location. Includes a ranked set of nearby + landmarks and precise containing areas and their relationship to the + target location. + type: object + properties: + landmarks: description: >- - An abbreviated textual name for the address component, if available. - For example, an address component for the country of Australia may - have a short_name of "AU". - types: + A ranked list of nearby landmarks. The most recognizable and nearby + landmarks are ranked first. + type: array items: - type: string + $ref: '#/components/schemas/GoogleMapsPlacesV1AddressDescriptorLandmark' + areas: + description: >- + A ranked list of containing or adjacent areas. The most recognizable + and precise areas are ranked first. type: array - description: An array indicating the type(s) of the address component. + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1AddressDescriptorArea' + GoogleMapsPlacesV1AddressDescriptorLandmark: + id: GoogleMapsPlacesV1AddressDescriptorLandmark + description: >- + Basic landmark information and the landmark's relationship with the + target location. Landmarks are prominent places that can be used to + describe a location. type: object - GoogleMapsPlacesV1PlaceSubDestination: + properties: + name: + description: The landmark's resource name. + type: string + placeId: + description: The landmark's place id. + type: string + displayName: + description: The landmark's display name. + $ref: '#/components/schemas/GoogleTypeLocalizedText' + types: + description: >- + A set of type tags for this landmark. For a complete list of + possible values, see + https://developers.google.com/maps/documentation/places/web-service/place-types. + type: array + items: + type: string + spatialRelationship: + description: >- + Defines the spatial relationship between the target location and the + landmark. + type: string + enumDescriptions: + - >- + This is the default relationship when nothing more specific below + applies. + - >- + The landmark has a spatial geometry and the target is within its + bounds. + - The target is directly adjacent to the landmark. + - >- + The target is directly opposite the landmark on the other side of + the road. + - On the same route as the landmark but not besides or across. + - Not on the same route as the landmark but a single turn away. + - >- + Close to the landmark's structure but further away from its street + entrances. + enum: + - NEAR + - WITHIN + - BESIDE + - ACROSS_THE_ROAD + - DOWN_THE_ROAD + - AROUND_THE_CORNER + - BEHIND + straightLineDistanceMeters: + description: >- + The straight line distance, in meters, between the center point of + the target and the center point of the landmark. In some situations, + this value can be longer than `travel_distance_meters`. + type: number + format: float + travelDistanceMeters: + description: >- + The travel distance, in meters, along the road network from the + target to the landmark, if known. This value does not take into + account the mode of transportation, such as walking, driving, or + biking. + type: number + format: float + GoogleMapsPlacesV1AddressDescriptorArea: + id: GoogleMapsPlacesV1AddressDescriptorArea + description: >- + Area information and the area's relationship with the target location. + Areas includes precise sublocality, neighborhoods, and large compounds + that are useful for describing a location. type: object properties: - id: - type: string - description: The place id of the sub destination. name: - description: The resource name of the sub destination. + description: The area's resource name. type: string - description: >- - Place resource name and id of sub destinations that relate to the place. - For example, different terminals are different destinations of an - airport. - id: GoogleMapsPlacesV1PlaceSubDestination - GoogleMapsPlacesV1PlaceParkingOptions: - type: object - id: GoogleMapsPlacesV1PlaceParkingOptions - properties: - valetParking: - type: boolean - description: Place offers valet parking. - freeStreetParking: - description: Place offers free street parking. - type: boolean - paidGarageParking: - type: boolean - description: Place offers paid garage parking. - paidStreetParking: - type: boolean - description: Place offers paid street parking. - paidParkingLot: - type: boolean - description: Place offers paid parking lots. - freeParkingLot: - type: boolean - description: Place offers free parking lots. - freeGarageParking: - description: Place offers free garage parking. - type: boolean - description: >- - Information about parking options for the place. A parking lot could - support more than one option at the same time. + placeId: + description: The area's place id. + type: string + displayName: + description: The area's display name. + $ref: '#/components/schemas/GoogleTypeLocalizedText' + containment: + description: >- + Defines the spatial relationship between the target location and the + area. + type: string + enumDescriptions: + - The containment is unspecified. + - >- + The target location is within the area region, close to the + center. + - The target location is within the area region, close to the edge. + - The target location is outside the area region, but close by. + enum: + - CONTAINMENT_UNSPECIFIED + - WITHIN + - OUTSKIRTS + - NEAR GoogleMapsPlacesV1PlaceGoogleMapsLinks: + id: GoogleMapsPlacesV1PlaceGoogleMapsLinks + description: Links to trigger different Google Maps actions. + type: object properties: - writeAReviewUri: + directionsUri: description: >- - A link to write a review for this place. This link is currently not - supported on Google Maps Mobile and only works on the web version of - Google Maps. + A link to show the directions to the place. The link only populates + the destination location and uses the default travel mode `DRIVE`. type: string placeUri: description: A link to show this place. type: string + writeAReviewUri: + description: A link to write a review for this place on Google Maps. + type: string reviewsUri: - description: >- - A link to show reviews of this place. This link is currently not - supported on Google Maps Mobile and only works on the web version of - Google Maps. + description: A link to show reviews of this place on Google Maps. type: string photosUri: - description: >- - A link to show photos of this place. This link is currently not - supported on Google Maps Mobile and only works on the web version of - Google Maps. - type: string - directionsUri: - description: >- - A link to show the directions to the place. The link only populates - the destination location and uses the default travel mode `DRIVE`. + description: A link to show reviews of this place on Google Maps. type: string + GoogleMapsPlacesV1PriceRange: + id: GoogleMapsPlacesV1PriceRange + description: >- + The price range associated with a Place. `end_price` could be unset, + which indicates a range without upper bound (e.g. "More than $100"). type: object - id: GoogleMapsPlacesV1PlaceGoogleMapsLinks - description: Links to trigger different Google Maps actions. - GoogleTypeMoney: - type: object - description: Represents an amount of money with its currency type. properties: - currencyCode: - type: string - description: The three-letter currency code defined in ISO 4217. - nanos: + startPrice: description: >- - Number of nano (10^-9) units of the amount. The value must be - between -999,999,999 and +999,999,999 inclusive. If `units` is - positive, `nanos` must be positive or zero. If `units` is zero, - `nanos` can be positive, zero, or negative. If `units` is negative, - `nanos` must be negative or zero. For example $-1.75 is represented - as `units`=-1 and `nanos`=-750,000,000. - format: int32 - type: integer - units: - format: int64 + The low end of the price range (inclusive). Price should be at or + above this amount. + $ref: '#/components/schemas/GoogleTypeMoney' + endPrice: description: >- - The whole units of the amount. For example if `currencyCode` is - `"USD"`, then 1 unit is one US dollar. - type: string - id: GoogleTypeMoney - GoogleMapsPlacesV1PlaceAttribution: - description: Information about data providers of this place. + The high end of the price range (exclusive). Price should be lower + than this amount. + $ref: '#/components/schemas/GoogleTypeMoney' + GoogleMapsPlacesV1PlaceReviewSummary: + id: GoogleMapsPlacesV1PlaceReviewSummary + description: AI-generated summary of the place using user reviews. + type: object properties: - providerUri: + text: + description: The summary of user reviews. + $ref: '#/components/schemas/GoogleTypeLocalizedText' + flagContentUri: + description: A link where users can flag a problem with the summary. type: string - description: URI to the Place's data provider. - provider: - description: Name of the Place's data provider. + disclosureText: + description: >- + The AI disclosure message "Summarized with Gemini" (and its + localized variants). This will be in the language specified in the + request if available. + $ref: '#/components/schemas/GoogleTypeLocalizedText' + reviewsUri: + description: A link to show reviews of this place on Google Maps. type: string - id: GoogleMapsPlacesV1PlaceAttribution - type: object - GoogleMapsPlacesV1ContextualContentJustificationReviewJustification: - description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. User review justifications. This highlights a section - of the user review that would interest an end user. For instance, if the - search query is "firewood pizza", the review justification highlights - the text relevant to the search query. - type: object - id: GoogleMapsPlacesV1ContextualContentJustificationReviewJustification - properties: - review: - $ref: '#/components/schemas/GoogleMapsPlacesV1Review' - description: The review that the highlighted text is generated from. - highlightedText: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedText - GoogleMapsPlacesV1PlaceOpeningHoursSpecialDay: + GoogleMapsPlacesV1PlaceEvChargeAmenitySummary: + id: GoogleMapsPlacesV1PlaceEvChargeAmenitySummary description: >- - Structured information for special days that fall within the period that - the returned opening hours cover. Special days are days that could - impact the business hours of a place, e.g. Christmas day. - properties: - date: - description: The date of this special day. - $ref: '#/components/schemas/GoogleTypeDate' - id: GoogleMapsPlacesV1PlaceOpeningHoursSpecialDay + The summary of amenities near the EV charging station. This only applies + to places with type `electric_vehicle_charging_station`. The `overview` + field is guaranteed to be provided while the other fields are optional. type: object - GoogleMapsPlacesV1Photo: properties: + overview: + description: >- + An overview of the available amenities. This is guaranteed to be + provided. + $ref: '#/components/schemas/GoogleMapsPlacesV1ContentBlock' + coffee: + description: A summary of the nearby coffee options. + $ref: '#/components/schemas/GoogleMapsPlacesV1ContentBlock' + restaurant: + description: A summary of the nearby restaurants. + $ref: '#/components/schemas/GoogleMapsPlacesV1ContentBlock' + store: + description: A summary of the nearby stores. + $ref: '#/components/schemas/GoogleMapsPlacesV1ContentBlock' flagContentUri: - description: A link where users can flag a problem with the photo. - type: string - heightPx: - type: integer - description: The maximum available height, in pixels. - format: int32 - authorAttributions: - description: This photo's authors. - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1AuthorAttribution' - type: array - widthPx: - description: The maximum available width, in pixels. - format: int32 - type: integer - name: + description: A link where users can flag a problem with the summary. type: string + disclosureText: description: >- - Identifier. A reference representing this place photo which may be - used to look up this place photo again (also called the API - "resource" name: `places/{place_id}/photos/{photo}`). - googleMapsUri: - description: A link to show the photo on Google Maps. - type: string + The AI disclosure message "Summarized with Gemini" (and its + localized variants). This will be in the language specified in the + request if available. + $ref: '#/components/schemas/GoogleTypeLocalizedText' + GoogleMapsPlacesV1ContentBlock: + id: GoogleMapsPlacesV1ContentBlock + description: A block of content that can be served individually. type: object - description: Information about a photo of a place. - id: GoogleMapsPlacesV1Photo - GoogleMapsPlacesV1EVChargeOptionsConnectorAggregation: - id: GoogleMapsPlacesV1EVChargeOptionsConnectorAggregation - description: >- - EV charging information grouped by [type, max_charge_rate_kw]. Shows EV - charge aggregation of connectors that have the same type and max charge - rate in kw. + properties: + content: + description: Content related to the topic. + $ref: '#/components/schemas/GoogleTypeLocalizedText' + referencedPlaces: + description: >- + The list of resource names of the referenced places. This name can + be used in other APIs that accept Place resource names. + type: array + items: + type: string + GoogleMapsPlacesV1PlaceNeighborhoodSummary: + id: GoogleMapsPlacesV1PlaceNeighborhoodSummary + description: A summary of points of interest near the place. type: object properties: - type: - description: The connector type of this aggregation. - enum: - - EV_CONNECTOR_TYPE_UNSPECIFIED - - EV_CONNECTOR_TYPE_OTHER - - EV_CONNECTOR_TYPE_J1772 - - EV_CONNECTOR_TYPE_TYPE_2 - - EV_CONNECTOR_TYPE_CHADEMO - - EV_CONNECTOR_TYPE_CCS_COMBO_1 - - EV_CONNECTOR_TYPE_CCS_COMBO_2 - - EV_CONNECTOR_TYPE_TESLA - - EV_CONNECTOR_TYPE_UNSPECIFIED_GB_T - - EV_CONNECTOR_TYPE_UNSPECIFIED_WALL_OUTLET - type: string - enumDescriptions: - - Unspecified connector. - - Other connector types. - - J1772 type 1 connector. - - IEC 62196 type 2 connector. Often referred to as MENNEKES. - - CHAdeMO type connector. - - >- - Combined Charging System (AC and DC). Based on SAE. Type-1 J-1772 - connector - - >- - Combined Charging System (AC and DC). Based on Type-2 Mennekes - connector - - >- - The generic TESLA connector. This is NACS in the North America but - can be non-NACS in other parts of the world (e.g. CCS Combo 2 - (CCS2) or GB/T). This value is less representative of an actual - connector type, and more represents the ability to charge a Tesla - brand vehicle at a Tesla owned charging station. - - >- - GB/T type corresponds to the GB/T standard in China. This type - covers all GB_T types. - - Unspecified wall outlet. - count: - format: int32 - description: Number of connectors in this aggregation. - type: integer - availabilityLastUpdateTime: + overview: + description: An overview summary of the neighborhood. + $ref: '#/components/schemas/GoogleMapsPlacesV1ContentBlock' + description: + description: A detailed description of the neighborhood. + $ref: '#/components/schemas/GoogleMapsPlacesV1ContentBlock' + flagContentUri: + description: A link where users can flag a problem with the summary. type: string - format: google-datetime - description: >- - The timestamp when the connector availability information in this - aggregation was last updated. - maxChargeRateKw: - type: number + disclosureText: description: >- - The static max charging rate in kw of each connector in the - aggregation. - format: double - outOfServiceCount: - format: int32 - type: integer + The AI disclosure message "Summarized with Gemini" (and its + localized variants). This will be in the language specified in the + request if available. + $ref: '#/components/schemas/GoogleTypeLocalizedText' + GoogleMapsPlacesV1RoutingSummary: + id: GoogleMapsPlacesV1RoutingSummary + description: >- + The duration and distance from the routing origin to a place in the + response, and a second leg from that place to the destination, if + requested. **Note:** Adding `routingSummaries` in the field mask without + also including either the `routingParameters.origin` parameter or the + `searchAlongRouteParameters.polyline.encodedPolyline` parameter in the + request causes an error. + type: object + properties: + legs: description: >- - Number of connectors in this aggregation that are currently out of - service. - availableCount: + The legs of the trip. When you calculate travel duration and + distance from a set origin, `legs` contains a single leg containing + the duration and distance from the origin to the destination. When + you do a search along route, `legs` contains two legs: one from the + origin to place, and one from the place to the destination. + type: array + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1RoutingSummaryLeg' + directionsUri: description: >- - Number of connectors in this aggregation that are currently - available. + A link to show directions on Google Maps using the waypoints from + the given routing summary. The route generated by this link is not + guaranteed to be the same as the route used to generate the routing + summary. The link uses information provided in the request, from + fields including `routingParameters` and + `searchAlongRouteParameters` when applicable, to generate the + directions link. + type: string + GoogleMapsPlacesV1RoutingSummaryLeg: + id: GoogleMapsPlacesV1RoutingSummaryLeg + description: A leg is a single portion of a journey from one location to another. + type: object + properties: + duration: + description: The time it takes to complete this leg of the trip. + type: string + format: google-duration + distanceMeters: + description: The distance of this leg of the trip. type: integer format: int32 GoogleMapsPlacesV1SearchTextRequest: + id: GoogleMapsPlacesV1SearchTextRequest description: 'Request proto for SearchText. ' + type: object properties: + textQuery: + description: Required. The text query for textual search. + type: string languageCode: description: >- Place details will be displayed with the preferred language if @@ -1570,14 +1844,45 @@ components: English if such details exist. Current list of supported languages: https://developers.google.com/maps/faq#languagesupport. type: string - textQuery: + regionCode: + description: >- + The Unicode country/region code (CLDR) of the location where the + request is coming from. This parameter is used to display the place + details, like region-specific place name, if available. The + parameter can affect results based on applicable law. For more + information, see + https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html. + Note that 3-digit region codes are not currently supported. type: string - description: Required. The text query for textual search. - routingParameters: - $ref: '#/components/schemas/GoogleMapsPlacesV1RoutingParameters' - description: Optional. Additional parameters for routing to results. + rankPreference: + description: How results will be ranked in the response. + type: string + enumDescriptions: + - >- + For a categorical query such as "Restaurants in New York City", + RELEVANCE is the default. For non-categorical queries such as + "Mountain View, CA" we recommend that you leave rankPreference + unset. + - Ranks results by distance. + - >- + Ranks results by relevance. Sort order determined by normal + ranking stack. + enum: + - RANK_PREFERENCE_UNSPECIFIED + - DISTANCE + - RELEVANCE + includedType: + description: >- + The requested place type. Full list of types supported: + https://developers.google.com/maps/documentation/places/web-service/place-types. + Only support one included type. + type: string + openNow: + description: >- + Used to restrict the search to places that are currently open. The + default is false. + type: boolean minRating: - type: number description: >- Filter out results whose average user rating is strictly less than this limit. A valid value must be a float between 0 and 5 @@ -1585,14 +1890,34 @@ components: inclusively. The input rating will round up to the nearest 0.5(ceiling). For instance, a rating of 0.6 will eliminate all results with a less than 1.0 rating. + type: number format: double - locationRestriction: + maxResultCount: description: >- - The region to search. This location serves as a restriction which - means results outside given location will not be returned. Cannot be - set along with location_bias. - $ref: >- - #/components/schemas/GoogleMapsPlacesV1SearchTextRequestLocationRestriction + Deprecated: Use `page_size` instead. The maximum number of results + per page that can be returned. If the number of available results is + larger than `max_result_count`, a `next_page_token` is returned + which can be passed to `page_token` to get the next page of results + in subsequent requests. If 0 or no value is provided, a default of + 20 is used. The maximum value is 20; values above 20 will be coerced + to 20. Negative values will return an INVALID_ARGUMENT error. If + both `max_result_count` and `page_size` are specified, + `max_result_count` will be ignored. + deprecated: true + type: integer + format: int32 + pageSize: + description: >- + Optional. The maximum number of results per page that can be + returned. If the number of available results is larger than + `page_size`, a `next_page_token` is returned which can be passed to + `page_token` to get the next page of results in subsequent requests. + If 0 or no value is provided, a default of 20 is used. The maximum + value is 20; values above 20 will be set to 20. Negative values will + return an INVALID_ARGUMENT error. If both `max_result_count` and + `page_size` are specified, `max_result_count` will be ignored. + type: integer + format: int32 pageToken: description: >- Optional. A page token, received from a previous TextSearch call. @@ -1602,22 +1927,13 @@ components: call that provided the page token. Otherwise an INVALID_ARGUMENT error is returned. type: string - evOptions: - $ref: '#/components/schemas/GoogleMapsPlacesV1SearchTextRequestEVOptions' - description: Optional. Set the searchable EV options of a place search request. priceLevels: description: >- Used to restrict the search to places that are marked as certain price levels. Users can choose any combinations of price levels. Default to select all price levels. + type: array items: - enum: - - PRICE_LEVEL_UNSPECIFIED - - PRICE_LEVEL_FREE - - PRICE_LEVEL_INEXPENSIVE - - PRICE_LEVEL_MODERATE - - PRICE_LEVEL_EXPENSIVE - - PRICE_LEVEL_VERY_EXPENSIVE type: string enumDescriptions: - Place price level is unspecified or unknown. @@ -1626,187 +1942,146 @@ components: - Place provides moderately priced services. - Place provides expensive services. - Place provides very expensive services. - type: array - openNow: + enum: + - PRICE_LEVEL_UNSPECIFIED + - PRICE_LEVEL_FREE + - PRICE_LEVEL_INEXPENSIVE + - PRICE_LEVEL_MODERATE + - PRICE_LEVEL_EXPENSIVE + - PRICE_LEVEL_VERY_EXPENSIVE + strictTypeFiltering: description: >- - Used to restrict the search to places that are currently open. The - default is false. + Used to set strict type filtering for included_type. If set to true, + only results of the same type will be returned. Default to false. type: boolean - includedType: - description: >- - The requested place type. Full list of types supported: - https://developers.google.com/maps/documentation/places/web-service/place-types. - Only support one included type. - type: string locationBias: description: >- The region to search. This location serves as a bias which means results around given location might be returned. Cannot be set along with location_restriction. $ref: '#/components/schemas/GoogleMapsPlacesV1SearchTextRequestLocationBias' - strictTypeFiltering: - type: boolean - description: >- - Used to set strict type filtering for included_type. If set to true, - only results of the same type will be returned. Default to false. - regionCode: - description: >- - The Unicode country/region code (CLDR) of the location where the - request is coming from. This parameter is used to display the place - details, like region-specific place name, if available. The - parameter can affect results based on applicable law. For more - information, see - https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html. - Note that 3-digit region codes are not currently supported. - type: string - pageSize: - type: integer - format: int32 + locationRestriction: description: >- - Optional. The maximum number of results per page that can be - returned. If the number of available results is larger than - `page_size`, a `next_page_token` is returned which can be passed to - `page_token` to get the next page of results in subsequent requests. - If 0 or no value is provided, a default of 20 is used. The maximum - value is 20; values above 20 will be set to 20. Negative values will - return an INVALID_ARGUMENT error. If both `max_result_count` and - `page_size` are specified, `max_result_count` will be ignored. - rankPreference: - type: string - enum: - - RANK_PREFERENCE_UNSPECIFIED - - DISTANCE - - RELEVANCE - description: How results will be ranked in the response. - enumDescriptions: - - >- - For a categorical query such as "Restaurants in New York City", - RELEVANCE is the default. For non-categorical queries such as - "Mountain View, CA" we recommend that you leave rankPreference - unset. - - Ranks results by distance. - - >- - Ranks results by relevance. Sort order determined by normal - ranking stack. + The region to search. This location serves as a restriction which + means results outside given location will not be returned. Cannot be + set along with location_bias. + $ref: >- + #/components/schemas/GoogleMapsPlacesV1SearchTextRequestLocationRestriction + evOptions: + description: Optional. Set the searchable EV options of a place search request. + $ref: '#/components/schemas/GoogleMapsPlacesV1SearchTextRequestEVOptions' + routingParameters: + description: Optional. Additional parameters for routing to results. + $ref: '#/components/schemas/GoogleMapsPlacesV1RoutingParameters' searchAlongRouteParameters: + description: Optional. Additional parameters proto for searching along a route. $ref: >- #/components/schemas/GoogleMapsPlacesV1SearchTextRequestSearchAlongRouteParameters - description: Optional. Additional parameters proto for searching along a route. - maxResultCount: - description: >- - Deprecated: Use `page_size` instead. The maximum number of results - per page that can be returned. If the number of available results is - larger than `max_result_count`, a `next_page_token` is returned - which can be passed to `page_token` to get the next page of results - in subsequent requests. If 0 or no value is provided, a default of - 20 is used. The maximum value is 20; values above 20 will be coerced - to 20. Negative values will return an INVALID_ARGUMENT error. If - both `max_result_count` and `page_size` are specified, - `max_result_count` will be ignored. - type: integer - format: int32 - deprecated: true - id: GoogleMapsPlacesV1SearchTextRequest + includePureServiceAreaBusinesses: + description: >- + Optional. Include pure service area businesses if the field is set + to true. Pure service area business is a business that visits or + delivers to customers directly but does not serve customers at their + business address. For example, businesses like cleaning services or + plumbers. Those businesses do not have a physical address or + location on Google Maps. Places will not return fields including + `location`, `plus_code`, and other location related fields for these + businesses. + type: boolean + GoogleMapsPlacesV1SearchTextRequestLocationBias: + id: GoogleMapsPlacesV1SearchTextRequestLocationBias + description: >- + The region to search. This location serves as a bias which means results + around given location might be returned. type: object - GoogleMapsPlacesV1PlaceGenerativeSummary: properties: - description: - $ref: '#/components/schemas/GoogleTypeLocalizedText' - description: The detailed description of the place. - descriptionFlagContentUri: - description: A link where users can flag a problem with the description summary. - type: string - overview: - description: The overview of the place. - $ref: '#/components/schemas/GoogleTypeLocalizedText' - references: - description: References that are used to generate the summary description. - $ref: '#/components/schemas/GoogleMapsPlacesV1References' - overviewFlagContentUri: - description: A link where users can flag a problem with the overview summary. - type: string - description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. AI-generated summary of the place. + rectangle: + description: >- + A rectangle box defined by northeast and southwest corner. + `rectangle.high()` must be the northeast point of the rectangle + viewport. `rectangle.low()` must be the southwest point of the + rectangle viewport. `rectangle.low().latitude()` cannot be greater + than `rectangle.high().latitude()`. This will result in an empty + latitude range. A rectangle viewport cannot be wider than 180 + degrees. + $ref: '#/components/schemas/GoogleGeoTypeViewport' + circle: + description: A circle defined by center point and radius. + $ref: '#/components/schemas/GoogleMapsPlacesV1Circle' + GoogleMapsPlacesV1SearchTextRequestLocationRestriction: + id: GoogleMapsPlacesV1SearchTextRequestLocationRestriction + description: >- + The region to search. This location serves as a restriction which means + results outside given location will not be returned. type: object - id: GoogleMapsPlacesV1PlaceGenerativeSummary - GoogleMapsPlacesV1RoutingParameters: properties: - travelMode: - enumDescriptions: - - No travel mode specified. Defaults to `DRIVE`. - - Travel by passenger car. - - >- - Travel by bicycle. Not supported with - `search_along_route_parameters`. - - >- - Travel by walking. Not supported with - `search_along_route_parameters`. - - >- - Motorized two wheeled vehicles of all kinds such as scooters and - motorcycles. Note that this is distinct from the `BICYCLE` travel - mode which covers human-powered transport. Not supported with - `search_along_route_parameters`. Only supported in those countries - listed at [Countries and regions supported for two-wheeled - vehicles](https://developers.google.com/maps/documentation/routes/coverage-two-wheeled). - enum: - - TRAVEL_MODE_UNSPECIFIED - - DRIVE - - BICYCLE - - WALK - - TWO_WHEELER - type: string - description: Optional. The travel mode. - routeModifiers: - $ref: '#/components/schemas/GoogleMapsPlacesV1RouteModifiers' - description: Optional. The route modifiers. - origin: - $ref: '#/components/schemas/GoogleTypeLatLng' - description: >- - Optional. An explicit routing origin that overrides the origin - defined in the polyline. By default, the polyline origin is used. - routingPreference: - enumDescriptions: - - No routing preference specified. Default to `TRAFFIC_UNAWARE`. - - >- - Computes routes without taking live traffic conditions into - consideration. Suitable when traffic conditions don't matter or - are not applicable. Using this value produces the lowest latency. - Note: For `TravelMode` `DRIVE` and `TWO_WHEELER`, the route and - duration chosen are based on road network and average - time-independent traffic conditions, not current road conditions. - Consequently, routes may include roads that are temporarily - closed. Results for a given request may vary over time due to - changes in the road network, updated average traffic conditions, - and the distributed nature of the service. Results may also vary - between nearly-equivalent routes at any time or frequency. - - >- - Calculates routes taking live traffic conditions into - consideration. In contrast to `TRAFFIC_AWARE_OPTIMAL`, some - optimizations are applied to significantly reduce latency. - - >- - Calculates the routes taking live traffic conditions into - consideration, without applying most performance optimizations. - Using this value produces the highest latency. - type: string - enum: - - ROUTING_PREFERENCE_UNSPECIFIED - - TRAFFIC_UNAWARE - - TRAFFIC_AWARE - - TRAFFIC_AWARE_OPTIMAL + rectangle: description: >- - Optional. Specifies how to compute the routing summaries. The server - attempts to use the selected routing preference to compute the - route. The traffic aware routing preference is only available for - the `DRIVE` or `TWO_WHEELER` `travelMode`. - description: >- - Parameters to configure the routing calculations to the places in the - response, both along a route (where result ranking will be influenced) - and for calculating travel times on results. + A rectangle box defined by northeast and southwest corner. + `rectangle.high()` must be the northeast point of the rectangle + viewport. `rectangle.low()` must be the southwest point of the + rectangle viewport. `rectangle.low().latitude()` cannot be greater + than `rectangle.high().latitude()`. This will result in an empty + latitude range. A rectangle viewport cannot be wider than 180 + degrees. + $ref: '#/components/schemas/GoogleGeoTypeViewport' + GoogleMapsPlacesV1SearchTextRequestEVOptions: + id: GoogleMapsPlacesV1SearchTextRequestEVOptions + description: Searchable EV options of a place search request. type: object - id: GoogleMapsPlacesV1RoutingParameters + properties: + minimumChargingRateKw: + description: >- + Optional. Minimum required charging rate in kilowatts. A place with + a charging rate less than the specified rate is filtered out. + type: number + format: double + connectorTypes: + description: >- + Optional. The list of preferred EV connector types. A place that + does not support any of the listed connector types is filtered out. + type: array + items: + type: string + enumDescriptions: + - Unspecified connector. + - Other connector types. + - J1772 type 1 connector. + - IEC 62196 type 2 connector. Often referred to as MENNEKES. + - CHAdeMO type connector. + - >- + Combined Charging System (AC and DC). Based on SAE. Type-1 + J-1772 connector + - >- + Combined Charging System (AC and DC). Based on Type-2 Mennekes + connector + - >- + The generic TESLA connector. This is NACS in the North America + but can be non-NACS in other parts of the world (e.g. CCS Combo + 2 (CCS2) or GB/T). This value is less representative of an + actual connector type, and more represents the ability to charge + a Tesla brand vehicle at a Tesla owned charging station. + - >- + GB/T type corresponds to the GB/T standard in China. This type + covers all GB_T types. + - Unspecified wall outlet. + - >- + The North American Charging System (NACS), standardized as SAE + J3400. + enum: + - EV_CONNECTOR_TYPE_UNSPECIFIED + - EV_CONNECTOR_TYPE_OTHER + - EV_CONNECTOR_TYPE_J1772 + - EV_CONNECTOR_TYPE_TYPE_2 + - EV_CONNECTOR_TYPE_CHADEMO + - EV_CONNECTOR_TYPE_CCS_COMBO_1 + - EV_CONNECTOR_TYPE_CCS_COMBO_2 + - EV_CONNECTOR_TYPE_TESLA + - EV_CONNECTOR_TYPE_UNSPECIFIED_GB_T + - EV_CONNECTOR_TYPE_UNSPECIFIED_WALL_OUTLET + - EV_CONNECTOR_TYPE_NACS GoogleMapsPlacesV1SearchTextRequestSearchAlongRouteParameters: + id: GoogleMapsPlacesV1SearchTextRequestSearchAlongRouteParameters description: >- Specifies a precalculated polyline from the [Routes API](https://developers.google.com/maps/documentation/routes) defining @@ -1824,523 +2099,531 @@ components: type: object properties: polyline: - $ref: '#/components/schemas/GoogleMapsPlacesV1Polyline' description: Required. The route polyline. - id: GoogleMapsPlacesV1SearchTextRequestSearchAlongRouteParameters - GoogleMapsPlacesV1AutocompletePlacesRequest: - id: GoogleMapsPlacesV1AutocompletePlacesRequest - description: Request proto for AutocompletePlaces. - properties: - inputOffset: - description: >- - Optional. A zero-based Unicode character offset of `input` - indicating the cursor position in `input`. The cursor position may - influence what predictions are returned. If empty, defaults to the - length of `input`. - format: int32 - type: integer - includeQueryPredictions: - description: >- - Optional. If true, the response will include both Place and query - predictions. Otherwise the response will only return Place - predictions. - type: boolean - languageCode: - description: >- - Optional. The language in which to return results. Defaults to - en-US. The results may be in mixed languages if the language used in - `input` is different from `language_code` or if the returned Place - does not have a translation from the local language to - `language_code`. - type: string - sessionToken: - type: string - description: >- - Optional. A string which identifies an Autocomplete session for - billing purposes. Must be a URL and filename safe base64 string with - at most 36 ASCII characters in length. Otherwise an INVALID_ARGUMENT - error is returned. The session begins when the user starts typing a - query, and concludes when they select a place and a call to Place - Details or Address Validation is made. Each session can have - multiple queries, followed by one Place Details or Address - Validation request. The credentials used for each request within a - session must belong to the same Google Cloud Console project. Once a - session has concluded, the token is no longer valid; your app must - generate a fresh token for each session. If the `session_token` - parameter is omitted, or if you reuse a session token, the session - is charged as if no session token was provided (each request is - billed separately). We recommend the following guidelines: * Use - session tokens for all Place Autocomplete calls. * Generate a fresh - token for each session. Using a version 4 UUID is recommended. * - Ensure that the credentials used for all Place Autocomplete, Place - Details, and Address Validation requests within a session belong to - the same Cloud Console project. * Be sure to pass a unique session - token for each new session. Using the same token for more than one - session will result in each request being billed individually. - includedPrimaryTypes: - description: >- - Optional. Included primary Place type (for example, "restaurant" or - "gas_station") in Place Types - (https://developers.google.com/maps/documentation/places/web-service/place-types), - or only `(regions)`, or only `(cities)`. A Place is only returned if - its primary type is included in this list. Up to 5 values can be - specified. If no types are specified, all Place types are returned. - type: array - items: - type: string - locationBias: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesRequestLocationBias - description: >- - Optional. Bias results to a specified location. At most one of - `location_bias` or `location_restriction` should be set. If neither - are set, the results will be biased by IP address, meaning the IP - address will be mapped to an imprecise location and used as a - biasing signal. - includedRegionCodes: - description: >- - Optional. Only include results in the specified regions, specified - as up to 15 CLDR two-character region codes. An empty set will not - restrict the results. If both `location_restriction` and - `included_region_codes` are set, the results will be located in the - area of intersection. - items: - type: string - type: array - regionCode: - type: string - description: >- - Optional. The region code, specified as a CLDR two-character region - code. This affects address formatting, result ranking, and may - influence what results are returned. This does not restrict results - to the specified region. To restrict results to a region, use - `region_code_restriction`. - input: - description: Required. The text string on which to search. - type: string - locationRestriction: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesRequestLocationRestriction - description: >- - Optional. Restrict results to a specified location. At most one of - `location_bias` or `location_restriction` should be set. If neither - are set, the results will be biased by IP address, meaning the IP - address will be mapped to an imprecise location and used as a - biasing signal. - origin: - $ref: '#/components/schemas/GoogleTypeLatLng' - description: >- - Optional. The origin point from which to calculate geodesic distance - to the destination (returned as `distance_meters`). If this value is - omitted, geodesic distance will not be returned. - type: object - GoogleMapsPlacesV1AuthorAttribution: - id: GoogleMapsPlacesV1AuthorAttribution - description: Information about the author of the UGC data. Used in Photo, and Review. + $ref: '#/components/schemas/GoogleMapsPlacesV1Polyline' + GoogleMapsPlacesV1Polyline: + id: GoogleMapsPlacesV1Polyline + description: >- + A route polyline. Only supports an [encoded + polyline](https://developers.google.com/maps/documentation/utilities/polylinealgorithm), + which can be passed as a string and includes compression with minimal + lossiness. This is the Routes API default output. + type: object properties: - uri: - type: string - description: URI of the author of the Photo or Review. - photoUri: - type: string - description: Profile photo URI of the author of the Photo or Review. - displayName: + encodedPolyline: + description: >- + An [encoded + polyline](https://developers.google.com/maps/documentation/utilities/polylinealgorithm), + as returned by the [Routes API by + default](https://developers.google.com/maps/documentation/routes/reference/rest/v2/TopLevel/computeRoutes#polylineencoding). + See the + [encoder](https://developers.google.com/maps/documentation/utilities/polylineutility) + and + [decoder](https://developers.google.com/maps/documentation/routes/polylinedecoder) + tools. type: string - description: Name of the author of the Photo or Review. - type: object - GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionQueryPrediction: + GoogleMapsPlacesV1SearchTextResponse: + id: GoogleMapsPlacesV1SearchTextResponse + description: 'Response proto for SearchText. ' type: object properties: - text: + places: + description: A list of places that meet the user's text search criteria. + type: array + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1Place' + routingSummaries: description: >- - The predicted text. This text does not represent a Place, but rather - a text query that could be used in a search endpoint (for example, - Text Search). `text` is recommended for developers who wish to show - a single UI element. Developers who wish to show two separate, but - related, UI elements may want to use `structured_format` instead. - They are two different ways to represent a query prediction. Users - should not try to parse `structured_format` into `text` or vice - versa. May be in mixed languages if the request `input` and - `language_code` are in different languages or if part of the query - does not have a translation from the local language to - `language_code`. - $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText - structuredFormat: + A list of routing summaries where each entry associates to the + corresponding place in the same index in the `places` field. If the + routing summary is not available for one of the places, it will + contain an empty entry. This list will have as many entries as the + list of places if requested. + type: array + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1RoutingSummary' + contextualContents: description: >- - A breakdown of the query prediction into main text containing the - query and secondary text containing additional disambiguating - features (such as a city or region). `structured_format` is - recommended for developers who wish to show two separate, but - related, UI elements. Developers who wish to show a single UI - element may want to use `text` instead. They are two different ways - to represent a query prediction. Users should not try to parse - `structured_format` into `text` or vice versa. - $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStructuredFormat - description: Prediction results for a Query Autocomplete prediction. - id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionQueryPrediction - GoogleMapsPlacesV1AddressDescriptor: + Experimental: See + https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative + for more details. A list of contextual contents where each entry + associates to the corresponding place in the same index in the + places field. The contents that are relevant to the `text_query` in + the request are preferred. If the contextual content is not + available for one of the places, it will return non-contextual + content. It will be empty only when the content is unavailable for + this place. This list will have as many entries as the list of + places if requested. + type: array + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1ContextualContent' + nextPageToken: + description: >- + A token that can be sent as `page_token` to retrieve the next page. + If this field is omitted or empty, there are no subsequent pages. + type: string + searchUri: + description: >- + A link allows the user to search with the same text query as + specified in the request on Google Maps. + type: string + GoogleMapsPlacesV1ContextualContent: + id: GoogleMapsPlacesV1ContextualContent + description: >- + Experimental: See + https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative + for more details. Content that is contextual to the place query. type: object - id: GoogleMapsPlacesV1AddressDescriptor properties: - areas: - description: >- - A ranked list of containing or adjacent areas. The most recognizable - and precise areas are ranked first. + reviews: + description: List of reviews about this place, contexual to the place query. + type: array items: - $ref: '#/components/schemas/GoogleMapsPlacesV1AddressDescriptorArea' + $ref: '#/components/schemas/GoogleMapsPlacesV1Review' + photos: + description: >- + Information (including references) about photos of this place, + contexual to the place query. type: array - landmarks: items: - $ref: '#/components/schemas/GoogleMapsPlacesV1AddressDescriptorLandmark' + $ref: '#/components/schemas/GoogleMapsPlacesV1Photo' + justifications: description: >- - A ranked list of nearby landmarks. The most recognizable and nearby - landmarks are ranked first. + Experimental: See + https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative + for more details. Justifications for the place. type: array + items: + $ref: >- + #/components/schemas/GoogleMapsPlacesV1ContextualContentJustification + GoogleMapsPlacesV1ContextualContentJustification: + id: GoogleMapsPlacesV1ContextualContentJustification description: >- - A relational description of a location. Includes a ranked set of nearby - landmarks and precise containing areas and their relationship to the - target location. - GoogleMapsPlacesV1PlacePaymentOptions: - id: GoogleMapsPlacesV1PlacePaymentOptions + Experimental: See + https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative + for more details. Justifications for the place. Justifications answers + the question of why a place could interest an end user. + type: object properties: - acceptsCashOnly: - type: boolean + reviewJustification: description: >- - Place accepts cash only as payment. Places with this attribute may - still accept other payment methods. - acceptsNfc: - type: boolean - description: Place accepts NFC payments. - acceptsDebitCards: - type: boolean - description: Place accepts debit cards as payment. - acceptsCreditCards: - type: boolean - description: Place accepts credit cards as payment. - description: Payment options the place accepts. + Experimental: See + https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative + for more details. + $ref: >- + #/components/schemas/GoogleMapsPlacesV1ContextualContentJustificationReviewJustification + businessAvailabilityAttributesJustification: + description: >- + Experimental: See + https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative + for more details. + $ref: >- + #/components/schemas/GoogleMapsPlacesV1ContextualContentJustificationBusinessAvailabilityAttributesJustification + GoogleMapsPlacesV1ContextualContentJustificationReviewJustification: + id: GoogleMapsPlacesV1ContextualContentJustificationReviewJustification + description: >- + Experimental: See + https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative + for more details. User review justifications. This highlights a section + of the user review that would interest an end user. For instance, if the + search query is "firewood pizza", the review justification highlights + the text relevant to the search query. type: object - GoogleMapsPlacesV1ContentBlock: - id: GoogleMapsPlacesV1ContentBlock + properties: + highlightedText: + $ref: >- + #/components/schemas/GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedText + review: + description: The review that the highlighted text is generated from. + $ref: '#/components/schemas/GoogleMapsPlacesV1Review' + GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedText: + id: >- + GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedText + description: >- + The text highlighted by the justification. This is a subset of the + review itself. The exact word to highlight is marked by the + HighlightedTextRange. There could be several words in the text being + highlighted. type: object - description: A block of content that can be served individually. properties: - topic: + text: type: string - description: The topic of the content, for example "overview" or "restaurant". - content: - description: Content related to the topic. - $ref: '#/components/schemas/GoogleTypeLocalizedText' - references: - description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. References that are related to this block of - content. - $ref: '#/components/schemas/GoogleMapsPlacesV1References' + highlightedTextRanges: + description: The list of the ranges of the highlighted text. + type: array + items: + $ref: >- + #/components/schemas/GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedTextHighlightedTextRange + GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedTextHighlightedTextRange: + id: >- + GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedTextHighlightedTextRange + description: The range of highlighted text. + type: object + properties: + startIndex: + type: integer + format: int32 + endIndex: + type: integer + format: int32 GoogleMapsPlacesV1ContextualContentJustificationBusinessAvailabilityAttributesJustification: id: >- GoogleMapsPlacesV1ContextualContentJustificationBusinessAvailabilityAttributesJustification + description: >- + Experimental: See + https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative + for more details. BusinessAvailabilityAttributes justifications. This + shows some attributes a business has that could interest an end user. type: object properties: + takeout: + description: If a place provides takeout. + type: boolean delivery: description: If a place provides delivery. type: boolean - takeout: - type: boolean - description: If a place provides takeout. dineIn: - type: boolean description: If a place provides dine-in. - description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. BusinessAvailabilityAttributes justifications. This - shows some attributes a business has that could interest an end user. - GoogleMapsPlacesV1SearchTextResponse: - description: 'Response proto for SearchText. ' + type: boolean + GoogleMapsPlacesV1PhotoMedia: + id: GoogleMapsPlacesV1PhotoMedia + description: A photo media from Places API. type: object properties: - searchUri: + name: description: >- - A link allows the user to search with the same text query as - specified in the request on Google Maps. + The resource name of a photo media in the format: + `places/{place_id}/photos/{photo_reference}/media`. type: string - nextPageToken: + photoUri: + description: A short-lived uri that can be used to render the photo. + type: string + GoogleMapsPlacesV1AutocompletePlacesRequest: + id: GoogleMapsPlacesV1AutocompletePlacesRequest + description: Request proto for AutocompletePlaces. + type: object + properties: + input: + description: Required. The text string on which to search. type: string + locationBias: description: >- - A token that can be sent as `page_token` to retrieve the next page. - If this field is omitted or empty, there are no subsequent pages. - routingSummaries: + Optional. Bias results to a specified location. At most one of + `location_bias` or `location_restriction` should be set. If neither + are set, the results will be biased by IP address, meaning the IP + address will be mapped to an imprecise location and used as a + biasing signal. + $ref: >- + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesRequestLocationBias + locationRestriction: description: >- - A list of routing summaries where each entry associates to the - corresponding place in the same index in the `places` field. If the - routing summary is not available for one of the places, it will - contain an empty entry. This list will have as many entries as the - list of places if requested. - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1RoutingSummary' - type: array - contextualContents: + Optional. Restrict results to a specified location. At most one of + `location_bias` or `location_restriction` should be set. If neither + are set, the results will be biased by IP address, meaning the IP + address will be mapped to an imprecise location and used as a + biasing signal. + $ref: >- + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesRequestLocationRestriction + includedPrimaryTypes: description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. A list of contextual contents where each entry - associates to the corresponding place in the same index in the - places field. The contents that are relevant to the `text_query` in - the request are preferred. If the contextual content is not - available for one of the places, it will return non-contextual - content. It will be empty only when the content is unavailable for - this place. This list will have as many entries as the list of - places if requested. + Optional. Included primary Place type (for example, "restaurant" or + "gas_station") in Place Types + (https://developers.google.com/maps/documentation/places/web-service/place-types), + or only `(regions)`, or only `(cities)`. A Place is only returned if + its primary type is included in this list. Up to 5 values can be + specified. If no types are specified, all Place types are returned. type: array items: - $ref: '#/components/schemas/GoogleMapsPlacesV1ContextualContent' - places: - description: A list of places that meet the user's text search criteria. + type: string + includedRegionCodes: + description: >- + Optional. Only include results in the specified regions, specified + as up to 15 CLDR two-character region codes. An empty set will not + restrict the results. If both `location_restriction` and + `included_region_codes` are set, the results will be located in the + area of intersection. type: array items: - $ref: '#/components/schemas/GoogleMapsPlacesV1Place' - id: GoogleMapsPlacesV1SearchTextResponse - GoogleMapsPlacesV1Polyline: - type: object - description: >- - A route polyline. Only supports an [encoded - polyline](https://developers.google.com/maps/documentation/utilities/polylinealgorithm), - which can be passed as a string and includes compression with minimal - lossiness. This is the Routes API default output. - properties: - encodedPolyline: + type: string + languageCode: + description: >- + Optional. The language in which to return results. Defaults to + en-US. The results may be in mixed languages if the language used in + `input` is different from `language_code` or if the returned Place + does not have a translation from the local language to + `language_code`. type: string + regionCode: description: >- - An [encoded - polyline](https://developers.google.com/maps/documentation/utilities/polylinealgorithm), - as returned by the [Routes API by - default](https://developers.google.com/maps/documentation/routes/reference/rest/v2/TopLevel/computeRoutes#polylineencoding). - See the - [encoder](https://developers.google.com/maps/documentation/utilities/polylineutility) - and - [decoder](https://developers.google.com/maps/documentation/routes/polylinedecoder) - tools. - id: GoogleMapsPlacesV1Polyline - GoogleMapsPlacesV1RouteModifiers: - id: GoogleMapsPlacesV1RouteModifiers - properties: - avoidIndoor: - type: boolean + Optional. The region code, specified as a CLDR two-character region + code. This affects address formatting, result ranking, and may + influence what results are returned. This does not restrict results + to the specified region. To restrict results to a region, use + `region_code_restriction`. + type: string + origin: description: >- - Optional. When set to true, avoids navigating indoors where - reasonable, giving preference to routes not containing indoor - navigation. Applies only to the `WALK` `TravelMode`. - avoidFerries: + Optional. The origin point from which to calculate geodesic distance + to the destination (returned as `distance_meters`). If this value is + omitted, geodesic distance will not be returned. + $ref: '#/components/schemas/GoogleTypeLatLng' + inputOffset: description: >- - Optional. When set to true, avoids ferries where reasonable, giving - preference to routes not containing ferries. Applies only to the - `DRIVE` and `TWO_WHEELER` `TravelMode`. - type: boolean - avoidHighways: - type: boolean + Optional. A zero-based Unicode character offset of `input` + indicating the cursor position in `input`. The cursor position may + influence what predictions are returned. If empty, defaults to the + length of `input`. + type: integer + format: int32 + includeQueryPredictions: description: >- - Optional. When set to true, avoids highways where reasonable, giving - preference to routes not containing highways. Applies only to the - `DRIVE` and `TWO_WHEELER` `TravelMode`. - avoidTolls: + Optional. If true, the response will include both Place and query + predictions. Otherwise the response will only return Place + predictions. type: boolean + sessionToken: description: >- - Optional. When set to true, avoids toll roads where reasonable, - giving preference to routes not containing toll roads. Applies only - to the `DRIVE` and `TWO_WHEELER` `TravelMode`. + Optional. A string which identifies an Autocomplete session for + billing purposes. Must be a URL and filename safe base64 string with + at most 36 ASCII characters in length. Otherwise an INVALID_ARGUMENT + error is returned. The session begins when the user starts typing a + query, and concludes when they select a place and a call to Place + Details or Address Validation is made. Each session can have + multiple queries, followed by one Place Details or Address + Validation request. The credentials used for each request within a + session must belong to the same Google Cloud Console project. Once a + session has concluded, the token is no longer valid; your app must + generate a fresh token for each session. If the `session_token` + parameter is omitted, or if you reuse a session token, the session + is charged as if no session token was provided (each request is + billed separately). We recommend the following guidelines: * Use + session tokens for all Place Autocomplete calls. * Generate a fresh + token for each session. Using a version 4 UUID is recommended. * + Ensure that the credentials used for all Place Autocomplete, Place + Details, and Address Validation requests within a session belong to + the same Cloud Console project. * Be sure to pass a unique session + token for each new session. Using the same token for more than one + session will result in each request being billed individually. + type: string + includePureServiceAreaBusinesses: + description: >- + Optional. Include pure service area businesses if the field is set + to true. Pure service area business is a business that visits or + delivers to customers directly but does not serve customers at their + business address. For example, businesses like cleaning services or + plumbers. Those businesses do not have a physical address or + location on Google Maps. Places will not return fields including + `location`, `plus_code`, and other location related fields for these + businesses. + type: boolean + GoogleMapsPlacesV1AutocompletePlacesRequestLocationBias: + id: GoogleMapsPlacesV1AutocompletePlacesRequestLocationBias description: >- - Encapsulates a set of optional conditions to satisfy when calculating - the routes. + The region to search. The results may be biased around the specified + region. type: object - GoogleMapsPlacesV1RoutingSummary: - id: GoogleMapsPlacesV1RoutingSummary + properties: + rectangle: + description: A viewport defined by a northeast and a southwest corner. + $ref: '#/components/schemas/GoogleGeoTypeViewport' + circle: + description: A circle defined by a center point and radius. + $ref: '#/components/schemas/GoogleMapsPlacesV1Circle' + GoogleMapsPlacesV1AutocompletePlacesRequestLocationRestriction: + id: GoogleMapsPlacesV1AutocompletePlacesRequestLocationRestriction description: >- - The duration and distance from the routing origin to a place in the - response, and a second leg from that place to the destination, if - requested. **Note:** Adding `routingSummaries` in the field mask without - also including either the `routingParameters.origin` parameter or the - `searchAlongRouteParameters.polyline.encodedPolyline` parameter in the - request causes an error. + The region to search. The results will be restricted to the specified + region. + type: object properties: - directionsUri: - type: string - description: >- - A link to show directions on Google Maps using the waypoints from - the given routing summary. The route generated by this link is not - guaranteed to be the same as the route used to generate the routing - summary. The link uses information provided in the request, from - fields including `routingParameters` and - `searchAlongRouteParameters` when applicable, to generate the - directions link. - legs: - type: array - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1RoutingSummaryLeg' - description: >- - The legs of the trip. When you calculate travel duration and - distance from a set origin, `legs` contains a single leg containing - the duration and distance from the origin to the destination. When - you do a search along route, `legs` contains two legs: one from the - origin to place, and one from the place to the destination. + rectangle: + description: A viewport defined by a northeast and a southwest corner. + $ref: '#/components/schemas/GoogleGeoTypeViewport' + circle: + description: A circle defined by a center point and radius. + $ref: '#/components/schemas/GoogleMapsPlacesV1Circle' + GoogleMapsPlacesV1AutocompletePlacesResponse: + id: GoogleMapsPlacesV1AutocompletePlacesResponse + description: Response proto for AutocompletePlaces. type: object - GoogleMapsPlacesV1FuelOptions: properties: - fuelPrices: - type: array + suggestions: description: >- - The last known fuel price for each type of fuel this station has. - There is one entry per fuel type this station has. Order is not - important. + Contains a list of suggestions, ordered in descending order of + relevance. + type: array items: - $ref: '#/components/schemas/GoogleMapsPlacesV1FuelOptionsFuelPrice' + $ref: >- + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestion + GoogleMapsPlacesV1AutocompletePlacesResponseSuggestion: + id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestion + description: An Autocomplete suggestion result. type: object - description: >- - The most recent information about fuel options in a gas station. This - information is updated regularly. - id: GoogleMapsPlacesV1FuelOptions - GoogleMapsPlacesV1SearchNearbyRequest: properties: - excludedPrimaryTypes: - description: >- - Excluded primary Place type (e.g. "restaurant" or "gas_station") - from - https://developers.google.com/maps/documentation/places/web-service/place-types. - Up to 50 types from [Table - A](https://developers.google.com/maps/documentation/places/web-service/place-types#table-a) - may be specified. If there are any conflicting primary types, i.e. a - type appears in both included_primary_types and - excluded_primary_types, an INVALID_ARGUMENT error is returned. If a - Place type is specified with multiple type restrictions, only places - that satisfy all of the restrictions are returned. For example, if - we have {included_types = ["restaurant"], excluded_primary_types = - ["restaurant"]}, the returned places provide "restaurant" related - services but do not operate primarily as "restaurants". - items: - type: string - type: array - locationRestriction: - description: Required. The region to search. + placePrediction: + description: A prediction for a Place. + $ref: >- + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionPlacePrediction + queryPrediction: + description: A prediction for a query. $ref: >- - #/components/schemas/GoogleMapsPlacesV1SearchNearbyRequestLocationRestriction - languageCode: - type: string + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionQueryPrediction + GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionPlacePrediction: + id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionPlacePrediction + description: Prediction results for a Place Autocomplete prediction. + type: object + properties: + place: description: >- - Place details will be displayed with the preferred language if - available. If the language code is unspecified or unrecognized, - place details of any language may be returned, with a preference for - English if such details exist. Current list of supported languages: - https://developers.google.com/maps/faq#languagesupport. - routingParameters: - $ref: '#/components/schemas/GoogleMapsPlacesV1RoutingParameters' - description: Optional. Parameters that affect the routing to the search results. - maxResultCount: - format: int32 + The resource name of the suggested Place. This name can be used in + other APIs that accept Place names. + type: string + placeId: description: >- - Maximum number of results to return. It must be between 1 and 20 - (default), inclusively. If the number is unset, it falls back to the - upper limit. If the number is set to negative or exceeds the upper - limit, an INVALID_ARGUMENT error is returned. - type: integer - rankPreference: + The unique identifier of the suggested Place. This identifier can be + used in other APIs that accept Place IDs. type: string - enum: - - RANK_PREFERENCE_UNSPECIFIED - - DISTANCE - - POPULARITY - enumDescriptions: - - >- - RankPreference value not set. Will use rank by POPULARITY by - default. - - Ranks results by distance. - - Ranks results by popularity. - description: How results will be ranked in the response. - includedPrimaryTypes: + text: description: >- - Included primary Place type (e.g. "restaurant" or "gas_station") - from - https://developers.google.com/maps/documentation/places/web-service/place-types. - A place can only have a single primary type from the supported types - table associated with it. Up to 50 types from [Table - A](https://developers.google.com/maps/documentation/places/web-service/place-types#table-a) - may be specified. If there are any conflicting primary types, i.e. a - type appears in both included_primary_types and - excluded_primary_types, an INVALID_ARGUMENT error is returned. If a - Place type is specified with multiple type restrictions, only places - that satisfy all of the restrictions are returned. For example, if - we have {included_types = ["restaurant"], excluded_primary_types = - ["restaurant"]}, the returned places provide "restaurant" related - services but do not operate primarily as "restaurants". - type: array - items: - type: string - includedTypes: + Contains the human-readable name for the returned result. For + establishment results, this is usually the business name and + address. `text` is recommended for developers who wish to show a + single UI element. Developers who wish to show two separate, but + related, UI elements may want to use `structured_format` instead. + They are two different ways to represent a Place prediction. Users + should not try to parse `structured_format` into `text` or vice + versa. This text may be different from the `display_name` returned + by GetPlace. May be in mixed languages if the request `input` and + `language_code` are in different languages or if the Place does not + have a translation from the local language to `language_code`. + $ref: >- + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText + structuredFormat: description: >- - Included Place type (eg, "restaurant" or "gas_station") from + A breakdown of the Place prediction into main text containing the + name of the Place and secondary text containing additional + disambiguating features (such as a city or region). + `structured_format` is recommended for developers who wish to show + two separate, but related, UI elements. Developers who wish to show + a single UI element may want to use `text` instead. They are two + different ways to represent a Place prediction. Users should not try + to parse `structured_format` into `text` or vice versa. + $ref: >- + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStructuredFormat + types: + description: >- + List of types that apply to this Place from Table A or Table B in https://developers.google.com/maps/documentation/places/web-service/place-types. - Up to 50 types from [Table - A](https://developers.google.com/maps/documentation/places/web-service/place-types#table-a) - may be specified. If there are any conflicting types, i.e. a type - appears in both included_types and excluded_types, an - INVALID_ARGUMENT error is returned. If a Place type is specified - with multiple type restrictions, only places that satisfy all of the - restrictions are returned. For example, if we have {included_types = - ["restaurant"], excluded_primary_types = ["restaurant"]}, the - returned places provide "restaurant" related services but do not - operate primarily as "restaurants". - items: - type: string - type: array - excludedTypes: + A type is a categorization of a Place. Places with shared types will + share similar characteristics. type: array items: type: string + distanceMeters: description: >- - Excluded Place type (eg, "restaurant" or "gas_station") from - https://developers.google.com/maps/documentation/places/web-service/place-types. - Up to 50 types from [Table - A](https://developers.google.com/maps/documentation/places/web-service/place-types#table-a) - may be specified. If the client provides both included_types (e.g. - restaurant) and excluded_types (e.g. cafe), then the response should - include places that are restaurant but not cafe. The response - includes places that match at least one of the included_types and - none of the excluded_types. If there are any conflicting types, i.e. - a type appears in both included_types and excluded_types, an - INVALID_ARGUMENT error is returned. If a Place type is specified - with multiple type restrictions, only places that satisfy all of the - restrictions are returned. For example, if we have {included_types = - ["restaurant"], excluded_primary_types = ["restaurant"]}, the - returned places provide "restaurant" related services but do not - operate primarily as "restaurants". - regionCode: - description: >- - The Unicode country/region code (CLDR) of the location where the - request is coming from. This parameter is used to display the place - details, like region-specific place name, if available. The - parameter can affect results based on applicable law. For more - information, see - https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html. - Note that 3-digit region codes are not currently supported. - type: string + The length of the geodesic in meters from `origin` if `origin` is + specified. Certain predictions such as routes may not populate this + field. + type: integer + format: int32 + GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText: + id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText + description: >- + Text representing a Place or query prediction. The text may be used as + is or formatted. type: object - description: 'Request proto for Search Nearby. ' - id: GoogleMapsPlacesV1SearchNearbyRequest - GoogleMapsPlacesV1RoutingSummaryLeg: - id: GoogleMapsPlacesV1RoutingSummaryLeg + properties: + text: + description: Text that may be used as is or formatted with `matches`. + type: string + matches: + description: >- + A list of string ranges identifying where the input request matched + in `text`. The ranges can be used to format specific parts of + `text`. The substrings may not be exact matches of `input` if the + matching was determined by criteria other than string matching (for + example, spell corrections or transliterations). These values are + Unicode character offsets of `text`. The ranges are guaranteed to be + ordered in increasing offset values. + type: array + items: + $ref: >- + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStringRange + GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStringRange: + id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStringRange + description: Identifies a substring within a given text. type: object properties: - distanceMeters: + startOffset: + description: >- + Zero-based offset of the first Unicode character of the string + (inclusive). type: integer format: int32 - description: The distance of this leg of the trip. - duration: - format: google-duration - description: The time it takes to complete this leg of the trip. - type: string - description: A leg is a single portion of a journey from one location to another. + endOffset: + description: Zero-based offset of the last Unicode character (exclusive). + type: integer + format: int32 + GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStructuredFormat: + id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStructuredFormat + description: >- + Contains a breakdown of a Place or query prediction into main text and + secondary text. For Place predictions, the main text contains the + specific name of the Place. For query predictions, the main text + contains the query. The secondary text contains additional + disambiguating features (such as a city or region) to further identify + the Place or refine the query. + type: object + properties: + mainText: + description: Represents the name of the Place or query. + $ref: >- + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText + secondaryText: + description: >- + Represents additional disambiguating features (such as a city or + region) to further identify the Place or refine the query. + $ref: >- + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText + GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionQueryPrediction: + id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionQueryPrediction + description: Prediction results for a Query Autocomplete prediction. + type: object + properties: + text: + description: >- + The predicted text. This text does not represent a Place, but rather + a text query that could be used in a search endpoint (for example, + Text Search). `text` is recommended for developers who wish to show + a single UI element. Developers who wish to show two separate, but + related, UI elements may want to use `structured_format` instead. + They are two different ways to represent a query prediction. Users + should not try to parse `structured_format` into `text` or vice + versa. May be in mixed languages if the request `input` and + `language_code` are in different languages or if part of the query + does not have a translation from the local language to + `language_code`. + $ref: >- + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText + structuredFormat: + description: >- + A breakdown of the query prediction into main text containing the + query and secondary text containing additional disambiguating + features (such as a city or region). `structured_format` is + recommended for developers who wish to show two separate, but + related, UI elements. Developers who wish to show a single UI + element may want to use `text` instead. They are two different ways + to represent a query prediction. Users should not try to parse + `structured_format` into `text` or vice versa. + $ref: >- + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStructuredFormat parameters: + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string alt: description: Data format for response. in: query @@ -2351,31 +2634,46 @@ components: - json - media - proto - quotaUser: + 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: >- - 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. + 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: quotaUser + name: key schema: type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: uploadType + name: oauth_token schema: type: string - fields: - description: Selector specifying which fields to include in a partial response. + prettyPrint: + description: Returns response with indentations and line breaks. in: query - name: fields + name: prettyPrint schema: - type: string - callback: - description: JSONP + 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: callback + name: quotaUser schema: type: string upload_protocol: @@ -2384,10 +2682,10 @@ components: name: upload_protocol schema: type: string - oauth_token: - description: OAuth 2.0 token for the current user. + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: oauth_token + name: uploadType schema: type: string _.xgafv: @@ -2399,99 +2697,83 @@ components: enum: - '1' - '2' - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean - access_token: - description: OAuth access token. - in: query - name: access_token - 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 x-stackQL-resources: - photos_media: - id: google.places.photos_media - name: photos_media - title: Photos_media - methods: - get_media: - operation: - $ref: '#/paths/~1v1~1places~1{placesId}~1photos~1{photosId}~1media/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/photos_media/methods/get_media' - insert: [] - update: [] - replace: [] - delete: [] places: id: google.places.places name: places title: Places methods: + search_nearby: + operation: + $ref: '#/paths/~1v1~1places:searchNearby/post' + response: + mediaType: application/json + openAPIDocKey: '200' search_text: operation: $ref: '#/paths/~1v1~1places:searchText/post' response: mediaType: application/json openAPIDocKey: '200' - autocomplete: + get: operation: - $ref: '#/paths/~1v1~1places:autocomplete/post' + $ref: '#/paths/~1v1~1places~1{placesId}/get' response: mediaType: application/json openAPIDocKey: '200' - search_nearby: + autocomplete: operation: - $ref: '#/paths/~1v1~1places:searchNearby/post' + $ref: '#/paths/~1v1~1places:autocomplete/post' response: mediaType: application/json openAPIDocKey: '200' - get: + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/places/methods/get' + insert: [] + update: [] + replace: [] + delete: [] + photos_media: + id: google.places.photos_media + name: photos_media + title: Photos_media + methods: + get_media: operation: - $ref: '#/paths/~1v1~1places~1{placesId}/get' + $ref: '#/paths/~1v1~1places~1{placesId}~1photos~1{photosId}~1media/get' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/places/methods/get' + - $ref: '#/components/x-stackQL-resources/photos_media/methods/get_media' insert: [] update: [] replace: [] delete: [] paths: - /v1/places/{placesId}/photos/{photosId}/media: + /v1/places:searchNearby: parameters: &ref_1 + - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/key' - get: - description: Get a photo media with a photo reference string. - operationId: places.places.photos.getMedia + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' + post: + description: Search for places near locations. + operationId: places.places.searchNearby + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleMapsPlacesV1SearchNearbyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2502,41 +2784,17 @@ paths: Oauth2c: - https://www.googleapis.com/auth/maps-platform.places - Oauth2: - - https://www.googleapis.com/auth/maps-platform.places.getphotomedia + - https://www.googleapis.com/auth/maps-platform.places.nearbysearch Oauth2c: - - https://www.googleapis.com/auth/maps-platform.places.getphotomedia + - https://www.googleapis.com/auth/maps-platform.places.nearbysearch responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleMapsPlacesV1PhotoMedia' - parameters: - - in: path - name: placesId - required: true - schema: - type: string - - in: path - name: photosId - required: true - schema: - type: string - - in: query - name: maxWidthPx - schema: - type: integer - format: int32 - - in: query - name: maxHeightPx - schema: - type: integer - format: int32 - - in: query - name: skipHttpRedirect - schema: - type: boolean + $ref: '#/components/schemas/GoogleMapsPlacesV1SearchNearbyResponse' + parameters: [] /v1/places:searchText: parameters: *ref_1 post: @@ -2568,16 +2826,13 @@ paths: schema: $ref: '#/components/schemas/GoogleMapsPlacesV1SearchTextResponse' parameters: [] - /v1/places:autocomplete: + /v1/places/{placesId}: parameters: *ref_1 - post: - description: Returns predictions for the given input. - operationId: places.places.autocomplete - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleMapsPlacesV1AutocompletePlacesRequest' + get: + description: >- + Get the details of a place based on its resource name, which is a string + in the `places/{place_id}` format. + operationId: places.places.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2588,28 +2843,44 @@ paths: Oauth2c: - https://www.googleapis.com/auth/maps-platform.places - Oauth2: - - https://www.googleapis.com/auth/maps-platform.places.autocomplete + - https://www.googleapis.com/auth/maps-platform.places.details Oauth2c: - - https://www.googleapis.com/auth/maps-platform.places.autocomplete + - https://www.googleapis.com/auth/maps-platform.places.details responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponse - parameters: [] - /v1/places:searchNearby: + $ref: '#/components/schemas/GoogleMapsPlacesV1Place' + parameters: + - in: path + name: placesId + required: true + schema: + type: string + - in: query + name: languageCode + schema: + type: string + - in: query + name: regionCode + schema: + type: string + - in: query + name: sessionToken + schema: + type: string + /v1/places:autocomplete: parameters: *ref_1 post: - description: Search for places near locations. - operationId: places.places.searchNearby + description: Returns predictions for the given input. + operationId: places.places.autocomplete requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleMapsPlacesV1SearchNearbyRequest' + $ref: '#/components/schemas/GoogleMapsPlacesV1AutocompletePlacesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2620,24 +2891,23 @@ paths: Oauth2c: - https://www.googleapis.com/auth/maps-platform.places - Oauth2: - - https://www.googleapis.com/auth/maps-platform.places.nearbysearch + - https://www.googleapis.com/auth/maps-platform.places.autocomplete Oauth2c: - - https://www.googleapis.com/auth/maps-platform.places.nearbysearch + - https://www.googleapis.com/auth/maps-platform.places.autocomplete responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleMapsPlacesV1SearchNearbyResponse' + $ref: >- + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponse parameters: [] - /v1/places/{placesId}: + /v1/places/{placesId}/photos/{photosId}/media: parameters: *ref_1 get: - description: >- - Get the details of a place based on its resource name, which is a string - in the `places/{place_id}` format. - operationId: places.places.get + description: Get a photo media with a photo reference string. + operationId: places.places.photos.getMedia security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2648,31 +2918,38 @@ paths: Oauth2c: - https://www.googleapis.com/auth/maps-platform.places - Oauth2: - - https://www.googleapis.com/auth/maps-platform.places.details + - https://www.googleapis.com/auth/maps-platform.places.getphotomedia Oauth2c: - - https://www.googleapis.com/auth/maps-platform.places.details + - https://www.googleapis.com/auth/maps-platform.places.getphotomedia responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleMapsPlacesV1Place' + $ref: '#/components/schemas/GoogleMapsPlacesV1PhotoMedia' parameters: - in: path name: placesId required: true schema: type: string - - in: query - name: regionCode + - in: path + name: photosId + required: true schema: type: string - in: query - name: languageCode + name: maxWidthPx schema: - type: string + type: integer + format: int32 - in: query - name: sessionToken + name: maxHeightPx schema: - type: string + type: integer + format: int32 + - in: query + name: skipHttpRedirect + schema: + type: boolean diff --git a/providers/src/googleapis.com/v00.00.00000/services/policyanalyzer.yaml b/providers/src/googleapis.com/v00.00.00000/services/policyanalyzer.yaml index 220b6a3a..eb184bb8 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/policyanalyzer.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/policyanalyzer.yaml @@ -7,8 +7,8 @@ info: title: Policy Analyzer API description: '' version: v1 - x-discovery-doc-revision: '20241103' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250824' + x-generated-date: '2025-08-28' externalDocs: url: https://www.google.com servers: @@ -34,64 +34,70 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudPolicyanalyzerV1Activity: + GoogleCloudPolicyanalyzerV1QueryActivityResponse: + id: GoogleCloudPolicyanalyzerV1QueryActivityResponse + description: Response to the `QueryActivity` method. type: object - description: Represents Activity on a GCP resource over specific observation period. properties: - activityType: - description: The type of the activity. + activities: + description: The set of activities that match the filter included in the request. + type: array + items: + $ref: '#/components/schemas/GoogleCloudPolicyanalyzerV1Activity' + nextPageToken: + description: >- + If there might be more results than those appearing in this + response, then `nextPageToken` is included. To get the next set of + results, call this method again using the value of `nextPageToken` + as `pageToken`. type: string + GoogleCloudPolicyanalyzerV1Activity: + id: GoogleCloudPolicyanalyzerV1Activity + description: Represents Activity on a GCP resource over specific observation period. + type: object + properties: fullResourceName: description: >- The full resource name that identifies the resource. For examples of full resource names for Google Cloud services, see https://cloud.google.com/iam/help/troubleshooter/full-resource-names. type: string + activityType: + description: The type of the activity. + type: string + observationPeriod: + description: The data observation period to build the activity. + $ref: '#/components/schemas/GoogleCloudPolicyanalyzerV1ObservationPeriod' activity: + description: A struct of custom fields to explain the activity. type: object additionalProperties: - description: Properties of the object. type: any - description: A struct of custom fields to explain the activity. - observationPeriod: - description: The data observation period to build the activity. - $ref: '#/components/schemas/GoogleCloudPolicyanalyzerV1ObservationPeriod' - id: GoogleCloudPolicyanalyzerV1Activity + description: Properties of the object. GoogleCloudPolicyanalyzerV1ObservationPeriod: id: GoogleCloudPolicyanalyzerV1ObservationPeriod + description: Represents data observation period. + type: object properties: - endTime: - format: google-datetime - description: >- - The observation end time. The time in this timestamp is always - `07:00:00Z`. - type: string startTime: description: >- The observation start time. The time in this timestamp is always `07:00:00Z`. type: string format: google-datetime - description: Represents data observation period. - type: object - GoogleCloudPolicyanalyzerV1QueryActivityResponse: - type: object - description: Response to the `QueryActivity` method. - id: GoogleCloudPolicyanalyzerV1QueryActivityResponse - properties: - activities: - items: - $ref: '#/components/schemas/GoogleCloudPolicyanalyzerV1Activity' - description: The set of activities that match the filter included in the request. - type: array - nextPageToken: + endTime: description: >- - If there might be more results than those appearing in this - response, then `nextPageToken` is included. To get the next set of - results, call this method again using the value of `nextPageToken` - as `pageToken`. + The observation end time. The time in this timestamp is always + `07:00:00Z`. type: string + format: google-datetime parameters: + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string alt: description: Data format for response. in: query @@ -102,6 +108,18 @@ components: - json - media - proto + 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 @@ -111,18 +129,18 @@ components: 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 - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - type: string quotaUser: description: >- Available to use for quota purposes for server-side applications. Can be @@ -138,39 +156,21 @@ components: name: upload_protocol schema: type: string - _.xgafv: - description: V1 error format. - in: query - name: $.xgafv - schema: - type: string - enum: - - '1' - - '2' - access_token: - description: OAuth access token. - in: query - name: access_token - schema: - type: string - callback: - description: JSONP - in: query - name: callback - schema: - type: string uploadType: description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query name: uploadType schema: type: string - oauth_token: - description: OAuth 2.0 token for the current user. + _.xgafv: + description: V1 error format. in: query - name: oauth_token + name: $.xgafv schema: type: string + enum: + - '1' + - '2' x-stackQL-resources: activities: id: google.policyanalyzer.activities @@ -180,7 +180,7 @@ components: query: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1activityTypes~1{activityTypesId}~1activities:query/get + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1activityTypes~1{activityTypesId}~1activities:query/get response: mediaType: application/json openAPIDocKey: '200' @@ -194,17 +194,17 @@ components: paths: /v1/projects/{projectsId}/locations/{locationsId}/activityTypes/{activityTypesId}/activities:query: parameters: &ref_1 + - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/_.xgafv' get: description: Queries policy activities on Google Cloud resources. operationId: policyanalyzer.projects.locations.activityTypes.activities.query @@ -238,7 +238,7 @@ paths: schema: type: string - in: query - name: pageToken + name: filter schema: type: string - in: query @@ -247,14 +247,14 @@ paths: type: integer format: int32 - in: query - name: filter + name: pageToken schema: type: string - /v1/folders/{foldersId}/locations/{locationsId}/activityTypes/{activityTypesId}/activities:query: + /v1/organizations/{organizationsId}/locations/{locationsId}/activityTypes/{activityTypesId}/activities:query: parameters: *ref_1 get: description: Queries policy activities on Google Cloud resources. - operationId: policyanalyzer.folders.locations.activityTypes.activities.query + operationId: policyanalyzer.organizations.locations.activityTypes.activities.query security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -270,7 +270,7 @@ paths: #/components/schemas/GoogleCloudPolicyanalyzerV1QueryActivityResponse parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string @@ -284,24 +284,24 @@ paths: required: true schema: type: string + - in: query + name: filter + schema: + type: string - in: query name: pageSize schema: type: integer format: int32 - - in: query - name: filter - schema: - type: string - in: query name: pageToken schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/activityTypes/{activityTypesId}/activities:query: + /v1/folders/{foldersId}/locations/{locationsId}/activityTypes/{activityTypesId}/activities:query: parameters: *ref_1 get: description: Queries policy activities on Google Cloud resources. - operationId: policyanalyzer.organizations.locations.activityTypes.activities.query + operationId: policyanalyzer.folders.locations.activityTypes.activities.query security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -317,7 +317,7 @@ paths: #/components/schemas/GoogleCloudPolicyanalyzerV1QueryActivityResponse parameters: - in: path - name: organizationsId + name: foldersId required: true schema: type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/policysimulator.yaml b/providers/src/googleapis.com/v00.00.00000/services/policysimulator.yaml index b099d3da..e3290159 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/policysimulator.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/policysimulator.yaml @@ -7,8 +7,8 @@ info: title: Policy Simulator API description: ' Policy Simulator is a collection of endpoints for creating, running, and viewing a Replay. A `Replay` is a type of simulation that lets you see how your members'' access to resources might change if you changed your IAM policy. During a `Replay`, Policy Simulator re-evaluates, or replays, past access attempts under both the current policy and your proposed policy, and compares those results to determine how your members'' access might change under the proposed policy.' version: v1 - x-discovery-doc-revision: '20241030' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250821' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/iam/docs/simulating-access servers: @@ -34,496 +34,530 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudPolicysimulatorV1alphaGenerateOrgPolicyViolationsPreviewOperationMetadata: + GoogleLongrunningListOperationsResponse: + id: GoogleLongrunningListOperationsResponse + description: The response message for Operations.ListOperations. + type: object properties: - resourcesFound: - type: integer - description: >- - Total number of resources that need scanning. Should equal - resource_scanned + resources_pending - format: int32 - state: - description: The current state of the operation. - enumDescriptions: - - The state is unspecified. - - The OrgPolicyViolationsPreview has not been created yet. - - The OrgPolicyViolationsPreview is currently being created. - - The OrgPolicyViolationsPreview creation finished successfully. - - The OrgPolicyViolationsPreview creation failed with an error. - enum: - - PREVIEW_STATE_UNSPECIFIED - - PREVIEW_PENDING - - PREVIEW_RUNNING - - PREVIEW_SUCCEEDED - - PREVIEW_FAILED - type: string - requestTime: - type: string - format: google-datetime - description: Time when the request was received. - resourcesPending: - type: integer - format: int32 - description: Number of resources still to scan. - startTime: + operations: description: >- - Time when the request started processing, i.e. when the state was - set to RUNNING. - format: google-datetime + A list of operations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/GoogleLongrunningOperation' + nextPageToken: + description: The standard List next-page token. type: string - resourcesScanned: - type: integer - format: int32 - description: Number of resources already scanned. + GoogleLongrunningOperation: + id: GoogleLongrunningOperation description: >- - GenerateOrgPolicyViolationsPreviewOperationMetadata is metadata about an - OrgPolicyViolationsPreview generations operation. - id: >- - GoogleCloudPolicysimulatorV1alphaGenerateOrgPolicyViolationsPreviewOperationMetadata + This resource represents a long-running operation that is the result of + a network API call. type: object - GoogleCloudPolicysimulatorV1ExplainedAccess: - id: GoogleCloudPolicysimulatorV1ExplainedAccess properties: - errors: - items: - $ref: '#/components/schemas/GoogleRpcStatus' - type: array + name: description: >- - If the AccessState is `UNKNOWN`, this field contains a list of - errors explaining why the result is `UNKNOWN`. If the `AccessState` - is `GRANTED` or `NOT_GRANTED`, this field is omitted. - accessState: + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. type: string - enum: - - ACCESS_STATE_UNSPECIFIED - - GRANTED - - NOT_GRANTED - - UNKNOWN_CONDITIONAL - - UNKNOWN_INFO_DENIED - enumDescriptions: - - Default value. This value is unused. - - The principal has the permission. - - The principal does not have the permission. - - >- - The principal has the permission only if a condition expression - evaluates to `true`. - - >- - The user who created the Replay does not have access to all of the - policies that Policy Simulator needs to evaluate. + metadata: description: >- - Whether the principal in the access tuple has permission to access - the resource in the access tuple under the given policies. - policies: - type: array + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + done: description: >- - If the AccessState is `UNKNOWN`, this field contains the policies - that led to that result. If the `AccessState` is `GRANTED` or - `NOT_GRANTED`, this field is omitted. - items: - $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ExplainedPolicy' - description: >- - Details about how a set of policies, listed in ExplainedPolicy, resulted - in a certain AccessState when replaying an access tuple. - type: object - GoogleIamV1AuditConfig: + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + type: boolean + error: + description: >- + The error result of the operation in case of failure or + cancellation. + $ref: '#/components/schemas/GoogleRpcStatus' + response: + description: >- + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + GoogleRpcStatus: + id: GoogleRpcStatus 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. + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). type: object - id: GoogleIamV1AuditConfig properties: - service: + code: + description: The status code, which should be an enum value of google.rpc.Code. + type: integer + format: int32 + message: 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. + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. type: string - auditLogConfigs: - description: The configuration for logging of each type of permission. - items: - $ref: '#/components/schemas/GoogleIamV1AuditLogConfig' + details: + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. type: array - GoogleCloudOrgpolicyV2Policy: + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + GoogleCloudPolicysimulatorV1Replay: + id: GoogleCloudPolicysimulatorV1Replay + description: A resource describing a `Replay`, or simulation. type: object - description: >- - Defines an organization policy which is used to specify constraints for - configurations of Google Cloud resources. - id: GoogleCloudOrgpolicyV2Policy properties: - alternate: - description: Deprecated. - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2AlternatePolicySpec' - deprecated: true name: description: >- - Immutable. The resource name of the policy. Must be one of the - following forms, where `constraint_name` is the name of the - constraint which this policy configures: * - `projects/{project_number}/policies/{constraint_name}` * - `folders/{folder_id}/policies/{constraint_name}` * - `organizations/{organization_id}/policies/{constraint_name}` For - example, `projects/123/policies/compute.disableSerialPortAccess`. - Note: `projects/{project_id}/policies/{constraint_name}` is also an - acceptable name for API requests, but responses will return the name - using the equivalent project number. + Output only. The resource name of the `Replay`, which has the + following format: + `{projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}`, + where `{resource-id}` is the ID of the project, folder, or + organization that owns the Replay. Example: + `projects/my-example-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36` + readOnly: true type: string - spec: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' - description: Basic information about the Organization Policy. - etag: - description: >- - Optional. An opaque tag indicating the current state of the policy, - used for concurrency control. This 'etag' is computed by the server - based on the value of other fields, and may be sent on update and - delete requests to ensure the client has an up-to-date value before - proceeding. + state: + description: Output only. The current state of the `Replay`. + readOnly: true type: string - dryRunSpec: + enumDescriptions: + - Default value. This value is unused. + - The `Replay` has not started yet. + - The `Replay` is currently running. + - The `Replay` has successfully completed. + - The `Replay` has finished with an error. + enum: + - STATE_UNSPECIFIED + - PENDING + - RUNNING + - SUCCEEDED + - FAILED + config: + description: Required. The configuration used for the `Replay`. + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ReplayConfig' + resultsSummary: + description: Output only. Summary statistics about the replayed log entries. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1ReplayResultsSummary + GoogleCloudPolicysimulatorV1ReplayConfig: + id: GoogleCloudPolicysimulatorV1ReplayConfig + description: The configuration used for a Replay. + type: object + properties: + policyOverlay: description: >- - Dry-run policy. Audit-only policy, can be used to monitor how the - policy would have impacted the existing and future resources if it's - enforced. - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' - GoogleTypeDate: - id: GoogleTypeDate + A mapping of the resources that you want to simulate policies for + and the policies that you want to simulate. Keys are the full + resource names for the resources. For example, + `//cloudresourcemanager.googleapis.com/projects/my-project`. For + examples of full resource names for Google Cloud services, see + https://cloud.google.com/iam/help/troubleshooter/full-resource-names. + Values are Policy objects representing the policies that you want to + simulate. Replays automatically take into account any IAM policies + inherited through the resource hierarchy, and any policies set on + descendant resources. You do not need to include these policies in + the policy overlay. + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleIamV1Policy' + logSource: + description: The logs to use as input for the Replay. + type: string + enumDescriptions: + - >- + An unspecified log source. If the log source is unspecified, the + Replay defaults to using `RECENT_ACCESSES`. + - >- + All access logs from the last 90 days. These logs may not include + logs from the most recent 7 days. + enum: + - LOG_SOURCE_UNSPECIFIED + - RECENT_ACCESSES + GoogleIamV1Policy: + id: GoogleIamV1Policy + description: >- + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. A `Policy` is a collection of + `bindings`. A `binding` binds one or more `members`, or principals, to a + single `role`. Principals can be user accounts, service accounts, Google + groups, and domains (such as G Suite). A `role` is a named list of + permissions; each `role` can be an IAM predefined role or a user-created + custom role. For some types of Google Cloud resources, a `binding` can + also specify a `condition`, which is a logical expression that allows + access to a resource only if the expression evaluates to `true`. A + condition can add constraints based on attributes of the request, the + resource, or both. To learn which resources support conditions in their + IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + **JSON example:** ``` { "bindings": [ { "role": + "roles/resourcemanager.organizationAdmin", "members": [ + "user:mike@example.com", "group:admins@example.com", + "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { + "role": "roles/resourcemanager.organizationViewer", "members": [ + "user:eve@example.com" ], "condition": { "title": "expirable access", + "description": "Does not grant access after Sep 2020", "expression": + "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": + "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - + members: - user:mike@example.com - group:admins@example.com - + domain:google.com - + serviceAccount:my-project-id@appspot.gserviceaccount.com role: + roles/resourcemanager.organizationAdmin - members: - + user:eve@example.com role: roles/resourcemanager.organizationViewer + condition: title: expirable access description: Does not grant access + after Sep 2020 expression: request.time < + timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` + For a description of IAM and its features, see the [IAM + documentation](https://cloud.google.com/iam/docs/). + type: object properties: - year: - type: integer + version: description: >- - Year of the date. Must be from 1 to 9999, or 0 to specify a date - without a year. - format: int32 - month: - format: int32 + 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). type: integer - description: >- - Month of a year. Must be from 1 to 12, or 0 to specify a year - without a month and day. - day: format: int32 + bindings: description: >- - Day of a month. Must be from 1 to 31 and valid for the year and - month, or 0 to specify a year by itself or a year and month where - the day isn't significant. - type: integer + Associates a list of `members`, or principals, with a `role`. + Optionally, may specify a `condition` that determines how and when + the `bindings` are applied. Each of the `bindings` must contain at + least one principal. The `bindings` in a `Policy` can refer to up to + 1,500 principals; up to 250 of these principals can be Google + groups. Each occurrence of a principal counts towards these limits. + For example, if the `bindings` grant 50 different roles to + `user:alice@example.com`, and not to any other principal, then you + can add another 1,450 principals to the `bindings` in the `Policy`. + type: array + items: + $ref: '#/components/schemas/GoogleIamV1Binding' + auditConfigs: + description: Specifies cloud audit logging configuration for this policy. + type: array + items: + $ref: '#/components/schemas/GoogleIamV1AuditConfig' + 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. + type: string + format: byte + GoogleIamV1Binding: + id: GoogleIamV1Binding + description: Associates `members`, or principals, with a `role`. type: object - description: >- - Represents a whole or partial calendar date, such as a birthday. The - time of day and time zone are either specified elsewhere or are - insignificant. The date is relative to the Gregorian Calendar. This can - represent one of the following: * A full date, with non-zero year, - month, and day values. * A month and day, with a zero year (for example, - an anniversary). * A year on its own, with a zero month and a zero day. - * A year and month, with a zero day (for example, a credit card - expiration date). Related types: * google.type.TimeOfDay * - google.type.DateTime * google.protobuf.Timestamp - GoogleCloudOrgpolicyV2PolicySpecPolicyRule: properties: - values: + role: description: >- - List of values to be used for this policy rule. This field can be - set only in policies for list constraints. - $ref: >- - #/components/schemas/GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues - enforce: + Role that is assigned to the list of `members`, or principals. For + example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an + overview of the IAM roles and permissions, see the [IAM + documentation](https://cloud.google.com/iam/docs/roles-overview). + For a list of the available pre-defined roles, see + [here](https://cloud.google.com/iam/docs/understanding-roles). + type: string + members: description: >- - If `true`, then the policy is enforced. If `false`, then any - configuration is acceptable. This field can be set only in policies - for boolean constraints. - type: boolean + Specifies the principals requesting access for a Google Cloud + 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. Does not include identities + that come from external identity providers (IdPs) through identity + federation. * `user:{emailid}`: An email address that represents a + specific Google account. For example, `alice@example.com` . * + `serviceAccount:{emailid}`: An email address that represents a + Google service account. For example, + `my-other-app@appspot.gserviceaccount.com`. * + `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: + An identifier for a [Kubernetes service + account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). + For example, + `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * + `group:{emailid}`: An email address that represents a Google group. + For example, `admins@example.com`. * `domain:{domain}`: The G Suite + domain (primary) that represents all the users of that domain. For + example, `google.com` or `example.com`. * + `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workforce identity pool. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: + All workforce identities in a group. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All workforce identities with a specific attribute value. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: + All identities in a workforce identity pool. * + `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workload identity pool. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: + A workload identity pool group. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All identities in a workload identity pool with a certain attribute. + * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: + All identities in a workload identity pool. * + `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. * + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + Deleted single identity in a workforce identity pool. For example, + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + type: array + items: + type: string condition: - $ref: '#/components/schemas/GoogleTypeExpr' - description: >- - A condition which determines whether this rule is used in the - evaluation of the policy. When set, the `expression` field in the - `Expr' must include from 1 to 10 subexpressions, joined by the "||" - or "&&" operators. Each subexpression must be of the form - "resource.matchTag('/tag_key_short_name, 'tag_value_short_name')". - or "resource.matchTagId('tagKeys/key_id', 'tagValues/value_id')". - where key_name and value_name are the resource names for Label Keys - and Values. These names are available from the Tag Manager Service. - An example expression is: "resource.matchTag('123456789/environment, - 'prod')". or "resource.matchTagId('tagKeys/123', 'tagValues/456')". - allowAll: - type: boolean - description: >- - Setting this to true means that all values are allowed. This field - can be set only in policies for list constraints. - denyAll: description: >- - Setting this to true means that all values are denied. This field - can be set only in policies for list constraints. - type: boolean - type: object - description: A rule used to express this policy. - id: GoogleCloudOrgpolicyV2PolicySpecPolicyRule - GoogleCloudPolicysimulatorV1betaCreateOrgPolicyViolationsPreviewOperationMetadata: - id: >- - GoogleCloudPolicysimulatorV1betaCreateOrgPolicyViolationsPreviewOperationMetadata + The condition that is associated with this binding. If the condition + evaluates to `true`, then this binding applies to the current + request. If the condition evaluates to `false`, then this binding + does not apply to the current request. However, a different role + binding might grant the same role to one or more of the principals + in this binding. To learn which resources support conditions in + their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + $ref: '#/components/schemas/GoogleTypeExpr' + GoogleTypeExpr: + id: GoogleTypeExpr description: >- - CreateOrgPolicyViolationsPreviewOperationMetadata is metadata about an - OrgPolicyViolationsPreview generations operation. - properties: - resourcesPending: - format: int32 - description: Number of resources still to scan. - type: integer - state: - enumDescriptions: - - The state is unspecified. - - The OrgPolicyViolationsPreview has not been created yet. - - The OrgPolicyViolationsPreview is currently being created. - - The OrgPolicyViolationsPreview creation finished successfully. - - The OrgPolicyViolationsPreview creation failed with an error. - type: string - description: Output only. The current state of the operation. - readOnly: true - enum: - - PREVIEW_STATE_UNSPECIFIED - - PREVIEW_PENDING - - PREVIEW_RUNNING - - PREVIEW_SUCCEEDED - - PREVIEW_FAILED - startTime: - format: google-datetime - description: >- - Time when the request started processing, i.e., when the state was - set to RUNNING. - type: string - resourcesScanned: - type: integer - description: Number of resources already scanned. - format: int32 - resourcesFound: - type: integer - format: int32 - description: >- - Total number of resources that need scanning. Should equal - resource_scanned + resources_pending - requestTime: - format: google-datetime - description: Time when the request was received. - type: string + 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. type: object - GoogleCloudOrgpolicyV2PolicySpec: properties: - rules: - items: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpecPolicyRule' - type: array + expression: description: >- - In policies for boolean constraints, the following requirements - apply: - There must be one and only one policy rule where condition - is unset. - Boolean policy rules with conditions must set `enforced` - to the opposite of the policy rule without a condition. - During - policy evaluation, policy rules with conditions that are true for a - target resource take precedence. - etag: + Textual representation of an expression in Common Expression + Language syntax. type: string + title: description: >- - An opaque tag indicating the current version of the policySpec, used - for concurrency control. This field is ignored if used in a - `CreatePolicy` request. When the policy is returned from either a - `GetPolicy` or a `ListPolicies` request, this `etag` indicates the - version of the current policySpec to use when executing a - read-modify-write loop. When the policy is returned from a - `GetEffectivePolicy` request, the `etag` will be unset. - inheritFromParent: - description: >- - Determines the inheritance behavior for this policy. If - `inherit_from_parent` is true, policy rules set higher up in the - hierarchy (up to the closest root) are inherited and present in the - effective policy. If it is false, then no rules are inherited, and - this policy becomes the new root for evaluation. This field can be - set only for policies which configure list constraints. - type: boolean - reset: - type: boolean + 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 + description: description: >- - Ignores policies set above this resource and restores the - `constraint_default` enforcement behavior of the specific constraint - at this resource. This field can be set in policies for either list - or boolean constraints. If set, `rules` must be empty and - `inherit_from_parent` must be set to false. - updateTime: - format: google-datetime - readOnly: true + 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 + location: description: >- - Output only. The time stamp this was previously updated. This - represents the last time a call to `CreatePolicy` or `UpdatePolicy` - was made for that policy. - type: object + Optional. String indicating the location of the expression for error + reporting, e.g. a file name and a position in the file. + type: string + GoogleIamV1AuditConfig: + id: GoogleIamV1AuditConfig description: >- - Defines a Google Cloud policy specification which is used to specify - constraints for configurations of Google Cloud resources. - id: GoogleCloudOrgpolicyV2PolicySpec - GoogleCloudPolicysimulatorV1ExplainedPolicy: + 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. + type: object properties: - fullResourceName: - type: string + service: description: >- - The full resource name that identifies the resource. For example, - `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. - If the user who created the Replay does not have access to the - policy, this field is omitted. For examples of full resource names - for Google Cloud services, see - https://cloud.google.com/iam/help/troubleshooter/full-resource-names. - relevance: - enum: - - HEURISTIC_RELEVANCE_UNSPECIFIED - - NORMAL - - HIGH + 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 - enumDescriptions: - - Default value. This value is unused. - - >- - The data point has a limited effect on the result. Changing the - data point is unlikely to affect the overall determination. - - >- - The data point has a strong effect on the result. Changing the - data point is likely to affect the overall determination. - description: >- - The relevance of this policy to the overall determination in the - TroubleshootIamPolicyResponse. If the user who created the Replay - does not have access to the policy, this field is omitted. - bindingExplanations: + auditLogConfigs: + description: The configuration for logging of each type of permission. type: array items: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1BindingExplanation - description: >- - Details about how each binding in the policy affects the principal's - ability, or inability, to use the permission for the resource. If - the user who created the Replay does not have access to the policy, - this field is omitted. - access: - enum: - - ACCESS_STATE_UNSPECIFIED - - GRANTED - - NOT_GRANTED - - UNKNOWN_CONDITIONAL - - UNKNOWN_INFO_DENIED + $ref: '#/components/schemas/GoogleIamV1AuditLogConfig' + GoogleIamV1AuditLogConfig: + id: GoogleIamV1AuditLogConfig + 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. + type: object + properties: + logType: + description: The log type that this config enables. type: string enumDescriptions: - - Default value. This value is unused. - - The principal has the permission. - - The principal does not have the permission. - - >- - The principal has the permission only if a condition expression - evaluates to `true`. - - >- - The user who created the Replay does not have access to all of the - policies that Policy Simulator needs to evaluate. - description: >- - Indicates whether _this policy_ provides the specified permission to - the specified principal for the specified resource. This field does - _not_ indicate whether the principal actually has the permission for - the resource. There might be another policy that overrides this - policy. To determine whether the principal actually has the - permission, use the `access` field in the - TroubleshootIamPolicyResponse. - policy: - $ref: '#/components/schemas/GoogleIamV1Policy' + - Default case. Should never be this. + - 'Admin reads. Example: CloudIAM getIamPolicy' + - 'Data writes. Example: CloudSQL Users create' + - 'Data reads. Example: CloudSQL Users list' + enum: + - LOG_TYPE_UNSPECIFIED + - ADMIN_READ + - DATA_WRITE + - DATA_READ + exemptedMembers: description: >- - The IAM policy attached to the resource. If the user who created the - Replay does not have access to the policy, this field is empty. - description: Details about how a specific IAM Policy contributed to the access check. - id: GoogleCloudPolicysimulatorV1ExplainedPolicy - type: object - GoogleCloudPolicysimulatorV1betaGenerateOrgPolicyViolationsPreviewOperationMetadata: + Specifies the identities that do not cause logging for this type of + permission. Follows the same format of Binding.members. + type: array + items: + type: string + GoogleCloudPolicysimulatorV1ReplayResultsSummary: + id: GoogleCloudPolicysimulatorV1ReplayResultsSummary + description: Summary statistics about the replayed log entries. type: object - id: >- - GoogleCloudPolicysimulatorV1betaGenerateOrgPolicyViolationsPreviewOperationMetadata - description: >- - GenerateOrgPolicyViolationsPreviewOperationMetadata is metadata about an - OrgPolicyViolationsPreview generations operation. properties: - state: - enum: - - PREVIEW_STATE_UNSPECIFIED - - PREVIEW_PENDING - - PREVIEW_RUNNING - - PREVIEW_SUCCEEDED - - PREVIEW_FAILED - description: The current state of the operation. - type: string - enumDescriptions: - - The state is unspecified. - - The OrgPolicyViolationsPreview has not been created yet. - - The OrgPolicyViolationsPreview is currently being created. - - The OrgPolicyViolationsPreview creation finished successfully. - - The OrgPolicyViolationsPreview creation failed with an error. - startTime: - type: string + logCount: + description: The total number of log entries replayed. + type: integer + format: int32 + unchangedCount: description: >- - Time when the request started processing, i.e. when the state was - set to RUNNING. - format: google-datetime - resourcesScanned: - description: Number of resources already scanned. + The number of replayed log entries with no difference between + baseline and simulated policies. + type: integer + format: int32 + differenceCount: + description: >- + The number of replayed log entries with a difference between + baseline and simulated policies. + type: integer + format: int32 + errorCount: + description: The number of log entries that could not be replayed. + type: integer + format: int32 + oldestDate: + description: The date of the oldest log entry replayed. + $ref: '#/components/schemas/GoogleTypeDate' + newestDate: + description: The date of the newest log entry replayed. + $ref: '#/components/schemas/GoogleTypeDate' + GoogleTypeDate: + id: GoogleTypeDate + description: >- + Represents a whole or partial calendar date, such as a birthday. The + time of day and time zone are either specified elsewhere or are + insignificant. The date is relative to the Gregorian Calendar. This can + represent one of the following: * A full date, with non-zero year, + month, and day values. * A month and day, with a zero year (for example, + an anniversary). * A year on its own, with a zero month and a zero day. + * A year and month, with a zero day (for example, a credit card + expiration date). Related types: * google.type.TimeOfDay * + google.type.DateTime * google.protobuf.Timestamp + type: object + properties: + year: + description: >- + Year of the date. Must be from 1 to 9999, or 0 to specify a date + without a year. type: integer format: int32 - resourcesPending: - format: int32 - description: Number of resources still to scan. - type: integer - resourcesFound: + month: description: >- - Total number of resources that need scanning. Should equal - resource_scanned + resources_pending + Month of a year. Must be from 1 to 12, or 0 to specify a year + without a month and day. type: integer format: int32 - requestTime: - type: string - format: google-datetime - description: Time when the request was received. - GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay: - id: GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay - description: The proposed changes to OrgPolicy. - type: object - properties: - customConstraints: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayCustomConstraintOverlay - description: >- - Optional. The OrgPolicy CustomConstraint changes to preview - violations for. Any existing CustomConstraints with the same name - will be overridden in the simulation. That is, violations will be - determined as if all custom constraints in the overlay were - instantiated. Only a single custom_constraint is supported in the - overlay at a time. For evaluating multiple constraints, multiple - `GenerateOrgPolicyViolationsPreview` requests are made, where each - request evaluates a single constraint. - policies: - items: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayPolicyOverlay + day: description: >- - Optional. The OrgPolicy changes to preview violations for. Any - existing OrgPolicies with the same name will be overridden in the - simulation. That is, violations will be determined as if all - policies in the overlay were created or updated. - type: array + Day of a month. Must be from 1 to 31 and valid for the year and + month, or 0 to specify a year by itself or a year and month where + the day isn't significant. + type: integer + format: int32 GoogleCloudPolicysimulatorV1ListReplayResultsResponse: id: GoogleCloudPolicysimulatorV1ListReplayResultsResponse + description: Response message for Simulator.ListReplayResults. + type: object properties: replayResults: description: The results of running a Replay. @@ -531,253 +565,371 @@ components: items: $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ReplayResult' nextPageToken: - type: string description: >- A token that you can use to retrieve the next page of ReplayResult objects. If this field is omitted, there are no subsequent pages. - description: Response message for Simulator.ListReplayResults. + type: string + GoogleCloudPolicysimulatorV1ReplayResult: + id: GoogleCloudPolicysimulatorV1ReplayResult + description: The result of replaying a single access tuple against a simulated state. type: object - GoogleCloudPolicysimulatorV1ReplayConfig: properties: - logSource: - enumDescriptions: - - >- - An unspecified log source. If the log source is unspecified, the - Replay defaults to using `RECENT_ACCESSES`. - - >- - All access logs from the last 90 days. These logs may not include - logs from the most recent 7 days. + diff: + description: >- + The difference between the principal's access under the current + (baseline) policies and the principal's access under the proposed + (simulated) policies. This field is only included for access tuples + that were successfully replayed and had different results under the + current policies and the proposed policies. + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ReplayDiff' + error: + description: >- + The error that caused the access tuple replay to fail. This field is + only included for access tuples that were not replayed successfully. + $ref: '#/components/schemas/GoogleRpcStatus' + name: + description: >- + The resource name of the `ReplayResult`, in the following format: + `{projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}/results/{replay-result-id}`, + where `{resource-id}` is the ID of the project, folder, or + organization that owns the Replay. Example: + `projects/my-example-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36/results/1234` type: string - description: The logs to use as input for the Replay. - enum: - - LOG_SOURCE_UNSPECIFIED - - RECENT_ACCESSES - policyOverlay: - type: object + parent: + description: The Replay that the access tuple was included in. + type: string + accessTuple: description: >- - A mapping of the resources that you want to simulate policies for - and the policies that you want to simulate. Keys are the full - resource names for the resources. For example, - `//cloudresourcemanager.googleapis.com/projects/my-project`. For - examples of full resource names for Google Cloud services, see - https://cloud.google.com/iam/help/troubleshooter/full-resource-names. - Values are Policy objects representing the policies that you want to - simulate. Replays automatically take into account any IAM policies - inherited through the resource hierarchy, and any policies set on - descendant resources. You do not need to include these policies in - the policy overlay. - additionalProperties: - $ref: '#/components/schemas/GoogleIamV1Policy' + The access tuple that was replayed. This field includes information + about the principal, resource, and permission that were involved in + the access attempt. + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1AccessTuple' + lastSeenDate: + description: The latest date this access tuple was seen in the logs. + $ref: '#/components/schemas/GoogleTypeDate' + GoogleCloudPolicysimulatorV1ReplayDiff: + id: GoogleCloudPolicysimulatorV1ReplayDiff + description: >- + The difference between the results of evaluating an access tuple under + the current (baseline) policies and under the proposed (simulated) + policies. This difference explains how a principal's access could change + if the proposed policies were applied. type: object - description: The configuration used for a Replay. - id: GoogleCloudPolicysimulatorV1ReplayConfig - GoogleIamV1AuditLogConfig: - id: GoogleIamV1AuditLogConfig + properties: + accessDiff: + description: >- + A summary and comparison of the principal's access under the current + (baseline) policies and the proposed (simulated) policies for a + single access tuple. The evaluation of the principal's access is + reported in the AccessState field. + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1AccessStateDiff' + GoogleCloudPolicysimulatorV1AccessStateDiff: + id: GoogleCloudPolicysimulatorV1AccessStateDiff 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. + A summary and comparison of the principal's access under the current + (baseline) policies and the proposed (simulated) policies for a single + access tuple. + type: object properties: - logType: - enum: - - LOG_TYPE_UNSPECIFIED - - ADMIN_READ - - DATA_WRITE - - DATA_READ + baseline: + description: >- + The results of evaluating the access tuple under the current + (baseline) policies. If the AccessState couldn't be fully evaluated, + this field explains why. + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ExplainedAccess' + simulated: + description: >- + The results of evaluating the access tuple under the proposed + (simulated) policies. If the AccessState couldn't be fully + evaluated, this field explains why. + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ExplainedAccess' + accessChange: + description: >- + How the principal's access, specified in the AccessState field, + changed between the current (baseline) policies and proposed + (simulated) policies. + type: string enumDescriptions: - - Default case. Should never be this. - - 'Admin reads. Example: CloudIAM getIamPolicy' - - 'Data writes. Example: CloudSQL Users create' - - 'Data reads. Example: CloudSQL Users list' + - Default value. This value is unused. + - >- + The principal's access did not change. This includes the case + where both baseline and simulated are UNKNOWN, but the unknown + information is equivalent. + - >- + The principal's access under both the current policies and the + proposed policies is `UNKNOWN`, but the unknown information + differs between them. + - >- + The principal had access under the current policies (`GRANTED`), + but will no longer have access after the proposed changes + (`NOT_GRANTED`). + - >- + The principal did not have access under the current policies + (`NOT_GRANTED`), but will have access after the proposed changes + (`GRANTED`). + - >- + This result can occur for the following reasons: * The principal + had access under the current policies (`GRANTED`), but their + access after the proposed changes is `UNKNOWN`. * The principal's + access under the current policies is `UNKNOWN`, but they will not + have access after the proposed changes (`NOT_GRANTED`). + - >- + This result can occur for the following reasons: * The principal + did not have access under the current policies (`NOT_GRANTED`), + but their access after the proposed changes is `UNKNOWN`. * The + principal's access under the current policies is `UNKNOWN`, but + they will have access after the proposed changes (`GRANTED`). + enum: + - ACCESS_CHANGE_TYPE_UNSPECIFIED + - NO_CHANGE + - UNKNOWN_CHANGE + - ACCESS_REVOKED + - ACCESS_GAINED + - ACCESS_MAYBE_REVOKED + - ACCESS_MAYBE_GAINED + GoogleCloudPolicysimulatorV1ExplainedAccess: + id: GoogleCloudPolicysimulatorV1ExplainedAccess + description: >- + Details about how a set of policies, listed in ExplainedPolicy, resulted + in a certain AccessState when replaying an access tuple. + type: object + properties: + accessState: + description: >- + Whether the principal in the access tuple has permission to access + the resource in the access tuple under the given policies. type: string - description: The log type that this config enables. - exemptedMembers: + enumDescriptions: + - Default value. This value is unused. + - The principal has the permission. + - The principal does not have the permission. + - >- + The principal has the permission only if a condition expression + evaluates to `true`. + - >- + The user who created the Replay does not have access to all of the + policies that Policy Simulator needs to evaluate. + enum: + - ACCESS_STATE_UNSPECIFIED + - GRANTED + - NOT_GRANTED + - UNKNOWN_CONDITIONAL + - UNKNOWN_INFO_DENIED + policies: + description: >- + If the AccessState is `UNKNOWN`, this field contains the policies + that led to that result. If the `AccessState` is `GRANTED` or + `NOT_GRANTED`, this field is omitted. type: array + items: + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ExplainedPolicy' + errors: description: >- - Specifies the identities that do not cause logging for this type of - permission. Follows the same format of Binding.members. + If the AccessState is `UNKNOWN`, this field contains a list of + errors explaining why the result is `UNKNOWN`. If the `AccessState` + is `GRANTED` or `NOT_GRANTED`, this field is omitted. + type: array items: - type: string + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudPolicysimulatorV1ExplainedPolicy: + id: GoogleCloudPolicysimulatorV1ExplainedPolicy + description: Details about how a specific IAM Policy contributed to the access check. type: object - GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreview: - description: >- - OrgPolicyViolationsPreview is a resource providing a preview of the - violations that will exist if an OrgPolicy change is made. The list of - violations are modeled as child resources and retrieved via a - ListOrgPolicyViolations API call. There are potentially more - OrgPolicyViolations than could fit in an embedded field. Thus, the use - of a child resource instead of a field. - id: GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreview properties: - resourceCounts: + access: description: >- - Output only. A summary of the state of all resources scanned for - compliance with the changed OrgPolicy. - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts - readOnly: true - state: - enumDescriptions: - - The state is unspecified. - - The OrgPolicyViolationsPreview has not been created yet. - - The OrgPolicyViolationsPreview is currently being created. - - The OrgPolicyViolationsPreview creation finished successfully. - - The OrgPolicyViolationsPreview creation failed with an error. - description: Output only. The state of the `OrgPolicyViolationsPreview`. + Indicates whether _this policy_ provides the specified permission to + the specified principal for the specified resource. This field does + _not_ indicate whether the principal actually has the permission for + the resource. There might be another policy that overrides this + policy. To determine whether the principal actually has the + permission, use the `access` field in the + TroubleshootIamPolicyResponse. type: string + enumDescriptions: + - Default value. This value is unused. + - The principal has the permission. + - The principal does not have the permission. + - >- + The principal has the permission only if a condition expression + evaluates to `true`. + - >- + The user who created the Replay does not have access to all of the + policies that Policy Simulator needs to evaluate. enum: - - PREVIEW_STATE_UNSPECIFIED - - PREVIEW_PENDING - - PREVIEW_RUNNING - - PREVIEW_SUCCEEDED - - PREVIEW_FAILED - readOnly: true - name: - readOnly: true + - ACCESS_STATE_UNSPECIFIED + - GRANTED + - NOT_GRANTED + - UNKNOWN_CONDITIONAL + - UNKNOWN_INFO_DENIED + fullResourceName: description: >- - Output only. The resource name of the `OrgPolicyViolationsPreview`. - It has the following format: - `organizations/{organization}/locations/{location}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreview}` - Example: - `organizations/my-example-org/locations/global/orgPolicyViolationsPreviews/506a5f7f` - type: string - overlay: - description: Required. The proposed changes we are previewing violations for. - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay - createTime: + The full resource name that identifies the resource. For example, + `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. + If the user who created the Replay does not have access to the + policy, this field is omitted. For examples of full resource names + for Google Cloud services, see + https://cloud.google.com/iam/help/troubleshooter/full-resource-names. type: string + policy: description: >- - Output only. Time when this `OrgPolicyViolationsPreview` was - created. - readOnly: true - format: google-datetime - customConstraints: + The IAM policy attached to the resource. If the user who created the + Replay does not have access to the policy, this field is empty. + $ref: '#/components/schemas/GoogleIamV1Policy' + bindingExplanations: description: >- - Output only. The names of the constraints against which all - `OrgPolicyViolations` were evaluated. If `OrgPolicyOverlay` only - contains `PolicyOverlay` then it contains the name of the configured - custom constraint, applicable to the specified policies. Otherwise - it contains the name of the constraint specified in - `CustomConstraintOverlay`. Format: - `organizations/{organization_id}/customConstraints/{custom_constraint_id}` - Example: - `organizations/123/customConstraints/custom.createOnlyE2TypeVms` - readOnly: true + Details about how each binding in the policy affects the principal's + ability, or inability, to use the permission for the resource. If + the user who created the Replay does not have access to the policy, + this field is omitted. type: array items: - type: string - violationsCount: - type: integer + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1BindingExplanation + relevance: description: >- - Output only. The number of OrgPolicyViolations in this - `OrgPolicyViolationsPreview`. This count may differ from - `resource_summary.noncompliant_count` because each - OrgPolicyViolation is specific to a resource **and** constraint. If - there are multiple constraints being evaluated (i.e. multiple - policies in the overlay), a single resource may violate multiple - constraints. - format: int32 - readOnly: true - type: object - GoogleCloudPolicysimulatorV1alphaCreateOrgPolicyViolationsPreviewOperationMetadata: + The relevance of this policy to the overall determination in the + TroubleshootIamPolicyResponse. If the user who created the Replay + does not have access to the policy, this field is omitted. + type: string + enumDescriptions: + - Default value. This value is unused. + - >- + The data point has a limited effect on the result. Changing the + data point is unlikely to affect the overall determination. + - >- + The data point has a strong effect on the result. Changing the + data point is likely to affect the overall determination. + enum: + - HEURISTIC_RELEVANCE_UNSPECIFIED + - NORMAL + - HIGH + GoogleCloudPolicysimulatorV1BindingExplanation: + id: GoogleCloudPolicysimulatorV1BindingExplanation description: >- - CreateOrgPolicyViolationsPreviewOperationMetadata is metadata about an - OrgPolicyViolationsPreview generations operation. - id: >- - GoogleCloudPolicysimulatorV1alphaCreateOrgPolicyViolationsPreviewOperationMetadata + Details about how a binding in a policy affects a principal's ability to + use a permission. + type: object properties: - resourcesFound: + access: description: >- - Total number of resources that need scanning. Should equal - resource_scanned + resources_pending - type: integer - format: int32 - state: - description: Output only. The current state of the operation. - enum: - - PREVIEW_STATE_UNSPECIFIED - - PREVIEW_PENDING - - PREVIEW_RUNNING - - PREVIEW_SUCCEEDED - - PREVIEW_FAILED + Required. Indicates whether _this binding_ provides the specified + permission to the specified principal for the specified resource. + This field does _not_ indicate whether the principal actually has + the permission for the resource. There might be another binding that + overrides this binding. To determine whether the principal actually + has the permission, use the `access` field in the + TroubleshootIamPolicyResponse. type: string - readOnly: true enumDescriptions: - - The state is unspecified. - - The OrgPolicyViolationsPreview has not been created yet. - - The OrgPolicyViolationsPreview is currently being created. - - The OrgPolicyViolationsPreview creation finished successfully. - - The OrgPolicyViolationsPreview creation failed with an error. - resourcesPending: - format: int32 - type: integer - description: Number of resources still to scan. - startTime: - type: string - format: google-datetime + - Default value. This value is unused. + - The principal has the permission. + - The principal does not have the permission. + - >- + The principal has the permission only if a condition expression + evaluates to `true`. + - >- + The user who created the Replay does not have access to all of the + policies that Policy Simulator needs to evaluate. + enum: + - ACCESS_STATE_UNSPECIFIED + - GRANTED + - NOT_GRANTED + - UNKNOWN_CONDITIONAL + - UNKNOWN_INFO_DENIED + role: description: >- - Time when the request started processing, i.e., when the state was - set to RUNNING. - resourcesScanned: - description: Number of resources already scanned. - type: integer - format: int32 - requestTime: - description: Time when the request was received. - format: google-datetime + The role that this binding grants. For example, + `roles/compute.serviceAgent`. For a complete list of predefined IAM + roles, as well as the permissions in each role, see + https://cloud.google.com/iam/help/roles/reference. type: string - type: object - GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayCustomConstraintOverlay: - properties: - customConstraint: - description: Optional. The new or updated custom constraint. - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' - customConstraintParent: + rolePermission: + description: >- + Indicates whether the role granted by this binding contains the + specified permission. type: string + enumDescriptions: + - Default value. This value is unused. + - The permission is included in the role. + - The permission is not included in the role. + - >- + The user who created the Replay is not allowed to access the + binding. + enum: + - ROLE_PERMISSION_UNSPECIFIED + - ROLE_PERMISSION_INCLUDED + - ROLE_PERMISSION_NOT_INCLUDED + - ROLE_PERMISSION_UNKNOWN_INFO_DENIED + rolePermissionRelevance: description: >- - Optional. Resource the constraint is attached to. Example: - "organization/987654" - type: object - id: GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayCustomConstraintOverlay - description: A change to an OrgPolicy custom constraint. - GoogleLongrunningListOperationsResponse: - description: The response message for Operations.ListOperations. - properties: - nextPageToken: + The relevance of the permission's existence, or nonexistence, in the + role to the overall determination for the entire policy. type: string - description: The standard List next-page token. - operations: - items: - $ref: '#/components/schemas/GoogleLongrunningOperation' - type: array + enumDescriptions: + - Default value. This value is unused. + - >- + The data point has a limited effect on the result. Changing the + data point is unlikely to affect the overall determination. + - >- + The data point has a strong effect on the result. Changing the + data point is likely to affect the overall determination. + enum: + - HEURISTIC_RELEVANCE_UNSPECIFIED + - NORMAL + - HIGH + memberships: + description: >- + Indicates whether each principal in the binding includes the + principal specified in the request, either directly or indirectly. + Each key identifies a principal in the binding, and each value + indicates whether the principal in the binding includes the + principal in the request. For example, suppose that a binding + includes the following principals: * `user:alice@example.com` * + `group:product-eng@example.com` The principal in the replayed access + tuple is `user:bob@example.com`. This user is a principal of the + group `group:product-eng@example.com`. For the first principal in + the binding, the key is `user:alice@example.com`, and the + `membership` field in the value is set to `MEMBERSHIP_NOT_INCLUDED`. + For the second principal in the binding, the key is + `group:product-eng@example.com`, and the `membership` field in the + value is set to `MEMBERSHIP_INCLUDED`. + type: object + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1BindingExplanationAnnotatedMembership + relevance: description: >- - A list of operations that matches the specified filter in the - request. - type: object - id: GoogleLongrunningListOperationsResponse - GoogleCloudOrgpolicyV2AlternatePolicySpec: - properties: - spec: - description: Specify constraint for configurations of Google Cloud resources. - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' - launch: + The relevance of this binding to the overall determination for the + entire policy. type: string + enumDescriptions: + - Default value. This value is unused. + - >- + The data point has a limited effect on the result. Changing the + data point is unlikely to affect the overall determination. + - >- + The data point has a strong effect on the result. Changing the + data point is likely to affect the overall determination. + enum: + - HEURISTIC_RELEVANCE_UNSPECIFIED + - NORMAL + - HIGH + condition: description: >- - Reference to the launch that will be used while audit logging and to - control the launch. Should be set only in the alternate policy. - id: GoogleCloudOrgpolicyV2AlternatePolicySpec - type: object - description: >- - Similar to PolicySpec but with an extra 'launch' field for launch - reference. The PolicySpec here is specific for dry-run/darklaunch. + A condition expression that prevents this binding from granting + access unless the expression evaluates to `true`. To learn about IAM + Conditions, see + https://cloud.google.com/iam/docs/conditions-overview. + $ref: '#/components/schemas/GoogleTypeExpr' GoogleCloudPolicysimulatorV1BindingExplanationAnnotatedMembership: + id: GoogleCloudPolicysimulatorV1BindingExplanationAnnotatedMembership description: Details about whether the binding includes the principal. type: object properties: membership: + description: Indicates whether the binding includes the principal. + type: string enumDescriptions: - Default value. This value is unused. - >- @@ -793,8 +945,6 @@ components: - >- The principal is an unsupported type. Only Google Accounts and service accounts are supported. - description: Indicates whether the binding includes the principal. - type: string enum: - MEMBERSHIP_UNSPECIFIED - MEMBERSHIP_INCLUDED @@ -802,10 +952,10 @@ components: - MEMBERSHIP_UNKNOWN_INFO_DENIED - MEMBERSHIP_UNKNOWN_UNSUPPORTED relevance: - enum: - - HEURISTIC_RELEVANCE_UNSPECIFIED - - NORMAL - - HIGH + description: >- + The relevance of the principal's status to the overall determination + for the binding. + type: string enumDescriptions: - Default value. This value is unused. - >- @@ -814,509 +964,327 @@ components: - >- The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination. - description: >- - The relevance of the principal's status to the overall determination - for the binding. - type: string - id: GoogleCloudPolicysimulatorV1BindingExplanationAnnotatedMembership - GoogleLongrunningOperation: + enum: + - HEURISTIC_RELEVANCE_UNSPECIFIED + - NORMAL + - HIGH + GoogleCloudPolicysimulatorV1AccessTuple: + id: GoogleCloudPolicysimulatorV1AccessTuple + description: Information about the principal, resource, and permission to check. type: object - description: >- - This resource represents a long-running operation that is the result of - a network API call. properties: - done: - description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - type: boolean - error: - description: >- - The error result of the operation in case of failure or - cancellation. - $ref: '#/components/schemas/GoogleRpcStatus' - metadata: - description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - name: - description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. - type: string - response: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any + principal: description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - type: object - id: GoogleLongrunningOperation - GoogleCloudPolicysimulatorV1ReplayResult: - type: object - properties: - parent: - description: The Replay that the access tuple was included in. + Required. The principal whose access you want to check, in the form + of the email address that represents that principal. For example, + `alice@example.com` or + `my-service-account@my-project.iam.gserviceaccount.com`. The + principal must be a Google Account or a service account. Other types + of principals are not supported. type: string - diff: - $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ReplayDiff' - description: >- - The difference between the principal's access under the current - (baseline) policies and the principal's access under the proposed - (simulated) policies. This field is only included for access tuples - that were successfully replayed and had different results under the - current policies and the proposed policies. - accessTuple: - description: >- - The access tuple that was replayed. This field includes information - about the principal, resource, and permission that were involved in - the access attempt. - $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1AccessTuple' - error: - $ref: '#/components/schemas/GoogleRpcStatus' + fullResourceName: description: >- - The error that caused the access tuple replay to fail. This field is - only included for access tuples that were not replayed successfully. - name: + Required. The full resource name that identifies the resource. For + example, + `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. + For examples of full resource names for Google Cloud services, see + https://cloud.google.com/iam/help/troubleshooter/full-resource-names. type: string + permission: description: >- - The resource name of the `ReplayResult`, in the following format: - `{projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}/results/{replay-result-id}`, - where `{resource-id}` is the ID of the project, folder, or - organization that owns the Replay. Example: - `projects/my-example-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36/results/1234` - lastSeenDate: - description: The latest date this access tuple was seen in the logs. - $ref: '#/components/schemas/GoogleTypeDate' - description: The result of replaying a single access tuple against a simulated state. - id: GoogleCloudPolicysimulatorV1ReplayResult - GoogleRpcStatus: - type: object - id: GoogleRpcStatus - properties: - message: + Required. The IAM permission to check for the specified principal + and resource. For a complete list of IAM permissions, see + https://cloud.google.com/iam/help/permissions/reference. For a + complete list of predefined IAM roles and the permissions in each + role, see https://cloud.google.com/iam/help/roles/reference. type: string - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - code: - type: integer - format: int32 - description: The status code, which should be an enum value of google.rpc.Code. - details: - items: - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: object - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - type: array + GoogleCloudPolicysimulatorV1ListOrgPolicyViolationsPreviewsResponse: + id: GoogleCloudPolicysimulatorV1ListOrgPolicyViolationsPreviewsResponse description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayPolicyOverlay: - description: A change to an OrgPolicy. - id: GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayPolicyOverlay - properties: - policy: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' - description: Optional. The new or updated OrgPolicy. - policyParent: - description: >- - Optional. The parent of the policy we are attaching to. Example: - "projects/123456" - type: string + ListOrgPolicyViolationsPreviewsResponse is the response message for + OrgPolicyViolationsPreviewService.ListOrgPolicyViolationsPreviews. type: object - GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts: properties: - noncompliant: - description: >- - Output only. Number of scanned resources with at least one - violation. - type: integer - format: int32 - readOnly: true - unenforced: - format: int32 - readOnly: true - type: integer - description: >- - Output only. Number of resources where the constraint was not - enforced, i.e. the Policy set `enforced: false` for that resource. - scanned: - format: int32 - type: integer - description: >- - Output only. Number of resources checked for compliance. Must equal: - unenforced + noncompliant + compliant + error - readOnly: true - compliant: - readOnly: true - format: int32 - description: Output only. Number of scanned resources with zero violations. - type: integer - errors: - type: integer - readOnly: true - description: >- - Output only. Number of resources that returned an error when - scanned. - format: int32 - id: GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts - type: object - description: >- - A summary of the state of all resources scanned for compliance with the - changed OrgPolicy. - GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts: + orgPolicyViolationsPreviews: + description: The list of OrgPolicyViolationsPreview + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1OrgPolicyViolationsPreview + nextPageToken: + description: >- + A token that you can use to retrieve the next page of results. If + this field is omitted, there are no subsequent pages. + type: string + GoogleCloudPolicysimulatorV1OrgPolicyViolationsPreview: + id: GoogleCloudPolicysimulatorV1OrgPolicyViolationsPreview description: >- - A summary of the state of all resources scanned for compliance with the - changed OrgPolicy. - id: >- - GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts + OrgPolicyViolationsPreview is a resource providing a preview of the + violations that will exist if an OrgPolicy change is made. The list of + violations are modeled as child resources and retrieved via a + ListOrgPolicyViolations API call. There are potentially more + OrgPolicyViolations than could fit in an embedded field. Thus, the use + of a child resource instead of a field. type: object properties: - errors: + name: description: >- - Output only. Number of resources that returned an error when - scanned. - type: integer + Output only. The resource name of the `OrgPolicyViolationsPreview`. + It has the following format: + `organizations/{organization}/locations/{location}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreview}` + Example: + `organizations/my-example-org/locations/global/orgPolicyViolationsPreviews/506a5f7f` readOnly: true - format: int32 - scanned: - type: integer + type: string + state: + description: Output only. The state of the `OrgPolicyViolationsPreview`. readOnly: true + type: string + enumDescriptions: + - The state is unspecified. + - The OrgPolicyViolationsPreview has not been created yet. + - The OrgPolicyViolationsPreview is currently being created. + - The OrgPolicyViolationsPreview creation finished successfully. + - The OrgPolicyViolationsPreview creation failed with an error. + enum: + - PREVIEW_STATE_UNSPECIFIED + - PREVIEW_PENDING + - PREVIEW_RUNNING + - PREVIEW_SUCCEEDED + - PREVIEW_FAILED + overlay: + description: Required. The proposed changes we are previewing violations for. + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1OrgPolicyOverlay' + violationsCount: description: >- - Output only. Number of resources checked for compliance. Must equal: - unenforced + noncompliant + compliant + error - format: int32 - compliant: - description: Output only. Number of scanned resources with zero violations. - format: int32 + Output only. The number of OrgPolicyViolations in this + `OrgPolicyViolationsPreview`. This count may differ from + `resource_summary.noncompliant_count` because each + OrgPolicyViolation is specific to a resource **and** constraint. If + there are multiple constraints being evaluated (i.e. multiple + policies in the overlay), a single resource may violate multiple + constraints. readOnly: true type: integer - unenforced: + format: int32 + resourceCounts: description: >- - Output only. Number of resources where the constraint was not - enforced, i.e. the Policy set `enforced: false` for that resource. + Output only. A summary of the state of all resources scanned for + compliance with the changed OrgPolicy. readOnly: true - format: int32 - type: integer - noncompliant: - type: integer - format: int32 + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1OrgPolicyViolationsPreviewResourceCounts + customConstraints: description: >- - Output only. Number of scanned resources with at least one - violation. + Output only. The names of the constraints against which all + `OrgPolicyViolations` were evaluated. If `OrgPolicyOverlay` only + contains `PolicyOverlay` then it contains the name of the configured + custom constraint, applicable to the specified policies. Otherwise + it contains the name of the constraint specified in + `CustomConstraintOverlay`. Format: + `organizations/{organization_id}/customConstraints/{custom_constraint_id}` + Example: + `organizations/123/customConstraints/custom.createOnlyE2TypeVms` + readOnly: true + type: array + items: + type: string + createTime: + description: >- + Output only. Time when this `OrgPolicyViolationsPreview` was + created. readOnly: true - GoogleIamV1Binding: - description: Associates `members`, or principals, with a `role`. - id: GoogleIamV1Binding - properties: - role: type: string + format: google-datetime + GoogleCloudPolicysimulatorV1OrgPolicyOverlay: + id: GoogleCloudPolicysimulatorV1OrgPolicyOverlay + description: The proposed changes to OrgPolicy. + type: object + properties: + policies: description: >- - Role that is assigned to the list of `members`, or principals. For - example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an - overview of the IAM roles and permissions, see the [IAM - documentation](https://cloud.google.com/iam/docs/roles-overview). - For a list of the available pre-defined roles, see - [here](https://cloud.google.com/iam/docs/understanding-roles). - members: + Optional. The OrgPolicy changes to preview violations for. Any + existing OrgPolicies with the same name will be overridden in the + simulation. That is, violations will be determined as if all + policies in the overlay were created or updated. type: array - description: >- - Specifies the principals requesting access for a Google Cloud - 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. Does not include identities - that come from external identity providers (IdPs) through identity - federation. * `user:{emailid}`: An email address that represents a - specific Google account. For example, `alice@example.com` . * - `serviceAccount:{emailid}`: An email address that represents a - Google service account. For example, - `my-other-app@appspot.gserviceaccount.com`. * - `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: - An identifier for a [Kubernetes service - account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). - For example, - `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * - `group:{emailid}`: An email address that represents a Google group. - For example, `admins@example.com`. * `domain:{domain}`: The G Suite - domain (primary) that represents all the users of that domain. For - example, `google.com` or `example.com`. * - `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workforce identity pool. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: - All workforce identities in a group. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All workforce identities with a specific attribute value. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: - All identities in a workforce identity pool. * - `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workload identity pool. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: - A workload identity pool group. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All identities in a workload identity pool with a certain attribute. - * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: - All identities in a workload identity pool. * - `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. * - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - Deleted single identity in a workforce identity pool. For example, - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. items: - type: string - condition: - $ref: '#/components/schemas/GoogleTypeExpr' + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1OrgPolicyOverlayPolicyOverlay + customConstraints: description: >- - The condition that is associated with this binding. If the condition - evaluates to `true`, then this binding applies to the current - request. If the condition evaluates to `false`, then this binding - does not apply to the current request. However, a different role - binding might grant the same role to one or more of the principals - in this binding. To learn which resources support conditions in - their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + Optional. The OrgPolicy CustomConstraint changes to preview + violations for. Any existing CustomConstraints with the same name + will be overridden in the simulation. That is, violations will be + determined as if all custom constraints in the overlay were + instantiated. Only a single custom_constraint is supported in the + overlay at a time. For evaluating multiple constraints, multiple + `GenerateOrgPolicyViolationsPreview` requests are made, where each + request evaluates a single constraint. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1OrgPolicyOverlayCustomConstraintOverlay + GoogleCloudPolicysimulatorV1OrgPolicyOverlayPolicyOverlay: + id: GoogleCloudPolicysimulatorV1OrgPolicyOverlayPolicyOverlay + description: A change to an OrgPolicy. type: object - GoogleCloudPolicysimulatorV1AccessStateDiff: + properties: + policyParent: + description: >- + Optional. The parent of the policy we are attaching to. Example: + "projects/123456" + type: string + policy: + description: Optional. The new or updated OrgPolicy. + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + GoogleCloudOrgpolicyV2Policy: + id: GoogleCloudOrgpolicyV2Policy + description: >- + Defines an organization policy which is used to specify constraints for + configurations of Google Cloud resources. type: object + properties: + name: + description: >- + Immutable. The resource name of the policy. Must be one of the + following forms, where `constraint_name` is the name of the + constraint which this policy configures: * + `projects/{project_number}/policies/{constraint_name}` * + `folders/{folder_id}/policies/{constraint_name}` * + `organizations/{organization_id}/policies/{constraint_name}` For + example, `projects/123/policies/compute.disableSerialPortAccess`. + Note: `projects/{project_id}/policies/{constraint_name}` is also an + acceptable name for API requests, but responses will return the name + using the equivalent project number. + type: string + spec: + description: Basic information about the organization policy. + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' + alternate: + description: Deprecated. + deprecated: true + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2AlternatePolicySpec' + dryRunSpec: + description: >- + Dry-run policy. Audit-only policy, can be used to monitor how the + policy would have impacted the existing and future resources if it's + enforced. + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' + etag: + description: >- + Optional. An opaque tag indicating the current state of the policy, + used for concurrency control. This 'etag' is computed by the server + based on the value of other fields, and may be sent on update and + delete requests to ensure the client has an up-to-date value before + proceeding. + type: string + GoogleCloudOrgpolicyV2PolicySpec: + id: GoogleCloudOrgpolicyV2PolicySpec description: >- - A summary and comparison of the principal's access under the current - (baseline) policies and the proposed (simulated) policies for a single - access tuple. - id: GoogleCloudPolicysimulatorV1AccessStateDiff + Defines a Google Cloud policy specification which is used to specify + constraints for configurations of Google Cloud resources. + type: object properties: - baseline: - $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ExplainedAccess' + etag: description: >- - The results of evaluating the access tuple under the current - (baseline) policies. If the AccessState couldn't be fully evaluated, - this field explains why. - simulated: - $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ExplainedAccess' + An opaque tag indicating the current version of the policySpec, used + for concurrency control. This field is ignored if used in a + `CreatePolicy` request. When the policy is returned from either a + `GetPolicy` or a `ListPolicies` request, this `etag` indicates the + version of the current policySpec to use when executing a + read-modify-write loop. When the policy is returned from a + `GetEffectivePolicy` request, the `etag` will be unset. + type: string + updateTime: description: >- - The results of evaluating the access tuple under the proposed - (simulated) policies. If the AccessState couldn't be fully - evaluated, this field explains why. - accessChange: - enum: - - ACCESS_CHANGE_TYPE_UNSPECIFIED - - NO_CHANGE - - UNKNOWN_CHANGE - - ACCESS_REVOKED - - ACCESS_GAINED - - ACCESS_MAYBE_REVOKED - - ACCESS_MAYBE_GAINED + Output only. The time stamp this was previously updated. This + represents the last time a call to `CreatePolicy` or `UpdatePolicy` + was made for that policy. + readOnly: true type: string - enumDescriptions: - - Default value. This value is unused. - - >- - The principal's access did not change. This includes the case - where both baseline and simulated are UNKNOWN, but the unknown - information is equivalent. - - >- - The principal's access under both the current policies and the - proposed policies is `UNKNOWN`, but the unknown information - differs between them. - - >- - The principal had access under the current policies (`GRANTED`), - but will no longer have access after the proposed changes - (`NOT_GRANTED`). - - >- - The principal did not have access under the current policies - (`NOT_GRANTED`), but will have access after the proposed changes - (`GRANTED`). - - >- - This result can occur for the following reasons: * The principal - had access under the current policies (`GRANTED`), but their - access after the proposed changes is `UNKNOWN`. * The principal's - access under the current policies is `UNKNOWN`, but they will not - have access after the proposed changes (`NOT_GRANTED`). - - >- - This result can occur for the following reasons: * The principal - did not have access under the current policies (`NOT_GRANTED`), - but their access after the proposed changes is `UNKNOWN`. * The - principal's access under the current policies is `UNKNOWN`, but - they will have access after the proposed changes (`GRANTED`). + format: google-datetime + rules: description: >- - How the principal's access, specified in the AccessState field, - changed between the current (baseline) policies and proposed - (simulated) policies. - GoogleCloudPolicysimulatorV1BindingExplanation: + In policies for boolean constraints, the following requirements + apply: - There must be one and only one policy rule where condition + is unset. - Boolean policy rules with conditions must set `enforced` + to the opposite of the policy rule without a condition. - During + policy evaluation, policy rules with conditions that are true for a + target resource take precedence. + type: array + items: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpecPolicyRule' + inheritFromParent: + description: >- + Determines the inheritance behavior for this policy. If + `inherit_from_parent` is true, policy rules set higher up in the + hierarchy (up to the closest root) are inherited and present in the + effective policy. If it is false, then no rules are inherited, and + this policy becomes the new root for evaluation. This field can be + set only for policies which configure list constraints. + type: boolean + reset: + description: >- + Ignores policies set above this resource and restores the + `constraint_default` enforcement behavior of the specific constraint + at this resource. This field can be set in policies for either list + or boolean constraints. If set, `rules` must be empty and + `inherit_from_parent` must be set to false. + type: boolean + GoogleCloudOrgpolicyV2PolicySpecPolicyRule: + id: GoogleCloudOrgpolicyV2PolicySpecPolicyRule + description: A rule used to express this policy. type: object - id: GoogleCloudPolicysimulatorV1BindingExplanation - description: >- - Details about how a binding in a policy affects a principal's ability to - use a permission. properties: - rolePermission: - enum: - - ROLE_PERMISSION_UNSPECIFIED - - ROLE_PERMISSION_INCLUDED - - ROLE_PERMISSION_NOT_INCLUDED - - ROLE_PERMISSION_UNKNOWN_INFO_DENIED - type: string + values: description: >- - Indicates whether the role granted by this binding contains the - specified permission. - enumDescriptions: - - Default value. This value is unused. - - The permission is included in the role. - - The permission is not included in the role. - - >- - The user who created the Replay is not allowed to access the - binding. + List of values to be used for this policy rule. This field can be + set only in policies for list constraints. + $ref: >- + #/components/schemas/GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues + allowAll: + description: >- + Setting this to true means that all values are allowed. This field + can be set only in policies for list constraints. + type: boolean + denyAll: + description: >- + Setting this to true means that all values are denied. This field + can be set only in policies for list constraints. + type: boolean + enforce: + description: >- + If `true`, then the policy is enforced. If `false`, then any + configuration is acceptable. This field can be set in policies for + boolean constraints, custom constraints and managed constraints. + type: boolean condition: description: >- - A condition expression that prevents this binding from granting - access unless the expression evaluates to `true`. To learn about IAM - Conditions, see - https://cloud.google.com/iam/docs/conditions-overview. + A condition which determines whether this rule is used in the + evaluation of the policy. When set, the `expression` field in the + `Expr' must include from 1 to 10 subexpressions, joined by the "||" + or "&&" operators. Each subexpression must be of the form + "resource.matchTag('/tag_key_short_name, 'tag_value_short_name')". + or "resource.matchTagId('tagKeys/key_id', 'tagValues/value_id')". + where key_name and value_name are the resource names for Label Keys + and Values. These names are available from the Tag Manager Service. + An example expression is: "resource.matchTag('123456789/environment, + 'prod')". or "resource.matchTagId('tagKeys/123', 'tagValues/456')". $ref: '#/components/schemas/GoogleTypeExpr' - relevance: - type: string - enumDescriptions: - - Default value. This value is unused. - - >- - The data point has a limited effect on the result. Changing the - data point is unlikely to affect the overall determination. - - >- - The data point has a strong effect on the result. Changing the - data point is likely to affect the overall determination. - enum: - - HEURISTIC_RELEVANCE_UNSPECIFIED - - NORMAL - - HIGH - description: >- - The relevance of this binding to the overall determination for the - entire policy. - memberships: + parameters: description: >- - Indicates whether each principal in the binding includes the - principal specified in the request, either directly or indirectly. - Each key identifies a principal in the binding, and each value - indicates whether the principal in the binding includes the - principal in the request. For example, suppose that a binding - includes the following principals: * `user:alice@example.com` * - `group:product-eng@example.com` The principal in the replayed access - tuple is `user:bob@example.com`. This user is a principal of the - group `group:product-eng@example.com`. For the first principal in - the binding, the key is `user:alice@example.com`, and the - `membership` field in the value is set to `MEMBERSHIP_NOT_INCLUDED`. - For the second principal in the binding, the key is - `group:product-eng@example.com`, and the `membership` field in the - value is set to `MEMBERSHIP_INCLUDED`. + Optional. Required for managed constraints if parameters are + defined. Passes parameter values when policy enforcement is enabled. + Ensure that parameter value types match those defined in the + constraint definition. For example: ``` { "allowedLocations" : + ["us-east1", "us-west1"], "allowAll" : true } ``` type: object additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1BindingExplanationAnnotatedMembership - role: - type: string - description: >- - The role that this binding grants. For example, - `roles/compute.serviceAgent`. For a complete list of predefined IAM - roles, as well as the permissions in each role, see - https://cloud.google.com/iam/help/roles/reference. - rolePermissionRelevance: - type: string - enumDescriptions: - - Default value. This value is unused. - - >- - The data point has a limited effect on the result. Changing the - data point is unlikely to affect the overall determination. - - >- - The data point has a strong effect on the result. Changing the - data point is likely to affect the overall determination. - enum: - - HEURISTIC_RELEVANCE_UNSPECIFIED - - NORMAL - - HIGH - description: >- - The relevance of the permission's existence, or nonexistence, in the - role to the overall determination for the entire policy. - access: - enum: - - ACCESS_STATE_UNSPECIFIED - - GRANTED - - NOT_GRANTED - - UNKNOWN_CONDITIONAL - - UNKNOWN_INFO_DENIED - type: string - description: >- - Required. Indicates whether _this binding_ provides the specified - permission to the specified principal for the specified resource. - This field does _not_ indicate whether the principal actually has - the permission for the resource. There might be another binding that - overrides this binding. To determine whether the principal actually - has the permission, use the `access` field in the - TroubleshootIamPolicyResponse. - enumDescriptions: - - Default value. This value is unused. - - The principal has the permission. - - The principal does not have the permission. - - >- - The principal has the permission only if a condition expression - evaluates to `true`. - - >- - The user who created the Replay does not have access to all of the - policies that Policy Simulator needs to evaluate. + type: any + description: Properties of the object. GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues: id: GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues - type: object - properties: - allowedValues: - description: List of values allowed at this resource. - type: array - items: - type: string - deniedValues: - type: array - items: - type: string - description: List of values denied at this resource. description: >- A message that holds specific allowed and denied values. This message can define specific values and subtrees of the Resource Manager resource @@ -1331,111 +1299,57 @@ components: `organizations/` (for example, `organizations/1234`) The `supports_under` field of the associated `Constraint` defines whether ancestry prefixes can be used. - GoogleCloudPolicysimulatorV1Replay: + type: object + properties: + allowedValues: + description: List of values allowed at this resource. + type: array + items: + type: string + deniedValues: + description: List of values denied at this resource. + type: array + items: + type: string + GoogleCloudOrgpolicyV2AlternatePolicySpec: + id: GoogleCloudOrgpolicyV2AlternatePolicySpec + description: >- + Similar to PolicySpec but with an extra 'launch' field for launch + reference. The PolicySpec here is specific for dry-run. + type: object properties: - resultsSummary: - description: Output only. Summary statistics about the replayed log entries. - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1ReplayResultsSummary - state: - description: Output only. The current state of the `Replay`. - readOnly: true - enumDescriptions: - - Default value. This value is unused. - - The `Replay` has not started yet. - - The `Replay` is currently running. - - The `Replay` has successfully completed. - - The `Replay` has finished with an error. - enum: - - STATE_UNSPECIFIED - - PENDING - - RUNNING - - SUCCEEDED - - FAILED - type: string - name: - type: string + launch: description: >- - Output only. The resource name of the `Replay`, which has the - following format: - `{projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}`, - where `{resource-id}` is the ID of the project, folder, or - organization that owns the Replay. Example: - `projects/my-example-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36` - readOnly: true - config: - description: Required. The configuration used for the `Replay`. - $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ReplayConfig' - id: GoogleCloudPolicysimulatorV1Replay - type: object - description: A resource describing a `Replay`, or simulation. - GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay: + Reference to the launch that will be used while audit logging and to + control the launch. Should be set only in the alternate policy. + type: string + spec: + description: Specify constraint for configurations of Google Cloud resources. + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' + GoogleCloudPolicysimulatorV1OrgPolicyOverlayCustomConstraintOverlay: + id: GoogleCloudPolicysimulatorV1OrgPolicyOverlayCustomConstraintOverlay description: A change to an OrgPolicy custom constraint. - id: GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay + type: object properties: customConstraintParent: - type: string description: >- Optional. Resource the constraint is attached to. Example: "organization/987654" + type: string customConstraint: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' description: Optional. The new or updated custom constraint. - type: object - GoogleCloudPolicysimulatorV1AccessTuple: - id: GoogleCloudPolicysimulatorV1AccessTuple - type: object - description: Information about the principal, resource, and permission to check. - properties: - permission: - type: string - description: >- - Required. The IAM permission to check for the specified principal - and resource. For a complete list of IAM permissions, see - https://cloud.google.com/iam/help/permissions/reference. For a - complete list of predefined IAM roles and the permissions in each - role, see https://cloud.google.com/iam/help/roles/reference. - fullResourceName: - description: >- - Required. The full resource name that identifies the resource. For - example, - `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. - For examples of full resource names for Google Cloud services, see - https://cloud.google.com/iam/help/troubleshooter/full-resource-names. - type: string - principal: - description: >- - Required. The principal whose access you want to check, in the form - of the email address that represents that principal. For example, - `alice@example.com` or - `my-service-account@my-project.iam.gserviceaccount.com`. The - principal must be a Google Account or a service account. Other types - of principals are not supported. - type: string - GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay: - id: GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay - type: object - description: A change to an OrgPolicy. - properties: - policy: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' - description: Optional. The new or updated OrgPolicy. - policyParent: - type: string - description: >- - Optional. The parent of the policy we are attaching to. Example: - "projects/123456" + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' GoogleCloudOrgpolicyV2CustomConstraint: id: GoogleCloudOrgpolicyV2CustomConstraint + description: >- + A custom constraint defined by customers which can *only* be applied to + the given resource types and organization. By creating a custom + constraint, customers can apply policies of this custom constraint. + *Creating a custom constraint itself does NOT apply any policy + enforcement*. + type: object properties: - description: - description: >- - Detailed information about this custom policy constraint. The max - length of the description is 2000 characters. - type: string name: - type: string description: >- Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * @@ -1445,24 +1359,31 @@ components: max length is 70 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id}/customConstraints/` is not counted. - updateTime: - format: google-datetime - description: >- - Output only. The last time this custom constraint was updated. This - represents the last time that the `CreateCustomConstraint` or - `UpdateCustomConstraint` RPC was called - type: string - readOnly: true - displayName: type: string + resourceTypes: description: >- - One line display name for the UI. The max length of the display_name - is 200 characters. + Immutable. The resource instance type on which this policy applies. + Format will be of the form : `/` Example: * + `compute.googleapis.com/Instance`. + type: array + items: + type: string methodTypes: description: All the operations being applied for this constraint. type: array items: type: string + enumDescriptions: + - >- + This is only used for distinguishing unset values and should + never be used. Results in an error. + - Constraint applied when creating the resource. + - Constraint applied when updating the resource. + - >- + Constraint applied when deleting the resource. Not currently + supported. + - Constraint applied when removing an IAM grant. + - Constraint applied when enforcing forced tagging. enum: - METHOD_TYPE_UNSPECIFIED - CREATE @@ -1470,239 +1391,265 @@ components: - DELETE - REMOVE_GRANT - GOVERN_TAGS - enumDescriptions: - - Unspecified. Results in an error. - - Constraint applied when creating the resource. - - Constraint applied when updating the resource. - - >- - Constraint applied when deleting the resource. Not supported - yet. - - Constraint applied when removing an IAM grant. - - Constraint applied when enforcing forced tagging. - resourceTypes: - description: >- - Immutable. The resource instance type on which this policy applies. - Format will be of the form : `/` Example: * - `compute.googleapis.com/Instance`. - type: array - items: - type: string condition: - type: string description: >- - Org policy condition/expression. For example: + A Common Expression Language (CEL) condition which is used in the + evaluation of the constraint. For example: `resource.instanceName.matches("[production|test]_.*_(\d)+")` or, `resource.management.auto_upgrade == true` The max length of the condition is 1000 characters. + type: string actionType: description: Allow or deny type. + type: string enumDescriptions: - - Unspecified. Results in an error. + - >- + This is only used for distinguishing unset values and should never + be used. Results in an error. - Allowed action type. - Deny action type. - type: string enum: - ACTION_TYPE_UNSPECIFIED - ALLOW - DENY - type: object + displayName: + description: >- + One line display name for the UI. The max length of the display_name + is 200 characters. + type: string + description: + description: >- + Detailed information about this custom policy constraint. The max + length of the description is 2000 characters. + type: string + updateTime: + description: >- + Output only. The last time this custom constraint was updated. This + represents the last time that the `CreateCustomConstraint` or + `UpdateCustomConstraint` methods were called. + readOnly: true + type: string + format: google-datetime + GoogleCloudPolicysimulatorV1OrgPolicyViolationsPreviewResourceCounts: + id: GoogleCloudPolicysimulatorV1OrgPolicyViolationsPreviewResourceCounts description: >- - A custom constraint defined by customers which can *only* be applied to - the given resource types and organization. By creating a custom - constraint, customers can apply policies of this custom constraint. - *Creating a custom constraint itself does NOT apply any policy - enforcement*. - GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay: + A summary of the state of all resources scanned for compliance with the + changed OrgPolicy. type: object properties: - customConstraints: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay + scanned: description: >- - Optional. The OrgPolicy CustomConstraint changes to preview - violations for. Any existing CustomConstraints with the same name - will be overridden in the simulation. That is, violations will be - determined as if all custom constraints in the overlay were - instantiated. Only a single custom_constraint is supported in the - overlay at a time. For evaluating multiple constraints, multiple - `GenerateOrgPolicyViolationsPreview` requests are made, where each - request evaluates a single constraint. - policies: - items: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay - type: array + Output only. Number of resources checked for compliance. Must equal: + unenforced + noncompliant + compliant + error + readOnly: true + type: integer + format: int32 + noncompliant: description: >- - Optional. The OrgPolicy changes to preview violations for. Any - existing OrgPolicies with the same name will be overridden in the - simulation. That is, violations will be determined as if all - policies in the overlay were created or updated. - description: The proposed changes to OrgPolicy. - id: GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay - GoogleCloudPolicysimulatorV1ReplayDiff: - description: >- - The difference between the results of evaluating an access tuple under - the current (baseline) policies and under the proposed (simulated) - policies. This difference explains how a principal's access could change - if the proposed policies were applied. - id: GoogleCloudPolicysimulatorV1ReplayDiff - properties: - accessDiff: - $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1AccessStateDiff' + Output only. Number of scanned resources with at least one + violation. + readOnly: true + type: integer + format: int32 + compliant: + description: Output only. Number of scanned resources with zero violations. + readOnly: true + type: integer + format: int32 + unenforced: description: >- - A summary and comparison of the principal's access under the current - (baseline) policies and the proposed (simulated) policies for a - single access tuple. The evaluation of the principal's access is - reported in the AccessState field. - type: object - GoogleIamV1Policy: + Output only. Number of resources where the constraint was not + enforced, i.e. the Policy set `enforced: false` for that resource. + readOnly: true + type: integer + format: int32 + errors: + description: >- + Output only. Number of resources that returned an error when + scanned. + readOnly: true + type: integer + format: int32 + GoogleCloudPolicysimulatorV1ListOrgPolicyViolationsResponse: + id: GoogleCloudPolicysimulatorV1ListOrgPolicyViolationsResponse + description: >- + ListOrgPolicyViolationsResponse is the response message for + OrgPolicyViolationsPreviewService.ListOrgPolicyViolations type: object properties: - etag: - type: string - format: byte - 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. - auditConfigs: + orgPolicyViolations: + description: The list of OrgPolicyViolations type: array items: - $ref: '#/components/schemas/GoogleIamV1AuditConfig' - description: Specifies cloud audit logging configuration for this policy. - bindings: + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1OrgPolicyViolation + nextPageToken: description: >- - Associates a list of `members`, or principals, with a `role`. - Optionally, may specify a `condition` that determines how and when - the `bindings` are applied. Each of the `bindings` must contain at - least one principal. The `bindings` in a `Policy` can refer to up to - 1,500 principals; up to 250 of these principals can be Google - groups. Each occurrence of a principal counts towards these limits. - For example, if the `bindings` grant 50 different roles to - `user:alice@example.com`, and not to any other principal, then you - can add another 1,450 principals to the `bindings` in the `Policy`. - items: - $ref: '#/components/schemas/GoogleIamV1Binding' - type: array - version: + A token that you can use to retrieve the next page of results. If + this field is omitted, there are no subsequent pages. + type: string + GoogleCloudPolicysimulatorV1OrgPolicyViolation: + id: GoogleCloudPolicysimulatorV1OrgPolicyViolation + description: >- + OrgPolicyViolation is a resource representing a single resource + violating a single OrgPolicy constraint. + type: object + properties: + name: 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). - type: integer - format: int32 + The name of the `OrgPolicyViolation`. Example: + organizations/my-example-org/locations/global/orgPolicyViolationsPreviews/506a5f7f/orgPolicyViolations/38ce` + type: string + resource: + description: The resource violating the constraint. + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ResourceContext' + customConstraint: + description: The custom constraint being violated. + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' + error: + description: Any error encountered during the evaluation. + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudPolicysimulatorV1ResourceContext: + id: GoogleCloudPolicysimulatorV1ResourceContext description: >- - An Identity and Access Management (IAM) policy, which specifies access - controls for Google Cloud resources. A `Policy` is a collection of - `bindings`. A `binding` binds one or more `members`, or principals, to a - single `role`. Principals can be user accounts, service accounts, Google - groups, and domains (such as G Suite). A `role` is a named list of - permissions; each `role` can be an IAM predefined role or a user-created - custom role. For some types of Google Cloud resources, a `binding` can - also specify a `condition`, which is a logical expression that allows - access to a resource only if the expression evaluates to `true`. A - condition can add constraints based on attributes of the request, the - resource, or both. To learn which resources support conditions in their - IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - **JSON example:** ``` { "bindings": [ { "role": - "roles/resourcemanager.organizationAdmin", "members": [ - "user:mike@example.com", "group:admins@example.com", - "domain:google.com", - "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { - "role": "roles/resourcemanager.organizationViewer", "members": [ - "user:eve@example.com" ], "condition": { "title": "expirable access", - "description": "Does not grant access after Sep 2020", "expression": - "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": - "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - - members: - user:mike@example.com - group:admins@example.com - - domain:google.com - - serviceAccount:my-project-id@appspot.gserviceaccount.com role: - roles/resourcemanager.organizationAdmin - members: - - user:eve@example.com role: roles/resourcemanager.organizationViewer - condition: title: expirable access description: Does not grant access - after Sep 2020 expression: request.time < - timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` - For a description of IAM and its features, see the [IAM - documentation](https://cloud.google.com/iam/docs/). - id: GoogleIamV1Policy - GoogleTypeExpr: + ResourceContext provides the context we know about a resource. It is + similar in concept to google.cloud.asset.v1.Resource, but focuses on the + information specifically used by Simulator. type: object - id: GoogleTypeExpr properties: - expression: + resource: + description: >- + The full name of the resource. Example: + `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1` + See [Resource + names](https://cloud.google.com/apis/design/resource_names#full_resource_name) + for more information. + type: string + assetType: + description: >- + The asset type of the resource as defined by CAIS. Example: + `compute.googleapis.com/Firewall` See [Supported asset + types](https://cloud.google.com/asset-inventory/docs/supported-asset-types) + for more information. + type: string + ancestors: + description: >- + The ancestry path of the resource in Google Cloud [resource + hierarchy](https://cloud.google.com/resource-manager/docs/cloud-platform-resource-hierarchy), + represented as a list of relative resource names. An ancestry path + starts with the closest ancestor in the hierarchy and ends at root. + If the resource is a project, folder, or organization, the ancestry + path starts from the resource itself. Example: + `["projects/123456789", "folders/5432", "organizations/1234"]` + type: array + items: + type: string + GoogleCloudPolicysimulatorV1ReplayOperationMetadata: + id: GoogleCloudPolicysimulatorV1ReplayOperationMetadata + description: Metadata about a Replay operation. + type: object + properties: + startTime: + description: Time when the request was received. type: string - description: >- - Textual representation of an expression in Common Expression - Language syntax. - location: + format: google-datetime + GoogleCloudPolicysimulatorV1betaGenerateOrgPolicyViolationsPreviewOperationMetadata: + id: >- + GoogleCloudPolicysimulatorV1betaGenerateOrgPolicyViolationsPreviewOperationMetadata + description: >- + GenerateOrgPolicyViolationsPreviewOperationMetadata is metadata about an + OrgPolicyViolationsPreview generations operation. + type: object + properties: + requestTime: + description: Time when the request was received. type: string + format: google-datetime + startTime: description: >- - Optional. String indicating the location of the expression for error - reporting, e.g. a file name and a position in the file. - title: + Time when the request started processing, i.e. when the state was + set to RUNNING. type: string - 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. - description: + format: google-datetime + state: + description: The current state of the operation. type: string + enumDescriptions: + - The state is unspecified. + - The OrgPolicyViolationsPreview has not been created yet. + - The OrgPolicyViolationsPreview is currently being created. + - The OrgPolicyViolationsPreview creation finished successfully. + - The OrgPolicyViolationsPreview creation failed with an error. + enum: + - PREVIEW_STATE_UNSPECIFIED + - PREVIEW_PENDING + - PREVIEW_RUNNING + - PREVIEW_SUCCEEDED + - PREVIEW_FAILED + resourcesFound: description: >- - Optional. Description of the expression. This is a longer text which - describes the expression, e.g. when hovered over it in a UI. + Total number of resources that need scanning. Should equal + resource_scanned + resources_pending + type: integer + format: int32 + resourcesScanned: + description: Number of resources already scanned. + type: integer + format: int32 + resourcesPending: + description: Number of resources still to scan. + type: integer + format: int32 + GoogleCloudPolicysimulatorV1betaCreateOrgPolicyViolationsPreviewOperationMetadata: + id: >- + GoogleCloudPolicysimulatorV1betaCreateOrgPolicyViolationsPreviewOperationMetadata 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. - GoogleCloudPolicysimulatorV1ReplayOperationMetadata: + CreateOrgPolicyViolationsPreviewOperationMetadata is metadata about an + OrgPolicyViolationsPreview generations operation. type: object - description: Metadata about a Replay operation. properties: + requestTime: + description: Time when the request was received. + type: string + format: google-datetime startTime: + description: >- + Time when the request started processing, i.e., when the state was + set to RUNNING. + type: string format: google-datetime - description: Time when the request was received. + state: + description: Output only. The current state of the operation. + readOnly: true type: string - id: GoogleCloudPolicysimulatorV1ReplayOperationMetadata - GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreview: - type: object + enumDescriptions: + - The state is unspecified. + - The OrgPolicyViolationsPreview has not been created yet. + - The OrgPolicyViolationsPreview is currently being created. + - The OrgPolicyViolationsPreview creation finished successfully. + - The OrgPolicyViolationsPreview creation failed with an error. + enum: + - PREVIEW_STATE_UNSPECIFIED + - PREVIEW_PENDING + - PREVIEW_RUNNING + - PREVIEW_SUCCEEDED + - PREVIEW_FAILED + resourcesFound: + description: >- + Total number of resources that need scanning. Should equal + resource_scanned + resources_pending + type: integer + format: int32 + resourcesScanned: + description: Number of resources already scanned. + type: integer + format: int32 + resourcesPending: + description: Number of resources still to scan. + type: integer + format: int32 + GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreview: + id: GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreview description: >- OrgPolicyViolationsPreview is a resource providing a preview of the violations that will exist if an OrgPolicy change is made. The list of @@ -1710,27 +1657,19 @@ components: ListOrgPolicyViolations API call. There are potentially more OrgPolicyViolations than could fit in an embedded field. Thus, the use of a child resource instead of a field. + type: object properties: - overlay: - description: Required. The proposed changes we are previewing violations for. - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay - customConstraints: - items: - type: string - readOnly: true + name: description: >- - Output only. The names of the constraints against which all - `OrgPolicyViolations` were evaluated. If `OrgPolicyOverlay` only - contains `PolicyOverlay` then it contains the name of the configured - custom constraint, applicable to the specified policies. Otherwise - it contains the name of the constraint specified in - `CustomConstraintOverlay`. Format: - `organizations/{organization_id}/customConstraints/{custom_constraint_id}` + Output only. The resource name of the `OrgPolicyViolationsPreview`. + It has the following format: + `organizations/{organization}/locations/{location}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreview}` Example: - `organizations/123/customConstraints/custom.createOnlyE2TypeVms` - type: array + `organizations/my-example-org/locations/global/orgPolicyViolationsPreviews/506a5f7f` + readOnly: true + type: string state: + description: Output only. The state of the `OrgPolicyViolationsPreview`. readOnly: true type: string enumDescriptions: @@ -1745,11 +1684,11 @@ components: - PREVIEW_RUNNING - PREVIEW_SUCCEEDED - PREVIEW_FAILED - description: Output only. The state of the `OrgPolicyViolationsPreview`. + overlay: + description: Required. The proposed changes we are previewing violations for. + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay violationsCount: - readOnly: true - format: int32 - type: integer description: >- Output only. The number of OrgPolicyViolations in this `OrgPolicyViolationsPreview`. This count may differ from @@ -1758,66 +1697,138 @@ components: there are multiple constraints being evaluated (i.e. multiple policies in the overlay), a single resource may violate multiple constraints. + readOnly: true + type: integer + format: int32 + resourceCounts: + description: >- + Output only. A summary of the state of all resources scanned for + compliance with the changed OrgPolicy. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts + customConstraints: + description: >- + Output only. The names of the constraints against which all + `OrgPolicyViolations` were evaluated. If `OrgPolicyOverlay` only + contains `PolicyOverlay` then it contains the name of the configured + custom constraint, applicable to the specified policies. Otherwise + it contains the name of the constraint specified in + `CustomConstraintOverlay`. Format: + `organizations/{organization_id}/customConstraints/{custom_constraint_id}` + Example: + `organizations/123/customConstraints/custom.createOnlyE2TypeVms` + readOnly: true + type: array + items: + type: string createTime: description: >- Output only. Time when this `OrgPolicyViolationsPreview` was created. - format: google-datetime readOnly: true type: string - name: - type: string - readOnly: true + format: google-datetime + GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay: + id: GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay + description: The proposed changes to OrgPolicy. + type: object + properties: + policies: description: >- - Output only. The resource name of the `OrgPolicyViolationsPreview`. - It has the following format: - `organizations/{organization}/locations/{location}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreview}` - Example: - `organizations/my-example-org/locations/global/orgPolicyViolationsPreviews/506a5f7f` - resourceCounts: - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts + Optional. The OrgPolicy changes to preview violations for. Any + existing OrgPolicies with the same name will be overridden in the + simulation. That is, violations will be determined as if all + policies in the overlay were created or updated. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay + customConstraints: description: >- - Output only. A summary of the state of all resources scanned for - compliance with the changed OrgPolicy. - id: GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreview - GoogleCloudPolicysimulatorV1ReplayResultsSummary: + Optional. The OrgPolicy CustomConstraint changes to preview + violations for. Any existing CustomConstraints with the same name + will be overridden in the simulation. That is, violations will be + determined as if all custom constraints in the overlay were + instantiated. Only a single custom_constraint is supported in the + overlay at a time. For evaluating multiple constraints, multiple + `GenerateOrgPolicyViolationsPreview` requests are made, where each + request evaluates a single constraint. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay + GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay: + id: GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay + description: A change to an OrgPolicy. type: object - id: GoogleCloudPolicysimulatorV1ReplayResultsSummary - description: Summary statistics about the replayed log entries. properties: - oldestDate: - description: The date of the oldest log entry replayed. - $ref: '#/components/schemas/GoogleTypeDate' - logCount: - type: integer - format: int32 - description: The total number of log entries replayed. - errorCount: + policyParent: + description: >- + Optional. The parent of the policy we are attaching to. Example: + "projects/123456" + type: string + policy: + description: Optional. The new or updated OrgPolicy. + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay: + id: GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay + description: A change to an OrgPolicy custom constraint. + type: object + properties: + customConstraintParent: + description: >- + Optional. Resource the constraint is attached to. Example: + "organization/987654" + type: string + customConstraint: + description: Optional. The new or updated custom constraint. + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' + GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts: + id: GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts + description: >- + A summary of the state of all resources scanned for compliance with the + changed OrgPolicy. + type: object + properties: + scanned: + description: >- + Output only. Number of resources checked for compliance. Must equal: + unenforced + noncompliant + compliant + error + readOnly: true type: integer - description: The number of log entries that could not be replayed. format: int32 - unchangedCount: + noncompliant: description: >- - The number of replayed log entries with no difference between - baseline and simulated policies. + Output only. Number of scanned resources with at least one + violation. + readOnly: true + type: integer format: int32 + compliant: + description: Output only. Number of scanned resources with zero violations. + readOnly: true type: integer - differenceCount: + format: int32 + unenforced: + description: >- + Output only. Number of resources where the constraint was not + enforced, i.e. the Policy set `enforced: false` for that resource. + readOnly: true type: integer format: int32 + errors: description: >- - The number of replayed log entries with a difference between - baseline and simulated policies. - newestDate: - $ref: '#/components/schemas/GoogleTypeDate' - description: The date of the newest log entry replayed. + Output only. Number of resources that returned an error when + scanned. + readOnly: true + type: integer + format: int32 parameters: - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + access_token: + description: OAuth access token. in: query - name: upload_protocol + name: access_token schema: type: string alt: @@ -1830,40 +1841,16 @@ components: - json - media - proto - _.xgafv: - description: V1 error format. - in: query - name: $.xgafv - schema: - type: string - enum: - - '1' - - '2' - 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 - oauth_token: - description: OAuth 2.0 token for the current user. - in: query - name: oauth_token - schema: - type: string callback: description: JSONP in: query name: callback schema: type: string - access_token: - description: OAuth access token. + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: access_token + name: fields schema: type: string key: @@ -1875,24 +1862,48 @@ components: 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 + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string uploadType: description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query name: uploadType schema: type: string - fields: - description: Selector specifying which fields to include in a partial response. + _.xgafv: + description: V1 error format. in: query - name: fields + name: $.xgafv schema: type: string + enum: + - '1' + - '2' x-stackQL-resources: operations: id: google.policysimulator.operations @@ -1912,6 +1923,20 @@ components: response: mediaType: application/json openAPIDocKey: '200' + projects_locations_org_policy_violations_previews_operations_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1orgPolicyViolationsPreviews~1{orgPolicyViolationsPreviewsId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_access_policy_simulations_operations_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1accessPolicySimulations~1{accessPolicySimulationsId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' projects_locations_replays_operations_list: operation: $ref: >- @@ -1927,77 +1952,90 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_locations_org_policy_violations_previews_operations_get: + folders_locations_org_policy_violations_previews_operations_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1orgPolicyViolationsPreviews~1{orgPolicyViolationsPreviewsId}~1operations~1{operationsId}/get + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1orgPolicyViolationsPreviews~1{orgPolicyViolationsPreviewsId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_org_policy_violations_previews_operations_get: + folders_locations_access_policy_simulations_operations_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1orgPolicyViolationsPreviews~1{orgPolicyViolationsPreviewsId}~1operations~1{operationsId}/get + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1accessPolicySimulations~1{accessPolicySimulationsId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_replays_operations_get: + folders_locations_replays_operations_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1replays~1{replaysId}~1operations~1{operationsId}/get + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1replays~1{replaysId}~1operations/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_replays_operations_list: + objectKey: $.operations + folders_locations_replays_operations_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1replays~1{replaysId}~1operations/get + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1replays~1{replaysId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.operations - folders_locations_org_policy_violations_previews_operations_get: + organizations_locations_access_policy_simulations_operations_get: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1orgPolicyViolationsPreviews~1{orgPolicyViolationsPreviewsId}~1operations~1{operationsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1accessPolicySimulations~1{accessPolicySimulationsId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_replays_operations_list: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1replays~1{replaysId}~1operations/get response: mediaType: application/json openAPIDocKey: '200' - folders_locations_replays_operations_list: + objectKey: $.operations + organizations_locations_replays_operations_get: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1replays~1{replaysId}~1operations/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1replays~1{replaysId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.operations - folders_locations_replays_operations_get: + organizations_locations_org_policy_violations_previews_operations_get: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1replays~1{replaysId}~1operations~1{operationsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1orgPolicyViolationsPreviews~1{orgPolicyViolationsPreviewsId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_replays_operations_get - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_org_policy_violations_previews_operations_get - $ref: >- - #/components/x-stackQL-resources/operations/methods/organizations_locations_org_policy_violations_previews_operations_get + #/components/x-stackQL-resources/operations/methods/projects_locations_access_policy_simulations_operations_get - $ref: >- - #/components/x-stackQL-resources/operations/methods/organizations_locations_replays_operations_get + #/components/x-stackQL-resources/operations/methods/projects_locations_replays_operations_get - $ref: >- #/components/x-stackQL-resources/operations/methods/folders_locations_org_policy_violations_previews_operations_get + - $ref: >- + #/components/x-stackQL-resources/operations/methods/folders_locations_access_policy_simulations_operations_get - $ref: >- #/components/x-stackQL-resources/operations/methods/folders_locations_replays_operations_get - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_replays_operations_list + #/components/x-stackQL-resources/operations/methods/organizations_locations_access_policy_simulations_operations_get - $ref: >- - #/components/x-stackQL-resources/operations/methods/organizations_locations_replays_operations_list + #/components/x-stackQL-resources/operations/methods/organizations_locations_replays_operations_get + - $ref: >- + #/components/x-stackQL-resources/operations/methods/organizations_locations_org_policy_violations_previews_operations_get + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_locations_replays_operations_list - $ref: >- #/components/x-stackQL-resources/operations/methods/folders_locations_replays_operations_list + - $ref: >- + #/components/x-stackQL-resources/operations/methods/organizations_locations_replays_operations_list - $ref: '#/components/x-stackQL-resources/operations/methods/operations_get' - $ref: >- #/components/x-stackQL-resources/operations/methods/operations_list @@ -2010,45 +2048,45 @@ components: name: replays title: Replays methods: - projects_locations_replays_create: + projects_locations_replays_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1replays/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1replays~1{replaysId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_replays_get: + projects_locations_replays_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1replays~1{replaysId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1replays/post response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_replays_create: + folders_locations_replays_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1replays/post + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1replays~1{replaysId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_replays_get: + folders_locations_replays_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1replays~1{replaysId}/get + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1replays/post response: mediaType: application/json openAPIDocKey: '200' - folders_locations_replays_get: + organizations_locations_replays_get: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1replays~1{replaysId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1replays~1{replaysId}/get response: mediaType: application/json openAPIDocKey: '200' - folders_locations_replays_create: + organizations_locations_replays_create: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1replays/post + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1replays/post response: mediaType: application/json openAPIDocKey: '200' @@ -2056,17 +2094,17 @@ components: select: - $ref: >- #/components/x-stackQL-resources/replays/methods/projects_locations_replays_get - - $ref: >- - #/components/x-stackQL-resources/replays/methods/organizations_locations_replays_get - $ref: >- #/components/x-stackQL-resources/replays/methods/folders_locations_replays_get + - $ref: >- + #/components/x-stackQL-resources/replays/methods/organizations_locations_replays_get insert: - $ref: >- #/components/x-stackQL-resources/replays/methods/projects_locations_replays_create - - $ref: >- - #/components/x-stackQL-resources/replays/methods/organizations_locations_replays_create - $ref: >- #/components/x-stackQL-resources/replays/methods/folders_locations_replays_create + - $ref: >- + #/components/x-stackQL-resources/replays/methods/organizations_locations_replays_create update: [] replace: [] delete: [] @@ -2083,18 +2121,18 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.replayResults - organizations_locations_replays_results_list: + folders_locations_replays_results_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1replays~1{replaysId}~1results/get + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1replays~1{replaysId}~1results/get response: mediaType: application/json openAPIDocKey: '200' objectKey: $.replayResults - folders_locations_replays_results_list: + organizations_locations_replays_results_list: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1replays~1{replaysId}~1results/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1replays~1{replaysId}~1results/get response: mediaType: application/json openAPIDocKey: '200' @@ -2103,10 +2141,70 @@ components: select: - $ref: >- #/components/x-stackQL-resources/results/methods/projects_locations_replays_results_list + - $ref: >- + #/components/x-stackQL-resources/results/methods/folders_locations_replays_results_list - $ref: >- #/components/x-stackQL-resources/results/methods/organizations_locations_replays_results_list + insert: [] + update: [] + replace: [] + delete: [] + org_policy_violations_previews: + id: google.policysimulator.org_policy_violations_previews + name: org_policy_violations_previews + title: Org_policy_violations_previews + methods: + organizations_locations_org_policy_violations_previews_list: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1orgPolicyViolationsPreviews/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.orgPolicyViolationsPreviews + organizations_locations_org_policy_violations_previews_create: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1orgPolicyViolationsPreviews/post + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_org_policy_violations_previews_get: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1orgPolicyViolationsPreviews~1{orgPolicyViolationsPreviewsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: - $ref: >- - #/components/x-stackQL-resources/results/methods/folders_locations_replays_results_list + #/components/x-stackQL-resources/org_policy_violations_previews/methods/organizations_locations_org_policy_violations_previews_get + - $ref: >- + #/components/x-stackQL-resources/org_policy_violations_previews/methods/organizations_locations_org_policy_violations_previews_list + insert: + - $ref: >- + #/components/x-stackQL-resources/org_policy_violations_previews/methods/organizations_locations_org_policy_violations_previews_create + update: [] + replace: [] + delete: [] + org_policy_violations: + id: google.policysimulator.org_policy_violations + name: org_policy_violations + title: Org_policy_violations + methods: + organizations_locations_org_policy_violations_previews_org_policy_violations_list: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1orgPolicyViolationsPreviews~1{orgPolicyViolationsPreviewsId}~1orgPolicyViolations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.orgPolicyViolations + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/org_policy_violations/methods/organizations_locations_org_policy_violations_previews_org_policy_violations_list insert: [] update: [] replace: [] @@ -2114,22 +2212,165 @@ components: paths: /v1/operations: parameters: &ref_1 - - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/_.xgafv' + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: policysimulator.operations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + parameters: + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: policysimulator.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreviewsId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: >- + policysimulator.projects.locations.orgPolicyViolationsPreviews.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: orgPolicyViolationsPreviewsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/accessPolicySimulations/{accessPolicySimulationsId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: >- + policysimulator.projects.locations.accessPolicySimulations.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: accessPolicySimulationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/replays/{replaysId}: + parameters: *ref_1 get: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: policysimulator.operations.list + Gets the specified Replay. Each `Replay` is available for at least 7 + days. + operationId: policysimulator.projects.locations.replays.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2141,29 +2382,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1Replay' parameters: - - in: query - name: pageSize + - in: path + name: projectsId + required: true schema: - type: integer - format: int32 - - in: query - name: pageToken + type: string + - in: path + name: locationsId + required: true schema: type: string - - in: query - name: filter + - in: path + name: replaysId + required: true schema: type: string - /v1/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/replays: parameters: *ref_1 - get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: policysimulator.operations.get + post: + description: Creates and starts a Replay using the given ReplayConfig. + operationId: policysimulator.projects.locations.replays.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1Replay' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2178,20 +2423,22 @@ paths: $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path - name: operationsId + name: projectsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/replays: + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/replays/{replaysId}/operations: parameters: *ref_1 - post: - description: Creates and starts a Replay using the given ReplayConfig. - operationId: policysimulator.projects.locations.replays.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1Replay' + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: policysimulator.projects.locations.replays.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2203,7 +2450,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -2215,13 +2462,32 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/replays/{replaysId}: + - in: path + name: replaysId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/replays/{replaysId}/operations/{operationsId}: parameters: *ref_1 get: description: >- - Gets the specified Replay. Each `Replay` is available for at least 7 - days. - operationId: policysimulator.projects.locations.replays.get + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: policysimulator.projects.locations.replays.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2233,7 +2499,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1Replay' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -2250,6 +2516,11 @@ paths: required: true schema: type: string + - in: path + name: operationsId + required: true + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/replays/{replaysId}/results: parameters: *ref_1 get: @@ -2293,13 +2564,164 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/replays/{replaysId}/operations: + /v1/folders/{foldersId}/locations/{locationsId}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreviewsId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: >- + policysimulator.folders.locations.orgPolicyViolationsPreviews.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: foldersId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: orgPolicyViolationsPreviewsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/folders/{foldersId}/locations/{locationsId}/accessPolicySimulations/{accessPolicySimulationsId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: policysimulator.folders.locations.accessPolicySimulations.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: foldersId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: accessPolicySimulationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/folders/{foldersId}/locations/{locationsId}/replays/{replaysId}: + parameters: *ref_1 + get: + description: >- + Gets the specified Replay. Each `Replay` is available for at least 7 + days. + operationId: policysimulator.folders.locations.replays.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1Replay' + parameters: + - in: path + name: foldersId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: replaysId + required: true + schema: + type: string + /v1/folders/{foldersId}/locations/{locationsId}/replays: + parameters: *ref_1 + post: + description: Creates and starts a Replay using the given ReplayConfig. + operationId: policysimulator.folders.locations.replays.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1Replay' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: foldersId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/folders/{foldersId}/locations/{locationsId}/replays/{replaysId}/operations: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: policysimulator.projects.locations.replays.operations.list + operationId: policysimulator.folders.locations.replays.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2314,7 +2736,7 @@ paths: $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string @@ -2332,23 +2754,23 @@ paths: name: filter schema: type: string - - in: query - name: pageToken - schema: - type: string - in: query name: pageSize schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/replays/{replaysId}/operations/{operationsId}: + - in: query + name: pageToken + schema: + type: string + /v1/folders/{foldersId}/locations/{locationsId}/replays/{replaysId}/operations/{operationsId}: parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - operationId: policysimulator.projects.locations.replays.operations.get + operationId: policysimulator.folders.locations.replays.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2363,7 +2785,7 @@ paths: $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string @@ -2382,15 +2804,11 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreviewsId}/operations/{operationsId}: + /v1/folders/{foldersId}/locations/{locationsId}/replays/{replaysId}/results: parameters: *ref_1 get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: >- - policysimulator.projects.locations.orgPolicyViolationsPreviews.operations.get + description: Lists the results of running a Replay. + operationId: policysimulator.folders.locations.replays.results.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2402,10 +2820,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1ListReplayResultsResponse parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string @@ -2415,16 +2834,20 @@ paths: schema: type: string - in: path - name: orgPolicyViolationsPreviewsId + name: replaysId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreviewsId}/operations/{operationsId}: + /v1/organizations/{organizationsId}/locations/{locationsId}/accessPolicySimulations/{accessPolicySimulationsId}/operations/{operationsId}: parameters: *ref_1 get: description: >- @@ -2432,7 +2855,7 @@ paths: method to poll the operation result at intervals as recommended by the API service. operationId: >- - policysimulator.organizations.locations.orgPolicyViolationsPreviews.operations.get + policysimulator.organizations.locations.accessPolicySimulations.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2457,7 +2880,7 @@ paths: schema: type: string - in: path - name: orgPolicyViolationsPreviewsId + name: accessPolicySimulationsId required: true schema: type: string @@ -2466,14 +2889,13 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/replays/{replaysId}/operations/{operationsId}: + /v1/organizations/{organizationsId}/locations/{locationsId}/replays/{replaysId}: parameters: *ref_1 get: description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: policysimulator.organizations.locations.replays.operations.get + Gets the specified Replay. Each `Replay` is available for at least 7 + days. + operationId: policysimulator.organizations.locations.replays.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2485,7 +2907,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1Replay' parameters: - in: path name: organizationsId @@ -2502,18 +2924,16 @@ paths: required: true schema: type: string - - in: path - name: operationsId - required: true - schema: - type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/replays/{replaysId}/operations: + /v1/organizations/{organizationsId}/locations/{locationsId}/replays: parameters: *ref_1 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: policysimulator.organizations.locations.replays.operations.list + post: + description: Creates and starts a Replay using the given ReplayConfig. + operationId: policysimulator.organizations.locations.replays.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1Replay' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2525,7 +2945,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -2537,29 +2957,13 @@ paths: required: true schema: type: string - - in: path - name: replaysId - required: true - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/replays/{replaysId}/results: + /v1/organizations/{organizationsId}/locations/{locationsId}/replays/{replaysId}/operations: parameters: *ref_1 get: - description: Lists the results of running a Replay. - operationId: policysimulator.organizations.locations.replays.results.list + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: policysimulator.organizations.locations.replays.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2571,8 +2975,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1ListReplayResultsResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: organizationsId @@ -2590,7 +2993,7 @@ paths: schema: type: string - in: query - name: pageToken + name: filter schema: type: string - in: query @@ -2598,46 +3001,18 @@ paths: schema: type: integer format: int32 - /v1/organizations/{organizationsId}/locations/{locationsId}/replays: - parameters: *ref_1 - post: - description: Creates and starts a Replay using the given ReplayConfig. - operationId: policysimulator.organizations.locations.replays.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1Replay' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true + - in: query + name: pageToken schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/replays/{replaysId}: + /v1/organizations/{organizationsId}/locations/{locationsId}/replays/{replaysId}/operations/{operationsId}: parameters: *ref_1 get: description: >- - Gets the specified Replay. Each `Replay` is available for at least 7 - days. - operationId: policysimulator.organizations.locations.replays.get + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: policysimulator.organizations.locations.replays.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2649,7 +3024,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1Replay' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -2666,15 +3041,16 @@ paths: required: true schema: type: string - /v1/folders/{foldersId}/locations/{locationsId}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreviewsId}/operations/{operationsId}: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/replays/{replaysId}/results: parameters: *ref_1 get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: >- - policysimulator.folders.locations.orgPolicyViolationsPreviews.operations.get + description: Lists the results of running a Replay. + operationId: policysimulator.organizations.locations.replays.results.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2686,10 +3062,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1ListReplayResultsResponse parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string @@ -2699,22 +3076,27 @@ paths: schema: type: string - in: path - name: orgPolicyViolationsPreviewsId + name: replaysId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/folders/{foldersId}/locations/{locationsId}/replays/{replaysId}: + /v1/organizations/{organizationsId}/locations/{locationsId}/orgPolicyViolationsPreviews: parameters: *ref_1 get: description: >- - Gets the specified Replay. Each `Replay` is available for at least 7 - days. - operationId: policysimulator.folders.locations.replays.get + ListOrgPolicyViolationsPreviews lists each OrgPolicyViolationsPreview in + an organization. Each OrgPolicyViolationsPreview is available for at + least 7 days. + operationId: policysimulator.organizations.locations.orgPolicyViolationsPreviews.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2726,10 +3108,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1Replay' + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1ListOrgPolicyViolationsPreviewsResponse parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string @@ -2738,21 +3121,30 @@ paths: required: true schema: type: string - - in: path - name: replaysId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/folders/{foldersId}/locations/{locationsId}/replays: - parameters: *ref_1 post: - description: Creates and starts a Replay using the given ReplayConfig. - operationId: policysimulator.folders.locations.replays.create + description: >- + CreateOrgPolicyViolationsPreview creates an OrgPolicyViolationsPreview + for the proposed changes in the provided + OrgPolicyViolationsPreview.OrgPolicyOverlay. The changes to OrgPolicy + are specified by this `OrgPolicyOverlay`. The resources to scan are + inferred from these specified changes. + operationId: >- + policysimulator.organizations.locations.orgPolicyViolationsPreviews.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1Replay' + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1OrgPolicyViolationsPreview security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2767,7 +3159,7 @@ paths: $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string @@ -2776,13 +3168,18 @@ paths: required: true schema: type: string - /v1/folders/{foldersId}/locations/{locationsId}/replays/{replaysId}/operations: + - in: query + name: orgPolicyViolationsPreviewId + schema: + type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreviewsId}: parameters: *ref_1 get: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: policysimulator.folders.locations.replays.operations.list + GetOrgPolicyViolationsPreview gets the specified + OrgPolicyViolationsPreview. Each OrgPolicyViolationsPreview is available + for at least 7 days. + operationId: policysimulator.organizations.locations.orgPolicyViolationsPreviews.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2794,10 +3191,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1OrgPolicyViolationsPreview parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string @@ -2807,31 +3205,19 @@ paths: schema: type: string - in: path - name: replaysId + name: orgPolicyViolationsPreviewsId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/folders/{foldersId}/locations/{locationsId}/replays/{replaysId}/operations/{operationsId}: + /v1/organizations/{organizationsId}/locations/{locationsId}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreviewsId}/operations/{operationsId}: parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - operationId: policysimulator.folders.locations.replays.operations.get + operationId: >- + policysimulator.organizations.locations.orgPolicyViolationsPreviews.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2846,7 +3232,7 @@ paths: $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string @@ -2856,7 +3242,7 @@ paths: schema: type: string - in: path - name: replaysId + name: orgPolicyViolationsPreviewsId required: true schema: type: string @@ -2865,11 +3251,14 @@ paths: required: true schema: type: string - /v1/folders/{foldersId}/locations/{locationsId}/replays/{replaysId}/results: + /v1/organizations/{organizationsId}/locations/{locationsId}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreviewsId}/orgPolicyViolations: parameters: *ref_1 get: - description: Lists the results of running a Replay. - operationId: policysimulator.folders.locations.replays.results.list + description: >- + ListOrgPolicyViolations lists the OrgPolicyViolations that are present + in an OrgPolicyViolationsPreview. + operationId: >- + policysimulator.organizations.locations.orgPolicyViolationsPreviews.orgPolicyViolations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2882,10 +3271,10 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1ListReplayResultsResponse + #/components/schemas/GoogleCloudPolicysimulatorV1ListOrgPolicyViolationsResponse parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string @@ -2895,7 +3284,7 @@ paths: schema: type: string - in: path - name: replaysId + name: orgPolicyViolationsPreviewsId required: true schema: type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/policytroubleshooter.yaml b/providers/src/googleapis.com/v00.00.00000/services/policytroubleshooter.yaml index d53d7700..969c8fa5 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/policytroubleshooter.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/policytroubleshooter.yaml @@ -7,8 +7,8 @@ info: title: Policy Troubleshooter API description: '' version: v1 - x-discovery-doc-revision: '20241103' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250825' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/iam/ servers: @@ -35,60 +35,18 @@ components: scopes: *ref_0 schemas: GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyRequest: - type: object + id: GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyRequest description: Request for TroubleshootIamPolicy. + type: object properties: accessTuple: - $ref: '#/components/schemas/GoogleCloudPolicytroubleshooterV1AccessTuple' description: >- The information to use for checking whether a principal has a permission for a resource. - id: GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyRequest - GoogleTypeExpr: - properties: - expression: - description: >- - Textual representation of an expression in Common Expression - Language syntax. - type: string - location: - type: string - description: >- - Optional. String indicating the location of the expression for error - reporting, e.g. a file name and a position in the file. - 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 - 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 - 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. - type: object - id: GoogleTypeExpr + $ref: '#/components/schemas/GoogleCloudPolicytroubleshooterV1AccessTuple' GoogleCloudPolicytroubleshooterV1AccessTuple: - description: Information about the principal, resource, and permission to check. id: GoogleCloudPolicytroubleshooterV1AccessTuple + description: Information about the principal, resource, and permission to check. type: object properties: principal: @@ -100,6 +58,14 @@ components: principal must be a Google Account or a service account. Other types of principals are not supported. type: string + fullResourceName: + description: >- + Required. The full resource name that identifies the resource. For + example, + `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. + For examples of full resource names for Google Cloud services, see + https://cloud.google.com/iam/help/troubleshooter/full-resource-names. + type: string permission: description: >- Required. The IAM permission to check for the specified principal @@ -108,73 +74,127 @@ components: complete list of predefined IAM roles and the permissions in each role, see https://cloud.google.com/iam/help/roles/reference. type: string - fullResourceName: - type: string - description: >- - Required. The full resource name that identifies the resource. For - example, - `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. - For examples of full resource names for Google Cloud services, see - https://cloud.google.com/iam/help/troubleshooter/full-resource-names. - GoogleIamV1Policy: + GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyResponse: + id: GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyResponse + description: Response for TroubleshootIamPolicy. + type: object properties: - etag: + access: 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. + Indicates whether the principal has the specified permission for the + specified resource, based on evaluating all of the applicable IAM + policies. type: string - format: byte - version: - format: int32 + enumDescriptions: + - Default value. This value is unused. + - The principal has the permission. + - The principal does not have the permission. + - >- + The principal has the permission only if a condition expression + evaluates to `true`. + - >- + The sender of the request does not have access to all of the + policies that Policy Troubleshooter needs to evaluate. + enum: + - ACCESS_STATE_UNSPECIFIED + - GRANTED + - NOT_GRANTED + - UNKNOWN_CONDITIONAL + - UNKNOWN_INFO_DENIED + explainedPolicies: 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). - type: integer - bindings: + List of IAM policies that were evaluated to check the principal's + permissions, with annotations to indicate how each policy + contributed to the final result. The list of policies can include + the policy for the resource itself. It can also include policies + that are inherited from higher levels of the resource hierarchy, + including the organization, the folder, and the project. To learn + more about the resource hierarchy, see + https://cloud.google.com/iam/help/resource-hierarchy. type: array items: - $ref: '#/components/schemas/GoogleIamV1Binding' + $ref: >- + #/components/schemas/GoogleCloudPolicytroubleshooterV1ExplainedPolicy + errors: + description: The general errors contained in the troubleshooting response. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudPolicytroubleshooterV1ExplainedPolicy: + id: GoogleCloudPolicytroubleshooterV1ExplainedPolicy + description: Details about how a specific IAM Policy contributed to the access check. + type: object + properties: + access: description: >- - Associates a list of `members`, or principals, with a `role`. - Optionally, may specify a `condition` that determines how and when - the `bindings` are applied. Each of the `bindings` must contain at - least one principal. The `bindings` in a `Policy` can refer to up to - 1,500 principals; up to 250 of these principals can be Google - groups. Each occurrence of a principal counts towards these limits. - For example, if the `bindings` grant 50 different roles to - `user:alice@example.com`, and not to any other principal, then you - can add another 1,450 principals to the `bindings` in the `Policy`. - auditConfigs: + Indicates whether _this policy_ provides the specified permission to + the specified principal for the specified resource. This field does + _not_ indicate whether the principal actually has the permission for + the resource. There might be another policy that overrides this + policy. To determine whether the principal actually has the + permission, use the `access` field in the + TroubleshootIamPolicyResponse. + type: string + enumDescriptions: + - Default value. This value is unused. + - The principal has the permission. + - The principal does not have the permission. + - >- + The principal has the permission only if a condition expression + evaluates to `true`. + - >- + The sender of the request does not have access to all of the + policies that Policy Troubleshooter needs to evaluate. + enum: + - ACCESS_STATE_UNSPECIFIED + - GRANTED + - NOT_GRANTED + - UNKNOWN_CONDITIONAL + - UNKNOWN_INFO_DENIED + fullResourceName: + description: >- + The full resource name that identifies the resource. For example, + `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. + If the sender of the request does not have access to the policy, + this field is omitted. For examples of full resource names for + Google Cloud services, see + https://cloud.google.com/iam/help/troubleshooter/full-resource-names. + type: string + policy: + description: >- + The IAM policy attached to the resource. If the sender of the + request does not have access to the policy, this field is empty. + $ref: '#/components/schemas/GoogleIamV1Policy' + bindingExplanations: + description: >- + Details about how each binding in the policy affects the principal's + ability, or inability, to use the permission for the resource. If + the sender of the request does not have access to the policy, this + field is omitted. type: array items: - $ref: '#/components/schemas/GoogleIamV1AuditConfig' - description: Specifies cloud audit logging configuration for this policy. + $ref: >- + #/components/schemas/GoogleCloudPolicytroubleshooterV1BindingExplanation + relevance: + description: >- + The relevance of this policy to the overall determination in the + TroubleshootIamPolicyResponse. If the sender of the request does not + have access to the policy, this field is omitted. + type: string + enumDescriptions: + - Default value. This value is unused. + - >- + The data point has a limited effect on the result. Changing the + data point is unlikely to affect the overall determination. + - >- + The data point has a strong effect on the result. Changing the + data point is likely to affect the overall determination. + enum: + - HEURISTIC_RELEVANCE_UNSPECIFIED + - NORMAL + - HIGH + GoogleIamV1Policy: id: GoogleIamV1Policy - type: object description: >- An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of @@ -209,11 +229,273 @@ components: 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/). - GoogleCloudPolicytroubleshooterV1BindingExplanation: type: object + properties: + 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). + type: integer + format: int32 + bindings: + description: >- + Associates a list of `members`, or principals, with a `role`. + Optionally, may specify a `condition` that determines how and when + the `bindings` are applied. Each of the `bindings` must contain at + least one principal. The `bindings` in a `Policy` can refer to up to + 1,500 principals; up to 250 of these principals can be Google + groups. Each occurrence of a principal counts towards these limits. + For example, if the `bindings` grant 50 different roles to + `user:alice@example.com`, and not to any other principal, then you + can add another 1,450 principals to the `bindings` in the `Policy`. + type: array + items: + $ref: '#/components/schemas/GoogleIamV1Binding' + auditConfigs: + description: Specifies cloud audit logging configuration for this policy. + type: array + items: + $ref: '#/components/schemas/GoogleIamV1AuditConfig' + 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. + type: string + format: byte + GoogleIamV1Binding: + id: GoogleIamV1Binding + description: Associates `members`, or principals, with a `role`. + type: object + properties: + role: + description: >- + Role that is assigned to the list of `members`, or principals. For + example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an + overview of the IAM roles and permissions, see the [IAM + documentation](https://cloud.google.com/iam/docs/roles-overview). + For a list of the available pre-defined roles, see + [here](https://cloud.google.com/iam/docs/understanding-roles). + type: string + members: + description: >- + Specifies the principals requesting access for a Google Cloud + 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. Does not include identities + that come from external identity providers (IdPs) through identity + federation. * `user:{emailid}`: An email address that represents a + specific Google account. For example, `alice@example.com` . * + `serviceAccount:{emailid}`: An email address that represents a + Google service account. For example, + `my-other-app@appspot.gserviceaccount.com`. * + `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: + An identifier for a [Kubernetes service + account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). + For example, + `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * + `group:{emailid}`: An email address that represents a Google group. + For example, `admins@example.com`. * `domain:{domain}`: The G Suite + domain (primary) that represents all the users of that domain. For + example, `google.com` or `example.com`. * + `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workforce identity pool. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: + All workforce identities in a group. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All workforce identities with a specific attribute value. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: + All identities in a workforce identity pool. * + `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workload identity pool. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: + A workload identity pool group. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All identities in a workload identity pool with a certain attribute. + * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: + All identities in a workload identity pool. * + `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. * + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + Deleted single identity in a workforce identity pool. For example, + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + type: array + items: + type: string + condition: + description: >- + The condition that is associated with this binding. If the condition + evaluates to `true`, then this binding applies to the current + request. If the condition evaluates to `false`, then this binding + does not apply to the current request. However, a different role + binding might grant the same role to one or more of the principals + in this binding. To learn which resources support conditions in + their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + $ref: '#/components/schemas/GoogleTypeExpr' + GoogleTypeExpr: + id: GoogleTypeExpr + 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. + type: object + properties: + expression: + description: >- + Textual representation of an expression in Common Expression + Language syntax. + 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 + 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 + 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 + GoogleIamV1AuditConfig: + id: GoogleIamV1AuditConfig + 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. + type: object + properties: + 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 + auditLogConfigs: + description: The configuration for logging of each type of permission. + type: array + items: + $ref: '#/components/schemas/GoogleIamV1AuditLogConfig' + GoogleIamV1AuditLogConfig: + id: GoogleIamV1AuditLogConfig + 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. + type: object + properties: + logType: + description: The log type that this config enables. + type: string + enumDescriptions: + - Default case. Should never be this. + - 'Admin reads. Example: CloudIAM getIamPolicy' + - 'Data writes. Example: CloudSQL Users create' + - 'Data reads. Example: CloudSQL Users list' + enum: + - LOG_TYPE_UNSPECIFIED + - ADMIN_READ + - DATA_WRITE + - DATA_READ + exemptedMembers: + description: >- + Specifies the identities that do not cause logging for this type of + permission. Follows the same format of Binding.members. + type: array + items: + type: string + GoogleCloudPolicytroubleshooterV1BindingExplanation: id: GoogleCloudPolicytroubleshooterV1BindingExplanation + description: >- + Details about how a binding in a policy affects a principal's ability to + use a permission. + type: object properties: access: + description: >- + Required. Indicates whether _this binding_ provides the specified + permission to the specified principal for the specified resource. + This field does _not_ indicate whether the principal actually has + the permission for the resource. There might be another binding that + overrides this binding. To determine whether the principal actually + has the permission, use the `access` field in the + TroubleshootIamPolicyResponse. + type: string enumDescriptions: - Default value. This value is unused. - The principal has the permission. @@ -224,95 +506,39 @@ components: - >- The sender of the request does not have access to all of the policies that Policy Troubleshooter needs to evaluate. - description: >- - Required. Indicates whether _this binding_ provides the specified - permission to the specified principal for the specified resource. - This field does _not_ indicate whether the principal actually has - the permission for the resource. There might be another binding that - overrides this binding. To determine whether the principal actually - has the permission, use the `access` field in the - TroubleshootIamPolicyResponse. - type: string enum: - ACCESS_STATE_UNSPECIFIED - GRANTED - NOT_GRANTED - UNKNOWN_CONDITIONAL - UNKNOWN_INFO_DENIED - memberships: - type: object - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudPolicytroubleshooterV1BindingExplanationAnnotatedMembership - description: >- - Indicates whether each principal in the binding includes the - principal specified in the request, either directly or indirectly. - Each key identifies a principal in the binding, and each value - indicates whether the principal in the binding includes the - principal in the request. For example, suppose that a binding - includes the following principals: * `user:alice@example.com` * - `group:product-eng@example.com` You want to troubleshoot access for - `user:bob@example.com`. This user is a principal of the group - `group:product-eng@example.com`. For the first principal in the - binding, the key is `user:alice@example.com`, and the `membership` - field in the value is set to `MEMBERSHIP_NOT_INCLUDED`. For the - second principal in the binding, the key is - `group:product-eng@example.com`, and the `membership` field in the - value is set to `MEMBERSHIP_INCLUDED`. - condition: - description: >- - A condition expression that prevents this binding from granting - access unless the expression evaluates to `true`. To learn about IAM - Conditions, see - https://cloud.google.com/iam/help/conditions/overview. - $ref: '#/components/schemas/GoogleTypeExpr' - relevance: - enumDescriptions: - - Default value. This value is unused. - - >- - The data point has a limited effect on the result. Changing the - data point is unlikely to affect the overall determination. - - >- - The data point has a strong effect on the result. Changing the - data point is likely to affect the overall determination. - type: string - description: >- - The relevance of this binding to the overall determination for the - entire policy. - enum: - - HEURISTIC_RELEVANCE_UNSPECIFIED - - NORMAL - - HIGH role: - type: string description: >- The role that this binding grants. For example, `roles/compute.serviceAgent`. For a complete list of predefined IAM roles, as well as the permissions in each role, see https://cloud.google.com/iam/help/roles/reference. + type: string rolePermission: + description: >- + Indicates whether the role granted by this binding contains the + specified permission. + type: string enumDescriptions: - Default value. This value is unused. - The permission is included in the role. - The permission is not included in the role. - The sender of the request is not allowed to access the binding. - type: string - description: >- - Indicates whether the role granted by this binding contains the - specified permission. enum: - ROLE_PERMISSION_UNSPECIFIED - ROLE_PERMISSION_INCLUDED - ROLE_PERMISSION_NOT_INCLUDED - ROLE_PERMISSION_UNKNOWN_INFO_DENIED rolePermissionRelevance: - enum: - - HEURISTIC_RELEVANCE_UNSPECIFIED - - NORMAL - - HIGH description: >- The relevance of the permission's existence, or nonexistence, in the role to the overall determination for the entire policy. + type: string enumDescriptions: - Default value. This value is unused. - >- @@ -321,59 +547,35 @@ components: - >- The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination. - type: string - description: >- - Details about how a binding in a policy affects a principal's ability to - use a permission. - GoogleIamV1AuditLogConfig: - id: GoogleIamV1AuditLogConfig - 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: - logType: enum: - - LOG_TYPE_UNSPECIFIED - - ADMIN_READ - - DATA_WRITE - - DATA_READ - enumDescriptions: - - Default case. Should never be this. - - 'Admin reads. Example: CloudIAM getIamPolicy' - - 'Data writes. Example: CloudSQL Users create' - - 'Data reads. Example: CloudSQL Users list' - description: The log type that this config enables. - type: string - exemptedMembers: - type: array - 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: object - GoogleCloudPolicytroubleshooterV1ExplainedPolicy: - type: object - description: Details about how a specific IAM Policy contributed to the access check. - properties: - bindingExplanations: - type: array + - HEURISTIC_RELEVANCE_UNSPECIFIED + - NORMAL + - HIGH + memberships: description: >- - Details about how each binding in the policy affects the principal's - ability, or inability, to use the permission for the resource. If - the sender of the request does not have access to the policy, this - field is omitted. - items: + Indicates whether each principal in the binding includes the + principal specified in the request, either directly or indirectly. + Each key identifies a principal in the binding, and each value + indicates whether the principal in the binding includes the + principal in the request. For example, suppose that a binding + includes the following principals: * `user:alice@example.com` * + `group:product-eng@example.com` You want to troubleshoot access for + `user:bob@example.com`. This user is a principal of the group + `group:product-eng@example.com`. For the first principal in the + binding, the key is `user:alice@example.com`, and the `membership` + field in the value is set to `MEMBERSHIP_NOT_INCLUDED`. For the + second principal in the binding, the key is + `group:product-eng@example.com`, and the `membership` field in the + value is set to `MEMBERSHIP_INCLUDED`. + type: object + additionalProperties: $ref: >- - #/components/schemas/GoogleCloudPolicytroubleshooterV1BindingExplanation + #/components/schemas/GoogleCloudPolicytroubleshooterV1BindingExplanationAnnotatedMembership relevance: description: >- - The relevance of this policy to the overall determination in the - TroubleshootIamPolicyResponse. If the sender of the request does not - have access to the policy, this field is omitted. + The relevance of this binding to the overall determination for the + entire policy. + type: string enumDescriptions: - Default value. This value is unused. - >- @@ -382,107 +584,22 @@ components: - >- The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination. - type: string enum: - HEURISTIC_RELEVANCE_UNSPECIFIED - NORMAL - HIGH - policy: - description: >- - The IAM policy attached to the resource. If the sender of the - request does not have access to the policy, this field is empty. - $ref: '#/components/schemas/GoogleIamV1Policy' - fullResourceName: - type: string - description: >- - The full resource name that identifies the resource. For example, - `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. - If the sender of the request does not have access to the policy, - this field is omitted. For examples of full resource names for - Google Cloud services, see - https://cloud.google.com/iam/help/troubleshooter/full-resource-names. - access: - type: string - enum: - - ACCESS_STATE_UNSPECIFIED - - GRANTED - - NOT_GRANTED - - UNKNOWN_CONDITIONAL - - UNKNOWN_INFO_DENIED - description: >- - Indicates whether _this policy_ provides the specified permission to - the specified principal for the specified resource. This field does - _not_ indicate whether the principal actually has the permission for - the resource. There might be another policy that overrides this - policy. To determine whether the principal actually has the - permission, use the `access` field in the - TroubleshootIamPolicyResponse. - enumDescriptions: - - Default value. This value is unused. - - The principal has the permission. - - The principal does not have the permission. - - >- - The principal has the permission only if a condition expression - evaluates to `true`. - - >- - The sender of the request does not have access to all of the - policies that Policy Troubleshooter needs to evaluate. - id: GoogleCloudPolicytroubleshooterV1ExplainedPolicy - GoogleIamV1AuditConfig: - id: GoogleIamV1AuditConfig - 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. - type: object - properties: - service: - type: string + condition: 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. - auditLogConfigs: - items: - $ref: '#/components/schemas/GoogleIamV1AuditLogConfig' - description: The configuration for logging of each type of permission. - type: array + A condition expression that prevents this binding from granting + access unless the expression evaluates to `true`. To learn about IAM + Conditions, see + https://cloud.google.com/iam/help/conditions/overview. + $ref: '#/components/schemas/GoogleTypeExpr' GoogleCloudPolicytroubleshooterV1BindingExplanationAnnotatedMembership: - description: Details about whether the binding includes the principal. id: GoogleCloudPolicytroubleshooterV1BindingExplanationAnnotatedMembership + description: Details about whether the binding includes the principal. type: object properties: - relevance: - description: >- - The relevance of the principal's status to the overall determination - for the binding. - enum: - - HEURISTIC_RELEVANCE_UNSPECIFIED - - NORMAL - - HIGH - type: string - enumDescriptions: - - Default value. This value is unused. - - >- - The data point has a limited effect on the result. Changing the - data point is unlikely to affect the overall determination. - - >- - The data point has a strong effect on the result. Changing the - data point is likely to affect the overall determination. membership: description: Indicates whether the binding includes the principal. type: string @@ -505,6 +622,23 @@ components: - MEMBERSHIP_NOT_INCLUDED - MEMBERSHIP_UNKNOWN_INFO_DENIED - MEMBERSHIP_UNKNOWN_UNSUPPORTED + relevance: + description: >- + The relevance of the principal's status to the overall determination + for the binding. + type: string + enumDescriptions: + - Default value. This value is unused. + - >- + The data point has a limited effect on the result. Changing the + data point is unlikely to affect the overall determination. + - >- + The data point has a strong effect on the result. Changing the + data point is likely to affect the overall determination. + enum: + - HEURISTIC_RELEVANCE_UNSPECIFIED + - NORMAL + - HIGH GoogleRpcStatus: id: GoogleRpcStatus description: >- @@ -515,203 +649,70 @@ components: details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). + type: object properties: code: description: The status code, which should be an enum value of google.rpc.Code. type: integer format: int32 - details: - items: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: array - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. message: description: >- A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. type: string - type: object - GoogleIamV1Binding: - properties: - condition: - description: >- - The condition that is associated with this binding. If the condition - evaluates to `true`, then this binding applies to the current - request. If the condition evaluates to `false`, then this binding - does not apply to the current request. However, a different role - binding might grant the same role to one or more of the principals - in this binding. To learn which resources support conditions in - their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - $ref: '#/components/schemas/GoogleTypeExpr' - members: - description: >- - Specifies the principals requesting access for a Google Cloud - 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. Does not include identities - that come from external identity providers (IdPs) through identity - federation. * `user:{emailid}`: An email address that represents a - specific Google account. For example, `alice@example.com` . * - `serviceAccount:{emailid}`: An email address that represents a - Google service account. For example, - `my-other-app@appspot.gserviceaccount.com`. * - `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: - An identifier for a [Kubernetes service - account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). - For example, - `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * - `group:{emailid}`: An email address that represents a Google group. - For example, `admins@example.com`. * `domain:{domain}`: The G Suite - domain (primary) that represents all the users of that domain. For - example, `google.com` or `example.com`. * - `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workforce identity pool. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: - All workforce identities in a group. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All workforce identities with a specific attribute value. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: - All identities in a workforce identity pool. * - `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workload identity pool. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: - A workload identity pool group. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All identities in a workload identity pool with a certain attribute. - * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: - All identities in a workload identity pool. * - `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. * - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - Deleted single identity in a workforce identity pool. For example, - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. - items: - type: string - type: array - role: - description: >- - Role that is assigned to the list of `members`, or principals. For - example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an - overview of the IAM roles and permissions, see the [IAM - documentation](https://cloud.google.com/iam/docs/roles-overview). - For a list of the available pre-defined roles, see - [here](https://cloud.google.com/iam/docs/understanding-roles). - type: string - id: GoogleIamV1Binding - description: Associates `members`, or principals, with a `role`. - type: object - GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyResponse: - properties: - access: + details: description: >- - Indicates whether the principal has the specified permission for the - specified resource, based on evaluating all of the applicable IAM - policies. - enum: - - ACCESS_STATE_UNSPECIFIED - - GRANTED - - NOT_GRANTED - - UNKNOWN_CONDITIONAL - - UNKNOWN_INFO_DENIED - enumDescriptions: - - Default value. This value is unused. - - The principal has the permission. - - The principal does not have the permission. - - >- - The principal has the permission only if a condition expression - evaluates to `true`. - - >- - The sender of the request does not have access to all of the - policies that Policy Troubleshooter needs to evaluate. - type: string - errors: - description: The general errors contained in the troubleshooting response. - items: - $ref: '#/components/schemas/GoogleRpcStatus' - type: array - explainedPolicies: + A list of messages that carry the error details. There is a common + set of message types for APIs to use. type: array items: - $ref: >- - #/components/schemas/GoogleCloudPolicytroubleshooterV1ExplainedPolicy - description: >- - List of IAM policies that were evaluated to check the principal's - permissions, with annotations to indicate how each policy - contributed to the final result. The list of policies can include - the policy for the resource itself. It can also include policies - that are inherited from higher levels of the resource hierarchy, - including the organization, the folder, and the project. To learn - more about the resource hierarchy, see - https://cloud.google.com/iam/help/resource-hierarchy. - description: Response for TroubleshootIamPolicy. - type: object - id: GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyResponse + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. parameters: - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + access_token: + description: OAuth access token. in: query - name: uploadType + name: access_token schema: type: string - callback: - description: JSONP + alt: + description: Data format for response. in: query - name: callback + name: alt schema: type: string - _.xgafv: - description: V1 error format. + enum: + - json + - media + - proto + callback: + description: JSONP in: query - name: $.xgafv + name: callback schema: type: string - enum: - - '1' - - '2' - access_token: - description: OAuth access token. + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: access_token + name: fields schema: type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + 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: upload_protocol + name: key schema: type: string - 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. + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: quotaUser + name: oauth_token schema: type: string prettyPrint: @@ -720,37 +721,36 @@ components: name: prettyPrint schema: type: boolean - alt: - description: Data format for response. + 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: alt + name: quotaUser schema: type: string - enum: - - json - - media - - proto - oauth_token: - description: OAuth 2.0 token for the current user. + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: oauth_token + name: upload_protocol 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. + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: key + name: uploadType schema: type: string - fields: - description: Selector specifying which fields to include in a partial response. + _.xgafv: + description: V1 error format. in: query - name: fields + name: $.xgafv schema: type: string + enum: + - '1' + - '2' x-stackQL-resources: iam: id: google.policytroubleshooter.iam @@ -772,17 +772,17 @@ components: paths: /v1/iam:troubleshoot: parameters: - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' post: description: >- Checks whether a principal has a specific permission for a specific diff --git a/providers/src/googleapis.com/v00.00.00000/services/pollen.yaml b/providers/src/googleapis.com/v00.00.00000/services/pollen.yaml index afa6dd6c..6f15126c 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/pollen.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/pollen.yaml @@ -7,8 +7,8 @@ info: title: Pollen API description: 'The Pollen API. ' version: v1 - x-discovery-doc-revision: '20241030' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250826' + x-generated-date: '2025-08-28' externalDocs: url: https://developers.google.com/maps/documentation/pollen servers: @@ -34,325 +34,163 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - PlantInfo: - properties: - indexInfo: - description: >- - This object contains data representing specific pollen index value, - category and description. - $ref: '#/components/schemas/IndexInfo' - plantDescription: - $ref: '#/components/schemas/PlantDescription' - description: >- - Contains general information about plants, including details on - their seasonality, special shapes and colors, information about - allergic cross-reactions, and plant photos. - code: - enum: - - PLANT_UNSPECIFIED - - ALDER - - ASH - - BIRCH - - COTTONWOOD - - ELM - - MAPLE - - OLIVE - - JUNIPER - - OAK - - PINE - - CYPRESS_PINE - - HAZEL - - GRAMINALES - - RAGWEED - - MUGWORT - - JAPANESE_CEDAR - - JAPANESE_CYPRESS - description: >- - The plant code name. For example: "COTTONWOOD". A list of all - available codes could be found here. - type: string - enumDescriptions: - - Unspecified plant code. - - Alder is classified as a tree pollen type. - - Ash is classified as a tree pollen type. - - Birch is classified as a tree pollen type. - - Cottonwood is classified as a tree pollen type. - - Elm is classified as a tree pollen type. - - Maple is classified as a tree pollen type. - - Olive is classified as a tree pollen type. - - Juniper is classified as a tree pollen type. - - Oak is classified as a tree pollen type. - - Pine is classified as a tree pollen type. - - Cypress pine is classified as a tree pollen type. - - Hazel is classified as a tree pollen type. - - Graminales is classified as a grass pollen type. - - Ragweed is classified as a weed pollen type. - - Mugwort is classified as a weed pollen type. - - Japanese cedar is classified as a tree pollen type. - - Japanese cypress is classified as a tree pollen type. - displayName: - type: string - description: >- - A human readable representation of the plant name. Example: - “Cottonwood". - inSeason: - description: Indication of either the plant is in season or not. - type: boolean - type: object - id: PlantInfo - description: This object contains the daily information on specific plant. - PlantDescription: - type: object - description: >- - Contains general information about plants, including details on their - seasonality, special shapes and colors, information about allergic - cross-reactions, and plant photos. - properties: - season: - description: >- - Textual list of explanations of seasons where the pollen is active. - Example: "Late winter, spring". - type: string - specialShapes: - type: string - description: >- - Textual description of the plants' shapes of leaves, bark, flowers - or seeds that helps identify the plant. - specialColors: - type: string - description: >- - Textual description of the plants' colors of leaves, bark, flowers - or seeds that helps identify the plant. - picture: - description: Link to the picture of the plant. - type: string - type: - description: >- - The plant's pollen type. For example: "GRASS". A list of all - available codes could be found here. - enum: - - POLLEN_TYPE_UNSPECIFIED - - GRASS - - TREE - - WEED - enumDescriptions: - - Unspecified plant type. - - Grass pollen type. - - Tree pollen type. - - Weed pollen type. - type: string - family: - description: >- - A human readable representation of the plant family name. Example: - "Betulaceae (the Birch family)". - type: string - crossReaction: - type: string - description: >- - Textual description of pollen cross reaction plants. Example: Alder, - Hazel, Hornbeam, Beech, Willow, and Oak pollen. - pictureCloseup: - description: Link to a closeup picture of the plant. - type: string - id: PlantDescription - PollenTypeInfo: - properties: - indexInfo: - description: Contains the Universal Pollen Index (UPI) data for the pollen type. - $ref: '#/components/schemas/IndexInfo' - healthRecommendations: - description: >- - Textual list of explanations, related to health insights based on - the current pollen levels. - type: array - items: - type: string - code: - type: string - enum: - - POLLEN_TYPE_UNSPECIFIED - - GRASS - - TREE - - WEED - description: 'The pollen type''s code name. For example: "GRASS"' - enumDescriptions: - - Unspecified plant type. - - Grass pollen type. - - Tree pollen type. - - Weed pollen type. - inSeason: - type: boolean - description: Indication whether the plant is in season or not. - displayName: - description: >- - A human readable representation of the pollen type name. Example: - "Grass" - type: string - description: >- - This object contains the pollen type index and health recommendation - information on specific pollen type. - type: object - id: PollenTypeInfo LookupForecastResponse: id: LookupForecastResponse type: object properties: - dailyInfo: - type: array - description: >- - Required. This object contains the daily forecast information for - each day requested. - items: - $ref: '#/components/schemas/DayInfo' regionCode: - type: string description: >- The ISO_3166-1 alpha-2 code of the country/region corresponding to the location provided in the request. This field might be omitted from the response if the location provided in the request resides in a disputed territory. - nextPageToken: type: string + dailyInfo: + description: >- + Required. This object contains the daily forecast information for + each day requested. + type: array + items: + $ref: '#/components/schemas/DayInfo' + nextPageToken: description: Optional. The token to retrieve the next page. - HttpBody: - id: HttpBody + type: string + DayInfo: + id: DayInfo description: >- - Message that represents an arbitrary HTTP body. It should only be used - for payload formats that can't be represented as JSON, such as raw - binary or an HTML page. This message can be used both in streaming and - non-streaming API methods in the request as well as the response. It can - be used as a top-level request field, which is convenient if one wants - to extract parameters from either the URL or HTTP template into the - request fields and also want access to the raw HTTP body. Example: - message GetResourceRequest { // A unique request id. string request_id = - 1; // The raw HTTP body is bound to this field. google.api.HttpBody - http_body = 2; } service ResourceService { rpc - GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc - UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } - Example with streaming methods: service CaldavService { rpc - GetCalendar(stream google.api.HttpBody) returns (stream - google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) - returns (stream google.api.HttpBody); } Use of this type only changes - how the request and response bodies are handled, all other features will - continue to work unchanged. + This object contains the daily forecast information for each day + requested. + type: object properties: - contentType: + date: + description: The date in UTC at which the pollen forecast data is represented. + $ref: '#/components/schemas/Date' + pollenTypeInfo: description: >- - The HTTP Content-Type header value specifying the content type of - the body. - type: string - data: - format: byte - type: string - description: The HTTP request/response body as raw binary. - extensions: - items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object + This list will include up to three pollen types (GRASS, WEED, TREE) + affecting the location specified in the request. type: array + items: + $ref: '#/components/schemas/PollenTypeInfo' + plantInfo: description: >- - Application specific response metadata. Must be set in the first - response for streaming APIs. - type: object + This list will include up to 15 pollen species affecting the + location specified in the request. + type: array + items: + $ref: '#/components/schemas/PlantInfo' Date: + id: Date + description: >- + Represents a whole or partial calendar date, such as a birthday. The + time of day and time zone are either specified elsewhere or are + insignificant. The date is relative to the Gregorian Calendar. This can + represent one of the following: * A full date, with non-zero year, + month, and day values. * A month and day, with a zero year (for example, + an anniversary). * A year on its own, with a zero month and a zero day. + * A year and month, with a zero day (for example, a credit card + expiration date). Related types: * google.type.TimeOfDay * + google.type.DateTime * google.protobuf.Timestamp type: object properties: - day: - format: int32 + year: description: >- - Day of a month. Must be from 1 to 31 and valid for the year and - month, or 0 to specify a year by itself or a year and month where - the day isn't significant. + Year of the date. Must be from 1 to 9999, or 0 to specify a date + without a year. type: integer - month: format: int32 + month: description: >- Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. type: integer - year: format: int32 + day: + description: >- + Day of a month. Must be from 1 to 31 and valid for the year and + month, or 0 to specify a year by itself or a year and month where + the day isn't significant. + type: integer + format: int32 + PollenTypeInfo: + id: PollenTypeInfo + description: >- + This object contains the pollen type index and health recommendation + information on specific pollen type. + type: object + properties: + code: + description: 'The pollen type''s code name. For example: "GRASS"' + type: string + enumDescriptions: + - Unspecified plant type. + - Grass pollen type. + - Tree pollen type. + - Weed pollen type. + enum: + - POLLEN_TYPE_UNSPECIFIED + - GRASS + - TREE + - WEED + displayName: + description: >- + A human readable representation of the pollen type name. Example: + "Grass" + type: string + inSeason: + description: Indication whether the plant is in season or not. + type: boolean + indexInfo: + description: Contains the Universal Pollen Index (UPI) data for the pollen type. + $ref: '#/components/schemas/IndexInfo' + healthRecommendations: description: >- - Year of the date. Must be from 1 to 9999, or 0 to specify a date - without a year. - type: integer - id: Date - description: >- - Represents a whole or partial calendar date, such as a birthday. The - time of day and time zone are either specified elsewhere or are - insignificant. The date is relative to the Gregorian Calendar. This can - represent one of the following: * A full date, with non-zero year, - month, and day values. * A month and day, with a zero year (for example, - an anniversary). * A year on its own, with a zero month and a zero day. - * A year and month, with a zero day (for example, a credit card - expiration date). Related types: * google.type.TimeOfDay * - google.type.DateTime * google.protobuf.Timestamp + Textual list of explanations, related to health insights based on + the current pollen levels. + type: array + items: + type: string IndexInfo: + id: IndexInfo + description: >- + This object contains data representing specific pollen index value, + category and description. + type: object properties: code: + description: >- + The index's code. This field represents the index for programming + purposes by using snake cases instead of spaces. Example: "UPI". type: string - enum: - - INDEX_UNSPECIFIED - - UPI enumDescriptions: - Unspecified index. - Universal Pollen Index. - description: >- - The index's code. This field represents the index for programming - purposes by using snake cases instead of spaces. Example: "UPI". + enum: + - INDEX_UNSPECIFIED + - UPI displayName: - type: string description: >- A human readable representation of the index name. Example: "Universal Pollen Index". + type: string value: + description: The index's numeric score. Numeric range is between 0 and 5. type: integer format: int32 - description: The index's numeric score. Numeric range is between 0 and 5. category: - type: string description: >- Text classification of index numerical score interpretation. The index consists of six categories: * 0: "None" * 1: "Very low" * 2: "Low" * 3: "Moderate" * 4: "High" * 5: "Very high - color: - description: The color used to represent the Pollen Index numeric score. - $ref: '#/components/schemas/Color' + type: string indexDescription: description: Textual explanation of current index level. type: string - description: >- - This object contains data representing specific pollen index value, - category and description. - id: IndexInfo - type: object - DayInfo: - id: DayInfo - type: object - properties: - date: - $ref: '#/components/schemas/Date' - description: The date in UTC at which the pollen forecast data is represented. - plantInfo: - description: >- - This list will include up to 15 pollen species affecting the - location specified in the request. - items: - $ref: '#/components/schemas/PlantInfo' - type: array - pollenTypeInfo: - type: array - items: - $ref: '#/components/schemas/PollenTypeInfo' - description: >- - This list will include up to three pollen types (GRASS, WEED, TREE) - affecting the location specified in the request. - description: >- - This object contains the daily forecast information for each day - requested. + color: + description: The color used to represent the Pollen Index numeric score. + $ref: '#/components/schemas/Color' Color: + id: Color description: >- Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations @@ -406,71 +244,231 @@ components: resultBuilder.join(''); }; // ... type: object properties: - blue: - type: number - description: The amount of blue in the color as a value in the interval [0, 1]. - format: float - alpha: - format: float + red: + description: The amount of red in the color as a value in the interval [0, 1]. + type: number + format: float + green: + description: The amount of green in the color as a value in the interval [0, 1]. + type: number + format: float + blue: + description: The amount of blue in the color as a value in the interval [0, 1]. + type: number + format: float + alpha: + description: >- + The fraction of this color that should be applied to the pixel. That + is, the final pixel color is defined by the equation: `pixel color = + alpha * (this color) + (1.0 - alpha) * (background color)` This + means that a value of 1.0 corresponds to a solid color, whereas a + value of 0.0 corresponds to a completely transparent color. This + uses a wrapper message rather than a simple float scalar so that it + is possible to distinguish between a default value and the value + being unset. If omitted, this color object is rendered as a solid + color (as if the alpha value had been explicitly given a value of + 1.0). + type: number + format: float + PlantInfo: + id: PlantInfo + description: This object contains the daily information on specific plant. + type: object + properties: + code: + description: >- + The plant code name. For example: "COTTONWOOD". A list of all + available codes could be found here. + type: string + enumDescriptions: + - Unspecified plant code. + - Alder is classified as a tree pollen type. + - Ash is classified as a tree pollen type. + - Birch is classified as a tree pollen type. + - Cottonwood is classified as a tree pollen type. + - Elm is classified as a tree pollen type. + - Maple is classified as a tree pollen type. + - Olive is classified as a tree pollen type. + - Juniper is classified as a tree pollen type. + - Oak is classified as a tree pollen type. + - Pine is classified as a tree pollen type. + - Cypress pine is classified as a tree pollen type. + - Hazel is classified as a tree pollen type. + - Graminales is classified as a grass pollen type. + - Ragweed is classified as a weed pollen type. + - Mugwort is classified as a weed pollen type. + - Japanese cedar is classified as a tree pollen type. + - Japanese cypress is classified as a tree pollen type. + enum: + - PLANT_UNSPECIFIED + - ALDER + - ASH + - BIRCH + - COTTONWOOD + - ELM + - MAPLE + - OLIVE + - JUNIPER + - OAK + - PINE + - CYPRESS_PINE + - HAZEL + - GRAMINALES + - RAGWEED + - MUGWORT + - JAPANESE_CEDAR + - JAPANESE_CYPRESS + displayName: + description: >- + A human readable representation of the plant name. Example: + “Cottonwood". + type: string + inSeason: + description: Indication of either the plant is in season or not. + type: boolean + indexInfo: + description: >- + This object contains data representing specific pollen index value, + category and description. + $ref: '#/components/schemas/IndexInfo' + plantDescription: + description: >- + Contains general information about plants, including details on + their seasonality, special shapes and colors, information about + allergic cross-reactions, and plant photos. + $ref: '#/components/schemas/PlantDescription' + PlantDescription: + id: PlantDescription + description: >- + Contains general information about plants, including details on their + seasonality, special shapes and colors, information about allergic + cross-reactions, and plant photos. + type: object + properties: + type: + description: >- + The plant's pollen type. For example: "GRASS". A list of all + available codes could be found here. + type: string + enumDescriptions: + - Unspecified plant type. + - Grass pollen type. + - Tree pollen type. + - Weed pollen type. + enum: + - POLLEN_TYPE_UNSPECIFIED + - GRASS + - TREE + - WEED + family: + description: >- + A human readable representation of the plant family name. Example: + "Betulaceae (the Birch family)". + type: string + season: + description: >- + Textual list of explanations of seasons where the pollen is active. + Example: "Late winter, spring". + type: string + specialColors: + description: >- + Textual description of the plants' colors of leaves, bark, flowers + or seeds that helps identify the plant. + type: string + specialShapes: + description: >- + Textual description of the plants' shapes of leaves, bark, flowers + or seeds that helps identify the plant. + type: string + crossReaction: + description: >- + Textual description of pollen cross reaction plants. Example: Alder, + Hazel, Hornbeam, Beech, Willow, and Oak pollen. + type: string + picture: + description: Link to the picture of the plant. + type: string + pictureCloseup: + description: Link to a closeup picture of the plant. + type: string + HttpBody: + id: HttpBody + description: >- + Message that represents an arbitrary HTTP body. It should only be used + for payload formats that can't be represented as JSON, such as raw + binary or an HTML page. This message can be used both in streaming and + non-streaming API methods in the request as well as the response. It can + be used as a top-level request field, which is convenient if one wants + to extract parameters from either the URL or HTTP template into the + request fields and also want access to the raw HTTP body. Example: + message GetResourceRequest { // A unique request id. string request_id = + 1; // The raw HTTP body is bound to this field. google.api.HttpBody + http_body = 2; } service ResourceService { rpc + GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc + UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } + Example with streaming methods: service CaldavService { rpc + GetCalendar(stream google.api.HttpBody) returns (stream + google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) + returns (stream google.api.HttpBody); } Use of this type only changes + how the request and response bodies are handled, all other features will + continue to work unchanged. + type: object + properties: + contentType: description: >- - The fraction of this color that should be applied to the pixel. That - is, the final pixel color is defined by the equation: `pixel color = - alpha * (this color) + (1.0 - alpha) * (background color)` This - means that a value of 1.0 corresponds to a solid color, whereas a - value of 0.0 corresponds to a completely transparent color. This - uses a wrapper message rather than a simple float scalar so that it - is possible to distinguish between a default value and the value - being unset. If omitted, this color object is rendered as a solid - color (as if the alpha value had been explicitly given a value of - 1.0). - type: number - green: - format: float - type: number - description: The amount of green in the color as a value in the interval [0, 1]. - red: - description: The amount of red in the color as a value in the interval [0, 1]. - type: number - format: float - id: Color + The HTTP Content-Type header value specifying the content type of + the body. + type: string + data: + description: The HTTP request/response body as raw binary. + type: string + format: byte + extensions: + description: >- + Application specific response metadata. Must be set in the first + response for streaming APIs. + type: array + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. parameters: - callback: - description: JSONP + access_token: + description: OAuth access token. in: query - name: callback + name: access_token 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. + alt: + description: Data format for response. in: query - name: key + name: alt schema: type: string - _.xgafv: - description: V1 error format. + enum: + - json + - media + - proto + callback: + description: JSONP in: query - name: $.xgafv + name: callback schema: type: string - enum: - - '1' - - '2' - 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. + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: quotaUser + name: fields schema: type: string - access_token: - description: OAuth access token. + 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: access_token + name: key schema: type: string oauth_token: @@ -485,44 +483,45 @@ components: name: prettyPrint schema: type: boolean - fields: - description: Selector specifying which fields to include in a partial response. + 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: fields + name: quotaUser schema: type: string - alt: - description: Data format for response. + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: alt + name: upload_protocol schema: type: string - enum: - - json - - media - - proto 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"). + _.xgafv: + description: V1 error format. in: query - name: upload_protocol + name: $.xgafv schema: type: string + enum: + - '1' + - '2' x-stackQL-resources: - heatmap_tiles: - id: google.pollen.heatmap_tiles - name: heatmap_tiles - title: Heatmap_tiles + forecast: + id: google.pollen.forecast + name: forecast + title: Forecast methods: - lookup_heatmap_tile: + lookup: operation: - $ref: >- - #/paths/~1v1~1mapTypes~1{mapType}~1heatmapTiles~1{zoom}~1{x}~1{y}/get + $ref: '#/paths/~1v1~1forecast:lookup/get' response: mediaType: application/json openAPIDocKey: '200' @@ -532,14 +531,15 @@ components: update: [] replace: [] delete: [] - forecast: - id: google.pollen.forecast - name: forecast - title: Forecast + heatmap_tiles: + id: google.pollen.heatmap_tiles + name: heatmap_tiles + title: Heatmap_tiles methods: - lookup: + lookup_heatmap_tile: operation: - $ref: '#/paths/~1v1~1forecast:lookup/get' + $ref: >- + #/paths/~1v1~1mapTypes~1{mapType}~1heatmapTiles~1{zoom}~1{x}~1{y}/get response: mediaType: application/json openAPIDocKey: '200' @@ -550,22 +550,24 @@ components: replace: [] delete: [] paths: - /v1/mapTypes/{mapType}/heatmapTiles/{zoom}/{x}/{y}: + /v1/forecast:lookup: parameters: &ref_1 + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' get: - description: Returns a byte array containing the data of the tile PNG image. - operationId: pollen.mapTypes.heatmapTiles.lookupHeatmapTile + description: >- + Returns up to 5 days of daily pollen information in more than 65 + countries, up to 1km resolution. + operationId: pollen.forecast.lookup security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -577,35 +579,45 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/HttpBody' + $ref: '#/components/schemas/LookupForecastResponse' parameters: - - in: path - name: mapType - required: true + - in: query + name: location.latitude schema: - type: string - - in: path - name: zoom - required: true + type: number + format: double + - in: query + name: location.longitude schema: - type: string - - in: path - name: x - required: true + type: number + format: double + - in: query + name: days + schema: + type: integer + format: int32 + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - - in: path - name: 'y' - required: true + - in: query + name: languageCode schema: type: string - /v1/forecast:lookup: + - in: query + name: plantsDescription + schema: + type: boolean + /v1/mapTypes/{mapType}/heatmapTiles/{zoom}/{x}/{y}: parameters: *ref_1 get: - description: >- - Returns up to 5 days of daily pollen information in more than 65 - countries, up to 1km resolution. - operationId: pollen.forecast.lookup + description: Returns a byte array containing the data of the tile PNG image. + operationId: pollen.mapTypes.heatmapTiles.lookupHeatmapTile security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -617,37 +629,25 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LookupForecastResponse' + $ref: '#/components/schemas/HttpBody' parameters: - - in: query - name: location.longitude - schema: - type: number - format: double - - in: query - name: languageCode + - in: path + name: mapType + required: true schema: type: string - - in: query - name: pageToken + - in: path + name: zoom + required: true schema: type: string - - in: query - name: days - schema: - type: integer - format: int32 - - in: query - name: plantsDescription - schema: - type: boolean - - in: query - name: location.latitude + - in: path + name: x + required: true schema: - type: number - format: double - - in: query - name: pageSize + type: string + - in: path + name: 'y' + required: true schema: - type: integer - format: int32 + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/privateca.yaml b/providers/src/googleapis.com/v00.00.00000/services/privateca.yaml index f7f722cc..a79259ea 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/privateca.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/privateca.yaml @@ -11,8 +11,8 @@ info: certificate authorities (CAs) while staying in control of your private keys. version: v1 - x-discovery-doc-revision: '20241023' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250625' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/ servers: @@ -207,9 +207,8 @@ components: properties: name: description: >- - Output only. The resource name for this Certificate in the format + Identifier. The resource name for this Certificate in the format `projects/*/locations/*/caPools/*/certificates/*`. - readOnly: true type: string pemCsr: description: Immutable. A pem-encoded X.509 certificate signing request (CSR). @@ -257,6 +256,14 @@ components: certificate's Subject and/or SubjectAltNames are specified in the certificate request. This mode requires the caller to have the `privateca.certificates.create` permission. + - >- + A mode used to get an accurate representation of the Subject + field's distinguished name. Indicates that the certificate's + Subject and/or SubjectAltNames are specified in the certificate + request. When parsing a PEM CSR this mode will maintain the + sequence of RDNs found in the CSR's subject field in the issued + Certificate. This mode requires the caller to have the + `privateca.certificates.create` permission. - >- A mode reserved for special cases. Indicates that the certificate should have one SPIFFE SubjectAltNames set by the service based on @@ -267,6 +274,7 @@ components: enum: - SUBJECT_REQUEST_MODE_UNSPECIFIED - DEFAULT + - RDN_SEQUENCE - REFLECTED_SPIFFE revocationDetails: description: >- @@ -385,6 +393,74 @@ components: postalCode: description: The postal code of the subject. type: string + rdnSequence: + description: This field can be used in place of the named subject fields. + type: array + items: + $ref: '#/components/schemas/RelativeDistinguishedName' + RelativeDistinguishedName: + id: RelativeDistinguishedName + description: >- + RelativeDistinguishedName specifies a relative distinguished name which + will be used to build a distinguished name. + type: object + properties: + attributes: + description: Attributes describes the attribute value assertions in the RDN. + type: array + items: + $ref: '#/components/schemas/AttributeTypeAndValue' + AttributeTypeAndValue: + id: AttributeTypeAndValue + description: >- + AttributeTypeAndValue specifies an attribute type and value. It can use + either a OID or enum value to specify the attribute type. + type: object + properties: + type: + description: The attribute type of the attribute and value pair. + type: string + enumDescriptions: + - Attribute type is unspecified. + - The "common name" of the subject. + - The country code of the subject. + - The organization of the subject. + - The organizational unit of the subject. + - The locality or city of the subject. + - The province, territory, or regional state of the subject. + - The street address of the subject. + - The postal code of the subject. + enum: + - ATTRIBUTE_TYPE_UNSPECIFIED + - COMMON_NAME + - COUNTRY_CODE + - ORGANIZATION + - ORGANIZATIONAL_UNIT + - LOCALITY + - PROVINCE + - STREET_ADDRESS + - POSTAL_CODE + objectId: + description: Object ID for an attribute type of an attribute and value pair. + $ref: '#/components/schemas/ObjectId' + value: + description: The value for the attribute type. + type: string + ObjectId: + id: ObjectId + description: >- + An ObjectId specifies an object identifier (OID). These provide context + and describe types in ASN.1 messages. + type: object + properties: + objectIdPath: + description: >- + Required. The parts of an OID path. The most significant parts of + the path come first. + type: array + items: + type: integer + format: int32 SubjectAltNames: id: SubjectAltNames description: >- @@ -443,21 +519,6 @@ components: description: Required. The value of this X.509 extension. type: string format: byte - ObjectId: - id: ObjectId - description: >- - An ObjectId specifies an object identifier (OID). These provide context - and describe types in ASN.1 messages. - type: object - properties: - objectIdPath: - description: >- - Required. The parts of an OID path. The most significant parts of - the path come first. - type: array - items: - type: integer - format: int32 X509Parameters: id: X509Parameters description: >- @@ -912,7 +973,7 @@ components: nextPageToken: description: >- A token to retrieve next page of results. Pass this value in - ListCertificatesRequest.next_page_token to retrieve the next page of + ListCertificatesRequest.page_token to retrieve the next page of results. type: string unreachable: @@ -1051,10 +1112,8 @@ components: properties: name: description: >- - Output only. Identifier. The resource name for this - CertificateAuthority in the format - `projects/*/locations/*/caPools/*/certificateAuthorities/*`. - readOnly: true + Identifier. The resource name for this CertificateAuthority in the + format `projects/*/locations/*/caPools/*/certificateAuthorities/*`. type: string type: description: Required. Immutable. The Type of this CertificateAuthority. @@ -1212,6 +1271,12 @@ components: type: object additionalProperties: type: string + userDefinedAccessUrls: + description: >- + Optional. User-defined URLs for CA certificate and CRLs. The service + does not publish content to these URLs. It is up to the user to + mirror content to these URLs. + $ref: '#/components/schemas/UserDefinedAccessUrls' satisfiesPzs: description: Output only. Reserved for future use. readOnly: true @@ -1276,6 +1341,31 @@ components: type: array items: type: string + UserDefinedAccessUrls: + id: UserDefinedAccessUrls + description: >- + User-defined URLs for accessing content published by this + CertificateAuthority. + type: object + properties: + aiaIssuingCertificateUrls: + description: >- + Optional. A list of URLs where the issuer CA certificate may be + downloaded, which appears in the "Authority Information Access" + extension in the certificate. If specified, the default Cloud + Storage URLs will be omitted. + type: array + items: + type: string + crlAccessUrls: + description: >- + Optional. A list of URLs where to obtain CRL information, i.e. the + DistributionPoint.fullName described by + https://tools.ietf.org/html/rfc5280#section-4.2.1.13. If specified, + the default Cloud Storage URLs will be omitted. + type: array + items: + type: string DisableCertificateAuthorityRequest: id: DisableCertificateAuthorityRequest description: >- @@ -1355,8 +1445,8 @@ components: nextPageToken: description: >- A token to retrieve next page of results. Pass this value in - ListCertificateAuthoritiesRequest.next_page_token to retrieve the - next page of results. + ListCertificateAuthoritiesRequest.page_token to retrieve the next + page of results. type: string unreachable: description: A list of locations (e.g. "us-west1") that could not be reached. @@ -1396,9 +1486,8 @@ components: properties: name: description: >- - Output only. Identifier. The resource name for this CaPool in the - format `projects/*/locations/*/caPools/*`. - readOnly: true + Identifier. The resource name for this CaPool in the format + `projects/*/locations/*/caPools/*`. type: string tier: description: Required. Immutable. The Tier of this CaPool. @@ -1439,6 +1528,17 @@ components: type: array items: $ref: '#/components/schemas/AllowedKeyType' + backdateDuration: + description: >- + Optional. The duration to backdate all certificates issued from this + CaPool. If not set, the certificates will be issued with a + not_before_time of the issuance time (i.e. the current time). If + set, the certificates will be issued with a not_before_time of the + issuance time minus the backdate_duration. The not_after_time will + be adjusted to preserve the requested lifetime. The + backdate_duration must be less than or equal to 48 hours. + type: string + format: google-duration maximumLifetime: description: >- Optional. The maximum lifetime allowed for issued Certificates. Note @@ -1747,8 +1847,8 @@ components: nextPageToken: description: >- A token to retrieve next page of results. Pass this value in - ListCertificateAuthoritiesRequest.next_page_token to retrieve the - next page of results. + ListCertificateAuthoritiesRequest.page_token to retrieve the next + page of results. type: string unreachable: description: A list of locations (e.g. "us-west1") that could not be reached. @@ -1806,11 +1906,10 @@ components: properties: name: description: >- - Output only. The resource name for this CertificateRevocationList in + Identifier. The resource name for this CertificateRevocationList in the format `projects/*/locations/*/caPools/*certificateAuthorities/*/ certificateRevocationLists/*`. - readOnly: true type: string sequenceNumber: description: Output only. The CRL sequence number that appears in pem_crl. @@ -1933,8 +2032,8 @@ components: nextPageToken: description: >- A token to retrieve next page of results. Pass this value in - ListCertificateRevocationListsRequest.next_page_token to retrieve - the next page of results. + ListCertificateRevocationListsRequest.page_token to retrieve the + next page of results. type: string unreachable: description: A list of locations (e.g. "us-west1") that could not be reached. @@ -1950,9 +2049,8 @@ components: properties: name: description: >- - Output only. The resource name for this CertificateTemplate in the + Identifier. The resource name for this CertificateTemplate in the format `projects/*/locations/*/certificateTemplates/*`. - readOnly: true type: string maximumLifetime: description: >- @@ -2028,8 +2126,8 @@ components: nextPageToken: description: >- A token to retrieve next page of results. Pass this value in - ListCertificateTemplatesRequest.next_page_token to retrieve the next - page of results. + ListCertificateTemplatesRequest.page_token to retrieve the next page + of results. type: string unreachable: description: A list of locations (e.g. "us-west1") that could not be reached. @@ -2359,8 +2457,8 @@ components: description: >- Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled - have Operation.error value with a google.rpc.Status.code of 1, - corresponding to `Code.CANCELLED`. + have google.longrunning.Operation.error value with a + google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. readOnly: true type: boolean apiVersion: @@ -3021,6 +3119,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: @@ -3175,7 +3277,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: privateca.projects.locations.operations.cancel requestBody: content: diff --git a/providers/src/googleapis.com/v00.00.00000/services/prod_tt_sasportal.yaml b/providers/src/googleapis.com/v00.00.00000/services/prod_tt_sasportal.yaml index 63bbe752..3382876a 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/prod_tt_sasportal.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/prod_tt_sasportal.yaml @@ -7,8 +7,8 @@ info: title: SAS Portal API (Testing) description: '' version: v1alpha1 - x-discovery-doc-revision: '20241103' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250826' + x-generated-date: '2025-08-28' externalDocs: url: https://developers.google.com/spectrum-access-system/ servers: @@ -22,10 +22,10 @@ components: implicit: authorizationUrl: https://accounts.google.com/o/oauth2/auth scopes: &ref_0 - https://www.googleapis.com/auth/sasportal: Read, create, update, and delete your SAS Portal data. 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/sasportal: Read, create, update, and delete your SAS Portal data. Oauth2c: type: oauth2 description: Oauth 2.0 authorization code authentication @@ -35,201 +35,182 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - SasPortalSetPolicyRequest: + SasPortalCustomer: + id: SasPortalCustomer + description: Entity representing a SAS customer. type: object - id: SasPortalSetPolicyRequest - description: Request message for `SetPolicy` method. properties: - policy: - $ref: '#/components/schemas/SasPortalPolicy' - description: Required. The policy to be applied to the `resource`. - resource: + name: + description: Output only. Resource name of the customer. type: string + displayName: description: >- - Required. The resource for which the policy is being specified. This - policy replaces any existing policy. - disableNotification: - type: boolean - description: >- - Optional. Set the field as `true` to disable the onboarding - notification. - SasPortalListDevicesResponse: + Required. Name of the organization that the customer entity + represents. + type: string + sasUserIds: + description: User IDs used by the devices belonging to this customer. + type: array + items: + type: string + SasPortalListCustomersResponse: + id: SasPortalListCustomersResponse + description: Response for `ListCustomers`. type: object - id: SasPortalListDevicesResponse - description: Response for ListDevices. properties: + customers: + description: The list of customers that match the request. + type: array + items: + $ref: '#/components/schemas/SasPortalCustomer' nextPageToken: description: >- - A pagination token returned from a previous call to ListDevices that - indicates from where listing should continue. If the field is - missing or empty, it means there is no more devices. + A pagination token returned from a previous call to ListCustomers + that indicates from where listing should continue. If the field is + missing or empty, it means there are no more customers. type: string - devices: - description: The devices that match the request. - items: - $ref: '#/components/schemas/SasPortalDevice' - type: array - SasPortalSetupSasAnalyticsMetadata: + SasPortalListGcpProjectDeploymentsResponse: + id: SasPortalListGcpProjectDeploymentsResponse + description: Response for [ListGcpProjectDeployments]. type: object - id: SasPortalSetupSasAnalyticsMetadata - properties: {} + properties: + deployments: + description: Optional. Deployments associated with the GCP project + type: array + items: + $ref: '#/components/schemas/SasPortalGcpProjectDeployment' + SasPortalGcpProjectDeployment: + id: SasPortalGcpProjectDeployment description: >- - Metadata returned by the long running operation for the - SetupSasAnalytics rpc. - SasPortalValidateInstallerResponse: - id: SasPortalValidateInstallerResponse + Deployment associated with the GCP project. Includes whether SAS + analytics has been enabled or not. type: object - description: Response for ValidateInstaller. - properties: {} - SasPortalDevice: + properties: + hasEnabledAnalytics: + description: Whether SAS analytics has been enabled. + type: boolean + deployment: + description: Deployment associated with the GCP project. + $ref: '#/components/schemas/SasPortalDeployment' + SasPortalDeployment: + id: SasPortalDeployment + description: The Deployment. type: object - id: SasPortalDevice properties: - state: - description: Output only. Device state. - enum: - - DEVICE_STATE_UNSPECIFIED - - RESERVED - - REGISTERED - - DEREGISTERED - enumDescriptions: - - Unspecified state. - - >- - Device created in the SAS Portal, however, not yet registered with - SAS. - - Device registered with SAS. - - Device de-registered with SAS. - type: string - grantRangeAllowlists: - items: - $ref: '#/components/schemas/SasPortalFrequencyRange' - type: array - description: >- - Only ranges that are within the allowlists are available for new - grants. - fccId: - description: >- - The FCC identifier of the device. Refer to - https://www.fcc.gov/oet/ea/fccid for FccID format. Accept - underscores and periods because some test-SAS customers use them. + name: + description: Output only. Resource name. + readOnly: true type: string - serialNumber: + displayName: + description: The deployment's display name. type: string - description: A serial number assigned to the device by the device manufacturer. - currentChannels: - description: Output only. Current channels with scores. - items: - $ref: '#/components/schemas/SasPortalChannelWithScore' - deprecated: true - readOnly: true - type: array - deviceMetadata: + sasUserIds: description: >- - Device parameters that can be overridden by both SAS Portal and SAS - registration requests. - $ref: '#/components/schemas/SasPortalDeviceMetadata' - activeConfig: + User ID used by the devices belonging to this deployment. Each + deployment should be associated with one unique user ID. + type: array + items: + type: string + frns: description: >- - Output only. Current configuration of the device as registered to - the SAS. - $ref: '#/components/schemas/SasPortalDeviceConfig' - preloadedConfig: - description: Configuration of the device, as specified via SAS Portal API. - $ref: '#/components/schemas/SasPortalDeviceConfig' - grants: - description: Output only. Grants held by the device. + Output only. The FCC Registration Numbers (FRNs) copied from its + direct parent. + readOnly: true type: array items: - $ref: '#/components/schemas/SasPortalDeviceGrant' - displayName: - type: string - description: Device display name. - name: - description: Output only. The resource path name. - type: string - SasPortalCreateSignedDeviceRequest: + type: string + SasPortalProvisionDeploymentRequest: + id: SasPortalProvisionDeploymentRequest + description: >- + Request for [ProvisionDeployment]. + [spectrum.sas.portal.v1alpha1.Provisioning.ProvisionDeployment]. GCP + Project, Organization Info, and caller’s GAIA ID should be retrieved + from the RPC handler, and used as inputs to create a new SAS + organization (if not exists) and a new SAS deployment. + type: object properties: - installerId: + newOrganizationDisplayName: + description: >- + Optional. If this field is set, and a new SAS Portal Organization + needs to be created, its display name will be set to the value of + this field. type: string + newDeploymentDisplayName: description: >- - Required. Unique installer id (CPI ID) from the Certified - Professional Installers database. - encodedDevice: - format: byte + Optional. If this field is set, and a new SAS Portal Deployment + needs to be created, its display name will be set to the value of + this field. + type: string + organizationId: description: >- - Required. JSON Web Token signed using a CPI private key. Payload - must be the JSON encoding of the device. The user_id field must be - set. + Optional. If this field is set then a new deployment will be created + under the organization specified by this id. type: string + format: int64 + SasPortalProvisionDeploymentResponse: + id: SasPortalProvisionDeploymentResponse + description: >- + Response for [ProvisionDeployment]. + [spectrum.sas.portal.v1alpha1.Provisioning.ProvisionDeployment]. type: object - description: Request for CreateSignedDevice. - id: SasPortalCreateSignedDeviceRequest - SasPortalStatus: properties: - details: - items: - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: object - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - type: array - message: + errorMessage: description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. + Optional. Optional error message if the provisioning request is not + successful. type: string - code: - format: int32 - description: The status code, which should be an enum value of google.rpc.Code. - type: integer + SasPortalListLegacyOrganizationsResponse: + id: SasPortalListLegacyOrganizationsResponse description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). + Response for [ListLegacyOrganizations]. + [spectrum.sas.portal.v1alpha1.Provisioning.ListLegacyOrganizations]. type: object - id: SasPortalStatus - SasPortalOperation: properties: - response: - description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - error: - $ref: '#/components/schemas/SasPortalStatus' - description: >- - The error result of the operation in case of failure or - cancellation. - name: - type: string - description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP + organizations: + description: Optional. Legacy SAS organizations. + type: array + items: + $ref: '#/components/schemas/SasPortalOrganization' + SasPortalOrganization: + id: SasPortalOrganization + description: Organization details. + type: object + properties: + id: + description: Id of organization + type: string + format: int64 + displayName: + description: Name of organization + type: string + SasPortalMigrateOrganizationRequest: + id: SasPortalMigrateOrganizationRequest + description: >- + Request for [MigrateOrganization]. + [spectrum.sas.portal.v1alpha1.Provisioning.MigrateOrganization]. GCP + Project, Organization Info, and caller's GAIA ID should be retrieved + from the RPC handler, and used to check authorization on SAS Portal + organization and to create GCP Projects. + type: object + properties: + organizationId: + description: Required. Id of the SAS organization to be migrated. + type: string + format: int64 + SasPortalOperation: + id: SasPortalOperation + description: >- + This resource represents a long-running operation that is the result of + a network API call. + type: object + properties: + name: + description: >- + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. - done: - description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - type: boolean + type: string metadata: description: >- Service-specific metadata associated with the operation. It @@ -237,298 +218,589 @@ components: create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. + type: object additionalProperties: - description: Properties of the object. Contains field @type with type URL. type: any + description: Properties of the object. Contains field @type with type URL. + done: + description: >- + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + type: boolean + error: + description: >- + The error result of the operation in case of failure or + cancellation. + $ref: '#/components/schemas/SasPortalStatus' + response: + description: >- + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + SasPortalStatus: + id: SasPortalStatus description: >- - This resource represents a long-running operation that is the result of - a network API call. - id: SasPortalOperation - type: object - SasPortalUpdateSignedDeviceRequest: - id: SasPortalUpdateSignedDeviceRequest - description: Request for UpdateSignedDevice. + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). type: object properties: - installerId: + code: + description: The status code, which should be an enum value of google.rpc.Code. + type: integer + format: int32 + message: description: >- - Required. Unique installer ID (CPI ID) from the Certified - Professional Installers database. + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. type: string - encodedDevice: - format: byte + details: description: >- - Required. The JSON Web Token signed using a CPI private key. Payload - must be the JSON encoding of the device. The user_id field must be - set. - type: string - SasPortalTestPermissionsRequest: + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + type: array + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + SasPortalSetupSasAnalyticsRequest: + id: SasPortalSetupSasAnalyticsRequest + description: Request for the SetupSasAnalytics rpc. type: object - id: SasPortalTestPermissionsRequest - description: Request message for `TestPermissions` method. properties: - resource: + userId: description: >- - Required. The resource for which the permissions are being - requested. + Optional. User id to setup analytics for, if not provided the user + id associated with the project is used. optional type: string - permissions: - items: - type: string - type: array - description: The set of permissions to check for the `resource`. - SasPortalDeviceGrant: + SasPortalDevice: + id: SasPortalDevice type: object - description: >- - Device grant. It is an authorization provided by the Spectrum Access - System to a device to transmit using specified operating parameters - after a successful heartbeat by the device. properties: - expireTime: + name: + description: Output only. The resource path name. type: string - description: The expiration time of the grant. - format: google-datetime - suspensionReason: - description: If the grant is suspended, the reason(s) for suspension. - type: array - items: - type: string - lastHeartbeatTransmitExpireTime: - description: The transmit expiration time of the last heartbeat. + fccId: + description: >- + The FCC identifier of the device. Refer to + https://www.fcc.gov/oet/ea/fccid for FccID format. Accept + underscores and periods because some test-SAS customers use them. type: string - format: google-datetime + serialNumber: + description: A serial number assigned to the device by the device manufacturer. + type: string + preloadedConfig: + description: Configuration of the device, as specified via SAS Portal API. + $ref: '#/components/schemas/SasPortalDeviceConfig' + activeConfig: + description: >- + Output only. Current configuration of the device as registered to + the SAS. + $ref: '#/components/schemas/SasPortalDeviceConfig' state: - description: State of the grant. - enum: - - GRANT_STATE_UNSPECIFIED - - GRANT_STATE_GRANTED - - GRANT_STATE_TERMINATED - - GRANT_STATE_SUSPENDED - - GRANT_STATE_AUTHORIZED - - GRANT_STATE_EXPIRED + description: Output only. Device state. + type: string enumDescriptions: - - '' + - Unspecified state. - >- - The grant has been granted but the device is not heartbeating on - it. - - The grant has been terminated by the SAS. - - The grant has been suspended by the SAS. - - The device is currently transmitting. - - The grant has expired. + Device created in the SAS Portal, however, not yet registered with + SAS. + - Device registered with SAS. + - Device de-registered with SAS. + enum: + - DEVICE_STATE_UNSPECIFIED + - RESERVED + - REGISTERED + - DEREGISTERED + grants: + description: Output only. Grants held by the device. + type: array + items: + $ref: '#/components/schemas/SasPortalDeviceGrant' + displayName: + description: Device display name. type: string - maxEirp: - type: number - format: double + deviceMetadata: description: >- - Maximum Equivalent Isotropically Radiated Power (EIRP) permitted by - the grant. The maximum EIRP is in units of dBm/MHz. The value of - `maxEirp` represents the average (RMS) EIRP that would be measured - by the procedure defined in FCC part 96.41(e)(3). - grantId: - description: Grant Id. - type: string - moveList: + Device parameters that can be overridden by both SAS Portal and SAS + registration requests. + $ref: '#/components/schemas/SasPortalDeviceMetadata' + currentChannels: + description: Output only. Current channels with scores. + readOnly: true + deprecated: true + type: array items: - $ref: '#/components/schemas/SasPortalDpaMoveList' - description: The DPA move lists on which this grant appears. + $ref: '#/components/schemas/SasPortalChannelWithScore' + grantRangeAllowlists: + description: >- + Only ranges that are within the allowlists are available for new + grants. type: array - channelType: - description: Type of channel used. + items: + $ref: '#/components/schemas/SasPortalFrequencyRange' + SasPortalDeviceConfig: + id: SasPortalDeviceConfig + description: Information about the device configuration. + type: object + properties: + category: + description: FCC category of the device. type: string enumDescriptions: - - '' - - '' - - '' + - Unspecified device category. + - Category A. + - Category B. enum: - - CHANNEL_TYPE_UNSPECIFIED - - CHANNEL_TYPE_GAA - - CHANNEL_TYPE_PAL - frequencyRange: - description: The transmission frequency range. - $ref: '#/components/schemas/SasPortalFrequencyRange' - id: SasPortalDeviceGrant - SasPortalMigrateOrganizationResponse: - description: >- - Response for [MigrateOrganization]. - [spectrum.sas.portal.v1alpha1.Provisioning.MigrateOrganization]. - properties: - deploymentAssociation: + - DEVICE_CATEGORY_UNSPECIFIED + - DEVICE_CATEGORY_A + - DEVICE_CATEGORY_B + model: + description: Information about this device model. + $ref: '#/components/schemas/SasPortalDeviceModel' + airInterface: + description: Information about this device's air interface. + $ref: '#/components/schemas/SasPortalDeviceAirInterface' + installationParams: + description: Installation parameters for the device. + $ref: '#/components/schemas/SasPortalInstallationParams' + measurementCapabilities: + description: Measurement reporting capabilities of the device. type: array - description: >- - Optional. A list of deployment association that were created for the - migration, or current associations if they already exist. items: - $ref: '#/components/schemas/SasPortalDeploymentAssociation' + type: string + enumDescriptions: + - '' + - '' + - '' + enum: + - MEASUREMENT_CAPABILITY_UNSPECIFIED + - MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITH_GRANT + - MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITHOUT_GRANT + userId: + description: The identifier of a device user. + type: string + callSign: + description: The call sign of the device operator. + type: string + state: + description: State of the configuration. + type: string + enumDescriptions: + - '' + - '' + - '' + enum: + - DEVICE_CONFIG_STATE_UNSPECIFIED + - DRAFT + - FINAL + isSigned: + description: Output only. Whether the configuration has been signed by a CPI. + type: boolean + updateTime: + description: Output only. The last time the device configuration was edited. + type: string + format: google-datetime + SasPortalDeviceModel: + id: SasPortalDeviceModel + description: Information about the model of the device. type: object - id: SasPortalMigrateOrganizationResponse - SasPortalNode: properties: - displayName: + vendor: + description: The name of the device vendor. type: string - description: The node's display name. name: + description: The name of the device model. type: string - description: Output only. Resource name. - sasUserIds: - items: - type: string - description: User ids used by the devices belonging to this node. - type: array - id: SasPortalNode - type: object - description: The Node. - SasPortalSetupSasAnalyticsResponse: - properties: {} - description: >- - Response returned by the long running operation for the - SetupSasAnalytics rpc. + softwareVersion: + description: The software version of the device. + type: string + hardwareVersion: + description: The hardware version of the device. + type: string + firmwareVersion: + description: The firmware version of the device. + type: string + SasPortalDeviceAirInterface: + id: SasPortalDeviceAirInterface + description: Information about the device's air interface. type: object - id: SasPortalSetupSasAnalyticsResponse - SasPortalListDeploymentsResponse: - description: Response for ListDeployments. properties: - nextPageToken: + radioTechnology: description: >- - A pagination token returned from a previous call to ListDeployments - that indicates from where listing should continue. If the field is - missing or empty, it means there are no more deployments. + Conditional. This field specifies the radio access technology that + is used for the CBSD. type: string - deployments: - items: - $ref: '#/components/schemas/SasPortalDeployment' - type: array - description: The deployments that match the request. - type: object - id: SasPortalListDeploymentsResponse - SasPortalGetPolicyRequest: - description: Request message for `GetPolicy` method. - properties: - resource: - description: Required. The resource for which the policy is being requested. + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + enum: + - RADIO_TECHNOLOGY_UNSPECIFIED + - E_UTRA + - CAMBIUM_NETWORKS + - FOUR_G_BBW_SAA_1 + - NR + - DOODLE_CBRS + - CW + - REDLINE + - TARANA_WIRELESS + - FAROS + supportedSpec: + description: >- + Optional. This field is related to the `radioTechnology` and + provides the air interface specification that the CBSD is compliant + with at the time of registration. type: string + SasPortalInstallationParams: + id: SasPortalInstallationParams + description: Information about the device installation parameters. type: object - id: SasPortalGetPolicyRequest - SasPortalDeploymentAssociation: properties: - gcpProjectId: - description: GCP project id of the associated project. + latitude: + description: >- + Latitude of the device antenna location in degrees relative to the + WGS 84 datum. The allowed range is from -90.000000 to +90.000000. + Positive values represent latitudes north of the equator; negative + values south of the equator. + type: number + format: double + longitude: + description: >- + Longitude of the device antenna location in degrees relative to the + WGS 84 datum. The allowed range is from -180.000000 to +180.000000. + Positive values represent longitudes east of the prime meridian; + negative values west of the prime meridian. + type: number + format: double + height: + description: >- + Device antenna height in meters. When the `heightType` parameter + value is "AGL", the antenna height should be given relative to + ground level. When the `heightType` parameter value is "AMSL", it is + given with respect to WGS84 datum. + type: number + format: double + heightType: + description: Specifies how the height is measured. type: string - userId: + enumDescriptions: + - Unspecified height type. + - AGL height is measured relative to the ground level. + - AMSL height is measured relative to the mean sea level. + enum: + - HEIGHT_TYPE_UNSPECIFIED + - HEIGHT_TYPE_AGL + - HEIGHT_TYPE_AMSL + horizontalAccuracy: + description: >- + A positive number in meters to indicate accuracy of the device + antenna horizontal location. This optional parameter should only be + present if its value is less than the FCC requirement of 50 meters. + type: number + format: double + verticalAccuracy: + description: >- + A positive number in meters to indicate accuracy of the device + antenna vertical location. This optional parameter should only be + present if its value is less than the FCC requirement of 3 meters. + type: number + format: double + indoorDeployment: + description: >- + Whether the device antenna is indoor or not. `true`: indoor. + `false`: outdoor. + type: boolean + antennaAzimuth: + description: >- + Boresight direction of the horizontal plane of the antenna in + degrees with respect to true north. The value of this parameter is + an integer with a value between 0 and 359 inclusive. A value of 0 + degrees means true north; a value of 90 degrees means east. This + parameter is optional for Category A devices and conditional for + Category B devices. + type: integer + format: int32 + antennaDowntilt: + description: >- + Antenna downtilt in degrees and is an integer with a value between + -90 and +90 inclusive; a negative value means the antenna is tilted + up (above horizontal). This parameter is optional for Category A + devices and conditional for Category B devices. + type: integer + format: int32 + antennaGain: + description: >- + Peak antenna gain in dBi. This parameter is a double with a value + between -127 and +128 (dBi) inclusive. Part of Release 2 to support + floating-point value + type: number + format: double + eirpCapability: + description: >- + This parameter is the maximum device EIRP in units of dBm/10MHz and + is an integer with a value between -127 and +47 (dBm/10 MHz) + inclusive. If not included, SAS interprets it as maximum allowable + EIRP in units of dBm/10MHz for device category. + type: integer + format: int32 + antennaBeamwidth: + description: >- + 3-dB antenna beamwidth of the antenna in the horizontal-plane in + degrees. This parameter is an unsigned integer having a value + between 0 and 360 (degrees) inclusive; it is optional for Category A + devices and conditional for Category B devices. + type: integer + format: int32 + antennaModel: + description: >- + If an external antenna is used, the antenna model is optionally + provided in this field. The string has a maximum length of 128 + octets. type: string - description: User id of the deployment. - id: SasPortalDeploymentAssociation - description: Association between a gcp project and a SAS user id. - type: object - SasPortalGenerateSecretRequest: - id: SasPortalGenerateSecretRequest - type: object - description: Request for GenerateSecret. - properties: {} - SasPortalTestPermissionsResponse: - properties: - permissions: - description: A set of permissions that the caller is allowed. - items: - type: string - type: array - description: Response message for `TestPermissions` method. + cpeCbsdIndication: + description: >- + If present, this parameter specifies whether the CBSD is a CPE-CBSD + or not. + type: boolean + SasPortalDeviceGrant: + id: SasPortalDeviceGrant + description: >- + Device grant. It is an authorization provided by the Spectrum Access + System to a device to transmit using specified operating parameters + after a successful heartbeat by the device. type: object - id: SasPortalTestPermissionsResponse - SasPortalDeviceModel: - description: Information about the model of the device. properties: - name: + maxEirp: + description: >- + Maximum Equivalent Isotropically Radiated Power (EIRP) permitted by + the grant. The maximum EIRP is in units of dBm/MHz. The value of + `maxEirp` represents the average (RMS) EIRP that would be measured + by the procedure defined in FCC part 96.41(e)(3). + type: number + format: double + frequencyRange: + description: The transmission frequency range. + $ref: '#/components/schemas/SasPortalFrequencyRange' + state: + description: State of the grant. type: string - description: The name of the device model. - vendor: - description: The name of the device vendor. + enumDescriptions: + - '' + - >- + The grant has been granted but the device is not heartbeating on + it. + - The grant has been terminated by the SAS. + - The grant has been suspended by the SAS. + - The device is currently transmitting. + - The grant has expired. + enum: + - GRANT_STATE_UNSPECIFIED + - GRANT_STATE_GRANTED + - GRANT_STATE_TERMINATED + - GRANT_STATE_SUSPENDED + - GRANT_STATE_AUTHORIZED + - GRANT_STATE_EXPIRED + channelType: + description: Type of channel used. type: string - hardwareVersion: + enumDescriptions: + - '' + - '' + - '' + enum: + - CHANNEL_TYPE_UNSPECIFIED + - CHANNEL_TYPE_GAA + - CHANNEL_TYPE_PAL + moveList: + description: The DPA move lists on which this grant appears. + type: array + items: + $ref: '#/components/schemas/SasPortalDpaMoveList' + expireTime: + description: The expiration time of the grant. type: string - description: The hardware version of the device. - firmwareVersion: - description: The firmware version of the device. + format: google-datetime + suspensionReason: + description: If the grant is suspended, the reason(s) for suspension. + type: array + items: + type: string + grantId: + description: Grant Id. type: string - softwareVersion: + lastHeartbeatTransmitExpireTime: + description: The transmit expiration time of the last heartbeat. type: string - description: The software version of the device. + format: google-datetime + SasPortalFrequencyRange: + id: SasPortalFrequencyRange + description: Frequency range from `low_frequency` to `high_frequency`. type: object - id: SasPortalDeviceModel - SasPortalListNodesResponse: - id: SasPortalListNodesResponse - description: Response for ListNodes. + properties: + lowFrequencyMhz: + description: The lowest frequency of the frequency range in MHz. + type: number + format: double + highFrequencyMhz: + description: The highest frequency of the frequency range in MHz. + type: number + format: double + SasPortalDpaMoveList: + id: SasPortalDpaMoveList + description: An entry in a DPA's move list. type: object properties: - nextPageToken: - description: >- - A pagination token returned from a previous call to ListNodes that - indicates from where listing should continue. If the field is - missing or empty, it means there is no more nodes. + dpaId: + description: The ID of the DPA. type: string - nodes: - items: - $ref: '#/components/schemas/SasPortalNode' - type: array - description: The nodes that match the request. - SasPortalGcpProjectDeployment: - id: SasPortalGcpProjectDeployment + frequencyRange: + description: The frequency range that the move list affects. + $ref: '#/components/schemas/SasPortalFrequencyRange' + SasPortalDeviceMetadata: + id: SasPortalDeviceMetadata + description: Device data overridable by both SAS Portal and registration requests. type: object properties: - deployment: - description: Deployment associated with the GCP project. - $ref: '#/components/schemas/SasPortalDeployment' - hasEnabledAnalytics: - description: Whether SAS analytics has been enabled. + interferenceCoordinationGroup: + description: >- + Interference Coordination Group (ICG). A group of CBSDs that manage + their own interference with the group. For more details, see + [CBRSA-TS-2001 + V3.0.0](https://ongoalliance.org/wp-content/uploads/2020/02/CBRSA-TS-2001-V3.0.0_Approved-for-publication.pdf). + type: string + commonChannelGroup: + description: >- + Common Channel Group (CCG). A group of CBSDs in the same ICG + requesting a common primary channel assignment. For more details, + see [CBRSA-TS-2001 + V3.0.0](https://ongoalliance.org/wp-content/uploads/2020/02/CBRSA-TS-2001-V3.0.0_Approved-for-publication.pdf). + type: string + antennaModel: + description: >- + If populated, the Antenna Model Pattern to use. Format is: + `RecordCreatorId:PatternId` + type: string + nrqzValidated: + description: >- + Output only. Set to `true` if a CPI has validated that they have + coordinated with the National Quiet Zone office. + readOnly: true + deprecated: true type: boolean - description: >- - Deployment associated with the GCP project. Includes whether SAS - analytics has been enabled or not. + nrqzValidation: + description: Output only. National Radio Quiet Zone validation info. + readOnly: true + $ref: '#/components/schemas/SasPortalNrqzValidation' + SasPortalNrqzValidation: + id: SasPortalNrqzValidation + description: Information about National Radio Quiet Zone validation. + type: object + properties: + caseId: + description: Validation case ID. + type: string + latitude: + description: Device latitude that's associated with the validation. + type: number + format: double + longitude: + description: Device longitude that's associated with the validation. + type: number + format: double + cpiId: + description: CPI who signed the validation. + type: string + state: + description: State of the NRQZ validation info. + type: string + enumDescriptions: + - Unspecified state. + - Draft state. + - Final state. + enum: + - STATE_UNSPECIFIED + - DRAFT + - FINAL SasPortalChannelWithScore: - description: The channel with score. id: SasPortalChannelWithScore + description: The channel with score. type: object properties: + frequencyRange: + description: The frequency range of the channel. + $ref: '#/components/schemas/SasPortalFrequencyRange' score: - type: number description: The channel score, normalized to be in the range [0,100]. + type: number format: double - frequencyRange: - $ref: '#/components/schemas/SasPortalFrequencyRange' - description: The frequency range of the channel. - SasPortalAssignment: - id: SasPortalAssignment - description: Associates `members` with a `role`. + SasPortalCreateSignedDeviceRequest: + id: SasPortalCreateSignedDeviceRequest + description: Request for CreateSignedDevice. type: object properties: - members: - type: array - items: - type: string + encodedDevice: description: >- - The identities the role is assigned to. It can have the following - values: * `{user_email}`: An email address that represents a - specific Google account. For example: `alice@gmail.com`. * - `{group_email}`: An email address that represents a Google group. - For example, `viewers@gmail.com`. - role: + Required. JSON Web Token signed using a CPI private key. Payload + must be the JSON encoding of the device. The user_id field must be + set. type: string - description: Required. Role that is assigned to `members`. - SasPortalMigrateOrganizationRequest: + format: byte + installerId: + description: >- + Required. Unique installer id (CPI ID) from the Certified + Professional Installers database. + type: string + SasPortalEmpty: + id: SasPortalEmpty + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + type: object + properties: {} + SasPortalListDevicesResponse: + id: SasPortalListDevicesResponse + description: Response for ListDevices. type: object properties: - organizationId: - description: Required. Id of the SAS organization to be migrated. + devices: + description: The devices that match the request. + type: array + items: + $ref: '#/components/schemas/SasPortalDevice' + nextPageToken: + description: >- + A pagination token returned from a previous call to ListDevices that + indicates from where listing should continue. If the field is + missing or empty, it means there is no more devices. type: string - format: int64 - description: >- - Request for [MigrateOrganization]. - [spectrum.sas.portal.v1alpha1.Provisioning.MigrateOrganization]. GCP - Project, Organization Info, and caller's GAIA ID should be retrieved - from the RPC handler, and used to check authorization on SAS Portal - organization and to create GCP Projects. - id: SasPortalMigrateOrganizationRequest SasPortalMoveDeviceRequest: + id: SasPortalMoveDeviceRequest description: Request for MoveDevice. type: object properties: @@ -537,347 +809,240 @@ components: Required. The name of the new parent resource node or customer to reparent the device under. type: string - id: SasPortalMoveDeviceRequest - SasPortalValidateInstallerRequest: - id: SasPortalValidateInstallerRequest - description: Request for ValidateInstaller. + SasPortalUpdateSignedDeviceRequest: + id: SasPortalUpdateSignedDeviceRequest + description: Request for UpdateSignedDevice. type: object properties: - secret: + encodedDevice: + description: >- + Required. The JSON Web Token signed using a CPI private key. Payload + must be the JSON encoding of the device. The user_id field must be + set. type: string - description: Required. Secret returned by the GenerateSecret. + format: byte installerId: description: >- - Required. Unique installer id (CPI ID) from the Certified + Required. Unique installer ID (CPI ID) from the Certified Professional Installers database. type: string - encodedSecret: - description: >- - Required. JSON Web Token signed using a CPI private key. Payload - must include a "secret" claim whose value is the secret. - type: string - SasPortalMoveDeploymentRequest: - type: object - description: Request for MoveDeployment. - id: SasPortalMoveDeploymentRequest - properties: - destination: - type: string - description: >- - Required. The name of the new parent resource node or customer to - reparent the deployment under. - SasPortalPolicy: - id: SasPortalPolicy - properties: - etag: - description: >- - The 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 - GetPolicy, and systems are expected to put that etag in the request - to SetPolicy to ensure that their change will be applied to the same - version of the policy. If no etag is provided in the call to - GetPolicy, then the existing policy is overwritten blindly. - type: string - format: byte - assignments: - description: List of assignments - type: array - items: - $ref: '#/components/schemas/SasPortalAssignment' - type: object - description: Defines an access control policy to the resources. SasPortalSignDeviceRequest: + id: SasPortalSignDeviceRequest + description: Request for SignDevice. + type: object properties: device: - $ref: '#/components/schemas/SasPortalDevice' description: >- Required. The device to sign. The device fields name, fcc_id and serial_number must be set. The user_id field must be set. + $ref: '#/components/schemas/SasPortalDevice' + SasPortalNode: + id: SasPortalNode + description: The Node. type: object - description: Request for SignDevice. - id: SasPortalSignDeviceRequest - SasPortalFrequencyRange: - id: SasPortalFrequencyRange - description: Frequency range from `low_frequency` to `high_frequency`. - type: object - properties: - highFrequencyMhz: - format: double - description: The highest frequency of the frequency range in MHz. - type: number - lowFrequencyMhz: - format: double - description: The lowest frequency of the frequency range in MHz. - type: number - SasPortalListGcpProjectDeploymentsResponse: - type: object - properties: - deployments: - description: Optional. Deployments associated with the GCP project - type: array - items: - $ref: '#/components/schemas/SasPortalGcpProjectDeployment' - description: Response for [ListGcpProjectDeployments]. - id: SasPortalListGcpProjectDeploymentsResponse - SasPortalDpaMoveList: - id: SasPortalDpaMoveList - type: object - description: An entry in a DPA's move list. - properties: - frequencyRange: - description: The frequency range that the move list affects. - $ref: '#/components/schemas/SasPortalFrequencyRange' - dpaId: - type: string - description: The ID of the DPA. - SasPortalDeviceAirInterface: - id: SasPortalDeviceAirInterface - type: object - description: Information about the device's air interface. properties: - supportedSpec: - type: string - description: >- - Optional. This field is related to the `radioTechnology` and - provides the air interface specification that the CBSD is compliant - with at the time of registration. - radioTechnology: - description: >- - Conditional. This field specifies the radio access technology that - is used for the CBSD. - enum: - - RADIO_TECHNOLOGY_UNSPECIFIED - - E_UTRA - - CAMBIUM_NETWORKS - - FOUR_G_BBW_SAA_1 - - NR - - DOODLE_CBRS - - CW - - REDLINE - - TARANA_WIRELESS - - FAROS - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' + name: + description: Output only. Resource name. type: string - SasPortalDeployment: - properties: - frns: - readOnly: true - description: >- - Output only. The FCC Registration Numbers (FRNs) copied from its - direct parent. - items: - type: string - type: array displayName: - description: The deployment's display name. + description: The node's display name. type: string sasUserIds: + description: User ids used by the devices belonging to this node. type: array - description: >- - User ID used by the devices belonging to this deployment. Each - deployment should be associated with one unique user ID. items: type: string - name: - description: Output only. Resource name. - readOnly: true - type: string - id: SasPortalDeployment - description: The Deployment. + SasPortalListNodesResponse: + id: SasPortalListNodesResponse + description: Response for ListNodes. type: object - SasPortalListLegacyOrganizationsResponse: - id: SasPortalListLegacyOrganizationsResponse - description: >- - Response for [ListLegacyOrganizations]. - [spectrum.sas.portal.v1alpha1.Provisioning.ListLegacyOrganizations]. + properties: + nodes: + description: The nodes that match the request. + type: array + items: + $ref: '#/components/schemas/SasPortalNode' + nextPageToken: + description: >- + A pagination token returned from a previous call to ListNodes that + indicates from where listing should continue. If the field is + missing or empty, it means there is no more nodes. + type: string + SasPortalMoveNodeRequest: + id: SasPortalMoveNodeRequest + description: Request for MoveNode. type: object properties: - organizations: - description: Optional. Legacy SAS organizations. - items: - $ref: '#/components/schemas/SasPortalOrganization' - type: array - SasPortalGenerateSecretResponse: - properties: - secret: + destination: + description: >- + Required. The name of the new parent resource node or customer to + reparent the node under. type: string - description: The secret generated by the string and used by ValidateInstaller. + SasPortalGenerateSecretRequest: + id: SasPortalGenerateSecretRequest + description: Request for GenerateSecret. + type: object + properties: {} + SasPortalGenerateSecretResponse: id: SasPortalGenerateSecretResponse description: Response for GenerateSecret. type: object - SasPortalProvisionDeploymentResponse: properties: - errorMessage: + secret: + description: The secret generated by the string and used by ValidateInstaller. type: string - description: >- - Optional. Optional error message if the provisioning request is not - successful. - id: SasPortalProvisionDeploymentResponse - description: >- - Response for [ProvisionDeployment]. - [spectrum.sas.portal.v1alpha1.Provisioning.ProvisionDeployment]. + SasPortalValidateInstallerRequest: + id: SasPortalValidateInstallerRequest + description: Request for ValidateInstaller. type: object - SasPortalDeviceConfig: - id: SasPortalDeviceConfig properties: - measurementCapabilities: - type: array - description: Measurement reporting capabilities of the device. - items: - enumDescriptions: - - '' - - '' - - '' - type: string - enum: - - MEASUREMENT_CAPABILITY_UNSPECIFIED - - MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITH_GRANT - - MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITHOUT_GRANT - airInterface: - $ref: '#/components/schemas/SasPortalDeviceAirInterface' - description: Information about this device's air interface. - category: - enum: - - DEVICE_CATEGORY_UNSPECIFIED - - DEVICE_CATEGORY_A - - DEVICE_CATEGORY_B - description: FCC category of the device. - type: string - enumDescriptions: - - Unspecified device category. - - Category A. - - Category B. - callSign: - type: string - description: The call sign of the device operator. - isSigned: - type: boolean - description: Output only. Whether the configuration has been signed by a CPI. - updateTime: - format: google-datetime + installerId: + description: >- + Required. Unique installer id (CPI ID) from the Certified + Professional Installers database. type: string - description: Output only. The last time the device configuration was edited. - userId: + secret: + description: Required. Secret returned by the GenerateSecret. type: string - description: The identifier of a device user. - installationParams: - description: Installation parameters for the device. - $ref: '#/components/schemas/SasPortalInstallationParams' - state: - enum: - - DEVICE_CONFIG_STATE_UNSPECIFIED - - DRAFT - - FINAL - enumDescriptions: - - '' - - '' - - '' + encodedSecret: + description: >- + Required. JSON Web Token signed using a CPI private key. Payload + must include a "secret" claim whose value is the secret. type: string - description: State of the configuration. - model: - description: Information about this device model. - $ref: '#/components/schemas/SasPortalDeviceModel' + SasPortalValidateInstallerResponse: + id: SasPortalValidateInstallerResponse + description: Response for ValidateInstaller. type: object - description: Information about the device configuration. - SasPortalDeviceMetadata: - id: SasPortalDeviceMetadata + properties: {} + SasPortalListDeploymentsResponse: + id: SasPortalListDeploymentsResponse + description: Response for ListDeployments. type: object properties: - antennaModel: - type: string + deployments: + description: The deployments that match the request. + type: array + items: + $ref: '#/components/schemas/SasPortalDeployment' + nextPageToken: description: >- - If populated, the Antenna Model Pattern to use. Format is: - `RecordCreatorId:PatternId` - commonChannelGroup: + A pagination token returned from a previous call to ListDeployments + that indicates from where listing should continue. If the field is + missing or empty, it means there are no more deployments. + type: string + SasPortalMoveDeploymentRequest: + id: SasPortalMoveDeploymentRequest + description: Request for MoveDeployment. + type: object + properties: + destination: description: >- - Common Channel Group (CCG). A group of CBSDs in the same ICG - requesting a common primary channel assignment. For more details, - see [CBRSA-TS-2001 - V3.0.0](https://ongoalliance.org/wp-content/uploads/2020/02/CBRSA-TS-2001-V3.0.0_Approved-for-publication.pdf). + Required. The name of the new parent resource node or customer to + reparent the deployment under. type: string - nrqzValidated: - readOnly: true - type: boolean + SasPortalSetPolicyRequest: + id: SasPortalSetPolicyRequest + description: Request message for `SetPolicy` method. + type: object + properties: + resource: description: >- - Output only. Set to `true` if a CPI has validated that they have - coordinated with the National Quiet Zone office. - deprecated: true - nrqzValidation: - description: Output only. National Radio Quiet Zone validation info. - readOnly: true - $ref: '#/components/schemas/SasPortalNrqzValidation' - interferenceCoordinationGroup: + Required. The resource for which the policy is being specified. This + policy replaces any existing policy. type: string + policy: + description: Required. The policy to be applied to the `resource`. + $ref: '#/components/schemas/SasPortalPolicy' + disableNotification: description: >- - Interference Coordination Group (ICG). A group of CBSDs that manage - their own interference with the group. For more details, see - [CBRSA-TS-2001 - V3.0.0](https://ongoalliance.org/wp-content/uploads/2020/02/CBRSA-TS-2001-V3.0.0_Approved-for-publication.pdf). - description: Device data overridable by both SAS Portal and registration requests. - SasPortalSetupSasAnalyticsRequest: + Optional. Set the field as `true` to disable the onboarding + notification. + type: boolean + SasPortalPolicy: + id: SasPortalPolicy + description: Defines an access control policy to the resources. type: object - id: SasPortalSetupSasAnalyticsRequest properties: - userId: + assignments: + description: List of assignments + type: array + items: + $ref: '#/components/schemas/SasPortalAssignment' + etag: description: >- - Optional. User id to setup analytics for, if not provided the user - id associated with the project is used. optional + The 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 + GetPolicy, and systems are expected to put that etag in the request + to SetPolicy to ensure that their change will be applied to the same + version of the policy. If no etag is provided in the call to + GetPolicy, then the existing policy is overwritten blindly. type: string - description: Request for the SetupSasAnalytics rpc. - SasPortalNrqzValidation: + format: byte + SasPortalAssignment: + id: SasPortalAssignment + description: Associates `members` with a `role`. type: object properties: - latitude: - format: double - description: Device latitude that's associated with the validation. - type: number - caseId: + role: + description: Required. Role that is assigned to `members`. type: string - description: Validation case ID. - cpiId: - description: CPI who signed the validation. + members: + description: >- + The identities the role is assigned to. It can have the following + values: * `{user_email}`: An email address that represents a + specific Google account. For example: `alice@gmail.com`. * + `{group_email}`: An email address that represents a Google group. + For example, `viewers@gmail.com`. + type: array + items: + type: string + SasPortalGetPolicyRequest: + id: SasPortalGetPolicyRequest + description: Request message for `GetPolicy` method. + type: object + properties: + resource: + description: Required. The resource for which the policy is being requested. type: string - longitude: - type: number - format: double - description: Device longitude that's associated with the validation. - state: + SasPortalTestPermissionsRequest: + id: SasPortalTestPermissionsRequest + description: Request message for `TestPermissions` method. + type: object + properties: + resource: + description: >- + Required. The resource for which the permissions are being + requested. type: string - enum: - - STATE_UNSPECIFIED - - DRAFT - - FINAL - description: State of the NRQZ validation info. - enumDescriptions: - - Unspecified state. - - Draft state. - - Final state. - id: SasPortalNrqzValidation - description: Information about National Radio Quiet Zone validation. + permissions: + description: The set of permissions to check for the `resource`. + type: array + items: + type: string + SasPortalTestPermissionsResponse: + id: SasPortalTestPermissionsResponse + description: Response message for `TestPermissions` method. + type: object + properties: + permissions: + description: A set of permissions that the caller is allowed. + type: array + items: + type: string SasPortalMigrateOrganizationMetadata: + id: SasPortalMigrateOrganizationMetadata description: >- Long-running operation metadata message returned by the MigrateOrganization. - id: SasPortalMigrateOrganizationMetadata type: object properties: operationState: - type: string - readOnly: true description: Output only. Current operation state + readOnly: true + type: string enumDescriptions: - Unspecified. - Pending (Not started). @@ -890,224 +1055,72 @@ components: - OPERATION_STATE_RUNNING - OPERATION_STATE_SUCCEEDED - OPERATION_STATE_FAILED - SasPortalCustomer: + SasPortalMigrateOrganizationResponse: + id: SasPortalMigrateOrganizationResponse + description: >- + Response for [MigrateOrganization]. + [spectrum.sas.portal.v1alpha1.Provisioning.MigrateOrganization]. + type: object properties: - name: - description: Output only. Resource name of the customer. - type: string - displayName: + deploymentAssociation: description: >- - Required. Name of the organization that the customer entity - represents. - type: string - sasUserIds: - description: User IDs used by the devices belonging to this customer. + Optional. A list of deployment association that were created for the + migration, or current associations if they already exist. type: array items: - type: string - type: object - description: Entity representing a SAS customer. - id: SasPortalCustomer - SasPortalProvisionDeploymentRequest: - description: >- - Request for [ProvisionDeployment]. - [spectrum.sas.portal.v1alpha1.Provisioning.ProvisionDeployment]. GCP - Project, Organization Info, and caller’s GAIA ID should be retrieved - from the RPC handler, and used as inputs to create a new SAS - organization (if not exists) and a new SAS deployment. - properties: - organizationId: - description: >- - Optional. If this field is set then a new deployment will be created - under the organization specified by this id. - type: string - format: int64 - newDeploymentDisplayName: - description: >- - Optional. If this field is set, and a new SAS Portal Deployment - needs to be created, its display name will be set to the value of - this field. - type: string - newOrganizationDisplayName: - type: string - description: >- - Optional. If this field is set, and a new SAS Portal Organization - needs to be created, its display name will be set to the value of - this field. - type: object - id: SasPortalProvisionDeploymentRequest - SasPortalInstallationParams: + $ref: '#/components/schemas/SasPortalDeploymentAssociation' + SasPortalDeploymentAssociation: + id: SasPortalDeploymentAssociation + description: Association between a gcp project and a SAS user id. type: object - description: Information about the device installation parameters. - id: SasPortalInstallationParams properties: - antennaModel: - description: >- - If an external antenna is used, the antenna model is optionally - provided in this field. The string has a maximum length of 128 - octets. - type: string - latitude: - format: double - type: number - description: >- - Latitude of the device antenna location in degrees relative to the - WGS 84 datum. The allowed range is from -90.000000 to +90.000000. - Positive values represent latitudes north of the equator; negative - values south of the equator. - longitude: - description: >- - Longitude of the device antenna location in degrees relative to the - WGS 84 datum. The allowed range is from -180.000000 to +180.000000. - Positive values represent longitudes east of the prime meridian; - negative values west of the prime meridian. - type: number - format: double - cpeCbsdIndication: - description: >- - If present, this parameter specifies whether the CBSD is a CPE-CBSD - or not. - type: boolean - antennaAzimuth: - type: integer - description: >- - Boresight direction of the horizontal plane of the antenna in - degrees with respect to true north. The value of this parameter is - an integer with a value between 0 and 359 inclusive. A value of 0 - degrees means true north; a value of 90 degrees means east. This - parameter is optional for Category A devices and conditional for - Category B devices. - format: int32 - antennaDowntilt: - description: >- - Antenna downtilt in degrees and is an integer with a value between - -90 and +90 inclusive; a negative value means the antenna is tilted - up (above horizontal). This parameter is optional for Category A - devices and conditional for Category B devices. - format: int32 - type: integer - antennaGain: - type: number - format: double - description: >- - Peak antenna gain in dBi. This parameter is a double with a value - between -127 and +128 (dBi) inclusive. Part of Release 2 to support - floating-point value - antennaBeamwidth: - format: int32 - type: integer - description: >- - 3-dB antenna beamwidth of the antenna in the horizontal-plane in - degrees. This parameter is an unsigned integer having a value - between 0 and 360 (degrees) inclusive; it is optional for Category A - devices and conditional for Category B devices. - heightType: - enum: - - HEIGHT_TYPE_UNSPECIFIED - - HEIGHT_TYPE_AGL - - HEIGHT_TYPE_AMSL + userId: + description: User id of the deployment. type: string - enumDescriptions: - - Unspecified height type. - - AGL height is measured relative to the ground level. - - AMSL height is measured relative to the mean sea level. - description: Specifies how the height is measured. - eirpCapability: - format: int32 - description: >- - This parameter is the maximum device EIRP in units of dBm/10MHz and - is an integer with a value between -127 and +47 (dBm/10 MHz) - inclusive. If not included, SAS interprets it as maximum allowable - EIRP in units of dBm/10MHz for device category. - type: integer - height: - format: double - type: number - description: >- - Device antenna height in meters. When the `heightType` parameter - value is "AGL", the antenna height should be given relative to - ground level. When the `heightType` parameter value is "AMSL", it is - given with respect to WGS84 datum. - indoorDeployment: - type: boolean - description: >- - Whether the device antenna is indoor or not. `true`: indoor. - `false`: outdoor. - horizontalAccuracy: - description: >- - A positive number in meters to indicate accuracy of the device - antenna horizontal location. This optional parameter should only be - present if its value is less than the FCC requirement of 50 meters. - format: double - type: number - verticalAccuracy: - description: >- - A positive number in meters to indicate accuracy of the device - antenna vertical location. This optional parameter should only be - present if its value is less than the FCC requirement of 3 meters. - type: number - format: double - SasPortalMoveNodeRequest: - id: SasPortalMoveNodeRequest - properties: - destination: - description: >- - Required. The name of the new parent resource node or customer to - reparent the node under. + gcpProjectId: + description: GCP project id of the associated project. type: string + SasPortalSetupSasAnalyticsMetadata: + id: SasPortalSetupSasAnalyticsMetadata + description: >- + Metadata returned by the long running operation for the + SetupSasAnalytics rpc. type: object - description: Request for MoveNode. - SasPortalEmpty: - type: object - id: SasPortalEmpty properties: {} + SasPortalSetupSasAnalyticsResponse: + id: SasPortalSetupSasAnalyticsResponse description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } - SasPortalOrganization: - description: Organization details. - properties: - id: - format: int64 - type: string - description: Id of organization - displayName: - description: Name of organization - type: string - type: object - id: SasPortalOrganization - SasPortalListCustomersResponse: + Response returned by the long running operation for the + SetupSasAnalytics rpc. type: object - description: Response for `ListCustomers`. - id: SasPortalListCustomersResponse - properties: - customers: - items: - $ref: '#/components/schemas/SasPortalCustomer' - type: array - description: The list of customers that match the request. - nextPageToken: - description: >- - A pagination token returned from a previous call to ListCustomers - that indicates from where listing should continue. If the field is - missing or empty, it means there are no more customers. - type: string + properties: {} parameters: - fields: - description: Selector specifying which fields to include in a partial response. + access_token: + description: OAuth access token. in: query - name: fields + name: access_token schema: type: string - 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. + alt: + description: Data format for response. + in: query + name: alt + schema: + type: string + enum: + - json + - media + - proto + 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: quotaUser + name: fields schema: type: string key: @@ -1119,499 +1132,387 @@ components: name: key schema: type: string - access_token: - description: OAuth access token. - in: query - name: access_token - schema: - type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string - _.xgafv: - description: V1 error format. + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: $.xgafv + name: oauth_token schema: type: string - enum: - - '1' - - '2' prettyPrint: description: Returns response with indentations and line breaks. in: query name: prettyPrint schema: type: boolean - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + 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: upload_protocol + name: quotaUser schema: type: string - alt: - description: Data format for response. + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: alt + name: upload_protocol schema: type: string - enum: - - json - - media - - proto - callback: - description: JSONP + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: callback + name: uploadType schema: type: string - oauth_token: - description: OAuth 2.0 token for the current user. + _.xgafv: + description: V1 error format. in: query - name: oauth_token + name: $.xgafv schema: type: string + enum: + - '1' + - '2' x-stackQL-resources: - policies: - id: google.prod_tt_sasportal.policies - name: policies - title: Policies - methods: - policies_test: - operation: - $ref: '#/paths/~1v1alpha1~1policies:test/post' - response: - mediaType: application/json - openAPIDocKey: '200' - policies_get: - operation: - $ref: '#/paths/~1v1alpha1~1policies:get/post' - response: - mediaType: application/json - openAPIDocKey: '200' - policies_set: - operation: - $ref: '#/paths/~1v1alpha1~1policies:set/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/policies/methods/policies_get' - insert: [] - update: [] - replace: [] - delete: [] - deployments: - id: google.prod_tt_sasportal.deployments - name: deployments - title: Deployments + customers: + id: google.prod_tt_sasportal.customers + name: customers + title: Customers methods: - deployments_get: - operation: - $ref: '#/paths/~1v1alpha1~1deployments~1{deploymentsId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - customers_deployments_get: - operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - customers_deployments_delete: - operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - customers_deployments_patch: - operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - customers_deployments_move: - operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}:move/post - response: - mediaType: application/json - openAPIDocKey: '200' - customers_deployments_create: - operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1deployments/post' - response: - mediaType: application/json - openAPIDocKey: '200' - customers_deployments_list: - operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1deployments/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.deployments - customers_nodes_deployments_list: - operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1deployments/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.deployments - customers_nodes_deployments_create: + customers_get: operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1deployments/post + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}/get' response: mediaType: application/json openAPIDocKey: '200' - nodes_deployments_get: + customers_patch: operation: - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}/get + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}/patch' response: mediaType: application/json openAPIDocKey: '200' - nodes_deployments_patch: + customers_list: operation: - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}/patch + $ref: '#/paths/~1v1alpha1~1customers/get' response: mediaType: application/json openAPIDocKey: '200' - nodes_deployments_delete: + objectKey: $.customers + customers_provision_deployment: operation: - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}/delete + $ref: '#/paths/~1v1alpha1~1customers:provisionDeployment/post' response: mediaType: application/json openAPIDocKey: '200' - nodes_deployments_move: + customers_migrate_organization: operation: - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}:move/post + $ref: '#/paths/~1v1alpha1~1customers:migrateOrganization/post' response: mediaType: application/json openAPIDocKey: '200' - nodes_deployments_list: + customers_setup_sas_analytics: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments/get' + $ref: '#/paths/~1v1alpha1~1customers:setupSasAnalytics/post' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.deployments - nodes_nodes_deployments_list: + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/customers/methods/customers_get' + - $ref: '#/components/x-stackQL-resources/customers/methods/customers_list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/customers/methods/customers_patch' + replace: [] + delete: [] + customers_gcp_project_deployments: + id: google.prod_tt_sasportal.customers_gcp_project_deployments + name: customers_gcp_project_deployments + title: Customers_gcp_project_deployments + methods: + customers_list_gcp_project_deployments: operation: - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1deployments/get + $ref: '#/paths/~1v1alpha1~1customers:listGcpProjectDeployments/get' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.deployments - nodes_nodes_deployments_create: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/customers_gcp_project_deployments/methods/customers_list_gcp_project_deployments + insert: [] + update: [] + replace: [] + delete: [] + customers_legacy_organizations: + id: google.prod_tt_sasportal.customers_legacy_organizations + name: customers_legacy_organizations + title: Customers_legacy_organizations + methods: + customers_list_legacy_organizations: operation: - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1deployments/post + $ref: '#/paths/~1v1alpha1~1customers:listLegacyOrganizations/get' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/deployments/methods/customers_deployments_get - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/customers_nodes_deployments_list - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/nodes_deployments_get - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/nodes_nodes_deployments_list - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/deployments_get - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/customers_deployments_list - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/nodes_deployments_list - insert: - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/customers_nodes_deployments_create - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/nodes_nodes_deployments_create - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/customers_deployments_create - update: - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/customers_deployments_patch - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/nodes_deployments_patch - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/customers_deployments_delete - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/nodes_deployments_delete + #/components/x-stackQL-resources/customers_legacy_organizations/methods/customers_list_legacy_organizations + insert: [] + update: [] + replace: [] + delete: [] devices: id: google.prod_tt_sasportal.devices name: devices title: Devices methods: - deployments_devices_move: + customers_devices_create: operation: - $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:move/post + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1devices/post' response: mediaType: application/json openAPIDocKey: '200' - deployments_devices_delete: + customers_devices_list: operation: - $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/delete + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1devices/get' response: mediaType: application/json openAPIDocKey: '200' - deployments_devices_get: + objectKey: $.devices + customers_devices_delete: operation: $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/get + #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}/delete response: mediaType: application/json openAPIDocKey: '200' - deployments_devices_patch: + customers_devices_get: operation: $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/patch + #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}/get response: mediaType: application/json openAPIDocKey: '200' - deployments_devices_sign_device: + customers_devices_patch: operation: $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:signDevice/post + #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}/patch response: mediaType: application/json openAPIDocKey: '200' - customers_deployments_devices_list: + customers_devices_move: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices/get + #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}:move/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.devices - customers_deployments_devices_create: + customers_devices_sign_device: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices/post + #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}:signDevice/post response: mediaType: application/json openAPIDocKey: '200' - customers_devices_get: + customers_nodes_devices_create: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}/get + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices/post response: mediaType: application/json openAPIDocKey: '200' - customers_devices_patch: + customers_nodes_devices_list: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}/patch + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices/get response: mediaType: application/json openAPIDocKey: '200' - customers_devices_delete: + objectKey: $.devices + customers_deployments_devices_create: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}/delete + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices/post response: mediaType: application/json openAPIDocKey: '200' - customers_devices_move: + customers_deployments_devices_list: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}:move/post + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices/get response: mediaType: application/json openAPIDocKey: '200' - customers_devices_list: + objectKey: $.devices + nodes_devices_create: operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1devices/get' + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices/post' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.devices - customers_devices_create: + nodes_devices_list: operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1devices/post' + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices/get' response: mediaType: application/json openAPIDocKey: '200' - customers_devices_sign_device: + objectKey: $.devices + nodes_devices_delete: operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}:signDevice/post + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}/delete' response: mediaType: application/json openAPIDocKey: '200' - customers_nodes_devices_create: + nodes_devices_get: operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices/post + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}/get' response: mediaType: application/json openAPIDocKey: '200' - customers_nodes_devices_list: + nodes_devices_patch: operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices/get + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}/patch' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.devices - nodes_devices_list: + nodes_devices_move: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices/get' + $ref: >- + #/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}:move/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.devices - nodes_devices_create: + nodes_devices_sign_device: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices/post' + $ref: >- + #/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}:signDevice/post response: mediaType: application/json openAPIDocKey: '200' - nodes_devices_patch: + nodes_nodes_devices_create: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}/patch' + $ref: >- + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices/post response: mediaType: application/json openAPIDocKey: '200' - nodes_devices_delete: + nodes_nodes_devices_list: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}/delete' + $ref: >- + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices/get response: mediaType: application/json openAPIDocKey: '200' - nodes_devices_get: + objectKey: $.devices + nodes_deployments_devices_create: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}/get' + $ref: >- + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}~1devices/post response: mediaType: application/json openAPIDocKey: '200' - nodes_devices_sign_device: + nodes_deployments_devices_list: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}:signDevice/post + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}~1devices/get response: mediaType: application/json openAPIDocKey: '200' - nodes_devices_move: + objectKey: $.devices + deployments_devices_delete: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}:move/post + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/delete response: mediaType: application/json openAPIDocKey: '200' - nodes_deployments_devices_create: + deployments_devices_get: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}~1devices/post + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/get response: mediaType: application/json openAPIDocKey: '200' - nodes_deployments_devices_list: + deployments_devices_patch: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}~1devices/get + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/patch response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.devices - nodes_nodes_devices_create: + deployments_devices_move: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices/post + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:move/post response: mediaType: application/json openAPIDocKey: '200' - nodes_nodes_devices_list: + deployments_devices_sign_device: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices/get + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:signDevice/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.devices sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/devices/methods/deployments_devices_get - - $ref: >- - #/components/x-stackQL-resources/devices/methods/customers_deployments_devices_list - $ref: >- #/components/x-stackQL-resources/devices/methods/customers_devices_get - $ref: >- #/components/x-stackQL-resources/devices/methods/customers_nodes_devices_list + - $ref: >- + #/components/x-stackQL-resources/devices/methods/customers_deployments_devices_list - $ref: '#/components/x-stackQL-resources/devices/methods/nodes_devices_get' + - $ref: >- + #/components/x-stackQL-resources/devices/methods/nodes_nodes_devices_list - $ref: >- #/components/x-stackQL-resources/devices/methods/nodes_deployments_devices_list - $ref: >- - #/components/x-stackQL-resources/devices/methods/nodes_nodes_devices_list + #/components/x-stackQL-resources/devices/methods/deployments_devices_get - $ref: >- #/components/x-stackQL-resources/devices/methods/customers_devices_list - $ref: >- #/components/x-stackQL-resources/devices/methods/nodes_devices_list insert: - - $ref: >- - #/components/x-stackQL-resources/devices/methods/customers_deployments_devices_create - $ref: >- #/components/x-stackQL-resources/devices/methods/customers_nodes_devices_create - $ref: >- - #/components/x-stackQL-resources/devices/methods/nodes_deployments_devices_create + #/components/x-stackQL-resources/devices/methods/customers_deployments_devices_create - $ref: >- #/components/x-stackQL-resources/devices/methods/nodes_nodes_devices_create + - $ref: >- + #/components/x-stackQL-resources/devices/methods/nodes_deployments_devices_create - $ref: >- #/components/x-stackQL-resources/devices/methods/customers_devices_create - $ref: >- #/components/x-stackQL-resources/devices/methods/nodes_devices_create update: - - $ref: >- - #/components/x-stackQL-resources/devices/methods/deployments_devices_patch - $ref: >- #/components/x-stackQL-resources/devices/methods/customers_devices_patch - $ref: >- #/components/x-stackQL-resources/devices/methods/nodes_devices_patch + - $ref: >- + #/components/x-stackQL-resources/devices/methods/deployments_devices_patch replace: [] delete: - - $ref: >- - #/components/x-stackQL-resources/devices/methods/deployments_devices_delete - $ref: >- #/components/x-stackQL-resources/devices/methods/customers_devices_delete - $ref: >- #/components/x-stackQL-resources/devices/methods/nodes_devices_delete + - $ref: >- + #/components/x-stackQL-resources/devices/methods/deployments_devices_delete devices_signed: id: google.prod_tt_sasportal.devices_signed name: devices_signed title: Devices_signed methods: - deployments_devices_update_signed: - operation: - $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:updateSigned/patch - response: - mediaType: application/json - openAPIDocKey: '200' - customers_deployments_devices_create_signed: + customers_devices_create_signed: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices:createSigned/post + #/paths/~1v1alpha1~1customers~1{customersId}~1devices:createSigned/post response: mediaType: application/json openAPIDocKey: '200' @@ -1622,17 +1523,17 @@ components: response: mediaType: application/json openAPIDocKey: '200' - customers_devices_create_signed: + customers_nodes_devices_create_signed: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices:createSigned/post + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices:createSigned/post response: mediaType: application/json openAPIDocKey: '200' - customers_nodes_devices_create_signed: + customers_deployments_devices_create_signed: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices:createSigned/post + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices:createSigned/post response: mediaType: application/json openAPIDocKey: '200' @@ -1649,6 +1550,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + nodes_nodes_devices_create_signed: + operation: + $ref: >- + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices:createSigned/post + response: + mediaType: application/json + openAPIDocKey: '200' nodes_deployments_devices_create_signed: operation: $ref: >- @@ -1656,149 +1564,93 @@ components: response: mediaType: application/json openAPIDocKey: '200' - nodes_nodes_devices_create_signed: + deployments_devices_update_signed: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices:createSigned/post + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:updateSigned/patch response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: [] insert: - - $ref: >- - #/components/x-stackQL-resources/devices_signed/methods/customers_deployments_devices_create_signed - $ref: >- #/components/x-stackQL-resources/devices_signed/methods/customers_nodes_devices_create_signed - $ref: >- - #/components/x-stackQL-resources/devices_signed/methods/nodes_deployments_devices_create_signed + #/components/x-stackQL-resources/devices_signed/methods/customers_deployments_devices_create_signed - $ref: >- #/components/x-stackQL-resources/devices_signed/methods/nodes_nodes_devices_create_signed + - $ref: >- + #/components/x-stackQL-resources/devices_signed/methods/nodes_deployments_devices_create_signed - $ref: >- #/components/x-stackQL-resources/devices_signed/methods/customers_devices_create_signed - $ref: >- #/components/x-stackQL-resources/devices_signed/methods/nodes_devices_create_signed update: - - $ref: >- - #/components/x-stackQL-resources/devices_signed/methods/deployments_devices_update_signed - $ref: >- #/components/x-stackQL-resources/devices_signed/methods/customers_devices_update_signed - $ref: >- #/components/x-stackQL-resources/devices_signed/methods/nodes_devices_update_signed - replace: [] - delete: [] - installer: - id: google.prod_tt_sasportal.installer - name: installer - title: Installer - methods: - installer_validate: - operation: - $ref: '#/paths/~1v1alpha1~1installer:validate/post' - response: - mediaType: application/json - openAPIDocKey: '200' - installer_generate_secret: - operation: - $ref: '#/paths/~1v1alpha1~1installer:generateSecret/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: [] - customers_gcp_project_deployments: - id: google.prod_tt_sasportal.customers_gcp_project_deployments - name: customers_gcp_project_deployments - title: Customers_gcp_project_deployments - methods: - customers_list_gcp_project_deployments: - operation: - $ref: '#/paths/~1v1alpha1~1customers:listGcpProjectDeployments/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - $ref: >- - #/components/x-stackQL-resources/customers_gcp_project_deployments/methods/customers_list_gcp_project_deployments - insert: [] - update: [] + #/components/x-stackQL-resources/devices_signed/methods/deployments_devices_update_signed replace: [] delete: [] - customers: - id: google.prod_tt_sasportal.customers - name: customers - title: Customers - methods: - customers_migrate_organization: - operation: - $ref: '#/paths/~1v1alpha1~1customers:migrateOrganization/post' - response: - mediaType: application/json - openAPIDocKey: '200' - customers_get: - operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - customers_patch: + customer_nodes: + id: google.prod_tt_sasportal.customer_nodes + name: customer_nodes + title: Customer_nodes + methods: + customers_nodes_create: operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}/patch' + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1nodes/post' response: mediaType: application/json openAPIDocKey: '200' - customers_provision_deployment: + customers_nodes_list: operation: - $ref: '#/paths/~1v1alpha1~1customers:provisionDeployment/post' + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1nodes/get' response: mediaType: application/json openAPIDocKey: '200' - customers_list: + objectKey: $.nodes + customers_nodes_delete: operation: - $ref: '#/paths/~1v1alpha1~1customers/get' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.customers - customers_setup_sas_analytics: + customers_nodes_nodes_create: operation: - $ref: '#/paths/~1v1alpha1~1customers:setupSasAnalytics/post' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1nodes/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/customers/methods/customers_get' - - $ref: '#/components/x-stackQL-resources/customers/methods/customers_list' - insert: [] - update: - - $ref: '#/components/x-stackQL-resources/customers/methods/customers_patch' - replace: [] - delete: [] - customers_legacy_organizations: - id: google.prod_tt_sasportal.customers_legacy_organizations - name: customers_legacy_organizations - title: Customers_legacy_organizations - methods: - customers_list_legacy_organizations: + customers_nodes_nodes_list: operation: - $ref: '#/paths/~1v1alpha1~1customers:listLegacyOrganizations/get' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1nodes/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.nodes sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/customers_legacy_organizations/methods/customers_list_legacy_organizations - insert: [] + #/components/x-stackQL-resources/customer_nodes/methods/customers_nodes_nodes_list + - $ref: >- + #/components/x-stackQL-resources/customer_nodes/methods/customers_nodes_list + insert: + - $ref: >- + #/components/x-stackQL-resources/customer_nodes/methods/customers_nodes_nodes_create + - $ref: >- + #/components/x-stackQL-resources/customer_nodes/methods/customers_nodes_create update: [] replace: [] - delete: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/customer_nodes/methods/customers_nodes_delete customer_node: id: google.prod_tt_sasportal.customer_node name: customer_node @@ -1818,42 +1670,66 @@ components: update: [] replace: [] delete: [] - customer_nodes: - id: google.prod_tt_sasportal.customer_nodes - name: customer_nodes - title: Customer_nodes + nodes: + id: google.prod_tt_sasportal.nodes + name: nodes + title: Nodes methods: - customers_nodes_delete: + customers_nodes_patch: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}/delete + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}/patch response: mediaType: application/json openAPIDocKey: '200' - customers_nodes_create: + customers_nodes_move: operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1nodes/post' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}:move/post response: mediaType: application/json openAPIDocKey: '200' - customers_nodes_list: + nodes_nodes_create: operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1nodes/get' + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes/post' + response: + mediaType: application/json + openAPIDocKey: '200' + nodes_nodes_list: + operation: + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.nodes - customers_nodes_nodes_create: + nodes_nodes_delete: operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1nodes/post + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}/delete' response: mediaType: application/json openAPIDocKey: '200' - customers_nodes_nodes_list: + nodes_nodes_patch: + operation: + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + nodes_nodes_move: + operation: + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}:move/post' + response: + mediaType: application/json + openAPIDocKey: '200' + nodes_nodes_nodes_create: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1nodes/get + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1nodes/post + response: + mediaType: application/json + openAPIDocKey: '200' + nodes_nodes_nodes_list: + operation: + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1nodes/get' response: mediaType: application/json openAPIDocKey: '200' @@ -1861,99 +1737,170 @@ components: sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/customer_nodes/methods/customers_nodes_nodes_list - - $ref: >- - #/components/x-stackQL-resources/customer_nodes/methods/customers_nodes_list + #/components/x-stackQL-resources/nodes/methods/nodes_nodes_nodes_list + - $ref: '#/components/x-stackQL-resources/nodes/methods/nodes_nodes_list' insert: - $ref: >- - #/components/x-stackQL-resources/customer_nodes/methods/customers_nodes_nodes_create + #/components/x-stackQL-resources/nodes/methods/nodes_nodes_nodes_create + - $ref: '#/components/x-stackQL-resources/nodes/methods/nodes_nodes_create' + update: - $ref: >- - #/components/x-stackQL-resources/customer_nodes/methods/customers_nodes_create - update: [] + #/components/x-stackQL-resources/nodes/methods/customers_nodes_patch + - $ref: '#/components/x-stackQL-resources/nodes/methods/nodes_nodes_patch' replace: [] delete: - - $ref: >- - #/components/x-stackQL-resources/customer_nodes/methods/customers_nodes_delete - nodes: - id: google.prod_tt_sasportal.nodes - name: nodes - title: Nodes + - $ref: '#/components/x-stackQL-resources/nodes/methods/nodes_nodes_delete' + deployments: + id: google.prod_tt_sasportal.deployments + name: deployments + title: Deployments methods: - customers_nodes_patch: + customers_nodes_deployments_create: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}/patch + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1deployments/post response: mediaType: application/json openAPIDocKey: '200' - customers_nodes_move: + customers_nodes_deployments_list: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}:move/post + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1deployments/get response: mediaType: application/json openAPIDocKey: '200' - nodes_nodes_patch: + objectKey: $.deployments + customers_deployments_create: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}/patch' + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1deployments/post' response: mediaType: application/json openAPIDocKey: '200' - nodes_nodes_delete: + customers_deployments_list: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}/delete' + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1deployments/get' response: mediaType: application/json openAPIDocKey: '200' - nodes_nodes_list: + objectKey: $.deployments + customers_deployments_delete: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes/get' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.nodes - nodes_nodes_create: + customers_deployments_get: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes/post' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/get response: mediaType: application/json openAPIDocKey: '200' - nodes_nodes_move: + customers_deployments_patch: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}:move/post' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/patch response: mediaType: application/json openAPIDocKey: '200' - nodes_nodes_nodes_list: + customers_deployments_move: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1nodes/get' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}:move/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.nodes - nodes_nodes_nodes_create: + nodes_nodes_deployments_create: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1nodes/post + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1deployments/post + response: + mediaType: application/json + openAPIDocKey: '200' + nodes_nodes_deployments_list: + operation: + $ref: >- + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1deployments/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.deployments + nodes_deployments_delete: + operation: + $ref: >- + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + nodes_deployments_get: + operation: + $ref: >- + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + nodes_deployments_patch: + operation: + $ref: >- + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + nodes_deployments_list: + operation: + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.deployments + nodes_deployments_move: + operation: + $ref: >- + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}:move/post + response: + mediaType: application/json + openAPIDocKey: '200' + deployments_get: + operation: + $ref: '#/paths/~1v1alpha1~1deployments~1{deploymentsId}/get' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/nodes/methods/nodes_nodes_nodes_list - - $ref: '#/components/x-stackQL-resources/nodes/methods/nodes_nodes_list' + #/components/x-stackQL-resources/deployments/methods/customers_nodes_deployments_list + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/customers_deployments_get + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/nodes_nodes_deployments_list + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/nodes_deployments_get + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/customers_deployments_list + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/nodes_deployments_list + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/deployments_get insert: - $ref: >- - #/components/x-stackQL-resources/nodes/methods/nodes_nodes_nodes_create - - $ref: '#/components/x-stackQL-resources/nodes/methods/nodes_nodes_create' + #/components/x-stackQL-resources/deployments/methods/customers_nodes_deployments_create + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/nodes_nodes_deployments_create + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/customers_deployments_create update: - $ref: >- - #/components/x-stackQL-resources/nodes/methods/customers_nodes_patch - - $ref: '#/components/x-stackQL-resources/nodes/methods/nodes_nodes_patch' + #/components/x-stackQL-resources/deployments/methods/customers_deployments_patch + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/nodes_deployments_patch replace: [] delete: - - $ref: '#/components/x-stackQL-resources/nodes/methods/nodes_nodes_delete' + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/customers_deployments_delete + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/nodes_deployments_delete node: id: google.prod_tt_sasportal.node name: node @@ -1979,28 +1926,201 @@ components: update: [] replace: [] delete: [] + installer: + id: google.prod_tt_sasportal.installer + name: installer + title: Installer + methods: + installer_generate_secret: + operation: + $ref: '#/paths/~1v1alpha1~1installer:generateSecret/post' + response: + mediaType: application/json + openAPIDocKey: '200' + installer_validate: + operation: + $ref: '#/paths/~1v1alpha1~1installer:validate/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + policies: + id: google.prod_tt_sasportal.policies + name: policies + title: Policies + methods: + policies_set: + operation: + $ref: '#/paths/~1v1alpha1~1policies:set/post' + response: + mediaType: application/json + openAPIDocKey: '200' + policies_get: + operation: + $ref: '#/paths/~1v1alpha1~1policies:get/post' + response: + mediaType: application/json + openAPIDocKey: '200' + policies_test: + operation: + $ref: '#/paths/~1v1alpha1~1policies:test/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/policies/methods/policies_get' + insert: [] + update: [] + replace: [] + delete: [] paths: - /v1alpha1/policies:test: + /v1alpha1/customers/{customersId}: parameters: &ref_1 - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' + get: + description: Returns a requested customer. + operationId: prod_tt_sasportal.customers.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/sasportal + Oauth2c: + - https://www.googleapis.com/auth/sasportal + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalCustomer' + parameters: + - in: path + name: customersId + required: true + schema: + type: string + patch: + description: Updates an existing customer. + operationId: prod_tt_sasportal.customers.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalCustomer' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/sasportal + Oauth2c: + - https://www.googleapis.com/auth/sasportal + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalCustomer' + parameters: + - in: path + name: customersId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1alpha1/customers: + parameters: *ref_1 + get: + description: Returns a list of requested customers. + operationId: prod_tt_sasportal.customers.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/sasportal + Oauth2c: + - https://www.googleapis.com/auth/sasportal + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalListCustomersResponse' + parameters: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1alpha1/customers:listGcpProjectDeployments: + parameters: *ref_1 + get: + description: >- + Returns a list of SAS deployments associated with current GCP project. + Includes whether SAS analytics has been enabled or not. + operationId: prod_tt_sasportal.customers.listGcpProjectDeployments + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/sasportal + Oauth2c: + - https://www.googleapis.com/auth/sasportal + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/SasPortalListGcpProjectDeploymentsResponse + parameters: [] + /v1alpha1/customers:provisionDeployment: + parameters: *ref_1 post: - description: Returns permissions that a caller has on the specified resource. - operationId: prod_tt_sasportal.policies.test + description: >- + Creates a new SAS deployment through the GCP workflow. Creates a SAS + organization if an organization match is not found. + operationId: prod_tt_sasportal.customers.provisionDeployment requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalTestPermissionsRequest' + $ref: '#/components/schemas/SasPortalProvisionDeploymentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2016,20 +2136,74 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalTestPermissionsResponse' + $ref: '#/components/schemas/SasPortalProvisionDeploymentResponse' parameters: [] - /v1alpha1/policies:get: + /v1alpha1/customers:listLegacyOrganizations: + parameters: *ref_1 + get: + description: Returns a list of legacy organizations. + operationId: prod_tt_sasportal.customers.listLegacyOrganizations + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/sasportal + Oauth2c: + - https://www.googleapis.com/auth/sasportal + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalListLegacyOrganizationsResponse' + parameters: [] + /v1alpha1/customers:migrateOrganization: + parameters: *ref_1 + post: + description: >- + Migrates a SAS organization to the cloud. This will create GCP projects + for each deployment and associate them. The SAS Organization is linked + to the gcp project that called the command. + go/sas-legacy-customer-migration + operationId: prod_tt_sasportal.customers.migrateOrganization + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalMigrateOrganizationRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/sasportal + Oauth2c: + - https://www.googleapis.com/auth/sasportal + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalOperation' + parameters: [] + /v1alpha1/customers:setupSasAnalytics: parameters: *ref_1 post: description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: prod_tt_sasportal.policies.get + Setups the a GCP Project to receive SAS Analytics messages via GCP + Pub/Sub with a subscription to BigQuery. All the Pub/Sub topics and + BigQuery tables are created automatically as part of this service. + operationId: prod_tt_sasportal.customers.setupSasAnalytics requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalGetPolicyRequest' + $ref: '#/components/schemas/SasPortalSetupSasAnalyticsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2045,20 +2219,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalPolicy' + $ref: '#/components/schemas/SasPortalOperation' parameters: [] - /v1alpha1/policies:set: + /v1alpha1/customers/{customersId}/devices: parameters: *ref_1 post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. - operationId: prod_tt_sasportal.policies.set + description: Creates a device under a node or customer. + operationId: prod_tt_sasportal.customers.devices.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalSetPolicyRequest' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2074,13 +2246,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalPolicy' - parameters: [] - /v1alpha1/deployments/{deploymentsId}: - parameters: *ref_1 + $ref: '#/components/schemas/SasPortalDevice' + parameters: + - in: path + name: customersId + required: true + schema: + type: string get: - description: Returns a requested deployment. - operationId: prod_tt_sasportal.deployments.get + description: Lists devices under a node or customer. + operationId: prod_tt_sasportal.customers.devices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2096,23 +2271,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalListDevicesResponse' parameters: - in: path - name: deploymentsId + name: customersId required: true schema: type: string - /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:move: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1alpha1/customers/{customersId}/devices:createSigned: parameters: *ref_1 post: - description: Moves a device under another node or customer. - operationId: prod_tt_sasportal.deployments.devices.move + description: Creates a signed device under a node or customer. + operationId: prod_tt_sasportal.customers.devices.createSigned requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalMoveDeviceRequest' + $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2128,23 +2316,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: deploymentsId - required: true - schema: - type: string - - in: path - name: devicesId + name: customersId required: true schema: type: string - /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}: + /v1alpha1/customers/{customersId}/devices/{devicesId}: parameters: *ref_1 delete: description: Deletes a device. - operationId: prod_tt_sasportal.deployments.devices.delete + operationId: prod_tt_sasportal.customers.devices.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2163,7 +2346,7 @@ paths: $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path - name: deploymentsId + name: customersId required: true schema: type: string @@ -2174,7 +2357,7 @@ paths: type: string get: description: Gets details about a device. - operationId: prod_tt_sasportal.deployments.devices.get + operationId: prod_tt_sasportal.customers.devices.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2193,7 +2376,7 @@ paths: $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: deploymentsId + name: customersId required: true schema: type: string @@ -2204,7 +2387,7 @@ paths: type: string patch: description: Updates a device. - operationId: prod_tt_sasportal.deployments.devices.patch + operationId: prod_tt_sasportal.customers.devices.patch requestBody: content: application/json: @@ -2228,7 +2411,7 @@ paths: $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: deploymentsId + name: customersId required: true schema: type: string @@ -2242,16 +2425,16 @@ paths: schema: type: string format: google-fieldmask - /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:signDevice: + /v1alpha1/customers/{customersId}/devices/{devicesId}:move: parameters: *ref_1 post: - description: Signs a device. - operationId: prod_tt_sasportal.deployments.devices.signDevice + description: Moves a device under another node or customer. + operationId: prod_tt_sasportal.customers.devices.move requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalSignDeviceRequest' + $ref: '#/components/schemas/SasPortalMoveDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2267,10 +2450,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path - name: deploymentsId + name: customersId required: true schema: type: string @@ -2279,11 +2462,11 @@ paths: required: true schema: type: string - /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:updateSigned: + /v1alpha1/customers/{customersId}/devices/{devicesId}:updateSigned: parameters: *ref_1 patch: description: Updates a signed device. - operationId: prod_tt_sasportal.deployments.devices.updateSigned + operationId: prod_tt_sasportal.customers.devices.updateSigned requestBody: content: application/json: @@ -2307,7 +2490,7 @@ paths: $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: deploymentsId + name: customersId required: true schema: type: string @@ -2316,67 +2499,16 @@ paths: required: true schema: type: string - /v1alpha1/installer:validate: - parameters: *ref_1 - post: - description: Validates the identity of a Certified Professional Installer (CPI). - operationId: prod_tt_sasportal.installer.validate - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalValidateInstallerRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/sasportal - Oauth2c: - - https://www.googleapis.com/auth/sasportal - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalValidateInstallerResponse' - parameters: [] - /v1alpha1/installer:generateSecret: + /v1alpha1/customers/{customersId}/devices/{devicesId}:signDevice: parameters: *ref_1 post: - description: Generates a secret to be used with the ValidateInstaller. - operationId: prod_tt_sasportal.installer.generateSecret + description: Signs a device. + operationId: prod_tt_sasportal.customers.devices.signDevice requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalGenerateSecretRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/sasportal - Oauth2c: - - https://www.googleapis.com/auth/sasportal - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalGenerateSecretResponse' - parameters: [] - /v1alpha1/customers:listGcpProjectDeployments: - parameters: *ref_1 - get: - description: >- - Returns a list of SAS deployments associated with current GCP project. - Includes whether SAS analytics has been enabled or not. - operationId: prod_tt_sasportal.customers.listGcpProjectDeployments + $ref: '#/components/schemas/SasPortalSignDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2392,23 +2524,28 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/SasPortalListGcpProjectDeploymentsResponse - parameters: [] - /v1alpha1/customers:migrateOrganization: + $ref: '#/components/schemas/SasPortalEmpty' + parameters: + - in: path + name: customersId + required: true + schema: + type: string + - in: path + name: devicesId + required: true + schema: + type: string + /v1alpha1/customers/{customersId}/nodes: parameters: *ref_1 post: - description: >- - Migrates a SAS organization to the cloud. This will create GCP projects - for each deployment and associate them. The SAS Organization is linked - to the gcp project that called the command. - go/sas-legacy-customer-migration - operationId: prod_tt_sasportal.customers.migrateOrganization + description: Creates a new node. + operationId: prod_tt_sasportal.customers.nodes.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalMigrateOrganizationRequest' + $ref: '#/components/schemas/SasPortalNode' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2424,13 +2561,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' - parameters: [] - /v1alpha1/customers/{customersId}: - parameters: *ref_1 + $ref: '#/components/schemas/SasPortalNode' + parameters: + - in: path + name: customersId + required: true + schema: + type: string get: - description: Returns a requested customer. - operationId: prod_tt_sasportal.customers.get + description: Lists nodes. + operationId: prod_tt_sasportal.customers.nodes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2446,21 +2586,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCustomer' + $ref: '#/components/schemas/SasPortalListNodesResponse' parameters: - in: path name: customersId required: true schema: type: string - patch: - description: Updates an existing customer. - operationId: prod_tt_sasportal.customers.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalCustomer' + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1alpha1/customers/{customersId}/nodes/{nodesId}: + parameters: *ref_1 + delete: + description: Deletes a node. + operationId: prod_tt_sasportal.customers.nodes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2476,23 +2626,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCustomer' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path name: customersId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: nodesId + required: true schema: type: string - format: google-fieldmask - /v1alpha1/customers:listLegacyOrganizations: - parameters: *ref_1 get: - description: Returns a list of legacy organizations. - operationId: prod_tt_sasportal.customers.listLegacyOrganizations + description: Returns a requested node. + operationId: prod_tt_sasportal.customers.nodes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2508,20 +2656,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListLegacyOrganizationsResponse' - parameters: [] - /v1alpha1/customers:provisionDeployment: - parameters: *ref_1 - post: - description: >- - Creates a new SAS deployment through the GCP workflow. Creates a SAS - organization if an organization match is not found. - operationId: prod_tt_sasportal.customers.provisionDeployment + $ref: '#/components/schemas/SasPortalNode' + parameters: + - in: path + name: customersId + required: true + schema: + type: string + - in: path + name: nodesId + required: true + schema: + type: string + patch: + description: Updates an existing node. + operationId: prod_tt_sasportal.customers.nodes.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalProvisionDeploymentRequest' + $ref: '#/components/schemas/SasPortalNode' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2537,13 +2691,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalProvisionDeploymentResponse' - parameters: [] - /v1alpha1/customers: + $ref: '#/components/schemas/SasPortalNode' + parameters: + - in: path + name: customersId + required: true + schema: + type: string + - in: path + name: nodesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1alpha1/customers/{customersId}/nodes/{nodesId}:move: parameters: *ref_1 - get: - description: Returns a list of requested customers. - operationId: prod_tt_sasportal.customers.list + post: + description: Moves a node under another node or customer. + operationId: prod_tt_sasportal.customers.nodes.move + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalMoveNodeRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2559,30 +2733,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListCustomersResponse' + $ref: '#/components/schemas/SasPortalOperation' parameters: - - in: query - name: pageToken + - in: path + name: customersId + required: true schema: type: string - - in: query - name: pageSize + - in: path + name: nodesId + required: true schema: - type: integer - format: int32 - /v1alpha1/customers:setupSasAnalytics: + type: string + /v1alpha1/customers/{customersId}/nodes/{nodesId}/devices: parameters: *ref_1 post: - description: >- - Setups the a GCP Project to receive SAS Analytics messages via GCP - Pub/Sub with a subscription to BigQuery. All the Pub/Sub topics and - BigQuery tables are created automatically as part of this service. - operationId: prod_tt_sasportal.customers.setupSasAnalytics + description: Creates a device under a node or customer. + operationId: prod_tt_sasportal.customers.nodes.devices.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalSetupSasAnalyticsRequest' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2598,13 +2770,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' - parameters: [] - /v1alpha1/customers/{customersId}/deployments/{deploymentsId}/devices: - parameters: *ref_1 + $ref: '#/components/schemas/SasPortalDevice' + parameters: + - in: path + name: customersId + required: true + schema: + type: string + - in: path + name: nodesId + required: true + schema: + type: string get: description: Lists devices under a node or customer. - operationId: prod_tt_sasportal.customers.deployments.devices.list + operationId: prod_tt_sasportal.customers.nodes.devices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2628,7 +2808,7 @@ paths: schema: type: string - in: path - name: deploymentsId + name: nodesId required: true schema: type: string @@ -2645,14 +2825,16 @@ paths: name: filter schema: type: string + /v1alpha1/customers/{customersId}/nodes/{nodesId}/devices:createSigned: + parameters: *ref_1 post: - description: Creates a device under a node or customer. - operationId: prod_tt_sasportal.customers.deployments.devices.create + description: Creates a signed device under a node or customer. + operationId: prod_tt_sasportal.customers.nodes.devices.createSigned requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2676,20 +2858,20 @@ paths: schema: type: string - in: path - name: deploymentsId + name: nodesId required: true schema: type: string - /v1alpha1/customers/{customersId}/deployments/{deploymentsId}/devices:createSigned: + /v1alpha1/customers/{customersId}/nodes/{nodesId}/nodes: parameters: *ref_1 post: - description: Creates a signed device under a node or customer. - operationId: prod_tt_sasportal.customers.deployments.devices.createSigned + description: Creates a new node. + operationId: prod_tt_sasportal.customers.nodes.nodes.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' + $ref: '#/components/schemas/SasPortalNode' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2705,7 +2887,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalNode' parameters: - in: path name: customersId @@ -2713,15 +2895,13 @@ paths: schema: type: string - in: path - name: deploymentsId + name: nodesId required: true schema: type: string - /v1alpha1/customers/{customersId}/deployments/{deploymentsId}: - parameters: *ref_1 get: - description: Returns a requested deployment. - operationId: prod_tt_sasportal.customers.deployments.get + description: Lists nodes. + operationId: prod_tt_sasportal.customers.nodes.nodes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2737,7 +2917,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalListNodesResponse' parameters: - in: path name: customersId @@ -2745,43 +2925,28 @@ paths: schema: type: string - in: path - name: deploymentsId + name: nodesId required: true schema: type: string - delete: - description: Deletes a deployment. - operationId: prod_tt_sasportal.customers.deployments.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/sasportal - Oauth2c: - - https://www.googleapis.com/auth/sasportal - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalEmpty' - parameters: - - in: path - name: customersId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - - in: path - name: deploymentsId - required: true + - in: query + name: filter schema: type: string - patch: - description: Updates an existing deployment. - operationId: prod_tt_sasportal.customers.deployments.patch + /v1alpha1/customers/{customersId}/nodes/{nodesId}/deployments: + parameters: *ref_1 + post: + description: Creates a new deployment. + operationId: prod_tt_sasportal.customers.nodes.deployments.create requestBody: content: application/json: @@ -2810,25 +2975,13 @@ paths: schema: type: string - in: path - name: deploymentsId + name: nodesId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1alpha1/customers/{customersId}/deployments/{deploymentsId}:move: - parameters: *ref_1 - post: - description: Moves a deployment under another node or customer. - operationId: prod_tt_sasportal.customers.deployments.move - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalMoveDeploymentRequest' + get: + description: Lists deployments. + operationId: prod_tt_sasportal.customers.nodes.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2844,7 +2997,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalListDeploymentsResponse' parameters: - in: path name: customersId @@ -2852,10 +3005,23 @@ paths: schema: type: string - in: path - name: deploymentsId + name: nodesId required: true schema: type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string /v1alpha1/customers/{customersId}/deployments: parameters: *ref_1 post: @@ -2913,10 +3079,6 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - in: query name: pageSize schema: @@ -2926,46 +3088,15 @@ paths: name: pageToken schema: type: string - /v1alpha1/customers/{customersId}/devices/{devicesId}: - parameters: *ref_1 - get: - description: Gets details about a device. - operationId: prod_tt_sasportal.customers.devices.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/sasportal - Oauth2c: - - https://www.googleapis.com/auth/sasportal - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalDevice' - parameters: - - in: path - name: customersId - required: true - schema: - type: string - - in: path - name: devicesId - required: true + - in: query + name: filter schema: type: string - patch: - description: Updates a device. - operationId: prod_tt_sasportal.customers.devices.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalDevice' + /v1alpha1/customers/{customersId}/deployments/{deploymentsId}: + parameters: *ref_1 + delete: + description: Deletes a deployment. + operationId: prod_tt_sasportal.customers.deployments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2981,7 +3112,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path name: customersId @@ -2989,18 +3120,13 @@ paths: schema: type: string - in: path - name: devicesId + name: deploymentsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: - description: Deletes a device. - operationId: prod_tt_sasportal.customers.devices.delete + get: + description: Returns a requested deployment. + operationId: prod_tt_sasportal.customers.deployments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3016,7 +3142,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path name: customersId @@ -3024,20 +3150,18 @@ paths: schema: type: string - in: path - name: devicesId + name: deploymentsId required: true schema: type: string - /v1alpha1/customers/{customersId}/devices/{devicesId}:updateSigned: - parameters: *ref_1 patch: - description: Updates a signed device. - operationId: prod_tt_sasportal.customers.devices.updateSigned + description: Updates an existing deployment. + operationId: prod_tt_sasportal.customers.deployments.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalUpdateSignedDeviceRequest' + $ref: '#/components/schemas/SasPortalDeployment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3053,7 +3177,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path name: customersId @@ -3061,20 +3185,25 @@ paths: schema: type: string - in: path - name: devicesId + name: deploymentsId required: true schema: type: string - /v1alpha1/customers/{customersId}/devices:createSigned: + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1alpha1/customers/{customersId}/deployments/{deploymentsId}:move: parameters: *ref_1 post: - description: Creates a signed device under a node or customer. - operationId: prod_tt_sasportal.customers.devices.createSigned + description: Moves a deployment under another node or customer. + operationId: prod_tt_sasportal.customers.deployments.move requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' + $ref: '#/components/schemas/SasPortalMoveDeploymentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3090,23 +3219,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path name: customersId required: true schema: type: string - /v1alpha1/customers/{customersId}/devices/{devicesId}:move: + - in: path + name: deploymentsId + required: true + schema: + type: string + /v1alpha1/customers/{customersId}/deployments/{deploymentsId}/devices: parameters: *ref_1 post: - description: Moves a device under another node or customer. - operationId: prod_tt_sasportal.customers.devices.move + description: Creates a device under a node or customer. + operationId: prod_tt_sasportal.customers.deployments.devices.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalMoveDeviceRequest' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3122,7 +3256,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: customersId @@ -3130,15 +3264,13 @@ paths: schema: type: string - in: path - name: devicesId + name: deploymentsId required: true schema: type: string - /v1alpha1/customers/{customersId}/devices: - parameters: *ref_1 get: description: Lists devices under a node or customer. - operationId: prod_tt_sasportal.customers.devices.list + operationId: prod_tt_sasportal.customers.deployments.devices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3161,12 +3293,9 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + - in: path + name: deploymentsId + required: true schema: type: string - in: query @@ -3174,46 +3303,24 @@ paths: schema: type: integer format: int32 - post: - description: Creates a device under a node or customer. - operationId: prod_tt_sasportal.customers.devices.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalDevice' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/sasportal - Oauth2c: - - https://www.googleapis.com/auth/sasportal - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalDevice' - parameters: - - in: path - name: customersId - required: true + - in: query + name: pageToken schema: type: string - /v1alpha1/customers/{customersId}/devices/{devicesId}:signDevice: + - in: query + name: filter + schema: + type: string + /v1alpha1/customers/{customersId}/deployments/{deploymentsId}/devices:createSigned: parameters: *ref_1 post: - description: Signs a device. - operationId: prod_tt_sasportal.customers.devices.signDevice + description: Creates a signed device under a node or customer. + operationId: prod_tt_sasportal.customers.deployments.devices.createSigned requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalSignDeviceRequest' + $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3229,7 +3336,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: customersId @@ -3237,15 +3344,15 @@ paths: schema: type: string - in: path - name: devicesId + name: deploymentsId required: true schema: type: string - /v1alpha1/customers/{customersId}/nodes/{nodesId}: + /v1alpha1/nodes/{nodesId}: parameters: *ref_1 get: description: Returns a requested node. - operationId: prod_tt_sasportal.customers.nodes.get + operationId: prod_tt_sasportal.nodes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3263,19 +3370,21 @@ paths: schema: $ref: '#/components/schemas/SasPortalNode' parameters: - - in: path - name: customersId - required: true - schema: - type: string - in: path name: nodesId required: true schema: type: string - delete: - description: Deletes a node. - operationId: prod_tt_sasportal.customers.nodes.delete + /v1alpha1/nodes/{nodesId}/devices: + parameters: *ref_1 + post: + description: Creates a device under a node or customer. + operationId: prod_tt_sasportal.nodes.devices.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3291,26 +3400,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalDevice' parameters: - - in: path - name: customersId - required: true - schema: - type: string - in: path name: nodesId required: true schema: type: string - patch: - description: Updates an existing node. - operationId: prod_tt_sasportal.customers.nodes.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalNode' + get: + description: Lists devices under a node or customer. + operationId: prod_tt_sasportal.nodes.devices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3326,33 +3425,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalListDevicesResponse' parameters: - in: path - name: customersId + name: nodesId required: true schema: type: string - - in: path - name: nodesId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - in: query - name: updateMask + name: filter schema: type: string - format: google-fieldmask - /v1alpha1/customers/{customersId}/nodes/{nodesId}:move: + /v1alpha1/nodes/{nodesId}/devices:createSigned: parameters: *ref_1 post: - description: Moves a node under another node or customer. - operationId: prod_tt_sasportal.customers.nodes.move + description: Creates a signed device under a node or customer. + operationId: prod_tt_sasportal.nodes.devices.createSigned requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalMoveNodeRequest' + $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3368,28 +3470,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalDevice' parameters: - - in: path - name: customersId - required: true - schema: - type: string - in: path name: nodesId required: true schema: type: string - /v1alpha1/customers/{customersId}/nodes: + /v1alpha1/nodes/{nodesId}/devices/{devicesId}: parameters: *ref_1 - post: - description: Creates a new node. - operationId: prod_tt_sasportal.customers.nodes.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalNode' + delete: + description: Deletes a device. + operationId: prod_tt_sasportal.nodes.devices.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3405,61 +3497,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path - name: customersId + name: nodesId required: true schema: type: string - get: - description: Lists nodes. - operationId: prod_tt_sasportal.customers.nodes.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/sasportal - Oauth2c: - - https://www.googleapis.com/auth/sasportal - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalListNodesResponse' - parameters: - in: path - name: customersId + name: devicesId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - /v1alpha1/customers/{customersId}/nodes/{nodesId}/nodes: - parameters: *ref_1 - post: - description: Creates a new node. - operationId: prod_tt_sasportal.customers.nodes.nodes.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalNode' + get: + description: Gets details about a device. + operationId: prod_tt_sasportal.nodes.devices.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3475,21 +3527,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: customersId + name: nodesId required: true schema: type: string - in: path - name: nodesId + name: devicesId required: true schema: type: string - get: - description: Lists nodes. - operationId: prod_tt_sasportal.customers.nodes.nodes.list + patch: + description: Updates a device. + operationId: prod_tt_sasportal.nodes.devices.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3505,36 +3562,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListNodesResponse' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: customersId + name: nodesId required: true schema: type: string - in: path - name: nodesId + name: devicesId required: true schema: type: string - in: query - name: filter - schema: - type: string - - in: query - name: pageToken + name: updateMask schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1alpha1/customers/{customersId}/nodes/{nodesId}/deployments: + format: google-fieldmask + /v1alpha1/nodes/{nodesId}/devices/{devicesId}:move: parameters: *ref_1 - get: - description: Lists deployments. - operationId: prod_tt_sasportal.customers.nodes.deployments.list + post: + description: Moves a device under another node or customer. + operationId: prod_tt_sasportal.nodes.devices.move + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalMoveDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3550,39 +3604,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDeploymentsResponse' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path - name: customersId + name: nodesId required: true schema: type: string - in: path - name: nodesId + name: devicesId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - post: - description: Creates a new deployment. - operationId: prod_tt_sasportal.customers.nodes.deployments.create + /v1alpha1/nodes/{nodesId}/devices/{devicesId}:updateSigned: + parameters: *ref_1 + patch: + description: Updates a signed device. + operationId: prod_tt_sasportal.nodes.devices.updateSigned requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalUpdateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3598,28 +3641,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: customersId + name: nodesId required: true schema: type: string - in: path - name: nodesId + name: devicesId required: true schema: type: string - /v1alpha1/customers/{customersId}/nodes/{nodesId}/devices:createSigned: + /v1alpha1/nodes/{nodesId}/devices/{devicesId}:signDevice: parameters: *ref_1 post: - description: Creates a signed device under a node or customer. - operationId: prod_tt_sasportal.customers.nodes.devices.createSigned + description: Signs a device. + operationId: prod_tt_sasportal.nodes.devices.signDevice requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' + $ref: '#/components/schemas/SasPortalSignDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3635,28 +3678,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path - name: customersId + name: nodesId required: true schema: type: string - in: path - name: nodesId + name: devicesId required: true schema: type: string - /v1alpha1/customers/{customersId}/nodes/{nodesId}/devices: + /v1alpha1/nodes/{nodesId}/nodes: parameters: *ref_1 post: - description: Creates a device under a node or customer. - operationId: prod_tt_sasportal.customers.nodes.devices.create + description: Creates a new node. + operationId: prod_tt_sasportal.nodes.nodes.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalNode' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3672,21 +3715,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalNode' parameters: - - in: path - name: customersId - required: true - schema: - type: string - in: path name: nodesId required: true schema: type: string get: - description: Lists devices under a node or customer. - operationId: prod_tt_sasportal.customers.nodes.devices.list + description: Lists nodes. + operationId: prod_tt_sasportal.nodes.nodes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3702,36 +3740,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDevicesResponse' + $ref: '#/components/schemas/SasPortalListNodesResponse' parameters: - - in: path - name: customersId - required: true - schema: - type: string - in: path name: nodesId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - in: query name: pageSize schema: type: integer format: int32 + - in: query + name: pageToken + schema: + type: string - in: query name: filter schema: type: string - /v1alpha1/nodes/{nodesId}: + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}: parameters: *ref_1 - get: - description: Returns a requested node. - operationId: prod_tt_sasportal.nodes.get + delete: + description: Deletes a node. + operationId: prod_tt_sasportal.nodes.nodes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3747,18 +3780,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path name: nodesId required: true schema: type: string - /v1alpha1/nodes/{nodesId}/devices: - parameters: *ref_1 + - in: path + name: nodesId1 + required: true + schema: + type: string get: - description: Lists devices under a node or customer. - operationId: prod_tt_sasportal.nodes.devices.list + description: Returns a requested node. + operationId: prod_tt_sasportal.nodes.nodes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3774,34 +3810,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDevicesResponse' + $ref: '#/components/schemas/SasPortalNode' parameters: - in: path name: nodesId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: nodesId1 + required: true schema: type: string - post: - description: Creates a device under a node or customer. - operationId: prod_tt_sasportal.nodes.devices.create + patch: + description: Updates an existing node. + operationId: prod_tt_sasportal.nodes.nodes.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalNode' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3817,23 +3845,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalNode' parameters: - in: path name: nodesId required: true schema: type: string - /v1alpha1/nodes/{nodesId}/devices:createSigned: + - in: path + name: nodesId1 + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}:move: parameters: *ref_1 post: - description: Creates a signed device under a node or customer. - operationId: prod_tt_sasportal.nodes.devices.createSigned + description: Moves a node under another node or customer. + operationId: prod_tt_sasportal.nodes.nodes.move requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' + $ref: '#/components/schemas/SasPortalMoveNodeRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3849,18 +3887,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path name: nodesId required: true schema: type: string - /v1alpha1/nodes/{nodesId}/devices/{devicesId}: + - in: path + name: nodesId1 + required: true + schema: + type: string + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/devices: parameters: *ref_1 - patch: - description: Updates a device. - operationId: prod_tt_sasportal.nodes.devices.patch + post: + description: Creates a device under a node or customer. + operationId: prod_tt_sasportal.nodes.nodes.devices.create requestBody: content: application/json: @@ -3889,18 +3932,13 @@ paths: schema: type: string - in: path - name: devicesId + name: nodesId1 required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: - description: Deletes a device. - operationId: prod_tt_sasportal.nodes.devices.delete + get: + description: Lists devices under a node or customer. + operationId: prod_tt_sasportal.nodes.nodes.devices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3916,7 +3954,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalListDevicesResponse' parameters: - in: path name: nodesId @@ -3924,50 +3962,33 @@ paths: schema: type: string - in: path - name: devicesId + name: nodesId1 required: true schema: type: string - get: - description: Gets details about a device. - operationId: prod_tt_sasportal.nodes.devices.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/sasportal - Oauth2c: - - https://www.googleapis.com/auth/sasportal - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalDevice' - parameters: - - in: path - name: nodesId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - - in: path - name: devicesId - required: true + - in: query + name: filter schema: type: string - /v1alpha1/nodes/{nodesId}/devices/{devicesId}:signDevice: + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/devices:createSigned: parameters: *ref_1 post: - description: Signs a device. - operationId: prod_tt_sasportal.nodes.devices.signDevice + description: Creates a signed device under a node or customer. + operationId: prod_tt_sasportal.nodes.nodes.devices.createSigned requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalSignDeviceRequest' + $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3983,7 +4004,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: nodesId @@ -3991,20 +4012,20 @@ paths: schema: type: string - in: path - name: devicesId + name: nodesId1 required: true schema: type: string - /v1alpha1/nodes/{nodesId}/devices/{devicesId}:updateSigned: + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/nodes: parameters: *ref_1 - patch: - description: Updates a signed device. - operationId: prod_tt_sasportal.nodes.devices.updateSigned + post: + description: Creates a new node. + operationId: prod_tt_sasportal.nodes.nodes.nodes.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalUpdateSignedDeviceRequest' + $ref: '#/components/schemas/SasPortalNode' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4020,7 +4041,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalNode' parameters: - in: path name: nodesId @@ -4028,20 +4049,13 @@ paths: schema: type: string - in: path - name: devicesId + name: nodesId1 required: true schema: type: string - /v1alpha1/nodes/{nodesId}/devices/{devicesId}:move: - parameters: *ref_1 - post: - description: Moves a device under another node or customer. - operationId: prod_tt_sasportal.nodes.devices.move - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalMoveDeviceRequest' + get: + description: Lists nodes. + operationId: prod_tt_sasportal.nodes.nodes.nodes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4057,7 +4071,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalListNodesResponse' parameters: - in: path name: nodesId @@ -4065,20 +4079,33 @@ paths: schema: type: string - in: path - name: devicesId + name: nodesId1 required: true schema: type: string - /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}/devices: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/deployments: parameters: *ref_1 post: - description: Creates a device under a node or customer. - operationId: prod_tt_sasportal.nodes.deployments.devices.create + description: Creates a new deployment. + operationId: prod_tt_sasportal.nodes.nodes.deployments.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalDeployment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4094,7 +4121,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path name: nodesId @@ -4102,13 +4129,13 @@ paths: schema: type: string - in: path - name: deploymentsId + name: nodesId1 required: true schema: type: string get: - description: Lists devices under a node or customer. - operationId: prod_tt_sasportal.nodes.deployments.devices.list + description: Lists deployments. + operationId: prod_tt_sasportal.nodes.nodes.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4124,7 +4151,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDevicesResponse' + $ref: '#/components/schemas/SasPortalListDeploymentsResponse' parameters: - in: path name: nodesId @@ -4132,10 +4159,15 @@ paths: schema: type: string - in: path - name: deploymentsId + name: nodesId1 required: true schema: type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 - in: query name: pageToken schema: @@ -4144,21 +4176,11 @@ paths: name: filter schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}/devices:createSigned: + /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}: parameters: *ref_1 - post: - description: Creates a signed device under a node or customer. - operationId: prod_tt_sasportal.nodes.deployments.devices.createSigned - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' + delete: + description: Deletes a deployment. + operationId: prod_tt_sasportal.nodes.deployments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4174,7 +4196,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path name: nodesId @@ -4186,8 +4208,6 @@ paths: required: true schema: type: string - /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}: - parameters: *ref_1 get: description: Returns a requested deployment. operationId: prod_tt_sasportal.nodes.deployments.get @@ -4258,9 +4278,11 @@ paths: schema: type: string format: google-fieldmask - delete: - description: Deletes a deployment. - operationId: prod_tt_sasportal.nodes.deployments.delete + /v1alpha1/nodes/{nodesId}/deployments: + parameters: *ref_1 + get: + description: Lists deployments. + operationId: prod_tt_sasportal.nodes.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4276,16 +4298,24 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalListDeploymentsResponse' parameters: - in: path name: nodesId required: true schema: type: string - - in: path - name: deploymentsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter schema: type: string /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}:move: @@ -4325,11 +4355,16 @@ paths: required: true schema: type: string - /v1alpha1/nodes/{nodesId}/deployments: + /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}/devices: parameters: *ref_1 - get: - description: Lists deployments. - operationId: prod_tt_sasportal.nodes.deployments.list + post: + description: Creates a device under a node or customer. + operationId: prod_tt_sasportal.nodes.deployments.devices.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4345,36 +4380,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDeploymentsResponse' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: nodesId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: deploymentsId + required: true schema: type: string - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}: - parameters: *ref_1 - patch: - description: Updates an existing node. - operationId: prod_tt_sasportal.nodes.nodes.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalNode' + get: + description: Lists devices under a node or customer. + operationId: prod_tt_sasportal.nodes.deployments.devices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4390,7 +4410,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalListDevicesResponse' parameters: - in: path name: nodesId @@ -4398,18 +4418,33 @@ paths: schema: type: string - in: path - name: nodesId1 + name: deploymentsId required: true schema: type: string - in: query - name: updateMask + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - format: google-fieldmask - get: - description: Returns a requested node. - operationId: prod_tt_sasportal.nodes.nodes.get + - in: query + name: filter + schema: + type: string + /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}/devices:createSigned: + parameters: *ref_1 + post: + description: Creates a signed device under a node or customer. + operationId: prod_tt_sasportal.nodes.deployments.devices.createSigned + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4425,7 +4460,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: nodesId @@ -4433,13 +4468,20 @@ paths: schema: type: string - in: path - name: nodesId1 + name: deploymentsId required: true schema: type: string - delete: - description: Deletes a node. - operationId: prod_tt_sasportal.nodes.nodes.delete + /v1alpha1/installer:generateSecret: + parameters: *ref_1 + post: + description: Generates a secret to be used with the ValidateInstaller. + operationId: prod_tt_sasportal.installer.generateSecret + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalGenerateSecretRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4455,23 +4497,40 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' - parameters: - - in: path - name: nodesId - required: true - schema: - type: string - - in: path - name: nodesId1 - required: true - schema: - type: string - /v1alpha1/nodes/{nodesId}/nodes: + $ref: '#/components/schemas/SasPortalGenerateSecretResponse' + parameters: [] + /v1alpha1/installer:validate: + parameters: *ref_1 + post: + description: Validates the identity of a Certified Professional Installer (CPI). + operationId: prod_tt_sasportal.installer.validate + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalValidateInstallerRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/sasportal + Oauth2c: + - https://www.googleapis.com/auth/sasportal + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalValidateInstallerResponse' + parameters: [] + /v1alpha1/deployments/{deploymentsId}: parameters: *ref_1 get: - description: Lists nodes. - operationId: prod_tt_sasportal.nodes.nodes.list + description: Returns a requested deployment. + operationId: prod_tt_sasportal.deployments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4487,34 +4546,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListNodesResponse' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path - name: nodesId + name: deploymentsId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - post: - description: Creates a new node. - operationId: prod_tt_sasportal.nodes.nodes.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalNode' + /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}: + parameters: *ref_1 + delete: + description: Deletes a device. + operationId: prod_tt_sasportal.deployments.devices.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4530,23 +4573,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path - name: nodesId + name: deploymentsId required: true schema: type: string - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}:move: - parameters: *ref_1 - post: - description: Moves a node under another node or customer. - operationId: prod_tt_sasportal.nodes.nodes.move - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalMoveNodeRequest' + - in: path + name: devicesId + required: true + schema: + type: string + get: + description: Gets details about a device. + operationId: prod_tt_sasportal.deployments.devices.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4562,23 +4603,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: nodesId + name: deploymentsId required: true schema: type: string - in: path - name: nodesId1 + name: devicesId required: true schema: type: string - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/devices: - parameters: *ref_1 - post: - description: Creates a device under a node or customer. - operationId: prod_tt_sasportal.nodes.nodes.devices.create + patch: + description: Updates a device. + operationId: prod_tt_sasportal.deployments.devices.patch requestBody: content: application/json: @@ -4602,18 +4641,30 @@ paths: $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: nodesId + name: deploymentsId required: true schema: type: string - in: path - name: nodesId1 + name: devicesId required: true schema: type: string - get: - description: Lists devices under a node or customer. - operationId: prod_tt_sasportal.nodes.nodes.devices.list + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:move: + parameters: *ref_1 + post: + description: Moves a device under another node or customer. + operationId: prod_tt_sasportal.deployments.devices.move + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalMoveDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4629,41 +4680,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDevicesResponse' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path - name: nodesId + name: deploymentsId required: true schema: type: string - in: path - name: nodesId1 + name: devicesId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/devices:createSigned: + /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:updateSigned: parameters: *ref_1 - post: - description: Creates a signed device under a node or customer. - operationId: prod_tt_sasportal.nodes.nodes.devices.createSigned + patch: + description: Updates a signed device. + operationId: prod_tt_sasportal.deployments.devices.updateSigned requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' + $ref: '#/components/schemas/SasPortalUpdateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4682,20 +4720,25 @@ paths: $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: nodesId + name: deploymentsId required: true schema: type: string - in: path - name: nodesId1 + name: devicesId required: true schema: type: string - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/deployments: + /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:signDevice: parameters: *ref_1 - get: - description: Lists deployments. - operationId: prod_tt_sasportal.nodes.nodes.deployments.list + post: + description: Signs a device. + operationId: prod_tt_sasportal.deployments.devices.signDevice + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalSignDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4711,39 +4754,30 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDeploymentsResponse' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path - name: nodesId + name: deploymentsId required: true schema: type: string - in: path - name: nodesId1 + name: devicesId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 + /v1alpha1/policies:set: + parameters: *ref_1 post: - description: Creates a new deployment. - operationId: prod_tt_sasportal.nodes.nodes.deployments.create + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy. + operationId: prod_tt_sasportal.policies.set requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalSetPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4759,23 +4793,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' - parameters: - - in: path - name: nodesId - required: true - schema: - type: string - - in: path - name: nodesId1 - required: true - schema: - type: string - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/nodes: + $ref: '#/components/schemas/SasPortalPolicy' + parameters: [] + /v1alpha1/policies:get: parameters: *ref_1 - get: - description: Lists nodes. - operationId: prod_tt_sasportal.nodes.nodes.nodes.list + post: + description: >- + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: prod_tt_sasportal.policies.get + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalGetPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4791,39 +4822,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListNodesResponse' - parameters: - - in: path - name: nodesId - required: true - schema: - type: string - - in: path - name: nodesId1 - required: true - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string + $ref: '#/components/schemas/SasPortalPolicy' + parameters: [] + /v1alpha1/policies:test: + parameters: *ref_1 post: - description: Creates a new node. - operationId: prod_tt_sasportal.nodes.nodes.nodes.create + description: Returns permissions that a caller has on the specified resource. + operationId: prod_tt_sasportal.policies.test requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalTestPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4839,15 +4849,5 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' - parameters: - - in: path - name: nodesId - required: true - schema: - type: string - - in: path - name: nodesId1 - required: true - schema: - type: string + $ref: '#/components/schemas/SasPortalTestPermissionsResponse' + parameters: [] diff --git a/providers/src/googleapis.com/v00.00.00000/services/publicca.yaml b/providers/src/googleapis.com/v00.00.00000/services/publicca.yaml index e68a2d6a..7e2b40c5 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/publicca.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/publicca.yaml @@ -10,8 +10,8 @@ info: external account binding keys associated with Google Trust Services' publicly trusted certificate authority. version: v1 - x-discovery-doc-revision: '20241104' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250825' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/public-certificate-authority/docs servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/pubsub.yaml b/providers/src/googleapis.com/v00.00.00000/services/pubsub.yaml index 53f3c18d..e974c1af 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/pubsub.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/pubsub.yaml @@ -9,8 +9,8 @@ info: Provides reliable, many-to-many, asynchronous messaging between applications. version: v1 - x-discovery-doc-revision: '20241022' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250812' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/pubsub/docs servers: @@ -511,6 +511,13 @@ components: ingestionDataSourceSettings: description: Optional. Settings for ingestion from a data source into this topic. $ref: '#/components/schemas/IngestionDataSourceSettings' + messageTransforms: + description: >- + Optional. Transforms to be applied to messages published to the + topic. Transforms are applied in the order specified. + type: array + items: + $ref: '#/components/schemas/MessageTransform' MessageStoragePolicy: id: MessageStoragePolicy description: A policy constraining the storage of messages published to the topic. @@ -583,6 +590,15 @@ components: cloudStorage: description: Optional. Cloud Storage. $ref: '#/components/schemas/CloudStorage' + azureEventHubs: + description: Optional. Azure Event Hubs. + $ref: '#/components/schemas/AzureEventHubs' + awsMsk: + description: Optional. Amazon MSK. + $ref: '#/components/schemas/AwsMsk' + confluentCloud: + description: Optional. Confluent Cloud. + $ref: '#/components/schemas/ConfluentCloud' platformLogsSettings: description: >- Optional. Platform Logs settings. If unset, no Platform Logs will be @@ -745,6 +761,169 @@ components: will be restored when publishing. type: object properties: {} + AzureEventHubs: + id: AzureEventHubs + description: Ingestion settings for Azure Event Hubs. + type: object + properties: + state: + description: >- + Output only. An output-only field that indicates the state of the + Event Hubs ingestion source. + readOnly: true + type: string + enumDescriptions: + - Default value. This value is unused. + - Ingestion is active. + - >- + Permission denied encountered while consuming data from Event + Hubs. This can happen when `client_id`, or `tenant_id` are + invalid. Or the right permissions haven't been granted. + - Permission denied encountered while publishing to the topic. + - The provided Event Hubs namespace couldn't be found. + - The provided Event Hub couldn't be found. + - The provided Event Hubs subscription couldn't be found. + - The provided Event Hubs resource group couldn't be found. + enum: + - STATE_UNSPECIFIED + - ACTIVE + - EVENT_HUBS_PERMISSION_DENIED + - PUBLISH_PERMISSION_DENIED + - NAMESPACE_NOT_FOUND + - EVENT_HUB_NOT_FOUND + - SUBSCRIPTION_NOT_FOUND + - RESOURCE_GROUP_NOT_FOUND + resourceGroup: + description: Optional. Name of the resource group within the azure subscription. + type: string + namespace: + description: Optional. The name of the Event Hubs namespace. + type: string + eventHub: + description: Optional. The name of the Event Hub. + type: string + clientId: + description: >- + Optional. The client id of the Azure application that is being used + to authenticate Pub/Sub. + type: string + tenantId: + description: >- + Optional. The tenant id of the Azure application that is being used + to authenticate Pub/Sub. + type: string + subscriptionId: + description: Optional. The Azure subscription id. + type: string + gcpServiceAccount: + description: >- + Optional. The GCP service account to be used for Federated Identity + authentication. + type: string + AwsMsk: + id: AwsMsk + description: Ingestion settings for Amazon MSK. + type: object + properties: + state: + description: >- + Output only. An output-only field that indicates the state of the + Amazon MSK ingestion source. + readOnly: true + type: string + enumDescriptions: + - Default value. This value is unused. + - Ingestion is active. + - >- + Permission denied encountered while consuming data from Amazon + MSK. + - Permission denied encountered while publishing to the topic. + - The provided MSK cluster wasn't found. + - The provided topic wasn't found. + enum: + - STATE_UNSPECIFIED + - ACTIVE + - MSK_PERMISSION_DENIED + - PUBLISH_PERMISSION_DENIED + - CLUSTER_NOT_FOUND + - TOPIC_NOT_FOUND + clusterArn: + description: >- + Required. The Amazon Resource Name (ARN) that uniquely identifies + the cluster. + type: string + topic: + description: >- + Required. The name of the topic in the Amazon MSK cluster that + Pub/Sub will import from. + type: string + awsRoleArn: + description: >- + Required. AWS role ARN to be used for Federated Identity + authentication with Amazon MSK. Check the Pub/Sub docs for how to + set up this role and the required permissions that need to be + attached to it. + type: string + gcpServiceAccount: + description: >- + Required. The GCP service account to be used for Federated Identity + authentication with Amazon MSK (via a `AssumeRoleWithWebIdentity` + call for the provided role). The `aws_role_arn` must be set up with + `accounts.google.com:sub` equals to this service account number. + type: string + ConfluentCloud: + id: ConfluentCloud + description: Ingestion settings for Confluent Cloud. + type: object + properties: + state: + description: >- + Output only. An output-only field that indicates the state of the + Confluent Cloud ingestion source. + readOnly: true + type: string + enumDescriptions: + - Default value. This value is unused. + - Ingestion is active. + - >- + Permission denied encountered while consuming data from Confluent + Cloud. + - Permission denied encountered while publishing to the topic. + - The provided bootstrap server address is unreachable. + - The provided cluster wasn't found. + - The provided topic wasn't found. + enum: + - STATE_UNSPECIFIED + - ACTIVE + - CONFLUENT_CLOUD_PERMISSION_DENIED + - PUBLISH_PERMISSION_DENIED + - UNREACHABLE_BOOTSTRAP_SERVER + - CLUSTER_NOT_FOUND + - TOPIC_NOT_FOUND + bootstrapServer: + description: >- + Required. The address of the bootstrap server. The format is + url:port. + type: string + clusterId: + description: Required. The id of the cluster. + type: string + topic: + description: >- + Required. The name of the topic in the Confluent Cloud cluster that + Pub/Sub will import from. + type: string + identityPoolId: + description: >- + Required. The id of the identity pool to be used for Federated + Identity authentication with Confluent Cloud. See + https://docs.confluent.io/cloud/current/security/authenticate/workload-identities/identity-providers/oauth/identity-pools.html#add-oauth-identity-pools. + type: string + gcpServiceAccount: + description: >- + Required. The GCP service account to be used for Federated Identity + authentication with `identity_pool_id`. + type: string PlatformLogsSettings: id: PlatformLogsSettings description: Settings for Platform Logs produced by Pub/Sub. @@ -769,6 +948,55 @@ components: - INFO - WARNING - ERROR + MessageTransform: + id: MessageTransform + description: All supported message transforms types. + type: object + properties: + javascriptUdf: + description: >- + Optional. JavaScript User Defined Function. If multiple + JavaScriptUDF's are specified on a resource, each must have a unique + `function_name`. + $ref: '#/components/schemas/JavaScriptUDF' + enabled: + description: >- + Optional. This field is deprecated, use the `disabled` field to + disable transforms. + deprecated: true + type: boolean + disabled: + description: >- + Optional. If true, the transform is disabled and will not be applied + to messages. Defaults to `false`. + type: boolean + JavaScriptUDF: + id: JavaScriptUDF + description: >- + User-defined JavaScript function that can transform or filter a Pub/Sub + message. + type: object + properties: + functionName: + description: >- + Required. Name of the JavasScript function that should applied to + Pub/Sub messages. + type: string + code: + description: >- + Required. JavaScript code that contains a function `function_name` + with the below signature: ``` /** * Transforms a Pub/Sub message. * + @return {(Object)>|null)} - To * filter a message, return `null`. To + transform a message return a map * with the following keys: * - + (required) 'data' : {string} * - (optional) 'attributes' : {Object} + * Returning empty `attributes` will remove all attributes from the * + message. * * @param {(Object)>} Pub/Sub * message. Keys: * - + (required) 'data' : {string} * - (required) 'attributes' : {Object} + * * @param {Object} metadata - Pub/Sub message metadata. * Keys: * - + (optional) 'message_id' : {string} * - (optional) 'publish_time': + {string} YYYY-MM-DDTHH:MM:SSZ format * - (optional) 'ordering_key': + {string} */ function (message, metadata) { } ``` + type: string UpdateTopicRequest: id: UpdateTopicRequest description: Request for the UpdateTopic method. @@ -1046,7 +1274,7 @@ components: delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be - triggered on NACKs or acknowledgement deadline exceeded events for a + triggered on NACKs or acknowledgment deadline exceeded events for a given message. $ref: '#/components/schemas/RetryPolicy' detached: @@ -1062,8 +1290,8 @@ components: Optional. If true, Pub/Sub provides the following guarantees for the delivery of a message with a given value of `message_id` on this subscription: * The message sent to a subscriber is guaranteed not - to be resent before the message's acknowledgement deadline expires. - * An acknowledged message will not be resent to a subscriber. Note + to be resent before the message's acknowledgment deadline expires. * + An acknowledged message will not be resent to a subscriber. Note that subscribers may still receive multiple copies of a message when `enable_exactly_once_delivery` is true if the message was published multiple times by a publisher client. These copies are considered @@ -1105,6 +1333,14 @@ components: Hub. readOnly: true $ref: '#/components/schemas/AnalyticsHubSubscriptionInfo' + messageTransforms: + description: >- + Optional. Transforms to be applied to messages before they are + delivered to subscribers. Transforms are applied in the order + specified. + type: array + items: + $ref: '#/components/schemas/MessageTransform' PushConfig: id: PushConfig description: Configuration for a push delivery endpoint. @@ -1318,7 +1554,7 @@ components: description: >- Optional. The maximum duration that can elapse before a new Cloud Storage file is created. Min 1 minute, max 10 minutes, default 5 - minutes. May not exceed the subscription's acknowledgement deadline. + minutes. May not exceed the subscription's acknowledgment deadline. type: string format: google-duration maxBytes: @@ -1445,7 +1681,7 @@ components: Optional. The maximum number of delivery attempts for any message. The value must be between 5 and 100. The number of delivery attempts is defined as 1 + (the sum of number of NACKs and number of times - the acknowledgement deadline has been exceeded for the message). A + the acknowledgment deadline has been exceeded for the message). A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that client libraries may automatically extend ack_deadlines. This field will be honored on a best effort basis. If this parameter is 0, a @@ -1458,7 +1694,7 @@ components: A policy that specifies how Pub/Sub retries message delivery. Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff. RetryPolicy - will be triggered on NACKs or acknowledgement deadline exceeded events + will be triggered on NACKs or acknowledgment deadline exceeded events for a given message. Retry Policy is implemented on a best effort basis. At times, the delay between consecutive deliveries may not match the configuration. That is, delay can be more or less than configured @@ -1482,8 +1718,8 @@ components: AnalyticsHubSubscriptionInfo: id: AnalyticsHubSubscriptionInfo description: >- - Information about an associated Analytics Hub subscription - (https://cloud.google.com/bigquery/docs/analytics-hub-manage-subscriptions). + Information about an associated [Analytics Hub + subscription](https://cloud.google.com/bigquery/docs/analytics-hub-manage-subscriptions). type: object properties: listing: diff --git a/providers/src/googleapis.com/v00.00.00000/services/pubsublite.yaml b/providers/src/googleapis.com/v00.00.00000/services/pubsublite.yaml index a1504397..31099b5c 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/pubsublite.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/pubsublite.yaml @@ -7,8 +7,8 @@ info: title: Pub/Sub Lite API description: '' version: v1 - x-discovery-doc-revision: '20241025' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250815' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/pubsub/lite/docs servers: @@ -1241,7 +1241,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: pubsublite.admin.projects.locations.operations.cancel requestBody: content: diff --git a/providers/src/googleapis.com/v00.00.00000/services/rapidmigrationassessment.yaml b/providers/src/googleapis.com/v00.00.00000/services/rapidmigrationassessment.yaml index 8c421cb3..bc2ad79b 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/rapidmigrationassessment.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/rapidmigrationassessment.yaml @@ -9,8 +9,8 @@ info: The Rapid Migration Assessment service is our first-party migration assessment and planning tool. version: v1 - x-discovery-doc-revision: '20241012' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250718' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/migration-center servers: @@ -752,6 +752,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: @@ -906,7 +910,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: rapidmigrationassessment.projects.locations.operations.cancel requestBody: content: @@ -1108,7 +1112,7 @@ paths: delete: description: >- Deletes a single Collector - changes state of collector to "Deleting". - Background jobs does final deletion thorugh producer api. + Background jobs does final deletion through producer API. operationId: rapidmigrationassessment.projects.locations.collectors.delete security: - Oauth2: diff --git a/providers/src/googleapis.com/v00.00.00000/services/recaptchaenterprise.yaml b/providers/src/googleapis.com/v00.00.00000/services/recaptchaenterprise.yaml index 5d2b7181..68cf615d 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/recaptchaenterprise.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/recaptchaenterprise.yaml @@ -9,8 +9,8 @@ info: Help protect your website from fraudulent activity, spam, and abuse without creating friction. version: v1 - x-discovery-doc-revision: '20241027' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250713' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/recaptcha-enterprise/ servers: @@ -36,286 +36,385 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudRecaptchaenterpriseV1FirewallActionBlockAction: - id: GoogleCloudRecaptchaenterpriseV1FirewallActionBlockAction - properties: {} + GoogleCloudRecaptchaenterpriseV1Assessment: + id: GoogleCloudRecaptchaenterpriseV1Assessment + description: A reCAPTCHA Enterprise assessment resource. type: object - description: >- - A block action serves an HTTP error code a prevents the request from - hitting the backend. - GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsResponse: - description: The response to a `SearchRelatedAccountGroupMemberships` call. properties: - relatedAccountGroupMemberships: - items: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1RelatedAccountGroupMembership - type: array - description: The queried memberships. - nextPageToken: + name: + description: >- + Output only. Identifier. The resource name for the Assessment in the + format `projects/{project}/assessments/{assessment}`. + readOnly: true type: string + event: + description: Optional. The event being assessed. + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Event' + riskAnalysis: + description: Output only. The risk analysis result for the event being assessed. + readOnly: true + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1RiskAnalysis' + tokenProperties: + description: Output only. Properties of the provided event token. + readOnly: true + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1TokenProperties' + accountVerification: description: >- - A token, which can be sent as `page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. + Optional. Account verification information for identity + verification. The assessment event must include a token and site key + to use this feature. + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo + accountDefenderAssessment: + description: >- + Output only. Assessment returned by account defender when an account + identifier is provided. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment + privatePasswordLeakVerification: + description: >- + Optional. The private password leak verification field contains the + parameters that are used to to check for leaks privately without + sharing user credentials. + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1PrivatePasswordLeakVerification + firewallPolicyAssessment: + description: >- + Output only. Assessment returned when firewall policies belonging to + the project are evaluated using the field + firewall_policy_evaluation. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicyAssessment + fraudPreventionAssessment: + description: >- + Output only. Assessment returned by Fraud Prevention when + TransactionData is provided. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessment + fraudSignals: + description: >- + Output only. Fraud Signals specific to the users involved in a + payment transaction. + readOnly: true + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudSignals' + phoneFraudAssessment: + description: >- + Output only. Assessment returned when a site key, a token, and a + phone number as `user_id` are provided. Account defender and SMS + toll fraud protection need to be enabled. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1PhoneFraudAssessment + assessmentEnvironment: + description: >- + Optional. The environment creating the assessment. This describes + your environment (the system invoking CreateAssessment), NOT the + environment of your user. + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1AssessmentEnvironment + GoogleCloudRecaptchaenterpriseV1Event: + id: GoogleCloudRecaptchaenterpriseV1Event + description: The event being assessed. type: object - id: >- - GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsResponse - GoogleCloudRecaptchaenterpriseV1TransactionEvent: - description: Describes an event in the lifecycle of a payment transaction. properties: - eventType: + token: + description: >- + Optional. The user response token provided by the reCAPTCHA + Enterprise client-side integration on your site. + type: string + siteKey: + description: >- + Optional. The site key that was used to invoke reCAPTCHA Enterprise + on your site and generate the token. + type: string + userAgent: + description: >- + Optional. The user agent present in the request from the user's + device related to this event. + type: string + userIpAddress: + description: >- + Optional. The IP address in the request from the user's device + related to this event. + type: string + expectedAction: + description: >- + Optional. The expected action for this type of event. This should be + the same action provided at token generation time on client-side + platforms already integrated with recaptcha enterprise. + type: string + hashedAccountId: + description: >- + Optional. Deprecated: use `user_info.account_id` instead. Unique + stable hashed user identifier for the request. The identifier must + be hashed using hmac-sha256 with stable secret. + deprecated: true + type: string + format: byte + express: + description: >- + Optional. Flag for a reCAPTCHA express request for an assessment + without a token. If enabled, `site_key` must reference an Express + site key. + type: boolean + requestedUri: + description: >- + Optional. The URI resource the user requested that triggered an + assessment. + type: string + wafTokenAssessment: + description: >- + Optional. Flag for running WAF token assessment. If enabled, the + token must be specified, and have been created by a WAF-enabled key. + type: boolean + ja3: + description: >- + Optional. JA3 fingerprint for SSL clients. To learn how to compute + this fingerprint, please refer to https://github.com/salesforce/ja3. + type: string + ja4: + description: >- + Optional. JA4 fingerprint for SSL clients. To learn how to compute + this fingerprint, please refer to https://github.com/FoxIO-LLC/ja4. + type: string + headers: + description: Optional. HTTP header information about the request. + type: array + items: + type: string + firewallPolicyEvaluation: + description: >- + Optional. Flag for enabling firewall policy config assessment. If + this flag is enabled, the firewall policy is evaluated and a + suggested firewall action is returned in the response. + type: boolean + transactionData: + description: >- + Optional. Data describing a payment transaction to be assessed. + Sending this data enables reCAPTCHA Enterprise Fraud Prevention and + the FraudPreventionAssessment component in the response. + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionData' + userInfo: + description: >- + Optional. Information about the user that generates this event, when + they can be identified. They are often identified through the use of + an account for logged-in requests or login/registration requests, or + by providing user identifiers for guest actions like checkout. + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1UserInfo' + fraudPrevention: + description: Optional. The Fraud Prevention setting for this assessment. + type: string enumDescriptions: - - Default, unspecified event type. - >- - Indicates that the transaction is approved by the merchant. The - accompanying reasons can include terms such as 'INHOUSE', - 'ACCERTIFY', 'CYBERSOURCE', or 'MANUAL_REVIEW'. + Default, unspecified setting. `fraud_prevention_assessment` is + returned if `transaction_data` is present in `Event` and Fraud + Prevention is enabled in the Google Cloud console. - >- - Indicates that the transaction is denied and concluded due to - risks detected by the merchant. The accompanying reasons can - include terms such as 'INHOUSE', 'ACCERTIFY', 'CYBERSOURCE', or - 'MANUAL_REVIEW'. - - >- - Indicates that the transaction is being evaluated by a human, due - to suspicion or risk. - - >- - Indicates that the authorization attempt with the card issuer - succeeded. - - >- - Indicates that the authorization attempt with the card issuer - failed. The accompanying reasons can include Visa's '54' - indicating that the card is expired, or '82' indicating that the - CVV is incorrect. - - >- - Indicates that the transaction is completed because the funds were - settled. - - >- - Indicates that the transaction could not be completed because the - funds were not settled. - - >- - Indicates that the transaction has been canceled. Specify the - reason for the cancellation. For example, - 'INSUFFICIENT_INVENTORY'. - - >- - Indicates that the merchant has received a chargeback inquiry due - to fraud for the transaction, requesting additional information - before a fraud chargeback is officially issued and a formal - chargeback notification is sent. - - >- - Indicates that the merchant has received a chargeback alert due to - fraud for the transaction. The process of resolving the dispute - without involving the payment network is started. - - >- - Indicates that a fraud notification is issued for the transaction, - sent by the payment instrument's issuing bank because the - transaction appears to be fraudulent. We recommend including TC40 - or SAFE data in the `reason` field for this event type. For - partial chargebacks, we recommend that you include an amount in - the `value` field. - - >- - Indicates that the merchant is informed by the payment network - that the transaction has entered the chargeback process due to - fraud. Reason code examples include Discover's '6005' and '6041'. - For partial chargebacks, we recommend that you include an amount - in the `value` field. - - >- - Indicates that the transaction has entered the chargeback process - due to fraud, and that the merchant has chosen to enter - representment. Reason examples include Discover's '6005' and - '6041'. For partial chargebacks, we recommend that you include an - amount in the `value` field. - - >- - Indicates that the transaction has had a fraud chargeback which - was illegitimate and was reversed as a result. For partial - chargebacks, we recommend that you include an amount in the - `value` field. - - >- - Indicates that the merchant has received a refund for a completed - transaction. For partial refunds, we recommend that you include an - amount in the `value` field. Reason example: 'TAX_EXEMPT' (partial - refund of exempt tax) - - >- - Indicates that the merchant has received a refund request for this - transaction, but that they have declined it. For partial refunds, - we recommend that you include an amount in the `value` field. - Reason example: 'TAX_EXEMPT' (partial refund of exempt tax) - - >- - Indicates that the completed transaction was refunded by the - merchant. For partial refunds, we recommend that you include an - amount in the `value` field. Reason example: 'TAX_EXEMPT' (partial - refund of exempt tax) + Enable Fraud Prevention for this assessment, if Fraud Prevention + is enabled in the Google Cloud console. - >- - Indicates that the completed transaction was refunded by the - merchant, and that this refund was reversed. For partial refunds, - we recommend that you include an amount in the `value` field. - description: Optional. The type of this transaction event. + Disable Fraud Prevention for this assessment, regardless of the + Google Cloud console settings. + enum: + - FRAUD_PREVENTION_UNSPECIFIED + - ENABLED + - DISABLED + GoogleCloudRecaptchaenterpriseV1TransactionData: + id: GoogleCloudRecaptchaenterpriseV1TransactionData + description: >- + Transaction data associated with a payment protected by reCAPTCHA + Enterprise. + type: object + properties: + transactionId: + description: >- + Unique identifier for the transaction. This custom identifier can be + used to reference this transaction in the future, for example, + labeling a refund or chargeback event. Two attempts at the same + transaction should use the same transaction id. type: string - enum: - - TRANSACTION_EVENT_TYPE_UNSPECIFIED - - MERCHANT_APPROVE - - MERCHANT_DENY - - MANUAL_REVIEW - - AUTHORIZATION - - AUTHORIZATION_DECLINE - - PAYMENT_CAPTURE - - PAYMENT_CAPTURE_DECLINE - - CANCEL - - CHARGEBACK_INQUIRY - - CHARGEBACK_ALERT - - FRAUD_NOTIFICATION - - CHARGEBACK - - CHARGEBACK_REPRESENTMENT - - CHARGEBACK_REVERSE - - REFUND_REQUEST - - REFUND_DECLINE - - REFUND - - REFUND_REVERSE - eventTime: + paymentMethod: description: >- - Optional. Timestamp when this transaction event occurred; otherwise - assumed to be the time of the API call. + Optional. The payment method for the transaction. The allowed values + are: * credit-card * debit-card * gift-card * processor-{name} (If a + third-party is used, for example, processor-paypal) * custom-{name} + (If an alternative method is used, for example, custom-crypto) + type: string + cardBin: + description: >- + Optional. The Bank Identification Number - generally the first 6 or + 8 digits of the card. + type: string + cardLastFour: + description: Optional. The last four digits of the card. + type: string + currencyCode: + description: Optional. The currency code in ISO-4217 format. type: string - format: google-datetime value: + description: >- + Optional. The decimal value of the transaction in the specified + currency. + type: number format: double + shippingValue: description: >- - Optional. The value that corresponds with this transaction event, if - one exists. For example, a refund event where $5.00 was refunded. - Currency is obtained from the original transaction data. + Optional. The value of shipping in the specified currency. 0 for + free or no shipping. type: number - reason: - type: string + format: double + shippingAddress: description: >- - Optional. The reason or standardized code that corresponds with this - transaction event, if one exists. For example, a CHARGEBACK event - with code 6005. - id: GoogleCloudRecaptchaenterpriseV1TransactionEvent - type: object - GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest: - type: object - description: The migrate key request message. - id: GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest - properties: - skipBillingCheck: + Optional. Destination address if this transaction involves shipping + a physical item. + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataAddress + billingAddress: description: >- - Optional. If true, skips the billing check. A reCAPTCHA Enterprise - key or migrated key behaves differently than a reCAPTCHA - (non-Enterprise version) key when you reach a quota limit (see - https://cloud.google.com/recaptcha/quotas#quota_limit). To avoid any - disruption of your usage, we check that a billing account is - present. If your usage of reCAPTCHA is under the free quota, you can - safely skip the billing check and proceed with the migration. See - https://cloud.google.com/recaptcha/docs/billing-information. - type: boolean - GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo: + Optional. Address associated with the payment method when + applicable. + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataAddress + user: + description: >- + Optional. Information about the user paying/initiating the + transaction. + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataUser + merchants: + description: >- + Optional. Information about the user or users fulfilling the + transaction. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataUser + items: + description: Optional. Items purchased in this transaction. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataItem + gatewayInfo: + description: >- + Optional. Information about the payment gateway's response to the + transaction. + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataGatewayInfo + GoogleCloudRecaptchaenterpriseV1TransactionDataAddress: + id: GoogleCloudRecaptchaenterpriseV1TransactionDataAddress + description: Structured address format for billing and shipping addresses. + type: object properties: - requestToken: + recipient: description: >- - Output only. Token to provide to the client to trigger endpoint - verification. It must be used within 15 minutes. - type: string - readOnly: true - emailAddress: - description: Email address for which to trigger a verification request. + Optional. The recipient name, potentially including information such + as "care of". type: string - lastVerificationTime: + address: description: >- - Output only. Timestamp of the last successful verification for the - endpoint, if any. + Optional. The first lines of the address. The first line generally + contains the street name and number, and further lines may include + information such as an apartment number. + type: array + items: + type: string + locality: + description: Optional. The town/city of the address. type: string - readOnly: true - format: google-datetime - phoneNumber: + administrativeArea: description: >- - Phone number for which to trigger a verification request. Should be - given in E.164 format. + Optional. The state, province, or otherwise administrative area of + the address. type: string - id: GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo - description: Information about a verification endpoint that can be used for 2FA. - type: object - GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessment: + regionCode: + description: Optional. The CLDR country/region of the address. + type: string + postalCode: + description: Optional. The postal or ZIP code of the address. + type: string + GoogleCloudRecaptchaenterpriseV1TransactionDataUser: + id: GoogleCloudRecaptchaenterpriseV1TransactionDataUser + description: Details about a user's account involved in the transaction. type: object properties: - cardTestingVerdict: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentCardTestingVerdict - readOnly: true - description: >- - Output only. Assessment of this transaction for risk of being part - of a card testing attack. - transactionRisk: - format: float + accountId: description: >- - Output only. Probability of this transaction being fraudulent. - Summarizes the combined risk of attack vectors below. Values are - from 0.0 (lowest) to 1.0 (highest). - readOnly: true - type: number - behavioralTrustVerdict: - description: Output only. Assessment of this transaction for behavioral trust. - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentBehavioralTrustVerdict - stolenInstrumentVerdict: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentStolenInstrumentVerdict + Optional. Unique account identifier for this user. If using account + defender, this should match the hashed_account_id field. Otherwise, + a unique and persistent identifier for this account. + type: string + creationMs: + description: Optional. The epoch milliseconds of the user's account creation. + type: string + format: int64 + email: + description: Optional. The email address of the user. + type: string + emailVerified: description: >- - Output only. Assessment of this transaction for risk of a stolen - instrument. - readOnly: true - description: Assessment for Fraud Prevention. - id: GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessment - GoogleCloudRecaptchaenterpriseV1PhoneFraudAssessment: - properties: - smsTollFraudVerdict: + Optional. Whether the email has been verified to be accessible by + the user (OTP or similar). + type: boolean + phoneNumber: + description: Optional. The phone number of the user, with country code. + type: string + phoneVerified: description: >- - Output only. Assessment of this phone event for risk of SMS toll - fraud. - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1SmsTollFraudVerdict - readOnly: true - id: GoogleCloudRecaptchaenterpriseV1PhoneFraudAssessment + Optional. Whether the phone number has been verified to be + accessible by the user (OTP or similar). + type: boolean + GoogleCloudRecaptchaenterpriseV1TransactionDataItem: + id: GoogleCloudRecaptchaenterpriseV1TransactionDataItem + description: Line items being purchased in this transaction. type: object - description: Assessment for Phone Fraud - GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentCardTestingVerdict: - description: >- - Information about card testing fraud, where an adversary is testing - fraudulently obtained cards or brute forcing their details. properties: - risk: + name: + description: Optional. The full name of the item. + type: string + value: description: >- - Output only. Probability of this transaction attempt being part of a - card testing attack. Values are from 0.0 (lowest) to 1.0 (highest). + Optional. The value per item that the user is paying, in the + transaction currency, after discounts. type: number - format: float - readOnly: true - type: object - id: >- - GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentCardTestingVerdict - GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectAction: - description: >- - A redirect action returns a 307 (temporary redirect) response, pointing - the user to a reCAPTCHA interstitial page to attach a token. - type: object - properties: {} - id: GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectAction - GoogleCloudRecaptchaenterpriseV1ScoreMetrics: + format: double + quantity: + description: Optional. The quantity of this item that is being purchased. + type: string + format: int64 + merchantAccountId: + description: >- + Optional. When a merchant is specified, its corresponding + account_id. Necessary to populate marketplace-style transactions. + type: string + GoogleCloudRecaptchaenterpriseV1TransactionDataGatewayInfo: + id: GoogleCloudRecaptchaenterpriseV1TransactionDataGatewayInfo + description: Details about the transaction from the gateway. type: object properties: - actionMetrics: - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1ScoreDistribution + name: description: >- - Action-based metrics. The map key is the action name which specified - by the site owners at time of the "execute" client-side call. - type: object - overallMetrics: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1ScoreDistribution - description: Aggregated score metrics for all traffic. - id: GoogleCloudRecaptchaenterpriseV1ScoreMetrics - description: Metrics related to scoring. + Optional. Name of the gateway service (for example, stripe, square, + paypal). + type: string + gatewayResponseCode: + description: >- + Optional. Gateway response code describing the state of the + transaction. + type: string + avsResponseCode: + description: >- + Optional. AVS response code from the gateway (available only when + reCAPTCHA Enterprise is called after authorization). + type: string + cvvResponseCode: + description: >- + Optional. CVV response code from the gateway (available only when + reCAPTCHA Enterprise is called after authorization). + type: string GoogleCloudRecaptchaenterpriseV1UserInfo: id: GoogleCloudRecaptchaenterpriseV1UserInfo description: >- @@ -323,1736 +422,1772 @@ components: Enterprise. type: object properties: - userIds: - type: array - items: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1UserId' - description: Optional. Identifiers associated with this user or request. createAccountTime: - type: string - format: google-datetime description: >- Optional. Creation time for this account associated with this user. Leave blank for non logged-in actions, guest checkout, or when there is no account associated with the current user. - accountId: type: string + format: google-datetime + accountId: description: >- Optional. For logged-in requests or login/registration requests, the unique account identifier associated with this user. You can use the username if it is stable (meaning it is the same for every request associated with the same user), or any stable user ID of your choice. Leave blank for non logged-in actions or guest checkout. - GoogleCloudRecaptchaenterpriseV1RemoveIpOverrideRequest: - description: The RemoveIpOverride request message. - type: object - id: GoogleCloudRecaptchaenterpriseV1RemoveIpOverrideRequest - properties: - ipOverrideData: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1IpOverrideData' - description: Required. IP override to be removed from the key. - GoogleCloudRecaptchaenterpriseV1ListFirewallPoliciesResponse: - properties: - firewallPolicies: + type: string + userIds: + description: Optional. Identifiers associated with this user or request. type: array items: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy - description: Policy details. - nextPageToken: - description: >- - Token to retrieve the next page of results. It is set to empty if no - policies remain in results. - type: string - description: Response to request to list firewall policies belonging to a project. - type: object - id: GoogleCloudRecaptchaenterpriseV1ListFirewallPoliciesResponse - GoogleCloudRecaptchaenterpriseV1FirewallPolicy: + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1UserId' + GoogleCloudRecaptchaenterpriseV1UserId: + id: GoogleCloudRecaptchaenterpriseV1UserId + description: An identifier associated with a user. type: object - id: GoogleCloudRecaptchaenterpriseV1FirewallPolicy properties: - description: - description: >- - Optional. A description of what this policy aims to achieve, for - convenience purposes. The description can at most include 256 UTF-8 - characters. - type: string - condition: - description: >- - Optional. A CEL (Common Expression Language) conditional expression - that specifies if this policy applies to an incoming user request. - If this condition evaluates to true and the requested path matched - the path pattern, the associated actions should be executed by the - caller. The condition string is checked for CEL syntax correctness - on creation. For more information, see the [CEL - spec](https://github.com/google/cel-spec) and its [language - definition](https://github.com/google/cel-spec/blob/master/doc/langdef.md). - A condition has a max length of 500 characters. + email: + description: Optional. An email address. type: string - actions: - description: >- - Optional. The actions that the caller should take regarding user - access. There should be at most one terminal action. A terminal - action is any action that forces a response, such as `AllowAction`, - `BlockAction` or `SubstituteAction`. Zero or more non-terminal - actions such as `SetHeader` might be specified. A single policy can - contain up to 16 actions. - items: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallAction - type: array - path: - description: >- - Optional. The path for which this policy applies, specified as a - glob pattern. For more information on glob, see the [manual - page](https://man7.org/linux/man-pages/man7/glob.7.html). A path has - a max length of 200 characters. + phoneNumber: + description: Optional. A phone number. Should use the E.164 format. type: string - name: + username: description: >- - Identifier. The resource name for the FirewallPolicy in the format - `projects/{project}/firewallpolicies/{firewallpolicy}`. + Optional. A unique username, if different from all the other + identifiers and `account_id` that are provided. Can be a unique + login handle or display name for a user. type: string - description: >- - A FirewallPolicy represents a single matching pattern and resulting - actions to take. - GoogleCloudRecaptchaenterpriseV1SmsTollFraudVerdict: - id: GoogleCloudRecaptchaenterpriseV1SmsTollFraudVerdict + GoogleCloudRecaptchaenterpriseV1RiskAnalysis: + id: GoogleCloudRecaptchaenterpriseV1RiskAnalysis + description: Risk analysis result for an event. + type: object properties: - risk: + score: + description: >- + Output only. Legitimate event score from 0.0 to 1.0. (1.0 means very + likely legitimate traffic while 0.0 means very likely non-legitimate + traffic). readOnly: true type: number format: float - description: >- - Output only. Probability of an SMS event being fraudulent. Values - are from 0.0 (lowest) to 1.0 (highest). reasons: + description: Output only. Reasons contributing to the risk analysis verdict. + readOnly: true type: array items: - enum: - - SMS_TOLL_FRAUD_REASON_UNSPECIFIED - - INVALID_PHONE_NUMBER + type: string enumDescriptions: - - Default unspecified reason - - The provided phone number was invalid + - Default unspecified type. + - Interactions matched the behavior of an automated agent. + - The event originated from an illegitimate environment. + - Traffic volume from the event source is higher than normal. + - >- + Interactions with the site were significantly different than + expected patterns. + - >- + Too little traffic has been received from this site thus far to + generate quality risk analysis. + - >- + The request matches behavioral characteristics of a carding + attack. + - >- + The request matches behavioral characteristics of chargebacks + for fraud. + enum: + - CLASSIFICATION_REASON_UNSPECIFIED + - AUTOMATION + - UNEXPECTED_ENVIRONMENT + - TOO_MUCH_TRAFFIC + - UNEXPECTED_USAGE_PATTERNS + - LOW_CONFIDENCE_SCORE + - SUSPECTED_CARDING + - SUSPECTED_CHARGEBACK + extendedVerdictReasons: + description: >- + Output only. Extended verdict reasons to be used for experimentation + only. The set of possible reasons is subject to change. + readOnly: true + type: array + items: type: string + challenge: + description: >- + Output only. Challenge information for POLICY_BASED_CHALLENGE and + INVISIBLE keys readOnly: true - description: Output only. Reasons contributing to the SMS toll fraud verdict. - description: Information about SMS toll fraud. + type: string + enumDescriptions: + - Default unspecified type. + - No challenge was presented for solving. + - A solution was submitted that was correct. + - >- + A solution was submitted that was incorrect or otherwise deemed + suspicious. + enum: + - CHALLENGE_UNSPECIFIED + - NOCAPTCHA + - PASSED + - FAILED + verifiedBots: + description: >- + Output only. Bots with identities that have been verified by + reCAPTCHA and detected in the event. + readOnly: true + type: array + items: + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Bot' + GoogleCloudRecaptchaenterpriseV1Bot: + id: GoogleCloudRecaptchaenterpriseV1Bot + description: Bot information and metadata. type: object - GoogleCloudRecaptchaenterpriseV1RelatedAccountGroup: properties: name: - type: string description: >- - Required. Identifier. The resource name for the related account - group in the format - `projects/{project}/relatedaccountgroups/{related_account_group}`. - id: GoogleCloudRecaptchaenterpriseV1RelatedAccountGroup - type: object - description: A group of related accounts. - GoogleCloudRecaptchaenterpriseV1FirewallActionSubstituteAction: + Optional. Enumerated string value that indicates the identity of the + bot, formatted in kebab-case. + type: string + botType: + description: Optional. Enumerated field representing the type of bot. + type: string + enumDescriptions: + - Default unspecified type. + - >- + Software program that interacts with a site and performs tasks + autonomously. + - Software that extracts specific data from sites for use. + - >- + Software that crawls sites and stores content for the purpose of + efficient retrieval, likely as part of a search engine. + enum: + - BOT_TYPE_UNSPECIFIED + - AI_AGENT + - CONTENT_SCRAPER + - SEARCH_INDEXER + GoogleCloudRecaptchaenterpriseV1TokenProperties: + id: GoogleCloudRecaptchaenterpriseV1TokenProperties + description: Properties of the provided event token. type: object properties: - path: + valid: + description: >- + Output only. Whether the provided user response token is valid. When + valid = false, the reason could be specified in invalid_reason or it + could also be due to a user failing to solve a challenge or a + sitekey mismatch (i.e the sitekey used to generate the token was + different than the one specified in the assessment). + readOnly: true + type: boolean + invalidReason: + description: Output only. Reason associated with the response when valid = false. + readOnly: true + type: string + enumDescriptions: + - Default unspecified type. + - If the failure reason was not accounted for. + - The provided user verification token was malformed. + - The user verification token had expired. + - The user verification had already been seen. + - The user verification token was not present. + - >- + A retriable error (such as network failure) occurred on the + browser. Could easily be simulated by an attacker. + enum: + - INVALID_REASON_UNSPECIFIED + - UNKNOWN_INVALID_REASON + - MALFORMED + - EXPIRED + - DUPE + - MISSING + - BROWSER_ERROR + createTime: description: >- - Optional. The address to redirect to. The target is a relative path - in the current host. Example: "/blog/404.html". + Output only. The timestamp corresponding to the generation of the + token. + readOnly: true type: string - description: >- - A substitute action transparently serves a different page than the one - requested. - id: GoogleCloudRecaptchaenterpriseV1FirewallActionSubstituteAction - GoogleCloudRecaptchaenterpriseV1Event: - properties: - firewallPolicyEvaluation: + format: google-datetime + hostname: description: >- - Optional. Flag for enabling firewall policy config assessment. If - this flag is enabled, the firewall policy is evaluated and a - suggested firewall action is returned in the response. - type: boolean - headers: - type: array - description: Optional. HTTP header information about the request. - items: - type: string - token: + Output only. The hostname of the page on which the token was + generated (Web keys only). + readOnly: true type: string + androidPackageName: description: >- - Optional. The user response token provided by the reCAPTCHA - Enterprise client-side integration on your site. - ja3: - description: Optional. JA3 fingerprint for SSL clients. - type: string - requestedUri: + Output only. The name of the Android package with which the token + was generated (Android keys only). + readOnly: true type: string + iosBundleId: description: >- - Optional. The URI resource the user requested that triggered an - assessment. - expectedAction: + Output only. The ID of the iOS bundle with which the token was + generated (iOS keys only). + readOnly: true type: string - description: >- - Optional. The expected action for this type of event. This should be - the same action provided at token generation time on client-side - platforms already integrated with recaptcha enterprise. - wafTokenAssessment: - type: boolean - description: >- - Optional. Flag for running WAF token assessment. If enabled, the - token must be specified, and have been created by a WAF-enabled key. - userAgent: + action: + description: Output only. Action name provided at token generation. + readOnly: true type: string + GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo: + id: GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo + description: Information about account verification, used for identity verification. + type: object + properties: + endpoints: + description: Optional. Endpoints that can be used for identity verification. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo + languageCode: description: >- - Optional. The user agent present in the request from the user's - device related to this event. - express: - description: >- - Optional. Flag for a reCAPTCHA express request for an assessment - without a token. If enabled, `site_key` must reference an Express - site key. - type: boolean - hashedAccountId: - format: byte + Optional. Language code preference for the verification message, set + as a IETF BCP 47 language code. type: string - deprecated: true - description: >- - Optional. Deprecated: use `user_info.account_id` instead. Unique - stable hashed user identifier for the request. The identifier must - be hashed using hmac-sha256 with stable secret. - userIpAddress: + latestVerificationResult: + description: Output only. Result of the latest account verification challenge. + readOnly: true type: string - description: >- - Optional. The IP address in the request from the user's device - related to this event. - transactionData: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionData' - description: >- - Optional. Data describing a payment transaction to be assessed. - Sending this data enables reCAPTCHA Enterprise Fraud Prevention and - the FraudPreventionAssessment component in the response. - userInfo: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1UserInfo' - description: >- - Optional. Information about the user that generates this event, when - they can be identified. They are often identified through the use of - an account for logged-in requests or login/registration requests, or - by providing user identifiers for guest actions like checkout. - fraudPrevention: enumDescriptions: + - No information about the latest account verification. - >- - Default, unspecified setting. If opted in for automatic detection, - `fraud_prevention_assessment` is returned based on the request. - Otherwise, `fraud_prevention_assessment` is returned if - `transaction_data` is present in the `Event` and Fraud Prevention - is enabled in the Google Cloud console. + The user was successfully verified. This means the account + verification challenge was successfully completed. + - The user failed the verification challenge. - >- - Enable Fraud Prevention for this assessment, if Fraud Prevention - is enabled in the Google Cloud console. + The site is not properly onboarded to use the account verification + feature. - >- - Disable Fraud Prevention for this assessment, regardless of opt-in - status or Google Cloud console settings. - type: string + The recipient is not allowed for account verification. This can + occur during integration but should not occur in production. + - >- + The recipient has already been sent too many verification codes in + a short amount of time. + - >- + The verification flow could not be completed due to a critical + internal error. + - >- + The client has exceeded their two factor request quota for this + period of time. + - >- + The request cannot be processed at the time because of an + incident. This bypass can be restricted to a problematic + destination email domain, a customer, or could affect the entire + service. + - >- + The request parameters do not match with the token provided and + cannot be processed. enum: - - FRAUD_PREVENTION_UNSPECIFIED - - ENABLED - - DISABLED - description: Optional. The Fraud Prevention setting for this assessment. - siteKey: + - RESULT_UNSPECIFIED + - SUCCESS_USER_VERIFIED + - ERROR_USER_NOT_VERIFIED + - ERROR_SITE_ONBOARDING_INCOMPLETE + - ERROR_RECIPIENT_NOT_ALLOWED + - ERROR_RECIPIENT_ABUSE_LIMIT_EXHAUSTED + - ERROR_CRITICAL_INTERNAL + - ERROR_CUSTOMER_QUOTA_EXHAUSTED + - ERROR_VERIFICATION_BYPASSED + - ERROR_VERDICT_MISMATCH + username: description: >- - Optional. The site key that was used to invoke reCAPTCHA Enterprise - on your site and generate the token. + Username of the account that is being verified. Deprecated. + Customers should now provide the `account_id` field in + `event.user_info`. + deprecated: true type: string - description: The event being assessed. - type: object - id: GoogleCloudRecaptchaenterpriseV1Event - GoogleCloudRecaptchaenterpriseV1FirewallActionAllowAction: - id: GoogleCloudRecaptchaenterpriseV1FirewallActionAllowAction - description: An allow action continues processing a request unimpeded. - type: object - properties: {} - GoogleCloudRecaptchaenterpriseV1TransactionDataAddress: - description: Structured address format for billing and shipping addresses. + GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo: + id: GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo + description: Information about a verification endpoint that can be used for 2FA. type: object properties: - administrativeArea: + emailAddress: + description: Email address for which to trigger a verification request. type: string + phoneNumber: description: >- - Optional. The state, province, or otherwise administrative area of - the address. - postalCode: - description: Optional. The postal or ZIP code of the address. + Phone number for which to trigger a verification request. Should be + given in E.164 format. type: string - regionCode: - description: Optional. The CLDR country/region of the address. + requestToken: + description: >- + Output only. Token to provide to the client to trigger endpoint + verification. It must be used within 15 minutes. + readOnly: true type: string - locality: + lastVerificationTime: + description: >- + Output only. Timestamp of the last successful verification for the + endpoint, if any. + readOnly: true type: string - description: Optional. The town/city of the address. - recipient: + format: google-datetime + GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment: + id: GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment + description: Account defender risk assessment. + type: object + properties: + labels: + description: Output only. Labels for this request. + readOnly: true + type: array + items: + type: string + enumDescriptions: + - Default unspecified type. + - The request matches a known good profile for the user. + - >- + The request is potentially a suspicious login event and must be + further verified either through multi-factor authentication or + another system. + - >- + The request matched a profile that previously had suspicious + account creation behavior. This can mean that this is a fake + account. + - >- + The account in the request has a high number of related + accounts. It does not necessarily imply that the account is bad + but can require further investigation. + enum: + - ACCOUNT_DEFENDER_LABEL_UNSPECIFIED + - PROFILE_MATCH + - SUSPICIOUS_LOGIN_ACTIVITY + - SUSPICIOUS_ACCOUNT_CREATION + - RELATED_ACCOUNTS_NUMBER_HIGH + GoogleCloudRecaptchaenterpriseV1PrivatePasswordLeakVerification: + id: GoogleCloudRecaptchaenterpriseV1PrivatePasswordLeakVerification + description: Private password leak verification info. + type: object + properties: + lookupHashPrefix: + description: >- + Required. Exactly 26-bit prefix of the SHA-256 hash of the + canonicalized username. It is used to look up password leaks + associated with that hash prefix. type: string + format: byte + encryptedUserCredentialsHash: description: >- - Optional. The recipient name, potentially including information such - as "care of". - address: + Optional. Encrypted Scrypt hash of the canonicalized + username+password. It is re-encrypted by the server and returned + through `reencrypted_user_credentials_hash`. + type: string + format: byte + encryptedLeakMatchPrefixes: + description: >- + Output only. List of prefixes of the encrypted potential password + leaks that matched the given parameters. They must be compared with + the client-side decryption prefix of + `reencrypted_user_credentials_hash` + readOnly: true + type: array items: type: string - type: array + format: byte + reencryptedUserCredentialsHash: description: >- - Optional. The first lines of the address. The first line generally - contains the street name and number, and further lines may include - information such as an apartment number. - id: GoogleCloudRecaptchaenterpriseV1TransactionDataAddress - GoogleCloudRecaptchaenterpriseV1ChallengeMetrics: + Output only. Corresponds to the re-encryption of the + `encrypted_user_credentials_hash` field. It is used to match + potential password leaks within `encrypted_leak_match_prefixes`. + readOnly: true + type: string + format: byte + GoogleCloudRecaptchaenterpriseV1FirewallPolicyAssessment: + id: GoogleCloudRecaptchaenterpriseV1FirewallPolicyAssessment + description: Policy config assessment. type: object properties: - passedCount: - type: string - format: int64 + error: description: >- - Count of nocaptchas (successful verification without a challenge) - plus submitted challenge solutions that were correct and resulted in - verification. - nocaptchaCount: + Output only. If the processing of a policy config fails, an error is + populated and the firewall_policy is left empty. + readOnly: true + $ref: '#/components/schemas/GoogleRpcStatus' + firewallPolicy: description: >- - Count of nocaptchas (successful verification without a challenge) - issued. - type: string - format: int64 - pageloadCount: - format: int64 + Output only. The policy that matched the request. If more than one + policy may match, this is the first match. If no policy matches the + incoming request, the policy field is left empty. + readOnly: true + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy' + GoogleRpcStatus: + id: GoogleRpcStatus + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + type: object + properties: + code: + description: The status code, which should be an enum value of google.rpc.Code. + type: integer + format: int32 + message: description: >- - Count of reCAPTCHA checkboxes or badges rendered. This is mostly - equivalent to a count of pageloads for pages that include reCAPTCHA. + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. type: string - failedCount: - format: int64 + details: description: >- - Count of submitted challenge solutions that were incorrect or - otherwise deemed suspicious such that a subsequent challenge was - triggered. - type: string - description: Metrics related to challenges. - id: GoogleCloudRecaptchaenterpriseV1ChallengeMetrics - GoogleCloudRecaptchaenterpriseV1TransactionDataItem: - id: GoogleCloudRecaptchaenterpriseV1TransactionDataItem + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + type: array + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + GoogleCloudRecaptchaenterpriseV1FirewallPolicy: + id: GoogleCloudRecaptchaenterpriseV1FirewallPolicy + description: >- + A FirewallPolicy represents a single matching pattern and resulting + actions to take. + type: object properties: name: + description: >- + Identifier. The resource name for the FirewallPolicy in the format + `projects/{project}/firewallpolicies/{firewallpolicy}`. type: string - description: Optional. The full name of the item. - quantity: + description: + description: >- + Optional. A description of what this policy aims to achieve, for + convenience purposes. The description can at most include 256 UTF-8 + characters. type: string - format: int64 - description: Optional. The quantity of this item that is being purchased. - value: + path: description: >- - Optional. The value per item that the user is paying, in the - transaction currency, after discounts. - format: double - type: number - merchantAccountId: + Optional. The path for which this policy applies, specified as a + glob pattern. For more information on glob, see the [manual + page](https://man7.org/linux/man-pages/man7/glob.7.html). A path has + a max length of 200 characters. + type: string + condition: description: >- - Optional. When a merchant is specified, its corresponding - account_id. Necessary to populate marketplace-style transactions. + Optional. A CEL (Common Expression Language) conditional expression + that specifies if this policy applies to an incoming user request. + If this condition evaluates to true and the requested path matched + the path pattern, the associated actions should be executed by the + caller. The condition string is checked for CEL syntax correctness + on creation. For more information, see the [CEL + spec](https://github.com/google/cel-spec) and its [language + definition](https://github.com/google/cel-spec/blob/master/doc/langdef.md). + A condition has a max length of 500 characters. type: string + actions: + description: >- + Optional. The actions that the caller should take regarding user + access. There should be at most one terminal action. A terminal + action is any action that forces a response, such as `AllowAction`, + `BlockAction` or `SubstituteAction`. Zero or more non-terminal + actions such as `SetHeader` might be specified. A single policy can + contain up to 16 actions. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallAction + GoogleCloudRecaptchaenterpriseV1FirewallAction: + id: GoogleCloudRecaptchaenterpriseV1FirewallAction + description: >- + An individual action. Each action represents what to do if a policy + matches. type: object - description: Line items being purchased in this transaction. - GoogleCloudRecaptchaenterpriseV1AndroidKeySettings: - id: GoogleCloudRecaptchaenterpriseV1AndroidKeySettings - description: Settings specific to keys that can be used by Android apps. properties: - allowedPackageNames: - items: - type: string - type: array + allow: description: >- - Optional. Android package names of apps allowed to use the key. - Example: 'com.companyname.appname' - allowAllPackageNames: - type: boolean - description: Optional. If set to true, allowed_package_names are not enforced. - supportNonGoogleAppStoreDistribution: + The user request did not match any policy and should be allowed + access to the requested resource. + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionAllowAction + block: description: >- - Optional. Set to true for keys that are used in an Android - application that is available for download in app stores in addition - to the Google Play Store. - type: boolean - type: object - GoogleCloudRecaptchaenterpriseV1IOSKeySettings: - type: object - id: GoogleCloudRecaptchaenterpriseV1IOSKeySettings - description: Settings specific to keys that can be used by iOS apps. - properties: - appleDeveloperId: + This action denies access to a given page. The user gets an HTTP + error code. + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionBlockAction + includeRecaptchaScript: description: >- - Optional. Apple Developer account details for the app that is - protected by the reCAPTCHA Key. reCAPTCHA leverages - platform-specific checks like Apple App Attest and Apple DeviceCheck - to protect your app from abuse. Providing these fields allows - reCAPTCHA to get a better assessment of the integrity of your app. + This action injects reCAPTCHA JavaScript code into the HTML page + returned by the site backend. $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1AppleDeveloperId - allowedBundleIds: + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionIncludeRecaptchaScriptAction + redirect: description: >- - Optional. iOS bundle ids of apps allowed to use the key. Example: - 'com.companyname.productname.appname' - items: - type: string - type: array - allowAllBundleIds: - type: boolean - description: Optional. If set to true, allowed_bundle_ids are not enforced. - GoogleCloudRecaptchaenterpriseV1FirewallPolicyAssessment: - properties: - firewallPolicy: - readOnly: true - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy' + This action redirects the request to a reCAPTCHA interstitial to + attach a token. + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectAction + substitute: description: >- - Output only. The policy that matched the request. If more than one - policy may match, this is the first match. If no policy matches the - incoming request, the policy field is left empty. - error: + This action transparently serves a different page to an offending + user. + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionSubstituteAction + setHeader: description: >- - Output only. If the processing of a policy config fails, an error is - populated and the firewall_policy is left empty. - $ref: '#/components/schemas/GoogleRpcStatus' - readOnly: true - id: GoogleCloudRecaptchaenterpriseV1FirewallPolicyAssessment + This action sets a custom header but allow the request to continue + to the customer backend. + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionSetHeaderAction + GoogleCloudRecaptchaenterpriseV1FirewallActionAllowAction: + id: GoogleCloudRecaptchaenterpriseV1FirewallActionAllowAction + description: An allow action continues processing a request unimpeded. + type: object + properties: {} + GoogleCloudRecaptchaenterpriseV1FirewallActionBlockAction: + id: GoogleCloudRecaptchaenterpriseV1FirewallActionBlockAction + description: >- + A block action serves an HTTP error code a prevents the request from + hitting the backend. + type: object + properties: {} + GoogleCloudRecaptchaenterpriseV1FirewallActionIncludeRecaptchaScriptAction: + id: >- + GoogleCloudRecaptchaenterpriseV1FirewallActionIncludeRecaptchaScriptAction + description: >- + An include reCAPTCHA script action involves injecting reCAPTCHA + JavaScript code into the HTML returned by the site backend. This + reCAPTCHA script is tasked with collecting user signals on the requested + web page, issuing tokens as a cookie within the site domain, and + enabling their utilization in subsequent page requests. + type: object + properties: {} + GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectAction: + id: GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectAction + description: >- + A redirect action returns a 307 (temporary redirect) response, pointing + the user to a reCAPTCHA interstitial page to attach a token. + type: object + properties: {} + GoogleCloudRecaptchaenterpriseV1FirewallActionSubstituteAction: + id: GoogleCloudRecaptchaenterpriseV1FirewallActionSubstituteAction + description: >- + A substitute action transparently serves a different page than the one + requested. type: object - description: Policy config assessment. - GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesRequest: properties: - names: - items: - type: string + path: description: >- - Required. A list containing all policy names, in the new order. Each - name is in the format - `projects/{project}/firewallpolicies/{firewallpolicy}`. - type: array - type: object - id: GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesRequest - description: The reorder firewall policies request message. - GoogleCloudRecaptchaenterpriseV1FirewallAction: + Optional. The address to redirect to. The target is a relative path + in the current host. Example: "/blog/404.html". + type: string + GoogleCloudRecaptchaenterpriseV1FirewallActionSetHeaderAction: + id: GoogleCloudRecaptchaenterpriseV1FirewallActionSetHeaderAction + description: >- + A set header action sets a header and forwards the request to the + backend. This can be used to trigger custom protection implemented on + the backend. type: object - id: GoogleCloudRecaptchaenterpriseV1FirewallAction properties: - setHeader: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionSetHeaderAction + key: description: >- - This action sets a custom header but allow the request to continue - to the customer backend. - allow: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionAllowAction + Optional. The header key to set in the request to the backend + server. + type: string + value: description: >- - The user request did not match any policy and should be allowed - access to the requested resource. - redirect: + Optional. The header value to set in the request to the backend + server. + type: string + GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessment: + id: GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessment + description: Assessment for Fraud Prevention. + type: object + properties: + transactionRisk: description: >- - This action redirects the request to a reCAPTCHA interstitial to - attach a token. - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectAction - substitute: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionSubstituteAction + Output only. Probability of this transaction being fraudulent. + Summarizes the combined risk of attack vectors below. Values are + from 0.0 (lowest) to 1.0 (highest). + readOnly: true + type: number + format: float + riskReasons: description: >- - This action transparently serves a different page to an offending - user. - block: + Output only. Reasons why the transaction is probably fraudulent and + received a high transaction risk score. + readOnly: true + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentRiskReason + stolenInstrumentVerdict: description: >- - This action denies access to a given page. The user gets an HTTP - error code. + Output only. Assessment of this transaction for risk of a stolen + instrument. + readOnly: true $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionBlockAction - includeRecaptchaScript: + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentStolenInstrumentVerdict + cardTestingVerdict: description: >- - This action injects reCAPTCHA JavaScript code into the HTML page - returned by the site backend. + Output only. Assessment of this transaction for risk of being part + of a card testing attack. + readOnly: true $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionIncludeRecaptchaScriptAction - description: >- - An individual action. Each action represents what to do if a policy - matches. - GoogleCloudRecaptchaenterpriseV1WafSettings: + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentCardTestingVerdict + behavioralTrustVerdict: + description: Output only. Assessment of this transaction for behavioral trust. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentBehavioralTrustVerdict + GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentRiskReason: + id: GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentRiskReason + description: Risk reasons applicable to the Fraud Prevention assessment. type: object properties: - wafFeature: - enum: - - WAF_FEATURE_UNSPECIFIED - - CHALLENGE_PAGE - - SESSION_TOKEN - - ACTION_TOKEN - - EXPRESS + reason: + description: >- + Output only. Risk reasons applicable to the Fraud Prevention + assessment. + readOnly: true + type: string enumDescriptions: - - Undefined feature. - - Redirects suspicious traffic to reCAPTCHA. + - Default unspecified type. - >- - Use reCAPTCHA session-tokens to protect the whole user session on - the site's domain. - - Use reCAPTCHA action-tokens to protect user actions. + A suspiciously high number of recent transactions have used + identifiers present in this transaction. - >- - Use reCAPTCHA WAF express protection to protect any content other - than web pages, like APIs and IoT devices. - description: Required. The WAF feature for which this key is enabled. - type: string - wafService: - description: Required. The WAF service that uses this key. + User is cycling through a suspiciously large number of + identifiers, suggesting enumeration or validation attacks within a + potential fraud network. + - >- + User has a short history or no history in the reCAPTCHA network, + suggesting the possibility of synthetic identity generation. + - >- + Identifiers used in this transaction originate from an unusual or + conflicting set of geolocations. + - >- + This transaction is linked to a cluster of known fraudulent + activity. enum: - - WAF_SERVICE_UNSPECIFIED - - CA - - FASTLY - - CLOUDFLARE - - AKAMAI - enumDescriptions: - - Undefined WAF - - Cloud Armor - - Fastly - - Cloudflare - - Akamai - type: string - id: GoogleCloudRecaptchaenterpriseV1WafSettings + - REASON_UNSPECIFIED + - HIGH_TRANSACTION_VELOCITY + - EXCESSIVE_ENUMERATION_PATTERN + - SHORT_IDENTITY_HISTORY + - GEOLOCATION_DISCREPANCY + - ASSOCIATED_WITH_FRAUD_CLUSTER + GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentStolenInstrumentVerdict: + id: >- + GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentStolenInstrumentVerdict description: >- - Settings specific to keys that can be used for WAF (Web Application - Firewall). - GoogleCloudRecaptchaenterpriseV1ListIpOverridesResponse: + Information about stolen instrument fraud, where the user is not the + legitimate owner of the instrument being used for the purchase. + type: object properties: - ipOverrides: - description: IP Overrides details. - items: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1IpOverrideData - type: array - nextPageToken: - type: string + risk: description: >- - Token to retrieve the next page of results. If this field is empty, - no keys remain in the results. - id: GoogleCloudRecaptchaenterpriseV1ListIpOverridesResponse + Output only. Probability of this transaction being executed with a + stolen instrument. Values are from 0.0 (lowest) to 1.0 (highest). + readOnly: true + type: number + format: float + GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentCardTestingVerdict: + id: >- + GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentCardTestingVerdict + description: >- + Information about card testing fraud, where an adversary is testing + fraudulently obtained cards or brute forcing their details. type: object - description: Response for ListIpOverrides. - GoogleCloudRecaptchaenterpriseV1ScoreDistribution: + properties: + risk: + description: >- + Output only. Probability of this transaction attempt being part of a + card testing attack. Values are from 0.0 (lowest) to 1.0 (highest). + readOnly: true + type: number + format: float + GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentBehavioralTrustVerdict: + id: >- + GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentBehavioralTrustVerdict + description: Information about behavioral trust of the transaction. + type: object + properties: + trust: + description: >- + Output only. Probability of this transaction attempt being executed + in a behaviorally trustworthy way. Values are from 0.0 (lowest) to + 1.0 (highest). + readOnly: true + type: number + format: float + GoogleCloudRecaptchaenterpriseV1FraudSignals: + id: GoogleCloudRecaptchaenterpriseV1FraudSignals + description: Fraud signals describing users and cards involved in the transaction. + type: object + properties: + userSignals: + description: Output only. Signals describing the end user in this transaction. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudSignalsUserSignals + cardSignals: + description: >- + Output only. Signals describing the payment card or cards used in + this transaction. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudSignalsCardSignals + GoogleCloudRecaptchaenterpriseV1FraudSignalsUserSignals: + id: GoogleCloudRecaptchaenterpriseV1FraudSignalsUserSignals + description: Signals describing the user involved in this transaction. + type: object + properties: + activeDaysLowerBound: + description: >- + Output only. This user (based on email, phone, and other + identifiers) has been seen on the internet for at least this number + of days. + readOnly: true + type: integer + format: int32 + syntheticRisk: + description: >- + Output only. Likelihood (from 0.0 to 1.0) this user includes + synthetic components in their identity, such as a randomly generated + email address, temporary phone number, or fake shipping address. + readOnly: true + type: number + format: float + GoogleCloudRecaptchaenterpriseV1FraudSignalsCardSignals: + id: GoogleCloudRecaptchaenterpriseV1FraudSignalsCardSignals + description: Signals describing the payment card used in this transaction. + type: object + properties: + cardLabels: + description: Output only. The labels for the payment card in this transaction. + readOnly: true + type: array + items: + type: string + enumDescriptions: + - No label specified. + - This card has been detected as prepaid. + - >- + This card has been detected as virtual, such as a card number + generated for a single transaction or merchant. + - >- + This card has been detected as being used in an unexpected + geographic location. + enum: + - CARD_LABEL_UNSPECIFIED + - PREPAID + - VIRTUAL + - UNEXPECTED_LOCATION + GoogleCloudRecaptchaenterpriseV1PhoneFraudAssessment: + id: GoogleCloudRecaptchaenterpriseV1PhoneFraudAssessment + description: Assessment for Phone Fraud type: object - description: Score distribution. - id: GoogleCloudRecaptchaenterpriseV1ScoreDistribution properties: - scoreBuckets: - additionalProperties: - format: int64 - type: string - type: object + smsTollFraudVerdict: description: >- - Map key is score value multiplied by 100. The scores are discrete - values between [0, 1]. The maximum number of buckets is on order of - a few dozen, but typically much lower (ie. 10). - GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment: - id: GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment - description: Account defender risk assessment. + Output only. Assessment of this phone event for risk of SMS toll + fraud. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1SmsTollFraudVerdict + GoogleCloudRecaptchaenterpriseV1SmsTollFraudVerdict: + id: GoogleCloudRecaptchaenterpriseV1SmsTollFraudVerdict + description: Information about SMS toll fraud. type: object properties: - labels: + risk: + description: >- + Output only. Probability of an SMS event being fraudulent. Values + are from 0.0 (lowest) to 1.0 (highest). + readOnly: true + type: number + format: float + reasons: + description: Output only. Reasons contributing to the SMS toll fraud verdict. + readOnly: true type: array items: type: string - enum: - - ACCOUNT_DEFENDER_LABEL_UNSPECIFIED - - PROFILE_MATCH - - SUSPICIOUS_LOGIN_ACTIVITY - - SUSPICIOUS_ACCOUNT_CREATION - - RELATED_ACCOUNTS_NUMBER_HIGH enumDescriptions: - - Default unspecified type. - - The request matches a known good profile for the user. - - >- - The request is potentially a suspicious login event and must be - further verified either through multi-factor authentication or - another system. - - >- - The request matched a profile that previously had suspicious - account creation behavior. This can mean that this is a fake - account. - - >- - The account in the request has a high number of related - accounts. It does not necessarily imply that the account is bad - but can require further investigation. - readOnly: true - description: Output only. Labels for this request. - GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsRequest: - description: The request message to search related account group memberships. + - Default unspecified reason + - The provided phone number was invalid + enum: + - SMS_TOLL_FRAUD_REASON_UNSPECIFIED + - INVALID_PHONE_NUMBER + GoogleCloudRecaptchaenterpriseV1AssessmentEnvironment: + id: GoogleCloudRecaptchaenterpriseV1AssessmentEnvironment + description: >- + The environment creating the assessment. This describes your environment + (the system invoking CreateAssessment), NOT the environment of your + user. type: object properties: - pageSize: - description: >- - Optional. The maximum number of groups to return. The service might - return fewer than this value. If unspecified, at most 50 groups are - returned. The maximum value is 1000; values above 1000 are coerced - to 1000. - format: int32 - type: integer - accountId: - type: string + client: description: >- - Optional. The unique stable account identifier used to search - connections. The identifier should correspond to an `account_id` - provided in a previous `CreateAssessment` or `AnnotateAssessment` - call. Either hashed_account_id or account_id must be set, but not - both. - hashedAccountId: + Optional. Identifies the client module initiating the + CreateAssessment request. This can be the link to the client + module's project. Examples include: - + "github.com/GoogleCloudPlatform/recaptcha-enterprise-google-tag-manager" + - "cloud.google.com/recaptcha/docs/implement-waf-akamai" - + "cloud.google.com/recaptcha/docs/implement-waf-cloudflare" - + "wordpress.org/plugins/recaptcha-something" type: string - description: >- - Optional. Deprecated: use `account_id` instead. The unique stable - hashed account identifier used to search connections. The identifier - should correspond to a `hashed_account_id` provided in a previous - `CreateAssessment` or `AnnotateAssessment` call. Either - hashed_account_id or account_id must be set, but not both. - deprecated: true - format: byte - pageToken: + version: + description: Optional. The version of the client module. For example, "1.0.0". type: string - description: >- - Optional. A page token, received from a previous - `SearchRelatedAccountGroupMemberships` call. Provide this to - retrieve the subsequent page. When paginating, all other parameters - provided to `SearchRelatedAccountGroupMemberships` must match the - call that provided the page token. - id: >- - GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsRequest - GoogleCloudRecaptchaenterpriseV1WebKeySettings: - id: GoogleCloudRecaptchaenterpriseV1WebKeySettings + GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest: + id: GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest + description: The request message to annotate an Assessment. type: object - description: Settings specific to keys that can be used by websites. properties: - allowAllDomains: - type: boolean - description: Optional. If set to true, it means allowed_domains are not enforced. - challengeSecurityPreference: - enum: - - CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED - - USABILITY - - BALANCE - - SECURITY - description: >- - Optional. Settings for the frequency and difficulty at which this - key triggers captcha challenges. This should only be specified for - IntegrationTypes CHECKBOX and INVISIBLE and SCORE_AND_CHALLENGE. - type: string - enumDescriptions: - - Default type that indicates this enum hasn't been specified. - - Key tends to show fewer and easier challenges. - - Key tends to show balanced (in amount and difficulty) challenges. - - Key tends to show more and harder challenges. - allowAmpTraffic: - type: boolean + annotation: description: >- - Optional. If set to true, the key can be used on AMP (Accelerated - Mobile Pages) websites. This is supported only for the SCORE - integration type. - integrationType: - enum: - - INTEGRATION_TYPE_UNSPECIFIED - - SCORE - - CHECKBOX - - INVISIBLE - description: Required. Describes how this key is integrated with the website. + Optional. The annotation that is assigned to the Event. This field + can be left empty to provide reasons that apply to an event without + concluding whether the event is legitimate or fraudulent. type: string enumDescriptions: + - Default unspecified type. + - Provides information that the event turned out to be legitimate. + - Provides information that the event turned out to be fraudulent. - >- - Default type that indicates this enum hasn't been specified. This - is not a valid IntegrationType, one of the other types must be - specified instead. - - >- - Only used to produce scores. It doesn't display the "I'm not a - robot" checkbox and never shows captcha challenges. - - >- - Displays the "I'm not a robot" checkbox and may show captcha - challenges after it is checked. + Provides information that the event was related to a login event + in which the user typed the correct password. Deprecated, prefer + indicating CORRECT_PASSWORD through the reasons field instead. - >- - Doesn't display the "I'm not a robot" checkbox, but may show - captcha challenges after risk analysis. - allowedDomains: - description: >- - Optional. Domains or subdomains of websites allowed to use the key. - All subdomains of an allowed domain are automatically allowed. A - valid domain requires a host and must not include any path, port, - query or fragment. Examples: 'example.com' or - 'subdomain.example.com' + Provides information that the event was related to a login event + in which the user typed the incorrect password. Deprecated, prefer + indicating INCORRECT_PASSWORD through the reasons field instead. + enumDeprecated: + - false + - false + - false + - true + - true + enum: + - ANNOTATION_UNSPECIFIED + - LEGITIMATE + - FRAUDULENT + - PASSWORD_CORRECT + - PASSWORD_INCORRECT + reasons: + description: Optional. Reasons for the annotation that are assigned to the event. + type: array items: type: string - type: array - GoogleCloudRecaptchaenterpriseV1RelatedAccountGroupMembership: - properties: + enumDescriptions: + - Unspecified reason. Do not use. + - >- + Indicates that the transaction had a chargeback issued with no + other details. When possible, specify the type by using + CHARGEBACK_FRAUD or CHARGEBACK_DISPUTE instead. + - >- + Indicates that the transaction had a chargeback issued related + to an alleged unauthorized transaction from the cardholder's + perspective (for example, the card number was stolen). + - >- + Indicates that the transaction had a chargeback issued related + to the cardholder having provided their card details but + allegedly not being satisfied with the purchase (for example, + misrepresentation, attempted cancellation). + - >- + Indicates that the completed payment transaction was refunded by + the seller. + - >- + Indicates that the completed payment transaction was determined + to be fraudulent by the seller, and was cancelled and refunded + as a result. + - >- + Indicates that the payment transaction was accepted, and the + user was charged. + - >- + Indicates that the payment transaction was declined, for example + due to invalid card details. + - >- + Indicates the transaction associated with the assessment is + suspected of being fraudulent based on the payment method, + billing details, shipping address or other transaction + information. + - >- + Indicates that the user was served a 2FA challenge. An old + assessment with `ENUM_VALUES.INITIATED_TWO_FACTOR` reason that + has not been overwritten with `PASSED_TWO_FACTOR` is treated as + an abandoned 2FA flow. This is equivalent to + `FAILED_TWO_FACTOR`. + - Indicates that the user passed a 2FA challenge. + - Indicates that the user failed a 2FA challenge. + - Indicates the user provided the correct password. + - Indicates the user provided an incorrect password. + - >- + Indicates that the user sent unwanted and abusive messages to + other users of the platform, such as spam, scams, phishing, or + social engineering. + enum: + - REASON_UNSPECIFIED + - CHARGEBACK + - CHARGEBACK_FRAUD + - CHARGEBACK_DISPUTE + - REFUND + - REFUND_FRAUD + - TRANSACTION_ACCEPTED + - TRANSACTION_DECLINED + - PAYMENT_HEURISTICS + - INITIATED_TWO_FACTOR + - PASSED_TWO_FACTOR + - FAILED_TWO_FACTOR + - CORRECT_PASSWORD + - INCORRECT_PASSWORD + - SOCIAL_SPAM accountId: - type: string description: >- - The unique stable account identifier of the member. The identifier - corresponds to an `account_id` provided in a previous - `CreateAssessment` or `AnnotateAssessment` call. - name: + Optional. A stable account identifier to apply to the assessment. + This is an alternative to setting `account_id` in + `CreateAssessment`, for example when a stable account identifier is + not yet known in the initial request. type: string - description: >- - Required. Identifier. The resource name for this membership in the - format - `projects/{project}/relatedaccountgroups/{relatedaccountgroup}/memberships/{membership}`. hashedAccountId: - type: string description: >- - Deprecated: use `account_id` instead. The unique stable hashed - account identifier of the member. The identifier corresponds to a - `hashed_account_id` provided in a previous `CreateAssessment` or - `AnnotateAssessment` call. - deprecated: true + Optional. A stable hashed account identifier to apply to the + assessment. This is an alternative to setting `hashed_account_id` in + `CreateAssessment`, for example when a stable account identifier is + not yet known in the initial request. + type: string format: byte - id: GoogleCloudRecaptchaenterpriseV1RelatedAccountGroupMembership - description: A membership in a group of related accounts. - type: object - GoogleCloudRecaptchaenterpriseV1RetrieveLegacySecretKeyResponse: - type: object - id: GoogleCloudRecaptchaenterpriseV1RetrieveLegacySecretKeyResponse - description: >- - Secret key is used only in legacy reCAPTCHA. It must be used in a 3rd - party integration with legacy reCAPTCHA. - properties: - legacySecretKey: + transactionEvent: description: >- - The secret key (also known as shared secret) authorizes - communication between your application backend and the reCAPTCHA - Enterprise server to create an assessment. The secret key needs to - be kept safe for security purposes. - type: string - GoogleCloudRecaptchaenterpriseV1TestingOptions: - description: Options for user acceptance testing. + Optional. If the assessment is part of a payment transaction, + provide details on payment lifecycle events that occur in the + transaction. + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionEvent + GoogleCloudRecaptchaenterpriseV1TransactionEvent: + id: GoogleCloudRecaptchaenterpriseV1TransactionEvent + description: Describes an event in the lifecycle of a payment transaction. type: object - id: GoogleCloudRecaptchaenterpriseV1TestingOptions properties: - testingChallenge: + eventType: + description: Optional. The type of this transaction event. type: string - description: >- - Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all - challenge requests for this site return nocaptcha if NOCAPTCHA, or - an unsolvable challenge if CHALLENGE. enumDescriptions: + - Default, unspecified event type. - >- - Perform the normal risk analysis and return either nocaptcha or a - challenge depending on risk and trust factors. + Indicates that the transaction is approved by the merchant. The + accompanying reasons can include terms such as 'INHOUSE', + 'ACCERTIFY', 'CYBERSOURCE', or 'MANUAL_REVIEW'. - >- - Challenge requests for this key always return a nocaptcha, which - does not require a solution. + Indicates that the transaction is denied and concluded due to + risks detected by the merchant. The accompanying reasons can + include terms such as 'INHOUSE', 'ACCERTIFY', 'CYBERSOURCE', or + 'MANUAL_REVIEW'. - >- - Challenge requests for this key always return an unsolvable - challenge. - enum: - - TESTING_CHALLENGE_UNSPECIFIED - - NOCAPTCHA - - UNSOLVABLE_CHALLENGE - testingScore: - type: number - description: >- - Optional. All assessments for this Key return this score. Must be - between 0 (likely not legitimate) and 1 (likely legitimate) - inclusive. - format: float - GoogleCloudRecaptchaenterpriseV1TokenProperties: - type: object - description: Properties of the provided event token. - properties: - invalidReason: - readOnly: true - enumDescriptions: - - Default unspecified type. - - If the failure reason was not accounted for. - - The provided user verification token was malformed. - - The user verification token had expired. - - The user verification had already been seen. - - The user verification token was not present. + Indicates that the transaction is being evaluated by a human, due + to suspicion or risk. - >- - A retriable error (such as network failure) occurred on the - browser. Could easily be simulated by an attacker. - type: string + Indicates that the authorization attempt with the card issuer + succeeded. + - >- + Indicates that the authorization attempt with the card issuer + failed. The accompanying reasons can include Visa's '54' + indicating that the card is expired, or '82' indicating that the + CVV is incorrect. + - >- + Indicates that the transaction is completed because the funds were + settled. + - >- + Indicates that the transaction could not be completed because the + funds were not settled. + - >- + Indicates that the transaction has been canceled. Specify the + reason for the cancellation. For example, + 'INSUFFICIENT_INVENTORY'. + - >- + Indicates that the merchant has received a chargeback inquiry due + to fraud for the transaction, requesting additional information + before a fraud chargeback is officially issued and a formal + chargeback notification is sent. + - >- + Indicates that the merchant has received a chargeback alert due to + fraud for the transaction. The process of resolving the dispute + without involving the payment network is started. + - >- + Indicates that a fraud notification is issued for the transaction, + sent by the payment instrument's issuing bank because the + transaction appears to be fraudulent. We recommend including TC40 + or SAFE data in the `reason` field for this event type. For + partial chargebacks, we recommend that you include an amount in + the `value` field. + - >- + Indicates that the merchant is informed by the payment network + that the transaction has entered the chargeback process due to + fraud. Reason code examples include Discover's '6005' and '6041'. + For partial chargebacks, we recommend that you include an amount + in the `value` field. + - >- + Indicates that the transaction has entered the chargeback process + due to fraud, and that the merchant has chosen to enter + representment. Reason examples include Discover's '6005' and + '6041'. For partial chargebacks, we recommend that you include an + amount in the `value` field. + - >- + Indicates that the transaction has had a fraud chargeback which + was illegitimate and was reversed as a result. For partial + chargebacks, we recommend that you include an amount in the + `value` field. + - >- + Indicates that the merchant has received a refund for a completed + transaction. For partial refunds, we recommend that you include an + amount in the `value` field. Reason example: 'TAX_EXEMPT' (partial + refund of exempt tax) + - >- + Indicates that the merchant has received a refund request for this + transaction, but that they have declined it. For partial refunds, + we recommend that you include an amount in the `value` field. + Reason example: 'TAX_EXEMPT' (partial refund of exempt tax) + - >- + Indicates that the completed transaction was refunded by the + merchant. For partial refunds, we recommend that you include an + amount in the `value` field. Reason example: 'TAX_EXEMPT' (partial + refund of exempt tax) + - >- + Indicates that the completed transaction was refunded by the + merchant, and that this refund was reversed. For partial refunds, + we recommend that you include an amount in the `value` field. enum: - - INVALID_REASON_UNSPECIFIED - - UNKNOWN_INVALID_REASON - - MALFORMED - - EXPIRED - - DUPE - - MISSING - - BROWSER_ERROR - description: Output only. Reason associated with the response when valid = false. - iosBundleId: - type: string - readOnly: true - description: >- - Output only. The ID of the iOS bundle with which the token was - generated (iOS keys only). - createTime: - format: google-datetime - type: string + - TRANSACTION_EVENT_TYPE_UNSPECIFIED + - MERCHANT_APPROVE + - MERCHANT_DENY + - MANUAL_REVIEW + - AUTHORIZATION + - AUTHORIZATION_DECLINE + - PAYMENT_CAPTURE + - PAYMENT_CAPTURE_DECLINE + - CANCEL + - CHARGEBACK_INQUIRY + - CHARGEBACK_ALERT + - FRAUD_NOTIFICATION + - CHARGEBACK + - CHARGEBACK_REPRESENTMENT + - CHARGEBACK_REVERSE + - REFUND_REQUEST + - REFUND_DECLINE + - REFUND + - REFUND_REVERSE + reason: description: >- - Output only. The timestamp corresponding to the generation of the - token. - readOnly: true - action: - description: Output only. Action name provided at token generation. - readOnly: true + Optional. The reason or standardized code that corresponds with this + transaction event, if one exists. For example, a CHARGEBACK event + with code 6005. type: string - valid: - readOnly: true - description: >- - Output only. Whether the provided user response token is valid. When - valid = false, the reason could be specified in invalid_reason or it - could also be due to a user failing to solve a challenge or a - sitekey mismatch (i.e the sitekey used to generate the token was - different than the one specified in the assessment). - type: boolean - hostname: - readOnly: true + value: description: >- - Output only. The hostname of the page on which the token was - generated (Web keys only). - type: string - androidPackageName: + Optional. The value that corresponds with this transaction event, if + one exists. For example, a refund event where $5.00 was refunded. + Currency is obtained from the original transaction data. + type: number + format: double + eventTime: description: >- - Output only. The name of the Android package with which the token - was generated (Android keys only). - readOnly: true + Optional. Timestamp when this transaction event occurred; otherwise + assumed to be the time of the API call. type: string - id: GoogleCloudRecaptchaenterpriseV1TokenProperties - GoogleCloudRecaptchaenterpriseV1RemoveIpOverrideResponse: - properties: {} - description: Response for RemoveIpOverride. + format: google-datetime + GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentResponse: + id: GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentResponse + description: Empty response for AnnotateAssessment. type: object - id: GoogleCloudRecaptchaenterpriseV1RemoveIpOverrideResponse + properties: {} GoogleCloudRecaptchaenterpriseV1Key: + id: GoogleCloudRecaptchaenterpriseV1Key + description: >- + A key used to identify and configure applications (web and/or mobile) + that use reCAPTCHA Enterprise. type: object properties: - createTime: - description: >- - Output only. The timestamp corresponding to the creation of this - key. - format: google-datetime - type: string - readOnly: true - testingOptions: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1TestingOptions' - description: Optional. Options for user acceptance testing. - webSettings: - description: Settings for keys that can be used by websites. - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1WebKeySettings' - labels: - type: object - additionalProperties: - type: string - description: >- - Optional. See [Creating and managing labels] - (https://cloud.google.com/recaptcha/docs/labels). name: - type: string description: >- Identifier. The resource name for the Key in the format `projects/{project}/keys/{key}`. - displayName: type: string + displayName: description: >- Required. Human-readable display name of this key. Modifiable by user. + type: string + webSettings: + description: Settings for keys that can be used by websites. + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1WebKeySettings' androidSettings: + description: Settings for keys that can be used by Android apps. $ref: >- #/components/schemas/GoogleCloudRecaptchaenterpriseV1AndroidKeySettings - description: Settings for keys that can be used by Android apps. iosSettings: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1IOSKeySettings' description: Settings for keys that can be used by iOS apps. - wafSettings: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1WafSettings' - description: Optional. Settings for WAF + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1IOSKeySettings' expressSettings: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1ExpressKeySettings description: Settings for keys that can be used by reCAPTCHA Express. - description: >- - A key used to identify and configure applications (web and/or mobile) - that use reCAPTCHA Enterprise. - id: GoogleCloudRecaptchaenterpriseV1Key - GoogleCloudRecaptchaenterpriseV1TransactionData: - id: GoogleCloudRecaptchaenterpriseV1TransactionData - description: >- - Transaction data associated with a payment protected by reCAPTCHA - Enterprise. - type: object - properties: - shippingValue: - type: number - description: >- - Optional. The value of shipping in the specified currency. 0 for - free or no shipping. - format: double - gatewayInfo: - description: >- - Optional. Information about the payment gateway's response to the - transaction. - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataGatewayInfo - shippingAddress: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataAddress - description: >- - Optional. Destination address if this transaction involves shipping - a physical item. - paymentMethod: - type: string - description: >- - Optional. The payment method for the transaction. The allowed values - are: * credit-card * debit-card * gift-card * processor-{name} (If a - third-party is used, for example, processor-paypal) * custom-{name} - (If an alternative method is used, for example, custom-crypto) - cardBin: - type: string - description: >- - Optional. The Bank Identification Number - generally the first 6 or - 8 digits of the card. - transactionId: - type: string - description: >- - Unique identifier for the transaction. This custom identifier can be - used to reference this transaction in the future, for example, - labeling a refund or chargeback event. Two attempts at the same - transaction should use the same transaction id. - items: - type: array - description: Optional. Items purchased in this transaction. - items: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataItem - cardLastFour: - type: string - description: Optional. The last four digits of the card. - billingAddress: - description: >- - Optional. Address associated with the payment method when - applicable. - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataAddress - merchants: - description: >- - Optional. Information about the user or users fulfilling the - transaction. - items: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataUser - type: array - user: - description: >- - Optional. Information about the user paying/initiating the - transaction. $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataUser - value: - format: double - type: number - description: >- - Optional. The decimal value of the transaction in the specified - currency. - currencyCode: - description: Optional. The currency code in ISO-4217 format. - type: string - GoogleCloudRecaptchaenterpriseV1RiskAnalysis: - id: GoogleCloudRecaptchaenterpriseV1RiskAnalysis - properties: - score: - format: float - readOnly: true - type: number - description: >- - Output only. Legitimate event score from 0.0 to 1.0. (1.0 means very - likely legitimate traffic while 0.0 means very likely non-legitimate - traffic). - reasons: - readOnly: true - type: array - description: Output only. Reasons contributing to the risk analysis verdict. - items: - enumDescriptions: - - Default unspecified type. - - Interactions matched the behavior of an automated agent. - - The event originated from an illegitimate environment. - - Traffic volume from the event source is higher than normal. - - >- - Interactions with the site were significantly different than - expected patterns. - - >- - Too little traffic has been received from this site thus far to - generate quality risk analysis. - - >- - The request matches behavioral characteristics of a carding - attack. - - >- - The request matches behavioral characteristics of chargebacks - for fraud. - type: string - enum: - - CLASSIFICATION_REASON_UNSPECIFIED - - AUTOMATION - - UNEXPECTED_ENVIRONMENT - - TOO_MUCH_TRAFFIC - - UNEXPECTED_USAGE_PATTERNS - - LOW_CONFIDENCE_SCORE - - SUSPECTED_CARDING - - SUSPECTED_CHARGEBACK - challenge: - readOnly: true - description: >- - Output only. Challenge information for SCORE_AND_CHALLENGE and - INVISIBLE keys - type: string - enumDescriptions: - - Default unspecified type. - - No challenge was presented for solving. - - A solution was submitted that was correct. - - >- - A solution was submitted that was incorrect or otherwise deemed - suspicious. - enum: - - CHALLENGE_UNSPECIFIED - - NOCAPTCHA - - PASSED - - FAILED - extendedVerdictReasons: - description: >- - Output only. Extended verdict reasons to be used for experimentation - only. The set of possible reasons is subject to change. - items: - type: string - type: array - readOnly: true - description: Risk analysis result for an event. - type: object - GoogleRpcStatus: - type: object - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - properties: - details: - type: array - items: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - code: - format: int32 - description: The status code, which should be an enum value of google.rpc.Code. - type: integer - message: - type: string - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - id: GoogleRpcStatus - GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupsResponse: - properties: - relatedAccountGroups: - items: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1RelatedAccountGroup - description: The groups of related accounts listed by the query. - type: array - nextPageToken: - type: string + #/components/schemas/GoogleCloudRecaptchaenterpriseV1ExpressKeySettings + labels: description: >- - A token, which can be sent as `page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. - description: The response to a `ListRelatedAccountGroups` call. - id: GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupsResponse - type: object - GoogleCloudRecaptchaenterpriseV1FraudSignalsUserSignals: - properties: - syntheticRisk: - readOnly: true + Optional. See [Creating and managing labels] + (https://cloud.google.com/recaptcha/docs/labels). + type: object + additionalProperties: + type: string + createTime: description: >- - Output only. Likelihood (from 0.0 to 1.0) this user includes - synthetic components in their identity, such as a randomly generated - email address, temporary phone number, or fake shipping address. - type: number - format: float - activeDaysLowerBound: - type: integer + Output only. The timestamp corresponding to the creation of this + key. readOnly: true - format: int32 - description: >- - Output only. This user (based on email, phone, and other - identifiers) has been seen on the internet for at least this number - of days. - id: GoogleCloudRecaptchaenterpriseV1FraudSignalsUserSignals + type: string + format: google-datetime + testingOptions: + description: Optional. Options for user acceptance testing. + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1TestingOptions' + wafSettings: + description: Optional. Settings for WAF + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1WafSettings' + GoogleCloudRecaptchaenterpriseV1WebKeySettings: + id: GoogleCloudRecaptchaenterpriseV1WebKeySettings + description: Settings specific to keys that can be used by websites. type: object - description: Signals describing the user involved in this transaction. - GoogleCloudRecaptchaenterpriseV1IpOverrideData: - id: GoogleCloudRecaptchaenterpriseV1IpOverrideData - description: Information about the IP or IP range override. properties: - ip: - type: string + allowAllDomains: + description: Optional. If set to true, it means allowed_domains are not enforced. + type: boolean + allowedDomains: description: >- - Required. The IP address to override (can be IPv4, IPv6 or CIDR). - The IP override must be a valid IPv4 or IPv6 address, or a CIDR - range. The IP override must be a public IP address. Example of IPv4: - 168.192.5.6 Example of IPv6: 2001:0000:130F:0000:0000:09C0:876A:130B - Example of IPv4 with CIDR: 168.192.5.0/24 Example of IPv6 with CIDR: - 2001:0DB8:1234::/48 - overrideType: - enum: - - OVERRIDE_TYPE_UNSPECIFIED - - ALLOW - description: Required. Describes the type of IP override. + Optional. Domains or subdomains of websites allowed to use the key. + All subdomains of an allowed domain are automatically allowed. A + valid domain requires a host and must not include any path, port, + query or fragment. Examples: 'example.com' or + 'subdomain.example.com' + type: array + items: + type: string + allowAmpTraffic: + description: >- + Optional. If set to true, the key can be used on AMP (Accelerated + Mobile Pages) websites. This is supported only for the SCORE + integration type. + type: boolean + integrationType: + description: Required. Describes how this key is integrated with the website. type: string enumDescriptions: - >- - Default override type that indicates this enum hasn't been - specified. + Default type that indicates this enum hasn't been specified. This + is not a valid IntegrationType, one of the other types must be + specified instead. - >- - Allowlist the IP address; i.e. give a `risk_analysis.score` of 0.9 - for all valid assessments. - type: object - GoogleCloudRecaptchaenterpriseV1Metrics: - properties: - challengeMetrics: - items: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1ChallengeMetrics + Only used to produce scores. It doesn't display the "I'm not a + robot" checkbox and never shows captcha challenges. + - >- + Displays the "I'm not a robot" checkbox and may show captcha + challenges after it is checked. + - >- + Doesn't display the "I'm not a robot" checkbox, but may show + captcha challenges after risk analysis. + - >- + Displays a visual challenge or not depending on the user risk + analysis score. + enum: + - INTEGRATION_TYPE_UNSPECIFIED + - SCORE + - CHECKBOX + - INVISIBLE + - POLICY_BASED_CHALLENGE + challengeSecurityPreference: description: >- - Metrics are continuous and in order by dates, and in the granularity - of day. Only challenge-based keys (CHECKBOX, INVISIBLE) have - challenge-based data. - type: array - startTime: - description: Inclusive start time aligned to a day (UTC). - type: string - format: google-datetime - name: + Optional. Settings for the frequency and difficulty at which this + key triggers captcha challenges. This should only be specified for + `IntegrationType` CHECKBOX, INVISIBLE or POLICY_BASED_CHALLENGE. type: string - readOnly: true - description: >- - Output only. Identifier. The name of the metrics, in the format - `projects/{project}/keys/{key}/metrics`. - scoreMetrics: - description: >- - Metrics are continuous and in order by dates, and in the granularity - of day. All Key types should have score-based data. - items: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1ScoreMetrics' - type: array - id: GoogleCloudRecaptchaenterpriseV1Metrics - description: Metrics for a single Key. - type: object - GoogleCloudRecaptchaenterpriseV1AssessmentEnvironment: + enumDescriptions: + - Default type that indicates this enum hasn't been specified. + - Key tends to show fewer and easier challenges. + - Key tends to show balanced (in amount and difficulty) challenges. + - Key tends to show more and harder challenges. + enum: + - CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED + - USABILITY + - BALANCE + - SECURITY + challengeSettings: + description: Optional. Challenge settings. + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1WebKeySettingsChallengeSettings + GoogleCloudRecaptchaenterpriseV1WebKeySettingsChallengeSettings: + id: GoogleCloudRecaptchaenterpriseV1WebKeySettingsChallengeSettings + description: >- + Settings for POLICY_BASED_CHALLENGE keys to control when a challenge is + triggered. type: object - id: GoogleCloudRecaptchaenterpriseV1AssessmentEnvironment properties: - version: - description: Optional. The version of the client module. For example, "1.0.0". - type: string - client: + defaultSettings: description: >- - Optional. Identifies the client module initiating the - CreateAssessment request. This can be the link to the client - module's project. Examples include: - - "github.com/GoogleCloudPlatform/recaptcha-enterprise-google-tag-manager" - - "cloud.google.com/recaptcha/docs/implement-waf-akamai" - - "cloud.google.com/recaptcha/docs/implement-waf-cloudflare" - - "wordpress.org/plugins/recaptcha-something" - type: string - description: >- - The environment creating the assessment. This describes your environment - (the system invoking CreateAssessment), NOT the environment of your - user. - GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesResponse: - properties: {} - description: The reorder firewall policies response message. + Required. Defines when a challenge is triggered (unless the default + threshold is overridden for the given action, see + `action_settings`). + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1WebKeySettingsActionSettings + actionSettings: + description: >- + Optional. The action to score threshold map. The action name should + be the same as the action name passed in the `data-action` attribute + (see https://cloud.google.com/recaptcha/docs/actions-website). + Action names are case-insensitive. There is a maximum of 100 action + settings. An action name has a maximum length of 100. + type: object + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1WebKeySettingsActionSettings + GoogleCloudRecaptchaenterpriseV1WebKeySettingsActionSettings: + id: GoogleCloudRecaptchaenterpriseV1WebKeySettingsActionSettings + description: Per-action challenge settings. type: object - id: GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesResponse - GoogleCloudRecaptchaenterpriseV1FraudSignalsCardSignals: - id: GoogleCloudRecaptchaenterpriseV1FraudSignalsCardSignals - description: Signals describing the payment card used in this transaction. + properties: + scoreThreshold: + description: >- + Required. A challenge is triggered if the end-user score is below + that threshold. Value must be between 0 and 1 (inclusive). + type: number + format: float + GoogleCloudRecaptchaenterpriseV1AndroidKeySettings: + id: GoogleCloudRecaptchaenterpriseV1AndroidKeySettings + description: Settings specific to keys that can be used by Android apps. type: object properties: - cardLabels: + allowAllPackageNames: + description: Optional. If set to true, allowed_package_names are not enforced. + type: boolean + allowedPackageNames: + description: >- + Optional. Android package names of apps allowed to use the key. + Example: 'com.companyname.appname' type: array - readOnly: true items: type: string - enum: - - CARD_LABEL_UNSPECIFIED - - PREPAID - - VIRTUAL - - UNEXPECTED_LOCATION - enumDescriptions: - - No label specified. - - This card has been detected as prepaid. - - >- - This card has been detected as virtual, such as a card number - generated for a single transaction or merchant. - - >- - This card has been detected as being used in an unexpected - geographic location. - description: Output only. The labels for the payment card in this transaction. - GoogleCloudRecaptchaenterpriseV1FirewallActionSetHeaderAction: - properties: - key: - type: string - description: >- - Optional. The header key to set in the request to the backend - server. - value: - type: string + supportNonGoogleAppStoreDistribution: description: >- - Optional. The header value to set in the request to the backend - server. + Optional. Set to true for keys that are used in an Android + application that is available for download in app stores in addition + to the Google Play Store. + type: boolean + GoogleCloudRecaptchaenterpriseV1IOSKeySettings: + id: GoogleCloudRecaptchaenterpriseV1IOSKeySettings + description: Settings specific to keys that can be used by iOS apps. type: object - id: GoogleCloudRecaptchaenterpriseV1FirewallActionSetHeaderAction - description: >- - A set header action sets a header and forwards the request to the - backend. This can be used to trigger custom protection implemented on - the backend. - GoogleCloudRecaptchaenterpriseV1TransactionDataUser: properties: - emailVerified: + allowAllBundleIds: + description: Optional. If set to true, allowed_bundle_ids are not enforced. type: boolean + allowedBundleIds: description: >- - Optional. Whether the email has been verified to be accessible by - the user (OTP or similar). - phoneNumber: - description: Optional. The phone number of the user, with country code. - type: string - accountId: - type: string - description: >- - Optional. Unique account identifier for this user. If using account - defender, this should match the hashed_account_id field. Otherwise, - a unique and persistent identifier for this account. - phoneVerified: + Optional. iOS bundle ids of apps allowed to use the key. Example: + 'com.companyname.productname.appname' + type: array + items: + type: string + appleDeveloperId: description: >- - Optional. Whether the phone number has been verified to be - accessible by the user (OTP or similar). - type: boolean - email: - type: string - description: Optional. The email address of the user. - creationMs: - description: Optional. The epoch milliseconds of the user's account creation. - type: string - format: int64 - type: object - description: Details about a user's account involved in the transaction. - id: GoogleCloudRecaptchaenterpriseV1TransactionDataUser + Optional. Apple Developer account details for the app that is + protected by the reCAPTCHA Key. reCAPTCHA leverages + platform-specific checks like Apple App Attest and Apple DeviceCheck + to protect your app from abuse. Providing these fields allows + reCAPTCHA to get a better assessment of the integrity of your app. + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1AppleDeveloperId GoogleCloudRecaptchaenterpriseV1AppleDeveloperId: - type: object id: GoogleCloudRecaptchaenterpriseV1AppleDeveloperId description: >- Contains fields that are required to perform Apple-specific integrity checks. + type: object properties: - teamId: - description: >- - Required. The Apple team ID (10-character string) owning the - provisioning profile used to build your application. - type: string privateKey: - type: string description: >- Required. Input only. A private key (downloaded as a text file with a .p8 file extension) generated for your Apple Developer account. Ensure that Apple DeviceCheck is enabled for the private key. + type: string keyId: description: Required. The Apple developer key ID (10-character string). type: string - GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo: - id: GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo + teamId: + description: >- + Required. The Apple team ID (10-character string) owning the + provisioning profile used to build your application. + type: string + GoogleCloudRecaptchaenterpriseV1ExpressKeySettings: + id: GoogleCloudRecaptchaenterpriseV1ExpressKeySettings + description: Settings specific to keys that can be used for reCAPTCHA Express. + type: object + properties: {} + GoogleCloudRecaptchaenterpriseV1TestingOptions: + id: GoogleCloudRecaptchaenterpriseV1TestingOptions + description: Options for user acceptance testing. type: object properties: - languageCode: - type: string + testingScore: description: >- - Optional. Language code preference for the verification message, set - as a IETF BCP 47 language code. - latestVerificationResult: - readOnly: true - enum: - - RESULT_UNSPECIFIED - - SUCCESS_USER_VERIFIED - - ERROR_USER_NOT_VERIFIED - - ERROR_SITE_ONBOARDING_INCOMPLETE - - ERROR_RECIPIENT_NOT_ALLOWED - - ERROR_RECIPIENT_ABUSE_LIMIT_EXHAUSTED - - ERROR_CRITICAL_INTERNAL - - ERROR_CUSTOMER_QUOTA_EXHAUSTED - - ERROR_VERIFICATION_BYPASSED - - ERROR_VERDICT_MISMATCH + Optional. All assessments for this Key return this score. Must be + between 0 (likely not legitimate) and 1 (likely legitimate) + inclusive. + type: number + format: float + testingChallenge: + description: >- + Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all + challenge requests for this site return nocaptcha if NOCAPTCHA, or + an unsolvable challenge if CHALLENGE. + type: string enumDescriptions: - - No information about the latest account verification. - - >- - The user was successfully verified. This means the account - verification challenge was successfully completed. - - The user failed the verification challenge. - - >- - The site is not properly onboarded to use the account verification - feature. - - >- - The recipient is not allowed for account verification. This can - occur during integration but should not occur in production. - - >- - The recipient has already been sent too many verification codes in - a short amount of time. - >- - The verification flow could not be completed due to a critical - internal error. - - >- - The client has exceeded their two factor request quota for this - period of time. + Perform the normal risk analysis and return either nocaptcha or a + challenge depending on risk and trust factors. - >- - The request cannot be processed at the time because of an - incident. This bypass can be restricted to a problematic - destination email domain, a customer, or could affect the entire - service. + Challenge requests for this key always return a nocaptcha, which + does not require a solution. - >- - The request parameters do not match with the token provided and - cannot be processed. - description: Output only. Result of the latest account verification challenge. + Challenge requests for this key always return an unsolvable + challenge. + enum: + - TESTING_CHALLENGE_UNSPECIFIED + - NOCAPTCHA + - UNSOLVABLE_CHALLENGE + GoogleCloudRecaptchaenterpriseV1WafSettings: + id: GoogleCloudRecaptchaenterpriseV1WafSettings + description: >- + Settings specific to keys that can be used for WAF (Web Application + Firewall). + type: object + properties: + wafService: + description: Required. The WAF service that uses this key. type: string - endpoints: - items: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo - type: array - description: Optional. Endpoints that can be used for identity verification. - username: + enumDescriptions: + - Undefined WAF + - Cloud Armor + - Fastly + - Cloudflare + - Akamai + enum: + - WAF_SERVICE_UNSPECIFIED + - CA + - FASTLY + - CLOUDFLARE + - AKAMAI + wafFeature: + description: Required. The WAF feature for which this key is enabled. type: string - deprecated: true - description: >- - Username of the account that is being verified. Deprecated. - Customers should now provide the `account_id` field in - `event.user_info`. - description: Information about account verification, used for identity verification. + enumDescriptions: + - Undefined feature. + - Redirects suspicious traffic to reCAPTCHA. + - >- + Use reCAPTCHA session-tokens to protect the whole user session on + the site's domain. + - Use reCAPTCHA action-tokens to protect user actions. + - 'Deprecated: Use `express_settings` instead.' + enumDeprecated: + - false + - false + - false + - false + - true + enum: + - WAF_FEATURE_UNSPECIFIED + - CHALLENGE_PAGE + - SESSION_TOKEN + - ACTION_TOKEN + - EXPRESS GoogleCloudRecaptchaenterpriseV1ListKeysResponse: - type: object + id: GoogleCloudRecaptchaenterpriseV1ListKeysResponse description: Response to request to list keys in a project. + type: object properties: - nextPageToken: - type: string - description: >- - Token to retrieve the next page of results. It is set to empty if no - keys remain in results. keys: + description: Key details. type: array items: $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Key' - description: Key details. - id: GoogleCloudRecaptchaenterpriseV1ListKeysResponse - GoogleCloudRecaptchaenterpriseV1ExpressKeySettings: + nextPageToken: + description: >- + Token to retrieve the next page of results. It is set to empty if no + keys remain in results. + type: string + GoogleCloudRecaptchaenterpriseV1RetrieveLegacySecretKeyResponse: + id: GoogleCloudRecaptchaenterpriseV1RetrieveLegacySecretKeyResponse + description: >- + Secret key is used only in legacy reCAPTCHA. It must be used in a 3rd + party integration with legacy reCAPTCHA. + type: object + properties: + legacySecretKey: + description: >- + The secret key (also known as shared secret) authorizes + communication between your application backend and the reCAPTCHA + Enterprise server to create an assessment. The secret key needs to + be kept safe for security purposes. + type: string + GoogleProtobufEmpty: + id: GoogleProtobufEmpty + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } type: object - id: GoogleCloudRecaptchaenterpriseV1ExpressKeySettings - properties: {} - description: Settings specific to keys that can be used for reCAPTCHA Express. - GoogleCloudRecaptchaenterpriseV1FirewallActionIncludeRecaptchaScriptAction: properties: {} - id: >- - GoogleCloudRecaptchaenterpriseV1FirewallActionIncludeRecaptchaScriptAction + GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest: + id: GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest + description: The migrate key request message. type: object - description: >- - An include reCAPTCHA script action involves injecting reCAPTCHA - JavaScript code into the HTML returned by the site backend. This - reCAPTCHA script is tasked with collecting user signals on the requested - web page, issuing tokens as a cookie within the site domain, and - enabling their utilization in subsequent page requests. - GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentStolenInstrumentVerdict: + properties: + skipBillingCheck: + description: >- + Optional. If true, skips the billing check. A reCAPTCHA Enterprise + key or migrated key behaves differently than a reCAPTCHA + (non-Enterprise version) key when you reach a quota limit (see + https://cloud.google.com/recaptcha/quotas#quota_limit). To avoid any + disruption of your usage, we check that a billing account is + present. If your usage of reCAPTCHA is under the free quota, you can + safely skip the billing check and proceed with the migration. See + https://cloud.google.com/recaptcha/docs/billing-information. + type: boolean + GoogleCloudRecaptchaenterpriseV1AddIpOverrideRequest: + id: GoogleCloudRecaptchaenterpriseV1AddIpOverrideRequest + description: The AddIpOverride request message. type: object - description: >- - Information about stolen instrument fraud, where the user is not the - legitimate owner of the instrument being used for the purchase. - id: >- - GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentStolenInstrumentVerdict properties: - risk: - format: float - readOnly: true + ipOverrideData: + description: Required. IP override added to the key. + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1IpOverrideData' + GoogleCloudRecaptchaenterpriseV1IpOverrideData: + id: GoogleCloudRecaptchaenterpriseV1IpOverrideData + description: Information about the IP or IP range override. + type: object + properties: + ip: description: >- - Output only. Probability of this transaction being executed with a - stolen instrument. Values are from 0.0 (lowest) to 1.0 (highest). - type: number - GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentBehavioralTrustVerdict: + Required. The IP address to override (can be IPv4, IPv6 or CIDR). + The IP override must be a valid IPv4 or IPv6 address, or a CIDR + range. The IP override must be a public IP address. Example of IPv4: + 168.192.5.6 Example of IPv6: 2001:0000:130F:0000:0000:09C0:876A:130B + Example of IPv4 with CIDR: 168.192.5.0/24 Example of IPv6 with CIDR: + 2001:0DB8:1234::/48 + type: string + overrideType: + description: Required. Describes the type of IP override. + type: string + enumDescriptions: + - >- + Default override type that indicates this enum hasn't been + specified. + - >- + Allowlist the IP address; i.e. give a `risk_analysis.score` of 0.9 + for all valid assessments. + enum: + - OVERRIDE_TYPE_UNSPECIFIED + - ALLOW + GoogleCloudRecaptchaenterpriseV1AddIpOverrideResponse: + id: GoogleCloudRecaptchaenterpriseV1AddIpOverrideResponse + description: Response for AddIpOverride. + type: object + properties: {} + GoogleCloudRecaptchaenterpriseV1RemoveIpOverrideRequest: + id: GoogleCloudRecaptchaenterpriseV1RemoveIpOverrideRequest + description: The RemoveIpOverride request message. type: object - id: >- - GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentBehavioralTrustVerdict properties: - trust: - readOnly: true - format: float - description: >- - Output only. Probability of this transaction attempt being executed - in a behaviorally trustworthy way. Values are from 0.0 (lowest) to - 1.0 (highest). - type: number - description: Information about behavioral trust of the transaction. - GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentResponse: + ipOverrideData: + description: Required. IP override to be removed from the key. + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1IpOverrideData' + GoogleCloudRecaptchaenterpriseV1RemoveIpOverrideResponse: + id: GoogleCloudRecaptchaenterpriseV1RemoveIpOverrideResponse + description: Response for RemoveIpOverride. type: object properties: {} - id: GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentResponse - description: Empty response for AnnotateAssessment. - GoogleCloudRecaptchaenterpriseV1AddIpOverrideResponse: - properties: {} - description: Response for AddIpOverride. - id: GoogleCloudRecaptchaenterpriseV1AddIpOverrideResponse - type: object - GoogleCloudRecaptchaenterpriseV1TransactionDataGatewayInfo: + GoogleCloudRecaptchaenterpriseV1ListIpOverridesResponse: + id: GoogleCloudRecaptchaenterpriseV1ListIpOverridesResponse + description: Response for ListIpOverrides. type: object - description: Details about the transaction from the gateway. - id: GoogleCloudRecaptchaenterpriseV1TransactionDataGatewayInfo properties: - avsResponseCode: - type: string - description: >- - Optional. AVS response code from the gateway (available only when - reCAPTCHA Enterprise is called after authorization). - gatewayResponseCode: + ipOverrides: + description: IP Overrides details. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1IpOverrideData + nextPageToken: description: >- - Optional. Gateway response code describing the state of the - transaction. + Token to retrieve the next page of results. If this field is empty, + no keys remain in the results. type: string + GoogleCloudRecaptchaenterpriseV1Metrics: + id: GoogleCloudRecaptchaenterpriseV1Metrics + description: Metrics for a single Key. + type: object + properties: name: + description: >- + Output only. Identifier. The name of the metrics, in the format + `projects/{project}/keys/{key}/metrics`. + readOnly: true type: string + startTime: description: >- - Optional. Name of the gateway service (for example, stripe, square, - paypal). - cvvResponseCode: + Inclusive start time aligned to a day in the America/Los_Angeles + (Pacific) timezone. type: string + format: google-datetime + scoreMetrics: description: >- - Optional. CVV response code from the gateway (available only when - reCAPTCHA Enterprise is called after authorization). - GoogleCloudRecaptchaenterpriseV1Assessment: + Metrics are continuous and in order by dates, and in the granularity + of day. All Key types should have score-based data. + type: array + items: + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1ScoreMetrics' + challengeMetrics: + description: >- + Metrics are continuous and in order by dates, and in the granularity + of day. Only challenge-based keys (CHECKBOX, INVISIBLE) have + challenge-based data. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1ChallengeMetrics + GoogleCloudRecaptchaenterpriseV1ScoreMetrics: + id: GoogleCloudRecaptchaenterpriseV1ScoreMetrics + description: Metrics related to scoring. type: object - id: GoogleCloudRecaptchaenterpriseV1Assessment - description: A reCAPTCHA Enterprise assessment resource. properties: - riskAnalysis: - readOnly: true - description: Output only. The risk analysis result for the event being assessed. - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1RiskAnalysis' - event: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Event' - description: Optional. The event being assessed. - assessmentEnvironment: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1AssessmentEnvironment - description: >- - Optional. The environment creating the assessment. This describes - your environment (the system invoking CreateAssessment), NOT the - environment of your user. - fraudPreventionAssessment: - description: >- - Output only. Assessment returned by Fraud Prevention when - TransactionData is provided. + overallMetrics: + description: Aggregated score metrics for all traffic. $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessment - readOnly: true - accountDefenderAssessment: + #/components/schemas/GoogleCloudRecaptchaenterpriseV1ScoreDistribution + actionMetrics: description: >- - Output only. Assessment returned by account defender when an account - identifier is provided. - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment - fraudSignals: - readOnly: true + Action-based metrics. The map key is the action name which specified + by the site owners at time of the "execute" client-side call. + type: object + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1ScoreDistribution + GoogleCloudRecaptchaenterpriseV1ScoreDistribution: + id: GoogleCloudRecaptchaenterpriseV1ScoreDistribution + description: Score distribution. + type: object + properties: + scoreBuckets: description: >- - Output only. Fraud Signals specific to the users involved in a - payment transaction. - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudSignals' - tokenProperties: - readOnly: true - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1TokenProperties' - description: Output only. Properties of the provided event token. - name: + Map key is score value multiplied by 100. The scores are discrete + values between [0, 1]. The maximum number of buckets is on order of + a few dozen, but typically much lower (ie. 10). + type: object + additionalProperties: + type: string + format: int64 + GoogleCloudRecaptchaenterpriseV1ChallengeMetrics: + id: GoogleCloudRecaptchaenterpriseV1ChallengeMetrics + description: Metrics related to challenges. + type: object + properties: + pageloadCount: description: >- - Output only. Identifier. The resource name for the Assessment in the - format `projects/{project}/assessments/{assessment}`. + Count of reCAPTCHA checkboxes or badges rendered. This is mostly + equivalent to a count of pageloads for pages that include reCAPTCHA. type: string - readOnly: true - firewallPolicyAssessment: - description: >- - Output only. Assessment returned when firewall policies belonging to - the project are evaluated using the field - firewall_policy_evaluation. - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicyAssessment - phoneFraudAssessment: - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1PhoneFraudAssessment + format: int64 + nocaptchaCount: description: >- - Output only. Assessment returned when a site key, a token, and a - phone number as `user_id` are provided. Account defender and SMS - toll fraud protection need to be enabled. - accountVerification: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo + Count of nocaptchas (successful verification without a challenge) + issued. + type: string + format: int64 + failedCount: description: >- - Optional. Account verification information for identity - verification. The assessment event must include a token and site key - to use this feature. - privatePasswordLeakVerification: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1PrivatePasswordLeakVerification + Count of submitted challenge solutions that were incorrect or + otherwise deemed suspicious such that a subsequent challenge was + triggered. + type: string + format: int64 + passedCount: description: >- - Optional. The private password leak verification field contains the - parameters that are used to to check for leaks privately without - sharing user credentials. - GoogleProtobufEmpty: - type: object - id: GoogleProtobufEmpty - properties: {} - description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } - GoogleCloudRecaptchaenterpriseV1PrivatePasswordLeakVerification: - id: GoogleCloudRecaptchaenterpriseV1PrivatePasswordLeakVerification - description: Private password leak verification info. + Count of nocaptchas (successful verification without a challenge) + plus submitted challenge solutions that were correct and resulted in + verification. + type: string + format: int64 + GoogleCloudRecaptchaenterpriseV1ListFirewallPoliciesResponse: + id: GoogleCloudRecaptchaenterpriseV1ListFirewallPoliciesResponse + description: Response to request to list firewall policies belonging to a project. type: object properties: - reencryptedUserCredentialsHash: - type: string - format: byte - description: >- - Output only. Corresponds to the re-encryption of the - `encrypted_user_credentials_hash` field. It is used to match - potential password leaks within `encrypted_leak_match_prefixes`. - readOnly: true - encryptedLeakMatchPrefixes: + firewallPolicies: + description: Policy details. type: array items: - format: byte - type: string - readOnly: true - description: >- - Output only. List of prefixes of the encrypted potential password - leaks that matched the given parameters. They must be compared with - the client-side decryption prefix of - `reencrypted_user_credentials_hash` - lookupHashPrefix: - format: byte - description: >- - Required. Exactly 26-bit prefix of the SHA-256 hash of the - canonicalized username. It is used to look up password leaks - associated with that hash prefix. - type: string - encryptedUserCredentialsHash: - format: byte + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy + nextPageToken: description: >- - Optional. Encrypted Scrypt hash of the canonicalized - username+password. It is re-encrypted by the server and returned - through `reencrypted_user_credentials_hash`. + Token to retrieve the next page of results. It is set to empty if no + policies remain in results. type: string - GoogleCloudRecaptchaenterpriseV1FraudSignals: - id: GoogleCloudRecaptchaenterpriseV1FraudSignals - description: Fraud signals describing users and cards involved in the transaction. + GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesRequest: + id: GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesRequest + description: The reorder firewall policies request message. type: object properties: - cardSignals: - readOnly: true + names: description: >- - Output only. Signals describing the payment card or cards used in - this transaction. - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudSignalsCardSignals - userSignals: - description: Output only. Signals describing the end user in this transaction. - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudSignalsUserSignals - GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupMembershipsResponse: + Required. A list containing all policy names, in the new order. Each + name is in the format + `projects/{project}/firewallpolicies/{firewallpolicy}`. + type: array + items: + type: string + GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesResponse: + id: GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesResponse + description: The reorder firewall policies response message. + type: object + properties: {} + GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupsResponse: + id: GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupsResponse + description: The response to a `ListRelatedAccountGroups` call. + type: object properties: + relatedAccountGroups: + description: The groups of related accounts listed by the query. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1RelatedAccountGroup nextPageToken: - type: string description: >- A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + type: string + GoogleCloudRecaptchaenterpriseV1RelatedAccountGroup: + id: GoogleCloudRecaptchaenterpriseV1RelatedAccountGroup + description: A group of related accounts. + type: object + properties: + name: + description: >- + Required. Identifier. The resource name for the related account + group in the format + `projects/{project}/relatedaccountgroups/{related_account_group}`. + type: string + GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupMembershipsResponse: + id: >- + GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupMembershipsResponse + description: The response to a `ListRelatedAccountGroupMemberships` call. + type: object + properties: relatedAccountGroupMemberships: + description: The memberships listed by the query. + type: array items: $ref: >- #/components/schemas/GoogleCloudRecaptchaenterpriseV1RelatedAccountGroupMembership - type: array - description: The memberships listed by the query. + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + GoogleCloudRecaptchaenterpriseV1RelatedAccountGroupMembership: + id: GoogleCloudRecaptchaenterpriseV1RelatedAccountGroupMembership + description: A membership in a group of related accounts. type: object - id: >- - GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupMembershipsResponse - description: The response to a `ListRelatedAccountGroupMemberships` call. - GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest: - id: GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest properties: - transactionEvent: + name: description: >- - Optional. If the assessment is part of a payment transaction, - provide details on payment lifecycle events that occur in the - transaction. - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionEvent + Required. Identifier. The resource name for this membership in the + format + `projects/{project}/relatedaccountgroups/{relatedaccountgroup}/memberships/{membership}`. + type: string accountId: description: >- - Optional. A stable account identifier to apply to the assessment. - This is an alternative to setting `account_id` in - `CreateAssessment`, for example when a stable account identifier is - not yet known in the initial request. + The unique stable account identifier of the member. The identifier + corresponds to an `account_id` provided in a previous + `CreateAssessment` or `AnnotateAssessment` call. type: string hashedAccountId: description: >- - Optional. A stable hashed account identifier to apply to the - assessment. This is an alternative to setting `hashed_account_id` in - `CreateAssessment`, for example when a stable account identifier is - not yet known in the initial request. + Deprecated: use `account_id` instead. The unique stable hashed + account identifier of the member. The identifier corresponds to a + `hashed_account_id` provided in a previous `CreateAssessment` or + `AnnotateAssessment` call. + deprecated: true type: string format: byte - reasons: - type: array - items: - enum: - - REASON_UNSPECIFIED - - CHARGEBACK - - CHARGEBACK_FRAUD - - CHARGEBACK_DISPUTE - - REFUND - - REFUND_FRAUD - - TRANSACTION_ACCEPTED - - TRANSACTION_DECLINED - - PAYMENT_HEURISTICS - - INITIATED_TWO_FACTOR - - PASSED_TWO_FACTOR - - FAILED_TWO_FACTOR - - CORRECT_PASSWORD - - INCORRECT_PASSWORD - - SOCIAL_SPAM - type: string - enumDescriptions: - - Default unspecified reason. - - >- - Indicates that the transaction had a chargeback issued with no - other details. When possible, specify the type by using - CHARGEBACK_FRAUD or CHARGEBACK_DISPUTE instead. - - >- - Indicates that the transaction had a chargeback issued related - to an alleged unauthorized transaction from the cardholder's - perspective (for example, the card number was stolen). - - >- - Indicates that the transaction had a chargeback issued related - to the cardholder having provided their card details but - allegedly not being satisfied with the purchase (for example, - misrepresentation, attempted cancellation). - - >- - Indicates that the completed payment transaction was refunded by - the seller. - - >- - Indicates that the completed payment transaction was determined - to be fraudulent by the seller, and was cancelled and refunded - as a result. - - >- - Indicates that the payment transaction was accepted, and the - user was charged. - - >- - Indicates that the payment transaction was declined, for example - due to invalid card details. - - >- - Indicates the transaction associated with the assessment is - suspected of being fraudulent based on the payment method, - billing details, shipping address or other transaction - information. - - >- - Indicates that the user was served a 2FA challenge. An old - assessment with `ENUM_VALUES.INITIATED_TWO_FACTOR` reason that - has not been overwritten with `PASSED_TWO_FACTOR` is treated as - an abandoned 2FA flow. This is equivalent to - `FAILED_TWO_FACTOR`. - - Indicates that the user passed a 2FA challenge. - - Indicates that the user failed a 2FA challenge. - - Indicates the user provided the correct password. - - Indicates the user provided an incorrect password. - - >- - Indicates that the user sent unwanted and abusive messages to - other users of the platform, such as spam, scams, phishing, or - social engineering. - description: Optional. Reasons for the annotation that are assigned to the event. - annotation: - enumDeprecated: - - false - - false - - false - - true - - true - enum: - - ANNOTATION_UNSPECIFIED - - LEGITIMATE - - FRAUDULENT - - PASSWORD_CORRECT - - PASSWORD_INCORRECT - enumDescriptions: - - Default unspecified type. - - Provides information that the event turned out to be legitimate. - - Provides information that the event turned out to be fraudulent. - - >- - Provides information that the event was related to a login event - in which the user typed the correct password. Deprecated, prefer - indicating CORRECT_PASSWORD through the reasons field instead. - - >- - Provides information that the event was related to a login event - in which the user typed the incorrect password. Deprecated, prefer - indicating INCORRECT_PASSWORD through the reasons field instead. - type: string - description: >- - Optional. The annotation that is assigned to the Event. This field - can be left empty to provide reasons that apply to an event without - concluding whether the event is legitimate or fraudulent. - description: The request message to annotate an Assessment. - type: object - GoogleCloudRecaptchaenterpriseV1UserId: - id: GoogleCloudRecaptchaenterpriseV1UserId + GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsRequest: + id: >- + GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsRequest + description: The request message to search related account group memberships. type: object properties: - username: - type: string + accountId: description: >- - Optional. A unique username, if different from all the other - identifiers and `account_id` that are provided. Can be a unique - login handle or display name for a user. - email: + Optional. The unique stable account identifier used to search + connections. The identifier should correspond to an `account_id` + provided in a previous `CreateAssessment` or `AnnotateAssessment` + call. Either hashed_account_id or account_id must be set, but not + both. type: string - description: Optional. An email address. - phoneNumber: - description: Optional. A phone number. Should use the E.164 format. + hashedAccountId: + description: >- + Optional. Deprecated: use `account_id` instead. The unique stable + hashed account identifier used to search connections. The identifier + should correspond to a `hashed_account_id` provided in a previous + `CreateAssessment` or `AnnotateAssessment` call. Either + hashed_account_id or account_id must be set, but not both. + deprecated: true type: string - description: An identifier associated with a user. - GoogleCloudRecaptchaenterpriseV1AddIpOverrideRequest: - id: GoogleCloudRecaptchaenterpriseV1AddIpOverrideRequest - properties: - ipOverrideData: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1IpOverrideData' - description: Required. IP override added to the key. - description: The AddIpOverride request message. + format: byte + pageSize: + description: >- + Optional. The maximum number of groups to return. The service might + return fewer than this value. If unspecified, at most 50 groups are + returned. The maximum value is 1000; values above 1000 are coerced + to 1000. + type: integer + format: int32 + pageToken: + description: >- + Optional. A page token, received from a previous + `SearchRelatedAccountGroupMemberships` call. Provide this to + retrieve the subsequent page. When paginating, all other parameters + provided to `SearchRelatedAccountGroupMemberships` must match the + call that provided the page token. + type: string + GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsResponse: + id: >- + GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsResponse + description: The response to a `SearchRelatedAccountGroupMemberships` call. type: object + properties: + relatedAccountGroupMemberships: + description: The queried memberships. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1RelatedAccountGroupMembership + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string parameters: - prettyPrint: - description: Returns response with indentations and line breaks. + access_token: + description: OAuth access token. in: query - name: prettyPrint + name: access_token schema: - type: boolean + type: string alt: description: Data format for response. in: query @@ -2063,43 +2198,16 @@ components: - json - media - proto - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - type: string - _.xgafv: - description: V1 error format. - in: query - name: $.xgafv - schema: - type: string - enum: - - '1' - - '2' - access_token: - description: OAuth access token. - in: query - name: access_token - schema: - type: string callback: description: JSONP in: query name: callback schema: type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: upload_protocol + name: fields schema: type: string key: @@ -2111,6 +2219,18 @@ components: 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 @@ -2120,12 +2240,27 @@ components: name: quotaUser schema: type: string - oauth_token: - description: OAuth 2.0 token for the current user. + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: oauth_token + name: upload_protocol + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv schema: type: string + enum: + - '1' + - '2' x-stackQL-resources: assessments: id: google.recaptchaenterprise.assessments @@ -2157,40 +2292,40 @@ components: name: keys title: Keys methods: - get: + create: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}/get' + $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys/post' response: mediaType: application/json openAPIDocKey: '200' - patch: + list: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}/patch' + $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys/get' response: mediaType: application/json openAPIDocKey: '200' - delete: + objectKey: $.keys + get: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}/delete' + $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}/get' response: mediaType: application/json openAPIDocKey: '200' - migrate: + patch: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}:migrate/post' + $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}/patch' response: mediaType: application/json openAPIDocKey: '200' - list: + delete: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys/get' + $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}/delete' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.keys - create: + migrate: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys/post' + $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}:migrate/post' response: mediaType: application/json openAPIDocKey: '200' @@ -2225,27 +2360,6 @@ components: update: [] replace: [] delete: [] - keys_ip_overrides: - id: google.recaptchaenterprise.keys_ip_overrides - name: keys_ip_overrides - title: Keys_ip_overrides - methods: - list_ip_overrides: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}:listIpOverrides/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.ipOverrides - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/keys_ip_overrides/methods/list_ip_overrides - insert: [] - update: [] - replace: [] - delete: [] keys_ip_override: id: google.recaptchaenterprise.keys_ip_override name: keys_ip_override @@ -2275,38 +2389,41 @@ components: delete: - $ref: >- #/components/x-stackQL-resources/keys_ip_override/methods/remove_ip_override - keys_metrics: - id: google.recaptchaenterprise.keys_metrics - name: keys_metrics - title: Keys_metrics + keys_ip_overrides: + id: google.recaptchaenterprise.keys_ip_overrides + name: keys_ip_overrides + title: Keys_ip_overrides methods: - get_metrics: + list_ip_overrides: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}~1metrics/get' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}:listIpOverrides/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.ipOverrides sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/keys_metrics/methods/get_metrics' + - $ref: >- + #/components/x-stackQL-resources/keys_ip_overrides/methods/list_ip_overrides insert: [] update: [] replace: [] delete: [] - relatedaccountgroupmemberships: - id: google.recaptchaenterprise.relatedaccountgroupmemberships - name: relatedaccountgroupmemberships - title: Relatedaccountgroupmemberships + keys_metrics: + id: google.recaptchaenterprise.keys_metrics + name: keys_metrics + title: Keys_metrics methods: - search: + get_metrics: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1relatedaccountgroupmemberships:search/post + $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}~1metrics/get' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: '#/components/x-stackQL-resources/keys_metrics/methods/get_metrics' insert: [] update: [] replace: [] @@ -2316,23 +2433,23 @@ components: name: firewallpolicies title: Firewallpolicies methods: - list: + create: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1firewallpolicies/get' + $ref: '#/paths/~1v1~1projects~1{projectsId}~1firewallpolicies/post' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.firewallPolicies - create: + list: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1firewallpolicies/post' + $ref: '#/paths/~1v1~1projects~1{projectsId}~1firewallpolicies/get' response: mediaType: application/json openAPIDocKey: '200' - delete: + objectKey: $.firewallPolicies + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1firewallpolicies~1{firewallpoliciesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1firewallpolicies~1{firewallpoliciesId}/get response: mediaType: application/json openAPIDocKey: '200' @@ -2343,10 +2460,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' - get: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1firewallpolicies~1{firewallpoliciesId}/get + #/paths/~1v1~1projects~1{projectsId}~1firewallpolicies~1{firewallpoliciesId}/delete response: mediaType: application/json openAPIDocKey: '200' @@ -2407,20 +2524,38 @@ components: update: [] replace: [] delete: [] + relatedaccountgroupmemberships: + id: google.recaptchaenterprise.relatedaccountgroupmemberships + name: relatedaccountgroupmemberships + title: Relatedaccountgroupmemberships + methods: + search: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1relatedaccountgroupmemberships:search/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] paths: /v1/projects/{projectsId}/assessments: parameters: &ref_1 - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' post: description: Creates an Assessment of the likelihood an event is legitimate. operationId: recaptchaenterprise.projects.assessments.create @@ -2486,37 +2621,11 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/keys/{keysId}: + /v1/projects/{projectsId}/keys: parameters: *ref_1 - get: - description: Returns the specified key. - operationId: recaptchaenterprise.projects.keys.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Key' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: keysId - required: true - schema: - type: string - patch: - description: Updates the specified key. - operationId: recaptchaenterprise.projects.keys.patch + post: + description: Creates a new reCAPTCHA Enterprise key. + operationId: recaptchaenterprise.projects.keys.create requestBody: content: application/json: @@ -2540,19 +2649,9 @@ paths: required: true schema: type: string - - in: path - name: keysId - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: - description: Deletes the specified key. - operationId: recaptchaenterprise.projects.keys.delete + get: + description: Returns the list of all keys that belong to a project. + operationId: recaptchaenterprise.projects.keys.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2564,16 +2663,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1ListKeysResponse parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: keysId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string /v1/projects/{projectsId}/keys/{keysId}:retrieveLegacySecretKey: @@ -2608,11 +2712,11 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/keys/{keysId}:listIpOverrides: + /v1/projects/{projectsId}/keys/{keysId}: parameters: *ref_1 get: - description: Lists all IP overrides for a key. - operationId: recaptchaenterprise.projects.keys.listIpOverrides + description: Returns the specified key. + operationId: recaptchaenterprise.projects.keys.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2624,8 +2728,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1ListIpOverridesResponse + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Key' parameters: - in: path name: projectsId @@ -2637,30 +2740,14 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/keys/{keysId}:addIpOverride: - parameters: *ref_1 - post: - description: >- - Adds an IP override to a key. The following restrictions hold: * The - maximum number of IP overrides per key is 100. * For any conflict (such - as IP already exists or IP part of an existing IP range), an error is - returned. - operationId: recaptchaenterprise.projects.keys.addIpOverride + patch: + description: Updates the specified key. + operationId: recaptchaenterprise.projects.keys.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1AddIpOverrideRequest + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Key' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2672,8 +2759,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1AddIpOverrideResponse + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Key' parameters: - in: path name: projectsId @@ -2685,13 +2771,14 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/keys/{keysId}/metrics: - parameters: *ref_1 - get: - description: >- - Get some aggregated metrics for a Key. This data can be used to build - dashboards. - operationId: recaptchaenterprise.projects.keys.getMetrics + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes the specified key. + operationId: recaptchaenterprise.projects.keys.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2703,7 +2790,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Metrics' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -2754,6 +2841,45 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/keys/{keysId}:addIpOverride: + parameters: *ref_1 + post: + description: >- + Adds an IP override to a key. The following restrictions hold: * The + maximum number of IP overrides per key is 1000. * For any conflict (such + as IP already exists or IP part of an existing IP range), an error is + returned. + operationId: recaptchaenterprise.projects.keys.addIpOverride + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1AddIpOverrideRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1AddIpOverrideResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: keysId + required: true + schema: + type: string /v1/projects/{projectsId}/keys/{keysId}:removeIpOverride: parameters: *ref_1 post: @@ -2793,11 +2919,11 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/keys: + /v1/projects/{projectsId}/keys/{keysId}:listIpOverrides: parameters: *ref_1 get: - description: Returns the list of all keys that belong to a project. - operationId: recaptchaenterprise.projects.keys.list + description: Lists all IP overrides for a key. + operationId: recaptchaenterprise.projects.keys.listIpOverrides security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2810,13 +2936,18 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1ListKeysResponse + #/components/schemas/GoogleCloudRecaptchaenterpriseV1ListIpOverridesResponse parameters: - in: path name: projectsId required: true schema: type: string + - in: path + name: keysId + required: true + schema: + type: string - in: query name: pageSize schema: @@ -2826,14 +2957,13 @@ paths: name: pageToken schema: type: string - post: - description: Creates a new reCAPTCHA Enterprise key. - operationId: recaptchaenterprise.projects.keys.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Key' + /v1/projects/{projectsId}/keys/{keysId}/metrics: + parameters: *ref_1 + get: + description: >- + Get some aggregated metrics for a Key. This data can be used to build + dashboards. + operationId: recaptchaenterprise.projects.keys.getMetrics security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2845,24 +2975,32 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Key' + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Metrics' parameters: - in: path name: projectsId required: true schema: type: string - /v1/projects/{projectsId}/relatedaccountgroupmemberships:search: + - in: path + name: keysId + required: true + schema: + type: string + /v1/projects/{projectsId}/firewallpolicies: parameters: *ref_1 post: - description: Search group memberships related to a given account. - operationId: recaptchaenterprise.projects.relatedaccountgroupmemberships.search + description: >- + Creates a new FirewallPolicy, specifying conditions at which reCAPTCHA + Enterprise actions can be executed. A project may have a maximum of 1000 + policies. + operationId: recaptchaenterprise.projects.firewallpolicies.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsRequest + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2875,15 +3013,13 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsResponse + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy parameters: - in: path name: projectsId required: true schema: type: string - /v1/projects/{projectsId}/firewallpolicies: - parameters: *ref_1 get: description: Returns the list of all firewall policies that belong to a project. operationId: recaptchaenterprise.projects.firewallpolicies.list @@ -2915,42 +3051,11 @@ paths: name: pageToken schema: type: string - post: - description: >- - Creates a new FirewallPolicy, specifying conditions at which reCAPTCHA - Enterprise actions can be executed. A project may have a maximum of 1000 - policies. - operationId: recaptchaenterprise.projects.firewallpolicies.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy - parameters: - - in: path - name: projectsId - required: true - schema: - type: string /v1/projects/{projectsId}/firewallpolicies/{firewallpoliciesId}: parameters: *ref_1 - delete: - description: Deletes the specified firewall policy. - operationId: recaptchaenterprise.projects.firewallpolicies.delete + get: + description: Returns the specified firewall policy. + operationId: recaptchaenterprise.projects.firewallpolicies.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2962,7 +3067,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy parameters: - in: path name: projectsId @@ -3012,9 +3118,9 @@ paths: schema: type: string format: google-fieldmask - get: - description: Returns the specified firewall policy. - operationId: recaptchaenterprise.projects.firewallpolicies.get + delete: + description: Deletes the specified firewall policy. + operationId: recaptchaenterprise.projects.firewallpolicies.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3026,8 +3132,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -3131,12 +3236,42 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - in: query name: pageSize schema: type: integer format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/relatedaccountgroupmemberships:search: + parameters: *ref_1 + post: + description: Search group memberships related to a given account. + operationId: recaptchaenterprise.projects.relatedaccountgroupmemberships.search + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/recommendationengine.yaml b/providers/src/googleapis.com/v00.00.00000/services/recommendationengine.yaml index f0400a0e..f578a2de 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/recommendationengine.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/recommendationengine.yaml @@ -14,8 +14,8 @@ info: personalized recommendation systems without requiring a high level of expertise in machine learning, recommendation system, or Google Cloud. version: v1beta1 - x-discovery-doc-revision: '20241024' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250717' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/recommendations-ai/docs servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/recommender.yaml b/providers/src/googleapis.com/v00.00.00000/services/recommender.yaml index 97bfaccd..fdc583b0 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/recommender.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/recommender.yaml @@ -7,8 +7,8 @@ info: title: Recommender API description: '' version: v1 - x-discovery-doc-revision: '20241027' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250824' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/recommender/docs/ servers: @@ -34,292 +34,71 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudRecommenderV1InsightTypeConfig: - properties: - etag: - type: string - description: >- - Fingerprint of the InsightTypeConfig. Provides optimistic locking - when updating. - annotations: - description: >- - Allows clients to store small amounts of arbitrary data. Annotations - must follow the Kubernetes syntax. The total size of all keys and - values combined is limited to 256k. Key can have 2 segments: prefix - (optional) and name (required), separated by a slash (/). Prefix - must be a DNS subdomain. Name must be 63 characters or less, begin - and end with alphanumerics, with dashes (-), underscores (_), dots - (.), and alphanumerics between. - type: object - additionalProperties: - type: string - revisionId: - description: >- - Output only. Immutable. The revision ID of the config. A new - revision is committed whenever the config is changed in any way. The - format is an 8-character hexadecimal string. - readOnly: true - type: string - updateTime: - type: string - description: Last time when the config was updated. - format: google-datetime - name: - type: string - description: >- - Identifier. Name of insight type config. Eg, - projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config - displayName: - description: >- - A user-settable field to provide a human-readable name to be used in - user interfaces. - type: string - insightTypeGenerationConfig: - description: >- - InsightTypeGenerationConfig which configures the generation of - insights for this insight type. - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1InsightTypeGenerationConfig - description: Configuration for an InsightType. - id: GoogleCloudRecommenderV1InsightTypeConfig + GoogleCloudRecommenderV1ListInsightsResponse: + id: GoogleCloudRecommenderV1ListInsightsResponse + description: Response to the `ListInsights` method. type: object - GoogleCloudRecommenderV1CostProjection: properties: - costInLocalCurrency: - $ref: '#/components/schemas/GoogleTypeMoney' - description: >- - The approximate cost savings in the billing account's local - currency. - cost: + insights: + description: The set of insights for the `parent` resource. + type: array + items: + $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' + nextPageToken: description: >- - An approximate projection on amount saved or amount incurred. - Negative cost units indicate cost savings and positive cost units - indicate increase. See google.type.Money documentation for - positive/negative units. A user's permissions may affect whether the - cost is computed using list prices or custom contract prices. - $ref: '#/components/schemas/GoogleTypeMoney' - duration: + A token that can be used to request the next page of results. This + field is empty if there are no additional results. type: string - description: Duration for which this cost applies. - format: google-duration + GoogleCloudRecommenderV1Insight: + id: GoogleCloudRecommenderV1Insight description: >- - Contains metadata about how much money a recommendation can save or - incur. + An insight along with the information used to derive the insight. The + insight may have associated recommendations as well. type: object - id: GoogleCloudRecommenderV1CostProjection - GoogleCloudRecommenderV1InsightStateInfo: properties: - state: - description: Insight state. - enum: - - STATE_UNSPECIFIED - - ACTIVE - - ACCEPTED - - DISMISSED - enumDescriptions: - - Unspecified state. - - >- - Insight is active. Content for ACTIVE insights can be updated by - Google. ACTIVE insights can be marked DISMISSED OR ACCEPTED. - - >- - Some action has been taken based on this insight. Insights become - accepted when a recommendation derived from the insight has been - marked CLAIMED, SUCCEEDED, or FAILED. ACTIVE insights can also be - marked ACCEPTED explicitly. Content for ACCEPTED insights is - immutable. ACCEPTED insights can only be marked ACCEPTED (which - may update state metadata). - - >- - Insight is dismissed. Content for DISMISSED insights can be - updated by Google. DISMISSED insights can be marked as ACTIVE. + name: + description: Identifier. Name of the insight. type: string - stateMetadata: - type: object - description: >- - A map of metadata for the state, provided by user or automations - systems. - additionalProperties: - type: string - type: object - id: GoogleCloudRecommenderV1InsightStateInfo - description: Information related to insight state. - GoogleCloudRecommenderV1RecommendationContent: - id: GoogleCloudRecommenderV1RecommendationContent - description: Contains what resources are changing and how they are changing. - properties: - operationGroups: + description: description: >- - Operations to one or more Google Cloud resources grouped in such a - way that, all operations within one group are expected to be - performed atomically and in an order. - type: array - items: - $ref: '#/components/schemas/GoogleCloudRecommenderV1OperationGroup' - overview: - type: object - additionalProperties: - description: Properties of the object. - type: any - description: Condensed overview information about the recommendation. - type: object - GoogleCloudRecommenderV1ReliabilityProjection: - id: GoogleCloudRecommenderV1ReliabilityProjection - type: object - description: Contains information on the impact of a reliability recommendation. - properties: - details: - type: object - additionalProperties: - description: Properties of the object. - type: any - description: Per-recommender projection. - risks: - description: Reliability risks mitigated by this recommendation. + Free-form human readable summary in English. The maximum length is + 500 characters. + type: string + targetResources: + description: Fully qualified resource names that this insight is targeting. type: array items: type: string - enum: - - RISK_TYPE_UNSPECIFIED - - SERVICE_DISRUPTION - - DATA_LOSS - - ACCESS_DENY - enumDescriptions: - - Default unspecified risk. Don't use directly. - - Potential service downtime. - - Potential data loss. - - >- - Potential access denial. The service is still up but some or all - clients can't access it. - GoogleCloudRecommenderV1Operation: - properties: - resourceType: - description: >- - Type of GCP resource being modified/tested. This field is always - populated. Example: cloudresourcemanager.googleapis.com/Project, - compute.googleapis.com/Instance - type: string - action: - type: string - description: >- - Type of this operation. Contains one of 'add', 'remove', 'replace', - 'move', 'copy', 'test' and custom operations. This field is - case-insensitive and always populated. - value: - type: any + insightSubtype: description: >- - Value for the `path` field. Will be set for actions:'add'/'replace'. - Maybe set for action: 'test'. Either this or `value_matcher` will be - set for 'test' operation. An exact match must be performed. - sourcePath: + Insight subtype. Insight content schema will be stable for a given + subtype. type: string + content: description: >- - Can be set with action 'copy' or 'move' to indicate the source field - within resource or source_resource, ignored if provided for other - operation types. - pathFilters: + A struct of custom fields to explain the insight. Example: + "grantedPermissionsCount": "1000" type: object - description: >- - Set of filters to apply if `path` refers to array elements or nested - array elements in order to narrow down to a single unique element - that is being tested/modified. This is intended to be an exact match - per filter. To perform advanced matching, use path_value_matchers. * - Example: ``` { "/versions/*/name" : "it-123" - "/versions/*/targetSize/percent": 20 } ``` * Example: ``` { - "/bindings/*/role": "roles/owner" "/bindings/*/condition" : null } - ``` * Example: ``` { "/bindings/*/role": "roles/owner" - "/bindings/*/members/*" : ["x@example.com", "y@example.com"] } ``` - When both path_filters and path_value_matchers are set, an implicit - AND must be performed. additionalProperties: type: any - path: - type: string - description: >- - Path to the target field being operated on. If the operation is at - the resource level, then path should be "/". This field is always - populated. - sourceResource: - type: string - description: >- - Can be set with action 'copy' to copy resource configuration across - different resources of the same type. Example: A resource clone can - be done via action = 'copy', path = "/", from = "/", source_resource - = and resource_name = . This field is empty for all other values of - `action`. - pathValueMatchers: - type: object - additionalProperties: - $ref: '#/components/schemas/GoogleCloudRecommenderV1ValueMatcher' - description: >- - Similar to path_filters, this contains set of filters to apply if - `path` field refers to array elements. This is meant to support - value matching beyond exact match. To perform exact match, use - path_filters. When both path_filters and path_value_matchers are - set, an implicit AND must be performed. - valueMatcher: - description: >- - Can be set for action 'test' for advanced matching for the value of - 'path' field. Either this or `value` will be set for 'test' - operation. - $ref: '#/components/schemas/GoogleCloudRecommenderV1ValueMatcher' - resource: - type: string - description: >- - Contains the fully qualified resource name. This field is always - populated. ex: //cloudresourcemanager.googleapis.com/projects/foo. - description: >- - Contains an operation for a resource loosely based on the JSON-PATCH - format with support for: * Custom filters for describing partial array - patch. * Extended path values for describing nested arrays. * Custom - fields for describing the resource for which the operation is being - described. * Allows extension to custom operations not natively - supported by RFC6902. See https://tools.ietf.org/html/rfc6902 for - details on the original RFC. - id: GoogleCloudRecommenderV1Operation - type: object - GoogleCloudRecommenderV1InsightTypeGenerationConfig: - properties: - params: - type: object - additionalProperties: description: Properties of the object. - type: any - description: >- - Parameters for this InsightTypeGenerationConfig. These configs can - be used by or are applied to all subtypes. - id: GoogleCloudRecommenderV1InsightTypeGenerationConfig - type: object - description: >- - A configuration to customize the generation of insights. Eg, customizing - the lookback period considered when generating a insight. - GoogleCloudRecommenderV1Insight: - type: object - description: >- - An insight along with the information used to derive the insight. The - insight may have associated recommendations as well. - properties: - observationPeriod: + lastRefreshTime: + description: Timestamp of the latest data used to generate the insight. type: string - format: google-duration + format: google-datetime + observationPeriod: description: >- Observation period that led to the insight. The source data used to generate the insight ends at last_refresh_time and begins at (last_refresh_time - observation_period). - insightSubtype: type: string - description: >- - Insight subtype. Insight content schema will be stable for a given - subtype. + format: google-duration + stateInfo: + description: Information state and metadata. + $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightStateInfo' category: - type: string description: Category being targeted by the insight. - enum: - - CATEGORY_UNSPECIFIED - - COST - - SECURITY - - PERFORMANCE - - MANAGEABILITY - - SUSTAINABILITY - - RELIABILITY + type: string enumDescriptions: - Unspecified category. - The insight is related to cost. @@ -328,157 +107,131 @@ components: - This insight is related to manageability. - The insight is related to sustainability. - This insight is related to reliability. - description: - type: string - description: >- - Free-form human readable summary in English. The maximum length is - 500 characters. - etag: - description: >- - Fingerprint of the Insight. Provides optimistic locking when - updating states. - type: string - targetResources: - items: - type: string - type: array - description: Fully qualified resource names that this insight is targeting. + enum: + - CATEGORY_UNSPECIFIED + - COST + - SECURITY + - PERFORMANCE + - MANAGEABILITY + - SUSTAINABILITY + - RELIABILITY severity: + description: Insight's severity. + type: string + enumDescriptions: + - Insight has unspecified severity. + - Insight has low severity. + - Insight has medium severity. + - Insight has high severity. + - Insight has critical severity. enum: - SEVERITY_UNSPECIFIED - LOW - MEDIUM - HIGH - CRITICAL + etag: + description: >- + Fingerprint of the Insight. Provides optimistic locking when + updating states. + type: string + associatedRecommendations: + description: Recommendations derived from this insight. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1InsightRecommendationReference + GoogleCloudRecommenderV1InsightStateInfo: + id: GoogleCloudRecommenderV1InsightStateInfo + description: Information related to insight state. + type: object + properties: + state: + description: Insight state. type: string - description: Insight's severity. enumDescriptions: - - Insight has unspecified severity. - - Insight has low severity. - - Insight has medium severity. - - Insight has high severity. - - Insight has critical severity. - stateInfo: - description: Information state and metadata. - $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightStateInfo' - content: - type: object + - Unspecified state. + - >- + Insight is active. Content for ACTIVE insights can be updated by + Google. ACTIVE insights can be marked DISMISSED OR ACCEPTED. + - >- + Some action has been taken based on this insight. Insights become + accepted when a recommendation derived from the insight has been + marked CLAIMED, SUCCEEDED, or FAILED. ACTIVE insights can also be + marked ACCEPTED explicitly. Content for ACCEPTED insights is + immutable. ACCEPTED insights can only be marked ACCEPTED (which + may update state metadata). + - >- + Insight is dismissed. Content for DISMISSED insights can be + updated by Google. DISMISSED insights can be marked as ACTIVE. + enum: + - STATE_UNSPECIFIED + - ACTIVE + - ACCEPTED + - DISMISSED + stateMetadata: description: >- - A struct of custom fields to explain the insight. Example: - "grantedPermissionsCount": "1000" + A map of metadata for the state, provided by user or automations + systems. + type: object additionalProperties: - description: Properties of the object. - type: any - associatedRecommendations: - description: Recommendations derived from this insight. - items: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1InsightRecommendationReference - type: array - name: - type: string - description: Identifier. Name of the insight. - lastRefreshTime: - type: string - format: google-datetime - description: Timestamp of the latest data used to generate the insight. - id: GoogleCloudRecommenderV1Insight + type: string GoogleCloudRecommenderV1InsightRecommendationReference: + id: GoogleCloudRecommenderV1InsightRecommendationReference description: Reference to an associated recommendation. + type: object properties: recommendation: - type: string description: >- Recommendation resource name, e.g. projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/recommendations/[RECOMMENDATION_ID] + type: string + GoogleCloudRecommenderV1MarkInsightAcceptedRequest: + id: GoogleCloudRecommenderV1MarkInsightAcceptedRequest + description: Request for the `MarkInsightAccepted` method. type: object - id: GoogleCloudRecommenderV1InsightRecommendationReference - GoogleCloudRecommenderV1RecommenderGenerationConfig: - id: GoogleCloudRecommenderV1RecommenderGenerationConfig - description: >- - A Configuration to customize the generation of recommendations. Eg, - customizing the lookback period considered when generating a - recommendation. - type: object - properties: - params: - type: object - description: >- - Parameters for this RecommenderGenerationConfig. These configs can - be used by or are applied to all subtypes. - additionalProperties: - description: Properties of the object. - type: any - GoogleCloudRecommenderV1MarkRecommendationSucceededRequest: properties: - etag: - type: string - description: >- - Required. Fingerprint of the Recommendation. Provides optimistic - locking. stateMetadata: description: >- - State properties to include with this state. Overwrites any existing - `state_metadata`. Keys must match the regex `/^a-z0-9{0,62}$/`. - Values must match the regex `/^[a-zA-Z0-9_./-]{0,255}$/`. + Optional. State properties user wish to include with this state. + Full replace of the current state_metadata. + type: object additionalProperties: type: string - type: object - description: Request for the `MarkRecommendationSucceeded` Method. - id: GoogleCloudRecommenderV1MarkRecommendationSucceededRequest - type: object - GoogleCloudRecommenderV1MarkRecommendationDismissedRequest: - type: object - properties: etag: - description: Fingerprint of the Recommendation. Provides optimistic locking. + description: Required. Fingerprint of the Insight. Provides optimistic locking. type: string - id: GoogleCloudRecommenderV1MarkRecommendationDismissedRequest - description: Request for the `MarkRecommendationDismissed` Method. - GoogleCloudRecommenderV1ValueMatcher: - description: Contains various matching options for values for a GCP resource field. + GoogleCloudRecommenderV1ListRecommendationsResponse: + id: GoogleCloudRecommenderV1ListRecommendationsResponse + description: Response to the `ListRecommendations` method. type: object - id: GoogleCloudRecommenderV1ValueMatcher properties: - matchesPattern: + recommendations: + description: The set of recommendations for the `parent` resource. + type: array + items: + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + nextPageToken: description: >- - To be used for full regex matching. The regular expression is using - the Google RE2 syntax (https://github.com/google/re2/wiki/Syntax), - so to be used with RE2::FullMatch + A token that can be used to request the next page of results. This + field is empty if there are no additional results. type: string GoogleCloudRecommenderV1Recommendation: + id: GoogleCloudRecommenderV1Recommendation + description: >- + A recommendation along with a suggested action. E.g., a rightsizing + recommendation for an underutilized VM, IAM role recommendations, etc + type: object properties: - content: - description: >- - Content of the recommendation describing recommended changes to - resources. - $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommendationContent' - associatedInsights: - description: Insights that led to this recommendation. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1RecommendationInsightReference - stateInfo: - description: Information for state. Contains state and metadata. - $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommendationStateInfo' - additionalImpact: - items: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Impact' - description: >- - Optional set of additional impact that this recommendation may have - when trying to optimize for the primary category. These may be - positive or negative. - type: array - targetResources: + name: + description: Identifier. Name of recommendation. + type: string + description: description: >- - Fully qualified resource names that this recommendation is - targeting. - type: array - items: - type: string - recommenderSubtype: + Free-form human readable summary in English. The maximum length is + 500 characters. type: string + recommenderSubtype: description: >- Contains an identifier for a subtype of recommendations produced for the same recommender. Subtype is a function of content and impact, @@ -488,69 +241,82 @@ components: Recommender. Examples: For recommender = "google.iam.policy.Recommender", recommender_subtype can be one of "REMOVE_ROLE"/"REPLACE_ROLE" - description: - description: >- - Free-form human readable summary in English. The maximum length is - 500 characters. - type: string - name: type: string - description: Identifier. Name of recommendation. lastRefreshTime: - type: string - format: google-datetime description: >- Last time this recommendation was refreshed by the system that created it in the first place. - xorGroupId: - description: >- - Corresponds to a mutually exclusive group ID within a recommender. A - non-empty ID indicates that the recommendation belongs to a mutually - exclusive group. This means that only one recommendation within the - group is suggested to be applied. - type: string - etag: type: string + format: google-datetime + primaryImpact: description: >- - Fingerprint of the Recommendation. Provides optimistic locking when - updating states. + The primary impact that this recommendation can have while trying to + optimize for one category. + $ref: '#/components/schemas/GoogleCloudRecommenderV1Impact' + additionalImpact: + description: >- + Optional set of additional impact that this recommendation may have + when trying to optimize for the primary category. These may be + positive or negative. + type: array + items: + $ref: '#/components/schemas/GoogleCloudRecommenderV1Impact' priority: - enum: - - PRIORITY_UNSPECIFIED - - P4 - - P3 - - P2 - - P1 description: Recommendation's priority. + type: string enumDescriptions: - Recommendation has unspecified priority. - Recommendation has P4 priority (lowest priority). - Recommendation has P3 priority (second lowest priority). - Recommendation has P2 priority (second highest priority). - Recommendation has P1 priority (highest priority). + enum: + - PRIORITY_UNSPECIFIED + - P4 + - P3 + - P2 + - P1 + content: + description: >- + Content of the recommendation describing recommended changes to + resources. + $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommendationContent' + stateInfo: + description: Information for state. Contains state and metadata. + $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommendationStateInfo' + etag: + description: >- + Fingerprint of the Recommendation. Provides optimistic locking when + updating states. type: string - primaryImpact: + associatedInsights: + description: Insights that led to this recommendation. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1RecommendationInsightReference + xorGroupId: description: >- - The primary impact that this recommendation can have while trying to - optimize for one category. - $ref: '#/components/schemas/GoogleCloudRecommenderV1Impact' - type: object - description: >- - A recommendation along with a suggested action. E.g., a rightsizing - recommendation for an underutilized VM, IAM role recommendations, etc - id: GoogleCloudRecommenderV1Recommendation + Corresponds to a mutually exclusive group ID within a recommender. A + non-empty ID indicates that the recommendation belongs to a mutually + exclusive group. This means that only one recommendation within the + group is suggested to be applied. + type: string + targetResources: + description: >- + Fully qualified resource names that this recommendation is + targeting. + type: array + items: + type: string GoogleCloudRecommenderV1Impact: + id: GoogleCloudRecommenderV1Impact + description: Contains the impact a recommendation can have for a given category. + type: object properties: category: + description: Category that is being targeted. type: string - enum: - - CATEGORY_UNSPECIFIED - - COST - - SECURITY - - PERFORMANCE - - MANAGEABILITY - - SUSTAINABILITY - - RELIABILITY enumDescriptions: - Default unspecified category. Don't use directly. - Indicates a potential increase or decrease in cost. @@ -559,87 +325,77 @@ components: - Indicates a potential increase or decrease in manageability. - Indicates a potential increase or decrease in sustainability. - Indicates a potential increase or decrease in reliability. - description: Category that is being targeted. + enum: + - CATEGORY_UNSPECIFIED + - COST + - SECURITY + - PERFORMANCE + - MANAGEABILITY + - SUSTAINABILITY + - RELIABILITY + costProjection: + description: Use with CategoryType.COST + $ref: '#/components/schemas/GoogleCloudRecommenderV1CostProjection' securityProjection: description: Use with CategoryType.SECURITY $ref: '#/components/schemas/GoogleCloudRecommenderV1SecurityProjection' - impactComponents: - items: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Impact' - type: array - description: >- - If populated, the impact contains multiple components. In this case, - the top-level impact contains aggregated values and each component - contains per-service details. - reliabilityProjection: - $ref: '#/components/schemas/GoogleCloudRecommenderV1ReliabilityProjection' - description: Use with CategoryType.RELIABILITY sustainabilityProjection: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1SustainabilityProjection description: Use with CategoryType.SUSTAINABILITY - costProjection: - $ref: '#/components/schemas/GoogleCloudRecommenderV1CostProjection' - description: Use with CategoryType.COST + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1SustainabilityProjection + reliabilityProjection: + description: Use with CategoryType.RELIABILITY + $ref: '#/components/schemas/GoogleCloudRecommenderV1ReliabilityProjection' service: description: The service that this impact is associated with. type: string - type: object - description: Contains the impact a recommendation can have for a given category. - id: GoogleCloudRecommenderV1Impact - GoogleCloudRecommenderV1MarkInsightAcceptedRequest: - description: Request for the `MarkInsightAccepted` method. - id: GoogleCloudRecommenderV1MarkInsightAcceptedRequest - type: object - properties: - etag: - type: string - description: Required. Fingerprint of the Insight. Provides optimistic locking. - stateMetadata: - type: object + impactComponents: description: >- - Optional. State properties user wish to include with this state. - Full replace of the current state_metadata. - additionalProperties: - type: string - GoogleCloudRecommenderV1SustainabilityProjection: + If populated, the impact contains multiple components. In this case, + the top-level impact contains aggregated values and each component + contains per-service details. + type: array + items: + $ref: '#/components/schemas/GoogleCloudRecommenderV1Impact' + GoogleCloudRecommenderV1CostProjection: + id: GoogleCloudRecommenderV1CostProjection description: >- - Contains metadata about how much sustainability a recommendation can - save or incur. + Contains metadata about how much money a recommendation can save or + incur. type: object - id: GoogleCloudRecommenderV1SustainabilityProjection properties: - kgCO2e: + cost: description: >- - Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e - so that the name renders correctly in camelCase (kgCO2e). - format: double - type: number + An approximate projection on amount saved or amount incurred. + Negative cost units indicate cost savings and positive cost units + indicate increase. See google.type.Money documentation for + positive/negative units. A user's permissions may affect whether the + cost is computed using list prices or custom contract prices. + $ref: '#/components/schemas/GoogleTypeMoney' duration: - format: google-duration - type: string - description: Duration for which this sustainability applies. - GoogleCloudRecommenderV1RecommendationInsightReference: - id: GoogleCloudRecommenderV1RecommendationInsightReference - description: Reference to an associated insight. - properties: - insight: + description: Duration for which this cost applies. type: string + format: google-duration + costInLocalCurrency: description: >- - Insight resource name, e.g. - projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/insights/[INSIGHT_ID] - type: object + The approximate cost savings in the billing account's local + currency. + $ref: '#/components/schemas/GoogleTypeMoney' GoogleTypeMoney: id: GoogleTypeMoney description: Represents an amount of money with its currency type. type: object properties: currencyCode: - type: string description: The three-letter currency code defined in ISO 4217. + type: string + units: + description: >- + The whole units of the amount. For example if `currencyCode` is + `"USD"`, then 1 unit is one US dollar. + type: string + format: int64 nanos: - type: integer - format: int32 description: >- Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is @@ -647,74 +403,204 @@ components: `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. - units: - description: >- - The whole units of the amount. For example if `currencyCode` is - `"USD"`, then 1 unit is one US dollar. - type: string - format: int64 + type: integer + format: int32 GoogleCloudRecommenderV1SecurityProjection: + id: GoogleCloudRecommenderV1SecurityProjection + description: Contains various ways of describing the impact on Security. type: object properties: details: - additionalProperties: - type: any - description: Properties of the object. - type: object description: >- Additional security impact details that is provided by the recommender. - id: GoogleCloudRecommenderV1SecurityProjection - description: Contains various ways of describing the impact on Security. - GoogleCloudRecommenderV1ListRecommendationsResponse: - id: GoogleCloudRecommenderV1ListRecommendationsResponse + type: object + additionalProperties: + type: any + description: Properties of the object. + GoogleCloudRecommenderV1SustainabilityProjection: + id: GoogleCloudRecommenderV1SustainabilityProjection + description: >- + Contains metadata about how much sustainability a recommendation can + save or incur. type: object - description: Response to the `ListRecommendations` method. properties: - nextPageToken: + kgCO2e: description: >- - A token that can be used to request the next page of results. This - field is empty if there are no additional results. + Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e + so that the name renders correctly in camelCase (kgCO2e). + type: number + format: double + duration: + description: Duration for which this sustainability applies. type: string - recommendations: + format: google-duration + GoogleCloudRecommenderV1ReliabilityProjection: + id: GoogleCloudRecommenderV1ReliabilityProjection + description: Contains information on the impact of a reliability recommendation. + type: object + properties: + risks: + description: Reliability risks mitigated by this recommendation. type: array - description: The set of recommendations for the `parent` resource. items: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + type: string + enumDescriptions: + - Default unspecified risk. Don't use directly. + - Potential service downtime. + - Potential data loss. + - >- + Potential access denial. The service is still up but some or all + clients can't access it. + enum: + - RISK_TYPE_UNSPECIFIED + - SERVICE_DISRUPTION + - DATA_LOSS + - ACCESS_DENY + details: + description: Per-recommender projection. + type: object + additionalProperties: + type: any + description: Properties of the object. + GoogleCloudRecommenderV1RecommendationContent: + id: GoogleCloudRecommenderV1RecommendationContent + description: Contains what resources are changing and how they are changing. + type: object + properties: + operationGroups: + description: >- + Operations to one or more Google Cloud resources grouped in such a + way that, all operations within one group are expected to be + performed atomically and in an order. + type: array + items: + $ref: '#/components/schemas/GoogleCloudRecommenderV1OperationGroup' + overview: + description: Condensed overview information about the recommendation. + type: object + additionalProperties: + type: any + description: Properties of the object. GoogleCloudRecommenderV1OperationGroup: id: GoogleCloudRecommenderV1OperationGroup + description: Group of operations that need to be performed atomically. + type: object properties: operations: - type: array description: >- List of operations across one or more resources that belong to this group. Loosely based on RFC6902 and should be performed in the order they appear. + type: array items: $ref: '#/components/schemas/GoogleCloudRecommenderV1Operation' - description: Group of operations that need to be performed atomically. - type: object - GoogleCloudRecommenderV1MarkRecommendationFailedRequest: - id: GoogleCloudRecommenderV1MarkRecommendationFailedRequest + GoogleCloudRecommenderV1Operation: + id: GoogleCloudRecommenderV1Operation + description: >- + Contains an operation for a resource loosely based on the JSON-PATCH + format with support for: * Custom filters for describing partial array + patch. * Extended path values for describing nested arrays. * Custom + fields for describing the resource for which the operation is being + described. * Allows extension to custom operations not natively + supported by RFC6902. See https://tools.ietf.org/html/rfc6902 for + details on the original RFC. type: object - description: Request for the `MarkRecommendationFailed` Method. properties: - etag: + action: + description: >- + Type of this operation. Contains one of 'add', 'remove', 'replace', + 'move', 'copy', 'test' and custom operations. This field is + case-insensitive and always populated. type: string + resourceType: description: >- - Required. Fingerprint of the Recommendation. Provides optimistic - locking. - stateMetadata: + Type of GCP resource being modified/tested. This field is always + populated. Example: cloudresourcemanager.googleapis.com/Project, + compute.googleapis.com/Instance + type: string + resource: + description: >- + Contains the fully qualified resource name. This field is always + populated. ex: //cloudresourcemanager.googleapis.com/projects/foo. + type: string + path: + description: >- + Path to the target field being operated on. If the operation is at + the resource level, then path should be "/". This field is always + populated. + type: string + sourceResource: + description: >- + Can be set with action 'copy' to copy resource configuration across + different resources of the same type. Example: A resource clone can + be done via action = 'copy', path = "/", from = "/", source_resource + = and resource_name = . This field is empty for all other values of + `action`. + type: string + sourcePath: + description: >- + Can be set with action 'copy' or 'move' to indicate the source field + within resource or source_resource, ignored if provided for other + operation types. + type: string + value: + description: >- + Value for the `path` field. Will be set for actions:'add'/'replace'. + Maybe set for action: 'test'. Either this or `value_matcher` will be + set for 'test' operation. An exact match must be performed. + type: any + valueMatcher: + description: >- + Can be set for action 'test' for advanced matching for the value of + 'path' field. Either this or `value` will be set for 'test' + operation. + $ref: '#/components/schemas/GoogleCloudRecommenderV1ValueMatcher' + pathFilters: + description: >- + Set of filters to apply if `path` refers to array elements or nested + array elements in order to narrow down to a single unique element + that is being tested/modified. This is intended to be an exact match + per filter. To perform advanced matching, use path_value_matchers. * + Example: ``` { "/versions/*/name" : "it-123" + "/versions/*/targetSize/percent": 20 } ``` * Example: ``` { + "/bindings/*/role": "roles/owner" "/bindings/*/condition" : null } + ``` * Example: ``` { "/bindings/*/role": "roles/owner" + "/bindings/*/members/*" : ["x@example.com", "y@example.com"] } ``` + When both path_filters and path_value_matchers are set, an implicit + AND must be performed. + type: object + additionalProperties: + type: any + pathValueMatchers: + description: >- + Similar to path_filters, this contains set of filters to apply if + `path` field refers to array elements. This is meant to support + value matching beyond exact match. To perform exact match, use + path_filters. When both path_filters and path_value_matchers are + set, an implicit AND must be performed. type: object - description: >- - State properties to include with this state. Overwrites any existing - `state_metadata`. Keys must match the regex `/^a-z0-9{0,62}$/`. - Values must match the regex `/^[a-zA-Z0-9_./-]{0,255}$/`. additionalProperties: - type: string + $ref: '#/components/schemas/GoogleCloudRecommenderV1ValueMatcher' + GoogleCloudRecommenderV1ValueMatcher: + id: GoogleCloudRecommenderV1ValueMatcher + description: Contains various matching options for values for a GCP resource field. + type: object + properties: + matchesPattern: + description: >- + To be used for full regex matching. The regular expression is using + the Google RE2 syntax (https://github.com/google/re2/wiki/Syntax), + so to be used with RE2::FullMatch + type: string GoogleCloudRecommenderV1RecommendationStateInfo: + id: GoogleCloudRecommenderV1RecommendationStateInfo + description: Information for state. Contains state and metadata. + type: object properties: state: + description: The state of the recommendation, Eg ACTIVE, SUCCEEDED, FAILED. + type: string enumDescriptions: - Default state. Don't use directly. - >- @@ -737,7 +623,6 @@ components: Recommendation is in dismissed state. Recommendation content can be updated by Google. DISMISSED recommendations can be marked as ACTIVE. - description: The state of the recommendation, Eg ACTIVE, SUCCEEDED, FAILED. enum: - STATE_UNSPECIFIED - ACTIVE @@ -745,89 +630,183 @@ components: - SUCCEEDED - FAILED - DISMISSED - type: string stateMetadata: - type: object - additionalProperties: - type: string description: >- A map of metadata for the state, provided by user or automations systems. - id: GoogleCloudRecommenderV1RecommendationStateInfo + type: object + additionalProperties: + type: string + GoogleCloudRecommenderV1RecommendationInsightReference: + id: GoogleCloudRecommenderV1RecommendationInsightReference + description: Reference to an associated insight. type: object - description: Information for state. Contains state and metadata. - GoogleCloudRecommenderV1ListInsightsResponse: properties: - nextPageToken: - type: string + insight: description: >- - A token that can be used to request the next page of results. This - field is empty if there are no additional results. - insights: - items: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' - description: The set of insights for the `parent` resource. - type: array - id: GoogleCloudRecommenderV1ListInsightsResponse - description: Response to the `ListInsights` method. + Insight resource name, e.g. + projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/insights/[INSIGHT_ID] + type: string + GoogleCloudRecommenderV1MarkRecommendationDismissedRequest: + id: GoogleCloudRecommenderV1MarkRecommendationDismissedRequest + description: Request for the `MarkRecommendationDismissed` Method. type: object + properties: + etag: + description: Fingerprint of the Recommendation. Provides optimistic locking. + type: string GoogleCloudRecommenderV1MarkRecommendationClaimedRequest: id: GoogleCloudRecommenderV1MarkRecommendationClaimedRequest description: Request for the `MarkRecommendationClaimed` Method. type: object properties: + stateMetadata: + description: >- + State properties to include with this state. Overwrites any existing + `state_metadata`. Keys must match the regex `/^a-z0-9{0,62}$/`. + Values must match the regex `/^[a-zA-Z0-9_./-]{0,255}$/`. + type: object + additionalProperties: + type: string etag: - type: string description: >- Required. Fingerprint of the Recommendation. Provides optimistic locking. + type: string + GoogleCloudRecommenderV1MarkRecommendationSucceededRequest: + id: GoogleCloudRecommenderV1MarkRecommendationSucceededRequest + description: Request for the `MarkRecommendationSucceeded` Method. + type: object + properties: stateMetadata: + description: >- + State properties to include with this state. Overwrites any existing + `state_metadata`. Keys must match the regex `/^a-z0-9{0,62}$/`. + Values must match the regex `/^[a-zA-Z0-9_./-]{0,255}$/`. + type: object additionalProperties: type: string - type: object + etag: + description: >- + Required. Fingerprint of the Recommendation. Provides optimistic + locking. + type: string + GoogleCloudRecommenderV1MarkRecommendationFailedRequest: + id: GoogleCloudRecommenderV1MarkRecommendationFailedRequest + description: Request for the `MarkRecommendationFailed` Method. + type: object + properties: + stateMetadata: description: >- State properties to include with this state. Overwrites any existing `state_metadata`. Keys must match the regex `/^a-z0-9{0,62}$/`. Values must match the regex `/^[a-zA-Z0-9_./-]{0,255}$/`. + type: object + additionalProperties: + type: string + etag: + description: >- + Required. Fingerprint of the Recommendation. Provides optimistic + locking. + type: string GoogleCloudRecommenderV1RecommenderConfig: + id: GoogleCloudRecommenderV1RecommenderConfig description: Configuration for a Recommender. + type: object properties: - displayName: + name: description: >- - A user-settable field to provide a human-readable name to be used in - user interfaces. - type: string - updateTime: - description: Last time when the config was updated. + Identifier. Name of recommender config. Eg, + projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config type: string - format: google-datetime + recommenderGenerationConfig: + description: >- + RecommenderGenerationConfig which configures the Generation of + recommendations for this recommender. + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1RecommenderGenerationConfig etag: description: >- Fingerprint of the RecommenderConfig. Provides optimistic locking when updating. type: string - name: + updateTime: + description: Last time when the config was updated. type: string - description: >- - Identifier. Name of recommender config. Eg, - projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config + format: google-datetime revisionId: - type: string description: >- Output only. Immutable. The revision ID of the config. A new revision is committed whenever the config is changed in any way. The format is an 8-character hexadecimal string. readOnly: true - recommenderGenerationConfig: - description: >- - RecommenderGenerationConfig which configures the Generation of - recommendations for this recommender. - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1RecommenderGenerationConfig + type: string annotations: + description: >- + Allows clients to store small amounts of arbitrary data. Annotations + must follow the Kubernetes syntax. The total size of all keys and + values combined is limited to 256k. Key can have 2 segments: prefix + (optional) and name (required), separated by a slash (/). Prefix + must be a DNS subdomain. Name must be 63 characters or less, begin + and end with alphanumerics, with dashes (-), underscores (_), dots + (.), and alphanumerics between. + type: object additionalProperties: type: string + displayName: + description: >- + A user-settable field to provide a human-readable name to be used in + user interfaces. + type: string + GoogleCloudRecommenderV1RecommenderGenerationConfig: + id: GoogleCloudRecommenderV1RecommenderGenerationConfig + description: >- + A Configuration to customize the generation of recommendations. Eg, + customizing the lookback period considered when generating a + recommendation. + type: object + properties: + params: + description: >- + Parameters for this RecommenderGenerationConfig. These configs can + be used by or are applied to all subtypes. type: object + additionalProperties: + type: any + description: Properties of the object. + GoogleCloudRecommenderV1InsightTypeConfig: + id: GoogleCloudRecommenderV1InsightTypeConfig + description: Configuration for an InsightType. + type: object + properties: + name: + description: >- + Identifier. Name of insight type config. Eg, + projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config + type: string + insightTypeGenerationConfig: + description: >- + InsightTypeGenerationConfig which configures the generation of + insights for this insight type. + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1InsightTypeGenerationConfig + etag: + description: >- + Fingerprint of the InsightTypeConfig. Provides optimistic locking + when updating. + type: string + updateTime: + description: Last time when the config was updated. + type: string + format: google-datetime + revisionId: + description: >- + Output only. Immutable. The revision ID of the config. A new + revision is committed whenever the config is changed in any way. The + format is an 8-character hexadecimal string. + readOnly: true + type: string + annotations: description: >- Allows clients to store small amounts of arbitrary data. Annotations must follow the Kubernetes syntax. The total size of all keys and @@ -836,19 +815,34 @@ components: must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between. - id: GoogleCloudRecommenderV1RecommenderConfig + type: object + additionalProperties: + type: string + displayName: + description: >- + A user-settable field to provide a human-readable name to be used in + user interfaces. + type: string + GoogleCloudRecommenderV1InsightTypeGenerationConfig: + id: GoogleCloudRecommenderV1InsightTypeGenerationConfig + description: >- + A configuration to customize the generation of insights. Eg, customizing + the lookback period considered when generating a insight. type: object + properties: + params: + description: >- + Parameters for this InsightTypeGenerationConfig. These configs can + be used by or are applied to all subtypes. + type: object + additionalProperties: + type: any + description: Properties of the object. parameters: - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - type: string - callback: - description: JSONP + access_token: + description: OAuth access token. in: query - name: callback + name: access_token schema: type: string alt: @@ -861,12 +855,18 @@ components: - json - media - proto - prettyPrint: - description: Returns response with indentations and line breaks. + callback: + description: JSONP in: query - name: prettyPrint + name: callback schema: - type: boolean + 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 @@ -882,12 +882,12 @@ components: name: oauth_token schema: type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + prettyPrint: + description: Returns response with indentations and line breaks. in: query - name: upload_protocol + name: prettyPrint schema: - type: string + type: boolean quotaUser: description: >- Available to use for quota purposes for server-side applications. Can be @@ -897,10 +897,16 @@ components: name: quotaUser schema: type: string - access_token: - description: OAuth access token. + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: access_token + name: uploadType schema: type: string _.xgafv: @@ -912,76 +918,70 @@ components: enum: - '1' - '2' - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string x-stackQL-resources: recommenders_config: id: google.recommender.recommenders_config name: recommenders_config title: Recommenders_config methods: - organizations_locations_recommenders_update_config: + projects_locations_recommenders_get_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_recommenders_get_config: + projects_locations_recommenders_update_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/patch response: mediaType: application/json openAPIDocKey: '200' - billing_accounts_locations_recommenders_update_config: + billing_accounts_locations_recommenders_get_config: operation: $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/patch + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/get response: mediaType: application/json openAPIDocKey: '200' - billing_accounts_locations_recommenders_get_config: + billing_accounts_locations_recommenders_update_config: operation: $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/get + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_recommenders_update_config: + organizations_locations_recommenders_get_config: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/patch + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_recommenders_get_config: + organizations_locations_recommenders_update_config: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/patch response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/recommenders_config/methods/organizations_locations_recommenders_get_config + #/components/x-stackQL-resources/recommenders_config/methods/projects_locations_recommenders_get_config - $ref: >- #/components/x-stackQL-resources/recommenders_config/methods/billing_accounts_locations_recommenders_get_config - $ref: >- - #/components/x-stackQL-resources/recommenders_config/methods/projects_locations_recommenders_get_config + #/components/x-stackQL-resources/recommenders_config/methods/organizations_locations_recommenders_get_config insert: [] update: - $ref: >- - #/components/x-stackQL-resources/recommenders_config/methods/organizations_locations_recommenders_update_config + #/components/x-stackQL-resources/recommenders_config/methods/projects_locations_recommenders_update_config - $ref: >- #/components/x-stackQL-resources/recommenders_config/methods/billing_accounts_locations_recommenders_update_config - $ref: >- - #/components/x-stackQL-resources/recommenders_config/methods/projects_locations_recommenders_update_config + #/components/x-stackQL-resources/recommenders_config/methods/organizations_locations_recommenders_update_config replace: [] delete: [] recommendations: @@ -989,56 +989,57 @@ components: name: recommendations title: Recommendations methods: - organizations_locations_recommenders_recommendations_mark_failed: + projects_locations_recommenders_recommendations_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markFailed/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_recommenders_recommendations_get: + objectKey: $.recommendations + projects_locations_recommenders_recommendations_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_recommenders_recommendations_mark_dismissed: + projects_locations_recommenders_recommendations_mark_dismissed: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markDismissed/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markDismissed/post response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_recommenders_recommendations_mark_succeeded: + projects_locations_recommenders_recommendations_mark_claimed: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markSucceeded/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markClaimed/post response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_recommenders_recommendations_list: + projects_locations_recommenders_recommendations_mark_succeeded: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markSucceeded/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.recommendations - organizations_locations_recommenders_recommendations_mark_claimed: + projects_locations_recommenders_recommendations_mark_failed: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markClaimed/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markFailed/post response: mediaType: application/json openAPIDocKey: '200' - billing_accounts_locations_recommenders_recommendations_mark_claimed: + billing_accounts_locations_recommenders_recommendations_list: operation: $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markClaimed/post + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.recommendations billing_accounts_locations_recommenders_recommendations_get: operation: $ref: >- @@ -1046,25 +1047,17 @@ components: response: mediaType: application/json openAPIDocKey: '200' - billing_accounts_locations_recommenders_recommendations_mark_failed: - operation: - $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markFailed/post - response: - mediaType: application/json - openAPIDocKey: '200' - billing_accounts_locations_recommenders_recommendations_list: + billing_accounts_locations_recommenders_recommendations_mark_dismissed: operation: $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations/get + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markDismissed/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.recommendations - billing_accounts_locations_recommenders_recommendations_mark_dismissed: + billing_accounts_locations_recommenders_recommendations_mark_claimed: operation: $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markDismissed/post + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markClaimed/post response: mediaType: application/json openAPIDocKey: '200' @@ -1075,20 +1068,21 @@ components: response: mediaType: application/json openAPIDocKey: '200' - folders_locations_recommenders_recommendations_mark_claimed: + billing_accounts_locations_recommenders_recommendations_mark_failed: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markClaimed/post + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markFailed/post response: mediaType: application/json openAPIDocKey: '200' - folders_locations_recommenders_recommendations_mark_failed: + folders_locations_recommenders_recommendations_list: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markFailed/post + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.recommendations folders_locations_recommenders_recommendations_get: operation: $ref: >- @@ -1103,14 +1097,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - folders_locations_recommenders_recommendations_list: + folders_locations_recommenders_recommendations_mark_claimed: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations/get + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markClaimed/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.recommendations folders_locations_recommenders_recommendations_mark_succeeded: operation: $ref: >- @@ -1118,142 +1111,148 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_locations_recommenders_recommendations_mark_dismissed: + folders_locations_recommenders_recommendations_mark_failed: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markDismissed/post + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markFailed/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_recommenders_recommendations_mark_failed: + organizations_locations_recommenders_recommendations_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markFailed/post + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_recommenders_recommendations_list: + objectKey: $.recommendations + organizations_locations_recommenders_recommendations_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.recommendations - projects_locations_recommenders_recommendations_get: + organizations_locations_recommenders_recommendations_mark_dismissed: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markDismissed/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_recommenders_recommendations_mark_claimed: + organizations_locations_recommenders_recommendations_mark_claimed: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markClaimed/post + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markClaimed/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_recommenders_recommendations_mark_succeeded: + organizations_locations_recommenders_recommendations_mark_succeeded: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markSucceeded/post + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markSucceeded/post + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_recommenders_recommendations_mark_failed: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markFailed/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/recommendations/methods/organizations_locations_recommenders_recommendations_get + #/components/x-stackQL-resources/recommendations/methods/projects_locations_recommenders_recommendations_get - $ref: >- #/components/x-stackQL-resources/recommendations/methods/billing_accounts_locations_recommenders_recommendations_get - $ref: >- #/components/x-stackQL-resources/recommendations/methods/folders_locations_recommenders_recommendations_get - $ref: >- - #/components/x-stackQL-resources/recommendations/methods/projects_locations_recommenders_recommendations_get + #/components/x-stackQL-resources/recommendations/methods/organizations_locations_recommenders_recommendations_get - $ref: >- - #/components/x-stackQL-resources/recommendations/methods/organizations_locations_recommenders_recommendations_list + #/components/x-stackQL-resources/recommendations/methods/projects_locations_recommenders_recommendations_list - $ref: >- #/components/x-stackQL-resources/recommendations/methods/billing_accounts_locations_recommenders_recommendations_list - $ref: >- #/components/x-stackQL-resources/recommendations/methods/folders_locations_recommenders_recommendations_list - $ref: >- - #/components/x-stackQL-resources/recommendations/methods/projects_locations_recommenders_recommendations_list + #/components/x-stackQL-resources/recommendations/methods/organizations_locations_recommenders_recommendations_list insert: [] update: [] replace: [] delete: [] - insights: - id: google.recommender.insights - name: insights - title: Insights + insight_types_config: + id: google.recommender.insight_types_config + name: insight_types_config + title: Insight_types_config methods: - organizations_locations_insight_types_insights_list: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.insights - organizations_locations_insight_types_insights_get: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_locations_insight_types_insights_mark_accepted: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}:markAccepted/post - response: - mediaType: application/json - openAPIDocKey: '200' - billing_accounts_locations_insight_types_insights_mark_accepted: + projects_locations_insight_types_get_config: operation: $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}:markAccepted/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/get response: mediaType: application/json openAPIDocKey: '200' - billing_accounts_locations_insight_types_insights_get: + projects_locations_insight_types_update_config: operation: $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/patch response: mediaType: application/json openAPIDocKey: '200' - billing_accounts_locations_insight_types_insights_list: + billing_accounts_locations_insight_types_get_config: operation: $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights/get + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.insights - folders_locations_insight_types_insights_get: + billing_accounts_locations_insight_types_update_config: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}/get + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/patch response: mediaType: application/json openAPIDocKey: '200' - folders_locations_insight_types_insights_list: + organizations_locations_insight_types_get_config: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/get response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.insights - folders_locations_insight_types_insights_mark_accepted: + organizations_locations_insight_types_update_config: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}:markAccepted/post + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/patch response: mediaType: application/json openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/insight_types_config/methods/projects_locations_insight_types_get_config + - $ref: >- + #/components/x-stackQL-resources/insight_types_config/methods/billing_accounts_locations_insight_types_get_config + - $ref: >- + #/components/x-stackQL-resources/insight_types_config/methods/organizations_locations_insight_types_get_config + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/insight_types_config/methods/projects_locations_insight_types_update_config + - $ref: >- + #/components/x-stackQL-resources/insight_types_config/methods/billing_accounts_locations_insight_types_update_config + - $ref: >- + #/components/x-stackQL-resources/insight_types_config/methods/organizations_locations_insight_types_update_config + replace: [] + delete: [] + insights: + id: google.recommender.insights + name: insights + title: Insights + methods: projects_locations_insight_types_insights_list: operation: $ref: >- @@ -1273,115 +1272,149 @@ components: operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}:markAccepted/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/insights/methods/organizations_locations_insight_types_insights_get - - $ref: >- - #/components/x-stackQL-resources/insights/methods/billing_accounts_locations_insight_types_insights_get - - $ref: >- - #/components/x-stackQL-resources/insights/methods/folders_locations_insight_types_insights_get - - $ref: >- - #/components/x-stackQL-resources/insights/methods/projects_locations_insight_types_insights_get - - $ref: >- - #/components/x-stackQL-resources/insights/methods/organizations_locations_insight_types_insights_list - - $ref: >- - #/components/x-stackQL-resources/insights/methods/billing_accounts_locations_insight_types_insights_list - - $ref: >- - #/components/x-stackQL-resources/insights/methods/folders_locations_insight_types_insights_list - - $ref: >- - #/components/x-stackQL-resources/insights/methods/projects_locations_insight_types_insights_list - insert: [] - update: [] - replace: [] - delete: [] - insight_types_config: - id: google.recommender.insight_types_config - name: insight_types_config - title: Insight_types_config - methods: - organizations_locations_insight_types_get_config: + response: + mediaType: application/json + openAPIDocKey: '200' + billing_accounts_locations_insight_types_insights_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/get + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_insight_types_update_config: + objectKey: $.insights + billing_accounts_locations_insight_types_insights_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/patch + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}/get response: mediaType: application/json openAPIDocKey: '200' - billing_accounts_locations_insight_types_get_config: + billing_accounts_locations_insight_types_insights_mark_accepted: operation: $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/get + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}:markAccepted/post response: mediaType: application/json openAPIDocKey: '200' - billing_accounts_locations_insight_types_update_config: + folders_locations_insight_types_insights_list: operation: $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/patch + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_insight_types_get_config: + objectKey: $.insights + folders_locations_insight_types_insights_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/get + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_insight_types_update_config: + folders_locations_insight_types_insights_mark_accepted: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/patch + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}:markAccepted/post + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_insight_types_insights_list: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.insights + organizations_locations_insight_types_insights_get: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_insight_types_insights_mark_accepted: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}:markAccepted/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/insight_types_config/methods/organizations_locations_insight_types_get_config + #/components/x-stackQL-resources/insights/methods/projects_locations_insight_types_insights_get - $ref: >- - #/components/x-stackQL-resources/insight_types_config/methods/billing_accounts_locations_insight_types_get_config + #/components/x-stackQL-resources/insights/methods/billing_accounts_locations_insight_types_insights_get - $ref: >- - #/components/x-stackQL-resources/insight_types_config/methods/projects_locations_insight_types_get_config - insert: [] - update: + #/components/x-stackQL-resources/insights/methods/folders_locations_insight_types_insights_get - $ref: >- - #/components/x-stackQL-resources/insight_types_config/methods/organizations_locations_insight_types_update_config + #/components/x-stackQL-resources/insights/methods/organizations_locations_insight_types_insights_get - $ref: >- - #/components/x-stackQL-resources/insight_types_config/methods/billing_accounts_locations_insight_types_update_config + #/components/x-stackQL-resources/insights/methods/projects_locations_insight_types_insights_list - $ref: >- - #/components/x-stackQL-resources/insight_types_config/methods/projects_locations_insight_types_update_config + #/components/x-stackQL-resources/insights/methods/billing_accounts_locations_insight_types_insights_list + - $ref: >- + #/components/x-stackQL-resources/insights/methods/folders_locations_insight_types_insights_list + - $ref: >- + #/components/x-stackQL-resources/insights/methods/organizations_locations_insight_types_insights_list + insert: [] + update: [] replace: [] delete: [] paths: - /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/config: + /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/config: parameters: &ref_1 - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' + get: + description: >- + Gets the requested Recommender Config. There is only one instance of the + config for each Recommender. + operationId: recommender.projects.locations.recommenders.getConfig + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: recommendersId + required: true + schema: + type: string patch: description: >- Updates a Recommender Config. This will create a new revision of the config. - operationId: recommender.organizations.locations.recommenders.updateConfig + operationId: recommender.projects.locations.recommenders.updateConfig requestBody: content: application/json: @@ -1401,7 +1434,7 @@ paths: $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -1415,20 +1448,71 @@ paths: required: true schema: type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask - in: query name: validateOnly schema: type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations: + parameters: *ref_1 + get: + description: >- + Lists recommendations for the specified Cloud Resource. Requires the + recommender.*.list IAM permission for the specified recommender. + operationId: recommender.projects.locations.recommenders.recommendations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1ListRecommendationsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: recommendersId + required: true + schema: + type: string - in: query - name: updateMask + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - format: google-fieldmask + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}: + parameters: *ref_1 get: description: >- - Gets the requested Recommender Config. There is only one instance of the - config for each Recommender. - operationId: recommender.organizations.locations.recommenders.getConfig + Gets the requested recommendation. Requires the recommender.*.get IAM + permission for the specified recommender. + operationId: recommender.projects.locations.recommenders.recommendations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1440,10 +1524,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -1457,26 +1541,28 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markFailed: + - in: path + name: recommendationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markDismissed: parameters: *ref_1 post: description: >- - Marks the Recommendation State as Failed. Users can use this method to - indicate to the Recommender API that they have applied the - recommendation themselves, and the operation failed. This stops the - recommendation content from being updated. Associated insights are - frozen and placed in the ACCEPTED state. MarkRecommendationFailed can be - applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED - state. Requires the recommender.*.update IAM permission for the - specified recommender. + Mark the Recommendation State as Dismissed. Users can use this method to + indicate to the Recommender API that an ACTIVE recommendation has to be + marked back as DISMISSED. MarkRecommendationDismissed can be applied to + recommendations in ACTIVE state. Requires the recommender.*.update IAM + permission for the specified recommender. operationId: >- - recommender.organizations.locations.recommenders.recommendations.markFailed + recommender.projects.locations.recommenders.recommendations.markDismissed requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationFailedRequest + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationDismissedRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1491,7 +1577,7 @@ paths: $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -1510,13 +1596,24 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markClaimed: parameters: *ref_1 - get: + post: description: >- - Gets the requested recommendation. Requires the recommender.*.get IAM - permission for the specified recommender. - operationId: recommender.organizations.locations.recommenders.recommendations.get + Marks the Recommendation State as Claimed. Users can use this method to + indicate to the Recommender API that they are starting to apply the + recommendation themselves. This stops the recommendation content from + being updated. Associated insights are frozen and placed in the ACCEPTED + state. MarkRecommendationClaimed can be applied to recommendations in + CLAIMED, SUCCEEDED, FAILED, or ACTIVE state. Requires the + recommender.*.update IAM permission for the specified recommender. + operationId: recommender.projects.locations.recommenders.recommendations.markClaimed + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationClaimedRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1531,7 +1628,7 @@ paths: $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -1550,23 +1647,26 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markDismissed: + /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markSucceeded: parameters: *ref_1 post: description: >- - Mark the Recommendation State as Dismissed. Users can use this method to - indicate to the Recommender API that an ACTIVE recommendation has to be - marked back as DISMISSED. MarkRecommendationDismissed can be applied to - recommendations in ACTIVE state. Requires the recommender.*.update IAM - permission for the specified recommender. + Marks the Recommendation State as Succeeded. Users can use this method + to indicate to the Recommender API that they have applied the + recommendation themselves, and the operation was successful. This stops + the recommendation content from being updated. Associated insights are + frozen and placed in the ACCEPTED state. MarkRecommendationSucceeded can + be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED + state. Requires the recommender.*.update IAM permission for the + specified recommender. operationId: >- - recommender.organizations.locations.recommenders.recommendations.markDismissed + recommender.projects.locations.recommenders.recommendations.markSucceeded requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationDismissedRequest + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationSucceededRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1581,7 +1681,7 @@ paths: $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -1600,26 +1700,25 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markSucceeded: + /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markFailed: parameters: *ref_1 post: description: >- - Marks the Recommendation State as Succeeded. Users can use this method - to indicate to the Recommender API that they have applied the - recommendation themselves, and the operation was successful. This stops - the recommendation content from being updated. Associated insights are - frozen and placed in the ACCEPTED state. MarkRecommendationSucceeded can - be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED + Marks the Recommendation State as Failed. Users can use this method to + indicate to the Recommender API that they have applied the + recommendation themselves, and the operation failed. This stops the + recommendation content from being updated. Associated insights are + frozen and placed in the ACCEPTED state. MarkRecommendationFailed can be + applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender. - operationId: >- - recommender.organizations.locations.recommenders.recommendations.markSucceeded + operationId: recommender.projects.locations.recommenders.recommendations.markFailed requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationSucceededRequest + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationFailedRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1634,7 +1733,7 @@ paths: $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -1653,13 +1752,13 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations: + /v1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/config: parameters: *ref_1 get: description: >- - Lists recommendations for the specified Cloud Resource. Requires the - recommender.*.list IAM permission for the specified recommender. - operationId: recommender.organizations.locations.recommenders.recommendations.list + Gets the requested InsightTypeConfig. There is only one instance of the + config for each InsightType. + operationId: recommender.projects.locations.insightTypes.getConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1671,11 +1770,10 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1ListRecommendationsResponse + $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -1685,42 +1783,20 @@ paths: schema: type: string - in: path - name: recommendersId + name: insightTypesId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markClaimed: - parameters: *ref_1 - post: + patch: description: >- - Marks the Recommendation State as Claimed. Users can use this method to - indicate to the Recommender API that they are starting to apply the - recommendation themselves. This stops the recommendation content from - being updated. Associated insights are frozen and placed in the ACCEPTED - state. MarkRecommendationClaimed can be applied to recommendations in - CLAIMED, SUCCEEDED, FAILED, or ACTIVE state. Requires the - recommender.*.update IAM permission for the specified recommender. - operationId: >- - recommender.organizations.locations.recommenders.recommendations.markClaimed + Updates an InsightTypeConfig change. This will create a new revision of + the config. + operationId: recommender.projects.locations.insightTypes.updateConfig requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationClaimedRequest + $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1732,10 +1808,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -1745,22 +1821,26 @@ paths: schema: type: string - in: path - name: recommendersId + name: insightTypesId required: true schema: type: string - - in: path - name: recommendationsId - required: true + - in: query + name: updateMask schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights: + format: google-fieldmask + - in: query + name: validateOnly + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights: parameters: *ref_1 get: description: >- Lists insights for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified insight type. - operationId: recommender.organizations.locations.insightTypes.insights.list + operationId: recommender.projects.locations.insightTypes.insights.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1776,7 +1856,7 @@ paths: #/components/schemas/GoogleCloudRecommenderV1ListInsightsResponse parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -1796,20 +1876,20 @@ paths: type: integer format: int32 - in: query - name: filter + name: pageToken schema: type: string - in: query - name: pageToken + name: filter schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}: + /v1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}: parameters: *ref_1 get: description: >- Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type. - operationId: recommender.organizations.locations.insightTypes.insights.get + operationId: recommender.projects.locations.insightTypes.insights.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1824,7 +1904,7 @@ paths: $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -1843,7 +1923,7 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}:markAccepted: + /v1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}:markAccepted: parameters: *ref_1 post: description: >- @@ -1852,7 +1932,7 @@ paths: on the insight. This stops the insight content from being updated. MarkInsightAccepted can be applied to insights in ACTIVE state. Requires the recommender.*.update IAM permission for the specified insight. - operationId: recommender.organizations.locations.insightTypes.insights.markAccepted + operationId: recommender.projects.locations.insightTypes.insights.markAccepted requestBody: content: application/json: @@ -1873,7 +1953,7 @@ paths: $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -1892,13 +1972,13 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/insightTypes/{insightTypesId}/config: + /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/config: parameters: *ref_1 get: description: >- - Gets the requested InsightTypeConfig. There is only one instance of the - config for each InsightType. - operationId: recommender.organizations.locations.insightTypes.getConfig + Gets the requested Recommender Config. There is only one instance of the + config for each Recommender. + operationId: recommender.billingAccounts.locations.recommenders.getConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1910,10 +1990,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' + $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' parameters: - in: path - name: organizationsId + name: billingAccountsId required: true schema: type: string @@ -1923,20 +2003,20 @@ paths: schema: type: string - in: path - name: insightTypesId + name: recommendersId required: true schema: type: string patch: description: >- - Updates an InsightTypeConfig change. This will create a new revision of - the config. - operationId: recommender.organizations.locations.insightTypes.updateConfig + Updates a Recommender Config. This will create a new revision of the + config. + operationId: recommender.billingAccounts.locations.recommenders.updateConfig requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' + $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1948,10 +2028,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' + $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' parameters: - in: path - name: organizationsId + name: billingAccountsId required: true schema: type: string @@ -1961,7 +2041,7 @@ paths: schema: type: string - in: path - name: insightTypesId + name: recommendersId required: true schema: type: string @@ -1974,25 +2054,13 @@ paths: name: validateOnly schema: type: boolean - /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markClaimed: + /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations: parameters: *ref_1 - post: + get: description: >- - Marks the Recommendation State as Claimed. Users can use this method to - indicate to the Recommender API that they are starting to apply the - recommendation themselves. This stops the recommendation content from - being updated. Associated insights are frozen and placed in the ACCEPTED - state. MarkRecommendationClaimed can be applied to recommendations in - CLAIMED, SUCCEEDED, FAILED, or ACTIVE state. Requires the - recommender.*.update IAM permission for the specified recommender. - operationId: >- - recommender.billingAccounts.locations.recommenders.recommendations.markClaimed - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationClaimedRequest + Lists recommendations for the specified Cloud Resource. Requires the + recommender.*.list IAM permission for the specified recommender. + operationId: recommender.billingAccounts.locations.recommenders.recommendations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2004,7 +2072,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1ListRecommendationsResponse parameters: - in: path name: billingAccountsId @@ -2021,9 +2090,17 @@ paths: required: true schema: type: string - - in: path - name: recommendationsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter schema: type: string /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}: @@ -2066,26 +2143,23 @@ paths: required: true schema: type: string - /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markFailed: + /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markDismissed: parameters: *ref_1 post: description: >- - Marks the Recommendation State as Failed. Users can use this method to - indicate to the Recommender API that they have applied the - recommendation themselves, and the operation failed. This stops the - recommendation content from being updated. Associated insights are - frozen and placed in the ACCEPTED state. MarkRecommendationFailed can be - applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED - state. Requires the recommender.*.update IAM permission for the - specified recommender. + Mark the Recommendation State as Dismissed. Users can use this method to + indicate to the Recommender API that an ACTIVE recommendation has to be + marked back as DISMISSED. MarkRecommendationDismissed can be applied to + recommendations in ACTIVE state. Requires the recommender.*.update IAM + permission for the specified recommender. operationId: >- - recommender.billingAccounts.locations.recommenders.recommendations.markFailed + recommender.billingAccounts.locations.recommenders.recommendations.markDismissed requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationFailedRequest + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationDismissedRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2119,72 +2193,25 @@ paths: required: true schema: type: string - /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations: - parameters: *ref_1 - get: - description: >- - Lists recommendations for the specified Cloud Resource. Requires the - recommender.*.list IAM permission for the specified recommender. - operationId: recommender.billingAccounts.locations.recommenders.recommendations.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1ListRecommendationsResponse - parameters: - - in: path - name: billingAccountsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: recommendersId - required: true - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markDismissed: + /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markClaimed: parameters: *ref_1 post: description: >- - Mark the Recommendation State as Dismissed. Users can use this method to - indicate to the Recommender API that an ACTIVE recommendation has to be - marked back as DISMISSED. MarkRecommendationDismissed can be applied to - recommendations in ACTIVE state. Requires the recommender.*.update IAM - permission for the specified recommender. + Marks the Recommendation State as Claimed. Users can use this method to + indicate to the Recommender API that they are starting to apply the + recommendation themselves. This stops the recommendation content from + being updated. Associated insights are frozen and placed in the ACCEPTED + state. MarkRecommendationClaimed can be applied to recommendations in + CLAIMED, SUCCEEDED, FAILED, or ACTIVE state. Requires the + recommender.*.update IAM permission for the specified recommender. operationId: >- - recommender.billingAccounts.locations.recommenders.recommendations.markDismissed + recommender.billingAccounts.locations.recommenders.recommendations.markClaimed requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationDismissedRequest + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationClaimedRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2271,18 +2298,26 @@ paths: required: true schema: type: string - /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/config: + /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markFailed: parameters: *ref_1 - patch: + post: description: >- - Updates a Recommender Config. This will create a new revision of the - config. - operationId: recommender.billingAccounts.locations.recommenders.updateConfig + Marks the Recommendation State as Failed. Users can use this method to + indicate to the Recommender API that they have applied the + recommendation themselves, and the operation failed. This stops the + recommendation content from being updated. Associated insights are + frozen and placed in the ACCEPTED state. MarkRecommendationFailed can be + applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED + state. Requires the recommender.*.update IAM permission for the + specified recommender. + operationId: >- + recommender.billingAccounts.locations.recommenders.recommendations.markFailed requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationFailedRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2294,7 +2329,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path name: billingAccountsId @@ -2311,20 +2346,18 @@ paths: required: true schema: type: string - - in: query - name: updateMask + - in: path + name: recommendationsId + required: true schema: type: string - format: google-fieldmask - - in: query - name: validateOnly - schema: - type: boolean + /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/insightTypes/{insightTypesId}/config: + parameters: *ref_1 get: description: >- - Gets the requested Recommender Config. There is only one instance of the - config for each Recommender. - operationId: recommender.billingAccounts.locations.recommenders.getConfig + Gets the requested InsightTypeConfig. There is only one instance of the + config for each InsightType. + operationId: recommender.billingAccounts.locations.insightTypes.getConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2336,7 +2369,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' + $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' parameters: - in: path name: billingAccountsId @@ -2349,26 +2382,20 @@ paths: schema: type: string - in: path - name: recommendersId + name: insightTypesId required: true schema: type: string - /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}:markAccepted: - parameters: *ref_1 - post: + patch: description: >- - Marks the Insight State as Accepted. Users can use this method to - indicate to the Recommender API that they have applied some action based - on the insight. This stops the insight content from being updated. - MarkInsightAccepted can be applied to insights in ACTIVE state. Requires - the recommender.*.update IAM permission for the specified insight. - operationId: recommender.billingAccounts.locations.insightTypes.insights.markAccepted + Updates an InsightTypeConfig change. This will create a new revision of + the config. + operationId: recommender.billingAccounts.locations.insightTypes.updateConfig requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkInsightAcceptedRequest + $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2380,7 +2407,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' + $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' parameters: - in: path name: billingAccountsId @@ -2397,11 +2424,64 @@ paths: required: true schema: type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: validateOnly + schema: + type: boolean + /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights: + parameters: *ref_1 + get: + description: >- + Lists insights for the specified Cloud Resource. Requires the + recommender.*.list IAM permission for the specified insight type. + operationId: recommender.billingAccounts.locations.insightTypes.insights.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1ListInsightsResponse + parameters: - in: path - name: insightsId + name: billingAccountsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: insightTypesId required: true schema: type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}: parameters: *ref_1 get: @@ -2442,13 +2522,22 @@ paths: required: true schema: type: string - /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights: + /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}:markAccepted: parameters: *ref_1 - get: + post: description: >- - Lists insights for the specified Cloud Resource. Requires the - recommender.*.list IAM permission for the specified insight type. - operationId: recommender.billingAccounts.locations.insightTypes.insights.list + Marks the Insight State as Accepted. Users can use this method to + indicate to the Recommender API that they have applied some action based + on the insight. This stops the insight content from being updated. + MarkInsightAccepted can be applied to insights in ACTIVE state. Requires + the recommender.*.update IAM permission for the specified insight. + operationId: recommender.billingAccounts.locations.insightTypes.insights.markAccepted + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1MarkInsightAcceptedRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2460,8 +2549,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1ListInsightsResponse + $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' parameters: - in: path name: billingAccountsId @@ -2478,26 +2566,18 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + - in: path + name: insightsId + required: true schema: type: string - /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/insightTypes/{insightTypesId}/config: + /v1/folders/{foldersId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights: parameters: *ref_1 get: description: >- - Gets the requested InsightTypeConfig. There is only one instance of the - config for each InsightType. - operationId: recommender.billingAccounts.locations.insightTypes.getConfig + Lists insights for the specified Cloud Resource. Requires the + recommender.*.list IAM permission for the specified insight type. + operationId: recommender.folders.locations.insightTypes.insights.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2509,10 +2589,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1ListInsightsResponse parameters: - in: path - name: billingAccountsId + name: foldersId required: true schema: type: string @@ -2526,16 +2607,26 @@ paths: required: true schema: type: string - patch: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1/folders/{foldersId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}: + parameters: *ref_1 + get: description: >- - Updates an InsightTypeConfig change. This will create a new revision of - the config. - operationId: recommender.billingAccounts.locations.insightTypes.updateConfig - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' + Gets the requested insight. Requires the recommender.*.get IAM + permission for the specified insight type. + operationId: recommender.folders.locations.insightTypes.insights.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2547,10 +2638,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' parameters: - in: path - name: billingAccountsId + name: foldersId required: true schema: type: string @@ -2564,33 +2655,27 @@ paths: required: true schema: type: string - - in: query - name: validateOnly - schema: - type: boolean - - in: query - name: updateMask + - in: path + name: insightsId + required: true schema: type: string - format: google-fieldmask - /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markClaimed: + /v1/folders/{foldersId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}:markAccepted: parameters: *ref_1 post: description: >- - Marks the Recommendation State as Claimed. Users can use this method to - indicate to the Recommender API that they are starting to apply the - recommendation themselves. This stops the recommendation content from - being updated. Associated insights are frozen and placed in the ACCEPTED - state. MarkRecommendationClaimed can be applied to recommendations in - CLAIMED, SUCCEEDED, FAILED, or ACTIVE state. Requires the - recommender.*.update IAM permission for the specified recommender. - operationId: recommender.folders.locations.recommenders.recommendations.markClaimed + Marks the Insight State as Accepted. Users can use this method to + indicate to the Recommender API that they have applied some action based + on the insight. This stops the insight content from being updated. + MarkInsightAccepted can be applied to insights in ACTIVE state. Requires + the recommender.*.update IAM permission for the specified insight. + operationId: recommender.folders.locations.insightTypes.insights.markAccepted requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationClaimedRequest + #/components/schemas/GoogleCloudRecommenderV1MarkInsightAcceptedRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2602,7 +2687,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' parameters: - in: path name: foldersId @@ -2615,34 +2700,22 @@ paths: schema: type: string - in: path - name: recommendersId + name: insightTypesId required: true schema: type: string - in: path - name: recommendationsId + name: insightsId required: true schema: type: string - /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markFailed: + /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations: parameters: *ref_1 - post: + get: description: >- - Marks the Recommendation State as Failed. Users can use this method to - indicate to the Recommender API that they have applied the - recommendation themselves, and the operation failed. This stops the - recommendation content from being updated. Associated insights are - frozen and placed in the ACCEPTED state. MarkRecommendationFailed can be - applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED - state. Requires the recommender.*.update IAM permission for the - specified recommender. - operationId: recommender.folders.locations.recommenders.recommendations.markFailed - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationFailedRequest + Lists recommendations for the specified Cloud Resource. Requires the + recommender.*.list IAM permission for the specified recommender. + operationId: recommender.folders.locations.recommenders.recommendations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2654,7 +2727,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1ListRecommendationsResponse parameters: - in: path name: foldersId @@ -2671,9 +2745,17 @@ paths: required: true schema: type: string - - in: path - name: recommendationsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter schema: type: string /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}: @@ -2765,13 +2847,24 @@ paths: required: true schema: type: string - /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations: + /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markClaimed: parameters: *ref_1 - get: + post: description: >- - Lists recommendations for the specified Cloud Resource. Requires the - recommender.*.list IAM permission for the specified recommender. - operationId: recommender.folders.locations.recommenders.recommendations.list + Marks the Recommendation State as Claimed. Users can use this method to + indicate to the Recommender API that they are starting to apply the + recommendation themselves. This stops the recommendation content from + being updated. Associated insights are frozen and placed in the ACCEPTED + state. MarkRecommendationClaimed can be applied to recommendations in + CLAIMED, SUCCEEDED, FAILED, or ACTIVE state. Requires the + recommender.*.update IAM permission for the specified recommender. + operationId: recommender.folders.locations.recommenders.recommendations.markClaimed + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationClaimedRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2783,8 +2876,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1ListRecommendationsResponse + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path name: foldersId @@ -2801,17 +2893,9 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken + - in: path + name: recommendationsId + required: true schema: type: string /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markSucceeded: @@ -2866,13 +2950,25 @@ paths: required: true schema: type: string - /v1/folders/{foldersId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}: + /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markFailed: parameters: *ref_1 - get: + post: description: >- - Gets the requested insight. Requires the recommender.*.get IAM - permission for the specified insight type. - operationId: recommender.folders.locations.insightTypes.insights.get + Marks the Recommendation State as Failed. Users can use this method to + indicate to the Recommender API that they have applied the + recommendation themselves, and the operation failed. This stops the + recommendation content from being updated. Associated insights are + frozen and placed in the ACCEPTED state. MarkRecommendationFailed can be + applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED + state. Requires the recommender.*.update IAM permission for the + specified recommender. + operationId: recommender.folders.locations.recommenders.recommendations.markFailed + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationFailedRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2884,7 +2980,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path name: foldersId @@ -2897,22 +2993,22 @@ paths: schema: type: string - in: path - name: insightTypesId + name: recommendersId required: true schema: type: string - in: path - name: insightsId + name: recommendationsId required: true schema: type: string - /v1/folders/{foldersId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights: + /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/config: parameters: *ref_1 get: description: >- - Lists insights for the specified Cloud Resource. Requires the - recommender.*.list IAM permission for the specified insight type. - operationId: recommender.folders.locations.insightTypes.insights.list + Gets the requested Recommender Config. There is only one instance of the + config for each Recommender. + operationId: recommender.organizations.locations.recommenders.getConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2924,11 +3020,10 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1ListInsightsResponse + $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string @@ -2938,39 +3033,20 @@ paths: schema: type: string - in: path - name: insightTypesId + name: recommendersId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - /v1/folders/{foldersId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}:markAccepted: - parameters: *ref_1 - post: + patch: description: >- - Marks the Insight State as Accepted. Users can use this method to - indicate to the Recommender API that they have applied some action based - on the insight. This stops the insight content from being updated. - MarkInsightAccepted can be applied to insights in ACTIVE state. Requires - the recommender.*.update IAM permission for the specified insight. - operationId: recommender.folders.locations.insightTypes.insights.markAccepted + Updates a Recommender Config. This will create a new revision of the + config. + operationId: recommender.organizations.locations.recommenders.updateConfig requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkInsightAcceptedRequest + $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2982,10 +3058,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' + $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string @@ -2995,22 +3071,26 @@ paths: schema: type: string - in: path - name: insightTypesId + name: recommendersId required: true schema: type: string - - in: path - name: insightsId - required: true + - in: query + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/config: + format: google-fieldmask + - in: query + name: validateOnly + schema: + type: boolean + /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations: parameters: *ref_1 get: description: >- - Gets the requested InsightTypeConfig. There is only one instance of the - config for each InsightType. - operationId: recommender.projects.locations.insightTypes.getConfig + Lists recommendations for the specified Cloud Resource. Requires the + recommender.*.list IAM permission for the specified recommender. + operationId: recommender.organizations.locations.recommenders.recommendations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3022,10 +3102,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1ListRecommendationsResponse parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -3035,64 +3116,30 @@ paths: schema: type: string - in: path - name: insightTypesId - required: true - schema: - type: string - patch: - description: >- - Updates an InsightTypeConfig change. This will create a new revision of - the config. - operationId: recommender.projects.locations.insightTypes.updateConfig - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId + name: recommendersId required: true schema: type: string - - in: path - name: insightTypesId - required: true + - in: query + name: pageSize schema: - type: string + type: integer + format: int32 - in: query - name: validateOnly + name: pageToken schema: - type: boolean + type: string - in: query - name: updateMask + name: filter schema: type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights: + /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}: parameters: *ref_1 get: description: >- - Lists insights for the specified Cloud Resource. Requires the - recommender.*.list IAM permission for the specified insight type. - operationId: recommender.projects.locations.insightTypes.insights.list + Gets the requested recommendation. Requires the recommender.*.get IAM + permission for the specified recommender. + operationId: recommender.organizations.locations.recommenders.recommendations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3104,11 +3151,10 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1ListInsightsResponse + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -3118,30 +3164,32 @@ paths: schema: type: string - in: path - name: insightTypesId + name: recommendersId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken + - in: path + name: recommendationsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}: + /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markDismissed: parameters: *ref_1 - get: + post: description: >- - Gets the requested insight. Requires the recommender.*.get IAM - permission for the specified insight type. - operationId: recommender.projects.locations.insightTypes.insights.get + Mark the Recommendation State as Dismissed. Users can use this method to + indicate to the Recommender API that an ACTIVE recommendation has to be + marked back as DISMISSED. MarkRecommendationDismissed can be applied to + recommendations in ACTIVE state. Requires the recommender.*.update IAM + permission for the specified recommender. + operationId: >- + recommender.organizations.locations.recommenders.recommendations.markDismissed + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationDismissedRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3153,10 +3201,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -3166,31 +3214,34 @@ paths: schema: type: string - in: path - name: insightTypesId + name: recommendersId required: true schema: type: string - in: path - name: insightsId + name: recommendationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}:markAccepted: + /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markClaimed: parameters: *ref_1 post: description: >- - Marks the Insight State as Accepted. Users can use this method to - indicate to the Recommender API that they have applied some action based - on the insight. This stops the insight content from being updated. - MarkInsightAccepted can be applied to insights in ACTIVE state. Requires - the recommender.*.update IAM permission for the specified insight. - operationId: recommender.projects.locations.insightTypes.insights.markAccepted + Marks the Recommendation State as Claimed. Users can use this method to + indicate to the Recommender API that they are starting to apply the + recommendation themselves. This stops the recommendation content from + being updated. Associated insights are frozen and placed in the ACCEPTED + state. MarkRecommendationClaimed can be applied to recommendations in + CLAIMED, SUCCEEDED, FAILED, or ACTIVE state. Requires the + recommender.*.update IAM permission for the specified recommender. + operationId: >- + recommender.organizations.locations.recommenders.recommendations.markClaimed requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkInsightAcceptedRequest + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationClaimedRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3202,10 +3253,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -3215,32 +3266,35 @@ paths: schema: type: string - in: path - name: insightTypesId + name: recommendersId required: true schema: type: string - in: path - name: insightsId + name: recommendationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markDismissed: + /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markSucceeded: parameters: *ref_1 post: description: >- - Mark the Recommendation State as Dismissed. Users can use this method to - indicate to the Recommender API that an ACTIVE recommendation has to be - marked back as DISMISSED. MarkRecommendationDismissed can be applied to - recommendations in ACTIVE state. Requires the recommender.*.update IAM - permission for the specified recommender. + Marks the Recommendation State as Succeeded. Users can use this method + to indicate to the Recommender API that they have applied the + recommendation themselves, and the operation was successful. This stops + the recommendation content from being updated. Associated insights are + frozen and placed in the ACCEPTED state. MarkRecommendationSucceeded can + be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED + state. Requires the recommender.*.update IAM permission for the + specified recommender. operationId: >- - recommender.projects.locations.recommenders.recommendations.markDismissed + recommender.organizations.locations.recommenders.recommendations.markSucceeded requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationDismissedRequest + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationSucceededRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3255,7 +3309,7 @@ paths: $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -3274,7 +3328,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markFailed: + /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markFailed: parameters: *ref_1 post: description: >- @@ -3286,7 +3340,8 @@ paths: applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender. - operationId: recommender.projects.locations.recommenders.recommendations.markFailed + operationId: >- + recommender.organizations.locations.recommenders.recommendations.markFailed requestBody: content: application/json: @@ -3307,7 +3362,7 @@ paths: $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -3326,13 +3381,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations: + /v1/organizations/{organizationsId}/locations/{locationsId}/insightTypes/{insightTypesId}/config: parameters: *ref_1 get: description: >- - Lists recommendations for the specified Cloud Resource. Requires the - recommender.*.list IAM permission for the specified recommender. - operationId: recommender.projects.locations.recommenders.recommendations.list + Gets the requested InsightTypeConfig. There is only one instance of the + config for each InsightType. + operationId: recommender.organizations.locations.insightTypes.getConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3344,11 +3399,10 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1ListRecommendationsResponse + $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -3358,30 +3412,20 @@ paths: schema: type: string - in: path - name: recommendersId + name: insightTypesId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}: - parameters: *ref_1 - get: + patch: description: >- - Gets the requested recommendation. Requires the recommender.*.get IAM - permission for the specified recommender. - operationId: recommender.projects.locations.recommenders.recommendations.get + Updates an InsightTypeConfig change. This will create a new revision of + the config. + operationId: recommender.organizations.locations.insightTypes.updateConfig + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3393,10 +3437,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -3406,33 +3450,26 @@ paths: schema: type: string - in: path - name: recommendersId + name: insightTypesId required: true schema: type: string - - in: path - name: recommendationsId - required: true + - in: query + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markClaimed: + format: google-fieldmask + - in: query + name: validateOnly + schema: + type: boolean + /v1/organizations/{organizationsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights: parameters: *ref_1 - post: + get: description: >- - Marks the Recommendation State as Claimed. Users can use this method to - indicate to the Recommender API that they are starting to apply the - recommendation themselves. This stops the recommendation content from - being updated. Associated insights are frozen and placed in the ACCEPTED - state. MarkRecommendationClaimed can be applied to recommendations in - CLAIMED, SUCCEEDED, FAILED, or ACTIVE state. Requires the - recommender.*.update IAM permission for the specified recommender. - operationId: recommender.projects.locations.recommenders.recommendations.markClaimed - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationClaimedRequest + Lists insights for the specified Cloud Resource. Requires the + recommender.*.list IAM permission for the specified insight type. + operationId: recommender.organizations.locations.insightTypes.insights.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3444,10 +3481,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1ListInsightsResponse parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -3457,35 +3495,30 @@ paths: schema: type: string - in: path - name: recommendersId + name: insightTypesId required: true schema: type: string - - in: path - name: recommendationsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markSucceeded: + - in: query + name: filter + schema: + type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}: parameters: *ref_1 - post: + get: description: >- - Marks the Recommendation State as Succeeded. Users can use this method - to indicate to the Recommender API that they have applied the - recommendation themselves, and the operation was successful. This stops - the recommendation content from being updated. Associated insights are - frozen and placed in the ACCEPTED state. MarkRecommendationSucceeded can - be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED - state. Requires the recommender.*.update IAM permission for the - specified recommender. - operationId: >- - recommender.projects.locations.recommenders.recommendations.markSucceeded - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationSucceededRequest + Gets the requested insight. Requires the recommender.*.get IAM + permission for the specified insight type. + operationId: recommender.organizations.locations.insightTypes.insights.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3497,10 +3530,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -3510,27 +3543,31 @@ paths: schema: type: string - in: path - name: recommendersId + name: insightTypesId required: true schema: type: string - in: path - name: recommendationsId + name: insightsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/config: + /v1/organizations/{organizationsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}:markAccepted: parameters: *ref_1 - patch: + post: description: >- - Updates a Recommender Config. This will create a new revision of the - config. - operationId: recommender.projects.locations.recommenders.updateConfig + Marks the Insight State as Accepted. Users can use this method to + indicate to the Recommender API that they have applied some action based + on the insight. This stops the insight content from being updated. + MarkInsightAccepted can be applied to insights in ACTIVE state. Requires + the recommender.*.update IAM permission for the specified insight. + operationId: recommender.organizations.locations.insightTypes.insights.markAccepted requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1MarkInsightAcceptedRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3542,10 +3579,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -3555,49 +3592,12 @@ paths: schema: type: string - in: path - name: recommendersId - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - - in: query - name: validateOnly - schema: - type: boolean - get: - description: >- - Gets the requested Recommender Config. There is only one instance of the - config for each Recommender. - operationId: recommender.projects.locations.recommenders.getConfig - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId + name: insightTypesId required: true schema: type: string - in: path - name: recommendersId + name: insightsId required: true schema: type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/redis.yaml b/providers/src/googleapis.com/v00.00.00000/services/redis.yaml index bd7076a7..b55b49ca 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/redis.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/redis.yaml @@ -7,8 +7,8 @@ info: title: Google Cloud Memorystore for Redis API description: Creates and manages Redis instances on the Google Cloud Platform. version: v1 - x-discovery-doc-revision: '20241024' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250819' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/memorystore/docs/redis/ servers: @@ -229,6 +229,15 @@ components: description: A cluster instance. type: object properties: + gcsSource: + description: >- + Optional. Backups stored in Cloud Storage buckets. The Cloud Storage + buckets need to be the same region as the clusters. Read permission + is required to import from the provided Cloud Storage objects. + $ref: '#/components/schemas/GcsBackupSource' + managedBackupSource: + description: Optional. Backups generated and managed by memorystore service. + $ref: '#/components/schemas/ManagedBackupSource' name: description: >- Required. Identifier. Unique name of the resource in this scope @@ -395,6 +404,14 @@ components: maintenance schedule. readOnly: true $ref: '#/components/schemas/ClusterMaintenanceSchedule' + satisfiesPzs: + description: Optional. Output only. Reserved for future use. + readOnly: true + type: boolean + satisfiesPzi: + description: Optional. Output only. Reserved for future use. + readOnly: true + type: boolean pscServiceAttachments: description: Output only. Service attachment details to configure Psc connections readOnly: true @@ -402,10 +419,84 @@ components: items: $ref: '#/components/schemas/PscServiceAttachment' clusterEndpoints: - description: Optional. A list of cluster enpoints. + description: Optional. A list of cluster endpoints. type: array items: $ref: '#/components/schemas/ClusterEndpoint' + simulateMaintenanceEvent: + description: Optional. Input only. Simulate a maintenance event. + type: boolean + backupCollection: + description: >- + Optional. Output only. The backup collection full resource name. + Example: + projects/{project}/locations/{location}/backupCollections/{collection} + readOnly: true + type: string + kmsKey: + description: >- + Optional. The KMS key used to encrypt the at-rest data of the + cluster. + type: string + ondemandMaintenance: + description: >- + Optional. Input only. Ondemand maintenance for the cluster. This + field can be used to trigger ondemand critical update on the + cluster. + deprecated: true + type: boolean + automatedBackupConfig: + description: Optional. The automated backup config for the cluster. + $ref: '#/components/schemas/AutomatedBackupConfig' + encryptionInfo: + description: >- + Output only. Encryption information of the data at rest of the + cluster. + readOnly: true + $ref: '#/components/schemas/EncryptionInfo' + asyncClusterEndpointsDeletionEnabled: + description: >- + Optional. If true, cluster endpoints that are created and registered + by customers can be deleted asynchronously. That is, such a cluster + endpoint can be de-registered before the forwarding rules in the + cluster endpoint are deleted. + type: boolean + allowFewerZonesDeployment: + description: >- + Optional. Immutable. Allows customers to specify if they are okay + with deploying a multi-zone cluster in less than 3 zones. Once set, + if there is a zonal outage during the cluster creation, the cluster + will only be deployed in 2 zones, and stay within the 2 zones for + its lifecycle. + type: boolean + GcsBackupSource: + id: GcsBackupSource + description: >- + Backups stored in Cloud Storage buckets. The Cloud Storage buckets need + to be the same region as the clusters. + type: object + properties: + uris: + description: >- + Optional. URIs of the Cloud Storage objects to import. Example: + gs://bucket1/object1, gs://bucket2/folder2/object2 + type: array + items: + type: string + ManagedBackupSource: + id: ManagedBackupSource + description: Backups that generated and managed by memorystore. + type: object + properties: + backup: + description: >- + Optional. Example: + //redis.googleapis.com/projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backup} + A shorter version (without the prefix) of the backup name is also + supported, like + projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backup_id} + In this case, it assumes the backup is under redis.googleapis.com. + type: string PscConfig: id: PscConfig type: object @@ -444,6 +535,13 @@ components: description: Details of consumer resources in a PSC connection. type: object properties: + port: + description: >- + Output only. port will only be set for Primary/Reader or Discovery + endpoint. + readOnly: true + type: integer + format: int32 pscConnectionId: description: >- Required. The PSC connection id of the forwarding rule connected to @@ -534,6 +632,21 @@ components: description: Target number of replica nodes per shard. type: integer format: int32 + targetNodeType: + description: Target node type for redis cluster. + type: string + enumDescriptions: + - Node type unspecified + - Redis shared core nano node_type. + - Redis highmem medium node_type. + - Redis highmem xlarge node_type. + - Redis standard small node_type. + enum: + - NODE_TYPE_UNSPECIFIED + - REDIS_SHARED_CORE_NANO + - REDIS_HIGHMEM_MEDIUM + - REDIS_HIGHMEM_XLARGE + - REDIS_STANDARD_SMALL ClusterPersistenceConfig: id: ClusterPersistenceConfig description: Configuration of the persistence functionality. @@ -648,7 +761,8 @@ components: type: object properties: clusterRole: - description: The role of the cluster in cross cluster replication. + description: Output only. The role of the cluster in cross cluster replication. + readOnly: true type: string enumDescriptions: - Cluster role is not set. The behavior is equivalent to NONE. @@ -712,8 +826,9 @@ components: properties: cluster: description: >- - The full resource path of the remote cluster in the format: - projects//locations//clusters/ + Output only. The full resource path of the remote cluster in the + format: projects//locations//clusters/ + readOnly: true type: string uid: description: Output only. The unique identifier of the remote cluster. @@ -773,7 +888,9 @@ components: type: object properties: day: - description: Allows to define schedule that runs specified day of the week. + description: >- + Optional. Allows to define schedule that runs specified day of the + week. type: string enumDescriptions: - The day of the week is unspecified. @@ -794,7 +911,7 @@ components: - SATURDAY - SUNDAY startTime: - description: Start time of the window in UTC. + description: Optional. Start time of the window in UTC. $ref: '#/components/schemas/TimeOfDay' TimeOfDay: id: TimeOfDay @@ -833,7 +950,7 @@ components: format: int32 ClusterMaintenanceSchedule: id: ClusterMaintenanceSchedule - description: Upcoming maitenance schedule. + description: Upcoming maintenance schedule. type: object properties: startTime: @@ -895,8 +1012,8 @@ components: properties: connections: description: >- - A group of PSC connections. They are created in the same VPC - network, one for each service attachment in the cluster. + Required. A group of PSC connections. They are created in the same + VPC network, one for each service attachment in the cluster. type: array items: $ref: '#/components/schemas/ConnectionDetail' @@ -905,11 +1022,200 @@ components: description: Detailed information of each PSC connection. type: object properties: + pscAutoConnection: + description: >- + Detailed information of a PSC connection that is created through + service connectivity automation. + $ref: '#/components/schemas/PscAutoConnection' pscConnection: description: >- Detailed information of a PSC connection that is created by the customer who owns the cluster. $ref: '#/components/schemas/PscConnection' + PscAutoConnection: + id: PscAutoConnection + description: >- + Details of consumer resources in a PSC connection that is created + through Service Connectivity Automation. + type: object + properties: + pscConnectionId: + description: >- + Output only. The PSC connection id of the forwarding rule connected + to the service attachment. + readOnly: true + type: string + address: + description: >- + Output only. The IP allocated on the consumer network for the PSC + forwarding rule. + readOnly: true + type: string + forwardingRule: + description: >- + Output only. The URI of the consumer side forwarding rule. Example: + projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. + readOnly: true + type: string + projectId: + description: >- + Required. The consumer project_id where the forwarding rule is + created from. + type: string + network: + description: >- + Required. The consumer network where the IP address resides, in the + form of projects/{project_id}/global/networks/{network_id}. + type: string + serviceAttachment: + description: >- + Output only. The service attachment which is the target of the PSC + connection, in the form of + projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id}. + readOnly: true + type: string + pscConnectionStatus: + description: >- + Output only. The status of the PSC connection. Please note that this + value is updated periodically. Please use Private Service Connect + APIs for the latest status. + readOnly: true + type: string + enumDescriptions: + - PSC connection status is not specified. + - The connection is active + - Connection not found + enum: + - PSC_CONNECTION_STATUS_UNSPECIFIED + - PSC_CONNECTION_STATUS_ACTIVE + - PSC_CONNECTION_STATUS_NOT_FOUND + connectionType: + description: Output only. Type of the PSC connection. + readOnly: true + type: string + enumDescriptions: + - Cluster endpoint Type is not set + - >- + Cluster endpoint that will be used as for cluster topology + discovery. + - >- + Cluster endpoint that will be used as primary endpoint to access + primary. + - >- + Cluster endpoint that will be used as reader endpoint to access + replicas. + enum: + - CONNECTION_TYPE_UNSPECIFIED + - CONNECTION_TYPE_DISCOVERY + - CONNECTION_TYPE_PRIMARY + - CONNECTION_TYPE_READER + AutomatedBackupConfig: + id: AutomatedBackupConfig + description: The automated backup config for a cluster. + type: object + properties: + fixedFrequencySchedule: + description: Optional. Trigger automated backups at a fixed frequency. + $ref: '#/components/schemas/FixedFrequencySchedule' + automatedBackupMode: + description: >- + Optional. The automated backup mode. If the mode is disabled, the + other fields will be ignored. + type: string + enumDescriptions: + - Default value. Automated backup config is not specified. + - Automated backup config disabled. + - Automated backup config enabled. + enum: + - AUTOMATED_BACKUP_MODE_UNSPECIFIED + - DISABLED + - ENABLED + retention: + description: >- + Optional. How long to keep automated backups before the backups are + deleted. The value should be between 1 day and 365 days. If not + specified, the default value is 35 days. + type: string + format: google-duration + FixedFrequencySchedule: + id: FixedFrequencySchedule + description: >- + This schedule allows the backup to be triggered at a fixed frequency + (currently only daily is supported). + type: object + properties: + startTime: + description: >- + Required. The start time of every automated backup in UTC. It must + be set to the start of an hour. This field is required. + $ref: '#/components/schemas/TimeOfDay' + EncryptionInfo: + id: EncryptionInfo + description: >- + EncryptionInfo describes the encryption information of a cluster or a + backup. + type: object + properties: + encryptionType: + description: Output only. Type of encryption. + readOnly: true + type: string + enumDescriptions: + - >- + Encryption type not specified. Defaults to + GOOGLE_DEFAULT_ENCRYPTION. + - >- + The data is encrypted at rest with a key that is fully managed by + Google. No key version will be populated. This is the default + state. + - >- + The data is encrypted at rest with a key that is managed by the + customer. KMS key versions will be populated. + enum: + - TYPE_UNSPECIFIED + - GOOGLE_DEFAULT_ENCRYPTION + - CUSTOMER_MANAGED_ENCRYPTION + kmsKeyVersions: + description: >- + Output only. KMS key versions that are being used to protect the + data at-rest. + readOnly: true + type: array + items: + type: string + kmsKeyPrimaryState: + description: >- + Output only. The state of the primary version of the KMS key + perceived by the system. This field is not populated in backups. + readOnly: true + type: string + enumDescriptions: + - The default value. This value is unused. + - The KMS key is enabled and correctly configured. + - Permission denied on the KMS key. + - The KMS key is disabled. + - The KMS key is destroyed. + - The KMS key is scheduled to be destroyed. + - The EKM key is unreachable. + - Billing is disabled for the project. + - All other unknown failures. + enum: + - KMS_KEY_STATE_UNSPECIFIED + - ENABLED + - PERMISSION_DENIED + - DISABLED + - DESTROYED + - DESTROY_SCHEDULED + - EKM_KEY_UNREACHABLE_DETECTED + - BILLING_DISABLED + - UNKNOWN_FAILURE + lastUpdateTime: + description: >- + Output only. The most recent time when the encryption info was + updated. + readOnly: true + type: string + format: google-datetime CertificateAuthority: id: CertificateAuthority description: Redis cluster certificate authority @@ -970,25 +1276,25 @@ components: `2012-11-15T16:19:00.094Z`. type: string format: google-datetime - ListInstancesResponse: - id: ListInstancesResponse - description: Response for ListInstances. + ListBackupCollectionsResponse: + id: ListBackupCollectionsResponse + description: Response for [ListBackupCollections]. type: object properties: - instances: - description: >- - A list of Redis instances in the project in the specified location, - or across all locations. If the `location_id` in the parent field of - the request is "-", all regions available to the project are - queried, and the results aggregated. If in such an aggregated query - a location is unavailable, a placeholder Redis entry is included in - the response with the `name` field set to a value of the form - `projects/{project_id}/locations/{location_id}/instances/`- and the - `status` field set to ERROR and `status_message` field set to - "location not available for ListInstances". + backupCollections: + description: >- + A list of backupCollections in the project. If the `location_id` in + the parent field of the request is "-", all regions available to the + project are queried, and the results aggregated. If in such an + aggregated query a location is unavailable, a placeholder + backupCollection entry is included in the response with the `name` + field set to a value of the form + `projects/{project_id}/locations/{location_id}/backupCollections/`- + and the `status` field set to ERROR and `status_message` field set + to "location not available for ListBackupCollections". type: array items: - $ref: '#/components/schemas/Instance' + $ref: '#/components/schemas/BackupCollection' nextPageToken: description: >- Token to retrieve the next page of results, or empty if there are no @@ -999,100 +1305,354 @@ components: type: array items: type: string - Instance: - id: Instance - description: A Memorystore for Redis instance. + BackupCollection: + id: BackupCollection + description: BackupCollection of a cluster. type: object properties: name: - description: >- - Required. Unique name of the resource in this scope including - project and location using the form: - `projects/{project_id}/locations/{location_id}/instances/{instance_id}` - Note: Redis instances are managed and addressed at regional level so - location_id here refers to a GCP region; however, users may choose - which specific zone (or collection of zones for cross-zone - instances) an instance should be provisioned in. Refer to - location_id and alternative_location_id fields for more details. - type: string - displayName: - description: An arbitrary and optional user-provided name for the instance. - type: string - labels: - description: Resource labels to represent user provided metadata - type: object - additionalProperties: - type: string - locationId: - description: >- - Optional. The zone where the instance will be provisioned. If not - provided, the service will choose a zone from the specified region - for the instance. For standard tier, additional nodes will be added - across multiple zones for protection against zonal failures. If - specified, at least one node will be provisioned in this zone. - type: string - alternativeLocationId: - description: >- - Optional. If specified, at least one node will be provisioned in - this zone in addition to the zone specified in location_id. Only - applicable to standard tier. If provided, it must be a different - zone from the one provided in [location_id]. Additional nodes beyond - the first 2 will be placed in zones selected by the service. - type: string - redisVersion: - description: >- - Optional. The version of Redis software. If not provided, latest - supported version will be used. Currently, the supported values are: - * `REDIS_3_2` for Redis 3.2 compatibility * `REDIS_4_0` for Redis - 4.0 compatibility (default) * `REDIS_5_0` for Redis 5.0 - compatibility * `REDIS_6_X` for Redis 6.x compatibility * - `REDIS_7_0` for Redis 7.0 compatibility + description: Identifier. Full resource path of the backup collection. type: string - reservedIpRange: - description: >- - Optional. For DIRECT_PEERING mode, the CIDR range of internal - addresses that are reserved for this instance. Range must be unique - and non-overlapping with existing subnets in an authorized network. - For PRIVATE_SERVICE_ACCESS mode, the name of one allocated IP - address ranges associated with this private service access - connection. If not provided, the service will choose an unused /29 - block, for example, 10.0.0.0/29 or 192.168.0.0/29. For - READ_REPLICAS_ENABLED the default block size is /28. + clusterUid: + description: Output only. The cluster uid of the backup collection. + readOnly: true type: string - secondaryIpRange: + cluster: description: >- - Optional. Additional IP range for node placement. Required when - enabling read replicas on an existing instance. For DIRECT_PEERING - mode value must be a CIDR range of size /28, or "auto". For - PRIVATE_SERVICE_ACCESS mode value must be the name of an allocated - address range associated with the private service access connection, - or "auto". + Output only. The full resource path of the cluster the backup + collection belongs to. Example: + projects/{project}/locations/{location}/clusters/{cluster} + readOnly: true type: string - host: + kmsKey: description: >- - Output only. Hostname or IP address of the exposed Redis endpoint - used by clients to connect to the service. + Output only. The KMS key used to encrypt the backups under this + backup collection. readOnly: true type: string - port: - description: Output only. The port number of the exposed Redis endpoint. - readOnly: true - type: integer - format: int32 - currentLocationId: + uid: description: >- - Output only. The current zone where the Redis primary node is - located. In basic tier, this will always be the same as - [location_id]. In standard tier, this can be the zone of any node in - the instance. + Output only. System assigned unique identifier of the backup + collection. readOnly: true type: string createTime: - description: Output only. The time the instance was created. + description: Output only. The time when the backup collection was created. readOnly: true type: string format: google-datetime - state: + totalBackupSizeBytes: + description: Output only. Total size of all backups in the backup collection. + readOnly: true + type: string + format: int64 + totalBackupCount: + description: Output only. Total number of backups in the backup collection. + readOnly: true + type: string + format: int64 + lastBackupTime: + description: >- + Output only. The last time a backup was created in the backup + collection. + readOnly: true + type: string + format: google-datetime + ListBackupsResponse: + id: ListBackupsResponse + description: Response for [ListBackups]. + type: object + properties: + backups: + description: A list of backups in the project. + type: array + items: + $ref: '#/components/schemas/Backup' + nextPageToken: + description: >- + Token to retrieve the next page of results, or empty if there are no + more results in the list. + type: string + unreachable: + description: Backups that could not be reached. + type: array + items: + type: string + Backup: + id: Backup + description: Backup of a cluster. + type: object + properties: + name: + description: >- + Identifier. Full resource path of the backup. the last part of the + name is the backup id with the following format: + [YYYYMMDDHHMMSS]_[Shorted Cluster UID] OR customer specified while + backup cluster. Example: 20240515123000_1234 + type: string + createTime: + description: Output only. The time when the backup was created. + readOnly: true + type: string + format: google-datetime + cluster: + description: Output only. Cluster resource path of this backup. + readOnly: true + type: string + clusterUid: + description: Output only. Cluster uid of this backup. + readOnly: true + type: string + totalSizeBytes: + description: Output only. Total size of the backup in bytes. + readOnly: true + type: string + format: int64 + expireTime: + description: Output only. The time when the backup will expire. + readOnly: true + type: string + format: google-datetime + engineVersion: + description: Output only. redis-7.2, valkey-7.5 + readOnly: true + type: string + backupFiles: + description: Output only. List of backup files of the backup. + readOnly: true + type: array + items: + $ref: '#/components/schemas/BackupFile' + nodeType: + description: Output only. Node type of the cluster. + readOnly: true + type: string + enumDescriptions: + - Node type unspecified + - Redis shared core nano node_type. + - Redis highmem medium node_type. + - Redis highmem xlarge node_type. + - Redis standard small node_type. + enum: + - NODE_TYPE_UNSPECIFIED + - REDIS_SHARED_CORE_NANO + - REDIS_HIGHMEM_MEDIUM + - REDIS_HIGHMEM_XLARGE + - REDIS_STANDARD_SMALL + replicaCount: + description: Output only. Number of replicas for the cluster. + readOnly: true + type: integer + format: int32 + shardCount: + description: Output only. Number of shards for the cluster. + readOnly: true + type: integer + format: int32 + backupType: + description: Output only. Type of the backup. + readOnly: true + type: string + enumDescriptions: + - The default value, not set. + - On-demand backup. + - Automated backup. + enum: + - BACKUP_TYPE_UNSPECIFIED + - ON_DEMAND + - AUTOMATED + state: + description: Output only. State of the backup. + readOnly: true + type: string + enumDescriptions: + - The default value, not set. + - The backup is being created. + - The backup is active to be used. + - The backup is being deleted. + - >- + The backup is currently suspended due to reasons like project + deletion, billing account closure, etc. + enum: + - STATE_UNSPECIFIED + - CREATING + - ACTIVE + - DELETING + - SUSPENDED + encryptionInfo: + description: Output only. Encryption information of the backup. + readOnly: true + $ref: '#/components/schemas/EncryptionInfo' + uid: + description: Output only. System assigned unique identifier of the backup. + readOnly: true + type: string + BackupFile: + id: BackupFile + description: Backup is consisted of multiple backup files. + type: object + properties: + fileName: + description: 'Output only. e.g: .rdb' + readOnly: true + type: string + sizeBytes: + description: Output only. Size of the backup file in bytes. + readOnly: true + type: string + format: int64 + createTime: + description: Output only. The time when the backup file was created. + readOnly: true + type: string + format: google-datetime + ExportBackupRequest: + id: ExportBackupRequest + description: Request for [ExportBackup]. + type: object + properties: + gcsBucket: + description: Google Cloud Storage bucket, like "my-bucket". + type: string + BackupClusterRequest: + id: BackupClusterRequest + description: Request for [BackupCluster]. + type: object + properties: + ttl: + description: >- + Optional. TTL for the backup to expire. Value range is 1 day to 100 + years. If not specified, the default value is 100 years. + type: string + format: google-duration + backupId: + description: >- + Optional. The id of the backup to be created. If not specified, the + default value ([YYYYMMDDHHMMSS]_[Shortened Cluster UID] is used. + type: string + ListInstancesResponse: + id: ListInstancesResponse + description: Response for ListInstances. + type: object + properties: + instances: + description: >- + A list of Redis instances in the project in the specified location, + or across all locations. If the `location_id` in the parent field of + the request is "-", all regions available to the project are + queried, and the results aggregated. If in such an aggregated query + a location is unavailable, a placeholder Redis entry is included in + the response with the `name` field set to a value of the form + `projects/{project_id}/locations/{location_id}/instances/`- and the + `status` field set to ERROR and `status_message` field set to + "location not available for ListInstances". + type: array + items: + $ref: '#/components/schemas/Instance' + nextPageToken: + description: >- + Token to retrieve the next page of results, or empty if there are no + more results in the list. + type: string + unreachable: + description: Locations that could not be reached. + type: array + items: + type: string + Instance: + id: Instance + description: A Memorystore for Redis instance. + type: object + properties: + name: + description: >- + Required. Unique name of the resource in this scope including + project and location using the form: + `projects/{project_id}/locations/{location_id}/instances/{instance_id}` + Note: Redis instances are managed and addressed at regional level so + location_id here refers to a GCP region; however, users may choose + which specific zone (or collection of zones for cross-zone + instances) an instance should be provisioned in. Refer to + location_id and alternative_location_id fields for more details. + type: string + displayName: + description: An arbitrary and optional user-provided name for the instance. + type: string + labels: + description: Resource labels to represent user provided metadata + type: object + additionalProperties: + type: string + locationId: + description: >- + Optional. The zone where the instance will be provisioned. If not + provided, the service will choose a zone from the specified region + for the instance. For standard tier, additional nodes will be added + across multiple zones for protection against zonal failures. If + specified, at least one node will be provisioned in this zone. + type: string + alternativeLocationId: + description: >- + Optional. If specified, at least one node will be provisioned in + this zone in addition to the zone specified in location_id. Only + applicable to standard tier. If provided, it must be a different + zone from the one provided in [location_id]. Additional nodes beyond + the first 2 will be placed in zones selected by the service. + type: string + redisVersion: + description: >- + Optional. The version of Redis software. If not provided, the + default version will be used. Currently, the supported values are: * + `REDIS_3_2` for Redis 3.2 compatibility * `REDIS_4_0` for Redis 4.0 + compatibility * `REDIS_5_0` for Redis 5.0 compatibility * + `REDIS_6_X` for Redis 6.x compatibility * `REDIS_7_0` for Redis 7.0 + compatibility (default) * `REDIS_7_2` for Redis 7.2 compatibility + type: string + reservedIpRange: + description: >- + Optional. For DIRECT_PEERING mode, the CIDR range of internal + addresses that are reserved for this instance. Range must be unique + and non-overlapping with existing subnets in an authorized network. + For PRIVATE_SERVICE_ACCESS mode, the name of one allocated IP + address ranges associated with this private service access + connection. If not provided, the service will choose an unused /29 + block, for example, 10.0.0.0/29 or 192.168.0.0/29. For + READ_REPLICAS_ENABLED the default block size is /28. + type: string + secondaryIpRange: + description: >- + Optional. Additional IP range for node placement. Required when + enabling read replicas on an existing instance. For DIRECT_PEERING + mode value must be a CIDR range of size /28, or "auto". For + PRIVATE_SERVICE_ACCESS mode value must be the name of an allocated + address range associated with the private service access connection, + or "auto". + type: string + host: + description: >- + Output only. Hostname or IP address of the exposed Redis endpoint + used by clients to connect to the service. + readOnly: true + type: string + port: + description: Output only. The port number of the exposed Redis endpoint. + readOnly: true + type: integer + format: int32 + currentLocationId: + description: >- + Output only. The current zone where the Redis primary node is + located. In basic tier, this will always be the same as + [location_id]. In standard tier, this can be the zone of any node in + the instance. + readOnly: true + type: string + createTime: + description: Output only. The time the instance was created. + readOnly: true + type: string + format: google-datetime + state: description: Output only. The current state of this instance. readOnly: true type: string @@ -1311,6 +1871,14 @@ components: description: Optional. Output only. Reserved for future use. readOnly: true type: boolean + tags: + description: >- + Optional. Input only. Immutable. Tag keys/values directly bound to + this resource. For example: "123/environment": "production", + "123/costCenter": "marketing" + type: object + additionalProperties: + type: string TlsCertificate: id: TlsCertificate description: TlsCertificate Resource @@ -1668,7 +2236,8 @@ components: id: DatabaseResourceFeed description: >- DatabaseResourceFeed is the top level proto to be used to ingest - different database resource level events into Condor platform. + different database resource level events into Condor platform. Next ID: + 11 type: object properties: resourceId: @@ -1690,12 +2259,16 @@ components: - Database resource monitoring data - Database resource security health signal data - Database resource recommendation signal data + - Database config based signal data + - Database resource metadata from BackupDR enum: - FEEDTYPE_UNSPECIFIED - RESOURCE_METADATA - OBSERVABILITY_DATA - SECURITY_FINDING_DATA - RECOMMENDATION_SIGNAL_DATA + - CONFIG_BASED_SIGNAL_DATA + - BACKUPDR_METADATA resourceMetadata: $ref: '#/components/schemas/DatabaseResourceMetadata' resourceHealthSignalData: @@ -1704,6 +2277,22 @@ components: $ref: '#/components/schemas/DatabaseResourceRecommendationSignalData' observabilityMetricData: $ref: '#/components/schemas/ObservabilityMetricData' + configBasedSignalData: + description: >- + Config based signal data is used to ingest signals that are + generated based on the configuration of the database resource. + $ref: '#/components/schemas/ConfigBasedSignalData' + backupdrMetadata: + description: BackupDR metadata is used to ingest metadata from BackupDR. + $ref: '#/components/schemas/BackupDRMetadata' + skipIngestion: + description: >- + Optional. If true, the feed won't be ingested by DB Center. This + indicates that the feed is intentionally skipped. For example, + BackupDR feeds are only needed for resources integrated with DB + Center (e.g., CloudSQL, AlloyDB). Feeds for non-integrated resources + (e.g., Compute Engine, Persistent Disk) can be skipped. + type: boolean DatabaseResourceId: id: DatabaseResourceId description: >- @@ -1748,17 +2337,22 @@ components: resourceType: description: >- Required. The type of resource this ID is identifying. Ex + go/keep-sorted start alloydb.googleapis.com/Cluster, + alloydb.googleapis.com/Instance, + bigtableadmin.googleapis.com/Cluster, + bigtableadmin.googleapis.com/Instance + compute.googleapis.com/Instance firestore.googleapis.com/Database, redis.googleapis.com/Instance, redis.googleapis.com/Cluster, - alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, + oracledatabase.googleapis.com/CloudExadataInfrastructure + oracledatabase.googleapis.com/CloudVmCluster + oracledatabase.googleapis.com/AutonomousDatabase spanner.googleapis.com/Instance, spanner.googleapis.com/Database, - firestore.googleapis.com/Database, sqladmin.googleapis.com/Instance, - bigtableadmin.googleapis.com/Cluster, - bigtableadmin.googleapis.com/Instance REQUIRED Please refer - go/condor-common-datamodel + sqladmin.googleapis.com/Instance, go/keep-sorted end REQUIRED Please + refer go/condor-common-datamodel type: string DatabaseResourceMetadata: id: DatabaseResourceMetadata - description: 'Common model for database resource instance metadata. Next ID: 23' + description: 'Common model for database resource instance metadata. Next ID: 26' type: object properties: id: @@ -1848,7 +2442,7 @@ components: description: The type of the instance. Specified at creation time. type: string enumDescriptions: - - '' + - Unspecified. - For rest of the other categories. - A regular primary database instance. - A cluster or an instance acting as a secondary. @@ -1857,6 +2451,7 @@ components: - A regular primary database instance. - A cluster or an instance acting as a secondary. - An instance acting as a read-replica. + - An instance acting as an external primary. - For rest of the other categories. enumDeprecated: - true @@ -1869,6 +2464,7 @@ components: - false - false - false + - false enum: - INSTANCE_TYPE_UNSPECIFIED - SUB_RESOURCE_TYPE_UNSPECIFIED @@ -1879,6 +2475,7 @@ components: - SUB_RESOURCE_TYPE_PRIMARY - SUB_RESOURCE_TYPE_SECONDARY - SUB_RESOURCE_TYPE_READ_REPLICA + - SUB_RESOURCE_TYPE_EXTERNAL_PRIMARY - SUB_RESOURCE_TYPE_OTHER product: description: The product this resource represents. @@ -1923,6 +2520,32 @@ components: - EDITION_UNSPECIFIED - EDITION_ENTERPRISE - EDITION_ENTERPRISE_PLUS + suspensionReason: + description: Optional. Suspension reason for the resource. + type: string + enumDescriptions: + - Suspension reason is unspecified. + - Wipeout hide event. + - Wipeout purge event. + - Billing disabled for project + - Abuse detected for resource + - Encryption key inaccessible. + - Replicated cluster encryption key inaccessible. + enum: + - SUSPENSION_REASON_UNSPECIFIED + - WIPEOUT_HIDE_EVENT + - WIPEOUT_PURGE_EVENT + - BILLING_DISABLED + - ABUSER_DETECTED + - ENCRYPTION_KEY_INACCESSIBLE + - REPLICATED_CLUSTER_ENCRYPTION_KEY_INACCESSIBLE + gcbdrConfiguration: + description: GCBDR configuration for the resource. + deprecated: true + $ref: '#/components/schemas/GCBDRConfiguration' + backupdrConfiguration: + description: Optional. BackupDR Configuration for the resource. + $ref: '#/components/schemas/BackupDRConfiguration' Product: id: Product description: Product specification for Condor resources. @@ -1944,10 +2567,12 @@ components: - On premises database product. - Memorystore product area in GCP - Bigtable product area in GCP + - Firestore product area in GCP. + - Compute Engine self managed databases + - Oracle product area in GCP - >- Other refers to rest of other product type. This is to be when product type is known, but it is not present in this enum. - - Firestore product area in GCP. enumDeprecated: - false - false @@ -1961,6 +2586,8 @@ components: - false - false - false + - false + - false enum: - PRODUCT_TYPE_UNSPECIFIED - PRODUCT_TYPE_CLOUD_SQL @@ -1972,8 +2599,10 @@ components: - ON_PREM - PRODUCT_TYPE_MEMORYSTORE - PRODUCT_TYPE_BIGTABLE - - PRODUCT_TYPE_OTHER - PRODUCT_TYPE_FIRESTORE + - PRODUCT_TYPE_COMPUTE_ENGINE + - PRODUCT_TYPE_ORACLE_ON_GCP + - PRODUCT_TYPE_OTHER engine: description: The specific engine that the underlying database is running. type: string @@ -1996,6 +2625,9 @@ components: engine is known, but it is not present in this enum. - Firestore with native mode. - Firestore with datastore mode. + - Firestore with MongoDB compatibility mode. + - Oracle Exadata engine. + - Oracle Autonomous DB Serverless engine. enumDeprecated: - false - false @@ -2013,6 +2645,9 @@ components: - false - false - false + - false + - false + - false enum: - ENGINE_UNSPECIFIED - ENGINE_MYSQL @@ -2030,12 +2665,21 @@ components: - ENGINE_OTHER - ENGINE_FIRESTORE_WITH_NATIVE_MODE - ENGINE_FIRESTORE_WITH_DATASTORE_MODE + - ENGINE_FIRESTORE_WITH_MONGODB_COMPATIBILITY_MODE + - ENGINE_EXADATA_ORACLE + - ENGINE_ADB_SERVERLESS_ORACLE version: description: >- Version of the underlying database engine. Example values: For MySQL, it could be "8.0", "5.7" etc.. For Postgres, it could be "14", "15" etc.. type: string + minorVersion: + description: >- + Minor version of the underlying database engine. Example values: For + MySQL, it could be "8.0.32", "5.7.32" etc.. For Postgres, it could + be "14.3", "15.3" etc.. + type: string AvailabilityConfiguration: id: AvailabilityConfiguration description: Configuration for availability of database instance @@ -2121,6 +2765,7 @@ components: - DURATION - RETENTION_UNIT_OTHER timeBasedRetention: + deprecated: true type: string format: google-duration quantityBasedRetention: @@ -2238,6 +2883,9 @@ components: backupRun: description: Information about the last backup attempt for this database $ref: '#/components/schemas/BackupRun' + isDeletionProtectionEnabled: + description: Whether deletion protection is enabled for this internal resource. + type: boolean Entitlement: id: Entitlement description: >- @@ -2249,11 +2897,24 @@ components: description: An enum that represents the type of this entitlement. type: string enumDescriptions: - - '' - - The root entitlement representing Gemini package ownership. + - The entitlement type is unspecified. + - >- + The root entitlement representing Gemini package ownership.This + will no longer be supported in the future. + - >- + The entitlement representing Native Tier, This will be the default + Entitlement going forward with GCA Enablement. + - The entitlement representing GCA-Standard Tier. + enumDeprecated: + - false + - true + - false + - false enum: - ENTITLEMENT_TYPE_UNSPECIFIED - GEMINI + - NATIVE + - GCA_STANDARD entitlementState: description: The current state of user's accessibility to a feature/benefit. type: string @@ -2291,20 +2952,27 @@ components: properties: cpuCount: description: >- - The number of CPUs. TODO(b/342344482, b/342346271) add proto - validations again after bug fix. + The number of CPUs. Deprecated. Use vcpu_count instead. + TODO(b/342344482) add proto validations again after bug fix. + deprecated: true type: integer format: int32 memorySizeInBytes: description: >- - Memory size in bytes. TODO(b/342344482, b/342346271) add proto - validations again after bug fix. + Memory size in bytes. TODO(b/342344482) add proto validations again + after bug fix. type: string format: int64 shardCount: description: Optional. Number of shards (if applicable). type: integer format: int32 + vcpuCount: + description: >- + Optional. The number of vCPUs. TODO(b/342344482) add proto + validations again after bug fix. + type: number + format: double Tags: id: Tags description: >- @@ -2318,6 +2986,24 @@ components: type: object additionalProperties: type: string + GCBDRConfiguration: + id: GCBDRConfiguration + description: GCBDR Configuration for the resource. + type: object + properties: + gcbdrManaged: + description: Whether the resource is managed by GCBDR. + type: boolean + BackupDRConfiguration: + id: BackupDRConfiguration + description: >- + BackupDRConfiguration to capture the backup and disaster recovery + details of database resource. + type: object + properties: + backupdrManaged: + description: Indicates if the resource is managed by BackupDR. + type: boolean DatabaseResourceHealthSignalData: id: DatabaseResourceHealthSignalData description: Common model for database resource health signal data. @@ -2644,12 +3330,70 @@ components: Detects if database instance data exported to a Cloud Storage bucket that is owned by the organization and is publicly accessible. + - >- + Detects if a database instance is using a weak password hash + algorithm. + - Detects if a database instance has no user password policy set. + - Detects if a database instance/cluster has a hot node. + - >- + Detects if a database instance has no point in time recovery + enabled. + - Detects if a database instance/cluster is suspended. + - >- + Detects that expensive commands are being run on a database + instance impacting overall performance. + - >- + Indicates that the instance does not have a maintenance policy + configured. + - Deletion Protection Disabled for the resource + - Indicates that the instance has inefficient queries detected. + - Indicates that the instance has read intensive workload. + - Indicates that the instance is nearing memory limit. + - >- + Indicates that the instance's max server memory is configured + higher than the recommended value. + - >- + Indicates that the database has large rows beyond the recommended + limit. + - Heavy write pressure on the database rows. + - Heavy read pressure on the database rows. + - Encryption org policy not satisfied. + - Location org policy not satisfied. + - Outdated DB minor version. + - Schema not optimized. + - High number of idle connections. + - Replication delay. + - Outdated version. + - Outdated client. enumDeprecated: - false - false - false - true - true + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false - false - false - false @@ -2804,6 +3548,34 @@ components: - SIGNAL_TYPE_USER_GRANTED_ALL_PERMISSIONS - SIGNAL_TYPE_DATA_EXPORT_TO_EXTERNAL_CLOUD_STORAGE_BUCKET - SIGNAL_TYPE_DATA_EXPORT_TO_PUBLIC_CLOUD_STORAGE_BUCKET + - SIGNAL_TYPE_WEAK_PASSWORD_HASH_ALGORITHM + - SIGNAL_TYPE_NO_USER_PASSWORD_POLICY + - SIGNAL_TYPE_HOT_NODE + - SIGNAL_TYPE_NO_POINT_IN_TIME_RECOVERY + - SIGNAL_TYPE_RESOURCE_SUSPENDED + - SIGNAL_TYPE_EXPENSIVE_COMMANDS + - SIGNAL_TYPE_NO_MAINTENANCE_POLICY_CONFIGURED + - SIGNAL_TYPE_NO_DELETION_PROTECTION + - SIGNAL_TYPE_INEFFICIENT_QUERY + - SIGNAL_TYPE_READ_INTENSIVE_WORKLOAD + - SIGNAL_TYPE_MEMORY_LIMIT + - SIGNAL_TYPE_MAX_SERVER_MEMORY + - SIGNAL_TYPE_LARGE_ROWS + - SIGNAL_TYPE_HIGH_WRITE_PRESSURE + - SIGNAL_TYPE_HIGH_READ_PRESSURE + - SIGNAL_TYPE_ENCRYPTION_ORG_POLICY_NOT_SATISFIED + - SIGNAL_TYPE_LOCATION_ORG_POLICY_NOT_SATISFIED + - SIGNAL_TYPE_OUTDATED_MINOR_VERSION + - SIGNAL_TYPE_SCHEMA_NOT_OPTIMIZED + - SIGNAL_TYPE_MANY_IDLE_CONNECTIONS + - SIGNAL_TYPE_REPLICATION_LAG + - SIGNAL_TYPE_OUTDATED_VERSION + - SIGNAL_TYPE_OUTDATED_CLIENT + location: + description: >- + This is used to identify the location of the resource. Example: + "us-central1" + type: string Compliance: id: Compliance description: >- @@ -3002,12 +3774,70 @@ components: Detects if database instance data exported to a Cloud Storage bucket that is owned by the organization and is publicly accessible. + - >- + Detects if a database instance is using a weak password hash + algorithm. + - Detects if a database instance has no user password policy set. + - Detects if a database instance/cluster has a hot node. + - >- + Detects if a database instance has no point in time recovery + enabled. + - Detects if a database instance/cluster is suspended. + - >- + Detects that expensive commands are being run on a database + instance impacting overall performance. + - >- + Indicates that the instance does not have a maintenance policy + configured. + - Deletion Protection Disabled for the resource + - Indicates that the instance has inefficient queries detected. + - Indicates that the instance has read intensive workload. + - Indicates that the instance is nearing memory limit. + - >- + Indicates that the instance's max server memory is configured + higher than the recommended value. + - >- + Indicates that the database has large rows beyond the recommended + limit. + - Heavy write pressure on the database rows. + - Heavy read pressure on the database rows. + - Encryption org policy not satisfied. + - Location org policy not satisfied. + - Outdated DB minor version. + - Schema not optimized. + - High number of idle connections. + - Replication delay. + - Outdated version. + - Outdated client. enumDeprecated: - false - false - false - true - true + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false - false - false - false @@ -3162,6 +3992,29 @@ components: - SIGNAL_TYPE_USER_GRANTED_ALL_PERMISSIONS - SIGNAL_TYPE_DATA_EXPORT_TO_EXTERNAL_CLOUD_STORAGE_BUCKET - SIGNAL_TYPE_DATA_EXPORT_TO_PUBLIC_CLOUD_STORAGE_BUCKET + - SIGNAL_TYPE_WEAK_PASSWORD_HASH_ALGORITHM + - SIGNAL_TYPE_NO_USER_PASSWORD_POLICY + - SIGNAL_TYPE_HOT_NODE + - SIGNAL_TYPE_NO_POINT_IN_TIME_RECOVERY + - SIGNAL_TYPE_RESOURCE_SUSPENDED + - SIGNAL_TYPE_EXPENSIVE_COMMANDS + - SIGNAL_TYPE_NO_MAINTENANCE_POLICY_CONFIGURED + - SIGNAL_TYPE_NO_DELETION_PROTECTION + - SIGNAL_TYPE_INEFFICIENT_QUERY + - SIGNAL_TYPE_READ_INTENSIVE_WORKLOAD + - SIGNAL_TYPE_MEMORY_LIMIT + - SIGNAL_TYPE_MAX_SERVER_MEMORY + - SIGNAL_TYPE_LARGE_ROWS + - SIGNAL_TYPE_HIGH_WRITE_PRESSURE + - SIGNAL_TYPE_HIGH_READ_PRESSURE + - SIGNAL_TYPE_ENCRYPTION_ORG_POLICY_NOT_SATISFIED + - SIGNAL_TYPE_LOCATION_ORG_POLICY_NOT_SATISFIED + - SIGNAL_TYPE_OUTDATED_MINOR_VERSION + - SIGNAL_TYPE_SCHEMA_NOT_OPTIMIZED + - SIGNAL_TYPE_MANY_IDLE_CONNECTIONS + - SIGNAL_TYPE_REPLICATION_LAG + - SIGNAL_TYPE_OUTDATED_VERSION + - SIGNAL_TYPE_OUTDATED_CLIENT lastRefreshTime: description: Required. last time recommendationw as refreshed type: string @@ -3251,6 +4104,13 @@ components: Storage utilization for a resource. The value is a fraction between 0.0 and 1.0 (may momentarily exceed 1.0 in some cases). - Sotrage used by a resource. + - >- + Node count for a resource. It represents the number of node units + in a bigtable/spanner instance. + - Memory used by a resource (in bytes). + - >- + Processing units used by a resource. It represents the number of + processing units in a spanner instance. enum: - METRIC_TYPE_UNSPECIFIED - CPU_UTILIZATION @@ -3258,6 +4118,9 @@ components: - NETWORK_CONNECTIONS - STORAGE_UTILIZATION - STORAGE_USED_BYTES + - NODE_COUNT + - MEMORY_USED_BYTES + - PROCESSING_UNIT_COUNT aggregationType: description: Required. Type of aggregation performed on the metric. type: string @@ -3301,6 +4164,74 @@ components: boolValue: description: For boolean value type: boolean + ConfigBasedSignalData: + id: ConfigBasedSignalData + description: >- + Config based signal data. This is used to send signals to Condor which + are based on the DB level configurations. These will be used to send + signals for self managed databases. + type: object + properties: + resourceId: + description: Database resource id. + $ref: '#/components/schemas/DatabaseResourceId' + fullResourceName: + description: Required. Full Resource name of the source resource. + type: string + lastRefreshTime: + description: Required. Last time signal was refreshed + type: string + format: google-datetime + signalType: + description: Required. Signal type of the signal + type: string + enumDescriptions: + - Unspecified signal type. + - Outdated Minor Version + - Represents database auditing is disabled. + - >- + Represents if a database has a password configured for the root + account or not. + - Represents if a resource is exposed to public access. + - >- + Represents if a resources requires all incoming connections to use + SSL or not. + enum: + - SIGNAL_TYPE_UNSPECIFIED + - SIGNAL_TYPE_OUTDATED_MINOR_VERSION + - SIGNAL_TYPE_DATABASE_AUDITING_DISABLED + - SIGNAL_TYPE_NO_ROOT_PASSWORD + - SIGNAL_TYPE_EXPOSED_TO_PUBLIC_ACCESS + - SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS + signalBoolValue: + description: Signal data for boolean signals. + type: boolean + BackupDRMetadata: + id: BackupDRMetadata + description: >- + BackupDRMetadata contains information about the backup and disaster + recovery metadata of a database resource. + type: object + properties: + resourceId: + description: Required. Database resource id. + $ref: '#/components/schemas/DatabaseResourceId' + lastRefreshTime: + description: Required. Last time backup configuration was refreshed. + type: string + format: google-datetime + backupConfiguration: + description: Backup configuration for this instance. + $ref: '#/components/schemas/BackupConfiguration' + backupRun: + description: Latest backup run information for this instance. + $ref: '#/components/schemas/BackupRun' + backupdrConfiguration: + description: BackupDR configuration for this instance. + $ref: '#/components/schemas/BackupDRConfiguration' + fullResourceName: + description: Required. Full resource name of this instance. + type: string OperationMetadata: id: OperationMetadata description: Pre-defined metadata fields. @@ -3594,6 +4525,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + backup: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clusters~1{clustersId}:backup/post + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/clusters/methods/get' @@ -3625,6 +4563,77 @@ components: update: [] replace: [] delete: [] + backup_collections: + id: google.redis.backup_collections + name: backup_collections + title: Backup_collections + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupCollections/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.backupCollections + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupCollections~1{backupCollectionsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/backup_collections/methods/get' + - $ref: '#/components/x-stackQL-resources/backup_collections/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + backups: + id: google.redis.backups + name: backups + title: Backups + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupCollections~1{backupCollectionsId}~1backups/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.backups + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupCollections~1{backupCollectionsId}~1backups~1{backupsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupCollections~1{backupCollectionsId}~1backups~1{backupsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + export: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupCollections~1{backupCollectionsId}~1backups~1{backupsId}:export/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/backups/methods/get' + - $ref: '#/components/x-stackQL-resources/backups/methods/list' + insert: [] + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/backups/methods/delete' instances: id: google.redis.instances name: instances @@ -3780,6 +4789,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: @@ -3934,7 +4947,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: redis.projects.locations.operations.cancel security: - Oauth2: @@ -4242,6 +5255,293 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:backup: + parameters: *ref_1 + post: + description: >- + Backup Redis Cluster. If this is the first time a backup is being + created, a backup collection will be created at the backend, and this + backup belongs to this collection. Both collection and backup will have + a resource name. Backup will be executed for each shard. A replica + (primary if nonHA) will be selected to perform the execution. Backup + call will be rejected if there is an ongoing backup or update operation. + Be aware that during preview, if the cluster's internal software version + is too old, critical update will be performed before actual backup. Once + the internal software version is updated to the minimum version required + by the backup feature, subsequent backups will not require critical + update. After preview, there will be no critical update needed for + backup. + operationId: redis.projects.locations.clusters.backup + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BackupClusterRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/backupCollections: + parameters: *ref_1 + get: + description: >- + Lists all backup collections owned by a consumer project in either the + specified location (region) or all locations. If `location_id` is + specified as `-` (wildcard), then all regions available to the project + are queried, and the results are aggregated. + operationId: redis.projects.locations.backupCollections.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListBackupCollectionsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/backupCollections/{backupCollectionsId}: + parameters: *ref_1 + get: + description: Get a backup collection. + operationId: redis.projects.locations.backupCollections.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/BackupCollection' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: backupCollectionsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/backupCollections/{backupCollectionsId}/backups: + parameters: *ref_1 + get: + description: Lists all backups owned by a backup collection. + operationId: redis.projects.locations.backupCollections.backups.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListBackupsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: backupCollectionsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/backupCollections/{backupCollectionsId}/backups/{backupsId}: + parameters: *ref_1 + get: + description: Gets the details of a specific backup. + operationId: redis.projects.locations.backupCollections.backups.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Backup' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: backupCollectionsId + required: true + schema: + type: string + - in: path + name: backupsId + required: true + schema: + type: string + delete: + description: Deletes a specific backup. + operationId: redis.projects.locations.backupCollections.backups.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: backupCollectionsId + required: true + schema: + type: string + - in: path + name: backupsId + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/backupCollections/{backupCollectionsId}/backups/{backupsId}:export: + parameters: *ref_1 + post: + description: Exports a specific backup to a customer target Cloud Storage URI. + operationId: redis.projects.locations.backupCollections.backups.export + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExportBackupRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: backupCollectionsId + required: true + schema: + type: string + - in: path + name: backupsId + required: true + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/instances: parameters: *ref_1 get: diff --git a/providers/src/googleapis.com/v00.00.00000/services/resourcesettings.yaml b/providers/src/googleapis.com/v00.00.00000/services/resourcesettings.yaml deleted file mode 100644 index b592483d..00000000 --- a/providers/src/googleapis.com/v00.00.00000/services/resourcesettings.yaml +++ /dev/null @@ -1,720 +0,0 @@ -openapi: 3.1.0 -info: - contact: - name: StackQL Studios - url: https://github.com/stackql/google-discovery-to-openapi - email: info@stackql.io - title: Resource Settings API - description: >- - The Resource Settings API allows users to control and modify the behavior of - their GCP resources (e.g., VM, firewall, Project, etc.) across the Cloud - Resource Hierarchy. - version: v1 - x-discovery-doc-revision: '20241103' - x-generated-date: '2024-11-06' -externalDocs: - url: https://cloud.google.com/resource-manager/docs/resource-settings/overview -servers: - - url: https://resourcesettings.googleapis.com -components: - securitySchemes: - Oauth2: - type: oauth2 - description: Oauth 2.0 implicit authentication - flows: - implicit: - authorizationUrl: https://accounts.google.com/o/oauth2/auth - scopes: &ref_0 - 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. - Oauth2c: - type: oauth2 - description: Oauth 2.0 authorization code authentication - flows: - authorizationCode: - authorizationUrl: https://accounts.google.com/o/oauth2/auth - tokenUrl: https://accounts.google.com/o/oauth2/token - scopes: *ref_0 - schemas: - GoogleCloudResourcesettingsV1ListSettingsResponse: - type: object - id: GoogleCloudResourcesettingsV1ListSettingsResponse - properties: - nextPageToken: - description: Unused. A page token used to retrieve the next page. - type: string - settings: - items: - $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Setting' - description: >- - A list of settings that are available at the specified Cloud - resource. - type: array - description: The response from ListSettings. - GoogleCloudResourcesettingsV1Setting: - id: GoogleCloudResourcesettingsV1Setting - properties: - metadata: - $ref: '#/components/schemas/GoogleCloudResourcesettingsV1SettingMetadata' - readOnly: true - description: >- - Output only. Metadata about a setting which is not editable by the - end user. - etag: - description: >- - A fingerprint used for optimistic concurrency. See UpdateSetting for - more details. - type: string - localValue: - description: >- - The configured value of the setting at the given parent resource, - ignoring the resource hierarchy. The data type of Value must always - be consistent with the data type defined in Setting.metadata. - $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Value' - effectiveValue: - $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Value' - readOnly: true - description: >- - Output only. The effective value of the setting at the given parent - resource, evaluated based on the resource hierarchy The effective - value evaluates to one of the following options, in this order. If - an option is not valid or doesn't exist, then the next option is - used: 1. The local setting value on the given resource: - Setting.local_value 2. If one of the given resource's ancestors in - the resource hierarchy have a local setting value, the local value - at the nearest such ancestor. 3. The setting's default value: - SettingMetadata.default_value 4. An empty value, defined as a - `Value` with all fields unset. The data type of Value must always be - consistent with the data type defined in Setting.metadata. - name: - description: >- - The resource name of the setting. Must be in one of the following - forms: * `projects/{project_number}/settings/{setting_name}` * - `folders/{folder_id}/settings/{setting_name}` * - `organizations/{organization_id}/settings/{setting_name}` For - example, "/projects/123/settings/gcp-enableMyFeature" - type: string - description: The schema for settings. - type: object - GoogleCloudResourcesettingsV1SettingMetadata: - properties: - displayName: - type: string - description: The human readable name for this setting. - readOnly: - type: boolean - description: >- - A flag indicating that values of this setting cannot be modified. - See documentation for the specific setting for updates and reasons. - description: - description: A detailed description of what this setting does. - type: string - dataType: - description: The data type for this setting. - enum: - - DATA_TYPE_UNSPECIFIED - - BOOLEAN - - STRING - - STRING_SET - - ENUM_VALUE - - DURATION_VALUE - - STRING_MAP - type: string - enumDescriptions: - - Unspecified data type. - - A boolean setting. - - A string setting. - - A string set setting. - - A Enum setting - - A Duration setting - - A string->string map setting - defaultValue: - $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Value' - description: >- - The value provided by Setting.effective_value if no setting value is - explicitly set. Note: not all settings have a default value. - id: GoogleCloudResourcesettingsV1SettingMetadata - description: Metadata about a setting which is not editable by the end user. - type: object - GoogleCloudResourcesettingsV1ValueStringMap: - id: GoogleCloudResourcesettingsV1ValueStringMap - description: >- - A string->string map value that can hold a map of string keys to string - values. The maximum length of each string is 200 characters and there - can be a maximum of 50 key-value pairs in the map. - type: object - properties: - mappings: - additionalProperties: - type: string - type: object - description: The key-value pairs in the map - GoogleCloudResourcesettingsV1ValueStringSet: - properties: - values: - description: The strings in the set - type: array - items: - type: string - description: >- - A string set value that can hold a set of strings. The maximum length of - each string is 200 characters and there can be a maximum of 50 strings - in the string set. - type: object - id: GoogleCloudResourcesettingsV1ValueStringSet - GoogleCloudResourcesettingsV1ValueEnumValue: - properties: - value: - description: The value of this enum - type: string - id: GoogleCloudResourcesettingsV1ValueEnumValue - description: >- - A enum value that can hold any enum type setting values. Each enum type - is represented by a number, this representation is stored in the - definitions. - type: object - GoogleCloudResourcesettingsV1Value: - type: object - description: The data in a setting value. - id: GoogleCloudResourcesettingsV1Value - properties: - booleanValue: - type: boolean - description: Defines this value as being a boolean value. - stringMapValue: - description: Defines this value as being a StringMap. - $ref: '#/components/schemas/GoogleCloudResourcesettingsV1ValueStringMap' - stringSetValue: - $ref: '#/components/schemas/GoogleCloudResourcesettingsV1ValueStringSet' - description: Defines this value as being a StringSet. - stringValue: - type: string - description: Defines this value as being a string value. - durationValue: - description: Defines this value as being a Duration. - type: string - format: google-duration - enumValue: - description: Defines this value as being a Enum. - $ref: '#/components/schemas/GoogleCloudResourcesettingsV1ValueEnumValue' - parameters: - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - 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 - callback: - description: JSONP - in: query - name: callback - schema: - type: string - alt: - description: Data format for response. - in: query - name: alt - schema: - type: string - enum: - - json - - media - - proto - 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 - _.xgafv: - description: V1 error format. - in: query - name: $.xgafv - schema: - type: string - enum: - - '1' - - '2' - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean - access_token: - description: OAuth access token. - in: query - name: access_token - schema: - type: string - x-stackQL-resources: - settings: - id: google.resourcesettings.settings - name: settings - title: Settings - methods: - projects_settings_list: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1settings/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.settings - projects_settings_patch: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1settings~1{settingsId}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - projects_settings_get: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1settings~1{settingsId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_settings_list: - operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1settings/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.settings - organizations_settings_get: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1settings~1{settingsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_settings_patch: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1settings~1{settingsId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - folders_settings_get: - operation: - $ref: '#/paths/~1v1~1folders~1{foldersId}~1settings~1{settingsId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - folders_settings_patch: - operation: - $ref: '#/paths/~1v1~1folders~1{foldersId}~1settings~1{settingsId}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - folders_settings_list: - operation: - $ref: '#/paths/~1v1~1folders~1{foldersId}~1settings/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.settings - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/settings/methods/projects_settings_get - - $ref: >- - #/components/x-stackQL-resources/settings/methods/organizations_settings_get - - $ref: >- - #/components/x-stackQL-resources/settings/methods/folders_settings_get - - $ref: >- - #/components/x-stackQL-resources/settings/methods/projects_settings_list - - $ref: >- - #/components/x-stackQL-resources/settings/methods/organizations_settings_list - - $ref: >- - #/components/x-stackQL-resources/settings/methods/folders_settings_list - insert: [] - update: - - $ref: >- - #/components/x-stackQL-resources/settings/methods/projects_settings_patch - - $ref: >- - #/components/x-stackQL-resources/settings/methods/organizations_settings_patch - - $ref: >- - #/components/x-stackQL-resources/settings/methods/folders_settings_patch - replace: [] - delete: [] -paths: - /v1/projects/{projectsId}/settings: - parameters: &ref_1 - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/access_token' - get: - description: >- - Lists all the settings that are available on the Cloud resource - `parent`. - operationId: resourcesettings.projects.settings.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudResourcesettingsV1ListSettingsResponse - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: view - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/settings/{settingsId}: - parameters: *ref_1 - patch: - description: >- - Updates a specified setting. Returns a `google.rpc.Status` with - `google.rpc.Code.NOT_FOUND` if the setting does not exist. Returns a - `google.rpc.Status` with `google.rpc.Code.FAILED_PRECONDITION` if the - setting is flagged as read only. Returns a `google.rpc.Status` with - `google.rpc.Code.ABORTED` if the etag supplied in the request does not - match the persisted etag of the setting value. On success, the response - will contain only `name`, `local_value` and `etag`. The `metadata` and - `effective_value` cannot be updated through this API. Note: the supplied - setting will perform a full overwrite of the `local_value` field. - operationId: resourcesettings.projects.settings.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Setting' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Setting' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: settingsId - required: true - schema: - type: string - get: - description: >- - Returns a specified setting. Returns a `google.rpc.Status` with - `google.rpc.Code.NOT_FOUND` if the setting does not exist. - operationId: resourcesettings.projects.settings.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Setting' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: settingsId - required: true - schema: - type: string - - in: query - name: view - schema: - type: string - /v1/organizations/{organizationsId}/settings: - parameters: *ref_1 - get: - description: >- - Lists all the settings that are available on the Cloud resource - `parent`. - operationId: resourcesettings.organizations.settings.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudResourcesettingsV1ListSettingsResponse - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: view - schema: - type: string - /v1/organizations/{organizationsId}/settings/{settingsId}: - parameters: *ref_1 - get: - description: >- - Returns a specified setting. Returns a `google.rpc.Status` with - `google.rpc.Code.NOT_FOUND` if the setting does not exist. - operationId: resourcesettings.organizations.settings.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Setting' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: settingsId - required: true - schema: - type: string - - in: query - name: view - schema: - type: string - patch: - description: >- - Updates a specified setting. Returns a `google.rpc.Status` with - `google.rpc.Code.NOT_FOUND` if the setting does not exist. Returns a - `google.rpc.Status` with `google.rpc.Code.FAILED_PRECONDITION` if the - setting is flagged as read only. Returns a `google.rpc.Status` with - `google.rpc.Code.ABORTED` if the etag supplied in the request does not - match the persisted etag of the setting value. On success, the response - will contain only `name`, `local_value` and `etag`. The `metadata` and - `effective_value` cannot be updated through this API. Note: the supplied - setting will perform a full overwrite of the `local_value` field. - operationId: resourcesettings.organizations.settings.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Setting' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Setting' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: settingsId - required: true - schema: - type: string - /v1/folders/{foldersId}/settings/{settingsId}: - parameters: *ref_1 - get: - description: >- - Returns a specified setting. Returns a `google.rpc.Status` with - `google.rpc.Code.NOT_FOUND` if the setting does not exist. - operationId: resourcesettings.folders.settings.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Setting' - parameters: - - in: path - name: foldersId - required: true - schema: - type: string - - in: path - name: settingsId - required: true - schema: - type: string - - in: query - name: view - schema: - type: string - patch: - description: >- - Updates a specified setting. Returns a `google.rpc.Status` with - `google.rpc.Code.NOT_FOUND` if the setting does not exist. Returns a - `google.rpc.Status` with `google.rpc.Code.FAILED_PRECONDITION` if the - setting is flagged as read only. Returns a `google.rpc.Status` with - `google.rpc.Code.ABORTED` if the etag supplied in the request does not - match the persisted etag of the setting value. On success, the response - will contain only `name`, `local_value` and `etag`. The `metadata` and - `effective_value` cannot be updated through this API. Note: the supplied - setting will perform a full overwrite of the `local_value` field. - operationId: resourcesettings.folders.settings.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Setting' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Setting' - parameters: - - in: path - name: foldersId - required: true - schema: - type: string - - in: path - name: settingsId - required: true - schema: - type: string - /v1/folders/{foldersId}/settings: - parameters: *ref_1 - get: - description: >- - Lists all the settings that are available on the Cloud resource - `parent`. - operationId: resourcesettings.folders.settings.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudResourcesettingsV1ListSettingsResponse - parameters: - - in: path - name: foldersId - required: true - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: view - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 diff --git a/providers/src/googleapis.com/v00.00.00000/services/retail.yaml b/providers/src/googleapis.com/v00.00.00000/services/retail.yaml index b9ce492b..a88723d5 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/retail.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/retail.yaml @@ -4,15 +4,15 @@ info: name: StackQL Studios url: https://github.com/stackql/google-discovery-to-openapi email: info@stackql.io - title: Vertex AI Search for Retail API + title: Vertex AI Search for commerce API description: >- - Vertex AI Search for Retail API is made up of Retail Search, Browse and + Vertex AI Search for commerce API is made up of Retail Search, Browse and Recommendations. These discovery AI solutions help you implement personalized search, browse and recommendations, based on machine learning models, across your websites and mobile applications. version: v2 - x-discovery-doc-revision: '20241024' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250821' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/recommendations servers: @@ -427,7 +427,7 @@ components: partitionDate: description: >- BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD - format. Only supported in ImportProductsRequest. + format. $ref: '#/components/schemas/GoogleTypeDate' projectId: description: >- @@ -535,7 +535,7 @@ components: Product.attributes. - >- At this level, we honor the attribute configurations set in - CatalogConfig.attribute_configs. + `CatalogConfig.attribute_configs`. enum: - ATTRIBUTE_CONFIG_LEVEL_UNSPECIFIED - PRODUCT_LEVEL_ATTRIBUTE_CONFIG @@ -565,8 +565,7 @@ components: products. `True` if at least one Product is using this attribute in Product.attributes. Otherwise, this field is `False`. CatalogAttribute can be pre-loaded by using - CatalogService.AddCatalogAttribute, - CatalogService.ImportCatalogAttributes, or + CatalogService.AddCatalogAttribute or CatalogService.UpdateAttributesConfig APIs. This field is `False` for pre-loaded CatalogAttributes. Only pre-loaded catalog attributes that are neither in use by products nor predefined can be deleted. @@ -1138,6 +1137,42 @@ components: description: Optional. This field specifies tile navigation related parameters. $ref: >- #/components/schemas/GoogleCloudRetailV2SearchRequestTileNavigationSpec + languageCode: + description: >- + Optional. The BCP-47 language code, such as "en-US" or "sr-Latn" + [list](https://www.unicode.org/cldr/charts/46/summary/root.html). + For more information, see [Standardized + codes](https://google.aip.dev/143). This field helps to better + interpret the query. If a value isn't specified, the query language + code is automatically detected, which may not be accurate. + type: string + regionCode: + description: >- + Optional. The Unicode country/region code (CLDR) of a location, such + as "US" and "419" + [list](https://www.unicode.org/cldr/charts/46/supplemental/territory_information.html). + For more information, see [Standardized + codes](https://google.aip.dev/143). If set, then results will be + boosted based on the region_code provided. + type: string + placeId: + description: >- + Optional. An id corresponding to a place, such as a store id or + region id. When specified, we use the price from the local inventory + with the matching product's LocalInventory.place_id for revenue + optimization. + type: string + userAttributes: + description: >- + Optional. The user attributes that could be used for personalization + of search results. * Populate at most 100 key-value pairs per query. + * Only supports string keys and repeated string values. * Duplicate + keys are not allowed within a single query. Example: + user_attributes: [ { key: "pets" value { values: "dog" values: "cat" + } }, { key: "state" value { values: "CA" } } ] + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudRetailV2StringList' GoogleCloudRetailV2UserInfo: id: GoogleCloudRetailV2UserInfo description: Information of an end user. @@ -1165,10 +1200,9 @@ components: type: string userAgent: description: >- - User agent as included in the HTTP header. Required for getting - SearchResponse.sponsored_results. The field must be a UTF-8 encoded - string with a length limit of 1,000 characters. Otherwise, an - INVALID_ARGUMENT error is returned. This should not be set when + User agent as included in the HTTP header. The field must be a UTF-8 + encoded string with a length limit of 1,000 characters. Otherwise, + an INVALID_ARGUMENT error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set. type: string @@ -1381,7 +1415,7 @@ components: conditionBoostSpecs: description: >- Condition boost specifications. If a product matches multiple - conditions in the specifictions, boost scores from these + conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. type: array @@ -1450,9 +1484,9 @@ components: - AUTO pinUnexpandedResults: description: >- - Whether to pin unexpanded results. If this field is set to true, - unexpanded products are always at the top of the search results, - followed by the expanded results. + Whether to pin unexpanded results. The default value is false. If + this field is set to true, unexpanded products are always at the top + of the search results, followed by the expanded results. type: boolean GoogleCloudRetailV2SearchRequestPersonalizationSpec: id: GoogleCloudRetailV2SearchRequestPersonalizationSpec @@ -1593,10 +1627,13 @@ components: type: boolean appliedTiles: description: >- - This field specifies the tiles which are already clicked in client - side. NOTE: This field is not being used for filtering search - products. Client side should also put all the applied tiles in - SearchRequest.filter. + This optional field specifies the tiles which are already clicked in + client side. While the feature works without this field set, + particularly for an initial query, it is highly recommended to set + this field because it can improve the quality of the search response + and removes possible duplicate tiles. NOTE: This field is not being + used for filtering search products. Client side should also put all + the applied tiles in SearchRequest.filter. type: array items: $ref: '#/components/schemas/GoogleCloudRetailV2Tile' @@ -1628,6 +1665,16 @@ components: interval: description: The numeric interval (e.g. [10, 20)) $ref: '#/components/schemas/GoogleCloudRetailV2Interval' + GoogleCloudRetailV2StringList: + id: GoogleCloudRetailV2StringList + description: A list of string values. + type: object + properties: + values: + description: String values. + type: array + items: + type: string GoogleCloudRetailV2SearchResponse: id: GoogleCloudRetailV2SearchResponse description: Response message for SearchService.Search method. @@ -1702,7 +1749,7 @@ components: #/components/schemas/GoogleCloudRetailV2SearchRequestBoostSpecConditionBoostSpec experimentInfo: description: >- - Metadata related to A/B testing Experiment associated with this + Metadata related to A/B testing experiment associated with this response. Only exists when an experiment is triggered. type: array items: @@ -1786,6 +1833,11 @@ components: type: array items: type: string + modelScores: + description: Google provided available scores. + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudRetailV2DoubleList' GoogleCloudRetailV2Product: id: GoogleCloudRetailV2Product description: >- @@ -2408,10 +2460,11 @@ components: GoogleCloudRetailV2Image: id: GoogleCloudRetailV2Image description: >- - Product image. Recommendations AI and Retail Search do not use product - images to improve prediction and search results. However, product images - can be returned in results, and are shown in prediction or search - previews in the console. + Product image. Recommendations AI and Retail Search use product images + to improve prediction and search results. Product images can be returned + in results, and are shown in prediction or search previews in the + console. Please try to provide correct product images and avoid using + images with size too small. type: object properties: uri: @@ -2485,7 +2538,11 @@ components: string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant Center property [color](https://support.google.com/merchants/answer/6324487). - Schema.org property [Product.color](https://schema.org/color). + Schema.org property [Product.color](https://schema.org/color). The + colorFamilies field as a system attribute is not a required field + but strongly recommended to be specified. Google Search models treat + this field as more important than a custom product attribute when + specified. type: array items: type: string @@ -2527,19 +2584,20 @@ components: type: object properties: placeId: - description: The place ID for the current set of inventory information. + description: Optional. The place ID for the current set of inventory information. type: string priceInfo: description: >- - Product price and cost information. Google Merchant Center property + Optional. Product price and cost information. Google Merchant Center + property [price](https://support.google.com/merchants/answer/6324371). $ref: '#/components/schemas/GoogleCloudRetailV2PriceInfo' attributes: description: >- - Additional local inventory attributes, for example, store name, - promotion tags, etc. This field needs to pass all below criteria, - otherwise an INVALID_ARGUMENT error is returned: * At most 30 - attributes are allowed. * The key must be a UTF-8 encoded string + Optional. Additional local inventory attributes, for example, store + name, promotion tags, etc. This field needs to pass all below + criteria, otherwise an INVALID_ARGUMENT error is returned: * At most + 30 attributes are allowed. * The key must be a UTF-8 encoded string with a length limit of 32 characters. * The key must match the pattern: `a-zA-Z0-9*`. For example, key0LikeThis or KEY_1_LIKE_THIS. * The attribute values must be of the same type (text or number). * @@ -2553,10 +2611,10 @@ components: $ref: '#/components/schemas/GoogleCloudRetailV2CustomAttribute' fulfillmentTypes: description: >- - Input only. Supported fulfillment types. Valid fulfillment type - values include commonly used types (such as pickup in store and same - day delivery), and custom types. Customers have to map custom types - to their display names before rendering UI. Supported values: * + Optional. Supported fulfillment types. Valid fulfillment type values + include commonly used types (such as pickup in store and same day + delivery), and custom types. Customers have to map custom types to + their display names before rendering UI. Supported values: * "pickup-in-store" * "ship-to-store" * "same-day-delivery" * "next-day-delivery" * "custom-type-1" * "custom-type-2" * "custom-type-3" * "custom-type-4" * "custom-type-5" If this field is @@ -2566,6 +2624,17 @@ components: type: array items: type: string + GoogleCloudRetailV2DoubleList: + id: GoogleCloudRetailV2DoubleList + description: A message with a list of double values. + type: object + properties: + values: + description: The list of double values. + type: array + items: + type: number + format: double GoogleCloudRetailV2SearchResponseFacet: id: GoogleCloudRetailV2SearchResponseFacet description: A facet result. @@ -2664,7 +2733,7 @@ components: type: string GoogleCloudRetailV2ExperimentInfo: id: GoogleCloudRetailV2ExperimentInfo - description: Metadata for active A/B testing Experiment. + description: Metadata for active A/B testing experiment. type: object properties: servingConfigExperiment: @@ -2693,7 +2762,7 @@ components: experimentServingConfig: description: >- The fully qualified resource name of the serving config - Experiment.VariantArm.serving_config_id responsible for generating + `Experiment.VariantArm.serving_config_id` responsible for generating the search response. For example: `projects/*/locations/*/catalogs/*/servingConfigs/*`. type: string @@ -2826,7 +2895,7 @@ components: attributeResults: description: >- A map of matched attribute suggestions. This field is only available - for "cloud-retail" dataset. Current supported keys: * `brands` * + for `cloud-retail` dataset. Current supported keys: * `brands` * `categories` type: object additionalProperties: @@ -2842,9 +2911,9 @@ components: type: string attributes: description: >- - Custom attributes for the suggestion term. * For "user-data", the + Custom attributes for the suggestion term. * For `user-data`, the attributes are additional custom attributes ingested through - BigQuery. * For "cloud-retail", the attributes are product + BigQuery. * For `cloud-retail`, the attributes are product attributes generated by Cloud Retail. It requires UserEvent.product_details is imported properly. type: object @@ -2861,12 +2930,11 @@ components: type: string GoogleCloudRetailV2CompleteQueryResponseAttributeResult: id: GoogleCloudRetailV2CompleteQueryResponseAttributeResult - description: >- - Resource that represents attribute results. The list of suggestions for - the attribute. + description: Resource that represents attribute results. type: object properties: suggestions: + description: The list of suggestions for the attribute. type: array items: type: string @@ -2892,12 +2960,6 @@ components: affect search or recommendation results at serving time. type: object properties: - rule: - description: >- - A rule control - a condition-action pair. Enacts a set action when - the condition is triggered. For example: Boost "gShoe" when query - full matches "Running Shoes". - $ref: '#/components/schemas/GoogleCloudRetailV2Rule' name: description: >- Immutable. Fully qualified name @@ -2909,6 +2971,12 @@ components: UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown. type: string + rule: + description: >- + A rule control - a condition-action pair. Enacts a set action when + the condition is triggered. For example: Boost "gShoe" when query + full matches "Running Shoes". + $ref: '#/components/schemas/GoogleCloudRetailV2Rule' associatedServingConfigIds: description: >- Output only. List of serving config ids that are associated with @@ -2995,6 +3063,11 @@ components: removeFacetAction: description: Remove an attribute as a facet in the request (if present). $ref: '#/components/schemas/GoogleCloudRetailV2RuleRemoveFacetAction' + pinAction: + description: >- + Pins one or more specified products to a specific position in the + results. + $ref: '#/components/schemas/GoogleCloudRetailV2RulePinAction' condition: description: >- Required. The condition that triggers the rule. If the condition is @@ -3236,6 +3309,37 @@ components: type: array items: type: string + GoogleCloudRetailV2RulePinAction: + id: GoogleCloudRetailV2RulePinAction + description: >- + Pins one or more specified products to a specific position in the + results. * Rule Condition: Must specify non-empty Condition.query_terms + (for search only) or Condition.page_categories (for browse only), but + can't specify both. * Action Input: mapping of `[pin_position, + product_id]` pairs (pin position uses 1-based indexing). * Action + Result: Will pin products with matching ids to the position specified in + the final result order. Example: Suppose the query is `shoes`, the + Condition.query_terms is `shoes` and the pin_map has `{1, "pid1"}`, then + product with `pid1` will be pinned to the top position in the final + results. If multiple PinActions are matched to a single request the + actions will be processed from most to least recently updated. Pins to + positions larger than the max allowed page size of 120 are not allowed. + type: object + properties: + pinMap: + description: >- + Required. A map of positions to product_ids. Partial matches per + action are allowed, if a certain position in the map is already + filled that `[position, product_id]` pair will be ignored but the + rest may still be applied. This case will only occur if multiple pin + actions are matched to a single request, as the map guarantees that + pin positions are unique within the same action. Duplicate + product_ids are not permitted within a single pin map. The max size + of this map is 120, equivalent to the max [request page + size](https://cloud.google.com/retail/docs/reference/rest/v2/projects.locations.catalogs.placements/search#request-body). + type: object + additionalProperties: + type: string GoogleCloudRetailV2Condition: id: GoogleCloudRetailV2Condition description: >- @@ -3421,6 +3525,123 @@ components: type: array items: $ref: '#/components/schemas/GoogleCloudRetailV2GenerativeQuestionConfig' + GoogleCloudRetailV2ConversationalSearchCustomizationConfig: + id: GoogleCloudRetailV2ConversationalSearchCustomizationConfig + description: >- + The public proto to represent the conversational search customization + config. It will be converted to the internal proto in the backend. + type: object + properties: + retailerDisplayName: + description: >- + Optional. The retailer's display name that could be used in our LLM + answers. Example - "Google" + type: string + intentClassificationConfig: + description: Optional. The configs for intent classification. + $ref: '#/components/schemas/GoogleCloudRetailV2IntentClassificationConfig' + catalog: + description: >- + Required. Resource name of the catalog. Format: + projects/{project}/locations/{location}/catalogs/{catalog} + type: string + GoogleCloudRetailV2IntentClassificationConfig: + id: GoogleCloudRetailV2IntentClassificationConfig + description: >- + The public proto to represent the intent classification config. It will + be converted to the internal proto in the backend. + type: object + properties: + inlineSource: + description: Optional. Inline source for intent classifications. + $ref: >- + #/components/schemas/GoogleCloudRetailV2IntentClassificationConfigInlineSource + modelPreamble: + description: >- + Optional. Customers can use the preamble to specify any requirements + for blocklisting intent classification. This preamble will be added + to the blocklisting intent classification model prompt. + type: string + example: + description: Optional. A list of examples for intent classification. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudRetailV2IntentClassificationConfigExample + blocklistKeywords: + description: >- + Optional. A list of keywords that will be used to classify the query + to the "BLOCKLISTED" intent type. The keywords are case insensitive. + type: array + items: + type: string + disabledIntentTypes: + description: >- + Optional. A list of intent types that will be disabled for this + customer. The intent types must match one of the predefined intent + types defined at + https://cloud.google.com/retail/docs/reference/rpc/google.cloud.retail.v2alpha#querytype + type: array + items: + type: string + GoogleCloudRetailV2IntentClassificationConfigInlineSource: + id: GoogleCloudRetailV2IntentClassificationConfigInlineSource + description: Inline source for intent classifications. + type: object + properties: + inlineForceIntents: + description: Optional. A list of inline force intent classifications. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudRetailV2IntentClassificationConfigInlineForceIntent + GoogleCloudRetailV2IntentClassificationConfigInlineForceIntent: + id: GoogleCloudRetailV2IntentClassificationConfigInlineForceIntent + description: An inline force intent classification configuration. + type: object + properties: + query: + description: Optional. A example query. + type: string + operation: + description: Optional. The operation to perform for the query. + type: string + enumDescriptions: + - Unspecified match operation. + - Exact match. + - Contains match. + enum: + - OPERATION_UNSPECIFIED + - EXACT_MATCH + - CONTAINS + intentType: + description: >- + Optional. The intent_type must match one of the predefined intent + types defined at + https://cloud.google.com/retail/docs/reference/rpc/google.cloud.retail.v2alpha#querytype + type: string + GoogleCloudRetailV2IntentClassificationConfigExample: + id: GoogleCloudRetailV2IntentClassificationConfigExample + description: An example for intent classification. + type: object + properties: + query: + description: Required. Example query. + type: string + intentType: + description: >- + Optional. The intent_type must match one of the predefined intent + types defined at + https://cloud.google.com/retail/docs/reference/rpc/google.cloud.retail.v2alpha#querytype + type: string + reason: + description: >- + Optional. The reason for the intent classification. This is used to + explain the intent classification decision. + type: string + classifiedPositive: + description: Required. Whether the example is classified positively. + type: boolean GoogleCloudRetailV2Model: id: GoogleCloudRetailV2Model description: >- @@ -3692,8 +3913,6 @@ components: removed from cart. * `category-page-view`: Special pages such as sale or promotion pages viewed. * `detail-page-view`: Products detail page viewed. * `home-page-view`: Homepage viewed. * - `promotion-offered`: Promotion is offered to a user. * - `promotion-not-offered`: Promotion is not offered to a user. * `purchase-complete`: User finishing a purchase. * `search`: Product search. * `shopping-cart-page-view`: User viewing a shopping cart. type: string @@ -3717,7 +3936,7 @@ components: A unique identifier for tracking a visitor session with a length limit of 128 bytes. A session is an aggregation of an end user behavior in a time span. A general guideline to populate the - sesion_id: 1. If user has no activity for 30 min, a new session_id + session_id: 1. If user has no activity for 30 min, a new session_id should be assigned. 2. The session_id should be unique across users, suggest use uuid or add visitor_id as prefix. type: string @@ -3892,6 +4111,13 @@ components: this field to get better per-entity search, completion, and prediction results. type: string + panels: + description: >- + Optional. List of panels associated with this event. Used for + panel-level impression data. + type: array + items: + $ref: '#/components/schemas/GoogleCloudRetailV2PanelInfo' GoogleCloudRetailV2ProductDetail: id: GoogleCloudRetailV2ProductDetail description: Detailed product information associated with a user event. @@ -3966,6 +4192,37 @@ components: currencyCode: description: Required. Currency code. Use three-character ISO-4217 code. type: string + GoogleCloudRetailV2PanelInfo: + id: GoogleCloudRetailV2PanelInfo + description: Detailed panel information associated with a user event. + type: object + properties: + panelId: + description: Required. The panel ID. + type: string + displayName: + description: Optional. The display name of the panel. + type: string + productDetails: + description: Optional. The product details associated with the panel. + type: array + items: + $ref: '#/components/schemas/GoogleCloudRetailV2ProductDetail' + totalPanels: + description: >- + Optional. The total number of panels, including this one, shown to + the user. Must be set if panel_position is set. + type: integer + format: int32 + panelPosition: + description: >- + Optional. The ordered position of the panel, if shown to the user + with other panels. If set, then total_panels must also be set. + type: integer + format: int32 + attributionToken: + description: Optional. The attribution token of the panel. + type: string GoogleApiHttpBody: id: GoogleApiHttpBody description: >- @@ -4008,6 +4265,42 @@ components: additionalProperties: type: any description: Properties of the object. Contains field @type with type URL. + GoogleCloudRetailV2CollectUserEventRequest: + id: GoogleCloudRetailV2CollectUserEventRequest + description: Request message for CollectUserEvent method. + type: object + properties: + prebuiltRule: + description: >- + The prebuilt rule name that can convert a specific type of raw_json. + For example: "ga4_bq" rule for the GA4 user event schema. + type: string + userEvent: + description: >- + Required. URL encoded UserEvent proto with a length limit of + 2,000,000 characters. + type: string + uri: + description: >- + The URL including cgi-parameters but excluding the hash fragment + with a length limit of 5,000 characters. This is often more useful + than the referer URL, because many browsers only send the domain for + 3rd party requests. + type: string + ets: + description: >- + The event timestamp in milliseconds. This prevents browser caching + of otherwise identical get requests. The name is abbreviated to + reduce the payload bytes. + type: string + format: int64 + rawJson: + description: >- + An arbitrary serialized JSON string that contains necessary + information that can comprise a user event. When this field is + specified, the user_event field will be ignored. Note: + line-delimited JSON is not supported, a single JSON only. + type: string GoogleCloudRetailV2PurgeUserEventsRequest: id: GoogleCloudRetailV2PurgeUserEventsRequest description: Request message for PurgeUserEvents method. @@ -5815,7 +6108,14 @@ components: type: object properties: primaryFeedId: - description: Merchant Center primary feed ID. + description: >- + Merchant Center primary feed ID. Deprecated: use data_source_id + instead. + deprecated: true + type: string + format: int64 + dataSourceId: + description: AFM data source ID. type: string format: int64 primaryFeedName: @@ -7324,6 +7624,35 @@ components: #/components/x-stackQL-resources/catalogs_generative_question/methods/projects_locations_catalogs_update_generative_question replace: [] delete: [] + catalogs_conversational_search_customization_config: + id: google.retail.catalogs_conversational_search_customization_config + name: catalogs_conversational_search_customization_config + title: Catalogs_conversational_search_customization_config + methods: + projects_locations_catalogs_get_conversational_search_customization_config: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1catalogs~1{catalogsId}~1conversationalSearchCustomizationConfig/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_catalogs_update_conversational_search_customization_config: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1catalogs~1{catalogsId}~1conversationalSearchCustomizationConfig/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/catalogs_conversational_search_customization_config/methods/projects_locations_catalogs_get_conversational_search_customization_config + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/catalogs_conversational_search_customization_config/methods/projects_locations_catalogs_update_conversational_search_customization_config + replace: [] + delete: [] products: id: google.retail.products name: products @@ -7842,7 +8171,7 @@ components: projects_locations_catalogs_user_events_collect: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1catalogs~1{catalogsId}~1userEvents:collect/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1catalogs~1{catalogsId}~1userEvents:collect/post response: mediaType: application/json openAPIDocKey: '200' @@ -8530,6 +8859,89 @@ paths: schema: type: string format: google-fieldmask + /v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/conversationalSearchCustomizationConfig: + parameters: *ref_1 + get: + description: >- + Returns the conversational search customization config for a given + catalog. + operationId: >- + retail.projects.locations.catalogs.getConversationalSearchCustomizationConfig + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRetailV2ConversationalSearchCustomizationConfig + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: catalogsId + required: true + schema: + type: string + patch: + description: >- + Updates the conversational search customization config for a given + catalog. + operationId: >- + retail.projects.locations.catalogs.updateConversationalSearchCustomizationConfig + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRetailV2ConversationalSearchCustomizationConfig + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRetailV2ConversationalSearchCustomizationConfig + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: catalogsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask /v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/operations: parameters: *ref_1 get: @@ -10649,13 +11061,19 @@ paths: type: boolean /v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/userEvents:collect: parameters: *ref_1 - get: + post: description: >- - Writes a single user event from the browser. This uses a GET request to - due to browser restriction of POST-ing to a 3rd party domain. This - method is used only by the Retail API JavaScript pixel and Google Tag - Manager. Users should not call this method directly. + Writes a single user event from the browser. For larger user event + payload over 16 KB, the POST method should be used instead, otherwise a + 400 Bad Request error is returned. This method is used only by the + Retail API JavaScript pixel and Google Tag Manager. Users should not + call this method directly. operationId: retail.projects.locations.catalogs.userEvents.collect + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudRetailV2CollectUserEventRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10684,27 +11102,6 @@ paths: required: true schema: type: string - - in: query - name: prebuiltRule - schema: - type: string - - in: query - name: userEvent - schema: - type: string - - in: query - name: uri - schema: - type: string - - in: query - name: ets - schema: - type: string - format: int64 - - in: query - name: rawJson - schema: - type: string /v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/userEvents:purge: parameters: *ref_1 post: diff --git a/providers/src/googleapis.com/v00.00.00000/services/run.yaml b/providers/src/googleapis.com/v00.00.00000/services/run.yaml index f47f400a..d0e4b343 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/run.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/run.yaml @@ -11,8 +11,8 @@ info: Serving API specification, while v2 is aligned with Google Cloud AIP-based API standards, as described in https://google.aip.dev/. version: v2 - x-discovery-doc-revision: '20241025' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250822' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/run/ servers: @@ -132,30 +132,47 @@ components: description: >- Numeric code drawn from the space specified below. Often, this is the canonical error space, and code is drawn from - google3/util/task/codes.proto + google3/util/task/codes.proto copybara:strip_begin(b/383363683) + copybara:strip_end_and_replace optional int32 code = 1; type: integer format: int32 space: description: >- - The following are usually only present when code != 0 Space to which - this status belongs + copybara:strip_begin(b/383363683) Space to which this status belongs + copybara:strip_end_and_replace optional string space = 2; // Space + to which this status belongs type: string message: - description: Detail message + description: >- + Detail message copybara:strip_begin(b/383363683) + copybara:strip_end_and_replace optional string message = 3; type: string canonicalCode: description: >- - The canonical error code (see codes.proto) that most closely - corresponds to this status. This may be missing, and in the common - case of the generic space, it definitely will be. + copybara:strip_begin(b/383363683) copybara:strip_end_and_replace + optional int32 canonical_code = 6; type: integer format: int32 messageSet: - description: message_set associates an arbitrary proto message with the status. + description: >- + message_set associates an arbitrary proto message with the status. + copybara:strip_begin(b/383363683) copybara:strip_end_and_replace + optional proto2.bridge.MessageSet message_set = 5; $ref: '#/components/schemas/Proto2BridgeMessageSet' Proto2BridgeMessageSet: id: Proto2BridgeMessageSet - description: This is proto2's version of MessageSet. + deprecated: true + description: >- + This is proto2's version of MessageSet. DEPRECATED: DO NOT USE FOR NEW + FIELDS. If you are using editions or proto2, please make your own + extendable messages for your use case. If you are using proto3, please + use `Any` instead. MessageSet was the implementation of extensions for + proto1. When proto2 was introduced, extensions were implemented as a + first-class feature. This schema for MessageSet was meant to be a + "bridge" solution to migrate MessageSet-bearing messages from proto1 to + proto2. This schema has been open-sourced only to facilitate the + migration of Google products with MessageSet-bearing messages to + open-source environments. type: object properties: {} GoogleLongrunningListOperationsResponse: @@ -315,6 +332,65 @@ components: type: array items: type: string + machineType: + description: >- + Optional. The machine type from default pool to use for the build. + If left blank, cloudbuild will use a sensible default. Currently + only E2_HIGHCPU_8 is supported. If worker_pool is set, this field + will be ignored. + type: string + releaseTrack: + description: >- + Optional. The release track of the client that initiated the build + request. + type: string + enumDescriptions: + - Do not use this default value. + - The feature is not yet implemented. Users can not use it. + - >- + Prelaunch features are hidden from users and are only visible + internally. + - >- + Early Access features are limited to a closed group of testers. To + use these features, you must sign up in advance and sign a Trusted + Tester agreement (which includes confidentiality provisions). + These features may be unstable, changed in backward-incompatible + ways, and are not guaranteed to be released. + - >- + Alpha is a limited availability test for releases before they are + cleared for widespread use. By Alpha, all significant design + issues are resolved and we are in the process of verifying + functionality. Alpha customers need to apply for access, agree to + applicable terms, and have their projects allowlisted. Alpha + releases don't have to be feature complete, no SLAs are provided, + and there are no technical support obligations, but they will be + far enough along that customers can actually use them in test + environments or for limited-use tests -- just like they would in + normal production cases. + - >- + Beta is the point at which we are ready to open a release for any + customer to use. There are no SLA or technical support obligations + in a Beta release. Products will be complete from a feature + perspective, but may have some open outstanding issues. Beta + releases are suitable for limited production use cases. + - >- + GA features are open to all developers and are considered stable + and fully qualified for production use. + - >- + Deprecated features are scheduled to be shut down and removed. For + more information, see the "Deprecation Policy" section of our + [Terms of Service](https://cloud.google.com/terms/) and the + [Google Cloud Platform Subject to the Deprecation + Policy](https://cloud.google.com/terms/deprecation) documentation. + enum: + - LAUNCH_STAGE_UNSPECIFIED + - UNIMPLEMENTED + - PRELAUNCH + - EARLY_ACCESS + - ALPHA + - BETA + - GA + - DEPRECATED GoogleCloudRunV2StorageSource: id: GoogleCloudRunV2StorageSource description: Location of the source in an archive file in Google Cloud Storage. @@ -362,9 +438,7 @@ components: best-effort basis. type: string baseImage: - description: >- - Optional. The base image used to opt into automatic base image - updates. + description: Optional. The base image to use for the build. type: string environmentVariables: description: Optional. User-provided build-time environment variables. @@ -378,6 +452,12 @@ components: built on a scratch base image, so the base layers can be appended at run time. type: boolean + projectDescriptor: + description: >- + Optional. project_descriptor stores the path to the project + descriptor file. When empty, it means that there is no project + descriptor file in the source. + type: string GoogleCloudRunV2DockerBuild: id: GoogleCloudRunV2DockerBuild description: Build the source using Docker. This means the source has a Dockerfile. @@ -418,6 +498,10 @@ components: the resource is deleted. readOnly: true type: string + creator: + description: Output only. Email address of the authenticated creator. + readOnly: true + type: string generation: description: >- Output only. A number that monotonically increases every time the @@ -705,6 +789,14 @@ components: information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc. $ref: '#/components/schemas/GoogleCloudRunV2VpcAccess' + nodeSelector: + description: Optional. The node selector for the task template. + $ref: '#/components/schemas/GoogleCloudRunV2NodeSelector' + gpuZonalRedundancyDisabled: + description: >- + Optional. True if GPU zonal redundancy is disabled on this task + template. + type: boolean GoogleCloudRunV2Container: id: GoogleCloudRunV2Container description: >- @@ -783,6 +875,16 @@ components: type: array items: type: string + baseImageUri: + description: >- + Base image for this container. Only supported for services. If set, + it indicates that the service is enrolled into automatic base image + update. + type: string + buildInfo: + description: Output only. The build info of the container image. + readOnly: true + $ref: '#/components/schemas/GoogleCloudRunV2BuildInfo' GoogleCloudRunV2EnvVar: id: GoogleCloudRunV2EnvVar description: EnvVar represents an environment variable present in a Container. @@ -889,6 +991,11 @@ components: information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run type: string + subPath: + description: >- + Optional. Path within the volume from which the container's volume + should be mounted. Defaults to "" (volume's root). + type: string GoogleCloudRunV2Probe: id: GoogleCloudRunV2Probe description: >- @@ -1008,6 +1115,21 @@ components: https://github.com/grpc/grpc/blob/master/doc/health-checking.md ). If this is not specified, the default behavior is defined by gRPC. type: string + GoogleCloudRunV2BuildInfo: + id: GoogleCloudRunV2BuildInfo + description: Build information of the image. + type: object + properties: + functionTarget: + description: >- + Output only. Entry point of the function when the image is a Cloud + Run function. + readOnly: true + type: string + sourceLocation: + description: Output only. Source code location of the image. + readOnly: true + type: string GoogleCloudRunV2Volume: id: GoogleCloudRunV2Volume description: Volume represents a named volume in a container. @@ -1068,8 +1190,7 @@ components: setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod - numeric notation with a leading zero. Some examples: for chmod 777 - (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 + numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, @@ -1101,8 +1222,7 @@ components: be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod - numeric notation with a leading zero. Some examples: for chmod 777 - (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 + numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, @@ -1258,6 +1378,14 @@ components: type: array items: type: string + GoogleCloudRunV2NodeSelector: + id: GoogleCloudRunV2NodeSelector + description: Hardware constraints configuration. + type: object + properties: + accelerator: + description: Required. GPU accelerator type to attach to an instance. + type: string GoogleCloudRunV2Condition: id: GoogleCloudRunV2Condition description: Defines a status condition for a resource. @@ -1330,6 +1458,7 @@ components: - >- An internal error occurred. Further information may be in the message. + - User-provided VPC network was not found. enum: - COMMON_REASON_UNDEFINED - UNKNOWN @@ -1346,6 +1475,7 @@ components: - IMMEDIATE_RETRY - POSTPONED_RETRY - INTERNAL + - VPC_NETWORK_NOT_FOUND revisionReason: description: Output only. A reason for the revision condition. readOnly: true @@ -1673,10 +1803,9 @@ components: type: string etag: description: >- - Output only. A system-generated fingerprint for this version of the + Optional. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates. - readOnly: true type: string GoogleCloudRunV2BinaryAuthorization: id: GoogleCloudRunV2BinaryAuthorization @@ -1740,13 +1869,13 @@ components: type: string parallelism: description: >- - Specifies the maximum desired number of tasks the execution should - run at given time. Must be <= task_count. When the job is run, if - this field is 0 or unset, the maximum possible value will be used - for that execution. The actual number of tasks running in steady - state will be less than this number when there are fewer tasks - waiting to be completed remaining, i.e. when the work left to do is - less than max parallelism. + Optional. Specifies the maximum desired number of tasks the + execution should run at given time. When the job is run, if this + field is 0 or unset, the maximum possible value will be used for + that execution. The actual number of tasks running in steady state + will be less than this number when there are fewer tasks waiting to + be completed remaining, i.e. when the work left to do is less than + max parallelism. type: integer format: int32 taskCount: @@ -2469,6 +2598,16 @@ components: nodeSelector: description: The node selector for the revision. $ref: '#/components/schemas/GoogleCloudRunV2NodeSelector' + gpuZonalRedundancyDisabled: + description: >- + Optional. Output only. True if GPU zonal redundancy is disabled on + this revision. + readOnly: true + type: boolean + creator: + description: Output only. Email address of the authenticated creator. + readOnly: true + type: string etag: description: >- Output only. A system-generated fingerprint for this version of the @@ -2517,14 +2656,6 @@ components: description: The current number of min instances provisioned for this revision. type: integer format: int32 - GoogleCloudRunV2NodeSelector: - id: GoogleCloudRunV2NodeSelector - description: Hardware constraints configuration. - type: object - properties: - accelerator: - description: Required. GPU accelerator type to attach to an instance. - type: string GoogleCloudRunV2ListRevisionsResponse: id: GoogleCloudRunV2ListRevisionsResponse description: Response message containing a list of Revisions. @@ -2629,7 +2760,7 @@ components: expireTime: description: >- Output only. For a deleted resource, the time after which it will be - permamently deleted. + permanently deleted. readOnly: true type: string format: google-datetime @@ -2743,8 +2874,7 @@ components: invokerIamDisabled: description: >- Optional. Disables IAM permission check for run.routes.invoke for - callers of this service. This feature is available by invitation - only. For more information, visit + callers of this service. For more information, visit https://cloud.google.com/run/docs/securing/managing-access#invoker_check. type: boolean defaultUriDisabled: @@ -2758,6 +2888,12 @@ components: type: array items: type: string + iapEnabled: + description: Optional. IAP settings on the Service. + type: boolean + multiRegionSettings: + description: Optional. Settings for multi-region deployment. + $ref: '#/components/schemas/GoogleCloudRunV2MultiRegionSettings' customAudiences: description: >- One or more custom audiences that you want this service to support. @@ -2827,6 +2963,15 @@ components: description: Output only. Reserved for future use. readOnly: true type: boolean + threatDetectionEnabled: + description: >- + Output only. True if Cloud Run Threat Detection monitoring is + enabled for the parent project of this Service. + readOnly: true + type: boolean + buildConfig: + description: Optional. Configuration for building a Cloud Run function. + $ref: '#/components/schemas/GoogleCloudRunV2BuildConfig' reconciling: description: >- Output only. Returns true if the Service is currently being acted @@ -2835,7 +2980,7 @@ components: asynchronously perform all necessary steps to bring the Service to the desired serving state. This process is called reconciliation. While reconciliation is in process, `observed_generation`, - `latest_ready_revison`, `traffic_statuses`, and `uri` will have + `latest_ready_revision`, `traffic_statuses`, and `uri` will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the serving state @@ -2853,10 +2998,9 @@ components: type: boolean etag: description: >- - Output only. A system-generated fingerprint for this version of the + Optional. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates. - readOnly: true type: string GoogleCloudRunV2RevisionTemplate: id: GoogleCloudRunV2RevisionTemplate @@ -2955,13 +3099,32 @@ components: maxInstanceRequestConcurrency: description: >- Optional. Sets the maximum number of requests that each serving - instance can receive. If not specified or 0, defaults to 80 when - requested `CPU >= 1` and defaults to 1 when requested `CPU < 1`. + instance can receive. If not specified or 0, concurrency defaults to + 80 when requested `CPU >= 1` and defaults to 1 when requested `CPU < + 1`. type: integer format: int32 serviceMesh: description: Optional. Enables service mesh connectivity. $ref: '#/components/schemas/GoogleCloudRunV2ServiceMesh' + encryptionKeyRevocationAction: + description: Optional. The action to take if the encryption key is revoked. + type: string + enumDescriptions: + - Unspecified + - Prevents the creation of new instances. + - Shuts down existing instances, and prevents creation of new ones. + enum: + - ENCRYPTION_KEY_REVOCATION_ACTION_UNSPECIFIED + - PREVENT_NEW + - SHUTDOWN + encryptionKeyShutdownDuration: + description: >- + Optional. If encryption_key_revocation_action is SHUTDOWN, the + duration before shutting down all instances. The minimum increment + is 1 hour. + type: string + format: google-duration sessionAffinity: description: Optional. Enable session affinity. type: boolean @@ -2971,6 +3134,9 @@ components: nodeSelector: description: Optional. The node selector for the revision template. $ref: '#/components/schemas/GoogleCloudRunV2NodeSelector' + gpuZonalRedundancyDisabled: + description: Optional. True if GPU zonal redundancy is disabled on this revision. + type: boolean GoogleCloudRunV2TrafficTarget: id: GoogleCloudRunV2TrafficTarget description: >- @@ -3031,6 +3197,34 @@ components: - SCALING_MODE_UNSPECIFIED - AUTOMATIC - MANUAL + maxInstanceCount: + description: >- + Optional. total max instances for the service. This number of + instances is divided among all revisions with specified traffic + based on the percent of traffic they are receiving. + type: integer + format: int32 + manualInstanceCount: + description: >- + Optional. total instance count for the service in manual scaling + mode. This number of instances is divided among all revisions with + specified traffic based on the percent of traffic they are + receiving. + type: integer + format: int32 + GoogleCloudRunV2MultiRegionSettings: + id: GoogleCloudRunV2MultiRegionSettings + description: Settings for multi-region deployment. + type: object + properties: + regions: + description: Required. List of regions to deploy to, including primary region. + type: array + items: + type: string + multiRegionId: + description: Optional. System-generated unique id for the multi-region Service. + type: string GoogleCloudRunV2TrafficTargetStatus: id: GoogleCloudRunV2TrafficTargetStatus description: Represents the observed state of a single `TrafficTarget` entry. @@ -3062,6 +3256,65 @@ components: uri: description: Displays the target URI. type: string + GoogleCloudRunV2BuildConfig: + id: GoogleCloudRunV2BuildConfig + description: >- + Describes the Build step of the function that builds a container from + the given source. + type: object + properties: + name: + description: >- + Output only. The Cloud Build name of the latest successful + deployment of the function. + readOnly: true + type: string + sourceLocation: + description: >- + The Cloud Storage bucket URI where the function source code is + located. + type: string + functionTarget: + description: >- + Optional. The name of the function (as defined in source code) that + will be executed. Defaults to the resource name suffix, if not + specified. For backward compatibility, if function with given name + is not found, then the system will try to use function named + "function". + type: string + imageUri: + description: Optional. Artifact Registry URI to store the built image. + type: string + baseImage: + description: Optional. The base image used to build the function. + type: string + enableAutomaticUpdates: + description: >- + Optional. Sets whether the function will receive automatic base + image updates. + type: boolean + workerPool: + description: >- + Optional. Name of the Cloud Build Custom Worker Pool that should be + used to build the Cloud Run function. The format of this field is + `projects/{project}/locations/{region}/workerPools/{workerPool}` + where `{project}` and `{region}` are the project id and region + respectively where the worker pool is defined and `{workerPool}` is + the short name of the worker pool. + type: string + environmentVariables: + description: >- + Optional. User-provided build-time environment variables for the + function + type: object + additionalProperties: + type: string + serviceAccount: + description: >- + Optional. Service account to be used for building the container. The + format of this field is + `projects/{projectId}/serviceAccounts/{serviceAccountEmail}`. + type: string GoogleCloudRunV2ListServicesResponse: id: GoogleCloudRunV2ListServicesResponse description: Response message containing a list of Services. @@ -3290,6 +3543,16 @@ components: description: Output only. Reserved for future use. readOnly: true type: boolean + nodeSelector: + description: Output only. The node selector for the task. + readOnly: true + $ref: '#/components/schemas/GoogleCloudRunV2NodeSelector' + gpuZonalRedundancyDisabled: + description: >- + Optional. Output only. True if GPU zonal redundancy is disabled on + this task. + readOnly: true + type: boolean etag: description: >- Output only. A system-generated fingerprint for this version of the @@ -3312,7 +3575,16 @@ components: description: >- Output only. The exit code of this attempt. This may be unset if the container was unable to exit cleanly with a code due to some other - failure. See status field for possible failure details. + failure. See status field for possible failure details. At most one + of exit_code or term_signal will be set. + readOnly: true + type: integer + format: int32 + termSignal: + description: >- + Output only. Termination signal of the container. This is set to + non-zero if the container is terminated by the system. At most one + of exit_code or term_signal will be set. readOnly: true type: integer format: int32 @@ -3331,550 +3603,511 @@ components: A token indicating there are more items than page_size. Use it in the next ListTasks request to continue. type: string - GoogleDevtoolsCloudbuildV1BuildOperationMetadata: - id: GoogleDevtoolsCloudbuildV1BuildOperationMetadata - description: Metadata for build operations. - type: object - properties: - build: - description: The build that the operation is tracking. - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1Build' - GoogleDevtoolsCloudbuildV1Build: - id: GoogleDevtoolsCloudbuildV1Build + GoogleCloudRunV2WorkerPool: + id: GoogleCloudRunV2WorkerPool description: >- - A build resource in the Cloud Build API. At a high level, a `Build` - describes where to find source code, how to build it (for example, the - builder image to run on the source), and where to store the built - artifacts. Fields can include the following variables, which will be - expanded when the build is created: - $PROJECT_ID: the project ID of the - build. - $PROJECT_NUMBER: the project number of the build. - $LOCATION: - the location/region of the build. - $BUILD_ID: the autogenerated ID of - the build. - $REPO_NAME: the source repository name specified by - RepoSource. - $BRANCH_NAME: the branch name specified by RepoSource. - - $TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID or - $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the - specified branch or tag. - $SHORT_SHA: first 7 characters of - $REVISION_ID or $COMMIT_SHA. + WorkerPool acts as a top-level container that manages a set of + configurations and revision templates which implement a pull-based + workload. WorkerPool exists to provide a singular abstraction which can + be access controlled, reasoned about, and which encapsulates software + lifecycle decisions such as rollout policy and team resource ownership. type: object properties: name: description: >- - Output only. The 'Build' name with format: - `projects/{project}/locations/{location}/builds/{build}`, where - {build} is a unique identifier generated by the service. - readOnly: true + The fully qualified name of this WorkerPool. In + CreateWorkerPoolRequest, this field is ignored, and instead composed + from CreateWorkerPoolRequest.parent and + CreateWorkerPoolRequest.worker_id. Format: + `projects/{project}/locations/{location}/workerPools/{worker_id}` type: string - id: - description: Output only. Unique identifier of the build. - readOnly: true + description: + description: >- + User-provided description of the WorkerPool. This field currently + has a 512-character limit. type: string - projectId: - description: Output only. ID of the project. + uid: + description: >- + Output only. Server assigned unique identifier for the trigger. The + value is a UUID4 string and guaranteed to remain unchanged until the + resource is deleted. readOnly: true type: string - status: - description: Output only. Status of the build. + generation: + description: >- + Output only. A number that monotonically increases every time the + user modifies the desired state. Please note that unlike v1, this is + an int64 value. As with most Google APIs, its JSON representation + will be a `string` instead of an `integer`. readOnly: true type: string - enumDescriptions: - - Status of the build is unknown. - - >- - Build has been created and is pending execution and queuing. It - has not been queued. - - Build or step is queued; work has not yet begun. - - Build or step is being executed. - - Build or step finished successfully. - - Build or step failed to complete successfully. - - Build or step failed due to an internal cause. - - Build or step took longer than was allowed. - - Build or step was canceled by a user. - - Build was enqueued for longer than the value of `queue_ttl`. - enum: - - STATUS_UNKNOWN - - PENDING - - QUEUED - - WORKING - - SUCCESS - - FAILURE - - INTERNAL_ERROR - - TIMEOUT - - CANCELLED - - EXPIRED - statusDetail: - description: Output only. Customer-readable message about the current status. - readOnly: true - type: string - source: - description: Optional. The location of the source files to build. - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1Source' - steps: - description: Required. The operations to be performed on the workspace. - type: array - items: - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1BuildStep' - results: - description: Output only. Results of the build. - readOnly: true - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1Results' - createTime: + format: int64 + labels: description: >- - Output only. Time at which the request to create the build was - received. + Optional. Unstructured key value map that can be used to organize + and categorize objects. User-provided labels are shared with + Google's billing system, so they can be used to filter, or break + down billing charges by team, component, environment, state, etc. + For more information, visit + https://cloud.google.com/resource-manager/docs/creating-managing-labels + or https://cloud.google.com/run/docs/configuring/labels. Cloud Run + API v2 does not support labels with `run.googleapis.com`, + `cloud.googleapis.com`, `serving.knative.dev`, or + `autoscaling.knative.dev` namespaces, and they will be rejected. All + system labels in v1 now have a corresponding field in v2 WorkerPool. + type: object + additionalProperties: + type: string + annotations: + description: >- + Optional. Unstructured key value map that may be set by external + tools to store and arbitrary metadata. They are not queryable and + should be preserved when modifying objects. Cloud Run API v2 does + not support annotations with `run.googleapis.com`, + `cloud.googleapis.com`, `serving.knative.dev`, or + `autoscaling.knative.dev` namespaces, and they will be rejected in + new resources. All system annotations in v1 now have a corresponding + field in v2 WorkerPool. This field follows Kubernetes annotations' + namespacing, limits, and rules. + type: object + additionalProperties: + type: string + createTime: + description: Output only. The creation time. readOnly: true type: string format: google-datetime - startTime: - description: Output only. Time at which execution of the build was started. + updateTime: + description: Output only. The last-modified time. readOnly: true type: string format: google-datetime - finishTime: + deleteTime: description: >- - Output only. Time at which execution of the build was finished. The - difference between finish_time and start_time is the duration of the - build's execution. + Output only. The deletion time. It is only populated as a response + to a Delete request. readOnly: true type: string format: google-datetime - timeout: + expireTime: description: >- - Amount of time that this build should be allowed to run, to second - granularity. If this amount of time elapses, work on the build will - cease and the build status will be `TIMEOUT`. `timeout` starts - ticking from `startTime`. Default time is 60 minutes. + Output only. For a deleted resource, the time after which it will be + permamently deleted. + readOnly: true type: string - format: google-duration - images: + format: google-datetime + creator: + description: Output only. Email address of the authenticated creator. + readOnly: true + type: string + lastModifier: + description: Output only. Email address of the last authenticated modifier. + readOnly: true + type: string + client: + description: Arbitrary identifier for the API client. + type: string + clientVersion: + description: Arbitrary version identifier for the API client. + type: string + launchStage: description: >- - A list of images to be pushed upon the successful completion of all - build steps. The images are pushed using the builder service - account's credentials. The digests of the pushed images will be - stored in the `Build` resource's results field. If any of the images - fail to be pushed, the build status is marked `FAILURE`. + Optional. The launch stage as defined by [Google Cloud Platform + Launch Stages](https://cloud.google.com/terms/launch-stages). Cloud + Run supports `ALPHA`, `BETA`, and `GA`. If no value is specified, GA + is assumed. Set the launch stage to a preview stage on input to + allow use of preview features in that stage. On read (or output), + describes whether the resource uses preview features. For example, + if ALPHA is provided as input, but only BETA and GA-level features + are used, this field will be BETA on output. + type: string + enumDescriptions: + - Do not use this default value. + - The feature is not yet implemented. Users can not use it. + - >- + Prelaunch features are hidden from users and are only visible + internally. + - >- + Early Access features are limited to a closed group of testers. To + use these features, you must sign up in advance and sign a Trusted + Tester agreement (which includes confidentiality provisions). + These features may be unstable, changed in backward-incompatible + ways, and are not guaranteed to be released. + - >- + Alpha is a limited availability test for releases before they are + cleared for widespread use. By Alpha, all significant design + issues are resolved and we are in the process of verifying + functionality. Alpha customers need to apply for access, agree to + applicable terms, and have their projects allowlisted. Alpha + releases don't have to be feature complete, no SLAs are provided, + and there are no technical support obligations, but they will be + far enough along that customers can actually use them in test + environments or for limited-use tests -- just like they would in + normal production cases. + - >- + Beta is the point at which we are ready to open a release for any + customer to use. There are no SLA or technical support obligations + in a Beta release. Products will be complete from a feature + perspective, but may have some open outstanding issues. Beta + releases are suitable for limited production use cases. + - >- + GA features are open to all developers and are considered stable + and fully qualified for production use. + - >- + Deprecated features are scheduled to be shut down and removed. For + more information, see the "Deprecation Policy" section of our + [Terms of Service](https://cloud.google.com/terms/) and the + [Google Cloud Platform Subject to the Deprecation + Policy](https://cloud.google.com/terms/deprecation) documentation. + enum: + - LAUNCH_STAGE_UNSPECIFIED + - UNIMPLEMENTED + - PRELAUNCH + - EARLY_ACCESS + - ALPHA + - BETA + - GA + - DEPRECATED + binaryAuthorization: + description: Optional. Settings for the Binary Authorization feature. + $ref: '#/components/schemas/GoogleCloudRunV2BinaryAuthorization' + template: + description: Required. The template used to create revisions for this WorkerPool. + $ref: '#/components/schemas/GoogleCloudRunV2WorkerPoolRevisionTemplate' + instanceSplits: + description: >- + Optional. Specifies how to distribute instances over a collection of + Revisions belonging to the WorkerPool. If instance split is empty or + not provided, defaults to 100% instances assigned to the latest + `Ready` Revision. type: array items: - type: string - queueTtl: + $ref: '#/components/schemas/GoogleCloudRunV2InstanceSplit' + scaling: + description: Optional. Specifies worker-pool-level scaling settings + $ref: '#/components/schemas/GoogleCloudRunV2WorkerPoolScaling' + observedGeneration: description: >- - TTL in queue for this build. If provided and the build is enqueued - longer than this value, the build will expire and the build status - will be `EXPIRED`. The TTL starts ticking from create_time. + Output only. The generation of this WorkerPool currently serving + workloads. See comments in `reconciling` for additional information + on reconciliation process in Cloud Run. Please note that unlike v1, + this is an int64 value. As with most Google APIs, its JSON + representation will be a `string` instead of an `integer`. + readOnly: true type: string - format: google-duration - artifacts: + format: int64 + terminalCondition: description: >- - Artifacts produced by the build that should be uploaded upon - successful completion of all build steps. - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1Artifacts' - logsBucket: + Output only. The Condition of this WorkerPool, containing its + readiness status, and detailed error information in case it did not + reach a serving state. See comments in `reconciling` for additional + information on reconciliation process in Cloud Run. + readOnly: true + $ref: '#/components/schemas/GoogleCloudRunV2Condition' + conditions: description: >- - Cloud Storage bucket where logs should be written (see [Bucket Name - Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). - Logs file names will be of the format - `${logs_bucket}/log-${build_id}.txt`. - type: string - sourceProvenance: - description: Output only. A permanent fixed identifier for source. + Output only. The Conditions of all other associated sub-resources. + They contain additional diagnostics information in case the + WorkerPool does not reach its Serving state. See comments in + `reconciling` for additional information on reconciliation process + in Cloud Run. readOnly: true - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1SourceProvenance' - buildTriggerId: + type: array + items: + $ref: '#/components/schemas/GoogleCloudRunV2Condition' + latestReadyRevision: description: >- - Output only. The ID of the `BuildTrigger` that triggered this build, - if it was triggered automatically. + Output only. Name of the latest revision that is serving workloads. + See comments in `reconciling` for additional information on + reconciliation process in Cloud Run. readOnly: true type: string - options: - description: Special options for this build. - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1BuildOptions' - logUrl: - description: Output only. URL to logs for this build in Google Cloud Console. + latestCreatedRevision: + description: >- + Output only. Name of the last created revision. See comments in + `reconciling` for additional information on reconciliation process + in Cloud Run. readOnly: true type: string - substitutions: - description: Substitutions data for `Build` resource. - type: object - additionalProperties: - type: string - tags: - description: Tags for annotation of a `Build`. These are not docker tags. + instanceSplitStatuses: + description: >- + Output only. Detailed status information for corresponding instance + splits. See comments in `reconciling` for additional information on + reconciliation process in Cloud Run. + readOnly: true type: array items: - type: string - secrets: + $ref: '#/components/schemas/GoogleCloudRunV2InstanceSplitStatus' + customAudiences: description: >- - Secrets to decrypt using Cloud Key Management Service. Note: Secret - Manager is the recommended technique for managing sensitive data - with Cloud Build. Use `available_secrets` to configure builds to - access secrets from Secret Manager. For instructions, see: - https://cloud.google.com/cloud-build/docs/securing-builds/use-secrets + One or more custom audiences that you want this worker pool to + support. Specify each custom audience as the full URL in a string. + The custom audiences are encoded in the token and used to + authenticate requests. For more information, see + https://cloud.google.com/run/docs/configuring/custom-audiences. type: array items: - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1Secret' - timing: - description: >- - Output only. Stores timing information for phases of the build. - Valid keys are: * BUILD: time to execute all build steps. * PUSH: - time to push all artifacts including docker images and non docker - artifacts. * FETCHSOURCE: time to fetch source. * SETUPBUILD: time - to set up build. If the build does not specify source or images, - these keys will not be included. + type: string + satisfiesPzs: + description: Output only. Reserved for future use. readOnly: true - type: object - additionalProperties: - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1TimeSpan' - approval: + type: boolean + reconciling: description: >- - Output only. Describes this build's approval configuration, status, - and result. + Output only. Returns true if the WorkerPool is currently being acted + upon by the system to bring it into the desired state. When a new + WorkerPool is created, or an existing one is updated, Cloud Run will + asynchronously perform all necessary steps to bring the WorkerPool + to the desired serving state. This process is called reconciliation. + While reconciliation is in process, `observed_generation`, + `latest_ready_revison`, `instance_split_statuses`, and `uri` will + have transient values that might mismatch the intended state: Once + reconciliation is over (and this field is false), there are two + possible outcomes: reconciliation succeeded and the serving state + matches the WorkerPool, or there was an error, and reconciliation + failed. This state can be found in `terminal_condition.state`. If + reconciliation succeeded, the following fields will match: + `instance_splits` and `instance_split_statuses`, + `observed_generation` and `generation`, `latest_ready_revision` and + `latest_created_revision`. If reconciliation failed, + `instance_split_statuses`, `observed_generation`, and + `latest_ready_revision` will have the state of the last serving + revision, or empty for newly created WorkerPools. Additional + information on the failure can be found in `terminal_condition` and + `conditions`. readOnly: true - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1BuildApproval' - serviceAccount: + type: boolean + etag: description: >- - IAM service account whose credentials will be used at build runtime. - Must be of the format - `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. ACCOUNT can be - email address or uniqueId of the service account. + Optional. A system-generated fingerprint for this version of the + resource. May be used to detect modification conflict during + updates. type: string - availableSecrets: - description: Secrets and secret environment variables. - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1Secrets' - warnings: - description: >- - Output only. Non-fatal problems encountered during the execution of - the build. - readOnly: true - type: array - items: - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1Warning' - gitConfig: - description: Optional. Configuration for git operations. - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1GitConfig' - failureInfo: - description: >- - Output only. Contains information about the build when - status=FAILURE. - readOnly: true - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1FailureInfo' - GoogleDevtoolsCloudbuildV1Source: - id: GoogleDevtoolsCloudbuildV1Source - description: Location of the source in a supported storage service. - type: object - properties: - storageSource: - description: If provided, get the source from this location in Cloud Storage. - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1StorageSource' - repoSource: - description: >- - If provided, get the source from this location in a Cloud Source - Repository. - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1RepoSource' - gitSource: - description: If provided, get the source from this Git repository. - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1GitSource' - storageSourceManifest: - description: >- - If provided, get the source from this manifest in Cloud Storage. - This feature is in Preview; see description - [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher). - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1StorageSourceManifest' - connectedRepository: - description: >- - Optional. If provided, get the source from this 2nd-gen Google Cloud - Build repository resource. - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1ConnectedRepository' - developerConnectConfig: - description: If provided, get the source from this Developer Connect config. - $ref: >- - #/components/schemas/GoogleDevtoolsCloudbuildV1DeveloperConnectConfig - GoogleDevtoolsCloudbuildV1StorageSource: - id: GoogleDevtoolsCloudbuildV1StorageSource - description: Location of the source in an archive file in Cloud Storage. + GoogleCloudRunV2WorkerPoolRevisionTemplate: + id: GoogleCloudRunV2WorkerPoolRevisionTemplate + description: >- + WorkerPoolRevisionTemplate describes the data a worker pool revision + should have when created from a template. type: object properties: - bucket: + revision: description: >- - Cloud Storage bucket containing the source (see [Bucket Name - Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). + Optional. The unique name for the revision. If this field is + omitted, it will be automatically generated based on the WorkerPool + name. type: string - object: + labels: description: >- - Required. Cloud Storage object containing the source. This object - must be a zipped (`.zip`) or gzipped archive file (`.tar.gz`) - containing source to build. - type: string - generation: + Optional. Unstructured key value map that can be used to organize + and categorize objects. User-provided labels are shared with + Google's billing system, so they can be used to filter, or break + down billing charges by team, component, environment, state, etc. + For more information, visit + https://cloud.google.com/resource-manager/docs/creating-managing-labels + or https://cloud.google.com/run/docs/configuring/labels. Cloud Run + API v2 does not support labels with `run.googleapis.com`, + `cloud.googleapis.com`, `serving.knative.dev`, or + `autoscaling.knative.dev` namespaces, and they will be rejected. All + system labels in v1 now have a corresponding field in v2 + WorkerPoolRevisionTemplate. + type: object + additionalProperties: + type: string + annotations: description: >- - Optional. Cloud Storage generation for the object. If the generation - is omitted, the latest generation will be used. - type: string - format: int64 - sourceFetcher: + Optional. Unstructured key value map that may be set by external + tools to store and arbitrary metadata. They are not queryable and + should be preserved when modifying objects. Cloud Run API v2 does + not support annotations with `run.googleapis.com`, + `cloud.googleapis.com`, `serving.knative.dev`, or + `autoscaling.knative.dev` namespaces, and they will be rejected. All + system annotations in v1 now have a corresponding field in v2 + WorkerPoolRevisionTemplate. This field follows Kubernetes + annotations' namespacing, limits, and rules. + type: object + additionalProperties: + type: string + vpcAccess: description: >- - Optional. Option to specify the tool to fetch the source file for - the build. - type: string - enumDescriptions: - - Unspecified defaults to GSUTIL. - - Use the "gsutil" tool to download the source file. - - Use the Cloud Storage Fetcher tool to download the source file. - enum: - - SOURCE_FETCHER_UNSPECIFIED - - GSUTIL - - GCS_FETCHER - GoogleDevtoolsCloudbuildV1RepoSource: - id: GoogleDevtoolsCloudbuildV1RepoSource - description: Location of the source in a Google Cloud Source Repository. - type: object - properties: - projectId: + Optional. VPC Access configuration to use for this Revision. For + more information, visit + https://cloud.google.com/run/docs/configuring/connecting-vpc. + $ref: '#/components/schemas/GoogleCloudRunV2VpcAccess' + serviceAccount: description: >- - Optional. ID of the project that owns the Cloud Source Repository. - If omitted, the project ID requesting the build is assumed. - type: string - repoName: - description: Required. Name of the Cloud Source Repository. + Optional. Email address of the IAM service account associated with + the revision of the service. The service account represents the + identity of the running revision, and determines what permissions + the revision has. If not provided, the revision will use the + project's default service account. type: string - branchName: + containers: description: >- - Regex matching branches to build. The syntax of the regular - expressions accepted is the syntax accepted by RE2 and described at - https://github.com/google/re2/wiki/Syntax - type: string - tagName: + Holds list of the containers that defines the unit of execution for + this Revision. + type: array + items: + $ref: '#/components/schemas/GoogleCloudRunV2Container' + volumes: + description: Optional. A list of Volumes to make available to containers. + type: array + items: + $ref: '#/components/schemas/GoogleCloudRunV2Volume' + encryptionKey: description: >- - Regex matching tags to build. The syntax of the regular expressions - accepted is the syntax accepted by RE2 and described at - https://github.com/google/re2/wiki/Syntax + A reference to a customer managed encryption key (CMEK) to use to + encrypt this container image. For more information, go to + https://cloud.google.com/run/docs/securing/using-cmek type: string - commitSha: - description: Explicit commit SHA to build. + serviceMesh: + description: Optional. Enables service mesh connectivity. + $ref: '#/components/schemas/GoogleCloudRunV2ServiceMesh' + encryptionKeyRevocationAction: + description: Optional. The action to take if the encryption key is revoked. type: string - dir: + enumDescriptions: + - Unspecified + - Prevents the creation of new instances. + - Shuts down existing instances, and prevents creation of new ones. + enum: + - ENCRYPTION_KEY_REVOCATION_ACTION_UNSPECIFIED + - PREVENT_NEW + - SHUTDOWN + encryptionKeyShutdownDuration: description: >- - Optional. Directory, relative to the source root, in which to run - the build. This must be a relative path. If a step's `dir` is - specified and is an absolute path, this value is ignored for that - step's execution. + Optional. If encryption_key_revocation_action is SHUTDOWN, the + duration before shutting down all instances. The minimum increment + is 1 hour. type: string - invertRegex: + format: google-duration + nodeSelector: + description: Optional. The node selector for the revision template. + $ref: '#/components/schemas/GoogleCloudRunV2NodeSelector' + gpuZonalRedundancyDisabled: description: >- - Optional. Only trigger a build if the revision regex does NOT match - the revision regex. + Optional. True if GPU zonal redundancy is disabled on this worker + pool. type: boolean - substitutions: - description: >- - Optional. Substitutions to use in a triggered build. Should only be - used with RunBuildTrigger - type: object - additionalProperties: - type: string - GoogleDevtoolsCloudbuildV1GitSource: - id: GoogleDevtoolsCloudbuildV1GitSource - description: Location of the source in any accessible Git repository. + GoogleCloudRunV2InstanceSplit: + id: GoogleCloudRunV2InstanceSplit + description: >- + Holds a single instance split entry for the Worker. Allocations can be + done to a specific Revision name, or pointing to the latest Ready + Revision. type: object properties: - url: + type: + description: The allocation type for this instance split. + type: string + enumDescriptions: + - Unspecified instance allocation type. + - Allocates instances to the Service's latest ready Revision. + - Allocates instances to a Revision by name. + enum: + - INSTANCE_SPLIT_ALLOCATION_TYPE_UNSPECIFIED + - INSTANCE_SPLIT_ALLOCATION_TYPE_LATEST + - INSTANCE_SPLIT_ALLOCATION_TYPE_REVISION + revision: description: >- - Required. Location of the Git repo to build. This will be used as a - `git remote`, see https://git-scm.com/docs/git-remote. + Revision to which to assign this portion of instances, if split + allocation is by revision. type: string - dir: + percent: description: >- - Optional. Directory, relative to the source root, in which to run - the build. This must be a relative path. If a step's `dir` is - specified and is an absolute path, this value is ignored for that - step's execution. + Specifies percent of the instance split to this Revision. This + defaults to zero if unspecified. + type: integer + format: int32 + GoogleCloudRunV2WorkerPoolScaling: + id: GoogleCloudRunV2WorkerPoolScaling + description: Worker pool scaling settings. + type: object + properties: + manualInstanceCount: + description: Optional. The total number of instances in manual scaling mode. + type: integer + format: int32 + GoogleCloudRunV2InstanceSplitStatus: + id: GoogleCloudRunV2InstanceSplitStatus + description: Represents the observed state of a single `InstanceSplit` entry. + type: object + properties: + type: + description: The allocation type for this instance split. type: string + enumDescriptions: + - Unspecified instance allocation type. + - Allocates instances to the Service's latest ready Revision. + - Allocates instances to a Revision by name. + enum: + - INSTANCE_SPLIT_ALLOCATION_TYPE_UNSPECIFIED + - INSTANCE_SPLIT_ALLOCATION_TYPE_LATEST + - INSTANCE_SPLIT_ALLOCATION_TYPE_REVISION revision: - description: >- - Optional. The revision to fetch from the Git repository such as a - branch, a tag, a commit SHA, or any Git ref. Cloud Build uses `git - fetch` to fetch the revision from the Git repository; therefore make - sure that the string you provide for `revision` is parsable by the - command. For information on string values accepted by `git fetch`, - see https://git-scm.com/docs/gitrevisions#_specifying_revisions. For - information on `git fetch`, see https://git-scm.com/docs/git-fetch. + description: Revision to which this instance split is assigned. type: string - GoogleDevtoolsCloudbuildV1StorageSourceManifest: - id: GoogleDevtoolsCloudbuildV1StorageSourceManifest - description: >- - Location of the source manifest in Cloud Storage. This feature is in - Preview; see description - [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher). + percent: + description: Specifies percent of the instance split to this Revision. + type: integer + format: int32 + GoogleCloudRunV2ListWorkerPoolsResponse: + id: GoogleCloudRunV2ListWorkerPoolsResponse + description: Response message containing a list of WorkerPools. type: object properties: - bucket: - description: >- - Required. Cloud Storage bucket containing the source manifest (see - [Bucket Name - Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). - type: string - object: - description: >- - Required. Cloud Storage object containing the source manifest. This - object must be a JSON file. - type: string - generation: - description: >- - Cloud Storage generation for the object. If the generation is - omitted, the latest generation will be used. - type: string - format: int64 - GoogleDevtoolsCloudbuildV1ConnectedRepository: - id: GoogleDevtoolsCloudbuildV1ConnectedRepository - description: >- - Location of the source in a 2nd-gen Google Cloud Build repository - resource. - type: object - properties: - repository: - description: >- - Required. Name of the Google Cloud Build repository, formatted as - `projects/*/locations/*/connections/*/repositories/*`. - type: string - dir: - description: >- - Optional. Directory, relative to the source root, in which to run - the build. - type: string - revision: + workerPools: + description: The resulting list of WorkerPools. + type: array + items: + $ref: '#/components/schemas/GoogleCloudRunV2WorkerPool' + nextPageToken: description: >- - Required. The revision to fetch from the Git repository such as a - branch, a tag, a commit SHA, or any Git ref. + A token indicating there are more items than page_size. Use it in + the next ListWorkerPools request to continue. type: string - GoogleDevtoolsCloudbuildV1DeveloperConnectConfig: - id: GoogleDevtoolsCloudbuildV1DeveloperConnectConfig - description: This config defines the location of a source through Developer Connect. + GoogleDevtoolsCloudbuildV1BuildOperationMetadata: + id: GoogleDevtoolsCloudbuildV1BuildOperationMetadata + description: Metadata for build operations. type: object properties: - gitRepositoryLink: - description: >- - Required. The Developer Connect Git repository link, formatted as - `projects/*/locations/*/connections/*/gitRepositoryLink/*`. - type: string - dir: - description: >- - Required. Directory, relative to the source root, in which to run - the build. - type: string - revision: - description: >- - Required. The revision to fetch from the Git repository such as a - branch, a tag, a commit SHA, or any Git ref. - type: string - GoogleDevtoolsCloudbuildV1BuildStep: - id: GoogleDevtoolsCloudbuildV1BuildStep - description: A step in the build pipeline. + build: + description: The build that the operation is tracking. + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1Build' + GoogleDevtoolsCloudbuildV1Build: + id: GoogleDevtoolsCloudbuildV1Build + description: >- + A build resource in the Cloud Build API. At a high level, a `Build` + describes where to find source code, how to build it (for example, the + builder image to run on the source), and where to store the built + artifacts. Fields can include the following variables, which will be + expanded when the build is created: - $PROJECT_ID: the project ID of the + build. - $PROJECT_NUMBER: the project number of the build. - $LOCATION: + the location/region of the build. - $BUILD_ID: the autogenerated ID of + the build. - $REPO_NAME: the source repository name specified by + RepoSource. - $BRANCH_NAME: the branch name specified by RepoSource. - + $TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID or + $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the + specified branch or tag. - $SHORT_SHA: first 7 characters of + $REVISION_ID or $COMMIT_SHA. type: object properties: name: description: >- - Required. The name of the container image that will run this - particular build step. If the image is available in the host's - Docker daemon's cache, it will be run directly. If not, the host - will attempt to pull the image first, using the builder service - account's credentials if necessary. The Docker daemon's cache will - already have the latest versions of all of the officially supported - build steps - ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). - The Docker daemon will also have cached many of the layers for some - popular images, like "ubuntu", "debian", but they will be refreshed - at the time you attempt to use them. If you built an image in a - previous build step, it will be stored in the host's Docker daemon's - cache and is available to use as the name for a later build step. - type: string - env: - description: >- - A list of environment variable definitions to be used when running a - step. The elements are of the form "KEY=VALUE" for the environment - variable "KEY" being given the value "VALUE". - type: array - items: - type: string - args: - description: >- - A list of arguments that will be presented to the step when it is - started. If the image used to run the step's container has an - entrypoint, the `args` are used as arguments to that entrypoint. If - the image does not define an entrypoint, the first element in args - is used as the entrypoint, and the remainder will be used as - arguments. - type: array - items: - type: string - dir: - description: >- - Working directory to use when running this step's container. If this - value is a relative path, it is relative to the build's working - directory. If this value is absolute, it may be outside the build's - working directory, in which case the contents of the path may not be - persisted across build step executions, unless a `volume` for that - path is specified. If the build specifies a `RepoSource` with `dir` - and a step with a `dir`, which specifies an absolute path, the - `RepoSource` `dir` is ignored for the step's execution. + Output only. The 'Build' name with format: + `projects/{project}/locations/{location}/builds/{build}`, where + {build} is a unique identifier generated by the service. + readOnly: true type: string id: - description: >- - Unique identifier for this build step, used in `wait_for` to - reference this build step as a dependency. - type: string - waitFor: - description: >- - The ID(s) of the step(s) that this build step depends on. This build - step will not start until all the build steps in `wait_for` have - completed successfully. If `wait_for` is empty, this build step will - start when all previous build steps in the `Build.Steps` list have - completed successfully. - type: array - items: - type: string - entrypoint: - description: >- - Entrypoint to be used instead of the build step image's default - entrypoint. If unset, the image's default entrypoint is used. - type: string - secretEnv: - description: >- - A list of environment variables which are encrypted using a Cloud - Key Management Service crypto key. These values must be specified in - the build's `Secret`. - type: array - items: - type: string - volumes: - description: >- - List of volumes to mount into the build step. Each volume is created - as an empty volume prior to execution of the build step. Upon - completion of the build, volumes and their contents are discarded. - Using a named volume in only one step is not valid as it is - indicative of a build request with an incorrect configuration. - type: array - items: - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1Volume' - timing: - description: >- - Output only. Stores timing information for executing this build - step. + description: Output only. Unique identifier of the build. readOnly: true - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1TimeSpan' - pullTiming: - description: >- - Output only. Stores timing information for pulling this build step's - builder image only. + type: string + projectId: + description: Output only. ID of the project. readOnly: true - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1TimeSpan' - timeout: - description: >- - Time limit for executing this build step. If not defined, the step - has no time limit and will be allowed to continue to run until - either it completes or the build itself times out. type: string - format: google-duration status: - description: >- - Output only. Status of the build step. At this time, build step - status is only updated on build completion; step status is not - updated in real-time as the build progresses. + description: Output only. Status of the build. readOnly: true type: string enumDescriptions: @@ -3901,953 +4134,1599 @@ components: - TIMEOUT - CANCELLED - EXPIRED - allowFailure: - description: >- - Allow this build step to fail without failing the entire build. If - false, the entire build will fail if this step fails. Otherwise, the - build will succeed, but this step will still have a failure status. - Error information will be reported in the failure_detail field. - type: boolean - exitCode: - description: Output only. Return code from running the step. + statusDetail: + description: Output only. Customer-readable message about the current status. readOnly: true - type: integer - format: int32 - allowExitCodes: - description: >- - Allow this build step to fail without failing the entire build if - and only if the exit code is one of the specified codes. If - allow_failure is also specified, this field will take precedence. + type: string + source: + description: Optional. The location of the source files to build. + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1Source' + steps: + description: Required. The operations to be performed on the workspace. type: array items: - type: integer - format: int32 - script: + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1BuildStep' + results: + description: Output only. Results of the build. + readOnly: true + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1Results' + createTime: description: >- - A shell script to be executed in the step. When script is provided, - the user cannot specify the entrypoint or args. + Output only. Time at which the request to create the build was + received. + readOnly: true type: string - automapSubstitutions: - description: >- - Option to include built-in and custom substitutions as env variables - for this build step. This option will override the global option in - BuildOption. - type: boolean - GoogleDevtoolsCloudbuildV1Volume: - id: GoogleDevtoolsCloudbuildV1Volume - description: >- - Volume describes a Docker container volume which is mounted into build - steps in order to persist files across build step execution. - type: object - properties: - name: - description: >- - Name of the volume to mount. Volume names must be unique per build - step and must be valid names for Docker volumes. Each named volume - must be used by at least two build steps. + format: google-datetime + startTime: + description: Output only. Time at which execution of the build was started. + readOnly: true type: string - path: + format: google-datetime + finishTime: description: >- - Path at which to mount the volume. Paths must be absolute and cannot - conflict with other volume paths on the same build step or with - certain reserved volume paths. - type: string - GoogleDevtoolsCloudbuildV1TimeSpan: - id: GoogleDevtoolsCloudbuildV1TimeSpan - description: Start and end times for a build execution phase. - type: object - properties: - startTime: - description: Start of time span. + Output only. Time at which execution of the build was finished. The + difference between finish_time and start_time is the duration of the + build's execution. + readOnly: true type: string format: google-datetime - endTime: - description: End of time span. + timeout: + description: >- + Amount of time that this build should be allowed to run, to second + granularity. If this amount of time elapses, work on the build will + cease and the build status will be `TIMEOUT`. `timeout` starts + ticking from `startTime`. Default time is 60 minutes. type: string - format: google-datetime - GoogleDevtoolsCloudbuildV1Results: - id: GoogleDevtoolsCloudbuildV1Results - description: Artifacts created by the build pipeline. - type: object - properties: + format: google-duration images: - description: Container images that were built as a part of the build. - type: array - items: - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1BuiltImage' - buildStepImages: description: >- - List of build step digests, in the order corresponding to build step - indices. + A list of images to be pushed upon the successful completion of all + build steps. The images are pushed using the builder service + account's credentials. The digests of the pushed images will be + stored in the `Build` resource's results field. If any of the images + fail to be pushed, the build status is marked `FAILURE`. type: array items: type: string - artifactManifest: + queueTtl: description: >- - Path to the artifact manifest for non-container artifacts uploaded - to Cloud Storage. Only populated when artifacts are uploaded to - Cloud Storage. + TTL in queue for this build. If provided and the build is enqueued + longer than this value, the build will expire and the build status + will be `EXPIRED`. The TTL starts ticking from create_time. type: string - numArtifacts: + format: google-duration + artifacts: description: >- - Number of non-container artifacts uploaded to Cloud Storage. Only - populated when artifacts are uploaded to Cloud Storage. + Artifacts produced by the build that should be uploaded upon + successful completion of all build steps. + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1Artifacts' + logsBucket: + description: >- + Cloud Storage bucket where logs should be written (see [Bucket Name + Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). + Logs file names will be of the format + `${logs_bucket}/log-${build_id}.txt`. type: string - format: int64 - buildStepOutputs: + sourceProvenance: + description: Output only. A permanent fixed identifier for source. + readOnly: true + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1SourceProvenance' + buildTriggerId: description: >- - List of build step outputs, produced by builder images, in the order - corresponding to build step indices. [Cloud - Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) - can produce this output by writing to `$BUILDER_OUTPUT/output`. Only - the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` - variable is read-only and can't be substituted. + Output only. The ID of the `BuildTrigger` that triggered this build, + if it was triggered automatically. + readOnly: true + type: string + options: + description: Special options for this build. + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1BuildOptions' + logUrl: + description: Output only. URL to logs for this build in Google Cloud Console. + readOnly: true + type: string + substitutions: + description: Substitutions data for `Build` resource. + type: object + additionalProperties: + type: string + tags: + description: Tags for annotation of a `Build`. These are not docker tags. type: array items: type: string - format: byte - artifactTiming: - description: Time to push all non-container artifacts to Cloud Storage. - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1TimeSpan' - pythonPackages: + secrets: description: >- - Python artifacts uploaded to Artifact Registry at the end of the - build. + Secrets to decrypt using Cloud Key Management Service. Note: Secret + Manager is the recommended technique for managing sensitive data + with Cloud Build. Use `available_secrets` to configure builds to + access secrets from Secret Manager. For instructions, see: + https://cloud.google.com/cloud-build/docs/securing-builds/use-secrets type: array items: - $ref: >- - #/components/schemas/GoogleDevtoolsCloudbuildV1UploadedPythonPackage - mavenArtifacts: + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1Secret' + timing: description: >- - Maven artifacts uploaded to Artifact Registry at the end of the - build. + Output only. Stores timing information for phases of the build. + Valid keys are: * BUILD: time to execute all build steps. * PUSH: + time to push all artifacts including docker images and non docker + artifacts. * FETCHSOURCE: time to fetch source. * SETUPBUILD: time + to set up build. If the build does not specify source or images, + these keys will not be included. + readOnly: true + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1TimeSpan' + approval: + description: >- + Output only. Describes this build's approval configuration, status, + and result. + readOnly: true + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1BuildApproval' + serviceAccount: + description: >- + IAM service account whose credentials will be used at build runtime. + Must be of the format + `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. ACCOUNT can be + email address or uniqueId of the service account. + type: string + availableSecrets: + description: Secrets and secret environment variables. + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1Secrets' + warnings: + description: >- + Output only. Non-fatal problems encountered during the execution of + the build. + readOnly: true type: array items: - $ref: >- - #/components/schemas/GoogleDevtoolsCloudbuildV1UploadedMavenArtifact - npmPackages: - description: Npm packages uploaded to Artifact Registry at the end of the build. + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1Warning' + gitConfig: + description: Optional. Configuration for git operations. + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1GitConfig' + failureInfo: + description: >- + Output only. Contains information about the build when + status=FAILURE. + readOnly: true + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1FailureInfo' + dependencies: + description: >- + Optional. Dependencies that the Cloud Build worker will fetch before + executing user steps. type: array items: - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1UploadedNpmPackage' - GoogleDevtoolsCloudbuildV1BuiltImage: - id: GoogleDevtoolsCloudbuildV1BuiltImage - description: An image built by the pipeline. + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1Dependency' + GoogleDevtoolsCloudbuildV1Source: + id: GoogleDevtoolsCloudbuildV1Source + description: Location of the source in a supported storage service. type: object properties: - name: + storageSource: + description: If provided, get the source from this location in Cloud Storage. + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1StorageSource' + repoSource: description: >- - Name used to push the container image to Google Container Registry, - as presented to `docker push`. - type: string - digest: - description: Docker Registry 2.0 digest. - type: string - pushTiming: + If provided, get the source from this location in a Cloud Source + Repository. + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1RepoSource' + gitSource: + description: If provided, get the source from this Git repository. + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1GitSource' + storageSourceManifest: description: >- - Output only. Stores timing information for pushing the specified - image. - readOnly: true - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1TimeSpan' - GoogleDevtoolsCloudbuildV1UploadedPythonPackage: - id: GoogleDevtoolsCloudbuildV1UploadedPythonPackage - description: Artifact uploaded using the PythonPackage directive. + If provided, get the source from this manifest in Cloud Storage. + This feature is in Preview; see description + [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher). + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1StorageSourceManifest' + connectedRepository: + description: >- + Optional. If provided, get the source from this 2nd-gen Google Cloud + Build repository resource. + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1ConnectedRepository' + developerConnectConfig: + description: If provided, get the source from this Developer Connect config. + $ref: >- + #/components/schemas/GoogleDevtoolsCloudbuildV1DeveloperConnectConfig + GoogleDevtoolsCloudbuildV1StorageSource: + id: GoogleDevtoolsCloudbuildV1StorageSource + description: Location of the source in an archive file in Cloud Storage. type: object properties: - uri: - description: URI of the uploaded artifact. + bucket: + description: >- + Cloud Storage bucket containing the source (see [Bucket Name + Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). type: string - fileHashes: - description: Hash types and values of the Python Artifact. - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1FileHashes' - pushTiming: + object: description: >- - Output only. Stores timing information for pushing the specified - artifact. - readOnly: true - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1TimeSpan' - GoogleDevtoolsCloudbuildV1FileHashes: - id: GoogleDevtoolsCloudbuildV1FileHashes - description: >- - Container message for hashes of byte content of files, used in - SourceProvenance messages to verify integrity of source input to the - build. - type: object - properties: - fileHash: - description: Collection of file hashes. - type: array - items: - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1Hash' - GoogleDevtoolsCloudbuildV1Hash: - id: GoogleDevtoolsCloudbuildV1Hash - description: Container message for hash values. - type: object - properties: - type: - description: The type of hash that was performed. + Required. Cloud Storage object containing the source. This object + must be a zipped (`.zip`) or gzipped archive file (`.tar.gz`) + containing source to build. + type: string + generation: + description: >- + Optional. Cloud Storage generation for the object. If the generation + is omitted, the latest generation will be used. + type: string + format: int64 + sourceFetcher: + description: >- + Optional. Option to specify the tool to fetch the source file for + the build. type: string enumDescriptions: - - No hash requested. - - Use a sha256 hash. - - Use a md5 hash. - - Use a sha512 hash. + - Unspecified defaults to GSUTIL. + - Use the "gsutil" tool to download the source file. + - Use the Cloud Storage Fetcher tool to download the source file. enum: - - NONE - - SHA256 - - MD5 - - SHA512 - value: - description: The hash value. - type: string - format: byte - GoogleDevtoolsCloudbuildV1UploadedMavenArtifact: - id: GoogleDevtoolsCloudbuildV1UploadedMavenArtifact - description: A Maven artifact uploaded using the MavenArtifact directive. + - SOURCE_FETCHER_UNSPECIFIED + - GSUTIL + - GCS_FETCHER + GoogleDevtoolsCloudbuildV1RepoSource: + id: GoogleDevtoolsCloudbuildV1RepoSource + description: Location of the source in a Google Cloud Source Repository. type: object properties: - uri: - description: URI of the uploaded artifact. + projectId: + description: >- + Optional. ID of the project that owns the Cloud Source Repository. + If omitted, the project ID requesting the build is assumed. type: string - fileHashes: - description: Hash types and values of the Maven Artifact. - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1FileHashes' - pushTiming: + repoName: + description: Required. Name of the Cloud Source Repository. + type: string + branchName: description: >- - Output only. Stores timing information for pushing the specified - artifact. - readOnly: true - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1TimeSpan' - GoogleDevtoolsCloudbuildV1UploadedNpmPackage: - id: GoogleDevtoolsCloudbuildV1UploadedNpmPackage - description: >- - An npm package uploaded to Artifact Registry using the NpmPackage - directive. - type: object - properties: - uri: - description: URI of the uploaded npm package. + Regex matching branches to build. The syntax of the regular + expressions accepted is the syntax accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax type: string - fileHashes: - description: Hash types and values of the npm package. - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1FileHashes' - pushTiming: + tagName: description: >- - Output only. Stores timing information for pushing the specified - artifact. - readOnly: true - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1TimeSpan' - GoogleDevtoolsCloudbuildV1Artifacts: - id: GoogleDevtoolsCloudbuildV1Artifacts - description: >- - Artifacts produced by a build that should be uploaded upon successful - completion of all build steps. - type: object - properties: - images: + Regex matching tags to build. The syntax of the regular expressions + accepted is the syntax accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax + type: string + commitSha: + description: Explicit commit SHA to build. + type: string + dir: description: >- - A list of images to be pushed upon the successful completion of all - build steps. The images will be pushed using the builder service - account's credentials. The digests of the pushed images will be - stored in the Build resource's results field. If any of the images - fail to be pushed, the build is marked FAILURE. - type: array - items: - type: string - objects: + Optional. Directory, relative to the source root, in which to run + the build. This must be a relative path. If a step's `dir` is + specified and is an absolute path, this value is ignored for that + step's execution. + type: string + invertRegex: description: >- - A list of objects to be uploaded to Cloud Storage upon successful - completion of all build steps. Files in the workspace matching - specified paths globs will be uploaded to the specified Cloud - Storage location using the builder service account's credentials. - The location and generation of the uploaded objects will be stored - in the Build resource's results field. If any objects fail to be - pushed, the build is marked FAILURE. - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1ArtifactObjects' - mavenArtifacts: + Optional. Only trigger a build if the revision regex does NOT match + the revision regex. + type: boolean + substitutions: description: >- - A list of Maven artifacts to be uploaded to Artifact Registry upon - successful completion of all build steps. Artifacts in the workspace - matching specified paths globs will be uploaded to the specified - Artifact Registry repository using the builder service account's - credentials. If any artifacts fail to be pushed, the build is marked - FAILURE. - type: array - items: - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1MavenArtifact' - pythonPackages: + Optional. Substitutions to use in a triggered build. Should only be + used with RunBuildTrigger + type: object + additionalProperties: + type: string + GoogleDevtoolsCloudbuildV1GitSource: + id: GoogleDevtoolsCloudbuildV1GitSource + description: Location of the source in any accessible Git repository. + type: object + properties: + url: description: >- - A list of Python packages to be uploaded to Artifact Registry upon - successful completion of all build steps. The build service account - credentials will be used to perform the upload. If any objects fail - to be pushed, the build is marked FAILURE. - type: array - items: - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1PythonPackage' - npmPackages: + Required. Location of the Git repo to build. This will be used as a + `git remote`, see https://git-scm.com/docs/git-remote. + type: string + dir: description: >- - A list of npm packages to be uploaded to Artifact Registry upon - successful completion of all build steps. Npm packages in the - specified paths will be uploaded to the specified Artifact Registry - repository using the builder service account's credentials. If any - packages fail to be pushed, the build is marked FAILURE. - type: array - items: - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1NpmPackage' - GoogleDevtoolsCloudbuildV1ArtifactObjects: - id: GoogleDevtoolsCloudbuildV1ArtifactObjects + Optional. Directory, relative to the source root, in which to run + the build. This must be a relative path. If a step's `dir` is + specified and is an absolute path, this value is ignored for that + step's execution. + type: string + revision: + description: >- + Optional. The revision to fetch from the Git repository such as a + branch, a tag, a commit SHA, or any Git ref. Cloud Build uses `git + fetch` to fetch the revision from the Git repository; therefore make + sure that the string you provide for `revision` is parsable by the + command. For information on string values accepted by `git fetch`, + see https://git-scm.com/docs/gitrevisions#_specifying_revisions. For + information on `git fetch`, see https://git-scm.com/docs/git-fetch. + type: string + GoogleDevtoolsCloudbuildV1StorageSourceManifest: + id: GoogleDevtoolsCloudbuildV1StorageSourceManifest description: >- - Files in the workspace to upload to Cloud Storage upon successful - completion of all build steps. + Location of the source manifest in Cloud Storage. This feature is in + Preview; see description + [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher). type: object properties: - location: + bucket: description: >- - Cloud Storage bucket and optional object path, in the form - "gs://bucket/path/to/somewhere/". (see [Bucket Name + Required. Cloud Storage bucket containing the source manifest (see + [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). - Files in the workspace matching any path pattern will be uploaded to - Cloud Storage with this location as a prefix. type: string - paths: - description: Path globs used to match files in the build's workspace. - type: array - items: - type: string - timing: + object: description: >- - Output only. Stores timing information for pushing all artifact - objects. - readOnly: true - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1TimeSpan' - GoogleDevtoolsCloudbuildV1MavenArtifact: - id: GoogleDevtoolsCloudbuildV1MavenArtifact + Required. Cloud Storage object containing the source manifest. This + object must be a JSON file. + type: string + generation: + description: >- + Cloud Storage generation for the object. If the generation is + omitted, the latest generation will be used. + type: string + format: int64 + GoogleDevtoolsCloudbuildV1ConnectedRepository: + id: GoogleDevtoolsCloudbuildV1ConnectedRepository description: >- - A Maven artifact to upload to Artifact Registry upon successful - completion of all build steps. + Location of the source in a 2nd-gen Google Cloud Build repository + resource. type: object properties: repository: description: >- - Artifact Registry repository, in the form - "https://$REGION-maven.pkg.dev/$PROJECT/$REPOSITORY" Artifact in the - workspace specified by path will be uploaded to Artifact Registry - with this location as a prefix. + Required. Name of the Google Cloud Build repository, formatted as + `projects/*/locations/*/connections/*/repositories/*`. type: string - path: + dir: description: >- - Path to an artifact in the build's workspace to be uploaded to - Artifact Registry. This can be either an absolute path, e.g. - /workspace/my-app/target/my-app-1.0.SNAPSHOT.jar or a relative path - from /workspace, e.g. my-app/target/my-app-1.0.SNAPSHOT.jar. + Optional. Directory, relative to the source root, in which to run + the build. type: string - artifactId: + revision: description: >- - Maven `artifactId` value used when uploading the artifact to - Artifact Registry. + Required. The revision to fetch from the Git repository such as a + branch, a tag, a commit SHA, or any Git ref. type: string - groupId: + GoogleDevtoolsCloudbuildV1DeveloperConnectConfig: + id: GoogleDevtoolsCloudbuildV1DeveloperConnectConfig + description: This config defines the location of a source through Developer Connect. + type: object + properties: + gitRepositoryLink: description: >- - Maven `groupId` value used when uploading the artifact to Artifact - Registry. + Required. The Developer Connect Git repository link, formatted as + `projects/*/locations/*/connections/*/gitRepositoryLink/*`. type: string - version: + dir: description: >- - Maven `version` value used when uploading the artifact to Artifact - Registry. + Required. Directory, relative to the source root, in which to run + the build. type: string - GoogleDevtoolsCloudbuildV1PythonPackage: - id: GoogleDevtoolsCloudbuildV1PythonPackage - description: >- - Python package to upload to Artifact Registry upon successful completion - of all build steps. A package can encapsulate multiple objects to be - uploaded to a single repository. + revision: + description: >- + Required. The revision to fetch from the Git repository such as a + branch, a tag, a commit SHA, or any Git ref. + type: string + GoogleDevtoolsCloudbuildV1BuildStep: + id: GoogleDevtoolsCloudbuildV1BuildStep + description: A step in the build pipeline. type: object properties: - repository: + name: description: >- - Artifact Registry repository, in the form - "https://$REGION-python.pkg.dev/$PROJECT/$REPOSITORY" Files in the - workspace matching any path pattern will be uploaded to Artifact - Registry with this location as a prefix. + Required. The name of the container image that will run this + particular build step. If the image is available in the host's + Docker daemon's cache, it will be run directly. If not, the host + will attempt to pull the image first, using the builder service + account's credentials if necessary. The Docker daemon's cache will + already have the latest versions of all of the officially supported + build steps + ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). + The Docker daemon will also have cached many of the layers for some + popular images, like "ubuntu", "debian", but they will be refreshed + at the time you attempt to use them. If you built an image in a + previous build step, it will be stored in the host's Docker daemon's + cache and is available to use as the name for a later build step. type: string - paths: + env: description: >- - Path globs used to match files in the build's workspace. For Python/ - Twine, this is usually `dist/*`, and sometimes additionally an - `.asc` file. + A list of environment variable definitions to be used when running a + step. The elements are of the form "KEY=VALUE" for the environment + variable "KEY" being given the value "VALUE". type: array items: type: string - GoogleDevtoolsCloudbuildV1NpmPackage: - id: GoogleDevtoolsCloudbuildV1NpmPackage - description: >- - Npm package to upload to Artifact Registry upon successful completion of - all build steps. - type: object - properties: - repository: + args: description: >- - Artifact Registry repository, in the form - "https://$REGION-npm.pkg.dev/$PROJECT/$REPOSITORY" Npm package in - the workspace specified by path will be zipped and uploaded to - Artifact Registry with this location as a prefix. + A list of arguments that will be presented to the step when it is + started. If the image used to run the step's container has an + entrypoint, the `args` are used as arguments to that entrypoint. If + the image does not define an entrypoint, the first element in args + is used as the entrypoint, and the remainder will be used as + arguments. + type: array + items: + type: string + dir: + description: >- + Working directory to use when running this step's container. If this + value is a relative path, it is relative to the build's working + directory. If this value is absolute, it may be outside the build's + working directory, in which case the contents of the path may not be + persisted across build step executions, unless a `volume` for that + path is specified. If the build specifies a `RepoSource` with `dir` + and a step with a `dir`, which specifies an absolute path, the + `RepoSource` `dir` is ignored for the step's execution. type: string - packagePath: - description: Path to the package.json. e.g. workspace/path/to/package + id: + description: >- + Unique identifier for this build step, used in `wait_for` to + reference this build step as a dependency. type: string - GoogleDevtoolsCloudbuildV1SourceProvenance: - id: GoogleDevtoolsCloudbuildV1SourceProvenance - description: >- - Provenance of the source. Ways to find the original source, or verify - that some source was used for this build. - type: object - properties: - resolvedStorageSource: + waitFor: description: >- - A copy of the build's `source.storage_source`, if exists, with any - generations resolved. - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1StorageSource' - resolvedRepoSource: + The ID(s) of the step(s) that this build step depends on. This build + step will not start until all the build steps in `wait_for` have + completed successfully. If `wait_for` is empty, this build step will + start when all previous build steps in the `Build.Steps` list have + completed successfully. + type: array + items: + type: string + entrypoint: description: >- - A copy of the build's `source.repo_source`, if exists, with any - revisions resolved. - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1RepoSource' - resolvedStorageSourceManifest: + Entrypoint to be used instead of the build step image's default + entrypoint. If unset, the image's default entrypoint is used. + type: string + secretEnv: description: >- - A copy of the build's `source.storage_source_manifest`, if exists, - with any revisions resolved. This feature is in Preview. - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1StorageSourceManifest' - resolvedConnectedRepository: + A list of environment variables which are encrypted using a Cloud + Key Management Service crypto key. These values must be specified in + the build's `Secret`. + type: array + items: + type: string + volumes: description: >- - Output only. A copy of the build's `source.connected_repository`, if - exists, with any revisions resolved. - readOnly: true - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1ConnectedRepository' - resolvedGitSource: + List of volumes to mount into the build step. Each volume is created + as an empty volume prior to execution of the build step. Upon + completion of the build, volumes and their contents are discarded. + Using a named volume in only one step is not valid as it is + indicative of a build request with an incorrect configuration. + type: array + items: + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1Volume' + timing: description: >- - Output only. A copy of the build's `source.git_source`, if exists, - with any revisions resolved. + Output only. Stores timing information for executing this build + step. readOnly: true - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1GitSource' - fileHashes: + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1TimeSpan' + pullTiming: description: >- - Output only. Hash(es) of the build source, which can be used to - verify that the original source integrity was maintained in the - build. Note that `FileHashes` will only be populated if - `BuildOptions` has requested a `SourceProvenanceHash`. The keys to - this map are file paths used as build source and the values contain - the hash values for those files. If the build source came in a - single package such as a gzipped tarfile (`.tar.gz`), the `FileHash` - will be for the single path to that file. + Output only. Stores timing information for pulling this build step's + builder image only. readOnly: true - type: object - additionalProperties: - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1FileHashes' - GoogleDevtoolsCloudbuildV1BuildOptions: - id: GoogleDevtoolsCloudbuildV1BuildOptions - description: Optional arguments to enable specific features of builds. - type: object - properties: - sourceProvenanceHash: - description: Requested hash for SourceProvenance. - type: array - items: - type: string - enumDescriptions: - - No hash requested. - - Use a sha256 hash. - - Use a md5 hash. - - Use a sha512 hash. - enum: - - NONE - - SHA256 - - MD5 - - SHA512 - requestedVerifyOption: - description: Requested verifiability options. - type: string - enumDescriptions: - - Not a verifiable build (the default). - - Build must be verified. - enum: - - NOT_VERIFIED - - VERIFIED - machineType: - description: Compute Engine machine type on which to run the build. - type: string - enumDescriptions: - - Standard machine type. - - Highcpu machine with 8 CPUs. - - Highcpu machine with 32 CPUs. - - Highcpu e2 machine with 8 CPUs. - - Highcpu e2 machine with 32 CPUs. - - E2 machine with 1 CPU. - enumDeprecated: - - false - - true - - true - - false - - false - - false - enum: - - UNSPECIFIED - - N1_HIGHCPU_8 - - N1_HIGHCPU_32 - - E2_HIGHCPU_8 - - E2_HIGHCPU_32 - - E2_MEDIUM - diskSizeGb: + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1TimeSpan' + timeout: description: >- - Requested disk size for the VM that runs the build. Note that this - is *NOT* "disk free"; some of the space will be used by the - operating system and build utilities. Also note that this is the - minimum disk size that will be allocated for the build -- the build - may run with a larger disk than requested. At present, the maximum - disk size is 4000GB; builds that request more than the maximum are - rejected with an error. + Time limit for executing this build step. If not defined, the step + has no time limit and will be allowed to continue to run until + either it completes or the build itself times out. type: string - format: int64 - substitutionOption: + format: google-duration + status: description: >- - Option to specify behavior when there is an error in the - substitution checks. NOTE: this is always set to ALLOW_LOOSE for - triggered builds and cannot be overridden in the build configuration - file. + Output only. Status of the build step. At this time, build step + status is only updated on build completion; step status is not + updated in real-time as the build progresses. + readOnly: true type: string enumDescriptions: + - Status of the build is unknown. - >- - Fails the build if error in substitutions checks, like missing a - substitution in the template or in the map. - - Do not fail the build if error in substitutions checks. + Build has been created and is pending execution and queuing. It + has not been queued. + - Build or step is queued; work has not yet begun. + - Build or step is being executed. + - Build or step finished successfully. + - Build or step failed to complete successfully. + - Build or step failed due to an internal cause. + - Build or step took longer than was allowed. + - Build or step was canceled by a user. + - Build was enqueued for longer than the value of `queue_ttl`. enum: - - MUST_MATCH - - ALLOW_LOOSE - dynamicSubstitutions: + - STATUS_UNKNOWN + - PENDING + - QUEUED + - WORKING + - SUCCESS + - FAILURE + - INTERNAL_ERROR + - TIMEOUT + - CANCELLED + - EXPIRED + allowFailure: description: >- - Option to specify whether or not to apply bash style string - operations to the substitutions. NOTE: this is always enabled for - triggered builds and cannot be overridden in the build configuration - file. + Allow this build step to fail without failing the entire build. If + false, the entire build will fail if this step fails. Otherwise, the + build will succeed, but this step will still have a failure status. + Error information will be reported in the failure_detail field. type: boolean - automapSubstitutions: - description: >- + exitCode: + description: Output only. Return code from running the step. + readOnly: true + type: integer + format: int32 + allowExitCodes: + description: >- + Allow this build step to fail without failing the entire build if + and only if the exit code is one of the specified codes. If + allow_failure is also specified, this field will take precedence. + type: array + items: + type: integer + format: int32 + script: + description: >- + A shell script to be executed in the step. When script is provided, + the user cannot specify the entrypoint or args. + type: string + automapSubstitutions: + description: >- Option to include built-in and custom substitutions as env variables - for all build steps. + for this build step. This option will override the global option in + BuildOption. type: boolean - logStreamingOption: - description: Option to define build log streaming behavior to Cloud Storage. + GoogleDevtoolsCloudbuildV1Volume: + id: GoogleDevtoolsCloudbuildV1Volume + description: >- + Volume describes a Docker container volume which is mounted into build + steps in order to persist files across build step execution. + type: object + properties: + name: + description: >- + Name of the volume to mount. Volume names must be unique per build + step and must be valid names for Docker volumes. Each named volume + must be used by at least two build steps. type: string - enumDescriptions: - - Service may automatically determine build log streaming behavior. - - Build logs should be streamed to Cloud Storage. - - >- - Build logs should not be streamed to Cloud Storage; they will be - written when the build is completed. - enum: - - STREAM_DEFAULT - - STREAM_ON - - STREAM_OFF - workerPool: - description: This field deprecated; please use `pool.name` instead. - deprecated: true + path: + description: >- + Path at which to mount the volume. Paths must be absolute and cannot + conflict with other volume paths on the same build step or with + certain reserved volume paths. type: string - pool: + GoogleDevtoolsCloudbuildV1TimeSpan: + id: GoogleDevtoolsCloudbuildV1TimeSpan + description: Start and end times for a build execution phase. + type: object + properties: + startTime: + description: Start of time span. + type: string + format: google-datetime + endTime: + description: End of time span. + type: string + format: google-datetime + GoogleDevtoolsCloudbuildV1Results: + id: GoogleDevtoolsCloudbuildV1Results + description: Artifacts created by the build pipeline. + type: object + properties: + images: + description: Container images that were built as a part of the build. + type: array + items: + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1BuiltImage' + buildStepImages: description: >- - Optional. Specification for execution on a `WorkerPool`. See - [running builds in a private - pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) - for more information. - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1PoolOption' - logging: + List of build step digests, in the order corresponding to build step + indices. + type: array + items: + type: string + artifactManifest: description: >- - Option to specify the logging mode, which determines if and where - build logs are stored. + Path to the artifact manifest for non-container artifacts uploaded + to Cloud Storage. Only populated when artifacts are uploaded to + Cloud Storage. type: string - enumDescriptions: - - >- - The service determines the logging mode. The default is `LEGACY`. - Do not rely on the default logging behavior as it may change in - the future. - - Build logs are stored in Cloud Logging and Cloud Storage. - - Build logs are stored in Cloud Storage. - - This option is the same as CLOUD_LOGGING_ONLY. - - >- - Build logs are stored in Cloud Logging. Selecting this option will - not allow [logs - streaming](https://cloud.google.com/sdk/gcloud/reference/builds/log). - - Turn off all logging. No build logs will be captured. - enumDeprecated: - - false - - false - - false - - true - - false - - false - enum: - - LOGGING_UNSPECIFIED - - LEGACY - - GCS_ONLY - - STACKDRIVER_ONLY - - CLOUD_LOGGING_ONLY - - NONE - env: + numArtifacts: description: >- - A list of global environment variable definitions that will exist - for all build steps in this build. If a variable is defined in both - globally and in a build step, the variable will use the build step - value. The elements are of the form "KEY=VALUE" for the environment - variable "KEY" being given the value "VALUE". + Number of non-container artifacts uploaded to Cloud Storage. Only + populated when artifacts are uploaded to Cloud Storage. + type: string + format: int64 + buildStepOutputs: + description: >- + List of build step outputs, produced by builder images, in the order + corresponding to build step indices. [Cloud + Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) + can produce this output by writing to `$BUILDER_OUTPUT/output`. Only + the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` + variable is read-only and can't be substituted. type: array items: type: string - secretEnv: + format: byte + artifactTiming: + description: Time to push all non-container artifacts to Cloud Storage. + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1TimeSpan' + pythonPackages: description: >- - A list of global environment variables, which are encrypted using a - Cloud Key Management Service crypto key. These values must be - specified in the build's `Secret`. These variables will be available - to all build steps in this build. + Python artifacts uploaded to Artifact Registry at the end of the + build. type: array items: - type: string - volumes: + $ref: >- + #/components/schemas/GoogleDevtoolsCloudbuildV1UploadedPythonPackage + mavenArtifacts: description: >- - Global list of volumes to mount for ALL build steps Each volume is - created as an empty volume prior to starting the build process. Upon - completion of the build, volumes and their contents are discarded. - Global volume names and paths cannot conflict with the volumes - defined a build step. Using a global volume in a build with only one - step is not valid as it is indicative of a build request with an - incorrect configuration. + Maven artifacts uploaded to Artifact Registry at the end of the + build. type: array items: - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1Volume' - defaultLogsBucketBehavior: - description: Optional. Option to specify how default logs buckets are setup. - type: string - enumDescriptions: - - Unspecified. - - >- - Bucket is located in user-owned project in the same region as the - build. The builder service account must have access to create and - write to Cloud Storage buckets in the build project. - - >- - Bucket is located in a Google-owned project and is not - regionalized. - enum: - - DEFAULT_LOGS_BUCKET_BEHAVIOR_UNSPECIFIED - - REGIONAL_USER_OWNED_BUCKET - - LEGACY_BUCKET - GoogleDevtoolsCloudbuildV1PoolOption: - id: GoogleDevtoolsCloudbuildV1PoolOption - description: >- - Details about how a build should be executed on a `WorkerPool`. See - [running builds in a private - pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) - for more information. + $ref: >- + #/components/schemas/GoogleDevtoolsCloudbuildV1UploadedMavenArtifact + goModules: + description: >- + Optional. Go module artifacts uploaded to Artifact Registry at the + end of the build. + type: array + items: + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1UploadedGoModule' + npmPackages: + description: Npm packages uploaded to Artifact Registry at the end of the build. + type: array + items: + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1UploadedNpmPackage' + GoogleDevtoolsCloudbuildV1BuiltImage: + id: GoogleDevtoolsCloudbuildV1BuiltImage + description: An image built by the pipeline. type: object properties: name: description: >- - The `WorkerPool` resource to execute the build on. You must have - `cloudbuild.workerpools.use` on the project hosting the WorkerPool. - Format - projects/{project}/locations/{location}/workerPools/{workerPoolId} + Name used to push the container image to Google Container Registry, + as presented to `docker push`. type: string - GoogleDevtoolsCloudbuildV1Secret: - id: GoogleDevtoolsCloudbuildV1Secret - description: >- - Pairs a set of secret environment variables containing encrypted values - with the Cloud KMS key to use to decrypt the value. Note: Use - `kmsKeyName` with `available_secrets` instead of using `kmsKeyName` with - `secret`. For instructions see: - https://cloud.google.com/cloud-build/docs/securing-builds/use-encrypted-credentials. - type: object - properties: - kmsKeyName: - description: Cloud KMS key name to use to decrypt these envs. + digest: + description: Docker Registry 2.0 digest. type: string - secretEnv: + pushTiming: description: >- - Map of environment variable name to its encrypted value. Secret - environment variables must be unique across all of a build's - secrets, and must be used by at least one build step. Values can be - at most 64 KB in size. There can be at most 100 secret values across - all of a build's secrets. - type: object - additionalProperties: - type: string - format: byte - GoogleDevtoolsCloudbuildV1BuildApproval: - id: GoogleDevtoolsCloudbuildV1BuildApproval - description: >- - BuildApproval describes a build's approval configuration, state, and - result. + Output only. Stores timing information for pushing the specified + image. + readOnly: true + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1TimeSpan' + GoogleDevtoolsCloudbuildV1UploadedPythonPackage: + id: GoogleDevtoolsCloudbuildV1UploadedPythonPackage + description: Artifact uploaded using the PythonPackage directive. type: object properties: - state: - description: Output only. The state of this build's approval. - readOnly: true + uri: + description: URI of the uploaded artifact. type: string - enumDescriptions: - - Default enum type. This should not be used. - - Build approval is pending. - - Build approval has been approved. - - Build approval has been rejected. - - Build was cancelled while it was still pending approval. - enum: - - STATE_UNSPECIFIED - - PENDING - - APPROVED - - REJECTED - - CANCELLED - config: - description: Output only. Configuration for manual approval of this build. - readOnly: true - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1ApprovalConfig' - result: - description: Output only. Result of manual approval for this Build. + fileHashes: + description: Hash types and values of the Python Artifact. + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1FileHashes' + pushTiming: + description: >- + Output only. Stores timing information for pushing the specified + artifact. readOnly: true - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1ApprovalResult' - GoogleDevtoolsCloudbuildV1ApprovalConfig: - id: GoogleDevtoolsCloudbuildV1ApprovalConfig - description: ApprovalConfig describes configuration for manual approval of a build. + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1TimeSpan' + GoogleDevtoolsCloudbuildV1FileHashes: + id: GoogleDevtoolsCloudbuildV1FileHashes + description: >- + Container message for hashes of byte content of files, used in + SourceProvenance messages to verify integrity of source input to the + build. type: object properties: - approvalRequired: - description: >- - Whether or not approval is needed. If this is set on a build, it - will become pending when created, and will need to be explicitly - approved to start. - type: boolean - GoogleDevtoolsCloudbuildV1ApprovalResult: - id: GoogleDevtoolsCloudbuildV1ApprovalResult - description: >- - ApprovalResult describes the decision and associated metadata of a - manual approval of a build. + fileHash: + description: Collection of file hashes. + type: array + items: + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1Hash' + GoogleDevtoolsCloudbuildV1Hash: + id: GoogleDevtoolsCloudbuildV1Hash + description: Container message for hash values. type: object properties: - approverAccount: - description: >- - Output only. Email of the user that called the ApproveBuild API to - approve or reject a build at the time that the API was called. - readOnly: true - type: string - approvalTime: - description: Output only. The time when the approval decision was made. - readOnly: true - type: string - format: google-datetime - decision: - description: Required. The decision of this manual approval. + type: + description: The type of hash that was performed. type: string enumDescriptions: - - Default enum type. This should not be used. - - Build is approved. - - Build is rejected. + - No hash requested. + - Use a sha256 hash. + - Use a md5 hash. + - Dirhash of a Go module's source code which is then hex-encoded. + - Use a sha512 hash. enum: - - DECISION_UNSPECIFIED - - APPROVED - - REJECTED - comment: - description: Optional. An optional comment for this manual approval result. + - NONE + - SHA256 + - MD5 + - GO_MODULE_H1 + - SHA512 + value: + description: The hash value. type: string - url: + format: byte + GoogleDevtoolsCloudbuildV1UploadedMavenArtifact: + id: GoogleDevtoolsCloudbuildV1UploadedMavenArtifact + description: A Maven artifact uploaded using the MavenArtifact directive. + type: object + properties: + uri: + description: URI of the uploaded artifact. + type: string + fileHashes: + description: Hash types and values of the Maven Artifact. + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1FileHashes' + pushTiming: description: >- - Optional. An optional URL tied to this manual approval result. This - field is essentially the same as comment, except that it will be - rendered by the UI differently. An example use case is a link to an - external job that approved this Build. + Output only. Stores timing information for pushing the specified + artifact. + readOnly: true + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1TimeSpan' + GoogleDevtoolsCloudbuildV1UploadedGoModule: + id: GoogleDevtoolsCloudbuildV1UploadedGoModule + description: >- + A Go module artifact uploaded to Artifact Registry using the GoModule + directive. + type: object + properties: + uri: + description: URI of the uploaded artifact. type: string - GoogleDevtoolsCloudbuildV1Secrets: - id: GoogleDevtoolsCloudbuildV1Secrets - description: Secrets and secret environment variables. + fileHashes: + description: Hash types and values of the Go Module Artifact. + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1FileHashes' + pushTiming: + description: >- + Output only. Stores timing information for pushing the specified + artifact. + readOnly: true + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1TimeSpan' + GoogleDevtoolsCloudbuildV1UploadedNpmPackage: + id: GoogleDevtoolsCloudbuildV1UploadedNpmPackage + description: >- + An npm package uploaded to Artifact Registry using the NpmPackage + directive. type: object properties: - secretManager: + uri: + description: URI of the uploaded npm package. + type: string + fileHashes: + description: Hash types and values of the npm package. + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1FileHashes' + pushTiming: description: >- - Secrets in Secret Manager and associated secret environment - variable. + Output only. Stores timing information for pushing the specified + artifact. + readOnly: true + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1TimeSpan' + GoogleDevtoolsCloudbuildV1Artifacts: + id: GoogleDevtoolsCloudbuildV1Artifacts + description: >- + Artifacts produced by a build that should be uploaded upon successful + completion of all build steps. + type: object + properties: + images: + description: >- + A list of images to be pushed upon the successful completion of all + build steps. The images will be pushed using the builder service + account's credentials. The digests of the pushed images will be + stored in the Build resource's results field. If any of the images + fail to be pushed, the build is marked FAILURE. type: array items: - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1SecretManagerSecret' - inline: + type: string + objects: description: >- - Secrets encrypted with KMS key and the associated secret environment - variable. + A list of objects to be uploaded to Cloud Storage upon successful + completion of all build steps. Files in the workspace matching + specified paths globs will be uploaded to the specified Cloud + Storage location using the builder service account's credentials. + The location and generation of the uploaded objects will be stored + in the Build resource's results field. If any objects fail to be + pushed, the build is marked FAILURE. + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1ArtifactObjects' + mavenArtifacts: + description: >- + A list of Maven artifacts to be uploaded to Artifact Registry upon + successful completion of all build steps. Artifacts in the workspace + matching specified paths globs will be uploaded to the specified + Artifact Registry repository using the builder service account's + credentials. If any artifacts fail to be pushed, the build is marked + FAILURE. type: array items: - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1InlineSecret' - GoogleDevtoolsCloudbuildV1SecretManagerSecret: - id: GoogleDevtoolsCloudbuildV1SecretManagerSecret + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1MavenArtifact' + goModules: + description: >- + Optional. A list of Go modules to be uploaded to Artifact Registry + upon successful completion of all build steps. If any objects fail + to be pushed, the build is marked FAILURE. + type: array + items: + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1GoModule' + pythonPackages: + description: >- + A list of Python packages to be uploaded to Artifact Registry upon + successful completion of all build steps. The build service account + credentials will be used to perform the upload. If any objects fail + to be pushed, the build is marked FAILURE. + type: array + items: + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1PythonPackage' + npmPackages: + description: >- + A list of npm packages to be uploaded to Artifact Registry upon + successful completion of all build steps. Npm packages in the + specified paths will be uploaded to the specified Artifact Registry + repository using the builder service account's credentials. If any + packages fail to be pushed, the build is marked FAILURE. + type: array + items: + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1NpmPackage' + GoogleDevtoolsCloudbuildV1ArtifactObjects: + id: GoogleDevtoolsCloudbuildV1ArtifactObjects description: >- - Pairs a secret environment variable with a SecretVersion in Secret - Manager. + Files in the workspace to upload to Cloud Storage upon successful + completion of all build steps. type: object properties: - versionName: + location: description: >- - Resource name of the SecretVersion. In format: - projects/*/secrets/*/versions/* + Cloud Storage bucket and optional object path, in the form + "gs://bucket/path/to/somewhere/". (see [Bucket Name + Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). + Files in the workspace matching any path pattern will be uploaded to + Cloud Storage with this location as a prefix. type: string - env: + paths: + description: Path globs used to match files in the build's workspace. + type: array + items: + type: string + timing: description: >- - Environment variable name to associate with the secret. Secret - environment variables must be unique across all of a build's - secrets, and must be used by at least one build step. - type: string - GoogleDevtoolsCloudbuildV1InlineSecret: - id: GoogleDevtoolsCloudbuildV1InlineSecret + Output only. Stores timing information for pushing all artifact + objects. + readOnly: true + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1TimeSpan' + GoogleDevtoolsCloudbuildV1MavenArtifact: + id: GoogleDevtoolsCloudbuildV1MavenArtifact description: >- - Pairs a set of secret environment variables mapped to encrypted values - with the Cloud KMS key to use to decrypt the value. + A Maven artifact to upload to Artifact Registry upon successful + completion of all build steps. type: object properties: - kmsKeyName: + repository: description: >- - Resource name of Cloud KMS crypto key to decrypt the encrypted - value. In format: projects/*/locations/*/keyRings/*/cryptoKeys/* + Artifact Registry repository, in the form + "https://$REGION-maven.pkg.dev/$PROJECT/$REPOSITORY" Artifact in the + workspace specified by path will be uploaded to Artifact Registry + with this location as a prefix. type: string - envMap: + path: description: >- - Map of environment variable name to its encrypted value. Secret - environment variables must be unique across all of a build's - secrets, and must be used by at least one build step. Values can be - at most 64 KB in size. There can be at most 100 secret values across - all of a build's secrets. - type: object - additionalProperties: - type: string - format: byte - GoogleDevtoolsCloudbuildV1Warning: - id: GoogleDevtoolsCloudbuildV1Warning - description: A non-fatal problem encountered during the execution of the build. + Optional. Path to an artifact in the build's workspace to be + uploaded to Artifact Registry. This can be either an absolute path, + e.g. /workspace/my-app/target/my-app-1.0.SNAPSHOT.jar or a relative + path from /workspace, e.g. my-app/target/my-app-1.0.SNAPSHOT.jar. + type: string + artifactId: + description: >- + Maven `artifactId` value used when uploading the artifact to + Artifact Registry. + type: string + groupId: + description: >- + Maven `groupId` value used when uploading the artifact to Artifact + Registry. + type: string + version: + description: >- + Maven `version` value used when uploading the artifact to Artifact + Registry. + type: string + GoogleDevtoolsCloudbuildV1GoModule: + id: GoogleDevtoolsCloudbuildV1GoModule + description: >- + Go module to upload to Artifact Registry upon successful completion of + all build steps. A module refers to all dependencies in a go.mod file. type: object properties: - text: - description: Explanation of the warning generated. + repositoryName: + description: >- + Optional. Artifact Registry repository name. Specified Go modules + will be zipped and uploaded to Artifact Registry with this location + as a prefix. e.g. my-go-repo type: string - priority: - description: The priority for this warning. + repositoryLocation: + description: >- + Optional. Location of the Artifact Registry repository. i.e. + us-east1 Defaults to the build’s location. type: string - enumDescriptions: - - Should not be used. - - e.g. deprecation warnings and alternative feature highlights. - - e.g. automated detection of possible issues with the build. - - e.g. alerts that a feature used in the build is pending removal - enum: - - PRIORITY_UNSPECIFIED - - INFO - - WARNING - - ALERT - GoogleDevtoolsCloudbuildV1GitConfig: - id: GoogleDevtoolsCloudbuildV1GitConfig - description: GitConfig is a configuration for git operations. + repositoryProjectId: + description: >- + Optional. Project ID of the Artifact Registry repository. Defaults + to the build project. + type: string + sourcePath: + description: >- + Optional. Source path of the go.mod file in the build's workspace. + If not specified, this will default to the current directory. e.g. + ~/code/go/mypackage + type: string + modulePath: + description: Optional. The Go module's "module path". e.g. example.com/foo/v2 + type: string + moduleVersion: + description: >- + Optional. The Go module's semantic version in the form vX.Y.Z. e.g. + v0.1.1 Pre-release identifiers can also be added by appending a dash + and dot separated ASCII alphanumeric characters and hyphens. e.g. + v0.2.3-alpha.x.12m.5 + type: string + GoogleDevtoolsCloudbuildV1PythonPackage: + id: GoogleDevtoolsCloudbuildV1PythonPackage + description: >- + Python package to upload to Artifact Registry upon successful completion + of all build steps. A package can encapsulate multiple objects to be + uploaded to a single repository. type: object properties: - http: - description: Configuration for HTTP related git operations. - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1HttpConfig' - GoogleDevtoolsCloudbuildV1HttpConfig: - id: GoogleDevtoolsCloudbuildV1HttpConfig - description: HttpConfig is a configuration for HTTP related git operations. + repository: + description: >- + Artifact Registry repository, in the form + "https://$REGION-python.pkg.dev/$PROJECT/$REPOSITORY" Files in the + workspace matching any path pattern will be uploaded to Artifact + Registry with this location as a prefix. + type: string + paths: + description: >- + Path globs used to match files in the build's workspace. For Python/ + Twine, this is usually `dist/*`, and sometimes additionally an + `.asc` file. + type: array + items: + type: string + GoogleDevtoolsCloudbuildV1NpmPackage: + id: GoogleDevtoolsCloudbuildV1NpmPackage + description: >- + Npm package to upload to Artifact Registry upon successful completion of + all build steps. type: object properties: - proxySecretVersionName: + repository: description: >- - SecretVersion resource of the HTTP proxy URL. The Service Account - used in the build (either the default Service Account or - user-specified Service Account) should have - `secretmanager.versions.access` permissions on this secret. The - proxy URL should be in format `protocol://@]proxyhost[:port]`. + Artifact Registry repository, in the form + "https://$REGION-npm.pkg.dev/$PROJECT/$REPOSITORY" Npm package in + the workspace specified by path will be zipped and uploaded to + Artifact Registry with this location as a prefix. type: string - GoogleDevtoolsCloudbuildV1FailureInfo: - id: GoogleDevtoolsCloudbuildV1FailureInfo - description: A fatal problem encountered during the execution of the build. + packagePath: + description: Path to the package.json. e.g. workspace/path/to/package + type: string + GoogleDevtoolsCloudbuildV1SourceProvenance: + id: GoogleDevtoolsCloudbuildV1SourceProvenance + description: >- + Provenance of the source. Ways to find the original source, or verify + that some source was used for this build. type: object properties: - type: - description: The name of the failure. + resolvedStorageSource: + description: >- + A copy of the build's `source.storage_source`, if exists, with any + generations resolved. + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1StorageSource' + resolvedRepoSource: + description: >- + A copy of the build's `source.repo_source`, if exists, with any + revisions resolved. + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1RepoSource' + resolvedStorageSourceManifest: + description: >- + A copy of the build's `source.storage_source_manifest`, if exists, + with any revisions resolved. This feature is in Preview. + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1StorageSourceManifest' + resolvedConnectedRepository: + description: >- + Output only. A copy of the build's `source.connected_repository`, if + exists, with any revisions resolved. + readOnly: true + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1ConnectedRepository' + resolvedGitSource: + description: >- + Output only. A copy of the build's `source.git_source`, if exists, + with any revisions resolved. + readOnly: true + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1GitSource' + fileHashes: + description: >- + Output only. Hash(es) of the build source, which can be used to + verify that the original source integrity was maintained in the + build. Note that `FileHashes` will only be populated if + `BuildOptions` has requested a `SourceProvenanceHash`. The keys to + this map are file paths used as build source and the values contain + the hash values for those files. If the build source came in a + single package such as a gzipped tarfile (`.tar.gz`), the `FileHash` + will be for the single path to that file. + readOnly: true + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1FileHashes' + GoogleDevtoolsCloudbuildV1BuildOptions: + id: GoogleDevtoolsCloudbuildV1BuildOptions + description: Optional arguments to enable specific features of builds. + type: object + properties: + sourceProvenanceHash: + description: Requested hash for SourceProvenance. + type: array + items: + type: string + enumDescriptions: + - No hash requested. + - Use a sha256 hash. + - Use a md5 hash. + - Dirhash of a Go module's source code which is then hex-encoded. + - Use a sha512 hash. + enum: + - NONE + - SHA256 + - MD5 + - GO_MODULE_H1 + - SHA512 + requestedVerifyOption: + description: Requested verifiability options. type: string enumDescriptions: - - Type unspecified - - Unable to push the image to the repository. - - Final image not found. - - Unauthorized push of the final image. - - Backend logging failures. Should retry. - - A build step has failed. - - The source fetching has failed. + - Not a verifiable build (the default). + - Build must be verified. enum: - - FAILURE_TYPE_UNSPECIFIED - - PUSH_FAILED - - PUSH_IMAGE_NOT_FOUND - - PUSH_NOT_AUTHORIZED - - LOGGING_FAILURE - - USER_BUILD_STEP - - FETCH_SOURCE_FAILED - detail: - description: Explains the failure issue in more detail using hard-coded text. + - NOT_VERIFIED + - VERIFIED + machineType: + description: Compute Engine machine type on which to run the build. type: string - parameters: - 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: - type: string - enum: - - json - - media - - proto - 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 - upload_protocol: + enumDescriptions: + - Standard machine type. + - Highcpu machine with 8 CPUs. + - Highcpu machine with 32 CPUs. + - Highcpu e2 machine with 8 CPUs. + - Highcpu e2 machine with 32 CPUs. + - E2 machine with 1 CPU. + enumDeprecated: + - false + - true + - true + - false + - false + - false + enum: + - UNSPECIFIED + - N1_HIGHCPU_8 + - N1_HIGHCPU_32 + - E2_HIGHCPU_8 + - E2_HIGHCPU_32 + - E2_MEDIUM + diskSizeGb: + description: >- + Requested disk size for the VM that runs the build. Note that this + is *NOT* "disk free"; some of the space will be used by the + operating system and build utilities. Also note that this is the + minimum disk size that will be allocated for the build -- the build + may run with a larger disk than requested. At present, the maximum + disk size is 4000GB; builds that request more than the maximum are + rejected with an error. + type: string + format: int64 + substitutionOption: + description: >- + Option to specify behavior when there is an error in the + substitution checks. NOTE: this is always set to ALLOW_LOOSE for + triggered builds and cannot be overridden in the build configuration + file. + type: string + enumDescriptions: + - >- + Fails the build if error in substitutions checks, like missing a + substitution in the template or in the map. + - Do not fail the build if error in substitutions checks. + enum: + - MUST_MATCH + - ALLOW_LOOSE + dynamicSubstitutions: + description: >- + Option to specify whether or not to apply bash style string + operations to the substitutions. NOTE: this is always enabled for + triggered builds and cannot be overridden in the build configuration + file. + type: boolean + automapSubstitutions: + description: >- + Option to include built-in and custom substitutions as env variables + for all build steps. + type: boolean + logStreamingOption: + description: Option to define build log streaming behavior to Cloud Storage. + type: string + enumDescriptions: + - Service may automatically determine build log streaming behavior. + - Build logs should be streamed to Cloud Storage. + - >- + Build logs should not be streamed to Cloud Storage; they will be + written when the build is completed. + enum: + - STREAM_DEFAULT + - STREAM_ON + - STREAM_OFF + workerPool: + description: This field deprecated; please use `pool.name` instead. + deprecated: true + type: string + pool: + description: >- + Optional. Specification for execution on a `WorkerPool`. See + [running builds in a private + pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) + for more information. + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1PoolOption' + logging: + description: >- + Option to specify the logging mode, which determines if and where + build logs are stored. + type: string + enumDescriptions: + - >- + The service determines the logging mode. The default is `LEGACY`. + Do not rely on the default logging behavior as it may change in + the future. + - Build logs are stored in Cloud Logging and Cloud Storage. + - Build logs are stored in Cloud Storage. + - This option is the same as CLOUD_LOGGING_ONLY. + - >- + Build logs are stored in Cloud Logging. Selecting this option will + not allow [logs + streaming](https://cloud.google.com/sdk/gcloud/reference/builds/log). + - Turn off all logging. No build logs will be captured. + enumDeprecated: + - false + - false + - false + - true + - false + - false + enum: + - LOGGING_UNSPECIFIED + - LEGACY + - GCS_ONLY + - STACKDRIVER_ONLY + - CLOUD_LOGGING_ONLY + - NONE + env: + description: >- + A list of global environment variable definitions that will exist + for all build steps in this build. If a variable is defined in both + globally and in a build step, the variable will use the build step + value. The elements are of the form "KEY=VALUE" for the environment + variable "KEY" being given the value "VALUE". + type: array + items: + type: string + secretEnv: + description: >- + A list of global environment variables, which are encrypted using a + Cloud Key Management Service crypto key. These values must be + specified in the build's `Secret`. These variables will be available + to all build steps in this build. + type: array + items: + type: string + volumes: + description: >- + Global list of volumes to mount for ALL build steps Each volume is + created as an empty volume prior to starting the build process. Upon + completion of the build, volumes and their contents are discarded. + Global volume names and paths cannot conflict with the volumes + defined a build step. Using a global volume in a build with only one + step is not valid as it is indicative of a build request with an + incorrect configuration. + type: array + items: + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1Volume' + defaultLogsBucketBehavior: + description: Optional. Option to specify how default logs buckets are setup. + type: string + enumDescriptions: + - Unspecified. + - >- + Bucket is located in user-owned project in the same region as the + build. The builder service account must have access to create and + write to Cloud Storage buckets in the build project. + - >- + Bucket is located in a Google-owned project and is not + regionalized. + enum: + - DEFAULT_LOGS_BUCKET_BEHAVIOR_UNSPECIFIED + - REGIONAL_USER_OWNED_BUCKET + - LEGACY_BUCKET + enableStructuredLogging: + description: >- + Optional. Option to specify whether structured logging is enabled. + If true, JSON-formatted logs are parsed as structured logs. + type: boolean + pubsubTopic: + description: >- + Optional. Option to specify the Pub/Sub topic to receive build + status updates. + type: string + GoogleDevtoolsCloudbuildV1PoolOption: + id: GoogleDevtoolsCloudbuildV1PoolOption + description: >- + Details about how a build should be executed on a `WorkerPool`. See + [running builds in a private + pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) + for more information. + type: object + properties: + name: + description: >- + The `WorkerPool` resource to execute the build on. You must have + `cloudbuild.workerpools.use` on the project hosting the WorkerPool. + Format + projects/{project}/locations/{location}/workerPools/{workerPoolId} + type: string + GoogleDevtoolsCloudbuildV1Secret: + id: GoogleDevtoolsCloudbuildV1Secret + description: >- + Pairs a set of secret environment variables containing encrypted values + with the Cloud KMS key to use to decrypt the value. Note: Use + `kmsKeyName` with `available_secrets` instead of using `kmsKeyName` with + `secret`. For instructions see: + https://cloud.google.com/cloud-build/docs/securing-builds/use-encrypted-credentials. + type: object + properties: + kmsKeyName: + description: Cloud KMS key name to use to decrypt these envs. + type: string + secretEnv: + description: >- + Map of environment variable name to its encrypted value. Secret + environment variables must be unique across all of a build's + secrets, and must be used by at least one build step. Values can be + at most 64 KB in size. There can be at most 100 secret values across + all of a build's secrets. + type: object + additionalProperties: + type: string + format: byte + GoogleDevtoolsCloudbuildV1BuildApproval: + id: GoogleDevtoolsCloudbuildV1BuildApproval + description: >- + BuildApproval describes a build's approval configuration, state, and + result. + type: object + properties: + state: + description: Output only. The state of this build's approval. + readOnly: true + type: string + enumDescriptions: + - Default enum type. This should not be used. + - Build approval is pending. + - Build approval has been approved. + - Build approval has been rejected. + - Build was cancelled while it was still pending approval. + enum: + - STATE_UNSPECIFIED + - PENDING + - APPROVED + - REJECTED + - CANCELLED + config: + description: Output only. Configuration for manual approval of this build. + readOnly: true + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1ApprovalConfig' + result: + description: Output only. Result of manual approval for this Build. + readOnly: true + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1ApprovalResult' + GoogleDevtoolsCloudbuildV1ApprovalConfig: + id: GoogleDevtoolsCloudbuildV1ApprovalConfig + description: ApprovalConfig describes configuration for manual approval of a build. + type: object + properties: + approvalRequired: + description: >- + Whether or not approval is needed. If this is set on a build, it + will become pending when created, and will need to be explicitly + approved to start. + type: boolean + GoogleDevtoolsCloudbuildV1ApprovalResult: + id: GoogleDevtoolsCloudbuildV1ApprovalResult + description: >- + ApprovalResult describes the decision and associated metadata of a + manual approval of a build. + type: object + properties: + approverAccount: + description: >- + Output only. Email of the user that called the ApproveBuild API to + approve or reject a build at the time that the API was called. + readOnly: true + type: string + approvalTime: + description: Output only. The time when the approval decision was made. + readOnly: true + type: string + format: google-datetime + decision: + description: Required. The decision of this manual approval. + type: string + enumDescriptions: + - Default enum type. This should not be used. + - Build is approved. + - Build is rejected. + enum: + - DECISION_UNSPECIFIED + - APPROVED + - REJECTED + comment: + description: Optional. An optional comment for this manual approval result. + type: string + url: + description: >- + Optional. An optional URL tied to this manual approval result. This + field is essentially the same as comment, except that it will be + rendered by the UI differently. An example use case is a link to an + external job that approved this Build. + type: string + GoogleDevtoolsCloudbuildV1Secrets: + id: GoogleDevtoolsCloudbuildV1Secrets + description: Secrets and secret environment variables. + type: object + properties: + secretManager: + description: >- + Secrets in Secret Manager and associated secret environment + variable. + type: array + items: + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1SecretManagerSecret' + inline: + description: >- + Secrets encrypted with KMS key and the associated secret environment + variable. + type: array + items: + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1InlineSecret' + GoogleDevtoolsCloudbuildV1SecretManagerSecret: + id: GoogleDevtoolsCloudbuildV1SecretManagerSecret + description: >- + Pairs a secret environment variable with a SecretVersion in Secret + Manager. + type: object + properties: + versionName: + description: >- + Resource name of the SecretVersion. In format: + projects/*/secrets/*/versions/* + type: string + env: + description: >- + Environment variable name to associate with the secret. Secret + environment variables must be unique across all of a build's + secrets, and must be used by at least one build step. + type: string + GoogleDevtoolsCloudbuildV1InlineSecret: + id: GoogleDevtoolsCloudbuildV1InlineSecret + description: >- + Pairs a set of secret environment variables mapped to encrypted values + with the Cloud KMS key to use to decrypt the value. + type: object + properties: + kmsKeyName: + description: >- + Resource name of Cloud KMS crypto key to decrypt the encrypted + value. In format: projects/*/locations/*/keyRings/*/cryptoKeys/* + type: string + envMap: + description: >- + Map of environment variable name to its encrypted value. Secret + environment variables must be unique across all of a build's + secrets, and must be used by at least one build step. Values can be + at most 64 KB in size. There can be at most 100 secret values across + all of a build's secrets. + type: object + additionalProperties: + type: string + format: byte + GoogleDevtoolsCloudbuildV1Warning: + id: GoogleDevtoolsCloudbuildV1Warning + description: A non-fatal problem encountered during the execution of the build. + type: object + properties: + text: + description: Explanation of the warning generated. + type: string + priority: + description: The priority for this warning. + type: string + enumDescriptions: + - Should not be used. + - e.g. deprecation warnings and alternative feature highlights. + - e.g. automated detection of possible issues with the build. + - e.g. alerts that a feature used in the build is pending removal + enum: + - PRIORITY_UNSPECIFIED + - INFO + - WARNING + - ALERT + GoogleDevtoolsCloudbuildV1GitConfig: + id: GoogleDevtoolsCloudbuildV1GitConfig + description: GitConfig is a configuration for git operations. + type: object + properties: + http: + description: Configuration for HTTP related git operations. + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1HttpConfig' + GoogleDevtoolsCloudbuildV1HttpConfig: + id: GoogleDevtoolsCloudbuildV1HttpConfig + description: HttpConfig is a configuration for HTTP related git operations. + type: object + properties: + proxySecretVersionName: + description: >- + SecretVersion resource of the HTTP proxy URL. The Service Account + used in the build (either the default Service Account or + user-specified Service Account) should have + `secretmanager.versions.access` permissions on this secret. The + proxy URL should be in format `protocol://@]proxyhost[:port]`. + type: string + GoogleDevtoolsCloudbuildV1FailureInfo: + id: GoogleDevtoolsCloudbuildV1FailureInfo + description: A fatal problem encountered during the execution of the build. + type: object + properties: + type: + description: The name of the failure. + type: string + enumDescriptions: + - Type unspecified + - Unable to push the image to the repository. + - Final image not found. + - Unauthorized push of the final image. + - Backend logging failures. Should retry. + - A build step has failed. + - The source fetching has failed. + enum: + - FAILURE_TYPE_UNSPECIFIED + - PUSH_FAILED + - PUSH_IMAGE_NOT_FOUND + - PUSH_NOT_AUTHORIZED + - LOGGING_FAILURE + - USER_BUILD_STEP + - FETCH_SOURCE_FAILED + detail: + description: Explains the failure issue in more detail using hard-coded text. + type: string + GoogleDevtoolsCloudbuildV1Dependency: + id: GoogleDevtoolsCloudbuildV1Dependency + description: >- + A dependency that the Cloud Build worker will fetch before executing + user steps. + type: object + properties: + empty: + description: >- + If set to true disable all dependency fetching (ignoring the default + source as well). + type: boolean + gitSource: + description: Represents a git repository as a build dependency. + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1GitSourceDependency' + GoogleDevtoolsCloudbuildV1GitSourceDependency: + id: GoogleDevtoolsCloudbuildV1GitSourceDependency + description: Represents a git repository as a build dependency. + type: object + properties: + repository: + description: Required. The kind of repo (url or dev connect). + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1GitSourceRepository' + revision: + description: Required. The revision that we will fetch the repo at. + type: string + recurseSubmodules: + description: Optional. True if submodules should be fetched too (default false). + type: boolean + depth: + description: >- + Optional. How much history should be fetched for the build (default + 1, -1 for all history). + type: string + format: int64 + destPath: + description: Required. Where should the files be placed on the worker. + type: string + GoogleDevtoolsCloudbuildV1GitSourceRepository: + id: GoogleDevtoolsCloudbuildV1GitSourceRepository + description: A repository for a git source. + type: object + properties: + url: + description: Location of the Git repository. + type: string + developerConnect: + description: >- + The Developer Connect Git repository link formatted as + `projects/*/locations/*/connections/*/gitRepositoryLink/*` + type: string + parameters: + 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: + type: string + enum: + - json + - media + - proto + 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 + upload_protocol: description: Upload protocol for media (e.g. "raw", "multipart"). in: query name: upload_protocol @@ -5247,21 +6126,21 @@ components: get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1services~1{servicesId}~1revisions~1{revisionsId}/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1workerPools~1{workerPoolsId}~1revisions~1{revisionsId}/get response: mediaType: application/json openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1services~1{servicesId}~1revisions~1{revisionsId}/delete + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1workerPools~1{workerPoolsId}~1revisions~1{revisionsId}/delete response: mediaType: application/json openAPIDocKey: '200' list: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1services~1{servicesId}~1revisions/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1workerPools~1{workerPoolsId}~1revisions/get response: mediaType: application/json openAPIDocKey: '200' @@ -5275,6 +6154,95 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/revisions/methods/delete' + worker_pools: + id: google.run.worker_pools + name: worker_pools + title: Worker_pools + methods: + create: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1workerPools/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1workerPools/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.workerPools + get: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1workerPools~1{workerPoolsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1workerPools~1{workerPoolsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1workerPools~1{workerPoolsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/worker_pools/methods/get' + - $ref: '#/components/x-stackQL-resources/worker_pools/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/worker_pools/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/worker_pools/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/worker_pools/methods/delete' + worker_pools_iam_policies: + id: google.run.worker_pools_iam_policies + name: worker_pools_iam_policies + title: Worker_pools_iam_policies + methods: + get_iam_policy: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1workerPools~1{workerPoolsId}:getIamPolicy/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.bindings + set_iam_policy: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1workerPools~1{workerPoolsId}:setIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + test_iam_permissions: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1workerPools~1{workerPoolsId}:testIamPermissions/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/worker_pools_iam_policies/methods/get_iam_policy + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/worker_pools_iam_policies/methods/set_iam_policy + delete: [] paths: /v2/projects/{projectsId}/locations/{locationsId}:exportProjectMetadata: parameters: &ref_1 @@ -5290,8 +6258,339 @@ paths: - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/_.xgafv' get: - description: Export generated customer metadata for a given project. - operationId: run.projects.locations.exportProjectMetadata + description: Export generated customer metadata for a given project. + operationId: run.projects.locations.exportProjectMetadata + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudRunV2Metadata' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/{locationsId1}:exportMetadata: + parameters: *ref_1 + get: + description: Export generated customer metadata for a given resource. + operationId: run.projects.locations.exportMetadata + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudRunV2Metadata' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: locationsId1 + required: true + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/{locationsId1}:exportImageMetadata: + parameters: *ref_1 + get: + description: Export image metadata for a given resource. + operationId: run.projects.locations.exportImageMetadata + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudRunV2Metadata' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: locationsId1 + required: true + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/{locationsId1}:exportImage: + parameters: *ref_1 + post: + description: Export image for a given resource. + operationId: run.projects.locations.exportImage + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudRunV2ExportImageRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudRunV2ExportImageResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: locationsId1 + required: true + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: run.projects.locations.operations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: run.projects.locations.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + delete: + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: run.projects.locations.operations.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:wait: + parameters: *ref_1 + post: + description: >- + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It may return the latest state before the specified + timeout (including immediately), meaning even an immediate response is + no guarantee that the operation is done. + operationId: run.projects.locations.operations.wait + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningWaitOperationRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/builds:submit: + parameters: *ref_1 + post: + description: Submits a build in a given project. + operationId: run.projects.locations.builds.submit + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudRunV2SubmitBuildRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudRunV2SubmitBuildResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/jobs: + parameters: *ref_1 + post: + description: Creates a Job. + operationId: run.projects.locations.jobs.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudRunV2Job' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5303,7 +6602,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRunV2Metadata' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -5315,11 +6614,17 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/{locationsId1}:exportMetadata: - parameters: *ref_1 + - in: query + name: jobId + schema: + type: string + - in: query + name: validateOnly + schema: + type: boolean get: - description: Export generated customer metadata for a given resource. - operationId: run.projects.locations.exportMetadata + description: Lists Jobs. Results are sorted by creation time, descending. + operationId: run.projects.locations.jobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5331,7 +6636,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRunV2Metadata' + $ref: '#/components/schemas/GoogleCloudRunV2ListJobsResponse' parameters: - in: path name: projectsId @@ -5343,16 +6648,24 @@ paths: required: true schema: type: string - - in: path - name: locationsId1 - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/{locationsId1}:exportImageMetadata: + - in: query + name: showDeleted + schema: + type: boolean + /v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}: parameters: *ref_1 get: - description: Export image metadata for a given resource. - operationId: run.projects.locations.exportImageMetadata + description: Gets information about a Job. + operationId: run.projects.locations.jobs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5364,7 +6677,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRunV2Metadata' + $ref: '#/components/schemas/GoogleCloudRunV2Job' parameters: - in: path name: projectsId @@ -5377,20 +6690,18 @@ paths: schema: type: string - in: path - name: locationsId1 + name: jobsId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/{locationsId1}:exportImage: - parameters: *ref_1 - post: - description: Export image for a given resource. - operationId: run.projects.locations.exportImage + patch: + description: Updates a Job. + operationId: run.projects.locations.jobs.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRunV2ExportImageRequest' + $ref: '#/components/schemas/GoogleCloudRunV2Job' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5402,7 +6713,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRunV2ExportImageResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -5415,17 +6726,21 @@ paths: schema: type: string - in: path - name: locationsId1 + name: jobsId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_1 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: run.projects.locations.operations.list + - in: query + name: validateOnly + schema: + type: boolean + - in: query + name: allowMissing + schema: + type: boolean + delete: + description: Deletes a Job. + operationId: run.projects.locations.jobs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5437,7 +6752,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -5449,27 +6764,29 @@ paths: required: true schema: type: string - - in: query - name: filter + - in: path + name: jobsId + required: true schema: type: string - in: query - name: pageSize + name: validateOnly schema: - type: integer - format: int32 + type: boolean - in: query - name: pageToken + name: etag schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: + /v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}:run: parameters: *ref_1 - get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: run.projects.locations.operations.get + post: + description: Triggers creation of a new Execution of this Job. + operationId: run.projects.locations.jobs.run + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudRunV2RunJobRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5494,17 +6811,17 @@ paths: schema: type: string - in: path - name: operationsId + name: jobsId required: true schema: type: string - delete: + /v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}:getIamPolicy: + parameters: *ref_1 + get: description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: run.projects.locations.operations.delete + Gets the IAM Access Control policy currently in effect for the given + Job. This result does not include any inherited policies. + operationId: run.projects.locations.jobs.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5516,7 +6833,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -5529,29 +6846,27 @@ paths: schema: type: string - in: path - name: operationsId + name: jobsId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:wait: + - in: query + name: options.requestedPolicyVersion + schema: + type: integer + format: int32 + /v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}:setIamPolicy: parameters: *ref_1 post: description: >- - Waits until the specified long-running operation is done or reaches at - most a specified timeout, returning the latest state. If the operation - is already done, the latest state is immediately returned. If the - timeout specified is greater than the default HTTP/RPC timeout, the - HTTP/RPC timeout is used. If the server does not support this method, it - returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a - best-effort basis. It may return the latest state before the specified - timeout (including immediately), meaning even an immediate response is - no guarantee that the operation is done. - operationId: run.projects.locations.operations.wait + Sets the IAM Access control policy for the specified Job. Overwrites any + existing policy. + operationId: run.projects.locations.jobs.setIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningWaitOperationRequest' + $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5563,7 +6878,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -5576,20 +6891,98 @@ paths: schema: type: string - in: path - name: operationsId + name: jobsId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/builds:submit: + /v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}:testIamPermissions: parameters: *ref_1 post: - description: Submits a build in a given project. - operationId: run.projects.locations.builds.submit + description: >- + Returns permissions that a caller has on the specified Project. There + are no permissions required for making this API call. + operationId: run.projects.locations.jobs.testIamPermissions requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRunV2SubmitBuildRequest' + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: jobsId + required: true + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}/executions/{executionsId}/{executionsId1}:exportStatus: + parameters: *ref_1 + get: + description: Read the status of an image export operation. + operationId: run.projects.locations.jobs.executions.exportStatus + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudRunV2ExportStatusResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: jobsId + required: true + schema: + type: string + - in: path + name: executionsId + required: true + schema: + type: string + - in: path + name: executionsId1 + required: true + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}/executions/{executionsId}: + parameters: *ref_1 + get: + description: Gets information about an Execution. + operationId: run.projects.locations.jobs.executions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5601,7 +6994,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRunV2SubmitBuildResponse' + $ref: '#/components/schemas/GoogleCloudRunV2Execution' parameters: - in: path name: projectsId @@ -5613,16 +7006,19 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/jobs: - parameters: *ref_1 - post: - description: Creates a Job. - operationId: run.projects.locations.jobs.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudRunV2Job' + - in: path + name: jobsId + required: true + schema: + type: string + - in: path + name: executionsId + required: true + schema: + type: string + delete: + description: Deletes an Execution. + operationId: run.projects.locations.jobs.executions.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5646,17 +7042,31 @@ paths: required: true schema: type: string - - in: query - name: jobId + - in: path + name: jobsId + required: true + schema: + type: string + - in: path + name: executionsId + required: true schema: type: string - in: query name: validateOnly schema: type: boolean + - in: query + name: etag + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}/executions: + parameters: *ref_1 get: - description: Lists Jobs. Results are sorted by creation time, descending. - operationId: run.projects.locations.jobs.list + description: >- + Lists Executions from a Job. Results are sorted by creation time, + descending. + operationId: run.projects.locations.jobs.executions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5668,7 +7078,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRunV2ListJobsResponse' + $ref: '#/components/schemas/GoogleCloudRunV2ListExecutionsResponse' parameters: - in: path name: projectsId @@ -5680,6 +7090,11 @@ paths: required: true schema: type: string + - in: path + name: jobsId + required: true + schema: + type: string - in: query name: pageSize schema: @@ -5693,11 +7108,16 @@ paths: name: showDeleted schema: type: boolean - /v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}: + /v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}/executions/{executionsId}:cancel: parameters: *ref_1 - get: - description: Gets information about a Job. - operationId: run.projects.locations.jobs.get + post: + description: Cancels an Execution. + operationId: run.projects.locations.jobs.executions.cancel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudRunV2CancelExecutionRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5709,7 +7129,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRunV2Job' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -5726,14 +7146,16 @@ paths: required: true schema: type: string - patch: - description: Updates a Job. - operationId: run.projects.locations.jobs.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudRunV2Job' + - in: path + name: executionsId + required: true + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}/executions/{executionsId}/tasks/{tasksId}: + parameters: *ref_1 + get: + description: Gets information about a Task. + operationId: run.projects.locations.jobs.executions.tasks.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5745,7 +7167,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudRunV2Task' parameters: - in: path name: projectsId @@ -5762,17 +7184,21 @@ paths: required: true schema: type: string - - in: query - name: validateOnly + - in: path + name: executionsId + required: true schema: - type: boolean - - in: query - name: allowMissing + type: string + - in: path + name: tasksId + required: true schema: - type: boolean - delete: - description: Deletes a Job. - operationId: run.projects.locations.jobs.delete + type: string + /v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}/executions/{executionsId}/tasks: + parameters: *ref_1 + get: + description: Lists Tasks from an Execution of a Job. + operationId: run.projects.locations.jobs.executions.tasks.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5784,7 +7210,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudRunV2ListTasksResponse' parameters: - in: path name: projectsId @@ -5801,24 +7227,34 @@ paths: required: true schema: type: string + - in: path + name: executionsId + required: true + schema: + type: string - in: query - name: validateOnly + name: pageSize schema: - type: boolean + type: integer + format: int32 - in: query - name: etag + name: pageToken schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}:run: + - in: query + name: showDeleted + schema: + type: boolean + /v2/projects/{projectsId}/locations/{locationsId}/services: parameters: *ref_1 post: - description: Triggers creation of a new Execution of this Job. - operationId: run.projects.locations.jobs.run + description: Creates a new Service in a given project and location. + operationId: run.projects.locations.services.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRunV2RunJobRequest' + $ref: '#/components/schemas/GoogleCloudRunV2Service' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5842,18 +7278,58 @@ paths: required: true schema: type: string + - in: query + name: serviceId + schema: + type: string + - in: query + name: validateOnly + schema: + type: boolean + get: + description: Lists Services. Results are sorted by creation time, descending. + operationId: run.projects.locations.services.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudRunV2ListServicesResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string - in: path - name: jobsId + name: locationsId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}:getIamPolicy: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: showDeleted + schema: + type: boolean + /v2/projects/{projectsId}/locations/{locationsId}/services/{servicesId}: parameters: *ref_1 get: - description: >- - Gets the IAM Access Control policy currently in effect for the given - Job. This result does not include any inherited policies. - operationId: run.projects.locations.jobs.getIamPolicy + description: Gets information about a Service. + operationId: run.projects.locations.services.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5865,7 +7341,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleCloudRunV2Service' parameters: - in: path name: projectsId @@ -5878,27 +7354,18 @@ paths: schema: type: string - in: path - name: jobsId + name: servicesId required: true schema: type: string - - in: query - name: options.requestedPolicyVersion - schema: - type: integer - format: int32 - /v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}:setIamPolicy: - parameters: *ref_1 - post: - description: >- - Sets the IAM Access control policy for the specified Job. Overwrites any - existing policy. - operationId: run.projects.locations.jobs.setIamPolicy + patch: + description: Updates a Service. + operationId: run.projects.locations.services.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' + $ref: '#/components/schemas/GoogleCloudRunV2Service' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5910,7 +7377,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -5923,22 +7390,28 @@ paths: schema: type: string - in: path - name: jobsId + name: servicesId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}:testIamPermissions: - parameters: *ref_1 - post: + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: validateOnly + schema: + type: boolean + - in: query + name: allowMissing + schema: + type: boolean + delete: description: >- - Returns permissions that a caller has on the specified Project. There - are no permissions required for making this API call. - operationId: run.projects.locations.jobs.testIamPermissions - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsRequest' + Deletes a Service. This will cause the Service to stop serving traffic + and will delete all revisions. + operationId: run.projects.locations.services.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5950,7 +7423,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -5963,15 +7436,25 @@ paths: schema: type: string - in: path - name: jobsId + name: servicesId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}/executions/{executionsId}/{executionsId1}:exportStatus: + - in: query + name: validateOnly + schema: + type: boolean + - in: query + name: etag + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:getIamPolicy: parameters: *ref_1 get: - description: Read the status of an image export operation. - operationId: run.projects.locations.jobs.executions.exportStatus + description: >- + Gets the IAM Access Control policy currently in effect for the given + Cloud Run Service. This result does not include any inherited policies. + operationId: run.projects.locations.services.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5983,7 +7466,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRunV2ExportStatusResponse' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -5996,25 +7479,27 @@ paths: schema: type: string - in: path - name: jobsId - required: true - schema: - type: string - - in: path - name: executionsId + name: servicesId required: true schema: type: string - - in: path - name: executionsId1 - required: true + - in: query + name: options.requestedPolicyVersion schema: - type: string - /v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}/executions/{executionsId}: + type: integer + format: int32 + /v2/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:setIamPolicy: parameters: *ref_1 - get: - description: Gets information about an Execution. - operationId: run.projects.locations.jobs.executions.get + post: + description: >- + Sets the IAM Access control policy for the specified Service. Overwrites + any existing policy. + operationId: run.projects.locations.services.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6026,7 +7511,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRunV2Execution' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -6039,18 +7524,22 @@ paths: schema: type: string - in: path - name: jobsId - required: true - schema: - type: string - - in: path - name: executionsId + name: servicesId required: true schema: type: string - delete: - description: Deletes an Execution. - operationId: run.projects.locations.jobs.executions.delete + /v2/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:testIamPermissions: + parameters: *ref_1 + post: + description: >- + Returns permissions that a caller has on the specified Project. There + are no permissions required for making this API call. + operationId: run.projects.locations.services.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6062,7 +7551,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' parameters: - in: path name: projectsId @@ -6075,30 +7564,15 @@ paths: schema: type: string - in: path - name: jobsId - required: true - schema: - type: string - - in: path - name: executionsId + name: servicesId required: true schema: type: string - - in: query - name: validateOnly - schema: - type: boolean - - in: query - name: etag - schema: - type: string - /v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}/executions: + /v2/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/revisions/{revisionsId}/{revisionsId1}:exportStatus: parameters: *ref_1 get: - description: >- - Lists Executions from a Job. Results are sorted by creation time, - descending. - operationId: run.projects.locations.jobs.executions.list + description: Read the status of an image export operation. + operationId: run.projects.locations.services.revisions.exportStatus security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6110,7 +7584,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRunV2ListExecutionsResponse' + $ref: '#/components/schemas/GoogleCloudRunV2ExportStatusResponse' parameters: - in: path name: projectsId @@ -6123,33 +7597,25 @@ paths: schema: type: string - in: path - name: jobsId + name: servicesId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: revisionsId + required: true schema: type: string - - in: query - name: showDeleted + - in: path + name: revisionsId1 + required: true schema: - type: boolean - /v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}/executions/{executionsId}:cancel: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/revisions/{revisionsId}: parameters: *ref_1 - post: - description: Cancels an Execution. - operationId: run.projects.locations.jobs.executions.cancel - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudRunV2CancelExecutionRequest' + get: + description: Gets information about a Revision. + operationId: run.projects.locations.services.revisions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6161,7 +7627,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudRunV2Revision' parameters: - in: path name: projectsId @@ -6174,20 +7640,18 @@ paths: schema: type: string - in: path - name: jobsId + name: servicesId required: true schema: type: string - in: path - name: executionsId + name: revisionsId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}/executions/{executionsId}/tasks/{tasksId}: - parameters: *ref_1 - get: - description: Gets information about a Task. - operationId: run.projects.locations.jobs.executions.tasks.get + delete: + description: Deletes a Revision. + operationId: run.projects.locations.services.revisions.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6199,7 +7663,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRunV2Task' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -6212,25 +7676,30 @@ paths: schema: type: string - in: path - name: jobsId + name: servicesId required: true schema: type: string - in: path - name: executionsId + name: revisionsId required: true schema: type: string - - in: path - name: tasksId - required: true + - in: query + name: validateOnly + schema: + type: boolean + - in: query + name: etag schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}/executions/{executionsId}/tasks: + /v2/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/revisions: parameters: *ref_1 get: - description: Lists Tasks from an Execution of a Job. - operationId: run.projects.locations.jobs.executions.tasks.list + description: >- + Lists Revisions from a given Service, or from a given location. Results + are sorted by creation time, descending. + operationId: run.projects.locations.services.revisions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6242,7 +7711,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRunV2ListTasksResponse' + $ref: '#/components/schemas/GoogleCloudRunV2ListRevisionsResponse' parameters: - in: path name: projectsId @@ -6255,12 +7724,7 @@ paths: schema: type: string - in: path - name: jobsId - required: true - schema: - type: string - - in: path - name: executionsId + name: servicesId required: true schema: type: string @@ -6277,16 +7741,16 @@ paths: name: showDeleted schema: type: boolean - /v2/projects/{projectsId}/locations/{locationsId}/services: + /v2/projects/{projectsId}/locations/{locationsId}/workerPools: parameters: *ref_1 post: - description: Creates a new Service in a given project and location. - operationId: run.projects.locations.services.create + description: Creates a new WorkerPool in a given project and location. + operationId: run.projects.locations.workerPools.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRunV2Service' + $ref: '#/components/schemas/GoogleCloudRunV2WorkerPool' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6311,7 +7775,7 @@ paths: schema: type: string - in: query - name: serviceId + name: workerPoolId schema: type: string - in: query @@ -6319,8 +7783,8 @@ paths: schema: type: boolean get: - description: Lists Services. Results are sorted by creation time, descending. - operationId: run.projects.locations.services.list + description: Lists WorkerPools. Results are sorted by creation time, descending. + operationId: run.projects.locations.workerPools.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6332,7 +7796,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRunV2ListServicesResponse' + $ref: '#/components/schemas/GoogleCloudRunV2ListWorkerPoolsResponse' parameters: - in: path name: projectsId @@ -6357,11 +7821,11 @@ paths: name: showDeleted schema: type: boolean - /v2/projects/{projectsId}/locations/{locationsId}/services/{servicesId}: + /v2/projects/{projectsId}/locations/{locationsId}/workerPools/{workerPoolsId}: parameters: *ref_1 get: - description: Gets information about a Service. - operationId: run.projects.locations.services.get + description: Gets information about a WorkerPool. + operationId: run.projects.locations.workerPools.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6373,7 +7837,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRunV2Service' + $ref: '#/components/schemas/GoogleCloudRunV2WorkerPool' parameters: - in: path name: projectsId @@ -6386,18 +7850,18 @@ paths: schema: type: string - in: path - name: servicesId + name: workerPoolsId required: true schema: type: string patch: - description: Updates a Service. - operationId: run.projects.locations.services.patch + description: Updates a WorkerPool. + operationId: run.projects.locations.workerPools.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRunV2Service' + $ref: '#/components/schemas/GoogleCloudRunV2WorkerPool' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6422,7 +7886,7 @@ paths: schema: type: string - in: path - name: servicesId + name: workerPoolsId required: true schema: type: string @@ -6439,11 +7903,13 @@ paths: name: allowMissing schema: type: boolean + - in: query + name: forceNewRevision + schema: + type: boolean delete: - description: >- - Deletes a Service. This will cause the Service to stop serving traffic - and will delete all revisions. - operationId: run.projects.locations.services.delete + description: Deletes a WorkerPool. + operationId: run.projects.locations.workerPools.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6468,7 +7934,7 @@ paths: schema: type: string - in: path - name: servicesId + name: workerPoolsId required: true schema: type: string @@ -6480,13 +7946,14 @@ paths: name: etag schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:getIamPolicy: + /v2/projects/{projectsId}/locations/{locationsId}/workerPools/{workerPoolsId}:getIamPolicy: parameters: *ref_1 get: description: >- Gets the IAM Access Control policy currently in effect for the given - Cloud Run Service. This result does not include any inherited policies. - operationId: run.projects.locations.services.getIamPolicy + Cloud Run WorkerPool. This result does not include any inherited + policies. + operationId: run.projects.locations.workerPools.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6511,7 +7978,7 @@ paths: schema: type: string - in: path - name: servicesId + name: workerPoolsId required: true schema: type: string @@ -6520,13 +7987,13 @@ paths: schema: type: integer format: int32 - /v2/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:setIamPolicy: + /v2/projects/{projectsId}/locations/{locationsId}/workerPools/{workerPoolsId}:setIamPolicy: parameters: *ref_1 post: description: >- - Sets the IAM Access control policy for the specified Service. Overwrites - any existing policy. - operationId: run.projects.locations.services.setIamPolicy + Sets the IAM Access control policy for the specified WorkerPool. + Overwrites any existing policy. + operationId: run.projects.locations.workerPools.setIamPolicy requestBody: content: application/json: @@ -6556,17 +8023,17 @@ paths: schema: type: string - in: path - name: servicesId + name: workerPoolsId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:testIamPermissions: + /v2/projects/{projectsId}/locations/{locationsId}/workerPools/{workerPoolsId}:testIamPermissions: parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified Project. There are no permissions required for making this API call. - operationId: run.projects.locations.services.testIamPermissions + operationId: run.projects.locations.workerPools.testIamPermissions requestBody: content: application/json: @@ -6596,58 +8063,15 @@ paths: schema: type: string - in: path - name: servicesId - required: true - schema: - type: string - /v2/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/revisions/{revisionsId}/{revisionsId1}:exportStatus: - parameters: *ref_1 - get: - description: Read the status of an image export operation. - operationId: run.projects.locations.services.revisions.exportStatus - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudRunV2ExportStatusResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: servicesId - required: true - schema: - type: string - - in: path - name: revisionsId - required: true - schema: - type: string - - in: path - name: revisionsId1 + name: workerPoolsId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/revisions/{revisionsId}: + /v2/projects/{projectsId}/locations/{locationsId}/workerPools/{workerPoolsId}/revisions/{revisionsId}: parameters: *ref_1 get: description: Gets information about a Revision. - operationId: run.projects.locations.services.revisions.get + operationId: run.projects.locations.workerPools.revisions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6672,7 +8096,7 @@ paths: schema: type: string - in: path - name: servicesId + name: workerPoolsId required: true schema: type: string @@ -6683,7 +8107,7 @@ paths: type: string delete: description: Deletes a Revision. - operationId: run.projects.locations.services.revisions.delete + operationId: run.projects.locations.workerPools.revisions.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6708,7 +8132,7 @@ paths: schema: type: string - in: path - name: servicesId + name: workerPoolsId required: true schema: type: string @@ -6725,13 +8149,13 @@ paths: name: etag schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/revisions: + /v2/projects/{projectsId}/locations/{locationsId}/workerPools/{workerPoolsId}/revisions: parameters: *ref_1 get: description: >- Lists Revisions from a given Service, or from a given location. Results are sorted by creation time, descending. - operationId: run.projects.locations.services.revisions.list + operationId: run.projects.locations.workerPools.revisions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6756,7 +8180,7 @@ paths: schema: type: string - in: path - name: servicesId + name: workerPoolsId required: true schema: type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/runtimeconfig.yaml b/providers/src/googleapis.com/v00.00.00000/services/runtimeconfig.yaml index ce495fb2..4b49ccfd 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/runtimeconfig.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/runtimeconfig.yaml @@ -11,8 +11,8 @@ info: Watchers and Waiters that will watch for changes to your data and return based on certain conditions. version: v1 - x-discovery-doc-revision: '20240923' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250805' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/deployment-manager/runtime-configurator/ servers: @@ -355,7 +355,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: runtimeconfig.operations.cancel requestBody: content: diff --git a/providers/src/googleapis.com/v00.00.00000/services/saasservicemgmt.yaml b/providers/src/googleapis.com/v00.00.00000/services/saasservicemgmt.yaml new file mode 100644 index 00000000..97033a02 --- /dev/null +++ b/providers/src/googleapis.com/v00.00.00000/services/saasservicemgmt.yaml @@ -0,0 +1,3982 @@ +openapi: 3.1.0 +info: + contact: + name: StackQL Studios + url: https://github.com/stackql/google-discovery-to-openapi + email: info@stackql.io + title: SaaS Runtime API + description: 'Model, deploy, and operate your SaaS at scale. ' + version: v1beta1 + x-discovery-doc-revision: '20250806' + x-generated-date: '2025-08-28' +externalDocs: + url: https://cloud.google.com/saas-runtime/docs +servers: + - url: https://saasservicemgmt.googleapis.com +components: + securitySchemes: + Oauth2: + type: oauth2 + description: Oauth 2.0 implicit authentication + flows: + implicit: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + scopes: &ref_0 + 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. + Oauth2c: + type: oauth2 + description: Oauth 2.0 authorization code authentication + flows: + authorizationCode: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + tokenUrl: https://accounts.google.com/o/oauth2/token + scopes: *ref_0 + schemas: + ListSaasResponse: + id: ListSaasResponse + description: The response structure for the ListSaas method. + type: object + properties: + saas: + description: The resulting saas. + type: array + items: + $ref: '#/components/schemas/Saas' + nextPageToken: + description: >- + If present, the next page token can be provided to a subsequent + ListSaas call to list the next page. If empty, there are no more + pages. + type: string + unreachable: + description: Locations that could not be reached. + type: array + items: + type: string + Saas: + id: Saas + description: Saas is a representation of a SaaS service managed by the Producer. + type: object + properties: + name: + description: >- + Identifier. The resource name (full URI of the resource) following + the standard naming scheme: + "projects/{project}/locations/{location}/saas/{saas}" + type: string + locations: + description: >- + Optional. List of locations that the service is available in. + Rollout refers to the list to generate a rollout plan. + type: array + items: + $ref: '#/components/schemas/Location' + labels: + description: >- + Optional. The labels on the resource, which can be used for + categorization. similar to Kubernetes resource labels. + type: object + additionalProperties: + type: string + annotations: + description: >- + Optional. Annotations is an unstructured key-value map stored with a + resource that may be set by external tools to store and retrieve + arbitrary metadata. They are not queryable and should be preserved + when modifying objects. More info: + https://kubernetes.io/docs/user-guide/annotations + type: object + additionalProperties: + type: string + uid: + description: >- + Output only. The unique identifier of the resource. UID is unique in + the time and space for this resource within the scope of the + service. It is typically generated by the server on successful + creation of a resource and must not be changed. UID is used to + uniquely identify resources with resource name reuses. This should + be a UUID4. + readOnly: true + type: string + etag: + description: >- + Output only. An opaque value that uniquely identifies a version or + generation of a resource. It can be used to confirm that the client + and server agree on the ordering of a resource being written. + readOnly: true + type: string + createTime: + description: Output only. The timestamp when the resource was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: >- + Output only. The timestamp when the resource was last updated. Any + change to the resource made by users must refresh this value. + Changes to a resource made by the service should refresh this value. + readOnly: true + type: string + format: google-datetime + Location: + id: Location + description: Location information that the service is available in. + type: object + properties: + name: + description: Optional. Name of location. + type: string + Empty: + id: Empty + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + type: object + properties: {} + ListTenantsResponse: + id: ListTenantsResponse + description: The response structure for the ListTenants method. + type: object + properties: + tenants: + description: The resulting tenants. + type: array + items: + $ref: '#/components/schemas/Tenant' + nextPageToken: + description: >- + If present, the next page token can be provided to a subsequent + ListTenants call to list the next page. If empty, there are no more + pages. + type: string + unreachable: + description: Locations that could not be reached. + type: array + items: + type: string + Tenant: + id: Tenant + description: >- + Tenant represents the service producer side of an instance of the + service created based on a request from a consumer. In a typical + scenario a Tenant has a one-to-one mapping with a resource given out to + a service consumer. Example: tenant: name: + "projects/svc1/locations/loc/tenants/inst-068afff8" consumer_resource: + "projects/gshoe/locations/loc/shoes/black-shoe" + type: object + properties: + name: + description: >- + Identifier. The resource name (full URI of the resource) following + the standard naming scheme: + "projects/{project}/locations/{location}/tenants/{tenant}" + type: string + consumerResource: + description: >- + Optional. Immutable. A reference to the consumer resource this SaaS + Tenant is representing. The relationship with a consumer resource + can be used by SaaS Runtime for retrieving consumer-defined settings + and policies such as maintenance policies (using Unified Maintenance + Policy API). + type: string + saas: + description: >- + Required. Immutable. A reference to the Saas that defines the + product (managed service) that the producer wants to manage with + SaaS Runtime. Part of the SaaS Runtime common data model. + type: string + labels: + description: >- + Optional. The labels on the resource, which can be used for + categorization. similar to Kubernetes resource labels. + type: object + additionalProperties: + type: string + annotations: + description: >- + Optional. Annotations is an unstructured key-value map stored with a + resource that may be set by external tools to store and retrieve + arbitrary metadata. They are not queryable and should be preserved + when modifying objects. More info: + https://kubernetes.io/docs/user-guide/annotations + type: object + additionalProperties: + type: string + uid: + description: >- + Output only. The unique identifier of the resource. UID is unique in + the time and space for this resource within the scope of the + service. It is typically generated by the server on successful + creation of a resource and must not be changed. UID is used to + uniquely identify resources with resource name reuses. This should + be a UUID4. + readOnly: true + type: string + etag: + description: >- + Output only. An opaque value that uniquely identifies a version or + generation of a resource. It can be used to confirm that the client + and server agree on the ordering of a resource being written. + readOnly: true + type: string + createTime: + description: Output only. The timestamp when the resource was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: >- + Output only. The timestamp when the resource was last updated. Any + change to the resource made by users must refresh this value. + Changes to a resource made by the service should refresh this value. + readOnly: true + type: string + format: google-datetime + ListUnitKindsResponse: + id: ListUnitKindsResponse + description: The response structure for the ListUnitKinds method. + type: object + properties: + unitKinds: + description: The resulting unit kinds. + type: array + items: + $ref: '#/components/schemas/UnitKind' + nextPageToken: + description: >- + If present, the next page token can be provided to a subsequent + ListUnitKinds call to list the next page. If empty, there are no + more pages. + type: string + unreachable: + description: Locations that could not be reached. + type: array + items: + type: string + UnitKind: + id: UnitKind + description: >- + Definition of a Unit. Units belonging to the same UnitKind are managed + together; for example they follow the same release model (blueprints, + versions etc.) and are typically rolled out together. + type: object + properties: + name: + description: >- + Identifier. The resource name (full URI of the resource) following + the standard naming scheme: + "projects/{project}/locations/{location}/unitKinds/{unitKind}" + type: string + defaultRelease: + description: >- + Optional. A reference to the Release object to use as default for + creating new units of this UnitKind (optional). If not specified, a + new unit must explicitly reference which release to use for its + creation. + type: string + dependencies: + description: >- + Optional. Immutable. List of other unit kinds that this release will + depend on. Dependencies will be automatically provisioned if not + found. Maximum 10. + type: array + items: + $ref: '#/components/schemas/Dependency' + inputVariableMappings: + description: >- + Optional. List of inputVariables for this release that will either + be retrieved from a dependency’s outputVariables, or will be passed + on to a dependency’s inputVariables. Maximum 100. + type: array + items: + $ref: '#/components/schemas/VariableMapping' + outputVariableMappings: + description: >- + Optional. List of outputVariables for this unit kind will be passed + to this unit's outputVariables. Maximum 100. + type: array + items: + $ref: '#/components/schemas/VariableMapping' + saas: + description: >- + Required. Immutable. A reference to the Saas that defines the + product (managed service) that the producer wants to manage with + SaaS Runtime. Part of the SaaS Runtime common data model. Immutable + once set. + type: string + labels: + description: >- + Optional. The labels on the resource, which can be used for + categorization. similar to Kubernetes resource labels. + type: object + additionalProperties: + type: string + annotations: + description: >- + Optional. Annotations is an unstructured key-value map stored with a + resource that may be set by external tools to store and retrieve + arbitrary metadata. They are not queryable and should be preserved + when modifying objects. More info: + https://kubernetes.io/docs/user-guide/annotations + type: object + additionalProperties: + type: string + uid: + description: >- + Output only. The unique identifier of the resource. UID is unique in + the time and space for this resource within the scope of the + service. It is typically generated by the server on successful + creation of a resource and must not be changed. UID is used to + uniquely identify resources with resource name reuses. This should + be a UUID4. + readOnly: true + type: string + etag: + description: >- + Output only. An opaque value that uniquely identifies a version or + generation of a resource. It can be used to confirm that the client + and server agree on the ordering of a resource being written. + readOnly: true + type: string + createTime: + description: Output only. The timestamp when the resource was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: >- + Output only. The timestamp when the resource was last updated. Any + change to the resource made by users must refresh this value. + Changes to a resource made by the service should refresh this value. + readOnly: true + type: string + format: google-datetime + Dependency: + id: Dependency + description: >- + Dependency represent a single dependency with another unit kind by + alias. + type: object + properties: + unitKind: + description: Required. Immutable. The unit kind of the dependency. + type: string + alias: + description: >- + Required. An alias for the dependency. Used for input variable + mapping. + type: string + VariableMapping: + id: VariableMapping + description: >- + Mapping of input variables to their respective output variable for + depedenencies + type: object + properties: + from: + description: >- + Optional. Output variables which will get their values from + dependencies + $ref: '#/components/schemas/FromMapping' + to: + description: >- + Optional. Input variables whose values will be passed on to + dependencies. + $ref: '#/components/schemas/ToMapping' + variable: + description: Required. name of the variable + type: string + FromMapping: + id: FromMapping + description: Output variables whose values will be passed on to dependencies + type: object + properties: + dependency: + description: >- + Required. Alias of the dependency that the outputVariable will pass + its value to + type: string + outputVariable: + description: Required. Name of the outputVariable on the dependency + type: string + ToMapping: + id: ToMapping + description: Input variables whose values will be passed on to dependencies + type: object + properties: + dependency: + description: >- + Required. Alias of the dependency that the inputVariable will pass + its value to + type: string + inputVariable: + description: Required. Name of the inputVariable on the dependency + type: string + ignoreForLookup: + description: >- + Optional. Tells SaaS Runtime if this mapping should be used during + lookup or not + type: boolean + ListUnitsResponse: + id: ListUnitsResponse + description: The response structure for the ListUnits method. + type: object + properties: + units: + description: The resulting units. + type: array + items: + $ref: '#/components/schemas/Unit' + nextPageToken: + description: >- + If present, the next page token can be provided to a subsequent + ListUnits call to list the next page. If empty, there are no more + pages. + type: string + unreachable: + description: Locations that could not be reached. + type: array + items: + type: string + Unit: + id: Unit + description: >- + A unit of deployment that has its lifecycle via a CRUD API using an + actuation engine under the hood (e.g. based on Terraform, Helm or a + custom implementation provided by a service producer). A building block + of a SaaS Tenant. + type: object + properties: + name: + description: >- + Identifier. The resource name (full URI of the resource) following + the standard naming scheme: + "projects/{project}/locations/{location}/units/{unit}" + type: string + unitKind: + description: >- + Optional. Reference to the UnitKind this Unit belongs to. Immutable + once set. + type: string + release: + description: Optional. Output only. The current Release object for this Unit. + readOnly: true + type: string + tenant: + description: >- + Optional. Reference to the Saas Tenant resource this unit belongs + to. This for example informs the maintenance policies to use for + scheduling future updates on a unit. (optional and immutable once + created) + type: string + ongoingOperations: + description: >- + Optional. Output only. List of concurrent UnitOperations that are + operating on this Unit. + readOnly: true + type: array + items: + type: string + pendingOperations: + description: >- + Optional. Output only. List of pending (wait to be executed) + UnitOperations for this unit. + readOnly: true + type: array + items: + type: string + scheduledOperations: + description: >- + Optional. Output only. List of scheduled UnitOperations for this + unit. + readOnly: true + type: array + items: + type: string + dependents: + description: >- + Optional. Output only. List of Units that depend on this unit. Unit + can only be deprovisioned if this list is empty. Maximum 1000. + readOnly: true + type: array + items: + $ref: '#/components/schemas/UnitDependency' + dependencies: + description: >- + Optional. Output only. Set of dependencies for this unit. Maximum + 10. + readOnly: true + type: array + items: + $ref: '#/components/schemas/UnitDependency' + inputVariables: + description: >- + Optional. Output only. Indicates the current input variables + deployed by the unit + readOnly: true + type: array + items: + $ref: '#/components/schemas/UnitVariable' + outputVariables: + description: >- + Optional. Output only. Set of key/value pairs corresponding to + output variables from execution of actuation templates. The + variables are declared in actuation configs (e.g in helm chart or + terraform) and the values are fetched and returned by the actuation + engine upon completion of execution. + readOnly: true + type: array + items: + $ref: '#/components/schemas/UnitVariable' + maintenance: + description: >- + Optional. Captures requested directives for performing future + maintenance on the unit. This includes a request for the unit to + skip maintenance for a period of time and remain pinned to its + current release as well as controls for postponing maintenance + scheduled in future. + $ref: '#/components/schemas/MaintenanceSettings' + state: + description: >- + Optional. Output only. Current lifecycle state of the resource (e.g. + if it's being created or ready to use). + readOnly: true + type: string + enumDescriptions: + - Unspecified state. + - Unit is not provisioned. + - Unit is being provisioned. + - >- + Unit is being updated. This is typically when a unit is being + upgraded to a new release or some of the input variables on the + Unit is being changed. Certain kinds of updates may cause the Unit + to become unusable while the update is in progress. + - Unit is being deleted. + - Unit has been provisioned and is ready for use + - Unit has error, when it is not ready and some error operation + enum: + - UNIT_STATE_UNSPECIFIED + - UNIT_STATE_NOT_PROVISIONED + - UNIT_STATE_PROVISIONING + - UNIT_STATE_UPDATING + - UNIT_STATE_DEPROVISIONING + - UNIT_STATE_READY + - UNIT_STATE_ERROR + conditions: + description: >- + Optional. Output only. A set of conditions which indicate the + various conditions this resource can have. + readOnly: true + type: array + items: + $ref: '#/components/schemas/UnitCondition' + managementMode: + description: >- + Optional. Immutable. Indicates whether the Unit life cycle is + controlled by the user or by the system. Immutable once created. + type: string + enumDescriptions: + - '' + - Unit's lifecycle is managed by the user. + - >- + The system will decide when to deprovision and delete the unit. + User still can deprovision or delete the unit manually. + enum: + - MANAGEMENT_MODE_UNSPECIFIED + - MANAGEMENT_MODE_USER + - MANAGEMENT_MODE_SYSTEM + systemManagedState: + description: >- + Optional. Output only. Indicates the system managed state of the + unit. + readOnly: true + type: string + enumDescriptions: + - '' + - Unit has dependents attached. + - Unit has no dependencies attached, but attachment is allowed. + - Unit has no dependencies attached, and attachment is not allowed. + enum: + - SYSTEM_MANAGED_STATE_UNSPECIFIED + - SYSTEM_MANAGED_STATE_ACTIVE + - SYSTEM_MANAGED_STATE_INACTIVE + - SYSTEM_MANAGED_STATE_DECOMMISSIONED + systemCleanupAt: + description: >- + Optional. Output only. If set, indicates the time when the system + will start removing the unit. + readOnly: true + type: string + format: google-datetime + labels: + description: >- + Optional. The labels on the resource, which can be used for + categorization. similar to Kubernetes resource labels. + type: object + additionalProperties: + type: string + annotations: + description: >- + Optional. Annotations is an unstructured key-value map stored with a + resource that may be set by external tools to store and retrieve + arbitrary metadata. They are not queryable and should be preserved + when modifying objects. More info: + https://kubernetes.io/docs/user-guide/annotations + type: object + additionalProperties: + type: string + uid: + description: >- + Output only. The unique identifier of the resource. UID is unique in + the time and space for this resource within the scope of the + service. It is typically generated by the server on successful + creation of a resource and must not be changed. UID is used to + uniquely identify resources with resource name reuses. This should + be a UUID4. + readOnly: true + type: string + etag: + description: >- + Output only. An opaque value that uniquely identifies a version or + generation of a resource. It can be used to confirm that the client + and server agree on the ordering of a resource being written. + readOnly: true + type: string + createTime: + description: Output only. The timestamp when the resource was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: >- + Output only. The timestamp when the resource was last updated. Any + change to the resource made by users must refresh this value. + Changes to a resource made by the service should refresh this value. + readOnly: true + type: string + format: google-datetime + UnitDependency: + id: UnitDependency + description: Set of dependencies for this unit. Maximum 10. + type: object + properties: + alias: + description: Output only. Alias for the name of the dependency. + readOnly: true + type: string + unit: + description: Output only. A reference to the Unit object. + readOnly: true + type: string + UnitVariable: + id: UnitVariable + description: UnitVariable describes a parameter for a Unit. + type: object + properties: + variable: + description: Required. Immutable. Name of the variable from actuation configs. + type: string + type: + description: >- + Optional. Immutable. Name of a supported variable type. Supported + types are string, int, bool. + type: string + enumDescriptions: + - Variable type is unspecified. + - Variable type is string. + - Variable type is int. + - Variable type is bool. + enum: + - TYPE_UNSPECIFIED + - STRING + - INT + - BOOL + value: + description: Optional. String encoded value for the variable. + type: string + MaintenanceSettings: + id: MaintenanceSettings + description: >- + Captures requested directives for performing future maintenance on the + unit. This includes a request for the unit to skip maintenance for a + period of time and remain pinned to its current release as well as + controls for postponing maintenance scheduled in future. + type: object + properties: + pinnedUntilTime: + description: >- + Optional. If present, it fixes the release on the unit until the + given time; i.e. changes to the release field will be rejected. + Rollouts should and will also respect this by not requesting an + upgrade in the first place. + type: string + format: google-datetime + UnitCondition: + id: UnitCondition + description: >- + UnitCondition describes the status of an Unit. UnitCondition is + individual components that contribute to an overall state. + type: object + properties: + status: + description: Required. Status of the condition. + type: string + enumDescriptions: + - Condition status is unspecified. + - Condition is unknown. + - Condition is true. + - Condition is false. + enum: + - STATUS_UNSPECIFIED + - STATUS_UNKNOWN + - STATUS_TRUE + - STATUS_FALSE + type: + description: Required. Type of the condition. + type: string + enumDescriptions: + - Condition type is unspecified. + - Condition type is ready. + - Condition type is updating. + - Condition type is provisioned. + - >- + Condition type is operationError. True when the last unit + operation fails with a non-ignorable error. + enum: + - TYPE_UNSPECIFIED + - TYPE_READY + - TYPE_UPDATING + - TYPE_PROVISIONED + - TYPE_OPERATION_ERROR + lastTransitionTime: + description: >- + Required. Last time the condition transited from one status to + another. + type: string + format: google-datetime + message: + description: >- + Required. Human readable message indicating details about the last + transition. + type: string + reason: + description: Required. Brief reason for the condition's last transition. + type: string + ListUnitOperationsResponse: + id: ListUnitOperationsResponse + description: The response structure for the ListUnitOperations method. + type: object + properties: + unitOperations: + description: The resulting unit operations. + type: array + items: + $ref: '#/components/schemas/UnitOperation' + nextPageToken: + description: >- + If present, the next page token can be provided to a subsequent + ListUnitOperations call to list the next page. If empty, there are + no more pages. + type: string + unreachable: + description: Locations that could not be reached. + type: array + items: + type: string + UnitOperation: + id: UnitOperation + description: >- + UnitOperation encapsulates the intent of changing/interacting with the + service component represented by the specific Unit. Multiple + UnitOperations can be created (requested) and scheduled in the future, + however only one will be allowed to execute at a time (that can change + in the future for non-mutating operations). UnitOperations allow + different actors interacting with the same unit to focus only on the + change they have requested. This is a base object that contains the + common fields in all unit operations. Next: 19 + type: object + properties: + provision: + $ref: '#/components/schemas/Provision' + upgrade: + $ref: '#/components/schemas/Upgrade' + deprovision: + $ref: '#/components/schemas/Deprovision' + name: + description: >- + Identifier. The resource name (full URI of the resource) following + the standard naming scheme: + "projects/{project}/locations/{location}/unitOperations/{unitOperation}" + type: string + unit: + description: Required. Immutable. The Unit a given UnitOperation will act upon. + type: string + parentUnitOperation: + description: >- + Optional. Reference to parent resource: UnitOperation. If an + operation needs to create other operations as part of its workflow, + each of the child operations should have this field set to the + parent. This can be used for tracing. (Optional) + type: string + rollout: + description: >- + Optional. Specifies which rollout created this Unit Operation. This + cannot be modified and is used for filtering purposes only. If a + dependent unit and unit operation are created as part of another + unit operation, they will use the same rolloutId. + type: string + cancel: + description: >- + Optional. When true, attempt to cancel the operation. Cancellation + may fail if the operation is already executing. (Optional) + type: boolean + state: + description: >- + Optional. Output only. UnitOperationState describes the current + state of the unit operation. + readOnly: true + type: string + enumDescriptions: + - '' + - Unit operation is accepted but not ready to run. + - Unit operation is accepted and scheduled. + - Unit operation is running. + - Unit operation has completed successfully. + - Unit operation has failed. + - Unit operation was cancelled. + enum: + - UNIT_OPERATION_STATE_UNKNOWN + - UNIT_OPERATION_STATE_PENDING + - UNIT_OPERATION_STATE_SCHEDULED + - UNIT_OPERATION_STATE_RUNNING + - UNIT_OPERATION_STATE_SUCCEEDED + - UNIT_OPERATION_STATE_FAILED + - UNIT_OPERATION_STATE_CANCELLED + conditions: + description: >- + Optional. Output only. A set of conditions which indicate the + various conditions this resource can have. + readOnly: true + type: array + items: + $ref: '#/components/schemas/UnitOperationCondition' + schedule: + description: Optional. When to schedule this operation. + $ref: '#/components/schemas/Schedule' + engineState: + description: >- + Optional. Output only. The engine state for on-going deployment + engine operation(s). This field is opaque for external usage. + readOnly: true + type: string + errorCategory: + description: >- + Optional. Output only. UnitOperationErrorCategory describe the error + category. + readOnly: true + type: string + enumDescriptions: + - Unit operation error category is unspecified + - >- + Unit operation error category is not applicable, or it is not an + error + - Unit operation error category is fatal + - Unit operation error category is retriable + - Unit operation error category is ignorable + - >- + Unit operation error category is standard, counts towards Rollout + error budget + enum: + - UNIT_OPERATION_ERROR_CATEGORY_UNSPECIFIED + - NOT_APPLICABLE + - FATAL + - RETRIABLE + - IGNORABLE + - STANDARD + labels: + description: >- + Optional. The labels on the resource, which can be used for + categorization. similar to Kubernetes resource labels. + type: object + additionalProperties: + type: string + annotations: + description: >- + Optional. Annotations is an unstructured key-value map stored with a + resource that may be set by external tools to store and retrieve + arbitrary metadata. They are not queryable and should be preserved + when modifying objects. More info: + https://kubernetes.io/docs/user-guide/annotations + type: object + additionalProperties: + type: string + uid: + description: >- + Output only. The unique identifier of the resource. UID is unique in + the time and space for this resource within the scope of the + service. It is typically generated by the server on successful + creation of a resource and must not be changed. UID is used to + uniquely identify resources with resource name reuses. This should + be a UUID4. + readOnly: true + type: string + etag: + description: >- + Output only. An opaque value that uniquely identifies a version or + generation of a resource. It can be used to confirm that the client + and server agree on the ordering of a resource being written. + readOnly: true + type: string + createTime: + description: Output only. The timestamp when the resource was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: >- + Output only. The timestamp when the resource was last updated. Any + change to the resource made by users must refresh this value. + Changes to a resource made by the service should refresh this value. + readOnly: true + type: string + format: google-datetime + Provision: + id: Provision + description: >- + Provision is the unit operation that provision the underlying resources + represented by a Unit. Can only execute if the Unit is not currently + provisioned. + type: object + properties: + release: + description: >- + Optional. Reference to the Release object to use for the Unit. + (optional). + type: string + inputVariables: + description: Optional. Set of input variables. Maximum 100. (optional) + type: array + items: + $ref: '#/components/schemas/UnitVariable' + Upgrade: + id: Upgrade + description: >- + Upgrade is the unit operation that upgrades a provisioned unit, which + may also include the underlying resources represented by a Unit. Can + only execute if the Unit is currently provisioned. + type: object + properties: + release: + description: >- + Optional. Reference to the Release object to use for the Unit. + (optional). + type: string + inputVariables: + description: Optional. Set of input variables. Maximum 100. (optional) + type: array + items: + $ref: '#/components/schemas/UnitVariable' + Deprovision: + id: Deprovision + description: >- + Deprovision is the unit operation that deprovision the underlying + resources represented by a Unit. Can only execute if the Unit is + currently provisioned. + type: object + properties: {} + UnitOperationCondition: + id: UnitOperationCondition + description: >- + UnitOperationCondition describes the status of an Unit Operation. + UnitOperationCondition is individual components that contribute to an + overall state. + type: object + properties: + status: + description: Required. Status of the condition. + type: string + enumDescriptions: + - Condition status is unspecified. + - Condition is unknown. + - Condition is true. + - Condition is false. + enum: + - STATUS_UNSPECIFIED + - STATUS_UNKNOWN + - STATUS_TRUE + - STATUS_FALSE + type: + description: Required. Type of the condition. + type: string + enumDescriptions: + - Condition type is unspecified. + - Condition type is scheduled. + - Condition type is running. + - Condition type is succeeded. + - Condition type is cancelled. + enum: + - TYPE_UNSPECIFIED + - TYPE_SCHEDULED + - TYPE_RUNNING + - TYPE_SUCCEEDED + - TYPE_CANCELLED + lastTransitionTime: + description: >- + Required. Last time the condition transited from one status to + another. + type: string + format: google-datetime + message: + description: >- + Required. Human readable message indicating details about the last + transition. + type: string + reason: + description: Required. Brief reason for the condition's last transition. + type: string + Schedule: + id: Schedule + description: A time specification to schedule the maintenance. + type: object + properties: + startTime: + description: >- + Optional. Start of operation. If not set, will be set to the start + of the next window. (optional) + type: string + format: google-datetime + ListReleasesResponse: + id: ListReleasesResponse + description: The response structure for the ListReleases method. + type: object + properties: + releases: + description: The resulting releases. + type: array + items: + $ref: '#/components/schemas/Release' + nextPageToken: + description: >- + If present, the next page token can be provided to a subsequent + ListReleases call to list the next page. If empty, there are no more + pages. + type: string + unreachable: + description: Locations that could not be reached. + type: array + items: + type: string + Release: + id: Release + description: >- + A new version to be propagated and deployed to units. This includes + pointers to packaged blueprints for actuation (e.g Helm or Terraform + configuration packages) via artifact registry. + type: object + properties: + name: + description: >- + Identifier. The resource name (full URI of the resource) following + the standard naming scheme: + "projects/{project}/locations/{location}/releases/{release}" + type: string + unitKind: + description: >- + Required. Immutable. Reference to the UnitKind this Release + corresponds to (required and immutable once created). + type: string + blueprint: + description: >- + Optional. Blueprints are OCI Images that contain all of the + artifacts needed to provision a unit. + $ref: '#/components/schemas/Blueprint' + releaseRequirements: + description: >- + Optional. Set of requirements to be fulfilled on the Unit when using + this Release. + $ref: '#/components/schemas/ReleaseRequirements' + inputVariables: + description: >- + Optional. Output only. List of input variables declared on the + blueprint and can be present with their values on the unit spec + readOnly: true + type: array + items: + $ref: '#/components/schemas/UnitVariable' + outputVariables: + description: >- + Optional. Output only. List of output variables declared on the + blueprint and can be present with their values on the unit status + readOnly: true + type: array + items: + $ref: '#/components/schemas/UnitVariable' + inputVariableDefaults: + description: Optional. Mapping of input variables to default values. Maximum 100 + type: array + items: + $ref: '#/components/schemas/UnitVariable' + labels: + description: >- + Optional. The labels on the resource, which can be used for + categorization. similar to Kubernetes resource labels. + type: object + additionalProperties: + type: string + annotations: + description: >- + Optional. Annotations is an unstructured key-value map stored with a + resource that may be set by external tools to store and retrieve + arbitrary metadata. They are not queryable and should be preserved + when modifying objects. More info: + https://kubernetes.io/docs/user-guide/annotations + type: object + additionalProperties: + type: string + uid: + description: >- + Output only. The unique identifier of the resource. UID is unique in + the time and space for this resource within the scope of the + service. It is typically generated by the server on successful + creation of a resource and must not be changed. UID is used to + uniquely identify resources with resource name reuses. This should + be a UUID4. + readOnly: true + type: string + etag: + description: >- + Output only. An opaque value that uniquely identifies a version or + generation of a resource. It can be used to confirm that the client + and server agree on the ordering of a resource being written. + readOnly: true + type: string + createTime: + description: Output only. The timestamp when the resource was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: >- + Output only. The timestamp when the resource was last updated. Any + change to the resource made by users must refresh this value. + Changes to a resource made by the service should refresh this value. + readOnly: true + type: string + format: google-datetime + Blueprint: + id: Blueprint + description: >- + Blueprints are OCI Images that contain all of the artifacts needed to + provision a unit. Metadata such as, type of the engine used to actuate + the blueprint (e.g. terraform, helm etc) and version will come from the + image manifest. If the hostname is omitted, it will be assumed to be the + regional path to Artifact Registry (eg. us-east1-docker.pkg.dev). + type: object + properties: + package: + description: >- + Optional. Immutable. URI to a blueprint used by the Unit (required + unless unitKind or release is set). + type: string + engine: + description: >- + Output only. Type of the engine used to actuate the blueprint. e.g. + terraform, helm etc. + readOnly: true + type: string + version: + description: Output only. Version metadata if present on the blueprint. + readOnly: true + type: string + ReleaseRequirements: + id: ReleaseRequirements + description: Set of requirements to be fulfilled on the Unit when using this Release. + type: object + properties: + upgradeableFromReleases: + description: >- + Optional. A list of releases from which a unit can be upgraded to + this one (optional). If left empty no constraints will be applied. + When provided, unit upgrade requests to this release will check and + enforce this constraint. + type: array + items: + type: string + ListRolloutsResponse: + id: ListRolloutsResponse + description: The response structure for the ListRollouts method. + type: object + properties: + rollouts: + description: The resulting rollouts. + type: array + items: + $ref: '#/components/schemas/Rollout' + nextPageToken: + description: >- + If present, the next page token can be provided to a subsequent + ListRollouts call to list the next page. If empty, there are no more + pages. + type: string + unreachable: + description: Locations that could not be reached. + type: array + items: + type: string + Rollout: + id: Rollout + description: Represents a single rollout execution and its results + type: object + properties: + name: + description: >- + Identifier. The resource name (full URI of the resource) following + the standard naming scheme: + "projects/{project}/locations/{location}/rollout/{rollout_id}" + type: string + release: + description: >- + Optional. Immutable. Name of the Release that gets rolled out to + target Units. Required if no other type of release is specified. + type: string + startTime: + description: >- + Optional. Output only. The time when the rollout started executing. + Will be empty if the rollout hasn't started yet. + readOnly: true + type: string + format: google-datetime + endTime: + description: >- + Optional. Output only. The time when the rollout finished execution + (regardless of success, failure, or cancellation). Will be empty if + the rollout hasn't finished yet. Once set, the rollout is in + terminal state and all the results are final. + readOnly: true + type: string + format: google-datetime + state: + description: Output only. Current state of the rollout. + readOnly: true + type: string + enumDescriptions: + - Unspecified state. + - Rollout is in progress. + - Rollout has been paused. + - Rollout completed successfully. + - Rollout has failed. + - Rollout has been canceled. + - Rollout is waiting for some condition to be met before starting. + - Rollout is being canceled. + - Rollout is being resumed. + - Rollout is being paused. + enum: + - ROLLOUT_STATE_UNSPECIFIED + - ROLLOUT_STATE_RUNNING + - ROLLOUT_STATE_PAUSED + - ROLLOUT_STATE_SUCCEEDED + - ROLLOUT_STATE_FAILED + - ROLLOUT_STATE_CANCELLED + - ROLLOUT_STATE_WAITING + - ROLLOUT_STATE_CANCELLING + - ROLLOUT_STATE_RESUMING + - ROLLOUT_STATE_PAUSING + stateMessage: + description: >- + Output only. Human readable message indicating details about the + last state transition. + readOnly: true + type: string + stateTransitionTime: + description: >- + Optional. Output only. The time when the rollout transitioned into + its current state. + readOnly: true + type: string + format: google-datetime + rootRollout: + description: >- + Optional. Output only. The root rollout that this rollout is + stemming from. The resource name (full URI of the resource) + following the standard naming scheme: + "projects/{project}/locations/{location}/rollouts/{rollout_id}" + readOnly: true + type: string + parentRollout: + description: >- + Optional. Output only. The direct parent rollout that this rollout + is stemming from. The resource name (full URI of the resource) + following the standard naming scheme: + "projects/{project}/locations/{location}/rollouts/{rollout_id}" + readOnly: true + type: string + rolloutOrchestrationStrategy: + description: >- + Optional. The strategy used for executing this Rollout. This + strategy will override whatever strategy is specified in the + RolloutType. If not specified on creation, the strategy from + RolloutType will be used. There are two supported values strategies + which are used to control - "Google.Cloud.Simple.AllAtOnce" - + "Google.Cloud.Simple.OneLocationAtATime" A rollout with one of these + simple strategies will rollout across all locations defined in the + targeted UnitKind's Saas Locations. + type: string + unitFilter: + description: >- + Optional. CEL(https://github.com/google/cel-spec) formatted filter + string against Unit. The filter will be applied to determine the + eligible unit population. This filter can only reduce, but not + expand the scope of the rollout. If not provided, the unit_filter + from the RolloutType will be used. + type: string + rolloutKind: + description: >- + Optional. Immutable. Name of the RolloutKind this rollout is + stemming from and adhering to. + type: string + stats: + description: Optional. Output only. Details about the progress of the rollout. + readOnly: true + $ref: '#/components/schemas/RolloutStats' + control: + description: >- + Optional. Requested change to the execution of this rollout. Default + RolloutControl.action is ROLLOUT_ACTION_RUN meaning the rollout will + be executed to completion while progressing through all natural + Rollout States (such as RUNNING -> SUCCEEDED or RUNNING -> FAILED). + Requests can only be made when the Rollout is in a non-terminal + state. + $ref: '#/components/schemas/RolloutControl' + labels: + description: >- + Optional. The labels on the resource, which can be used for + categorization. similar to Kubernetes resource labels. + type: object + additionalProperties: + type: string + annotations: + description: >- + Optional. Annotations is an unstructured key-value map stored with a + resource that may be set by external tools to store and retrieve + arbitrary metadata. They are not queryable and should be preserved + when modifying objects. More info: + https://kubernetes.io/docs/user-guide/annotations + type: object + additionalProperties: + type: string + uid: + description: >- + Output only. The unique identifier of the resource. UID is unique in + the time and space for this resource within the scope of the + service. It is typically generated by the server on successful + creation of a resource and must not be changed. UID is used to + uniquely identify resources with resource name reuses. This should + be a UUID4. + readOnly: true + type: string + etag: + description: >- + Output only. An opaque value that uniquely identifies a version or + generation of a resource. It can be used to confirm that the client + and server agree on the ordering of a resource being written. + readOnly: true + type: string + createTime: + description: Output only. The timestamp when the resource was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: >- + Output only. The timestamp when the resource was last updated. Any + change to the resource made by users must refresh this value. + Changes to a resource made by the service should refresh this value. + readOnly: true + type: string + format: google-datetime + RolloutStats: + id: RolloutStats + description: RolloutStats contains information about the progress of a rollout. + type: object + properties: + operationsByState: + description: >- + Output only. A breakdown of the progress of operations triggered by + the rollout. Provides a count of Operations by their state. This can + be used to determine the number of units which have been updated, or + are scheduled to be updated. There will be at most one entry per + group. Possible values for operation groups are: - "SCHEDULED" - + "PENDING" - "RUNNING" - "SUCCEEDED" - "FAILED" - "CANCELLED" + readOnly: true + type: array + items: + $ref: '#/components/schemas/Aggregate' + Aggregate: + id: Aggregate + description: >- + Represents the aggregation of a set of population of like records by a + certain group. For example, a collection of unit counts can be + aggregated and grouped by their state. + type: object + properties: + group: + description: Required. Group by which to aggregate. + type: string + count: + description: Required. Number of records in the group. + type: integer + format: int32 + RolloutControl: + id: RolloutControl + description: >- + RolloutControl provides a way to request a change to the execution of a + Rollout by pausing or canceling it. + type: object + properties: + runParams: + description: >- + Optional. Parameters for the RUN action. It is an error to specify + this if the RolloutAction is not set to RUN. By default, the rollout + will retry failed operations when resumed. + $ref: '#/components/schemas/RunRolloutActionParams' + action: + description: >- + Required. Action to be performed on the Rollout. The default + behavior is to run the rollout until it naturally reaches a terminal + state. + type: string + enumDescriptions: + - Unspecified action, will be treated as RUN by default. + - >- + Run the Rollout until it naturally reaches a terminal state. A + rollout requested to run will progress through all natural Rollout + States (such as RUNNING -> SUCCEEDED or RUNNING -> FAILED). If + retriable errors are encountered during the rollout, the rollout + will paused by default and can be resumed by re-requesting this + RUN action. + - Pause the Rollout until it is resumed (i.e. RUN is requested). + - Cancel the Rollout permanently. + enum: + - ROLLOUT_ACTION_UNSPECIFIED + - ROLLOUT_ACTION_RUN + - ROLLOUT_ACTION_PAUSE + - ROLLOUT_ACTION_CANCEL + RunRolloutActionParams: + id: RunRolloutActionParams + description: >- + Parameters for the RUN action controlling the behavior of the rollout + when it is resumed from a PAUSED state. + type: object + properties: + retryFailedOperations: + description: >- + Required. If true, the rollout will retry failed operations when + resumed. This is applicable only the current state of the Rollout is + PAUSED and the requested action is RUN. + type: boolean + ListRolloutKindsResponse: + id: ListRolloutKindsResponse + description: The response structure for the ListRolloutKinds method. + type: object + properties: + rolloutKinds: + description: The resulting rollout kinds. + type: array + items: + $ref: '#/components/schemas/RolloutKind' + nextPageToken: + description: >- + If present, the next page token can be provided to a subsequent + ListRolloutKinds call to list the next page. If empty, there are no + more pages. + type: string + unreachable: + description: Locations that could not be reached. + type: array + items: + type: string + RolloutKind: + id: RolloutKind + description: >- + An object that describes various settings of Rollout execution. Includes + built-in policies across GCP and GDC, and customizable policies. + type: object + properties: + name: + description: >- + Identifier. The resource name (full URI of the resource) following + the standard naming scheme: + "projects/{project}/locations/{location}/rolloutKinds/{rollout_kind_id}" + type: string + unitKind: + description: >- + Required. Immutable. UnitKind that this rollout kind corresponds to. + Rollouts stemming from this rollout kind will target the units of + this unit kind. In other words, this defines the population of + target units to be upgraded by rollouts. + type: string + rolloutOrchestrationStrategy: + description: >- + Optional. The strategy used for executing a Rollout. This is a + required field. There are two supported values strategies which are + used to control - "Google.Cloud.Simple.AllAtOnce" - + "Google.Cloud.Simple.OneLocationAtATime" A rollout with one of these + simple strategies will rollout across all locations defined in the + associated UnitKind's Saas Locations. + type: string + unitFilter: + description: >- + Optional. CEL(https://github.com/google/cel-spec) formatted filter + string against Unit. The filter will be applied to determine the + eligible unit population. This filter can only reduce, but not + expand the scope of the rollout. + type: string + updateUnitKindStrategy: + description: >- + Optional. The config for updating the unit kind. By default, the + unit kind will be updated on the rollout start. + type: string + enumDescriptions: + - Strategy unspecified. + - Update the unit kind strategy on the rollout start. + - Never update the unit kind. + enum: + - UPDATE_UNIT_KIND_STRATEGY_UNSPECIFIED + - UPDATE_UNIT_KIND_STRATEGY_ON_START + - UPDATE_UNIT_KIND_STRATEGY_NEVER + errorBudget: + description: >- + Optional. The configuration for error budget. If the number of + failed units exceeds max(allowed_count, allowed_ratio * + total_units), the rollout will be paused. If not set, all units will + be attempted to be updated regardless of the number of failures + encountered. + $ref: '#/components/schemas/ErrorBudget' + labels: + description: >- + Optional. The labels on the resource, which can be used for + categorization. similar to Kubernetes resource labels. + type: object + additionalProperties: + type: string + annotations: + description: >- + Optional. Annotations is an unstructured key-value map stored with a + resource that may be set by external tools to store and retrieve + arbitrary metadata. They are not queryable and should be preserved + when modifying objects. More info: + https://kubernetes.io/docs/user-guide/annotations + type: object + additionalProperties: + type: string + uid: + description: >- + Output only. The unique identifier of the resource. UID is unique in + the time and space for this resource within the scope of the + service. It is typically generated by the server on successful + creation of a resource and must not be changed. UID is used to + uniquely identify resources with resource name reuses. This should + be a UUID4. + readOnly: true + type: string + etag: + description: >- + Output only. An opaque value that uniquely identifies a version or + generation of a resource. It can be used to confirm that the client + and server agree on the ordering of a resource being written. + readOnly: true + type: string + createTime: + description: Output only. The timestamp when the resource was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: >- + Output only. The timestamp when the resource was last updated. Any + change to the resource made by users must refresh this value. + Changes to a resource made by the service should refresh this value. + readOnly: true + type: string + format: google-datetime + ErrorBudget: + id: ErrorBudget + description: >- + The configuration for error budget. If the number of failed units + exceeds max(allowed_count, allowed_ratio * total_units), the rollout + will be paused. + type: object + properties: + allowedCount: + description: >- + Optional. The maximum number of failed units allowed in a location + without pausing the rollout. + type: integer + format: int32 + allowedPercentage: + description: >- + Optional. The maximum percentage of units allowed to fail (0, 100] + within a location without pausing the rollout. + type: integer + format: int32 + ListLocationsResponse: + id: ListLocationsResponse + description: The response message for Locations.ListLocations. + type: object + properties: + locations: + description: >- + A list of locations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/GoogleCloudLocationLocation' + nextPageToken: + description: The standard List next-page token. + type: string + GoogleCloudLocationLocation: + id: GoogleCloudLocationLocation + description: A resource that represents a Google Cloud location. + type: object + properties: + name: + description: >- + Resource name for the location, which may vary between + implementations. For example: + `"projects/example-project/locations/us-east1"` + type: string + locationId: + description: 'The canonical id for this location. For example: `"us-east1"`.' + type: string + displayName: + description: >- + The friendly name for this location, typically a nearby city name. + For example, "Tokyo". + type: string + labels: + description: >- + Cross-service attributes for the location. For example + {"cloud.googleapis.com/region": "us-east1"} + type: object + additionalProperties: + type: string + metadata: + description: >- + Service-specific metadata. For example the available capacity at the + given location. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + parameters: + 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: + type: string + enum: + - json + - media + - proto + 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 + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + x-stackQL-resources: + locations: + id: google.saasservicemgmt.locations + name: locations + title: Locations + methods: + list: + operation: + $ref: '#/paths/~1v1beta1~1projects~1{projectsId}~1locations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.locations + get: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + saas: + id: google.saasservicemgmt.saas + name: saas + title: Saas + methods: + list: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1saas/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.saas + create: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1saas/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1saas~1{saasId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1saas~1{saasId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1saas~1{saasId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/saas/methods/get' + - $ref: '#/components/x-stackQL-resources/saas/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/saas/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/saas/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/saas/methods/delete' + tenants: + id: google.saasservicemgmt.tenants + name: tenants + title: Tenants + methods: + list: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1tenants/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.tenants + create: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1tenants/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1tenants~1{tenantsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1tenants~1{tenantsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1tenants~1{tenantsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tenants/methods/get' + - $ref: '#/components/x-stackQL-resources/tenants/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/tenants/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/tenants/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/tenants/methods/delete' + unit_kinds: + id: google.saasservicemgmt.unit_kinds + name: unit_kinds + title: Unit_kinds + methods: + list: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1unitKinds/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.unitKinds + create: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1unitKinds/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1unitKinds~1{unitKindsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1unitKinds~1{unitKindsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1unitKinds~1{unitKindsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/unit_kinds/methods/get' + - $ref: '#/components/x-stackQL-resources/unit_kinds/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/unit_kinds/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/unit_kinds/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/unit_kinds/methods/delete' + units: + id: google.saasservicemgmt.units + name: units + title: Units + methods: + list: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1units/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.units + create: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1units/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1units~1{unitsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1units~1{unitsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1units~1{unitsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/units/methods/get' + - $ref: '#/components/x-stackQL-resources/units/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/units/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/units/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/units/methods/delete' + unit_operations: + id: google.saasservicemgmt.unit_operations + name: unit_operations + title: Unit_operations + methods: + list: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1unitOperations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.unitOperations + create: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1unitOperations/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1unitOperations~1{unitOperationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1unitOperations~1{unitOperationsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1unitOperations~1{unitOperationsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/unit_operations/methods/get' + - $ref: '#/components/x-stackQL-resources/unit_operations/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/unit_operations/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/unit_operations/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/unit_operations/methods/delete' + releases: + id: google.saasservicemgmt.releases + name: releases + title: Releases + methods: + list: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1releases/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.releases + create: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1releases/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1releases~1{releasesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1releases~1{releasesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1releases~1{releasesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/releases/methods/get' + - $ref: '#/components/x-stackQL-resources/releases/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/releases/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/releases/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/releases/methods/delete' + rollouts: + id: google.saasservicemgmt.rollouts + name: rollouts + title: Rollouts + methods: + list: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1rollouts/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.rollouts + create: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1rollouts/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1rollouts~1{rolloutsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1rollouts~1{rolloutsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1rollouts~1{rolloutsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/rollouts/methods/get' + - $ref: '#/components/x-stackQL-resources/rollouts/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/rollouts/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/rollouts/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/rollouts/methods/delete' + rollout_kinds: + id: google.saasservicemgmt.rollout_kinds + name: rollout_kinds + title: Rollout_kinds + methods: + list: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1rolloutKinds/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.rolloutKinds + create: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1rolloutKinds/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1rolloutKinds~1{rolloutKindsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1rolloutKinds~1{rolloutKindsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1rolloutKinds~1{rolloutKindsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/rollout_kinds/methods/get' + - $ref: '#/components/x-stackQL-resources/rollout_kinds/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/rollout_kinds/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/rollout_kinds/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/rollout_kinds/methods/delete' +paths: + /v1beta1/projects/{projectsId}/locations: + parameters: &ref_1 + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' + get: + description: Lists information about the supported locations for this service. + operationId: saasservicemgmt.projects.locations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListLocationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: extraLocationTypes + schema: + type: string + /v1beta1/projects/{projectsId}/locations/{locationsId}: + parameters: *ref_1 + get: + description: Gets information about a location. + operationId: saasservicemgmt.projects.locations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudLocationLocation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1beta1/projects/{projectsId}/locations/{locationsId}/saas: + parameters: *ref_1 + get: + description: Retrieve a collection of saas. + operationId: saasservicemgmt.projects.locations.saas.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListSaasResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + post: + description: Create a new saas. + operationId: saasservicemgmt.projects.locations.saas.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Saas' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Saas' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: saasId + schema: + type: string + - in: query + name: validateOnly + schema: + type: boolean + - in: query + name: requestId + schema: + type: string + /v1beta1/projects/{projectsId}/locations/{locationsId}/saas/{saasId}: + parameters: *ref_1 + get: + description: Retrieve a single saas. + operationId: saasservicemgmt.projects.locations.saas.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Saas' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: saasId + required: true + schema: + type: string + patch: + description: Update a single saas. + operationId: saasservicemgmt.projects.locations.saas.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Saas' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Saas' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: saasId + required: true + schema: + type: string + - in: query + name: validateOnly + schema: + type: boolean + - in: query + name: requestId + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Delete a single saas. + operationId: saasservicemgmt.projects.locations.saas.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: saasId + required: true + schema: + type: string + - in: query + name: etag + schema: + type: string + - in: query + name: validateOnly + schema: + type: boolean + - in: query + name: requestId + schema: + type: string + /v1beta1/projects/{projectsId}/locations/{locationsId}/tenants: + parameters: *ref_1 + get: + description: Retrieve a collection of tenants. + operationId: saasservicemgmt.projects.locations.tenants.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListTenantsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + post: + description: Create a new tenant. + operationId: saasservicemgmt.projects.locations.tenants.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Tenant' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Tenant' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: tenantId + schema: + type: string + - in: query + name: validateOnly + schema: + type: boolean + - in: query + name: requestId + schema: + type: string + /v1beta1/projects/{projectsId}/locations/{locationsId}/tenants/{tenantsId}: + parameters: *ref_1 + get: + description: Retrieve a single tenant. + operationId: saasservicemgmt.projects.locations.tenants.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Tenant' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: tenantsId + required: true + schema: + type: string + patch: + description: Update a single tenant. + operationId: saasservicemgmt.projects.locations.tenants.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Tenant' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Tenant' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: tenantsId + required: true + schema: + type: string + - in: query + name: validateOnly + schema: + type: boolean + - in: query + name: requestId + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Delete a single tenant. + operationId: saasservicemgmt.projects.locations.tenants.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: tenantsId + required: true + schema: + type: string + - in: query + name: etag + schema: + type: string + - in: query + name: validateOnly + schema: + type: boolean + - in: query + name: requestId + schema: + type: string + /v1beta1/projects/{projectsId}/locations/{locationsId}/unitKinds: + parameters: *ref_1 + get: + description: Retrieve a collection of unit kinds. + operationId: saasservicemgmt.projects.locations.unitKinds.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListUnitKindsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + post: + description: Create a new unit kind. + operationId: saasservicemgmt.projects.locations.unitKinds.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UnitKind' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/UnitKind' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: unitKindId + schema: + type: string + - in: query + name: validateOnly + schema: + type: boolean + - in: query + name: requestId + schema: + type: string + /v1beta1/projects/{projectsId}/locations/{locationsId}/unitKinds/{unitKindsId}: + parameters: *ref_1 + get: + description: Retrieve a single unit kind. + operationId: saasservicemgmt.projects.locations.unitKinds.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/UnitKind' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: unitKindsId + required: true + schema: + type: string + patch: + description: Update a single unit kind. + operationId: saasservicemgmt.projects.locations.unitKinds.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UnitKind' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/UnitKind' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: unitKindsId + required: true + schema: + type: string + - in: query + name: validateOnly + schema: + type: boolean + - in: query + name: requestId + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Delete a single unit kind. + operationId: saasservicemgmt.projects.locations.unitKinds.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: unitKindsId + required: true + schema: + type: string + - in: query + name: etag + schema: + type: string + - in: query + name: validateOnly + schema: + type: boolean + - in: query + name: requestId + schema: + type: string + /v1beta1/projects/{projectsId}/locations/{locationsId}/units: + parameters: *ref_1 + get: + description: Retrieve a collection of units. + operationId: saasservicemgmt.projects.locations.units.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListUnitsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + post: + description: Create a new unit. + operationId: saasservicemgmt.projects.locations.units.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Unit' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Unit' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: unitId + schema: + type: string + - in: query + name: validateOnly + schema: + type: boolean + - in: query + name: requestId + schema: + type: string + /v1beta1/projects/{projectsId}/locations/{locationsId}/units/{unitsId}: + parameters: *ref_1 + get: + description: Retrieve a single unit. + operationId: saasservicemgmt.projects.locations.units.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Unit' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: unitsId + required: true + schema: + type: string + patch: + description: Update a single unit. + operationId: saasservicemgmt.projects.locations.units.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Unit' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Unit' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: unitsId + required: true + schema: + type: string + - in: query + name: validateOnly + schema: + type: boolean + - in: query + name: requestId + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Delete a single unit. + operationId: saasservicemgmt.projects.locations.units.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: unitsId + required: true + schema: + type: string + - in: query + name: etag + schema: + type: string + - in: query + name: validateOnly + schema: + type: boolean + - in: query + name: requestId + schema: + type: string + /v1beta1/projects/{projectsId}/locations/{locationsId}/unitOperations: + parameters: *ref_1 + get: + description: Retrieve a collection of unit operations. + operationId: saasservicemgmt.projects.locations.unitOperations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListUnitOperationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + post: + description: Create a new unit operation. + operationId: saasservicemgmt.projects.locations.unitOperations.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UnitOperation' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/UnitOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: unitOperationId + schema: + type: string + - in: query + name: validateOnly + schema: + type: boolean + - in: query + name: requestId + schema: + type: string + /v1beta1/projects/{projectsId}/locations/{locationsId}/unitOperations/{unitOperationsId}: + parameters: *ref_1 + get: + description: Retrieve a single unit operation. + operationId: saasservicemgmt.projects.locations.unitOperations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/UnitOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: unitOperationsId + required: true + schema: + type: string + patch: + description: Update a single unit operation. + operationId: saasservicemgmt.projects.locations.unitOperations.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UnitOperation' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/UnitOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: unitOperationsId + required: true + schema: + type: string + - in: query + name: validateOnly + schema: + type: boolean + - in: query + name: requestId + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Delete a single unit operation. + operationId: saasservicemgmt.projects.locations.unitOperations.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: unitOperationsId + required: true + schema: + type: string + - in: query + name: etag + schema: + type: string + - in: query + name: validateOnly + schema: + type: boolean + - in: query + name: requestId + schema: + type: string + /v1beta1/projects/{projectsId}/locations/{locationsId}/releases: + parameters: *ref_1 + get: + description: Retrieve a collection of releases. + operationId: saasservicemgmt.projects.locations.releases.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListReleasesResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + post: + description: Create a new release. + operationId: saasservicemgmt.projects.locations.releases.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Release' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Release' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: releaseId + schema: + type: string + - in: query + name: validateOnly + schema: + type: boolean + - in: query + name: requestId + schema: + type: string + /v1beta1/projects/{projectsId}/locations/{locationsId}/releases/{releasesId}: + parameters: *ref_1 + get: + description: Retrieve a single release. + operationId: saasservicemgmt.projects.locations.releases.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Release' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: releasesId + required: true + schema: + type: string + patch: + description: Update a single release. + operationId: saasservicemgmt.projects.locations.releases.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Release' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Release' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: releasesId + required: true + schema: + type: string + - in: query + name: validateOnly + schema: + type: boolean + - in: query + name: requestId + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Delete a single release. + operationId: saasservicemgmt.projects.locations.releases.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: releasesId + required: true + schema: + type: string + - in: query + name: etag + schema: + type: string + - in: query + name: validateOnly + schema: + type: boolean + - in: query + name: requestId + schema: + type: string + /v1beta1/projects/{projectsId}/locations/{locationsId}/rollouts: + parameters: *ref_1 + get: + description: Retrieve a collection of rollouts. + operationId: saasservicemgmt.projects.locations.rollouts.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListRolloutsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + post: + description: Create a new rollout. + operationId: saasservicemgmt.projects.locations.rollouts.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Rollout' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Rollout' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: rolloutId + schema: + type: string + - in: query + name: validateOnly + schema: + type: boolean + - in: query + name: requestId + schema: + type: string + /v1beta1/projects/{projectsId}/locations/{locationsId}/rollouts/{rolloutsId}: + parameters: *ref_1 + get: + description: Retrieve a single rollout. + operationId: saasservicemgmt.projects.locations.rollouts.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Rollout' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: rolloutsId + required: true + schema: + type: string + patch: + description: Update a single rollout. + operationId: saasservicemgmt.projects.locations.rollouts.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Rollout' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Rollout' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: rolloutsId + required: true + schema: + type: string + - in: query + name: validateOnly + schema: + type: boolean + - in: query + name: requestId + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Delete a single rollout. + operationId: saasservicemgmt.projects.locations.rollouts.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: rolloutsId + required: true + schema: + type: string + - in: query + name: etag + schema: + type: string + - in: query + name: validateOnly + schema: + type: boolean + - in: query + name: requestId + schema: + type: string + /v1beta1/projects/{projectsId}/locations/{locationsId}/rolloutKinds: + parameters: *ref_1 + get: + description: Retrieve a collection of rollout kinds. + operationId: saasservicemgmt.projects.locations.rolloutKinds.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListRolloutKindsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + post: + description: Create a new rollout kind. + operationId: saasservicemgmt.projects.locations.rolloutKinds.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RolloutKind' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/RolloutKind' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: rolloutKindId + schema: + type: string + - in: query + name: validateOnly + schema: + type: boolean + - in: query + name: requestId + schema: + type: string + /v1beta1/projects/{projectsId}/locations/{locationsId}/rolloutKinds/{rolloutKindsId}: + parameters: *ref_1 + get: + description: Retrieve a single rollout kind. + operationId: saasservicemgmt.projects.locations.rolloutKinds.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/RolloutKind' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: rolloutKindsId + required: true + schema: + type: string + patch: + description: Update a single rollout kind. + operationId: saasservicemgmt.projects.locations.rolloutKinds.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RolloutKind' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/RolloutKind' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: rolloutKindsId + required: true + schema: + type: string + - in: query + name: validateOnly + schema: + type: boolean + - in: query + name: requestId + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Delete a single rollout kind. + operationId: saasservicemgmt.projects.locations.rolloutKinds.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: rolloutKindsId + required: true + schema: + type: string + - in: query + name: etag + schema: + type: string + - in: query + name: validateOnly + schema: + type: boolean + - in: query + name: requestId + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/sasportal.yaml b/providers/src/googleapis.com/v00.00.00000/services/sasportal.yaml index 7c06fce1..c3623887 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/sasportal.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/sasportal.yaml @@ -7,8 +7,8 @@ info: title: SAS Portal API description: '' version: v1alpha1 - x-discovery-doc-revision: '20241031' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250824' + x-generated-date: '2025-08-28' externalDocs: url: https://developers.google.com/spectrum-access-system/ servers: @@ -22,10 +22,10 @@ components: implicit: authorizationUrl: https://accounts.google.com/o/oauth2/auth scopes: &ref_0 - https://www.googleapis.com/auth/sasportal: Read, create, update, and delete your SAS Portal data. 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/sasportal: Read, create, update, and delete your SAS Portal data. Oauth2c: type: oauth2 description: Oauth 2.0 authorization code authentication @@ -35,527 +35,351 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - SasPortalValidateInstallerResponse: - id: SasPortalValidateInstallerResponse - type: object - description: Response for ValidateInstaller. - properties: {} - SasPortalTestPermissionsRequest: - id: SasPortalTestPermissionsRequest + SasPortalCustomer: + id: SasPortalCustomer + description: Entity representing a SAS customer. type: object properties: - permissions: - description: The set of permissions to check for the `resource`. + name: + description: Output only. Resource name of the customer. + type: string + displayName: + description: >- + Required. Name of the organization that the customer entity + represents. + type: string + sasUserIds: + description: User IDs used by the devices belonging to this customer. type: array items: type: string - resource: - description: >- - Required. The resource for which the permissions are being - requested. - type: string - description: Request message for `TestPermissions` method. - SasPortalPolicy: - id: SasPortalPolicy - description: Defines an access control policy to the resources. + SasPortalListCustomersResponse: + id: SasPortalListCustomersResponse + description: Response for `ListCustomers`. type: object properties: - assignments: - items: - $ref: '#/components/schemas/SasPortalAssignment' + customers: + description: The list of customers that match the request. type: array - description: List of assignments - etag: - format: byte + items: + $ref: '#/components/schemas/SasPortalCustomer' + nextPageToken: description: >- - The 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 - GetPolicy, and systems are expected to put that etag in the request - to SetPolicy to ensure that their change will be applied to the same - version of the policy. If no etag is provided in the call to - GetPolicy, then the existing policy is overwritten blindly. + A pagination token returned from a previous call to ListCustomers + that indicates from where listing should continue. If the field is + missing or empty, it means there are no more customers. type: string - SasPortalSignDeviceRequest: - description: Request for SignDevice. + SasPortalListGcpProjectDeploymentsResponse: + id: SasPortalListGcpProjectDeploymentsResponse + description: Response for [ListGcpProjectDeployments]. + type: object properties: - device: - $ref: '#/components/schemas/SasPortalDevice' - description: >- - Required. The device to sign. The device fields name, fcc_id and - serial_number must be set. The user_id field must be set. - id: SasPortalSignDeviceRequest + deployments: + description: Optional. Deployments associated with the GCP project + type: array + items: + $ref: '#/components/schemas/SasPortalGcpProjectDeployment' + SasPortalGcpProjectDeployment: + id: SasPortalGcpProjectDeployment + description: >- + Deployment associated with the GCP project. Includes whether SAS + analytics has been enabled or not. type: object - SasPortalDeviceMetadata: - id: SasPortalDeviceMetadata + properties: + hasEnabledAnalytics: + description: Whether SAS analytics has been enabled. + type: boolean + deployment: + description: Deployment associated with the GCP project. + $ref: '#/components/schemas/SasPortalDeployment' + SasPortalDeployment: + id: SasPortalDeployment + description: The Deployment. type: object - description: Device data overridable by both SAS Portal and registration requests. properties: - antennaModel: + name: + description: Output only. Resource name. + readOnly: true type: string - description: >- - If populated, the Antenna Model Pattern to use. Format is: - `RecordCreatorId:PatternId` - commonChannelGroup: + displayName: + description: The deployment's display name. type: string + sasUserIds: description: >- - Common Channel Group (CCG). A group of CBSDs in the same ICG - requesting a common primary channel assignment. For more details, - see [CBRSA-TS-2001 - V3.0.0](https://ongoalliance.org/wp-content/uploads/2020/02/CBRSA-TS-2001-V3.0.0_Approved-for-publication.pdf). - nrqzValidation: - readOnly: true - description: Output only. National Radio Quiet Zone validation info. - $ref: '#/components/schemas/SasPortalNrqzValidation' - nrqzValidated: - readOnly: true - deprecated: true - type: boolean - description: >- - Output only. Set to `true` if a CPI has validated that they have - coordinated with the National Quiet Zone office. - interferenceCoordinationGroup: - type: string + User ID used by the devices belonging to this deployment. Each + deployment should be associated with one unique user ID. + type: array + items: + type: string + frns: description: >- - Interference Coordination Group (ICG). A group of CBSDs that manage - their own interference with the group. For more details, see - [CBRSA-TS-2001 - V3.0.0](https://ongoalliance.org/wp-content/uploads/2020/02/CBRSA-TS-2001-V3.0.0_Approved-for-publication.pdf). - SasPortalTestPermissionsResponse: - description: Response message for `TestPermissions` method. - id: SasPortalTestPermissionsResponse - properties: - permissions: + Output only. The FCC Registration Numbers (FRNs) copied from its + direct parent. + readOnly: true type: array - description: A set of permissions that the caller is allowed. items: type: string - type: object - SasPortalNode: - id: SasPortalNode - description: The Node. + SasPortalProvisionDeploymentRequest: + id: SasPortalProvisionDeploymentRequest + description: >- + Request for [ProvisionDeployment]. + [spectrum.sas.portal.v1alpha1.Provisioning.ProvisionDeployment]. GCP + Project, Organization Info, and caller’s GAIA ID should be retrieved + from the RPC handler, and used as inputs to create a new SAS + organization (if not exists) and a new SAS deployment. type: object properties: - displayName: - description: The node's display name. + newOrganizationDisplayName: + description: >- + Optional. If this field is set, and a new SAS Portal Organization + needs to be created, its display name will be set to the value of + this field. type: string - name: + newDeploymentDisplayName: + description: >- + Optional. If this field is set, and a new SAS Portal Deployment + needs to be created, its display name will be set to the value of + this field. type: string - description: Output only. Resource name. - sasUserIds: - items: - type: string - type: array - description: User ids used by the devices belonging to this node. - SasPortalSetupSasAnalyticsMetadata: - id: SasPortalSetupSasAnalyticsMetadata - properties: {} - type: object + organizationId: + description: >- + Optional. If this field is set then a new deployment will be created + under the organization specified by this id. + type: string + format: int64 + SasPortalProvisionDeploymentResponse: + id: SasPortalProvisionDeploymentResponse description: >- - Metadata returned by the long running operation for the - SetupSasAnalytics rpc. - SasPortalGenerateSecretRequest: - type: object - id: SasPortalGenerateSecretRequest - properties: {} - description: Request for GenerateSecret. - SasPortalGetPolicyRequest: - id: SasPortalGetPolicyRequest - description: Request message for `GetPolicy` method. + Response for [ProvisionDeployment]. + [spectrum.sas.portal.v1alpha1.Provisioning.ProvisionDeployment]. type: object properties: - resource: - description: Required. The resource for which the policy is being requested. + errorMessage: + description: >- + Optional. Optional error message if the provisioning request is not + successful. type: string - SasPortalListDevicesResponse: - description: Response for ListDevices. - id: SasPortalListDevicesResponse + SasPortalListLegacyOrganizationsResponse: + id: SasPortalListLegacyOrganizationsResponse + description: >- + Response for [ListLegacyOrganizations]. + [spectrum.sas.portal.v1alpha1.Provisioning.ListLegacyOrganizations]. type: object properties: - devices: + organizations: + description: Optional. Legacy SAS organizations. type: array items: - $ref: '#/components/schemas/SasPortalDevice' - description: The devices that match the request. - nextPageToken: + $ref: '#/components/schemas/SasPortalOrganization' + SasPortalOrganization: + id: SasPortalOrganization + description: Organization details. + type: object + properties: + id: + description: Id of organization type: string - description: >- - A pagination token returned from a previous call to ListDevices that - indicates from where listing should continue. If the field is - missing or empty, it means there is no more devices. - SasPortalAssignment: + format: int64 + displayName: + description: Name of organization + type: string + SasPortalMigrateOrganizationRequest: + id: SasPortalMigrateOrganizationRequest + description: >- + Request for [MigrateOrganization]. + [spectrum.sas.portal.v1alpha1.Provisioning.MigrateOrganization]. GCP + Project, Organization Info, and caller's GAIA ID should be retrieved + from the RPC handler, and used to check authorization on SAS Portal + organization and to create GCP Projects. type: object - description: Associates `members` with a `role`. properties: - role: - description: Required. Role that is assigned to `members`. + organizationId: + description: Required. Id of the SAS organization to be migrated. type: string - members: - type: array - description: >- - The identities the role is assigned to. It can have the following - values: * `{user_email}`: An email address that represents a - specific Google account. For example: `alice@gmail.com`. * - `{group_email}`: An email address that represents a Google group. - For example, `viewers@gmail.com`. - items: - type: string - id: SasPortalAssignment - SasPortalChannelWithScore: - id: SasPortalChannelWithScore - properties: - score: - type: number - description: The channel score, normalized to be in the range [0,100]. - format: double - frequencyRange: - $ref: '#/components/schemas/SasPortalFrequencyRange' - description: The frequency range of the channel. - description: The channel with score. - type: object - SasPortalGenerateSecretResponse: - description: Response for GenerateSecret. - properties: - secret: - description: The secret generated by the string and used by ValidateInstaller. - type: string - id: SasPortalGenerateSecretResponse - type: object - SasPortalEmpty: - properties: {} + format: int64 + SasPortalOperation: + id: SasPortalOperation description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + This resource represents a long-running operation that is the result of + a network API call. type: object - id: SasPortalEmpty - SasPortalCustomer: properties: - displayName: - description: >- - Required. Name of the organization that the customer entity - represents. - type: string name: - description: Output only. Resource name of the customer. - type: string - sasUserIds: - type: array - items: - type: string - description: User IDs used by the devices belonging to this customer. - id: SasPortalCustomer - type: object - description: Entity representing a SAS customer. - SasPortalSetupSasAnalyticsResponse: - properties: {} - type: object - description: >- - Response returned by the long running operation for the - SetupSasAnalytics rpc. - id: SasPortalSetupSasAnalyticsResponse - SasPortalDeviceAirInterface: - properties: - supportedSpec: - type: string description: >- - Optional. This field is related to the `radioTechnology` and - provides the air interface specification that the CBSD is compliant - with at the time of registration. - radioTechnology: - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - enum: - - RADIO_TECHNOLOGY_UNSPECIFIED - - E_UTRA - - CAMBIUM_NETWORKS - - FOUR_G_BBW_SAA_1 - - NR - - DOODLE_CBRS - - CW - - REDLINE - - TARANA_WIRELESS - - FAROS + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. type: string + metadata: description: >- - Conditional. This field specifies the radio access technology that - is used for the CBSD. - id: SasPortalDeviceAirInterface - type: object - description: Information about the device's air interface. - SasPortalSetPolicyRequest: - id: SasPortalSetPolicyRequest - description: Request message for `SetPolicy` method. - type: object - properties: - disableNotification: + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + done: + description: >- + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. type: boolean + error: description: >- - Optional. Set the field as `true` to disable the onboarding - notification. - resource: - type: string + The error result of the operation in case of failure or + cancellation. + $ref: '#/components/schemas/SasPortalStatus' + response: description: >- - Required. The resource for which the policy is being specified. This - policy replaces any existing policy. - policy: - $ref: '#/components/schemas/SasPortalPolicy' - description: Required. The policy to be applied to the `resource`. - SasPortalDeviceModel: - properties: - name: - description: The name of the device model. - type: string - softwareVersion: - description: The software version of the device. - type: string - vendor: - description: The name of the device vendor. - type: string - hardwareVersion: - type: string - description: The hardware version of the device. - firmwareVersion: - description: The firmware version of the device. - type: string - id: SasPortalDeviceModel - type: object - description: Information about the model of the device. - SasPortalMigrateOrganizationMetadata: - properties: - operationState: - description: Output only. Current operation state - enum: - - OPERATION_STATE_UNSPECIFIED - - OPERATION_STATE_PENDING - - OPERATION_STATE_RUNNING - - OPERATION_STATE_SUCCEEDED - - OPERATION_STATE_FAILED - enumDescriptions: - - Unspecified. - - Pending (Not started). - - In-progress. - - Done successfully. - - Done with errors. - readOnly: true - type: string + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + SasPortalStatus: + id: SasPortalStatus description: >- - Long-running operation metadata message returned by the - MigrateOrganization. - id: SasPortalMigrateOrganizationMetadata - type: object - SasPortalDeviceGrant: - id: SasPortalDeviceGrant + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). type: object properties: - grantId: - description: Grant Id. - type: string - channelType: - enumDescriptions: - - '' - - '' - - '' - type: string - enum: - - CHANNEL_TYPE_UNSPECIFIED - - CHANNEL_TYPE_GAA - - CHANNEL_TYPE_PAL - description: Type of channel used. - moveList: - items: - $ref: '#/components/schemas/SasPortalDpaMoveList' - description: The DPA move lists on which this grant appears. - type: array - maxEirp: + code: + description: The status code, which should be an enum value of google.rpc.Code. + type: integer + format: int32 + message: description: >- - Maximum Equivalent Isotropically Radiated Power (EIRP) permitted by - the grant. The maximum EIRP is in units of dBm/MHz. The value of - `maxEirp` represents the average (RMS) EIRP that would be measured - by the procedure defined in FCC part 96.41(e)(3). - type: number - format: double - frequencyRange: - description: The transmission frequency range. - $ref: '#/components/schemas/SasPortalFrequencyRange' - state: - description: State of the grant. + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. type: string - enumDescriptions: - - '' - - >- - The grant has been granted but the device is not heartbeating on - it. - - The grant has been terminated by the SAS. - - The grant has been suspended by the SAS. - - The device is currently transmitting. - - The grant has expired. - enum: - - GRANT_STATE_UNSPECIFIED - - GRANT_STATE_GRANTED - - GRANT_STATE_TERMINATED - - GRANT_STATE_SUSPENDED - - GRANT_STATE_AUTHORIZED - - GRANT_STATE_EXPIRED - suspensionReason: + details: + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. type: array - description: If the grant is suspended, the reason(s) for suspension. - items: - type: string - lastHeartbeatTransmitExpireTime: - type: string - format: google-datetime - description: The transmit expiration time of the last heartbeat. - expireTime: - type: string - description: The expiration time of the grant. - format: google-datetime - description: >- - Device grant. It is an authorization provided by the Spectrum Access - System to a device to transmit using specified operating parameters - after a successful heartbeat by the device. - SasPortalListGcpProjectDeploymentsResponse: - type: object - id: SasPortalListGcpProjectDeploymentsResponse - description: Response for [ListGcpProjectDeployments]. - properties: - deployments: items: - $ref: '#/components/schemas/SasPortalGcpProjectDeployment' - description: Optional. Deployments associated with the GCP project - type: array - SasPortalCreateSignedDeviceRequest: - type: object - description: Request for CreateSignedDevice. - id: SasPortalCreateSignedDeviceRequest - properties: - encodedDevice: - type: string - description: >- - Required. JSON Web Token signed using a CPI private key. Payload - must be the JSON encoding of the device. The user_id field must be - set. - format: byte - installerId: - description: >- - Required. Unique installer id (CPI ID) from the Certified - Professional Installers database. - type: string + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. SasPortalSetupSasAnalyticsRequest: - type: object - description: Request for the SetupSasAnalytics rpc. id: SasPortalSetupSasAnalyticsRequest + description: Request for the SetupSasAnalytics rpc. + type: object properties: userId: - type: string description: >- Optional. User id to setup analytics for, if not provided the user id associated with the project is used. optional - SasPortalValidateInstallerRequest: - id: SasPortalValidateInstallerRequest - properties: - secret: - type: string - description: Required. Secret returned by the GenerateSecret. - installerId: type: string - description: >- - Required. Unique installer id (CPI ID) from the Certified - Professional Installers database. - encodedSecret: - type: string - description: >- - Required. JSON Web Token signed using a CPI private key. Payload - must include a "secret" claim whose value is the secret. - type: object - description: Request for ValidateInstaller. - SasPortalOrganization: - id: SasPortalOrganization + SasPortalDevice: + id: SasPortalDevice type: object properties: - id: - format: int64 + name: + description: Output only. The resource path name. type: string - description: Id of organization - displayName: - description: Name of organization + fccId: + description: >- + The FCC identifier of the device. Refer to + https://www.fcc.gov/oet/ea/fccid for FccID format. Accept + underscores and periods because some test-SAS customers use them. type: string - description: Organization details. - SasPortalDeployment: - description: The Deployment. - properties: - name: - readOnly: true - description: Output only. Resource name. + serialNumber: + description: A serial number assigned to the device by the device manufacturer. + type: string + preloadedConfig: + description: Configuration of the device, as specified via SAS Portal API. + $ref: '#/components/schemas/SasPortalDeviceConfig' + activeConfig: + description: >- + Output only. Current configuration of the device as registered to + the SAS. + $ref: '#/components/schemas/SasPortalDeviceConfig' + state: + description: Output only. Device state. type: string + enumDescriptions: + - Unspecified state. + - >- + Device created in the SAS Portal, however, not yet registered with + SAS. + - Device registered with SAS. + - Device de-registered with SAS. + enum: + - DEVICE_STATE_UNSPECIFIED + - RESERVED + - REGISTERED + - DEREGISTERED + grants: + description: Output only. Grants held by the device. + type: array + items: + $ref: '#/components/schemas/SasPortalDeviceGrant' displayName: - description: The deployment's display name. + description: Device display name. type: string - frns: + deviceMetadata: description: >- - Output only. The FCC Registration Numbers (FRNs) copied from its - direct parent. - items: - type: string + Device parameters that can be overridden by both SAS Portal and SAS + registration requests. + $ref: '#/components/schemas/SasPortalDeviceMetadata' + currentChannels: + description: Output only. Current channels with scores. readOnly: true + deprecated: true type: array - sasUserIds: - type: array - description: >- - User ID used by the devices belonging to this deployment. Each - deployment should be associated with one unique user ID. items: - type: string - type: object - id: SasPortalDeployment - SasPortalProvisionDeploymentResponse: - description: >- - Response for [ProvisionDeployment]. - [spectrum.sas.portal.v1alpha1.Provisioning.ProvisionDeployment]. - properties: - errorMessage: + $ref: '#/components/schemas/SasPortalChannelWithScore' + grantRangeAllowlists: description: >- - Optional. Optional error message if the provisioning request is not - successful. - type: string - type: object - id: SasPortalProvisionDeploymentResponse + Only ranges that are within the allowlists are available for new + grants. + type: array + items: + $ref: '#/components/schemas/SasPortalFrequencyRange' SasPortalDeviceConfig: - description: Information about the device configuration. id: SasPortalDeviceConfig + description: Information about the device configuration. type: object properties: - userId: - type: string - description: The identifier of a device user. - updateTime: + category: + description: FCC category of the device. type: string - description: Output only. The last time the device configuration was edited. - format: google-datetime + enumDescriptions: + - Unspecified device category. + - Category A. + - Category B. + enum: + - DEVICE_CATEGORY_UNSPECIFIED + - DEVICE_CATEGORY_A + - DEVICE_CATEGORY_B model: - $ref: '#/components/schemas/SasPortalDeviceModel' description: Information about this device model. + $ref: '#/components/schemas/SasPortalDeviceModel' airInterface: description: Information about this device's air interface. $ref: '#/components/schemas/SasPortalDeviceAirInterface' - isSigned: - type: boolean - description: Output only. Whether the configuration has been signed by a CPI. installationParams: - $ref: '#/components/schemas/SasPortalInstallationParams' description: Installation parameters for the device. + $ref: '#/components/schemas/SasPortalInstallationParams' measurementCapabilities: description: Measurement reporting capabilities of the device. type: array @@ -569,536 +393,712 @@ components: - MEASUREMENT_CAPABILITY_UNSPECIFIED - MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITH_GRANT - MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITHOUT_GRANT + userId: + description: The identifier of a device user. + type: string + callSign: + description: The call sign of the device operator. + type: string state: description: State of the configuration. type: string + enumDescriptions: + - '' + - '' + - '' enum: - DEVICE_CONFIG_STATE_UNSPECIFIED - DRAFT - FINAL + isSigned: + description: Output only. Whether the configuration has been signed by a CPI. + type: boolean + updateTime: + description: Output only. The last time the device configuration was edited. + type: string + format: google-datetime + SasPortalDeviceModel: + id: SasPortalDeviceModel + description: Information about the model of the device. + type: object + properties: + vendor: + description: The name of the device vendor. + type: string + name: + description: The name of the device model. + type: string + softwareVersion: + description: The software version of the device. + type: string + hardwareVersion: + description: The hardware version of the device. + type: string + firmwareVersion: + description: The firmware version of the device. + type: string + SasPortalDeviceAirInterface: + id: SasPortalDeviceAirInterface + description: Information about the device's air interface. + type: object + properties: + radioTechnology: + description: >- + Conditional. This field specifies the radio access technology that + is used for the CBSD. + type: string enumDescriptions: - '' - '' - '' - category: - description: FCC category of the device. - type: string + - '' + - '' + - '' + - '' + - '' + - '' + - '' enum: - - DEVICE_CATEGORY_UNSPECIFIED - - DEVICE_CATEGORY_A - - DEVICE_CATEGORY_B - enumDescriptions: - - Unspecified device category. - - Category A. - - Category B. - callSign: - description: The call sign of the device operator. + - RADIO_TECHNOLOGY_UNSPECIFIED + - E_UTRA + - CAMBIUM_NETWORKS + - FOUR_G_BBW_SAA_1 + - NR + - DOODLE_CBRS + - CW + - REDLINE + - TARANA_WIRELESS + - FAROS + supportedSpec: + description: >- + Optional. This field is related to the `radioTechnology` and + provides the air interface specification that the CBSD is compliant + with at the time of registration. type: string - SasPortalDeploymentAssociation: - id: SasPortalDeploymentAssociation + SasPortalInstallationParams: + id: SasPortalInstallationParams + description: Information about the device installation parameters. + type: object properties: - gcpProjectId: - description: GCP project id of the associated project. + latitude: + description: >- + Latitude of the device antenna location in degrees relative to the + WGS 84 datum. The allowed range is from -90.000000 to +90.000000. + Positive values represent latitudes north of the equator; negative + values south of the equator. + type: number + format: double + longitude: + description: >- + Longitude of the device antenna location in degrees relative to the + WGS 84 datum. The allowed range is from -180.000000 to +180.000000. + Positive values represent longitudes east of the prime meridian; + negative values west of the prime meridian. + type: number + format: double + height: + description: >- + Device antenna height in meters. When the `heightType` parameter + value is "AGL", the antenna height should be given relative to + ground level. When the `heightType` parameter value is "AMSL", it is + given with respect to WGS84 datum. + type: number + format: double + heightType: + description: Specifies how the height is measured. type: string - userId: - description: User id of the deployment. + enumDescriptions: + - Unspecified height type. + - AGL height is measured relative to the ground level. + - AMSL height is measured relative to the mean sea level. + enum: + - HEIGHT_TYPE_UNSPECIFIED + - HEIGHT_TYPE_AGL + - HEIGHT_TYPE_AMSL + horizontalAccuracy: + description: >- + A positive number in meters to indicate accuracy of the device + antenna horizontal location. This optional parameter should only be + present if its value is less than the FCC requirement of 50 meters. + type: number + format: double + verticalAccuracy: + description: >- + A positive number in meters to indicate accuracy of the device + antenna vertical location. This optional parameter should only be + present if its value is less than the FCC requirement of 3 meters. + type: number + format: double + indoorDeployment: + description: >- + Whether the device antenna is indoor or not. `true`: indoor. + `false`: outdoor. + type: boolean + antennaAzimuth: + description: >- + Boresight direction of the horizontal plane of the antenna in + degrees with respect to true north. The value of this parameter is + an integer with a value between 0 and 359 inclusive. A value of 0 + degrees means true north; a value of 90 degrees means east. This + parameter is optional for Category A devices and conditional for + Category B devices. + type: integer + format: int32 + antennaDowntilt: + description: >- + Antenna downtilt in degrees and is an integer with a value between + -90 and +90 inclusive; a negative value means the antenna is tilted + up (above horizontal). This parameter is optional for Category A + devices and conditional for Category B devices. + type: integer + format: int32 + antennaGain: + description: >- + Peak antenna gain in dBi. This parameter is a double with a value + between -127 and +128 (dBi) inclusive. Part of Release 2 to support + floating-point value + type: number + format: double + eirpCapability: + description: >- + This parameter is the maximum device EIRP in units of dBm/10MHz and + is an integer with a value between -127 and +47 (dBm/10 MHz) + inclusive. If not included, SAS interprets it as maximum allowable + EIRP in units of dBm/10MHz for device category. + type: integer + format: int32 + antennaBeamwidth: + description: >- + 3-dB antenna beamwidth of the antenna in the horizontal-plane in + degrees. This parameter is an unsigned integer having a value + between 0 and 360 (degrees) inclusive; it is optional for Category A + devices and conditional for Category B devices. + type: integer + format: int32 + antennaModel: + description: >- + If an external antenna is used, the antenna model is optionally + provided in this field. The string has a maximum length of 128 + octets. type: string - description: Association between a gcp project and a SAS user id. - type: object - SasPortalStatus: + cpeCbsdIndication: + description: >- + If present, this parameter specifies whether the CBSD is a CPE-CBSD + or not. + type: boolean + SasPortalDeviceGrant: + id: SasPortalDeviceGrant description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - id: SasPortalStatus + Device grant. It is an authorization provided by the Spectrum Access + System to a device to transmit using specified operating parameters + after a successful heartbeat by the device. + type: object properties: - message: + maxEirp: description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. + Maximum Equivalent Isotropically Radiated Power (EIRP) permitted by + the grant. The maximum EIRP is in units of dBm/MHz. The value of + `maxEirp` represents the average (RMS) EIRP that would be measured + by the procedure defined in FCC part 96.41(e)(3). + type: number + format: double + frequencyRange: + description: The transmission frequency range. + $ref: '#/components/schemas/SasPortalFrequencyRange' + state: + description: State of the grant. + type: string + enumDescriptions: + - '' + - >- + The grant has been granted but the device is not heartbeating on + it. + - The grant has been terminated by the SAS. + - The grant has been suspended by the SAS. + - The device is currently transmitting. + - The grant has expired. + enum: + - GRANT_STATE_UNSPECIFIED + - GRANT_STATE_GRANTED + - GRANT_STATE_TERMINATED + - GRANT_STATE_SUSPENDED + - GRANT_STATE_AUTHORIZED + - GRANT_STATE_EXPIRED + channelType: + description: Type of channel used. type: string - code: - description: The status code, which should be an enum value of google.rpc.Code. - type: integer - format: int32 - details: - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. + enumDescriptions: + - '' + - '' + - '' + enum: + - CHANNEL_TYPE_UNSPECIFIED + - CHANNEL_TYPE_GAA + - CHANNEL_TYPE_PAL + moveList: + description: The DPA move lists on which this grant appears. type: array items: - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: object + $ref: '#/components/schemas/SasPortalDpaMoveList' + expireTime: + description: The expiration time of the grant. + type: string + format: google-datetime + suspensionReason: + description: If the grant is suspended, the reason(s) for suspension. + type: array + items: + type: string + grantId: + description: Grant Id. + type: string + lastHeartbeatTransmitExpireTime: + description: The transmit expiration time of the last heartbeat. + type: string + format: google-datetime SasPortalFrequencyRange: + id: SasPortalFrequencyRange + description: Frequency range from `low_frequency` to `high_frequency`. + type: object properties: - highFrequencyMhz: - description: The highest frequency of the frequency range in MHz. + lowFrequencyMhz: + description: The lowest frequency of the frequency range in MHz. type: number format: double - lowFrequencyMhz: + highFrequencyMhz: + description: The highest frequency of the frequency range in MHz. type: number format: double - description: The lowest frequency of the frequency range in MHz. - id: SasPortalFrequencyRange - description: Frequency range from `low_frequency` to `high_frequency`. - type: object - SasPortalMigrateOrganizationResponse: - description: >- - Response for [MigrateOrganization]. - [spectrum.sas.portal.v1alpha1.Provisioning.MigrateOrganization]. + SasPortalDpaMoveList: + id: SasPortalDpaMoveList + description: An entry in a DPA's move list. type: object - id: SasPortalMigrateOrganizationResponse - properties: - deploymentAssociation: - items: - $ref: '#/components/schemas/SasPortalDeploymentAssociation' - type: array - description: >- - Optional. A list of deployment association that were created for the - migration, or current associations if they already exist. - SasPortalMigrateOrganizationRequest: - id: SasPortalMigrateOrganizationRequest properties: - organizationId: + dpaId: + description: The ID of the DPA. type: string - format: int64 - description: Required. Id of the SAS organization to be migrated. - type: object - description: >- - Request for [MigrateOrganization]. - [spectrum.sas.portal.v1alpha1.Provisioning.MigrateOrganization]. GCP - Project, Organization Info, and caller's GAIA ID should be retrieved - from the RPC handler, and used to check authorization on SAS Portal - organization and to create GCP Projects. - SasPortalGcpProjectDeployment: - type: object - description: >- - Deployment associated with the GCP project. Includes whether SAS - analytics has been enabled or not. - properties: - deployment: - description: Deployment associated with the GCP project. - $ref: '#/components/schemas/SasPortalDeployment' - hasEnabledAnalytics: - type: boolean - description: Whether SAS analytics has been enabled. - id: SasPortalGcpProjectDeployment - SasPortalMoveDeviceRequest: + frequencyRange: + description: The frequency range that the move list affects. + $ref: '#/components/schemas/SasPortalFrequencyRange' + SasPortalDeviceMetadata: + id: SasPortalDeviceMetadata + description: Device data overridable by both SAS Portal and registration requests. type: object - id: SasPortalMoveDeviceRequest properties: - destination: - type: string + interferenceCoordinationGroup: description: >- - Required. The name of the new parent resource node or customer to - reparent the device under. - description: Request for MoveDevice. - SasPortalDevice: - properties: - activeConfig: + Interference Coordination Group (ICG). A group of CBSDs that manage + their own interference with the group. For more details, see + [CBRSA-TS-2001 + V3.0.0](https://ongoalliance.org/wp-content/uploads/2020/02/CBRSA-TS-2001-V3.0.0_Approved-for-publication.pdf). + type: string + commonChannelGroup: description: >- - Output only. Current configuration of the device as registered to - the SAS. - $ref: '#/components/schemas/SasPortalDeviceConfig' - fccId: + Common Channel Group (CCG). A group of CBSDs in the same ICG + requesting a common primary channel assignment. For more details, + see [CBRSA-TS-2001 + V3.0.0](https://ongoalliance.org/wp-content/uploads/2020/02/CBRSA-TS-2001-V3.0.0_Approved-for-publication.pdf). type: string + antennaModel: description: >- - The FCC identifier of the device. Refer to - https://www.fcc.gov/oet/ea/fccid for FccID format. Accept - underscores and periods because some test-SAS customers use them. - grantRangeAllowlists: + If populated, the Antenna Model Pattern to use. Format is: + `RecordCreatorId:PatternId` + type: string + nrqzValidated: description: >- - Only ranges that are within the allowlists are available for new - grants. - items: - $ref: '#/components/schemas/SasPortalFrequencyRange' - type: array - name: - description: Output only. The resource path name. + Output only. Set to `true` if a CPI has validated that they have + coordinated with the National Quiet Zone office. + readOnly: true + deprecated: true + type: boolean + nrqzValidation: + description: Output only. National Radio Quiet Zone validation info. + readOnly: true + $ref: '#/components/schemas/SasPortalNrqzValidation' + SasPortalNrqzValidation: + id: SasPortalNrqzValidation + description: Information about National Radio Quiet Zone validation. + type: object + properties: + caseId: + description: Validation case ID. + type: string + latitude: + description: Device latitude that's associated with the validation. + type: number + format: double + longitude: + description: Device longitude that's associated with the validation. + type: number + format: double + cpiId: + description: CPI who signed the validation. type: string state: + description: State of the NRQZ validation info. type: string - description: Output only. Device state. - enum: - - DEVICE_STATE_UNSPECIFIED - - RESERVED - - REGISTERED - - DEREGISTERED enumDescriptions: - Unspecified state. - - >- - Device created in the SAS Portal, however, not yet registered with - SAS. - - Device registered with SAS. - - Device de-registered with SAS. - preloadedConfig: - $ref: '#/components/schemas/SasPortalDeviceConfig' - description: Configuration of the device, as specified via SAS Portal API. - currentChannels: - type: array - readOnly: true - deprecated: true - description: Output only. Current channels with scores. - items: - $ref: '#/components/schemas/SasPortalChannelWithScore' - grants: + - Draft state. + - Final state. + enum: + - STATE_UNSPECIFIED + - DRAFT + - FINAL + SasPortalChannelWithScore: + id: SasPortalChannelWithScore + description: The channel with score. + type: object + properties: + frequencyRange: + description: The frequency range of the channel. + $ref: '#/components/schemas/SasPortalFrequencyRange' + score: + description: The channel score, normalized to be in the range [0,100]. + type: number + format: double + SasPortalCreateSignedDeviceRequest: + id: SasPortalCreateSignedDeviceRequest + description: Request for CreateSignedDevice. + type: object + properties: + encodedDevice: + description: >- + Required. JSON Web Token signed using a CPI private key. Payload + must be the JSON encoding of the device. The user_id field must be + set. + type: string + format: byte + installerId: + description: >- + Required. Unique installer id (CPI ID) from the Certified + Professional Installers database. + type: string + SasPortalEmpty: + id: SasPortalEmpty + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + type: object + properties: {} + SasPortalListDevicesResponse: + id: SasPortalListDevicesResponse + description: Response for ListDevices. + type: object + properties: + devices: + description: The devices that match the request. type: array items: - $ref: '#/components/schemas/SasPortalDeviceGrant' - description: Output only. Grants held by the device. - displayName: - type: string - description: Device display name. - deviceMetadata: - $ref: '#/components/schemas/SasPortalDeviceMetadata' + $ref: '#/components/schemas/SasPortalDevice' + nextPageToken: description: >- - Device parameters that can be overridden by both SAS Portal and SAS - registration requests. - serialNumber: - description: A serial number assigned to the device by the device manufacturer. + A pagination token returned from a previous call to ListDevices that + indicates from where listing should continue. If the field is + missing or empty, it means there is no more devices. type: string - id: SasPortalDevice + SasPortalMoveDeviceRequest: + id: SasPortalMoveDeviceRequest + description: Request for MoveDevice. type: object - SasPortalMoveNodeRequest: - description: Request for MoveNode. - id: SasPortalMoveNodeRequest properties: destination: - type: string description: >- Required. The name of the new parent resource node or customer to - reparent the node under. - type: object - SasPortalOperation: - description: >- - This resource represents a long-running operation that is the result of - a network API call. + reparent the device under. + type: string + SasPortalUpdateSignedDeviceRequest: + id: SasPortalUpdateSignedDeviceRequest + description: Request for UpdateSignedDevice. type: object - id: SasPortalOperation properties: - response: + encodedDevice: description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: object - name: + Required. The JSON Web Token signed using a CPI private key. Payload + must be the JSON encoding of the device. The user_id field must be + set. type: string + format: byte + installerId: description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. - metadata: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - error: - $ref: '#/components/schemas/SasPortalStatus' - description: >- - The error result of the operation in case of failure or - cancellation. - done: - description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - type: boolean - SasPortalProvisionDeploymentRequest: - description: >- - Request for [ProvisionDeployment]. - [spectrum.sas.portal.v1alpha1.Provisioning.ProvisionDeployment]. GCP - Project, Organization Info, and caller’s GAIA ID should be retrieved - from the RPC handler, and used as inputs to create a new SAS - organization (if not exists) and a new SAS deployment. + Required. Unique installer ID (CPI ID) from the Certified + Professional Installers database. + type: string + SasPortalSignDeviceRequest: + id: SasPortalSignDeviceRequest + description: Request for SignDevice. type: object - id: SasPortalProvisionDeploymentRequest properties: - newDeploymentDisplayName: - type: string - description: >- - Optional. If this field is set, and a new SAS Portal Deployment - needs to be created, its display name will be set to the value of - this field. - organizationId: - format: int64 + device: description: >- - Optional. If this field is set then a new deployment will be created - under the organization specified by this id. + Required. The device to sign. The device fields name, fcc_id and + serial_number must be set. The user_id field must be set. + $ref: '#/components/schemas/SasPortalDevice' + SasPortalNode: + id: SasPortalNode + description: The Node. + type: object + properties: + name: + description: Output only. Resource name. type: string - newOrganizationDisplayName: - description: >- - Optional. If this field is set, and a new SAS Portal Organization - needs to be created, its display name will be set to the value of - this field. + displayName: + description: The node's display name. type: string - SasPortalListLegacyOrganizationsResponse: + sasUserIds: + description: User ids used by the devices belonging to this node. + type: array + items: + type: string + SasPortalListNodesResponse: + id: SasPortalListNodesResponse + description: Response for ListNodes. type: object properties: - organizations: - description: Optional. Legacy SAS organizations. + nodes: + description: The nodes that match the request. type: array items: - $ref: '#/components/schemas/SasPortalOrganization' - description: >- - Response for [ListLegacyOrganizations]. - [spectrum.sas.portal.v1alpha1.Provisioning.ListLegacyOrganizations]. - id: SasPortalListLegacyOrganizationsResponse - SasPortalInstallationParams: - properties: - longitude: - type: number - description: >- - Longitude of the device antenna location in degrees relative to the - WGS 84 datum. The allowed range is from -180.000000 to +180.000000. - Positive values represent longitudes east of the prime meridian; - negative values west of the prime meridian. - format: double - antennaDowntilt: - description: >- - Antenna downtilt in degrees and is an integer with a value between - -90 and +90 inclusive; a negative value means the antenna is tilted - up (above horizontal). This parameter is optional for Category A - devices and conditional for Category B devices. - type: integer - format: int32 - horizontalAccuracy: - format: double - type: number - description: >- - A positive number in meters to indicate accuracy of the device - antenna horizontal location. This optional parameter should only be - present if its value is less than the FCC requirement of 50 meters. - height: - description: >- - Device antenna height in meters. When the `heightType` parameter - value is "AGL", the antenna height should be given relative to - ground level. When the `heightType` parameter value is "AMSL", it is - given with respect to WGS84 datum. - type: number - format: double - antennaAzimuth: - description: >- - Boresight direction of the horizontal plane of the antenna in - degrees with respect to true north. The value of this parameter is - an integer with a value between 0 and 359 inclusive. A value of 0 - degrees means true north; a value of 90 degrees means east. This - parameter is optional for Category A devices and conditional for - Category B devices. - format: int32 - type: integer - latitude: - description: >- - Latitude of the device antenna location in degrees relative to the - WGS 84 datum. The allowed range is from -90.000000 to +90.000000. - Positive values represent latitudes north of the equator; negative - values south of the equator. - type: number - format: double - eirpCapability: - description: >- - This parameter is the maximum device EIRP in units of dBm/10MHz and - is an integer with a value between -127 and +47 (dBm/10 MHz) - inclusive. If not included, SAS interprets it as maximum allowable - EIRP in units of dBm/10MHz for device category. - type: integer - format: int32 - verticalAccuracy: - description: >- - A positive number in meters to indicate accuracy of the device - antenna vertical location. This optional parameter should only be - present if its value is less than the FCC requirement of 3 meters. - type: number - format: double - indoorDeployment: - type: boolean + $ref: '#/components/schemas/SasPortalNode' + nextPageToken: description: >- - Whether the device antenna is indoor or not. `true`: indoor. - `false`: outdoor. - antennaBeamwidth: - format: int32 - type: integer + A pagination token returned from a previous call to ListNodes that + indicates from where listing should continue. If the field is + missing or empty, it means there is no more nodes. + type: string + SasPortalMoveNodeRequest: + id: SasPortalMoveNodeRequest + description: Request for MoveNode. + type: object + properties: + destination: description: >- - 3-dB antenna beamwidth of the antenna in the horizontal-plane in - degrees. This parameter is an unsigned integer having a value - between 0 and 360 (degrees) inclusive; it is optional for Category A - devices and conditional for Category B devices. - antennaModel: + Required. The name of the new parent resource node or customer to + reparent the node under. + type: string + SasPortalGenerateSecretRequest: + id: SasPortalGenerateSecretRequest + description: Request for GenerateSecret. + type: object + properties: {} + SasPortalGenerateSecretResponse: + id: SasPortalGenerateSecretResponse + description: Response for GenerateSecret. + type: object + properties: + secret: + description: The secret generated by the string and used by ValidateInstaller. + type: string + SasPortalValidateInstallerRequest: + id: SasPortalValidateInstallerRequest + description: Request for ValidateInstaller. + type: object + properties: + installerId: description: >- - If an external antenna is used, the antenna model is optionally - provided in this field. The string has a maximum length of 128 - octets. + Required. Unique installer id (CPI ID) from the Certified + Professional Installers database. type: string - cpeCbsdIndication: - type: boolean - description: >- - If present, this parameter specifies whether the CBSD is a CPE-CBSD - or not. - heightType: + secret: + description: Required. Secret returned by the GenerateSecret. type: string - description: Specifies how the height is measured. - enum: - - HEIGHT_TYPE_UNSPECIFIED - - HEIGHT_TYPE_AGL - - HEIGHT_TYPE_AMSL - enumDescriptions: - - Unspecified height type. - - AGL height is measured relative to the ground level. - - AMSL height is measured relative to the mean sea level. - antennaGain: - format: double + encodedSecret: description: >- - Peak antenna gain in dBi. This parameter is a double with a value - between -127 and +128 (dBi) inclusive. Part of Release 2 to support - floating-point value - type: number + Required. JSON Web Token signed using a CPI private key. Payload + must include a "secret" claim whose value is the secret. + type: string + SasPortalValidateInstallerResponse: + id: SasPortalValidateInstallerResponse + description: Response for ValidateInstaller. + type: object + properties: {} + SasPortalListDeploymentsResponse: + id: SasPortalListDeploymentsResponse + description: Response for ListDeployments. type: object - id: SasPortalInstallationParams - description: Information about the device installation parameters. - SasPortalDpaMoveList: - description: An entry in a DPA's move list. properties: - dpaId: - description: The ID of the DPA. + deployments: + description: The deployments that match the request. + type: array + items: + $ref: '#/components/schemas/SasPortalDeployment' + nextPageToken: + description: >- + A pagination token returned from a previous call to ListDeployments + that indicates from where listing should continue. If the field is + missing or empty, it means there are no more deployments. type: string - frequencyRange: - $ref: '#/components/schemas/SasPortalFrequencyRange' - description: The frequency range that the move list affects. - id: SasPortalDpaMoveList + SasPortalMoveDeploymentRequest: + id: SasPortalMoveDeploymentRequest + description: Request for MoveDeployment. type: object - SasPortalUpdateSignedDeviceRequest: properties: - encodedDevice: - format: byte + destination: description: >- - Required. The JSON Web Token signed using a CPI private key. Payload - must be the JSON encoding of the device. The user_id field must be - set. + Required. The name of the new parent resource node or customer to + reparent the deployment under. type: string - installerId: + SasPortalSetPolicyRequest: + id: SasPortalSetPolicyRequest + description: Request message for `SetPolicy` method. + type: object + properties: + resource: + description: >- + Required. The resource for which the policy is being specified. This + policy replaces any existing policy. type: string + policy: + description: Required. The policy to be applied to the `resource`. + $ref: '#/components/schemas/SasPortalPolicy' + disableNotification: description: >- - Required. Unique installer ID (CPI ID) from the Certified - Professional Installers database. - id: SasPortalUpdateSignedDeviceRequest + Optional. Set the field as `true` to disable the onboarding + notification. + type: boolean + SasPortalPolicy: + id: SasPortalPolicy + description: Defines an access control policy to the resources. type: object - description: Request for UpdateSignedDevice. - SasPortalListNodesResponse: + properties: + assignments: + description: List of assignments + type: array + items: + $ref: '#/components/schemas/SasPortalAssignment' + etag: + description: >- + The 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 + GetPolicy, and systems are expected to put that etag in the request + to SetPolicy to ensure that their change will be applied to the same + version of the policy. If no etag is provided in the call to + GetPolicy, then the existing policy is overwritten blindly. + type: string + format: byte + SasPortalAssignment: + id: SasPortalAssignment + description: Associates `members` with a `role`. type: object - description: Response for ListNodes. - id: SasPortalListNodesResponse properties: - nextPageToken: + role: + description: Required. Role that is assigned to `members`. type: string + members: description: >- - A pagination token returned from a previous call to ListNodes that - indicates from where listing should continue. If the field is - missing or empty, it means there is no more nodes. - nodes: - description: The nodes that match the request. + The identities the role is assigned to. It can have the following + values: * `{user_email}`: An email address that represents a + specific Google account. For example: `alice@gmail.com`. * + `{group_email}`: An email address that represents a Google group. + For example, `viewers@gmail.com`. type: array items: - $ref: '#/components/schemas/SasPortalNode' - SasPortalNrqzValidation: + type: string + SasPortalGetPolicyRequest: + id: SasPortalGetPolicyRequest + description: Request message for `GetPolicy` method. type: object - description: Information about National Radio Quiet Zone validation. properties: - caseId: - description: Validation case ID. - type: string - longitude: - format: double - description: Device longitude that's associated with the validation. - type: number - cpiId: - type: string - description: CPI who signed the validation. - state: - enumDescriptions: - - Unspecified state. - - Draft state. - - Final state. - description: State of the NRQZ validation info. + resource: + description: Required. The resource for which the policy is being requested. type: string - enum: - - STATE_UNSPECIFIED - - DRAFT - - FINAL - latitude: - format: double - type: number - description: Device latitude that's associated with the validation. - id: SasPortalNrqzValidation - SasPortalMoveDeploymentRequest: + SasPortalTestPermissionsRequest: + id: SasPortalTestPermissionsRequest + description: Request message for `TestPermissions` method. type: object - description: Request for MoveDeployment. - id: SasPortalMoveDeploymentRequest properties: - destination: + resource: description: >- - Required. The name of the new parent resource node or customer to - reparent the deployment under. + Required. The resource for which the permissions are being + requested. type: string - SasPortalListDeploymentsResponse: + permissions: + description: The set of permissions to check for the `resource`. + type: array + items: + type: string + SasPortalTestPermissionsResponse: + id: SasPortalTestPermissionsResponse + description: Response message for `TestPermissions` method. + type: object properties: - nextPageToken: - type: string - description: >- - A pagination token returned from a previous call to ListDeployments - that indicates from where listing should continue. If the field is - missing or empty, it means there are no more deployments. - deployments: - description: The deployments that match the request. + permissions: + description: A set of permissions that the caller is allowed. type: array items: - $ref: '#/components/schemas/SasPortalDeployment' + type: string + SasPortalMigrateOrganizationMetadata: + id: SasPortalMigrateOrganizationMetadata + description: >- + Long-running operation metadata message returned by the + MigrateOrganization. type: object - id: SasPortalListDeploymentsResponse - description: Response for ListDeployments. - SasPortalListCustomersResponse: - description: Response for `ListCustomers`. - id: SasPortalListCustomersResponse + properties: + operationState: + description: Output only. Current operation state + readOnly: true + type: string + enumDescriptions: + - Unspecified. + - Pending (Not started). + - In-progress. + - Done successfully. + - Done with errors. + enum: + - OPERATION_STATE_UNSPECIFIED + - OPERATION_STATE_PENDING + - OPERATION_STATE_RUNNING + - OPERATION_STATE_SUCCEEDED + - OPERATION_STATE_FAILED + SasPortalMigrateOrganizationResponse: + id: SasPortalMigrateOrganizationResponse + description: >- + Response for [MigrateOrganization]. + [spectrum.sas.portal.v1alpha1.Provisioning.MigrateOrganization]. type: object properties: - nextPageToken: + deploymentAssociation: description: >- - A pagination token returned from a previous call to ListCustomers - that indicates from where listing should continue. If the field is - missing or empty, it means there are no more customers. + Optional. A list of deployment association that were created for the + migration, or current associations if they already exist. + type: array + items: + $ref: '#/components/schemas/SasPortalDeploymentAssociation' + SasPortalDeploymentAssociation: + id: SasPortalDeploymentAssociation + description: Association between a gcp project and a SAS user id. + type: object + properties: + userId: + description: User id of the deployment. + type: string + gcpProjectId: + description: GCP project id of the associated project. type: string - customers: - items: - $ref: '#/components/schemas/SasPortalCustomer' - description: The list of customers that match the request. - type: array + SasPortalSetupSasAnalyticsMetadata: + id: SasPortalSetupSasAnalyticsMetadata + description: >- + Metadata returned by the long running operation for the + SetupSasAnalytics rpc. + type: object + properties: {} + SasPortalSetupSasAnalyticsResponse: + id: SasPortalSetupSasAnalyticsResponse + description: >- + Response returned by the long running operation for the + SetupSasAnalytics rpc. + type: object + properties: {} parameters: - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + access_token: + description: OAuth access token. in: query - name: upload_protocol + name: access_token schema: type: string alt: @@ -1111,27 +1111,18 @@ components: - json - media - proto - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean - oauth_token: - description: OAuth 2.0 token for the current user. + callback: + description: JSONP in: query - name: oauth_token + name: callback schema: type: string - _.xgafv: - description: V1 error format. + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: $.xgafv + name: fields schema: type: string - enum: - - '1' - - '2' key: description: >- API key. Your API key identifies your project and provides you with API @@ -1141,303 +1132,136 @@ components: name: key schema: type: string - fields: - description: Selector specifying which fields to include in a partial response. + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: fields + name: oauth_token schema: type: string - access_token: - description: OAuth access token. + prettyPrint: + description: Returns response with indentations and line breaks. in: query - name: access_token + name: prettyPrint schema: - type: string + 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 - callback: - description: JSONP - in: query - name: callback - schema: - type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string - x-stackQL-resources: - installer: - id: google.sasportal.installer - name: installer - title: Installer - methods: - installer_validate: - operation: - $ref: '#/paths/~1v1alpha1~1installer:validate/post' - response: - mediaType: application/json - openAPIDocKey: '200' - installer_generate_secret: - operation: - $ref: '#/paths/~1v1alpha1~1installer:generateSecret/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: [] - deployments: - id: google.sasportal.deployments - name: deployments - title: Deployments - methods: - deployments_get: - operation: - $ref: '#/paths/~1v1alpha1~1deployments~1{deploymentsId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - customers_nodes_deployments_create: - operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1deployments/post - response: - mediaType: application/json - openAPIDocKey: '200' - customers_nodes_deployments_list: - operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1deployments/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.deployments - customers_deployments_patch: - operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - customers_deployments_get: - operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - customers_deployments_delete: - operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - customers_deployments_move: - operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}:move/post - response: - mediaType: application/json - openAPIDocKey: '200' - customers_deployments_list: - operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1deployments/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.deployments - customers_deployments_create: - operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1deployments/post' - response: - mediaType: application/json - openAPIDocKey: '200' - nodes_nodes_deployments_create: - operation: - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1deployments/post - response: - mediaType: application/json - openAPIDocKey: '200' - nodes_nodes_deployments_list: - operation: - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1deployments/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.deployments - nodes_deployments_delete: - operation: - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - nodes_deployments_get: - operation: - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - nodes_deployments_patch: - operation: - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - nodes_deployments_move: - operation: - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}:move/post - response: - mediaType: application/json - openAPIDocKey: '200' - nodes_deployments_list: - operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.deployments - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/customers_nodes_deployments_list - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/customers_deployments_get - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/nodes_nodes_deployments_list - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/nodes_deployments_get - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/deployments_get - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/customers_deployments_list - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/nodes_deployments_list - insert: - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/customers_nodes_deployments_create - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/nodes_nodes_deployments_create - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/customers_deployments_create - update: - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/customers_deployments_patch - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/nodes_deployments_patch - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/customers_deployments_delete - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/nodes_deployments_delete - devices_signed: - id: google.sasportal.devices_signed - name: devices_signed - title: Devices_signed + in: query + name: quotaUser + schema: + type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + x-stackQL-resources: + customers: + id: google.sasportal.customers + name: customers + title: Customers methods: - deployments_devices_update_signed: - operation: - $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:updateSigned/patch - response: - mediaType: application/json - openAPIDocKey: '200' - customers_devices_create_signed: + customers_get: operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices:createSigned/post + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}/get' response: mediaType: application/json openAPIDocKey: '200' - customers_devices_update_signed: + customers_patch: operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}:updateSigned/patch + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}/patch' response: mediaType: application/json openAPIDocKey: '200' - customers_nodes_devices_create_signed: + customers_list: operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices:createSigned/post + $ref: '#/paths/~1v1alpha1~1customers/get' response: mediaType: application/json openAPIDocKey: '200' - customers_deployments_devices_create_signed: + objectKey: $.customers + customers_provision_deployment: operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices:createSigned/post + $ref: '#/paths/~1v1alpha1~1customers:provisionDeployment/post' response: mediaType: application/json openAPIDocKey: '200' - nodes_nodes_devices_create_signed: + customers_migrate_organization: operation: - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices:createSigned/post + $ref: '#/paths/~1v1alpha1~1customers:migrateOrganization/post' response: mediaType: application/json openAPIDocKey: '200' - nodes_devices_create_signed: + customers_setup_sas_analytics: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices:createSigned/post' + $ref: '#/paths/~1v1alpha1~1customers:setupSasAnalytics/post' response: mediaType: application/json openAPIDocKey: '200' - nodes_devices_update_signed: + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/customers/methods/customers_get' + - $ref: '#/components/x-stackQL-resources/customers/methods/customers_list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/customers/methods/customers_patch' + replace: [] + delete: [] + customers_gcp_project_deployments: + id: google.sasportal.customers_gcp_project_deployments + name: customers_gcp_project_deployments + title: Customers_gcp_project_deployments + methods: + customers_list_gcp_project_deployments: operation: - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}:updateSigned/patch + $ref: '#/paths/~1v1alpha1~1customers:listGcpProjectDeployments/get' response: mediaType: application/json openAPIDocKey: '200' - nodes_deployments_devices_create_signed: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/customers_gcp_project_deployments/methods/customers_list_gcp_project_deployments + insert: [] + update: [] + replace: [] + delete: [] + customers_legacy_organizations: + id: google.sasportal.customers_legacy_organizations + name: customers_legacy_organizations + title: Customers_legacy_organizations + methods: + customers_list_legacy_organizations: operation: - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}~1devices:createSigned/post + $ref: '#/paths/~1v1alpha1~1customers:listLegacyOrganizations/get' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] - insert: - - $ref: >- - #/components/x-stackQL-resources/devices_signed/methods/customers_nodes_devices_create_signed - - $ref: >- - #/components/x-stackQL-resources/devices_signed/methods/customers_deployments_devices_create_signed - - $ref: >- - #/components/x-stackQL-resources/devices_signed/methods/nodes_nodes_devices_create_signed - - $ref: >- - #/components/x-stackQL-resources/devices_signed/methods/nodes_deployments_devices_create_signed - - $ref: >- - #/components/x-stackQL-resources/devices_signed/methods/customers_devices_create_signed - - $ref: >- - #/components/x-stackQL-resources/devices_signed/methods/nodes_devices_create_signed - update: - - $ref: >- - #/components/x-stackQL-resources/devices_signed/methods/deployments_devices_update_signed - - $ref: >- - #/components/x-stackQL-resources/devices_signed/methods/customers_devices_update_signed + select: - $ref: >- - #/components/x-stackQL-resources/devices_signed/methods/nodes_devices_update_signed + #/components/x-stackQL-resources/customers_legacy_organizations/methods/customers_list_legacy_organizations + insert: [] + update: [] replace: [] delete: [] devices: @@ -1445,38 +1269,9 @@ components: name: devices title: Devices methods: - deployments_devices_move: - operation: - $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:move/post - response: - mediaType: application/json - openAPIDocKey: '200' - deployments_devices_get: - operation: - $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - deployments_devices_delete: - operation: - $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - deployments_devices_patch: - operation: - $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - deployments_devices_sign_device: + customers_devices_create: operation: - $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:signDevice/post + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1devices/post' response: mediaType: application/json openAPIDocKey: '200' @@ -1487,12 +1282,6 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.devices - customers_devices_create: - operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1devices/post' - response: - mediaType: application/json - openAPIDocKey: '200' customers_devices_delete: operation: $ref: >- @@ -1500,17 +1289,17 @@ components: response: mediaType: application/json openAPIDocKey: '200' - customers_devices_patch: + customers_devices_get: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}/patch + #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}/get response: mediaType: application/json openAPIDocKey: '200' - customers_devices_get: + customers_devices_patch: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}/get + #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}/patch response: mediaType: application/json openAPIDocKey: '200' @@ -1543,40 +1332,37 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.devices - customers_deployments_devices_list: + customers_deployments_devices_create: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices/get + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.devices - customers_deployments_devices_create: + customers_deployments_devices_list: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices/post + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices/get response: mediaType: application/json openAPIDocKey: '200' - nodes_nodes_devices_create: + objectKey: $.devices + nodes_devices_create: operation: - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices/post + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices/post' response: mediaType: application/json openAPIDocKey: '200' - nodes_nodes_devices_list: + nodes_devices_list: operation: - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices/get + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.devices - nodes_devices_move: + nodes_devices_delete: operation: - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}:move/post + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}/delete' response: mediaType: application/json openAPIDocKey: '200' @@ -1586,15 +1372,16 @@ components: response: mediaType: application/json openAPIDocKey: '200' - nodes_devices_delete: + nodes_devices_patch: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}/delete' + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}/patch' response: mediaType: application/json openAPIDocKey: '200' - nodes_devices_patch: + nodes_devices_move: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}/patch' + $ref: >- + #/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}:move/post response: mediaType: application/json openAPIDocKey: '200' @@ -1605,15 +1392,17 @@ components: response: mediaType: application/json openAPIDocKey: '200' - nodes_devices_create: + nodes_nodes_devices_create: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices/post' + $ref: >- + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices/post response: mediaType: application/json openAPIDocKey: '200' - nodes_devices_list: + nodes_nodes_devices_list: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices/get' + $ref: >- + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices/get response: mediaType: application/json openAPIDocKey: '200' @@ -1633,21 +1422,56 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.devices + deployments_devices_delete: + operation: + $ref: >- + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + deployments_devices_get: + operation: + $ref: >- + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + deployments_devices_patch: + operation: + $ref: >- + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + deployments_devices_move: + operation: + $ref: >- + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:move/post + response: + mediaType: application/json + openAPIDocKey: '200' + deployments_devices_sign_device: + operation: + $ref: >- + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:signDevice/post + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/devices/methods/deployments_devices_get - $ref: >- #/components/x-stackQL-resources/devices/methods/customers_devices_get - $ref: >- #/components/x-stackQL-resources/devices/methods/customers_nodes_devices_list - $ref: >- #/components/x-stackQL-resources/devices/methods/customers_deployments_devices_list + - $ref: '#/components/x-stackQL-resources/devices/methods/nodes_devices_get' - $ref: >- #/components/x-stackQL-resources/devices/methods/nodes_nodes_devices_list - - $ref: '#/components/x-stackQL-resources/devices/methods/nodes_devices_get' - $ref: >- #/components/x-stackQL-resources/devices/methods/nodes_deployments_devices_list + - $ref: >- + #/components/x-stackQL-resources/devices/methods/deployments_devices_get - $ref: >- #/components/x-stackQL-resources/devices/methods/customers_devices_list - $ref: >- @@ -1666,48 +1490,109 @@ components: - $ref: >- #/components/x-stackQL-resources/devices/methods/nodes_devices_create update: - - $ref: >- - #/components/x-stackQL-resources/devices/methods/deployments_devices_patch - $ref: >- #/components/x-stackQL-resources/devices/methods/customers_devices_patch - $ref: >- #/components/x-stackQL-resources/devices/methods/nodes_devices_patch + - $ref: >- + #/components/x-stackQL-resources/devices/methods/deployments_devices_patch replace: [] delete: - - $ref: >- - #/components/x-stackQL-resources/devices/methods/deployments_devices_delete - $ref: >- #/components/x-stackQL-resources/devices/methods/customers_devices_delete - $ref: >- #/components/x-stackQL-resources/devices/methods/nodes_devices_delete - policies: - id: google.sasportal.policies - name: policies - title: Policies + - $ref: >- + #/components/x-stackQL-resources/devices/methods/deployments_devices_delete + devices_signed: + id: google.sasportal.devices_signed + name: devices_signed + title: Devices_signed methods: - policies_set: + customers_devices_create_signed: operation: - $ref: '#/paths/~1v1alpha1~1policies:set/post' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1devices:createSigned/post response: mediaType: application/json openAPIDocKey: '200' - policies_get: + customers_devices_update_signed: operation: - $ref: '#/paths/~1v1alpha1~1policies:get/post' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}:updateSigned/patch response: mediaType: application/json openAPIDocKey: '200' - policies_test: + customers_nodes_devices_create_signed: operation: - $ref: '#/paths/~1v1alpha1~1policies:test/post' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices:createSigned/post + response: + mediaType: application/json + openAPIDocKey: '200' + customers_deployments_devices_create_signed: + operation: + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices:createSigned/post + response: + mediaType: application/json + openAPIDocKey: '200' + nodes_devices_create_signed: + operation: + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices:createSigned/post' + response: + mediaType: application/json + openAPIDocKey: '200' + nodes_devices_update_signed: + operation: + $ref: >- + #/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}:updateSigned/patch + response: + mediaType: application/json + openAPIDocKey: '200' + nodes_nodes_devices_create_signed: + operation: + $ref: >- + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices:createSigned/post + response: + mediaType: application/json + openAPIDocKey: '200' + nodes_deployments_devices_create_signed: + operation: + $ref: >- + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}~1devices:createSigned/post + response: + mediaType: application/json + openAPIDocKey: '200' + deployments_devices_update_signed: + operation: + $ref: >- + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:updateSigned/patch response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/policies/methods/policies_get' - insert: [] - update: [] + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/devices_signed/methods/customers_nodes_devices_create_signed + - $ref: >- + #/components/x-stackQL-resources/devices_signed/methods/customers_deployments_devices_create_signed + - $ref: >- + #/components/x-stackQL-resources/devices_signed/methods/nodes_nodes_devices_create_signed + - $ref: >- + #/components/x-stackQL-resources/devices_signed/methods/nodes_deployments_devices_create_signed + - $ref: >- + #/components/x-stackQL-resources/devices_signed/methods/customers_devices_create_signed + - $ref: >- + #/components/x-stackQL-resources/devices_signed/methods/nodes_devices_create_signed + update: + - $ref: >- + #/components/x-stackQL-resources/devices_signed/methods/customers_devices_update_signed + - $ref: >- + #/components/x-stackQL-resources/devices_signed/methods/nodes_devices_update_signed + - $ref: >- + #/components/x-stackQL-resources/devices_signed/methods/deployments_devices_update_signed replace: [] delete: [] customer_nodes: @@ -1715,41 +1600,41 @@ components: name: customer_nodes title: Customer_nodes methods: - customers_nodes_nodes_create: + customers_nodes_create: operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1nodes/post + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1nodes/post' response: mediaType: application/json openAPIDocKey: '200' - customers_nodes_nodes_list: + customers_nodes_list: operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1nodes/get + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1nodes/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.nodes - customers_nodes_list: + customers_nodes_delete: operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1nodes/get' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}/delete response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.nodes - customers_nodes_create: + customers_nodes_nodes_create: operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1nodes/post' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1nodes/post response: mediaType: application/json openAPIDocKey: '200' - customers_nodes_delete: + customers_nodes_nodes_list: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}/delete + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1nodes/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.nodes sqlVerbs: select: - $ref: >- @@ -1804,20 +1689,19 @@ components: response: mediaType: application/json openAPIDocKey: '200' - nodes_nodes_nodes_list: + nodes_nodes_create: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1nodes/get' + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes/post' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.nodes - nodes_nodes_nodes_create: + nodes_nodes_list: operation: - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1nodes/post + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes/get' response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.nodes nodes_nodes_delete: operation: $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}/delete' @@ -1836,15 +1720,16 @@ components: response: mediaType: application/json openAPIDocKey: '200' - nodes_nodes_create: + nodes_nodes_nodes_create: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes/post' + $ref: >- + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1nodes/post response: mediaType: application/json openAPIDocKey: '200' - nodes_nodes_list: + nodes_nodes_nodes_list: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes/get' + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1nodes/get' response: mediaType: application/json openAPIDocKey: '200' @@ -1865,142 +1750,252 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/nodes/methods/nodes_nodes_delete' - customers_legacy_organizations: - id: google.sasportal.customers_legacy_organizations - name: customers_legacy_organizations - title: Customers_legacy_organizations + deployments: + id: google.sasportal.deployments + name: deployments + title: Deployments methods: - customers_list_legacy_organizations: + customers_nodes_deployments_create: operation: - $ref: '#/paths/~1v1alpha1~1customers:listLegacyOrganizations/get' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1deployments/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/customers_legacy_organizations/methods/customers_list_legacy_organizations - insert: [] - update: [] - replace: [] - delete: [] - customers: - id: google.sasportal.customers - name: customers - title: Customers - methods: - customers_provision_deployment: + customers_nodes_deployments_list: operation: - $ref: '#/paths/~1v1alpha1~1customers:provisionDeployment/post' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1deployments/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.deployments + customers_deployments_create: + operation: + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1deployments/post' + response: + mediaType: application/json + openAPIDocKey: '200' + customers_deployments_list: + operation: + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1deployments/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.deployments + customers_deployments_delete: + operation: + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + customers_deployments_get: + operation: + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + customers_deployments_patch: + operation: + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + customers_deployments_move: + operation: + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}:move/post + response: + mediaType: application/json + openAPIDocKey: '200' + nodes_nodes_deployments_create: + operation: + $ref: >- + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1deployments/post + response: + mediaType: application/json + openAPIDocKey: '200' + nodes_nodes_deployments_list: + operation: + $ref: >- + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1deployments/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.deployments + nodes_deployments_delete: + operation: + $ref: >- + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + nodes_deployments_get: + operation: + $ref: >- + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + nodes_deployments_patch: + operation: + $ref: >- + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}/patch response: mediaType: application/json openAPIDocKey: '200' - customers_patch: + nodes_deployments_list: operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}/patch' + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments/get' response: mediaType: application/json openAPIDocKey: '200' - customers_get: + objectKey: $.deployments + nodes_deployments_move: operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}/get' + $ref: >- + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}:move/post response: mediaType: application/json openAPIDocKey: '200' - customers_setup_sas_analytics: + deployments_get: operation: - $ref: '#/paths/~1v1alpha1~1customers:setupSasAnalytics/post' + $ref: '#/paths/~1v1alpha1~1deployments~1{deploymentsId}/get' response: mediaType: application/json openAPIDocKey: '200' - customers_list: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/customers_nodes_deployments_list + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/customers_deployments_get + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/nodes_nodes_deployments_list + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/nodes_deployments_get + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/customers_deployments_list + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/nodes_deployments_list + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/deployments_get + insert: + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/customers_nodes_deployments_create + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/nodes_nodes_deployments_create + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/customers_deployments_create + update: + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/customers_deployments_patch + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/nodes_deployments_patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/customers_deployments_delete + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/nodes_deployments_delete + node: + id: google.sasportal.node + name: node + title: Node + methods: + nodes_get: operation: - $ref: '#/paths/~1v1alpha1~1customers/get' + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}/get' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.customers - customers_migrate_organization: + nodes_nodes_get: operation: - $ref: '#/paths/~1v1alpha1~1customers:migrateOrganization/post' + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}/get' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/customers/methods/customers_get' - - $ref: '#/components/x-stackQL-resources/customers/methods/customers_list' + - $ref: '#/components/x-stackQL-resources/node/methods/nodes_nodes_get' + - $ref: '#/components/x-stackQL-resources/node/methods/nodes_get' insert: [] - update: - - $ref: '#/components/x-stackQL-resources/customers/methods/customers_patch' + update: [] replace: [] delete: [] - customers_gcp_project_deployments: - id: google.sasportal.customers_gcp_project_deployments - name: customers_gcp_project_deployments - title: Customers_gcp_project_deployments + installer: + id: google.sasportal.installer + name: installer + title: Installer methods: - customers_list_gcp_project_deployments: + installer_generate_secret: operation: - $ref: '#/paths/~1v1alpha1~1customers:listGcpProjectDeployments/get' + $ref: '#/paths/~1v1alpha1~1installer:generateSecret/post' + response: + mediaType: application/json + openAPIDocKey: '200' + installer_validate: + operation: + $ref: '#/paths/~1v1alpha1~1installer:validate/post' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/customers_gcp_project_deployments/methods/customers_list_gcp_project_deployments + select: [] insert: [] update: [] replace: [] delete: [] - node: - id: google.sasportal.node - name: node - title: Node + policies: + id: google.sasportal.policies + name: policies + title: Policies methods: - nodes_nodes_get: + policies_set: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}/get' + $ref: '#/paths/~1v1alpha1~1policies:set/post' response: mediaType: application/json openAPIDocKey: '200' - nodes_get: + policies_get: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}/get' + $ref: '#/paths/~1v1alpha1~1policies:get/post' + response: + mediaType: application/json + openAPIDocKey: '200' + policies_test: + operation: + $ref: '#/paths/~1v1alpha1~1policies:test/post' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/node/methods/nodes_nodes_get' - - $ref: '#/components/x-stackQL-resources/node/methods/nodes_get' + - $ref: '#/components/x-stackQL-resources/policies/methods/policies_get' insert: [] update: [] replace: [] delete: [] paths: - /v1alpha1/installer:validate: + /v1alpha1/customers/{customersId}: parameters: &ref_1 - - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' - post: - description: Validates the identity of a Certified Professional Installer (CPI). - operationId: sasportal.installer.validate - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalValidateInstallerRequest' + - $ref: '#/components/parameters/_.xgafv' + get: + description: Returns a requested customer. + operationId: sasportal.customers.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2016,18 +2011,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalValidateInstallerResponse' - parameters: [] - /v1alpha1/installer:generateSecret: - parameters: *ref_1 - post: - description: Generates a secret to be used with the ValidateInstaller. - operationId: sasportal.installer.generateSecret + $ref: '#/components/schemas/SasPortalCustomer' + parameters: + - in: path + name: customersId + required: true + schema: + type: string + patch: + description: Updates an existing customer. + operationId: sasportal.customers.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalGenerateSecretRequest' + $ref: '#/components/schemas/SasPortalCustomer' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2043,13 +2041,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalGenerateSecretResponse' - parameters: [] - /v1alpha1/deployments/{deploymentsId}: + $ref: '#/components/schemas/SasPortalCustomer' + parameters: + - in: path + name: customersId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1alpha1/customers: parameters: *ref_1 get: - description: Returns a requested deployment. - operationId: sasportal.deployments.get + description: Returns a list of requested customers. + operationId: sasportal.customers.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2065,23 +2073,24 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalListCustomersResponse' parameters: - - in: path - name: deploymentsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:updateSigned: + /v1alpha1/customers:listGcpProjectDeployments: parameters: *ref_1 - patch: - description: Updates a signed device. - operationId: sasportal.deployments.devices.updateSigned - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalUpdateSignedDeviceRequest' + get: + description: >- + Returns a list of SAS deployments associated with current GCP project. + Includes whether SAS analytics has been enabled or not. + operationId: sasportal.customers.listGcpProjectDeployments security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2097,60 +2106,43 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' - parameters: - - in: path - name: deploymentsId - required: true - schema: - type: string - - in: path - name: devicesId - required: true - schema: - type: string - /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:move: + $ref: >- + #/components/schemas/SasPortalListGcpProjectDeploymentsResponse + parameters: [] + /v1alpha1/customers:provisionDeployment: parameters: *ref_1 post: - description: Moves a device under another node or customer. - operationId: sasportal.deployments.devices.move + description: >- + Creates a new SAS deployment through the GCP workflow. Creates a SAS + organization if an organization match is not found. + operationId: sasportal.customers.provisionDeployment requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalMoveDeviceRequest' + $ref: '#/components/schemas/SasPortalProvisionDeploymentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - - https://www.googleapis.com/auth/sasportal - Oauth2c: - - https://www.googleapis.com/auth/sasportal - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalOperation' - parameters: - - in: path - name: deploymentsId - required: true - schema: - type: string - - in: path - name: devicesId - required: true - schema: - type: string - /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}: + - https://www.googleapis.com/auth/sasportal + Oauth2c: + - https://www.googleapis.com/auth/sasportal + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalProvisionDeploymentResponse' + parameters: [] + /v1alpha1/customers:listLegacyOrganizations: parameters: *ref_1 get: - description: Gets details about a device. - operationId: sasportal.deployments.devices.get + description: Returns a list of legacy organizations. + operationId: sasportal.customers.listLegacyOrganizations security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2166,21 +2158,22 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' - parameters: - - in: path - name: deploymentsId - required: true - schema: - type: string - - in: path - name: devicesId - required: true - schema: - type: string - delete: - description: Deletes a device. - operationId: sasportal.deployments.devices.delete + $ref: '#/components/schemas/SasPortalListLegacyOrganizationsResponse' + parameters: [] + /v1alpha1/customers:migrateOrganization: + parameters: *ref_1 + post: + description: >- + Migrates a SAS organization to the cloud. This will create GCP projects + for each deployment and associate them. The SAS Organization is linked + to the gcp project that called the command. + go/sas-legacy-customer-migration + operationId: sasportal.customers.migrateOrganization + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalMigrateOrganizationRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2196,26 +2189,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' - parameters: - - in: path - name: deploymentsId - required: true - schema: - type: string - - in: path - name: devicesId - required: true - schema: - type: string - patch: - description: Updates a device. - operationId: sasportal.deployments.devices.patch + $ref: '#/components/schemas/SasPortalOperation' + parameters: [] + /v1alpha1/customers:setupSasAnalytics: + parameters: *ref_1 + post: + description: >- + Setups the a GCP Project to receive SAS Analytics messages via GCP + Pub/Sub with a subscription to BigQuery. All the Pub/Sub topics and + BigQuery tables are created automatically as part of this service. + operationId: sasportal.customers.setupSasAnalytics requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalSetupSasAnalyticsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2231,33 +2219,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' - parameters: - - in: path - name: deploymentsId - required: true - schema: - type: string - - in: path - name: devicesId - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:signDevice: + $ref: '#/components/schemas/SasPortalOperation' + parameters: [] + /v1alpha1/customers/{customersId}/devices: parameters: *ref_1 post: - description: Signs a device. - operationId: sasportal.deployments.devices.signDevice + description: Creates a device under a node or customer. + operationId: sasportal.customers.devices.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalSignDeviceRequest' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2273,30 +2246,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: deploymentsId - required: true - schema: - type: string - - in: path - name: devicesId + name: customersId required: true schema: type: string - /v1alpha1/policies:set: - parameters: *ref_1 - post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. - operationId: sasportal.policies.set - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalSetPolicyRequest' + get: + description: Lists devices under a node or customer. + operationId: sasportal.customers.devices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2312,20 +2271,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalPolicy' - parameters: [] - /v1alpha1/policies:get: + $ref: '#/components/schemas/SasPortalListDevicesResponse' + parameters: + - in: path + name: customersId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1alpha1/customers/{customersId}/devices:createSigned: parameters: *ref_1 post: - description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: sasportal.policies.get + description: Creates a signed device under a node or customer. + operationId: sasportal.customers.devices.createSigned requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalGetPolicyRequest' + $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2341,18 +2316,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalPolicy' - parameters: [] - /v1alpha1/policies:test: + $ref: '#/components/schemas/SasPortalDevice' + parameters: + - in: path + name: customersId + required: true + schema: + type: string + /v1alpha1/customers/{customersId}/devices/{devicesId}: parameters: *ref_1 - post: - description: Returns permissions that a caller has on the specified resource. - operationId: sasportal.policies.test - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalTestPermissionsRequest' + delete: + description: Deletes a device. + operationId: sasportal.customers.devices.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2368,18 +2343,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalTestPermissionsResponse' - parameters: [] - /v1alpha1/customers/{customersId}/devices:createSigned: - parameters: *ref_1 - post: - description: Creates a signed device under a node or customer. - operationId: sasportal.customers.devices.createSigned - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' + $ref: '#/components/schemas/SasPortalEmpty' + parameters: + - in: path + name: customersId + required: true + schema: + type: string + - in: path + name: devicesId + required: true + schema: + type: string + get: + description: Gets details about a device. + operationId: sasportal.customers.devices.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2402,16 +2380,19 @@ paths: required: true schema: type: string - /v1alpha1/customers/{customersId}/devices/{devicesId}:updateSigned: - parameters: *ref_1 + - in: path + name: devicesId + required: true + schema: + type: string patch: - description: Updates a signed device. - operationId: sasportal.customers.devices.updateSigned + description: Updates a device. + operationId: sasportal.customers.devices.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalUpdateSignedDeviceRequest' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2439,11 +2420,21 @@ paths: required: true schema: type: string - /v1alpha1/customers/{customersId}/devices: + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1alpha1/customers/{customersId}/devices/{devicesId}:move: parameters: *ref_1 - get: - description: Lists devices under a node or customer. - operationId: sasportal.customers.devices.list + post: + description: Moves a device under another node or customer. + operationId: sasportal.customers.devices.move + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalMoveDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2459,34 +2450,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDevicesResponse' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path name: customersId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + - in: path + name: devicesId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - post: - description: Creates a device under a node or customer. - operationId: sasportal.customers.devices.create + /v1alpha1/customers/{customersId}/devices/{devicesId}:updateSigned: + parameters: *ref_1 + patch: + description: Updates a signed device. + operationId: sasportal.customers.devices.updateSigned requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalUpdateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2509,11 +2494,21 @@ paths: required: true schema: type: string - /v1alpha1/customers/{customersId}/devices/{devicesId}: + - in: path + name: devicesId + required: true + schema: + type: string + /v1alpha1/customers/{customersId}/devices/{devicesId}:signDevice: parameters: *ref_1 - delete: - description: Deletes a device. - operationId: sasportal.customers.devices.delete + post: + description: Signs a device. + operationId: sasportal.customers.devices.signDevice + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalSignDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2541,14 +2536,16 @@ paths: required: true schema: type: string - patch: - description: Updates a device. - operationId: sasportal.customers.devices.patch + /v1alpha1/customers/{customersId}/nodes: + parameters: *ref_1 + post: + description: Creates a new node. + operationId: sasportal.customers.nodes.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalNode' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2564,26 +2561,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalNode' parameters: - in: path name: customersId required: true schema: type: string - - in: path - name: devicesId - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask get: - description: Gets details about a device. - operationId: sasportal.customers.devices.get + description: Lists nodes. + operationId: sasportal.customers.nodes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2599,28 +2586,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalListNodesResponse' parameters: - in: path name: customersId required: true schema: type: string - - in: path - name: devicesId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1alpha1/customers/{customersId}/devices/{devicesId}:move: + - in: query + name: filter + schema: + type: string + /v1alpha1/customers/{customersId}/nodes/{nodesId}: parameters: *ref_1 - post: - description: Moves a device under another node or customer. - operationId: sasportal.customers.devices.move - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalMoveDeviceRequest' + delete: + description: Deletes a node. + operationId: sasportal.customers.nodes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2636,7 +2626,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path name: customersId @@ -2644,20 +2634,13 @@ paths: schema: type: string - in: path - name: devicesId + name: nodesId required: true schema: type: string - /v1alpha1/customers/{customersId}/devices/{devicesId}:signDevice: - parameters: *ref_1 - post: - description: Signs a device. - operationId: sasportal.customers.devices.signDevice - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalSignDeviceRequest' + get: + description: Returns a requested node. + operationId: sasportal.customers.nodes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2673,7 +2656,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalNode' parameters: - in: path name: customersId @@ -2681,20 +2664,18 @@ paths: schema: type: string - in: path - name: devicesId + name: nodesId required: true schema: type: string - /v1alpha1/customers/{customersId}/nodes/{nodesId}/deployments: - parameters: *ref_1 - post: - description: Creates a new deployment. - operationId: sasportal.customers.nodes.deployments.create + patch: + description: Updates an existing node. + operationId: sasportal.customers.nodes.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalNode' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2710,7 +2691,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalNode' parameters: - in: path name: customersId @@ -2722,9 +2703,21 @@ paths: required: true schema: type: string - get: - description: Lists deployments. - operationId: sasportal.customers.nodes.deployments.list + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1alpha1/customers/{customersId}/nodes/{nodesId}:move: + parameters: *ref_1 + post: + description: Moves a node under another node or customer. + operationId: sasportal.customers.nodes.move + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalMoveNodeRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2740,7 +2733,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDeploymentsResponse' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path name: customersId @@ -2752,19 +2745,6 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string /v1alpha1/customers/{customersId}/nodes/{nodesId}/devices: parameters: *ref_1 post: @@ -2832,6 +2812,11 @@ paths: required: true schema: type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 - in: query name: pageToken schema: @@ -2840,11 +2825,6 @@ paths: name: filter schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 /v1alpha1/customers/{customersId}/nodes/{nodesId}/devices:createSigned: parameters: *ref_1 post: @@ -2949,6 +2929,11 @@ paths: required: true schema: type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 - in: query name: pageToken schema: @@ -2957,16 +2942,16 @@ paths: name: filter schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1alpha1/customers/{customersId}/nodes: + /v1alpha1/customers/{customersId}/nodes/{nodesId}/deployments: parameters: *ref_1 - get: - description: Lists nodes. - operationId: sasportal.customers.nodes.list + post: + description: Creates a new deployment. + operationId: sasportal.customers.nodes.deployments.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalDeployment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2982,34 +2967,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListNodesResponse' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path name: customersId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + - in: path + name: nodesId + required: true schema: type: string - post: - description: Creates a new node. - operationId: sasportal.customers.nodes.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalNode' + get: + description: Lists deployments. + operationId: sasportal.customers.nodes.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3025,18 +2997,41 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalListDeploymentsResponse' parameters: - in: path name: customersId required: true schema: type: string - /v1alpha1/customers/{customersId}/nodes/{nodesId}: + - in: path + name: nodesId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1alpha1/customers/{customersId}/deployments: parameters: *ref_1 - get: - description: Returns a requested node. - operationId: sasportal.customers.nodes.get + post: + description: Creates a new deployment. + operationId: sasportal.customers.deployments.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalDeployment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3052,26 +3047,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path name: customersId required: true schema: type: string - - in: path - name: nodesId - required: true - schema: - type: string - patch: - description: Updates an existing node. - operationId: sasportal.customers.nodes.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalNode' + get: + description: Lists deployments. + operationId: sasportal.customers.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3087,26 +3072,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalListDeploymentsResponse' parameters: - in: path name: customersId required: true schema: type: string - - in: path - name: nodesId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - in: query - name: updateMask + name: filter schema: type: string - format: google-fieldmask + /v1alpha1/customers/{customersId}/deployments/{deploymentsId}: + parameters: *ref_1 delete: - description: Deletes a node. - operationId: sasportal.customers.nodes.delete + description: Deletes a deployment. + operationId: sasportal.customers.deployments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3130,20 +3120,13 @@ paths: schema: type: string - in: path - name: nodesId + name: deploymentsId required: true schema: type: string - /v1alpha1/customers/{customersId}/nodes/{nodesId}:move: - parameters: *ref_1 - post: - description: Moves a node under another node or customer. - operationId: sasportal.customers.nodes.move - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalMoveNodeRequest' + get: + description: Returns a requested deployment. + operationId: sasportal.customers.deployments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3159,7 +3142,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path name: customersId @@ -3167,15 +3150,18 @@ paths: schema: type: string - in: path - name: nodesId + name: deploymentsId required: true schema: type: string - /v1alpha1/customers/{customersId}/deployments/{deploymentsId}/devices: - parameters: *ref_1 - get: - description: Lists devices under a node or customer. - operationId: sasportal.customers.deployments.devices.list + patch: + description: Updates an existing deployment. + operationId: sasportal.customers.deployments.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalDeployment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3191,7 +3177,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDevicesResponse' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path name: customersId @@ -3204,26 +3190,20 @@ paths: schema: type: string - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + name: updateMask schema: type: string + format: google-fieldmask + /v1alpha1/customers/{customersId}/deployments/{deploymentsId}:move: + parameters: *ref_1 post: - description: Creates a device under a node or customer. - operationId: sasportal.customers.deployments.devices.create + description: Moves a deployment under another node or customer. + operationId: sasportal.customers.deployments.move requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalMoveDeploymentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3239,7 +3219,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path name: customersId @@ -3251,16 +3231,16 @@ paths: required: true schema: type: string - /v1alpha1/customers/{customersId}/deployments/{deploymentsId}/devices:createSigned: + /v1alpha1/customers/{customersId}/deployments/{deploymentsId}/devices: parameters: *ref_1 post: - description: Creates a signed device under a node or customer. - operationId: sasportal.customers.deployments.devices.createSigned + description: Creates a device under a node or customer. + operationId: sasportal.customers.deployments.devices.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3288,16 +3268,9 @@ paths: required: true schema: type: string - /v1alpha1/customers/{customersId}/deployments/{deploymentsId}: - parameters: *ref_1 - patch: - description: Updates an existing deployment. - operationId: sasportal.customers.deployments.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalDeployment' + get: + description: Lists devices under a node or customer. + operationId: sasportal.customers.deployments.devices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3313,7 +3286,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalListDevicesResponse' parameters: - in: path name: customersId @@ -3326,13 +3299,28 @@ paths: schema: type: string - in: query - name: updateMask + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - format: google-fieldmask - get: - description: Returns a requested deployment. - operationId: sasportal.customers.deployments.get + - in: query + name: filter + schema: + type: string + /v1alpha1/customers/{customersId}/deployments/{deploymentsId}/devices:createSigned: + parameters: *ref_1 + post: + description: Creates a signed device under a node or customer. + operationId: sasportal.customers.deployments.devices.createSigned + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3348,7 +3336,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: customersId @@ -3360,9 +3348,11 @@ paths: required: true schema: type: string - delete: - description: Deletes a deployment. - operationId: sasportal.customers.deployments.delete + /v1alpha1/nodes/{nodesId}: + parameters: *ref_1 + get: + description: Returns a requested node. + operationId: sasportal.nodes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3378,28 +3368,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalNode' parameters: - in: path - name: customersId - required: true - schema: - type: string - - in: path - name: deploymentsId + name: nodesId required: true schema: type: string - /v1alpha1/customers/{customersId}/deployments/{deploymentsId}:move: + /v1alpha1/nodes/{nodesId}/devices: parameters: *ref_1 post: - description: Moves a deployment under another node or customer. - operationId: sasportal.customers.deployments.move + description: Creates a device under a node or customer. + operationId: sasportal.nodes.devices.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalMoveDeploymentRequest' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3415,23 +3400,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: customersId - required: true - schema: - type: string - - in: path - name: deploymentsId + name: nodesId required: true schema: type: string - /v1alpha1/customers/{customersId}/deployments: - parameters: *ref_1 get: - description: Lists deployments. - operationId: sasportal.customers.deployments.list + description: Lists devices under a node or customer. + operationId: sasportal.nodes.devices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3447,10 +3425,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDeploymentsResponse' + $ref: '#/components/schemas/SasPortalListDevicesResponse' parameters: - in: path - name: customersId + name: nodesId required: true schema: type: string @@ -3460,21 +3438,23 @@ paths: type: integer format: int32 - in: query - name: filter + name: pageToken schema: type: string - in: query - name: pageToken + name: filter schema: type: string + /v1alpha1/nodes/{nodesId}/devices:createSigned: + parameters: *ref_1 post: - description: Creates a new deployment. - operationId: sasportal.customers.deployments.create + description: Creates a signed device under a node or customer. + operationId: sasportal.nodes.devices.createSigned requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3490,18 +3470,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: customersId + name: nodesId required: true schema: type: string - /v1alpha1/customers:listLegacyOrganizations: + /v1alpha1/nodes/{nodesId}/devices/{devicesId}: parameters: *ref_1 - get: - description: Returns a list of legacy organizations. - operationId: sasportal.customers.listLegacyOrganizations + delete: + description: Deletes a device. + operationId: sasportal.nodes.devices.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3517,20 +3497,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListLegacyOrganizationsResponse' - parameters: [] - /v1alpha1/customers:provisionDeployment: - parameters: *ref_1 - post: - description: >- - Creates a new SAS deployment through the GCP workflow. Creates a SAS - organization if an organization match is not found. - operationId: sasportal.customers.provisionDeployment - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalProvisionDeploymentRequest' + $ref: '#/components/schemas/SasPortalEmpty' + parameters: + - in: path + name: nodesId + required: true + schema: + type: string + - in: path + name: devicesId + required: true + schema: + type: string + get: + description: Gets details about a device. + operationId: sasportal.nodes.devices.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3546,18 +3527,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalProvisionDeploymentResponse' - parameters: [] - /v1alpha1/customers/{customersId}: - parameters: *ref_1 + $ref: '#/components/schemas/SasPortalDevice' + parameters: + - in: path + name: nodesId + required: true + schema: + type: string + - in: path + name: devicesId + required: true + schema: + type: string patch: - description: Updates an existing customer. - operationId: sasportal.customers.patch + description: Updates a device. + operationId: sasportal.nodes.devices.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCustomer' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3573,10 +3562,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCustomer' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: customersId + name: nodesId + required: true + schema: + type: string + - in: path + name: devicesId required: true schema: type: string @@ -3585,9 +3579,16 @@ paths: schema: type: string format: google-fieldmask - get: - description: Returns a requested customer. - operationId: sasportal.customers.get + /v1alpha1/nodes/{nodesId}/devices/{devicesId}:move: + parameters: *ref_1 + post: + description: Moves a device under another node or customer. + operationId: sasportal.nodes.devices.move + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalMoveDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3603,26 +3604,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCustomer' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path - name: customersId + name: nodesId required: true schema: type: string - /v1alpha1/customers:setupSasAnalytics: + - in: path + name: devicesId + required: true + schema: + type: string + /v1alpha1/nodes/{nodesId}/devices/{devicesId}:updateSigned: parameters: *ref_1 - post: - description: >- - Setups the a GCP Project to receive SAS Analytics messages via GCP - Pub/Sub with a subscription to BigQuery. All the Pub/Sub topics and - BigQuery tables are created automatically as part of this service. - operationId: sasportal.customers.setupSasAnalytics + patch: + description: Updates a signed device. + operationId: sasportal.nodes.devices.updateSigned requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalSetupSasAnalyticsRequest' + $ref: '#/components/schemas/SasPortalUpdateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3638,13 +3641,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' - parameters: [] - /v1alpha1/customers: + $ref: '#/components/schemas/SasPortalDevice' + parameters: + - in: path + name: nodesId + required: true + schema: + type: string + - in: path + name: devicesId + required: true + schema: + type: string + /v1alpha1/nodes/{nodesId}/devices/{devicesId}:signDevice: parameters: *ref_1 - get: - description: Returns a list of requested customers. - operationId: sasportal.customers.list + post: + description: Signs a device. + operationId: sasportal.nodes.devices.signDevice + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalSignDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3660,24 +3678,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListCustomersResponse' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - - in: query - name: pageSize + - in: path + name: nodesId + required: true schema: - type: integer - format: int32 - - in: query - name: pageToken + type: string + - in: path + name: devicesId + required: true schema: type: string - /v1alpha1/customers:listGcpProjectDeployments: + /v1alpha1/nodes/{nodesId}/nodes: parameters: *ref_1 - get: - description: >- - Returns a list of SAS deployments associated with current GCP project. - Includes whether SAS analytics has been enabled or not. - operationId: sasportal.customers.listGcpProjectDeployments + post: + description: Creates a new node. + operationId: sasportal.nodes.nodes.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalNode' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3693,23 +3715,16 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/SasPortalListGcpProjectDeploymentsResponse - parameters: [] - /v1alpha1/customers:migrateOrganization: - parameters: *ref_1 - post: - description: >- - Migrates a SAS organization to the cloud. This will create GCP projects - for each deployment and associate them. The SAS Organization is linked - to the gcp project that called the command. - go/sas-legacy-customer-migration - operationId: sasportal.customers.migrateOrganization - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalMigrateOrganizationRequest' + $ref: '#/components/schemas/SasPortalNode' + parameters: + - in: path + name: nodesId + required: true + schema: + type: string + get: + description: Lists nodes. + operationId: sasportal.nodes.nodes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3725,18 +3740,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' - parameters: [] - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/deployments: + $ref: '#/components/schemas/SasPortalListNodesResponse' + parameters: + - in: path + name: nodesId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}: parameters: *ref_1 - post: - description: Creates a new deployment. - operationId: sasportal.nodes.nodes.deployments.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalDeployment' + delete: + description: Deletes a node. + operationId: sasportal.nodes.nodes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3752,7 +3780,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path name: nodesId @@ -3765,8 +3793,8 @@ paths: schema: type: string get: - description: Lists deployments. - operationId: sasportal.nodes.nodes.deployments.list + description: Returns a requested node. + operationId: sasportal.nodes.nodes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3782,7 +3810,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDeploymentsResponse' + $ref: '#/components/schemas/SasPortalNode' parameters: - in: path name: nodesId @@ -3794,29 +3822,14 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/devices: - parameters: *ref_1 - post: - description: Creates a device under a node or customer. - operationId: sasportal.nodes.nodes.devices.create + patch: + description: Updates an existing node. + operationId: sasportal.nodes.nodes.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalNode' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3832,7 +3845,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalNode' parameters: - in: path name: nodesId @@ -3844,9 +3857,21 @@ paths: required: true schema: type: string - get: - description: Lists devices under a node or customer. - operationId: sasportal.nodes.nodes.devices.list + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}:move: + parameters: *ref_1 + post: + description: Moves a node under another node or customer. + operationId: sasportal.nodes.nodes.move + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalMoveNodeRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3862,7 +3887,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDevicesResponse' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path name: nodesId @@ -3874,29 +3899,16 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/devices:createSigned: + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/devices: parameters: *ref_1 post: - description: Creates a signed device under a node or customer. - operationId: sasportal.nodes.nodes.devices.createSigned + description: Creates a device under a node or customer. + operationId: sasportal.nodes.nodes.devices.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3924,11 +3936,9 @@ paths: required: true schema: type: string - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/nodes: - parameters: *ref_1 get: - description: Lists nodes. - operationId: sasportal.nodes.nodes.nodes.list + description: Lists devices under a node or customer. + operationId: sasportal.nodes.nodes.devices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3944,7 +3954,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListNodesResponse' + $ref: '#/components/schemas/SasPortalListDevicesResponse' parameters: - in: path name: nodesId @@ -3957,26 +3967,28 @@ paths: schema: type: string - in: query - name: filter + name: pageSize schema: - type: string + type: integer + format: int32 - in: query name: pageToken schema: type: string - in: query - name: pageSize + name: filter schema: - type: integer - format: int32 + type: string + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/devices:createSigned: + parameters: *ref_1 post: - description: Creates a new node. - operationId: sasportal.nodes.nodes.nodes.create + description: Creates a signed device under a node or customer. + operationId: sasportal.nodes.nodes.devices.createSigned requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3992,7 +4004,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: nodesId @@ -4004,11 +4016,16 @@ paths: required: true schema: type: string - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}: + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/nodes: parameters: *ref_1 - delete: - description: Deletes a node. - operationId: sasportal.nodes.nodes.delete + post: + description: Creates a new node. + operationId: sasportal.nodes.nodes.nodes.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalNode' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4024,7 +4041,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalNode' parameters: - in: path name: nodesId @@ -4036,14 +4053,9 @@ paths: required: true schema: type: string - patch: - description: Updates an existing node. - operationId: sasportal.nodes.nodes.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalNode' + get: + description: Lists nodes. + operationId: sasportal.nodes.nodes.nodes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4059,7 +4071,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalListNodesResponse' parameters: - in: path name: nodesId @@ -4072,13 +4084,28 @@ paths: schema: type: string - in: query - name: updateMask + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - format: google-fieldmask - get: - description: Returns a requested node. - operationId: sasportal.nodes.nodes.get + - in: query + name: filter + schema: + type: string + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/deployments: + parameters: *ref_1 + post: + description: Creates a new deployment. + operationId: sasportal.nodes.nodes.deployments.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalDeployment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4094,7 +4121,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path name: nodesId @@ -4106,16 +4133,9 @@ paths: required: true schema: type: string - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}:move: - parameters: *ref_1 - post: - description: Moves a node under another node or customer. - operationId: sasportal.nodes.nodes.move - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalMoveNodeRequest' + get: + description: Lists deployments. + operationId: sasportal.nodes.nodes.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4131,7 +4151,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalListDeploymentsResponse' parameters: - in: path name: nodesId @@ -4143,16 +4163,24 @@ paths: required: true schema: type: string - /v1alpha1/nodes/{nodesId}/nodes: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}: parameters: *ref_1 - post: - description: Creates a new node. - operationId: sasportal.nodes.nodes.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalNode' + delete: + description: Deletes a deployment. + operationId: sasportal.nodes.deployments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4168,16 +4196,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path name: nodesId required: true schema: type: string + - in: path + name: deploymentsId + required: true + schema: + type: string get: - description: Lists nodes. - operationId: sasportal.nodes.nodes.list + description: Returns a requested deployment. + operationId: sasportal.nodes.deployments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4193,36 +4226,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListNodesResponse' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path name: nodesId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken + - in: path + name: deploymentsId + required: true schema: type: string - /v1alpha1/nodes/{nodesId}/devices/{devicesId}:move: - parameters: *ref_1 - post: - description: Moves a device under another node or customer. - operationId: sasportal.nodes.devices.move + patch: + description: Updates an existing deployment. + operationId: sasportal.nodes.deployments.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalMoveDeviceRequest' + $ref: '#/components/schemas/SasPortalDeployment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4238,7 +4261,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path name: nodesId @@ -4246,15 +4269,20 @@ paths: schema: type: string - in: path - name: devicesId + name: deploymentsId required: true schema: type: string - /v1alpha1/nodes/{nodesId}/devices/{devicesId}: + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1alpha1/nodes/{nodesId}/deployments: parameters: *ref_1 get: - description: Gets details about a device. - operationId: sasportal.nodes.devices.get + description: Lists deployments. + operationId: sasportal.nodes.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4270,21 +4298,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalListDeploymentsResponse' parameters: - in: path name: nodesId required: true schema: type: string - - in: path - name: devicesId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - delete: - description: Deletes a device. - operationId: sasportal.nodes.devices.delete + - in: query + name: filter + schema: + type: string + /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}:move: + parameters: *ref_1 + post: + description: Moves a deployment under another node or customer. + operationId: sasportal.nodes.deployments.move + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalMoveDeploymentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4300,7 +4343,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path name: nodesId @@ -4308,13 +4351,15 @@ paths: schema: type: string - in: path - name: devicesId + name: deploymentsId required: true schema: type: string - patch: - description: Updates a device. - operationId: sasportal.nodes.devices.patch + /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}/devices: + parameters: *ref_1 + post: + description: Creates a device under a node or customer. + operationId: sasportal.nodes.deployments.devices.create requestBody: content: application/json: @@ -4343,25 +4388,13 @@ paths: schema: type: string - in: path - name: devicesId + name: deploymentsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1alpha1/nodes/{nodesId}/devices/{devicesId}:signDevice: - parameters: *ref_1 - post: - description: Signs a device. - operationId: sasportal.nodes.devices.signDevice - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalSignDeviceRequest' + get: + description: Lists devices under a node or customer. + operationId: sasportal.nodes.deployments.devices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4377,7 +4410,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalListDevicesResponse' parameters: - in: path name: nodesId @@ -4385,15 +4418,28 @@ paths: schema: type: string - in: path - name: devicesId + name: deploymentsId required: true schema: type: string - /v1alpha1/nodes/{nodesId}/devices:createSigned: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}/devices:createSigned: parameters: *ref_1 post: description: Creates a signed device under a node or customer. - operationId: sasportal.nodes.devices.createSigned + operationId: sasportal.nodes.deployments.devices.createSigned requestBody: content: application/json: @@ -4421,16 +4467,21 @@ paths: required: true schema: type: string - /v1alpha1/nodes/{nodesId}/devices: + - in: path + name: deploymentsId + required: true + schema: + type: string + /v1alpha1/installer:generateSecret: parameters: *ref_1 post: - description: Creates a device under a node or customer. - operationId: sasportal.nodes.devices.create + description: Generates a secret to be used with the ValidateInstaller. + operationId: sasportal.installer.generateSecret requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalGenerateSecretRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4446,16 +4497,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' - parameters: - - in: path - name: nodesId - required: true - schema: - type: string - get: - description: Lists devices under a node or customer. - operationId: sasportal.nodes.devices.list + $ref: '#/components/schemas/SasPortalGenerateSecretResponse' + parameters: [] + /v1alpha1/installer:validate: + parameters: *ref_1 + post: + description: Validates the identity of a Certified Professional Installer (CPI). + operationId: sasportal.installer.validate + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalValidateInstallerRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4471,36 +4524,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDevicesResponse' - parameters: - - in: path - name: nodesId - required: true - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1alpha1/nodes/{nodesId}/devices/{devicesId}:updateSigned: + $ref: '#/components/schemas/SasPortalValidateInstallerResponse' + parameters: [] + /v1alpha1/deployments/{deploymentsId}: parameters: *ref_1 - patch: - description: Updates a signed device. - operationId: sasportal.nodes.devices.updateSigned - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalUpdateSignedDeviceRequest' + get: + description: Returns a requested deployment. + operationId: sasportal.deployments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4516,28 +4546,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path - name: nodesId - required: true - schema: - type: string - - in: path - name: devicesId + name: deploymentsId required: true schema: type: string - /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}/devices: + /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}: parameters: *ref_1 - post: - description: Creates a device under a node or customer. - operationId: sasportal.nodes.deployments.devices.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalDevice' + delete: + description: Deletes a device. + operationId: sasportal.deployments.devices.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4553,21 +4573,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path - name: nodesId + name: deploymentsId required: true schema: type: string - in: path - name: deploymentsId + name: devicesId required: true schema: type: string get: - description: Lists devices under a node or customer. - operationId: sasportal.nodes.deployments.devices.list + description: Gets details about a device. + operationId: sasportal.deployments.devices.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4583,41 +4603,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDevicesResponse' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: nodesId + name: deploymentsId required: true schema: type: string - in: path - name: deploymentsId + name: devicesId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}/devices:createSigned: - parameters: *ref_1 - post: - description: Creates a signed device under a node or customer. - operationId: sasportal.nodes.deployments.devices.createSigned + patch: + description: Updates a device. + operationId: sasportal.deployments.devices.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4636,20 +4641,30 @@ paths: $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: nodesId + name: deploymentsId required: true schema: type: string - in: path - name: deploymentsId + name: devicesId required: true schema: type: string - /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}: + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:move: parameters: *ref_1 - delete: - description: Deletes a deployment. - operationId: sasportal.nodes.deployments.delete + post: + description: Moves a device under another node or customer. + operationId: sasportal.deployments.devices.move + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalMoveDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4665,21 +4680,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path - name: nodesId + name: deploymentsId required: true schema: type: string - in: path - name: deploymentsId + name: devicesId required: true schema: type: string - get: - description: Returns a requested deployment. - operationId: sasportal.nodes.deployments.get + /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:updateSigned: + parameters: *ref_1 + patch: + description: Updates a signed device. + operationId: sasportal.deployments.devices.updateSigned + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalUpdateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4695,26 +4717,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: nodesId + name: deploymentsId required: true schema: type: string - in: path - name: deploymentsId + name: devicesId required: true schema: type: string - patch: - description: Updates an existing deployment. - operationId: sasportal.nodes.deployments.patch + /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:signDevice: + parameters: *ref_1 + post: + description: Signs a device. + operationId: sasportal.deployments.devices.signDevice requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalSignDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4730,33 +4754,30 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path - name: nodesId + name: deploymentsId required: true schema: type: string - in: path - name: deploymentsId + name: devicesId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}:move: + /v1alpha1/policies:set: parameters: *ref_1 post: - description: Moves a deployment under another node or customer. - operationId: sasportal.nodes.deployments.move + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy. + operationId: sasportal.policies.set requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalMoveDeploymentRequest' + $ref: '#/components/schemas/SasPortalSetPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4772,23 +4793,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' - parameters: - - in: path - name: nodesId - required: true - schema: - type: string - - in: path - name: deploymentsId - required: true - schema: - type: string - /v1alpha1/nodes/{nodesId}/deployments: + $ref: '#/components/schemas/SasPortalPolicy' + parameters: [] + /v1alpha1/policies:get: parameters: *ref_1 - get: - description: Lists deployments. - operationId: sasportal.nodes.deployments.list + post: + description: >- + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: sasportal.policies.get + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalGetPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4804,31 +4822,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDeploymentsResponse' - parameters: - - in: path - name: nodesId - required: true - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - /v1alpha1/nodes/{nodesId}: + $ref: '#/components/schemas/SasPortalPolicy' + parameters: [] + /v1alpha1/policies:test: parameters: *ref_1 - get: - description: Returns a requested node. - operationId: sasportal.nodes.get + post: + description: Returns permissions that a caller has on the specified resource. + operationId: sasportal.policies.test + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalTestPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4844,10 +4849,5 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' - parameters: - - in: path - name: nodesId - required: true - schema: - type: string + $ref: '#/components/schemas/SasPortalTestPermissionsResponse' + parameters: [] diff --git a/providers/src/googleapis.com/v00.00.00000/services/secretmanager.yaml b/providers/src/googleapis.com/v00.00.00000/services/secretmanager.yaml index 7174e6b3..b014dc1f 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/secretmanager.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/secretmanager.yaml @@ -9,8 +9,8 @@ info: Stores sensitive data such as API keys, passwords, and certificates. Provides convenience while improving security. version: v1 - x-discovery-doc-revision: '20241023' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250711' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/secret-manager/ servers: @@ -218,6 +218,16 @@ components: afterwards. They do not apply retroactively to existing SecretVersions. $ref: '#/components/schemas/CustomerManagedEncryption' + tags: + description: >- + Optional. Input only. Immutable. Mapping of Tag keys/values directly + bound to this resource. For example: "123/environment": + "production", "123/costCenter": "marketing" Tags are used to + organize and group resources. Tags can be used to control policy + evaluation for the resource. + type: object + additionalProperties: + type: string Replication: id: Replication description: >- @@ -269,7 +279,7 @@ components: id: UserManaged description: >- A replication policy that replicates the Secret payload into the - locations specified in Secret.replication.user_managed.replicas + locations specified in Replication.UserManaged.replicas type: object properties: replicas: @@ -1245,6 +1255,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: diff --git a/providers/src/googleapis.com/v00.00.00000/services/securesourcemanager.yaml b/providers/src/googleapis.com/v00.00.00000/services/securesourcemanager.yaml new file mode 100644 index 00000000..4ff336a3 --- /dev/null +++ b/providers/src/googleapis.com/v00.00.00000/services/securesourcemanager.yaml @@ -0,0 +1,5051 @@ +openapi: 3.1.0 +info: + contact: + name: StackQL Studios + url: https://github.com/stackql/google-discovery-to-openapi + email: info@stackql.io + title: Secure Source Manager API + description: >- + Regionally deployed, single-tenant managed source code repository hosted on + Google Cloud. + version: v1 + x-discovery-doc-revision: '0' + x-generated-date: '2025-08-28' +externalDocs: + url: https://cloud.google.com/secure-source-manager +servers: + - url: https://securesourcemanager.googleapis.com +components: + securitySchemes: + Oauth2: + type: oauth2 + description: Oauth 2.0 implicit authentication + flows: + implicit: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + scopes: &ref_0 + 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. + Oauth2c: + type: oauth2 + description: Oauth 2.0 authorization code authentication + flows: + authorizationCode: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + tokenUrl: https://accounts.google.com/o/oauth2/token + scopes: *ref_0 + schemas: + ListLocationsResponse: + id: ListLocationsResponse + description: The response message for Locations.ListLocations. + type: object + properties: + locations: + description: >- + A list of locations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/Location' + nextPageToken: + description: The standard List next-page token. + type: string + Location: + id: Location + description: A resource that represents a Google Cloud location. + type: object + properties: + name: + description: >- + Resource name for the location, which may vary between + implementations. For example: + `"projects/example-project/locations/us-east1"` + type: string + locationId: + description: 'The canonical id for this location. For example: `"us-east1"`.' + type: string + displayName: + description: >- + The friendly name for this location, typically a nearby city name. + For example, "Tokyo". + type: string + labels: + description: >- + Cross-service attributes for the location. For example + {"cloud.googleapis.com/region": "us-east1"} + type: object + additionalProperties: + type: string + metadata: + description: >- + Service-specific metadata. For example the available capacity at the + given location. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + SetIamPolicyRequest: + id: SetIamPolicyRequest + description: Request message for `SetIamPolicy` method. + type: object + properties: + policy: + description: >- + REQUIRED: The complete policy to be applied to the `resource`. The + size of the policy is limited to a few 10s of KB. An empty policy is + a valid policy but certain Google Cloud services (such as Projects) + might reject them. + $ref: '#/components/schemas/Policy' + updateMask: + description: >- + OPTIONAL: A FieldMask specifying which fields of the policy to + modify. Only the fields in the mask will be modified. If no mask is + provided, the following default mask is used: `paths: "bindings, + etag"` + type: string + format: google-fieldmask + Policy: + id: Policy + description: >- + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. A `Policy` is a collection of + `bindings`. A `binding` binds one or more `members`, or principals, to a + single `role`. Principals can be user accounts, service accounts, Google + groups, and domains (such as G Suite). A `role` is a named list of + permissions; each `role` can be an IAM predefined role or a user-created + custom role. For some types of Google Cloud resources, a `binding` can + also specify a `condition`, which is a logical expression that allows + access to a resource only if the expression evaluates to `true`. A + condition can add constraints based on attributes of the request, the + resource, or both. To learn which resources support conditions in their + IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + **JSON example:** ``` { "bindings": [ { "role": + "roles/resourcemanager.organizationAdmin", "members": [ + "user:mike@example.com", "group:admins@example.com", + "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { + "role": "roles/resourcemanager.organizationViewer", "members": [ + "user:eve@example.com" ], "condition": { "title": "expirable access", + "description": "Does not grant access after Sep 2020", "expression": + "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": + "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - + members: - user:mike@example.com - group:admins@example.com - + domain:google.com - + serviceAccount:my-project-id@appspot.gserviceaccount.com role: + roles/resourcemanager.organizationAdmin - members: - + user:eve@example.com role: roles/resourcemanager.organizationViewer + condition: title: expirable access description: Does not grant access + after Sep 2020 expression: request.time < + timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` + For a description of IAM and its features, see the [IAM + documentation](https://cloud.google.com/iam/docs/). + type: object + properties: + 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). + type: integer + format: int32 + bindings: + description: >- + Associates a list of `members`, or principals, with a `role`. + Optionally, may specify a `condition` that determines how and when + the `bindings` are applied. Each of the `bindings` must contain at + least one principal. The `bindings` in a `Policy` can refer to up to + 1,500 principals; up to 250 of these principals can be Google + groups. Each occurrence of a principal counts towards these limits. + For example, if the `bindings` grant 50 different roles to + `user:alice@example.com`, and not to any other principal, then you + can add another 1,450 principals to the `bindings` in the `Policy`. + type: array + items: + $ref: '#/components/schemas/Binding' + auditConfigs: + description: Specifies cloud audit logging configuration for this policy. + type: array + items: + $ref: '#/components/schemas/AuditConfig' + 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. + type: string + format: byte + Binding: + id: Binding + description: Associates `members`, or principals, with a `role`. + type: object + properties: + role: + description: >- + Role that is assigned to the list of `members`, or principals. For + example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an + overview of the IAM roles and permissions, see the [IAM + documentation](https://cloud.google.com/iam/docs/roles-overview). + For a list of the available pre-defined roles, see + [here](https://cloud.google.com/iam/docs/understanding-roles). + type: string + members: + description: >- + Specifies the principals requesting access for a Google Cloud + 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. Does not include identities + that come from external identity providers (IdPs) through identity + federation. * `user:{emailid}`: An email address that represents a + specific Google account. For example, `alice@example.com` . * + `serviceAccount:{emailid}`: An email address that represents a + Google service account. For example, + `my-other-app@appspot.gserviceaccount.com`. * + `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: + An identifier for a [Kubernetes service + account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). + For example, + `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * + `group:{emailid}`: An email address that represents a Google group. + For example, `admins@example.com`. * `domain:{domain}`: The G Suite + domain (primary) that represents all the users of that domain. For + example, `google.com` or `example.com`. * + `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workforce identity pool. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: + All workforce identities in a group. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All workforce identities with a specific attribute value. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: + All identities in a workforce identity pool. * + `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workload identity pool. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: + A workload identity pool group. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All identities in a workload identity pool with a certain attribute. + * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: + All identities in a workload identity pool. * + `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. * + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + Deleted single identity in a workforce identity pool. For example, + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + type: array + items: + type: string + condition: + description: >- + The condition that is associated with this binding. If the condition + evaluates to `true`, then this binding applies to the current + request. If the condition evaluates to `false`, then this binding + does not apply to the current request. However, a different role + binding might grant the same role to one or more of the principals + in this binding. To learn which resources support conditions in + their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + $ref: '#/components/schemas/Expr' + Expr: + id: 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. + type: object + properties: + expression: + description: >- + Textual representation of an expression in Common Expression + Language syntax. + 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 + 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 + 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 + AuditConfig: + id: 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. + type: object + properties: + 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 + auditLogConfigs: + description: The configuration for logging of each type of permission. + type: array + items: + $ref: '#/components/schemas/AuditLogConfig' + AuditLogConfig: + id: 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. + type: object + properties: + logType: + description: The log type that this config enables. + type: string + enumDescriptions: + - Default case. Should never be this. + - 'Admin reads. Example: CloudIAM getIamPolicy' + - 'Data writes. Example: CloudSQL Users create' + - 'Data reads. Example: CloudSQL Users list' + enum: + - LOG_TYPE_UNSPECIFIED + - ADMIN_READ + - DATA_WRITE + - DATA_READ + exemptedMembers: + description: >- + Specifies the identities that do not cause logging for this type of + permission. Follows the same format of Binding.members. + type: array + items: + type: string + TestIamPermissionsRequest: + id: TestIamPermissionsRequest + description: Request message for `TestIamPermissions` method. + type: object + properties: + permissions: + description: >- + The set of permissions to check for the `resource`. Permissions with + wildcards (such as `*` or `storage.*`) are not allowed. For more + information see [IAM + Overview](https://cloud.google.com/iam/docs/overview#permissions). + type: array + items: + type: string + TestIamPermissionsResponse: + id: TestIamPermissionsResponse + description: Response message for `TestIamPermissions` method. + type: object + properties: + permissions: + description: >- + A subset of `TestPermissionsRequest.permissions` that the caller is + allowed. + type: array + items: + type: string + ListOperationsResponse: + id: ListOperationsResponse + description: The response message for Operations.ListOperations. + type: object + properties: + operations: + description: >- + A list of operations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/Operation' + nextPageToken: + description: The standard List next-page token. + type: string + Operation: + id: Operation + description: >- + This resource represents a long-running operation that is the result of + a network API call. + type: object + properties: + name: + description: >- + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. + type: string + metadata: + description: >- + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + done: + description: >- + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + type: boolean + error: + description: >- + The error result of the operation in case of failure or + cancellation. + $ref: '#/components/schemas/Status' + response: + description: >- + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + Status: + id: Status + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + type: object + properties: + code: + description: The status code, which should be an enum value of google.rpc.Code. + type: integer + format: int32 + message: + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + type: string + details: + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + type: array + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + Empty: + id: Empty + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + type: object + properties: {} + CancelOperationRequest: + id: CancelOperationRequest + description: The request message for Operations.CancelOperation. + type: object + properties: {} + ListInstancesResponse: + id: ListInstancesResponse + type: object + properties: + instances: + description: The list of instances. + type: array + items: + $ref: '#/components/schemas/Instance' + nextPageToken: + description: A token identifying a page of results the server should return. + type: string + unreachable: + description: Locations that could not be reached. + type: array + items: + type: string + Instance: + id: Instance + description: A resource that represents a Secure Source Manager instance. + type: object + properties: + name: + description: >- + Optional. A unique identifier for an instance. The name should be of + the format: + `projects/{project_number}/locations/{location_id}/instances/{instance_id}` + `project_number`: Maps to a unique int64 id assigned to each + project. `location_id`: Refers to the region where the instance will + be deployed. Since Secure Source Manager is a regional service, it + must be one of the valid GCP regions. `instance_id`: User provided + name for the instance, must be unique for a project_number and + location_id combination. + type: string + createTime: + description: Output only. Create timestamp. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. Update timestamp. + readOnly: true + type: string + format: google-datetime + labels: + description: Optional. Labels as key value pairs. + type: object + additionalProperties: + type: string + privateConfig: + description: Optional. Private settings for private instance. + $ref: '#/components/schemas/PrivateConfig' + state: + description: Output only. Current state of the instance. + readOnly: true + type: string + enumDescriptions: + - Not set. This should only be the case for incoming requests. + - Instance is being created. + - Instance is ready. + - Instance is being deleted. + - Instance is paused. + - Instance is unknown, we are not sure if it's functioning. + enum: + - STATE_UNSPECIFIED + - CREATING + - ACTIVE + - DELETING + - PAUSED + - UNKNOWN + stateNote: + description: >- + Output only. An optional field providing information about the + current instance state. + readOnly: true + type: string + enumDescriptions: + - STATE_NOTE_UNSPECIFIED as the first value of State. + - CMEK access is unavailable. + - >- + INSTANCE_RESUMING indicates that the instance was previously + paused and is under the process of being brought back. + enumDeprecated: + - false + - false + - true + enum: + - STATE_NOTE_UNSPECIFIED + - PAUSED_CMEK_UNAVAILABLE + - INSTANCE_RESUMING + kmsKey: + description: >- + Optional. Immutable. Customer-managed encryption key name, in the + format projects/*/locations/*/keyRings/*/cryptoKeys/*. + type: string + hostConfig: + description: Output only. A list of hostnames for this instance. + readOnly: true + $ref: '#/components/schemas/HostConfig' + workforceIdentityFederationConfig: + description: >- + Optional. Configuration for Workforce Identity Federation to support + third party identity provider. If unset, defaults to the Google OIDC + IdP. + $ref: '#/components/schemas/WorkforceIdentityFederationConfig' + PrivateConfig: + id: PrivateConfig + description: PrivateConfig includes settings for private instance. + type: object + properties: + isPrivate: + description: Required. Immutable. Indicate if it's private instance. + type: boolean + caPool: + description: >- + Optional. Immutable. CA pool resource, resource must in the format + of `projects/{project}/locations/{location}/caPools/{ca_pool}`. + type: string + httpServiceAttachment: + description: >- + Output only. Service Attachment for HTTP, resource is in the format + of + `projects/{project}/regions/{region}/serviceAttachments/{service_attachment}`. + readOnly: true + type: string + sshServiceAttachment: + description: >- + Output only. Service Attachment for SSH, resource is in the format + of + `projects/{project}/regions/{region}/serviceAttachments/{service_attachment}`. + readOnly: true + type: string + pscAllowedProjects: + description: >- + Optional. Additional allowed projects for setting up PSC + connections. Instance host project is automatically allowed and does + not need to be included in this list. + type: array + items: + type: string + HostConfig: + id: HostConfig + description: HostConfig has different instance endpoints. + type: object + properties: + html: + description: Output only. HTML hostname. + readOnly: true + type: string + api: + description: Output only. API hostname. + readOnly: true + type: string + gitHttp: + description: Output only. Git HTTP hostname. + readOnly: true + type: string + gitSsh: + description: Output only. Git SSH hostname. + readOnly: true + type: string + WorkforceIdentityFederationConfig: + id: WorkforceIdentityFederationConfig + description: >- + WorkforceIdentityFederationConfig allows this instance to support users + from external identity providers. + type: object + properties: + enabled: + description: >- + Optional. Immutable. Whether Workforce Identity Federation is + enabled. + type: boolean + ListRepositoriesResponse: + id: ListRepositoriesResponse + type: object + properties: + repositories: + description: The list of repositories. + type: array + items: + $ref: '#/components/schemas/Repository' + nextPageToken: + description: A token identifying a page of results the server should return. + type: string + Repository: + id: Repository + description: Metadata of a Secure Source Manager repository. + type: object + properties: + name: + description: >- + Optional. A unique identifier for a repository. The name should be + of the format: + `projects/{project}/locations/{location_id}/repositories/{repository_id}` + type: string + description: + description: >- + Optional. Description of the repository, which cannot exceed 500 + characters. + type: string + instance: + description: >- + Optional. The name of the instance in which the repository is + hosted, formatted as + `projects/{project_number}/locations/{location_id}/instances/{instance_id}` + When creating repository via securesourcemanager.googleapis.com, + this field is used as input. When creating repository via + *.sourcemanager.dev, this field is output only. + type: string + uid: + description: Output only. Unique identifier of the repository. + readOnly: true + type: string + createTime: + description: Output only. Create timestamp. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. Update timestamp. + readOnly: true + type: string + format: google-datetime + etag: + description: >- + Optional. This checksum is computed by the server based on the value + of other fields, and may be sent on update and delete requests to + ensure the client has an up-to-date value before proceeding. + type: string + uris: + description: Output only. URIs for the repository. + readOnly: true + $ref: '#/components/schemas/URIs' + initialConfig: + description: Input only. Initial configurations for the repository. + $ref: '#/components/schemas/InitialConfig' + URIs: + id: URIs + description: URIs for the repository. + type: object + properties: + html: + description: >- + Output only. HTML is the URI for user to view the repository in a + browser. + readOnly: true + type: string + gitHttps: + description: Output only. git_https is the git HTTPS URI for git operations. + readOnly: true + type: string + api: + description: Output only. API is the URI for API access. + readOnly: true + type: string + InitialConfig: + id: InitialConfig + description: Repository initialization configuration. + type: object + properties: + defaultBranch: + description: Default branch name of the repository. + type: string + gitignores: + description: >- + List of gitignore template names user can choose from. Valid values: + actionscript, ada, agda, android, anjuta, ansible, + appcelerator-titanium, app-engine, archives, arch-linux-packages, + atmel-studio, autotools, backup, bazaar, bazel, bitrix, bricx-cc, c, + cake-php, calabash, cf-wheels, chef-cookbook, clojure, cloud9, + c-make, code-igniter, code-kit, code-sniffer, common-lisp, composer, + concrete5, coq, cordova, cpp, craft-cms, cuda, cvs, d, dart, + dart-editor, delphi, diff, dm, dreamweaver, dropbox, drupal, + drupal-7, eagle, eclipse, eiffel-studio, elisp, elixir, elm, emacs, + ensime, epi-server, erlang, esp-idf, espresso, exercism, + expression-engine, ext-js, fancy, finale, flex-builder, + force-dot-com, fortran, fuel-php, gcov, git-book, + gnome-shell-extension, go, godot, gpg, gradle, grails, gwt, haskell, + hugo, iar-ewarm, idris, igor-pro, images, infor-cms, java, jboss, + jboss-4, jboss-6, jdeveloper, jekyll, jenkins-home, jenv, + jet-brains, jigsaw, joomla, julia, jupyter-notebooks, kate, + kdevelop4, kentico, ki-cad, kohana, kotlin, lab-view, laravel, + lazarus, leiningen, lemon-stand, libre-office, lilypond, linux, + lithium, logtalk, lua, lyx, mac-os, magento, magento-1, magento-2, + matlab, maven, mercurial, mercury, metals, meta-programming-system, + meteor, microsoft-office, model-sim, momentics, mono-develop, nanoc, + net-beans, nikola, nim, ninja, node, notepad-pp, nwjs, objective--c, + ocaml, octave, opa, open-cart, openssl, oracle-forms, otto, packer, + patch, perl, perl6, phalcon, phoenix, pimcore, play-framework, + plone, prestashop, processing, psoc-creator, puppet, pure-script, + putty, python, qooxdoo, qt, r, racket, rails, raku, red, redcar, + redis, rhodes-rhomobile, ros, ruby, rust, sam, sass, sbt, scala, + scheme, scons, scrivener, sdcc, seam-gen, sketch-up, slick-edit, + smalltalk, snap, splunk, stata, stella, sublime-text, sugar-crm, + svn, swift, symfony, symphony-cms, synopsys-vcs, tags, terraform, + tex, text-mate, textpattern, think-php, tortoise-git, turbo-gears-2, + typo3, umbraco, unity, unreal-engine, vagrant, vim, virtual-env, + virtuoso, visual-studio, visual-studio-code, vue, vvvv, waf, + web-methods, windows, word-press, xcode, xilinx, xilinx-ise, xojo, + yeoman, yii, zend-framework, zephir. + type: array + items: + type: string + license: + description: >- + License template name user can choose from. Valid values: + license-0bsd, license-389-exception, aal, abstyles, adobe-2006, + adobe-glyph, adsl, afl-1-1, afl-1-2, afl-2-0, afl-2-1, afl-3-0, + afmparse, agpl-1-0, agpl-1-0-only, agpl-1-0-or-later, agpl-3-0-only, + agpl-3-0-or-later, aladdin, amdplpa, aml, ampas, antlr-pd, + antlr-pd-fallback, apache-1-0, apache-1-1, apache-2-0, apafml, + apl-1-0, apsl-1-0, apsl-1-1, apsl-1-2, apsl-2-0, artistic-1-0, + artistic-1-0-cl8, artistic-1-0-perl, artistic-2-0, + autoconf-exception-2-0, autoconf-exception-3-0, bahyph, barr, + beerware, bison-exception-2-2, bittorrent-1-0, bittorrent-1-1, + blessing, blueoak-1-0-0, bootloader-exception, borceux, + bsd-1-clause, bsd-2-clause, bsd-2-clause-freebsd, + bsd-2-clause-netbsd, bsd-2-clause-patent, bsd-2-clause-views, + bsd-3-clause, bsd-3-clause-attribution, bsd-3-clause-clear, + bsd-3-clause-lbnl, bsd-3-clause-modification, + bsd-3-clause-no-nuclear-license, + bsd-3-clause-no-nuclear-license-2014, + bsd-3-clause-no-nuclear-warranty, bsd-3-clause-open-mpi, + bsd-4-clause, bsd-4-clause-shortened, bsd-4-clause-uc, + bsd-protection, bsd-source-code, bsl-1-0, busl-1-1, cal-1-0, + cal-1-0-combined-work-exception, caldera, catosl-1-1, cc0-1-0, + cc-by-1-0, cc-by-2-0, cc-by-3-0, cc-by-3-0-at, cc-by-3-0-us, + cc-by-4-0, cc-by-nc-1-0, cc-by-nc-2-0, cc-by-nc-3-0, cc-by-nc-4-0, + cc-by-nc-nd-1-0, cc-by-nc-nd-2-0, cc-by-nc-nd-3-0, + cc-by-nc-nd-3-0-igo, cc-by-nc-nd-4-0, cc-by-nc-sa-1-0, + cc-by-nc-sa-2-0, cc-by-nc-sa-3-0, cc-by-nc-sa-4-0, cc-by-nd-1-0, + cc-by-nd-2-0, cc-by-nd-3-0, cc-by-nd-4-0, cc-by-sa-1-0, + cc-by-sa-2-0, cc-by-sa-2-0-uk, cc-by-sa-2-1-jp, cc-by-sa-3-0, + cc-by-sa-3-0-at, cc-by-sa-4-0, cc-pddc, cddl-1-0, cddl-1-1, + cdla-permissive-1-0, cdla-sharing-1-0, cecill-1-0, cecill-1-1, + cecill-2-0, cecill-2-1, cecill-b, cecill-c, cern-ohl-1-1, + cern-ohl-1-2, cern-ohl-p-2-0, cern-ohl-s-2-0, cern-ohl-w-2-0, + clartistic, classpath-exception-2-0, clisp-exception-2-0, + cnri-jython, cnri-python, cnri-python-gpl-compatible, condor-1-1, + copyleft-next-0-3-0, copyleft-next-0-3-1, cpal-1-0, cpl-1-0, + cpol-1-02, crossword, crystal-stacker, cua-opl-1-0, cube, c-uda-1-0, + curl, d-fsl-1-0, diffmark, digirule-foss-exception, doc, dotseqn, + drl-1-0, dsdp, dvipdfm, ecl-1-0, ecl-2-0, ecos-exception-2-0, + efl-1-0, efl-2-0, egenix, entessa, epics, epl-1-0, epl-2-0, + erlpl-1-1, etalab-2-0, eu-datagrid, eupl-1-0, eupl-1-1, eupl-1-2, + eurosym, fair, fawkes-runtime-exception, fltk-exception, + font-exception-2-0, frameworx-1-0, freebsd-doc, freeimage, + freertos-exception-2-0, fsfap, fsful, fsfullr, ftl, + gcc-exception-2-0, gcc-exception-3-1, gd, gfdl-1-1-invariants-only, + gfdl-1-1-invariants-or-later, gfdl-1-1-no-invariants-only, + gfdl-1-1-no-invariants-or-later, gfdl-1-1-only, gfdl-1-1-or-later, + gfdl-1-2-invariants-only, gfdl-1-2-invariants-or-later, + gfdl-1-2-no-invariants-only, gfdl-1-2-no-invariants-or-later, + gfdl-1-2-only, gfdl-1-2-or-later, gfdl-1-3-invariants-only, + gfdl-1-3-invariants-or-later, gfdl-1-3-no-invariants-only, + gfdl-1-3-no-invariants-or-later, gfdl-1-3-only, gfdl-1-3-or-later, + giftware, gl2ps, glide, glulxe, glwtpl, gnu-javamail-exception, + gnuplot, gpl-1-0-only, gpl-1-0-or-later, gpl-2-0-only, + gpl-2-0-or-later, gpl-3-0-linking-exception, + gpl-3-0-linking-source-exception, gpl-3-0-only, gpl-3-0-or-later, + gpl-cc-1-0, gsoap-1-3b, haskell-report, hippocratic-2-1, hpnd, + hpnd-sell-variant, htmltidy, i2p-gpl-java-exception, ibm-pibs, icu, + ijg, image-magick, imatix, imlib2, info-zip, intel, intel-acpi, + interbase-1-0, ipa, ipl-1-0, isc, jasper-2-0, jpnic, json, lal-1-2, + lal-1-3, latex2e, leptonica, lgpl-2-0-only, lgpl-2-0-or-later, + lgpl-2-1-only, lgpl-2-1-or-later, lgpl-3-0-linking-exception, + lgpl-3-0-only, lgpl-3-0-or-later, lgpllr, libpng, libpng-2-0, + libselinux-1-0, libtiff, libtool-exception, liliq-p-1-1, + liliq-r-1-1, liliq-rplus-1-1, linux-openib, linux-syscall-note, + llvm-exception, lpl-1-0, lpl-1-02, lppl-1-0, lppl-1-1, lppl-1-2, + lppl-1-3a, lppl-1-3c, lzma-exception, make-index, mif-exception, + miros, mit, mit-0, mit-advertising, mit-cmu, mit-enna, mit-feh, + mit-modern-variant, mitnfa, mit-open-group, motosoto, mpich2, + mpl-1-0, mpl-1-1, mpl-2-0, mpl-2-0-no-copyleft-exception, ms-pl, + ms-rl, mtll, mulanpsl-1-0, mulanpsl-2-0, multics, mup, naist-2003, + nasa-1-3, naumen, nbpl-1-0, ncgl-uk-2-0, ncsa, netcdf, net-snmp, + newsletr, ngpl, nist-pd, nist-pd-fallback, nlod-1-0, nlpl, nokia, + nokia-qt-exception-1-1, nosl, noweb, npl-1-0, npl-1-1, nposl-3-0, + nrl, ntp, ntp-0, ocaml-lgpl-linking-exception, occt-exception-1-0, + occt-pl, oclc-2-0, odbl-1-0, odc-by-1-0, ofl-1-0, ofl-1-0-no-rfn, + ofl-1-0-rfn, ofl-1-1, ofl-1-1-no-rfn, ofl-1-1-rfn, ogc-1-0, + ogdl-taiwan-1-0, ogl-canada-2-0, ogl-uk-1-0, ogl-uk-2-0, ogl-uk-3-0, + ogtsl, oldap-1-1, oldap-1-2, oldap-1-3, oldap-1-4, oldap-2-0, + oldap-2-0-1, oldap-2-1, oldap-2-2, oldap-2-2-1, oldap-2-2-2, + oldap-2-3, oldap-2-4, oldap-2-7, oml, + openjdk-assembly-exception-1-0, openssl, openvpn-openssl-exception, + opl-1-0, oset-pl-2-1, osl-1-0, osl-1-1, osl-2-0, osl-2-1, osl-3-0, + o-uda-1-0, parity-6-0-0, parity-7-0-0, pddl-1-0, php-3-0, php-3-01, + plexus, polyform-noncommercial-1-0-0, polyform-small-business-1-0-0, + postgresql, psf-2-0, psfrag, ps-or-pdf-font-exception-20170817, + psutils, python-2-0, qhull, qpl-1-0, qt-gpl-exception-1-0, + qt-lgpl-exception-1-1, qwt-exception-1-0, rdisc, rhecos-1-1, + rpl-1-1, rpsl-1-0, rsa-md, rscpl, ruby, saxpath, sax-pd, scea, + sendmail, sendmail-8-23, sgi-b-1-0, sgi-b-1-1, sgi-b-2-0, shl-0-51, + shl-2-0, shl-2-1, simpl-2-0, sissl, sissl-1-2, sleepycat, smlnj, + smppl, snia, spencer-86, spencer-94, spencer-99, spl-1-0, + ssh-openssh, ssh-short, sspl-1-0, sugarcrm-1-1-3, swift-exception, + swl, tapr-ohl-1-0, tcl, tcp-wrappers, tmate, torque-1-1, tosl, + tu-berlin-1-0, tu-berlin-2-0, u-boot-exception-2-0, ucl-1-0, + unicode-dfs-2015, unicode-dfs-2016, unicode-tou, + universal-foss-exception-1-0, unlicense, upl-1-0, vim, vostrom, + vsl-1-0, w3c, w3c-19980720, w3c-20150513, watcom-1-0, wsuipa, wtfpl, + wxwindows-exception-3-1, x11, xerox, xfree86-1-1, xinetd, xnet, xpp, + xskat, ypl-1-0, ypl-1-1, zed, zend-2-0, zimbra-1-3, zimbra-1-4, + zlib, zlib-acknowledgement, zpl-1-1, zpl-2-0, zpl-2-1. + type: string + readme: + description: 'README template name. Valid template name(s) are: default.' + type: string + ListHooksResponse: + id: ListHooksResponse + description: ListHooksResponse is response to list hooks. + type: object + properties: + hooks: + description: The list of hooks. + type: array + items: + $ref: '#/components/schemas/Hook' + nextPageToken: + description: A token identifying a page of results the server should return. + type: string + Hook: + id: Hook + description: Metadata of a Secure Source Manager Hook. + type: object + properties: + name: + description: >- + Identifier. A unique identifier for a Hook. The name should be of + the format: + `projects/{project}/locations/{location_id}/repositories/{repository_id}/hooks/{hook_id}` + type: string + targetUri: + description: Required. The target URI to which the payloads will be delivered. + type: string + disabled: + description: >- + Optional. Determines if the hook disabled or not. Set to true to + stop sending traffic. + type: boolean + events: + description: Optional. The events that trigger hook on. + type: array + items: + type: string + enumDescriptions: + - Unspecified. + - Push events are triggered when pushing to the repository. + - >- + Pull request events are triggered when a pull request is opened, + closed, reopened, or edited. + enum: + - UNSPECIFIED + - PUSH + - PULL_REQUEST + createTime: + description: Output only. Create timestamp. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. Update timestamp. + readOnly: true + type: string + format: google-datetime + uid: + description: Output only. Unique identifier of the hook. + readOnly: true + type: string + pushOption: + description: Optional. The trigger option for push events. + $ref: '#/components/schemas/PushOption' + sensitiveQueryString: + description: >- + Optional. The sensitive query string to be appended to the target + URI. + type: string + PushOption: + id: PushOption + type: object + properties: + branchFilter: + description: >- + Optional. Trigger hook for matching branches only. Specified as glob + pattern. If empty or *, events for all branches are reported. + Examples: main, {main,release*}. See + https://pkg.go.dev/github.com/gobwas/glob documentation. + type: string + BranchRule: + id: BranchRule + description: >- + Metadata of a BranchRule. BranchRule is the protection rule to enforce + pre-defined rules on designated branches within a repository. + type: object + properties: + name: + description: >- + Optional. A unique identifier for a BranchRule. The name should be + of the format: + `projects/{project}/locations/{location}/repositories/{repository}/branchRules/{branch_rule}` + type: string + uid: + description: Output only. Unique identifier of the repository. + readOnly: true + type: string + createTime: + description: Output only. Create timestamp. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. Update timestamp. + readOnly: true + type: string + format: google-datetime + annotations: + description: >- + Optional. User annotations. These attributes can only be set and + used by the user. See https://google.aip.dev/128#annotations for + more details such as format and size limitations. + type: object + additionalProperties: + type: string + etag: + description: >- + Optional. This checksum is computed by the server based on the value + of other fields, and may be sent on update and delete requests to + ensure the client has an up-to-date value before proceeding. + type: string + includePattern: + description: >- + Optional. The pattern of the branch that can match to this + BranchRule. Specified as regex. .* for all branches. Examples: main, + (main|release.*). Current MVP phase only support `.*` for wildcard. + type: string + disabled: + description: Optional. Determines if the branch rule is disabled or not. + type: boolean + requirePullRequest: + description: >- + Optional. Determines if the branch rule requires a pull request or + not. + type: boolean + minimumReviewsCount: + description: >- + Optional. The minimum number of reviews required for the branch rule + to be matched. + type: integer + format: int32 + minimumApprovalsCount: + description: >- + Optional. The minimum number of approvals required for the branch + rule to be matched. + type: integer + format: int32 + requireCommentsResolved: + description: >- + Optional. Determines if require comments resolved before merging to + the branch. + type: boolean + allowStaleReviews: + description: >- + Optional. Determines if allow stale reviews or approvals before + merging to the branch. + type: boolean + requireLinearHistory: + description: >- + Optional. Determines if require linear history before merging to the + branch. + type: boolean + requiredStatusChecks: + description: >- + Optional. List of required status checks before merging to the + branch. + type: array + items: + $ref: '#/components/schemas/Check' + Check: + id: Check + description: Check is a type for status check. + type: object + properties: + context: + description: Required. The context of the check. + type: string + ListBranchRulesResponse: + id: ListBranchRulesResponse + description: ListBranchRulesResponse is the response to listing branchRules. + type: object + properties: + branchRules: + description: The list of branch rules. + type: array + items: + $ref: '#/components/schemas/BranchRule' + nextPageToken: + description: A token identifying a page of results the server should return. + type: string + PullRequest: + id: PullRequest + description: >- + Metadata of a PullRequest. PullRequest is the request from a user to + merge a branch (head) into another branch (base). + type: object + properties: + name: + description: >- + Output only. A unique identifier for a PullRequest. The number + appended at the end is generated by the server. Format: + `projects/{project}/locations/{location}/repositories/{repository}/pullRequests/{pull_request_id}` + readOnly: true + type: string + title: + description: Required. The pull request title. + type: string + body: + description: >- + Optional. The pull request body. Provides a detailed description of + the changes. + type: string + base: + description: Required. The branch to merge changes in. + $ref: '#/components/schemas/Branch' + head: + description: Immutable. The branch containing the changes to be merged. + $ref: '#/components/schemas/Branch' + state: + description: Output only. State of the pull request (open, closed or merged). + readOnly: true + type: string + enumDescriptions: + - Unspecified. + - An open pull request. + - A closed pull request. + - A merged pull request. + enum: + - STATE_UNSPECIFIED + - OPEN + - CLOSED + - MERGED + createTime: + description: Output only. Creation timestamp. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. Last updated timestamp. + readOnly: true + type: string + format: google-datetime + closeTime: + description: >- + Output only. Close timestamp (if closed or merged). Cleared when + pull request is re-opened. + readOnly: true + type: string + format: google-datetime + Branch: + id: Branch + description: Branch represents a branch involved in a pull request. + type: object + properties: + ref: + description: Required. Name of the branch. + type: string + sha: + description: Output only. The commit at the tip of the branch. + readOnly: true + type: string + ListPullRequestsResponse: + id: ListPullRequestsResponse + description: ListPullRequestsResponse is the response to list pull requests. + type: object + properties: + pullRequests: + description: The list of pull requests. + type: array + items: + $ref: '#/components/schemas/PullRequest' + nextPageToken: + description: A token identifying a page of results the server should return. + type: string + MergePullRequestRequest: + id: MergePullRequestRequest + description: MergePullRequestRequest is the request to merge a pull request. + type: object + properties: {} + OpenPullRequestRequest: + id: OpenPullRequestRequest + description: OpenPullRequestRequest is the request to open a pull request. + type: object + properties: {} + ClosePullRequestRequest: + id: ClosePullRequestRequest + description: ClosePullRequestRequest is the request to close a pull request. + type: object + properties: {} + ListPullRequestFileDiffsResponse: + id: ListPullRequestFileDiffsResponse + description: >- + ListPullRequestFileDiffsResponse is the response containing file diffs + returned from ListPullRequestFileDiffs. + type: object + properties: + fileDiffs: + description: The list of pull request file diffs. + type: array + items: + $ref: '#/components/schemas/FileDiff' + nextPageToken: + description: A token identifying a page of results the server should return. + type: string + FileDiff: + id: FileDiff + description: >- + Metadata of a FileDiff. FileDiff represents a single file diff in a pull + request. + type: object + properties: + name: + description: Output only. The name of the file. + readOnly: true + type: string + action: + description: >- + Output only. The action taken on the file (eg. added, modified, + deleted). + readOnly: true + type: string + enumDescriptions: + - Unspecified. + - The file was added. + - The file was modified. + - The file was deleted. + enum: + - ACTION_UNSPECIFIED + - ADDED + - MODIFIED + - DELETED + sha: + description: Output only. The commit pointing to the file changes. + readOnly: true + type: string + patch: + description: Output only. The git patch containing the file changes. + readOnly: true + type: string + FetchTreeResponse: + id: FetchTreeResponse + description: Response message containing a list of TreeEntry objects. + type: object + properties: + treeEntries: + description: The list of TreeEntry objects. + type: array + items: + $ref: '#/components/schemas/TreeEntry' + nextPageToken: + description: A token identifying a page of results the server should return. + type: string + TreeEntry: + id: TreeEntry + description: Represents an entry within a tree structure (like a Git tree). + type: object + properties: + type: + description: >- + Output only. The type of the object (TREE, BLOB, COMMIT). + Output-only. + readOnly: true + type: string + enumDescriptions: + - Default value, indicating the object type is unspecified. + - Represents a directory (folder). + - Represents a file (contains file data). + - Represents a pointer to another repository (submodule). + enum: + - OBJECT_TYPE_UNSPECIFIED + - TREE + - BLOB + - COMMIT + sha: + description: >- + Output only. The SHA-1 hash of the object (unique identifier). + Output-only. + readOnly: true + type: string + path: + description: >- + Output only. The path of the file or directory within the tree + (e.g., "src/main/java/MyClass.java"). Output-only. + readOnly: true + type: string + mode: + description: >- + Output only. The file mode as a string (e.g., "100644"). Indicates + file type. Output-only. + readOnly: true + type: string + size: + description: >- + Output only. The size of the object in bytes (only for blobs). + Output-only. + readOnly: true + type: string + format: int64 + FetchBlobResponse: + id: FetchBlobResponse + description: Response message containing the content of a blob. + type: object + properties: + sha: + description: The SHA-1 hash of the blob. + type: string + content: + description: The content of the blob, encoded as base64. + type: string + Issue: + id: Issue + description: Metadata of an Issue. + type: object + properties: + name: + description: >- + Identifier. Unique identifier for an issue. The issue id is + generated by the server. Format: + `projects/{project}/locations/{location}/repositories/{repository}/issues/{issue_id}` + type: string + title: + description: Required. Issue title. + type: string + body: + description: Optional. Issue body. Provides a detailed description of the issue. + type: string + state: + description: Output only. State of the issue. + readOnly: true + type: string + enumDescriptions: + - Unspecified. + - An open issue. + - A closed issue. + enum: + - STATE_UNSPECIFIED + - OPEN + - CLOSED + createTime: + description: Output only. Creation timestamp. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. Last updated timestamp. + readOnly: true + type: string + format: google-datetime + closeTime: + description: Output only. Close timestamp (if closed). Cleared when is re-opened. + readOnly: true + type: string + format: google-datetime + etag: + description: >- + Optional. This checksum is computed by the server based on the value + of other fields, and may be sent on update and delete requests to + ensure the client has an up-to-date value before proceeding. + type: string + ListIssuesResponse: + id: ListIssuesResponse + description: The response to list issues. + type: object + properties: + issues: + description: The list of issues. + type: array + items: + $ref: '#/components/schemas/Issue' + nextPageToken: + description: A token identifying a page of results the server should return. + type: string + OpenIssueRequest: + id: OpenIssueRequest + description: The request to open an issue. + type: object + properties: + etag: + description: >- + Optional. The current etag of the issue. If the etag is provided and + does not match the current etag of the issue, opening will be + blocked and an ABORTED error will be returned. + type: string + CloseIssueRequest: + id: CloseIssueRequest + description: The request to close an issue. + type: object + properties: + etag: + description: >- + Optional. The current etag of the issue. If the etag is provided and + does not match the current etag of the issue, closing will be + blocked and an ABORTED error will be returned. + type: string + PullRequestComment: + id: PullRequestComment + description: PullRequestComment represents a comment on a pull request. + type: object + properties: + name: + description: >- + Identifier. Unique identifier for the pull request comment. The + comment id is generated by the server. Format: + `projects/{project}/locations/{location}/repositories/{repository}/pullRequests/{pull_request}/pullRequestComments/{comment_id}` + type: string + createTime: + description: Output only. Creation timestamp. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. Last updated timestamp. + readOnly: true + type: string + format: google-datetime + review: + description: Optional. The review summary comment. + $ref: '#/components/schemas/Review' + comment: + description: Optional. The general pull request comment. + $ref: '#/components/schemas/Comment' + code: + description: Optional. The comment on a code line. + $ref: '#/components/schemas/Code' + Review: + id: Review + description: The review summary comment. + type: object + properties: + actionType: + description: Required. The review action type. + type: string + enumDescriptions: + - Unspecified. + - A general review comment. + - Change required from this review. + - Change approved from this review. + enum: + - ACTION_TYPE_UNSPECIFIED + - COMMENT + - CHANGE_REQUESTED + - APPROVED + body: + description: Optional. The comment body. + type: string + effectiveCommitSha: + description: Output only. The effective commit sha this review is pointing to. + readOnly: true + type: string + Comment: + id: Comment + description: The general pull request comment. + type: object + properties: + body: + description: Required. The comment body. + type: string + Code: + id: Code + description: The comment on a code line. + type: object + properties: + body: + description: Required. The comment body. + type: string + reply: + description: >- + Optional. Input only. The PullRequestComment resource name that this + comment is replying to. + type: string + position: + description: Optional. The position of the comment. + $ref: '#/components/schemas/Position' + effectiveRootComment: + description: >- + Output only. The root comment of the conversation, derived from the + reply field. + readOnly: true + type: string + resolved: + description: Output only. Boolean indicator if the comment is resolved. + readOnly: true + type: boolean + effectiveCommitSha: + description: >- + Output only. The effective commit sha this code comment is pointing + to. + readOnly: true + type: string + Position: + id: Position + description: The position of the code comment. + type: object + properties: + path: + description: Required. The path of the file. + type: string + line: + description: >- + Required. The line number of the comment. Positive value means it's + on the new side of the diff, negative value means it's on the old + side. + type: string + format: int64 + ListPullRequestCommentsResponse: + id: ListPullRequestCommentsResponse + description: The response to list pull request comments. + type: object + properties: + pullRequestComments: + description: The list of pull request comments. + type: array + items: + $ref: '#/components/schemas/PullRequestComment' + nextPageToken: + description: >- + A token to set as page_token to retrieve the next page. If this + field is omitted, there are no subsequent pages. + type: string + BatchCreatePullRequestCommentsRequest: + id: BatchCreatePullRequestCommentsRequest + description: The request to batch create pull request comments. + type: object + properties: + requests: + description: >- + Required. The request message specifying the resources to create. + There should be exactly one CreatePullRequestCommentRequest with + CommentDetail being REVIEW in the list, and no more than 100 + CreatePullRequestCommentRequests with CommentDetail being CODE in + the list + type: array + items: + $ref: '#/components/schemas/CreatePullRequestCommentRequest' + CreatePullRequestCommentRequest: + id: CreatePullRequestCommentRequest + description: The request to create a pull request comment. + type: object + properties: + parent: + description: >- + Required. The pull request in which to create the pull request + comment. Format: + `projects/{project_number}/locations/{location_id}/repositories/{repository_id}/pullRequests/{pull_request_id}` + type: string + pullRequestComment: + description: Required. The pull request comment to create. + $ref: '#/components/schemas/PullRequestComment' + ResolvePullRequestCommentsRequest: + id: ResolvePullRequestCommentsRequest + description: The request to resolve multiple pull request comments. + type: object + properties: + names: + description: >- + Required. The names of the pull request comments to resolve. Format: + `projects/{project_number}/locations/{location_id}/repositories/{repository_id}/pullRequests/{pull_request_id}/pullRequestComments/{comment_id}` + Only comments from the same threads are allowed in the same request. + type: array + items: + type: string + autoFill: + description: >- + Optional. If set, at least one comment in a thread is required, rest + of the comments in the same thread will be automatically updated to + resolved. If unset, all comments in the same thread need be present. + type: boolean + UnresolvePullRequestCommentsRequest: + id: UnresolvePullRequestCommentsRequest + description: The request to unresolve multiple pull request comments. + type: object + properties: + names: + description: >- + Required. The names of the pull request comments to unresolve. + Format: + `projects/{project_number}/locations/{location_id}/repositories/{repository_id}/pullRequests/{pull_request_id}/pullRequestComments/{comment_id}` + Only comments from the same threads are allowed in the same request. + type: array + items: + type: string + autoFill: + description: >- + Optional. If set, at least one comment in a thread is required, rest + of the comments in the same thread will be automatically updated to + unresolved. If unset, all comments in the same thread need be + present. + type: boolean + IssueComment: + id: IssueComment + description: IssueComment represents a comment on an issue. + type: object + properties: + name: + description: >- + Identifier. Unique identifier for an issue comment. The comment id + is generated by the server. Format: + `projects/{project}/locations/{location}/repositories/{repository}/issues/{issue}/issueComments/{comment_id}` + type: string + body: + description: Required. The comment body. + type: string + createTime: + description: Output only. Creation timestamp. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. Last updated timestamp. + readOnly: true + type: string + format: google-datetime + ListIssueCommentsResponse: + id: ListIssueCommentsResponse + description: The response to list issue comments. + type: object + properties: + issueComments: + description: The list of issue comments. + type: array + items: + $ref: '#/components/schemas/IssueComment' + nextPageToken: + description: A token identifying a page of results the server should return. + type: string + OperationMetadata: + id: OperationMetadata + description: Represents the metadata of the long-running operation. + type: object + properties: + createTime: + description: Output only. The time the operation was created. + readOnly: true + type: string + format: google-datetime + endTime: + description: Output only. The time the operation finished running. + readOnly: true + type: string + format: google-datetime + target: + description: >- + Output only. Server-defined resource path for the target of the + operation. + readOnly: true + type: string + verb: + description: Output only. Name of the verb executed by the operation. + readOnly: true + type: string + statusMessage: + description: Output only. Human-readable status of the operation, if any. + readOnly: true + type: string + requestedCancellation: + description: >- + Output only. Identifies whether the user has requested cancellation + of the operation. Operations that have successfully been cancelled + have Operation.error value with a google.rpc.Status.code of 1, + corresponding to `Code.CANCELLED`. + readOnly: true + type: boolean + apiVersion: + description: Output only. API version used to start the operation. + readOnly: true + type: string + BatchCreatePullRequestCommentsResponse: + id: BatchCreatePullRequestCommentsResponse + description: The response to batch create pull request comments. + type: object + properties: + pullRequestComments: + description: The list of pull request comments created. + type: array + items: + $ref: '#/components/schemas/PullRequestComment' + ResolvePullRequestCommentsResponse: + id: ResolvePullRequestCommentsResponse + description: The response to resolve multiple pull request comments. + type: object + properties: + pullRequestComments: + description: The list of pull request comments resolved. + type: array + items: + $ref: '#/components/schemas/PullRequestComment' + UnresolvePullRequestCommentsResponse: + id: UnresolvePullRequestCommentsResponse + description: The response to unresolve multiple pull request comments. + type: object + properties: + pullRequestComments: + description: The list of pull request comments unresolved. + type: array + items: + $ref: '#/components/schemas/PullRequestComment' + parameters: + 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: + type: string + enum: + - json + - media + - proto + 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 + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + x-stackQL-resources: + locations: + id: google.securesourcemanager.locations + name: locations + title: Locations + methods: + list: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.locations + get: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + instances_iam_policies: + id: google.securesourcemanager.instances_iam_policies + name: instances_iam_policies + title: Instances_iam_policies + methods: + set_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1instances~1{instancesId}:setIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + get_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1instances~1{instancesId}:getIamPolicy/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.bindings + test_iam_permissions: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1instances~1{instancesId}:testIamPermissions/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/instances_iam_policies/methods/get_iam_policy + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/instances_iam_policies/methods/set_iam_policy + delete: [] + instances: + id: google.securesourcemanager.instances + name: instances + title: Instances + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1instances/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.instances + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1instances/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1instances~1{instancesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1instances~1{instancesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/instances/methods/get' + - $ref: '#/components/x-stackQL-resources/instances/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/instances/methods/create' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/instances/methods/delete' + operations: + id: google.securesourcemanager.operations + name: operations + title: Operations + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.operations + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + cancel: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' + insert: [] + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/operations/methods/delete' + repositories: + id: google.securesourcemanager.repositories + name: repositories + title: Repositories + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.repositories + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/repositories/methods/get' + - $ref: '#/components/x-stackQL-resources/repositories/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/repositories/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/repositories/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/repositories/methods/delete' + repositories_iam_policies: + id: google.securesourcemanager.repositories_iam_policies + name: repositories_iam_policies + title: Repositories_iam_policies + methods: + get_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}:getIamPolicy/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.bindings + set_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}:setIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + test_iam_permissions: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}:testIamPermissions/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/repositories_iam_policies/methods/get_iam_policy + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/repositories_iam_policies/methods/set_iam_policy + delete: [] + repositories_tree: + id: google.securesourcemanager.repositories_tree + name: repositories_tree + title: Repositories_tree + methods: + fetch_tree: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}:fetchTree/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/repositories_tree/methods/fetch_tree + insert: [] + update: [] + replace: [] + delete: [] + repositories_blob: + id: google.securesourcemanager.repositories_blob + name: repositories_blob + title: Repositories_blob + methods: + fetch_blob: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}:fetchBlob/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/repositories_blob/methods/fetch_blob + insert: [] + update: [] + replace: [] + delete: [] + hooks: + id: google.securesourcemanager.hooks + name: hooks + title: Hooks + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1hooks/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.hooks + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1hooks/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1hooks~1{hooksId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1hooks~1{hooksId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1hooks~1{hooksId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/hooks/methods/get' + - $ref: '#/components/x-stackQL-resources/hooks/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/hooks/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/hooks/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/hooks/methods/delete' + branch_rules: + id: google.securesourcemanager.branch_rules + name: branch_rules + title: Branch_rules + methods: + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1branchRules/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1branchRules/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.branchRules + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1branchRules~1{branchRulesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1branchRules~1{branchRulesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1branchRules~1{branchRulesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/branch_rules/methods/get' + - $ref: '#/components/x-stackQL-resources/branch_rules/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/branch_rules/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/branch_rules/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/branch_rules/methods/delete' + pull_requests: + id: google.securesourcemanager.pull_requests + name: pull_requests + title: Pull_requests + methods: + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1pullRequests/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1pullRequests/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.pullRequests + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1pullRequests~1{pullRequestsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1pullRequests~1{pullRequestsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + merge: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1pullRequests~1{pullRequestsId}:merge/post + response: + mediaType: application/json + openAPIDocKey: '200' + open: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1pullRequests~1{pullRequestsId}:open/post + response: + mediaType: application/json + openAPIDocKey: '200' + close: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1pullRequests~1{pullRequestsId}:close/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/pull_requests/methods/get' + - $ref: '#/components/x-stackQL-resources/pull_requests/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/pull_requests/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/pull_requests/methods/patch' + replace: [] + delete: [] + pull_requests_file_diffs: + id: google.securesourcemanager.pull_requests_file_diffs + name: pull_requests_file_diffs + title: Pull_requests_file_diffs + methods: + list_file_diffs: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1pullRequests~1{pullRequestsId}:listFileDiffs/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.fileDiffs + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/pull_requests_file_diffs/methods/list_file_diffs + insert: [] + update: [] + replace: [] + delete: [] + pull_request_comments: + id: google.securesourcemanager.pull_request_comments + name: pull_request_comments + title: Pull_request_comments + methods: + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1pullRequests~1{pullRequestsId}~1pullRequestComments~1{pullRequestCommentsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1pullRequests~1{pullRequestsId}~1pullRequestComments~1{pullRequestCommentsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1pullRequests~1{pullRequestsId}~1pullRequestComments~1{pullRequestCommentsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1pullRequests~1{pullRequestsId}~1pullRequestComments/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.pullRequestComments + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1pullRequests~1{pullRequestsId}~1pullRequestComments/post + response: + mediaType: application/json + openAPIDocKey: '200' + batch_create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1pullRequests~1{pullRequestsId}~1pullRequestComments:batchCreate/post + response: + mediaType: application/json + openAPIDocKey: '200' + resolve: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1pullRequests~1{pullRequestsId}~1pullRequestComments:resolve/post + response: + mediaType: application/json + openAPIDocKey: '200' + unresolve: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1pullRequests~1{pullRequestsId}~1pullRequestComments:unresolve/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/pull_request_comments/methods/get' + - $ref: >- + #/components/x-stackQL-resources/pull_request_comments/methods/list + insert: + - $ref: >- + #/components/x-stackQL-resources/pull_request_comments/methods/create + - $ref: >- + #/components/x-stackQL-resources/pull_request_comments/methods/batch_create + update: + - $ref: >- + #/components/x-stackQL-resources/pull_request_comments/methods/patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/pull_request_comments/methods/delete + issues: + id: google.securesourcemanager.issues + name: issues + title: Issues + methods: + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1issues/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1issues/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.issues + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1issues~1{issuesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1issues~1{issuesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1issues~1{issuesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + open: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1issues~1{issuesId}:open/post + response: + mediaType: application/json + openAPIDocKey: '200' + close: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1issues~1{issuesId}:close/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/issues/methods/get' + - $ref: '#/components/x-stackQL-resources/issues/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/issues/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/issues/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/issues/methods/delete' + issue_comments: + id: google.securesourcemanager.issue_comments + name: issue_comments + title: Issue_comments + methods: + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1issues~1{issuesId}~1issueComments/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1issues~1{issuesId}~1issueComments/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.issueComments + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1issues~1{issuesId}~1issueComments~1{issueCommentsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1issues~1{issuesId}~1issueComments~1{issueCommentsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1issues~1{issuesId}~1issueComments~1{issueCommentsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/issue_comments/methods/get' + - $ref: '#/components/x-stackQL-resources/issue_comments/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/issue_comments/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/issue_comments/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/issue_comments/methods/delete' +paths: + /v1/projects/{projectsId}/locations: + parameters: &ref_1 + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' + get: + description: Lists information about the supported locations for this service. + operationId: securesourcemanager.projects.locations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListLocationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: extraLocationTypes + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}: + parameters: *ref_1 + get: + description: Gets information about a location. + operationId: securesourcemanager.projects.locations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Location' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:setIamPolicy: + parameters: *ref_1 + post: + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and + `PERMISSION_DENIED` errors. + operationId: securesourcemanager.projects.locations.instances.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetIamPolicyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:getIamPolicy: + parameters: *ref_1 + get: + description: >- + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: securesourcemanager.projects.locations.instances.getIamPolicy + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + - in: query + name: options.requestedPolicyVersion + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:testIamPermissions: + parameters: *ref_1 + post: + description: >- + Returns permissions that a caller has on the specified resource. If the + resource does not exist, this will return an empty set of permissions, + not a `NOT_FOUND` error. Note: This operation is designed to be used for + building permission-aware UIs and command-line tools, not for + authorization checking. This operation may "fail open" without warning. + operationId: securesourcemanager.projects.locations.instances.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/instances: + parameters: *ref_1 + get: + description: Lists Instances in a given project and location. + operationId: securesourcemanager.projects.locations.instances.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListInstancesResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + post: + description: Creates a new instance in a given project and location. + operationId: securesourcemanager.projects.locations.instances.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Instance' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: instanceId + schema: + type: string + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}: + parameters: *ref_1 + get: + description: Gets details of a single instance. + operationId: securesourcemanager.projects.locations.instances.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Instance' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + delete: + description: Deletes a single instance. + operationId: securesourcemanager.projects.locations.instances.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: securesourcemanager.projects.locations.operations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListOperationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: securesourcemanager.projects.locations.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + delete: + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: securesourcemanager.projects.locations.operations.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + `1`, corresponding to `Code.CANCELLED`. + operationId: securesourcemanager.projects.locations.operations.cancel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CancelOperationRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/repositories: + parameters: *ref_1 + get: + description: >- + Lists Repositories in a given project and location. The instance field + is required in the query parameter for requests using the + securesourcemanager.googleapis.com endpoint. + operationId: securesourcemanager.projects.locations.repositories.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListRepositoriesResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: instance + schema: + type: string + post: + description: >- + Creates a new repository in a given project and location. The + Repository.Instance field is required in the request body for requests + using the securesourcemanager.googleapis.com endpoint. + operationId: securesourcemanager.projects.locations.repositories.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Repository' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: repositoryId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}: + parameters: *ref_1 + get: + description: Gets metadata of a repository. + operationId: securesourcemanager.projects.locations.repositories.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Repository' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: repositoriesId + required: true + schema: + type: string + patch: + description: Updates the metadata of a repository. + operationId: securesourcemanager.projects.locations.repositories.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Repository' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: repositoriesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: validateOnly + schema: + type: boolean + delete: + description: Deletes a Repository. + operationId: securesourcemanager.projects.locations.repositories.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: repositoriesId + required: true + schema: + type: string + - in: query + name: allowMissing + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:getIamPolicy: + parameters: *ref_1 + get: + description: Get IAM policy for a repository. + operationId: securesourcemanager.projects.locations.repositories.getIamPolicy + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: repositoriesId + required: true + schema: + type: string + - in: query + name: options.requestedPolicyVersion + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:setIamPolicy: + parameters: *ref_1 + post: + description: Set IAM policy on a repository. + operationId: securesourcemanager.projects.locations.repositories.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetIamPolicyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: repositoriesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:testIamPermissions: + parameters: *ref_1 + post: + description: >- + Test IAM permissions on a repository. IAM permission checks are not + required on this method. + operationId: securesourcemanager.projects.locations.repositories.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: repositoriesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:fetchTree: + parameters: *ref_1 + get: + description: Fetches a tree from a repository. + operationId: securesourcemanager.projects.locations.repositories.fetchTree + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/FetchTreeResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: repositoriesId + required: true + schema: + type: string + - in: query + name: ref + schema: + type: string + - in: query + name: recursive + schema: + type: boolean + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:fetchBlob: + parameters: *ref_1 + get: + description: Fetches a blob from a repository. + operationId: securesourcemanager.projects.locations.repositories.fetchBlob + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/FetchBlobResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: repositoriesId + required: true + schema: + type: string + - in: query + name: sha + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/hooks: + parameters: *ref_1 + get: + description: Lists hooks in a given repository. + operationId: securesourcemanager.projects.locations.repositories.hooks.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListHooksResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: repositoriesId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + post: + description: Creates a new hook in a given repository. + operationId: securesourcemanager.projects.locations.repositories.hooks.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Hook' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: repositoriesId + required: true + schema: + type: string + - in: query + name: hookId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/hooks/{hooksId}: + parameters: *ref_1 + get: + description: Gets metadata of a hook. + operationId: securesourcemanager.projects.locations.repositories.hooks.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Hook' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: repositoriesId + required: true + schema: + type: string + - in: path + name: hooksId + required: true + schema: + type: string + patch: + description: Updates the metadata of a hook. + operationId: securesourcemanager.projects.locations.repositories.hooks.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Hook' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: repositoriesId + required: true + schema: + type: string + - in: path + name: hooksId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a Hook. + operationId: securesourcemanager.projects.locations.repositories.hooks.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: repositoriesId + required: true + schema: + type: string + - in: path + name: hooksId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/branchRules: + parameters: *ref_1 + post: + description: CreateBranchRule creates a branch rule in a given repository. + operationId: securesourcemanager.projects.locations.repositories.branchRules.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BranchRule' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: repositoriesId + required: true + schema: + type: string + - in: query + name: branchRuleId + schema: + type: string + get: + description: ListBranchRules lists branch rules in a given repository. + operationId: securesourcemanager.projects.locations.repositories.branchRules.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListBranchRulesResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: repositoriesId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/branchRules/{branchRulesId}: + parameters: *ref_1 + get: + description: GetBranchRule gets a branch rule. + operationId: securesourcemanager.projects.locations.repositories.branchRules.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/BranchRule' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: repositoriesId + required: true + schema: + type: string + - in: path + name: branchRulesId + required: true + schema: + type: string + patch: + description: UpdateBranchRule updates a branch rule. + operationId: securesourcemanager.projects.locations.repositories.branchRules.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BranchRule' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: repositoriesId + required: true + schema: + type: string + - in: path + name: branchRulesId + required: true + schema: + type: string + - in: query + name: validateOnly + schema: + type: boolean + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: DeleteBranchRule deletes a branch rule. + operationId: securesourcemanager.projects.locations.repositories.branchRules.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: repositoriesId + required: true + schema: + type: string + - in: path + name: branchRulesId + required: true + schema: + type: string + - in: query + name: allowMissing + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/pullRequests: + parameters: *ref_1 + post: + description: Creates a pull request. + operationId: securesourcemanager.projects.locations.repositories.pullRequests.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PullRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: repositoriesId + required: true + schema: + type: string + get: + description: Lists pull requests in a repository. + operationId: securesourcemanager.projects.locations.repositories.pullRequests.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListPullRequestsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: repositoriesId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/pullRequests/{pullRequestsId}: + parameters: *ref_1 + get: + description: Gets a pull request. + operationId: securesourcemanager.projects.locations.repositories.pullRequests.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/PullRequest' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: repositoriesId + required: true + schema: + type: string + - in: path + name: pullRequestsId + required: true + schema: + type: string + patch: + description: Updates a pull request. + operationId: securesourcemanager.projects.locations.repositories.pullRequests.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PullRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: repositoriesId + required: true + schema: + type: string + - in: path + name: pullRequestsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/pullRequests/{pullRequestsId}:merge: + parameters: *ref_1 + post: + description: Merges a pull request. + operationId: securesourcemanager.projects.locations.repositories.pullRequests.merge + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MergePullRequestRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: repositoriesId + required: true + schema: + type: string + - in: path + name: pullRequestsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/pullRequests/{pullRequestsId}:open: + parameters: *ref_1 + post: + description: Opens a pull request. + operationId: securesourcemanager.projects.locations.repositories.pullRequests.open + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OpenPullRequestRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: repositoriesId + required: true + schema: + type: string + - in: path + name: pullRequestsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/pullRequests/{pullRequestsId}:close: + parameters: *ref_1 + post: + description: Closes a pull request without merging. + operationId: securesourcemanager.projects.locations.repositories.pullRequests.close + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ClosePullRequestRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: repositoriesId + required: true + schema: + type: string + - in: path + name: pullRequestsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/pullRequests/{pullRequestsId}:listFileDiffs: + parameters: *ref_1 + get: + description: Lists a pull request's file diffs. + operationId: >- + securesourcemanager.projects.locations.repositories.pullRequests.listFileDiffs + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListPullRequestFileDiffsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: repositoriesId + required: true + schema: + type: string + - in: path + name: pullRequestsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/pullRequests/{pullRequestsId}/pullRequestComments/{pullRequestCommentsId}: + parameters: *ref_1 + get: + description: Gets a pull request comment. + operationId: >- + securesourcemanager.projects.locations.repositories.pullRequests.pullRequestComments.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/PullRequestComment' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: repositoriesId + required: true + schema: + type: string + - in: path + name: pullRequestsId + required: true + schema: + type: string + - in: path + name: pullRequestCommentsId + required: true + schema: + type: string + patch: + description: Updates a pull request comment. + operationId: >- + securesourcemanager.projects.locations.repositories.pullRequests.pullRequestComments.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PullRequestComment' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: repositoriesId + required: true + schema: + type: string + - in: path + name: pullRequestsId + required: true + schema: + type: string + - in: path + name: pullRequestCommentsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a pull request comment. + operationId: >- + securesourcemanager.projects.locations.repositories.pullRequests.pullRequestComments.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: repositoriesId + required: true + schema: + type: string + - in: path + name: pullRequestsId + required: true + schema: + type: string + - in: path + name: pullRequestCommentsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/pullRequests/{pullRequestsId}/pullRequestComments: + parameters: *ref_1 + get: + description: Lists pull request comments. + operationId: >- + securesourcemanager.projects.locations.repositories.pullRequests.pullRequestComments.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListPullRequestCommentsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: repositoriesId + required: true + schema: + type: string + - in: path + name: pullRequestsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + post: + description: >- + Creates a pull request comment. This function is used to create a single + PullRequestComment of type Comment, or a single PullRequestComment of + type Code that's replying to another PullRequestComment of type Code. + Use BatchCreatePullRequestComments to create multiple + PullRequestComments for code reviews. + operationId: >- + securesourcemanager.projects.locations.repositories.pullRequests.pullRequestComments.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PullRequestComment' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: repositoriesId + required: true + schema: + type: string + - in: path + name: pullRequestsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/pullRequests/{pullRequestsId}/pullRequestComments:batchCreate: + parameters: *ref_1 + post: + description: >- + Batch creates pull request comments. This function is used to create + multiple PullRequestComments for code review. There needs to be exactly + one PullRequestComment of type Review, and at most 100 + PullRequestComments of type Code per request. The Position of the code + comments must be unique within the request. + operationId: >- + securesourcemanager.projects.locations.repositories.pullRequests.pullRequestComments.batchCreate + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BatchCreatePullRequestCommentsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: repositoriesId + required: true + schema: + type: string + - in: path + name: pullRequestsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/pullRequests/{pullRequestsId}/pullRequestComments:resolve: + parameters: *ref_1 + post: + description: >- + Resolves pull request comments. A list of PullRequestComment names must + be provided. The PullRequestComment names must be in the same + conversation thread. If auto_fill is set, all comments in the + conversation thread will be resolved. + operationId: >- + securesourcemanager.projects.locations.repositories.pullRequests.pullRequestComments.resolve + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ResolvePullRequestCommentsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: repositoriesId + required: true + schema: + type: string + - in: path + name: pullRequestsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/pullRequests/{pullRequestsId}/pullRequestComments:unresolve: + parameters: *ref_1 + post: + description: >- + Unresolves pull request comments. A list of PullRequestComment names + must be provided. The PullRequestComment names must be in the same + conversation thread. If auto_fill is set, all comments in the + conversation thread will be unresolved. + operationId: >- + securesourcemanager.projects.locations.repositories.pullRequests.pullRequestComments.unresolve + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UnresolvePullRequestCommentsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: repositoriesId + required: true + schema: + type: string + - in: path + name: pullRequestsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/issues: + parameters: *ref_1 + post: + description: Creates an issue. + operationId: securesourcemanager.projects.locations.repositories.issues.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Issue' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: repositoriesId + required: true + schema: + type: string + get: + description: Lists issues in a repository. + operationId: securesourcemanager.projects.locations.repositories.issues.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListIssuesResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: repositoriesId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/issues/{issuesId}: + parameters: *ref_1 + get: + description: Gets an issue. + operationId: securesourcemanager.projects.locations.repositories.issues.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Issue' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: repositoriesId + required: true + schema: + type: string + - in: path + name: issuesId + required: true + schema: + type: string + patch: + description: Updates a issue. + operationId: securesourcemanager.projects.locations.repositories.issues.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Issue' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: repositoriesId + required: true + schema: + type: string + - in: path + name: issuesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes an issue. + operationId: securesourcemanager.projects.locations.repositories.issues.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: repositoriesId + required: true + schema: + type: string + - in: path + name: issuesId + required: true + schema: + type: string + - in: query + name: etag + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/issues/{issuesId}:open: + parameters: *ref_1 + post: + description: Opens an issue. + operationId: securesourcemanager.projects.locations.repositories.issues.open + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OpenIssueRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: repositoriesId + required: true + schema: + type: string + - in: path + name: issuesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/issues/{issuesId}:close: + parameters: *ref_1 + post: + description: Closes an issue. + operationId: securesourcemanager.projects.locations.repositories.issues.close + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CloseIssueRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: repositoriesId + required: true + schema: + type: string + - in: path + name: issuesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/issues/{issuesId}/issueComments: + parameters: *ref_1 + post: + description: Creates an issue comment. + operationId: >- + securesourcemanager.projects.locations.repositories.issues.issueComments.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/IssueComment' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: repositoriesId + required: true + schema: + type: string + - in: path + name: issuesId + required: true + schema: + type: string + get: + description: Lists comments in an issue. + operationId: >- + securesourcemanager.projects.locations.repositories.issues.issueComments.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListIssueCommentsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: repositoriesId + required: true + schema: + type: string + - in: path + name: issuesId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/issues/{issuesId}/issueComments/{issueCommentsId}: + parameters: *ref_1 + get: + description: Gets an issue comment. + operationId: >- + securesourcemanager.projects.locations.repositories.issues.issueComments.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/IssueComment' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: repositoriesId + required: true + schema: + type: string + - in: path + name: issuesId + required: true + schema: + type: string + - in: path + name: issueCommentsId + required: true + schema: + type: string + patch: + description: Updates an issue comment. + operationId: >- + securesourcemanager.projects.locations.repositories.issues.issueComments.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/IssueComment' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: repositoriesId + required: true + schema: + type: string + - in: path + name: issuesId + required: true + schema: + type: string + - in: path + name: issueCommentsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes an issue comment. + operationId: >- + securesourcemanager.projects.locations.repositories.issues.issueComments.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: repositoriesId + required: true + schema: + type: string + - in: path + name: issuesId + required: true + schema: + type: string + - in: path + name: issueCommentsId + required: true + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/securitycenter.yaml b/providers/src/googleapis.com/v00.00.00000/services/securitycenter.yaml index 3b182b06..1cd73e24 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/securitycenter.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/securitycenter.yaml @@ -9,8 +9,8 @@ info: Security Command Center API provides access to temporal views of assets and findings within an organization. version: v1 - x-discovery-doc-revision: '20241026' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250822' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/security-command-center servers: @@ -252,6 +252,19 @@ components: customConfig: description: The user specified custom configuration for the module. $ref: '#/components/schemas/GoogleCloudSecuritycenterV1CustomConfig' + cloudProvider: + description: The cloud provider of the custom module. + type: string + enumDescriptions: + - Unspecified cloud provider. + - Google Cloud. + - Amazon Web Services (AWS). + - Microsoft Azure. + enum: + - CLOUD_PROVIDER_UNSPECIFIED + - GOOGLE_CLOUD_PLATFORM + - AMAZON_WEB_SERVICES + - MICROSOFT_AZURE GoogleCloudSecuritycenterV1CustomConfig: id: GoogleCloudSecuritycenterV1CustomConfig description: >- @@ -625,6 +638,9 @@ components: - >- Describes a potential security risk to data assets that contain sensitive data. + - >- + Describes a resource or resource group where high risk attack + paths converge, based on attack path simulations (APS). enum: - FINDING_CLASS_UNSPECIFIED - THREAT @@ -635,6 +651,7 @@ components: - POSTURE_VIOLATION - TOXIC_COMBINATION - SENSITIVE_DATA_RISK + - CHOKEPOINT indicator: description: >- Represents what's commonly known as an *indicator of compromise* @@ -780,9 +797,15 @@ components: type: array items: $ref: '#/components/schemas/OrgPolicy' + job: + description: Job associated with the finding. + $ref: '#/components/schemas/Job' application: description: Represents an application associated with the finding. $ref: '#/components/schemas/Application' + ipRules: + description: IP rules associated with the finding. + $ref: '#/components/schemas/IpRules' backupDisasterRecovery: description: Fields related to Backup and DR findings. $ref: '#/components/schemas/BackupDisasterRecovery' @@ -822,6 +845,9 @@ components: type: array items: $ref: '#/components/schemas/GroupMembership' + disk: + description: Disk associated with the finding. + $ref: '#/components/schemas/Disk' dataAccessEvents: description: Data access events associated with the finding. type: array @@ -832,6 +858,37 @@ components: type: array items: $ref: '#/components/schemas/DataFlowEvent' + networks: + description: Represents the VPC networks that the resource is attached to. + type: array + items: + $ref: '#/components/schemas/Network' + dataRetentionDeletionEvents: + description: Data retention deletion events associated with the finding. + type: array + items: + $ref: '#/components/schemas/DataRetentionDeletionEvent' + affectedResources: + description: AffectedResources associated with the finding. + $ref: '#/components/schemas/AffectedResources' + aiModel: + description: The AI model associated with the finding. + $ref: '#/components/schemas/AiModel' + chokepoint: + description: >- + Contains details about a chokepoint, which is a resource or resource + group where high-risk attack paths converge, based on [attack path + simulations] + (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). + This field cannot be updated. Its value is ignored in all update + requests. + $ref: '#/components/schemas/Chokepoint' + complianceDetails: + description: Details about the compliance implications of the finding. + $ref: '#/components/schemas/ComplianceDetails' + vertexAi: + description: VertexAi associated with the finding. + $ref: '#/components/schemas/VertexAi' SecurityMarks: id: SecurityMarks description: >- @@ -982,6 +1039,24 @@ components: securityBulletin: description: The security bulletin is relevant to this finding. $ref: '#/components/schemas/SecurityBulletin' + providerRiskScore: + description: >- + Provider provided risk_score based on multiple factors. The higher + the risk score, the more risky the vulnerability is. + type: string + format: int64 + reachable: + description: >- + Represents whether the vulnerability is reachable (detected via + static analysis) + type: boolean + cwes: + description: >- + Represents one or more Common Weakness Enumeration (CWE) information + on this vulnerability. + type: array + items: + $ref: '#/components/schemas/Cwe' Cve: id: Cve description: >- @@ -1283,6 +1358,23 @@ components: notification should be upgraded to, based on its current version. For example, 1.15.0 type: string + Cwe: + id: Cwe + description: >- + CWE stands for Common Weakness Enumeration. Information about this + weakness, as described by [CWE](https://cwe.mitre.org/). + type: object + properties: + id: + description: The CWE identifier, e.g. CWE-94 + type: string + references: + description: >- + Any reference to the details on the CWE, for example, + https://cwe.mitre.org/data/definitions/94.html + type: array + items: + $ref: '#/components/schemas/Reference' GoogleCloudSecuritycenterV1ExternalSystem: id: GoogleCloudSecuritycenterV1ExternalSystem description: Representation of third party SIEM/SOAR fields within SCC. @@ -1431,11 +1523,30 @@ components: type: string enumDescriptions: - Unspecified value. + - T1001 + - T1001.002 + - T1003 + - T1003.007 + - T1003.008 + - T1005 + - T1020 + - T1027 + - T1027.003 + - T1027.004 + - T1027.010 + - T1029 + - T1033 - T1036 - T1036.005 - T1037 - T1037.005 - T1046 + - T1053 + - T1053.003 + - T1053.007 + - T1055 + - T1056 + - T1056.001 - T1057 - T1059 - T1059.004 @@ -1443,7 +1554,12 @@ components: - T1068 - T1069 - T1069.003 + - T1070 + - T1070.002 + - T1070.003 - T1070.004 + - T1070.006 + - T1070.008 - T1071 - T1071.004 - T1072 @@ -1451,59 +1567,125 @@ components: - T1078.001 - T1078.003 - T1078.004 + - T1083 + - T1087.001 - T1090 - T1090.002 - T1090.003 - T1098 - T1098.001 + - T1098.003 - T1098.004 - T1098.006 + - T1104 - T1105 - T1106 - T1110 + - T1119 - T1129 + - T1132 + - T1132.001 - T1134 - T1134.001 + - T1136 + - T1136.001 + - T1140 - T1190 + - T1195 + - T1195.001 + - T1203 + - T1204 + - T1222.002 - T1484 - T1485 + - T1486 - T1489 - T1490 + - T1495 - T1496 - T1498 - T1526 - T1528 - T1531 + - T1537 - T1539 - T1543 - T1546 + - T1547 + - T1547.006 + - T1547.009 - T1548 + - T1548.001 + - T1548.003 - T1552 + - T1552.001 + - T1552.003 + - T1552.004 + - T1553 + - T1553.004 + - T1554 + - T1555 - T1556 + - T1556.003 + - T1556.006 - T1562 - T1562.001 + - T1562.006 + - T1562.012 + - T1564 + - T1564.001 + - T1564.002 - T1567 - T1567.002 - T1568 - T1570 + - T1574 + - T1574.006 - T1578 - T1578.001 - T1580 + - T1587 + - T1587.001 - T1588 + - T1588.001 + - T1588.006 - T1595 - T1595.001 + - T1608 + - T1608.001 - T1609 - T1610 - T1611 - T1613 + - T1620 - T1649 + - T1657 enum: - TECHNIQUE_UNSPECIFIED + - DATA_OBFUSCATION + - DATA_OBFUSCATION_STEGANOGRAPHY + - OS_CREDENTIAL_DUMPING + - OS_CREDENTIAL_DUMPING_PROC_FILESYSTEM + - OS_CREDENTIAL_DUMPING_ETC_PASSWORD_AND_ETC_SHADOW + - DATA_FROM_LOCAL_SYSTEM + - AUTOMATED_EXFILTRATION + - OBFUSCATED_FILES_OR_INFO + - STEGANOGRAPHY + - COMPILE_AFTER_DELIVERY + - COMMAND_OBFUSCATION + - SCHEDULED_TRANSFER + - SYSTEM_OWNER_USER_DISCOVERY - MASQUERADING - MATCH_LEGITIMATE_NAME_OR_LOCATION - BOOT_OR_LOGON_INITIALIZATION_SCRIPTS - STARTUP_ITEMS - NETWORK_SERVICE_DISCOVERY + - SCHEDULED_TASK_JOB + - SCHEDULED_TASK_JOB_CRON + - CONTAINER_ORCHESTRATION_JOB + - PROCESS_INJECTION + - INPUT_CAPTURE + - INPUT_CAPTURE_KEYLOGGING - PROCESS_DISCOVERY - COMMAND_AND_SCRIPTING_INTERPRETER - UNIX_SHELL @@ -1511,7 +1693,12 @@ components: - EXPLOITATION_FOR_PRIVILEGE_ESCALATION - PERMISSION_GROUPS_DISCOVERY - CLOUD_GROUPS + - INDICATOR_REMOVAL + - INDICATOR_REMOVAL_CLEAR_LINUX_OR_MAC_SYSTEM_LOGS + - INDICATOR_REMOVAL_CLEAR_COMMAND_HISTORY - INDICATOR_REMOVAL_FILE_DELETION + - INDICATOR_REMOVAL_TIMESTOMP + - INDICATOR_REMOVAL_CLEAR_MAILBOX_DATA - APPLICATION_LAYER_PROTOCOL - DNS - SOFTWARE_DEPLOYMENT_TOOLS @@ -1519,52 +1706,99 @@ components: - DEFAULT_ACCOUNTS - LOCAL_ACCOUNTS - CLOUD_ACCOUNTS + - FILE_AND_DIRECTORY_DISCOVERY + - ACCOUNT_DISCOVERY_LOCAL_ACCOUNT - PROXY - EXTERNAL_PROXY - MULTI_HOP_PROXY - ACCOUNT_MANIPULATION - ADDITIONAL_CLOUD_CREDENTIALS + - ADDITIONAL_CLOUD_ROLES - SSH_AUTHORIZED_KEYS - ADDITIONAL_CONTAINER_CLUSTER_ROLES + - MULTI_STAGE_CHANNELS - INGRESS_TOOL_TRANSFER - NATIVE_API - BRUTE_FORCE + - AUTOMATED_COLLECTION - SHARED_MODULES + - DATA_ENCODING + - STANDARD_ENCODING - ACCESS_TOKEN_MANIPULATION - TOKEN_IMPERSONATION_OR_THEFT + - CREATE_ACCOUNT + - LOCAL_ACCOUNT + - DEOBFUSCATE_DECODE_FILES_OR_INFO - EXPLOIT_PUBLIC_FACING_APPLICATION + - SUPPLY_CHAIN_COMPROMISE + - COMPROMISE_SOFTWARE_DEPENDENCIES_AND_DEVELOPMENT_TOOLS + - EXPLOITATION_FOR_CLIENT_EXECUTION + - USER_EXECUTION + - LINUX_AND_MAC_FILE_AND_DIRECTORY_PERMISSIONS_MODIFICATION - DOMAIN_POLICY_MODIFICATION - DATA_DESTRUCTION + - DATA_ENCRYPTED_FOR_IMPACT - SERVICE_STOP - INHIBIT_SYSTEM_RECOVERY + - FIRMWARE_CORRUPTION - RESOURCE_HIJACKING - NETWORK_DENIAL_OF_SERVICE - CLOUD_SERVICE_DISCOVERY - STEAL_APPLICATION_ACCESS_TOKEN - ACCOUNT_ACCESS_REMOVAL + - TRANSFER_DATA_TO_CLOUD_ACCOUNT - STEAL_WEB_SESSION_COOKIE - CREATE_OR_MODIFY_SYSTEM_PROCESS - EVENT_TRIGGERED_EXECUTION + - BOOT_OR_LOGON_AUTOSTART_EXECUTION + - KERNEL_MODULES_AND_EXTENSIONS + - SHORTCUT_MODIFICATION - ABUSE_ELEVATION_CONTROL_MECHANISM + - ABUSE_ELEVATION_CONTROL_MECHANISM_SETUID_AND_SETGID + - ABUSE_ELEVATION_CONTROL_MECHANISM_SUDO_AND_SUDO_CACHING - UNSECURED_CREDENTIALS + - CREDENTIALS_IN_FILES + - BASH_HISTORY + - PRIVATE_KEYS + - SUBVERT_TRUST_CONTROL + - INSTALL_ROOT_CERTIFICATE + - COMPROMISE_HOST_SOFTWARE_BINARY + - CREDENTIALS_FROM_PASSWORD_STORES - MODIFY_AUTHENTICATION_PROCESS + - PLUGGABLE_AUTHENTICATION_MODULES + - MULTI_FACTOR_AUTHENTICATION - IMPAIR_DEFENSES - DISABLE_OR_MODIFY_TOOLS + - INDICATOR_BLOCKING + - DISABLE_OR_MODIFY_LINUX_AUDIT_SYSTEM + - HIDE_ARTIFACTS + - HIDDEN_FILES_AND_DIRECTORIES + - HIDDEN_USERS - EXFILTRATION_OVER_WEB_SERVICE - EXFILTRATION_TO_CLOUD_STORAGE - DYNAMIC_RESOLUTION - LATERAL_TOOL_TRANSFER + - HIJACK_EXECUTION_FLOW + - HIJACK_EXECUTION_FLOW_DYNAMIC_LINKER_HIJACKING - MODIFY_CLOUD_COMPUTE_INFRASTRUCTURE - CREATE_SNAPSHOT - CLOUD_INFRASTRUCTURE_DISCOVERY + - DEVELOP_CAPABILITIES + - DEVELOP_CAPABILITIES_MALWARE - OBTAIN_CAPABILITIES + - OBTAIN_CAPABILITIES_MALWARE + - OBTAIN_CAPABILITIES_VULNERABILITIES - ACTIVE_SCANNING - SCANNING_IP_BLOCKS + - STAGE_CAPABILITIES + - UPLOAD_MALWARE - CONTAINER_ADMINISTRATION_COMMAND - DEPLOY_CONTAINER - ESCAPE_TO_HOST - CONTAINER_AND_RESOURCE_DISCOVERY + - REFLECTIVE_CODE_LOADING - STEAL_OR_FORGE_AUTHENTICATION_CERTIFICATES + - FINANCIAL_THEFT additionalTactics: description: Additional MITRE ATT&CK tactics related to this finding, if any. type: array @@ -1611,11 +1845,30 @@ components: type: string enumDescriptions: - Unspecified value. + - T1001 + - T1001.002 + - T1003 + - T1003.007 + - T1003.008 + - T1005 + - T1020 + - T1027 + - T1027.003 + - T1027.004 + - T1027.010 + - T1029 + - T1033 - T1036 - T1036.005 - T1037 - T1037.005 - T1046 + - T1053 + - T1053.003 + - T1053.007 + - T1055 + - T1056 + - T1056.001 - T1057 - T1059 - T1059.004 @@ -1623,7 +1876,12 @@ components: - T1068 - T1069 - T1069.003 + - T1070 + - T1070.002 + - T1070.003 - T1070.004 + - T1070.006 + - T1070.008 - T1071 - T1071.004 - T1072 @@ -1631,59 +1889,125 @@ components: - T1078.001 - T1078.003 - T1078.004 + - T1083 + - T1087.001 - T1090 - T1090.002 - T1090.003 - T1098 - T1098.001 + - T1098.003 - T1098.004 - T1098.006 + - T1104 - T1105 - T1106 - T1110 + - T1119 - T1129 + - T1132 + - T1132.001 - T1134 - T1134.001 + - T1136 + - T1136.001 + - T1140 - T1190 + - T1195 + - T1195.001 + - T1203 + - T1204 + - T1222.002 - T1484 - T1485 + - T1486 - T1489 - T1490 + - T1495 - T1496 - T1498 - T1526 - T1528 - T1531 + - T1537 - T1539 - T1543 - T1546 + - T1547 + - T1547.006 + - T1547.009 - T1548 + - T1548.001 + - T1548.003 - T1552 + - T1552.001 + - T1552.003 + - T1552.004 + - T1553 + - T1553.004 + - T1554 + - T1555 - T1556 + - T1556.003 + - T1556.006 - T1562 - T1562.001 + - T1562.006 + - T1562.012 + - T1564 + - T1564.001 + - T1564.002 - T1567 - T1567.002 - T1568 - T1570 + - T1574 + - T1574.006 - T1578 - T1578.001 - T1580 + - T1587 + - T1587.001 - T1588 + - T1588.001 + - T1588.006 - T1595 - T1595.001 + - T1608 + - T1608.001 - T1609 - T1610 - T1611 - T1613 + - T1620 - T1649 + - T1657 enum: - TECHNIQUE_UNSPECIFIED + - DATA_OBFUSCATION + - DATA_OBFUSCATION_STEGANOGRAPHY + - OS_CREDENTIAL_DUMPING + - OS_CREDENTIAL_DUMPING_PROC_FILESYSTEM + - OS_CREDENTIAL_DUMPING_ETC_PASSWORD_AND_ETC_SHADOW + - DATA_FROM_LOCAL_SYSTEM + - AUTOMATED_EXFILTRATION + - OBFUSCATED_FILES_OR_INFO + - STEGANOGRAPHY + - COMPILE_AFTER_DELIVERY + - COMMAND_OBFUSCATION + - SCHEDULED_TRANSFER + - SYSTEM_OWNER_USER_DISCOVERY - MASQUERADING - MATCH_LEGITIMATE_NAME_OR_LOCATION - BOOT_OR_LOGON_INITIALIZATION_SCRIPTS - STARTUP_ITEMS - NETWORK_SERVICE_DISCOVERY + - SCHEDULED_TASK_JOB + - SCHEDULED_TASK_JOB_CRON + - CONTAINER_ORCHESTRATION_JOB + - PROCESS_INJECTION + - INPUT_CAPTURE + - INPUT_CAPTURE_KEYLOGGING - PROCESS_DISCOVERY - COMMAND_AND_SCRIPTING_INTERPRETER - UNIX_SHELL @@ -1691,7 +2015,12 @@ components: - EXPLOITATION_FOR_PRIVILEGE_ESCALATION - PERMISSION_GROUPS_DISCOVERY - CLOUD_GROUPS + - INDICATOR_REMOVAL + - INDICATOR_REMOVAL_CLEAR_LINUX_OR_MAC_SYSTEM_LOGS + - INDICATOR_REMOVAL_CLEAR_COMMAND_HISTORY - INDICATOR_REMOVAL_FILE_DELETION + - INDICATOR_REMOVAL_TIMESTOMP + - INDICATOR_REMOVAL_CLEAR_MAILBOX_DATA - APPLICATION_LAYER_PROTOCOL - DNS - SOFTWARE_DEPLOYMENT_TOOLS @@ -1699,52 +2028,99 @@ components: - DEFAULT_ACCOUNTS - LOCAL_ACCOUNTS - CLOUD_ACCOUNTS + - FILE_AND_DIRECTORY_DISCOVERY + - ACCOUNT_DISCOVERY_LOCAL_ACCOUNT - PROXY - EXTERNAL_PROXY - MULTI_HOP_PROXY - ACCOUNT_MANIPULATION - ADDITIONAL_CLOUD_CREDENTIALS + - ADDITIONAL_CLOUD_ROLES - SSH_AUTHORIZED_KEYS - ADDITIONAL_CONTAINER_CLUSTER_ROLES + - MULTI_STAGE_CHANNELS - INGRESS_TOOL_TRANSFER - NATIVE_API - BRUTE_FORCE + - AUTOMATED_COLLECTION - SHARED_MODULES + - DATA_ENCODING + - STANDARD_ENCODING - ACCESS_TOKEN_MANIPULATION - TOKEN_IMPERSONATION_OR_THEFT + - CREATE_ACCOUNT + - LOCAL_ACCOUNT + - DEOBFUSCATE_DECODE_FILES_OR_INFO - EXPLOIT_PUBLIC_FACING_APPLICATION + - SUPPLY_CHAIN_COMPROMISE + - COMPROMISE_SOFTWARE_DEPENDENCIES_AND_DEVELOPMENT_TOOLS + - EXPLOITATION_FOR_CLIENT_EXECUTION + - USER_EXECUTION + - LINUX_AND_MAC_FILE_AND_DIRECTORY_PERMISSIONS_MODIFICATION - DOMAIN_POLICY_MODIFICATION - DATA_DESTRUCTION + - DATA_ENCRYPTED_FOR_IMPACT - SERVICE_STOP - INHIBIT_SYSTEM_RECOVERY + - FIRMWARE_CORRUPTION - RESOURCE_HIJACKING - NETWORK_DENIAL_OF_SERVICE - CLOUD_SERVICE_DISCOVERY - STEAL_APPLICATION_ACCESS_TOKEN - ACCOUNT_ACCESS_REMOVAL + - TRANSFER_DATA_TO_CLOUD_ACCOUNT - STEAL_WEB_SESSION_COOKIE - CREATE_OR_MODIFY_SYSTEM_PROCESS - EVENT_TRIGGERED_EXECUTION + - BOOT_OR_LOGON_AUTOSTART_EXECUTION + - KERNEL_MODULES_AND_EXTENSIONS + - SHORTCUT_MODIFICATION - ABUSE_ELEVATION_CONTROL_MECHANISM + - ABUSE_ELEVATION_CONTROL_MECHANISM_SETUID_AND_SETGID + - ABUSE_ELEVATION_CONTROL_MECHANISM_SUDO_AND_SUDO_CACHING - UNSECURED_CREDENTIALS + - CREDENTIALS_IN_FILES + - BASH_HISTORY + - PRIVATE_KEYS + - SUBVERT_TRUST_CONTROL + - INSTALL_ROOT_CERTIFICATE + - COMPROMISE_HOST_SOFTWARE_BINARY + - CREDENTIALS_FROM_PASSWORD_STORES - MODIFY_AUTHENTICATION_PROCESS + - PLUGGABLE_AUTHENTICATION_MODULES + - MULTI_FACTOR_AUTHENTICATION - IMPAIR_DEFENSES - DISABLE_OR_MODIFY_TOOLS + - INDICATOR_BLOCKING + - DISABLE_OR_MODIFY_LINUX_AUDIT_SYSTEM + - HIDE_ARTIFACTS + - HIDDEN_FILES_AND_DIRECTORIES + - HIDDEN_USERS - EXFILTRATION_OVER_WEB_SERVICE - EXFILTRATION_TO_CLOUD_STORAGE - DYNAMIC_RESOLUTION - LATERAL_TOOL_TRANSFER + - HIJACK_EXECUTION_FLOW + - HIJACK_EXECUTION_FLOW_DYNAMIC_LINKER_HIJACKING - MODIFY_CLOUD_COMPUTE_INFRASTRUCTURE - CREATE_SNAPSHOT - CLOUD_INFRASTRUCTURE_DISCOVERY + - DEVELOP_CAPABILITIES + - DEVELOP_CAPABILITIES_MALWARE - OBTAIN_CAPABILITIES + - OBTAIN_CAPABILITIES_MALWARE + - OBTAIN_CAPABILITIES_VULNERABILITIES - ACTIVE_SCANNING - SCANNING_IP_BLOCKS + - STAGE_CAPABILITIES + - UPLOAD_MALWARE - CONTAINER_ADMINISTRATION_COMMAND - DEPLOY_CONTAINER - ESCAPE_TO_HOST - CONTAINER_AND_RESOURCE_DISCOVERY + - REFLECTIVE_CODE_LOADING - STEAL_OR_FORGE_AUTHENTICATION_CERTIFICATES + - FINANCIAL_THEFT version: description: The MITRE ATT&CK version referenced by the above fields. E.g. "8". type: string @@ -2002,6 +2378,12 @@ components: description: The parent process ID. type: string format: int64 + userId: + description: >- + The ID of the user that executed the process. E.g. If this is the + root user this will always be 0. + type: string + format: int64 File: id: File description: >- @@ -2037,6 +2419,11 @@ components: diskPath: description: Path of the file in terms of underlying disk/partition identifiers. $ref: '#/components/schemas/DiskPath' + operations: + description: Operation(s) performed on a file. + type: array + items: + $ref: '#/components/schemas/FileOperation' DiskPath: id: DiskPath description: Path of the file in terms of underlying disk/partition identifiers. @@ -2052,6 +2439,28 @@ components: Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh type: string + FileOperation: + id: FileOperation + description: Operation(s) performed on a file. + type: object + properties: + type: + description: The type of the operation + type: string + enumDescriptions: + - The operation is unspecified. + - Represents an open operation. + - Represents a read operation. + - Represents a rename operation. + - Represents a write operation. + - Represents an execute operation. + enum: + - OPERATION_TYPE_UNSPECIFIED + - OPEN + - READ + - RENAME + - WRITE + - EXECUTE EnvironmentVariable: id: EnvironmentVariable description: >- @@ -2677,6 +3086,41 @@ components: The resource name of the org policy. Example: "organizations/{organization_id}/policies/{constraint_name}" type: string + Job: + id: Job + description: Describes a job + type: object + properties: + name: + description: The fully-qualified name for a job. e.g. `projects//jobs/` + type: string + state: + description: Output only. State of the job, such as `RUNNING` or `PENDING`. + readOnly: true + type: string + enumDescriptions: + - Unspecified represents an unknown state and should not be used. + - Job is scheduled and pending for run + - Job in progress + - Job has completed with success + - Job has completed but with failure + enum: + - JOB_STATE_UNSPECIFIED + - PENDING + - RUNNING + - SUCCEEDED + - FAILED + errorCode: + description: >- + Optional. If the job did not complete successfully, this field + describes why. + type: integer + format: int32 + location: + description: >- + Optional. Gives the location where the job ran, such as `US` or + `europe-west1` + type: string Application: id: Application description: Represents an application associated with a finding. @@ -2693,6 +3137,111 @@ components: The full URI with payload that can be used to reproduce the vulnerability. For example, `http://example.com?p=aMmYgI6H`. type: string + IpRules: + id: IpRules + description: IP rules associated with the finding. + type: object + properties: + direction: + description: >- + The direction that the rule is applicable to, one of ingress or + egress. + type: string + enumDescriptions: + - Unspecified direction value. + - Ingress direction value. + - Egress direction value. + enum: + - DIRECTION_UNSPECIFIED + - INGRESS + - EGRESS + allowed: + description: Tuple with allowed rules. + $ref: '#/components/schemas/Allowed' + denied: + description: Tuple with denied rules. + $ref: '#/components/schemas/Denied' + sourceIpRanges: + description: >- + If source IP 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. Only supports IPv4. + type: array + items: + type: string + destinationIpRanges: + description: >- + If destination IP ranges are specified, the firewall rule applies + only to traffic that has a destination IP address in these ranges. + These ranges must be expressed in CIDR format. Only supports IPv4. + type: array + items: + type: string + exposedServices: + description: >- + Name of the network protocol service, such as FTP, that is exposed + by the open port. Follows the naming convention available at: + https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml. + type: array + items: + type: string + Allowed: + id: Allowed + description: Allowed IP rule. + type: object + properties: + ipRules: + description: Optional. Optional list of allowed IP rules. + type: array + items: + $ref: '#/components/schemas/IpRule' + IpRule: + id: IpRule + description: IP rule information. + type: object + properties: + protocol: + description: >- + The IP protocol this rule applies to. This value can either be one + of the following well known protocol strings (TCP, UDP, ICMP, ESP, + AH, IPIP, SCTP) or a string representation of the integer value. + type: string + portRanges: + description: >- + Optional. An optional list of ports to which this rule applies. This + field is only applicable for the UDP or (S)TCP protocols. Each entry + must be either an integer or a range including a min and max port + number. + type: array + items: + $ref: '#/components/schemas/PortRange' + PortRange: + id: PortRange + description: >- + A port range which is inclusive of the min and max values. Values are + between 0 and 2^16-1. The max can be equal / must be not smaller than + the min value. If min and max are equal this indicates that it is a + single port. + type: object + properties: + min: + description: Minimum port value. + type: string + format: int64 + max: + description: Maximum port value. + type: string + format: int64 + Denied: + id: Denied + description: Denied IP rule. + type: object + properties: + ipRules: + description: Optional. Optional list of denied IP rules. + type: array + items: + $ref: '#/components/schemas/IpRule' BackupDisasterRecovery: id: BackupDisasterRecovery description: Information related to Google Cloud Backup and DR Service findings. @@ -2991,19 +3540,33 @@ components: description: Information about DDoS attack volume and classification. type: object properties: - volumePps: + volumePpsLong: description: Total PPS (packets per second) volume of attack. - type: integer - format: int32 - volumeBps: + type: string + format: int64 + volumeBpsLong: description: Total BPS (bytes per second) volume of attack. - type: integer - format: int32 + type: string + format: int64 classification: description: >- Type of attack, for example, 'SYN-flood', 'NTP-udp', or 'CHARGEN-udp'. type: string + volumePps: + description: >- + Total PPS (packets per second) volume of attack. Deprecated - refer + to volume_pps_long instead. + deprecated: true + type: integer + format: int32 + volumeBps: + description: >- + Total BPS (bytes per second) volume of attack. Deprecated - refer to + volume_bps_long instead. + deprecated: true + type: integer + format: int32 Notebook: id: Notebook description: >- @@ -3064,12 +3627,24 @@ components: enumDescriptions: - Default value. - Group represents a toxic combination. + - Group represents a chokepoint. enum: - GROUP_TYPE_UNSPECIFIED - GROUP_TYPE_TOXIC_COMBINATION + - GROUP_TYPE_CHOKEPOINT groupId: description: ID of the group. type: string + Disk: + id: Disk + description: Contains information about the disk associated with the finding. + type: object + properties: + name: + description: >- + The name of the disk, for example, + "https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}". + type: string DataAccessEvent: id: DataAccessEvent description: >- @@ -3140,6 +3715,286 @@ components: description: Timestamp of data flow event. type: string format: google-datetime + Network: + id: Network + description: Contains information about a VPC network associated with the finding. + type: object + properties: + name: + description: >- + The name of the VPC network resource, for example, + `//compute.googleapis.com/projects/my-project/global/networks/my-network`. + type: string + DataRetentionDeletionEvent: + id: DataRetentionDeletionEvent + description: >- + Details about data retention deletion violations, in which the data is + non-compliant based on their retention or deletion time, as defined in + the applicable data security policy. The Data Retention Deletion (DRD) + control is a control of the DSPM (Data Security Posture Management) + suite that enables organizations to manage data retention and deletion + policies in compliance with regulations, such as GDPR and CRPA. DRD + supports two primary policy types: maximum storage length (max TTL) and + minimum storage length (min TTL). Both are aimed at helping + organizations meet regulatory and data management commitments. + type: object + properties: + eventDetectionTime: + description: Timestamp indicating when the event was detected. + type: string + format: google-datetime + dataObjectCount: + description: >- + Number of objects that violated the policy for this resource. If the + number is less than 1,000, then the value of this field is the exact + number. If the number of objects that violated the policy is greater + than or equal to 1,000, then the value of this field is 1000. + type: string + format: int64 + maxRetentionAllowed: + description: >- + Maximum duration of retention allowed from the DRD control. This + comes from the DRD control where users set a max TTL for their data. + For example, suppose that a user sets the max TTL for a Cloud + Storage bucket to 90 days. However, an object in that bucket is 100 + days old. In this case, a DataRetentionDeletionEvent will be + generated for that Cloud Storage bucket, and the + max_retention_allowed is 90 days. + type: string + format: google-duration + eventType: + description: Type of the DRD event. + type: string + enumDescriptions: + - Unspecified event type. + - The maximum retention time has been exceeded. + enum: + - EVENT_TYPE_UNSPECIFIED + - EVENT_TYPE_MAX_TTL_EXCEEDED + AffectedResources: + id: AffectedResources + description: Details about resources affected by this finding. + type: object + properties: + count: + description: The count of resources affected by the finding. + type: string + format: int64 + AiModel: + id: AiModel + description: Contains information about the AI model associated with the finding. + type: object + properties: + name: + description: The name of the AI model, for example, "gemini:1.0.0". + type: string + domain: + description: The domain of the model, for example, “image-classification”. + type: string + library: + description: The name of the model library, for example, “transformers”. + type: string + location: + description: The region in which the model is used, for example, “us-central1”. + type: string + publisher: + description: The publisher of the model, for example, “google” or “nvidia”. + type: string + deploymentPlatform: + description: The platform on which the model is deployed. + type: string + enumDescriptions: + - Unspecified deployment platform. + - Vertex AI. + - Google Kubernetes Engine. + enum: + - DEPLOYMENT_PLATFORM_UNSPECIFIED + - VERTEX_AI + - GKE + displayName: + description: >- + The user defined display name of model. Ex. + baseline-classification-model + type: string + Chokepoint: + id: Chokepoint + description: >- + Contains details about a chokepoint, which is a resource or resource + group where high-risk attack paths converge, based on [attack path + simulations] + (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). + type: object + properties: + relatedFindings: + description: >- + List of resource names of findings associated with this chokepoint. + For example, organizations/123/sources/456/findings/789. This list + will have at most 100 findings. + type: array + items: + type: string + ComplianceDetails: + id: ComplianceDetails + description: Compliance Details associated with the finding. + type: object + properties: + frameworks: + description: Details of Frameworks associated with the finding + type: array + items: + $ref: '#/components/schemas/Framework' + cloudControl: + description: CloudControl associated with the finding + $ref: '#/components/schemas/CloudControl' + cloudControlDeploymentNames: + description: >- + Cloud Control Deployments associated with the finding. For example, + organizations/123/locations/global/cloudControlDeployments/deploymentIdentifier + type: array + items: + type: string + Framework: + id: Framework + description: Compliance framework associated with the finding. + type: object + properties: + name: + description: Name of the framework associated with the finding + type: string + displayName: + description: >- + Display name of the framework. For a standard framework, this will + look like e.g. PCI DSS 3.2.1, whereas for a custom framework it can + be a user defined string like MyFramework + type: string + category: + description: >- + Category of the framework associated with the finding. E.g. Security + Benchmark, or Assured Workloads + type: array + items: + type: string + enumDescriptions: + - Default value. This value is unused. + - Security Benchmarks framework + - Assured Workloads framework + - Data Security framework + - Google Best Practices framework + enum: + - FRAMEWORK_CATEGORY_UNSPECIFIED + - SECURITY_BENCHMARKS + - ASSURED_WORKLOADS + - DATA_SECURITY + - GOOGLE_BEST_PRACTICES + type: + description: >- + Type of the framework associated with the finding, to specify + whether the framework is built-in (pre-defined and immutable) or a + custom framework defined by the customer (equivalent to security + posture) + type: string + enumDescriptions: + - Default value. This value is unused. + - >- + The framework is a built-in framework if it is created and managed + by GCP. + - >- + The framework is a custom framework if it is created and managed + by the user. + enum: + - FRAMEWORK_TYPE_UNSPECIFIED + - FRAMEWORK_TYPE_BUILT_IN + - FRAMEWORK_TYPE_CUSTOM + controls: + description: The controls associated with the framework. + type: array + items: + $ref: '#/components/schemas/Control' + Control: + id: Control + description: Compliance control associated with the finding. + type: object + properties: + controlName: + description: Name of the Control + type: string + displayName: + description: Display name of the control. For example, AU-02. + type: string + CloudControl: + id: CloudControl + description: CloudControl associated with the finding. + type: object + properties: + cloudControlName: + description: Name of the CloudControl associated with the finding. + type: string + type: + description: Type of cloud control. + type: string + enumDescriptions: + - Unspecified. + - Built in Cloud Control. + - Custom Cloud Control. + enum: + - CLOUD_CONTROL_TYPE_UNSPECIFIED + - BUILT_IN + - CUSTOM + policyType: + description: Policy type of the CloudControl + type: string + version: + description: Version of the Cloud Control + type: integer + format: int32 + VertexAi: + id: VertexAi + description: Vertex AI-related information associated with the finding. + type: object + properties: + datasets: + description: Datasets associated with the finding. + type: array + items: + $ref: '#/components/schemas/Dataset' + pipelines: + description: Pipelines associated with the finding. + type: array + items: + $ref: '#/components/schemas/Pipeline' + Dataset: + id: Dataset + description: Vertex AI dataset associated with the finding. + type: object + properties: + name: + description: >- + Resource name of the dataset, e.g. + projects/{project}/locations/{location}/datasets/2094040236064505856 + type: string + displayName: + description: The user defined display name of dataset, e.g. plants-dataset + type: string + source: + description: >- + Data source, such as BigQuery source URI, e.g. + bq://scc-nexus-test.AIPPtest.gsod + type: string + Pipeline: + id: Pipeline + description: Vertex AI training pipeline associated with the finding. + type: object + properties: + name: + description: >- + Resource name of the pipeline, e.g. + projects/{project}/locations/{location}/trainingPipelines/5253428229225578496 + type: string + displayName: + description: >- + The user defined display name of pipeline, e.g. + plants-classification + type: string GoogleCloudSecuritycenterV1MuteConfig: id: GoogleCloudSecuritycenterV1MuteConfig description: >- @@ -3318,7 +4173,7 @@ components: type: string enumDescriptions: - The cloud provider is unspecified. - - The cloud provider is Google Cloud Platform. + - The cloud provider is Google Cloud. - The cloud provider is Amazon Web Services. - The cloud provider is Microsoft Azure. enum: @@ -3836,6 +4691,19 @@ components: contain alphanumeric characters or underscores only. readOnly: true type: string + cloudProvider: + description: The cloud provider of the custom module. + type: string + enumDescriptions: + - Unspecified cloud provider. + - Google Cloud. + - Amazon Web Services. + - Microsoft Azure. + enum: + - CLOUD_PROVIDER_UNSPECIFIED + - GOOGLE_CLOUD_PLATFORM + - AMAZON_WEB_SERVICES + - MICROSOFT_AZURE GroupAssetsRequest: id: GroupAssetsRequest description: Request message for grouping by assets. @@ -4408,7 +5276,7 @@ components: type: string enumDescriptions: - The cloud provider is unspecified. - - The cloud provider is Google Cloud Platform. + - The cloud provider is Google Cloud. - The cloud provider is Amazon Web Services. - The cloud provider is Microsoft Azure. enum: @@ -4962,10 +5830,23 @@ components: description: Output only. The editor the module was last updated by. readOnly: true type: string - ListDescendantEventThreatDetectionCustomModulesResponse: - id: ListDescendantEventThreatDetectionCustomModulesResponse - description: >- - Response for listing current and descendant resident Event Threat + cloudProvider: + description: The cloud provider of the custom module. + type: string + enumDescriptions: + - Unspecified cloud provider. + - Google Cloud. + - Amazon Web Services (AWS). + - Microsoft Azure. + enum: + - CLOUD_PROVIDER_UNSPECIFIED + - GOOGLE_CLOUD_PLATFORM + - AMAZON_WEB_SERVICES + - MICROSOFT_AZURE + ListDescendantEventThreatDetectionCustomModulesResponse: + id: ListDescendantEventThreatDetectionCustomModulesResponse + description: >- + Response for listing current and descendant resident Event Threat Detection custom modules. type: object properties: @@ -5025,6 +5906,7 @@ components: type: object properties: errors: + description: The list of errors. type: array items: $ref: '#/components/schemas/CustomModuleValidationError' @@ -5055,7 +5937,7 @@ components: description: >- The end position of the error in the uploaded text version of the module. This field may be omitted if no specific position applies, - or if one could not be computed.. + or if one could not be computed. $ref: '#/components/schemas/Position' Position: id: Position @@ -5063,9 +5945,11 @@ components: type: object properties: lineNumber: + description: The line number. type: integer format: int32 columnNumber: + description: The column number. type: integer format: int32 EffectiveEventThreatDetectionCustomModule: @@ -5127,6 +6011,19 @@ components: description: Output only. The description for the module. readOnly: true type: string + cloudProvider: + description: The cloud provider of the custom module. + type: string + enumDescriptions: + - Unspecified cloud provider. + - Google Cloud. + - Amazon Web Services. + - Microsoft Azure. + enum: + - CLOUD_PROVIDER_UNSPECIFIED + - GOOGLE_CLOUD_PLATFORM + - AMAZON_WEB_SERVICES + - MICROSOFT_AZURE ListEffectiveEventThreatDetectionCustomModulesResponse: id: ListEffectiveEventThreatDetectionCustomModulesResponse description: Response for listing EffectiveEventThreatDetectionCustomModules. @@ -5190,9 +6087,10 @@ components: - NONE tagValues: description: >- - Required. Tag values combined with `AND` to check against. Values in - the form "tagValues/123" Example: `[ "tagValues/123", - "tagValues/456", "tagValues/789" ]` + Required. Tag values combined with `AND` to check against. For + Google Cloud resources, they are tag value IDs in the form of + "tagValues/123". Example: `[ "tagValues/123", "tagValues/456", + "tagValues/789" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing type: array items: @@ -5243,7 +6141,7 @@ components: type: string enumDescriptions: - The cloud provider is unspecified. - - The cloud provider is Google Cloud Platform. + - The cloud provider is Google Cloud. - The cloud provider is Amazon Web Services. - The cloud provider is Microsoft Azure. enum: @@ -5571,7 +6469,7 @@ components: type: string enumDescriptions: - The cloud provider is unspecified. - - The cloud provider is Google Cloud Platform. + - The cloud provider is Google Cloud. - The cloud provider is Amazon Web Services. - The cloud provider is Microsoft Azure. enum: @@ -5829,6 +6727,13 @@ components: removed from all findings. type: string format: google-datetime + cryptoKeyName: + description: >- + Output only. The resource name of the Cloud KMS `CryptoKey` used to + encrypt this configuration data, if CMEK was enabled during Security + Command Center activation. + readOnly: true + type: string GoogleCloudSecuritycenterV2BigQueryExport: id: GoogleCloudSecuritycenterV2BigQueryExport description: Configures how to deliver Findings to BigQuery Instance. @@ -5901,6 +6806,13 @@ components: table and upload data to the BigQuery dataset. readOnly: true type: string + cryptoKeyName: + description: >- + Output only. The resource name of the Cloud KMS `CryptoKey` used to + protect this configuration's data, if configured during Security + Command Center activation. + readOnly: true + type: string GoogleCloudSecuritycenterV2NotificationMessage: id: GoogleCloudSecuritycenterV2NotificationMessage description: Cloud SCC's Notification @@ -5929,7 +6841,7 @@ components: properties: name: description: >- - The [relative resource + Identifier. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. The following list shows some examples: + `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}` @@ -6141,6 +7053,9 @@ components: - >- Describes a potential security risk to data assets that contain sensitive data. + - >- + Describes a resource or resource group where high risk attack + paths converge, based on attack path simulations (APS). enum: - FINDING_CLASS_UNSPECIFIED - THREAT @@ -6151,6 +7066,7 @@ components: - POSTURE_VIOLATION - TOXIC_COMBINATION - SENSITIVE_DATA_RISK + - CHOKEPOINT indicator: description: >- Represents what's commonly known as an *indicator of compromise* @@ -6292,9 +7208,15 @@ components: type: array items: $ref: '#/components/schemas/GoogleCloudSecuritycenterV2OrgPolicy' + job: + description: Job associated with the finding. + $ref: '#/components/schemas/GoogleCloudSecuritycenterV2Job' application: description: Represents an application associated with the finding. $ref: '#/components/schemas/GoogleCloudSecuritycenterV2Application' + ipRules: + description: IP rules associated with the finding. + $ref: '#/components/schemas/GoogleCloudSecuritycenterV2IpRules' backupDisasterRecovery: description: Fields related to Backup and DR findings. $ref: >- @@ -6335,6 +7257,9 @@ components: type: array items: $ref: '#/components/schemas/GoogleCloudSecuritycenterV2GroupMembership' + disk: + description: Disk associated with the finding. + $ref: '#/components/schemas/GoogleCloudSecuritycenterV2Disk' dataAccessEvents: description: Data access events associated with the finding. type: array @@ -6345,6 +7270,44 @@ components: type: array items: $ref: '#/components/schemas/GoogleCloudSecuritycenterV2DataFlowEvent' + networks: + description: Represents the VPC networks that the resource is attached to. + type: array + items: + $ref: '#/components/schemas/GoogleCloudSecuritycenterV2Network' + dataRetentionDeletionEvents: + description: Data retention deletion events associated with the finding. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudSecuritycenterV2DataRetentionDeletionEvent + affectedResources: + description: AffectedResources associated with the finding. + $ref: '#/components/schemas/GoogleCloudSecuritycenterV2AffectedResources' + aiModel: + description: The AI model associated with the finding. + $ref: '#/components/schemas/GoogleCloudSecuritycenterV2AiModel' + chokepoint: + description: >- + Contains details about a chokepoint, which is a resource or resource + group where high-risk attack paths converge, based on [attack path + simulations] + (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). + This field cannot be updated. Its value is ignored in all update + requests. + $ref: '#/components/schemas/GoogleCloudSecuritycenterV2Chokepoint' + complianceDetails: + description: Details about the compliance implications of the finding. + $ref: '#/components/schemas/GoogleCloudSecuritycenterV2ComplianceDetails' + vertexAi: + description: VertexAi associated with the finding. + $ref: '#/components/schemas/GoogleCloudSecuritycenterV2VertexAi' + cryptoKeyName: + description: >- + Output only. The name of the Cloud KMS key used to encrypt this + finding, if any. + readOnly: true + type: string GoogleCloudSecuritycenterV2SecurityMarks: id: GoogleCloudSecuritycenterV2SecurityMarks description: >- @@ -6564,6 +7527,24 @@ components: securityBulletin: description: The security bulletin is relevant to this finding. $ref: '#/components/schemas/GoogleCloudSecuritycenterV2SecurityBulletin' + providerRiskScore: + description: >- + Provider provided risk_score based on multiple factors. The higher + the risk score, the more risky the vulnerability is. + type: string + format: int64 + reachable: + description: >- + Represents whether the vulnerability is reachable (detected via + static analysis) + type: boolean + cwes: + description: >- + Represents one or more Common Weakness Enumeration (CWE) information + on this vulnerability. + type: array + items: + $ref: '#/components/schemas/GoogleCloudSecuritycenterV2Cwe' GoogleCloudSecuritycenterV2Cve: id: GoogleCloudSecuritycenterV2Cve description: >- @@ -6865,6 +7846,23 @@ components: notification should be upgraded to, based on its current version. For example, 1.15.0 type: string + GoogleCloudSecuritycenterV2Cwe: + id: GoogleCloudSecuritycenterV2Cwe + description: >- + CWE stands for Common Weakness Enumeration. Information about this + weakness, as described by [CWE](https://cwe.mitre.org/). + type: object + properties: + id: + description: The CWE identifier, e.g. CWE-94 + type: string + references: + description: >- + Any reference to the details on the CWE, for example, + https://cwe.mitre.org/data/definitions/94.html + type: array + items: + $ref: '#/components/schemas/GoogleCloudSecuritycenterV2Reference' GoogleCloudSecuritycenterV2MitreAttack: id: GoogleCloudSecuritycenterV2MitreAttack description: >- @@ -6923,11 +7921,30 @@ components: type: string enumDescriptions: - Unspecified value. + - T1001 + - T1001.002 + - T1003 + - T1003.007 + - T1003.008 + - T1005 + - T1020 + - T1027 + - T1027.003 + - T1027.004 + - T1027.010 + - T1029 + - T1033 - T1036 - T1036.005 - T1037 - T1037.005 - T1046 + - T1053 + - T1053.003 + - T1053.007 + - T1055 + - T1056 + - T1056.001 - T1057 - T1059 - T1059.004 @@ -6935,7 +7952,12 @@ components: - T1068 - T1069 - T1069.003 + - T1070 + - T1070.002 + - T1070.003 - T1070.004 + - T1070.006 + - T1070.008 - T1071 - T1071.004 - T1072 @@ -6943,59 +7965,125 @@ components: - T1078.001 - T1078.003 - T1078.004 + - T1083 + - T1087.001 - T1090 - T1090.002 - T1090.003 - T1098 - T1098.001 + - T1098.003 - T1098.004 - T1098.006 + - T1104 - T1105 - T1106 - T1110 + - T1119 - T1129 + - T1132 + - T1132.001 - T1134 - T1134.001 + - T1136 + - T1136.001 + - T1140 - T1190 + - T1195 + - T1195.001 + - T1203 + - T1204 + - T1222.002 - T1484 - T1485 + - T1486 - T1489 - T1490 + - T1495 - T1496 - T1498 - T1526 - T1528 - T1531 + - T1537 - T1539 - T1543 - T1546 + - T1547 + - T1547.006 + - T1547.009 - T1548 + - T1548.001 + - T1548.003 - T1552 + - T1552.001 + - T1552.003 + - T1552.004 + - T1553 + - T1553.004 + - T1554 + - T1555 - T1556 + - T1556.003 + - T1556.006 - T1562 - T1562.001 + - T1562.006 + - T1562.012 + - T1564 + - T1564.001 + - T1564.002 - T1567 - T1567.002 - T1568 - T1570 + - T1574 + - T1574.006 - T1578 - T1578.001 - T1580 + - T1587 + - T1587.001 - T1588 + - T1588.001 + - T1588.006 - T1595 - T1595.001 + - T1608 + - T1608.001 - T1609 - T1610 - T1611 - T1613 + - T1620 - T1649 + - T1657 enum: - TECHNIQUE_UNSPECIFIED + - DATA_OBFUSCATION + - DATA_OBFUSCATION_STEGANOGRAPHY + - OS_CREDENTIAL_DUMPING + - OS_CREDENTIAL_DUMPING_PROC_FILESYSTEM + - OS_CREDENTIAL_DUMPING_ETC_PASSWORD_AND_ETC_SHADOW + - DATA_FROM_LOCAL_SYSTEM + - AUTOMATED_EXFILTRATION + - OBFUSCATED_FILES_OR_INFO + - STEGANOGRAPHY + - COMPILE_AFTER_DELIVERY + - COMMAND_OBFUSCATION + - SCHEDULED_TRANSFER + - SYSTEM_OWNER_USER_DISCOVERY - MASQUERADING - MATCH_LEGITIMATE_NAME_OR_LOCATION - BOOT_OR_LOGON_INITIALIZATION_SCRIPTS - STARTUP_ITEMS - NETWORK_SERVICE_DISCOVERY + - SCHEDULED_TASK_JOB + - SCHEDULED_TASK_JOB_CRON + - CONTAINER_ORCHESTRATION_JOB + - PROCESS_INJECTION + - INPUT_CAPTURE + - INPUT_CAPTURE_KEYLOGGING - PROCESS_DISCOVERY - COMMAND_AND_SCRIPTING_INTERPRETER - UNIX_SHELL @@ -7003,7 +8091,12 @@ components: - EXPLOITATION_FOR_PRIVILEGE_ESCALATION - PERMISSION_GROUPS_DISCOVERY - CLOUD_GROUPS + - INDICATOR_REMOVAL + - INDICATOR_REMOVAL_CLEAR_LINUX_OR_MAC_SYSTEM_LOGS + - INDICATOR_REMOVAL_CLEAR_COMMAND_HISTORY - INDICATOR_REMOVAL_FILE_DELETION + - INDICATOR_REMOVAL_TIMESTOMP + - INDICATOR_REMOVAL_CLEAR_MAILBOX_DATA - APPLICATION_LAYER_PROTOCOL - DNS - SOFTWARE_DEPLOYMENT_TOOLS @@ -7011,52 +8104,99 @@ components: - DEFAULT_ACCOUNTS - LOCAL_ACCOUNTS - CLOUD_ACCOUNTS + - FILE_AND_DIRECTORY_DISCOVERY + - ACCOUNT_DISCOVERY_LOCAL_ACCOUNT - PROXY - EXTERNAL_PROXY - MULTI_HOP_PROXY - ACCOUNT_MANIPULATION - ADDITIONAL_CLOUD_CREDENTIALS + - ADDITIONAL_CLOUD_ROLES - SSH_AUTHORIZED_KEYS - ADDITIONAL_CONTAINER_CLUSTER_ROLES + - MULTI_STAGE_CHANNELS - INGRESS_TOOL_TRANSFER - NATIVE_API - BRUTE_FORCE + - AUTOMATED_COLLECTION - SHARED_MODULES + - DATA_ENCODING + - STANDARD_ENCODING - ACCESS_TOKEN_MANIPULATION - TOKEN_IMPERSONATION_OR_THEFT + - CREATE_ACCOUNT + - LOCAL_ACCOUNT + - DEOBFUSCATE_DECODE_FILES_OR_INFO - EXPLOIT_PUBLIC_FACING_APPLICATION + - SUPPLY_CHAIN_COMPROMISE + - COMPROMISE_SOFTWARE_DEPENDENCIES_AND_DEVELOPMENT_TOOLS + - EXPLOITATION_FOR_CLIENT_EXECUTION + - USER_EXECUTION + - LINUX_AND_MAC_FILE_AND_DIRECTORY_PERMISSIONS_MODIFICATION - DOMAIN_POLICY_MODIFICATION - DATA_DESTRUCTION + - DATA_ENCRYPTED_FOR_IMPACT - SERVICE_STOP - INHIBIT_SYSTEM_RECOVERY + - FIRMWARE_CORRUPTION - RESOURCE_HIJACKING - NETWORK_DENIAL_OF_SERVICE - CLOUD_SERVICE_DISCOVERY - STEAL_APPLICATION_ACCESS_TOKEN - ACCOUNT_ACCESS_REMOVAL + - TRANSFER_DATA_TO_CLOUD_ACCOUNT - STEAL_WEB_SESSION_COOKIE - CREATE_OR_MODIFY_SYSTEM_PROCESS - EVENT_TRIGGERED_EXECUTION + - BOOT_OR_LOGON_AUTOSTART_EXECUTION + - KERNEL_MODULES_AND_EXTENSIONS + - SHORTCUT_MODIFICATION - ABUSE_ELEVATION_CONTROL_MECHANISM + - ABUSE_ELEVATION_CONTROL_MECHANISM_SETUID_AND_SETGID + - ABUSE_ELEVATION_CONTROL_MECHANISM_SUDO_AND_SUDO_CACHING - UNSECURED_CREDENTIALS + - CREDENTIALS_IN_FILES + - BASH_HISTORY + - PRIVATE_KEYS + - SUBVERT_TRUST_CONTROL + - INSTALL_ROOT_CERTIFICATE + - COMPROMISE_HOST_SOFTWARE_BINARY + - CREDENTIALS_FROM_PASSWORD_STORES - MODIFY_AUTHENTICATION_PROCESS + - PLUGGABLE_AUTHENTICATION_MODULES + - MULTI_FACTOR_AUTHENTICATION - IMPAIR_DEFENSES - DISABLE_OR_MODIFY_TOOLS + - INDICATOR_BLOCKING + - DISABLE_OR_MODIFY_LINUX_AUDIT_SYSTEM + - HIDE_ARTIFACTS + - HIDDEN_FILES_AND_DIRECTORIES + - HIDDEN_USERS - EXFILTRATION_OVER_WEB_SERVICE - EXFILTRATION_TO_CLOUD_STORAGE - DYNAMIC_RESOLUTION - LATERAL_TOOL_TRANSFER + - HIJACK_EXECUTION_FLOW + - HIJACK_EXECUTION_FLOW_DYNAMIC_LINKER_HIJACKING - MODIFY_CLOUD_COMPUTE_INFRASTRUCTURE - CREATE_SNAPSHOT - CLOUD_INFRASTRUCTURE_DISCOVERY + - DEVELOP_CAPABILITIES + - DEVELOP_CAPABILITIES_MALWARE - OBTAIN_CAPABILITIES + - OBTAIN_CAPABILITIES_MALWARE + - OBTAIN_CAPABILITIES_VULNERABILITIES - ACTIVE_SCANNING - SCANNING_IP_BLOCKS + - STAGE_CAPABILITIES + - UPLOAD_MALWARE - CONTAINER_ADMINISTRATION_COMMAND - DEPLOY_CONTAINER - ESCAPE_TO_HOST - CONTAINER_AND_RESOURCE_DISCOVERY + - REFLECTIVE_CODE_LOADING - STEAL_OR_FORGE_AUTHENTICATION_CERTIFICATES + - FINANCIAL_THEFT additionalTactics: description: Additional MITRE ATT&CK tactics related to this finding, if any. type: array @@ -7103,11 +8243,30 @@ components: type: string enumDescriptions: - Unspecified value. + - T1001 + - T1001.002 + - T1003 + - T1003.007 + - T1003.008 + - T1005 + - T1020 + - T1027 + - T1027.003 + - T1027.004 + - T1027.010 + - T1029 + - T1033 - T1036 - T1036.005 - T1037 - T1037.005 - T1046 + - T1053 + - T1053.003 + - T1053.007 + - T1055 + - T1056 + - T1056.001 - T1057 - T1059 - T1059.004 @@ -7115,7 +8274,12 @@ components: - T1068 - T1069 - T1069.003 + - T1070 + - T1070.002 + - T1070.003 - T1070.004 + - T1070.006 + - T1070.008 - T1071 - T1071.004 - T1072 @@ -7123,59 +8287,125 @@ components: - T1078.001 - T1078.003 - T1078.004 + - T1083 + - T1087.001 - T1090 - T1090.002 - T1090.003 - T1098 - T1098.001 + - T1098.003 - T1098.004 - T1098.006 + - T1104 - T1105 - T1106 - T1110 + - T1119 - T1129 + - T1132 + - T1132.001 - T1134 - T1134.001 + - T1136 + - T1136.001 + - T1140 - T1190 + - T1195 + - T1195.001 + - T1203 + - T1204 + - T1222.002 - T1484 - T1485 + - T1486 - T1489 - T1490 + - T1495 - T1496 - T1498 - T1526 - T1528 - T1531 + - T1537 - T1539 - T1543 - T1546 + - T1547 + - T1547.006 + - T1547.009 - T1548 + - T1548.001 + - T1548.003 - T1552 + - T1552.001 + - T1552.003 + - T1552.004 + - T1553 + - T1553.004 + - T1554 + - T1555 - T1556 + - T1556.003 + - T1556.006 - T1562 - T1562.001 + - T1562.006 + - T1562.012 + - T1564 + - T1564.001 + - T1564.002 - T1567 - T1567.002 - T1568 - T1570 + - T1574 + - T1574.006 - T1578 - T1578.001 - T1580 + - T1587 + - T1587.001 - T1588 + - T1588.001 + - T1588.006 - T1595 - T1595.001 + - T1608 + - T1608.001 - T1609 - T1610 - T1611 - T1613 + - T1620 - T1649 + - T1657 enum: - TECHNIQUE_UNSPECIFIED + - DATA_OBFUSCATION + - DATA_OBFUSCATION_STEGANOGRAPHY + - OS_CREDENTIAL_DUMPING + - OS_CREDENTIAL_DUMPING_PROC_FILESYSTEM + - OS_CREDENTIAL_DUMPING_ETC_PASSWORD_AND_ETC_SHADOW + - DATA_FROM_LOCAL_SYSTEM + - AUTOMATED_EXFILTRATION + - OBFUSCATED_FILES_OR_INFO + - STEGANOGRAPHY + - COMPILE_AFTER_DELIVERY + - COMMAND_OBFUSCATION + - SCHEDULED_TRANSFER + - SYSTEM_OWNER_USER_DISCOVERY - MASQUERADING - MATCH_LEGITIMATE_NAME_OR_LOCATION - BOOT_OR_LOGON_INITIALIZATION_SCRIPTS - STARTUP_ITEMS - NETWORK_SERVICE_DISCOVERY + - SCHEDULED_TASK_JOB + - SCHEDULED_TASK_JOB_CRON + - CONTAINER_ORCHESTRATION_JOB + - PROCESS_INJECTION + - INPUT_CAPTURE + - INPUT_CAPTURE_KEYLOGGING - PROCESS_DISCOVERY - COMMAND_AND_SCRIPTING_INTERPRETER - UNIX_SHELL @@ -7183,7 +8413,12 @@ components: - EXPLOITATION_FOR_PRIVILEGE_ESCALATION - PERMISSION_GROUPS_DISCOVERY - CLOUD_GROUPS + - INDICATOR_REMOVAL + - INDICATOR_REMOVAL_CLEAR_LINUX_OR_MAC_SYSTEM_LOGS + - INDICATOR_REMOVAL_CLEAR_COMMAND_HISTORY - INDICATOR_REMOVAL_FILE_DELETION + - INDICATOR_REMOVAL_TIMESTOMP + - INDICATOR_REMOVAL_CLEAR_MAILBOX_DATA - APPLICATION_LAYER_PROTOCOL - DNS - SOFTWARE_DEPLOYMENT_TOOLS @@ -7191,52 +8426,99 @@ components: - DEFAULT_ACCOUNTS - LOCAL_ACCOUNTS - CLOUD_ACCOUNTS + - FILE_AND_DIRECTORY_DISCOVERY + - ACCOUNT_DISCOVERY_LOCAL_ACCOUNT - PROXY - EXTERNAL_PROXY - MULTI_HOP_PROXY - ACCOUNT_MANIPULATION - ADDITIONAL_CLOUD_CREDENTIALS + - ADDITIONAL_CLOUD_ROLES - SSH_AUTHORIZED_KEYS - ADDITIONAL_CONTAINER_CLUSTER_ROLES + - MULTI_STAGE_CHANNELS - INGRESS_TOOL_TRANSFER - NATIVE_API - BRUTE_FORCE + - AUTOMATED_COLLECTION - SHARED_MODULES + - DATA_ENCODING + - STANDARD_ENCODING - ACCESS_TOKEN_MANIPULATION - TOKEN_IMPERSONATION_OR_THEFT + - CREATE_ACCOUNT + - LOCAL_ACCOUNT + - DEOBFUSCATE_DECODE_FILES_OR_INFO - EXPLOIT_PUBLIC_FACING_APPLICATION + - SUPPLY_CHAIN_COMPROMISE + - COMPROMISE_SOFTWARE_DEPENDENCIES_AND_DEVELOPMENT_TOOLS + - EXPLOITATION_FOR_CLIENT_EXECUTION + - USER_EXECUTION + - LINUX_AND_MAC_FILE_AND_DIRECTORY_PERMISSIONS_MODIFICATION - DOMAIN_POLICY_MODIFICATION - DATA_DESTRUCTION + - DATA_ENCRYPTED_FOR_IMPACT - SERVICE_STOP - INHIBIT_SYSTEM_RECOVERY + - FIRMWARE_CORRUPTION - RESOURCE_HIJACKING - NETWORK_DENIAL_OF_SERVICE - CLOUD_SERVICE_DISCOVERY - STEAL_APPLICATION_ACCESS_TOKEN - ACCOUNT_ACCESS_REMOVAL + - TRANSFER_DATA_TO_CLOUD_ACCOUNT - STEAL_WEB_SESSION_COOKIE - CREATE_OR_MODIFY_SYSTEM_PROCESS - EVENT_TRIGGERED_EXECUTION + - BOOT_OR_LOGON_AUTOSTART_EXECUTION + - KERNEL_MODULES_AND_EXTENSIONS + - SHORTCUT_MODIFICATION - ABUSE_ELEVATION_CONTROL_MECHANISM + - ABUSE_ELEVATION_CONTROL_MECHANISM_SETUID_AND_SETGID + - ABUSE_ELEVATION_CONTROL_MECHANISM_SUDO_AND_SUDO_CACHING - UNSECURED_CREDENTIALS + - CREDENTIALS_IN_FILES + - BASH_HISTORY + - PRIVATE_KEYS + - SUBVERT_TRUST_CONTROL + - INSTALL_ROOT_CERTIFICATE + - COMPROMISE_HOST_SOFTWARE_BINARY + - CREDENTIALS_FROM_PASSWORD_STORES - MODIFY_AUTHENTICATION_PROCESS + - PLUGGABLE_AUTHENTICATION_MODULES + - MULTI_FACTOR_AUTHENTICATION - IMPAIR_DEFENSES - DISABLE_OR_MODIFY_TOOLS + - INDICATOR_BLOCKING + - DISABLE_OR_MODIFY_LINUX_AUDIT_SYSTEM + - HIDE_ARTIFACTS + - HIDDEN_FILES_AND_DIRECTORIES + - HIDDEN_USERS - EXFILTRATION_OVER_WEB_SERVICE - EXFILTRATION_TO_CLOUD_STORAGE - DYNAMIC_RESOLUTION - LATERAL_TOOL_TRANSFER + - HIJACK_EXECUTION_FLOW + - HIJACK_EXECUTION_FLOW_DYNAMIC_LINKER_HIJACKING - MODIFY_CLOUD_COMPUTE_INFRASTRUCTURE - CREATE_SNAPSHOT - CLOUD_INFRASTRUCTURE_DISCOVERY + - DEVELOP_CAPABILITIES + - DEVELOP_CAPABILITIES_MALWARE - OBTAIN_CAPABILITIES + - OBTAIN_CAPABILITIES_MALWARE + - OBTAIN_CAPABILITIES_VULNERABILITIES - ACTIVE_SCANNING - SCANNING_IP_BLOCKS + - STAGE_CAPABILITIES + - UPLOAD_MALWARE - CONTAINER_ADMINISTRATION_COMMAND - DEPLOY_CONTAINER - ESCAPE_TO_HOST - CONTAINER_AND_RESOURCE_DISCOVERY + - REFLECTIVE_CODE_LOADING - STEAL_OR_FORGE_AUTHENTICATION_CERTIFICATES + - FINANCIAL_THEFT version: description: The MITRE ATT&CK version referenced by the above fields. E.g. "8". type: string @@ -7436,6 +8718,12 @@ components: description: The parent process ID. type: string format: int64 + userId: + description: >- + The ID of the user that executed the process. E.g. If this is the + root user this will always be 0. + type: string + format: int64 GoogleCloudSecuritycenterV2File: id: GoogleCloudSecuritycenterV2File description: >- @@ -7471,6 +8759,11 @@ components: diskPath: description: Path of the file in terms of underlying disk/partition identifiers. $ref: '#/components/schemas/GoogleCloudSecuritycenterV2DiskPath' + operations: + description: Operation(s) performed on a file. + type: array + items: + $ref: '#/components/schemas/GoogleCloudSecuritycenterV2FileOperation' GoogleCloudSecuritycenterV2DiskPath: id: GoogleCloudSecuritycenterV2DiskPath description: Path of the file in terms of underlying disk/partition identifiers. @@ -7486,6 +8779,28 @@ components: Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh type: string + GoogleCloudSecuritycenterV2FileOperation: + id: GoogleCloudSecuritycenterV2FileOperation + description: Operation(s) performed on a file. + type: object + properties: + type: + description: The type of the operation + type: string + enumDescriptions: + - The operation is unspecified. + - Represents an open operation. + - Represents a read operation. + - Represents a rename operation. + - Represents a write operation. + - Represents an execute operation. + enum: + - OPERATION_TYPE_UNSPECIFIED + - OPEN + - READ + - RENAME + - WRITE + - EXECUTE GoogleCloudSecuritycenterV2EnvironmentVariable: id: GoogleCloudSecuritycenterV2EnvironmentVariable description: >- @@ -8109,9 +9424,44 @@ components: properties: name: description: >- - The resource name of the org policy. Example: + Identifier. The resource name of the org policy. Example: "organizations/{organization_id}/policies/{constraint_name}" type: string + GoogleCloudSecuritycenterV2Job: + id: GoogleCloudSecuritycenterV2Job + description: Describes a job + type: object + properties: + name: + description: The fully-qualified name for a job. e.g. `projects//jobs/` + type: string + state: + description: Output only. State of the job, such as `RUNNING` or `PENDING`. + readOnly: true + type: string + enumDescriptions: + - Unspecified represents an unknown state and should not be used. + - Job is scheduled and pending for run + - Job in progress + - Job has completed with success + - Job has completed but with failure + enum: + - JOB_STATE_UNSPECIFIED + - PENDING + - RUNNING + - SUCCEEDED + - FAILED + errorCode: + description: >- + Optional. If the job did not complete successfully, this field + describes why. + type: integer + format: int32 + location: + description: >- + Optional. Gives the location where the job ran, such as `US` or + `europe-west1` + type: string GoogleCloudSecuritycenterV2Application: id: GoogleCloudSecuritycenterV2Application description: Represents an application associated with a finding. @@ -8128,6 +9478,111 @@ components: The full URI with payload that could be used to reproduce the vulnerability. For example, `http://example.com?p=aMmYgI6H`. type: string + GoogleCloudSecuritycenterV2IpRules: + id: GoogleCloudSecuritycenterV2IpRules + description: IP rules associated with the finding. + type: object + properties: + direction: + description: >- + The direction that the rule is applicable to, one of ingress or + egress. + type: string + enumDescriptions: + - Unspecified direction value. + - Ingress direction value. + - Egress direction value. + enum: + - DIRECTION_UNSPECIFIED + - INGRESS + - EGRESS + allowed: + description: Tuple with allowed rules. + $ref: '#/components/schemas/GoogleCloudSecuritycenterV2Allowed' + denied: + description: Tuple with denied rules. + $ref: '#/components/schemas/GoogleCloudSecuritycenterV2Denied' + sourceIpRanges: + description: >- + If source IP 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. Only supports IPv4. + type: array + items: + type: string + destinationIpRanges: + description: >- + If destination IP ranges are specified, the firewall rule applies + only to traffic that has a destination IP address in these ranges. + These ranges must be expressed in CIDR format. Only supports IPv4. + type: array + items: + type: string + exposedServices: + description: >- + Name of the network protocol service, such as FTP, that is exposed + by the open port. Follows the naming convention available at: + https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml. + type: array + items: + type: string + GoogleCloudSecuritycenterV2Allowed: + id: GoogleCloudSecuritycenterV2Allowed + description: Allowed IP rule. + type: object + properties: + ipRules: + description: Optional. Optional list of allowed IP rules. + type: array + items: + $ref: '#/components/schemas/GoogleCloudSecuritycenterV2IpRule' + GoogleCloudSecuritycenterV2IpRule: + id: GoogleCloudSecuritycenterV2IpRule + description: IP rule information. + type: object + properties: + protocol: + description: >- + The IP protocol this rule applies to. This value can either be one + of the following well known protocol strings (TCP, UDP, ICMP, ESP, + AH, IPIP, SCTP) or a string representation of the integer value. + type: string + portRanges: + description: >- + Optional. An optional list of ports to which this rule applies. This + field is only applicable for the UDP or (S)TCP protocols. Each entry + must be either an integer or a range including a min and max port + number. + type: array + items: + $ref: '#/components/schemas/GoogleCloudSecuritycenterV2PortRange' + GoogleCloudSecuritycenterV2PortRange: + id: GoogleCloudSecuritycenterV2PortRange + description: >- + A port range which is inclusive of the min and max values. Values are + between 0 and 2^16-1. The max can be equal / must be not smaller than + the min value. If min and max are equal this indicates that it is a + single port. + type: object + properties: + min: + description: Minimum port value. + type: string + format: int64 + max: + description: Maximum port value. + type: string + format: int64 + GoogleCloudSecuritycenterV2Denied: + id: GoogleCloudSecuritycenterV2Denied + description: Denied IP rule. + type: object + properties: + ipRules: + description: Optional. Optional list of denied IP rules. + type: array + items: + $ref: '#/components/schemas/GoogleCloudSecuritycenterV2IpRule' GoogleCloudSecuritycenterV2BackupDisasterRecovery: id: GoogleCloudSecuritycenterV2BackupDisasterRecovery description: Information related to Google Cloud Backup and DR Service findings. @@ -8426,19 +9881,33 @@ components: description: Information about DDoS attack volume and classification. type: object properties: - volumePps: + volumePpsLong: description: Total PPS (packets per second) volume of attack. - type: integer - format: int32 - volumeBps: + type: string + format: int64 + volumeBpsLong: description: Total BPS (bytes per second) volume of attack. - type: integer - format: int32 + type: string + format: int64 classification: description: >- Type of attack, for example, 'SYN-flood', 'NTP-udp', or 'CHARGEN-udp'. type: string + volumePps: + description: >- + Total PPS (packets per second) volume of attack. Deprecated - refer + to volume_pps_long instead. + deprecated: true + type: integer + format: int32 + volumeBps: + description: >- + Total BPS (bytes per second) volume of attack. Deprecated - refer to + volume_bps_long instead. + deprecated: true + type: integer + format: int32 GoogleCloudSecuritycenterV2Notebook: id: GoogleCloudSecuritycenterV2Notebook description: >- @@ -8499,12 +9968,24 @@ components: enumDescriptions: - Default value. - Group represents a toxic combination. + - Group represents a chokepoint. enum: - GROUP_TYPE_UNSPECIFIED - GROUP_TYPE_TOXIC_COMBINATION + - GROUP_TYPE_CHOKEPOINT groupId: description: ID of the group. type: string + GoogleCloudSecuritycenterV2Disk: + id: GoogleCloudSecuritycenterV2Disk + description: Contains information about the disk associated with the finding. + type: object + properties: + name: + description: >- + The name of the disk, for example, + "https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}". + type: string GoogleCloudSecuritycenterV2DataAccessEvent: id: GoogleCloudSecuritycenterV2DataAccessEvent description: >- @@ -8571,10 +10052,290 @@ components: violatedLocation: description: Non-compliant location of the principal or the data destination. type: string - eventTime: - description: Timestamp of data flow event. + eventTime: + description: Timestamp of data flow event. + type: string + format: google-datetime + GoogleCloudSecuritycenterV2Network: + id: GoogleCloudSecuritycenterV2Network + description: Contains information about a VPC network associated with the finding. + type: object + properties: + name: + description: >- + The name of the VPC network resource, for example, + `//compute.googleapis.com/projects/my-project/global/networks/my-network`. + type: string + GoogleCloudSecuritycenterV2DataRetentionDeletionEvent: + id: GoogleCloudSecuritycenterV2DataRetentionDeletionEvent + description: >- + Details about data retention deletion violations, in which the data is + non-compliant based on their retention or deletion time, as defined in + the applicable data security policy. The Data Retention Deletion (DRD) + control is a control of the DSPM (Data Security Posture Management) + suite that enables organizations to manage data retention and deletion + policies in compliance with regulations, such as GDPR and CRPA. DRD + supports two primary policy types: maximum storage length (max TTL) and + minimum storage length (min TTL). Both are aimed at helping + organizations meet regulatory and data management commitments. + type: object + properties: + eventDetectionTime: + description: Timestamp indicating when the event was detected. + type: string + format: google-datetime + dataObjectCount: + description: >- + Number of objects that violated the policy for this resource. If the + number is less than 1,000, then the value of this field is the exact + number. If the number of objects that violated the policy is greater + than or equal to 1,000, then the value of this field is 1000. + type: string + format: int64 + maxRetentionAllowed: + description: >- + Maximum duration of retention allowed from the DRD control. This + comes from the DRD control where users set a max TTL for their data. + For example, suppose that a user sets the max TTL for a Cloud + Storage bucket to 90 days. However, an object in that bucket is 100 + days old. In this case, a DataRetentionDeletionEvent will be + generated for that Cloud Storage bucket, and the + max_retention_allowed is 90 days. + type: string + format: google-duration + eventType: + description: Type of the DRD event. + type: string + enumDescriptions: + - Unspecified event type. + - The maximum retention time has been exceeded. + enum: + - EVENT_TYPE_UNSPECIFIED + - EVENT_TYPE_MAX_TTL_EXCEEDED + GoogleCloudSecuritycenterV2AffectedResources: + id: GoogleCloudSecuritycenterV2AffectedResources + description: Details about resources affected by this finding. + type: object + properties: + count: + description: The count of resources affected by the finding. + type: string + format: int64 + GoogleCloudSecuritycenterV2AiModel: + id: GoogleCloudSecuritycenterV2AiModel + description: Contains information about the AI model associated with the finding. + type: object + properties: + name: + description: The name of the AI model, for example, "gemini:1.0.0". + type: string + domain: + description: The domain of the model, for example, “image-classification”. + type: string + library: + description: The name of the model library, for example, “transformers”. + type: string + location: + description: The region in which the model is used, for example, “us-central1”. + type: string + publisher: + description: The publisher of the model, for example, “google” or “nvidia”. + type: string + deploymentPlatform: + description: The platform on which the model is deployed. + type: string + enumDescriptions: + - Unspecified deployment platform. + - Vertex AI. + - Google Kubernetes Engine. + enum: + - DEPLOYMENT_PLATFORM_UNSPECIFIED + - VERTEX_AI + - GKE + displayName: + description: >- + The user defined display name of model. Ex. + baseline-classification-model + type: string + GoogleCloudSecuritycenterV2Chokepoint: + id: GoogleCloudSecuritycenterV2Chokepoint + description: >- + Contains details about a chokepoint, which is a resource or resource + group where high-risk attack paths converge, based on [attack path + simulations] + (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). + type: object + properties: + relatedFindings: + description: >- + List of resource names of findings associated with this chokepoint. + For example, organizations/123/sources/456/findings/789. This list + will have at most 100 findings. + type: array + items: + type: string + GoogleCloudSecuritycenterV2ComplianceDetails: + id: GoogleCloudSecuritycenterV2ComplianceDetails + description: Compliance Details associated with the finding. + type: object + properties: + frameworks: + description: Details of Frameworks associated with the finding + type: array + items: + $ref: '#/components/schemas/GoogleCloudSecuritycenterV2Framework' + cloudControl: + description: CloudControl associated with the finding + $ref: '#/components/schemas/GoogleCloudSecuritycenterV2CloudControl' + cloudControlDeploymentNames: + description: >- + Cloud Control Deployments associated with the finding. For example, + organizations/123/locations/global/cloudControlDeployments/deploymentIdentifier + type: array + items: + type: string + GoogleCloudSecuritycenterV2Framework: + id: GoogleCloudSecuritycenterV2Framework + description: Compliance framework associated with the finding. + type: object + properties: + name: + description: Name of the framework associated with the finding + type: string + displayName: + description: >- + Display name of the framework. For a standard framework, this will + look like e.g. PCI DSS 3.2.1, whereas for a custom framework it can + be a user defined string like MyFramework + type: string + category: + description: >- + Category of the framework associated with the finding. E.g. Security + Benchmark, or Assured Workloads + type: array + items: + type: string + enumDescriptions: + - Default value. This value is unused. + - Security Benchmarks framework + - Assured Workloads framework + - Data Security framework + - Google Best Practices framework + enum: + - FRAMEWORK_CATEGORY_UNSPECIFIED + - SECURITY_BENCHMARKS + - ASSURED_WORKLOADS + - DATA_SECURITY + - GOOGLE_BEST_PRACTICES + type: + description: >- + Type of the framework associated with the finding, to specify + whether the framework is built-in (pre-defined and immutable) or a + custom framework defined by the customer (equivalent to security + posture) + type: string + enumDescriptions: + - Default value. This value is unused. + - >- + The framework is a built-in framework if it is created and managed + by GCP. + - >- + The framework is a custom framework if it is created and managed + by the user. + enum: + - FRAMEWORK_TYPE_UNSPECIFIED + - FRAMEWORK_TYPE_BUILT_IN + - FRAMEWORK_TYPE_CUSTOM + controls: + description: The controls associated with the framework. + type: array + items: + $ref: '#/components/schemas/GoogleCloudSecuritycenterV2Control' + GoogleCloudSecuritycenterV2Control: + id: GoogleCloudSecuritycenterV2Control + description: Compliance control associated with the finding. + type: object + properties: + controlName: + description: Name of the Control + type: string + displayName: + description: Display name of the control. For example, AU-02. + type: string + GoogleCloudSecuritycenterV2CloudControl: + id: GoogleCloudSecuritycenterV2CloudControl + description: CloudControl associated with the finding. + type: object + properties: + cloudControlName: + description: Name of the CloudControl associated with the finding. + type: string + type: + description: Type of cloud control. + type: string + enumDescriptions: + - Unspecified. + - Built in Cloud Control. + - Custom Cloud Control. + enum: + - CLOUD_CONTROL_TYPE_UNSPECIFIED + - BUILT_IN + - CUSTOM + policyType: + description: Policy type of the CloudControl + type: string + version: + description: Version of the Cloud Control + type: integer + format: int32 + GoogleCloudSecuritycenterV2VertexAi: + id: GoogleCloudSecuritycenterV2VertexAi + description: Vertex AI-related information associated with the finding. + type: object + properties: + datasets: + description: Datasets associated with the finding. + type: array + items: + $ref: '#/components/schemas/GoogleCloudSecuritycenterV2Dataset' + pipelines: + description: Pipelines associated with the finding. + type: array + items: + $ref: '#/components/schemas/GoogleCloudSecuritycenterV2Pipeline' + GoogleCloudSecuritycenterV2Dataset: + id: GoogleCloudSecuritycenterV2Dataset + description: Vertex AI dataset associated with the finding. + type: object + properties: + name: + description: >- + Resource name of the dataset, e.g. + projects/{project}/locations/{location}/datasets/2094040236064505856 + type: string + displayName: + description: The user defined display name of dataset, e.g. plants-dataset + type: string + source: + description: >- + Data source, such as a BigQuery source URI, e.g. + bq://scc-nexus-test.AIPPtest.gsod + type: string + GoogleCloudSecuritycenterV2Pipeline: + id: GoogleCloudSecuritycenterV2Pipeline + description: Vertex AI training pipeline associated with the finding. + type: object + properties: + name: + description: >- + Resource name of the pipeline, e.g. + projects/{project}/locations/{location}/trainingPipelines/5253428229225578496 + type: string + displayName: + description: >- + The user-defined display name of pipeline, e.g. + plants-classification type: string - format: google-datetime GoogleCloudSecuritycenterV2Resource: id: GoogleCloudSecuritycenterV2Resource description: Information related to the Google Cloud resource. @@ -8596,7 +10357,7 @@ components: type: string enumDescriptions: - The cloud provider is unspecified. - - The cloud provider is Google Cloud Platform. + - The cloud provider is Google Cloud. - The cloud provider is Amazon Web Services. - The cloud provider is Microsoft Azure. enum: @@ -8611,7 +10372,7 @@ components: description: The region or location of the service (if applicable). type: string gcpMetadata: - description: The GCP metadata associated with the finding. + description: The Google Cloud metadata associated with the finding. $ref: '#/components/schemas/GcpMetadata' awsMetadata: description: The AWS metadata associated with the finding. @@ -8638,8 +10399,8 @@ components: GcpMetadata: id: GcpMetadata description: >- - GCP metadata associated with the resource, only applicable if the - finding's cloud provider is Google Cloud Platform. + Google Cloud metadata associated with the resource. Only applicable if + the finding's cloud provider is Google Cloud. type: object properties: project: @@ -8905,9 +10666,9 @@ components: - NONE tagValues: description: >- - Tag values combined with `AND` to check against. Values in the form - "tagValues/123" Example: `[ "tagValues/123", "tagValues/456", - "tagValues/789" ]` + Tag values combined with `AND` to check against. For Google Cloud + resources, they are tag value IDs in the form of "tagValues/123". + Example: `[ "tagValues/123", "tagValues/456", "tagValues/789" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing type: array items: @@ -8958,7 +10719,7 @@ components: type: string enumDescriptions: - The cloud provider is unspecified. - - The cloud provider is Google Cloud Platform. + - The cloud provider is Google Cloud. - The cloud provider is Amazon Web Services. - The cloud provider is Microsoft Azure. enum: @@ -9016,51 +10777,6 @@ components: - MEDIUM - LOW - NONE - ComplianceSnapshot: - id: ComplianceSnapshot - description: >- - Result containing the properties and count of a ComplianceSnapshot - request. - type: object - properties: - name: - description: >- - The compliance snapshot name. Format: - //sources//complianceSnapshots/ - type: string - cloudProvider: - description: The cloud provider for the compliance snapshot. - type: string - enumDescriptions: - - The cloud provider is unspecified. - - The cloud provider is Google Cloud Platform. - - The cloud provider is Amazon Web Services. - - The cloud provider is Microsoft Azure. - enum: - - CLOUD_PROVIDER_UNSPECIFIED - - GOOGLE_CLOUD_PLATFORM - - AMAZON_WEB_SERVICES - - MICROSOFT_AZURE - category: - description: The category of Findings matching. - type: string - leafContainerResource: - description: The leaf container resource name that is closest to the snapshot. - type: string - complianceStandard: - description: The compliance standard (ie CIS). - type: string - complianceVersion: - description: The compliance version (ie 1.3) in CIS 1.3. - type: string - count: - description: Total count of findings for the given properties. - type: string - format: int64 - snapshotTime: - description: The snapshot time of the snapshot. - type: string - format: google-datetime VulnerabilitySnapshot: id: VulnerabilitySnapshot description: >- @@ -9078,7 +10794,7 @@ components: type: string enumDescriptions: - The cloud provider is unspecified. - - The cloud provider is Google Cloud Platform. + - The cloud provider is Google Cloud. - The cloud provider is Amazon Web Services. - The cloud provider is Microsoft Azure. enum: @@ -9104,6 +10820,335 @@ components: additionalProperties: type: string format: int64 + GoogleCloudSecuritycenterV2Issue: + id: GoogleCloudSecuritycenterV2Issue + description: Security Command Center Issue. + type: object + properties: + name: + description: >- + Identifier. The name of the issue. Format: + organizations/{organization}/locations/{location}/issues/{issue} + type: string + detection: + description: The finding category or rule name that generated the issue. + type: string + description: + description: The description of the issue in Markdown format. + type: string + remediations: + description: Approaches to remediate the issue in Markdown format. + type: array + items: + type: string + severity: + description: The severity of the issue. + type: string + enumDescriptions: + - Unspecified severity. + - Critical severity. + - High severity. + - Medium severity. + - Low severity. + enum: + - SEVERITY_UNSPECIFIED + - CRITICAL + - HIGH + - MEDIUM + - LOW + state: + description: Output only. The state of the issue. + readOnly: true + type: string + enumDescriptions: + - Unspecified state. + - Active state. + - Inactive state. + enum: + - STATE_UNSPECIFIED + - ACTIVE + - INACTIVE + createTime: + description: Output only. The time the issue was created. + readOnly: true + type: string + format: google-datetime + lastObservationTime: + description: The time the issue was last observed. + type: string + format: google-datetime + updateTime: + description: Output only. The time the issue was last updated. + readOnly: true + type: string + format: google-datetime + primaryResource: + description: The primary resource associated with the issue. + $ref: '#/components/schemas/GoogleCloudSecuritycenterV2IssueResource' + secondaryResources: + description: Additional resources associated with the issue. + type: array + items: + $ref: '#/components/schemas/GoogleCloudSecuritycenterV2IssueResource' + issueType: + description: The type of the issue. + type: string + enumDescriptions: + - Unspecified issue type. + - Chokepoint issue type. + - Toxic combination issue type. + - Insight issue type. + enum: + - ISSUE_TYPE_UNSPECIFIED + - CHOKEPOINT + - TOXIC_COMBINATION + - INSIGHT + mute: + description: The mute information of the issue. + $ref: '#/components/schemas/GoogleCloudSecuritycenterV2IssueMute' + exposureScore: + description: The exposure score of the issue. + type: number + format: double + domains: + description: The domains of the issue. + type: array + items: + $ref: '#/components/schemas/GoogleCloudSecuritycenterV2IssueDomain' + securityContexts: + description: The security context of the issue. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudSecuritycenterV2IssueSecurityContext + relatedFindings: + description: The findings related to the issue. + type: array + items: + $ref: '#/components/schemas/GoogleCloudSecuritycenterV2IssueFinding' + GoogleCloudSecuritycenterV2IssueResource: + id: GoogleCloudSecuritycenterV2IssueResource + description: A resource associated with the an issue. + type: object + properties: + name: + description: The full resource name of the resource associated with the issue. + type: string + displayName: + description: >- + The resource-type specific display name of the resource associated + with the issue. + type: string + type: + description: The type of the resource associated with the issue. + type: string + cloudProvider: + description: The cloud provider of the resource associated with the issue. + type: string + enumDescriptions: + - Unspecified cloud provider. + - Google Cloud. + - Amazon Web Services. + - Microsoft Azure. + enum: + - CLOUD_PROVIDER_UNSPECIFIED + - GOOGLE_CLOUD + - AMAZON_WEB_SERVICES + - MICROSOFT_AZURE + googleCloudMetadata: + description: >- + The Google Cloud metadata of the resource associated with the issue. + Only populated for Google Cloud resources. + $ref: >- + #/components/schemas/GoogleCloudSecuritycenterV2IssueResourceGoogleCloudMetadata + awsMetadata: + description: >- + The AWS metadata of the resource associated with the issue. Only + populated for AWS resources. + $ref: >- + #/components/schemas/GoogleCloudSecuritycenterV2IssueResourceAwsMetadata + azureMetadata: + description: >- + The Azure metadata of the resource associated with the issue. Only + populated for Azure resources. + $ref: >- + #/components/schemas/GoogleCloudSecuritycenterV2IssueResourceAzureMetadata + GoogleCloudSecuritycenterV2IssueResourceGoogleCloudMetadata: + id: GoogleCloudSecuritycenterV2IssueResourceGoogleCloudMetadata + description: Google Cloud metadata of a resource associated with an issue. + type: object + properties: + projectId: + description: >- + The project ID that the resource associated with the issue belongs + to. + type: string + GoogleCloudSecuritycenterV2IssueResourceAwsMetadata: + id: GoogleCloudSecuritycenterV2IssueResourceAwsMetadata + description: The AWS metadata of a resource associated with an issue. + type: object + properties: + account: + description: The AWS account of the resource associated with the issue. + $ref: >- + #/components/schemas/GoogleCloudSecuritycenterV2IssueResourceAwsMetadataAwsAccount + GoogleCloudSecuritycenterV2IssueResourceAwsMetadataAwsAccount: + id: GoogleCloudSecuritycenterV2IssueResourceAwsMetadataAwsAccount + description: The AWS account of the resource associated with the issue. + type: object + properties: + id: + description: The AWS account ID of the resource associated with the issue. + type: string + name: + description: The AWS account name of the resource associated with the issue. + type: string + GoogleCloudSecuritycenterV2IssueResourceAzureMetadata: + id: GoogleCloudSecuritycenterV2IssueResourceAzureMetadata + description: The Azure metadata of a resource associated with an issue. + type: object + properties: + subscription: + description: The Azure subscription of the resource associated with the issue. + $ref: >- + #/components/schemas/GoogleCloudSecuritycenterV2IssueResourceAzureMetadataAzureSubscription + GoogleCloudSecuritycenterV2IssueResourceAzureMetadataAzureSubscription: + id: GoogleCloudSecuritycenterV2IssueResourceAzureMetadataAzureSubscription + description: The Azure subscription of the resource associated with the issue. + type: object + properties: + id: + description: The Azure subscription ID of the resource associated with the issue. + type: string + displayName: + description: >- + The Azure subscription display name of the resource associated with + the issue. + type: string + GoogleCloudSecuritycenterV2IssueMute: + id: GoogleCloudSecuritycenterV2IssueMute + description: The mute information of the issue. + type: object + properties: + muteState: + description: Output only. The mute state of the issue. + readOnly: true + type: string + enumDescriptions: + - Unspecified mute state. + - Not muted. + - Muted. + enum: + - MUTE_STATE_UNSPECIFIED + - NOT_MUTED + - MUTED + muteInitiator: + description: >- + The email address of the user who last changed the mute state of the + issue. + type: string + muteReason: + description: The user-provided reason for muting the issue. + type: string + muteUpdateTime: + description: The time the issue was muted. + type: string + format: google-datetime + GoogleCloudSecuritycenterV2IssueDomain: + id: GoogleCloudSecuritycenterV2IssueDomain + description: The domains of an issue. + type: object + properties: + domainCategory: + description: The domain category of the issue. + type: string + enumDescriptions: + - Unspecified domain category. + - Issues in the AI domain. + - Issues in the code domain. + - Issues in the container domain. + - Issues in the data domain. + - Issues in the identity and access domain. + - Issues in the vulnerability domain. + - Issues in the threat domain. + enum: + - DOMAIN_CATEGORY_UNSPECIFIED + - AI + - CODE + - CONTAINER + - DATA + - IDENTITY_AND_ACCESS + - VULNERABILITY + - THREAT + GoogleCloudSecuritycenterV2IssueSecurityContext: + id: GoogleCloudSecuritycenterV2IssueSecurityContext + description: Security context associated with an issue. + type: object + properties: + context: + description: The context of the security context. + $ref: >- + #/components/schemas/GoogleCloudSecuritycenterV2IssueSecurityContextContext + aggregatedCount: + description: The aggregated count of the security context. + $ref: >- + #/components/schemas/GoogleCloudSecuritycenterV2IssueSecurityContextAggregatedCount + GoogleCloudSecuritycenterV2IssueSecurityContextContext: + id: GoogleCloudSecuritycenterV2IssueSecurityContextContext + description: Context of a security context. + type: object + properties: + type: + description: Context type. + type: string + values: + description: Context values. + type: array + items: + type: string + GoogleCloudSecuritycenterV2IssueSecurityContextAggregatedCount: + id: GoogleCloudSecuritycenterV2IssueSecurityContextAggregatedCount + description: Aggregated count of a security context. + type: object + properties: + key: + description: Aggregation key. + type: string + value: + description: Aggregation value. + type: integer + format: int32 + GoogleCloudSecuritycenterV2IssueFinding: + id: GoogleCloudSecuritycenterV2IssueFinding + description: Finding related to an issue. + type: object + properties: + name: + description: The name of the finding. + type: string + cve: + description: The CVE of the finding. + $ref: '#/components/schemas/GoogleCloudSecuritycenterV2IssueFindingCve' + securityBulletin: + description: The security bulletin of the finding. + $ref: >- + #/components/schemas/GoogleCloudSecuritycenterV2IssueFindingSecurityBulletin + GoogleCloudSecuritycenterV2IssueFindingCve: + id: GoogleCloudSecuritycenterV2IssueFindingCve + description: The CVE of the finding. + type: object + properties: + name: + description: The CVE name. + type: string + GoogleCloudSecuritycenterV2IssueFindingSecurityBulletin: + id: GoogleCloudSecuritycenterV2IssueFindingSecurityBulletin + description: The security bulletin of the finding. + type: object + properties: + name: + description: The security bulletin name. + type: string GoogleCloudSecuritycenterV1p1beta1NotificationMessage: id: GoogleCloudSecuritycenterV1p1beta1NotificationMessage description: Security Command Center's Notification @@ -9349,6 +11394,33 @@ components: description: The duration between asset discovery run start and end type: string format: google-duration + ExportFindingsResponse: + id: ExportFindingsResponse + description: The response to a ExportFindings request. Contains the LRO information. + type: object + properties: {} + ExportFindingsMetadata: + id: ExportFindingsMetadata + description: The LRO metadata for a ExportFindings request. + type: object + properties: + exportStartTime: + description: Optional. Timestamp at which export was started + type: string + format: google-datetime + bigQueryDestination: + description: Required. The destination BigQuery dataset to export findings to. + $ref: '#/components/schemas/BigQueryDestination' + BigQueryDestination: + id: BigQueryDestination + description: The destination BigQuery dataset to export findings to. + type: object + properties: + dataset: + description: >- + Required. The relative resource name of the destination dataset, in + the form projects/{projectId}/datasets/{datasetId}. + type: string parameters: access_token: description: OAuth access token. @@ -11112,6 +13184,13 @@ components: mediaType: application/json openAPIDocKey: '200' objectKey: $.attackPaths + organizations_attack_paths_list: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1attackPaths/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.attackPaths sqlVerbs: select: - $ref: >- @@ -11120,6 +13199,8 @@ components: #/components/x-stackQL-resources/attack_paths/methods/organizations_simulations_attack_exposure_results_attack_paths_list - $ref: >- #/components/x-stackQL-resources/attack_paths/methods/organizations_simulations_attack_paths_list + - $ref: >- + #/components/x-stackQL-resources/attack_paths/methods/organizations_attack_paths_list insert: [] update: [] replace: [] @@ -14728,7 +16809,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: securitycenter.organizations.operations.cancel security: - Oauth2: @@ -17196,3 +19277,41 @@ paths: name: orderBy schema: type: string + /v1/organizations/{organizationsId}/attackPaths: + parameters: *ref_1 + get: + description: >- + Lists the attack paths for a set of simulation results or valued + resources and filter. + operationId: securitycenter.organizations.attackPaths.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListAttackPathsResponse' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 diff --git a/providers/src/googleapis.com/v00.00.00000/services/securityposture.yaml b/providers/src/googleapis.com/v00.00.00000/services/securityposture.yaml new file mode 100644 index 00000000..d64ec731 --- /dev/null +++ b/providers/src/googleapis.com/v00.00.00000/services/securityposture.yaml @@ -0,0 +1,2585 @@ +openapi: 3.1.0 +info: + contact: + name: StackQL Studios + url: https://github.com/stackql/google-discovery-to-openapi + email: info@stackql.io + title: Security Posture API + description: >- + Defines, assesses, and monitors the overall status of your security in + Google Cloud. You can use security postures to evaluate your current cloud + security against defined benchmarks and help maintain the level of security + that your organization requires. + version: v1 + x-discovery-doc-revision: '20250819' + x-generated-date: '2025-08-28' +externalDocs: + url: https://cloud.google.com/security-command-center +servers: + - url: https://securityposture.googleapis.com +components: + securitySchemes: + Oauth2: + type: oauth2 + description: Oauth 2.0 implicit authentication + flows: + implicit: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + scopes: &ref_0 + 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. + Oauth2c: + type: oauth2 + description: Oauth 2.0 authorization code authentication + flows: + authorizationCode: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + tokenUrl: https://accounts.google.com/o/oauth2/token + scopes: *ref_0 + schemas: + ListOperationsResponse: + id: ListOperationsResponse + description: The response message for Operations.ListOperations. + type: object + properties: + operations: + description: >- + A list of operations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/Operation' + nextPageToken: + description: The standard List next-page token. + type: string + Operation: + id: Operation + description: >- + This resource represents a long-running operation that is the result of + a network API call. + type: object + properties: + name: + description: >- + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. + type: string + metadata: + description: >- + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + done: + description: >- + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + type: boolean + error: + description: >- + The error result of the operation in case of failure or + cancellation. + $ref: '#/components/schemas/Status' + response: + description: >- + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + Status: + id: Status + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + type: object + properties: + code: + description: The status code, which should be an enum value of google.rpc.Code. + type: integer + format: int32 + message: + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + type: string + details: + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + type: array + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + Empty: + id: Empty + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + type: object + properties: {} + CancelOperationRequest: + id: CancelOperationRequest + description: The request message for Operations.CancelOperation. + type: object + properties: {} + ListPosturesResponse: + id: ListPosturesResponse + description: Response message for ListPostures. + type: object + properties: + postures: + description: The list of Posture resources. + type: array + items: + $ref: '#/components/schemas/Posture' + nextPageToken: + description: >- + A pagination token. To retrieve the next page of results, call the + method again with this token. + type: string + unreachable: + description: >- + Locations that were temporarily unavailable and could not be + reached. + type: array + items: + type: string + Posture: + id: Posture + description: The details of a posture. + type: object + properties: + name: + description: >- + Required. Identifier. The name of the posture, in the format + `organizations/{organization}/locations/global/postures/{posture_id}`. + type: string + state: + description: Required. The state of the posture at the specified `revision_id`. + type: string + enumDescriptions: + - Default value. This value is unused. + - The posture is deprecated and can no longer be deployed. + - The posture is a draft and is not ready to deploy. + - The posture is complete and ready to deploy. + enum: + - STATE_UNSPECIFIED + - DEPRECATED + - DRAFT + - ACTIVE + revisionId: + description: >- + Output only. Immutable. An opaque eight-character string that + identifies the revision of the posture. A posture can have multiple + revisions; when you deploy a posture, you deploy a specific revision + of the posture. + readOnly: true + type: string + createTime: + description: Output only. The time at which the posture was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. The time at which the posture was last updated. + readOnly: true + type: string + format: google-datetime + description: + description: Optional. A description of the posture. + type: string + policySets: + description: Required. The PolicySet resources that the posture includes. + type: array + items: + $ref: '#/components/schemas/PolicySet' + etag: + description: >- + Optional. An opaque identifier for the current version of the + posture at the specified `revision_id`. To prevent concurrent + updates from overwriting each other, always provide the `etag` when + you update a posture. You can also provide the `etag` when you + delete a posture, to help ensure that you're deleting the intended + version of the posture. + type: string + annotations: + description: >- + Optional. The user-specified annotations for the posture. For + details about the values you can use in an annotation, see [AIP-148: + Standard fields](https://google.aip.dev/148#annotations). + type: object + additionalProperties: + type: string + reconciling: + description: Output only. Whether the posture is in the process of being updated. + readOnly: true + type: boolean + categories: + description: >- + Output only. The categories that the posture belongs to, as + determined by the Security Posture API. + readOnly: true + type: array + items: + type: string + enumDescriptions: + - Default value. This value is unused. + - Artificial intelligence (AI). + - Amazon Web Services (AWS) policies. + - Google Cloud policies. + - Microsoft Azure policies. + enum: + - CATEGORY_UNSPECIFIED + - AI + - AWS + - GCP + - AZURE + PolicySet: + id: PolicySet + description: A group of one or more Policy resources. + type: object + properties: + policySetId: + description: Required. An identifier for the policy set. + type: string + description: + description: Optional. A description of the policy set. + type: string + policies: + description: >- + Required. The Policy resources in the policy set. Each policy must + have a policy_id that's unique within the policy set. + type: array + items: + $ref: '#/components/schemas/Policy' + Policy: + id: Policy + description: The details of a policy, including the constraints that it includes. + type: object + properties: + policyId: + description: >- + Required. A user-specified identifier for the policy. In a + PolicySet, each policy must have a unique identifier. + type: string + complianceStandards: + description: Optional. The compliance standards that the policy helps enforce. + type: array + items: + $ref: '#/components/schemas/ComplianceStandard' + constraint: + description: Required. The constraints that the policy includes. + $ref: '#/components/schemas/Constraint' + description: + description: Optional. A description of the policy. + type: string + ComplianceStandard: + id: ComplianceStandard + description: Information about a compliance standard that the policy helps enforce. + type: object + properties: + standard: + description: >- + Optional. The compliance standard that the policy helps enforce. For + example, `NIST SP 800-53`. + type: string + control: + description: >- + Optional. The control in the compliance standard that the policy + helps enforce. For example, `AC-3`. + type: string + Constraint: + id: Constraint + description: Metadata for a constraint in a Policy. + type: object + properties: + securityHealthAnalyticsModule: + description: Optional. A built-in detector for Security Health Analytics. + $ref: '#/components/schemas/SecurityHealthAnalyticsModule' + securityHealthAnalyticsCustomModule: + description: Optional. A custom module for Security Health Analytics. + $ref: '#/components/schemas/SecurityHealthAnalyticsCustomModule' + orgPolicyConstraint: + description: Optional. A predefined organization policy constraint. + $ref: '#/components/schemas/OrgPolicyConstraint' + orgPolicyConstraintCustom: + description: Optional. A custom organization policy constraint. + $ref: '#/components/schemas/OrgPolicyConstraintCustom' + SecurityHealthAnalyticsModule: + id: SecurityHealthAnalyticsModule + description: A built-in detector for Security Health Analytics. + type: object + properties: + moduleName: + description: >- + Required. The name of the detector. For example, + `BIGQUERY_TABLE_CMEK_DISABLED`. This field is also used as the + finding category for all the asset violation findings that the + detector returns. + type: string + moduleEnablementState: + description: >- + Whether the detector is enabled at a specified level of the resource + hierarchy. + type: string + enumDescriptions: + - Default value. This value is unused. + - The detector or custom module is enabled. + - The detector or custom module is disabled. + enum: + - ENABLEMENT_STATE_UNSPECIFIED + - ENABLED + - DISABLED + SecurityHealthAnalyticsCustomModule: + id: SecurityHealthAnalyticsCustomModule + description: A custom module for Security Health Analytics. + type: object + properties: + id: + description: >- + Output only. Immutable. The unique identifier for the custom module. + Contains 1 to 20 digits. + readOnly: true + type: string + displayName: + description: >- + Optional. The display name of the custom module. This value is used + as the finding category for all the asset violation findings that + the custom module returns. The display name must contain between 1 + and 128 alphanumeric characters or underscores, and it must start + with a lowercase letter. + type: string + config: + description: Required. Configuration settings for the custom module. + $ref: '#/components/schemas/CustomConfig' + moduleEnablementState: + description: >- + Whether the custom module is enabled at a specified level of the + resource hierarchy. + type: string + enumDescriptions: + - Default value. This value is unused. + - The detector or custom module is enabled. + - The detector or custom module is disabled. + enum: + - ENABLEMENT_STATE_UNSPECIFIED + - ENABLED + - DISABLED + CustomConfig: + id: CustomConfig + description: >- + A custom module configuration for Security Health Analytics. Use + `CustomConfig` to create custom detectors that generate custom findings + for resources that you specify. + type: object + properties: + predicate: + description: >- + Required. The Common Expression Language (CEL) expression to + evaluate. When the expression evaluates to `true` for a resource, a + finding is generated. + $ref: '#/components/schemas/Expr' + customOutput: + description: >- + Optional. Definitions of custom source properties to include in + findings. + $ref: '#/components/schemas/CustomOutputSpec' + resourceSelector: + description: Required. The resource types that the custom module operates on. + $ref: '#/components/schemas/ResourceSelector' + severity: + description: Required. The severity of findings generated by the custom module. + type: string + enumDescriptions: + - Default value. This value is unused. + - Critical severity. + - High severity. + - Medium severity. + - Low severity. + enum: + - SEVERITY_UNSPECIFIED + - CRITICAL + - HIGH + - MEDIUM + - LOW + description: + description: >- + Optional. A description of the vulnerability or misconfiguration + that the custom module detects. The description appears in each + finding. Provide enough information to help an investigator + understand the finding. The value must be enclosed in quotation + marks. + type: string + recommendation: + description: >- + Required. An explanation of the steps that security teams can take + to resolve the detected issue. The explanation appears in each + finding. + type: string + Expr: + id: 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. + type: object + properties: + expression: + description: >- + Textual representation of an expression in Common Expression + Language syntax. + 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 + 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 + 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 + CustomOutputSpec: + id: CustomOutputSpec + description: Definitions of custom source properties that can appear in findings. + type: object + properties: + properties: + description: Optional. The custom source properties that can appear in findings. + type: array + items: + $ref: '#/components/schemas/Property' + Property: + id: Property + description: A name-value pair used as a custom source property. + type: object + properties: + name: + description: Required. The name of the custom source property. + type: string + valueExpression: + description: >- + Optional. The CEL expression for the value of the custom source + property. For resource properties, you can return the value of the + property or a string enclosed in quotation marks. + $ref: '#/components/schemas/Expr' + ResourceSelector: + id: ResourceSelector + description: A selector for the resource types to run the detector on. + type: object + properties: + resourceTypes: + description: >- + Required. The resource types to run the detector on. Each custom + module can specify up to 5 resource types. + type: array + items: + type: string + OrgPolicyConstraint: + id: OrgPolicyConstraint + description: A predefined organization policy constraint. + type: object + properties: + cannedConstraintId: + description: Required. A unique identifier for the constraint. + type: string + policyRules: + description: Required. The rules enforced by the constraint. + type: array + items: + $ref: '#/components/schemas/GoogleCloudSecuritypostureV1PolicyRule' + GoogleCloudSecuritypostureV1PolicyRule: + id: GoogleCloudSecuritypostureV1PolicyRule + description: >- + A rule that defines the allowed and denied values for an organization + policy constraint. + type: object + properties: + values: + description: >- + The allowed and denied values for a list constraint. Valid only for + list constraints. + $ref: >- + #/components/schemas/GoogleCloudSecuritypostureV1PolicyRuleStringValues + allowAll: + description: >- + Whether to allow any value for a list constraint. Valid only for + list constraints. + type: boolean + denyAll: + description: >- + Whether to deny all values for a list constraint. Valid only for + list constraints. + type: boolean + enforce: + description: >- + Whether to enforce the constraint. Valid only for boolean + constraints. + type: boolean + condition: + description: >- + A condition that determines whether this rule is used to evaluate + the policy. When set, the google.type.Expr.expression field must + contain 1 to 10 subexpressions, joined by the `||` or `&&` + operators. Each subexpression must use the `resource.matchTag()` or + `resource.matchTagId()` Common Expression Language (CEL) function. + The `resource.matchTag()` function takes the following arguments: * + `key_name`: the namespaced name of the tag key, with the + organization ID and a slash (`/`) as a prefix; for example, + `123456789012/environment` * `value_name`: the short name of the tag + value For example: `resource.matchTag('123456789012/environment, + 'prod')` The `resource.matchTagId()` function takes the following + arguments: * `key_id`: the permanent ID of the tag key; for example, + `tagKeys/123456789012` * `value_id`: the permanent ID of the tag + value; for example, `tagValues/567890123456` For example: + `resource.matchTagId('tagKeys/123456789012', + 'tagValues/567890123456')` + $ref: '#/components/schemas/Expr' + parameters: + description: >- + Optional. Required for managed constraints if parameters are + defined. Passes parameter values when policy enforcement is enabled. + Ensure that parameter value types match those defined in the + constraint definition. For example: ``` { "allowedLocations": + ["us-east1", "us-west1"], "allowAll": true } ``` + type: object + additionalProperties: + type: any + description: Properties of the object. + resourceTypes: + description: >- + Optional. The resource types policies can support, only used for + managed constraints. Method type is `GOVERN_TAGS`. + $ref: '#/components/schemas/ResourceTypes' + GoogleCloudSecuritypostureV1PolicyRuleStringValues: + id: GoogleCloudSecuritypostureV1PolicyRuleStringValues + description: >- + The allowed and denied values for a list constraint. For all + constraints, these fields can contain literal values. Optionally, you + can add the `is:` prefix to these values. If the value contains a colon + (`:`), then the `is:` prefix is required. Some constraints allow you to + specify a portion of the resource hierarchy, known as a [_hierarchy + subtree_](https://cloud.google.com/resource-manager/help/organization-policy/hierarchy-subtree), + that the constraint applies to. To specify a hierarchy subtree, use the + `under:` prefix, followed by a value with one of these formats: - + `projects/{project_id}` (for example, `projects/tokyo-rain-123`) - + `folders/{folder_id}` (for example, `folders/1234567890123`) - + `organizations/{organization_id}` (for example, + `organizations/123456789012`) A constraint's `supports_under` field + indicates whether you can specify a hierarchy subtree. To learn which + predefined constraints let you specify a hierarchy subtree, see the + [constraints + reference](https://cloud.google.com/resource-manager/help/organization-policy/constraints/reference). + type: object + properties: + allowedValues: + description: The allowed values for the constraint. + type: array + items: + type: string + deniedValues: + description: The denied values for the constraint. + type: array + items: + type: string + ResourceTypes: + id: ResourceTypes + description: >- + Set multiple resource types for one policy, for example: ``` + resourceTypes: included: - compute.googleapis.com/Instance - + compute.googleapis.com/Disk ``` Constraint definition contains an empty + resource type in order to support multiple resource types in the policy. + Only supports managed constraints. Method type is `GOVERN_TAGS`. + type: object + properties: + included: + description: Optional. The resource types we currently support. + type: array + items: + type: string + OrgPolicyConstraintCustom: + id: OrgPolicyConstraintCustom + description: A custom organization policy constraint. + type: object + properties: + customConstraint: + description: Required. Metadata for the constraint. + $ref: '#/components/schemas/GoogleCloudSecuritypostureV1CustomConstraint' + policyRules: + description: Required. The rules enforced by the constraint. + type: array + items: + $ref: '#/components/schemas/GoogleCloudSecuritypostureV1PolicyRule' + GoogleCloudSecuritypostureV1CustomConstraint: + id: GoogleCloudSecuritypostureV1CustomConstraint + description: >- + A custom, user-defined constraint. You can apply the constraint only to + the resource types specified in the constraint, and only within the + organization where the constraint is defined. _When you create a custom + constraint, it is not enforced automatically._ You must use an + organization policy to [enforce the + constraint](https://cloud.google.com/resource-manager/help/organization-policy/constraints/enforce). + type: object + properties: + name: + description: >- + Immutable. The name of the constraint, in the format + `organizations/{organization_id}/customConstraints/custom.{custom_constraint_id}`. + For example, + `organizations/123456789012/customConstraints/custom.createOnlyE2TypeVms`. + Must contain 1 to 62 characters, excluding the prefix + `organizations/{organization_id}/customConstraints/custom.`. + type: string + resourceTypes: + description: >- + Immutable. The resource type that the constraint applies to, in the + format `{canonical_service_name}/{resource_type_name}`. For example, + `compute.googleapis.com/Instance`. + type: array + items: + type: string + methodTypes: + description: The types of operations that the constraint applies to. + type: array + items: + type: string + enumDescriptions: + - Default value. This value is unused. + - Constraint applied when creating the resource. + - Constraint applied when updating the resource. + - Not supported. Constraint applied when deleting the resource. + enum: + - METHOD_TYPE_UNSPECIFIED + - CREATE + - UPDATE + - DELETE + condition: + description: >- + A Common Expression Language (CEL) condition expression that must + evaluate to `true` for the constraint to be enforced. The maximum + length is 1000 characters. For example: + + `resource.instanceName.matches('(production|test)_(.+_)?[\d]+')`: + Evaluates to `true` if the resource's `instanceName` attribute + contains the following: + The prefix `production` or `test` + An + underscore (`_`) + Optional: One or more characters, followed by an + underscore (`_`) + One or more digits + + `resource.management.auto_upgrade == true`: Evaluates to `true` if + the resource's `management.auto_upgrade` attribute is `true`. + type: string + actionType: + description: Whether to allow or deny the action. + type: string + enumDescriptions: + - Default value. This value is unused. + - Allow the action. + - Deny the action. + enum: + - ACTION_TYPE_UNSPECIFIED + - ALLOW + - DENY + displayName: + description: >- + A display name for the constraint. The maximum length is 200 + characters. + type: string + description: + description: >- + A description of the constraint. The maximum length is 2000 + characters. + type: string + updateTime: + description: >- + Output only. The last time at which the constraint was updated or + created. + readOnly: true + type: string + format: google-datetime + ListPostureRevisionsResponse: + id: ListPostureRevisionsResponse + description: Response message for ListPostureRevisions. + type: object + properties: + revisions: + description: The list of revisions for the Posture. + type: array + items: + $ref: '#/components/schemas/Posture' + nextPageToken: + description: >- + A pagination token. To retrieve the next page of results, call the + method again with this token. + type: string + ExtractPostureRequest: + id: ExtractPostureRequest + description: Request message for ExtractPosture. + type: object + properties: + postureId: + description: Required. An identifier for the posture. + type: string + workload: + description: >- + Required. The organization, folder, or project from which policies + are extracted. Must be within the organization defined in parent. + Use one of the following formats: * + `organization/{organization_number}` * `folder/{folder_number}` * + `project/{project_number}` + type: string + ListPostureDeploymentsResponse: + id: ListPostureDeploymentsResponse + description: Response message for ListPostureDeployments. + type: object + properties: + postureDeployments: + description: The list of PostureDeployment resources. + type: array + items: + $ref: '#/components/schemas/PostureDeployment' + nextPageToken: + description: >- + A pagination token. To retrieve the next page of results, call the + method again with this token. + type: string + unreachable: + description: >- + Locations that were temporarily unavailable and could not be + reached. + type: array + items: + type: string + PostureDeployment: + id: PostureDeployment + description: >- + Details for a Posture deployment on an organization, folder, or project. + You can deploy at most one posture to each organization, folder, or + project. The parent resource for a posture deployment is always the + organization, even if the deployment applies to a folder or project. + type: object + properties: + name: + description: >- + Required. Identifier. The name of the posture deployment, in the + format + `organizations/{organization}/locations/global/postureDeployments/{deployment_id}`. + type: string + targetResource: + description: >- + Required. The organization, folder, or project where the posture is + deployed. Uses one of the following formats: * + `organizations/{organization_number}` * `folders/{folder_number}` * + `projects/{project_number}` + type: string + state: + description: Output only. The state of the posture deployment. + readOnly: true + type: string + enumDescriptions: + - Default value. This value is unused. + - The posture deployment is being created. + - The posture deployment is being deleted. + - The posture deployment is being updated. + - The posture deployment is active and in use. + - The posture deployment could not be created. + - The posture deployment could not be updated. + - The posture deployment could not be deleted. + enum: + - STATE_UNSPECIFIED + - CREATING + - DELETING + - UPDATING + - ACTIVE + - CREATE_FAILED + - UPDATE_FAILED + - DELETE_FAILED + postureId: + description: >- + Required. The posture used in the deployment, in the format + `organizations/{organization}/locations/global/postures/{posture_id}`. + type: string + postureRevisionId: + description: Required. The revision ID of the posture used in the deployment. + type: string + createTime: + description: Output only. The time at which the posture deployment was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: >- + Output only. The time at which the posture deployment was last + updated. + readOnly: true + type: string + format: google-datetime + description: + description: Optional. A description of the posture deployment. + type: string + etag: + description: >- + Optional. An opaque identifier for the current version of the + posture deployment. To prevent concurrent updates from overwriting + each other, always provide the `etag` when you update a posture + deployment. You can also provide the `etag` when you delete a + posture deployment, to help ensure that you're deleting the intended + posture deployment. + type: string + annotations: + description: >- + Optional. The user-specified annotations for the posture deployment. + For details about the values you can use in an annotation, see + [AIP-148: Standard fields](https://google.aip.dev/148#annotations). + type: object + additionalProperties: + type: string + reconciling: + description: >- + Output only. Whether the posture deployment is in the process of + being updated. + readOnly: true + type: boolean + desiredPostureId: + description: >- + Output only. The posture ID that was specified for the deployment. + Present only if the posture deployment is in a failed state. + readOnly: true + type: string + desiredPostureRevisionId: + description: >- + Output only. The revision ID of the posture that was specified for + the deployment. Present only if the deployment is in a failed state. + readOnly: true + type: string + failureMessage: + description: >- + Output only. A description of why the posture deployment failed. + Present only if the deployment is in a failed state. + readOnly: true + type: string + categories: + description: >- + Output only. The categories that the posture deployment belongs to, + as determined by the Security Posture API. + readOnly: true + type: array + items: + type: string + enumDescriptions: + - Default value. This value is unused. + - Artificial intelligence (AI). + - Amazon Web Services (AWS) policies. + - Google Cloud policies. + - Microsoft Azure policies. + enum: + - CATEGORY_UNSPECIFIED + - AI + - AWS + - GCP + - AZURE + ListPostureTemplatesResponse: + id: ListPostureTemplatesResponse + description: Response message for ListPostureTemplates. + type: object + properties: + postureTemplates: + description: The list of PostureTemplate resources. + type: array + items: + $ref: '#/components/schemas/PostureTemplate' + nextPageToken: + description: >- + A pagination token. To retrieve the next page of results, call the + method again with this token. + type: string + PostureTemplate: + id: PostureTemplate + description: The details of a posture template. + type: object + properties: + name: + description: >- + Output only. Identifier. The name of the posture template, in the + format + `organizations/{organization}/locations/global/postureTemplates/{posture_template}`. + readOnly: true + type: string + revisionId: + description: >- + Output only. A string that identifies the revision of the posture + template. + readOnly: true + type: string + description: + description: Output only. A description of the posture template. + readOnly: true + type: string + state: + description: >- + Output only. The state of the posture template at the specified + `revision_id`. + readOnly: true + type: string + enumDescriptions: + - Default value. This value is unused. + - The posture template follows the latest controls and standards. + - >- + The posture template uses outdated controls and standards. We + recommend that you use a newer revision of the posture template. + enum: + - STATE_UNSPECIFIED + - ACTIVE + - DEPRECATED + policySets: + description: >- + Output only. The PolicySet resources that the posture template + includes. + readOnly: true + type: array + items: + $ref: '#/components/schemas/PolicySet' + categories: + description: >- + Output only. The categories that the posture template belongs to, as + determined by the Security Posture API. + readOnly: true + type: array + items: + type: string + enumDescriptions: + - Default value. This value is unused. + - Artificial intelligence (AI). + - Amazon Web Services (AWS) policies. + - Google Cloud policies. + - Microsoft Azure policies. + enum: + - CATEGORY_UNSPECIFIED + - AI + - AWS + - GCP + - AZURE + ListReportsResponse: + id: ListReportsResponse + description: Response message for ListReports. + type: object + properties: + reports: + description: The list of Report resources. + type: array + items: + $ref: '#/components/schemas/Report' + nextPageToken: + description: >- + A pagination token. To retrieve the next page of results, call the + method again with this token. + type: string + unreachable: + description: >- + Locations that were temporarily unavailable and could not be + reached. + type: array + items: + type: string + Report: + id: Report + description: Details of a report. + type: object + properties: + iacValidationReport: + description: Output only. An infrastructure-as-code (IaC) validation report. + readOnly: true + $ref: '#/components/schemas/IaCValidationReport' + name: + description: >- + Required. The name of the report, in the format + `organizations/{organization}/locations/global/reports/{report_id}`. + type: string + createTime: + description: Output only. The time at which the report was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. The time at which the report was last updated. + readOnly: true + type: string + format: google-datetime + IaCValidationReport: + id: IaCValidationReport + description: Details of an infrastructure-as-code (IaC) validation report. + type: object + properties: + violations: + description: A list of every Violation found in the IaC configuration. + type: array + items: + $ref: '#/components/schemas/Violation' + note: + description: Additional information about the report. + type: string + Violation: + id: Violation + description: Details of a violation. + type: object + properties: + assetId: + description: >- + The full resource name of the asset that caused the violation. For + details about the format of the full resource name for each asset + type, see [Resource name + format](https://cloud.google.com/asset-inventory/docs/resource-name-format). + type: string + policyId: + description: The policy that was violated. + type: string + violatedPosture: + description: >- + Details for the posture that was violated. This field is present + only if the violated policy belongs to a deployed posture. + $ref: '#/components/schemas/PostureDetails' + severity: + description: The severity of the violation. + type: string + enumDescriptions: + - Default value. This value is unused. + - Critical severity. + - High severity. + - Medium severity. + - Low severity. + enum: + - SEVERITY_UNSPECIFIED + - CRITICAL + - HIGH + - MEDIUM + - LOW + nextSteps: + description: A description of the steps that you can take to fix the violation. + type: string + violatedAsset: + description: >- + Details of the Cloud Asset Inventory asset that caused the + violation. + $ref: '#/components/schemas/AssetDetails' + violatedPolicy: + description: Details of the policy that was violated. + $ref: '#/components/schemas/PolicyDetails' + PostureDetails: + id: PostureDetails + description: Details of a posture deployment. + type: object + properties: + postureDeployment: + description: >- + The name of the posture deployment, in the format + `organizations/{organization}/locations/global/postureDeployments/{deployment_id}`. + type: string + postureDeploymentTargetResource: + description: >- + The organization, folder, or project where the posture is deployed. + Uses one of the following formats: * + `organizations/{organization_number}` * `folders/{folder_number}` * + `projects/{project_number}` + type: string + posture: + description: >- + The posture used in the deployment, in the format + `organizations/{organization}/locations/global/postures/{posture_id}`. + type: string + postureRevisionId: + description: The revision ID of the posture used in the deployment. + type: string + policySet: + description: >- + The identifier for the PolicySet that the relevant policy belongs + to. + type: string + AssetDetails: + id: AssetDetails + description: Details of a Cloud Asset Inventory asset that caused a violation. + type: object + properties: + asset: + description: >- + Information about the Cloud Asset Inventory asset that violated a + policy. The format of this information can change at any time + without prior notice. Your application must not depend on this + information in any way. + type: string + assetType: + description: >- + The type of Cloud Asset Inventory asset. For a list of asset types, + see [Supported asset + types](https://cloud.google.com/asset-inventory/docs/supported-asset-types). + type: string + PolicyDetails: + id: PolicyDetails + description: Details of a policy that was violated. + type: object + properties: + constraint: + description: >- + Information about the constraint that was violated. The format of + this information can change at any time without prior notice. Your + application must not depend on this information in any way. + type: string + constraintType: + description: The type of constraint that was violated. + type: string + enumDescriptions: + - Default value. This value is unused. + - A custom module for Security Health Analytics. + - A custom organization policy constraint. + - A built-in detector for Security Health Analytics. + - A predefined organization policy constraint. + - A custom rego policy constraint. + enum: + - CONSTRAINT_TYPE_UNSPECIFIED + - SECURITY_HEALTH_ANALYTICS_CUSTOM_MODULE + - ORG_POLICY_CUSTOM + - SECURITY_HEALTH_ANALYTICS_MODULE + - ORG_POLICY + - REGO_POLICY + complianceStandards: + description: >- + The compliance standards that the policy maps to. For example, + `CIS-2.0 1.15`. + type: array + items: + type: string + description: + description: A description of the policy. + type: string + CreateIaCValidationReportRequest: + id: CreateIaCValidationReportRequest + description: Request message for CreateIaCValidationReport. + type: object + properties: + iac: + description: >- + Required. The infrastructure-as-code (IaC) configuration to + validate. + $ref: '#/components/schemas/IaC' + IaC: + id: IaC + description: Details of an infrastructure-as-code (IaC) configuration. + type: object + properties: + tfPlan: + description: >- + Optional. A Terraform plan file, formatted as a stringified JSON + object. To learn how to generate a Terraform plan file in JSON + format, see [JSON output + format](https://developer.hashicorp.com/terraform/internals/json-format) + in the Terraform documentation. + type: string + format: byte + ListLocationsResponse: + id: ListLocationsResponse + description: The response message for Locations.ListLocations. + type: object + properties: + locations: + description: >- + A list of locations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/Location' + nextPageToken: + description: The standard List next-page token. + type: string + Location: + id: Location + description: A resource that represents a Google Cloud location. + type: object + properties: + name: + description: >- + Resource name for the location, which may vary between + implementations. For example: + `"projects/example-project/locations/us-east1"` + type: string + locationId: + description: 'The canonical id for this location. For example: `"us-east1"`.' + type: string + displayName: + description: >- + The friendly name for this location, typically a nearby city name. + For example, "Tokyo". + type: string + labels: + description: >- + Cross-service attributes for the location. For example + {"cloud.googleapis.com/region": "us-east1"} + type: object + additionalProperties: + type: string + metadata: + description: >- + Service-specific metadata. For example the available capacity at the + given location. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + OperationMetadata: + id: OperationMetadata + description: Metadata for an Operation. + type: object + properties: + createTime: + description: Output only. The time at which the operation was created. + readOnly: true + type: string + format: google-datetime + endTime: + description: Output only. The time at which the operation finished running. + readOnly: true + type: string + format: google-datetime + target: + description: >- + Output only. The server-defined resource path for the target of the + operation. + readOnly: true + type: string + verb: + description: Output only. The name of the action executed by the operation. + readOnly: true + type: string + statusMessage: + description: Output only. The status of the operation, if any. + readOnly: true + type: string + requestedCancellation: + description: >- + Output only. Whether a request to cancel the operation has been + received. For operations that have been cancelled successfully, the + Operation.error field contains the error code CANCELLED. + readOnly: true + type: boolean + apiVersion: + description: Output only. The API version used to start the operation. + readOnly: true + type: string + errorMessage: + description: >- + Output only. An error message. Returned when a PostureDeployment + enters a failure state like UPDATE_FAILED. + readOnly: true + type: string + parameters: + 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: + type: string + enum: + - json + - media + - proto + 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 + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + x-stackQL-resources: + operations: + id: google.securityposture.operations + name: operations + title: Operations + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1operations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.operations + get: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1operations~1{operationsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + cancel: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' + insert: [] + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/operations/methods/delete' + postures: + id: google.securityposture.postures + name: postures + title: Postures + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1postures/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.postures + create: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1postures/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1postures~1{posturesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1postures~1{posturesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1postures~1{posturesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + extract: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1postures:extract/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/postures/methods/get' + - $ref: '#/components/x-stackQL-resources/postures/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/postures/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/postures/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/postures/methods/delete' + postures_revisions: + id: google.securityposture.postures_revisions + name: postures_revisions + title: Postures_revisions + methods: + list_revisions: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1postures~1{posturesId}:listRevisions/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.revisions + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/postures_revisions/methods/list_revisions + insert: [] + update: [] + replace: [] + delete: [] + posture_deployments: + id: google.securityposture.posture_deployments + name: posture_deployments + title: Posture_deployments + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1postureDeployments/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.postureDeployments + create: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1postureDeployments/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1postureDeployments~1{postureDeploymentsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1postureDeployments~1{postureDeploymentsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1postureDeployments~1{postureDeploymentsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/posture_deployments/methods/get' + - $ref: '#/components/x-stackQL-resources/posture_deployments/methods/list' + insert: + - $ref: >- + #/components/x-stackQL-resources/posture_deployments/methods/create + update: + - $ref: '#/components/x-stackQL-resources/posture_deployments/methods/patch' + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/posture_deployments/methods/delete + posture_templates: + id: google.securityposture.posture_templates + name: posture_templates + title: Posture_templates + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1postureTemplates/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.postureTemplates + get: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1postureTemplates~1{postureTemplatesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/posture_templates/methods/get' + - $ref: '#/components/x-stackQL-resources/posture_templates/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + reports: + id: google.securityposture.reports + name: reports + title: Reports + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1reports/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.reports + get: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1reports~1{reportsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/reports/methods/get' + - $ref: '#/components/x-stackQL-resources/reports/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + reports_ia_cvalidation_report: + id: google.securityposture.reports_ia_cvalidation_report + name: reports_ia_cvalidation_report + title: Reports_ia_cvalidation_report + methods: + create_ia_cvalidation_report: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1reports:createIaCValidationReport/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/reports_ia_cvalidation_report/methods/create_ia_cvalidation_report + update: [] + replace: [] + delete: [] + locations: + id: google.securityposture.locations + name: locations + title: Locations + methods: + list: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.locations + get: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' + insert: [] + update: [] + replace: [] + delete: [] +paths: + /v1/organizations/{organizationsId}/locations/{locationsId}/operations: + parameters: &ref_1 + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: securityposture.organizations.locations.operations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListOperationsResponse' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: securityposture.organizations.locations.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + delete: + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: securityposture.organizations.locations.operations.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + `1`, corresponding to `Code.CANCELLED`. + operationId: securityposture.organizations.locations.operations.cancel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CancelOperationRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/postures: + parameters: *ref_1 + get: + description: >- + Lists the most recent revisions of all Posture resources in a specified + organization and location. + operationId: securityposture.organizations.locations.postures.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListPosturesResponse' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + post: + description: Creates a new Posture. + operationId: securityposture.organizations.locations.postures.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Posture' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: postureId + schema: + type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/postures/{posturesId}:listRevisions: + parameters: *ref_1 + get: + description: Lists all revisions of a single Posture. + operationId: securityposture.organizations.locations.postures.listRevisions + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListPostureRevisionsResponse' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: posturesId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/postures/{posturesId}: + parameters: *ref_1 + get: + description: Gets a single revision of a Posture. + operationId: securityposture.organizations.locations.postures.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Posture' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: posturesId + required: true + schema: + type: string + - in: query + name: revisionId + schema: + type: string + patch: + description: >- + Updates a revision of an existing Posture. If the posture revision that + you update is currently deployed, then a new revision of the posture is + created. To prevent concurrent updates from overwriting each other, + always follow the read-modify-write pattern when you update a posture: + 1. Call GetPosture to get the current version of the posture. 2. Update + the fields in the posture as needed. 3. Call UpdatePosture to update the + posture. Ensure that your request includes the `etag` value from the + GetPosture response. **Important:** If you omit the `etag` when you call + UpdatePosture, then the updated posture unconditionally overwrites the + existing posture. + operationId: securityposture.organizations.locations.postures.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Posture' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: posturesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: revisionId + schema: + type: string + delete: + description: >- + Deletes all revisions of a Posture. You can only delete a posture if + none of its revisions are deployed. + operationId: securityposture.organizations.locations.postures.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: posturesId + required: true + schema: + type: string + - in: query + name: etag + schema: + type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/postures:extract: + parameters: *ref_1 + post: + description: >- + Extracts existing policies from an organization, folder, or project, and + applies them to another organization, folder, or project as a Posture. + If the other organization, folder, or project already has a posture, + then the result of the long-running operation is an ALREADY_EXISTS + error. + operationId: securityposture.organizations.locations.postures.extract + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExtractPostureRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/postureDeployments: + parameters: *ref_1 + get: + description: Lists every PostureDeployment in a project and location. + operationId: securityposture.organizations.locations.postureDeployments.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListPostureDeploymentsResponse' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + post: + description: Creates a new PostureDeployment in a given project and location. + operationId: securityposture.organizations.locations.postureDeployments.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PostureDeployment' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: postureDeploymentId + schema: + type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/postureDeployments/{postureDeploymentsId}: + parameters: *ref_1 + get: + description: Gets details for a PostureDeployment. + operationId: securityposture.organizations.locations.postureDeployments.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/PostureDeployment' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: postureDeploymentsId + required: true + schema: + type: string + patch: + description: >- + Updates an existing PostureDeployment. To prevent concurrent updates + from overwriting each other, always follow the read-modify-write pattern + when you update a posture deployment: 1. Call GetPostureDeployment to + get the current version of the deployment. 2. Update the fields in the + deployment as needed. 3. Call UpdatePostureDeployment to update the + deployment. Ensure that your request includes the `etag` value from the + GetPostureDeployment response. **Important:** If you omit the `etag` + when you call UpdatePostureDeployment, then the updated deployment + unconditionally overwrites the existing deployment. + operationId: securityposture.organizations.locations.postureDeployments.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PostureDeployment' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: postureDeploymentsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a PostureDeployment. + operationId: securityposture.organizations.locations.postureDeployments.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: postureDeploymentsId + required: true + schema: + type: string + - in: query + name: etag + schema: + type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/postureTemplates: + parameters: *ref_1 + get: + description: Lists every PostureTemplate in a given organization and location. + operationId: securityposture.organizations.locations.postureTemplates.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListPostureTemplatesResponse' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/postureTemplates/{postureTemplatesId}: + parameters: *ref_1 + get: + description: Gets a single revision of a PostureTemplate. + operationId: securityposture.organizations.locations.postureTemplates.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/PostureTemplate' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: postureTemplatesId + required: true + schema: + type: string + - in: query + name: revisionId + schema: + type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/reports: + parameters: *ref_1 + get: + description: Lists every Report in a given organization and location. + operationId: securityposture.organizations.locations.reports.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListReportsResponse' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/reports/{reportsId}: + parameters: *ref_1 + get: + description: Gets details for a Report. + operationId: securityposture.organizations.locations.reports.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Report' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: reportsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/reports:createIaCValidationReport: + parameters: *ref_1 + post: + description: >- + Validates a specified infrastructure-as-code (IaC) configuration, and + creates a Report with the validation results. Only Terraform + configurations are supported. Only modified assets are validated. + operationId: >- + securityposture.organizations.locations.reports.createIaCValidationReport + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateIaCValidationReportRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations: + parameters: *ref_1 + get: + description: Lists information about the supported locations for this service. + operationId: securityposture.projects.locations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListLocationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: extraLocationTypes + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}: + parameters: *ref_1 + get: + description: Gets information about a location. + operationId: securityposture.projects.locations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Location' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/serviceconsumermanagement.yaml b/providers/src/googleapis.com/v00.00.00000/services/serviceconsumermanagement.yaml index 15fcb5a5..50485668 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/serviceconsumermanagement.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/serviceconsumermanagement.yaml @@ -7,8 +7,8 @@ info: title: Service Consumer Management API description: Manages the service consumers of a Service Infrastructure service. version: v1 - x-discovery-doc-revision: '20241025' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250619' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/service-consumer-management/docs/overview servers: @@ -35,15 +35,6 @@ components: scopes: *ref_0 schemas: MonitoredResourceDescriptor: - id: MonitoredResourceDescriptor - description: >- - An object that describes the schema of a MonitoredResource object using - a type name and a set of labels. For example, the monitored resource - descriptor for Google Compute Engine VM instances has a type of - `"gce_instance"` and specifies the use of the labels `"instance_id"` and - `"zone"` to identify particular VM instances. Different APIs can support - different monitored resource types. APIs generally provide a `list` - method that returns the monitored resource descriptors used by the API. properties: displayName: description: >- @@ -52,7 +43,17 @@ components: Phrase, without any article or other determiners. For example, `"Google Cloud SQL Database"`. type: string + labels: + type: array + items: + $ref: '#/components/schemas/LabelDescriptor' + description: >- + Required. A set of labels used to describe instances of this + monitored resource type. For example, an individual Google Cloud SQL + database is identified by values for the labels `"database_id"` and + `"zone"`. launchStage: + description: Optional. The launch stage of the monitored resource definition. enumDescriptions: - Do not use this default value. - The feature is not yet implemented. Users can not use it. @@ -91,7 +92,6 @@ components: [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud Platform Subject to the Deprecation Policy](https://cloud.google.com/terms/deprecation) documentation. - description: Optional. The launch stage of the monitored resource definition. enum: - LAUNCH_STAGE_UNSPECIFIED - UNIMPLEMENTED @@ -111,6 +111,11 @@ components: {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format `"monitoredResourceDescriptors/{type}"`. + description: + description: >- + Optional. A detailed description of the monitored resource type that + might be used in documentation. + type: string type: description: >- Required. The monitored resource type. For example, the type @@ -120,181 +125,306 @@ components: [Logging resource types](https://cloud.google.com/logging/docs/api/v2/resource-list). type: string - labels: - type: array - items: - $ref: '#/components/schemas/LabelDescriptor' - description: >- - Required. A set of labels used to describe instances of this - monitored resource type. For example, an individual Google Cloud SQL - database is identified by values for the labels `"database_id"` and - `"zone"`. - description: - type: string - description: >- - Optional. A detailed description of the monitored resource type that - might be used in documentation. + id: MonitoredResourceDescriptor + description: >- + An object that describes the schema of a MonitoredResource object using + a type name and a set of labels. For example, the monitored resource + descriptor for Google Compute Engine VM instances has a type of + `"gce_instance"` and specifies the use of the labels `"instance_id"` and + `"zone"` to identify particular VM instances. Different APIs can support + different monitored resource types. APIs generally provide a `list` + method that returns the monitored resource descriptors used by the API. type: object - Method: + CppSettings: + id: CppSettings + properties: + common: + $ref: '#/components/schemas/CommonLanguageSettings' + description: Some settings. + description: Settings for C++ client libraries. + type: object + CustomHttpPattern: type: object - description: Method represents a method of an API interface. - id: Method properties: - requestTypeUrl: + path: + description: The path matched by this custom verb. type: string - description: A URL of the input message type. - name: + kind: + description: The name of this custom HTTP verb. type: string - description: The simple name of this method. - syntax: + id: CustomHttpPattern + description: A custom pattern is used for defining custom HTTP verb. + LabelDescriptor: + properties: + description: + description: A human-readable description for the label. + type: string + valueType: enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS - description: The source syntax of this method. + - STRING + - BOOL + - INT64 enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. + - A variable-length string. This is the default. + - Boolean; true or false. + - A 64-bit signed integer. type: string - responseTypeUrl: + description: The type of data that can be assigned to the label. + key: type: string - description: The URL of the output message type. - options: - type: array - description: Any metadata attached to the method. - items: - $ref: '#/components/schemas/Option' - requestStreaming: - description: If true, the request is streamed. - type: boolean - responseStreaming: - type: boolean - description: If true, the response is streamed. - TenantResource: + description: The label key. + id: LabelDescriptor type: object + description: A description of a label. + ClientLibrarySettings: properties: - resource: - description: >- - Output only. @OutputOnly Identifier of the tenant resource. For - cloud projects, it is in the form 'projects/{number}'. For example - 'projects/123456'. - type: string - readOnly: true - tag: - type: string - description: Unique per single tenancy unit. - status: - type: string - description: Status of tenant resource. + launchStage: enum: - - STATUS_UNSPECIFIED - - PENDING_CREATE - - ACTIVE - - PENDING_DELETE - - FAILED - - DELETED + - LAUNCH_STAGE_UNSPECIFIED + - UNIMPLEMENTED + - PRELAUNCH + - EARLY_ACCESS + - ALPHA + - BETA + - GA + - DEPRECATED + description: Launch stage of this version of the API. + type: string enumDescriptions: - - Unspecified status is the default unset value. - - Creation of the tenant resource is ongoing. - - Active resource. - - Deletion of the resource is ongoing. - - Tenant resource creation or deletion has failed. - - Tenant resource has been deleted. - description: Resource constituting the TenancyUnit. - id: TenantResource - V1Beta1DisableConsumerResponse: - properties: {} - id: V1Beta1DisableConsumerResponse - description: >- - Response message for the `DisableConsumer` method. This response message - is assigned to the `response` field of the returned Operation when that - operation is done. - type: object - GoSettings: - properties: - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - description: Settings for Go client libraries. + - Do not use this default value. + - The feature is not yet implemented. Users can not use it. + - >- + Prelaunch features are hidden from users and are only visible + internally. + - >- + Early Access features are limited to a closed group of testers. To + use these features, you must sign up in advance and sign a Trusted + Tester agreement (which includes confidentiality provisions). + These features may be unstable, changed in backward-incompatible + ways, and are not guaranteed to be released. + - >- + Alpha is a limited availability test for releases before they are + cleared for widespread use. By Alpha, all significant design + issues are resolved and we are in the process of verifying + functionality. Alpha customers need to apply for access, agree to + applicable terms, and have their projects allowlisted. Alpha + releases don't have to be feature complete, no SLAs are provided, + and there are no technical support obligations, but they will be + far enough along that customers can actually use them in test + environments or for limited-use tests -- just like they would in + normal production cases. + - >- + Beta is the point at which we are ready to open a release for any + customer to use. There are no SLA or technical support obligations + in a Beta release. Products will be complete from a feature + perspective, but may have some open outstanding issues. Beta + releases are suitable for limited production use cases. + - >- + GA features are open to all developers and are considered stable + and fully qualified for production use. + - >- + Deprecated features are scheduled to be shut down and removed. For + more information, see the "Deprecation Policy" section of our + [Terms of Service](https://cloud.google.com/terms/) and the + [Google Cloud Platform Subject to the Deprecation + Policy](https://cloud.google.com/terms/deprecation) documentation. + phpSettings: + $ref: '#/components/schemas/PhpSettings' + description: Settings for PHP client libraries. + version: + type: string + description: >- + Version of the API to apply these settings to. This is the full + protobuf package for the API, ending in the version element. + Examples: "google.cloud.speech.v1" and + "google.spanner.admin.database.v1". + dotnetSettings: + description: Settings for .NET client libraries. + $ref: '#/components/schemas/DotnetSettings' + cppSettings: + $ref: '#/components/schemas/CppSettings' + description: Settings for C++ client libraries. + rubySettings: + description: Settings for Ruby client libraries. + $ref: '#/components/schemas/RubySettings' + javaSettings: + $ref: '#/components/schemas/JavaSettings' + description: Settings for legacy Java features, supported in the Service YAML. + goSettings: + description: Settings for Go client libraries. + $ref: '#/components/schemas/GoSettings' + nodeSettings: + description: Settings for Node client libraries. + $ref: '#/components/schemas/NodeSettings' + restNumericEnums: + type: boolean + description: >- + When using transport=rest, the client request will encode enums as + numbers rather than strings. + pythonSettings: + description: Settings for Python client libraries. + $ref: '#/components/schemas/PythonSettings' type: object - id: GoSettings - Usage: + id: ClientLibrarySettings + description: Details about how and where to publish client libraries. + Quota: properties: - rules: + limits: items: - $ref: '#/components/schemas/UsageRule' - description: >- - A list of usage rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. + $ref: '#/components/schemas/QuotaLimit' + description: List of QuotaLimit definitions for the service. type: array - producerNotificationChannel: + metricRules: + items: + $ref: '#/components/schemas/MetricRule' description: >- - The full resource name of a channel used for sending notifications - to the service producer. Google Service Management currently only - supports [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as - a notification channel. To use Google Cloud Pub/Sub as the channel, - this must be the name of a Cloud Pub/Sub topic that uses the Cloud - Pub/Sub topic name format documented in - https://cloud.google.com/pubsub/docs/overview. + List of MetricRule definitions, each one mapping a selected method + to one or more metrics. + type: array + id: Quota + type: object + description: >- + Quota configuration helps to achieve fairness and budgeting in service + usage. The metric based quota configuration works this way: - The + service configuration defines a set of metrics. - For API calls, the + quota.metric_rules maps methods to metrics with corresponding costs. - + The quota.limits defines limits on the metrics, which will be used for + quota checks at runtime. An example quota configuration in yaml format: + quota: limits: - name: apiWriteQpsPerProject metric: + library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit + for consumer projects values: STANDARD: 10000 (The metric rules bind all + methods to the read_calls metric, except for the UpdateBook and + DeleteBook methods. These two methods are mapped to the write_calls + metric, with the UpdateBook method consuming at twice rate as the + DeleteBook method.) metric_rules: - selector: "*" metric_costs: + library.googleapis.com/read_calls: 1 - selector: + google.example.library.v1.LibraryService.UpdateBook metric_costs: + library.googleapis.com/write_calls: 2 - selector: + google.example.library.v1.LibraryService.DeleteBook metric_costs: + library.googleapis.com/write_calls: 1 Corresponding Metric definition: + metrics: - name: library.googleapis.com/read_calls display_name: Read + requests metric_kind: DELTA value_type: INT64 - name: + library.googleapis.com/write_calls display_name: Write requests + metric_kind: DELTA value_type: INT64 + ContextRule: + type: object + properties: + requested: + description: >- + A list of full type names of requested contexts, only the requested + context will be made available to the backend. + items: + type: string + type: array + provided: + items: + type: string + description: >- + A list of full type names of provided contexts. It is used to + support propagating HTTP headers and ETags from the response + extension. + type: array + selector: type: string - requirements: + description: >- + Selects the methods to which this rule applies. Refer to selector + for syntax details. + allowedRequestExtensions: type: array description: >- - Requirements that must be satisfied before a consumer project can - use the service. Each requirement is of the form /; for example - 'serviceusage.googleapis.com/billing-enabled'. For Google APIs, a - Terms of Service requirement must be included here. Google Cloud - APIs must include "serviceusage.googleapis.com/tos/cloud". Other - Google APIs should include - "serviceusage.googleapis.com/tos/universal". Additional ToS can be - included based on the business needs. + A list of full type names or extension IDs of extensions allowed in + grpc side channel from client to backend. items: type: string - type: object - description: Configuration controlling usage of a service. - id: Usage - Page: - type: object + allowedResponseExtensions: + items: + type: string + type: array + description: >- + A list of full type names or extension IDs of extensions allowed in + grpc side channel from backend to client. + id: ContextRule description: >- - Represents a documentation page. A page can contain subpages to - represent nested documentation set structure. + A context rule provides information about the context for an individual + API element. + BatchingDescriptorProto: + id: BatchingDescriptorProto properties: - content: + subresponseField: + type: string description: >- - The Markdown content of the page. You can use (== include {path} ==) - to include content from a Markdown file. The content can be used to - produce the documentation page such as HTML format page. + Optional. When present, indicates the field in the response message + to be used to demultiplex the response into multiple response + messages, in correspondence with the multiple request messages + originally batched together. + batchedField: type: string - subpages: - items: - $ref: '#/components/schemas/Page' + description: >- + The repeated field in the request message to be aggregated by + batching. + discriminatorFields: type: array + items: + type: string description: >- - Subpages of this page. The order of subpages specified here will be - honored in the generated docset. - name: + A list of the fields in the request message. Two requests will be + batched together only if the values of every field specified in + `request_discriminator_fields` is equal between the two requests. + type: object + description: >- + `BatchingDescriptorProto` specifies the fields of the request message to + be used for batching, and, optionally, the fields of the response + message to be used for demultiplexing. + PhpSettings: + id: PhpSettings + description: Settings for Php client libraries. + type: object + properties: + libraryPackage: + description: >- + The package name to use in Php. Clobbers the php_namespace option + set in the protobuf. This should be used **only** by APIs who have + already set the language_settings.php.package_name" field in + gapic.yaml. API teams should use the protobuf php_namespace option + where possible. Example of a YAML configuration:: publishing: + library_settings: php_settings: library_package: + Google\Cloud\PubSub\V1 type: string + common: + $ref: '#/components/schemas/CommonLanguageSettings' + description: Some settings. + Empty: + properties: {} + id: Empty + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + type: object + TenantProjectPolicy: + description: >- + Describes policy settings that can be applied to a newly created tenant + project. + type: object + id: TenantProjectPolicy + properties: + policyBindings: description: >- - The name of the page. It will be used as an identity of the page to - generate URI of the page, text of the link to this page in - navigation, etc. The full page name (start from the root page name - to this page concatenated with `.`) can be used as reference to the - page in your documentation. For example: pages: - name: Tutorial - content: (== include tutorial.md ==) subpages: - name: Java content: - (== include tutorial_java.md ==) You can reference `Java` page using - Markdown reference link syntax: `Java`. - id: Page + Policy bindings to be applied to the tenant project, in addition to + the 'roles/owner' role granted to the Service Consumer Management + service account. + type: array + items: + $ref: '#/components/schemas/PolicyBinding' AuthRequirement: properties: providerId: + type: string description: >- id from authentication provider. Example: provider_id: bookstore_auth - type: string audiences: - type: string description: >- NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of @@ -308,454 +438,265 @@ components: "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com - id: AuthRequirement + type: string + type: object description: >- User-defined authentication requirements, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). - type: object - OAuthRequirements: - description: >- - OAuth scopes are a way to define data and permissions on data. For - example, there are scopes defined for "Read-only access to Google - Calendar" and "Access to Cloud Platform". Users can consent to a scope - for an application, giving it permission to access that data on their - behalf. OAuth scope specifications should be fairly coarse grained; a - user will need to see and understand the text description of what your - scope means. In most cases: use one or at most two OAuth scopes for an - entire family of products. If your product has multiple APIs, you should - probably be sharing the OAuth scope across all of those APIs. When you - need finer grained OAuth consent screens: talk with your product - management about how developers will use them in practice. Please note - that even though each of the canonical scopes is enough for a request to - be accepted and passed to the backend, a request can still fail due to - the backend requiring additional scopes or permissions. + id: AuthRequirement + V1ServiceAccount: + description: A service account in the Identity and Access Management API. properties: - canonicalScopes: - description: >- - The list of publicly documented OAuth scopes that are allowed - access. An OAuth token containing any of these scopes will be - accepted. Example: canonical_scopes: - https://www.googleapis.com/auth/calendar, - https://www.googleapis.com/auth/calendar.read + iamAccountName: + deprecated: true + description: Deprecated. See b/136209818. type: string - id: OAuthRequirements - type: object - SystemParameters: - id: SystemParameters - description: >- - ### System parameter configuration A system parameter is a special kind - of parameter defined by the API system, not by an individual API. It is - typically mapped to an HTTP header and/or a URL query parameter. This - configuration specifies which methods change the names of the system - parameters. - properties: - rules: - type: array + tag: description: >- - Define system parameters. The parameters defined here will override - the default parameters implemented by the system. If this field is - missing from the service config, default system parameters will be - used. Default system parameters and names is - implementation-dependent. Example: define api key for all methods - system_parameters rules: - selector: "*" parameters: - name: api_key - url_query_parameter: api_key Example: define 2 api key names for a - specific method. system_parameters rules: - selector: "/ListShelves" - parameters: - name: api_key http_header: Api-Key1 - name: api_key - http_header: Api-Key2 **NOTE:** All service configuration rules - follow "last one wins" order. - items: - $ref: '#/components/schemas/SystemParameterRule' - type: object - JwtLocation: - properties: - query: + The P4 SA configuration tag. This must be defined in + activation_grants. If not specified when creating the account, the + tag is set to "default". type: string - description: Specifies URL query parameter name to extract JWT token. - header: + uniqueId: + description: The unique and stable id of the service account. type: string - description: Specifies HTTP header name to extract JWT token. - cookie: + email: type: string - description: Specifies cookie name to extract JWT token. - valuePrefix: + description: The email address of the service account. + name: type: string description: >- - The value prefix. The value format is "value_prefix{token}" Only - applies to "in" header type. Must be empty for "in" query type. If - not empty, the header value has to match (case sensitive) this - prefix. If not matched, JWT will not be extracted. If matched, JWT - will be extracted after the prefix is removed. For example, for - "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space - at the end. - id: JwtLocation - type: object - description: Specifies a location to extract JWT from an API request. - SelectiveGapicGeneration: + P4 SA resource name. An example name would be: + `services/serviceconsumermanagement.googleapis.com/projects/123/serviceAccounts/default` + id: V1ServiceAccount type: object - description: >- - This message is used to configure the generation of a subset of the RPCs - in a service for client libraries. + Monitoring: properties: - methods: + producerDestinations: + description: >- + Monitoring configurations for sending metrics to the producer + project. There can be multiple producer destinations. A monitored + resource type may appear in multiple monitoring destinations if + different aggregations are needed for different sets of metrics + associated with that monitored resource type. A monitored resource + and metric pair may only be used once in the Monitoring + configuration. type: array items: - type: string + $ref: '#/components/schemas/MonitoringDestination' + consumerDestinations: + items: + $ref: '#/components/schemas/MonitoringDestination' description: >- - An allowlist of the fully qualified names of RPCs that should be - included on public client surfaces. - id: SelectiveGapicGeneration - V1Beta1GenerateServiceIdentityResponse: - id: V1Beta1GenerateServiceIdentityResponse - type: object - description: >- - Response message for the `GenerateServiceIdentity` method. This response - message is assigned to the `response` field of the returned Operation - when that operation is done. - properties: - identity: - $ref: '#/components/schemas/V1Beta1ServiceIdentity' - description: ServiceIdentity that was created or retrieved. - SystemParameterRule: - type: object - properties: - selector: - type: string - description: >- - Selects the methods to which this rule applies. Use '*' to indicate - all methods in all APIs. Refer to selector for syntax details. - parameters: - description: >- - Define parameters. Multiple names may be defined for a parameter. - For a given method call, only one of them should be used. If - multiple names are used the behavior is implementation-dependent. If - none of the specified names are present the behavior is - parameter-dependent. + Monitoring configurations for sending metrics to the consumer + project. There can be multiple consumer destinations. A monitored + resource type may appear in multiple monitoring destinations if + different aggregations are needed for different sets of metrics + associated with that monitored resource type. A monitored resource + and metric pair may only be used once in the Monitoring + configuration. type: array - items: - $ref: '#/components/schemas/SystemParameter' - description: >- - Define a system parameter rule mapping system parameter definitions to - methods. - id: SystemParameterRule - AuthenticationRule: - id: AuthenticationRule description: >- - Authentication rules for the service. By default, if a method has any - authentication requirements, every request must include a valid - credential matching one of the requirements. It's an error to include - more than one kind of credential in a single request. If a method - doesn't have any auth requirements, request credentials will be ignored. + Monitoring configuration of the service. The example below shows how to + configure monitored resources and metrics for monitoring. In the + example, a monitored resource and two metrics are defined. The + `library.googleapis.com/book/returned_count` metric is sent to both + producer and consumer projects, whereas the + `library.googleapis.com/book/num_overdue` metric is only sent to the + consumer project. monitored_resources: - type: + library.googleapis.com/Branch display_name: "Library Branch" + description: "A branch of a library." launch_stage: GA labels: - key: + resource_container description: "The Cloud container (ie. project id) + for the Branch." - key: location description: "The location of the + library branch." - key: branch_id description: "The id of the branch." + metrics: - name: library.googleapis.com/book/returned_count + display_name: "Books Returned" description: "The count of books that + have been returned." launch_stage: GA metric_kind: DELTA value_type: + INT64 unit: "1" labels: - key: customer_id description: "The id of the + customer." - name: library.googleapis.com/book/num_overdue display_name: + "Books Overdue" description: "The current number of overdue books." + launch_stage: GA metric_kind: GAUGE value_type: INT64 unit: "1" labels: + - key: customer_id description: "The id of the customer." monitoring: + producer_destinations: - monitored_resource: + library.googleapis.com/Branch metrics: - + library.googleapis.com/book/returned_count consumer_destinations: - + monitored_resource: library.googleapis.com/Branch metrics: - + library.googleapis.com/book/returned_count - + library.googleapis.com/book/num_overdue + id: Monitoring type: object + V1Beta1ServiceIdentity: properties: - allowWithoutCredential: - type: boolean - description: >- - If true, the service accepts API keys without any other credential. - This flag only applies to HTTP and gRPC requests. - selector: - type: string - description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. - oauth: - description: The requirements for OAuth credentials. - $ref: '#/components/schemas/OAuthRequirements' - requirements: - items: - $ref: '#/components/schemas/AuthRequirement' - type: array - description: Requirements for additional authentication providers. - V1Beta1ProducerQuotaPolicy: - description: Quota policy created by service producer. - id: V1Beta1ProducerQuotaPolicy - properties: - policyValue: - description: >- - The quota policy value. Can be any nonnegative integer, or -1 - (unlimited quota). - format: int64 - type: string - unit: - description: >- - The limit unit of the limit to which this policy applies. An example - unit would be: `1/{project}/{region}` Note that `{project}` and - `{region}` are not placeholders in this example; the literal - characters `{` and `}` occur in the string. + email: + description: The email address of the service identity. type: string - container: + name: type: string description: >- - The cloud resource container at which the quota policy is created. - The format is {container_type}/{container_number} - dimensions: - description: ' If this map is nonempty, then this policy applies only to specific values for dimensions defined in the limit unit. For example, a policy on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the policy is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit''s unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota polcies that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map.' - additionalProperties: - type: string - type: object - metric: + P4 service identity resource name. An example name would be: + `services/serviceconsumermanagement.googleapis.com/projects/123/serviceIdentities/default` + tag: type: string description: >- - The name of the metric to which this policy applies. An example name - would be: `compute.googleapis.com/cpus` - name: - description: >- - The resource name of the producer policy. An example name would be: - `services/compute.googleapis.com/organizations/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerQuotaPolicies/4a3f2c1d` + The P4 service identity configuration tag. This must be defined in + activation_grants. If not specified when creating the account, the + tag is set to "default". + uniqueId: type: string + description: The unique and stable id of the service identity. type: object - RubySettings: - id: RubySettings - description: Settings for Ruby client libraries. - properties: - common: - description: Some settings. - $ref: '#/components/schemas/CommonLanguageSettings' - type: object - ServiceAccountConfig: - description: Describes the service account configuration for the tenant project. + description: A service identity in the Identity and Access Management API. + id: V1Beta1ServiceIdentity + MetricRule: properties: - tenantProjectRoles: - items: + metricCosts: + description: >- + Metrics to update when the selected methods are called, and the + associated cost applied to each metric. The key of the map is the + metric name, and the values are the amount increased for the metric + against which the quota limits are defined. The value must not be + negative. + type: object + additionalProperties: + format: int64 type: string - description: Roles for the associated service account for the tenant project. - type: array - accountId: - type: string + selector: description: >- - ID of the IAM service account to be created in tenant project. The - email format of the service account is "@.iam.gserviceaccount.com". - This account ID must be unique within tenant project and service - producers have to guarantee it. The ID must be 6-30 characters long, - and match the following regular expression: - `[a-z]([-a-z0-9]*[a-z0-9])`. + Selects the methods to which this rule applies. Refer to selector + for syntax details. + type: string + description: >- + Bind API methods to metrics. Binding a method to a metric causes that + metric's configured quota behaviors to apply to the method call. + id: MetricRule type: object - id: ServiceAccountConfig - HttpRule: + Documentation: type: object properties: - patch: - description: Maps to HTTP PATCH. Used for updating a resource. - type: string - body: - description: >- - The name of the request field whose value is mapped to the HTTP - request body, or `*` for mapping all request fields not captured by - the path pattern to the HTTP body, or omitted for not having any - HTTP request body. NOTE: the referred field must be present at the - top-level of the request message type. - type: string - put: + documentationRootUrl: type: string - description: Maps to HTTP PUT. Used for replacing a resource. - responseBody: + description: The URL to the root of documentation. + overview: description: >- - Optional. The name of the response field whose value is mapped to - the HTTP response body. When omitted, the entire response message - will be used as the HTTP response body. NOTE: The referred field - must be present at the top-level of the response message type. + Declares a single overview page. For example: documentation: + summary: ... overview: (== include overview.md ==) This is a + shortcut for the following declaration (using pages style): + documentation: summary: ... pages: - name: Overview content: (== + include overview.md ==) Note: you cannot specify both `overview` + field and `pages` field. type: string - get: + serviceRootUrl: type: string description: >- - Maps to HTTP GET. Used for listing and getting information about - resources. - selector: + Specifies the service root url if the default one (the service name + from the yaml file) is not suitable. This can be seen in any fully + specified service urls as well as sections that show a base that + other urls are relative to. + additionalIamInfo: type: string description: >- - Selects a method to which this rule applies. Refer to selector for - syntax details. - additionalBindings: + Optional information about the IAM configuration. This is typically + used to link to documentation about a product's IAM roles and + permissions. + sectionOverrides: type: array + description: >- + Specifies section and content to override the boilerplate content. + Currently overrides following sections: 1. + rest.service.client_libraries items: - $ref: '#/components/schemas/HttpRule' + $ref: '#/components/schemas/Page' + pages: + description: The top level pages for the documentation set. + items: + $ref: '#/components/schemas/Page' + type: array + rules: description: >- - Additional HTTP bindings for the selector. Nested bindings must not - contain an `additional_bindings` field themselves (that is, the - nesting may only be one level deep). - custom: - $ref: '#/components/schemas/CustomHttpPattern' + A list of documentation rules that apply to individual API elements. + **NOTE:** All service configuration rules follow "last one wins" + order. + type: array + items: + $ref: '#/components/schemas/DocumentationRule' + summary: description: >- - The custom pattern is used for specifying an HTTP method that is not - included in the `pattern` field, such as HEAD, or "*" to leave the - HTTP method unspecified for this rule. The wild-card rule is useful - for services that provide content to Web (HTML) clients. - delete: + A short description of what the service does. The summary must be + plain text. It becomes the overview of the service displayed in + Google Cloud Console. NOTE: This field is equivalent to the standard + field `description`. type: string - description: Maps to HTTP DELETE. Used for deleting a resource. - post: - description: >- - Maps to HTTP POST. Used for creating a resource or performing an - action. - type: string - id: HttpRule description: >- - gRPC Transcoding gRPC Transcoding is a feature for mapping between a - gRPC method and one or more HTTP REST endpoints. It allows developers to - build a single API service that supports both gRPC APIs and REST APIs. - Many systems, including [Google - APIs](https://github.com/googleapis/googleapis), [Cloud - Endpoints](https://cloud.google.com/endpoints), [gRPC - Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and - [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature - and use it for large scale production services. `HttpRule` defines the - schema of the gRPC/REST mapping. The mapping specifies how different - portions of the gRPC request message are mapped to the URL path, URL - query parameters, and HTTP request body. It also controls how the gRPC - response message is mapped to the HTTP response body. `HttpRule` is - typically specified as an `google.api.http` annotation on the gRPC - method. Each mapping specifies a URL path template and an HTTP method. - The path template may refer to one or more fields in the gRPC request - message, as long as each field is a non-repeated field with a primitive - (non-message) type. The path template controls how fields of the request - message are mapped to the URL path. Example: service Messaging { rpc - GetMessage(GetMessageRequest) returns (Message) { option - (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message - GetMessageRequest { string name = 1; // Mapped to URL path. } message - Message { string text = 1; // The resource content. } This enables an - HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - - gRPC: `GetMessage(name: "messages/123456")` Any fields in the request - message which are not bound by the path template automatically become - HTTP query parameters if there is no HTTP request body. For example: - service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) - { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } - message GetMessageRequest { message SubMessage { string subfield = 1; } - string message_id = 1; // Mapped to URL path. int64 revision = 2; // - Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped - to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC - mapping as below: - HTTP: `GET - /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: - `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: - "foo"))` Note that fields which are mapped to URL query parameters must - have a primitive type or a repeated primitive type or a non-repeated - message type. In the case of a repeated type, the parameter can be - repeated in the URL as `...?param=A¶m=B`. In the case of a message - type, each field of the message is mapped to a separate parameter, such - as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request - body, the `body` field specifies the mapping. Consider a REST update - method on the message resource collection: service Messaging { rpc - UpdateMessage(UpdateMessageRequest) returns (Message) { option - (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" - }; } } message UpdateMessageRequest { string message_id = 1; // mapped - to the URL Message message = 2; // mapped to the body } The following - HTTP JSON to RPC mapping is enabled, where the representation of the - JSON in the request body is determined by protos JSON encoding: - HTTP: - `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: - `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The - special name `*` can be used in the body mapping to define that every - field not bound by the path template should be mapped to the request - body. This enables the following alternative definition of the update - method: service Messaging { rpc UpdateMessage(Message) returns (Message) - { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: - "*" }; } } message Message { string message_id = 1; string text = 2; } - The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH - /v1/messages/123456 { "text": "Hi!" }` - gRPC: - `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using - `*` in the body mapping, it is not possible to have HTTP parameters, as - all fields not bound by the path end in the body. This makes this option - more rarely used in practice when defining REST APIs. The common usage - of `*` is in custom methods which don't use the URL at all for - transferring data. It is possible to define multiple HTTP methods for - one RPC by using the `additional_bindings` option. Example: service - Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option - (google.api.http) = { get: "/v1/messages/{message_id}" - additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } - }; } } message GetMessageRequest { string message_id = 1; string user_id - = 2; } This enables the following two alternative HTTP JSON to RPC - mappings: - HTTP: `GET /v1/messages/123456` - gRPC: - `GetMessage(message_id: "123456")` - HTTP: `GET - /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" - message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields - (recursive expansion nested messages in the request message) are - classified into three categories: - Fields referred by the path - template. They are passed via the URL path. - Fields referred by the - HttpRule.body. They are passed via the HTTP request body. - All other - fields are passed via the URL query parameters, and the parameter name - is the field path in the request message. A repeated field can be - represented as multiple query parameters under the same name. 2. If - HttpRule.body is "*", there is no URL query parameter, all fields are - passed via URL path and HTTP request body. 3. If HttpRule.body is - omitted, there is no HTTP request body, all fields are passed via URL - path and URL query parameters. Path template syntax Template = "/" - Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | - "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] - "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax - `*` matches a single URL path segment. The syntax `**` matches zero or - more URL path segments, which must be the last part of the URL path - except the `Verb`. The syntax `Variable` matches part of the URL path as - specified by its template. A variable template must not contain other - variables. If a variable matches a single path segment, its template may - be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax - `LITERAL` matches literal text in the URL path. If the `LITERAL` - contains any reserved character, such characters should be - percent-encoded before the matching. If a variable contains exactly one - path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is - expanded into a URL path on the client side, all characters except - `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse - decoding. Such variables show up in the [Discovery - Document](https://developers.google.com/discovery/v1/reference/apis) as - `{var}`. If a variable contains multiple path segments, such as - `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a - URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` - are percent-encoded. The server side does the reverse decoding, except - "%2F" and "%2f" are left unchanged. Such variables show up in the - [Discovery - Document](https://developers.google.com/discovery/v1/reference/apis) as - `{+var}`. Using gRPC API Service Configuration gRPC API Service - Configuration (service config) is a configuration language for - configuring a gRPC service to become a user-facing product. The service - config is simply the YAML representation of the `google.api.Service` - proto message. As an alternative to annotating your proto file, you can - configure gRPC transcoding in your service config YAML files. You do - this by specifying a `HttpRule` that maps the gRPC method to a REST - endpoint, achieving the same effect as the proto annotation. This can be - particularly useful if you have a proto that is reused in multiple - services. Note that any transcoding specified in the service config will - override any matching transcoding configuration in the proto. The - following example selects a gRPC method and applies an `HttpRule` to it: - http: rules: - selector: example.v1.Messaging.GetMessage get: - /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC - Transcoding is used to map a gRPC to JSON REST endpoints, the proto to - JSON conversion must follow the [proto3 - specification](https://developers.google.com/protocol-buffers/docs/proto3#json). - While the single segment variable follows the semantics of [RFC - 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String - Expansion, the multi segment variable **does not** follow RFC 6570 - Section 3.2.3 Reserved Expansion. The reason is that the Reserved - Expansion does not expand special characters like `?` and `#`, which - would lead to invalid URLs. As the result, gRPC Transcoding uses a - custom encoding for multi segment variables. The path variables **must - not** refer to any repeated or mapped field, because client libraries - are not capable of handling such variable expansion. The path variables - **must not** capture the leading "/" character. The reason is that the - most common use case "{var}" does not capture the leading "/" character. - For consistency, all path variables must share the same behavior. - Repeated message fields must not be mapped to URL query parameters, - because no client library can support such complicated mapping. If an - API needs to use a JSON array for request or response body, it can map - the request or response body to a repeated field. However, some gRPC - Transcoding implementations may not support this feature. - CreateTenancyUnitRequest: - id: CreateTenancyUnitRequest + `Documentation` provides the information for describing a service. + Example: documentation: summary: > The Google Calendar API gives access + to most calendar features. pages: - name: Overview content: (== include + google/foo/overview.md ==) - name: Tutorial content: (== include + google/foo/tutorial.md ==) subpages: - name: Java content: (== include + google/foo/tutorial_java.md ==) rules: - selector: + google.calendar.Calendar.Get description: > ... - selector: + google.calendar.Calendar.Put description: > ... Documentation is + provided in markdown syntax. In addition to standard markdown features, + definition lists, tables and fenced code blocks are supported. Section + headers can be provided and are interpreted relative to the section + nesting of the context where a documentation fragment is embedded. + Documentation from the IDL is merged with documentation defined via the + config at normalization time, where documentation provided by config + rules overrides IDL provided. A number of constructs specific to the API + platform are supported in documentation text. In order to reference a + proto element, the following notation can be used: + [fully.qualified.proto.name][] To override the display text used for the + link, this can be used: [display text][fully.qualified.proto.name] Text + can be excluded from doc using the following notation: (-- internal + comment --) A few directives are available in documentation. Note that + directives must appear on a single line to be properly identified. The + `include` directive includes a markdown file from an external source: + (== include path/to/file ==) The `resource_for` directive marks a + message to be the resource of a collection in REST view. If it is not + specified, tools attempt to infer the resource from the operations in a + collection: (== resource_for v1.shelves.books ==) The directive + `suppress_warning` does not directly affect documentation and is + documented together with service config validation. + id: Documentation + Authentication: + properties: + rules: + type: array + description: >- + A list of authentication rules that apply to individual API methods. + **NOTE:** All service configuration rules follow "last one wins" + order. + items: + $ref: '#/components/schemas/AuthenticationRule' + providers: + description: Defines a set of authentication providers that a service supports. + type: array + items: + $ref: '#/components/schemas/AuthProvider' + id: Authentication + description: >- + `Authentication` defines the authentication configuration for API + methods provided by an API service. Example: name: + calendar.googleapis.com authentication: providers: - id: + google_calendar_auth jwks_uri: + https://www.googleapis.com/oauth2/v1/certs issuer: + https://securetoken.google.com rules: - selector: "*" requirements: + provider_id: google_calendar_auth - selector: google.calendar.Delegate + oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read type: object + UndeleteTenantProjectRequest: description: >- - Request to create a tenancy unit for a service consumer of a managed - service. + Request message to undelete tenant project resource previously deleted + from the tenancy unit. + type: object properties: - tenancyUnitId: - description: >- - Optional. Optional service producer-provided identifier of the - tenancy unit. Must be no longer than 40 characters and preferably - URI friendly. If it isn't provided, a UID for the tenancy unit is - automatically generated. The identifier must be unique across a - managed service. If the tenancy unit already exists for the managed - service and service consumer pair, calling `CreateTenancyUnit` - returns the existing tenancy unit if the provided identifier is - identical or empty, otherwise the call fails. + tag: + description: Required. Tag of the resource within the tenancy unit. type: string + id: UndeleteTenantProjectRequest CustomErrorRule: - type: object id: CustomErrorRule + type: object description: A custom error rule. properties: selector: @@ -769,1313 +710,1494 @@ components: Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload. - JavaSettings: - type: object - id: JavaSettings + UsageRule: properties: - serviceClassNames: - additionalProperties: - type: string - type: object + allowUnregisteredCalls: + type: boolean + description: ' Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity.' + skipServiceControl: description: >- - Configure the Java class name to use instead of the service's for - its corresponding generated GAPIC client. Keys are fully-qualified - service names as they appear in the protobuf (including the full the - language_settings.java.interface_names" field in gapic.yaml. API - teams should otherwise use the service name as it appears in the - protobuf. Example of a YAML configuration:: publishing: - java_settings: service_class_names: - google.pubsub.v1.Publisher: - TopicAdmin - google.pubsub.v1.Subscriber: SubscriptionAdmin - libraryPackage: + If true, the selected method should skip service control and the + control plane features, such as quota and billing, will not be + available. This flag is used by Google Cloud Endpoints to bypass + checks for internal methods, such as service health check methods. + type: boolean + selector: type: string description: >- - The package name to use in Java. Clobbers the java_package option - set in the protobuf. This should be used **only** by APIs who have - already set the language_settings.java.package_name" field in - gapic.yaml. API teams should use the protobuf java_package option - where possible. Example of a YAML configuration:: publishing: - java_settings: library_package: com.google.cloud.pubsub.v1 - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - description: Settings for Java client libraries. - V1DefaultIdentity: - description: A default identity in the Identity and Access Management API. + Selects the methods to which this rule applies. Use '*' to indicate + all methods in all APIs. Refer to selector for syntax details. type: object - id: V1DefaultIdentity + description: Usage configuration rules for the service. + id: UsageRule + V1Beta1BatchCreateProducerOverridesResponse: + description: Response message for BatchCreateProducerOverrides + type: object + id: V1Beta1BatchCreateProducerOverridesResponse properties: - email: + overrides: + items: + $ref: '#/components/schemas/V1Beta1QuotaOverride' + description: The overrides that were created. + type: array + CustomError: + description: >- + Customize service error responses. For example, list any service + specific protobuf types that can appear in error detail lists of error + responses. Example: custom_error: types: - google.foo.v1.CustomError - + google.foo.v1.AnotherError + properties: + rules: + items: + $ref: '#/components/schemas/CustomErrorRule' + type: array description: >- - The email address of the default identity. Calling - GenerateDefaultIdentity with a deleted or purged default identity - should expect does_not_exist@invalid-project.iam.gserviceaccount.com - placeholder email. + The list of custom error rules that apply to individual API + messages. **NOTE:** All service configuration rules follow "last one + wins" order. + types: + items: + type: string + description: >- + The list of custom error detail types, e.g. + 'google.foo.v1.CustomError'. + type: array + id: CustomError + type: object + LongRunning: + description: >- + Describes settings to use when generating API methods that use the + long-running operation pattern. All default values below are from those + used in the client library generators (e.g. + [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)). + id: LongRunning + properties: + totalPollTimeout: + description: 'Total polling timeout. Default value: 5 minutes.' + format: google-duration type: string - uniqueId: + maxPollDelay: type: string - description: The unique and stable id of the default identity. - tag: + description: >- + Maximum time between two subsequent poll requests. Default value: 45 + seconds. + format: google-duration + pollDelayMultiplier: + type: number + format: float + description: >- + Multiplier to gradually increase delay between subsequent polls + until it reaches max_poll_delay. Default value: 1.5. + initialPollDelay: + description: >- + Initial delay after which the first poll request will be made. + Default value: 5 seconds. + type: string + format: google-duration + type: object + V1Beta1ImportProducerQuotaPoliciesResponse: + properties: + policies: + type: array + description: The policies that were created from the imported data. + items: + $ref: '#/components/schemas/V1Beta1ProducerQuotaPolicy' + type: object + description: Response message for ImportProducerQuotaPolicies + id: V1Beta1ImportProducerQuotaPoliciesResponse + DocumentationRule: + id: DocumentationRule + type: object + description: A documentation rule provides information about individual API elements. + properties: + disableReplacementWords: type: string description: >- - The Default Identity tag. If specified when creating the account, - the tag must be present in activation_grants. If not specified when - creating the account, the tag is set to the tag specified in - activation_grants. - name: + String of comma or space separated case-sensitive words for which + method/field name replacement will be disabled. + description: + description: >- + Description of the selected proto element (e.g. a message, a method, + a 'service' definition, or a field). Defaults to leading & trailing + comments taken from the proto source definition of the proto + element. + type: string + selector: type: string description: >- - Default identity resource name. An example name would be: - `services/serviceconsumermanagement.googleapis.com/projects/123/defaultIdentity` - V1Beta1EnableConsumerResponse: + The selector is a comma-separated list of patterns for any element + such as a method, a field, an enum value. Each pattern is a + qualified name of the element which may end in "*", indicating a + wildcard. Wildcards are only allowed at the end and for a whole + component of the qualified name, i.e. "foo.*" is ok, but not + "foo.b*" or "foo.*.bar". A wildcard will match one or more + components. To specify a default for all applicable elements, the + whole pattern "*" is used. + deprecationDescription: + type: string + description: >- + Deprecation description of the selected element(s). It can be + provided if an element is marked as `deprecated`. + Usage: + description: Configuration controlling usage of a service. + properties: + rules: + items: + $ref: '#/components/schemas/UsageRule' + type: array + description: >- + A list of usage rules that apply to individual API methods. + **NOTE:** All service configuration rules follow "last one wins" + order. + producerNotificationChannel: + type: string + description: >- + The full resource name of a channel used for sending notifications + to the service producer. Google Service Management currently only + supports [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as + a notification channel. To use Google Cloud Pub/Sub as the channel, + this must be the name of a Cloud Pub/Sub topic that uses the Cloud + Pub/Sub topic name format documented in + https://cloud.google.com/pubsub/docs/overview. + requirements: + description: >- + Requirements that must be satisfied before a consumer project can + use the service. Each requirement is of the form /; for example + 'serviceusage.googleapis.com/billing-enabled'. For Google APIs, a + Terms of Service requirement must be included here. Google Cloud + APIs must include "serviceusage.googleapis.com/tos/cloud". Other + Google APIs should include + "serviceusage.googleapis.com/tos/universal". Additional ToS can be + included based on the business needs. + type: array + items: + type: string + id: Usage + type: object + V1DisableConsumerResponse: + id: V1DisableConsumerResponse + properties: {} type: object description: >- - Response message for the `EnableConsumer` method. This response message + Response message for the `DisableConsumer` method. This response message is assigned to the `response` field of the returned Operation when that operation is done. - id: V1Beta1EnableConsumerResponse - properties: {} - Empty: - description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } - properties: {} + MethodSettings: + id: MethodSettings type: object - id: Empty - SourceContext: - description: >- - `SourceContext` represents information about the source of a protobuf - element, like the file in which it is defined. properties: - fileName: + selector: description: >- - The path-qualified name of the .proto file that contained the - associated protobuf element. For example: - `"google/protobuf/source_context.proto"`. + The fully qualified name of the method, for which the options below + apply. This is used to find the method to apply the options. + Example: publishing: method_settings: - selector: + google.storage.control.v2.StorageControl.CreateFolder # method + settings for CreateFolder... type: string + longRunning: + description: >- + Describes settings to use for long-running operations when + generating API methods for RPCs. Complements RPCs that use the + annotations in google/longrunning/operations.proto. Example of a + YAML configuration:: publishing: method_settings: - selector: + google.cloud.speech.v2.Speech.BatchRecognize long_running: + initial_poll_delay: 60s # 1 minute poll_delay_multiplier: 1.5 + max_poll_delay: 360s # 6 minutes total_poll_timeout: 54000s # 90 + minutes + $ref: '#/components/schemas/LongRunning' + batching: + description: >- + Batching configuration for an API method in client libraries. + Example of a YAML configuration: publishing: method_settings: - + selector: google.example.v1.ExampleService.BatchCreateExample + batching: element_count_threshold: 1000 request_byte_threshold: + 100000000 delay_threshold_millis: 10 + $ref: '#/components/schemas/BatchingConfigProto' + autoPopulatedFields: + items: + type: string + description: >- + List of top-level fields of the request message, that should be + automatically populated by the client libraries based on their + (google.api.field_info).format. Currently supported format: UUID4. + Example of a YAML configuration: publishing: method_settings: - + selector: google.example.v1.ExampleService.CreateExample + auto_populated_fields: - request_id + type: array + description: Describes the generator configuration for a method. + V1Beta1ImportProducerOverridesResponse: + properties: + overrides: + items: + $ref: '#/components/schemas/V1Beta1QuotaOverride' + description: The overrides that were created from the imported data. + type: array type: object - id: SourceContext + description: Response message for ImportProducerOverrides + id: V1Beta1ImportProducerOverridesResponse V1RemoveVisibilityLabelsResponse: - id: V1RemoveVisibilityLabelsResponse description: >- Response message for the `RemoveVisibilityLabels` method. This response message is assigned to the `response` field of the returned Operation when that operation is done. - type: object properties: labels: items: type: string + type: array description: >- The updated set of visibility labels for this consumer on this service. - type: array - SystemParameter: + id: V1RemoveVisibilityLabelsResponse type: object - id: SystemParameter + AddTenantProjectRequest: properties: - httpHeader: - description: >- - Define the HTTP header name to use for the parameter. It is case - insensitive. - type: string - name: - type: string + tag: description: >- - Define the name of the parameter, such as "api_key" . It is case - sensitive. - urlQueryParameter: + Required. Tag of the added project. Must be less than 128 + characters. Required. type: string + projectConfig: description: >- - Define the URL query parameter name to use for the parameter. It is - case sensitive. + Configuration of the new tenant project to be added to tenancy unit + resources. + $ref: '#/components/schemas/TenantProjectConfig' description: >- - Define a parameter's name and location. The parameter may be passed as - either an HTTP header or a URL query parameter, and if both are passed - the behavior is implementation-dependent. - CustomHttpPattern: + Request to add a newly created and configured tenant project to a + tenancy unit. type: object + id: AddTenantProjectRequest + Method: properties: - kind: - description: The name of this custom HTTP verb. + options: + description: Any metadata attached to the method. + type: array + items: + $ref: '#/components/schemas/Option' + requestTypeUrl: type: string - path: + description: A URL of the input message type. + responseTypeUrl: type: string - description: The path matched by this custom verb. - description: A custom pattern is used for defining custom HTTP verb. - id: CustomHttpPattern - MetricRule: + description: The URL of the output message type. + name: + description: The simple name of this method. + type: string + responseStreaming: + type: boolean + description: If true, the response is streamed. + syntax: + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS + enumDescriptions: + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. + description: The source syntax of this method. + type: string + requestStreaming: + type: boolean + description: If true, the request is streamed. + description: Method represents a method of an API interface. + id: Method type: object - id: MetricRule - description: >- - Bind API methods to metrics. Binding a method to a metric causes that - metric's configured quota behaviors to apply to the method call. + SourceInfo: properties: - metricCosts: + sourceFiles: + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: array + description: All files used during config generation. + id: SourceInfo + type: object + description: Source information used to create a Service Config + BillingConfig: + properties: + billingAccount: description: >- - Metrics to update when the selected methods are called, and the - associated cost applied to each metric. The key of the map is the - metric name, and the values are the amount increased for the metric - against which the quota limits are defined. The value must not be - negative. - type: object - additionalProperties: - format: int64 - type: string - selector: + Name of the billing account. For example + `billingAccounts/012345-567890-ABCDEF`. type: string - description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. - V1RefreshConsumerResponse: - properties: {} - id: V1RefreshConsumerResponse + description: Describes the billing configuration for a new tenant project. + id: BillingConfig + type: object + V1EnableConsumerResponse: + id: V1EnableConsumerResponse description: >- - Response message for the `RefreshConsumer` method. This response message + Response message for the `EnableConsumer` method. This response message is assigned to the `response` field of the returned Operation when that operation is done. + properties: {} type: object - CommonLanguageSettings: - description: Required information for every language. - id: CommonLanguageSettings + MonitoringDestination: + description: >- + Configuration of a specific monitoring destination (the producer project + or the consumer project). properties: - destinations: - type: array + monitoredResource: + type: string description: >- - The destination where API teams want this client library to be - published. + The monitored resource type. The type must be defined in + Service.monitored_resources section. + metrics: items: - enumDescriptions: - - >- - Client libraries will neither be generated nor published to - package managers. - - >- - Generate the client library in a repo under - github.com/googleapis, but don't publish it to package managers. - - >- - Publish the library to package managers like nuget.org and - npmjs.com. type: string - enum: - - CLIENT_LIBRARY_DESTINATION_UNSPECIFIED - - GITHUB - - PACKAGE_MANAGER - referenceDocsUri: - type: string - deprecated: true - description: >- - Link to automatically generated reference documentation. Example: - https://cloud.google.com/nodejs/docs/reference/asset/latest - selectiveGapicGeneration: - $ref: '#/components/schemas/SelectiveGapicGeneration' + type: array description: >- - Configuration for which RPCs should be generated in the GAPIC - client. + Types of the metrics to report to this monitoring destination. Each + type must be defined in Service.metrics section. + type: object + id: MonitoringDestination + Service: type: object - V1Beta1QuotaOverride: - id: V1Beta1QuotaOverride - description: A quota override properties: - adminOverrideAncestor: + publishing: description: >- - The resource name of the ancestor that requested the override. For - example: "organizations/12345" or "folders/67890". Used by admin - overrides only. + Settings for [Google Cloud Client + libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) + generated from APIs defined as protocol buffers. + $ref: '#/components/schemas/Publishing' + context: + description: Context configuration. + $ref: '#/components/schemas/Context' + producerProjectId: + description: The Google project that owns this service. type: string - dimensions: - description: ' If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit''s unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota overrides that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map.' - additionalProperties: - type: string - type: object - unit: + types: description: >- - The limit unit of the limit to which this override applies. An - example unit would be: `1/{project}/{region}` Note that `{project}` - and `{region}` are not placeholders in this example; the literal - characters `{` and `}` occur in the string. - type: string - overrideValue: + A list of all proto message types included in this API service. + Types referenced directly or indirectly by the `apis` are + automatically included. Messages which are not referenced but shall + be included, such as types used by the `google.protobuf.Any` type, + should be listed here by name by the configuration author. Example: + types: - name: google.protobuf.Int32 + type: array + items: + $ref: '#/components/schemas/Type' + systemParameters: + description: System parameter configuration. + $ref: '#/components/schemas/SystemParameters' + id: description: >- - The overriding quota limit value. Can be any nonnegative integer, or - -1 (unlimited quota). - type: string - format: int64 - metric: + A unique ID for a specific instance of this message, typically + assigned by the client for tracking purpose. Must be no longer than + 63 characters and only lower case letters, digits, '.', '_' and '-' + are allowed. If empty, the server may choose to generate one + instead. type: string + endpoints: + items: + $ref: '#/components/schemas/Endpoint' + type: array description: >- - The name of the metric to which this override applies. An example - name would be: `compute.googleapis.com/cpus` - name: - type: string + Configuration for network endpoints. If this is empty, then an + endpoint with the same name as the service is automatically + generated to service all defined APIs. + billing: + description: Billing configuration. + $ref: '#/components/schemas/Billing' + http: + $ref: '#/components/schemas/Http' + description: HTTP configuration. + sourceInfo: description: >- - The resource name of the producer override. An example name would - be: - `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d` - type: object - PhpSettings: - id: PhpSettings - properties: - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - description: Settings for Php client libraries. - type: object - DocumentationRule: - properties: - selector: + Output only. The source information for this configuration if + available. + $ref: '#/components/schemas/SourceInfo' + aspects: + items: + $ref: '#/components/schemas/Aspect' description: >- - The selector is a comma-separated list of patterns for any element - such as a method, a field, an enum value. Each pattern is a - qualified name of the element which may end in "*", indicating a - wildcard. Wildcards are only allowed at the end and for a whole - component of the qualified name, i.e. "foo.*" is ok, but not - "foo.b*" or "foo.*.bar". A wildcard will match one or more - components. To specify a default for all applicable elements, the - whole pattern "*" is used. - type: string - disableReplacementWords: + Configuration aspects. This is a repeated field to allow multiple + aspects to be configured. The kind field in each ConfigAspect + specifies the type of aspect. The spec field contains the + configuration for that aspect. The schema for the spec field is + defined by the backend service owners. + type: array + configVersion: + type: integer description: >- - String of comma or space separated case-sensitive words for which - method/field name replacement will be disabled by go/api-docgen. - type: string - description: + Obsolete. Do not use. This field has no semantic meaning. The + service config compiler always sets this field to `3`. + format: uint32 + title: description: >- - Description of the selected proto element (e.g. a message, a method, - a 'service' definition, or a field). Defaults to leading & trailing - comments taken from the proto source definition of the proto - element. + The product title for this service, it is the name displayed in + Google Cloud Console. type: string - deprecationDescription: - description: >- - Deprecation description of the selected element(s). It can be - provided if an element is marked as `deprecated`. - type: string - description: A documentation rule provides information about individual API elements. - type: object - id: DocumentationRule - MetricDescriptor: - description: >- - Defines a metric type and its schema. Once a metric descriptor is - created, deleting or altering it stops data collection and makes the - metric type's existing data unusable. - id: MetricDescriptor - properties: - monitoredResourceTypes: - description: >- - Read-only. If present, then a time series, which is identified - partially by a metric type and a MonitoredResourceDescriptor, that - is associated with this metric type can only be associated with one - of the monitored resource types listed here. - type: array + metrics: + description: Defines the metrics used by this service. items: - type: string - type: + $ref: '#/components/schemas/MetricDescriptor' + type: array + monitoredResources: + type: array description: >- - The metric type, including its DNS name prefix. The type is not - URL-encoded. All user-defined metric types have the DNS name - `custom.googleapis.com` or `external.googleapis.com`. Metric types - should use a natural hierarchical grouping. For example: - "custom.googleapis.com/invoice/paid/amount" - "external.googleapis.com/prometheus/up" - "appengine.googleapis.com/http/server/response_latencies" - type: string - unit: + Defines the monitored resources used by this service. This is + required by the Service.monitoring and Service.logging + configurations. + items: + $ref: '#/components/schemas/MonitoredResourceDescriptor' + name: type: string description: >- - The units in which the metric value is reported. It is only - applicable if the `value_type` is `INT64`, `DOUBLE`, or - `DISTRIBUTION`. The `unit` defines the representation of the stored - metric values. Different systems might scale the values to be more - easily displayed (so a value of `0.02kBy` _might_ be displayed as - `20By`, and a value of `3523kBy` _might_ be displayed as `3.5MBy`). - However, if the `unit` is `kBy`, then the value of the metric is - always in thousands of bytes, no matter how it might be displayed. - If you want a custom metric to record the exact number of - CPU-seconds used by a job, you can create an `INT64 CUMULATIVE` - metric whose `unit` is `s{CPU}` (or equivalently `1s{CPU}` or just - `s`). If the job uses 12,005 CPU-seconds, then the value is written - as `12005`. Alternatively, if you want a custom metric to record - data in a more granular way, you can create a `DOUBLE CUMULATIVE` - metric whose `unit` is `ks{CPU}`, and then write the value `12.005` - (which is `12005/1000`), or use `Kis{CPU}` and write `11.723` (which - is `12005/1024`). The supported units are a subset of [The Unified - Code for Units of Measure](https://unitsofmeasure.org/ucum.html) - standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` - second * `min` minute * `h` hour * `d` day * `1` dimensionless - **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga - (10^9) * `T` tera (10^12) * `P` peta (10^15) * `E` exa (10^18) * `Z` - zetta (10^21) * `Y` yotta (10^24) * `m` milli (10^-3) * `u` micro - (10^-6) * `n` nano (10^-9) * `p` pico (10^-12) * `f` femto (10^-15) - * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto (10^-24) * `Ki` - kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) - * `Pi` pebi (2^50) **Grammar** The grammar also includes these - connectors: * `/` division or ratio (as an infix operator). For - examples, `kBy/{email}` or `MiBy/10ms` (although you should almost - never have `/s` in a metric `unit`; rates should always be computed - at query time from the underlying cumulative or delta value). * `.` - multiplication or composition (as an infix operator). For examples, - `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: - Expression = Component { "." Component } { "/" Component } ; - Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | - "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a - comment if it follows a `UNIT`. If the annotation is used alone, - then the unit is equivalent to `1`. For examples, `{request}/s == - 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of - non-blank printable ASCII characters not containing `{` or `}`. * - `1` represents a unitary [dimensionless - unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, - such as in `1/s`. It is typically used when none of the basic units - are appropriate. For example, "new users per day" can be represented - as `1/d` or `{new-users}/d` (and a metric value `5` would mean "5 - new users). Alternatively, "thousands of page views per day" would - be represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a - metric value of `5.3` would mean "5300 page views per day"). * `%` - represents dimensionless value of 1/100, and annotates values giving - a percentage (so the metric values are typically in the range of - 0..100, and a metric value `3` means "3 percent"). * `10^2.%` - indicates a metric contains a ratio, typically in the range 0..1, - that will be multiplied by 100 and displayed as a percentage (so a - metric value `0.03` means "3 percent"). - labels: + The service name, which is a DNS-like logical identifier for the + service, such as `calendar.googleapis.com`. The service name + typically goes through DNS verification to make sure the owner of + the service also owns the DNS name. + customError: + $ref: '#/components/schemas/CustomError' + description: Custom error configuration. + monitoring: + description: Monitoring configuration. + $ref: '#/components/schemas/Monitoring' + usage: + $ref: '#/components/schemas/Usage' + description: Configuration controlling usage of this service. + documentation: + description: Additional API documentation. + $ref: '#/components/schemas/Documentation' + systemTypes: items: - $ref: '#/components/schemas/LabelDescriptor' + $ref: '#/components/schemas/Type' + type: array description: >- - The set of labels that can be used to describe a specific instance - of this metric type. For example, the - `appengine.googleapis.com/http/server/response_latencies` metric - type has a label for the HTTP response code, `response_code`, so you - can look at latencies for successful responses or just for responses - that failed. + A list of all proto message types included in this API service. It + serves similar purpose as [google.api.Service.types], except that + these types are not needed by user-defined APIs. Therefore, they + will not show up in the generated discovery doc. This field should + only be used to define system APIs in ESF. + control: + $ref: '#/components/schemas/Control' + description: Configuration for the service control plane. + authentication: + description: Auth configuration. + $ref: '#/components/schemas/Authentication' + logging: + $ref: '#/components/schemas/Logging' + description: Logging configuration. + backend: + description: API backend configuration. + $ref: '#/components/schemas/Backend' + enums: + items: + $ref: '#/components/schemas/Enum' type: array - valueType: - type: string - enum: - - VALUE_TYPE_UNSPECIFIED - - BOOL - - INT64 - - DOUBLE - - STRING - - DISTRIBUTION - - MONEY - enumDescriptions: - - Do not use this default value. - - >- - The value is a boolean. This value type can be used only if the - metric kind is `GAUGE`. - - The value is a signed 64-bit integer. - - The value is a double precision floating point number. - - >- - The value is a text string. This value type can be used only if - the metric kind is `GAUGE`. - - The value is a `Distribution`. - - The value is money. description: >- - Whether the measurement is an integer, a floating-point number, etc. - Some combinations of `metric_kind` and `value_type` might not be - supported. - description: + A list of all enum types included in this API service. Enums + referenced directly or indirectly by the `apis` are automatically + included. Enums which are not referenced but shall be included + should be listed here by name by the configuration author. Example: + enums: - name: google.someapi.v1.SomeEnum + apis: description: >- - A detailed description of the metric, which can be used in - documentation. + A list of API interfaces exported by this service. Only the `name` + field of the google.protobuf.Api needs to be provided by the + configuration author, as the remaining fields will be derived from + the IDL during the normalization process. It is an error to specify + an API interface here which cannot be resolved against the + associated IDL files. + type: array + items: + $ref: '#/components/schemas/Api' + logs: + items: + $ref: '#/components/schemas/LogDescriptor' + description: Defines the logs used by this service. + type: array + quota: + description: Quota configuration. + $ref: '#/components/schemas/Quota' + id: Service + description: >- + `Service` is the root object of Google API service configuration + (service config). It describes the basic information about a logical + service, such as the service name and the user-facing title, and + delegates other aspects to sub-sections. Each sub-section is either a + proto message or a repeated proto message that configures a specific + aspect, such as auth. For more information, see each proto message + definition. Example: type: google.api.Service name: + calendar.googleapis.com title: Google Calendar API apis: - name: + google.calendar.v3.Calendar visibility: rules: - selector: + "google.calendar.v3.*" restriction: PREVIEW backend: rules: - selector: + "google.calendar.v3.*" address: calendar.example.com authentication: + providers: - id: google_calendar_auth jwks_uri: + https://www.googleapis.com/oauth2/v1/certs issuer: + https://securetoken.google.com rules: - selector: "*" requirements: + provider_id: google_calendar_auth + SystemParameter: + type: object + description: >- + Define a parameter's name and location. The parameter may be passed as + either an HTTP header or a URL query parameter, and if both are passed + the behavior is implementation-dependent. + properties: + urlQueryParameter: + description: >- + Define the URL query parameter name to use for the parameter. It is + case sensitive. type: string name: - description: The resource name of the metric descriptor. type: string - metadata: - $ref: '#/components/schemas/MetricDescriptorMetadata' - description: Optional. Metadata which can be used to guide usage of the metric. - displayName: description: >- - A concise name for the metric, which can be displayed in user - interfaces. Use sentence case without an ending period, for example - "Request count". This field is optional but it is recommended to be - set for any metrics associated with user-visible concepts, such as - Quota. - type: string - launchStage: - enumDescriptions: - - Do not use this default value. - - The feature is not yet implemented. Users can not use it. - - >- - Prelaunch features are hidden from users and are only visible - internally. - - >- - Early Access features are limited to a closed group of testers. To - use these features, you must sign up in advance and sign a Trusted - Tester agreement (which includes confidentiality provisions). - These features may be unstable, changed in backward-incompatible - ways, and are not guaranteed to be released. - - >- - Alpha is a limited availability test for releases before they are - cleared for widespread use. By Alpha, all significant design - issues are resolved and we are in the process of verifying - functionality. Alpha customers need to apply for access, agree to - applicable terms, and have their projects allowlisted. Alpha - releases don't have to be feature complete, no SLAs are provided, - and there are no technical support obligations, but they will be - far enough along that customers can actually use them in test - environments or for limited-use tests -- just like they would in - normal production cases. - - >- - Beta is the point at which we are ready to open a release for any - customer to use. There are no SLA or technical support obligations - in a Beta release. Products will be complete from a feature - perspective, but may have some open outstanding issues. Beta - releases are suitable for limited production use cases. - - >- - GA features are open to all developers and are considered stable - and fully qualified for production use. - - >- - Deprecated features are scheduled to be shut down and removed. For - more information, see the "Deprecation Policy" section of our - [Terms of Service](https://cloud.google.com/terms/) and the - [Google Cloud Platform Subject to the Deprecation - Policy](https://cloud.google.com/terms/deprecation) documentation. - type: string - enum: - - LAUNCH_STAGE_UNSPECIFIED - - UNIMPLEMENTED - - PRELAUNCH - - EARLY_ACCESS - - ALPHA - - BETA - - GA - - DEPRECATED - description: Optional. The launch stage of the metric definition. - metricKind: + Define the name of the parameter, such as "api_key" . It is case + sensitive. + httpHeader: type: string - enum: - - METRIC_KIND_UNSPECIFIED - - GAUGE - - DELTA - - CUMULATIVE description: >- - Whether the metric records instantaneous values, changes to a value, - etc. Some combinations of `metric_kind` and `value_type` might not - be supported. - enumDescriptions: - - Do not use this default value. - - An instantaneous measurement of a value. - - The change in a value during a time interval. - - >- - A value accumulated over a time interval. Cumulative measurements - in a time series should have the same start time and increasing - end times, until an event resets the cumulative value to zero and - sets a new start time for the following points. + Define the HTTP header name to use for the parameter. It is case + insensitive. + id: SystemParameter + V1Beta1EnableConsumerResponse: + id: V1Beta1EnableConsumerResponse type: object - V1Beta1ServiceIdentity: + description: >- + Response message for the `EnableConsumer` method. This response message + is assigned to the `response` field of the returned Operation when that + operation is done. + properties: {} + Control: properties: - email: - type: string - description: The email address of the service identity. - uniqueId: - description: The unique and stable id of the service identity. - type: string - name: + methodPolicies: + type: array + description: Defines policies applying to the API methods of the service. + items: + $ref: '#/components/schemas/MethodPolicy' + environment: type: string description: >- - P4 service identity resource name. An example name would be: - `services/serviceconsumermanagement.googleapis.com/projects/123/serviceIdentities/default` - tag: - description: >- - The P4 service identity configuration tag. This must be defined in - activation_grants. If not specified when creating the account, the - tag is set to "default". - type: string - id: V1Beta1ServiceIdentity + The service controller environment to use. If empty, no control + plane feature (like quota and billing) will be enabled. The + recommended value for most services is servicecontrol.googleapis.com + description: >- + Selects and configures the service controller used by the service. + Example: control: environment: servicecontrol.googleapis.com + id: Control type: object - description: A service identity in the Identity and Access Management API. - UndeleteTenantProjectRequest: + SourceContext: + id: SourceContext type: object - properties: - tag: - type: string - description: Required. Tag of the resource within the tenancy unit. description: >- - Request message to undelete tenant project resource previously deleted - from the tenancy unit. - id: UndeleteTenantProjectRequest - ListOperationsResponse: - id: ListOperationsResponse - type: object + `SourceContext` represents information about the source of a protobuf + element, like the file in which it is defined. properties: - nextPageToken: - type: string - description: The standard List next-page token. - operations: - items: - $ref: '#/components/schemas/Operation' - type: array + fileName: description: >- - A list of operations that matches the specified filter in the - request. - description: The response message for Operations.ListOperations. - Publishing: + The path-qualified name of the .proto file that contained the + associated protobuf element. For example: + `"google/protobuf/source_context.proto"`. + type: string + HttpRule: type: object + id: HttpRule description: >- - This message configures the settings for publishing [Google Cloud Client - libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) - generated from the service config. - id: Publishing + gRPC Transcoding gRPC Transcoding is a feature for mapping between a + gRPC method and one or more HTTP REST endpoints. It allows developers to + build a single API service that supports both gRPC APIs and REST APIs. + Many systems, including [Google + APIs](https://github.com/googleapis/googleapis), [Cloud + Endpoints](https://cloud.google.com/endpoints), [gRPC + Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and + [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature + and use it for large scale production services. `HttpRule` defines the + schema of the gRPC/REST mapping. The mapping specifies how different + portions of the gRPC request message are mapped to the URL path, URL + query parameters, and HTTP request body. It also controls how the gRPC + response message is mapped to the HTTP response body. `HttpRule` is + typically specified as an `google.api.http` annotation on the gRPC + method. Each mapping specifies a URL path template and an HTTP method. + The path template may refer to one or more fields in the gRPC request + message, as long as each field is a non-repeated field with a primitive + (non-message) type. The path template controls how fields of the request + message are mapped to the URL path. Example: service Messaging { rpc + GetMessage(GetMessageRequest) returns (Message) { option + (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message + GetMessageRequest { string name = 1; // Mapped to URL path. } message + Message { string text = 1; // The resource content. } This enables an + HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - + gRPC: `GetMessage(name: "messages/123456")` Any fields in the request + message which are not bound by the path template automatically become + HTTP query parameters if there is no HTTP request body. For example: + service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) + { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } + message GetMessageRequest { message SubMessage { string subfield = 1; } + string message_id = 1; // Mapped to URL path. int64 revision = 2; // + Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped + to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC + mapping as below: - HTTP: `GET + /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: + `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: + "foo"))` Note that fields which are mapped to URL query parameters must + have a primitive type or a repeated primitive type or a non-repeated + message type. In the case of a repeated type, the parameter can be + repeated in the URL as `...?param=A¶m=B`. In the case of a message + type, each field of the message is mapped to a separate parameter, such + as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request + body, the `body` field specifies the mapping. Consider a REST update + method on the message resource collection: service Messaging { rpc + UpdateMessage(UpdateMessageRequest) returns (Message) { option + (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" + }; } } message UpdateMessageRequest { string message_id = 1; // mapped + to the URL Message message = 2; // mapped to the body } The following + HTTP JSON to RPC mapping is enabled, where the representation of the + JSON in the request body is determined by protos JSON encoding: - HTTP: + `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: + `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The + special name `*` can be used in the body mapping to define that every + field not bound by the path template should be mapped to the request + body. This enables the following alternative definition of the update + method: service Messaging { rpc UpdateMessage(Message) returns (Message) + { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: + "*" }; } } message Message { string message_id = 1; string text = 2; } + The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH + /v1/messages/123456 { "text": "Hi!" }` - gRPC: + `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using + `*` in the body mapping, it is not possible to have HTTP parameters, as + all fields not bound by the path end in the body. This makes this option + more rarely used in practice when defining REST APIs. The common usage + of `*` is in custom methods which don't use the URL at all for + transferring data. It is possible to define multiple HTTP methods for + one RPC by using the `additional_bindings` option. Example: service + Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option + (google.api.http) = { get: "/v1/messages/{message_id}" + additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } + }; } } message GetMessageRequest { string message_id = 1; string user_id + = 2; } This enables the following two alternative HTTP JSON to RPC + mappings: - HTTP: `GET /v1/messages/123456` - gRPC: + `GetMessage(message_id: "123456")` - HTTP: `GET + /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" + message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields + (recursive expansion nested messages in the request message) are + classified into three categories: - Fields referred by the path + template. They are passed via the URL path. - Fields referred by the + HttpRule.body. They are passed via the HTTP request body. - All other + fields are passed via the URL query parameters, and the parameter name + is the field path in the request message. A repeated field can be + represented as multiple query parameters under the same name. 2. If + HttpRule.body is "*", there is no URL query parameter, all fields are + passed via URL path and HTTP request body. 3. If HttpRule.body is + omitted, there is no HTTP request body, all fields are passed via URL + path and URL query parameters. Path template syntax Template = "/" + Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | + "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] + "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax + `*` matches a single URL path segment. The syntax `**` matches zero or + more URL path segments, which must be the last part of the URL path + except the `Verb`. The syntax `Variable` matches part of the URL path as + specified by its template. A variable template must not contain other + variables. If a variable matches a single path segment, its template may + be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax + `LITERAL` matches literal text in the URL path. If the `LITERAL` + contains any reserved character, such characters should be + percent-encoded before the matching. If a variable contains exactly one + path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is + expanded into a URL path on the client side, all characters except + `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse + decoding. Such variables show up in the [Discovery + Document](https://developers.google.com/discovery/v1/reference/apis) as + `{var}`. If a variable contains multiple path segments, such as + `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a + URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` + are percent-encoded. The server side does the reverse decoding, except + "%2F" and "%2f" are left unchanged. Such variables show up in the + [Discovery + Document](https://developers.google.com/discovery/v1/reference/apis) as + `{+var}`. Using gRPC API Service Configuration gRPC API Service + Configuration (service config) is a configuration language for + configuring a gRPC service to become a user-facing product. The service + config is simply the YAML representation of the `google.api.Service` + proto message. As an alternative to annotating your proto file, you can + configure gRPC transcoding in your service config YAML files. You do + this by specifying a `HttpRule` that maps the gRPC method to a REST + endpoint, achieving the same effect as the proto annotation. This can be + particularly useful if you have a proto that is reused in multiple + services. Note that any transcoding specified in the service config will + override any matching transcoding configuration in the proto. The + following example selects a gRPC method and applies an `HttpRule` to it: + http: rules: - selector: example.v1.Messaging.GetMessage get: + /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC + Transcoding is used to map a gRPC to JSON REST endpoints, the proto to + JSON conversion must follow the [proto3 + specification](https://developers.google.com/protocol-buffers/docs/proto3#json). + While the single segment variable follows the semantics of [RFC + 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String + Expansion, the multi segment variable **does not** follow RFC 6570 + Section 3.2.3 Reserved Expansion. The reason is that the Reserved + Expansion does not expand special characters like `?` and `#`, which + would lead to invalid URLs. As the result, gRPC Transcoding uses a + custom encoding for multi segment variables. The path variables **must + not** refer to any repeated or mapped field, because client libraries + are not capable of handling such variable expansion. The path variables + **must not** capture the leading "/" character. The reason is that the + most common use case "{var}" does not capture the leading "/" character. + For consistency, all path variables must share the same behavior. + Repeated message fields must not be mapped to URL query parameters, + because no client library can support such complicated mapping. If an + API needs to use a JSON array for request or response body, it can map + the request or response body to a repeated field. However, some gRPC + Transcoding implementations may not support this feature. properties: - restReferenceDocumentationUri: + post: type: string description: >- - Optional link to REST reference documentation. Example: - https://cloud.google.com/pubsub/lite/docs/reference/rest - documentationUri: + Maps to HTTP POST. Used for creating a resource or performing an + action. + body: type: string description: >- - Link to product home page. Example: - https://cloud.google.com/asset-inventory/docs/overview - organization: - enumDescriptions: - - Not useful. - - Google Cloud Platform Org. - - Ads (Advertising) Org. - - Photos Org. - - Street View Org. - - Shopping Org. - - Geo Org. - - Generative AI - https://developers.generativeai.google - description: For whom the client library is being published. - type: string - enum: - - CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED - - CLOUD - - ADS - - PHOTOS - - STREET_VIEW - - SHOPPING - - GEO - - GENERATIVE_AI - apiShortName: + The name of the request field whose value is mapped to the HTTP + request body, or `*` for mapping all request fields not captured by + the path pattern to the HTTP body, or omitted for not having any + HTTP request body. NOTE: the referred field must be present at the + top-level of the request message type. + get: type: string description: >- - Used as a tracking tag when collecting data about the APIs developer - relations artifacts like docs, packages delivered to package - managers, etc. Example: "speech". - librarySettings: - description: >- - Client library settings. If the same version string appears multiple - times in this list, then the last one wins. Settings from earlier - settings with the same version string are discarded. + Maps to HTTP GET. Used for listing and getting information about + resources. + additionalBindings: items: - $ref: '#/components/schemas/ClientLibrarySettings' - type: array - protoReferenceDocumentationUri: - description: >- - Optional link to proto reference documentation. Example: - https://cloud.google.com/pubsub/lite/docs/reference/rpc - type: string - codeownerGithubTeams: + $ref: '#/components/schemas/HttpRule' description: >- - GitHub teams to be added to CODEOWNERS in the directory in GitHub - containing source code for the client libraries for this API. - items: - type: string + Additional HTTP bindings for the selector. Nested bindings must not + contain an `additional_bindings` field themselves (that is, the + nesting may only be one level deep). type: array - newIssueUri: - description: >- - Link to a *public* URI where users can report issues. Example: - https://issuetracker.google.com/issues/new?component=190865&template=1161103 + patch: + description: Maps to HTTP PATCH. Used for updating a resource. type: string - docTagPrefix: + selector: description: >- - A prefix used in sample code when demarking regions to be included - in documentation. + Selects a method to which this rule applies. Refer to selector for + syntax details. + type: string + responseBody: type: string - methodSettings: - type: array description: >- - A list of API method settings, e.g. the behavior for methods that - use the long-running operation pattern. - items: - $ref: '#/components/schemas/MethodSettings' - githubLabel: + Optional. The name of the response field whose value is mapped to + the HTTP response body. When omitted, the entire response message + will be used as the HTTP response body. NOTE: The referred field + must be present at the top-level of the response message type. + put: + type: string + description: Maps to HTTP PUT. Used for replacing a resource. + delete: + description: Maps to HTTP DELETE. Used for deleting a resource. type: string + custom: description: >- - GitHub label to apply to issues and pull requests opened for this - API. + The custom pattern is used for specifying an HTTP method that is not + included in the `pattern` field, such as HEAD, or "*" to leave the + HTTP method unspecified for this rule. The wild-card rule is useful + for services that provide content to Web (HTML) clients. + $ref: '#/components/schemas/CustomHttpPattern' Context: - description: >- - `Context` defines which contexts an API requests. Example: context: - rules: - selector: "*" requested: - google.rpc.context.ProjectContext - - google.rpc.context.OriginContext The above specifies that all methods in - the API request `google.rpc.context.ProjectContext` and - `google.rpc.context.OriginContext`. Available context types are defined - in package `google.rpc.context`. This also provides mechanism to - allowlist any protobuf message extension that can be sent in grpc - metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For - example, list any service specific protobuf types that can appear in - grpc metadata as follows in your yaml file: Example: context: rules: - - selector: "google.example.library.v1.LibraryService.CreateBook" - allowed_request_extensions: - google.foo.v1.NewExtension - allowed_response_extensions: - google.foo.v1.NewExtension You can also - specify extension ID instead of fully qualified extension name here. - id: Context - type: object properties: rules: description: >- A list of RPC context rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. - items: - $ref: '#/components/schemas/ContextRule' type: array - BillingDestination: - description: >- - Configuration of a specific billing destination (Currently only support - bill against consumer project). - properties: - monitoredResource: - description: >- - The monitored resource type. The type must be defined in - Service.monitored_resources section. - type: string - metrics: items: - type: string - description: >- - Names of the metrics to report to this billing destination. Each - name must be defined in Service.metrics section. - type: array - type: object - id: BillingDestination - QuotaLimit: + $ref: '#/components/schemas/ContextRule' description: >- - `QuotaLimit` defines a specific limit that applies over a specified - duration for a limit type. There can be at most one limit for a duration - and limit type combination defined within a `QuotaGroup`. - type: object - properties: - unit: - type: string - description: >- - Specify the unit of the quota limit. It uses the same syntax as - Metric.unit. The supported unit kinds are determined by the quota - backend system. Here are some examples: * "1/min/{project}" for - quota per minute per project. Note: the order of unit components is - insignificant. The "1" at the beginning is required to follow the - metric unit syntax. - displayName: - type: string - description: >- - User-visible display name for this limit. Optional. If not set, the - UI will provide a default display name based on the quota - configuration. This field can be used to override the default - display name generated from the configuration. - values: - type: object - description: >- - Tiered limit values. You must specify this as a key:value pair, with - an integer value that is the maximum number of requests allowed for - the specified unit. Currently only STANDARD is supported. - additionalProperties: - format: int64 - type: string - duration: - type: string - description: >- - Duration of this limit in textual notation. Must be "100s" or "1d". - Used by group-based quotas only. - defaultLimit: - format: int64 - type: string - description: >- - Default number of tokens that can be consumed during the specified - duration. This is the number of tokens assigned when a client - application developer activates the service for his/her project. - Specifying a value of 0 will block all requests. This can be used if - you are provisioning quota to selected consumers and blocking - others. Similarly, a value of -1 will indicate an unlimited quota. - No other negative values are allowed. Used by group-based quotas - only. - metric: - description: >- - The name of the metric this quota limit applies to. The quota limits - with the same metric will be checked together during runtime. The - metric must be defined within the service config. - type: string - description: - type: string - description: >- - Optional. User-visible, extended description for this quota limit. - Should be used only when more context is needed to understand this - limit than provided by the limit's display name (see: - `display_name`). - name: - type: string - description: >- - Name of the quota limit. The name must be provided, and it must be - unique within the service. The name can only include alphanumeric - characters as well as '-'. The maximum length of the limit name is - 64 characters. - maxLimit: - type: string - format: int64 - description: >- - Maximum number of tokens that can be consumed during the specified - duration. Client application developers can override the default - limit up to this maximum. If specified, this value cannot be set to - a value less than the default limit. If not specified, it is set to - the default limit. To allow clients to apply overrides with no upper - bound, set this to -1, indicating unlimited maximum quota. Used by - group-based quotas only. - freeTier: - format: int64 - description: >- - Free tier value displayed in the Developers Console for this limit. - The free tier is the number of tokens that will be subtracted from - the billed amount when billing is enabled. This field can only be - set on a limit with duration "1d", in a billable group; it is - invalid on any other limit. If this field is not set, it defaults to - 0, indicating that there is no free tier for this service. Used by - group-based quotas only. - type: string - id: QuotaLimit - UsageRule: + `Context` defines which contexts an API requests. Example: context: + rules: - selector: "*" requested: - google.rpc.context.ProjectContext - + google.rpc.context.OriginContext The above specifies that all methods in + the API request `google.rpc.context.ProjectContext` and + `google.rpc.context.OriginContext`. Available context types are defined + in package `google.rpc.context`. This also provides mechanism to + allowlist any protobuf message extension that can be sent in grpc + metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For + example, list any service specific protobuf types that can appear in + grpc metadata as follows in your yaml file: Example: context: rules: - + selector: "google.example.library.v1.LibraryService.CreateBook" + allowed_request_extensions: - google.foo.v1.NewExtension + allowed_response_extensions: - google.foo.v1.NewExtension You can also + specify extension ID instead of fully qualified extension name here. + type: object + id: Context + AuthProvider: properties: - allowUnregisteredCalls: - type: boolean + issuer: description: >- - If true, the selected method allows unregistered calls, e.g. calls - that don't identify any user or application. - selector: + Identifies the principal that issued the JWT. See + https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 + Usually a URL or an email address. Example: + https://securetoken.google.com Example: + 1234567-compute@developer.gserviceaccount.com type: string + jwksUri: description: >- - Selects the methods to which this rule applies. Use '*' to indicate - all methods in all APIs. Refer to selector for syntax details. - skipServiceControl: - type: boolean - description: >- - If true, the selected method should skip service control and the - control plane features, such as quota and billing, will not be - available. This flag is used by Google Cloud Endpoints to bypass - checks for internal methods, such as service health check methods. - description: >- - Usage configuration rules for the service. NOTE: Under development. Use - this rule to configure unregistered calls for the service. Unregistered - calls are calls that do not contain consumer project identity. (Example: - calls that do not contain an API key). By default, API methods do not - allow unregistered calls, and each method call must be identified by a - consumer project identity. Use this rule to allow/disallow unregistered - calls. Example of an API that wants to allow unregistered calls for - entire service. usage: rules: - selector: "*" allow_unregistered_calls: - true Example of a method that wants to allow unregistered calls. usage: - rules: - selector: "google.example.library.v1.LibraryService.CreateBook" - allow_unregistered_calls: true - id: UsageRule - type: object - CustomError: - type: object - properties: - rules: - items: - $ref: '#/components/schemas/CustomErrorRule' + URL of the provider's public key set to validate signature of the + JWT. See [OpenID + Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). + Optional if the key set document: - can be retrieved from [OpenID + Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html) + of the issuer. - can be inferred from the email domain of the issuer + (e.g. a Google service account). Example: + https://www.googleapis.com/oauth2/v1/certs + type: string + audiences: + type: string description: >- - The list of custom error rules that apply to individual API - messages. **NOTE:** All service configuration rules follow "last one - wins" order. - type: array - types: + The list of JWT + [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). + that are allowed to access. A JWT containing any of these audiences + will be accepted. When this setting is absent, JWTs with audiences: + - "https://[service.name]/[google.protobuf.Api.name]" - + "https://[service.name]/" will be accepted. For example, if no + audiences are in the setting, LibraryService API will accept JWTs + with the following audiences: - + https://library-example.googleapis.com/google.example.library.v1.LibraryService + - https://library-example.googleapis.com/ Example: audiences: + bookstore_android.apps.googleusercontent.com, + bookstore_web.apps.googleusercontent.com + jwtLocations: items: - type: string + $ref: '#/components/schemas/JwtLocation' type: array description: >- - The list of custom error detail types, e.g. - 'google.foo.v1.CustomError'. + Defines the locations to extract the JWT. For now it is only used by + the Cloud Endpoints to store the OpenAPI extension + [x-google-jwt-locations] + (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) + JWT locations can be one of HTTP headers, URL query parameters or + cookies. The rule is that the first match wins. If not specified, + default to use following 3 locations: 1) Authorization: Bearer 2) + x-goog-iap-jwt-assertion 3) access_token query parameter Default + locations can be specified as followings: jwt_locations: - header: + Authorization value_prefix: "Bearer " - header: + x-goog-iap-jwt-assertion - query: access_token + id: + description: >- + The unique identifier of the auth provider. It will be referred to + by `AuthRequirement.provider_id`. Example: "bookstore_auth". + type: string + authorizationUrl: + type: string + description: >- + Redirect URL if JWT token is required but not present or is expired. + Implement authorizationUrl of securityDefinitions in OpenAPI spec. + id: AuthProvider description: >- - Customize service error responses. For example, list any service - specific protobuf types that can appear in error detail lists of error - responses. Example: custom_error: types: - google.foo.v1.CustomError - - google.foo.v1.AnotherError - id: CustomError - MethodPolicy: + Configuration for an authentication provider, including support for + [JSON Web Token + (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). type: object - description: Defines policies applying to an RPC method. + CreateTenancyUnitRequest: properties: - selector: + tenancyUnitId: type: string description: >- - Selects a method to which these policies should be enforced, for - example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to - selector for syntax details. NOTE: This field must not be set in the - proto annotation. It will be automatically filled by the service - config compiler . - requestPolicies: - items: - $ref: '#/components/schemas/FieldPolicy' - type: array - description: Policies that are applicable to the request message. - id: MethodPolicy - Service: + Optional. Optional service producer-provided identifier of the + tenancy unit. Must be no longer than 40 characters and preferably + URI friendly. If it isn't provided, a UID for the tenancy unit is + automatically generated. The identifier must be unique across a + managed service. If the tenancy unit already exists for the managed + service and service consumer pair, calling `CreateTenancyUnit` + returns the existing tenancy unit if the provided identifier is + identical or empty, otherwise the call fails. type: object - id: Service + id: CreateTenancyUnitRequest description: >- - `Service` is the root object of Google API service configuration - (service config). It describes the basic information about a logical - service, such as the service name and the user-facing title, and - delegates other aspects to sub-sections. Each sub-section is either a - proto message or a repeated proto message that configures a specific - aspect, such as auth. For more information, see each proto message - definition. Example: type: google.api.Service name: - calendar.googleapis.com title: Google Calendar API apis: - name: - google.calendar.v3.Calendar visibility: rules: - selector: - "google.calendar.v3.*" restriction: PREVIEW backend: rules: - selector: - "google.calendar.v3.*" address: calendar.example.com authentication: - providers: - id: google_calendar_auth jwks_uri: - https://www.googleapis.com/oauth2/v1/certs issuer: - https://securetoken.google.com rules: - selector: "*" requirements: - provider_id: google_calendar_auth + Request to create a tenancy unit for a service consumer of a managed + service. + PolicyBinding: + id: PolicyBinding + type: object + description: Translates to IAM Policy bindings (without auditing at this level) properties: - documentation: - description: Additional API documentation. - $ref: '#/components/schemas/Documentation' - monitoredResources: - type: array - description: >- - Defines the monitored resources used by this service. This is - required by the Service.monitoring and Service.logging - configurations. - items: - $ref: '#/components/schemas/MonitoredResourceDescriptor' - sourceInfo: - $ref: '#/components/schemas/SourceInfo' + role: + type: string description: >- - Output only. The source information for this configuration if - available. - systemTypes: + Role. (https://cloud.google.com/iam/docs/understanding-roles) For + example, `roles/viewer`, `roles/editor`, or `roles/owner`. + members: type: array - description: >- - A list of all proto message types included in this API service. It - serves similar purpose as [google.api.Service.types], except that - these types are not needed by user-defined APIs. Therefore, they - will not show up in the generated discovery doc. This field should - only be used to define system APIs in ESF. - items: - $ref: '#/components/schemas/Type' - types: items: - $ref: '#/components/schemas/Type' - type: array + type: string description: >- - A list of all proto message types included in this API service. - Types referenced directly or indirectly by the `apis` are - automatically included. Messages which are not referenced but shall - be included, such as types used by the `google.protobuf.Any` type, - should be listed here by name by the configuration author. Example: - types: - name: google.protobuf.Int32 - billing: - $ref: '#/components/schemas/Billing' - description: Billing configuration. - control: - $ref: '#/components/schemas/Control' - description: Configuration for the service control plane. - endpoints: + Uses the same format as in IAM policy. `member` must include both a + prefix and ID. For example, `user:{emailId}`, + `serviceAccount:{emailId}`, `group:{emailId}`. + Type: + id: Type + properties: + fields: + items: + $ref: '#/components/schemas/Field' type: array - description: >- - Configuration for network endpoints. If this is empty, then an - endpoint with the same name as the service is automatically - generated to service all defined APIs. + description: The list of fields. + options: + description: The protocol buffer options. items: - $ref: '#/components/schemas/Endpoint' - configVersion: - description: >- - Obsolete. Do not use. This field has no semantic meaning. The - service config compiler always sets this field to `3`. - format: uint32 - type: integer - authentication: - description: Auth configuration. - $ref: '#/components/schemas/Authentication' - title: + $ref: '#/components/schemas/Option' + type: array + name: + type: string + description: The fully qualified message name. + syntax: + enumDescriptions: + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS + description: The source syntax. + type: string + edition: type: string description: >- - The product title for this service, it is the name displayed in - Google Cloud Console. - logging: - description: Logging configuration. - $ref: '#/components/schemas/Logging' + The source edition string, only valid when syntax is + SYNTAX_EDITIONS. + oneofs: + items: + type: string + type: array + description: The list of types appearing in `oneof` definitions in this type. + sourceContext: + description: The source context. + $ref: '#/components/schemas/SourceContext' + description: A protocol buffer message type. + type: object + BatchingConfigProto: + id: BatchingConfigProto + description: >- + `BatchingConfigProto` defines the batching configuration for an API + method. + type: object + properties: + thresholds: + description: The thresholds which trigger a batched request to be sent. + $ref: '#/components/schemas/BatchingSettingsProto' + batchDescriptor: + $ref: '#/components/schemas/BatchingDescriptorProto' + description: The request and response fields used in batching. + V1DefaultIdentity: + type: object + properties: name: type: string description: >- - The service name, which is a DNS-like logical identifier for the - service, such as `calendar.googleapis.com`. The service name - typically goes through DNS verification to make sure the owner of - the service also owns the DNS name. - customError: - description: Custom error configuration. - $ref: '#/components/schemas/CustomError' - usage: - $ref: '#/components/schemas/Usage' - description: Configuration controlling usage of this service. - id: + Default identity resource name. An example name would be: + `services/serviceconsumermanagement.googleapis.com/projects/123/defaultIdentity` + uniqueId: + description: The unique and stable id of the default identity. + type: string + email: description: >- - A unique ID for a specific instance of this message, typically - assigned by the client for tracking purpose. Must be no longer than - 63 characters and only lower case letters, digits, '.', '_' and '-' - are allowed. If empty, the server may choose to generate one - instead. + The email address of the default identity. Calling + GenerateDefaultIdentity with a deleted or purged default identity + should expect does_not_exist@invalid-project.iam.gserviceaccount.com + placeholder email. type: string - producerProjectId: - description: The Google project that owns this service. + tag: type: string - systemParameters: - $ref: '#/components/schemas/SystemParameters' - description: System parameter configuration. - monitoring: - $ref: '#/components/schemas/Monitoring' - description: Monitoring configuration. - backend: - description: API backend configuration. - $ref: '#/components/schemas/Backend' - quota: - $ref: '#/components/schemas/Quota' - description: Quota configuration. - publishing: description: >- - Settings for [Google Cloud Client - libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) - generated from APIs defined as protocol buffers. - $ref: '#/components/schemas/Publishing' - context: - description: Context configuration. - $ref: '#/components/schemas/Context' - logs: - type: array - items: - $ref: '#/components/schemas/LogDescriptor' - description: Defines the logs used by this service. - http: - description: HTTP configuration. - $ref: '#/components/schemas/Http' - apis: + The Default Identity tag. If specified when creating the account, + the tag must be present in activation_grants. If not specified when + creating the account, the tag is set to the tag specified in + activation_grants. + description: A default identity in the Identity and Access Management API. + id: V1DefaultIdentity + MetricDescriptorMetadata: + description: Additional annotations that can be used to guide the usage of a metric. + properties: + ingestDelay: + description: >- + The delay of data points caused by ingestion. Data points older than + this age are guaranteed to be ingested and available to be read, + excluding data loss due to errors. + format: google-duration + type: string + launchStage: + enum: + - LAUNCH_STAGE_UNSPECIFIED + - UNIMPLEMENTED + - PRELAUNCH + - EARLY_ACCESS + - ALPHA + - BETA + - GA + - DEPRECATED + description: Deprecated. Must use the MetricDescriptor.launch_stage instead. + enumDescriptions: + - Do not use this default value. + - The feature is not yet implemented. Users can not use it. + - >- + Prelaunch features are hidden from users and are only visible + internally. + - >- + Early Access features are limited to a closed group of testers. To + use these features, you must sign up in advance and sign a Trusted + Tester agreement (which includes confidentiality provisions). + These features may be unstable, changed in backward-incompatible + ways, and are not guaranteed to be released. + - >- + Alpha is a limited availability test for releases before they are + cleared for widespread use. By Alpha, all significant design + issues are resolved and we are in the process of verifying + functionality. Alpha customers need to apply for access, agree to + applicable terms, and have their projects allowlisted. Alpha + releases don't have to be feature complete, no SLAs are provided, + and there are no technical support obligations, but they will be + far enough along that customers can actually use them in test + environments or for limited-use tests -- just like they would in + normal production cases. + - >- + Beta is the point at which we are ready to open a release for any + customer to use. There are no SLA or technical support obligations + in a Beta release. Products will be complete from a feature + perspective, but may have some open outstanding issues. Beta + releases are suitable for limited production use cases. + - >- + GA features are open to all developers and are considered stable + and fully qualified for production use. + - >- + Deprecated features are scheduled to be shut down and removed. For + more information, see the "Deprecation Policy" section of our + [Terms of Service](https://cloud.google.com/terms/) and the + [Google Cloud Platform Subject to the Deprecation + Policy](https://cloud.google.com/terms/deprecation) documentation. + type: string + deprecated: true + timeSeriesResourceHierarchyLevel: items: - $ref: '#/components/schemas/Api' + enumDescriptions: + - Do not use this default value. + - Scopes a metric to a project. + - Scopes a metric to an organization. + - Scopes a metric to a folder. + enum: + - TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED + - PROJECT + - ORGANIZATION + - FOLDER + type: string + description: The scope of the timeseries data of the metric. type: array + samplePeriod: + type: string description: >- - A list of API interfaces exported by this service. Only the `name` - field of the google.protobuf.Api needs to be provided by the - configuration author, as the remaining fields will be derived from - the IDL during the normalization process. It is an error to specify - an API interface here which cannot be resolved against the - associated IDL files. - metrics: + The sampling period of metric data points. For metrics which are + written periodically, consecutive data points are stored at this + time interval, excluding data loss due to errors. Metrics with a + higher granularity have a smaller sampling period. + format: google-duration + type: object + id: MetricDescriptorMetadata + V1Beta1RefreshConsumerResponse: + properties: {} + description: >- + Response message for the `RefreshConsumer` method. This response message + is assigned to the `response` field of the returned Operation when that + operation is done. + id: V1Beta1RefreshConsumerResponse + type: object + SystemParameters: + type: object + description: >- + ### System parameter configuration A system parameter is a special kind + of parameter defined by the API system, not by an individual API. It is + typically mapped to an HTTP header and/or a URL query parameter. This + configuration specifies which methods change the names of the system + parameters. + id: SystemParameters + properties: + rules: type: array - items: - $ref: '#/components/schemas/MetricDescriptor' - description: Defines the metrics used by this service. - enums: description: >- - A list of all enum types included in this API service. Enums - referenced directly or indirectly by the `apis` are automatically - included. Enums which are not referenced but shall be included - should be listed here by name by the configuration author. Example: - enums: - name: google.someapi.v1.SomeEnum + Define system parameters. The parameters defined here will override + the default parameters implemented by the system. If this field is + missing from the service config, default system parameters will be + used. Default system parameters and names is + implementation-dependent. Example: define api key for all methods + system_parameters rules: - selector: "*" parameters: - name: api_key + url_query_parameter: api_key Example: define 2 api key names for a + specific method. system_parameters rules: - selector: "/ListShelves" + parameters: - name: api_key http_header: Api-Key1 - name: api_key + http_header: Api-Key2 **NOTE:** All service configuration rules + follow "last one wins" order. + items: + $ref: '#/components/schemas/SystemParameterRule' + SearchTenancyUnitsResponse: + properties: + tenancyUnits: type: array + description: Tenancy Units matching the request. items: - $ref: '#/components/schemas/Enum' - Http: - id: Http - description: >- - Defines the HTTP configuration for an API service. It contains a list of - HttpRule, each specifying the mapping of an RPC method to one or more - HTTP REST API methods. + $ref: '#/components/schemas/TenancyUnit' + nextPageToken: + type: string + description: Pagination token for large results. + id: SearchTenancyUnitsResponse + description: Response for the search query. + type: object + TenantProjectConfig: + type: object properties: - fullyDecodeReservedExpansion: - type: boolean + folder: + type: string description: >- - When set to true, URL path parameters will be fully URI-decoded - except in cases of single segment matches in reserved expansion, - where "%2F" will be left encoded. The default behavior is to not - decode RFC 6570 reserved characters in multi segment matches. - rules: + Folder where project in this tenancy unit must be located This + folder must have been previously created with the required + permissions for the caller to create and configure a project in it. + Valid folder resource names have the format + `folders/{folder_number}` (for example, `folders/123456`). + serviceAccountConfig: + $ref: '#/components/schemas/ServiceAccountConfig' + description: Configuration for the IAM service account on the tenant project. + billingConfig: + $ref: '#/components/schemas/BillingConfig' + description: Billing account properties. The billing account must be specified. + tenantProjectPolicy: + $ref: '#/components/schemas/TenantProjectPolicy' + description: Describes ownership and policies for the new tenant project. + labels: + additionalProperties: + type: string + description: Labels that are applied to this project. + type: object + services: + description: >- + Google Cloud API names of services that are activated on this + project during provisioning. If any of these services can't be + activated, the request fails. For example: + 'compute.googleapis.com','cloudfunctions.googleapis.com' type: array items: - $ref: '#/components/schemas/HttpRule' - description: >- - A list of HTTP configuration rules that apply to individual API - methods. **NOTE:** All service configuration rules follow "last one - wins" order. - type: object - V1Beta1ImportProducerOverridesResponse: + type: string + description: >- + This structure defines a tenant project to be added to the specified + tenancy unit and its initial configuration and properties. A project + lien is created for the tenant project to prevent the tenant project + from being deleted accidentally. The lien is deleted as part of tenant + project removal. + id: TenantProjectConfig + RubySettings: + properties: + common: + $ref: '#/components/schemas/CommonLanguageSettings' + description: Some settings. type: object - id: V1Beta1ImportProducerOverridesResponse - description: Response message for ImportProducerOverrides + id: RubySettings + description: Settings for Ruby client libraries. + BillingDestination: properties: - overrides: - description: The overrides that were created from the imported data. - type: array + monitoredResource: + description: >- + The monitored resource type. The type must be defined in + Service.monitored_resources section. + type: string + metrics: items: - $ref: '#/components/schemas/V1Beta1QuotaOverride' - V1EnableConsumerResponse: - id: V1EnableConsumerResponse + type: string + type: array + description: >- + Names of the metrics to report to this billing destination. Each + name must be defined in Service.metrics section. + id: BillingDestination type: object - properties: {} description: >- - Response message for the `EnableConsumer` method. This response message - is assigned to the `response` field of the returned Operation when that - operation is done. - Quota: + Configuration of a specific billing destination (Currently only support + bill against consumer project). + LogDescriptor: + description: >- + A description of a log type. Example in YAML format: - name: + library.googleapis.com/activity_history description: The history of + borrowing and returning library items. display_name: Activity labels: - + key: /customer_id description: Identifier of a library customer properties: - metricRules: - type: array - items: - $ref: '#/components/schemas/MetricRule' + name: description: >- - List of MetricRule definitions, each one mapping a selected method - to one or more metrics. - limits: - description: List of QuotaLimit definitions for the service. - type: array + The name of the log. It must be less than 512 characters long and + can include the following characters: upper- and lower-case + alphanumeric characters [A-Za-z0-9], and punctuation characters + including slash, underscore, hyphen, period [/_-.]. + type: string + labels: items: - $ref: '#/components/schemas/QuotaLimit' - id: Quota - description: >- - Quota configuration helps to achieve fairness and budgeting in service - usage. The metric based quota configuration works this way: - The - service configuration defines a set of metrics. - For API calls, the - quota.metric_rules maps methods to metrics with corresponding costs. - - The quota.limits defines limits on the metrics, which will be used for - quota checks at runtime. An example quota configuration in yaml format: - quota: limits: - name: apiWriteQpsPerProject metric: - library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit - for consumer projects values: STANDARD: 10000 (The metric rules bind all - methods to the read_calls metric, except for the UpdateBook and - DeleteBook methods. These two methods are mapped to the write_calls - metric, with the UpdateBook method consuming at twice rate as the - DeleteBook method.) metric_rules: - selector: "*" metric_costs: - library.googleapis.com/read_calls: 1 - selector: - google.example.library.v1.LibraryService.UpdateBook metric_costs: - library.googleapis.com/write_calls: 2 - selector: - google.example.library.v1.LibraryService.DeleteBook metric_costs: - library.googleapis.com/write_calls: 1 Corresponding Metric definition: - metrics: - name: library.googleapis.com/read_calls display_name: Read - requests metric_kind: DELTA value_type: INT64 - name: - library.googleapis.com/write_calls display_name: Write requests - metric_kind: DELTA value_type: INT64 + $ref: '#/components/schemas/LabelDescriptor' + type: array + description: >- + The set of labels that are available to describe a specific log + entry. Runtime requests that contain labels not specified here are + considered invalid. + description: + type: string + description: >- + A human-readable description of this log. This information appears + in the documentation and can contain details. + displayName: + type: string + description: >- + The human-readable name for this log. This information appears on + the user interface and should be concise. type: object - Monitoring: + id: LogDescriptor + Field: + id: Field + description: A single field of a message type. type: object - id: Monitoring properties: - producerDestinations: - type: array + name: + description: The field name. + type: string + typeUrl: + type: string description: >- - Monitoring configurations for sending metrics to the producer - project. There can be multiple producer destinations. A monitored - resource type may appear in multiple monitoring destinations if - different aggregations are needed for different sets of metrics - associated with that monitored resource type. A monitored resource - and metric pair may only be used once in the Monitoring - configuration. - items: - $ref: '#/components/schemas/MonitoringDestination' - consumerDestinations: + The field type URL, without the scheme, for message or enumeration + types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. + options: + description: The protocol buffer options. items: - $ref: '#/components/schemas/MonitoringDestination' + $ref: '#/components/schemas/Option' type: array + kind: + enum: + - TYPE_UNKNOWN + - TYPE_DOUBLE + - TYPE_FLOAT + - TYPE_INT64 + - TYPE_UINT64 + - TYPE_INT32 + - TYPE_FIXED64 + - TYPE_FIXED32 + - TYPE_BOOL + - TYPE_STRING + - TYPE_GROUP + - TYPE_MESSAGE + - TYPE_BYTES + - TYPE_UINT32 + - TYPE_ENUM + - TYPE_SFIXED32 + - TYPE_SFIXED64 + - TYPE_SINT32 + - TYPE_SINT64 + type: string + enumDescriptions: + - Field type unknown. + - Field type double. + - Field type float. + - Field type int64. + - Field type uint64. + - Field type int32. + - Field type fixed64. + - Field type fixed32. + - Field type bool. + - Field type string. + - Field type group. Proto2 syntax only, and deprecated. + - Field type message. + - Field type bytes. + - Field type uint32. + - Field type enum. + - Field type sfixed32. + - Field type sfixed64. + - Field type sint32. + - Field type sint64. + description: The field type. + number: + format: int32 + description: The field number. + type: integer + defaultValue: + type: string description: >- - Monitoring configurations for sending metrics to the consumer - project. There can be multiple consumer destinations. A monitored - resource type may appear in multiple monitoring destinations if - different aggregations are needed for different sets of metrics - associated with that monitored resource type. A monitored resource - and metric pair may only be used once in the Monitoring - configuration. - description: >- - Monitoring configuration of the service. The example below shows how to - configure monitored resources and metrics for monitoring. In the - example, a monitored resource and two metrics are defined. The - `library.googleapis.com/book/returned_count` metric is sent to both - producer and consumer projects, whereas the - `library.googleapis.com/book/num_overdue` metric is only sent to the - consumer project. monitored_resources: - type: - library.googleapis.com/Branch display_name: "Library Branch" - description: "A branch of a library." launch_stage: GA labels: - key: - resource_container description: "The Cloud container (ie. project id) - for the Branch." - key: location description: "The location of the - library branch." - key: branch_id description: "The id of the branch." - metrics: - name: library.googleapis.com/book/returned_count - display_name: "Books Returned" description: "The count of books that - have been returned." launch_stage: GA metric_kind: DELTA value_type: - INT64 unit: "1" labels: - key: customer_id description: "The id of the - customer." - name: library.googleapis.com/book/num_overdue display_name: - "Books Overdue" description: "The current number of overdue books." - launch_stage: GA metric_kind: GAUGE value_type: INT64 unit: "1" labels: - - key: customer_id description: "The id of the customer." monitoring: - producer_destinations: - monitored_resource: - library.googleapis.com/Branch metrics: - - library.googleapis.com/book/returned_count consumer_destinations: - - monitored_resource: library.googleapis.com/Branch metrics: - - library.googleapis.com/book/returned_count - - library.googleapis.com/book/num_overdue - AuthProvider: - id: AuthProvider + The string value of the default value of this field. Proto2 syntax + only. + oneofIndex: + type: integer + description: >- + The index of the field type in `Type.oneofs`, for message or + enumeration types. The first type has index 1; zero means the type + is not in the list. + format: int32 + cardinality: + enum: + - CARDINALITY_UNKNOWN + - CARDINALITY_OPTIONAL + - CARDINALITY_REQUIRED + - CARDINALITY_REPEATED + enumDescriptions: + - For fields with unknown cardinality. + - For optional fields. + - For required fields. Proto2 syntax only. + - For repeated fields. + type: string + description: The field cardinality. + packed: + description: Whether to use alternative packed wire representation. + type: boolean + jsonName: + type: string + description: The field JSON name. + V1AddVisibilityLabelsResponse: description: >- - Configuration for an authentication provider, including support for - [JSON Web Token - (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + Response message for the `AddVisibilityLabels` method. This response + message is assigned to the `response` field of the returned Operation + when that operation is done. + id: V1AddVisibilityLabelsResponse + properties: + labels: + items: + type: string + type: array + description: >- + The updated set of visibility labels for this consumer on this + service. type: object + V1Beta1ProducerQuotaPolicy: + description: Quota policy created by service producer. + id: V1Beta1ProducerQuotaPolicy properties: - audiences: - type: string + name: description: >- - The list of JWT - [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). - that are allowed to access. A JWT containing any of these audiences - will be accepted. When this setting is absent, JWTs with audiences: - - "https://[service.name]/[google.protobuf.Api.name]" - - "https://[service.name]/" will be accepted. For example, if no - audiences are in the setting, LibraryService API will accept JWTs - with the following audiences: - - https://library-example.googleapis.com/google.example.library.v1.LibraryService - - https://library-example.googleapis.com/ Example: audiences: - bookstore_android.apps.googleusercontent.com, - bookstore_web.apps.googleusercontent.com - jwksUri: + The resource name of the producer policy. An example name would be: + `services/compute.googleapis.com/organizations/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerQuotaPolicies/4a3f2c1d` + type: string + unit: type: string description: >- - URL of the provider's public key set to validate signature of the - JWT. See [OpenID - Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). - Optional if the key set document: - can be retrieved from [OpenID - Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html) - of the issuer. - can be inferred from the email domain of the issuer - (e.g. a Google service account). Example: - https://www.googleapis.com/oauth2/v1/certs - id: + The limit unit of the limit to which this policy applies. An example + unit would be: `1/{project}/{region}` Note that `{project}` and + `{region}` are not placeholders in this example; the literal + characters `{` and `}` occur in the string. + dimensions: + type: object + description: ' If this map is nonempty, then this policy applies only to specific values for dimensions defined in the limit unit. For example, a policy on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the policy is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit''s unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota polcies that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map.' + additionalProperties: + type: string + metric: type: string description: >- - The unique identifier of the auth provider. It will be referred to - by `AuthRequirement.provider_id`. Example: "bookstore_auth". - authorizationUrl: + The name of the metric to which this policy applies. An example name + would be: `compute.googleapis.com/cpus` + container: + description: >- + The cloud resource container at which the quota policy is created. + The format is {container_type}/{container_number} type: string + policyValue: + format: int64 description: >- - Redirect URL if JWT token is required but not present or is expired. - Implement authorizationUrl of securityDefinitions in OpenAPI spec. - issuer: + The quota policy value. Can be any nonnegative integer, or -1 + (unlimited quota). + type: string + type: object + V1Beta1QuotaOverride: + properties: + unit: type: string description: >- - Identifies the principal that issued the JWT. See - https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 - Usually a URL or an email address. Example: - https://securetoken.google.com Example: - 1234567-compute@developer.gserviceaccount.com - jwtLocations: + The limit unit of the limit to which this override applies. An + example unit would be: `1/{project}/{region}` Note that `{project}` + and `{region}` are not placeholders in this example; the literal + characters `{` and `}` occur in the string. + adminOverrideAncestor: description: >- - Defines the locations to extract the JWT. For now it is only used by - the Cloud Endpoints to store the OpenAPI extension - [x-google-jwt-locations] - (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) - JWT locations can be one of HTTP headers, URL query parameters or - cookies. The rule is that the first match wins. If not specified, - default to use following 3 locations: 1) Authorization: Bearer 2) - x-goog-iap-jwt-assertion 3) access_token query parameter Default - locations can be specified as followings: jwt_locations: - header: - Authorization value_prefix: "Bearer " - header: - x-goog-iap-jwt-assertion - query: access_token - items: - $ref: '#/components/schemas/JwtLocation' - type: array - Mixin: - description: >- - Declares an API Interface to be included in this interface. The - including interface must redeclare all the methods from the included - interface, but documentation and options are inherited as follows: - If - after comment and whitespace stripping, the documentation string of the - redeclared method is empty, it will be inherited from the original - method. - Each annotation belonging to the service config (http, - visibility) which is not set in the redeclared method will be inherited. - - If an http annotation is inherited, the path pattern will be modified - as follows. Any version prefix will be replaced by the version of the - including interface plus the root path if specified. Example of a simple - mixin: package google.acl.v1; service AccessControl { // Get the - underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option - (google.api.http).get = "/v1/{resource=**}:getAcl"; } } package - google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) - returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns - (Data) { option (google.api.http).get = "/v2/{resource=**}"; } } Example - of a mixin configuration: apis: - name: google.storage.v2.Storage - mixins: - name: google.acl.v1.AccessControl The mixin construct implies - that all methods in `AccessControl` are also declared with same name and - request/response types in `Storage`. A documentation generator or - annotation processor will see the effective `Storage.GetAcl` method - after inheriting documentation and annotations as follows: service - Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) - returns (Acl) { option (google.api.http).get = - "/v2/{resource=**}:getAcl"; } ... } Note how the version in the path - pattern changed from `v1` to `v2`. If the `root` field in the mixin is - specified, it should be a relative path under which inherited HTTP paths - are placed. Example: apis: - name: google.storage.v2.Storage mixins: - - name: google.acl.v1.AccessControl root: acls This implies the following - inherited HTTP annotation: service Storage { // Get the underlying ACL - object. rpc GetAcl(GetAclRequest) returns (Acl) { option - (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; } ... } - id: Mixin - properties: + The resource name of the ancestor that requested the override. For + example: "organizations/12345" or "folders/67890". Used by admin + overrides only. + type: string name: - description: The fully qualified name of the interface which is included. type: string - root: + description: >- + The resource name of the producer override. An example name would + be: + `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d` + metric: + description: >- + The name of the metric to which this override applies. An example + name would be: `compute.googleapis.com/cpus` type: string + overrideValue: + format: int64 description: >- - If non-empty specifies a path under which inherited HTTP paths are - rooted. + The overriding quota limit value. Can be any nonnegative integer, or + -1 (unlimited quota). + type: string + dimensions: + description: ' If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit''s unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota overrides that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map.' + type: object + additionalProperties: + type: string + id: V1Beta1QuotaOverride + description: A quota override type: object - RemoveTenantProjectRequest: - description: >- - Request message to remove a tenant project resource from the tenancy - unit. + TenantResource: properties: + resource: + description: >- + Output only. @OutputOnly Identifier of the tenant resource. For + cloud projects, it is in the form 'projects/{number}'. For example + 'projects/123456'. + readOnly: true + type: string + status: + enum: + - STATUS_UNSPECIFIED + - PENDING_CREATE + - ACTIVE + - PENDING_DELETE + - FAILED + - DELETED + type: string + enumDescriptions: + - Unspecified status is the default unset value. + - Creation of the tenant resource is ongoing. + - Active resource. + - Deletion of the resource is ongoing. + - Tenant resource creation or deletion has failed. + - Tenant resource has been deleted. + description: Status of tenant resource. tag: - description: Required. Tag of the resource within the tenancy unit. + description: Unique per single tenancy unit. type: string type: object - id: RemoveTenantProjectRequest - NodeSettings: - description: Settings for Node client libraries. - id: NodeSettings - type: object - properties: - common: - description: Some settings. - $ref: '#/components/schemas/CommonLanguageSettings' - LoggingDestination: + id: TenantResource + description: Resource constituting the TenancyUnit. + ServiceAccountConfig: + description: Describes the service account configuration for the tenant project. type: object - description: >- - Configuration of a specific logging destination (the producer project or - the consumer project). + id: ServiceAccountConfig properties: - logs: - description: >- - Names of the logs to be sent to this destination. Each name must be - defined in the Service.logs section. If the log name is not a domain - scoped name, it will be automatically prefixed with the service name - followed by "/". - type: array + tenantProjectRoles: items: type: string - monitoredResource: - type: string + type: array + description: Roles for the associated service account for the tenant project. + accountId: description: >- - The monitored resource type. The type must be defined in the - Service.monitored_resources section. - id: LoggingDestination - V1Beta1RefreshConsumerResponse: - properties: {} - type: object - id: V1Beta1RefreshConsumerResponse - description: >- - Response message for the `RefreshConsumer` method. This response message - is assigned to the `response` field of the returned Operation when that - operation is done. + ID of the IAM service account to be created in tenant project. The + email format of the service account is "@.iam.gserviceaccount.com". + This account ID must be unique within tenant project and service + producers have to guarantee it. The ID must be 6-30 characters long, + and match the following regular expression: + `[a-z]([-a-z0-9]*[a-z0-9])`. + type: string Endpoint: - id: Endpoint + type: object properties: + aliases: + description: >- + Aliases for this endpoint, these will be served by the same UrlMap + as the parent endpoint, and will be provisioned in the GCP stack for + the Regional Endpoints. + items: + type: string + type: array + name: + type: string + description: The canonical name of this endpoint. allowCors: type: boolean description: >- @@ -2085,25 +2207,15 @@ components: endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed. - name: - description: The canonical name of this endpoint. - type: string target: - type: string description: >- The specification of an Internet routable address of API frontend that will handle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary). It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com". - aliases: - type: array - description: >- - Aliases for this endpoint, these will be served by the same UrlMap - as the parent endpoint, and will be provisioned in the GCP stack for - the Regional Endpoints. - items: - type: string + type: string + id: Endpoint description: >- `Endpoint` describes a network address of a service that serves a set of APIs. It is commonly known as a service endpoint. A service may expose @@ -2119,834 +2231,570 @@ components: calls to be passed to the API frontend, for it # to decide whether the subsequent cross-origin request is allowed # to proceed. allow_cors: true - type: object - ApplyTenantProjectConfigRequest: - type: object - id: ApplyTenantProjectConfigRequest - description: Request to apply configuration to an existing tenant project. - properties: - tag: - description: >- - Required. Tag of the project. Must be less than 128 characters. - Required. - type: string - projectConfig: - $ref: '#/components/schemas/TenantProjectConfig' - description: Configuration that should be applied to the existing tenant project. - AddTenantProjectRequest: - description: >- - Request to add a newly created and configured tenant project to a - tenancy unit. - properties: - projectConfig: - description: >- - Configuration of the new tenant project to be added to tenancy unit - resources. - $ref: '#/components/schemas/TenantProjectConfig' - tag: - type: string - description: >- - Required. Tag of the added project. Must be less than 128 - characters. Required. - type: object - id: AddTenantProjectRequest - DotnetSettings: - description: Settings for Dotnet client libraries. - id: DotnetSettings - properties: - forcedNamespaceAliases: - type: array - items: - type: string - description: >- - Namespaces which must be aliased in snippets due to a known (but - non-generator-predictable) naming collision - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - renamedResources: - description: >- - Map from full resource types to the effective short name for the - resource. This is used when otherwise resource named from different - services would cause naming collisions. Example entry: - "datalabeling.googleapis.com/Dataset": "DataLabelingDataset" - additionalProperties: - type: string - type: object - ignoredResources: - items: - type: string - type: array - description: >- - List of full resource types to ignore during generation. This is - typically used for API-specific Location resources, which should be - handled by the generator as if they were actually the common - Location resources. Example entry: - "documentai.googleapis.com/Location" - renamedServices: - type: object - description: >- - Map from original service names to renamed versions. This is used - when the default generated types would cause a naming conflict. - (Neither name is fully-qualified.) Example: Subscriber to - SubscriberServiceApi. - additionalProperties: - type: string - handwrittenSignatures: - type: array - items: - type: string - description: >- - Method signatures (in the form "service.method(signature)") which - are provided separately, so shouldn't be generated. Snippets - *calling* these methods are still generated, however. - type: object - V1DisableConsumerResponse: - type: object - description: >- - Response message for the `DisableConsumer` method. This response message - is assigned to the `response` field of the returned Operation when that - operation is done. - properties: {} - id: V1DisableConsumerResponse - TenantProjectConfig: - id: TenantProjectConfig - properties: - tenantProjectPolicy: - description: Describes ownership and policies for the new tenant project. - $ref: '#/components/schemas/TenantProjectPolicy' - folder: - type: string - description: >- - Folder where project in this tenancy unit must be located This - folder must have been previously created with the required - permissions for the caller to create and configure a project in it. - Valid folder resource names have the format - `folders/{folder_number}` (for example, `folders/123456`). - serviceAccountConfig: - $ref: '#/components/schemas/ServiceAccountConfig' - description: Configuration for the IAM service account on the tenant project. - billingConfig: - $ref: '#/components/schemas/BillingConfig' - description: Billing account properties. The billing account must be specified. - services: - items: - type: string - description: >- - Google Cloud API names of services that are activated on this - project during provisioning. If any of these services can't be - activated, the request fails. For example: - 'compute.googleapis.com','cloudfunctions.googleapis.com' - type: array - labels: - additionalProperties: - type: string - type: object - description: Labels that are applied to this project. - description: >- - This structure defines a tenant project to be added to the specified - tenancy unit and its initial configuration and properties. A project - lien is created for the tenant project to prevent the tenant project - from being deleted accidentally. The lien is deleted as part of tenant - project removal. - type: object - ListTenancyUnitsResponse: - description: Response for the list request. - properties: - nextPageToken: - description: Pagination token for large results. - type: string - tenancyUnits: - type: array - description: Tenancy units matching the request. - items: - $ref: '#/components/schemas/TenancyUnit' - type: object - id: ListTenancyUnitsResponse - ContextRule: + MethodPolicy: + id: MethodPolicy properties: - selector: - description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. - type: string - allowedRequestExtensions: - type: array - items: - type: string - description: >- - A list of full type names or extension IDs of extensions allowed in - grpc side channel from client to backend. - provided: - description: >- - A list of full type names of provided contexts. It is used to - support propagating HTTP headers and ETags from the response - extension. - items: - type: string - type: array - requested: - items: - type: string - type: array - description: >- - A list of full type names of requested contexts, only the requested - context will be made available to the backend. - allowedResponseExtensions: - items: - type: string + requestPolicies: type: array - description: >- - A list of full type names or extension IDs of extensions allowed in - grpc side channel from backend to client. - type: object - id: ContextRule - description: >- - A context rule provides information about the context for an individual - API element. - BillingConfig: - description: Describes the billing configuration for a new tenant project. - type: object - properties: - billingAccount: - description: >- - Name of the billing account. For example - `billingAccounts/012345-567890-ABCDEF`. - type: string - id: BillingConfig - Option: - description: >- - A protocol buffer option, which can be attached to a message, field, - enumeration, etc. - properties: - value: - type: object - description: >- - The option's value packed in an Any message. If the value is a - primitive, the corresponding wrapper type defined in - google/protobuf/wrappers.proto should be used. If the value is an - enum, it should be stored as an int32 value using the - google.protobuf.Int32Value type. - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - name: - type: string - description: >- - The option's name. For protobuf built-in options (options defined in - descriptor.proto), this is the short name. For example, - `"map_entry"`. For custom options, it should be the fully-qualified - name. For example, `"google.api.http"`. - type: object - id: Option - PolicyBinding: - type: object - id: PolicyBinding - properties: - members: items: - type: string - description: >- - Uses the same format as in IAM policy. `member` must include both a - prefix and ID. For example, `user:{emailId}`, - `serviceAccount:{emailId}`, `group:{emailId}`. - type: array - role: - type: string + $ref: '#/components/schemas/FieldPolicy' + description: Policies that are applicable to the request message. + selector: description: >- - Role. (https://cloud.google.com/iam/docs/understanding-roles) For - example, `roles/viewer`, `roles/editor`, or `roles/owner`. - description: Translates to IAM Policy bindings (without auditing at this level) - EnumValue: - description: Enum value definition. - id: EnumValue + Selects a method to which these policies should be enforced, for + example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to + selector for syntax details. NOTE: This field must not be set in the + proto annotation. It will be automatically filled by the service + config compiler . + type: string type: object + description: Defines policies applying to an RPC method. + EnumValue: properties: number: description: Enum value number. - format: int32 type: integer + format: int32 options: type: array - description: Protocol buffer options. items: $ref: '#/components/schemas/Option' + description: Protocol buffer options. name: type: string description: Enum value name. - ClientLibrarySettings: - description: Details about how and where to publish client libraries. + description: Enum value definition. + id: EnumValue + type: object + ExperimentalFeatures: + type: object + description: >- + Experimental features to be included during client library generation. + These fields will be deprecated once the feature graduates and is + enabled by default. properties: - javaSettings: - $ref: '#/components/schemas/JavaSettings' - description: Settings for legacy Java features, supported in the Service YAML. - nodeSettings: - $ref: '#/components/schemas/NodeSettings' - description: Settings for Node client libraries. - restNumericEnums: + protobufPythonicTypesEnabled: + description: >- + Enables generation of protobuf code using new types that are more + Pythonic which are included in `protobuf>=5.29.x`. This feature will + be enabled by default 1 month after launching the feature in preview + packages. type: boolean + unversionedPackageDisabled: description: >- - When using transport=rest, the client request will encode enums as - numbers rather than strings. - launchStage: - type: string - enum: - - LAUNCH_STAGE_UNSPECIFIED - - UNIMPLEMENTED - - PRELAUNCH - - EARLY_ACCESS - - ALPHA - - BETA - - GA - - DEPRECATED - enumDescriptions: - - Do not use this default value. - - The feature is not yet implemented. Users can not use it. - - >- - Prelaunch features are hidden from users and are only visible - internally. - - >- - Early Access features are limited to a closed group of testers. To - use these features, you must sign up in advance and sign a Trusted - Tester agreement (which includes confidentiality provisions). - These features may be unstable, changed in backward-incompatible - ways, and are not guaranteed to be released. - - >- - Alpha is a limited availability test for releases before they are - cleared for widespread use. By Alpha, all significant design - issues are resolved and we are in the process of verifying - functionality. Alpha customers need to apply for access, agree to - applicable terms, and have their projects allowlisted. Alpha - releases don't have to be feature complete, no SLAs are provided, - and there are no technical support obligations, but they will be - far enough along that customers can actually use them in test - environments or for limited-use tests -- just like they would in - normal production cases. - - >- - Beta is the point at which we are ready to open a release for any - customer to use. There are no SLA or technical support obligations - in a Beta release. Products will be complete from a feature - perspective, but may have some open outstanding issues. Beta - releases are suitable for limited production use cases. - - >- - GA features are open to all developers and are considered stable - and fully qualified for production use. - - >- - Deprecated features are scheduled to be shut down and removed. For - more information, see the "Deprecation Policy" section of our - [Terms of Service](https://cloud.google.com/terms/) and the - [Google Cloud Platform Subject to the Deprecation - Policy](https://cloud.google.com/terms/deprecation) documentation. - description: Launch stage of this version of the API. - cppSettings: - $ref: '#/components/schemas/CppSettings' - description: Settings for C++ client libraries. - goSettings: - $ref: '#/components/schemas/GoSettings' - description: Settings for Go client libraries. - dotnetSettings: - description: Settings for .NET client libraries. - $ref: '#/components/schemas/DotnetSettings' - phpSettings: - $ref: '#/components/schemas/PhpSettings' - description: Settings for PHP client libraries. - version: - type: string + Disables generation of an unversioned Python package for this client + library. This means that the module names will need to be versioned + in import statements. For example `import google.cloud.library_v2` + instead of `import google.cloud.library`. + type: boolean + restAsyncIoEnabled: description: >- - Version of the API to apply these settings to. This is the full - protobuf package for the API, ending in the version element. - Examples: "google.cloud.speech.v1" and - "google.spanner.admin.database.v1". - rubySettings: - $ref: '#/components/schemas/RubySettings' - description: Settings for Ruby client libraries. - pythonSettings: - description: Settings for Python client libraries. - $ref: '#/components/schemas/PythonSettings' - id: ClientLibrarySettings - type: object - Control: - id: Control - description: >- - Selects and configures the service controller used by the service. - Example: control: environment: servicecontrol.googleapis.com + Enables generation of asynchronous REST clients if `rest` transport + is enabled. By default, asynchronous REST clients will not be + generated. This feature will be enabled by default 1 month after + launching the feature in preview packages. + type: boolean + id: ExperimentalFeatures + JwtLocation: properties: - environment: + valuePrefix: description: >- - The service controller environment to use. If empty, no control - plane feature (like quota and billing) will be enabled. The - recommended value for most services is servicecontrol.googleapis.com + The value prefix. The value format is "value_prefix{token}" Only + applies to "in" header type. Must be empty for "in" query type. If + not empty, the header value has to match (case sensitive) this + prefix. If not matched, JWT will not be extracted. If matched, JWT + will be extracted after the prefix is removed. For example, for + "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space + at the end. type: string - methodPolicies: - description: Defines policies applying to the API methods of the service. - items: - $ref: '#/components/schemas/MethodPolicy' - type: array + header: + description: Specifies HTTP header name to extract JWT token. + type: string + query: + type: string + description: Specifies URL query parameter name to extract JWT token. + cookie: + description: Specifies cookie name to extract JWT token. + type: string + id: JwtLocation + description: Specifies a location to extract JWT from an API request. type: object - TenancyUnit: + AuthenticationRule: + description: >- + Authentication rules for the service. By default, if a method has any + authentication requirements, every request must include a valid + credential matching one of the requirements. It's an error to include + more than one kind of credential in a single request. If a method + doesn't have any auth requirements, request credentials will be ignored. + id: AuthenticationRule properties: - consumer: + selector: type: string - readOnly: true description: >- - Output only. @OutputOnly Cloud resource name of the consumer of this - service. For example 'projects/123456'. - createTime: - type: string - description: Output only. @OutputOnly The time this tenancy unit was created. - readOnly: true - format: google-datetime - service: - type: string - readOnly: true + Selects the methods to which this rule applies. Refer to selector + for syntax details. + oauth: + $ref: '#/components/schemas/OAuthRequirements' + description: The requirements for OAuth credentials. + allowWithoutCredential: + type: boolean description: >- - Output only. Google Cloud API name of the managed service owning - this tenancy unit. For example - 'serviceconsumermanagement.googleapis.com'. - tenantResources: - items: - $ref: '#/components/schemas/TenantResource' + If true, the service accepts API keys without any other credential. + This flag only applies to HTTP and gRPC requests. + requirements: type: array - description: >- - Resources constituting the tenancy unit. There can be at most 512 - tenant resources in a tenancy unit. - name: - description: >- - Globally unique identifier of this tenancy unit - "services/{service}/{collection id}/{resource - id}/tenancyUnits/{unit}" - type: string - description: Representation of a tenancy unit. - id: TenancyUnit + items: + $ref: '#/components/schemas/AuthRequirement' + description: Requirements for additional authentication providers. type: object - Backend: - description: '`Backend` defines the backend configuration for a service.' - id: Backend + SelectiveGapicGeneration: + description: >- + This message is used to configure the generation of a subset of the RPCs + in a service for client libraries. + id: SelectiveGapicGeneration properties: - rules: + generateOmittedAsInternal: + type: boolean description: >- - A list of API backend rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. + Setting this to true indicates to the client generators that methods + that would be excluded from the generation should instead be + generated in a way that indicates these methods should not be + consumed by end users. How this is expressed is up to individual + language implementations to decide. Some examples may be: added + annotations, obfuscated identifiers, or other language idiomatic + patterns. + methods: + description: >- + An allowlist of the fully qualified names of RPCs that should be + included on public client surfaces. type: array items: - $ref: '#/components/schemas/BackendRule' - type: object - Documentation: + type: string type: object + Publishing: properties: - documentationRootUrl: - description: The URL to the root of documentation. + docTagPrefix: + description: >- + A prefix used in sample code when demarking regions to be included + in documentation. type: string - pages: + githubLabel: + type: string + description: >- + GitHub label to apply to issues and pull requests opened for this + API. + codeownerGithubTeams: + items: + type: string + description: >- + GitHub teams to be added to CODEOWNERS in the directory in GitHub + containing source code for the client libraries for this API. + type: array + methodSettings: type: array items: - $ref: '#/components/schemas/Page' - description: The top level pages for the documentation set. - overview: + $ref: '#/components/schemas/MethodSettings' description: >- - Declares a single overview page. For example: documentation: - summary: ... overview: (== include overview.md ==) This is a - shortcut for the following declaration (using pages style): - documentation: summary: ... pages: - name: Overview content: (== - include overview.md ==) Note: you cannot specify both `overview` - field and `pages` field. + A list of API method settings, e.g. the behavior for methods that + use the long-running operation pattern. + newIssueUri: type: string - serviceRootUrl: description: >- - Specifies the service root url if the default one (the service name - from the yaml file) is not suitable. This can be seen in any fully - specified service urls as well as sections that show a base that - other urls are relative to. + Link to a *public* URI where users can report issues. Example: + https://issuetracker.google.com/issues/new?component=190865&template=1161103 + apiShortName: type: string - sectionOverrides: description: >- - Specifies section and content to override boilerplate content - provided by go/api-docgen. Currently overrides following sections: - 1. rest.service.client_libraries - type: array - items: - $ref: '#/components/schemas/Page' - rules: - items: - $ref: '#/components/schemas/DocumentationRule' + Used as a tracking tag when collecting data about the APIs developer + relations artifacts like docs, packages delivered to package + managers, etc. Example: "speech". + documentationUri: description: >- - A list of documentation rules that apply to individual API elements. - **NOTE:** All service configuration rules follow "last one wins" - order. - type: array - summary: + Link to product home page. Example: + https://cloud.google.com/asset-inventory/docs/overview type: string + protoReferenceDocumentationUri: description: >- - A short description of what the service does. The summary must be - plain text. It becomes the overview of the service displayed in - Google Cloud Console. NOTE: This field is equivalent to the standard - field `description`. - description: >- - `Documentation` provides the information for describing a service. - Example: documentation: summary: > The Google Calendar API gives access - to most calendar features. pages: - name: Overview content: (== include - google/foo/overview.md ==) - name: Tutorial content: (== include - google/foo/tutorial.md ==) subpages: - name: Java content: (== include - google/foo/tutorial_java.md ==) rules: - selector: - google.calendar.Calendar.Get description: > ... - selector: - google.calendar.Calendar.Put description: > ... Documentation is - provided in markdown syntax. In addition to standard markdown features, - definition lists, tables and fenced code blocks are supported. Section - headers can be provided and are interpreted relative to the section - nesting of the context where a documentation fragment is embedded. - Documentation from the IDL is merged with documentation defined via the - config at normalization time, where documentation provided by config - rules overrides IDL provided. A number of constructs specific to the API - platform are supported in documentation text. In order to reference a - proto element, the following notation can be used: - [fully.qualified.proto.name][] To override the display text used for the - link, this can be used: [display text][fully.qualified.proto.name] Text - can be excluded from doc using the following notation: (-- internal - comment --) A few directives are available in documentation. Note that - directives must appear on a single line to be properly identified. The - `include` directive includes a markdown file from an external source: - (== include path/to/file ==) The `resource_for` directive marks a - message to be the resource of a collection in REST view. If it is not - specified, tools attempt to infer the resource from the operations in a - collection: (== resource_for v1.shelves.books ==) The directive - `suppress_warning` does not directly affect documentation and is - documented together with service config validation. - id: Documentation - LabelDescriptor: - description: A description of a label. - properties: - description: + Optional link to proto reference documentation. Example: + https://cloud.google.com/pubsub/lite/docs/reference/rpc type: string - description: A human-readable description for the label. - key: - description: The label key. + librarySettings: + type: array + description: >- + Client library settings. If the same version string appears multiple + times in this list, then the last one wins. Settings from earlier + settings with the same version string are discarded. + items: + $ref: '#/components/schemas/ClientLibrarySettings' + restReferenceDocumentationUri: type: string - valueType: + description: >- + Optional link to REST reference documentation. Example: + https://cloud.google.com/pubsub/lite/docs/reference/rest + organization: enumDescriptions: - - A variable-length string. This is the default. - - Boolean; true or false. - - A 64-bit signed integer. - description: The type of data that can be assigned to the label. + - Not useful. + - Google Cloud Platform Org. + - Ads (Advertising) Org. + - Photos Org. + - Street View Org. + - Shopping Org. + - Geo Org. + - Generative AI - https://developers.generativeai.google enum: - - STRING - - BOOL - - INT64 + - CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED + - CLOUD + - ADS + - PHOTOS + - STREET_VIEW + - SHOPPING + - GEO + - GENERATIVE_AI + description: For whom the client library is being published. type: string - id: LabelDescriptor type: object - Type: - description: A protocol buffer message type. - id: Type + id: Publishing + description: >- + This message configures the settings for publishing [Google Cloud Client + libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) + generated from the service config. + RemoveTenantProjectRequest: + description: >- + Request message to remove a tenant project resource from the tenancy + unit. + id: RemoveTenantProjectRequest type: object properties: - fields: - description: The list of fields. - type: array - items: - $ref: '#/components/schemas/Field' - options: - type: array - description: The protocol buffer options. - items: - $ref: '#/components/schemas/Option' - syntax: - enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. - type: string - description: The source syntax. - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS - name: - type: string - description: The fully qualified message name. - oneofs: - items: - type: string - type: array - description: The list of types appearing in `oneof` definitions in this type. - sourceContext: - $ref: '#/components/schemas/SourceContext' - description: The source context. - edition: - description: >- - The source edition string, only valid when syntax is - SYNTAX_EDITIONS. + tag: type: string - Operation: + description: Required. Tag of the resource within the tenancy unit. + BackendRule: + description: A backend rule provides configuration for an individual API element. + id: BackendRule type: object properties: - done: + minDeadline: + type: number + format: double + description: Deprecated, do not use. + deprecated: true + loadBalancingPolicy: + description: >- + The load balancing policy used for connection to the application + backend. Defined as an arbitrary string to accomondate custom load + balancing policies supported by the underlying channel, but suggest + most users use one of the standard policies, such as the default, + "RoundRobin". + type: string + disableAuth: type: boolean description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - response: + When disable_auth is true, a JWT ID token won't be generated and the + original "Authorization" HTTP header will be preserved. If the + header is used to carry the original token and is expected by the + backend, this field must be set to true to preserve the header. + pathTranslation: + type: string + enum: + - PATH_TRANSLATION_UNSPECIFIED + - CONSTANT_ADDRESS + - APPEND_PATH_TO_ADDRESS + enumDescriptions: + - '' + - >- + Use the backend address as-is, with no modification to the path. + If the URL pattern contains variables, the variable names and + values will be appended to the query string. If a query string + parameter and a URL pattern variable have the same name, this may + result in duplicate keys in the query string. # Examples Given the + following operation config: Method path: + /api/company/{cid}/user/{uid} Backend address: + https://example.cloudfunctions.net/getUser Requests to the + following request paths will call the backend at the translated + path: Request path: /api/company/widgetworks/user/johndoe + Translated: + https://example.cloudfunctions.net/getUser?cid=widgetworks&uid=johndoe + Request path: /api/company/widgetworks/user/johndoe?timezone=EST + Translated: + https://example.cloudfunctions.net/getUser?timezone=EST&cid=widgetworks&uid=johndoe + - >- + The request path will be appended to the backend address. # + Examples Given the following operation config: Method path: + /api/company/{cid}/user/{uid} Backend address: + https://example.appspot.com Requests to the following request + paths will call the backend at the translated path: Request path: + /api/company/widgetworks/user/johndoe Translated: + https://example.appspot.com/api/company/widgetworks/user/johndoe + Request path: /api/company/widgetworks/user/johndoe?timezone=EST + Translated: + https://example.appspot.com/api/company/widgetworks/user/johndoe?timezone=EST + address: + type: string description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. + The address of the API backend. The scheme is used to determine the + backend protocol and security. The following schemes are accepted: + SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// + gRPC None grpcs:// gRPC TLS It is recommended to explicitly include + a scheme. Leaving out the scheme may cause constrasting behaviors + across platforms. If the port is unspecified, the default is: - 80 + for schemes without TLS - 443 for schemes with TLS For HTTP + backends, use protocol to specify the protocol version. + overridesByRequestProtocol: type: object additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - error: - $ref: '#/components/schemas/Status' + $ref: '#/components/schemas/BackendRule' + description: The map between request protocol and the backend address. + deadline: + format: double + type: number + description: >- + The number of seconds to wait for a response from a request. The + default varies based on the request protocol and deployment + environment. + jwtAudience: + type: string description: >- - The error result of the operation in case of failure or - cancellation. - name: + The JWT audience is used when generating a JWT ID token for the + backend. This ID token will be added in the HTTP "authorization" + header, and sent to the backend. + protocol: + description: >- + The protocol used for sending a request to the backend. The + supported values are "http/1.1" and "h2". The default value is + inferred from the scheme in the address field: SCHEME PROTOCOL + http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure + HTTP backends (https://) that support HTTP/2, set this field to "h2" + for improved performance. Configuring this field to non-default + values is only supported for secure HTTP backends. This field will + be ignored for all other backends. See + https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids + for more details on the supported values. type: string + operationDeadline: + type: number + format: double description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. - metadata: + The number of seconds to wait for the completion of a long running + operation. The default is no deadline. + selector: + type: string description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - description: >- - This resource represents a long-running operation that is the result of - a network API call. - id: Operation - SearchTenancyUnitsResponse: - id: SearchTenancyUnitsResponse - description: Response for the search query. + Selects the methods to which this rule applies. Refer to selector + for syntax details. + PythonSettings: properties: - nextPageToken: - type: string - description: Pagination token for large results. - tenancyUnits: - type: array - description: Tenancy Units matching the request. - items: - $ref: '#/components/schemas/TenancyUnit' + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' + experimentalFeatures: + description: >- + Experimental features to be included during client library + generation. + $ref: '#/components/schemas/ExperimentalFeatures' + id: PythonSettings type: object - Field: + description: Settings for Python client libraries. + V1GenerateServiceAccountResponse: + id: V1GenerateServiceAccountResponse properties: - packed: - description: Whether to use alternative packed wire representation. - type: boolean - cardinality: - description: The field cardinality. - enum: - - CARDINALITY_UNKNOWN - - CARDINALITY_OPTIONAL - - CARDINALITY_REQUIRED - - CARDINALITY_REPEATED - enumDescriptions: - - For fields with unknown cardinality. - - For optional fields. - - For required fields. Proto2 syntax only. - - For repeated fields. + account: + $ref: '#/components/schemas/V1ServiceAccount' + description: ServiceAccount that was created or retrieved. + type: object + description: >- + Response message for the `GenerateServiceAccount` method. This response + message is assigned to the `response` field of the returned Operation + when that operation is done. + FieldPolicy: + type: object + id: FieldPolicy + properties: + resourceType: type: string - defaultValue: + description: >- + Specifies the resource type for the resource referred to by the + field. + resourcePermission: + description: >- + Specifies the required permission(s) for the resource referred to by + the field. It requires the field contains a valid resource + reference, and the request must pass the permission checks to + proceed. For example, "resourcemanager.projects.get". type: string + selector: description: >- - The string value of the default value of this field. Proto2 syntax - only. - name: - description: The field name. + Selects one or more request or response message fields to apply this + `FieldPolicy`. When a `FieldPolicy` is used in proto annotation, the + selector must be left as empty. The service config generator will + automatically fill the correct value. When a `FieldPolicy` is used + in service config, the selector must be a comma-separated string + with valid request or response field paths, such as "foo.bar" or + "foo.bar,foo.baz". type: string - jsonName: - description: The field JSON name. + description: >- + Google API Policy Annotation This message defines a simple API policy + annotation that can be used to annotate API request and response message + fields with applicable policies. One field may have multiple applicable + policies that must all be satisfied before a request can be processed. + This policy annotation is used to generate the overall policy that will + be used for automatic runtime policy enforcement and documentation + generation. + BatchingSettingsProto: + description: >- + `BatchingSettingsProto` specifies a set of batching thresholds, each of + which acts as a trigger to send a batch of messages as a request. At + least one threshold must be positive nonzero. + type: object + properties: + elementCountLimit: + type: integer + format: int32 + description: >- + The maximum number of elements collected in a batch that could be + accepted by server. + delayThreshold: + description: >- + The duration after which a batch should be sent, starting from the + addition of the first message to that batch. type: string - typeUrl: + format: google-duration + elementCountThreshold: + format: int32 + type: integer + description: >- + The number of elements of a field collected into a batch which, if + exceeded, causes the batch to be sent. + requestByteLimit: + format: int32 + type: integer + description: The maximum size of the request that could be accepted by server. + requestByteThreshold: + format: int64 type: string description: >- - The field type URL, without the scheme, for message or enumeration - types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. - oneofIndex: + The aggregated size of the batched field which, if exceeded, causes + the batch to be sent. This size is computed by aggregating the sizes + of the request field to be batched, not of the entire request + message. + flowControlByteLimit: type: integer + description: The maximum size of data allowed by flow control. format: int32 - description: >- - The index of the field type in `Type.oneofs`, for message or - enumeration types. The first type has index 1; zero means the type - is not in the list. - options: - type: array - description: The protocol buffer options. - items: - $ref: '#/components/schemas/Option' - kind: - description: The field type. + flowControlLimitExceededBehavior: type: string - enum: - - TYPE_UNKNOWN - - TYPE_DOUBLE - - TYPE_FLOAT - - TYPE_INT64 - - TYPE_UINT64 - - TYPE_INT32 - - TYPE_FIXED64 - - TYPE_FIXED32 - - TYPE_BOOL - - TYPE_STRING - - TYPE_GROUP - - TYPE_MESSAGE - - TYPE_BYTES - - TYPE_UINT32 - - TYPE_ENUM - - TYPE_SFIXED32 - - TYPE_SFIXED64 - - TYPE_SINT32 - - TYPE_SINT64 enumDescriptions: - - Field type unknown. - - Field type double. - - Field type float. - - Field type int64. - - Field type uint64. - - Field type int32. - - Field type fixed64. - - Field type fixed32. - - Field type bool. - - Field type string. - - Field type group. Proto2 syntax only, and deprecated. - - Field type message. - - Field type bytes. - - Field type uint32. - - Field type enum. - - Field type sfixed32. - - Field type sfixed64. - - Field type sint32. - - Field type sint64. - number: - format: int32 + - Default behavior, system-defined. + - Stop operation, raise error. + - Pause operation until limit clears. + - Continue operation, disregard limit. + description: The behavior to take when the flow control limit is exceeded. + enum: + - UNSET_BEHAVIOR + - THROW_EXCEPTION + - BLOCK + - IGNORE + flowControlElementLimit: + description: The maximum number of elements allowed by flow control. type: integer - description: The field number. - type: object - id: Field - description: A single field of a message type. - DeleteTenantProjectRequest: - id: DeleteTenantProjectRequest - type: object - description: Request message to delete tenant project resource from the tenancy unit. - properties: - tag: - description: Required. Tag of the resource within the tenancy unit. - type: string - LongRunning: + format: int32 + id: BatchingSettingsProto + JavaSettings: properties: - pollDelayMultiplier: - format: float - type: number + libraryPackage: description: >- - Multiplier to gradually increase delay between subsequent polls - until it reaches max_poll_delay. Default value: 1.5. - initialPollDelay: + The package name to use in Java. Clobbers the java_package option + set in the protobuf. This should be used **only** by APIs who have + already set the language_settings.java.package_name" field in + gapic.yaml. API teams should use the protobuf java_package option + where possible. Example of a YAML configuration:: publishing: + library_settings: java_settings: library_package: + com.google.cloud.pubsub.v1 type: string + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' + serviceClassNames: + additionalProperties: + type: string + type: object description: >- - Initial delay after which the first poll request will be made. - Default value: 5 seconds. - format: google-duration - maxPollDelay: - type: string - format: google-duration + Configure the Java class name to use instead of the service's for + its corresponding generated GAPIC client. Keys are fully-qualified + service names as they appear in the protobuf (including the full the + language_settings.java.interface_names" field in gapic.yaml. API + teams should otherwise use the service name as it appears in the + protobuf. Example of a YAML configuration:: publishing: + java_settings: service_class_names: - google.pubsub.v1.Publisher: + TopicAdmin - google.pubsub.v1.Subscriber: SubscriptionAdmin + id: JavaSettings + description: Settings for Java client libraries. + type: object + ApplyTenantProjectConfigRequest: + type: object + properties: + projectConfig: + $ref: '#/components/schemas/TenantProjectConfig' + description: Configuration that should be applied to the existing tenant project. + tag: description: >- - Maximum time between two subsequent poll requests. Default value: 45 - seconds. - totalPollTimeout: + Required. Tag of the project. Must be less than 128 characters. + Required. type: string - format: google-duration - description: 'Total polling timeout. Default value: 5 minutes.' - description: >- - Describes settings to use when generating API methods that use the - long-running operation pattern. All default values below are from those - used in the client library generators (e.g. - [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)). - id: LongRunning - type: object - ExperimentalFeatures: - id: ExperimentalFeatures + description: Request to apply configuration to an existing tenant project. + id: ApplyTenantProjectConfigRequest + Http: type: object description: >- - Experimental features to be included during client library generation. - These fields will be deprecated once the feature graduates and is - enabled by default. + Defines the HTTP configuration for an API service. It contains a list of + HttpRule, each specifying the mapping of an RPC method to one or more + HTTP REST API methods. + id: Http properties: - restAsyncIoEnabled: + fullyDecodeReservedExpansion: description: >- - Enables generation of asynchronous REST clients if `rest` transport - is enabled. By default, asynchronous REST clients will not be - generated. This feature will be enabled by default 1 month after - launching the feature in preview packages. + When set to true, URL path parameters will be fully URI-decoded + except in cases of single segment matches in reserved expansion, + where "%2F" will be left encoded. The default behavior is to not + decode RFC 6570 reserved characters in multi segment matches. type: boolean - V1GenerateDefaultIdentityResponse: + rules: + items: + $ref: '#/components/schemas/HttpRule' + description: >- + A list of HTTP configuration rules that apply to individual API + methods. **NOTE:** All service configuration rules follow "last one + wins" order. + type: array + GoSettings: type: object properties: - identity: - $ref: '#/components/schemas/V1DefaultIdentity' - description: DefaultIdentity that was created or retrieved. - role: - type: string - description: >- - Role attached to consumer project. Empty if not attached in this - request. (Under development, currently always return empty.) - attachStatus: - enumDescriptions: - - Indicates that the AttachStatus was not set. - - >- - The default identity was attached to a role successfully in this - request. - - >- - The request specified that no attempt should be made to attach the - role. - - >- - Role was attached to the consumer project at some point in time. - Tenant manager doesn't make assertion about the current state of - the identity with respect to the consumer. Role attachment should - happen only once after activation and cannot be reattached after - customer removes it. (go/si-attach-role) - - >- - Role attachment was denied in this request by customer set org - policy. (go/si-attach-role) - enum: - - ATTACH_STATUS_UNSPECIFIED - - ATTACHED - - ATTACH_SKIPPED - - PREVIOUSLY_ATTACHED - - ATTACH_DENIED_BY_ORG_POLICY - type: string + renamedServices: + type: object description: >- - Status of the role attachment. Under development - (go/si-attach-role), currently always return - ATTACH_STATUS_UNSPECIFIED) - id: V1GenerateDefaultIdentityResponse - description: >- - Response message for the `GenerateDefaultIdentity` method. This response - message is assigned to the `response` field of the returned Operation - when that operation is done. + Map of service names to renamed services. Keys are the package + relative service names and values are the name to be used for the + service client and call options. publishing: go_settings: + renamed_services: Publisher: TopicAdmin + additionalProperties: + type: string + common: + $ref: '#/components/schemas/CommonLanguageSettings' + description: Some settings. + description: Settings for Go client libraries. + id: GoSettings Logging: id: Logging + type: object properties: consumerDestinations: + items: + $ref: '#/components/schemas/LoggingDestination' + type: array description: >- Logging configurations for sending logs to the consumer project. There can be multiple consumer destinations, each one must have a different monitored resource type. A log can be used in at most one consumer destination. - items: - $ref: '#/components/schemas/LoggingDestination' - type: array producerDestinations: items: $ref: '#/components/schemas/LoggingDestination' @@ -2956,7 +2804,6 @@ components: different monitored resource type. A log can be used in at most one producer destination. type: array - type: object description: >- Logging configuration of the service. The following example shows how to configure logs to be sent to the producer and consumer projects. In the @@ -2971,29 +2818,154 @@ components: activity_history - purchase_history consumer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history + Backend: + properties: + rules: + type: array + description: >- + A list of API backend rules that apply to individual API methods. + **NOTE:** All service configuration rules follow "last one wins" + order. + items: + $ref: '#/components/schemas/BackendRule' + id: Backend + description: '`Backend` defines the backend configuration for a service.' + type: object + ListOperationsResponse: + properties: + nextPageToken: + type: string + description: The standard List next-page token. + operations: + description: >- + A list of operations that matches the specified filter in the + request. + items: + $ref: '#/components/schemas/Operation' + type: array + description: The response message for Operations.ListOperations. + type: object + id: ListOperationsResponse + Mixin: + description: >- + Declares an API Interface to be included in this interface. The + including interface must redeclare all the methods from the included + interface, but documentation and options are inherited as follows: - If + after comment and whitespace stripping, the documentation string of the + redeclared method is empty, it will be inherited from the original + method. - Each annotation belonging to the service config (http, + visibility) which is not set in the redeclared method will be inherited. + - If an http annotation is inherited, the path pattern will be modified + as follows. Any version prefix will be replaced by the version of the + including interface plus the root path if specified. Example of a simple + mixin: package google.acl.v1; service AccessControl { // Get the + underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option + (google.api.http).get = "/v1/{resource=**}:getAcl"; } } package + google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) + returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns + (Data) { option (google.api.http).get = "/v2/{resource=**}"; } } Example + of a mixin configuration: apis: - name: google.storage.v2.Storage + mixins: - name: google.acl.v1.AccessControl The mixin construct implies + that all methods in `AccessControl` are also declared with same name and + request/response types in `Storage`. A documentation generator or + annotation processor will see the effective `Storage.GetAcl` method + after inheriting documentation and annotations as follows: service + Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) + returns (Acl) { option (google.api.http).get = + "/v2/{resource=**}:getAcl"; } ... } Note how the version in the path + pattern changed from `v1` to `v2`. If the `root` field in the mixin is + specified, it should be a relative path under which inherited HTTP paths + are placed. Example: apis: - name: google.storage.v2.Storage mixins: - + name: google.acl.v1.AccessControl root: acls This implies the following + inherited HTTP annotation: service Storage { // Get the underlying ACL + object. rpc GetAcl(GetAclRequest) returns (Acl) { option + (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; } ... } + id: Mixin + type: object + properties: + root: + type: string + description: >- + If non-empty specifies a path under which inherited HTTP paths are + rooted. + name: + type: string + description: The fully qualified name of the interface which is included. + OAuthRequirements: + properties: + canonicalScopes: + type: string + description: >- + The list of publicly documented OAuth scopes that are allowed + access. An OAuth token containing any of these scopes will be + accepted. Example: canonical_scopes: + https://www.googleapis.com/auth/calendar, + https://www.googleapis.com/auth/calendar.read + id: OAuthRequirements + description: >- + OAuth scopes are a way to define data and permissions on data. For + example, there are scopes defined for "Read-only access to Google + Calendar" and "Access to Cloud Platform". Users can consent to a scope + for an application, giving it permission to access that data on their + behalf. OAuth scope specifications should be fairly coarse grained; a + user will need to see and understand the text description of what your + scope means. In most cases: use one or at most two OAuth scopes for an + entire family of products. If your product has multiple APIs, you should + probably be sharing the OAuth scope across all of those APIs. When you + need finer grained OAuth consent screens: talk with your product + management about how developers will use them in practice. Please note + that even though each of the canonical scopes is enough for a request to + be accepted and passed to the backend, a request can still fail due to + the backend requiring additional scopes or permissions. + type: object + V1RefreshConsumerResponse: + type: object + properties: {} + id: V1RefreshConsumerResponse + description: >- + Response message for the `RefreshConsumer` method. This response message + is assigned to the `response` field of the returned Operation when that + operation is done. + CancelOperationRequest: + properties: {} + id: CancelOperationRequest + type: object + description: The request message for Operations.CancelOperation. Api: id: Api - description: >- - Api is a light-weight descriptor for an API Interface. Interfaces are - also described as "protocol buffer services" in some contexts, such as - by the "service" keyword in a .proto file, but they are different from - API Services, which represent a concrete implementation of an interface - as opposed to simply a description of methods and bindings. They are - also sometimes simply referred to as "APIs" in other contexts, such as - the name of this message itself. See - https://cloud.google.com/apis/design/glossary for detailed terminology. type: object properties: - methods: - type: array - items: - $ref: '#/components/schemas/Method' - description: The methods of this interface, in unspecified order. + syntax: + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS + description: The source syntax of the service. + enumDescriptions: + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. + type: string + name: + description: >- + The fully qualified name of this interface, including package name + followed by the interface's simple name. + type: string options: - description: Any metadata attached to the interface. + type: array items: $ref: '#/components/schemas/Option' + description: Any metadata attached to the interface. + methods: + items: + $ref: '#/components/schemas/Method' type: array + description: The methods of this interface, in unspecified order. + sourceContext: + $ref: '#/components/schemas/SourceContext' + description: >- + Source context for the protocol buffer service represented by this + message. version: description: >- A version string for this interface. If specified, must have the @@ -3013,339 +2985,420 @@ components: omitted. Zero major versions must only be used for experimental, non-GA interfaces. type: string - syntax: - enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. - type: string - description: The source syntax of the service. - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS - sourceContext: - $ref: '#/components/schemas/SourceContext' - description: >- - Source context for the protocol buffer service represented by this - message. mixins: description: Included interfaces. See Mixin. items: $ref: '#/components/schemas/Mixin' type: array + description: >- + Api is a light-weight descriptor for an API Interface. Interfaces are + also described as "protocol buffer services" in some contexts, such as + by the "service" keyword in a .proto file, but they are different from + API Services, which represent a concrete implementation of an interface + as opposed to simply a description of methods and bindings. They are + also sometimes simply referred to as "APIs" in other contexts, such as + the name of this message itself. See + https://cloud.google.com/apis/design/glossary for detailed terminology. + Aspect: + id: Aspect + properties: + spec: + description: >- + Content of the configuration. The underlying schema should be + defined by Aspect owners as protobuf message under + `google/api/configaspects/proto`. + additionalProperties: + type: any + description: Properties of the object. + type: object + kind: + type: string + description: The type of this aspect configuration. + type: object + description: >- + Aspect represents Generic aspect. It is used to configure an aspect + without making direct changes to service.proto + Operation: + type: object + description: >- + This resource represents a long-running operation that is the result of + a network API call. + properties: + error: + $ref: '#/components/schemas/Status' + description: >- + The error result of the operation in case of failure or + cancellation. + response: + type: object + description: >- + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + metadata: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + description: >- + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + type: object + name: + type: string + description: >- + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. + done: + type: boolean + description: >- + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + id: Operation + TenancyUnit: + id: TenancyUnit + type: object + properties: + tenantResources: + type: array + description: >- + Resources constituting the tenancy unit. There can be at most 512 + tenant resources in a tenancy unit. + items: + $ref: '#/components/schemas/TenantResource' + consumer: + type: string + description: >- + Output only. @OutputOnly Cloud resource name of the consumer of this + service. For example 'projects/123456'. + readOnly: true + service: + type: string + readOnly: true + description: >- + Output only. Google Cloud API name of the managed service owning + this tenancy unit. For example + 'serviceconsumermanagement.googleapis.com'. + createTime: + type: string + readOnly: true + description: Output only. @OutputOnly The time this tenancy unit was created. + format: google-datetime + name: + description: >- + Globally unique identifier of this tenancy unit + "services/{service}/{collection id}/{resource + id}/tenancyUnits/{unit}" + type: string + description: Representation of a tenancy unit. + MetricDescriptor: + type: object + properties: + launchStage: + type: string + enumDescriptions: + - Do not use this default value. + - The feature is not yet implemented. Users can not use it. + - >- + Prelaunch features are hidden from users and are only visible + internally. + - >- + Early Access features are limited to a closed group of testers. To + use these features, you must sign up in advance and sign a Trusted + Tester agreement (which includes confidentiality provisions). + These features may be unstable, changed in backward-incompatible + ways, and are not guaranteed to be released. + - >- + Alpha is a limited availability test for releases before they are + cleared for widespread use. By Alpha, all significant design + issues are resolved and we are in the process of verifying + functionality. Alpha customers need to apply for access, agree to + applicable terms, and have their projects allowlisted. Alpha + releases don't have to be feature complete, no SLAs are provided, + and there are no technical support obligations, but they will be + far enough along that customers can actually use them in test + environments or for limited-use tests -- just like they would in + normal production cases. + - >- + Beta is the point at which we are ready to open a release for any + customer to use. There are no SLA or technical support obligations + in a Beta release. Products will be complete from a feature + perspective, but may have some open outstanding issues. Beta + releases are suitable for limited production use cases. + - >- + GA features are open to all developers and are considered stable + and fully qualified for production use. + - >- + Deprecated features are scheduled to be shut down and removed. For + more information, see the "Deprecation Policy" section of our + [Terms of Service](https://cloud.google.com/terms/) and the + [Google Cloud Platform Subject to the Deprecation + Policy](https://cloud.google.com/terms/deprecation) documentation. + enum: + - LAUNCH_STAGE_UNSPECIFIED + - UNIMPLEMENTED + - PRELAUNCH + - EARLY_ACCESS + - ALPHA + - BETA + - GA + - DEPRECATED + description: Optional. The launch stage of the metric definition. + metricKind: + enum: + - METRIC_KIND_UNSPECIFIED + - GAUGE + - DELTA + - CUMULATIVE + type: string + enumDescriptions: + - Do not use this default value. + - An instantaneous measurement of a value. + - The change in a value during a time interval. + - >- + A value accumulated over a time interval. Cumulative measurements + in a time series should have the same start time and increasing + end times, until an event resets the cumulative value to zero and + sets a new start time for the following points. + description: >- + Whether the metric records instantaneous values, changes to a value, + etc. Some combinations of `metric_kind` and `value_type` might not + be supported. + unit: + description: >- + The units in which the metric value is reported. It is only + applicable if the `value_type` is `INT64`, `DOUBLE`, or + `DISTRIBUTION`. The `unit` defines the representation of the stored + metric values. Different systems might scale the values to be more + easily displayed (so a value of `0.02kBy` _might_ be displayed as + `20By`, and a value of `3523kBy` _might_ be displayed as `3.5MBy`). + However, if the `unit` is `kBy`, then the value of the metric is + always in thousands of bytes, no matter how it might be displayed. + If you want a custom metric to record the exact number of + CPU-seconds used by a job, you can create an `INT64 CUMULATIVE` + metric whose `unit` is `s{CPU}` (or equivalently `1s{CPU}` or just + `s`). If the job uses 12,005 CPU-seconds, then the value is written + as `12005`. Alternatively, if you want a custom metric to record + data in a more granular way, you can create a `DOUBLE CUMULATIVE` + metric whose `unit` is `ks{CPU}`, and then write the value `12.005` + (which is `12005/1000`), or use `Kis{CPU}` and write `11.723` (which + is `12005/1024`). The supported units are a subset of [The Unified + Code for Units of Measure](https://unitsofmeasure.org/ucum.html) + standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` + second * `min` minute * `h` hour * `d` day * `1` dimensionless + **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga + (10^9) * `T` tera (10^12) * `P` peta (10^15) * `E` exa (10^18) * `Z` + zetta (10^21) * `Y` yotta (10^24) * `m` milli (10^-3) * `u` micro + (10^-6) * `n` nano (10^-9) * `p` pico (10^-12) * `f` femto (10^-15) + * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto (10^-24) * `Ki` + kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) + * `Pi` pebi (2^50) **Grammar** The grammar also includes these + connectors: * `/` division or ratio (as an infix operator). For + examples, `kBy/{email}` or `MiBy/10ms` (although you should almost + never have `/s` in a metric `unit`; rates should always be computed + at query time from the underlying cumulative or delta value). * `.` + multiplication or composition (as an infix operator). For examples, + `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: + Expression = Component { "." Component } { "/" Component } ; + Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | + "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a + comment if it follows a `UNIT`. If the annotation is used alone, + then the unit is equivalent to `1`. For examples, `{request}/s == + 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of + non-blank printable ASCII characters not containing `{` or `}`. * + `1` represents a unitary [dimensionless + unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, + such as in `1/s`. It is typically used when none of the basic units + are appropriate. For example, "new users per day" can be represented + as `1/d` or `{new-users}/d` (and a metric value `5` would mean "5 + new users). Alternatively, "thousands of page views per day" would + be represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a + metric value of `5.3` would mean "5300 page views per day"). * `%` + represents dimensionless value of 1/100, and annotates values giving + a percentage (so the metric values are typically in the range of + 0..100, and a metric value `3` means "3 percent"). * `10^2.%` + indicates a metric contains a ratio, typically in the range 0..1, + that will be multiplied by 100 and displayed as a percentage (so a + metric value `0.03` means "3 percent"). + type: string name: + description: The resource name of the metric descriptor. type: string + labels: description: >- - The fully qualified name of this interface, including package name - followed by the interface's simple name. - MetricDescriptorMetadata: - properties: - timeSeriesResourceHierarchyLevel: - description: The scope of the timeseries data of the metric. - type: array + The set of labels that can be used to describe a specific instance + of this metric type. For example, the + `appengine.googleapis.com/http/server/response_latencies` metric + type has a label for the HTTP response code, `response_code`, so you + can look at latencies for successful responses or just for responses + that failed. items: - enumDescriptions: - - Do not use this default value. - - Scopes a metric to a project. - - Scopes a metric to an organization. - - Scopes a metric to a folder. - type: string - enum: - - TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED - - PROJECT - - ORGANIZATION - - FOLDER - samplePeriod: - format: google-duration - type: string - description: >- - The sampling period of metric data points. For metrics which are - written periodically, consecutive data points are stored at this - time interval, excluding data loss due to errors. Metrics with a - higher granularity have a smaller sampling period. - launchStage: + $ref: '#/components/schemas/LabelDescriptor' + type: array + valueType: enum: - - LAUNCH_STAGE_UNSPECIFIED - - UNIMPLEMENTED - - PRELAUNCH - - EARLY_ACCESS - - ALPHA - - BETA - - GA - - DEPRECATED - deprecated: true + - VALUE_TYPE_UNSPECIFIED + - BOOL + - INT64 + - DOUBLE + - STRING + - DISTRIBUTION + - MONEY + description: >- + Whether the measurement is an integer, a floating-point number, etc. + Some combinations of `metric_kind` and `value_type` might not be + supported. type: string - description: Deprecated. Must use the MetricDescriptor.launch_stage instead. enumDescriptions: - Do not use this default value. - - The feature is not yet implemented. Users can not use it. - - >- - Prelaunch features are hidden from users and are only visible - internally. - - >- - Early Access features are limited to a closed group of testers. To - use these features, you must sign up in advance and sign a Trusted - Tester agreement (which includes confidentiality provisions). - These features may be unstable, changed in backward-incompatible - ways, and are not guaranteed to be released. - - >- - Alpha is a limited availability test for releases before they are - cleared for widespread use. By Alpha, all significant design - issues are resolved and we are in the process of verifying - functionality. Alpha customers need to apply for access, agree to - applicable terms, and have their projects allowlisted. Alpha - releases don't have to be feature complete, no SLAs are provided, - and there are no technical support obligations, but they will be - far enough along that customers can actually use them in test - environments or for limited-use tests -- just like they would in - normal production cases. - - >- - Beta is the point at which we are ready to open a release for any - customer to use. There are no SLA or technical support obligations - in a Beta release. Products will be complete from a feature - perspective, but may have some open outstanding issues. Beta - releases are suitable for limited production use cases. - >- - GA features are open to all developers and are considered stable - and fully qualified for production use. + The value is a boolean. This value type can be used only if the + metric kind is `GAUGE`. + - The value is a signed 64-bit integer. + - The value is a double precision floating point number. - >- - Deprecated features are scheduled to be shut down and removed. For - more information, see the "Deprecation Policy" section of our - [Terms of Service](https://cloud.google.com/terms/) and the - [Google Cloud Platform Subject to the Deprecation - Policy](https://cloud.google.com/terms/deprecation) documentation. - ingestDelay: - format: google-duration - description: >- - The delay of data points caused by ingestion. Data points older than - this age are guaranteed to be ingested and available to be read, - excluding data loss due to errors. + The value is a text string. This value type can be used only if + the metric kind is `GAUGE`. + - The value is a `Distribution`. + - The value is money. + metadata: + description: Optional. Metadata which can be used to guide usage of the metric. + $ref: '#/components/schemas/MetricDescriptorMetadata' + displayName: type: string - type: object - id: MetricDescriptorMetadata - description: Additional annotations that can be used to guide the usage of a metric. - TenantProjectPolicy: - id: TenantProjectPolicy - properties: - policyBindings: - items: - $ref: '#/components/schemas/PolicyBinding' description: >- - Policy bindings to be applied to the tenant project, in addition to - the 'roles/owner' role granted to the Service Consumer Management - service account. + A concise name for the metric, which can be displayed in user + interfaces. Use sentence case without an ending period, for example + "Request count". This field is optional but it is recommended to be + set for any metrics associated with user-visible concepts, such as + Quota. + monitoredResourceTypes: + description: >- + Read-only. If present, then a time series, which is identified + partially by a metric type and a MonitoredResourceDescriptor, that + is associated with this metric type can only be associated with one + of the monitored resource types listed here. type: array - type: object - description: >- - Describes policy settings that can be applied to a newly created tenant - project. - V1Beta1ImportProducerQuotaPoliciesResponse: - description: Response message for ImportProducerQuotaPolicies - type: object - properties: - policies: - description: The policies that were created from the imported data. items: - $ref: '#/components/schemas/V1Beta1ProducerQuotaPolicy' - type: array - id: V1Beta1ImportProducerQuotaPoliciesResponse - V1GenerateServiceAccountResponse: - id: V1GenerateServiceAccountResponse - properties: - account: - $ref: '#/components/schemas/V1ServiceAccount' - description: ServiceAccount that was created or retrieved. - type: object - description: >- - Response message for the `GenerateServiceAccount` method. This response - message is assigned to the `response` field of the returned Operation - when that operation is done. - V1ServiceAccount: - type: object - description: A service account in the Identity and Access Management API. - id: V1ServiceAccount - properties: - uniqueId: - description: The unique and stable id of the service account. - type: string - iamAccountName: - type: string - description: Deprecated. See b/136209818. - deprecated: true - email: - description: The email address of the service account. + type: string + description: type: string - tag: description: >- - The P4 SA configuration tag. This must be defined in - activation_grants. If not specified when creating the account, the - tag is set to "default". - type: string - name: + A detailed description of the metric, which can be used in + documentation. + type: description: >- - P4 SA resource name. An example name would be: - `services/serviceconsumermanagement.googleapis.com/projects/123/serviceAccounts/default` + The metric type, including its DNS name prefix. The type is not + URL-encoded. All user-defined metric types have the DNS name + `custom.googleapis.com` or `external.googleapis.com`. Metric types + should use a natural hierarchical grouping. For example: + "custom.googleapis.com/invoice/paid/amount" + "external.googleapis.com/prometheus/up" + "appengine.googleapis.com/http/server/response_latencies" type: string - Authentication: - type: object description: >- - `Authentication` defines the authentication configuration for API - methods provided by an API service. Example: name: - calendar.googleapis.com authentication: providers: - id: - google_calendar_auth jwks_uri: - https://www.googleapis.com/oauth2/v1/certs issuer: - https://securetoken.google.com rules: - selector: "*" requirements: - provider_id: google_calendar_auth - selector: google.calendar.Delegate - oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read + Defines a metric type and its schema. Once a metric descriptor is + created, deleting or altering it stops data collection and makes the + metric type's existing data unusable. + id: MetricDescriptor + DotnetSettings: + type: object + description: Settings for Dotnet client libraries. + id: DotnetSettings properties: - providers: - items: - $ref: '#/components/schemas/AuthProvider' + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' + ignoredResources: type: array - description: Defines a set of authentication providers that a service supports. - rules: + items: + type: string description: >- - A list of authentication rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. + List of full resource types to ignore during generation. This is + typically used for API-specific Location resources, which should be + handled by the generator as if they were actually the common + Location resources. Example entry: + "documentai.googleapis.com/Location" + renamedResources: + additionalProperties: + type: string + type: object + description: >- + Map from full resource types to the effective short name for the + resource. This is used when otherwise resource named from different + services would cause naming collisions. Example entry: + "datalabeling.googleapis.com/Dataset": "DataLabelingDataset" + handwrittenSignatures: + description: >- + Method signatures (in the form "service.method(signature)") which + are provided separately, so shouldn't be generated. Snippets + *calling* these methods are still generated, however. items: - $ref: '#/components/schemas/AuthenticationRule' + type: string type: array - id: Authentication - V1AddVisibilityLabelsResponse: - properties: - labels: + forcedNamespaceAliases: type: array - description: >- - The updated set of visibility labels for this consumer on this - service. items: type: string - description: >- - Response message for the `AddVisibilityLabels` method. This response - message is assigned to the `response` field of the returned Operation - when that operation is done. - type: object - id: V1AddVisibilityLabelsResponse - BackendRule: - description: A backend rule provides configuration for an individual API element. - type: object - id: BackendRule - properties: - selector: - type: string description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. - overridesByRequestProtocol: + Namespaces which must be aliased in snippets due to a known (but + non-generator-predictable) naming collision + renamedServices: type: object additionalProperties: - $ref: '#/components/schemas/BackendRule' - description: The map between request protocol and the backend address. - disableAuth: - type: boolean - description: >- - When disable_auth is true, a JWT ID token won't be generated and the - original "Authorization" HTTP header will be preserved. If the - header is used to carry the original token and is expected by the - backend, this field must be set to true to preserve the header. - address: + type: string description: >- - The address of the API backend. The scheme is used to determine the - backend protocol and security. The following schemes are accepted: - SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// - gRPC None grpcs:// gRPC TLS It is recommended to explicitly include - a scheme. Leaving out the scheme may cause constrasting behaviors - across platforms. If the port is unspecified, the default is: - 80 - for schemes without TLS - 443 for schemes with TLS For HTTP - backends, use protocol to specify the protocol version. - type: string - jwtAudience: + Map from original service names to renamed versions. This is used + when the default generated types would cause a naming conflict. + (Neither name is fully-qualified.) Example: Subscriber to + SubscriberServiceApi. + Page: + description: >- + Represents a documentation page. A page can contain subpages to + represent nested documentation set structure. + type: object + id: Page + properties: + name: type: string description: >- - The JWT audience is used when generating a JWT ID token for the - backend. This ID token will be added in the HTTP "authorization" - header, and sent to the backend. - deadline: - format: double - type: number - description: >- - The number of seconds to wait for a response from a request. The - default varies based on the request protocol and deployment - environment. - operationDeadline: - format: double + The name of the page. It will be used as an identity of the page to + generate URI of the page, text of the link to this page in + navigation, etc. The full page name (start from the root page name + to this page concatenated with `.`) can be used as reference to the + page in your documentation. For example: pages: - name: Tutorial + content: (== include tutorial.md ==) subpages: - name: Java content: + (== include tutorial_java.md ==) You can reference `Java` page using + Markdown reference link syntax: `Java`. + content: description: >- - The number of seconds to wait for the completion of a long running - operation. The default is no deadline. - type: number - pathTranslation: - type: string - enumDescriptions: - - '' - - >- - Use the backend address as-is, with no modification to the path. - If the URL pattern contains variables, the variable names and - values will be appended to the query string. If a query string - parameter and a URL pattern variable have the same name, this may - result in duplicate keys in the query string. # Examples Given the - following operation config: Method path: - /api/company/{cid}/user/{uid} Backend address: - https://example.cloudfunctions.net/getUser Requests to the - following request paths will call the backend at the translated - path: Request path: /api/company/widgetworks/user/johndoe - Translated: - https://example.cloudfunctions.net/getUser?cid=widgetworks&uid=johndoe - Request path: /api/company/widgetworks/user/johndoe?timezone=EST - Translated: - https://example.cloudfunctions.net/getUser?timezone=EST&cid=widgetworks&uid=johndoe - - >- - The request path will be appended to the backend address. # - Examples Given the following operation config: Method path: - /api/company/{cid}/user/{uid} Backend address: - https://example.appspot.com Requests to the following request - paths will call the backend at the translated path: Request path: - /api/company/widgetworks/user/johndoe Translated: - https://example.appspot.com/api/company/widgetworks/user/johndoe - Request path: /api/company/widgetworks/user/johndoe?timezone=EST - Translated: - https://example.appspot.com/api/company/widgetworks/user/johndoe?timezone=EST - enum: - - PATH_TRANSLATION_UNSPECIFIED - - CONSTANT_ADDRESS - - APPEND_PATH_TO_ADDRESS - protocol: + The Markdown content of the page. You can use ```(== include {path} + ==)``` to include content from a Markdown file. The content can be + used to produce the documentation page such as HTML format page. type: string + subpages: + type: array + items: + $ref: '#/components/schemas/Page' description: >- - The protocol used for sending a request to the backend. The - supported values are "http/1.1" and "h2". The default value is - inferred from the scheme in the address field: SCHEME PROTOCOL - http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure - HTTP backends (https://) that support HTTP/2, set this field to "h2" - for improved performance. Configuring this field to non-default - values is only supported for secure HTTP backends. This field will - be ignored for all other backends. See - https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids - for more details on the supported values. - minDeadline: - format: double - type: number - deprecated: true - description: Deprecated, do not use. + Subpages of this page. The order of subpages specified here will be + honored in the generated docset. Billing: - properties: - consumerDestinations: - description: >- - Billing configurations for sending metrics to the consumer project. - There can be multiple consumer destinations per service, each one - must have a different monitored resource type. A metric can be used - in at most one consumer destination. - items: - $ref: '#/components/schemas/BillingDestination' - type: array - type: object id: Billing + type: object description: >- Billing related configuration of the service. The following example shows how to configure monitored resources and metrics for billing, @@ -3364,116 +3417,182 @@ components: value_type: INT64 unit: "1" billing: consumer_destinations: - monitored_resource: library.googleapis.com/billing_branch metrics: - library.googleapis.com/book/borrowed_count - CppSettings: - id: CppSettings properties: - common: - description: Some settings. - $ref: '#/components/schemas/CommonLanguageSettings' - type: object - description: Settings for C++ client libraries. - LogDescriptor: + consumerDestinations: + items: + $ref: '#/components/schemas/BillingDestination' + description: >- + Billing configurations for sending metrics to the consumer project. + There can be multiple consumer destinations per service, each one + must have a different monitored resource type. A metric can be used + in at most one consumer destination. + type: array + V1Beta1DisableConsumerResponse: + description: >- + Response message for the `DisableConsumer` method. This response message + is assigned to the `response` field of the returned Operation when that + operation is done. type: object + id: V1Beta1DisableConsumerResponse + properties: {} + LoggingDestination: + properties: + monitoredResource: + type: string + description: >- + The monitored resource type. The type must be defined in the + Service.monitored_resources section. + logs: + type: array + description: >- + Names of the logs to be sent to this destination. Each name must be + defined in the Service.logs section. If the log name is not a domain + scoped name, it will be automatically prefixed with the service name + followed by "/". + items: + type: string description: >- - A description of a log type. Example in YAML format: - name: - library.googleapis.com/activity_history description: The history of - borrowing and returning library items. display_name: Activity labels: - - key: /customer_id description: Identifier of a library customer + Configuration of a specific logging destination (the producer project or + the consumer project). + id: LoggingDestination + type: object + CommonLanguageSettings: + type: object properties: - labels: + destinations: description: >- - The set of labels that are available to describe a specific log - entry. Runtime requests that contain labels not specified here are - considered invalid. + The destination where API teams want this client library to be + published. type: array items: - $ref: '#/components/schemas/LabelDescriptor' - description: + enum: + - CLIENT_LIBRARY_DESTINATION_UNSPECIFIED + - GITHUB + - PACKAGE_MANAGER + enumDescriptions: + - >- + Client libraries will neither be generated nor published to + package managers. + - >- + Generate the client library in a repo under + github.com/googleapis, but don't publish it to package managers. + - >- + Publish the library to package managers like nuget.org and + npmjs.com. + type: string + selectiveGapicGeneration: description: >- - A human-readable description of this log. This information appears - in the documentation and can contain details. + Configuration for which RPCs should be generated in the GAPIC + client. + $ref: '#/components/schemas/SelectiveGapicGeneration' + referenceDocsUri: + description: >- + Link to automatically generated reference documentation. Example: + https://cloud.google.com/nodejs/docs/reference/asset/latest + deprecated: true + type: string + description: Required information for every language. + id: CommonLanguageSettings + V1Beta1GenerateServiceIdentityResponse: + type: object + id: V1Beta1GenerateServiceIdentityResponse + properties: + identity: + description: ServiceIdentity that was created or retrieved. + $ref: '#/components/schemas/V1Beta1ServiceIdentity' + description: >- + Response message for the `GenerateServiceIdentity` method. This response + message is assigned to the `response` field of the returned Operation + when that operation is done. + DeleteTenantProjectRequest: + id: DeleteTenantProjectRequest + type: object + properties: + tag: + type: string + description: Required. Tag of the resource within the tenancy unit. + description: Request message to delete tenant project resource from the tenancy unit. + V1GenerateDefaultIdentityResponse: + id: V1GenerateDefaultIdentityResponse + description: >- + Response message for the `GenerateDefaultIdentity` method. This response + message is assigned to the `response` field of the returned Operation + when that operation is done. + properties: + role: type: string - name: description: >- - The name of the log. It must be less than 512 characters long and - can include the following characters: upper- and lower-case - alphanumeric characters [A-Za-z0-9], and punctuation characters - including slash, underscore, hyphen, period [/_-.]. - type: string - displayName: + Role attached to consumer project. Empty if not attached in this + request. (Under development, currently always return empty.) + identity: + $ref: '#/components/schemas/V1DefaultIdentity' + description: DefaultIdentity that was created or retrieved. + attachStatus: type: string + enumDescriptions: + - Indicates that the AttachStatus was not set. + - >- + The default identity was attached to a role successfully in this + request. + - >- + The request specified that no attempt should be made to attach the + role. + - >- + Role was attached to the consumer project at some point in time. + Tenant manager doesn't make assertion about the current state of + the identity with respect to the consumer. Role attachment should + happen only once after activation and cannot be reattached after + customer removes it. (go/si-attach-role) + - >- + Role attachment was denied in this request by customer set org + policy. (go/si-attach-role) description: >- - The human-readable name for this log. This information appears on - the user interface and should be concise. - id: LogDescriptor - V1Beta1BatchCreateProducerOverridesResponse: + Status of the role attachment. Under development + (go/si-attach-role), currently always return + ATTACH_STATUS_UNSPECIFIED) + enum: + - ATTACH_STATUS_UNSPECIFIED + - ATTACHED + - ATTACH_SKIPPED + - PREVIOUSLY_ATTACHED + - ATTACH_DENIED_BY_ORG_POLICY + type: object + NodeSettings: + description: Settings for Node client libraries. type: object + id: NodeSettings properties: - overrides: - items: - $ref: '#/components/schemas/V1Beta1QuotaOverride' - type: array - description: The overrides that were created. - description: Response message for BatchCreateProducerOverrides - id: V1Beta1BatchCreateProducerOverridesResponse - MethodSettings: - description: Describes the generator configuration for a method. - id: MethodSettings + common: + $ref: '#/components/schemas/CommonLanguageSettings' + description: Some settings. + Option: + id: Option + description: >- + A protocol buffer option, which can be attached to a message, field, + enumeration, etc. + type: object properties: - selector: + value: + type: object description: >- - The fully qualified name of the method, for which the options below - apply. This is used to find the method to apply the options. - Example: publishing: method_settings: - selector: - google.storage.control.v2.StorageControl.CreateFolder # method - settings for CreateFolder... + The option's value packed in an Any message. If the value is a + primitive, the corresponding wrapper type defined in + google/protobuf/wrappers.proto should be used. If the value is an + enum, it should be stored as an int32 value using the + google.protobuf.Int32Value type. + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + name: type: string - longRunning: - $ref: '#/components/schemas/LongRunning' - description: >- - Describes settings to use for long-running operations when - generating API methods for RPCs. Complements RPCs that use the - annotations in google/longrunning/operations.proto. Example of a - YAML configuration:: publishing: method_settings: - selector: - google.cloud.speech.v2.Speech.BatchRecognize long_running: - initial_poll_delay: 60s # 1 minute poll_delay_multiplier: 1.5 - max_poll_delay: 360s # 6 minutes total_poll_timeout: 54000s # 90 - minutes - autoPopulatedFields: description: >- - List of top-level fields of the request message, that should be - automatically populated by the client libraries based on their - (google.api.field_info).format. Currently supported format: UUID4. - Example of a YAML configuration: publishing: method_settings: - - selector: google.example.v1.ExampleService.CreateExample - auto_populated_fields: - request_id - type: array - items: - type: string - type: object + The option's name. For protobuf built-in options (options defined in + descriptor.proto), this is the short name. For example, + `"map_entry"`. For custom options, it should be the fully-qualified + name. For example, `"google.api.http"`. Status: type: object - properties: - details: - type: array - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - items: - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - code: - format: int32 - type: integer - description: The status code, which should be an enum value of google.rpc.Code. - message: - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - type: string + id: Status description: >- The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It @@ -3482,120 +3601,105 @@ components: details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - id: Status - CancelOperationRequest: - type: object - description: The request message for Operations.CancelOperation. - id: CancelOperationRequest - properties: {} - Enum: - id: Enum - type: object - description: Enum type definition. properties: - options: - type: array - description: Protocol buffer options. - items: - $ref: '#/components/schemas/Option' - edition: - description: >- - The source edition string, only valid when syntax is - SYNTAX_EDITIONS. - type: string - syntax: + message: type: string - enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS - description: The source syntax. - enumvalue: - items: - $ref: '#/components/schemas/EnumValue' + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + code: + description: The status code, which should be an enum value of google.rpc.Code. + type: integer + format: int32 + details: + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. type: array - description: Enum value definitions. - sourceContext: - $ref: '#/components/schemas/SourceContext' - description: The source context. - name: - description: Enum type name. - type: string - FieldPolicy: - id: FieldPolicy - description: >- - Google API Policy Annotation This message defines a simple API policy - annotation that can be used to annotate API request and response message - fields with applicable policies. One field may have multiple applicable - policies that must all be satisfied before a request can be processed. - This policy annotation is used to generate the overall policy that will - be used for automatic runtime policy enforcement and documentation - generation. + items: + type: object + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + SystemParameterRule: type: object + description: >- + Define a system parameter rule mapping system parameter definitions to + methods. + id: SystemParameterRule properties: - resourceType: - description: >- - Specifies the resource type for the resource referred to by the - field. - type: string selector: - type: string - description: >- - Selects one or more request or response message fields to apply this - `FieldPolicy`. When a `FieldPolicy` is used in proto annotation, the - selector must be left as empty. The service config generator will - automatically fill the correct value. When a `FieldPolicy` is used - in service config, the selector must be a comma-separated string - with valid request or response field paths, such as "foo.bar" or - "foo.bar,foo.baz". - resourcePermission: description: >- - Specifies the required permission(s) for the resource referred to by - the field. It requires the field contains a valid resource - reference, and the request must pass the permission checks to - proceed. For example, "resourcemanager.projects.get". + Selects the methods to which this rule applies. Use '*' to indicate + all methods in all APIs. Refer to selector for syntax details. type: string - PythonSettings: - type: object - properties: - experimentalFeatures: + parameters: + items: + $ref: '#/components/schemas/SystemParameter' description: >- - Experimental features to be included during client library - generation. - $ref: '#/components/schemas/ExperimentalFeatures' - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - description: Settings for Python client libraries. - id: PythonSettings - MonitoringDestination: - description: >- - Configuration of a specific monitoring destination (the producer project - or the consumer project). - id: MonitoringDestination + Define parameters. Multiple names may be defined for a parameter. + For a given method call, only one of them should be used. If + multiple names are used the behavior is implementation-dependent. If + none of the specified names are present the behavior is + parameter-dependent. + type: array + Enum: + id: Enum + description: Enum type definition. properties: - metrics: + syntax: + type: string + enumDescriptions: + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. + description: The source syntax. + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS + options: + description: Protocol buffer options. + type: array items: - type: string + $ref: '#/components/schemas/Option' + name: + description: Enum type name. + type: string + sourceContext: + description: The source context. + $ref: '#/components/schemas/SourceContext' + edition: + type: string description: >- - Types of the metrics to report to this monitoring destination. Each - type must be defined in Service.metrics section. + The source edition string, only valid when syntax is + SYNTAX_EDITIONS. + enumvalue: + description: Enum value definitions. type: array - monitoredResource: - description: >- - The monitored resource type. The type must be defined in - Service.monitored_resources section. - type: string + items: + $ref: '#/components/schemas/EnumValue' + type: object + ListTenancyUnitsResponse: + description: Response for the list request. + id: ListTenancyUnitsResponse type: object + properties: + tenancyUnits: + description: Tenancy units matching the request. + type: array + items: + $ref: '#/components/schemas/TenancyUnit' + nextPageToken: + type: string + description: Pagination token for large results. AttachTenantProjectRequest: - id: AttachTenantProjectRequest description: >- Request to attach an existing project to the tenancy unit as a new tenant resource. + type: object + id: AttachTenantProjectRequest properties: reservedResource: description: >- @@ -3610,25 +3714,109 @@ components: `projects/{project_number}`. type: string tag: + type: string description: >- Required. Tag of the tenant resource after attachment. Must be less than 128 characters. Required. - type: string - type: object - SourceInfo: - description: Source information used to create a Service Config - id: SourceInfo + QuotaLimit: + description: >- + `QuotaLimit` defines a specific limit that applies over a specified + duration for a limit type. There can be at most one limit for a duration + and limit type combination defined within a `QuotaGroup`. type: object properties: - sourceFiles: - type: array - description: All files used during config generation. - items: - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. + defaultLimit: + format: int64 + type: string + description: >- + Default number of tokens that can be consumed during the specified + duration. This is the number of tokens assigned when a client + application developer activates the service for his/her project. + Specifying a value of 0 will block all requests. This can be used if + you are provisioning quota to selected consumers and blocking + others. Similarly, a value of -1 will indicate an unlimited quota. + No other negative values are allowed. Used by group-based quotas + only. + duration: + type: string + description: >- + Duration of this limit in textual notation. Must be "100s" or "1d". + Used by group-based quotas only. + freeTier: + format: int64 + type: string + description: >- + Free tier value displayed in the Developers Console for this limit. + The free tier is the number of tokens that will be subtracted from + the billed amount when billing is enabled. This field can only be + set on a limit with duration "1d", in a billable group; it is + invalid on any other limit. If this field is not set, it defaults to + 0, indicating that there is no free tier for this service. Used by + group-based quotas only. + unit: + description: >- + Specify the unit of the quota limit. It uses the same syntax as + MetricDescriptor.unit. The supported unit kinds are determined by + the quota backend system. Here are some examples: * + "1/min/{project}" for quota per minute per project. Note: the order + of unit components is insignificant. The "1" at the beginning is + required to follow the metric unit syntax. + type: string + values: + additionalProperties: + type: string + format: int64 + type: object + description: >- + Tiered limit values. You must specify this as a key:value pair, with + an integer value that is the maximum number of requests allowed for + the specified unit. Currently only STANDARD is supported. + description: + type: string + description: >- + Optional. User-visible, extended description for this quota limit. + Should be used only when more context is needed to understand this + limit than provided by the limit's display name (see: + `display_name`). + metric: + description: >- + The name of the metric this quota limit applies to. The quota limits + with the same metric will be checked together during runtime. The + metric must be defined within the service config. + type: string + name: + description: >- + Name of the quota limit. The name must be provided, and it must be + unique within the service. The name can only include alphanumeric + characters as well as '-'. The maximum length of the limit name is + 64 characters. + type: string + displayName: + description: >- + User-visible display name for this limit. Optional. If not set, the + UI will provide a default display name based on the quota + configuration. This field can be used to override the default + display name generated from the configuration. + type: string + maxLimit: + description: >- + Maximum number of tokens that can be consumed during the specified + duration. Client application developers can override the default + limit up to this maximum. If specified, this value cannot be set to + a value less than the default limit. If not specified, it is set to + the default limit. To allow clients to apply overrides with no upper + bound, set this to -1, indicating unlimited maximum quota. Used by + group-based quotas only. + type: string + format: int64 + id: QuotaLimit parameters: + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string alt: description: Data format for response. in: query @@ -3639,16 +3827,10 @@ components: - json - media - proto - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string - access_token: - description: OAuth access token. + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: access_token + name: fields schema: type: string oauth_token: @@ -3657,40 +3839,40 @@ components: name: oauth_token schema: type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + 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: uploadType + name: key schema: type: string - fields: - description: Selector specifying which fields to include in a partial response. + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: fields + name: upload_protocol schema: type: string - callback: - description: JSONP + 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: callback + name: quotaUser schema: type: string - _.xgafv: - description: V1 error format. + callback: + description: JSONP in: query - name: $.xgafv + name: callback schema: type: string - enum: - - '1' - - '2' - 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. + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: key + name: uploadType schema: type: string prettyPrint: @@ -3699,16 +3881,55 @@ components: 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. + _.xgafv: + description: V1 error format. in: query - name: quotaUser + name: $.xgafv schema: type: string + enum: + - '1' + - '2' x-stackQL-resources: + operations: + id: google.serviceconsumermanagement.operations + name: operations + title: Operations + methods: + get: + operation: + $ref: '#/paths/~1v1~1operations~1{operationsId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1v1~1operations~1{operationsId}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + cancel: + operation: + $ref: '#/paths/~1v1~1operations~1{operationsId}:cancel/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1v1~1operations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.operations + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' + insert: [] + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/operations/methods/delete' services: id: google.serviceconsumermanagement.services name: services @@ -3731,6 +3952,13 @@ components: name: tenancy_units title: Tenancy_units methods: + delete: + operation: + $ref: >- + #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits~1{tenancyUnitsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' list: operation: $ref: >- @@ -3753,13 +3981,6 @@ components: response: mediaType: application/json openAPIDocKey: '200' - undelete_project: - operation: - $ref: >- - #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits~1{tenancyUnitsId}:undeleteProject/post - response: - mediaType: application/json - openAPIDocKey: '200' attach_project: operation: $ref: >- @@ -3767,10 +3988,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete: + undelete_project: operation: $ref: >- - #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits~1{tenancyUnitsId}/delete + #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits~1{tenancyUnitsId}:undeleteProject/post response: mediaType: application/json openAPIDocKey: '200' @@ -3795,17 +4016,17 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_project: + add_project: operation: $ref: >- - #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits~1{tenancyUnitsId}:deleteProject/post + #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits~1{tenancyUnitsId}:addProject/post response: mediaType: application/json openAPIDocKey: '200' - add_project: + delete_project: operation: $ref: >- - #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits~1{tenancyUnitsId}:addProject/post + #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits~1{tenancyUnitsId}:deleteProject/post response: mediaType: application/json openAPIDocKey: '200' @@ -3821,59 +4042,141 @@ components: #/components/x-stackQL-resources/tenancy_units_project/methods/remove_project - $ref: >- #/components/x-stackQL-resources/tenancy_units_project/methods/delete_project - operations: - id: google.serviceconsumermanagement.operations - name: operations - title: Operations - methods: - delete: - operation: - $ref: '#/paths/~1v1~1operations~1{operationsId}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: '#/paths/~1v1~1operations~1{operationsId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - cancel: - operation: - $ref: '#/paths/~1v1~1operations~1{operationsId}:cancel/post' - response: - mediaType: application/json - openAPIDocKey: '200' - list: - operation: - $ref: '#/paths/~1v1~1operations/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.operations - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - insert: [] - update: [] - replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' paths: - /v1/services/{servicesId}:search: + /v1/operations/{operationsId}: parameters: &ref_1 - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/_.xgafv' + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: serviceconsumermanagement.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: operationsId + required: true + schema: + type: string + delete: + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: serviceconsumermanagement.operations.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/operations/{operationsId}:cancel: + parameters: *ref_1 + post: + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + `1`, corresponding to `Code.CANCELLED`. + operationId: serviceconsumermanagement.operations.cancel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CancelOperationRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: serviceconsumermanagement.operations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListOperationsResponse' + parameters: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1/services/{servicesId}:search: + parameters: *ref_1 get: description: Search tenancy units for a managed service. operationId: serviceconsumermanagement.services.search @@ -3908,16 +4211,13 @@ paths: name: pageToken schema: type: string - /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits: + /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}: parameters: *ref_1 - get: + delete: description: >- - Find the tenancy unit for a managed service and service consumer. This - method shouldn't be used in a service producer's runtime path, for - example to find the tenant project number when creating VMs. Service - producers must persist the tenant project's information after the - project is created. - operationId: serviceconsumermanagement.services.tenancyUnits.list + Delete a tenancy unit. Before you delete the tenancy unit, there should + be no tenant resources in it that aren't in a DELETED state. Operation. + operationId: serviceconsumermanagement.services.tenancyUnits.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3929,7 +4229,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListTenancyUnitsResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: servicesId @@ -3946,31 +4246,21 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - post: - description: >- - Creates a tenancy unit with no tenant resources. If tenancy unit already - exists, it will be returned, however, in this case, returned TenancyUnit - does not have tenant_resources field set and ListTenancyUnits has to be - used to get a complete TenancyUnit with all fields populated. - operationId: serviceconsumermanagement.services.tenancyUnits.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CreateTenancyUnitRequest' + - in: path + name: tenancyUnitsId + required: true + schema: + type: string + /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits: + parameters: *ref_1 + get: + description: >- + Find the tenancy unit for a managed service and service consumer. This + method shouldn't be used in a service producer's runtime path, for + example to find the tenant project number when creating VMs. Service + producers must persist the tenant project's information after the + project is created. + operationId: serviceconsumermanagement.services.tenancyUnits.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3982,7 +4272,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TenancyUnit' + $ref: '#/components/schemas/ListTenancyUnitsResponse' parameters: - in: path name: servicesId @@ -3999,23 +4289,31 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:removeProject: - parameters: *ref_1 + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string post: description: >- - Removes the specified project resource identified by a tenant resource - tag. The method removes the project lien with 'TenantManager' origin if - that was added. It then attempts to delete the project. If that - operation fails, this method also fails. Calls to remove already removed - or non-existent tenant project succeed. After the project has been - deleted, or if was already in a DELETED state, resource metadata is - permanently removed from the tenancy unit. Operation. - operationId: serviceconsumermanagement.services.tenancyUnits.removeProject + Creates a tenancy unit with no tenant resources. If tenancy unit already + exists, it will be returned, however, in this case, returned TenancyUnit + does not have tenant_resources field set and ListTenancyUnits has to be + used to get a complete TenancyUnit with all fields populated. + operationId: serviceconsumermanagement.services.tenancyUnits.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/RemoveTenantProjectRequest' + $ref: '#/components/schemas/CreateTenancyUnitRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4027,7 +4325,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/TenancyUnit' parameters: - in: path name: servicesId @@ -4044,11 +4342,6 @@ paths: required: true schema: type: string - - in: path - name: tenancyUnitsId - required: true - schema: - type: string /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:applyProjectConfig: parameters: *ref_1 post: @@ -4106,24 +4399,26 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:deleteProject: + /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:attachProject: parameters: *ref_1 post: description: >- - Deletes the specified project resource identified by a tenant resource - tag. The mothod removes a project lien with a 'TenantManager' origin if - that was added. It will then attempt to delete the project. If that - operation fails, this method also fails. After the project has been - deleted, the tenant resource state is set to DELETED. To permanently - remove resource metadata, call the `RemoveTenantProject` method. New - resources with the same tag can't be added if there are existing - resources in a DELETED state. Operation. - operationId: serviceconsumermanagement.services.tenancyUnits.deleteProject + Attach an existing project to the tenancy unit as a new tenant resource. + The project could either be the tenant project reserved by calling + `AddTenantProject` under a tenancy unit of a service producer's project + of a managed service, or from a separate project. The caller is checked + against a set of permissions as if calling `AddTenantProject` on the + same service consumer. To trigger the attachment, the targeted tenant + project must be in a folder. Make sure the ServiceConsumerManagement + service account is the owner of that project. These two requirements are + already met if the project is reserved by calling `AddTenantProject`. + Operation. + operationId: serviceconsumermanagement.services.tenancyUnits.attachProject requestBody: content: application/json: schema: - $ref: '#/components/schemas/DeleteTenantProjectRequest' + $ref: '#/components/schemas/AttachTenantProjectRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4157,21 +4452,23 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:undeleteProject: + /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:removeProject: parameters: *ref_1 post: description: >- - Attempts to undelete a previously deleted tenant project. The project - must be in a DELETED state. There are no guarantees that an undeleted - project will be in a fully restored and functional state. Call the - `ApplyTenantProjectConfig` method to update its configuration and then - validate all managed service resources. Operation. - operationId: serviceconsumermanagement.services.tenancyUnits.undeleteProject + Removes the specified project resource identified by a tenant resource + tag. The method removes the project lien with 'TenantManager' origin if + that was added. It then attempts to delete the project. If that + operation fails, this method also fails. Calls to remove already removed + or non-existent tenant project succeed. After the project has been + deleted, or if was already in a DELETED state, resource metadata is + permanently removed from the tenancy unit. Operation. + operationId: serviceconsumermanagement.services.tenancyUnits.removeProject requestBody: content: application/json: schema: - $ref: '#/components/schemas/UndeleteTenantProjectRequest' + $ref: '#/components/schemas/RemoveTenantProjectRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4205,26 +4502,21 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:attachProject: + /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:undeleteProject: parameters: *ref_1 post: description: >- - Attach an existing project to the tenancy unit as a new tenant resource. - The project could either be the tenant project reserved by calling - `AddTenantProject` under a tenancy unit of a service producer's project - of a managed service, or from a separate project. The caller is checked - against a set of permissions as if calling `AddTenantProject` on the - same service consumer. To trigger the attachment, the targeted tenant - project must be in a folder. Make sure the ServiceConsumerManagement - service account is the owner of that project. These two requirements are - already met if the project is reserved by calling `AddTenantProject`. - Operation. - operationId: serviceconsumermanagement.services.tenancyUnits.attachProject + Attempts to undelete a previously deleted tenant project. The project + must be in a DELETED state. There are no guarantees that an undeleted + project will be in a fully restored and functional state. Call the + `ApplyTenantProjectConfig` method to update its configuration and then + validate all managed service resources. Operation. + operationId: serviceconsumermanagement.services.tenancyUnits.undeleteProject requestBody: content: application/json: schema: - $ref: '#/components/schemas/AttachTenantProjectRequest' + $ref: '#/components/schemas/UndeleteTenantProjectRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4306,13 +4598,24 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}: + /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:deleteProject: parameters: *ref_1 - delete: + post: description: >- - Delete a tenancy unit. Before you delete the tenancy unit, there should - be no tenant resources in it that aren't in a DELETED state. Operation. - operationId: serviceconsumermanagement.services.tenancyUnits.delete + Deletes the specified project resource identified by a tenant resource + tag. The mothod removes a project lien with a 'TenantManager' origin if + that was added. It will then attempt to delete the project. If that + operation fails, this method also fails. After the project has been + deleted, the tenant resource state is set to DELETED. To permanently + remove resource metadata, call the `RemoveTenantProject` method. New + resources with the same tag can't be added if there are existing + resources in a DELETED state. Operation. + operationId: serviceconsumermanagement.services.tenancyUnits.deleteProject + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteTenantProjectRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4346,124 +4649,3 @@ paths: required: true schema: type: string - /v1/operations/{operationsId}: - parameters: *ref_1 - delete: - description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: serviceconsumermanagement.operations.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Empty' - parameters: - - in: path - name: operationsId - required: true - schema: - type: string - get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: serviceconsumermanagement.operations.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: operationsId - required: true - schema: - type: string - /v1/operations/{operationsId}:cancel: - parameters: *ref_1 - post: - description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: serviceconsumermanagement.operations.cancel - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CancelOperationRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Empty' - parameters: - - in: path - name: operationsId - required: true - schema: - type: string - /v1/operations: - parameters: *ref_1 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: serviceconsumermanagement.operations.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/ListOperationsResponse' - parameters: - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 diff --git a/providers/src/googleapis.com/v00.00.00000/services/servicecontrol.yaml b/providers/src/googleapis.com/v00.00.00000/services/servicecontrol.yaml index 9d01fd59..44158944 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/servicecontrol.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/servicecontrol.yaml @@ -9,8 +9,8 @@ info: Provides admission control and telemetry reporting for services integrated with Service Infrastructure. version: v2 - x-discovery-doc-revision: '20241024' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250711' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/service-control/ servers: @@ -222,6 +222,13 @@ components: requests. Derived from the HTTP request `Authorization` header or equivalent. $ref: '#/components/schemas/Auth' + origin: + description: >- + The values from Origin header from the HTTP request, such as + "https://console.cloud.google.com". Modern browsers can only have + one origin. Special browsers and/or HTTP clients may require + multiple origins. + type: string Auth: id: Auth description: >- @@ -289,13 +296,6 @@ components: type: array items: type: string - credentialId: - description: >- - Identifies the client credential id used for authentication. - credential_id is in the format of AUTH_METHOD:IDENTIFIER, e.g. - "serviceaccount:XXXXX, apikey:XXXXX" where the format of the - IDENTIFIER can vary for different AUTH_METHODs. - type: string Response: id: Response description: >- @@ -506,6 +506,15 @@ components: type: object additionalProperties: type: string + dynamicMetadata: + description: >- + Optional response metadata that will be emitted as dynamic metadata + to be consumed by the caller of ServiceController. For compatibility + with the ext_authz interface. + type: object + additionalProperties: + type: any + description: Properties of the object. Status: id: Status description: >- @@ -1209,7 +1218,7 @@ components: referer: description: >- The referer URL of the request, as defined in [HTTP/1.1 Header Field - Definitions](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). + Definitions](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). type: string latency: description: >- @@ -1490,7 +1499,6 @@ paths: - $ref: '#/components/parameters/_.xgafv' post: description: >- - Private Preview. This feature is only available for approved services. This method provides admission control for services that are integrated with [Service Infrastructure](https://cloud.google.com/service-infrastructure). It @@ -1538,7 +1546,6 @@ paths: parameters: *ref_1 post: description: >- - Private Preview. This feature is only available for approved services. This method provides telemetry reporting for services that are integrated with [Service Infrastructure](https://cloud.google.com/service-infrastructure). It diff --git a/providers/src/googleapis.com/v00.00.00000/services/servicedirectory.yaml b/providers/src/googleapis.com/v00.00.00000/services/servicedirectory.yaml index c28aff84..e1e2c741 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/servicedirectory.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/servicedirectory.yaml @@ -9,8 +9,8 @@ info: Service Directory is a platform for discovering, publishing, and connecting services. version: v1 - x-discovery-doc-revision: '20241017' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250811' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/service-directory servers: @@ -996,6 +996,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: diff --git a/providers/src/googleapis.com/v00.00.00000/services/servicemanagement.yaml b/providers/src/googleapis.com/v00.00.00000/services/servicemanagement.yaml index 9cb72ef2..da7de044 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/servicemanagement.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/servicemanagement.yaml @@ -10,8 +10,8 @@ info: on Google Cloud Platform so that they can be discovered and used by service consumers. version: v1 - x-discovery-doc-revision: '20241023' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250617' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/service-management/ servers: @@ -344,6 +344,16 @@ components: type: array items: $ref: '#/components/schemas/Type' + aspects: + description: >- + Configuration aspects. This is a repeated field to allow multiple + aspects to be configured. The kind field in each ConfigAspect + specifies the type of aspect. The spec field contains the + configuration for that aspect. The schema for the spec field is + defined by the backend service owners. + type: array + items: + $ref: '#/components/schemas/Aspect' configVersion: description: >- Obsolete. Do not use. This field has no semantic meaning. The @@ -802,11 +812,17 @@ components: include overview.md ==) Note: you cannot specify both `overview` field and `pages` field. type: string + additionalIamInfo: + description: >- + Optional information about the IAM configuration. This is typically + used to link to documentation about a product's IAM roles and + permissions. + type: string sectionOverrides: description: >- - Specifies section and content to override boilerplate content - provided by go/api-docgen. Currently overrides following sections: - 1. rest.service.client_libraries + Specifies section and content to override the boilerplate content. + Currently overrides following sections: 1. + rest.service.client_libraries type: array items: $ref: '#/components/schemas/Page' @@ -830,9 +846,9 @@ components: type: string content: description: >- - The Markdown content of the page. You can use (== include {path} ==) - to include content from a Markdown file. The content can be used to - produce the documentation page such as HTML format page. + The Markdown content of the page. You can use ```(== include {path} + ==)``` to include content from a Markdown file. The content can be + used to produce the documentation page such as HTML format page. type: string subpages: description: >- @@ -872,7 +888,7 @@ components: disableReplacementWords: description: >- String of comma or space separated case-sensitive words for which - method/field name replacement will be disabled by go/api-docgen. + method/field name replacement will be disabled. type: string Backend: id: Backend @@ -992,6 +1008,14 @@ components: type: object additionalProperties: $ref: '#/components/schemas/BackendRule' + loadBalancingPolicy: + description: >- + The load balancing policy used for connection to the application + backend. Defined as an arbitrary string to accomondate custom load + balancing policies supported by the underlying channel, but suggest + most users use one of the standard policies, such as the default, + "RoundRobin". + type: string Http: id: Http description: >- @@ -1339,11 +1363,11 @@ components: unit: description: >- Specify the unit of the quota limit. It uses the same syntax as - Metric.unit. The supported unit kinds are determined by the quota - backend system. Here are some examples: * "1/min/{project}" for - quota per minute per project. Note: the order of unit components is - insignificant. The "1" at the beginning is required to follow the - metric unit syntax. + MetricDescriptor.unit. The supported unit kinds are determined by + the quota backend system. Here are some examples: * + "1/min/{project}" for quota per minute per project. Note: the order + of unit components is insignificant. The "1" at the beginning is + required to follow the metric unit syntax. type: string values: description: >- @@ -1691,18 +1715,7 @@ components: type: string UsageRule: id: UsageRule - description: >- - Usage configuration rules for the service. NOTE: Under development. Use - this rule to configure unregistered calls for the service. Unregistered - calls are calls that do not contain consumer project identity. (Example: - calls that do not contain an API key). By default, API methods do not - allow unregistered calls, and each method call must be identified by a - consumer project identity. Use this rule to allow/disallow unregistered - calls. Example of an API that wants to allow unregistered calls for - entire service. usage: rules: - selector: "*" allow_unregistered_calls: - true Example of a method that wants to allow unregistered calls. usage: - rules: - selector: "google.example.library.v1.LibraryService.CreateBook" - allow_unregistered_calls: true + description: Usage configuration rules for the service. type: object properties: selector: @@ -1711,9 +1724,7 @@ components: all methods in all APIs. Refer to selector for syntax details. type: string allowUnregisteredCalls: - description: >- - If true, the selected method allows unregistered calls, e.g. calls - that don't identify any user or application. + description: ' Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity.' type: boolean skipServiceControl: description: >- @@ -2719,6 +2730,14 @@ components: type: array items: type: string + batching: + description: >- + Batching configuration for an API method in client libraries. + Example of a YAML configuration: publishing: method_settings: - + selector: google.example.v1.ExampleService.BatchCreateExample + batching: element_count_threshold: 1000 request_byte_threshold: + 100000000 delay_threshold_millis: 10 + $ref: '#/components/schemas/BatchingConfigProto' LongRunning: id: LongRunning description: >- @@ -2750,6 +2769,106 @@ components: description: 'Total polling timeout. Default value: 5 minutes.' type: string format: google-duration + BatchingConfigProto: + id: BatchingConfigProto + description: >- + `BatchingConfigProto` defines the batching configuration for an API + method. + type: object + properties: + thresholds: + description: The thresholds which trigger a batched request to be sent. + $ref: '#/components/schemas/BatchingSettingsProto' + batchDescriptor: + description: The request and response fields used in batching. + $ref: '#/components/schemas/BatchingDescriptorProto' + BatchingSettingsProto: + id: BatchingSettingsProto + description: >- + `BatchingSettingsProto` specifies a set of batching thresholds, each of + which acts as a trigger to send a batch of messages as a request. At + least one threshold must be positive nonzero. + type: object + properties: + elementCountThreshold: + description: >- + The number of elements of a field collected into a batch which, if + exceeded, causes the batch to be sent. + type: integer + format: int32 + requestByteThreshold: + description: >- + The aggregated size of the batched field which, if exceeded, causes + the batch to be sent. This size is computed by aggregating the sizes + of the request field to be batched, not of the entire request + message. + type: string + format: int64 + delayThreshold: + description: >- + The duration after which a batch should be sent, starting from the + addition of the first message to that batch. + type: string + format: google-duration + elementCountLimit: + description: >- + The maximum number of elements collected in a batch that could be + accepted by server. + type: integer + format: int32 + requestByteLimit: + description: The maximum size of the request that could be accepted by server. + type: integer + format: int32 + flowControlElementLimit: + description: The maximum number of elements allowed by flow control. + type: integer + format: int32 + flowControlByteLimit: + description: The maximum size of data allowed by flow control. + type: integer + format: int32 + flowControlLimitExceededBehavior: + description: The behavior to take when the flow control limit is exceeded. + type: string + enumDescriptions: + - Default behavior, system-defined. + - Stop operation, raise error. + - Pause operation until limit clears. + - Continue operation, disregard limit. + enum: + - UNSET_BEHAVIOR + - THROW_EXCEPTION + - BLOCK + - IGNORE + BatchingDescriptorProto: + id: BatchingDescriptorProto + description: >- + `BatchingDescriptorProto` specifies the fields of the request message to + be used for batching, and, optionally, the fields of the response + message to be used for demultiplexing. + type: object + properties: + batchedField: + description: >- + The repeated field in the request message to be aggregated by + batching. + type: string + discriminatorFields: + description: >- + A list of the fields in the request message. Two requests will be + batched together only if the values of every field specified in + `request_discriminator_fields` is equal between the two requests. + type: array + items: + type: string + subresponseField: + description: >- + Optional. When present, indicates the field in the response message + to be used to demultiplex the response into multiple response + messages, in correspondence with the multiple request messages + originally batched together. + type: string ClientLibrarySettings: id: ClientLibrarySettings description: Details about how and where to publish client libraries. @@ -2853,7 +2972,8 @@ components: already set the language_settings.java.package_name" field in gapic.yaml. API teams should use the protobuf java_package option where possible. Example of a YAML configuration:: publishing: - java_settings: library_package: com.google.cloud.pubsub.v1 + library_settings: java_settings: library_package: + com.google.cloud.pubsub.v1 type: string serviceClassNames: description: >- @@ -2922,6 +3042,16 @@ components: type: array items: type: string + generateOmittedAsInternal: + description: >- + Setting this to true indicates to the client generators that methods + that would be excluded from the generation should instead be + generated in a way that indicates these methods should not be + consumed by end users. How this is expressed is up to individual + language implementations to decide. Some examples may be: added + annotations, obfuscated identifiers, or other language idiomatic + patterns. + type: boolean CppSettings: id: CppSettings description: Settings for C++ client libraries. @@ -2966,6 +3096,20 @@ components: generated. This feature will be enabled by default 1 month after launching the feature in preview packages. type: boolean + protobufPythonicTypesEnabled: + description: >- + Enables generation of protobuf code using new types that are more + Pythonic which are included in `protobuf>=5.29.x`. This feature will + be enabled by default 1 month after launching the feature in preview + packages. + type: boolean + unversionedPackageDisabled: + description: >- + Disables generation of an unversioned Python package for this client + library. This means that the module names will need to be versioned + in import statements. For example `import google.cloud.library_v2` + instead of `import google.cloud.library`. + type: boolean NodeSettings: id: NodeSettings description: Settings for Node client libraries. @@ -3041,6 +3185,34 @@ components: common: description: Some settings. $ref: '#/components/schemas/CommonLanguageSettings' + renamedServices: + description: >- + Map of service names to renamed services. Keys are the package + relative service names and values are the name to be used for the + service client and call options. publishing: go_settings: + renamed_services: Publisher: TopicAdmin + type: object + additionalProperties: + type: string + Aspect: + id: Aspect + description: >- + Aspect represents Generic aspect. It is used to configure an aspect + without making direct changes to service.proto + type: object + properties: + kind: + description: The type of this aspect configuration. + type: string + spec: + description: >- + Content of the configuration. The underlying schema should be + defined by Aspect owners as protobuf message under + `google/api/configaspects/proto`. + type: object + additionalProperties: + type: any + description: Properties of the object. SubmitConfigSourceRequest: id: SubmitConfigSourceRequest description: Request message for SubmitConfigSource method. @@ -3195,6 +3367,9 @@ components: serviceName: description: The name of the service associated with this Rollout. type: string + universe: + description: The TPC universe which the rollout will be rolled out to. + type: string TrafficPercentStrategy: id: TrafficPercentStrategy description: >- diff --git a/providers/src/googleapis.com/v00.00.00000/services/servicenetworking.yaml b/providers/src/googleapis.com/v00.00.00000/services/servicenetworking.yaml index 6e0efe2c..76dc006a 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/servicenetworking.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/servicenetworking.yaml @@ -9,8 +9,8 @@ info: Provides automatic management of network configurations necessary for certain services. version: v1 - x-discovery-doc-revision: '20241104' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250818' + x-generated-date: '2025-08-28' externalDocs: url: >- https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started @@ -38,611 +38,545 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - JavaSettings: - description: Settings for Java client libraries. - id: JavaSettings + ListOperationsResponse: + id: ListOperationsResponse + description: The response message for Operations.ListOperations. type: object properties: - serviceClassNames: + operations: description: >- - Configure the Java class name to use instead of the service's for - its corresponding generated GAPIC client. Keys are fully-qualified - service names as they appear in the protobuf (including the full the - language_settings.java.interface_names" field in gapic.yaml. API - teams should otherwise use the service name as it appears in the - protobuf. Example of a YAML configuration:: publishing: - java_settings: service_class_names: - google.pubsub.v1.Publisher: - TopicAdmin - google.pubsub.v1.Subscriber: SubscriptionAdmin - additionalProperties: - type: string - type: object - common: - description: Some settings. - $ref: '#/components/schemas/CommonLanguageSettings' - libraryPackage: + A list of operations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/Operation' + nextPageToken: + description: The standard List next-page token. type: string - description: >- - The package name to use in Java. Clobbers the java_package option - set in the protobuf. This should be used **only** by APIs who have - already set the language_settings.java.package_name" field in - gapic.yaml. API teams should use the protobuf java_package option - where possible. Example of a YAML configuration:: publishing: - java_settings: library_package: com.google.cloud.pubsub.v1 - Endpoint: + Operation: + id: Operation + description: >- + This resource represents a long-running operation that is the result of + a network API call. + type: object properties: name: - type: string - description: The canonical name of this endpoint. - aliases: - items: - type: string - type: array description: >- - Aliases for this endpoint, these will be served by the same UrlMap - as the parent endpoint, and will be provisioned in the GCP stack for - the Regional Endpoints. - target: + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. type: string + metadata: description: >- - The specification of an Internet routable address of API frontend - that will handle requests to this [API - Endpoint](https://cloud.google.com/apis/design/glossary). It should - be either a valid IPv4 address or a fully-qualified domain name. For - example, "8.8.8.8" or "myservice.appspot.com". - allowCors: + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + done: + description: >- + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. type: boolean + error: description: >- - Allowing - [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), - aka cross-domain traffic, would allow the backends served from this - endpoint to receive and respond to HTTP OPTIONS requests. The - response will be used by the browser to determine whether the - subsequent cross-origin request is allowed to proceed. - id: Endpoint - type: object + The error result of the operation in case of failure or + cancellation. + $ref: '#/components/schemas/Status' + response: + description: >- + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + Status: + id: Status description: >- - `Endpoint` describes a network address of a service that serves a set of - APIs. It is commonly known as a service endpoint. A service may expose - any number of service endpoints, and all service endpoints share the - same service definition, such as quota limits and monitoring metrics. - Example: type: google.api.Service name: library-example.googleapis.com - endpoints: # Declares network address - `https://library-example.googleapis.com` # for service - `library-example.googleapis.com`. The `https` scheme # is implicit for - all service endpoints. Other schemes may be # supported in the future. - - name: library-example.googleapis.com allow_cors: false - name: - content-staging-library-example.googleapis.com # Allows HTTP OPTIONS - calls to be passed to the API frontend, for it # to decide whether the - subsequent cross-origin request is allowed # to proceed. allow_cors: - true - ClientLibrarySettings: + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). type: object properties: - goSettings: - $ref: '#/components/schemas/GoSettings' - description: Settings for Go client libraries. - phpSettings: - description: Settings for PHP client libraries. - $ref: '#/components/schemas/PhpSettings' - dotnetSettings: - $ref: '#/components/schemas/DotnetSettings' - description: Settings for .NET client libraries. - pythonSettings: - $ref: '#/components/schemas/PythonSettings' - description: Settings for Python client libraries. - rubySettings: - description: Settings for Ruby client libraries. - $ref: '#/components/schemas/RubySettings' - restNumericEnums: - type: boolean - description: >- - When using transport=rest, the client request will encode enums as - numbers rather than strings. - nodeSettings: - description: Settings for Node client libraries. - $ref: '#/components/schemas/NodeSettings' - launchStage: - enumDescriptions: - - Do not use this default value. - - The feature is not yet implemented. Users can not use it. - - >- - Prelaunch features are hidden from users and are only visible - internally. - - >- - Early Access features are limited to a closed group of testers. To - use these features, you must sign up in advance and sign a Trusted - Tester agreement (which includes confidentiality provisions). - These features may be unstable, changed in backward-incompatible - ways, and are not guaranteed to be released. - - >- - Alpha is a limited availability test for releases before they are - cleared for widespread use. By Alpha, all significant design - issues are resolved and we are in the process of verifying - functionality. Alpha customers need to apply for access, agree to - applicable terms, and have their projects allowlisted. Alpha - releases don't have to be feature complete, no SLAs are provided, - and there are no technical support obligations, but they will be - far enough along that customers can actually use them in test - environments or for limited-use tests -- just like they would in - normal production cases. - - >- - Beta is the point at which we are ready to open a release for any - customer to use. There are no SLA or technical support obligations - in a Beta release. Products will be complete from a feature - perspective, but may have some open outstanding issues. Beta - releases are suitable for limited production use cases. - - >- - GA features are open to all developers and are considered stable - and fully qualified for production use. - - >- - Deprecated features are scheduled to be shut down and removed. For - more information, see the "Deprecation Policy" section of our - [Terms of Service](https://cloud.google.com/terms/) and the - [Google Cloud Platform Subject to the Deprecation - Policy](https://cloud.google.com/terms/deprecation) documentation. - type: string - enum: - - LAUNCH_STAGE_UNSPECIFIED - - UNIMPLEMENTED - - PRELAUNCH - - EARLY_ACCESS - - ALPHA - - BETA - - GA - - DEPRECATED - description: Launch stage of this version of the API. - javaSettings: - $ref: '#/components/schemas/JavaSettings' - description: Settings for legacy Java features, supported in the Service YAML. - cppSettings: - description: Settings for C++ client libraries. - $ref: '#/components/schemas/CppSettings' - version: + code: + description: The status code, which should be an enum value of google.rpc.Code. + type: integer + format: int32 + message: description: >- - Version of the API to apply these settings to. This is the full - protobuf package for the API, ending in the version element. - Examples: "google.cloud.speech.v1" and - "google.spanner.admin.database.v1". - type: string - description: Details about how and where to publish client libraries. - id: ClientLibrarySettings - Mixin: - id: Mixin - properties: - name: - description: The fully qualified name of the interface which is included. - type: string - root: + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. type: string + details: description: >- - If non-empty specifies a path under which inherited HTTP paths are - rooted. + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + type: array + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + Empty: + id: Empty + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } type: object + properties: {} + CancelOperationRequest: + id: CancelOperationRequest + description: The request message for Operations.CancelOperation. + type: object + properties: {} + ListConnectionsResponse: + id: ListConnectionsResponse description: >- - Declares an API Interface to be included in this interface. The - including interface must redeclare all the methods from the included - interface, but documentation and options are inherited as follows: - If - after comment and whitespace stripping, the documentation string of the - redeclared method is empty, it will be inherited from the original - method. - Each annotation belonging to the service config (http, - visibility) which is not set in the redeclared method will be inherited. - - If an http annotation is inherited, the path pattern will be modified - as follows. Any version prefix will be replaced by the version of the - including interface plus the root path if specified. Example of a simple - mixin: package google.acl.v1; service AccessControl { // Get the - underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option - (google.api.http).get = "/v1/{resource=**}:getAcl"; } } package - google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) - returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns - (Data) { option (google.api.http).get = "/v2/{resource=**}"; } } Example - of a mixin configuration: apis: - name: google.storage.v2.Storage - mixins: - name: google.acl.v1.AccessControl The mixin construct implies - that all methods in `AccessControl` are also declared with same name and - request/response types in `Storage`. A documentation generator or - annotation processor will see the effective `Storage.GetAcl` method - after inheriting documentation and annotations as follows: service - Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) - returns (Acl) { option (google.api.http).get = - "/v2/{resource=**}:getAcl"; } ... } Note how the version in the path - pattern changed from `v1` to `v2`. If the `root` field in the mixin is - specified, it should be a relative path under which inherited HTTP paths - are placed. Example: apis: - name: google.storage.v2.Storage mixins: - - name: google.acl.v1.AccessControl root: acls This implies the following - inherited HTTP annotation: service Storage { // Get the underlying ACL - object. rpc GetAcl(GetAclRequest) returns (Acl) { option - (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; } ... } - RubySettings: - id: RubySettings + ListConnectionsResponse is the response to list peering states for the + given service and consumer project. type: object properties: - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - description: Settings for Ruby client libraries. - DisableVpcServiceControlsRequest: + connections: + description: The list of Connections. + type: array + items: + $ref: '#/components/schemas/Connection' + Connection: + id: Connection + description: >- + Represents a private connection resource. A private connection is + implemented as a VPC Network Peering connection between a service + producer's VPC network and a service consumer's VPC network. type: object - description: Request to disable VPC service controls. + properties: + network: + description: >- + Required. The name of service consumer's VPC network that's + connected with service producer network, in the following format: + `projects/{project}/global/networks/{network}`. `{project}` is a + project number, such as in `12345` that includes the VPC service + consumer's VPC network. `{network}` is the name of the service + consumer's VPC network. + type: string + reservedPeeringRanges: + description: >- + The name of one or more allocated IP address ranges for this service + producer of type `PEERING`. Note that invoking CreateConnection + method with a different range when connection is already established + will not modify already provisioned service producer subnetworks. If + CreateConnection method is invoked repeatedly to reconnect when + peering connection had been disconnected on the consumer side, + leaving this field empty will restore previously allocated IP + ranges. + type: array + items: + type: string + peering: + description: >- + Output only. The name of the VPC Network Peering connection that was + created by the service producer. + readOnly: true + type: string + service: + description: >- + Output only. The name of the peering service that's associated with + this connection, in the following format: `services/{service name}`. + readOnly: true + type: string + DeleteConnectionRequest: + id: DeleteConnectionRequest + description: >- + Request to delete a private service access connection. The call will + fail if there are any managed service instances using this connection. + type: object + properties: + consumerNetwork: + description: >- + Required. The network that the consumer is using to connect with + services. Must be in the form of + projects/{project}/global/networks/{network} {project} is a project + number, as in '12345' {network} is a network name. + type: string + DisableVpcServiceControlsRequest: id: DisableVpcServiceControlsRequest + description: Request to disable VPC service controls. + type: object properties: consumerNetwork: + description: >- + Required. The network that the consumer is using to connect with + services. Must be in the form of + projects/{project}/global/networks/{network} {project} is a project + number, as in '12345' {network} is network name. type: string + EnableVpcServiceControlsRequest: + id: EnableVpcServiceControlsRequest + description: Request to enable VPC service controls. + type: object + properties: + consumerNetwork: description: >- Required. The network that the consumer is using to connect with services. Must be in the form of projects/{project}/global/networks/{network} {project} is a project number, as in '12345' {network} is network name. - Empty: - description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + type: string + VpcServiceControls: + id: VpcServiceControls + description: Response for the get VPC Service Controls request. type: object - id: Empty - properties: {} - Api: properties: - options: - type: array - description: Any metadata attached to the interface. - items: - $ref: '#/components/schemas/Option' - syntax: - description: The source syntax of the service. + enabled: + description: >- + Output only. Indicates whether the VPC Service Controls are enabled + or disabled for the connection. If the consumer called the + EnableVpcServiceControls method, then this is true. If the consumer + called DisableVpcServiceControls, then this is false. The default is + false. + readOnly: true + type: boolean + AddSubnetworkRequest: + id: AddSubnetworkRequest + description: Request to create a subnetwork in a previously peered service network. + type: object + properties: + consumerNetwork: + description: >- + Required. The name of the service consumer's VPC network. The + network must have an existing private connection that was + provisioned through the connections.create method. The name must be + in the following format: + `projects/{project}/global/networks/{network}`, where {project} is a + project number, such as `12345`. {network} is the name of a VPC + network in the project. type: string - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS - enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. - name: + subnetwork: description: >- - The fully qualified name of this interface, including package name - followed by the interface's simple name. + Required. A name for the new subnet. For information about the + naming requirements, see + [subnetwork](https://cloud.google.com/compute/docs/reference/rest/v1/subnetworks) + in the Compute API documentation. type: string - version: + region: + description: >- + Required. The name of a + [region](https://cloud.google.com/compute/docs/regions-zones) for + the subnet, such `europe-west1`. type: string + ipPrefixLength: description: >- - A version string for this interface. If specified, must have the - form `major-version.minor-version`, as in `1.10`. If the minor - version is omitted, it defaults to zero. If the entire version field - is empty, the major version is derived from the package name, as - outlined below. If the field is not empty, the version in the - package name will be verified to be consistent with what is provided - here. The versioning schema uses [semantic - versioning](http://semver.org) where the major version number - indicates a breaking change and the minor version an additive, - non-breaking change. Both version numbers are signals to users what - to expect from different versions, and should be carefully chosen - based on the product plan. The major version is also reflected in - the package name of the interface, which must end in `v`, as in - `google.feature.v1`. For major versions 0 and 1, the suffix can be - omitted. Zero major versions must only be used for experimental, - non-GA interfaces. - sourceContext: + Required. The prefix length of the subnet's IP address range. Use + CIDR range notation, such as `29` to provision a subnet with an + `x.x.x.x/29` CIDR range. The IP address range is drawn from a pool + of available ranges in the service consumer's allocated range. GCE + disallows subnets with prefix_length > 29 + type: integer + format: int32 + description: + description: Optional. Description of the subnet. + type: string + subnetworkUsers: description: >- - Source context for the protocol buffer service represented by this - message. - $ref: '#/components/schemas/SourceContext' - methods: - description: The methods of this interface, in unspecified order. + A list of members that are granted the + `roles/servicenetworking.subnetworkAdmin` role on the subnet. type: array items: - $ref: '#/components/schemas/Method' - mixins: - description: Included interfaces. See Mixin. - items: - $ref: '#/components/schemas/Mixin' - type: array - type: object - description: >- - Api is a light-weight descriptor for an API Interface. Interfaces are - also described as "protocol buffer services" in some contexts, such as - by the "service" keyword in a .proto file, but they are different from - API Services, which represent a concrete implementation of an interface - as opposed to simply a description of methods and bindings. They are - also sometimes simply referred to as "APIs" in other contexts, such as - the name of this message itself. See - https://cloud.google.com/apis/design/glossary for detailed terminology. - id: Api - DnsZone: - type: object - description: Represents a DNS zone resource. - id: DnsZone - properties: - dnsSuffix: + type: string + consumer: description: >- - The DNS name suffix of this zone e.g. `example.com.`. Cloud DNS - requires that a DNS suffix ends with a trailing dot. + Required. A resource that represents the service consumer, such as + `projects/123456`. The project number can be different from the + value in the consumer network parameter. For example, the network + might be part of a Shared VPC network. In those cases, Service + Networking validates that this resource belongs to that Shared VPC. type: string - name: + requestedAddress: + description: >- + Optional. The starting address of a range. The address must be a + valid IPv4 address in the x.x.x.x format. This value combined with + the IP prefix range is the CIDR range for the subnet. The range must + be within the allocated range that is assigned to the private + connection. If the CIDR range isn't available, the call fails. type: string + secondaryIpRangeSpecs: description: >- - User assigned name for this resource. Must be unique within the - project. The name must be 1-63 characters long, must begin with a - letter, end with a letter or digit, and only contain lowercase - letters, digits or dashes. - MonitoredResourceDescriptor: - type: object - description: >- - An object that describes the schema of a MonitoredResource object using - a type name and a set of labels. For example, the monitored resource - descriptor for Google Compute Engine VM instances has a type of - `"gce_instance"` and specifies the use of the labels `"instance_id"` and - `"zone"` to identify particular VM instances. Different APIs can support - different monitored resource types. APIs generally provide a `list` - method that returns the monitored resource descriptors used by the API. - id: MonitoredResourceDescriptor - properties: - displayName: + Optional. A list of secondary IP ranges to be created within the new + subnetwork. + type: array + items: + $ref: '#/components/schemas/SecondaryIpRangeSpec' + privateIpv6GoogleAccess: description: >- - Optional. A concise name for the monitored resource type that might - be displayed in user interfaces. It should be a Title Cased Noun - Phrase, without any article or other determiners. For example, - `"Google Cloud SQL Database"`. + Optional. The private IPv6 google access type for the VMs in this + subnet. For information about the access types that can be set using + this field, see + [subnetwork](https://cloud.google.com/compute/docs/reference/rest/v1/subnetworks) + in the Compute API documentation. type: string - labels: - type: array + requestedRanges: description: >- - Required. A set of labels used to describe instances of this - monitored resource type. For example, an individual Google Cloud SQL - database is identified by values for the labels `"database_id"` and - `"zone"`. + Optional. The name of one or more allocated IP address ranges + associated with this private service access connection. If no range + names are provided all ranges associated with this connection will + be considered. If a CIDR range with the specified IP prefix length + is not available within these ranges, the call fails. + type: array items: - $ref: '#/components/schemas/LabelDescriptor' - launchStage: - enum: - - LAUNCH_STAGE_UNSPECIFIED - - UNIMPLEMENTED - - PRELAUNCH - - EARLY_ACCESS - - ALPHA - - BETA - - GA - - DEPRECATED - description: Optional. The launch stage of the monitored resource definition. + type: string + outsideAllocationPublicIpRange: + description: >- + Optional. Enable outside allocation using public IP addresses. Any + public IP range may be specified. If this field is provided, we will + not use customer reserved ranges for this primary IP range. type: string - enumDescriptions: - - Do not use this default value. - - The feature is not yet implemented. Users can not use it. - - >- - Prelaunch features are hidden from users and are only visible - internally. - - >- - Early Access features are limited to a closed group of testers. To - use these features, you must sign up in advance and sign a Trusted - Tester agreement (which includes confidentiality provisions). - These features may be unstable, changed in backward-incompatible - ways, and are not guaranteed to be released. - - >- - Alpha is a limited availability test for releases before they are - cleared for widespread use. By Alpha, all significant design - issues are resolved and we are in the process of verifying - functionality. Alpha customers need to apply for access, agree to - applicable terms, and have their projects allowlisted. Alpha - releases don't have to be feature complete, no SLAs are provided, - and there are no technical support obligations, but they will be - far enough along that customers can actually use them in test - environments or for limited-use tests -- just like they would in - normal production cases. - - >- - Beta is the point at which we are ready to open a release for any - customer to use. There are no SLA or technical support obligations - in a Beta release. Products will be complete from a feature - perspective, but may have some open outstanding issues. Beta - releases are suitable for limited production use cases. - - >- - GA features are open to all developers and are considered stable - and fully qualified for production use. - - >- - Deprecated features are scheduled to be shut down and removed. For - more information, see the "Deprecation Policy" section of our - [Terms of Service](https://cloud.google.com/terms/) and the - [Google Cloud Platform Subject to the Deprecation - Policy](https://cloud.google.com/terms/deprecation) documentation. - type: + purpose: + description: >- + Optional. Defines the purpose field of the subnet, e.g. + 'PRIVATE_SERVICE_CONNECT'. For information about the purposes that + can be set using this field, see + [subnetwork](https://cloud.google.com/compute/docs/reference/rest/v1/subnetworks) + in the Compute API documentation. type: string + checkServiceNetworkingUsePermission: description: >- - Required. The monitored resource type. For example, the type - `"cloudsql_database"` represents databases in Google Cloud SQL. For - a list of types, see [Monitored resource - types](https://cloud.google.com/monitoring/api/resources) and - [Logging resource - types](https://cloud.google.com/logging/docs/api/v2/resource-list). - description: + Optional. The IAM permission check determines whether the consumer + project has 'servicenetworking.services.use' permission or not. + type: boolean + useCustomComputeIdempotencyWindow: + description: >- + Optional. Specifies if Service Networking should use a custom time + bucket for GCE idempotency. If false, Service Networking uses a 300 + second (5 minute) GCE idempotency window. If true, Service + Networking uses a custom idempotency window provided by the user in + field compute_idempotency_window. + type: boolean + computeIdempotencyWindow: + description: >- + Optional. Specifies a custom time bucket for GCE subnetwork request + idempotency. If two equivalent concurrent requests are made, GCE + will know to ignore the request if it has already been completed or + is in progress. Only requests with matching + compute_idempotency_window have guaranteed idempotency. Changing + this time window between requests results in undefined behavior. + Zero (or empty) value with custom_compute_idempotency_window=true + specifies no idempotency (i.e. no request ID is provided to GCE). + Maximum value of 14 days (enforced by GCE limit). type: string + format: google-duration + allowSubnetCidrRoutesOverlap: description: >- - Optional. A detailed description of the monitored resource type that - might be used in documentation. - name: + Optional. Defines the allowSubnetCidrRoutesOverlap field of the + subnet, e.g. Available in alpha and beta according to [Compute API + documentation](https://cloud.google.com/compute/docs/reference/rest/beta/subnetworks/insert) + type: boolean + role: + description: >- + Optional. Defines the role field of the subnet, e.g. 'ACTIVE'. For + information about the roles that can be set using this field, see + [subnetwork](https://cloud.google.com/compute/docs/reference/rest/v1/subnetworks) + in the Compute API documentation. + type: string + internalRange: + description: >- + Optional. The url of an Internal Range. Eg: + `projects//locations/global/internalRanges/`. If specified, it means + that the subnetwork cidr will be created using the combination of + requested_address/ip_prefix_length. Note that the subnet cidr has to + be within the cidr range of this Internal Range. type: string + skipRequestedAddressValidation: description: >- - Optional. The resource name of the monitored resource descriptor: - `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where - {type} is the value of the `type` field in this object and - {project_id} is a project ID that provides API-specific context for - accessing the type. APIs that do not use project information can use - the resource name format `"monitoredResourceDescriptors/{type}"`. - CustomErrorRule: + Optional. Skips validating if the requested_address is in use by SN + VPC’s peering group. Compute Engine will still perform this check + and fail the request if the requested_address is in use. Note that + Compute Engine does not check for the existence of dynamic routes + when performing this check. Caller of this API should make sure that + there are no dynamic routes overlapping with the + requested_address/prefix_length IP address range otherwise the + created subnet could cause misrouting. + type: boolean + SecondaryIpRangeSpec: + id: SecondaryIpRangeSpec type: object - id: CustomErrorRule properties: - selector: + rangeName: description: >- - Selects messages to which this rule applies. Refer to selector for - syntax details. + Required. A name for the secondary IP range. The name must be 1-63 + characters long, and comply with RFC1035. The name must be unique + within the subnetwork. type: string - isErrorType: + ipPrefixLength: description: >- - Mark this message as possible payload in error response. Otherwise, - objects of this type will be filtered when they appear in error - payload. - type: boolean - description: A custom error rule. - SystemParameterRule: - properties: - selector: + Required. The prefix length of the secondary IP range. Use CIDR + range notation, such as `30` to provision a secondary IP range with + an `x.x.x.x/30` CIDR range. The IP address range is drawn from a + pool of available ranges in the service consumer's allocated range. + type: integer + format: int32 + requestedAddress: description: >- - Selects the methods to which this rule applies. Use '*' to indicate - all methods in all APIs. Refer to selector for syntax details. + Optional. The starting address of a range. The address must be a + valid IPv4 address in the x.x.x.x format. This value combined with + the IP prefix range is the CIDR range for the secondary IP range. + The range must be within the allocated range that is assigned to the + private connection. If the CIDR range isn't available, the call + fails. type: string - parameters: + outsideAllocationPublicIpRange: description: >- - Define parameters. Multiple names may be defined for a parameter. - For a given method call, only one of them should be used. If - multiple names are used the behavior is implementation-dependent. If - none of the specified names are present the behavior is - parameter-dependent. - type: array - items: - $ref: '#/components/schemas/SystemParameter' - description: >- - Define a system parameter rule mapping system parameter definitions to - methods. - id: SystemParameterRule - type: object - Context: - id: Context + Optional. Enable outside allocation using public IP addresses. Any + public IP range may be specified. If this field is provided, we will + not use customer reserved ranges for this secondary IP range. + type: string + SearchRangeRequest: + id: SearchRangeRequest + description: Request to search for an unused range within allocated ranges. type: object - description: >- - `Context` defines which contexts an API requests. Example: context: - rules: - selector: "*" requested: - google.rpc.context.ProjectContext - - google.rpc.context.OriginContext The above specifies that all methods in - the API request `google.rpc.context.ProjectContext` and - `google.rpc.context.OriginContext`. Available context types are defined - in package `google.rpc.context`. This also provides mechanism to - allowlist any protobuf message extension that can be sent in grpc - metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For - example, list any service specific protobuf types that can appear in - grpc metadata as follows in your yaml file: Example: context: rules: - - selector: "google.example.library.v1.LibraryService.CreateBook" - allowed_request_extensions: - google.foo.v1.NewExtension - allowed_response_extensions: - google.foo.v1.NewExtension You can also - specify extension ID instead of fully qualified extension name here. properties: - rules: - items: - $ref: '#/components/schemas/ContextRule' + network: description: >- - A list of RPC context rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. - type: array - Authentication: - id: Authentication - type: object - properties: - rules: - type: array + Required. Network name in the consumer project. This network must + have been already peered with a shared VPC network using + CreateConnection method. Must be in a form + 'projects/{project}/global/networks/{network}'. {project} is a + project number, as in '12345' {network} is network name. + type: string + ipPrefixLength: description: >- - A list of authentication rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. - items: - $ref: '#/components/schemas/AuthenticationRule' - providers: - description: Defines a set of authentication providers that a service supports. - items: - $ref: '#/components/schemas/AuthProvider' - type: array - description: >- - `Authentication` defines the authentication configuration for API - methods provided by an API service. Example: name: - calendar.googleapis.com authentication: providers: - id: - google_calendar_auth jwks_uri: - https://www.googleapis.com/oauth2/v1/certs issuer: - https://securetoken.google.com rules: - selector: "*" requirements: - provider_id: google_calendar_auth - selector: google.calendar.Delegate - oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read - AddDnsRecordSetMetadata: - properties: {} + Required. The prefix length of the IP range. Use usual CIDR range + notation. For example, '30' to find unused x.x.x.x/30 CIDR range. + Actual range will be determined using allocated range for the + consumer peered network and returned in the result. + type: integer + format: int32 + ValidateConsumerConfigRequest: + id: ValidateConsumerConfigRequest type: object - description: >- - Metadata provided through GetOperation request for the LRO generated by - AddDnsRecordSet API - id: AddDnsRecordSetMetadata - Monitoring: - description: >- - Monitoring configuration of the service. The example below shows how to - configure monitored resources and metrics for monitoring. In the - example, a monitored resource and two metrics are defined. The - `library.googleapis.com/book/returned_count` metric is sent to both - producer and consumer projects, whereas the - `library.googleapis.com/book/num_overdue` metric is only sent to the - consumer project. monitored_resources: - type: - library.googleapis.com/Branch display_name: "Library Branch" - description: "A branch of a library." launch_stage: GA labels: - key: - resource_container description: "The Cloud container (ie. project id) - for the Branch." - key: location description: "The location of the - library branch." - key: branch_id description: "The id of the branch." - metrics: - name: library.googleapis.com/book/returned_count - display_name: "Books Returned" description: "The count of books that - have been returned." launch_stage: GA metric_kind: DELTA value_type: - INT64 unit: "1" labels: - key: customer_id description: "The id of the - customer." - name: library.googleapis.com/book/num_overdue display_name: - "Books Overdue" description: "The current number of overdue books." - launch_stage: GA metric_kind: GAUGE value_type: INT64 unit: "1" labels: - - key: customer_id description: "The id of the customer." monitoring: - producer_destinations: - monitored_resource: - library.googleapis.com/Branch metrics: - - library.googleapis.com/book/returned_count consumer_destinations: - - monitored_resource: library.googleapis.com/Branch metrics: - - library.googleapis.com/book/returned_count - - library.googleapis.com/book/num_overdue + properties: + consumerNetwork: + description: >- + Required. The network that the consumer is using to connect with + services. Must be in the form of + projects/{project}/global/networks/{network} {project} is a project + number, as in '12345' {network} is network name. + type: string + validateNetwork: + description: >- + The validations will be performed in the order listed in the + ValidationError enum. The first failure will return. If a validation + is not requested, then the next one will be performed. + SERVICE_NETWORKING_NOT_ENABLED and NETWORK_NOT_PEERED checks are + performed for all requests where validation is requested. + NETWORK_NOT_FOUND and NETWORK_DISCONNECTED checks are done for + requests that have validate_network set to true. + type: boolean + consumerProject: + description: >- + NETWORK_NOT_IN_CONSUMERS_PROJECT, + NETWORK_NOT_IN_CONSUMERS_HOST_PROJECT, and HOST_PROJECT_NOT_FOUND + are done when consumer_project is provided. + $ref: '#/components/schemas/ConsumerProject' + rangeReservation: + description: >- + RANGES_EXHAUSTED, RANGES_NOT_RESERVED, and RANGES_DELETED_LATER are + done when range_reservation is provided. + $ref: '#/components/schemas/RangeReservation' + checkServiceNetworkingUsePermission: + description: >- + Optional. The IAM permission check determines whether the consumer + project has 'servicenetworking.services.use' permission or not. + type: boolean + ConsumerProject: + id: ConsumerProject + description: Represents a consumer project. type: object properties: - consumerDestinations: + projectNum: + description: >- + Required. Project number of the consumer that is launching the + service instance. It can own the network that is peered with Google + or, be a service project in an XPN where the host project has the + network. + type: string + format: int64 + RangeReservation: + id: RangeReservation + description: Represents a range reservation. + type: object + properties: + ipPrefixLength: + description: >- + Required. The size of the desired subnet. Use usual CIDR range + notation. For example, '29' to find unused x.x.x.x/29 CIDR range. + The goal is to determine if one of the allocated ranges has enough + free space for a subnet of the requested size. GCE disallows subnets + with prefix_length > 29 + type: integer + format: int32 + secondaryRangeIpPrefixLengths: + description: >- + Optional. The size of the desired secondary ranges for the subnet. + Use usual CIDR range notation. For example, '29' to find unused + x.x.x.x/29 CIDR range. The goal is to determine that the allocated + ranges have enough free space for all the requested secondary + ranges. GCE disallows subnets with prefix_length > 29 + type: array items: - $ref: '#/components/schemas/MonitoringDestination' + type: integer + format: int32 + requestedRanges: description: >- - Monitoring configurations for sending metrics to the consumer - project. There can be multiple consumer destinations. A monitored - resource type may appear in multiple monitoring destinations if - different aggregations are needed for different sets of metrics - associated with that monitored resource type. A monitored resource - and metric pair may only be used once in the Monitoring - configuration. + Optional. The name of one or more allocated IP address ranges + associated with this private service access connection. If no range + names are provided all ranges associated with this connection will + be considered. If a CIDR range with the specified IP prefix length + is not available within these ranges the validation fails. type: array - producerDestinations: + items: + type: string + subnetworkCandidates: description: >- - Monitoring configurations for sending metrics to the producer - project. There can be multiple producer destinations. A monitored - resource type may appear in multiple monitoring destinations if - different aggregations are needed for different sets of metrics - associated with that monitored resource type. A monitored resource - and metric pair may only be used once in the Monitoring - configuration. + Optional. List of subnetwork candidates to validate. The required + input fields are `name`, `network`, and `region`. Subnetworks from + this list which exist will be returned in the response with the + `ip_cidr_range`, `secondary_ip_cider_ranges`, and + `outside_allocation` fields set. type: array items: - $ref: '#/components/schemas/MonitoringDestination' - id: Monitoring - UpdateDnsRecordSetMetadata: - type: object - id: UpdateDnsRecordSetMetadata - description: >- - Metadata provided through GetOperation request for the LRO generated by - UpdateDnsRecordSet API - properties: {} + $ref: '#/components/schemas/Subnetwork' Subnetwork: + id: Subnetwork + description: >- + Represents a subnet that was created or discovered by a private access + management service. type: object properties: - ipCidrRange: - type: string - description: Subnetwork CIDR range in `10.x.x.x/y` format. - secondaryIpRanges: - items: - $ref: '#/components/schemas/SecondaryIpRange' - type: array - description: List of secondary IP ranges in this subnetwork. - region: - type: string - description: GCP region where the subnetwork is located. name: description: Subnetwork name. See https://cloud.google.com/compute/docs/vpc/ type: string + ipCidrRange: + description: Subnetwork CIDR range in `10.x.x.x/y` format. + type: string network: description: >- In the Shared VPC host project, the VPC network that's peered with @@ -654,251 +588,398 @@ components: This is a discovered subnet that is not within the current consumer allocated ranges. type: boolean - id: Subnetwork - description: >- - Represents a subnet that was created or discovered by a private access - management service. - MonitoringDestination: - id: MonitoringDestination - description: >- - Configuration of a specific monitoring destination (the producer project - or the consumer project). - properties: - metrics: - description: >- - Types of the metrics to report to this monitoring destination. Each - type must be defined in Service.metrics section. + secondaryIpRanges: + description: List of secondary IP ranges in this subnetwork. type: array items: - type: string - monitoredResource: + $ref: '#/components/schemas/SecondaryIpRange' + region: + description: GCP region where the subnetwork is located. type: string - description: >- - The monitored resource type. The type must be defined in - Service.monitored_resources section. + SecondaryIpRange: + id: SecondaryIpRange type: object - Type: - description: A protocol buffer message type. - id: Type properties: - edition: + rangeName: + description: Name of the secondary IP range. type: string - description: >- - The source edition string, only valid when syntax is - SYNTAX_EDITIONS. - syntax: - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS - description: The source syntax. + ipCidrRange: + description: Secondary IP CIDR range in `x.x.x.x/y` format. + type: string + ValidateConsumerConfigResponse: + id: ValidateConsumerConfigResponse + type: object + properties: + isValid: + description: Indicates whether all the requested validations passed. + type: boolean + validationError: + description: The first validation which failed. type: string enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. - options: - description: The protocol buffer options. - items: - $ref: '#/components/schemas/Option' - type: array - fields: - type: array - items: - $ref: '#/components/schemas/Field' - description: The list of fields. - oneofs: + - '' + - In case none of the validations are requested. + - '' + - The network provided by the consumer does not exist. + - The network has not been peered with the producer org. + - The peering was created and later deleted. + - >- + The network is a regular VPC but the network is not in the + consumer's project. + - >- + The consumer project is a service project, and network is a shared + VPC, but the network is not in the host project of this consumer + project. + - >- + The host project associated with the consumer project was not + found. + - >- + The consumer project is not a service project for the specified + host project. + - >- + The reserved IP ranges do not have enough space to create a subnet + of desired size. + - The IP ranges were not reserved. + - The IP ranges were reserved but deleted later. + - The consumer project does not have the compute api enabled. + - >- + The consumer project does not have the permission from the host + project. + - >- + The SN service agent + {service-@service-networking.iam.gserviceaccount.com} does not + have the SN service agent role on the consumer project. + enum: + - VALIDATION_ERROR_UNSPECIFIED + - VALIDATION_NOT_REQUESTED + - SERVICE_NETWORKING_NOT_ENABLED + - NETWORK_NOT_FOUND + - NETWORK_NOT_PEERED + - NETWORK_PEERING_DELETED + - NETWORK_NOT_IN_CONSUMERS_PROJECT + - NETWORK_NOT_IN_CONSUMERS_HOST_PROJECT + - HOST_PROJECT_NOT_FOUND + - CONSUMER_PROJECT_NOT_SERVICE_PROJECT + - RANGES_EXHAUSTED + - RANGES_NOT_RESERVED + - RANGES_DELETED_LATER + - COMPUTE_API_NOT_ENABLED + - USE_PERMISSION_NOT_FOUND + - SN_SERVICE_AGENT_PERMISSION_DENIED_ON_CONSUMER_PROJECT + existingSubnetworkCandidates: + description: >- + List of subnetwork candidates from the request which exist with the + `ip_cidr_range`, `secondary_ip_cider_ranges`, and + `outside_allocation` fields set. type: array - description: The list of types appearing in `oneof` definitions in this type. items: - type: string - name: - description: The fully qualified message name. - type: string - sourceContext: - description: The source context. - $ref: '#/components/schemas/SourceContext' - type: object - PhpSettings: - description: Settings for Php client libraries. + $ref: '#/components/schemas/Subnetwork' + UpdateConsumerConfigRequest: + id: UpdateConsumerConfigRequest + description: >- + Request to update the configuration of a service networking connection + including the import/export of custom routes and subnetwork routes with + public IP. type: object properties: - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - id: PhpSettings - ListOperationsResponse: - properties: - operations: - items: - $ref: '#/components/schemas/Operation' - description: >- - A list of operations that matches the specified filter in the - request. - type: array - nextPageToken: - type: string - description: The standard List next-page token. + consumerConfig: + description: Required. The updated peering config. + $ref: '#/components/schemas/ConsumerConfig' + ConsumerConfig: + id: ConsumerConfig + description: Configuration information for a private service access connection. type: object - description: The response message for Operations.ListOperations. - id: ListOperationsResponse - ContextRule: - description: >- - A context rule provides information about the context for an individual - API element. - id: ContextRule properties: - selector: + producerNetwork: description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. + Output only. The VPC host network that is used to host managed + service instances. In the format, + projects/{project}/global/networks/{network} where {project} is the + project number e.g. '12345' and {network} is the network name. + readOnly: true type: string - requested: + consumerImportCustomRoutes: description: >- - A list of full type names of requested contexts, only the requested - context will be made available to the backend. - items: - type: string - type: array - provided: - items: - type: string - type: array + Import custom routes flag value for peering from consumer to + producer. + type: boolean + consumerExportCustomRoutes: description: >- - A list of full type names of provided contexts. It is used to - support propagating HTTP headers and ETags from the response - extension. - allowedResponseExtensions: - items: - type: string - type: array + Export custom routes flag value for peering from consumer to + producer. + type: boolean + producerImportCustomRoutes: description: >- - A list of full type names or extension IDs of extensions allowed in - grpc side channel from backend to client. - allowedRequestExtensions: + Import custom routes flag value for peering from producer to + consumer. + type: boolean + producerExportCustomRoutes: description: >- - A list of full type names or extension IDs of extensions allowed in - grpc side channel from client to backend. + Export custom routes flag value for peering from producer to + consumer. + type: boolean + consumerImportSubnetRoutesWithPublicIp: + description: >- + Import subnet routes with public ip flag value for peering from + consumer to producer. + type: boolean + consumerExportSubnetRoutesWithPublicIp: + description: >- + Export subnet routes with public ip flag value for peering from + consumer to producer. + type: boolean + producerImportSubnetRoutesWithPublicIp: + description: >- + Import subnet routes with public ip flag value for peering from + producer to consumer. + type: boolean + producerExportSubnetRoutesWithPublicIp: + description: >- + Export subnet routes with public ip flag value for peering from + producer to consumer. + type: boolean + reservedRanges: + description: >- + Output only. The reserved ranges associated with this private + service access connection. + readOnly: true type: array items: - type: string - type: object - RemoveDnsZoneResponse: - properties: {} - id: RemoveDnsZoneResponse - type: object - description: Blank message response type for RemoveDnsZone API - SelectiveGapicGeneration: - id: SelectiveGapicGeneration - description: >- - This message is used to configure the generation of a subset of the RPCs - in a service for client libraries. - properties: - methods: + $ref: >- + #/components/schemas/GoogleCloudServicenetworkingV1ConsumerConfigReservedRange + vpcScReferenceArchitectureEnabled: + description: >- + Output only. Indicates whether the VPC Service Controls reference + architecture is configured for the producer VPC host network. + readOnly: true + type: boolean + usedIpRanges: + description: Output only. The IP ranges already in use by consumer or producer + readOnly: true + type: array items: type: string + cloudsqlConfigs: + description: Represents one or multiple Cloud SQL configurations. type: array - description: >- - An allowlist of the fully qualified names of RPCs that should be - included on public client surfaces. - type: object - CancelOperationRequest: - type: object - description: The request message for Operations.CancelOperation. - properties: {} - id: CancelOperationRequest - SystemParameter: - id: SystemParameter - description: >- - Define a parameter's name and location. The parameter may be passed as - either an HTTP header or a URL query parameter, and if both are passed - the behavior is implementation-dependent. + items: + $ref: '#/components/schemas/CloudSQLConfig' + GoogleCloudServicenetworkingV1ConsumerConfigReservedRange: + id: GoogleCloudServicenetworkingV1ConsumerConfigReservedRange + description: Allocated IP address ranges for this private service access connection. type: object properties: name: + description: The name of the reserved range. + type: string + ipPrefixLength: + description: The prefix length of the reserved range. + type: integer + format: int32 + address: description: >- - Define the name of the parameter, such as "api_key" . It is case - sensitive. + The starting address of the reserved range. The address must be a + valid IPv4 address in the x.x.x.x format. This value combined with + the IP prefix length is the CIDR range for the reserved range. type: string - httpHeader: + CloudSQLConfig: + id: CloudSQLConfig + description: Cloud SQL configuration. + type: object + properties: + service: description: >- - Define the HTTP header name to use for the parameter. It is case - insensitive. + Required. Peering service used for peering with the Cloud SQL + project. type: string - urlQueryParameter: + umbrellaProject: + description: Required. The project number of the Cloud SQL umbrella project. + type: string + format: int64 + umbrellaNetwork: description: >- - Define the URL query parameter name to use for the parameter. It is - case sensitive. + Required. The name of the umbrella network in the Cloud SQL umbrella + project. type: string - ConsumerConfigMetadata: - properties: {} + AddRolesRequest: + id: AddRolesRequest description: >- - Metadata provided through GetOperation request for the LRO generated by - UpdateConsumerConfig API. - id: ConsumerConfigMetadata + Request for AddRoles to allow Service Producers to add roles in the + shared VPC host project for them to use. type: object - DeletePeeredDnsDomainMetadata: + properties: + consumerNetwork: + description: >- + Required. The network that the consumer is using to connect with + services. Must be in the form of + projects/{project}/global/networks/{network} {project} is a project + number, as in '12345' {network} is a network name. + type: string + policyBinding: + description: Required. List of policy bindings to add to shared VPC host project. + type: array + items: + $ref: '#/components/schemas/PolicyBinding' + PolicyBinding: + id: PolicyBinding + description: Grouping of IAM role and IAM member. + type: object + properties: + role: + description: >- + Required. Role to apply. Only allowlisted roles can be used at the + specified granularity. The role must be one of the following: - + 'roles/container.hostServiceAgentUser' applied on the shared VPC + host project - 'roles/compute.securityAdmin' applied on the shared + VPC host project - 'roles/compute.networkAdmin' applied on the + shared VPC host project - 'roles/tpu.xpnAgent' applied on the shared + VPC host project - 'roles/dns.admin' applied on the shared VPC host + project - 'roles/logging.admin' applied on the shared VPC host + project - 'roles/monitoring.viewer' applied on the shared VPC host + project - 'roles/servicemanagement.quotaViewer' applied on the + shared VPC host project + type: string + member: + description: >- + Required. Member to bind the role with. See + /iam/docs/reference/rest/v1/Policy#Binding for how to format each + member. Eg. - user:myuser@mydomain.com - + serviceAccount:my-service-account@app.gserviceaccount.com + type: string + AddDnsZoneRequest: + id: AddDnsZoneRequest description: >- - Metadata provided through GetOperation request for the LRO generated by - DeletePeeredDnsDomain API. - properties: {} - id: DeletePeeredDnsDomainMetadata + Request to add a private managed DNS zone in the shared producer host + project and a matching DNS peering zone in the consumer project. type: object - GetDnsZoneResponse: + properties: + consumerNetwork: + description: >- + Required. The network that the consumer is using to connect with + services. Must be in the form of + projects/{project}/global/networks/{network} {project} is the + project number, as in '12345' {network} is the network name. + type: string + name: + description: >- + Required. The name for both the private zone in the shared producer + host project and the peering zone in the consumer project. Must be + unique within both projects. The name must be 1-63 characters long, + must begin with a letter, end with a letter or digit, and only + contain lowercase letters, digits or dashes. + type: string + dnsSuffix: + description: >- + Required. The DNS name suffix for the zones e.g. `example.com.`. + Cloud DNS requires that a DNS suffix ends with a trailing dot. + type: string + RemoveDnsZoneRequest: + id: RemoveDnsZoneRequest + description: >- + Request to remove a private managed DNS zone in the shared producer host + project and a matching DNS peering zone in the consumer project. + type: object + properties: + consumerNetwork: + description: >- + Required. The network that the consumer is using to connect with + services. Must be in the form of + projects/{project}/global/networks/{network} {project} is the + project number, as in '12345' {network} is the network name. + type: string + name: + description: >- + Required. The name for both the private zone in the shared producer + host project and the peering zone in the consumer project. + type: string + ListDnsZonesResponse: + id: ListDnsZonesResponse + description: >- + Represents all DNS zones in the shared producer host project and the + matching peering zones in the consumer project. + type: object + properties: + dnsZonePairs: + description: >- + All pairs of private DNS zones in the shared producer host project + and the matching peering zones in the consumer project.. + type: array + items: + $ref: '#/components/schemas/DnsZonePair' + DnsZonePair: + id: DnsZonePair + description: '* Represents a pair of private and peering DNS zone resources. *' type: object - id: GetDnsZoneResponse properties: producerPrivateZone: - description: The private DNS zone created in the shared producer host project. + description: The private DNS zone in the shared producer host project. $ref: '#/components/schemas/DnsZone' consumerPeeringZone: + description: The DNS peering zone in the consumer project. $ref: '#/components/schemas/DnsZone' - description: The DNS peering zone created in the consumer project. + DnsZone: + id: DnsZone + description: Represents a DNS zone resource. + type: object + properties: + name: + description: >- + User assigned name for this resource. Must be unique within the + project. The name must be 1-63 characters long, must begin with a + letter, end with a letter or digit, and only contain lowercase + letters, digits or dashes. + type: string + dnsSuffix: + description: >- + The DNS name suffix of this zone e.g. `example.com.`. Cloud DNS + requires that a DNS suffix ends with a trailing dot. + type: string + GetDnsZoneResponse: + id: GetDnsZoneResponse description: >- Represents managed DNS zones created in the shared Producer host and consumer projects. - RemoveDnsZoneRequest: type: object + properties: + producerPrivateZone: + description: The private DNS zone created in the shared producer host project. + $ref: '#/components/schemas/DnsZone' + consumerPeeringZone: + description: The DNS peering zone created in the consumer project. + $ref: '#/components/schemas/DnsZone' + AddDnsRecordSetRequest: + id: AddDnsRecordSetRequest description: >- - Request to remove a private managed DNS zone in the shared producer host - project and a matching DNS peering zone in the consumer project. + Request to add a record set to a private managed DNS zone in the shared + producer host project. + type: object properties: - name: - description: >- - Required. The name for both the private zone in the shared producer - host project and the peering zone in the consumer project. - type: string consumerNetwork: - type: string description: >- Required. The network that the consumer is using to connect with services. Must be in the form of projects/{project}/global/networks/{network} {project} is the project number, as in '12345' {network} is the network name. - id: RemoveDnsZoneRequest - BillingDestination: - id: BillingDestination - properties: - monitoredResource: - description: >- - The monitored resource type. The type must be defined in - Service.monitored_resources section. type: string - metrics: + zone: description: >- - Names of the metrics to report to this billing destination. Each - name must be defined in Service.metrics section. - items: - type: string - type: array - description: >- - Configuration of a specific billing destination (Currently only support - bill against consumer project). - type: object + Required. The name of the private DNS zone in the shared producer + host project to which the record set will be added. + type: string + dnsRecordSet: + description: Required. The DNS record set to add. + $ref: '#/components/schemas/DnsRecordSet' DnsRecordSet: - description: Represents a DNS record set resource. id: DnsRecordSet + description: Represents a DNS record set resource. + type: object properties: + domain: + description: >- + Required. The DNS or domain name of the record set, e.g. + `test.example.com`. Cloud DNS requires that a DNS suffix ends with a + trailing dot. + type: string type: description: Required. The identifier of a supported record type. type: string @@ -908,739 +989,559 @@ components: by resolvers. type: string format: google-duration - domain: - type: string - description: >- - Required. The DNS or domain name of the record set, e.g. - `test.example.com`. Cloud DNS requires that a DNS suffix ends with a - trailing dot. data: - items: - type: string - type: array description: >- Required. As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) for examples see https://cloud.google.com/dns/records/json-record. + type: array + items: + type: string + RemoveDnsRecordSetRequest: + id: RemoveDnsRecordSetRequest + description: >- + Request to remove a record set from a private managed DNS zone in the + shared producer host project. The name, type, ttl, and data values must + all exactly match an existing record set in the specified zone. type: object - CloudSQLConfig: - type: object - id: CloudSQLConfig - properties: - umbrellaNetwork: - type: string - description: The name of the umbrella network in the Cloud SQL umbrella project. - umbrellaProject: - format: int64 - description: The project number of the Cloud SQL umbrella project. - type: string - service: - description: Peering service used for peering with the Cloud SQL project. - type: string - description: Cloud SQL configuration. - SecondaryIpRange: properties: - rangeName: + consumerNetwork: + description: >- + Required. The network that the consumer is using to connect with + services. Must be in the form of + projects/{project}/global/networks/{network} {project} is the + project number, as in '12345' {network} is the network name. type: string - description: Name of the secondary IP range. - ipCidrRange: + zone: + description: >- + Required. The name of the private DNS zone in the shared producer + host project from which the record set will be removed. type: string - description: Secondary IP CIDR range in `x.x.x.x/y` format. - type: object - id: SecondaryIpRange - ExperimentalFeatures: + dnsRecordSet: + description: Required. The DNS record set to remove. + $ref: '#/components/schemas/DnsRecordSet' + UpdateDnsRecordSetRequest: + id: UpdateDnsRecordSetRequest description: >- - Experimental features to be included during client library generation. - These fields will be deprecated once the feature graduates and is - enabled by default. - properties: - restAsyncIoEnabled: - description: >- - Enables generation of asynchronous REST clients if `rest` transport - is enabled. By default, asynchronous REST clients will not be - generated. This feature will be enabled by default 1 month after - launching the feature in preview packages. - type: boolean - id: ExperimentalFeatures + Request to update a record set from a private managed DNS zone in the + shared producer host project. The name, type, ttl, and data values of + the existing record set must all exactly match an existing record set in + the specified zone. type: object - ListDnsRecordSetsResponse: properties: - dnsRecordSets: - description: DNS record Set Resource - items: - $ref: '#/components/schemas/DnsRecordSet' - type: array - description: Represents all DNS RecordSets associated with the producer network - id: ListDnsRecordSetsResponse - type: object - Backend: - type: object - id: Backend - properties: - rules: - description: >- - A list of API backend rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. - type: array - items: - $ref: '#/components/schemas/BackendRule' - description: '`Backend` defines the backend configuration for a service.' - AddRolesResponse: - type: object - id: AddRolesResponse - description: Represents IAM roles added to the shared VPC host project. - properties: - policyBinding: - items: - $ref: '#/components/schemas/PolicyBinding' - description: >- - Required. List of policy bindings that were added to the shared VPC - host project. - type: array - NodeSettings: - type: object - id: NodeSettings - description: Settings for Node client libraries. - properties: - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - CommonLanguageSettings: - description: Required information for every language. - id: CommonLanguageSettings - type: object - properties: - destinations: - items: - enum: - - CLIENT_LIBRARY_DESTINATION_UNSPECIFIED - - GITHUB - - PACKAGE_MANAGER - type: string - enumDescriptions: - - >- - Client libraries will neither be generated nor published to - package managers. - - >- - Generate the client library in a repo under - github.com/googleapis, but don't publish it to package managers. - - >- - Publish the library to package managers like nuget.org and - npmjs.com. - type: array - description: >- - The destination where API teams want this client library to be - published. - selectiveGapicGeneration: - description: >- - Configuration for which RPCs should be generated in the GAPIC - client. - $ref: '#/components/schemas/SelectiveGapicGeneration' - referenceDocsUri: - deprecated: true - type: string - description: >- - Link to automatically generated reference documentation. Example: - https://cloud.google.com/nodejs/docs/reference/asset/latest - SearchRangeRequest: - id: SearchRangeRequest - description: Request to search for an unused range within allocated ranges. - type: object - properties: - ipPrefixLength: - description: >- - Required. The prefix length of the IP range. Use usual CIDR range - notation. For example, '30' to find unused x.x.x.x/30 CIDR range. - Actual range will be determined using allocated range for the - consumer peered network and returned in the result. - format: int32 - type: integer - network: - description: >- - Network name in the consumer project. This network must have been - already peered with a shared VPC network using CreateConnection - method. Must be in a form - 'projects/{project}/global/networks/{network}'. {project} is a - project number, as in '12345' {network} is network name. - type: string - Method: - properties: - name: - type: string - description: The simple name of this method. - requestStreaming: - description: If true, the request is streamed. - type: boolean - requestTypeUrl: - description: A URL of the input message type. - type: string - responseTypeUrl: - type: string - description: The URL of the output message type. - responseStreaming: - type: boolean - description: If true, the response is streamed. - syntax: - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS - type: string - description: The source syntax of this method. - enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. - options: - description: Any metadata attached to the method. - items: - $ref: '#/components/schemas/Option' - type: array - type: object - description: Method represents a method of an API interface. - id: Method - DnsZonePair: - type: object - properties: - producerPrivateZone: - description: The private DNS zone in the shared producer host project. - $ref: '#/components/schemas/DnsZone' - consumerPeeringZone: - description: The DNS peering zone in the consumer project. - $ref: '#/components/schemas/DnsZone' - id: DnsZonePair - description: '* Represents a pair of private and peering DNS zone resources. *' - AddDnsRecordSetRequest: - type: object - description: >- - Request to add a record set to a private managed DNS zone in the shared - producer host project. - properties: - dnsRecordSet: - $ref: '#/components/schemas/DnsRecordSet' - description: Required. The DNS record set to add. consumerNetwork: - type: string description: >- Required. The network that the consumer is using to connect with services. Must be in the form of projects/{project}/global/networks/{network} {project} is the project number, as in '12345' {network} is the network name. - zone: type: string + zone: description: >- Required. The name of the private DNS zone in the shared producer - host project to which the record set will be added. - id: AddDnsRecordSetRequest - SourceContext: - properties: - fileName: + host project from which the record set will be removed. type: string + existingDnsRecordSet: + description: Required. The existing DNS record set to update. + $ref: '#/components/schemas/DnsRecordSet' + newDnsRecordSet: description: >- - The path-qualified name of the .proto file that contained the - associated protobuf element. For example: - `"google/protobuf/source_context.proto"`. - description: >- - `SourceContext` represents information about the source of a protobuf - element, like the file in which it is defined. + Required. The new values that the DNS record set should be updated + to hold. + $ref: '#/components/schemas/DnsRecordSet' + ListDnsRecordSetsResponse: + id: ListDnsRecordSetsResponse + description: Represents all DNS RecordSets associated with the producer network type: object - id: SourceContext - EnumValue: properties: - options: - description: Protocol buffer options. + dnsRecordSets: + description: DNS record Set Resource type: array items: - $ref: '#/components/schemas/Option' - name: - description: Enum value name. - type: string - number: - description: Enum value number. - type: integer - format: int32 - id: EnumValue - type: object - description: Enum value definition. - ConsumerProject: + $ref: '#/components/schemas/DnsRecordSet' + PeeredDnsDomain: + id: PeeredDnsDomain + description: >- + DNS domain suffix for which requests originating in the producer VPC + network are resolved in the associated consumer VPC network. type: object - id: ConsumerProject - description: Represents a consumer project. properties: - projectNum: + name: + description: >- + Required. User assigned name for this resource. Must be unique + within the consumer network. The name must be 1-63 characters long, + must begin with a letter, end with a letter or digit, and only + contain lowercase letters, digits or dashes. type: string + dnsSuffix: description: >- - Required. Project number of the consumer that is launching the - service instance. It can own the network that is peered with Google - or, be a service project in an XPN where the host project has the - network. - format: int64 - ValidateConsumerConfigRequest: + The DNS domain name suffix e.g. `example.com.`. Cloud DNS requires + that a DNS suffix ends with a trailing dot. + type: string + ListPeeredDnsDomainsResponse: + id: ListPeeredDnsDomainsResponse + description: Response to list peered DNS domains for a given connection. type: object properties: - consumerProject: - $ref: '#/components/schemas/ConsumerProject' + peeredDnsDomains: + description: The list of peered DNS domains. + type: array + items: + $ref: '#/components/schemas/PeeredDnsDomain' + Service: + id: Service + description: >- + `Service` is the root object of Google API service configuration + (service config). It describes the basic information about a logical + service, such as the service name and the user-facing title, and + delegates other aspects to sub-sections. Each sub-section is either a + proto message or a repeated proto message that configures a specific + aspect, such as auth. For more information, see each proto message + definition. Example: type: google.api.Service name: + calendar.googleapis.com title: Google Calendar API apis: - name: + google.calendar.v3.Calendar visibility: rules: - selector: + "google.calendar.v3.*" restriction: PREVIEW backend: rules: - selector: + "google.calendar.v3.*" address: calendar.example.com authentication: + providers: - id: google_calendar_auth jwks_uri: + https://www.googleapis.com/oauth2/v1/certs issuer: + https://securetoken.google.com rules: - selector: "*" requirements: + provider_id: google_calendar_auth + type: object + properties: + name: description: >- - NETWORK_NOT_IN_CONSUMERS_PROJECT, - NETWORK_NOT_IN_CONSUMERS_HOST_PROJECT, and HOST_PROJECT_NOT_FOUND - are done when consumer_project is provided. - validateNetwork: - type: boolean + The service name, which is a DNS-like logical identifier for the + service, such as `calendar.googleapis.com`. The service name + typically goes through DNS verification to make sure the owner of + the service also owns the DNS name. + type: string + title: description: >- - The validations will be performed in the order listed in the - ValidationError enum. The first failure will return. If a validation - is not requested, then the next one will be performed. - SERVICE_NETWORKING_NOT_ENABLED and NETWORK_NOT_PEERED checks are - performed for all requests where validation is requested. - NETWORK_NOT_FOUND and NETWORK_DISCONNECTED checks are done for - requests that have validate_network set to true. - checkServiceNetworkingUsePermission: - description: >- - Optional. The IAM permission check determines whether the consumer - project has 'servicenetworking.services.use' permission or not. - type: boolean - consumerNetwork: - description: >- - Required. The network that the consumer is using to connect with - services. Must be in the form of - projects/{project}/global/networks/{network} {project} is a project - number, as in '12345' {network} is network name. + The product title for this service, it is the name displayed in + Google Cloud Console. type: string - rangeReservation: - description: >- - RANGES_EXHAUSTED, RANGES_EXHAUSTED, and RANGES_DELETED_LATER are - done when range_reservation is provided. - $ref: '#/components/schemas/RangeReservation' - id: ValidateConsumerConfigRequest - UpdateDnsRecordSetRequest: - properties: - existingDnsRecordSet: - description: Required. The existing DNS record set to update. - $ref: '#/components/schemas/DnsRecordSet' - consumerNetwork: + producerProjectId: + description: The Google project that owns this service. type: string + id: description: >- - Required. The network that the consumer is using to connect with - services. Must be in the form of - projects/{project}/global/networks/{network} {project} is the - project number, as in '12345' {network} is the network name. - newDnsRecordSet: + A unique ID for a specific instance of this message, typically + assigned by the client for tracking purpose. Must be no longer than + 63 characters and only lower case letters, digits, '.', '_' and '-' + are allowed. If empty, the server may choose to generate one + instead. + type: string + apis: description: >- - Required. The new values that the DNS record set should be updated - to hold. - $ref: '#/components/schemas/DnsRecordSet' - zone: + A list of API interfaces exported by this service. Only the `name` + field of the google.protobuf.Api needs to be provided by the + configuration author, as the remaining fields will be derived from + the IDL during the normalization process. It is an error to specify + an API interface here which cannot be resolved against the + associated IDL files. + type: array + items: + $ref: '#/components/schemas/Api' + types: description: >- - Required. The name of the private DNS zone in the shared producer - host project from which the record set will be removed. - type: string - id: UpdateDnsRecordSetRequest - description: >- - Request to update a record set from a private managed DNS zone in the - shared producer host project. The name, type, ttl, and data values of - the existing record set must all exactly match an existing record set in - the specified zone. - type: object - AddSubnetworkRequest: - id: AddSubnetworkRequest - description: Request to create a subnetwork in a previously peered service network. - type: object - properties: - subnetworkUsers: + A list of all proto message types included in this API service. + Types referenced directly or indirectly by the `apis` are + automatically included. Messages which are not referenced but shall + be included, such as types used by the `google.protobuf.Any` type, + should be listed here by name by the configuration author. Example: + types: - name: google.protobuf.Int32 + type: array items: - type: string + $ref: '#/components/schemas/Type' + enums: description: >- - A list of members that are granted the - `roles/servicenetworking.subnetworkAdmin` role on the subnet. + A list of all enum types included in this API service. Enums + referenced directly or indirectly by the `apis` are automatically + included. Enums which are not referenced but shall be included + should be listed here by name by the configuration author. Example: + enums: - name: google.someapi.v1.SomeEnum type: array - skipRequestedAddressValidation: - type: boolean + items: + $ref: '#/components/schemas/Enum' + documentation: + description: Additional API documentation. + $ref: '#/components/schemas/Documentation' + backend: + description: API backend configuration. + $ref: '#/components/schemas/Backend' + http: + description: HTTP configuration. + $ref: '#/components/schemas/Http' + quota: + description: Quota configuration. + $ref: '#/components/schemas/Quota' + authentication: + description: Auth configuration. + $ref: '#/components/schemas/Authentication' + context: + description: Context configuration. + $ref: '#/components/schemas/Context' + usage: + description: Configuration controlling usage of this service. + $ref: '#/components/schemas/Usage' + customError: + description: Custom error configuration. + $ref: '#/components/schemas/CustomError' + endpoints: description: >- - Optional. Skips validating if the requested_address is in use by SN - VPC’s peering group. Compute Engine will still perform this check - and fail the request if the requested_address is in use. Note that - Compute Engine does not check for the existence of dynamic routes - when performing this check. Caller of this API should make sure that - there are no dynamic routes overlapping with the - requested_address/prefix_length IP address range otherwise the - created subnet could cause misrouting. - checkServiceNetworkingUsePermission: + Configuration for network endpoints. If this is empty, then an + endpoint with the same name as the service is automatically + generated to service all defined APIs. + type: array + items: + $ref: '#/components/schemas/Endpoint' + control: + description: Configuration for the service control plane. + $ref: '#/components/schemas/Control' + logs: + description: Defines the logs used by this service. + type: array + items: + $ref: '#/components/schemas/LogDescriptor' + metrics: + description: Defines the metrics used by this service. + type: array + items: + $ref: '#/components/schemas/MetricDescriptor' + monitoredResources: description: >- - Optional. The IAM permission check determines whether the consumer - project has 'servicenetworking.services.use' permission or not. - type: boolean - consumerNetwork: + Defines the monitored resources used by this service. This is + required by the Service.monitoring and Service.logging + configurations. + type: array + items: + $ref: '#/components/schemas/MonitoredResourceDescriptor' + billing: + description: Billing configuration. + $ref: '#/components/schemas/Billing' + logging: + description: Logging configuration. + $ref: '#/components/schemas/Logging' + monitoring: + description: Monitoring configuration. + $ref: '#/components/schemas/Monitoring' + systemParameters: + description: System parameter configuration. + $ref: '#/components/schemas/SystemParameters' + sourceInfo: description: >- - Required. The name of the service consumer's VPC network. The - network must have an existing private connection that was - provisioned through the connections.create method. The name must be - in the following format: - `projects/{project}/global/networks/{network}`, where {project} is a - project number, such as `12345`. {network} is the name of a VPC - network in the project. - type: string - privateIpv6GoogleAccess: - type: string + Output only. The source information for this configuration if + available. + $ref: '#/components/schemas/SourceInfo' + publishing: description: >- - Optional. The private IPv6 google access type for the VMs in this - subnet. For information about the access types that can be set using - this field, see - [subnetwork](https://cloud.google.com/compute/docs/reference/rest/v1/subnetworks) - in the Compute API documentation. - computeIdempotencyWindow: + Settings for [Google Cloud Client + libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) + generated from APIs defined as protocol buffers. + $ref: '#/components/schemas/Publishing' + systemTypes: description: >- - Optional. Specifies a custom time bucket for Arcus subnetwork - request idempotency. If two equivalent concurrent requests are made, - Arcus will know to ignore the request if it has already been - completed or is in progress. Only requests with matching - compute_idempotency_window have guaranteed idempotency. Changing - this time window between requests results in undefined behavior. - Zero (or empty) value with custom_compute_idempotency_window=true - specifies no idempotency (i.e. no request ID is provided to Arcus). - Maximum value of 14 days (enforced by Arcus limit). For more - information on how to use, see: go/revisit-sn-idempotency-window - format: google-duration - type: string - outsideAllocationPublicIpRange: + A list of all proto message types included in this API service. It + serves similar purpose as [google.api.Service.types], except that + these types are not needed by user-defined APIs. Therefore, they + will not show up in the generated discovery doc. This field should + only be used to define system APIs in ESF. + type: array + items: + $ref: '#/components/schemas/Type' + aspects: description: >- - Optional. Enable outside allocation using public IP addresses. Any - public IP range may be specified. If this field is provided, we will - not use customer reserved ranges for this primary IP range. - type: string - description: - type: string - description: Optional. Description of the subnet. - allowSubnetCidrRoutesOverlap: + Configuration aspects. This is a repeated field to allow multiple + aspects to be configured. The kind field in each ConfigAspect + specifies the type of aspect. The spec field contains the + configuration for that aspect. The schema for the spec field is + defined by the backend service owners. + type: array + items: + $ref: '#/components/schemas/Aspect' + configVersion: description: >- - Optional. Defines the allowSubnetCidrRoutesOverlap field of the - subnet, e.g. Available in alpha and beta according to [Compute API - documentation](https://cloud.google.com/compute/docs/reference/rest/beta/subnetworks/insert) - type: boolean - purpose: - type: string + Obsolete. Do not use. This field has no semantic meaning. The + service config compiler always sets this field to `3`. + type: integer + format: uint32 + Api: + id: Api + description: >- + Api is a light-weight descriptor for an API Interface. Interfaces are + also described as "protocol buffer services" in some contexts, such as + by the "service" keyword in a .proto file, but they are different from + API Services, which represent a concrete implementation of an interface + as opposed to simply a description of methods and bindings. They are + also sometimes simply referred to as "APIs" in other contexts, such as + the name of this message itself. See + https://cloud.google.com/apis/design/glossary for detailed terminology. + New usages of this message as an alternative to ServiceDescriptorProto + are strongly discouraged. This message does not reliability preserve all + information necessary to model the schema and preserve semantics. + Instead make use of FileDescriptorSet which preserves the necessary + information. + type: object + properties: + name: description: >- - Optional. Defines the purpose field of the subnet, e.g. - 'PRIVATE_SERVICE_CONNECT'. For information about the purposes that - can be set using this field, see - [subnetwork](https://cloud.google.com/compute/docs/reference/rest/v1/subnetworks) - in the Compute API documentation. - role: + The fully qualified name of this interface, including package name + followed by the interface's simple name. type: string - description: >- - Optional. Defines the role field of the subnet, e.g. 'ACTIVE'. For - information about the roles that can be set using this field, see - [subnetwork](https://cloud.google.com/compute/docs/reference/rest/v1/subnetworks) - in the Compute API documentation. - ipPrefixLength: - description: >- - Required. The prefix length of the subnet's IP address range. Use - CIDR range notation, such as `29` to provision a subnet with an - `x.x.x.x/29` CIDR range. The IP address range is drawn from a pool - of available ranges in the service consumer's allocated range. GCE - disallows subnets with prefix_length > 29 - type: integer - format: int32 - secondaryIpRangeSpecs: + methods: + description: The methods of this interface, in unspecified order. type: array - description: >- - Optional. A list of secondary IP ranges to be created within the new - subnetwork. items: - $ref: '#/components/schemas/SecondaryIpRangeSpec' - subnetwork: + $ref: '#/components/schemas/Method' + options: + description: Any metadata attached to the interface. + type: array + items: + $ref: '#/components/schemas/Option' + version: description: >- - Required. A name for the new subnet. For information about the - naming requirements, see - [subnetwork](/compute/docs/reference/rest/v1/subnetworks) in the - Compute API documentation. - type: string - internalRange: + A version string for this interface. If specified, must have the + form `major-version.minor-version`, as in `1.10`. If the minor + version is omitted, it defaults to zero. If the entire version field + is empty, the major version is derived from the package name, as + outlined below. If the field is not empty, the version in the + package name will be verified to be consistent with what is provided + here. The versioning schema uses [semantic + versioning](http://semver.org) where the major version number + indicates a breaking change and the minor version an additive, + non-breaking change. Both version numbers are signals to users what + to expect from different versions, and should be carefully chosen + based on the product plan. The major version is also reflected in + the package name of the interface, which must end in `v`, as in + `google.feature.v1`. For major versions 0 and 1, the suffix can be + omitted. Zero major versions must only be used for experimental, + non-GA interfaces. type: string + sourceContext: description: >- - Optional. The url of an Internal Range. Eg: - `projects//locations/global/internalRanges/`. If specified, it means - that the subnetwork cidr will be created using the combination of - requested_address/ip_prefix_length. Note that the subnet cidr has to - be within the cidr range of this Internal Range. - requestedRanges: + Source context for the protocol buffer service represented by this + message. + $ref: '#/components/schemas/SourceContext' + mixins: + description: Included interfaces. See Mixin. type: array - description: >- - Optional. The name of one or more allocated IP address ranges - associated with this private service access connection. If no range - names are provided all ranges associated with this connection will - be considered. If a CIDR range with the specified IP prefix length - is not available within these ranges, the call fails. items: - type: string - useCustomComputeIdempotencyWindow: - description: >- - Optional. Specifies if Service Networking should use a custom time - bucket for Arcus idempotency. If false, Service Networking uses a - 300 second (5 minute) Arcus idempotency window. If true, Service - Networking uses a custom idempotency window provided by the user in - field compute_idempotency_window. For more information on how to - use, see: go/revisit-sn-idempotency-window - type: boolean - requestedAddress: - description: >- - Optional. The starting address of a range. The address must be a - valid IPv4 address in the x.x.x.x format. This value combined with - the IP prefix range is the CIDR range for the subnet. The range must - be within the allocated range that is assigned to the private - connection. If the CIDR range isn't available, the call fails. + $ref: '#/components/schemas/Mixin' + syntax: + description: The source syntax of the service. type: string - region: + enumDescriptions: + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS + edition: description: >- - Required. The name of a [region](/compute/docs/regions-zones) for - the subnet, such `europe-west1`. - type: string - consumer: + The source edition string, only valid when syntax is + SYNTAX_EDITIONS. type: string - description: >- - Required. A resource that represents the service consumer, such as - `projects/123456`. The project number can be different from the - value in the consumer network parameter. For example, the network - might be part of a Shared VPC network. In those cases, Service - Networking validates that this resource belongs to that Shared VPC. - Documentation: + Method: + id: Method + description: >- + Method represents a method of an API interface. New usages of this + message as an alternative to MethodDescriptorProto are strongly + discouraged. This message does not reliability preserve all information + necessary to model the schema and preserve semantics. Instead make use + of FileDescriptorSet which preserves the necessary information. + type: object properties: - overview: - description: >- - Declares a single overview page. For example: documentation: - summary: ... overview: (== include overview.md ==) This is a - shortcut for the following declaration (using pages style): - documentation: summary: ... pages: - name: Overview content: (== - include overview.md ==) Note: you cannot specify both `overview` - field and `pages` field. + name: + description: The simple name of this method. type: string - serviceRootUrl: + requestTypeUrl: + description: A URL of the input message type. type: string - description: >- - Specifies the service root url if the default one (the service name - from the yaml file) is not suitable. This can be seen in any fully - specified service urls as well as sections that show a base that - other urls are relative to. - sectionOverrides: - items: - $ref: '#/components/schemas/Page' - description: >- - Specifies section and content to override boilerplate content - provided by go/api-docgen. Currently overrides following sections: - 1. rest.service.client_libraries + requestStreaming: + description: If true, the request is streamed. + type: boolean + responseTypeUrl: + description: The URL of the output message type. + type: string + responseStreaming: + description: If true, the response is streamed. + type: boolean + options: + description: Any metadata attached to the method. type: array - summary: + items: + $ref: '#/components/schemas/Option' + syntax: description: >- - A short description of what the service does. The summary must be - plain text. It becomes the overview of the service displayed in - Google Cloud Console. NOTE: This field is equivalent to the standard - field `description`. - type: string - documentationRootUrl: + The source syntax of this method. This field should be ignored, + instead the syntax should be inherited from Api. This is similar to + Field and EnumValue. + deprecated: true type: string - description: The URL to the root of documentation. - pages: - items: - $ref: '#/components/schemas/Page' - description: The top level pages for the documentation set. - type: array - rules: - type: array + enumDescriptions: + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS + edition: description: >- - A list of documentation rules that apply to individual API elements. - **NOTE:** All service configuration rules follow "last one wins" - order. - items: - $ref: '#/components/schemas/DocumentationRule' + The source edition string, only valid when syntax is + SYNTAX_EDITIONS. This field should be ignored, instead the edition + should be inherited from Api. This is similar to Field and + EnumValue. + deprecated: true + type: string + Option: + id: Option description: >- - `Documentation` provides the information for describing a service. - Example: documentation: summary: > The Google Calendar API gives access - to most calendar features. pages: - name: Overview content: (== include - google/foo/overview.md ==) - name: Tutorial content: (== include - google/foo/tutorial.md ==) subpages: - name: Java content: (== include - google/foo/tutorial_java.md ==) rules: - selector: - google.calendar.Calendar.Get description: > ... - selector: - google.calendar.Calendar.Put description: > ... Documentation is - provided in markdown syntax. In addition to standard markdown features, - definition lists, tables and fenced code blocks are supported. Section - headers can be provided and are interpreted relative to the section - nesting of the context where a documentation fragment is embedded. - Documentation from the IDL is merged with documentation defined via the - config at normalization time, where documentation provided by config - rules overrides IDL provided. A number of constructs specific to the API - platform are supported in documentation text. In order to reference a - proto element, the following notation can be used: - [fully.qualified.proto.name][] To override the display text used for the - link, this can be used: [display text][fully.qualified.proto.name] Text - can be excluded from doc using the following notation: (-- internal - comment --) A few directives are available in documentation. Note that - directives must appear on a single line to be properly identified. The - `include` directive includes a markdown file from an external source: - (== include path/to/file ==) The `resource_for` directive marks a - message to be the resource of a collection in REST view. If it is not - specified, tools attempt to infer the resource from the operations in a - collection: (== resource_for v1.shelves.books ==) The directive - `suppress_warning` does not directly affect documentation and is - documented together with service config validation. + A protocol buffer option, which can be attached to a message, field, + enumeration, etc. New usages of this message as an alternative to + FileOptions, MessageOptions, FieldOptions, EnumOptions, + EnumValueOptions, ServiceOptions, or MethodOptions are strongly + discouraged. type: object - id: Documentation - AddDnsZoneResponse: properties: - producerPrivateZone: - description: The private DNS zone created in the shared producer host project. - $ref: '#/components/schemas/DnsZone' - consumerPeeringZone: - description: The DNS peering zone created in the consumer project. - $ref: '#/components/schemas/DnsZone' + name: + description: >- + The option's name. For protobuf built-in options (options defined in + descriptor.proto), this is the short name. For example, + `"map_entry"`. For custom options, it should be the fully-qualified + name. For example, `"google.api.http"`. + type: string + value: + description: >- + The option's value packed in an Any message. If the value is a + primitive, the corresponding wrapper type defined in + google/protobuf/wrappers.proto should be used. If the value is an + enum, it should be stored as an int32 value using the + google.protobuf.Int32Value type. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + SourceContext: + id: SourceContext description: >- - Represents managed DNS zones created in the shared producer host and - consumer projects. - type: object - id: AddDnsZoneResponse - AddDnsZoneMetadata: - id: AddDnsZoneMetadata + `SourceContext` represents information about the source of a protobuf + element, like the file in which it is defined. type: object - description: >- - Metadata provided through GetOperation request for the LRO generated by - AddDnsZone API - properties: {} - Page: properties: - content: - type: string + fileName: description: >- - The Markdown content of the page. You can use (== include {path} ==) - to include content from a Markdown file. The content can be used to - produce the documentation page such as HTML format page. - name: - type: string - description: >- - The name of the page. It will be used as an identity of the page to - generate URI of the page, text of the link to this page in - navigation, etc. The full page name (start from the root page name - to this page concatenated with `.`) can be used as reference to the - page in your documentation. For example: pages: - name: Tutorial - content: (== include tutorial.md ==) subpages: - name: Java content: - (== include tutorial_java.md ==) You can reference `Java` page using - Markdown reference link syntax: `Java`. - subpages: - description: >- - Subpages of this page. The order of subpages specified here will be - honored in the generated docset. - type: array - items: - $ref: '#/components/schemas/Page' - type: object + The path-qualified name of the .proto file that contained the + associated protobuf element. For example: + `"google/protobuf/source_context.proto"`. + type: string + Mixin: + id: Mixin description: >- - Represents a documentation page. A page can contain subpages to - represent nested documentation set structure. - id: Page - AddRolesRequest: + Declares an API Interface to be included in this interface. The + including interface must redeclare all the methods from the included + interface, but documentation and options are inherited as follows: - If + after comment and whitespace stripping, the documentation string of the + redeclared method is empty, it will be inherited from the original + method. - Each annotation belonging to the service config (http, + visibility) which is not set in the redeclared method will be inherited. + - If an http annotation is inherited, the path pattern will be modified + as follows. Any version prefix will be replaced by the version of the + including interface plus the root path if specified. Example of a simple + mixin: package google.acl.v1; service AccessControl { // Get the + underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option + (google.api.http).get = "/v1/{resource=**}:getAcl"; } } package + google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) + returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns + (Data) { option (google.api.http).get = "/v2/{resource=**}"; } } Example + of a mixin configuration: apis: - name: google.storage.v2.Storage + mixins: - name: google.acl.v1.AccessControl The mixin construct implies + that all methods in `AccessControl` are also declared with same name and + request/response types in `Storage`. A documentation generator or + annotation processor will see the effective `Storage.GetAcl` method + after inheriting documentation and annotations as follows: service + Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) + returns (Acl) { option (google.api.http).get = + "/v2/{resource=**}:getAcl"; } ... } Note how the version in the path + pattern changed from `v1` to `v2`. If the `root` field in the mixin is + specified, it should be a relative path under which inherited HTTP paths + are placed. Example: apis: - name: google.storage.v2.Storage mixins: - + name: google.acl.v1.AccessControl root: acls This implies the following + inherited HTTP annotation: service Storage { // Get the underlying ACL + object. rpc GetAcl(GetAclRequest) returns (Acl) { option + (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; } ... } type: object - id: AddRolesRequest properties: - consumerNetwork: + name: + description: The fully qualified name of the interface which is included. + type: string + root: description: >- - Required. The network that the consumer is using to connect with - services. Must be in the form of - projects/{project}/global/networks/{network} {project} is a project - number, as in '12345' {network} is a network name. + If non-empty specifies a path under which inherited HTTP paths are + rooted. type: string - policyBinding: - description: Required. List of policy bindings to add to shared VPC host project. - items: - $ref: '#/components/schemas/PolicyBinding' - type: array + Type: + id: Type description: >- - Request for AddRoles to allow Service Producers to add roles in the - shared VPC host project for them to use. - ConsumerConfig: - description: Configuration information for a private service access connection. - id: ConsumerConfig + A protocol buffer message type. New usages of this message as an + alternative to DescriptorProto are strongly discouraged. This message + does not reliability preserve all information necessary to model the + schema and preserve semantics. Instead make use of FileDescriptorSet + which preserves the necessary information. + type: object properties: - consumerExportSubnetRoutesWithPublicIp: - type: boolean - description: >- - Export subnet routes with public ip flag value for peering from - consumer to producer. - reservedRanges: + name: + description: The fully qualified message name. + type: string + fields: + description: The list of fields. type: array - readOnly: true items: - $ref: >- - #/components/schemas/GoogleCloudServicenetworkingV1ConsumerConfigReservedRange - description: >- - Output only. The reserved ranges associated with this private - service access connection. - usedIpRanges: - readOnly: true + $ref: '#/components/schemas/Field' + oneofs: + description: The list of types appearing in `oneof` definitions in this type. + type: array items: type: string + options: + description: The protocol buffer options. type: array - description: Output only. The IP ranges already in use by consumer or producer - producerImportSubnetRoutesWithPublicIp: - type: boolean - description: >- - Import subnet routes with public ip flag value for peering from - producer to consumer. - vpcScReferenceArchitectureEnabled: - type: boolean - readOnly: true - description: >- - Output only. Indicates whether the VPC Service Controls reference - architecture is configured for the producer VPC host network. - producerNetwork: - readOnly: true - description: >- - Output only. The VPC host network that is used to host managed - service instances. In the format, - projects/{project}/global/networks/{network} where {project} is the - project number e.g. '12345' and {network} is the network name. - type: string - cloudsqlConfigs: - description: Represents one or multiple Cloud SQL configurations. items: - $ref: '#/components/schemas/CloudSQLConfig' - type: array - consumerImportCustomRoutes: - type: boolean - description: >- - Import custom routes flag value for peering from consumer to - producer. - producerExportCustomRoutes: - description: >- - Export custom routes flag value for peering from producer to - consumer. - type: boolean - consumerExportCustomRoutes: - type: boolean - description: >- - Export custom routes flag value for peering from consumer to - producer. - consumerImportSubnetRoutesWithPublicIp: - type: boolean - description: >- - Import subnet routes with public ip flag value for peering from - consumer to producer. - producerImportCustomRoutes: - description: >- - Import custom routes flag value for peering from producer to - consumer. - type: boolean - producerExportSubnetRoutesWithPublicIp: - type: boolean + $ref: '#/components/schemas/Option' + sourceContext: + description: The source context. + $ref: '#/components/schemas/SourceContext' + syntax: + description: The source syntax. + type: string + enumDescriptions: + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS + edition: description: >- - Export subnet routes with public ip flag value for peering from - producer to consumer. - type: object + The source edition string, only valid when syntax is + SYNTAX_EDITIONS. + type: string Field: + id: Field + description: >- + A single field of a message type. New usages of this message as an + alternative to FieldDescriptorProto are strongly discouraged. This + message does not reliability preserve all information necessary to model + the schema and preserve semantics. Instead make use of FileDescriptorSet + which preserves the necessary information. type: object - description: A single field of a message type. properties: - jsonName: - description: The field JSON name. - type: string kind: + description: The field type. + type: string enumDescriptions: - Field type unknown. - Field type double. @@ -1681,1370 +1582,421 @@ components: - TYPE_SFIXED64 - TYPE_SINT32 - TYPE_SINT64 - type: string - description: The field type. - defaultValue: - type: string - description: >- - The string value of the default value of this field. Proto2 syntax - only. - name: - description: The field name. - type: string - options: - description: The protocol buffer options. - items: - $ref: '#/components/schemas/Option' - type: array cardinality: description: The field cardinality. - enum: - - CARDINALITY_UNKNOWN - - CARDINALITY_OPTIONAL - - CARDINALITY_REQUIRED - - CARDINALITY_REPEATED + type: string enumDescriptions: - For fields with unknown cardinality. - For optional fields. - For required fields. Proto2 syntax only. - For repeated fields. + enum: + - CARDINALITY_UNKNOWN + - CARDINALITY_OPTIONAL + - CARDINALITY_REQUIRED + - CARDINALITY_REPEATED + number: + description: The field number. + type: integer + format: int32 + name: + description: The field name. type: string - packed: - type: boolean - description: Whether to use alternative packed wire representation. typeUrl: description: >- The field type URL, without the scheme, for message or enumeration types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. type: string oneofIndex: - format: int32 - type: integer description: >- The index of the field type in `Type.oneofs`, for message or enumeration types. The first type has index 1; zero means the type is not in the list. - number: type: integer - description: The field number. format: int32 - id: Field - UpdateConsumerConfigRequest: - id: UpdateConsumerConfigRequest - properties: - consumerConfig: - description: Required. The updated peering config. - $ref: '#/components/schemas/ConsumerConfig' - description: >- - Request to update the configuration of a service networking connection - including the import/export of custom routes and subnetwork routes with - public IP. - type: object - MethodSettings: - id: MethodSettings - type: object - properties: - autoPopulatedFields: + packed: + description: Whether to use alternative packed wire representation. + type: boolean + options: + description: The protocol buffer options. type: array + items: + $ref: '#/components/schemas/Option' + jsonName: + description: The field JSON name. + type: string + defaultValue: description: >- - List of top-level fields of the request message, that should be - automatically populated by the client libraries based on their - (google.api.field_info).format. Currently supported format: UUID4. - Example of a YAML configuration: publishing: method_settings: - - selector: google.example.v1.ExampleService.CreateExample - auto_populated_fields: - request_id - items: - type: string - longRunning: - $ref: '#/components/schemas/LongRunning' - description: >- - Describes settings to use for long-running operations when - generating API methods for RPCs. Complements RPCs that use the - annotations in google/longrunning/operations.proto. Example of a - YAML configuration:: publishing: method_settings: - selector: - google.cloud.speech.v2.Speech.BatchRecognize long_running: - initial_poll_delay: 60s # 1 minute poll_delay_multiplier: 1.5 - max_poll_delay: 360s # 6 minutes total_poll_timeout: 54000s # 90 - minutes - selector: - type: string - description: >- - The fully qualified name of the method, for which the options below - apply. This is used to find the method to apply the options. - Example: publishing: method_settings: - selector: - google.storage.control.v2.StorageControl.CreateFolder # method - settings for CreateFolder... - description: Describes the generator configuration for a method. - MetricDescriptor: - properties: - launchStage: - description: Optional. The launch stage of the metric definition. - enum: - - LAUNCH_STAGE_UNSPECIFIED - - UNIMPLEMENTED - - PRELAUNCH - - EARLY_ACCESS - - ALPHA - - BETA - - GA - - DEPRECATED - type: string - enumDescriptions: - - Do not use this default value. - - The feature is not yet implemented. Users can not use it. - - >- - Prelaunch features are hidden from users and are only visible - internally. - - >- - Early Access features are limited to a closed group of testers. To - use these features, you must sign up in advance and sign a Trusted - Tester agreement (which includes confidentiality provisions). - These features may be unstable, changed in backward-incompatible - ways, and are not guaranteed to be released. - - >- - Alpha is a limited availability test for releases before they are - cleared for widespread use. By Alpha, all significant design - issues are resolved and we are in the process of verifying - functionality. Alpha customers need to apply for access, agree to - applicable terms, and have their projects allowlisted. Alpha - releases don't have to be feature complete, no SLAs are provided, - and there are no technical support obligations, but they will be - far enough along that customers can actually use them in test - environments or for limited-use tests -- just like they would in - normal production cases. - - >- - Beta is the point at which we are ready to open a release for any - customer to use. There are no SLA or technical support obligations - in a Beta release. Products will be complete from a feature - perspective, but may have some open outstanding issues. Beta - releases are suitable for limited production use cases. - - >- - GA features are open to all developers and are considered stable - and fully qualified for production use. - - >- - Deprecated features are scheduled to be shut down and removed. For - more information, see the "Deprecation Policy" section of our - [Terms of Service](https://cloud.google.com/terms/) and the - [Google Cloud Platform Subject to the Deprecation - Policy](https://cloud.google.com/terms/deprecation) documentation. - valueType: - enum: - - VALUE_TYPE_UNSPECIFIED - - BOOL - - INT64 - - DOUBLE - - STRING - - DISTRIBUTION - - MONEY - description: >- - Whether the measurement is an integer, a floating-point number, etc. - Some combinations of `metric_kind` and `value_type` might not be - supported. - enumDescriptions: - - Do not use this default value. - - >- - The value is a boolean. This value type can be used only if the - metric kind is `GAUGE`. - - The value is a signed 64-bit integer. - - The value is a double precision floating point number. - - >- - The value is a text string. This value type can be used only if - the metric kind is `GAUGE`. - - The value is a `Distribution`. - - The value is money. - type: string - monitoredResourceTypes: - description: >- - Read-only. If present, then a time series, which is identified - partially by a metric type and a MonitoredResourceDescriptor, that - is associated with this metric type can only be associated with one - of the monitored resource types listed here. - type: array - items: - type: string - unit: - description: >- - The units in which the metric value is reported. It is only - applicable if the `value_type` is `INT64`, `DOUBLE`, or - `DISTRIBUTION`. The `unit` defines the representation of the stored - metric values. Different systems might scale the values to be more - easily displayed (so a value of `0.02kBy` _might_ be displayed as - `20By`, and a value of `3523kBy` _might_ be displayed as `3.5MBy`). - However, if the `unit` is `kBy`, then the value of the metric is - always in thousands of bytes, no matter how it might be displayed. - If you want a custom metric to record the exact number of - CPU-seconds used by a job, you can create an `INT64 CUMULATIVE` - metric whose `unit` is `s{CPU}` (or equivalently `1s{CPU}` or just - `s`). If the job uses 12,005 CPU-seconds, then the value is written - as `12005`. Alternatively, if you want a custom metric to record - data in a more granular way, you can create a `DOUBLE CUMULATIVE` - metric whose `unit` is `ks{CPU}`, and then write the value `12.005` - (which is `12005/1000`), or use `Kis{CPU}` and write `11.723` (which - is `12005/1024`). The supported units are a subset of [The Unified - Code for Units of Measure](https://unitsofmeasure.org/ucum.html) - standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` - second * `min` minute * `h` hour * `d` day * `1` dimensionless - **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga - (10^9) * `T` tera (10^12) * `P` peta (10^15) * `E` exa (10^18) * `Z` - zetta (10^21) * `Y` yotta (10^24) * `m` milli (10^-3) * `u` micro - (10^-6) * `n` nano (10^-9) * `p` pico (10^-12) * `f` femto (10^-15) - * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto (10^-24) * `Ki` - kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) - * `Pi` pebi (2^50) **Grammar** The grammar also includes these - connectors: * `/` division or ratio (as an infix operator). For - examples, `kBy/{email}` or `MiBy/10ms` (although you should almost - never have `/s` in a metric `unit`; rates should always be computed - at query time from the underlying cumulative or delta value). * `.` - multiplication or composition (as an infix operator). For examples, - `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: - Expression = Component { "." Component } { "/" Component } ; - Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | - "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a - comment if it follows a `UNIT`. If the annotation is used alone, - then the unit is equivalent to `1`. For examples, `{request}/s == - 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of - non-blank printable ASCII characters not containing `{` or `}`. * - `1` represents a unitary [dimensionless - unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, - such as in `1/s`. It is typically used when none of the basic units - are appropriate. For example, "new users per day" can be represented - as `1/d` or `{new-users}/d` (and a metric value `5` would mean "5 - new users). Alternatively, "thousands of page views per day" would - be represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a - metric value of `5.3` would mean "5300 page views per day"). * `%` - represents dimensionless value of 1/100, and annotates values giving - a percentage (so the metric values are typically in the range of - 0..100, and a metric value `3` means "3 percent"). * `10^2.%` - indicates a metric contains a ratio, typically in the range 0..1, - that will be multiplied by 100 and displayed as a percentage (so a - metric value `0.03` means "3 percent"). - type: string - type: - type: string - description: >- - The metric type, including its DNS name prefix. The type is not - URL-encoded. All user-defined metric types have the DNS name - `custom.googleapis.com` or `external.googleapis.com`. Metric types - should use a natural hierarchical grouping. For example: - "custom.googleapis.com/invoice/paid/amount" - "external.googleapis.com/prometheus/up" - "appengine.googleapis.com/http/server/response_latencies" - displayName: - description: >- - A concise name for the metric, which can be displayed in user - interfaces. Use sentence case without an ending period, for example - "Request count". This field is optional but it is recommended to be - set for any metrics associated with user-visible concepts, such as - Quota. - type: string - metadata: - description: Optional. Metadata which can be used to guide usage of the metric. - $ref: '#/components/schemas/MetricDescriptorMetadata' - labels: - type: array - description: >- - The set of labels that can be used to describe a specific instance - of this metric type. For example, the - `appengine.googleapis.com/http/server/response_latencies` metric - type has a label for the HTTP response code, `response_code`, so you - can look at latencies for successful responses or just for responses - that failed. - items: - $ref: '#/components/schemas/LabelDescriptor' - name: - description: The resource name of the metric descriptor. - type: string - metricKind: - enum: - - METRIC_KIND_UNSPECIFIED - - GAUGE - - DELTA - - CUMULATIVE - description: >- - Whether the metric records instantaneous values, changes to a value, - etc. Some combinations of `metric_kind` and `value_type` might not - be supported. - type: string - enumDescriptions: - - Do not use this default value. - - An instantaneous measurement of a value. - - The change in a value during a time interval. - - >- - A value accumulated over a time interval. Cumulative measurements - in a time series should have the same start time and increasing - end times, until an event resets the cumulative value to zero and - sets a new start time for the following points. - description: - description: >- - A detailed description of the metric, which can be used in - documentation. - type: string - description: >- - Defines a metric type and its schema. Once a metric descriptor is - created, deleting or altering it stops data collection and makes the - metric type's existing data unusable. - id: MetricDescriptor - type: object - AuthProvider: - properties: - jwksUri: - description: >- - URL of the provider's public key set to validate signature of the - JWT. See [OpenID - Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). - Optional if the key set document: - can be retrieved from [OpenID - Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html) - of the issuer. - can be inferred from the email domain of the issuer - (e.g. a Google service account). Example: - https://www.googleapis.com/oauth2/v1/certs - type: string - authorizationUrl: - description: >- - Redirect URL if JWT token is required but not present or is expired. - Implement authorizationUrl of securityDefinitions in OpenAPI spec. - type: string - issuer: - description: >- - Identifies the principal that issued the JWT. See - https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 - Usually a URL or an email address. Example: - https://securetoken.google.com Example: - 1234567-compute@developer.gserviceaccount.com - type: string - jwtLocations: - description: >- - Defines the locations to extract the JWT. For now it is only used by - the Cloud Endpoints to store the OpenAPI extension - [x-google-jwt-locations] - (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) - JWT locations can be one of HTTP headers, URL query parameters or - cookies. The rule is that the first match wins. If not specified, - default to use following 3 locations: 1) Authorization: Bearer 2) - x-goog-iap-jwt-assertion 3) access_token query parameter Default - locations can be specified as followings: jwt_locations: - header: - Authorization value_prefix: "Bearer " - header: - x-goog-iap-jwt-assertion - query: access_token - type: array - items: - $ref: '#/components/schemas/JwtLocation' - id: - type: string - description: >- - The unique identifier of the auth provider. It will be referred to - by `AuthRequirement.provider_id`. Example: "bookstore_auth". - audiences: - type: string - description: >- - The list of JWT - [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). - that are allowed to access. A JWT containing any of these audiences - will be accepted. When this setting is absent, JWTs with audiences: - - "https://[service.name]/[google.protobuf.Api.name]" - - "https://[service.name]/" will be accepted. For example, if no - audiences are in the setting, LibraryService API will accept JWTs - with the following audiences: - - https://library-example.googleapis.com/google.example.library.v1.LibraryService - - https://library-example.googleapis.com/ Example: audiences: - bookstore_android.apps.googleusercontent.com, - bookstore_web.apps.googleusercontent.com - type: object - description: >- - Configuration for an authentication provider, including support for - [JSON Web Token - (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). - id: AuthProvider - RangeReservation: - type: object - id: RangeReservation - properties: - ipPrefixLength: - format: int32 - description: >- - Required. The size of the desired subnet. Use usual CIDR range - notation. For example, '29' to find unused x.x.x.x/29 CIDR range. - The goal is to determine if one of the allocated ranges has enough - free space for a subnet of the requested size. GCE disallows subnets - with prefix_length > 29 - type: integer - requestedRanges: - type: array - items: - type: string - description: >- - Optional. The name of one or more allocated IP address ranges - associated with this private service access connection. If no range - names are provided all ranges associated with this connection will - be considered. If a CIDR range with the specified IP prefix length - is not available within these ranges the validation fails. - secondaryRangeIpPrefixLengths: - description: >- - Optional. The size of the desired secondary ranges for the subnet. - Use usual CIDR range notation. For example, '29' to find unused - x.x.x.x/29 CIDR range. The goal is to determine that the allocated - ranges have enough free space for all the requested secondary - ranges. GCE disallows subnets with prefix_length > 29 - type: array - items: - format: int32 - type: integer - subnetworkCandidates: - items: - $ref: '#/components/schemas/Subnetwork' - description: >- - Optional. List of subnetwork candidates to validate. The required - input fields are `name`, `network`, and `region`. Subnetworks from - this list which exist will be returned in the response with the - `ip_cidr_range`, `secondary_ip_cider_ranges`, and - `outside_allocation` fields set. - type: array - description: Represents a range reservation. - DotnetSettings: - type: object - id: DotnetSettings - properties: - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - handwrittenSignatures: - type: array - description: >- - Method signatures (in the form "service.method(signature)") which - are provided separately, so shouldn't be generated. Snippets - *calling* these methods are still generated, however. - items: - type: string - forcedNamespaceAliases: - items: - type: string - type: array - description: >- - Namespaces which must be aliased in snippets due to a known (but - non-generator-predictable) naming collision - renamedResources: - description: >- - Map from full resource types to the effective short name for the - resource. This is used when otherwise resource named from different - services would cause naming collisions. Example entry: - "datalabeling.googleapis.com/Dataset": "DataLabelingDataset" - type: object - additionalProperties: - type: string - renamedServices: - description: >- - Map from original service names to renamed versions. This is used - when the default generated types would cause a naming conflict. - (Neither name is fully-qualified.) Example: Subscriber to - SubscriberServiceApi. - additionalProperties: - type: string - type: object - ignoredResources: - description: >- - List of full resource types to ignore during generation. This is - typically used for API-specific Location resources, which should be - handled by the generator as if they were actually the common - Location resources. Example entry: - "documentai.googleapis.com/Location" - items: - type: string - type: array - description: Settings for Dotnet client libraries. - GoogleCloudServicenetworkingV1betaConnection: - type: object - properties: - peering: - type: string - description: >- - Output only. The name of the VPC Network Peering connection that was - created by the service producer. - network: - type: string - description: >- - The name of service consumer's VPC network that's connected with - service producer network, in the following format: - `projects/{project}/global/networks/{network}`. `{project}` is a - project number, such as in `12345` that includes the VPC service - consumer's VPC network. `{network}` is the name of the service - consumer's VPC network. - service: - type: string - description: >- - Output only. The name of the peering service that's associated with - this connection, in the following format: `services/{service name}`. - reservedPeeringRanges: - type: array - items: - type: string - description: >- - The name of one or more allocated IP address ranges for this service - producer of type `PEERING`. Note that invoking this method with a - different range when connection is already established will not - modify already provisioned service producer subnetworks. - id: GoogleCloudServicenetworkingV1betaConnection - description: >- - Represents a private connection resource. A private connection is - implemented as a VPC Network Peering connection between a service - producer's VPC network and a service consumer's VPC network. - LabelDescriptor: - properties: - description: - type: string - description: A human-readable description for the label. - valueType: - description: The type of data that can be assigned to the label. - enumDescriptions: - - A variable-length string. This is the default. - - Boolean; true or false. - - A 64-bit signed integer. - type: string - enum: - - STRING - - BOOL - - INT64 - key: - description: The label key. - type: string - type: object - id: LabelDescriptor - description: A description of a label. - PeeredDnsDomain: - id: PeeredDnsDomain - type: object - description: >- - DNS domain suffix for which requests originating in the producer VPC - network are resolved in the associated consumer VPC network. - properties: - dnsSuffix: - type: string - description: >- - The DNS domain name suffix e.g. `example.com.`. Cloud DNS requires - that a DNS suffix ends with a trailing dot. - name: - type: string - description: >- - User assigned name for this resource. Must be unique within the - consumer network. The name must be 1-63 characters long, must begin - with a letter, end with a letter or digit, and only contain - lowercase letters, digits or dashes. - Range: - properties: - network: - type: string - description: >- - In the Shared VPC host project, the VPC network that's peered with - the consumer network. For example: - `projects/1234321/global/networks/host-network` - ipCidrRange: - description: >- - CIDR range in "10.x.x.x/y" format that is within the allocated - ranges and currently unused. - type: string - type: object - id: Range - description: Represents a found unused range. - OAuthRequirements: - id: OAuthRequirements - properties: - canonicalScopes: - description: >- - The list of publicly documented OAuth scopes that are allowed - access. An OAuth token containing any of these scopes will be - accepted. Example: canonical_scopes: - https://www.googleapis.com/auth/calendar, - https://www.googleapis.com/auth/calendar.read - type: string - type: object - description: >- - OAuth scopes are a way to define data and permissions on data. For - example, there are scopes defined for "Read-only access to Google - Calendar" and "Access to Cloud Platform". Users can consent to a scope - for an application, giving it permission to access that data on their - behalf. OAuth scope specifications should be fairly coarse grained; a - user will need to see and understand the text description of what your - scope means. In most cases: use one or at most two OAuth scopes for an - entire family of products. If your product has multiple APIs, you should - probably be sharing the OAuth scope across all of those APIs. When you - need finer grained OAuth consent screens: talk with your product - management about how developers will use them in practice. Please note - that even though each of the canonical scopes is enough for a request to - be accepted and passed to the backend, a request can still fail due to - the backend requiring additional scopes or permissions. - JwtLocation: - description: Specifies a location to extract JWT from an API request. - properties: - valuePrefix: - description: >- - The value prefix. The value format is "value_prefix{token}" Only - applies to "in" header type. Must be empty for "in" query type. If - not empty, the header value has to match (case sensitive) this - prefix. If not matched, JWT will not be extracted. If matched, JWT - will be extracted after the prefix is removed. For example, for - "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space - at the end. - type: string - cookie: - type: string - description: Specifies cookie name to extract JWT token. - query: - type: string - description: Specifies URL query parameter name to extract JWT token. - header: - description: Specifies HTTP header name to extract JWT token. - type: string - id: JwtLocation - type: object - BackendRule: - description: A backend rule provides configuration for an individual API element. - properties: - operationDeadline: - format: double - type: number - description: >- - The number of seconds to wait for the completion of a long running - operation. The default is no deadline. - address: - type: string - description: >- - The address of the API backend. The scheme is used to determine the - backend protocol and security. The following schemes are accepted: - SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// - gRPC None grpcs:// gRPC TLS It is recommended to explicitly include - a scheme. Leaving out the scheme may cause constrasting behaviors - across platforms. If the port is unspecified, the default is: - 80 - for schemes without TLS - 443 for schemes with TLS For HTTP - backends, use protocol to specify the protocol version. - pathTranslation: - enumDescriptions: - - '' - - >- - Use the backend address as-is, with no modification to the path. - If the URL pattern contains variables, the variable names and - values will be appended to the query string. If a query string - parameter and a URL pattern variable have the same name, this may - result in duplicate keys in the query string. # Examples Given the - following operation config: Method path: - /api/company/{cid}/user/{uid} Backend address: - https://example.cloudfunctions.net/getUser Requests to the - following request paths will call the backend at the translated - path: Request path: /api/company/widgetworks/user/johndoe - Translated: - https://example.cloudfunctions.net/getUser?cid=widgetworks&uid=johndoe - Request path: /api/company/widgetworks/user/johndoe?timezone=EST - Translated: - https://example.cloudfunctions.net/getUser?timezone=EST&cid=widgetworks&uid=johndoe - - >- - The request path will be appended to the backend address. # - Examples Given the following operation config: Method path: - /api/company/{cid}/user/{uid} Backend address: - https://example.appspot.com Requests to the following request - paths will call the backend at the translated path: Request path: - /api/company/widgetworks/user/johndoe Translated: - https://example.appspot.com/api/company/widgetworks/user/johndoe - Request path: /api/company/widgetworks/user/johndoe?timezone=EST - Translated: - https://example.appspot.com/api/company/widgetworks/user/johndoe?timezone=EST - type: string - enum: - - PATH_TRANSLATION_UNSPECIFIED - - CONSTANT_ADDRESS - - APPEND_PATH_TO_ADDRESS - deadline: - description: >- - The number of seconds to wait for a response from a request. The - default varies based on the request protocol and deployment - environment. - format: double - type: number - minDeadline: - description: Deprecated, do not use. - format: double - deprecated: true - type: number - overridesByRequestProtocol: - description: The map between request protocol and the backend address. - additionalProperties: - $ref: '#/components/schemas/BackendRule' - type: object - protocol: - type: string - description: >- - The protocol used for sending a request to the backend. The - supported values are "http/1.1" and "h2". The default value is - inferred from the scheme in the address field: SCHEME PROTOCOL - http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure - HTTP backends (https://) that support HTTP/2, set this field to "h2" - for improved performance. Configuring this field to non-default - values is only supported for secure HTTP backends. This field will - be ignored for all other backends. See - https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids - for more details on the supported values. - disableAuth: - type: boolean - description: >- - When disable_auth is true, a JWT ID token won't be generated and the - original "Authorization" HTTP header will be preserved. If the - header is used to carry the original token and is expected by the - backend, this field must be set to true to preserve the header. - jwtAudience: - description: >- - The JWT audience is used when generating a JWT ID token for the - backend. This ID token will be added in the HTTP "authorization" - header, and sent to the backend. - type: string - selector: - type: string - description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. - type: object - id: BackendRule - CustomError: - id: CustomError - type: object - properties: - types: - description: >- - The list of custom error detail types, e.g. - 'google.foo.v1.CustomError'. - items: - type: string - type: array - rules: - description: >- - The list of custom error rules that apply to individual API - messages. **NOTE:** All service configuration rules follow "last one - wins" order. - type: array - items: - $ref: '#/components/schemas/CustomErrorRule' - description: >- - Customize service error responses. For example, list any service - specific protobuf types that can appear in error detail lists of error - responses. Example: custom_error: types: - google.foo.v1.CustomError - - google.foo.v1.AnotherError - QuotaLimit: - type: object - description: >- - `QuotaLimit` defines a specific limit that applies over a specified - duration for a limit type. There can be at most one limit for a duration - and limit type combination defined within a `QuotaGroup`. - id: QuotaLimit - properties: - unit: - description: >- - Specify the unit of the quota limit. It uses the same syntax as - MetricDescriptor.unit. The supported unit kinds are determined by - the quota backend system. Here are some examples: * - "1/min/{project}" for quota per minute per project. Note: the order - of unit components is insignificant. The "1" at the beginning is - required to follow the metric unit syntax. - type: string - values: - additionalProperties: - format: int64 - type: string - type: object - description: >- - Tiered limit values. You must specify this as a key:value pair, with - an integer value that is the maximum number of requests allowed for - the specified unit. Currently only STANDARD is supported. - displayName: - type: string - description: >- - User-visible display name for this limit. Optional. If not set, the - UI will provide a default display name based on the quota - configuration. This field can be used to override the default - display name generated from the configuration. - defaultLimit: - description: >- - Default number of tokens that can be consumed during the specified - duration. This is the number of tokens assigned when a client - application developer activates the service for his/her project. - Specifying a value of 0 will block all requests. This can be used if - you are provisioning quota to selected consumers and blocking - others. Similarly, a value of -1 will indicate an unlimited quota. - No other negative values are allowed. Used by group-based quotas - only. - type: string - format: int64 - description: - type: string - description: >- - Optional. User-visible, extended description for this quota limit. - Should be used only when more context is needed to understand this - limit than provided by the limit's display name (see: - `display_name`). - duration: - description: >- - Duration of this limit in textual notation. Must be "100s" or "1d". - Used by group-based quotas only. - type: string - maxLimit: - description: >- - Maximum number of tokens that can be consumed during the specified - duration. Client application developers can override the default - limit up to this maximum. If specified, this value cannot be set to - a value less than the default limit. If not specified, it is set to - the default limit. To allow clients to apply overrides with no upper - bound, set this to -1, indicating unlimited maximum quota. Used by - group-based quotas only. - type: string - format: int64 - freeTier: - description: >- - Free tier value displayed in the Developers Console for this limit. - The free tier is the number of tokens that will be subtracted from - the billed amount when billing is enabled. This field can only be - set on a limit with duration "1d", in a billable group; it is - invalid on any other limit. If this field is not set, it defaults to - 0, indicating that there is no free tier for this service. Used by - group-based quotas only. - type: string - format: int64 - metric: - description: >- - The name of the metric this quota limit applies to. The quota limits - with the same metric will be checked together during runtime. The - metric must be defined within the service config. - type: string - name: - type: string - description: >- - Name of the quota limit. The name must be provided, and it must be - unique within the service. The name can only include alphanumeric - characters as well as '-'. The maximum length of the limit name is - 64 characters. - RemoveDnsRecordSetMetadata: - type: object - description: >- - Metadata provided through GetOperation request for the LRO generated by - RemoveDnsRecordSet API - properties: {} - id: RemoveDnsRecordSetMetadata - PeeredDnsDomainMetadata: - id: PeeredDnsDomainMetadata - type: object - description: >- - Metadata provided through GetOperation request for the LRO generated by - CreatePeeredDnsDomain API. - properties: {} - AuthenticationRule: - id: AuthenticationRule - description: >- - Authentication rules for the service. By default, if a method has any - authentication requirements, every request must include a valid - credential matching one of the requirements. It's an error to include - more than one kind of credential in a single request. If a method - doesn't have any auth requirements, request credentials will be ignored. - type: object - properties: - requirements: - type: array - description: Requirements for additional authentication providers. - items: - $ref: '#/components/schemas/AuthRequirement' - selector: - description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. - type: string - allowWithoutCredential: - type: boolean - description: >- - If true, the service accepts API keys without any other credential. - This flag only applies to HTTP and gRPC requests. - oauth: - description: The requirements for OAuth credentials. - $ref: '#/components/schemas/OAuthRequirements' - AddRolesMetadata: - properties: {} - id: AddRolesMetadata - type: object - description: >- - Metadata provided through GetOperation request for the LRO generated by - AddRoles API - Billing: - description: >- - Billing related configuration of the service. The following example - shows how to configure monitored resources and metrics for billing, - `consumer_destinations` is the only supported destination and the - monitored resources need at least one label key - `cloud.googleapis.com/location` to indicate the location of the billing - usage, using different monitored resources between monitoring and - billing is recommended so they can be evolved independently: - monitored_resources: - type: library.googleapis.com/billing_branch - labels: - key: cloud.googleapis.com/location description: | Predefined - label to support billing location restriction. - key: city description: - | Custom label to define the city where the library branch is located - in. - key: name description: Custom label to define the name of the - library branch. metrics: - name: - library.googleapis.com/book/borrowed_count metric_kind: DELTA - value_type: INT64 unit: "1" billing: consumer_destinations: - - monitored_resource: library.googleapis.com/billing_branch metrics: - - library.googleapis.com/book/borrowed_count - type: object - id: Billing - properties: - consumerDestinations: - items: - $ref: '#/components/schemas/BillingDestination' - description: >- - Billing configurations for sending metrics to the consumer project. - There can be multiple consumer destinations per service, each one - must have a different monitored resource type. A metric can be used - in at most one consumer destination. - type: array - MethodPolicy: - description: Defines policies applying to an RPC method. - type: object - id: MethodPolicy - properties: - requestPolicies: - items: - $ref: '#/components/schemas/FieldPolicy' - description: Policies that are applicable to the request message. - type: array - selector: - type: string - description: >- - Selects a method to which these policies should be enforced, for - example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to - selector for syntax details. NOTE: This field must not be set in the - proto annotation. It will be automatically filled by the service - config compiler . - AddDnsZoneRequest: - type: object - id: AddDnsZoneRequest - properties: - dnsSuffix: - type: string - description: >- - Required. The DNS name suffix for the zones e.g. `example.com.`. - Cloud DNS requires that a DNS suffix ends with a trailing dot. - name: - type: string - description: >- - Required. The name for both the private zone in the shared producer - host project and the peering zone in the consumer project. Must be - unique within both projects. The name must be 1-63 characters long, - must begin with a letter, end with a letter or digit, and only - contain lowercase letters, digits or dashes. - consumerNetwork: - description: >- - Required. The network that the consumer is using to connect with - services. Must be in the form of - projects/{project}/global/networks/{network} {project} is the - project number, as in '12345' {network} is the network name. - type: string - description: >- - Request to add a private managed DNS zone in the shared producer host - project and a matching DNS peering zone in the consumer project. - GoSettings: - properties: - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - description: Settings for Go client libraries. - id: GoSettings - type: object - LoggingDestination: - id: LoggingDestination - type: object - properties: - logs: - type: array - items: - type: string - description: >- - Names of the logs to be sent to this destination. Each name must be - defined in the Service.logs section. If the log name is not a domain - scoped name, it will be automatically prefixed with the service name - followed by "/". - monitoredResource: - description: >- - The monitored resource type. The type must be defined in the - Service.monitored_resources section. - type: string - description: >- - Configuration of a specific logging destination (the producer project or - the consumer project). - CppSettings: - description: Settings for C++ client libraries. - properties: - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - id: CppSettings - type: object - ListPeeredDnsDomainsResponse: - properties: - peeredDnsDomains: - type: array - description: The list of peered DNS domains. - items: - $ref: '#/components/schemas/PeeredDnsDomain' - id: ListPeeredDnsDomainsResponse - type: object - description: Response to list peered DNS domains for a given connection. - Http: - type: object - description: >- - Defines the HTTP configuration for an API service. It contains a list of - HttpRule, each specifying the mapping of an RPC method to one or more - HTTP REST API methods. - properties: - fullyDecodeReservedExpansion: - description: >- - When set to true, URL path parameters will be fully URI-decoded - except in cases of single segment matches in reserved expansion, - where "%2F" will be left encoded. The default behavior is to not - decode RFC 6570 reserved characters in multi segment matches. - type: boolean - rules: - description: >- - A list of HTTP configuration rules that apply to individual API - methods. **NOTE:** All service configuration rules follow "last one - wins" order. - items: - $ref: '#/components/schemas/HttpRule' - type: array - id: Http - Publishing: - description: >- - This message configures the settings for publishing [Google Cloud Client - libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) - generated from the service config. - type: object - id: Publishing - properties: - protoReferenceDocumentationUri: - type: string - description: >- - Optional link to proto reference documentation. Example: - https://cloud.google.com/pubsub/lite/docs/reference/rpc - documentationUri: - type: string - description: >- - Link to product home page. Example: - https://cloud.google.com/asset-inventory/docs/overview - restReferenceDocumentationUri: - type: string - description: >- - Optional link to REST reference documentation. Example: - https://cloud.google.com/pubsub/lite/docs/reference/rest - codeownerGithubTeams: - type: array - description: >- - GitHub teams to be added to CODEOWNERS in the directory in GitHub - containing source code for the client libraries for this API. - items: - type: string - githubLabel: - description: >- - GitHub label to apply to issues and pull requests opened for this - API. + The string value of the default value of this field. Proto2 syntax + only. type: string - organization: - enum: - - CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED - - CLOUD - - ADS - - PHOTOS - - STREET_VIEW - - SHOPPING - - GEO - - GENERATIVE_AI - description: For whom the client library is being published. + Enum: + id: Enum + description: >- + Enum type definition. New usages of this message as an alternative to + EnumDescriptorProto are strongly discouraged. This message does not + reliability preserve all information necessary to model the schema and + preserve semantics. Instead make use of FileDescriptorSet which + preserves the necessary information. + type: object + properties: + name: + description: Enum type name. type: string - enumDescriptions: - - Not useful. - - Google Cloud Platform Org. - - Ads (Advertising) Org. - - Photos Org. - - Street View Org. - - Shopping Org. - - Geo Org. - - Generative AI - https://developers.generativeai.google - librarySettings: - description: >- - Client library settings. If the same version string appears multiple - times in this list, then the last one wins. Settings from earlier - settings with the same version string are discarded. + enumvalue: + description: Enum value definitions. + type: array items: - $ref: '#/components/schemas/ClientLibrarySettings' + $ref: '#/components/schemas/EnumValue' + options: + description: Protocol buffer options. type: array - newIssueUri: - type: string - description: >- - Link to a *public* URI where users can report issues. Example: - https://issuetracker.google.com/issues/new?component=190865&template=1161103 - docTagPrefix: - description: >- - A prefix used in sample code when demarking regions to be included - in documentation. + items: + $ref: '#/components/schemas/Option' + sourceContext: + description: The source context. + $ref: '#/components/schemas/SourceContext' + syntax: + description: The source syntax. type: string - apiShortName: + enumDescriptions: + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS + edition: description: >- - Used as a tracking tag when collecting data about the APIs developer - relations artifacts like docs, packages delivered to package - managers, etc. Example: "speech". + The source edition string, only valid when syntax is + SYNTAX_EDITIONS. type: string - methodSettings: - items: - $ref: '#/components/schemas/MethodSettings' - type: array - description: >- - A list of API method settings, e.g. the behavior for methods that - use the long-running operation pattern. - Status: + EnumValue: + id: EnumValue description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - id: Status + Enum value definition. New usages of this message as an alternative to + EnumValueDescriptorProto are strongly discouraged. This message does not + reliability preserve all information necessary to model the schema and + preserve semantics. Instead make use of FileDescriptorSet which + preserves the necessary information. + type: object properties: - code: + name: + description: Enum value name. + type: string + number: + description: Enum value number. type: integer - description: The status code, which should be an enum value of google.rpc.Code. format: int32 - details: + options: + description: Protocol buffer options. type: array - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - message: - type: string - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. + $ref: '#/components/schemas/Option' + Documentation: + id: Documentation + description: >- + `Documentation` provides the information for describing a service. + Example: documentation: summary: > The Google Calendar API gives access + to most calendar features. pages: - name: Overview content: (== include + google/foo/overview.md ==) - name: Tutorial content: (== include + google/foo/tutorial.md ==) subpages: - name: Java content: (== include + google/foo/tutorial_java.md ==) rules: - selector: + google.calendar.Calendar.Get description: > ... - selector: + google.calendar.Calendar.Put description: > ... Documentation is + provided in markdown syntax. In addition to standard markdown features, + definition lists, tables and fenced code blocks are supported. Section + headers can be provided and are interpreted relative to the section + nesting of the context where a documentation fragment is embedded. + Documentation from the IDL is merged with documentation defined via the + config at normalization time, where documentation provided by config + rules overrides IDL provided. A number of constructs specific to the API + platform are supported in documentation text. In order to reference a + proto element, the following notation can be used: + [fully.qualified.proto.name][] To override the display text used for the + link, this can be used: [display text][fully.qualified.proto.name] Text + can be excluded from doc using the following notation: (-- internal + comment --) A few directives are available in documentation. Note that + directives must appear on a single line to be properly identified. The + `include` directive includes a markdown file from an external source: + (== include path/to/file ==) The `resource_for` directive marks a + message to be the resource of a collection in REST view. If it is not + specified, tools attempt to infer the resource from the operations in a + collection: (== resource_for v1.shelves.books ==) The directive + `suppress_warning` does not directly affect documentation and is + documented together with service config validation. type: object - GoogleCloudServicenetworkingV1ConsumerConfigReservedRange: properties: - ipPrefixLength: - type: integer - description: The prefix length of the reserved range. - format: int32 - name: - type: string - description: The name of the reserved range. - address: + summary: description: >- - The starting address of the reserved range. The address must be a - valid IPv4 address in the x.x.x.x format. This value combined with - the IP prefix length is the CIDR range for the reserved range. + A short description of what the service does. The summary must be + plain text. It becomes the overview of the service displayed in + Google Cloud Console. NOTE: This field is equivalent to the standard + field `description`. type: string - type: object - description: Allocated IP address ranges for this private service access connection. - id: GoogleCloudServicenetworkingV1ConsumerConfigReservedRange - ListConnectionsResponse: - id: ListConnectionsResponse - properties: - connections: + pages: + description: The top level pages for the documentation set. type: array items: - $ref: '#/components/schemas/Connection' - description: The list of Connections. - type: object - description: >- - ListConnectionsResponse is the response to list peering states for the - given service and consumer project. - GoogleCloudServicenetworkingV1betaSubnetwork: - id: GoogleCloudServicenetworkingV1betaSubnetwork - type: object - description: >- - Represents a subnet that was created or discovered by a private access - management service. - properties: - ipCidrRange: - description: Subnetwork CIDR range in `10.x.x.x/y` format. - type: string - network: - type: string - description: >- - In the Shared VPC host project, the VPC network that's peered with - the consumer network. For example: - `projects/1234321/global/networks/host-network` - outsideAllocation: - type: boolean + $ref: '#/components/schemas/Page' + rules: description: >- - This is a discovered subnet that is not within the current consumer - allocated ranges. - name: - description: Subnetwork name. See https://cloud.google.com/compute/docs/vpc/ + A list of documentation rules that apply to individual API elements. + **NOTE:** All service configuration rules follow "last one wins" + order. + type: array + items: + $ref: '#/components/schemas/DocumentationRule' + documentationRootUrl: + description: The URL to the root of documentation. type: string - FieldPolicy: - properties: - resourcePermission: + serviceRootUrl: description: >- - Specifies the required permission(s) for the resource referred to by - the field. It requires the field contains a valid resource - reference, and the request must pass the permission checks to - proceed. For example, "resourcemanager.projects.get". - type: string - selector: + Specifies the service root url if the default one (the service name + from the yaml file) is not suitable. This can be seen in any fully + specified service urls as well as sections that show a base that + other urls are relative to. type: string + overview: description: >- - Selects one or more request or response message fields to apply this - `FieldPolicy`. When a `FieldPolicy` is used in proto annotation, the - selector must be left as empty. The service config generator will - automatically fill the correct value. When a `FieldPolicy` is used - in service config, the selector must be a comma-separated string - with valid request or response field paths, such as "foo.bar" or - "foo.bar,foo.baz". - resourceType: + Declares a single overview page. For example: documentation: + summary: ... overview: (== include overview.md ==) This is a + shortcut for the following declaration (using pages style): + documentation: summary: ... pages: - name: Overview content: (== + include overview.md ==) Note: you cannot specify both `overview` + field and `pages` field. + type: string + additionalIamInfo: description: >- - Specifies the resource type for the resource referred to by the - field. + Optional information about the IAM configuration. This is typically + used to link to documentation about a product's IAM roles and + permissions. type: string - type: object - id: FieldPolicy + sectionOverrides: + description: >- + Specifies section and content to override the boilerplate content. + Currently overrides following sections: 1. + rest.service.client_libraries + type: array + items: + $ref: '#/components/schemas/Page' + Page: + id: Page description: >- - Google API Policy Annotation This message defines a simple API policy - annotation that can be used to annotate API request and response message - fields with applicable policies. One field may have multiple applicable - policies that must all be satisfied before a request can be processed. - This policy annotation is used to generate the overall policy that will - be used for automatic runtime policy enforcement and documentation - generation. - DeleteConnectionMetadata: + Represents a documentation page. A page can contain subpages to + represent nested documentation set structure. type: object - description: >- - Metadata provided through GetOperation request for the LRO generated by - Delete Connection API - properties: {} - id: DeleteConnectionMetadata - EnableVpcServiceControlsRequest: - id: EnableVpcServiceControlsRequest properties: - consumerNetwork: + name: + description: >- + The name of the page. It will be used as an identity of the page to + generate URI of the page, text of the link to this page in + navigation, etc. The full page name (start from the root page name + to this page concatenated with `.`) can be used as reference to the + page in your documentation. For example: pages: - name: Tutorial + content: (== include tutorial.md ==) subpages: - name: Java content: + (== include tutorial_java.md ==) You can reference `Java` page using + Markdown reference link syntax: `Java`. type: string + content: description: >- - Required. The network that the consumer is using to connect with - services. Must be in the form of - projects/{project}/global/networks/{network} {project} is a project - number, as in '12345' {network} is network name. + The Markdown content of the page. You can use ```(== include {path} + ==)``` to include content from a Markdown file. The content can be + used to produce the documentation page such as HTML format page. + type: string + subpages: + description: >- + Subpages of this page. The order of subpages specified here will be + honored in the generated docset. + type: array + items: + $ref: '#/components/schemas/Page' + DocumentationRule: + id: DocumentationRule + description: A documentation rule provides information about individual API elements. type: object - description: Request to enable VPC service controls. - PolicyBinding: properties: - member: + selector: + description: >- + The selector is a comma-separated list of patterns for any element + such as a method, a field, an enum value. Each pattern is a + qualified name of the element which may end in "*", indicating a + wildcard. Wildcards are only allowed at the end and for a whole + component of the qualified name, i.e. "foo.*" is ok, but not + "foo.b*" or "foo.*.bar". A wildcard will match one or more + components. To specify a default for all applicable elements, the + whole pattern "*" is used. type: string + description: description: >- - Required. Member to bind the role with. See - /iam/docs/reference/rest/v1/Policy#Binding for how to format each - member. Eg. - user:myuser@mydomain.com - - serviceAccount:my-service-account@app.gserviceaccount.com - role: + Description of the selected proto element (e.g. a message, a method, + a 'service' definition, or a field). Defaults to leading & trailing + comments taken from the proto source definition of the proto + element. + type: string + deprecationDescription: description: >- - Required. Role to apply. Only allowlisted roles can be used at the - specified granularity. The role must be one of the following: - - 'roles/container.hostServiceAgentUser' applied on the shared VPC - host project - 'roles/compute.securityAdmin' applied on the shared - VPC host project - 'roles/compute.networkAdmin' applied on the - shared VPC host project - 'roles/tpu.xpnAgent' applied on the shared - VPC host project - 'roles/dns.admin' applied on the shared VPC host - project - 'roles/logging.admin' applied on the shared VPC host - project - 'roles/monitoring.viewer' applied on the shared VPC host - project - 'roles/servicemanagement.quotaViewer' applied on the - shared VPC host project + Deprecation description of the selected element(s). It can be + provided if an element is marked as `deprecated`. type: string + disableReplacementWords: + description: >- + String of comma or space separated case-sensitive words for which + method/field name replacement will be disabled. + type: string + Backend: + id: Backend + description: '`Backend` defines the backend configuration for a service.' type: object - description: Grouping of IAM role and IAM member. - id: PolicyBinding - SystemParameters: - type: object - id: SystemParameters properties: rules: - items: - $ref: '#/components/schemas/SystemParameterRule' - type: array description: >- - Define system parameters. The parameters defined here will override - the default parameters implemented by the system. If this field is - missing from the service config, default system parameters will be - used. Default system parameters and names is - implementation-dependent. Example: define api key for all methods - system_parameters rules: - selector: "*" parameters: - name: api_key - url_query_parameter: api_key Example: define 2 api key names for a - specific method. system_parameters rules: - selector: "/ListShelves" - parameters: - name: api_key http_header: Api-Key1 - name: api_key - http_header: Api-Key2 **NOTE:** All service configuration rules - follow "last one wins" order. - description: >- - ### System parameter configuration A system parameter is a special kind - of parameter defined by the API system, not by an individual API. It is - typically mapped to an HTTP header and/or a URL query parameter. This - configuration specifies which methods change the names of the system - parameters. - HttpRule: + A list of API backend rules that apply to individual API methods. + **NOTE:** All service configuration rules follow "last one wins" + order. + type: array + items: + $ref: '#/components/schemas/BackendRule' + BackendRule: + id: BackendRule + description: A backend rule provides configuration for an individual API element. + type: object properties: - post: - description: >- - Maps to HTTP POST. Used for creating a resource or performing an - action. - type: string selector: description: >- - Selects a method to which this rule applies. Refer to selector for - syntax details. + Selects the methods to which this rule applies. Refer to selector + for syntax details. type: string - additionalBindings: - items: - $ref: '#/components/schemas/HttpRule' - type: array - description: >- - Additional HTTP bindings for the selector. Nested bindings must not - contain an `additional_bindings` field themselves (that is, the - nesting may only be one level deep). - responseBody: + address: description: >- - Optional. The name of the response field whose value is mapped to - the HTTP response body. When omitted, the entire response message - will be used as the HTTP response body. NOTE: The referred field - must be present at the top-level of the response message type. + The address of the API backend. The scheme is used to determine the + backend protocol and security. The following schemes are accepted: + SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// + gRPC None grpcs:// gRPC TLS It is recommended to explicitly include + a scheme. Leaving out the scheme may cause constrasting behaviors + across platforms. If the port is unspecified, the default is: - 80 + for schemes without TLS - 443 for schemes with TLS For HTTP + backends, use protocol to specify the protocol version. type: string - custom: + deadline: description: >- - The custom pattern is used for specifying an HTTP method that is not - included in the `pattern` field, such as HEAD, or "*" to leave the - HTTP method unspecified for this rule. The wild-card rule is useful - for services that provide content to Web (HTML) clients. - $ref: '#/components/schemas/CustomHttpPattern' - get: + The number of seconds to wait for a response from a request. The + default varies based on the request protocol and deployment + environment. + type: number + format: double + minDeadline: + description: Deprecated, do not use. + deprecated: true + type: number + format: double + operationDeadline: description: >- - Maps to HTTP GET. Used for listing and getting information about - resources. - type: string - patch: + The number of seconds to wait for the completion of a long running + operation. The default is no deadline. + type: number + format: double + pathTranslation: + description: no-lint type: string - description: Maps to HTTP PATCH. Used for updating a resource. - put: + enumDescriptions: + - '' + - >- + Use the backend address as-is, with no modification to the path. + If the URL pattern contains variables, the variable names and + values will be appended to the query string. If a query string + parameter and a URL pattern variable have the same name, this may + result in duplicate keys in the query string. # Examples Given the + following operation config: Method path: + /api/company/{cid}/user/{uid} Backend address: + https://example.cloudfunctions.net/getUser Requests to the + following request paths will call the backend at the translated + path: Request path: /api/company/widgetworks/user/johndoe + Translated: + https://example.cloudfunctions.net/getUser?cid=widgetworks&uid=johndoe + Request path: /api/company/widgetworks/user/johndoe?timezone=EST + Translated: + https://example.cloudfunctions.net/getUser?timezone=EST&cid=widgetworks&uid=johndoe + - >- + The request path will be appended to the backend address. # + Examples Given the following operation config: Method path: + /api/company/{cid}/user/{uid} Backend address: + https://example.appspot.com Requests to the following request + paths will call the backend at the translated path: Request path: + /api/company/widgetworks/user/johndoe Translated: + https://example.appspot.com/api/company/widgetworks/user/johndoe + Request path: /api/company/widgetworks/user/johndoe?timezone=EST + Translated: + https://example.appspot.com/api/company/widgetworks/user/johndoe?timezone=EST + enum: + - PATH_TRANSLATION_UNSPECIFIED + - CONSTANT_ADDRESS + - APPEND_PATH_TO_ADDRESS + jwtAudience: + description: >- + The JWT audience is used when generating a JWT ID token for the + backend. This ID token will be added in the HTTP "authorization" + header, and sent to the backend. type: string - description: Maps to HTTP PUT. Used for replacing a resource. - body: + disableAuth: + description: >- + When disable_auth is true, a JWT ID token won't be generated and the + original "Authorization" HTTP header will be preserved. If the + header is used to carry the original token and is expected by the + backend, this field must be set to true to preserve the header. + type: boolean + protocol: + description: >- + The protocol used for sending a request to the backend. The + supported values are "http/1.1" and "h2". The default value is + inferred from the scheme in the address field: SCHEME PROTOCOL + http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure + HTTP backends (https://) that support HTTP/2, set this field to "h2" + for improved performance. Configuring this field to non-default + values is only supported for secure HTTP backends. This field will + be ignored for all other backends. See + https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids + for more details on the supported values. type: string + overridesByRequestProtocol: + description: The map between request protocol and the backend address. + type: object + additionalProperties: + $ref: '#/components/schemas/BackendRule' + loadBalancingPolicy: description: >- - The name of the request field whose value is mapped to the HTTP - request body, or `*` for mapping all request fields not captured by - the path pattern to the HTTP body, or omitted for not having any - HTTP request body. NOTE: the referred field must be present at the - top-level of the request message type. - delete: + The load balancing policy used for connection to the application + backend. Defined as an arbitrary string to accomondate custom load + balancing policies supported by the underlying channel, but suggest + most users use one of the standard policies, such as the default, + "RoundRobin". type: string - description: Maps to HTTP DELETE. Used for deleting a resource. - id: HttpRule + Http: + id: Http + description: >- + Defines the HTTP configuration for an API service. It contains a list of + HttpRule, each specifying the mapping of an RPC method to one or more + HTTP REST API methods. type: object + properties: + rules: + description: >- + A list of HTTP configuration rules that apply to individual API + methods. **NOTE:** All service configuration rules follow "last one + wins" order. + type: array + items: + $ref: '#/components/schemas/HttpRule' + fullyDecodeReservedExpansion: + description: >- + When set to true, URL path parameters will be fully URI-decoded + except in cases of single segment matches in reserved expansion, + where "%2F" will be left encoded. The default behavior is to not + decode RFC 6570 reserved characters in multi segment matches. + type: boolean + HttpRule: + id: HttpRule description: >- gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to @@ -3191,161 +2143,545 @@ components: API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. - Operation: + type: object + properties: + selector: + description: >- + Selects a method to which this rule applies. Refer to selector for + syntax details. + type: string + get: + description: >- + Maps to HTTP GET. Used for listing and getting information about + resources. + type: string + put: + description: Maps to HTTP PUT. Used for replacing a resource. + type: string + post: + description: >- + Maps to HTTP POST. Used for creating a resource or performing an + action. + type: string + delete: + description: Maps to HTTP DELETE. Used for deleting a resource. + type: string + patch: + description: Maps to HTTP PATCH. Used for updating a resource. + type: string + custom: + description: >- + The custom pattern is used for specifying an HTTP method that is not + included in the `pattern` field, such as HEAD, or "*" to leave the + HTTP method unspecified for this rule. The wild-card rule is useful + for services that provide content to Web (HTML) clients. + $ref: '#/components/schemas/CustomHttpPattern' + body: + description: >- + The name of the request field whose value is mapped to the HTTP + request body, or `*` for mapping all request fields not captured by + the path pattern to the HTTP body, or omitted for not having any + HTTP request body. NOTE: the referred field must be present at the + top-level of the request message type. + type: string + responseBody: + description: >- + Optional. The name of the response field whose value is mapped to + the HTTP response body. When omitted, the entire response message + will be used as the HTTP response body. NOTE: The referred field + must be present at the top-level of the response message type. + type: string + additionalBindings: + description: >- + Additional HTTP bindings for the selector. Nested bindings must not + contain an `additional_bindings` field themselves (that is, the + nesting may only be one level deep). + type: array + items: + $ref: '#/components/schemas/HttpRule' + CustomHttpPattern: + id: CustomHttpPattern + description: A custom pattern is used for defining custom HTTP verb. + type: object + properties: + kind: + description: The name of this custom HTTP verb. + type: string + path: + description: The path matched by this custom verb. + type: string + Quota: + id: Quota + description: >- + Quota configuration helps to achieve fairness and budgeting in service + usage. The metric based quota configuration works this way: - The + service configuration defines a set of metrics. - For API calls, the + quota.metric_rules maps methods to metrics with corresponding costs. - + The quota.limits defines limits on the metrics, which will be used for + quota checks at runtime. An example quota configuration in yaml format: + quota: limits: - name: apiWriteQpsPerProject metric: + library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit + for consumer projects values: STANDARD: 10000 (The metric rules bind all + methods to the read_calls metric, except for the UpdateBook and + DeleteBook methods. These two methods are mapped to the write_calls + metric, with the UpdateBook method consuming at twice rate as the + DeleteBook method.) metric_rules: - selector: "*" metric_costs: + library.googleapis.com/read_calls: 1 - selector: + google.example.library.v1.LibraryService.UpdateBook metric_costs: + library.googleapis.com/write_calls: 2 - selector: + google.example.library.v1.LibraryService.DeleteBook metric_costs: + library.googleapis.com/write_calls: 1 Corresponding Metric definition: + metrics: - name: library.googleapis.com/read_calls display_name: Read + requests metric_kind: DELTA value_type: INT64 - name: + library.googleapis.com/write_calls display_name: Write requests + metric_kind: DELTA value_type: INT64 + type: object + properties: + limits: + description: List of QuotaLimit definitions for the service. + type: array + items: + $ref: '#/components/schemas/QuotaLimit' + metricRules: + description: >- + List of MetricRule definitions, each one mapping a selected method + to one or more metrics. + type: array + items: + $ref: '#/components/schemas/MetricRule' + QuotaLimit: + id: QuotaLimit + description: >- + `QuotaLimit` defines a specific limit that applies over a specified + duration for a limit type. There can be at most one limit for a duration + and limit type combination defined within a `QuotaGroup`. + type: object + properties: + name: + description: >- + Name of the quota limit. The name must be provided, and it must be + unique within the service. The name can only include alphanumeric + characters as well as '-'. The maximum length of the limit name is + 64 characters. + type: string + description: + description: >- + Optional. User-visible, extended description for this quota limit. + Should be used only when more context is needed to understand this + limit than provided by the limit's display name (see: + `display_name`). + type: string + defaultLimit: + description: >- + Default number of tokens that can be consumed during the specified + duration. This is the number of tokens assigned when a client + application developer activates the service for his/her project. + Specifying a value of 0 will block all requests. This can be used if + you are provisioning quota to selected consumers and blocking + others. Similarly, a value of -1 will indicate an unlimited quota. + No other negative values are allowed. Used by group-based quotas + only. + type: string + format: int64 + maxLimit: + description: >- + Maximum number of tokens that can be consumed during the specified + duration. Client application developers can override the default + limit up to this maximum. If specified, this value cannot be set to + a value less than the default limit. If not specified, it is set to + the default limit. To allow clients to apply overrides with no upper + bound, set this to -1, indicating unlimited maximum quota. Used by + group-based quotas only. + type: string + format: int64 + freeTier: + description: >- + Free tier value displayed in the Developers Console for this limit. + The free tier is the number of tokens that will be subtracted from + the billed amount when billing is enabled. This field can only be + set on a limit with duration "1d", in a billable group; it is + invalid on any other limit. If this field is not set, it defaults to + 0, indicating that there is no free tier for this service. Used by + group-based quotas only. + type: string + format: int64 + duration: + description: >- + Duration of this limit in textual notation. Must be "100s" or "1d". + Used by group-based quotas only. + type: string + metric: + description: >- + The name of the metric this quota limit applies to. The quota limits + with the same metric will be checked together during runtime. The + metric must be defined within the service config. + type: string + unit: + description: >- + Specify the unit of the quota limit. It uses the same syntax as + MetricDescriptor.unit. The supported unit kinds are determined by + the quota backend system. Here are some examples: * + "1/min/{project}" for quota per minute per project. Note: the order + of unit components is insignificant. The "1" at the beginning is + required to follow the metric unit syntax. + type: string + values: + description: >- + Tiered limit values. You must specify this as a key:value pair, with + an integer value that is the maximum number of requests allowed for + the specified unit. Currently only STANDARD is supported. + type: object + additionalProperties: + type: string + format: int64 + displayName: + description: >- + User-visible display name for this limit. Optional. If not set, the + UI will provide a default display name based on the quota + configuration. This field can be used to override the default + display name generated from the configuration. + type: string + MetricRule: + id: MetricRule + description: >- + Bind API methods to metrics. Binding a method to a metric causes that + metric's configured quota behaviors to apply to the method call. + type: object + properties: + selector: + description: >- + Selects the methods to which this rule applies. Refer to selector + for syntax details. + type: string + metricCosts: + description: >- + Metrics to update when the selected methods are called, and the + associated cost applied to each metric. The key of the map is the + metric name, and the values are the amount increased for the metric + against which the quota limits are defined. The value must not be + negative. + type: object + additionalProperties: + type: string + format: int64 + Authentication: + id: Authentication + description: >- + `Authentication` defines the authentication configuration for API + methods provided by an API service. Example: name: + calendar.googleapis.com authentication: providers: - id: + google_calendar_auth jwks_uri: + https://www.googleapis.com/oauth2/v1/certs issuer: + https://securetoken.google.com rules: - selector: "*" requirements: + provider_id: google_calendar_auth - selector: google.calendar.Delegate + oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read + type: object + properties: + rules: + description: >- + A list of authentication rules that apply to individual API methods. + **NOTE:** All service configuration rules follow "last one wins" + order. + type: array + items: + $ref: '#/components/schemas/AuthenticationRule' + providers: + description: Defines a set of authentication providers that a service supports. + type: array + items: + $ref: '#/components/schemas/AuthProvider' + AuthenticationRule: + id: AuthenticationRule description: >- - This resource represents a long-running operation that is the result of - a network API call. - id: Operation + Authentication rules for the service. By default, if a method has any + authentication requirements, every request must include a valid + credential matching one of the requirements. It's an error to include + more than one kind of credential in a single request. If a method + doesn't have any auth requirements, request credentials will be ignored. + type: object properties: - metadata: - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. + selector: description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - done: + Selects the methods to which this rule applies. Refer to selector + for syntax details. + type: string + oauth: + description: The requirements for OAuth credentials. + $ref: '#/components/schemas/OAuthRequirements' + allowWithoutCredential: description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. + If true, the service accepts API keys without any other credential. + This flag only applies to HTTP and gRPC requests. type: boolean - name: - type: string + requirements: + description: Requirements for additional authentication providers. + type: array + items: + $ref: '#/components/schemas/AuthRequirement' + OAuthRequirements: + id: OAuthRequirements + description: >- + OAuth scopes are a way to define data and permissions on data. For + example, there are scopes defined for "Read-only access to Google + Calendar" and "Access to Cloud Platform". Users can consent to a scope + for an application, giving it permission to access that data on their + behalf. OAuth scope specifications should be fairly coarse grained; a + user will need to see and understand the text description of what your + scope means. In most cases: use one or at most two OAuth scopes for an + entire family of products. If your product has multiple APIs, you should + probably be sharing the OAuth scope across all of those APIs. When you + need finer grained OAuth consent screens: talk with your product + management about how developers will use them in practice. Please note + that even though each of the canonical scopes is enough for a request to + be accepted and passed to the backend, a request can still fail due to + the backend requiring additional scopes or permissions. + type: object + properties: + canonicalScopes: description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. - response: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any + The list of publicly documented OAuth scopes that are allowed + access. An OAuth token containing any of these scopes will be + accepted. Example: canonical_scopes: + https://www.googleapis.com/auth/calendar, + https://www.googleapis.com/auth/calendar.read + type: string + AuthRequirement: + id: AuthRequirement + description: >- + User-defined authentication requirements, including support for [JSON + Web Token + (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + type: object + properties: + providerId: description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - error: - $ref: '#/components/schemas/Status' + id from authentication provider. Example: provider_id: + bookstore_auth + type: string + audiences: description: >- - The error result of the operation in case of failure or - cancellation. + NOTE: This will be deprecated soon, once AuthProvider.audiences is + implemented and accepted in all the runtime components. The list of + JWT + [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). + that are allowed to access. A JWT containing any of these audiences + will be accepted. When this setting is absent, only JWTs with + audience "https://Service_name/API_name" will be accepted. For + example, if no audiences are in the setting, LibraryService API will + only accept JWTs with the following audience + "https://library-example.googleapis.com/google.example.library.v1.LibraryService". + Example: audiences: bookstore_android.apps.googleusercontent.com, + bookstore_web.apps.googleusercontent.com + type: string + AuthProvider: + id: AuthProvider + description: >- + Configuration for an authentication provider, including support for + [JSON Web Token + (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). type: object - CustomHttpPattern: properties: - path: - description: The path matched by this custom verb. + id: + description: >- + The unique identifier of the auth provider. It will be referred to + by `AuthRequirement.provider_id`. Example: "bookstore_auth". type: string - kind: - description: The name of this custom HTTP verb. + issuer: + description: >- + Identifies the principal that issued the JWT. See + https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 + Usually a URL or an email address. Example: + https://securetoken.google.com Example: + 1234567-compute@developer.gserviceaccount.com + type: string + jwksUri: + description: >- + URL of the provider's public key set to validate signature of the + JWT. See [OpenID + Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). + Optional if the key set document: - can be retrieved from [OpenID + Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html) + of the issuer. - can be inferred from the email domain of the issuer + (e.g. a Google service account). Example: + https://www.googleapis.com/oauth2/v1/certs + type: string + audiences: + description: >- + The list of JWT + [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). + that are allowed to access. A JWT containing any of these audiences + will be accepted. When this setting is absent, JWTs with audiences: + - "https://[service.name]/[google.protobuf.Api.name]" - + "https://[service.name]/" will be accepted. For example, if no + audiences are in the setting, LibraryService API will accept JWTs + with the following audiences: - + https://library-example.googleapis.com/google.example.library.v1.LibraryService + - https://library-example.googleapis.com/ Example: audiences: + bookstore_android.apps.googleusercontent.com, + bookstore_web.apps.googleusercontent.com + type: string + authorizationUrl: + description: >- + Redirect URL if JWT token is required but not present or is expired. + Implement authorizationUrl of securityDefinitions in OpenAPI spec. type: string + jwtLocations: + description: >- + Defines the locations to extract the JWT. For now it is only used by + the Cloud Endpoints to store the OpenAPI extension + [x-google-jwt-locations] + (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) + JWT locations can be one of HTTP headers, URL query parameters or + cookies. The rule is that the first match wins. If not specified, + default to use following 3 locations: 1) Authorization: Bearer 2) + x-goog-iap-jwt-assertion 3) access_token query parameter Default + locations can be specified as followings: jwt_locations: - header: + Authorization value_prefix: "Bearer " - header: + x-goog-iap-jwt-assertion - query: access_token + type: array + items: + $ref: '#/components/schemas/JwtLocation' + JwtLocation: + id: JwtLocation + description: Specifies a location to extract JWT from an API request. type: object - description: A custom pattern is used for defining custom HTTP verb. - id: CustomHttpPattern - RemoveDnsRecordSetResponse: - description: Blank message response type for RemoveDnsRecordSet API - id: RemoveDnsRecordSetResponse - properties: {} + properties: + header: + description: Specifies HTTP header name to extract JWT token. + type: string + query: + description: Specifies URL query parameter name to extract JWT token. + type: string + cookie: + description: Specifies cookie name to extract JWT token. + type: string + valuePrefix: + description: >- + The value prefix. The value format is "value_prefix{token}" Only + applies to "in" header type. Must be empty for "in" query type. If + not empty, the header value has to match (case sensitive) this + prefix. If not matched, JWT will not be extracted. If matched, JWT + will be extracted after the prefix is removed. For example, for + "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space + at the end. + type: string + Context: + id: Context + description: >- + `Context` defines which contexts an API requests. Example: context: + rules: - selector: "*" requested: - google.rpc.context.ProjectContext - + google.rpc.context.OriginContext The above specifies that all methods in + the API request `google.rpc.context.ProjectContext` and + `google.rpc.context.OriginContext`. Available context types are defined + in package `google.rpc.context`. This also provides mechanism to + allowlist any protobuf message extension that can be sent in grpc + metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For + example, list any service specific protobuf types that can appear in + grpc metadata as follows in your yaml file: Example: context: rules: - + selector: "google.example.library.v1.LibraryService.CreateBook" + allowed_request_extensions: - google.foo.v1.NewExtension + allowed_response_extensions: - google.foo.v1.NewExtension You can also + specify extension ID instead of fully qualified extension name here. type: object - LogDescriptor: + properties: + rules: + description: >- + A list of RPC context rules that apply to individual API methods. + **NOTE:** All service configuration rules follow "last one wins" + order. + type: array + items: + $ref: '#/components/schemas/ContextRule' + ContextRule: + id: ContextRule description: >- - A description of a log type. Example in YAML format: - name: - library.googleapis.com/activity_history description: The history of - borrowing and returning library items. display_name: Activity labels: - - key: /customer_id description: Identifier of a library customer + A context rule provides information about the context for an individual + API element. type: object properties: - name: + selector: description: >- - The name of the log. It must be less than 512 characters long and - can include the following characters: upper- and lower-case - alphanumeric characters [A-Za-z0-9], and punctuation characters - including slash, underscore, hyphen, period [/_-.]. - type: string - displayName: + Selects the methods to which this rule applies. Refer to selector + for syntax details. type: string + requested: description: >- - The human-readable name for this log. This information appears on - the user interface and should be concise. - description: - type: string + A list of full type names of requested contexts, only the requested + context will be made available to the backend. + type: array + items: + type: string + provided: description: >- - A human-readable description of this log. This information appears - in the documentation and can contain details. - labels: + A list of full type names of provided contexts. It is used to + support propagating HTTP headers and ETags from the response + extension. + type: array items: - $ref: '#/components/schemas/LabelDescriptor' + type: string + allowedRequestExtensions: + description: >- + A list of full type names or extension IDs of extensions allowed in + grpc side channel from client to backend. type: array + items: + type: string + allowedResponseExtensions: description: >- - The set of labels that are available to describe a specific log - entry. Runtime requests that contain labels not specified here are - considered invalid. - id: LogDescriptor - Quota: + A list of full type names or extension IDs of extensions allowed in + grpc side channel from backend to client. + type: array + items: + type: string + Usage: + id: Usage + description: Configuration controlling usage of a service. type: object properties: - metricRules: + requirements: description: >- - List of MetricRule definitions, each one mapping a selected method - to one or more metrics. + Requirements that must be satisfied before a consumer project can + use the service. Each requirement is of the form /; for example + 'serviceusage.googleapis.com/billing-enabled'. For Google APIs, a + Terms of Service requirement must be included here. Google Cloud + APIs must include "serviceusage.googleapis.com/tos/cloud". Other + Google APIs should include + "serviceusage.googleapis.com/tos/universal". Additional ToS can be + included based on the business needs. type: array items: - $ref: '#/components/schemas/MetricRule' - limits: - description: List of QuotaLimit definitions for the service. - items: - $ref: '#/components/schemas/QuotaLimit' + type: string + rules: + description: >- + A list of usage rules that apply to individual API methods. + **NOTE:** All service configuration rules follow "last one wins" + order. type: array - description: >- - Quota configuration helps to achieve fairness and budgeting in service - usage. The metric based quota configuration works this way: - The - service configuration defines a set of metrics. - For API calls, the - quota.metric_rules maps methods to metrics with corresponding costs. - - The quota.limits defines limits on the metrics, which will be used for - quota checks at runtime. An example quota configuration in yaml format: - quota: limits: - name: apiWriteQpsPerProject metric: - library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit - for consumer projects values: STANDARD: 10000 (The metric rules bind all - methods to the read_calls metric, except for the UpdateBook and - DeleteBook methods. These two methods are mapped to the write_calls - metric, with the UpdateBook method consuming at twice rate as the - DeleteBook method.) metric_rules: - selector: "*" metric_costs: - library.googleapis.com/read_calls: 1 - selector: - google.example.library.v1.LibraryService.UpdateBook metric_costs: - library.googleapis.com/write_calls: 2 - selector: - google.example.library.v1.LibraryService.DeleteBook metric_costs: - library.googleapis.com/write_calls: 1 Corresponding Metric definition: - metrics: - name: library.googleapis.com/read_calls display_name: Read - requests metric_kind: DELTA value_type: INT64 - name: - library.googleapis.com/write_calls display_name: Write requests - metric_kind: DELTA value_type: INT64 - id: Quota + items: + $ref: '#/components/schemas/UsageRule' + producerNotificationChannel: + description: >- + The full resource name of a channel used for sending notifications + to the service producer. Google Service Management currently only + supports [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as + a notification channel. To use Google Cloud Pub/Sub as the channel, + this must be the name of a Cloud Pub/Sub topic that uses the Cloud + Pub/Sub topic name format documented in + https://cloud.google.com/pubsub/docs/overview. + type: string UsageRule: id: UsageRule + description: Usage configuration rules for the service. type: object - description: >- - Usage configuration rules for the service. NOTE: Under development. Use - this rule to configure unregistered calls for the service. Unregistered - calls are calls that do not contain consumer project identity. (Example: - calls that do not contain an API key). By default, API methods do not - allow unregistered calls, and each method call must be identified by a - consumer project identity. Use this rule to allow/disallow unregistered - calls. Example of an API that wants to allow unregistered calls for - entire service. usage: rules: - selector: "*" allow_unregistered_calls: - true Example of a method that wants to allow unregistered calls. usage: - rules: - selector: "google.example.library.v1.LibraryService.CreateBook" - allow_unregistered_calls: true properties: + selector: + description: >- + Selects the methods to which this rule applies. Use '*' to indicate + all methods in all APIs. Refer to selector for syntax details. + type: string + allowUnregisteredCalls: + description: ' Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity.' + type: boolean skipServiceControl: description: >- If true, the selected method should skip service control and the @@ -3353,115 +2689,438 @@ components: available. This flag is used by Google Cloud Endpoints to bypass checks for internal methods, such as service health check methods. type: boolean - allowUnregisteredCalls: + CustomError: + id: CustomError + description: >- + Customize service error responses. For example, list any service + specific protobuf types that can appear in error detail lists of error + responses. Example: custom_error: types: - google.foo.v1.CustomError - + google.foo.v1.AnotherError + type: object + properties: + rules: + description: >- + The list of custom error rules that apply to individual API + messages. **NOTE:** All service configuration rules follow "last one + wins" order. + type: array + items: + $ref: '#/components/schemas/CustomErrorRule' + types: + description: >- + The list of custom error detail types, e.g. + 'google.foo.v1.CustomError'. + type: array + items: + type: string + CustomErrorRule: + id: CustomErrorRule + description: A custom error rule. + type: object + properties: + selector: + description: >- + Selects messages to which this rule applies. Refer to selector for + syntax details. + type: string + isErrorType: + description: >- + Mark this message as possible payload in error response. Otherwise, + objects of this type will be filtered when they appear in error + payload. + type: boolean + Endpoint: + id: Endpoint + description: >- + `Endpoint` describes a network address of a service that serves a set of + APIs. It is commonly known as a service endpoint. A service may expose + any number of service endpoints, and all service endpoints share the + same service definition, such as quota limits and monitoring metrics. + Example: type: google.api.Service name: library-example.googleapis.com + endpoints: # Declares network address + `https://library-example.googleapis.com` # for service + `library-example.googleapis.com`. The `https` scheme # is implicit for + all service endpoints. Other schemes may be # supported in the future. - + name: library-example.googleapis.com allow_cors: false - name: + content-staging-library-example.googleapis.com # Allows HTTP OPTIONS + calls to be passed to the API frontend, for it # to decide whether the + subsequent cross-origin request is allowed # to proceed. allow_cors: + true + type: object + properties: + name: + description: The canonical name of this endpoint. + type: string + aliases: + description: >- + Aliases for this endpoint, these will be served by the same UrlMap + as the parent endpoint, and will be provisioned in the GCP stack for + the Regional Endpoints. + type: array + items: + type: string + target: + description: >- + The specification of an Internet routable address of API frontend + that will handle requests to this [API + Endpoint](https://cloud.google.com/apis/design/glossary). It should + be either a valid IPv4 address or a fully-qualified domain name. For + example, "8.8.8.8" or "myservice.appspot.com". + type: string + allowCors: + description: >- + Allowing + [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), + aka cross-domain traffic, would allow the backends served from this + endpoint to receive and respond to HTTP OPTIONS requests. The + response will be used by the browser to determine whether the + subsequent cross-origin request is allowed to proceed. type: boolean + Control: + id: Control + description: >- + Selects and configures the service controller used by the service. + Example: control: environment: servicecontrol.googleapis.com + type: object + properties: + environment: description: >- - If true, the selected method allows unregistered calls, e.g. calls - that don't identify any user or application. + The service controller environment to use. If empty, no control + plane feature (like quota and billing) will be enabled. The + recommended value for most services is servicecontrol.googleapis.com + type: string + methodPolicies: + description: Defines policies applying to the API methods of the service. + type: array + items: + $ref: '#/components/schemas/MethodPolicy' + MethodPolicy: + id: MethodPolicy + description: Defines policies applying to an RPC method. + type: object + properties: selector: description: >- - Selects the methods to which this rule applies. Use '*' to indicate - all methods in all APIs. Refer to selector for syntax details. + Selects a method to which these policies should be enforced, for + example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to + selector for syntax details. NOTE: This field must not be set in the + proto annotation. It will be automatically filled by the service + config compiler . type: string - MetricRule: + requestPolicies: + description: Policies that are applicable to the request message. + type: array + items: + $ref: '#/components/schemas/FieldPolicy' + FieldPolicy: + id: FieldPolicy description: >- - Bind API methods to metrics. Binding a method to a metric causes that - metric's configured quota behaviors to apply to the method call. - id: MetricRule + Google API Policy Annotation This message defines a simple API policy + annotation that can be used to annotate API request and response message + fields with applicable policies. One field may have multiple applicable + policies that must all be satisfied before a request can be processed. + This policy annotation is used to generate the overall policy that will + be used for automatic runtime policy enforcement and documentation + generation. type: object properties: selector: + description: >- + Selects one or more request or response message fields to apply this + `FieldPolicy`. When a `FieldPolicy` is used in proto annotation, the + selector must be left as empty. The service config generator will + automatically fill the correct value. When a `FieldPolicy` is used + in service config, the selector must be a comma-separated string + with valid request or response field paths, such as "foo.bar" or + "foo.bar,foo.baz". type: string + resourcePermission: description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. - metricCosts: - additionalProperties: - type: string - format: int64 + Specifies the required permission(s) for the resource referred to by + the field. It requires the field contains a valid resource + reference, and the request must pass the permission checks to + proceed. For example, "resourcemanager.projects.get". + type: string + resourceType: description: >- - Metrics to update when the selected methods are called, and the - associated cost applied to each metric. The key of the map is the - metric name, and the values are the amount increased for the metric - against which the quota limits are defined. The value must not be - negative. - type: object - Usage: + Specifies the resource type for the resource referred to by the + field. + type: string + LogDescriptor: + id: LogDescriptor + description: >- + A description of a log type. Example in YAML format: - name: + library.googleapis.com/activity_history description: The history of + borrowing and returning library items. display_name: Activity labels: - + key: /customer_id description: Identifier of a library customer type: object - description: Configuration controlling usage of a service. - id: Usage properties: - requirements: + name: description: >- - Requirements that must be satisfied before a consumer project can - use the service. Each requirement is of the form /; for example - 'serviceusage.googleapis.com/billing-enabled'. For Google APIs, a - Terms of Service requirement must be included here. Google Cloud - APIs must include "serviceusage.googleapis.com/tos/cloud". Other - Google APIs should include - "serviceusage.googleapis.com/tos/universal". Additional ToS can be - included based on the business needs. - items: - type: string + The name of the log. It must be less than 512 characters long and + can include the following characters: upper- and lower-case + alphanumeric characters [A-Za-z0-9], and punctuation characters + including slash, underscore, hyphen, period [/_-.]. + type: string + labels: + description: >- + The set of labels that are available to describe a specific log + entry. Runtime requests that contain labels not specified here are + considered invalid. type: array - rules: items: - $ref: '#/components/schemas/UsageRule' - type: array + $ref: '#/components/schemas/LabelDescriptor' + description: description: >- - A list of usage rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. - producerNotificationChannel: + A human-readable description of this log. This information appears + in the documentation and can contain details. + type: string + displayName: description: >- - The full resource name of a channel used for sending notifications - to the service producer. Google Service Management currently only - supports [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as - a notification channel. To use Google Cloud Pub/Sub as the channel, - this must be the name of a Cloud Pub/Sub topic that uses the Cloud - Pub/Sub topic name format documented in - https://cloud.google.com/pubsub/docs/overview. + The human-readable name for this log. This information appears on + the user interface and should be concise. type: string - SecondaryIpRangeSpec: - id: SecondaryIpRangeSpec + LabelDescriptor: + id: LabelDescriptor + description: A description of a label. type: object properties: - rangeName: + key: + description: The label key. + type: string + valueType: + description: The type of data that can be assigned to the label. + type: string + enumDescriptions: + - A variable-length string. This is the default. + - Boolean; true or false. + - A 64-bit signed integer. + enum: + - STRING + - BOOL + - INT64 + description: + description: A human-readable description for the label. + type: string + MetricDescriptor: + id: MetricDescriptor + description: >- + Defines a metric type and its schema. Once a metric descriptor is + created, deleting or altering it stops data collection and makes the + metric type's existing data unusable. + type: object + properties: + name: + description: The resource name of the metric descriptor. type: string + type: description: >- - Required. A name for the secondary IP range. The name must be 1-63 - characters long, and comply with RFC1035. The name must be unique - within the subnetwork. - ipPrefixLength: - type: integer - format: int32 + The metric type, including its DNS name prefix. The type is not + URL-encoded. All user-defined metric types have the DNS name + `custom.googleapis.com` or `external.googleapis.com`. Metric types + should use a natural hierarchical grouping. For example: + "custom.googleapis.com/invoice/paid/amount" + "external.googleapis.com/prometheus/up" + "appengine.googleapis.com/http/server/response_latencies" + type: string + labels: description: >- - Required. The prefix length of the secondary IP range. Use CIDR - range notation, such as `30` to provision a secondary IP range with - an `x.x.x.x/30` CIDR range. The IP address range is drawn from a - pool of available ranges in the service consumer's allocated range. - outsideAllocationPublicIpRange: + The set of labels that can be used to describe a specific instance + of this metric type. For example, the + `appengine.googleapis.com/http/server/response_latencies` metric + type has a label for the HTTP response code, `response_code`, so you + can look at latencies for successful responses or just for responses + that failed. + type: array + items: + $ref: '#/components/schemas/LabelDescriptor' + metricKind: + description: >- + Whether the metric records instantaneous values, changes to a value, + etc. Some combinations of `metric_kind` and `value_type` might not + be supported. + type: string + enumDescriptions: + - Do not use this default value. + - An instantaneous measurement of a value. + - The change in a value during a time interval. + - >- + A value accumulated over a time interval. Cumulative measurements + in a time series should have the same start time and increasing + end times, until an event resets the cumulative value to zero and + sets a new start time for the following points. + enum: + - METRIC_KIND_UNSPECIFIED + - GAUGE + - DELTA + - CUMULATIVE + valueType: + description: >- + Whether the measurement is an integer, a floating-point number, etc. + Some combinations of `metric_kind` and `value_type` might not be + supported. + type: string + enumDescriptions: + - Do not use this default value. + - >- + The value is a boolean. This value type can be used only if the + metric kind is `GAUGE`. + - The value is a signed 64-bit integer. + - The value is a double precision floating point number. + - >- + The value is a text string. This value type can be used only if + the metric kind is `GAUGE`. + - The value is a `Distribution`. + - The value is money. + enum: + - VALUE_TYPE_UNSPECIFIED + - BOOL + - INT64 + - DOUBLE + - STRING + - DISTRIBUTION + - MONEY + unit: + description: >- + The units in which the metric value is reported. It is only + applicable if the `value_type` is `INT64`, `DOUBLE`, or + `DISTRIBUTION`. The `unit` defines the representation of the stored + metric values. Different systems might scale the values to be more + easily displayed (so a value of `0.02kBy` _might_ be displayed as + `20By`, and a value of `3523kBy` _might_ be displayed as `3.5MBy`). + However, if the `unit` is `kBy`, then the value of the metric is + always in thousands of bytes, no matter how it might be displayed. + If you want a custom metric to record the exact number of + CPU-seconds used by a job, you can create an `INT64 CUMULATIVE` + metric whose `unit` is `s{CPU}` (or equivalently `1s{CPU}` or just + `s`). If the job uses 12,005 CPU-seconds, then the value is written + as `12005`. Alternatively, if you want a custom metric to record + data in a more granular way, you can create a `DOUBLE CUMULATIVE` + metric whose `unit` is `ks{CPU}`, and then write the value `12.005` + (which is `12005/1000`), or use `Kis{CPU}` and write `11.723` (which + is `12005/1024`). The supported units are a subset of [The Unified + Code for Units of Measure](https://unitsofmeasure.org/ucum.html) + standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` + second * `min` minute * `h` hour * `d` day * `1` dimensionless + **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga + (10^9) * `T` tera (10^12) * `P` peta (10^15) * `E` exa (10^18) * `Z` + zetta (10^21) * `Y` yotta (10^24) * `m` milli (10^-3) * `u` micro + (10^-6) * `n` nano (10^-9) * `p` pico (10^-12) * `f` femto (10^-15) + * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto (10^-24) * `Ki` + kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) + * `Pi` pebi (2^50) **Grammar** The grammar also includes these + connectors: * `/` division or ratio (as an infix operator). For + examples, `kBy/{email}` or `MiBy/10ms` (although you should almost + never have `/s` in a metric `unit`; rates should always be computed + at query time from the underlying cumulative or delta value). * `.` + multiplication or composition (as an infix operator). For examples, + `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: + Expression = Component { "." Component } { "/" Component } ; + Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | + "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a + comment if it follows a `UNIT`. If the annotation is used alone, + then the unit is equivalent to `1`. For examples, `{request}/s == + 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of + non-blank printable ASCII characters not containing `{` or `}`. * + `1` represents a unitary [dimensionless + unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, + such as in `1/s`. It is typically used when none of the basic units + are appropriate. For example, "new users per day" can be represented + as `1/d` or `{new-users}/d` (and a metric value `5` would mean "5 + new users). Alternatively, "thousands of page views per day" would + be represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a + metric value of `5.3` would mean "5300 page views per day"). * `%` + represents dimensionless value of 1/100, and annotates values giving + a percentage (so the metric values are typically in the range of + 0..100, and a metric value `3` means "3 percent"). * `10^2.%` + indicates a metric contains a ratio, typically in the range 0..1, + that will be multiplied by 100 and displayed as a percentage (so a + metric value `0.03` means "3 percent"). + type: string + description: + description: >- + A detailed description of the metric, which can be used in + documentation. type: string + displayName: description: >- - Optional. Enable outside allocation using public IP addresses. Any - public IP range may be specified. If this field is provided, we will - not use customer reserved ranges for this secondary IP range. - requestedAddress: + A concise name for the metric, which can be displayed in user + interfaces. Use sentence case without an ending period, for example + "Request count". This field is optional but it is recommended to be + set for any metrics associated with user-visible concepts, such as + Quota. + type: string + metadata: + description: Optional. Metadata which can be used to guide usage of the metric. + $ref: '#/components/schemas/MetricDescriptorMetadata' + launchStage: + description: Optional. The launch stage of the metric definition. type: string + enumDescriptions: + - Do not use this default value. + - The feature is not yet implemented. Users can not use it. + - >- + Prelaunch features are hidden from users and are only visible + internally. + - >- + Early Access features are limited to a closed group of testers. To + use these features, you must sign up in advance and sign a Trusted + Tester agreement (which includes confidentiality provisions). + These features may be unstable, changed in backward-incompatible + ways, and are not guaranteed to be released. + - >- + Alpha is a limited availability test for releases before they are + cleared for widespread use. By Alpha, all significant design + issues are resolved and we are in the process of verifying + functionality. Alpha customers need to apply for access, agree to + applicable terms, and have their projects allowlisted. Alpha + releases don't have to be feature complete, no SLAs are provided, + and there are no technical support obligations, but they will be + far enough along that customers can actually use them in test + environments or for limited-use tests -- just like they would in + normal production cases. + - >- + Beta is the point at which we are ready to open a release for any + customer to use. There are no SLA or technical support obligations + in a Beta release. Products will be complete from a feature + perspective, but may have some open outstanding issues. Beta + releases are suitable for limited production use cases. + - >- + GA features are open to all developers and are considered stable + and fully qualified for production use. + - >- + Deprecated features are scheduled to be shut down and removed. For + more information, see the "Deprecation Policy" section of our + [Terms of Service](https://cloud.google.com/terms/) and the + [Google Cloud Platform Subject to the Deprecation + Policy](https://cloud.google.com/terms/deprecation) documentation. + enum: + - LAUNCH_STAGE_UNSPECIFIED + - UNIMPLEMENTED + - PRELAUNCH + - EARLY_ACCESS + - ALPHA + - BETA + - GA + - DEPRECATED + monitoredResourceTypes: description: >- - Optional. The starting address of a range. The address must be a - valid IPv4 address in the x.x.x.x format. This value combined with - the IP prefix range is the CIDR range for the secondary IP range. - The range must be within the allocated range that is assigned to the - private connection. If the CIDR range isn't available, the call - fails. + Read-only. If present, then a time series, which is identified + partially by a metric type and a MonitoredResourceDescriptor, that + is associated with this metric type can only be associated with one + of the monitored resource types listed here. + type: array + items: + type: string MetricDescriptorMetadata: - type: object + id: MetricDescriptorMetadata description: Additional annotations that can be used to guide the usage of a metric. + type: object properties: launchStage: - type: string + description: Deprecated. Must use the MetricDescriptor.launch_stage instead. deprecated: true + type: string enumDescriptions: - Do not use this default value. - The feature is not yet implemented. Users can not use it. @@ -3509,584 +3168,1025 @@ components: - BETA - GA - DEPRECATED - description: Deprecated. Must use the MetricDescriptor.launch_stage instead. samplePeriod: - format: google-duration - type: string description: >- The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period. + type: string + format: google-duration + ingestDelay: + description: >- + The delay of data points caused by ingestion. Data points older than + this age are guaranteed to be ingested and available to be read, + excluding data loss due to errors. + type: string + format: google-duration timeSeriesResourceHierarchyLevel: - type: array description: The scope of the timeseries data of the metric. + type: array items: - enum: - - TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED - - PROJECT - - ORGANIZATION - - FOLDER type: string enumDescriptions: - Do not use this default value. - Scopes a metric to a project. - Scopes a metric to an organization. - Scopes a metric to a folder. - ingestDelay: + enum: + - TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED + - PROJECT + - ORGANIZATION + - FOLDER + MonitoredResourceDescriptor: + id: MonitoredResourceDescriptor + description: >- + An object that describes the schema of a MonitoredResource object using + a type name and a set of labels. For example, the monitored resource + descriptor for Google Compute Engine VM instances has a type of + `"gce_instance"` and specifies the use of the labels `"instance_id"` and + `"zone"` to identify particular VM instances. Different APIs can support + different monitored resource types. APIs generally provide a `list` + method that returns the monitored resource descriptors used by the API. + type: object + properties: + name: description: >- - The delay of data points caused by ingestion. Data points older than - this age are guaranteed to be ingested and available to be read, - excluding data loss due to errors. + Optional. The resource name of the monitored resource descriptor: + `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where + {type} is the value of the `type` field in this object and + {project_id} is a project ID that provides API-specific context for + accessing the type. APIs that do not use project information can use + the resource name format `"monitoredResourceDescriptors/{type}"`. type: string - format: google-duration - id: MetricDescriptorMetadata - DocumentationRule: - description: A documentation rule provides information about individual API elements. - properties: - disableReplacementWords: + type: description: >- - String of comma or space separated case-sensitive words for which - method/field name replacement will be disabled by go/api-docgen. + Required. The monitored resource type. For example, the type + `"cloudsql_database"` represents databases in Google Cloud SQL. For + a list of types, see [Monitored resource + types](https://cloud.google.com/monitoring/api/resources) and + [Logging resource + types](https://cloud.google.com/logging/docs/api/v2/resource-list). type: string - deprecationDescription: + displayName: description: >- - Deprecation description of the selected element(s). It can be - provided if an element is marked as `deprecated`. + Optional. A concise name for the monitored resource type that might + be displayed in user interfaces. It should be a Title Cased Noun + Phrase, without any article or other determiners. For example, + `"Google Cloud SQL Database"`. type: string description: + description: >- + Optional. A detailed description of the monitored resource type that + might be used in documentation. type: string + labels: description: >- - Description of the selected proto element (e.g. a message, a method, - a 'service' definition, or a field). Defaults to leading & trailing - comments taken from the proto source definition of the proto - element. - selector: + Required. A set of labels used to describe instances of this + monitored resource type. For example, an individual Google Cloud SQL + database is identified by values for the labels `"database_id"` and + `"zone"`. + type: array + items: + $ref: '#/components/schemas/LabelDescriptor' + launchStage: + description: Optional. The launch stage of the monitored resource definition. + type: string + enumDescriptions: + - Do not use this default value. + - The feature is not yet implemented. Users can not use it. + - >- + Prelaunch features are hidden from users and are only visible + internally. + - >- + Early Access features are limited to a closed group of testers. To + use these features, you must sign up in advance and sign a Trusted + Tester agreement (which includes confidentiality provisions). + These features may be unstable, changed in backward-incompatible + ways, and are not guaranteed to be released. + - >- + Alpha is a limited availability test for releases before they are + cleared for widespread use. By Alpha, all significant design + issues are resolved and we are in the process of verifying + functionality. Alpha customers need to apply for access, agree to + applicable terms, and have their projects allowlisted. Alpha + releases don't have to be feature complete, no SLAs are provided, + and there are no technical support obligations, but they will be + far enough along that customers can actually use them in test + environments or for limited-use tests -- just like they would in + normal production cases. + - >- + Beta is the point at which we are ready to open a release for any + customer to use. There are no SLA or technical support obligations + in a Beta release. Products will be complete from a feature + perspective, but may have some open outstanding issues. Beta + releases are suitable for limited production use cases. + - >- + GA features are open to all developers and are considered stable + and fully qualified for production use. + - >- + Deprecated features are scheduled to be shut down and removed. For + more information, see the "Deprecation Policy" section of our + [Terms of Service](https://cloud.google.com/terms/) and the + [Google Cloud Platform Subject to the Deprecation + Policy](https://cloud.google.com/terms/deprecation) documentation. + enum: + - LAUNCH_STAGE_UNSPECIFIED + - UNIMPLEMENTED + - PRELAUNCH + - EARLY_ACCESS + - ALPHA + - BETA + - GA + - DEPRECATED + Billing: + id: Billing + description: >- + Billing related configuration of the service. The following example + shows how to configure monitored resources and metrics for billing, + `consumer_destinations` is the only supported destination and the + monitored resources need at least one label key + `cloud.googleapis.com/location` to indicate the location of the billing + usage, using different monitored resources between monitoring and + billing is recommended so they can be evolved independently: + monitored_resources: - type: library.googleapis.com/billing_branch + labels: - key: cloud.googleapis.com/location description: | Predefined + label to support billing location restriction. - key: city description: + | Custom label to define the city where the library branch is located + in. - key: name description: Custom label to define the name of the + library branch. metrics: - name: + library.googleapis.com/book/borrowed_count metric_kind: DELTA + value_type: INT64 unit: "1" billing: consumer_destinations: - + monitored_resource: library.googleapis.com/billing_branch metrics: - + library.googleapis.com/book/borrowed_count + type: object + properties: + consumerDestinations: + description: >- + Billing configurations for sending metrics to the consumer project. + There can be multiple consumer destinations per service, each one + must have a different monitored resource type. A metric can be used + in at most one consumer destination. + type: array + items: + $ref: '#/components/schemas/BillingDestination' + BillingDestination: + id: BillingDestination + description: >- + Configuration of a specific billing destination (Currently only support + bill against consumer project). + type: object + properties: + monitoredResource: description: >- - The selector is a comma-separated list of patterns for any element - such as a method, a field, an enum value. Each pattern is a - qualified name of the element which may end in "*", indicating a - wildcard. Wildcards are only allowed at the end and for a whole - component of the qualified name, i.e. "foo.*" is ok, but not - "foo.b*" or "foo.*.bar". A wildcard will match one or more - components. To specify a default for all applicable elements, the - whole pattern "*" is used. + The monitored resource type. The type must be defined in + Service.monitored_resources section. type: string - type: object - id: DocumentationRule - Service: + metrics: + description: >- + Names of the metrics to report to this billing destination. Each + name must be defined in Service.metrics section. + type: array + items: + type: string + Logging: + id: Logging + description: >- + Logging configuration of the service. The following example shows how to + configure logs to be sent to the producer and consumer projects. In the + example, the `activity_history` log is sent to both the producer and + consumer projects, whereas the `purchase_history` log is only sent to + the producer project. monitored_resources: - type: + library.googleapis.com/branch labels: - key: /city description: The city + where the library branch is located in. - key: /name description: The + name of the branch. logs: - name: activity_history labels: - key: + /customer_id - name: purchase_history logging: producer_destinations: - + monitored_resource: library.googleapis.com/branch logs: - + activity_history - purchase_history consumer_destinations: - + monitored_resource: library.googleapis.com/branch logs: - + activity_history type: object properties: - types: + producerDestinations: + description: >- + Logging configurations for sending logs to the producer project. + There can be multiple producer destinations, each one must have a + different monitored resource type. A log can be used in at most one + producer destination. type: array items: - $ref: '#/components/schemas/Type' + $ref: '#/components/schemas/LoggingDestination' + consumerDestinations: description: >- - A list of all proto message types included in this API service. - Types referenced directly or indirectly by the `apis` are - automatically included. Messages which are not referenced but shall - be included, such as types used by the `google.protobuf.Any` type, - should be listed here by name by the configuration author. Example: - types: - name: google.protobuf.Int32 - systemParameters: - description: System parameter configuration. - $ref: '#/components/schemas/SystemParameters' - quota: - $ref: '#/components/schemas/Quota' - description: Quota configuration. - http: - $ref: '#/components/schemas/Http' - description: HTTP configuration. - sourceInfo: + Logging configurations for sending logs to the consumer project. + There can be multiple consumer destinations, each one must have a + different monitored resource type. A log can be used in at most one + consumer destination. + type: array + items: + $ref: '#/components/schemas/LoggingDestination' + LoggingDestination: + id: LoggingDestination + description: >- + Configuration of a specific logging destination (the producer project or + the consumer project). + type: object + properties: + monitoredResource: description: >- - Output only. The source information for this configuration if - available. - $ref: '#/components/schemas/SourceInfo' - backend: - $ref: '#/components/schemas/Backend' - description: API backend configuration. - control: - description: Configuration for the service control plane. - $ref: '#/components/schemas/Control' - monitoredResources: + The monitored resource type. The type must be defined in the + Service.monitored_resources section. + type: string + logs: description: >- - Defines the monitored resources used by this service. This is - required by the Service.monitoring and Service.logging - configurations. + Names of the logs to be sent to this destination. Each name must be + defined in the Service.logs section. If the log name is not a domain + scoped name, it will be automatically prefixed with the service name + followed by "/". type: array items: - $ref: '#/components/schemas/MonitoredResourceDescriptor' - customError: - $ref: '#/components/schemas/CustomError' - description: Custom error configuration. - context: - $ref: '#/components/schemas/Context' - description: Context configuration. - endpoints: + type: string + Monitoring: + id: Monitoring + description: >- + Monitoring configuration of the service. The example below shows how to + configure monitored resources and metrics for monitoring. In the + example, a monitored resource and two metrics are defined. The + `library.googleapis.com/book/returned_count` metric is sent to both + producer and consumer projects, whereas the + `library.googleapis.com/book/num_overdue` metric is only sent to the + consumer project. monitored_resources: - type: + library.googleapis.com/Branch display_name: "Library Branch" + description: "A branch of a library." launch_stage: GA labels: - key: + resource_container description: "The Cloud container (ie. project id) + for the Branch." - key: location description: "The location of the + library branch." - key: branch_id description: "The id of the branch." + metrics: - name: library.googleapis.com/book/returned_count + display_name: "Books Returned" description: "The count of books that + have been returned." launch_stage: GA metric_kind: DELTA value_type: + INT64 unit: "1" labels: - key: customer_id description: "The id of the + customer." - name: library.googleapis.com/book/num_overdue display_name: + "Books Overdue" description: "The current number of overdue books." + launch_stage: GA metric_kind: GAUGE value_type: INT64 unit: "1" labels: + - key: customer_id description: "The id of the customer." monitoring: + producer_destinations: - monitored_resource: + library.googleapis.com/Branch metrics: - + library.googleapis.com/book/returned_count consumer_destinations: - + monitored_resource: library.googleapis.com/Branch metrics: - + library.googleapis.com/book/returned_count - + library.googleapis.com/book/num_overdue + type: object + properties: + producerDestinations: description: >- - Configuration for network endpoints. If this is empty, then an - endpoint with the same name as the service is automatically - generated to service all defined APIs. + Monitoring configurations for sending metrics to the producer + project. There can be multiple producer destinations. A monitored + resource type may appear in multiple monitoring destinations if + different aggregations are needed for different sets of metrics + associated with that monitored resource type. A monitored resource + and metric pair may only be used once in the Monitoring + configuration. + type: array items: - $ref: '#/components/schemas/Endpoint' + $ref: '#/components/schemas/MonitoringDestination' + consumerDestinations: + description: >- + Monitoring configurations for sending metrics to the consumer + project. There can be multiple consumer destinations. A monitored + resource type may appear in multiple monitoring destinations if + different aggregations are needed for different sets of metrics + associated with that monitored resource type. A monitored resource + and metric pair may only be used once in the Monitoring + configuration. type: array - name: - type: string + items: + $ref: '#/components/schemas/MonitoringDestination' + MonitoringDestination: + id: MonitoringDestination + description: >- + Configuration of a specific monitoring destination (the producer project + or the consumer project). + type: object + properties: + monitoredResource: description: >- - The service name, which is a DNS-like logical identifier for the - service, such as `calendar.googleapis.com`. The service name - typically goes through DNS verification to make sure the owner of - the service also owns the DNS name. - documentation: - description: Additional API documentation. - $ref: '#/components/schemas/Documentation' - authentication: - description: Auth configuration. - $ref: '#/components/schemas/Authentication' - apis: + The monitored resource type. The type must be defined in + Service.monitored_resources section. + type: string + metrics: description: >- - A list of API interfaces exported by this service. Only the `name` - field of the google.protobuf.Api needs to be provided by the - configuration author, as the remaining fields will be derived from - the IDL during the normalization process. It is an error to specify - an API interface here which cannot be resolved against the - associated IDL files. - items: - $ref: '#/components/schemas/Api' - type: array - logging: - $ref: '#/components/schemas/Logging' - description: Logging configuration. - logs: + Types of the metrics to report to this monitoring destination. Each + type must be defined in Service.metrics section. type: array items: - $ref: '#/components/schemas/LogDescriptor' - description: Defines the logs used by this service. - billing: - $ref: '#/components/schemas/Billing' - description: Billing configuration. - metrics: - description: Defines the metrics used by this service. + type: string + SystemParameters: + id: SystemParameters + description: >- + ### System parameter configuration A system parameter is a special kind + of parameter defined by the API system, not by an individual API. It is + typically mapped to an HTTP header and/or a URL query parameter. This + configuration specifies which methods change the names of the system + parameters. + type: object + properties: + rules: + description: >- + Define system parameters. The parameters defined here will override + the default parameters implemented by the system. If this field is + missing from the service config, default system parameters will be + used. Default system parameters and names is + implementation-dependent. Example: define api key for all methods + system_parameters rules: - selector: "*" parameters: - name: api_key + url_query_parameter: api_key Example: define 2 api key names for a + specific method. system_parameters rules: - selector: "/ListShelves" + parameters: - name: api_key http_header: Api-Key1 - name: api_key + http_header: Api-Key2 **NOTE:** All service configuration rules + follow "last one wins" order. + type: array items: - $ref: '#/components/schemas/MetricDescriptor' + $ref: '#/components/schemas/SystemParameterRule' + SystemParameterRule: + id: SystemParameterRule + description: >- + Define a system parameter rule mapping system parameter definitions to + methods. + type: object + properties: + selector: + description: >- + Selects the methods to which this rule applies. Use '*' to indicate + all methods in all APIs. Refer to selector for syntax details. + type: string + parameters: + description: >- + Define parameters. Multiple names may be defined for a parameter. + For a given method call, only one of them should be used. If + multiple names are used the behavior is implementation-dependent. If + none of the specified names are present the behavior is + parameter-dependent. type: array - id: + items: + $ref: '#/components/schemas/SystemParameter' + SystemParameter: + id: SystemParameter + description: >- + Define a parameter's name and location. The parameter may be passed as + either an HTTP header or a URL query parameter, and if both are passed + the behavior is implementation-dependent. + type: object + properties: + name: + description: >- + Define the name of the parameter, such as "api_key" . It is case + sensitive. type: string + httpHeader: description: >- - A unique ID for a specific instance of this message, typically - assigned by the client for tracking purpose. Must be no longer than - 63 characters and only lower case letters, digits, '.', '_' and '-' - are allowed. If empty, the server may choose to generate one - instead. - enums: - items: - $ref: '#/components/schemas/Enum' + Define the HTTP header name to use for the parameter. It is case + insensitive. + type: string + urlQueryParameter: description: >- - A list of all enum types included in this API service. Enums - referenced directly or indirectly by the `apis` are automatically - included. Enums which are not referenced but shall be included - should be listed here by name by the configuration author. Example: - enums: - name: google.someapi.v1.SomeEnum + Define the URL query parameter name to use for the parameter. It is + case sensitive. + type: string + SourceInfo: + id: SourceInfo + description: Source information used to create a Service Config + type: object + properties: + sourceFiles: + description: All files used during config generation. type: array - systemTypes: + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + Publishing: + id: Publishing + description: >- + This message configures the settings for publishing [Google Cloud Client + libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) + generated from the service config. + type: object + properties: + methodSettings: description: >- - A list of all proto message types included in this API service. It - serves similar purpose as [google.api.Service.types], except that - these types are not needed by user-defined APIs. Therefore, they - will not show up in the generated discovery doc. This field should - only be used to define system APIs in ESF. + A list of API method settings, e.g. the behavior for methods that + use the long-running operation pattern. type: array items: - $ref: '#/components/schemas/Type' - producerProjectId: - description: The Google project that owns this service. + $ref: '#/components/schemas/MethodSettings' + newIssueUri: + description: >- + Link to a *public* URI where users can report issues. Example: + https://issuetracker.google.com/issues/new?component=190865&template=1161103 type: string - usage: - $ref: '#/components/schemas/Usage' - description: Configuration controlling usage of this service. - monitoring: - $ref: '#/components/schemas/Monitoring' - description: Monitoring configuration. - publishing: + documentationUri: description: >- - Settings for [Google Cloud Client - libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) - generated from APIs defined as protocol buffers. - $ref: '#/components/schemas/Publishing' - title: + Link to product home page. Example: + https://cloud.google.com/asset-inventory/docs/overview + type: string + apiShortName: description: >- - The product title for this service, it is the name displayed in - Google Cloud Console. + Used as a tracking tag when collecting data about the APIs developer + relations artifacts like docs, packages delivered to package + managers, etc. Example: "speech". type: string - configVersion: + githubLabel: description: >- - Obsolete. Do not use. This field has no semantic meaning. The - service config compiler always sets this field to `3`. - format: uint32 - type: integer - description: >- - `Service` is the root object of Google API service configuration - (service config). It describes the basic information about a logical - service, such as the service name and the user-facing title, and - delegates other aspects to sub-sections. Each sub-section is either a - proto message or a repeated proto message that configures a specific - aspect, such as auth. For more information, see each proto message - definition. Example: type: google.api.Service name: - calendar.googleapis.com title: Google Calendar API apis: - name: - google.calendar.v3.Calendar visibility: rules: - selector: - "google.calendar.v3.*" restriction: PREVIEW backend: rules: - selector: - "google.calendar.v3.*" address: calendar.example.com authentication: - providers: - id: google_calendar_auth jwks_uri: - https://www.googleapis.com/oauth2/v1/certs issuer: - https://securetoken.google.com rules: - selector: "*" requirements: - provider_id: google_calendar_auth - id: Service - VpcServiceControls: - description: Response for the get VPC Service Controls request. - type: object - id: VpcServiceControls - properties: - enabled: - readOnly: true + GitHub label to apply to issues and pull requests opened for this + API. + type: string + codeownerGithubTeams: description: >- - Output only. Indicates whether the VPC Service Controls are enabled - or disabled for the connection. If the consumer called the - EnableVpcServiceControls method, then this is true. If the consumer - called DisableVpcServiceControls, then this is false. The default is - false. - type: boolean - Enum: - type: object - description: Enum type definition. - properties: - syntax: + GitHub teams to be added to CODEOWNERS in the directory in GitHub + containing source code for the client libraries for this API. + type: array + items: + type: string + docTagPrefix: + description: >- + A prefix used in sample code when demarking regions to be included + in documentation. + type: string + organization: + description: For whom the client library is being published. + type: string enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. - description: The source syntax. + - Not useful. + - Google Cloud Platform Org. + - Ads (Advertising) Org. + - Photos Org. + - Street View Org. + - Shopping Org. + - Geo Org. + - Generative AI - https://developers.generativeai.google enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS - type: string - sourceContext: - $ref: '#/components/schemas/SourceContext' - description: The source context. - options: - description: Protocol buffer options. - items: - $ref: '#/components/schemas/Option' - type: array - enumvalue: - description: Enum value definitions. + - CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED + - CLOUD + - ADS + - PHOTOS + - STREET_VIEW + - SHOPPING + - GEO + - GENERATIVE_AI + librarySettings: + description: >- + Client library settings. If the same version string appears multiple + times in this list, then the last one wins. Settings from earlier + settings with the same version string are discarded. type: array items: - $ref: '#/components/schemas/EnumValue' - edition: + $ref: '#/components/schemas/ClientLibrarySettings' + protoReferenceDocumentationUri: description: >- - The source edition string, only valid when syntax is - SYNTAX_EDITIONS. + Optional link to proto reference documentation. Example: + https://cloud.google.com/pubsub/lite/docs/reference/rpc type: string - name: + restReferenceDocumentationUri: + description: >- + Optional link to REST reference documentation. Example: + https://cloud.google.com/pubsub/lite/docs/reference/rest type: string - description: Enum type name. - id: Enum - SourceInfo: + MethodSettings: + id: MethodSettings + description: Describes the generator configuration for a method. + type: object properties: - sourceFiles: - items: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any + selector: + description: >- + The fully qualified name of the method, for which the options below + apply. This is used to find the method to apply the options. + Example: publishing: method_settings: - selector: + google.storage.control.v2.StorageControl.CreateFolder # method + settings for CreateFolder... + type: string + longRunning: + description: >- + Describes settings to use for long-running operations when + generating API methods for RPCs. Complements RPCs that use the + annotations in google/longrunning/operations.proto. Example of a + YAML configuration:: publishing: method_settings: - selector: + google.cloud.speech.v2.Speech.BatchRecognize long_running: + initial_poll_delay: 60s # 1 minute poll_delay_multiplier: 1.5 + max_poll_delay: 360s # 6 minutes total_poll_timeout: 54000s # 90 + minutes + $ref: '#/components/schemas/LongRunning' + autoPopulatedFields: + description: >- + List of top-level fields of the request message, that should be + automatically populated by the client libraries based on their + (google.api.field_info).format. Currently supported format: UUID4. + Example of a YAML configuration: publishing: method_settings: - + selector: google.example.v1.ExampleService.CreateExample + auto_populated_fields: - request_id type: array - description: All files used during config generation. - type: object - id: SourceInfo - description: Source information used to create a Service Config - RemoveDnsRecordSetRequest: + items: + type: string + batching: + description: >- + Batching configuration for an API method in client libraries. + Example of a YAML configuration: publishing: method_settings: - + selector: google.example.v1.ExampleService.BatchCreateExample + batching: element_count_threshold: 1000 request_byte_threshold: + 100000000 delay_threshold_millis: 10 + $ref: '#/components/schemas/BatchingConfigProto' + LongRunning: + id: LongRunning + description: >- + Describes settings to use when generating API methods that use the + long-running operation pattern. All default values below are from those + used in the client library generators (e.g. + [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)). type: object properties: - dnsRecordSet: - $ref: '#/components/schemas/DnsRecordSet' - description: Required. The DNS record set to remove. - consumerNetwork: + initialPollDelay: + description: >- + Initial delay after which the first poll request will be made. + Default value: 5 seconds. type: string + format: google-duration + pollDelayMultiplier: description: >- - Required. The network that the consumer is using to connect with - services. Must be in the form of - projects/{project}/global/networks/{network} {project} is the - project number, as in '12345' {network} is the network name. - zone: + Multiplier to gradually increase delay between subsequent polls + until it reaches max_poll_delay. Default value: 1.5. + type: number + format: float + maxPollDelay: description: >- - Required. The name of the private DNS zone in the shared producer - host project from which the record set will be removed. + Maximum time between two subsequent poll requests. Default value: 45 + seconds. type: string - id: RemoveDnsRecordSetRequest + format: google-duration + totalPollTimeout: + description: 'Total polling timeout. Default value: 5 minutes.' + type: string + format: google-duration + BatchingConfigProto: + id: BatchingConfigProto description: >- - Request to remove a record set from a private managed DNS zone in the - shared producer host project. The name, type, ttl, and data values must - all exactly match an existing record set in the specified zone. - AuthRequirement: - id: AuthRequirement + `BatchingConfigProto` defines the batching configuration for an API + method. + type: object + properties: + thresholds: + description: The thresholds which trigger a batched request to be sent. + $ref: '#/components/schemas/BatchingSettingsProto' + batchDescriptor: + description: The request and response fields used in batching. + $ref: '#/components/schemas/BatchingDescriptorProto' + BatchingSettingsProto: + id: BatchingSettingsProto description: >- - User-defined authentication requirements, including support for [JSON - Web Token - (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + `BatchingSettingsProto` specifies a set of batching thresholds, each of + which acts as a trigger to send a batch of messages as a request. At + least one threshold must be positive nonzero. type: object properties: - audiences: - type: string + elementCountThreshold: description: >- - NOTE: This will be deprecated soon, once AuthProvider.audiences is - implemented and accepted in all the runtime components. The list of - JWT - [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). - that are allowed to access. A JWT containing any of these audiences - will be accepted. When this setting is absent, only JWTs with - audience "https://Service_name/API_name" will be accepted. For - example, if no audiences are in the setting, LibraryService API will - only accept JWTs with the following audience - "https://library-example.googleapis.com/google.example.library.v1.LibraryService". - Example: audiences: bookstore_android.apps.googleusercontent.com, - bookstore_web.apps.googleusercontent.com - providerId: + The number of elements of a field collected into a batch which, if + exceeded, causes the batch to be sent. + type: integer + format: int32 + requestByteThreshold: + description: >- + The aggregated size of the batched field which, if exceeded, causes + the batch to be sent. This size is computed by aggregating the sizes + of the request field to be batched, not of the entire request + message. type: string + format: int64 + delayThreshold: description: >- - id from authentication provider. Example: provider_id: - bookstore_auth - DeleteConnectionRequest: - properties: - consumerNetwork: + The duration after which a batch should be sent, starting from the + addition of the first message to that batch. + type: string + format: google-duration + elementCountLimit: description: >- - Required. The network that the consumer is using to connect with - services. Must be in the form of - projects/{project}/global/networks/{network} {project} is a project - number, as in '12345' {network} is a network name. + The maximum number of elements collected in a batch that could be + accepted by server. + type: integer + format: int32 + requestByteLimit: + description: The maximum size of the request that could be accepted by server. + type: integer + format: int32 + flowControlElementLimit: + description: The maximum number of elements allowed by flow control. + type: integer + format: int32 + flowControlByteLimit: + description: The maximum size of data allowed by flow control. + type: integer + format: int32 + flowControlLimitExceededBehavior: + description: The behavior to take when the flow control limit is exceeded. type: string + enumDescriptions: + - Default behavior, system-defined. + - Stop operation, raise error. + - Pause operation until limit clears. + - Continue operation, disregard limit. + enum: + - UNSET_BEHAVIOR + - THROW_EXCEPTION + - BLOCK + - IGNORE + BatchingDescriptorProto: + id: BatchingDescriptorProto description: >- - Request to delete a private service access connection. The call will - fail if there are any managed service instances using this connection. - type: object - id: DeleteConnectionRequest - Control: + `BatchingDescriptorProto` specifies the fields of the request message to + be used for batching, and, optionally, the fields of the response + message to be used for demultiplexing. type: object - description: >- - Selects and configures the service controller used by the service. - Example: control: environment: servicecontrol.googleapis.com properties: - environment: + batchedField: + description: >- + The repeated field in the request message to be aggregated by + batching. type: string + discriminatorFields: description: >- - The service controller environment to use. If empty, no control - plane feature (like quota and billing) will be enabled. The - recommended value for most services is servicecontrol.googleapis.com - methodPolicies: - description: Defines policies applying to the API methods of the service. + A list of the fields in the request message. Two requests will be + batched together only if the values of every field specified in + `request_discriminator_fields` is equal between the two requests. type: array items: - $ref: '#/components/schemas/MethodPolicy' - id: Control - LongRunning: + type: string + subresponseField: + description: >- + Optional. When present, indicates the field in the response message + to be used to demultiplex the response into multiple response + messages, in correspondence with the multiple request messages + originally batched together. + type: string + ClientLibrarySettings: + id: ClientLibrarySettings + description: Details about how and where to publish client libraries. + type: object properties: - initialPollDelay: + version: description: >- - Initial delay after which the first poll request will be made. - Default value: 5 seconds. - format: google-duration + Version of the API to apply these settings to. This is the full + protobuf package for the API, ending in the version element. + Examples: "google.cloud.speech.v1" and + "google.spanner.admin.database.v1". type: string - maxPollDelay: + launchStage: + description: Launch stage of this version of the API. + type: string + enumDescriptions: + - Do not use this default value. + - The feature is not yet implemented. Users can not use it. + - >- + Prelaunch features are hidden from users and are only visible + internally. + - >- + Early Access features are limited to a closed group of testers. To + use these features, you must sign up in advance and sign a Trusted + Tester agreement (which includes confidentiality provisions). + These features may be unstable, changed in backward-incompatible + ways, and are not guaranteed to be released. + - >- + Alpha is a limited availability test for releases before they are + cleared for widespread use. By Alpha, all significant design + issues are resolved and we are in the process of verifying + functionality. Alpha customers need to apply for access, agree to + applicable terms, and have their projects allowlisted. Alpha + releases don't have to be feature complete, no SLAs are provided, + and there are no technical support obligations, but they will be + far enough along that customers can actually use them in test + environments or for limited-use tests -- just like they would in + normal production cases. + - >- + Beta is the point at which we are ready to open a release for any + customer to use. There are no SLA or technical support obligations + in a Beta release. Products will be complete from a feature + perspective, but may have some open outstanding issues. Beta + releases are suitable for limited production use cases. + - >- + GA features are open to all developers and are considered stable + and fully qualified for production use. + - >- + Deprecated features are scheduled to be shut down and removed. For + more information, see the "Deprecation Policy" section of our + [Terms of Service](https://cloud.google.com/terms/) and the + [Google Cloud Platform Subject to the Deprecation + Policy](https://cloud.google.com/terms/deprecation) documentation. + enum: + - LAUNCH_STAGE_UNSPECIFIED + - UNIMPLEMENTED + - PRELAUNCH + - EARLY_ACCESS + - ALPHA + - BETA + - GA + - DEPRECATED + restNumericEnums: description: >- - Maximum time between two subsequent poll requests. Default value: 45 - seconds. + When using transport=rest, the client request will encode enums as + numbers rather than strings. + type: boolean + javaSettings: + description: Settings for legacy Java features, supported in the Service YAML. + $ref: '#/components/schemas/JavaSettings' + cppSettings: + description: Settings for C++ client libraries. + $ref: '#/components/schemas/CppSettings' + phpSettings: + description: Settings for PHP client libraries. + $ref: '#/components/schemas/PhpSettings' + pythonSettings: + description: Settings for Python client libraries. + $ref: '#/components/schemas/PythonSettings' + nodeSettings: + description: Settings for Node client libraries. + $ref: '#/components/schemas/NodeSettings' + dotnetSettings: + description: Settings for .NET client libraries. + $ref: '#/components/schemas/DotnetSettings' + rubySettings: + description: Settings for Ruby client libraries. + $ref: '#/components/schemas/RubySettings' + goSettings: + description: Settings for Go client libraries. + $ref: '#/components/schemas/GoSettings' + JavaSettings: + id: JavaSettings + description: Settings for Java client libraries. + type: object + properties: + libraryPackage: + description: >- + The package name to use in Java. Clobbers the java_package option + set in the protobuf. This should be used **only** by APIs who have + already set the language_settings.java.package_name" field in + gapic.yaml. API teams should use the protobuf java_package option + where possible. Example of a YAML configuration:: publishing: + library_settings: java_settings: library_package: + com.google.cloud.pubsub.v1 type: string - format: google-duration - pollDelayMultiplier: + serviceClassNames: + description: >- + Configure the Java class name to use instead of the service's for + its corresponding generated GAPIC client. Keys are fully-qualified + service names as they appear in the protobuf (including the full the + language_settings.java.interface_names" field in gapic.yaml. API + teams should otherwise use the service name as it appears in the + protobuf. Example of a YAML configuration:: publishing: + java_settings: service_class_names: - google.pubsub.v1.Publisher: + TopicAdmin - google.pubsub.v1.Subscriber: SubscriptionAdmin + type: object + additionalProperties: + type: string + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' + CommonLanguageSettings: + id: CommonLanguageSettings + description: Required information for every language. + type: object + properties: + referenceDocsUri: + description: >- + Link to automatically generated reference documentation. Example: + https://cloud.google.com/nodejs/docs/reference/asset/latest + deprecated: true + type: string + destinations: + description: >- + The destination where API teams want this client library to be + published. + type: array + items: + type: string + enumDescriptions: + - >- + Client libraries will neither be generated nor published to + package managers. + - >- + Generate the client library in a repo under + github.com/googleapis, but don't publish it to package managers. + - >- + Publish the library to package managers like nuget.org and + npmjs.com. + enum: + - CLIENT_LIBRARY_DESTINATION_UNSPECIFIED + - GITHUB + - PACKAGE_MANAGER + selectiveGapicGeneration: description: >- - Multiplier to gradually increase delay between subsequent polls - until it reaches max_poll_delay. Default value: 1.5. - type: number - format: float - totalPollTimeout: - description: 'Total polling timeout. Default value: 5 minutes.' - format: google-duration - type: string + Configuration for which RPCs should be generated in the GAPIC + client. + $ref: '#/components/schemas/SelectiveGapicGeneration' + SelectiveGapicGeneration: + id: SelectiveGapicGeneration description: >- - Describes settings to use when generating API methods that use the - long-running operation pattern. All default values below are from those - used in the client library generators (e.g. - [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)). - id: LongRunning + This message is used to configure the generation of a subset of the RPCs + in a service for client libraries. type: object - ListDnsZonesResponse: - description: >- - Represents all DNS zones in the shared producer host project and the - matching peering zones in the consumer project. properties: - dnsZonePairs: + methods: + description: >- + An allowlist of the fully qualified names of RPCs that should be + included on public client surfaces. type: array items: - $ref: '#/components/schemas/DnsZonePair' - description: >- - All pairs of private DNS zones in the shared producer host project - and the matching peering zones in the consumer project.. + type: string + generateOmittedAsInternal: + description: >- + Setting this to true indicates to the client generators that methods + that would be excluded from the generation should instead be + generated in a way that indicates these methods should not be + consumed by end users. How this is expressed is up to individual + language implementations to decide. Some examples may be: added + annotations, obfuscated identifiers, or other language idiomatic + patterns. + type: boolean + CppSettings: + id: CppSettings + description: Settings for C++ client libraries. type: object - id: ListDnsZonesResponse - PartialDeleteConnectionMetadata: - id: PartialDeleteConnectionMetadata + properties: + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' + PhpSettings: + id: PhpSettings + description: Settings for Php client libraries. type: object - properties: {} - description: >- - Metadata provided through GetOperation request for the LRO generated by - Partial Delete Connection API - Option: properties: - value: - type: object + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' + libraryPackage: description: >- - The option's value packed in an Any message. If the value is a - primitive, the corresponding wrapper type defined in - google/protobuf/wrappers.proto should be used. If the value is an - enum, it should be stored as an int32 value using the - google.protobuf.Int32Value type. - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - name: + The package name to use in Php. Clobbers the php_namespace option + set in the protobuf. This should be used **only** by APIs who have + already set the language_settings.php.package_name" field in + gapic.yaml. API teams should use the protobuf php_namespace option + where possible. Example of a YAML configuration:: publishing: + library_settings: php_settings: library_package: + Google\Cloud\PubSub\V1 type: string - description: >- - The option's name. For protobuf built-in options (options defined in - descriptor.proto), this is the short name. For example, - `"map_entry"`. For custom options, it should be the fully-qualified - name. For example, `"google.api.http"`. - id: Option - description: >- - A protocol buffer option, which can be attached to a message, field, - enumeration, etc. - type: object PythonSettings: + id: PythonSettings + description: Settings for Python client libraries. + type: object properties: common: - $ref: '#/components/schemas/CommonLanguageSettings' description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' experimentalFeatures: - $ref: '#/components/schemas/ExperimentalFeatures' description: >- Experimental features to be included during client library generation. - description: Settings for Python client libraries. - type: object - id: PythonSettings - RemoveDnsZoneMetadata: - type: object + $ref: '#/components/schemas/ExperimentalFeatures' + ExperimentalFeatures: + id: ExperimentalFeatures description: >- - Metadata provided through GetOperation request for the LRO generated by - RemoveDnsZone API - properties: {} - id: RemoveDnsZoneMetadata - ValidateConsumerConfigResponse: - id: ValidateConsumerConfigResponse + Experimental features to be included during client library generation. + These fields will be deprecated once the feature graduates and is + enabled by default. type: object properties: - validationError: - enum: - - VALIDATION_ERROR_UNSPECIFIED - - VALIDATION_NOT_REQUESTED - - SERVICE_NETWORKING_NOT_ENABLED - - NETWORK_NOT_FOUND - - NETWORK_NOT_PEERED - - NETWORK_PEERING_DELETED - - NETWORK_NOT_IN_CONSUMERS_PROJECT - - NETWORK_NOT_IN_CONSUMERS_HOST_PROJECT - - HOST_PROJECT_NOT_FOUND - - CONSUMER_PROJECT_NOT_SERVICE_PROJECT - - RANGES_EXHAUSTED - - RANGES_NOT_RESERVED - - RANGES_DELETED_LATER - - COMPUTE_API_NOT_ENABLED - - USE_PERMISSION_NOT_FOUND - description: The first validation which failed. - type: string - enumDescriptions: - - '' - - In case none of the validations are requested. - - '' - - The network provided by the consumer does not exist. - - The network has not been peered with the producer org. - - The peering was created and later deleted. - - >- - The network is a regular VPC but the network is not in the - consumer's project. - - >- - The consumer project is a service project, and network is a shared - VPC, but the network is not in the host project of this consumer - project. - - >- - The host project associated with the consumer project was not - found. - - >- - The consumer project is not a service project for the specified - host project. - - >- - The reserved IP ranges do not have enough space to create a subnet - of desired size. - - The IP ranges were not reserved. - - The IP ranges were reserved but deleted later. - - The consumer project does not have the compute api enabled. - - >- - The consumer project does not have the permission from the host - project. - isValid: + restAsyncIoEnabled: + description: >- + Enables generation of asynchronous REST clients if `rest` transport + is enabled. By default, asynchronous REST clients will not be + generated. This feature will be enabled by default 1 month after + launching the feature in preview packages. type: boolean - description: Indicates whether all the requested validations passed. - existingSubnetworkCandidates: + protobufPythonicTypesEnabled: + description: >- + Enables generation of protobuf code using new types that are more + Pythonic which are included in `protobuf>=5.29.x`. This feature will + be enabled by default 1 month after launching the feature in preview + packages. + type: boolean + unversionedPackageDisabled: + description: >- + Disables generation of an unversioned Python package for this client + library. This means that the module names will need to be versioned + in import statements. For example `import google.cloud.library_v2` + instead of `import google.cloud.library`. + type: boolean + NodeSettings: + id: NodeSettings + description: Settings for Node client libraries. + type: object + properties: + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' + DotnetSettings: + id: DotnetSettings + description: Settings for Dotnet client libraries. + type: object + properties: + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' + renamedServices: + description: >- + Map from original service names to renamed versions. This is used + when the default generated types would cause a naming conflict. + (Neither name is fully-qualified.) Example: Subscriber to + SubscriberServiceApi. + type: object + additionalProperties: + type: string + renamedResources: + description: >- + Map from full resource types to the effective short name for the + resource. This is used when otherwise resource named from different + services would cause naming collisions. Example entry: + "datalabeling.googleapis.com/Dataset": "DataLabelingDataset" + type: object + additionalProperties: + type: string + ignoredResources: + description: >- + List of full resource types to ignore during generation. This is + typically used for API-specific Location resources, which should be + handled by the generator as if they were actually the common + Location resources. Example entry: + "documentai.googleapis.com/Location" + type: array items: - $ref: '#/components/schemas/Subnetwork' + type: string + forcedNamespaceAliases: description: >- - List of subnetwork candidates from the request which exist with the - `ip_cidr_range`, `secondary_ip_cider_ranges`, and - `outside_allocation` fields set. + Namespaces which must be aliased in snippets due to a known (but + non-generator-predictable) naming collision type: array - Route: + items: + type: string + handwrittenSignatures: + description: >- + Method signatures (in the form "service.method(signature)") which + are provided separately, so shouldn't be generated. Snippets + *calling* these methods are still generated, however. + type: array + items: + type: string + RubySettings: + id: RubySettings + description: Settings for Ruby client libraries. + type: object + properties: + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' + GoSettings: + id: GoSettings + description: Settings for Go client libraries. + type: object + properties: + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' + renamedServices: + description: >- + Map of service names to renamed services. Keys are the package + relative service names and values are the name to be used for the + service client and call options. Example: publishing: go_settings: + renamed_services: Publisher: TopicAdmin + type: object + additionalProperties: + type: string + Aspect: + id: Aspect description: >- - Represents a route that was created or discovered by a private access - management service. + Aspect represents Generic aspect. It is used to configure an aspect + without making direct changes to service.proto type: object properties: - network: - description: >- - Fully-qualified URL of the VPC network in the producer host tenant - project that this route applies to. For example: - `projects/123456/global/networks/host-network` - type: string - destRange: - type: string - description: Destination CIDR range that this route applies to. - name: - type: string - description: Route name. See https://cloud.google.com/vpc/docs/routes - nextHopGateway: + kind: + description: The type of this aspect configuration. type: string + spec: description: >- - Fully-qualified URL of the gateway that should handle matching - packets that this route applies to. For example: - `projects/123456/global/gateways/default-internet-gateway` - id: Route - Connection: - id: Connection - type: object + Content of the configuration. The underlying schema should be + defined by Aspect owners as protobuf message under + `google/api/configaspects/proto`. + type: object + additionalProperties: + type: any + description: Properties of the object. + GoogleCloudServicenetworkingV1betaConnection: + id: GoogleCloudServicenetworkingV1betaConnection description: >- Represents a private connection resource. A private connection is implemented as a VPC Network Peering connection between a service producer's VPC network and a service consumer's VPC network. + type: object properties: - peering: - type: string - readOnly: true - description: >- - Output only. The name of the VPC Network Peering connection that was - created by the service producer. network: description: >- The name of service consumer's VPC network that's connected with @@ -4096,89 +4196,216 @@ components: consumer's VPC network. `{network}` is the name of the service consumer's VPC network. type: string + reservedPeeringRanges: + description: >- + The name of one or more allocated IP address ranges for this service + producer of type `PEERING`. Note that invoking this method with a + different range when connection is already established will not + modify already provisioned service producer subnetworks. + type: array + items: + type: string + peering: + description: >- + Output only. The name of the VPC Network Peering connection that was + created by the service producer. + type: string service: description: >- Output only. The name of the peering service that's associated with this connection, in the following format: `services/{service name}`. type: string - readOnly: true - reservedPeeringRanges: + GoogleCloudServicenetworkingV1betaSubnetwork: + id: GoogleCloudServicenetworkingV1betaSubnetwork + description: >- + Represents a subnet that was created or discovered by a private access + management service. + type: object + properties: + name: + description: Subnetwork name. See https://cloud.google.com/compute/docs/vpc/ + type: string + ipCidrRange: + description: Subnetwork CIDR range in `10.x.x.x/y` format. + type: string + network: description: >- - The name of one or more allocated IP address ranges for this service - producer of type `PEERING`. Note that invoking CreateConnection - method with a different range when connection is already established - will not modify already provisioned service producer subnetworks. If - CreateConnection method is invoked repeatedly to reconnect when - peering connection had been disconnected on the consumer side, - leaving this field empty will restore previously allocated IP - ranges. - items: - type: string - type: array - Logging: + In the Shared VPC host project, the VPC network that's peered with + the consumer network. For example: + `projects/1234321/global/networks/host-network` + type: string + outsideAllocation: + description: >- + This is a discovered subnet that is not within the current consumer + allocated ranges. + type: boolean + Range: + id: Range + description: Represents a found unused range. type: object + properties: + ipCidrRange: + description: >- + CIDR range in "10.x.x.x/y" format that is within the allocated + ranges and currently unused. + type: string + network: + description: >- + In the Shared VPC host project, the VPC network that's peered with + the consumer network. For example: + `projects/1234321/global/networks/host-network` + type: string + Route: + id: Route description: >- - Logging configuration of the service. The following example shows how to - configure logs to be sent to the producer and consumer projects. In the - example, the `activity_history` log is sent to both the producer and - consumer projects, whereas the `purchase_history` log is only sent to - the producer project. monitored_resources: - type: - library.googleapis.com/branch labels: - key: /city description: The city - where the library branch is located in. - key: /name description: The - name of the branch. logs: - name: activity_history labels: - key: - /customer_id - name: purchase_history logging: producer_destinations: - - monitored_resource: library.googleapis.com/branch logs: - - activity_history - purchase_history consumer_destinations: - - monitored_resource: library.googleapis.com/branch logs: - - activity_history + Represents a route that was created or discovered by a private access + management service. + type: object properties: - producerDestinations: - type: array + name: + description: Route name. See https://cloud.google.com/vpc/docs/routes + type: string + network: description: >- - Logging configurations for sending logs to the producer project. - There can be multiple producer destinations, each one must have a - different monitored resource type. A log can be used in at most one - producer destination. - items: - $ref: '#/components/schemas/LoggingDestination' - consumerDestinations: + Fully-qualified URL of the VPC network in the producer host tenant + project that this route applies to. For example: + `projects/123456/global/networks/host-network` + type: string + destRange: + description: Destination CIDR range that this route applies to. + type: string + nextHopGateway: description: >- - Logging configurations for sending logs to the consumer project. - There can be multiple consumer destinations, each one must have a - different monitored resource type. A log can be used in at most one - consumer destination. + Fully-qualified URL of the gateway that should handle matching + packets that this route applies to. For example: + `projects/123456/global/gateways/default-internet-gateway` + type: string + AddRolesResponse: + id: AddRolesResponse + description: Represents IAM roles added to the shared VPC host project. + type: object + properties: + policyBinding: + description: >- + Required. List of policy bindings that were added to the shared VPC + host project. type: array items: - $ref: '#/components/schemas/LoggingDestination' - id: Logging + $ref: '#/components/schemas/PolicyBinding' + AddRolesMetadata: + id: AddRolesMetadata + description: >- + Metadata provided through GetOperation request for the LRO generated by + AddRoles API + type: object + properties: {} + AddDnsZoneResponse: + id: AddDnsZoneResponse + description: >- + Represents managed DNS zones created in the shared producer host and + consumer projects. + type: object + properties: + producerPrivateZone: + description: The private DNS zone created in the shared producer host project. + $ref: '#/components/schemas/DnsZone' + consumerPeeringZone: + description: The DNS peering zone created in the consumer project. + $ref: '#/components/schemas/DnsZone' + AddDnsZoneMetadata: + id: AddDnsZoneMetadata + description: >- + Metadata provided through GetOperation request for the LRO generated by + AddDnsZone API + type: object + properties: {} + RemoveDnsZoneResponse: + id: RemoveDnsZoneResponse + description: Blank message response type for RemoveDnsZone API + type: object + properties: {} + RemoveDnsZoneMetadata: + id: RemoveDnsZoneMetadata + description: >- + Metadata provided through GetOperation request for the LRO generated by + RemoveDnsZone API + type: object + properties: {} + AddDnsRecordSetMetadata: + id: AddDnsRecordSetMetadata + description: >- + Metadata provided through GetOperation request for the LRO generated by + AddDnsRecordSet API + type: object + properties: {} + RemoveDnsRecordSetResponse: + id: RemoveDnsRecordSetResponse + description: Blank message response type for RemoveDnsRecordSet API + type: object + properties: {} + RemoveDnsRecordSetMetadata: + id: RemoveDnsRecordSetMetadata + description: >- + Metadata provided through GetOperation request for the LRO generated by + RemoveDnsRecordSet API + type: object + properties: {} + UpdateDnsRecordSetMetadata: + id: UpdateDnsRecordSetMetadata + description: >- + Metadata provided through GetOperation request for the LRO generated by + UpdateDnsRecordSet API + type: object + properties: {} + PeeredDnsDomainMetadata: + id: PeeredDnsDomainMetadata + description: >- + Metadata provided through GetOperation request for the LRO generated by + CreatePeeredDnsDomain API. + type: object + properties: {} + DeletePeeredDnsDomainMetadata: + id: DeletePeeredDnsDomainMetadata + description: >- + Metadata provided through GetOperation request for the LRO generated by + DeletePeeredDnsDomain API. + type: object + properties: {} + ConsumerConfigMetadata: + id: ConsumerConfigMetadata + description: >- + Metadata provided through GetOperation request for the LRO generated by + UpdateConsumerConfig API. + type: object + properties: {} + DeleteConnectionMetadata: + id: DeleteConnectionMetadata + description: >- + Metadata provided through GetOperation request for the LRO generated by + Delete Connection API + type: object + properties: {} + PartialDeleteConnectionMetadata: + id: PartialDeleteConnectionMetadata + description: >- + Metadata provided through GetOperation request for the LRO generated by + Partial Delete Connection API + type: object + properties: {} + CleanupConnectionMetadata: + id: CleanupConnectionMetadata + description: >- + Metadata provided through GetOperation request for the LRO generated by + Cleanup Connection API + type: object + properties: {} parameters: - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - type: string access_token: description: OAuth access token. in: query name: access_token schema: type: string - _.xgafv: - description: V1 error format. - in: query - name: $.xgafv - schema: - type: string - enum: - - '1' - - '2' - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string alt: description: Data format for response. in: query @@ -4189,10 +4416,16 @@ components: - json - media - proto - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + callback: + description: JSONP in: query - name: upload_protocol + 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: @@ -4204,6 +4437,18 @@ components: 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 @@ -4213,232 +4458,121 @@ components: name: quotaUser schema: type: string - callback: - description: JSONP + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: callback + name: upload_protocol schema: type: string - oauth_token: - description: OAuth 2.0 token for the current user. + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: oauth_token + name: uploadType schema: type: string - prettyPrint: - description: Returns response with indentations and line breaks. + _.xgafv: + description: V1 error format. in: query - name: prettyPrint + name: $.xgafv schema: - type: boolean + type: string + enum: + - '1' + - '2' x-stackQL-resources: - networks_consumer_config: - id: google.servicenetworking.networks_consumer_config - name: networks_consumer_config - title: Networks_consumer_config + operations: + id: google.servicenetworking.operations + name: operations + title: Operations methods: - update_consumer_config: + list: operation: - $ref: >- - #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}:updateConsumerConfig/patch + $ref: '#/paths/~1v1~1operations/get' response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: - - $ref: >- - #/components/x-stackQL-resources/networks_consumer_config/methods/update_consumer_config - replace: [] - delete: [] - networks: - id: google.servicenetworking.networks - name: networks - title: Networks - methods: + objectKey: $.operations get: operation: - $ref: >- - #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/networks/methods/get' - insert: [] - update: [] - replace: [] - delete: [] - networks_vpc_service_controls: - id: google.servicenetworking.networks_vpc_service_controls - name: networks_vpc_service_controls - title: Networks_vpc_service_controls - methods: - get_vpc_service_controls: - operation: - $ref: >- - #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}~1vpcServiceControls/get - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/networks_vpc_service_controls/methods/get_vpc_service_controls - insert: [] - update: [] - replace: [] - delete: [] - peered_dns_domains: - id: google.servicenetworking.peered_dns_domains - name: peered_dns_domains - title: Peered_dns_domains - methods: - list: - operation: - $ref: >- - #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}~1peeredDnsDomains/get + $ref: '#/paths/~1v1~1operations~1{operationsId}/get' response: mediaType: application/json openAPIDocKey: '200' - create: + delete: operation: - $ref: >- - #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}~1peeredDnsDomains/post + $ref: '#/paths/~1v1~1operations~1{operationsId}/delete' response: mediaType: application/json openAPIDocKey: '200' - delete: + cancel: operation: - $ref: >- - #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}~1peeredDnsDomains~1{peeredDnsDomainsId}/delete + $ref: '#/paths/~1v1~1operations~1{operationsId}:cancel/post' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/peered_dns_domains/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/peered_dns_domains/methods/create' + - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' + insert: [] update: [] replace: [] delete: - - $ref: '#/components/x-stackQL-resources/peered_dns_domains/methods/delete' - dns_zones: - id: google.servicenetworking.dns_zones - name: dns_zones - title: Dns_zones + - $ref: '#/components/x-stackQL-resources/operations/methods/delete' + services: + id: google.servicenetworking.services + name: services + title: Services methods: - get: + disable_vpc_service_controls: operation: $ref: >- - #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}~1dnsZones~1{dnsZonesId}/get + #/paths/~1v1~1services~1{servicesId}:disableVpcServiceControls/patch response: mediaType: application/json openAPIDocKey: '200' - list: + enable_vpc_service_controls: operation: $ref: >- - #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}~1dnsZones:list/get - response: - mediaType: application/json - openAPIDocKey: '200' - remove: - operation: - $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsZones:remove/post' - response: - mediaType: application/json - openAPIDocKey: '200' - add: - operation: - $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsZones:add/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/dns_zones/methods/get' - - $ref: '#/components/x-stackQL-resources/dns_zones/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/dns_zones/methods/add' - update: [] - replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/dns_zones/methods/remove' - dns_record_sets: - id: google.servicenetworking.dns_record_sets - name: dns_record_sets - title: Dns_record_sets - methods: - remove: - operation: - $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsRecordSets:remove/post' - response: - mediaType: application/json - openAPIDocKey: '200' - list: - operation: - $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsRecordSets:list/get' - response: - mediaType: application/json - openAPIDocKey: '200' - add: - operation: - $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsRecordSets:add/post' + #/paths/~1v1~1services~1{servicesId}:enableVpcServiceControls/patch response: mediaType: application/json openAPIDocKey: '200' - update: + search_range: operation: - $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsRecordSets:update/post' + $ref: '#/paths/~1v1~1services~1{servicesId}:searchRange/post' response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/dns_record_sets/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/dns_record_sets/methods/add' - update: - - $ref: '#/components/x-stackQL-resources/dns_record_sets/methods/update' - replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/dns_record_sets/methods/remove' - dns_record_set: - id: google.servicenetworking.dns_record_set - name: dns_record_set - title: Dns_record_set - methods: - get: + validate: operation: - $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsRecordSets:get/get' + $ref: '#/paths/~1v1~1services~1{servicesId}:validate/post' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/dns_record_set/methods/get' + select: [] insert: [] update: [] - replace: [] - delete: [] - roles: - id: google.servicenetworking.roles - name: roles - title: Roles + replace: [] + delete: [] + services_subnetwork: + id: google.servicenetworking.services_subnetwork + name: services_subnetwork + title: Services_subnetwork methods: - add: + add_subnetwork: operation: - $ref: '#/paths/~1v1~1services~1{servicesId}~1roles:add/post' + $ref: >- + #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}:addSubnetwork/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: [] insert: - - $ref: '#/components/x-stackQL-resources/roles/methods/add' + - $ref: >- + #/components/x-stackQL-resources/services_subnetwork/methods/add_subnetwork update: [] replace: [] delete: [] @@ -4495,127 +4629,273 @@ components: delete: - $ref: >- #/components/x-stackQL-resources/connections_connection/methods/delete_connection - services: - id: google.servicenetworking.services - name: services - title: Services + networks_vpc_service_controls: + id: google.servicenetworking.networks_vpc_service_controls + name: networks_vpc_service_controls + title: Networks_vpc_service_controls methods: - enable_vpc_service_controls: + get_vpc_service_controls: operation: $ref: >- - #/paths/~1v1~1services~1{servicesId}:enableVpcServiceControls/patch + #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}~1vpcServiceControls/get response: mediaType: application/json openAPIDocKey: '200' - search_range: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/networks_vpc_service_controls/methods/get_vpc_service_controls + insert: [] + update: [] + replace: [] + delete: [] + networks_consumer_config: + id: google.servicenetworking.networks_consumer_config + name: networks_consumer_config + title: Networks_consumer_config + methods: + update_consumer_config: operation: - $ref: '#/paths/~1v1~1services~1{servicesId}:searchRange/post' + $ref: >- + #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}:updateConsumerConfig/patch response: mediaType: application/json openAPIDocKey: '200' - disable_vpc_service_controls: + sqlVerbs: + select: [] + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/networks_consumer_config/methods/update_consumer_config + replace: [] + delete: [] + networks: + id: google.servicenetworking.networks + name: networks + title: Networks + methods: + get: operation: $ref: >- - #/paths/~1v1~1services~1{servicesId}:disableVpcServiceControls/patch + #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}/get response: mediaType: application/json openAPIDocKey: '200' - validate: + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/networks/methods/get' + insert: [] + update: [] + replace: [] + delete: [] + dns_zones: + id: google.servicenetworking.dns_zones + name: dns_zones + title: Dns_zones + methods: + list: operation: - $ref: '#/paths/~1v1~1services~1{servicesId}:validate/post' + $ref: >- + #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}~1dnsZones:list/get + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}~1dnsZones~1{dnsZonesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + add: + operation: + $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsZones:add/post' + response: + mediaType: application/json + openAPIDocKey: '200' + remove: + operation: + $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsZones:remove/post' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] - insert: [] + select: + - $ref: '#/components/x-stackQL-resources/dns_zones/methods/get' + - $ref: '#/components/x-stackQL-resources/dns_zones/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/dns_zones/methods/add' update: [] replace: [] - delete: [] - services_subnetwork: - id: google.servicenetworking.services_subnetwork - name: services_subnetwork - title: Services_subnetwork + delete: + - $ref: '#/components/x-stackQL-resources/dns_zones/methods/remove' + peered_dns_domains: + id: google.servicenetworking.peered_dns_domains + name: peered_dns_domains + title: Peered_dns_domains methods: - add_subnetwork: + create: operation: $ref: >- - #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}:addSubnetwork/post + #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}~1peeredDnsDomains/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}~1peeredDnsDomains/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}~1peeredDnsDomains~1{peeredDnsDomainsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/peered_dns_domains/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/peered_dns_domains/methods/create' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/peered_dns_domains/methods/delete' + roles: + id: google.servicenetworking.roles + name: roles + title: Roles + methods: + add: + operation: + $ref: '#/paths/~1v1~1services~1{servicesId}~1roles:add/post' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: [] insert: - - $ref: >- - #/components/x-stackQL-resources/services_subnetwork/methods/add_subnetwork + - $ref: '#/components/x-stackQL-resources/roles/methods/add' update: [] replace: [] delete: [] - operations: - id: google.servicenetworking.operations - name: operations - title: Operations + dns_record_sets: + id: google.servicenetworking.dns_record_sets + name: dns_record_sets + title: Dns_record_sets methods: - get: + add: operation: - $ref: '#/paths/~1v1~1operations~1{operationsId}/get' + $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsRecordSets:add/post' response: mediaType: application/json openAPIDocKey: '200' - delete: + remove: operation: - $ref: '#/paths/~1v1~1operations~1{operationsId}/delete' + $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsRecordSets:remove/post' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsRecordSets:update/post' response: mediaType: application/json openAPIDocKey: '200' list: operation: - $ref: '#/paths/~1v1~1operations/get' + $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsRecordSets:list/get' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.operations - cancel: + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/dns_record_sets/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/dns_record_sets/methods/add' + update: + - $ref: '#/components/x-stackQL-resources/dns_record_sets/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/dns_record_sets/methods/remove' + dns_record_set: + id: google.servicenetworking.dns_record_set + name: dns_record_set + title: Dns_record_set + methods: + get: operation: - $ref: '#/paths/~1v1~1operations~1{operationsId}:cancel/post' + $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsRecordSets:get/get' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' + - $ref: '#/components/x-stackQL-resources/dns_record_set/methods/get' insert: [] update: [] replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' + delete: [] paths: - /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}:updateConsumerConfig: + /v1/operations: parameters: &ref_1 - - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - patch: + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: servicenetworking.operations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/service.management + Oauth2c: + - https://www.googleapis.com/auth/service.management + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListOperationsResponse' + parameters: + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/operations/{operationsId}: + parameters: *ref_1 + get: description: >- - Service producers use this method to update the configuration of their - connection including the import/export of custom routes and subnetwork - routes with public IP. - operationId: servicenetworking.services.projects.global.networks.updateConsumerConfig - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/UpdateConsumerConfigRequest' + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: servicenetworking.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4634,28 +4914,17 @@ paths: $ref: '#/components/schemas/Operation' parameters: - in: path - name: servicesId - required: true - schema: - type: string - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: networksId + name: operationsId required: true schema: type: string - /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}: - parameters: *ref_1 - get: + delete: description: >- - Service producers use this method to get the configuration of their - connection including the import/export of custom routes and subnetwork - routes with public IP. - operationId: servicenetworking.services.projects.global.networks.get + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: servicenetworking.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4671,35 +4940,32 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ConsumerConfig' + $ref: '#/components/schemas/Empty' parameters: - in: path - name: servicesId - required: true - schema: - type: string - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: networksId + name: operationsId required: true schema: type: string - - in: query - name: includeUsedIpRanges - schema: - type: boolean - /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}/vpcServiceControls: + /v1/operations/{operationsId}:cancel: parameters: *ref_1 - get: + post: description: >- - Consumers use this method to find out the state of VPC Service Controls. - The controls could be enabled or disabled for a connection. - operationId: >- - servicenetworking.services.projects.global.networks.getVpcServiceControls + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + `1`, corresponding to `Code.CANCELLED`. + operationId: servicenetworking.operations.cancel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CancelOperationRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4715,29 +4981,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/VpcServiceControls' + $ref: '#/components/schemas/Empty' parameters: - in: path - name: servicesId - required: true - schema: - type: string - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: networksId + name: operationsId required: true schema: type: string - /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}/peeredDnsDomains: + /v1/services/{servicesId}:disableVpcServiceControls: parameters: *ref_1 - get: - description: Lists peered DNS domains for a connection. - operationId: >- - servicenetworking.services.projects.global.networks.peeredDnsDomains.list + patch: + description: Disables VPC service controls for a connection. + operationId: servicenetworking.services.disableVpcServiceControls + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DisableVpcServiceControlsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4753,35 +5013,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListPeeredDnsDomainsResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: servicesId required: true schema: type: string - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: networksId - required: true - schema: - type: string - post: - description: >- - Creates a peered DNS domain which sends requests for records in given - namespace originating in the service producer VPC network to the - consumer VPC network to be resolved. - operationId: >- - servicenetworking.services.projects.global.networks.peeredDnsDomains.create + /v1/services/{servicesId}:enableVpcServiceControls: + parameters: *ref_1 + patch: + description: Enables VPC service controls for a connection. + operationId: servicenetworking.services.enableVpcServiceControls requestBody: content: application/json: schema: - $ref: '#/components/schemas/PeeredDnsDomain' + $ref: '#/components/schemas/EnableVpcServiceControlsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4804,22 +5052,24 @@ paths: required: true schema: type: string - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: networksId - required: true - schema: - type: string - /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}/peeredDnsDomains/{peeredDnsDomainsId}: + /v1/services/{servicesId}/{servicesId1}/{servicesId2}:addSubnetwork: parameters: *ref_1 - delete: - description: Deletes a peered DNS domain. - operationId: >- - servicenetworking.services.projects.global.networks.peeredDnsDomains.delete + post: + description: >- + For service producers, provisions a new subnet in a peered service's + shared VPC network in the requested region and with the requested size + that's expressed as a CIDR range (number of leading bits of ipV4 network + mask). The method checks against the assigned allocated ranges to find a + non-conflicting IP address range. The method will reuse a subnet if + subsequent calls contain the same subnet name, region, and prefix + length. This method will make producer's tenant project to be a shared + VPC service project as needed. + operationId: servicenetworking.services.addSubnetwork + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddSubnetworkRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4843,28 +5093,31 @@ paths: schema: type: string - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: networksId + name: servicesId1 required: true schema: type: string - in: path - name: peeredDnsDomainsId + name: servicesId2 required: true schema: type: string - /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}/dnsZones/{dnsZonesId}: + /v1/services/{servicesId}:searchRange: parameters: *ref_1 - get: + post: description: >- - Service producers can use this method to retrieve a DNS zone in the - shared producer host project and the matching peering zones in consumer - project - operationId: servicenetworking.services.projects.global.networks.dnsZones.get + Service producers can use this method to find a currently unused range + within consumer allocated ranges. This returned range is not reserved, + and not guaranteed to remain unused. It will validate previously + provided allocated ranges, find non-conflicting sub-range of requested + size (expressed in number of leading bits of ipv4 network mask, as in + CIDR range notation). + operationId: servicenetworking.services.searchRange + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SearchRangeRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4880,36 +5133,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GetDnsZoneResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: servicesId required: true schema: type: string - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: networksId - required: true - schema: - type: string - - in: path - name: dnsZonesId - required: true - schema: - type: string - /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}/dnsZones:list: + /v1/services/{servicesId}:validate: parameters: *ref_1 - get: + post: description: >- - * Service producers can use this method to retrieve a list of available - DNS zones in the shared producer host project and the matching peering - zones in the consumer project. * - operationId: servicenetworking.services.projects.global.networks.dnsZones.list + Service producers use this method to validate if the consumer provided + network, project and requested range are valid. This allows them to use + a fail-fast mechanism for consumer requests, and not have to wait for + AddSubnetwork operation completion to determine if user request is + invalid. + operationId: servicenetworking.services.validate + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ValidateConsumerConfigRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4925,35 +5170,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListDnsZonesResponse' + $ref: '#/components/schemas/ValidateConsumerConfigResponse' parameters: - in: path name: servicesId required: true schema: type: string - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: networksId - required: true - schema: - type: string - /v1/services/{servicesId}/dnsRecordSets:remove: + /v1/services/{servicesId}/connections: parameters: *ref_1 - post: + get: description: >- - Service producers can use this method to remove DNS record sets from - private DNS zones in the shared producer host project. - operationId: servicenetworking.services.dnsRecordSets.remove - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RemoveDnsRecordSetRequest' + List the private connections that are configured in a service consumer's + VPC network. + operationId: servicenetworking.services.connections.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4969,21 +5199,32 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/ListConnectionsResponse' parameters: - in: path name: servicesId required: true schema: type: string - /v1/services/{servicesId}/dnsRecordSets:get: - parameters: *ref_1 - get: + - in: query + name: network + schema: + type: string + post: description: >- - Producers can use this method to retrieve information about the DNS - record set added to the private zone inside the shared tenant host - project associated with a consumer network. - operationId: servicenetworking.services.dnsRecordSets.get + Creates a private connection that establishes a VPC Network Peering + connection to a VPC network in the service producer's organization. The + administrator of the service consumer's VPC network invokes this method. + The administrator must assign one or more allocated IP ranges for + provisioning subnetworks in the service producer's VPC network. This + connection is used for all supported services in the service producer's + organization, so it only needs to be invoked once. + operationId: servicenetworking.services.connections.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Connection' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4999,37 +5240,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DnsRecordSet' + $ref: '#/components/schemas/Operation' parameters: - in: path name: servicesId required: true schema: type: string - - in: query - name: domain - schema: - type: string - - in: query - name: consumerNetwork - schema: - type: string - - in: query - name: zone - schema: - type: string - - in: query - name: type - schema: - type: string - /v1/services/{servicesId}/dnsRecordSets:list: + /v1/services/{servicesId}/connections/{connectionsId}: parameters: *ref_1 - get: - description: >- - Producers can use this method to retrieve a list of available DNS - RecordSets available inside the private zone on the tenant host project - accessible from their network. - operationId: servicenetworking.services.dnsRecordSets.list + post: + description: Deletes a private service access connection. + operationId: servicenetworking.services.connections.deleteConnection + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteConnectionRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5045,33 +5272,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListDnsRecordSetsResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: servicesId required: true schema: type: string - - in: query - name: zone - schema: - type: string - - in: query - name: consumerNetwork + - in: path + name: connectionsId + required: true schema: type: string - /v1/services/{servicesId}/dnsRecordSets:add: - parameters: *ref_1 - post: - description: >- - Service producers can use this method to add DNS record sets to private - DNS zones in the shared producer host project. - operationId: servicenetworking.services.dnsRecordSets.add + patch: + description: Updates the allocated ranges that are assigned to a connection. + operationId: servicenetworking.services.connections.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/AddDnsRecordSetRequest' + $ref: '#/components/schemas/Connection' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5094,18 +5314,28 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/dnsRecordSets:update: + - in: path + name: connectionsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: force + schema: + type: boolean + /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}/vpcServiceControls: parameters: *ref_1 - post: + get: description: >- - Service producers can use this method to update DNS record sets from - private DNS zones in the shared producer host project. - operationId: servicenetworking.services.dnsRecordSets.update - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/UpdateDnsRecordSetRequest' + Consumers use this method to find out the state of VPC Service Controls. + The controls could be enabled or disabled for a connection. + operationId: >- + servicenetworking.services.projects.global.networks.getVpcServiceControls security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5121,27 +5351,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/VpcServiceControls' parameters: - in: path name: servicesId required: true schema: type: string - /v1/services/{servicesId}/roles:add: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: networksId + required: true + schema: + type: string + /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}:updateConsumerConfig: parameters: *ref_1 - post: + patch: description: >- - Service producers can use this method to add roles in the shared VPC - host project. Each role is bound to the provided member. Each role must - be selected from within an allowlisted set of roles. Each role is - applied at only the granularity specified in the allowlist. - operationId: servicenetworking.services.roles.add + Service producers use this method to update the configuration of their + connection including the import/export of custom routes and subnetwork + routes with public IP. + operationId: servicenetworking.services.projects.global.networks.updateConsumerConfig requestBody: content: application/json: schema: - $ref: '#/components/schemas/AddRolesRequest' + $ref: '#/components/schemas/UpdateConsumerConfigRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5164,19 +5403,24 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/dnsZones:remove: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: networksId + required: true + schema: + type: string + /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}: parameters: *ref_1 - post: + get: description: >- - Service producers can use this method to remove private DNS zones in the - shared producer host project and matching peering zones in the consumer - project. - operationId: servicenetworking.services.dnsZones.remove - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RemoveDnsZoneRequest' + Service producers use this method to get the configuration of their + connection including the import/export of custom routes and subnetwork + routes with public IP. + operationId: servicenetworking.services.projects.global.networks.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5192,26 +5436,35 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/ConsumerConfig' parameters: - in: path name: servicesId required: true schema: type: string - /v1/services/{servicesId}/dnsZones:add: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: networksId + required: true + schema: + type: string + - in: query + name: includeUsedIpRanges + schema: + type: boolean + /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}/dnsZones:list: parameters: *ref_1 - post: + get: description: >- - Service producers can use this method to add private DNS zones in the - shared producer host project and matching peering zones in the consumer - project. - operationId: servicenetworking.services.dnsZones.add - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AddDnsZoneRequest' + * Service producers can use this method to retrieve a list of available + DNS zones in the shared producer host project and the matching peering + zones in the consumer project. * + operationId: servicenetworking.services.projects.global.networks.dnsZones.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5227,20 +5480,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/ListDnsZonesResponse' parameters: - in: path name: servicesId required: true schema: type: string - /v1/services/{servicesId}/connections: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: networksId + required: true + schema: + type: string + /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}/dnsZones/{dnsZonesId}: parameters: *ref_1 get: description: >- - List the private connections that are configured in a service consumer's - VPC network. - operationId: servicenetworking.services.connections.list + Service producers can use this method to retrieve a DNS zone in the + shared producer host project and the matching peering zones in consumer + project + operationId: servicenetworking.services.projects.global.networks.dnsZones.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5256,32 +5520,42 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListConnectionsResponse' + $ref: '#/components/schemas/GetDnsZoneResponse' parameters: - in: path name: servicesId required: true schema: type: string - - in: query - name: network + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: networksId + required: true + schema: + type: string + - in: path + name: dnsZonesId + required: true schema: type: string + /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}/peeredDnsDomains: + parameters: *ref_1 post: description: >- - Creates a private connection that establishes a VPC Network Peering - connection to a VPC network in the service producer's organization. The - administrator of the service consumer's VPC network invokes this method. - The administrator must assign one or more allocated IP ranges for - provisioning subnetworks in the service producer's VPC network. This - connection is used for all supported services in the service producer's - organization, so it only needs to be invoked once. - operationId: servicenetworking.services.connections.create + Creates a peered DNS domain which sends requests for records in given + namespace originating in the service producer VPC network to the + consumer VPC network to be resolved. + operationId: >- + servicenetworking.services.projects.global.networks.peeredDnsDomains.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/Connection' + $ref: '#/components/schemas/PeeredDnsDomain' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5304,16 +5578,20 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/connections/{connectionsId}: - parameters: *ref_1 - patch: - description: Updates the allocated ranges that are assigned to a connection. - operationId: servicenetworking.services.connections.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Connection' + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: networksId + required: true + schema: + type: string + get: + description: Lists peered DNS domains for a connection. + operationId: >- + servicenetworking.services.projects.global.networks.peeredDnsDomains.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5329,7 +5607,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/ListPeeredDnsDomainsResponse' parameters: - in: path name: servicesId @@ -5337,27 +5615,21 @@ paths: schema: type: string - in: path - name: connectionsId + name: projectsId required: true schema: type: string - - in: query - name: force - schema: - type: boolean - - in: query - name: updateMask + - in: path + name: networksId + required: true schema: type: string - format: google-fieldmask - post: - description: Deletes a private service access connection. - operationId: servicenetworking.services.connections.deleteConnection - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DeleteConnectionRequest' + /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}/peeredDnsDomains/{peeredDnsDomainsId}: + parameters: *ref_1 + delete: + description: Deletes a peered DNS domain. + operationId: >- + servicenetworking.services.projects.global.networks.peeredDnsDomains.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5381,20 +5653,34 @@ paths: schema: type: string - in: path - name: connectionsId + name: projectsId required: true schema: type: string - /v1/services/{servicesId}:enableVpcServiceControls: + - in: path + name: networksId + required: true + schema: + type: string + - in: path + name: peeredDnsDomainsId + required: true + schema: + type: string + /v1/services/{servicesId}/roles:add: parameters: *ref_1 - patch: - description: Enables VPC service controls for a connection. - operationId: servicenetworking.services.enableVpcServiceControls + post: + description: >- + Service producers can use this method to add roles in the shared VPC + host project. Each role is bound to the provided member. Each role must + be selected from within an allowlisted set of roles. Each role is + applied at only the granularity specified in the allowlist. + operationId: servicenetworking.services.roles.add requestBody: content: application/json: schema: - $ref: '#/components/schemas/EnableVpcServiceControlsRequest' + $ref: '#/components/schemas/AddRolesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5417,22 +5703,19 @@ paths: required: true schema: type: string - /v1/services/{servicesId}:searchRange: + /v1/services/{servicesId}/dnsZones:add: parameters: *ref_1 post: description: >- - Service producers can use this method to find a currently unused range - within consumer allocated ranges. This returned range is not reserved, - and not guaranteed to remain unused. It will validate previously - provided allocated ranges, find non-conflicting sub-range of requested - size (expressed in number of leading bits of ipv4 network mask, as in - CIDR range notation). - operationId: servicenetworking.services.searchRange + Service producers can use this method to add private DNS zones in the + shared producer host project and matching peering zones in the consumer + project. + operationId: servicenetworking.services.dnsZones.add requestBody: content: application/json: schema: - $ref: '#/components/schemas/SearchRangeRequest' + $ref: '#/components/schemas/AddDnsZoneRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5455,24 +5738,19 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/{servicesId1}/{servicesId2}:addSubnetwork: + /v1/services/{servicesId}/dnsZones:remove: parameters: *ref_1 post: description: >- - For service producers, provisions a new subnet in a peered service's - shared VPC network in the requested region and with the requested size - that's expressed as a CIDR range (number of leading bits of ipV4 network - mask). The method checks against the assigned allocated ranges to find a - non-conflicting IP address range. The method will reuse a subnet if - subsequent calls contain the same subnet name, region, and prefix - length. This method will make producer's tenant project to be a shared - VPC service project as needed. - operationId: servicenetworking.services.addSubnetwork + Service producers can use this method to remove private DNS zones in the + shared producer host project and matching peering zones in the consumer + project. + operationId: servicenetworking.services.dnsZones.remove requestBody: content: application/json: schema: - $ref: '#/components/schemas/AddSubnetworkRequest' + $ref: '#/components/schemas/RemoveDnsZoneRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5495,26 +5773,18 @@ paths: required: true schema: type: string - - in: path - name: servicesId1 - required: true - schema: - type: string - - in: path - name: servicesId2 - required: true - schema: - type: string - /v1/services/{servicesId}:disableVpcServiceControls: + /v1/services/{servicesId}/dnsRecordSets:add: parameters: *ref_1 - patch: - description: Disables VPC service controls for a connection. - operationId: servicenetworking.services.disableVpcServiceControls + post: + description: >- + Service producers can use this method to add DNS record sets to private + DNS zones in the shared producer host project. + operationId: servicenetworking.services.dnsRecordSets.add requestBody: content: application/json: schema: - $ref: '#/components/schemas/DisableVpcServiceControlsRequest' + $ref: '#/components/schemas/AddDnsRecordSetRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5537,21 +5807,18 @@ paths: required: true schema: type: string - /v1/services/{servicesId}:validate: + /v1/services/{servicesId}/dnsRecordSets:remove: parameters: *ref_1 post: description: >- - Service producers use this method to validate if the consumer provided - network, project and requested range are valid. This allows them to use - a fail-fast mechanism for consumer requests, and not have to wait for - AddSubnetwork operation completion to determine if user request is - invalid. - operationId: servicenetworking.services.validate + Service producers can use this method to remove DNS record sets from + private DNS zones in the shared producer host project. + operationId: servicenetworking.services.dnsRecordSets.remove requestBody: content: application/json: schema: - $ref: '#/components/schemas/ValidateConsumerConfigRequest' + $ref: '#/components/schemas/RemoveDnsRecordSetRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5567,21 +5834,25 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ValidateConsumerConfigResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: servicesId required: true schema: type: string - /v1/operations/{operationsId}: + /v1/services/{servicesId}/dnsRecordSets:update: parameters: *ref_1 - get: + post: description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: servicenetworking.operations.get + Service producers can use this method to update DNS record sets from + private DNS zones in the shared producer host project. + operationId: servicenetworking.services.dnsRecordSets.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateDnsRecordSetRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5600,17 +5871,18 @@ paths: $ref: '#/components/schemas/Operation' parameters: - in: path - name: operationsId + name: servicesId required: true schema: type: string - delete: + /v1/services/{servicesId}/dnsRecordSets:get: + parameters: *ref_1 + get: description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: servicenetworking.operations.delete + Producers can use this method to retrieve information about the DNS + record set added to the private zone inside the shared tenant host + project associated with a consumer network. + operationId: servicenetworking.services.dnsRecordSets.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5626,69 +5898,37 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/DnsRecordSet' parameters: - in: path - name: operationsId + name: servicesId required: true schema: type: string - /v1/operations: - parameters: *ref_1 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: servicenetworking.operations.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/service.management - Oauth2c: - - https://www.googleapis.com/auth/service.management - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/ListOperationsResponse' - parameters: - in: query - name: filter + name: consumerNetwork schema: type: string - in: query - name: pageToken + name: zone schema: type: string - in: query - name: pageSize + name: domain schema: - type: integer - format: int32 - /v1/operations/{operationsId}:cancel: + type: string + - in: query + name: type + schema: + type: string + /v1/services/{servicesId}/dnsRecordSets:list: parameters: *ref_1 - post: + get: description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: servicenetworking.operations.cancel - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CancelOperationRequest' + Producers can use this method to retrieve a list of available DNS + RecordSets available inside the private zone on the tenant host project + accessible from their network. + operationId: servicenetworking.services.dnsRecordSets.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5704,10 +5944,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/ListDnsRecordSetsResponse' parameters: - in: path - name: operationsId + name: servicesId required: true schema: type: string + - in: query + name: consumerNetwork + schema: + type: string + - in: query + name: zone + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/serviceusage.yaml b/providers/src/googleapis.com/v00.00.00000/services/serviceusage.yaml index 5ed7009e..31595e52 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/serviceusage.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/serviceusage.yaml @@ -10,8 +10,8 @@ info: Platform, lists the available or enabled services, or disables services that service consumers no longer use. version: v1 - x-discovery-doc-revision: '20241025' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250619' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/service-usage/ servers: @@ -25,13 +25,13 @@ components: implicit: authorizationUrl: https://accounts.google.com/o/oauth2/auth scopes: &ref_0 + https://www.googleapis.com/auth/service.management: Manage your Google API service configuration https://www.googleapis.com/auth/cloud-platform: >- See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. https://www.googleapis.com/auth/cloud-platform.read-only: >- View your data across Google Cloud services and see the email address of your Google Account - https://www.googleapis.com/auth/service.management: Manage your Google API service configuration Oauth2c: type: oauth2 description: Oauth 2.0 authorization code authentication @@ -41,730 +41,362 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - ClientLibrarySettings: + BatchEnableServicesResponse: + properties: + services: + items: + $ref: '#/components/schemas/GoogleApiServiceusageV1Service' + description: The new state of the services after enabling. + type: array + failures: + description: >- + If allow_partial_success is true, and one or more services could not + be enabled, this field contains the details about each failure. + type: array + items: + $ref: '#/components/schemas/EnableFailure' + description: >- + Response message for the `BatchEnableServices` method. This response + message is assigned to the `response` field of the returned Operation + when that operation is done. + id: BatchEnableServicesResponse type: object + GoogleApiServiceusageV1ServiceConfig: + id: GoogleApiServiceusageV1ServiceConfig + description: The configuration of the service. properties: - rubySettings: - $ref: '#/components/schemas/RubySettings' - description: Settings for Ruby client libraries. - launchStage: - enum: - - LAUNCH_STAGE_UNSPECIFIED - - UNIMPLEMENTED - - PRELAUNCH - - EARLY_ACCESS - - ALPHA - - BETA - - GA - - DEPRECATED + quota: + description: Quota configuration. + $ref: '#/components/schemas/Quota' + name: + description: >- + The DNS address at which this service is available. An example DNS + address would be: `calendar.googleapis.com`. type: string - enumDescriptions: - - Do not use this default value. - - The feature is not yet implemented. Users can not use it. - - >- - Prelaunch features are hidden from users and are only visible - internally. - - >- - Early Access features are limited to a closed group of testers. To - use these features, you must sign up in advance and sign a Trusted - Tester agreement (which includes confidentiality provisions). - These features may be unstable, changed in backward-incompatible - ways, and are not guaranteed to be released. - - >- - Alpha is a limited availability test for releases before they are - cleared for widespread use. By Alpha, all significant design - issues are resolved and we are in the process of verifying - functionality. Alpha customers need to apply for access, agree to - applicable terms, and have their projects allowlisted. Alpha - releases don't have to be feature complete, no SLAs are provided, - and there are no technical support obligations, but they will be - far enough along that customers can actually use them in test - environments or for limited-use tests -- just like they would in - normal production cases. - - >- - Beta is the point at which we are ready to open a release for any - customer to use. There are no SLA or technical support obligations - in a Beta release. Products will be complete from a feature - perspective, but may have some open outstanding issues. Beta - releases are suitable for limited production use cases. - - >- - GA features are open to all developers and are considered stable - and fully qualified for production use. - - >- - Deprecated features are scheduled to be shut down and removed. For - more information, see the "Deprecation Policy" section of our - [Terms of Service](https://cloud.google.com/terms/) and the - [Google Cloud Platform Subject to the Deprecation - Policy](https://cloud.google.com/terms/deprecation) documentation. - description: Launch stage of this version of the API. - phpSettings: - $ref: '#/components/schemas/PhpSettings' - description: Settings for PHP client libraries. - cppSettings: - $ref: '#/components/schemas/CppSettings' - description: Settings for C++ client libraries. - version: + usage: + $ref: '#/components/schemas/Usage' + description: Configuration controlling usage of this service. + title: + description: The product title for this service. type: string + authentication: + description: Auth configuration. Contains only the OAuth rules. + $ref: '#/components/schemas/Authentication' + apis: + items: + $ref: '#/components/schemas/Api' description: >- - Version of the API to apply these settings to. This is the full - protobuf package for the API, ending in the version element. - Examples: "google.cloud.speech.v1" and - "google.spanner.admin.database.v1". - pythonSettings: - $ref: '#/components/schemas/PythonSettings' - description: Settings for Python client libraries. - nodeSettings: - description: Settings for Node client libraries. - $ref: '#/components/schemas/NodeSettings' - goSettings: - description: Settings for Go client libraries. - $ref: '#/components/schemas/GoSettings' - dotnetSettings: - $ref: '#/components/schemas/DotnetSettings' - description: Settings for .NET client libraries. - restNumericEnums: - description: >- - When using transport=rest, the client request will encode enums as - numbers rather than strings. - type: boolean - javaSettings: - $ref: '#/components/schemas/JavaSettings' - description: Settings for legacy Java features, supported in the Service YAML. - description: Details about how and where to publish client libraries. - id: ClientLibrarySettings - ConsumerPolicy: - description: >- - Consumer Policy is a set of rules that define what services or service - groups can be used for a cloud resource hierarchy. - properties: - annotations: + A list of API interfaces exported by this service. Contains only the + names, versions, and method names of the interfaces. + type: array + endpoints: + items: + $ref: '#/components/schemas/Endpoint' description: >- - Optional. Annotations is an unstructured key-value map stored with a - policy that may be set by external tools to store and retrieve - arbitrary metadata. They are not queryable and should be preserved - when modifying objects. - [AIP-128](https://google.aip.dev/128#annotations) - additionalProperties: - type: string - type: object - enableRules: - description: Enable rules define usable services and service groups. + Configuration for network endpoints. Contains only the names and + aliases of the endpoints. type: array + monitoredResources: items: - $ref: '#/components/schemas/EnableRule' - etag: + $ref: '#/components/schemas/MonitoredResourceDescriptor' + type: array description: >- - An opaque tag indicating the current version of the policy, used for - concurrency control. - type: string - name: - readOnly: true + Defines the monitored resources used by this service. This is + required by the Service.monitoring and Service.logging + configurations. + monitoring: + $ref: '#/components/schemas/Monitoring' description: >- - Output only. The resource name of the policy. We only allow consumer - policy name as `default` for now: - `projects/12345/consumerPolicies/default`, - `folders/12345/consumerPolicies/default`, - `organizations/12345/consumerPolicies/default`. - type: string - updateTime: - type: string - format: google-datetime - description: The last-modified time. - id: ConsumerPolicy + Monitoring configuration. This should not include the + 'producer_destinations' field. + documentation: + description: >- + Additional API documentation. Contains only the summary and the + documentation URL. + $ref: '#/components/schemas/Documentation' type: object - ExperimentalFeatures: - id: ExperimentalFeatures - description: >- - Experimental features to be included during client library generation. - These fields will be deprecated once the feature graduates and is - enabled by default. + RemoveEnableRulesMetadata: + id: RemoveEnableRulesMetadata + properties: {} + description: Metadata for the `RemoveEnableRules` method. type: object + Publishing: + description: >- + This message configures the settings for publishing [Google Cloud Client + libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) + generated from the service config. properties: - restAsyncIoEnabled: - type: boolean + codeownerGithubTeams: description: >- - Enables generation of asynchronous REST clients if `rest` transport - is enabled. By default, asynchronous REST clients will not be - generated. This feature will be enabled by default 1 month after - launching the feature in preview packages. - Endpoint: - id: Endpoint - type: object - properties: - name: + GitHub teams to be added to CODEOWNERS in the directory in GitHub + containing source code for the client libraries for this API. + items: + type: string + type: array + documentationUri: + description: >- + Link to product home page. Example: + https://cloud.google.com/asset-inventory/docs/overview type: string - description: The canonical name of this endpoint. - aliases: + restReferenceDocumentationUri: description: >- - Aliases for this endpoint, these will be served by the same UrlMap - as the parent endpoint, and will be provisioned in the GCP stack for - the Regional Endpoints. + Optional link to REST reference documentation. Example: + https://cloud.google.com/pubsub/lite/docs/reference/rest + type: string + librarySettings: + items: + $ref: '#/components/schemas/ClientLibrarySettings' type: array + description: >- + Client library settings. If the same version string appears multiple + times in this list, then the last one wins. Settings from earlier + settings with the same version string are discarded. + methodSettings: items: - type: string - target: + $ref: '#/components/schemas/MethodSettings' description: >- - The specification of an Internet routable address of API frontend - that will handle requests to this [API - Endpoint](https://cloud.google.com/apis/design/glossary). It should - be either a valid IPv4 address or a fully-qualified domain name. For - example, "8.8.8.8" or "myservice.appspot.com". + A list of API method settings, e.g. the behavior for methods that + use the long-running operation pattern. + type: array + docTagPrefix: type: string - allowCors: - type: boolean description: >- - Allowing - [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), - aka cross-domain traffic, would allow the backends served from this - endpoint to receive and respond to HTTP OPTIONS requests. The - response will be used by the browser to determine whether the - subsequent cross-origin request is allowed to proceed. - description: >- - `Endpoint` describes a network address of a service that serves a set of - APIs. It is commonly known as a service endpoint. A service may expose - any number of service endpoints, and all service endpoints share the - same service definition, such as quota limits and monitoring metrics. - Example: type: google.api.Service name: library-example.googleapis.com - endpoints: # Declares network address - `https://library-example.googleapis.com` # for service - `library-example.googleapis.com`. The `https` scheme # is implicit for - all service endpoints. Other schemes may be # supported in the future. - - name: library-example.googleapis.com allow_cors: false - name: - content-staging-library-example.googleapis.com # Allows HTTP OPTIONS - calls to be passed to the API frontend, for it # to decide whether the - subsequent cross-origin request is allowed # to proceed. allow_cors: - true - AuthRequirement: - type: object - id: AuthRequirement - properties: - providerId: + A prefix used in sample code when demarking regions to be included + in documentation. + protoReferenceDocumentationUri: + type: string description: >- - id from authentication provider. Example: provider_id: - bookstore_auth + Optional link to proto reference documentation. Example: + https://cloud.google.com/pubsub/lite/docs/reference/rpc + apiShortName: + description: >- + Used as a tracking tag when collecting data about the APIs developer + relations artifacts like docs, packages delivered to package + managers, etc. Example: "speech". type: string - audiences: + newIssueUri: description: >- - NOTE: This will be deprecated soon, once AuthProvider.audiences is - implemented and accepted in all the runtime components. The list of - JWT - [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). - that are allowed to access. A JWT containing any of these audiences - will be accepted. When this setting is absent, only JWTs with - audience "https://Service_name/API_name" will be accepted. For - example, if no audiences are in the setting, LibraryService API will - only accept JWTs with the following audience - "https://library-example.googleapis.com/google.example.library.v1.LibraryService". - Example: audiences: bookstore_android.apps.googleusercontent.com, - bookstore_web.apps.googleusercontent.com + Link to a *public* URI where users can report issues. Example: + https://issuetracker.google.com/issues/new?component=190865&template=1161103 type: string - description: >- - User-defined authentication requirements, including support for [JSON - Web Token - (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). - EnumValue: - description: Enum value definition. - properties: - options: - description: Protocol buffer options. - items: - $ref: '#/components/schemas/Option' - type: array - number: - format: int32 - description: Enum value number. - type: integer - name: + githubLabel: type: string - description: Enum value name. - id: EnumValue + description: >- + GitHub label to apply to issues and pull requests opened for this + API. + organization: + enum: + - CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED + - CLOUD + - ADS + - PHOTOS + - STREET_VIEW + - SHOPPING + - GEO + - GENERATIVE_AI + description: For whom the client library is being published. + type: string + enumDescriptions: + - Not useful. + - Google Cloud Platform Org. + - Ads (Advertising) Org. + - Photos Org. + - Street View Org. + - Shopping Org. + - Geo Org. + - Generative AI - https://developers.generativeai.google + id: Publishing type: object - ImportConsumerOverridesMetadata: + Usage: type: object - properties: {} - id: ImportConsumerOverridesMetadata - description: >- - Metadata message that provides information such as progress, partial - failures, and similar information on each GetOperation call of LRO - returned by ImportConsumerOverrides. - SystemParameters: + id: Usage + description: Configuration controlling usage of a service. properties: rules: - type: array items: - $ref: '#/components/schemas/SystemParameterRule' + $ref: '#/components/schemas/UsageRule' description: >- - Define system parameters. The parameters defined here will override - the default parameters implemented by the system. If this field is - missing from the service config, default system parameters will be - used. Default system parameters and names is - implementation-dependent. Example: define api key for all methods - system_parameters rules: - selector: "*" parameters: - name: api_key - url_query_parameter: api_key Example: define 2 api key names for a - specific method. system_parameters rules: - selector: "/ListShelves" - parameters: - name: api_key http_header: Api-Key1 - name: api_key - http_header: Api-Key2 **NOTE:** All service configuration rules - follow "last one wins" order. - type: object - description: >- - ### System parameter configuration A system parameter is a special kind - of parameter defined by the API system, not by an individual API. It is - typically mapped to an HTTP header and/or a URL query parameter. This - configuration specifies which methods change the names of the system - parameters. - id: SystemParameters - BatchEnableServicesResponse: - id: BatchEnableServicesResponse - description: >- - Response message for the `BatchEnableServices` method. This response - message is assigned to the `response` field of the returned Operation - when that operation is done. - type: object - properties: - failures: + A list of usage rules that apply to individual API methods. + **NOTE:** All service configuration rules follow "last one wins" + order. type: array + producerNotificationChannel: + type: string description: >- - If allow_partial_success is true, and one or more services could not - be enabled, this field contains the details about each failure. - items: - $ref: '#/components/schemas/EnableFailure' - services: - type: array - items: - $ref: '#/components/schemas/GoogleApiServiceusageV1Service' - description: The new state of the services after enabling. - HttpRule: - id: HttpRule - properties: - additionalBindings: + The full resource name of a channel used for sending notifications + to the service producer. Google Service Management currently only + supports [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as + a notification channel. To use Google Cloud Pub/Sub as the channel, + this must be the name of a Cloud Pub/Sub topic that uses the Cloud + Pub/Sub topic name format documented in + https://cloud.google.com/pubsub/docs/overview. + requirements: type: array description: >- - Additional HTTP bindings for the selector. Nested bindings must not - contain an `additional_bindings` field themselves (that is, the - nesting may only be one level deep). + Requirements that must be satisfied before a consumer project can + use the service. Each requirement is of the form /; for example + 'serviceusage.googleapis.com/billing-enabled'. For Google APIs, a + Terms of Service requirement must be included here. Google Cloud + APIs must include "serviceusage.googleapis.com/tos/cloud". Other + Google APIs should include + "serviceusage.googleapis.com/tos/universal". Additional ToS can be + included based on the business needs. items: - $ref: '#/components/schemas/HttpRule' - delete: + type: string + DisableServiceRequest: + type: object + id: DisableServiceRequest + properties: + checkIfServiceHasUsage: + enum: + - CHECK_IF_SERVICE_HAS_USAGE_UNSPECIFIED + - SKIP + - CHECK + enumDescriptions: + - When unset, the default behavior is used, which is SKIP. + - If set, skip checking service usage when disabling a service. + - >- + If set, service usage is checked when disabling the service. If a + service, or its dependents, has usage in the last 30 days, the + request returns a FAILED_PRECONDITION error. type: string - description: Maps to HTTP DELETE. Used for deleting a resource. - body: description: >- - The name of the request field whose value is mapped to the HTTP - request body, or `*` for mapping all request fields not captured by - the path pattern to the HTTP body, or omitted for not having any - HTTP request body. NOTE: the referred field must be present at the - top-level of the request message type. + Defines the behavior for checking service usage when disabling a + service. + disableDependentServices: + description: >- + Indicates if services that are enabled and which depend on this + service should also be disabled. If not set, an error will be + generated if any enabled services depend on the service to be + disabled. When set, the service, and any enabled services that + depend on it, will be disabled together. + type: boolean + description: Request message for the `DisableService` method. + ImportAdminQuotaPoliciesMetadata: + description: >- + Metadata message that provides information such as progress, partial + failures, and similar information on each GetOperation call of LRO + returned by ImportAdminQuotaPolicies. + type: object + id: ImportAdminQuotaPoliciesMetadata + properties: {} + BatchingSettingsProto: + properties: + delayThreshold: + format: google-duration type: string - custom: - $ref: '#/components/schemas/CustomHttpPattern' description: >- - The custom pattern is used for specifying an HTTP method that is not - included in the `pattern` field, such as HEAD, or "*" to leave the - HTTP method unspecified for this rule. The wild-card rule is useful - for services that provide content to Web (HTML) clients. - get: + The duration after which a batch should be sent, starting from the + addition of the first message to that batch. + elementCountThreshold: description: >- - Maps to HTTP GET. Used for listing and getting information about - resources. - type: string - patch: + The number of elements of a field collected into a batch which, if + exceeded, causes the batch to be sent. + format: int32 + type: integer + requestByteLimit: + description: The maximum size of the request that could be accepted by server. + type: integer + format: int32 + requestByteThreshold: type: string - description: Maps to HTTP PATCH. Used for updating a resource. - selector: + format: int64 description: >- - Selects a method to which this rule applies. Refer to selector for - syntax details. - type: string - put: - type: string - description: Maps to HTTP PUT. Used for replacing a resource. - post: + The aggregated size of the batched field which, if exceeded, causes + the batch to be sent. This size is computed by aggregating the sizes + of the request field to be batched, not of the entire request + message. + flowControlByteLimit: + format: int32 + type: integer + description: The maximum size of data allowed by flow control. + flowControlElementLimit: + type: integer + format: int32 + description: The maximum number of elements allowed by flow control. + flowControlLimitExceededBehavior: + enum: + - UNSET_BEHAVIOR + - THROW_EXCEPTION + - BLOCK + - IGNORE type: string + enumDescriptions: + - Default behavior, system-defined. + - Stop operation, raise error. + - Pause operation until limit clears. + - Continue operation, disregard limit. + description: The behavior to take when the flow control limit is exceeded. + elementCountLimit: + format: int32 description: >- - Maps to HTTP POST. Used for creating a resource or performing an - action. - responseBody: - description: >- - Optional. The name of the response field whose value is mapped to - the HTTP response body. When omitted, the entire response message - will be used as the HTTP response body. NOTE: The referred field - must be present at the top-level of the response message type. - type: string - type: object + The maximum number of elements collected in a batch that could be + accepted by server. + type: integer description: >- - gRPC Transcoding gRPC Transcoding is a feature for mapping between a - gRPC method and one or more HTTP REST endpoints. It allows developers to - build a single API service that supports both gRPC APIs and REST APIs. - Many systems, including [Google - APIs](https://github.com/googleapis/googleapis), [Cloud - Endpoints](https://cloud.google.com/endpoints), [gRPC - Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and - [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature - and use it for large scale production services. `HttpRule` defines the - schema of the gRPC/REST mapping. The mapping specifies how different - portions of the gRPC request message are mapped to the URL path, URL - query parameters, and HTTP request body. It also controls how the gRPC - response message is mapped to the HTTP response body. `HttpRule` is - typically specified as an `google.api.http` annotation on the gRPC - method. Each mapping specifies a URL path template and an HTTP method. - The path template may refer to one or more fields in the gRPC request - message, as long as each field is a non-repeated field with a primitive - (non-message) type. The path template controls how fields of the request - message are mapped to the URL path. Example: service Messaging { rpc - GetMessage(GetMessageRequest) returns (Message) { option - (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message - GetMessageRequest { string name = 1; // Mapped to URL path. } message - Message { string text = 1; // The resource content. } This enables an - HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - - gRPC: `GetMessage(name: "messages/123456")` Any fields in the request - message which are not bound by the path template automatically become - HTTP query parameters if there is no HTTP request body. For example: - service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) - { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } - message GetMessageRequest { message SubMessage { string subfield = 1; } - string message_id = 1; // Mapped to URL path. int64 revision = 2; // - Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped - to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC - mapping as below: - HTTP: `GET - /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: - `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: - "foo"))` Note that fields which are mapped to URL query parameters must - have a primitive type or a repeated primitive type or a non-repeated - message type. In the case of a repeated type, the parameter can be - repeated in the URL as `...?param=A¶m=B`. In the case of a message - type, each field of the message is mapped to a separate parameter, such - as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request - body, the `body` field specifies the mapping. Consider a REST update - method on the message resource collection: service Messaging { rpc - UpdateMessage(UpdateMessageRequest) returns (Message) { option - (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" - }; } } message UpdateMessageRequest { string message_id = 1; // mapped - to the URL Message message = 2; // mapped to the body } The following - HTTP JSON to RPC mapping is enabled, where the representation of the - JSON in the request body is determined by protos JSON encoding: - HTTP: - `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: - `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The - special name `*` can be used in the body mapping to define that every - field not bound by the path template should be mapped to the request - body. This enables the following alternative definition of the update - method: service Messaging { rpc UpdateMessage(Message) returns (Message) - { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: - "*" }; } } message Message { string message_id = 1; string text = 2; } - The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH - /v1/messages/123456 { "text": "Hi!" }` - gRPC: - `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using - `*` in the body mapping, it is not possible to have HTTP parameters, as - all fields not bound by the path end in the body. This makes this option - more rarely used in practice when defining REST APIs. The common usage - of `*` is in custom methods which don't use the URL at all for - transferring data. It is possible to define multiple HTTP methods for - one RPC by using the `additional_bindings` option. Example: service - Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option - (google.api.http) = { get: "/v1/messages/{message_id}" - additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } - }; } } message GetMessageRequest { string message_id = 1; string user_id - = 2; } This enables the following two alternative HTTP JSON to RPC - mappings: - HTTP: `GET /v1/messages/123456` - gRPC: - `GetMessage(message_id: "123456")` - HTTP: `GET - /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" - message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields - (recursive expansion nested messages in the request message) are - classified into three categories: - Fields referred by the path - template. They are passed via the URL path. - Fields referred by the - HttpRule.body. They are passed via the HTTP request body. - All other - fields are passed via the URL query parameters, and the parameter name - is the field path in the request message. A repeated field can be - represented as multiple query parameters under the same name. 2. If - HttpRule.body is "*", there is no URL query parameter, all fields are - passed via URL path and HTTP request body. 3. If HttpRule.body is - omitted, there is no HTTP request body, all fields are passed via URL - path and URL query parameters. Path template syntax Template = "/" - Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | - "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] - "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax - `*` matches a single URL path segment. The syntax `**` matches zero or - more URL path segments, which must be the last part of the URL path - except the `Verb`. The syntax `Variable` matches part of the URL path as - specified by its template. A variable template must not contain other - variables. If a variable matches a single path segment, its template may - be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax - `LITERAL` matches literal text in the URL path. If the `LITERAL` - contains any reserved character, such characters should be - percent-encoded before the matching. If a variable contains exactly one - path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is - expanded into a URL path on the client side, all characters except - `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse - decoding. Such variables show up in the [Discovery - Document](https://developers.google.com/discovery/v1/reference/apis) as - `{var}`. If a variable contains multiple path segments, such as - `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a - URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` - are percent-encoded. The server side does the reverse decoding, except - "%2F" and "%2f" are left unchanged. Such variables show up in the - [Discovery - Document](https://developers.google.com/discovery/v1/reference/apis) as - `{+var}`. Using gRPC API Service Configuration gRPC API Service - Configuration (service config) is a configuration language for - configuring a gRPC service to become a user-facing product. The service - config is simply the YAML representation of the `google.api.Service` - proto message. As an alternative to annotating your proto file, you can - configure gRPC transcoding in your service config YAML files. You do - this by specifying a `HttpRule` that maps the gRPC method to a REST - endpoint, achieving the same effect as the proto annotation. This can be - particularly useful if you have a proto that is reused in multiple - services. Note that any transcoding specified in the service config will - override any matching transcoding configuration in the proto. The - following example selects a gRPC method and applies an `HttpRule` to it: - http: rules: - selector: example.v1.Messaging.GetMessage get: - /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC - Transcoding is used to map a gRPC to JSON REST endpoints, the proto to - JSON conversion must follow the [proto3 - specification](https://developers.google.com/protocol-buffers/docs/proto3#json). - While the single segment variable follows the semantics of [RFC - 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String - Expansion, the multi segment variable **does not** follow RFC 6570 - Section 3.2.3 Reserved Expansion. The reason is that the Reserved - Expansion does not expand special characters like `?` and `#`, which - would lead to invalid URLs. As the result, gRPC Transcoding uses a - custom encoding for multi segment variables. The path variables **must - not** refer to any repeated or mapped field, because client libraries - are not capable of handling such variable expansion. The path variables - **must not** capture the leading "/" character. The reason is that the - most common use case "{var}" does not capture the leading "/" character. - For consistency, all path variables must share the same behavior. - Repeated message fields must not be mapped to URL query parameters, - because no client library can support such complicated mapping. If an - API needs to use a JSON array for request or response body, it can map - the request or response body to a repeated field. However, some gRPC - Transcoding implementations may not support this feature. - ServiceIdentity: + `BatchingSettingsProto` specifies a set of batching thresholds, each of + which acts as a trigger to send a batch of messages as a request. At + least one threshold must be positive nonzero. type: object + id: BatchingSettingsProto + MethodPolicy: properties: - email: - description: >- - The email address of the service account that a service producer - would use to access consumer resources. + requestPolicies: + items: + $ref: '#/components/schemas/FieldPolicy' + type: array + description: Policies that are applicable to the request message. + selector: type: string - uniqueId: description: >- - The unique and stable id of the service account. - https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts#ServiceAccount - type: string - description: >- - Service identity for a service. This is the identity that service - producer should use to access consumer resources. - id: ServiceIdentity - Option: + Selects a method to which these policies should be enforced, for + example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to + selector for syntax details. NOTE: This field must not be set in the + proto annotation. It will be automatically filled by the service + config compiler . + id: MethodPolicy + description: Defines policies applying to an RPC method. type: object + GoogleApiServiceusageV2betaEnableRule: + description: >- + The consumer policy rule that defines enabled services, groups, and + categories. properties: - name: - description: >- - The option's name. For protobuf built-in options (options defined in - descriptor.proto), this is the short name. For example, - `"map_entry"`. For custom options, it should be the fully-qualified - name. For example, `"google.api.http"`. - type: string - value: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any + services: + type: array + items: + type: string description: >- - The option's value packed in an Any message. If the value is a - primitive, the corresponding wrapper type defined in - google/protobuf/wrappers.proto should be used. If the value is an - enum, it should be stored as an int32 value using the - google.protobuf.Int32Value type. - type: object - id: Option - description: >- - A protocol buffer option, which can be attached to a message, field, - enumeration, etc. - GoogleApiServiceusageV2betaUpdateConsumerPolicyMetadata: - properties: {} - type: object - description: Metadata for the `UpdateConsumerPolicy` method. - id: GoogleApiServiceusageV2betaUpdateConsumerPolicyMetadata - CustomError: + The names of the services that are enabled. Example: + `services/storage.googleapis.com`. + id: GoogleApiServiceusageV2betaEnableRule type: object + AuthProvider: + id: AuthProvider properties: - rules: + jwtLocations: description: >- - The list of custom error rules that apply to individual API - messages. **NOTE:** All service configuration rules follow "last one - wins" order. + Defines the locations to extract the JWT. For now it is only used by + the Cloud Endpoints to store the OpenAPI extension + [x-google-jwt-locations] + (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) + JWT locations can be one of HTTP headers, URL query parameters or + cookies. The rule is that the first match wins. If not specified, + default to use following 3 locations: 1) Authorization: Bearer 2) + x-goog-iap-jwt-assertion 3) access_token query parameter Default + locations can be specified as followings: jwt_locations: - header: + Authorization value_prefix: "Bearer " - header: + x-goog-iap-jwt-assertion - query: access_token items: - $ref: '#/components/schemas/CustomErrorRule' + $ref: '#/components/schemas/JwtLocation' type: array - types: + id: description: >- - The list of custom error detail types, e.g. - 'google.foo.v1.CustomError'. - items: - type: string - type: array - description: >- - Customize service error responses. For example, list any service - specific protobuf types that can appear in error detail lists of error - responses. Example: custom_error: types: - google.foo.v1.CustomError - - google.foo.v1.AnotherError - id: CustomError - Method: - properties: - requestTypeUrl: - description: A URL of the input message type. - type: string - responseTypeUrl: - type: string - description: The URL of the output message type. - name: - description: The simple name of this method. - type: string - requestStreaming: - type: boolean - description: If true, the request is streamed. - options: - items: - $ref: '#/components/schemas/Option' - description: Any metadata attached to the method. - type: array - responseStreaming: - description: If true, the response is streamed. - type: boolean - syntax: - type: string - description: The source syntax of this method. - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS - enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. - description: Method represents a method of an API interface. - id: Method - type: object - AddEnableRulesResponse: - type: object - properties: - parent: - type: string - description: >- - The parent consumer policy. It can be - `projects/12345/consumerPolicies/default`, or - `folders/12345/consumerPolicies/default`, or - `organizations/12345/consumerPolicies/default`. - addedValues: - items: - type: string - type: array - description: The values added to the parent consumer policy. - description: The response message of `AddEnableRules` method. - id: AddEnableRulesResponse - MonitoredResourceDescriptor: - properties: - description: - description: >- - Optional. A detailed description of the monitored resource type that - might be used in documentation. - type: string - type: - description: >- - Required. The monitored resource type. For example, the type - `"cloudsql_database"` represents databases in Google Cloud SQL. For - a list of types, see [Monitored resource - types](https://cloud.google.com/monitoring/api/resources) and - [Logging resource - types](https://cloud.google.com/logging/docs/api/v2/resource-list). - type: string - displayName: - description: >- - Optional. A concise name for the monitored resource type that might - be displayed in user interfaces. It should be a Title Cased Noun - Phrase, without any article or other determiners. For example, - `"Google Cloud SQL Database"`. - type: string - name: - description: >- - Optional. The resource name of the monitored resource descriptor: - `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where - {type} is the value of the `type` field in this object and - {project_id} is a project ID that provides API-specific context for - accessing the type. APIs that do not use project information can use - the resource name format `"monitoredResourceDescriptors/{type}"`. - type: string - launchStage: + The unique identifier of the auth provider. It will be referred to + by `AuthRequirement.provider_id`. Example: "bookstore_auth". type: string - description: Optional. The launch stage of the monitored resource definition. - enum: - - LAUNCH_STAGE_UNSPECIFIED - - UNIMPLEMENTED - - PRELAUNCH - - EARLY_ACCESS - - ALPHA - - BETA - - GA - - DEPRECATED - enumDescriptions: - - Do not use this default value. - - The feature is not yet implemented. Users can not use it. - - >- - Prelaunch features are hidden from users and are only visible - internally. - - >- - Early Access features are limited to a closed group of testers. To - use these features, you must sign up in advance and sign a Trusted - Tester agreement (which includes confidentiality provisions). - These features may be unstable, changed in backward-incompatible - ways, and are not guaranteed to be released. - - >- - Alpha is a limited availability test for releases before they are - cleared for widespread use. By Alpha, all significant design - issues are resolved and we are in the process of verifying - functionality. Alpha customers need to apply for access, agree to - applicable terms, and have their projects allowlisted. Alpha - releases don't have to be feature complete, no SLAs are provided, - and there are no technical support obligations, but they will be - far enough along that customers can actually use them in test - environments or for limited-use tests -- just like they would in - normal production cases. - - >- - Beta is the point at which we are ready to open a release for any - customer to use. There are no SLA or technical support obligations - in a Beta release. Products will be complete from a feature - perspective, but may have some open outstanding issues. Beta - releases are suitable for limited production use cases. - - >- - GA features are open to all developers and are considered stable - and fully qualified for production use. - - >- - Deprecated features are scheduled to be shut down and removed. For - more information, see the "Deprecation Policy" section of our - [Terms of Service](https://cloud.google.com/terms/) and the - [Google Cloud Platform Subject to the Deprecation - Policy](https://cloud.google.com/terms/deprecation) documentation. - labels: - type: array - description: >- - Required. A set of labels used to describe instances of this - monitored resource type. For example, an individual Google Cloud SQL - database is identified by values for the labels `"database_id"` and - `"zone"`. - items: - $ref: '#/components/schemas/LabelDescriptor' - id: MonitoredResourceDescriptor - description: >- - An object that describes the schema of a MonitoredResource object using - a type name and a set of labels. For example, the monitored resource - descriptor for Google Compute Engine VM instances has a type of - `"gce_instance"` and specifies the use of the labels `"instance_id"` and - `"zone"` to identify particular VM instances. Different APIs can support - different monitored resource types. APIs generally provide a `list` - method that returns the monitored resource descriptors used by the API. - type: object - AuthProvider: - properties: jwksUri: + type: string description: >- URL of the provider's public key set to validate signature of the JWT. See [OpenID @@ -774,38 +406,12 @@ components: of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs - type: string - jwtLocations: - description: >- - Defines the locations to extract the JWT. For now it is only used by - the Cloud Endpoints to store the OpenAPI extension - [x-google-jwt-locations] - (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) - JWT locations can be one of HTTP headers, URL query parameters or - cookies. The rule is that the first match wins. If not specified, - default to use following 3 locations: 1) Authorization: Bearer 2) - x-goog-iap-jwt-assertion 3) access_token query parameter Default - locations can be specified as followings: jwt_locations: - header: - Authorization value_prefix: "Bearer " - header: - x-goog-iap-jwt-assertion - query: access_token - type: array - items: - $ref: '#/components/schemas/JwtLocation' - issuer: - type: string + authorizationUrl: description: >- - Identifies the principal that issued the JWT. See - https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 - Usually a URL or an email address. Example: - https://securetoken.google.com Example: - 1234567-compute@developer.gserviceaccount.com - id: + Redirect URL if JWT token is required but not present or is expired. + Implement authorizationUrl of securityDefinitions in OpenAPI spec. type: string - description: >- - The unique identifier of the auth provider. It will be referred to - by `AuthRequirement.provider_id`. Example: "bookstore_auth". audiences: - type: string description: >- The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). @@ -819,592 +425,650 @@ components: - https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com - authorizationUrl: - description: >- - Redirect URL if JWT token is required but not present or is expired. - Implement authorizationUrl of securityDefinitions in OpenAPI spec. type: string - type: object + issuer: + type: string + description: >- + Identifies the principal that issued the JWT. See + https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 + Usually a URL or an email address. Example: + https://securetoken.google.com Example: + 1234567-compute@developer.gserviceaccount.com description: >- Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). - id: AuthProvider - BatchCreateAdminOverridesResponse: - description: Response message for BatchCreateAdminOverrides - id: BatchCreateAdminOverridesResponse + type: object + Context: + id: Context properties: - overrides: - description: The overrides that were created. + rules: type: array + description: >- + A list of RPC context rules that apply to individual API methods. + **NOTE:** All service configuration rules follow "last one wins" + order. items: - $ref: '#/components/schemas/QuotaOverride' + $ref: '#/components/schemas/ContextRule' + description: >- + `Context` defines which contexts an API requests. Example: context: + rules: - selector: "*" requested: - google.rpc.context.ProjectContext - + google.rpc.context.OriginContext The above specifies that all methods in + the API request `google.rpc.context.ProjectContext` and + `google.rpc.context.OriginContext`. Available context types are defined + in package `google.rpc.context`. This also provides mechanism to + allowlist any protobuf message extension that can be sent in grpc + metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For + example, list any service specific protobuf types that can appear in + grpc metadata as follows in your yaml file: Example: context: rules: - + selector: "google.example.library.v1.LibraryService.CreateBook" + allowed_request_extensions: - google.foo.v1.NewExtension + allowed_response_extensions: - google.foo.v1.NewExtension You can also + specify extension ID instead of fully qualified extension name here. type: object - GetServiceIdentityResponse: + EnableServiceResponse: + properties: + service: + $ref: '#/components/schemas/GoogleApiServiceusageV1Service' + description: The new state of the service after enabling. + description: >- + Response message for the `EnableService` method. This response message + is assigned to the `response` field of the returned Operation when that + operation is done. type: object + id: EnableServiceResponse + Http: properties: - identity: + fullyDecodeReservedExpansion: description: >- - Service identity that service producer can use to access consumer - resources. If exists is true, it contains email and unique_id. If - exists is false, it contains pre-constructed email and empty - unique_id. - $ref: '#/components/schemas/ServiceIdentity' - state: - enum: - - IDENTITY_STATE_UNSPECIFIED - - ACTIVE - description: Service identity state. - type: string - enumDescriptions: - - >- - Default service identity state. This value is used if the state is - omitted. - - Service identity has been created and can be used. - id: GetServiceIdentityResponse - description: Response message for getting service identity. - MonitoringDestination: - properties: - metrics: - items: - type: string - type: array - description: >- - Types of the metrics to report to this monitoring destination. Each - type must be defined in Service.metrics section. - monitoredResource: - type: string + When set to true, URL path parameters will be fully URI-decoded + except in cases of single segment matches in reserved expansion, + where "%2F" will be left encoded. The default behavior is to not + decode RFC 6570 reserved characters in multi segment matches. + type: boolean + rules: description: >- - The monitored resource type. The type must be defined in - Service.monitored_resources section. - type: object - description: >- - Configuration of a specific monitoring destination (the producer project - or the consumer project). - id: MonitoringDestination - Quota: - id: Quota - type: object - properties: - metricRules: + A list of HTTP configuration rules that apply to individual API + methods. **NOTE:** All service configuration rules follow "last one + wins" order. type: array items: - $ref: '#/components/schemas/MetricRule' - description: >- - List of MetricRule definitions, each one mapping a selected method - to one or more metrics. - limits: - items: - $ref: '#/components/schemas/QuotaLimit' - type: array - description: List of QuotaLimit definitions for the service. + $ref: '#/components/schemas/HttpRule' + type: object description: >- - Quota configuration helps to achieve fairness and budgeting in service - usage. The metric based quota configuration works this way: - The - service configuration defines a set of metrics. - For API calls, the - quota.metric_rules maps methods to metrics with corresponding costs. - - The quota.limits defines limits on the metrics, which will be used for - quota checks at runtime. An example quota configuration in yaml format: - quota: limits: - name: apiWriteQpsPerProject metric: - library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit - for consumer projects values: STANDARD: 10000 (The metric rules bind all - methods to the read_calls metric, except for the UpdateBook and - DeleteBook methods. These two methods are mapped to the write_calls - metric, with the UpdateBook method consuming at twice rate as the - DeleteBook method.) metric_rules: - selector: "*" metric_costs: - library.googleapis.com/read_calls: 1 - selector: - google.example.library.v1.LibraryService.UpdateBook metric_costs: - library.googleapis.com/write_calls: 2 - selector: - google.example.library.v1.LibraryService.DeleteBook metric_costs: - library.googleapis.com/write_calls: 1 Corresponding Metric definition: - metrics: - name: library.googleapis.com/read_calls display_name: Read - requests metric_kind: DELTA value_type: INT64 - name: - library.googleapis.com/write_calls display_name: Write requests - metric_kind: DELTA value_type: INT64 - SystemParameter: + Defines the HTTP configuration for an API service. It contains a list of + HttpRule, each specifying the mapping of an RPC method to one or more + HTTP REST API methods. + id: Http + BatchingConfigProto: properties: - name: - type: string - description: >- - Define the name of the parameter, such as "api_key" . It is case - sensitive. - urlQueryParameter: - description: >- - Define the URL query parameter name to use for the parameter. It is - case sensitive. - type: string - httpHeader: - description: >- - Define the HTTP header name to use for the parameter. It is case - insensitive. - type: string + batchDescriptor: + $ref: '#/components/schemas/BatchingDescriptorProto' + description: The request and response fields used in batching. + thresholds: + description: The thresholds which trigger a batched request to be sent. + $ref: '#/components/schemas/BatchingSettingsProto' type: object - id: SystemParameter + id: BatchingConfigProto description: >- - Define a parameter's name and location. The parameter may be passed as - either an HTTP header or a URL query parameter, and if both are passed - the behavior is implementation-dependent. - BatchEnableServicesRequest: + `BatchingConfigProto` defines the batching configuration for an API + method. + OperationMetadata: type: object + description: The operation metadata returned for the batchend services operation. + id: OperationMetadata properties: - serviceIds: - description: >- - The identifiers of the services to enable on the project. A valid - identifier would be: serviceusage.googleapis.com Enabling services - requires that each service is public or is shared with the user - enabling the service. A single request can enable a maximum of 20 - services at a time. If more than 20 services are specified, the - request will fail, and no state changes will occur. + resourceNames: items: type: string type: array - id: BatchEnableServicesRequest - description: Request message for the `BatchEnableServices` method. - CreateAdminQuotaPolicyMetadata: - properties: {} - id: CreateAdminQuotaPolicyMetadata - description: >- - Metadata message that provides information such as progress, partial - failures, and similar information on each GetOperation call of LRO - returned by CreateAdminQuotaPolicy. - type: object - Backend: - description: '`Backend` defines the backend configuration for a service.' - id: Backend - properties: - rules: - items: - $ref: '#/components/schemas/BackendRule' - type: array description: >- - A list of API backend rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. - type: object - SourceContext: + The full name of the resources that this operation is directly + associated with. + GoogleApiServiceusageV2alphaEnableRule: properties: - fileName: - type: string + services: + type: array description: >- - The path-qualified name of the .proto file that contained the - associated protobuf element. For example: - `"google/protobuf/source_context.proto"`. - id: SourceContext + The names of the services that are enabled. Example: + `services/storage.googleapis.com`. + items: + type: string type: object description: >- - `SourceContext` represents information about the source of a protobuf - element, like the file in which it is defined. - GoogleApiServiceusageV2betaAnalysis: - description: A message to group the analysis information. + The consumer policy rule that defines enabled services, groups, and + categories. + id: GoogleApiServiceusageV2alphaEnableRule + Impact: + id: Impact + description: A message to group impacts of updating a policy. + type: object properties: - displayName: - description: >- - Output only. The user friendly display name of the analysis type. - E.g. service dependency analysis, service resource usage analysis, - etc. + detail: type: string + description: Output only. User friendly impact detail in a free form message. readOnly: true - service: - type: string + parent: description: >- - The names of the service that has analysis result of warnings or - blockers. Example: `services/storage.googleapis.com`. - analysisType: - description: Output only. The type of analysis. + The parent resource that the analysis is based on and the service + name that the analysis is for. Example: + `projects/100/services/compute.googleapis.com`, + folders/101/services/compute.googleapis.com` and + `organizations/102/services/compute.googleapis.com`. Usually, the + parent resource here is same as the parent resource of the analyzed + policy. However, for some analysis types, the parent can be + different. For example, for resource existence analysis, if the + parent resource of the analyzed policy is a folder or an + organization, the parent resource here can still be the project that + contains the resources. + type: string + impactType: type: string - enum: - - ANALYSIS_TYPE_UNSPECIFIED - - ANALYSIS_TYPE_DEPENDENCY - - ANALYSIS_TYPE_RESOURCE_USAGE - readOnly: true enumDescriptions: - - Unspecified analysis type. Do not use. - - The analysis of service dependencies. - - The analysis of service resource usage. - analysis: - description: Output only. Analysis result of updating a policy. + - >- + Reserved Blocks (Block n contains codes from 100n to 100(n+1) -1 + Block 0 - Special/Admin codes Block 1 - Impact Type of + ANALYSIS_TYPE_DEPENDENCY Block 2 - Impact Type of + ANALYSIS_TYPE_RESOURCE_USAGE Block 3 - Impact Type of + ANALYSIS_TYPE_RESOURCE_EXISTENCE ... + - Block 1 - Impact Type of ANALYSIS_TYPE_DEPENDENCY + - Block 3 - Impact Type of ANALYSIS_TYPE_RESOURCE_EXISTENCE readOnly: true - $ref: '#/components/schemas/GoogleApiServiceusageV2betaAnalysisResult' - id: GoogleApiServiceusageV2betaAnalysis + enum: + - IMPACT_TYPE_UNSPECIFIED + - DEPENDENCY_MISSING_DEPENDENCIES + - RESOURCE_EXISTENCE_PROJECT + description: Output only. The type of impact. + DisableServiceResponse: + properties: + service: + $ref: '#/components/schemas/GoogleApiServiceusageV1Service' + description: The new state of the service after disabling. type: object - MethodSettings: + description: >- + Response message for the `DisableService` method. This response message + is assigned to the `response` field of the returned Operation when that + operation is done. + id: DisableServiceResponse + BatchingDescriptorProto: properties: - autoPopulatedFields: - description: >- - List of top-level fields of the request message, that should be - automatically populated by the client libraries based on their - (google.api.field_info).format. Currently supported format: UUID4. - Example of a YAML configuration: publishing: method_settings: - - selector: google.example.v1.ExampleService.CreateExample - auto_populated_fields: - request_id + discriminatorFields: type: array items: type: string - longRunning: - $ref: '#/components/schemas/LongRunning' description: >- - Describes settings to use for long-running operations when - generating API methods for RPCs. Complements RPCs that use the - annotations in google/longrunning/operations.proto. Example of a - YAML configuration:: publishing: method_settings: - selector: - google.cloud.speech.v2.Speech.BatchRecognize long_running: - initial_poll_delay: 60s # 1 minute poll_delay_multiplier: 1.5 - max_poll_delay: 360s # 6 minutes total_poll_timeout: 54000s # 90 - minutes - selector: + A list of the fields in the request message. Two requests will be + batched together only if the values of every field specified in + `request_discriminator_fields` is equal between the two requests. + batchedField: + type: string description: >- - The fully qualified name of the method, for which the options below - apply. This is used to find the method to apply the options. - Example: publishing: method_settings: - selector: - google.storage.control.v2.StorageControl.CreateFolder # method - settings for CreateFolder... + The repeated field in the request message to be aggregated by + batching. + subresponseField: + description: >- + Optional. When present, indicates the field in the response message + to be used to demultiplex the response into multiple response + messages, in correspondence with the multiple request messages + originally batched together. type: string type: object - id: MethodSettings - description: Describes the generator configuration for a method. - CppSettings: + id: BatchingDescriptorProto + description: >- + `BatchingDescriptorProto` specifies the fields of the request message to + be used for batching, and, optionally, the fields of the response + message to be used for demultiplexing. + MetricRule: type: object - description: Settings for C++ client libraries. - properties: - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - id: CppSettings - Documentation: + id: MetricRule properties: - overview: + selector: + description: >- + Selects the methods to which this rule applies. Refer to selector + for syntax details. type: string + metricCosts: + type: object + additionalProperties: + type: string + format: int64 description: >- - Declares a single overview page. For example: documentation: - summary: ... overview: (== include overview.md ==) This is a - shortcut for the following declaration (using pages style): - documentation: summary: ... pages: - name: Overview content: (== - include overview.md ==) Note: you cannot specify both `overview` - field and `pages` field. - documentationRootUrl: - description: The URL to the root of documentation. - type: string - serviceRootUrl: - description: >- - Specifies the service root url if the default one (the service name - from the yaml file) is not suitable. This can be seen in any fully - specified service urls as well as sections that show a base that - other urls are relative to. - type: string - pages: - type: array - items: - $ref: '#/components/schemas/Page' - description: The top level pages for the documentation set. - summary: - type: string - description: >- - A short description of what the service does. The summary must be - plain text. It becomes the overview of the service displayed in - Google Cloud Console. NOTE: This field is equivalent to the standard - field `description`. - sectionOverrides: - description: >- - Specifies section and content to override boilerplate content - provided by go/api-docgen. Currently overrides following sections: - 1. rest.service.client_libraries - type: array - items: - $ref: '#/components/schemas/Page' - rules: + Metrics to update when the selected methods are called, and the + associated cost applied to each metric. The key of the map is the + metric name, and the values are the amount increased for the metric + against which the quota limits are defined. The value must not be + negative. + description: >- + Bind API methods to metrics. Binding a method to a metric causes that + metric's configured quota behaviors to apply to the method call. + ImportAdminOverridesResponse: + id: ImportAdminOverridesResponse + type: object + description: Response message for ImportAdminOverrides + properties: + overrides: items: - $ref: '#/components/schemas/DocumentationRule' - description: >- - A list of documentation rules that apply to individual API elements. - **NOTE:** All service configuration rules follow "last one wins" - order. + $ref: '#/components/schemas/QuotaOverride' type: array - type: object - id: Documentation + description: The overrides that were created from the imported data. + Logging: + id: Logging description: >- - `Documentation` provides the information for describing a service. - Example: documentation: summary: > The Google Calendar API gives access - to most calendar features. pages: - name: Overview content: (== include - google/foo/overview.md ==) - name: Tutorial content: (== include - google/foo/tutorial.md ==) subpages: - name: Java content: (== include - google/foo/tutorial_java.md ==) rules: - selector: - google.calendar.Calendar.Get description: > ... - selector: - google.calendar.Calendar.Put description: > ... Documentation is - provided in markdown syntax. In addition to standard markdown features, - definition lists, tables and fenced code blocks are supported. Section - headers can be provided and are interpreted relative to the section - nesting of the context where a documentation fragment is embedded. - Documentation from the IDL is merged with documentation defined via the - config at normalization time, where documentation provided by config - rules overrides IDL provided. A number of constructs specific to the API - platform are supported in documentation text. In order to reference a - proto element, the following notation can be used: - [fully.qualified.proto.name][] To override the display text used for the - link, this can be used: [display text][fully.qualified.proto.name] Text - can be excluded from doc using the following notation: (-- internal - comment --) A few directives are available in documentation. Note that - directives must appear on a single line to be properly identified. The - `include` directive includes a markdown file from an external source: - (== include path/to/file ==) The `resource_for` directive marks a - message to be the resource of a collection in REST view. If it is not - specified, tools attempt to infer the resource from the operations in a - collection: (== resource_for v1.shelves.books ==) The directive - `suppress_warning` does not directly affect documentation and is - documented together with service config validation. - Usage: - description: Configuration controlling usage of a service. + Logging configuration of the service. The following example shows how to + configure logs to be sent to the producer and consumer projects. In the + example, the `activity_history` log is sent to both the producer and + consumer projects, whereas the `purchase_history` log is only sent to + the producer project. monitored_resources: - type: + library.googleapis.com/branch labels: - key: /city description: The city + where the library branch is located in. - key: /name description: The + name of the branch. logs: - name: activity_history labels: - key: + /customer_id - name: purchase_history logging: producer_destinations: - + monitored_resource: library.googleapis.com/branch logs: - + activity_history - purchase_history consumer_destinations: - + monitored_resource: library.googleapis.com/branch logs: - + activity_history + type: object properties: - producerNotificationChannel: - description: >- - The full resource name of a channel used for sending notifications - to the service producer. Google Service Management currently only - supports [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as - a notification channel. To use Google Cloud Pub/Sub as the channel, - this must be the name of a Cloud Pub/Sub topic that uses the Cloud - Pub/Sub topic name format documented in - https://cloud.google.com/pubsub/docs/overview. - type: string - requirements: - description: >- - Requirements that must be satisfied before a consumer project can - use the service. Each requirement is of the form /; for example - 'serviceusage.googleapis.com/billing-enabled'. For Google APIs, a - Terms of Service requirement must be included here. Google Cloud - APIs must include "serviceusage.googleapis.com/tos/cloud". Other - Google APIs should include - "serviceusage.googleapis.com/tos/universal". Additional ToS can be - included based on the business needs. + consumerDestinations: type: array items: - type: string - rules: + $ref: '#/components/schemas/LoggingDestination' + description: >- + Logging configurations for sending logs to the consumer project. + There can be multiple consumer destinations, each one must have a + different monitored resource type. A log can be used in at most one + consumer destination. + producerDestinations: type: array items: - $ref: '#/components/schemas/UsageRule' + $ref: '#/components/schemas/LoggingDestination' description: >- - A list of usage rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. - id: Usage + Logging configurations for sending logs to the producer project. + There can be multiple producer destinations, each one must have a + different monitored resource type. A log can be used in at most one + producer destination. + GoogleApiServiceusageV2betaAnalyzeConsumerPolicyMetadata: + properties: {} + id: GoogleApiServiceusageV2betaAnalyzeConsumerPolicyMetadata + description: Metadata for the `AnalyzeConsumerPolicy` method. type: object - BillingDestination: + Type: + type: object + id: Type + description: A protocol buffer message type. properties: - metrics: + name: + description: The fully qualified message name. + type: string + syntax: + enumDescriptions: + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. + description: The source syntax. + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS + type: string + sourceContext: + $ref: '#/components/schemas/SourceContext' + description: The source context. + oneofs: items: type: string type: array - description: >- - Names of the metrics to report to this billing destination. Each - name must be defined in Service.metrics section. - monitoredResource: - description: >- - The monitored resource type. The type must be defined in - Service.monitored_resources section. - type: string - id: BillingDestination - type: object - description: >- - Configuration of a specific billing destination (Currently only support - bill against consumer project). - Field: - properties: - number: - description: The field number. - format: int32 - type: integer + description: The list of types appearing in `oneof` definitions in this type. + fields: + description: The list of fields. + type: array + items: + $ref: '#/components/schemas/Field' options: type: array - description: The protocol buffer options. items: $ref: '#/components/schemas/Option' - name: - description: The field name. - type: string - typeUrl: + description: The protocol buffer options. + edition: description: >- - The field type URL, without the scheme, for message or enumeration - types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. + The source edition string, only valid when syntax is + SYNTAX_EDITIONS. type: string - jsonName: - description: The field JSON name. + DeleteAdminQuotaPolicyMetadata: + type: object + id: DeleteAdminQuotaPolicyMetadata + description: >- + Metadata message that provides information such as progress, partial + failures, and similar information on each GetOperation call of LRO + returned by DeleteAdminQuotaPolicy. + properties: {} + Analysis: + properties: + analysisType: type: string - defaultValue: + readOnly: true + description: Output only. The type of analysis. + enumDescriptions: + - Unspecified analysis type. Do not use. + - The analysis of service dependencies. + - The analysis of service resource usage. + - The analysis of service resource existence. + enum: + - ANALYSIS_TYPE_UNSPECIFIED + - ANALYSIS_TYPE_DEPENDENCY + - ANALYSIS_TYPE_RESOURCE_USAGE + - ANALYSIS_TYPE_RESOURCE_EXISTENCE + service: type: string description: >- - The string value of the default value of this field. Proto2 syntax - only. - oneofIndex: - type: integer + The names of the service that has analysis result of warnings or + blockers. Example: `services/storage.googleapis.com`. + analysis: + $ref: '#/components/schemas/AnalysisResult' + description: Output only. Analysis result of updating a policy. + readOnly: true + displayName: description: >- - The index of the field type in `Type.oneofs`, for message or - enumeration types. The first type has index 1; zero means the type - is not in the list. - format: int32 - packed: - description: Whether to use alternative packed wire representation. - type: boolean - kind: - enum: - - TYPE_UNKNOWN - - TYPE_DOUBLE - - TYPE_FLOAT - - TYPE_INT64 - - TYPE_UINT64 - - TYPE_INT32 - - TYPE_FIXED64 - - TYPE_FIXED32 - - TYPE_BOOL - - TYPE_STRING - - TYPE_GROUP - - TYPE_MESSAGE - - TYPE_BYTES - - TYPE_UINT32 - - TYPE_ENUM - - TYPE_SFIXED32 - - TYPE_SFIXED64 - - TYPE_SINT32 - - TYPE_SINT64 - type: string - description: The field type. - enumDescriptions: - - Field type unknown. - - Field type double. - - Field type float. - - Field type int64. - - Field type uint64. - - Field type int32. - - Field type fixed64. - - Field type fixed32. - - Field type bool. - - Field type string. - - Field type group. Proto2 syntax only, and deprecated. - - Field type message. - - Field type bytes. - - Field type uint32. - - Field type enum. - - Field type sfixed32. - - Field type sfixed64. - - Field type sint32. - - Field type sint64. - cardinality: - enum: - - CARDINALITY_UNKNOWN - - CARDINALITY_OPTIONAL - - CARDINALITY_REQUIRED - - CARDINALITY_REPEATED - description: The field cardinality. - enumDescriptions: - - For fields with unknown cardinality. - - For optional fields. - - For required fields. Proto2 syntax only. - - For repeated fields. + Output only. The user friendly display name of the analysis type. + E.g. service dependency analysis, service resource usage analysis, + etc. type: string - id: Field - description: A single field of a message type. + readOnly: true + description: A message to group the analysis information. + id: Analysis type: object - GoogleApiServiceusageV2alphaEnableRule: - id: GoogleApiServiceusageV2alphaEnableRule - description: >- - The consumer policy rule that defines enabled services, groups, and - categories. + Empty: type: object + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + id: Empty + properties: {} + MetricDescriptor: + id: MetricDescriptor properties: - services: - items: - type: string - description: >- - The names of the services that are enabled. Example: - `services/storage.googleapis.com`. - type: array - EnableRule: - properties: - values: - items: - type: string - type: array + valueType: + enum: + - VALUE_TYPE_UNSPECIFIED + - BOOL + - INT64 + - DOUBLE + - STRING + - DISTRIBUTION + - MONEY + enumDescriptions: + - Do not use this default value. + - >- + The value is a boolean. This value type can be used only if the + metric kind is `GAUGE`. + - The value is a signed 64-bit integer. + - The value is a double precision floating point number. + - >- + The value is a text string. This value type can be used only if + the metric kind is `GAUGE`. + - The value is a `Distribution`. + - The value is money. description: >- - The names of the services or service groups that are enabled. - Example: `services/storage.googleapis.com`, `groups/googleServices`, - `groups/allServices`. - groups: - items: - type: string + Whether the measurement is an integer, a floating-point number, etc. + Some combinations of `metric_kind` and `value_type` might not be + supported. + type: string + metricKind: + enum: + - METRIC_KIND_UNSPECIFIED + - GAUGE + - DELTA + - CUMULATIVE + enumDescriptions: + - Do not use this default value. + - An instantaneous measurement of a value. + - The change in a value during a time interval. + - >- + A value accumulated over a time interval. Cumulative measurements + in a time series should have the same start time and increasing + end times, until an event resets the cumulative value to zero and + sets a new start time for the following points. + type: string description: >- - DEPRECATED: Please use field `values`. Service group should have - prefix `groups/`. The names of the service groups that are enabled - (Not Implemented). Example: `groups/googleServices`. - deprecated: true - type: array - services: - deprecated: true - type: array - items: - type: string + Whether the metric records instantaneous values, changes to a value, + etc. Some combinations of `metric_kind` and `value_type` might not + be supported. + displayName: description: >- - DEPRECATED: Please use field `values`. Service should have prefix - `services/`. The names of the services that are enabled. Example: - `storage.googleapis.com`. - enableType: - description: Client and resource project enable type. + A concise name for the metric, which can be displayed in user + interfaces. Use sentence case without an ending period, for example + "Request count". This field is optional but it is recommended to be + set for any metrics associated with user-visible concepts, such as + Quota. + type: string + launchStage: enumDescriptions: + - Do not use this default value. + - The feature is not yet implemented. Users can not use it. - >- - Unspecified enable type, which means enabled as both client and - resource project. + Prelaunch features are hidden from users and are only visible + internally. - >- - Enable all clients under the CRM node specified by - `ConsumerPolicy.name` to use the listed services. A client can be - an API key, an OAuth client, or a service account. + Early Access features are limited to a closed group of testers. To + use these features, you must sign up in advance and sign a Trusted + Tester agreement (which includes confidentiality provisions). + These features may be unstable, changed in backward-incompatible + ways, and are not guaranteed to be released. - >- - Enable resources in the list services to be created and used under - the CRM node specified by the `ConsumerPolicy.name`. + Alpha is a limited availability test for releases before they are + cleared for widespread use. By Alpha, all significant design + issues are resolved and we are in the process of verifying + functionality. Alpha customers need to apply for access, agree to + applicable terms, and have their projects allowlisted. Alpha + releases don't have to be feature complete, no SLAs are provided, + and there are no technical support obligations, but they will be + far enough along that customers can actually use them in test + environments or for limited-use tests -- just like they would in + normal production cases. - >- - Activation made by Service Usage v1 API. This will be how - consumers differentiate between policy changes made by v1 and v2 - clients and understand what is actually possible based on those - different policies. - type: string + Beta is the point at which we are ready to open a release for any + customer to use. There are no SLA or technical support obligations + in a Beta release. Products will be complete from a feature + perspective, but may have some open outstanding issues. Beta + releases are suitable for limited production use cases. + - >- + GA features are open to all developers and are considered stable + and fully qualified for production use. + - >- + Deprecated features are scheduled to be shut down and removed. For + more information, see the "Deprecation Policy" section of our + [Terms of Service](https://cloud.google.com/terms/) and the + [Google Cloud Platform Subject to the Deprecation + Policy](https://cloud.google.com/terms/deprecation) documentation. enum: - - ENABLE_TYPE_UNSPECIFIED - - CLIENT - - RESOURCE - - V1_COMPATIBLE - type: object - description: >- - The consumer policy rule that defines usable services and service - groups. - id: EnableRule - DotnetSettings: - description: Settings for Dotnet client libraries. - properties: - handwrittenSignatures: - description: >- - Method signatures (in the form "service.method(signature)") which - are provided separately, so shouldn't be generated. Snippets - *calling* these methods are still generated, however. - items: - type: string - type: array - ignoredResources: + - LAUNCH_STAGE_UNSPECIFIED + - UNIMPLEMENTED + - PRELAUNCH + - EARLY_ACCESS + - ALPHA + - BETA + - GA + - DEPRECATED + description: Optional. The launch stage of the metric definition. + type: string + description: + type: string description: >- - List of full resource types to ignore during generation. This is - typically used for API-specific Location resources, which should be - handled by the generator as if they were actually the common - Location resources. Example entry: - "documentai.googleapis.com/Location" - type: array - items: - type: string - renamedServices: - additionalProperties: - type: string - type: object + A detailed description of the metric, which can be used in + documentation. + name: + type: string + description: The resource name of the metric descriptor. + unit: description: >- - Map from original service names to renamed versions. This is used + The units in which the metric value is reported. It is only + applicable if the `value_type` is `INT64`, `DOUBLE`, or + `DISTRIBUTION`. The `unit` defines the representation of the stored + metric values. Different systems might scale the values to be more + easily displayed (so a value of `0.02kBy` _might_ be displayed as + `20By`, and a value of `3523kBy` _might_ be displayed as `3.5MBy`). + However, if the `unit` is `kBy`, then the value of the metric is + always in thousands of bytes, no matter how it might be displayed. + If you want a custom metric to record the exact number of + CPU-seconds used by a job, you can create an `INT64 CUMULATIVE` + metric whose `unit` is `s{CPU}` (or equivalently `1s{CPU}` or just + `s`). If the job uses 12,005 CPU-seconds, then the value is written + as `12005`. Alternatively, if you want a custom metric to record + data in a more granular way, you can create a `DOUBLE CUMULATIVE` + metric whose `unit` is `ks{CPU}`, and then write the value `12.005` + (which is `12005/1000`), or use `Kis{CPU}` and write `11.723` (which + is `12005/1024`). The supported units are a subset of [The Unified + Code for Units of Measure](https://unitsofmeasure.org/ucum.html) + standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` + second * `min` minute * `h` hour * `d` day * `1` dimensionless + **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga + (10^9) * `T` tera (10^12) * `P` peta (10^15) * `E` exa (10^18) * `Z` + zetta (10^21) * `Y` yotta (10^24) * `m` milli (10^-3) * `u` micro + (10^-6) * `n` nano (10^-9) * `p` pico (10^-12) * `f` femto (10^-15) + * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto (10^-24) * `Ki` + kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) + * `Pi` pebi (2^50) **Grammar** The grammar also includes these + connectors: * `/` division or ratio (as an infix operator). For + examples, `kBy/{email}` or `MiBy/10ms` (although you should almost + never have `/s` in a metric `unit`; rates should always be computed + at query time from the underlying cumulative or delta value). * `.` + multiplication or composition (as an infix operator). For examples, + `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: + Expression = Component { "." Component } { "/" Component } ; + Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | + "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a + comment if it follows a `UNIT`. If the annotation is used alone, + then the unit is equivalent to `1`. For examples, `{request}/s == + 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of + non-blank printable ASCII characters not containing `{` or `}`. * + `1` represents a unitary [dimensionless + unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, + such as in `1/s`. It is typically used when none of the basic units + are appropriate. For example, "new users per day" can be represented + as `1/d` or `{new-users}/d` (and a metric value `5` would mean "5 + new users). Alternatively, "thousands of page views per day" would + be represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a + metric value of `5.3` would mean "5300 page views per day"). * `%` + represents dimensionless value of 1/100, and annotates values giving + a percentage (so the metric values are typically in the range of + 0..100, and a metric value `3` means "3 percent"). * `10^2.%` + indicates a metric contains a ratio, typically in the range 0..1, + that will be multiplied by 100 and displayed as a percentage (so a + metric value `0.03` means "3 percent"). + type: string + type: + description: >- + The metric type, including its DNS name prefix. The type is not + URL-encoded. All user-defined metric types have the DNS name + `custom.googleapis.com` or `external.googleapis.com`. Metric types + should use a natural hierarchical grouping. For example: + "custom.googleapis.com/invoice/paid/amount" + "external.googleapis.com/prometheus/up" + "appengine.googleapis.com/http/server/response_latencies" + type: string + monitoredResourceTypes: + items: + type: string + type: array + description: >- + Read-only. If present, then a time series, which is identified + partially by a metric type and a MonitoredResourceDescriptor, that + is associated with this metric type can only be associated with one + of the monitored resource types listed here. + labels: + items: + $ref: '#/components/schemas/LabelDescriptor' + description: >- + The set of labels that can be used to describe a specific instance + of this metric type. For example, the + `appengine.googleapis.com/http/server/response_latencies` metric + type has a label for the HTTP response code, `response_code`, so you + can look at latencies for successful responses or just for responses + that failed. + type: array + metadata: + description: Optional. Metadata which can be used to guide usage of the metric. + $ref: '#/components/schemas/MetricDescriptorMetadata' + description: >- + Defines a metric type and its schema. Once a metric descriptor is + created, deleting or altering it stops data collection and makes the + metric type's existing data unusable. + type: object + GoogleApiServiceusageV2betaAnalysisResult: + id: GoogleApiServiceusageV2betaAnalysisResult + description: An analysis result including blockers and warnings. + type: object + properties: + blockers: + description: >- + Blocking information that would prevent the policy changes at + runtime. + items: + $ref: '#/components/schemas/GoogleApiServiceusageV2betaImpact' + type: array + warnings: + description: >- + Warning information indicating that the policy changes might be + unsafe, but will not block the changes at runtime. + items: + $ref: '#/components/schemas/GoogleApiServiceusageV2betaImpact' + type: array + Enum: + id: Enum + description: Enum type definition. + properties: + edition: + description: >- + The source edition string, only valid when syntax is + SYNTAX_EDITIONS. + type: string + options: + items: + $ref: '#/components/schemas/Option' + type: array + description: Protocol buffer options. + syntax: + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS + description: The source syntax. + enumDescriptions: + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. + type: string + sourceContext: + $ref: '#/components/schemas/SourceContext' + description: The source context. + enumvalue: + type: array + description: Enum value definitions. + items: + $ref: '#/components/schemas/EnumValue' + name: + description: Enum type name. + type: string + type: object + DotnetSettings: + description: Settings for Dotnet client libraries. + type: object + properties: + common: + $ref: '#/components/schemas/CommonLanguageSettings' + description: Some settings. + renamedServices: + type: object + description: >- + Map from original service names to renamed versions. This is used when the default generated types would cause a naming conflict. (Neither name is fully-qualified.) Example: Subscriber to SubscriberServiceApi. + additionalProperties: + type: string renamedResources: - type: object description: >- Map from full resource types to the effective short name for the resource. This is used when otherwise resource named from different @@ -1412,226 +1076,397 @@ components: "datalabeling.googleapis.com/Dataset": "DataLabelingDataset" additionalProperties: type: string + type: object + ignoredResources: + items: + type: string + description: >- + List of full resource types to ignore during generation. This is + typically used for API-specific Location resources, which should be + handled by the generator as if they were actually the common + Location resources. Example entry: + "documentai.googleapis.com/Location" + type: array forcedNamespaceAliases: + type: array items: type: string description: >- Namespaces which must be aliased in snippets due to a known (but non-generator-predictable) naming collision + handwrittenSignatures: + items: + type: string + description: >- + Method signatures (in the form "service.method(signature)") which + are provided separately, so shouldn't be generated. Snippets + *calling* these methods are still generated, however. type: array - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - type: object id: DotnetSettings - UpdateConsumerPolicyMetadata: - type: object - description: Metadata for the `UpdateConsumerPolicy` method. - properties: {} - id: UpdateConsumerPolicyMetadata - AnalysisResult: + SourceInfo: + id: SourceInfo type: object - description: An analysis result including blockers and warnings. + description: Source information used to create a Service Config properties: - warnings: - type: array - items: - $ref: '#/components/schemas/Impact' - description: >- - Warning information indicating that the policy changes might be - unsafe, but will not block the changes at runtime. - blockers: - description: >- - Blocking information that would prevent the policy changes at - runtime. + sourceFiles: items: - $ref: '#/components/schemas/Impact' + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: object + description: All files used during config generation. type: array - id: AnalysisResult - CancelOperationRequest: - properties: {} - description: The request message for Operations.CancelOperation. - id: CancelOperationRequest - type: object - ImportAdminOverridesMetadata: - description: >- - Metadata message that provides information such as progress, partial - failures, and similar information on each GetOperation call of LRO - returned by ImportAdminOverrides. + GoogleApiServiceusageV2betaImpact: type: object - id: ImportAdminOverridesMetadata - properties: {} - GoogleApiServiceusageV1beta1GetServiceIdentityResponse: - id: GoogleApiServiceusageV1beta1GetServiceIdentityResponse + description: A message to group impacts of updating a policy. + id: GoogleApiServiceusageV2betaImpact properties: - identity: - $ref: '#/components/schemas/GoogleApiServiceusageV1beta1ServiceIdentity' - description: >- - Service identity that service producer can use to access consumer - resources. If exists is true, it contains email and unique_id. If - exists is false, it contains pre-constructed email and empty - unique_id. - state: - enumDescriptions: - - >- - Default service identity state. This value is used if the state is - omitted. - - Service identity has been created and can be used. - description: Service identity state. + detail: + description: Output only. User friendly impact detail in a free form message. + readOnly: true type: string + impactType: enum: - - IDENTITY_STATE_UNSPECIFIED - - ACTIVE - type: object - description: Response message for getting service identity. - MetricRule: - description: >- - Bind API methods to metrics. Binding a method to a metric causes that - metric's configured quota behaviors to apply to the method call. + - IMPACT_TYPE_UNSPECIFIED + - DEPENDENCY_MISSING_DEPENDENCIES + readOnly: true + type: string + enumDescriptions: + - >- + Reserved Blocks (Block n contains codes from 100n to 100(n+1) -1 + Block 0 - Special/Admin codes Block 1 - Impact Type of + ANALYSIS_TYPE_DEPENDENCY Block 2 - Impact Type of + ANALYSIS_TYPE_RESOURCE_USAGE ... + - Block 1 - Impact Type of ANALYSIS_TYPE_DEPENDENCY + description: Output only. The type of impact. + MethodSettings: + id: MethodSettings + type: object properties: - metricCosts: - description: >- - Metrics to update when the selected methods are called, and the - associated cost applied to each metric. The key of the map is the - metric name, and the values are the amount increased for the metric - against which the quota limits are defined. The value must not be - negative. - additionalProperties: + autoPopulatedFields: + items: type: string - format: int64 - type: object + type: array + description: >- + List of top-level fields of the request message, that should be + automatically populated by the client libraries based on their + (google.api.field_info).format. Currently supported format: UUID4. + Example of a YAML configuration: publishing: method_settings: - + selector: google.example.v1.ExampleService.CreateExample + auto_populated_fields: - request_id selector: description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. + The fully qualified name of the method, for which the options below + apply. This is used to find the method to apply the options. + Example: publishing: method_settings: - selector: + google.storage.control.v2.StorageControl.CreateFolder # method + settings for CreateFolder... type: string + batching: + description: >- + Batching configuration for an API method in client libraries. + Example of a YAML configuration: publishing: method_settings: - + selector: google.example.v1.ExampleService.BatchCreateExample + batching: element_count_threshold: 1000 request_byte_threshold: + 100000000 delay_threshold_millis: 10 + $ref: '#/components/schemas/BatchingConfigProto' + longRunning: + $ref: '#/components/schemas/LongRunning' + description: >- + Describes settings to use for long-running operations when + generating API methods for RPCs. Complements RPCs that use the + annotations in google/longrunning/operations.proto. Example of a + YAML configuration:: publishing: method_settings: - selector: + google.cloud.speech.v2.Speech.BatchRecognize long_running: + initial_poll_delay: 60s # 1 minute poll_delay_multiplier: 1.5 + max_poll_delay: 360s # 6 minutes total_poll_timeout: 54000s # 90 + minutes + description: Describes the generator configuration for a method. + BackendRule: type: object - id: MetricRule - GoSettings: - description: Settings for Go client libraries. - id: GoSettings - properties: - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - type: object - Analysis: + id: BackendRule properties: - displayName: - readOnly: true + operationDeadline: + description: >- + The number of seconds to wait for the completion of a long running + operation. The default is no deadline. + format: double + type: number + protocol: type: string description: >- - Output only. The user friendly display name of the analysis type. - E.g. service dependency analysis, service resource usage analysis, - etc. - analysisType: - description: Output only. The type of analysis. - enum: - - ANALYSIS_TYPE_UNSPECIFIED - - ANALYSIS_TYPE_DEPENDENCY - - ANALYSIS_TYPE_RESOURCE_USAGE - readOnly: true + The protocol used for sending a request to the backend. The + supported values are "http/1.1" and "h2". The default value is + inferred from the scheme in the address field: SCHEME PROTOCOL + http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure + HTTP backends (https://) that support HTTP/2, set this field to "h2" + for improved performance. Configuring this field to non-default + values is only supported for secure HTTP backends. This field will + be ignored for all other backends. See + https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids + for more details on the supported values. + minDeadline: + description: Deprecated, do not use. + type: number + format: double + deprecated: true + pathTranslation: + type: string enumDescriptions: - - Unspecified analysis type. Do not use. - - The analysis of service dependencies. - - The analysis of service resource usage. + - '' + - >- + Use the backend address as-is, with no modification to the path. + If the URL pattern contains variables, the variable names and + values will be appended to the query string. If a query string + parameter and a URL pattern variable have the same name, this may + result in duplicate keys in the query string. # Examples Given the + following operation config: Method path: + /api/company/{cid}/user/{uid} Backend address: + https://example.cloudfunctions.net/getUser Requests to the + following request paths will call the backend at the translated + path: Request path: /api/company/widgetworks/user/johndoe + Translated: + https://example.cloudfunctions.net/getUser?cid=widgetworks&uid=johndoe + Request path: /api/company/widgetworks/user/johndoe?timezone=EST + Translated: + https://example.cloudfunctions.net/getUser?timezone=EST&cid=widgetworks&uid=johndoe + - >- + The request path will be appended to the backend address. # + Examples Given the following operation config: Method path: + /api/company/{cid}/user/{uid} Backend address: + https://example.appspot.com Requests to the following request + paths will call the backend at the translated path: Request path: + /api/company/widgetworks/user/johndoe Translated: + https://example.appspot.com/api/company/widgetworks/user/johndoe + Request path: /api/company/widgetworks/user/johndoe?timezone=EST + Translated: + https://example.appspot.com/api/company/widgetworks/user/johndoe?timezone=EST + enum: + - PATH_TRANSLATION_UNSPECIFIED + - CONSTANT_ADDRESS + - APPEND_PATH_TO_ADDRESS + selector: + description: >- + Selects the methods to which this rule applies. Refer to selector + for syntax details. + type: string + address: type: string - analysis: - $ref: '#/components/schemas/AnalysisResult' - readOnly: true - description: Output only. Analysis result of updating a policy. - service: description: >- - The names of the service that has analysis result of warnings or - blockers. Example: `services/storage.googleapis.com`. + The address of the API backend. The scheme is used to determine the + backend protocol and security. The following schemes are accepted: + SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// + gRPC None grpcs:// gRPC TLS It is recommended to explicitly include + a scheme. Leaving out the scheme may cause constrasting behaviors + across platforms. If the port is unspecified, the default is: - 80 + for schemes without TLS - 443 for schemes with TLS For HTTP + backends, use protocol to specify the protocol version. + deadline: + description: >- + The number of seconds to wait for a response from a request. The + default varies based on the request protocol and deployment + environment. + type: number + format: double + jwtAudience: + description: >- + The JWT audience is used when generating a JWT ID token for the + backend. This ID token will be added in the HTTP "authorization" + header, and sent to the backend. type: string - description: A message to group the analysis information. - type: object - id: Analysis - Type: - id: Type - description: A protocol buffer message type. + loadBalancingPolicy: + description: >- + The load balancing policy used for connection to the application + backend. Defined as an arbitrary string to accomondate custom load + balancing policies supported by the underlying channel, but suggest + most users use one of the standard policies, such as the default, + "RoundRobin". + type: string + overridesByRequestProtocol: + additionalProperties: + $ref: '#/components/schemas/BackendRule' + description: The map between request protocol and the backend address. + type: object + disableAuth: + description: >- + When disable_auth is true, a JWT ID token won't be generated and the + original "Authorization" HTTP header will be preserved. If the + header is used to carry the original token and is expected by the + backend, this field must be set to true to preserve the header. + type: boolean + description: A backend rule provides configuration for an individual API element. + Field: + id: Field properties: - name: + jsonName: type: string - description: The fully qualified message name. - options: - items: - $ref: '#/components/schemas/Option' - description: The protocol buffer options. - type: array - fields: - type: array - items: - $ref: '#/components/schemas/Field' - description: The list of fields. - edition: + description: The field JSON name. + packed: + type: boolean + description: Whether to use alternative packed wire representation. + number: + type: integer + description: The field number. + format: int32 + defaultValue: type: string description: >- - The source edition string, only valid when syntax is - SYNTAX_EDITIONS. - sourceContext: - description: The source context. - $ref: '#/components/schemas/SourceContext' - oneofs: - items: - type: string - type: array - description: The list of types appearing in `oneof` definitions in this type. - syntax: - enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. + The string value of the default value of this field. Proto2 syntax + only. + typeUrl: + description: >- + The field type URL, without the scheme, for message or enumeration + types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. type: string + kind: enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS - description: The source syntax. - type: object - EnableServiceResponse: - properties: - service: - $ref: '#/components/schemas/GoogleApiServiceusageV1Service' - description: The new state of the service after enabling. - description: >- - Response message for the `EnableService` method. This response message - is assigned to the `response` field of the returned Operation when that - operation is done. - id: EnableServiceResponse - type: object - RemoveEnableRulesResponse: - description: The response message of `RemoveEnableRules` method. - type: object - properties: - removedValues: - description: The values removed from the parent consumer policy. - deprecated: true + - TYPE_UNKNOWN + - TYPE_DOUBLE + - TYPE_FLOAT + - TYPE_INT64 + - TYPE_UINT64 + - TYPE_INT32 + - TYPE_FIXED64 + - TYPE_FIXED32 + - TYPE_BOOL + - TYPE_STRING + - TYPE_GROUP + - TYPE_MESSAGE + - TYPE_BYTES + - TYPE_UINT32 + - TYPE_ENUM + - TYPE_SFIXED32 + - TYPE_SFIXED64 + - TYPE_SINT32 + - TYPE_SINT64 + type: string + enumDescriptions: + - Field type unknown. + - Field type double. + - Field type float. + - Field type int64. + - Field type uint64. + - Field type int32. + - Field type fixed64. + - Field type fixed32. + - Field type bool. + - Field type string. + - Field type group. Proto2 syntax only, and deprecated. + - Field type message. + - Field type bytes. + - Field type uint32. + - Field type enum. + - Field type sfixed32. + - Field type sfixed64. + - Field type sint32. + - Field type sint64. + description: The field type. + options: type: array + description: The protocol buffer options. items: - type: string - parent: + $ref: '#/components/schemas/Option' + name: + type: string + description: The field name. + oneofIndex: description: >- - The parent consumer policy. It can be - `projects/12345/consumerPolicies/default`, or - `folders/12345/consumerPolicies/default`, or - `organizations/12345/consumerPolicies/default`. + The index of the field type in `Type.oneofs`, for message or + enumeration types. The first type has index 1; zero means the type + is not in the list. + type: integer + format: int32 + cardinality: + description: The field cardinality. + enumDescriptions: + - For fields with unknown cardinality. + - For optional fields. + - For required fields. Proto2 syntax only. + - For repeated fields. type: string - id: RemoveEnableRulesResponse - GoogleApiServiceusageV1ServiceConfig: + enum: + - CARDINALITY_UNKNOWN + - CARDINALITY_OPTIONAL + - CARDINALITY_REQUIRED + - CARDINALITY_REPEATED + description: A single field of a message type. + type: object + AddEnableRulesMetadata: + id: AddEnableRulesMetadata + type: object + description: Metadata for the `AddEnableRules` method. + properties: {} + SourceContext: type: object + id: SourceContext + description: >- + `SourceContext` represents information about the source of a protobuf + element, like the file in which it is defined. properties: - apis: + fileName: + type: string + description: >- + The path-qualified name of the .proto file that contained the + associated protobuf element. For example: + `"google/protobuf/source_context.proto"`. + GoogleApiService: + description: >- + `Service` is the root object of Google API service configuration + (service config). It describes the basic information about a logical + service, such as the service name and the user-facing title, and + delegates other aspects to sub-sections. Each sub-section is either a + proto message or a repeated proto message that configures a specific + aspect, such as auth. For more information, see each proto message + definition. Example: type: google.api.Service name: + calendar.googleapis.com title: Google Calendar API apis: - name: + google.calendar.v3.Calendar visibility: rules: - selector: + "google.calendar.v3.*" restriction: PREVIEW backend: rules: - selector: + "google.calendar.v3.*" address: calendar.example.com authentication: + providers: - id: google_calendar_auth jwks_uri: + https://www.googleapis.com/oauth2/v1/certs issuer: + https://securetoken.google.com rules: - selector: "*" requirements: + provider_id: google_calendar_auth + properties: + aspects: items: - $ref: '#/components/schemas/Api' + $ref: '#/components/schemas/Aspect' + description: >- + Configuration aspects. This is a repeated field to allow multiple + aspects to be configured. The kind field in each ConfigAspect + specifies the type of aspect. The spec field contains the + configuration for that aspect. The schema for the spec field is + defined by the backend service owners. + type: array + control: + description: Configuration for the service control plane. + $ref: '#/components/schemas/Control' + monitoring: + description: Monitoring configuration. + $ref: '#/components/schemas/Monitoring' + billing: + description: Billing configuration. + $ref: '#/components/schemas/Billing' + documentation: + $ref: '#/components/schemas/Documentation' + description: Additional API documentation. + types: + description: >- + A list of all proto message types included in this API service. + Types referenced directly or indirectly by the `apis` are + automatically included. Messages which are not referenced but shall + be included, such as types used by the `google.protobuf.Any` type, + should be listed here by name by the configuration author. Example: + types: - name: google.protobuf.Int32 type: array + items: + $ref: '#/components/schemas/Type' + name: description: >- - A list of API interfaces exported by this service. Contains only the - names, versions, and method names of the interfaces. - authentication: - description: Auth configuration. Contains only the OAuth rules. - $ref: '#/components/schemas/Authentication' + The service name, which is a DNS-like logical identifier for the + service, such as `calendar.googleapis.com`. The service name + typically goes through DNS verification to make sure the owner of + the service also owns the DNS name. + type: string monitoredResources: description: >- Defines the monitored resources used by this service. This is @@ -1640,929 +1475,1316 @@ components: items: $ref: '#/components/schemas/MonitoredResourceDescriptor' type: array - title: + customError: + $ref: '#/components/schemas/CustomError' + description: Custom error configuration. + context: + description: Context configuration. + $ref: '#/components/schemas/Context' + http: + $ref: '#/components/schemas/Http' + description: HTTP configuration. + producerProjectId: + description: The Google project that owns this service. type: string - description: The product title for this service. - monitoring: - $ref: '#/components/schemas/Monitoring' + endpoints: + items: + $ref: '#/components/schemas/Endpoint' description: >- - Monitoring configuration. This should not include the - 'producer_destinations' field. - name: + Configuration for network endpoints. If this is empty, then an + endpoint with the same name as the service is automatically + generated to service all defined APIs. + type: array + systemParameters: + $ref: '#/components/schemas/SystemParameters' + description: System parameter configuration. + title: description: >- - The DNS address at which this service is available. An example DNS - address would be: `calendar.googleapis.com`. + The product title for this service, it is the name displayed in + Google Cloud Console. type: string - documentation: + metrics: + type: array + description: Defines the metrics used by this service. + items: + $ref: '#/components/schemas/MetricDescriptor' + logging: + $ref: '#/components/schemas/Logging' + description: Logging configuration. + publishing: + $ref: '#/components/schemas/Publishing' description: >- - Additional API documentation. Contains only the summary and the - documentation URL. - $ref: '#/components/schemas/Documentation' - endpoints: + Settings for [Google Cloud Client + libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) + generated from APIs defined as protocol buffers. + logs: + description: Defines the logs used by this service. type: array + items: + $ref: '#/components/schemas/LogDescriptor' + id: + type: string description: >- - Configuration for network endpoints. Contains only the names and - aliases of the endpoints. + A unique ID for a specific instance of this message, typically + assigned by the client for tracking purpose. Must be no longer than + 63 characters and only lower case letters, digits, '.', '_' and '-' + are allowed. If empty, the server may choose to generate one + instead. + enums: + description: >- + A list of all enum types included in this API service. Enums + referenced directly or indirectly by the `apis` are automatically + included. Enums which are not referenced but shall be included + should be listed here by name by the configuration author. Example: + enums: - name: google.someapi.v1.SomeEnum + type: array items: - $ref: '#/components/schemas/Endpoint' + $ref: '#/components/schemas/Enum' usage: - description: Configuration controlling usage of this service. $ref: '#/components/schemas/Usage' + description: Configuration controlling usage of this service. quota: description: Quota configuration. $ref: '#/components/schemas/Quota' - id: GoogleApiServiceusageV1ServiceConfig - description: The configuration of the service. - CustomErrorRule: - description: A custom error rule. - type: object - properties: - selector: - description: >- - Selects messages to which this rule applies. Refer to selector for - syntax details. - type: string - isErrorType: - type: boolean + systemTypes: description: >- - Mark this message as possible payload in error response. Otherwise, - objects of this type will be filtered when they appear in error - payload. - id: CustomErrorRule - EnableServiceRequest: - properties: {} - type: object - id: EnableServiceRequest - description: Request message for the `EnableService` method. - GoogleApiServiceusageV2betaImpact: - description: A message to group impacts of updating a policy. - properties: - impactType: - enum: - - IMPACT_TYPE_UNSPECIFIED - - DEPENDENCY_MISSING_DEPENDENCIES - type: string - description: Output only. The type of impact. - readOnly: true - enumDescriptions: - - >- - Reserved Blocks (Block n contains codes from 100n to 100(n+1) -1 - Block 0 - Special/Admin codes Block 1 - Impact Type of - ANALYSIS_TYPE_DEPENDENCY Block 2 - Impact Type of - ANALYSIS_TYPE_RESOURCE_USAGE ... - - Block 1 - Impact Type of ANALYSIS_TYPE_DEPENDENCY - detail: - readOnly: true - description: Output only. User friendly impact detail in a free form message. - type: string - type: object - id: GoogleApiServiceusageV2betaImpact - OperationMetadata: - description: The operation metadata returned for the batchend services operation. - type: object - id: OperationMetadata - properties: - resourceNames: + A list of all proto message types included in this API service. It + serves similar purpose as [google.api.Service.types], except that + these types are not needed by user-defined APIs. Therefore, they + will not show up in the generated discovery doc. This field should + only be used to define system APIs in ESF. type: array items: - type: string + $ref: '#/components/schemas/Type' + backend: + description: API backend configuration. + $ref: '#/components/schemas/Backend' + sourceInfo: + $ref: '#/components/schemas/SourceInfo' description: >- - The full name of the resources that this operation is directly - associated with. - DisableServiceResponse: + Output only. The source information for this configuration if + available. + apis: + description: >- + A list of API interfaces exported by this service. Only the `name` + field of the google.protobuf.Api needs to be provided by the + configuration author, as the remaining fields will be derived from + the IDL during the normalization process. It is an error to specify + an API interface here which cannot be resolved against the + associated IDL files. + type: array + items: + $ref: '#/components/schemas/Api' + configVersion: + description: >- + Obsolete. Do not use. This field has no semantic meaning. The + service config compiler always sets this field to `3`. + format: uint32 + type: integer + authentication: + $ref: '#/components/schemas/Authentication' + description: Auth configuration. type: object - id: DisableServiceResponse + id: GoogleApiService + GoSettings: properties: - service: - description: The new state of the service after disabling. - $ref: '#/components/schemas/GoogleApiServiceusageV1Service' + common: + $ref: '#/components/schemas/CommonLanguageSettings' + description: Some settings. + renamedServices: + description: >- + Map of service names to renamed services. Keys are the package + relative service names and values are the name to be used for the + service client and call options. publishing: go_settings: + renamed_services: Publisher: TopicAdmin + additionalProperties: + type: string + type: object + description: Settings for Go client libraries. + type: object + id: GoSettings + ContextRule: description: >- - Response message for the `DisableService` method. This response message - is assigned to the `response` field of the returned Operation when that - operation is done. - Http: + A context rule provides information about the context for an individual + API element. type: object + id: ContextRule properties: - fullyDecodeReservedExpansion: + allowedResponseExtensions: + type: array description: >- - When set to true, URL path parameters will be fully URI-decoded - except in cases of single segment matches in reserved expansion, - where "%2F" will be left encoded. The default behavior is to not - decode RFC 6570 reserved characters in multi segment matches. - type: boolean - rules: + A list of full type names or extension IDs of extensions allowed in + grpc side channel from backend to client. + items: + type: string + allowedRequestExtensions: + description: >- + A list of full type names or extension IDs of extensions allowed in + grpc side channel from client to backend. + type: array + items: + type: string + provided: type: array + items: + type: string description: >- - A list of HTTP configuration rules that apply to individual API - methods. **NOTE:** All service configuration rules follow "last one - wins" order. + A list of full type names of provided contexts. It is used to + support propagating HTTP headers and ETags from the response + extension. + selector: + description: >- + Selects the methods to which this rule applies. Refer to selector + for syntax details. + type: string + requested: + description: >- + A list of full type names of requested contexts, only the requested + context will be made available to the backend. items: - $ref: '#/components/schemas/HttpRule' - description: >- - Defines the HTTP configuration for an API service. It contains a list of - HttpRule, each specifying the mapping of an RPC method to one or more - HTTP REST API methods. - id: Http - LoggingDestination: + type: string + type: array + EnableRule: description: >- - Configuration of a specific logging destination (the producer project or - the consumer project). - type: object + The consumer policy rule that defines usable services and service + groups. properties: - logs: + groups: + type: array + items: + type: string + deprecated: true + description: >- + DEPRECATED: Please use field `values`. Service group should have + prefix `groups/`. The names of the service groups that are enabled + (Not Implemented). Example: `groups/googleServices`. + values: items: type: string + description: >- + The names of the services or service groups that are enabled. + Example: `services/storage.googleapis.com`, `groups/googleServices`, + `groups/allServices`. type: array + services: + items: + type: string description: >- - Names of the logs to be sent to this destination. Each name must be - defined in the Service.logs section. If the log name is not a domain - scoped name, it will be automatically prefixed with the service name - followed by "/". - monitoredResource: + DEPRECATED: Please use field `values`. Service should have prefix + `services/`. The names of the services that are enabled. Example: + `storage.googleapis.com`. + type: array + deprecated: true + enableType: type: string - description: >- - The monitored resource type. The type must be defined in the - Service.monitored_resources section. - id: LoggingDestination - QuotaOverride: - description: A quota override + enum: + - ENABLE_TYPE_UNSPECIFIED + - CLIENT + - RESOURCE + - V1_COMPATIBLE + description: Client and resource project enable type. + enumDescriptions: + - >- + Unspecified enable type, which means enabled as both client and + resource project. + - >- + Enable all clients under the CRM node specified by + `ConsumerPolicy.name` to use the listed services. A client can be + an API key, an OAuth client, or a service account. + - >- + Enable resources in the list services to be created and used under + the CRM node specified by the `ConsumerPolicy.name`. + - >- + Activation made by Service Usage v1 API. This will be how + consumers differentiate between policy changes made by v1 and v2 + clients and understand what is actually possible based on those + different policies. + type: object + id: EnableRule + MonitoredResourceDescriptor: + id: MonitoredResourceDescriptor + description: >- + An object that describes the schema of a MonitoredResource object using + a type name and a set of labels. For example, the monitored resource + descriptor for Google Compute Engine VM instances has a type of + `"gce_instance"` and specifies the use of the labels `"instance_id"` and + `"zone"` to identify particular VM instances. Different APIs can support + different monitored resource types. APIs generally provide a `list` + method that returns the monitored resource descriptors used by the API. type: object - id: QuotaOverride properties: - name: + type: type: string description: >- - The resource name of the override. This name is generated by the - server when the override is created. Example names would be: - `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` - `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` - The resource name is intended to be opaque and should not be parsed - for its component strings, since its representation could change in - the future. - overrideValue: + Required. The monitored resource type. For example, the type + `"cloudsql_database"` represents databases in Google Cloud SQL. For + a list of types, see [Monitored resource + types](https://cloud.google.com/monitoring/api/resources) and + [Logging resource + types](https://cloud.google.com/logging/docs/api/v2/resource-list). + description: type: string description: >- - The overriding quota limit value. Can be any nonnegative integer, or - -1 (unlimited quota). - format: int64 - dimensions: - additionalProperties: - type: string + Optional. A detailed description of the monitored resource type that + might be used in documentation. + displayName: description: >- - If this map is nonempty, then this override applies only to specific - values for dimensions defined in the limit unit. For example, an - override on a limit with the unit `1/{project}/{region}` could - contain an entry with the key `region` and the value `us-east-1`; - the override is only applied to quota consumed in that region. This - map has the following restrictions: * Keys that are not defined in - the limit's unit are not valid keys. Any string appearing in - `{brackets}` in the unit (besides `{project}` or `{user}`) is a - defined key. * `project` is not a valid key; the project is already - specified in the parent resource name. * `user` is not a valid key; - the API does not support quota overrides that apply only to a - specific user. * If `region` appears as a key, its value must be a - valid Cloud region. * If `zone` appears as a key, its value must be - a valid Cloud zone. * If any valid key other than `region` or `zone` - appears in the map, then all valid keys other than `region` or - `zone` must also appear in the map. - type: object - adminOverrideAncestor: + Optional. A concise name for the monitored resource type that might + be displayed in user interfaces. It should be a Title Cased Noun + Phrase, without any article or other determiners. For example, + `"Google Cloud SQL Database"`. + type: string + launchStage: + enum: + - LAUNCH_STAGE_UNSPECIFIED + - UNIMPLEMENTED + - PRELAUNCH + - EARLY_ACCESS + - ALPHA + - BETA + - GA + - DEPRECATED + description: Optional. The launch stage of the monitored resource definition. + type: string + enumDescriptions: + - Do not use this default value. + - The feature is not yet implemented. Users can not use it. + - >- + Prelaunch features are hidden from users and are only visible + internally. + - >- + Early Access features are limited to a closed group of testers. To + use these features, you must sign up in advance and sign a Trusted + Tester agreement (which includes confidentiality provisions). + These features may be unstable, changed in backward-incompatible + ways, and are not guaranteed to be released. + - >- + Alpha is a limited availability test for releases before they are + cleared for widespread use. By Alpha, all significant design + issues are resolved and we are in the process of verifying + functionality. Alpha customers need to apply for access, agree to + applicable terms, and have their projects allowlisted. Alpha + releases don't have to be feature complete, no SLAs are provided, + and there are no technical support obligations, but they will be + far enough along that customers can actually use them in test + environments or for limited-use tests -- just like they would in + normal production cases. + - >- + Beta is the point at which we are ready to open a release for any + customer to use. There are no SLA or technical support obligations + in a Beta release. Products will be complete from a feature + perspective, but may have some open outstanding issues. Beta + releases are suitable for limited production use cases. + - >- + GA features are open to all developers and are considered stable + and fully qualified for production use. + - >- + Deprecated features are scheduled to be shut down and removed. For + more information, see the "Deprecation Policy" section of our + [Terms of Service](https://cloud.google.com/terms/) and the + [Google Cloud Platform Subject to the Deprecation + Policy](https://cloud.google.com/terms/deprecation) documentation. + labels: + items: + $ref: '#/components/schemas/LabelDescriptor' + type: array description: >- - The resource name of the ancestor that requested the override. For - example: `organizations/12345` or `folders/67890`. Used by admin - overrides only. + Required. A set of labels used to describe instances of this + monitored resource type. For example, an individual Google Cloud SQL + database is identified by values for the labels `"database_id"` and + `"zone"`. + name: + description: >- + Optional. The resource name of the monitored resource descriptor: + `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where + {type} is the value of the `type` field in this object and + {project_id} is a project ID that provides API-specific context for + accessing the type. APIs that do not use project information can use + the resource name format `"monitoredResourceDescriptors/{type}"`. + type: string + HttpRule: + type: object + description: >- + gRPC Transcoding gRPC Transcoding is a feature for mapping between a + gRPC method and one or more HTTP REST endpoints. It allows developers to + build a single API service that supports both gRPC APIs and REST APIs. + Many systems, including [Google + APIs](https://github.com/googleapis/googleapis), [Cloud + Endpoints](https://cloud.google.com/endpoints), [gRPC + Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and + [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature + and use it for large scale production services. `HttpRule` defines the + schema of the gRPC/REST mapping. The mapping specifies how different + portions of the gRPC request message are mapped to the URL path, URL + query parameters, and HTTP request body. It also controls how the gRPC + response message is mapped to the HTTP response body. `HttpRule` is + typically specified as an `google.api.http` annotation on the gRPC + method. Each mapping specifies a URL path template and an HTTP method. + The path template may refer to one or more fields in the gRPC request + message, as long as each field is a non-repeated field with a primitive + (non-message) type. The path template controls how fields of the request + message are mapped to the URL path. Example: service Messaging { rpc + GetMessage(GetMessageRequest) returns (Message) { option + (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message + GetMessageRequest { string name = 1; // Mapped to URL path. } message + Message { string text = 1; // The resource content. } This enables an + HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - + gRPC: `GetMessage(name: "messages/123456")` Any fields in the request + message which are not bound by the path template automatically become + HTTP query parameters if there is no HTTP request body. For example: + service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) + { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } + message GetMessageRequest { message SubMessage { string subfield = 1; } + string message_id = 1; // Mapped to URL path. int64 revision = 2; // + Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped + to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC + mapping as below: - HTTP: `GET + /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: + `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: + "foo"))` Note that fields which are mapped to URL query parameters must + have a primitive type or a repeated primitive type or a non-repeated + message type. In the case of a repeated type, the parameter can be + repeated in the URL as `...?param=A¶m=B`. In the case of a message + type, each field of the message is mapped to a separate parameter, such + as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request + body, the `body` field specifies the mapping. Consider a REST update + method on the message resource collection: service Messaging { rpc + UpdateMessage(UpdateMessageRequest) returns (Message) { option + (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" + }; } } message UpdateMessageRequest { string message_id = 1; // mapped + to the URL Message message = 2; // mapped to the body } The following + HTTP JSON to RPC mapping is enabled, where the representation of the + JSON in the request body is determined by protos JSON encoding: - HTTP: + `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: + `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The + special name `*` can be used in the body mapping to define that every + field not bound by the path template should be mapped to the request + body. This enables the following alternative definition of the update + method: service Messaging { rpc UpdateMessage(Message) returns (Message) + { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: + "*" }; } } message Message { string message_id = 1; string text = 2; } + The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH + /v1/messages/123456 { "text": "Hi!" }` - gRPC: + `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using + `*` in the body mapping, it is not possible to have HTTP parameters, as + all fields not bound by the path end in the body. This makes this option + more rarely used in practice when defining REST APIs. The common usage + of `*` is in custom methods which don't use the URL at all for + transferring data. It is possible to define multiple HTTP methods for + one RPC by using the `additional_bindings` option. Example: service + Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option + (google.api.http) = { get: "/v1/messages/{message_id}" + additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } + }; } } message GetMessageRequest { string message_id = 1; string user_id + = 2; } This enables the following two alternative HTTP JSON to RPC + mappings: - HTTP: `GET /v1/messages/123456` - gRPC: + `GetMessage(message_id: "123456")` - HTTP: `GET + /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" + message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields + (recursive expansion nested messages in the request message) are + classified into three categories: - Fields referred by the path + template. They are passed via the URL path. - Fields referred by the + HttpRule.body. They are passed via the HTTP request body. - All other + fields are passed via the URL query parameters, and the parameter name + is the field path in the request message. A repeated field can be + represented as multiple query parameters under the same name. 2. If + HttpRule.body is "*", there is no URL query parameter, all fields are + passed via URL path and HTTP request body. 3. If HttpRule.body is + omitted, there is no HTTP request body, all fields are passed via URL + path and URL query parameters. Path template syntax Template = "/" + Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | + "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] + "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax + `*` matches a single URL path segment. The syntax `**` matches zero or + more URL path segments, which must be the last part of the URL path + except the `Verb`. The syntax `Variable` matches part of the URL path as + specified by its template. A variable template must not contain other + variables. If a variable matches a single path segment, its template may + be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax + `LITERAL` matches literal text in the URL path. If the `LITERAL` + contains any reserved character, such characters should be + percent-encoded before the matching. If a variable contains exactly one + path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is + expanded into a URL path on the client side, all characters except + `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse + decoding. Such variables show up in the [Discovery + Document](https://developers.google.com/discovery/v1/reference/apis) as + `{var}`. If a variable contains multiple path segments, such as + `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a + URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` + are percent-encoded. The server side does the reverse decoding, except + "%2F" and "%2f" are left unchanged. Such variables show up in the + [Discovery + Document](https://developers.google.com/discovery/v1/reference/apis) as + `{+var}`. Using gRPC API Service Configuration gRPC API Service + Configuration (service config) is a configuration language for + configuring a gRPC service to become a user-facing product. The service + config is simply the YAML representation of the `google.api.Service` + proto message. As an alternative to annotating your proto file, you can + configure gRPC transcoding in your service config YAML files. You do + this by specifying a `HttpRule` that maps the gRPC method to a REST + endpoint, achieving the same effect as the proto annotation. This can be + particularly useful if you have a proto that is reused in multiple + services. Note that any transcoding specified in the service config will + override any matching transcoding configuration in the proto. The + following example selects a gRPC method and applies an `HttpRule` to it: + http: rules: - selector: example.v1.Messaging.GetMessage get: + /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC + Transcoding is used to map a gRPC to JSON REST endpoints, the proto to + JSON conversion must follow the [proto3 + specification](https://developers.google.com/protocol-buffers/docs/proto3#json). + While the single segment variable follows the semantics of [RFC + 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String + Expansion, the multi segment variable **does not** follow RFC 6570 + Section 3.2.3 Reserved Expansion. The reason is that the Reserved + Expansion does not expand special characters like `?` and `#`, which + would lead to invalid URLs. As the result, gRPC Transcoding uses a + custom encoding for multi segment variables. The path variables **must + not** refer to any repeated or mapped field, because client libraries + are not capable of handling such variable expansion. The path variables + **must not** capture the leading "/" character. The reason is that the + most common use case "{var}" does not capture the leading "/" character. + For consistency, all path variables must share the same behavior. + Repeated message fields must not be mapped to URL query parameters, + because no client library can support such complicated mapping. If an + API needs to use a JSON array for request or response body, it can map + the request or response body to a repeated field. However, some gRPC + Transcoding implementations may not support this feature. + id: HttpRule + properties: + post: + type: string + description: >- + Maps to HTTP POST. Used for creating a resource or performing an + action. + additionalBindings: + description: >- + Additional HTTP bindings for the selector. Nested bindings must not + contain an `additional_bindings` field themselves (that is, the + nesting may only be one level deep). + items: + $ref: '#/components/schemas/HttpRule' + type: array + body: + type: string + description: >- + The name of the request field whose value is mapped to the HTTP + request body, or `*` for mapping all request fields not captured by + the path pattern to the HTTP body, or omitted for not having any + HTTP request body. NOTE: the referred field must be present at the + top-level of the request message type. + put: + description: Maps to HTTP PUT. Used for replacing a resource. + type: string + patch: + description: Maps to HTTP PATCH. Used for updating a resource. + type: string + selector: + description: >- + Selects a method to which this rule applies. Refer to selector for + syntax details. + type: string + get: + type: string + description: >- + Maps to HTTP GET. Used for listing and getting information about + resources. + custom: + description: >- + The custom pattern is used for specifying an HTTP method that is not + included in the `pattern` field, such as HEAD, or "*" to leave the + HTTP method unspecified for this rule. The wild-card rule is useful + for services that provide content to Web (HTML) clients. + $ref: '#/components/schemas/CustomHttpPattern' + responseBody: + type: string + description: >- + Optional. The name of the response field whose value is mapped to + the HTTP response body. When omitted, the entire response message + will be used as the HTTP response body. NOTE: The referred field + must be present at the top-level of the response message type. + delete: + description: Maps to HTTP DELETE. Used for deleting a resource. + type: string + ListOperationsResponse: + description: The response message for Operations.ListOperations. + type: object + id: ListOperationsResponse + properties: + operations: + items: + $ref: '#/components/schemas/Operation' + description: >- + A list of operations that matches the specified filter in the + request. + type: array + nextPageToken: + type: string + description: The standard List next-page token. + AnalyzeConsumerPolicyResponse: + type: object + id: AnalyzeConsumerPolicyResponse + description: The response of analyzing a consumer policy update. + properties: + analysis: + description: >- + The list of analyses returned from performing the intended policy + update analysis. The analysis is grouped by service name and + different analysis types. The empty analysis list means that the + consumer policy can be updated without any warnings or blockers. + items: + $ref: '#/components/schemas/Analysis' + type: array + LoggingDestination: + description: >- + Configuration of a specific logging destination (the producer project or + the consumer project). + type: object + properties: + monitoredResource: + description: >- + The monitored resource type. The type must be defined in the + Service.monitored_resources section. + type: string + logs: + items: + type: string + description: >- + Names of the logs to be sent to this destination. Each name must be + defined in the Service.logs section. If the log name is not a domain + scoped name, it will be automatically prefixed with the service name + followed by "/". + type: array + id: LoggingDestination + AdminQuotaPolicy: + id: AdminQuotaPolicy + properties: + name: + description: >- + The resource name of the policy. This name is generated by the + server when the policy is created. Example names would be: + `organizations/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminQuotaPolicies/4a3f2c1d` type: string metric: description: >- - The name of the metric to which this override applies. An example - name would be: `compute.googleapis.com/cpus` + The name of the metric to which this policy applies. An example name + would be: `compute.googleapis.com/cpus` type: string unit: type: string description: >- - The limit unit of the limit to which this override applies. An - example unit would be: `1/{project}/{region}` Note that `{project}` - and `{region}` are not placeholders in this example; the literal + The limit unit of the limit to which this policy applies. An example + unit would be: `1/{project}/{region}` Note that `{project}` and + `{region}` are not placeholders in this example; the literal characters `{` and `}` occur in the string. - AnalyzeConsumerPolicyResponse: - properties: - analysis: - type: array - items: - $ref: '#/components/schemas/Analysis' + policyValue: + format: int64 + type: string description: >- - The list of analyses returned from performing the intended policy - update analysis. The analysis is grouped by service name and - different analysis types. The empty analysis list means that the - consumer policy can be updated without any warnings or blockers. - id: AnalyzeConsumerPolicyResponse - type: object - description: The response of analyzing a consumer policy update. - GoogleApiServiceusageV2betaAnalyzeConsumerPolicyMetadata: + The quota policy value. Can be any nonnegative integer, or -1 + (unlimited quota). + container: + type: string + description: >- + The cloud resource container at which the quota policy is created. + The format is `{container_type}/{container_number}` + dimensions: + type: object + additionalProperties: + type: string + description: ' If this map is nonempty, then this policy applies only to specific values for dimensions defined in the limit unit. For example, a policy on a limit with the unit `1/{project}/{region}` could contain an entry with the key `region` and the value `us-east-1`; the policy is only applied to quota consumed in that region. This map has the following restrictions: * If `region` appears as a key, its value must be a valid Cloud region. * If `zone` appears as a key, its value must be a valid Cloud zone. * Keys other than `region` or `zone` are not valid.' type: object + description: Quota policy created by quota administrator. + AnalyzeConsumerPolicyMetadata: properties: {} - description: Metadata for the `AnalyzeConsumerPolicy` method. - id: GoogleApiServiceusageV2betaAnalyzeConsumerPolicyMetadata - GoogleApiService: + id: AnalyzeConsumerPolicyMetadata type: object - id: GoogleApiService + description: Metadata for the `AnalyzeConsumerPolicy` method. + Operation: description: >- - `Service` is the root object of Google API service configuration - (service config). It describes the basic information about a logical - service, such as the service name and the user-facing title, and - delegates other aspects to sub-sections. Each sub-section is either a - proto message or a repeated proto message that configures a specific - aspect, such as auth. For more information, see each proto message - definition. Example: type: google.api.Service name: - calendar.googleapis.com title: Google Calendar API apis: - name: - google.calendar.v3.Calendar visibility: rules: - selector: - "google.calendar.v3.*" restriction: PREVIEW backend: rules: - selector: - "google.calendar.v3.*" address: calendar.example.com authentication: - providers: - id: google_calendar_auth jwks_uri: - https://www.googleapis.com/oauth2/v1/certs issuer: - https://securetoken.google.com rules: - selector: "*" requirements: - provider_id: google_calendar_auth + This resource represents a long-running operation that is the result of + a network API call. + id: Operation + type: object properties: - usage: - $ref: '#/components/schemas/Usage' - description: Configuration controlling usage of this service. - context: - description: Context configuration. - $ref: '#/components/schemas/Context' - backend: - $ref: '#/components/schemas/Backend' - description: API backend configuration. - billing: - $ref: '#/components/schemas/Billing' - description: Billing configuration. - publishing: - $ref: '#/components/schemas/Publishing' + response: + type: object description: >- - Settings for [Google Cloud Client - libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) - generated from APIs defined as protocol buffers. - http: - $ref: '#/components/schemas/Http' - description: HTTP configuration. - apis: + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + error: + $ref: '#/components/schemas/Status' description: >- - A list of API interfaces exported by this service. Only the `name` - field of the google.protobuf.Api needs to be provided by the - configuration author, as the remaining fields will be derived from - the IDL during the normalization process. It is an error to specify - an API interface here which cannot be resolved against the - associated IDL files. - type: array - items: - $ref: '#/components/schemas/Api' - authentication: - description: Auth configuration. - $ref: '#/components/schemas/Authentication' - name: + The error result of the operation in case of failure or + cancellation. + metadata: + type: object description: >- - The service name, which is a DNS-like logical identifier for the - service, such as `calendar.googleapis.com`. The service name - typically goes through DNS verification to make sure the owner of - the service also owns the DNS name. + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + name: type: string - sourceInfo: - $ref: '#/components/schemas/SourceInfo' description: >- - Output only. The source information for this configuration if - available. - monitoring: - description: Monitoring configuration. - $ref: '#/components/schemas/Monitoring' - monitoredResources: - items: - $ref: '#/components/schemas/MonitoredResourceDescriptor' - type: array + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. + done: description: >- - Defines the monitored resources used by this service. This is - required by the Service.monitoring and Service.logging - configurations. - systemParameters: - $ref: '#/components/schemas/SystemParameters' - description: System parameter configuration. - documentation: - description: Additional API documentation. - $ref: '#/components/schemas/Documentation' - producerProjectId: - description: The Google project that owns this service. + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + type: boolean + LabelDescriptor: + description: A description of a label. + properties: + valueType: + description: The type of data that can be assigned to the label. + enum: + - STRING + - BOOL + - INT64 + enumDescriptions: + - A variable-length string. This is the default. + - Boolean; true or false. + - A 64-bit signed integer. type: string - endpoints: - description: >- - Configuration for network endpoints. If this is empty, then an - endpoint with the same name as the service is automatically - generated to service all defined APIs. - items: - $ref: '#/components/schemas/Endpoint' - type: array - metrics: - description: Defines the metrics used by this service. + description: + description: A human-readable description for the label. + type: string + key: + type: string + description: The label key. + type: object + id: LabelDescriptor + BatchGetServicesResponse: + id: BatchGetServicesResponse + type: object + description: Response message for the `BatchGetServices` method. + properties: + services: items: - $ref: '#/components/schemas/MetricDescriptor' + $ref: '#/components/schemas/GoogleApiServiceusageV1Service' + description: The requested Service states. type: array - id: + SystemParameterRule: + description: >- + Define a system parameter rule mapping system parameter definitions to + methods. + properties: + selector: description: >- - A unique ID for a specific instance of this message, typically - assigned by the client for tracking purpose. Must be no longer than - 63 characters and only lower case letters, digits, '.', '_' and '-' - are allowed. If empty, the server may choose to generate one - instead. + Selects the methods to which this rule applies. Use '*' to indicate + all methods in all APIs. Refer to selector for syntax details. type: string - configVersion: - format: uint32 - type: integer - description: >- - Obsolete. Do not use. This field has no semantic meaning. The - service config compiler always sets this field to `3`. - systemTypes: + parameters: type: array - items: - $ref: '#/components/schemas/Type' description: >- - A list of all proto message types included in this API service. It - serves similar purpose as [google.api.Service.types], except that - these types are not needed by user-defined APIs. Therefore, they - will not show up in the generated discovery doc. This field should - only be used to define system APIs in ESF. - logs: + Define parameters. Multiple names may be defined for a parameter. + For a given method call, only one of them should be used. If + multiple names are used the behavior is implementation-dependent. If + none of the specified names are present the behavior is + parameter-dependent. + items: + $ref: '#/components/schemas/SystemParameter' + type: object + id: SystemParameterRule + BatchCreateConsumerOverridesResponse: + properties: + overrides: type: array + description: The overrides that were created. items: - $ref: '#/components/schemas/LogDescriptor' - description: Defines the logs used by this service. - customError: - description: Custom error configuration. - $ref: '#/components/schemas/CustomError' - types: + $ref: '#/components/schemas/QuotaOverride' + description: Response message for BatchCreateConsumerOverrides + id: BatchCreateConsumerOverridesResponse + type: object + GoogleApiServiceusageV1beta1ServiceIdentity: + description: >- + Service identity for a service. This is the identity that service + producer should use to access consumer resources. + type: object + id: GoogleApiServiceusageV1beta1ServiceIdentity + properties: + uniqueId: description: >- - A list of all proto message types included in this API service. - Types referenced directly or indirectly by the `apis` are - automatically included. Messages which are not referenced but shall - be included, such as types used by the `google.protobuf.Any` type, - should be listed here by name by the configuration author. Example: - types: - name: google.protobuf.Int32 - items: - $ref: '#/components/schemas/Type' - type: array - title: + The unique and stable id of the service account. + https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts#ServiceAccount + type: string + email: type: string description: >- - The product title for this service, it is the name displayed in - Google Cloud Console. - enums: + The email address of the service account that a service producer + would use to access consumer resources. + ServiceIdentity: + description: >- + Service identity for a service. This is the identity that service + producer should use to access consumer resources. + properties: + uniqueId: + type: string description: >- - A list of all enum types included in this API service. Enums - referenced directly or indirectly by the `apis` are automatically - included. Enums which are not referenced but shall be included - should be listed here by name by the configuration author. Example: - enums: - name: google.someapi.v1.SomeEnum - type: array - items: - $ref: '#/components/schemas/Enum' - control: - description: Configuration for the service control plane. - $ref: '#/components/schemas/Control' - quota: - description: Quota configuration. - $ref: '#/components/schemas/Quota' - logging: - description: Logging configuration. - $ref: '#/components/schemas/Logging' - ImportAdminQuotaPoliciesMetadata: + The unique and stable id of the service account. + https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts#ServiceAccount + email: + type: string + description: >- + The email address of the service account that a service producer + would use to access consumer resources. + type: object + id: ServiceIdentity + EnableServiceRequest: properties: {} - id: ImportAdminQuotaPoliciesMetadata + description: Request message for the `EnableService` method. + id: EnableServiceRequest + type: object + PhpSettings: + id: PhpSettings + description: Settings for Php client libraries. type: object - description: >- - Metadata message that provides information such as progress, partial - failures, and similar information on each GetOperation call of LRO - returned by ImportAdminQuotaPolicies. - ImportAdminQuotaPoliciesResponse: - description: Response message for ImportAdminQuotaPolicies - id: ImportAdminQuotaPoliciesResponse properties: - policies: - description: The policies that were created from the imported data. - type: array - items: - $ref: '#/components/schemas/AdminQuotaPolicy' + common: + $ref: '#/components/schemas/CommonLanguageSettings' + description: Some settings. + libraryPackage: + description: >- + The package name to use in Php. Clobbers the php_namespace option + set in the protobuf. This should be used **only** by APIs who have + already set the language_settings.php.package_name" field in + gapic.yaml. API teams should use the protobuf php_namespace option + where possible. Example of a YAML configuration:: publishing: + library_settings: php_settings: library_package: + Google\Cloud\PubSub\V1 + type: string + CancelOperationRequest: + id: CancelOperationRequest type: object - UpdateAdminQuotaPolicyMetadata: + description: The request message for Operations.CancelOperation. properties: {} + MonitoringDestination: type: object - id: UpdateAdminQuotaPolicyMetadata + id: MonitoringDestination description: >- - Metadata message that provides information such as progress, partial - failures, and similar information on each GetOperation call of LRO - returned by UpdateAdminQuotaPolicy. - RemoveEnableRulesMetadata: - id: RemoveEnableRulesMetadata - type: object - properties: {} - description: Metadata for the `RemoveEnableRules` method. - SourceInfo: - description: Source information used to create a Service Config + Configuration of a specific monitoring destination (the producer project + or the consumer project). properties: - sourceFiles: + metrics: + description: >- + Types of the metrics to report to this monitoring destination. Each + type must be defined in Service.metrics section. type: array items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - description: All files used during config generation. - id: SourceInfo + type: string + monitoredResource: + type: string + description: >- + The monitored resource type. The type must be defined in + Service.monitored_resources section. + CommonLanguageSettings: + id: CommonLanguageSettings type: object - ContextRule: - id: ContextRule + description: Required information for every language. + properties: + selectiveGapicGeneration: + description: >- + Configuration for which RPCs should be generated in the GAPIC + client. + $ref: '#/components/schemas/SelectiveGapicGeneration' + destinations: + items: + type: string + enumDescriptions: + - >- + Client libraries will neither be generated nor published to + package managers. + - >- + Generate the client library in a repo under + github.com/googleapis, but don't publish it to package managers. + - >- + Publish the library to package managers like nuget.org and + npmjs.com. + enum: + - CLIENT_LIBRARY_DESTINATION_UNSPECIFIED + - GITHUB + - PACKAGE_MANAGER + type: array + description: >- + The destination where API teams want this client library to be + published. + referenceDocsUri: + type: string + description: >- + Link to automatically generated reference documentation. Example: + https://cloud.google.com/nodejs/docs/reference/asset/latest + deprecated: true + ClientLibrarySettings: + id: ClientLibrarySettings + description: Details about how and where to publish client libraries. + type: object + properties: + pythonSettings: + description: Settings for Python client libraries. + $ref: '#/components/schemas/PythonSettings' + goSettings: + $ref: '#/components/schemas/GoSettings' + description: Settings for Go client libraries. + dotnetSettings: + description: Settings for .NET client libraries. + $ref: '#/components/schemas/DotnetSettings' + rubySettings: + $ref: '#/components/schemas/RubySettings' + description: Settings for Ruby client libraries. + launchStage: + enumDescriptions: + - Do not use this default value. + - The feature is not yet implemented. Users can not use it. + - >- + Prelaunch features are hidden from users and are only visible + internally. + - >- + Early Access features are limited to a closed group of testers. To + use these features, you must sign up in advance and sign a Trusted + Tester agreement (which includes confidentiality provisions). + These features may be unstable, changed in backward-incompatible + ways, and are not guaranteed to be released. + - >- + Alpha is a limited availability test for releases before they are + cleared for widespread use. By Alpha, all significant design + issues are resolved and we are in the process of verifying + functionality. Alpha customers need to apply for access, agree to + applicable terms, and have their projects allowlisted. Alpha + releases don't have to be feature complete, no SLAs are provided, + and there are no technical support obligations, but they will be + far enough along that customers can actually use them in test + environments or for limited-use tests -- just like they would in + normal production cases. + - >- + Beta is the point at which we are ready to open a release for any + customer to use. There are no SLA or technical support obligations + in a Beta release. Products will be complete from a feature + perspective, but may have some open outstanding issues. Beta + releases are suitable for limited production use cases. + - >- + GA features are open to all developers and are considered stable + and fully qualified for production use. + - >- + Deprecated features are scheduled to be shut down and removed. For + more information, see the "Deprecation Policy" section of our + [Terms of Service](https://cloud.google.com/terms/) and the + [Google Cloud Platform Subject to the Deprecation + Policy](https://cloud.google.com/terms/deprecation) documentation. + enum: + - LAUNCH_STAGE_UNSPECIFIED + - UNIMPLEMENTED + - PRELAUNCH + - EARLY_ACCESS + - ALPHA + - BETA + - GA + - DEPRECATED + type: string + description: Launch stage of this version of the API. + version: + type: string + description: >- + Version of the API to apply these settings to. This is the full + protobuf package for the API, ending in the version element. + Examples: "google.cloud.speech.v1" and + "google.spanner.admin.database.v1". + cppSettings: + description: Settings for C++ client libraries. + $ref: '#/components/schemas/CppSettings' + javaSettings: + description: Settings for legacy Java features, supported in the Service YAML. + $ref: '#/components/schemas/JavaSettings' + nodeSettings: + description: Settings for Node client libraries. + $ref: '#/components/schemas/NodeSettings' + phpSettings: + description: Settings for PHP client libraries. + $ref: '#/components/schemas/PhpSettings' + restNumericEnums: + type: boolean + description: >- + When using transport=rest, the client request will encode enums as + numbers rather than strings. + ExperimentalFeatures: + properties: + protobufPythonicTypesEnabled: + description: >- + Enables generation of protobuf code using new types that are more + Pythonic which are included in `protobuf>=5.29.x`. This feature will + be enabled by default 1 month after launching the feature in preview + packages. + type: boolean + restAsyncIoEnabled: + description: >- + Enables generation of asynchronous REST clients if `rest` transport + is enabled. By default, asynchronous REST clients will not be + generated. This feature will be enabled by default 1 month after + launching the feature in preview packages. + type: boolean + unversionedPackageDisabled: + description: >- + Disables generation of an unversioned Python package for this client + library. This means that the module names will need to be versioned + in import statements. For example `import google.cloud.library_v2` + instead of `import google.cloud.library`. + type: boolean + id: ExperimentalFeatures + description: >- + Experimental features to be included during client library generation. + These fields will be deprecated once the feature graduates and is + enabled by default. type: object + SystemParameter: description: >- - A context rule provides information about the context for an individual - API element. + Define a parameter's name and location. The parameter may be passed as + either an HTTP header or a URL query parameter, and if both are passed + the behavior is implementation-dependent. + id: SystemParameter + type: object properties: - requested: + name: description: >- - A list of full type names of requested contexts, only the requested - context will be made available to the backend. - items: - type: string - type: array - selector: + Define the name of the parameter, such as "api_key" . It is case + sensitive. type: string + urlQueryParameter: description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. - provided: - items: - type: string - type: array - description: >- - A list of full type names of provided contexts. It is used to - support propagating HTTP headers and ETags from the response - extension. - allowedResponseExtensions: - type: array - description: >- - A list of full type names or extension IDs of extensions allowed in - grpc side channel from backend to client. - items: - type: string - allowedRequestExtensions: + Define the URL query parameter name to use for the parameter. It is + case sensitive. + type: string + httpHeader: + type: string description: >- - A list of full type names or extension IDs of extensions allowed in - grpc side channel from client to backend. - type: array - items: - type: string - SystemParameterRule: + Define the HTTP header name to use for the parameter. It is case + insensitive. + GoogleApiServiceusageV1beta1GetServiceIdentityResponse: properties: - selector: + state: + enumDescriptions: + - >- + Default service identity state. This value is used if the state is + omitted. + - Service identity has been created and can be used. + enum: + - IDENTITY_STATE_UNSPECIFIED + - ACTIVE + description: Service identity state. type: string + identity: description: >- - Selects the methods to which this rule applies. Use '*' to indicate - all methods in all APIs. Refer to selector for syntax details. - parameters: + Service identity that service producer can use to access consumer + resources. If exists is true, it contains email and unique_id. If + exists is false, it contains pre-constructed email and empty + unique_id. + $ref: '#/components/schemas/GoogleApiServiceusageV1beta1ServiceIdentity' + description: Response message for getting service identity. + id: GoogleApiServiceusageV1beta1GetServiceIdentityResponse + type: object + RemoveEnableRulesResponse: + id: RemoveEnableRulesResponse + properties: + parent: + type: string description: >- - Define parameters. Multiple names may be defined for a parameter. - For a given method call, only one of them should be used. If - multiple names are used the behavior is implementation-dependent. If - none of the specified names are present the behavior is - parameter-dependent. + The parent consumer policy. It can be + `projects/12345/consumerPolicies/default`, or + `folders/12345/consumerPolicies/default`, or + `organizations/12345/consumerPolicies/default`. + removedValues: items: - $ref: '#/components/schemas/SystemParameter' + type: string + description: The values removed from the parent consumer policy. + deprecated: true type: array - description: >- - Define a system parameter rule mapping system parameter definitions to - methods. - id: SystemParameterRule + description: The response message of `RemoveEnableRules` method. type: object - OAuthRequirements: + Control: properties: - canonicalScopes: - description: >- - The list of publicly documented OAuth scopes that are allowed - access. An OAuth token containing any of these scopes will be - accepted. Example: canonical_scopes: - https://www.googleapis.com/auth/calendar, - https://www.googleapis.com/auth/calendar.read + environment: type: string - id: OAuthRequirements - type: object - description: >- - OAuth scopes are a way to define data and permissions on data. For - example, there are scopes defined for "Read-only access to Google - Calendar" and "Access to Cloud Platform". Users can consent to a scope - for an application, giving it permission to access that data on their - behalf. OAuth scope specifications should be fairly coarse grained; a - user will need to see and understand the text description of what your - scope means. In most cases: use one or at most two OAuth scopes for an - entire family of products. If your product has multiple APIs, you should - probably be sharing the OAuth scope across all of those APIs. When you - need finer grained OAuth consent screens: talk with your product - management about how developers will use them in practice. Please note - that even though each of the canonical scopes is enough for a request to - be accepted and passed to the backend, a request can still fail due to - the backend requiring additional scopes or permissions. - LabelDescriptor: - id: LabelDescriptor - description: A description of a label. + description: >- + The service controller environment to use. If empty, no control + plane feature (like quota and billing) will be enabled. The + recommended value for most services is servicecontrol.googleapis.com + methodPolicies: + items: + $ref: '#/components/schemas/MethodPolicy' + description: Defines policies applying to the API methods of the service. + type: array type: object - properties: - valueType: - description: The type of data that can be assigned to the label. - type: string - enum: - - STRING - - BOOL - - INT64 - enumDescriptions: - - A variable-length string. This is the default. - - Boolean; true or false. - - A 64-bit signed integer. - description: - description: A human-readable description for the label. - type: string - key: - description: The label key. - type: string - GoogleApiServiceusageV2betaConsumerPolicy: description: >- - Consumer Policy is a set of rules that define what services or service - groups can be used for a cloud resource hierarchy. + Selects and configures the service controller used by the service. + Example: control: environment: servicecontrol.googleapis.com + id: Control + GoogleApiServiceusageV2betaAnalysis: type: object + id: GoogleApiServiceusageV2betaAnalysis + description: A message to group the analysis information. properties: - updateTime: - format: google-datetime - description: Output only. The time the policy was last updated. - readOnly: true - type: string - etag: + displayName: type: string description: >- - Output only. An opaque tag indicating the current version of the - policy, used for concurrency control. - readOnly: true - annotations: - type: object - description: >- - Optional. Annotations is an unstructured key-value map stored with a - policy that may be set by external tools to store and retrieve - arbitrary metadata. They are not queryable and should be preserved - when modifying objects. - [AIP-128](https://google.aip.dev/128#annotations) - additionalProperties: - type: string - name: - description: >- - Output only. The resource name of the policy. Only the `default` - policy is supported: `projects/12345/consumerPolicies/default`, - `folders/12345/consumerPolicies/default`, - `organizations/12345/consumerPolicies/default`. + Output only. The user friendly display name of the analysis type. + E.g. service dependency analysis, service resource usage analysis, + etc. readOnly: true + analysisType: + enum: + - ANALYSIS_TYPE_UNSPECIFIED + - ANALYSIS_TYPE_DEPENDENCY + - ANALYSIS_TYPE_RESOURCE_USAGE type: string - enableRules: - type: array - items: - $ref: '#/components/schemas/GoogleApiServiceusageV2betaEnableRule' - description: >- - Enable rules define usable services, groups, and categories. There - can currently be at most one `EnableRule`. This restriction will be - lifted in later releases. - createTime: + description: Output only. The type of analysis. + enumDescriptions: + - Unspecified analysis type. Do not use. + - The analysis of service dependencies. + - The analysis of service resource usage. readOnly: true + service: description: >- - Output only. The time the policy was created. For singleton - policies, this is the first touch of the policy. - type: string - format: google-datetime - id: GoogleApiServiceusageV2betaConsumerPolicy - MethodPolicy: - description: Defines policies applying to an RPC method. - properties: - selector: + The names of the service that has analysis result of warnings or + blockers. Example: `services/storage.googleapis.com`. type: string - description: >- - Selects a method to which these policies should be enforced, for - example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to - selector for syntax details. NOTE: This field must not be set in the - proto annotation. It will be automatically filled by the service - config compiler . - requestPolicies: - type: array - description: Policies that are applicable to the request message. - items: - $ref: '#/components/schemas/FieldPolicy' - id: MethodPolicy + analysisResult: + $ref: '#/components/schemas/GoogleApiServiceusageV2betaAnalysisResult' + description: Output only. Analysis result of updating a policy. + readOnly: true + GoogleApiServiceusageV2alphaUpdateConsumerPolicyMetadata: type: object - LongRunning: + properties: {} + description: Metadata for the `UpdateConsumerPolicy` method. + id: GoogleApiServiceusageV2alphaUpdateConsumerPolicyMetadata + AddEnableRulesResponse: properties: - initialPollDelay: + parent: type: string description: >- - Initial delay after which the first poll request will be made. - Default value: 5 seconds. - format: google-duration - pollDelayMultiplier: - format: float - type: number - description: >- - Multiplier to gradually increase delay between subsequent polls - until it reaches max_poll_delay. Default value: 1.5. - maxPollDelay: - type: string - format: google-duration + The parent consumer policy. It can be + `projects/12345/consumerPolicies/default`, or + `folders/12345/consumerPolicies/default`, or + `organizations/12345/consumerPolicies/default`. + addedValues: + items: + type: string + description: The values added to the parent consumer policy. + type: array + type: object + id: AddEnableRulesResponse + description: The response message of `AddEnableRules` method. + OAuthRequirements: + id: OAuthRequirements + properties: + canonicalScopes: description: >- - Maximum time between two subsequent poll requests. Default value: 45 - seconds. - totalPollTimeout: + The list of publicly documented OAuth scopes that are allowed + access. An OAuth token containing any of these scopes will be + accepted. Example: canonical_scopes: + https://www.googleapis.com/auth/calendar, + https://www.googleapis.com/auth/calendar.read type: string - format: google-duration - description: 'Total polling timeout. Default value: 5 minutes.' - id: LongRunning - type: object description: >- - Describes settings to use when generating API methods that use the - long-running operation pattern. All default values below are from those - used in the client library generators (e.g. - [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)). - AddEnableRulesMetadata: + OAuth scopes are a way to define data and permissions on data. For + example, there are scopes defined for "Read-only access to Google + Calendar" and "Access to Cloud Platform". Users can consent to a scope + for an application, giving it permission to access that data on their + behalf. OAuth scope specifications should be fairly coarse grained; a + user will need to see and understand the text description of what your + scope means. In most cases: use one or at most two OAuth scopes for an + entire family of products. If your product has multiple APIs, you should + probably be sharing the OAuth scope across all of those APIs. When you + need finer grained OAuth consent screens: talk with your product + management about how developers will use them in practice. Please note + that even though each of the canonical scopes is enough for a request to + be accepted and passed to the backend, a request can still fail due to + the backend requiring additional scopes or permissions. type: object - description: Metadata for the `AddEnableRules` method. - properties: {} - id: AddEnableRulesMetadata - Logging: - description: >- - Logging configuration of the service. The following example shows how to - configure logs to be sent to the producer and consumer projects. In the - example, the `activity_history` log is sent to both the producer and - consumer projects, whereas the `purchase_history` log is only sent to - the producer project. monitored_resources: - type: - library.googleapis.com/branch labels: - key: /city description: The city - where the library branch is located in. - key: /name description: The - name of the branch. logs: - name: activity_history labels: - key: - /customer_id - name: purchase_history logging: producer_destinations: - - monitored_resource: library.googleapis.com/branch logs: - - activity_history - purchase_history consumer_destinations: - - monitored_resource: library.googleapis.com/branch logs: - - activity_history - id: Logging + Status: type: object + id: Status + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). properties: - producerDestinations: - items: - $ref: '#/components/schemas/LoggingDestination' + details: description: >- - Logging configurations for sending logs to the producer project. - There can be multiple producer destinations, each one must have a - different monitored resource type. A log can be used in at most one - producer destination. - type: array - consumerDestinations: - type: array + A list of messages that carry the error details. There is a common + set of message types for APIs to use. items: - $ref: '#/components/schemas/LoggingDestination' + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: object + type: array + message: + type: string description: >- - Logging configurations for sending logs to the consumer project. - There can be multiple consumer destinations, each one must have a - different monitored resource type. A log can be used in at most one - consumer destination. - Billing: - id: Billing + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + code: + description: The status code, which should be an enum value of google.rpc.Code. + format: int32 + type: integer + PythonSettings: + type: object + id: PythonSettings properties: - consumerDestinations: - type: array - items: - $ref: '#/components/schemas/BillingDestination' + experimentalFeatures: description: >- - Billing configurations for sending metrics to the consumer project. - There can be multiple consumer destinations per service, each one - must have a different monitored resource type. A metric can be used - in at most one consumer destination. + Experimental features to be included during client library + generation. + $ref: '#/components/schemas/ExperimentalFeatures' + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' + description: Settings for Python client libraries. + QuotaLimit: description: >- - Billing related configuration of the service. The following example - shows how to configure monitored resources and metrics for billing, - `consumer_destinations` is the only supported destination and the - monitored resources need at least one label key - `cloud.googleapis.com/location` to indicate the location of the billing - usage, using different monitored resources between monitoring and - billing is recommended so they can be evolved independently: - monitored_resources: - type: library.googleapis.com/billing_branch - labels: - key: cloud.googleapis.com/location description: | Predefined - label to support billing location restriction. - key: city description: - | Custom label to define the city where the library branch is located - in. - key: name description: Custom label to define the name of the - library branch. metrics: - name: - library.googleapis.com/book/borrowed_count metric_kind: DELTA - value_type: INT64 unit: "1" billing: consumer_destinations: - - monitored_resource: library.googleapis.com/billing_branch metrics: - - library.googleapis.com/book/borrowed_count - type: object - BackendRule: - id: BackendRule - type: object + `QuotaLimit` defines a specific limit that applies over a specified + duration for a limit type. There can be at most one limit for a duration + and limit type combination defined within a `QuotaGroup`. properties: - overridesByRequestProtocol: - additionalProperties: - $ref: '#/components/schemas/BackendRule' - type: object - description: The map between request protocol and the backend address. - pathTranslation: - enumDescriptions: - - '' - - >- - Use the backend address as-is, with no modification to the path. - If the URL pattern contains variables, the variable names and - values will be appended to the query string. If a query string - parameter and a URL pattern variable have the same name, this may - result in duplicate keys in the query string. # Examples Given the - following operation config: Method path: - /api/company/{cid}/user/{uid} Backend address: - https://example.cloudfunctions.net/getUser Requests to the - following request paths will call the backend at the translated - path: Request path: /api/company/widgetworks/user/johndoe - Translated: - https://example.cloudfunctions.net/getUser?cid=widgetworks&uid=johndoe - Request path: /api/company/widgetworks/user/johndoe?timezone=EST - Translated: - https://example.cloudfunctions.net/getUser?timezone=EST&cid=widgetworks&uid=johndoe - - >- - The request path will be appended to the backend address. # - Examples Given the following operation config: Method path: - /api/company/{cid}/user/{uid} Backend address: - https://example.appspot.com Requests to the following request - paths will call the backend at the translated path: Request path: - /api/company/widgetworks/user/johndoe Translated: - https://example.appspot.com/api/company/widgetworks/user/johndoe - Request path: /api/company/widgetworks/user/johndoe?timezone=EST - Translated: - https://example.appspot.com/api/company/widgetworks/user/johndoe?timezone=EST + freeTier: type: string - enum: - - PATH_TRANSLATION_UNSPECIFIED - - CONSTANT_ADDRESS - - APPEND_PATH_TO_ADDRESS - operationDeadline: - type: number description: >- - The number of seconds to wait for the completion of a long running - operation. The default is no deadline. - format: double - minDeadline: - format: double - deprecated: true - description: Deprecated, do not use. - type: number - disableAuth: - type: boolean + Free tier value displayed in the Developers Console for this limit. + The free tier is the number of tokens that will be subtracted from + the billed amount when billing is enabled. This field can only be + set on a limit with duration "1d", in a billable group; it is + invalid on any other limit. If this field is not set, it defaults to + 0, indicating that there is no free tier for this service. Used by + group-based quotas only. + format: int64 + maxLimit: + format: int64 + type: string description: >- - When disable_auth is true, a JWT ID token won't be generated and the - original "Authorization" HTTP header will be preserved. If the - header is used to carry the original token and is expected by the - backend, this field must be set to true to preserve the header. - selector: + Maximum number of tokens that can be consumed during the specified + duration. Client application developers can override the default + limit up to this maximum. If specified, this value cannot be set to + a value less than the default limit. If not specified, it is set to + the default limit. To allow clients to apply overrides with no upper + bound, set this to -1, indicating unlimited maximum quota. Used by + group-based quotas only. + duration: + type: string + description: >- + Duration of this limit in textual notation. Must be "100s" or "1d". + Used by group-based quotas only. + description: + description: >- + Optional. User-visible, extended description for this quota limit. + Should be used only when more context is needed to understand this + limit than provided by the limit's display name (see: + `display_name`). type: string - description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. - protocol: + displayName: type: string description: >- - The protocol used for sending a request to the backend. The - supported values are "http/1.1" and "h2". The default value is - inferred from the scheme in the address field: SCHEME PROTOCOL - http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure - HTTP backends (https://) that support HTTP/2, set this field to "h2" - for improved performance. Configuring this field to non-default - values is only supported for secure HTTP backends. This field will - be ignored for all other backends. See - https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids - for more details on the supported values. - deadline: - type: number - description: >- - The number of seconds to wait for a response from a request. The - default varies based on the request protocol and deployment - environment. - format: double - address: + User-visible display name for this limit. Optional. If not set, the + UI will provide a default display name based on the quota + configuration. This field can be used to override the default + display name generated from the configuration. + metric: type: string description: >- - The address of the API backend. The scheme is used to determine the - backend protocol and security. The following schemes are accepted: - SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// - gRPC None grpcs:// gRPC TLS It is recommended to explicitly include - a scheme. Leaving out the scheme may cause constrasting behaviors - across platforms. If the port is unspecified, the default is: - 80 - for schemes without TLS - 443 for schemes with TLS For HTTP - backends, use protocol to specify the protocol version. - jwtAudience: + The name of the metric this quota limit applies to. The quota limits + with the same metric will be checked together during runtime. The + metric must be defined within the service config. + unit: type: string description: >- - The JWT audience is used when generating a JWT ID token for the - backend. This ID token will be added in the HTTP "authorization" - header, and sent to the backend. - description: A backend rule provides configuration for an individual API element. - UsageRule: - description: >- - Usage configuration rules for the service. NOTE: Under development. Use - this rule to configure unregistered calls for the service. Unregistered - calls are calls that do not contain consumer project identity. (Example: - calls that do not contain an API key). By default, API methods do not - allow unregistered calls, and each method call must be identified by a - consumer project identity. Use this rule to allow/disallow unregistered - calls. Example of an API that wants to allow unregistered calls for - entire service. usage: rules: - selector: "*" allow_unregistered_calls: - true Example of a method that wants to allow unregistered calls. usage: - rules: - selector: "google.example.library.v1.LibraryService.CreateBook" - allow_unregistered_calls: true - properties: - allowUnregisteredCalls: + Specify the unit of the quota limit. It uses the same syntax as + MetricDescriptor.unit. The supported unit kinds are determined by + the quota backend system. Here are some examples: * + "1/min/{project}" for quota per minute per project. Note: the order + of unit components is insignificant. The "1" at the beginning is + required to follow the metric unit syntax. + values: + type: object + additionalProperties: + format: int64 + type: string description: >- - If true, the selected method allows unregistered calls, e.g. calls - that don't identify any user or application. - type: boolean - selector: - type: string + Tiered limit values. You must specify this as a key:value pair, with + an integer value that is the maximum number of requests allowed for + the specified unit. Currently only STANDARD is supported. + name: description: >- - Selects the methods to which this rule applies. Use '*' to indicate - all methods in all APIs. Refer to selector for syntax details. - skipServiceControl: - type: boolean + Name of the quota limit. The name must be provided, and it must be + unique within the service. The name can only include alphanumeric + characters as well as '-'. The maximum length of the limit name is + 64 characters. + type: string + defaultLimit: + format: int64 + type: string description: >- - If true, the selected method should skip service control and the - control plane features, such as quota and billing, will not be - available. This flag is used by Google Cloud Endpoints to bypass - checks for internal methods, such as service health check methods. - id: UsageRule + Default number of tokens that can be consumed during the specified + duration. This is the number of tokens assigned when a client + application developer activates the service for his/her project. + Specifying a value of 0 will block all requests. This can be used if + you are provisioning quota to selected consumers and blocking + others. Similarly, a value of -1 will indicate an unlimited quota. + No other negative values are allowed. Used by group-based quotas + only. type: object - Monitoring: + id: QuotaLimit + EnableFailure: properties: - consumerDestinations: - items: - $ref: '#/components/schemas/MonitoringDestination' - type: array - description: >- - Monitoring configurations for sending metrics to the consumer - project. There can be multiple consumer destinations. A monitored - resource type may appear in multiple monitoring destinations if - different aggregations are needed for different sets of metrics - associated with that monitored resource type. A monitored resource - and metric pair may only be used once in the Monitoring - configuration. - producerDestinations: - description: >- - Monitoring configurations for sending metrics to the producer - project. There can be multiple producer destinations. A monitored - resource type may appear in multiple monitoring destinations if - different aggregations are needed for different sets of metrics - associated with that monitored resource type. A monitored resource - and metric pair may only be used once in the Monitoring - configuration. - type: array - items: - $ref: '#/components/schemas/MonitoringDestination' - description: >- - Monitoring configuration of the service. The example below shows how to - configure monitored resources and metrics for monitoring. In the - example, a monitored resource and two metrics are defined. The - `library.googleapis.com/book/returned_count` metric is sent to both - producer and consumer projects, whereas the - `library.googleapis.com/book/num_overdue` metric is only sent to the - consumer project. monitored_resources: - type: - library.googleapis.com/Branch display_name: "Library Branch" - description: "A branch of a library." launch_stage: GA labels: - key: - resource_container description: "The Cloud container (ie. project id) - for the Branch." - key: location description: "The location of the - library branch." - key: branch_id description: "The id of the branch." - metrics: - name: library.googleapis.com/book/returned_count - display_name: "Books Returned" description: "The count of books that - have been returned." launch_stage: GA metric_kind: DELTA value_type: - INT64 unit: "1" labels: - key: customer_id description: "The id of the - customer." - name: library.googleapis.com/book/num_overdue display_name: - "Books Overdue" description: "The current number of overdue books." - launch_stage: GA metric_kind: GAUGE value_type: INT64 unit: "1" labels: - - key: customer_id description: "The id of the customer." monitoring: - producer_destinations: - monitored_resource: - library.googleapis.com/Branch metrics: - - library.googleapis.com/book/returned_count consumer_destinations: - - monitored_resource: library.googleapis.com/Branch metrics: - - library.googleapis.com/book/returned_count - - library.googleapis.com/book/num_overdue + errorMessage: + description: An error message describing why the service could not be enabled. + type: string + serviceId: + description: The service id of a service that could not be enabled. + type: string + id: EnableFailure type: object - id: Monitoring + description: Provides error messages for the failing services. GoogleApiServiceusageV1Service: - description: A service that is available for use by the consumer. type: object - id: GoogleApiServiceusageV1Service properties: name: - type: string description: >- The resource name of the consumer and service. A valid name would be: - projects/123/services/serviceusage.googleapis.com - state: type: string + config: + description: >- + The service configuration of the available service. Some fields may + be filtered out of the configuration in responses to the + `ListServices` method. These fields are present only in responses to + the `GetService` method. + $ref: '#/components/schemas/GoogleApiServiceusageV1ServiceConfig' + parent: + description: >- + The resource name of the consumer. A valid name would be: - + projects/123 + type: string + state: description: Whether or not the service has been enabled for use by the consumer. enum: - STATE_UNSPECIFIED @@ -2578,992 +2800,1073 @@ components: The service cannot be used by this consumer. It has either been explicitly disabled, or has never been enabled. - The service has been explicitly enabled for use by this consumer. - config: - description: >- - The service configuration of the available service. Some fields may - be filtered out of the configuration in responses to the - `ListServices` method. These fields are present only in responses to - the `GetService` method. - $ref: '#/components/schemas/GoogleApiServiceusageV1ServiceConfig' - parent: type: string - description: >- - The resource name of the consumer. A valid name would be: - - projects/123 - JavaSettings: - description: Settings for Java client libraries. + id: GoogleApiServiceusageV1Service + description: A service that is available for use by the consumer. + ImportAdminQuotaPoliciesResponse: + id: ImportAdminQuotaPoliciesResponse properties: - serviceClassNames: - type: object + policies: + items: + $ref: '#/components/schemas/AdminQuotaPolicy' + type: array + description: The policies that were created from the imported data. + type: object + description: Response message for ImportAdminQuotaPolicies + Option: + type: object + id: Option + description: >- + A protocol buffer option, which can be attached to a message, field, + enumeration, etc. + properties: + value: additionalProperties: - type: string - description: >- - Configure the Java class name to use instead of the service's for - its corresponding generated GAPIC client. Keys are fully-qualified - service names as they appear in the protobuf (including the full the - language_settings.java.interface_names" field in gapic.yaml. API - teams should otherwise use the service name as it appears in the - protobuf. Example of a YAML configuration:: publishing: - java_settings: service_class_names: - google.pubsub.v1.Publisher: - TopicAdmin - google.pubsub.v1.Subscriber: SubscriptionAdmin - libraryPackage: + description: Properties of the object. Contains field @type with type URL. + type: any description: >- - The package name to use in Java. Clobbers the java_package option - set in the protobuf. This should be used **only** by APIs who have - already set the language_settings.java.package_name" field in - gapic.yaml. API teams should use the protobuf java_package option - where possible. Example of a YAML configuration:: publishing: - java_settings: library_package: com.google.cloud.pubsub.v1 + The option's value packed in an Any message. If the value is a + primitive, the corresponding wrapper type defined in + google/protobuf/wrappers.proto should be used. If the value is an + enum, it should be stored as an int32 value using the + google.protobuf.Int32Value type. + type: object + name: type: string - common: - description: Some settings. - $ref: '#/components/schemas/CommonLanguageSettings' + description: >- + The option's name. For protobuf built-in options (options defined in + descriptor.proto), this is the short name. For example, + `"map_entry"`. For custom options, it should be the fully-qualified + name. For example, `"google.api.http"`. + ImportConsumerOverridesMetadata: + properties: {} type: object - id: JavaSettings - GoogleApiServiceusageV2betaEnableRule: description: >- - The consumer policy rule that defines enabled services, groups, and - categories. - type: object - properties: - services: - items: - type: string - type: array - description: >- - The names of the services that are enabled. Example: - `services/storage.googleapis.com`. - id: GoogleApiServiceusageV2betaEnableRule + Metadata message that provides information such as progress, partial + failures, and similar information on each GetOperation call of LRO + returned by ImportConsumerOverrides. + id: ImportConsumerOverridesMetadata NodeSettings: + type: object + description: Settings for Node client libraries. + id: NodeSettings properties: common: - $ref: '#/components/schemas/CommonLanguageSettings' description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' + ConsumerPolicy: type: object - id: NodeSettings - description: Settings for Node client libraries. - Context: - description: >- - `Context` defines which contexts an API requests. Example: context: - rules: - selector: "*" requested: - google.rpc.context.ProjectContext - - google.rpc.context.OriginContext The above specifies that all methods in - the API request `google.rpc.context.ProjectContext` and - `google.rpc.context.OriginContext`. Available context types are defined - in package `google.rpc.context`. This also provides mechanism to - allowlist any protobuf message extension that can be sent in grpc - metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For - example, list any service specific protobuf types that can appear in - grpc metadata as follows in your yaml file: Example: context: rules: - - selector: "google.example.library.v1.LibraryService.CreateBook" - allowed_request_extensions: - google.foo.v1.NewExtension - allowed_response_extensions: - google.foo.v1.NewExtension You can also - specify extension ID instead of fully qualified extension name here. properties: - rules: - items: - $ref: '#/components/schemas/ContextRule' + enableRules: type: array + description: Enable rules define usable services and service groups. + items: + $ref: '#/components/schemas/EnableRule' + annotations: + additionalProperties: + type: string + type: object description: >- - A list of RPC context rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. - id: Context - type: object - LogDescriptor: - properties: - name: - description: >- - The name of the log. It must be less than 512 characters long and - can include the following characters: upper- and lower-case - alphanumeric characters [A-Za-z0-9], and punctuation characters - including slash, underscore, hyphen, period [/_-.]. + Optional. Annotations is an unstructured key-value map stored with a + policy that may be set by external tools to store and retrieve + arbitrary metadata. They are not queryable and should be preserved + when modifying objects. + [AIP-128](https://google.aip.dev/128#annotations) + updateTime: type: string - description: + format: google-datetime + description: The last-modified time. + etag: type: string description: >- - A human-readable description of this log. This information appears - in the documentation and can contain details. - labels: - type: array - description: >- - The set of labels that are available to describe a specific log - entry. Runtime requests that contain labels not specified here are - considered invalid. - items: - $ref: '#/components/schemas/LabelDescriptor' - displayName: + An opaque tag indicating the current version of the policy, used for + concurrency control. + name: + readOnly: true type: string description: >- - The human-readable name for this log. This information appears on - the user interface and should be concise. - type: object - id: LogDescriptor + Output only. The resource name of the policy. We only allow consumer + policy name as `default` for now: + `projects/12345/consumerPolicies/default`, + `folders/12345/consumerPolicies/default`, + `organizations/12345/consumerPolicies/default`. + id: ConsumerPolicy description: >- - A description of a log type. Example in YAML format: - name: - library.googleapis.com/activity_history description: The history of - borrowing and returning library items. display_name: Activity labels: - - key: /customer_id description: Identifier of a library customer - GoogleApiServiceusageV2alphaUpdateConsumerPolicyMetadata: - type: object - id: GoogleApiServiceusageV2alphaUpdateConsumerPolicyMetadata - description: Metadata for the `UpdateConsumerPolicy` method. - properties: {} - GoogleApiServiceusageV2betaAnalysisResult: - id: GoogleApiServiceusageV2betaAnalysisResult - description: An analysis result including blockers and warnings. + Consumer Policy is a set of rules that define what services or service + groups can be used for a cloud resource hierarchy. + Endpoint: type: object properties: - blockers: - type: array - items: - $ref: '#/components/schemas/GoogleApiServiceusageV2betaImpact' + target: + type: string description: >- - Blocking information that would prevent the policy changes at - runtime. - warnings: + The specification of an Internet routable address of API frontend + that will handle requests to this [API + Endpoint](https://cloud.google.com/apis/design/glossary). It should + be either a valid IPv4 address or a fully-qualified domain name. For + example, "8.8.8.8" or "myservice.appspot.com". + allowCors: + type: boolean description: >- - Warning information indicating that the policy changes might be - unsafe, but will not block the changes at runtime. - type: array - items: - $ref: '#/components/schemas/GoogleApiServiceusageV2betaImpact' - Enum: - id: Enum - type: object - properties: - syntax: - enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. - description: The source syntax. - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS - type: string + Allowing + [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), + aka cross-domain traffic, would allow the backends served from this + endpoint to receive and respond to HTTP OPTIONS requests. The + response will be used by the browser to determine whether the + subsequent cross-origin request is allowed to proceed. name: type: string - description: Enum type name. - options: + description: The canonical name of this endpoint. + aliases: type: array - description: Protocol buffer options. + description: >- + Aliases for this endpoint, these will be served by the same UrlMap + as the parent endpoint, and will be provisioned in the GCP stack for + the Regional Endpoints. items: - $ref: '#/components/schemas/Option' - sourceContext: - description: The source context. - $ref: '#/components/schemas/SourceContext' - edition: + type: string + id: Endpoint + description: >- + `Endpoint` describes a network address of a service that serves a set of + APIs. It is commonly known as a service endpoint. A service may expose + any number of service endpoints, and all service endpoints share the + same service definition, such as quota limits and monitoring metrics. + Example: type: google.api.Service name: library-example.googleapis.com + endpoints: # Declares network address + `https://library-example.googleapis.com` # for service + `library-example.googleapis.com`. The `https` scheme # is implicit for + all service endpoints. Other schemes may be # supported in the future. - + name: library-example.googleapis.com allow_cors: false - name: + content-staging-library-example.googleapis.com # Allows HTTP OPTIONS + calls to be passed to the API frontend, for it # to decide whether the + subsequent cross-origin request is allowed # to proceed. allow_cors: + true + BillingDestination: + properties: + monitoredResource: description: >- - The source edition string, only valid when syntax is - SYNTAX_EDITIONS. + The monitored resource type. The type must be defined in + Service.monitored_resources section. type: string - enumvalue: + metrics: items: - $ref: '#/components/schemas/EnumValue' - description: Enum value definitions. + type: string type: array - description: Enum type definition. - AdminQuotaPolicy: - id: AdminQuotaPolicy - description: Quota policy created by quota administrator. + description: >- + Names of the metrics to report to this billing destination. Each + name must be defined in Service.metrics section. + description: >- + Configuration of a specific billing destination (Currently only support + bill against consumer project). + type: object + id: BillingDestination + CustomError: + id: CustomError type: object + description: >- + Customize service error responses. For example, list any service + specific protobuf types that can appear in error detail lists of error + responses. Example: custom_error: types: - google.foo.v1.CustomError - + google.foo.v1.AnotherError properties: - dimensions: - additionalProperties: - type: string - description: ' If this map is nonempty, then this policy applies only to specific values for dimensions defined in the limit unit. For example, a policy on a limit with the unit `1/{project}/{region}` could contain an entry with the key `region` and the value `us-east-1`; the policy is only applied to quota consumed in that region. This map has the following restrictions: * If `region` appears as a key, its value must be a valid Cloud region. * If `zone` appears as a key, its value must be a valid Cloud zone. * Keys other than `region` or `zone` are not valid.' - type: object - container: - type: string - description: >- - The cloud resource container at which the quota policy is created. - The format is `{container_type}/{container_number}` - name: - type: string - description: >- - The resource name of the policy. This name is generated by the - server when the policy is created. Example names would be: - `organizations/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminQuotaPolicies/4a3f2c1d` - metric: - type: string - description: >- - The name of the metric to which this policy applies. An example name - would be: `compute.googleapis.com/cpus` - policyValue: + rules: + type: array description: >- - The quota policy value. Can be any nonnegative integer, or -1 - (unlimited quota). - type: string - format: int64 - unit: - type: string + The list of custom error rules that apply to individual API + messages. **NOTE:** All service configuration rules follow "last one + wins" order. + items: + $ref: '#/components/schemas/CustomErrorRule' + types: description: >- - The limit unit of the limit to which this policy applies. An example - unit would be: `1/{project}/{region}` Note that `{project}` and - `{region}` are not placeholders in this example; the literal - characters `{` and `}` occur in the string. - PhpSettings: + The list of custom error detail types, e.g. + 'google.foo.v1.CustomError'. + items: + type: string + type: array + GoogleApiServiceusageV1OperationMetadata: type: object - id: PhpSettings properties: - common: - description: Some settings. - $ref: '#/components/schemas/CommonLanguageSettings' - description: Settings for Php client libraries. + resourceNames: + type: array + description: >- + The full name of the resources that this operation is directly + associated with. + items: + type: string + id: GoogleApiServiceusageV1OperationMetadata + description: The operation metadata returned for the batchend services operation. ListServicesResponse: - description: Response message for the `ListServices` method. - type: object id: ListServicesResponse properties: services: - type: array - description: The available services for the requested project. items: $ref: '#/components/schemas/GoogleApiServiceusageV1Service' + type: array + description: The available services for the requested project. nextPageToken: type: string description: >- Token that can be passed to `ListServices` to resume a paginated query. - Authentication: - id: Authentication type: object - properties: - providers: - type: array - description: Defines a set of authentication providers that a service supports. - items: - $ref: '#/components/schemas/AuthProvider' - rules: - items: - $ref: '#/components/schemas/AuthenticationRule' - type: array - description: >- - A list of authentication rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. - description: >- - `Authentication` defines the authentication configuration for API - methods provided by an API service. Example: name: - calendar.googleapis.com authentication: providers: - id: - google_calendar_auth jwks_uri: - https://www.googleapis.com/oauth2/v1/certs issuer: - https://securetoken.google.com rules: - selector: "*" requirements: - provider_id: google_calendar_auth - selector: google.calendar.Delegate - oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read - PythonSettings: + description: Response message for the `ListServices` method. + CppSettings: + id: CppSettings type: object - id: PythonSettings - description: Settings for Python client libraries. properties: - experimentalFeatures: - description: >- - Experimental features to be included during client library - generation. - $ref: '#/components/schemas/ExperimentalFeatures' common: - description: Some settings. $ref: '#/components/schemas/CommonLanguageSettings' - Mixin: - id: Mixin + description: Some settings. + description: Settings for C++ client libraries. + LongRunning: + properties: + pollDelayMultiplier: + format: float + type: number + description: >- + Multiplier to gradually increase delay between subsequent polls + until it reaches max_poll_delay. Default value: 1.5. + totalPollTimeout: + type: string + format: google-duration + description: 'Total polling timeout. Default value: 5 minutes.' + maxPollDelay: + type: string + format: google-duration + description: >- + Maximum time between two subsequent poll requests. Default value: 45 + seconds. + initialPollDelay: + format: google-duration + type: string + description: >- + Initial delay after which the first poll request will be made. + Default value: 5 seconds. + id: LongRunning type: object description: >- - Declares an API Interface to be included in this interface. The - including interface must redeclare all the methods from the included - interface, but documentation and options are inherited as follows: - If - after comment and whitespace stripping, the documentation string of the - redeclared method is empty, it will be inherited from the original - method. - Each annotation belonging to the service config (http, - visibility) which is not set in the redeclared method will be inherited. - - If an http annotation is inherited, the path pattern will be modified - as follows. Any version prefix will be replaced by the version of the - including interface plus the root path if specified. Example of a simple - mixin: package google.acl.v1; service AccessControl { // Get the - underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option - (google.api.http).get = "/v1/{resource=**}:getAcl"; } } package - google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) - returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns - (Data) { option (google.api.http).get = "/v2/{resource=**}"; } } Example - of a mixin configuration: apis: - name: google.storage.v2.Storage - mixins: - name: google.acl.v1.AccessControl The mixin construct implies - that all methods in `AccessControl` are also declared with same name and - request/response types in `Storage`. A documentation generator or - annotation processor will see the effective `Storage.GetAcl` method - after inheriting documentation and annotations as follows: service - Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) - returns (Acl) { option (google.api.http).get = - "/v2/{resource=**}:getAcl"; } ... } Note how the version in the path - pattern changed from `v1` to `v2`. If the `root` field in the mixin is - specified, it should be a relative path under which inherited HTTP paths - are placed. Example: apis: - name: google.storage.v2.Storage mixins: - - name: google.acl.v1.AccessControl root: acls This implies the following - inherited HTTP annotation: service Storage { // Get the underlying ACL - object. rpc GetAcl(GetAclRequest) returns (Acl) { option - (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; } ... } + Describes settings to use when generating API methods that use the + long-running operation pattern. All default values below are from those + used in the client library generators (e.g. + [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)). + Method: + id: Method properties: - root: - description: >- - If non-empty specifies a path under which inherited HTTP paths are - rooted. + responseStreaming: + type: boolean + description: If true, the response is streamed. + syntax: + description: The source syntax of this method. type: string + enumDescriptions: + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS + options: + description: Any metadata attached to the method. + type: array + items: + $ref: '#/components/schemas/Option' name: - description: The fully qualified name of the interface which is included. type: string - RubySettings: - properties: - common: - description: Some settings. - $ref: '#/components/schemas/CommonLanguageSettings' - id: RubySettings - description: Settings for Ruby client libraries. + description: The simple name of this method. + requestTypeUrl: + type: string + description: A URL of the input message type. + responseTypeUrl: + description: The URL of the output message type. + type: string + requestStreaming: + type: boolean + description: If true, the request is streamed. type: object - CommonLanguageSettings: + description: Method represents a method of an API interface. + Page: type: object - id: CommonLanguageSettings + id: Page properties: - selectiveGapicGeneration: + content: + type: string description: >- - Configuration for which RPCs should be generated in the GAPIC - client. - $ref: '#/components/schemas/SelectiveGapicGeneration' - referenceDocsUri: + The Markdown content of the page. You can use ```(== include {path} + ==)``` to include content from a Markdown file. The content can be + used to produce the documentation page such as HTML format page. + subpages: + type: array + items: + $ref: '#/components/schemas/Page' + description: >- + Subpages of this page. The order of subpages specified here will be + honored in the generated docset. + name: type: string description: >- - Link to automatically generated reference documentation. Example: - https://cloud.google.com/nodejs/docs/reference/asset/latest - deprecated: true - destinations: + The name of the page. It will be used as an identity of the page to + generate URI of the page, text of the link to this page in + navigation, etc. The full page name (start from the root page name + to this page concatenated with `.`) can be used as reference to the + page in your documentation. For example: pages: - name: Tutorial + content: (== include tutorial.md ==) subpages: - name: Java content: + (== include tutorial_java.md ==) You can reference `Java` page using + Markdown reference link syntax: `Java`. + description: >- + Represents a documentation page. A page can contain subpages to + represent nested documentation set structure. + Api: + id: Api + description: >- + Api is a light-weight descriptor for an API Interface. Interfaces are + also described as "protocol buffer services" in some contexts, such as + by the "service" keyword in a .proto file, but they are different from + API Services, which represent a concrete implementation of an interface + as opposed to simply a description of methods and bindings. They are + also sometimes simply referred to as "APIs" in other contexts, such as + the name of this message itself. See + https://cloud.google.com/apis/design/glossary for detailed terminology. + type: object + properties: + sourceContext: description: >- - The destination where API teams want this client library to be - published. + Source context for the protocol buffer service represented by this + message. + $ref: '#/components/schemas/SourceContext' + mixins: + type: array items: - enum: - - CLIENT_LIBRARY_DESTINATION_UNSPECIFIED - - GITHUB - - PACKAGE_MANAGER - type: string - enumDescriptions: - - >- - Client libraries will neither be generated nor published to - package managers. - - >- - Generate the client library in a repo under - github.com/googleapis, but don't publish it to package managers. - - >- - Publish the library to package managers like nuget.org and - npmjs.com. + $ref: '#/components/schemas/Mixin' + description: Included interfaces. See Mixin. + name: + type: string + description: >- + The fully qualified name of this interface, including package name + followed by the interface's simple name. + syntax: + type: string + description: The source syntax of the service. + enumDescriptions: + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS + methods: + description: The methods of this interface, in unspecified order. + type: array + items: + $ref: '#/components/schemas/Method' + version: + description: >- + A version string for this interface. If specified, must have the + form `major-version.minor-version`, as in `1.10`. If the minor + version is omitted, it defaults to zero. If the entire version field + is empty, the major version is derived from the package name, as + outlined below. If the field is not empty, the version in the + package name will be verified to be consistent with what is provided + here. The versioning schema uses [semantic + versioning](http://semver.org) where the major version number + indicates a breaking change and the minor version an additive, + non-breaking change. Both version numbers are signals to users what + to expect from different versions, and should be carefully chosen + based on the product plan. The major version is also reflected in + the package name of the interface, which must end in `v`, as in + `google.feature.v1`. For major versions 0 and 1, the suffix can be + omitted. Zero major versions must only be used for experimental, + non-GA interfaces. + type: string + options: type: array - description: Required information for every language. - Impact: + items: + $ref: '#/components/schemas/Option' + description: Any metadata attached to the interface. + GetServiceIdentityMetadata: + id: GetServiceIdentityMetadata type: object - id: Impact - description: A message to group impacts of updating a policy. + description: Metadata for the `GetServiceIdentity` method. + properties: {} + GetServiceIdentityResponse: + type: object + description: Response message for getting service identity. + id: GetServiceIdentityResponse properties: - detail: - description: Output only. User friendly impact detail in a free form message. - type: string - readOnly: true - impactType: - description: Output only. The type of impact. - readOnly: true + state: + description: Service identity state. type: string + enum: + - IDENTITY_STATE_UNSPECIFIED + - ACTIVE enumDescriptions: - >- - Reserved Blocks (Block n contains codes from 100n to 100(n+1) -1 - Block 0 - Special/Admin codes Block 1 - Impact Type of - ANALYSIS_TYPE_DEPENDENCY Block 2 - Impact Type of - ANALYSIS_TYPE_RESOURCE_USAGE ... - - Block 1 - Impact Type of ANALYSIS_TYPE_DEPENDENCY - enum: - - IMPACT_TYPE_UNSPECIFIED - - DEPENDENCY_MISSING_DEPENDENCIES - ListOperationsResponse: - id: ListOperationsResponse + Default service identity state. This value is used if the state is + omitted. + - Service identity has been created and can be used. + identity: + description: >- + Service identity that service producer can use to access consumer + resources. If exists is true, it contains email and unique_id. If + exists is false, it contains pre-constructed email and empty + unique_id. + $ref: '#/components/schemas/ServiceIdentity' + EnumValue: + description: Enum value definition. + type: object properties: - nextPageToken: - description: The standard List next-page token. - type: string - operations: + number: + type: integer + format: int32 + description: Enum value number. + options: type: array - description: >- - A list of operations that matches the specified filter in the - request. + description: Protocol buffer options. items: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Option' + name: + type: string + description: Enum value name. + id: EnumValue + RubySettings: type: object - description: The response message for Operations.ListOperations. - QuotaLimit: + id: RubySettings + description: Settings for Ruby client libraries. + properties: + common: + $ref: '#/components/schemas/CommonLanguageSettings' + description: Some settings. + LogDescriptor: + id: LogDescriptor description: >- - `QuotaLimit` defines a specific limit that applies over a specified - duration for a limit type. There can be at most one limit for a duration - and limit type combination defined within a `QuotaGroup`. - id: QuotaLimit + A description of a log type. Example in YAML format: - name: + library.googleapis.com/activity_history description: The history of + borrowing and returning library items. display_name: Activity labels: - + key: /customer_id description: Identifier of a library customer type: object properties: - maxLimit: - type: string - description: >- - Maximum number of tokens that can be consumed during the specified - duration. Client application developers can override the default - limit up to this maximum. If specified, this value cannot be set to - a value less than the default limit. If not specified, it is set to - the default limit. To allow clients to apply overrides with no upper - bound, set this to -1, indicating unlimited maximum quota. Used by - group-based quotas only. - format: int64 - metric: - description: >- - The name of the metric this quota limit applies to. The quota limits - with the same metric will be checked together during runtime. The - metric must be defined within the service config. - type: string - values: - additionalProperties: - format: int64 - type: string + labels: + type: array description: >- - Tiered limit values. You must specify this as a key:value pair, with - an integer value that is the maximum number of requests allowed for - the specified unit. Currently only STANDARD is supported. - type: object + The set of labels that are available to describe a specific log + entry. Runtime requests that contain labels not specified here are + considered invalid. + items: + $ref: '#/components/schemas/LabelDescriptor' name: - type: string description: >- - Name of the quota limit. The name must be provided, and it must be - unique within the service. The name can only include alphanumeric - characters as well as '-'. The maximum length of the limit name is - 64 characters. - duration: + The name of the log. It must be less than 512 characters long and + can include the following characters: upper- and lower-case + alphanumeric characters [A-Za-z0-9], and punctuation characters + including slash, underscore, hyphen, period [/_-.]. type: string + displayName: description: >- - Duration of this limit in textual notation. Must be "100s" or "1d". - Used by group-based quotas only. + The human-readable name for this log. This information appears on + the user interface and should be concise. + type: string description: - description: >- - Optional. User-visible, extended description for this quota limit. - Should be used only when more context is needed to understand this - limit than provided by the limit's display name (see: - `display_name`). type: string - defaultLimit: + description: >- + A human-readable description of this log. This information appears + in the documentation and can contain details. + Documentation: + properties: + overview: type: string description: >- - Default number of tokens that can be consumed during the specified - duration. This is the number of tokens assigned when a client - application developer activates the service for his/her project. - Specifying a value of 0 will block all requests. This can be used if - you are provisioning quota to selected consumers and blocking - others. Similarly, a value of -1 will indicate an unlimited quota. - No other negative values are allowed. Used by group-based quotas - only. - format: int64 - unit: + Declares a single overview page. For example: documentation: + summary: ... overview: (== include overview.md ==) This is a + shortcut for the following declaration (using pages style): + documentation: summary: ... pages: - name: Overview content: (== + include overview.md ==) Note: you cannot specify both `overview` + field and `pages` field. + serviceRootUrl: description: >- - Specify the unit of the quota limit. It uses the same syntax as - Metric.unit. The supported unit kinds are determined by the quota - backend system. Here are some examples: * "1/min/{project}" for - quota per minute per project. Note: the order of unit components is - insignificant. The "1" at the beginning is required to follow the - metric unit syntax. + Specifies the service root url if the default one (the service name + from the yaml file) is not suitable. This can be seen in any fully + specified service urls as well as sections that show a base that + other urls are relative to. type: string - displayName: + sectionOverrides: + items: + $ref: '#/components/schemas/Page' description: >- - User-visible display name for this limit. Optional. If not set, the - UI will provide a default display name based on the quota - configuration. This field can be used to override the default - display name generated from the configuration. - type: string - freeTier: + Specifies section and content to override the boilerplate content. + Currently overrides following sections: 1. + rest.service.client_libraries + type: array + rules: + type: array description: >- - Free tier value displayed in the Developers Console for this limit. - The free tier is the number of tokens that will be subtracted from - the billed amount when billing is enabled. This field can only be - set on a limit with duration "1d", in a billable group; it is - invalid on any other limit. If this field is not set, it defaults to - 0, indicating that there is no free tier for this service. Used by - group-based quotas only. - format: int64 - type: string - Control: - properties: - methodPolicies: - description: Defines policies applying to the API methods of the service. + A list of documentation rules that apply to individual API elements. + **NOTE:** All service configuration rules follow "last one wins" + order. + items: + $ref: '#/components/schemas/DocumentationRule' + pages: + description: The top level pages for the documentation set. type: array items: - $ref: '#/components/schemas/MethodPolicy' - environment: + $ref: '#/components/schemas/Page' + additionalIamInfo: description: >- - The service controller environment to use. If empty, no control - plane feature (like quota and billing) will be enabled. The - recommended value for most services is servicecontrol.googleapis.com + Optional information about the IAM configuration. This is typically + used to link to documentation about a product's IAM roles and + permissions. + type: string + summary: + description: >- + A short description of what the service does. The summary must be + plain text. It becomes the overview of the service displayed in + Google Cloud Console. NOTE: This field is equivalent to the standard + field `description`. + type: string + documentationRootUrl: + description: The URL to the root of documentation. type: string - id: Control type: object description: >- - Selects and configures the service controller used by the service. - Example: control: environment: servicecontrol.googleapis.com - ImportConsumerOverridesResponse: - description: Response message for ImportConsumerOverrides - id: ImportConsumerOverridesResponse + `Documentation` provides the information for describing a service. + Example: documentation: summary: > The Google Calendar API gives access + to most calendar features. pages: - name: Overview content: (== include + google/foo/overview.md ==) - name: Tutorial content: (== include + google/foo/tutorial.md ==) subpages: - name: Java content: (== include + google/foo/tutorial_java.md ==) rules: - selector: + google.calendar.Calendar.Get description: > ... - selector: + google.calendar.Calendar.Put description: > ... Documentation is + provided in markdown syntax. In addition to standard markdown features, + definition lists, tables and fenced code blocks are supported. Section + headers can be provided and are interpreted relative to the section + nesting of the context where a documentation fragment is embedded. + Documentation from the IDL is merged with documentation defined via the + config at normalization time, where documentation provided by config + rules overrides IDL provided. A number of constructs specific to the API + platform are supported in documentation text. In order to reference a + proto element, the following notation can be used: + [fully.qualified.proto.name][] To override the display text used for the + link, this can be used: [display text][fully.qualified.proto.name] Text + can be excluded from doc using the following notation: (-- internal + comment --) A few directives are available in documentation. Note that + directives must appear on a single line to be properly identified. The + `include` directive includes a markdown file from an external source: + (== include path/to/file ==) The `resource_for` directive marks a + message to be the resource of a collection in REST view. If it is not + specified, tools attempt to infer the resource from the operations in a + collection: (== resource_for v1.shelves.books ==) The directive + `suppress_warning` does not directly affect documentation and is + documented together with service config validation. + id: Documentation + Quota: properties: - overrides: + limits: type: array - description: The overrides that were created from the imported data. items: - $ref: '#/components/schemas/QuotaOverride' - type: object - SelectiveGapicGeneration: - type: object - properties: - methods: + $ref: '#/components/schemas/QuotaLimit' + description: List of QuotaLimit definitions for the service. + metricRules: type: array - description: >- - An allowlist of the fully qualified names of RPCs that should be - included on public client surfaces. items: - type: string - id: SelectiveGapicGeneration + $ref: '#/components/schemas/MetricRule' + description: >- + List of MetricRule definitions, each one mapping a selected method + to one or more metrics. + id: Quota description: >- - This message is used to configure the generation of a subset of the RPCs - in a service for client libraries. - MetricDescriptor: + Quota configuration helps to achieve fairness and budgeting in service + usage. The metric based quota configuration works this way: - The + service configuration defines a set of metrics. - For API calls, the + quota.metric_rules maps methods to metrics with corresponding costs. - + The quota.limits defines limits on the metrics, which will be used for + quota checks at runtime. An example quota configuration in yaml format: + quota: limits: - name: apiWriteQpsPerProject metric: + library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit + for consumer projects values: STANDARD: 10000 (The metric rules bind all + methods to the read_calls metric, except for the UpdateBook and + DeleteBook methods. These two methods are mapped to the write_calls + metric, with the UpdateBook method consuming at twice rate as the + DeleteBook method.) metric_rules: - selector: "*" metric_costs: + library.googleapis.com/read_calls: 1 - selector: + google.example.library.v1.LibraryService.UpdateBook metric_costs: + library.googleapis.com/write_calls: 2 - selector: + google.example.library.v1.LibraryService.DeleteBook metric_costs: + library.googleapis.com/write_calls: 1 Corresponding Metric definition: + metrics: - name: library.googleapis.com/read_calls display_name: Read + requests metric_kind: DELTA value_type: INT64 - name: + library.googleapis.com/write_calls display_name: Write requests + metric_kind: DELTA value_type: INT64 + type: object + JavaSettings: + description: Settings for Java client libraries. properties: - name: - type: string - description: The resource name of the metric descriptor. - metadata: - $ref: '#/components/schemas/MetricDescriptorMetadata' - description: Optional. Metadata which can be used to guide usage of the metric. - description: + serviceClassNames: + type: object + additionalProperties: + type: string description: >- - A detailed description of the metric, which can be used in - documentation. - type: string - type: - type: string + Configure the Java class name to use instead of the service's for + its corresponding generated GAPIC client. Keys are fully-qualified + service names as they appear in the protobuf (including the full the + language_settings.java.interface_names" field in gapic.yaml. API + teams should otherwise use the service name as it appears in the + protobuf. Example of a YAML configuration:: publishing: + java_settings: service_class_names: - google.pubsub.v1.Publisher: + TopicAdmin - google.pubsub.v1.Subscriber: SubscriptionAdmin + common: + $ref: '#/components/schemas/CommonLanguageSettings' + description: Some settings. + libraryPackage: description: >- - The metric type, including its DNS name prefix. The type is not - URL-encoded. All user-defined metric types have the DNS name - `custom.googleapis.com` or `external.googleapis.com`. Metric types - should use a natural hierarchical grouping. For example: - "custom.googleapis.com/invoice/paid/amount" - "external.googleapis.com/prometheus/up" - "appengine.googleapis.com/http/server/response_latencies" - launchStage: - description: Optional. The launch stage of the metric definition. + The package name to use in Java. Clobbers the java_package option + set in the protobuf. This should be used **only** by APIs who have + already set the language_settings.java.package_name" field in + gapic.yaml. API teams should use the protobuf java_package option + where possible. Example of a YAML configuration:: publishing: + library_settings: java_settings: library_package: + com.google.cloud.pubsub.v1 type: string - enum: - - LAUNCH_STAGE_UNSPECIFIED - - UNIMPLEMENTED - - PRELAUNCH - - EARLY_ACCESS - - ALPHA - - BETA - - GA - - DEPRECATED - enumDescriptions: - - Do not use this default value. - - The feature is not yet implemented. Users can not use it. - - >- - Prelaunch features are hidden from users and are only visible - internally. - - >- - Early Access features are limited to a closed group of testers. To - use these features, you must sign up in advance and sign a Trusted - Tester agreement (which includes confidentiality provisions). - These features may be unstable, changed in backward-incompatible - ways, and are not guaranteed to be released. - - >- - Alpha is a limited availability test for releases before they are - cleared for widespread use. By Alpha, all significant design - issues are resolved and we are in the process of verifying - functionality. Alpha customers need to apply for access, agree to - applicable terms, and have their projects allowlisted. Alpha - releases don't have to be feature complete, no SLAs are provided, - and there are no technical support obligations, but they will be - far enough along that customers can actually use them in test - environments or for limited-use tests -- just like they would in - normal production cases. - - >- - Beta is the point at which we are ready to open a release for any - customer to use. There are no SLA or technical support obligations - in a Beta release. Products will be complete from a feature - perspective, but may have some open outstanding issues. Beta - releases are suitable for limited production use cases. - - >- - GA features are open to all developers and are considered stable - and fully qualified for production use. - - >- - Deprecated features are scheduled to be shut down and removed. For - more information, see the "Deprecation Policy" section of our - [Terms of Service](https://cloud.google.com/terms/) and the - [Google Cloud Platform Subject to the Deprecation - Policy](https://cloud.google.com/terms/deprecation) documentation. - metricKind: - enum: - - METRIC_KIND_UNSPECIFIED - - GAUGE - - DELTA - - CUMULATIVE - description: >- - Whether the metric records instantaneous values, changes to a value, - etc. Some combinations of `metric_kind` and `value_type` might not - be supported. + id: JavaSettings + type: object + CustomHttpPattern: + id: CustomHttpPattern + description: A custom pattern is used for defining custom HTTP verb. + properties: + kind: + description: The name of this custom HTTP verb. type: string - enumDescriptions: - - Do not use this default value. - - An instantaneous measurement of a value. - - The change in a value during a time interval. - - >- - A value accumulated over a time interval. Cumulative measurements - in a time series should have the same start time and increasing - end times, until an event resets the cumulative value to zero and - sets a new start time for the following points. - valueType: - enumDescriptions: - - Do not use this default value. - - >- - The value is a boolean. This value type can be used only if the - metric kind is `GAUGE`. - - The value is a signed 64-bit integer. - - The value is a double precision floating point number. - - >- - The value is a text string. This value type can be used only if - the metric kind is `GAUGE`. - - The value is a `Distribution`. - - The value is money. - description: >- - Whether the measurement is an integer, a floating-point number, etc. - Some combinations of `metric_kind` and `value_type` might not be - supported. - enum: - - VALUE_TYPE_UNSPECIFIED - - BOOL - - INT64 - - DOUBLE - - STRING - - DISTRIBUTION - - MONEY + path: + description: The path matched by this custom verb. + type: string + type: object + CreateAdminQuotaPolicyMetadata: + properties: {} + type: object + description: >- + Metadata message that provides information such as progress, partial + failures, and similar information on each GetOperation call of LRO + returned by CreateAdminQuotaPolicy. + id: CreateAdminQuotaPolicyMetadata + UpdateConsumerPolicyMetadata: + id: UpdateConsumerPolicyMetadata + type: object + description: Metadata for the `UpdateConsumerPolicy` method. + properties: {} + Mixin: + type: object + description: >- + Declares an API Interface to be included in this interface. The + including interface must redeclare all the methods from the included + interface, but documentation and options are inherited as follows: - If + after comment and whitespace stripping, the documentation string of the + redeclared method is empty, it will be inherited from the original + method. - Each annotation belonging to the service config (http, + visibility) which is not set in the redeclared method will be inherited. + - If an http annotation is inherited, the path pattern will be modified + as follows. Any version prefix will be replaced by the version of the + including interface plus the root path if specified. Example of a simple + mixin: package google.acl.v1; service AccessControl { // Get the + underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option + (google.api.http).get = "/v1/{resource=**}:getAcl"; } } package + google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) + returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns + (Data) { option (google.api.http).get = "/v2/{resource=**}"; } } Example + of a mixin configuration: apis: - name: google.storage.v2.Storage + mixins: - name: google.acl.v1.AccessControl The mixin construct implies + that all methods in `AccessControl` are also declared with same name and + request/response types in `Storage`. A documentation generator or + annotation processor will see the effective `Storage.GetAcl` method + after inheriting documentation and annotations as follows: service + Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) + returns (Acl) { option (google.api.http).get = + "/v2/{resource=**}:getAcl"; } ... } Note how the version in the path + pattern changed from `v1` to `v2`. If the `root` field in the mixin is + specified, it should be a relative path under which inherited HTTP paths + are placed. Example: apis: - name: google.storage.v2.Storage mixins: - + name: google.acl.v1.AccessControl root: acls This implies the following + inherited HTTP annotation: service Storage { // Get the underlying ACL + object. rpc GetAcl(GetAclRequest) returns (Acl) { option + (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; } ... } + properties: + name: + description: The fully qualified name of the interface which is included. type: string - labels: - items: - $ref: '#/components/schemas/LabelDescriptor' + root: description: >- - The set of labels that can be used to describe a specific instance - of this metric type. For example, the - `appengine.googleapis.com/http/server/response_latencies` metric - type has a label for the HTTP response code, `response_code`, so you - can look at latencies for successful responses or just for responses - that failed. - type: array - displayName: + If non-empty specifies a path under which inherited HTTP paths are + rooted. type: string + id: Mixin + UsageRule: + description: Usage configuration rules for the service. + type: object + properties: + skipServiceControl: + type: boolean description: >- - A concise name for the metric, which can be displayed in user - interfaces. Use sentence case without an ending period, for example - "Request count". This field is optional but it is recommended to be - set for any metrics associated with user-visible concepts, such as - Quota. - monitoredResourceTypes: - description: >- - Read-only. If present, then a time series, which is identified - partially by a metric type and a MonitoredResourceDescriptor, that - is associated with this metric type can only be associated with one - of the monitored resource types listed here. - type: array - items: - type: string - unit: + If true, the selected method should skip service control and the + control plane features, such as quota and billing, will not be + available. This flag is used by Google Cloud Endpoints to bypass + checks for internal methods, such as service health check methods. + selector: description: >- - The units in which the metric value is reported. It is only - applicable if the `value_type` is `INT64`, `DOUBLE`, or - `DISTRIBUTION`. The `unit` defines the representation of the stored - metric values. Different systems might scale the values to be more - easily displayed (so a value of `0.02kBy` _might_ be displayed as - `20By`, and a value of `3523kBy` _might_ be displayed as `3.5MBy`). - However, if the `unit` is `kBy`, then the value of the metric is - always in thousands of bytes, no matter how it might be displayed. - If you want a custom metric to record the exact number of - CPU-seconds used by a job, you can create an `INT64 CUMULATIVE` - metric whose `unit` is `s{CPU}` (or equivalently `1s{CPU}` or just - `s`). If the job uses 12,005 CPU-seconds, then the value is written - as `12005`. Alternatively, if you want a custom metric to record - data in a more granular way, you can create a `DOUBLE CUMULATIVE` - metric whose `unit` is `ks{CPU}`, and then write the value `12.005` - (which is `12005/1000`), or use `Kis{CPU}` and write `11.723` (which - is `12005/1024`). The supported units are a subset of [The Unified - Code for Units of Measure](https://unitsofmeasure.org/ucum.html) - standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` - second * `min` minute * `h` hour * `d` day * `1` dimensionless - **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga - (10^9) * `T` tera (10^12) * `P` peta (10^15) * `E` exa (10^18) * `Z` - zetta (10^21) * `Y` yotta (10^24) * `m` milli (10^-3) * `u` micro - (10^-6) * `n` nano (10^-9) * `p` pico (10^-12) * `f` femto (10^-15) - * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto (10^-24) * `Ki` - kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) - * `Pi` pebi (2^50) **Grammar** The grammar also includes these - connectors: * `/` division or ratio (as an infix operator). For - examples, `kBy/{email}` or `MiBy/10ms` (although you should almost - never have `/s` in a metric `unit`; rates should always be computed - at query time from the underlying cumulative or delta value). * `.` - multiplication or composition (as an infix operator). For examples, - `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: - Expression = Component { "." Component } { "/" Component } ; - Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | - "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a - comment if it follows a `UNIT`. If the annotation is used alone, - then the unit is equivalent to `1`. For examples, `{request}/s == - 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of - non-blank printable ASCII characters not containing `{` or `}`. * - `1` represents a unitary [dimensionless - unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, - such as in `1/s`. It is typically used when none of the basic units - are appropriate. For example, "new users per day" can be represented - as `1/d` or `{new-users}/d` (and a metric value `5` would mean "5 - new users). Alternatively, "thousands of page views per day" would - be represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a - metric value of `5.3` would mean "5300 page views per day"). * `%` - represents dimensionless value of 1/100, and annotates values giving - a percentage (so the metric values are typically in the range of - 0..100, and a metric value `3` means "3 percent"). * `10^2.%` - indicates a metric contains a ratio, typically in the range 0..1, - that will be multiplied by 100 and displayed as a percentage (so a - metric value `0.03` means "3 percent"). + Selects the methods to which this rule applies. Use '*' to indicate + all methods in all APIs. Refer to selector for syntax details. type: string - description: >- - Defines a metric type and its schema. Once a metric descriptor is - created, deleting or altering it stops data collection and makes the - metric type's existing data unusable. - type: object - id: MetricDescriptor - EnableFailure: - id: EnableFailure + allowUnregisteredCalls: + description: ' Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity.' + type: boolean + id: UsageRule + AuthRequirement: properties: - errorMessage: - description: An error message describing why the service could not be enabled. + audiences: type: string - serviceId: + description: >- + NOTE: This will be deprecated soon, once AuthProvider.audiences is + implemented and accepted in all the runtime components. The list of + JWT + [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). + that are allowed to access. A JWT containing any of these audiences + will be accepted. When this setting is absent, only JWTs with + audience "https://Service_name/API_name" will be accepted. For + example, if no audiences are in the setting, LibraryService API will + only accept JWTs with the following audience + "https://library-example.googleapis.com/google.example.library.v1.LibraryService". + Example: audiences: bookstore_android.apps.googleusercontent.com, + bookstore_web.apps.googleusercontent.com + providerId: + description: >- + id from authentication provider. Example: provider_id: + bookstore_auth type: string - description: The service id of a service that could not be enabled. + description: >- + User-defined authentication requirements, including support for [JSON + Web Token + (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + id: AuthRequirement type: object - description: Provides error messages for the failing services. - GetServiceIdentityMetadata: - description: Metadata for the `GetServiceIdentity` method. + GoogleApiServiceusageV2betaUpdateConsumerPolicyMetadata: type: object properties: {} - id: GetServiceIdentityMetadata - GoogleApiServiceusageV2betaAnalyzeConsumerPolicyResponse: + id: GoogleApiServiceusageV2betaUpdateConsumerPolicyMetadata + description: Metadata for the `UpdateConsumerPolicy` method. + AnalysisResult: + type: object + id: AnalysisResult + description: An analysis result including blockers and warnings. properties: - analysis: + warnings: items: - $ref: '#/components/schemas/GoogleApiServiceusageV2betaAnalysis' + $ref: '#/components/schemas/Impact' description: >- - The list of analyses returned from performing the intended policy - update analysis. The analysis is grouped by service name and - different analysis types. The empty analysis list means that the - consumer policy can be updated without any warnings or blockers. + Warning information indicating that the policy changes might be + unsafe, but will not block the changes at runtime. type: array - id: GoogleApiServiceusageV2betaAnalyzeConsumerPolicyResponse - type: object - description: The response of analyzing a consumer policy update. - Status: - id: Status - properties: - message: - type: string + blockers: description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - details: + Blocking information that would prevent the policy changes at + runtime. type: array - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. items: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - code: - type: integer - description: The status code, which should be an enum value of google.rpc.Code. - format: int32 - type: object - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - Empty: + $ref: '#/components/schemas/Impact' + UpdateAdminQuotaPolicyMetadata: + properties: {} description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + Metadata message that provides information such as progress, partial + failures, and similar information on each GetOperation call of LRO + returned by UpdateAdminQuotaPolicy. type: object - properties: {} - id: Empty - Operation: + id: UpdateAdminQuotaPolicyMetadata + BatchEnableServicesRequest: + id: BatchEnableServicesRequest + type: object + description: Request message for the `BatchEnableServices` method. + properties: + serviceIds: + items: + type: string + description: >- + The identifiers of the services to enable on the project. A valid + identifier would be: serviceusage.googleapis.com Enabling services + requires that each service is public or is shared with the user + enabling the service. A single request can enable a maximum of 20 + services at a time. If more than 20 services are specified, the + request will fail, and no state changes will occur. + type: array + Billing: + id: Billing type: object properties: - metadata: + consumerDestinations: + items: + $ref: '#/components/schemas/BillingDestination' + type: array + description: >- + Billing configurations for sending metrics to the consumer project. + There can be multiple consumer destinations per service, each one + must have a different monitored resource type. A metric can be used + in at most one consumer destination. + description: >- + Billing related configuration of the service. The following example + shows how to configure monitored resources and metrics for billing, + `consumer_destinations` is the only supported destination and the + monitored resources need at least one label key + `cloud.googleapis.com/location` to indicate the location of the billing + usage, using different monitored resources between monitoring and + billing is recommended so they can be evolved independently: + monitored_resources: - type: library.googleapis.com/billing_branch + labels: - key: cloud.googleapis.com/location description: | Predefined + label to support billing location restriction. - key: city description: + | Custom label to define the city where the library branch is located + in. - key: name description: Custom label to define the name of the + library branch. metrics: - name: + library.googleapis.com/book/borrowed_count metric_kind: DELTA + value_type: INT64 unit: "1" billing: consumer_destinations: - + monitored_resource: library.googleapis.com/billing_branch metrics: - + library.googleapis.com/book/borrowed_count + GoogleApiServiceusageV2betaConsumerPolicy: + properties: + createTime: + format: google-datetime + readOnly: true + type: string description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. + Output only. The time the policy was created. For singleton + policies, this is the first touch of the policy. + annotations: type: object + description: >- + Optional. Annotations is an unstructured key-value map stored with a + policy that may be set by external tools to store and retrieve + arbitrary metadata. They are not queryable and should be preserved + when modifying objects. + [AIP-128](https://google.aip.dev/128#annotations) additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - name: + type: string + enableRules: + items: + $ref: '#/components/schemas/GoogleApiServiceusageV2betaEnableRule' + type: array description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. + Enable rules define usable services, groups, and categories. There + can currently be at most one `EnableRule`. This restriction will be + lifted in later releases. + updateTime: + readOnly: true + description: Output only. The time the policy was last updated. type: string - error: - $ref: '#/components/schemas/Status' - description: >- - The error result of the operation in case of failure or - cancellation. - response: - description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - done: + format: google-datetime + etag: description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - type: boolean - id: Operation - description: >- - This resource represents a long-running operation that is the result of - a network API call. - CustomHttpPattern: - description: A custom pattern is used for defining custom HTTP verb. - id: CustomHttpPattern - properties: - path: + Output only. An opaque tag indicating the current version of the + policy, used for concurrency control. type: string - description: The path matched by this custom verb. - kind: - description: The name of this custom HTTP verb. + readOnly: true + name: type: string + description: >- + Output only. The resource name of the policy. Only the `default` + policy is supported: `projects/12345/consumerPolicies/default`, + `folders/12345/consumerPolicies/default`, + `organizations/12345/consumerPolicies/default`. + readOnly: true + description: >- + Consumer Policy is a set of rules that define what services or service + groups can be used for a cloud resource hierarchy. + id: GoogleApiServiceusageV2betaConsumerPolicy type: object - ImportAdminOverridesResponse: + MetricDescriptorMetadata: + id: MetricDescriptorMetadata + description: Additional annotations that can be used to guide the usage of a metric. properties: - overrides: + timeSeriesResourceHierarchyLevel: + description: The scope of the timeseries data of the metric. items: - $ref: '#/components/schemas/QuotaOverride' - description: The overrides that were created from the imported data. + enumDescriptions: + - Do not use this default value. + - Scopes a metric to a project. + - Scopes a metric to an organization. + - Scopes a metric to a folder. + type: string + enum: + - TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED + - PROJECT + - ORGANIZATION + - FOLDER type: array - type: object - description: Response message for ImportAdminOverrides - id: ImportAdminOverridesResponse - DocumentationRule: - id: DocumentationRule - description: A documentation rule provides information about individual API elements. - properties: - deprecationDescription: + ingestDelay: type: string description: >- - Deprecation description of the selected element(s). It can be - provided if an element is marked as `deprecated`. - disableReplacementWords: + The delay of data points caused by ingestion. Data points older than + this age are guaranteed to be ingested and available to be read, + excluding data loss due to errors. + format: google-duration + samplePeriod: + type: string + format: google-duration + description: >- + The sampling period of metric data points. For metrics which are + written periodically, consecutive data points are stored at this + time interval, excluding data loss due to errors. Metrics with a + higher granularity have a smaller sampling period. + launchStage: + description: Deprecated. Must use the MetricDescriptor.launch_stage instead. type: string + deprecated: true + enumDescriptions: + - Do not use this default value. + - The feature is not yet implemented. Users can not use it. + - >- + Prelaunch features are hidden from users and are only visible + internally. + - >- + Early Access features are limited to a closed group of testers. To + use these features, you must sign up in advance and sign a Trusted + Tester agreement (which includes confidentiality provisions). + These features may be unstable, changed in backward-incompatible + ways, and are not guaranteed to be released. + - >- + Alpha is a limited availability test for releases before they are + cleared for widespread use. By Alpha, all significant design + issues are resolved and we are in the process of verifying + functionality. Alpha customers need to apply for access, agree to + applicable terms, and have their projects allowlisted. Alpha + releases don't have to be feature complete, no SLAs are provided, + and there are no technical support obligations, but they will be + far enough along that customers can actually use them in test + environments or for limited-use tests -- just like they would in + normal production cases. + - >- + Beta is the point at which we are ready to open a release for any + customer to use. There are no SLA or technical support obligations + in a Beta release. Products will be complete from a feature + perspective, but may have some open outstanding issues. Beta + releases are suitable for limited production use cases. + - >- + GA features are open to all developers and are considered stable + and fully qualified for production use. + - >- + Deprecated features are scheduled to be shut down and removed. For + more information, see the "Deprecation Policy" section of our + [Terms of Service](https://cloud.google.com/terms/) and the + [Google Cloud Platform Subject to the Deprecation + Policy](https://cloud.google.com/terms/deprecation) documentation. + enum: + - LAUNCH_STAGE_UNSPECIFIED + - UNIMPLEMENTED + - PRELAUNCH + - EARLY_ACCESS + - ALPHA + - BETA + - GA + - DEPRECATED + type: object + SystemParameters: + id: SystemParameters + description: >- + ### System parameter configuration A system parameter is a special kind + of parameter defined by the API system, not by an individual API. It is + typically mapped to an HTTP header and/or a URL query parameter. This + configuration specifies which methods change the names of the system + parameters. + type: object + properties: + rules: description: >- - String of comma or space separated case-sensitive words for which - method/field name replacement will be disabled by go/api-docgen. - selector: + Define system parameters. The parameters defined here will override + the default parameters implemented by the system. If this field is + missing from the service config, default system parameters will be + used. Default system parameters and names is + implementation-dependent. Example: define api key for all methods + system_parameters rules: - selector: "*" parameters: - name: api_key + url_query_parameter: api_key Example: define 2 api key names for a + specific method. system_parameters rules: - selector: "/ListShelves" + parameters: - name: api_key http_header: Api-Key1 - name: api_key + http_header: Api-Key2 **NOTE:** All service configuration rules + follow "last one wins" order. + type: array + items: + $ref: '#/components/schemas/SystemParameterRule' + GoogleApiServiceusageV2alphaConsumerPolicy: + description: >- + Consumer Policy is a set of rules that define what services or service + groups can be used for a cloud resource hierarchy. + properties: + updateTime: + description: Output only. The time the policy was last updated. + format: google-datetime type: string + readOnly: true + annotations: + type: object + additionalProperties: + type: string description: >- - The selector is a comma-separated list of patterns for any element - such as a method, a field, an enum value. Each pattern is a - qualified name of the element which may end in "*", indicating a - wildcard. Wildcards are only allowed at the end and for a whole - component of the qualified name, i.e. "foo.*" is ok, but not - "foo.b*" or "foo.*.bar". A wildcard will match one or more - components. To specify a default for all applicable elements, the - whole pattern "*" is used. - description: + Optional. Annotations is an unstructured key-value map stored with a + policy that may be set by external tools to store and retrieve + arbitrary metadata. They are not queryable and should be preserved + when modifying objects. + [AIP-128](https://google.aip.dev/128#annotations) + enableRules: description: >- - Description of the selected proto element (e.g. a message, a method, - a 'service' definition, or a field). Defaults to leading & trailing - comments taken from the proto source definition of the proto - element. + Enable rules define usable services, groups, and categories. There + can currently be at most one `EnableRule`. This restriction will be + lifted in later releases. + items: + $ref: '#/components/schemas/GoogleApiServiceusageV2alphaEnableRule' + type: array + etag: + description: >- + Output only. An opaque tag indicating the current version of the + policy, used for concurrency control. + type: string + readOnly: true + name: + description: >- + Output only. The resource name of the policy. Only the `default` + policy is supported: `projects/12345/consumerPolicies/default`, + `folders/12345/consumerPolicies/default`, + `organizations/12345/consumerPolicies/default`. + readOnly: true type: string - type: object - Page: - description: >- - Represents a documentation page. A page can contain subpages to - represent nested documentation set structure. - properties: - content: + createTime: + format: google-datetime type: string + readOnly: true description: >- - The Markdown content of the page. You can use (== include {path} ==) - to include content from a Markdown file. The content can be used to - produce the documentation page such as HTML format page. - name: + Output only. The time the policy was created. For singleton + policies, this is the first touch of the policy. + id: GoogleApiServiceusageV2alphaConsumerPolicy + type: object + CustomErrorRule: + properties: + selector: type: string description: >- - The name of the page. It will be used as an identity of the page to - generate URI of the page, text of the link to this page in - navigation, etc. The full page name (start from the root page name - to this page concatenated with `.`) can be used as reference to the - page in your documentation. For example: pages: - name: Tutorial - content: (== include tutorial.md ==) subpages: - name: Java content: - (== include tutorial_java.md ==) You can reference `Java` page using - Markdown reference link syntax: `Java`. - subpages: - items: - $ref: '#/components/schemas/Page' - type: array + Selects messages to which this rule applies. Refer to selector for + syntax details. + isErrorType: description: >- - Subpages of this page. The order of subpages specified here will be - honored in the generated docset. + Mark this message as possible payload in error response. Otherwise, + objects of this type will be filtered when they appear in error + payload. + type: boolean type: object - id: Page + id: CustomErrorRule + description: A custom error rule. AuthenticationRule: + id: AuthenticationRule description: >- Authentication rules for the service. By default, if a method has any authentication requirements, every request must include a valid credential matching one of the requirements. It's an error to include more than one kind of credential in a single request. If a method doesn't have any auth requirements, request credentials will be ignored. - id: AuthenticationRule - type: object properties: - oauth: - $ref: '#/components/schemas/OAuthRequirements' - description: The requirements for OAuth credentials. - selector: - type: string - description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. requirements: - description: Requirements for additional authentication providers. type: array + description: Requirements for additional authentication providers. items: $ref: '#/components/schemas/AuthRequirement' allowWithoutCredential: @@ -3571,452 +3874,359 @@ components: If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests. type: boolean - JwtLocation: - id: JwtLocation - description: Specifies a location to extract JWT from an API request. - properties: - header: + oauth: + $ref: '#/components/schemas/OAuthRequirements' + description: The requirements for OAuth credentials. + selector: type: string - description: Specifies HTTP header name to extract JWT token. - valuePrefix: description: >- - The value prefix. The value format is "value_prefix{token}" Only - applies to "in" header type. Must be empty for "in" query type. If - not empty, the header value has to match (case sensitive) this - prefix. If not matched, JWT will not be extracted. If matched, JWT - will be extracted after the prefix is removed. For example, for - "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space - at the end. - type: string - cookie: - description: Specifies cookie name to extract JWT token. - type: string - query: - type: string - description: Specifies URL query parameter name to extract JWT token. + Selects the methods to which this rule applies. Refer to selector + for syntax details. type: object - Publishing: + Aspect: + description: >- + Aspect represents Generic aspect. It is used to configure an aspect + without making direct changes to service.proto + id: Aspect properties: - restReferenceDocumentationUri: - description: >- - Optional link to REST reference documentation. Example: - https://cloud.google.com/pubsub/lite/docs/reference/rest - type: string - apiShortName: - type: string - description: >- - Used as a tracking tag when collecting data about the APIs developer - relations artifacts like docs, packages delivered to package - managers, etc. Example: "speech". - librarySettings: - description: >- - Client library settings. If the same version string appears multiple - times in this list, then the last one wins. Settings from earlier - settings with the same version string are discarded. - items: - $ref: '#/components/schemas/ClientLibrarySettings' - type: array - organization: - type: string - enumDescriptions: - - Not useful. - - Google Cloud Platform Org. - - Ads (Advertising) Org. - - Photos Org. - - Street View Org. - - Shopping Org. - - Geo Org. - - Generative AI - https://developers.generativeai.google - enum: - - CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED - - CLOUD - - ADS - - PHOTOS - - STREET_VIEW - - SHOPPING - - GEO - - GENERATIVE_AI - description: For whom the client library is being published. - docTagPrefix: - type: string - description: >- - A prefix used in sample code when demarking regions to be included - in documentation. - protoReferenceDocumentationUri: - description: >- - Optional link to proto reference documentation. Example: - https://cloud.google.com/pubsub/lite/docs/reference/rpc - type: string - newIssueUri: - type: string - description: >- - Link to a *public* URI where users can report issues. Example: - https://issuetracker.google.com/issues/new?component=190865&template=1161103 - codeownerGithubTeams: - items: - type: string - description: >- - GitHub teams to be added to CODEOWNERS in the directory in GitHub - containing source code for the client libraries for this API. - type: array - methodSettings: - description: >- - A list of API method settings, e.g. the behavior for methods that - use the long-running operation pattern. - type: array - items: - $ref: '#/components/schemas/MethodSettings' - documentationUri: + kind: + description: The type of this aspect configuration. type: string + spec: + type: object description: >- - Link to product home page. Example: - https://cloud.google.com/asset-inventory/docs/overview - githubLabel: - description: >- - GitHub label to apply to issues and pull requests opened for this - API. - type: string + Content of the configuration. The underlying schema should be + defined by Aspect owners as protobuf message under + `google/api/configaspects/proto`. + additionalProperties: + description: Properties of the object. + type: any type: object - id: Publishing - description: >- - This message configures the settings for publishing [Google Cloud Client - libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) - generated from the service config. - GoogleApiServiceusageV1beta1ServiceIdentity: - id: GoogleApiServiceusageV1beta1ServiceIdentity + JwtLocation: + description: Specifies a location to extract JWT from an API request. properties: - uniqueId: - description: >- - The unique and stable id of the service account. - https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts#ServiceAccount + query: + description: Specifies URL query parameter name to extract JWT token. type: string - email: + cookie: + description: Specifies cookie name to extract JWT token. type: string - description: >- - The email address of the service account that a service producer - would use to access consumer resources. - description: >- - Service identity for a service. This is the identity that service - producer should use to access consumer resources. - type: object - Api: - id: Api - properties: - version: + header: + description: Specifies HTTP header name to extract JWT token. type: string - description: >- - A version string for this interface. If specified, must have the - form `major-version.minor-version`, as in `1.10`. If the minor - version is omitted, it defaults to zero. If the entire version field - is empty, the major version is derived from the package name, as - outlined below. If the field is not empty, the version in the - package name will be verified to be consistent with what is provided - here. The versioning schema uses [semantic - versioning](http://semver.org) where the major version number - indicates a breaking change and the minor version an additive, - non-breaking change. Both version numbers are signals to users what - to expect from different versions, and should be carefully chosen - based on the product plan. The major version is also reflected in - the package name of the interface, which must end in `v`, as in - `google.feature.v1`. For major versions 0 and 1, the suffix can be - omitted. Zero major versions must only be used for experimental, - non-GA interfaces. - sourceContext: - $ref: '#/components/schemas/SourceContext' - description: >- - Source context for the protocol buffer service represented by this - message. - methods: - description: The methods of this interface, in unspecified order. - items: - $ref: '#/components/schemas/Method' - type: array - mixins: - items: - $ref: '#/components/schemas/Mixin' - description: Included interfaces. See Mixin. - type: array - name: + valuePrefix: type: string description: >- - The fully qualified name of this interface, including package name - followed by the interface's simple name. - syntax: - enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. - type: string - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS - description: The source syntax of the service. - options: + The value prefix. The value format is "value_prefix{token}" Only + applies to "in" header type. Must be empty for "in" query type. If + not empty, the header value has to match (case sensitive) this + prefix. If not matched, JWT will not be extracted. If matched, JWT + will be extracted after the prefix is removed. For example, for + "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space + at the end. + type: object + id: JwtLocation + ImportConsumerOverridesResponse: + properties: + overrides: type: array + description: The overrides that were created from the imported data. items: - $ref: '#/components/schemas/Option' - description: Any metadata attached to the interface. + $ref: '#/components/schemas/QuotaOverride' + id: ImportConsumerOverridesResponse + type: object + description: Response message for ImportConsumerOverrides + BatchCreateAdminOverridesResponse: + id: BatchCreateAdminOverridesResponse type: object - description: >- - Api is a light-weight descriptor for an API Interface. Interfaces are - also described as "protocol buffer services" in some contexts, such as - by the "service" keyword in a .proto file, but they are different from - API Services, which represent a concrete implementation of an interface - as opposed to simply a description of methods and bindings. They are - also sometimes simply referred to as "APIs" in other contexts, such as - the name of this message itself. See - https://cloud.google.com/apis/design/glossary for detailed terminology. - BatchCreateConsumerOverridesResponse: - description: Response message for BatchCreateConsumerOverrides properties: overrides: + description: The overrides that were created. items: $ref: '#/components/schemas/QuotaOverride' type: array - description: The overrides that were created. - id: BatchCreateConsumerOverridesResponse - type: object - BatchGetServicesResponse: + description: Response message for BatchCreateAdminOverrides + Authentication: + description: >- + `Authentication` defines the authentication configuration for API + methods provided by an API service. Example: name: + calendar.googleapis.com authentication: providers: - id: + google_calendar_auth jwks_uri: + https://www.googleapis.com/oauth2/v1/certs issuer: + https://securetoken.google.com rules: - selector: "*" requirements: + provider_id: google_calendar_auth - selector: google.calendar.Delegate + oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read + id: Authentication type: object - description: Response message for the `BatchGetServices` method. - id: BatchGetServicesResponse properties: - services: - description: The requested Service states. + rules: + type: array items: - $ref: '#/components/schemas/GoogleApiServiceusageV1Service' + $ref: '#/components/schemas/AuthenticationRule' + description: >- + A list of authentication rules that apply to individual API methods. + **NOTE:** All service configuration rules follow "last one wins" + order. + providers: type: array - DeleteAdminQuotaPolicyMetadata: - type: object + description: Defines a set of authentication providers that a service supports. + items: + $ref: '#/components/schemas/AuthProvider' + ImportAdminOverridesMetadata: + id: ImportAdminOverridesMetadata properties: {} + type: object description: >- Metadata message that provides information such as progress, partial failures, and similar information on each GetOperation call of LRO - returned by DeleteAdminQuotaPolicy. - id: DeleteAdminQuotaPolicyMetadata - FieldPolicy: - id: FieldPolicy + returned by ImportAdminOverrides. + QuotaOverride: + id: QuotaOverride + description: A quota override type: object - description: >- - Google API Policy Annotation This message defines a simple API policy - annotation that can be used to annotate API request and response message - fields with applicable policies. One field may have multiple applicable - policies that must all be satisfied before a request can be processed. - This policy annotation is used to generate the overall policy that will - be used for automatic runtime policy enforcement and documentation - generation. properties: - resourceType: + dimensions: + additionalProperties: + type: string + type: object description: >- - Specifies the resource type for the resource referred to by the - field. - type: string - resourcePermission: + If this map is nonempty, then this override applies only to specific + values for dimensions defined in the limit unit. For example, an + override on a limit with the unit `1/{project}/{region}` could + contain an entry with the key `region` and the value `us-east-1`; + the override is only applied to quota consumed in that region. This + map has the following restrictions: * Keys that are not defined in + the limit's unit are not valid keys. Any string appearing in + `{brackets}` in the unit (besides `{project}` or `{user}`) is a + defined key. * `project` is not a valid key; the project is already + specified in the parent resource name. * `user` is not a valid key; + the API does not support quota overrides that apply only to a + specific user. * If `region` appears as a key, its value must be a + valid Cloud region. * If `zone` appears as a key, its value must be + a valid Cloud zone. * If any valid key other than `region` or `zone` + appears in the map, then all valid keys other than `region` or + `zone` must also appear in the map. + name: type: string description: >- - Specifies the required permission(s) for the resource referred to by - the field. It requires the field contains a valid resource - reference, and the request must pass the permission checks to - proceed. For example, "resourcemanager.projects.get". - selector: + The resource name of the override. This name is generated by the + server when the override is created. Example names would be: + `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` + `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` + The resource name is intended to be opaque and should not be parsed + for its component strings, since its representation could change in + the future. + adminOverrideAncestor: description: >- - Selects one or more request or response message fields to apply this - `FieldPolicy`. When a `FieldPolicy` is used in proto annotation, the - selector must be left as empty. The service config generator will - automatically fill the correct value. When a `FieldPolicy` is used - in service config, the selector must be a comma-separated string - with valid request or response field paths, such as "foo.bar" or - "foo.bar,foo.baz". + The resource name of the ancestor that requested the override. For + example: `organizations/12345` or `folders/67890`. Used by admin + overrides only. type: string - GoogleApiServiceusageV1OperationMetadata: - description: The operation metadata returned for the batchend services operation. - properties: - resourceNames: - type: array - description: >- - The full name of the resources that this operation is directly - associated with. - items: - type: string - type: object - id: GoogleApiServiceusageV1OperationMetadata - GoogleApiServiceusageV2alphaConsumerPolicy: - properties: - createTime: - readOnly: true - format: google-datetime + unit: description: >- - Output only. The time the policy was created. For singleton - policies, this is the first touch of the policy. - type: string - etag: - readOnly: true + The limit unit of the limit to which this override applies. An + example unit would be: `1/{project}/{region}` Note that `{project}` + and `{region}` are not placeholders in this example; the literal + characters `{` and `}` occur in the string. type: string + metric: description: >- - Output only. An opaque tag indicating the current version of the - policy, used for concurrency control. - name: - readOnly: true - description: >- - Output only. The resource name of the policy. Only the `default` - policy is supported: `projects/12345/consumerPolicies/default`, - `folders/12345/consumerPolicies/default`, - `organizations/12345/consumerPolicies/default`. + The name of the metric to which this override applies. An example + name would be: `compute.googleapis.com/cpus` type: string - annotations: - type: object - additionalProperties: - type: string + overrideValue: description: >- - Optional. Annotations is an unstructured key-value map stored with a - policy that may be set by external tools to store and retrieve - arbitrary metadata. They are not queryable and should be preserved - when modifying objects. - [AIP-128](https://google.aip.dev/128#annotations) - updateTime: - readOnly: true - format: google-datetime - description: Output only. The time the policy was last updated. + The overriding quota limit value. Can be any nonnegative integer, or + -1 (unlimited quota). + format: int64 type: string - enableRules: + GoogleApiServiceusageV2betaAnalyzeConsumerPolicyResponse: + id: GoogleApiServiceusageV2betaAnalyzeConsumerPolicyResponse + description: The response of analyzing a consumer policy update. + type: object + properties: + analysis: description: >- - Enable rules define usable services, groups, and categories. There - can currently be at most one `EnableRule`. This restriction will be - lifted in later releases. + The list of analyses returned from performing the intended policy + update analysis. The analysis is grouped by service name and + different analysis types. The empty analysis list means that the + consumer policy can be updated without any warnings or blockers. type: array items: - $ref: '#/components/schemas/GoogleApiServiceusageV2alphaEnableRule' - id: GoogleApiServiceusageV2alphaConsumerPolicy - type: object - description: >- - Consumer Policy is a set of rules that define what services or service - groups can be used for a cloud resource hierarchy. - AnalyzeConsumerPolicyMetadata: + $ref: '#/components/schemas/GoogleApiServiceusageV2betaAnalysis' + Backend: + description: '`Backend` defines the backend configuration for a service.' + properties: + rules: + type: array + items: + $ref: '#/components/schemas/BackendRule' + description: >- + A list of API backend rules that apply to individual API methods. + **NOTE:** All service configuration rules follow "last one wins" + order. type: object - id: AnalyzeConsumerPolicyMetadata - description: Metadata for the `AnalyzeConsumerPolicy` method. - properties: {} - DisableServiceRequest: - id: DisableServiceRequest - description: Request message for the `DisableService` method. + id: Backend + FieldPolicy: + id: FieldPolicy properties: - checkIfServiceHasUsage: + resourcePermission: + description: >- + Specifies the required permission(s) for the resource referred to by + the field. It requires the field contains a valid resource + reference, and the request must pass the permission checks to + proceed. For example, "resourcemanager.projects.get". + type: string + selector: type: string - enum: - - CHECK_IF_SERVICE_HAS_USAGE_UNSPECIFIED - - SKIP - - CHECK - enumDescriptions: - - When unset, the default behavior is used, which is SKIP. - - If set, skip checking service usage when disabling a service. - - >- - If set, service usage is checked when disabling the service. If a - service, or its dependents, has usage in the last 30 days, the - request returns a FAILED_PRECONDITION error. description: >- - Defines the behavior for checking service usage when disabling a - service. - disableDependentServices: - type: boolean + Selects one or more request or response message fields to apply this + `FieldPolicy`. When a `FieldPolicy` is used in proto annotation, the + selector must be left as empty. The service config generator will + automatically fill the correct value. When a `FieldPolicy` is used + in service config, the selector must be a comma-separated string + with valid request or response field paths, such as "foo.bar" or + "foo.bar,foo.baz". + resourceType: description: >- - Indicates if services that are enabled and which depend on this - service should also be disabled. If not set, an error will be - generated if any enabled services depend on the service to be - disabled. When set, the service, and any enabled services that - depend on it, will be disabled together. + Specifies the resource type for the resource referred to by the + field. + type: string type: object - MetricDescriptorMetadata: + description: >- + Google API Policy Annotation This message defines a simple API policy + annotation that can be used to annotate API request and response message + fields with applicable policies. One field may have multiple applicable + policies that must all be satisfied before a request can be processed. + This policy annotation is used to generate the overall policy that will + be used for automatic runtime policy enforcement and documentation + generation. + SelectiveGapicGeneration: type: object - description: Additional annotations that can be used to guide the usage of a metric. - id: MetricDescriptorMetadata properties: - timeSeriesResourceHierarchyLevel: - description: The scope of the timeseries data of the metric. + methods: type: array + description: >- + An allowlist of the fully qualified names of RPCs that should be + included on public client surfaces. items: - enumDescriptions: - - Do not use this default value. - - Scopes a metric to a project. - - Scopes a metric to an organization. - - Scopes a metric to a folder. type: string - enum: - - TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED - - PROJECT - - ORGANIZATION - - FOLDER - ingestDelay: - format: google-duration + generateOmittedAsInternal: + description: >- + Setting this to true indicates to the client generators that methods + that would be excluded from the generation should instead be + generated in a way that indicates these methods should not be + consumed by end users. How this is expressed is up to individual + language implementations to decide. Some examples may be: added + annotations, obfuscated identifiers, or other language idiomatic + patterns. + type: boolean + id: SelectiveGapicGeneration + description: >- + This message is used to configure the generation of a subset of the RPCs + in a service for client libraries. + Monitoring: + properties: + producerDestinations: description: >- - The delay of data points caused by ingestion. Data points older than - this age are guaranteed to be ingested and available to be read, - excluding data loss due to errors. + Monitoring configurations for sending metrics to the producer + project. There can be multiple producer destinations. A monitored + resource type may appear in multiple monitoring destinations if + different aggregations are needed for different sets of metrics + associated with that monitored resource type. A monitored resource + and metric pair may only be used once in the Monitoring + configuration. + type: array + items: + $ref: '#/components/schemas/MonitoringDestination' + consumerDestinations: + description: >- + Monitoring configurations for sending metrics to the consumer + project. There can be multiple consumer destinations. A monitored + resource type may appear in multiple monitoring destinations if + different aggregations are needed for different sets of metrics + associated with that monitored resource type. A monitored resource + and metric pair may only be used once in the Monitoring + configuration. + type: array + items: + $ref: '#/components/schemas/MonitoringDestination' + type: object + description: >- + Monitoring configuration of the service. The example below shows how to + configure monitored resources and metrics for monitoring. In the + example, a monitored resource and two metrics are defined. The + `library.googleapis.com/book/returned_count` metric is sent to both + producer and consumer projects, whereas the + `library.googleapis.com/book/num_overdue` metric is only sent to the + consumer project. monitored_resources: - type: + library.googleapis.com/Branch display_name: "Library Branch" + description: "A branch of a library." launch_stage: GA labels: - key: + resource_container description: "The Cloud container (ie. project id) + for the Branch." - key: location description: "The location of the + library branch." - key: branch_id description: "The id of the branch." + metrics: - name: library.googleapis.com/book/returned_count + display_name: "Books Returned" description: "The count of books that + have been returned." launch_stage: GA metric_kind: DELTA value_type: + INT64 unit: "1" labels: - key: customer_id description: "The id of the + customer." - name: library.googleapis.com/book/num_overdue display_name: + "Books Overdue" description: "The current number of overdue books." + launch_stage: GA metric_kind: GAUGE value_type: INT64 unit: "1" labels: + - key: customer_id description: "The id of the customer." monitoring: + producer_destinations: - monitored_resource: + library.googleapis.com/Branch metrics: - + library.googleapis.com/book/returned_count consumer_destinations: - + monitored_resource: library.googleapis.com/Branch metrics: - + library.googleapis.com/book/returned_count - + library.googleapis.com/book/num_overdue + id: Monitoring + DocumentationRule: + type: object + properties: + disableReplacementWords: + description: >- + String of comma or space separated case-sensitive words for which + method/field name replacement will be disabled. type: string - launchStage: - enum: - - LAUNCH_STAGE_UNSPECIFIED - - UNIMPLEMENTED - - PRELAUNCH - - EARLY_ACCESS - - ALPHA - - BETA - - GA - - DEPRECATED - enumDescriptions: - - Do not use this default value. - - The feature is not yet implemented. Users can not use it. - - >- - Prelaunch features are hidden from users and are only visible - internally. - - >- - Early Access features are limited to a closed group of testers. To - use these features, you must sign up in advance and sign a Trusted - Tester agreement (which includes confidentiality provisions). - These features may be unstable, changed in backward-incompatible - ways, and are not guaranteed to be released. - - >- - Alpha is a limited availability test for releases before they are - cleared for widespread use. By Alpha, all significant design - issues are resolved and we are in the process of verifying - functionality. Alpha customers need to apply for access, agree to - applicable terms, and have their projects allowlisted. Alpha - releases don't have to be feature complete, no SLAs are provided, - and there are no technical support obligations, but they will be - far enough along that customers can actually use them in test - environments or for limited-use tests -- just like they would in - normal production cases. - - >- - Beta is the point at which we are ready to open a release for any - customer to use. There are no SLA or technical support obligations - in a Beta release. Products will be complete from a feature - perspective, but may have some open outstanding issues. Beta - releases are suitable for limited production use cases. - - >- - GA features are open to all developers and are considered stable - and fully qualified for production use. - - >- - Deprecated features are scheduled to be shut down and removed. For - more information, see the "Deprecation Policy" section of our - [Terms of Service](https://cloud.google.com/terms/) and the - [Google Cloud Platform Subject to the Deprecation - Policy](https://cloud.google.com/terms/deprecation) documentation. - deprecated: true + deprecationDescription: type: string - description: Deprecated. Must use the MetricDescriptor.launch_stage instead. - samplePeriod: - format: google-duration description: >- - The sampling period of metric data points. For metrics which are - written periodically, consecutive data points are stored at this - time interval, excluding data loss due to errors. Metrics with a - higher granularity have a smaller sampling period. + Deprecation description of the selected element(s). It can be + provided if an element is marked as `deprecated`. + description: + type: string + description: >- + Description of the selected proto element (e.g. a message, a method, + a 'service' definition, or a field). Defaults to leading & trailing + comments taken from the proto source definition of the proto + element. + selector: type: string + description: >- + The selector is a comma-separated list of patterns for any element + such as a method, a field, an enum value. Each pattern is a + qualified name of the element which may end in "*", indicating a + wildcard. Wildcards are only allowed at the end and for a whole + component of the qualified name, i.e. "foo.*" is ok, but not + "foo.b*" or "foo.*.bar". A wildcard will match one or more + components. To specify a default for all applicable elements, the + whole pattern "*" is used. + description: A documentation rule provides information about individual API elements. + id: DocumentationRule parameters: - oauth_token: - description: OAuth 2.0 token for the current user. + 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: oauth_token + name: key + schema: + type: string + access_token: + description: OAuth access token. + in: query + name: access_token schema: type: string upload_protocol: @@ -4034,39 +4244,24 @@ components: enum: - '1' - '2' - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean callback: description: JSONP in: query name: callback schema: type: string - access_token: - description: OAuth access token. - in: query - name: access_token - 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 uploadType: description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query name: uploadType schema: type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean fields: description: Selector specifying which fields to include in a partial response. in: query @@ -4083,6 +4278,12 @@ components: - json - media - proto + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token + schema: + type: string quotaUser: description: >- Available to use for quota purposes for server-side applications. Can be @@ -4093,144 +4294,131 @@ components: schema: type: string x-stackQL-resources: - services: - id: google.serviceusage.services - name: services - title: Services + operations: + id: google.serviceusage.operations + name: operations + title: Operations methods: - batch_get: + get: operation: - $ref: '#/paths/~1v1~1{parentType}~1{parent}~1services/get' + $ref: '#/paths/~1v1~1operations~1{operationsId}/get' response: mediaType: application/json openAPIDocKey: '200' - batch_enable: + delete: operation: - $ref: '#/paths/~1v1~1{parentType}~1{parent}~1services/post' + $ref: '#/paths/~1v1~1operations~1{operationsId}/delete' response: mediaType: application/json openAPIDocKey: '200' - disable: + cancel: operation: - $ref: '#/paths/~1v1~1{name}/post' + $ref: '#/paths/~1v1~1operations~1{operationsId}:cancel/post' response: mediaType: application/json openAPIDocKey: '200' - get: + list: operation: - $ref: '#/paths/~1v1~1{name}/get' + $ref: '#/paths/~1v1~1operations/get' response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.operations sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/services/methods/batch_get' - - $ref: '#/components/x-stackQL-resources/services/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] replace: [] - delete: [] - operations: - id: google.serviceusage.operations - name: operations - title: Operations + delete: + - $ref: '#/components/x-stackQL-resources/operations/methods/delete' + services: + id: google.serviceusage.services + name: services + title: Services methods: - get: + disable: operation: - $ref: '#/paths/~1v1~1operations~1{operationsId}/get' + $ref: '#/paths/~1v1~1{name}/post' response: mediaType: application/json openAPIDocKey: '200' - delete: + get: operation: - $ref: '#/paths/~1v1~1operations~1{operationsId}/delete' + $ref: '#/paths/~1v1~1{name}/get' response: mediaType: application/json openAPIDocKey: '200' - list: + batch_get: operation: - $ref: '#/paths/~1v1~1operations/get' + $ref: '#/paths/~1v1~1{parentType}~1{parent}~1services/get' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.operations - cancel: + batch_enable: operation: - $ref: '#/paths/~1v1~1operations~1{operationsId}:cancel/post' + $ref: '#/paths/~1v1~1{parentType}~1{parent}~1services/post' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' + - $ref: '#/components/x-stackQL-resources/services/methods/batch_get' + - $ref: '#/components/x-stackQL-resources/services/methods/get' insert: [] update: [] replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' + delete: [] paths: - /v1/{parentType}/{parent}/services: + /v1/operations/{operationsId}: parameters: &ref_1 - - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/quotaUser' get: description: >- - Returns the service configurations and enabled states for a given list - of services. - operationId: serviceusage.services.batchGet + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: serviceusage.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only + - https://www.googleapis.com/auth/service.management Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only + - https://www.googleapis.com/auth/service.management responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/BatchGetServicesResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path - name: parentType - required: true - schema: - type: string - - in: path - name: parent + name: operationsId required: true schema: type: string - - in: query - name: names - schema: - type: string - post: + delete: description: >- - Enable multiple services on a project. The operation is atomic: if - enabling any service fails, then the entire batch fails, and no state - changes occur. To enable a single service, use the `EnableService` - method instead. - operationId: serviceusage.services.batchEnable - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/BatchEnableServicesRequest' + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: serviceusage.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4246,34 +4434,32 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Empty' parameters: - in: path - name: parentType - required: true - schema: - type: string - - in: path - name: parent + name: operationsId required: true schema: type: string - /v1/{name}: + /v1/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- - Disable a service so that it can no longer be used with a project. This - prevents unintended usage that may cause unexpected billing charges or - security leaks. It is not valid to call the disable method on a service - that is not currently enabled. Callers will receive a - `FAILED_PRECONDITION` status if the target service is not currently - enabled. - operationId: serviceusage.services.disable + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + `1`, corresponding to `Code.CANCELLED`. + operationId: serviceusage.operations.cancel requestBody: content: application/json: schema: - $ref: '#/components/schemas/DisableServiceRequest' + $ref: '#/components/schemas/CancelOperationRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4289,46 +4475,70 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Empty' parameters: - in: path - name: name + name: operationsId required: true schema: type: string + /v1/operations: + parameters: *ref_1 get: - description: Returns the service configuration and enabled state for a given service. - operationId: serviceusage.services.get + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: serviceusage.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only + - https://www.googleapis.com/auth/service.management Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only + - https://www.googleapis.com/auth/service.management responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleApiServiceusageV1Service' + $ref: '#/components/schemas/ListOperationsResponse' parameters: - - in: path + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query name: name - required: true schema: type: string - /v1/operations/{operationsId}: + /v1/{name}: parameters: *ref_1 - get: + post: description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: serviceusage.operations.get + Disable a service so that it can no longer be used with a project. This + prevents unintended usage that may cause unexpected billing charges or + security leaks. It is not valid to call the disable method on a service + that is not currently enabled. Callers will receive a + `FAILED_PRECONDITION` status if the target service is not currently + enabled. + operationId: serviceusage.services.disable + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DisableServiceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4347,99 +4557,85 @@ paths: $ref: '#/components/schemas/Operation' parameters: - in: path - name: operationsId + name: name required: true schema: type: string - delete: - description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: serviceusage.operations.delete + get: + description: Returns the service configuration and enabled state for a given service. + operationId: serviceusage.services.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - - https://www.googleapis.com/auth/service.management + - https://www.googleapis.com/auth/cloud-platform.read-only Oauth2c: - - https://www.googleapis.com/auth/service.management + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/GoogleApiServiceusageV1Service' parameters: - in: path - name: operationsId + name: name required: true schema: type: string - /v1/operations: + /v1/{parentType}/{parent}/services: parameters: *ref_1 get: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: serviceusage.operations.list + Returns the service configurations and enabled states for a given list + of services. + operationId: serviceusage.services.batchGet security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - - https://www.googleapis.com/auth/service.management + - https://www.googleapis.com/auth/cloud-platform.read-only Oauth2c: - - https://www.googleapis.com/auth/service.management + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/ListOperationsResponse' + $ref: '#/components/schemas/BatchGetServicesResponse' parameters: - - in: query - name: filter + - in: path + name: parentType + required: true schema: type: string - - in: query - name: pageToken + - in: path + name: parent + required: true schema: type: string - in: query - name: name + name: names schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/operations/{operationsId}:cancel: - parameters: *ref_1 post: description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: serviceusage.operations.cancel + Enable multiple services on a project. The operation is atomic: if + enabling any service fails, then the entire batch fails, and no state + changes occur. To enable a single service, use the `EnableService` + method instead. + operationId: serviceusage.services.batchEnable requestBody: content: application/json: schema: - $ref: '#/components/schemas/CancelOperationRequest' + $ref: '#/components/schemas/BatchEnableServicesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4455,10 +4651,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/Operation' parameters: - in: path - name: operationsId + name: parentType + required: true + schema: + type: string + - in: path + name: parent required: true schema: type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/solar.yaml b/providers/src/googleapis.com/v00.00.00000/services/solar.yaml index 6949738e..d99e3b98 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/solar.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/solar.yaml @@ -7,8 +7,8 @@ info: title: Solar API description: Solar API. version: v1 - x-discovery-doc-revision: '20241030' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250826' + x-generated-date: '2025-08-28' externalDocs: url: https://developers.google.com/maps/documentation/solar servers: @@ -34,323 +34,280 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - FinancialAnalysis: - properties: - monthlyBill: - $ref: '#/components/schemas/Money' - description: The monthly electric bill this analysis assumes. - averageKwhPerMonth: - type: number - description: >- - How much electricity the house uses in an average month, based on - the bill size and the local electricity rates. - format: float - financialDetails: - description: >- - Financial information that applies regardless of the financing - method used. - $ref: '#/components/schemas/FinancialDetails' - defaultBill: - type: boolean - description: >- - Whether this is the bill size selected to be the default bill for - the area this building is in. Exactly one `FinancialAnalysis` in - `BuildingSolarPotential` should have `default_bill` set. - leasingSavings: - $ref: '#/components/schemas/LeasingSavings' - description: Cost and benefit of leasing the solar panels. - cashPurchaseSavings: - $ref: '#/components/schemas/CashPurchaseSavings' - description: Cost and benefit of buying the solar panels with cash. - financedPurchaseSavings: - $ref: '#/components/schemas/FinancedPurchaseSavings' - description: >- - Cost and benefit of buying the solar panels by financing the - purchase. - panelConfigIndex: - format: int32 - type: integer - description: >- - Index in solar_panel_configs of the optimum solar layout for this - bill size. This can be -1 indicating that there is no layout. In - this case, the remaining submessages will be omitted. - type: object + BuildingInsights: + id: BuildingInsights description: >- - Analysis of the cost and benefits of the optimum solar layout for a - particular electric bill size. - id: FinancialAnalysis - LeasingSavings: - properties: - savings: - description: How much is saved (or not) over the lifetime period. - $ref: '#/components/schemas/SavingsOverTime' - leasesSupported: - description: >- - Whether leases are supported in this juristiction by the financial - calculation engine. If this field is false, then the values in this - message should probably be ignored. This is independent of - `leases_allowed`: in some areas leases are allowed, but under - conditions that aren't handled by the financial models. - type: boolean - leasesAllowed: - description: >- - Whether leases are allowed in this juristiction (leases are not - allowed in some states). If this field is false, then the values in - this message should probably be ignored. - type: boolean - annualLeasingCost: - description: Estimated annual leasing cost. - $ref: '#/components/schemas/Money' + Response message for `Solar.FindClosestBuildingInsights`. Information + about the location, dimensions, and solar potential of a building. type: object - id: LeasingSavings - description: >- - Cost and benefit of leasing a particular configuration of solar panels - with a particular electricity usage. - LatLngBox: properties: - ne: - $ref: '#/components/schemas/LatLng' - description: The northeast corner of the box. - sw: + name: + description: >- + The resource name for the building, of the format + `buildings/{place_id}`. + type: string + center: + description: A point near the center of the building. $ref: '#/components/schemas/LatLng' - description: The southwest corner of the box. - description: A bounding box in lat/lng coordinates. - type: object - id: LatLngBox - Money: - properties: - units: + boundingBox: + description: The bounding box of the building. + $ref: '#/components/schemas/LatLngBox' + imageryDate: + description: Date that the underlying imagery was acquired. This is approximate. + $ref: '#/components/schemas/Date' + imageryProcessedDate: + description: When processing was completed on this imagery. + $ref: '#/components/schemas/Date' + postalCode: + description: Postal code (e.g., US zip code) this building is contained by. type: string + administrativeArea: description: >- - The whole units of the amount. For example if `currencyCode` is - `"USD"`, then 1 unit is one US dollar. - format: int64 - currencyCode: + Administrative area 1 (e.g., in the US, the state) that contains + this building. For example, in the US, the abbreviation might be + "MA" or "CA." type: string - description: The three-letter currency code defined in ISO 4217. - nanos: - description: >- - Number of nano (10^-9) units of the amount. The value must be - between -999,999,999 and +999,999,999 inclusive. If `units` is - positive, `nanos` must be positive or zero. If `units` is zero, - `nanos` can be positive, zero, or negative. If `units` is negative, - `nanos` must be negative or zero. For example $-1.75 is represented - as `units`=-1 and `nanos`=-750,000,000. - type: integer - format: int32 - description: Represents an amount of money with its currency type. - id: Money - type: object - FinancedPurchaseSavings: - type: object - id: FinancedPurchaseSavings - properties: - loanInterestRate: - format: float - type: number - description: The interest rate on loans assumed in this set of calculations. - savings: - description: How much is saved (or not) over the lifetime period. - $ref: '#/components/schemas/SavingsOverTime' - rebateValue: + statisticalArea: + description: Statistical area (e.g., US census tract) this building is in. + type: string + regionCode: + description: Region code for the country (or region) this building is in. + type: string + solarPotential: + description: Solar potential of the building. + $ref: '#/components/schemas/SolarPotential' + imageryQuality: description: >- - The value of all tax rebates (including Federal Investment Tax - Credit (ITC)). - $ref: '#/components/schemas/Money' - annualLoanPayment: - description: Annual loan payments. - $ref: '#/components/schemas/Money' - description: >- - Cost and benefit of using a loan to buy a particular configuration of - solar panels with a particular electricity usage. + The quality of the imagery used to compute the data for this + building. + type: string + enumDescriptions: + - No quality is known. + - >- + Solar data is derived from aerial imagery captured at low-altitude + and processed at 0.1 m/pixel. + - >- + Solar data is derived from enhanced aerial imagery captured at + high-altitude and processed at 0.25 m/pixel. + - >- + Solar data is derived from enhanced satellite imagery processed at + 0.25 m/pixel. + - >- + Solar data is derived from enhanced satellite imagery processed at + 0.25 m/pixel. + enum: + - IMAGERY_QUALITY_UNSPECIFIED + - HIGH + - MEDIUM + - LOW + - BASE LatLng: id: LatLng + description: >- + An object that represents a latitude/longitude pair. This is expressed + as a pair of doubles to represent degrees latitude and degrees + longitude. Unless specified otherwise, this object must conform to the + WGS84 standard. Values must be within normalized ranges. + type: object properties: latitude: - format: double description: The latitude in degrees. It must be in the range [-90.0, +90.0]. type: number + format: double longitude: + description: The longitude in degrees. It must be in the range [-180.0, +180.0]. type: number format: double - description: The longitude in degrees. It must be in the range [-180.0, +180.0]. + LatLngBox: + id: LatLngBox + description: A bounding box in lat/lng coordinates. type: object + properties: + sw: + description: The southwest corner of the box. + $ref: '#/components/schemas/LatLng' + ne: + description: The northeast corner of the box. + $ref: '#/components/schemas/LatLng' + Date: + id: Date description: >- - An object that represents a latitude/longitude pair. This is expressed - as a pair of doubles to represent degrees latitude and degrees - longitude. Unless specified otherwise, this object must conform to the - WGS84 standard. Values must be within normalized ranges. - CashPurchaseSavings: + Represents a whole or partial calendar date, such as a birthday. The + time of day and time zone are either specified elsewhere or are + insignificant. The date is relative to the Gregorian Calendar. This can + represent one of the following: * A full date, with non-zero year, + month, and day values. * A month and day, with a zero year (for example, + an anniversary). * A year on its own, with a zero month and a zero day. + * A year and month, with a zero day (for example, a credit card + expiration date). Related types: * google.type.TimeOfDay * + google.type.DateTime * google.protobuf.Timestamp type: object - id: CashPurchaseSavings properties: - savings: - description: How much is saved (or not) over the lifetime period. - $ref: '#/components/schemas/SavingsOverTime' - paybackYears: - format: float - type: number + year: description: >- - Number of years until payback occurs. A negative value means payback - never occurs within the lifetime period. - rebateValue: - $ref: '#/components/schemas/Money' - description: The value of all tax rebates. - outOfPocketCost: - $ref: '#/components/schemas/Money' + Year of the date. Must be from 1 to 9999, or 0 to specify a date + without a year. + type: integer + format: int32 + month: description: >- - Initial cost before tax incentives: the amount that must be paid - out-of-pocket. Contrast with `upfront_cost`, which is after tax - incentives. - upfrontCost: - $ref: '#/components/schemas/Money' + Month of a year. Must be from 1 to 12, or 0 to specify a year + without a month and day. + type: integer + format: int32 + day: description: >- - Initial cost after tax incentives: it's the amount that must be paid - during first year. Contrast with `out_of_pocket_cost`, which is - before tax incentives. - description: >- - Cost and benefit of an outright purchase of a particular configuration - of solar panels with a particular electricity usage. - SolarPanelConfig: - id: SolarPanelConfig + Day of a month. Must be from 1 to 31 and valid for the year and + month, or 0 to specify a year by itself or a year and month where + the day isn't significant. + type: integer + format: int32 + SolarPotential: + id: SolarPotential description: >- - SolarPanelConfig describes a particular placement of solar panels on the - roof. + Information about the solar potential of a building. A number of fields + in this are defined in terms of "panels". The fields + panel_capacity_watts, panel_height_meters, and panel_width_meters + describe the parameters of the model of panel used in these + calculations. + type: object properties: - roofSegmentSummaries: - items: - $ref: '#/components/schemas/RoofSegmentSummary' - type: array + maxArrayPanelsCount: description: >- - Information about the production of each roof segment that is - carrying at least one panel in this layout. - `roof_segment_summaries[i]` describes the i-th roof segment, - including its size, expected production and orientation. - yearlyEnergyDcKwh: + Size of the maximum array - that is, the maximum number of panels + that can fit on the roof. + type: integer + format: int32 + panelCapacityWatts: + description: Capacity, in watts, of the panel used in the calculations. + type: number + format: float + panelHeightMeters: + description: >- + Height, in meters in portrait orientation, of the panel used in the + calculations. + type: number + format: float + panelWidthMeters: description: >- - How much sunlight energy this layout captures over the course of a - year, in DC kWh, assuming the panels described above. + Width, in meters in portrait orientation, of the panel used in the + calculations. type: number format: float - panelsCount: - type: integer - format: int32 + panelLifetimeYears: description: >- - Total number of panels. Note that this is redundant to (the sum of) - the corresponding fields in roof_segment_summaries. - type: object - RoofSegmentSummary: - description: >- - Information about a roof segment on the building, with some number of - panels placed on it. - properties: - panelsCount: - type: integer - format: int32 - description: The total number of panels on this segment. - segmentIndex: + The expected lifetime, in years, of the solar panels. This is used + in the financial calculations. type: integer format: int32 - description: >- - Index in roof_segment_stats of the corresponding - `RoofSegmentSizeAndSunshineStats`. - yearlyEnergyDcKwh: - format: float + maxArrayAreaMeters2: + description: Size, in square meters, of the maximum array. type: number + format: float + maxSunshineHoursPerYear: description: >- - How much sunlight energy this part of the layout captures over the - course of a year, in DC kWh, assuming the panels described above. - azimuthDegrees: + Maximum number of sunshine hours received per year, by any point on + the roof. Sunshine hours are a measure of the total amount of + insolation (energy) received per year. 1 sunshine hour = 1 kWh per + kW (where kW refers to kW of capacity under Standard Testing + Conditions). type: number format: float + carbonOffsetFactorKgPerMwh: description: >- - Compass direction the roof segment is pointing in. 0 = North, 90 = - East, 180 = South. For a "flat" roof segment (`pitch_degrees` very - near 0), azimuth is not well defined, so for consistency, we define - it arbitrarily to be 0 (North). - pitchDegrees: - description: >- - Angle of the roof segment relative to the theoretical ground plane. - 0 = parallel to the ground, 90 = perpendicular to the ground. + Equivalent amount of CO2 produced per MWh of grid electricity. This + is a measure of the carbon intensity of grid electricity displaced + by solar electricity. type: number format: float - id: RoofSegmentSummary + wholeRoofStats: + description: >- + Total size and sunlight quantiles for the part of the roof that was + assigned to some roof segment. Despite the name, this may not + include the entire building. See building_stats. + $ref: '#/components/schemas/SizeAndSunshineStats' + buildingStats: + description: >- + Size and sunlight quantiles for the entire building, including parts + of the roof that were not assigned to some roof segment. Because the + orientations of these parts are not well characterised, the roof + area estimate is unreliable, but the ground area estimate is + reliable. It may be that a more reliable whole building roof area + can be obtained by scaling the roof area from whole_roof_stats by + the ratio of the ground areas of `building_stats` and + `whole_roof_stats`. + $ref: '#/components/schemas/SizeAndSunshineStats' + roofSegmentStats: + description: Size and sunlight quantiles for each roof segment. + type: array + items: + $ref: '#/components/schemas/RoofSegmentSizeAndSunshineStats' + solarPanels: + description: >- + Each SolarPanel describes a single solar panel. They are listed in + the order that the panel layout algorithm placed this. This is + usually, though not always, in decreasing order of annual energy + production. + type: array + items: + $ref: '#/components/schemas/SolarPanel' + solarPanelConfigs: + description: >- + Each SolarPanelConfig describes a different arrangement of solar + panels on the roof. They are in order of increasing number of + panels. The `SolarPanelConfig` with panels_count=N is based on the + first N panels in the `solar_panels` list. This field is only + populated if at least 4 panels can fit on a roof. + type: array + items: + $ref: '#/components/schemas/SolarPanelConfig' + financialAnalyses: + description: >- + A FinancialAnalysis gives the savings from going solar assuming a + given monthly bill and a given electricity provider. They are in + order of increasing order of monthly bill amount. This field will be + empty for buildings in areas for which the Solar API does not have + enough information to perform financial computations. + type: array + items: + $ref: '#/components/schemas/FinancialAnalysis' + SizeAndSunshineStats: + id: SizeAndSunshineStats + description: Size and sunniness quantiles of a roof, or part of a roof. type: object - BuildingInsights: properties: - administrativeArea: + areaMeters2: description: >- - Administrative area 1 (e.g., in the US, the state) that contains - this building. For example, in the US, the abbreviation might be - "MA" or "CA." - type: string - name: - description: The resource name for the building, of the format `building/`. - type: string - boundingBox: - description: The bounding box of the building. - $ref: '#/components/schemas/LatLngBox' - center: - description: A point near the center of the building. - $ref: '#/components/schemas/LatLng' - regionCode: - type: string - description: Region code for the country (or region) this building is in. - imageryDate: - description: Date that the underlying imagery was acquired. This is approximate. - $ref: '#/components/schemas/Date' - postalCode: - type: string - description: Postal code (e.g., US zip code) this building is contained by. - imageryProcessedDate: - $ref: '#/components/schemas/Date' - description: When processing was completed on this imagery. - statisticalArea: - type: string - description: Statistical area (e.g., US census tract) this building is in. - solarPotential: - description: Solar potential of the building. - $ref: '#/components/schemas/SolarPotential' - imageryQuality: - type: string - enumDescriptions: - - No quality is known. - - >- - Solar data is derived from aerial imagery captured at low-altitude - and processed at 0.1 m/pixel. - - >- - Solar data is derived from enhanced aerial imagery captured at - high-altitude and processed at 0.25 m/pixel. - - >- - Solar data is derived from enhanced satellite imagery processed at - 0.25 m/pixel. - - >- - Solar data is derived from enhanced satellite imagery processed at - 0.25 m/pixel. - enum: - - IMAGERY_QUALITY_UNSPECIFIED - - HIGH - - MEDIUM - - LOW - - BASE + The area of the roof or roof segment, in m^2. This is the roof area + (accounting for tilt), not the ground footprint area. + type: number + format: float + sunshineQuantiles: description: >- - The quality of the imagery used to compute the data for this - building. - id: BuildingInsights - description: >- - Response message for `Solar.FindClosestBuildingInsights`. Information - about the location, dimensions, and solar potential of a building. - type: object + Quantiles of the pointwise sunniness across the area. If there are N + values here, this represents the (N-1)-iles. For example, if there + are 5 values, then they would be the quartiles (min, 25%, 50%, 75%, + max). Values are in annual kWh/kW like max_sunshine_hours_per_year. + type: array + items: + type: number + format: float + groundAreaMeters2: + description: >- + The ground footprint area covered by the roof or roof segment, in + m^2. + type: number + format: float RoofSegmentSizeAndSunshineStats: + id: RoofSegmentSizeAndSunshineStats description: Information about the size and sunniness quantiles of a roof segment. type: object - id: RoofSegmentSizeAndSunshineStats properties: pitchDegrees: - type: number description: >- Angle of the roof segment relative to the theoretical ground plane. 0 = parallel to the ground, 90 = perpendicular to the ground. + type: number format: float azimuthDegrees: description: >- @@ -360,110 +317,37 @@ components: it arbitrarily to be 0 (North). type: number format: float - planeHeightAtCenterMeters: - description: >- - The height of the roof segment plane, in meters above sea level, at - the point designated by `center`. Together with the pitch, azimuth, - and center location, this fully defines the roof segment plane. - type: number - format: float stats: - $ref: '#/components/schemas/SizeAndSunshineStats' description: Total size and sunlight quantiles for the roof segment. - boundingBox: - $ref: '#/components/schemas/LatLngBox' - description: The bounding box of the roof segment. + $ref: '#/components/schemas/SizeAndSunshineStats' center: - $ref: '#/components/schemas/LatLng' description: A point near the center of the roof segment. - FinancialDetails: - properties: - stateIncentive: - $ref: '#/components/schemas/Money' - description: >- - Amount of money available from state incentives; this applies if the - user buys (with or without a loan) the panels. - costOfElectricityWithoutSolar: - description: >- - Total cost of electricity the user would have paid over the lifetime - period if they didn't install solar. - $ref: '#/components/schemas/Money' - percentageExportedToGrid: - format: float - type: number - description: >- - The percentage (0-100) of solar electricity production we assumed - was exported to the grid, based on the first quarter of production. - This affects the calculations if net metering is not allowed. - netMeteringAllowed: - description: Whether net metering is allowed. - type: boolean - utilityIncentive: - $ref: '#/components/schemas/Money' - description: >- - Amount of money available from utility incentives; this applies if - the user buys (with or without a loan) the panels. - remainingLifetimeUtilityBill: - description: >- - Utility bill for electricity not produced by solar, for the lifetime - of the panels. - $ref: '#/components/schemas/Money' - federalIncentive: - description: >- - Amount of money available from federal incentives; this applies if - the user buys (with or without a loan) the panels. - $ref: '#/components/schemas/Money' - initialAcKwhPerYear: - description: >- - How many AC kWh we think the solar panels will generate in their - first year. - type: number - format: float - solarPercentage: - format: float + $ref: '#/components/schemas/LatLng' + boundingBox: + description: The bounding box of the roof segment. + $ref: '#/components/schemas/LatLngBox' + planeHeightAtCenterMeters: description: >- - Percentage (0-100) of the user's power supplied by solar. Valid for - the first year but approximately correct for future years. + The height of the roof segment plane, in meters above sea level, at + the point designated by `center`. Together with the pitch, azimuth, + and center location, this fully defines the roof segment plane. type: number - lifetimeSrecTotal: - $ref: '#/components/schemas/Money' - description: >- - Amount of money the user will receive from Solar Renewable Energy - Credits over the panel lifetime; this applies if the user buys (with - or without a loan) the panels. - description: >- - Details of a financial analysis. Some of these details are already - stored at higher levels (e.g., out of pocket cost). Total money amounts - are over a lifetime period defined by the panel_lifetime_years field in - SolarPotential. Note: The out of pocket cost of purchasing the panels is - given in the out_of_pocket_cost field in CashPurchaseSavings. - id: FinancialDetails - type: object + format: float SolarPanel: - type: object id: SolarPanel description: >- SolarPanel describes the position, orientation, and production of a single solar panel. See the panel_height_meters, panel_width_meters, and panel_capacity_watts fields in SolarPotential for information on the parameters of the panel. + type: object properties: center: description: The centre of the panel. $ref: '#/components/schemas/LatLng' - segmentIndex: - description: >- - Index in roof_segment_stats of the `RoofSegmentSizeAndSunshineStats` - which corresponds to the roof segment that this panel is placed on. - type: integer - format: int32 orientation: - type: string - enum: - - SOLAR_PANEL_ORIENTATION_UNSPECIFIED - - LANDSCAPE - - PORTRAIT description: The orientation of the panel. + type: string enumDescriptions: - No panel orientation is known. - >- @@ -472,271 +356,383 @@ components: - >- A `PORTRAIT` panel has its long edge parallel to the azimuth direction of the roof segment that it is placed on. + enum: + - SOLAR_PANEL_ORIENTATION_UNSPECIFIED + - LANDSCAPE + - PORTRAIT yearlyEnergyDcKwh: - type: number - format: float description: >- How much sunlight energy this layout captures over the course of a year, in DC kWh. - SolarPotential: - id: SolarPotential - properties: - maxSunshineHoursPerYear: type: number + format: float + segmentIndex: description: >- - Maximum number of sunshine hours received per year, by any point on - the roof. Sunshine hours are a measure of the total amount of - insolation (energy) received per year. 1 sunshine hour = 1 kWh per - kW (where kW refers to kW of capacity under Standard Testing - Conditions). + Index in roof_segment_stats of the `RoofSegmentSizeAndSunshineStats` + which corresponds to the roof segment that this panel is placed on. + type: integer + format: int32 + SolarPanelConfig: + id: SolarPanelConfig + description: >- + SolarPanelConfig describes a particular placement of solar panels on the + roof. + type: object + properties: + panelsCount: + description: >- + Total number of panels. Note that this is redundant to (the sum of) + the corresponding fields in roof_segment_summaries. + type: integer + format: int32 + yearlyEnergyDcKwh: + description: >- + How much sunlight energy this layout captures over the course of a + year, in DC kWh, assuming the panels described above. + type: number format: float - solarPanelConfigs: - items: - $ref: '#/components/schemas/SolarPanelConfig' + roofSegmentSummaries: description: >- - Each SolarPanelConfig describes a different arrangement of solar - panels on the roof. They are in order of increasing number of - panels. The `SolarPanelConfig` with panels_count=N is based on the - first N panels in the `solar_panels` list. This field is only - populated if at least 4 panels can fit on a roof. + Information about the production of each roof segment that is + carrying at least one panel in this layout. + `roof_segment_summaries[i]` describes the i-th roof segment, + including its size, expected production and orientation. type: array - carbonOffsetFactorKgPerMwh: + items: + $ref: '#/components/schemas/RoofSegmentSummary' + RoofSegmentSummary: + id: RoofSegmentSummary + description: >- + Information about a roof segment on the building, with some number of + panels placed on it. + type: object + properties: + pitchDegrees: description: >- - Equivalent amount of CO2 produced per MWh of grid electricity. This - is a measure of the carbon intensity of grid electricity displaced - by solar electricity. + Angle of the roof segment relative to the theoretical ground plane. + 0 = parallel to the ground, 90 = perpendicular to the ground. type: number format: float - maxArrayPanelsCount: + azimuthDegrees: + description: >- + Compass direction the roof segment is pointing in. 0 = North, 90 = + East, 180 = South. For a "flat" roof segment (`pitch_degrees` very + near 0), azimuth is not well defined, so for consistency, we define + it arbitrarily to be 0 (North). + type: number + format: float + panelsCount: + description: The total number of panels on this segment. type: integer format: int32 + yearlyEnergyDcKwh: description: >- - Size of the maximum array - that is, the maximum number of panels - that can fit on the roof. - panelWidthMeters: + How much sunlight energy this part of the layout captures over the + course of a year, in DC kWh, assuming the panels described above. type: number + format: float + segmentIndex: description: >- - Width, in meters in portrait orientation, of the panel used in the - calculations. + Index in roof_segment_stats of the corresponding + `RoofSegmentSizeAndSunshineStats`. + type: integer + format: int32 + FinancialAnalysis: + id: FinancialAnalysis + description: >- + Analysis of the cost and benefits of the optimum solar layout for a + particular electric bill size. + type: object + properties: + monthlyBill: + description: The monthly electric bill this analysis assumes. + $ref: '#/components/schemas/Money' + defaultBill: + description: >- + Whether this is the bill size selected to be the default bill for + the area this building is in. Exactly one `FinancialAnalysis` in + `BuildingSolarPotential` should have `default_bill` set. + type: boolean + averageKwhPerMonth: + description: >- + How much electricity the house uses in an average month, based on + the bill size and the local electricity rates. + type: number format: float - roofSegmentStats: - items: - $ref: '#/components/schemas/RoofSegmentSizeAndSunshineStats' - description: Size and sunlight quantiles for each roof segment. - type: array - buildingStats: + panelConfigIndex: description: >- - Size and sunlight quantiles for the entire building, including parts - of the roof that were not assigned to some roof segment. Because the - orientations of these parts are not well characterised, the roof - area estimate is unreliable, but the ground area estimate is - reliable. It may be that a more reliable whole building roof area - can be obtained by scaling the roof area from whole_roof_stats by - the ratio of the ground areas of `building_stats` and - `whole_roof_stats`. - $ref: '#/components/schemas/SizeAndSunshineStats' - financialAnalyses: - type: array + Index in solar_panel_configs of the optimum solar layout for this + bill size. This can be -1 indicating that there is no layout. In + this case, the remaining submessages will be omitted. + type: integer + format: int32 + financialDetails: description: >- - A FinancialAnalysis gives the savings from going solar assuming a - given monthly bill and a given electricity provider. They are in - order of increasing order of monthly bill amount. This field will be - empty for buildings in areas for which the Solar API does not have - enough information to perform financial computations. - items: - $ref: '#/components/schemas/FinancialAnalysis' - panelLifetimeYears: + Financial information that applies regardless of the financing + method used. + $ref: '#/components/schemas/FinancialDetails' + leasingSavings: + description: Cost and benefit of leasing the solar panels. + $ref: '#/components/schemas/LeasingSavings' + cashPurchaseSavings: + description: Cost and benefit of buying the solar panels with cash. + $ref: '#/components/schemas/CashPurchaseSavings' + financedPurchaseSavings: + description: >- + Cost and benefit of buying the solar panels by financing the + purchase. + $ref: '#/components/schemas/FinancedPurchaseSavings' + Money: + id: Money + description: Represents an amount of money with its currency type. + type: object + properties: + currencyCode: + description: The three-letter currency code defined in ISO 4217. + type: string + units: + description: >- + The whole units of the amount. For example if `currencyCode` is + `"USD"`, then 1 unit is one US dollar. + type: string + format: int64 + nanos: + description: >- + Number of nano (10^-9) units of the amount. The value must be + between -999,999,999 and +999,999,999 inclusive. If `units` is + positive, `nanos` must be positive or zero. If `units` is zero, + `nanos` can be positive, zero, or negative. If `units` is negative, + `nanos` must be negative or zero. For example $-1.75 is represented + as `units`=-1 and `nanos`=-750,000,000. type: integer format: int32 + FinancialDetails: + id: FinancialDetails + description: >- + Details of a financial analysis. Some of these details are already + stored at higher levels (e.g., out of pocket cost). Total money amounts + are over a lifetime period defined by the panel_lifetime_years field in + SolarPotential. Note: The out of pocket cost of purchasing the panels is + given in the out_of_pocket_cost field in CashPurchaseSavings. + type: object + properties: + initialAcKwhPerYear: description: >- - The expected lifetime, in years, of the solar panels. This is used - in the financial calculations. - panelCapacityWatts: - description: Capacity, in watts, of the panel used in the calculations. + How many AC kWh we think the solar panels will generate in their + first year. type: number format: float - solarPanels: - items: - $ref: '#/components/schemas/SolarPanel' - type: array + remainingLifetimeUtilityBill: + description: >- + Utility bill for electricity not produced by solar, for the lifetime + of the panels. + $ref: '#/components/schemas/Money' + federalIncentive: + description: >- + Amount of money available from federal incentives; this applies if + the user buys (with or without a loan) the panels. + $ref: '#/components/schemas/Money' + stateIncentive: + description: >- + Amount of money available from state incentives; this applies if the + user buys (with or without a loan) the panels. + $ref: '#/components/schemas/Money' + utilityIncentive: + description: >- + Amount of money available from utility incentives; this applies if + the user buys (with or without a loan) the panels. + $ref: '#/components/schemas/Money' + lifetimeSrecTotal: description: >- - Each SolarPanel describes a single solar panel. They are listed in - the order that the panel layout algorithm placed this. This is - usually, though not always, in decreasing order of annual energy - production. - wholeRoofStats: + Amount of money the user will receive from Solar Renewable Energy + Credits over the panel lifetime; this applies if the user buys (with + or without a loan) the panels. + $ref: '#/components/schemas/Money' + costOfElectricityWithoutSolar: description: >- - Total size and sunlight quantiles for the part of the roof that was - assigned to some roof segment. Despite the name, this may not - include the entire building. See building_stats. - $ref: '#/components/schemas/SizeAndSunshineStats' - maxArrayAreaMeters2: - format: float + Total cost of electricity the user would have paid over the lifetime + period if they didn't install solar. + $ref: '#/components/schemas/Money' + netMeteringAllowed: + description: Whether net metering is allowed. + type: boolean + solarPercentage: + description: >- + Percentage (0-100) of the user's power supplied by solar. Valid for + the first year but approximately correct for future years. type: number - description: Size, in square meters, of the maximum array. - panelHeightMeters: format: float + percentageExportedToGrid: description: >- - Height, in meters in portrait orientation, of the panel used in the - calculations. + The percentage (0-100) of solar electricity production we assumed + was exported to the grid, based on the first quarter of production. + This affects the calculations if net metering is not allowed. type: number + format: float + LeasingSavings: + id: LeasingSavings description: >- - Information about the solar potential of a building. A number of fields - in this are defined in terms of "panels". The fields - panel_capacity_watts, panel_height_meters, and panel_width_meters - describe the parameters of the model of panel used in these - calculations. - type: object - Date: + Cost and benefit of leasing a particular configuration of solar panels + with a particular electricity usage. type: object - id: Date properties: - day: - description: >- - Day of a month. Must be from 1 to 31 and valid for the year and - month, or 0 to specify a year by itself or a year and month where - the day isn't significant. - type: integer - format: int32 - year: + leasesAllowed: description: >- - Year of the date. Must be from 1 to 9999, or 0 to specify a date - without a year. - type: integer - format: int32 - month: - format: int32 + Whether leases are allowed in this juristiction (leases are not + allowed in some states). If this field is false, then the values in + this message should probably be ignored. + type: boolean + leasesSupported: description: >- - Month of a year. Must be from 1 to 12, or 0 to specify a year - without a month and day. - type: integer - description: >- - Represents a whole or partial calendar date, such as a birthday. The - time of day and time zone are either specified elsewhere or are - insignificant. The date is relative to the Gregorian Calendar. This can - represent one of the following: * A full date, with non-zero year, - month, and day values. * A month and day, with a zero year (for example, - an anniversary). * A year on its own, with a zero month and a zero day. - * A year and month, with a zero day (for example, a credit card - expiration date). Related types: * google.type.TimeOfDay * - google.type.DateTime * google.protobuf.Timestamp + Whether leases are supported in this juristiction by the financial + calculation engine. If this field is false, then the values in this + message should probably be ignored. This is independent of + `leases_allowed`: in some areas leases are allowed, but under + conditions that aren't handled by the financial models. + type: boolean + annualLeasingCost: + description: Estimated annual leasing cost. + $ref: '#/components/schemas/Money' + savings: + description: How much is saved (or not) over the lifetime period. + $ref: '#/components/schemas/SavingsOverTime' SavingsOverTime: + id: SavingsOverTime + description: Financial information that's shared between different financing methods. + type: object properties: savingsYear1: description: Savings in the first year after panel installation. $ref: '#/components/schemas/Money' - financiallyViable: - description: >- - Indicates whether this scenario is financially viable. Will be false - for scenarios with poor financial viability (e.g., money-losing). - type: boolean - presentValueOfSavingsYear20: + savingsYear20: + description: Savings in the first twenty years after panel installation. $ref: '#/components/schemas/Money' + presentValueOfSavingsYear20: description: >- Using the assumed discount rate, what is the present value of the cumulative 20-year savings? - savingsYear20: - description: Savings in the first twenty years after panel installation. $ref: '#/components/schemas/Money' savingsLifetime: description: Savings in the entire panel lifetime. $ref: '#/components/schemas/Money' presentValueOfSavingsLifetime: - $ref: '#/components/schemas/Money' description: >- Using the assumed discount rate, what is the present value of the cumulative lifetime savings? - description: Financial information that's shared between different financing methods. - id: SavingsOverTime + $ref: '#/components/schemas/Money' + financiallyViable: + description: >- + Indicates whether this scenario is financially viable. Will be false + for scenarios with poor financial viability (e.g., money-losing). + type: boolean + CashPurchaseSavings: + id: CashPurchaseSavings + description: >- + Cost and benefit of an outright purchase of a particular configuration + of solar panels with a particular electricity usage. type: object - SizeAndSunshineStats: - id: SizeAndSunshineStats properties: - sunshineQuantiles: + outOfPocketCost: description: >- - Quantiles of the pointwise sunniness across the area. If there are N - values here, this represents the (N-1)-iles. For example, if there - are 5 values, then they would be the quartiles (min, 25%, 50%, 75%, - max). Values are in annual kWh/kW like max_sunshine_hours_per_year. - items: - format: float - type: number - type: array - groundAreaMeters2: + Initial cost before tax incentives: the amount that must be paid + out-of-pocket. Contrast with `upfront_cost`, which is after tax + incentives. + $ref: '#/components/schemas/Money' + upfrontCost: + description: >- + Initial cost after tax incentives: it's the amount that must be paid + during first year. Contrast with `out_of_pocket_cost`, which is + before tax incentives. + $ref: '#/components/schemas/Money' + rebateValue: + description: The value of all tax rebates. + $ref: '#/components/schemas/Money' + paybackYears: + description: >- + Number of years until payback occurs. A negative value means payback + never occurs within the lifetime period. type: number format: float + savings: + description: How much is saved (or not) over the lifetime period. + $ref: '#/components/schemas/SavingsOverTime' + FinancedPurchaseSavings: + id: FinancedPurchaseSavings + description: >- + Cost and benefit of using a loan to buy a particular configuration of + solar panels with a particular electricity usage. + type: object + properties: + annualLoanPayment: + description: Annual loan payments. + $ref: '#/components/schemas/Money' + rebateValue: description: >- - The ground footprint area covered by the roof or roof segment, in - m^2. - areaMeters2: + The value of all tax rebates (including Federal Investment Tax + Credit (ITC)). + $ref: '#/components/schemas/Money' + loanInterestRate: + description: The interest rate on loans assumed in this set of calculations. type: number format: float - description: >- - The area of the roof or roof segment, in m^2. This is the roof area - (accounting for tilt), not the ground footprint area. - type: object - description: Size and sunniness quantiles of a roof, or part of a roof. - HttpBody: - id: HttpBody + savings: + description: How much is saved (or not) over the lifetime period. + $ref: '#/components/schemas/SavingsOverTime' + DataLayers: + id: DataLayers description: >- - Message that represents an arbitrary HTTP body. It should only be used - for payload formats that can't be represented as JSON, such as raw - binary or an HTML page. This message can be used both in streaming and - non-streaming API methods in the request as well as the response. It can - be used as a top-level request field, which is convenient if one wants - to extract parameters from either the URL or HTTP template into the - request fields and also want access to the raw HTTP body. Example: - message GetResourceRequest { // A unique request id. string request_id = - 1; // The raw HTTP body is bound to this field. google.api.HttpBody - http_body = 2; } service ResourceService { rpc - GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc - UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } - Example with streaming methods: service CaldavService { rpc - GetCalendar(stream google.api.HttpBody) returns (stream - google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) - returns (stream google.api.HttpBody); } Use of this type only changes - how the request and response bodies are handled, all other features will - continue to work unchanged. + Information about the solar potential of a region. The actual data are + contained in a number of GeoTIFF files covering the requested region, + for which this message contains URLs: Each string in the `DataLayers` + message contains a URL from which the corresponding GeoTIFF can be + fetched. These URLs are valid for a few hours after they've been + generated. Most of the GeoTIFF files are at a resolution of 0.1m/pixel, + but the monthly flux file is at 0.5m/pixel, and the hourly shade files + are at 1m/pixel. If a `pixel_size_meters` value was specified in the + `GetDataLayersRequest`, then the minimum resolution in the GeoTIFF files + will be that value. + type: object properties: - extensions: - type: array + imageryDate: description: >- - Application specific response metadata. Must be set in the first - response for streaming APIs. - items: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - data: - description: The HTTP request/response body as raw binary. - format: byte + When the source imagery (from which all the other data are derived) + in this region was taken. It is necessarily somewhat approximate, as + the images may have been taken over more than one day. + $ref: '#/components/schemas/Date' + imageryProcessedDate: + description: When processing was completed on this imagery. + $ref: '#/components/schemas/Date' + dsmUrl: + description: >- + The URL for an image of the DSM (Digital Surface Model) of the + region. Values are in meters above EGM96 geoid (i.e., sea level). + Invalid locations (where we don't have data) are stored as -9999. type: string - contentType: + rgbUrl: + description: The URL for an image of RGB data (aerial photo) of the region. + type: string + maskUrl: + description: >- + The URL for the building mask image: one bit per pixel saying + whether that pixel is considered to be part of a rooftop or not. + type: string + annualFluxUrl: + description: >- + The URL for the annual flux map (annual sunlight on roofs) of the + region. Values are kWh/kW/year. This is *unmasked flux*: flux is + computed for every location, not just building rooftops. Invalid + locations are stored as -9999: locations outside our coverage area + will be invalid, and a few locations inside the coverage area, where + we were unable to calculate flux, will also be invalid. type: string + monthlyFluxUrl: description: >- - The HTTP Content-Type header value specifying the content type of - the body. - type: object - DataLayers: - description: >- - Information about the solar potential of a region. The actual data are - contained in a number of GeoTIFF files covering the requested region, - for which this message contains URLs: Each string in the `DataLayers` - message contains a URL from which the corresponding GeoTIFF can be - fetched. These URLs are valid for a few hours after they've been - generated. Most of the GeoTIFF files are at a resolution of 0.1m/pixel, - but the monthly flux file is at 0.5m/pixel, and the hourly shade files - are at 1m/pixel. If a `pixel_size_meters` value was specified in the - `GetDataLayersRequest`, then the minimum resolution in the GeoTIFF files - will be that value. - type: object - id: DataLayers - properties: + The URL for the monthly flux map (sunlight on roofs, broken down by + month) of the region. Values are kWh/kW/year. The GeoTIFF pointed to + by this URL will contain twelve bands, corresponding to + January...December, in order. + type: string hourlyShadeUrls: - type: array - items: - type: string description: >- Twelve URLs for hourly shade, corresponding to January...December, in order. Each GeoTIFF will contain 24 bands, corresponding to the @@ -761,13 +757,12 @@ components: the channels, and a final non-zero result means "sunny". There are no leap days, and DST doesn't exist (all days are 24 hours long; noon is always "standard time" noon). + type: array + items: + type: string imageryQuality: - enum: - - IMAGERY_QUALITY_UNSPECIFIED - - HIGH - - MEDIUM - - LOW - - BASE + description: The quality of the result's imagery. + type: string enumDescriptions: - No quality is known. - >- @@ -782,90 +777,83 @@ components: - >- Solar data is derived from enhanced satellite imagery processed at 0.25 m/pixel. - description: The quality of the result's imagery. - type: string - dsmUrl: - description: >- - The URL for an image of the DSM (Digital Surface Model) of the - region. Values are in meters above EGM96 geoid (i.e., sea level). - Invalid locations (where we don't have data) are stored as -9999. - type: string - monthlyFluxUrl: - type: string - description: >- - The URL for the monthly flux map (sunlight on roofs, broken down by - month) of the region. Values are kWh/kW/year. The GeoTIFF pointed to - by this URL will contain twelve bands, corresponding to - January...December, in order. - maskUrl: - type: string + enum: + - IMAGERY_QUALITY_UNSPECIFIED + - HIGH + - MEDIUM + - LOW + - BASE + HttpBody: + id: HttpBody + description: >- + Message that represents an arbitrary HTTP body. It should only be used + for payload formats that can't be represented as JSON, such as raw + binary or an HTML page. This message can be used both in streaming and + non-streaming API methods in the request as well as the response. It can + be used as a top-level request field, which is convenient if one wants + to extract parameters from either the URL or HTTP template into the + request fields and also want access to the raw HTTP body. Example: + message GetResourceRequest { // A unique request id. string request_id = + 1; // The raw HTTP body is bound to this field. google.api.HttpBody + http_body = 2; } service ResourceService { rpc + GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc + UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } + Example with streaming methods: service CaldavService { rpc + GetCalendar(stream google.api.HttpBody) returns (stream + google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) + returns (stream google.api.HttpBody); } Use of this type only changes + how the request and response bodies are handled, all other features will + continue to work unchanged. + type: object + properties: + contentType: description: >- - The URL for the building mask image: one bit per pixel saying - whether that pixel is considered to be part of a rooftop or not. - imageryProcessedDate: - description: When processing was completed on this imagery. - $ref: '#/components/schemas/Date' - annualFluxUrl: + The HTTP Content-Type header value specifying the content type of + the body. type: string - description: >- - The URL for the annual flux map (annual sunlight on roofs) of the - region. Values are kWh/kW/year. This is *unmasked flux*: flux is - computed for every location, not just building rooftops. Invalid - locations are stored as -9999: locations outside our coverage area - will be invalid, and a few locations inside the coverage area, where - we were unable to calculate flux, will also be invalid. - rgbUrl: + data: + description: The HTTP request/response body as raw binary. type: string - description: The URL for an image of RGB data (aerial photo) of the region. - imageryDate: - $ref: '#/components/schemas/Date' + format: byte + extensions: description: >- - When the source imagery (from which all the other data are derived) - in this region was taken. It is necessarily somewhat approximate, as - the images may have been taken over more than one day. + Application specific response metadata. Must be set in the first + response for streaming APIs. + type: array + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. parameters: - _.xgafv: - description: V1 error format. - in: query - name: $.xgafv - schema: - type: string - enum: - - '1' - - '2' - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string - 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 - oauth_token: - description: OAuth 2.0 token for the current user. + access_token: + description: OAuth access token. in: query - name: oauth_token + name: access_token schema: type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + alt: + description: Data format for response. in: query - name: uploadType + name: alt schema: type: string + enum: + - json + - media + - proto 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 @@ -875,34 +863,48 @@ components: 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 - access_token: - description: OAuth access token. + 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: access_token + name: quotaUser schema: type: string - alt: - description: Data format for response. + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: alt + name: upload_protocol schema: type: string - enum: - - json - - media - - proto - fields: - description: Selector specifying which fields to include in a partial response. + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: fields + name: uploadType + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv schema: type: string + enum: + - '1' + - '2' x-stackQL-resources: building_insights: id: google.solar.building_insights @@ -960,22 +962,22 @@ components: paths: /v1/buildingInsights:findClosest: parameters: &ref_1 - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' get: description: >- - Locates the closest building to a query point. Returns an error with - code `NOT_FOUND` if there are no buildings within approximately 50m of - the query point. + Locates the building whose centroid is closest to a query point. Returns + an error with code `NOT_FOUND` if there are no buildings within + approximately 50m of the query point. operationId: solar.buildingInsights.findClosest security: - Oauth2: @@ -991,19 +993,19 @@ paths: $ref: '#/components/schemas/BuildingInsights' parameters: - in: query - name: requiredQuality + name: location.latitude schema: - type: string + type: number + format: double - in: query name: location.longitude schema: type: number format: double - in: query - name: location.latitude + name: requiredQuality schema: - type: number - format: double + type: string - in: query name: experiments schema: @@ -1030,23 +1032,28 @@ paths: $ref: '#/components/schemas/DataLayers' parameters: - in: query - name: radiusMeters + name: location.latitude schema: type: number - format: float + format: double - in: query - name: requiredQuality + name: location.longitude schema: - type: string + type: number + format: double + - in: query + name: radiusMeters + schema: + type: number + format: float - in: query name: view schema: type: string - in: query - name: location.latitude + name: requiredQuality schema: - type: number - format: double + type: string - in: query name: pixelSizeMeters schema: @@ -1056,11 +1063,6 @@ paths: name: exactQualityRequired schema: type: boolean - - in: query - name: location.longitude - schema: - type: number - format: double - in: query name: experiments schema: diff --git a/providers/src/googleapis.com/v00.00.00000/services/spanner.yaml b/providers/src/googleapis.com/v00.00.00000/services/spanner.yaml index d72d1b80..7c4ebbc3 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/spanner.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/spanner.yaml @@ -9,8 +9,8 @@ info: Cloud Spanner is a managed, mission-critical, globally consistent and scalable relational database service. version: v1 - x-discovery-doc-revision: '20241028' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250730' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/spanner/ servers: @@ -596,482 +596,930 @@ components: { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } type: object properties: {} - ListDatabasesResponse: - id: ListDatabasesResponse - description: The response for ListDatabases. + AdapterSession: + id: AdapterSession + description: A session in the Cloud Spanner Adapter API. type: object properties: - databases: - description: Databases that matched the request. + name: + description: Identifier. The name of the session. This is always system-assigned. + type: string + AdaptMessageRequest: + id: AdaptMessageRequest + description: Message sent by the client to the adapter. + type: object + properties: + protocol: + description: Required. Identifier for the underlying wire protocol. + type: string + payload: + description: Optional. Uninterpreted bytes from the underlying wire protocol. + type: string + format: byte + attachments: + description: Optional. Opaque request state passed by the client to the server. + type: object + additionalProperties: + type: string + AdaptMessageResponse: + id: AdaptMessageResponse + description: Message sent by the adapter to the client. + type: object + properties: + payload: + description: Optional. Uninterpreted bytes from the underlying wire protocol. + type: string + format: byte + stateUpdates: + description: Optional. Opaque state updates to be applied by the client. + type: object + additionalProperties: + type: string + ListInstanceConfigsResponse: + id: ListInstanceConfigsResponse + description: The response for ListInstanceConfigs. + type: object + properties: + instanceConfigs: + description: The list of requested instance configurations. type: array items: - $ref: '#/components/schemas/Database' + $ref: '#/components/schemas/InstanceConfig' nextPageToken: description: >- - `next_page_token` can be sent in a subsequent ListDatabases call to - fetch more of the matching databases. + `next_page_token` can be sent in a subsequent ListInstanceConfigs + call to fetch more of the matching instance configurations. type: string - Database: - id: Database - description: A Cloud Spanner database. + InstanceConfig: + id: InstanceConfig + description: >- + A possible configuration for a Cloud Spanner instance. Configurations + define the geographic placement of nodes and their replication. type: object properties: name: description: >- - Required. The name of the database. Values are of the form - `projects//instances//databases/`, where `` is as specified in the - `CREATE DATABASE` statement. This name can be passed to other API - methods to identify the database. + A unique identifier for the instance configuration. Values are of + the form `projects//instanceConfigs/a-z*`. User instance + configuration must start with `custom-`. type: string - state: - description: Output only. The current database state. - readOnly: true + displayName: + description: The name of this instance configuration as it appears in UIs. type: string - enumDescriptions: - - Not specified. - - >- - The database is still being created. Operations on the database - may fail with `FAILED_PRECONDITION` in this state. - - The database is fully created and ready for use. - - >- - The database is fully created and ready for use, but is still - being optimized for performance and cannot handle full load. In - this state, the database still references the backup it was - restore from, preventing the backup from being deleted. When - optimizations are complete, the full performance of the database - will be restored, and the database will transition to `READY` - state. - enum: - - STATE_UNSPECIFIED - - CREATING - - READY - - READY_OPTIMIZING - createTime: + configType: description: >- - Output only. If exists, the time at which the database creation - started. + Output only. Whether this instance configuration is a Google-managed + or user-managed configuration. readOnly: true type: string - format: google-datetime - restoreInfo: - description: >- - Output only. Applicable only for restored databases. Contains - information about the restore source. - readOnly: true - $ref: '#/components/schemas/RestoreInfo' - encryptionConfig: + enumDescriptions: + - Unspecified. + - Google-managed configuration. + - User-managed configuration. + enum: + - TYPE_UNSPECIFIED + - GOOGLE_MANAGED + - USER_MANAGED + replicas: description: >- - Output only. For databases that are using customer managed - encryption, this field contains the encryption configuration for the - database. For databases that are using Google default or other types - of encryption, this field is empty. - readOnly: true - $ref: '#/components/schemas/EncryptionConfig' - encryptionInfo: + The geographic placement of nodes in this instance configuration and + their replication properties. To create user-managed configurations, + input `replicas` must include all replicas in `replicas` of the + `base_config` and include one or more replicas in the + `optional_replicas` of the `base_config`. + type: array + items: + $ref: '#/components/schemas/ReplicaInfo' + optionalReplicas: description: >- - Output only. For databases that are using customer managed - encryption, this field contains the encryption information for the - database, such as all Cloud KMS key versions that are in use. The - `encryption_status` field inside of each `EncryptionInfo` is not - populated. For databases that are using Google default or other - types of encryption, this field is empty. This field is propagated - lazily from the backend. There might be a delay from when a key - version is being used and when it appears in this field. + Output only. The available optional replicas to choose from for + user-managed configurations. Populated for Google-managed + configurations. readOnly: true type: array items: - $ref: '#/components/schemas/EncryptionInfo' - versionRetentionPeriod: + $ref: '#/components/schemas/ReplicaInfo' + baseConfig: description: >- - Output only. The period in which Cloud Spanner retains all versions - of data for the database. This is the same as the value of - version_retention_period database option set using - UpdateDatabaseDdl. Defaults to 1 hour, if not set. - readOnly: true + Base configuration name, e.g. projects//instanceConfigs/nam3, based + on which this configuration is created. Only set for user-managed + configurations. `base_config` must refer to a configuration of type + `GOOGLE_MANAGED` in the same project as this configuration. type: string - earliestVersionTime: + labels: description: >- - Output only. Earliest timestamp at which older versions of the data - can be read. This value is continuously updated by Cloud Spanner and - becomes stale the moment it is queried. If you are using this value - to recover data, make sure to account for the time from the moment - when the value is queried to the moment when you initiate the - recovery. - readOnly: true - type: string - format: google-datetime - defaultLeader: + Cloud Labels are a flexible and lightweight mechanism for organizing + cloud resources into groups that reflect a customer's organizational + needs and deployment strategies. Cloud Labels can be used to filter + collections of resources. They can be used to control how resource + metrics are aggregated. And they can be used as arguments to policy + management rules (e.g. route, firewall, load balancing, etc.). * + Label keys must be between 1 and 63 characters long and must conform + to the following regular expression: `a-z{0,62}`. * Label values + must be between 0 and 63 characters long and must conform to the + regular expression `[a-z0-9_-]{0,63}`. * No more than 64 labels can + be associated with a given resource. See https://goo.gl/xmQnxf for + more information on and examples of labels. If you plan to use + labels in your own code, please note that additional characters may + be allowed in the future. Therefore, you are advised to use an + internal label representation, such as JSON, which doesn't rely upon + specific characters being disallowed. For example, representing + labels as the string: name + "_" + value would prove problematic if + we were to allow "_" in a future release. + type: object + additionalProperties: + type: string + etag: description: >- - Output only. The read-write region which contains the database's - leader replicas. This is the same as the value of default_leader - database option set using DatabaseAdmin.CreateDatabase or - DatabaseAdmin.UpdateDatabaseDdl. If not explicitly set, this is - empty. - readOnly: true - type: string - databaseDialect: - description: Output only. The dialect of the Cloud Spanner Database. - readOnly: true + etag is used for optimistic concurrency control as a way to help + prevent simultaneous updates of a instance configuration from + overwriting each other. It is strongly suggested that systems make + use of the etag in the read-modify-write cycle to perform instance + configuration updates in order to avoid race conditions: An etag is + returned in the response which contains instance configurations, and + systems are expected to put that etag in the request to update + instance configuration to ensure that their change is applied to the + same version of the instance configuration. If no etag is provided + in the call to update the instance configuration, then the existing + instance configuration is overwritten blindly. type: string - enumDescriptions: - - >- - Default value. This value will create a database with the - GOOGLE_STANDARD_SQL dialect. - - GoogleSQL supported SQL. - - PostgreSQL supported SQL. - enum: - - DATABASE_DIALECT_UNSPECIFIED - - GOOGLE_STANDARD_SQL - - POSTGRESQL - enableDropProtection: + leaderOptions: description: >- - Optional. Whether drop protection is enabled for this database. - Defaults to false, if not set. For more details, please see how to - [prevent accidental database - deletion](https://cloud.google.com/spanner/docs/prevent-database-deletion). - type: boolean + Allowed values of the "default_leader" schema option for databases + in instances that use this instance configuration. + type: array + items: + type: string reconciling: description: >- - Output only. If true, the database is being updated. If false, there - are no ongoing update operations for the database. + Output only. If true, the instance configuration is being created or + updated. If false, there are no ongoing operations for the instance + configuration. readOnly: true type: boolean - quorumInfo: + state: description: >- - Output only. Applicable only for databases that use dual-region - instance configurations. Contains information about the quorum. + Output only. The current instance configuration state. Applicable + only for `USER_MANAGED` configurations. readOnly: true - $ref: '#/components/schemas/QuorumInfo' - RestoreInfo: - id: RestoreInfo - description: Information about the database restore. - type: object - properties: - sourceType: - description: The type of the restore source. type: string enumDescriptions: - - No restore associated. - - A backup was used as the source of the restore. + - Not specified. + - The instance configuration is still being created. + - >- + The instance configuration is fully created and ready to be used + to create instances. enum: - - TYPE_UNSPECIFIED - - BACKUP - backupInfo: + - STATE_UNSPECIFIED + - CREATING + - READY + freeInstanceAvailability: description: >- - Information about the backup used to restore the database. The - backup may no longer exist. - $ref: '#/components/schemas/BackupInfo' - BackupInfo: - id: BackupInfo - description: Information about a backup. - type: object - properties: - backup: - description: Name of the backup. + Output only. Describes whether free instances are available to be + created in this instance configuration. + readOnly: true + type: string + enumDescriptions: + - Not specified. + - >- + Indicates that free instances are available to be created in this + instance configuration. + - >- + Indicates that free instances are not supported in this instance + configuration. + - >- + Indicates that free instances are currently not available to be + created in this instance configuration. + - >- + Indicates that additional free instances cannot be created in this + instance configuration because the project has reached its limit + of free instances. + enum: + - FREE_INSTANCE_AVAILABILITY_UNSPECIFIED + - AVAILABLE + - UNSUPPORTED + - DISABLED + - QUOTA_EXCEEDED + quorumType: + description: Output only. The `QuorumType` of the instance configuration. + readOnly: true + type: string + enumDescriptions: + - Quorum type not specified. + - >- + An instance configuration tagged with `REGION` quorum type forms a + write quorum in a single region. + - >- + An instance configuration tagged with the `DUAL_REGION` quorum + type forms a write quorum with exactly two read-write regions in a + multi-region configuration. This instance configuration requires + failover in the event of regional failures. + - >- + An instance configuration tagged with the `MULTI_REGION` quorum + type forms a write quorum from replicas that are spread across + more than one region in a multi-region configuration. + enum: + - QUORUM_TYPE_UNSPECIFIED + - REGION + - DUAL_REGION + - MULTI_REGION + storageLimitPerProcessingUnit: + description: Output only. The storage limit in bytes per processing unit. + readOnly: true + type: string + format: int64 + ReplicaInfo: + id: ReplicaInfo + type: object + properties: + location: + description: The location of the serving resources, e.g., "us-central1". + type: string + type: + description: The type of replica. + type: string + enumDescriptions: + - Not specified. + - >- + Read-write replicas support both reads and writes. These replicas: + * Maintain a full copy of your data. * Serve reads. * Can vote + whether to commit a write. * Participate in leadership election. * + Are eligible to become a leader. + - >- + Read-only replicas only support reads (not writes). Read-only + replicas: * Maintain a full copy of your data. * Serve reads. * Do + not participate in voting to commit writes. * Are not eligible to + become a leader. + - >- + Witness replicas don't support reads but do participate in voting + to commit writes. Witness replicas: * Do not maintain a full copy + of data. * Do not serve reads. * Vote whether to commit writes. * + Participate in leader election but are not eligible to become + leader. + enum: + - TYPE_UNSPECIFIED + - READ_WRITE + - READ_ONLY + - WITNESS + defaultLeaderLocation: + description: >- + If true, this location is designated as the default leader location + where leader replicas are placed. See the [region types + documentation](https://cloud.google.com/spanner/docs/instances#region_types) + for more details. + type: boolean + CreateInstanceConfigRequest: + id: CreateInstanceConfigRequest + description: The request for CreateInstanceConfig. + type: object + properties: + instanceConfigId: + description: >- + Required. The ID of the instance configuration to create. Valid + identifiers are of the form `custom-[-a-z0-9]*[a-z0-9]` and must be + between 2 and 64 characters in length. The `custom-` prefix is + required to avoid name conflicts with Google-managed configurations. + type: string + instanceConfig: + description: >- + Required. The `InstanceConfig` proto of the configuration to create. + `instance_config.name` must be `/instanceConfigs/`. + `instance_config.base_config` must be a Google-managed configuration + name, e.g. /instanceConfigs/us-east1, /instanceConfigs/nam3. + $ref: '#/components/schemas/InstanceConfig' + validateOnly: + description: >- + An option to validate, but not actually execute, a request, and + provide the same response. + type: boolean + UpdateInstanceConfigRequest: + id: UpdateInstanceConfigRequest + description: The request for UpdateInstanceConfig. + type: object + properties: + instanceConfig: + description: >- + Required. The user instance configuration to update, which must + always include the instance configuration name. Otherwise, only + fields mentioned in update_mask need be included. To prevent + conflicts of concurrent updates, etag can be used. + $ref: '#/components/schemas/InstanceConfig' + updateMask: + description: >- + Required. A mask specifying which fields in InstanceConfig should be + updated. The field mask must always be specified; this prevents any + future fields in InstanceConfig from being erased accidentally by + clients that do not know about them. Only display_name and labels + can be updated. + type: string + format: google-fieldmask + validateOnly: + description: >- + An option to validate, but not actually execute, a request, and + provide the same response. + type: boolean + ListInstanceConfigOperationsResponse: + id: ListInstanceConfigOperationsResponse + description: The response for ListInstanceConfigOperations. + type: object + properties: + operations: + description: >- + The list of matching instance configuration long-running operations. + Each operation's name will be prefixed by the name of the instance + configuration. The operation's metadata field type + `metadata.type_url` describes the type of the metadata. + type: array + items: + $ref: '#/components/schemas/Operation' + nextPageToken: + description: >- + `next_page_token` can be sent in a subsequent + ListInstanceConfigOperations call to fetch more of the matching + metadata. + type: string + ListInstancesResponse: + id: ListInstancesResponse + description: The response for ListInstances. + type: object + properties: + instances: + description: The list of requested instances. + type: array + items: + $ref: '#/components/schemas/Instance' + nextPageToken: + description: >- + `next_page_token` can be sent in a subsequent ListInstances call to + fetch more of the matching instances. + type: string + unreachable: + description: >- + The list of unreachable instances. It includes the names of + instances whose metadata could not be retrieved within + instance_deadline. + type: array + items: + type: string + Instance: + id: Instance + description: >- + An isolated set of Cloud Spanner resources on which databases can be + hosted. + type: object + properties: + name: + description: >- + Required. A unique identifier for the instance, which cannot be + changed after the instance is created. Values are of the form + `projects//instances/a-z*[a-z0-9]`. The final segment of the name + must be between 2 and 64 characters in length. + type: string + config: + description: >- + Required. The name of the instance's configuration. Values are of + the form `projects//instanceConfigs/`. See also InstanceConfig and + ListInstanceConfigs. + type: string + displayName: + description: >- + Required. The descriptive name for this instance as it appears in + UIs. Must be unique per project and between 4 and 30 characters in + length. + type: string + nodeCount: + description: >- + The number of nodes allocated to this instance. At most, one of + either `node_count` or `processing_units` should be present in the + message. Users can set the `node_count` field to specify the target + number of nodes allocated to the instance. If autoscaling is + enabled, `node_count` is treated as an `OUTPUT_ONLY` field and + reflects the current number of nodes allocated to the instance. This + might be zero in API responses for instances that are not yet in the + `READY` state. If the instance has varying node count across + replicas (achieved by setting `asymmetric_autoscaling_options` in + the autoscaling configuration), the `node_count` set here is the + maximum node count across all replicas. For more information, see + [Compute capacity, nodes, and processing + units](https://cloud.google.com/spanner/docs/compute-capacity). + type: integer + format: int32 + processingUnits: + description: >- + The number of processing units allocated to this instance. At most, + one of either `processing_units` or `node_count` should be present + in the message. Users can set the `processing_units` field to + specify the target number of processing units allocated to the + instance. If autoscaling is enabled, `processing_units` is treated + as an `OUTPUT_ONLY` field and reflects the current number of + processing units allocated to the instance. This might be zero in + API responses for instances that are not yet in the `READY` state. + If the instance has varying processing units per replica (achieved + by setting `asymmetric_autoscaling_options` in the autoscaling + configuration), the `processing_units` set here is the maximum + processing units across all replicas. For more information, see + [Compute capacity, nodes and processing + units](https://cloud.google.com/spanner/docs/compute-capacity). + type: integer + format: int32 + replicaComputeCapacity: + description: >- + Output only. Lists the compute capacity per ReplicaSelection. A + replica selection identifies a set of replicas with common + properties. Replicas identified by a ReplicaSelection are scaled + with the same compute capacity. + readOnly: true + type: array + items: + $ref: '#/components/schemas/ReplicaComputeCapacity' + autoscalingConfig: + description: >- + Optional. The autoscaling configuration. Autoscaling is enabled if + this field is set. When autoscaling is enabled, node_count and + processing_units are treated as OUTPUT_ONLY fields and reflect the + current compute capacity allocated to the instance. + $ref: '#/components/schemas/AutoscalingConfig' + state: + description: >- + Output only. The current instance state. For CreateInstance, the + state must be either omitted or set to `CREATING`. For + UpdateInstance, the state must be either omitted or set to `READY`. + readOnly: true + type: string + enumDescriptions: + - Not specified. + - >- + The instance is still being created. Resources may not be + available yet, and operations such as database creation may not + work. + - >- + The instance is fully created and ready to do work such as + creating databases. + enum: + - STATE_UNSPECIFIED + - CREATING + - READY + labels: + description: >- + Cloud Labels are a flexible and lightweight mechanism for organizing + cloud resources into groups that reflect a customer's organizational + needs and deployment strategies. Cloud Labels can be used to filter + collections of resources. They can be used to control how resource + metrics are aggregated. And they can be used as arguments to policy + management rules (e.g. route, firewall, load balancing, etc.). * + Label keys must be between 1 and 63 characters long and must conform + to the following regular expression: `a-z{0,62}`. * Label values + must be between 0 and 63 characters long and must conform to the + regular expression `[a-z0-9_-]{0,63}`. * No more than 64 labels can + be associated with a given resource. See https://goo.gl/xmQnxf for + more information on and examples of labels. If you plan to use + labels in your own code, please note that additional characters may + be allowed in the future. And so you are advised to use an internal + label representation, such as JSON, which doesn't rely upon specific + characters being disallowed. For example, representing labels as the + string: name + "_" + value would prove problematic if we were to + allow "_" in a future release. + type: object + additionalProperties: + type: string + instanceType: + description: The `InstanceType` of the current instance. + type: string + enumDescriptions: + - Not specified. + - >- + Provisioned instances have dedicated resources, standard usage + limits and support. + - >- + Free instances provide no guarantee for dedicated resources, + [node_count, processing_units] should be 0. They come with + stricter usage limits and limited support. + enum: + - INSTANCE_TYPE_UNSPECIFIED + - PROVISIONED + - FREE_INSTANCE + endpointUris: + description: Deprecated. This field is not populated. + type: array + items: + type: string + createTime: + description: Output only. The time at which the instance was created. + readOnly: true type: string - versionTime: + format: google-datetime + updateTime: description: >- - The backup contains an externally consistent copy of - `source_database` at the timestamp specified by `version_time`. If - the CreateBackup request did not specify `version_time`, the - `version_time` of the backup is equivalent to the `create_time`. + Output only. The time at which the instance was most recently + updated. + readOnly: true type: string format: google-datetime - createTime: - description: The time the CreateBackup request was received. + freeInstanceMetadata: + description: Free instance metadata. Only populated for free instances. + $ref: '#/components/schemas/FreeInstanceMetadata' + edition: + description: Optional. The `Edition` of the current instance. type: string - format: google-datetime - sourceDatabase: - description: Name of the database the backup was created from. + enumDescriptions: + - Edition not specified. + - Standard edition. + - Enterprise edition. + - Enterprise Plus edition. + enum: + - EDITION_UNSPECIFIED + - STANDARD + - ENTERPRISE + - ENTERPRISE_PLUS + defaultBackupScheduleType: + description: >- + Optional. Controls the default backup schedule behavior for new + databases within the instance. By default, a backup schedule is + created automatically when a new database is created in a new + instance. Note that the `AUTOMATIC` value isn't permitted for free + instances, as backups and backup schedules aren't supported for free + instances. In the `GetInstance` or `ListInstances` response, if the + value of `default_backup_schedule_type` isn't set, or set to `NONE`, + Spanner doesn't create a default backup schedule for new databases + in the instance. type: string - EncryptionConfig: - id: EncryptionConfig - description: Encryption configuration for a Cloud Spanner database. + enumDescriptions: + - Not specified. + - >- + A default backup schedule isn't created automatically when a new + database is created in the instance. + - >- + A default backup schedule is created automatically when a new + database is created in the instance. The default backup schedule + creates a full backup every 24 hours. These full backups are + retained for 7 days. You can edit or delete the default backup + schedule once it's created. + enum: + - DEFAULT_BACKUP_SCHEDULE_TYPE_UNSPECIFIED + - NONE + - AUTOMATIC + ReplicaComputeCapacity: + id: ReplicaComputeCapacity + description: >- + ReplicaComputeCapacity describes the amount of server resources that are + allocated to each replica identified by the replica selection. type: object properties: - kmsKeyName: + replicaSelection: description: >- - The Cloud KMS key to be used for encrypting and decrypting the - database. Values are of the form - `projects//locations//keyRings//cryptoKeys/`. + Required. Identifies replicas by specified properties. All replicas + in the selection have the same amount of compute capacity. + $ref: '#/components/schemas/InstanceReplicaSelection' + nodeCount: + description: >- + The number of nodes allocated to each replica. This may be zero in + API responses for instances that are not yet in state `READY`. + type: integer + format: int32 + processingUnits: + description: >- + The number of processing units allocated to each replica. This may + be zero in API responses for instances that are not yet in state + `READY`. + type: integer + format: int32 + InstanceReplicaSelection: + id: InstanceReplicaSelection + description: ReplicaSelection identifies replicas with common properties. + type: object + properties: + location: + description: >- + Required. Name of the location of the replicas (e.g., + "us-central1"). type: string - kmsKeyNames: + AutoscalingConfig: + id: AutoscalingConfig + description: Autoscaling configuration for an instance. + type: object + properties: + autoscalingLimits: + description: Required. Autoscaling limits for an instance. + $ref: '#/components/schemas/AutoscalingLimits' + autoscalingTargets: + description: Required. The autoscaling targets for an instance. + $ref: '#/components/schemas/AutoscalingTargets' + asymmetricAutoscalingOptions: description: >- - Specifies the KMS configuration for one or more keys used to encrypt - the database. Values are of the form - `projects//locations//keyRings//cryptoKeys/`. The keys referenced by - `kms_key_names` must fully cover all regions of the database's - instance configuration. Some examples: * For regional - (single-region) instance configurations, specify a regional location - KMS key. * For multi-region instance configurations of type - `GOOGLE_MANAGED`, either specify a multi-region location KMS key or - multiple regional location KMS keys that cover all regions in the - instance configuration. * For an instance configuration of type - `USER_MANAGED`, specify only regional location KMS keys to cover - each region in the instance configuration. Multi-region location KMS - keys aren't supported for `USER_MANAGED` type instance - configurations. + Optional. Optional asymmetric autoscaling options. Replicas matching + the replica selection criteria will be autoscaled independently from + other replicas. The autoscaler will scale the replicas based on the + utilization of replicas identified by the replica selection. Replica + selections should not overlap with each other. Other replicas (those + do not match any replica selection) will be autoscaled together and + will have the same compute capacity allocated to them. type: array items: - type: string - EncryptionInfo: - id: EncryptionInfo - description: Encryption information for a Cloud Spanner database or backup. + $ref: '#/components/schemas/AsymmetricAutoscalingOption' + AutoscalingLimits: + id: AutoscalingLimits + description: >- + The autoscaling limits for the instance. Users can define the minimum + and maximum compute capacity allocated to the instance, and the + autoscaler will only scale within that range. Users can either use nodes + or processing units to specify the limits, but should use the same unit + to set both the min_limit and max_limit. type: object properties: - encryptionType: - description: Output only. The type of encryption. - readOnly: true - type: string - enumDescriptions: - - >- - Encryption type was not specified, though data at rest remains - encrypted. - - >- - The data is encrypted at rest with a key that is fully managed by - Google. No key version or status will be populated. This is the - default state. - - >- - The data is encrypted at rest with a key that is managed by the - customer. The active version of the key. `kms_key_version` will be - populated, and `encryption_status` may be populated. - enum: - - TYPE_UNSPECIFIED - - GOOGLE_DEFAULT_ENCRYPTION - - CUSTOMER_MANAGED_ENCRYPTION - encryptionStatus: + minNodes: description: >- - Output only. If present, the status of a recent encrypt/decrypt call - on underlying data for this database or backup. Regardless of - status, data is always encrypted at rest. - readOnly: true - $ref: '#/components/schemas/Status' - kmsKeyVersion: + Minimum number of nodes allocated to the instance. If set, this + number should be greater than or equal to 1. + type: integer + format: int32 + minProcessingUnits: description: >- - Output only. A Cloud KMS key version that is being used to protect - the database or backup. - readOnly: true - type: string - QuorumInfo: - id: QuorumInfo - description: Information about the dual-region quorum. + Minimum number of processing units allocated to the instance. If + set, this number should be multiples of 1000. + type: integer + format: int32 + maxNodes: + description: >- + Maximum number of nodes allocated to the instance. If set, this + number should be greater than or equal to min_nodes. + type: integer + format: int32 + maxProcessingUnits: + description: >- + Maximum number of processing units allocated to the instance. If + set, this number should be multiples of 1000 and be greater than or + equal to min_processing_units. + type: integer + format: int32 + AutoscalingTargets: + id: AutoscalingTargets + description: The autoscaling targets for an instance. type: object properties: - quorumType: + highPriorityCpuUtilizationPercent: description: >- - Output only. The type of this quorum. See QuorumType for more - information about quorum type specifications. - readOnly: true - $ref: '#/components/schemas/QuorumType' - initiator: + Required. The target high priority cpu utilization percentage that + the autoscaler should be trying to achieve for the instance. This + number is on a scale from 0 (no utilization) to 100 (full + utilization). The valid range is [10, 90] inclusive. + type: integer + format: int32 + storageUtilizationPercent: + description: >- + Required. The target storage utilization percentage that the + autoscaler should be trying to achieve for the instance. This number + is on a scale from 0 (no utilization) to 100 (full utilization). The + valid range is [10, 99] inclusive. + type: integer + format: int32 + AsymmetricAutoscalingOption: + id: AsymmetricAutoscalingOption + description: >- + AsymmetricAutoscalingOption specifies the scaling of replicas identified + by the given selection. + type: object + properties: + replicaSelection: + description: >- + Required. Selects the replicas to which this + AsymmetricAutoscalingOption applies. Only read-only replicas are + supported. + $ref: '#/components/schemas/InstanceReplicaSelection' + overrides: + description: >- + Optional. Overrides applied to the top-level autoscaling + configuration for the selected replicas. + $ref: '#/components/schemas/AutoscalingConfigOverrides' + AutoscalingConfigOverrides: + id: AutoscalingConfigOverrides + description: >- + Overrides the top-level autoscaling configuration for the replicas + identified by `replica_selection`. All fields in this message are + optional. Any unspecified fields will use the corresponding values from + the top-level autoscaling configuration. + type: object + properties: + autoscalingLimits: + description: >- + Optional. If specified, overrides the min/max limit in the top-level + autoscaling configuration for the selected replicas. + $ref: '#/components/schemas/AutoscalingLimits' + autoscalingTargetHighPriorityCpuUtilizationPercent: + description: >- + Optional. If specified, overrides the autoscaling target + high_priority_cpu_utilization_percent in the top-level autoscaling + configuration for the selected replicas. + type: integer + format: int32 + FreeInstanceMetadata: + id: FreeInstanceMetadata + description: >- + Free instance specific metadata that is kept even after an instance has + been upgraded for tracking purposes. + type: object + properties: + expireTime: description: >- - Output only. Whether this `ChangeQuorum` is Google or User - initiated. + Output only. Timestamp after which the instance will either be + upgraded or scheduled for deletion after a grace period. + ExpireBehavior is used to choose between upgrading or scheduling the + free instance for deletion. This timestamp is set during the + creation of a free instance. readOnly: true type: string - enumDescriptions: - - Unspecified. - - '`ChangeQuorum` initiated by Google.' - - '`ChangeQuorum` initiated by User.' - enum: - - INITIATOR_UNSPECIFIED - - GOOGLE - - USER - startTime: - description: Output only. The timestamp when the request was triggered. + format: google-datetime + upgradeTime: + description: >- + Output only. If present, the timestamp at which the free instance + was upgraded to a provisioned instance. readOnly: true type: string format: google-datetime - etag: + expireBehavior: description: >- - Output only. The etag is used for optimistic concurrency control as - a way to help prevent simultaneous `ChangeQuorum` requests that - might create a race condition. - readOnly: true + Specifies the expiration behavior of a free instance. The default of + ExpireBehavior is `REMOVE_AFTER_GRACE_PERIOD`. This can be modified + during or after creation, and before expiration. type: string - QuorumType: - id: QuorumType - description: >- - Information about the database quorum type. This only applies to - dual-region instance configs. - type: object - properties: - singleRegion: - description: Single-region quorum type. - $ref: '#/components/schemas/SingleRegionQuorum' - dualRegion: - description: Dual-region quorum type. - $ref: '#/components/schemas/DualRegionQuorum' - SingleRegionQuorum: - id: SingleRegionQuorum - description: Message type for a single-region quorum. + enumDescriptions: + - Not specified. + - >- + When the free instance expires, upgrade the instance to a + provisioned instance. + - >- + When the free instance expires, disable the instance, and delete + it after the grace period passes if it has not been upgraded. + enum: + - EXPIRE_BEHAVIOR_UNSPECIFIED + - FREE_TO_PROVISIONED + - REMOVE_AFTER_GRACE_PERIOD + ListInstancePartitionsResponse: + id: ListInstancePartitionsResponse + description: The response for ListInstancePartitions. type: object properties: - servingLocation: + instancePartitions: + description: The list of requested instancePartitions. + type: array + items: + $ref: '#/components/schemas/InstancePartition' + nextPageToken: description: >- - Required. The location of the serving region, e.g. "us-central1". - The location must be one of the regions within the dual-region - instance configuration of your database. The list of valid locations - is available using the GetInstanceConfig API. This should only be - used if you plan to change quorum to the single-region quorum type. + `next_page_token` can be sent in a subsequent ListInstancePartitions + call to fetch more of the matching instance partitions. type: string - DualRegionQuorum: - id: DualRegionQuorum + unreachable: + description: >- + The list of unreachable instances or instance partitions. It + includes the names of instances or instance partitions whose + metadata could not be retrieved within instance_partition_deadline. + type: array + items: + type: string + InstancePartition: + id: InstancePartition description: >- - Message type for a dual-region quorum. Currently this type has no - options. - type: object - properties: {} - CreateDatabaseRequest: - id: CreateDatabaseRequest - description: The request for CreateDatabase. + An isolated set of Cloud Spanner resources that databases can define + placements on. type: object properties: - createStatement: + name: description: >- - Required. A `CREATE DATABASE` statement, which specifies the ID of - the new database. The database ID must conform to the regular - expression `a-z*[a-z0-9]` and be between 2 and 30 characters in - length. If the database ID is a reserved word or if it contains a - hyphen, the database ID must be enclosed in backticks (`` ` ``). + Required. A unique identifier for the instance partition. Values are + of the form `projects//instances//instancePartitions/a-z*[a-z0-9]`. + The final segment of the name must be between 2 and 64 characters in + length. An instance partition's name cannot be changed after the + instance partition is created. type: string - extraStatements: + config: description: >- - Optional. A list of DDL statements to run inside the newly created - database. Statements can create tables, indexes, etc. These - statements execute atomically with the creation of the database: if - there is an error in any statement, the database is not created. - type: array - items: - type: string - encryptionConfig: + Required. The name of the instance partition's configuration. Values + are of the form `projects//instanceConfigs/`. See also + InstanceConfig and ListInstanceConfigs. + type: string + displayName: description: >- - Optional. The encryption configuration for the database. If this - field is not specified, Cloud Spanner will encrypt/decrypt all data - at rest using Google default encryption. - $ref: '#/components/schemas/EncryptionConfig' - databaseDialect: - description: Optional. The dialect of the Cloud Spanner Database. + Required. The descriptive name for this instance partition as it + appears in UIs. Must be unique per project and between 4 and 30 + characters in length. + type: string + nodeCount: + description: >- + The number of nodes allocated to this instance partition. Users can + set the `node_count` field to specify the target number of nodes + allocated to the instance partition. This may be zero in API + responses for instance partitions that are not yet in state `READY`. + type: integer + format: int32 + processingUnits: + description: >- + The number of processing units allocated to this instance partition. + Users can set the `processing_units` field to specify the target + number of processing units allocated to the instance partition. This + might be zero in API responses for instance partitions that are not + yet in the `READY` state. + type: integer + format: int32 + state: + description: Output only. The current instance partition state. + readOnly: true type: string enumDescriptions: + - Not specified. - >- - Default value. This value will create a database with the - GOOGLE_STANDARD_SQL dialect. - - GoogleSQL supported SQL. - - PostgreSQL supported SQL. + The instance partition is still being created. Resources may not + be available yet, and operations such as creating placements using + this instance partition may not work. + - >- + The instance partition is fully created and ready to do work such + as creating placements and using in databases. enum: - - DATABASE_DIALECT_UNSPECIFIED - - GOOGLE_STANDARD_SQL - - POSTGRESQL - protoDescriptors: - description: >- - Optional. Proto descriptors used by `CREATE/ALTER PROTO BUNDLE` - statements in 'extra_statements'. Contains a protobuf-serialized - [`google.protobuf.FileDescriptorSet`](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto) - descriptor set. To generate it, - [install](https://grpc.io/docs/protoc-installation/) and run - `protoc` with --include_imports and --descriptor_set_out. For - example, to generate for moon/shot/app.proto, run ``` $protoc - --proto_path=/app_path --proto_path=/lib_path \ --include_imports \ - --descriptor_set_out=descriptors.data \ moon/shot/app.proto ``` For - more details, see protobuffer [self - description](https://developers.google.com/protocol-buffers/docs/techniques#self-description). + - STATE_UNSPECIFIED + - CREATING + - READY + createTime: + description: Output only. The time at which the instance partition was created. + readOnly: true type: string - format: byte - UpdateDatabaseDdlRequest: - id: UpdateDatabaseDdlRequest - description: >- - Enqueues the given DDL statements to be applied, in order but not - necessarily all at once, to the database schema at some point (or - points) in the future. The server checks that the statements are - executable (syntactically valid, name tables that exist, etc.) before - enqueueing them, but they may still fail upon later execution (e.g., if - a statement from another batch of statements is applied first and it - conflicts in some way, or if there is some data-related problem like a - `NULL` value in a column to which `NOT NULL` would be added). If a - statement fails, all subsequent statements in the batch are - automatically cancelled. Each batch of statements is assigned a name - which can be used with the Operations API to monitor progress. See the - operation_id field for more details. - type: object - properties: - statements: - description: Required. DDL statements to be applied to the database. - type: array - items: - type: string - operationId: + format: google-datetime + updateTime: description: >- - If empty, the new update request is assigned an - automatically-generated operation ID. Otherwise, `operation_id` is - used to construct the name of the resulting Operation. Specifying an - explicit operation ID simplifies determining whether the statements - were executed in the event that the UpdateDatabaseDdl call is - replayed, or the return value is otherwise lost: the database and - `operation_id` fields can be combined to form the `name` of the - resulting longrunning.Operation: `/operations/`. `operation_id` - should be unique within the database, and must be a valid - identifier: `a-z*`. Note that automatically-generated operation IDs - always begin with an underscore. If the named operation already - exists, UpdateDatabaseDdl returns `ALREADY_EXISTS`. + Output only. The time at which the instance partition was most + recently updated. + readOnly: true type: string - protoDescriptors: + format: google-datetime + referencingDatabases: description: >- - Optional. Proto descriptors used by CREATE/ALTER PROTO BUNDLE - statements. Contains a protobuf-serialized - [google.protobuf.FileDescriptorSet](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto). - To generate it, [install](https://grpc.io/docs/protoc-installation/) - and run `protoc` with --include_imports and --descriptor_set_out. - For example, to generate for moon/shot/app.proto, run ``` $protoc - --proto_path=/app_path --proto_path=/lib_path \ --include_imports \ - --descriptor_set_out=descriptors.data \ moon/shot/app.proto ``` For - more details, see protobuffer [self - description](https://developers.google.com/protocol-buffers/docs/techniques#self-description). - type: string - format: byte - GetDatabaseDdlResponse: - id: GetDatabaseDdlResponse - description: The response for GetDatabaseDdl. - type: object - properties: - statements: + Output only. The names of the databases that reference this instance + partition. Referencing databases should share the parent instance. + The existence of any referencing database prevents the instance + partition from being deleted. + readOnly: true + type: array + items: + type: string + referencingBackups: description: >- - A list of formatted DDL statements defining the schema of the - database specified in the request. + Output only. Deprecated: This field is not populated. Output only. + The names of the backups that reference this instance partition. + Referencing backups should share the parent instance. The existence + of any referencing backup prevents the instance partition from being + deleted. + readOnly: true + deprecated: true type: array items: type: string - protoDescriptors: + etag: description: >- - Proto descriptors stored in the database. Contains a - protobuf-serialized - [google.protobuf.FileDescriptorSet](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto). - For more details, see protobuffer [self - description](https://developers.google.com/protocol-buffers/docs/techniques#self-description). + Used for optimistic concurrency control as a way to help prevent + simultaneous updates of a instance partition from overwriting each + other. It is strongly suggested that systems make use of the etag in + the read-modify-write cycle to perform instance partition updates in + order to avoid race conditions: An etag is returned in the response + which contains instance partitions, and systems are expected to put + that etag in the request to update instance partitions to ensure + that their change will be applied to the same version of the + instance partition. If no etag is provided in the call to update + instance partition, then the existing instance partition is + overwritten blindly. type: string - format: byte - ChangeQuorumRequest: - id: ChangeQuorumRequest - description: The request for ChangeQuorum. + CreateInstanceRequest: + id: CreateInstanceRequest + description: The request for CreateInstance. type: object properties: - name: + instanceId: description: >- - Required. Name of the database in which to apply `ChangeQuorum`. - Values are of the form `projects//instances//databases/`. + Required. The ID of the instance to create. Valid identifiers are of + the form `a-z*[a-z0-9]` and must be between 2 and 64 characters in + length. type: string - quorumType: - description: Required. The type of this quorum. - $ref: '#/components/schemas/QuorumType' - etag: + instance: description: >- - Optional. The etag is the hash of the `QuorumInfo`. The - `ChangeQuorum` operation is only performed if the etag matches that - of the `QuorumInfo` in the current database resource. Otherwise the - API returns an `ABORTED` error. The etag is used for optimistic - concurrency control as a way to help prevent simultaneous change - quorum requests that could create a race condition. + Required. The instance to create. The name may be omitted, but if + specified must be `/instances/`. + $ref: '#/components/schemas/Instance' + UpdateInstanceRequest: + id: UpdateInstanceRequest + description: The request for UpdateInstance. + type: object + properties: + instance: + description: >- + Required. The instance to update, which must always include the + instance name. Otherwise, only fields mentioned in field_mask need + be included. + $ref: '#/components/schemas/Instance' + fieldMask: + description: >- + Required. A mask specifying which fields in Instance should be + updated. The field mask must always be specified; this prevents any + future fields in Instance from being erased accidentally by clients + that do not know about them. type: string + format: google-fieldmask SetIamPolicyRequest: id: SetIamPolicyRequest description: Request message for `SetIamPolicy` method. @@ -1294,428 +1742,198 @@ components: type: string 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 - 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 - GetIamPolicyRequest: - id: GetIamPolicyRequest - description: Request message for `GetIamPolicy` method. - type: object - properties: - options: - description: >- - OPTIONAL: A `GetPolicyOptions` object for specifying options to - `GetIamPolicy`. - $ref: '#/components/schemas/GetPolicyOptions' - GetPolicyOptions: - id: GetPolicyOptions - description: Encapsulates settings provided to GetIamPolicy. - type: object - properties: - requestedPolicyVersion: - description: >- - Optional. The maximum policy version that will be used to format the - policy. Valid values are 0, 1, and 3. Requests specifying an invalid - value will be rejected. Requests for policies with any conditional - role bindings must specify version 3. Policies with no conditional - role bindings may specify any valid value or leave the field unset. - The policy in the response might use the policy version that you - specified, or it might use a lower policy version. For example, if - you specify version 3, but the policy has no conditional role - bindings, the response uses version 1. To learn which resources - support conditions in their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - type: integer - format: int32 - TestIamPermissionsRequest: - id: TestIamPermissionsRequest - description: Request message for `TestIamPermissions` method. - type: object - properties: - permissions: - description: >- - REQUIRED: The set of permissions to check for 'resource'. - Permissions with wildcards (such as '*', 'spanner.*', - 'spanner.instances.*') are not allowed. - type: array - items: - type: string - TestIamPermissionsResponse: - id: TestIamPermissionsResponse - description: Response message for `TestIamPermissions` method. - type: object - properties: - permissions: - description: >- - A subset of `TestPermissionsRequest.permissions` that the caller is - allowed. - type: array - items: - type: string - Backup: - id: Backup - description: A backup of a Cloud Spanner database. - type: object - properties: - database: - description: >- - Required for the CreateBackup operation. Name of the database from - which this backup was created. This needs to be in the same instance - as the backup. Values are of the form - `projects//instances//databases/`. - type: string - versionTime: - description: >- - The backup will contain an externally consistent copy of the - database at the timestamp specified by `version_time`. If - `version_time` is not specified, the system will set `version_time` - to the `create_time` of the backup. - type: string - format: google-datetime - expireTime: - description: >- - Required for the CreateBackup operation. The expiration time of the - backup, with microseconds granularity that must be at least 6 hours - and at most 366 days from the time the CreateBackup request is - processed. Once the `expire_time` has passed, the backup is eligible - to be automatically deleted by Cloud Spanner to free the resources - used by the backup. - type: string - format: google-datetime - name: - description: >- - Output only for the CreateBackup operation. Required for the - UpdateBackup operation. A globally unique identifier for the backup - which cannot be changed. Values are of the form - `projects//instances//backups/a-z*[a-z0-9]` The final segment of the - name must be between 2 and 60 characters in length. The backup is - stored in the location(s) specified in the instance configuration of - the instance containing the backup, identified by the prefix of the - backup name of the form `projects//instances/`. - type: string - createTime: - description: >- - Output only. The time the CreateBackup request is received. If the - request does not specify `version_time`, the `version_time` of the - backup will be equivalent to the `create_time`. - readOnly: true - type: string - format: google-datetime - sizeBytes: - description: >- - Output only. Size of the backup in bytes. For a backup in an - incremental backup chain, this is the sum of the - `exclusive_size_bytes` of itself and all older backups in the chain. - readOnly: true - type: string - format: int64 - freeableSizeBytes: - description: >- - Output only. The number of bytes that will be freed by deleting this - backup. This value will be zero if, for example, this backup is part - of an incremental backup chain and younger backups in the chain - require that we keep its data. For backups not in an incremental - backup chain, this is always the size of the backup. This value may - change if backups on the same chain get created, deleted or expired. - readOnly: true - type: string - format: int64 - exclusiveSizeBytes: - description: >- - Output only. For a backup in an incremental backup chain, this is - the storage space needed to keep the data that has changed since the - previous backup. For all other backups, this is always the size of - the backup. This value may change if backups on the same chain get - deleted or expired. This field can be used to calculate the total - storage space used by a set of backups. For example, the total space - used by all backups of a database can be computed by summing up this - field. - readOnly: true - type: string - format: int64 - state: - description: Output only. The current state of the backup. - readOnly: true - type: string - enumDescriptions: - - Not specified. - - >- - The pending backup is still being created. Operations on the - backup may fail with `FAILED_PRECONDITION` in this state. - - The backup is complete and ready for use. - enum: - - STATE_UNSPECIFIED - - CREATING - - READY - referencingDatabases: - description: >- - Output only. The names of the restored databases that reference the - backup. The database names are of the form - `projects//instances//databases/`. Referencing databases may exist - in different instances. The existence of any referencing database - prevents the backup from being deleted. When a restored database - from the backup enters the `READY` state, the reference to the - backup is removed. - readOnly: true - type: array - items: - type: string - encryptionInfo: - description: Output only. The encryption information for the backup. - readOnly: true - $ref: '#/components/schemas/EncryptionInfo' - encryptionInformation: - description: >- - Output only. The encryption information for the backup, whether it - is protected by one or more KMS keys. The information includes all - Cloud KMS key versions used to encrypt the backup. The - `encryption_status` field inside of each `EncryptionInfo` is not - populated. At least one of the key versions must be available for - the backup to be restored. If a key version is revoked in the middle - of a restore, the restore behavior is undefined. - readOnly: true - type: array - items: - $ref: '#/components/schemas/EncryptionInfo' - databaseDialect: - description: Output only. The database dialect information for the backup. - readOnly: true + 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 - enumDescriptions: - - >- - Default value. This value will create a database with the - GOOGLE_STANDARD_SQL dialect. - - GoogleSQL supported SQL. - - PostgreSQL supported SQL. - enum: - - DATABASE_DIALECT_UNSPECIFIED - - GOOGLE_STANDARD_SQL - - POSTGRESQL - referencingBackups: + location: description: >- - Output only. The names of the destination backups being created by - copying this source backup. The backup names are of the form - `projects//instances//backups/`. Referencing backups may exist in - different instances. The existence of any referencing backup - prevents the backup from being deleted. When the copy operation is - done (either successfully completed or cancelled or the destination - backup is deleted), the reference to the backup is removed. - readOnly: true + Optional. String indicating the location of the expression for error + reporting, e.g. a file name and a position in the file. + type: string + GetIamPolicyRequest: + id: GetIamPolicyRequest + description: Request message for `GetIamPolicy` method. + type: object + properties: + options: + description: >- + OPTIONAL: A `GetPolicyOptions` object for specifying options to + `GetIamPolicy`. + $ref: '#/components/schemas/GetPolicyOptions' + GetPolicyOptions: + id: GetPolicyOptions + description: Encapsulates settings provided to GetIamPolicy. + type: object + properties: + requestedPolicyVersion: + description: >- + Optional. The maximum policy version that will be used to format the + policy. Valid values are 0, 1, and 3. Requests specifying an invalid + value will be rejected. Requests for policies with any conditional + role bindings must specify version 3. Policies with no conditional + role bindings may specify any valid value or leave the field unset. + The policy in the response might use the policy version that you + specified, or it might use a lower policy version. For example, if + you specify version 3, but the policy has no conditional role + bindings, the response uses version 1. To learn which resources + support conditions in their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + type: integer + format: int32 + TestIamPermissionsRequest: + id: TestIamPermissionsRequest + description: Request message for `TestIamPermissions` method. + type: object + properties: + permissions: + description: >- + REQUIRED: The set of permissions to check for 'resource'. + Permissions with wildcards (such as '*', 'spanner.*', + 'spanner.instances.*') are not allowed. type: array items: type: string - maxExpireTime: - description: >- - Output only. The max allowed expiration time of the backup, with - microseconds granularity. A backup's expiration time can be - configured in multiple APIs: CreateBackup, UpdateBackup, CopyBackup. - When updating or copying an existing backup, the expiration time - specified must be less than `Backup.max_expire_time`. - readOnly: true - type: string - format: google-datetime - backupSchedules: + TestIamPermissionsResponse: + id: TestIamPermissionsResponse + description: Response message for `TestIamPermissions` method. + type: object + properties: + permissions: description: >- - Output only. List of backup schedule URIs that are associated with - creating this backup. This is only applicable for scheduled backups, - and is empty for on-demand backups. To optimize for storage, - whenever possible, multiple schedules are collapsed together to - create one backup. In such cases, this field captures the list of - all backup schedule URIs that are associated with creating this - backup. If collapsing is not done, then this field captures the - single backup schedule URI associated with creating this backup. - readOnly: true + A subset of `TestPermissionsRequest.permissions` that the caller is + allowed. type: array items: type: string - incrementalBackupChainId: + CreateInstancePartitionRequest: + id: CreateInstancePartitionRequest + description: The request for CreateInstancePartition. + type: object + properties: + instancePartitionId: description: >- - Output only. Populated only for backups in an incremental backup - chain. Backups share the same chain id if and only if they belong to - the same incremental backup chain. Use this field to determine which - backups are part of the same incremental backup chain. The ordering - of backups in the chain can be determined by ordering the backup - `version_time`. - readOnly: true + Required. The ID of the instance partition to create. Valid + identifiers are of the form `a-z*[a-z0-9]` and must be between 2 and + 64 characters in length. type: string - oldestVersionTime: + instancePartition: description: >- - Output only. Data deleted at a time older than this is guaranteed - not to be retained in order to support this backup. For a backup in - an incremental backup chain, this is the version time of the oldest - backup that exists or ever existed in the chain. For all other - backups, this is the version time of the backup. This field can be - used to understand what data is being retained by the backup system. - readOnly: true - type: string - format: google-datetime - CopyBackupRequest: - id: CopyBackupRequest - description: The request for CopyBackup. + Required. The instance partition to create. The + instance_partition.name may be omitted, but if specified must be + `/instancePartitions/`. + $ref: '#/components/schemas/InstancePartition' + UpdateInstancePartitionRequest: + id: UpdateInstancePartitionRequest + description: The request for UpdateInstancePartition. type: object properties: - backupId: - description: >- - Required. The id of the backup copy. The `backup_id` appended to - `parent` forms the full backup_uri of the form - `projects//instances//backups/`. - type: string - sourceBackup: + instancePartition: description: >- - Required. The source backup to be copied. The source backup needs to - be in READY state for it to be copied. Once CopyBackup is in - progress, the source backup cannot be deleted or cleaned up on - expiration until CopyBackup is finished. Values are of the form: - `projects//instances//backups/`. - type: string - expireTime: + Required. The instance partition to update, which must always + include the instance partition name. Otherwise, only fields + mentioned in field_mask need be included. + $ref: '#/components/schemas/InstancePartition' + fieldMask: description: >- - Required. The expiration time of the backup in microsecond - granularity. The expiration time must be at least 6 hours and at - most 366 days from the `create_time` of the source backup. Once the - `expire_time` has passed, the backup is eligible to be automatically - deleted by Cloud Spanner to free the resources used by the backup. + Required. A mask specifying which fields in InstancePartition should + be updated. The field mask must always be specified; this prevents + any future fields in InstancePartition from being erased + accidentally by clients that do not know about them. type: string - format: google-datetime - encryptionConfig: - description: >- - Optional. The encryption configuration used to encrypt the backup. - If this field is not specified, the backup will use the same - encryption configuration as the source backup by default, namely - encryption_type = `USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION`. - $ref: '#/components/schemas/CopyBackupEncryptionConfig' - CopyBackupEncryptionConfig: - id: CopyBackupEncryptionConfig - description: Encryption configuration for the copied backup. + format: google-fieldmask + ListInstancePartitionOperationsResponse: + id: ListInstancePartitionOperationsResponse + description: The response for ListInstancePartitionOperations. type: object properties: - encryptionType: - description: Required. The encryption type of the backup. - type: string - enumDescriptions: - - Unspecified. Do not use. - - >- - This is the default option for CopyBackup when encryption_config - is not specified. For example, if the source backup is using - `Customer_Managed_Encryption`, the backup will be using the same - Cloud KMS key as the source backup. - - Use Google default encryption. - - >- - Use customer managed encryption. If specified, either - `kms_key_name` or `kms_key_names` must contain valid Cloud KMS - key(s). - enum: - - ENCRYPTION_TYPE_UNSPECIFIED - - USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION - - GOOGLE_DEFAULT_ENCRYPTION - - CUSTOMER_MANAGED_ENCRYPTION - kmsKeyName: + operations: description: >- - Optional. The Cloud KMS key that will be used to protect the backup. - This field should be set only when encryption_type is - `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form - `projects//locations//keyRings//cryptoKeys/`. + The list of matching instance partition long-running operations. + Each operation's name will be prefixed by the instance partition's + name. The operation's metadata field type `metadata.type_url` + describes the type of the metadata. + type: array + items: + $ref: '#/components/schemas/Operation' + nextPageToken: + description: >- + `next_page_token` can be sent in a subsequent + ListInstancePartitionOperations call to fetch more of the matching + metadata. type: string - kmsKeyNames: + unreachableInstancePartitions: description: >- - Optional. Specifies the KMS configuration for the one or more keys - used to protect the backup. Values are of the form - `projects//locations//keyRings//cryptoKeys/`. KMS keys specified can - be in any order. The keys referenced by `kms_key_names` must fully - cover all regions of the backup's instance configuration. Some - examples: * For regional (single-region) instance configurations, - specify a regional location KMS key. * For multi-region instance - configurations of type `GOOGLE_MANAGED`, either specify a - multi-region location KMS key or multiple regional location KMS keys - that cover all regions in the instance configuration. * For an - instance configuration of type `USER_MANAGED`, specify only regional - location KMS keys to cover each region in the instance - configuration. Multi-region location KMS keys aren't supported for - `USER_MANAGED` type instance configurations. + The list of unreachable instance partitions. It includes the names + of instance partitions whose operation metadata could not be + retrieved within instance_partition_deadline. type: array items: type: string - ListBackupsResponse: - id: ListBackupsResponse - description: The response for ListBackups. + MoveInstanceRequest: + id: MoveInstanceRequest + description: The request for MoveInstance. type: object properties: - backups: + targetConfig: + description: >- + Required. The target instance configuration where to move the + instance. Values are of the form `projects//instanceConfigs/`. + type: string + targetDatabaseMoveConfigs: description: >- - The list of matching backups. Backups returned are ordered by - `create_time` in descending order, starting from the most recent - `create_time`. + Optional. The configuration for each database in the target instance + configuration. type: array items: - $ref: '#/components/schemas/Backup' - nextPageToken: - description: >- - `next_page_token` can be sent in a subsequent ListBackups call to - fetch more of the matching backups. - type: string - RestoreDatabaseRequest: - id: RestoreDatabaseRequest - description: The request for RestoreDatabase. + $ref: '#/components/schemas/DatabaseMoveConfig' + DatabaseMoveConfig: + id: DatabaseMoveConfig + description: >- + The configuration for each database in the target instance + configuration. type: object properties: databaseId: description: >- - Required. The id of the database to create and restore to. This - database must not already exist. The `database_id` appended to - `parent` forms the full database name of the form - `projects//instances//databases/`. - type: string - backup: - description: >- - Name of the backup from which to restore. Values are of the form - `projects//instances//backups/`. + Required. The unique identifier of the database resource in the + Instance. For example, if the database uri is + `projects/foo/instances/bar/databases/baz`, then the id to supply + here is baz. type: string encryptionConfig: description: >- - Optional. An encryption configuration describing the encryption type - and key resources in Cloud KMS used to encrypt/decrypt the database - to restore to. If this field is not specified, the restored database - will use the same encryption configuration as the backup by default, - namely encryption_type = `USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION`. - $ref: '#/components/schemas/RestoreDatabaseEncryptionConfig' - RestoreDatabaseEncryptionConfig: - id: RestoreDatabaseEncryptionConfig - description: Encryption configuration for the restored database. + Optional. Encryption configuration to be used for the database in + the target configuration. The encryption configuration must be + specified for every database which currently uses CMEK encryption. + If a database currently uses Google-managed encryption and a target + encryption configuration is not specified, then the database + defaults to Google-managed encryption. If a database currently uses + Google-managed encryption and a target CMEK encryption is specified, + the request is rejected. If a database currently uses CMEK + encryption, then a target encryption configuration must be + specified. You can't move a CMEK database to a Google-managed + encryption database using the MoveInstance API. + $ref: '#/components/schemas/InstanceEncryptionConfig' + InstanceEncryptionConfig: + id: InstanceEncryptionConfig + description: Encryption configuration for a Cloud Spanner database. type: object properties: - encryptionType: - description: Required. The encryption type of the restored database. - type: string - enumDescriptions: - - Unspecified. Do not use. - - >- - This is the default option when encryption_config is not - specified. - - Use Google default encryption. - - >- - Use customer managed encryption. If specified, `kms_key_name` must - must contain a valid Cloud KMS key. - enum: - - ENCRYPTION_TYPE_UNSPECIFIED - - USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION - - GOOGLE_DEFAULT_ENCRYPTION - - CUSTOMER_MANAGED_ENCRYPTION kmsKeyName: description: >- - Optional. The Cloud KMS key that will be used to encrypt/decrypt the - restored database. This field should be set only when - encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the - form `projects//locations//keyRings//cryptoKeys/`. + Optional. This field is maintained for backwards compatibility. For + new callers, we recommend using `kms_key_names` to specify the KMS + key. `kms_key_name` should only be used if the location of the KMS + key matches the database instance’s configuration (location) + exactly. E.g. The KMS location is in us-central1 or nam3 and the + database instance is also in us-central1 or nam3. The Cloud KMS key + to be used for encrypting and decrypting the database. Values are of + the form `projects//locations//keyRings//cryptoKeys/`. type: string kmsKeyNames: description: >- Optional. Specifies the KMS configuration for one or more keys used - to encrypt the database. Values have the form + to encrypt the database. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by `kms_key_names` must fully cover all regions of the database's instance configuration. Some examples: * For regional @@ -1731,207 +1949,211 @@ components: type: array items: type: string - ListDatabaseOperationsResponse: - id: ListDatabaseOperationsResponse - description: The response for ListDatabaseOperations. + ListDatabasesResponse: + id: ListDatabasesResponse + description: The response for ListDatabases. type: object properties: - operations: - description: >- - The list of matching database long-running operations. Each - operation's name will be prefixed by the database's name. The - operation's metadata field type `metadata.type_url` describes the - type of the metadata. + databases: + description: Databases that matched the request. type: array items: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Database' nextPageToken: description: >- - `next_page_token` can be sent in a subsequent ListDatabaseOperations - call to fetch more of the matching metadata. + `next_page_token` can be sent in a subsequent ListDatabases call to + fetch more of the matching databases. type: string - ListBackupOperationsResponse: - id: ListBackupOperationsResponse - description: The response for ListBackupOperations. + Database: + id: Database + description: A Cloud Spanner database. type: object properties: - operations: + name: description: >- - The list of matching backup long-running operations. Each - operation's name will be prefixed by the backup's name. The - operation's metadata field type `metadata.type_url` describes the - type of the metadata. Operations returned include those that are - pending or have completed/failed/canceled within the last 7 days. - Operations returned are ordered by - `operation.metadata.value.progress.start_time` in descending order - starting from the most recently started operation. - type: array - items: - $ref: '#/components/schemas/Operation' - nextPageToken: + Required. The name of the database. Values are of the form + `projects//instances//databases/`, where `` is as specified in the + `CREATE DATABASE` statement. This name can be passed to other API + methods to identify the database. + type: string + state: + description: Output only. The current database state. + readOnly: true + type: string + enumDescriptions: + - Not specified. + - >- + The database is still being created. Operations on the database + may fail with `FAILED_PRECONDITION` in this state. + - The database is fully created and ready for use. + - >- + The database is fully created and ready for use, but is still + being optimized for performance and cannot handle full load. In + this state, the database still references the backup it was + restore from, preventing the backup from being deleted. When + optimizations are complete, the full performance of the database + will be restored, and the database will transition to `READY` + state. + enum: + - STATE_UNSPECIFIED + - CREATING + - READY + - READY_OPTIMIZING + createTime: description: >- - `next_page_token` can be sent in a subsequent ListBackupOperations - call to fetch more of the matching metadata. + Output only. If exists, the time at which the database creation + started. + readOnly: true type: string - ListDatabaseRolesResponse: - id: ListDatabaseRolesResponse - description: The response for ListDatabaseRoles. - type: object - properties: - databaseRoles: - description: Database roles that matched the request. + format: google-datetime + restoreInfo: + description: >- + Output only. Applicable only for restored databases. Contains + information about the restore source. + readOnly: true + $ref: '#/components/schemas/RestoreInfo' + encryptionConfig: + description: >- + Output only. For databases that are using customer managed + encryption, this field contains the encryption configuration for the + database. For databases that are using Google default or other types + of encryption, this field is empty. + readOnly: true + $ref: '#/components/schemas/EncryptionConfig' + encryptionInfo: + description: >- + Output only. For databases that are using customer managed + encryption, this field contains the encryption information for the + database, such as all Cloud KMS key versions that are in use. The + `encryption_status` field inside of each `EncryptionInfo` is not + populated. For databases that are using Google default or other + types of encryption, this field is empty. This field is propagated + lazily from the backend. There might be a delay from when a key + version is being used and when it appears in this field. + readOnly: true type: array items: - $ref: '#/components/schemas/DatabaseRole' - nextPageToken: + $ref: '#/components/schemas/EncryptionInfo' + versionRetentionPeriod: description: >- - `next_page_token` can be sent in a subsequent ListDatabaseRoles call - to fetch more of the matching roles. + Output only. The period in which Cloud Spanner retains all versions + of data for the database. This is the same as the value of + version_retention_period database option set using + UpdateDatabaseDdl. Defaults to 1 hour, if not set. + readOnly: true type: string - DatabaseRole: - id: DatabaseRole - description: A Cloud Spanner database role. - type: object - properties: - name: + earliestVersionTime: description: >- - Required. The name of the database role. Values are of the form - `projects//instances//databases//databaseRoles/` where `` is as - specified in the `CREATE ROLE` DDL statement. + Output only. Earliest timestamp at which older versions of the data + can be read. This value is continuously updated by Cloud Spanner and + becomes stale the moment it is queried. If you are using this value + to recover data, make sure to account for the time from the moment + when the value is queried to the moment when you initiate the + recovery. + readOnly: true type: string - BackupSchedule: - id: BackupSchedule - description: >- - BackupSchedule expresses the automated backup creation specification for - a Spanner database. Next ID: 10 - type: object - properties: - name: + format: google-datetime + defaultLeader: description: >- - Identifier. Output only for the CreateBackupSchedule operation. - Required for the UpdateBackupSchedule operation. A globally unique - identifier for the backup schedule which cannot be changed. Values - are of the form - `projects//instances//databases//backupSchedules/a-z*[a-z0-9]` The - final segment of the name must be between 2 and 60 characters in - length. + Output only. The read-write region which contains the database's + leader replicas. This is the same as the value of default_leader + database option set using DatabaseAdmin.CreateDatabase or + DatabaseAdmin.UpdateDatabaseDdl. If not explicitly set, this is + empty. + readOnly: true type: string - spec: - description: >- - Optional. The schedule specification based on which the backup - creations are triggered. - $ref: '#/components/schemas/BackupScheduleSpec' - retentionDuration: - description: >- - Optional. The retention duration of a backup that must be at least 6 - hours and at most 366 days. The backup is eligible to be - automatically deleted once the retention period has elapsed. + databaseDialect: + description: Output only. The dialect of the Cloud Spanner Database. + readOnly: true type: string - format: google-duration - encryptionConfig: + enumDescriptions: + - >- + Default value. This value will create a database with the + GOOGLE_STANDARD_SQL dialect. + - GoogleSQL supported SQL. + - PostgreSQL supported SQL. + enum: + - DATABASE_DIALECT_UNSPECIFIED + - GOOGLE_STANDARD_SQL + - POSTGRESQL + enableDropProtection: description: >- - Optional. The encryption configuration that will be used to encrypt - the backup. If this field is not specified, the backup will use the - same encryption configuration as the database. - $ref: '#/components/schemas/CreateBackupEncryptionConfig' - fullBackupSpec: - description: The schedule creates only full backups. - $ref: '#/components/schemas/FullBackupSpec' - incrementalBackupSpec: - description: The schedule creates incremental backup chains. - $ref: '#/components/schemas/IncrementalBackupSpec' - updateTime: + Optional. Whether drop protection is enabled for this database. + Defaults to false, if not set. For more details, please see how to + [prevent accidental database + deletion](https://cloud.google.com/spanner/docs/prevent-database-deletion). + type: boolean + reconciling: + description: >- + Output only. If true, the database is being updated. If false, there + are no ongoing update operations for the database. + readOnly: true + type: boolean + quorumInfo: description: >- - Output only. The timestamp at which the schedule was last updated. - If the schedule has never been updated, this field contains the - timestamp when the schedule was first created. + Output only. Applicable only for databases that use dual-region + instance configurations. Contains information about the quorum. readOnly: true - type: string - format: google-datetime - BackupScheduleSpec: - id: BackupScheduleSpec - description: Defines specifications of the backup schedule. + $ref: '#/components/schemas/QuorumInfo' + RestoreInfo: + id: RestoreInfo + description: Information about the database restore. type: object properties: - cronSpec: - description: Cron style schedule specification. - $ref: '#/components/schemas/CrontabSpec' - CrontabSpec: - id: CrontabSpec - description: >- - CrontabSpec can be used to specify the version time and frequency at - which the backup should be created. + sourceType: + description: The type of the restore source. + type: string + enumDescriptions: + - No restore associated. + - A backup was used as the source of the restore. + enum: + - TYPE_UNSPECIFIED + - BACKUP + backupInfo: + description: >- + Information about the backup used to restore the database. The + backup may no longer exist. + $ref: '#/components/schemas/BackupInfo' + BackupInfo: + id: BackupInfo + description: Information about a backup. type: object properties: - text: - description: >- - Required. Textual representation of the crontab. User can customize - the backup frequency and the backup version time using the cron - expression. The version time must be in UTC timzeone. The backup - will contain an externally consistent copy of the database at the - version time. Allowed frequencies are 12 hour, 1 day, 1 week and 1 - month. Examples of valid cron specifications: * `0 2/12 * * * ` : - every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * - * ` : every 12 hours at (2,14) hours past midnight in UTC. * `0 2 * - * * ` : once a day at 2 past midnight in UTC. * `0 2 * * 0 ` : once - a week every Sunday at 2 past midnight in UTC. * `0 2 8 * * ` : once - a month on 8th day at 2 past midnight in UTC. + backup: + description: Name of the backup. type: string - timeZone: + versionTime: description: >- - Output only. The time zone of the times in `CrontabSpec.text`. - Currently only UTC is supported. - readOnly: true + The backup contains an externally consistent copy of + `source_database` at the timestamp specified by `version_time`. If + the CreateBackup request did not specify `version_time`, the + `version_time` of the backup is equivalent to the `create_time`. type: string - creationWindow: - description: >- - Output only. Schedule backups will contain an externally consistent - copy of the database at the version time specified in - `schedule_spec.cron_spec`. However, Spanner may not initiate the - creation of the scheduled backups at that version time. Spanner will - initiate the creation of scheduled backups within the time window - bounded by the version_time specified in `schedule_spec.cron_spec` - and version_time + `creation_window`. - readOnly: true + format: google-datetime + createTime: + description: The time the CreateBackup request was received. type: string - format: google-duration - CreateBackupEncryptionConfig: - id: CreateBackupEncryptionConfig - description: Encryption configuration for the backup to create. + format: google-datetime + sourceDatabase: + description: Name of the database the backup was created from. + type: string + EncryptionConfig: + id: EncryptionConfig + description: Encryption configuration for a Cloud Spanner database. type: object properties: - encryptionType: - description: Required. The encryption type of the backup. - type: string - enumDescriptions: - - Unspecified. Do not use. - - >- - Use the same encryption configuration as the database. This is the - default option when encryption_config is empty. For example, if - the database is using `Customer_Managed_Encryption`, the backup - will be using the same Cloud KMS key as the database. - - Use Google default encryption. - - >- - Use customer managed encryption. If specified, `kms_key_name` must - contain a valid Cloud KMS key. - enum: - - ENCRYPTION_TYPE_UNSPECIFIED - - USE_DATABASE_ENCRYPTION - - GOOGLE_DEFAULT_ENCRYPTION - - CUSTOMER_MANAGED_ENCRYPTION kmsKeyName: description: >- - Optional. The Cloud KMS key that will be used to protect the backup. - This field should be set only when encryption_type is - `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form + The Cloud KMS key to be used for encrypting and decrypting the + database. Values are of the form `projects//locations//keyRings//cryptoKeys/`. type: string kmsKeyNames: description: >- - Optional. Specifies the KMS configuration for the one or more keys - used to protect the backup. Values are of the form + Specifies the KMS configuration for one or more keys used to encrypt + the database. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by - `kms_key_names` must fully cover all regions of the backup's + `kms_key_names` must fully cover all regions of the database's instance configuration. Some examples: * For regional (single-region) instance configurations, specify a regional location KMS key. * For multi-region instance configurations of type @@ -1941,993 +2163,969 @@ components: `USER_MANAGED`, specify only regional location KMS keys to cover each region in the instance configuration. Multi-region location KMS keys aren't supported for `USER_MANAGED` type instance - configurations. - type: array - items: - type: string - FullBackupSpec: - id: FullBackupSpec - description: >- - The specification for full backups. A full backup stores the entire - contents of the database at a given version time. - type: object - properties: {} - IncrementalBackupSpec: - id: IncrementalBackupSpec - description: >- - The specification for incremental backup chains. An incremental backup - stores the delta of changes between a previous backup and the database - contents at a given version time. An incremental backup chain consists - of a full backup and zero or more successive incremental backups. The - first backup created for an incremental backup chain is always a full - backup. - type: object - properties: {} - ListBackupSchedulesResponse: - id: ListBackupSchedulesResponse - description: The response for ListBackupSchedules. - type: object - properties: - backupSchedules: - description: The list of backup schedules for a database. - type: array - items: - $ref: '#/components/schemas/BackupSchedule' - nextPageToken: - description: >- - `next_page_token` can be sent in a subsequent ListBackupSchedules - call to fetch more of the schedules. - type: string - ListInstanceConfigsResponse: - id: ListInstanceConfigsResponse - description: The response for ListInstanceConfigs. - type: object - properties: - instanceConfigs: - description: The list of requested instance configurations. - type: array - items: - $ref: '#/components/schemas/InstanceConfig' - nextPageToken: - description: >- - `next_page_token` can be sent in a subsequent ListInstanceConfigs - call to fetch more of the matching instance configurations. - type: string - InstanceConfig: - id: InstanceConfig - description: >- - A possible configuration for a Cloud Spanner instance. Configurations - define the geographic placement of nodes and their replication. - type: object - properties: - name: - description: >- - A unique identifier for the instance configuration. Values are of - the form `projects//instanceConfigs/a-z*`. User instance - configuration must start with `custom-`. - type: string - displayName: - description: The name of this instance configuration as it appears in UIs. - type: string - configType: - description: >- - Output only. Whether this instance configuration is a Google-managed - or user-managed configuration. - readOnly: true - type: string - enumDescriptions: - - Unspecified. - - Google-managed configuration. - - User-managed configuration. - enum: - - TYPE_UNSPECIFIED - - GOOGLE_MANAGED - - USER_MANAGED - replicas: - description: >- - The geographic placement of nodes in this instance configuration and - their replication properties. To create user-managed configurations, - input `replicas` must include all replicas in `replicas` of the - `base_config` and include one or more replicas in the - `optional_replicas` of the `base_config`. - type: array - items: - $ref: '#/components/schemas/ReplicaInfo' - optionalReplicas: - description: >- - Output only. The available optional replicas to choose from for - user-managed configurations. Populated for Google-managed - configurations. - readOnly: true - type: array - items: - $ref: '#/components/schemas/ReplicaInfo' - baseConfig: - description: >- - Base configuration name, e.g. projects//instanceConfigs/nam3, based - on which this configuration is created. Only set for user-managed - configurations. `base_config` must refer to a configuration of type - `GOOGLE_MANAGED` in the same project as this configuration. - type: string - labels: - description: >- - Cloud Labels are a flexible and lightweight mechanism for organizing - cloud resources into groups that reflect a customer's organizational - needs and deployment strategies. Cloud Labels can be used to filter - collections of resources. They can be used to control how resource - metrics are aggregated. And they can be used as arguments to policy - management rules (e.g. route, firewall, load balancing, etc.). * - Label keys must be between 1 and 63 characters long and must conform - to the following regular expression: `a-z{0,62}`. * Label values - must be between 0 and 63 characters long and must conform to the - regular expression `[a-z0-9_-]{0,63}`. * No more than 64 labels can - be associated with a given resource. See https://goo.gl/xmQnxf for - more information on and examples of labels. If you plan to use - labels in your own code, please note that additional characters may - be allowed in the future. Therefore, you are advised to use an - internal label representation, such as JSON, which doesn't rely upon - specific characters being disallowed. For example, representing - labels as the string: name + "_" + value would prove problematic if - we were to allow "_" in a future release. - type: object - additionalProperties: - type: string - etag: - description: >- - etag is used for optimistic concurrency control as a way to help - prevent simultaneous updates of a instance configuration from - overwriting each other. It is strongly suggested that systems make - use of the etag in the read-modify-write cycle to perform instance - configuration updates in order to avoid race conditions: An etag is - returned in the response which contains instance configurations, and - systems are expected to put that etag in the request to update - instance configuration to ensure that their change is applied to the - same version of the instance configuration. If no etag is provided - in the call to update the instance configuration, then the existing - instance configuration is overwritten blindly. - type: string - leaderOptions: - description: >- - Allowed values of the "default_leader" schema option for databases - in instances that use this instance configuration. + configurations. type: array items: type: string - reconciling: - description: >- - Output only. If true, the instance configuration is being created or - updated. If false, there are no ongoing operations for the instance - configuration. - readOnly: true - type: boolean - state: - description: >- - Output only. The current instance configuration state. Applicable - only for `USER_MANAGED` configurations. + EncryptionInfo: + id: EncryptionInfo + description: Encryption information for a Cloud Spanner database or backup. + type: object + properties: + encryptionType: + description: Output only. The type of encryption. readOnly: true type: string enumDescriptions: - - Not specified. - - The instance configuration is still being created. - >- - The instance configuration is fully created and ready to be used - to create instances. + Encryption type was not specified, though data at rest remains + encrypted. + - >- + The data is encrypted at rest with a key that is fully managed by + Google. No key version or status will be populated. This is the + default state. + - >- + The data is encrypted at rest with a key that is managed by the + customer. The active version of the key. `kms_key_version` will be + populated, and `encryption_status` may be populated. enum: - - STATE_UNSPECIFIED - - CREATING - - READY - freeInstanceAvailability: + - TYPE_UNSPECIFIED + - GOOGLE_DEFAULT_ENCRYPTION + - CUSTOMER_MANAGED_ENCRYPTION + encryptionStatus: description: >- - Output only. Describes whether free instances are available to be - created in this instance configuration. + Output only. If present, the status of a recent encrypt/decrypt call + on underlying data for this database or backup. Regardless of + status, data is always encrypted at rest. + readOnly: true + $ref: '#/components/schemas/Status' + kmsKeyVersion: + description: >- + Output only. A Cloud KMS key version that is being used to protect + the database or backup. readOnly: true type: string - enumDescriptions: - - Not specified. - - >- - Indicates that free instances are available to be created in this - instance configuration. - - >- - Indicates that free instances are not supported in this instance - configuration. - - >- - Indicates that free instances are currently not available to be - created in this instance configuration. - - >- - Indicates that additional free instances cannot be created in this - instance configuration because the project has reached its limit - of free instances. - enum: - - FREE_INSTANCE_AVAILABILITY_UNSPECIFIED - - AVAILABLE - - UNSUPPORTED - - DISABLED - - QUOTA_EXCEEDED + QuorumInfo: + id: QuorumInfo + description: Information about the dual-region quorum. + type: object + properties: quorumType: - description: Output only. The `QuorumType` of the instance configuration. + description: >- + Output only. The type of this quorum. See QuorumType for more + information about quorum type specifications. + readOnly: true + $ref: '#/components/schemas/QuorumType' + initiator: + description: >- + Output only. Whether this `ChangeQuorum` is Google or User + initiated. readOnly: true type: string enumDescriptions: - - Quorum type not specified. - - >- - An instance configuration tagged with `REGION` quorum type forms a - write quorum in a single region. - - >- - An instance configuration tagged with the `DUAL_REGION` quorum - type forms a write quorum with exactly two read-write regions in a - multi-region configuration. This instance configuration requires - failover in the event of regional failures. - - >- - An instance configuration tagged with the `MULTI_REGION` quorum - type forms a write quorum from replicas that are spread across - more than one region in a multi-region configuration. + - Unspecified. + - '`ChangeQuorum` initiated by Google.' + - '`ChangeQuorum` initiated by User.' enum: - - QUORUM_TYPE_UNSPECIFIED - - REGION - - DUAL_REGION - - MULTI_REGION - storageLimitPerProcessingUnit: - description: Output only. The storage limit in bytes per processing unit. + - INITIATOR_UNSPECIFIED + - GOOGLE + - USER + startTime: + description: Output only. The timestamp when the request was triggered. readOnly: true type: string - format: int64 - ReplicaInfo: - id: ReplicaInfo + format: google-datetime + etag: + description: >- + Output only. The etag is used for optimistic concurrency control as + a way to help prevent simultaneous `ChangeQuorum` requests that + might create a race condition. + readOnly: true + type: string + QuorumType: + id: QuorumType + description: >- + Information about the database quorum type. This only applies to + dual-region instance configs. type: object properties: - location: - description: The location of the serving resources, e.g., "us-central1". - type: string - type: - description: The type of replica. - type: string - enumDescriptions: - - Not specified. - - >- - Read-write replicas support both reads and writes. These replicas: - * Maintain a full copy of your data. * Serve reads. * Can vote - whether to commit a write. * Participate in leadership election. * - Are eligible to become a leader. - - >- - Read-only replicas only support reads (not writes). Read-only - replicas: * Maintain a full copy of your data. * Serve reads. * Do - not participate in voting to commit writes. * Are not eligible to - become a leader. - - >- - Witness replicas don't support reads but do participate in voting - to commit writes. Witness replicas: * Do not maintain a full copy - of data. * Do not serve reads. * Vote whether to commit writes. * - Participate in leader election but are not eligible to become - leader. - enum: - - TYPE_UNSPECIFIED - - READ_WRITE - - READ_ONLY - - WITNESS - defaultLeaderLocation: + singleRegion: + description: Single-region quorum type. + $ref: '#/components/schemas/SingleRegionQuorum' + dualRegion: + description: Dual-region quorum type. + $ref: '#/components/schemas/DualRegionQuorum' + SingleRegionQuorum: + id: SingleRegionQuorum + description: Message type for a single-region quorum. + type: object + properties: + servingLocation: description: >- - If true, this location is designated as the default leader location - where leader replicas are placed. See the [region types - documentation](https://cloud.google.com/spanner/docs/instances#region_types) - for more details. - type: boolean - CreateInstanceConfigRequest: - id: CreateInstanceConfigRequest - description: The request for CreateInstanceConfigRequest. + Required. The location of the serving region, e.g. "us-central1". + The location must be one of the regions within the dual-region + instance configuration of your database. The list of valid locations + is available using the GetInstanceConfig API. This should only be + used if you plan to change quorum to the single-region quorum type. + type: string + DualRegionQuorum: + id: DualRegionQuorum + description: >- + Message type for a dual-region quorum. Currently this type has no + options. + type: object + properties: {} + CreateDatabaseRequest: + id: CreateDatabaseRequest + description: The request for CreateDatabase. type: object properties: - instanceConfigId: + createStatement: description: >- - Required. The ID of the instance configuration to create. Valid - identifiers are of the form `custom-[-a-z0-9]*[a-z0-9]` and must be - between 2 and 64 characters in length. The `custom-` prefix is - required to avoid name conflicts with Google-managed configurations. + Required. A `CREATE DATABASE` statement, which specifies the ID of + the new database. The database ID must conform to the regular + expression `a-z*[a-z0-9]` and be between 2 and 30 characters in + length. If the database ID is a reserved word or if it contains a + hyphen, the database ID must be enclosed in backticks (`` ` ``). type: string - instanceConfig: + extraStatements: description: >- - Required. The `InstanceConfig` proto of the configuration to create. - `instance_config.name` must be `/instanceConfigs/`. - `instance_config.base_config` must be a Google-managed configuration - name, e.g. /instanceConfigs/us-east1, /instanceConfigs/nam3. - $ref: '#/components/schemas/InstanceConfig' - validateOnly: + Optional. A list of DDL statements to run inside the newly created + database. Statements can create tables, indexes, etc. These + statements execute atomically with the creation of the database: if + there is an error in any statement, the database is not created. + type: array + items: + type: string + encryptionConfig: description: >- - An option to validate, but not actually execute, a request, and - provide the same response. - type: boolean - UpdateInstanceConfigRequest: - id: UpdateInstanceConfigRequest - description: The request for UpdateInstanceConfigRequest. + Optional. The encryption configuration for the database. If this + field is not specified, Cloud Spanner will encrypt/decrypt all data + at rest using Google default encryption. + $ref: '#/components/schemas/EncryptionConfig' + databaseDialect: + description: Optional. The dialect of the Cloud Spanner Database. + type: string + enumDescriptions: + - >- + Default value. This value will create a database with the + GOOGLE_STANDARD_SQL dialect. + - GoogleSQL supported SQL. + - PostgreSQL supported SQL. + enum: + - DATABASE_DIALECT_UNSPECIFIED + - GOOGLE_STANDARD_SQL + - POSTGRESQL + protoDescriptors: + description: >- + Optional. Proto descriptors used by `CREATE/ALTER PROTO BUNDLE` + statements in 'extra_statements'. Contains a protobuf-serialized + [`google.protobuf.FileDescriptorSet`](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto) + descriptor set. To generate it, + [install](https://grpc.io/docs/protoc-installation/) and run + `protoc` with --include_imports and --descriptor_set_out. For + example, to generate for moon/shot/app.proto, run ``` $protoc + --proto_path=/app_path --proto_path=/lib_path \ --include_imports \ + --descriptor_set_out=descriptors.data \ moon/shot/app.proto ``` For + more details, see protobuffer [self + description](https://developers.google.com/protocol-buffers/docs/techniques#self-description). + type: string + format: byte + UpdateDatabaseDdlRequest: + id: UpdateDatabaseDdlRequest + description: >- + Enqueues the given DDL statements to be applied, in order but not + necessarily all at once, to the database schema at some point (or + points) in the future. The server checks that the statements are + executable (syntactically valid, name tables that exist, etc.) before + enqueueing them, but they may still fail upon later execution (e.g., if + a statement from another batch of statements is applied first and it + conflicts in some way, or if there is some data-related problem like a + `NULL` value in a column to which `NOT NULL` would be added). If a + statement fails, all subsequent statements in the batch are + automatically cancelled. Each batch of statements is assigned a name + which can be used with the Operations API to monitor progress. See the + operation_id field for more details. type: object properties: - instanceConfig: - description: >- - Required. The user instance configuration to update, which must - always include the instance configuration name. Otherwise, only - fields mentioned in update_mask need be included. To prevent - conflicts of concurrent updates, etag can be used. - $ref: '#/components/schemas/InstanceConfig' - updateMask: + statements: + description: Required. DDL statements to be applied to the database. + type: array + items: + type: string + operationId: description: >- - Required. A mask specifying which fields in InstanceConfig should be - updated. The field mask must always be specified; this prevents any - future fields in InstanceConfig from being erased accidentally by - clients that do not know about them. Only display_name and labels - can be updated. + If empty, the new update request is assigned an + automatically-generated operation ID. Otherwise, `operation_id` is + used to construct the name of the resulting Operation. Specifying an + explicit operation ID simplifies determining whether the statements + were executed in the event that the UpdateDatabaseDdl call is + replayed, or the return value is otherwise lost: the database and + `operation_id` fields can be combined to form the `name` of the + resulting longrunning.Operation: `/operations/`. `operation_id` + should be unique within the database, and must be a valid + identifier: `a-z*`. Note that automatically-generated operation IDs + always begin with an underscore. If the named operation already + exists, UpdateDatabaseDdl returns `ALREADY_EXISTS`. type: string - format: google-fieldmask - validateOnly: + protoDescriptors: description: >- - An option to validate, but not actually execute, a request, and - provide the same response. - type: boolean - ListInstanceConfigOperationsResponse: - id: ListInstanceConfigOperationsResponse - description: The response for ListInstanceConfigOperations. + Optional. Proto descriptors used by CREATE/ALTER PROTO BUNDLE + statements. Contains a protobuf-serialized + [google.protobuf.FileDescriptorSet](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto). + To generate it, [install](https://grpc.io/docs/protoc-installation/) + and run `protoc` with --include_imports and --descriptor_set_out. + For example, to generate for moon/shot/app.proto, run ``` $protoc + --proto_path=/app_path --proto_path=/lib_path \ --include_imports \ + --descriptor_set_out=descriptors.data \ moon/shot/app.proto ``` For + more details, see protobuffer [self + description](https://developers.google.com/protocol-buffers/docs/techniques#self-description). + type: string + format: byte + GetDatabaseDdlResponse: + id: GetDatabaseDdlResponse + description: The response for GetDatabaseDdl. type: object properties: - operations: + statements: description: >- - The list of matching instance configuration long-running operations. - Each operation's name will be prefixed by the name of the instance - configuration. The operation's metadata field type - `metadata.type_url` describes the type of the metadata. + A list of formatted DDL statements defining the schema of the + database specified in the request. type: array items: - $ref: '#/components/schemas/Operation' - nextPageToken: + type: string + protoDescriptors: description: >- - `next_page_token` can be sent in a subsequent - ListInstanceConfigOperations call to fetch more of the matching - metadata. + Proto descriptors stored in the database. Contains a + protobuf-serialized + [google.protobuf.FileDescriptorSet](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto). + For more details, see protobuffer [self + description](https://developers.google.com/protocol-buffers/docs/techniques#self-description). type: string - ListInstancesResponse: - id: ListInstancesResponse - description: The response for ListInstances. + format: byte + ChangeQuorumRequest: + id: ChangeQuorumRequest + description: The request for ChangeQuorum. type: object properties: - instances: - description: The list of requested instances. - type: array - items: - $ref: '#/components/schemas/Instance' - nextPageToken: + name: description: >- - `next_page_token` can be sent in a subsequent ListInstances call to - fetch more of the matching instances. + Required. Name of the database in which to apply `ChangeQuorum`. + Values are of the form `projects//instances//databases/`. type: string - unreachable: + quorumType: + description: Required. The type of this quorum. + $ref: '#/components/schemas/QuorumType' + etag: description: >- - The list of unreachable instances. It includes the names of - instances whose metadata could not be retrieved within - instance_deadline. - type: array - items: - type: string - Instance: - id: Instance - description: >- - An isolated set of Cloud Spanner resources on which databases can be - hosted. + Optional. The etag is the hash of the `QuorumInfo`. The + `ChangeQuorum` operation is only performed if the etag matches that + of the `QuorumInfo` in the current database resource. Otherwise the + API returns an `ABORTED` error. The etag is used for optimistic + concurrency control as a way to help prevent simultaneous change + quorum requests that could create a race condition. + type: string + Backup: + id: Backup + description: A backup of a Cloud Spanner database. type: object properties: - name: + database: description: >- - Required. A unique identifier for the instance, which cannot be - changed after the instance is created. Values are of the form - `projects//instances/a-z*[a-z0-9]`. The final segment of the name - must be between 2 and 64 characters in length. + Required for the CreateBackup operation. Name of the database from + which this backup was created. This needs to be in the same instance + as the backup. Values are of the form + `projects//instances//databases/`. type: string - config: + versionTime: description: >- - Required. The name of the instance's configuration. Values are of - the form `projects//instanceConfigs/`. See also InstanceConfig and - ListInstanceConfigs. + The backup will contain an externally consistent copy of the + database at the timestamp specified by `version_time`. If + `version_time` is not specified, the system will set `version_time` + to the `create_time` of the backup. type: string - displayName: + format: google-datetime + expireTime: description: >- - Required. The descriptive name for this instance as it appears in - UIs. Must be unique per project and between 4 and 30 characters in - length. + Required for the CreateBackup operation. The expiration time of the + backup, with microseconds granularity that must be at least 6 hours + and at most 366 days from the time the CreateBackup request is + processed. Once the `expire_time` has passed, the backup is eligible + to be automatically deleted by Cloud Spanner to free the resources + used by the backup. type: string - nodeCount: + format: google-datetime + name: description: >- - The number of nodes allocated to this instance. At most, one of - either `node_count` or `processing_units` should be present in the - message. Users can set the `node_count` field to specify the target - number of nodes allocated to the instance. If autoscaling is - enabled, `node_count` is treated as an `OUTPUT_ONLY` field and - reflects the current number of nodes allocated to the instance. This - might be zero in API responses for instances that are not yet in the - `READY` state. For more information, see [Compute capacity, nodes, - and processing - units](https://cloud.google.com/spanner/docs/compute-capacity). - type: integer - format: int32 - processingUnits: + Output only for the CreateBackup operation. Required for the + UpdateBackup operation. A globally unique identifier for the backup + which cannot be changed. Values are of the form + `projects//instances//backups/a-z*[a-z0-9]` The final segment of the + name must be between 2 and 60 characters in length. The backup is + stored in the location(s) specified in the instance configuration of + the instance containing the backup, identified by the prefix of the + backup name of the form `projects//instances/`. + type: string + createTime: description: >- - The number of processing units allocated to this instance. At most, - one of either `processing_units` or `node_count` should be present - in the message. Users can set the `processing_units` field to - specify the target number of processing units allocated to the - instance. If autoscaling is enabled, `processing_units` is treated - as an `OUTPUT_ONLY` field and reflects the current number of - processing units allocated to the instance. This might be zero in - API responses for instances that are not yet in the `READY` state. - For more information, see [Compute capacity, nodes and processing - units](https://cloud.google.com/spanner/docs/compute-capacity). - type: integer - format: int32 - replicaComputeCapacity: + Output only. The time the CreateBackup request is received. If the + request does not specify `version_time`, the `version_time` of the + backup will be equivalent to the `create_time`. + readOnly: true + type: string + format: google-datetime + sizeBytes: description: >- - Output only. Lists the compute capacity per ReplicaSelection. A - replica selection identifies a set of replicas with common - properties. Replicas identified by a ReplicaSelection are scaled - with the same compute capacity. + Output only. Size of the backup in bytes. For a backup in an + incremental backup chain, this is the sum of the + `exclusive_size_bytes` of itself and all older backups in the chain. readOnly: true - type: array - items: - $ref: '#/components/schemas/ReplicaComputeCapacity' - autoscalingConfig: + type: string + format: int64 + freeableSizeBytes: description: >- - Optional. The autoscaling configuration. Autoscaling is enabled if - this field is set. When autoscaling is enabled, node_count and - processing_units are treated as OUTPUT_ONLY fields and reflect the - current compute capacity allocated to the instance. - $ref: '#/components/schemas/AutoscalingConfig' - state: + Output only. The number of bytes that will be freed by deleting this + backup. This value will be zero if, for example, this backup is part + of an incremental backup chain and younger backups in the chain + require that we keep its data. For backups not in an incremental + backup chain, this is always the size of the backup. This value may + change if backups on the same chain get created, deleted or expired. + readOnly: true + type: string + format: int64 + exclusiveSizeBytes: description: >- - Output only. The current instance state. For CreateInstance, the - state must be either omitted or set to `CREATING`. For - UpdateInstance, the state must be either omitted or set to `READY`. + Output only. For a backup in an incremental backup chain, this is + the storage space needed to keep the data that has changed since the + previous backup. For all other backups, this is always the size of + the backup. This value may change if backups on the same chain get + deleted or expired. This field can be used to calculate the total + storage space used by a set of backups. For example, the total space + used by all backups of a database can be computed by summing up this + field. + readOnly: true + type: string + format: int64 + state: + description: Output only. The current state of the backup. readOnly: true type: string enumDescriptions: - Not specified. - >- - The instance is still being created. Resources may not be - available yet, and operations such as database creation may not - work. - - >- - The instance is fully created and ready to do work such as - creating databases. + The pending backup is still being created. Operations on the + backup may fail with `FAILED_PRECONDITION` in this state. + - The backup is complete and ready for use. enum: - STATE_UNSPECIFIED - CREATING - READY - labels: + referencingDatabases: description: >- - Cloud Labels are a flexible and lightweight mechanism for organizing - cloud resources into groups that reflect a customer's organizational - needs and deployment strategies. Cloud Labels can be used to filter - collections of resources. They can be used to control how resource - metrics are aggregated. And they can be used as arguments to policy - management rules (e.g. route, firewall, load balancing, etc.). * - Label keys must be between 1 and 63 characters long and must conform - to the following regular expression: `a-z{0,62}`. * Label values - must be between 0 and 63 characters long and must conform to the - regular expression `[a-z0-9_-]{0,63}`. * No more than 64 labels can - be associated with a given resource. See https://goo.gl/xmQnxf for - more information on and examples of labels. If you plan to use - labels in your own code, please note that additional characters may - be allowed in the future. And so you are advised to use an internal - label representation, such as JSON, which doesn't rely upon specific - characters being disallowed. For example, representing labels as the - string: name + "_" + value would prove problematic if we were to - allow "_" in a future release. - type: object - additionalProperties: + Output only. The names of the restored databases that reference the + backup. The database names are of the form + `projects//instances//databases/`. Referencing databases may exist + in different instances. The existence of any referencing database + prevents the backup from being deleted. When a restored database + from the backup enters the `READY` state, the reference to the + backup is removed. + readOnly: true + type: array + items: type: string - instanceType: - description: The `InstanceType` of the current instance. + encryptionInfo: + description: Output only. The encryption information for the backup. + readOnly: true + $ref: '#/components/schemas/EncryptionInfo' + encryptionInformation: + description: >- + Output only. The encryption information for the backup, whether it + is protected by one or more KMS keys. The information includes all + Cloud KMS key versions used to encrypt the backup. The + `encryption_status` field inside of each `EncryptionInfo` is not + populated. At least one of the key versions must be available for + the backup to be restored. If a key version is revoked in the middle + of a restore, the restore behavior is undefined. + readOnly: true + type: array + items: + $ref: '#/components/schemas/EncryptionInfo' + databaseDialect: + description: Output only. The database dialect information for the backup. + readOnly: true type: string enumDescriptions: - - Not specified. - - >- - Provisioned instances have dedicated resources, standard usage - limits and support. - >- - Free instances provide no guarantee for dedicated resources, - [node_count, processing_units] should be 0. They come with - stricter usage limits and limited support. + Default value. This value will create a database with the + GOOGLE_STANDARD_SQL dialect. + - GoogleSQL supported SQL. + - PostgreSQL supported SQL. enum: - - INSTANCE_TYPE_UNSPECIFIED - - PROVISIONED - - FREE_INSTANCE - endpointUris: - description: Deprecated. This field is not populated. + - DATABASE_DIALECT_UNSPECIFIED + - GOOGLE_STANDARD_SQL + - POSTGRESQL + referencingBackups: + description: >- + Output only. The names of the destination backups being created by + copying this source backup. The backup names are of the form + `projects//instances//backups/`. Referencing backups may exist in + different instances. The existence of any referencing backup + prevents the backup from being deleted. When the copy operation is + done (either successfully completed or cancelled or the destination + backup is deleted), the reference to the backup is removed. + readOnly: true type: array items: type: string - createTime: - description: Output only. The time at which the instance was created. + maxExpireTime: + description: >- + Output only. The max allowed expiration time of the backup, with + microseconds granularity. A backup's expiration time can be + configured in multiple APIs: CreateBackup, UpdateBackup, CopyBackup. + When updating or copying an existing backup, the expiration time + specified must be less than `Backup.max_expire_time`. readOnly: true type: string format: google-datetime - updateTime: + backupSchedules: description: >- - Output only. The time at which the instance was most recently - updated. + Output only. List of backup schedule URIs that are associated with + creating this backup. This is only applicable for scheduled backups, + and is empty for on-demand backups. To optimize for storage, + whenever possible, multiple schedules are collapsed together to + create one backup. In such cases, this field captures the list of + all backup schedule URIs that are associated with creating this + backup. If collapsing is not done, then this field captures the + single backup schedule URI associated with creating this backup. readOnly: true - type: string - format: google-datetime - freeInstanceMetadata: - description: Free instance metadata. Only populated for free instances. - $ref: '#/components/schemas/FreeInstanceMetadata' - edition: - description: Optional. The `Edition` of the current instance. - type: string - enumDescriptions: - - Edition not specified. - - Standard edition. - - Enterprise edition. - - Enterprise Plus edition. - enum: - - EDITION_UNSPECIFIED - - STANDARD - - ENTERPRISE - - ENTERPRISE_PLUS - defaultBackupScheduleType: + type: array + items: + type: string + incrementalBackupChainId: description: >- - Optional. Controls the default backup behavior for new databases - within the instance. Note that `AUTOMATIC` is not permitted for free - instances, as backups and backup schedules are not allowed for free - instances. In the `GetInstance` or `ListInstances` response, if the - value of default_backup_schedule_type is unset or NONE, no default - backup schedule will be created for new databases within the - instance. + Output only. Populated only for backups in an incremental backup + chain. Backups share the same chain id if and only if they belong to + the same incremental backup chain. Use this field to determine which + backups are part of the same incremental backup chain. The ordering + of backups in the chain can be determined by ordering the backup + `version_time`. + readOnly: true type: string - enumDescriptions: - - Not specified. - - >- - No default backup schedule will be created automatically on - creation of a database within the instance. - - >- - A default backup schedule will be created automatically on - creation of a database within the instance. The default backup - schedule creates a full backup every 24 hours and retains the - backup for a period of 7 days. Once created, the default backup - schedule can be edited/deleted similar to any other backup - schedule. - enum: - - DEFAULT_BACKUP_SCHEDULE_TYPE_UNSPECIFIED - - NONE - - AUTOMATIC - ReplicaComputeCapacity: - id: ReplicaComputeCapacity - description: >- - ReplicaComputeCapacity describes the amount of server resources that are - allocated to each replica identified by the replica selection. - type: object - properties: - replicaSelection: - description: >- - Required. Identifies replicas by specified properties. All replicas - in the selection have the same amount of compute capacity. - $ref: '#/components/schemas/InstanceReplicaSelection' - nodeCount: - description: >- - The number of nodes allocated to each replica. This may be zero in - API responses for instances that are not yet in state `READY`. - type: integer - format: int32 - processingUnits: - description: >- - The number of processing units allocated to each replica. This may - be zero in API responses for instances that are not yet in state - `READY`. - type: integer - format: int32 - InstanceReplicaSelection: - id: InstanceReplicaSelection - description: ReplicaSelection identifies replicas with common properties. - type: object - properties: - location: + oldestVersionTime: description: >- - Required. Name of the location of the replicas (e.g., - "us-central1"). + Output only. Data deleted at a time older than this is guaranteed + not to be retained in order to support this backup. For a backup in + an incremental backup chain, this is the version time of the oldest + backup that exists or ever existed in the chain. For all other + backups, this is the version time of the backup. This field can be + used to understand what data is being retained by the backup system. + readOnly: true type: string - AutoscalingConfig: - id: AutoscalingConfig - description: Autoscaling configuration for an instance. - type: object - properties: - autoscalingLimits: - description: Required. Autoscaling limits for an instance. - $ref: '#/components/schemas/AutoscalingLimits' - autoscalingTargets: - description: Required. The autoscaling targets for an instance. - $ref: '#/components/schemas/AutoscalingTargets' - asymmetricAutoscalingOptions: + format: google-datetime + instancePartitions: description: >- - Optional. Optional asymmetric autoscaling options. Replicas matching - the replica selection criteria will be autoscaled independently from - other replicas. The autoscaler will scale the replicas based on the - utilization of replicas identified by the replica selection. Replica - selections should not overlap with each other. Other replicas (those - do not match any replica selection) will be autoscaled together and - will have the same compute capacity allocated to them. + Output only. The instance partition(s) storing the backup. This is + the same as the list of the instance partition(s) that the database + had footprint in at the backup's `version_time`. + readOnly: true type: array items: - $ref: '#/components/schemas/AsymmetricAutoscalingOption' - AutoscalingLimits: - id: AutoscalingLimits - description: >- - The autoscaling limits for the instance. Users can define the minimum - and maximum compute capacity allocated to the instance, and the - autoscaler will only scale within that range. Users can either use nodes - or processing units to specify the limits, but should use the same unit - to set both the min_limit and max_limit. + $ref: '#/components/schemas/BackupInstancePartition' + BackupInstancePartition: + id: BackupInstancePartition + description: Instance partition information for the backup. type: object properties: - minNodes: - description: >- - Minimum number of nodes allocated to the instance. If set, this - number should be greater than or equal to 1. - type: integer - format: int32 - minProcessingUnits: - description: >- - Minimum number of processing units allocated to the instance. If - set, this number should be multiples of 1000. - type: integer - format: int32 - maxNodes: - description: >- - Maximum number of nodes allocated to the instance. If set, this - number should be greater than or equal to min_nodes. - type: integer - format: int32 - maxProcessingUnits: + instancePartition: description: >- - Maximum number of processing units allocated to the instance. If - set, this number should be multiples of 1000 and be greater than or - equal to min_processing_units. - type: integer - format: int32 - AutoscalingTargets: - id: AutoscalingTargets - description: The autoscaling targets for an instance. + A unique identifier for the instance partition. Values are of the + form `projects//instances//instancePartitions/` + type: string + CopyBackupRequest: + id: CopyBackupRequest + description: The request for CopyBackup. type: object properties: - highPriorityCpuUtilizationPercent: + backupId: description: >- - Required. The target high priority cpu utilization percentage that - the autoscaler should be trying to achieve for the instance. This - number is on a scale from 0 (no utilization) to 100 (full - utilization). The valid range is [10, 90] inclusive. - type: integer - format: int32 - storageUtilizationPercent: + Required. The id of the backup copy. The `backup_id` appended to + `parent` forms the full backup_uri of the form + `projects//instances//backups/`. + type: string + sourceBackup: description: >- - Required. The target storage utilization percentage that the - autoscaler should be trying to achieve for the instance. This number - is on a scale from 0 (no utilization) to 100 (full utilization). The - valid range is [10, 99] inclusive. - type: integer - format: int32 - AsymmetricAutoscalingOption: - id: AsymmetricAutoscalingOption - description: >- - AsymmetricAutoscalingOption specifies the scaling of replicas identified - by the given selection. + Required. The source backup to be copied. The source backup needs to + be in READY state for it to be copied. Once CopyBackup is in + progress, the source backup cannot be deleted or cleaned up on + expiration until CopyBackup is finished. Values are of the form: + `projects//instances//backups/`. + type: string + expireTime: + description: >- + Required. The expiration time of the backup in microsecond + granularity. The expiration time must be at least 6 hours and at + most 366 days from the `create_time` of the source backup. Once the + `expire_time` has passed, the backup is eligible to be automatically + deleted by Cloud Spanner to free the resources used by the backup. + type: string + format: google-datetime + encryptionConfig: + description: >- + Optional. The encryption configuration used to encrypt the backup. + If this field is not specified, the backup will use the same + encryption configuration as the source backup by default, namely + encryption_type = `USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION`. + $ref: '#/components/schemas/CopyBackupEncryptionConfig' + CopyBackupEncryptionConfig: + id: CopyBackupEncryptionConfig + description: Encryption configuration for the copied backup. type: object properties: - replicaSelection: + encryptionType: + description: Required. The encryption type of the backup. + type: string + enumDescriptions: + - Unspecified. Do not use. + - >- + This is the default option for CopyBackup when encryption_config + is not specified. For example, if the source backup is using + `Customer_Managed_Encryption`, the backup will be using the same + Cloud KMS key as the source backup. + - Use Google default encryption. + - >- + Use customer managed encryption. If specified, either + `kms_key_name` or `kms_key_names` must contain valid Cloud KMS + key(s). + enum: + - ENCRYPTION_TYPE_UNSPECIFIED + - USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION + - GOOGLE_DEFAULT_ENCRYPTION + - CUSTOMER_MANAGED_ENCRYPTION + kmsKeyName: description: >- - Required. Selects the replicas to which this - AsymmetricAutoscalingOption applies. Only read-only replicas are - supported. - $ref: '#/components/schemas/InstanceReplicaSelection' - overrides: + Optional. The Cloud KMS key that will be used to protect the backup. + This field should be set only when encryption_type is + `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form + `projects//locations//keyRings//cryptoKeys/`. + type: string + kmsKeyNames: description: >- - Optional. Overrides applied to the top-level autoscaling - configuration for the selected replicas. - $ref: '#/components/schemas/AutoscalingConfigOverrides' - AutoscalingConfigOverrides: - id: AutoscalingConfigOverrides - description: >- - Overrides the top-level autoscaling configuration for the replicas - identified by `replica_selection`. All fields in this message are - optional. Any unspecified fields will use the corresponding values from - the top-level autoscaling configuration. + Optional. Specifies the KMS configuration for the one or more keys + used to protect the backup. Values are of the form + `projects//locations//keyRings//cryptoKeys/`. KMS keys specified can + be in any order. The keys referenced by `kms_key_names` must fully + cover all regions of the backup's instance configuration. Some + examples: * For regional (single-region) instance configurations, + specify a regional location KMS key. * For multi-region instance + configurations of type `GOOGLE_MANAGED`, either specify a + multi-region location KMS key or multiple regional location KMS keys + that cover all regions in the instance configuration. * For an + instance configuration of type `USER_MANAGED`, specify only regional + location KMS keys to cover each region in the instance + configuration. Multi-region location KMS keys aren't supported for + `USER_MANAGED` type instance configurations. + type: array + items: + type: string + ListBackupsResponse: + id: ListBackupsResponse + description: The response for ListBackups. type: object properties: - autoscalingLimits: + backups: description: >- - Optional. If specified, overrides the min/max limit in the top-level - autoscaling configuration for the selected replicas. - $ref: '#/components/schemas/AutoscalingLimits' - autoscalingTargetHighPriorityCpuUtilizationPercent: + The list of matching backups. Backups returned are ordered by + `create_time` in descending order, starting from the most recent + `create_time`. + type: array + items: + $ref: '#/components/schemas/Backup' + nextPageToken: description: >- - Optional. If specified, overrides the autoscaling target - high_priority_cpu_utilization_percent in the top-level autoscaling - configuration for the selected replicas. - type: integer - format: int32 - FreeInstanceMetadata: - id: FreeInstanceMetadata - description: >- - Free instance specific metadata that is kept even after an instance has - been upgraded for tracking purposes. + `next_page_token` can be sent in a subsequent ListBackups call to + fetch more of the matching backups. + type: string + RestoreDatabaseRequest: + id: RestoreDatabaseRequest + description: The request for RestoreDatabase. type: object properties: - expireTime: + databaseId: description: >- - Output only. Timestamp after which the instance will either be - upgraded or scheduled for deletion after a grace period. - ExpireBehavior is used to choose between upgrading or scheduling the - free instance for deletion. This timestamp is set during the - creation of a free instance. - readOnly: true + Required. The id of the database to create and restore to. This + database must not already exist. The `database_id` appended to + `parent` forms the full database name of the form + `projects//instances//databases/`. type: string - format: google-datetime - upgradeTime: + backup: description: >- - Output only. If present, the timestamp at which the free instance - was upgraded to a provisioned instance. - readOnly: true + Name of the backup from which to restore. Values are of the form + `projects//instances//backups/`. type: string - format: google-datetime - expireBehavior: + encryptionConfig: description: >- - Specifies the expiration behavior of a free instance. The default of - ExpireBehavior is `REMOVE_AFTER_GRACE_PERIOD`. This can be modified - during or after creation, and before expiration. + Optional. An encryption configuration describing the encryption type + and key resources in Cloud KMS used to encrypt/decrypt the database + to restore to. If this field is not specified, the restored database + will use the same encryption configuration as the backup by default, + namely encryption_type = `USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION`. + $ref: '#/components/schemas/RestoreDatabaseEncryptionConfig' + RestoreDatabaseEncryptionConfig: + id: RestoreDatabaseEncryptionConfig + description: Encryption configuration for the restored database. + type: object + properties: + encryptionType: + description: Required. The encryption type of the restored database. type: string enumDescriptions: - - Not specified. + - Unspecified. Do not use. - >- - When the free instance expires, upgrade the instance to a - provisioned instance. + This is the default option when encryption_config is not + specified. + - Use Google default encryption. - >- - When the free instance expires, disable the instance, and delete - it after the grace period passes if it has not been upgraded. + Use customer managed encryption. If specified, `kms_key_name` must + must contain a valid Cloud KMS key. enum: - - EXPIRE_BEHAVIOR_UNSPECIFIED - - FREE_TO_PROVISIONED - - REMOVE_AFTER_GRACE_PERIOD - ListInstancePartitionsResponse: - id: ListInstancePartitionsResponse - description: The response for ListInstancePartitions. + - ENCRYPTION_TYPE_UNSPECIFIED + - USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION + - GOOGLE_DEFAULT_ENCRYPTION + - CUSTOMER_MANAGED_ENCRYPTION + kmsKeyName: + description: >- + Optional. The Cloud KMS key that will be used to encrypt/decrypt the + restored database. This field should be set only when + encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the + form `projects//locations//keyRings//cryptoKeys/`. + type: string + kmsKeyNames: + description: >- + Optional. Specifies the KMS configuration for one or more keys used + to encrypt the database. Values have the form + `projects//locations//keyRings//cryptoKeys/`. The keys referenced by + `kms_key_names` must fully cover all regions of the database's + instance configuration. Some examples: * For regional + (single-region) instance configurations, specify a regional location + KMS key. * For multi-region instance configurations of type + `GOOGLE_MANAGED`, either specify a multi-region location KMS key or + multiple regional location KMS keys that cover all regions in the + instance configuration. * For an instance configuration of type + `USER_MANAGED`, specify only regional location KMS keys to cover + each region in the instance configuration. Multi-region location KMS + keys aren't supported for `USER_MANAGED` type instance + configurations. + type: array + items: + type: string + ListDatabaseOperationsResponse: + id: ListDatabaseOperationsResponse + description: The response for ListDatabaseOperations. type: object properties: - instancePartitions: - description: The list of requested instancePartitions. + operations: + description: >- + The list of matching database long-running operations. Each + operation's name will be prefixed by the database's name. The + operation's metadata field type `metadata.type_url` describes the + type of the metadata. + type: array + items: + $ref: '#/components/schemas/Operation' + nextPageToken: + description: >- + `next_page_token` can be sent in a subsequent ListDatabaseOperations + call to fetch more of the matching metadata. + type: string + ListBackupOperationsResponse: + id: ListBackupOperationsResponse + description: The response for ListBackupOperations. + type: object + properties: + operations: + description: >- + The list of matching backup long-running operations. Each + operation's name will be prefixed by the backup's name. The + operation's metadata field type `metadata.type_url` describes the + type of the metadata. Operations returned include those that are + pending or have completed/failed/canceled within the last 7 days. + Operations returned are ordered by + `operation.metadata.value.progress.start_time` in descending order + starting from the most recently started operation. type: array items: - $ref: '#/components/schemas/InstancePartition' + $ref: '#/components/schemas/Operation' nextPageToken: description: >- - `next_page_token` can be sent in a subsequent ListInstancePartitions - call to fetch more of the matching instance partitions. + `next_page_token` can be sent in a subsequent ListBackupOperations + call to fetch more of the matching metadata. type: string - unreachable: - description: >- - The list of unreachable instances or instance partitions. It - includes the names of instances or instance partitions whose - metadata could not be retrieved within instance_partition_deadline. + ListDatabaseRolesResponse: + id: ListDatabaseRolesResponse + description: The response for ListDatabaseRoles. + type: object + properties: + databaseRoles: + description: Database roles that matched the request. type: array items: - type: string - InstancePartition: - id: InstancePartition - description: >- - An isolated set of Cloud Spanner resources that databases can define - placements on. + $ref: '#/components/schemas/DatabaseRole' + nextPageToken: + description: >- + `next_page_token` can be sent in a subsequent ListDatabaseRoles call + to fetch more of the matching roles. + type: string + DatabaseRole: + id: DatabaseRole + description: A Cloud Spanner database role. type: object properties: name: description: >- - Required. A unique identifier for the instance partition. Values are - of the form `projects//instances//instancePartitions/a-z*[a-z0-9]`. - The final segment of the name must be between 2 and 64 characters in - length. An instance partition's name cannot be changed after the - instance partition is created. - type: string - config: - description: >- - Required. The name of the instance partition's configuration. Values - are of the form `projects//instanceConfigs/`. See also - InstanceConfig and ListInstanceConfigs. - type: string - displayName: - description: >- - Required. The descriptive name for this instance partition as it - appears in UIs. Must be unique per project and between 4 and 30 - characters in length. + Required. The name of the database role. Values are of the form + `projects//instances//databases//databaseRoles/` where `` is as + specified in the `CREATE ROLE` DDL statement. type: string - nodeCount: - description: >- - The number of nodes allocated to this instance partition. Users can - set the `node_count` field to specify the target number of nodes - allocated to the instance partition. This may be zero in API - responses for instance partitions that are not yet in state `READY`. - type: integer - format: int32 - processingUnits: + AddSplitPointsRequest: + id: AddSplitPointsRequest + description: The request for AddSplitPoints. + type: object + properties: + splitPoints: + description: Required. The split points to add. + type: array + items: + $ref: '#/components/schemas/SplitPoints' + initiator: description: >- - The number of processing units allocated to this instance partition. - Users can set the `processing_units` field to specify the target - number of processing units allocated to the instance partition. This - might be zero in API responses for instance partitions that are not - yet in the `READY` state. - type: integer - format: int32 - state: - description: Output only. The current instance partition state. - readOnly: true + Optional. A user-supplied tag associated with the split points. For + example, "initial_data_load", "special_event_1". Defaults to + "CloudAddSplitPointsAPI" if not specified. The length of the tag + must not exceed 50 characters, or else it is trimmed. Only valid + UTF8 characters are allowed. type: string - enumDescriptions: - - Not specified. - - >- - The instance partition is still being created. Resources may not - be available yet, and operations such as creating placements using - this instance partition may not work. - - >- - The instance partition is fully created and ready to do work such - as creating placements and using in databases. - enum: - - STATE_UNSPECIFIED - - CREATING - - READY - createTime: - description: Output only. The time at which the instance partition was created. - readOnly: true + SplitPoints: + id: SplitPoints + description: The split points of a table or an index. + type: object + properties: + table: + description: The table to split. type: string - format: google-datetime - updateTime: + index: description: >- - Output only. The time at which the instance partition was most - recently updated. - readOnly: true + The index to split. If specified, the `table` field must refer to + the index's base table. type: string - format: google-datetime - referencingDatabases: - description: >- - Output only. The names of the databases that reference this instance - partition. Referencing databases should share the parent instance. - The existence of any referencing database prevents the instance - partition from being deleted. - readOnly: true + keys: + description: Required. The list of split keys. In essence, the split boundaries. type: array items: - type: string - referencingBackups: + $ref: '#/components/schemas/Key' + expireTime: description: >- - Output only. Deprecated: This field is not populated. Output only. - The names of the backups that reference this instance partition. - Referencing backups should share the parent instance. The existence - of any referencing backup prevents the instance partition from being - deleted. - readOnly: true - deprecated: true + Optional. The expiration timestamp of the split points. A timestamp + in the past means immediate expiration. The maximum value can be 30 + days in the future. Defaults to 10 days in the future if not + specified. + type: string + format: google-datetime + Key: + id: Key + description: A split key. + type: object + properties: + keyParts: + description: Required. The column values making up the split key. type: array items: - type: string - etag: - description: >- - Used for optimistic concurrency control as a way to help prevent - simultaneous updates of a instance partition from overwriting each - other. It is strongly suggested that systems make use of the etag in - the read-modify-write cycle to perform instance partition updates in - order to avoid race conditions: An etag is returned in the response - which contains instance partitions, and systems are expected to put - that etag in the request to update instance partitions to ensure - that their change will be applied to the same version of the - instance partition. If no etag is provided in the call to update - instance partition, then the existing instance partition is - overwritten blindly. - type: string - CreateInstanceRequest: - id: CreateInstanceRequest - description: The request for CreateInstance. + type: any + AddSplitPointsResponse: + id: AddSplitPointsResponse + description: The response for AddSplitPoints. + type: object + properties: {} + BackupSchedule: + id: BackupSchedule + description: >- + BackupSchedule expresses the automated backup creation specification for + a Spanner database. type: object properties: - instanceId: + name: description: >- - Required. The ID of the instance to create. Valid identifiers are of - the form `a-z*[a-z0-9]` and must be between 2 and 64 characters in + Identifier. Output only for the CreateBackupSchedule operation. + Required for the UpdateBackupSchedule operation. A globally unique + identifier for the backup schedule which cannot be changed. Values + are of the form + `projects//instances//databases//backupSchedules/a-z*[a-z0-9]` The + final segment of the name must be between 2 and 60 characters in length. type: string - instance: + spec: description: >- - Required. The instance to create. The name may be omitted, but if - specified must be `/instances/`. - $ref: '#/components/schemas/Instance' - UpdateInstanceRequest: - id: UpdateInstanceRequest - description: The request for UpdateInstance. - type: object - properties: - instance: + Optional. The schedule specification based on which the backup + creations are triggered. + $ref: '#/components/schemas/BackupScheduleSpec' + retentionDuration: description: >- - Required. The instance to update, which must always include the - instance name. Otherwise, only fields mentioned in field_mask need - be included. - $ref: '#/components/schemas/Instance' - fieldMask: + Optional. The retention duration of a backup that must be at least 6 + hours and at most 366 days. The backup is eligible to be + automatically deleted once the retention period has elapsed. + type: string + format: google-duration + encryptionConfig: description: >- - Required. A mask specifying which fields in Instance should be - updated. The field mask must always be specified; this prevents any - future fields in Instance from being erased accidentally by clients - that do not know about them. + Optional. The encryption configuration that is used to encrypt the + backup. If this field is not specified, the backup uses the same + encryption configuration as the database. + $ref: '#/components/schemas/CreateBackupEncryptionConfig' + fullBackupSpec: + description: The schedule creates only full backups. + $ref: '#/components/schemas/FullBackupSpec' + incrementalBackupSpec: + description: The schedule creates incremental backup chains. + $ref: '#/components/schemas/IncrementalBackupSpec' + updateTime: + description: >- + Output only. The timestamp at which the schedule was last updated. + If the schedule has never been updated, this field contains the + timestamp when the schedule was first created. + readOnly: true type: string - format: google-fieldmask - CreateInstancePartitionRequest: - id: CreateInstancePartitionRequest - description: The request for CreateInstancePartition. + format: google-datetime + BackupScheduleSpec: + id: BackupScheduleSpec + description: Defines specifications of the backup schedule. type: object properties: - instancePartitionId: - description: >- - Required. The ID of the instance partition to create. Valid - identifiers are of the form `a-z*[a-z0-9]` and must be between 2 and - 64 characters in length. - type: string - instancePartition: - description: >- - Required. The instance partition to create. The - instance_partition.name may be omitted, but if specified must be - `/instancePartitions/`. - $ref: '#/components/schemas/InstancePartition' - UpdateInstancePartitionRequest: - id: UpdateInstancePartitionRequest - description: The request for UpdateInstancePartition. + cronSpec: + description: Cron style schedule specification. + $ref: '#/components/schemas/CrontabSpec' + CrontabSpec: + id: CrontabSpec + description: >- + CrontabSpec can be used to specify the version time and frequency at + which the backup is created. type: object properties: - instancePartition: + text: description: >- - Required. The instance partition to update, which must always - include the instance partition name. Otherwise, only fields - mentioned in field_mask need be included. - $ref: '#/components/schemas/InstancePartition' - fieldMask: + Required. Textual representation of the crontab. User can customize + the backup frequency and the backup version time using the cron + expression. The version time must be in UTC timezone. The backup + will contain an externally consistent copy of the database at the + version time. Full backups must be scheduled a minimum of 12 hours + apart and incremental backups must be scheduled a minimum of 4 hours + apart. Examples of valid cron specifications: * `0 2/12 * * *` : + every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * + *` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 */4 + * * *` : (incremental backups only) every 4 hours at (0, 4, 8, 12, + 16, 20) hours past midnight in UTC. * `0 2 * * *` : once a day at 2 + past midnight in UTC. * `0 2 * * 0` : once a week every Sunday at 2 + past midnight in UTC. * `0 2 8 * *` : once a month on 8th day at 2 + past midnight in UTC. + type: string + timeZone: + description: >- + Output only. The time zone of the times in `CrontabSpec.text`. + Currently, only UTC is supported. + readOnly: true + type: string + creationWindow: description: >- - Required. A mask specifying which fields in InstancePartition should - be updated. The field mask must always be specified; this prevents - any future fields in InstancePartition from being erased - accidentally by clients that do not know about them. + Output only. Scheduled backups contain an externally consistent copy + of the database at the version time specified in + `schedule_spec.cron_spec`. However, Spanner might not initiate the + creation of the scheduled backups at that version time. Spanner + initiates the creation of scheduled backups within the time window + bounded by the version_time specified in `schedule_spec.cron_spec` + and version_time + `creation_window`. + readOnly: true type: string - format: google-fieldmask - ListInstancePartitionOperationsResponse: - id: ListInstancePartitionOperationsResponse - description: The response for ListInstancePartitionOperations. + format: google-duration + CreateBackupEncryptionConfig: + id: CreateBackupEncryptionConfig + description: Encryption configuration for the backup to create. type: object properties: - operations: - description: >- - The list of matching instance partition long-running operations. - Each operation's name will be prefixed by the instance partition's - name. The operation's metadata field type `metadata.type_url` - describes the type of the metadata. - type: array - items: - $ref: '#/components/schemas/Operation' - nextPageToken: + encryptionType: + description: Required. The encryption type of the backup. + type: string + enumDescriptions: + - Unspecified. Do not use. + - >- + Use the same encryption configuration as the database. This is the + default option when encryption_config is empty. For example, if + the database is using `Customer_Managed_Encryption`, the backup + will be using the same Cloud KMS key as the database. + - Use Google default encryption. + - >- + Use customer managed encryption. If specified, `kms_key_name` must + contain a valid Cloud KMS key. + enum: + - ENCRYPTION_TYPE_UNSPECIFIED + - USE_DATABASE_ENCRYPTION + - GOOGLE_DEFAULT_ENCRYPTION + - CUSTOMER_MANAGED_ENCRYPTION + kmsKeyName: description: >- - `next_page_token` can be sent in a subsequent - ListInstancePartitionOperations call to fetch more of the matching - metadata. + Optional. The Cloud KMS key that will be used to protect the backup. + This field should be set only when encryption_type is + `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form + `projects//locations//keyRings//cryptoKeys/`. type: string - unreachableInstancePartitions: + kmsKeyNames: description: >- - The list of unreachable instance partitions. It includes the names - of instance partitions whose operation metadata could not be - retrieved within instance_partition_deadline. + Optional. Specifies the KMS configuration for the one or more keys + used to protect the backup. Values are of the form + `projects//locations//keyRings//cryptoKeys/`. The keys referenced by + `kms_key_names` must fully cover all regions of the backup's + instance configuration. Some examples: * For regional + (single-region) instance configurations, specify a regional location + KMS key. * For multi-region instance configurations of type + `GOOGLE_MANAGED`, either specify a multi-region location KMS key or + multiple regional location KMS keys that cover all regions in the + instance configuration. * For an instance configuration of type + `USER_MANAGED`, specify only regional location KMS keys to cover + each region in the instance configuration. Multi-region location KMS + keys aren't supported for `USER_MANAGED` type instance + configurations. type: array items: type: string - MoveInstanceRequest: - id: MoveInstanceRequest - description: The request for MoveInstance. + FullBackupSpec: + id: FullBackupSpec + description: >- + The specification for full backups. A full backup stores the entire + contents of the database at a given version time. + type: object + properties: {} + IncrementalBackupSpec: + id: IncrementalBackupSpec + description: >- + The specification for incremental backup chains. An incremental backup + stores the delta of changes between a previous backup and the database + contents at a given version time. An incremental backup chain consists + of a full backup and zero or more successive incremental backups. The + first backup created for an incremental backup chain is always a full + backup. + type: object + properties: {} + ListBackupSchedulesResponse: + id: ListBackupSchedulesResponse + description: The response for ListBackupSchedules. type: object properties: - targetConfig: + backupSchedules: + description: The list of backup schedules for a database. + type: array + items: + $ref: '#/components/schemas/BackupSchedule' + nextPageToken: description: >- - Required. The target instance configuration where to move the - instance. Values are of the form `projects//instanceConfigs/`. + `next_page_token` can be sent in a subsequent ListBackupSchedules + call to fetch more of the schedules. type: string CreateSessionRequest: id: CreateSessionRequest @@ -2968,7 +3166,7 @@ components: approximateLastUseTime: description: >- Output only. The approximate timestamp when the session is last - used. It is typically earlier than the actual last use time. + used. It's typically earlier than the actual last use time. readOnly: true type: string format: google-datetime @@ -2977,10 +3175,10 @@ components: type: string multiplexed: description: >- - Optional. If true, specifies a multiplexed session. Use a + Optional. If `true`, specifies a multiplexed session. Use a multiplexed session for multiple, concurrent read-only operations. Don't use them for read-write transactions, partitioned reads, or - partitioned queries. Use CreateSession to create multiplexed + partitioned queries. Use `sessions.create` to create multiplexed sessions. Don't use BatchCreateSessions to create a multiplexed session. You can't delete or list multiplexed sessions. type: boolean @@ -2990,15 +3188,15 @@ components: type: object properties: sessionTemplate: - description: Parameters to be applied to each created session. + description: Parameters to apply to each created session. $ref: '#/components/schemas/Session' sessionCount: description: >- Required. The number of sessions to be created in this batch call. - The API may return fewer than the requested number of sessions. If a + The API can return fewer than the requested number of sessions. If a specific number of sessions are desired, the client can make - additional calls to BatchCreateSessions (adjusting session_count as - necessary). + additional calls to `BatchCreateSessions` (adjusting session_count + as necessary). type: integer format: int32 BatchCreateSessionsResponse: @@ -3054,18 +3252,18 @@ components: https://cloud.google.com/spanner/docs/lexical#identifiers. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `"WHERE - id > @msg_id AND id < @msg_id + 100"` It is an error to execute a - SQL statement with unbound parameters. + id > @msg_id AND id < @msg_id + 100"` It's an error to execute a SQL + statement with unbound parameters. type: object additionalProperties: type: any description: Properties of the object. paramTypes: description: >- - It is not always possible for Cloud Spanner to infer the right SQL + It isn't always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type `BYTES` and values of type `STRING` both appear in params as JSON strings. In - these cases, `param_types` can be used to specify the exact SQL type + these cases, you can use `param_types` to specify the exact SQL type for some or all of the SQL statement parameters. See the definition of Type for more information about SQL types. type: object @@ -3095,7 +3293,7 @@ components: - >- This mode returns the query plan, overall execution statistics, operator level execution statistics along with the results. This - has a performance overhead compared to the other modes. It is not + has a performance overhead compared to the other modes. It isn't recommended to use this mode for production traffic. - >- This mode returns the overall (but not operator-level) execution @@ -3111,22 +3309,23 @@ components: - WITH_PLAN_AND_STATS partitionToken: description: >- - If present, results will be restricted to the specified partition - previously created using PartitionQuery(). There must be an exact + If present, results are restricted to the specified partition + previously created using `PartitionQuery`. There must be an exact match for the values of fields common to this message and the - PartitionQueryRequest message used to create this partition_token. + `PartitionQueryRequest` message used to create this + `partition_token`. type: string format: byte seqno: description: >- A per-transaction sequence number used to identify this request. This field makes each request idempotent such that if the request is - received multiple times, at most one will succeed. The sequence - number must be monotonically increasing within the transaction. If a + received multiple times, at most one succeeds. The sequence number + must be monotonically increasing within the transaction. If a request arrives for the first time with an out-of-order sequence - number, the transaction may be aborted. Replays of previously - handled requests will yield the same response as the first - execution. Required for DML statements. Ignored for queries. + number, the transaction can be aborted. Replays of previously + handled requests yield the same response as the first execution. + Required for DML statements. Ignored for queries. type: string format: int64 queryOptions: @@ -3142,8 +3341,20 @@ components: description: >- If this is for a partitioned query and this field is set to `true`, the request is executed with Spanner Data Boost independent compute - resources. If the field is set to `true` but the request does not - set `partition_token`, the API returns an `INVALID_ARGUMENT` error. + resources. If the field is set to `true` but the request doesn't set + `partition_token`, the API returns an `INVALID_ARGUMENT` error. + type: boolean + lastStatement: + description: >- + Optional. If set to `true`, this statement marks the end of the + transaction. After this statement executes, you must commit or abort + the transaction. Attempts to execute any other requests against this + transaction (including reads and queries) are rejected. For DML + statements, setting this option might cause some error reporting to + be deferred until commit time (for example, validation of unique + constraints). Given this, successful execution of a DML statement + shouldn't be assumed until a subsequent `Commit` call completes + successfully. type: boolean TransactionSelector: id: TransactionSelector @@ -3171,217 +3382,7 @@ components: $ref: '#/components/schemas/TransactionOptions' TransactionOptions: id: TransactionOptions - description: >- - Transactions: Each session can have at most one active transaction at a - time (note that standalone reads and queries use a transaction - internally and do count towards the one transaction limit). After the - active transaction is completed, the session can immediately be re-used - for the next transaction. It is not necessary to create a new session - for each transaction. Transaction modes: Cloud Spanner supports three - transaction modes: 1. Locking read-write. This type of transaction is - the only way to write data into Cloud Spanner. These transactions rely - on pessimistic locking and, if necessary, two-phase commit. Locking - read-write transactions may abort, requiring the application to retry. - 2. Snapshot read-only. Snapshot read-only transactions provide - guaranteed consistency across several reads, but do not allow writes. - Snapshot read-only transactions can be configured to read at timestamps - in the past, or configured to perform a strong read (where Spanner will - select a timestamp such that the read is guaranteed to see the effects - of all transactions that have committed before the start of the read). - Snapshot read-only transactions do not need to be committed. Queries on - change streams must be performed with the snapshot read-only transaction - mode, specifying a strong read. See TransactionOptions.ReadOnly.strong - for more details. 3. Partitioned DML. This type of transaction is used - to execute a single Partitioned DML statement. Partitioned DML - partitions the key space and runs the DML statement over each partition - in parallel using separate, internal transactions that commit - independently. Partitioned DML transactions do not need to be committed. - For transactions that only read, snapshot read-only transactions provide - simpler semantics and are almost always faster. In particular, read-only - transactions do not take locks, so they do not conflict with read-write - transactions. As a consequence of not taking locks, they also do not - abort, so retry loops are not needed. Transactions may only read-write - data in a single database. They may, however, read-write data in - different tables within that database. Locking read-write transactions: - Locking transactions may be used to atomically read-modify-write data - anywhere in a database. This type of transaction is externally - consistent. Clients should attempt to minimize the amount of time a - transaction is active. Faster transactions commit with higher - probability and cause less contention. Cloud Spanner attempts to keep - read locks active as long as the transaction continues to do reads, and - the transaction has not been terminated by Commit or Rollback. Long - periods of inactivity at the client may cause Cloud Spanner to release a - transaction's locks and abort it. Conceptually, a read-write transaction - consists of zero or more reads or SQL statements followed by Commit. At - any time before Commit, the client can send a Rollback request to abort - the transaction. Semantics: Cloud Spanner can commit the transaction if - all read locks it acquired are still valid at commit time, and it is - able to acquire write locks for all writes. Cloud Spanner can abort the - transaction for any reason. If a commit attempt returns `ABORTED`, Cloud - Spanner guarantees that the transaction has not modified any user data - in Cloud Spanner. Unless the transaction commits, Cloud Spanner makes no - guarantees about how long the transaction's locks were held for. It is - an error to use Cloud Spanner locks for any sort of mutual exclusion - other than between Cloud Spanner transactions themselves. Retrying - aborted transactions: When a transaction aborts, the application can - choose to retry the whole transaction again. To maximize the chances of - successfully committing the retry, the client should execute the retry - in the same session as the original attempt. The original session's lock - priority increases with each consecutive abort, meaning that each - attempt has a slightly better chance of success than the previous. Note - that the lock priority is preserved per session (not per transaction). - Lock priority is set by the first read or write in the first attempt of - a read-write transaction. If the application starts a new session to - retry the whole transaction, the transaction loses its original lock - priority. Moreover, the lock priority is only preserved if the - transaction fails with an `ABORTED` error. Under some circumstances (for - example, many transactions attempting to modify the same row(s)), a - transaction can abort many times in a short period before successfully - committing. Thus, it is not a good idea to cap the number of retries a - transaction can attempt; instead, it is better to limit the total amount - of time spent retrying. Idle transactions: A transaction is considered - idle if it has no outstanding reads or SQL queries and has not started a - read or SQL query within the last 10 seconds. Idle transactions can be - aborted by Cloud Spanner so that they don't hold on to locks - indefinitely. If an idle transaction is aborted, the commit will fail - with error `ABORTED`. If this behavior is undesirable, periodically - executing a simple SQL query in the transaction (for example, `SELECT - 1`) prevents the transaction from becoming idle. Snapshot read-only - transactions: Snapshot read-only transactions provides a simpler method - than locking read-write transactions for doing several consistent reads. - However, this type of transaction does not support writes. Snapshot - transactions do not take locks. Instead, they work by choosing a Cloud - Spanner timestamp, then executing all reads at that timestamp. Since - they do not acquire locks, they do not block concurrent read-write - transactions. Unlike locking read-write transactions, snapshot read-only - transactions never abort. They can fail if the chosen read timestamp is - garbage collected; however, the default garbage collection policy is - generous enough that most applications do not need to worry about this - in practice. Snapshot read-only transactions do not need to call Commit - or Rollback (and in fact are not permitted to do so). To execute a - snapshot transaction, the client specifies a timestamp bound, which - tells Cloud Spanner how to choose a read timestamp. The types of - timestamp bound are: - Strong (the default). - Bounded staleness. - - Exact staleness. If the Cloud Spanner database to be read is - geographically distributed, stale read-only transactions can execute - more quickly than strong or read-write transactions, because they are - able to execute far from the leader replica. Each type of timestamp - bound is discussed in detail below. Strong: Strong reads are guaranteed - to see the effects of all transactions that have committed before the - start of the read. Furthermore, all rows yielded by a single read are - consistent with each other -- if any part of the read observes a - transaction, all parts of the read see the transaction. Strong reads are - not repeatable: two consecutive strong read-only transactions might - return inconsistent results if there are concurrent writes. If - consistency across reads is required, the reads should be executed - within a transaction or at an exact read timestamp. Queries on change - streams (see below for more details) must also specify the strong read - timestamp bound. See TransactionOptions.ReadOnly.strong. Exact - staleness: These timestamp bounds execute reads at a user-specified - timestamp. Reads at a timestamp are guaranteed to see a consistent - prefix of the global transaction history: they observe modifications - done by all transactions with a commit timestamp less than or equal to - the read timestamp, and observe none of the modifications done by - transactions with a larger commit timestamp. They will block until all - conflicting transactions that may be assigned commit timestamps <= the - read timestamp have finished. The timestamp can either be expressed as - an absolute Cloud Spanner commit timestamp or a staleness relative to - the current time. These modes do not require a "negotiation phase" to - pick a timestamp. As a result, they execute slightly faster than the - equivalent boundedly stale concurrency modes. On the other hand, - boundedly stale reads usually return fresher results. See - TransactionOptions.ReadOnly.read_timestamp and - TransactionOptions.ReadOnly.exact_staleness. Bounded staleness: Bounded - staleness modes allow Cloud Spanner to pick the read timestamp, subject - to a user-provided staleness bound. Cloud Spanner chooses the newest - timestamp within the staleness bound that allows execution of the reads - at the closest available replica without blocking. All rows yielded are - consistent with each other -- if any part of the read observes a - transaction, all parts of the read see the transaction. Boundedly stale - reads are not repeatable: two stale reads, even if they use the same - staleness bound, can execute at different timestamps and thus return - inconsistent results. Boundedly stale reads execute in two phases: the - first phase negotiates a timestamp among all replicas needed to serve - the read. In the second phase, reads are executed at the negotiated - timestamp. As a result of the two phase execution, bounded staleness - reads are usually a little slower than comparable exact staleness reads. - However, they are typically able to return fresher results, and are more - likely to execute at the closest replica. Because the timestamp - negotiation requires up-front knowledge of which rows will be read, it - can only be used with single-use read-only transactions. See - TransactionOptions.ReadOnly.max_staleness and - TransactionOptions.ReadOnly.min_read_timestamp. Old read timestamps and - garbage collection: Cloud Spanner continuously garbage collects deleted - and overwritten data in the background to reclaim storage space. This - process is known as "version GC". By default, version GC reclaims - versions after they are one hour old. Because of this, Cloud Spanner - cannot perform reads at read timestamps more than one hour in the past. - This restriction also applies to in-progress reads and/or SQL queries - whose timestamp become too old while executing. Reads and SQL queries - with too-old read timestamps fail with the error `FAILED_PRECONDITION`. - You can configure and extend the `VERSION_RETENTION_PERIOD` of a - database up to a period as long as one week, which allows Cloud Spanner - to perform reads up to one week in the past. Querying change Streams: A - Change Stream is a schema object that can be configured to watch data - changes on the entire database, a set of tables, or a set of columns in - a database. When a change stream is created, Spanner automatically - defines a corresponding SQL Table-Valued Function (TVF) that can be used - to query the change records in the associated change stream using the - ExecuteStreamingSql API. The name of the TVF for a change stream is - generated from the name of the change stream: READ_. All queries on - change stream TVFs must be executed using the ExecuteStreamingSql API - with a single-use read-only transaction with a strong read-only - timestamp_bound. The change stream TVF allows users to specify the - start_timestamp and end_timestamp for the time range of interest. All - change records within the retention period is accessible using the - strong read-only timestamp_bound. All other TransactionOptions are - invalid for change stream queries. In addition, if - TransactionOptions.read_only.return_read_timestamp is set to true, a - special value of 2^63 - 2 will be returned in the Transaction message - that describes the transaction, instead of a valid read timestamp. This - special value should be discarded and not used for any subsequent - queries. Please see https://cloud.google.com/spanner/docs/change-streams - for more details on how to query the change stream TVFs. Partitioned DML - transactions: Partitioned DML transactions are used to execute DML - statements with a different execution strategy that provides different, - and often better, scalability properties for large, table-wide - operations than DML in a ReadWrite transaction. Smaller scoped - statements, such as an OLTP workload, should prefer using ReadWrite - transactions. Partitioned DML partitions the keyspace and runs the DML - statement on each partition in separate, internal transactions. These - transactions commit automatically when complete, and run independently - from one another. To reduce lock contention, this execution strategy - only acquires read locks on rows that match the WHERE clause of the - statement. Additionally, the smaller per-partition transactions hold - locks for less time. That said, Partitioned DML is not a drop-in - replacement for standard DML used in ReadWrite transactions. - The DML - statement must be fully-partitionable. Specifically, the statement must - be expressible as the union of many statements which each access only a - single row of the table. - The statement is not applied atomically to - all rows of the table. Rather, the statement is applied atomically to - partitions of the table, in independent transactions. Secondary index - rows are updated atomically with the base table rows. - Partitioned DML - does not guarantee exactly-once execution semantics against a partition. - The statement is applied at least once to each partition. It is strongly - recommended that the DML statement should be idempotent to avoid - unexpected results. For instance, it is potentially dangerous to run a - statement such as `UPDATE table SET column = column + 1` as it could be - run multiple times against some rows. - The partitions are committed - automatically - there is no support for Commit or Rollback. If the call - returns an error, or if the client issuing the ExecuteSql call dies, it - is possible that some rows had the statement executed on them - successfully. It is also possible that statement was never executed - against other rows. - Partitioned DML transactions may only contain the - execution of a single DML statement via ExecuteSql or - ExecuteStreamingSql. - If any error is encountered during the execution - of the partitioned DML operation (for instance, a UNIQUE INDEX - violation, division by zero, or a value that cannot be stored due to - schema constraints), then the operation is stopped at that point and an - error is returned. It is possible that at this point, some partitions - have been committed (or even committed multiple times), and other - partitions have not been run at all. Given the above, Partitioned DML is - good fit for large, database-wide, operations that are idempotent, such - as deleting old rows from a very large table. + description: Options to use for transactions. type: object properties: readWrite: @@ -3400,26 +3401,56 @@ components: $ref: '#/components/schemas/PartitionedDml' readOnly: description: >- - Transaction will not write. Authorization to begin a read-only + Transaction does not write. Authorization to begin a read-only transaction requires `spanner.databases.beginReadOnlyTransaction` permission on the `session` resource. $ref: '#/components/schemas/ReadOnly' excludeTxnFromChangeStreams: description: >- - When `exclude_txn_from_change_streams` is set to `true`: * - Modifications from this transaction will not be recorded in change - streams with DDL option `allow_txn_exclusion=true` that are tracking - columns modified by these transactions. * Modifications from this - transaction will be recorded in change streams with DDL option - `allow_txn_exclusion=false or not set` that are tracking columns - modified by these transactions. When + When `exclude_txn_from_change_streams` is set to `true`, it prevents + read or write transactions from being tracked in change streams. * + If the DDL option `allow_txn_exclusion` is set to `true`, then the + updates made within this transaction aren't recorded in the change + stream. * If you don't set the DDL option `allow_txn_exclusion` or + if it's set to `false`, then the updates made within this + transaction are recorded in the change stream. When `exclude_txn_from_change_streams` is set to `false` or not set, - Modifications from this transaction will be recorded in all change + modifications from this transaction are recorded in all change streams that are tracking columns modified by these transactions. - `exclude_txn_from_change_streams` may only be specified for - read-write or partitioned-dml transactions, otherwise the API will - return an `INVALID_ARGUMENT` error. + The `exclude_txn_from_change_streams` option can only be specified + for read-write or partitioned DML transactions, otherwise the API + returns an `INVALID_ARGUMENT` error. type: boolean + isolationLevel: + description: Isolation level for the transaction. + type: string + enumDescriptions: + - >- + Default value. If the value is not specified, the `SERIALIZABLE` + isolation level is used. + - >- + All transactions appear as if they executed in a serial order, + even if some of the reads, writes, and other operations of + distinct transactions actually occurred in parallel. Spanner + assigns commit timestamps that reflect the order of committed + transactions to implement this property. Spanner offers a stronger + guarantee than serializability called external consistency. For + further details, please refer to + https://cloud.google.com/spanner/docs/true-time-external-consistency#serializability. + - >- + All reads performed during the transaction observe a consistent + snapshot of the database, and the transaction is only successfully + committed in the absence of conflicts between its updates and any + concurrent updates that have occurred since that snapshot. + Consequently, in contrast to `SERIALIZABLE` transactions, only + write-write conflicts are detected in snapshot transactions. This + isolation level does not support Read-only and Partitioned DML + transactions. When `REPEATABLE_READ` is specified on a read-write + transaction, the locking semantics default to `OPTIMISTIC`. + enum: + - ISOLATION_LEVEL_UNSPECIFIED + - SERIALIZABLE + - REPEATABLE_READ ReadWrite: id: ReadWrite description: >- @@ -3432,16 +3463,25 @@ components: type: string enumDescriptions: - >- - Default value. If the value is not specified, the pessimistic read - lock is used. + Default value. * If isolation level is REPEATABLE_READ, then it is + an error to specify `read_lock_mode`. Locking semantics default to + `OPTIMISTIC`. No validation checks are done for reads, except to + validate that the data that was served at the snapshot time is + unchanged at commit time in the following cases: 1. reads done as + part of queries that use `SELECT FOR UPDATE` 2. reads done as part + of statements with a `LOCK_SCANNED_RANGES` hint 3. reads done as + part of DML statements * At all other isolation levels, if + `read_lock_mode` is the default value, then pessimistic read locks + are used. - >- Pessimistic lock mode. Read locks are acquired immediately on - read. + read. Semantics described only applies to SERIALIZABLE isolation. - >- Optimistic lock mode. Locks for reads within the transaction are not acquired on read. Instead the locks are acquired on a commit to validate that read/queried data has not changed since the - transaction started. + transaction started. Semantics described only applies to + SERIALIZABLE isolation. enum: - READ_LOCK_MODE_UNSPECIFIED - PESSIMISTIC @@ -3497,7 +3537,7 @@ components: Executes all reads at the given timestamp. Unlike other modes, reads at a specific timestamp are repeatable; the same read at the same timestamp always returns the same data. If the timestamp is in the - future, the read will block until the specified timestamp, modulo + future, the read is blocked until the specified timestamp, modulo the read's deadline. Useful for large scale consistent reads such as mapreduces, or for coordinating many reads against a consistent snapshot of the data. A timestamp in RFC3339 UTC \"Zulu\" format, @@ -3634,10 +3674,16 @@ components: values of this type should be treated as PostgreSQL JSONB values. Currently this annotation is always needed for JSON when a client interacts with PostgreSQL-enabled Spanner databases. + - >- + PostgreSQL compatible OID type. This annotation can be used by a + client interacting with PostgreSQL-enabled Spanner database to + specify that a value should be treated using the semantics of the + OID type. enum: - TYPE_ANNOTATION_CODE_UNSPECIFIED - PG_NUMERIC - PG_JSONB + - PG_OID protoTypeFqn: description: >- If code == PROTO or code == ENUM, then `proto_type_fqn` is the fully @@ -3693,9 +3739,9 @@ components: supported optimizer versions) overrides the default optimizer version for query execution. The list of supported optimizer versions can be queried from - SPANNER_SYS.SUPPORTED_OPTIMIZER_VERSIONS. Executing a SQL statement - with an invalid optimizer version fails with an `INVALID_ARGUMENT` - error. See + `SPANNER_SYS.SUPPORTED_OPTIMIZER_VERSIONS`. Executing a SQL + statement with an invalid optimizer version fails with an + `INVALID_ARGUMENT` error. See https://cloud.google.com/spanner/docs/query-optimizer/manage-query-optimizer for more information on managing the query optimizer. The `optimizer_version` statement hint has precedence over this setting. @@ -3708,13 +3754,14 @@ components: instructs Cloud Spanner to use the latest generated statistics package. If not specified, Cloud Spanner uses the statistics package set at the database level options, or the latest package if the - database option is not set. The statistics package requested by the + database option isn't set. The statistics package requested by the query has to be exempt from garbage collection. This can be achieved - with the following DDL statement: ``` ALTER STATISTICS SET OPTIONS - (allow_gc=false) ``` The list of available statistics packages can - be queried from `INFORMATION_SCHEMA.SPANNER_STATISTICS`. Executing a - SQL statement with an invalid optimizer statistics package or with a - statistics package that allows garbage collection fails with an + with the following DDL statement: ```sql ALTER STATISTICS SET + OPTIONS (allow_gc=false) ``` The list of available statistics + packages can be queried from + `INFORMATION_SCHEMA.SPANNER_STATISTICS`. Executing a SQL statement + with an invalid optimizer statistics package or with a statistics + package that allows garbage collection fails with an `INVALID_ARGUMENT` error. type: string RequestOptions: @@ -3738,55 +3785,55 @@ components: requestTag: description: >- A per-request tag which can be applied to queries or reads, used for - statistics collection. Both request_tag and transaction_tag can be - specified for a read or query that belongs to a transaction. This - field is ignored for requests where it's not applicable (e.g. - CommitRequest). Legal characters for `request_tag` values are all - printable characters (ASCII 32 - 126) and the length of a + statistics collection. Both `request_tag` and `transaction_tag` can + be specified for a read or query that belongs to a transaction. This + field is ignored for requests where it's not applicable (for + example, `CommitRequest`). Legal characters for `request_tag` values + are all printable characters (ASCII 32 - 126) and the length of a request_tag is limited to 50 characters. Values that exceed this - limit are truncated. Any leading underscore (_) characters will be + limit are truncated. Any leading underscore (_) characters are removed from the string. type: string transactionTag: description: >- A tag used for statistics collection about this transaction. Both - request_tag and transaction_tag can be specified for a read or query - that belongs to a transaction. The value of transaction_tag should - be the same for all requests belonging to the same transaction. If - this request doesn't belong to any transaction, transaction_tag will - be ignored. Legal characters for `transaction_tag` values are all - printable characters (ASCII 32 - 126) and the length of a - transaction_tag is limited to 50 characters. Values that exceed this - limit are truncated. Any leading underscore (_) characters will be - removed from the string. + `request_tag` and `transaction_tag` can be specified for a read or + query that belongs to a transaction. The value of transaction_tag + should be the same for all requests belonging to the same + transaction. If this request doesn't belong to any transaction, + `transaction_tag` is ignored. Legal characters for `transaction_tag` + values are all printable characters (ASCII 32 - 126) and the length + of a `transaction_tag` is limited to 50 characters. Values that + exceed this limit are truncated. Any leading underscore (_) + characters are removed from the string. type: string DirectedReadOptions: id: DirectedReadOptions description: >- - The DirectedReadOptions can be used to indicate which replicas or + The `DirectedReadOptions` can be used to indicate which replicas or regions should be used for non-transactional reads or queries. - DirectedReadOptions may only be specified for a read-only transaction, - otherwise the API will return an `INVALID_ARGUMENT` error. + `DirectedReadOptions` can only be specified for a read-only transaction, + otherwise the API returns an `INVALID_ARGUMENT` error. type: object properties: includeReplicas: description: >- - Include_replicas indicates the order of replicas (as they appear in - this list) to process the request. If auto_failover_disabled is set - to true and all replicas are exhausted without finding a healthy - replica, Spanner will wait for a replica in the list to become - available, requests may fail due to `DEADLINE_EXCEEDED` errors. + `Include_replicas` indicates the order of replicas (as they appear + in this list) to process the request. If `auto_failover_disabled` is + set to `true` and all replicas are exhausted without finding a + healthy replica, Spanner waits for a replica in the list to become + available, requests might fail due to `DEADLINE_EXCEEDED` errors. $ref: '#/components/schemas/IncludeReplicas' excludeReplicas: description: >- - Exclude_replicas indicates that specified replicas should be - excluded from serving requests. Spanner will not route requests to + `Exclude_replicas` indicates that specified replicas should be + excluded from serving requests. Spanner doesn't route requests to the replicas in this list. $ref: '#/components/schemas/ExcludeReplicas' IncludeReplicas: id: IncludeReplicas description: >- - An IncludeReplicas contains a repeated set of ReplicaSelection which + An `IncludeReplicas` contains a repeated set of `ReplicaSelection` which indicates the order in which replicas should be considered. type: object properties: @@ -3797,8 +3844,8 @@ components: $ref: '#/components/schemas/ReplicaSelection' autoFailoverDisabled: description: >- - If true, Spanner will not route requests to a replica outside the - include_replicas list when all of the specified replicas are + If `true`, Spanner doesn't route requests to a replica outside the + <`include_replicas` list when all of the specified replicas are unavailable or unhealthy. Default value is `false`. type: boolean ReplicaSelection: @@ -3809,15 +3856,17 @@ components: must be one of the regions within the multi-region configuration of your database. * `type` - The type of the replica. Some examples of using replica_selectors are: * `location:us-east1` --> The "us-east1" - replica(s) of any available type will be used to process the request. * - `type:READ_ONLY` --> The "READ_ONLY" type replica(s) in nearest - available location will be used to process the request. * - `location:us-east1 type:READ_ONLY` --> The "READ_ONLY" type replica(s) - in location "us-east1" will be used to process the request. + replica(s) of any available type is used to process the request. * + `type:READ_ONLY` --> The "READ_ONLY" type replica(s) in the nearest + available location are used to process the request. * `location:us-east1 + type:READ_ONLY` --> The "READ_ONLY" type replica(s) in location + "us-east1" is used to process the request. type: object properties: location: - description: The location or region of the serving requests, e.g. "us-east1". + description: >- + The location or region of the serving requests, for example, + "us-east1". type: string type: description: The type of replica. @@ -3868,15 +3917,15 @@ components: ExecuteSqlRequest.query_mode. DML statements always produce stats containing the number of rows modified, unless executed using the ExecuteSqlRequest.QueryMode.PLAN ExecuteSqlRequest.query_mode. Other - fields may or may not be populated, based on the + fields might or might not be populated, based on the ExecuteSqlRequest.query_mode. $ref: '#/components/schemas/ResultSetStats' precommitToken: description: >- - Optional. A precommit token will be included if the read-write - transaction is on a multiplexed session. The precommit token with - the highest sequence number from this transaction attempt should be - passed to the Commit request for this transaction. + Optional. A precommit token is included if the read-write + transaction is on a multiplexed session. Pass the precommit token + with the highest sequence number from this transaction attempt to + the Commit request for this transaction. $ref: '#/components/schemas/MultiplexedSessionPrecommitToken' ResultSetMetadata: id: ResultSetMetadata @@ -3930,20 +3979,20 @@ components: format: google-datetime precommitToken: description: >- - A precommit token will be included in the response of a - BeginTransaction request if the read-write transaction is on a - multiplexed session and a mutation_key was specified in the - BeginTransaction. The precommit token with the highest sequence - number from this transaction attempt should be passed to the Commit - request for this transaction. + A precommit token is included in the response of a BeginTransaction + request if the read-write transaction is on a multiplexed session + and a mutation_key was specified in the BeginTransaction. The + precommit token with the highest sequence number from this + transaction attempt should be passed to the Commit request for this + transaction. $ref: '#/components/schemas/MultiplexedSessionPrecommitToken' MultiplexedSessionPrecommitToken: id: MultiplexedSessionPrecommitToken description: >- When a read-write transaction is executed on a multiplexed session, this - precommit token is sent back to the client as a part of the - [Transaction] message in the BeginTransaction response and also as a - part of the [ResultSet] and [PartialResultSet] responses. + precommit token is sent back to the client as a part of the Transaction + message in the BeginTransaction response and also as a part of the + ResultSet and PartialResultSet responses. type: object properties: precommitToken: @@ -3981,7 +4030,7 @@ components: format: int64 rowCountLowerBound: description: >- - Partitioned DML does not offer exactly-once semantics, so it returns + Partitioned DML doesn't offer exactly-once semantics, so it returns a lower bound of the rows modified. type: string format: int64 @@ -4000,7 +4049,7 @@ components: $ref: '#/components/schemas/PlanNode' queryAdvice: description: >- - Optional. The advices/recommendations for a query. Currently this + Optional. The advise/recommendations for a query. Currently this field will be serving index recommendations for a query. $ref: '#/components/schemas/QueryAdvisorResult' PlanNode: @@ -4170,31 +4219,31 @@ components: rows and/or large values. Every N complete values defines a row, where N is equal to the number of entries in metadata.row_type.fields. Most values are encoded based on type as - described here. It is possible that the last value in values is + described here. It's possible that the last value in values is "chunked", meaning that the rest of the value is sent in subsequent `PartialResultSet`(s). This is denoted by the chunked_value field. Two or more chunked values can be merged to form a complete value as - follows: * `bool/number/null`: cannot be chunked * `string`: + follows: * `bool/number/null`: can't be chunked * `string`: concatenate the strings * `list`: concatenate the lists. If the last element in a list is a `string`, `list`, or `object`, merge it with the first element in the next list by applying these rules recursively. * `object`: concatenate the (field name, field value) pairs. If a field name is duplicated, then apply these rules - recursively to merge the field values. Some examples of merging: # - Strings are concatenated. "foo", "bar" => "foobar" # Lists of - non-strings are concatenated. [2, 3], [4] => [2, 3, 4] # Lists are - concatenated, but the last and first elements are merged # because - they are strings. ["a", "b"], ["c", "d"] => ["a", "bc", "d"] # Lists - are concatenated, but the last and first elements are merged # - because they are lists. Recursively, the last and first elements # - of the inner lists are merged because they are strings. ["a", ["b", - "c"]], [["d"], "e"] => ["a", ["b", "cd"], "e"] # Non-overlapping - object fields are combined. {"a": "1"}, {"b": "2"} => {"a": "1", - "b": 2"} # Overlapping object fields are merged. {"a": "1"}, {"a": - "2"} => {"a": "12"} # Examples of merging objects containing lists - of strings. {"a": ["1"]}, {"a": ["2"]} => {"a": ["12"]} For a more - complete example, suppose a streaming SQL query is yielding a result - set whose rows contain a single string field. The following + recursively to merge the field values. Some examples of merging: + Strings are concatenated. "foo", "bar" => "foobar" Lists of + non-strings are concatenated. [2, 3], [4] => [2, 3, 4] Lists are + concatenated, but the last and first elements are merged because + they are strings. ["a", "b"], ["c", "d"] => ["a", "bc", "d"] Lists + are concatenated, but the last and first elements are merged because + they are lists. Recursively, the last and first elements of the + inner lists are merged because they are strings. ["a", ["b", "c"]], + [["d"], "e"] => ["a", ["b", "cd"], "e"] Non-overlapping object + fields are combined. {"a": "1"}, {"b": "2"} => {"a": "1", "b": 2"} + Overlapping object fields are merged. {"a": "1"}, {"a": "2"} => + {"a": "12"} Examples of merging objects containing lists of strings. + {"a": ["1"]}, {"a": ["2"]} => {"a": ["12"]} For a more complete + example, suppose a streaming SQL query is yielding a result set + whose rows contain a single string field. The following `PartialResultSet`s might be yielded: { "metadata": { ... } "values": ["Hello", "W"] "chunked_value": true "resume_token": "Af65..." } { "values": ["orl"] "chunked_value": true } { "values": @@ -4204,8 +4253,8 @@ components: "orl" + "d"`. Not all `PartialResultSet`s contain a `resume_token`. Execution can only be resumed from a previously yielded `resume_token`. For the above sequence of `PartialResultSet`s, - resuming the query with `"resume_token": "Af65..."` will yield - results from the `PartialResultSet` with value `["orl"]`. + resuming the query with `"resume_token": "Af65..."` yields results + from the `PartialResultSet` with value "orl". type: array items: type: any @@ -4229,16 +4278,22 @@ components: Query plan and execution statistics for the statement that produced this streaming result set. These can be requested by setting ExecuteSqlRequest.query_mode and are sent only once with the last - response in the stream. This field will also be present in the last + response in the stream. This field is also present in the last response for DML statements. $ref: '#/components/schemas/ResultSetStats' precommitToken: description: >- - Optional. A precommit token will be included if the read-write - transaction is on a multiplexed session. The precommit token with - the highest sequence number from this transaction attempt should be - passed to the Commit request for this transaction. + Optional. A precommit token is included if the read-write + transaction has multiplexed sessions enabled. Pass the precommit + token with the highest sequence number from this transaction attempt + to the Commit request for this transaction. $ref: '#/components/schemas/MultiplexedSessionPrecommitToken' + last: + description: >- + Optional. Indicates whether this is the last `PartialResultSet` in + the stream. The server might optionally set this field. Clients + shouldn't rely on this field being set in all cases. + type: boolean ExecuteBatchDmlRequest: id: ExecuteBatchDmlRequest description: The request for ExecuteBatchDml. @@ -4266,17 +4321,28 @@ components: description: >- Required. A per-transaction sequence number used to identify this request. This field makes each request idempotent such that if the - request is received multiple times, at most one will succeed. The + request is received multiple times, at most one succeeds. The sequence number must be monotonically increasing within the transaction. If a request arrives for the first time with an - out-of-order sequence number, the transaction may be aborted. - Replays of previously handled requests will yield the same response - as the first execution. + out-of-order sequence number, the transaction might be aborted. + Replays of previously handled requests yield the same response as + the first execution. type: string format: int64 requestOptions: description: Common options for this request. $ref: '#/components/schemas/RequestOptions' + lastStatements: + description: >- + Optional. If set to `true`, this request marks the end of the + transaction. After these statements execute, you must commit or + abort the transaction. Attempts to execute any other requests + against this transaction (including reads and queries) are rejected. + Setting this option might cause some error reporting to be deferred + until commit time (for example, validation of unique constraints). + Given this, successful execution of statements shouldn't be assumed + until a subsequent `Commit` call completes successfully. + type: boolean Statement: id: Statement description: A single DML statement. @@ -4293,15 +4359,15 @@ components: Parameter names can contain letters, numbers, and underscores. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `"WHERE - id > @msg_id AND id < @msg_id + 100"` It is an error to execute a - SQL statement with unbound parameters. + id > @msg_id AND id < @msg_id + 100"` It's an error to execute a SQL + statement with unbound parameters. type: object additionalProperties: type: any description: Properties of the object. paramTypes: description: >- - It is not always possible for Cloud Spanner to infer the right SQL + It isn't always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type `BYTES` and values of type `STRING` both appear in params as JSON strings. In these cases, `param_types` can be used to specify the exact SQL type @@ -4349,10 +4415,10 @@ components: $ref: '#/components/schemas/Status' precommitToken: description: >- - Optional. A precommit token will be included if the read-write - transaction is on a multiplexed session. The precommit token with - the highest sequence number from this transaction attempt should be - passed to the Commit request for this transaction. + Optional. A precommit token is included if the read-write + transaction is on a multiplexed session. Pass the precommit token + with the highest sequence number from this transaction attempt + should be passed to the Commit request for this transaction. $ref: '#/components/schemas/MultiplexedSessionPrecommitToken' ReadRequest: id: ReadRequest @@ -4387,16 +4453,16 @@ components: index is present. If index is present, then key_set instead names index keys in index. If the partition_token field is empty, rows are yielded in table primary key order (if index is empty) or index key - order (if index is non-empty). If the partition_token field is not - empty, rows will be yielded in an unspecified order. It is not an - error for the `key_set` to name rows that do not exist in the - database. Read yields nothing for nonexistent rows. + order (if index is non-empty). If the partition_token field isn't + empty, rows are yielded in an unspecified order. It isn't an error + for the `key_set` to name rows that don't exist in the database. + Read yields nothing for nonexistent rows. $ref: '#/components/schemas/KeySet' limit: description: >- If greater than zero, only the first `limit` rows are yielded. If - `limit` is zero, the default is no limit. A limit cannot be - specified if `partition_token` is set. + `limit` is zero, the default is no limit. A limit can't be specified + if `partition_token` is set. type: string format: int64 resumeToken: @@ -4410,8 +4476,8 @@ components: format: byte partitionToken: description: >- - If present, results will be restricted to the specified partition - previously created using PartitionRead(). There must be an exact + If present, results are restricted to the specified partition + previously created using `PartitionRead`. There must be an exact match for the values of fields common to this message and the PartitionReadRequest message used to create this partition_token. type: string @@ -4426,27 +4492,26 @@ components: description: >- If this is for a partitioned read and this field is set to `true`, the request is executed with Spanner Data Boost independent compute - resources. If the field is set to `true` but the request does not - set `partition_token`, the API returns an `INVALID_ARGUMENT` error. + resources. If the field is set to `true` but the request doesn't set + `partition_token`, the API returns an `INVALID_ARGUMENT` error. type: boolean orderBy: description: >- - Optional. Order for the returned rows. By default, Spanner will - return result rows in primary key order except for PartitionRead - requests. For applications that do not require rows to be returned - in primary key (`ORDER_BY_PRIMARY_KEY`) order, setting - `ORDER_BY_NO_ORDER` option allows Spanner to optimize row retrieval, - resulting in lower latencies in certain cases (e.g. bulk point - lookups). + Optional. Order for the returned rows. By default, Spanner returns + result rows in primary key order except for PartitionRead requests. + For applications that don't require rows to be returned in primary + key (`ORDER_BY_PRIMARY_KEY`) order, setting `ORDER_BY_NO_ORDER` + option allows Spanner to optimize row retrieval, resulting in lower + latencies in certain cases (for example, bulk point lookups). type: string enumDescriptions: - >- - Default value. ORDER_BY_UNSPECIFIED is equivalent to - ORDER_BY_PRIMARY_KEY. + Default value. `ORDER_BY_UNSPECIFIED` is equivalent to + `ORDER_BY_PRIMARY_KEY`. - >- Read rows are returned in primary key order. In the event that this option is used in conjunction with the `partition_token` - field, the API will return an `INVALID_ARGUMENT` error. + field, the API returns an `INVALID_ARGUMENT` error. - Read rows are returned in any order. enum: - ORDER_BY_UNSPECIFIED @@ -4459,8 +4524,8 @@ components: type: string enumDescriptions: - >- - Default value. LOCK_HINT_UNSPECIFIED is equivalent to - LOCK_HINT_SHARED. + Default value. `LOCK_HINT_UNSPECIFIED` is equivalent to + `LOCK_HINT_SHARED`. - >- Acquire shared locks. By default when you perform a read as part of a read-write transaction, Spanner acquires shared read locks, @@ -4486,8 +4551,8 @@ components: multiple transactions try to act on the same data, they automatically get serialized. Each transaction waits its turn to acquire the lock and avoids getting into deadlock situations. - Because the exclusive lock hint is just a hint, it should not be - considered equivalent to a mutex. In other words, you should not + Because the exclusive lock hint is just a hint, it shouldn't be + considered equivalent to a mutex. In other words, you shouldn't use Spanner exclusive locks as a mutual exclusion mechanism for the execution of code outside of Spanner. **Note:** Request exclusive locks judiciously because they block others from reading @@ -4615,16 +4680,16 @@ components: requestOptions: description: >- Common options for this request. Priority is ignored for this - request. Setting the priority in this request_options struct will - not do anything. To set the priority for a transaction, set it on - the reads and writes that are part of this transaction instead. + request. Setting the priority in this `request_options` struct + doesn't do anything. To set the priority for a transaction, set it + on the reads and writes that are part of this transaction instead. $ref: '#/components/schemas/RequestOptions' mutationKey: description: >- Optional. Required for read-write transactions on a multiplexed - session that commit mutations but do not perform any reads or - queries. Clients should randomly select one of the mutations from - the mutation set and send it as a part of this request. + session that commit mutations but don't perform any reads or + queries. You must randomly select one of the mutations from the + mutation set and send it as a part of this request. $ref: '#/components/schemas/Mutation' Mutation: id: Mutation @@ -4728,9 +4793,9 @@ components: commit of a previously-started transaction, commit with a temporary transaction is non-idempotent. That is, if the `CommitRequest` is sent to Cloud Spanner more than once (for instance, due to retries - in the application, or in the transport library), it is possible - that the mutations are executed more than once. If this is - undesirable, use BeginTransaction and Commit instead. + in the application, or in the transport library), it's possible that + the mutations are executed more than once. If this is undesirable, + use BeginTransaction and Commit instead. $ref: '#/components/schemas/TransactionOptions' mutations: description: >- @@ -4742,13 +4807,13 @@ components: $ref: '#/components/schemas/Mutation' returnCommitStats: description: >- - If `true`, then statistics related to the transaction will be - included in the CommitResponse. Default value is `false`. + If `true`, then statistics related to the transaction is included in + the CommitResponse. Default value is `false`. type: boolean maxCommitDelay: description: >- Optional. The amount of latency this request is configured to incur - in order to improve throughput. If this field is not set, Spanner + in order to improve throughput. If this field isn't set, Spanner assumes requests are relatively latency sensitive and automatically determines an appropriate delay time. You can specify a commit delay value between 0 and 500 ms. @@ -4760,9 +4825,9 @@ components: precommitToken: description: >- Optional. If the read-write transaction was executed on a - multiplexed session, the precommit token with the highest sequence - number received in this transaction attempt, should be included - here. Failing to do so will result in a FailedPrecondition error. + multiplexed session, then you must include the precommit token with + the highest sequence number received in this transaction attempt. + Failing to do so results in a `FailedPrecondition` error. $ref: '#/components/schemas/MultiplexedSessionPrecommitToken' CommitResponse: id: CommitResponse @@ -4775,13 +4840,13 @@ components: format: google-datetime commitStats: description: >- - The statistics about this Commit. Not returned by default. For more - information, see CommitRequest.return_commit_stats. + The statistics about this `Commit`. Not returned by default. For + more information, see CommitRequest.return_commit_stats. $ref: '#/components/schemas/CommitStats' precommitToken: description: >- - If specified, transaction has not committed yet. Clients must retry - the commit with the new precommit token. + If specified, transaction has not committed yet. You must retry the + commit with the new precommit token. $ref: '#/components/schemas/MultiplexedSessionPrecommitToken' CommitStats: id: CommitStats @@ -4816,13 +4881,13 @@ components: properties: transaction: description: >- - Read only snapshot transactions are supported, read/write and single - use transactions are not. + Read-only snapshot transactions are supported, read and write and + single-use transactions are not. $ref: '#/components/schemas/TransactionSelector' sql: description: >- Required. The query request to generate partitions for. The request - fails if the query is not root partitionable. For a query to be root + fails if the query isn't root partitionable. For a query to be root partitionable, it needs to satisfy a few conditions. For example, if the query execution plan contains a distributed union operator, then it must be the first operator in the plan. For more information @@ -4830,7 +4895,7 @@ components: parallel](https://cloud.google.com/spanner/docs/reads#read_data_in_parallel). The query request must not contain DML commands, such as `INSERT`, `UPDATE`, or `DELETE`. Use `ExecuteStreamingSql` with a - PartitionedDml transaction for large, partition-friendly DML + `PartitionedDml` transaction for large, partition-friendly DML operations. type: string params: @@ -4841,15 +4906,15 @@ components: Parameter names can contain letters, numbers, and underscores. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `"WHERE - id > @msg_id AND id < @msg_id + 100"` It is an error to execute a - SQL statement with unbound parameters. + id > @msg_id AND id < @msg_id + 100"` It's an error to execute a SQL + statement with unbound parameters. type: object additionalProperties: type: any description: Properties of the object. paramTypes: description: >- - It is not always possible for Cloud Spanner to infer the right SQL + It isn't always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type `BYTES` and values of type `STRING` both appear in params as JSON strings. In these cases, `param_types` can be used to specify the exact SQL type @@ -4863,26 +4928,26 @@ components: $ref: '#/components/schemas/PartitionOptions' PartitionOptions: id: PartitionOptions - description: Options for a PartitionQueryRequest and PartitionReadRequest. + description: Options for a `PartitionQueryRequest` and `PartitionReadRequest`. type: object properties: partitionSizeBytes: description: >- - **Note:** This hint is currently ignored by PartitionQuery and - PartitionRead requests. The desired data size for each partition + **Note:** This hint is currently ignored by `PartitionQuery` and + `PartitionRead` requests. The desired data size for each partition generated. The default for this option is currently 1 GiB. This is - only a hint. The actual size of each partition may be smaller or + only a hint. The actual size of each partition can be smaller or larger than this size request. type: string format: int64 maxPartitions: description: >- - **Note:** This hint is currently ignored by PartitionQuery and - PartitionRead requests. The desired maximum number of partitions to - return. For example, this may be set to the number of workers + **Note:** This hint is currently ignored by `PartitionQuery` and + `PartitionRead` requests. The desired maximum number of partitions + to return. For example, this might be set to the number of workers available. The default for this option is currently 10,000. The maximum value is currently 200,000. This is only a hint. The actual - number of partitions returned may be smaller or larger than this + number of partitions returned can be smaller or larger than this maximum count request. type: string format: int64 @@ -4906,8 +4971,8 @@ components: properties: partitionToken: description: >- - This token can be passed to Read, StreamingRead, ExecuteSql, or - ExecuteStreamingSql requests to restrict the results to those + This token can be passed to `Read`, `StreamingRead`, `ExecuteSql`, + or `ExecuteStreamingSql` requests to restrict the results to those identified by this partition token. type: string format: byte @@ -4942,8 +5007,8 @@ components: Required. `key_set` identifies the rows to be yielded. `key_set` names the primary keys of the rows in table to be yielded, unless index is present. If index is present, then key_set instead names - index keys in index. It is not an error for the `key_set` to name - rows that do not exist in the database. Read yields nothing for + index keys in index. It isn't an error for the `key_set` to name + rows that don't exist in the database. Read yields nothing for nonexistent rows. $ref: '#/components/schemas/KeySet' partitionOptions: @@ -4964,18 +5029,10 @@ components: $ref: '#/components/schemas/MutationGroup' excludeTxnFromChangeStreams: description: >- - Optional. When `exclude_txn_from_change_streams` is set to `true`: * - Modifications from all transactions in this batch write operation - will not be recorded in change streams with DDL option - `allow_txn_exclusion=true` that are tracking columns modified by - these transactions. * Modifications from all transactions in this - batch write operation will be recorded in change streams with DDL - option `allow_txn_exclusion=false or not set` that are tracking - columns modified by these transactions. When - `exclude_txn_from_change_streams` is set to `false` or not set, - Modifications from all transactions in this batch write operation - will be recorded in all change streams that are tracking columns - modified by these transactions. + Optional. If you don't set the `exclude_txn_from_change_streams` + option or if it's set to `false`, then any change streams monitoring + columns modified by transactions will capture the updates made + within that transaction. type: boolean MutationGroup: id: MutationGroup @@ -5430,61 +5487,488 @@ components: successfully. type: string format: google-datetime - expectedFulfillmentPeriod: - description: The expected fulfillment period of this update operation. + expectedFulfillmentPeriod: + description: The expected fulfillment period of this update operation. + type: string + enumDescriptions: + - Not specified. + - >- + Normal fulfillment period. The operation is expected to complete + within minutes. + - >- + Extended fulfillment period. It can take up to an hour for the + operation to complete. + enum: + - FULFILLMENT_PERIOD_UNSPECIFIED + - FULFILLMENT_PERIOD_NORMAL + - FULFILLMENT_PERIOD_EXTENDED + UpdateInstanceConfigMetadata: + id: UpdateInstanceConfigMetadata + description: Metadata type for the operation returned by UpdateInstanceConfig. + type: object + properties: + instanceConfig: + description: The desired instance configuration after updating. + $ref: '#/components/schemas/InstanceConfig' + progress: + description: The progress of the UpdateInstanceConfig operation. + $ref: '#/components/schemas/InstanceOperationProgress' + cancelTime: + description: The time at which this operation was cancelled. + type: string + format: google-datetime + UpdateInstancePartitionMetadata: + id: UpdateInstancePartitionMetadata + description: Metadata type for the operation returned by UpdateInstancePartition. + type: object + properties: + instancePartition: + description: The desired end state of the update. + $ref: '#/components/schemas/InstancePartition' + startTime: + description: The time at which UpdateInstancePartition request was received. + type: string + format: google-datetime + cancelTime: + description: >- + The time at which this operation was cancelled. If set, this + operation is in the process of undoing itself (which is guaranteed + to succeed) and cannot be cancelled again. + type: string + format: google-datetime + endTime: + description: >- + The time at which this operation failed or was completed + successfully. + type: string + format: google-datetime + ChangeStreamRecord: + id: ChangeStreamRecord + description: >- + Spanner Change Streams enable customers to capture and stream out + changes to their Spanner databases in real-time. A change stream can be + created with option partition_mode='IMMUTABLE_KEY_RANGE' or + partition_mode='MUTABLE_KEY_RANGE'. This message is only used in Change + Streams created with the option partition_mode='MUTABLE_KEY_RANGE'. + Spanner automatically creates a special Table-Valued Function (TVF) + along with each Change Streams. The function provides access to the + change stream's records. The function is named READ_ (where is the name + of the change stream), and it returns a table with only one column + called ChangeRecord. + type: object + properties: + dataChangeRecord: + description: >- + Data change record describing a data change for a change stream + partition. + $ref: '#/components/schemas/DataChangeRecord' + heartbeatRecord: + description: >- + Heartbeat record describing a heartbeat for a change stream + partition. + $ref: '#/components/schemas/HeartbeatRecord' + partitionStartRecord: + description: Partition start record describing a new change stream partition. + $ref: '#/components/schemas/PartitionStartRecord' + partitionEndRecord: + description: >- + Partition end record describing a terminated change stream + partition. + $ref: '#/components/schemas/PartitionEndRecord' + partitionEventRecord: + description: >- + Partition event record describing key range changes for a change + stream partition. + $ref: '#/components/schemas/PartitionEventRecord' + DataChangeRecord: + id: DataChangeRecord + description: >- + A data change record contains a set of changes to a table with the same + modification type (insert, update, or delete) committed at the same + commit timestamp in one change stream partition for the same + transaction. Multiple data change records can be returned for the same + transaction across multiple change stream partitions. + type: object + properties: + commitTimestamp: + description: >- + Indicates the timestamp in which the change was committed. + DataChangeRecord.commit_timestamps, + PartitionStartRecord.start_timestamps, + PartitionEventRecord.commit_timestamps, and + PartitionEndRecord.end_timestamps can have the same value in the + same partition. + type: string + format: google-datetime + recordSequence: + description: >- + Record sequence numbers are unique and monotonically increasing (but + not necessarily contiguous) for a specific timestamp across record + types in the same partition. To guarantee ordered processing, the + reader should process records (of potentially different types) in + record_sequence order for a specific timestamp in the same + partition. The record sequence number ordering across partitions is + only meaningful in the context of a specific transaction. Record + sequence numbers are unique across partitions for a specific + transaction. Sort the DataChangeRecords for the same + server_transaction_id by record_sequence to reconstruct the ordering + of the changes within the transaction. + type: string + serverTransactionId: + description: >- + Provides a globally unique string that represents the transaction in + which the change was committed. Multiple transactions can have the + same commit timestamp, but each transaction has a unique + server_transaction_id. + type: string + isLastRecordInTransactionInPartition: + description: >- + Indicates whether this is the last record for a transaction in the + current partition. Clients can use this field to determine when all + records for a transaction in the current partition have been + received. + type: boolean + table: + description: Name of the table affected by the change. + type: string + columnMetadata: + description: >- + Provides metadata describing the columns associated with the mods + listed below. + type: array + items: + $ref: '#/components/schemas/ColumnMetadata' + mods: + description: Describes the changes that were made. + type: array + items: + $ref: '#/components/schemas/Mod' + modType: + description: Describes the type of change. + type: string + enumDescriptions: + - Not specified. + - Indicates data was inserted. + - Indicates existing data was updated. + - Indicates existing data was deleted. + enum: + - MOD_TYPE_UNSPECIFIED + - INSERT + - UPDATE + - DELETE + valueCaptureType: + description: >- + Describes the value capture type that was specified in the change + stream configuration when this change was captured. + type: string + enumDescriptions: + - Not specified. + - Records both old and new values of the modified watched columns. + - Records only new values of the modified watched columns. + - >- + Records new values of all watched columns, including modified and + unmodified columns. + - >- + Records the new values of all watched columns, including modified + and unmodified columns. Also records the old values of the + modified columns. + enum: + - VALUE_CAPTURE_TYPE_UNSPECIFIED + - OLD_AND_NEW_VALUES + - NEW_VALUES + - NEW_ROW + - NEW_ROW_AND_OLD_VALUES + numberOfRecordsInTransaction: + description: >- + Indicates the number of data change records that are part of this + transaction across all change stream partitions. This value can be + used to assemble all the records associated with a particular + transaction. + type: integer + format: int32 + numberOfPartitionsInTransaction: + description: >- + Indicates the number of partitions that return data change records + for this transaction. This value can be helpful in assembling all + records associated with a particular transaction. + type: integer + format: int32 + transactionTag: + description: Indicates the transaction tag associated with this transaction. + type: string + isSystemTransaction: + description: >- + Indicates whether the transaction is a system transaction. System + transactions include those issued by time-to-live (TTL), column + backfill, etc. + type: boolean + ColumnMetadata: + id: ColumnMetadata + description: Metadata for a column. + type: object + properties: + name: + description: Name of the column. + type: string + type: + description: Type of the column. + $ref: '#/components/schemas/Type' + isPrimaryKey: + description: Indicates whether the column is a primary key column. + type: boolean + ordinalPosition: + description: >- + Ordinal position of the column based on the original table + definition in the schema starting with a value of 1. + type: string + format: int64 + Mod: + id: Mod + description: A mod describes all data changes in a watched table row. + type: object + properties: + keys: + description: Returns the value of the primary key of the modified row. + type: array + items: + $ref: '#/components/schemas/ModValue' + oldValues: + description: >- + Returns the old values before the change for the modified columns. + Always empty for INSERT, or if old values are not being captured + specified by value_capture_type. + type: array + items: + $ref: '#/components/schemas/ModValue' + newValues: + description: >- + Returns the new values after the change for the modified columns. + Always empty for DELETE. + type: array + items: + $ref: '#/components/schemas/ModValue' + ModValue: + id: ModValue + description: >- + Returns the value and associated metadata for a particular field of the + Mod. + type: object + properties: + columnMetadataIndex: + description: >- + Index within the repeated column_metadata field, to obtain the + column metadata for the column that was modified. + type: integer + format: int32 + value: + description: The value of the column. + type: any + HeartbeatRecord: + id: HeartbeatRecord + description: >- + A heartbeat record is returned as a progress indicator, when there are + no data changes or any other partition record types in the change stream + partition. + type: object + properties: + timestamp: + description: >- + Indicates the timestamp at which the query has returned all the + records in the change stream partition with timestamp <= heartbeat + timestamp. The heartbeat timestamp will not be the same as the + timestamps of other record types in the same partition. + type: string + format: google-datetime + PartitionStartRecord: + id: PartitionStartRecord + description: >- + A partition start record serves as a notification that the client should + schedule the partitions to be queried. PartitionStartRecord returns + information about one or more partitions. + type: object + properties: + startTimestamp: + description: >- + Start timestamp at which the partitions should be queried to return + change stream records with timestamps >= start_timestamp. + DataChangeRecord.commit_timestamps, + PartitionStartRecord.start_timestamps, + PartitionEventRecord.commit_timestamps, and + PartitionEndRecord.end_timestamps can have the same value in the + same partition. + type: string + format: google-datetime + recordSequence: + description: >- + Record sequence numbers are unique and monotonically increasing (but + not necessarily contiguous) for a specific timestamp across record + types in the same partition. To guarantee ordered processing, the + reader should process records (of potentially different types) in + record_sequence order for a specific timestamp in the same + partition. type: string - enumDescriptions: - - Not specified. - - >- - Normal fulfillment period. The operation is expected to complete - within minutes. - - >- - Extended fulfillment period. It can take up to an hour for the - operation to complete. - enum: - - FULFILLMENT_PERIOD_UNSPECIFIED - - FULFILLMENT_PERIOD_NORMAL - - FULFILLMENT_PERIOD_EXTENDED - UpdateInstanceConfigMetadata: - id: UpdateInstanceConfigMetadata - description: Metadata type for the operation returned by UpdateInstanceConfig. + partitionTokens: + description: Unique partition identifiers to be used in queries. + type: array + items: + type: string + PartitionEndRecord: + id: PartitionEndRecord + description: >- + A partition end record serves as a notification that the client should + stop reading the partition. No further records are expected to be + retrieved on it. type: object properties: - instanceConfig: - description: The desired instance configuration after updating. - $ref: '#/components/schemas/InstanceConfig' - progress: - description: The progress of the UpdateInstanceConfig operation. - $ref: '#/components/schemas/InstanceOperationProgress' - cancelTime: - description: The time at which this operation was cancelled. + endTimestamp: + description: >- + End timestamp at which the change stream partition is terminated. + All changes generated by this partition will have timestamps <= + end_timestamp. DataChangeRecord.commit_timestamps, + PartitionStartRecord.start_timestamps, + PartitionEventRecord.commit_timestamps, and + PartitionEndRecord.end_timestamps can have the same value in the + same partition. PartitionEndRecord is the last record returned for a + partition. type: string format: google-datetime - UpdateInstancePartitionMetadata: - id: UpdateInstancePartitionMetadata - description: Metadata type for the operation returned by UpdateInstancePartition. + recordSequence: + description: >- + Record sequence numbers are unique and monotonically increasing (but + not necessarily contiguous) for a specific timestamp across record + types in the same partition. To guarantee ordered processing, the + reader should process records (of potentially different types) in + record_sequence order for a specific timestamp in the same + partition. + type: string + partitionToken: + description: >- + Unique partition identifier describing the terminated change stream + partition. partition_token is equal to the partition token of the + change stream partition currently queried to return this + PartitionEndRecord. + type: string + PartitionEventRecord: + id: PartitionEventRecord + description: >- + A partition event record describes key range changes for a change stream + partition. The changes to a row defined by its primary key can be + captured in one change stream partition for a specific time range, and + then be captured in a different change stream partition for a different + time range. This movement of key ranges across change stream partitions + is a reflection of activities, such as Spanner's dynamic splitting and + load balancing, etc. Processing this event is needed if users want to + guarantee processing of the changes for any key in timestamp order. If + time ordered processing of changes for a primary key is not needed, this + event can be ignored. To guarantee time ordered processing for each + primary key, if the event describes move-ins, the reader of this + partition needs to wait until the readers of the source partitions have + processed all records with timestamps <= this + PartitionEventRecord.commit_timestamp, before advancing beyond this + PartitionEventRecord. If the event describes move-outs, the reader can + notify the readers of the destination partitions that they can continue + processing. type: object properties: - instancePartition: - description: The desired end state of the update. - $ref: '#/components/schemas/InstancePartition' - startTime: - description: The time at which UpdateInstancePartition request was received. + commitTimestamp: + description: >- + Indicates the commit timestamp at which the key range change + occurred. DataChangeRecord.commit_timestamps, + PartitionStartRecord.start_timestamps, + PartitionEventRecord.commit_timestamps, and + PartitionEndRecord.end_timestamps can have the same value in the + same partition. type: string format: google-datetime - cancelTime: + recordSequence: description: >- - The time at which this operation was cancelled. If set, this - operation is in the process of undoing itself (which is guaranteed - to succeed) and cannot be cancelled again. + Record sequence numbers are unique and monotonically increasing (but + not necessarily contiguous) for a specific timestamp across record + types in the same partition. To guarantee ordered processing, the + reader should process records (of potentially different types) in + record_sequence order for a specific timestamp in the same + partition. type: string - format: google-datetime - endTime: + partitionToken: description: >- - The time at which this operation failed or was completed - successfully. + Unique partition identifier describing the partition this event + occurred on. partition_token is equal to the partition token of the + change stream partition currently queried to return this + PartitionEventRecord. + type: string + moveInEvents: + description: >- + Set when one or more key ranges are moved into the change stream + partition identified by partition_token. Example: Two key ranges are + moved into partition (P1) from partition (P2) and partition (P3) in + a single transaction at timestamp T. The PartitionEventRecord + returned in P1 will reflect the move as: PartitionEventRecord { + commit_timestamp: T partition_token: "P1" move_in_events { + source_partition_token: "P2" } move_in_events { + source_partition_token: "P3" } } The PartitionEventRecord returned + in P2 will reflect the move as: PartitionEventRecord { + commit_timestamp: T partition_token: "P2" move_out_events { + destination_partition_token: "P1" } } The PartitionEventRecord + returned in P3 will reflect the move as: PartitionEventRecord { + commit_timestamp: T partition_token: "P3" move_out_events { + destination_partition_token: "P1" } } + type: array + items: + $ref: '#/components/schemas/MoveInEvent' + moveOutEvents: + description: >- + Set when one or more key ranges are moved out of the change stream + partition identified by partition_token. Example: Two key ranges are + moved out of partition (P1) to partition (P2) and partition (P3) in + a single transaction at timestamp T. The PartitionEventRecord + returned in P1 will reflect the move as: PartitionEventRecord { + commit_timestamp: T partition_token: "P1" move_out_events { + destination_partition_token: "P2" } move_out_events { + destination_partition_token: "P3" } } The PartitionEventRecord + returned in P2 will reflect the move as: PartitionEventRecord { + commit_timestamp: T partition_token: "P2" move_in_events { + source_partition_token: "P1" } } The PartitionEventRecord returned + in P3 will reflect the move as: PartitionEventRecord { + commit_timestamp: T partition_token: "P3" move_in_events { + source_partition_token: "P1" } } + type: array + items: + $ref: '#/components/schemas/MoveOutEvent' + MoveInEvent: + id: MoveInEvent + description: >- + Describes move-in of the key ranges into the change stream partition + identified by partition_token. To maintain processing the changes for a + particular key in timestamp order, the query processing the change + stream partition identified by partition_token should not advance beyond + the partition event record commit timestamp until the queries processing + the source change stream partitions have processed all change stream + records with timestamps <= the partition event record commit timestamp. + type: object + properties: + sourcePartitionToken: + description: >- + An unique partition identifier describing the source change stream + partition that recorded changes for the key range that is moving + into this partition. + type: string + MoveOutEvent: + id: MoveOutEvent + description: >- + Describes move-out of the key ranges out of the change stream partition + identified by partition_token. To maintain processing the changes for a + particular key in timestamp order, the query processing the MoveOutEvent + in the partition identified by partition_token should inform the queries + processing the destination partitions that they can unblock and proceed + processing records past the commit_timestamp. + type: object + properties: + destinationPartitionToken: + description: >- + An unique partition identifier describing the destination change + stream partition that will record changes for the key range that is + moving out of this partition. type: string - format: google-datetime parameters: access_token: description: OAuth access token. @@ -5761,61 +6245,61 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_instances_backups_operations_list: + projects_instances_instance_partitions_operations_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1backups~1{backupsId}~1operations/get + #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1instancePartitions~1{instancePartitionsId}~1operations/get response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_instances_backups_operations_get: + projects_instances_instance_partitions_operations_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1backups~1{backupsId}~1operations~1{operationsId}/get + #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1instancePartitions~1{instancePartitionsId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_instances_backups_operations_delete: + projects_instances_instance_partitions_operations_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1backups~1{backupsId}~1operations~1{operationsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1instancePartitions~1{instancePartitionsId}~1operations~1{operationsId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_instances_backups_operations_cancel: + projects_instances_instance_partitions_operations_cancel: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1backups~1{backupsId}~1operations~1{operationsId}:cancel/post + #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1instancePartitions~1{instancePartitionsId}~1operations~1{operationsId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' - projects_instances_instance_partitions_operations_list: + projects_instances_backups_operations_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1instancePartitions~1{instancePartitionsId}~1operations/get + #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1backups~1{backupsId}~1operations/get response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_instances_instance_partitions_operations_get: + projects_instances_backups_operations_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1instancePartitions~1{instancePartitionsId}~1operations~1{operationsId}/get + #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1backups~1{backupsId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_instances_instance_partitions_operations_delete: + projects_instances_backups_operations_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1instancePartitions~1{instancePartitionsId}~1operations~1{operationsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1backups~1{backupsId}~1operations~1{operationsId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_instances_instance_partitions_operations_cancel: + projects_instances_backups_operations_cancel: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1instancePartitions~1{instancePartitionsId}~1operations~1{operationsId}:cancel/post + #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1backups~1{backupsId}~1operations~1{operationsId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' @@ -5825,10 +6309,10 @@ components: #/components/x-stackQL-resources/operations/methods/projects_instance_configs_ssd_caches_operations_get - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_instances_databases_operations_get - - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_instances_backups_operations_get - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_instances_instance_partitions_operations_get + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_instances_backups_operations_get - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_instance_configs_operations_get - $ref: >- @@ -5837,10 +6321,10 @@ components: #/components/x-stackQL-resources/operations/methods/projects_instances_databases_operations_list - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_instances_operations_get - - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_instances_backups_operations_list - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_instances_instance_partitions_operations_list + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_instances_backups_operations_list - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_instance_configs_operations_list - $ref: >- @@ -5853,10 +6337,10 @@ components: #/components/x-stackQL-resources/operations/methods/projects_instance_configs_ssd_caches_operations_delete - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_instances_databases_operations_delete - - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_instances_backups_operations_delete - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_instances_instance_partitions_operations_delete + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_instances_backups_operations_delete - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_instance_configs_operations_delete - $ref: >- @@ -6107,35 +6591,203 @@ components: projects_instances_databases_set_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}:setIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}:setIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_instances_databases_get_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}:getIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.bindings + projects_instances_databases_test_iam_permissions: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}:testIamPermissions/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/databases_iam_policies/methods/projects_instances_databases_get_iam_policy + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/databases_iam_policies/methods/projects_instances_databases_set_iam_policy + delete: [] + databases_split_points: + id: google.spanner.databases_split_points + name: databases_split_points + title: Databases_split_points + methods: + projects_instances_databases_add_split_points: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}:addSplitPoints/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/databases_split_points/methods/projects_instances_databases_add_split_points + update: [] + replace: [] + delete: [] + sessions: + id: google.spanner.sessions + name: sessions + title: Sessions + methods: + projects_instances_databases_sessions_adapter: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}~1sessions:adapter/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_instances_databases_sessions_adapt_message: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}~1sessions~1{sessionsId}:adaptMessage/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_instances_databases_sessions_create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}~1sessions/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_instances_databases_sessions_list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}~1sessions/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.sessions + projects_instances_databases_sessions_batch_create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}~1sessions:batchCreate/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_instances_databases_sessions_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}~1sessions~1{sessionsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_instances_databases_sessions_delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}~1sessions~1{sessionsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + projects_instances_databases_sessions_execute_sql: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}~1sessions~1{sessionsId}:executeSql/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_instances_databases_sessions_execute_streaming_sql: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}~1sessions~1{sessionsId}:executeStreamingSql/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_instances_databases_sessions_execute_batch_dml: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}~1sessions~1{sessionsId}:executeBatchDml/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_instances_databases_sessions_read: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}~1sessions~1{sessionsId}:read/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_instances_databases_sessions_streaming_read: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}~1sessions~1{sessionsId}:streamingRead/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_instances_databases_sessions_begin_transaction: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}~1sessions~1{sessionsId}:beginTransaction/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_instances_databases_sessions_commit: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}~1sessions~1{sessionsId}:commit/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_instances_databases_sessions_rollback: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}~1sessions~1{sessionsId}:rollback/post response: mediaType: application/json openAPIDocKey: '200' - projects_instances_databases_get_iam_policy: + projects_instances_databases_sessions_partition_query: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}:getIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}~1sessions~1{sessionsId}:partitionQuery/post response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.bindings - projects_instances_databases_test_iam_permissions: + projects_instances_databases_sessions_partition_read: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}:testIamPermissions/post + #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}~1sessions~1{sessionsId}:partitionRead/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_instances_databases_sessions_batch_write: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}~1sessions~1{sessionsId}:batchWrite/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/databases_iam_policies/methods/projects_instances_databases_get_iam_policy - insert: [] + #/components/x-stackQL-resources/sessions/methods/projects_instances_databases_sessions_get + - $ref: >- + #/components/x-stackQL-resources/sessions/methods/projects_instances_databases_sessions_list + insert: + - $ref: >- + #/components/x-stackQL-resources/sessions/methods/projects_instances_databases_sessions_create + - $ref: >- + #/components/x-stackQL-resources/sessions/methods/projects_instances_databases_sessions_batch_create update: [] - replace: + replace: [] + delete: - $ref: >- - #/components/x-stackQL-resources/databases_iam_policies/methods/projects_instances_databases_set_iam_policy - delete: [] + #/components/x-stackQL-resources/sessions/methods/projects_instances_databases_sessions_delete backup_schedules_iam_policies: id: google.spanner.backup_schedules_iam_policies name: backup_schedules_iam_policies @@ -6269,140 +6921,84 @@ components: update: [] replace: [] delete: [] - sessions: - id: google.spanner.sessions - name: sessions - title: Sessions + instance_partitions: + id: google.spanner.instance_partitions + name: instance_partitions + title: Instance_partitions methods: - projects_instances_databases_sessions_create: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}~1sessions/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_instances_databases_sessions_list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}~1sessions/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.sessions - projects_instances_databases_sessions_batch_create: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}~1sessions:batchCreate/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_instances_databases_sessions_get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}~1sessions~1{sessionsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - projects_instances_databases_sessions_delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}~1sessions~1{sessionsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - projects_instances_databases_sessions_execute_sql: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}~1sessions~1{sessionsId}:executeSql/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_instances_databases_sessions_execute_streaming_sql: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}~1sessions~1{sessionsId}:executeStreamingSql/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_instances_databases_sessions_execute_batch_dml: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}~1sessions~1{sessionsId}:executeBatchDml/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_instances_databases_sessions_read: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}~1sessions~1{sessionsId}:read/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_instances_databases_sessions_streaming_read: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}~1sessions~1{sessionsId}:streamingRead/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_instances_databases_sessions_begin_transaction: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}~1sessions~1{sessionsId}:beginTransaction/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_instances_databases_sessions_commit: + projects_instances_instance_partitions_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}~1sessions~1{sessionsId}:commit/post + #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1instancePartitions/get response: mediaType: application/json openAPIDocKey: '200' - projects_instances_databases_sessions_rollback: + objectKey: $.instancePartitions + projects_instances_instance_partitions_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}~1sessions~1{sessionsId}:rollback/post + #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1instancePartitions/post response: mediaType: application/json openAPIDocKey: '200' - projects_instances_databases_sessions_partition_query: + projects_instances_instance_partitions_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}~1sessions~1{sessionsId}:partitionQuery/post + #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1instancePartitions~1{instancePartitionsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_instances_databases_sessions_partition_read: + projects_instances_instance_partitions_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}~1sessions~1{sessionsId}:partitionRead/post + #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1instancePartitions~1{instancePartitionsId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_instances_databases_sessions_batch_write: + projects_instances_instance_partitions_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}~1sessions~1{sessionsId}:batchWrite/post + #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1instancePartitions~1{instancePartitionsId}/patch response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/sessions/methods/projects_instances_databases_sessions_get + #/components/x-stackQL-resources/instance_partitions/methods/projects_instances_instance_partitions_get - $ref: >- - #/components/x-stackQL-resources/sessions/methods/projects_instances_databases_sessions_list + #/components/x-stackQL-resources/instance_partitions/methods/projects_instances_instance_partitions_list insert: - $ref: >- - #/components/x-stackQL-resources/sessions/methods/projects_instances_databases_sessions_create + #/components/x-stackQL-resources/instance_partitions/methods/projects_instances_instance_partitions_create + update: - $ref: >- - #/components/x-stackQL-resources/sessions/methods/projects_instances_databases_sessions_batch_create - update: [] + #/components/x-stackQL-resources/instance_partitions/methods/projects_instances_instance_partitions_patch replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/sessions/methods/projects_instances_databases_sessions_delete + #/components/x-stackQL-resources/instance_partitions/methods/projects_instances_instance_partitions_delete + instance_partition_operations: + id: google.spanner.instance_partition_operations + name: instance_partition_operations + title: Instance_partition_operations + methods: + projects_instances_instance_partition_operations_list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1instancePartitionOperations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.operations + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/instance_partition_operations/methods/projects_instances_instance_partition_operations_list + insert: [] + update: [] + replace: [] + delete: [] backups_iam_policies: id: google.spanner.backups_iam_policies name: backups_iam_policies @@ -6527,91 +7123,13 @@ components: delete: [] backup_operations: id: google.spanner.backup_operations - name: backup_operations - title: Backup_operations - methods: - projects_instances_backup_operations_list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1backupOperations/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.operations - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/backup_operations/methods/projects_instances_backup_operations_list - insert: [] - update: [] - replace: [] - delete: [] - instance_partitions: - id: google.spanner.instance_partitions - name: instance_partitions - title: Instance_partitions - methods: - projects_instances_instance_partitions_list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1instancePartitions/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.instancePartitions - projects_instances_instance_partitions_create: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1instancePartitions/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_instances_instance_partitions_get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1instancePartitions~1{instancePartitionsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - projects_instances_instance_partitions_delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1instancePartitions~1{instancePartitionsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - projects_instances_instance_partitions_patch: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1instancePartitions~1{instancePartitionsId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/instance_partitions/methods/projects_instances_instance_partitions_get - - $ref: >- - #/components/x-stackQL-resources/instance_partitions/methods/projects_instances_instance_partitions_list - insert: - - $ref: >- - #/components/x-stackQL-resources/instance_partitions/methods/projects_instances_instance_partitions_create - update: - - $ref: >- - #/components/x-stackQL-resources/instance_partitions/methods/projects_instances_instance_partitions_patch - replace: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/instance_partitions/methods/projects_instances_instance_partitions_delete - instance_partition_operations: - id: google.spanner.instance_partition_operations - name: instance_partition_operations - title: Instance_partition_operations + name: backup_operations + title: Backup_operations methods: - projects_instances_instance_partition_operations_list: + projects_instances_backup_operations_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1instancePartitionOperations/get + #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1backupOperations/get response: mediaType: application/json openAPIDocKey: '200' @@ -6619,7 +7137,7 @@ components: sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/instance_partition_operations/methods/projects_instances_instance_partition_operations_list + #/components/x-stackQL-resources/backup_operations/methods/projects_instances_backup_operations_list insert: [] update: [] replace: [] @@ -7031,7 +7549,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: spanner.projects.instanceConfigs.operations.cancel security: - Oauth2: @@ -7218,7 +7736,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: spanner.projects.instanceConfigs.ssdCaches.operations.cancel security: - Oauth2: @@ -8323,6 +8841,48 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:addSplitPoints: + parameters: *ref_1 + post: + description: Adds split points to specified tables and indexes of a database. + operationId: spanner.projects.instances.databases.addSplitPoints + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddSplitPointsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/spanner.admin + Oauth2c: + - https://www.googleapis.com/auth/spanner.admin + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/AddSplitPointsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + - in: path + name: databasesId + required: true + schema: + type: string /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations: parameters: *ref_1 get: @@ -8476,7 +9036,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: spanner.projects.instances.databases.operations.cancel security: - Oauth2: @@ -8515,38 +9075,35 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}:setIamPolicy: + /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions:adapter: parameters: *ref_1 post: description: >- - Sets the access control policy on a database or backup resource. - Replaces any existing policy. Authorization requires - `spanner.databases.setIamPolicy` permission on resource. For backups, - authorization requires `spanner.backups.setIamPolicy` permission on - resource. For backup schedules, authorization requires - `spanner.backupSchedules.setIamPolicy` permission on resource. - operationId: spanner.projects.instances.databases.backupSchedules.setIamPolicy + Creates a new session to be used for requests made by the adapter. A + session identifies a specific incarnation of a database resource and is + meant to be reused across many `AdaptMessage` calls. + operationId: spanner.projects.instances.databases.sessions.adapter requestBody: content: application/json: schema: - $ref: '#/components/schemas/SetIamPolicyRequest' + $ref: '#/components/schemas/AdapterSession' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - - https://www.googleapis.com/auth/spanner.admin + - https://www.googleapis.com/auth/spanner.data Oauth2c: - - https://www.googleapis.com/auth/spanner.admin + - https://www.googleapis.com/auth/spanner.data responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/AdapterSession' parameters: - in: path name: projectsId @@ -8563,44 +9120,35 @@ paths: required: true schema: type: string - - in: path - name: backupSchedulesId - required: true - schema: - type: string - /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}:getIamPolicy: + /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:adaptMessage: parameters: *ref_1 post: description: >- - Gets the access control policy for a database or backup resource. - Returns an empty policy if a database or backup exists but does not have - a policy set. Authorization requires `spanner.databases.getIamPolicy` - permission on resource. For backups, authorization requires - `spanner.backups.getIamPolicy` permission on resource. For backup - schedules, authorization requires `spanner.backupSchedules.getIamPolicy` - permission on resource. - operationId: spanner.projects.instances.databases.backupSchedules.getIamPolicy + Handles a single message from the client and returns the result as a + stream. The server will interpret the message frame and respond with + message frames to the client. + operationId: spanner.projects.instances.databases.sessions.adaptMessage requestBody: content: application/json: schema: - $ref: '#/components/schemas/GetIamPolicyRequest' + $ref: '#/components/schemas/AdaptMessageRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - - https://www.googleapis.com/auth/spanner.admin + - https://www.googleapis.com/auth/spanner.data Oauth2c: - - https://www.googleapis.com/auth/spanner.admin + - https://www.googleapis.com/auth/spanner.data responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/AdaptMessageResponse' parameters: - in: path name: projectsId @@ -8618,93 +9166,48 @@ paths: schema: type: string - in: path - name: backupSchedulesId + name: sessionsId required: true schema: type: string - /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}:testIamPermissions: + /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions: parameters: *ref_1 post: description: >- - Returns permissions that the caller has on the specified database or - backup resource. Attempting this RPC on a non-existent Cloud Spanner - database will result in a NOT_FOUND error if the user has - `spanner.databases.list` permission on the containing Cloud Spanner - instance. Otherwise returns an empty set of permissions. Calling this - method on a backup that does not exist will result in a NOT_FOUND error - if the user has `spanner.backups.list` permission on the containing - instance. Calling this method on a backup schedule that does not exist - will result in a NOT_FOUND error if the user has - `spanner.backupSchedules.list` permission on the containing database. - operationId: spanner.projects.instances.databases.backupSchedules.testIamPermissions - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TestIamPermissionsRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/spanner.admin - Oauth2c: - - https://www.googleapis.com/auth/spanner.admin - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/TestIamPermissionsResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: instancesId - required: true - schema: - type: string - - in: path - name: databasesId - required: true - schema: - type: string - - in: path - name: backupSchedulesId - required: true - schema: - type: string - /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules: - parameters: *ref_1 - post: - description: Creates a new backup schedule. - operationId: spanner.projects.instances.databases.backupSchedules.create + Creates a new session. A session can be used to perform transactions + that read and/or modify data in a Cloud Spanner database. Sessions are + meant to be reused for many consecutive transactions. Sessions can only + execute one transaction at a time. To execute multiple concurrent + read-write/write-only transactions, create multiple sessions. Note that + standalone reads and queries use a transaction internally, and count + toward the one transaction limit. Active sessions use additional server + resources, so it's a good idea to delete idle and unneeded sessions. + Aside from explicit deletes, Cloud Spanner can delete sessions when no + operations are sent for more than an hour. If a session is deleted, + requests to it return `NOT_FOUND`. Idle sessions can be kept alive by + sending a trivial SQL query periodically, for example, `"SELECT 1"`. + operationId: spanner.projects.instances.databases.sessions.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/BackupSchedule' + $ref: '#/components/schemas/CreateSessionRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - - https://www.googleapis.com/auth/spanner.admin + - https://www.googleapis.com/auth/spanner.data Oauth2c: - - https://www.googleapis.com/auth/spanner.admin + - https://www.googleapis.com/auth/spanner.data responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/BackupSchedule' + $ref: '#/components/schemas/Session' parameters: - in: path name: projectsId @@ -8721,29 +9224,25 @@ paths: required: true schema: type: string - - in: query - name: backupScheduleId - schema: - type: string get: - description: Lists all the backup schedules for the database. - operationId: spanner.projects.instances.databases.backupSchedules.list + description: Lists all sessions in a given database. + operationId: spanner.projects.instances.databases.sessions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - - https://www.googleapis.com/auth/spanner.admin + - https://www.googleapis.com/auth/spanner.data Oauth2c: - - https://www.googleapis.com/auth/spanner.admin + - https://www.googleapis.com/auth/spanner.data responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/ListBackupSchedulesResponse' + $ref: '#/components/schemas/ListSessionsResponse' parameters: - in: path name: projectsId @@ -8769,72 +9268,39 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}: - parameters: *ref_1 - get: - description: Gets backup schedule for the input schedule name. - operationId: spanner.projects.instances.databases.backupSchedules.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/spanner.admin - Oauth2c: - - https://www.googleapis.com/auth/spanner.admin - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/BackupSchedule' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: instancesId - required: true - schema: - type: string - - in: path - name: databasesId - required: true - schema: - type: string - - in: path - name: backupSchedulesId - required: true + - in: query + name: filter schema: type: string - patch: - description: Updates a backup schedule. - operationId: spanner.projects.instances.databases.backupSchedules.patch + /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions:batchCreate: + parameters: *ref_1 + post: + description: >- + Creates multiple new sessions. This API can be used to initialize a + session cache on the clients. See https://goo.gl/TgSFN2 for best + practices on session cache management. + operationId: spanner.projects.instances.databases.sessions.batchCreate requestBody: content: application/json: schema: - $ref: '#/components/schemas/BackupSchedule' + $ref: '#/components/schemas/BatchCreateSessionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - - https://www.googleapis.com/auth/spanner.admin + - https://www.googleapis.com/auth/spanner.data Oauth2c: - - https://www.googleapis.com/auth/spanner.admin + - https://www.googleapis.com/auth/spanner.data responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/BackupSchedule' + $ref: '#/components/schemas/BatchCreateSessionsResponse' parameters: - in: path name: projectsId @@ -8851,35 +9317,29 @@ paths: required: true schema: type: string - - in: path - name: backupSchedulesId - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: - description: Deletes a backup schedule. - operationId: spanner.projects.instances.databases.backupSchedules.delete + /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}: + parameters: *ref_1 + get: + description: >- + Gets a session. Returns `NOT_FOUND` if the session doesn't exist. This + is mainly useful for determining whether a session is still alive. + operationId: spanner.projects.instances.databases.sessions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - - https://www.googleapis.com/auth/spanner.admin + - https://www.googleapis.com/auth/spanner.data Oauth2c: - - https://www.googleapis.com/auth/spanner.admin + - https://www.googleapis.com/auth/spanner.data responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/Session' parameters: - in: path name: projectsId @@ -8897,46 +9357,32 @@ paths: schema: type: string - in: path - name: backupSchedulesId + name: sessionsId required: true schema: type: string - /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/databaseRoles/{databaseRolesId}:testIamPermissions: - parameters: *ref_1 - post: + delete: description: >- - Returns permissions that the caller has on the specified database or - backup resource. Attempting this RPC on a non-existent Cloud Spanner - database will result in a NOT_FOUND error if the user has - `spanner.databases.list` permission on the containing Cloud Spanner - instance. Otherwise returns an empty set of permissions. Calling this - method on a backup that does not exist will result in a NOT_FOUND error - if the user has `spanner.backups.list` permission on the containing - instance. Calling this method on a backup schedule that does not exist - will result in a NOT_FOUND error if the user has - `spanner.backupSchedules.list` permission on the containing database. - operationId: spanner.projects.instances.databases.databaseRoles.testIamPermissions - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TestIamPermissionsRequest' + Ends a session, releasing server resources associated with it. This + asynchronously triggers the cancellation of any operations that are + running with this session. + operationId: spanner.projects.instances.databases.sessions.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - - https://www.googleapis.com/auth/spanner.admin + - https://www.googleapis.com/auth/spanner.data Oauth2c: - - https://www.googleapis.com/auth/spanner.admin + - https://www.googleapis.com/auth/spanner.data responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/TestIamPermissionsResponse' + $ref: '#/components/schemas/Empty' parameters: - in: path name: projectsId @@ -8954,31 +9400,46 @@ paths: schema: type: string - in: path - name: databaseRolesId + name: sessionsId required: true schema: type: string - /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/databaseRoles: + /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:executeSql: parameters: *ref_1 - get: - description: Lists Cloud Spanner database roles. - operationId: spanner.projects.instances.databases.databaseRoles.list + post: + description: >- + Executes an SQL statement, returning all results in a single reply. This + method can't be used to return a result set larger than 10 MiB; if the + query yields more data than that, the query fails with a + `FAILED_PRECONDITION` error. Operations inside read-write transactions + might return `ABORTED`. If this occurs, the application should restart + the transaction from the beginning. See Transaction for more details. + Larger result sets can be fetched in streaming fashion by calling + ExecuteStreamingSql instead. The query string can be SQL or [Graph Query + Language + (GQL)](https://cloud.google.com/spanner/docs/reference/standard-sql/graph-intro). + operationId: spanner.projects.instances.databases.sessions.executeSql + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExecuteSqlRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - - https://www.googleapis.com/auth/spanner.admin + - https://www.googleapis.com/auth/spanner.data Oauth2c: - - https://www.googleapis.com/auth/spanner.admin + - https://www.googleapis.com/auth/spanner.data responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/ListDatabaseRolesResponse' + $ref: '#/components/schemas/ResultSet' parameters: - in: path name: projectsId @@ -8995,37 +9456,27 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: sessionsId + required: true schema: type: string - /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions: + /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:executeStreamingSql: parameters: *ref_1 post: description: >- - Creates a new session. A session can be used to perform transactions - that read and/or modify data in a Cloud Spanner database. Sessions are - meant to be reused for many consecutive transactions. Sessions can only - execute one transaction at a time. To execute multiple concurrent - read-write/write-only transactions, create multiple sessions. Note that - standalone reads and queries use a transaction internally, and count - toward the one transaction limit. Active sessions use additional server - resources, so it is a good idea to delete idle and unneeded sessions. - Aside from explicit deletes, Cloud Spanner may delete sessions for which - no operations are sent for more than an hour. If a session is deleted, - requests to it return `NOT_FOUND`. Idle sessions can be kept alive by - sending a trivial SQL query periodically, e.g., `"SELECT 1"`. - operationId: spanner.projects.instances.databases.sessions.create + Like ExecuteSql, except returns the result set as a stream. Unlike + ExecuteSql, there is no limit on the size of the returned result set. + However, no individual row in the result set can exceed 100 MiB, and no + column value can exceed 10 MiB. The query string can be SQL or [Graph + Query Language + (GQL)](https://cloud.google.com/spanner/docs/reference/standard-sql/graph-intro). + operationId: spanner.projects.instances.databases.sessions.executeStreamingSql requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateSessionRequest' + $ref: '#/components/schemas/ExecuteSqlRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9041,7 +9492,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Session' + $ref: '#/components/schemas/PartialResultSet' parameters: - in: path name: projectsId @@ -9058,9 +9509,29 @@ paths: required: true schema: type: string - get: - description: Lists all sessions in a given database. - operationId: spanner.projects.instances.databases.sessions.list + - in: path + name: sessionsId + required: true + schema: + type: string + /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:executeBatchDml: + parameters: *ref_1 + post: + description: >- + Executes a batch of SQL DML statements. This method allows many + statements to be run with lower latency than submitting them + sequentially with ExecuteSql. Statements are executed in sequential + order. A request can succeed even if a statement fails. The + ExecuteBatchDmlResponse.status field in the response provides + information about the statement that failed. Clients must inspect this + field to determine whether an error occurred. Execution stops after the + first failed statement; the remaining statements are not executed. + operationId: spanner.projects.instances.databases.sessions.executeBatchDml + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExecuteBatchDmlRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9076,7 +9547,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListSessionsResponse' + $ref: '#/components/schemas/ExecuteBatchDmlResponse' parameters: - in: path name: projectsId @@ -9093,32 +9564,29 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + - in: path + name: sessionsId + required: true schema: type: string - /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions:batchCreate: + /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:read: parameters: *ref_1 post: description: >- - Creates multiple new sessions. This API can be used to initialize a - session cache on the clients. See https://goo.gl/TgSFN2 for best - practices on session cache management. - operationId: spanner.projects.instances.databases.sessions.batchCreate + Reads rows from the database using key lookups and scans, as a simple + key/value style alternative to ExecuteSql. This method can't be used to + return a result set larger than 10 MiB; if the read matches more data + than that, the read fails with a `FAILED_PRECONDITION` error. Reads + inside read-write transactions might return `ABORTED`. If this occurs, + the application should restart the transaction from the beginning. See + Transaction for more details. Larger result sets can be yielded in + streaming fashion by calling StreamingRead instead. + operationId: spanner.projects.instances.databases.sessions.read requestBody: content: application/json: schema: - $ref: '#/components/schemas/BatchCreateSessionsRequest' + $ref: '#/components/schemas/ReadRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9134,7 +9602,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BatchCreateSessionsResponse' + $ref: '#/components/schemas/ResultSet' parameters: - in: path name: projectsId @@ -9151,13 +9619,25 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}: + - in: path + name: sessionsId + required: true + schema: + type: string + /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:streamingRead: parameters: *ref_1 - get: + post: description: >- - Gets a session. Returns `NOT_FOUND` if the session does not exist. This - is mainly useful for determining whether a session is still alive. - operationId: spanner.projects.instances.databases.sessions.get + Like Read, except returns the result set as a stream. Unlike Read, there + is no limit on the size of the returned result set. However, no + individual row in the result set can exceed 100 MiB, and no column value + can exceed 10 MiB. + operationId: spanner.projects.instances.databases.sessions.streamingRead + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ReadRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9173,7 +9653,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Session' + $ref: '#/components/schemas/PartialResultSet' parameters: - in: path name: projectsId @@ -9195,12 +9675,18 @@ paths: required: true schema: type: string - delete: + /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:beginTransaction: + parameters: *ref_1 + post: description: >- - Ends a session, releasing server resources associated with it. This will - asynchronously trigger cancellation of any operations that are running - with this session. - operationId: spanner.projects.instances.databases.sessions.delete + Begins a new transaction. This step can often be skipped: Read, + ExecuteSql and Commit can begin a new transaction as a side-effect. + operationId: spanner.projects.instances.databases.sessions.beginTransaction + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BeginTransactionRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9216,7 +9702,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/Transaction' parameters: - in: path name: projectsId @@ -9238,24 +9724,27 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:executeSql: + /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:commit: parameters: *ref_1 post: description: >- - Executes an SQL statement, returning all results in a single reply. This - method cannot be used to return a result set larger than 10 MiB; if the - query yields more data than that, the query fails with a - `FAILED_PRECONDITION` error. Operations inside read-write transactions - might return `ABORTED`. If this occurs, the application should restart - the transaction from the beginning. See Transaction for more details. - Larger result sets can be fetched in streaming fashion by calling - ExecuteStreamingSql instead. - operationId: spanner.projects.instances.databases.sessions.executeSql + Commits a transaction. The request includes the mutations to be applied + to rows in the database. `Commit` might return an `ABORTED` error. This + can occur at any time; commonly, the cause is conflicts with concurrent + transactions. However, it can also happen for a variety of other + reasons. If `Commit` returns `ABORTED`, the caller should retry the + transaction from the beginning, reusing the same session. On very rare + occasions, `Commit` might return `UNKNOWN`. This can happen, for + example, if the client job experiences a 1+ hour networking failure. At + that point, Cloud Spanner has lost track of the transaction outcome and + we recommend that you perform another read from the database to see the + state of things as they are now. + operationId: spanner.projects.instances.databases.sessions.commit requestBody: content: application/json: schema: - $ref: '#/components/schemas/ExecuteSqlRequest' + $ref: '#/components/schemas/CommitRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9271,7 +9760,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ResultSet' + $ref: '#/components/schemas/CommitResponse' parameters: - in: path name: projectsId @@ -9293,20 +9782,22 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:executeStreamingSql: + /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:rollback: parameters: *ref_1 post: description: >- - Like ExecuteSql, except returns the result set as a stream. Unlike - ExecuteSql, there is no limit on the size of the returned result set. - However, no individual row in the result set can exceed 100 MiB, and no - column value can exceed 10 MiB. - operationId: spanner.projects.instances.databases.sessions.executeStreamingSql + Rolls back a transaction, releasing any locks it holds. It's a good idea + to call this for any transaction that includes one or more Read or + ExecuteSql requests and ultimately decides not to commit. `Rollback` + returns `OK` if it successfully aborts the transaction, the transaction + was already aborted, or the transaction isn't found. `Rollback` never + returns `ABORTED`. + operationId: spanner.projects.instances.databases.sessions.rollback requestBody: content: application/json: schema: - $ref: '#/components/schemas/ExecuteSqlRequest' + $ref: '#/components/schemas/RollbackRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9322,7 +9813,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PartialResultSet' + $ref: '#/components/schemas/Empty' parameters: - in: path name: projectsId @@ -9344,24 +9835,26 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:executeBatchDml: + /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:partitionQuery: parameters: *ref_1 post: description: >- - Executes a batch of SQL DML statements. This method allows many - statements to be run with lower latency than submitting them - sequentially with ExecuteSql. Statements are executed in sequential - order. A request can succeed even if a statement fails. The - ExecuteBatchDmlResponse.status field in the response provides - information about the statement that failed. Clients must inspect this - field to determine whether an error occurred. Execution stops after the - first failed statement; the remaining statements are not executed. - operationId: spanner.projects.instances.databases.sessions.executeBatchDml + Creates a set of partition tokens that can be used to execute a query + operation in parallel. Each of the returned partition tokens can be used + by ExecuteStreamingSql to specify a subset of the query result to read. + The same session and read-only transaction must be used by the + `PartitionQueryRequest` used to create the partition tokens and the + `ExecuteSqlRequests` that use the partition tokens. Partition tokens + become invalid when the session used to create them is deleted, is idle + for too long, begins a new transaction, or becomes too old. When any of + these happen, it isn't possible to resume the query, and the whole + operation must be restarted from the beginning. + operationId: spanner.projects.instances.databases.sessions.partitionQuery requestBody: content: application/json: schema: - $ref: '#/components/schemas/ExecuteBatchDmlRequest' + $ref: '#/components/schemas/PartitionQueryRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9377,7 +9870,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ExecuteBatchDmlResponse' + $ref: '#/components/schemas/PartitionResponse' parameters: - in: path name: projectsId @@ -9399,24 +9892,29 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:read: + /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:partitionRead: parameters: *ref_1 post: - description: >- - Reads rows from the database using key lookups and scans, as a simple - key/value style alternative to ExecuteSql. This method cannot be used to - return a result set larger than 10 MiB; if the read matches more data - than that, the read fails with a `FAILED_PRECONDITION` error. Reads - inside read-write transactions might return `ABORTED`. If this occurs, - the application should restart the transaction from the beginning. See - Transaction for more details. Larger result sets can be yielded in - streaming fashion by calling StreamingRead instead. - operationId: spanner.projects.instances.databases.sessions.read + description: >- + Creates a set of partition tokens that can be used to execute a read + operation in parallel. Each of the returned partition tokens can be used + by StreamingRead to specify a subset of the read result to read. The + same session and read-only transaction must be used by the + `PartitionReadRequest` used to create the partition tokens and the + `ReadRequests` that use the partition tokens. There are no ordering + guarantees on rows returned among the returned partition tokens, or even + within each individual `StreamingRead` call issued with a + `partition_token`. Partition tokens become invalid when the session used + to create them is deleted, is idle for too long, begins a new + transaction, or becomes too old. When any of these happen, it isn't + possible to resume the read, and the whole operation must be restarted + from the beginning. + operationId: spanner.projects.instances.databases.sessions.partitionRead requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadRequest' + $ref: '#/components/schemas/PartitionReadRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9432,7 +9930,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ResultSet' + $ref: '#/components/schemas/PartitionResponse' parameters: - in: path name: projectsId @@ -9454,20 +9952,30 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:streamingRead: + /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:batchWrite: parameters: *ref_1 post: description: >- - Like Read, except returns the result set as a stream. Unlike Read, there - is no limit on the size of the returned result set. However, no - individual row in the result set can exceed 100 MiB, and no column value - can exceed 10 MiB. - operationId: spanner.projects.instances.databases.sessions.streamingRead + Batches the supplied mutation groups in a collection of efficient + transactions. All mutations in a group are committed atomically. + However, mutations across groups can be committed non-atomically in an + unspecified order and thus, they must be independent of each other. + Partial failure is possible, that is, some groups might have been + committed successfully, while some might have failed. The results of + individual batches are streamed into the response as the batches are + applied. `BatchWrite` requests are not replay protected, meaning that + each mutation group can be applied more than once. Replays of + non-idempotent mutations can have undesirable effects. For example, + replays of an insert mutation can produce an already exists error or if + you use generated or commit timestamp-based keys, it can result in + additional rows being added to the mutation's table. We recommend + structuring your mutation groups to be idempotent to avoid this issue. + operationId: spanner.projects.instances.databases.sessions.batchWrite requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReadRequest' + $ref: '#/components/schemas/BatchWriteRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9483,7 +9991,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PartialResultSet' + $ref: '#/components/schemas/BatchWriteResponse' parameters: - in: path name: projectsId @@ -9505,34 +10013,38 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:beginTransaction: + /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}:setIamPolicy: parameters: *ref_1 post: description: >- - Begins a new transaction. This step can often be skipped: Read, - ExecuteSql and Commit can begin a new transaction as a side-effect. - operationId: spanner.projects.instances.databases.sessions.beginTransaction + Sets the access control policy on a database or backup resource. + Replaces any existing policy. Authorization requires + `spanner.databases.setIamPolicy` permission on resource. For backups, + authorization requires `spanner.backups.setIamPolicy` permission on + resource. For backup schedules, authorization requires + `spanner.backupSchedules.setIamPolicy` permission on resource. + operationId: spanner.projects.instances.databases.backupSchedules.setIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/BeginTransactionRequest' + $ref: '#/components/schemas/SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - - https://www.googleapis.com/auth/spanner.data + - https://www.googleapis.com/auth/spanner.admin Oauth2c: - - https://www.googleapis.com/auth/spanner.data + - https://www.googleapis.com/auth/spanner.admin responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Transaction' + $ref: '#/components/schemas/Policy' parameters: - in: path name: projectsId @@ -9550,47 +10062,43 @@ paths: schema: type: string - in: path - name: sessionsId + name: backupSchedulesId required: true schema: type: string - /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:commit: + /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}:getIamPolicy: parameters: *ref_1 post: description: >- - Commits a transaction. The request includes the mutations to be applied - to rows in the database. `Commit` might return an `ABORTED` error. This - can occur at any time; commonly, the cause is conflicts with concurrent - transactions. However, it can also happen for a variety of other - reasons. If `Commit` returns `ABORTED`, the caller should re-attempt the - transaction from the beginning, re-using the same session. On very rare - occasions, `Commit` might return `UNKNOWN`. This can happen, for - example, if the client job experiences a 1+ hour networking failure. At - that point, Cloud Spanner has lost track of the transaction outcome and - we recommend that you perform another read from the database to see the - state of things as they are now. - operationId: spanner.projects.instances.databases.sessions.commit + Gets the access control policy for a database or backup resource. + Returns an empty policy if a database or backup exists but does not have + a policy set. Authorization requires `spanner.databases.getIamPolicy` + permission on resource. For backups, authorization requires + `spanner.backups.getIamPolicy` permission on resource. For backup + schedules, authorization requires `spanner.backupSchedules.getIamPolicy` + permission on resource. + operationId: spanner.projects.instances.databases.backupSchedules.getIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/CommitRequest' + $ref: '#/components/schemas/GetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - - https://www.googleapis.com/auth/spanner.data + - https://www.googleapis.com/auth/spanner.admin Oauth2c: - - https://www.googleapis.com/auth/spanner.data + - https://www.googleapis.com/auth/spanner.admin responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/CommitResponse' + $ref: '#/components/schemas/Policy' parameters: - in: path name: projectsId @@ -9608,42 +10116,46 @@ paths: schema: type: string - in: path - name: sessionsId + name: backupSchedulesId required: true schema: type: string - /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:rollback: + /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}:testIamPermissions: parameters: *ref_1 post: description: >- - Rolls back a transaction, releasing any locks it holds. It is a good - idea to call this for any transaction that includes one or more Read or - ExecuteSql requests and ultimately decides not to commit. `Rollback` - returns `OK` if it successfully aborts the transaction, the transaction - was already aborted, or the transaction is not found. `Rollback` never - returns `ABORTED`. - operationId: spanner.projects.instances.databases.sessions.rollback + Returns permissions that the caller has on the specified database or + backup resource. Attempting this RPC on a non-existent Cloud Spanner + database will result in a NOT_FOUND error if the user has + `spanner.databases.list` permission on the containing Cloud Spanner + instance. Otherwise returns an empty set of permissions. Calling this + method on a backup that does not exist will result in a NOT_FOUND error + if the user has `spanner.backups.list` permission on the containing + instance. Calling this method on a backup schedule that does not exist + will result in a NOT_FOUND error if the user has + `spanner.backupSchedules.list` permission on the containing database. + operationId: spanner.projects.instances.databases.backupSchedules.testIamPermissions requestBody: content: application/json: schema: - $ref: '#/components/schemas/RollbackRequest' + $ref: '#/components/schemas/TestIamPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - - https://www.googleapis.com/auth/spanner.data + - https://www.googleapis.com/auth/spanner.admin Oauth2c: - - https://www.googleapis.com/auth/spanner.data + - https://www.googleapis.com/auth/spanner.admin responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/TestIamPermissionsResponse' parameters: - in: path name: projectsId @@ -9661,46 +10173,36 @@ paths: schema: type: string - in: path - name: sessionsId + name: backupSchedulesId required: true schema: type: string - /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:partitionQuery: + /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules: parameters: *ref_1 post: - description: >- - Creates a set of partition tokens that can be used to execute a query - operation in parallel. Each of the returned partition tokens can be used - by ExecuteStreamingSql to specify a subset of the query result to read. - The same session and read-only transaction must be used by the - PartitionQueryRequest used to create the partition tokens and the - ExecuteSqlRequests that use the partition tokens. Partition tokens - become invalid when the session used to create them is deleted, is idle - for too long, begins a new transaction, or becomes too old. When any of - these happen, it is not possible to resume the query, and the whole - operation must be restarted from the beginning. - operationId: spanner.projects.instances.databases.sessions.partitionQuery + description: Creates a new backup schedule. + operationId: spanner.projects.instances.databases.backupSchedules.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/PartitionQueryRequest' + $ref: '#/components/schemas/BackupSchedule' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - - https://www.googleapis.com/auth/spanner.data + - https://www.googleapis.com/auth/spanner.admin Oauth2c: - - https://www.googleapis.com/auth/spanner.data + - https://www.googleapis.com/auth/spanner.admin responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/PartitionResponse' + $ref: '#/components/schemas/BackupSchedule' parameters: - in: path name: projectsId @@ -9717,49 +10219,29 @@ paths: required: true schema: type: string - - in: path - name: sessionsId - required: true + - in: query + name: backupScheduleId schema: type: string - /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:partitionRead: - parameters: *ref_1 - post: - description: >- - Creates a set of partition tokens that can be used to execute a read - operation in parallel. Each of the returned partition tokens can be used - by StreamingRead to specify a subset of the read result to read. The - same session and read-only transaction must be used by the - PartitionReadRequest used to create the partition tokens and the - ReadRequests that use the partition tokens. There are no ordering - guarantees on rows returned among the returned partition tokens, or even - within each individual StreamingRead call issued with a partition_token. - Partition tokens become invalid when the session used to create them is - deleted, is idle for too long, begins a new transaction, or becomes too - old. When any of these happen, it is not possible to resume the read, - and the whole operation must be restarted from the beginning. - operationId: spanner.projects.instances.databases.sessions.partitionRead - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PartitionReadRequest' + get: + description: Lists all the backup schedules for the database. + operationId: spanner.projects.instances.databases.backupSchedules.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - - https://www.googleapis.com/auth/spanner.data + - https://www.googleapis.com/auth/spanner.admin Oauth2c: - - https://www.googleapis.com/auth/spanner.data + - https://www.googleapis.com/auth/spanner.admin responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/PartitionResponse' + $ref: '#/components/schemas/ListBackupSchedulesResponse' parameters: - in: path name: projectsId @@ -9776,51 +10258,36 @@ paths: required: true schema: type: string - - in: path - name: sessionsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:batchWrite: + /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}: parameters: *ref_1 - post: - description: >- - Batches the supplied mutation groups in a collection of efficient - transactions. All mutations in a group are committed atomically. - However, mutations across groups can be committed non-atomically in an - unspecified order and thus, they must be independent of each other. - Partial failure is possible, i.e., some groups may have been committed - successfully, while some may have failed. The results of individual - batches are streamed into the response as the batches are applied. - BatchWrite requests are not replay protected, meaning that each mutation - group may be applied more than once. Replays of non-idempotent mutations - may have undesirable effects. For example, replays of an insert mutation - may produce an already exists error or if you use generated or commit - timestamp-based keys, it may result in additional rows being added to - the mutation's table. We recommend structuring your mutation groups to - be idempotent to avoid this issue. - operationId: spanner.projects.instances.databases.sessions.batchWrite - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/BatchWriteRequest' + get: + description: Gets backup schedule for the input schedule name. + operationId: spanner.projects.instances.databases.backupSchedules.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - - https://www.googleapis.com/auth/spanner.data + - https://www.googleapis.com/auth/spanner.admin Oauth2c: - - https://www.googleapis.com/auth/spanner.data + - https://www.googleapis.com/auth/spanner.admin responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/BatchWriteResponse' + $ref: '#/components/schemas/BackupSchedule' parameters: - in: path name: projectsId @@ -9838,17 +10305,18 @@ paths: schema: type: string - in: path - name: sessionsId + name: backupSchedulesId required: true schema: type: string - /v1/projects/{projectsId}/instances/{instancesId}/operations: - parameters: *ref_1 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: spanner.projects.instances.operations.list + patch: + description: Updates a backup schedule. + operationId: spanner.projects.instances.databases.backupSchedules.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BackupSchedule' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9864,7 +10332,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListOperationsResponse' + $ref: '#/components/schemas/BackupSchedule' parameters: - in: path name: projectsId @@ -9876,27 +10344,24 @@ paths: required: true schema: type: string - - in: query - name: filter + - in: path + name: databasesId + required: true schema: type: string - - in: query - name: pageSize + - in: path + name: backupSchedulesId + required: true schema: - type: integer - format: int32 + type: string - in: query - name: pageToken + name: updateMask schema: type: string - /v1/projects/{projectsId}/instances/{instancesId}/operations/{operationsId}: - parameters: *ref_1 - get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: spanner.projects.instances.operations.get + format: google-fieldmask + delete: + description: Deletes a backup schedule. + operationId: spanner.projects.instances.databases.backupSchedules.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9912,7 +10377,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Empty' parameters: - in: path name: projectsId @@ -9925,17 +10390,35 @@ paths: schema: type: string - in: path - name: operationsId + name: databasesId required: true schema: type: string - delete: + - in: path + name: backupSchedulesId + required: true + schema: + type: string + /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/databaseRoles/{databaseRolesId}:testIamPermissions: + parameters: *ref_1 + post: description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: spanner.projects.instances.operations.delete + Returns permissions that the caller has on the specified database or + backup resource. Attempting this RPC on a non-existent Cloud Spanner + database will result in a NOT_FOUND error if the user has + `spanner.databases.list` permission on the containing Cloud Spanner + instance. Otherwise returns an empty set of permissions. Calling this + method on a backup that does not exist will result in a NOT_FOUND error + if the user has `spanner.backups.list` permission on the containing + instance. Calling this method on a backup schedule that does not exist + will result in a NOT_FOUND error if the user has + `spanner.backupSchedules.list` permission on the containing database. + operationId: spanner.projects.instances.databases.databaseRoles.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9951,7 +10434,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/TestIamPermissionsResponse' parameters: - in: path name: projectsId @@ -9964,24 +10447,20 @@ paths: schema: type: string - in: path - name: operationsId + name: databasesId required: true schema: type: string - /v1/projects/{projectsId}/instances/{instancesId}/operations/{operationsId}:cancel: + - in: path + name: databaseRolesId + required: true + schema: + type: string + /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/databaseRoles: parameters: *ref_1 - post: - description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: spanner.projects.instances.operations.cancel + get: + description: Lists Cloud Spanner database roles. + operationId: spanner.projects.instances.databases.databaseRoles.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9997,7 +10476,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/ListDatabaseRolesResponse' parameters: - in: path name: projectsId @@ -10010,26 +10489,26 @@ paths: schema: type: string - in: path - name: operationsId + name: databasesId required: true schema: type: string - /v1/projects/{projectsId}/instances/{instancesId}/backups/{backupsId}:setIamPolicy: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/instances/{instancesId}/operations: parameters: *ref_1 - post: + get: description: >- - Sets the access control policy on a database or backup resource. - Replaces any existing policy. Authorization requires - `spanner.databases.setIamPolicy` permission on resource. For backups, - authorization requires `spanner.backups.setIamPolicy` permission on - resource. For backup schedules, authorization requires - `spanner.backupSchedules.setIamPolicy` permission on resource. - operationId: spanner.projects.instances.backups.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SetIamPolicyRequest' + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: spanner.projects.instances.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10045,7 +10524,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/ListOperationsResponse' parameters: - in: path name: projectsId @@ -10057,28 +10536,27 @@ paths: required: true schema: type: string - - in: path - name: backupsId - required: true + - in: query + name: filter schema: type: string - /v1/projects/{projectsId}/instances/{instancesId}/backups/{backupsId}:getIamPolicy: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/instances/{instancesId}/operations/{operationsId}: parameters: *ref_1 - post: + get: description: >- - Gets the access control policy for a database or backup resource. - Returns an empty policy if a database or backup exists but does not have - a policy set. Authorization requires `spanner.databases.getIamPolicy` - permission on resource. For backups, authorization requires - `spanner.backups.getIamPolicy` permission on resource. For backup - schedules, authorization requires `spanner.backupSchedules.getIamPolicy` - permission on resource. - operationId: spanner.projects.instances.backups.getIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GetIamPolicyRequest' + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: spanner.projects.instances.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10094,7 +10572,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -10107,30 +10585,17 @@ paths: schema: type: string - in: path - name: backupsId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/instances/{instancesId}/backups/{backupsId}:testIamPermissions: - parameters: *ref_1 - post: + delete: description: >- - Returns permissions that the caller has on the specified database or - backup resource. Attempting this RPC on a non-existent Cloud Spanner - database will result in a NOT_FOUND error if the user has - `spanner.databases.list` permission on the containing Cloud Spanner - instance. Otherwise returns an empty set of permissions. Calling this - method on a backup that does not exist will result in a NOT_FOUND error - if the user has `spanner.backups.list` permission on the containing - instance. Calling this method on a backup schedule that does not exist - will result in a NOT_FOUND error if the user has - `spanner.backupSchedules.list` permission on the containing database. - operationId: spanner.projects.instances.backups.testIamPermissions - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TestIamPermissionsRequest' + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: spanner.projects.instances.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10146,7 +10611,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TestIamPermissionsResponse' + $ref: '#/components/schemas/Empty' parameters: - in: path name: projectsId @@ -10159,28 +10624,24 @@ paths: schema: type: string - in: path - name: backupsId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/instances/{instancesId}/backups: + /v1/projects/{projectsId}/instances/{instancesId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- - Starts creating a new Cloud Spanner Backup. The returned backup - long-running operation will have a name of the format - `projects//instances//backups//operations/` and can be used to track - creation of the backup. The metadata field type is CreateBackupMetadata. - The response field type is Backup, if successful. Cancelling the - returned operation will stop the creation and delete the backup. There - can be only one pending backup creation per database. Backup creation of - different databases can run concurrently. - operationId: spanner.projects.instances.backups.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Backup' + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + `1`, corresponding to `Code.CANCELLED`. + operationId: spanner.projects.instances.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10196,7 +10657,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Empty' parameters: - in: path name: projectsId @@ -10208,28 +10669,16 @@ paths: required: true schema: type: string - - in: query - name: backupId - schema: - type: string - - in: query - name: encryptionConfig.encryptionType - schema: - type: string - - in: query - name: encryptionConfig.kmsKeyName - schema: - type: string - - in: query - name: encryptionConfig.kmsKeyNames + - in: path + name: operationsId + required: true schema: type: string + /v1/projects/{projectsId}/instances/{instancesId}/instancePartitions: + parameters: *ref_1 get: - description: >- - Lists completed and pending backups. Backups returned are ordered by - `create_time` in descending order, starting from the most recent - `create_time`. - operationId: spanner.projects.instances.backups.list + description: Lists all instance partitions for the given instance. + operationId: spanner.projects.instances.instancePartitions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10245,7 +10694,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListBackupsResponse' + $ref: '#/components/schemas/ListInstancePartitionsResponse' parameters: - in: path name: projectsId @@ -10257,10 +10706,6 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - in: query name: pageSize schema: @@ -10270,24 +10715,39 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/instances/{instancesId}/backups:copy: - parameters: *ref_1 + - in: query + name: instancePartitionDeadline + schema: + type: string + format: google-datetime post: description: >- - Starts copying a Cloud Spanner Backup. The returned backup long-running - operation will have a name of the format - `projects//instances//backups//operations/` and can be used to track - copying of the backup. The operation is associated with the destination - backup. The metadata field type is CopyBackupMetadata. The response - field type is Backup, if successful. Cancelling the returned operation - will stop the copying and delete the destination backup. Concurrent - CopyBackup requests can run on the same source backup. - operationId: spanner.projects.instances.backups.copy + Creates an instance partition and begins preparing it to be used. The + returned long-running operation can be used to track the progress of + preparing the new instance partition. The instance partition name is + assigned by the caller. If the named instance partition already exists, + `CreateInstancePartition` returns `ALREADY_EXISTS`. Immediately upon + completion of this request: * The instance partition is readable via the + API, with all requested attributes but no allocated resources. Its state + is `CREATING`. Until completion of the returned operation: * Cancelling + the operation renders the instance partition immediately unreadable via + the API. * The instance partition can be deleted. * All other attempts + to modify the instance partition are rejected. Upon completion of the + returned operation: * Billing for all successfully-allocated resources + begins (some types may have lower than the requested levels). * + Databases can start using this instance partition. * The instance + partition's allocated resource levels are readable via the API. * The + instance partition's state becomes `READY`. The returned long-running + operation will have a name of the format `/operations/` and can be used + to track creation of the instance partition. The metadata field type is + CreateInstancePartitionMetadata. The response field type is + InstancePartition, if successful. + operationId: spanner.projects.instances.instancePartitions.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/CopyBackupRequest' + $ref: '#/components/schemas/CreateInstancePartitionRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10315,11 +10775,11 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/instances/{instancesId}/backups/{backupsId}: + /v1/projects/{projectsId}/instances/{instancesId}/instancePartitions/{instancePartitionsId}: parameters: *ref_1 get: - description: Gets metadata on a pending or completed Backup. - operationId: spanner.projects.instances.backups.get + description: Gets information about a particular instance partition. + operationId: spanner.projects.instances.instancePartitions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10335,7 +10795,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Backup' + $ref: '#/components/schemas/InstancePartition' parameters: - in: path name: projectsId @@ -10348,18 +10808,17 @@ paths: schema: type: string - in: path - name: backupsId + name: instancePartitionsId required: true schema: type: string - patch: - description: Updates a pending or completed Backup. - operationId: spanner.projects.instances.backups.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Backup' + delete: + description: >- + Deletes an existing instance partition. Requires that the instance + partition is not used by any database or backup and is not the default + instance partition of an instance. Authorization requires + `spanner.instancePartitions.delete` permission on the resource name. + operationId: spanner.projects.instances.instancePartitions.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10375,7 +10834,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Backup' + $ref: '#/components/schemas/Empty' parameters: - in: path name: projectsId @@ -10388,18 +10847,45 @@ paths: schema: type: string - in: path - name: backupsId + name: instancePartitionsId required: true schema: type: string - in: query - name: updateMask + name: etag schema: type: string - format: google-fieldmask - delete: - description: Deletes a pending or completed Backup. - operationId: spanner.projects.instances.backups.delete + patch: + description: >- + Updates an instance partition, and begins allocating or releasing + resources as requested. The returned long-running operation can be used + to track the progress of updating the instance partition. If the named + instance partition does not exist, returns `NOT_FOUND`. Immediately upon + completion of this request: * For resource types for which a decrease in + the instance partition's allocation has been requested, billing is based + on the newly-requested level. Until completion of the returned + operation: * Cancelling the operation sets its metadata's cancel_time, + and begins restoring resources to their pre-request values. The + operation is guaranteed to succeed at undoing all resource changes, + after which point it terminates with a `CANCELLED` status. * All other + attempts to modify the instance partition are rejected. * Reading the + instance partition via the API continues to give the pre-request + resource levels. Upon completion of the returned operation: * Billing + begins for all successfully-allocated resources (some types may have + lower than the requested levels). * All newly-reserved resources are + available for serving the instance partition's tables. * The instance + partition's new resource levels are readable via the API. The returned + long-running operation will have a name of the format `/operations/` and + can be used to track the instance partition modification. The metadata + field type is UpdateInstancePartitionMetadata. The response field type + is InstancePartition, if successful. Authorization requires + `spanner.instancePartitions.update` permission on the resource name. + operationId: spanner.projects.instances.instancePartitions.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateInstancePartitionRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10415,7 +10901,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -10428,17 +10914,17 @@ paths: schema: type: string - in: path - name: backupsId + name: instancePartitionsId required: true schema: type: string - /v1/projects/{projectsId}/instances/{instancesId}/backups/{backupsId}/operations: + /v1/projects/{projectsId}/instances/{instancesId}/instancePartitions/{instancePartitionsId}/operations: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: spanner.projects.instances.backups.operations.list + operationId: spanner.projects.instances.instancePartitions.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10467,7 +10953,7 @@ paths: schema: type: string - in: path - name: backupsId + name: instancePartitionsId required: true schema: type: string @@ -10484,14 +10970,14 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/instances/{instancesId}/backups/{backupsId}/operations/{operationsId}: + /v1/projects/{projectsId}/instances/{instancesId}/instancePartitions/{instancePartitionsId}/operations/{operationsId}: parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - operationId: spanner.projects.instances.backups.operations.get + operationId: spanner.projects.instances.instancePartitions.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10520,7 +11006,7 @@ paths: schema: type: string - in: path - name: backupsId + name: instancePartitionsId required: true schema: type: string @@ -10535,7 +11021,7 @@ paths: is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. - operationId: spanner.projects.instances.backups.operations.delete + operationId: spanner.projects.instances.instancePartitions.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10564,7 +11050,7 @@ paths: schema: type: string - in: path - name: backupsId + name: instancePartitionsId required: true schema: type: string @@ -10573,7 +11059,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/instances/{instancesId}/backups/{backupsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/instances/{instancesId}/instancePartitions/{instancePartitionsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- @@ -10585,8 +11071,8 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: spanner.projects.instances.backups.operations.cancel + `1`, corresponding to `Code.CANCELLED`. + operationId: spanner.projects.instances.instancePartitions.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10615,7 +11101,7 @@ paths: schema: type: string - in: path - name: backupsId + name: instancePartitionsId required: true schema: type: string @@ -10624,17 +11110,22 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/instances/{instancesId}/databaseOperations: + /v1/projects/{projectsId}/instances/{instancesId}/instancePartitionOperations: parameters: *ref_1 get: description: >- - Lists database longrunning-operations. A database operation has a name - of the form `projects//instances//databases//operations/`. The - long-running operation metadata field type `metadata.type_url` describes - the type of the metadata. Operations returned include those that have + Lists instance partition long-running operations in the given instance. + An instance partition operation has a name of the form + `projects//instances//instancePartitions//operations/`. The long-running + operation metadata field type `metadata.type_url` describes the type of + the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending - operations. - operationId: spanner.projects.instances.databaseOperations.list + operations. Operations returned are ordered by + `operation.metadata.value.start_time` in descending order starting from + the most recently started operation. Authorization requires + `spanner.instancePartitionOperations.list` permission on the resource + parent. + operationId: spanner.projects.instances.instancePartitionOperations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10650,7 +11141,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListDatabaseOperationsResponse' + $ref: '#/components/schemas/ListInstancePartitionOperationsResponse' parameters: - in: path name: projectsId @@ -10675,20 +11166,178 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/instances/{instancesId}/backupOperations: + - in: query + name: instancePartitionDeadline + schema: + type: string + format: google-datetime + /v1/projects/{projectsId}/instances/{instancesId}/backups/{backupsId}:setIamPolicy: parameters: *ref_1 - get: + post: description: >- - Lists the backup long-running operations in the given instance. A backup - operation has a name of the form - `projects//instances//backups//operations/`. The long-running operation - metadata field type `metadata.type_url` describes the type of the - metadata. Operations returned include those that have - completed/failed/canceled within the last 7 days, and pending - operations. Operations returned are ordered by - `operation.metadata.value.progress.start_time` in descending order - starting from the most recently started operation. - operationId: spanner.projects.instances.backupOperations.list + Sets the access control policy on a database or backup resource. + Replaces any existing policy. Authorization requires + `spanner.databases.setIamPolicy` permission on resource. For backups, + authorization requires `spanner.backups.setIamPolicy` permission on + resource. For backup schedules, authorization requires + `spanner.backupSchedules.setIamPolicy` permission on resource. + operationId: spanner.projects.instances.backups.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetIamPolicyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/spanner.admin + Oauth2c: + - https://www.googleapis.com/auth/spanner.admin + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + - in: path + name: backupsId + required: true + schema: + type: string + /v1/projects/{projectsId}/instances/{instancesId}/backups/{backupsId}:getIamPolicy: + parameters: *ref_1 + post: + description: >- + Gets the access control policy for a database or backup resource. + Returns an empty policy if a database or backup exists but does not have + a policy set. Authorization requires `spanner.databases.getIamPolicy` + permission on resource. For backups, authorization requires + `spanner.backups.getIamPolicy` permission on resource. For backup + schedules, authorization requires `spanner.backupSchedules.getIamPolicy` + permission on resource. + operationId: spanner.projects.instances.backups.getIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetIamPolicyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/spanner.admin + Oauth2c: + - https://www.googleapis.com/auth/spanner.admin + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + - in: path + name: backupsId + required: true + schema: + type: string + /v1/projects/{projectsId}/instances/{instancesId}/backups/{backupsId}:testIamPermissions: + parameters: *ref_1 + post: + description: >- + Returns permissions that the caller has on the specified database or + backup resource. Attempting this RPC on a non-existent Cloud Spanner + database will result in a NOT_FOUND error if the user has + `spanner.databases.list` permission on the containing Cloud Spanner + instance. Otherwise returns an empty set of permissions. Calling this + method on a backup that does not exist will result in a NOT_FOUND error + if the user has `spanner.backups.list` permission on the containing + instance. Calling this method on a backup schedule that does not exist + will result in a NOT_FOUND error if the user has + `spanner.backupSchedules.list` permission on the containing database. + operationId: spanner.projects.instances.backups.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/spanner.admin + Oauth2c: + - https://www.googleapis.com/auth/spanner.admin + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + - in: path + name: backupsId + required: true + schema: + type: string + /v1/projects/{projectsId}/instances/{instancesId}/backups: + parameters: *ref_1 + post: + description: >- + Starts creating a new Cloud Spanner Backup. The returned backup + long-running operation will have a name of the format + `projects//instances//backups//operations/` and can be used to track + creation of the backup. The metadata field type is CreateBackupMetadata. + The response field type is Backup, if successful. Cancelling the + returned operation will stop the creation and delete the backup. There + can be only one pending backup creation per database. Backup creation of + different databases can run concurrently. + operationId: spanner.projects.instances.backups.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Backup' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10704,7 +11353,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListBackupOperationsResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -10717,23 +11366,27 @@ paths: schema: type: string - in: query - name: filter + name: backupId schema: type: string - in: query - name: pageSize + name: encryptionConfig.encryptionType schema: - type: integer - format: int32 + type: string - in: query - name: pageToken + name: encryptionConfig.kmsKeyName + schema: + type: string + - in: query + name: encryptionConfig.kmsKeyNames schema: type: string - /v1/projects/{projectsId}/instances/{instancesId}/instancePartitions: - parameters: *ref_1 get: - description: Lists all instance partitions for the given instance. - operationId: spanner.projects.instances.instancePartitions.list + description: >- + Lists completed and pending backups. Backups returned are ordered by + `create_time` in descending order, starting from the most recent + `create_time`. + operationId: spanner.projects.instances.backups.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10749,7 +11402,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListInstancePartitionsResponse' + $ref: '#/components/schemas/ListBackupsResponse' parameters: - in: path name: projectsId @@ -10761,6 +11414,10 @@ paths: required: true schema: type: string + - in: query + name: filter + schema: + type: string - in: query name: pageSize schema: @@ -10770,39 +11427,24 @@ paths: name: pageToken schema: type: string - - in: query - name: instancePartitionDeadline - schema: - type: string - format: google-datetime + /v1/projects/{projectsId}/instances/{instancesId}/backups:copy: + parameters: *ref_1 post: description: >- - Creates an instance partition and begins preparing it to be used. The - returned long-running operation can be used to track the progress of - preparing the new instance partition. The instance partition name is - assigned by the caller. If the named instance partition already exists, - `CreateInstancePartition` returns `ALREADY_EXISTS`. Immediately upon - completion of this request: * The instance partition is readable via the - API, with all requested attributes but no allocated resources. Its state - is `CREATING`. Until completion of the returned operation: * Cancelling - the operation renders the instance partition immediately unreadable via - the API. * The instance partition can be deleted. * All other attempts - to modify the instance partition are rejected. Upon completion of the - returned operation: * Billing for all successfully-allocated resources - begins (some types may have lower than the requested levels). * - Databases can start using this instance partition. * The instance - partition's allocated resource levels are readable via the API. * The - instance partition's state becomes `READY`. The returned long-running - operation will have a name of the format `/operations/` and can be used - to track creation of the instance partition. The metadata field type is - CreateInstancePartitionMetadata. The response field type is - InstancePartition, if successful. - operationId: spanner.projects.instances.instancePartitions.create + Starts copying a Cloud Spanner Backup. The returned backup long-running + operation will have a name of the format + `projects//instances//backups//operations/` and can be used to track + copying of the backup. The operation is associated with the destination + backup. The metadata field type is CopyBackupMetadata. The response + field type is Backup, if successful. Cancelling the returned operation + will stop the copying and delete the destination backup. Concurrent + CopyBackup requests can run on the same source backup. + operationId: spanner.projects.instances.backups.copy requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateInstancePartitionRequest' + $ref: '#/components/schemas/CopyBackupRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10830,11 +11472,11 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/instances/{instancesId}/instancePartitions/{instancePartitionsId}: + /v1/projects/{projectsId}/instances/{instancesId}/backups/{backupsId}: parameters: *ref_1 get: - description: Gets information about a particular instance partition. - operationId: spanner.projects.instances.instancePartitions.get + description: Gets metadata on a pending or completed Backup. + operationId: spanner.projects.instances.backups.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10850,7 +11492,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InstancePartition' + $ref: '#/components/schemas/Backup' parameters: - in: path name: projectsId @@ -10863,17 +11505,18 @@ paths: schema: type: string - in: path - name: instancePartitionsId + name: backupsId required: true schema: type: string - delete: - description: >- - Deletes an existing instance partition. Requires that the instance - partition is not used by any database or backup and is not the default - instance partition of an instance. Authorization requires - `spanner.instancePartitions.delete` permission on the resource name. - operationId: spanner.projects.instances.instancePartitions.delete + patch: + description: Updates a pending or completed Backup. + operationId: spanner.projects.instances.backups.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Backup' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10889,7 +11532,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/Backup' parameters: - in: path name: projectsId @@ -10902,45 +11545,18 @@ paths: schema: type: string - in: path - name: instancePartitionsId + name: backupsId required: true schema: type: string - in: query - name: etag + name: updateMask schema: type: string - patch: - description: >- - Updates an instance partition, and begins allocating or releasing - resources as requested. The returned long-running operation can be used - to track the progress of updating the instance partition. If the named - instance partition does not exist, returns `NOT_FOUND`. Immediately upon - completion of this request: * For resource types for which a decrease in - the instance partition's allocation has been requested, billing is based - on the newly-requested level. Until completion of the returned - operation: * Cancelling the operation sets its metadata's cancel_time, - and begins restoring resources to their pre-request values. The - operation is guaranteed to succeed at undoing all resource changes, - after which point it terminates with a `CANCELLED` status. * All other - attempts to modify the instance partition are rejected. * Reading the - instance partition via the API continues to give the pre-request - resource levels. Upon completion of the returned operation: * Billing - begins for all successfully-allocated resources (some types may have - lower than the requested levels). * All newly-reserved resources are - available for serving the instance partition's tables. * The instance - partition's new resource levels are readable via the API. The returned - long-running operation will have a name of the format `/operations/` and - can be used to track the instance partition modification. The metadata - field type is UpdateInstancePartitionMetadata. The response field type - is InstancePartition, if successful. Authorization requires - `spanner.instancePartitions.update` permission on the resource name. - operationId: spanner.projects.instances.instancePartitions.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/UpdateInstancePartitionRequest' + format: google-fieldmask + delete: + description: Deletes a pending or completed Backup. + operationId: spanner.projects.instances.backups.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10956,7 +11572,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Empty' parameters: - in: path name: projectsId @@ -10969,17 +11585,17 @@ paths: schema: type: string - in: path - name: instancePartitionsId + name: backupsId required: true schema: type: string - /v1/projects/{projectsId}/instances/{instancesId}/instancePartitions/{instancePartitionsId}/operations: + /v1/projects/{projectsId}/instances/{instancesId}/backups/{backupsId}/operations: parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: spanner.projects.instances.instancePartitions.operations.list + operationId: spanner.projects.instances.backups.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11008,7 +11624,7 @@ paths: schema: type: string - in: path - name: instancePartitionsId + name: backupsId required: true schema: type: string @@ -11025,14 +11641,14 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/instances/{instancesId}/instancePartitions/{instancePartitionsId}/operations/{operationsId}: + /v1/projects/{projectsId}/instances/{instancesId}/backups/{backupsId}/operations/{operationsId}: parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - operationId: spanner.projects.instances.instancePartitions.operations.get + operationId: spanner.projects.instances.backups.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11061,7 +11677,7 @@ paths: schema: type: string - in: path - name: instancePartitionsId + name: backupsId required: true schema: type: string @@ -11076,7 +11692,7 @@ paths: is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. - operationId: spanner.projects.instances.instancePartitions.operations.delete + operationId: spanner.projects.instances.backups.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11105,7 +11721,7 @@ paths: schema: type: string - in: path - name: instancePartitionsId + name: backupsId required: true schema: type: string @@ -11114,7 +11730,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/instances/{instancesId}/instancePartitions/{instancePartitionsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/instances/{instancesId}/backups/{backupsId}/operations/{operationsId}:cancel: parameters: *ref_1 post: description: >- @@ -11126,8 +11742,8 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: spanner.projects.instances.instancePartitions.operations.cancel + `1`, corresponding to `Code.CANCELLED`. + operationId: spanner.projects.instances.backups.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11156,7 +11772,7 @@ paths: schema: type: string - in: path - name: instancePartitionsId + name: backupsId required: true schema: type: string @@ -11165,22 +11781,17 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/instances/{instancesId}/instancePartitionOperations: + /v1/projects/{projectsId}/instances/{instancesId}/databaseOperations: parameters: *ref_1 get: description: >- - Lists instance partition long-running operations in the given instance. - An instance partition operation has a name of the form - `projects//instances//instancePartitions//operations/`. The long-running - operation metadata field type `metadata.type_url` describes the type of - the metadata. Operations returned include those that have + Lists database longrunning-operations. A database operation has a name + of the form `projects//instances//databases//operations/`. The + long-running operation metadata field type `metadata.type_url` describes + the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending - operations. Operations returned are ordered by - `operation.metadata.value.start_time` in descending order starting from - the most recently started operation. Authorization requires - `spanner.instancePartitionOperations.list` permission on the resource - parent. - operationId: spanner.projects.instances.instancePartitionOperations.list + operations. + operationId: spanner.projects.instances.databaseOperations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11196,7 +11807,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListInstancePartitionOperationsResponse' + $ref: '#/components/schemas/ListDatabaseOperationsResponse' parameters: - in: path name: projectsId @@ -11221,8 +11832,57 @@ paths: name: pageToken schema: type: string + /v1/projects/{projectsId}/instances/{instancesId}/backupOperations: + parameters: *ref_1 + get: + description: >- + Lists the backup long-running operations in the given instance. A backup + operation has a name of the form + `projects//instances//backups//operations/`. The long-running operation + metadata field type `metadata.type_url` describes the type of the + metadata. Operations returned include those that have + completed/failed/canceled within the last 7 days, and pending + operations. Operations returned are ordered by + `operation.metadata.value.progress.start_time` in descending order + starting from the most recently started operation. + operationId: spanner.projects.instances.backupOperations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/spanner.admin + Oauth2c: + - https://www.googleapis.com/auth/spanner.admin + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListBackupOperationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string - in: query - name: instancePartitionDeadline + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - format: google-datetime diff --git a/providers/src/googleapis.com/v00.00.00000/services/speech.yaml b/providers/src/googleapis.com/v00.00.00000/services/speech.yaml index 112579e3..753b6b2f 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/speech.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/speech.yaml @@ -7,8 +7,8 @@ info: title: Cloud Speech-to-Text API description: Converts audio to text by applying powerful neural network models. version: v1 - x-discovery-doc-revision: '20241024' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250814' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/speech-to-text/docs/quickstart-protocol servers: diff --git a/providers/src/googleapis.com/v00.00.00000/services/sqladmin.yaml b/providers/src/googleapis.com/v00.00.00000/services/sqladmin.yaml index 2c287c86..aaf88088 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/sqladmin.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/sqladmin.yaml @@ -7,8 +7,8 @@ info: title: Cloud SQL Admin API description: API for Cloud SQL database instance management version: v1 - x-discovery-doc-revision: '20241011' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250807' + x-generated-date: '2025-08-28' externalDocs: url: https://developers.google.com/cloud-sql/ servers: @@ -153,6 +153,7 @@ components: - >- Switches the roles of the primary and replica pair. The target instance should be the replica. + - Update a backup. - >- Acquire a lease for the setup of SQL Server Reporting Services (SSRS). @@ -179,6 +180,15 @@ components: Switches a primary instance to a replica. This operation runs as part of a switchover operation to the original primary instance. - Updates the major version of a Cloud SQL instance. + - >- + Deprecated: ADVANCED_BACKUP is deprecated. Use ENHANCED_BACKUP + instead. + - Changes the BackupTier of a Cloud SQL instance. + - Creates a backup for an Enhanced BackupTier Cloud SQL instance. + - >- + Repairs entire read pool or specified read pool nodes in the read + pool. + - Creates a Cloud SQL read pool instance. enumDeprecated: - false - false @@ -222,10 +232,16 @@ components: - false - false - false + - false + - true - true + - false + - false - true - false - false + - false + - false enum: - SQL_OPERATION_TYPE_UNSPECIFIED - IMPORT @@ -266,6 +282,7 @@ components: - AUTO_RESTART - REENCRYPT - SWITCHOVER + - UPDATE_BACKUP - ACQUIRE_SSRS_LEASE - RELEASE_SSRS_LEASE - RECONFIGURE_OLD_PRIMARY @@ -273,6 +290,11 @@ components: - SELF_SERVICE_MAINTENANCE - SWITCHOVER_TO_REPLICA - MAJOR_VERSION_UPGRADE + - ADVANCED_BACKUP + - MANAGE_BACKUP + - ENHANCED_BACKUP + - REPAIR_READ_POOL + - CREATE_READ_POOL importContext: description: The context for import operation, if applicable. $ref: '#/components/schemas/ImportContext' @@ -289,7 +311,7 @@ components: information about the operation. type: string targetId: - description: Name of the database instance related to this operation. + description: Name of the resource on which this operation runs. type: string selfLink: description: The URI of this resource. @@ -300,6 +322,9 @@ components: acquireSsrsLeaseContext: description: The context for acquire SSRS lease operation, if applicable. $ref: '#/components/schemas/AcquireSsrsLeaseContext' + subOperationType: + description: Optional. The sub operation based on the operation type. + $ref: '#/components/schemas/SqlSubOperationType' OperationErrors: id: OperationErrors description: Database instance operation errors list wrapper. @@ -378,7 +403,9 @@ components: The target database for the import. If `fileType` is `SQL`, this field is required only if the import file does not specify a database, and is overridden by any database specification in the - import file. If `fileType` is `CSV`, one database must be specified. + import file. For entire instance parallel import operations, the + database is overridden by the database name stored in subdirectory + name. If `fileType` is `CSV`, one database must be specified. type: string kind: description: This is always `sql#importContext`. @@ -393,11 +420,13 @@ components: - File containing SQL statements. - File in CSV format. - '' + - TDE certificate. enum: - SQL_FILE_TYPE_UNSPECIFIED - SQL - CSV - BAK + - TDE csvImportOptions: description: Options for importing data as CSV. type: object @@ -460,6 +489,9 @@ components: pvkPassword: description: Password that encrypts the private key type: string + keepEncrypted: + description: Optional. Whether the imported file remains encrypted. + type: boolean striped: description: >- Whether or not the backup set being restored is striped. Applies @@ -534,6 +566,30 @@ components: This flag applies only if you enabled Cloud SQL to import files in parallel. type: boolean + tdeImportOptions: + description: Optional. Import parameters specific to SQL Server TDE certificates + type: object + properties: + certificatePath: + description: >- + Required. Path to the TDE certificate public key in the form + gs://bucketName/fileName. The instance must have read access to + the file. Applicable only for SQL Server instances. + type: string + privateKeyPath: + description: >- + Required. Path to the TDE certificate private key in the form + gs://bucketName/fileName. The instance must have read access to + the file. Applicable only for SQL Server instances. + type: string + privateKeyPassword: + description: Required. Password that encrypts the private key. + type: string + name: + description: >- + Required. Certificate name. Applicable only for SQL Server + instances. + type: string ExportContext: id: ExportContext description: Database instance export context. @@ -554,11 +610,15 @@ components: the `mysql` system database. If `fileType` is `CSV`, you can specify one database, either by using this property or by using the `csvExportOptions.selectQuery` property, which takes precedence over - this property. `PostgreSQL instances:` You must specify one database - to be exported. If `fileType` is `CSV`, this database must match the - one specified in the `csvExportOptions.selectQuery` property. `SQL - Server instances:` You must specify one database to be exported, and - the `fileType` must be `BAK`. + this property. `PostgreSQL instances:` If you don't specify a + database by name, all user databases in the instance are exported. + This excludes system databases and Cloud SQL databases used to + manage internal operations. Exporting all user databases is only + available for directory-formatted parallel export. If `fileType` is + `CSV`, this database must match the one specified in the + `csvExportOptions.selectQuery` property. `SQL Server instances:` You + must specify one database to be exported, and the `fileType` must be + `BAK`. type: array items: type: string @@ -609,9 +669,9 @@ components: properties: clean: description: >- - Optional. Use this option to include DROP SQL statements. - These statements are used to delete database objects before - running the import operation. + Optional. Use this option to include DROP SQL + statements. Use these statements to delete database objects + before running the import operation. type: boolean ifExists: description: >- @@ -655,13 +715,15 @@ components: - File containing SQL statements. - File in CSV format. - '' + - TDE certificate. enum: - SQL_FILE_TYPE_UNSPECIFIED - SQL - CSV - BAK + - TDE offload: - description: Option for export offload. + description: Whether to perform a serverless export. type: boolean bakExportOptions: description: Options for exporting BAK files (SQL Server-only) @@ -723,6 +785,30 @@ components: SQL for SQL Server. type: string format: google-datetime + tdeExportOptions: + description: Optional. Export parameters specific to SQL Server TDE certificates + type: object + properties: + certificatePath: + description: >- + Required. Path to the TDE certificate public key in the form + gs://bucketName/fileName. The instance must have write access to + the bucket. Applicable only for SQL Server instances. + type: string + privateKeyPath: + description: >- + Required. Path to the TDE certificate private key in the form + gs://bucketName/fileName. The instance must have write access to + the location. Applicable only for SQL Server instances. + type: string + privateKeyPassword: + description: Required. Password that encrypts the private key. + type: string + name: + description: >- + Required. Certificate name. Applicable only for SQL Server + instances. + type: string BackupContext: id: BackupContext description: Backup context. @@ -735,6 +821,9 @@ components: kind: description: This is always `sql#backupContext`. type: string + name: + description: 'The name of the backup. Format: projects/{project}/backups/{backup}' + type: string AcquireSsrsLeaseContext: id: AcquireSsrsLeaseContext description: Acquire SSRS lease context. @@ -757,6 +846,39 @@ components: description: Lease duration needed for SSRS setup. type: string format: google-duration + SqlSubOperationType: + id: SqlSubOperationType + description: The sub operation type based on the operation type. + type: object + properties: + maintenanceType: + description: The type of maintenance to be performed on the instance. + type: string + enumDescriptions: + - Maintenance type is unspecified. + - >- + Indicates that a standalone instance is undergoing maintenance. + The instance can be either a primary instance or a replica. + - >- + Indicates that the primary instance and all of its replicas, + including cascading replicas, are undergoing maintenance. + Maintenance is performed on groups of replicas first, followed by + the primary instance. + - >- + Indicates that the standalone instance is undergoing maintenance, + initiated by self-service. The instance can be either a primary + instance or a replica. + - >- + Indicates that the primary instance and all of its replicas are + undergoing maintenance, initiated by self-service. Maintenance is + performed on groups of replicas first, followed by the primary + instance. + enum: + - SQL_MAINTENANCE_TYPE_UNSPECIFIED + - INSTANCE_MAINTENANCE + - REPLICA_INCLUDED_MAINTENANCE + - INSTANCE_SELF_SERVICE_MAINTENANCE + - REPLICA_INCLUDED_SELF_SERVICE_MAINTENANCE InstancesCloneRequest: id: InstancesCloneRequest description: Database instance clone request. @@ -823,6 +945,13 @@ components: secondary zone as the source instance. This value cannot be the same as the preferred_zone field. This field applies to all DB types. type: string + sourceInstanceDeletionTime: + description: >- + The timestamp used to identify the time when the source instance is + deleted. If this instance is deleted, then you must set the + timestamp. + type: string + format: google-datetime BinLogCoordinates: id: BinLogCoordinates description: Binary log coordinates. @@ -912,7 +1041,7 @@ components: type: string clientKey: description: >- - PEM representation of the replica's private key. The corresponsing + PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate. The format of the replica's private key can be either PKCS #1 or PKCS #8. type: string @@ -1029,6 +1158,9 @@ components: The creation of the instance failed or a fatal error occurred during maintenance. - Deprecated + - >- + (Applicable to read pool nodes only.) The read pool node needs to + be repaired. The database might be unavailable. enumDeprecated: - false - false @@ -1038,6 +1170,7 @@ components: - false - false - true + - false enum: - SQL_INSTANCE_STATE_UNSPECIFIED - RUNNABLE @@ -1047,6 +1180,7 @@ components: - MAINTENANCE - FAILED - ONLINE_MAINTENANCE + - REPAIRING databaseVersion: description: >- The database engine type and version. The `databaseVersion` field @@ -1058,19 +1192,6 @@ components: - The database version is MySQL 5.5. - The database version is MySQL 5.6. - The database version is MySQL 5.7. - - The database version is SQL Server 2017 Standard. - - The database version is SQL Server 2017 Enterprise. - - The database version is SQL Server 2017 Express. - - The database version is SQL Server 2017 Web. - - The database version is PostgreSQL 9.6. - - The database version is PostgreSQL 10. - - The database version is PostgreSQL 11. - - The database version is PostgreSQL 12. - - The database version is PostgreSQL 13. - - The database version is PostgreSQL 14. - - The database version is PostgreSQL 15. - - The database version is PostgreSQL 16. - - The database version is PostgreSQL 17. - The database version is MySQL 8. - >- The database major version is MySQL 8.0 and the minor version is @@ -1111,16 +1232,44 @@ components: - >- The database major version is MySQL 8.0 and the minor version is 37. - - >- - The database major version is MySQL 8.0 and the minor version is - 38. - >- The database major version is MySQL 8.0 and the minor version is 39. - >- The database major version is MySQL 8.0 and the minor version is 40. + - >- + The database major version is MySQL 8.0 and the minor version is + 41. + - >- + The database major version is MySQL 8.0 and the minor version is + 42. + - >- + The database major version is MySQL 8.0 and the minor version is + 43. + - >- + The database major version is MySQL 8.0 and the minor version is + 44. + - >- + The database major version is MySQL 8.0 and the minor version is + 45. + - >- + The database major version is MySQL 8.0 and the minor version is + 46. - The database version is MySQL 8.4. + - The database version is SQL Server 2017 Standard. + - The database version is SQL Server 2017 Enterprise. + - The database version is SQL Server 2017 Express. + - The database version is SQL Server 2017 Web. + - The database version is PostgreSQL 9.6. + - The database version is PostgreSQL 10. + - The database version is PostgreSQL 11. + - The database version is PostgreSQL 12. + - The database version is PostgreSQL 13. + - The database version is PostgreSQL 14. + - The database version is PostgreSQL 15. + - The database version is PostgreSQL 16. + - The database version is PostgreSQL 17. - The database version is SQL Server 2019 Standard. - The database version is SQL Server 2019 Enterprise. - The database version is SQL Server 2019 Express. @@ -1140,6 +1289,12 @@ components: - false - false - false + - true + - false + - false + - false + - false + - false - false - false - false @@ -1153,7 +1308,6 @@ components: - false - false - false - - true - false - false - false @@ -1180,19 +1334,6 @@ components: - MYSQL_5_5 - MYSQL_5_6 - MYSQL_5_7 - - SQLSERVER_2017_STANDARD - - SQLSERVER_2017_ENTERPRISE - - SQLSERVER_2017_EXPRESS - - SQLSERVER_2017_WEB - - POSTGRES_9_6 - - POSTGRES_10 - - POSTGRES_11 - - POSTGRES_12 - - POSTGRES_13 - - POSTGRES_14 - - POSTGRES_15 - - POSTGRES_16 - - POSTGRES_17 - MYSQL_8_0 - MYSQL_8_0_18 - MYSQL_8_0_26 @@ -1207,10 +1348,28 @@ components: - MYSQL_8_0_35 - MYSQL_8_0_36 - MYSQL_8_0_37 - - MYSQL_8_0_38 - MYSQL_8_0_39 - MYSQL_8_0_40 + - MYSQL_8_0_41 + - MYSQL_8_0_42 + - MYSQL_8_0_43 + - MYSQL_8_0_44 + - MYSQL_8_0_45 + - MYSQL_8_0_46 - MYSQL_8_4 + - SQLSERVER_2017_STANDARD + - SQLSERVER_2017_ENTERPRISE + - SQLSERVER_2017_EXPRESS + - SQLSERVER_2017_WEB + - POSTGRES_9_6 + - POSTGRES_10 + - POSTGRES_11 + - POSTGRES_12 + - POSTGRES_13 + - POSTGRES_14 + - POSTGRES_15 + - POSTGRES_16 + - POSTGRES_17 - SQLSERVER_2019_STANDARD - SQLSERVER_2019_ENTERPRISE - SQLSERVER_2019_EXPRESS @@ -1290,11 +1449,13 @@ components: An instance running on the customer's premises that is not managed by Cloud SQL. - A Cloud SQL instance acting as a read-replica. + - A Cloud SQL read pool. enum: - SQL_INSTANCE_TYPE_UNSPECIFIED - CLOUD_SQL_INSTANCE - ON_PREMISES_INSTANCE - READ_REPLICA_INSTANCE + - READ_POOL_INSTANCE project: description: >- The project ID of the project containing the Cloud SQL instance. The @@ -1492,7 +1653,7 @@ components: Optional. A primary instance and disaster recovery (DR) replica pair. A DR replica is a cross-region replica that you designate for failover in the event that the primary instance experiences regional - failure. Only applicable to MySQL. + failure. Applicable to MySQL and PostgreSQL. $ref: '#/components/schemas/ReplicationCluster' geminiConfig: description: Gemini instance configuration. @@ -1508,6 +1669,42 @@ components: Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage. type: boolean + includeReplicasForMajorVersionUpgrade: + description: >- + Input only. Determines whether an in-place major version upgrade of + replicas happens when an in-place major version upgrade of a primary + instance is initiated. + type: boolean + tags: + description: >- + Optional. Input only. Immutable. Tag keys and tag values that are + bound to this instance. You must represent each item in the map as: + `"" : ""`. For example, a single resource can have the following + tags: ``` "123/environment": "production", "123/costCenter": + "marketing", ``` For more information on tag creation and + management, see + https://cloud.google.com/resource-manager/docs/tags/tags-overview. + type: object + additionalProperties: + type: string + nodeCount: + description: The number of read pool nodes in a read pool. + type: integer + format: int32 + nodes: + description: >- + Output only. Entries containing information about each read pool + node of the read pool. + readOnly: true + type: array + items: + $ref: '#/components/schemas/PoolNodeConfig' + dnsNames: + description: Output only. The list of DNS names used by this instance. + readOnly: true + type: array + items: + $ref: '#/components/schemas/DnsNameMapping' Settings: id: Settings description: Database instance settings. @@ -1662,16 +1859,19 @@ components: - >- This field is deprecated and will be removed from a future version of the API. + - A Hyperdisk Balanced data disk. enumDeprecated: - false - false - false - true + - false enum: - SQL_DATA_DISK_TYPE_UNSPECIFIED - PD_SSD - PD_HDD - OBSOLETE_LOCAL_SSD + - HYPERDISK_BALANCED maintenanceWindow: description: >- The maintenance window for this instance. This specifies when the @@ -1766,12 +1966,18 @@ components: dataCacheConfig: description: Configuration for data cache. $ref: '#/components/schemas/DataCacheConfig' + replicationLagMaxSeconds: + description: >- + Optional. Configuration value for recreation of replica after + certain replication lag + type: integer + format: int32 enableGoogleMlIntegration: description: >- Optional. When this parameter is set to true, Cloud SQL instances can connect to Vertex AI to pass requests for real-time predictions and insights to the AI. The default value is false. This applies - only to Cloud SQL for PostgreSQL instances. + only to Cloud SQL for MySQL and Cloud SQL for PostgreSQL instances. type: boolean enableDataplexIntegration: description: >- @@ -1779,6 +1985,36 @@ components: disabled for Dataplex. When this parameter is set to true, schema extraction for Dataplex on Cloud SQL instances is activated. type: boolean + retainBackupsOnDelete: + description: >- + Optional. When this parameter is set to true, Cloud SQL retains + backups of the instance even after the instance is deleted. The + ON_DEMAND backup will be retained until customer deletes the backup + or the project. The AUTOMATED backup will be retained based on the + backups retention setting. + type: boolean + dataDiskProvisionedIops: + description: >- + Optional. Provisioned number of I/O operations per second for the + data disk. This field is only used for hyperdisk-balanced disk + types. + type: string + format: int64 + dataDiskProvisionedThroughput: + description: >- + Optional. Provisioned throughput measured in MiB per second for the + data disk. This field is only used for hyperdisk-balanced disk + types. + type: string + format: int64 + connectionPoolConfig: + description: >- + Optional. The managed connection pooling configuration for the + instance. + $ref: '#/components/schemas/ConnectionPoolConfig' + finalBackupConfig: + description: Optional. The final backup configuration for the instance. + $ref: '#/components/schemas/FinalBackupConfig' IpConfiguration: id: IpConfiguration description: IP Management configuration. @@ -1891,10 +2127,27 @@ components: - >- Google-managed regional CA part of root CA hierarchy hosted on Google Cloud's Certificate Authority Service (CAS). + - >- + Customer-managed CA hosted on Google Cloud's Certificate Authority + Service (CAS). enum: - CA_MODE_UNSPECIFIED - GOOGLE_MANAGED_INTERNAL_CA - GOOGLE_MANAGED_CAS_CA + - CUSTOMER_MANAGED_CAS_CA + customSubjectAlternativeNames: + description: >- + Optional. Custom Subject Alternative Name(SAN)s for a Cloud SQL + instance. + type: array + items: + type: string + serverCaPool: + description: >- + Optional. The resource name of the server CA pool for an instance + with `CUSTOMER_MANAGED_CAS_CA` as the `server_ca_mode`. Format: + projects/{PROJECT}/locations/{REGION}/caPools/{CA_POOL_ID} + type: string AclEntry: id: AclEntry description: An entry for an Access Control list. @@ -1942,6 +2195,13 @@ components: type: array items: $ref: '#/components/schemas/PscAutoConnectionConfig' + networkAttachmentUri: + description: >- + Optional. The network attachment of the consumer network that the + Private Service Connect enabled Cloud SQL instance is authorized to + connect via PSC interface. format: + projects/PROJECT/regions/REGION/networkAttachments/ID + type: string PscAutoConnectionConfig: id: PscAutoConnectionConfig description: >- @@ -1951,17 +2211,18 @@ components: properties: consumerProject: description: >- - This is the project ID of consumer service project of this consumer - endpoint. Optional. This is only applicable if consumer_network is a - shared vpc network. + Optional. This is the project ID of consumer service project of this + consumer endpoint. Optional. This is only applicable if + consumer_network is a shared vpc network. type: string consumerNetwork: description: >- - The consumer network of this consumer endpoint. This must be a - resource path that includes both the host project and the network - name. For example, `projects/project1/global/networks/network1`. The - consumer host project of this network might be different from the - consumer service project. + Optional. The consumer network of this consumer endpoint. This must + be a resource path that includes both the host project and the + network name. For example, + `projects/project1/global/networks/network1`. The consumer host + project of this network might be different from the consumer service + project. type: string ipAddress: description: The IP address of the consumer endpoint. @@ -2139,6 +2400,25 @@ components: - SWITCHING_TO_CLOUD_STORAGE - SWITCHED_TO_CLOUD_STORAGE - CLOUD_STORAGE + backupTier: + description: Output only. Backup tier that manages the backups for the instance. + readOnly: true + type: string + enumDescriptions: + - Unspecified. + - Instance is managed by Cloud SQL. + - 'Deprecated: ADVANCED is deprecated. Please use ENHANCED instead.' + - Instance is managed by Google Cloud Backup and DR Service. + enumDeprecated: + - false + - false + - true + - false + enum: + - BACKUP_TIER_UNSPECIFIED + - STANDARD + - ADVANCED + - ENHANCED BackupRetentionSettings: id: BackupRetentionSettings description: >- @@ -2177,6 +2457,36 @@ components: domain: description: The name of the domain (e.g., mydomain.com). type: string + mode: + description: Optional. The mode of the Active Directory configuration. + type: string + enumDescriptions: + - >- + Unspecified mode. Will default to MANAGED_ACTIVE_DIRECTORY if the + mode is not specified to maintain backward compatibility. + - Managed Active Directory mode. + - Self-managed Active Directory mode. + enum: + - ACTIVE_DIRECTORY_MODE_UNSPECIFIED + - MANAGED_ACTIVE_DIRECTORY + - SELF_MANAGED_ACTIVE_DIRECTORY + dnsServers: + description: >- + Optional. Domain controller IPv4 addresses used to bootstrap Active + Directory. + type: array + items: + type: string + adminCredentialSecretName: + description: >- + Optional. The secret manager key storing the administrator + credential. (e.g., projects/{project}/secrets/{secret}). + type: string + organizationalUnit: + description: >- + Optional. The organizational unit distinguished name. This is the + full hierarchical path to the organizational unit. + type: string DenyMaintenancePeriod: id: DenyMaintenancePeriod description: >- @@ -2225,9 +2535,9 @@ components: queryStringLength: description: >- Maximum query length stored in bytes. Default value: 1024 bytes. - Range: 256-4500 bytes. Query length more than this field value will - be truncated to this value. When unset, query length will be the - default value. Changing query length will restart the database. + Range: 256-4500 bytes. Query lengths greater than this field value + will be truncated to this value. When unset, query length will be + the default value. Changing query length will restart the database. type: integer format: int32 queryPlansPerMinute: @@ -2314,6 +2624,55 @@ components: dataCacheEnabled: description: Whether data cache is enabled for the instance. type: boolean + ConnectionPoolConfig: + id: ConnectionPoolConfig + description: The managed connection pooling configuration. + type: object + properties: + connectionPoolingEnabled: + description: Whether managed connection pooling is enabled. + type: boolean + flags: + description: Optional. List of connection pool configuration flags. + type: array + items: + $ref: '#/components/schemas/ConnectionPoolFlags' + poolerCount: + description: Output only. Number of connection poolers. + readOnly: true + type: integer + format: int32 + ConnectionPoolFlags: + id: ConnectionPoolFlags + description: >- + Connection pool flags for Cloud SQL instances managed connection pool + configuration. + type: object + properties: + name: + description: Required. The name of the flag. + type: string + value: + description: >- + Required. The value of the flag. Boolean flags are set to `on` for + true and `off` for false. This field must be omitted if the flag + doesn't take a value. + type: string + FinalBackupConfig: + id: FinalBackupConfig + description: Config used to determine the final backup settings for the instance. + type: object + properties: + enabled: + description: Whether the final backup is enabled for the instance. + type: boolean + retentionDays: + description: >- + The number of days to retain the final backup after the instance + deletion. The final backup will be purged at + (time_of_instance_deletion + retention_days). + type: integer + format: int32 IpMapping: id: IpMapping description: Database instance IP mapping @@ -2424,7 +2783,7 @@ components: type: string clientKey: description: >- - PEM representation of the replica's private key. The corresponsing + PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate. type: string dumpFilePath: @@ -2433,6 +2792,30 @@ components: sourceInstance: description: The reference to Cloud SQL instance if the source is Cloud SQL. $ref: '#/components/schemas/InstanceReference' + selectedObjects: + description: >- + Optional. A list of objects that the user selects for replication + from an external source instance. + type: array + items: + $ref: '#/components/schemas/SelectedObjects' + sslOption: + description: >- + Optional. SSL option for replica connection to the on-premises + source. + type: string + enumDescriptions: + - Unknown SSL option i.e. SSL option not specified by user. + - SSL is not used for replica connection to the on-premises source. + - SSL is required for replica connection to the on-premises source. + - >- + Verify CA is required for replica connection to the on-premises + source. + enum: + - SSL_OPTION_UNSPECIFIED + - DISABLE + - REQUIRE + - VERIFY_CA InstanceReference: id: InstanceReference description: Reference to another Cloud SQL instance. @@ -2451,6 +2834,16 @@ components: The project ID of the Cloud SQL instance being referenced. The default is the same project ID as the instance references it. type: string + SelectedObjects: + id: SelectedObjects + description: >- + A list of objects that the user selects for replication from an external + source instance. + type: object + properties: + database: + description: Required. The name of the database to migrate. + type: string ReplicaConfiguration: id: ReplicaConfiguration description: Read-replica configuration for connecting to the primary instance. @@ -2521,7 +2914,7 @@ components: type: string clientKey: description: >- - PEM representation of the replica's private key. The corresponsing + PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate. type: string sslCipher: @@ -2630,20 +3023,20 @@ components: description: >- A primary instance and disaster recovery (DR) replica pair. A DR replica is a cross-region replica that you designate for failover in the event - that the primary instance experiences regional failure. Only applicable - to MySQL. + that the primary instance experiences regional failure. Applicable to + MySQL and PostgreSQL. type: object properties: psaWriteEndpoint: description: >- - Output only. If set, it indicates this instance has a private - service access (PSA) dns endpoint that is pointing to the primary - instance of the cluster. If this instance is the primary, the dns - should be pointing to this instance. After Switchover or Replica - failover, this DNS endpoint points to the promoted instance. This is - a read-only field, returned to the user as information. This field - can exist even if a standalone instance does not yet have a replica, - or had a DR replica that was deleted. + Output only. If set, this field indicates this instance has a + private service access (PSA) DNS endpoint that is pointing to the + primary instance of the cluster. If this instance is the primary, + then the DNS endpoint points to this instance. After a switchover or + replica failover operation, this DNS endpoint points to the promoted + instance. This is a read-only field, returned to the user as + information. This field can exist even if a standalone instance + doesn't have a DR replica yet or the DR replica is deleted. readOnly: true type: string failoverDrReplicaName: @@ -2694,37 +3087,142 @@ components: description: Output only. Whether the flag recommender is enabled. readOnly: true type: boolean - InstancesImportRequest: - id: InstancesImportRequest - description: Database instance import request. - type: object - properties: - importContext: - description: Contains details about the import operation. - $ref: '#/components/schemas/ImportContext' - InstancesListResponse: - id: InstancesListResponse - description: Database instances list response. + PoolNodeConfig: + id: PoolNodeConfig + description: Details of a single read pool node of a read pool. type: object properties: - kind: - description: This is always `sql#instancesList`. + name: + description: >- + Output only. The name of the read pool node, to be used for + retrieving metrics and logs. + readOnly: true type: string - warnings: - description: List of warnings that occurred while handling the request. - type: array - items: - $ref: '#/components/schemas/ApiWarning' - items: - description: List of database instance resources. + gceZone: + description: Output only. The zone of the read pool node. + readOnly: true + type: string + ipAddresses: + description: >- + Output only. Mappings containing IP addresses that can be used to + connect to the read pool node. + readOnly: true type: array items: - $ref: '#/components/schemas/DatabaseInstance' - nextPageToken: - description: >- - The continuation token, used to page through large result sets. - Provide this value in a subsequent request to return the next page - of results. + $ref: '#/components/schemas/IpMapping' + dnsName: + description: Output only. The DNS name of the read pool node. + readOnly: true + type: string + state: + description: Output only. The current state of the read pool node. + readOnly: true + type: string + enumDescriptions: + - The state of the instance is unknown. + - The instance is running, or has been stopped by owner. + - >- + The instance is not available, for example due to problems with + billing. + - The instance is being deleted. + - The instance is being created. + - The instance is down for maintenance. + - >- + The creation of the instance failed or a fatal error occurred + during maintenance. + - Deprecated + - >- + (Applicable to read pool nodes only.) The read pool node needs to + be repaired. The database might be unavailable. + enumDeprecated: + - false + - false + - false + - false + - false + - false + - false + - true + - false + enum: + - SQL_INSTANCE_STATE_UNSPECIFIED + - RUNNABLE + - SUSPENDED + - PENDING_DELETE + - PENDING_CREATE + - MAINTENANCE + - FAILED + - ONLINE_MAINTENANCE + - REPAIRING + dnsNames: + description: Output only. The list of DNS names used by this read pool node. + readOnly: true + type: array + items: + $ref: '#/components/schemas/DnsNameMapping' + DnsNameMapping: + id: DnsNameMapping + description: DNS metadata. + type: object + properties: + name: + description: The DNS name. + type: string + connectionType: + description: Output only. The connection type of the DNS name. + readOnly: true + type: string + enumDescriptions: + - Unknown connection type. + - Public IP. + - Private services access (private IP). + - Private Service Connect. + enum: + - CONNECTION_TYPE_UNSPECIFIED + - PUBLIC + - PRIVATE_SERVICES_ACCESS + - PRIVATE_SERVICE_CONNECT + dnsScope: + description: Output only. The scope that the DNS name applies to. + readOnly: true + type: string + enumDescriptions: + - Unknown DNS scope. + - Indicates a instance-level DNS name. + enum: + - DNS_SCOPE_UNSPECIFIED + - INSTANCE + InstancesImportRequest: + id: InstancesImportRequest + description: Database instance import request. + type: object + properties: + importContext: + description: Contains details about the import operation. + $ref: '#/components/schemas/ImportContext' + InstancesListResponse: + id: InstancesListResponse + description: Database instances list response. + type: object + properties: + kind: + description: This is always `sql#instancesList`. + type: string + warnings: + description: List of warnings that occurred while handling the request. + type: array + items: + $ref: '#/components/schemas/ApiWarning' + items: + description: List of database instance resources. + type: array + items: + $ref: '#/components/schemas/DatabaseInstance' + nextPageToken: + description: >- + The continuation token, used to page through large result sets. + Provide this value in a subsequent request to return the next page + of results. type: string InstancesListServerCasResponse: id: InstancesListServerCasResponse @@ -2774,6 +3272,39 @@ components: restoreBackupContext: description: Parameters required to perform the restore backup operation. $ref: '#/components/schemas/RestoreBackupContext' + backup: + description: >- + The name of the backup that's used to restore a Cloud SQL instance: + Format: projects/{project-id}/backups/{backup-uid}. Only one of + restore_backup_context, backup, backupdr_backup can be passed to the + input. + type: string + backupdrBackup: + description: >- + The name of the backup that's used to restore a Cloud SQL instance: + Format: + "projects/{project-id}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource}/backups/{backup-uid}". + Only one of restore_backup_context, backup, backupdr_backup can be + passed to the input. + type: string + restoreInstanceSettings: + description: >- + Optional. By using this parameter, Cloud SQL overrides any instance + settings stored in the backup you are restoring from. You can't + change the instance's major database version and you can only + increase the disk size. You can use this field to restore new + instances only. This field is not applicable for restore to existing + instances. + $ref: '#/components/schemas/DatabaseInstance' + restoreInstanceClearOverridesFieldNames: + description: >- + Optional. This field has the same purpose as + restore_instance_settings, changes any instance settings stored in + the backup you are restoring from. With the difference that these + fields are cleared in the settings. + type: array + items: + type: string RestoreBackupContext: id: RestoreBackupContext description: >- @@ -2966,6 +3497,13 @@ components: - MIN - OPTIMAL - MAX + selectedObjects: + description: >- + Optional. Migrate only the specified objects from the source + instance. If this field is empty, then migrate all objects. + type: array + items: + $ref: '#/components/schemas/ExternalSyncSelectedObject' MySqlSyncConfig: id: MySqlSyncConfig description: MySQL-specific external server sync settings. @@ -2991,6 +3529,14 @@ components: The value of the flag. This field must be omitted if the flag doesn't take a value. type: string + ExternalSyncSelectedObject: + id: ExternalSyncSelectedObject + description: The selected object that Cloud SQL migrates. + type: object + properties: + database: + description: The name of the database that Cloud SQL migrates. + type: string SqlInstancesVerifyExternalSyncSettingsResponse: id: SqlInstancesVerifyExternalSyncSettingsResponse description: Instance verify external sync settings response. @@ -3142,6 +3688,21 @@ components: identity or change it to DEFAULT. Note that this is an error and will block the migration. - The selected objects don't exist on the source instance. + - >- + PSC only destination instance does not have a network attachment + URI. + - >- + Selected objects reference unselected objects. Based on their + object type (foreign key constraint or view), selected objects + will fail during migration. + - >- + The migration will delete existing data in the replica; set + replica_overwrite_enabled in the request to acknowledge this. This + is an error. MySQL only. + - >- + The migration will delete existing data in the replica; + replica_overwrite_enabled was set in the request acknowledging + this. This is a warning rather than an error. MySQL only. enum: - SQL_EXTERNAL_SYNC_SETTING_ERROR_TYPE_UNSPECIFIED - CONNECTION_FAILURE @@ -3197,6 +3758,10 @@ components: - UNSUPPORTED_SYSTEM_OBJECTS - UNSUPPORTED_TABLES_WITH_REPLICA_IDENTITY - SELECTED_OBJECTS_NOT_EXIST_ON_SOURCE + - PSC_ONLY_INSTANCE_WITH_NO_NETWORK_ATTACHMENT_URI + - SELECTED_OBJECTS_REFERENCE_UNSELECTED_OBJECTS + - PROMPT_DELETE_EXISTING + - WILL_DELETE_EXISTING detail: description: Additional information about the error encountered. type: string @@ -3256,6 +3821,14 @@ components: - MIGRATION_TYPE_UNSPECIFIED - LOGICAL - PHYSICAL + replicaOverwriteEnabled: + description: >- + Optional. MySQL only. True if end-user has confirmed that this SES + call will wipe replica databases overlapping with the proposed + selected_objects. If this field is not set and there are both + overlapping and additional databases proposed, an error will be + returned. + type: boolean PerformDiskShrinkContext: id: PerformDiskShrinkContext description: Perform disk shrink context. @@ -3299,6 +3872,114 @@ components: instance. type: string format: google-datetime + ExecuteSqlPayload: + id: ExecuteSqlPayload + description: The request payload used to execute SQL statements. + type: object + properties: + sqlStatement: + description: >- + Required. SQL statements to run on the database. It can be a single + statement or a sequence of statements separated by semicolons. + type: string + database: + description: >- + Optional. Name of the database on which the statement will be + executed. + type: string + autoIamAuthn: + description: >- + Optional. When set to true, the API caller identity associated with + the request is used for database authentication. The API caller must + be an IAM user in the database. + type: boolean + rowLimit: + description: Optional. The maximum number of rows returned per SQL statement. + type: string + format: int64 + SqlInstancesExecuteSqlResponse: + id: SqlInstancesExecuteSqlResponse + description: Execute SQL statements response. + type: object + properties: + metadata: + description: >- + The additional metadata information regarding the execution of the + SQL statements. + $ref: '#/components/schemas/Metadata' + results: + description: The list of results after executing all the SQL statements. + type: array + items: + $ref: '#/components/schemas/QueryResult' + Metadata: + id: Metadata + description: >- + The additional metadata information regarding the execution of the SQL + statements. + type: object + properties: + sqlStatementExecutionTime: + description: The time taken to execute the SQL statements. + type: string + format: google-duration + QueryResult: + id: QueryResult + description: QueryResult contains the result of executing a single SQL statement. + type: object + properties: + columns: + description: >- + List of columns included in the result. This also includes the data + type of the column. + type: array + items: + $ref: '#/components/schemas/Column' + rows: + description: Rows returned by the SQL statement. + type: array + items: + $ref: '#/components/schemas/Row' + message: + description: Message related to the SQL execution result. + type: string + partialResult: + description: >- + Set to true if the SQL execution's result is truncated due to size + limits. + type: boolean + Column: + id: Column + description: Contains the name and datatype of a column. + type: object + properties: + name: + description: Name of the column. + type: string + type: + description: Datatype of the column. + type: string + Row: + id: Row + description: Contains the values for a row. + type: object + properties: + values: + description: The values for the row. + type: array + items: + $ref: '#/components/schemas/Value' + Value: + id: Value + description: The cell value of the table. + type: object + properties: + value: + description: The cell value in string format. + type: string + nullValue: + description: If cell value is null, then this flag will be set to true. + type: boolean InstancesAcquireSsrsLeaseRequest: id: InstancesAcquireSsrsLeaseRequest description: Request to acquire a lease for SSRS. @@ -3323,6 +4004,58 @@ components: operationId: description: The unique identifier for this operation. type: string + PointInTimeRestoreContext: + id: PointInTimeRestoreContext + description: >- + The context to perform a point-in-time recovery of an instance managed + by Google Cloud Backup and Disaster Recovery. + type: object + properties: + datasource: + description: >- + The Google Cloud Backup and Disaster Recovery Datasource URI. + Format: + projects/{project}/locations/{region}/backupVaults/{backupvault}/dataSources/{datasource}. + type: string + pointInTime: + description: >- + Required. The date and time to which you want to restore the + instance. + type: string + format: google-datetime + targetInstance: + description: Target instance name. + type: string + privateNetwork: + description: >- + Optional. The resource link for the VPC network from which the Cloud + SQL instance is accessible for private IP. For example, + `/projects/myProject/global/networks/default`. + type: string + allocatedIpRange: + description: >- + Optional. The name of the allocated IP range for the internal IP + Cloud SQL instance. For example: "google-managed-services-default". + If you set this, then Cloud SQL creates the IP address for the + cloned instance in the allocated range. This range must comply with + [RFC 1035](https://tools.ietf.org/html/rfc1035) standards. + Specifically, the name must be 1-63 characters long and match the + regular expression [a-z]([-a-z0-9]*[a-z0-9])?. Reserved for future + use. + type: string + preferredZone: + description: >- + Optional. Point-in-time recovery of an instance to the specified + zone. If no zone is specified, then clone to the same primary zone + as the source instance. + type: string + preferredSecondaryZone: + description: >- + Optional. Point-in-time recovery of a regional instance in the + specified zones. If not specified, clone to the same secondary zone + as the source instance. This value cannot be the same as the + preferred_zone field. + type: string BackupRun: id: BackupRun description: A BackupRun resource. @@ -3426,54 +4159,655 @@ components: location: description: Location of the backups. type: string - diskEncryptionConfiguration: - description: Encryption configuration specific to a backup. - $ref: '#/components/schemas/DiskEncryptionConfiguration' - diskEncryptionStatus: - description: Encryption status specific to a backup. - $ref: '#/components/schemas/DiskEncryptionStatus' - backupKind: - description: Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT. - type: string - enumDescriptions: - - This is an unknown BackupKind. - - Snapshot-based backups. - - Physical backups. - enum: - - SQL_BACKUP_KIND_UNSPECIFIED - - SNAPSHOT - - PHYSICAL - timeZone: + databaseVersion: description: >- - Backup time zone to prevent restores to an instance with a different - time zone. Now relevant only for SQL Server. - type: string - maxChargeableBytes: - description: Output only. The maximum chargeable bytes for the backup. + Output only. The instance database version at the time this backup + was made. readOnly: true type: string - format: int64 - BackupRunsListResponse: - id: BackupRunsListResponse - description: Backup run list results. - type: object - properties: - kind: - description: This is always `sql#backupRunsList`. + enumDescriptions: + - This is an unknown database version. + - The database version is MySQL 5.1. + - The database version is MySQL 5.5. + - The database version is MySQL 5.6. + - The database version is MySQL 5.7. + - The database version is MySQL 8. + - >- + The database major version is MySQL 8.0 and the minor version is + 18. + - >- + The database major version is MySQL 8.0 and the minor version is + 26. + - >- + The database major version is MySQL 8.0 and the minor version is + 27. + - >- + The database major version is MySQL 8.0 and the minor version is + 28. + - >- + The database major version is MySQL 8.0 and the minor version is + 29. + - >- + The database major version is MySQL 8.0 and the minor version is + 30. + - >- + The database major version is MySQL 8.0 and the minor version is + 31. + - >- + The database major version is MySQL 8.0 and the minor version is + 32. + - >- + The database major version is MySQL 8.0 and the minor version is + 33. + - >- + The database major version is MySQL 8.0 and the minor version is + 34. + - >- + The database major version is MySQL 8.0 and the minor version is + 35. + - >- + The database major version is MySQL 8.0 and the minor version is + 36. + - >- + The database major version is MySQL 8.0 and the minor version is + 37. + - >- + The database major version is MySQL 8.0 and the minor version is + 39. + - >- + The database major version is MySQL 8.0 and the minor version is + 40. + - >- + The database major version is MySQL 8.0 and the minor version is + 41. + - >- + The database major version is MySQL 8.0 and the minor version is + 42. + - >- + The database major version is MySQL 8.0 and the minor version is + 43. + - >- + The database major version is MySQL 8.0 and the minor version is + 44. + - >- + The database major version is MySQL 8.0 and the minor version is + 45. + - >- + The database major version is MySQL 8.0 and the minor version is + 46. + - The database version is MySQL 8.4. + - The database version is SQL Server 2017 Standard. + - The database version is SQL Server 2017 Enterprise. + - The database version is SQL Server 2017 Express. + - The database version is SQL Server 2017 Web. + - The database version is PostgreSQL 9.6. + - The database version is PostgreSQL 10. + - The database version is PostgreSQL 11. + - The database version is PostgreSQL 12. + - The database version is PostgreSQL 13. + - The database version is PostgreSQL 14. + - The database version is PostgreSQL 15. + - The database version is PostgreSQL 16. + - The database version is PostgreSQL 17. + - The database version is SQL Server 2019 Standard. + - The database version is SQL Server 2019 Enterprise. + - The database version is SQL Server 2019 Express. + - The database version is SQL Server 2019 Web. + - The database version is SQL Server 2022 Standard. + - The database version is SQL Server 2022 Enterprise. + - The database version is SQL Server 2022 Express. + - The database version is SQL Server 2022 Web. + enumDeprecated: + - false + - true + - true + - false + - false + - false + - false + - false + - false + - false + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + enum: + - SQL_DATABASE_VERSION_UNSPECIFIED + - MYSQL_5_1 + - MYSQL_5_5 + - MYSQL_5_6 + - MYSQL_5_7 + - MYSQL_8_0 + - MYSQL_8_0_18 + - MYSQL_8_0_26 + - MYSQL_8_0_27 + - MYSQL_8_0_28 + - MYSQL_8_0_29 + - MYSQL_8_0_30 + - MYSQL_8_0_31 + - MYSQL_8_0_32 + - MYSQL_8_0_33 + - MYSQL_8_0_34 + - MYSQL_8_0_35 + - MYSQL_8_0_36 + - MYSQL_8_0_37 + - MYSQL_8_0_39 + - MYSQL_8_0_40 + - MYSQL_8_0_41 + - MYSQL_8_0_42 + - MYSQL_8_0_43 + - MYSQL_8_0_44 + - MYSQL_8_0_45 + - MYSQL_8_0_46 + - MYSQL_8_4 + - SQLSERVER_2017_STANDARD + - SQLSERVER_2017_ENTERPRISE + - SQLSERVER_2017_EXPRESS + - SQLSERVER_2017_WEB + - POSTGRES_9_6 + - POSTGRES_10 + - POSTGRES_11 + - POSTGRES_12 + - POSTGRES_13 + - POSTGRES_14 + - POSTGRES_15 + - POSTGRES_16 + - POSTGRES_17 + - SQLSERVER_2019_STANDARD + - SQLSERVER_2019_ENTERPRISE + - SQLSERVER_2019_EXPRESS + - SQLSERVER_2019_WEB + - SQLSERVER_2022_STANDARD + - SQLSERVER_2022_ENTERPRISE + - SQLSERVER_2022_EXPRESS + - SQLSERVER_2022_WEB + diskEncryptionConfiguration: + description: Encryption configuration specific to a backup. + $ref: '#/components/schemas/DiskEncryptionConfiguration' + diskEncryptionStatus: + description: Encryption status specific to a backup. + $ref: '#/components/schemas/DiskEncryptionStatus' + backupKind: + description: Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT. + type: string + enumDescriptions: + - This is an unknown BackupKind. + - Snapshot-based backups. + - Physical backups. + enum: + - SQL_BACKUP_KIND_UNSPECIFIED + - SNAPSHOT + - PHYSICAL + timeZone: + description: >- + Backup time zone to prevent restores to an instance with a different + time zone. Now relevant only for SQL Server. + type: string + maxChargeableBytes: + description: Output only. The maximum chargeable bytes for the backup. + readOnly: true + type: string + format: int64 + BackupRunsListResponse: + id: BackupRunsListResponse + description: Backup run list results. + type: object + properties: + kind: + description: This is always `sql#backupRunsList`. + type: string + items: + description: >- + A list of backup runs in reverse chronological order of the enqueued + time. + type: array + items: + $ref: '#/components/schemas/BackupRun' + nextPageToken: + description: >- + The continuation token, used to page through large result sets. + Provide this value in a subsequent request to return the next page + of results. + type: string + Backup: + id: Backup + description: 'A backup resource. Next ID: 30' + type: object + properties: + name: + description: >- + Output only. The resource name of the backup. Format: + projects/{project}/backups/{backup}. + readOnly: true + type: string + kind: + description: Output only. This is always `sql#backup`. + readOnly: true + type: string + selfLink: + description: Output only. The URI of this resource. + readOnly: true + type: string + type: + description: >- + Output only. The type of this backup. The type can be "AUTOMATED", + "ON_DEMAND" or “FINAL”. + readOnly: true + type: string + enumDescriptions: + - This is an unknown backup type. + - The backup schedule triggers a backup automatically. + - The user triggers a backup manually. + - The backup created when instance is deleted. + enum: + - SQL_BACKUP_TYPE_UNSPECIFIED + - AUTOMATED + - ON_DEMAND + - FINAL + description: + description: The description of this backup. + type: string + instance: + description: The name of the source database instance. + type: string + location: + description: >- + The storage location of the backups. The location can be + multi-regional. + type: string + backupInterval: + description: >- + Output only. This output contains the following values: start_time: + All database writes up to this time are available. end_time: Any + database writes after this time aren't available. + readOnly: true + $ref: '#/components/schemas/Interval' + state: + description: Output only. The status of this backup. + readOnly: true + type: string + enumDescriptions: + - The state of the backup is unknown. + - The backup that's added to a queue. + - The backup is in progress. + - The backup failed. + - The backup is successful. + - The backup is being deleted. + - Deletion of the backup failed. + enum: + - SQL_BACKUP_STATE_UNSPECIFIED + - ENQUEUED + - RUNNING + - FAILED + - SUCCESSFUL + - DELETING + - DELETION_FAILED + error: + description: >- + Output only. Information about why the backup operation fails (for + example, when the backup state fails). + readOnly: true + $ref: '#/components/schemas/OperationError' + kmsKey: + description: >- + Output only. This output contains the encryption configuration for a + backup and the resource name of the KMS key for disk encryption. + readOnly: true + type: string + kmsKeyVersion: + description: >- + Output only. This output contains the encryption status for a backup + and the version of the KMS key that's used to encrypt the Cloud SQL + instance. + readOnly: true + type: string + backupKind: + description: >- + Output only. Specifies the kind of backup, PHYSICAL or + DEFAULT_SNAPSHOT. + readOnly: true + type: string + enumDescriptions: + - This is an unknown BackupKind. + - Snapshot-based backups. + - Physical backups. + enum: + - SQL_BACKUP_KIND_UNSPECIFIED + - SNAPSHOT + - PHYSICAL + timeZone: + description: >- + Output only. This output contains a backup time zone. If a Cloud SQL + for SQL Server instance has a different time zone from the backup's + time zone, then the restore to the instance doesn't happen. + readOnly: true + type: string + ttlDays: + description: >- + Input only. The time-to-live (TTL) interval for this resource (in + days). For example: ttlDays:7, means 7 days from the current time. + The expiration time can't exceed 365 days from the time that the + backup is created. + type: string + format: int64 + expiryTime: + description: Backup expiration time. A UTC timestamp of when this backup expired. + type: string + format: google-datetime + databaseVersion: + description: >- + Output only. The database version of the instance of at the time + this backup was made. + readOnly: true + type: string + enumDescriptions: + - This is an unknown database version. + - The database version is MySQL 5.1. + - The database version is MySQL 5.5. + - The database version is MySQL 5.6. + - The database version is MySQL 5.7. + - The database version is MySQL 8. + - >- + The database major version is MySQL 8.0 and the minor version is + 18. + - >- + The database major version is MySQL 8.0 and the minor version is + 26. + - >- + The database major version is MySQL 8.0 and the minor version is + 27. + - >- + The database major version is MySQL 8.0 and the minor version is + 28. + - >- + The database major version is MySQL 8.0 and the minor version is + 29. + - >- + The database major version is MySQL 8.0 and the minor version is + 30. + - >- + The database major version is MySQL 8.0 and the minor version is + 31. + - >- + The database major version is MySQL 8.0 and the minor version is + 32. + - >- + The database major version is MySQL 8.0 and the minor version is + 33. + - >- + The database major version is MySQL 8.0 and the minor version is + 34. + - >- + The database major version is MySQL 8.0 and the minor version is + 35. + - >- + The database major version is MySQL 8.0 and the minor version is + 36. + - >- + The database major version is MySQL 8.0 and the minor version is + 37. + - >- + The database major version is MySQL 8.0 and the minor version is + 39. + - >- + The database major version is MySQL 8.0 and the minor version is + 40. + - >- + The database major version is MySQL 8.0 and the minor version is + 41. + - >- + The database major version is MySQL 8.0 and the minor version is + 42. + - >- + The database major version is MySQL 8.0 and the minor version is + 43. + - >- + The database major version is MySQL 8.0 and the minor version is + 44. + - >- + The database major version is MySQL 8.0 and the minor version is + 45. + - >- + The database major version is MySQL 8.0 and the minor version is + 46. + - The database version is MySQL 8.4. + - The database version is SQL Server 2017 Standard. + - The database version is SQL Server 2017 Enterprise. + - The database version is SQL Server 2017 Express. + - The database version is SQL Server 2017 Web. + - The database version is PostgreSQL 9.6. + - The database version is PostgreSQL 10. + - The database version is PostgreSQL 11. + - The database version is PostgreSQL 12. + - The database version is PostgreSQL 13. + - The database version is PostgreSQL 14. + - The database version is PostgreSQL 15. + - The database version is PostgreSQL 16. + - The database version is PostgreSQL 17. + - The database version is SQL Server 2019 Standard. + - The database version is SQL Server 2019 Enterprise. + - The database version is SQL Server 2019 Express. + - The database version is SQL Server 2019 Web. + - The database version is SQL Server 2022 Standard. + - The database version is SQL Server 2022 Enterprise. + - The database version is SQL Server 2022 Express. + - The database version is SQL Server 2022 Web. + enumDeprecated: + - false + - true + - true + - false + - false + - false + - false + - false + - false + - false + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + enum: + - SQL_DATABASE_VERSION_UNSPECIFIED + - MYSQL_5_1 + - MYSQL_5_5 + - MYSQL_5_6 + - MYSQL_5_7 + - MYSQL_8_0 + - MYSQL_8_0_18 + - MYSQL_8_0_26 + - MYSQL_8_0_27 + - MYSQL_8_0_28 + - MYSQL_8_0_29 + - MYSQL_8_0_30 + - MYSQL_8_0_31 + - MYSQL_8_0_32 + - MYSQL_8_0_33 + - MYSQL_8_0_34 + - MYSQL_8_0_35 + - MYSQL_8_0_36 + - MYSQL_8_0_37 + - MYSQL_8_0_39 + - MYSQL_8_0_40 + - MYSQL_8_0_41 + - MYSQL_8_0_42 + - MYSQL_8_0_43 + - MYSQL_8_0_44 + - MYSQL_8_0_45 + - MYSQL_8_0_46 + - MYSQL_8_4 + - SQLSERVER_2017_STANDARD + - SQLSERVER_2017_ENTERPRISE + - SQLSERVER_2017_EXPRESS + - SQLSERVER_2017_WEB + - POSTGRES_9_6 + - POSTGRES_10 + - POSTGRES_11 + - POSTGRES_12 + - POSTGRES_13 + - POSTGRES_14 + - POSTGRES_15 + - POSTGRES_16 + - POSTGRES_17 + - SQLSERVER_2019_STANDARD + - SQLSERVER_2019_ENTERPRISE + - SQLSERVER_2019_EXPRESS + - SQLSERVER_2019_WEB + - SQLSERVER_2022_STANDARD + - SQLSERVER_2022_ENTERPRISE + - SQLSERVER_2022_EXPRESS + - SQLSERVER_2022_WEB + maxChargeableBytes: + description: Output only. The maximum chargeable bytes for the backup. + readOnly: true + type: string + format: int64 + instanceDeletionTime: + description: >- + Optional. Output only. Timestamp in UTC of when the instance + associated with this backup is deleted. + readOnly: true + type: string + format: google-datetime + instanceSettings: + description: >- + Optional. Output only. The instance setting of the source instance + that's associated with this backup. + readOnly: true + $ref: '#/components/schemas/DatabaseInstance' + backupRun: + description: >- + Output only. The mapping to backup run resource used for IAM + validations. + readOnly: true + type: string + satisfiesPzs: + description: >- + Output only. This status indicates whether the backup satisfies PZS. + The status is reserved for future use. + readOnly: true + type: boolean + satisfiesPzi: + description: >- + Output only. This status indicates whether the backup satisfies PZI. + The status is reserved for future use. + readOnly: true + type: boolean + Interval: + id: Interval + description: >- + Represents a time interval, encoded as a Timestamp start (inclusive) and + a Timestamp end (exclusive). The start must be less than or equal to the + end. When the start equals the end, the interval is empty (matches no + time). When both start and end are unspecified, the interval matches any + time. + type: object + properties: + startTime: + description: >- + Optional. Inclusive start of the interval. If specified, a Timestamp + matching this interval will have to be the same or after the start. type: string - items: + format: google-datetime + endTime: description: >- - A list of backup runs in reverse chronological order of the enqueued - time. + Optional. Exclusive end of the interval. If specified, a Timestamp + matching this interval will have to be before the end. + type: string + format: google-datetime + ListBackupsResponse: + id: ListBackupsResponse + description: The response payload containing a list of the backups. + type: object + properties: + backups: + description: A list of backups. type: array items: - $ref: '#/components/schemas/BackupRun' + $ref: '#/components/schemas/Backup' nextPageToken: description: >- - The continuation token, used to page through large result sets. - Provide this value in a subsequent request to return the next page - of results. + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, then there aren't subsequent pages. type: string + warnings: + description: >- + If a region isn't unavailable or if an unknown error occurs, then a + warning message is returned. + type: array + items: + $ref: '#/components/schemas/ApiWarning' ConnectSettings: id: ConnectSettings description: Connect settings retrieval response. @@ -3515,19 +4849,6 @@ components: - The database version is MySQL 5.5. - The database version is MySQL 5.6. - The database version is MySQL 5.7. - - The database version is SQL Server 2017 Standard. - - The database version is SQL Server 2017 Enterprise. - - The database version is SQL Server 2017 Express. - - The database version is SQL Server 2017 Web. - - The database version is PostgreSQL 9.6. - - The database version is PostgreSQL 10. - - The database version is PostgreSQL 11. - - The database version is PostgreSQL 12. - - The database version is PostgreSQL 13. - - The database version is PostgreSQL 14. - - The database version is PostgreSQL 15. - - The database version is PostgreSQL 16. - - The database version is PostgreSQL 17. - The database version is MySQL 8. - >- The database major version is MySQL 8.0 and the minor version is @@ -3568,16 +4889,44 @@ components: - >- The database major version is MySQL 8.0 and the minor version is 37. - - >- - The database major version is MySQL 8.0 and the minor version is - 38. - >- The database major version is MySQL 8.0 and the minor version is 39. - >- The database major version is MySQL 8.0 and the minor version is 40. + - >- + The database major version is MySQL 8.0 and the minor version is + 41. + - >- + The database major version is MySQL 8.0 and the minor version is + 42. + - >- + The database major version is MySQL 8.0 and the minor version is + 43. + - >- + The database major version is MySQL 8.0 and the minor version is + 44. + - >- + The database major version is MySQL 8.0 and the minor version is + 45. + - >- + The database major version is MySQL 8.0 and the minor version is + 46. - The database version is MySQL 8.4. + - The database version is SQL Server 2017 Standard. + - The database version is SQL Server 2017 Enterprise. + - The database version is SQL Server 2017 Express. + - The database version is SQL Server 2017 Web. + - The database version is PostgreSQL 9.6. + - The database version is PostgreSQL 10. + - The database version is PostgreSQL 11. + - The database version is PostgreSQL 12. + - The database version is PostgreSQL 13. + - The database version is PostgreSQL 14. + - The database version is PostgreSQL 15. + - The database version is PostgreSQL 16. + - The database version is PostgreSQL 17. - The database version is SQL Server 2019 Standard. - The database version is SQL Server 2019 Enterprise. - The database version is SQL Server 2019 Express. @@ -3597,6 +4946,12 @@ components: - false - false - false + - true + - false + - false + - false + - false + - false - false - false - false @@ -3610,7 +4965,6 @@ components: - false - false - false - - true - false - false - false @@ -3637,19 +4991,6 @@ components: - MYSQL_5_5 - MYSQL_5_6 - MYSQL_5_7 - - SQLSERVER_2017_STANDARD - - SQLSERVER_2017_ENTERPRISE - - SQLSERVER_2017_EXPRESS - - SQLSERVER_2017_WEB - - POSTGRES_9_6 - - POSTGRES_10 - - POSTGRES_11 - - POSTGRES_12 - - POSTGRES_13 - - POSTGRES_14 - - POSTGRES_15 - - POSTGRES_16 - - POSTGRES_17 - MYSQL_8_0 - MYSQL_8_0_18 - MYSQL_8_0_26 @@ -3664,10 +5005,28 @@ components: - MYSQL_8_0_35 - MYSQL_8_0_36 - MYSQL_8_0_37 - - MYSQL_8_0_38 - MYSQL_8_0_39 - MYSQL_8_0_40 + - MYSQL_8_0_41 + - MYSQL_8_0_42 + - MYSQL_8_0_43 + - MYSQL_8_0_44 + - MYSQL_8_0_45 + - MYSQL_8_0_46 - MYSQL_8_4 + - SQLSERVER_2017_STANDARD + - SQLSERVER_2017_ENTERPRISE + - SQLSERVER_2017_EXPRESS + - SQLSERVER_2017_WEB + - POSTGRES_9_6 + - POSTGRES_10 + - POSTGRES_11 + - POSTGRES_12 + - POSTGRES_13 + - POSTGRES_14 + - POSTGRES_15 + - POSTGRES_16 + - POSTGRES_17 - SQLSERVER_2019_STANDARD - SQLSERVER_2019_ENTERPRISE - SQLSERVER_2019_EXPRESS @@ -3713,10 +5072,84 @@ components: - >- Google-managed regional CA part of root CA hierarchy hosted on Google Cloud's Certificate Authority Service (CAS). + - >- + Customer-managed CA hosted on Google Cloud's Certificate Authority + Service (CAS). enum: - CA_MODE_UNSPECIFIED - GOOGLE_MANAGED_INTERNAL_CA - GOOGLE_MANAGED_CAS_CA + - CUSTOMER_MANAGED_CAS_CA + customSubjectAlternativeNames: + description: Custom subject alternative names for the server certificate. + type: array + items: + type: string + dnsNames: + description: Output only. The list of DNS names used by this instance. + readOnly: true + type: array + items: + $ref: '#/components/schemas/DnsNameMapping' + nodeCount: + description: The number of read pool nodes in a read pool. + type: integer + format: int32 + nodes: + description: >- + Output only. Entries containing information about each read pool + node of the read pool. + readOnly: true + type: array + items: + $ref: '#/components/schemas/ConnectPoolNodeConfig' + mdxProtocolSupport: + description: >- + Optional. Output only. mdx_protocol_support controls how the client + uses metadata exchange when connecting to the instance. The values + in the list representing parts of the MDX protocol that are + supported by this instance. When the list is empty, the instance + does not support MDX, so the client must not send an MDX request. + The default is empty. + readOnly: true + type: array + items: + type: string + enumDescriptions: + - Not specified. + - Client should send the client protocol type in the MDX request. + enum: + - MDX_PROTOCOL_SUPPORT_UNSPECIFIED + - CLIENT_PROTOCOL_TYPE + ConnectPoolNodeConfig: + id: ConnectPoolNodeConfig + description: Details of a single read pool node of a read pool. + type: object + properties: + name: + description: >- + Output only. The name of the read pool node. Doesn't include the + project ID. + readOnly: true + type: string + ipAddresses: + description: >- + Output only. Mappings containing IP addresses that can be used to + connect to the read pool node. + readOnly: true + type: array + items: + $ref: '#/components/schemas/IpMapping' + dnsName: + description: Output only. The DNS name of the read pool node. + readOnly: true + type: string + dnsNames: + description: Output only. The list of DNS names used by this read pool node. + readOnly: true + type: array + items: + $ref: '#/components/schemas/DnsNameMapping' GenerateEphemeralCertRequest: id: GenerateEphemeralCertRequest description: Ephemeral certificate creation request. @@ -3881,19 +5314,6 @@ components: - The database version is MySQL 5.5. - The database version is MySQL 5.6. - The database version is MySQL 5.7. - - The database version is SQL Server 2017 Standard. - - The database version is SQL Server 2017 Enterprise. - - The database version is SQL Server 2017 Express. - - The database version is SQL Server 2017 Web. - - The database version is PostgreSQL 9.6. - - The database version is PostgreSQL 10. - - The database version is PostgreSQL 11. - - The database version is PostgreSQL 12. - - The database version is PostgreSQL 13. - - The database version is PostgreSQL 14. - - The database version is PostgreSQL 15. - - The database version is PostgreSQL 16. - - The database version is PostgreSQL 17. - The database version is MySQL 8. - >- The database major version is MySQL 8.0 and the minor version is @@ -3934,16 +5354,44 @@ components: - >- The database major version is MySQL 8.0 and the minor version is 37. - - >- - The database major version is MySQL 8.0 and the minor version is - 38. - >- The database major version is MySQL 8.0 and the minor version is 39. - >- The database major version is MySQL 8.0 and the minor version is 40. + - >- + The database major version is MySQL 8.0 and the minor version is + 41. + - >- + The database major version is MySQL 8.0 and the minor version is + 42. + - >- + The database major version is MySQL 8.0 and the minor version is + 43. + - >- + The database major version is MySQL 8.0 and the minor version is + 44. + - >- + The database major version is MySQL 8.0 and the minor version is + 45. + - >- + The database major version is MySQL 8.0 and the minor version is + 46. - The database version is MySQL 8.4. + - The database version is SQL Server 2017 Standard. + - The database version is SQL Server 2017 Enterprise. + - The database version is SQL Server 2017 Express. + - The database version is SQL Server 2017 Web. + - The database version is PostgreSQL 9.6. + - The database version is PostgreSQL 10. + - The database version is PostgreSQL 11. + - The database version is PostgreSQL 12. + - The database version is PostgreSQL 13. + - The database version is PostgreSQL 14. + - The database version is PostgreSQL 15. + - The database version is PostgreSQL 16. + - The database version is PostgreSQL 17. - The database version is SQL Server 2019 Standard. - The database version is SQL Server 2019 Enterprise. - The database version is SQL Server 2019 Express. @@ -3963,6 +5411,12 @@ components: - false - false - false + - true + - false + - false + - false + - false + - false - false - false - false @@ -3976,7 +5430,6 @@ components: - false - false - false - - true - false - false - false @@ -4003,19 +5456,6 @@ components: - MYSQL_5_5 - MYSQL_5_6 - MYSQL_5_7 - - SQLSERVER_2017_STANDARD - - SQLSERVER_2017_ENTERPRISE - - SQLSERVER_2017_EXPRESS - - SQLSERVER_2017_WEB - - POSTGRES_9_6 - - POSTGRES_10 - - POSTGRES_11 - - POSTGRES_12 - - POSTGRES_13 - - POSTGRES_14 - - POSTGRES_15 - - POSTGRES_16 - - POSTGRES_17 - MYSQL_8_0 - MYSQL_8_0_18 - MYSQL_8_0_26 @@ -4030,10 +5470,28 @@ components: - MYSQL_8_0_35 - MYSQL_8_0_36 - MYSQL_8_0_37 - - MYSQL_8_0_38 - MYSQL_8_0_39 - MYSQL_8_0_40 + - MYSQL_8_0_41 + - MYSQL_8_0_42 + - MYSQL_8_0_43 + - MYSQL_8_0_44 + - MYSQL_8_0_45 + - MYSQL_8_0_46 - MYSQL_8_4 + - SQLSERVER_2017_STANDARD + - SQLSERVER_2017_ENTERPRISE + - SQLSERVER_2017_EXPRESS + - SQLSERVER_2017_WEB + - POSTGRES_9_6 + - POSTGRES_10 + - POSTGRES_11 + - POSTGRES_12 + - POSTGRES_13 + - POSTGRES_14 + - POSTGRES_15 + - POSTGRES_16 + - POSTGRES_17 - SQLSERVER_2019_STANDARD - SQLSERVER_2019_ENTERPRISE - SQLSERVER_2019_EXPRESS @@ -4074,6 +5532,24 @@ components: items: type: string format: int64 + flagScope: + description: Scope of flag. + type: string + enumDescriptions: + - Assume database flags if unspecified + - database flags + - connection pool configuration flags + enum: + - SQL_FLAG_SCOPE_UNSPECIFIED + - SQL_FLAG_SCOPE_DATABASE + - SQL_FLAG_SCOPE_CONNECTION_POOL + recommendedStringValue: + description: Recommended string value in string format for UI display. + type: string + recommendedIntValue: + description: Recommended int value in integer format for UI display. + type: string + format: int64 OperationsListResponse: id: OperationsListResponse description: Operations list response. @@ -4377,8 +5853,8 @@ components: description: >- Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully - have Operation.error value with a google.rpc.Status.code of 1, - corresponding to `Code.CANCELLED`. + have google.longrunning.Operation.error value with a + google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. readOnly: true type: boolean apiVersion: @@ -4674,6 +6150,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + execute_sql: + operation: + $ref: >- + #/paths/~1v1~1projects~1{project}~1instances~1{instance}~1executeSql/post + response: + mediaType: application/json + openAPIDocKey: '200' acquire_ssrs_lease: operation: $ref: >- @@ -4688,6 +6171,12 @@ components: response: mediaType: application/json openAPIDocKey: '200' + point_in_time_restore: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}:pointInTimeRestore/post' + response: + mediaType: application/json + openAPIDocKey: '200' reschedule_maintenance: operation: $ref: >- @@ -4865,43 +6354,84 @@ components: methods: delete: operation: - $ref: >- - #/paths/~1v1~1projects~1{project}~1instances~1{instance}~1backupRuns~1{id}/delete + $ref: >- + #/paths/~1v1~1projects~1{project}~1instances~1{instance}~1backupRuns~1{id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{project}~1instances~1{instance}~1backupRuns~1{id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + insert: + operation: + $ref: >- + #/paths/~1v1~1projects~1{project}~1instances~1{instance}~1backupRuns/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{project}~1instances~1{instance}~1backupRuns/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/backup_runs/methods/get' + - $ref: '#/components/x-stackQL-resources/backup_runs/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/backup_runs/methods/insert' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/backup_runs/methods/delete' + backups: + id: google.sqladmin.backups + name: backups + title: Backups + methods: + create_backup: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1backups/post' response: mediaType: application/json openAPIDocKey: '200' - get: + list_backups: operation: - $ref: >- - #/paths/~1v1~1projects~1{project}~1instances~1{instance}~1backupRuns~1{id}/get + $ref: '#/paths/~1v1~1projects~1{projectsId}~1backups/get' response: mediaType: application/json openAPIDocKey: '200' - insert: + get_backup: operation: - $ref: >- - #/paths/~1v1~1projects~1{project}~1instances~1{instance}~1backupRuns/post + $ref: '#/paths/~1v1~1projects~1{projectsId}~1backups~1{backupsId}/get' response: mediaType: application/json openAPIDocKey: '200' - list: + update_backup: operation: - $ref: >- - #/paths/~1v1~1projects~1{project}~1instances~1{instance}~1backupRuns/get + $ref: '#/paths/~1v1~1projects~1{projectsId}~1backups~1{backupsId}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_backup: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1backups~1{backupsId}/delete' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.items sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/backup_runs/methods/get' - - $ref: '#/components/x-stackQL-resources/backup_runs/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/backup_runs/methods/insert' + select: [] + insert: [] update: [] replace: [] - delete: - - $ref: '#/components/x-stackQL-resources/backup_runs/methods/delete' + delete: [] connect: id: google.sqladmin.connect name: connect @@ -5269,6 +6799,24 @@ paths: required: true schema: type: string + - in: query + name: enableFinalBackup + schema: + type: boolean + - in: query + name: finalBackupTtlDays + schema: + type: string + format: int64 + - in: query + name: finalBackupExpiryTime + schema: + type: string + format: google-datetime + - in: query + name: finalBackupDescription + schema: + type: string get: description: Retrieves a resource containing information about a Cloud SQL instance. operationId: sql.instances.get @@ -5790,9 +7338,7 @@ paths: /v1/projects/{project}/instances/{instance}/switchover: parameters: *ref_1 post: - description: >- - Switches over from the primary instance to the designated DR replica - instance. + description: Switches over from the primary instance to the DR replica instance. operationId: sql.instances.switchover security: - Oauth2: @@ -6113,6 +7659,43 @@ paths: required: true schema: type: string + /v1/projects/{project}/instances/{instance}/executeSql: + parameters: *ref_1 + post: + description: Execute SQL statements. + operationId: sql.instances.executeSql + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExecuteSqlPayload' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/sqlservice.admin + Oauth2c: + - https://www.googleapis.com/auth/sqlservice.admin + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SqlInstancesExecuteSqlResponse' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: instance + required: true + schema: + type: string /v1/projects/{project}/instances/{instance}/acquireSsrsLease: parameters: *ref_1 post: @@ -6182,6 +7765,40 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}:pointInTimeRestore: + parameters: *ref_1 + post: + description: >- + Point in time restore for an instance managed by Google Cloud Backup and + Disaster Recovery. + operationId: sql.instances.pointInTimeRestore + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PointInTimeRestoreContext' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/sqlservice.admin + Oauth2c: + - https://www.googleapis.com/auth/sqlservice.admin + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string /v1/projects/{project}/instances/{instance}/createEphemeral: parameters: *ref_1 post: @@ -6622,6 +8239,11 @@ paths: required: true schema: type: string + - in: query + name: sourceInstanceDeletionTime + schema: + type: string + format: google-datetime /v1/projects/{project}/instances/{instance}/backupRuns/{id}: parameters: *ref_1 delete: @@ -6773,6 +8395,182 @@ paths: name: pageToken schema: type: string + /v1/projects/{projectsId}/backups: + parameters: *ref_1 + post: + description: >- + Creates a backup for a Cloud SQL instance. This API can be used only to + create on-demand backups. + operationId: sql.Backups.CreateBackup + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Backup' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/sqlservice.admin + Oauth2c: + - https://www.googleapis.com/auth/sqlservice.admin + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + get: + description: Lists all backups associated with the project. + operationId: sql.Backups.ListBackups + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/sqlservice.admin + Oauth2c: + - https://www.googleapis.com/auth/sqlservice.admin + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListBackupsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/backups/{backupsId}: + parameters: *ref_1 + get: + description: Retrieves a resource containing information about a backup. + operationId: sql.Backups.GetBackup + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/sqlservice.admin + Oauth2c: + - https://www.googleapis.com/auth/sqlservice.admin + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Backup' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: backupsId + required: true + schema: + type: string + patch: + description: >- + Updates the retention period and description of the backup. You can use + this API to update final backups only. + operationId: sql.Backups.UpdateBackup + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Backup' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/sqlservice.admin + Oauth2c: + - https://www.googleapis.com/auth/sqlservice.admin + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: backupsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes the backup. + operationId: sql.Backups.DeleteBackup + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/sqlservice.admin + Oauth2c: + - https://www.googleapis.com/auth/sqlservice.admin + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: backupsId + required: true + schema: + type: string /v1/projects/{project}/instances/{instance}/connectSettings: parameters: *ref_1 get: @@ -7105,6 +8903,10 @@ paths: name: databaseVersion schema: type: string + - in: query + name: flagScope + schema: + type: string /v1/projects/{project}/operations/{operation}: parameters: *ref_1 get: diff --git a/providers/src/googleapis.com/v00.00.00000/services/storage.yaml b/providers/src/googleapis.com/v00.00.00000/services/storage.yaml index f64ed2e0..45dfbf1d 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/storage.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/storage.yaml @@ -7,8 +7,8 @@ info: title: Cloud Storage JSON API description: Stores and retrieves potentially large, immutable data objects. version: v1 - x-discovery-doc-revision: '20241031' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250822' + x-generated-date: '2025-08-28' externalDocs: url: https://developers.google.com/storage/docs/json_api/ servers: @@ -134,6 +134,99 @@ components: description: >- A Cloud KMS key that will be used to encrypt objects inserted into this bucket, if no encryption method is specified. + googleManagedEncryptionEnforcementConfig: + type: object + description: >- + If set, the new objects created in this bucket must comply with + this enforcement config. Changing this has no effect on existing + objects; it applies to new objects only. If omitted, the new + objects are allowed to be encrypted with Google Managed + Encryption type by default. + properties: + restrictionMode: + type: string + description: >- + Restriction mode for Google-Managed Encryption Keys. + Defaults to NotRestricted. + enum: + - NotRestricted + - FullyRestricted + enumDescriptions: + - >- + Creation of new objects with Google Managed Encryption is + not restricted. + - >- + Creation of new objects with Google Managed Encryption is + fully restricted. + effectiveTime: + type: string + description: >- + Server-determined value that indicates the time from which + configuration was enforced and effective. This value is in + RFC 3339 format. + format: date-time + customerManagedEncryptionEnforcementConfig: + type: object + description: >- + If set, the new objects created in this bucket must comply with + this enforcement config. Changing this has no effect on existing + objects; it applies to new objects only. If omitted, the new + objects are allowed to be encrypted with Customer Managed + Encryption type by default. + properties: + restrictionMode: + type: string + description: >- + Restriction mode for Customer-Managed Encryption Keys. + Defaults to NotRestricted. + enum: + - NotRestricted + - FullyRestricted + enumDescriptions: + - >- + Creation of new objects with Customer-Managed Encryption + is not restricted. + - >- + Creation of new objects with Customer-Managed Encryption + is fully restricted. + effectiveTime: + type: string + description: >- + Server-determined value that indicates the time from which + configuration was enforced and effective. This value is in + RFC 3339 format. + format: date-time + customerSuppliedEncryptionEnforcementConfig: + type: object + description: >- + If set, the new objects created in this bucket must comply with + this enforcement config. Changing this has no effect on existing + objects; it applies to new objects only. If omitted, the new + objects are allowed to be encrypted with Customer Supplied + Encryption type by default. + properties: + restrictionMode: + type: string + description: >- + Restriction mode for Customer-Supplied Encryption Keys. + Defaults to NotRestricted. + enum: + - NotRestricted + - FullyRestricted + enumDescriptions: + - >- + Creation of new objects with Customer-Supplied Encryption + is not restricted. + - >- + Creation of new objects with Customer-Supplied Encryption + is fully restricted. + effectiveTime: + type: string + description: >- + Server-determined value that indicates the time from which + configuration was enforced and effective. This value is in + RFC 3339 format. + format: date-time etag: type: string description: HTTP 1.1 Entity tag for the bucket. @@ -248,6 +341,16 @@ components: allowed to access the bucket. items: type: string + allowCrossOrgVpcs: + type: boolean + description: >- + Whether to allow cross-org VPCs in the bucket's IP filter + configuration. + allowAllServiceAgentAccess: + type: boolean + description: >- + Whether to allow all service agents to access the bucket + regardless of the IP filter configuration. kind: type: string description: >- @@ -1503,6 +1606,19 @@ components: additionalProperties: type: string description: An individual metadata entry. + contexts: + type: object + description: >- + User-defined or system-defined object contexts. Each object context + is a key-payload pair, where the key provides the identification and + the payload holds the associated value and additional metadata. + properties: + custom: + type: object + description: User-defined object contexts. + additionalProperties: + $ref: '#/components/schemas/ObjectCustomContextPayload' + description: A single user-defined object context. restoreToken: type: string description: >- @@ -1588,6 +1704,10 @@ components: Will be returned if and only if this version of the object has been deleted. format: date-time + timeFinalized: + type: string + description: The time when the object was finalized. + format: date-time softDeleteTime: type: string description: The time at which the object became soft-deleted in RFC 3339 format. @@ -1719,6 +1839,24 @@ components: The kind of item this is. For lists of object access control entries, this is always storage#objectAccessControls. default: storage#objectAccessControls + ObjectCustomContextPayload: + id: ObjectCustomContextPayload + type: object + description: The payload of a single user-defined object context. + properties: + value: + type: string + description: The value of the object context. + createTime: + type: string + description: The time at which the object context was created in RFC 3339 format. + format: date-time + updateTime: + type: string + description: >- + The time at which the object context was last updated in RFC 3339 + format. + format: date-time Objects: id: Objects type: object @@ -1774,35 +1912,35 @@ components: A collection of identifiers for members who may assume the provided role. Recognized identifiers are as follows: - - allUsers — A special identifier that represents anyone on + - allUsers - A special identifier that represents anyone on the internet; with or without a Google account. - - allAuthenticatedUsers — A special identifier that represents + - 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 + - user:emailid - An email address that represents a specific account. For example, user:alice@gmail.com or user:joe@example.com. - - serviceAccount:emailid — An email address that represents a + - serviceAccount:emailid - An email address that represents a service account. For example, serviceAccount:my-other-app@appspot.gserviceaccount.com . - - group:emailid — An email address that represents a Google + - group:emailid - An email address that represents a Google group. For example, group:admins@example.com. - - domain:domain — A Google Apps domain name that represents + - domain:domain - A Google Apps domain name that represents all the users of that domain. For example, domain:google.com or domain:example.com. - - projectOwner:projectid — Owners of the given project. For + - projectOwner:projectid - Owners of the given project. For example, projectOwner:my-example-project - - projectEditor:projectid — Editors of the given project. For + - projectEditor:projectid - Editors of the given project. For example, projectEditor:my-example-project - - projectViewer:projectid — Viewers of the given project. For + - projectViewer:projectid - Viewers of the given project. For example, projectViewer:my-example-project items: type: string @@ -1822,35 +1960,35 @@ components: The new IAM roles are: - - roles/storage.admin — Full control of Google Cloud Storage + - roles/storage.admin - Full control of Google Cloud Storage resources. - - roles/storage.objectViewer — Read-Only access to Google + - roles/storage.objectViewer - Read-Only access to Google Cloud Storage objects. - - roles/storage.objectCreator — Access to create objects in + - roles/storage.objectCreator - Access to create objects in Google Cloud Storage. - - roles/storage.objectAdmin — Full control of Google Cloud + - roles/storage.objectAdmin - Full control of Google Cloud Storage objects. The legacy IAM roles are: - - roles/storage.legacyObjectReader — Read-only access to + - roles/storage.legacyObjectReader - Read-only access to objects without listing. Equivalent to an ACL entry on an object with the READER role. - - roles/storage.legacyObjectOwner — Read/write access to + - roles/storage.legacyObjectOwner - Read/write access to existing objects without listing. Equivalent to an ACL entry on an object with the OWNER role. - - roles/storage.legacyBucketReader — Read access to buckets + - roles/storage.legacyBucketReader - Read access to buckets with object listing. Equivalent to an ACL entry on a bucket with the READER role. - - roles/storage.legacyBucketWriter — Read access to buckets + - roles/storage.legacyBucketWriter - Read access to buckets with object listing/creation/deletion. Equivalent to an ACL entry on a bucket with the WRITER role. - - roles/storage.legacyBucketOwner — Read and write access to + - roles/storage.legacyBucketOwner - Read and write access to existing buckets with object listing/creation/deletion. Equivalent to an ACL entry on a bucket with the OWNER role. annotations: @@ -1981,46 +2119,46 @@ components: buckets, objects, or managedFolders. The supported permissions are as follows: - - storage.buckets.delete — Delete bucket. + - storage.buckets.delete - Delete bucket. - - storage.buckets.get — Read bucket metadata. + - storage.buckets.get - Read bucket metadata. - - storage.buckets.getIamPolicy — Read bucket IAM policy. + - storage.buckets.getIamPolicy - Read bucket IAM policy. - - storage.buckets.create — Create bucket. + - storage.buckets.create - Create bucket. - - storage.buckets.list — List buckets. + - storage.buckets.list - List buckets. - - storage.buckets.setIamPolicy — Update bucket IAM policy. + - storage.buckets.setIamPolicy - Update bucket IAM policy. - - storage.buckets.update — Update bucket metadata. + - storage.buckets.update - Update bucket metadata. - - storage.objects.delete — Delete object. + - storage.objects.delete - Delete object. - - storage.objects.get — Read object data and metadata. + - storage.objects.get - Read object data and metadata. - - storage.objects.getIamPolicy — Read object IAM policy. + - storage.objects.getIamPolicy - Read object IAM policy. - - storage.objects.create — Create object. + - storage.objects.create - Create object. - - storage.objects.list — List objects. + - storage.objects.list - List objects. - - storage.objects.setIamPolicy — Update object IAM policy. + - storage.objects.setIamPolicy - Update object IAM policy. - - storage.objects.update — Update object metadata. + - storage.objects.update - Update object metadata. - - storage.managedFolders.delete — Delete managed folder. + - storage.managedFolders.delete - Delete managed folder. - - storage.managedFolders.get — Read managed folder metadata. + - storage.managedFolders.get - Read managed folder metadata. - - storage.managedFolders.getIamPolicy — Read managed folder IAM + - storage.managedFolders.getIamPolicy - Read managed folder IAM policy. - - storage.managedFolders.create — Create managed folder. + - storage.managedFolders.create - Create managed folder. - - storage.managedFolders.list — List managed folders. + - storage.managedFolders.list - List managed folders. - - storage.managedFolders.setIamPolicy — Update managed folder IAM + - storage.managedFolders.setIamPolicy - Update managed folder IAM policy. items: type: string @@ -2060,6 +2198,14 @@ components: description: >- If true, copies the source object's ACL; otherwise, uses the bucket's default object ACL. The default is false. + createdAfterTime: + type: string + description: Restores only the objects that were created after this time. + format: date-time + createdBeforeTime: + type: string + description: Restores only the objects that were created before this time. + format: date-time parameters: alt: description: Data format for the response. @@ -2069,6 +2215,7 @@ components: type: string enum: - json + - media fields: description: Selector specifying which fields to include in a partial response. in: query @@ -2760,6 +2907,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + move: + operation: + $ref: >- + #/paths/~1b~1{bucket}~1o~1{sourceObject}~1moveTo~1o~1{destinationObject}/post + response: + mediaType: application/json + openAPIDocKey: '200' watch_all: operation: $ref: '#/paths/~1b~1{bucket}~1o~1watch/post' @@ -3628,8 +3782,12 @@ paths: Oauth2c: - https://www.googleapis.com/auth/devstorage.read_write responses: - '204': - description: No Content + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Bucket' parameters: - in: path name: bucket @@ -3642,6 +3800,10 @@ paths: schema: type: string format: int64 + - in: query + name: projection + schema: + type: string - in: query name: userProject schema: @@ -6201,6 +6363,10 @@ paths: name: matchGlob schema: type: string + - in: query + name: filter + schema: + type: string - in: query name: softDeleted schema: @@ -6332,6 +6498,95 @@ paths: name: userProject schema: type: string + /b/{bucket}/o/{sourceObject}/moveTo/o/{destinationObject}: + parameters: *ref_1 + post: + description: Moves the source object to the destination object in the same bucket. + operationId: storage.objects.move + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + - Oauth2: + - https://www.googleapis.com/auth/devstorage.read_write + Oauth2c: + - https://www.googleapis.com/auth/devstorage.read_write + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Object' + parameters: + - in: path + name: bucket + required: true + schema: + type: string + - in: path + name: sourceObject + required: true + schema: + type: string + - in: path + name: destinationObject + required: true + schema: + type: string + - in: query + name: ifSourceGenerationMatch + schema: + type: string + format: int64 + - in: query + name: ifSourceGenerationNotMatch + schema: + type: string + format: int64 + - in: query + name: ifSourceMetagenerationMatch + schema: + type: string + format: int64 + - in: query + name: ifSourceMetagenerationNotMatch + schema: + type: string + format: int64 + - in: query + name: ifGenerationMatch + schema: + type: string + format: int64 + - in: query + name: ifGenerationNotMatch + schema: + type: string + format: int64 + - in: query + name: ifMetagenerationMatch + schema: + type: string + format: int64 + - in: query + name: ifMetagenerationNotMatch + schema: + type: string + format: int64 + - in: query + name: projection + schema: + type: string + - in: query + name: userProject + schema: + type: string /b/{bucket}/o/{object}/iam/testPermissions: parameters: *ref_1 get: diff --git a/providers/src/googleapis.com/v00.00.00000/services/storagebatchoperations.yaml b/providers/src/googleapis.com/v00.00.00000/services/storagebatchoperations.yaml new file mode 100644 index 00000000..0769364d --- /dev/null +++ b/providers/src/googleapis.com/v00.00.00000/services/storagebatchoperations.yaml @@ -0,0 +1,1385 @@ +openapi: 3.1.0 +info: + contact: + name: StackQL Studios + url: https://github.com/stackql/google-discovery-to-openapi + email: info@stackql.io + title: Storage Batch Operations API + description: '' + version: v1 + x-discovery-doc-revision: '20250820' + x-generated-date: '2025-08-28' +externalDocs: + url: https://cloud.google.com/storage/docs/batch-operations/overview +servers: + - url: https://storagebatchoperations.googleapis.com +components: + securitySchemes: + Oauth2: + type: oauth2 + description: Oauth 2.0 implicit authentication + flows: + implicit: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + scopes: &ref_0 + 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. + Oauth2c: + type: oauth2 + description: Oauth 2.0 authorization code authentication + flows: + authorizationCode: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + tokenUrl: https://accounts.google.com/o/oauth2/token + scopes: *ref_0 + schemas: + ListLocationsResponse: + id: ListLocationsResponse + description: The response message for Locations.ListLocations. + type: object + properties: + locations: + description: >- + A list of locations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/Location' + nextPageToken: + description: The standard List next-page token. + type: string + Location: + id: Location + description: A resource that represents a Google Cloud location. + type: object + properties: + name: + description: >- + Resource name for the location, which may vary between + implementations. For example: + `"projects/example-project/locations/us-east1"` + type: string + locationId: + description: 'The canonical id for this location. For example: `"us-east1"`.' + type: string + displayName: + description: >- + The friendly name for this location, typically a nearby city name. + For example, "Tokyo". + type: string + labels: + description: >- + Cross-service attributes for the location. For example + {"cloud.googleapis.com/region": "us-east1"} + type: object + additionalProperties: + type: string + metadata: + description: >- + Service-specific metadata. For example the available capacity at the + given location. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + ListOperationsResponse: + id: ListOperationsResponse + description: The response message for Operations.ListOperations. + type: object + properties: + operations: + description: >- + A list of operations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/Operation' + nextPageToken: + description: The standard List next-page token. + type: string + Operation: + id: Operation + description: >- + This resource represents a long-running operation that is the result of + a network API call. + type: object + properties: + name: + description: >- + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. + type: string + metadata: + description: >- + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + done: + description: >- + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + type: boolean + error: + description: >- + The error result of the operation in case of failure or + cancellation. + $ref: '#/components/schemas/Status' + response: + description: >- + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + Status: + id: Status + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + type: object + properties: + code: + description: The status code, which should be an enum value of google.rpc.Code. + type: integer + format: int32 + message: + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + type: string + details: + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + type: array + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + Empty: + id: Empty + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + type: object + properties: {} + CancelOperationRequest: + id: CancelOperationRequest + description: The request message for Operations.CancelOperation. + type: object + properties: {} + ListJobsResponse: + id: ListJobsResponse + description: Message for response to listing Jobs + type: object + properties: + jobs: + description: A list of storage batch jobs. + type: array + items: + $ref: '#/components/schemas/Job' + nextPageToken: + description: A token identifying a page of results. + type: string + unreachable: + description: Locations that could not be reached. + type: array + items: + type: string + Job: + id: Job + description: The Storage Batch Operations Job description. + type: object + properties: + name: + description: >- + Identifier. The resource name of the Job. job_id is unique within + the project, that is either set by the customer or defined by the + service. Format: projects/{project}/locations/global/jobs/{job_id} . + For example: "projects/123456/locations/global/jobs/job01". + type: string + description: + description: >- + Optional. A description provided by the user for the job. Its max + length is 1024 bytes when Unicode-encoded. + type: string + bucketList: + description: Specifies a list of buckets and their objects to be transformed. + $ref: '#/components/schemas/BucketList' + putObjectHold: + description: Changes object hold status. + $ref: '#/components/schemas/PutObjectHold' + deleteObject: + description: Delete objects. + $ref: '#/components/schemas/DeleteObject' + putMetadata: + description: >- + Updates object metadata. Allows updating fixed-key and custom + metadata and fixed-key metadata i.e. Cache-Control, + Content-Disposition, Content-Encoding, Content-Language, + Content-Type, Custom-Time. + $ref: '#/components/schemas/PutMetadata' + rewriteObject: + description: Rewrite the object and updates metadata like KMS key. + $ref: '#/components/schemas/RewriteObject' + loggingConfig: + description: Optional. Logging configuration. + $ref: '#/components/schemas/LoggingConfig' + createTime: + description: Output only. The time that the job was created. + readOnly: true + type: string + format: google-datetime + scheduleTime: + description: Output only. The time that the job was scheduled. + readOnly: true + type: string + format: google-datetime + completeTime: + description: Output only. The time that the job was completed. + readOnly: true + type: string + format: google-datetime + counters: + description: Output only. Information about the progress of the job. + readOnly: true + $ref: '#/components/schemas/Counters' + errorSummaries: + description: >- + Output only. Summarizes errors encountered with sample error log + entries. + readOnly: true + type: array + items: + $ref: '#/components/schemas/ErrorSummary' + state: + description: Output only. State of the job. + readOnly: true + type: string + enumDescriptions: + - Default value. This value is unused. + - In progress. + - Completed successfully. + - Cancelled by the user. + - Terminated due to an unrecoverable failure. + enum: + - STATE_UNSPECIFIED + - RUNNING + - SUCCEEDED + - CANCELED + - FAILED + BucketList: + id: BucketList + description: Describes list of buckets and their objects to be transformed. + type: object + properties: + buckets: + description: >- + Required. List of buckets and their objects to be transformed. + Currently, only one bucket configuration is supported. If multiple + buckets are specified, an error will be returned. + type: array + items: + $ref: '#/components/schemas/Bucket' + Bucket: + id: Bucket + description: >- + Describes configuration of a single bucket and its objects to be + transformed. + type: object + properties: + bucket: + description: Required. Bucket name for the objects to be transformed. + type: string + prefixList: + description: Specifies objects matching a prefix set. + $ref: '#/components/schemas/PrefixList' + manifest: + description: Specifies objects in a manifest file. + $ref: '#/components/schemas/Manifest' + PrefixList: + id: PrefixList + description: Describes prefixes of objects to be transformed. + type: object + properties: + includedObjectPrefixes: + description: >- + Optional. Include prefixes of the objects to be transformed. * + Supports full object name * Supports prefix of the object name * + Wildcards are not supported * Supports empty string for all objects + in a bucket. + type: array + items: + type: string + Manifest: + id: Manifest + description: Describes list of objects to be transformed. + type: object + properties: + manifestLocation: + description: >- + Required. `manifest_location` must contain the manifest source file + that is a CSV file in a Google Cloud Storage bucket. Each row in the + file must include the object details i.e. BucketId and Name. + Generation may optionally be specified. When it is not specified the + live object is acted upon. `manifest_location` should either be 1) + An absolute path to the object in the format of + `gs://bucket_name/path/file_name.csv`. 2) An absolute path with a + single wildcard character in the file name, for example + `gs://bucket_name/path/file_name*.csv`. If manifest location is + specified with a wildcard, objects in all manifest files matching + the pattern will be acted upon. + type: string + PutObjectHold: + id: PutObjectHold + description: Describes options to update object hold. + type: object + properties: + temporaryHold: + description: >- + Required. Updates object temporary holds state. When object + temporary hold is set, object cannot be deleted or replaced. + type: string + enumDescriptions: + - Default value, Object hold status will not be changed. + - Places the hold. + - Releases the hold. + enum: + - HOLD_STATUS_UNSPECIFIED + - SET + - UNSET + eventBasedHold: + description: >- + Required. Updates object event based holds state. When object event + based hold is set, object cannot be deleted or replaced. Resets + object's time in the bucket for the purposes of the retention + period. + type: string + enumDescriptions: + - Default value, Object hold status will not be changed. + - Places the hold. + - Releases the hold. + enum: + - HOLD_STATUS_UNSPECIFIED + - SET + - UNSET + DeleteObject: + id: DeleteObject + description: Describes options to delete an object. + type: object + properties: + permanentObjectDeletionEnabled: + description: >- + Required. Controls deletion behavior when versioning is enabled for + the object's bucket. If true both live and noncurrent objects will + be permanently deleted. Otherwise live objects in versioned buckets + will become noncurrent and objects that were already noncurrent will + be skipped. This setting doesn't have any impact on the Soft Delete + feature. All objects deleted by this service can be be restored for + the duration of the Soft Delete retention duration if enabled. If + enabled and the manifest doesn't specify an object's generation, a + GetObjectMetadata call (a Class B operation) will be made to + determine the live object generation. + type: boolean + PutMetadata: + id: PutMetadata + description: Describes options for object metadata update. + type: object + properties: + contentDisposition: + description: >- + Optional. Updates objects Content-Disposition fixed metadata. Unset + values will be ignored. Set empty values to clear the metadata. + Refer + https://cloud.google.com/storage/docs/metadata#content-disposition + for additional documentation. + type: string + contentEncoding: + description: >- + Optional. Updates objects Content-Encoding fixed metadata. Unset + values will be ignored. Set empty values to clear the metadata. + Refer to documentation in + https://cloud.google.com/storage/docs/metadata#content-encoding. + type: string + contentLanguage: + description: >- + Optional. Updates objects Content-Language fixed metadata. Refer to + ISO 639-1 language codes for typical values of this metadata. Max + length 100 characters. Unset values will be ignored. Set empty + values to clear the metadata. Refer to documentation in + https://cloud.google.com/storage/docs/metadata#content-language. + type: string + contentType: + description: >- + Optional. Updates objects Content-Type fixed metadata. Unset values + will be ignored. Set empty values to clear the metadata. Refer to + documentation in + https://cloud.google.com/storage/docs/metadata#content-type + type: string + cacheControl: + description: >- + Optional. Updates objects Cache-Control fixed metadata. Unset values + will be ignored. Set empty values to clear the metadata. + Additionally, the value for Custom-Time cannot decrease. Refer to + documentation in + https://cloud.google.com/storage/docs/metadata#caching_data. + type: string + customTime: + description: >- + Optional. Updates objects Custom-Time fixed metadata. Unset values + will be ignored. Set empty values to clear the metadata. Refer to + documentation in + https://cloud.google.com/storage/docs/metadata#custom-time. + type: string + customMetadata: + description: >- + Optional. Updates objects custom metadata. Adds or sets individual + custom metadata key value pairs on objects. Keys that are set with + empty custom metadata values will have its value cleared. Existing + custom metadata not specified with this flag is not changed. Refer + to documentation in + https://cloud.google.com/storage/docs/metadata#custom-metadata + type: object + additionalProperties: + type: string + RewriteObject: + id: RewriteObject + description: Describes options for object rewrite. + type: object + properties: + kmsKey: + description: >- + Required. Resource name of the Cloud KMS key that will be used to + encrypt the object. The Cloud KMS key must be located in same + location as the object. Refer to + https://cloud.google.com/storage/docs/encryption/using-customer-managed-keys#add-object-key + for additional documentation. Format: + projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key} + For example: + "projects/123456/locations/us-central1/keyRings/my-keyring/cryptoKeys/my-key". + The object will be rewritten and set with the specified KMS key. + type: string + LoggingConfig: + id: LoggingConfig + description: Specifies the Cloud Logging behavior. + type: object + properties: + logActions: + description: Required. Specifies the actions to be logged. + type: array + items: + type: string + enumDescriptions: + - Illegal value, to avoid allowing a default. + - The corresponding transform action in this job. + enum: + - LOGGABLE_ACTION_UNSPECIFIED + - TRANSFORM + logActionStates: + description: >- + Required. States in which Action are logged.If empty, no logs are + generated. + type: array + items: + type: string + enumDescriptions: + - Illegal value, to avoid allowing a default. + - >- + `LoggableAction` completed successfully. `SUCCEEDED` actions are + logged as INFO. + - >- + `LoggableAction` terminated in an error state. `FAILED` actions + are logged as ERROR. + enum: + - LOGGABLE_ACTION_STATE_UNSPECIFIED + - SUCCEEDED + - FAILED + Counters: + id: Counters + description: Describes details about the progress of the job. + type: object + properties: + totalObjectCount: + description: Output only. Number of objects listed. + readOnly: true + type: string + format: int64 + succeededObjectCount: + description: Output only. Number of objects completed. + readOnly: true + type: string + format: int64 + failedObjectCount: + description: Output only. Number of objects failed. + readOnly: true + type: string + format: int64 + ErrorSummary: + id: ErrorSummary + description: >- + A summary of errors by error code, plus a count and sample error log + entries. + type: object + properties: + errorCode: + description: Required. The canonical error code. + type: string + enumDescriptions: + - 'Not an error; returned on success. HTTP Mapping: 200 OK' + - >- + The operation was cancelled, typically by the caller. HTTP + Mapping: 499 Client Closed Request + - >- + Unknown error. For example, this error may be returned when a + `Status` value received from another address space belongs to an + error space that is not known in this address space. Also errors + raised by APIs that do not return enough error information may be + converted to this error. HTTP Mapping: 500 Internal Server Error + - >- + The client specified an invalid argument. Note that this differs + from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments + that are problematic regardless of the state of the system (e.g., + a malformed file name). HTTP Mapping: 400 Bad Request + - >- + The deadline expired before the operation could complete. For + operations that change the state of the system, this error may be + returned even if the operation has completed successfully. For + example, a successful response from a server could have been + delayed long enough for the deadline to expire. HTTP Mapping: 504 + Gateway Timeout + - >- + Some requested entity (e.g., file or directory) was not found. + Note to server developers: if a request is denied for an entire + class of users, such as gradual feature rollout or undocumented + allowlist, `NOT_FOUND` may be used. If a request is denied for + some users within a class of users, such as user-based access + control, `PERMISSION_DENIED` must be used. HTTP Mapping: 404 Not + Found + - >- + The entity that a client attempted to create (e.g., file or + directory) already exists. HTTP Mapping: 409 Conflict + - >- + The caller does not have permission to execute the specified + operation. `PERMISSION_DENIED` must not be used for rejections + caused by exhausting some resource (use `RESOURCE_EXHAUSTED` + instead for those errors). `PERMISSION_DENIED` must not be used if + the caller can not be identified (use `UNAUTHENTICATED` instead + for those errors). This error code does not imply the request is + valid or the requested entity exists or satisfies other + pre-conditions. HTTP Mapping: 403 Forbidden + - >- + The request does not have valid authentication credentials for the + operation. HTTP Mapping: 401 Unauthorized + - >- + Some resource has been exhausted, perhaps a per-user quota, or + perhaps the entire file system is out of space. HTTP Mapping: 429 + Too Many Requests + - >- + The operation was rejected because the system is not in a state + required for the operation's execution. For example, the directory + to be deleted is non-empty, an rmdir operation is applied to a + non-directory, etc. Service implementors can use the following + guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and + `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just + the failing call. (b) Use `ABORTED` if the client should retry at + a higher level. For example, when a client-specified test-and-set + fails, indicating the client should restart a read-modify-write + sequence. (c) Use `FAILED_PRECONDITION` if the client should not + retry until the system state has been explicitly fixed. For + example, if an "rmdir" fails because the directory is non-empty, + `FAILED_PRECONDITION` should be returned since the client should + not retry unless the files are deleted from the directory. HTTP + Mapping: 400 Bad Request + - >- + The operation was aborted, typically due to a concurrency issue + such as a sequencer check failure or transaction abort. See the + guidelines above for deciding between `FAILED_PRECONDITION`, + `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 409 Conflict + - >- + The operation was attempted past the valid range. E.g., seeking or + reading past end-of-file. Unlike `INVALID_ARGUMENT`, this error + indicates a problem that may be fixed if the system state changes. + For example, a 32-bit file system will generate `INVALID_ARGUMENT` + if asked to read at an offset that is not in the range [0,2^32-1], + but it will generate `OUT_OF_RANGE` if asked to read from an + offset past the current file size. There is a fair bit of overlap + between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We recommend + using `OUT_OF_RANGE` (the more specific error) when it applies so + that callers who are iterating through a space can easily look for + an `OUT_OF_RANGE` error to detect when they are done. HTTP + Mapping: 400 Bad Request + - >- + The operation is not implemented or is not supported/enabled in + this service. HTTP Mapping: 501 Not Implemented + - >- + Internal errors. This means that some invariants expected by the + underlying system have been broken. This error code is reserved + for serious errors. HTTP Mapping: 500 Internal Server Error + - >- + The service is currently unavailable. This is most likely a + transient condition, which can be corrected by retrying with a + backoff. Note that it is not always safe to retry non-idempotent + operations. See the guidelines above for deciding between + `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: + 503 Service Unavailable + - >- + Unrecoverable data loss or corruption. HTTP Mapping: 500 Internal + Server Error + enum: + - OK + - CANCELLED + - UNKNOWN + - INVALID_ARGUMENT + - DEADLINE_EXCEEDED + - NOT_FOUND + - ALREADY_EXISTS + - PERMISSION_DENIED + - UNAUTHENTICATED + - RESOURCE_EXHAUSTED + - FAILED_PRECONDITION + - ABORTED + - OUT_OF_RANGE + - UNIMPLEMENTED + - INTERNAL + - UNAVAILABLE + - DATA_LOSS + errorCount: + description: Required. Number of errors encountered per `error_code`. + type: string + format: int64 + errorLogEntries: + description: Required. Sample error logs. + type: array + items: + $ref: '#/components/schemas/ErrorLogEntry' + ErrorLogEntry: + id: ErrorLogEntry + description: An entry describing an error that has occurred. + type: object + properties: + objectUri: + description: Required. Output only. Object URL. e.g. gs://my_bucket/object.txt + readOnly: true + type: string + errorDetails: + description: >- + Optional. Output only. At most 5 error log entries are recorded for + a given error code for a job. + readOnly: true + type: array + items: + type: string + CancelJobRequest: + id: CancelJobRequest + description: Message for Job to Cancel + type: object + properties: + requestId: + description: >- + Optional. An optional request ID to identify requests. Specify a + unique request ID in case you need to retry your request. Requests + with same `request_id` will be ignored for at least 60 minutes since + the first request. The request ID must be a valid UUID with the + exception that zero UUID is not supported + (00000000-0000-0000-0000-000000000000). + type: string + CancelJobResponse: + id: CancelJobResponse + description: Message for response to cancel Job. + type: object + properties: {} + OperationMetadata: + id: OperationMetadata + description: Represents the metadata of the long-running operation. + type: object + properties: + operation: + description: >- + Output only. The unique operation resource name. Format: + projects/{project}/locations/global/operations/{operation}. + readOnly: true + type: string + createTime: + description: Output only. The time the operation was created. + readOnly: true + type: string + format: google-datetime + endTime: + description: Output only. The time the operation finished running. + readOnly: true + type: string + format: google-datetime + requestedCancellation: + description: >- + Output only. Identifies whether the user has requested cancellation + of the operation. Operations that have been cancelled successfully + have google.longrunning.Operation.error value with a + google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + readOnly: true + type: boolean + apiVersion: + description: Output only. API version used to start the operation. + readOnly: true + type: string + job: + description: Output only. The Job associated with the operation. + readOnly: true + $ref: '#/components/schemas/Job' + parameters: + 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: + type: string + enum: + - json + - media + - proto + 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 + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + x-stackQL-resources: + locations: + id: google.storagebatchoperations.locations + name: locations + title: Locations + methods: + list: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.locations + get: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + operations: + id: google.storagebatchoperations.operations + name: operations + title: Operations + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.operations + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + cancel: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' + insert: [] + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/operations/methods/delete' + jobs: + id: google.storagebatchoperations.jobs + name: jobs + title: Jobs + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1jobs/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.jobs + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1jobs/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1jobs~1{jobsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1jobs~1{jobsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + cancel: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1jobs~1{jobsId}:cancel/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/jobs/methods/get' + - $ref: '#/components/x-stackQL-resources/jobs/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/jobs/methods/create' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/jobs/methods/delete' +paths: + /v1/projects/{projectsId}/locations: + parameters: &ref_1 + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' + get: + description: Lists information about the supported locations for this service. + operationId: storagebatchoperations.projects.locations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListLocationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: extraLocationTypes + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}: + parameters: *ref_1 + get: + description: Gets information about a location. + operationId: storagebatchoperations.projects.locations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Location' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: storagebatchoperations.projects.locations.operations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListOperationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: storagebatchoperations.projects.locations.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + delete: + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: storagebatchoperations.projects.locations.operations.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + `1`, corresponding to `Code.CANCELLED`. + operationId: storagebatchoperations.projects.locations.operations.cancel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CancelOperationRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/jobs: + parameters: *ref_1 + get: + description: Lists Jobs in a given project. + operationId: storagebatchoperations.projects.locations.jobs.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListJobsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: orderBy + schema: + type: string + post: + description: Creates a batch job. + operationId: storagebatchoperations.projects.locations.jobs.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Job' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: jobId + schema: + type: string + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}: + parameters: *ref_1 + get: + description: Gets a batch job. + operationId: storagebatchoperations.projects.locations.jobs.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Job' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: jobsId + required: true + schema: + type: string + delete: + description: Deletes a batch job. + operationId: storagebatchoperations.projects.locations.jobs.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: jobsId + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}:cancel: + parameters: *ref_1 + post: + description: Cancels a batch job. + operationId: storagebatchoperations.projects.locations.jobs.cancel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CancelJobRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/CancelJobResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: jobsId + required: true + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/storagetransfer.yaml b/providers/src/googleapis.com/v00.00.00000/services/storagetransfer.yaml index 721ef3b8..94baca0a 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/storagetransfer.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/storagetransfer.yaml @@ -9,8 +9,8 @@ info: Transfers data from external data sources to a Google Cloud Storage bucket or between Google Cloud Storage buckets. version: v1 - x-discovery-doc-revision: '20241026' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250801' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/storage-transfer/docs servers: @@ -187,6 +187,21 @@ components: projectId: description: The ID of the Google Cloud project that owns the job. type: string + serviceAccount: + description: >- + Optional. The user-managed service account to which to delegate + service agent permissions. You can grant Cloud Storage bucket + permissions to this service account instead of to the Transfer + Service service agent. Format is + `projects/-/serviceAccounts/ACCOUNT_EMAIL_OR_UNIQUEID` Either the + service account email + (`SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com`) or the + unique ID (`123456789012345678901`) are accepted in the string. The + `-` wildcard character is required; replacing it with a project ID + is invalid. See + https://cloud.google.com//storage-transfer/docs/delegate-service-agent-permissions + for required permissions. + type: string transferSpec: description: Transfer specification. $ref: '#/components/schemas/TransferSpec' @@ -262,31 +277,31 @@ components: type: object properties: gcsDataSink: - description: A Cloud Storage data sink. + description: Optional. A Cloud Storage data sink. $ref: '#/components/schemas/GcsData' posixDataSink: - description: A POSIX Filesystem data sink. + description: Optional. A POSIX Filesystem data sink. $ref: '#/components/schemas/PosixFilesystem' gcsDataSource: - description: A Cloud Storage data source. + description: Optional. A Cloud Storage data source. $ref: '#/components/schemas/GcsData' awsS3DataSource: - description: An AWS S3 data source. + description: Optional. An AWS S3 data source. $ref: '#/components/schemas/AwsS3Data' httpDataSource: - description: An HTTP URL data source. + description: Optional. An HTTP URL data source. $ref: '#/components/schemas/HttpData' posixDataSource: - description: A POSIX Filesystem data source. + description: Optional. A POSIX Filesystem data source. $ref: '#/components/schemas/PosixFilesystem' azureBlobStorageDataSource: - description: An Azure Blob Storage data source. + description: Optional. An Azure Blob Storage data source. $ref: '#/components/schemas/AzureBlobStorageData' awsS3CompatibleDataSource: - description: An AWS S3 compatible data source. + description: Optional. An AWS S3 compatible data source. $ref: '#/components/schemas/AwsS3CompatibleData' hdfsDataSource: - description: An HDFS cluster data source. + description: Optional. An HDFS cluster data source. $ref: '#/components/schemas/HdfsData' gcsIntermediateDataLocation: description: >- @@ -479,8 +494,9 @@ components: listUrl: description: >- Required. The URL that points to the file that stores the object - list entries. This file must allow public access. Currently, only - URLs with HTTP and HTTPS schemes are supported. + list entries. This file must allow public access. The URL is either + an HTTP/HTTPS address (e.g. `https://example.com/urllist.tsv`) or a + Cloud Storage path (e.g. `gs://my-bucket/urllist.tsv`). type: string AzureBlobStorageData: id: AzureBlobStorageData @@ -525,6 +541,12 @@ components: specify azure_credentials. Format: `projects/{project_number}/secrets/{secret_name}` type: string + federatedIdentityConfig: + description: >- + Optional. Federated identity config of a user registered Azure + application. If `federated_identity_config` is specified, do not + specify azure_credentials or credentials_secret. + $ref: '#/components/schemas/FederatedIdentityConfig' AzureCredentials: id: AzureCredentials description: >- @@ -540,6 +562,28 @@ components: using shared access signatures (SAS)](https://docs.microsoft.com/en-us/azure/storage/common/storage-sas-overview). type: string + FederatedIdentityConfig: + id: FederatedIdentityConfig + description: >- + The identity of an Azure application through which Storage Transfer + Service can authenticate requests using Azure workload identity + federation. Storage Transfer Service can issue requests to Azure Storage + through registered Azure applications, eliminating the need to pass + credentials to Storage Transfer Service directly. To configure federated + identity, see [Configure access to Microsoft Azure + Storage](https://cloud.google.com/storage-transfer/docs/source-microsoft-azure#option_3_authenticate_using_federated_identity). + type: object + properties: + clientId: + description: >- + Required. The client (application) ID of the application with + federated credentials. + type: string + tenantId: + description: >- + Required. The tenant (directory) ID of the application with + federated credentials. + type: string AwsS3CompatibleData: id: AwsS3CompatibleData description: An AwsS3CompatibleData resource. @@ -653,8 +697,14 @@ components: modification time" refers to the time of the last change to the object's content or metadata — specifically, this is the `updated` property of Cloud Storage objects, the `LastModified` field of S3 objects, and the - `Last-Modified` header of Azure blobs. Transfers with a PosixFilesystem - source or destination don't support `ObjectConditions`. + `Last-Modified` header of Azure blobs. For S3 objects, the + `LastModified` value is the time the object begins uploading. If the + object meets your "last modification time" criteria, but has not + finished uploading, the object is not transferred. See [Transfer from + Amazon S3 to Cloud + Storage](https://cloud.google.com/storage-transfer/docs/create-transfers/agentless/s3#transfer_options) + for more information. Transfers with a PosixFilesystem source or + destination don't support `ObjectConditions`. type: object properties: minTimeElapsedSinceLastModification: @@ -761,7 +811,7 @@ components: description: >- When to overwrite objects that already exist in the sink. The default is that only objects that are different from the source are - ovewritten. If true, all objects in the sink whose name matches an + overwritten. If true, all objects in the sink whose name matches an object in the source are overwritten with the source object. type: boolean deleteObjectsUniqueInSink: @@ -1075,7 +1125,7 @@ components: - Default value. This value is unused. - Listing objects in a bucket. - Deleting objects at the source or the destination. - - Copying objects to Google Cloud Storage. + - Copying objects to the destination. enum: - LOGGABLE_ACTION_UNSPECIFIED - FIND @@ -1096,10 +1146,14 @@ components: - >- `LoggableAction` terminated in an error state. `FAILED` actions are logged as ERROR. + - >- + The `COPY` action was skipped for this file. Only supported for + agent-based transfers. `SKIPPED` actions are logged as INFO. enum: - LOGGABLE_ACTION_STATE_UNSPECIFIED - SUCCEEDED - FAILED + - SKIPPED enableOnpremGcsTransferLogs: description: >- For PosixFilesystem transfers, enables [file system transfer @@ -1154,7 +1208,7 @@ components: Combined with schedule_end_date, `end_time_of_day` specifies the end date and time for starting new transfer operations. This field must be greater than or equal to the timestamp corresponding to the - combintation of schedule_start_date and start_time_of_day, and is + combination of schedule_start_date and start_time_of_day, and is subject to the following: * If `end_time_of_day` is not set and `schedule_end_date` is set, then a default value of `23:59:59` is used for `end_time_of_day`. * If `end_time_of_day` is set and @@ -1717,11 +1771,12 @@ components: properties: url: description: >- - Required. A URL that refers to the target (a data source, a data + Output only. A URL that refers to the target (a data source, a data sink, or an object) with which the error is associated. + readOnly: true type: string errorDetails: - description: A list of messages that carry the error details. + description: Optional. A list of messages that carry the error details. type: array items: type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/testing.yaml b/providers/src/googleapis.com/v00.00.00000/services/testing.yaml deleted file mode 100644 index f5a68225..00000000 --- a/providers/src/googleapis.com/v00.00.00000/services/testing.yaml +++ /dev/null @@ -1,3103 +0,0 @@ -openapi: 3.1.0 -info: - contact: - name: StackQL Studios - url: https://github.com/stackql/google-discovery-to-openapi - email: info@stackql.io - title: Cloud Testing API - description: >- - Allows developers to run automated tests for their mobile applications on - Google infrastructure. - version: v1 - x-discovery-doc-revision: '20241101' - x-generated-date: '2024-11-06' -externalDocs: - url: https://firebase.google.com/docs/test-lab/ -servers: - - url: https://testing.googleapis.com -components: - securitySchemes: - Oauth2: - type: oauth2 - description: Oauth 2.0 implicit authentication - flows: - implicit: - authorizationUrl: https://accounts.google.com/o/oauth2/auth - scopes: &ref_0 - https://www.googleapis.com/auth/cloud-platform: >- - See, edit, configure, and delete your Google Cloud data and see - the email address for your Google Account. - https://www.googleapis.com/auth/cloud-platform.read-only: >- - View your data across Google Cloud services and see the email - address of your Google Account - Oauth2c: - type: oauth2 - description: Oauth 2.0 authorization code authentication - flows: - authorizationCode: - authorizationUrl: https://accounts.google.com/o/oauth2/auth - tokenUrl: https://accounts.google.com/o/oauth2/token - scopes: *ref_0 - schemas: - TestMatrix: - id: TestMatrix - description: >- - TestMatrix captures all details about a test. It contains the - environment configuration, test specification, test executions and - overall state and outcome. - type: object - properties: - testMatrixId: - description: Output only. Unique id set by the service. - type: string - projectId: - description: The cloud project that owns the test matrix. - type: string - clientInfo: - description: Information about the client which invoked the test. - $ref: '#/components/schemas/ClientInfo' - testSpecification: - description: Required. How to run the test. - $ref: '#/components/schemas/TestSpecification' - environmentMatrix: - description: Required. The devices the tests are being executed on. - $ref: '#/components/schemas/EnvironmentMatrix' - testExecutions: - description: >- - Output only. The list of test executions that the service creates - for this matrix. - type: array - items: - $ref: '#/components/schemas/TestExecution' - resultStorage: - description: Required. Where the results for the matrix are written. - $ref: '#/components/schemas/ResultStorage' - state: - description: Output only. Indicates the current progress of the test matrix. - type: string - enumDescriptions: - - Do not use. For proto versioning only. - - The execution or matrix is being validated. - - >- - The execution or matrix is waiting for resources to become - available. - - >- - The execution is currently being processed. Can only be set on an - execution. - - >- - The execution or matrix has terminated normally. On a matrix this - means that the matrix level processing completed normally, but - individual executions may be in an ERROR state. - - >- - The execution or matrix has stopped because it encountered an - infrastructure failure. - - >- - The execution was not run because it corresponds to a unsupported - environment. Can only be set on an execution. - - >- - The execution was not run because the provided inputs are - incompatible with the requested environment. Example: requested - AndroidVersion is lower than APK's minSdkVersion Can only be set - on an execution. - - >- - The execution was not run because the provided inputs are - incompatible with the requested architecture. Example: requested - device does not support running the native code in the supplied - APK Can only be set on an execution. - - The user cancelled the execution. Can only be set on an execution. - - >- - The execution or matrix was not run because the provided inputs - are not valid. Examples: input file is not of the expected type, - is malformed/corrupt, or was flagged as malware - enum: - - TEST_STATE_UNSPECIFIED - - VALIDATING - - PENDING - - RUNNING - - FINISHED - - ERROR - - UNSUPPORTED_ENVIRONMENT - - INCOMPATIBLE_ENVIRONMENT - - INCOMPATIBLE_ARCHITECTURE - - CANCELLED - - INVALID - timestamp: - description: Output only. The time this test matrix was initially created. - type: string - format: google-datetime - invalidMatrixDetails: - description: >- - Output only. Describes why the matrix is considered invalid. Only - useful for matrices in the INVALID state. - type: string - enumDescriptions: - - Do not use. For proto versioning only. - - The matrix is INVALID, but there are no further details available. - - The input app APK could not be parsed. - - The input test APK could not be parsed. - - The AndroidManifest.xml could not be found. - - The APK manifest does not declare a package name. - - >- - The APK application ID (aka package name) is invalid. See also - https://developer.android.com/studio/build/application-id - - The test package and app package are the same. - - The test apk does not declare an instrumentation. - - The input app apk does not have a signature. - - >- - The test runner class specified by user or in the test APK's - manifest file is not compatible with Android Test Orchestrator. - Orchestrator is only compatible with AndroidJUnitRunner version - 1.1 or higher. Orchestrator can be disabled by using - DO_NOT_USE_ORCHESTRATOR OrchestratorOption. - - >- - The test APK does not contain the test runner class specified by - the user or in the manifest file. This can be caused by one of the - following reasons: - the user provided a runner class name that's - incorrect, or - the test runner isn't built into the test APK - (might be in the app APK instead). - - A main launcher activity could not be found. - - The app declares one or more permissions that are not allowed. - - There is a conflict in the provided robo_directives. - - >- - There is at least one invalid resource name in the provided robo - directives - - >- - Invalid definition of action in the robo directives (e.g. a click - or ignore action includes an input text field) - - >- - There is no test loop intent filter, or the one that is given is - not formatted correctly. - - >- - The request contains a scenario label that was not declared in the - manifest. - - There was an error when parsing a label's value. - - >- - The request contains a scenario number that was not declared in - the manifest. - - Device administrator applications are not allowed. - - >- - The zipped XCTest was malformed. The zip did not contain a single - .xctestrun file and the contents of the DerivedData/Build/Products - directory. - - >- - The zipped XCTest was built for the iOS simulator rather than for - a physical device. - - The .xctestrun file did not specify any test targets. - - >- - One or more of the test targets defined in the .xctestrun file - specifies "UseDestinationArtifacts", which is disallowed. - - >- - XC tests which run on physical devices must have - "IsAppHostedTestBundle" == "true" in the xctestrun file. - - An Info.plist file in the XCTest zip could not be parsed. - - >- - The APK is marked as "testOnly". Deprecated and not currently - used. - - The input IPA could not be parsed. - - The application doesn't register the game loop URL scheme. - - The iOS application bundle (.app) couldn't be processed. - - >- - APK contains no code. See also - https://developer.android.com/guide/topics/manifest/application-element.html#code - - >- - Either the provided input APK path was malformed, the APK file - does not exist, or the user does not have permission to access the - APK file. - - APK is built for a preview SDK which is unsupported - - The matrix expanded to contain too many executions. - - Not enough test quota to run the executions in this matrix. - - >- - A required cloud service api is not activated. See: - https://firebase.google.com/docs/test-lab/android/continuous#requirements - - There was an unknown permission issue running this test. - enumDeprecated: - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - true - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - enum: - - INVALID_MATRIX_DETAILS_UNSPECIFIED - - DETAILS_UNAVAILABLE - - MALFORMED_APK - - MALFORMED_TEST_APK - - NO_MANIFEST - - NO_PACKAGE_NAME - - INVALID_PACKAGE_NAME - - TEST_SAME_AS_APP - - NO_INSTRUMENTATION - - NO_SIGNATURE - - INSTRUMENTATION_ORCHESTRATOR_INCOMPATIBLE - - NO_TEST_RUNNER_CLASS - - NO_LAUNCHER_ACTIVITY - - FORBIDDEN_PERMISSIONS - - INVALID_ROBO_DIRECTIVES - - INVALID_RESOURCE_NAME - - INVALID_DIRECTIVE_ACTION - - TEST_LOOP_INTENT_FILTER_NOT_FOUND - - SCENARIO_LABEL_NOT_DECLARED - - SCENARIO_LABEL_MALFORMED - - SCENARIO_NOT_DECLARED - - DEVICE_ADMIN_RECEIVER - - MALFORMED_XC_TEST_ZIP - - BUILT_FOR_IOS_SIMULATOR - - NO_TESTS_IN_XC_TEST_ZIP - - USE_DESTINATION_ARTIFACTS - - TEST_NOT_APP_HOSTED - - PLIST_CANNOT_BE_PARSED - - TEST_ONLY_APK - - MALFORMED_IPA - - MISSING_URL_SCHEME - - MALFORMED_APP_BUNDLE - - NO_CODE_APK - - INVALID_INPUT_APK - - INVALID_APK_PREVIEW_SDK - - MATRIX_TOO_LARGE - - TEST_QUOTA_EXCEEDED - - SERVICE_NOT_ACTIVATED - - UNKNOWN_PERMISSION_ERROR - extendedInvalidMatrixDetails: - description: >- - Output only. Details about why a matrix was deemed invalid. If - multiple checks can be safely performed, they will be reported but - no assumptions should be made about the length of this list. - readOnly: true - type: array - items: - $ref: '#/components/schemas/MatrixErrorDetail' - flakyTestAttempts: - description: >- - The number of times a TestExecution should be re-attempted if one or - more of its test cases fail for any reason. The maximum number of - reruns allowed is 10. Default is 0, which implies no reruns. - type: integer - format: int32 - outcomeSummary: - description: >- - Output Only. The overall outcome of the test. Only set when the test - matrix state is FINISHED. - type: string - enumDescriptions: - - Do not use. For proto versioning only. - - >- - The test matrix run was successful, for instance: - All the test - cases passed. - Robo did not detect a crash of the application - under test. - - >- - A run failed, for instance: - One or more test cases failed. - A - test timed out. - The application under test crashed. - - >- - Something unexpected happened. The run should still be considered - unsuccessful but this is likely a transient problem and re-running - the test might be successful. - - >- - All tests were skipped, for instance: - All device configurations - were incompatible. - enum: - - OUTCOME_SUMMARY_UNSPECIFIED - - SUCCESS - - FAILURE - - INCONCLUSIVE - - SKIPPED - failFast: - description: >- - If true, only a single attempt at most will be made to run each - execution/shard in the matrix. Flaky test attempts are not affected. - Normally, 2 or more attempts are made if a potential infrastructure - issue is detected. This feature is for latency sensitive workloads. - The incidence of execution failures may be significantly greater for - fail-fast matrices and support is more limited because of that - expectation. - type: boolean - ClientInfo: - id: ClientInfo - description: Information about the client which invoked the test. - type: object - properties: - name: - description: Required. Client name, such as gcloud. - type: string - clientInfoDetails: - description: The list of detailed information about client. - type: array - items: - $ref: '#/components/schemas/ClientInfoDetail' - ClientInfoDetail: - id: ClientInfoDetail - description: >- - Key-value pair of detailed information about the client which invoked - the test. Examples: {'Version', '1.0'}, {'Release Track', 'BETA'}. - type: object - properties: - key: - description: Required. The key of detailed client information. - type: string - value: - description: Required. The value of detailed client information. - type: string - TestSpecification: - id: TestSpecification - description: A description of how to run the test. - type: object - properties: - testTimeout: - description: >- - Max time a test execution is allowed to run before it is - automatically cancelled. The default value is 5 min. - type: string - format: google-duration - testSetup: - description: >- - Test setup requirements for Android e.g. files to install, bootstrap - scripts. - $ref: '#/components/schemas/TestSetup' - iosTestSetup: - description: Test setup requirements for iOS. - $ref: '#/components/schemas/IosTestSetup' - androidInstrumentationTest: - description: An Android instrumentation test. - $ref: '#/components/schemas/AndroidInstrumentationTest' - androidRoboTest: - description: An Android robo test. - $ref: '#/components/schemas/AndroidRoboTest' - androidTestLoop: - description: An Android Application with a Test Loop. - $ref: '#/components/schemas/AndroidTestLoop' - iosXcTest: - description: An iOS XCTest, via an .xctestrun file. - $ref: '#/components/schemas/IosXcTest' - iosTestLoop: - description: An iOS application with a test loop. - $ref: '#/components/schemas/IosTestLoop' - iosRoboTest: - description: An iOS Robo test. - $ref: '#/components/schemas/IosRoboTest' - disableVideoRecording: - description: Disables video recording. May reduce test latency. - type: boolean - disablePerformanceMetrics: - description: Disables performance metrics recording. May reduce test latency. - type: boolean - TestSetup: - id: TestSetup - description: >- - A description of how to set up the Android device prior to running the - test. - type: object - properties: - filesToPush: - description: List of files to push to the device before starting the test. - type: array - items: - $ref: '#/components/schemas/DeviceFile' - directoriesToPull: - description: >- - List of directories on the device to upload to GCS at the end of the - test; they must be absolute paths under /sdcard, /storage or - /data/local/tmp. Path names are restricted to characters a-z A-Z 0-9 - _ - . + and / Note: The paths /sdcard and /data will be made - available and treated as implicit path substitutions. E.g. if - /sdcard on a particular device does not map to external storage, the - system will replace it with the external storage path prefix for - that device. - type: array - items: - type: string - initialSetupApks: - description: >- - Optional. Initial setup APKs to install before the app under test is - installed. Currently capped at 100. - type: array - items: - $ref: '#/components/schemas/Apk' - additionalApks: - description: >- - APKs to install in addition to those being directly tested. These - will be installed after the app under test. Currently capped at 100. - type: array - items: - $ref: '#/components/schemas/Apk' - account: - description: >- - The device will be logged in on this account for the duration of the - test. - $ref: '#/components/schemas/Account' - networkProfile: - description: >- - The network traffic profile used for running the test. Available - network profiles can be queried by using the NETWORK_CONFIGURATION - environment type when calling - TestEnvironmentDiscoveryService.GetTestEnvironmentCatalog. - type: string - environmentVariables: - description: >- - Environment variables to set for the test (only applicable for - instrumentation tests). - type: array - items: - $ref: '#/components/schemas/EnvironmentVariable' - systrace: - description: >- - Systrace configuration for the run. Deprecated: Systrace used Python - 2 which was sunsetted on 2020-01-01. Systrace is no longer supported - in the Cloud Testing API, and no Systrace file will be provided in - the results. - deprecated: true - $ref: '#/components/schemas/SystraceSetup' - dontAutograntPermissions: - description: >- - Whether to prevent all runtime permissions to be granted at app - install - type: boolean - DeviceFile: - id: DeviceFile - description: A single device file description. - type: object - properties: - obbFile: - description: A reference to an opaque binary blob file. - $ref: '#/components/schemas/ObbFile' - regularFile: - description: A reference to a regular file. - $ref: '#/components/schemas/RegularFile' - ObbFile: - id: ObbFile - description: >- - An opaque binary blob file to install on the device before the test - starts. - type: object - properties: - obbFileName: - description: >- - Required. OBB file name which must conform to the format as - specified by Android e.g. - [main|patch].0300110.com.example.android.obb which will be installed - into \/Android/obb/\/ on the device. - type: string - obb: - description: Required. Opaque Binary Blob (OBB) file(s) to install on the device. - $ref: '#/components/schemas/FileReference' - FileReference: - id: FileReference - description: A reference to a file, used for user inputs. - type: object - properties: - gcsPath: - description: >- - A path to a file in Google Cloud Storage. Example: - gs://build-app-1414623860166/app%40debug-unaligned.apk These paths - are expected to be url encoded (percent encoding) - type: string - RegularFile: - id: RegularFile - description: A file or directory to install on the device before the test starts. - type: object - properties: - content: - description: Required. The source file. - $ref: '#/components/schemas/FileReference' - devicePath: - description: >- - Required. Where to put the content on the device. Must be an - absolute, allowlisted path. If the file exists, it will be replaced. - The following device-side directories and any of their - subdirectories are allowlisted: ${EXTERNAL_STORAGE}, /sdcard, or - /storage ${ANDROID_DATA}/local/tmp, or /data/local/tmp Specifying a - path outside of these directory trees is invalid. The paths /sdcard - and /data will be made available and treated as implicit path - substitutions. E.g. if /sdcard on a particular device does not map - to external storage, the system will replace it with the external - storage path prefix for that device and copy the file there. It is - strongly advised to use the Environment API in app and test code to - access files on the device in a portable way. - type: string - Apk: - id: Apk - description: An Android package file to install. - type: object - properties: - location: - description: >- - The path to an APK to be installed on the device before the test - begins. - $ref: '#/components/schemas/FileReference' - packageName: - description: >- - The java package for the APK to be installed. Value is determined by - examining the application's manifest. - type: string - Account: - id: Account - description: Identifies an account and how to log into it. - type: object - properties: - googleAuto: - description: An automatic google login account. - $ref: '#/components/schemas/GoogleAuto' - GoogleAuto: - id: GoogleAuto - description: >- - Enables automatic Google account login. If set, the service - automatically generates a Google test account and adds it to the device, - before executing the test. Note that test accounts might be reused. Many - applications show their full set of functionalities when an account is - present on the device. Logging into the device with these generated - accounts allows testing more functionalities. - type: object - properties: {} - EnvironmentVariable: - id: EnvironmentVariable - description: A key-value pair passed as an environment variable to the test. - type: object - properties: - key: - description: Key for the environment variable. - type: string - value: - description: Value for the environment variable. - type: string - SystraceSetup: - id: SystraceSetup - type: object - properties: - durationSeconds: - description: >- - Systrace duration in seconds. Should be between 1 and 30 seconds. 0 - disables systrace. - deprecated: true - type: integer - format: int32 - IosTestSetup: - id: IosTestSetup - description: A description of how to set up an iOS device prior to running the test. - type: object - properties: - networkProfile: - description: >- - The network traffic profile used for running the test. Available - network profiles can be queried by using the NETWORK_CONFIGURATION - environment type when calling - TestEnvironmentDiscoveryService.GetTestEnvironmentCatalog. - type: string - additionalIpas: - description: iOS apps to install in addition to those being directly tested. - type: array - items: - $ref: '#/components/schemas/FileReference' - pushFiles: - description: List of files to push to the device before starting the test. - type: array - items: - $ref: '#/components/schemas/IosDeviceFile' - pullDirectories: - description: >- - List of directories on the device to upload to Cloud Storage at the - end of the test. Directories should either be in a shared directory - (such as /private/var/mobile/Media) or within an accessible - directory inside the app's filesystem (such as /Documents) by - specifying the bundle ID. - type: array - items: - $ref: '#/components/schemas/IosDeviceFile' - IosDeviceFile: - id: IosDeviceFile - description: A file or directory to install on the device before the test starts. - type: object - properties: - content: - description: The source file - $ref: '#/components/schemas/FileReference' - bundleId: - description: >- - The bundle id of the app where this file lives. iOS apps sandbox - their own filesystem, so app files must specify which app installed - on the device. - type: string - devicePath: - description: >- - Location of the file on the device, inside the app's sandboxed - filesystem - type: string - AndroidInstrumentationTest: - id: AndroidInstrumentationTest - description: >- - A test of an Android application that can control an Android component - independently of its normal lifecycle. Android instrumentation tests run - an application APK and test APK inside the same process on a virtual or - physical AndroidDevice. They also specify a test runner class, such as - com.google.GoogleTestRunner, which can vary on the specific - instrumentation framework chosen. See for more information on types of - Android tests. - type: object - properties: - appApk: - description: The APK for the application under test. - $ref: '#/components/schemas/FileReference' - appBundle: - description: A multi-apk app bundle for the application under test. - $ref: '#/components/schemas/AppBundle' - testApk: - description: Required. The APK containing the test code to be executed. - $ref: '#/components/schemas/FileReference' - appPackageId: - description: >- - The java package for the application under test. The default value - is determined by examining the application's manifest. - type: string - testPackageId: - description: >- - The java package for the test to be executed. The default value is - determined by examining the application's manifest. - type: string - testRunnerClass: - description: >- - The InstrumentationTestRunner class. The default value is determined - by examining the application's manifest. - type: string - testTargets: - description: >- - Each target must be fully qualified with the package name or class - name, in one of these formats: - "package package_name" - "class - package_name.class_name" - "class - package_name.class_name#method_name" If empty, all targets in the - module will be run. - type: array - items: - type: string - orchestratorOption: - description: >- - The option of whether running each test within its own invocation of - instrumentation with Android Test Orchestrator or not. ** - Orchestrator is only compatible with AndroidJUnitRunner version 1.1 - or higher! ** Orchestrator offers the following benefits: - No - shared state - Crashes are isolated - Logs are scoped per test See - for more information about Android Test Orchestrator. If not set, - the test will be run without the orchestrator. - type: string - enumDescriptions: - - >- - Default value: the server will choose the mode. Currently implies - that the test will run without the orchestrator. In the future, - all instrumentation tests will be run with the orchestrator. Using - the orchestrator is highly encouraged because of all the benefits - it offers. - - >- - Run test using orchestrator. ** Only compatible with - AndroidJUnitRunner version 1.1 or higher! ** Recommended. - - Run test without using orchestrator. - enum: - - ORCHESTRATOR_OPTION_UNSPECIFIED - - USE_ORCHESTRATOR - - DO_NOT_USE_ORCHESTRATOR - shardingOption: - description: The option to run tests in multiple shards in parallel. - $ref: '#/components/schemas/ShardingOption' - AppBundle: - id: AppBundle - description: >- - An Android App Bundle file format, containing a BundleConfig.pb file, a - base module directory, zero or more dynamic feature module directories. - See https://developer.android.com/guide/app-bundle/build for guidance on - building App Bundles. - type: object - properties: - bundleLocation: - description: .aab file representing the app bundle under test. - $ref: '#/components/schemas/FileReference' - ShardingOption: - id: ShardingOption - description: Options for enabling sharding. - type: object - properties: - uniformSharding: - description: Uniformly shards test cases given a total number of shards. - $ref: '#/components/schemas/UniformSharding' - manualSharding: - description: >- - Shards test cases into the specified groups of packages, classes, - and/or methods. - $ref: '#/components/schemas/ManualSharding' - smartSharding: - description: Shards test based on previous test case timing records. - $ref: '#/components/schemas/SmartSharding' - UniformSharding: - id: UniformSharding - description: >- - Uniformly shards test cases given a total number of shards. For - instrumentation tests, it will be translated to "-e numShard" and "-e - shardIndex" AndroidJUnitRunner arguments. With uniform sharding enabled, - specifying either of these sharding arguments via - `environment_variables` is invalid. Based on the sharding mechanism - AndroidJUnitRunner uses, there is no guarantee that test cases will be - distributed uniformly across all shards. - type: object - properties: - numShards: - description: >- - Required. The total number of shards to create. This must always be - a positive number that is no greater than the total number of test - cases. When you select one or more physical devices, the number of - shards must be <= 50. When you select one or more ARM virtual - devices, it must be <= 200. When you select only x86 virtual - devices, it must be <= 500. - type: integer - format: int32 - ManualSharding: - id: ManualSharding - description: >- - Shards test cases into the specified groups of packages, classes, and/or - methods. With manual sharding enabled, specifying test targets via - environment_variables or in InstrumentationTest is invalid. - type: object - properties: - testTargetsForShard: - description: >- - Required. Group of packages, classes, and/or test methods to be run - for each manually-created shard. You must specify at least one shard - if this field is present. When you select one or more physical - devices, the number of repeated test_targets_for_shard must be <= - 50. When you select one or more ARM virtual devices, it must be <= - 200. When you select only x86 virtual devices, it must be <= 500. - type: array - items: - $ref: '#/components/schemas/TestTargetsForShard' - TestTargetsForShard: - id: TestTargetsForShard - description: Test targets for a shard. - type: object - properties: - testTargets: - description: >- - Group of packages, classes, and/or test methods to be run for each - shard. The targets need to be specified in AndroidJUnitRunner - argument format. For example, "package com.my.packages" "class - com.my.package.MyClass". The number of test_targets must be greater - than 0. - type: array - items: - type: string - SmartSharding: - id: SmartSharding - description: Shards test based on previous test case timing records. - type: object - properties: - targetedShardDuration: - description: >- - The amount of time tests within a shard should take. Default: 300 - seconds (5 minutes). The minimum allowed: 120 seconds (2 minutes). - The shard count is dynamically set based on time, up to the maximum - shard limit (described below). To guarantee at least one test case - for each shard, the number of shards will not exceed the number of - test cases. Shard duration will be exceeded if: - The maximum shard - limit is reached and there is more calculated test time remaining to - allocate into shards. - Any individual test is estimated to be - longer than the targeted shard duration. Shard duration is not - guaranteed because smart sharding uses test case history and default - durations which may not be accurate. The rules for finding the test - case timing records are: - If the service has processed a test case - in the last 30 days, the record of the latest successful test case - will be used. - For new test cases, the average duration of other - known test cases will be used. - If there are no previous test case - timing records available, the default test case duration is 15 - seconds. Because the actual shard duration can exceed the targeted - shard duration, we recommend that you set the targeted value at - least 5 minutes less than the maximum allowed test timeout (45 - minutes for physical devices and 60 minutes for virtual), or that - you use the custom test timeout value that you set. This approach - avoids cancelling the shard before all tests can finish. Note that - there is a limit for maximum number of shards. When you select one - or more physical devices, the number of shards must be <= 50. When - you select one or more ARM virtual devices, it must be <= 200. When - you select only x86 virtual devices, it must be <= 500. To guarantee - at least one test case for per shard, the number of shards will not - exceed the number of test cases. Each shard created counts toward - daily test quota. - type: string - format: google-duration - AndroidRoboTest: - id: AndroidRoboTest - description: >- - A test of an android application that explores the application on a - virtual or physical Android Device, finding culprits and crashes as it - goes. - type: object - properties: - appApk: - description: The APK for the application under test. - $ref: '#/components/schemas/FileReference' - appBundle: - description: A multi-apk app bundle for the application under test. - $ref: '#/components/schemas/AppBundle' - appPackageId: - description: >- - The java package for the application under test. The default value - is determined by examining the application's manifest. - type: string - appInitialActivity: - description: The initial activity that should be used to start the app. - type: string - maxDepth: - description: >- - The max depth of the traversal stack Robo can explore. Needs to be - at least 2 to make Robo explore the app beyond the first activity. - Default is 50. - deprecated: true - type: integer - format: int32 - maxSteps: - description: The max number of steps Robo can execute. Default is no limit. - deprecated: true - type: integer - format: int32 - roboDirectives: - description: >- - A set of directives Robo should apply during the crawl. This allows - users to customize the crawl. For example, the username and password - for a test account can be provided. - type: array - items: - $ref: '#/components/schemas/RoboDirective' - roboMode: - description: >- - The mode in which Robo should run. Most clients should allow the - server to populate this field automatically. - type: string - enumDescriptions: - - This means that the server should choose the mode. Recommended. - - Runs Robo in UIAutomator-only mode without app resigning - - Runs Robo in standard Espresso with UIAutomator fallback - enum: - - ROBO_MODE_UNSPECIFIED - - ROBO_VERSION_1 - - ROBO_VERSION_2 - roboScript: - description: >- - A JSON file with a sequence of actions Robo should perform as a - prologue for the crawl. - $ref: '#/components/schemas/FileReference' - startingIntents: - description: >- - The intents used to launch the app for the crawl. If none are - provided, then the main launcher activity is launched. If some are - provided, then only those provided are launched (the main launcher - activity must be provided explicitly). - type: array - items: - $ref: '#/components/schemas/RoboStartingIntent' - RoboDirective: - id: RoboDirective - description: >- - Directs Robo to interact with a specific UI element if it is encountered - during the crawl. Currently, Robo can perform text entry or element - click. - type: object - properties: - resourceName: - description: >- - Required. The android resource name of the target UI element. For - example, in Java: R.string.foo in xml: @string/foo Only the "foo" - part is needed. Reference doc: - https://developer.android.com/guide/topics/resources/accessing-resources.html - type: string - inputText: - description: >- - The text that Robo is directed to set. If left empty, the directive - will be treated as a CLICK on the element matching the - resource_name. - type: string - actionType: - description: >- - Required. The type of action that Robo should perform on the - specified element. - type: string - enumDescriptions: - - DO NOT USE. For proto versioning only. - - >- - Direct Robo to click on the specified element. No-op if specified - element is not clickable. - - >- - Direct Robo to enter text on the specified element. No-op if - specified element is not enabled or does not allow text entry. - - Direct Robo to ignore interactions with a specific element. - enum: - - ACTION_TYPE_UNSPECIFIED - - SINGLE_CLICK - - ENTER_TEXT - - IGNORE - RoboStartingIntent: - id: RoboStartingIntent - description: Message for specifying the start activities to crawl. - type: object - properties: - launcherActivity: - description: An intent that starts the main launcher activity. - $ref: '#/components/schemas/LauncherActivityIntent' - startActivity: - description: An intent that starts an activity with specific details. - $ref: '#/components/schemas/StartActivityIntent' - noActivity: - description: Skips the starting activity - $ref: '#/components/schemas/NoActivityIntent' - timeout: - description: Timeout in seconds for each intent. - type: string - format: google-duration - LauncherActivityIntent: - id: LauncherActivityIntent - description: Specifies an intent that starts the main launcher activity. - type: object - properties: {} - StartActivityIntent: - id: StartActivityIntent - description: A starting intent specified by an action, uri, and categories. - type: object - properties: - action: - description: Action name. Required for START_ACTIVITY. - type: string - uri: - description: URI for the action. - type: string - categories: - description: Intent categories to set on the intent. - type: array - items: - type: string - NoActivityIntent: - id: NoActivityIntent - description: Skips the starting activity - type: object - properties: {} - AndroidTestLoop: - id: AndroidTestLoop - description: >- - A test of an Android Application with a Test Loop. The intent \ will be - implicitly added, since Games is the only user of this api, for the time - being. - type: object - properties: - appApk: - description: The APK for the application under test. - $ref: '#/components/schemas/FileReference' - appBundle: - description: A multi-apk app bundle for the application under test. - $ref: '#/components/schemas/AppBundle' - appPackageId: - description: >- - The java package for the application under test. The default is - determined by examining the application's manifest. - type: string - scenarios: - description: >- - The list of scenarios that should be run during the test. The - default is all test loops, derived from the application's manifest. - type: array - items: - type: integer - format: int32 - scenarioLabels: - description: >- - The list of scenario labels that should be run during the test. The - scenario labels should map to labels defined in the application's - manifest. For example, player_experience and - com.google.test.loops.player_experience add all of the loops labeled - in the manifest with the com.google.test.loops.player_experience - name to the execution. Scenarios can also be specified in the - scenarios field. - type: array - items: - type: string - IosXcTest: - id: IosXcTest - description: >- - A test of an iOS application that uses the XCTest framework. Xcode - supports the option to "build for testing", which generates an - .xctestrun file that contains a test specification (arguments, test - methods, etc). This test type accepts a zip file containing the - .xctestrun file and the corresponding contents of the Build/Products - directory that contains all the binaries needed to run the tests. - type: object - properties: - testsZip: - description: >- - Required. The .zip containing the .xctestrun file and the contents - of the DerivedData/Build/Products directory. The .xctestrun file in - this zip is ignored if the xctestrun field is specified. - $ref: '#/components/schemas/FileReference' - xctestrun: - description: >- - An .xctestrun file that will override the .xctestrun file in the - tests zip. Because the .xctestrun file contains environment - variables along with test methods to run and/or ignore, this can be - useful for sharding tests. Default is taken from the tests zip. - $ref: '#/components/schemas/FileReference' - xcodeVersion: - description: >- - The Xcode version that should be used for the test. Use the - TestEnvironmentDiscoveryService to get supported options. Defaults - to the latest Xcode version Firebase Test Lab supports. - type: string - appBundleId: - description: Output only. The bundle id for the application under test. - type: string - testSpecialEntitlements: - description: >- - The option to test special app entitlements. Setting this would - re-sign the app having special entitlements with an explicit - application-identifier. Currently supports testing aps-environment - entitlement. - type: boolean - IosTestLoop: - id: IosTestLoop - description: >- - A test of an iOS application that implements one or more game loop - scenarios. This test type accepts an archived application (.ipa file) - and a list of integer scenarios that will be executed on the app - sequentially. - type: object - properties: - appIpa: - description: Required. The .ipa of the application to test. - $ref: '#/components/schemas/FileReference' - scenarios: - description: >- - The list of scenarios that should be run during the test. Defaults - to the single scenario 0 if unspecified. - type: array - items: - type: integer - format: int32 - appBundleId: - description: Output only. The bundle id for the application under test. - type: string - IosRoboTest: - id: IosRoboTest - description: A test that explores an iOS application on an iOS device. - type: object - properties: - appIpa: - description: >- - Required. The ipa stored at this file should be used to run the - test. - $ref: '#/components/schemas/FileReference' - appBundleId: - description: >- - The bundle ID for the app-under-test. This is determined by - examining the application's "Info.plist" file. - type: string - roboScript: - description: >- - An optional Roboscript to customize the crawl. See - https://firebase.google.com/docs/test-lab/android/robo-scripts-reference - for more information about Roboscripts. - $ref: '#/components/schemas/FileReference' - EnvironmentMatrix: - id: EnvironmentMatrix - description: The matrix of environments in which the test is to be executed. - type: object - properties: - androidMatrix: - description: A matrix of Android devices. - $ref: '#/components/schemas/AndroidMatrix' - androidDeviceList: - description: >- - A list of Android devices; the test will be run only on the - specified devices. - $ref: '#/components/schemas/AndroidDeviceList' - iosDeviceList: - description: A list of iOS devices. - $ref: '#/components/schemas/IosDeviceList' - AndroidMatrix: - id: AndroidMatrix - description: >- - A set of Android device configuration permutations is defined by the the - cross-product of the given axes. Internally, the given AndroidMatrix - will be expanded into a set of AndroidDevices. Only supported - permutations will be instantiated. Invalid permutations (e.g., - incompatible models/versions) are ignored. - type: object - properties: - androidModelIds: - description: >- - Required. The ids of the set of Android device to be used. Use the - TestEnvironmentDiscoveryService to get supported options. - type: array - items: - type: string - androidVersionIds: - description: >- - Required. The ids of the set of Android OS version to be used. Use - the TestEnvironmentDiscoveryService to get supported options. - type: array - items: - type: string - locales: - description: >- - Required. The set of locales the test device will enable for - testing. Use the TestEnvironmentDiscoveryService to get supported - options. - type: array - items: - type: string - orientations: - description: >- - Required. The set of orientations to test with. Use the - TestEnvironmentDiscoveryService to get supported options. - type: array - items: - type: string - AndroidDeviceList: - id: AndroidDeviceList - description: >- - A list of Android device configurations in which the test is to be - executed. - type: object - properties: - androidDevices: - description: Required. A list of Android devices. - type: array - items: - $ref: '#/components/schemas/AndroidDevice' - AndroidDevice: - id: AndroidDevice - description: A single Android device. - type: object - properties: - androidModelId: - description: >- - Required. The id of the Android device to be used. Use the - TestEnvironmentDiscoveryService to get supported options. - type: string - androidVersionId: - description: >- - Required. The id of the Android OS version to be used. Use the - TestEnvironmentDiscoveryService to get supported options. - type: string - locale: - description: >- - Required. The locale the test device used for testing. Use the - TestEnvironmentDiscoveryService to get supported options. - type: string - orientation: - description: >- - Required. How the device is oriented during the test. Use the - TestEnvironmentDiscoveryService to get supported options. - type: string - IosDeviceList: - id: IosDeviceList - description: A list of iOS device configurations in which the test is to be executed. - type: object - properties: - iosDevices: - description: Required. A list of iOS devices. - type: array - items: - $ref: '#/components/schemas/IosDevice' - IosDevice: - id: IosDevice - description: A single iOS device. - type: object - properties: - iosModelId: - description: >- - Required. The id of the iOS device to be used. Use the - TestEnvironmentDiscoveryService to get supported options. - type: string - iosVersionId: - description: >- - Required. The id of the iOS major software version to be used. Use - the TestEnvironmentDiscoveryService to get supported options. - type: string - locale: - description: >- - Required. The locale the test device used for testing. Use the - TestEnvironmentDiscoveryService to get supported options. - type: string - orientation: - description: >- - Required. How the device is oriented during the test. Use the - TestEnvironmentDiscoveryService to get supported options. - type: string - TestExecution: - id: TestExecution - description: A single test executed in a single environment. - type: object - properties: - id: - description: Output only. Unique id set by the service. - type: string - matrixId: - description: Output only. Id of the containing TestMatrix. - type: string - projectId: - description: Output only. The cloud project that owns the test execution. - type: string - testSpecification: - description: Output only. How to run the test. - $ref: '#/components/schemas/TestSpecification' - shard: - description: Output only. Details about the shard. - $ref: '#/components/schemas/Shard' - environment: - description: Output only. How the host machine(s) are configured. - $ref: '#/components/schemas/Environment' - state: - description: >- - Output only. Indicates the current progress of the test execution - (e.g., FINISHED). - type: string - enumDescriptions: - - Do not use. For proto versioning only. - - The execution or matrix is being validated. - - >- - The execution or matrix is waiting for resources to become - available. - - >- - The execution is currently being processed. Can only be set on an - execution. - - >- - The execution or matrix has terminated normally. On a matrix this - means that the matrix level processing completed normally, but - individual executions may be in an ERROR state. - - >- - The execution or matrix has stopped because it encountered an - infrastructure failure. - - >- - The execution was not run because it corresponds to a unsupported - environment. Can only be set on an execution. - - >- - The execution was not run because the provided inputs are - incompatible with the requested environment. Example: requested - AndroidVersion is lower than APK's minSdkVersion Can only be set - on an execution. - - >- - The execution was not run because the provided inputs are - incompatible with the requested architecture. Example: requested - device does not support running the native code in the supplied - APK Can only be set on an execution. - - The user cancelled the execution. Can only be set on an execution. - - >- - The execution or matrix was not run because the provided inputs - are not valid. Examples: input file is not of the expected type, - is malformed/corrupt, or was flagged as malware - enum: - - TEST_STATE_UNSPECIFIED - - VALIDATING - - PENDING - - RUNNING - - FINISHED - - ERROR - - UNSUPPORTED_ENVIRONMENT - - INCOMPATIBLE_ENVIRONMENT - - INCOMPATIBLE_ARCHITECTURE - - CANCELLED - - INVALID - toolResultsStep: - description: Output only. Where the results for this execution are written. - $ref: '#/components/schemas/ToolResultsStep' - timestamp: - description: Output only. The time this test execution was initially created. - type: string - format: google-datetime - testDetails: - description: Output only. Additional details about the running test. - $ref: '#/components/schemas/TestDetails' - Shard: - id: Shard - description: Output only. Details about the shard. - type: object - properties: - shardIndex: - description: Output only. The index of the shard among all the shards. - readOnly: true - type: integer - format: int32 - numShards: - description: Output only. The total number of shards. - readOnly: true - type: integer - format: int32 - testTargetsForShard: - description: >- - Output only. Test targets for each shard. Only set for manual - sharding. - readOnly: true - $ref: '#/components/schemas/TestTargetsForShard' - estimatedShardDuration: - description: >- - Output only. The estimated shard duration based on previous test - case timing records, if available. - readOnly: true - type: string - format: google-duration - Environment: - id: Environment - description: The environment in which the test is run. - type: object - properties: - androidDevice: - description: An Android device which must be used with an Android test. - $ref: '#/components/schemas/AndroidDevice' - iosDevice: - description: An iOS device which must be used with an iOS test. - $ref: '#/components/schemas/IosDevice' - ToolResultsStep: - id: ToolResultsStep - description: >- - Represents a tool results step resource. This has the results of a - TestExecution. - type: object - properties: - projectId: - description: Output only. The cloud project that owns the tool results step. - type: string - historyId: - description: Output only. A tool results history ID. - type: string - executionId: - description: Output only. A tool results execution ID. - type: string - stepId: - description: Output only. A tool results step ID. - type: string - TestDetails: - id: TestDetails - description: Additional details about the progress of the running test. - type: object - properties: - progressMessages: - description: >- - Output only. Human-readable, detailed descriptions of the test's - progress. For example: "Provisioning a device", "Starting Test". - During the course of execution new data may be appended to the end - of progress_messages. - type: array - items: - type: string - errorMessage: - description: >- - Output only. If the TestState is ERROR, then this string will - contain human-readable details about the error. - type: string - ResultStorage: - id: ResultStorage - description: Locations where the results of running the test are stored. - type: object - properties: - googleCloudStorage: - description: Required. - $ref: '#/components/schemas/GoogleCloudStorage' - toolResultsHistory: - description: >- - The tool results history that contains the tool results execution - that results are written to. If not provided, the service will - choose an appropriate value. - $ref: '#/components/schemas/ToolResultsHistory' - toolResultsExecution: - description: Output only. The tool results execution that results are written to. - $ref: '#/components/schemas/ToolResultsExecution' - resultsUrl: - description: Output only. URL to the results in the Firebase Web Console. - type: string - GoogleCloudStorage: - id: GoogleCloudStorage - description: A storage location within Google cloud storage (GCS). - type: object - properties: - gcsPath: - description: >- - Required. The path to a directory in GCS that will eventually - contain the results for this test. The requesting user must have - write access on the bucket in the supplied path. - type: string - ToolResultsHistory: - id: ToolResultsHistory - description: Represents a tool results history resource. - type: object - properties: - projectId: - description: Required. The cloud project that owns the tool results history. - type: string - historyId: - description: Required. A tool results history ID. - type: string - ToolResultsExecution: - id: ToolResultsExecution - description: >- - Represents a tool results execution resource. This has the results of a - TestMatrix. - type: object - properties: - projectId: - description: Output only. The cloud project that owns the tool results execution. - type: string - historyId: - description: Output only. A tool results history ID. - type: string - executionId: - description: Output only. A tool results execution ID. - type: string - MatrixErrorDetail: - id: MatrixErrorDetail - description: Describes a single error or issue with a matrix. - type: object - properties: - reason: - description: >- - Output only. The reason for the error. This is a constant value in - UPPER_SNAKE_CASE that identifies the cause of the error. - readOnly: true - type: string - message: - description: >- - Output only. A human-readable message about how the error in the - TestMatrix. Expands on the `reason` field with additional details - and possible options to fix the issue. - readOnly: true - type: string - CancelTestMatrixResponse: - id: CancelTestMatrixResponse - description: Response containing the current state of the specified test matrix. - type: object - properties: - testState: - description: >- - The current rolled-up state of the test matrix. If this state is - already final, then the cancelation request will have no effect. - type: string - enumDescriptions: - - Do not use. For proto versioning only. - - The execution or matrix is being validated. - - >- - The execution or matrix is waiting for resources to become - available. - - >- - The execution is currently being processed. Can only be set on an - execution. - - >- - The execution or matrix has terminated normally. On a matrix this - means that the matrix level processing completed normally, but - individual executions may be in an ERROR state. - - >- - The execution or matrix has stopped because it encountered an - infrastructure failure. - - >- - The execution was not run because it corresponds to a unsupported - environment. Can only be set on an execution. - - >- - The execution was not run because the provided inputs are - incompatible with the requested environment. Example: requested - AndroidVersion is lower than APK's minSdkVersion Can only be set - on an execution. - - >- - The execution was not run because the provided inputs are - incompatible with the requested architecture. Example: requested - device does not support running the native code in the supplied - APK Can only be set on an execution. - - The user cancelled the execution. Can only be set on an execution. - - >- - The execution or matrix was not run because the provided inputs - are not valid. Examples: input file is not of the expected type, - is malformed/corrupt, or was flagged as malware - enum: - - TEST_STATE_UNSPECIFIED - - VALIDATING - - PENDING - - RUNNING - - FINISHED - - ERROR - - UNSUPPORTED_ENVIRONMENT - - INCOMPATIBLE_ENVIRONMENT - - INCOMPATIBLE_ARCHITECTURE - - CANCELLED - - INVALID - GetApkDetailsResponse: - id: GetApkDetailsResponse - description: Response containing the details of the specified Android application. - type: object - properties: - apkDetail: - description: Details of the Android App. - $ref: '#/components/schemas/ApkDetail' - ApkDetail: - id: ApkDetail - description: >- - Android application details based on application manifest and archive - contents. - type: object - properties: - apkManifest: - $ref: '#/components/schemas/ApkManifest' - ApkManifest: - id: ApkManifest - description: >- - An Android app manifest. See - http://developer.android.com/guide/topics/manifest/manifest-intro.html - type: object - properties: - packageName: - description: >- - Full Java-style package name for this application, e.g. - "com.example.foo". - type: string - minSdkVersion: - description: Minimum API level required for the application to run. - type: integer - format: int32 - maxSdkVersion: - description: Maximum API level on which the application is designed to run. - type: integer - format: int32 - targetSdkVersion: - description: Specifies the API Level on which the application is designed to run. - type: integer - format: int32 - applicationLabel: - description: User-readable name for the application. - type: string - intentFilters: - type: array - items: - $ref: '#/components/schemas/IntentFilter' - usesPermission: - description: Permissions declared to be used by the application - type: array - items: - type: string - versionCode: - description: Version number used internally by the app. - type: string - format: int64 - versionName: - description: Version number shown to users. - type: string - metadata: - description: Meta-data tags defined in the manifest. - type: array - items: - $ref: '#/components/schemas/Metadata' - usesFeature: - description: Feature usage tags defined in the manifest. - type: array - items: - $ref: '#/components/schemas/UsesFeature' - services: - description: Services contained in the tag. - type: array - items: - $ref: '#/components/schemas/Service' - IntentFilter: - id: IntentFilter - description: >- - The section of an tag. - https://developer.android.com/guide/topics/manifest/intent-filter-element.html - type: object - properties: - actionNames: - description: The android:name value of the tag. - type: array - items: - type: string - categoryNames: - description: The android:name value of the tag. - type: array - items: - type: string - mimeType: - description: The android:mimeType value of the tag. - type: string - Metadata: - id: Metadata - description: >- - A tag within a manifest. - https://developer.android.com/guide/topics/manifest/meta-data-element.html - type: object - properties: - name: - description: The android:name value - type: string - value: - description: The android:value value - type: string - UsesFeature: - id: UsesFeature - description: >- - A tag within a manifest. - https://developer.android.com/guide/topics/manifest/uses-feature-element.html - type: object - properties: - name: - description: The android:name value - type: string - isRequired: - description: The android:required value - type: boolean - Service: - id: Service - description: >- - The section of an tag. - https://developer.android.com/guide/topics/manifest/service-element - type: object - properties: - name: - description: The android:name value - type: string - intentFilter: - description: Intent filters in the service - type: array - items: - $ref: '#/components/schemas/IntentFilter' - DeviceSession: - id: DeviceSession - description: Protobuf message describing the device message, used from several RPCs. - type: object - properties: - name: - description: >- - Optional. Name of the DeviceSession, e.g. - "projects/{project_id}/deviceSessions/{session_id}" - type: string - displayName: - description: >- - Output only. The title of the DeviceSession to be presented in the - UI. - readOnly: true - type: string - state: - description: Output only. Current state of the DeviceSession. - readOnly: true - type: string - enumDescriptions: - - Default value. This value is unused. - - >- - Initial state of a session request. The session is being validated - for correctness and a device is not yet requested. - - The session has been validated and is in the queue for a device. - - >- - The session has been granted and the device is accepting - connections. - - >- - The session duration exceeded the device’s reservation time period - and timed out automatically. - - >- - The user is finished with the session and it was canceled by the - user while the request was still getting allocated or after - allocation and during device usage period. - - >- - Unable to complete the session because the device was unavailable - and it failed to allocate through the scheduler. For example, a - device not in the catalog was requested or the request expired in - the allocation queue. - - >- - Unable to complete the session for an internal reason, such as an - infrastructure failure. - enum: - - SESSION_STATE_UNSPECIFIED - - REQUESTED - - PENDING - - ACTIVE - - EXPIRED - - FINISHED - - UNAVAILABLE - - ERROR - stateHistories: - description: >- - Output only. The historical state transitions of the session_state - message including the current session state. - readOnly: true - type: array - items: - $ref: '#/components/schemas/SessionStateEvent' - ttl: - description: >- - Optional. The amount of time that a device will be initially - allocated for. This can eventually be extended with the - UpdateDeviceSession RPC. Default: 15 minutes. - type: string - format: google-duration - expireTime: - description: >- - Optional. If the device is still in use at this time, any - connections will be ended and the SessionState will transition from - ACTIVE to FINISHED. - type: string - format: google-datetime - inactivityTimeout: - description: >- - Output only. The interval of time that this device must be - interacted with before it transitions from ACTIVE to - TIMEOUT_INACTIVITY. - readOnly: true - type: string - format: google-duration - createTime: - description: Output only. The time that the Session was created. - readOnly: true - type: string - format: google-datetime - activeStartTime: - description: Output only. The timestamp that the session first became ACTIVE. - readOnly: true - type: string - format: google-datetime - androidDevice: - description: Required. The requested device - $ref: '#/components/schemas/AndroidDevice' - SessionStateEvent: - id: SessionStateEvent - description: >- - A message encapsulating a series of Session states and the time that the - DeviceSession first entered those states. - type: object - properties: - sessionState: - description: Output only. The session_state tracked by this event - readOnly: true - type: string - enumDescriptions: - - Default value. This value is unused. - - >- - Initial state of a session request. The session is being validated - for correctness and a device is not yet requested. - - The session has been validated and is in the queue for a device. - - >- - The session has been granted and the device is accepting - connections. - - >- - The session duration exceeded the device’s reservation time period - and timed out automatically. - - >- - The user is finished with the session and it was canceled by the - user while the request was still getting allocated or after - allocation and during device usage period. - - >- - Unable to complete the session because the device was unavailable - and it failed to allocate through the scheduler. For example, a - device not in the catalog was requested or the request expired in - the allocation queue. - - >- - Unable to complete the session for an internal reason, such as an - infrastructure failure. - enum: - - SESSION_STATE_UNSPECIFIED - - REQUESTED - - PENDING - - ACTIVE - - EXPIRED - - FINISHED - - UNAVAILABLE - - ERROR - eventTime: - description: >- - Output only. The time that the session_state first encountered that - state. - readOnly: true - type: string - format: google-datetime - stateMessage: - description: Output only. A human-readable message to explain the state. - readOnly: true - type: string - ListDeviceSessionsResponse: - id: ListDeviceSessionsResponse - description: A list of device sessions. - type: object - properties: - deviceSessions: - description: >- - The sessions matching the specified filter in the given cloud - project. - type: array - items: - $ref: '#/components/schemas/DeviceSession' - nextPageToken: - description: >- - A token, which can be sent as `page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. - type: string - CancelDeviceSessionRequest: - id: CancelDeviceSessionRequest - description: The request object for cancelling a Device Session. - type: object - properties: {} - Empty: - id: Empty - description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } - type: object - properties: {} - TestEnvironmentCatalog: - id: TestEnvironmentCatalog - description: A description of a test environment. - type: object - properties: - androidDeviceCatalog: - description: Supported Android devices. - $ref: '#/components/schemas/AndroidDeviceCatalog' - iosDeviceCatalog: - description: Supported iOS devices. - $ref: '#/components/schemas/IosDeviceCatalog' - networkConfigurationCatalog: - description: Supported network configurations. - $ref: '#/components/schemas/NetworkConfigurationCatalog' - softwareCatalog: - description: The software test environment provided by TestExecutionService. - $ref: '#/components/schemas/ProvidedSoftwareCatalog' - deviceIpBlockCatalog: - description: The IP blocks used by devices in the test environment. - $ref: '#/components/schemas/DeviceIpBlockCatalog' - AndroidDeviceCatalog: - id: AndroidDeviceCatalog - description: The currently supported Android devices. - type: object - properties: - models: - description: The set of supported Android device models. - type: array - items: - $ref: '#/components/schemas/AndroidModel' - versions: - description: The set of supported Android OS versions. - type: array - items: - $ref: '#/components/schemas/AndroidVersion' - runtimeConfiguration: - description: The set of supported runtime configurations. - $ref: '#/components/schemas/AndroidRuntimeConfiguration' - AndroidModel: - id: AndroidModel - description: A description of an Android device tests may be run on. - type: object - properties: - id: - description: >- - The unique opaque id for this model. Use this for invoking the - TestExecutionService. - type: string - name: - description: >- - The human-readable marketing name for this device model. Examples: - "Nexus 5", "Galaxy S5". - type: string - manufacturer: - description: The manufacturer of this device. - type: string - brand: - description: >- - The company that this device is branded with. Example: "Google", - "Samsung". - type: string - codename: - description: >- - The name of the industrial design. This corresponds to - android.os.Build.DEVICE. - type: string - form: - description: Whether this device is virtual or physical. - type: string - enumDescriptions: - - Do not use. For proto versioning only. - - >- - Android virtual device using Compute Engine native virtualization. - Firebase Test Lab only. - - Actual hardware. - - >- - Android virtual device using emulator in nested virtualization. - Equivalent to Android Studio. - enum: - - DEVICE_FORM_UNSPECIFIED - - VIRTUAL - - PHYSICAL - - EMULATOR - formFactor: - description: Whether this device is a phone, tablet, wearable, etc. - type: string - enumDescriptions: - - Do not use. For proto versioning only. - - This device has the shape of a phone. - - This device has the shape of a tablet. - - This device has the shape of a watch or other wearable. - enum: - - DEVICE_FORM_FACTOR_UNSPECIFIED - - PHONE - - TABLET - - WEARABLE - perVersionInfo: - description: Version-specific information of an Android model. - type: array - items: - $ref: '#/components/schemas/PerAndroidVersionInfo' - screenX: - description: Screen size in the horizontal (X) dimension measured in pixels. - type: integer - format: int32 - screenY: - description: Screen size in the vertical (Y) dimension measured in pixels. - type: integer - format: int32 - screenDensity: - description: Screen density in DPI. This corresponds to ro.sf.lcd_density - type: integer - format: int32 - lowFpsVideoRecording: - description: >- - True if and only if tests with this model are recorded by stitching - together screenshots. See use_low_spec_video_recording in device - config. - type: boolean - supportedVersionIds: - description: The set of Android versions this device supports. - type: array - items: - type: string - supportedAbis: - description: >- - The list of supported ABIs for this device. This corresponds to - either android.os.Build.SUPPORTED_ABIS (for API level 21 and above) - or android.os.Build.CPU_ABI/CPU_ABI2. The most preferred ABI is the - first element in the list. Elements are optionally prefixed by - "version_id:" (where version_id is the id of an AndroidVersion), - denoting an ABI that is supported only on a particular version. - type: array - items: - type: string - tags: - description: >- - Tags for this dimension. Examples: "default", "preview", - "deprecated". - type: array - items: - type: string - thumbnailUrl: - description: URL of a thumbnail image (photo) of the device. - type: string - labInfo: - description: Output only. Lab info of this device. - readOnly: true - $ref: '#/components/schemas/LabInfo' - PerAndroidVersionInfo: - id: PerAndroidVersionInfo - description: A version-specific information of an Android model. - type: object - properties: - versionId: - description: An Android version. - type: string - deviceCapacity: - description: The number of online devices for an Android version. - type: string - enumDescriptions: - - The value of device capacity is unknown or unset. - - >- - Devices that are high in capacity (The lab has a large number of - these devices). These devices are generally suggested for running - a large number of simultaneous tests (e.g. more than 100 tests). - Please note that high capacity devices do not guarantee short wait - times due to several factors: 1. Traffic (how heavily they are - used at any given moment) 2. High capacity devices are prioritized - for certain usages, which may cause user tests to be slower than - selecting other similar device types. - - >- - Devices that are medium in capacity (The lab has a decent number - of these devices, though not as many as high capacity devices). - These devices are suitable for fewer test runs (e.g. fewer than - 100 tests) and only for low shard counts (e.g. less than 10 - shards). - - >- - Devices that are low in capacity (The lab has a small number of - these devices). These devices may be used if users need to test on - this specific device model and version. Please note that due to - low capacity, the tests may take much longer to finish, especially - if a large number of tests are invoked at once. These devices are - not suitable for test sharding. - - >- - Devices that are completely missing from the lab. These devices - are unavailable either temporarily or permanently and should not - be requested. If the device is also marked as deprecated, this - state is very likely permanent. - enum: - - DEVICE_CAPACITY_UNSPECIFIED - - DEVICE_CAPACITY_HIGH - - DEVICE_CAPACITY_MEDIUM - - DEVICE_CAPACITY_LOW - - DEVICE_CAPACITY_NONE - interactiveDeviceAvailabilityEstimate: - description: >- - Output only. The estimated wait time for a single interactive device - session using Direct Access. - readOnly: true - type: string - format: google-duration - directAccessVersionInfo: - description: >- - Output only. Identifies supported clients for DirectAccess for this - Android version. - readOnly: true - $ref: '#/components/schemas/DirectAccessVersionInfo' - DirectAccessVersionInfo: - id: DirectAccessVersionInfo - description: >- - Denotes whether Direct Access is supported, and by which client - versions. DirectAccessService is currently available as a preview to - select developers. You can register today on behalf of you and your team - at https://developer.android.com/studio/preview/android-device-streaming - type: object - properties: - directAccessSupported: - description: >- - Whether direct access is supported at all. Clients are expected to - filter down the device list to only android models and versions - which support Direct Access when that is the user intent. - type: boolean - minimumAndroidStudioVersion: - description: >- - Output only. Indicates client-device compatibility, where a device - is known to work only with certain workarounds implemented in the - Android Studio client. Expected format "major.minor.micro.patch", - e.g. "5921.22.2211.8881706". - type: string - LabInfo: - id: LabInfo - description: Lab specific information for a device. - type: object - properties: - name: - description: >- - Lab name where the device is hosted. If empty, the device is hosted - in a Google owned lab. - type: string - AndroidVersion: - id: AndroidVersion - description: A version of the Android OS. - type: object - properties: - id: - description: >- - An opaque id for this Android version. Use this id to invoke the - TestExecutionService. - type: string - versionString: - description: >- - A string representing this version of the Android OS. Examples: - "4.3", "4.4". - type: string - apiLevel: - description: 'The API level for this Android version. Examples: 18, 19.' - type: integer - format: int32 - codeName: - description: >- - The code name for this Android version. Examples: "JellyBean", - "KitKat". - type: string - releaseDate: - description: The date this Android version became available in the market. - $ref: '#/components/schemas/Date' - distribution: - description: Market share for this version. - $ref: '#/components/schemas/Distribution' - tags: - description: >- - Tags for this dimension. Examples: "default", "preview", - "deprecated". - type: array - items: - type: string - Date: - id: Date - description: >- - Represents a whole or partial calendar date, such as a birthday. The - time of day and time zone are either specified elsewhere or are - insignificant. The date is relative to the Gregorian Calendar. This can - represent one of the following: * A full date, with non-zero year, - month, and day values. * A month and day, with a zero year (for example, - an anniversary). * A year on its own, with a zero month and a zero day. - * A year and month, with a zero day (for example, a credit card - expiration date). Related types: * google.type.TimeOfDay * - google.type.DateTime * google.protobuf.Timestamp - type: object - properties: - year: - description: >- - Year of the date. Must be from 1 to 9999, or 0 to specify a date - without a year. - type: integer - format: int32 - month: - description: >- - Month of a year. Must be from 1 to 12, or 0 to specify a year - without a month and day. - type: integer - format: int32 - day: - description: >- - Day of a month. Must be from 1 to 31 and valid for the year and - month, or 0 to specify a year by itself or a year and month where - the day isn't significant. - type: integer - format: int32 - Distribution: - id: Distribution - description: >- - Data about the relative number of devices running a given configuration - of the Android platform. - type: object - properties: - measurementTime: - description: Output only. The time this distribution was measured. - type: string - format: google-datetime - marketShare: - description: >- - Output only. The estimated fraction (0-1) of the total market with - this configuration. - type: number - format: double - AndroidRuntimeConfiguration: - id: AndroidRuntimeConfiguration - description: Android configuration that can be selected at the time a test is run. - type: object - properties: - locales: - description: The set of available locales. - type: array - items: - $ref: '#/components/schemas/Locale' - orientations: - description: The set of available orientations. - type: array - items: - $ref: '#/components/schemas/Orientation' - Locale: - id: Locale - description: A location/region designation for language. - type: object - properties: - id: - description: 'The id for this locale. Example: "en_US".' - type: string - name: - description: 'A human-friendly name for this language/locale. Example: "English".' - type: string - region: - description: >- - A human-friendly string representing the region for this locale. - Example: "United States". Not present for every locale. - type: string - tags: - description: 'Tags for this dimension. Example: "default".' - type: array - items: - type: string - Orientation: - id: Orientation - description: Screen orientation of the device. - type: object - properties: - id: - description: 'The id for this orientation. Example: "portrait".' - type: string - name: - description: 'A human-friendly name for this orientation. Example: "portrait".' - type: string - tags: - description: 'Tags for this dimension. Example: "default".' - type: array - items: - type: string - IosDeviceCatalog: - id: IosDeviceCatalog - description: The currently supported iOS devices. - type: object - properties: - models: - description: The set of supported iOS device models. - type: array - items: - $ref: '#/components/schemas/IosModel' - versions: - description: The set of supported iOS software versions. - type: array - items: - $ref: '#/components/schemas/IosVersion' - xcodeVersions: - description: The set of supported Xcode versions. - type: array - items: - $ref: '#/components/schemas/XcodeVersion' - runtimeConfiguration: - description: The set of supported runtime configurations. - $ref: '#/components/schemas/IosRuntimeConfiguration' - IosModel: - id: IosModel - description: A description of an iOS device tests may be run on. - type: object - properties: - id: - description: >- - The unique opaque id for this model. Use this for invoking the - TestExecutionService. - type: string - name: - description: >- - The human-readable name for this device model. Examples: "iPhone - 4s", "iPad Mini 2". - type: string - supportedVersionIds: - description: The set of iOS major software versions this device supports. - type: array - items: - type: string - tags: - description: >- - Tags for this dimension. Examples: "default", "preview", - "deprecated". - type: array - items: - type: string - deviceCapabilities: - description: >- - Device capabilities. Copied from - https://developer.apple.com/library/archive/documentation/DeviceInformation/Reference/iOSDeviceCompatibility/DeviceCompatibilityMatrix/DeviceCompatibilityMatrix.html - type: array - items: - type: string - screenX: - description: Screen size in the horizontal (X) dimension measured in pixels. - type: integer - format: int32 - screenY: - description: Screen size in the vertical (Y) dimension measured in pixels. - type: integer - format: int32 - screenDensity: - description: Screen density in DPI. - type: integer - format: int32 - formFactor: - description: Whether this device is a phone, tablet, wearable, etc. - type: string - enumDescriptions: - - Do not use. For proto versioning only. - - This device has the shape of a phone. - - This device has the shape of a tablet. - - This device has the shape of a watch or other wearable. - enum: - - DEVICE_FORM_FACTOR_UNSPECIFIED - - PHONE - - TABLET - - WEARABLE - perVersionInfo: - description: Version-specific information of an iOS model. - type: array - items: - $ref: '#/components/schemas/PerIosVersionInfo' - PerIosVersionInfo: - id: PerIosVersionInfo - description: A version-specific information of an iOS model. - type: object - properties: - versionId: - description: An iOS version. - type: string - deviceCapacity: - description: The number of online devices for an iOS version. - type: string - enumDescriptions: - - The value of device capacity is unknown or unset. - - >- - Devices that are high in capacity (The lab has a large number of - these devices). These devices are generally suggested for running - a large number of simultaneous tests (e.g. more than 100 tests). - Please note that high capacity devices do not guarantee short wait - times due to several factors: 1. Traffic (how heavily they are - used at any given moment) 2. High capacity devices are prioritized - for certain usages, which may cause user tests to be slower than - selecting other similar device types. - - >- - Devices that are medium in capacity (The lab has a decent number - of these devices, though not as many as high capacity devices). - These devices are suitable for fewer test runs (e.g. fewer than - 100 tests) and only for low shard counts (e.g. less than 10 - shards). - - >- - Devices that are low in capacity (The lab has a small number of - these devices). These devices may be used if users need to test on - this specific device model and version. Please note that due to - low capacity, the tests may take much longer to finish, especially - if a large number of tests are invoked at once. These devices are - not suitable for test sharding. - - >- - Devices that are completely missing from the lab. These devices - are unavailable either temporarily or permanently and should not - be requested. If the device is also marked as deprecated, this - state is very likely permanent. - enum: - - DEVICE_CAPACITY_UNSPECIFIED - - DEVICE_CAPACITY_HIGH - - DEVICE_CAPACITY_MEDIUM - - DEVICE_CAPACITY_LOW - - DEVICE_CAPACITY_NONE - IosVersion: - id: IosVersion - description: An iOS version. - type: object - properties: - id: - description: >- - An opaque id for this iOS version. Use this id to invoke the - TestExecutionService. - type: string - majorVersion: - description: 'An integer representing the major iOS version. Examples: "8", "9".' - type: integer - format: int32 - minorVersion: - description: 'An integer representing the minor iOS version. Examples: "1", "2".' - type: integer - format: int32 - tags: - description: >- - Tags for this dimension. Examples: "default", "preview", - "deprecated". - type: array - items: - type: string - supportedXcodeVersionIds: - description: The available Xcode versions for this version. - type: array - items: - type: string - XcodeVersion: - id: XcodeVersion - description: An Xcode version that an iOS version is compatible with. - type: object - properties: - version: - description: 'The id for this version. Example: "9.2".' - type: string - tags: - description: 'Tags for this Xcode version. Example: "default".' - type: array - items: - type: string - IosRuntimeConfiguration: - id: IosRuntimeConfiguration - description: iOS configuration that can be selected at the time a test is run. - type: object - properties: - locales: - description: The set of available locales. - type: array - items: - $ref: '#/components/schemas/Locale' - orientations: - description: The set of available orientations. - type: array - items: - $ref: '#/components/schemas/Orientation' - NetworkConfigurationCatalog: - id: NetworkConfigurationCatalog - type: object - properties: - configurations: - type: array - items: - $ref: '#/components/schemas/NetworkConfiguration' - NetworkConfiguration: - id: NetworkConfiguration - type: object - properties: - id: - description: The unique opaque id for this network traffic configuration. - type: string - upRule: - description: The emulation rule applying to the upload traffic. - $ref: '#/components/schemas/TrafficRule' - downRule: - description: The emulation rule applying to the download traffic. - $ref: '#/components/schemas/TrafficRule' - TrafficRule: - id: TrafficRule - description: Network emulation parameters. - type: object - properties: - delay: - description: Packet delay, must be >= 0. - type: string - format: google-duration - packetLossRatio: - description: Packet loss ratio (0.0 - 1.0). - type: number - format: float - packetDuplicationRatio: - description: Packet duplication ratio (0.0 - 1.0). - type: number - format: float - bandwidth: - description: Bandwidth in kbits/second. - type: number - format: float - burst: - description: Burst size in kbits. - type: number - format: float - ProvidedSoftwareCatalog: - id: ProvidedSoftwareCatalog - description: The currently provided software environment on the devices under test. - type: object - properties: - orchestratorVersion: - description: >- - Deprecated: Use AndroidX Test Orchestrator going forward. A string - representing the current version of Android Test Orchestrator that - is used in the environment. The package is available at - https://maven.google.com/web/index.html#com.android.support.test:orchestrator. - deprecated: true - type: string - androidxOrchestratorVersion: - description: >- - A string representing the current version of AndroidX Test - Orchestrator that is used in the environment. The package is - available at - https://maven.google.com/web/index.html#androidx.test:orchestrator. - type: string - DeviceIpBlockCatalog: - id: DeviceIpBlockCatalog - description: List of IP blocks used by the Firebase Test Lab - type: object - properties: - ipBlocks: - description: The device IP blocks used by Firebase Test Lab - type: array - items: - $ref: '#/components/schemas/DeviceIpBlock' - DeviceIpBlock: - id: DeviceIpBlock - description: A single device IP block - type: object - properties: - block: - description: 'An IP address block in CIDR notation eg: 34.68.194.64/29' - type: string - form: - description: Whether this block is used by physical or virtual devices - type: string - enumDescriptions: - - Do not use. For proto versioning only. - - >- - Android virtual device using Compute Engine native virtualization. - Firebase Test Lab only. - - Actual hardware. - - >- - Android virtual device using emulator in nested virtualization. - Equivalent to Android Studio. - enum: - - DEVICE_FORM_UNSPECIFIED - - VIRTUAL - - PHYSICAL - - EMULATOR - addedDate: - description: The date this block was added to Firebase Test Lab - $ref: '#/components/schemas/Date' - parameters: - 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: - type: string - enum: - - json - - media - - proto - 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 - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string - _.xgafv: - description: V1 error format. - in: query - name: $.xgafv - schema: - type: string - enum: - - '1' - - '2' - x-stackQL-resources: - test_matrices: - id: google.testing.test_matrices - name: test_matrices - title: Test_matrices - methods: - create: - operation: - $ref: '#/paths/~1v1~1projects~1{projectId}~1testMatrices/post' - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectId}~1testMatrices~1{testMatrixId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - cancel: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectId}~1testMatrices~1{testMatrixId}:cancel/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/test_matrices/methods/get' - insert: - - $ref: '#/components/x-stackQL-resources/test_matrices/methods/create' - update: [] - replace: [] - delete: [] - device_sessions: - id: google.testing.device_sessions - name: device_sessions - title: Device_sessions - methods: - create: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1deviceSessions/post' - response: - mediaType: application/json - openAPIDocKey: '200' - list: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1deviceSessions/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.deviceSessions - get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1deviceSessions~1{deviceSessionsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - patch: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1deviceSessions~1{deviceSessionsId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - cancel: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1deviceSessions~1{deviceSessionsId}:cancel/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/device_sessions/methods/get' - - $ref: '#/components/x-stackQL-resources/device_sessions/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/device_sessions/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/device_sessions/methods/patch' - replace: [] - delete: [] - application_detail_service_apk_details: - id: google.testing.application_detail_service_apk_details - name: application_detail_service_apk_details - title: Application_detail_service_apk_details - methods: - get_apk_details: - operation: - $ref: '#/paths/~1v1~1applicationDetailService~1getApkDetails/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/application_detail_service_apk_details/methods/get_apk_details - insert: [] - update: [] - replace: [] - delete: [] - test_environment_catalog: - id: google.testing.test_environment_catalog - name: test_environment_catalog - title: Test_environment_catalog - methods: - get: - operation: - $ref: '#/paths/~1v1~1testEnvironmentCatalog~1{environmentType}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/test_environment_catalog/methods/get - insert: [] - update: [] - replace: [] - delete: [] -paths: - /v1/projects/{projectId}/testMatrices: - parameters: &ref_1 - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/_.xgafv' - post: - description: >- - Creates and runs a matrix of tests according to the given - specifications. Unsupported environments will be returned in the state - UNSUPPORTED. A test matrix is limited to use at most 2000 devices in - parallel. The returned matrix will not yet contain the executions that - will be created for this matrix. Execution creation happens later on and - will require a call to GetTestMatrix. May return any of the following - canonical error codes: - PERMISSION_DENIED - if the user is not - authorized to write to project - INVALID_ARGUMENT - if the request is - malformed or if the matrix tries to use too many simultaneous devices. - operationId: testing.projects.testMatrices.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TestMatrix' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/TestMatrix' - parameters: - - in: path - name: projectId - required: true - schema: - type: string - - in: query - name: requestId - schema: - type: string - /v1/projects/{projectId}/testMatrices/{testMatrixId}: - parameters: *ref_1 - get: - description: >- - Checks the status of a test matrix and the executions once they are - created. The test matrix will contain the list of test executions to run - if and only if the resultStorage.toolResultsExecution fields have been - populated. Note: Flaky test executions may be added to the matrix at a - later stage. May return any of the following canonical error codes: - - PERMISSION_DENIED - if the user is not authorized to read project - - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Test - Matrix does not exist - operationId: testing.projects.testMatrices.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/TestMatrix' - parameters: - - in: path - name: projectId - required: true - schema: - type: string - - in: path - name: testMatrixId - required: true - schema: - type: string - /v1/projects/{projectId}/testMatrices/{testMatrixId}:cancel: - parameters: *ref_1 - post: - description: >- - Cancels unfinished test executions in a test matrix. This call returns - immediately and cancellation proceeds asynchronously. If the matrix is - already final, this operation will have no effect. May return any of the - following canonical error codes: - PERMISSION_DENIED - if the user is - not authorized to read project - INVALID_ARGUMENT - if the request is - malformed - NOT_FOUND - if the Test Matrix does not exist - operationId: testing.projects.testMatrices.cancel - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/CancelTestMatrixResponse' - parameters: - - in: path - name: projectId - required: true - schema: - type: string - - in: path - name: testMatrixId - required: true - schema: - type: string - /v1/projects/{projectsId}/deviceSessions: - parameters: *ref_1 - post: - description: POST /v1/projects/{project_id}/deviceSessions - operationId: testing.projects.deviceSessions.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DeviceSession' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/DeviceSession' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - get: - description: >- - GET /v1/projects/{project_id}/deviceSessions Lists device Sessions owned - by the project user. - operationId: testing.projects.deviceSessions.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/ListDeviceSessionsResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - /v1/projects/{projectsId}/deviceSessions/{deviceSessionsId}: - parameters: *ref_1 - get: - description: >- - GET /v1/projects/{project_id}/deviceSessions/{device_session_id} Return - a DeviceSession, which documents the allocation status and whether the - device is allocated. Clients making requests from this API must poll - GetDeviceSession. - operationId: testing.projects.deviceSessions.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/DeviceSession' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: deviceSessionsId - required: true - schema: - type: string - patch: - description: >- - PATCH - /v1/projects/{projectId}/deviceSessions/deviceSessionId}:updateDeviceSession - Updates the current device session to the fields described by the - update_mask. - operationId: testing.projects.deviceSessions.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DeviceSession' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/DeviceSession' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: deviceSessionsId - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1/projects/{projectsId}/deviceSessions/{deviceSessionsId}:cancel: - parameters: *ref_1 - post: - description: >- - POST /v1/projects/{project_id}/deviceSessions/{device_session_id}:cancel - Changes the DeviceSession to state FINISHED and terminates all - connections. Canceled sessions are not deleted and can be retrieved or - listed by the user until they expire based on the 28 day deletion - policy. - operationId: testing.projects.deviceSessions.cancel - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CancelDeviceSessionRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Empty' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: deviceSessionsId - required: true - schema: - type: string - /v1/applicationDetailService/getApkDetails: - parameters: *ref_1 - post: - description: Gets the details of an Android application APK. - operationId: testing.applicationDetailService.getApkDetails - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/FileReference' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GetApkDetailsResponse' - parameters: - - in: query - name: bundleLocation.gcsPath - schema: - type: string - /v1/testEnvironmentCatalog/{environmentType}: - parameters: *ref_1 - get: - description: >- - Gets the catalog of supported test environments. May return any of the - following canonical error codes: - INVALID_ARGUMENT - if the request is - malformed - NOT_FOUND - if the environment type does not exist - - INTERNAL - if an internal error occurred - operationId: testing.testEnvironmentCatalog.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/TestEnvironmentCatalog' - parameters: - - in: path - name: environmentType - required: true - schema: - type: string - - in: query - name: projectId - schema: - type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/texttospeech.yaml b/providers/src/googleapis.com/v00.00.00000/services/texttospeech.yaml index ad315fa6..baf89807 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/texttospeech.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/texttospeech.yaml @@ -9,8 +9,8 @@ info: Synthesizes natural-sounding speech by applying powerful neural network models. version: v1 - x-discovery-doc-revision: '20241026' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250814' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/text-to-speech/ servers: @@ -117,6 +117,11 @@ components: text: description: The raw text to be synthesized. type: string + markup: + description: >- + Markup for HD voices specifically. This field may not be used with + any other voices. + type: string ssml: description: >- The SSML document to be synthesized. The SSML document must be valid @@ -131,15 +136,13 @@ components: $ref: '#/components/schemas/MultiSpeakerMarkup' customPronunciations: description: >- - Optional. The pronunciation customizations to be applied to the - input. If this is set, the input will be synthesized using the given - pronunciation customizations. The initial support will be for EFIGS - (English, French, Italian, German, Spanish) languages, as provided - in VoiceSelectionParams. Journey and Instant Clone voices are not - supported yet. In order to customize the pronunciation of a phrase, - there must be an exact match of the phrase in the input types. If - using SSML, the phrase must not be inside a phoneme tag (entirely or - partially). + Optional. The pronunciation customizations are applied to the input. + If this is set, the input is synthesized using the given + pronunciation customizations. The initial support is for en-us, with + plans to expand to other locales in the future. Instant Clone voices + aren't supported. In order to customize the pronunciation of a + phrase, there must be an exact match of the phrase in the input + types. If using SSML, the phrase must not be inside a phoneme tag. $ref: '#/components/schemas/CustomPronunciations' MultiSpeakerMarkup: id: MultiSpeakerMarkup @@ -153,7 +156,7 @@ components: $ref: '#/components/schemas/Turn' Turn: id: Turn - description: A Multi-speaker turn. + description: A multi-speaker turn. type: object properties: speaker: @@ -170,7 +173,7 @@ components: type: object properties: pronunciations: - description: The pronunciation customizations to be applied. + description: The pronunciation customizations are applied. type: array items: $ref: '#/components/schemas/CustomPronunciationParams' @@ -181,9 +184,9 @@ components: properties: phrase: description: >- - The phrase to which the customization will be applied. The phrase - can be multiple words (in the case of proper nouns etc), but should - not span to a whole sentence. + The phrase to which the customization is applied. The phrase can be + multiple words, such as proper nouns, but shouldn't span the length + of the sentence. type: string phoneticEncoding: description: The phonetic encoding of the phrase. @@ -191,15 +194,32 @@ components: enumDescriptions: - Not specified. - >- - IPA. (e.g. apple -> ˈæpəl ) + IPA, such as apple -> ˈæpəl. https://en.wikipedia.org/wiki/International_Phonetic_Alphabet - >- - X-SAMPA (e.g. apple -> "{p@l" ) + X-SAMPA, such as apple -> "{p@l". https://en.wikipedia.org/wiki/X-SAMPA + - >- + For reading-to-pron conversion to work well, the `pronunciation` + field should only contain Kanji, Hiragana, and Katakana. The + pronunciation can also contain pitch accents. The start of a pitch + phrase is specified with `^` and the down-pitch position is + specified with `!`, for example: phrase:端 pronunciation:^はし + phrase:箸 pronunciation:^は!し phrase:橋 pronunciation:^はし! We + currently only support the Tokyo dialect, which allows at most one + down-pitch per phrase (i.e. at most one `!` between `^`). + - >- + Used to specify pronunciations for Mandarin words. See + https://en.wikipedia.org/wiki/Pinyin. For example: 朝阳, the + pronunciation is "chao2 yang2". The number represents the tone, + and there is a space between syllables. Neutral tones are + represented by 5, for example 孩子 "hai2 zi5". enum: - PHONETIC_ENCODING_UNSPECIFIED - PHONETIC_ENCODING_IPA - PHONETIC_ENCODING_X_SAMPA + - PHONETIC_ENCODING_JAPANESE_YOMIGANA + - PHONETIC_ENCODING_PINYIN pronunciation: description: >- The pronunciation of the phrase. This must be in the phonetic @@ -264,9 +284,14 @@ components: voiceClone: description: >- Optional. The configuration for a voice clone. If - [VoiceCloneParams.voice_clone_key] is set, the service will choose - the voice clone matching the specified configuration. + [VoiceCloneParams.voice_clone_key] is set, the service chooses the + voice clone matching the specified configuration. $ref: '#/components/schemas/VoiceCloneParams' + modelName: + description: >- + Optional. The name of the model. If set, the service will choose the + model matching the specified configuration. + type: string CustomVoiceParams: id: CustomVoiceParams description: Description of the custom voice to be synthesized. @@ -315,16 +340,16 @@ components: type: string enumDescriptions: - >- - Not specified. Will return result - google.rpc.Code.INVALID_ARGUMENT. + Not specified. Only used by GenerateVoiceCloningKey. Otherwise, + will return result google.rpc.Code.INVALID_ARGUMENT. - >- Uncompressed 16-bit signed little-endian samples (Linear PCM). Audio content returned as LINEAR16 also contains a WAV header. - MP3 audio at 32kbps. - >- - Opus encoded audio wrapped in an ogg container. The result will be - a file which can be played natively on Android, and in browsers - (at least Chrome and Firefox). The quality of the encoding is + Opus encoded audio wrapped in an ogg container. The result is a + file which can be played natively on Android, and in browsers (at + least Chrome and Firefox). The quality of the encoding is considerably higher than MP3 while using approximately the same bitrate. - >- @@ -335,6 +360,11 @@ components: 8-bit samples that compand 14-bit audio samples using G.711 PCMU/A-law. Audio content returned as ALAW also contains a WAV header. + - >- + Uncompressed 16-bit signed little-endian samples (Linear PCM). + Note that as opposed to LINEAR16, audio won't be wrapped in a WAV + (or any other) header. + - M4A audio. enum: - AUDIO_ENCODING_UNSPECIFIED - LINEAR16 @@ -342,12 +372,14 @@ components: - OGG_OPUS - MULAW - ALAW + - PCM + - M4A speakingRate: description: >- - Optional. Input only. Speaking rate/speed, in the range [0.25, 4.0]. + Optional. Input only. Speaking rate/speed, in the range [0.25, 2.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults - to the native 1.0 speed. Any other values < 0.25 or > 4.0 will + to the native 1.0 speed. Any other values < 0.25 or > 2.0 will return an error. type: number format: double @@ -400,8 +432,8 @@ components: properties: lowLatencyJourneySynthesis: description: >- - Only for Journey voices. If false, the synthesis will be context - aware and have higher latency. + Only for Journey voices. If false, the synthesis is context aware + and has a higher latency. type: boolean SynthesizeSpeechResponse: id: SynthesizeSpeechResponse @@ -977,7 +1009,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: texttospeech.operations.cancel requestBody: content: diff --git a/providers/src/googleapis.com/v00.00.00000/services/tpu.yaml b/providers/src/googleapis.com/v00.00.00000/services/tpu.yaml index 29b312e5..a16ebd8b 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/tpu.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/tpu.yaml @@ -7,8 +7,8 @@ info: title: Cloud TPU API description: TPU API provides customers with access to Google TPU technology. version: v2 - x-discovery-doc-revision: '20241025' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250815' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/tpu/ servers: @@ -278,8 +278,21 @@ components: description: Required. The runtime version running in the Node. type: string networkConfig: - description: Network configurations for the TPU node. + description: >- + Network configurations for the TPU node. network_config and + network_configs are mutually exclusive, you can only specify one of + them. If both are specified, an error will be returned. $ref: '#/components/schemas/NetworkConfig' + networkConfigs: + description: >- + Optional. Repeated network configurations for the TPU node. This + field is used to specify multiple networks configs for the TPU node. + network_config and network_configs are mutually exclusive, you can + only specify one of them. If both are specified, an error will be + returned. + type: array + items: + $ref: '#/components/schemas/NetworkConfig' cidrBlock: description: >- The CIDR block that the TPU node will use when selecting an IP @@ -398,6 +411,10 @@ components: description: Output only. Whether the Node belongs to a Multislice group. readOnly: true type: boolean + upcomingMaintenance: + description: Output only. Upcoming maintenance on this TPU node. + readOnly: true + $ref: '#/components/schemas/UpcomingMaintenance' NetworkConfig: id: NetworkConfig description: Network related configurations. @@ -573,7 +590,8 @@ components: - TPU v3. - TPU v4. - TPU v5lite pod. - - TPU v5p + - TPU v5p. + - TPU v6e. enum: - TYPE_UNSPECIFIED - V2 @@ -581,9 +599,59 @@ components: - V4 - V5LITE_POD - V5P + - V6E topology: description: Required. Topology of TPU in chips. type: string + UpcomingMaintenance: + id: UpcomingMaintenance + description: Upcoming Maintenance notification information. + type: object + properties: + type: + description: Defines the type of maintenance. + type: string + enumDescriptions: + - No type specified. Do not use this value. + - >- + Scheduled maintenance (e.g. maintenance after uptime guarantee is + complete). + - >- + Unscheduled maintenance (e.g. emergency maintenance during uptime + guarantee). + enum: + - UNKNOWN_TYPE + - SCHEDULED + - UNSCHEDULED + canReschedule: + description: Indicates if the maintenance can be customer triggered. + type: boolean + windowStartTime: + description: >- + The current start time of the maintenance window. This timestamp + value is in RFC3339 text format. + type: string + windowEndTime: + description: >- + The time by which the maintenance disruption will be completed. This + timestamp value is in RFC3339 text format. + type: string + latestWindowStartTime: + description: >- + The latest time for the planned maintenance window to start. This + timestamp value is in RFC3339 text format. + type: string + maintenanceStatus: + description: The status of the maintenance. + type: string + enumDescriptions: + - Unknown maintenance status. Do not use this value. + - There is pending maintenance. + - There is ongoing maintenance on this VM. + enum: + - UNKNOWN + - PENDING + - ONGOING StopNodeRequest: id: StopNodeRequest description: Request for StopNode. @@ -695,8 +763,8 @@ components: nodeCount: description: >- Required. Number of nodes with this spec. The system will attempt to - provison "node_count" nodes as part of the request. This needs to be - > 1. + provision "node_count" nodes as part of the request. This needs to + be > 1. type: integer format: int32 nodeIdPrefix: @@ -1508,6 +1576,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v2/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: @@ -1695,7 +1767,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: tpu.projects.locations.operations.cancel security: - Oauth2: diff --git a/providers/src/googleapis.com/v00.00.00000/services/trafficdirector.yaml b/providers/src/googleapis.com/v00.00.00000/services/trafficdirector.yaml index 4fcbd094..9ee9f8e4 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/trafficdirector.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/trafficdirector.yaml @@ -7,8 +7,8 @@ info: title: Traffic Director API description: '' version: v3 - x-discovery-doc-revision: '20241009' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250728' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/traffic-director servers: @@ -82,24 +82,24 @@ components: type: string prefix: description: >- - The input string must have the prefix specified here. Note: empty - prefix is not allowed, please use regex instead. Examples: * ``abc`` - matches the value ``abc.xyz`` + The input string must have the prefix specified here. .. note:: + Empty prefix match is not allowed, please use ``safe_regex`` + instead. Examples: * ``abc`` matches the value ``abc.xyz`` type: string suffix: description: >- - The input string must have the suffix specified here. Note: empty - prefix is not allowed, please use regex instead. Examples: * ``abc`` - matches the value ``xyz.abc`` + The input string must have the suffix specified here. .. note:: + Empty suffix match is not allowed, please use ``safe_regex`` + instead. Examples: * ``abc`` matches the value ``xyz.abc`` type: string safeRegex: description: The input string must match the regular expression specified here. $ref: '#/components/schemas/RegexMatcher' contains: description: >- - The input string must have the substring specified here. Note: empty - contains match is not allowed, please use regex instead. Examples: * - ``abc`` matches the value ``xyz.abc.def`` + The input string must have the substring specified here. .. note:: + Empty contains match is not allowed, please use ``safe_regex`` + instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` type: string custom: description: >- @@ -108,10 +108,11 @@ components: $ref: '#/components/schemas/TypedExtensionConfig' ignoreCase: description: >- - If true, indicates the exact/prefix/suffix/contains matching should - be case insensitive. This has no effect for the safe_regex match. - For example, the matcher ``data`` will match both input string - ``Data`` and ``data`` if set to true. + If ``true``, indicates the exact/prefix/suffix/contains matching + should be case insensitive. This has no effect for the + ``safe_regex`` match. For example, the matcher ``data`` will match + both input string ``Data`` and ``data`` if this option is set to + ``true``. type: boolean RegexMatcher: id: RegexMatcher @@ -544,7 +545,7 @@ components: $ref: '#/components/schemas/EnvoyInternalAddress' SocketAddress: id: SocketAddress - description: '[#next-free-field: 7]' + description: '[#next-free-field: 8]' type: object properties: protocol: @@ -593,6 +594,16 @@ components: connections, with peer IPv4 addresses mapped into IPv6 space as ``::FFFF:``. type: boolean + networkNamespaceFilepath: + description: >- + Filepath that specifies the Linux network namespace this socket will + be created in (see ``man 7 network_namespaces``). If this field is + set, Envoy will create the socket in the specified network + namespace. .. note:: Setting this parameter requires Envoy to run + with the ``CAP_NET_ADMIN`` capability. .. note:: Currently only used + for Listener sockets. .. attention:: Network namespaces are only + configurable on Linux. Otherwise, this field has no effect. + type: string Pipe: id: Pipe type: object @@ -710,11 +721,16 @@ components: attached config dump is not the NACKed version, but the most recent accepted one. If no config is accepted yet, the attached config dump will be empty. + - >- + Client received an error from the control plane. The attached + config dump is the most recent accepted one. If no config is + accepted yet, the attached config dump will be empty. enum: - CLIENT_UNKNOWN - CLIENT_REQUESTED - CLIENT_ACKED - CLIENT_NACKED + - CLIENT_RECEIVED_ERROR listenerConfig: $ref: '#/components/schemas/ListenersConfigDump' clusterConfig: @@ -825,12 +841,19 @@ components: section. - Client received this resource and replied with ACK. - Client received this resource and replied with NACK. + - >- + Client received an error from the control plane. The attached + config dump is the most recent accepted one. If no config is + accepted yet, the attached config dump will be empty. + - Client timed out waiting for the resource from the control plane. enum: - UNKNOWN - REQUESTED - DOES_NOT_EXIST - ACKED - NACKED + - RECEIVED_ERROR + - TIMEOUT DynamicListenerState: id: DynamicListenerState type: object @@ -980,12 +1003,19 @@ components: section. - Client received this resource and replied with ACK. - Client received this resource and replied with NACK. + - >- + Client received an error from the control plane. The attached + config dump is the most recent accepted one. If no config is + accepted yet, the attached config dump will be empty. + - Client timed out waiting for the resource from the control plane. enum: - UNKNOWN - REQUESTED - DOES_NOT_EXIST - ACKED - NACKED + - RECEIVED_ERROR + - TIMEOUT RoutesConfigDump: id: RoutesConfigDump description: >- @@ -1070,12 +1100,19 @@ components: section. - Client received this resource and replied with ACK. - Client received this resource and replied with NACK. + - >- + Client received an error from the control plane. The attached + config dump is the most recent accepted one. If no config is + accepted yet, the attached config dump will be empty. + - Client timed out waiting for the resource from the control plane. enum: - UNKNOWN - REQUESTED - DOES_NOT_EXIST - ACKED - NACKED + - RECEIVED_ERROR + - TIMEOUT ScopedRoutesConfigDump: id: ScopedRoutesConfigDump description: >- @@ -1169,12 +1206,19 @@ components: section. - Client received this resource and replied with ACK. - Client received this resource and replied with NACK. + - >- + Client received an error from the control plane. The attached + config dump is the most recent accepted one. If no config is + accepted yet, the attached config dump will be empty. + - Client timed out waiting for the resource from the control plane. enum: - UNKNOWN - REQUESTED - DOES_NOT_EXIST - ACKED - NACKED + - RECEIVED_ERROR + - TIMEOUT EndpointsConfigDump: id: EndpointsConfigDump description: >- @@ -1261,12 +1305,19 @@ components: section. - Client received this resource and replied with ACK. - Client received this resource and replied with NACK. + - >- + Client received an error from the control plane. The attached + config dump is the most recent accepted one. If no config is + accepted yet, the attached config dump will be empty. + - Client timed out waiting for the resource from the control plane. enum: - UNKNOWN - REQUESTED - DOES_NOT_EXIST - ACKED - NACKED + - RECEIVED_ERROR + - TIMEOUT GenericXdsConfig: id: GenericXdsConfig description: >- @@ -1341,12 +1392,19 @@ components: section. - Client received this resource and replied with ACK. - Client received this resource and replied with NACK. + - >- + Client received an error from the control plane. The attached + config dump is the most recent accepted one. If no config is + accepted yet, the attached config dump will be empty. + - Client timed out waiting for the resource from the control plane. enum: - UNKNOWN - REQUESTED - DOES_NOT_EXIST - ACKED - NACKED + - RECEIVED_ERROR + - TIMEOUT errorState: description: >- Set if the last update failed, cleared after the next successful diff --git a/providers/src/googleapis.com/v00.00.00000/services/transcoder.yaml b/providers/src/googleapis.com/v00.00.00000/services/transcoder.yaml index 9668841d..4a74f98c 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/transcoder.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/transcoder.yaml @@ -9,8 +9,8 @@ info: This API converts video files into formats suitable for consumer distribution. For more information, see the Transcoder API overview. version: v1 - x-discovery-doc-revision: '20241023' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250813' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/transcoder/docs/ servers: @@ -164,6 +164,11 @@ components: - OPTIMIZATION_STRATEGY_UNSPECIFIED - AUTODETECT - DISABLED + fillContentGaps: + description: >- + Optional. Insert silence and duplicate frames when timestamp gaps + are detected in a given stream. + type: boolean JobConfig: id: JobConfig description: Job configuration @@ -251,6 +256,9 @@ components: preprocessingConfig: description: Preprocessing configurations. $ref: '#/components/schemas/PreprocessingConfig' + attributes: + description: Optional. Input Attributes. + $ref: '#/components/schemas/InputAttributes' PreprocessingConfig: id: PreprocessingConfig description: Preprocessing configurations. @@ -474,6 +482,54 @@ components: Deinterlace all frames rather than just the frames identified as interlaced. The default is `false`. type: boolean + InputAttributes: + id: InputAttributes + description: >- + Input attributes that provide additional information about the input + asset. + type: object + properties: + trackDefinitions: + description: Optional. A list of track definitions for the input asset. + type: array + items: + $ref: '#/components/schemas/TrackDefinition' + TrackDefinition: + id: TrackDefinition + description: Track definition for the input asset. + type: object + properties: + inputTrack: + description: The input track. + type: integer + format: int32 + languages: + description: >- + Optional. A list of languages spoken in the input asset, represented + by a BCP 47 language code, such as "en-US" or "sr-Latn". For more + information, see + https://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + type: array + items: + type: string + detectLanguages: + description: >- + Optional. Whether to automatically detect the languages present in + the track. If true, the system will attempt to identify all the + languages present in the track and populate the languages field. + type: boolean + detectedLanguages: + description: >- + Output only. A list of languages detected in the input asset, + represented by a BCP 47 language code, such as "en-US" or "sr-Latn". + For more information, see + https://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + This field is only populated if the detect_languages field is set to + true. + readOnly: true + type: array + items: + type: string EditAtom: id: EditAtom description: Edit atom. @@ -1200,9 +1256,10 @@ components: type: string container: description: >- - The container format. The default is `mp4` Supported container + The container format. The default is `mp4` Supported streaming formats: - `ts` - `fmp4`- the corresponding file extension is `.m4s` - - `mp4` - `vtt` - `ogg` See also: [Supported input and output + Supported standalone file formats: - `mp4` - `mp3` - `ogg` - `vtt` + See also: [Supported input and output formats](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats) type: string elementaryStreams: diff --git a/providers/src/googleapis.com/v00.00.00000/services/translate.yaml b/providers/src/googleapis.com/v00.00.00000/services/translate.yaml index 608095a4..878137b3 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/translate.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/translate.yaml @@ -7,8 +7,8 @@ info: title: Cloud Translation API description: Integrates text translation into your website or application. version: v3 - x-discovery-doc-revision: '20241029' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250424' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/translate/docs/quickstarts servers: @@ -293,6 +293,11 @@ components: Optional. Indicates match is case insensitive. The default value is `false` if missing. type: boolean + contextualTranslationEnabled: + description: >- + Optional. If set to true, the glossary will be used for contextual + translation. + type: boolean TransliterationConfig: id: TransliterationConfig description: Configures transliteration feature on top of translation. @@ -1410,6 +1415,11 @@ components: Optional. Indicates match is case insensitive. The default value is `false` if missing. type: boolean + contextualTranslationEnabled: + description: >- + Optional. If set to true, the glossary will be used for contextual + translation. + type: boolean AdaptiveMtTranslateResponse: id: AdaptiveMtTranslateResponse description: An AdaptiveMtTranslate response. @@ -2566,6 +2576,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v3/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: @@ -3047,7 +3061,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: translate.projects.locations.operations.cancel requestBody: content: diff --git a/providers/src/googleapis.com/v00.00.00000/services/videointelligence.yaml b/providers/src/googleapis.com/v00.00.00000/services/videointelligence.yaml index 7fbac502..98ada7a5 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/videointelligence.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/videointelligence.yaml @@ -10,8 +10,8 @@ info: specifies the region for annotation and transcribes speech to text. Supports both asynchronous API and streaming API. version: v1 - x-discovery-doc-revision: '20240719' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250724' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/video-intelligence/docs/ servers: @@ -936,7 +936,7 @@ components: point: description: >- The 2D point of the detected landmark using the normalized image - coordindate system. The normalized coordinates have the range from 0 + coordinate system. The normalized coordinates have the range from 0 to 1. $ref: >- #/components/schemas/GoogleCloudVideointelligenceV1beta2_NormalizedVertex @@ -1170,7 +1170,7 @@ components: the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note - that values can be less than 0, or greater than 1 due to trignometric + that values can be less than 0, or greater than 1 due to trigonometric calculations for location of the box. type: object properties: @@ -1352,6 +1352,33 @@ components: more than one segment. $ref: >- #/components/schemas/GoogleCloudVideointelligenceV1beta2_VideoSegment + exportStatus: + description: >- + Status of exporting annotation response to user specified + `output_uri`. Only set if `output_uri` is set in the request. + $ref: >- + #/components/schemas/GoogleCloudVideointelligenceV1beta2_ExportToOutputUriStatus + GoogleCloudVideointelligenceV1beta2_ExportToOutputUriStatus: + id: GoogleCloudVideointelligenceV1beta2_ExportToOutputUriStatus + description: Status of exporting annotation response to user specified `output_uri`. + type: object + properties: + state: + description: Output only. State of the `output_uri` export. + readOnly: true + type: string + enumDescriptions: + - Default value. + - Export succeeded. + - Export failed. + enum: + - STATE_UNSPECIFIED + - SUCCEEDED + - FAILED + status: + description: Output only. Only set if state is FAILED. + readOnly: true + $ref: '#/components/schemas/GoogleRpc_Status' GoogleCloudVideointelligenceV1_AnnotateVideoResponse: id: GoogleCloudVideointelligenceV1_AnnotateVideoResponse description: >- @@ -1737,7 +1764,7 @@ components: point: description: >- The 2D point of the detected landmark using the normalized image - coordindate system. The normalized coordinates have the range from 0 + coordinate system. The normalized coordinates have the range from 0 to 1. $ref: '#/components/schemas/GoogleCloudVideointelligenceV1_NormalizedVertex' confidence: @@ -1968,7 +1995,7 @@ components: the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note - that values can be less than 0, or greater than 1 due to trignometric + that values can be less than 0, or greater than 1 due to trigonometric calculations for location of the box. type: object properties: @@ -2147,6 +2174,33 @@ components: Specifies which segment is being tracked if the request contains more than one segment. $ref: '#/components/schemas/GoogleCloudVideointelligenceV1_VideoSegment' + exportStatus: + description: >- + Status of exporting annotation response to user specified + `output_uri`. Only set if `output_uri` is set in the request. + $ref: >- + #/components/schemas/GoogleCloudVideointelligenceV1_ExportToOutputUriStatus + GoogleCloudVideointelligenceV1_ExportToOutputUriStatus: + id: GoogleCloudVideointelligenceV1_ExportToOutputUriStatus + description: Status of exporting annotation response to user specified `output_uri`. + type: object + properties: + state: + description: Output only. State of the `output_uri` export. + readOnly: true + type: string + enumDescriptions: + - Default value. + - Export succeeded. + - Export failed. + enum: + - STATE_UNSPECIFIED + - SUCCEEDED + - FAILED + status: + description: Output only. Only set if state is FAILED. + readOnly: true + $ref: '#/components/schemas/GoogleRpc_Status' GoogleCloudVideointelligenceV1p1beta1_AnnotateVideoResponse: id: GoogleCloudVideointelligenceV1p1beta1_AnnotateVideoResponse description: >- @@ -2560,7 +2614,7 @@ components: point: description: >- The 2D point of the detected landmark using the normalized image - coordindate system. The normalized coordinates have the range from 0 + coordinate system. The normalized coordinates have the range from 0 to 1. $ref: >- #/components/schemas/GoogleCloudVideointelligenceV1p1beta1_NormalizedVertex @@ -2796,7 +2850,7 @@ components: the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note - that values can be less than 0, or greater than 1 due to trignometric + that values can be less than 0, or greater than 1 due to trigonometric calculations for location of the box. type: object properties: @@ -2978,6 +3032,33 @@ components: more than one segment. $ref: >- #/components/schemas/GoogleCloudVideointelligenceV1p1beta1_VideoSegment + exportStatus: + description: >- + Status of exporting annotation response to user specified + `output_uri`. Only set if `output_uri` is set in the request. + $ref: >- + #/components/schemas/GoogleCloudVideointelligenceV1p1beta1_ExportToOutputUriStatus + GoogleCloudVideointelligenceV1p1beta1_ExportToOutputUriStatus: + id: GoogleCloudVideointelligenceV1p1beta1_ExportToOutputUriStatus + description: Status of exporting annotation response to user specified `output_uri`. + type: object + properties: + state: + description: Output only. State of the `output_uri` export. + readOnly: true + type: string + enumDescriptions: + - Default value. + - Export succeeded. + - Export failed. + enum: + - STATE_UNSPECIFIED + - SUCCEEDED + - FAILED + status: + description: Output only. Only set if state is FAILED. + readOnly: true + $ref: '#/components/schemas/GoogleRpc_Status' GoogleCloudVideointelligenceV1p2beta1_AnnotateVideoResponse: id: GoogleCloudVideointelligenceV1p2beta1_AnnotateVideoResponse description: >- @@ -3391,7 +3472,7 @@ components: point: description: >- The 2D point of the detected landmark using the normalized image - coordindate system. The normalized coordinates have the range from 0 + coordinate system. The normalized coordinates have the range from 0 to 1. $ref: >- #/components/schemas/GoogleCloudVideointelligenceV1p2beta1_NormalizedVertex @@ -3627,7 +3708,7 @@ components: the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note - that values can be less than 0, or greater than 1 due to trignometric + that values can be less than 0, or greater than 1 due to trigonometric calculations for location of the box. type: object properties: @@ -3809,6 +3890,33 @@ components: more than one segment. $ref: >- #/components/schemas/GoogleCloudVideointelligenceV1p2beta1_VideoSegment + exportStatus: + description: >- + Status of exporting annotation response to user specified + `output_uri`. Only set if `output_uri` is set in the request. + $ref: >- + #/components/schemas/GoogleCloudVideointelligenceV1p2beta1_ExportToOutputUriStatus + GoogleCloudVideointelligenceV1p2beta1_ExportToOutputUriStatus: + id: GoogleCloudVideointelligenceV1p2beta1_ExportToOutputUriStatus + description: Status of exporting annotation response to user specified `output_uri`. + type: object + properties: + state: + description: Output only. State of the `output_uri` export. + readOnly: true + type: string + enumDescriptions: + - Default value. + - Export succeeded. + - Export failed. + enum: + - STATE_UNSPECIFIED + - SUCCEEDED + - FAILED + status: + description: Output only. Only set if state is FAILED. + readOnly: true + $ref: '#/components/schemas/GoogleRpc_Status' GoogleCloudVideointelligenceV1p3beta1_AnnotateVideoResponse: id: GoogleCloudVideointelligenceV1p3beta1_AnnotateVideoResponse description: >- @@ -4226,7 +4334,7 @@ components: point: description: >- The 2D point of the detected landmark using the normalized image - coordindate system. The normalized coordinates have the range from 0 + coordinate system. The normalized coordinates have the range from 0 to 1. $ref: >- #/components/schemas/GoogleCloudVideointelligenceV1p3beta1_NormalizedVertex @@ -4462,7 +4570,7 @@ components: the text is horizontal it might look like: 0----1 | | 3----2 When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3). Note - that values can be less than 0, or greater than 1 due to trignometric + that values can be less than 0, or greater than 1 due to trigonometric calculations for location of the box. type: object properties: @@ -4711,6 +4819,33 @@ components: more than one segment. $ref: >- #/components/schemas/GoogleCloudVideointelligenceV1p3beta1_VideoSegment + exportStatus: + description: >- + Status of exporting annotation response to user specified + `output_uri`. Only set if `output_uri` is set in the request. + $ref: >- + #/components/schemas/GoogleCloudVideointelligenceV1p3beta1_ExportToOutputUriStatus + GoogleCloudVideointelligenceV1p3beta1_ExportToOutputUriStatus: + id: GoogleCloudVideointelligenceV1p3beta1_ExportToOutputUriStatus + description: Status of exporting annotation response to user specified `output_uri`. + type: object + properties: + state: + description: Output only. State of the `output_uri` export. + readOnly: true + type: string + enumDescriptions: + - Default value. + - Export succeeded. + - Export failed. + enum: + - STATE_UNSPECIFIED + - SUCCEEDED + - FAILED + status: + description: Output only. Only set if state is FAILED. + readOnly: true + $ref: '#/components/schemas/GoogleRpc_Status' GoogleCloudVideointelligenceV1p3beta1_StreamingAnnotateVideoResponse: id: GoogleCloudVideointelligenceV1p3beta1_StreamingAnnotateVideoResponse description: >- @@ -5090,7 +5225,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: videointelligence.projects.locations.operations.cancel requestBody: content: @@ -5208,7 +5343,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: videointelligence.operations.projects.locations.operations.cancel security: - Oauth2: diff --git a/providers/src/googleapis.com/v00.00.00000/services/vision.yaml b/providers/src/googleapis.com/v00.00.00000/services/vision.yaml index e202b344..598d2a27 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/vision.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/vision.yaml @@ -10,8 +10,8 @@ info: landmark detection, optical character recognition (OCR), and detection of explicit content, into applications. version: v1 - x-discovery-doc-revision: '20241025' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250815' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/vision/ servers: @@ -653,7 +653,7 @@ components: Model to use for the feature. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". `DOCUMENT_TEXT_DETECTION` and `TEXT_DETECTION` also support - "builtin/weekly" for the bleeding edge release updated weekly. + "builtin/rc" for the latest release candidate. type: string ImageContext: id: ImageContext @@ -8696,7 +8696,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: vision.operations.cancel requestBody: content: diff --git a/providers/src/googleapis.com/v00.00.00000/services/vmmigration.yaml b/providers/src/googleapis.com/v00.00.00000/services/vmmigration.yaml index 2652bb3a..1d10ac19 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/vmmigration.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/vmmigration.yaml @@ -9,8 +9,8 @@ info: Use the Migrate to Virtual Machines API to programmatically migrate workloads. version: v1 - x-discovery-doc-revision: '20241024' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250817' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/migrate/virtual-machines servers: @@ -581,7 +581,7 @@ components: - SUSPENDED - PENDING cpuCount: - description: The number of cpus the VM has. + description: The number of CPU cores the VM has. type: integer format: int32 memoryMb: @@ -655,6 +655,12 @@ components: - X86_64 - ARM64 - X86_64_MAC + vcpuCount: + description: >- + The number of vCPUs the VM has. It is calculated as the number of + CPU cores * threads per CPU the VM has. + type: integer + format: int32 AwsSecurityGroup: id: AwsSecurityGroup description: AwsSecurityGroup describes a security group of an AWS VM. @@ -1110,7 +1116,7 @@ components: $ref: '#/components/schemas/UpgradeStatus' AvailableUpdates: id: AvailableUpdates - description: Holds informatiom about the available versions for upgrade. + description: Holds information about the available versions for upgrade. type: object properties: newDeployableAppliance: @@ -1290,6 +1296,13 @@ components: - >- The replication process encountered an unrecoverable error and was aborted. + - >- + The migrating VM has passed its expiration date. It might be + possible to bring it back to "Active" state by updating the TTL + field. For more information, see the documentation. + - >- + The migrating VM's has been finalized and migration resources have + been removed. enum: - STATE_UNSPECIFIED - PENDING @@ -1303,6 +1316,8 @@ components: - FINALIZING - FINALIZED - ERROR + - EXPIRED + - FINALIZED_EXPIRED stateTime: description: Output only. The last time the migrating VM state was updated. readOnly: true @@ -1366,6 +1381,12 @@ components: MigratingVm. Set to empty when cutover forecast is unavailable. readOnly: true $ref: '#/components/schemas/CutoverForecast' + expiration: + description: >- + Output only. Provides details about the expiration state of the + migrating VM. + readOnly: true + $ref: '#/components/schemas/Expiration' ComputeEngineTargetDefaults: id: ComputeEngineTargetDefaults description: >- @@ -1401,7 +1422,7 @@ components: items: $ref: '#/components/schemas/NetworkInterface' serviceAccount: - description: The service account to associate the VM with. + description: Optional. The service account to associate the VM with. type: string diskType: description: The disk type to use in the VM. @@ -1504,13 +1525,26 @@ components: - BOOT_CONVERSION_UNSPECIFIED - NONE - BIOS_TO_EFI + diskReplicaZones: + description: >- + Optional. Additional replica zones of the target regional disks. If + this list is not empty a regional disk will be created. The first + supported zone would be the one stated in the zone field. The rest + are taken from this list. Please refer to the [regional disk + creation + API](https://cloud.google.com/compute/docs/regions-zones/global-regional-zonal-resources) + for further details about regional vs zonal disks. If not specified, + a zonal disk will be created in the same zone the VM is created. + type: array + items: + type: string NetworkInterface: id: NetworkInterface description: NetworkInterface represents a NIC of a VM. type: object properties: network: - description: The network to connect the NIC to. + description: Optional. The network to connect the NIC to. type: string subnetwork: description: Optional. The subnetwork to connect the NIC to. @@ -1942,10 +1976,12 @@ components: - This is for API compatibility only and is not in use. - NVMe driver installed and the VM can use NVMe PD or local SSD. - gVNIC virtual NIC driver supported. + - IDPF virtual NIC driver supported. enum: - OS_CAPABILITY_UNSPECIFIED - OS_CAPABILITY_NVME_STORAGE_ACCESS - OS_CAPABILITY_GVNIC_NETWORK_INTERFACE + - OS_CAPABILITY_IDPF_NETWORK_INTERFACE lastOsCapabilitiesUpdateTime: description: Output only. The last time OS capabilities list was updated. readOnly: true @@ -2512,6 +2548,19 @@ components: - BOOT_CONVERSION_UNSPECIFIED - NONE - BIOS_TO_EFI + diskReplicaZones: + description: >- + Optional. Additional replica zones of the target regional disks. If + this list is not empty a regional disk will be created. The first + supported zone would be the one stated in the zone field. The rest + are taken from this list. Please refer to the [regional disk + creation + API](https://cloud.google.com/compute/docs/regions-zones/global-regional-zonal-resources) + for further details about regional vs zonal disks. If not specified, + a zonal disk will be created in the same zone the VM is created. + type: array + items: + type: string ComputeEngineDisksTargetDetails: id: ComputeEngineDisksTargetDetails description: >- @@ -2598,7 +2647,7 @@ components: description: >- CutoverJob message describes a cutover of a migrating VM. The CutoverJob is the operation of shutting down the VM, creating a snapshot and - clonning the VM using the replicated snapshot. + cloning the VM using the replicated snapshot. type: object properties: computeEngineTargetDetails: @@ -2726,6 +2775,25 @@ components: readOnly: true type: string format: google-duration + Expiration: + id: Expiration + description: Expiration holds information about the expiration of a MigratingVm. + type: object + properties: + expireTime: + description: Output only. Timestamp of when this resource is considered expired. + readOnly: true + type: string + format: google-datetime + extensionCount: + description: Output only. The number of times expiration was extended. + readOnly: true + type: integer + format: int32 + extendable: + description: Output only. Describes whether the expiration can be extended. + readOnly: true + type: boolean ListMigratingVmsResponse: id: ListMigratingVmsResponse description: Response message for 'ListMigratingVms' request. @@ -2770,6 +2838,11 @@ components: description: Request message for 'FinalizeMigration' request. type: object properties: {} + ExtendMigrationRequest: + id: ExtendMigrationRequest + description: Request message for 'ExtendMigrationRequest' request. + type: object + properties: {} CancelCloneJobRequest: id: CancelCloneJobRequest description: Request message for 'CancelCloneJob' request. @@ -3137,6 +3210,21 @@ components: - COMPUTE_ENGINE_LICENSE_TYPE_DEFAULT - COMPUTE_ENGINE_LICENSE_TYPE_PAYG - COMPUTE_ENGINE_LICENSE_TYPE_BYOL + bootConversion: + description: >- + Optional. By default the image will keep its existing boot option. + Setting this property will trigger an internal process which will + convert the image from using the existing boot option to another. + The size of the boot disk might be increased to allow the conversion + type: string + enumDescriptions: + - Unspecified conversion type. + - No conversion. + - Convert from BIOS to EFI. + enum: + - BOOT_CONVERSION_UNSPECIFIED + - NONE + - BIOS_TO_EFI DataDiskImageImport: id: DataDiskImageImport description: Mentions that the image import is not using OS adaptation process. @@ -3176,7 +3264,10 @@ components: multi-region is selected. type: boolean encryption: - description: Immutable. The encryption to apply to the machine image. + description: >- + Immutable. The encryption to apply to the machine image. If the + Image Import resource has an encryption, this field must be set to + the same encryption key. $ref: '#/components/schemas/Encryption' machineImageParametersOverrides: description: >- @@ -3218,8 +3309,8 @@ components: networkInterfaces: description: >- Optional. The network interfaces to create with the instance created - by the machine image. Internal and external IP addresses are ignored - for machine image import. + by the machine image. Internal and external IP addresses, and + network tiers are ignored for machine image import. type: array items: $ref: '#/components/schemas/NetworkInterface' @@ -4005,6 +4096,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + extend_migration: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sources~1{sourcesId}~1migratingVms~1{migratingVmsId}:extendMigration/post + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/migrating_vms/methods/get' @@ -4390,6 +4488,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: @@ -4544,7 +4646,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: vmmigration.projects.locations.operations.cancel requestBody: content: @@ -5634,6 +5736,49 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/migratingVms/{migratingVmsId}:extendMigration: + parameters: *ref_1 + post: + description: Extend the migrating VM time to live. + operationId: vmmigration.projects.locations.sources.migratingVms.extendMigration + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExtendMigrationRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: sourcesId + required: true + schema: + type: string + - in: path + name: migratingVmsId + required: true + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/migratingVms/{migratingVmsId}/cloneJobs: parameters: *ref_1 post: diff --git a/providers/src/googleapis.com/v00.00.00000/services/vmwareengine.yaml b/providers/src/googleapis.com/v00.00.00000/services/vmwareengine.yaml index 0bde83fa..b6b551d9 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/vmwareengine.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/vmwareengine.yaml @@ -9,8 +9,8 @@ info: The Google VMware Engine API lets you programmatically manage VMware environments. version: v1 - x-discovery-doc-revision: '20241009' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250811' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/solutions/vmware-as-a-service servers: @@ -465,6 +465,25 @@ components: fqdn: description: Fully qualified domain name of the appliance. type: string + AcceleratePrivateCloudDeletionRequest: + id: AcceleratePrivateCloudDeletionRequest + description: Request message for VmwareEngine.AcceleratePrivateCloudDeletion + type: object + properties: + requestId: + description: >- + Optional. The request ID must be a valid UUID with the exception + that zero UUID is not supported + (00000000-0000-0000-0000-000000000000). + type: string + etag: + description: >- + Optional. Checksum used to ensure that the user-provided value is up + to date before the server processes the request. The server compares + provided checksum with the current checksum of the resource. If the + user-provided value is out of date, this request returns an + `ABORTED` error. + type: string UndeletePrivateCloudRequest: id: UndeletePrivateCloudRequest description: Request message for VmwareEngine.UndeletePrivateCloud @@ -1510,6 +1529,9 @@ components: - >- Peering connection used for connecting to Google Cloud NetApp Volumes. + - >- + Peering connection used for connecting to Google Cloud Filestore + Instances. enum: - PEER_NETWORK_TYPE_UNSPECIFIED - STANDARD @@ -1519,6 +1541,7 @@ components: - THIRD_PARTY_SERVICE - DELL_POWERSCALE - GOOGLE_CLOUD_NETAPP_VOLUMES + - GOOGLE_CLOUD_FILESTORE_INSTANCES uid: description: Output only. System-generated unique identifier for the resource. readOnly: true @@ -2328,6 +2351,552 @@ components: request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). type: string + ListAnnouncementsResponse: + id: ListAnnouncementsResponse + description: Response message for VmwareEngine.ListAnnouncements + type: object + properties: + announcements: + description: A list of announcement runs. + type: array + items: + $ref: '#/components/schemas/Announcement' + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + unreachable: + description: list of unreachable locations + type: array + items: + type: string + Announcement: + id: Announcement + description: Announcement for the resources of Vmware Engine. + type: object + properties: + name: + description: >- + Output only. The resource name of the announcement. Resource names + are schemeless URIs that follow the conventions in + https://cloud.google.com/apis/design/resource_names. For example: + `projects/my-project/locations/us-west1-a/announcements/my-announcement-id` + readOnly: true + type: string + createTime: + description: >- + Output only. Creation time of this resource. It also serves as start + time of notification. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. Last update time of this resource. + readOnly: true + type: string + format: google-datetime + code: + description: >- + Required. Code of the announcement. Indicates the presence of a + VMware Engine related announcement and corresponds to a related + message in the `description` field. + type: string + description: + description: Output only. Description of the announcement. + readOnly: true + type: string + state: + description: >- + Output only. State of the resource. New values may be added to this + enum when appropriate. + readOnly: true + type: string + enumDescriptions: + - The default value. This value should never be used. + - Active announcement which should be visible to user. + - Inactive announcement which should not be visible to user. + - Announcement which is being deleted + - Announcement which being created + enum: + - STATE_UNSPECIFIED + - ACTIVE + - INACTIVE + - DELETING + - CREATING + privateCloud: + description: A Private Cloud resource name. + type: string + cluster: + description: A Cluster resource name. + type: string + targetResourceType: + description: >- + Output only. Target Resource Type defines the type of the target for + the announcement + readOnly: true + type: string + metadata: + description: Output only. Additional structured details about this announcement. + readOnly: true + type: object + additionalProperties: + type: string + activityType: + description: >- + Optional. Activity type of the announcement There can be only one + active announcement for a given activity type and target resource. + type: string + ListUpgradesResponse: + id: ListUpgradesResponse + description: Response message for VmwareEngine.ListUpgrades. + type: object + properties: + upgrades: + description: A list of `Upgrades`. + type: array + items: + $ref: '#/components/schemas/Upgrade' + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + unreachable: + description: List of unreachable resources. + type: array + items: + type: string + Upgrade: + id: Upgrade + description: Describes Private cloud Upgrade. + type: object + properties: + name: + description: >- + Output only. Identifier. The resource name of the private cloud + `Upgrade`. Resource names are schemeless URIs that follow the + conventions in https://cloud.google.com/apis/design/resource_names. + For example: + `projects/my-project/locations/us-west1-a/privateClouds/my-cloud/upgrades/my-upgrade` + readOnly: true + type: string + createTime: + description: Output only. Output Only. Creation time of this resource. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. Output Only. Last update time of this resource. + readOnly: true + type: string + format: google-datetime + endTime: + description: Output only. Output Only. End time of the upgrade. + readOnly: true + type: string + format: google-datetime + state: + description: Output only. The current state of the upgrade. + readOnly: true + type: string + enumDescriptions: + - The default value. This value should never be used. + - The upgrade is scheduled but not started yet. + - The upgrade is currently in progress and has not completed yet. + - The upgrade completed successfully. + - The upgrade is currently paused. + - The upgrade failed. + - The upgrade is in process of being canceled. + - The upgrade is canceled. + - The upgrade is in process of being rescheduled. + enum: + - STATE_UNSPECIFIED + - SCHEDULED + - ONGOING + - SUCCEEDED + - PAUSED + - FAILED + - CANCELLING + - CANCELLED + - RESCHEDULING + type: + description: Output only. Output Only. The type of upgrade. + readOnly: true + type: string + enumDescriptions: + - The default value. This value should never be used. + - >- + Upgrade of vmware components when a major version is available. + 7.0u2 -> 7.0u3. + - >- + Patching of vmware components when a minor version is available. + 7.0u2c -> 7.0u2d. + - >- + Workarounds are hotfixes for vulnerabilities or issues applied to + mitigate the known vulnerability or issue until a patch or update + is released. The description of the upgrade will have more + details. + - Firmware upgrade for VMware product used in the private cloud. + - Switch upgrade. + - The upgrade type that doesn't fall into any other category. + - Infrastructure upgrade in BM node maintenance. + enum: + - TYPE_UNSPECIFIED + - VSPHERE_UPGRADE + - VSPHERE_PATCH + - WORKAROUND + - FIRMWARE_UPGRADE + - SWITCH_UPGRADE + - OTHER + - INFRASTRUCTURE_UPGRADE + description: + description: >- + Output only. Output Only. The description of the upgrade. This is + used to provide additional information about the private cloud + upgrade, such as the upgrade's purpose, the changes included in the + upgrade, or any other relevant information about the upgrade. + readOnly: true + type: string + estimatedDuration: + description: >- + Output only. Output Only. The estimated total duration of the + upgrade. This information can be used to plan or schedule upgrades + to minimize disruptions. Please note that the estimated duration is + only an estimate. The actual upgrade duration may vary. + readOnly: true + type: string + format: google-duration + schedule: + description: Schedule details for the upgrade. + $ref: '#/components/schemas/Schedule' + version: + description: 'Output only. ' + readOnly: true + type: string + etag: + description: >- + The etag for the upgrade resource. If this is provided on update, it + must match the server's etag. + type: string + uid: + description: Output only. System-generated unique identifier for the resource. + readOnly: true + type: string + componentUpgrades: + description: Output only. Output Only. The list of component upgrades. + readOnly: true + type: array + items: + $ref: '#/components/schemas/VmwareUpgradeComponent' + startVersion: + description: Output only. Output Only. The start version + readOnly: true + type: string + targetVersion: + description: Output only. Output Only. The target version + readOnly: true + type: string + Schedule: + id: Schedule + description: Schedule for the upgrade. + type: object + properties: + startTime: + description: Required. The scheduled start time for the upgrade. + type: string + format: google-datetime + weeklyWindows: + description: >- + Required. Weekly time windows for upgrade activities. The server + performs upgrade activities during these time windows to minimize + disruptions. + type: array + items: + $ref: '#/components/schemas/TimeWindow' + constraints: + description: >- + Output only. Output Only. Constraints applied to the schedule. These + constraints should be applicable at the time of any rescheduling. + readOnly: true + $ref: '#/components/schemas/Constraints' + editWindow: + description: >- + Output only. Output Only. The schedule is open for edits during this + time interval or window. + readOnly: true + $ref: '#/components/schemas/Interval' + lastEditor: + description: >- + Output only. Output Only. Indicates who most recently edited the + upgrade schedule. The value is updated whenever the upgrade is + rescheduled. + readOnly: true + type: string + enumDescriptions: + - The default value. This value should never be used. + - The upgrade is scheduled by the System or internal service. + - The upgrade is scheduled by the end user. + enum: + - EDITOR_UNSPECIFIED + - SYSTEM + - USER + TimeWindow: + id: TimeWindow + description: Represents the time window to perform upgrade activities. + type: object + properties: + dayOfWeek: + description: Required. Day of the week for this window. + type: string + enumDescriptions: + - The day of the week is unspecified. + - Monday + - Tuesday + - Wednesday + - Thursday + - Friday + - Saturday + - Sunday + enum: + - DAY_OF_WEEK_UNSPECIFIED + - MONDAY + - TUESDAY + - WEDNESDAY + - THURSDAY + - FRIDAY + - SATURDAY + - SUNDAY + startTime: + description: Required. Time in UTC when the window starts. + $ref: '#/components/schemas/TimeOfDay' + duration: + description: >- + Required. The duration of the window. The max allowed duration for + any window is 24 hours. + type: string + format: google-duration + TimeOfDay: + id: TimeOfDay + description: >- + Represents a time of day. The date and time zone are either not + significant or are specified elsewhere. An API may choose to allow leap + seconds. Related types are google.type.Date and + `google.protobuf.Timestamp`. + type: object + properties: + hours: + description: >- + Hours of a day in 24 hour format. Must be greater than or equal to 0 + and typically must be less than or equal to 23. An API may choose to + allow the value "24:00:00" for scenarios like business closing time. + type: integer + format: int32 + minutes: + description: >- + Minutes of an hour. Must be greater than or equal to 0 and less than + or equal to 59. + type: integer + format: int32 + seconds: + description: >- + Seconds of a minute. Must be greater than or equal to 0 and + typically must be less than or equal to 59. An API may allow the + value 60 if it allows leap-seconds. + type: integer + format: int32 + nanos: + description: >- + Fractions of seconds, in nanoseconds. Must be greater than or equal + to 0 and less than or equal to 999,999,999. + type: integer + format: int32 + Constraints: + id: Constraints + description: >- + Constraints to be applied while editing a schedule. These constraints + ensure that `Upgrade` specific requirements are met. + type: object + properties: + minHoursDay: + description: >- + Output only. Minimum number of hours must be allotted for the + upgrade activities for each selected day. This is a minimum; the + upgrade schedule can allot more hours for the given day. + readOnly: true + type: integer + format: int32 + minHoursWeek: + description: >- + Output only. The minimum number of weekly hours must be allotted for + the upgrade activities. This is just a minimum; the schedule can + assign more weekly hours. + readOnly: true + type: integer + format: int32 + rescheduleDateRange: + description: >- + Output only. Output Only. The user can only reschedule an upgrade + that starts within this range. + readOnly: true + $ref: '#/components/schemas/Interval' + disallowedIntervals: + description: >- + Output only. Output Only. A list of intervals in which maintenance + windows are not allowed. Any time window that overlaps with any of + these intervals will be considered invalid. + readOnly: true + type: array + items: + $ref: '#/components/schemas/WeeklyTimeInterval' + Interval: + id: Interval + description: >- + Represents a time interval, encoded as a Timestamp start (inclusive) and + a Timestamp end (exclusive). The start must be less than or equal to the + end. When the start equals the end, the interval is empty (matches no + time). When both start and end are unspecified, the interval matches any + time. + type: object + properties: + startTime: + description: >- + Optional. Inclusive start of the interval. If specified, a Timestamp + matching this interval will have to be the same or after the start. + type: string + format: google-datetime + endTime: + description: >- + Optional. Exclusive end of the interval. If specified, a Timestamp + matching this interval will have to be before the end. + type: string + format: google-datetime + WeeklyTimeInterval: + id: WeeklyTimeInterval + description: >- + Represents a time interval, spanning across days of the week. Until + local timezones are supported, this interval is in UTC. + type: object + properties: + startDay: + description: Output only. The day on which the interval starts. + readOnly: true + type: string + enumDescriptions: + - The day of the week is unspecified. + - Monday + - Tuesday + - Wednesday + - Thursday + - Friday + - Saturday + - Sunday + enum: + - DAY_OF_WEEK_UNSPECIFIED + - MONDAY + - TUESDAY + - WEDNESDAY + - THURSDAY + - FRIDAY + - SATURDAY + - SUNDAY + startTime: + description: Output only. The time on the start day at which the interval starts. + readOnly: true + $ref: '#/components/schemas/TimeOfDay' + endDay: + description: >- + Output only. The day on which the interval ends. Can be same as + start day. + readOnly: true + type: string + enumDescriptions: + - The day of the week is unspecified. + - Monday + - Tuesday + - Wednesday + - Thursday + - Friday + - Saturday + - Sunday + enum: + - DAY_OF_WEEK_UNSPECIFIED + - MONDAY + - TUESDAY + - WEDNESDAY + - THURSDAY + - FRIDAY + - SATURDAY + - SUNDAY + endTime: + description: Output only. The time on the end day at which the interval ends. + readOnly: true + $ref: '#/components/schemas/TimeOfDay' + VmwareUpgradeComponent: + id: VmwareUpgradeComponent + description: Per component upgrade resource + type: object + properties: + componentType: + description: Output only. Type of component + readOnly: true + type: string + enumDescriptions: + - The default value. This value should never be used. + - vcenter + - esxi nodes + transport nodes + - nsxt upgrade coordinator + - nsxt edges cluster + - nsxt managers/management plane + - hcx + - VSAN cluster + - DVS switch + - Nameserver VMs + - KMS VM used for vsan encryption + - witness VM in case of stretch PC + - nsxt + - Cluster is used in case of BM + enum: + - VMWARE_COMPONENT_TYPE_UNSPECIFIED + - VCENTER + - ESXI + - NSXT_UC + - NSXT_EDGE + - NSXT_MGR + - HCX + - VSAN + - DVS + - NAMESERVER_VM + - KMS_VM + - WITNESS_VM + - NSXT + - CLUSTER + state: + description: Output only. Component's upgrade state. + readOnly: true + type: string + enumDescriptions: + - The default value. This value should never be used. + - Component's upgrade is in progress + - >- + The component's upgrade is paused. Will be resumed when upgrade + job is resumed + - The component's upgrade is successfully completed + - >- + The component's upgrade has failed. This will move to resume if + upgrade is resumed or stay as is + - Component's upgrade has not started yet + - >- + Component's upgrade is not applicable in this upgrade. It will be + skipped. + enum: + - STATE_UNSPECIFIED + - RUNNING + - PAUSED + - SUCCEEDED + - FAILED + - NOT_STARTED + - NOT_APPLICABLE ListLocationsResponse: id: ListLocationsResponse description: The response message for Locations.ListLocations. @@ -2990,6 +3559,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + private_cloud_deletion_now: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1privateClouds~1{privateCloudsId}:privateCloudDeletionNow/post + response: + mediaType: application/json + openAPIDocKey: '200' undelete: operation: $ref: >- @@ -3497,6 +4073,42 @@ components: delete: - $ref: >- #/components/x-stackQL-resources/management_dns_zone_bindings/methods/delete + upgrades: + id: google.vmwareengine.upgrades + name: upgrades + title: Upgrades + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1privateClouds~1{privateCloudsId}~1upgrades/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.upgrades + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1privateClouds~1{privateCloudsId}~1upgrades~1{upgradesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1privateClouds~1{privateCloudsId}~1upgrades~1{upgradesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/upgrades/methods/get' + - $ref: '#/components/x-stackQL-resources/upgrades/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/upgrades/methods/patch' + replace: [] + delete: [] network_policies_external_addresses: id: google.vmwareengine.network_policies_external_addresses name: network_policies_external_addresses @@ -3836,6 +4448,34 @@ components: delete: - $ref: >- #/components/x-stackQL-resources/private_connections/methods/delete + announcements: + id: google.vmwareengine.announcements + name: announcements + title: Announcements + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1announcements/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.announcements + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1announcements~1{announcementsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/announcements/methods/get' + - $ref: '#/components/x-stackQL-resources/announcements/methods/list' + insert: [] + update: [] + replace: [] + delete: [] paths: /v1/projects/{projectsId}/locations/{locationsId}/dnsBindPermission: parameters: &ref_1 @@ -3915,6 +4555,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: @@ -4293,6 +4937,48 @@ paths: schema: type: integer format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}:privateCloudDeletionNow: + parameters: *ref_1 + post: + description: >- + Accelerates the deletion of a private cloud that is currently in soft + deletion A `PrivateCloud` resource in soft deletion has + `PrivateCloud.state` set to `SOFT_DELETED` and `PrivateCloud.expireTime` + set to the time when deletion can no longer be reversed. + operationId: vmwareengine.projects.locations.privateClouds.privateCloudDeletionNow + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AcceleratePrivateCloudDeletionRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: privateCloudsId + required: true + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}:undelete: parameters: *ref_1 post: @@ -6301,6 +6987,148 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/upgrades: + parameters: *ref_1 + get: + description: Lists past, ongoing and upcoming `Upgrades` for the given private cloud. + operationId: vmwareengine.projects.locations.privateClouds.upgrades.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListUpgradesResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: privateCloudsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/upgrades/{upgradesId}: + parameters: *ref_1 + get: + description: Retrieves a private cloud `Upgrade` resource by its resource name. + operationId: vmwareengine.projects.locations.privateClouds.upgrades.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Upgrade' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: privateCloudsId + required: true + schema: + type: string + - in: path + name: upgradesId + required: true + schema: + type: string + patch: + description: >- + Update the private cloud `Upgrade` resource. Only `schedule` field can + updated. The schedule can only be updated when the upgrade has not + started and schedule edit window is open. Only fields specified in + `update_mask` are considered. + operationId: vmwareengine.projects.locations.privateClouds.upgrades.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Upgrade' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: privateCloudsId + required: true + schema: + type: string + - in: path + name: upgradesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: requestId + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/networkPolicies/{networkPoliciesId}:fetchExternalAddresses: parameters: *ref_1 get: @@ -7658,3 +8486,81 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/announcements: + parameters: *ref_1 + get: + description: Lists `Announcements` for a given region and project + operationId: vmwareengine.projects.locations.announcements.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListAnnouncementsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/announcements/{announcementsId}: + parameters: *ref_1 + get: + description: Retrieves a `Announcement` by its resource name. + operationId: vmwareengine.projects.locations.announcements.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Announcement' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: announcementsId + required: true + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/vpcaccess.yaml b/providers/src/googleapis.com/v00.00.00000/services/vpcaccess.yaml index c8b4dbc6..58d4dbed 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/vpcaccess.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/vpcaccess.yaml @@ -7,8 +7,8 @@ info: title: Serverless VPC Access API description: API for managing VPC access connectors. version: v1 - x-discovery-doc-revision: '20241003' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250817' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/vpc/docs/configure-serverless-vpc-access servers: @@ -606,6 +606,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/operations: parameters: *ref_1 get: diff --git a/providers/src/googleapis.com/v00.00.00000/services/webrisk.yaml b/providers/src/googleapis.com/v00.00.00000/services/webrisk.yaml index a8713cf9..4ee4f17f 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/webrisk.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/webrisk.yaml @@ -7,8 +7,8 @@ info: title: Web Risk API description: '' version: v1 - x-discovery-doc-revision: '20241027' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250824' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/web-risk/ servers: @@ -34,135 +34,293 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: + GoogleLongrunningListOperationsResponse: + id: GoogleLongrunningListOperationsResponse + description: The response message for Operations.ListOperations. + type: object + properties: + operations: + description: >- + A list of operations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/GoogleLongrunningOperation' + nextPageToken: + description: The standard List next-page token. + type: string GoogleLongrunningOperation: id: GoogleLongrunningOperation + description: >- + This resource represents a long-running operation that is the result of + a network API call. type: object properties: - response: + name: + description: Matches the `/v1/{project-name}/operations/{operation-id}` pattern. + type: string + metadata: + description: Contains a `SubmitUriMetadata` object. + type: object additionalProperties: type: any description: Properties of the object. Contains field @type with type URL. - type: object - description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. done: - type: boolean description: >- If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. - name: - type: string - description: Matches the `/v1/{project-name}/operations/{operation-id}` pattern. + type: boolean error: description: >- The error result of the operation in case of failure or cancellation. $ref: '#/components/schemas/GoogleRpcStatus' - metadata: + response: + description: >- + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. type: object - description: Contains a `SubmitUriMetadata` object. additionalProperties: - description: Properties of the object. Contains field @type with type URL. type: any + description: Properties of the object. Contains field @type with type URL. + GoogleRpcStatus: + id: GoogleRpcStatus description: >- - This resource represents a long-running operation that is the result of - a network API call. - GoogleCloudWebriskV1ThreatEntryRemovals: + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). type: object - description: Contains the set of entries to remove from a local database. properties: - riceIndices: - $ref: '#/components/schemas/GoogleCloudWebriskV1RiceDeltaEncoding' + code: + description: The status code, which should be an enum value of google.rpc.Code. + type: integer + format: int32 + message: description: >- - The encoded local, lexicographically-sorted list indices, using a - Golomb-Rice encoding. Used for sending compressed removal indices. - The removal indices (uint32) are sorted in ascending order, then - delta encoded and stored as encoded_data. - rawIndices: - description: The raw removal indices for a local list. - $ref: '#/components/schemas/GoogleCloudWebriskV1RawIndices' - id: GoogleCloudWebriskV1ThreatEntryRemovals - GoogleCloudWebriskV1SearchUrisResponse: + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + type: string + details: + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + type: array + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + GoogleProtobufEmpty: + id: GoogleProtobufEmpty + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + type: object + properties: {} + GoogleLongrunningCancelOperationRequest: + id: GoogleLongrunningCancelOperationRequest + description: The request message for Operations.CancelOperation. + type: object + properties: {} + GoogleCloudWebriskV1ComputeThreatListDiffResponse: + id: GoogleCloudWebriskV1ComputeThreatListDiffResponse type: object - id: GoogleCloudWebriskV1SearchUrisResponse properties: - threat: + responseType: description: >- - The threat list matches. This might be empty if the URI is on no - list. - $ref: '#/components/schemas/GoogleCloudWebriskV1SearchUrisResponseThreatUri' - GoogleCloudWebriskV1RiceDeltaEncoding: + The type of response. This may indicate that an action must be taken + by the client when the response is received. + type: string + enumDescriptions: + - Unknown. + - >- + Partial updates are applied to the client's existing local + database. + - >- + Full updates resets the client's entire local database. This means + that either the client had no state, was seriously out-of-date, or + the client is believed to be corrupt. + enum: + - RESPONSE_TYPE_UNSPECIFIED + - DIFF + - RESET + additions: + description: A set of entries to add to a local threat type's list. + $ref: '#/components/schemas/GoogleCloudWebriskV1ThreatEntryAdditions' + removals: + description: >- + A set of entries to remove from a local threat type's list. This + field may be empty. + $ref: '#/components/schemas/GoogleCloudWebriskV1ThreatEntryRemovals' + newVersionToken: + description: >- + The new opaque client version token. This should be retained by the + client and passed into the next call of ComputeThreatListDiff as + 'version_token'. A separate version token should be stored and used + for each threatList. + type: string + format: byte + checksum: + description: >- + The expected SHA256 hash of the client state; that is, of the sorted + list of all hashes present in the database after applying the + provided diff. If the client state doesn't match the expected state, + the client must discard this diff and retry later. + $ref: >- + #/components/schemas/GoogleCloudWebriskV1ComputeThreatListDiffResponseChecksum + recommendedNextDiff: + description: >- + The soonest the client should wait before issuing any diff request. + Querying sooner is unlikely to produce a meaningful diff. Waiting + longer is acceptable considering the use case. If this field is not + set clients may update as soon as they want. + type: string + format: google-datetime + GoogleCloudWebriskV1ThreatEntryAdditions: + id: GoogleCloudWebriskV1ThreatEntryAdditions + description: >- + Contains the set of entries to add to a local database. May contain a + combination of compressed and raw data in a single response. type: object + properties: + rawHashes: + description: >- + The raw SHA256-formatted entries. Repeated to allow returning sets + of hashes with different prefix sizes. + type: array + items: + $ref: '#/components/schemas/GoogleCloudWebriskV1RawHashes' + riceHashes: + description: >- + The encoded 4-byte prefixes of SHA256-formatted entries, using a + Golomb-Rice encoding. The hashes are converted to uint32, sorted in + ascending order, then delta encoded and stored as encoded_data. + $ref: '#/components/schemas/GoogleCloudWebriskV1RiceDeltaEncoding' + GoogleCloudWebriskV1RawHashes: + id: GoogleCloudWebriskV1RawHashes description: >- - The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes - or compressed removal indices. - id: GoogleCloudWebriskV1RiceDeltaEncoding + The uncompressed threat entries in hash format. Hashes can be anywhere + from 4 to 32 bytes in size. A large majority are 4 bytes, but some + hashes are lengthened if they collide with the hash of a popular URI. + Used for sending ThreatEntryAdditons to clients that do not support + compression, or when sending non-4-byte hashes to clients that do + support compression. + type: object properties: - riceParameter: - type: integer + prefixSize: description: >- - The Golomb-Rice parameter, which is a number between 2 and 28. This - field is missing (that is, zero) if `num_entries` is zero. + The number of bytes for each prefix encoded below. This field can be + anywhere from 4 (shortest prefix) to 32 (full SHA256 hash). In + practice this is almost always 4, except in exceptional + circumstances. + type: integer format: int32 + rawHashes: + description: >- + The hashes, in binary format, concatenated into one long string. + Hashes are sorted in lexicographic order. For JSON API users, hashes + are base64-encoded. + type: string + format: byte + GoogleCloudWebriskV1RiceDeltaEncoding: + id: GoogleCloudWebriskV1RiceDeltaEncoding + description: >- + The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes + or compressed removal indices. + type: object + properties: firstValue: description: >- The offset of the first entry in the encoded data, or, if only a single integer was encoded, that single integer's value. If the field is empty or missing, assume zero. - format: int64 type: string - entryCount: + format: int64 + riceParameter: + description: >- + The Golomb-Rice parameter, which is a number between 2 and 28. This + field is missing (that is, zero) if `num_entries` is zero. type: integer format: int32 + entryCount: description: >- The number of entries that are delta encoded in the encoded data. If only a single integer was encoded, this will be zero and the single value will be stored in `first_value`. + type: integer + format: int32 encodedData: - format: byte description: The encoded deltas that are encoded using the Golomb-Rice coder. type: string - GoogleCloudWebriskV1RawHashes: - description: >- - The uncompressed threat entries in hash format. Hashes can be anywhere - from 4 to 32 bytes in size. A large majority are 4 bytes, but some - hashes are lengthened if they collide with the hash of a popular URI. - Used for sending ThreatEntryAdditons to clients that do not support - compression, or when sending non-4-byte hashes to clients that do - support compression. - id: GoogleCloudWebriskV1RawHashes + format: byte + GoogleCloudWebriskV1ThreatEntryRemovals: + id: GoogleCloudWebriskV1ThreatEntryRemovals + description: Contains the set of entries to remove from a local database. + type: object + properties: + rawIndices: + description: The raw removal indices for a local list. + $ref: '#/components/schemas/GoogleCloudWebriskV1RawIndices' + riceIndices: + description: >- + The encoded local, lexicographically-sorted list indices, using a + Golomb-Rice encoding. Used for sending compressed removal indices. + The removal indices (uint32) are sorted in ascending order, then + delta encoded and stored as encoded_data. + $ref: '#/components/schemas/GoogleCloudWebriskV1RiceDeltaEncoding' + GoogleCloudWebriskV1RawIndices: + id: GoogleCloudWebriskV1RawIndices + description: A set of raw indices to remove from a local list. type: object properties: - rawHashes: - format: byte - type: string + indices: + description: The indices to remove from a lexicographically-sorted local list. + type: array + items: + type: integer + format: int32 + GoogleCloudWebriskV1ComputeThreatListDiffResponseChecksum: + id: GoogleCloudWebriskV1ComputeThreatListDiffResponseChecksum + description: The expected state of a client's local database. + type: object + properties: + sha256: description: >- - The hashes, in binary format, concatenated into one long string. - Hashes are sorted in lexicographic order. For JSON API users, hashes - are base64-encoded. - prefixSize: - format: int32 - type: integer + The SHA256 hash of the client state; that is, of the sorted list of + all hashes present in the database. + type: string + format: byte + GoogleCloudWebriskV1SearchUrisResponse: + id: GoogleCloudWebriskV1SearchUrisResponse + type: object + properties: + threat: description: >- - The number of bytes for each prefix encoded below. This field can be - anywhere from 4 (shortest prefix) to 32 (full SHA256 hash). In - practice this is almost always 4, except in exceptional - circumstances. - GoogleCloudWebriskV1SearchHashesResponseThreatHash: - description: Contains threat information on a matching hash. + The threat list matches. This might be empty if the URI is on no + list. + $ref: '#/components/schemas/GoogleCloudWebriskV1SearchUrisResponseThreatUri' + GoogleCloudWebriskV1SearchUrisResponseThreatUri: + id: GoogleCloudWebriskV1SearchUrisResponseThreatUri + description: Contains threat information on a matching uri. + type: object properties: threatTypes: - description: >- - The ThreatList this threat belongs to. This must contain at least - one entry. + description: The ThreatList this threat belongs to. + type: array items: type: string enumDescriptions: @@ -181,213 +339,42 @@ components: - SOCIAL_ENGINEERING - UNWANTED_SOFTWARE - SOCIAL_ENGINEERING_EXTENDED_COVERAGE - type: array expireTime: description: >- The cache lifetime for the returned match. Clients must not cache this response past this timestamp to avoid false positives. - format: google-datetime - type: string - hash: - description: >- - A 32 byte SHA256 hash. This field is in binary format. For JSON - requests, hashes are base64-encoded. - type: string - format: byte - id: GoogleCloudWebriskV1SearchHashesResponseThreatHash - type: object - GoogleRpcStatus: - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - type: object - properties: - details: - items: - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - type: array - code: - description: The status code, which should be an enum value of google.rpc.Code. - format: int32 - type: integer - message: - type: string - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - id: GoogleRpcStatus - GoogleCloudWebriskV1ComputeThreatListDiffResponseChecksum: - description: The expected state of a client's local database. - properties: - sha256: - format: byte - description: >- - The SHA256 hash of the client state; that is, of the sorted list of - all hashes present in the database. type: string - id: GoogleCloudWebriskV1ComputeThreatListDiffResponseChecksum - type: object - GoogleCloudWebriskV1RawIndices: - id: GoogleCloudWebriskV1RawIndices - type: object - properties: - indices: - description: The indices to remove from a lexicographically-sorted local list. - type: array - items: - format: int32 - type: integer - description: A set of raw indices to remove from a local list. - GoogleLongrunningCancelOperationRequest: - description: The request message for Operations.CancelOperation. - id: GoogleLongrunningCancelOperationRequest - type: object - properties: {} - GoogleCloudWebriskV1ThreatEntryAdditions: - id: GoogleCloudWebriskV1ThreatEntryAdditions - type: object - description: >- - Contains the set of entries to add to a local database. May contain a - combination of compressed and raw data in a single response. - properties: - riceHashes: - description: >- - The encoded 4-byte prefixes of SHA256-formatted entries, using a - Golomb-Rice encoding. The hashes are converted to uint32, sorted in - ascending order, then delta encoded and stored as encoded_data. - $ref: '#/components/schemas/GoogleCloudWebriskV1RiceDeltaEncoding' - rawHashes: - items: - $ref: '#/components/schemas/GoogleCloudWebriskV1RawHashes' - type: array - description: >- - The raw SHA256-formatted entries. Repeated to allow returning sets - of hashes with different prefix sizes. + format: google-datetime GoogleCloudWebriskV1SearchHashesResponse: + id: GoogleCloudWebriskV1SearchHashesResponse + type: object properties: threats: description: >- The full hashes that matched the requested prefixes. The hash will be populated in the key. + type: array items: $ref: >- #/components/schemas/GoogleCloudWebriskV1SearchHashesResponseThreatHash - type: array negativeExpireTime: - format: google-datetime - type: string description: >- For requested entities that did not match the threat list, how long to cache the response until. - id: GoogleCloudWebriskV1SearchHashesResponse - type: object - GoogleCloudWebriskV1ComputeThreatListDiffResponse: - properties: - checksum: - $ref: >- - #/components/schemas/GoogleCloudWebriskV1ComputeThreatListDiffResponseChecksum - description: >- - The expected SHA256 hash of the client state; that is, of the sorted - list of all hashes present in the database after applying the - provided diff. If the client state doesn't match the expected state, - the client must discard this diff and retry later. - newVersionToken: - format: byte - description: >- - The new opaque client version token. This should be retained by the - client and passed into the next call of ComputeThreatListDiff as - 'version_token'. A separate version token should be stored and used - for each threatList. type: string - recommendedNextDiff: format: google-datetime - type: string - description: >- - The soonest the client should wait before issuing any diff request. - Querying sooner is unlikely to produce a meaningful diff. Waiting - longer is acceptable considering the use case. If this field is not - set clients may update as soon as they want. - responseType: - type: string - enumDescriptions: - - Unknown. - - >- - Partial updates are applied to the client's existing local - database. - - >- - Full updates resets the client's entire local database. This means - that either the client had no state, was seriously out-of-date, or - the client is believed to be corrupt. - enum: - - RESPONSE_TYPE_UNSPECIFIED - - DIFF - - RESET - description: >- - The type of response. This may indicate that an action must be taken - by the client when the response is received. - additions: - $ref: '#/components/schemas/GoogleCloudWebriskV1ThreatEntryAdditions' - description: A set of entries to add to a local threat type's list. - removals: - $ref: '#/components/schemas/GoogleCloudWebriskV1ThreatEntryRemovals' - description: >- - A set of entries to remove from a local threat type's list. This - field may be empty. - type: object - id: GoogleCloudWebriskV1ComputeThreatListDiffResponse - GoogleProtobufEmpty: - type: object - id: GoogleProtobufEmpty - description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } - properties: {} - GoogleCloudWebriskV1Submission: - properties: - uri: - description: >- - Required. The URI that is being reported for malicious content to be - analyzed. - type: string - id: GoogleCloudWebriskV1Submission - description: Wraps a URI that might be displaying malicious content. - type: object - GoogleLongrunningListOperationsResponse: - description: The response message for Operations.ListOperations. - properties: - operations: - description: >- - A list of operations that matches the specified filter in the - request. - items: - $ref: '#/components/schemas/GoogleLongrunningOperation' - type: array - nextPageToken: - description: The standard List next-page token. - type: string - type: object - id: GoogleLongrunningListOperationsResponse - GoogleCloudWebriskV1SearchUrisResponseThreatUri: + GoogleCloudWebriskV1SearchHashesResponseThreatHash: + id: GoogleCloudWebriskV1SearchHashesResponseThreatHash + description: Contains threat information on a matching hash. type: object properties: threatTypes: + description: >- + The ThreatList this threat belongs to. This must contain at least + one entry. type: array - description: The ThreatList this threat belongs to. items: + type: string enumDescriptions: - >- No entries should match this threat type. This threat type is @@ -404,35 +391,33 @@ components: - SOCIAL_ENGINEERING - UNWANTED_SOFTWARE - SOCIAL_ENGINEERING_EXTENDED_COVERAGE - type: string + hash: + description: >- + A 32 byte SHA256 hash. This field is in binary format. For JSON + requests, hashes are base64-encoded. + type: string + format: byte expireTime: + description: >- + The cache lifetime for the returned match. Clients must not cache + this response past this timestamp to avoid false positives. + type: string format: google-datetime + GoogleCloudWebriskV1Submission: + id: GoogleCloudWebriskV1Submission + description: Wraps a URI that might be displaying malicious content. + type: object + properties: + uri: description: >- - The cache lifetime for the returned match. Clients must not cache - this response past this timestamp to avoid false positives. + Required. The URI that is being reported for malicious content to be + analyzed. type: string - description: Contains threat information on a matching uri. - id: GoogleCloudWebriskV1SearchUrisResponseThreatUri parameters: - _.xgafv: - description: V1 error format. - in: query - name: $.xgafv - schema: - type: string - enum: - - '1' - - '2' - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string - callback: - description: JSONP + access_token: + description: OAuth access token. in: query - name: callback + name: access_token schema: type: string alt: @@ -445,16 +430,16 @@ components: - json - media - proto - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + callback: + description: JSONP in: query - name: uploadType + name: callback schema: type: string - access_token: - description: OAuth access token. + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: access_token + name: fields schema: type: string key: @@ -466,10 +451,10 @@ components: name: key schema: type: string - fields: - description: Selector specifying which fields to include in a partial response. + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: fields + name: oauth_token schema: type: string prettyPrint: @@ -478,12 +463,6 @@ components: name: prettyPrint schema: type: boolean - oauth_token: - description: OAuth 2.0 token for the current user. - in: query - name: oauth_token - schema: - type: string quotaUser: description: >- Available to use for quota purposes for server-side applications. Can be @@ -493,29 +472,40 @@ components: name: quotaUser schema: type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' x-stackQL-resources: - threat_lists: - id: google.webrisk.threat_lists - name: threat_lists - title: Threat_lists - methods: - compute_diff: - operation: - $ref: '#/paths/~1v1~1threatLists:computeDiff/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - replace: [] - delete: [] operations: id: google.webrisk.operations name: operations title: Operations methods: + list: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1operations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.operations get: operation: $ref: >- @@ -537,13 +527,6 @@ components: response: mediaType: application/json openAPIDocKey: '200' - list: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1operations/get' - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.operations sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/operations/methods/get' @@ -571,6 +554,23 @@ components: update: [] replace: [] delete: [] + threat_lists: + id: google.webrisk.threat_lists + name: threat_lists + title: Threat_lists + methods: + compute_diff: + operation: + $ref: '#/paths/~1v1~1threatLists:computeDiff/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] uris: id: google.webrisk.uris name: uris @@ -606,63 +606,49 @@ components: replace: [] delete: [] paths: - /v1/threatLists:computeDiff: + /v1/projects/{projectsId}/operations: parameters: &ref_1 - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' get: description: >- - Gets the most recent threat list diffs. These diffs should be applied to - a local database of hashes to keep it up-to-date. If the local database - is empty or excessively out-of-date, a complete snapshot of the database - will be returned. This Method only updates a single ThreatList at a - time. To update multiple ThreatList databases, this method needs to be - called once for each list. - operationId: webrisk.threatLists.computeDiff - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: webrisk.projects.operations.list + security: [] responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudWebriskV1ComputeThreatListDiffResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - - in: query - name: constraints.maxDatabaseEntries - schema: - type: integer - format: int32 - - in: query - name: versionToken + - in: path + name: projectsId + required: true schema: type: string - format: byte - in: query - name: threatType + name: filter schema: type: string - in: query - name: constraints.maxDiffEntries + name: pageSize schema: type: integer format: int32 - in: query - name: constraints.supportedCompressions + name: pageToken schema: type: string /v1/projects/{projectsId}/operations/{operationsId}: @@ -734,7 +720,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: webrisk.projects.operations.cancel requestBody: content: @@ -760,40 +746,6 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/operations: - parameters: *ref_1 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: webrisk.projects.operations.list - security: [] - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string /v1/projects/{projectsId}/submissions: parameters: *ref_1 post: @@ -830,6 +782,54 @@ paths: required: true schema: type: string + /v1/threatLists:computeDiff: + parameters: *ref_1 + get: + description: >- + Gets the most recent threat list diffs. These diffs should be applied to + a local database of hashes to keep it up-to-date. If the local database + is empty or excessively out-of-date, a complete snapshot of the database + will be returned. This Method only updates a single ThreatList at a + time. To update multiple ThreatList databases, this method needs to be + called once for each list. + operationId: webrisk.threatLists.computeDiff + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudWebriskV1ComputeThreatListDiffResponse + parameters: + - in: query + name: threatType + schema: + type: string + - in: query + name: versionToken + schema: + type: string + format: byte + - in: query + name: constraints.maxDiffEntries + schema: + type: integer + format: int32 + - in: query + name: constraints.maxDatabaseEntries + schema: + type: integer + format: int32 + - in: query + name: constraints.supportedCompressions + schema: + type: string /v1/uris:search: parameters: *ref_1 get: diff --git a/providers/src/googleapis.com/v00.00.00000/services/websecurityscanner.yaml b/providers/src/googleapis.com/v00.00.00000/services/websecurityscanner.yaml index f32ee33a..d5d9dc59 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/websecurityscanner.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/websecurityscanner.yaml @@ -7,8 +7,8 @@ info: title: Web Security Scanner API description: Scans your Compute and App Engine apps for common web vulnerabilities. version: v1 - x-discovery-doc-revision: '20241027' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250810' + x-generated-date: '2025-08-28' externalDocs: url: >- https://cloud.google.com/security-command-center/docs/concepts-web-security-scanner-overview/ @@ -35,137 +35,144 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - Finding: + ScanConfig: + id: ScanConfig + description: A ScanConfig resource contains the configurations to launch a scan. type: object - description: >- - A Finding resource represents a vulnerability instance identified during - a ScanRun. - id: Finding properties: - frameUrl: - type: string - description: >- - Output only. If the vulnerability was originated from nested IFrame, - the immediate parent IFrame is reported. - body: - type: string - description: >- - Output only. The body of the request that triggered the - vulnerability. - trackingId: + name: description: >- - Output only. The tracking ID uniquely identifies a vulnerability - instance across multiple ScanRuns. + Identifier. The resource name of the ScanConfig. The name follows + the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The + ScanConfig IDs are generated by the system. type: string - findingType: - description: >- - Output only. The type of the Finding. Detailed and up-to-date - information on findings can be found here: - https://cloud.google.com/security-command-center/docs/how-to-remediate-web-security-scanner-findings + displayName: + description: Required. The user provided display name of the ScanConfig. type: string - vulnerableHeaders: + maxQps: description: >- - Output only. An addon containing information about vulnerable or - missing HTTP headers. - $ref: '#/components/schemas/VulnerableHeaders' - outdatedLibrary: - $ref: '#/components/schemas/OutdatedLibrary' + The maximum QPS during scanning. A valid value ranges from 5 to 20 + inclusively. If the field is unspecified or its value is set 0, + server will default to 15. Other values outside of [5, 20] range + will be rejected with INVALID_ARGUMENT error. + type: integer + format: int32 + startingUrls: + description: Required. The starting URLs from which the scanner finds site pages. + type: array + items: + type: string + authentication: description: >- - Output only. An addon containing information about outdated - libraries. - severity: - readOnly: true + The authentication configuration. If specified, service will use the + authentication configuration during scanning. + $ref: '#/components/schemas/Authentication' + userAgent: + description: The user agent used during scanning. + type: string enumDescriptions: - - No severity specified. The default value. - - Critical severity. - - High severity. - - Medium severity. - - Low severity. + - The user agent is unknown. Service will default to CHROME_LINUX. + - Chrome on Linux. This is the service default if unspecified. + - Chrome on Android. + - Safari on IPhone. enum: - - SEVERITY_UNSPECIFIED - - CRITICAL - - HIGH - - MEDIUM - - LOW - description: Output only. The severity level of the reported vulnerability. - type: string - violatingResource: - description: >- - Output only. An addon containing detailed information regarding any - resource causing the vulnerability such as JavaScript sources, - image, audio files, etc. - $ref: '#/components/schemas/ViolatingResource' - httpMethod: - description: >- - Output only. The http method of the request that triggered the - vulnerability, in uppercase. - type: string - fuzzedUrl: - type: string - description: >- - Output only. The URL produced by the server-side fuzzer and used in - the request that triggered the vulnerability. - finalUrl: + - USER_AGENT_UNSPECIFIED + - CHROME_LINUX + - CHROME_ANDROID + - SAFARI_IPHONE + blacklistPatterns: description: >- - Output only. The URL where the browser lands when the vulnerability - is detected. - type: string - reproductionUrl: + The excluded URL patterns as described in + https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls + type: array + items: + type: string + schedule: + description: The schedule of the ScanConfig. + $ref: '#/components/schemas/Schedule' + exportToSecurityCommandCenter: description: >- - Output only. The URL containing human-readable payload that user can - leverage to reproduce the vulnerability. + Controls export of scan configurations and results to Security + Command Center. type: string - xss: - $ref: '#/components/schemas/Xss' - description: >- - Output only. An addon containing information reported for an XSS, if - any. - description: - description: Output only. The description of the vulnerability. + enumDescriptions: + - Use default, which is ENABLED. + - Export results of this scan to Security Command Center. + - Do not export results of this scan to Security Command Center. + enum: + - EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIED + - ENABLED + - DISABLED + riskLevel: + description: The risk level selected for the scan type: string - form: + enumDescriptions: + - Use default, which is NORMAL. + - Normal scanning (Recommended) + - Lower impact scanning + enum: + - RISK_LEVEL_UNSPECIFIED + - NORMAL + - LOW + managedScan: description: >- - Output only. An addon containing information reported for a - vulnerability with an HTML form, if any. - $ref: '#/components/schemas/Form' - vulnerableParameters: - $ref: '#/components/schemas/VulnerableParameters' + Whether the scan config is managed by Web Security Scanner, output + only. + type: boolean + staticIpScan: description: >- - Output only. An addon containing information about request - parameters which were found to be vulnerable. - xxe: + Whether the scan configuration has enabled static IP address scan + feature. If enabled, the scanner will access applications from + static IP addresses. + type: boolean + ignoreHttpStatusErrors: description: >- - Output only. An addon containing information reported for an XXE, if - any. - $ref: '#/components/schemas/Xxe' - readOnly: true - name: + Whether to keep scanning even if most requests return HTTP error + codes. + type: boolean + latestRun: + $ref: '#/components/schemas/ScanRun' + targetPlatforms: description: >- - Output only. The resource name of the Finding. The name follows the - format of - 'projects/{projectId}/scanConfigs/{scanConfigId}/scanruns/{scanRunId}/findings/{findingId}'. - The finding IDs are generated by the system. - type: string - VulnerableHeaders: - id: VulnerableHeaders - type: object - properties: - missingHeaders: - type: array - description: List of missing headers. - items: - $ref: '#/components/schemas/Header' - headers: + Set of Google Cloud platforms targeted by the scan. If empty, + APP_ENGINE will be used as a default. type: array - description: List of vulnerable headers. items: - $ref: '#/components/schemas/Header' - description: Information about vulnerable or missing HTTP Headers. - GoogleAccount: - deprecated: true + type: string + enumDescriptions: + - >- + The target platform is unknown. Requests with this enum value + will be rejected with INVALID_ARGUMENT error. + - Google App Engine service. + - Google Compute Engine service. + - Google Cloud Run service. + - Google Cloud Function service. + enum: + - TARGET_PLATFORM_UNSPECIFIED + - APP_ENGINE + - COMPUTE + - CLOUD_RUN + - CLOUD_FUNCTIONS + Authentication: + id: Authentication + description: Scan authentication configuration. type: object + properties: + googleAccount: + description: Authentication using a Google account. + deprecated: true + $ref: '#/components/schemas/GoogleAccount' + customAccount: + description: Authentication using a custom account. + $ref: '#/components/schemas/CustomAccount' + iapCredential: + description: Authentication using Identity-Aware-Proxy (IAP). + $ref: '#/components/schemas/IapCredential' + GoogleAccount: id: GoogleAccount + deprecated: true description: Describes authentication configuration that uses a Google account. + type: object properties: username: description: Required. The user name of the Google account. @@ -176,184 +183,227 @@ components: credential is stored encrypted and not returned in any response nor included in audit logs. type: string - Header: + CustomAccount: + id: CustomAccount + description: Describes authentication configuration that uses a custom account. + type: object properties: - value: - description: Header value. + username: + description: Required. The user name of the custom account. type: string - name: + password: + description: >- + Required. Input only. The password of the custom account. The + credential is stored encrypted and not returned in any response nor + included in audit logs. type: string - description: Header name. - id: Header + loginUrl: + description: Required. The login form URL of the website. + type: string + IapCredential: + id: IapCredential + description: Describes authentication configuration for Identity-Aware-Proxy (IAP). type: object - description: Describes a HTTP Header. - ListScanRunsResponse: - description: Response for the `ListScanRuns` method. + properties: + iapTestServiceAccountInfo: + description: >- + Authentication configuration when Web-Security-Scanner service + account is added in Identity-Aware-Proxy (IAP) access policies. + $ref: '#/components/schemas/IapTestServiceAccountInfo' + IapTestServiceAccountInfo: + id: IapTestServiceAccountInfo + description: >- + Describes authentication configuration when Web-Security-Scanner service + account is added in Identity-Aware-Proxy (IAP) access policies. type: object - id: ListScanRunsResponse properties: - nextPageToken: + targetAudienceClientId: + description: >- + Required. Describes OAuth2 client id of resources protected by + Identity-Aware-Proxy (IAP). type: string + Schedule: + id: Schedule + description: Scan schedule configuration. + type: object + properties: + scheduleTime: description: >- - Token to retrieve the next page of results, or empty if there are no - more results in the list. - scanRuns: - items: - $ref: '#/components/schemas/ScanRun' - description: The list of ScanRuns returned. - type: array - Xxe: - properties: - payloadLocation: - enum: - - LOCATION_UNSPECIFIED - - COMPLETE_REQUEST_BODY - type: string - description: Location within the request where the payload was placed. - enumDescriptions: - - Unknown Location. - - The XML payload replaced the complete request body. - payloadValue: - description: >- - The XML string that triggered the XXE vulnerability. Non-payload - values might be redacted. + A timestamp indicates when the next run will be scheduled. The value + is refreshed by the server after each run. If unspecified, it will + default to current server time, which means the scan will be + scheduled to start immediately. type: string + format: google-datetime + intervalDurationDays: + description: Required. The duration of time between executions in days. + type: integer + format: int32 + ScanRun: + id: ScanRun + description: >- + A ScanRun is a output-only resource representing an actual run of the + scan. Next id: 12 type: object - id: Xxe - description: Information reported for an XXE. - Xss: - id: Xss properties: - attackVector: + name: + description: >- + Output only. The resource name of the ScanRun. The name follows the + format of + 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. + The ScanRun IDs are generated by the system. + type: string + executionState: + description: Output only. The execution state of the ScanRun. type: string - description: The attack vector of the payload triggering this XSS. - enum: - - ATTACK_VECTOR_UNSPECIFIED - - LOCAL_STORAGE - - SESSION_STORAGE - - WINDOW_NAME - - REFERRER - - FORM_INPUT - - COOKIE - - POST_MESSAGE - - GET_PARAMETERS - - URL_FRAGMENT - - HTML_COMMENT - - POST_PARAMETERS - - PROTOCOL - - STORED_XSS - - SAME_ORIGIN - - USER_CONTROLLABLE_URL enumDescriptions: - - Unknown attack vector. - - The attack comes from fuzzing the browser's localStorage. - - The attack comes from fuzzing the browser's sessionStorage. - - The attack comes from fuzzing the window's name property. - - The attack comes from fuzzing the referrer property. - - The attack comes from fuzzing an input element. - - The attack comes from fuzzing the browser's cookies. - - The attack comes from hijacking the post messaging mechanism. - - The attack comes from fuzzing parameters in the url. - - The attack comes from fuzzing the fragment in the url. - - The attack comes from fuzzing the HTML comments. - - The attack comes from fuzzing the POST parameters. - - The attack comes from fuzzing the protocol. - - The attack comes from the server side and is stored. - >- - The attack is a Same-Origin Method Execution attack via a GET - parameter. + Represents an invalid state caused by internal server error. This + value should never be returned. + - The scan is waiting in the queue. + - The scan is in progress. + - The scan is either finished or stopped by user. + enum: + - EXECUTION_STATE_UNSPECIFIED + - QUEUED + - SCANNING + - FINISHED + resultState: + description: >- + Output only. The result state of the ScanRun. This field is only + available after the execution state reaches "FINISHED". + type: string + enumDescriptions: - >- - The attack payload is received from a third-party host via a URL - that is user-controllable - storedXssSeedingUrl: - description: The reproduction url for the seeding POST request of a Stored XSS. + Default value. This value is returned when the ScanRun is not yet + finished. + - The scan finished without errors. + - The scan finished with errors. + - The scan was terminated by user. + enum: + - RESULT_STATE_UNSPECIFIED + - SUCCESS + - ERROR + - KILLED + startTime: + description: Output only. The time at which the ScanRun started. type: string - stackTraces: - items: - type: string - type: array - description: Stack traces leading to the point where the XSS occurred. - errorMessage: - description: An error message generated by a javascript breakage. + format: google-datetime + endTime: + description: >- + Output only. The time at which the ScanRun reached termination state + - that the ScanRun is either finished or stopped by user. type: string - type: object - description: Information reported for an XSS. - StopScanRunRequest: - description: Request for the `StopScanRun` method. - type: object - id: StopScanRunRequest - properties: {} - ListFindingsResponse: - description: Response for the `ListFindings` method. - type: object - properties: - findings: - type: array - items: - $ref: '#/components/schemas/Finding' - description: The list of Findings returned. - nextPageToken: + format: google-datetime + urlsCrawledCount: + description: >- + Output only. The number of URLs crawled during this ScanRun. If the + scan is in progress, the value represents the number of URLs crawled + up to now. type: string + format: int64 + urlsTestedCount: description: >- - Token to retrieve the next page of results, or empty if there are no - more results in the list. - id: ListFindingsResponse - ScanConfigError: - properties: - fieldName: + Output only. The number of URLs tested during this ScanRun. If the + scan is in progress, the value represents the number of URLs tested + up to now. The number of URLs tested is usually larger than the + number URLS crawled because typically a crawled URL is tested with + multiple test payloads. type: string + format: int64 + hasVulnerabilities: + description: Output only. Whether the scan run has found any vulnerabilities. + type: boolean + progressPercent: description: >- - Output only. Indicates the full name of the ScanConfig field that - triggers this error, for example "scan_config.max_qps". This field - is provided for troubleshooting purposes only and its actual value - can change in the future. + Output only. The percentage of total completion ranging from 0 to + 100. If the scan is in queue, the value is 0. If the scan is + running, the value ranges from 0 to 100. If the scan is finished, + the value is 100. + type: integer + format: int32 + errorTrace: + description: >- + Output only. If result_state is an ERROR, this field provides the + primary reason for scan's termination and more details, if such are + available. + $ref: '#/components/schemas/ScanRunErrorTrace' + warningTraces: + description: >- + Output only. A list of warnings, if such are encountered during this + scan run. + type: array + items: + $ref: '#/components/schemas/ScanRunWarningTrace' + ScanRunErrorTrace: + id: ScanRunErrorTrace + description: Output only. Defines an error trace message for a ScanRun. + type: object + properties: code: - description: Output only. Indicates the reason code for a configuration failure. + description: Output only. Indicates the error reason code. type: string + enumDescriptions: + - Default value is never used. + - >- + Indicates that the scan run failed due to an internal server + error. + - >- + Indicates a scan configuration error, usually due to outdated + ScanConfig settings, such as starting_urls or the DNS + configuration. + - >- + Indicates an authentication error, usually due to outdated + ScanConfig authentication settings. + - >- + Indicates a scan operation timeout, usually caused by a very large + site. + - >- + Indicates that a scan encountered excessive redirects, either to + authentication or some other page outside of the scan scope. + - >- + Indicates that a scan encountered numerous errors from the web + site pages. When available, most_common_http_error_code field + indicates the most common HTTP error code encountered during the + scan. + - >- + Indicates that some of the starting web urls returned HTTP errors + during the scan. enum: - CODE_UNSPECIFIED - - OK - INTERNAL_ERROR - - APPENGINE_API_BACKEND_ERROR - - APPENGINE_API_NOT_ACCESSIBLE - - APPENGINE_DEFAULT_HOST_MISSING - - CANNOT_USE_GOOGLE_COM_ACCOUNT - - CANNOT_USE_OWNER_ACCOUNT - - COMPUTE_API_BACKEND_ERROR - - COMPUTE_API_NOT_ACCESSIBLE - - CUSTOM_LOGIN_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECT - - CUSTOM_LOGIN_URL_MALFORMED - - CUSTOM_LOGIN_URL_MAPPED_TO_NON_ROUTABLE_ADDRESS - - CUSTOM_LOGIN_URL_MAPPED_TO_UNRESERVED_ADDRESS - - CUSTOM_LOGIN_URL_HAS_NON_ROUTABLE_IP_ADDRESS - - CUSTOM_LOGIN_URL_HAS_UNRESERVED_IP_ADDRESS - - DUPLICATE_SCAN_NAME - - INVALID_FIELD_VALUE - - FAILED_TO_AUTHENTICATE_TO_TARGET - - FINDING_TYPE_UNSPECIFIED - - FORBIDDEN_TO_SCAN_COMPUTE - - FORBIDDEN_UPDATE_TO_MANAGED_SCAN - - MALFORMED_FILTER - - MALFORMED_RESOURCE_NAME - - PROJECT_INACTIVE - - REQUIRED_FIELD - - RESOURCE_NAME_INCONSISTENT - - SCAN_ALREADY_RUNNING - - SCAN_NOT_RUNNING - - SEED_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECT - - SEED_URL_MALFORMED - - SEED_URL_MAPPED_TO_NON_ROUTABLE_ADDRESS - - SEED_URL_MAPPED_TO_UNRESERVED_ADDRESS - - SEED_URL_HAS_NON_ROUTABLE_IP_ADDRESS - - SEED_URL_HAS_UNRESERVED_IP_ADDRESS - - SERVICE_ACCOUNT_NOT_CONFIGURED - - TOO_MANY_SCANS - - UNABLE_TO_RESOLVE_PROJECT_INFO - - UNSUPPORTED_BLACKLIST_PATTERN_FORMAT - - UNSUPPORTED_FILTER - - UNSUPPORTED_FINDING_TYPE - - UNSUPPORTED_URL_SCHEME - - CLOUD_ASSET_INVENTORY_ASSET_NOT_FOUND + - SCAN_CONFIG_ISSUE + - AUTHENTICATION_CONFIG_ISSUE + - TIMED_OUT_WHILE_SCANNING + - TOO_MANY_REDIRECTS + - TOO_MANY_HTTP_ERRORS + - STARTING_URLS_CRAWL_HTTP_ERRORS + scanConfigError: + description: >- + Output only. If the scan encounters SCAN_CONFIG_ISSUE error, this + field has the error message encountered during scan configuration + validation that is performed before each scan run. + $ref: '#/components/schemas/ScanConfigError' + mostCommonHttpErrorCode: + description: >- + Output only. If the scan encounters TOO_MANY_HTTP_ERRORS, this field + indicates the most common HTTP error code, if such is available. For + example, if this code is 404, the scan has encountered too many + NOT_FOUND responses. + type: integer + format: int32 + ScanConfigError: + id: ScanConfigError + description: >- + Defines a custom error message used by CreateScanConfig and + UpdateScanConfig APIs when scan configuration validation fails. It is + also reported as part of a ScanRunErrorTrace message if scan validation + fails due to a scan configuration error. + type: object + properties: + code: + description: Output only. Indicates the reason code for a configuration failure. + type: string enumDescriptions: - There is no error. - There is no error. @@ -435,54 +485,68 @@ components: The URL scheme of one or more of the supplied URLs is not supported. - CAI is not able to list assets. - type: object - description: >- - Defines a custom error message used by CreateScanConfig and - UpdateScanConfig APIs when scan configuration validation fails. It is - also reported as part of a ScanRunErrorTrace message if scan validation - fails due to a scan configuration error. - id: ScanConfigError - Authentication: - properties: - googleAccount: - $ref: '#/components/schemas/GoogleAccount' - deprecated: true - description: Authentication using a Google account. - customAccount: - $ref: '#/components/schemas/CustomAccount' - description: Authentication using a custom account. - iapCredential: - $ref: '#/components/schemas/IapCredential' - description: Authentication using Identity-Aware-Proxy (IAP). - description: Scan authentication configuration. - id: Authentication - type: object - CustomAccount: - type: object - description: Describes authentication configuration that uses a custom account. - id: CustomAccount - properties: - username: - description: Required. The user name of the custom account. - type: string - loginUrl: - description: Required. The login form URL of the website. - type: string - password: + enum: + - CODE_UNSPECIFIED + - OK + - INTERNAL_ERROR + - APPENGINE_API_BACKEND_ERROR + - APPENGINE_API_NOT_ACCESSIBLE + - APPENGINE_DEFAULT_HOST_MISSING + - CANNOT_USE_GOOGLE_COM_ACCOUNT + - CANNOT_USE_OWNER_ACCOUNT + - COMPUTE_API_BACKEND_ERROR + - COMPUTE_API_NOT_ACCESSIBLE + - CUSTOM_LOGIN_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECT + - CUSTOM_LOGIN_URL_MALFORMED + - CUSTOM_LOGIN_URL_MAPPED_TO_NON_ROUTABLE_ADDRESS + - CUSTOM_LOGIN_URL_MAPPED_TO_UNRESERVED_ADDRESS + - CUSTOM_LOGIN_URL_HAS_NON_ROUTABLE_IP_ADDRESS + - CUSTOM_LOGIN_URL_HAS_UNRESERVED_IP_ADDRESS + - DUPLICATE_SCAN_NAME + - INVALID_FIELD_VALUE + - FAILED_TO_AUTHENTICATE_TO_TARGET + - FINDING_TYPE_UNSPECIFIED + - FORBIDDEN_TO_SCAN_COMPUTE + - FORBIDDEN_UPDATE_TO_MANAGED_SCAN + - MALFORMED_FILTER + - MALFORMED_RESOURCE_NAME + - PROJECT_INACTIVE + - REQUIRED_FIELD + - RESOURCE_NAME_INCONSISTENT + - SCAN_ALREADY_RUNNING + - SCAN_NOT_RUNNING + - SEED_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECT + - SEED_URL_MALFORMED + - SEED_URL_MAPPED_TO_NON_ROUTABLE_ADDRESS + - SEED_URL_MAPPED_TO_UNRESERVED_ADDRESS + - SEED_URL_HAS_NON_ROUTABLE_IP_ADDRESS + - SEED_URL_HAS_UNRESERVED_IP_ADDRESS + - SERVICE_ACCOUNT_NOT_CONFIGURED + - TOO_MANY_SCANS + - UNABLE_TO_RESOLVE_PROJECT_INFO + - UNSUPPORTED_BLACKLIST_PATTERN_FORMAT + - UNSUPPORTED_FILTER + - UNSUPPORTED_FINDING_TYPE + - UNSUPPORTED_URL_SCHEME + - CLOUD_ASSET_INVENTORY_ASSET_NOT_FOUND + fieldName: description: >- - Required. Input only. The password of the custom account. The - credential is stored encrypted and not returned in any response nor - included in audit logs. + Output only. Indicates the full name of the ScanConfig field that + triggers this error, for example "scan_config.max_qps". This field + is provided for troubleshooting purposes only and its actual value + can change in the future. type: string ScanRunWarningTrace: + id: ScanRunWarningTrace description: >- Output only. Defines a warning trace message for ScanRun. Warning traces provide customers with useful information that helps make the scanning process more effective. - id: ScanRunWarningTrace type: object properties: code: + description: Output only. Indicates the warning code. + type: string enumDescriptions: - Default value is never used. - >- @@ -492,485 +556,439 @@ components: - >- Indicates that a scan discovered too many URLs to test, or excessive redundant URLs. - - >- - Indicates that too many tests have been generated for the scan. - Customer should try reducing the number of starting URLs, - increasing the QPS rate, or narrowing down the scope of the scan - using the excluded patterns. - - Indicates that a scan is blocked by IAP. - - Indicates that no seeds is found for a scan - description: Output only. Indicates the warning code. - enum: - - CODE_UNSPECIFIED - - INSUFFICIENT_CRAWL_RESULTS - - TOO_MANY_CRAWL_RESULTS - - TOO_MANY_FUZZ_TASKS - - BLOCKED_BY_IAP - - NO_STARTING_URL_FOUND_FOR_MANAGED_SCAN - type: string - VulnerableParameters: - description: Information about vulnerable request parameters. - id: VulnerableParameters - type: object - properties: - parameterNames: - description: The vulnerable parameter names. - type: array - items: - type: string - StartScanRunRequest: - id: StartScanRunRequest - description: Request for the `StartScanRun` method. - properties: {} - type: object - Schedule: - description: Scan schedule configuration. - type: object - properties: - intervalDurationDays: - description: Required. The duration of time between executions in days. - type: integer - format: int32 - scheduleTime: - description: >- - A timestamp indicates when the next run will be scheduled. The value - is refreshed by the server after each run. If unspecified, it will - default to current server time, which means the scan will be - scheduled to start immediately. - format: google-datetime - type: string - id: Schedule + - >- + Indicates that too many tests have been generated for the scan. + Customer should try reducing the number of starting URLs, + increasing the QPS rate, or narrowing down the scope of the scan + using the excluded patterns. + - Indicates that a scan is blocked by IAP. + - Indicates that no seeds is found for a scan + enum: + - CODE_UNSPECIFIED + - INSUFFICIENT_CRAWL_RESULTS + - TOO_MANY_CRAWL_RESULTS + - TOO_MANY_FUZZ_TASKS + - BLOCKED_BY_IAP + - NO_STARTING_URL_FOUND_FOR_MANAGED_SCAN Empty: id: Empty - properties: {} - type: object description: >- A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } - IapTestServiceAccountInfo: type: object - description: >- - Describes authentication configuration when Web-Security-Scanner service - account is added in Identity-Aware-Proxy (IAP) access policies. - properties: - targetAudienceClientId: - type: string - description: >- - Required. Describes OAuth2 client id of resources protected by - Identity-Aware-Proxy (IAP). - id: IapTestServiceAccountInfo - ListCrawledUrlsResponse: + properties: {} + ListScanConfigsResponse: + id: ListScanConfigsResponse + description: Response for the `ListScanConfigs` method. type: object - id: ListCrawledUrlsResponse properties: + scanConfigs: + description: The list of ScanConfigs returned. + type: array + items: + $ref: '#/components/schemas/ScanConfig' nextPageToken: - type: string description: >- Token to retrieve the next page of results, or empty if there are no more results in the list. - crawledUrls: - items: - $ref: '#/components/schemas/CrawledUrl' - type: array - description: The list of CrawledUrls returned. - description: Response for the `ListCrawledUrls` method. - ListScanConfigsResponse: - description: Response for the `ListScanConfigs` method. + type: string + StartScanRunRequest: + id: StartScanRunRequest + description: Request for the `StartScanRun` method. + type: object + properties: {} + ListScanRunsResponse: + id: ListScanRunsResponse + description: Response for the `ListScanRuns` method. + type: object properties: + scanRuns: + description: The list of ScanRuns returned. + type: array + items: + $ref: '#/components/schemas/ScanRun' nextPageToken: - type: string description: >- Token to retrieve the next page of results, or empty if there are no more results in the list. - scanConfigs: - type: array - description: The list of ScanConfigs returned. - items: - $ref: '#/components/schemas/ScanConfig' + type: string + StopScanRunRequest: + id: StopScanRunRequest + description: Request for the `StopScanRun` method. type: object - id: ListScanConfigsResponse - IapCredential: - properties: - iapTestServiceAccountInfo: - description: >- - Authentication configuration when Web-Security-Scanner service - account is added in Identity-Aware-Proxy (IAP) access policies. - $ref: '#/components/schemas/IapTestServiceAccountInfo' + properties: {} + ListCrawledUrlsResponse: + id: ListCrawledUrlsResponse + description: Response for the `ListCrawledUrls` method. type: object - description: Describes authentication configuration for Identity-Aware-Proxy (IAP). - id: IapCredential - OutdatedLibrary: - description: Information reported for an outdated library. properties: - version: - type: string - description: The version number. - learnMoreUrls: - description: >- - URLs to learn more information about the vulnerabilities in the - library. + crawledUrls: + description: The list of CrawledUrls returned. type: array items: - type: string - libraryName: + $ref: '#/components/schemas/CrawledUrl' + nextPageToken: + description: >- + Token to retrieve the next page of results, or empty if there are no + more results in the list. type: string - description: The name of the outdated library. - type: object - id: OutdatedLibrary CrawledUrl: - type: object + id: CrawledUrl description: >- A CrawledUrl resource represents a URL that was crawled during a ScanRun. Web Security Scanner Service crawls the web applications, following all links within the scope of sites, to find the URLs to test against. + type: object properties: - body: - type: string - description: Output only. The body of the request that was used to visit the URL. httpMethod: - type: string description: >- Output only. The http method of the request that was used to visit the URL, in uppercase. - url: type: string + url: description: Output only. The URL that was crawled. - id: CrawledUrl - ScanConfig: - description: A ScanConfig resource contains the configurations to launch a scan. + type: string + body: + description: Output only. The body of the request that was used to visit the URL. + type: string + Finding: + id: Finding + description: >- + A Finding resource represents a vulnerability instance identified during + a ScanRun. type: object - id: ScanConfig properties: - authentication: - $ref: '#/components/schemas/Authentication' - description: >- - The authentication configuration. If specified, service will use the - authentication configuration during scanning. - ignoreHttpStatusErrors: - description: >- - Whether to keep scanning even if most requests return HTTP error - codes. - type: boolean - maxQps: + name: description: >- - The maximum QPS during scanning. A valid value ranges from 5 to 20 - inclusively. If the field is unspecified or its value is set 0, - server will default to 15. Other values outside of [5, 20] range - will be rejected with INVALID_ARGUMENT error. - type: integer - format: int32 - staticIpScan: - type: boolean + Output only. The resource name of the Finding. The name follows the + format of + 'projects/{projectId}/scanConfigs/{scanConfigId}/scanruns/{scanRunId}/findings/{findingId}'. + The finding IDs are generated by the system. + type: string + findingType: description: >- - Whether the scan configuration has enabled static IP address scan - feature. If enabled, the scanner will access applications from - static IP addresses. - riskLevel: - enum: - - RISK_LEVEL_UNSPECIFIED - - NORMAL - - LOW - enumDescriptions: - - Use default, which is NORMAL. - - Normal scanning (Recommended) - - Lower impact scanning + Output only. The type of the Finding. Detailed and up-to-date + information on findings can be found here: + https://cloud.google.com/security-command-center/docs/how-to-remediate-web-security-scanner-findings + type: string + severity: + description: Output only. The severity level of the reported vulnerability. + readOnly: true type: string - description: The risk level selected for the scan - userAgent: - description: The user agent used during scanning. enumDescriptions: - - The user agent is unknown. Service will default to CHROME_LINUX. - - Chrome on Linux. This is the service default if unspecified. - - Chrome on Android. - - Safari on IPhone. + - No severity specified. The default value. + - Critical severity. + - High severity. + - Medium severity. + - Low severity. enum: - - USER_AGENT_UNSPECIFIED - - CHROME_LINUX - - CHROME_ANDROID - - SAFARI_IPHONE + - SEVERITY_UNSPECIFIED + - CRITICAL + - HIGH + - MEDIUM + - LOW + httpMethod: + description: >- + Output only. The http method of the request that triggered the + vulnerability, in uppercase. type: string - name: + fuzzedUrl: + description: >- + Output only. The URL produced by the server-side fuzzer and used in + the request that triggered the vulnerability. + type: string + body: + description: >- + Output only. The body of the request that triggered the + vulnerability. + type: string + description: + description: Output only. The description of the vulnerability. + type: string + reproductionUrl: + description: >- + Output only. The URL containing human-readable payload that user can + leverage to reproduce the vulnerability. + type: string + frameUrl: + description: >- + Output only. If the vulnerability was originated from nested IFrame, + the immediate parent IFrame is reported. + type: string + finalUrl: + description: >- + Output only. The URL where the browser lands when the vulnerability + is detected. + type: string + trackingId: + description: >- + Output only. The tracking ID uniquely identifies a vulnerability + instance across multiple ScanRuns. type: string + form: + description: >- + Output only. An addon containing information reported for a + vulnerability with an HTML form, if any. + $ref: '#/components/schemas/Form' + outdatedLibrary: + description: >- + Output only. An addon containing information about outdated + libraries. + $ref: '#/components/schemas/OutdatedLibrary' + violatingResource: + description: >- + Output only. An addon containing detailed information regarding any + resource causing the vulnerability such as JavaScript sources, + image, audio files, etc. + $ref: '#/components/schemas/ViolatingResource' + vulnerableHeaders: + description: >- + Output only. An addon containing information about vulnerable or + missing HTTP headers. + $ref: '#/components/schemas/VulnerableHeaders' + vulnerableParameters: + description: >- + Output only. An addon containing information about request + parameters which were found to be vulnerable. + $ref: '#/components/schemas/VulnerableParameters' + xss: description: >- - The resource name of the ScanConfig. The name follows the format of - 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig - IDs are generated by the system. - exportToSecurityCommandCenter: - type: string - enum: - - EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIED - - ENABLED - - DISABLED + Output only. An addon containing information reported for an XSS, if + any. + $ref: '#/components/schemas/Xss' + xxe: description: >- - Controls export of scan configurations and results to Security - Command Center. - enumDescriptions: - - Use default, which is ENABLED. - - Export results of this scan to Security Command Center. - - Do not export results of this scan to Security Command Center. - schedule: - $ref: '#/components/schemas/Schedule' - description: The schedule of the ScanConfig. - blacklistPatterns: + Output only. An addon containing information reported for an XXE, if + any. + readOnly: true + $ref: '#/components/schemas/Xxe' + Form: + id: Form + description: '! Information about a vulnerability with an HTML.' + type: object + properties: + actionUri: + description: '! The URI where to send the form when it''s submitted.' + type: string + fields: + description: '! The names of form fields related to the vulnerability.' type: array items: type: string - description: >- - The excluded URL patterns as described in - https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls - managedScan: - type: boolean - description: >- - Whether the scan config is managed by Web Security Scanner, output - only. - displayName: + OutdatedLibrary: + id: OutdatedLibrary + description: Information reported for an outdated library. + type: object + properties: + libraryName: + description: The name of the outdated library. type: string - description: Required. The user provided display name of the ScanConfig. - startingUrls: + version: + description: The version number. + type: string + learnMoreUrls: + description: >- + URLs to learn more information about the vulnerabilities in the + library. type: array items: type: string - description: Required. The starting URLs from which the scanner finds site pages. ViolatingResource: - type: object + id: ViolatingResource description: >- Information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc. + type: object properties: - resourceUrl: - type: string - description: URL of this violating resource. contentType: description: The MIME type of this resource. type: string - id: ViolatingResource - ScanRunErrorTrace: - properties: - code: + resourceUrl: + description: URL of this violating resource. type: string - enumDescriptions: - - Default value is never used. - - >- - Indicates that the scan run failed due to an internal server - error. - - >- - Indicates a scan configuration error, usually due to outdated - ScanConfig settings, such as starting_urls or the DNS - configuration. - - >- - Indicates an authentication error, usually due to outdated - ScanConfig authentication settings. - - >- - Indicates a scan operation timeout, usually caused by a very large - site. - - >- - Indicates that a scan encountered excessive redirects, either to - authentication or some other page outside of the scan scope. - - >- - Indicates that a scan encountered numerous errors from the web - site pages. When available, most_common_http_error_code field - indicates the most common HTTP error code encountered during the - scan. - - >- - Indicates that some of the starting web urls returned HTTP errors - during the scan. - description: Output only. Indicates the error reason code. - enum: - - CODE_UNSPECIFIED - - INTERNAL_ERROR - - SCAN_CONFIG_ISSUE - - AUTHENTICATION_CONFIG_ISSUE - - TIMED_OUT_WHILE_SCANNING - - TOO_MANY_REDIRECTS - - TOO_MANY_HTTP_ERRORS - - STARTING_URLS_CRAWL_HTTP_ERRORS - scanConfigError: - description: >- - Output only. If the scan encounters SCAN_CONFIG_ISSUE error, this - field has the error message encountered during scan configuration - validation that is performed before each scan run. - $ref: '#/components/schemas/ScanConfigError' - mostCommonHttpErrorCode: - type: integer - format: int32 - description: >- - Output only. If the scan encounters TOO_MANY_HTTP_ERRORS, this field - indicates the most common HTTP error code, if such is available. For - example, if this code is 404, the scan has encountered too many - NOT_FOUND responses. - description: Output only. Defines an error trace message for a ScanRun. + VulnerableHeaders: + id: VulnerableHeaders + description: Information about vulnerable or missing HTTP Headers. type: object - id: ScanRunErrorTrace - FindingTypeStats: - description: >- - A FindingTypeStats resource represents stats regarding a specific - FindingType of Findings under a given ScanRun. - id: FindingTypeStats + properties: + headers: + description: List of vulnerable headers. + type: array + items: + $ref: '#/components/schemas/Header' + missingHeaders: + description: List of missing headers. + type: array + items: + $ref: '#/components/schemas/Header' + Header: + id: Header + description: Describes a HTTP Header. type: object properties: - findingType: + name: + description: Header name. type: string - description: Output only. The finding type associated with the stats. - findingCount: - format: int32 - type: integer - description: Output only. The count of findings belonging to this finding type. - Form: - description: '! Information about a vulnerability with an HTML.' + value: + description: Header value. + type: string + VulnerableParameters: + id: VulnerableParameters + description: Information about vulnerable request parameters. type: object - id: Form properties: - fields: - description: '! The names of form fields related to the vulnerability.' + parameterNames: + description: The vulnerable parameter names. type: array items: type: string - actionUri: - description: '! The URI where to send the form when it''s submitted.' - type: string - ScanRun: + Xss: + id: Xss + description: Information reported for an XSS. type: object - id: ScanRun properties: - startTime: - format: google-datetime - description: Output only. The time at which the ScanRun started. - type: string - hasVulnerabilities: - type: boolean - description: Output only. Whether the scan run has found any vulnerabilities. - progressPercent: - type: integer - description: >- - Output only. The percentage of total completion ranging from 0 to - 100. If the scan is in queue, the value is 0. If the scan is - running, the value ranges from 0 to 100. If the scan is finished, - the value is 100. - format: int32 - warningTraces: + stackTraces: + description: Stack traces leading to the point where the XSS occurred. type: array - description: >- - Output only. A list of warnings, if such are encountered during this - scan run. items: - $ref: '#/components/schemas/ScanRunWarningTrace' - executionState: - enumDescriptions: - - >- - Represents an invalid state caused by internal server error. This - value should never be returned. - - The scan is waiting in the queue. - - The scan is in progress. - - The scan is either finished or stopped by user. - description: Output only. The execution state of the ScanRun. - type: string - enum: - - EXECUTION_STATE_UNSPECIFIED - - QUEUED - - SCANNING - - FINISHED - name: - description: >- - Output only. The resource name of the ScanRun. The name follows the - format of - 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. - The ScanRun IDs are generated by the system. + type: string + errorMessage: + description: An error message generated by a javascript breakage. type: string - urlsTestedCount: - format: int64 + attackVector: + description: The attack vector of the payload triggering this XSS. type: string - description: >- - Output only. The number of URLs tested during this ScanRun. If the - scan is in progress, the value represents the number of URLs tested - up to now. The number of URLs tested is usually larger than the - number URLS crawled because typically a crawled URL is tested with - multiple test payloads. - resultState: - enum: - - RESULT_STATE_UNSPECIFIED - - SUCCESS - - ERROR - - KILLED enumDescriptions: + - Unknown attack vector. + - The attack comes from fuzzing the browser's localStorage. + - The attack comes from fuzzing the browser's sessionStorage. + - The attack comes from fuzzing the window's name property. + - The attack comes from fuzzing the referrer property. + - The attack comes from fuzzing an input element. + - The attack comes from fuzzing the browser's cookies. + - The attack comes from hijacking the post messaging mechanism. + - The attack comes from fuzzing parameters in the url. + - The attack comes from fuzzing the fragment in the url. + - The attack comes from fuzzing the HTML comments. + - The attack comes from fuzzing the POST parameters. + - The attack comes from fuzzing the protocol. + - The attack comes from the server side and is stored. + - >- + The attack is a Same-Origin Method Execution attack via a GET + parameter. - >- - Default value. This value is returned when the ScanRun is not yet - finished. - - The scan finished without errors. - - The scan finished with errors. - - The scan was terminated by user. + The attack payload is received from a third-party host via a URL + that is user-controllable + enum: + - ATTACK_VECTOR_UNSPECIFIED + - LOCAL_STORAGE + - SESSION_STORAGE + - WINDOW_NAME + - REFERRER + - FORM_INPUT + - COOKIE + - POST_MESSAGE + - GET_PARAMETERS + - URL_FRAGMENT + - HTML_COMMENT + - POST_PARAMETERS + - PROTOCOL + - STORED_XSS + - SAME_ORIGIN + - USER_CONTROLLABLE_URL + storedXssSeedingUrl: + description: The reproduction url for the seeding POST request of a Stored XSS. + type: string + Xxe: + id: Xxe + description: Information reported for an XXE. + type: object + properties: + payloadValue: description: >- - Output only. The result state of the ScanRun. This field is only - available after the execution state reaches "FINISHED". + The XML string that triggered the XXE vulnerability. Non-payload + values might be redacted. type: string - endTime: + payloadLocation: + description: Location within the request where the payload was placed. type: string - format: google-datetime - description: >- - Output only. The time at which the ScanRun reached termination state - - that the ScanRun is either finished or stopped by user. - urlsCrawledCount: + enumDescriptions: + - Unknown Location. + - The XML payload replaced the complete request body. + enum: + - LOCATION_UNSPECIFIED + - COMPLETE_REQUEST_BODY + ListFindingsResponse: + id: ListFindingsResponse + description: Response for the `ListFindings` method. + type: object + properties: + findings: + description: The list of Findings returned. + type: array + items: + $ref: '#/components/schemas/Finding' + nextPageToken: description: >- - Output only. The number of URLs crawled during this ScanRun. If the - scan is in progress, the value represents the number of URLs crawled - up to now. + Token to retrieve the next page of results, or empty if there are no + more results in the list. type: string - format: int64 - errorTrace: - description: >- - Output only. If result_state is an ERROR, this field provides the - primary reason for scan's termination and more details, if such are - available. - $ref: '#/components/schemas/ScanRunErrorTrace' - description: >- - A ScanRun is a output-only resource representing an actual run of the - scan. Next id: 12 ListFindingTypeStatsResponse: id: ListFindingTypeStatsResponse + description: Response for the `ListFindingTypeStats` method. + type: object properties: findingTypeStats: + description: The list of FindingTypeStats returned. type: array items: $ref: '#/components/schemas/FindingTypeStats' - description: The list of FindingTypeStats returned. - description: Response for the `ListFindingTypeStats` method. + FindingTypeStats: + id: FindingTypeStats + description: >- + A FindingTypeStats resource represents stats regarding a specific + FindingType of Findings under a given ScanRun. type: object + properties: + findingType: + description: Output only. The finding type associated with the stats. + type: string + findingCount: + description: Output only. The count of findings belonging to this finding type. + type: integer + format: int32 parameters: - prettyPrint: - description: Returns response with indentations and line breaks. + access_token: + description: OAuth access token. in: query - name: prettyPrint + name: access_token schema: - type: boolean - oauth_token: - description: OAuth 2.0 token for the current user. + type: string + alt: + description: Data format for response. in: query - name: oauth_token + name: alt schema: type: string - _.xgafv: - description: V1 error format. + enum: + - json + - media + - proto + callback: + description: JSONP in: query - name: $.xgafv + name: callback schema: type: string - enum: - - '1' - - '2' fields: description: Selector specifying which fields to include in a partial response. in: query name: fields schema: type: string - access_token: - description: OAuth access token. - in: query - name: access_token - schema: - type: string key: description: >- API key. Your API key identifies your project and provides you with API @@ -980,18 +998,18 @@ components: name: key schema: type: string - callback: - description: JSONP + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: callback + name: oauth_token schema: type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + prettyPrint: + description: Returns response with indentations and line breaks. in: query - name: uploadType + name: prettyPrint schema: - type: string + type: boolean quotaUser: description: >- Available to use for quota purposes for server-side applications. Can be @@ -1001,66 +1019,71 @@ components: name: quotaUser schema: type: string - alt: - description: Data format for response. - in: query - name: alt - schema: - type: string - enum: - - json - - media - - proto upload_protocol: description: Upload protocol for media (e.g. "raw", "multipart"). in: query name: upload_protocol schema: type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' x-stackQL-resources: scan_configs: id: google.websecurityscanner.scan_configs name: scan_configs title: Scan_configs methods: - list: + create: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1scanConfigs/get' + $ref: '#/paths/~1v1~1projects~1{projectsId}~1scanConfigs/post' response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.scanConfigs - create: + list: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1scanConfigs/post' + $ref: '#/paths/~1v1~1projects~1{projectsId}~1scanConfigs/get' response: mediaType: application/json openAPIDocKey: '200' - start: + objectKey: $.scanConfigs + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}:start/post + #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}/delete response: mediaType: application/json openAPIDocKey: '200' - patch: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}/get response: mediaType: application/json openAPIDocKey: '200' - get: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}/get + #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}/patch response: mediaType: application/json openAPIDocKey: '200' - delete: + start: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}:start/post response: mediaType: application/json openAPIDocKey: '200' @@ -1075,21 +1098,37 @@ components: replace: [] delete: - $ref: '#/components/x-stackQL-resources/scan_configs/methods/delete' - finding_type_stats: - id: google.websecurityscanner.finding_type_stats - name: finding_type_stats - title: Finding_type_stats + scan_runs: + id: google.websecurityscanner.scan_runs + name: scan_runs + title: Scan_runs methods: + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}~1scanRuns~1{scanRunsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}~1scanRuns~1{scanRunsId}~1findingTypeStats/get + #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}~1scanRuns/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.scanRuns + stop: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}~1scanRuns~1{scanRunsId}:stop/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/finding_type_stats/methods/list' + - $ref: '#/components/x-stackQL-resources/scan_runs/methods/get' + - $ref: '#/components/x-stackQL-resources/scan_runs/methods/list' insert: [] update: [] replace: [] @@ -1119,14 +1158,6 @@ components: name: findings title: Findings methods: - list: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}~1scanRuns~1{scanRunsId}~1findings/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.findings get: operation: $ref: >- @@ -1134,45 +1165,37 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/findings/methods/get' - - $ref: '#/components/x-stackQL-resources/findings/methods/list' - insert: [] - update: [] - replace: [] - delete: [] - scan_runs: - id: google.websecurityscanner.scan_runs - name: scan_runs - title: Scan_runs - methods: list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}~1scanRuns/get - response: - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.scanRuns - stop: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}~1scanRuns~1{scanRunsId}:stop/post + #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}~1scanRuns~1{scanRunsId}~1findings/get response: mediaType: application/json openAPIDocKey: '200' - get: + objectKey: $.findings + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/findings/methods/get' + - $ref: '#/components/x-stackQL-resources/findings/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + finding_type_stats: + id: google.websecurityscanner.finding_type_stats + name: finding_type_stats + title: Finding_type_stats + methods: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}~1scanRuns~1{scanRunsId}/get + #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}~1scanRuns~1{scanRunsId}~1findingTypeStats/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/scan_runs/methods/get' - - $ref: '#/components/x-stackQL-resources/scan_runs/methods/list' + - $ref: '#/components/x-stackQL-resources/finding_type_stats/methods/list' insert: [] update: [] replace: [] @@ -1180,17 +1203,43 @@ components: paths: /v1/projects/{projectsId}/scanConfigs: parameters: &ref_1 - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' + post: + description: Creates a new ScanConfig. + operationId: websecurityscanner.projects.scanConfigs.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ScanConfig' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ScanConfig' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string get: description: Lists ScanConfigs under a given project. operationId: websecurityscanner.projects.scanConfigs.list @@ -1212,23 +1261,20 @@ paths: required: true schema: type: string + - in: query + name: pageToken + schema: + type: string - in: query name: pageSize schema: type: integer format: int32 - - in: query - name: pageToken - schema: - type: string - post: - description: Creates a new ScanConfig. - operationId: websecurityscanner.projects.scanConfigs.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ScanConfig' + /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}: + parameters: *ref_1 + delete: + description: Deletes an existing ScanConfig and its child resources. + operationId: websecurityscanner.projects.scanConfigs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1240,23 +1286,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ScanConfig' + $ref: '#/components/schemas/Empty' parameters: - in: path name: projectsId required: true schema: type: string - /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}:start: - parameters: *ref_1 - post: - description: Start a ScanRun according to the given ScanConfig. - operationId: websecurityscanner.projects.scanConfigs.start - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/StartScanRunRequest' + - in: path + name: scanConfigsId + required: true + schema: + type: string + get: + description: Gets a ScanConfig. + operationId: websecurityscanner.projects.scanConfigs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1268,7 +1312,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ScanRun' + $ref: '#/components/schemas/ScanConfig' parameters: - in: path name: projectsId @@ -1280,8 +1324,6 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}: - parameters: *ref_1 patch: description: >- Updates a ScanConfig. This method support partial update of a @@ -1320,9 +1362,16 @@ paths: schema: type: string format: google-fieldmask - get: - description: Gets a ScanConfig. - operationId: websecurityscanner.projects.scanConfigs.get + /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}:start: + parameters: *ref_1 + post: + description: Start a ScanRun according to the given ScanConfig. + operationId: websecurityscanner.projects.scanConfigs.start + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StartScanRunRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1334,7 +1383,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ScanConfig' + $ref: '#/components/schemas/ScanRun' parameters: - in: path name: projectsId @@ -1346,9 +1395,11 @@ paths: required: true schema: type: string - delete: - description: Deletes an existing ScanConfig and its child resources. - operationId: websecurityscanner.projects.scanConfigs.delete + /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}: + parameters: *ref_1 + get: + description: Gets a ScanRun. + operationId: websecurityscanner.projects.scanConfigs.scanRuns.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1360,7 +1411,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/ScanRun' parameters: - in: path name: projectsId @@ -1372,11 +1423,18 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}/findingTypeStats: + - in: path + name: scanRunsId + required: true + schema: + type: string + /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns: parameters: *ref_1 get: - description: List all FindingTypeStats under a given ScanRun. - operationId: websecurityscanner.projects.scanConfigs.scanRuns.findingTypeStats.list + description: >- + Lists ScanRuns under a given ScanConfig, in descending order of ScanRun + stop time. + operationId: websecurityscanner.projects.scanConfigs.scanRuns.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1388,7 +1446,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListFindingTypeStatsResponse' + $ref: '#/components/schemas/ListScanRunsResponse' parameters: - in: path name: projectsId @@ -1400,16 +1458,25 @@ paths: required: true schema: type: string - - in: path - name: scanRunsId - required: true + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}/crawledUrls: + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}:stop: parameters: *ref_1 - get: - description: List CrawledUrls under a given ScanRun. - operationId: websecurityscanner.projects.scanConfigs.scanRuns.crawledUrls.list + post: + description: Stops a ScanRun. The stopped ScanRun is returned. + operationId: websecurityscanner.projects.scanConfigs.scanRuns.stop + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StopScanRunRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1421,7 +1488,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListCrawledUrlsResponse' + $ref: '#/components/schemas/ScanRun' parameters: - in: path name: projectsId @@ -1438,20 +1505,11 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}/findings: + /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}/crawledUrls: parameters: *ref_1 get: - description: List Findings under a given ScanRun. - operationId: websecurityscanner.projects.scanConfigs.scanRuns.findings.list + description: List CrawledUrls under a given ScanRun. + operationId: websecurityscanner.projects.scanConfigs.scanRuns.crawledUrls.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1463,7 +1521,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListFindingsResponse' + $ref: '#/components/schemas/ListCrawledUrlsResponse' parameters: - in: path name: projectsId @@ -1489,10 +1547,6 @@ paths: schema: type: integer format: int32 - - in: query - name: filter - schema: - type: string /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}/findings/{findingsId}: parameters: *ref_1 get: @@ -1531,13 +1585,11 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns: + /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}/findings: parameters: *ref_1 get: - description: >- - Lists ScanRuns under a given ScanConfig, in descending order of ScanRun - stop time. - operationId: websecurityscanner.projects.scanConfigs.scanRuns.list + description: List Findings under a given ScanRun. + operationId: websecurityscanner.projects.scanConfigs.scanRuns.findings.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1549,7 +1601,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListScanRunsResponse' + $ref: '#/components/schemas/ListFindingsResponse' parameters: - in: path name: projectsId @@ -1561,58 +1613,29 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}:stop: - parameters: *ref_1 - post: - description: Stops a ScanRun. The stopped ScanRun is returned. - operationId: websecurityscanner.projects.scanConfigs.scanRuns.stop - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/StopScanRunRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/ScanRun' - parameters: - in: path - name: projectsId + name: scanRunsId required: true schema: type: string - - in: path - name: scanConfigsId - required: true + - in: query + name: filter schema: type: string - - in: path - name: scanRunsId - required: true + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}: + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}/findingTypeStats: parameters: *ref_1 get: - description: Gets a ScanRun. - operationId: websecurityscanner.projects.scanConfigs.scanRuns.get + description: List all FindingTypeStats under a given ScanRun. + operationId: websecurityscanner.projects.scanConfigs.scanRuns.findingTypeStats.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1624,7 +1647,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ScanRun' + $ref: '#/components/schemas/ListFindingTypeStatsResponse' parameters: - in: path name: projectsId diff --git a/providers/src/googleapis.com/v00.00.00000/services/workflowexecutions.yaml b/providers/src/googleapis.com/v00.00.00000/services/workflowexecutions.yaml index 74b32c65..6b41a238 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/workflowexecutions.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/workflowexecutions.yaml @@ -7,8 +7,8 @@ info: title: Workflow Executions API description: Execute workflows created with Workflows API. version: v1 - x-discovery-doc-revision: '20241015' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250812' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/workflows servers: @@ -214,15 +214,15 @@ components: type: string format: int64 navigationInfo: - description: Output only. The NavigationInfo associated to this step. + description: Output only. The NavigationInfo associated with this step. readOnly: true $ref: '#/components/schemas/NavigationInfo' stepEntryMetadata: - description: Output only. The StepEntryMetadata associated to this step. + description: Output only. The StepEntryMetadata associated with this step. readOnly: true $ref: '#/components/schemas/StepEntryMetadata' variableData: - description: Output only. The VariableData associated to this step. + description: Output only. The VariableData associated with this step. readOnly: true $ref: '#/components/schemas/VariableData' Exception: @@ -459,12 +459,11 @@ components: type: boolean executionHistoryLevel: description: >- - Optional. Describes the level of the execution history feature to - apply to this execution. If not specified, the level of the - execution history feature will be determined by its workflow's - execution history level. If the value is different from its - workflow's value, it will override the workflow's execution history - level for this exeuction. + Optional. Describes the execution history level to apply to this + execution. If not specified, the execution history level is + determined by its workflow's execution history level. If the levels + are different, the executionHistoryLevel overrides the workflow's + execution history level for this execution. type: string enumDescriptions: - The default/unset value. diff --git a/providers/src/googleapis.com/v00.00.00000/services/workflows.yaml b/providers/src/googleapis.com/v00.00.00000/services/workflows.yaml index 27058909..64c1b11c 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/workflows.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/workflows.yaml @@ -9,8 +9,8 @@ info: Manage workflow definitions. To execute workflows and manage executions, see the Workflows Executions API. version: v1 - x-discovery-doc-revision: '20241016' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250814' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/workflows servers: @@ -347,8 +347,8 @@ components: type: string executionHistoryLevel: description: >- - Optional. Describes the level of the execution history feature to - apply to this workflow. + Optional. Describes the execution history level to apply to this + workflow. type: string enumDescriptions: - The default/unset value. @@ -381,6 +381,11 @@ components: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}/cryptoKeyVersions/{cryptoKeyVersion} readOnly: true type: string + tags: + description: Optional. Input only. Immutable. Tags associated with this workflow. + type: object + additionalProperties: + type: string StateError: id: StateError description: Describes an error related to the current state of the workflow. @@ -701,6 +706,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: diff --git a/providers/src/googleapis.com/v00.00.00000/services/workloadmanager.yaml b/providers/src/googleapis.com/v00.00.00000/services/workloadmanager.yaml index 493ce935..7b41aa81 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/workloadmanager.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/workloadmanager.yaml @@ -10,8 +10,8 @@ info: to automate the deployment and validation of your workloads against best practices and recommendations. version: v1 - x-discovery-doc-revision: '20241023' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250813' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/workload-manager/docs servers: @@ -168,7 +168,7 @@ components: type: string Evaluation: id: Evaluation - description: LINT.IfChange Message describing Evaluation object + description: Message describing Evaluation object type: object properties: name: @@ -221,9 +221,35 @@ components: customRulesBucket: description: The Cloud Storage bucket name for custom rules. type: string + evaluationType: + description: Evaluation type + type: string + enumDescriptions: + - Not specified + - SAP best practices + - SQL best practices + - Customized best practices + - SCC IaC (Infra as Code) best practices. + enumDeprecated: + - false + - false + - false + - false + - true + enum: + - EVALUATION_TYPE_UNSPECIFIED + - SAP + - SQL_SERVER + - OTHER + - SCC_IAC bigQueryDestination: description: Optional. BigQuery destination $ref: '#/components/schemas/BigQueryDestination' + kmsKey: + description: >- + Optional. Immutable. Customer-managed encryption key name, in the + format projects/*/locations/*/keyRings/*/cryptoKeys/*. + type: string ResourceFilter: id: ResourceFilter description: Message describing resource filters @@ -392,6 +418,21 @@ components: type: array items: $ref: '#/components/schemas/Notice' + engine: + description: Optional. Engine + type: string + enumDescriptions: + - The original CG + - SlimCG / Scanner + - Evaluation Engine V2 + enum: + - ENGINE_UNSPECIFIED + - ENGINE_SCANNER + - V2 + resultSummary: + description: Output only. [Output only] Result summary for the execution + readOnly: true + $ref: '#/components/schemas/Summary' RuleExecutionResult: id: RuleExecutionResult description: Message for execution result summary per rule @@ -465,6 +506,28 @@ components: description: Output only. Message of the notice readOnly: true type: string + Summary: + id: Summary + description: Message for execution summary + type: object + properties: + failures: + description: Output only. Number of failures + readOnly: true + type: string + format: int64 + newFailures: + description: >- + Output only. Number of new failures compared to the previous + execution + readOnly: true + type: string + format: int64 + newFixes: + description: Output only. Number of new fixes compared to the previous execution + readOnly: true + type: string + format: int64 RunEvaluationRequest: id: RunEvaluationRequest description: Message for creating a Execution @@ -801,6 +864,12 @@ components: sqlserverValidation: description: The insights data for the sqlserver workload validation. $ref: '#/components/schemas/SqlserverValidation' + torsoValidation: + description: The insights data for workload validation of torso workloads. + $ref: '#/components/schemas/TorsoValidation' + agentStatus: + description: The insights data for the agent status. + $ref: '#/components/schemas/AgentStatus' instanceId: description: Required. The instance id where the insight is generated from type: string @@ -905,6 +974,9 @@ components: workloadProperties: description: Optional. The properties of the workload. $ref: '#/components/schemas/SapDiscoveryWorkloadProperties' + useDrReconciliation: + description: Optional. Whether to use DR reconciliation or not. + type: boolean SapDiscoveryMetadata: id: SapDiscoveryMetadata description: Message describing SAP discovery system metadata @@ -973,7 +1045,12 @@ components: configurations. type: array items: - $ref: '#/components/schemas/SapDiscoveryComponent' + $ref: '#/components/schemas/SapDiscoveryComponentReplicationSite' + region: + description: >- + Optional. The region this component's resources are primarily + located in. + type: string SapDiscoveryResource: id: SapDiscoveryResource description: Message describing a resource. @@ -1116,6 +1193,16 @@ components: isDrSite: description: Optional. Instance is part of a DR site. type: boolean + diskMounts: + description: Optional. Disk mounts on the instance. + type: array + items: + $ref: >- + #/components/schemas/SapDiscoveryResourceInstancePropertiesDiskMount + osKernelVersion: + description: Optional. The kernel version of the instance. + $ref: >- + #/components/schemas/SapDiscoveryResourceInstancePropertiesKernelVersion SapDiscoveryResourceInstancePropertiesAppInstance: id: SapDiscoveryResourceInstancePropertiesAppInstance description: Fields to describe an SAP application server instance. @@ -1127,6 +1214,69 @@ components: number: description: Optional. Instance number of the SAP application instance. type: string + SapDiscoveryResourceInstancePropertiesDiskMount: + id: SapDiscoveryResourceInstancePropertiesDiskMount + description: Disk mount on the instance. + type: object + properties: + name: + description: Optional. Name of the disk. + type: string + mountPoint: + description: Optional. Filesystem mount point. + type: string + diskNames: + description: Optional. Names of the disks providing this mount point. + type: array + items: + type: string + SapDiscoveryResourceInstancePropertiesKernelVersion: + id: SapDiscoveryResourceInstancePropertiesKernelVersion + description: KernelVersion encapsulates the kernel version data for the system. + type: object + properties: + rawString: + description: Optional. Raw string of the kernel version. + type: string + osKernel: + description: >- + Optional. Captures the OS-specific kernel version, the portion of + the string up to the first dash. + $ref: >- + #/components/schemas/SapDiscoveryResourceInstancePropertiesKernelVersionVersion + distroKernel: + description: >- + Optional. Captures the distro-specific kernel version, the portion + of the string following the first dash. + $ref: >- + #/components/schemas/SapDiscoveryResourceInstancePropertiesKernelVersionVersion + SapDiscoveryResourceInstancePropertiesKernelVersionVersion: + id: SapDiscoveryResourceInstancePropertiesKernelVersionVersion + description: Version is reported as Major.Minor.Build.Patch. + type: object + properties: + major: + description: Optional. The major version number. + type: integer + format: int32 + minor: + description: Optional. The minor version number. + type: integer + format: int32 + build: + description: Optional. The build version number. + type: integer + format: int32 + patch: + description: Optional. The patch version number. + type: integer + format: int32 + remainder: + description: >- + Optional. A catch-all for any unparsed version components. This is + in case the number of points in the version string exceeds the + expected count of 4. + type: string SapDiscoveryComponentApplicationProperties: id: SapDiscoveryComponentApplicationProperties description: A set of properties describing an SAP Application layer. @@ -1187,11 +1337,17 @@ components: - SAP HANA - SAP MAX_DB - IBM DB2 + - Oracle Database + - Microsoft SQL Server + - SAP Sybase ASE enum: - DATABASE_TYPE_UNSPECIFIED - HANA - MAX_DB - DB2 + - ORACLE + - SQLSERVER + - ASE primaryInstanceUri: description: Required. URI of the recognized primary instance of the database. type: string @@ -1211,6 +1367,22 @@ components: databaseSid: description: Optional. SID of the system database. type: string + landscapeId: + description: Optional. Landscape ID from the HANA nameserver. + type: string + SapDiscoveryComponentReplicationSite: + id: SapDiscoveryComponentReplicationSite + description: A replication site used in Disaster Recovery (DR) configurations. + type: object + properties: + sourceSite: + description: >- + Optional. The name of the source site from which this one + replicates. + type: string + component: + description: Optional. The system component for the site. + $ref: '#/components/schemas/SapDiscoveryComponent' SapDiscoveryWorkloadProperties: id: SapDiscoveryWorkloadProperties description: A set of properties describing an SAP workload. @@ -1339,11 +1511,680 @@ components: type: object additionalProperties: type: string + TorsoValidation: + id: TorsoValidation + description: The schema of torso workload validation data. + type: object + properties: + workloadType: + description: Required. workload_type specifies the type of torso workload. + type: string + enumDescriptions: + - Unspecified workload type. + - MySQL workload. + - Oracle workload. + - Redis workload. + enum: + - WORKLOAD_TYPE_UNSPECIFIED + - MYSQL + - ORACLE + - REDIS + validationDetails: + description: >- + Required. validation_details contains the pairs of validation data: + field name & field value. + type: object + additionalProperties: + type: string + agentVersion: + description: >- + Required. agent_version lists the version of the agent that + collected this data. + type: string + projectId: + description: >- + Required. project_id lists the human readable cloud project that the + data comes from. + type: string + instanceName: + description: >- + Required. instance_name lists the human readable name of the + instance that the data comes from. + type: string + AgentStatus: + id: AgentStatus + description: The schema of agent status data. + type: object + properties: + installedVersion: + description: Output only. The installed version of the agent on the host. + readOnly: true + type: string + availableVersion: + description: >- + Output only. The available version of the agent in artifact + registry. + readOnly: true + type: string + systemdServiceEnabled: + description: Output only. Whether the agent service is enabled in systemd. + readOnly: true + type: string + enumDescriptions: + - The state is unspecified and has not been checked yet. + - The state is successful (enabled, granted, fully functional). + - The state is failed (disabled, denied, not fully functional). + - >- + There was an internal error while checking the state, state is + unknown. + enum: + - UNSPECIFIED_STATE + - SUCCESS_STATE + - FAILURE_STATE + - ERROR_STATE + systemdServiceRunning: + description: Output only. Whether the agent service is running in systemd. + readOnly: true + type: string + enumDescriptions: + - The state is unspecified and has not been checked yet. + - The state is successful (enabled, granted, fully functional). + - The state is failed (disabled, denied, not fully functional). + - >- + There was an internal error while checking the state, state is + unknown. + enum: + - UNSPECIFIED_STATE + - SUCCESS_STATE + - FAILURE_STATE + - ERROR_STATE + configurationFilePath: + description: Output only. The path to the agent configuration file. + readOnly: true + type: string + configurationValid: + description: Output only. Whether the agent configuration is valid. + readOnly: true + type: string + enumDescriptions: + - The state is unspecified and has not been checked yet. + - The state is successful (enabled, granted, fully functional). + - The state is failed (disabled, denied, not fully functional). + - >- + There was an internal error while checking the state, state is + unknown. + enum: + - UNSPECIFIED_STATE + - SUCCESS_STATE + - FAILURE_STATE + - ERROR_STATE + configurationErrorMessage: + description: >- + Output only. The error message for the agent configuration if + invalid. + readOnly: true + type: string + services: + description: Output only. The services (process metrics, host metrics, etc.). + readOnly: true + type: array + items: + $ref: '#/components/schemas/AgentStatusServiceStatus' + references: + description: Output only. Optional references to public documentation. + readOnly: true + type: array + items: + $ref: '#/components/schemas/AgentStatusReference' + agentName: + description: Output only. The name of the agent. + readOnly: true + type: string + cloudApiAccessFullScopesGranted: + description: Output only. Whether the agent has full access to Cloud APIs. + readOnly: true + type: string + enumDescriptions: + - The state is unspecified and has not been checked yet. + - The state is successful (enabled, granted, fully functional). + - The state is failed (disabled, denied, not fully functional). + - >- + There was an internal error while checking the state, state is + unknown. + enum: + - UNSPECIFIED_STATE + - SUCCESS_STATE + - FAILURE_STATE + - ERROR_STATE + kernelVersion: + description: Output only. The kernel version of the system. + readOnly: true + $ref: >- + #/components/schemas/SapDiscoveryResourceInstancePropertiesKernelVersion + instanceUri: + description: >- + Output only. The URI of the instance. Format: + projects//zones//instances/ + readOnly: true + type: string + AgentStatusServiceStatus: + id: AgentStatusServiceStatus + description: The status of a service (process metrics, host metrics, etc.). + type: object + properties: + name: + description: Output only. The name of the service. + readOnly: true + type: string + state: + description: >- + Output only. The state of the service (enabled or disabled in the + configuration). + readOnly: true + type: string + enumDescriptions: + - The state is unspecified and has not been checked yet. + - The state is successful (enabled, granted, fully functional). + - The state is failed (disabled, denied, not fully functional). + - >- + There was an internal error while checking the state, state is + unknown. + enum: + - UNSPECIFIED_STATE + - SUCCESS_STATE + - FAILURE_STATE + - ERROR_STATE + fullyFunctional: + description: >- + Output only. Whether the service is fully functional (all checks + passed). + readOnly: true + type: string + enumDescriptions: + - The state is unspecified and has not been checked yet. + - The state is successful (enabled, granted, fully functional). + - The state is failed (disabled, denied, not fully functional). + - >- + There was an internal error while checking the state, state is + unknown. + enum: + - UNSPECIFIED_STATE + - SUCCESS_STATE + - FAILURE_STATE + - ERROR_STATE + errorMessage: + description: >- + Output only. The error message for the service if it is not fully + functional. + readOnly: true + type: string + iamPermissions: + description: Output only. The permissions required for the service. + readOnly: true + type: array + items: + $ref: '#/components/schemas/AgentStatusIAMPermission' + configValues: + description: Output only. The configuration values for the service. + readOnly: true + type: array + items: + $ref: '#/components/schemas/AgentStatusConfigValue' + unspecifiedStateMessage: + description: >- + Output only. The message to display when the service state is + unspecified. + readOnly: true + type: string + AgentStatusIAMPermission: + id: AgentStatusIAMPermission + description: The IAM permission status. + type: object + properties: + name: + description: Output only. The name of the permission. + readOnly: true + type: string + granted: + description: Output only. Whether the permission is granted. + readOnly: true + type: string + enumDescriptions: + - The state is unspecified and has not been checked yet. + - The state is successful (enabled, granted, fully functional). + - The state is failed (disabled, denied, not fully functional). + - >- + There was an internal error while checking the state, state is + unknown. + enum: + - UNSPECIFIED_STATE + - SUCCESS_STATE + - FAILURE_STATE + - ERROR_STATE + AgentStatusConfigValue: + id: AgentStatusConfigValue + description: The configuration value. + type: object + properties: + name: + description: Output only. The name of the configuration value. + readOnly: true + type: string + value: + description: Output only. The value of the configuration value. + readOnly: true + type: string + isDefault: + description: >- + Output only. Whether the configuration value is the default value or + overridden. + readOnly: true + type: boolean + AgentStatusReference: + id: AgentStatusReference + description: The reference to public documentation. + type: object + properties: + name: + description: Output only. The name of the reference. + readOnly: true + type: string + url: + description: Output only. The URL of the reference. + readOnly: true + type: string WriteInsightResponse: id: WriteInsightResponse description: The response for write insights request. type: object properties: {} + ListDiscoveredProfilesResponse: + id: ListDiscoveredProfilesResponse + description: List discovered profile Response returns discovered profiles from agents + type: object + properties: + workloadProfiles: + description: Output only. The list of workload profiles + readOnly: true + type: array + items: + $ref: '#/components/schemas/WorkloadProfile' + unreachable: + description: Locations that could not be reached. + type: array + items: + type: string + nextPageToken: + description: >- + Output only. A token identifying a page of results the server should + return + readOnly: true + type: string + WorkloadProfile: + id: WorkloadProfile + description: workload resource + type: object + properties: + name: + description: >- + Identifier. name of resource names have the form + 'projects/{project_id}/locations/{location}/workloadProfiles/{workload_id}' + type: string + labels: + description: >- + Optional. such as name, description, version. More example can be + found in deployment + type: object + additionalProperties: + type: string + refreshedTime: + description: Required. time when the workload data was refreshed + type: string + format: google-datetime + workloadType: + description: Required. The type of the workload + type: string + enumDescriptions: + - unspecified workload type + - running sap workload s4/hana + enum: + - WORKLOAD_TYPE_UNSPECIFIED + - S4_HANA + sapWorkload: + description: The sap workload content + $ref: '#/components/schemas/SapWorkload' + SapWorkload: + id: SapWorkload + description: The body of sap workload + type: object + properties: + metadata: + description: Output only. The metadata for SAP workload. + readOnly: true + type: object + additionalProperties: + type: string + database: + description: Output only. the database componment + readOnly: true + $ref: '#/components/schemas/SapComponent' + application: + description: Output only. the acsc componment + readOnly: true + $ref: '#/components/schemas/SapComponent' + products: + description: Output only. the products on this workload. + readOnly: true + type: array + items: + $ref: '#/components/schemas/Product' + architecture: + description: Output only. the architecture + readOnly: true + type: string + enumDescriptions: + - Unspecified architecture. + - Invaliad architecture. + - A centralized system. + - A distributed system. + - A distributed with HA system. + - A standalone database system. + - A standalone database with HA system. + enum: + - ARCHITECTURE_UNSPECIFIED + - INVALID + - CENTRALIZED + - DISTRIBUTED + - DISTRIBUTED_HA + - STANDALONE_DATABASE + - STANDALONE_DATABASE_HA + SapComponent: + id: SapComponent + description: The component of sap workload + type: object + properties: + sid: + description: Output only. sid is the sap component identificator + readOnly: true + type: string + resources: + description: Output only. resources in the component + readOnly: true + type: array + items: + $ref: '#/components/schemas/CloudResource' + topologyType: + description: The detected topology of the component. + type: string + enumDescriptions: + - Unspecified topology. + - A scale-up single node system. + - A scale-out multi-node system. + enum: + - TOPOLOGY_TYPE_UNSPECIFIED + - TOPOLOGY_SCALE_UP + - TOPOLOGY_SCALE_OUT + haHosts: + description: >- + A list of host URIs that are part of the HA configuration if + present. An empty list indicates the component is not configured for + HA. + type: array + items: + type: string + databaseProperties: + description: Output only. All instance properties. + readOnly: true + $ref: '#/components/schemas/DatabaseProperties' + CloudResource: + id: CloudResource + description: The resource on GCP + type: object + properties: + name: + description: Output only. resource name + readOnly: true + type: string + kind: + description: >- + Output only. ComputeInstance, ComputeDisk, VPC, Bare Metal server, + etc. + readOnly: true + type: string + enumDescriptions: + - Unspecified resource kind. + - This is a compute instance. + - This is a compute disk. + - This is a compute address. + - This is a filestore instance. + - This is a compute health check. + - This is a compute forwarding rule. + - This is a compute backend service. + - This is a compute subnetwork. + - This is a compute network. + - This is a public accessible IP Address. + - This is a compute instance group. + enum: + - RESOURCE_KIND_UNSPECIFIED + - RESOURCE_KIND_INSTANCE + - RESOURCE_KIND_DISK + - RESOURCE_KIND_ADDRESS + - RESOURCE_KIND_FILESTORE + - RESOURCE_KIND_HEALTH_CHECK + - RESOURCE_KIND_FORWARDING_RULE + - RESOURCE_KIND_BACKEND_SERVICE + - RESOURCE_KIND_SUBNETWORK + - RESOURCE_KIND_NETWORK + - RESOURCE_KIND_PUBLIC_ADDRESS + - RESOURCE_KIND_INSTANCE_GROUP + instanceProperties: + description: Output only. All instance properties. + readOnly: true + $ref: '#/components/schemas/InstanceProperties' + InstanceProperties: + id: InstanceProperties + description: Instance Properties. + type: object + properties: + status: + description: Optional. Instance status. + type: string + machineType: + description: Optional. Instance machine type. + type: string + instanceNumber: + description: Optional. Instance number. + type: string + upcomingMaintenanceEvent: + description: Optional. the next maintenance event on VM + $ref: '#/components/schemas/UpcomingMaintenanceEvent' + sapInstanceProperties: + description: Optional. SAP Instance properties. + $ref: '#/components/schemas/SapInstanceProperties' + roles: + description: Optional. Instance roles. + type: array + items: + type: string + enumDescriptions: + - Unspecified role. + - ASCS role. + - ERS role. + - APP server. + - HANA primary role. + - HANA secondary role. + enum: + - INSTANCE_ROLE_UNSPECIFIED + - INSTANCE_ROLE_ASCS + - INSTANCE_ROLE_ERS + - INSTANCE_ROLE_APP_SERVER + - INSTANCE_ROLE_HANA_PRIMARY + - INSTANCE_ROLE_HANA_SECONDARY + UpcomingMaintenanceEvent: + id: UpcomingMaintenanceEvent + description: Maintenance Event + type: object + properties: + startTime: + description: Optional. Start time + type: string + format: google-datetime + endTime: + description: Optional. End time + type: string + format: google-datetime + maintenanceStatus: + description: Optional. Maintenance status + type: string + type: + description: Optional. Type + type: string + onHostMaintenance: + description: >- + Optional. Instance maintenance behavior. Could be "MIGRATE" or + "TERMINATE". + type: string + SapInstanceProperties: + id: SapInstanceProperties + description: SAP instance properties. + type: object + properties: + numbers: + description: Optional. SAP Instance numbers. They are from '00' to '99'. + type: array + items: + type: string + agentStates: + description: Optional. Sap Instance Agent status. + $ref: '#/components/schemas/AgentStates' + AgentStates: + id: AgentStates + description: Agent status. + type: object + properties: + installedVersion: + description: Optional. The installed version of the agent on the host. + type: string + availableVersion: + description: Optional. The available version of the agent in artifact registry. + type: string + isFullyEnabled: + description: >- + Optional. Whether the agent is fully enabled. If false, the agent is + has some issues. + type: boolean + processMetrics: + description: Optional. The Process metrics of the agent. + $ref: '#/components/schemas/ServiceStates' + systemDiscovery: + description: Optional. The System discovery metrics of the agent. + $ref: '#/components/schemas/ServiceStates' + hanaMonitoring: + description: Optional. HANA monitoring metrics of the agent. + $ref: '#/components/schemas/ServiceStates' + ServiceStates: + id: ServiceStates + description: The state of the service. + type: object + properties: + state: + description: Output only. The overall state of the service. + readOnly: true + type: string + enumDescriptions: + - The state is unspecified. + - The state means the service has config errors. + - The state means the service has IAM permission errors. + - The state means the service has functionality errors. + - The state means the service has no error. + - The state means the service disabled. + enum: + - STATE_UNSPECIFIED + - CONFIG_FAILURE + - IAM_FAILURE + - FUNCTIONALITY_FAILURE + - ENABLED + - DISABLED + iamPermissions: + description: Optional. Output only. The IAM permissions for the service. + readOnly: true + type: array + items: + $ref: '#/components/schemas/IAMPermission' + IAMPermission: + id: IAMPermission + description: The IAM permission status. + type: object + properties: + name: + description: Output only. The name of the permission. + readOnly: true + type: string + granted: + description: Output only. Whether the permission is granted. + readOnly: true + type: boolean + DatabaseProperties: + id: DatabaseProperties + description: Database Properties. + type: object + properties: + backupProperties: + description: Output only. Backup properties. + readOnly: true + $ref: '#/components/schemas/BackupProperties' + databaseType: + description: Output only. Type of the database. HANA, DB2, etc. + readOnly: true + type: string + enumDescriptions: + - unspecified + - SAP HANA + - SAP MAX_DB + - IBM DB2 + - Oracle Database + - Microsoft SQL Server + - SAP Sybase ASE + enum: + - DATABASE_TYPE_UNSPECIFIED + - HANA + - MAX_DB + - DB2 + - ORACLE + - SQLSERVER + - ASE + BackupProperties: + id: BackupProperties + description: Backup properties. + type: object + properties: + latestBackupTime: + description: The time when the latest backup was performed. + type: string + format: google-datetime + latestBackupStatus: + description: Output only. The state of the latest backup. + readOnly: true + type: string + enumDescriptions: + - unspecified + - SUCCESS state + - FAILURE state + enum: + - BACKUP_STATE_UNSPECIFIED + - BACKUP_STATE_SUCCESS + - BACKUP_STATE_FAILURE + Product: + id: Product + description: Product contains the details of a product. + type: object + properties: + name: + description: Optional. Name of the product. + type: string + version: + description: Optional. Version of the product. + type: string OperationMetadata: id: OperationMetadata description: Represents the metadata of the long-running operation. @@ -1694,11 +2535,39 @@ components: response: mediaType: application/json openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1insights~1{insightsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: [] insert: [] update: [] replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/insights/methods/delete' + discoveredprofiles: + id: google.workloadmanager.discoveredprofiles + name: discoveredprofiles + title: Discoveredprofiles + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1discoveredprofiles/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.workloadProfiles + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/discoveredprofiles/methods/list' + insert: [] + update: [] + replace: [] delete: [] paths: /v1/projects/{projectsId}/locations: @@ -1748,6 +2617,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: @@ -1902,7 +2775,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: workloadmanager.projects.locations.operations.cancel requestBody: content: @@ -2415,6 +3288,10 @@ paths: name: customRulesBucket schema: type: string + - in: query + name: evaluationType + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/insights:writeInsight: parameters: *ref_1 post: @@ -2448,3 +3325,81 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/insights/{insightsId}: + parameters: *ref_1 + delete: + description: Delete the data insights from workload manager data warehouse. + operationId: workloadmanager.projects.locations.insights.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: insightsId + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/discoveredprofiles: + parameters: *ref_1 + get: + description: List discovered workload profiles + operationId: workloadmanager.projects.locations.discoveredprofiles.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListDiscoveredProfilesResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/workstations.yaml b/providers/src/googleapis.com/v00.00.00000/services/workstations.yaml index f6c7cfc6..3c1913da 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/workstations.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/workstations.yaml @@ -9,8 +9,8 @@ info: Allows administrators to create managed developer environments in the cloud. version: v1 - x-discovery-doc-revision: '20241010' - x-generated-date: '2024-11-06' + x-discovery-doc-revision: '20250811' + x-generated-date: '2025-08-28' externalDocs: url: https://cloud.google.com/workstations servers: @@ -36,55 +36,6 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - ListLocationsResponse: - id: ListLocationsResponse - description: The response message for Locations.ListLocations. - type: object - properties: - locations: - description: >- - A list of locations that matches the specified filter in the - request. - type: array - items: - $ref: '#/components/schemas/Location' - nextPageToken: - description: The standard List next-page token. - type: string - Location: - id: Location - description: A resource that represents a Google Cloud location. - type: object - properties: - name: - description: >- - Resource name for the location, which may vary between - implementations. For example: - `"projects/example-project/locations/us-east1"` - type: string - locationId: - description: 'The canonical id for this location. For example: `"us-east1"`.' - type: string - displayName: - description: >- - The friendly name for this location, typically a nearby city name. - For example, "Tokyo". - type: string - labels: - description: >- - Cross-service attributes for the location. For example - {"cloud.googleapis.com/region": "us-east1"} - type: object - additionalProperties: - type: string - metadata: - description: >- - Service-specific metadata. For example the available capacity at the - given location. - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. ListOperationsResponse: id: ListOperationsResponse description: The response message for Operations.ListOperations. @@ -288,7 +239,8 @@ components: description: >- Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full - functionality. Details can be found in conditions. + functionality. The conditions field contains detailed information + about the status of the cluster. readOnly: true type: boolean conditions: @@ -301,12 +253,15 @@ components: $ref: '#/components/schemas/Status' tags: description: >- - Optional. Tag keys/values directly bound to this resource. For - example: "123/environment": "production", "123/costCenter": - "marketing" + Optional. Input only. Immutable. Tag keys/values directly bound to + this resource. For example: "123/environment": "production", + "123/costCenter": "marketing" type: object additionalProperties: type: string + gatewayConfig: + description: Optional. Configuration options for Cluster HTTP Gateway. + $ref: '#/components/schemas/GatewayConfig' PrivateClusterConfig: id: PrivateClusterConfig description: Configuration options for private workstation clusters. @@ -327,7 +282,7 @@ components: serviceAttachmentUri: description: >- Output only. Service attachment URI for the workstation cluster. The - service attachemnt is created when private endpoint is enabled. To + service attachment is created when private endpoint is enabled. To access workstations in the workstation cluster, configure access to the managed service using [Private Service Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services). @@ -350,6 +305,16 @@ components: domain: description: Immutable. Domain used by Workstations for HTTP ingress. type: string + GatewayConfig: + id: GatewayConfig + description: Configuration options for Cluster HTTP Gateway. + type: object + properties: + http2Enabled: + description: >- + Optional. Whether HTTP/2 is enabled for this workstation cluster. + Defaults to false. + type: boolean ListWorkstationClustersResponse: id: ListWorkstationClustersResponse description: Response message for ListWorkstationClusters. @@ -540,15 +505,16 @@ components: type: string degraded: description: >- - Output only. Whether this resource is degraded, in which case it may - require user action to restore full functionality. See also the - conditions field. + Output only. Whether this workstation configuration is in degraded + mode, in which case it may require user action to restore full + functionality. The conditions field contains detailed information + about the status of the configuration. readOnly: true type: boolean conditions: description: >- - Output only. Status conditions describing the current resource - state. + Output only. Status conditions describing the workstation + configuration's current state. readOnly: true type: array items: @@ -720,7 +686,9 @@ components: boostConfigs: description: >- Optional. A list of the boost configurations that workstations - created using this workstation configuration are allowed to use. + created using this workstation configuration are allowed to use. If + specified, users will have the option to choose from the list of + boost configs when starting a workstation. type: array items: $ref: '#/components/schemas/BoostConfig' @@ -775,11 +743,18 @@ components: format: int32 BoostConfig: id: BoostConfig - description: A configuration that workstations can boost to. + description: >- + A boost configuration is a set of resources that a workstation can use + to increase its performance. If you specify a boost configuration, upon + startup, workstation users can choose to use a VM provisioned under the + boost config by passing the boost config ID in the start request. If the + workstation user does not provide a boost config ID in the start + request, the system will choose a VM from the pool provisioned under the + default config. type: object properties: id: - description: Optional. Required. The id to be used for the boost configuration. + description: Required. The ID to be used for the boost configuration. type: string machineType: description: >- @@ -833,7 +808,10 @@ components: format: int32 PersistentDirectory: id: PersistentDirectory - description: A directory to persist across workstation sessions. + description: >- + A directory to persist across workstation sessions. Updates to this + field will not update existing workstations and will only take effect on + new workstations. type: object properties: gcePd: @@ -878,7 +856,8 @@ components: sourceSnapshot: description: >- Optional. Name of the snapshot to use as the source for the disk. If - set, size_gb and fs_type must be empty. + set, size_gb and fs_type must be empty. Must be formatted as ext4 + file system with no partitions. type: string reclaimPolicy: description: >- @@ -922,14 +901,23 @@ components: Optional. Name of the snapshot to use as the source for the disk. Must be empty if source_image is set. Must be empty if read_only is false. Updating source_snapshot will update content in the ephemeral - directory after the workstation is restarted. This field is mutable. + directory after the workstation is restarted. Only file systems + supported by Container-Optimized OS (COS) are explicitly supported. + For a list of supported file systems, see [the filesystems available + in Container-Optimized + OS](https://cloud.google.com/container-optimized-os/docs/concepts/supported-filesystems). + This field is mutable. type: string sourceImage: description: >- Optional. Name of the disk image to use as the source for the disk. Must be empty if source_snapshot is set. Updating source_image will update content in the ephemeral directory after the workstation is - restarted. This field is mutable. + restarted. Only file systems supported by Container-Optimized OS + (COS) are explicitly supported. For a list of supported file + systems, please refer to the [COS + documentation](https://cloud.google.com/container-optimized-os/docs/concepts/supported-filesystems). + This field is mutable. type: string readOnly: description: >- @@ -1192,6 +1180,42 @@ components: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. readOnly: true type: string + sourceWorkstation: + description: >- + Optional. The source workstation from which this workstation's + persistent directories were cloned on creation. + type: string + runtimeHost: + description: >- + Optional. Output only. Runtime host for the workstation when in + STATE_RUNNING. + readOnly: true + $ref: '#/components/schemas/RuntimeHost' + RuntimeHost: + id: RuntimeHost + description: Runtime host for the workstation. + type: object + properties: + gceInstanceHost: + description: Specifies a Compute Engine instance as the host. + $ref: '#/components/schemas/GceInstanceHost' + GceInstanceHost: + id: GceInstanceHost + description: The Compute Engine instance host. + type: object + properties: + name: + description: Optional. Output only. The name of the Compute Engine instance. + readOnly: true + type: string + id: + description: Optional. Output only. The ID of the Compute Engine instance. + readOnly: true + type: string + zone: + description: Optional. Output only. The zone of the Compute Engine instance. + readOnly: true + type: string ListWorkstationsResponse: id: ListWorkstationsResponse description: Response message for ListWorkstations. @@ -1247,6 +1271,11 @@ components: Optional. If set, the request will be rejected if the latest version of the workstation on the server does not have this ETag. type: string + boostConfig: + description: >- + Optional. If set, the workstation starts using the boost + configuration with the specified ID. + type: string StopWorkstationRequest: id: StopWorkstationRequest description: Request message for StopWorkstation. @@ -1306,6 +1335,55 @@ components: description: Time at which the generated token will expire. type: string format: google-datetime + ListLocationsResponse: + id: ListLocationsResponse + description: The response message for Locations.ListLocations. + type: object + properties: + locations: + description: >- + A list of locations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/Location' + nextPageToken: + description: The standard List next-page token. + type: string + Location: + id: Location + description: A resource that represents a Google Cloud location. + type: object + properties: + name: + description: >- + Resource name for the location, which may vary between + implementations. For example: + `"projects/example-project/locations/us-east1"` + type: string + locationId: + description: 'The canonical id for this location. For example: `"us-east1"`.' + type: string + displayName: + description: >- + The friendly name for this location, typically a nearby city name. + For example, "Tokyo". + type: string + labels: + description: >- + Cross-service attributes for the location. For example + {"cloud.googleapis.com/region": "us-east1"} + type: object + additionalProperties: + type: string + metadata: + description: >- + Service-specific metadata. For example the available capacity at the + given location. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. SetIamPolicyRequest: id: SetIamPolicyRequest description: Request message for `SetIamPolicy` method. @@ -2173,6 +2251,10 @@ paths: name: pageToken schema: type: string + - in: query + name: extraLocationTypes + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}: parameters: *ref_1 get: @@ -2327,7 +2409,7 @@ paths: the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. + `1`, corresponding to `Code.CANCELLED`. operationId: workstations.projects.locations.operations.cancel requestBody: content: @@ -2524,6 +2606,10 @@ paths: name: pageToken schema: type: string + - in: query + name: filter + schema: + type: string post: description: Creates a new workstation cluster. operationId: workstations.projects.locations.workstationClusters.create @@ -2749,6 +2835,10 @@ paths: name: pageToken schema: type: string + - in: query + name: filter + schema: + type: string post: description: Creates a new workstation configuration. operationId: >- @@ -3183,6 +3273,10 @@ paths: name: pageToken schema: type: string + - in: query + name: filter + schema: + type: string post: description: Creates a new workstation. operationId: >- @@ -3386,7 +3480,8 @@ paths: post: description: >- Returns a short-lived credential that can be used to send authenticated - and authorized traffic to a workstation. + and authorized traffic to a workstation. Once generated this token + cannot be revoked and is good for the lifetime of the token. operationId: >- workstations.projects.locations.workstationClusters.workstationConfigs.workstations.generateAccessToken requestBody: